alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
5d13a0b544
esp-idf/components/esp_common/include/esp_check.h

318 lines
19 KiB
C
Raw Normal View History

esp_common: add generic check macros Add four check maros: * ESP_RETURN_ON_ERROR() * ESP_GOTO_ON_ERROR() * ESP_RETURN_ON_FALSE() * ESP_GOTO_ON_FALSE() Also add a `xx_ISR` version for each of them, which can be used in ISR.
2021-03-03 04:18:11 -05:00
// Copyright 2021 Espressif Systems (Shanghai) PTE LTD
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
#pragma once
#include "esp_err.h"
#include "esp_log.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* Macro which can be used to check the error code. If the code is not ESP_OK, it prints the message and returns.
*/
#if defined(CONFIG_COMPILER_OPTIMIZATION_CHECKS_SILENT)
#define ESP_RETURN_ON_ERROR(x, log_tag, format, ...) do { \
build: fix unused tag string Closes https://github.com/espressif/esp-idf/issues/8250
2022-01-17 01:37:30 -05:00
(void)log_tag; \
esp_common: add generic check macros Add four check maros: * ESP_RETURN_ON_ERROR() * ESP_GOTO_ON_ERROR() * ESP_RETURN_ON_FALSE() * ESP_GOTO_ON_FALSE() Also add a `xx_ISR` version for each of them, which can be used in ISR.
2021-03-03 04:18:11 -05:00
esp_err_t err_rc_ = (x); \
if (unlikely(err_rc_ != ESP_OK)) { \
return err_rc_; \
} \
} while(0)
/**
* A version of ESP_RETURN_ON_ERROR() macro that can be called from ISR.
*/
#define ESP_RETURN_ON_ERROR_ISR(x, log_tag, format, ...) do { \
build: fix unused tag string Closes https://github.com/espressif/esp-idf/issues/8250
2022-01-17 01:37:30 -05:00
(void)log_tag; \
esp_common: add generic check macros Add four check maros: * ESP_RETURN_ON_ERROR() * ESP_GOTO_ON_ERROR() * ESP_RETURN_ON_FALSE() * ESP_GOTO_ON_FALSE() Also add a `xx_ISR` version for each of them, which can be used in ISR.
2021-03-03 04:18:11 -05:00
esp_err_t err_rc_ = (x); \
if (unlikely(err_rc_ != ESP_OK)) { \
return err_rc_; \
} \
} while(0)
/**
* Macro which can be used to check the error code. If the code is not ESP_OK, it prints the message,
* sets the local variable 'ret' to the code, and then exits by jumping to 'goto_tag'.
*/
#define ESP_GOTO_ON_ERROR(x, goto_tag, log_tag, format, ...) do { \
build: fix unused tag string Closes https://github.com/espressif/esp-idf/issues/8250
2022-01-17 01:37:30 -05:00
(void)log_tag; \
esp_common: add generic check macros Add four check maros: * ESP_RETURN_ON_ERROR() * ESP_GOTO_ON_ERROR() * ESP_RETURN_ON_FALSE() * ESP_GOTO_ON_FALSE() Also add a `xx_ISR` version for each of them, which can be used in ISR.
2021-03-03 04:18:11 -05:00
esp_err_t err_rc_ = (x); \
if (unlikely(err_rc_ != ESP_OK)) { \
ret = err_rc_; \
goto goto_tag; \
} \
} while(0)
[cxx]: No ##__VA_ARGS__ in public header files * ##__VA_ARGS__ is replaced by __VA_OPT__(,) and __VA_ARGS if C++20 is used. * Affected header files are: esp_log.h, portmacro.h and esp_check.h * Closes https://github.com/espressif/esp-idf/pull/6692
2021-05-20 23:09:20 -04:00
/**
* A version of ESP_GOTO_ON_ERROR() macro that can be called from ISR.
*/
#define ESP_GOTO_ON_ERROR_ISR(x, goto_tag, log_tag, format, ...) do { \
build: fix unused tag string Closes https://github.com/espressif/esp-idf/issues/8250
2022-01-17 01:37:30 -05:00
(void)log_tag; \
esp_common: add generic check macros Add four check maros: * ESP_RETURN_ON_ERROR() * ESP_GOTO_ON_ERROR() * ESP_RETURN_ON_FALSE() * ESP_GOTO_ON_FALSE() Also add a `xx_ISR` version for each of them, which can be used in ISR.
2021-03-03 04:18:11 -05:00
esp_err_t err_rc_ = (x); \
if (unlikely(err_rc_ != ESP_OK)) { \
ret = err_rc_; \
goto goto_tag; \
} \
} while(0)
[cxx]: No ##__VA_ARGS__ in public header files * ##__VA_ARGS__ is replaced by __VA_OPT__(,) and __VA_ARGS if C++20 is used. * Affected header files are: esp_log.h, portmacro.h and esp_check.h * Closes https://github.com/espressif/esp-idf/pull/6692
2021-05-20 23:09:20 -04:00
/**
* Macro which can be used to check the condition. If the condition is not 'true', it prints the message
* and returns with the supplied 'err_code'.
*/
#define ESP_RETURN_ON_FALSE(a, err_code, log_tag, format, ...) do { \
build: fix unused tag string Closes https://github.com/espressif/esp-idf/issues/8250
2022-01-17 01:37:30 -05:00
(void)log_tag; \
[cxx]: No ##__VA_ARGS__ in public header files * ##__VA_ARGS__ is replaced by __VA_OPT__(,) and __VA_ARGS if C++20 is used. * Affected header files are: esp_log.h, portmacro.h and esp_check.h * Closes https://github.com/espressif/esp-idf/pull/6692
2021-05-20 23:09:20 -04:00
if (unlikely(!(a))) { \
return err_code; \
} \
} while(0)
/**
* A version of ESP_RETURN_ON_FALSE() macro that can be called from ISR.
*/
#define ESP_RETURN_ON_FALSE_ISR(a, err_code, log_tag, format, ...) do { \
build: fix unused tag string Closes https://github.com/espressif/esp-idf/issues/8250
2022-01-17 01:37:30 -05:00
(void)log_tag; \
[cxx]: No ##__VA_ARGS__ in public header files * ##__VA_ARGS__ is replaced by __VA_OPT__(,) and __VA_ARGS if C++20 is used. * Affected header files are: esp_log.h, portmacro.h and esp_check.h * Closes https://github.com/espressif/esp-idf/pull/6692
2021-05-20 23:09:20 -04:00
if (unlikely(!(a))) { \
return err_code; \
} \
} while(0)
/**
* Macro which can be used to check the condition. If the condition is not 'true', it prints the message,
* sets the local variable 'ret' to the supplied 'err_code', and then exits by jumping to 'goto_tag'.
*/
#define ESP_GOTO_ON_FALSE(a, err_code, goto_tag, log_tag, format, ...) do { \
build: fix unused tag string Closes https://github.com/espressif/esp-idf/issues/8250
2022-01-17 01:37:30 -05:00
(void)log_tag; \
[cxx]: No ##__VA_ARGS__ in public header files * ##__VA_ARGS__ is replaced by __VA_OPT__(,) and __VA_ARGS if C++20 is used. * Affected header files are: esp_log.h, portmacro.h and esp_check.h * Closes https://github.com/espressif/esp-idf/pull/6692
2021-05-20 23:09:20 -04:00
if (unlikely(!(a))) { \
ret = err_code; \
goto goto_tag; \
} \
} while (0)
/**
* A version of ESP_GOTO_ON_FALSE() macro that can be called from ISR.
*/
#define ESP_GOTO_ON_FALSE_ISR(a, err_code, goto_tag, log_tag, format, ...) do { \
build: fix unused tag string Closes https://github.com/espressif/esp-idf/issues/8250
2022-01-17 01:37:30 -05:00
(void)log_tag; \
[cxx]: No ##__VA_ARGS__ in public header files * ##__VA_ARGS__ is replaced by __VA_OPT__(,) and __VA_ARGS if C++20 is used. * Affected header files are: esp_log.h, portmacro.h and esp_check.h * Closes https://github.com/espressif/esp-idf/pull/6692
2021-05-20 23:09:20 -04:00
if (unlikely(!(a))) { \
ret = err_code; \
goto goto_tag; \
} \
} while (0)
#else // !CONFIG_COMPILER_OPTIMIZATION_CHECKS_SILENT
/**
* In the future, we want to switch to C++20. We also want to become compatible with clang.
* Hence, we provide two versions of the following macros. The first one is using the GNU extension \#\#__VA_ARGS__.
* The second one is using the C++20 feature __VA_OPT__(,). This allows users to compile their code with
* standard C++20 enabled instead of the GNU extension. Below C++20, we haven't found any good alternative to
* using \#\#__VA_ARGS__.
*/
#if defined(__cplusplus) && (__cplusplus > 201703L)
/**
* Macro which can be used to check the error code. If the code is not ESP_OK, it prints the message and returns.
*/
#define ESP_RETURN_ON_ERROR(x, log_tag, format, ...) do { \
esp_err_t err_rc_ = (x); \
if (unlikely(err_rc_ != ESP_OK)) { \
ESP_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__ __VA_OPT__(,) __VA_ARGS__); \
return err_rc_; \
} \
} while(0)
/**
* A version of ESP_RETURN_ON_ERROR() macro that can be called from ISR.
*/
#define ESP_RETURN_ON_ERROR_ISR(x, log_tag, format, ...) do { \
esp_err_t err_rc_ = (x); \
if (unlikely(err_rc_ != ESP_OK)) { \
ESP_EARLY_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__ __VA_OPT__(,) __VA_ARGS__); \
return err_rc_; \
} \
} while(0)
/**
* Macro which can be used to check the error code. If the code is not ESP_OK, it prints the message,
* sets the local variable 'ret' to the code, and then exits by jumping to 'goto_tag'.
*/
#define ESP_GOTO_ON_ERROR(x, goto_tag, log_tag, format, ...) do { \
esp_err_t err_rc_ = (x); \
if (unlikely(err_rc_ != ESP_OK)) { \
ESP_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__ __VA_OPT__(,) __VA_ARGS__); \
ret = err_rc_; \
goto goto_tag; \
} \
} while(0)
esp_common: add generic check macros Add four check maros: * ESP_RETURN_ON_ERROR() * ESP_GOTO_ON_ERROR() * ESP_RETURN_ON_FALSE() * ESP_GOTO_ON_FALSE() Also add a `xx_ISR` version for each of them, which can be used in ISR.
2021-03-03 04:18:11 -05:00
/**
* A version of ESP_GOTO_ON_ERROR() macro that can be called from ISR.
*/
[cxx]: No ##__VA_ARGS__ in public header files * ##__VA_ARGS__ is replaced by __VA_OPT__(,) and __VA_ARGS if C++20 is used. * Affected header files are: esp_log.h, portmacro.h and esp_check.h * Closes https://github.com/espressif/esp-idf/pull/6692
2021-05-20 23:09:20 -04:00
#define ESP_GOTO_ON_ERROR_ISR(x, goto_tag, log_tag, format, ...) do { \
esp_err_t err_rc_ = (x); \
if (unlikely(err_rc_ != ESP_OK)) { \
ESP_EARLY_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__ __VA_OPT__(,) __VA_ARGS__); \
ret = err_rc_; \
goto goto_tag; \
} \
} while(0)
/**
* Macro which can be used to check the condition. If the condition is not 'true', it prints the message
* and returns with the supplied 'err_code'.
*/
#define ESP_RETURN_ON_FALSE(a, err_code, log_tag, format, ...) do { \
if (unlikely(!(a))) { \
ESP_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__ __VA_OPT__(,) __VA_ARGS__); \
return err_code; \
} \
} while(0)
/**
* A version of ESP_RETURN_ON_FALSE() macro that can be called from ISR.
*/
#define ESP_RETURN_ON_FALSE_ISR(a, err_code, log_tag, format, ...) do { \
if (unlikely(!(a))) { \
ESP_EARLY_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__ __VA_OPT__(,) __VA_ARGS__); \
return err_code; \
} \
} while(0)
/**
* Macro which can be used to check the condition. If the condition is not 'true', it prints the message,
* sets the local variable 'ret' to the supplied 'err_code', and then exits by jumping to 'goto_tag'.
*/
#define ESP_GOTO_ON_FALSE(a, err_code, goto_tag, log_tag, format, ...) do { \
if (unlikely(!(a))) { \
ESP_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__ __VA_OPT__(,) __VA_ARGS__); \
ret = err_code; \
goto goto_tag; \
} \
} while (0)
/**
* A version of ESP_GOTO_ON_FALSE() macro that can be called from ISR.
*/
#define ESP_GOTO_ON_FALSE_ISR(a, err_code, goto_tag, log_tag, format, ...) do { \
if (unlikely(!(a))) { \
ESP_EARLY_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__ __VA_OPT__(,) __VA_ARGS__); \
ret = err_code; \
goto goto_tag; \
} \
} while (0)
#else // !(defined(__cplusplus) && (__cplusplus > 201703L))
/**
* Macro which can be used to check the error code. If the code is not ESP_OK, it prints the message and returns.
*/
#define ESP_RETURN_ON_ERROR(x, log_tag, format, ...) do { \
esp_err_t err_rc_ = (x); \
if (unlikely(err_rc_ != ESP_OK)) { \
ESP_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
return err_rc_; \
} \
} while(0)
/**
* A version of ESP_RETURN_ON_ERROR() macro that can be called from ISR.
*/
#define ESP_RETURN_ON_ERROR_ISR(x, log_tag, format, ...) do { \
esp_common: add generic check macros Add four check maros: * ESP_RETURN_ON_ERROR() * ESP_GOTO_ON_ERROR() * ESP_RETURN_ON_FALSE() * ESP_GOTO_ON_FALSE() Also add a `xx_ISR` version for each of them, which can be used in ISR.
2021-03-03 04:18:11 -05:00
esp_err_t err_rc_ = (x); \
if (unlikely(err_rc_ != ESP_OK)) { \
[cxx]: No ##__VA_ARGS__ in public header files * ##__VA_ARGS__ is replaced by __VA_OPT__(,) and __VA_ARGS if C++20 is used. * Affected header files are: esp_log.h, portmacro.h and esp_check.h * Closes https://github.com/espressif/esp-idf/pull/6692
2021-05-20 23:09:20 -04:00
ESP_EARLY_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
return err_rc_; \
} \
} while(0)
/**
* Macro which can be used to check the error code. If the code is not ESP_OK, it prints the message,
* sets the local variable 'ret' to the code, and then exits by jumping to 'goto_tag'.
*/
#define ESP_GOTO_ON_ERROR(x, goto_tag, log_tag, format, ...) do { \
esp_err_t err_rc_ = (x); \
if (unlikely(err_rc_ != ESP_OK)) { \
ESP_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
esp_common: add generic check macros Add four check maros: * ESP_RETURN_ON_ERROR() * ESP_GOTO_ON_ERROR() * ESP_RETURN_ON_FALSE() * ESP_GOTO_ON_FALSE() Also add a `xx_ISR` version for each of them, which can be used in ISR.
2021-03-03 04:18:11 -05:00
ret = err_rc_; \
goto goto_tag; \
} \
} while(0)
[cxx]: No ##__VA_ARGS__ in public header files * ##__VA_ARGS__ is replaced by __VA_OPT__(,) and __VA_ARGS if C++20 is used. * Affected header files are: esp_log.h, portmacro.h and esp_check.h * Closes https://github.com/espressif/esp-idf/pull/6692
2021-05-20 23:09:20 -04:00
/**
* A version of ESP_GOTO_ON_ERROR() macro that can be called from ISR.
*/
esp_common: add generic check macros Add four check maros: * ESP_RETURN_ON_ERROR() * ESP_GOTO_ON_ERROR() * ESP_RETURN_ON_FALSE() * ESP_GOTO_ON_FALSE() Also add a `xx_ISR` version for each of them, which can be used in ISR.
2021-03-03 04:18:11 -05:00
#define ESP_GOTO_ON_ERROR_ISR(x, goto_tag, log_tag, format, ...) do { \
esp_err_t err_rc_ = (x); \
if (unlikely(err_rc_ != ESP_OK)) { \
ESP_EARLY_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
ret = err_rc_; \
goto goto_tag; \
} \
} while(0)
/**
* Macro which can be used to check the condition. If the condition is not 'true', it prints the message
* and returns with the supplied 'err_code'.
*/
#define ESP_RETURN_ON_FALSE(a, err_code, log_tag, format, ...) do { \
if (unlikely(!(a))) { \
ESP_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
return err_code; \
} \
} while(0)
/**
* A version of ESP_RETURN_ON_FALSE() macro that can be called from ISR.
*/
#define ESP_RETURN_ON_FALSE_ISR(a, err_code, log_tag, format, ...) do { \
if (unlikely(!(a))) { \
ESP_EARLY_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
return err_code; \
} \
} while(0)
/**
* Macro which can be used to check the condition. If the condition is not 'true', it prints the message,
* sets the local variable 'ret' to the supplied 'err_code', and then exits by jumping to 'goto_tag'.
*/
#define ESP_GOTO_ON_FALSE(a, err_code, goto_tag, log_tag, format, ...) do { \
if (unlikely(!(a))) { \
ESP_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
ret = err_code; \
goto goto_tag; \
} \
} while (0)
/**
* A version of ESP_GOTO_ON_FALSE() macro that can be called from ISR.
*/
#define ESP_GOTO_ON_FALSE_ISR(a, err_code, goto_tag, log_tag, format, ...) do { \
if (unlikely(!(a))) { \
ESP_EARLY_LOGE(log_tag, "%s(%d): " format, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
ret = err_code; \
goto goto_tag; \
} \
} while (0)
[cxx]: No ##__VA_ARGS__ in public header files * ##__VA_ARGS__ is replaced by __VA_OPT__(,) and __VA_ARGS if C++20 is used. * Affected header files are: esp_log.h, portmacro.h and esp_check.h * Closes https://github.com/espressif/esp-idf/pull/6692
2021-05-20 23:09:20 -04:00
#endif // !(defined(__cplusplus) && (__cplusplus > 201703L))
#endif // !CONFIG_COMPILER_OPTIMIZATION_CHECKS_SILENT
esp_common: add generic check macros Add four check maros: * ESP_RETURN_ON_ERROR() * ESP_GOTO_ON_ERROR() * ESP_RETURN_ON_FALSE() * ESP_GOTO_ON_FALSE() Also add a `xx_ISR` version for each of them, which can be used in ISR.
2021-03-03 04:18:11 -05:00
#ifdef __cplusplus
}
#endif
Reference in New Issue Copy Permalink