mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
8712fd3ccf
Renamed the internal rc to __err_rc to avoid clashes with local variables.
This code would not do the expected thing with the original ESP_ERROR_CHECK macro:
esp_err_t my_func(esp_err_t x)
{
assert(x == 23);
}
esp_err_t rc = 23; //some value that is important fo the user
ESP_ERROR_CHECK(my_func(rc));
The macro will expand to:
esp_err_t rc = (my_func(rc));
And the code will assert, as my_func will receive a random value - whatever is in the internal macro rc temp variable. This is due to the C weirdness of allowing this code:
int x = x; //x has a random value.
83 lines
2.8 KiB
C
83 lines
2.8 KiB
C
// Copyright 2015-2016 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 <stdint.h>
|
|
#include <stdio.h>
|
|
#include <assert.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef int32_t esp_err_t;
|
|
|
|
/* Definitions for error constants. */
|
|
|
|
#define ESP_OK 0
|
|
#define ESP_FAIL -1
|
|
|
|
#define ESP_ERR_NO_MEM 0x101
|
|
#define ESP_ERR_INVALID_ARG 0x102
|
|
#define ESP_ERR_INVALID_STATE 0x103
|
|
#define ESP_ERR_INVALID_SIZE 0x104
|
|
#define ESP_ERR_NOT_FOUND 0x105
|
|
#define ESP_ERR_NOT_SUPPORTED 0x106
|
|
#define ESP_ERR_TIMEOUT 0x107
|
|
#define ESP_ERR_INVALID_RESPONSE 0x108
|
|
#define ESP_ERR_INVALID_CRC 0x109
|
|
#define ESP_ERR_INVALID_VERSION 0x10A
|
|
#define ESP_ERR_INVALID_MAC 0x10B
|
|
|
|
#define ESP_ERR_WIFI_BASE 0x3000 /*!< Starting number of WiFi error codes */
|
|
|
|
void _esp_error_check_failed(esp_err_t rc, const char *file, int line, const char *function, const char *expression) __attribute__((noreturn));
|
|
|
|
#ifndef __ASSERT_FUNC
|
|
/* This won't happen on IDF, which defines __ASSERT_FUNC in assert.h, but it does happen when building on the host which
|
|
uses /usr/include/assert.h or equivalent.
|
|
*/
|
|
#ifdef __ASSERT_FUNCTION
|
|
#define __ASSERT_FUNC __ASSERT_FUNCTION /* used in glibc assert.h */
|
|
#else
|
|
#define __ASSERT_FUNC "??"
|
|
#endif
|
|
#endif
|
|
|
|
/**
|
|
* Macro which can be used to check the error code,
|
|
* and terminate the program in case the code is not ESP_OK.
|
|
* Prints the error code, error location, and the failed statement to serial output.
|
|
*
|
|
* Disabled if assertions are disabled.
|
|
*/
|
|
#ifdef NDEBUG
|
|
#define ESP_ERROR_CHECK(x) do { \
|
|
esp_err_t __err_rc = (x); \
|
|
(void) sizeof(__err_rc); \
|
|
} while(0);
|
|
#else
|
|
#define ESP_ERROR_CHECK(x) do { \
|
|
esp_err_t __err_rc = (x); \
|
|
if (__err_rc != ESP_OK) { \
|
|
_esp_error_check_failed(__err_rc, __FILE__, __LINE__, \
|
|
__ASSERT_FUNC, #x); \
|
|
} \
|
|
} while(0);
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|