Zephyr API Documentation 4.0.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
buf.h
Go to the documentation of this file.
1
5/*
6 * Copyright (c) 2016 Intel Corporation
7 *
8 * SPDX-License-Identifier: Apache-2.0
9 */
10
11#ifndef ZEPHYR_INCLUDE_BLUETOOTH_BUF_H_
12#define ZEPHYR_INCLUDE_BLUETOOTH_BUF_H_
13
21#include <stdint.h>
22
23#include <zephyr/net_buf.h>
25#include <zephyr/sys/util.h>
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
48
53
54/* Headroom reserved in buffers, primarily for HCI transport encoding purposes */
55#define BT_BUF_RESERVE 1
56
58#define BT_BUF_SIZE(size) (BT_BUF_RESERVE + (size))
59
61#define BT_BUF_ACL_SIZE(size) BT_BUF_SIZE(BT_HCI_ACL_HDR_SIZE + (size))
62
64#define BT_BUF_EVT_SIZE(size) BT_BUF_SIZE(BT_HCI_EVT_HDR_SIZE + (size))
65
67#define BT_BUF_CMD_SIZE(size) BT_BUF_SIZE(BT_HCI_CMD_HDR_SIZE + (size))
68
70#define BT_BUF_ISO_SIZE(size) BT_BUF_SIZE(BT_HCI_ISO_HDR_SIZE + \
71 BT_HCI_ISO_SDU_TS_HDR_SIZE + \
72 (size))
73
75#define BT_BUF_ACL_RX_SIZE BT_BUF_ACL_SIZE(CONFIG_BT_BUF_ACL_RX_SIZE)
76
78#define BT_BUF_EVT_RX_SIZE BT_BUF_EVT_SIZE(CONFIG_BT_BUF_EVT_RX_SIZE)
79
80#if defined(CONFIG_BT_ISO)
81#define BT_BUF_ISO_RX_SIZE BT_BUF_ISO_SIZE(CONFIG_BT_ISO_RX_MTU)
82#define BT_BUF_ISO_RX_COUNT CONFIG_BT_ISO_RX_BUF_COUNT
83#else
84#define BT_BUF_ISO_RX_SIZE 0
85#define BT_BUF_ISO_RX_COUNT 0
86#endif /* CONFIG_BT_ISO */
87
88/* see Core Spec v6.0 vol.4 part E 7.4.5 */
89#define BT_BUF_ACL_RX_COUNT_MAX 65535
90
91#if defined(CONFIG_BT_CONN) && defined(CONFIG_BT_HCI_HOST)
92 /* The host needs more ACL buffers than maximum ACL links. This is because of
93 * the way we re-assemble ACL packets into L2CAP PDUs.
94 *
95 * We keep around the first buffer (that comes from the driver) to do
96 * re-assembly into, and if all links are re-assembling, there will be no buffer
97 * available for the HCI driver to allocate from.
98 *
99 * TODO: When CONFIG_BT_BUF_ACL_RX_COUNT is removed,
100 * remove the MAX and only keep (CONFIG_BT_MAX_CONN + 1)
101 */
102#define BT_BUF_ACL_RX_COUNT \
103 (MAX(CONFIG_BT_BUF_ACL_RX_COUNT, (CONFIG_BT_MAX_CONN + 1)) + \
104 CONFIG_BT_BUF_ACL_RX_COUNT_EXTRA)
105#else
106#define BT_BUF_ACL_RX_COUNT 0
107#endif /* CONFIG_BT_CONN && CONFIG_BT_HCI_HOST */
108
109#if defined(CONFIG_BT_BUF_ACL_RX_COUNT) && CONFIG_BT_BUF_ACL_RX_COUNT > 0
110#warning "CONFIG_BT_BUF_ACL_RX_COUNT is deprecated, see Zephyr 4.1 migration guide"
111#endif /* CONFIG_BT_BUF_ACL_RX_COUNT && CONFIG_BT_BUF_ACL_RX_COUNT > 0 */
112
114 "Maximum number of ACL RX buffer is 65535, reduce CONFIG_BT_BUF_ACL_RX_COUNT_EXTRA");
115
117#define BT_BUF_RX_SIZE (MAX(MAX(BT_BUF_ACL_RX_SIZE, BT_BUF_EVT_RX_SIZE), \
118 BT_BUF_ISO_RX_SIZE))
119
121#define BT_BUF_RX_COUNT (MAX(MAX(CONFIG_BT_BUF_EVT_RX_COUNT, \
122 BT_BUF_ACL_RX_COUNT), \
123 BT_BUF_ISO_RX_COUNT))
124
126#define BT_BUF_CMD_TX_SIZE BT_BUF_CMD_SIZE(CONFIG_BT_BUF_CMD_TX_SIZE)
127
139struct net_buf *bt_buf_get_rx(enum bt_buf_type type, k_timeout_t timeout);
140
153typedef void (*bt_buf_rx_freed_cb_t)(enum bt_buf_type type_mask);
154
161
175struct net_buf *bt_buf_get_tx(enum bt_buf_type type, k_timeout_t timeout,
176 const void *data, size_t size);
177
189struct net_buf *bt_buf_get_evt(uint8_t evt, bool discardable, k_timeout_t timeout);
190
196static inline void bt_buf_set_type(struct net_buf *buf, enum bt_buf_type type)
197{
198 ((struct bt_buf_data *)net_buf_user_data(buf))->type = type;
199}
200
207static inline enum bt_buf_type bt_buf_get_type(struct net_buf *buf)
208{
209 return (enum bt_buf_type)((struct bt_buf_data *)net_buf_user_data(buf))
210 ->type;
211}
212
217#ifdef __cplusplus
218}
219#endif
220
221#endif /* ZEPHYR_INCLUDE_BLUETOOTH_BUF_H_ */
#define BT_BUF_ACL_RX_COUNT
Definition buf.h:106
static enum bt_buf_type bt_buf_get_type(struct net_buf *buf)
Get the buffer type.
Definition buf.h:207
struct net_buf * bt_buf_get_rx(enum bt_buf_type type, k_timeout_t timeout)
Allocate a buffer for incoming data.
struct net_buf * bt_buf_get_tx(enum bt_buf_type type, k_timeout_t timeout, const void *data, size_t size)
Allocate a buffer for outgoing data.
struct net_buf * bt_buf_get_evt(uint8_t evt, bool discardable, k_timeout_t timeout)
Allocate a buffer for an HCI Event.
#define BT_BUF_ACL_RX_COUNT_MAX
Definition buf.h:89
static void bt_buf_set_type(struct net_buf *buf, enum bt_buf_type type)
Set the buffer type.
Definition buf.h:196
void(* bt_buf_rx_freed_cb_t)(enum bt_buf_type type_mask)
A callback to notify about freed buffer in the incoming data pool.
Definition buf.h:153
void bt_buf_rx_freed_cb_set(bt_buf_rx_freed_cb_t cb)
Set the callback to notify about freed buffer in the incoming data pool.
bt_buf_type
Possible types of buffers passed around the Bluetooth stack in a form of bitmask.
Definition buf.h:32
@ BT_BUF_EVT
HCI event.
Definition buf.h:36
@ BT_BUF_ISO_OUT
Outgoing ISO data.
Definition buf.h:42
@ BT_BUF_ACL_OUT
Outgoing ACL data.
Definition buf.h:38
@ BT_BUF_ISO_IN
Incoming ISO data.
Definition buf.h:44
@ BT_BUF_CMD
HCI command.
Definition buf.h:34
@ BT_BUF_H4
H:4 data.
Definition buf.h:46
@ BT_BUF_ACL_IN
Incoming ACL data.
Definition buf.h:40
static void * net_buf_user_data(const struct net_buf *buf)
Get a pointer to the user data of a buffer.
Definition net_buf.h:1576
#define BIT(n)
Unsigned integer with bit position n set (signed in assembly language).
Definition util_macro.h:44
Buffer management.
__UINT8_TYPE__ uint8_t
Definition stdint.h:88
This is a base type for bt_buf user data.
Definition buf.h:50
uint8_t type
Definition buf.h:51
Kernel timeout type.
Definition sys_clock.h:65
Network buffer representation.
Definition net_buf.h:1006
uint16_t size
Amount of data that this buffer can store.
Definition net_buf.h:1038
uint8_t * data
Pointer to the start of data in the buffer.
Definition net_buf.h:1032
Misc utilities.