drivers/bluetooth/btintel.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  *
   4  *  Bluetooth support for Intel devices
   5  *
   6  *  Copyright (C) 2015  Intel Corporation
   7  */
   8
   9 /* List of tlv type */
  10 enum {
  11         INTEL_TLV_CNVI_TOP = 0x10,
  12         INTEL_TLV_CNVR_TOP,
  13         INTEL_TLV_CNVI_BT,
  14         INTEL_TLV_CNVR_BT,
  15         INTEL_TLV_CNVI_OTP,
  16         INTEL_TLV_CNVR_OTP,
  17         INTEL_TLV_DEV_REV_ID,
  18         INTEL_TLV_USB_VENDOR_ID,
  19         INTEL_TLV_USB_PRODUCT_ID,
  20         INTEL_TLV_PCIE_VENDOR_ID,
  21         INTEL_TLV_PCIE_DEVICE_ID,
  22         INTEL_TLV_PCIE_SUBSYSTEM_ID,
  23         INTEL_TLV_IMAGE_TYPE,
  24         INTEL_TLV_TIME_STAMP,
  25         INTEL_TLV_BUILD_TYPE,
  26         INTEL_TLV_BUILD_NUM,
  27         INTEL_TLV_FW_BUILD_PRODUCT,
  28         INTEL_TLV_FW_BUILD_HW,
  29         INTEL_TLV_FW_STEP,
  30         INTEL_TLV_BT_SPEC,
  31         INTEL_TLV_MFG_NAME,
  32         INTEL_TLV_HCI_REV,
  33         INTEL_TLV_LMP_SUBVER,
  34         INTEL_TLV_OTP_PATCH_VER,
  35         INTEL_TLV_SECURE_BOOT,
  36         INTEL_TLV_KEY_FROM_HDR,
  37         INTEL_TLV_OTP_LOCK,
  38         INTEL_TLV_API_LOCK,
  39         INTEL_TLV_DEBUG_LOCK,
  40         INTEL_TLV_MIN_FW,
  41         INTEL_TLV_LIMITED_CCE,
  42         INTEL_TLV_SBE_TYPE,
  43         INTEL_TLV_OTP_BDADDR,
  44         INTEL_TLV_UNLOCKED_STATE,
  45         INTEL_TLV_GIT_SHA1,
  46         INTEL_TLV_FW_ID = 0x50
  47 };
  48
  49 struct intel_tlv {
  50         u8 type;
  51         u8 len;
  52         u8 val[];
  53 } __packed;
  54
  55 #define BTINTEL_CNVI_BLAZARI            0x900
  56 #define BTINTEL_CNVI_BLAZARIW           0x901
  57 #define BTINTEL_CNVI_GAP                0x910
  58 #define BTINTEL_CNVI_BLAZARU            0x930
  59
  60 #define BTINTEL_IMG_BOOTLOADER          0x01    /* Bootloader image */
  61 #define BTINTEL_IMG_IML                 0x02    /* Intermediate image */
  62 #define BTINTEL_IMG_OP                  0x03    /* Operational image */
  63
  64 #define BTINTEL_FWID_MAXLEN 64
  65
  66 struct intel_version_tlv {
  67         u32     cnvi_top;
  68         u32     cnvr_top;
  69         u32     cnvi_bt;
  70         u32     cnvr_bt;
  71         u16     dev_rev_id;
  72         u8      img_type;
  73         u16     timestamp;
  74         u8      build_type;
  75         u32     build_num;
  76         u8      secure_boot;
  77         u8      otp_lock;
  78         u8      api_lock;
  79         u8      debug_lock;
  80         u8      min_fw_build_nn;
  81         u8      min_fw_build_cw;
  82         u8      min_fw_build_yy;
  83         u8      limited_cce;
  84         u8      sbe_type;
  85         u32     git_sha1;
  86         u8      fw_id[BTINTEL_FWID_MAXLEN];
  87         bdaddr_t otp_bd_addr;
  88 };
  89
  90 struct intel_version {
  91         u8 status;
  92         u8 hw_platform;
  93         u8 hw_variant;
  94         u8 hw_revision;
  95         u8 fw_variant;
  96         u8 fw_revision;
  97         u8 fw_build_num;
  98         u8 fw_build_ww;
  99         u8 fw_build_yy;
 100         u8 fw_patch_num;
 101 } __packed;
 102
 103 struct intel_boot_params {
 104         __u8     status;
 105         __u8     otp_format;
 106         __u8     otp_content;
 107         __u8     otp_patch;
 108         __le16   dev_revid;
 109         __u8     secure_boot;
 110         __u8     key_from_hdr;
 111         __u8     key_type;
 112         __u8     otp_lock;
 113         __u8     api_lock;
 114         __u8     debug_lock;
 115         bdaddr_t otp_bdaddr;
 116         __u8     min_fw_build_nn;
 117         __u8     min_fw_build_cw;
 118         __u8     min_fw_build_yy;
 119         __u8     limited_cce;
 120         __u8     unlocked_state;
 121 } __packed;
 122
 123 struct intel_bootup {
 124         __u8     zero;
 125         __u8     num_cmds;
 126         __u8     source;
 127         __u8     reset_type;
 128         __u8     reset_reason;
 129         __u8     ddc_status;
 130 } __packed;
 131
 132 struct intel_secure_send_result {
 133         __u8     result;
 134         __le16   opcode;
 135         __u8     status;
 136 } __packed;
 137
 138 struct intel_reset {
 139         __u8     reset_type;
 140         __u8     patch_enable;
 141         __u8     ddc_reload;
 142         __u8     boot_option;
 143         __le32   boot_param;
 144 } __packed;
 145
 146 struct intel_debug_features {
 147         __u8    page1[16];
 148 } __packed;
 149
 150 struct intel_offload_use_cases {
 151         __u8    status;
 152         __u8    preset[8];
 153 } __packed;
 154
 155 #define INTEL_OP_PPAG_CMD               0xFE0B
 156 struct hci_ppag_enable_cmd {
 157         __le32  ppag_enable_flags;
 158 } __packed;
 159
 160 #define INTEL_TLV_TYPE_ID               0x01
 161
 162 #define INTEL_TLV_SYSTEM_EXCEPTION      0x00
 163 #define INTEL_TLV_FATAL_EXCEPTION       0x01
 164 #define INTEL_TLV_DEBUG_EXCEPTION       0x02
 165 #define INTEL_TLV_TEST_EXCEPTION        0xDE
 166
 167 #define INTEL_HW_PLATFORM(cnvx_bt)      ((u8)(((cnvx_bt) & 0x0000ff00) >> 8))
 168 #define INTEL_HW_VARIANT(cnvx_bt)       ((u8)(((cnvx_bt) & 0x003f0000) >> 16))
 169 #define INTEL_CNVX_TOP_TYPE(cnvx_top)   ((cnvx_top) & 0x00000fff)
 170 #define INTEL_CNVX_TOP_STEP(cnvx_top)   (((cnvx_top) & 0x0f000000) >> 24)
 171 #define INTEL_CNVX_TOP_PACK_SWAB(t, s)  __swab16(((__u16)(((t) << 4) | (s))))
 172
 173 enum {
 174         INTEL_BOOTLOADER,
 175         INTEL_DOWNLOADING,
 176         INTEL_FIRMWARE_LOADED,
 177         INTEL_FIRMWARE_FAILED,
 178         INTEL_BOOTING,
 179         INTEL_BROKEN_INITIAL_NCMD,
 180         INTEL_BROKEN_SHUTDOWN_LED,
 181         INTEL_ROM_LEGACY,
 182         INTEL_ROM_LEGACY_NO_WBS_SUPPORT,
 183         INTEL_ACPI_RESET_ACTIVE,
 184         INTEL_WAIT_FOR_D0,
 185
 186         __INTEL_NUM_FLAGS,
 187 };
 188
 189 struct btintel_data {
 190         DECLARE_BITMAP(flags, __INTEL_NUM_FLAGS);
 191         int (*acpi_reset_method)(struct hci_dev *hdev);
 192 };
 193
 194 #define btintel_set_flag(hdev, nr)                                      \
 195         do {                                                            \
 196                 struct btintel_data *intel = hci_get_priv((hdev));      \
 197                 set_bit((nr), intel->flags);                            \
 198         } while (0)
 199
 200 #define btintel_clear_flag(hdev, nr)                                    \
 201         do {                                                            \
 202                 struct btintel_data *intel = hci_get_priv((hdev));      \
 203                 clear_bit((nr), intel->flags);                          \
 204         } while (0)
 205
 206 #define btintel_wake_up_flag(hdev, nr)                                  \
 207         do {                                                            \
 208                 struct btintel_data *intel = hci_get_priv((hdev));      \
 209                 wake_up_bit(intel->flags, (nr));                        \
 210         } while (0)
 211
 212 #define btintel_get_flag(hdev)                                          \
 213         (((struct btintel_data *)hci_get_priv(hdev))->flags)
 214
 215 #define btintel_test_flag(hdev, nr)     test_bit((nr), btintel_get_flag(hdev))
 216 #define btintel_test_and_clear_flag(hdev, nr) test_and_clear_bit((nr), btintel_get_flag(hdev))
 217 #define btintel_wait_on_flag_timeout(hdev, nr, m, to)                   \
 218                 wait_on_bit_timeout(btintel_get_flag(hdev), (nr), m, to)
 219
 220 #if IS_ENABLED(CONFIG_BT_INTEL) || IS_ENABLED(CONFIG_BT_INTEL_PCIE)
 221
 222 int btintel_check_bdaddr(struct hci_dev *hdev);
 223 int btintel_enter_mfg(struct hci_dev *hdev);
 224 int btintel_exit_mfg(struct hci_dev *hdev, bool reset, bool patched);
 225 int btintel_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr);
 226 int btintel_set_diag(struct hci_dev *hdev, bool enable);
 227
 228 int btintel_version_info(struct hci_dev *hdev, struct intel_version *ver);
 229 int btintel_load_ddc_config(struct hci_dev *hdev, const char *ddc_name);
 230 int btintel_set_event_mask_mfg(struct hci_dev *hdev, bool debug);
 231 int btintel_read_version(struct hci_dev *hdev, struct intel_version *ver);
 232 struct regmap *btintel_regmap_init(struct hci_dev *hdev, u16 opcode_read,
 233                                    u16 opcode_write);
 234 int btintel_send_intel_reset(struct hci_dev *hdev, u32 boot_param);
 235 int btintel_read_boot_params(struct hci_dev *hdev,
 236                              struct intel_boot_params *params);
 237 int btintel_download_firmware(struct hci_dev *dev, struct intel_version *ver,
 238                               const struct firmware *fw, u32 *boot_param);
 239 int btintel_configure_setup(struct hci_dev *hdev, const char *driver_name);
 240 int btintel_recv_event(struct hci_dev *hdev, struct sk_buff *skb);
 241 void btintel_bootup(struct hci_dev *hdev, const void *ptr, unsigned int len);
 242 void btintel_secure_send_result(struct hci_dev *hdev,
 243                                 const void *ptr, unsigned int len);
 244 int btintel_set_quality_report(struct hci_dev *hdev, bool enable);
 245 int btintel_version_info_tlv(struct hci_dev *hdev,
 246                              struct intel_version_tlv *version);
 247 int btintel_parse_version_tlv(struct hci_dev *hdev,
 248                               struct intel_version_tlv *version,
 249                               struct sk_buff *skb);
 250 void btintel_set_msft_opcode(struct hci_dev *hdev, u8 hw_variant);
 251 int btintel_bootloader_setup_tlv(struct hci_dev *hdev,
 252                                  struct intel_version_tlv *ver);
 253 int btintel_shutdown_combined(struct hci_dev *hdev);
 254 void btintel_hw_error(struct hci_dev *hdev, u8 code);
 255 void btintel_print_fseq_info(struct hci_dev *hdev);
 256 int btintel_diagnostics(struct hci_dev *hdev, struct sk_buff *skb);
 257 #else
 258
 259 static inline int btintel_check_bdaddr(struct hci_dev *hdev)
 260 {
 261         return -EOPNOTSUPP;
 262 }
 263
 264 static inline int btintel_enter_mfg(struct hci_dev *hdev)
 265 {
 266         return -EOPNOTSUPP;
 267 }
 268
 269 static inline int btintel_exit_mfg(struct hci_dev *hdev, bool reset, bool patched)
 270 {
 271         return -EOPNOTSUPP;
 272 }
 273
 274 static inline int btintel_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr)
 275 {
 276         return -EOPNOTSUPP;
 277 }
 278
 279 static inline int btintel_set_diag(struct hci_dev *hdev, bool enable)
 280 {
 281         return -EOPNOTSUPP;
 282 }
 283
 284 static inline int btintel_version_info(struct hci_dev *hdev,
 285                                        struct intel_version *ver)
 286 {
 287         return -EOPNOTSUPP;
 288 }
 289
 290 static inline int btintel_load_ddc_config(struct hci_dev *hdev,
 291                                           const char *ddc_name)
 292 {
 293         return -EOPNOTSUPP;
 294 }
 295
 296 static inline int btintel_set_event_mask_mfg(struct hci_dev *hdev, bool debug)
 297 {
 298         return -EOPNOTSUPP;
 299 }
 300
 301 static inline int btintel_read_version(struct hci_dev *hdev,
 302                                        struct intel_version *ver)
 303 {
 304         return -EOPNOTSUPP;
 305 }
 306
 307 static inline struct regmap *btintel_regmap_init(struct hci_dev *hdev,
 308                                                  u16 opcode_read,
 309                                                  u16 opcode_write)
 310 {
 311         return ERR_PTR(-EINVAL);
 312 }
 313
 314 static inline int btintel_send_intel_reset(struct hci_dev *hdev,
 315                                            u32 reset_param)
 316 {
 317         return -EOPNOTSUPP;
 318 }
 319
 320 static inline int btintel_read_boot_params(struct hci_dev *hdev,
 321                                            struct intel_boot_params *params)
 322 {
 323         return -EOPNOTSUPP;
 324 }
 325
 326 static inline int btintel_download_firmware(struct hci_dev *dev,
 327                                             const struct firmware *fw,
 328                                             u32 *boot_param)
 329 {
 330         return -EOPNOTSUPP;
 331 }
 332
 333 static inline int btintel_configure_setup(struct hci_dev *hdev,
 334                                           const char *driver_name)
 335 {
 336         return -ENODEV;
 337 }
 338
 339 static inline void btintel_bootup(struct hci_dev *hdev,
 340                                   const void *ptr, unsigned int len)
 341 {
 342 }
 343
 344 static inline void btintel_secure_send_result(struct hci_dev *hdev,
 345                                 const void *ptr, unsigned int len)
 346 {
 347 }
 348
 349 static inline int btintel_set_quality_report(struct hci_dev *hdev, bool enable)
 350 {
 351         return -ENODEV;
 352 }
 353
 354 static inline int btintel_version_info_tlv(struct hci_dev *hdev,
 355                                            struct intel_version_tlv *version)
 356 {
 357         return -EOPNOTSUPP;
 358 }
 359
 360 static inline int btintel_parse_version_tlv(struct hci_dev *hdev,
 361                                             struct intel_version_tlv *version,
 362                                             struct sk_buff *skb)
 363 {
 364         return -EOPNOTSUPP;
 365 }
 366
 367 static inline void btintel_set_msft_opcode(struct hci_dev *hdev, u8 hw_variant)
 368
 369 {
 370 }
 371
 372 static inline int btintel_bootloader_setup_tlv(struct hci_dev *hdev,
 373                                                struct intel_version_tlv *ver)
 374 {
 375         return -ENODEV;
 376 }
 377
 378 static inline int btintel_shutdown_combined(struct hci_dev *hdev)
 379 {
 380         return -ENODEV;
 381 }
 382
 383 static inline void btintel_hw_error(struct hci_dev *hdev, u8 code)
 384 {
 385 }
 386
 387 static inline void btintel_print_fseq_info(struct hci_dev *hdev)
 388 {
 389 }
 390
 391 static inline int btintel_diagnostics(struct hci_dev *hdev, struct sk_buff *skb)
 392 {
 393         return -EOPNOTSUPP;
 394 }
 395 #endif