mcuxCsslDataIntegrity_SecureCounter.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------*/
/* Copyright 2023-2024 NXP                                                  */
/*                                                                          */
/* SPDX-License-Identifier: BSD-3-Clause                                    */
/*                                                                          */
/* Redistribution and use in source and binary forms, with or without       */
/* modification, are permitted provided that the following conditions are   */
/* met:                                                                     */
/*                                                                          */
/* 1. Redistributions of source code must retain the above copyright        */
/*    notice, this list of conditions and the following disclaimer.         */
/*                                                                          */
/* 2. Redistributions in binary form must reproduce the above copyright     */
/*    notice, this list of conditions and the following disclaimer in the   */
/*    documentation and/or other materials provided with the distribution.  */
/*                                                                          */
/* 3. Neither the name of the copyright holder nor the names of its         */
/*    contributors may be used to endorse or promote products derived from  */
/*    this software without specific prior written permission.              */
/*                                                                          */
/* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS  */
/* IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED    */
/* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A          */
/* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT       */
/* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,   */
/* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED */
/* TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR   */
/* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF   */
/* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING     */
/* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS       */
/* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.             */
/*--------------------------------------------------------------------------*/

 
#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_ */