Skip to content

Commit d94b32e

Browse files
mairaspre-commit-ci-lite[bot]
mairas
and
pre-commit-ci-lite[bot]
authored
fix(esp-hal-log):Provide a default TAG name for USE_ESP_IDF_LOG logging macro (#9686)
* change(logging): Provide a default TAG name for USE_ESP_IDF_LOG The ESP-IDF logging library has some nice features such as log forwarding. esp32-hal-log.h has long supported the USE_ESP_IDF_LOG macro, but due to subsequent changes, it requires a global TAG preprocessor macro to be defined. The macro name is too generic and just having a sane default would be preferable. * ci(pre-commit): Apply automatic fixes --------- Co-authored-by: pre-commit-ci-lite[bot] <117423508+pre-commit-ci-lite[bot]@users.noreply.github.com>
1 parent 8091b7a commit d94b32e

File tree

1 file changed

+61
-60
lines changed

1 file changed

+61
-60
lines changed

‎cores/esp32/esp32-hal-log.h

+61-60
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,12 @@ extern "C" {
8080
#define ARDUHAL_LOG_COLOR_PRINT_END
8181
#endif
8282

83+
#ifdef USE_ESP_IDF_LOG
84+
#ifndef ARDUHAL_ESP_LOG_TAG
85+
#define ARDUHAL_ESP_LOG_TAG "ARDUINO"
86+
#endif
87+
#endif
88+
8389
const char *pathToFileName(const char *path);
8490
int log_printf(const char *fmt, ...);
8591
void log_print_buf(const uint8_t *b, size_t len);
@@ -102,17 +108,17 @@ void log_print_buf(const uint8_t *b, size_t len);
102108
ARDUHAL_LOG_COLOR_PRINT_END; \
103109
} while (0)
104110
#else
105-
#define log_v(format, ...) \
106-
do { \
107-
ESP_LOG_LEVEL_LOCAL(ESP_LOG_VERBOSE, TAG, format, ##__VA_ARGS__); \
111+
#define log_v(format, ...) \
112+
do { \
113+
ESP_LOG_LEVEL_LOCAL(ESP_LOG_VERBOSE, ARDUHAL_ESP_LOG_TAG, format, ##__VA_ARGS__); \
108114
} while (0)
109-
#define isr_log_v(format, ...) \
110-
do { \
111-
ets_printf(LOG_FORMAT(V, format), esp_log_timestamp(), TAG, ##__VA_ARGS__); \
115+
#define isr_log_v(format, ...) \
116+
do { \
117+
ets_printf(LOG_FORMAT(V, format), esp_log_timestamp(), ARDUHAL_ESP_LOG_TAG, ##__VA_ARGS__); \
112118
} while (0)
113-
#define log_buf_v(b, l) \
114-
do { \
115-
ESP_LOG_BUFFER_HEXDUMP(TAG, b, l, ESP_LOG_VERBOSE); \
119+
#define log_buf_v(b, l) \
120+
do { \
121+
ESP_LOG_BUFFER_HEXDUMP(ARDUHAL_ESP_LOG_TAG, b, l, ESP_LOG_VERBOSE); \
116122
} while (0)
117123
#endif
118124
#else
@@ -138,17 +144,17 @@ void log_print_buf(const uint8_t *b, size_t len);
138144
ARDUHAL_LOG_COLOR_PRINT_END; \
139145
} while (0)
140146
#else
141-
#define log_d(format, ...) \
142-
do { \
143-
ESP_LOG_LEVEL_LOCAL(ESP_LOG_DEBUG, TAG, format, ##__VA_ARGS__); \
147+
#define log_d(format, ...) \
148+
do { \
149+
ESP_LOG_LEVEL_LOCAL(ESP_LOG_DEBUG, ARDUHAL_ESP_LOG_TAG, format, ##__VA_ARGS__); \
144150
} while (0)
145-
#define isr_log_d(format, ...) \
146-
do { \
147-
ets_printf(LOG_FORMAT(D, format), esp_log_timestamp(), TAG, ##__VA_ARGS__); \
151+
#define isr_log_d(format, ...) \
152+
do { \
153+
ets_printf(LOG_FORMAT(D, format), esp_log_timestamp(), ARDUHAL_ESP_LOG_TAG, ##__VA_ARGS__); \
148154
} while (0)
149-
#define log_buf_d(b, l) \
150-
do { \
151-
ESP_LOG_BUFFER_HEXDUMP(TAG, b, l, ESP_LOG_DEBUG); \
155+
#define log_buf_d(b, l) \
156+
do { \
157+
ESP_LOG_BUFFER_HEXDUMP(ARDUHAL_ESP_LOG_TAG, b, l, ESP_LOG_DEBUG); \
152158
} while (0)
153159
#endif
154160
#else
@@ -174,17 +180,17 @@ void log_print_buf(const uint8_t *b, size_t len);
174180
ARDUHAL_LOG_COLOR_PRINT_END; \
175181
} while (0)
176182
#else
177-
#define log_i(format, ...) \
178-
do { \
179-
ESP_LOG_LEVEL_LOCAL(ESP_LOG_INFO, TAG, format, ##__VA_ARGS__); \
183+
#define log_i(format, ...) \
184+
do { \
185+
ESP_LOG_LEVEL_LOCAL(ESP_LOG_INFO, ARDUHAL_ESP_LOG_TAG, format, ##__VA_ARGS__); \
180186
} while (0)
181-
#define isr_log_i(format, ...) \
182-
do { \
183-
ets_printf(LOG_FORMAT(I, format), esp_log_timestamp(), TAG, ##__VA_ARGS__); \
187+
#define isr_log_i(format, ...) \
188+
do { \
189+
ets_printf(LOG_FORMAT(I, format), esp_log_timestamp(), ARDUHAL_ESP_LOG_TAG, ##__VA_ARGS__); \
184190
} while (0)
185-
#define log_buf_i(b, l) \
186-
do { \
187-
ESP_LOG_BUFFER_HEXDUMP(TAG, b, l, ESP_LOG_INFO); \
191+
#define log_buf_i(b, l) \
192+
do { \
193+
ESP_LOG_BUFFER_HEXDUMP(ARDUHAL_ESP_LOG_TAG, b, l, ESP_LOG_INFO); \
188194
} while (0)
189195
#endif
190196
#else
@@ -210,17 +216,17 @@ void log_print_buf(const uint8_t *b, size_t len);
210216
ARDUHAL_LOG_COLOR_PRINT_END; \
211217
} while (0)
212218
#else
213-
#define log_w(format, ...) \
214-
do { \
215-
ESP_LOG_LEVEL_LOCAL(ESP_LOG_WARN, TAG, format, ##__VA_ARGS__); \
219+
#define log_w(format, ...) \
220+
do { \
221+
ESP_LOG_LEVEL_LOCAL(ESP_LOG_WARN, ARDUHAL_ESP_LOG_TAG, format, ##__VA_ARGS__); \
216222
} while (0)
217-
#define isr_log_w(format, ...) \
218-
do { \
219-
ets_printf(LOG_FORMAT(W, format), esp_log_timestamp(), TAG, ##__VA_ARGS__); \
223+
#define isr_log_w(format, ...) \
224+
do { \
225+
ets_printf(LOG_FORMAT(W, format), esp_log_timestamp(), ARDUHAL_ESP_LOG_TAG, ##__VA_ARGS__); \
220226
} while (0)
221-
#define log_buf_w(b, l) \
222-
do { \
223-
ESP_LOG_BUFFER_HEXDUMP(TAG, b, l, ESP_LOG_WARN); \
227+
#define log_buf_w(b, l) \
228+
do { \
229+
ESP_LOG_BUFFER_HEXDUMP(ARDUHAL_ESP_LOG_TAG, b, l, ESP_LOG_WARN); \
224230
} while (0)
225231
#endif
226232
#else
@@ -246,17 +252,17 @@ void log_print_buf(const uint8_t *b, size_t len);
246252
ARDUHAL_LOG_COLOR_PRINT_END; \
247253
} while (0)
248254
#else
249-
#define log_e(format, ...) \
250-
do { \
251-
ESP_LOG_LEVEL_LOCAL(ESP_LOG_ERROR, TAG, format, ##__VA_ARGS__); \
255+
#define log_e(format, ...) \
256+
do { \
257+
ESP_LOG_LEVEL_LOCAL(ESP_LOG_ERROR, ARDUHAL_ESP_LOG_TAG, format, ##__VA_ARGS__); \
252258
} while (0)
253-
#define isr_log_e(format, ...) \
254-
do { \
255-
ets_printf(LOG_FORMAT(E, format), esp_log_timestamp(), TAG, ##__VA_ARGS__); \
259+
#define isr_log_e(format, ...) \
260+
do { \
261+
ets_printf(LOG_FORMAT(E, format), esp_log_timestamp(), ARDUHAL_ESP_LOG_TAG, ##__VA_ARGS__); \
256262
} while (0)
257-
#define log_buf_e(b, l) \
258-
do { \
259-
ESP_LOG_BUFFER_HEXDUMP(TAG, b, l, ESP_LOG_ERROR); \
263+
#define log_buf_e(b, l) \
264+
do { \
265+
ESP_LOG_BUFFER_HEXDUMP(ARDUHAL_ESP_LOG_TAG, b, l, ESP_LOG_ERROR); \
260266
} while (0)
261267
#endif
262268
#else
@@ -282,17 +288,17 @@ void log_print_buf(const uint8_t *b, size_t len);
282288
ARDUHAL_LOG_COLOR_PRINT_END; \
283289
} while (0)
284290
#else
285-
#define log_n(format, ...) \
286-
do { \
287-
ESP_LOG_LEVEL_LOCAL(ESP_LOG_ERROR, TAG, format, ##__VA_ARGS__); \
291+
#define log_n(format, ...) \
292+
do { \
293+
ESP_LOG_LEVEL_LOCAL(ESP_LOG_ERROR, ARDUHAL_ESP_LOG_TAG, format, ##__VA_ARGS__); \
288294
} while (0)
289-
#define isr_log_n(format, ...) \
290-
do { \
291-
ets_printf(LOG_FORMAT(E, format), esp_log_timestamp(), TAG, ##__VA_ARGS__); \
295+
#define isr_log_n(format, ...) \
296+
do { \
297+
ets_printf(LOG_FORMAT(E, format), esp_log_timestamp(), ARDUHAL_ESP_LOG_TAG, ##__VA_ARGS__); \
292298
} while (0)
293-
#define log_buf_n(b, l) \
294-
do { \
295-
ESP_LOG_BUFFER_HEXDUMP(TAG, b, l, ESP_LOG_ERROR); \
299+
#define log_buf_n(b, l) \
300+
do { \
301+
ESP_LOG_BUFFER_HEXDUMP(ARDUHAL_ESP_LOG_TAG, b, l, ESP_LOG_ERROR); \
296302
} while (0)
297303
#endif
298304
#else
@@ -309,12 +315,7 @@ void log_print_buf(const uint8_t *b, size_t len);
309315

310316
#include "esp_log.h"
311317

312-
#ifdef USE_ESP_IDF_LOG
313-
//#ifndef TAG
314-
//#define TAG "ARDUINO"
315-
//#endif
316-
//#define log_n(format, ...) myLog(ESP_LOG_NONE, format, ##__VA_ARGS__)
317-
#else
318+
#ifndef USE_ESP_IDF_LOG
318319
#ifdef CONFIG_ARDUHAL_ESP_LOG
319320
#undef ESP_LOGE
320321
#undef ESP_LOGW

0 commit comments

Comments
 (0)