1 // Copyright 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 // 7 // http://www.apache.org/licenses/LICENSE-2.0 8 // 9 // Unless required by applicable law or agreed to in writing, software 10 // distributed under the License is distributed on an "AS IS" BASIS, 11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 // See the License for the specific language governing permissions and 13 // limitations under the License. 14 15 #ifndef ESP_WIFI_OS_ADAPTER_H_ 16 #define ESP_WIFI_OS_ADAPTER_H_ 17 18 #include <stdarg.h> 19 20 #ifdef __cplusplus 21 extern "C" { 22 #endif 23 24 #define ESP_WIFI_OS_ADAPTER_VERSION 0x00000008 25 #define ESP_WIFI_OS_ADAPTER_MAGIC 0xDEADBEAF 26 27 #define OSI_FUNCS_TIME_BLOCKING 0xffffffff 28 29 #define OSI_QUEUE_SEND_FRONT 0 30 #define OSI_QUEUE_SEND_BACK 1 31 #define OSI_QUEUE_SEND_OVERWRITE 2 32 33 typedef struct { 34 int32_t _version; 35 bool (* _env_is_chip)(void); 36 void (*_set_intr)(int32_t cpu_no, uint32_t intr_source, uint32_t intr_num, int32_t intr_prio); 37 void (*_clear_intr)(uint32_t intr_source, uint32_t intr_num); 38 void (*_set_isr)(int32_t n, void *f, void *arg); 39 void (*_ints_on)(uint32_t mask); 40 void (*_ints_off)(uint32_t mask); 41 bool (* _is_from_isr)(void); 42 void *(* _spin_lock_create)(void); 43 void (* _spin_lock_delete)(void *lock); 44 uint32_t (*_wifi_int_disable)(void *wifi_int_mux); 45 void (*_wifi_int_restore)(void *wifi_int_mux, uint32_t tmp); 46 void (*_task_yield_from_isr)(void); 47 void *(*_semphr_create)(uint32_t max, uint32_t init); 48 void (*_semphr_delete)(void *semphr); 49 int32_t (*_semphr_take)(void *semphr, uint32_t block_time_tick); 50 int32_t (*_semphr_give)(void *semphr); 51 void *(*_wifi_thread_semphr_get)(void); 52 void *(*_mutex_create)(void); 53 void *(*_recursive_mutex_create)(void); 54 void (*_mutex_delete)(void *mutex); 55 int32_t (*_mutex_lock)(void *mutex); 56 int32_t (*_mutex_unlock)(void *mutex); 57 void *(* _queue_create)(uint32_t queue_len, uint32_t item_size); 58 void (* _queue_delete)(void *queue); 59 int32_t (* _queue_send)(void *queue, void *item, uint32_t block_time_tick); 60 int32_t (* _queue_send_from_isr)(void *queue, void *item, void *hptw); 61 int32_t (* _queue_send_to_back)(void *queue, void *item, uint32_t block_time_tick); 62 int32_t (* _queue_send_to_front)(void *queue, void *item, uint32_t block_time_tick); 63 int32_t (* _queue_recv)(void *queue, void *item, uint32_t block_time_tick); 64 uint32_t (* _queue_msg_waiting)(void *queue); 65 void *(* _event_group_create)(void); 66 void (* _event_group_delete)(void *event); 67 uint32_t (* _event_group_set_bits)(void *event, uint32_t bits); 68 uint32_t (* _event_group_clear_bits)(void *event, uint32_t bits); 69 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); 70 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); 71 int32_t (* _task_create)(void *task_func, const char *name, uint32_t stack_depth, void *param, uint32_t prio, void *task_handle); 72 void (* _task_delete)(void *task_handle); 73 void (* _task_delay)(uint32_t tick); 74 int32_t (* _task_ms_to_tick)(uint32_t ms); 75 void *(* _task_get_current_task)(void); 76 int32_t (* _task_get_max_priority)(void); 77 void *(* _malloc)(unsigned int size); 78 void (* _free)(void *p); 79 int32_t (* _event_post)(const char* event_base, int32_t event_id, void* event_data, size_t event_data_size, uint32_t ticks_to_wait); 80 uint32_t (* _get_free_heap_size)(void); 81 uint32_t (* _rand)(void); 82 void (* _dport_access_stall_other_cpu_start_wrap)(void); 83 void (* _dport_access_stall_other_cpu_end_wrap)(void); 84 void (* _wifi_apb80m_request)(void); 85 void (* _wifi_apb80m_release)(void); 86 void (* _phy_disable)(void); 87 void (* _phy_enable)(void); 88 #if CONFIG_IDF_TARGET_ESP32 89 void (* _phy_common_clock_enable)(void); 90 void (* _phy_common_clock_disable)(void); 91 #endif 92 int (* _phy_update_country_info)(const char* country); 93 int (* _read_mac)(uint8_t* mac, uint32_t type); 94 void (* _timer_arm)(void *timer, uint32_t tmout, bool repeat); 95 void (* _timer_disarm)(void *timer); 96 void (* _timer_done)(void *ptimer); 97 void (* _timer_setfn)(void *ptimer, void *pfunction, void *parg); 98 void (* _timer_arm_us)(void *ptimer, uint32_t us, bool repeat); 99 void (* _wifi_reset_mac)(void); 100 void (* _wifi_clock_enable)(void); 101 void (* _wifi_clock_disable)(void); 102 void (* _wifi_rtc_enable_iso)(void); 103 void (* _wifi_rtc_disable_iso)(void); 104 int64_t (* _esp_timer_get_time)(void); 105 int (* _nvs_set_i8)(uint32_t handle, const char* key, int8_t value); 106 int (* _nvs_get_i8)(uint32_t handle, const char* key, int8_t* out_value); 107 int (* _nvs_set_u8)(uint32_t handle, const char* key, uint8_t value); 108 int (* _nvs_get_u8)(uint32_t handle, const char* key, uint8_t* out_value); 109 int (* _nvs_set_u16)(uint32_t handle, const char* key, uint16_t value); 110 int (* _nvs_get_u16)(uint32_t handle, const char* key, uint16_t* out_value); 111 int (* _nvs_open)(const char* name, uint32_t open_mode, uint32_t *out_handle); 112 void (* _nvs_close)(uint32_t handle); 113 int (* _nvs_commit)(uint32_t handle); 114 int (* _nvs_set_blob)(uint32_t handle, const char* key, const void* value, size_t length); 115 int (* _nvs_get_blob)(uint32_t handle, const char* key, void* out_value, size_t* length); 116 int (* _nvs_erase_key)(uint32_t handle, const char* key); 117 int (* _get_random)(uint8_t *buf, size_t len); 118 int (* _get_time)(void *t); 119 unsigned long (* _random)(void); 120 #if CONFIG_IDF_TARGET_ESP32S2 || CONFIG_IDF_TARGET_ESP32S3 || CONFIG_IDF_TARGET_ESP32C3 121 uint32_t (* _slowclk_cal_get)(void); 122 #endif 123 void (* _log_write)(uint32_t level, const char* tag, const char* format, ...); 124 void (* _log_writev)(uint32_t level, const char* tag, const char* format, va_list args); 125 uint32_t (* _log_timestamp)(void); 126 void * (* _malloc_internal)(size_t size); 127 void * (* _realloc_internal)(void *ptr, size_t size); 128 void * (* _calloc_internal)(size_t n, size_t size); 129 void * (* _zalloc_internal)(size_t size); 130 void * (* _wifi_malloc)(size_t size); 131 void * (* _wifi_realloc)(void *ptr, size_t size); 132 void * (* _wifi_calloc)(size_t n, size_t size); 133 void * (* _wifi_zalloc)(size_t size); 134 void * (* _wifi_create_queue)(int queue_len, int item_size); 135 void (* _wifi_delete_queue)(void * queue); 136 int (* _coex_init)(void); 137 void (* _coex_deinit)(void); 138 int (* _coex_enable)(void); 139 void (* _coex_disable)(void); 140 uint32_t (* _coex_status_get)(void); 141 void (* _coex_condition_set)(uint32_t type, bool dissatisfy); 142 int (* _coex_wifi_request)(uint32_t event, uint32_t latency, uint32_t duration); 143 int (* _coex_wifi_release)(uint32_t event); 144 int (* _coex_wifi_channel_set)(uint8_t primary, uint8_t secondary); 145 int (* _coex_event_duration_get)(uint32_t event, uint32_t *duration); 146 int (* _coex_pti_get)(uint32_t event, uint8_t *pti); 147 void (* _coex_schm_status_bit_clear)(uint32_t type, uint32_t status); 148 void (* _coex_schm_status_bit_set)(uint32_t type, uint32_t status); 149 int (* _coex_schm_interval_set)(uint32_t interval); 150 uint32_t (* _coex_schm_interval_get)(void); 151 uint8_t (* _coex_schm_curr_period_get)(void); 152 void * (* _coex_schm_curr_phase_get)(void); 153 int (* _coex_schm_curr_phase_idx_set)(int idx); 154 int (* _coex_schm_curr_phase_idx_get)(void); 155 int32_t _magic; 156 } wifi_osi_funcs_t; 157 158 extern wifi_osi_funcs_t g_wifi_osi_funcs; 159 160 #ifdef __cplusplus 161 } 162 #endif 163 164 #endif /* ESP_WIFI_OS_ADAPTER_H_ */ 165