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 };
  46
  47 struct intel_tlv {
  48         u8 type;
  49         u8 len;
  50         u8 val[];
  51 } __packed;
  52
  53 struct intel_version_tlv {
  54         u32     cnvi_top;
  55         u32     cnvr_top;
  56         u32     cnvi_bt;
  57         u32     cnvr_bt;
  58         u16     dev_rev_id;
  59         u8      img_type;
  60         u16     timestamp;
  61         u8      build_type;
  62         u32     build_num;
  63         u8      secure_boot;
  64         u8      otp_lock;
  65         u8      api_lock;
  66         u8      debug_lock;
  67         u8      min_fw_build_nn;
  68         u8      min_fw_build_cw;
  69         u8      min_fw_build_yy;
  70         u8      limited_cce;
  71         u8      sbe_type;
  72         bdaddr_t otp_bd_addr;
  73 };
  74
  75 struct intel_version {
  76         u8 status;
  77         u8 hw_platform;
  78         u8 hw_variant;
  79         u8 hw_revision;
  80         u8 fw_variant;
  81         u8 fw_revision;
  82         u8 fw_build_num;
  83         u8 fw_build_ww;
  84         u8 fw_build_yy;
  85         u8 fw_patch_num;
  86 } __packed;
  87
  88 struct intel_boot_params {
  89         __u8     status;
  90         __u8     otp_format;
  91         __u8     otp_content;
  92         __u8     otp_patch;
  93         __le16   dev_revid;
  94         __u8     secure_boot;
  95         __u8     key_from_hdr;
  96         __u8     key_type;
  97         __u8     otp_lock;
  98         __u8     api_lock;
  99         __u8     debug_lock;
 100         bdaddr_t otp_bdaddr;
 101         __u8     min_fw_build_nn;
 102         __u8     min_fw_build_cw;
 103         __u8     min_fw_build_yy;
 104         __u8     limited_cce;
 105         __u8     unlocked_state;
 106 } __packed;
 107
 108 struct intel_bootup {
 109         __u8     zero;
 110         __u8     num_cmds;
 111         __u8     source;
 112         __u8     reset_type;
 113         __u8     reset_reason;
 114         __u8     ddc_status;
 115 } __packed;
 116
 117 struct intel_secure_send_result {
 118         __u8     result;
 119         __le16   opcode;
 120         __u8     status;
 121 } __packed;
 122
 123 struct intel_reset {
 124         __u8     reset_type;
 125         __u8     patch_enable;
 126         __u8     ddc_reload;
 127         __u8     boot_option;
 128         __le32   boot_param;
 129 } __packed;
 130
 131 struct intel_debug_features {
 132         __u8    page1[16];
 133 } __packed;
 134
 135 #define INTEL_HW_PLATFORM(cnvx_bt)      ((u8)(((cnvx_bt) & 0x0000ff00) >> 8))
 136 #define INTEL_HW_VARIANT(cnvx_bt)       ((u8)(((cnvx_bt) & 0x003f0000) >> 16))
 137 #define INTEL_CNVX_TOP_TYPE(cnvx_top)   ((cnvx_top) & 0x00000fff)
 138 #define INTEL_CNVX_TOP_STEP(cnvx_top)   (((cnvx_top) & 0x0f000000) >> 24)
 139 #define INTEL_CNVX_TOP_PACK_SWAB(t, s)  __swab16(((__u16)(((t) << 4) | (s))))
 140
 141 #if IS_ENABLED(CONFIG_BT_INTEL)
 142
 143 int btintel_check_bdaddr(struct hci_dev *hdev);
 144 int btintel_enter_mfg(struct hci_dev *hdev);
 145 int btintel_exit_mfg(struct hci_dev *hdev, bool reset, bool patched);
 146 int btintel_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr);
 147 int btintel_set_diag(struct hci_dev *hdev, bool enable);
 148 int btintel_set_diag_mfg(struct hci_dev *hdev, bool enable);
 149 void btintel_hw_error(struct hci_dev *hdev, u8 code);
 150
 151 void btintel_version_info(struct hci_dev *hdev, struct intel_version *ver);
 152 int btintel_version_info_tlv(struct hci_dev *hdev, struct intel_version_tlv *version);
 153 int btintel_secure_send(struct hci_dev *hdev, u8 fragment_type, u32 plen,
 154                         const void *param);
 155 int btintel_load_ddc_config(struct hci_dev *hdev, const char *ddc_name);
 156 int btintel_set_event_mask(struct hci_dev *hdev, bool debug);
 157 int btintel_set_event_mask_mfg(struct hci_dev *hdev, bool debug);
 158 int btintel_read_version(struct hci_dev *hdev, struct intel_version *ver);
 159 int btintel_read_version_tlv(struct hci_dev *hdev, struct intel_version_tlv *ver);
 160
 161 struct regmap *btintel_regmap_init(struct hci_dev *hdev, u16 opcode_read,
 162                                    u16 opcode_write);
 163 int btintel_send_intel_reset(struct hci_dev *hdev, u32 boot_param);
 164 int btintel_read_boot_params(struct hci_dev *hdev,
 165                              struct intel_boot_params *params);
 166 int btintel_download_firmware(struct hci_dev *dev, struct intel_version *ver,
 167                               const struct firmware *fw, u32 *boot_param);
 168 int btintel_download_firmware_newgen(struct hci_dev *hdev,
 169                                      struct intel_version_tlv *ver,
 170                                      const struct firmware *fw,
 171                                      u32 *boot_param, u8 hw_variant,
 172                                      u8 sbe_type);
 173 void btintel_reset_to_bootloader(struct hci_dev *hdev);
 174 int btintel_read_debug_features(struct hci_dev *hdev,
 175                                 struct intel_debug_features *features);
 176 int btintel_set_debug_features(struct hci_dev *hdev,
 177                                const struct intel_debug_features *features);
 178 #else
 179
 180 static inline int btintel_check_bdaddr(struct hci_dev *hdev)
 181 {
 182         return -EOPNOTSUPP;
 183 }
 184
 185 static inline int btintel_enter_mfg(struct hci_dev *hdev)
 186 {
 187         return -EOPNOTSUPP;
 188 }
 189
 190 static inline int btintel_exit_mfg(struct hci_dev *hdev, bool reset, bool patched)
 191 {
 192         return -EOPNOTSUPP;
 193 }
 194
 195 static inline int btintel_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr)
 196 {
 197         return -EOPNOTSUPP;
 198 }
 199
 200 static inline int btintel_set_diag(struct hci_dev *hdev, bool enable)
 201 {
 202         return -EOPNOTSUPP;
 203 }
 204
 205 static inline int btintel_set_diag_mfg(struct hci_dev *hdev, bool enable)
 206 {
 207         return -EOPNOTSUPP;
 208 }
 209
 210 static inline void btintel_hw_error(struct hci_dev *hdev, u8 code)
 211 {
 212 }
 213
 214 static inline void btintel_version_info(struct hci_dev *hdev,
 215                                         struct intel_version *ver)
 216 {
 217 }
 218
 219 static inline int btintel_version_info_tlv(struct hci_dev *hdev,
 220                                            struct intel_version_tlv *version)
 221 {
 222         return -EOPNOTSUPP;
 223 }
 224
 225 static inline int btintel_secure_send(struct hci_dev *hdev, u8 fragment_type,
 226                                       u32 plen, const void *param)
 227 {
 228         return -EOPNOTSUPP;
 229 }
 230
 231 static inline int btintel_load_ddc_config(struct hci_dev *hdev,
 232                                           const char *ddc_name)
 233 {
 234         return -EOPNOTSUPP;
 235 }
 236
 237 static inline int btintel_set_event_mask(struct hci_dev *hdev, bool debug)
 238 {
 239         return -EOPNOTSUPP;
 240 }
 241
 242 static inline int btintel_set_event_mask_mfg(struct hci_dev *hdev, bool debug)
 243 {
 244         return -EOPNOTSUPP;
 245 }
 246
 247 static inline int btintel_read_version(struct hci_dev *hdev,
 248                                        struct intel_version *ver)
 249 {
 250         return -EOPNOTSUPP;
 251 }
 252
 253 static inline int btintel_read_version_tlv(struct hci_dev *hdev,
 254                                            struct intel_version_tlv *ver)
 255 {
 256         return -EOPNOTSUPP;
 257 }
 258
 259 static inline struct regmap *btintel_regmap_init(struct hci_dev *hdev,
 260                                                  u16 opcode_read,
 261                                                  u16 opcode_write)
 262 {
 263         return ERR_PTR(-EINVAL);
 264 }
 265
 266 static inline int btintel_send_intel_reset(struct hci_dev *hdev,
 267                                            u32 reset_param)
 268 {
 269         return -EOPNOTSUPP;
 270 }
 271
 272 static inline int btintel_read_boot_params(struct hci_dev *hdev,
 273                                            struct intel_boot_params *params)
 274 {
 275         return -EOPNOTSUPP;
 276 }
 277
 278 static inline int btintel_download_firmware(struct hci_dev *dev,
 279                                             const struct firmware *fw,
 280                                             u32 *boot_param)
 281 {
 282         return -EOPNOTSUPP;
 283 }
 284
 285 static inline int btintel_download_firmware_newgen(struct hci_dev *hdev,
 286                                                    const struct firmware *fw,
 287                                                    u32 *boot_param,
 288                                                    u8 hw_variant, u8 sbe_type)
 289 {
 290         return -EOPNOTSUPP;
 291 }
 292
 293 static inline void btintel_reset_to_bootloader(struct hci_dev *hdev)
 294 {
 295 }
 296
 297 static inline int btintel_read_debug_features(struct hci_dev *hdev,
 298                                               struct intel_debug_features *features)
 299 {
 300         return -EOPNOTSUPP;
 301 }
 302
 303 static inline int btintel_set_debug_features(struct hci_dev *hdev,
 304                                              const struct intel_debug_features *features)
 305 {
 306         return -EOPNOTSUPP;
 307 }
 308
 309 #endif