mcuxCsslFlowProtection.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------*/
/* Copyright 2020-2025 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 MCUX_CSSL_FLOW_PROTECTION_H_
#define MCUX_CSSL_FLOW_PROTECTION_H_
 
#include <mcuxCsslAnalysis.h>
/* Include the actual implementation of the flow protection mechanism. */
#include <mcuxCsslFlowProtection_Impl.h>
 
MCUX_CSSL_ANALYSIS_START_PATTERN_URL_IN_COMMENTS()
 
 

 

#define MCUX_CSSL_FP_COUNTER_STMT(statement) \
  MCUX_CSSL_FP_COUNTER_STMT_IMPL(statement)

 

#define MCUX_CSSL_FP_PROTECTED_TYPE(resultType) \
  MCUX_CSSL_FP_PROTECTED_TYPE_IMPL(resultType)

#define MCUX_CSSL_FP_FUNCTION_DECL(...) \
  MCUX_CSSL_FP_FUNCTION_DECL_IMPL(__VA_ARGS__)

#define MCUX_CSSL_FP_FUNCTION_DEF(...) \
  MCUX_CSSL_FP_FUNCTION_DEF_IMPL(__VA_ARGS__)

#define MCUX_CSSL_FP_FUNCTION_POINTER(type, definition) \
  MCUX_CSSL_FP_FUNCTION_POINTER_IMPL(type, definition)

#define MCUX_CSSL_FP_FUNCTION_ENTRY(...) \
  MCUX_CSSL_FP_FUNCTION_ENTRY_IMPL(__VA_ARGS__, MCUX_CSSL_FP_VOID_EXPECTATION_IMPL())

#define MCUX_CSSL_FP_FUNCTION_EXIT(...) \
  MCUX_CSSL_FP_FUNCTION_EXIT_IMPL(__VA_ARGS__, MCUX_CSSL_FP_VOID_EXPECTATION_IMPL())

#define MCUX_CSSL_FP_FUNCTION_EXIT_WITH_CHECK(...) \
  MCUX_CSSL_FP_FUNCTION_EXIT_WITH_CHECK_IMPL(__VA_ARGS__, MCUX_CSSL_FP_VOID_EXPECTATION_IMPL())

#define MCUX_CSSL_FP_FUNCTION_EXIT_VOID(...) \
  MCUX_CSSL_FP_FUNCTION_EXIT_VOID_IMPL(__VA_ARGS__, MCUX_CSSL_FP_VOID_EXPECTATION_IMPL())

#define MCUX_CSSL_FP_RESULT(...) \
  MCUX_CSSL_FP_RESULT_IMPL(__VA_ARGS__)

#define MCUX_CSSL_FP_PROTECTION_TOKEN(return) \
  MCUX_CSSL_FP_PROTECTION_TOKEN_IMPL(return)

#define MCUX_CSSL_FP_FUNCTION_CALL(...) \
  MCUX_CSSL_FP_FUNCTION_CALL_IMPL(__VA_ARGS__)

#define MCUX_CSSL_FP_FUNCTION_CALL_VOID(...) \
  MCUX_CSSL_FP_FUNCTION_CALL_VOID_IMPL(__VA_ARGS__)

#define MCUX_CSSL_FP_FUNCTION_CALL_PROTECTED(...) \
  MCUX_CSSL_FP_FUNCTION_CALL_PROTECTED_IMPL(__VA_ARGS__)

#define MCUX_CSSL_FP_FUNCTION_CALL_VOID_PROTECTED(...) \
  MCUX_CSSL_FP_FUNCTION_CALL_VOID_PROTECTED_IMPL(__VA_ARGS__)

#define MCUX_CSSL_FP_FUNCTION_CALL_BEGIN(...) \
  MCUX_CSSL_FP_FUNCTION_CALL_BEGIN_IMPL(__VA_ARGS__)

#define MCUX_CSSL_FP_FUNCTION_CALL_END(...) \
  MCUX_CSSL_FP_FUNCTION_CALL_END_IMPL(__VA_ARGS__)

#define MCUX_CSSL_FP_FUNCTION_CALL_VOID_BEGIN(...) \
  MCUX_CSSL_FP_FUNCTION_CALL_VOID_BEGIN_IMPL(__VA_ARGS__)

#define MCUX_CSSL_FP_FUNCTION_CALL_VOID_END(...) \
  MCUX_CSSL_FP_FUNCTION_CALL_VOID_END_IMPL(__VA_ARGS__)

#define MCUX_CSSL_FP_FUNCTION_CALLED(...) \
  MCUX_CSSL_FP_FUNCTION_CALLED_IMPL(__VA_ARGS__)
 

#define MCUX_CSSL_FP_FUNCTION_ENTERED(id) \
  MCUX_CSSL_FP_FUNCTION_ENTERED_IMPL(id)
 


#define MCUX_CSSL_FP_LOOP_DECL(id) \
  MCUX_CSSL_FP_LOOP_DECL_IMPL(id)

#define MCUX_CSSL_FP_LOOP_ITERATION(...) \
  MCUX_CSSL_FP_LOOP_ITERATION_IMPL(__VA_ARGS__, MCUX_CSSL_FP_VOID_EXPECTATION_IMPL())

#define MCUX_CSSL_FP_LOOP_ITERATIONS(id, count) \
  MCUX_CSSL_FP_LOOP_ITERATIONS_IMPL(id, count)
 
 


#define MCUX_CSSL_FP_BRANCH_DECL(id) \
  MCUX_CSSL_FP_BRANCH_DECL_IMPL(id)

#define MCUX_CSSL_FP_BRANCH_POSITIVE(...) \
  MCUX_CSSL_FP_BRANCH_POSITIVE_IMPL(__VA_ARGS__, MCUX_CSSL_FP_VOID_EXPECTATION_IMPL())

#define MCUX_CSSL_FP_BRANCH_NEGATIVE(...) \
  MCUX_CSSL_FP_BRANCH_NEGATIVE_IMPL(__VA_ARGS__, MCUX_CSSL_FP_VOID_EXPECTATION_IMPL())

#define MCUX_CSSL_FP_BRANCH_TAKEN_POSITIVE(...) \
  MCUX_CSSL_FP_BRANCH_TAKEN_POSITIVE_IMPL(__VA_ARGS__)

#define MCUX_CSSL_FP_BRANCH_TAKEN_NEGATIVE(...) \
  MCUX_CSSL_FP_BRANCH_TAKEN_NEGATIVE_IMPL(__VA_ARGS__)
 
 


#define MCUX_CSSL_FP_SWITCH_DECL(id) \
  MCUX_CSSL_FP_SWITCH_DECL_IMPL(id)

#define MCUX_CSSL_FP_SWITCH_CASE(...) \
  MCUX_CSSL_FP_SWITCH_CASE_IMPL(__VA_ARGS__, MCUX_CSSL_FP_VOID_EXPECTATION_IMPL())

#define MCUX_CSSL_FP_SWITCH_DEFAULT(...) \
  MCUX_CSSL_FP_SWITCH_DEFAULT_IMPL(__VA_ARGS__, MCUX_CSSL_FP_VOID_EXPECTATION_IMPL())

#define MCUX_CSSL_FP_SWITCH_TAKEN(...) \
  MCUX_CSSL_FP_SWITCH_TAKEN_IMPL(__VA_ARGS__)

#define MCUX_CSSL_FP_SWITCH_TAKEN_DEFAULT(...) \
  MCUX_CSSL_FP_SWITCH_TAKEN_DEFAULT_IMPL(__VA_ARGS__)
 
 


#define MCUX_CSSL_FP_EXPECT(...) \
  MCUX_CSSL_FP_EXPECT_IMPL(__VA_ARGS__, MCUX_CSSL_FP_VOID_EXPECTATION_IMPL())

#define MCUX_CSSL_FP_CONDITIONAL(condition, ...) \
  MCUX_CSSL_FP_CONDITIONAL_IMPL((condition), __VA_ARGS__, MCUX_CSSL_FP_VOID_EXPECTATION_IMPL())

#define MCUX_CSSL_FP_ASSERT(...) \
  MCUX_CSSL_FP_ASSERT_IMPL(__VA_ARGS__)
 
MCUX_CSSL_ANALYSIS_STOP_PATTERN_URL_IN_COMMENTS()
 
#endif /* MCUX_CSSL_FLOW_PROTECTION_H_ */