192 lines
6.9 KiB
C
192 lines
6.9 KiB
C
/**
|
|
* Copyright (c) 2013 - 2017, Nordic Semiconductor ASA
|
|
*
|
|
* All rights reserved.
|
|
*
|
|
* 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, except as embedded into a Nordic
|
|
* Semiconductor ASA integrated circuit in a product or a software update for
|
|
* such product, 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 Nordic Semiconductor ASA nor the names of its
|
|
* contributors may be used to endorse or promote products derived from this
|
|
* software without specific prior written permission.
|
|
*
|
|
* 4. This software, with or without modification, must only be used with a
|
|
* Nordic Semiconductor ASA integrated circuit.
|
|
*
|
|
* 5. Any software provided in binary form under this license must not be reverse
|
|
* engineered, decompiled, modified and/or disassembled.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
|
|
* OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
* OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
* DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA 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.
|
|
*
|
|
*/
|
|
/**@file
|
|
*
|
|
|
|
* @defgroup sdk_common_macros SDK Common Header
|
|
* @ingroup app_common
|
|
* @brief Macros for parameter checking and similar tasks
|
|
* @{
|
|
*/
|
|
|
|
#ifndef SDK_MACROS_H__
|
|
#define SDK_MACROS_H__
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
/**@brief Macro for verifying statement to be true. It will cause the exterior function to return
|
|
* err_code if the statement is not true.
|
|
*
|
|
* @param[in] statement Statement to test.
|
|
* @param[in] err_code Error value to return if test was invalid.
|
|
*
|
|
* @retval nothing, but will cause the exterior function to return @p err_code if @p statement
|
|
* is false.
|
|
*/
|
|
#define VERIFY_TRUE(statement, err_code) \
|
|
do \
|
|
{ \
|
|
if (!(statement)) \
|
|
{ \
|
|
return err_code; \
|
|
} \
|
|
} while (0)
|
|
|
|
|
|
/**@brief Macro for verifying statement to be true. It will cause the exterior function to return
|
|
* if the statement is not true.
|
|
*
|
|
* @param[in] statement Statement to test.
|
|
*/
|
|
#define VERIFY_TRUE_VOID(statement) VERIFY_TRUE((statement), )
|
|
|
|
|
|
/**@brief Macro for verifying statement to be false. It will cause the exterior function to return
|
|
* err_code if the statement is not false.
|
|
*
|
|
* @param[in] statement Statement to test.
|
|
* @param[in] err_code Error value to return if test was invalid.
|
|
*
|
|
* @retval nothing, but will cause the exterior function to return @p err_code if @p statement
|
|
* is true.
|
|
*/
|
|
#define VERIFY_FALSE(statement, err_code) \
|
|
do \
|
|
{ \
|
|
if ((statement)) \
|
|
{ \
|
|
return err_code; \
|
|
} \
|
|
} while (0)
|
|
|
|
|
|
/**@brief Macro for verifying statement to be false. It will cause the exterior function to return
|
|
* if the statement is not false.
|
|
*
|
|
* @param[in] statement Statement to test.
|
|
*/
|
|
#define VERIFY_FALSE_VOID(statement) VERIFY_FALSE((statement), )
|
|
|
|
|
|
/**@brief Macro for verifying that a function returned NRF_SUCCESS. It will cause the exterior
|
|
* function to return err_code if the err_code is not @ref NRF_SUCCESS.
|
|
*
|
|
* @param[in] err_code The error code to check.
|
|
*/
|
|
#ifdef DISABLE_PARAM_CHECK
|
|
#define VERIFY_SUCCESS()
|
|
#else
|
|
#define VERIFY_SUCCESS(err_code) VERIFY_TRUE((err_code) == NRF_SUCCESS, (err_code))
|
|
#endif /* DISABLE_PARAM_CHECK */
|
|
|
|
|
|
/**@brief Macro for verifying that a function returned NRF_SUCCESS. It will cause the exterior
|
|
* function to return if the err_code is not @ref NRF_SUCCESS.
|
|
*
|
|
* @param[in] err_code The error code to check.
|
|
*/
|
|
#ifdef DISABLE_PARAM_CHECK
|
|
#define VERIFY_SUCCESS_VOID()
|
|
#else
|
|
#define VERIFY_SUCCESS_VOID(err_code) VERIFY_TRUE_VOID((err_code) == NRF_SUCCESS)
|
|
#endif /* DISABLE_PARAM_CHECK */
|
|
|
|
|
|
/**@brief Macro for verifying that the module is initialized. It will cause the exterior function to
|
|
* return @ref NRF_ERROR_INVALID_STATE if not.
|
|
*
|
|
* @note MODULE_INITIALIZED must be defined in each module using this macro. MODULE_INITIALIZED
|
|
* should be true if the module is initialized, false if not.
|
|
*/
|
|
#ifdef DISABLE_PARAM_CHECK
|
|
#define VERIFY_MODULE_INITIALIZED()
|
|
#else
|
|
#define VERIFY_MODULE_INITIALIZED() VERIFY_TRUE((MODULE_INITIALIZED), NRF_ERROR_INVALID_STATE)
|
|
#endif /* DISABLE_PARAM_CHECK */
|
|
|
|
|
|
/**@brief Macro for verifying that the module is initialized. It will cause the exterior function to
|
|
* return if not.
|
|
*
|
|
* @note MODULE_INITIALIZED must be defined in each module using this macro. MODULE_INITIALIZED
|
|
* should be true if the module is initialized, false if not.
|
|
*/
|
|
#ifdef DISABLE_PARAM_CHECK
|
|
#define VERIFY_MODULE_INITIALIZED_VOID()
|
|
#else
|
|
#define VERIFY_MODULE_INITIALIZED_VOID() VERIFY_TRUE_VOID((MODULE_INITIALIZED))
|
|
#endif /* DISABLE_PARAM_CHECK */
|
|
|
|
|
|
/**@brief Macro for verifying that the module is initialized. It will cause the exterior function to
|
|
* return if not.
|
|
*
|
|
* @param[in] param The variable to check if is NULL.
|
|
*/
|
|
#ifdef DISABLE_PARAM_CHECK
|
|
#define VERIFY_PARAM_NOT_NULL()
|
|
#else
|
|
#define VERIFY_PARAM_NOT_NULL(param) VERIFY_FALSE(((param) == NULL), NRF_ERROR_NULL)
|
|
#endif /* DISABLE_PARAM_CHECK */
|
|
|
|
|
|
/**@brief Macro for verifying that the module is initialized. It will cause the exterior function to
|
|
* return if not.
|
|
*
|
|
* @param[in] param The variable to check if is NULL.
|
|
*/
|
|
#ifdef DISABLE_PARAM_CHECK
|
|
#define VERIFY_PARAM_NOT_NULL_VOID()
|
|
#else
|
|
#define VERIFY_PARAM_NOT_NULL_VOID(param) VERIFY_FALSE_VOID(((param) == NULL))
|
|
#endif /* DISABLE_PARAM_CHECK */
|
|
|
|
/** @} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif // SDK_MACROS_H__
|
|
|