drivers/bluetooth/hci/intel/vendor_hci.h

// Copyright 2017 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#pragma once

#include <queue>

#include "garnet/drivers/bluetooth/lib/common/byte_buffer.h"
#include "garnet/drivers/bluetooth/lib/common/device_address.h"
#include "garnet/drivers/bluetooth/lib/hci/control_packets.h"
#include "garnet/drivers/bluetooth/lib/hci/hci.h"

#include <lib/zx/channel.h>

namespace btintel {

constexpr btlib::hci::OpCode kReadVersion = btlib::hci::VendorOpCode(0x0005);

struct ReadVersionReturnParams {
  btlib::hci::StatusCode status;
  uint8_t hw_platform;
  uint8_t hw_variant;
  uint8_t hw_revision;
  uint8_t fw_variant;
  uint8_t fw_revision;
  uint8_t fw_build_num;
  uint8_t fw_build_week;
  uint8_t fw_build_year;
  uint8_t fw_patch_num;
} __PACKED;

constexpr uint8_t kBootloaderFirmwareVariant = 0x06;
constexpr uint8_t kFirmwareFirmwareVariant = 0x23;

constexpr btlib::hci::OpCode kLoadPatch = btlib::hci::VendorOpCode(0x008e);

constexpr btlib::hci::OpCode kSecureSend = btlib::hci::VendorOpCode(0x0009);

constexpr btlib::hci::OpCode kReadBootParams = btlib::hci::VendorOpCode(0x000D);

struct ReadBootParamsReturnParams {
  btlib::hci::StatusCode status;
  uint8_t otp_format;
  uint8_t otp_content;
  uint8_t otp_patch;
  uint16_t dev_revid;
  btlib::hci::GenericEnableParam secure_boot;
  uint8_t key_from_hdr;
  uint8_t key_type;
  btlib::hci::GenericEnableParam otp_lock;
  btlib::hci::GenericEnableParam api_lock;
  btlib::hci::GenericEnableParam debug_lock;
  btlib::common::DeviceAddressBytes otp_bdaddr;
  uint8_t min_fw_build_num;
  uint8_t min_fw_build_week;
  uint8_t min_fw_build_year;
  btlib::hci::GenericEnableParam limited_cce;
  uint8_t unlocked_state;
} __PACKED;

constexpr btlib::hci::OpCode kReset = btlib::hci::VendorOpCode(0x0001);

struct ResetCommandParams {
  uint8_t data[8];
} __PACKED;

constexpr btlib::hci::OpCode kMfgModeChange = btlib::hci::VendorOpCode(0x0011);

enum class MfgDisableMode : uint8_t {
  kNoPatches = 0x00,
  kPatchesDisabled = 0x01,
  kPatchesEnabled = 0x02,
};

struct MfgModeChangeCommandParams {
  btlib::hci::GenericEnableParam enable;
  MfgDisableMode disable_mode;
} __PACKED;

struct SecureSendEventParams {
  uint8_t vendor_event_code;
  uint8_t result;
  uint16_t opcode;
  uint8_t status;
} __PACKED;

struct BootloaderVendorEventParams {
  FXL_DISALLOW_IMPLICIT_CONSTRUCTORS(BootloaderVendorEventParams);

  uint8_t vendor_event_code;
  uint8_t vendor_params[];
} __PACKED;

class VendorHci {
 public:
  explicit VendorHci(zx::channel* ctrl);

  // When |acl| is not nullptr, WaitForEventPacket will wait on both control and ACL
  // channels.
  void enable_events_on_bulk(zx::channel* acl) { acl_ = acl; }

  ReadVersionReturnParams SendReadVersion() const;

  ReadBootParamsReturnParams SendReadBootParams() const;

  btlib::hci::StatusCode SendHciReset() const;

  void SendVendorReset() const;

  bool SendSecureSend(uint8_t type,
                      const btlib::common::BufferView& bytes) const;

  bool SendAndExpect(
      const btlib::common::PacketView<btlib::hci::CommandHeader>& command,
      std::deque<btlib::common::BufferView> events) const;

  void EnterManufacturerMode();

  bool ExitManufacturerMode(MfgDisableMode mode);

 private:
  // The control and ACL (interrupt and bulk on USB) endpoints of the
  // controller. Intel controllers that support the "secure send" can send
  // vendor events over the bulk endpoint while in bootloader mode. We listen on
  // incoming events on both channels, if provided.
  zx::channel* ctrl_;
  zx::channel* acl_;

  // True when we are in Manufacturer Mode
  bool manufacturer_;

  void SendCommand(const btlib::common::PacketView<btlib::hci::CommandHeader>&
                       command) const;

  std::unique_ptr<btlib::hci::EventPacket> WaitForEventPacket(
      zx::duration timeout = zx::sec(5),
      btlib::hci::EventCode expected_event = 0) const;
};

}  // namespace btintel