path: root/tools/rootcanal/model/controller/dual_mode_controller.h

/*
 * Copyright 2015 The Android Open Source Project
 *
 * 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 <unistd.h>

#include <cstdint>
#include <memory>
#include <string>
#include <unordered_map>
#include <vector>

#include "hci/address.h"
#include "hci/hci_packets.h"
#include "link_layer_controller.h"
#include "model/devices/device.h"
#include "model/setup/async_manager.h"
#include "security_manager.h"

namespace rootcanal {

using ::bluetooth::hci::Address;
using ::bluetooth::hci::CommandView;

// Emulates a dual mode BR/EDR + LE controller by maintaining the link layer
// state machine detailed in the Bluetooth Core Specification Version 4.2,
// Volume 6, Part B, Section 1.1 (page 30). Provides methods corresponding to
// commands sent by the HCI. These methods will be registered as callbacks from
// a controller instance with the HciHandler. To implement a new Bluetooth
// command, simply add the method declaration below, with return type void and a
// single const std::vector<uint8_t>& argument. After implementing the
// method, simply register it with the HciHandler using the SET_HANDLER macro in
// the controller's default constructor. Be sure to name your method after the
// corresponding Bluetooth command in the Core Specification with the prefix
// "Hci" to distinguish it as a controller command.
class DualModeController : public Device {
  // The location of the config file loaded to populate controller attributes.
  static constexpr char kControllerPropertiesFile[] =
      "/vendor/etc/bluetooth/controller_properties.json";
  static constexpr uint16_t kSecurityManagerNumKeys = 15;

 public:
  // Sets all of the methods to be used as callbacks in the HciHandler.
  DualModeController(const std::string& properties_filename =
                         std::string(kControllerPropertiesFile),
                     uint16_t num_keys = kSecurityManagerNumKeys);

  ~DualModeController() = default;

  // Device methods.
  virtual std::string GetTypeString() const override;

  virtual void IncomingPacket(
      model::packets::LinkLayerPacketView incoming) override;

  virtual void TimerTick() override;

  virtual void Close() override;

  // Route commands and data from the stack.
  void HandleAcl(std::shared_ptr<std::vector<uint8_t>> acl_packet);
  void HandleCommand(std::shared_ptr<std::vector<uint8_t>> command_packet);
  void HandleSco(std::shared_ptr<std::vector<uint8_t>> sco_packet);
  void HandleIso(std::shared_ptr<std::vector<uint8_t>> iso_packet);

  // Set the callbacks for scheduling tasks.
  void RegisterTaskScheduler(
      std::function<AsyncTaskId(std::chrono::milliseconds, const TaskCallback&)>
          evtScheduler);

  void RegisterPeriodicTaskScheduler(
      std::function<AsyncTaskId(std::chrono::milliseconds,
                                std::chrono::milliseconds, const TaskCallback&)>
          periodicEvtScheduler);

  void RegisterTaskCancel(std::function<void(AsyncTaskId)> cancel);

  // Set the callbacks for sending packets to the HCI.
  void RegisterEventChannel(
      const std::function<void(std::shared_ptr<std::vector<uint8_t>>)>&
          send_event);

  void RegisterAclChannel(
      const std::function<void(std::shared_ptr<std::vector<uint8_t>>)>&
          send_acl);

  void RegisterScoChannel(
      const std::function<void(std::shared_ptr<std::vector<uint8_t>>)>&
          send_sco);

  void RegisterIsoChannel(
      const std::function<void(std::shared_ptr<std::vector<uint8_t>>)>&
          send_iso);

  // Set the device's address.
  void SetAddress(Address address) override;

  // Controller commands. For error codes, see the Bluetooth Core Specification,
  // Version 4.2, Volume 2, Part D (page 370).

  // Link Control Commands
  // Bluetooth Core Specification Version 4.2 Volume 2 Part E 7.1

  // 7.1.1
  void Inquiry(CommandView args);

  // 7.1.2
  void InquiryCancel(CommandView args);

  // 7.1.5
  void CreateConnection(CommandView args);

  // 7.1.6
  void Disconnect(CommandView args);

  // Deprecated
  void AddScoConnection(CommandView args);

  // 7.1.7
  void CreateConnectionCancel(CommandView args);

  // 7.1.8
  void AcceptConnectionRequest(CommandView args);

  // 7.1.9
  void RejectConnectionRequest(CommandView args);

  // 7.1.10
  void LinkKeyRequestReply(CommandView args);

  // 7.1.11
  void LinkKeyRequestNegativeReply(CommandView args);

  // 7.1.12
  void PinCodeRequestReply(CommandView args);

  // 7.1.13
  void PinCodeRequestNegativeReply(CommandView args);

  // 7.1.14
  void ChangeConnectionPacketType(CommandView args);

  // 7.1.15
  void AuthenticationRequested(CommandView args);

  // 7.1.16
  void SetConnectionEncryption(CommandView args);

  // 7.1.17
  void ChangeConnectionLinkKey(CommandView args);

  // 7.1.18
  void CentralLinkKey(CommandView args);

  // 7.1.19
  void RemoteNameRequest(CommandView args);

  // 7.2.8
  void SwitchRole(CommandView args);

  // 7.1.21
  void ReadRemoteSupportedFeatures(CommandView args);

  // 7.1.22
  void ReadRemoteExtendedFeatures(CommandView args);

  // 7.1.23
  void ReadRemoteVersionInformation(CommandView args);

  // 7.1.24
  void ReadClockOffset(CommandView args);

  // 7.1.26
  void SetupSynchronousConnection(CommandView command);

  // 7.1.27
  void AcceptSynchronousConnection(CommandView command);

  // 7.1.28
  void RejectSynchronousConnection(CommandView command);

  // 7.1.29
  void IoCapabilityRequestReply(CommandView args);

  // 7.1.30
  void UserConfirmationRequestReply(CommandView args);

  // 7.1.31
  void UserConfirmationRequestNegativeReply(CommandView args);

  // 7.1.32
  void UserPasskeyRequestReply(CommandView args);

  // 7.1.33
  void UserPasskeyRequestNegativeReply(CommandView args);

  // 7.1.34
  void RemoteOobDataRequestReply(CommandView args);

  // 7.1.35
  void RemoteOobDataRequestNegativeReply(CommandView args);

  // 7.1.36
  void IoCapabilityRequestNegativeReply(CommandView args);

  // 7.1.53
  void RemoteOobExtendedDataRequestReply(CommandView args);

  // Link Policy Commands
  // Bluetooth Core Specification Version 4.2 Volume 2 Part E 7.2

  // 7.2.1
  void HoldMode(CommandView args);

  // 7.2.2
  void SniffMode(CommandView args);

  // 7.2.3
  void ExitSniffMode(CommandView args);

  // 7.2.6
  void QosSetup(CommandView args);

  // 7.2.7
  void RoleDiscovery(CommandView args);

  // 7.2.10
  void WriteLinkPolicySettings(CommandView args);

  // 7.2.11
  void ReadDefaultLinkPolicySettings(CommandView args);

  // 7.2.12
  void WriteDefaultLinkPolicySettings(CommandView args);

  // 7.2.13
  void FlowSpecification(CommandView args);

  // 7.2.14
  void SniffSubrating(CommandView args);

  // Link Controller Commands
  // Bluetooth Core Specification Version 4.2 Volume 2 Part E 7.3

  // 7.3.1
  void SetEventMask(CommandView args);

  // 7.3.2
  void Reset(CommandView args);

  // 7.3.3
  void SetEventFilter(CommandView args);

  // 7.3.10
  void DeleteStoredLinkKey(CommandView args);

  // 7.3.11
  void WriteLocalName(CommandView args);

  // 7.3.12
  void ReadLocalName(CommandView args);

  // 7.3.15
  void ReadPageTimeout(CommandView args);

  // 7.3.16
  void WritePageTimeout(CommandView args);

  // 7.3.17
  void ReadScanEnable(CommandView args);

  // 7.3.18
  void WriteScanEnable(CommandView args);

  // 7.3.19
  void ReadPageScanActivity(CommandView args);

  // 7.3.20
  void WritePageScanActivity(CommandView args);

  // 7.3.21
  void ReadInquiryScanActivity(CommandView args);

  // 7.3.22
  void WriteInquiryScanActivity(CommandView args);

  // 7.3.23
  void ReadAuthenticationEnable(CommandView args);

  // 7.3.24
  void WriteAuthenticationEnable(CommandView args);

  // 7.3.26
  void WriteClassOfDevice(CommandView args);

  // 7.3.28
  void WriteVoiceSetting(CommandView args);

  // 7.3.36
  void ReadSynchronousFlowControlEnable(CommandView args);

  // 7.3.37
  void WriteSynchronousFlowControlEnable(CommandView args);

  // 7.3.39
  void HostBufferSize(CommandView args);

  // 7.3.42
  void WriteLinkSupervisionTimeout(CommandView args);

  // 7.3.43
  void ReadNumberOfSupportedIac(CommandView args);

  // 7.3.44
  void ReadCurrentIacLap(CommandView args);

  // 7.3.45
  void WriteCurrentIacLap(CommandView args);

  // 7.3.47
  void ReadInquiryScanType(CommandView args);

  // 7.3.48
  void WriteInquiryScanType(CommandView args);

  // 7.3.49
  void ReadInquiryMode(CommandView args);

  // 7.3.50
  void WriteInquiryMode(CommandView args);

  // 7.3.52
  void ReadPageScanType(CommandView args);

  // 7.3.52
  void WritePageScanType(CommandView args);

  // 7.3.56
  void WriteExtendedInquiryResponse(CommandView args);

  // 7.3.57
  void RefreshEncryptionKey(CommandView args);

  // 7.3.59
  void WriteSimplePairingMode(CommandView args);

  // 7.3.60
  void ReadLocalOobData(CommandView args);

  // 7.3.61
  void ReadInquiryResponseTransmitPowerLevel(CommandView args);

  // 7.3.63
  void SendKeypressNotification(CommandView args);

  // 7.3.69
  void SetEventMaskPage2(CommandView args);

  // 7.3.79
  void WriteLeHostSupport(CommandView args);

  // 7.3.92
  void WriteSecureConnectionsHostSupport(CommandView args);

  // 7.3.95
  void ReadLocalOobExtendedData(CommandView args);

  // Informational Parameters Commands
  // Bluetooth Core Specification Version 4.2 Volume 2 Part E 7.4

  // 7.4.5
  void ReadBufferSize(CommandView args);

  // 7.4.1
  void ReadLocalVersionInformation(CommandView args);

  // 7.4.6
  void ReadBdAddr(CommandView args);

  // 7.4.2
  void ReadLocalSupportedCommands(CommandView args);

  // 7.4.3
  void ReadLocalSupportedFeatures(CommandView args);

  // 7.4.4
  void ReadLocalExtendedFeatures(CommandView args);

  // 7.4.8
  void ReadLocalSupportedCodecs(CommandView args);

  // Status Parameters Commands
  // Bluetooth Core Specification Version 4.2 Volume 2 Part E 7.5

  // 7.5.7
  void ReadEncryptionKeySize(CommandView args);

  // Test Commands
  // Bluetooth Core Specification Version 4.2 Volume 2 Part E 7.7

  // 7.7.1
  void ReadLoopbackMode(CommandView args);

  // 7.7.2
  void WriteLoopbackMode(CommandView args);

  // LE Controller Commands
  // Bluetooth Core Specification Version 4.2 Volume 2 Part E 7.8

  // 7.8.1
  void LeSetEventMask(CommandView args);

  // 7.8.2
  void LeReadBufferSize(CommandView args);

  // 7.8.3
  void LeReadLocalSupportedFeatures(CommandView args);

  // 7.8.4
  void LeSetRandomAddress(CommandView args);

  // 7.8.5
  void LeSetAdvertisingParameters(CommandView args);

  // 7.8.6
  void LeReadAdvertisingPhysicalChannelTxPower(CommandView args);

  // 7.8.7
  void LeSetAdvertisingData(CommandView args);

  // 7.8.8
  void LeSetScanResponseData(CommandView args);

  // 7.8.9
  void LeSetAdvertisingEnable(CommandView args);

  // 7.8.10
  void LeSetScanParameters(CommandView args);

  // 7.8.11
  void LeSetScanEnable(CommandView args);

  // 7.8.12
  void LeCreateConnection(CommandView args);

  // 7.8.18
  void LeConnectionUpdate(CommandView args);

  // 7.8.13
  void LeConnectionCancel(CommandView args);

  // 7.8.14
  void LeReadFilterAcceptListSize(CommandView args);

  // 7.8.15
  void LeClearFilterAcceptList(CommandView args);

  // 7.8.16
  void LeAddDeviceToFilterAcceptList(CommandView args);

  // 7.8.17
  void LeRemoveDeviceFromFilterAcceptList(CommandView args);

  // 7.8.21
  void LeReadRemoteFeatures(CommandView args);

  // 7.8.22
  void LeEncrypt(CommandView args);

  // 7.8.23
  void LeRand(CommandView args);

  // 7.8.24
  void LeStartEncryption(CommandView args);

  // 7.8.25
  void LeLongTermKeyRequestReply(CommandView args);

  // 7.8.26
  void LeLongTermKeyRequestNegativeReply(CommandView args);

  // 7.8.27
  void LeReadSupportedStates(CommandView args);

  // 7.8.31
  void LeRemoteConnectionParameterRequestReply(CommandView args);

  // 7.8.32
  void LeRemoteConnectionParameterRequestNegativeReply(CommandView args);

  // 7.8.34
  void LeReadSuggestedDefaultDataLength(CommandView args);

  // 7.8.35
  void LeWriteSuggestedDefaultDataLength(CommandView args);

  // 7.8.38
  void LeAddDeviceToResolvingList(CommandView args);

  // 7.8.39
  void LeRemoveDeviceFromResolvingList(CommandView args);

  // 7.8.40
  void LeClearResolvingList(CommandView args);

  // 7.8.41
  void LeReadResolvingListSize(CommandView args);

  // 7.8.44
  void LeSetAddressResolutionEnable(CommandView args);

  // 7.8.45
  void LeSetResovalablePrivateAddressTimeout(CommandView args);

  // 7.8.46
  void LeReadMaximumDataLength(CommandView args);

  // 7.8.52
  void LeSetExtendedAdvertisingRandomAddress(CommandView args);

  // 7.8.53
  void LeSetExtendedAdvertisingParameters(CommandView args);

  // 7.8.54
  void LeSetExtendedAdvertisingData(CommandView args);

  // 7.8.55
  void LeSetExtendedAdvertisingScanResponse(CommandView args);

  // 7.8.56
  void LeSetExtendedAdvertisingEnable(CommandView args);

  // 7.8.57
  void LeReadMaximumAdvertisingDataLength(CommandView args);

  // 7.8.58
  void LeReadNumberOfSupportedAdvertisingSets(CommandView args);

  // 7.8.59
  void LeRemoveAdvertisingSet(CommandView args);

  // 7.8.60
  void LeClearAdvertisingSets(CommandView args);

  // 7.8.64
  void LeSetExtendedScanParameters(CommandView args);

  // 7.8.65
  void LeSetExtendedScanEnable(CommandView args);

  // 7.8.66
  void LeExtendedCreateConnection(CommandView args);

  // 7.8.77
  void LeSetPrivacyMode(CommandView args);

  // 7.8.93 (moved to 7.8.2)
  void LeReadBufferSizeV2(CommandView args);

  // 7.8.96 - 7.8.110
  void LeReadIsoTxSync(CommandView packet_view);
  void LeSetCigParameters(CommandView packet_view);
  void LeCreateCis(CommandView packet_view);
  void LeRemoveCig(CommandView packet_view);
  void LeAcceptCisRequest(CommandView packet_view);
  void LeRejectCisRequest(CommandView packet_view);
  void LeCreateBig(CommandView packet_view);
  void LeTerminateBig(CommandView packet_view);
  void LeBigCreateSync(CommandView packet_view);
  void LeBigTerminateSync(CommandView packet_view);
  void LeRequestPeerSca(CommandView packet_view);
  void LeSetupIsoDataPath(CommandView packet_view);
  void LeRemoveIsoDataPath(CommandView packet_view);

  // 7.8.115
  void LeSetHostFeature(CommandView packet_view);

  // Vendor-specific Commands

  void LeVendorSleepMode(CommandView args);
  void LeVendorCap(CommandView args);
  void LeVendorMultiAdv(CommandView args);
  void LeVendor155(CommandView args);
  void LeVendor157(CommandView args);
  void LeEnergyInfo(CommandView args);
  void LeAdvertisingFilter(CommandView args);
  void LeExtendedScanParams(CommandView args);

  // Required commands for handshaking with hci driver
  void ReadClassOfDevice(CommandView args);
  void ReadVoiceSetting(CommandView args);
  void ReadConnectionAcceptTimeout(CommandView args);
  void WriteConnectionAcceptTimeout(CommandView args);

  void SetTimerPeriod(std::chrono::milliseconds new_period);
  void StartTimer();
  void StopTimer();

 protected:
  LinkLayerController link_layer_controller_{properties_};

 private:
  // Set a timer for a future action
  void AddControllerEvent(std::chrono::milliseconds,
                          const TaskCallback& callback);

  void AddConnectionAction(const TaskCallback& callback, uint16_t handle);

  void SendCommandCompleteUnknownOpCodeEvent(uint16_t command_opcode) const;

  // Unused state to maintain consistency for the Host
  uint16_t le_suggested_default_data_bytes_{0x20};
  uint16_t le_suggested_default_data_time_{0x148};

  // Callbacks to send packets back to the HCI.
  std::function<void(std::shared_ptr<bluetooth::hci::AclBuilder>)> send_acl_;
  std::function<void(std::shared_ptr<bluetooth::hci::EventBuilder>)>
      send_event_;
  std::function<void(std::shared_ptr<bluetooth::hci::ScoBuilder>)> send_sco_;
  std::function<void(std::shared_ptr<bluetooth::hci::IsoBuilder>)> send_iso_;

  // Maintains the commands to be registered and used in the HciHandler object.
  // Keys are command opcodes and values are the callbacks to handle each
  // command.
  std::unordered_map<bluetooth::hci::OpCode,
                     std::function<void(bluetooth::hci::CommandView)>>
      active_hci_commands_;

  bluetooth::hci::LoopbackMode loopback_mode_;

  SecurityManager security_manager_;

  DualModeController(const DualModeController& cmdPckt) = delete;
  DualModeController& operator=(const DualModeController& cmdPckt) = delete;
};

}  // namespace rootcanal