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