Skip to content

Commit fc5c1fb

Browse files
Lzw655Lzw655
committed
feat(log): update tag
1 parent d6bfe55 commit fc5c1fb

24 files changed

+467
-395
lines changed

‎.codespellrc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
11
[codespell]
2-
skip = ./src/touch/port/esp_lcd_touch_xpt2046.c

‎.github/workflows/build_test.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
build:
1010
strategy:
1111
matrix:
12-
idf_ver: ["release-v5.1", "release-v5.2", "release-v5.3"]
12+
idf_ver: ["release-v5.1", "release-v5.2", "release-v5.3"]
1313
idf_target: ["esp32", "esp32s3"]
1414
runs-on: ubuntu-20.04
1515
container: espressif/idf:${{ matrix.idf_ver }}
@@ -28,3 +28,7 @@ jobs:
2828
idf.py build
2929
rm -rf sdkconfig build managed_components dependencies.lock
3030
idf.py -DSDKCONFIG_DEFAULTS="sdkconfig.defaults;sdkconfig.ci.cxx_exceptions" build
31+
rm -rf sdkconfig build managed_components dependencies.lock
32+
idf.py -DSDKCONFIG_DEFAULTS="sdkconfig.defaults;sdkconfig.ci.cxx_exceptions;sdkconfig.ci.esp_mem" build
33+
rm -rf sdkconfig build managed_components dependencies.lock
34+
idf.py -DSDKCONFIG_DEFAULTS="sdkconfig.defaults;sdkconfig.ci.cxx_exceptions;sdkconfig.ci.custom_mem" build

‎Kconfig

Lines changed: 53 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,111 +1,120 @@
11
menu "ESP Library Utils"
2-
config ESP_UTILS_CONFIG_FILE_SKIP
3-
bool "Unckeck this to ignore `esp_utils_config.h`"
2+
config ESP_UTILS_CONF_FILE_SKIP
3+
bool "Unckeck this to use custom `esp_utils_conf.h`"
44
default y
55

66
menu "Check functions"
7-
config ESP_UTILS_ENABLE_CHECK
8-
bool "Enable error check"
7+
depends on ESP_UTILS_CONF_FILE_SKIP
8+
config ESP_UTILS_CONF_ENABLE_CHECK
9+
bool "Enable check functions"
910
default y
1011
help
1112
If enabled, the driver will check the function parameters, return value, etc. Disable them will reduce the code size.
1213

13-
config ESP_UTILS_CHECK_WITH_ERROR_LOG
14-
bool "Print error message on error"
14+
config ESP_UTILS_CONF_CHECK_WITH_ERROR_LOG
15+
bool "Print log messages on error"
1516
default y
16-
depends on ESP_UTILS_ENABLE_CHECK
17+
depends on ESP_UTILS_CONF_ENABLE_CHECK
1718
help
1819
If enabled, the driver will print error message when check failed.
1920

20-
config ESP_UTILS_CHECK_WITH_ASSERT
21+
config ESP_UTILS_CONF_CHECK_WITH_ASSERT
2122
bool "Assert on error"
2223
default n
23-
depends on ESP_UTILS_ENABLE_CHECK
24+
depends on ESP_UTILS_CONF_ENABLE_CHECK
2425
help
2526
If enabled, the driver will assert when check failed.
2627
endmenu
2728

2829
menu "Log functions"
29-
config ESP_UTILS_ENABLE_LOG
30-
bool "Enable output debug log"
30+
depends on ESP_UTILS_CONF_FILE_SKIP
31+
config ESP_UTILS_CONF_ENABLE_LOG
32+
bool "Enable log functions"
3133
default y
3234
help
3335
If enabled, the driver will output log for debugging.
3436

35-
config ESP_UTILS_LOG_BUFFER_SIZE
36-
int "Buffer size for log messages"
37-
depends on ESP_UTILS_ENABLE_LOG
37+
config ESP_UTILS_CONF_LOG_BUFFER_SIZE
38+
int "Buffer size for formatting messages"
39+
depends on ESP_UTILS_CONF_ENABLE_LOG
3840
default 256
3941

40-
choice ESP_UTILS_LOG_LEVEL
41-
prompt "Log level for all messages"
42-
depends on ESP_UTILS_ENABLE_LOG
43-
default ESP_UTILS_LOG_LEVEL_INFO
42+
choice ESP_UTILS_CONF_LOG_LEVEL
43+
prompt "Select global log level"
44+
depends on ESP_UTILS_CONF_ENABLE_LOG
45+
default ESP_UTILS_CONF_LOG_LEVEL_INFO
4446

45-
config ESP_UTILS_LOG_LEVEL_DEBUG
47+
config ESP_UTILS_CONF_LOG_LEVEL_DEBUG
4648
bool "Debug"
4749
help
4850
Extra information which is not necessary for normal use (values, pointers, sizes, etc)
4951

50-
config ESP_UTILS_LOG_LEVEL_INFO
52+
config ESP_UTILS_CONF_LOG_LEVEL_INFO
5153
bool "Info"
5254
help
5355
Information messages which describe the normal flow of events
5456

55-
config ESP_UTILS_LOG_LEVEL_WARNING
57+
config ESP_UTILS_CONF_LOG_LEVEL_WARNING
5658
bool "Warning"
5759
help
5860
Error conditions from which recovery measures have been taken
5961

60-
config ESP_UTILS_LOG_LEVEL_ERROR
62+
config ESP_UTILS_CONF_LOG_LEVEL_ERROR
6163
bool "Error"
6264
help
6365
Critical errors, software module cannot recover on its own
6466
endchoice
6567

66-
config ESP_UTILS_LOG_GLOBAL_LEVEL
68+
config ESP_UTILS_CONF_LOG_LEVEL
6769
int
68-
default 0 if ESP_UTILS_LOG_LEVEL_DEBUG
69-
default 1 if ESP_UTILS_LOG_LEVEL_INFO
70-
default 2 if ESP_UTILS_LOG_LEVEL_WARNING
71-
default 3 if ESP_UTILS_LOG_LEVEL_ERROR
70+
default 0 if ESP_UTILS_CONF_LOG_LEVEL_DEBUG
71+
default 1 if ESP_UTILS_CONF_LOG_LEVEL_INFO
72+
default 2 if ESP_UTILS_CONF_LOG_LEVEL_WARNING
73+
default 3 if ESP_UTILS_CONF_LOG_LEVEL_ERROR
7274

73-
config ESP_UTILS_ENABLE_LOG_TRACE
75+
config ESP_UTILS_CONF_ENABLE_LOG_TRACE
7476
bool "Enable trace function"
75-
depends on ESP_UTILS_LOG_LEVEL_DEBUG
77+
depends on ESP_UTILS_CONF_LOG_LEVEL_DEBUG
7678
default n
7779
help
7880
If enabled, the driver will print trace log messages when enter/exit functions, useful for debugging
7981
endmenu
8082

8183
menu "Memory functions"
82-
choice ESP_UTILS_MEM_GENERAL_ALLOC_TYPE_CHOICE
84+
depends on ESP_UTILS_CONF_FILE_SKIP
85+
choice ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE_CHOICE
8386
prompt "Select general allocation type"
84-
default ESP_UTILS_MEM_GENERAL_ALLOC_TYPE_STDLIB
87+
default ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE_STDLIB
8588

86-
config ESP_UTILS_MEM_GENERAL_ALLOC_TYPE_STDLIB
89+
config ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE_STDLIB
8790
bool "Standard library (malloc, free)"
8891

89-
config ESP_UTILS_MEM_GENERAL_ALLOC_TYPE_ESP
92+
config ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE_ESP
9093
bool "ESP (heap_caps_malloc, free)"
9194

92-
config ESP_UTILS_MEM_GENERAL_ALLOC_TYPE_MICROPYTHON
95+
config ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE_MICROPYTHON
9396
bool "MicroPython (mp_malloc, mp_free)"
9497

95-
config ESP_UTILS_MEM_GENERAL_ALLOC_TYPE_CUSTOM
96-
bool "Custom (`ESP_UTILS_MEM_GENERAL_ALLOC_CUSTOM_MALLOC` and `ESP_UTILS_MEM_GENERAL_ALLOC_CUSTOM_FREE`)"
98+
config ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE_CUSTOM
99+
bool "Custom (`ESP_UTILS_CONF_MEM_GEN_ALLOC_CUSTOM_MALLOC` and `ESP_UTILS_CONF_MEM_GEN_ALLOC_CUSTOM_FREE`)"
97100
endchoice
98101

99-
config ESP_UTILS_MEM_GENERAL_ALLOC_TYPE
102+
config ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE
100103
int
101-
default 0 if ESP_UTILS_MEM_GENERAL_ALLOC_TYPE_STDLIB
102-
default 1 if ESP_UTILS_MEM_GENERAL_ALLOC_TYPE_ESP
103-
default 2 if ESP_UTILS_MEM_GENERAL_ALLOC_TYPE_MICROPYTHON
104-
default 3 if ESP_UTILS_MEM_GENERAL_ALLOC_TYPE_CUSTOM
105-
106-
config ESP_UTILS_MEM_GENERAL_ALLOC_CUSTOM_INCLUDE
104+
default 0 if ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE_STDLIB
105+
default 1 if ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE_ESP
106+
default 2 if ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE_MICROPYTHON
107+
default 3 if ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE_CUSTOM
108+
109+
config ESP_UTILS_CONF_MEM_GEN_ALLOC_ESP_ALIGN
110+
int "General esp memory alignment (bytes)"
111+
depends on ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE_ESP
112+
default 1
113+
range 1 1024
114+
115+
config ESP_UTILS_CONF_MEM_GEN_ALLOC_CUSTOM_INCLUDE
107116
string "General custom memory header file"
108-
depends on ESP_UTILS_MEM_GENERAL_ALLOC_TYPE_CUSTOM
117+
depends on ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE_CUSTOM
109118
default "stdlib.h"
110119
endmenu
111120
endmenu

‎esp_utils_config.h renamed to ‎esp_utils_conf.h

Lines changed: 39 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -9,84 +9,85 @@
99
// *INDENT-OFF*
1010

1111
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
12-
///////////////////////////////////////////////// Utils Configurations /////////////////////////////////////////////////
12+
///////////////////////////////////////////////// Check Configurations /////////////////////////////////////////////////
1313
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
1414
/**
15-
* Check functions related.
16-
*
1715
* These functions are used to check the function parameters, return value, etc. Disable them will reduce the code size.
1816
*
1917
*/
2018
/* Set to 1 if use `ESP_UTILS_CHECK_*()` macros */
21-
#define ESP_UTILS_ENABLE_CHECK (1) // 0/1
22-
#if ESP_UTILS_ENABLE_CHECK
19+
#define ESP_UTILS_CONF_ENABLE_CHECK (1) // 0/1
20+
#if ESP_UTILS_CONF_ENABLE_CHECK
2321
/* Set to 1 if print message when check failed */
24-
#define ESP_UTILS_CHECK_WITH_ERROR_LOG (1) // 0/1
22+
#define ESP_UTILS_CONF_CHECK_WITH_ERROR_LOG (1) // 0/1
2523

2624
/* Set to 1 if assert when check failed */
27-
#define ESP_UTILS_CHECK_WITH_ASSERT (0) // 0/1
28-
#endif // ESP_UTILS_ENABLE_CHECK
25+
#define ESP_UTILS_CONF_CHECK_WITH_ASSERT (0) // 0/1
26+
#endif // ESP_UTILS_CONF_ENABLE_CHECK
2927

28+
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
29+
////////////////////////////////////////////////// Log Configurations //////////////////////////////////////////////////
30+
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
3031
/**
31-
* Log functions related.
32-
*
3332
* These functions are used to print log messages. Disable them will reduce the code size.
3433
*
3534
*/
3635
/* Set to 1 if use `ESP_UTILS_LOG*()` macros */
37-
#define ESP_UTILS_ENABLE_LOG (1) // 0/1
38-
#if ESP_UTILS_ENABLE_LOG
36+
#define ESP_UTILS_CONF_ENABLE_LOG (1) // 0/1
37+
#if ESP_UTILS_CONF_ENABLE_LOG
3938
/**
4039
* Global log level, logs with a level lower than this will not be compiled. Choose one of the following:
41-
* - ESP_UTILS_LOG_LEVEL_DEBUG: Extra information which is not necessary for normal use (values, pointers, sizes,
42-
* etc) (lowest level)
40+
* - ESP_UTILS_LOG_LEVEL_DEBUG: Extra information which is not necessary for normal use (values, pointers, sizes, etc)
41+
* (lowest level)
4342
* - ESP_UTILS_LOG_LEVEL_INFO: Information messages which describe the normal flow of events
4443
* - ESP_UTILS_LOG_LEVEL_WARNING: Error conditions from which recovery measures have been taken
4544
* - ESP_UTILS_LOG_LEVEL_ERROR: Critical errors, software module cannot recover on its own (highest level)
4645
*
4746
*/
48-
#define ESP_UTILS_LOG_GLOBAL_LEVEL ESP_UTILS_LOG_LEVEL_INFO
49-
#if ESP_UTILS_LOG_GLOBAL_LEVEL == ESP_UTILS_LOG_LEVEL_DEBUG
47+
#define ESP_UTILS_CONF_LOG_LEVEL (ESP_UTILS_LOG_LEVEL_INFO)
48+
#if ESP_UTILS_CONF_LOG_LEVEL == ESP_UTILS_LOG_LEVEL_DEBUG
49+
5050
/* Set to 1 if print trace log messages when enter/exit functions, useful for debugging */
51-
#define ESP_UTILS_ENABLE_LOG_TRACE (0)
52-
#endif // ESP_UTILS_LOG_GLOBAL_LEVEL
51+
#define ESP_UTILS_CONF_ENABLE_LOG_TRACE (0)
52+
53+
#endif // ESP_UTILS_CONF_LOG_LEVEL
5354

5455
/* Log format buffer size */
55-
#define ESP_UTILS_LOG_BUFFER_SIZE (256)
56-
#endif // ESP_UTILS_ENABLE_LOG
56+
#define ESP_UTILS_CONF_LOG_BUFFER_SIZE (256)
57+
#endif // ESP_UTILS_CONF_ENABLE_LOG
5758

59+
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
60+
//////////////////////////////////////////////// Memory Configurations /////////////////////////////////////////////////
61+
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
5862
/**
59-
* Memory related
60-
*
61-
*/
62-
/**
63-
* Memory allocation type, choose one of the following:
63+
* General Memory allocation type, choose one of the following:
6464
* - ESP_UTILS_MEM_ALLOC_TYPE_STDLIB: Use the standard library memory allocation functions (malloc, free)
65-
* - ESP_UTILS_MEM_ALLOC_TYPE_ESP: Use the ESP-IDF memory allocation functions (heap_caps_malloc, heap_caps_free)
65+
* - ESP_UTILS_MEM_ALLOC_TYPE_ESP: Use the ESP-IDF memory allocation functions (heap_caps_aligned_alloc, heap_caps_free)
6666
* - ESP_UTILS_MEM_ALLOC_TYPE_MICROPYTHON: Use the MicroPython memory allocation functions (m_malloc, m_free)
6767
* - ESP_UTILS_MEM_ALLOC_TYPE_CUSTOM: Use custom memory allocation functions (ESP_UTILS_MEM_ALLOC_CUSTOM_MALLOC,
6868
* ESP_UTILS_MEM_ALLOC_CUSTOM_FREE)
6969
*
7070
*/
71-
#define ESP_UTILS_MEM_GENERAL_ALLOC_TYPE ESP_UTILS_MEM_ALLOC_TYPE_STDLIB
72-
#if ESP_UTILS_MEM_GENERAL_ALLOC_TYPE == ESP_UTILS_MEM_ALLOC_TYPE_ESP
71+
#define ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE (ESP_UTILS_MEM_ALLOC_TYPE_STDLIB)
72+
#if ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE == ESP_UTILS_MEM_ALLOC_TYPE_ESP
7373

74-
#define ESP_UTILS_MEM_GENERAL_ALLOC_ESP_CAPS (MALLOC_CAP_DEFAULT | MALLOC_CAP_8BIT)
74+
#define ESP_UTILS_CONF_MEM_GEN_ALLOC_ESP_ALIGN (1)
75+
#define ESP_UTILS_CONF_MEM_GEN_ALLOC_ESP_CAPS (MALLOC_CAP_DEFAULT | MALLOC_CAP_8BIT)
7576

76-
#elif ESP_UTILS_MEM_GENERAL_ALLOC_TYPE == ESP_UTILS_MEM_ALLOC_TYPE_CUSTOM
77+
#elif ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE == ESP_UTILS_MEM_ALLOC_TYPE_CUSTOM
7778

78-
#define ESP_UTILS_MEM_GENERAL_ALLOC_CUSTOM_INCLUDE stdlib.h
79-
#define ESP_UTILS_MEM_GENERAL_ALLOC_CUSTOM_MALLOC malloc
80-
#define ESP_UTILS_MEM_GENERAL_ALLOC_CUSTOM_FREE free
79+
#define ESP_UTILS_CONF_MEM_GEN_ALLOC_CUSTOM_INCLUDE "stdlib.h"
80+
#define ESP_UTILS_CONF_MEM_GEN_ALLOC_CUSTOM_MALLOC malloc
81+
#define ESP_UTILS_CONF_MEM_GEN_ALLOC_CUSTOM_FREE free
8182

82-
#endif
83+
#endif // ESP_UTILS_CONF_MEM_GEN_ALLOC_TYPE
8384

8485
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
8586
/////////////////////////////////////////////// File Version ///////////////////////////////////////////////////////////
8687
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
8788
/**
8889
* Do not change the following versions, they are used to check if the configurations in this file are compatible with
89-
* the current version of `esp_utils_config.h` in the library. The detailed rules are as follows:
90+
* the current version of `esp_utils_conf.h` in the library. The detailed rules are as follows:
9091
*
9192
* 1. If the major version is not consistent, then the configurations in this file are incompatible with the library
9293
* and must be replaced with the file from the library.
@@ -95,8 +96,8 @@
9596
* 3. Even if the patch version is not consistent, it will not affect normal functionality.
9697
*
9798
*/
98-
#define ESP_UTILS_CONFIG_FILE_VERSION_MAJOR 0
99-
#define ESP_UTILS_CONFIG_FILE_VERSION_MINOR 1
100-
#define ESP_UTILS_CONFIG_FILE_VERSION_PATCH 0
99+
#define ESP_UTILS_CONF_FILE_VERSION_MAJOR 0
100+
#define ESP_UTILS_CONF_FILE_VERSION_MINOR 1
101+
#define ESP_UTILS_CONF_FILE_VERSION_PATCH 0
101102

102103
// *INDENT-OFF*

‎src/check/esp_utils_check.h

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
* SPDX-License-Identifier: Apache-2.0
55
*/
66
#include "esp_err.h"
7-
#include "esp_utils_config_internal.h"
7+
#include "esp_utils_conf_internal.h"
88
#include "log/esp_utils_log.h"
99

10-
#if !ESP_UTILS_ENABLE_CHECK
10+
#if !ESP_UTILS_CONF_ENABLE_CHECK
1111

1212
#ifndef ESP_UTILS_CHECK_TAG
1313
#define ESP_UTILS_CHECK_TAG(goto_tag)
@@ -33,7 +33,7 @@
3333

3434
#else
3535

36-
#if ESP_UTILS_CHECK_WITH_ASSERT
36+
#if ESP_UTILS_CONF_CHECK_WITH_ASSERT
3737

3838
#ifndef ESP_UTILS_CHECK_TAG
3939
#define ESP_UTILS_CHECK_TAG(goto_tag)
@@ -87,7 +87,7 @@
8787
#define ESP_UTILS_CHECK_TAG(goto_tag) goto_tag:
8888
#endif
8989

90-
#if ESP_UTILS_CHECK_WITH_ERROR_LOG
90+
#if ESP_UTILS_CONF_CHECK_WITH_ERROR_LOG
9191

9292
/**
9393
* @brief Check if the pointer is NULL; if NULL, log an error and return the specified value.
@@ -202,8 +202,9 @@
202202
* @param ... Additional arguments for the format string
203203
*/
204204
#define ESP_UTILS_CHECK_ERROR_GOTO(x, goto_tag, fmt, ...) do { \
205-
if (unlikely((x) != ESP_OK)) { \
206-
ESP_UTILS_LOGE(fmt, ##__VA_ARGS__); \
205+
esp_err_t err = (x); \
206+
if (unlikely((err) != ESP_OK)) { \
207+
ESP_UTILS_LOGE(fmt " [%s]", ##__VA_ARGS__, esp_err_to_name(err)); \
207208
goto goto_tag; \
208209
} \
209210
} while(0)
@@ -216,8 +217,9 @@
216217
* @param ... Additional arguments for the format string
217218
*/
218219
#define ESP_UTILS_CHECK_ERROR_EXIT(x, fmt, ...) do { \
219-
if (unlikely((x) != ESP_OK)) { \
220-
ESP_UTILS_LOGE(fmt, ##__VA_ARGS__); \
220+
esp_err_t err = (x); \
221+
if (unlikely((err) != ESP_OK)) { \
222+
ESP_UTILS_LOGE(fmt " [%s]", ##__VA_ARGS__, esp_err_to_name(err)); \
221223
return; \
222224
} \
223225
} while(0)
@@ -262,7 +264,13 @@
262264
#else
263265

264266
#define ESP_UTILS_CHECK_EXCEPTION_RETURN(x, ret, fmt, ...) (x)
265-
#define ESP_UTILS_CHECK_EXCEPTION_GOTO(x, goto_tag, fmt, ...) (x)
267+
#define ESP_UTILS_CHECK_EXCEPTION_GOTO(x, goto_tag, fmt, ...) do {\
268+
x; \
269+
/* Aoivd unused tag warning */ \
270+
if (0) { \
271+
goto goto_tag; \
272+
} \
273+
} while (0)
266274
#define ESP_UTILS_CHECK_EXCEPTION_EXIT(x, fmt, ...) (x)
267275

268276
#endif // CONFIG_COMPILER_CXX_EXCEPTIONS
@@ -420,6 +428,6 @@
420428
} while (0)
421429
#endif // __cplusplus
422430

423-
#endif // ESP_UTILS_CHECK_WITH_ERROR_LOG
424-
#endif // ESP_UTILS_CHECK_WITH_ASSERT
425-
#endif // ESP_UTILS_ENABLE_CHECK
431+
#endif // ESP_UTILS_CONF_CHECK_WITH_ERROR_LOG
432+
#endif // ESP_UTILS_CONF_CHECK_WITH_ASSERT
433+
#endif // ESP_UTILS_CONF_ENABLE_CHECK

0 commit comments

Comments
 (0)