pw_bluetooth_sapphire: Add field to LowEnergyScanResult

Add periodic_advertising_interval to LowEnergyScanResult. This field
will be populated by LE Extended Advertising Report events, and will
default to 0 (No periodic advertising).

Also add advertising_sid and periodic_advertising_interval to FakePeer
to allow for testing the population of these values from advertising
reports.

Bug: 372944638
Test: pw presubmit --step gn_chre_googletest_nanopb_sapphire_build
Change-Id: Ib54f5d32bfb7cf8553c0c495dc585c055548e682
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/279052
Reviewed-by: Sarah Bodin <sarahbodin@google.com>
Lint: Lint 🤖 <android-build-ayeaye@system.gserviceaccount.com>
Commit-Queue: Josh Conner <joshconner@google.com>
Docs-Not-Needed: Josh Conner <joshconner@google.com>

Author: josh-conner

pw_bluetooth_sapphire/host/hci-spec/public/pw_bluetooth_sapphire/internal/host/hci-spec/constants.h

@@ -668,6 +668,9 @@ inline constexpr int8_t kRSSIInvalid = 127;
 // Invalid advertising sid value
 inline constexpr uint8_t kAdvertisingSidInvalid = 0xFF;
 
+// Invalid periodic advertising interval
+inline constexpr uint16_t kPeriodicAdvertisingIntervalInvalid = 0x0000;
+
 // The maximum length of a friendly name that can be assigned to a BR/EDR
 // controller, in octets.
 inline constexpr size_t kMaxNameLength = bt::kMaxNameLength;

pw_bluetooth_sapphire/host/hci/extended_low_energy_scanner.cc

@@ -248,6 +248,8 @@ void ExtendedLowEnergyScanner::OnExtendedAdvertisingReportEvent(
     result.set_rssi(rssi);
     result.set_tx_power(report.tx_power().Read());
     result.set_advertising_sid(report.advertising_sid().Read());
+    result.set_periodic_advertising_interval(
+        report.periodic_advertising_interval().Read());
 
     // If the next set of data exceeds the maximum allowed in an extended
     // advertising data payload, take as much as we can and report it back.

pw_bluetooth_sapphire/host/hci/extended_low_energy_scanner_test.cc

@@ -45,6 +45,9 @@ const DeviceAddress kPublicAddr1(DeviceAddress::Type::kLEPublic, {1});
 const DeviceAddress kPublicAddr2(DeviceAddress::Type::kLEPublic, {2});
 const DeviceAddress kPublicAddr3(DeviceAddress::Type::kLEPublic, {3});
 
+constexpr uint8_t kAdvertisingSid = 0xa;
+constexpr uint16_t kPeriodicAdvertisingInterval = 0x1234;
+
 class ExtendedLowEnergyScannerTest : public TestingBase,
                                      public LowEnergyScanner::Delegate {
  public:
@@ -67,17 +70,22 @@ class ExtendedLowEnergyScannerTest : public TestingBase,
     scanner_->SetPacketFilters(0, {});
     scanner_->set_delegate(this);
 
+    // peers(0)
     auto p = std::make_unique<FakePeer>(kPublicAddr1, dispatcher(), true, true);
     p->set_use_extended_advertising_pdus(true);
     p->set_advertising_data(kPlainAdvDataBytes);
     p->set_scan_response(kPlainScanRspBytes);
     peers_.push_back(std::move(p));
 
+    // peers(1)
     p = std::make_unique<FakePeer>(kPublicAddr2, dispatcher(), true, false);
     p->set_use_extended_advertising_pdus(true);
     p->set_advertising_data(kPlainAdvDataBytes);
+    p->set_advertising_sid(kAdvertisingSid);
+    p->set_periodic_advertising_interval(kPeriodicAdvertisingInterval);
     peers_.push_back(std::move(p));
 
+    // peers(2)
     p = std::make_unique<FakePeer>(kPublicAddr3, dispatcher(), true, false);
     p->set_use_extended_advertising_pdus(true);
     p->set_advertising_data(kPlainAdvDataBytes);
@@ -159,6 +167,9 @@ TEST_F(ExtendedLowEnergyScannerTest, ParseAdvertisingReportsSingleReport) {
     EXPECT_EQ(peer(1)->address(), result.address());
     EXPECT_EQ(peer(1)->advertising_data().size(), result.data().size());
     EXPECT_EQ(peer(1)->advertising_data(), result.data());
+    EXPECT_EQ(result.advertising_sid(), kAdvertisingSid);
+    EXPECT_EQ(result.periodic_advertising_interval(),
+              kPeriodicAdvertisingInterval);
   });
 
   RunUntilIdle();

pw_bluetooth_sapphire/host/hci/public/pw_bluetooth_sapphire/internal/host/hci/low_energy_scanner.h

@@ -53,6 +53,13 @@ class LowEnergyScanResult {
   uint8_t advertising_sid() const { return advertising_sid_; }
   void set_advertising_sid(uint8_t value) { advertising_sid_ = value; }
 
+  uint16_t periodic_advertising_interval() const {
+    return periodic_advertising_interval_;
+  }
+  void set_periodic_advertising_interval(uint16_t value) {
+    periodic_advertising_interval_ = value;
+  }
+
   BufferView data() const { return buffer_.view(0, data_size_); }
   void AppendData(const ByteBuffer& data);
 
@@ -79,6 +86,11 @@ class LowEnergyScanResult {
   // advertisement, used to synchronize against a periodic advertising train
   uint8_t advertising_sid_ = hci_spec::kAdvertisingSidInvalid;
 
+  // Interval of periodic advertisements, in increments of 1.25 ms, specified in
+  // the LE extended advertising report.
+  uint16_t periodic_advertising_interval_ =
+      hci_spec::kPeriodicAdvertisingIntervalInvalid;
+
   // The size of the data so far accumulated in |buffer_|.
   size_t data_size_ = 0u;
 

pw_bluetooth_sapphire/host/testing/fake_peer.cc

@@ -330,10 +330,10 @@ void FakePeer::FillExtendedAdvertisingReport(
       pw::bluetooth::emboss::LEPrimaryAdvertisingPHY::LE_1M);
   report.secondary_phy().Write(
       pw::bluetooth::emboss::LESecondaryAdvertisingPHY::NONE);
-  report.advertising_sid().Write(0);
+  report.advertising_sid().Write(advertising_sid());
   report.tx_power().Write(tx_power());
   report.rssi().Write(rssi());
-  report.periodic_advertising_interval().Write(0);
+  report.periodic_advertising_interval().Write(periodic_advertising_interval());
 
   // skip direct_address_type and direct_address for now since we don't use it
 

pw_bluetooth_sapphire/host/testing/public/pw_bluetooth_sapphire/internal/host/testing/fake_peer.h

@@ -95,6 +95,17 @@ class FakePeer {
   int8_t rssi() const { return -1; }
   int8_t tx_power() const { return -2; }
 
+  // LE extended advertising attributes
+  uint8_t advertising_sid() const { return advertising_sid_; }
+  void set_advertising_sid(uint8_t value) { advertising_sid_ = value; }
+
+  uint16_t periodic_advertising_interval() const {
+    return periodic_advertising_interval_;
+  }
+  void set_periodic_advertising_interval(uint16_t value) {
+    periodic_advertising_interval_ = value;
+  }
+
   // The local name of the device. Used in HCI Remote Name Request event.
   std::string name() const { return name_; }
   void set_name(const std::string& name) { name_ = name; }
@@ -254,6 +265,10 @@ class FakePeer {
   bool use_extended_advertising_pdus_ = false;
   bool send_advertising_report_;
 
+  uint8_t advertising_sid_ = bt::hci_spec::kAdvertisingSidInvalid;
+  uint16_t periodic_advertising_interval_ =
+      bt::hci_spec::kPeriodicAdvertisingIntervalInvalid;
+
   pw::bluetooth::emboss::StatusCode connect_status_;
   pw::bluetooth::emboss::StatusCode connect_response_;
   bool force_pending_connect_;  // Causes connection requests to remain pending.