1 /* 2 * Copyright (C) 2014 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN 24 * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 /** 39 * @title L2CAP 40 * 41 * Logical Link Control and Adaption Protocol 42 * 43 */ 44 45 #ifndef L2CAP_H 46 #define L2CAP_H 47 48 #include "hci.h" 49 #include "l2cap_signaling.h" 50 #include "btstack_util.h" 51 #include "bluetooth.h" 52 53 #if defined __cplusplus 54 extern "C" { 55 #endif 56 57 // check L2CAP MTU 58 #ifdef ENABLE_CLASSIC 59 #if (L2CAP_HEADER_SIZE + L2CAP_MINIMAL_MTU) > HCI_ACL_PAYLOAD_SIZE 60 #error "HCI_ACL_PAYLOAD_SIZE too small for minimal L2CAP MTU of 48 bytes" 61 #endif 62 #endif 63 #ifdef ENABLE_BLE 64 #if (L2CAP_HEADER_SIZE + L2CAP_LE_DEFAULT_MTU) > HCI_ACL_PAYLOAD_SIZE 65 #error "HCI_ACL_PAYLOAD_SIZE too small for minimal L2CAP LE MTU of 23 bytes" 66 #endif 67 #endif 68 69 #define L2CAP_LE_AUTOMATIC_CREDITS 0xffff 70 71 // private structs 72 typedef enum { 73 L2CAP_STATE_CLOSED = 1, // no baseband 74 L2CAP_STATE_WILL_SEND_CREATE_CONNECTION, 75 L2CAP_STATE_WAIT_CONNECTION_COMPLETE, 76 L2CAP_STATE_WAIT_REMOTE_SUPPORTED_FEATURES, 77 L2CAP_STATE_WAIT_INCOMING_SECURITY_LEVEL_UPDATE, 78 L2CAP_STATE_WAIT_OUTGOING_SECURITY_LEVEL_UPDATE, 79 L2CAP_STATE_WAIT_INCOMING_EXTENDED_FEATURES, // only for Enhanced Retransmission Mode 80 L2CAP_STATE_WAIT_OUTGOING_EXTENDED_FEATURES, // only for Enhanced Retransmission Mode 81 L2CAP_STATE_WAIT_CLIENT_ACCEPT_OR_REJECT, 82 L2CAP_STATE_WAIT_CONNECT_RSP, // from peer 83 L2CAP_STATE_CONFIG, 84 L2CAP_STATE_OPEN, 85 L2CAP_STATE_WAIT_DISCONNECT, // from application 86 L2CAP_STATE_WILL_SEND_CONNECTION_REQUEST, 87 L2CAP_STATE_WILL_SEND_CONNECTION_RESPONSE_INSUFFICIENT_SECURITY, 88 L2CAP_STATE_WILL_SEND_CONNECTION_RESPONSE_DECLINE, 89 L2CAP_STATE_WILL_SEND_CONNECTION_RESPONSE_ACCEPT, 90 L2CAP_STATE_WILL_SEND_DISCONNECT_REQUEST, 91 L2CAP_STATE_WILL_SEND_DISCONNECT_RESPONSE, 92 L2CAP_STATE_WILL_SEND_LE_CONNECTION_REQUEST, 93 L2CAP_STATE_WILL_SEND_LE_CONNECTION_RESPONSE_DECLINE, 94 L2CAP_STATE_WILL_SEND_LE_CONNECTION_RESPONSE_ACCEPT, 95 L2CAP_STATE_WAIT_LE_CONNECTION_RESPONSE, 96 L2CAP_STATE_EMIT_OPEN_FAILED_AND_DISCARD, 97 L2CAP_STATE_WILL_SEND_ENHANCED_CONNECTION_REQUEST, 98 L2CAP_STATE_WAIT_ENHANCED_CONNECTION_RESPONSE, 99 L2CAP_STATE_WILL_SEND_ENHANCED_CONNECTION_RESPONSE, 100 L2CAP_STATE_WILL_SEND_EHNANCED_RENEGOTIATION_REQUEST, 101 L2CAP_STATE_WAIT_ENHANCED_RENEGOTIATION_RESPONSE, 102 L2CAP_STATE_INVALID, 103 } L2CAP_STATE; 104 105 #define L2CAP_CHANNEL_STATE_VAR_NONE 0 106 #define L2CAP_CHANNEL_STATE_VAR_RCVD_CONF_REQ 1 << 0 107 #define L2CAP_CHANNEL_STATE_VAR_RCVD_CONF_RSP 1 << 1 108 #define L2CAP_CHANNEL_STATE_VAR_SEND_CONF_REQ 1 << 2 109 #define L2CAP_CHANNEL_STATE_VAR_SEND_CONF_RSP 1 << 3 110 #define L2CAP_CHANNEL_STATE_VAR_SENT_CONF_REQ 1 << 4 111 #define L2CAP_CHANNEL_STATE_VAR_SENT_CONF_RSP 1 << 5 112 #define L2CAP_CHANNEL_STATE_VAR_SEND_CONF_RSP_MTU 1 << 6 // in CONF RSP, add MTU option 113 #define L2CAP_CHANNEL_STATE_VAR_SEND_CONF_RSP_ERTM 1 << 7 // in CONF RSP, add Retransmission and Flowcontrol option 114 #define L2CAP_CHANNEL_STATE_VAR_SEND_CONF_RSP_CONT 1 << 8 // in CONF RSP, set CONTINUE flag 115 #define L2CAP_CHANNEL_STATE_VAR_SEND_CONF_RSP_INVALID 1 << 9 // in CONF RSP, send UNKNOWN OPTIONS 116 #define L2CAP_CHANNEL_STATE_VAR_SEND_CONF_RSP_REJECTED 1 << 10 // in CONF RSP, send Unacceptable Parameters (ERTM) 117 #define L2CAP_CHANNEL_STATE_VAR_BASIC_FALLBACK_TRIED 1 << 11 // set when ERTM was requested but we want only Basic mode (ERM) 118 #define L2CAP_CHANNEL_STATE_VAR_SEND_CONN_RESP_PEND 1 << 12 // send Connection Respond with pending 119 #define L2CAP_CHANNEL_STATE_VAR_SENT_CONN_RESP_PEND 1 << 13 // send CMD_REJ with reason unknown 120 #define L2CAP_CHANNEL_STATE_VAR_INCOMING 1 << 15 // channel is incoming 121 122 123 typedef enum { 124 L2CAP_CHANNEL_TYPE_CLASSIC, // Classic Basic or ERTM 125 L2CAP_CHANNEL_TYPE_CONNECTIONLESS, // Classic Connectionless 126 L2CAP_CHANNEL_TYPE_CHANNEL_CBM, // LE 127 L2CAP_CHANNEL_TYPE_FIXED, // LE ATT + SM, Classic SM 128 L2CAP_CHANNEL_TYPE_CHANNEL_ECBM // Classic + LE 129 } l2cap_channel_type_t; 130 131 132 /* 133 * @brief L2CAP Segmentation And Reassembly packet type in I-Frames 134 */ 135 typedef enum { 136 L2CAP_SEGMENTATION_AND_REASSEMBLY_UNSEGMENTED_L2CAP_SDU = 0, 137 L2CAP_SEGMENTATION_AND_REASSEMBLY_START_OF_L2CAP_SDU, 138 L2CAP_SEGMENTATION_AND_REASSEMBLY_END_OF_L2CAP_SDU, 139 L2CAP_SEGMENTATION_AND_REASSEMBLY_CONTINUATION_OF_L2CAP_SDU 140 } l2cap_segmentation_and_reassembly_t; 141 142 typedef struct { 143 l2cap_segmentation_and_reassembly_t sar; 144 uint16_t len; 145 uint8_t valid; 146 } l2cap_ertm_rx_packet_state_t; 147 148 typedef struct { 149 l2cap_segmentation_and_reassembly_t sar; 150 uint16_t len; 151 uint8_t tx_seq; 152 uint8_t retry_count; 153 uint8_t retransmission_requested; 154 } l2cap_ertm_tx_packet_state_t; 155 156 typedef struct { 157 // If not mandatory, the use of ERTM can be decided by the remote 158 uint8_t ertm_mandatory; 159 160 // Number of retransmissions that L2CAP is allowed to try before accepting that a packet and the channel is lost. 161 uint8_t max_transmit; 162 163 // time before retransmission of i-frame / Recommended : 2000 ms (ACL Flush timeout not used) 164 uint16_t retransmission_timeout_ms; 165 166 // time after withc s-frames are sent / Recommended: 12000 ms (ACL Flush timeout not used) 167 uint16_t monitor_timeout_ms; 168 169 // MTU for incoming SDUs 170 uint16_t local_mtu; 171 172 // Number of buffers for outgoing data 173 uint8_t num_tx_buffers; 174 175 // Number of packets that can be received out of order (-> our tx_window size) 176 uint8_t num_rx_buffers; 177 178 // Frame Check Sequence (FCS) Option 179 uint8_t fcs_option; 180 181 } l2cap_ertm_config_t; 182 183 // info regarding an actual channel 184 // note: l2cap_fixed_channel and l2cap_channel_t share commmon fields 185 186 typedef struct l2cap_fixed_channel { 187 // linked list - assert: first field 188 btstack_linked_item_t item; 189 190 // channel type 191 l2cap_channel_type_t channel_type; 192 193 // local cid, primary key for channel lookup 194 uint16_t local_cid; 195 196 // packet handler 197 btstack_packet_handler_t packet_handler; 198 199 // send request 200 uint8_t waiting_for_can_send_now; 201 202 // -- end of shared prefix 203 204 } l2cap_fixed_channel_t; 205 206 typedef struct { 207 // linked list - assert: first field 208 btstack_linked_item_t item; 209 210 // channel type 211 l2cap_channel_type_t channel_type; 212 213 // local cid, primary key for channel lookup 214 uint16_t local_cid; 215 216 // packet handler 217 btstack_packet_handler_t packet_handler; 218 219 // send request 220 uint8_t waiting_for_can_send_now; 221 222 // -- end of shared prefix 223 224 // timer 225 btstack_timer_source_t rtx; // also used for ertx 226 227 L2CAP_STATE state; 228 uint16_t state_var; 229 230 // info 231 hci_con_handle_t con_handle; 232 233 bd_addr_t address; 234 bd_addr_type_t address_type; 235 236 uint8_t remote_sig_id; // used by other side, needed for delayed response 237 uint8_t local_sig_id; // own signaling identifier 238 239 uint16_t remote_cid; 240 241 uint16_t local_mtu; 242 uint16_t remote_mtu; 243 244 uint16_t flush_timeout; // default 0xffff 245 246 uint16_t psm; 247 248 gap_security_level_t required_security_level; 249 250 uint16_t reason; // used in decline internal 251 252 uint8_t unknown_option; // used for ConfigResponse 253 254 // Credit-Based Flow-Control mode 255 256 // incoming SDU 257 uint8_t * receive_sdu_buffer; 258 uint16_t receive_sdu_len; 259 uint16_t receive_sdu_pos; 260 261 #ifdef ENABLE_L2CAP_ENHANCED_CREDIT_BASED_FLOW_CONTROL_MODE 262 uint8_t * renegotiate_sdu_buffer; 263 uint16_t renegotiate_mtu; 264 #endif 265 266 // outgoing SDU 267 const uint8_t * send_sdu_buffer; 268 uint16_t send_sdu_len; 269 uint16_t send_sdu_pos; 270 271 // max PDU size 272 uint16_t remote_mps; 273 274 // credits for outgoing traffic 275 uint16_t credits_outgoing; 276 277 // number of packets remote will be granted 278 uint16_t new_credits_incoming; 279 280 // credits for incoming traffic 281 uint16_t credits_incoming; 282 283 // automatic credits incoming 284 bool automatic_credits; 285 286 #ifdef ENABLE_L2CAP_ENHANCED_CREDIT_BASED_FLOW_CONTROL_MODE 287 uint8_t cid_index; 288 uint8_t num_cids; 289 #endif 290 291 #ifdef ENABLE_L2CAP_ENHANCED_RETRANSMISSION_MODE 292 293 // l2cap channel mode: basic or enhanced retransmission mode 294 l2cap_channel_mode_t mode; 295 296 // local mps = size of rx/tx buffers 297 uint16_t local_mps; 298 299 // retransmission timer 300 btstack_timer_source_t retransmission_timer; 301 302 // monitor timer 303 btstack_timer_source_t monitor_timer; 304 305 // local/remote config options 306 uint16_t local_retransmission_timeout_ms; 307 uint16_t local_monitor_timeout_ms; 308 309 uint16_t remote_retransmission_timeout_ms; 310 uint16_t remote_monitor_timeout_ms; 311 312 uint8_t remote_tx_window_size; 313 314 uint8_t local_max_transmit; 315 uint8_t remote_max_transmit; 316 317 // if ertm is not mandatory, allow fallback to L2CAP Basic Mode - flag 318 uint8_t ertm_mandatory; 319 320 // Frame Chech Sequence (crc16) is present in both directions 321 uint8_t fcs_option; 322 323 // sender: max num of stored outgoing frames 324 uint8_t num_tx_buffers; 325 326 // sender: num stored outgoing frames 327 uint8_t num_stored_tx_frames; 328 329 // sender: number of unacknowledeged I-Frames - frames have been sent, but not acknowledged yet 330 uint8_t unacked_frames; 331 332 // sender: buffer index of oldest packet 333 uint8_t tx_read_index; 334 335 // sender: buffer index to store next tx packet 336 uint8_t tx_write_index; 337 338 // sender: buffer index of packet to send next 339 uint8_t tx_send_index; 340 341 // sender: next seq nr used for sending 342 uint8_t next_tx_seq; 343 344 // sender: selective retransmission requested 345 uint8_t srej_active; 346 347 348 // receiver: max num out-of-order packets // tx_window 349 uint8_t num_rx_buffers; 350 351 // receiver: buffer index of to store packet with delta = 1 352 uint8_t rx_store_index; 353 354 // receiver: value of tx_seq in next expected i-frame 355 uint8_t expected_tx_seq; 356 357 // receiver: request transmission with tx_seq = req_seq and ack up to and including req_seq 358 uint8_t req_seq; 359 360 // receiver: local busy condition 361 uint8_t local_busy; 362 363 // receiver: send RR frame with optional final flag set - flag 364 uint8_t send_supervisor_frame_receiver_ready; 365 366 // receiver: send RR frame with poll bit set 367 uint8_t send_supervisor_frame_receiver_ready_poll; 368 369 // receiver: send RNR frame - flag 370 uint8_t send_supervisor_frame_receiver_not_ready; 371 372 // receiver: send REJ frame - flag 373 uint8_t send_supervisor_frame_reject; 374 375 // receiver: send SREJ frame - flag 376 uint8_t send_supervisor_frame_selective_reject; 377 378 // set final bit after poll packet with poll bit was received 379 uint8_t set_final_bit_after_packet_with_poll_bit_set; 380 381 // receiver: meta data for out-of-order frames 382 l2cap_ertm_rx_packet_state_t * rx_packets_state; 383 384 // sender: retransmission state 385 l2cap_ertm_tx_packet_state_t * tx_packets_state; 386 387 // receiver: reassemly pos 388 uint16_t reassembly_pos; 389 390 // receiver: reassemly sdu length 391 uint16_t reassembly_sdu_length; 392 393 // receiver: eassembly buffer 394 uint8_t * reassembly_buffer; 395 396 // receiver: num_rx_buffers of size local_mps 397 uint8_t * rx_packets_data; 398 399 // sender: num_tx_buffers of size local_mps 400 uint8_t * tx_packets_data; 401 402 #endif 403 } l2cap_channel_t; 404 405 // info regarding potential connections 406 typedef struct { 407 // linked list - assert: first field 408 btstack_linked_item_t item; 409 410 // service id 411 uint16_t psm; 412 413 // max local mtu for basic mode, min remote mtu for enhanced credit-based flow-control mode 414 uint16_t mtu; 415 416 // internal connection 417 btstack_packet_handler_t packet_handler; 418 419 // required security level 420 gap_security_level_t required_security_level; 421 422 } l2cap_service_t; 423 424 425 typedef struct l2cap_signaling_response { 426 hci_con_handle_t handle; 427 uint8_t sig_id; 428 uint8_t code; 429 uint16_t cid; // source cid for CONNECTION REQUEST 430 uint16_t data; // infoType for INFORMATION REQUEST, result for CONNECTION REQUEST and COMMAND UNKNOWN 431 } l2cap_signaling_response_t; 432 433 434 void l2cap_register_fixed_channel(btstack_packet_handler_t packet_handler, uint16_t channel_id); 435 bool l2cap_can_send_fixed_channel_packet_now(hci_con_handle_t con_handle, uint16_t channel_id); 436 void l2cap_request_can_send_fix_channel_now_event(hci_con_handle_t con_handle, uint16_t channel_id); 437 uint8_t l2cap_send_connectionless(hci_con_handle_t con_handle, uint16_t cid, uint8_t *data, uint16_t len); 438 uint8_t l2cap_send_prepared_connectionless(hci_con_handle_t con_handle, uint16_t cid, uint16_t len); 439 440 // PTS Testing 441 int l2cap_send_echo_request(hci_con_handle_t con_handle, uint8_t *data, uint16_t len); 442 void l2cap_require_security_level_2_for_outgoing_sdp(void); 443 444 // Used by RFCOMM - similar to l2cap_can-send_packet_now but does not check if outgoing buffer is reserved 445 bool l2cap_can_send_prepared_packet_now(uint16_t local_cid); 446 447 /* API_START */ 448 449 // 450 // PSM numbers from https://www.bluetooth.com/specifications/assigned-numbers/logical-link-control 451 // 452 #define PSM_SDP BLUETOOTH_PROTOCOL_SDP 453 #define PSM_RFCOMM BLUETOOTH_PROTOCOL_RFCOMM 454 #define PSM_BNEP BLUETOOTH_PROTOCOL_BNEP 455 // @TODO: scrape PSMs Bluetooth SIG site and put in bluetooth_psm.h or bluetooth_l2cap.h 456 #define PSM_HID_CONTROL 0x11 457 #define PSM_HID_INTERRUPT 0x13 458 #define PSM_ATT 0x1f 459 #define PSM_IPSP 0x23 460 461 /** 462 * @brief Set up L2CAP and register L2CAP with HCI layer. 463 */ 464 void l2cap_init(void); 465 466 /** 467 * @brief Add event packet handler for LE Connection Parameter Update events 468 */ 469 void l2cap_add_event_handler(btstack_packet_callback_registration_t * callback_handler); 470 471 /** 472 * @brief Remove event packet handler. 473 */ 474 void l2cap_remove_event_handler(btstack_packet_callback_registration_t * callback_handler); 475 476 /** 477 * @brief Get max MTU for Classic connections based on btstack configuration 478 */ 479 uint16_t l2cap_max_mtu(void); 480 481 /** 482 * @brief Get max MTU for LE connections based on btstack configuration 483 */ 484 uint16_t l2cap_max_le_mtu(void); 485 486 /** 487 * @brief Set the max MTU for LE connections, if not set l2cap_max_mtu() will be used. 488 */ 489 void l2cap_set_max_le_mtu(uint16_t max_mtu); 490 491 /** 492 * @brief Creates L2CAP channel to the PSM of a remote device with baseband address. A new baseband connection will be initiated if necessary. 493 * @param packet_handler 494 * @param address 495 * @param psm 496 * @param mtu 497 * @param local_cid 498 * @return status 499 */ 500 uint8_t l2cap_create_channel(btstack_packet_handler_t packet_handler, bd_addr_t address, uint16_t psm, uint16_t mtu, uint16_t * out_local_cid); 501 502 /** 503 * @brief Disconnects L2CAP channel with given identifier. 504 * @param local_cid 505 * @return status ERROR_CODE_SUCCESS if successful or L2CAP_LOCAL_CID_DOES_NOT_EXIST 506 */ 507 uint8_t l2cap_disconnect(uint16_t local_cid); 508 509 /** 510 * @brief Queries the maximal transfer unit (MTU) for L2CAP channel with given identifier. 511 */ 512 uint16_t l2cap_get_remote_mtu_for_local_cid(uint16_t local_cid); 513 514 /** 515 * @brief Sends L2CAP data packet to the channel with given identifier. 516 * @note For channel in credit-based flow control mode, data needs to stay valid until .. event 517 * @param local_cid 518 * @param data to send 519 * @param len of data 520 * @return status 521 */ 522 uint8_t l2cap_send(uint16_t local_cid, const uint8_t *data, uint16_t len); 523 524 /** 525 * @brief Registers L2CAP service with given PSM and MTU, and assigns a packet handler. 526 * @param packet_handler 527 * @param psm 528 * @param mtu 529 * @param security_level 530 * @return status ERROR_CODE_SUCCESS if successful, otherwise L2CAP_SERVICE_ALREADY_REGISTERED or BTSTACK_MEMORY_ALLOC_FAILED 531 */ 532 uint8_t l2cap_register_service(btstack_packet_handler_t packet_handler, uint16_t psm, uint16_t mtu, gap_security_level_t security_level); 533 534 /** 535 * @brief Unregisters L2CAP service with given PSM. 536 */ 537 uint8_t l2cap_unregister_service(uint16_t psm); 538 539 /** 540 * @brief Accepts incoming L2CAP connection. 541 */ 542 void l2cap_accept_connection(uint16_t local_cid); 543 544 /** 545 * @brief Deny incoming L2CAP connection. 546 */ 547 void l2cap_decline_connection(uint16_t local_cid); 548 549 /** 550 * @brief Check if outgoing buffer is available and that there's space on the Bluetooth module 551 * @return true if packet can be sent 552 */ 553 bool l2cap_can_send_packet_now(uint16_t local_cid); 554 555 /** 556 * @brief Request emission of L2CAP_EVENT_CAN_SEND_NOW as soon as possible 557 * @note L2CAP_EVENT_CAN_SEND_NOW might be emitted during call to this function 558 * so packet handler should be ready to handle it 559 * @param local_cid 560 * @return status 561 */ 562 uint8_t l2cap_request_can_send_now_event(uint16_t local_cid); 563 564 /** 565 * @brief Reserve outgoing buffer 566 * @note Only for L2CAP Basic Mode Channels 567 * @return true on success 568 */ 569 bool l2cap_reserve_packet_buffer(void); 570 571 /** 572 * @brief Get outgoing buffer and prepare data. 573 * @note Only for L2CAP Basic Mode Channels 574 */ 575 uint8_t *l2cap_get_outgoing_buffer(void); 576 577 /** 578 * @brief Send L2CAP packet prepared in outgoing buffer to channel 579 * @note Only for L2CAP Basic Mode Channels 580 */ 581 uint8_t l2cap_send_prepared(uint16_t local_cid, uint16_t len); 582 583 /** 584 * @brief Release outgoing buffer (only needed if l2cap_send_prepared is not called) 585 * @note Only for L2CAP Basic Mode Channels 586 */ 587 void l2cap_release_packet_buffer(void); 588 589 // 590 // Connection-Oriented Channels in Enhanced Retransmission Mode - ERTM 591 // 592 593 /** 594 * @brief Creates L2CAP channel to the PSM of a remote device with baseband address using Enhanced Retransmission Mode. 595 * A new baseband connection will be initiated if necessary. 596 * @param packet_handler 597 * @param address 598 * @param psm 599 * @param ertm_config 600 * @param buffer to store reassembled rx packet, out-of-order packets and unacknowledged outgoing packets with their tretransmission timers 601 * @param size of buffer 602 * @param local_cid 603 * @return status 604 */ 605 uint8_t l2cap_ertm_create_channel(btstack_packet_handler_t packet_handler, bd_addr_t address, uint16_t psm, 606 l2cap_ertm_config_t * ertm_contig, uint8_t * buffer, uint32_t size, uint16_t * out_local_cid); 607 608 /** 609 * @brief Accepts incoming L2CAP connection for Enhanced Retransmission Mode 610 * @param local_cid 611 * @param ertm_config 612 * @param buffer to store reassembled rx packet, out-of-order packets and unacknowledged outgoing packets with their tretransmission timers 613 * @param size of buffer 614 * @return status 615 */ 616 uint8_t l2cap_ertm_accept_connection(uint16_t local_cid, l2cap_ertm_config_t * ertm_contig, uint8_t * buffer, uint32_t size); 617 618 /** 619 * @brief Deny incoming incoming L2CAP connection for Enhanced Retransmission Mode 620 * @param local_cid 621 * @return status 622 */ 623 uint8_t l2cap_ertm_decline_connection(uint16_t local_cid); 624 625 /** 626 * @brief ERTM Set channel as busy. 627 * @note Can be cleared by l2cap_ertm_set_ready 628 * @param local_cid 629 * @return status 630 */ 631 uint8_t l2cap_ertm_set_busy(uint16_t local_cid); 632 633 /** 634 * @brief ERTM Set channel as ready 635 * @note Used after l2cap_ertm_set_busy 636 * @param local_cid 637 * @return status 638 */ 639 uint8_t l2cap_ertm_set_ready(uint16_t local_cid); 640 641 642 // 643 // L2CAP Connection-Oriented Channels in LE Credit-Based Flow-Control Mode - CBM 644 // 645 646 /** 647 * @brief Register L2CAP service in LE Credit-Based Flow-Control Mode 648 * @note MTU and initial credits are specified in l2cap_cbm_accept_connection(..) call 649 * @param packet_handler 650 * @param psm 651 * @param security_level 652 */ 653 uint8_t l2cap_cbm_register_service(btstack_packet_handler_t packet_handler, uint16_t psm, gap_security_level_t security_level); 654 655 /** 656 * @brief Unregister L2CAP service in LE Credit-Based Flow-Control Mode 657 * @param psm 658 */ 659 660 uint8_t l2cap_cbm_unregister_service(uint16_t psm); 661 662 /* 663 * @brief Accept incoming connection LE Credit-Based Flow-Control Mode 664 * @param local_cid L2CAP Channel Identifier 665 * @param receive_buffer buffer used for reassembly of L2CAP LE Information Frames into service data unit (SDU) with given MTU 666 * @param receive_buffer_size buffer size equals MTU 667 * @param initial_credits Number of initial credits provided to peer or L2CAP_LE_AUTOMATIC_CREDITS to enable automatic credits 668 */ 669 670 uint8_t l2cap_cbm_accept_connection(uint16_t local_cid, uint8_t * receive_sdu_buffer, uint16_t mtu, uint16_t initial_credits); 671 672 /** 673 * @brief Deecline connection in LE Credit-Based Flow-Control Mode 674 * @param local_cid L2CAP Channel Identifier 675 * @param result result, see L2CAP_CBM_CONNECTION_RESULT_SUCCESS in bluetooth.h 676 */ 677 678 uint8_t l2cap_cbm_decline_connection(uint16_t local_cid, uint16_t result); 679 680 /** 681 * @brief Create outgoing channel in LE Credit-Based Flow-Control Mode 682 * @param packet_handler Packet handler for this connection 683 * @param con_handle HCI Connection Handle, LE transport 684 * @param psm Service PSM to connect to 685 * @param receive_buffer buffer used for reassembly of L2CAP LE Information Frames into service data unit (SDU) with given MTU 686 * @param receive_buffer_size buffer size equals MTU 687 * @param initial_credits Number of initial credits provided to peer or L2CAP_LE_AUTOMATIC_CREDITS to enable automatic credits 688 * @param security_level Minimum required security level 689 * @param out_local_cid L2CAP LE Channel Identifier is stored here 690 */ 691 uint8_t l2cap_cbm_create_channel(btstack_packet_handler_t packet_handler, hci_con_handle_t con_handle, 692 uint16_t psm, uint8_t * receive_sdu_buffer, uint16_t mtu, uint16_t initial_credits, gap_security_level_t security_level, 693 uint16_t * out_local_cid); 694 695 /** 696 * @brief Provide credits for channel in LE Credit-Based Flow-Control Mode 697 * @param local_cid L2CAP Channel Identifier 698 * @param credits Number additional credits for peer 699 */ 700 uint8_t l2cap_cbm_provide_credits(uint16_t local_cid, uint16_t credits); 701 702 // 703 // L2CAP Connection-Oriented Channels in Enhanced Credit-Based Flow-Control Mode - ECBM 704 // 705 706 /** 707 * @brief Register L2CAP service in Enhanced Credit-Based Flow-Control Mode 708 * @note MTU and initial credits are specified in l2cap_enhanced_accept_connection(..) call 709 * @param packet_handler 710 * @param psm 711 * @param min_remote_mtu 712 * @param security_level 713 * @return status 714 */ 715 uint8_t l2cap_ecbm_register_service(btstack_packet_handler_t packet_handler, uint16_t psm, uint16_t min_remote_mtu, gap_security_level_t security_level); 716 717 /** 718 * @brief Unregister L2CAP service in Enhanced Credit-Based Flow-Control Mode 719 * @param psm 720 * @return status 721 */ 722 723 uint8_t l2cap_ecbm_unregister_service(uint16_t psm); 724 725 /** 726 * @brief Set Minimal MPS for channel in Enhanced Credit-Based Flow-Control Mode 727 * @param mps_min 728 */ 729 void l2cap_ecbm_mps_set_min(uint16_t mps_min); 730 731 /** 732 * @brief Set Minimal MPS for channel in Enhanced Credit-Based Flow-Control Mode 733 * @param mps_max 734 */ 735 void l2cap_ecbm_mps_set_max(uint16_t mps_max); 736 737 /** 738 * @brief Create outgoing channel in Enhanced Credit-Based Flow-Control Mode 739 * @note receive_buffer points to an array of receive buffers with num_channels elements 740 * @note out_local_cid points to an array where CID is stored with num_channel elements 741 * @param packet_handler Packet handler for this connection 742 * @param con_handle HCI Connection Handle 743 * @param security_level Minimum required security level 744 * @param psm Service PSM to connect to 745 * @param num_channels number of channels to create 746 * @param initial_credits Number of initial credits provided to peer per channel or L2CAP_LE_AUTOMATIC_CREDITS to enable automatic credits 747 * @param receive_buffer_size buffer size equals MTU 748 * @param receive_buffers Array of buffers used for reassembly of L2CAP Information Frames into service data unit (SDU) with given MTU 749 * @param out_local_cids Array of L2CAP Channel Identifiers is stored here on success 750 * @return status 751 */ 752 uint8_t l2cap_ecbm_create_channels(btstack_packet_handler_t packet_handler, hci_con_handle_t con_handle, 753 gap_security_level_t security_level, 754 uint16_t psm, uint8_t num_channels, uint16_t initial_credits, uint16_t receive_buffer_size, 755 uint8_t ** receive_buffers, uint16_t * out_local_cids); 756 757 /** 758 * @brief Accept incoming connection Enhanced Credit-Based Flow-Control Mode 759 * @param local_cid from L2CAP_EVENT_INCOMING_DATA_CONNECTION 760 * @param num_channels 761 * @param initial_credits Number of initial credits provided to peer per channel or L2CAP_LE_AUTOMATIC_CREDITS to enable automatic credits 762 * @param receive_buffer_size 763 * @param receive_buffers Array of buffers used for reassembly of L2CAP Information Frames into service data unit (SDU) with given MTU 764 * @param out_local_cids Array of L2CAP Channel Identifiers is stored here on success 765 * @return status 766 */ 767 uint8_t l2cap_ecbm_accept_channels(uint16_t local_cid, uint8_t num_channels, uint16_t initial_credits, 768 uint16_t receive_buffer_size, uint8_t ** receive_buffers, uint16_t * out_local_cids); 769 /** 770 * @brief Decline connection in Enhanced Credit-Based Flow-Control Mode 771 * @param local_cid from L2CAP_EVENT_INCOMING_DATA_CONNECTION 772 * @param result See L2CAP_ECBM_CONNECTION_RESULT_ALL_SUCCESS in bluetooth.h 773 * @return status 774 */ 775 uint8_t l2cap_ecbm_decline_channels(uint16_t local_cid, uint16_t result); 776 777 /** 778 * @brief Provide credits for channel in Enhanced Credit-Based Flow-Control Mode 779 * @param local_cid L2CAP Channel Identifier 780 * @param credits Number additional credits for peer 781 * @return status 782 */ 783 uint8_t l2cap_ecbm_provide_credits(uint16_t local_cid, uint16_t credits); 784 785 /** 786 * @brief Request emission of L2CAP_EVENT_ECBM_CAN_SEND_NOW as soon as possible 787 * @note L2CAP_EVENT_ECBM_CAN_SEND_NOW might be emitted during call to this function 788 * so packet handler should be ready to handle it 789 * @param local_cid L2CAP Channel Identifier 790 * @return status 791 */ 792 uint8_t l2cap_ecbm_request_can_send_now_event(uint16_t local_cid); 793 794 /** 795 * @brief Reconfigure MPS/MTU of local channels 796 * @param num_cids 797 * @param local_cids array of local_cids to reconfigure 798 * @param receive_buffer_size buffer size equals MTU 799 * @param receive_buffers Array of buffers used for reassembly of L2CAP Information Frames into service data unit (SDU) with given MTU 800 * @return status 801 */ 802 uint8_t l2cap_ecbm_reconfigure_channels(uint8_t num_cids, uint16_t * local_cids, int16_t receive_buffer_size, uint8_t ** receive_buffers); 803 804 /** 805 * @brief De-Init L2CAP 806 */ 807 void l2cap_deinit(void); 808 809 /* API_END */ 810 811 812 // @deprecated - please use l2cap_ertm_create_channel 813 uint8_t l2cap_create_ertm_channel(btstack_packet_handler_t packet_handler, bd_addr_t address, uint16_t psm, l2cap_ertm_config_t * ertm_contig, uint8_t * buffer, uint32_t size, uint16_t * out_local_cid); 814 815 // @deprecated - please use l2cap_ertm_accept_connection 816 uint8_t l2cap_accept_ertm_connection(uint16_t local_cid, l2cap_ertm_config_t * ertm_contig, uint8_t * buffer, uint32_t size); 817 818 // @deprecated - please use l2cap_cbm_register_service 819 uint8_t l2cap_le_register_service(btstack_packet_handler_t packet_handler, uint16_t psm, gap_security_level_t security_level); 820 821 // @deprecated - please use l2cap_cbm_unregister_service 822 uint8_t l2cap_le_unregister_service(uint16_t psm); 823 824 // @deprecated - please use l2cap_cbm_accept_connection 825 uint8_t l2cap_le_accept_connection(uint16_t local_cid, uint8_t * receive_sdu_buffer, uint16_t mtu, uint16_t initial_credits); 826 827 // @deprecated - please use l2cap_cbm_decline_connection 828 uint8_t l2cap_le_decline_connection(uint16_t local_cid); 829 830 // @deprecated - please use l2cap_cbm_create_channel 831 uint8_t l2cap_le_create_channel(btstack_packet_handler_t packet_handler, hci_con_handle_t con_handle, 832 uint16_t psm, uint8_t * receive_sdu_buffer, uint16_t mtu, uint16_t initial_credits, gap_security_level_t security_level, 833 uint16_t * out_local_cid); 834 835 // @deprecated - please use l2cap_cbm_decline_connection 836 uint8_t l2cap_le_provide_credits(uint16_t local_cid, uint16_t credits); 837 838 // @deprecated - please use l2cap_cbm_can_send_now 839 bool l2cap_le_can_send_now(uint16_t local_cid); 840 841 // @deprecated - please use l2cap_cbm_request_can_send_now_event 842 uint8_t l2cap_le_request_can_send_now_event(uint16_t local_cid); 843 844 // @deprecated - please use l2cap_send_data 845 uint8_t l2cap_le_send_data(uint16_t local_cid, const uint8_t * data, uint16_t size); 846 847 // @deprecated - please use l2cap_disconnect 848 uint8_t l2cap_le_disconnect(uint16_t local_cid); 849 850 // @deprecated - please use l2cap_can_send_now 851 bool l2cap_cbm_can_send_now(uint16_t local_cid); 852 853 // @deprecated - please use l2cap_request_can_send_now_event 854 uint8_t l2cap_cbm_request_can_send_now_event(uint16_t local_cid); 855 856 857 #if defined __cplusplus 858 } 859 #endif 860 861 #endif // L2CAP_H 862