bluetooth: ble_scan: add manufacturer data filter support

Port the manufacturer data scan filter from NCS to Bare Metal. Adds
BLE_SCAN_MANUFACTURER_DATA_FILTER type, manufacturer_data_filter_match
flag in ble_scan_filter_match, and plumbing through
ble_scan_filter_add, ble_scan_filters_enable, ble_scan_filters_disable,
ble_scan_all_filter_remove and the adv report event handler.

New Kconfig options:
  - CONFIG_BLE_SCAN_MANUFACTURER_DATA_COUNT
  - CONFIG_BLE_SCAN_MANUFACTURER_DATA_MAX_LEN

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

@@ -78,6 +78,14 @@ Libraries
 
    * 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.
 
+* :ref:`lib_ble_scan` library:
+
+   * Added:
+
+      * The :c:struct:`ble_scan_filter_data` structure as input to the :c:func:`ble_scan_filter_add` function.
+      * Support for filtering by manufacturer-specific data using the :c:macro:`BLE_SCAN_MANUFACTURER_DATA_FILTER` filter type.
+      * The :kconfig:option:`CONFIG_BLE_SCAN_MANUFACTURER_DATA_COUNT` and :kconfig:option:`CONFIG_BLE_SCAN_MANUFACTURER_DATA_MAX_LEN` Kconfig options to configure the manufacturer data filter capacity and maximum payload length.
+
 Bluetooth LE Services
 ---------------------
 

include/bm/bluetooth/ble_scan.h

@@ -107,6 +107,8 @@ enum ble_scan_evt_type {
 #define BLE_SCAN_APPEARANCE_FILTER (0x08)
 /** Filters the device short name. */
 #define BLE_SCAN_SHORT_NAME_FILTER (0x10)
+/** Filters the manufacturer data. */
+#define BLE_SCAN_MANUFACTURER_DATA_FILTER (0x20)
 /** @} */
 
 /**
@@ -137,6 +139,13 @@ struct ble_scan_filter_data {
 			/** Minimum length of the short name to be matched. */
 			uint8_t short_name_min_len;
 		} short_name_filter;
+		/** Manufacturer filter data */
+		struct {
+			/** Pointer to the manufacturer data. */
+			uint8_t *data;
+			/** Manufacturer data length. */
+			uint8_t data_len;
+		} manufacturer_data_filter;
 	};
 };
 
@@ -154,6 +163,8 @@ struct ble_scan_filter_match {
 	uint8_t appearance_filter_match: 1;
 	/** Set to 1 if short name filter is matched. */
 	uint8_t short_name_filter_match: 1;
+	/** Set to 1 if manufacturer data filter is matched. */
+	uint8_t manufacturer_data_filter_match: 1;
 };
 
 /**
@@ -292,6 +303,22 @@ struct ble_scan_appearance_filter {
 	bool appearance_filter_enabled;
 };
 
+/** Scan manufacturer data filter. */
+struct ble_scan_manufacturer_data_filter {
+	struct {
+		/** Manufacturer data that the main application will scan for, and that will be
+		 *  advertised by the peripherals.
+		 */
+		uint8_t data[CONFIG_BLE_SCAN_MANUFACTURER_DATA_MAX_LEN];
+		/** Length of the manufacturer data. */
+		uint8_t data_len;
+	} manufacturer_data[CONFIG_BLE_SCAN_MANUFACTURER_DATA_COUNT];
+	/** Number of manufacturer data in list. */
+	uint8_t manufacturer_data_cnt;
+	/** Flag to inform about enabling or disabling this filter. */
+	bool manufacturer_data_filter_enabled;
+};
+
 /**
  * @brief Filter data.
  *
@@ -321,6 +348,10 @@ struct ble_scan_filters {
 #if CONFIG_BLE_SCAN_APPEARANCE_COUNT > 0
 	/** Appearance filter data. */
 	struct ble_scan_appearance_filter appearance_filter;
+#endif
+#if CONFIG_BLE_SCAN_MANUFACTURER_DATA_COUNT > 0
+	/** Manufacturer filter data. */
+	struct ble_scan_manufacturer_data_filter manufacturer_data_filter;
 #endif
 	/** Filter mode. If true, all set filters must be matched to generate an event. */
 	bool all_filters_mode;
@@ -518,8 +549,9 @@ uint32_t ble_scan_filter_get(const struct ble_scan *scan, struct ble_scan_filter
  *          This function adds a new filter by type @ref ble_scan_filter_type.
  *          The filter will be added if the number of filters of a given type does not exceed @ref
  *          CONFIG_BLE_SCAN_UUID_COUNT, @ref CONFIG_BLE_SCAN_NAME_COUNT, @ref
- *          CONFIG_BLE_SCAN_ADDRESS_COUNT, or @ref CONFIG_BLE_SCAN_APPEARANCE_COUNT, depending on
- *          the filter type, and if the same filter has not already been set.
+ *          CONFIG_BLE_SCAN_ADDRESS_COUNT, @ref CONFIG_BLE_SCAN_APPEARANCE_COUNT,
+ *          or @ref BLE_SCAN_MANUFACTURER_DATA_COUNT, depending on the filter type,
+ *          and if the same filter has not already been set.
  *
  * @param[in,out] scan Scan library instance.
  * @param[in] type Filter type.

lib/bluetooth/ble_scan/Kconfig

@@ -30,6 +30,12 @@ config BLE_SCAN_SHORT_NAME_MAX_LEN
 	help
 	  Maximum size of the short name to search for in the advertisement report.
 
+config BLE_SCAN_MANUFACTURER_DATA_MAX_LEN
+	int "Scan manufacturer data maximum length"
+	default 32
+	help
+	  Maximum size for the manufacturer data to search in the advertisement report.
+
 config BLE_SCAN_FILTER
 	bool "Scan filter"
 	default y
@@ -68,6 +74,12 @@ config BLE_SCAN_UUID_COUNT
 	help
 	  Maximum number of filters for UUIDs.
 
+config BLE_SCAN_MANUFACTURER_DATA_COUNT
+	int "Scan manufacturer data count"
+	default 0
+	help
+	  Maximum number of manufacturer data filters.
+
 endif # BLE_SCAN_FILTER
 
 config BLE_SCAN_INTERVAL

lib/bluetooth/ble_scan/ble_scan.c

@@ -362,6 +362,68 @@ static int appearance_filter_add(struct ble_scan *scan, const struct ble_scan_fi
 }
 #endif /* CONFIG_BLE_SCAN_APPEARANCE_COUNT */
 
+#if (CONFIG_BLE_SCAN_MANUFACTURER_DATA_COUNT > 0)
+static bool adv_manufacturer_data_compare(const struct ble_scan *scan,
+					  uint8_t *data, uint16_t len)
+{
+	const struct ble_scan_manufacturer_data_filter *md_filter =
+	&scan->scan_filters.manufacturer_data_filter;
+
+	/* Match the adv packet against each configured manufacturer data filter. */
+	for (uint8_t i = 0; i < md_filter->manufacturer_data_cnt; i++) {
+		if (ble_adv_data_manufacturer_data_find(data, len,
+							md_filter->manufacturer_data[i].data,
+							md_filter->manufacturer_data[i].data_len)) {
+			return true;
+		}
+	}
+	return false;
+}
+
+static int manufacturer_data_filter_add(struct ble_scan *scan,
+					const struct ble_scan_filter_data *data)
+{
+	struct ble_scan_manufacturer_data_filter *md_filter =
+	&scan->scan_filters.manufacturer_data_filter;
+	uint8_t *counter = &md_filter->manufacturer_data_cnt;
+	uint8_t md_len = data->manufacturer_data_filter.data_len;
+	uint8_t *md_data = data->manufacturer_data_filter.data;
+
+	/* Validate length. */
+	if ((md_len == 0) || (md_len > CONFIG_BLE_SCAN_MANUFACTURER_DATA_MAX_LEN)) {
+		return NRF_ERROR_DATA_SIZE;
+	}
+
+	/* Validate md_data. */
+	if (md_data == NULL) {
+		return NRF_ERROR_NULL;
+	}
+
+	/* Check for duplicated filter. */
+	for (uint8_t i = 0; i < *counter; i++) {
+		if ((md_filter->manufacturer_data[i].data_len == md_len) &&
+		    (memcmp(md_filter->manufacturer_data[i].data, md_data, md_len) == 0)) {
+			return NRF_SUCCESS;
+		}
+	}
+
+	/* Check for free slot. */
+	if (*counter >= CONFIG_BLE_SCAN_MANUFACTURER_DATA_COUNT) {
+		return NRF_ERROR_NO_MEM;
+	}
+
+	/* Add manufacturer data to filter. */
+	memcpy(md_filter->manufacturer_data[*counter].data, md_data, md_len);
+	md_filter->manufacturer_data[*counter].data_len = md_len;
+	(*counter)++;
+
+	LOG_DBG("Added manufacturer data filter");
+	LOG_HEXDUMP_DBG(md_data, md_len, "Manufacturer data");
+
+	return NRF_SUCCESS;
+}
+#endif /* CONFIG_BLE_SCAN_MANUFACTURER_DATA_COUNT */
+
 uint32_t ble_scan_filter_add(struct ble_scan *scan, uint8_t type,
 			     const struct ble_scan_filter_data *data)
 {
@@ -400,6 +462,12 @@ uint32_t ble_scan_filter_add(struct ble_scan *scan, uint8_t type,
 	}
 #endif
 
+#if (CONFIG_BLE_SCAN_MANUFACTURER_DATA_COUNT > 0)
+	case BLE_SCAN_MANUFACTURER_DATA_FILTER: {
+		return manufacturer_data_filter_add(scan, data);
+	}
+#endif
+
 	default:
 		return NRF_ERROR_INVALID_PARAM;
 	}
@@ -444,6 +512,14 @@ uint32_t ble_scan_all_filter_remove(struct ble_scan *scan)
 	appearance_filter->appearance_cnt = 0;
 #endif
 
+#if (CONFIG_BLE_SCAN_MANUFACTURER_DATA_COUNT > 0)
+	struct ble_scan_manufacturer_data_filter *md_filter =
+		&scan->scan_filters.manufacturer_data_filter;
+
+	memset(md_filter->manufacturer_data, 0, sizeof(md_filter->manufacturer_data));
+	md_filter->manufacturer_data_cnt = 0;
+#endif
+
 	return NRF_SUCCESS;
 }
 
@@ -461,7 +537,8 @@ uint32_t ble_scan_filters_enable(struct ble_scan *scan, uint8_t mode, bool match
 	    (!(mode & BLE_SCAN_NAME_FILTER)) &&
 	    (!(mode & BLE_SCAN_UUID_FILTER)) &&
 	    (!(mode & BLE_SCAN_SHORT_NAME_FILTER)) &&
-	    (!(mode & BLE_SCAN_APPEARANCE_FILTER))) {
+	    (!(mode & BLE_SCAN_APPEARANCE_FILTER)) &&
+	    (!(mode & BLE_SCAN_MANUFACTURER_DATA_FILTER))) {
 		return NRF_ERROR_INVALID_PARAM;
 	}
 
@@ -502,6 +579,12 @@ uint32_t ble_scan_filters_enable(struct ble_scan *scan, uint8_t mode, bool match
 	}
 #endif
 
+#if (CONFIG_BLE_SCAN_MANUFACTURER_DATA_COUNT > 0)
+	if (mode & BLE_SCAN_MANUFACTURER_DATA_FILTER) {
+		filters->manufacturer_data_filter.manufacturer_data_filter_enabled = true;
+	}
+#endif
+
 	/* Select the filter mode. */
 	filters->all_filters_mode = match_all;
 
@@ -539,6 +622,10 @@ uint32_t ble_scan_filters_disable(struct ble_scan *scan)
 	filters->appearance_filter.appearance_filter_enabled = false;
 #endif
 
+#if (CONFIG_BLE_SCAN_MANUFACTURER_DATA_COUNT > 0)
+	filters->manufacturer_data_filter.manufacturer_data_filter_enabled = false;
+#endif
+
 	return NRF_SUCCESS;
 }
 
@@ -771,6 +858,21 @@ static void ble_scan_on_adv_report(struct ble_scan *scan,
 	}
 #endif /* CONFIG_BLE_SCAN_APPEARANCE_COUNT */
 
+#if (CONFIG_BLE_SCAN_MANUFACTURER_DATA_COUNT > 0)
+	/* Check the manufacturer data filter. */
+	if (scan->scan_filters.manufacturer_data_filter.manufacturer_data_filter_enabled) {
+		filter_cnt++;
+		if (adv_manufacturer_data_compare(scan, adv_report->data.p_data,
+						  adv_report->data.len) ||
+		    (active_match_all &&
+		     adv_manufacturer_data_compare(scan, adv_data, adv_data_len))) {
+			filter_match_cnt++;
+
+			scan_evt.filter_match.filter_match.manufacturer_data_filter_match = true;
+		}
+	}
+#endif /* CONFIG_BLE_SCAN_MANUFACTURER_DATA_COUNT */
+
 	/* In the multifilter mode, the number of the active filters must equal the number of the
 	 * filters matched to generate the notification.
 	 */

tests/unit/lib/bluetooth/ble_scan/prj.conf

@@ -3,11 +3,13 @@ CONFIG_UNITY=y
 CONFIG_BLE_SCAN_BUFFER_SIZE=31
 CONFIG_BLE_SCAN_NAME_MAX_LEN=32
 CONFIG_BLE_SCAN_SHORT_NAME_MAX_LEN=32
+CONFIG_BLE_SCAN_MANUFACTURER_DATA_MAX_LEN=32
 CONFIG_BLE_SCAN_NAME_COUNT=1
 CONFIG_BLE_SCAN_APPEARANCE_COUNT=1
 CONFIG_BLE_SCAN_ADDRESS_COUNT=1
 CONFIG_BLE_SCAN_SHORT_NAME_COUNT=2
 CONFIG_BLE_SCAN_UUID_COUNT=1
+CONFIG_BLE_SCAN_MANUFACTURER_DATA_COUNT=2
 CONFIG_BLE_SCAN_INTERVAL=160
 CONFIG_BLE_SCAN_DURATION=0
 CONFIG_BLE_SCAN_WINDOW=80