feat(esp8266): Modify WIFI OS adapter APIs for ESP8266

Add platform code of FreeRTOS.

components/esp8266/include/esp_wifi_os_adapter.h

@@ -15,13 +15,13 @@
 #ifndef ESP_WIFI_OS_ADAPTER_H_
 #define ESP_WIFI_OS_ADAPTER_H_
 
+#include <stdint.h>
+#include <stdbool.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-#define ESP_WIFI_OS_ADAPTER_VERSION  0x00000001
-#define ESP_WIFI_OS_ADAPTER_MAGIC    0xDEADBEAF
-
 #define OSI_FUNCS_TIME_BLOCKING      0xffffffff
 
 #define OSI_QUEUE_SEND_FRONT         0
@@ -29,57 +29,61 @@ extern "C" {
 #define OSI_QUEUE_SEND_OVERWRITE     2
 
 typedef struct {
-    int32_t _version;
-    xt_handler (*_set_isr)(int32_t n, xt_handler f, void *arg);
-    void (*_ints_on)(uint32_t mask);
-    void (*_ints_off)(uint32_t mask);
-    uint32_t (*_interrupt_disable)(void);
-    void (*_interrupt_restore)(uint32_t tmp);
-    void (*_task_yield)(void);
-    void (*_task_yield_from_isr)(void);
-    void *(*_semphr_create)(uint32_t max, uint32_t init);
-    void (*_semphr_delete)(void *semphr);
-    int32_t (*_semphr_take_from_isr)(void *semphr, void *hptw);
-    int32_t (*_semphr_give_from_isr)(void *semphr, void *hptw);
-    int32_t (*_semphr_take)(void *semphr, uint32_t block_time_tick);
-    int32_t (*_semphr_give)(void *semphr);
-    void *(*_mutex_create)(void);
-    void (*_mutex_delete)(void *mutex);
-    int32_t (*_mutex_lock)(void *mutex);
-    int32_t (*_mutex_unlock)(void *mutex);
-    void *(* _queue_create)(uint32_t queue_len, uint32_t item_size);
-    void (* _queue_delete)(void *queue);
-    int32_t (* _queue_send)(void *queue, void *item, uint32_t block_time_tick, uint32_t pos);
-    int32_t (* _queue_send_from_isr)(void *queue, void *item, void *hptw);
-    int32_t (* _queue_recv)(void *queue, void *item, uint32_t block_time_tick);
-    int32_t (* _queue_recv_from_isr)(void *queue, void *item, void *hptw);
-    int32_t (* _queue_msg_waiting)(void *queue);
-    void *(* _event_group_create)(void);
-    void (* _event_group_delete)(void *event);
-    uint32_t (* _event_group_set_bits)(void *event, uint32_t bits);
-    uint32_t (* _event_group_clear_bits)(void *event, uint32_t bits);
-    uint32_t (* _event_group_wait_bits)(void *event, uint32_t bits_to_wait_for, int clear_on_exit, int wait_for_all_bits, uint32_t block_time_tick);
-    int32_t (* _task_create_pinned_to_core)(void *task_func, const char *name, uint32_t stack_depth, void *param, uint32_t prio, void *task_handle, uint32_t core_id);
-    int32_t (* _task_create)(void *task_func, const char *name, uint32_t stack_depth, void *param, uint32_t prio, void *task_handle);
-    void (* _task_delete)(void *task_handle);
-    void (* _task_delay)(uint32_t tick);
-    int32_t (* _task_ms_to_tick)(uint32_t ms);
-    void *(* _task_get_current_task)(void);
-    int32_t (* _task_get_max_priority)(void);
-    bool (* _is_in_isr)(void);
-    void *(* _malloc)(uint32_t size);
-    void (* _free)(void *p);
-    int32_t (* _get_free_heap_size)(void);
-    int32_t (* _read_efuse_mac)(uint8_t mac[6]);
-    void (* _srand)(uint32_t seed);
-    int32_t (* _rand)(void);
-    int32_t _magic;
-} wifi_osi_funcs_t;
+    uint32_t (*enter_critical)(void);
+    void (*exit_critical)(uint32_t tmp);
 
-extern wifi_osi_funcs_t g_wifi_osi_funcs;
+    void *(*task_create)(void *task_func, const char *name, uint32_t stack_depth, void *param, uint32_t prio);
+    void (*task_delete)(void *task_handle);
+    void (*task_yield)(void);
+    void (*task_yield_from_isr)(void);
+    void (*task_delay)(uint32_t tick);
+    void *(*task_get_current_task)(void);
+    uint32_t (*task_get_max_priority)(void);
+
+    uint32_t (*task_ms_to_tick)(uint32_t ms);
+
+    void (*task_suspend_all)(void);
+    void (*task_resume_all)(void);
+
+    void (*os_init)(void);
+    void (*os_start)(void);
+
+    void *(*semphr_create)(uint32_t max, uint32_t init);
+    void (*semphr_delete)(void *semphr);
+    bool (*semphr_take_from_isr)(void *semphr, int *hptw);
+    bool (*semphr_give_from_isr)(void *semphr, int *hptw);
+    bool (*semphr_take)(void *semphr, uint32_t block_time_tick);
+    bool (*semphr_give)(void *semphr);
+
+    void *(*mutex_create)(void);
+    void (*mutex_delete)(void *mutex);
+    bool (*mutex_lock)(void *mutex);
+    bool (*mutex_unlock)(void *mutex);
+
+    void *(*queue_create)(uint32_t queue_len, uint32_t item_size);
+    void (*queue_delete)(void *queue);
+    bool (*queue_send)(void *queue, void *item, uint32_t block_time_tick, uint32_t pos);
+    bool (*queue_send_from_isr)(void *queue, void *item, int *hptw);
+    bool (*queue_recv)(void *queue, void *item, uint32_t block_time_tick);
+    bool (*queue_recv_from_isr)(void *queue, void *item, int *hptw);
+    uint32_t (*queue_msg_waiting)(void *queue);
+
+    void *(*timer_create)(const char *name, uint32_t period_ticks, bool auto_load, void *arg, void (*cb)(void *timer));
+    void *(*timer_get_arg)(void *timer);
+    bool (*timer_reset)(void *timer, uint32_t ticks);
+    bool (*timer_stop)(void *timer, uint32_t ticks);
+    bool (*timer_delete)(void *timer, uint32_t ticks);
+
+    void *(*malloc)(uint32_t size);
+    void (*free)(void *p);
+    uint32_t (*get_free_heap_size)(void);
+
+    void (*srand)(uint32_t seed);
+    int32_t (*rand)(void);
+} wifi_osi_funcs_t;
 
 #ifdef __cplusplus
 }
 #endif
 
-#endif /* ESP_WIFI_OS_ADAPTER_H_ */
+#endif /* ESP_WIFI_OS_ADAPTER_H_ */

components/esp8266/include/esp_wifi_osi.h

@@ -0,0 +1,153 @@
+// Copyright 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.
+
+#ifndef ESP_WIFI_OSI_H_
+#define ESP_WIFI_OSI_H_
+
+#include "esp_wifi_os_adapter.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+extern wifi_osi_funcs_t s_wifi_osi_funcs;
+
+#define wifi_enter_critical(t) \
+    t = s_wifi_osi_funcs.enter_critical()
+
+#define wifi_exit_critical(t) \
+    s_wifi_osi_funcs.exit_critical(t)
+
+#define wifi_task_create(func, name, depth, param, pri) \
+    s_wifi_osi_funcs.task_create(func, name, depth, param, pri)
+
+#define wifi_task_delete(h) \
+    s_wifi_osi_funcs.task_delete(h)
+
+#define wifi_task_yield() \
+    s_wifi_osi_funcs.task_yield()
+
+#define wifi_task_yield_from_isr() \
+    s_wifi_osi_funcs.task_yield_from_isr()
+
+#define wifi_task_delay(t) \
+    s_wifi_osi_funcs.task_delay(t)
+
+#define wifi_task_get_current_task() \
+    s_wifi_osi_funcs.task_get_current_task()
+
+#define wifi_task_get_max_priority() \
+    s_wifi_osi_funcs.task_get_max_priority()
+
+#define wifi_task_ms_to_ticks(t) \
+    s_wifi_osi_funcs.task_ms_to_tick(t)
+
+#define wifi_task_suspend_all() \
+    s_wifi_osi_funcs.task_suspend_all()
+
+#define wifi_task_resume_all() \
+    s_wifi_osi_funcs.task_resume_all()
+
+#define wifi_os_init() \
+    s_wifi_osi_funcs.os_init()
+
+#define wifi_os_start() \
+    s_wifi_osi_funcs.os_start()
+
+#define wifi_semphr_create(m, i) \
+    s_wifi_osi_funcs.semphr_create(m, i)
+
+#define wifi_semphr_delete(s) \
+    s_wifi_osi_funcs.semphr_delete(s)
+
+#define wifi_semphr_take_from_isr(s, r) \
+    s_wifi_osi_funcs.semphr_take_from_isr(s, r)
+
+#define wifi_semphr_give_from_isr(s, r) \
+    s_wifi_osi_funcs.semphr_give_from_isr(s, r)
+
+#define wifi_semphr_take(s, t) \
+    s_wifi_osi_funcs.semphr_take(s, t)
+
+#define wifi_semphr_give(s) \
+    s_wifi_osi_funcs.semphr_give(s)
+
+#define wifi_mutex_create() \
+    s_wifi_osi_funcs.mutex_create()
+
+#define wifi_mutex_delete(m) \
+    s_wifi_osi_funcs.mutex_delete(m)
+
+#define wifi_mutex_lock(m) \
+    s_wifi_osi_funcs.mutex_lock(m)
+
+#define wifi_mutex_unlock(m) \
+    s_wifi_osi_funcs.mutex_unlock(m)
+
+#define wifi_queue_create(ql, is) \
+    s_wifi_osi_funcs.queue_create(ql, is)
+
+#define wifi_queue_delete(q) \
+    s_wifi_osi_funcs.queue_delete(q)
+
+#define wifi_queue_send(q, i, t, p) \
+    s_wifi_osi_funcs.queue_send(q, i, t, p)
+
+#define wifi_queue_send_from_isr(q, i, r) \
+    s_wifi_osi_funcs.queue_send_from_isr(q, i, r)
+
+#define wifi_queue_recv(q, i, t) \
+    s_wifi_osi_funcs.queue_recv(q, i, t)
+
+#define wifi_queue_recv_from_isr(q, i, r) \
+    s_wifi_osi_funcs.queue_recv_from_isr(q, i, r)
+
+#define wifi_queue_msg_waiting(q) \
+    s_wifi_osi_funcs.queue_msg_waiting(q)
+
+#define wifi_timer_create(n, p, al, ag, cb) \
+    s_wifi_osi_funcs.timer_create(n, p, al, ag, cb)
+
+#define wifi_timer_get_arg(t) \
+    s_wifi_osi_funcs.timer_get_arg(t)
+
+#define wifi_timer_reset(t, tk) \
+    s_wifi_osi_funcs.timer_reset(t, tk)
+
+#define wifi_timer_stop(t, tk) \
+    s_wifi_osi_funcs.timer_stop(t, tk)
+
+#define wifi_timer_delete(t, tk) \
+    s_wifi_osi_funcs.timer_delete(t, tk)
+
+#define wifi_malloc(s) \
+    s_wifi_osi_funcs.malloc(s)
+
+#define wifi_free(p) \
+    s_wifi_osi_funcs.free(p)
+
+#define wifi_get_free_heap_size() \
+    s_wifi_osi_funcs.get_free_heap_size()
+
+#define wifi_srand(s) \
+    s_wifi_osi_funcs.srand(s)
+
+#define wifi_rand() \
+    s_wifi_osi_funcs.rand()
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* ESP_WIFI_OSI_H_ */

components/esp8266/source/esp_wifi_os_adapter.c

@@ -0,0 +1,330 @@
+// Copyright 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 "esp_wifi_os_adapter.h"
+#include "esp_system.h"
+
+#include "freertos/FreeRTOS.h"
+#include "freertos/task.h"
+#include "freertos/queue.h"
+#include "freertos/semphr.h"
+#include "freertos/timers.h"
+
+static uint32_t enter_critical_wrapper(void)
+{
+    taskENTER_CRITICAL();
+
+    return 0;
+}
+
+static void exit_critical_wrapper(uint32_t tmp)
+{
+    taskEXIT_CRITICAL();
+}
+
+static void *task_create_wrapper(void *task_func, const char *name, uint32_t stack_depth, void *param, uint32_t prio)
+{
+    portBASE_TYPE ret;
+    xTaskHandle handle;
+
+    ret = xTaskCreate(task_func, (const signed char *)name, stack_depth, param, prio, &handle);
+
+    return ret == pdPASS ? handle : NULL;
+}
+
+static void task_delete_wrapper(void *task_handle)
+{
+    vTaskDelete(task_handle);
+}
+
+static void task_yield_wrapper(void)
+{
+    portYIELD();
+}
+
+static void task_yield_from_isr_wrapper(void)
+{
+    portYIELD();
+}
+
+static void task_delay_wrapper(uint32_t tick)
+{
+    vTaskDelay(tick);
+}
+
+static void* task_get_current_task_wrapper(void)
+{
+    return (void *)xTaskGetCurrentTaskHandle();
+}
+
+static uint32_t task_get_max_priority_wrapper(void)
+{
+    return (uint32_t)(configMAX_PRIORITIES);
+}
+
+static uint32_t task_ms_to_tick_wrapper(uint32_t ms)
+{
+    return (uint32_t)(ms / portTICK_RATE_MS);
+}
+
+static void task_suspend_all_wrapper(void)
+{
+    vTaskSuspendAll();
+}
+
+static void task_resume_all_wrapper(void)
+{
+    xTaskResumeAll();
+}
+
+static void os_init_wrapper(void)
+{
+    /* empty function */
+}
+
+static void os_start_wrapper(void)
+{
+    vTaskStartScheduler();
+}
+
+static void *semphr_create_wrapper(uint32_t max, uint32_t init)
+{
+    return (void *)xSemaphoreCreateCounting(max, init);
+}
+
+static void semphr_delete_wrapper(void *semphr)
+{
+    vSemaphoreDelete(semphr);
+}
+
+static bool semphr_take_from_isr_wrapper(void *semphr, int *hptw)
+{
+    signed portBASE_TYPE ret;
+
+    ret = xSemaphoreTakeFromISR(semphr, (signed portBASE_TYPE *)hptw);
+    
+    return ret == pdPASS ? true : false;
+}
+
+static bool semphr_give_from_isr_wrapper(void *semphr, int *hptw)
+{
+    signed portBASE_TYPE ret;
+
+    ret = xSemaphoreGiveFromISR(semphr, (signed portBASE_TYPE *)hptw);
+
+    return ret == pdPASS ? true : false;
+}
+
+static bool semphr_take_wrapper(void *semphr, uint32_t block_time_tick)
+{
+    signed portBASE_TYPE ret;
+
+    if (block_time_tick == OSI_FUNCS_TIME_BLOCKING) {
+        ret = xSemaphoreTake(semphr, portMAX_DELAY);
+    } else {
+        ret = xSemaphoreTake(semphr, block_time_tick);
+    }
+
+    return ret == pdPASS ? true : false;
+}
+
+static bool semphr_give_wrapper(void *semphr)
+{
+    signed portBASE_TYPE ret;
+
+    ret = xSemaphoreGive(semphr);
+
+    return ret == pdPASS ? true : false;
+}
+
+static void *mutex_create_wrapper(void)
+{
+    return (void *)xSemaphoreCreateRecursiveMutex();
+}
+
+static void mutex_delete_wrapper(void *mutex)
+{
+    vSemaphoreDelete(mutex);
+}
+
+static bool mutex_lock_wrapper(void *mutex)
+{
+    signed portBASE_TYPE ret;
+
+    ret = xSemaphoreTakeRecursive(mutex, portMAX_DELAY);
+
+    return ret == pdPASS ? true : false;
+}
+
+static bool mutex_unlock_wrapper(void *mutex)
+{
+    signed portBASE_TYPE ret;
+
+    ret = xSemaphoreGiveRecursive(mutex);
+
+    return ret == pdPASS ? true : false;
+}
+
+static void *queue_create_wrapper(uint32_t queue_len, uint32_t item_size)
+{
+    return (void *)xQueueCreate(queue_len, item_size);
+}
+
+static void queue_delete_wrapper(void *queue)
+{
+    vQueueDelete(queue);
+}
+
+static bool queue_send_wrapper(void *queue, void *item, uint32_t block_time_tick, uint32_t pos)
+{
+    signed portBASE_TYPE ret;
+
+    if (block_time_tick == OSI_FUNCS_TIME_BLOCKING) {
+        ret = xQueueGenericSend(queue, item, portMAX_DELAY, pos);
+    } else {
+        ret = xQueueGenericSend(queue, item, block_time_tick, pos);
+    }
+
+    return ret == pdPASS ? true : false;
+}
+
+static bool queue_send_from_isr_wrapper(void *queue, void *item, int *hptw)
+{
+    signed portBASE_TYPE ret;
+
+    ret = xQueueSendFromISR(queue, item, (signed portBASE_TYPE *)hptw);
+
+    return ret == pdPASS ? true : false;
+}
+
+static bool queue_recv_wrapper(void *queue, void *item, uint32_t block_time_tick)
+{
+    signed portBASE_TYPE ret;
+
+    if (block_time_tick == OSI_FUNCS_TIME_BLOCKING) {
+        ret = xQueueReceive(queue, item, portMAX_DELAY);
+    } else {
+        ret = xQueueReceive(queue, item, block_time_tick);
+    }
+
+    return ret == pdPASS ? true : false;
+}
+
+static bool queue_recv_from_isr_wrapper(void *queue, void *item, int *hptw)
+{
+    signed portBASE_TYPE ret;
+
+    ret = xQueueReceiveFromISR(queue, item, (signed portBASE_TYPE *)hptw);
+
+    return ret == pdPASS ? true : false;
+}
+
+static uint32_t queue_msg_waiting_wrapper(void *queue)
+{
+    return (uint32_t)uxQueueMessagesWaiting(queue);
+}
+
+static uint32_t get_free_heap_size_wrapper(void)
+{
+    return (uint32_t)system_get_free_heap_size();
+}
+
+static void *timer_create_wrapper(const char *name, uint32_t period_ticks, bool auto_load, void *arg, void (*cb)(void *timer))
+{
+    return xTimerCreate((const signed char *)name, period_ticks, auto_load, arg, (tmrTIMER_CALLBACK)cb);
+}
+
+static void *timer_get_arg_wrapper(void *timer)
+{
+    return pvTimerGetTimerID(timer);
+}
+
+static bool timer_reset_wrapper(void *timer, uint32_t ticks)
+{
+    return xTimerReset(timer, ticks);
+}
+
+static bool timer_stop_wrapper(void *timer, uint32_t ticks)
+{
+    return xTimerStop(timer, ticks);
+}
+
+static bool timer_delete_wrapper(void *timer, uint32_t ticks)
+{
+    return xTimerDelete(timer, ticks);
+}
+
+static void srand_wrapper(uint32_t seed)
+{
+    /* empty function */
+}
+
+static int32_t rand_wrapper(void)
+{
+    return (int32_t)os_random();
+}
+
+wifi_osi_funcs_t g_wifi_osi_funcs = {
+    .enter_critical = enter_critical_wrapper,
+    .exit_critical = exit_critical_wrapper,
+    
+    .task_create = task_create_wrapper,
+    .task_delete = task_delete_wrapper,
+    .task_yield = task_yield_wrapper,
+    .task_yield_from_isr = task_yield_from_isr_wrapper,
+    .task_delay = task_delay_wrapper,
+    .task_get_current_task = task_get_current_task_wrapper,
+    .task_get_max_priority = task_get_max_priority_wrapper,
+    
+    .task_ms_to_tick = task_ms_to_tick_wrapper,
+
+    .task_suspend_all = task_suspend_all_wrapper,
+    .task_resume_all = task_resume_all_wrapper,
+
+    .os_init = os_init_wrapper,
+    .os_start = os_start_wrapper,
+    
+    .semphr_create = semphr_create_wrapper,
+    .semphr_delete = semphr_delete_wrapper,
+    .semphr_take_from_isr = semphr_take_from_isr_wrapper,
+    .semphr_give_from_isr = semphr_give_from_isr_wrapper,
+    .semphr_take = semphr_take_wrapper,
+    .semphr_give = semphr_give_wrapper,
+    
+    .mutex_create = mutex_create_wrapper,
+    .mutex_delete = mutex_delete_wrapper,
+    .mutex_lock = mutex_lock_wrapper,
+    .mutex_unlock = mutex_unlock_wrapper,
+    
+    .queue_create = queue_create_wrapper,
+    .queue_delete = queue_delete_wrapper,
+    .queue_send = queue_send_wrapper,
+    .queue_send_from_isr = queue_send_from_isr_wrapper,
+    .queue_recv = queue_recv_wrapper,
+    .queue_recv_from_isr = queue_recv_from_isr_wrapper,
+    .queue_msg_waiting = queue_msg_waiting_wrapper,
+
+    .timer_create = timer_create_wrapper,
+    .timer_get_arg = timer_get_arg_wrapper,
+    .timer_reset = timer_reset_wrapper,
+    .timer_stop = timer_stop_wrapper,
+    .timer_delete = timer_delete_wrapper,
+
+    .malloc = malloc,
+    .free = free,
+    .get_free_heap_size = get_free_heap_size_wrapper,
+
+    .srand = srand_wrapper,
+    .rand = rand_wrapper,
+};