btintel.h 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309
  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. /* List of tlv type */
  9. enum {
  10. INTEL_TLV_CNVI_TOP = 0x10,
  11. INTEL_TLV_CNVR_TOP,
  12. INTEL_TLV_CNVI_BT,
  13. INTEL_TLV_CNVR_BT,
  14. INTEL_TLV_CNVI_OTP,
  15. INTEL_TLV_CNVR_OTP,
  16. INTEL_TLV_DEV_REV_ID,
  17. INTEL_TLV_USB_VENDOR_ID,
  18. INTEL_TLV_USB_PRODUCT_ID,
  19. INTEL_TLV_PCIE_VENDOR_ID,
  20. INTEL_TLV_PCIE_DEVICE_ID,
  21. INTEL_TLV_PCIE_SUBSYSTEM_ID,
  22. INTEL_TLV_IMAGE_TYPE,
  23. INTEL_TLV_TIME_STAMP,
  24. INTEL_TLV_BUILD_TYPE,
  25. INTEL_TLV_BUILD_NUM,
  26. INTEL_TLV_FW_BUILD_PRODUCT,
  27. INTEL_TLV_FW_BUILD_HW,
  28. INTEL_TLV_FW_STEP,
  29. INTEL_TLV_BT_SPEC,
  30. INTEL_TLV_MFG_NAME,
  31. INTEL_TLV_HCI_REV,
  32. INTEL_TLV_LMP_SUBVER,
  33. INTEL_TLV_OTP_PATCH_VER,
  34. INTEL_TLV_SECURE_BOOT,
  35. INTEL_TLV_KEY_FROM_HDR,
  36. INTEL_TLV_OTP_LOCK,
  37. INTEL_TLV_API_LOCK,
  38. INTEL_TLV_DEBUG_LOCK,
  39. INTEL_TLV_MIN_FW,
  40. INTEL_TLV_LIMITED_CCE,
  41. INTEL_TLV_SBE_TYPE,
  42. INTEL_TLV_OTP_BDADDR,
  43. INTEL_TLV_UNLOCKED_STATE
  44. };
  45. struct intel_tlv {
  46. u8 type;
  47. u8 len;
  48. u8 val[];
  49. } __packed;
  50. struct intel_version_tlv {
  51. u32 cnvi_top;
  52. u32 cnvr_top;
  53. u32 cnvi_bt;
  54. u32 cnvr_bt;
  55. u16 dev_rev_id;
  56. u8 img_type;
  57. u16 timestamp;
  58. u8 build_type;
  59. u32 build_num;
  60. u8 secure_boot;
  61. u8 otp_lock;
  62. u8 api_lock;
  63. u8 debug_lock;
  64. u8 min_fw_build_nn;
  65. u8 min_fw_build_cw;
  66. u8 min_fw_build_yy;
  67. u8 limited_cce;
  68. u8 sbe_type;
  69. bdaddr_t otp_bd_addr;
  70. };
  71. struct intel_version {
  72. u8 status;
  73. u8 hw_platform;
  74. u8 hw_variant;
  75. u8 hw_revision;
  76. u8 fw_variant;
  77. u8 fw_revision;
  78. u8 fw_build_num;
  79. u8 fw_build_ww;
  80. u8 fw_build_yy;
  81. u8 fw_patch_num;
  82. } __packed;
  83. struct intel_boot_params {
  84. __u8 status;
  85. __u8 otp_format;
  86. __u8 otp_content;
  87. __u8 otp_patch;
  88. __le16 dev_revid;
  89. __u8 secure_boot;
  90. __u8 key_from_hdr;
  91. __u8 key_type;
  92. __u8 otp_lock;
  93. __u8 api_lock;
  94. __u8 debug_lock;
  95. bdaddr_t otp_bdaddr;
  96. __u8 min_fw_build_nn;
  97. __u8 min_fw_build_cw;
  98. __u8 min_fw_build_yy;
  99. __u8 limited_cce;
  100. __u8 unlocked_state;
  101. } __packed;
  102. struct intel_bootup {
  103. __u8 zero;
  104. __u8 num_cmds;
  105. __u8 source;
  106. __u8 reset_type;
  107. __u8 reset_reason;
  108. __u8 ddc_status;
  109. } __packed;
  110. struct intel_secure_send_result {
  111. __u8 result;
  112. __le16 opcode;
  113. __u8 status;
  114. } __packed;
  115. struct intel_reset {
  116. __u8 reset_type;
  117. __u8 patch_enable;
  118. __u8 ddc_reload;
  119. __u8 boot_option;
  120. __le32 boot_param;
  121. } __packed;
  122. struct intel_debug_features {
  123. __u8 page1[16];
  124. } __packed;
  125. struct intel_offload_use_cases {
  126. __u8 status;
  127. __u8 preset[8];
  128. } __packed;
  129. #define INTEL_HW_PLATFORM(cnvx_bt) ((u8)(((cnvx_bt) & 0x0000ff00) >> 8))
  130. #define INTEL_HW_VARIANT(cnvx_bt) ((u8)(((cnvx_bt) & 0x003f0000) >> 16))
  131. #define INTEL_CNVX_TOP_TYPE(cnvx_top) ((cnvx_top) & 0x00000fff)
  132. #define INTEL_CNVX_TOP_STEP(cnvx_top) (((cnvx_top) & 0x0f000000) >> 24)
  133. #define INTEL_CNVX_TOP_PACK_SWAB(t, s) __swab16(((__u16)(((t) << 4) | (s))))
  134. enum {
  135. INTEL_BOOTLOADER,
  136. INTEL_DOWNLOADING,
  137. INTEL_FIRMWARE_LOADED,
  138. INTEL_FIRMWARE_FAILED,
  139. INTEL_BOOTING,
  140. INTEL_BROKEN_INITIAL_NCMD,
  141. INTEL_BROKEN_SHUTDOWN_LED,
  142. INTEL_ROM_LEGACY,
  143. INTEL_ROM_LEGACY_NO_WBS_SUPPORT,
  144. __INTEL_NUM_FLAGS,
  145. };
  146. struct btintel_data {
  147. DECLARE_BITMAP(flags, __INTEL_NUM_FLAGS);
  148. };
  149. #define btintel_set_flag(hdev, nr) \
  150. do { \
  151. struct btintel_data *intel = hci_get_priv((hdev)); \
  152. set_bit((nr), intel->flags); \
  153. } while (0)
  154. #define btintel_clear_flag(hdev, nr) \
  155. do { \
  156. struct btintel_data *intel = hci_get_priv((hdev)); \
  157. clear_bit((nr), intel->flags); \
  158. } while (0)
  159. #define btintel_wake_up_flag(hdev, nr) \
  160. do { \
  161. struct btintel_data *intel = hci_get_priv((hdev)); \
  162. wake_up_bit(intel->flags, (nr)); \
  163. } while (0)
  164. #define btintel_get_flag(hdev) \
  165. (((struct btintel_data *)hci_get_priv(hdev))->flags)
  166. #define btintel_test_flag(hdev, nr) test_bit((nr), btintel_get_flag(hdev))
  167. #define btintel_test_and_clear_flag(hdev, nr) test_and_clear_bit((nr), btintel_get_flag(hdev))
  168. #define btintel_wait_on_flag_timeout(hdev, nr, m, to) \
  169. wait_on_bit_timeout(btintel_get_flag(hdev), (nr), m, to)
  170. #if IS_ENABLED(CONFIG_BT_INTEL)
  171. int btintel_check_bdaddr(struct hci_dev *hdev);
  172. int btintel_enter_mfg(struct hci_dev *hdev);
  173. int btintel_exit_mfg(struct hci_dev *hdev, bool reset, bool patched);
  174. int btintel_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr);
  175. int btintel_set_diag(struct hci_dev *hdev, bool enable);
  176. int btintel_version_info(struct hci_dev *hdev, struct intel_version *ver);
  177. int btintel_load_ddc_config(struct hci_dev *hdev, const char *ddc_name);
  178. int btintel_set_event_mask_mfg(struct hci_dev *hdev, bool debug);
  179. int btintel_read_version(struct hci_dev *hdev, struct intel_version *ver);
  180. struct regmap *btintel_regmap_init(struct hci_dev *hdev, u16 opcode_read,
  181. u16 opcode_write);
  182. int btintel_send_intel_reset(struct hci_dev *hdev, u32 boot_param);
  183. int btintel_read_boot_params(struct hci_dev *hdev,
  184. struct intel_boot_params *params);
  185. int btintel_download_firmware(struct hci_dev *dev, struct intel_version *ver,
  186. const struct firmware *fw, u32 *boot_param);
  187. int btintel_configure_setup(struct hci_dev *hdev);
  188. void btintel_bootup(struct hci_dev *hdev, const void *ptr, unsigned int len);
  189. void btintel_secure_send_result(struct hci_dev *hdev,
  190. const void *ptr, unsigned int len);
  191. int btintel_set_quality_report(struct hci_dev *hdev, bool enable);
  192. #else
  193. static inline int btintel_check_bdaddr(struct hci_dev *hdev)
  194. {
  195. return -EOPNOTSUPP;
  196. }
  197. static inline int btintel_enter_mfg(struct hci_dev *hdev)
  198. {
  199. return -EOPNOTSUPP;
  200. }
  201. static inline int btintel_exit_mfg(struct hci_dev *hdev, bool reset, bool patched)
  202. {
  203. return -EOPNOTSUPP;
  204. }
  205. static inline int btintel_set_bdaddr(struct hci_dev *hdev, const bdaddr_t *bdaddr)
  206. {
  207. return -EOPNOTSUPP;
  208. }
  209. static inline int btintel_set_diag(struct hci_dev *hdev, bool enable)
  210. {
  211. return -EOPNOTSUPP;
  212. }
  213. static inline int btintel_version_info(struct hci_dev *hdev,
  214. struct intel_version *ver)
  215. {
  216. return -EOPNOTSUPP;
  217. }
  218. static inline int btintel_load_ddc_config(struct hci_dev *hdev,
  219. const char *ddc_name)
  220. {
  221. return -EOPNOTSUPP;
  222. }
  223. static inline int btintel_set_event_mask_mfg(struct hci_dev *hdev, bool debug)
  224. {
  225. return -EOPNOTSUPP;
  226. }
  227. static inline int btintel_read_version(struct hci_dev *hdev,
  228. struct intel_version *ver)
  229. {
  230. return -EOPNOTSUPP;
  231. }
  232. static inline struct regmap *btintel_regmap_init(struct hci_dev *hdev,
  233. u16 opcode_read,
  234. u16 opcode_write)
  235. {
  236. return ERR_PTR(-EINVAL);
  237. }
  238. static inline int btintel_send_intel_reset(struct hci_dev *hdev,
  239. u32 reset_param)
  240. {
  241. return -EOPNOTSUPP;
  242. }
  243. static inline int btintel_read_boot_params(struct hci_dev *hdev,
  244. struct intel_boot_params *params)
  245. {
  246. return -EOPNOTSUPP;
  247. }
  248. static inline int btintel_download_firmware(struct hci_dev *dev,
  249. const struct firmware *fw,
  250. u32 *boot_param)
  251. {
  252. return -EOPNOTSUPP;
  253. }
  254. static inline int btintel_configure_setup(struct hci_dev *hdev)
  255. {
  256. return -ENODEV;
  257. }
  258. static inline void btintel_bootup(struct hci_dev *hdev,
  259. const void *ptr, unsigned int len)
  260. {
  261. }
  262. static inline void btintel_secure_send_result(struct hci_dev *hdev,
  263. const void *ptr, unsigned int len)
  264. {
  265. }
  266. static inline int btintel_set_quality_report(struct hci_dev *hdev, bool enable)
  267. {
  268. return -ENODEV;
  269. }
  270. #endif