Fork of the espurna firmware for `mhsw` switches
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

223 lines
6.9 KiB

7 years ago
7 years ago
7 years ago
7 years ago
  1. /*
  2. DEBUG MODULE
  3. Copyright (C) 2016-2018 by Xose Pérez <xose dot perez at gmail dot com>
  4. */
  5. #if DEBUG_SUPPORT
  6. #include <stdio.h>
  7. #include <stdarg.h>
  8. extern "C" {
  9. #include "user_interface.h"
  10. }
  11. #if DEBUG_UDP_SUPPORT
  12. #include <WiFiUdp.h>
  13. WiFiUDP _udp_debug;
  14. #endif
  15. void debugSend(const char * format, ...) {
  16. va_list args;
  17. va_start(args, format);
  18. char test[1];
  19. int len = ets_vsnprintf(test, 1, format, args) + 1;
  20. char * buffer = new char[len];
  21. ets_vsnprintf(buffer, len, format, args);
  22. va_end(args);
  23. #if DEBUG_SERIAL_SUPPORT
  24. DEBUG_PORT.printf(buffer);
  25. #endif
  26. #if DEBUG_UDP_SUPPORT
  27. #if SYSTEM_CHECK_ENABLED
  28. if (systemCheck()) {
  29. #endif
  30. _udp_debug.beginPacket(DEBUG_UDP_IP, DEBUG_UDP_PORT);
  31. _udp_debug.write(buffer);
  32. _udp_debug.endPacket();
  33. #if SYSTEM_CHECK_ENABLED
  34. }
  35. #endif
  36. #endif
  37. #if DEBUG_TELNET_SUPPORT
  38. _telnetWrite(buffer, strlen(buffer));
  39. #endif
  40. delete[] buffer;
  41. }
  42. void debugSend_P(PGM_P format_P, ...) {
  43. char format[strlen_P(format_P)+1];
  44. memcpy_P(format, format_P, sizeof(format));
  45. va_list args;
  46. va_start(args, format_P);
  47. char test[1];
  48. int len = ets_vsnprintf(test, 1, format, args) + 1;
  49. char * buffer = new char[len];
  50. ets_vsnprintf(buffer, len, format, args);
  51. va_end(args);
  52. #if DEBUG_SERIAL_SUPPORT
  53. DEBUG_PORT.printf(buffer);
  54. #endif
  55. #if DEBUG_UDP_SUPPORT
  56. #if SYSTEM_CHECK_ENABLED
  57. if (systemCheck()) {
  58. #endif
  59. _udp_debug.beginPacket(DEBUG_UDP_IP, DEBUG_UDP_PORT);
  60. _udp_debug.write(buffer);
  61. _udp_debug.endPacket();
  62. #if SYSTEM_CHECK_ENABLED
  63. }
  64. #endif
  65. #endif
  66. #if DEBUG_TELNET_SUPPORT
  67. _telnetWrite(buffer, strlen(buffer));
  68. #endif
  69. delete[] buffer;
  70. }
  71. // -----------------------------------------------------------------------------
  72. // Save crash info
  73. // Taken from krzychb EspSaveCrash
  74. // https://github.com/krzychb/EspSaveCrash
  75. // -----------------------------------------------------------------------------
  76. #define SAVE_CRASH_EEPROM_OFFSET 0x0100 // initial address for crash data
  77. /**
  78. * Structure of the single crash data set
  79. *
  80. * 1. Crash time
  81. * 2. Restart reason
  82. * 3. Exception cause
  83. * 4. epc1
  84. * 5. epc2
  85. * 6. epc3
  86. * 7. excvaddr
  87. * 8. depc
  88. * 9. adress of stack start
  89. * 10. adress of stack end
  90. * 11. stack trace bytes
  91. * ...
  92. */
  93. #define SAVE_CRASH_CRASH_TIME 0x00 // 4 bytes
  94. #define SAVE_CRASH_RESTART_REASON 0x04 // 1 byte
  95. #define SAVE_CRASH_EXCEPTION_CAUSE 0x05 // 1 byte
  96. #define SAVE_CRASH_EPC1 0x06 // 4 bytes
  97. #define SAVE_CRASH_EPC2 0x0A // 4 bytes
  98. #define SAVE_CRASH_EPC3 0x0E // 4 bytes
  99. #define SAVE_CRASH_EXCVADDR 0x12 // 4 bytes
  100. #define SAVE_CRASH_DEPC 0x16 // 4 bytes
  101. #define SAVE_CRASH_STACK_START 0x1A // 4 bytes
  102. #define SAVE_CRASH_STACK_END 0x1E // 4 bytes
  103. #define SAVE_CRASH_STACK_TRACE 0x22 // variable
  104. /**
  105. * Save crash information in EEPROM
  106. * This function is called automatically if ESP8266 suffers an exception
  107. * It should be kept quick / consise to be able to execute before hardware wdt may kick in
  108. */
  109. extern "C" void custom_crash_callback(struct rst_info * rst_info, uint32_t stack_start, uint32_t stack_end ) {
  110. // This method assumes EEPROM has already been initialized
  111. // which is the first thing ESPurna does
  112. // write crash time to EEPROM
  113. uint32_t crash_time = millis();
  114. EEPROM.put(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_CRASH_TIME, crash_time);
  115. // write reset info to EEPROM
  116. EEPROM.write(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_RESTART_REASON, rst_info->reason);
  117. EEPROM.write(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_EXCEPTION_CAUSE, rst_info->exccause);
  118. // write epc1, epc2, epc3, excvaddr and depc to EEPROM
  119. EEPROM.put(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_EPC1, rst_info->epc1);
  120. EEPROM.put(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_EPC2, rst_info->epc2);
  121. EEPROM.put(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_EPC3, rst_info->epc3);
  122. EEPROM.put(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_EXCVADDR, rst_info->excvaddr);
  123. EEPROM.put(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_DEPC, rst_info->depc);
  124. // write stack start and end address to EEPROM
  125. EEPROM.put(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_STACK_START, stack_start);
  126. EEPROM.put(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_STACK_END, stack_end);
  127. // write stack trace to EEPROM
  128. int16_t current_address = SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_STACK_TRACE;
  129. for (uint32_t i = stack_start; i < stack_end; i++) {
  130. byte* byteValue = (byte*) i;
  131. EEPROM.write(current_address++, *byteValue);
  132. }
  133. EEPROM.commit();
  134. }
  135. /**
  136. * Clears crash info
  137. */
  138. void debugClearCrashInfo() {
  139. uint32_t crash_time = 0xFFFFFFFF;
  140. EEPROM.put(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_CRASH_TIME, crash_time);
  141. EEPROM.commit();
  142. }
  143. /**
  144. * Print out crash information that has been previusly saved in EEPROM
  145. */
  146. void debugDumpCrashInfo() {
  147. uint32_t crash_time;
  148. EEPROM.get(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_CRASH_TIME, crash_time);
  149. if ((crash_time == 0) || (crash_time == 0xFFFFFFFF)) {
  150. DEBUG_MSG_P(PSTR("[DEBUG] No crash info\n"));
  151. return;
  152. }
  153. DEBUG_MSG_P(PSTR("[DEBUG] Crash at %lu ms\n"), crash_time);
  154. DEBUG_MSG_P(PSTR("[DEBUG] Reason of restart: %u\n"), EEPROM.read(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_RESTART_REASON));
  155. DEBUG_MSG_P(PSTR("[DEBUG] Exception cause: %u\n"), EEPROM.read(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_EXCEPTION_CAUSE));
  156. uint32_t epc1, epc2, epc3, excvaddr, depc;
  157. EEPROM.get(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_EPC1, epc1);
  158. EEPROM.get(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_EPC2, epc2);
  159. EEPROM.get(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_EPC3, epc3);
  160. EEPROM.get(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_EXCVADDR, excvaddr);
  161. EEPROM.get(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_DEPC, depc);
  162. DEBUG_MSG_P(PSTR("[DEBUG] epc1=0x%08x epc2=0x%08x epc3=0x%08x\n"), epc1, epc2, epc3);
  163. DEBUG_MSG_P(PSTR("[DEBUG] excvaddr=0x%08x depc=0x%08x\n"), excvaddr, depc);
  164. uint32_t stack_start, stack_end;
  165. EEPROM.get(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_STACK_START, stack_start);
  166. EEPROM.get(SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_STACK_END, stack_end);
  167. DEBUG_MSG_P(PSTR("[DEBUG] >>>stack>>>\n[DEBUG] "));
  168. int16_t current_address = SAVE_CRASH_EEPROM_OFFSET + SAVE_CRASH_STACK_TRACE;
  169. int16_t stack_len = stack_end - stack_start;
  170. uint32_t stack_trace;
  171. for (int16_t i = 0; i < stack_len; i += 0x10) {
  172. DEBUG_MSG_P(PSTR("%08x: "), stack_start + i);
  173. for (byte j = 0; j < 4; j++) {
  174. EEPROM.get(current_address, stack_trace);
  175. DEBUG_MSG_P(PSTR("%08x "), stack_trace);
  176. current_address += 4;
  177. }
  178. DEBUG_MSG_P(PSTR("\n[DEBUG] "));
  179. }
  180. DEBUG_MSG_P(PSTR("<<<stack<<<\n"));
  181. }
  182. #endif // DEBUG_SUPPORT