[nrf fromtree] 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]>
(cherry picked from commit 796c000)
Signed-off-by: Vinayak Kariappa Chettimada <[email protected]>

Author: cvinayak

subsys/bluetooth/controller/Kconfig

@@ -1190,6 +1190,18 @@ rsource "Kconfig.df"
 rsource "Kconfig.ll_sw_split"
 rsource "Kconfig.dtm"
 
+config BT_CTLR_ASSERT_DEBUG
+	bool "Development asserts"
+	default y
+	help
+	  This option enables development asserts used for code coverage.
+
+	  The Controller will continue to function without memory leak or corruption with these
+	  assertion checks disabled. Example, run-time mis-aligned memory access etc. which do
+	  otherwise implicitly cause CPU fault during development testing. But these type of
+	  asserted are essentially required for debugging, code and unit test coverage during
+	  development cycle.
+
 config BT_CTLR_ASSERT_HANDLER
 	bool "Application Defined Assertion Handler"
 	help

subsys/bluetooth/controller/hal/debug.h

@@ -27,6 +27,25 @@ void bt_ctlr_assert_handle(char *file, uint32_t line);
 		BT_ASSERT_MSG(cond, fmt, ##__VA_ARGS__)
 #endif
 
+/* Fatal asserts.
+ * The Controller will otherwise misbehave causing memory leak or system-wide memory corruptions due
+ * to uncontrolled DMA transfers etc.
+ * It is not safe to disable these assertion checks.
+ */
+#define LL_ASSERT_ERR(cond) LL_ASSERT(cond)
+
+/* Development asserts.
+ * The Controller will continue to function without memory leak or corruption with these assertion
+ * checks disabled. Example, run-time mis-aligned memory access etc. which do otherwise implicitly
+ * cause CPU fault during development testing. But these type of asserted are essentially required
+ * for debugging, code and unit test coverage during development cycle.
+ */
+#if defined(CONFIG_BT_CTLR_ASSERT_DEBUG)
+#define LL_ASSERT_DBG(cond) LL_ASSERT(cond)
+#else /* !CONFIG_BT_CTLR_ASSERT_DEBUG */
+#define LL_ASSERT_DBG(cond) ARG_UNUSED((cond))
+#endif /* !CONFIG_BT_CTLR_ASSERT_DEBUG */
+
 #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

@@ -3222,7 +3222,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 */
@@ -4412,7 +4412,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)) ||
@@ -4459,7 +4459,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;
@@ -4518,7 +4518,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;
@@ -5520,7 +5520,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 */
@@ -6300,7 +6300,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);
@@ -6554,7 +6554,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 &&
@@ -6624,7 +6624,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) &&
@@ -7093,7 +7093,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);
 
@@ -7630,7 +7630,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);
 
@@ -7726,7 +7726,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;
@@ -8006,7 +8006,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);
 
@@ -8062,7 +8062,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);
 		}
@@ -8147,7 +8147,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;
@@ -8451,7 +8451,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;
@@ -8588,7 +8588,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;
@@ -8845,7 +8845,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 */
@@ -8984,7 +8984,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;
 	}
 }
@@ -9212,7 +9212,7 @@ static void encode_data_ctrl(struct node_rx_pdu *node_rx,
 		break;
 
 	default:
-		LL_ASSERT(0);
+		LL_ASSERT_DBG(0);
 		return;
 	}
 }
@@ -9243,20 +9243,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;
 	}
 }