bluetooth: ble_adv_data: add manufacturer data find helper

Add ble_adv_data_manufacturer_data_find() to locate
manufacturer-specific data in an advertising payload and prefix-match
it against a target value. Follows the pattern of existing _find
helpers for name, uuid and appearance.

Modified unit tests to align with changes.
Added changelog.

Signed-off-by: Martynas Smilingis <martynas.smilingis@nordicsemi.no>

Author: PizzaAllTheWay

doc/nrf-bm/release_notes/release_notes_changelog.rst

@@ -81,6 +81,10 @@ Libraries
       * An issue where the :c:func:`ble_conn_params_phy_radio_mode_get` function would incorrectly return the PHY mode mask of a pending update rather than the currently active PHY mode if a PHY update initiated by the :c:func:`ble_conn_params_phy_radio_mode_set` function was still in progress.
       * An issue where the SoftDevice define :c:macro:`BLE_GAP_PHYS_SUPPORTED` was used instead of the PHY preferences set with Kconfig when initiating or responding to a PHY update procedure.
 
+* :ref:`lib_ble_adv` library:
+
+   * Added the :c:func:`ble_adv_data_manufacturer_data_find` function to locate manufacturer-specific data in an advertising payload and prefix-match it against a target value.
+
 Bluetooth LE Services
 ---------------------
 

include/bm/bluetooth/ble_adv_data.h

@@ -308,6 +308,23 @@ bool ble_adv_data_uuid_find(const uint8_t *buf, uint16_t len, const ble_uuid_t *
  */
 bool ble_adv_data_appearance_find(const uint8_t *buf, uint16_t len, const uint16_t *appearance);
 
+/**
+ * @brief Search encoded Advertising data for manufacturer-specific data.
+ *
+ * @param[in] buf Encoded advertising data.
+ * @param[in] len Buffer length.
+ * @param[in] target_data Target manufacturer data to match (prefix). Starts with the
+ *                        2-byte little-endian company identifier followed by optional
+ *                        vendor payload.
+ * @param[in] target_data_len Length of the target manufacturer data.
+ *
+ * @retval true  If manufacturer-specific data in which the first @p target_data_len bytes matches
+ *               @p target_data was found among @p buf.
+ * @retval false If no match was found among @p buf, or if @p buf or @p target_data was @c NULL.
+ */
+bool ble_adv_data_manufacturer_data_find(const uint8_t *buf, uint16_t len,
+					 const uint8_t *target_data, uint8_t target_data_len);
+
 #ifdef __cplusplus
 }
 #endif

lib/bluetooth/ble_adv/ble_adv_data.c

@@ -742,3 +742,32 @@ bool ble_adv_data_appearance_find(const uint8_t *data, uint16_t data_len,
 
 	return false;
 }
+
+bool ble_adv_data_manufacturer_data_find(const uint8_t *data, uint16_t data_len,
+					 const uint8_t *target_data, uint8_t target_data_len)
+{
+	uint16_t data_offset;
+	uint16_t parsed_len;
+
+	if (!data || !target_data || target_data_len == 0) {
+		return false;
+	}
+
+	data_offset = 0;
+	parsed_len = ble_adv_data_search(data, data_len, &data_offset,
+					 BLE_GAP_AD_TYPE_MANUFACTURER_SPECIFIC_DATA);
+
+	if (data_offset == 0 || parsed_len == 0) {
+		return false;
+	}
+
+	if (target_data_len > parsed_len) {
+		return false;
+	}
+
+	if (memcmp(&data[data_offset], target_data, target_data_len) == 0) {
+		return true;
+	}
+
+	return false;
+}

tests/unit/lib/bluetooth/ble_adv_data/src/unity_test.c

@@ -196,11 +196,17 @@ static void encode_128bit_uuid_test_data(void)
 	 */
 	uint32_t nrf_err;
 	ble_uuid_t uuids[] = {
-		{.uuid = TEST_UUID_128_VAL, .type = TEST_UUID_128_TYPE},
+		{
+			.uuid = TEST_UUID_128_VAL,
+			.type = TEST_UUID_128_TYPE
+		},
 	};
 	struct ble_adv_data adv_data = {
 		.flags = BLE_GAP_ADV_FLAGS_LE_ONLY_GENERAL_DISC_MODE,
-		.uuid_lists.complete = {.uuid = uuids, .len = 1},
+		.uuid_lists.complete = {
+			.uuid = uuids,
+			.len = 1
+		},
 	};
 
 	__cmock_sd_ble_uuid_encode_Stub(stub_uuid_encode);
@@ -209,6 +215,30 @@ static void encode_128bit_uuid_test_data(void)
 	TEST_ASSERT_EQUAL(NRF_SUCCESS, nrf_err);
 }
 
+static void encode_manufacturer_test_data(const uint8_t *payload, uint8_t payload_len)
+{
+	/*
+	 * Separate from common_test_data_encode() because that does not encode a
+	 * manufacturer-specific data AD field, which is required to test
+	 * ble_adv_data_manufacturer_data_find(). This encodes the Nordic company
+	 * identifier followed by an optional caller-provided payload as a
+	 * MANUFACTURER_SPECIFIC_DATA AD field.
+	 */
+	uint32_t nrf_err;
+	struct ble_adv_data_manufacturer manuf = {
+		.company_identifier = BLE_COMPANY_ID_NORDIC,
+		.data = (uint8_t *)payload,
+		.len = payload_len,
+	};
+	struct ble_adv_data adv_data = {
+		.flags = BLE_GAP_ADV_FLAGS_LE_ONLY_GENERAL_DISC_MODE,
+		.manufacturer_data = &manuf,
+	};
+
+	nrf_err = ble_adv_data_encode(&adv_data, buf, &len);
+	TEST_ASSERT_EQUAL(NRF_SUCCESS, nrf_err);
+}
+
 /* ble_adv_data_encode() => Generic Unit Tests */
 void test_ble_adv_data_encode_error_null(void)
 {
@@ -1944,6 +1974,152 @@ void test_ble_adv_data_appearance_find_zero_length_data(void)
 	TEST_ASSERT_FALSE(found);
 }
 
+/* ble_adv_data_manufacturer_data_find() Unit Tests */
+void test_ble_adv_data_manufacturer_data_find_company_id_only(void)
+{
+	/* Encoded manufacturer data contains only the company ID,
+	 * search with the same 2-byte company ID matches.
+	 */
+	bool found;
+	const uint8_t target[] = {0x59, 0x00}; /* Nordic company ID, little-endian */
+
+	encode_manufacturer_test_data(NULL, 0);
+
+	found = ble_adv_data_manufacturer_data_find(buf, len, target, sizeof(target));
+	TEST_ASSERT_TRUE(found);
+}
+
+void test_ble_adv_data_manufacturer_data_find_full_match(void)
+{
+	/* Exact match of company ID + full payload. */
+	bool found;
+	const uint8_t payload[] = {0xDE, 0xAD, 0xBE, 0xEF};
+	const uint8_t target[] = {0x59, 0x00, 0xDE, 0xAD, 0xBE, 0xEF};
+
+	encode_manufacturer_test_data(payload, sizeof(payload));
+
+	found = ble_adv_data_manufacturer_data_find(buf, len, target, sizeof(target));
+	TEST_ASSERT_TRUE(found);
+}
+
+void test_ble_adv_data_manufacturer_data_find_prefix_match(void)
+{
+	/* Target is a prefix of the encoded manufacturer data, prefix match succeeds. */
+	bool found;
+	const uint8_t payload[] = {0xDE, 0xAD, 0xBE, 0xEF};
+	const uint8_t target[] = {0x59, 0x00, 0xDE, 0xAD};
+
+	encode_manufacturer_test_data(payload, sizeof(payload));
+
+	found = ble_adv_data_manufacturer_data_find(buf, len, target, sizeof(target));
+	TEST_ASSERT_TRUE(found);
+}
+
+void test_ble_adv_data_manufacturer_data_find_wrong_company_id(void)
+{
+	/* Different company ID, no match. */
+	bool found;
+	const uint8_t payload[] = {0xDE, 0xAD};
+	const uint8_t target[] = {0x4C, 0x00, 0xDE, 0xAD}; /* Random company ID */
+
+	encode_manufacturer_test_data(payload, sizeof(payload));
+
+	found = ble_adv_data_manufacturer_data_find(buf, len, target, sizeof(target));
+	TEST_ASSERT_FALSE(found);
+}
+
+void test_ble_adv_data_manufacturer_data_find_wrong_payload(void)
+{
+	/* Company ID matches but payload differs. */
+	bool found;
+	const uint8_t payload[] = {0xDE, 0xAD, 0xBE, 0xEF};
+	const uint8_t target[] = {0x59, 0x00, 0x12, 0x34};
+
+	encode_manufacturer_test_data(payload, sizeof(payload));
+
+	found = ble_adv_data_manufacturer_data_find(buf, len, target, sizeof(target));
+	TEST_ASSERT_FALSE(found);
+}
+
+void test_ble_adv_data_manufacturer_data_find_target_longer_than_encoded(void)
+{
+	/* Target length exceeds encoded manufacturer data length. */
+	bool found;
+	const uint8_t payload[] = {0xDE, 0xAD};
+	const uint8_t target[] = {0x59, 0x00, 0xDE, 0xAD, 0xBE, 0xEF};
+
+	encode_manufacturer_test_data(payload, sizeof(payload));
+
+	found = ble_adv_data_manufacturer_data_find(buf, len, target, sizeof(target));
+	TEST_ASSERT_FALSE(found);
+}
+
+void test_ble_adv_data_manufacturer_data_find_no_manuf_data_in_data(void)
+{
+	/* Encoded data has no manufacturer-specific data AD field. */
+	bool found;
+	const uint8_t target[] = {0x59, 0x00};
+
+	common_test_data_encode();
+
+	found = ble_adv_data_manufacturer_data_find(buf, len, target, sizeof(target));
+	TEST_ASSERT_FALSE(found);
+}
+
+void test_ble_adv_data_manufacturer_data_find_null_data(void)
+{
+	const uint8_t target[] = {0x59, 0x00};
+
+	bool found = ble_adv_data_manufacturer_data_find(NULL, 10, target, sizeof(target));
+
+	TEST_ASSERT_FALSE(found);
+}
+
+void test_ble_adv_data_manufacturer_data_find_null_target(void)
+{
+	bool found;
+
+	encode_manufacturer_test_data(NULL, 0);
+
+	found = ble_adv_data_manufacturer_data_find(buf, len, NULL, 2);
+	TEST_ASSERT_FALSE(found);
+}
+
+void test_ble_adv_data_manufacturer_data_find_zero_target_len(void)
+{
+	bool found;
+	const uint8_t target[] = {0x59, 0x00};
+
+	encode_manufacturer_test_data(NULL, 0);
+
+	found = ble_adv_data_manufacturer_data_find(buf, len, target, 0);
+	TEST_ASSERT_FALSE(found);
+}
+
+void test_ble_adv_data_manufacturer_data_find_zero_length_data(void)
+{
+	const uint8_t target[] = {0x59, 0x00};
+
+	bool found = ble_adv_data_manufacturer_data_find(buf, 0, target, sizeof(target));
+
+	TEST_ASSERT_FALSE(found);
+}
+
+void test_ble_adv_data_manufacturer_data_find_only_other_ad_types(void)
+{
+	/* Encoded data contains appearance, flags, tx_power, UUID, conn_int and name
+	 * but no manufacturer-specific data AD field. Searching for manufacturer data
+	 * should not match any of the other AD fields.
+	 */
+	bool found;
+	const uint8_t target[] = {0x59, 0x00};
+
+	common_test_data_encode();
+
+	found = ble_adv_data_manufacturer_data_find(buf, len, target, sizeof(target));
+	TEST_ASSERT_FALSE(found);
+}
+
 /* Unit Test Setup */
 void setUp(void)
 {