Skip to content

Commit 322ba37

Browse files
lucasssvazP-R-O-C-H-Y
lucasssvaz
and
P-R-O-C-H-Y
authored
PeriMan: Improve log messages (espressif#8812)
* Improve log messages * Add name function --------- Co-authored-by: Jan Procházka <90197375+P-R-O-C-H-Y@users.noreply.github.com>
1 parent 6d9ebea commit 322ba37

File tree

3 files changed

+68
-59
lines changed

3 files changed

+68
-59
lines changed

‎cores/esp32/chip-debug-report.cpp‎

Lines changed: 1 addition & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -251,55 +251,7 @@ static void printPerimanInfo(void){
251251
continue;//unused pin
252252
}
253253
chip_report_printf(" %17u : ", i);
254-
switch(type){
255-
case ESP32_BUS_TYPE_GPIO: chip_report_printf("GPIO\n"); break;
256-
case ESP32_BUS_TYPE_UART_RX: chip_report_printf("UART_RX\n"); break;
257-
case ESP32_BUS_TYPE_UART_TX: chip_report_printf("UART_TX\n"); break;
258-
case ESP32_BUS_TYPE_UART_CTS: chip_report_printf("UART_CTS\n"); break;
259-
case ESP32_BUS_TYPE_UART_RTS: chip_report_printf("UART_RTS\n"); break;
260-
#if SOC_SDM_SUPPORTED
261-
case ESP32_BUS_TYPE_SIGMADELTA: chip_report_printf("SIGMADELTA\n"); break;
262-
#endif
263-
#if SOC_ADC_SUPPORTED
264-
case ESP32_BUS_TYPE_ADC_ONESHOT: chip_report_printf("ADC_ONESHOT\n"); break;
265-
case ESP32_BUS_TYPE_ADC_CONT: chip_report_printf("ADC_CONT\n"); break;
266-
#endif
267-
#if SOC_DAC_SUPPORTED
268-
case ESP32_BUS_TYPE_DAC_ONESHOT: chip_report_printf("DAC_ONESHOT\n"); break;
269-
case ESP32_BUS_TYPE_DAC_CONT: chip_report_printf("DAC_CONT\n"); break;
270-
case ESP32_BUS_TYPE_DAC_COSINE: chip_report_printf("DAC_COSINE\n"); break;
271-
#endif
272-
#if SOC_LEDC_SUPPORTED
273-
case ESP32_BUS_TYPE_LEDC: chip_report_printf("LEDC\n"); break;
274-
#endif
275-
#if SOC_RMT_SUPPORTED
276-
case ESP32_BUS_TYPE_RMT_TX: chip_report_printf("RMT_TX\n"); break;
277-
case ESP32_BUS_TYPE_RMT_RX: chip_report_printf("RMT_RX\n"); break;
278-
#endif
279-
#if SOC_I2S_SUPPORTED
280-
case ESP32_BUS_TYPE_I2S_STD: chip_report_printf("I2S_STD\n"); break;
281-
case ESP32_BUS_TYPE_I2S_TDM: chip_report_printf("I2S_TDM\n"); break;
282-
case ESP32_BUS_TYPE_I2S_PDM_TX: chip_report_printf("I2S_PDM_TX\n"); break;
283-
case ESP32_BUS_TYPE_I2S_PDM_RX: chip_report_printf("I2S_PDM_RX\n"); break;
284-
#endif
285-
#if SOC_I2C_SUPPORTED
286-
case ESP32_BUS_TYPE_I2C_MASTER: chip_report_printf("I2C_MASTER\n"); break;
287-
case ESP32_BUS_TYPE_I2C_SLAVE: chip_report_printf("I2C_SLAVE\n"); break;
288-
#endif
289-
#if SOC_GPSPI_SUPPORTED
290-
case ESP32_BUS_TYPE_SPI_MASTER: chip_report_printf("SPI_MASTER\n"); break;
291-
#endif
292-
#if SOC_SDMMC_HOST_SUPPORTED
293-
case ESP32_BUS_TYPE_SDMMC: chip_report_printf("SDMMC\n"); break;
294-
#endif
295-
#if SOC_TOUCH_SENSOR_SUPPORTED
296-
case ESP32_BUS_TYPE_TOUCH: chip_report_printf("TOUCH\n"); break;
297-
#endif
298-
#if SOC_USB_SERIAL_JTAG_SUPPORTED || SOC_USB_OTG_SUPPORTED
299-
case ESP32_BUS_TYPE_USB: chip_report_printf("USB\n"); break;
300-
#endif
301-
default: chip_report_printf("%d\n", type); break;
302-
}
254+
chip_report_printf("%s\n", perimanGetTypeName(type));
303255
}
304256
}
305257

‎cores/esp32/esp32-hal-periman.c‎

Lines changed: 65 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,59 @@ static peripheral_pin_item_t pins[SOC_GPIO_PIN_COUNT];
1818

1919
#define GPIO_NOT_VALID(p) ((p >= SOC_GPIO_PIN_COUNT) || ((SOC_GPIO_VALID_GPIO_MASK & (1ULL << p)) == 0))
2020

21+
const char* perimanGetTypeName(peripheral_bus_type_t type) {
22+
switch(type) {
23+
case ESP32_BUS_TYPE_INIT: return "INIT";
24+
case ESP32_BUS_TYPE_GPIO: return "GPIO";
25+
case ESP32_BUS_TYPE_UART_RX: return "UART_RX";
26+
case ESP32_BUS_TYPE_UART_TX: return "UART_TX";
27+
case ESP32_BUS_TYPE_UART_CTS: return "UART_CTS";
28+
case ESP32_BUS_TYPE_UART_RTS: return "UART_RTS";
29+
#if SOC_SDM_SUPPORTED
30+
case ESP32_BUS_TYPE_SIGMADELTA: return "SIGMADELTA";
31+
#endif
32+
#if SOC_ADC_SUPPORTED
33+
case ESP32_BUS_TYPE_ADC_ONESHOT: return "ADC_ONESHOT";
34+
case ESP32_BUS_TYPE_ADC_CONT: return "ADC_CONT";
35+
#endif
36+
#if SOC_DAC_SUPPORTED
37+
case ESP32_BUS_TYPE_DAC_ONESHOT: return "DAC_ONESHOT";
38+
case ESP32_BUS_TYPE_DAC_CONT: return "DAC_CONT";
39+
case ESP32_BUS_TYPE_DAC_COSINE: return "DAC_COSINE";
40+
#endif
41+
#if SOC_LEDC_SUPPORTED
42+
case ESP32_BUS_TYPE_LEDC: return "LEDC";
43+
#endif
44+
#if SOC_RMT_SUPPORTED
45+
case ESP32_BUS_TYPE_RMT_TX: return "RMT_TX";
46+
case ESP32_BUS_TYPE_RMT_RX: return "RMT_RX";
47+
#endif
48+
#if SOC_I2S_SUPPORTED
49+
case ESP32_BUS_TYPE_I2S_STD: return "I2S_STD";
50+
case ESP32_BUS_TYPE_I2S_TDM: return "I2S_TDM";
51+
case ESP32_BUS_TYPE_I2S_PDM_TX: return "I2S_PDM_TX";
52+
case ESP32_BUS_TYPE_I2S_PDM_RX: return "I2S_PDM_RX";
53+
#endif
54+
#if SOC_I2C_SUPPORTED
55+
case ESP32_BUS_TYPE_I2C_MASTER: return "I2C_MASTER";
56+
case ESP32_BUS_TYPE_I2C_SLAVE: return "I2C_SLAVE";
57+
#endif
58+
#if SOC_GPSPI_SUPPORTED
59+
case ESP32_BUS_TYPE_SPI_MASTER: return "SPI_MASTER";
60+
#endif
61+
#if SOC_SDMMC_HOST_SUPPORTED
62+
case ESP32_BUS_TYPE_SDMMC: return "SDMMC";
63+
#endif
64+
#if SOC_TOUCH_SENSOR_SUPPORTED
65+
case ESP32_BUS_TYPE_TOUCH: return "TOUCH";
66+
#endif
67+
#if SOC_USB_SERIAL_JTAG_SUPPORTED || SOC_USB_OTG_SUPPORTED
68+
case ESP32_BUS_TYPE_USB: return "USB";
69+
#endif
70+
default: return "UNKNOWN";
71+
}
72+
}
73+
2174
bool perimanSetPinBus(uint8_t pin, peripheral_bus_type_t type, void * bus){
2275
peripheral_bus_type_t otype = ESP32_BUS_TYPE_INIT;
2376
void * obus = NULL;
@@ -26,37 +79,38 @@ bool perimanSetPinBus(uint8_t pin, peripheral_bus_type_t type, void * bus){
2679
return false;
2780
}
2881
if(type >= ESP32_BUS_TYPE_MAX){
29-
log_e("Invalid type: %u", (unsigned int)type);
82+
log_e("Invalid type: %s (%u) when setting pin %u", perimanGetTypeName(type), (unsigned int)type, pin);
3083
return false;
3184
}
3285
if(type > ESP32_BUS_TYPE_GPIO && bus == NULL){
33-
log_e("Bus is NULL");
86+
log_e("Bus is NULL for pin %u with type %s (%u)", pin, perimanGetTypeName(type), (unsigned int)type);
3487
return false;
3588
}
3689
if (type == ESP32_BUS_TYPE_INIT && bus != NULL){
37-
log_e("Can't set a Bus to INIT Type");
90+
log_e("Can't set a Bus to INIT Type (pin %u)", pin);
3891
return false;
39-
}
92+
}
4093
otype = pins[pin].type;
4194
obus = pins[pin].bus;
4295
if(type == otype && bus == obus){
4396
if (type != ESP32_BUS_TYPE_INIT) {
44-
log_i("Bus already set");
97+
log_i("Pin %u already has type %s (%u) with bus %p", pin, perimanGetTypeName(type), (unsigned int)type, bus);
4598
}
4699
return true;
47100
}
48101
if(obus != NULL){
49102
if(deinit_functions[otype] == NULL){
50-
log_e("Bus does not have deinit function set");
103+
log_e("No deinit function for type %s (%u) (pin %u)", perimanGetTypeName(otype), (unsigned int)otype, pin);
51104
return false;
52105
}
53106
if(!deinit_functions[otype](obus)){
54-
log_e("Previous bus failed to deinit");
107+
log_e("Deinit function for previous bus type %s (%u) failed (pin %u)", perimanGetTypeName(otype), (unsigned int)otype, pin);
55108
return false;
56109
}
57110
}
58111
pins[pin].type = type;
59112
pins[pin].bus = bus;
113+
log_v("Pin %u successfully set to type %s (%u) with bus %p", pin, perimanGetTypeName(type), (unsigned int)type, bus);
60114
return true;
61115
}
62116

@@ -66,7 +120,7 @@ void * perimanGetPinBus(uint8_t pin, peripheral_bus_type_t type){
66120
return NULL;
67121
}
68122
if(type >= ESP32_BUS_TYPE_MAX || type == ESP32_BUS_TYPE_INIT){
69-
log_e("Invalid type: %u", (unsigned int)type);
123+
log_e("Invalid type %s (%u) for pin %u", perimanGetTypeName(type), (unsigned int)type, pin);
70124
return NULL;
71125
}
72126
if(pins[pin].type == type){
@@ -85,14 +139,15 @@ peripheral_bus_type_t perimanGetPinBusType(uint8_t pin){
85139

86140
bool perimanSetBusDeinit(peripheral_bus_type_t type, peripheral_bus_deinit_cb_t cb){
87141
if(type >= ESP32_BUS_TYPE_MAX || type == ESP32_BUS_TYPE_INIT){
88-
log_e("Invalid type: %u", (unsigned int)type);
142+
log_e("Invalid type: %s (%u)", perimanGetTypeName(type), (unsigned int)type);
89143
return false;
90144
}
91145
if(cb == NULL){
92-
log_e("Callback is NULL");
146+
log_e("Callback is NULL when setting deinit function for type %s (%u)", perimanGetTypeName(type), (unsigned int)type);
93147
return false;
94148
}
95149
deinit_functions[type] = cb;
150+
log_v("Deinit function for type %s (%u) successfully set to %p", perimanGetTypeName(type), (unsigned int)type, cb);
96151
return true;
97152
}
98153

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,8 @@ typedef enum {
7070

7171
typedef bool (*peripheral_bus_deinit_cb_t)(void * bus);
7272

73+
const char* perimanGetTypeName(peripheral_bus_type_t type);
74+
7375
// Sets the bus type and bus handle for given pin.
7476
bool perimanSetPinBus(uint8_t pin, peripheral_bus_type_t type, void * bus);
7577

0 commit comments

Comments
 (0)