Zephyr API Documentation  3.0.0
A Scalable Open Source RTOS
3.0.0
All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
l2cap.h
Go to the documentation of this file.
1
5/*
6 * Copyright (c) 2015-2016 Intel Corporation
7 *
8 * SPDX-License-Identifier: Apache-2.0
9 */
10#ifndef ZEPHYR_INCLUDE_BLUETOOTH_L2CAP_H_
11#define ZEPHYR_INCLUDE_BLUETOOTH_L2CAP_H_
12
20#include <sys/atomic.h>
21#include <bluetooth/buf.h>
22#include <bluetooth/conn.h>
23#include <bluetooth/hci.h>
24
25#ifdef __cplusplus
26extern "C" {
27#endif
28
30#define BT_L2CAP_HDR_SIZE 4
31
33#define BT_L2CAP_TX_MTU (CONFIG_BT_L2CAP_TX_MTU)
34
36#define BT_L2CAP_RX_MTU (CONFIG_BT_BUF_ACL_RX_SIZE - BT_L2CAP_HDR_SIZE)
37
45#define BT_L2CAP_BUF_SIZE(mtu) BT_BUF_ACL_SIZE(BT_L2CAP_HDR_SIZE + (mtu))
46
48#define BT_L2CAP_SDU_HDR_SIZE 2
49
58#define BT_L2CAP_SDU_TX_MTU (BT_L2CAP_TX_MTU - BT_L2CAP_SDU_HDR_SIZE)
59
70#define BT_L2CAP_SDU_RX_MTU (BT_L2CAP_RX_MTU - BT_L2CAP_SDU_HDR_SIZE)
71
81#define BT_L2CAP_SDU_BUF_SIZE(mtu) BT_L2CAP_BUF_SIZE(BT_L2CAP_SDU_HDR_SIZE + (mtu))
82
83struct bt_l2cap_chan;
84
90typedef void (*bt_l2cap_chan_destroy_t)(struct bt_l2cap_chan *chan);
91
97typedef enum bt_l2cap_chan_state {
108
110
115
122
125
126 /* Total number of status - must be at the end of the enum */
129
133 struct bt_conn *conn;
135 const struct bt_l2cap_chan_ops *ops;
138 /* Response Timeout eXpired (RTX) timer */
142
143#if defined(CONFIG_BT_L2CAP_DYNAMIC_CHANNEL)
146 uint16_t psm;
148 uint8_t ident;
149 bt_security_t required_sec_level;
150#endif /* CONFIG_BT_L2CAP_DYNAMIC_CHANNEL */
151};
152
165};
166
180
183
193 struct net_buf *_sdu;
194 uint16_t _sdu_len;
195
198};
199
209#define BT_L2CAP_LE_CHAN(_ch) CONTAINER_OF(_ch, struct bt_l2cap_le_chan, chan)
210
217};
218
227 /* For internal use only */
229};
230
240 void (*connected)(struct bt_l2cap_chan *chan);
241
250 void (*disconnected)(struct bt_l2cap_chan *chan);
251
267 void (*encrypt_change)(struct bt_l2cap_chan *chan, uint8_t hci_status);
268
281 struct net_buf *(*alloc_buf)(struct bt_l2cap_chan *chan);
282
296 int (*recv)(struct bt_l2cap_chan *chan, struct net_buf *buf);
297
305 void (*sent)(struct bt_l2cap_chan *chan);
306
315 void (*status)(struct bt_l2cap_chan *chan, atomic_t *status);
316
317 /* @brief Channel released callback
318 *
319 * If this callback is set it is called when the stack has release all
320 * references to the channel object.
321 */
322 void (*released)(struct bt_l2cap_chan *chan);
323
332 void (*reconfigured)(struct bt_l2cap_chan *chan);
333};
334
338#define BT_L2CAP_CHAN_SEND_RESERVE (BT_L2CAP_BUF_SIZE(0))
339
343#define BT_L2CAP_SDU_CHAN_SEND_RESERVE (BT_L2CAP_SDU_BUF_SIZE(0))
344
361
364
378 int (*accept)(struct bt_conn *conn, struct bt_l2cap_chan **chan);
379
381};
382
403
415
429 struct bt_l2cap_chan **chans, uint16_t psm);
430
444
463int bt_l2cap_chan_connect(struct bt_conn *conn, struct bt_l2cap_chan *chan,
464 uint16_t psm);
465
478
510int bt_l2cap_chan_send(struct bt_l2cap_chan *chan, struct net_buf *buf);
511
525 struct net_buf *buf);
526
527#ifdef __cplusplus
528}
529#endif
530
535#endif /* ZEPHYR_INCLUDE_BLUETOOTH_L2CAP_H_ */
long atomic_t
Definition: atomic.h:22
Bluetooth data buffer API.
Bluetooth connection handling.
#define ATOMIC_DEFINE(name, num_bits)
Define an array of atomic variables.
Definition: atomic.h:114
bt_security_t
Definition: conn.h:664
int bt_l2cap_ecred_chan_reconfigure(struct bt_l2cap_chan **chans, uint16_t mtu)
Reconfigure Enhanced Credit Based L2CAP channels.
int bt_l2cap_server_register(struct bt_l2cap_server *server)
Register L2CAP server.
bt_l2cap_chan_status
Status of L2CAP channel.
Definition: l2cap.h:112
enum bt_l2cap_chan_status bt_l2cap_chan_status_t
Status of L2CAP channel.
int bt_l2cap_chan_connect(struct bt_conn *conn, struct bt_l2cap_chan *chan, uint16_t psm)
Connect L2CAP channel.
enum bt_l2cap_chan_state bt_l2cap_chan_state_t
Life-span states of L2CAP CoC channel.
int bt_l2cap_br_server_register(struct bt_l2cap_server *server)
Register L2CAP server on BR/EDR oriented connection.
bt_l2cap_chan_state
Life-span states of L2CAP CoC channel.
Definition: l2cap.h:97
int bt_l2cap_chan_disconnect(struct bt_l2cap_chan *chan)
Disconnect L2CAP channel.
int bt_l2cap_chan_send(struct bt_l2cap_chan *chan, struct net_buf *buf)
Send data to L2CAP channel.
int bt_l2cap_chan_recv_complete(struct bt_l2cap_chan *chan, struct net_buf *buf)
Complete receiving L2CAP channel data.
int bt_l2cap_ecred_chan_connect(struct bt_conn *conn, struct bt_l2cap_chan **chans, uint16_t psm)
Connect Enhanced Credit Based L2CAP channels.
void(* bt_l2cap_chan_destroy_t)(struct bt_l2cap_chan *chan)
Channel destroy callback.
Definition: l2cap.h:90
@ BT_L2CAP_STATUS_SHUTDOWN
Channel shutdown status.
Definition: l2cap.h:121
@ BT_L2CAP_STATUS_OUT
Definition: l2cap.h:114
@ BT_L2CAP_NUM_STATUS
Definition: l2cap.h:127
@ BT_L2CAP_STATUS_ENCRYPT_PENDING
Channel encryption pending status.
Definition: l2cap.h:124
@ BT_L2CAP_DISCONNECTED
Definition: l2cap.h:99
@ BT_L2CAP_CONFIG
Definition: l2cap.h:103
@ BT_L2CAP_DISCONNECT
Definition: l2cap.h:107
@ BT_L2CAP_CONNECTED
Definition: l2cap.h:105
@ BT_L2CAP_CONNECT
Definition: l2cap.h:101
flags
Definition: http_parser.h:131
state
Definition: http_parser_state.h:30
struct _snode sys_snode_t
Definition: slist.h:33
__UINT8_TYPE__ uint8_t
Definition: stdint.h:58
__UINT16_TYPE__ uint16_t
Definition: stdint.h:59
BREDR L2CAP Channel structure.
Definition: l2cap.h:220
struct bt_l2cap_br_endpoint rx
Definition: l2cap.h:224
struct bt_l2cap_chan chan
Definition: l2cap.h:222
struct bt_l2cap_br_endpoint tx
Definition: l2cap.h:226
BREDR L2CAP Endpoint structure.
Definition: l2cap.h:212
uint16_t mtu
Definition: l2cap.h:216
uint16_t cid
Definition: l2cap.h:214
L2CAP Channel operations structure.
Definition: l2cap.h:232
int(* recv)(struct bt_l2cap_chan *chan, struct net_buf *buf)
Channel recv callback.
Definition: l2cap.h:296
void(* encrypt_change)(struct bt_l2cap_chan *chan, uint8_t hci_status)
Channel encrypt_change callback.
Definition: l2cap.h:267
void(* disconnected)(struct bt_l2cap_chan *chan)
Channel disconnected callback.
Definition: l2cap.h:250
void(* connected)(struct bt_l2cap_chan *chan)
Channel connected callback.
Definition: l2cap.h:240
void(* status)(struct bt_l2cap_chan *chan, atomic_t *status)
Channel status callback.
Definition: l2cap.h:315
void(* released)(struct bt_l2cap_chan *chan)
Definition: l2cap.h:322
void(* sent)(struct bt_l2cap_chan *chan)
Channel sent callback.
Definition: l2cap.h:305
void(* reconfigured)(struct bt_l2cap_chan *chan)
Channel reconfigured callback.
Definition: l2cap.h:332
L2CAP Channel structure.
Definition: l2cap.h:131
struct bt_conn * conn
Definition: l2cap.h:133
sys_snode_t node
Definition: l2cap.h:136
struct k_work_sync rtx_sync
Definition: l2cap.h:140
const struct bt_l2cap_chan_ops * ops
Definition: l2cap.h:135
struct k_work_delayable rtx_work
Definition: l2cap.h:139
atomic_t status[ATOMIC_BITMAP_SIZE(BT_L2CAP_NUM_STATUS)]
Definition: l2cap.h:141
bt_l2cap_chan_destroy_t destroy
Definition: l2cap.h:137
LE L2CAP Channel structure.
Definition: l2cap.h:168
struct bt_l2cap_le_endpoint tx
Definition: l2cap.h:185
struct k_work rx_work
Definition: l2cap.h:196
uint16_t pending_rx_mtu
Definition: l2cap.h:182
struct k_fifo tx_queue
Definition: l2cap.h:187
struct bt_l2cap_le_endpoint rx
Channel Receiving Endpoint.
Definition: l2cap.h:179
struct bt_l2cap_chan chan
Definition: l2cap.h:170
struct k_fifo rx_queue
Definition: l2cap.h:197
struct k_work tx_work
Definition: l2cap.h:191
struct net_buf * tx_buf
Definition: l2cap.h:189
LE L2CAP Endpoint structure.
Definition: l2cap.h:154
uint16_t mtu
Definition: l2cap.h:158
uint16_t init_credits
Definition: l2cap.h:162
uint16_t mps
Definition: l2cap.h:160
atomic_t credits
Definition: l2cap.h:164
uint16_t cid
Definition: l2cap.h:156
L2CAP Server structure.
Definition: l2cap.h:346
uint16_t psm
Server PSM.
Definition: l2cap.h:360
sys_snode_t node
Definition: l2cap.h:380
bt_security_t sec_level
Definition: l2cap.h:363
int(* accept)(struct bt_conn *conn, struct bt_l2cap_chan **chan)
Server accept callback.
Definition: l2cap.h:378
Definition: kernel.h:2116
A structure used to submit work after a delay.
Definition: kernel.h:3600
A structure holding internal state for a pending synchronous operation on a work item or queue.
Definition: kernel.h:3683
A structure used to submit work.
Definition: kernel.h:3572
Network buffer representation.
Definition: buf.h:915