1 /* 2 // Copyright 2015-2016 Espressif Systems (Shanghai) PTE LTD 3 // 4 // Licensed under the Apache License, Version 2.0 (the "License"); 5 // you may not use this file except in compliance with the License. 6 // You may obtain a copy of the License at 7 8 // http://www.apache.org/licenses/LICENSE-2.0 9 // 10 // Unless required by applicable law or agreed to in writing, software 11 // distributed under the License is distributed on an "AS IS" BASIS, 12 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 // See the License for the specific language governing permissions and 14 // limitations under the License. 15 */ 16 #ifndef __BLUFI_INT_H__ 17 #define __BLUFI_INT_H__ 18 19 #include "btc/btc_task.h" 20 #include "esp_blufi_api.h" 21 #if (BLUFI_INCLUDED == 1) 22 23 #define BTC_BLUFI_GREAT_VER 0x01 //Version + Subversion 24 #define BTC_BLUFI_SUB_VER 0x02 //Version + Subversion 25 #define BTC_BLUFI_VERSION ((BTC_BLUFI_GREAT_VER<<8)|BTC_BLUFI_SUB_VER) //Version + Subversion 26 27 typedef UINT8 tGATT_IF; 28 /* service engine control block */ 29 typedef struct { 30 /* Protocol reference */ 31 tGATT_IF gatt_if; 32 UINT8 srvc_inst; 33 UINT16 handle_srvc; 34 UINT16 handle_char_p2e; 35 UINT16 handle_char_e2p; 36 UINT16 handle_descr_e2p; 37 UINT16 conn_id; 38 BOOLEAN is_connected; 39 BD_ADDR remote_bda; 40 UINT32 trans_id; 41 UINT8 congest; 42 UINT16 frag_size; 43 #define BLUFI_PREPAIR_BUF_MAX_SIZE 1024 44 uint8_t *prepare_buf; 45 int prepare_len; 46 /* Control reference */ 47 esp_blufi_callbacks_t *cbs; 48 BOOLEAN enabled; 49 uint8_t send_seq; 50 uint8_t recv_seq; 51 uint8_t sec_mode; 52 uint8_t *aggr_buf; 53 uint16_t total_len; 54 uint16_t offset; 55 } tBLUFI_ENV; 56 57 /* BLUFI protocol */ 58 struct blufi_hdr{ 59 uint8_t type; 60 uint8_t fc; 61 uint8_t seq; 62 uint8_t data_len; 63 uint8_t data[0]; 64 }; 65 typedef struct blufi_hdr blufi_hd_t; 66 67 struct blufi_frag_hdr { 68 uint8_t type; 69 uint8_t fc; 70 uint8_t seq; 71 uint8_t data_len; 72 uint16_t total_len; 73 uint8_t content[0]; 74 }; 75 typedef struct blufi_frag_hdr blufi_frag_hdr_t; 76 77 #if GATT_DYNAMIC_MEMORY == 0 78 extern tBLUFI_ENV blufi_env; 79 #else 80 extern tBLUFI_ENV *blufi_env_ptr; 81 #define blufi_env (*blufi_env_ptr) 82 #endif 83 84 #define BLUFI_DATA_SEC_MODE_CHECK_MASK 0x01 85 #define BLUFI_DATA_SEC_MODE_ENC_MASK 0x02 86 #define BLUFI_CTRL_SEC_MODE_CHECK_MASK 0x10 87 #define BLUFI_CTRL_SEC_MODE_ENC_MASK 0x20 88 #define BLUFI_MAX_DATA_LEN 255 89 90 // packet type 91 #define BLUFI_TYPE_MASK 0x03 92 #define BLUFI_TYPE_SHIFT 0 93 #define BLUFI_SUBTYPE_MASK 0xFC 94 #define BLUFI_SUBTYPE_SHIFT 2 95 96 #define BLUFI_GET_TYPE(type) ((type) & BLUFI_TYPE_MASK) 97 #define BLUFI_GET_SUBTYPE(type) (((type) & BLUFI_SUBTYPE_MASK) >>BLUFI_SUBTYPE_SHIFT) 98 #define BLUFI_BUILD_TYPE(type, subtype) (((type) & BLUFI_TYPE_MASK) | ((subtype)<<BLUFI_SUBTYPE_SHIFT)) 99 100 #define BLUFI_TYPE_CTRL 0x0 101 #define BLUFI_TYPE_CTRL_SUBTYPE_ACK 0x00 102 #define BLUFI_TYPE_CTRL_SUBTYPE_SET_SEC_MODE 0x01 103 #define BLUFI_TYPE_CTRL_SUBTYPE_SET_WIFI_OPMODE 0x02 104 #define BLUFI_TYPE_CTRL_SUBTYPE_CONN_TO_AP 0x03 105 #define BLUFI_TYPE_CTRL_SUBTYPE_DISCONN_FROM_AP 0x04 106 #define BLUFI_TYPE_CTRL_SUBTYPE_GET_WIFI_STATUS 0x05 107 #define BLUFI_TYPE_CTRL_SUBTYPE_DEAUTHENTICATE_STA 0x06 108 #define BLUFI_TYPE_CTRL_SUBTYPE_GET_VERSION 0x07 109 #define BLUFI_TYPE_CTRL_SUBTYPE_DISCONNECT_BLE 0x08 110 #define BLUFI_TYPE_CTRL_SUBTYPE_GET_WIFI_LIST 0x09 111 112 #define BLUFI_TYPE_DATA 0x1 113 #define BLUFI_TYPE_DATA_SUBTYPE_NEG 0x00 114 #define BLUFI_TYPE_DATA_SUBTYPE_STA_BSSID 0x01 115 #define BLUFI_TYPE_DATA_SUBTYPE_STA_SSID 0x02 116 #define BLUFI_TYPE_DATA_SUBTYPE_STA_PASSWD 0x03 117 #define BLUFI_TYPE_DATA_SUBTYPE_SOFTAP_SSID 0x04 118 #define BLUFI_TYPE_DATA_SUBTYPE_SOFTAP_PASSWD 0x05 119 #define BLUFI_TYPE_DATA_SUBTYPE_SOFTAP_MAX_CONN_NUM 0x06 120 #define BLUFI_TYPE_DATA_SUBTYPE_SOFTAP_AUTH_MODE 0x07 121 #define BLUFI_TYPE_DATA_SUBTYPE_SOFTAP_CHANNEL 0x08 122 #define BLUFI_TYPE_DATA_SUBTYPE_USERNAME 0x09 123 #define BLUFI_TYPE_DATA_SUBTYPE_CA 0x0a 124 #define BLUFI_TYPE_DATA_SUBTYPE_CLIENT_CERT 0x0b 125 #define BLUFI_TYPE_DATA_SUBTYPE_SERVER_CERT 0x0c 126 #define BLUFI_TYPE_DATA_SUBTYPE_CLIENT_PRIV_KEY 0x0d 127 #define BLUFI_TYPE_DATA_SUBTYPE_SERVER_PRIV_KEY 0x0e 128 #define BLUFI_TYPE_DATA_SUBTYPE_WIFI_REP 0x0f 129 #define BLUFI_TYPE_DATA_SUBTYPE_REPLY_VERSION 0x10 130 #define BLUFI_TYPE_DATA_SUBTYPE_WIFI_LIST 0x11 131 #define BLUFI_TYPE_DATA_SUBTYPE_ERROR_INFO 0x12 132 #define BLUFI_TYPE_DATA_SUBTYPE_CUSTOM_DATA 0x13 133 #define BLUFI_TYPE_IS_CTRL(type) (BLUFI_GET_TYPE((type)) == BLUFI_TYPE_CTRL) 134 #define BLUFI_TYPE_IS_DATA(type) (BLUFI_GET_TYPE((type)) == BLUFI_TYPE_DATA) 135 136 #define BLUFI_TYPE_IS_CTRL_ACK(type) (BLUFI_TYPE_IS_CTRL((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_CTRL_SUBTYPE_ACK) 137 #define BLUFI_TYPE_IS_CTRL_START_NEG(type) (BLUFI_TYPE_IS_CTRL((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_CTRL_SUBTYPE_START_NEG) 138 #define BLUFI_TYPE_IS_CTRL_STOP_NEG(type) (BLUFI_TYPE_IS_CTRL((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_CTRL_SUBTYPE_STOP_NEG) 139 #define BLUFI_TYPE_IS_CTRL_SET_WIFI_OPMODE(type) (BLUFI_TYPE_IS_CTRL((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_CTRL_SUBTYPE_SET_WIFI_OPMODE) 140 #define BLUFI_TYPE_IS_CTRL_CONN_WIFI(type) (BLUFI_TYPE_IS_CTRL((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_CTRL_SUBTYPE_CONN_TO_AP) 141 #define BLUFI_TYPE_IS_CTRL_DISCONN_WIFI(type) (BLUFI_TYPE_IS_CTRL((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_CTRL_SUBTYPE_DISCONN_FROM_AP) 142 #define BLUFI_TYPE_IS_CTRL_GET_WIFI_STATUS(type) (BLUFI_TYPE_IS_CTRL((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_CTRL_SUBTYPE_GET_WIFI_STATUS) 143 #define BLUFI_TYPE_IS_CTRL_DEAUTHENTICATE_STA(type) (BLUFI_TYPE_IS_CTRL((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_CTRL_SUBTYPE_DEAUTHENTICATE_STA) 144 #define BLUFI_TYPE_IS_CTRL_GET_VERSION(type) (BLUFI_TYPE_IS_CTRL((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_CTRL_SUBTYPE_GET_VERSION) 145 146 #define BLUFI_TYPE_IS_DATA_NEG(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_NEG) 147 #define BLUFI_TYPE_IS_DATA_STA_BSSID(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_STA_BSSID) 148 #define BLUFI_TYPE_IS_DATA_STA_SSID(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_STA_SSID) 149 #define BLUFI_TYPE_IS_DATA_STA_PASSWD(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_STA_PASSWD) 150 #define BLUFI_TYPE_IS_DATA_SOFTAP_SSID(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_SOFTAP_SSID) 151 #define BLUFI_TYPE_IS_DATA_SOFTAP_PASSWD(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_SOFTAP_PASSWD) 152 #define BLUFI_TYPE_IS_DATA_SOFTAP_MAX_CONN_NUM(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_SOFTAP_MAX_CONN_NUM) 153 #define BLUFI_TYPE_IS_DATA_SOFTAP_AUTH_MODE(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_SOFTAP_AUTH_MODE) 154 #define BLUFI_TYPE_IS_DATA_SOFTAP_CHANNEL(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_SOFTAP_CHANNEL) 155 #define BLUFI_TYPE_IS_DATA_USERNAME(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_USERNAME) 156 #define BLUFI_TYPE_IS_DATA_CA(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_CA) 157 #define BLUFI_TYPE_IS_DATA_CLEINT_CERT(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_CLIENT_CERT) 158 #define BLUFI_TYPE_IS_DATA_SERVER_CERT(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_SERVER_CERT) 159 #define BLUFI_TYPE_IS_DATA_CLIENT_PRIV_KEY(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_CLIENT_PRIV_KEY) 160 #define BLUFI_TYPE_IS_DATA_SERVER_PRIV_KEY(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_SERVER_PRIV_KEY) 161 #define BLUFI_TYPE_IS_DATA_ERROR_INFO(type) (BLUFI_TYPE_IS_DATA((type)) && BLUFI_GET_SUBTYPE((type)) == BLUFI_TYPE_DATA_SUBTYPE_ERROR_INFO) 162 163 // packet frame control 164 #define BLUFI_FC_ENC_MASK 0x01 165 #define BLUFI_FC_CHECK_MASK 0x02 166 #define BLUFI_FC_DIR_MASK 0x04 167 #define BLUFI_FC_REQ_ACK_MASK 0x08 168 #define BLUFI_FC_FRAG_MASK 0x10 169 170 #define BLUFI_FC_ENC 0x01 171 #define BLUFI_FC_CHECK 0x02 172 #define BLUFI_FC_DIR_P2E 0x00 173 #define BLUFI_FC_DIR_E2P 0x04 174 #define BLUFI_FC_REQ_ACK 0x08 175 #define BLUFI_FC_FRAG 0x10 176 177 #define BLUFI_FC_IS_ENC(fc) ((fc) & BLUFI_FC_ENC_MASK) 178 #define BLUFI_FC_IS_CHECK(fc) ((fc) & BLUFI_FC_CHECK_MASK) 179 #define BLUFI_FC_IS_DIR_P2E(fc) ((fc) & BLUFI_FC_DIR_P2E_MASK) 180 #define BLUFI_FC_IS_DIR_E2P(fc) (!((fc) & BLUFI_DIR_P2E_MASK)) 181 #define BLUFI_FC_IS_REQ_ACK(fc) ((fc) & BLUFI_FC_REQ_ACK_MASK) 182 #define BLUFI_FC_IS_FRAG(fc) ((fc) & BLUFI_FC_FRAG_MASK) 183 184 /* default GATT MTU size over LE link 185 */ 186 #define GATT_DEF_BLE_MTU_SIZE 23 187 /* BLUFI HEADER + TOTAL(REMAIN) LENGTH + CRC + L2CAP RESERVED */ 188 #define BLUFI_MTU_RESERVED_SIZE (sizeof(struct blufi_hdr) + 2 + 2 + 3) 189 #define BLUFI_FRAG_DATA_DEFAULT_LEN (GATT_DEF_BLE_MTU_SIZE - BLUFI_MTU_RESERVED_SIZE) 190 191 //function declare 192 void btc_blufi_protocol_handler(uint8_t type, uint8_t *data, int len); 193 194 void btc_blufi_send_encap(uint8_t type, uint8_t *data, int data_len); 195 196 void btc_blufi_set_callbacks(esp_blufi_callbacks_t *callbacks); 197 198 void btc_blufi_cb_deep_copy(btc_msg_t *msg, void *p_dest, void *p_src); 199 200 void btc_blufi_cb_deep_free(btc_msg_t *msg); 201 202 #endif /* __BLUFI_INT_H__ */ 203 #endif ///BLUFI_INCLUDED == 1 204