Bluetooth: Deprecate bt_buf_get/set_type()

These are fairly pointless now and needlessly obscure the actual encoding
or decoding of the packet type.

Signed-off-by: Johan Hedberg <[email protected]>

Author: jhedberg

doc/releases/migration-guide-4.2.rst

@@ -238,7 +238,8 @@ Bluetooth HCI
 
 * The buffer types passing through the HCI driver interface are now indicated as H:4 encoded prefix
   bytes as part of the buffer payload itself. The bt_buf_set_type() and bt_buf_get_type() functions
-  are still usable, except that the latter can only be called once per buffer.
+  have been deprecated, but are still usable, with the exception that they can only be
+  called once per buffer.
 
 * As part of the HCI buffer encoding change, since packet type values are no longer independent
   bits, the callback used by :c:func:`bt_buf_rx_freed_cb_set` has been changed to take a bitmask

drivers/bluetooth/hci/hci_ifx_cyw208xx.c

@@ -265,7 +265,7 @@ static int cyw208xx_send(const struct device *dev, struct net_buf *buf)
 
 	k_sem_take(&hci_sem, K_FOREVER);
 
-	type = bt_buf_get_type(buf);
+	type = net_buf_pull_u8(buf);
 
 	LOG_DBG("buf %p type %u len %u", buf, type, buf->len);
 

drivers/bluetooth/hci/hci_ifx_psoc6_bless.c

@@ -166,7 +166,7 @@ static int psoc6_bless_send(const struct device *dev, struct net_buf *buf)
 
 	memset(&hci_tx_pkt, 0, sizeof(cy_stc_ble_hci_tx_packet_info_t));
 
-	hci_tx_pkt.packetType = bt_buf_get_type(buf);
+	hci_tx_pkt.packetType = net_buf_pull_u8(buf);
 	hci_tx_pkt.dataLength = buf->len;
 	hci_tx_pkt.data = buf->data;
 

drivers/bluetooth/hci/hci_stm32wb0.c

@@ -371,7 +371,7 @@ static struct net_buf *get_rx(uint8_t *msg)
 static int bt_hci_stm32wb0_send(const struct device *dev, struct net_buf *buf)
 {
 	int ret = 0;
-	uint8_t type = bt_buf_get_type(buf);
+	uint8_t type = net_buf_pull_u8(buf);
 	uint8_t *hci_buffer = buf->data;
 
 	ARG_UNUSED(dev);

drivers/bluetooth/hci/ipm_stm32wb.c

@@ -365,17 +365,15 @@ static int bt_ipm_send(const struct device *dev, struct net_buf *buf)
 	case BT_BUF_ACL_OUT:
 		LOG_DBG("ACL: buf %p type %u len %u", buf, buf->data[0], buf->len);
 		k_sem_take(&acl_data_ack, K_FOREVER);
-		memcpy((void *)
-		       &((TL_AclDataPacket_t *)HciAclDataBuffer)->AclDataSerial,
+		memcpy((void *)&((TL_AclDataPacket_t *)HciAclDataBuffer)->AclDataSerial,
 		       buf->data, buf->len);
 		TL_BLE_SendAclData(NULL, 0);
 		break;
 	case BT_BUF_CMD:
 		LOG_DBG("CMD: buf %p type %u len %u", buf, buf->data[0], buf->len);
-		ble_cmd_buff->cmdserial.type = bt_buf_get_type(buf);
+		ble_cmd_buff->cmdserial.type = net_buf_pull_u8(buf);
 		ble_cmd_buff->cmdserial.cmd.plen = buf->len;
-		memcpy((void *)&ble_cmd_buff->cmdserial.cmd, buf->data,
-		       buf->len);
+		memcpy((void *)&ble_cmd_buff->cmdserial.cmd, buf->data, buf->len);
 		TL_BLE_SendCmd(NULL, 0);
 		break;
 	default:

include/zephyr/bluetooth/buf.h

@@ -131,8 +131,7 @@ BUILD_ASSERT(CONFIG_BT_BUF_EVT_RX_COUNT > CONFIG_BT_BUF_ACL_TX_COUNT,
 
 /** Allocate a buffer for incoming data
  *
- *  This will set the buffer type so bt_buf_set_type() does not need to
- *  be explicitly called.
+ *  This will set the buffer type so it doesn't need to be explicitly encoded into the buffer.
  *
  *  @param type    Type of buffer. Only BT_BUF_EVT, BT_BUF_ACL_IN and BT_BUF_ISO_IN
  *                 are allowed.
@@ -165,8 +164,7 @@ void bt_buf_rx_freed_cb_set(bt_buf_rx_freed_cb_t cb);
 
 /** Allocate a buffer for outgoing data
  *
- *  This will set the buffer type so bt_buf_set_type() does not need to
- *  be explicitly called.
+ *  This will set the buffer type so it doesn't need to be explicitly encoded into the buffer.
  *
  *  @param type    Type of buffer. BT_BUF_CMD or BT_BUF_ACL_OUT.
  *  @param timeout Non-negative waiting period to obtain a buffer or one of the
@@ -180,8 +178,7 @@ struct net_buf *bt_buf_get_tx(enum bt_buf_type type, 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.
+ *  This will set the buffer type so it doesn't need to be explicitly encoded into the buffer.
  *
  *  @param evt          HCI event code
  *  @param discardable  Whether the driver considers the event discardable.
@@ -197,7 +194,7 @@ struct net_buf *bt_buf_get_evt(uint8_t evt, bool discardable, k_timeout_t timeou
  *  @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)
+static inline void __deprecated bt_buf_set_type(struct net_buf *buf, enum bt_buf_type type)
 {
 	__ASSERT_NO_MSG(net_buf_headroom(buf) >= 1);
 	net_buf_push_u8(buf, type);
@@ -210,7 +207,7 @@ static inline void bt_buf_set_type(struct net_buf *buf, enum bt_buf_type type)
  *
  *  @return The BT_* type to of the buffer
  */
-static inline enum bt_buf_type bt_buf_get_type(struct net_buf *buf)
+static inline enum bt_buf_type __deprecated bt_buf_get_type(struct net_buf *buf)
 {
 	return net_buf_pull_u8(buf);
 }

include/zephyr/drivers/bluetooth.h

@@ -114,9 +114,8 @@ __subsystem struct bt_hci_driver_api {
  *
  * @param dev  HCI device
  * @param recv This is callback through which the HCI driver provides the
- *             host with data from the controller. The buffer passed to
- *             the callback will have its type set with bt_buf_set_type().
- *             The callback is expected to be called from thread context.
+ *             host with data from the controller. The callback is expected
+ *             to be called from thread context.
  *
  * @return 0 on success or negative POSIX error number on failure.
  */
@@ -151,8 +150,7 @@ static inline int bt_hci_close(const struct device *dev)
 /**
  * @brief Send HCI buffer to controller.
  *
- * Send an HCI packet to the controller. The packet type of the buffer
- * must be set using bt_buf_set_type(). The packet type is encoded as H:4,
+ * Send an HCI packet to the controller. The packet type is encoded as H:4,
  * i.e. the UART transport encoding, as a prefix to the actual payload. This means
  * that HCI drivers that use H:4 as their native encoding don't need to do any
  * special handling of the packet type.

subsys/bluetooth/controller/hci/hci.c

@@ -5237,8 +5237,7 @@ static struct net_buf *vs_err_evt_create(uint8_t subevt, uint8_t len)
 		struct bt_hci_evt_le_meta_event *me;
 		struct bt_hci_evt_hdr *hdr;
 
-		net_buf_reserve(buf, BT_BUF_RESERVE);
-		bt_buf_set_type(buf, BT_BUF_EVT);
+		net_buf_add_u8(buf, BT_BUF_EVT);
 
 		hdr = net_buf_add(buf, sizeof(*hdr));
 		hdr->evt = BT_HCI_EVT_VENDOR;

subsys/bluetooth/controller/hci/hci_driver.c

@@ -198,7 +198,7 @@ isoal_status_t sink_sdu_emit_hci(const struct isoal_sink             *sink_ctx,
 		hdr->handle = sys_cpu_to_le16(handle_packed);
 		hdr->len = sys_cpu_to_le16(len);
 
-		bt_buf_set_type(buf, BT_BUF_ISO_IN);
+		net_buf_push_u8(buf, BT_BUF_ISO_IN);
 
 		/* send fragment up the chain */
 		data->recv(dev, buf);
@@ -966,7 +966,7 @@ static int hci_driver_send(const struct device *dev, struct net_buf *buf)
 		return -EINVAL;
 	}
 
-	type = bt_buf_get_type(buf);
+	type = net_buf_pull_u8(buf);
 	switch (type) {
 #if defined(CONFIG_BT_CONN)
 	case BT_BUF_ACL_OUT:

subsys/bluetooth/host/buf.c

@@ -128,10 +128,8 @@ struct net_buf *bt_buf_get_rx(enum bt_buf_type type, k_timeout_t timeout)
 #else
 	buf = net_buf_alloc(&hci_rx_pool, timeout);
 #endif
-
 	if (buf) {
-		net_buf_reserve(buf, BT_BUF_RESERVE);
-		bt_buf_set_type(buf, type);
+		net_buf_add_u8(buf, type);
 	}
 
 	return buf;
@@ -172,8 +170,7 @@ struct net_buf *bt_buf_get_evt(uint8_t evt, bool discardable,
 	}
 
 	if (buf) {
-		net_buf_reserve(buf, BT_BUF_RESERVE);
-		bt_buf_set_type(buf, BT_BUF_EVT);
+		net_buf_add_u8(buf, BT_BUF_EVT);
 	}
 
 	return buf;

subsys/bluetooth/host/conn.c

@@ -551,7 +551,7 @@ static int send_acl(struct bt_conn *conn, struct net_buf *buf, uint8_t flags)
 	hdr->handle = sys_cpu_to_le16(bt_acl_handle_pack(conn->handle, flags));
 	hdr->len = sys_cpu_to_le16(buf->len - sizeof(*hdr));
 
-	bt_buf_set_type(buf, BT_BUF_ACL_OUT);
+	net_buf_push_u8(buf, BT_BUF_ACL_OUT);
 
 	return bt_send(buf);
 }
@@ -609,7 +609,7 @@ static int send_iso(struct bt_conn *conn, struct net_buf *buf, uint8_t flags)
 	hdr->handle = sys_cpu_to_le16(bt_iso_handle_pack(conn->handle, flags, ts));
 	hdr->len = sys_cpu_to_le16(buf->len - sizeof(*hdr));
 
-	bt_buf_set_type(buf, BT_BUF_ISO_OUT);
+	net_buf_push_u8(buf, BT_BUF_ISO_OUT);
 
 	return bt_send(buf);
 }

subsys/bluetooth/host/hci_core.c

@@ -331,8 +331,7 @@ struct net_buf *bt_hci_cmd_create(uint16_t opcode, uint8_t param_len)
 
 	LOG_DBG("buf %p", buf);
 
-	net_buf_reserve(buf, BT_BUF_RESERVE);
-	bt_buf_set_type(buf, BT_BUF_CMD);
+	net_buf_add_u8(buf, BT_BUF_CMD);
 
 	cmd(buf)->opcode = opcode;
 	cmd(buf)->sync = NULL;
@@ -4239,7 +4238,7 @@ static void rx_work_handler(struct k_work *work)
 		return;
 	}
 
-	type = bt_buf_get_type(buf);
+	type = net_buf_pull_u8(buf);
 
 	LOG_DBG("buf %p type %u len %u", buf, type, buf->len);
 

subsys/bluetooth/host/hci_raw.c

@@ -96,8 +96,7 @@ struct net_buf *bt_buf_get_rx(enum bt_buf_type type, k_timeout_t timeout)
 		return buf;
 	}
 
-	net_buf_reserve(buf, BT_BUF_RESERVE);
-	bt_buf_set_type(buf, type);
+	net_buf_add_u8(buf, type);
 
 	return buf;
 }
@@ -135,8 +134,7 @@ struct net_buf *bt_buf_get_tx(enum bt_buf_type type, k_timeout_t timeout,
 		return buf;
 	}
 
-	net_buf_reserve(buf, BT_BUF_RESERVE);
-	bt_buf_set_type(buf, type);
+	net_buf_add_u8(buf, type);
 
 	if (data && size) {
 		if (net_buf_tailroom(buf) < size) {

subsys/bluetooth/host/iso.c

@@ -616,8 +616,7 @@ struct net_buf *bt_iso_get_rx(k_timeout_t timeout)
 	struct net_buf *buf = net_buf_alloc(&iso_rx_pool, timeout);
 
 	if (buf) {
-		net_buf_reserve(buf, BT_BUF_RESERVE);
-		bt_buf_set_type(buf, BT_BUF_ISO_IN);
+		net_buf_add_u8(buf, BT_BUF_ISO_IN);
 	}
 
 	return buf;

subsys/usb/device/class/bluetooth.c

@@ -152,7 +152,7 @@ static void hci_tx_thread(void *p1, void *p2, void *p3)
 			}
 		}
 
-		type = bt_buf_get_type(buf);
+		type = net_buf_pull_u8(buf);
 		switch (type) {
 		case BT_BUF_EVT:
 			usb_transfer_sync(

subsys/usb/device_next/class/bt_hci.c

@@ -207,7 +207,7 @@ static void bt_hci_tx_thread(void *p1, void *p2, void *p3)
 		uint8_t ep;
 
 		bt_buf = k_fifo_get(&bt_hci_tx_queue, K_FOREVER);
-		type = bt_buf_get_type(bt_buf);
+		type = net_buf_pull_u8(bt_buf);
 
 		switch (type) {
 		case BT_BUF_EVT:
@@ -279,7 +279,7 @@ static uint16_t hci_pkt_get_len(struct net_buf *const buf,
 	size_t hdr_len = 0;
 	uint16_t len = 0;
 
-	switch (bt_buf_get_type(buf)) {
+	switch (net_buf_pull_u8(buf)) {
 	case BT_BUF_CMD: {
 		struct bt_hci_cmd_hdr *cmd_hdr;
 

tests/bluetooth/hci_prop_evt/src/main.c

@@ -227,7 +227,7 @@ static int driver_open(const struct device *dev, bt_hci_recv_t recv)
 /*  HCI driver send.  */
 static int driver_send(const struct device *dev, struct net_buf *buf)
 {
-	uint8_t type = bt_buf_get_type(buf);
+	uint8_t type = net_buf_pull_u8(buf);
 
 	zassert_true(type == BT_BUF_CMD, "Expected command buffer, got %u", type);
 

tests/bluetooth/host_long_adv_recv/src/main.c

@@ -242,7 +242,7 @@ static int driver_open(const struct device *dev, bt_hci_recv_t recv)
 /*  HCI driver send.  */
 static int driver_send(const struct device *dev, struct net_buf *buf)
 {
-	uint8_t type = bt_buf_get_type(buf);
+	uint8_t type = net_buf_pull_u8(buf);
 
 	zassert_true(type == BT_BUF_CMD, "Unexpected command buffer, got %u", type);
 

tests/bsim/bluetooth/host/att/pipeline/tester/src/main.c

@@ -78,8 +78,7 @@ struct net_buf *bt_hci_cmd_create(uint16_t opcode, uint8_t param_len)
 
 	LOG_DBG("buf %p", buf);
 
-	net_buf_reserve(buf, BT_BUF_RESERVE);
-	bt_buf_set_type(buf, BT_BUF_CMD);
+	net_buf_add_u8(buf, BT_BUF_CMD);
 
 	hdr = net_buf_add(buf, sizeof(*hdr));
 	hdr->opcode = sys_cpu_to_le16(opcode);
@@ -305,7 +304,7 @@ static void recv(struct net_buf *buf)
 {
 	LOG_HEXDUMP_DBG(buf->data, buf->len, "HCI RX");
 
-	uint8_t type = bt_buf_get_type(buf);
+	uint8_t type = net_buf_pull_u8(buf);
 	uint8_t code = buf->data[0];
 
 	if (type == BT_BUF_EVT) {
@@ -525,7 +524,7 @@ static int send_acl(struct net_buf *buf)
 	hdr->handle = sys_cpu_to_le16(bt_acl_handle_pack(conn_handle, flags));
 	hdr->len = sys_cpu_to_le16(buf->len - sizeof(*hdr));
 
-	bt_buf_set_type(buf, BT_BUF_ACL_OUT);
+	net_buf_push_u8(buf, BT_BUF_ACL_OUT);
 
 	k_sem_take(&acl_pkts, K_FOREVER);
 

tests/bsim/bluetooth/host/att/sequential/tester/src/main.c

@@ -73,8 +73,7 @@ struct net_buf *bt_hci_cmd_create(uint16_t opcode, uint8_t param_len)
 
 	LOG_DBG("buf %p", buf);
 
-	net_buf_reserve(buf, BT_BUF_RESERVE);
-	bt_buf_set_type(buf, BT_BUF_CMD);
+	net_buf_add_u8(buf, BT_BUF_CMD);
 
 	hdr = net_buf_add(buf, sizeof(*hdr));
 	hdr->opcode = sys_cpu_to_le16(opcode);
@@ -282,7 +281,7 @@ static void recv(struct net_buf *buf)
 {
 	LOG_HEXDUMP_DBG(buf->data, buf->len, "HCI RX");
 
-	uint8_t type = bt_buf_get_type(buf);
+	uint8_t type = net_buf_pull_u8(buf);
 	uint8_t code = buf->data[0];
 
 	if (type == BT_BUF_EVT) {
@@ -502,7 +501,7 @@ static int send_acl(struct net_buf *buf)
 	hdr->handle = sys_cpu_to_le16(bt_acl_handle_pack(conn_handle, flags));
 	hdr->len = sys_cpu_to_le16(buf->len - sizeof(*hdr));
 
-	bt_buf_set_type(buf, BT_BUF_ACL_OUT);
+	net_buf_push_u8(buf, BT_BUF_ACL_OUT);
 
 	k_sem_take(&acl_pkts, K_FOREVER);
 

tests/bsim/bluetooth/host/iso/frag/src/broadcaster.c

@@ -232,7 +232,7 @@ void entrypoint_broadcaster(void)
 
 void validate_no_iso_frag(struct net_buf *buf)
 {
-	struct bt_hci_iso_hdr *hci_hdr = (void *)buf->data;
+	struct bt_hci_iso_hdr *hci_hdr = (void *)(buf->data + 1);
 
 	uint16_t handle = sys_le16_to_cpu(hci_hdr->handle);
 	uint8_t flags = bt_iso_flags(handle);
@@ -245,15 +245,11 @@ int __real_bt_send(struct net_buf *buf);
 
 int __wrap_bt_send(struct net_buf *buf)
 {
-	uint8_t type = bt_buf_get_type(buf);
-
 	LOG_HEXDUMP_DBG(buf->data, buf->len, "h->c");
 
-	if (type == BT_BUF_ISO_OUT) {
+	if (buf->data[0] == BT_BUF_ISO_OUT) {
 		validate_no_iso_frag(buf);
 	}
 
-	bt_buf_set_type(buf, type);
-
 	return __real_bt_send(buf);
 }

tests/bsim/bluetooth/host/iso/frag_2/src/broadcaster.c

@@ -269,10 +269,9 @@ int __real_bt_send(struct net_buf *buf);
 
 int __wrap_bt_send(struct net_buf *buf)
 {
-	uint8_t type = bt_buf_get_type(buf);
-	struct bt_hci_iso_hdr *hci_hdr = (void *)buf->data;
+	if (buf->data[0] == BT_BUF_ISO_OUT) {
+		struct bt_hci_iso_hdr *hci_hdr = (void *)(buf->data + 1);
 
-	if (type == BT_BUF_ISO_OUT) {
 		uint16_t handle = sys_le16_to_cpu(hci_hdr->handle);
 		uint8_t flags = bt_iso_flags(handle);
 		uint8_t pb_flag = bt_iso_flags_pb(flags);
@@ -283,7 +282,5 @@ int __wrap_bt_send(struct net_buf *buf)
 		}
 	}
 
-	bt_buf_set_type(buf, type);
-
 	return __real_bt_send(buf);
 }