142 lines
4.1 KiB
C
142 lines
4.1 KiB
C
/** @file
|
|
* @brief Bluetooth data buffer API
|
|
*/
|
|
|
|
/*
|
|
* Copyright (c) 2016 Intel Corporation
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef ZEPHYR_INCLUDE_BLUETOOTH_BUF_H_
|
|
#define ZEPHYR_INCLUDE_BLUETOOTH_BUF_H_
|
|
|
|
/**
|
|
* @brief Data buffers
|
|
* @defgroup bt_buf Data buffers
|
|
* @ingroup bluetooth
|
|
* @{
|
|
*/
|
|
|
|
#include <zephyr/types.h>
|
|
#include <net/buf.h>
|
|
#include <bluetooth/hci.h>
|
|
|
|
/** Possible types of buffers passed around the Bluetooth stack */
|
|
enum bt_buf_type {
|
|
/** HCI command */
|
|
BT_BUF_CMD,
|
|
/** HCI event */
|
|
BT_BUF_EVT,
|
|
/** Outgoing ACL data */
|
|
BT_BUF_ACL_OUT,
|
|
/** Incoming ACL data */
|
|
BT_BUF_ACL_IN,
|
|
/** Outgoing ISO data */
|
|
BT_BUF_ISO_OUT,
|
|
/** Incoming ISO data */
|
|
BT_BUF_ISO_IN,
|
|
/** H:4 data */
|
|
BT_BUF_H4,
|
|
};
|
|
|
|
/** Minimum amount of user data size for buffers passed to the stack. */
|
|
#define BT_BUF_USER_DATA_MIN __DEPRECATED_MACRO 4
|
|
|
|
#if defined(CONFIG_BT_HCI_RAW)
|
|
#define BT_BUF_RESERVE MAX(CONFIG_BT_HCI_RESERVE, CONFIG_BT_HCI_RAW_RESERVE)
|
|
#else
|
|
#define BT_BUF_RESERVE CONFIG_BT_HCI_RESERVE
|
|
#endif
|
|
|
|
#define BT_BUF_SIZE(size) (BT_BUF_RESERVE + (size))
|
|
|
|
/** Data size neeed for HCI RX buffers */
|
|
#define BT_BUF_RX_SIZE (BT_BUF_SIZE(CONFIG_BT_RX_BUF_LEN))
|
|
|
|
/** Allocate a buffer for incoming data
|
|
*
|
|
* This will set the buffer type so bt_buf_set_type() does not need to
|
|
* be explicitly called before bt_recv_prio().
|
|
*
|
|
* @param type Type of buffer. Only BT_BUF_EVT and BT_BUF_ACL_IN are
|
|
* allowed.
|
|
* @param timeout Non-negative waiting period to obtain a buffer or one of the
|
|
* special values K_NO_WAIT and K_FOREVER.
|
|
* @return A new buffer.
|
|
*/
|
|
struct net_buf *bt_buf_get_rx(enum bt_buf_type type, k_timeout_t timeout);
|
|
|
|
/** Allocate a buffer for outgoing data
|
|
*
|
|
* This will set the buffer type so bt_buf_set_type() does not need to
|
|
* be explicitly called before bt_send().
|
|
*
|
|
* @param type Type of buffer. Only BT_BUF_CMD, BT_BUF_ACL_OUT or
|
|
* BT_BUF_H4, when operating on H:4 mode, are allowed.
|
|
* @param timeout Non-negative waiting period to obtain a buffer or one of the
|
|
* special values K_NO_WAIT and K_FOREVER.
|
|
* @param data Initial data to append to buffer.
|
|
* @param size Initial data size.
|
|
* @return A new buffer.
|
|
*/
|
|
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 an HCI Command Complete/Status Event
|
|
*
|
|
* This will set the buffer type so bt_buf_set_type() does not need to
|
|
* be explicitly called before bt_recv_prio().
|
|
*
|
|
* @param timeout Non-negative waiting period to obtain a buffer or one of the
|
|
* special values K_NO_WAIT and K_FOREVER.
|
|
* @return A new buffer.
|
|
*/
|
|
struct net_buf *bt_buf_get_cmd_complete(k_timeout_t timeout);
|
|
|
|
/** Allocate a buffer for an HCI Event
|
|
*
|
|
* This will set the buffer type so bt_buf_set_type() does not need to
|
|
* be explicitly called before bt_recv_prio() or bt_recv().
|
|
*
|
|
* @param evt HCI event code
|
|
* @param discardable Whether the driver considers the event discardable.
|
|
* @param timeout Non-negative waiting period to obtain a buffer or one of
|
|
* the special values K_NO_WAIT and K_FOREVER.
|
|
* @return A new buffer.
|
|
*/
|
|
struct net_buf *bt_buf_get_evt(uint8_t evt, bool discardable, k_timeout_t timeout);
|
|
|
|
/** Set the buffer type
|
|
*
|
|
* @param buf Bluetooth buffer
|
|
* @param type The BT_* type to set the buffer to
|
|
*/
|
|
static inline void bt_buf_set_type(struct net_buf *buf, enum bt_buf_type type)
|
|
{
|
|
*(uint8_t *)net_buf_user_data(buf) = type;
|
|
}
|
|
|
|
/** Get the buffer type
|
|
*
|
|
* @param buf Bluetooth buffer
|
|
*
|
|
* @return The BT_* type to of the buffer
|
|
*/
|
|
static inline enum bt_buf_type bt_buf_get_type(struct net_buf *buf)
|
|
{
|
|
/* De-referencing the pointer from net_buf_user_data(buf) as a
|
|
* pointer to an enum causes issues on qemu_x86 because the true
|
|
* size is 8-bit, but the enum is 32-bit on qemu_x86. So we put in
|
|
* a temporary cast to 8-bit to ensure only 8 bits are read from
|
|
* the pointer.
|
|
*/
|
|
return (enum bt_buf_type)(*(uint8_t *)net_buf_user_data(buf));
|
|
}
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
#endif /* ZEPHYR_INCLUDE_BLUETOOTH_BUF_H_ */
|