Bluetooth: Controller: Introduce LL_ASSERT_DBG/ERR

Introduce development and fatal assertion classification
in the Controller implementation.

Signed-off-by: Vinayak Kariappa Chettimada <[email protected]>

Author: cvinayak

subsys/bluetooth/controller/hal/debug.h

@@ -27,6 +27,9 @@ void bt_ctlr_assert_handle(char *file, uint32_t line);
 		BT_ASSERT_MSG(cond, fmt, ##__VA_ARGS__)
 #endif
 
+#define LL_ASSERT_ERR(cond) LL_ASSERT(cond)
+#define LL_ASSERT_DBG(cond) LL_ASSERT(cond)
+
 #if defined(CONFIG_BT_CTLR_ASSERT_VENDOR)
 #define LL_ASSERT_INFO1(cond, param) \
 		BT_ASSERT_VND(cond, param, 0)

subsys/bluetooth/controller/hci/hci.c

@@ -3173,7 +3173,7 @@ static void le_df_connection_iq_report(struct node_rx_pdu *node_rx, struct net_b
 	phy_rx = lll->phy_rx;
 
 	/* Make sure the report is generated for connection on PHY UNCODED */
-	LL_ASSERT(phy_rx != PHY_CODED);
+	LL_ASSERT_DBG(phy_rx != PHY_CODED);
 #else
 	phy_rx = PHY_1M;
 #endif /* CONFIG_BT_CTLR_PHY */
@@ -4363,7 +4363,7 @@ static void le_cis_request(struct pdu_data *pdu_data,
 	 * event.
 	 */
 	node = pdu_data;
-	LL_ASSERT(IS_PTR_ALIGNED(node, struct node_rx_conn_iso_estab));
+	LL_ASSERT_DBG(IS_PTR_ALIGNED(node, struct node_rx_conn_iso_estab));
 
 	req = node;
 	if (!(ll_feat_get() & BIT64(BT_LE_FEAT_BIT_ISO_CHANNELS)) ||
@@ -4410,7 +4410,7 @@ static void le_cis_established(struct pdu_data *pdu_data,
 	 * event.
 	 */
 	node = pdu_data;
-	LL_ASSERT(IS_PTR_ALIGNED(node, struct node_rx_conn_iso_estab));
+	LL_ASSERT_DBG(IS_PTR_ALIGNED(node, struct node_rx_conn_iso_estab));
 
 	est = node;
 	sep->status = est->status;
@@ -4469,7 +4469,7 @@ static void le_per_adv_sync_transfer_received(struct pdu_data *pdu_data_rx,
 	 * event.
 	 */
 	node = pdu_data_rx;
-	LL_ASSERT(IS_PTR_ALIGNED(node, struct node_rx_past_received));
+	LL_ASSERT_DBG(IS_PTR_ALIGNED(node, struct node_rx_past_received));
 
 	se = node;
 	sep->status = se->rx_sync.status;
@@ -5460,7 +5460,7 @@ static void vs_le_df_connection_iq_report(struct node_rx_pdu *node_rx, struct ne
 	phy_rx = lll->phy_rx;
 
 	/* Make sure the report is generated for connection on PHY UNCODED */
-	LL_ASSERT(phy_rx != PHY_CODED);
+	LL_ASSERT_DBG(phy_rx != PHY_CODED);
 #else
 	phy_rx = PHY_1M;
 #endif /* CONFIG_BT_CTLR_PHY */
@@ -6240,7 +6240,7 @@ int hci_iso_handle(struct net_buf *buf, struct net_buf **evt)
 
 		/* Start Fragmentation */
 		/* FIXME: need to ensure ISO-AL returns proper isoal_status.
-		 * Currently there are cases where ISO-AL calls LL_ASSERT.
+		 * Currently there are cases where ISO-AL calls LL_ASSERT_ERR.
 		 */
 		isoal_status_t isoal_status =
 			isoal_tx_sdu_fragment(stream->dp->source_hdl, &sdu_frag_tx);
@@ -6494,7 +6494,7 @@ static inline void le_dir_adv_report(struct pdu_adv *adv, struct net_buf *buf,
 		return;
 	}
 
-	LL_ASSERT(adv->type == PDU_ADV_TYPE_DIRECT_IND);
+	LL_ASSERT_DBG(adv->type == PDU_ADV_TYPE_DIRECT_IND);
 
 #if CONFIG_BT_CTLR_DUP_FILTER_LEN > 0
 	if (dup_scan &&
@@ -6564,7 +6564,7 @@ static inline void le_mesh_scan_report(struct pdu_adv *adv,
 	uint32_t instant;
 	uint8_t chan;
 
-	LL_ASSERT(adv->type == PDU_ADV_TYPE_NONCONN_IND);
+	LL_ASSERT_DBG(adv->type == PDU_ADV_TYPE_NONCONN_IND);
 
 	/* Filter based on currently active Scan Filter */
 	if (sf_curr < ARRAY_SIZE(scan_filters) &&
@@ -7033,7 +7033,7 @@ static void ext_adv_pdu_frag(uint8_t evt_type, uint8_t phy, uint8_t sec_phy,
 		*data_len_total -= data_len_frag;
 
 		*evt_buf = bt_buf_get_rx(BT_BUF_EVT, BUF_GET_TIMEOUT);
-		LL_ASSERT(*evt_buf);
+		LL_ASSERT_ERR(*evt_buf);
 
 		net_buf_frag_add(buf, *evt_buf);
 
@@ -7570,7 +7570,7 @@ static void le_ext_adv_report(struct pdu_data *pdu_data,
 	 * event.
 	 */
 	evt_buf = bt_buf_get_rx(BT_BUF_EVT, BUF_GET_TIMEOUT);
-	LL_ASSERT(evt_buf);
+	LL_ASSERT_ERR(evt_buf);
 
 	net_buf_frag_add(buf, evt_buf);
 
@@ -7666,7 +7666,7 @@ static void le_per_adv_sync_established(struct pdu_data *pdu_data,
 	 * event.
 	 */
 	node = pdu_data;
-	LL_ASSERT(IS_PTR_ALIGNED(node, struct node_rx_sync));
+	LL_ASSERT_DBG(IS_PTR_ALIGNED(node, struct node_rx_sync));
 
 	se = node;
 	sep->status = se->status;
@@ -7946,7 +7946,7 @@ static void le_per_adv_sync_report(struct pdu_data *pdu_data,
 				data_status = BT_HCI_LE_ADV_EVT_TYPE_DATA_STATUS_PARTIAL;
 
 				evt_buf = bt_buf_get_rx(BT_BUF_EVT, BUF_GET_TIMEOUT);
-				LL_ASSERT(evt_buf);
+				LL_ASSERT_ERR(evt_buf);
 
 				net_buf_frag_add(buf, evt_buf);
 
@@ -8002,7 +8002,7 @@ static void le_per_adv_sync_report(struct pdu_data *pdu_data,
 		 */
 		if (!evt_buf) {
 			evt_buf = bt_buf_get_rx(BT_BUF_EVT, BUF_GET_TIMEOUT);
-			LL_ASSERT(evt_buf);
+			LL_ASSERT_ERR(evt_buf);
 
 			net_buf_frag_add(buf, evt_buf);
 		}
@@ -8087,7 +8087,7 @@ static void le_big_sync_established(struct pdu_data *pdu,
 	 * established event.
 	 */
 	node = pdu;
-	LL_ASSERT(IS_PTR_ALIGNED(node, struct node_rx_sync_iso));
+	LL_ASSERT_DBG(IS_PTR_ALIGNED(node, struct node_rx_sync_iso));
 
 	se = node;
 	sep->status = se->status;
@@ -8391,7 +8391,7 @@ static void le_conn_complete(struct pdu_data *pdu_data, uint16_t handle,
 	 * complete event.
 	 */
 	node = pdu_data;
-	LL_ASSERT(IS_PTR_ALIGNED(node, struct node_rx_cc));
+	LL_ASSERT_DBG(IS_PTR_ALIGNED(node, struct node_rx_cc));
 
 	cc = node;
 	status = cc->status;
@@ -8528,7 +8528,7 @@ static void le_conn_update_complete(struct pdu_data *pdu_data, uint16_t handle,
 	 * update complete event.
 	 */
 	node = pdu_data;
-	LL_ASSERT(IS_PTR_ALIGNED(node, struct node_rx_cu));
+	LL_ASSERT_DBG(IS_PTR_ALIGNED(node, struct node_rx_cu));
 
 	cu = node;
 	sep->status = cu->status;
@@ -8763,7 +8763,7 @@ static void encode_control(struct node_rx_pdu *node_rx,
 #elif defined(CONFIG_BT_CTLR_VS_SCAN_REQ_RX)
 		le_vs_scan_req_received(pdu_data, node_rx, buf);
 #else
-		LL_ASSERT(0);
+		LL_ASSERT_DBG(0);
 #endif /* CONFIG_BT_CTLR_ADV_EXT */
 		break;
 #endif /* CONFIG_BT_CTLR_SCAN_REQ_NOTIFY */
@@ -8896,7 +8896,7 @@ static void encode_control(struct node_rx_pdu *node_rx,
 #endif /* CONFIG_BT_CTLR_USER_EVT_RANGE > 0 */
 
 	default:
-		LL_ASSERT(0);
+		LL_ASSERT_DBG(0);
 		return;
 	}
 }
@@ -9124,7 +9124,7 @@ static void encode_data_ctrl(struct node_rx_pdu *node_rx,
 		break;
 
 	default:
-		LL_ASSERT(0);
+		LL_ASSERT_DBG(0);
 		return;
 	}
 }
@@ -9155,20 +9155,20 @@ void hci_acl_encode(struct node_rx_pdu *node_rx, struct net_buf *buf)
 		memcpy(data, pdu_data->lldata, pdu_data->len);
 #if defined(CONFIG_BT_HCI_ACL_FLOW_CONTROL)
 		if (hci_hbuf_total > 0) {
-			LL_ASSERT((hci_hbuf_sent - hci_hbuf_acked) <
+			LL_ASSERT_DBG((hci_hbuf_sent - hci_hbuf_acked) <
 				  hci_hbuf_total);
 			hci_hbuf_sent++;
 			/* Note: This requires linear handle values starting
 			 * from 0
 			 */
-			LL_ASSERT(handle < ARRAY_SIZE(hci_hbuf_pend));
+			LL_ASSERT_DBG(handle < ARRAY_SIZE(hci_hbuf_pend));
 			hci_hbuf_pend[handle]++;
 		}
 #endif /* CONFIG_BT_HCI_ACL_FLOW_CONTROL */
 		break;
 
 	default:
-		LL_ASSERT(0);
+		LL_ASSERT_DBG(0);
 		break;
 	}
 }

subsys/bluetooth/controller/hci/hci_driver.c

@@ -91,21 +91,20 @@ isoal_status_t sink_sdu_alloc_hci(const struct isoal_sink    *sink_ctx,
 				  const struct isoal_pdu_rx  *valid_pdu,
 				  struct isoal_sdu_buffer    *sdu_buffer)
 {
+	struct net_buf *buf;
+
 	ARG_UNUSED(sink_ctx);
 	ARG_UNUSED(valid_pdu); /* TODO copy valid pdu into netbuf ? */
 
-	struct net_buf *buf  = bt_buf_get_rx(BT_BUF_ISO_IN, K_FOREVER);
+	buf = bt_buf_get_rx(BT_BUF_ISO_IN, K_FOREVER);
+	LL_ASSERT_ERR(buf);
 
-	if (buf) {
-		/* Increase reserved space for headers */
-		net_buf_reset(buf);
-		net_buf_reserve(buf, BT_BUF_RESERVE + SDU_HCI_HDR_SIZE);
-
-		sdu_buffer->dbuf = buf;
-		sdu_buffer->size = net_buf_tailroom(buf);
-	} else {
-		LL_ASSERT(0);
-	}
+	/* Increase reserved space for headers */
+	net_buf_reset(buf);
+	net_buf_reserve(buf, BT_BUF_RESERVE + SDU_HCI_HDR_SIZE);
+
+	sdu_buffer->dbuf = buf;
+	sdu_buffer->size = net_buf_tailroom(buf);
 
 	return ISOAL_STATUS_OK;
 }
@@ -212,11 +211,13 @@ isoal_status_t sink_sdu_write_hci(void *dbuf,
 				  const uint8_t *pdu_payload,
 				  const size_t consume_len)
 {
+	struct net_buf *buf;
+
 	ARG_UNUSED(sdu_written);
 
-	struct net_buf *buf = (struct net_buf *) dbuf;
+	buf = (struct net_buf *) dbuf;
+	LL_ASSERT_ERR(buf);
 
-	LL_ASSERT(buf);
 	net_buf_add_mem(buf, pdu_payload, consume_len);
 
 	return ISOAL_STATUS_OK;
@@ -364,7 +365,7 @@ static void prio_recv_thread(void *p1, void *p2, void *p3)
 			LOG_DBG("Num Complete: 0x%04x:%u", handle, num_cmplt);
 
 			err = bt_recv_prio(dev, buf);
-			LL_ASSERT(err == 0);
+			LL_ASSERT_DBG(err == 0);
 
 			k_yield();
 #endif /* CONFIG_BT_CONN || CONFIG_BT_CTLR_ADV_ISO */
@@ -392,7 +393,7 @@ static void prio_recv_thread(void *p1, void *p2, void *p3)
 				}
 
 				err = bt_recv_prio(dev, buf);
-				LL_ASSERT(err == 0);
+				LL_ASSERT_DBG(err == 0);
 
 				/* bt_recv_prio would not release normal evt
 				 * buf.
@@ -470,7 +471,7 @@ static void node_rx_recv(const struct device *dev)
 #if defined(CONFIG_BT_CONN) || defined(CONFIG_BT_CTLR_ADV_ISO)
 			struct net_buf *buf;
 
-			LL_ASSERT(node_rx == NULL);
+			LL_ASSERT_DBG(node_rx == NULL);
 
 			buf = bt_buf_get_evt(BT_HCI_EVT_NUM_COMPLETED_PACKETS,
 					     false, K_FOREVER);
@@ -482,7 +483,7 @@ static void node_rx_recv(const struct device *dev)
 			k_yield();
 
 #else /* !CONFIG_BT_CONN && !CONFIG_BT_CTLR_ADV_ISO */
-			LL_ASSERT(0);
+			LL_ASSERT_DBG(0);
 #endif /* !CONFIG_BT_CONN && !CONFIG_BT_CTLR_ADV_ISO */
 
 			num_cmplt = ll_rx_get((void *)&node_rx, &handle);
@@ -588,7 +589,7 @@ static inline struct net_buf *encode_node(struct node_rx_pdu *node_rx,
 						isoal_rx_pdu_recombine(dp->sink_hdl, &pckt_meta);
 
 					/* TODO handle err */
-					LL_ASSERT(err == ISOAL_STATUS_OK);
+					LL_ASSERT_ERR(err == ISOAL_STATUS_OK);
 				}
 			}
 #endif /* CONFIG_BT_CTLR_CONN_ISO */
@@ -612,13 +613,13 @@ static inline struct net_buf *encode_node(struct node_rx_pdu *node_rx,
 				isoal_rx.pdu = (void *)node_rx->pdu;
 				err = isoal_rx_pdu_recombine(stream->dp->sink_hdl, &isoal_rx);
 
-				LL_ASSERT(err == ISOAL_STATUS_OK ||
-					  err == ISOAL_STATUS_ERR_SDU_ALLOC);
+				LL_ASSERT_ERR(err == ISOAL_STATUS_OK ||
+					      err == ISOAL_STATUS_ERR_SDU_ALLOC);
 			}
 #endif /* CONFIG_BT_CTLR_SYNC_ISO */
 
 		} else {
-			LL_ASSERT(0);
+			LL_ASSERT_DBG(0);
 		}
 
 		node_rx->hdr.next = NULL;
@@ -629,7 +630,7 @@ static inline struct net_buf *encode_node(struct node_rx_pdu *node_rx,
 #endif /* CONFIG_BT_CTLR_SYNC_ISO || CONFIG_BT_CTLR_CONN_ISO */
 
 	default:
-		LL_ASSERT(0);
+		LL_ASSERT_DBG(0);
 		break;
 	}
 
@@ -667,7 +668,7 @@ static inline struct net_buf *process_node(struct node_rx_pdu *node_rx)
 			}
 			break;
 		default:
-			LL_ASSERT(0);
+			LL_ASSERT_DBG(0);
 			break;
 		}
 	}
@@ -740,7 +741,7 @@ static inline struct net_buf *process_hbuf(struct node_rx_pdu *n)
 	case HCI_CLASS_EVT_DISCARDABLE:
 	case HCI_CLASS_EVT_REQUIRED:
 	default:
-		LL_ASSERT(0);
+		LL_ASSERT_DBG(0);
 		break;
 	}
 
@@ -822,7 +823,7 @@ static void recv_thread(void *p1, void *p2, void *p3)
 		int err;
 
 		err = k_poll(events, ARRAY_SIZE(events), K_FOREVER);
-		LL_ASSERT(err == 0 || err == -EINTR);
+		LL_ASSERT_ERR(err == 0 || err == -EINTR);
 
 		if (false) {
 
@@ -834,7 +835,7 @@ static void recv_thread(void *p1, void *p2, void *p3)
 #if !defined(CONFIG_BT_CTLR_RX_PRIO_STACK_SIZE)
 		} else if (events[EVENT_SEM].state == K_POLL_STATE_SEM_AVAILABLE) {
 			err = k_sem_take(events[EVENT_SEM].sem, K_NO_WAIT);
-			LL_ASSERT(err == 0);
+			LL_ASSERT_DBG(err == 0);
 
 			node_rx_recv(dev);
 #endif /* !CONFIG_BT_CTLR_RX_PRIO_STACK_SIZE */
@@ -1046,7 +1047,7 @@ static int hci_driver_close(const struct device *dev)
 
 	/* Resetting the LL stops all roles */
 	err = ll_deinit();
-	LL_ASSERT(!err);
+	LL_ASSERT_DBG(!err);
 
 #if defined(CONFIG_BT_CTLR_RX_PRIO_STACK_SIZE)
 	/* Abort prio RX thread */