twai.c 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718
  1. // Copyright 2015-2018 Espressif Systems (Shanghai) PTE LTD
  2. //
  3. // Licensed under the Apache License, Version 2.0 (the "License");
  4. // you may not use this file except in compliance with the License.
  5. // You may obtain a copy of the License at
  6. // http://www.apache.org/licenses/LICENSE-2.0
  7. //
  8. // Unless required by applicable law or agreed to in writing, software
  9. // distributed under the License is distributed on an "AS IS" BASIS,
  10. // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11. // See the License for the specific language governing permissions and
  12. // limitations under the License.
  13. #include "sdkconfig.h"
  14. #include "freertos/FreeRTOS.h"
  15. #include "freertos/task.h"
  16. #include "freertos/queue.h"
  17. #include "freertos/semphr.h"
  18. #include "esp_types.h"
  19. #include "esp_log.h"
  20. #include "esp_intr_alloc.h"
  21. #include "esp_pm.h"
  22. #include "esp_attr.h"
  23. #include "esp_heap_caps.h"
  24. #include "driver/gpio.h"
  25. #include "driver/periph_ctrl.h"
  26. #include "driver/twai.h"
  27. #include "soc/soc_caps.h"
  28. #include "soc/twai_periph.h"
  29. #include "hal/twai_hal.h"
  30. #include "esp_rom_gpio.h"
  31. /* ---------------------------- Definitions --------------------------------- */
  32. //Internal Macros
  33. #define TWAI_CHECK(cond, ret_val) ({ \
  34. if (!(cond)) { \
  35. return (ret_val); \
  36. } \
  37. })
  38. #define TWAI_CHECK_FROM_CRIT(cond, ret_val) ({ \
  39. if (!(cond)) { \
  40. TWAI_EXIT_CRITICAL(); \
  41. return ret_val; \
  42. } \
  43. })
  44. #define TWAI_SET_FLAG(var, mask) ((var) |= (mask))
  45. #define TWAI_RESET_FLAG(var, mask) ((var) &= ~(mask))
  46. #ifdef CONFIG_TWAI_ISR_IN_IRAM
  47. #define TWAI_ISR_ATTR IRAM_ATTR
  48. #define TWAI_MALLOC_CAPS (MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT)
  49. #else
  50. #define TWAI_TAG "TWAI"
  51. #define TWAI_ISR_ATTR
  52. #define TWAI_MALLOC_CAPS MALLOC_CAP_DEFAULT
  53. #endif //CONFIG_TWAI_ISR_IN_IRAM
  54. #define DRIVER_DEFAULT_INTERRUPTS 0xE7 //Exclude data overrun (bit[3]) and brp_div (bit[4])
  55. #define ALERT_LOG_LEVEL_WARNING TWAI_ALERT_ARB_LOST //Alerts above and including this level use ESP_LOGW
  56. #define ALERT_LOG_LEVEL_ERROR TWAI_ALERT_TX_FAILED //Alerts above and including this level use ESP_LOGE
  57. /* ------------------ Typedefs, structures, and variables ------------------- */
  58. //Control structure for TWAI driver
  59. typedef struct {
  60. //Control and status members
  61. twai_state_t state;
  62. twai_mode_t mode;
  63. uint32_t rx_missed_count;
  64. uint32_t rx_overrun_count;
  65. uint32_t tx_failed_count;
  66. uint32_t arb_lost_count;
  67. uint32_t bus_error_count;
  68. intr_handle_t isr_handle;
  69. //TX and RX
  70. #ifdef CONFIG_TWAI_ISR_IN_IRAM
  71. void *tx_queue_buff;
  72. void *tx_queue_struct;
  73. void *rx_queue_buff;
  74. void *rx_queue_struct;
  75. void *semphr_struct;
  76. #endif
  77. QueueHandle_t tx_queue;
  78. QueueHandle_t rx_queue;
  79. int tx_msg_count;
  80. int rx_msg_count;
  81. //Alerts
  82. SemaphoreHandle_t alert_semphr;
  83. uint32_t alerts_enabled;
  84. uint32_t alerts_triggered;
  85. #ifdef CONFIG_PM_ENABLE
  86. //Power Management
  87. esp_pm_lock_handle_t pm_lock;
  88. #endif
  89. } twai_obj_t;
  90. static twai_obj_t *p_twai_obj = NULL;
  91. static portMUX_TYPE twai_spinlock = portMUX_INITIALIZER_UNLOCKED;
  92. #define TWAI_ENTER_CRITICAL_ISR() portENTER_CRITICAL_ISR(&twai_spinlock)
  93. #define TWAI_EXIT_CRITICAL_ISR() portEXIT_CRITICAL_ISR(&twai_spinlock)
  94. #define TWAI_ENTER_CRITICAL() portENTER_CRITICAL(&twai_spinlock)
  95. #define TWAI_EXIT_CRITICAL() portEXIT_CRITICAL(&twai_spinlock)
  96. static twai_hal_context_t twai_context;
  97. /* -------------------- Interrupt and Alert Handlers ------------------------ */
  98. TWAI_ISR_ATTR static void twai_alert_handler(uint32_t alert_code, int *alert_req)
  99. {
  100. if (p_twai_obj->alerts_enabled & alert_code) {
  101. //Signify alert has occurred
  102. TWAI_SET_FLAG(p_twai_obj->alerts_triggered, alert_code);
  103. *alert_req = 1;
  104. #ifndef CONFIG_TWAI_ISR_IN_IRAM //Only log if ISR is not in IRAM
  105. if (p_twai_obj->alerts_enabled & TWAI_ALERT_AND_LOG) {
  106. if (alert_code >= ALERT_LOG_LEVEL_ERROR) {
  107. ESP_EARLY_LOGE(TWAI_TAG, "Alert %d", alert_code);
  108. } else if (alert_code >= ALERT_LOG_LEVEL_WARNING) {
  109. ESP_EARLY_LOGW(TWAI_TAG, "Alert %d", alert_code);
  110. } else {
  111. ESP_EARLY_LOGI(TWAI_TAG, "Alert %d", alert_code);
  112. }
  113. }
  114. #endif //CONFIG_TWAI_ISR_IN_IRAM
  115. }
  116. }
  117. static inline void twai_handle_rx_buffer_frames(BaseType_t *task_woken, int *alert_req)
  118. {
  119. #ifdef SOC_TWAI_SUPPORTS_RX_STATUS
  120. uint32_t msg_count = twai_hal_get_rx_msg_count(&twai_context);
  121. for (uint32_t i = 0; i < msg_count; i++) {
  122. twai_hal_frame_t frame;
  123. if (twai_hal_read_rx_buffer_and_clear(&twai_context, &frame)) {
  124. //Valid frame copied from RX buffer
  125. if (xQueueSendFromISR(p_twai_obj->rx_queue, &frame, task_woken) == pdTRUE) {
  126. p_twai_obj->rx_msg_count++;
  127. } else { //Failed to send to queue
  128. p_twai_obj->rx_missed_count++;
  129. twai_alert_handler(TWAI_ALERT_RX_QUEUE_FULL, alert_req);
  130. }
  131. } else { //Failed to read from RX buffer because message is overrun
  132. p_twai_obj->rx_overrun_count++;
  133. twai_alert_handler(TWAI_ALERT_RX_FIFO_OVERRUN, alert_req);
  134. }
  135. }
  136. #else //SOC_TWAI_SUPPORTS_RX_STATUS
  137. uint32_t msg_count = twai_hal_get_rx_msg_count(&twai_context);
  138. bool overrun = false;
  139. //Clear all valid RX frames
  140. for (int i = 0; i < msg_count; i++) {
  141. twai_hal_frame_t frame;
  142. if (twai_hal_read_rx_buffer_and_clear(&twai_context, &frame)) {
  143. //Valid frame copied from RX buffer
  144. if (xQueueSendFromISR(p_twai_obj->rx_queue, &frame, task_woken) == pdTRUE) {
  145. p_twai_obj->rx_msg_count++;
  146. } else {
  147. p_twai_obj->rx_missed_count++;
  148. twai_alert_handler(TWAI_ALERT_RX_QUEUE_FULL, alert_req);
  149. }
  150. } else {
  151. overrun = true;
  152. break;
  153. }
  154. }
  155. //All remaining frames are treated as overrun. Clear them all
  156. if (overrun) {
  157. p_twai_obj->rx_overrun_count += twai_hal_clear_rx_fifo_overrun(&twai_context);
  158. twai_alert_handler(TWAI_ALERT_RX_FIFO_OVERRUN, alert_req);
  159. }
  160. #endif //SOC_TWAI_SUPPORTS_RX_STATUS
  161. }
  162. static inline void twai_handle_tx_buffer_frame(BaseType_t *task_woken, int *alert_req)
  163. {
  164. //Handle previously transmitted frame
  165. if (twai_hal_check_last_tx_successful(&twai_context)) {
  166. twai_alert_handler(TWAI_ALERT_TX_SUCCESS, alert_req);
  167. } else {
  168. p_twai_obj->tx_failed_count++;
  169. twai_alert_handler(TWAI_ALERT_TX_FAILED, alert_req);
  170. }
  171. //Update TX message count
  172. p_twai_obj->tx_msg_count--;
  173. assert(p_twai_obj->tx_msg_count >= 0); //Sanity check
  174. //Check if there are more frames to transmit
  175. if (p_twai_obj->tx_msg_count > 0 && p_twai_obj->tx_queue != NULL) {
  176. twai_hal_frame_t frame;
  177. int res = xQueueReceiveFromISR(p_twai_obj->tx_queue, &frame, task_woken);
  178. if (res == pdTRUE) {
  179. twai_hal_set_tx_buffer_and_transmit(&twai_context, &frame);
  180. } else {
  181. assert(false && "failed to get a frame from TX queue");
  182. }
  183. } else {
  184. //No more frames to transmit
  185. twai_alert_handler(TWAI_ALERT_TX_IDLE, alert_req);
  186. }
  187. }
  188. TWAI_ISR_ATTR static void twai_intr_handler_main(void *arg)
  189. {
  190. BaseType_t task_woken = pdFALSE;
  191. int alert_req = 0;
  192. uint32_t events;
  193. TWAI_ENTER_CRITICAL_ISR();
  194. if (p_twai_obj == NULL) { //In case intr occurs whilst driver is being uninstalled
  195. TWAI_EXIT_CRITICAL_ISR();
  196. return;
  197. }
  198. events = twai_hal_get_events(&twai_context); //Get the events that triggered the interrupt
  199. #if defined(CONFIG_TWAI_ERRATA_FIX_RX_FRAME_INVALID) || defined(CONFIG_TWAI_ERRATA_FIX_RX_FIFO_CORRUPT)
  200. if (events & TWAI_HAL_EVENT_NEED_PERIPH_RESET) {
  201. twai_hal_prepare_for_reset(&twai_context);
  202. periph_module_reset(PERIPH_TWAI_MODULE);
  203. twai_hal_recover_from_reset(&twai_context);
  204. p_twai_obj->rx_missed_count += twai_hal_get_reset_lost_rx_cnt(&twai_context);
  205. twai_alert_handler(TWAI_ALERT_PERIPH_RESET, &alert_req);
  206. }
  207. #endif
  208. if (events & TWAI_HAL_EVENT_RX_BUFF_FRAME) {
  209. //Note: This event will never occur if there is a periph reset event
  210. twai_handle_rx_buffer_frames(&task_woken, &alert_req);
  211. }
  212. if (events & TWAI_HAL_EVENT_TX_BUFF_FREE) {
  213. twai_handle_tx_buffer_frame(&task_woken, &alert_req);
  214. }
  215. //Handle events that only require alerting (i.e. no handler)
  216. if (events & TWAI_HAL_EVENT_BUS_OFF) {
  217. p_twai_obj->state = TWAI_STATE_BUS_OFF;
  218. twai_alert_handler(TWAI_ALERT_BUS_OFF, &alert_req);
  219. }
  220. if (events & TWAI_HAL_EVENT_BUS_RECOV_CPLT) {
  221. p_twai_obj->state = TWAI_STATE_STOPPED;
  222. twai_alert_handler(TWAI_ALERT_BUS_RECOVERED, &alert_req);
  223. }
  224. if (events & TWAI_HAL_EVENT_BUS_ERR) {
  225. p_twai_obj->bus_error_count++;
  226. twai_alert_handler(TWAI_ALERT_BUS_ERROR, &alert_req);
  227. }
  228. if (events & TWAI_HAL_EVENT_ARB_LOST) {
  229. p_twai_obj->arb_lost_count++;
  230. twai_alert_handler(TWAI_ALERT_ARB_LOST, &alert_req);
  231. }
  232. if (events & TWAI_HAL_EVENT_BUS_RECOV_PROGRESS) {
  233. //Bus-recovery in progress. TEC has dropped below error warning limit
  234. twai_alert_handler(TWAI_ALERT_RECOVERY_IN_PROGRESS, &alert_req);
  235. }
  236. if (events & TWAI_HAL_EVENT_ERROR_PASSIVE) {
  237. //Entered error passive
  238. twai_alert_handler(TWAI_ALERT_ERR_PASS, &alert_req);
  239. }
  240. if (events & TWAI_HAL_EVENT_ERROR_ACTIVE) {
  241. //Returned to error active
  242. twai_alert_handler(TWAI_ALERT_ERR_ACTIVE, &alert_req);
  243. }
  244. if (events & TWAI_HAL_EVENT_ABOVE_EWL) {
  245. //TEC or REC surpassed error warning limit
  246. twai_alert_handler(TWAI_ALERT_ABOVE_ERR_WARN, &alert_req);
  247. }
  248. if (events & TWAI_HAL_EVENT_BELOW_EWL) {
  249. //TEC and REC are both below error warning
  250. twai_alert_handler(TWAI_ALERT_BELOW_ERR_WARN, &alert_req);
  251. }
  252. TWAI_EXIT_CRITICAL_ISR();
  253. if (p_twai_obj->alert_semphr != NULL && alert_req) {
  254. //Give semaphore if alerts were triggered
  255. xSemaphoreGiveFromISR(p_twai_obj->alert_semphr, &task_woken);
  256. }
  257. if (task_woken == pdTRUE) {
  258. portYIELD_FROM_ISR();
  259. }
  260. }
  261. /* -------------------------- Helper functions ----------------------------- */
  262. static void twai_configure_gpio(gpio_num_t tx, gpio_num_t rx, gpio_num_t clkout, gpio_num_t bus_status)
  263. {
  264. //Set TX pin
  265. gpio_set_pull_mode(tx, GPIO_FLOATING);
  266. esp_rom_gpio_connect_out_signal(tx, TWAI_TX_IDX, false, false);
  267. esp_rom_gpio_pad_select_gpio(tx);
  268. //Set RX pin
  269. gpio_set_pull_mode(rx, GPIO_FLOATING);
  270. esp_rom_gpio_connect_in_signal(rx, TWAI_RX_IDX, false);
  271. esp_rom_gpio_pad_select_gpio(rx);
  272. gpio_set_direction(rx, GPIO_MODE_INPUT);
  273. //Configure output clock pin (Optional)
  274. if (clkout >= 0 && clkout < GPIO_NUM_MAX) {
  275. gpio_set_pull_mode(clkout, GPIO_FLOATING);
  276. esp_rom_gpio_connect_out_signal(clkout, TWAI_CLKOUT_IDX, false, false);
  277. esp_rom_gpio_pad_select_gpio(clkout);
  278. }
  279. //Configure bus status pin (Optional)
  280. if (bus_status >= 0 && bus_status < GPIO_NUM_MAX) {
  281. gpio_set_pull_mode(bus_status, GPIO_FLOATING);
  282. esp_rom_gpio_connect_out_signal(bus_status, TWAI_BUS_OFF_ON_IDX, false, false);
  283. esp_rom_gpio_pad_select_gpio(bus_status);
  284. }
  285. }
  286. static void twai_free_driver_obj(twai_obj_t *p_obj)
  287. {
  288. //Free driver object and any dependent SW resources it uses (queues, semaphores etc)
  289. #ifdef CONFIG_PM_ENABLE
  290. if (p_obj->pm_lock != NULL) {
  291. ESP_ERROR_CHECK(esp_pm_lock_delete(p_obj->pm_lock));
  292. }
  293. #endif
  294. //Delete queues and semaphores
  295. if (p_obj->tx_queue != NULL) {
  296. vQueueDelete(p_obj->tx_queue);
  297. }
  298. if (p_obj->rx_queue != NULL) {
  299. vQueueDelete(p_obj->rx_queue);
  300. }
  301. if (p_obj->alert_semphr != NULL) {
  302. vSemaphoreDelete(p_obj->alert_semphr);
  303. }
  304. #ifdef CONFIG_TWAI_ISR_IN_IRAM
  305. //Free memory used by static queues and semaphores. free() allows freeing NULL pointers
  306. free(p_obj->tx_queue_buff);
  307. free(p_obj->tx_queue_struct);
  308. free(p_obj->rx_queue_buff);
  309. free(p_obj->rx_queue_struct);
  310. free(p_obj->semphr_struct);
  311. #endif //CONFIG_TWAI_ISR_IN_IRAM
  312. free(p_obj);
  313. }
  314. static twai_obj_t *twai_alloc_driver_obj(uint32_t tx_queue_len, uint32_t rx_queue_len)
  315. {
  316. //Allocates driver object and any dependent SW resources it uses (queues, semaphores etc)
  317. //Create a TWAI driver object
  318. twai_obj_t *p_obj = heap_caps_calloc(1, sizeof(twai_obj_t), TWAI_MALLOC_CAPS);
  319. if (p_obj == NULL) {
  320. return NULL;
  321. }
  322. #ifdef CONFIG_TWAI_ISR_IN_IRAM
  323. //Allocate memory for queues and semaphores in DRAM
  324. if (tx_queue_len > 0) {
  325. p_obj->tx_queue_buff = heap_caps_calloc(tx_queue_len, sizeof(twai_hal_frame_t), TWAI_MALLOC_CAPS);
  326. p_obj->tx_queue_struct = heap_caps_calloc(1, sizeof(StaticQueue_t), TWAI_MALLOC_CAPS);
  327. if (p_obj->tx_queue_buff == NULL || p_obj->tx_queue_struct == NULL) {
  328. goto cleanup;
  329. }
  330. }
  331. p_obj->rx_queue_buff = heap_caps_calloc(rx_queue_len, sizeof(twai_hal_frame_t), TWAI_MALLOC_CAPS);
  332. p_obj->rx_queue_struct = heap_caps_calloc(1, sizeof(StaticQueue_t), TWAI_MALLOC_CAPS);
  333. p_obj->semphr_struct = heap_caps_calloc(1, sizeof(StaticSemaphore_t), TWAI_MALLOC_CAPS);
  334. if (p_obj->rx_queue_buff == NULL || p_obj->rx_queue_struct == NULL || p_obj->semphr_struct == NULL) {
  335. goto cleanup;
  336. }
  337. //Create static queues and semaphores
  338. if (tx_queue_len > 0) {
  339. p_obj->tx_queue = xQueueCreateStatic(tx_queue_len, sizeof(twai_hal_frame_t), p_obj->tx_queue_buff, p_obj->tx_queue_struct);
  340. if (p_obj->tx_queue == NULL) {
  341. goto cleanup;
  342. }
  343. }
  344. p_obj->rx_queue = xQueueCreateStatic(rx_queue_len, sizeof(twai_hal_frame_t), p_obj->rx_queue_buff, p_obj->rx_queue_struct);
  345. p_obj->alert_semphr = xSemaphoreCreateBinaryStatic(p_obj->semphr_struct);
  346. if (p_obj->rx_queue == NULL || p_obj->alert_semphr == NULL) {
  347. goto cleanup;
  348. }
  349. #else //CONFIG_TWAI_ISR_IN_IRAM
  350. if (tx_queue_len > 0) {
  351. p_obj->tx_queue = xQueueCreate(tx_queue_len, sizeof(twai_hal_frame_t));
  352. }
  353. p_obj->rx_queue = xQueueCreate(rx_queue_len, sizeof(twai_hal_frame_t));
  354. p_obj->alert_semphr = xSemaphoreCreateBinary();
  355. if ((tx_queue_len > 0 && p_obj->tx_queue == NULL) || p_obj->rx_queue == NULL || p_obj->alert_semphr == NULL) {
  356. goto cleanup;
  357. }
  358. #endif //CONFIG_TWAI_ISR_IN_IRAM
  359. #ifdef CONFIG_PM_ENABLE
  360. esp_err_t pm_err = esp_pm_lock_create(ESP_PM_APB_FREQ_MAX, 0, "twai", &(p_obj->pm_lock));
  361. if (pm_err != ESP_OK ) {
  362. goto cleanup;
  363. }
  364. #endif
  365. return p_obj;
  366. cleanup:
  367. twai_free_driver_obj(p_obj);
  368. return NULL;
  369. }
  370. /* ---------------------------- Public Functions ---------------------------- */
  371. esp_err_t twai_driver_install(const twai_general_config_t *g_config, const twai_timing_config_t *t_config, const twai_filter_config_t *f_config)
  372. {
  373. //Check arguments
  374. TWAI_CHECK(g_config != NULL, ESP_ERR_INVALID_ARG);
  375. TWAI_CHECK(t_config != NULL, ESP_ERR_INVALID_ARG);
  376. TWAI_CHECK(f_config != NULL, ESP_ERR_INVALID_ARG);
  377. TWAI_CHECK(g_config->rx_queue_len > 0, ESP_ERR_INVALID_ARG);
  378. TWAI_CHECK(g_config->tx_io >= 0 && g_config->tx_io < GPIO_NUM_MAX, ESP_ERR_INVALID_ARG);
  379. TWAI_CHECK(g_config->rx_io >= 0 && g_config->rx_io < GPIO_NUM_MAX, ESP_ERR_INVALID_ARG);
  380. TWAI_CHECK(t_config->brp >= SOC_TWAI_BRP_MIN && t_config->brp <= SOC_TWAI_BRP_MAX, ESP_ERR_INVALID_ARG);
  381. #ifndef CONFIG_TWAI_ISR_IN_IRAM
  382. TWAI_CHECK(!(g_config->intr_flags & ESP_INTR_FLAG_IRAM), ESP_ERR_INVALID_ARG);
  383. #endif
  384. TWAI_ENTER_CRITICAL();
  385. TWAI_CHECK_FROM_CRIT(p_twai_obj == NULL, ESP_ERR_INVALID_STATE);
  386. TWAI_EXIT_CRITICAL();
  387. esp_err_t ret;
  388. twai_obj_t *p_twai_obj_dummy;
  389. //Create a TWAI object (including queues and semaphores)
  390. p_twai_obj_dummy = twai_alloc_driver_obj(g_config->tx_queue_len, g_config->rx_queue_len);
  391. TWAI_CHECK(p_twai_obj_dummy != NULL, ESP_ERR_NO_MEM);
  392. //Initialize flags and variables. All other members are already set to zero by twai_alloc_driver_obj()
  393. p_twai_obj_dummy->state = TWAI_STATE_STOPPED;
  394. p_twai_obj_dummy->mode = g_config->mode;
  395. p_twai_obj_dummy->alerts_enabled = g_config->alerts_enabled;
  396. //Initialize TWAI peripheral registers, and allocate interrupt
  397. TWAI_ENTER_CRITICAL();
  398. if (p_twai_obj == NULL) {
  399. p_twai_obj = p_twai_obj_dummy;
  400. } else {
  401. //Check if driver is already installed
  402. TWAI_EXIT_CRITICAL();
  403. ret = ESP_ERR_INVALID_STATE;
  404. goto err;
  405. }
  406. periph_module_reset(PERIPH_TWAI_MODULE);
  407. periph_module_enable(PERIPH_TWAI_MODULE); //Enable APB CLK to TWAI peripheral
  408. bool init = twai_hal_init(&twai_context);
  409. assert(init);
  410. twai_hal_configure(&twai_context, t_config, f_config, DRIVER_DEFAULT_INTERRUPTS, g_config->clkout_divider);
  411. TWAI_EXIT_CRITICAL();
  412. //Allocate GPIO and Interrupts
  413. twai_configure_gpio(g_config->tx_io, g_config->rx_io, g_config->clkout_io, g_config->bus_off_io);
  414. ESP_ERROR_CHECK(esp_intr_alloc(ETS_TWAI_INTR_SOURCE, g_config->intr_flags, twai_intr_handler_main, NULL, &p_twai_obj->isr_handle));
  415. #ifdef CONFIG_PM_ENABLE
  416. ESP_ERROR_CHECK(esp_pm_lock_acquire(p_twai_obj->pm_lock)); //Acquire pm_lock to keep APB clock at 80MHz
  417. #endif
  418. return ESP_OK; //TWAI module is still in reset mode, users need to call twai_start() afterwards
  419. err:
  420. twai_free_driver_obj(p_twai_obj_dummy);
  421. return ret;
  422. }
  423. esp_err_t twai_driver_uninstall(void)
  424. {
  425. twai_obj_t *p_twai_obj_dummy;
  426. TWAI_ENTER_CRITICAL();
  427. //Check state
  428. TWAI_CHECK_FROM_CRIT(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
  429. TWAI_CHECK_FROM_CRIT(p_twai_obj->state == TWAI_STATE_STOPPED || p_twai_obj->state == TWAI_STATE_BUS_OFF, ESP_ERR_INVALID_STATE);
  430. //Clear registers by reading
  431. twai_hal_deinit(&twai_context);
  432. periph_module_disable(PERIPH_TWAI_MODULE); //Disable TWAI peripheral
  433. p_twai_obj_dummy = p_twai_obj; //Use dummy to shorten critical section
  434. p_twai_obj = NULL;
  435. TWAI_EXIT_CRITICAL();
  436. ESP_ERROR_CHECK(esp_intr_free(p_twai_obj_dummy->isr_handle)); //Free interrupt
  437. #ifdef CONFIG_PM_ENABLE
  438. //Release and delete power management lock
  439. ESP_ERROR_CHECK(esp_pm_lock_release(p_twai_obj_dummy->pm_lock));
  440. #endif
  441. //Free can driver object
  442. twai_free_driver_obj(p_twai_obj_dummy);
  443. return ESP_OK;
  444. }
  445. esp_err_t twai_start(void)
  446. {
  447. //Check state
  448. TWAI_ENTER_CRITICAL();
  449. TWAI_CHECK_FROM_CRIT(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
  450. TWAI_CHECK_FROM_CRIT(p_twai_obj->state == TWAI_STATE_STOPPED, ESP_ERR_INVALID_STATE);
  451. //Reset RX queue, RX message count, amd TX queue
  452. xQueueReset(p_twai_obj->rx_queue);
  453. if (p_twai_obj->tx_queue != NULL) {
  454. xQueueReset(p_twai_obj->tx_queue);
  455. }
  456. p_twai_obj->rx_msg_count = 0;
  457. p_twai_obj->tx_msg_count = 0;
  458. twai_hal_start(&twai_context, p_twai_obj->mode);
  459. p_twai_obj->state = TWAI_STATE_RUNNING;
  460. TWAI_EXIT_CRITICAL();
  461. return ESP_OK;
  462. }
  463. esp_err_t twai_stop(void)
  464. {
  465. //Check state
  466. TWAI_ENTER_CRITICAL();
  467. TWAI_CHECK_FROM_CRIT(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
  468. TWAI_CHECK_FROM_CRIT(p_twai_obj->state == TWAI_STATE_RUNNING, ESP_ERR_INVALID_STATE);
  469. twai_hal_stop(&twai_context);
  470. //Reset TX Queue and message count
  471. if (p_twai_obj->tx_queue != NULL) {
  472. xQueueReset(p_twai_obj->tx_queue);
  473. }
  474. p_twai_obj->tx_msg_count = 0;
  475. p_twai_obj->state = TWAI_STATE_STOPPED;
  476. TWAI_EXIT_CRITICAL();
  477. return ESP_OK;
  478. }
  479. esp_err_t twai_transmit(const twai_message_t *message, TickType_t ticks_to_wait)
  480. {
  481. //Check arguments
  482. TWAI_CHECK(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
  483. TWAI_CHECK(message != NULL, ESP_ERR_INVALID_ARG);
  484. TWAI_CHECK((message->data_length_code <= TWAI_FRAME_MAX_DLC) || message->dlc_non_comp, ESP_ERR_INVALID_ARG);
  485. TWAI_ENTER_CRITICAL();
  486. //Check State
  487. TWAI_CHECK_FROM_CRIT(!(p_twai_obj->mode == TWAI_MODE_LISTEN_ONLY), ESP_ERR_NOT_SUPPORTED);
  488. TWAI_CHECK_FROM_CRIT(p_twai_obj->state == TWAI_STATE_RUNNING, ESP_ERR_INVALID_STATE);
  489. //Format frame
  490. esp_err_t ret = ESP_FAIL;
  491. twai_hal_frame_t tx_frame;
  492. twai_hal_format_frame(message, &tx_frame);
  493. //Check if frame can be sent immediately
  494. if (p_twai_obj->tx_msg_count == 0) {
  495. //No other frames waiting to transmit. Bypass queue and transmit immediately
  496. twai_hal_set_tx_buffer_and_transmit(&twai_context, &tx_frame);
  497. p_twai_obj->tx_msg_count++;
  498. ret = ESP_OK;
  499. }
  500. TWAI_EXIT_CRITICAL();
  501. if (ret != ESP_OK) {
  502. if (p_twai_obj->tx_queue == NULL) {
  503. //TX Queue is disabled and TX buffer is occupied, message was not sent
  504. ret = ESP_FAIL;
  505. } else if (xQueueSend(p_twai_obj->tx_queue, &tx_frame, ticks_to_wait) == pdTRUE) {
  506. //Copied to TX Queue
  507. TWAI_ENTER_CRITICAL();
  508. if ((!twai_hal_check_state_flags(&twai_context, TWAI_HAL_STATE_FLAG_TX_BUFF_OCCUPIED)) && uxQueueMessagesWaiting(p_twai_obj->tx_queue) > 0) {
  509. //If the TX buffer is free but the TX queue is not empty. Check if we need to manually start a transmission
  510. if (twai_hal_check_state_flags(&twai_context, TWAI_HAL_STATE_FLAG_BUS_OFF) || !twai_hal_check_state_flags(&twai_context, TWAI_HAL_STATE_FLAG_RUNNING)) {
  511. //TX buffer became free due to bus-off or is no longer running. No need to start a transmission
  512. ret = ESP_ERR_INVALID_STATE;
  513. } else {
  514. //Manually start a transmission
  515. int res = xQueueReceive(p_twai_obj->tx_queue, &tx_frame, 0);
  516. assert(res == pdTRUE);
  517. twai_hal_set_tx_buffer_and_transmit(&twai_context, &tx_frame);
  518. p_twai_obj->tx_msg_count++;
  519. ret = ESP_OK;
  520. }
  521. } else {
  522. //Frame was copied to queue, waiting to be transmitted
  523. p_twai_obj->tx_msg_count++;
  524. ret = ESP_OK;
  525. }
  526. TWAI_EXIT_CRITICAL();
  527. } else {
  528. //Timed out waiting for free space on TX queue
  529. ret = ESP_ERR_TIMEOUT;
  530. }
  531. }
  532. return ret;
  533. }
  534. esp_err_t twai_receive(twai_message_t *message, TickType_t ticks_to_wait)
  535. {
  536. //Check arguments and state
  537. TWAI_CHECK(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
  538. TWAI_CHECK(message != NULL, ESP_ERR_INVALID_ARG);
  539. //Get frame from RX Queue or RX Buffer
  540. twai_hal_frame_t rx_frame;
  541. if (xQueueReceive(p_twai_obj->rx_queue, &rx_frame, ticks_to_wait) != pdTRUE) {
  542. return ESP_ERR_TIMEOUT;
  543. }
  544. TWAI_ENTER_CRITICAL();
  545. p_twai_obj->rx_msg_count--;
  546. TWAI_EXIT_CRITICAL();
  547. //Decode frame
  548. twai_hal_parse_frame(&rx_frame, message);
  549. return ESP_OK;
  550. }
  551. esp_err_t twai_read_alerts(uint32_t *alerts, TickType_t ticks_to_wait)
  552. {
  553. //Check arguments and state
  554. TWAI_CHECK(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
  555. TWAI_CHECK(alerts != NULL, ESP_ERR_INVALID_ARG);
  556. //Wait for an alert to occur
  557. if (xSemaphoreTake(p_twai_obj->alert_semphr, ticks_to_wait) == pdTRUE) {
  558. TWAI_ENTER_CRITICAL();
  559. *alerts = p_twai_obj->alerts_triggered;
  560. p_twai_obj->alerts_triggered = 0; //Clear triggered alerts
  561. TWAI_EXIT_CRITICAL();
  562. return ESP_OK;
  563. } else {
  564. *alerts = 0;
  565. return ESP_ERR_TIMEOUT;
  566. }
  567. }
  568. esp_err_t twai_reconfigure_alerts(uint32_t alerts_enabled, uint32_t *current_alerts)
  569. {
  570. TWAI_CHECK(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
  571. TWAI_ENTER_CRITICAL();
  572. //Clear any unhandled alerts
  573. if (current_alerts != NULL) {
  574. *current_alerts = p_twai_obj->alerts_triggered;;
  575. }
  576. p_twai_obj->alerts_triggered = 0;
  577. p_twai_obj->alerts_enabled = alerts_enabled; //Update enabled alerts
  578. TWAI_EXIT_CRITICAL();
  579. return ESP_OK;
  580. }
  581. esp_err_t twai_initiate_recovery(void)
  582. {
  583. TWAI_ENTER_CRITICAL();
  584. //Check state
  585. TWAI_CHECK_FROM_CRIT(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
  586. TWAI_CHECK_FROM_CRIT(p_twai_obj->state == TWAI_STATE_BUS_OFF, ESP_ERR_INVALID_STATE);
  587. //Reset TX Queue/Counters
  588. if (p_twai_obj->tx_queue != NULL) {
  589. xQueueReset(p_twai_obj->tx_queue);
  590. }
  591. p_twai_obj->tx_msg_count = 0;
  592. //Trigger start of recovery process
  593. twai_hal_start_bus_recovery(&twai_context);
  594. p_twai_obj->state = TWAI_STATE_RECOVERING;
  595. TWAI_EXIT_CRITICAL();
  596. return ESP_OK;
  597. }
  598. esp_err_t twai_get_status_info(twai_status_info_t *status_info)
  599. {
  600. //Check parameters and state
  601. TWAI_CHECK(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
  602. TWAI_CHECK(status_info != NULL, ESP_ERR_INVALID_ARG);
  603. TWAI_ENTER_CRITICAL();
  604. status_info->tx_error_counter = twai_hal_get_tec(&twai_context);
  605. status_info->rx_error_counter = twai_hal_get_rec(&twai_context);
  606. status_info->msgs_to_tx = p_twai_obj->tx_msg_count;
  607. status_info->msgs_to_rx = p_twai_obj->rx_msg_count;
  608. status_info->tx_failed_count = p_twai_obj->tx_failed_count;
  609. status_info->rx_missed_count = p_twai_obj->rx_missed_count;
  610. status_info->rx_overrun_count = p_twai_obj->rx_overrun_count;
  611. status_info->arb_lost_count = p_twai_obj->arb_lost_count;
  612. status_info->bus_error_count = p_twai_obj->bus_error_count;
  613. status_info->state = p_twai_obj->state;
  614. TWAI_EXIT_CRITICAL();
  615. return ESP_OK;
  616. }
  617. esp_err_t twai_clear_transmit_queue(void)
  618. {
  619. //Check State
  620. TWAI_CHECK(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
  621. TWAI_CHECK(p_twai_obj->tx_queue != NULL, ESP_ERR_NOT_SUPPORTED);
  622. TWAI_ENTER_CRITICAL();
  623. //If a message is currently undergoing transmission, the tx interrupt handler will decrement tx_msg_count
  624. p_twai_obj->tx_msg_count = twai_hal_check_state_flags(&twai_context, TWAI_HAL_STATE_FLAG_TX_BUFF_OCCUPIED) ? 1 : 0;
  625. xQueueReset(p_twai_obj->tx_queue);
  626. TWAI_EXIT_CRITICAL();
  627. return ESP_OK;
  628. }
  629. esp_err_t twai_clear_receive_queue(void)
  630. {
  631. //Check State
  632. TWAI_CHECK(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
  633. TWAI_ENTER_CRITICAL();
  634. p_twai_obj->rx_msg_count = 0;
  635. xQueueReset(p_twai_obj->rx_queue);
  636. TWAI_EXIT_CRITICAL();
  637. return ESP_OK;
  638. }