/** This file encapsulates the SDK-based task handling for the NodeMCU Lua firmware. */ #include "task/task.h" #include #include #include "freertos/FreeRTOS.h" #include "freertos/queue.h" #include "freertos/semphr.h" #define TASK_HANDLE_MONIKER 0x68680000 #define TASK_HANDLE_MASK 0xFFF80000 #define TASK_HANDLE_UNMASK (~TASK_HANDLE_MASK) #define TASK_HANDLE_ALLOCATION_BRICK 4 // must be a power of 2 #define CHECK(p,v,msg) if (!(p)) { NODE_DBG ( msg ); return (v); } #ifndef NODE_DBG # define NODE_DBG(...) do{}while(0) #endif typedef struct { task_handle_t sig; task_param_t par; } task_event_t; /* * Private arrays to hold the 3 event task queues and the dispatch callbacks */ static QueueHandle_t task_Q[TASK_PRIORITY_COUNT]; /* Rather than using a QueueSet (which requires queues to be empty when created) * we use a binary semaphore to unblock the pump whenever something is posted */ static SemaphoreHandle_t pending; static task_callback_t *task_func; static int task_count; task_handle_t task_get_id(task_callback_t t) { if ( (task_count & (TASK_HANDLE_ALLOCATION_BRICK - 1)) == 0 ) { /* With a brick size of 4 this branch is taken at 0, 4, 8 ... and the new size is +4 */ task_func =(task_callback_t *)realloc( task_func, sizeof(task_callback_t)*(task_count+TASK_HANDLE_ALLOCATION_BRICK)); CHECK(task_func, 0 , "Malloc failure in task_get_id"); memset (task_func+task_count, 0, sizeof(task_callback_t)*TASK_HANDLE_ALLOCATION_BRICK); } task_func[task_count] = t; return TASK_HANDLE_MONIKER | task_count++; } static bool IRAM_ATTR task_post_wait(task_prio_t priority, task_handle_t handle, task_param_t param, unsigned max_wait) { if (priority >= TASK_PRIORITY_COUNT || (handle & TASK_HANDLE_MASK) != TASK_HANDLE_MONIKER) return false; task_event_t ev = { handle, param }; bool res = (pdPASS == xQueueSendToBack(task_Q[priority], &ev, max_wait)); xSemaphoreGive(pending); return res; } bool IRAM_ATTR task_post(task_prio_t priority, task_handle_t handle, task_param_t param) { return task_post_wait(priority, handle, param, 0); } bool IRAM_ATTR task_post_block(task_prio_t priority, task_handle_t handle, task_param_t param) { return task_post_wait(priority, handle, param, portMAX_DELAY); } bool IRAM_ATTR task_post_isr(task_prio_t priority, task_handle_t handle, task_param_t param) { if (priority >= TASK_PRIORITY_COUNT || (handle & TASK_HANDLE_MASK) != TASK_HANDLE_MONIKER) return false; task_event_t ev = { handle, param }; bool res = (pdPASS == xQueueSendToBackFromISR (task_Q[priority], &ev, NULL)); BaseType_t woken = pdFALSE; xSemaphoreGiveFromISR (pending, &woken); if (woken == pdTRUE) portYIELD_FROM_ISR(); return res; } static bool next_event (task_event_t *ev, task_prio_t *prio) { for (task_prio_t pr = TASK_PRIORITY_COUNT; pr != TASK_PRIORITY_LOW; --pr) { task_prio_t p = pr -1; if (task_Q[p] && xQueueReceive (task_Q[p], ev, 0) == pdTRUE) { *prio = p; return true; } } return false; // no events queued } static void dispatch (task_event_t *e, uint8_t prio) { task_handle_t handle = e->sig; if ( (handle & TASK_HANDLE_MASK) == TASK_HANDLE_MONIKER) { uint16_t entry = (handle & TASK_HANDLE_UNMASK); if ( task_func && entry < task_count ){ /* call the registered task handler with the specified parameter and priority */ task_func[entry](e->par, prio); return; } } /* Invalid signals are ignored */ NODE_DBG ( "Invalid signal issued: %08x", handle); } void task_init (void) { pending = xSemaphoreCreateBinary (); // Due to the nature of the RTOS, if we ever fail to do a task_post, we're // up the proverbial creek without a paddle. Each queue slot only costs us // 8 bytes, so it's a worthwhile trade-off to reserve a bit of RAM for this // purpose. Trying to work around the issue in the places which post ends // up being *at least* as bad, so better take the hit where the benefit // is shared. That said, we let the user have the final say. const size_t q_mem = CONFIG_NODEMCU_TASK_SLOT_MEMORY; // Rather than blindly sizing everything the same, we try to be a little // bit aware of the typical uses of the queues. const size_t slice = q_mem / (10 * sizeof(task_event_t)); static const int qlens[] = { 1 * slice, 5 * slice, 4 * slice }; for (task_prio_t p = TASK_PRIORITY_LOW; p != TASK_PRIORITY_COUNT; ++p) task_Q[p] = xQueueCreate (qlens[p], sizeof (task_event_t)); } void task_pump_messages (void) { for (;;) { task_event_t ev; task_prio_t prio; if (next_event (&ev, &prio)) dispatch (&ev, prio); else xSemaphoreTake (pending, portMAX_DELAY); } }