Import of the watch repository from Pebble

src/fw/applib/bluetooth/ble_scan.h

@@ -0,0 +1,53 @@
+/*
+ * Copyright 2024 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#pragma once
+
+#include <bluetooth/bluetooth_types.h>
+
+//! Callback that is called for each advertisment that is found while scanning
+//! using ble_scan_start().
+//! @param device The device from which the advertisment originated.
+//! @param rssi The RSSI (Received Signal Strength Indication) of the
+//! advertisement.
+//! @param advertisement_data The payload of the advertisement. When there was
+//! a scan response, this payload will contain the data of the scan response
+//! as well. The information in the payload can be accessed using the
+//! ble_ad_... functions, @see for example ble_ad_copy_local_name() and
+//! ble_ad_includes_service().
+//! @note The advertisement_data is cleaned up by the system automatically
+//! immediately after returning from this callback. Do not keep around
+//! any long-lived references around to the advertisement_data.
+//! @note Do not use ble_ad_destroy() on the advertisement_data.
+typedef void (*BLEScanHandler)(BTDevice device,
+                               int8_t rssi,
+                               const BLEAdData *advertisement_data);
+
+//! Start scanning for advertisements. Pebble will scan actively, meaning it
+//! will perform scan requests whenever the advertisement is scannable.
+//! @param handler The callback to handle the found advertisments. It must not
+//! be NULL.
+//! @return BTErrnoOK if scanning started successfully, BTErrnoInvalidParameter
+//! if the handler was invalid or BTErrnoInvalidState if scanning had already
+//! been started.
+BTErrno ble_scan_start(BLEScanHandler handler);
+
+//! Stop scanning for advertisements.
+//! @return BTErrnoOK if scanning stopped successfully, or TODO...
+BTErrno ble_scan_stop(void);
+
+//! @return True if the system is scanning for advertisements or false if not.
+bool ble_scan_is_scanning(void);