mcuxCsslDataIntegrity_SecureCounter.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------*/
/* Copyright 2023-2024 NXP                                                  */
/*                                                                          */
/* NXP Confidential and Proprietary. This software is owned or controlled   */
/* by NXP and may only be used strictly in accordance with the applicable   */
/* license terms.  By expressly accepting such terms or by downloading,     */
/* installing, activating and/or otherwise using the software, you are      */
/* agreeing that you have read, and that you agree to comply with and are   */
/* bound by, such license terms.  If you do not agree to be bound by the    */
/* applicable license terms, then you may not retain, install, activate or  */
/* otherwise use the software.                                              */
/*--------------------------------------------------------------------------*/

 
#ifndef MCUXCSSLDATAINTEGRITY_SECURECOUNTER_H_
#define MCUXCSSLDATAINTEGRITY_SECURECOUNTER_H_
 
#include <mcuxCsslAnalysis.h>
#include <mcuxCsslFlowProtection.h>
 
#if (1 == MCUX_CSSL_SC_USE_SW_LOCAL) && (0 == MCUX_CSSL_FP_USE_SECURE_COUNTER)
  #error "Local SW SC is not supported for DI when FP does not use this local SW SC, as SC_ALLOC would be missing."
#endif

 

 
 
/****************************************************************************/
/* Constants                                                                */
/****************************************************************************/

#define MCUX_CSSL_DI_CHECK_PASSED_IMPL (MCUX_CSSL_SC_CHECK_PASSED)

#define MCUX_CSSL_DI_CHECK_FAILED_IMPL (MCUX_CSSL_SC_CHECK_FAILED)
 
 
/****************************************************************************/
/* Macros that depend on the implementation of the secure counter mechanism */
/****************************************************************************/
 
#if (1 == MCUX_CSSL_SC_USE_HW_SCM)
#define MCUX_CSSL_DI_BACKUP_SC(backupValue) \
  uint32_t backupValue = MCUX_CSSL_SC_REF_VALUE_IMPL(); \
  MCUX_CSSL_SC_REF_VALUE_IMPL() = MCUX_CSSL_SC_VALUE()

#define MCUX_CSSL_DI_RESTORE_SC_REF(reference) \
  MCUX_CSSL_SC_REF_VALUE_IMPL() = (reference)
 
#else
#define MCUX_CSSL_DI_BACKUP_SC(backupValue) \
  uint32_t backupValue = MCUX_CSSL_SC_VALUE()

#define MCUX_CSSL_DI_RESTORE_SC_REF(reference)
 
#endif
 
/****************************************************************************/
/* Initialization                                                           */
/****************************************************************************/
 
#if (1 == MCUX_CSSL_FP_USE_SECURE_COUNTER)
#define MCUX_CSSL_DI_INIT_IMPL(backupValue) \
  uint32_t backupValue = 0u
#else
#define MCUX_CSSL_DI_INIT_IMPL(backupValue) \
  MCUX_CSSL_DI_BACKUP_SC(backupValue)
#endif
 
 
/****************************************************************************/
/* Check                                                                    */
/****************************************************************************/

#define MCUX_CSSL_DI_CHECK_IMPL(reference) \
  MCUX_CSSL_SC_CHECK(reference)
 
#if (1 == MCUX_CSSL_FP_USE_SECURE_COUNTER)
#define MCUX_CSSL_DI_CHECK_EXIT_IMPL(id, reference, fail) \
  (void)(reference)
#else
#define MCUX_CSSL_DI_CHECK_EXIT_IMPL(id, reference, fail) \
  if (MCUX_CSSL_DI_CHECK_PASSED != MCUX_CSSL_DI_CHECK(reference)) \
  { \
    MCUX_CSSL_FP_FUNCTION_EXIT(id, fail); \
  } \
  MCUX_CSSL_DI_RESTORE_SC_REF(reference);
#endif
 
 
/****************************************************************************/
/* Updates                                                                  */
/****************************************************************************/


#define MCUX_CSSL_DI_RECORD_IMPL(identifier, value) \
  MCUX_CSSL_ANALYSIS_START_PATTERN_DI_CAST() \
  MCUX_CSSL_SC_ADD(value) \
  MCUX_CSSL_ANALYSIS_STOP_PATTERN_DI_CAST()

#define MCUX_CSSL_DI_EXPUNGE_IMPL(identifier, value) \
  MCUX_CSSL_ANALYSIS_START_PATTERN_DI_CAST() \
  MCUX_CSSL_SC_SUB(value) \
  MCUX_CSSL_ANALYSIS_STOP_PATTERN_DI_CAST()
 
#endif /* MCUXCSSLDATAINTEGRITY_SECURECOUNTER_H_ */