| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771 |
- // Copyright 2015-2018 Espressif Systems (Shanghai) PTE LTD
- //
- // Licensed under the Apache License, Version 2.0 (the "License");
- // you may not use this file except in compliance with the License.
- // You may obtain a copy of the License at
- // http://www.apache.org/licenses/LICENSE-2.0
- //
- // Unless required by applicable law or agreed to in writing, software
- // distributed under the License is distributed on an "AS IS" BASIS,
- // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- // See the License for the specific language governing permissions and
- // limitations under the License.
- #include "soc/soc_caps.h"
- #include "sdkconfig.h"
- #include "freertos/FreeRTOS.h"
- #include "freertos/task.h"
- #include "freertos/queue.h"
- #include "freertos/semphr.h"
- #include "esp_types.h"
- #include "esp_log.h"
- #include "esp_intr_alloc.h"
- #include "esp_pm.h"
- #include "esp_attr.h"
- #include "esp_heap_caps.h"
- #include "driver/gpio.h"
- #include "driver/periph_ctrl.h"
- #include "driver/twai.h"
- #include "soc/twai_periph.h"
- #include "hal/twai_hal.h"
- /* ---------------------------- Definitions --------------------------------- */
- //Internal Macros
- #define TWAI_CHECK(cond, ret_val) ({ \
- if (!(cond)) { \
- return (ret_val); \
- } \
- })
- #define TWAI_CHECK_FROM_CRIT(cond, ret_val) ({ \
- if (!(cond)) { \
- TWAI_EXIT_CRITICAL(); \
- return ret_val; \
- } \
- })
- #define TWAI_SET_FLAG(var, mask) ((var) |= (mask))
- #define TWAI_RESET_FLAG(var, mask) ((var) &= ~(mask))
- #ifdef CONFIG_TWAI_ISR_IN_IRAM
- #define TWAI_ISR_ATTR IRAM_ATTR
- #define TWAI_MALLOC_CAPS (MALLOC_CAP_INTERNAL | MALLOC_CAP_8BIT)
- #else
- #define TWAI_TAG "TWAI"
- #define TWAI_ISR_ATTR
- #define TWAI_MALLOC_CAPS MALLOC_CAP_DEFAULT
- #endif //CONFIG_TWAI_ISR_IN_IRAM
- #define DRIVER_DEFAULT_INTERRUPTS 0xE7 //Exclude data overrun (bit[3]) and brp_div (bit[4])
- //Control flags
- #define CTRL_FLAG_STOPPED 0x001 //TWAI peripheral in stopped state
- #define CTRL_FLAG_RECOVERING 0x002 //Bus is undergoing bus recovery
- #define CTRL_FLAG_ERR_WARN 0x004 //TEC or REC is >= error warning limit
- #define CTRL_FLAG_ERR_PASSIVE 0x008 //TEC or REC is >= 128
- #define CTRL_FLAG_BUS_OFF 0x010 //Bus-off due to TEC >= 256
- #define CTRL_FLAG_TX_BUFF_OCCUPIED 0x020 //Transmit buffer is occupied
- #define ALERT_LOG_LEVEL_WARNING TWAI_ALERT_ARB_LOST //Alerts above and including this level use ESP_LOGW
- #define ALERT_LOG_LEVEL_ERROR TWAI_ALERT_TX_FAILED //Alerts above and including this level use ESP_LOGE
- /* ------------------ Typedefs, structures, and variables ------------------- */
- //Control structure for TWAI driver
- typedef struct {
- //Control and status members
- uint32_t control_flags;
- twai_mode_t mode;
- uint32_t rx_missed_count;
- uint32_t tx_failed_count;
- uint32_t arb_lost_count;
- uint32_t bus_error_count;
- intr_handle_t isr_handle;
- //TX and RX
- #ifdef CONFIG_TWAI_ISR_IN_IRAM
- void *tx_queue_buff;
- void *tx_queue_struct;
- void *rx_queue_buff;
- void *rx_queue_struct;
- void *semphr_struct;
- #endif
- QueueHandle_t tx_queue;
- QueueHandle_t rx_queue;
- int tx_msg_count;
- int rx_msg_count;
- //Alerts
- SemaphoreHandle_t alert_semphr;
- uint32_t alerts_enabled;
- uint32_t alerts_triggered;
- #ifdef CONFIG_PM_ENABLE
- //Power Management
- esp_pm_lock_handle_t pm_lock;
- #endif
- } twai_obj_t;
- static twai_obj_t *p_twai_obj = NULL;
- static portMUX_TYPE twai_spinlock = portMUX_INITIALIZER_UNLOCKED;
- #define TWAI_ENTER_CRITICAL_ISR() portENTER_CRITICAL_ISR(&twai_spinlock)
- #define TWAI_EXIT_CRITICAL_ISR() portEXIT_CRITICAL_ISR(&twai_spinlock)
- #define TWAI_ENTER_CRITICAL() portENTER_CRITICAL(&twai_spinlock)
- #define TWAI_EXIT_CRITICAL() portEXIT_CRITICAL(&twai_spinlock)
- static twai_hal_context_t twai_context;
- /* -------------------- Interrupt and Alert Handlers ------------------------ */
- TWAI_ISR_ATTR static void twai_alert_handler(uint32_t alert_code, int *alert_req)
- {
- if (p_twai_obj->alerts_enabled & alert_code) {
- //Signify alert has occurred
- TWAI_SET_FLAG(p_twai_obj->alerts_triggered, alert_code);
- *alert_req = 1;
- #ifndef CONFIG_TWAI_ISR_IN_IRAM //Only log if ISR is not in IRAM
- if (p_twai_obj->alerts_enabled & TWAI_ALERT_AND_LOG) {
- if (alert_code >= ALERT_LOG_LEVEL_ERROR) {
- ESP_EARLY_LOGE(TWAI_TAG, "Alert %d", alert_code);
- } else if (alert_code >= ALERT_LOG_LEVEL_WARNING) {
- ESP_EARLY_LOGW(TWAI_TAG, "Alert %d", alert_code);
- } else {
- ESP_EARLY_LOGI(TWAI_TAG, "Alert %d", alert_code);
- }
- }
- #endif
- }
- }
- static inline void twai_handle_bus_off(int *alert_req)
- {
- //Bus-Off condition. TEC should set and held at 127, REC should be 0, reset mode entered
- TWAI_SET_FLAG(p_twai_obj->control_flags, CTRL_FLAG_BUS_OFF);
- /* Note: REC is still allowed to increase during bus-off. REC > err_warn
- can prevent "bus recovery complete" interrupt from occurring. Set to
- listen only mode to freeze REC. */
- twai_hal_handle_bus_off(&twai_context);
- twai_alert_handler(TWAI_ALERT_BUS_OFF, alert_req);
- }
- static inline void twai_handle_recovery_complete(int *alert_req)
- {
- //Bus recovery complete.
- bool recov_cplt = twai_hal_handle_bus_recov_cplt(&twai_context);
- assert(recov_cplt);
- //Reset and set flags to the equivalent of the stopped state
- TWAI_RESET_FLAG(p_twai_obj->control_flags, CTRL_FLAG_RECOVERING | CTRL_FLAG_ERR_WARN |
- CTRL_FLAG_ERR_PASSIVE | CTRL_FLAG_BUS_OFF |
- CTRL_FLAG_TX_BUFF_OCCUPIED);
- TWAI_SET_FLAG(p_twai_obj->control_flags, CTRL_FLAG_STOPPED);
- twai_alert_handler(TWAI_ALERT_BUS_RECOVERED, alert_req);
- }
- static inline void twai_handle_recovery_in_progress(int * alert_req)
- {
- //Bus-recovery in progress. TEC has dropped below error warning limit
- twai_alert_handler(TWAI_ALERT_RECOVERY_IN_PROGRESS, alert_req);
- }
- static inline void twai_handle_above_ewl(int *alert_req)
- {
- //TEC or REC surpassed error warning limit
- TWAI_SET_FLAG(p_twai_obj->control_flags, CTRL_FLAG_ERR_WARN);
- twai_alert_handler(TWAI_ALERT_ABOVE_ERR_WARN, alert_req);
- }
- static inline void twai_handle_below_ewl(int *alert_req)
- {
- //TEC and REC are both below error warning
- TWAI_RESET_FLAG(p_twai_obj->control_flags, CTRL_FLAG_ERR_WARN);
- twai_alert_handler(TWAI_ALERT_BELOW_ERR_WARN, alert_req);
- }
- static inline void twai_handle_error_passive(int *alert_req)
- {
- //Entered error passive
- TWAI_SET_FLAG(p_twai_obj->control_flags, CTRL_FLAG_ERR_PASSIVE);
- twai_alert_handler(TWAI_ALERT_ERR_PASS, alert_req);
- }
- static inline void twai_handle_error_active(int *alert_req)
- {
- //Returned to error active
- TWAI_RESET_FLAG(p_twai_obj->control_flags, CTRL_FLAG_ERR_PASSIVE);
- twai_alert_handler(TWAI_ALERT_ERR_ACTIVE, alert_req);
- }
- static inline void twai_handle_bus_error(int *alert_req)
- {
- // ECC register is read to re-arm bus error interrupt. ECC is not used
- twai_hal_handle_bus_error(&twai_context);
- p_twai_obj->bus_error_count++;
- twai_alert_handler(TWAI_ALERT_BUS_ERROR, alert_req);
- }
- static inline void twai_handle_arb_lost(int *alert_req)
- {
- //ALC register is read to re-arm arb lost interrupt. ALC is not used
- twai_hal_handle_arb_lost(&twai_context);
- p_twai_obj->arb_lost_count++;
- twai_alert_handler(TWAI_ALERT_ARB_LOST, alert_req);
- }
- static inline void twai_handle_rx_buffer_frames(BaseType_t *task_woken, int *alert_req)
- {
- uint32_t msg_count = twai_hal_get_rx_msg_count(&twai_context);
- for (int i = 0; i < msg_count; i++) {
- twai_hal_frame_t frame;
- twai_hal_read_rx_buffer_and_clear(&twai_context, &frame);
- //Copy frame into RX Queue
- if (xQueueSendFromISR(p_twai_obj->rx_queue, &frame, task_woken) == pdTRUE) {
- p_twai_obj->rx_msg_count++;
- } else {
- p_twai_obj->rx_missed_count++;
- twai_alert_handler(TWAI_ALERT_RX_QUEUE_FULL, alert_req);
- }
- }
- //Todo: Add Software Filters
- //Todo: Check for data overrun of RX FIFO, then trigger alert
- }
- static inline void twai_handle_tx_buffer_frame(BaseType_t *task_woken, int *alert_req)
- {
- //Handle previously transmitted frame
- if (twai_hal_check_last_tx_successful(&twai_context)) {
- twai_alert_handler(TWAI_ALERT_TX_SUCCESS, alert_req);
- } else {
- p_twai_obj->tx_failed_count++;
- twai_alert_handler(TWAI_ALERT_TX_FAILED, alert_req);
- }
- //Update TX message count
- p_twai_obj->tx_msg_count--;
- assert(p_twai_obj->tx_msg_count >= 0); //Sanity check
- //Check if there are more frames to transmit
- if (p_twai_obj->tx_msg_count > 0 && p_twai_obj->tx_queue != NULL) {
- twai_hal_frame_t frame;
- int res = xQueueReceiveFromISR(p_twai_obj->tx_queue, &frame, task_woken);
- if (res == pdTRUE) {
- twai_hal_set_tx_buffer_and_transmit(&twai_context, &frame);
- } else {
- assert(false && "failed to get a frame from TX queue");
- }
- } else {
- //No more frames to transmit
- TWAI_RESET_FLAG(p_twai_obj->control_flags, CTRL_FLAG_TX_BUFF_OCCUPIED);
- twai_alert_handler(TWAI_ALERT_TX_IDLE, alert_req);
- }
- }
- TWAI_ISR_ATTR static void twai_intr_handler_main(void *arg)
- {
- BaseType_t task_woken = pdFALSE;
- int alert_req = 0;
- uint32_t event;
- TWAI_ENTER_CRITICAL_ISR();
- if (p_twai_obj == NULL) { //Incase intr occurs whilst driver is being uninstalled
- TWAI_EXIT_CRITICAL_ISR();
- return;
- }
- event = twai_hal_decode_interrupt_events(&twai_context, p_twai_obj->control_flags & CTRL_FLAG_RECOVERING);
- if (event & TWAI_HAL_EVENT_BUS_OFF) {
- twai_handle_bus_off(&alert_req);
- }
- if (event & TWAI_HAL_EVENT_BUS_RECOV_CPLT) {
- twai_handle_recovery_complete(&alert_req);
- }
- if (event & TWAI_HAL_EVENT_BUS_RECOV_PROGRESS) {
- twai_handle_recovery_in_progress(&alert_req);
- }
- if (event & TWAI_HAL_EVENT_ABOVE_EWL) {
- twai_handle_above_ewl(&alert_req);
- }
- if (event & TWAI_HAL_EVENT_BELOW_EWL) {
- twai_handle_below_ewl(&alert_req);
- }
- if (event & TWAI_HAL_EVENT_ERROR_PASSIVE) {
- twai_handle_error_passive(&alert_req);
- }
- if (event & TWAI_HAL_EVENT_ERROR_ACTIVE) {
- twai_handle_error_active(&alert_req);
- }
- if (event & TWAI_HAL_EVENT_BUS_ERR) {
- twai_handle_bus_error(&alert_req);
- }
- if (event & TWAI_HAL_EVENT_ARB_LOST) {
- twai_handle_arb_lost(&alert_req);
- }
- if (event & TWAI_HAL_EVENT_RX_BUFF_FRAME) {
- twai_handle_rx_buffer_frames(&task_woken, &alert_req);
- }
- //TX command related handlers should be called last, so that other commands
- //do not overwrite the TX command related bits in the command register.
- if (event & TWAI_HAL_EVENT_TX_BUFF_FREE) {
- twai_handle_tx_buffer_frame(&task_woken, &alert_req);
- }
- TWAI_EXIT_CRITICAL_ISR();
- if (p_twai_obj->alert_semphr != NULL && alert_req) {
- //Give semaphore if alerts were triggered
- xSemaphoreGiveFromISR(p_twai_obj->alert_semphr, &task_woken);
- }
- if (task_woken == pdTRUE) {
- portYIELD_FROM_ISR();
- }
- }
- /* -------------------------- Helper functions ----------------------------- */
- static void twai_configure_gpio(gpio_num_t tx, gpio_num_t rx, gpio_num_t clkout, gpio_num_t bus_status)
- {
- //Set TX pin
- gpio_set_pull_mode(tx, GPIO_FLOATING);
- gpio_matrix_out(tx, TWAI_TX_IDX, false, false);
- gpio_pad_select_gpio(tx);
- //Set RX pin
- gpio_set_pull_mode(rx, GPIO_FLOATING);
- gpio_matrix_in(rx, TWAI_RX_IDX, false);
- gpio_pad_select_gpio(rx);
- gpio_set_direction(rx, GPIO_MODE_INPUT);
- //Configure output clock pin (Optional)
- if (clkout >= 0 && clkout < GPIO_NUM_MAX) {
- gpio_set_pull_mode(clkout, GPIO_FLOATING);
- gpio_matrix_out(clkout, TWAI_CLKOUT_IDX, false, false);
- gpio_pad_select_gpio(clkout);
- }
- //Configure bus status pin (Optional)
- if (bus_status >= 0 && bus_status < GPIO_NUM_MAX) {
- gpio_set_pull_mode(bus_status, GPIO_FLOATING);
- gpio_matrix_out(bus_status, TWAI_BUS_OFF_ON_IDX, false, false);
- gpio_pad_select_gpio(bus_status);
- }
- }
- static void twai_free_driver_obj(twai_obj_t *p_obj)
- {
- //Free driver object and any dependent SW resources it uses (queues, semaphores etc)
- #ifdef CONFIG_PM_ENABLE
- if (p_obj->pm_lock != NULL) {
- ESP_ERROR_CHECK(esp_pm_lock_delete(p_obj->pm_lock));
- }
- #endif
- //Delete queues and semaphores
- if (p_obj->tx_queue != NULL) {
- vQueueDelete(p_obj->tx_queue);
- }
- if (p_obj->rx_queue != NULL) {
- vQueueDelete(p_obj->rx_queue);
- }
- if (p_obj->alert_semphr != NULL) {
- vSemaphoreDelete(p_obj->alert_semphr);
- }
- #ifdef CONFIG_TWAI_ISR_IN_IRAM
- //Free memory used by static queues and semaphores. free() allows freeing NULL pointers
- free(p_obj->tx_queue_buff);
- free(p_obj->tx_queue_struct);
- free(p_obj->rx_queue_buff);
- free(p_obj->rx_queue_struct);
- free(p_obj->semphr_struct);
- #endif //CONFIG_TWAI_ISR_IN_IRAM
- free(p_obj);
- }
- static twai_obj_t *twai_alloc_driver_obj(uint32_t tx_queue_len, uint32_t rx_queue_len)
- {
- //Allocates driver object and any dependent SW resources it uses (queues, semaphores etc)
- //Create a TWAI driver object
- twai_obj_t *p_obj = heap_caps_calloc(1, sizeof(twai_obj_t), TWAI_MALLOC_CAPS);
- if (p_obj == NULL) {
- return NULL;
- }
- #ifdef CONFIG_TWAI_ISR_IN_IRAM
- //Allocate memory for queues and semaphores in DRAM
- if (tx_queue_len > 0) {
- p_obj->tx_queue_buff = heap_caps_calloc(tx_queue_len, sizeof(twai_hal_frame_t), TWAI_MALLOC_CAPS);
- p_obj->tx_queue_struct = heap_caps_calloc(1, sizeof(StaticQueue_t), TWAI_MALLOC_CAPS);
- if (p_obj->tx_queue_buff == NULL || p_obj->tx_queue_struct == NULL) {
- goto cleanup;
- }
- }
- p_obj->rx_queue_buff = heap_caps_calloc(rx_queue_len, sizeof(twai_hal_frame_t), TWAI_MALLOC_CAPS);
- p_obj->rx_queue_struct = heap_caps_calloc(1, sizeof(StaticQueue_t), TWAI_MALLOC_CAPS);
- p_obj->semphr_struct = heap_caps_calloc(1, sizeof(StaticSemaphore_t), TWAI_MALLOC_CAPS);
- if (p_obj->rx_queue_buff == NULL || p_obj->rx_queue_struct == NULL || p_obj->semphr_struct == NULL) {
- goto cleanup;
- }
- //Create static queues and semaphores
- if (tx_queue_len > 0) {
- p_obj->tx_queue = xQueueCreateStatic(tx_queue_len, sizeof(twai_hal_frame_t), p_obj->tx_queue_buff, p_obj->tx_queue_struct);
- if (p_obj->tx_queue == NULL) {
- goto cleanup;
- }
- }
- p_obj->rx_queue = xQueueCreateStatic(rx_queue_len, sizeof(twai_hal_frame_t), p_obj->rx_queue_buff, p_obj->rx_queue_struct);
- p_obj->alert_semphr = xSemaphoreCreateBinaryStatic(p_obj->semphr_struct);
- if (p_obj->rx_queue == NULL || p_obj->alert_semphr == NULL) {
- goto cleanup;
- }
- #else //CONFIG_TWAI_ISR_IN_IRAM
- if (tx_queue_len > 0) {
- p_obj->tx_queue = xQueueCreate(tx_queue_len, sizeof(twai_hal_frame_t));
- }
- p_obj->rx_queue = xQueueCreate(rx_queue_len, sizeof(twai_hal_frame_t));
- p_obj->alert_semphr = xSemaphoreCreateBinary();
- if ((tx_queue_len > 0 && p_obj->tx_queue == NULL) || p_obj->rx_queue == NULL || p_obj->alert_semphr == NULL) {
- goto cleanup;
- }
- #endif //CONFIG_TWAI_ISR_IN_IRAM
- #ifdef CONFIG_PM_ENABLE
- esp_err_t pm_err = esp_pm_lock_create(ESP_PM_APB_FREQ_MAX, 0, "twai", &(p_obj->pm_lock));
- if (pm_err != ESP_OK ) {
- goto cleanup;
- }
- #endif
- return p_obj;
- cleanup:
- twai_free_driver_obj(p_obj);
- return NULL;
- }
- /* ---------------------------- Public Functions ---------------------------- */
- 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)
- {
- //Check arguments
- TWAI_CHECK(g_config != NULL, ESP_ERR_INVALID_ARG);
- TWAI_CHECK(t_config != NULL, ESP_ERR_INVALID_ARG);
- TWAI_CHECK(f_config != NULL, ESP_ERR_INVALID_ARG);
- TWAI_CHECK(g_config->rx_queue_len > 0, ESP_ERR_INVALID_ARG);
- TWAI_CHECK(g_config->tx_io >= 0 && g_config->tx_io < GPIO_NUM_MAX, ESP_ERR_INVALID_ARG);
- TWAI_CHECK(g_config->rx_io >= 0 && g_config->rx_io < GPIO_NUM_MAX, ESP_ERR_INVALID_ARG);
- #if (CONFIG_ESP32_REV_MIN >= 2)
- TWAI_CHECK(t_config->brp >= TWAI_BRP_MIN && t_config->brp <= TWAI_BRP_MAX_ECO, ESP_ERR_INVALID_ARG);
- #else
- TWAI_CHECK(t_config->brp >= TWAI_BRP_MIN && t_config->brp <= TWAI_BRP_MAX, ESP_ERR_INVALID_ARG);
- #endif
- #ifndef CONFIG_TWAI_ISR_IN_IRAM
- TWAI_CHECK(!(g_config->intr_flags & ESP_INTR_FLAG_IRAM), ESP_ERR_INVALID_ARG);
- #endif
- TWAI_ENTER_CRITICAL();
- TWAI_CHECK_FROM_CRIT(p_twai_obj == NULL, ESP_ERR_INVALID_STATE);
- TWAI_EXIT_CRITICAL();
- esp_err_t ret;
- twai_obj_t *p_twai_obj_dummy;
- //Create a TWAI object (including queues and semaphores)
- p_twai_obj_dummy = twai_alloc_driver_obj(g_config->tx_queue_len, g_config->rx_queue_len);
- TWAI_CHECK(p_twai_obj_dummy != NULL, ESP_ERR_NO_MEM);
- //Initialize flags and variables. All other members are already set to zero by twai_alloc_driver_obj()
- p_twai_obj_dummy->control_flags = CTRL_FLAG_STOPPED;
- p_twai_obj_dummy->mode = g_config->mode;
- p_twai_obj_dummy->alerts_enabled = g_config->alerts_enabled;
- //Initialize TWAI peripheral registers, and allocate interrupt
- TWAI_ENTER_CRITICAL();
- if (p_twai_obj == NULL) {
- p_twai_obj = p_twai_obj_dummy;
- } else {
- //Check if driver is already installed
- TWAI_EXIT_CRITICAL();
- ret = ESP_ERR_INVALID_STATE;
- goto err;
- }
- periph_module_reset(PERIPH_TWAI_MODULE);
- periph_module_enable(PERIPH_TWAI_MODULE); //Enable APB CLK to TWAI peripheral
- bool init = twai_hal_init(&twai_context);
- assert(init);
- twai_hal_configure(&twai_context, t_config, f_config, DRIVER_DEFAULT_INTERRUPTS, g_config->clkout_divider);
- //Todo: Allow interrupt to be registered to specified CPU
- TWAI_EXIT_CRITICAL();
- //Allocate GPIO and Interrupts
- twai_configure_gpio(g_config->tx_io, g_config->rx_io, g_config->clkout_io, g_config->bus_off_io);
- ESP_ERROR_CHECK(esp_intr_alloc(ETS_TWAI_INTR_SOURCE, g_config->intr_flags, twai_intr_handler_main, NULL, &p_twai_obj->isr_handle));
- #ifdef CONFIG_PM_ENABLE
- ESP_ERROR_CHECK(esp_pm_lock_acquire(p_twai_obj->pm_lock)); //Acquire pm_lock to keep APB clock at 80MHz
- #endif
- return ESP_OK; //TWAI module is still in reset mode, users need to call twai_start() afterwards
- err:
- //Free can driver object
- twai_free_driver_obj(p_twai_obj_dummy);
- return ret;
- }
- esp_err_t twai_driver_uninstall(void)
- {
- twai_obj_t *p_twai_obj_dummy;
- TWAI_ENTER_CRITICAL();
- //Check state
- TWAI_CHECK_FROM_CRIT(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
- TWAI_CHECK_FROM_CRIT(p_twai_obj->control_flags & (CTRL_FLAG_STOPPED | CTRL_FLAG_BUS_OFF), ESP_ERR_INVALID_STATE);
- //Todo: Add check to see if in reset mode. //Enter reset mode to stop any TWAI bus activity
- //Clear registers by reading
- twai_hal_deinit(&twai_context);
- periph_module_disable(PERIPH_TWAI_MODULE); //Disable TWAI peripheral
- p_twai_obj_dummy = p_twai_obj; //Use dummy to shorten critical section
- p_twai_obj = NULL;
- TWAI_EXIT_CRITICAL();
- ESP_ERROR_CHECK(esp_intr_free(p_twai_obj_dummy->isr_handle)); //Free interrupt
- #ifdef CONFIG_PM_ENABLE
- //Release and delete power management lock
- ESP_ERROR_CHECK(esp_pm_lock_release(p_twai_obj_dummy->pm_lock));
- #endif
- //Free can driver object
- twai_free_driver_obj(p_twai_obj_dummy);
- return ESP_OK;
- }
- esp_err_t twai_start(void)
- {
- //Check state
- TWAI_ENTER_CRITICAL();
- TWAI_CHECK_FROM_CRIT(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
- TWAI_CHECK_FROM_CRIT(p_twai_obj->control_flags & CTRL_FLAG_STOPPED, ESP_ERR_INVALID_STATE);
- //Reset RX queue, and RX message count
- xQueueReset(p_twai_obj->rx_queue);
- p_twai_obj->rx_msg_count = 0;
- //Todo: Add assert to see if in reset mode. //Should already be in bus-off mode, set again to make sure
- //Currently in listen only mode, need to set to mode specified by configuration
- bool started = twai_hal_start(&twai_context, p_twai_obj->mode);
- assert(started);
- TWAI_RESET_FLAG(p_twai_obj->control_flags, CTRL_FLAG_STOPPED);
- TWAI_EXIT_CRITICAL();
- return ESP_OK;
- }
- esp_err_t twai_stop(void)
- {
- //Check state
- TWAI_ENTER_CRITICAL();
- TWAI_CHECK_FROM_CRIT(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
- TWAI_CHECK_FROM_CRIT(!(p_twai_obj->control_flags & (CTRL_FLAG_STOPPED | CTRL_FLAG_BUS_OFF)), ESP_ERR_INVALID_STATE);
- bool stopped = twai_hal_stop(&twai_context);
- assert(stopped);
- TWAI_RESET_FLAG(p_twai_obj->control_flags, CTRL_FLAG_TX_BUFF_OCCUPIED);
- TWAI_SET_FLAG(p_twai_obj->control_flags, CTRL_FLAG_STOPPED);
- //Reset TX Queue and message count
- if (p_twai_obj->tx_queue != NULL) {
- xQueueReset(p_twai_obj->tx_queue);
- }
- p_twai_obj->tx_msg_count = 0;
- TWAI_EXIT_CRITICAL();
- return ESP_OK;
- }
- esp_err_t twai_transmit(const twai_message_t *message, TickType_t ticks_to_wait)
- {
- //Check arguments
- TWAI_CHECK(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
- TWAI_CHECK(message != NULL, ESP_ERR_INVALID_ARG);
- TWAI_CHECK((message->data_length_code <= TWAI_FRAME_MAX_DLC) || message->dlc_non_comp, ESP_ERR_INVALID_ARG);
- TWAI_ENTER_CRITICAL();
- //Check State
- TWAI_CHECK_FROM_CRIT(!(p_twai_obj->mode == TWAI_MODE_LISTEN_ONLY), ESP_ERR_NOT_SUPPORTED);
- TWAI_CHECK_FROM_CRIT(!(p_twai_obj->control_flags & (CTRL_FLAG_STOPPED | CTRL_FLAG_BUS_OFF)), ESP_ERR_INVALID_STATE);
- //Format frame
- esp_err_t ret = ESP_FAIL;
- twai_hal_frame_t tx_frame;
- twai_hal_format_frame(message, &tx_frame);
- //Check if frame can be sent immediately
- if ((p_twai_obj->tx_msg_count == 0) && !(p_twai_obj->control_flags & CTRL_FLAG_TX_BUFF_OCCUPIED)) {
- //No other frames waiting to transmit. Bypass queue and transmit immediately
- twai_hal_set_tx_buffer_and_transmit(&twai_context, &tx_frame);
- p_twai_obj->tx_msg_count++;
- TWAI_SET_FLAG(p_twai_obj->control_flags, CTRL_FLAG_TX_BUFF_OCCUPIED);
- ret = ESP_OK;
- }
- TWAI_EXIT_CRITICAL();
- if (ret != ESP_OK) {
- if (p_twai_obj->tx_queue == NULL) {
- //TX Queue is disabled and TX buffer is occupied, message was not sent
- ret = ESP_FAIL;
- } else if (xQueueSend(p_twai_obj->tx_queue, &tx_frame, ticks_to_wait) == pdTRUE) {
- //Copied to TX Queue
- TWAI_ENTER_CRITICAL();
- if (p_twai_obj->control_flags & (CTRL_FLAG_STOPPED | CTRL_FLAG_BUS_OFF)) {
- //TX queue was reset (due to stop/bus_off), remove copied frame from queue to prevent transmission
- int res = xQueueReceive(p_twai_obj->tx_queue, &tx_frame, 0);
- assert(res == pdTRUE);
- ret = ESP_ERR_INVALID_STATE;
- } else if ((p_twai_obj->tx_msg_count == 0) && !(p_twai_obj->control_flags & CTRL_FLAG_TX_BUFF_OCCUPIED)) {
- //TX buffer was freed during copy, manually trigger transmission
- int res = xQueueReceive(p_twai_obj->tx_queue, &tx_frame, 0);
- assert(res == pdTRUE);
- twai_hal_set_tx_buffer_and_transmit(&twai_context, &tx_frame);
- p_twai_obj->tx_msg_count++;
- TWAI_SET_FLAG(p_twai_obj->control_flags, CTRL_FLAG_TX_BUFF_OCCUPIED);
- ret = ESP_OK;
- } else {
- //Frame was copied to queue, waiting to be transmitted
- p_twai_obj->tx_msg_count++;
- ret = ESP_OK;
- }
- TWAI_EXIT_CRITICAL();
- } else {
- //Timed out waiting for free space on TX queue
- ret = ESP_ERR_TIMEOUT;
- }
- }
- return ret;
- }
- esp_err_t twai_receive(twai_message_t *message, TickType_t ticks_to_wait)
- {
- //Check arguments and state
- TWAI_CHECK(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
- TWAI_CHECK(message != NULL, ESP_ERR_INVALID_ARG);
- //Get frame from RX Queue or RX Buffer
- twai_hal_frame_t rx_frame;
- if (xQueueReceive(p_twai_obj->rx_queue, &rx_frame, ticks_to_wait) != pdTRUE) {
- return ESP_ERR_TIMEOUT;
- }
- TWAI_ENTER_CRITICAL();
- p_twai_obj->rx_msg_count--;
- TWAI_EXIT_CRITICAL();
- //Decode frame
- twai_hal_parse_frame(&rx_frame, message);
- return ESP_OK;
- }
- esp_err_t twai_read_alerts(uint32_t *alerts, TickType_t ticks_to_wait)
- {
- //Check arguments and state
- TWAI_CHECK(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
- TWAI_CHECK(alerts != NULL, ESP_ERR_INVALID_ARG);
- //Wait for an alert to occur
- if (xSemaphoreTake(p_twai_obj->alert_semphr, ticks_to_wait) == pdTRUE) {
- TWAI_ENTER_CRITICAL();
- *alerts = p_twai_obj->alerts_triggered;
- p_twai_obj->alerts_triggered = 0; //Clear triggered alerts
- TWAI_EXIT_CRITICAL();
- return ESP_OK;
- } else {
- *alerts = 0;
- return ESP_ERR_TIMEOUT;
- }
- }
- esp_err_t twai_reconfigure_alerts(uint32_t alerts_enabled, uint32_t *current_alerts)
- {
- TWAI_CHECK(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
- TWAI_ENTER_CRITICAL();
- //Clear any unhandled alerts
- if (current_alerts != NULL) {
- *current_alerts = p_twai_obj->alerts_triggered;;
- }
- p_twai_obj->alerts_triggered = 0;
- p_twai_obj->alerts_enabled = alerts_enabled; //Update enabled alerts
- TWAI_EXIT_CRITICAL();
- return ESP_OK;
- }
- esp_err_t twai_initiate_recovery(void)
- {
- TWAI_ENTER_CRITICAL();
- //Check state
- TWAI_CHECK_FROM_CRIT(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
- TWAI_CHECK_FROM_CRIT(p_twai_obj->control_flags & CTRL_FLAG_BUS_OFF, ESP_ERR_INVALID_STATE);
- TWAI_CHECK_FROM_CRIT(!(p_twai_obj->control_flags & CTRL_FLAG_RECOVERING), ESP_ERR_INVALID_STATE);
- //Reset TX Queue/Counters
- if (p_twai_obj->tx_queue != NULL) {
- xQueueReset(p_twai_obj->tx_queue);
- }
- p_twai_obj->tx_msg_count = 0;
- TWAI_RESET_FLAG(p_twai_obj->control_flags, CTRL_FLAG_TX_BUFF_OCCUPIED);
- TWAI_SET_FLAG(p_twai_obj->control_flags, CTRL_FLAG_RECOVERING);
- //Trigger start of recovery process
- bool started = twai_hal_start_bus_recovery(&twai_context);
- assert(started);
- TWAI_EXIT_CRITICAL();
- return ESP_OK;
- }
- esp_err_t twai_get_status_info(twai_status_info_t *status_info)
- {
- //Check parameters and state
- TWAI_CHECK(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
- TWAI_CHECK(status_info != NULL, ESP_ERR_INVALID_ARG);
- TWAI_ENTER_CRITICAL();
- status_info->tx_error_counter = twai_hal_get_tec(&twai_context);
- status_info->rx_error_counter = twai_hal_get_rec(&twai_context);
- status_info->msgs_to_tx = p_twai_obj->tx_msg_count;
- status_info->msgs_to_rx = p_twai_obj->rx_msg_count;
- status_info->tx_failed_count = p_twai_obj->tx_failed_count;
- status_info->rx_missed_count = p_twai_obj->rx_missed_count;
- status_info->arb_lost_count = p_twai_obj->arb_lost_count;
- status_info->bus_error_count = p_twai_obj->bus_error_count;
- if (p_twai_obj->control_flags & CTRL_FLAG_RECOVERING) {
- status_info->state = TWAI_STATE_RECOVERING;
- } else if (p_twai_obj->control_flags & CTRL_FLAG_BUS_OFF) {
- status_info->state = TWAI_STATE_BUS_OFF;
- } else if (p_twai_obj->control_flags & CTRL_FLAG_STOPPED) {
- status_info->state = TWAI_STATE_STOPPED;
- } else {
- status_info->state = TWAI_STATE_RUNNING;
- }
- TWAI_EXIT_CRITICAL();
- return ESP_OK;
- }
- esp_err_t twai_clear_transmit_queue(void)
- {
- //Check State
- TWAI_CHECK(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
- TWAI_CHECK(p_twai_obj->tx_queue != NULL, ESP_ERR_NOT_SUPPORTED);
- TWAI_ENTER_CRITICAL();
- //If a message is currently undergoing transmission, the tx interrupt handler will decrement tx_msg_count
- p_twai_obj->tx_msg_count = (p_twai_obj->control_flags & CTRL_FLAG_TX_BUFF_OCCUPIED) ? 1 : 0;
- xQueueReset(p_twai_obj->tx_queue);
- TWAI_EXIT_CRITICAL();
- return ESP_OK;
- }
- esp_err_t twai_clear_receive_queue(void)
- {
- //Check State
- TWAI_CHECK(p_twai_obj != NULL, ESP_ERR_INVALID_STATE);
- TWAI_ENTER_CRITICAL();
- p_twai_obj->rx_msg_count = 0;
- xQueueReset(p_twai_obj->rx_queue);
- TWAI_EXIT_CRITICAL();
- return ESP_OK;
- }
|