common.h 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325
  1. /******************************************************************************
  2. * Copyright (C) 2015, The Linux Foundation. All rights reserved.
  3. * Copyright (C) 2019-2022 NXP
  4. *
  5. * This program is free software; you can redistribute it and/or modify
  6. * it under the terms of the GNU General Public License as published by
  7. * the Free Software Foundation; either version 2 of the License, or
  8. * (at your option) any later version.
  9. *
  10. * This program is distributed in the hope that it will be useful,
  11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13. * GNU General Public License for more details.
  14. *
  15. * You should have received a copy of the GNU General Public License
  16. * along with this program; if not, write to the Free Software
  17. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  18. *
  19. ******************************************************************************/
  20. /*
  21. * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
  22. *
  23. *****************************************************************************/
  24. #ifndef _COMMON_H_
  25. #define _COMMON_H_
  26. #include <linux/cdev.h>
  27. #include <linux/of_gpio.h>
  28. #include <linux/delay.h>
  29. #include <linux/ipc_logging.h>
  30. #include <linux/clk.h>
  31. #include <nfcinfo.h>
  32. #include "i2c_drv.h"
  33. #include "ese_cold_reset.h"
  34. /*secure library headers*/
  35. #include "smcinvoke.h"
  36. #include "smcinvoke_object.h"
  37. #include "IClientEnv.h"
  38. /* Max device count for this driver */
  39. #define DEV_COUNT 1
  40. /* i2c device class */
  41. #define CLASS_NAME "qti-nfc"
  42. /* NFC character device name, this will be in /dev/ */
  43. #define NFC_CHAR_DEV_NAME "nq-nci"
  44. /* NCI packet details */
  45. #define NCI_CMD (0x20)
  46. #define NCI_RSP (0x40)
  47. #define NCI_NTF (0x60)
  48. #define NCI_HDR_LEN (3)
  49. #define NCI_HDR_IDX (0)
  50. #define DL_CMD 0x00
  51. #define DL_PAYLOAD_BYTE_ZERO 0x00
  52. #define NCI_HDR_OID_IDX (1)
  53. #define NCI_PAYLOAD_IDX (3)
  54. #define NCI_PAYLOAD_LEN_IDX (2)
  55. /*Time to wait for first NCI rest response*/
  56. #define NCI_RESET_RESP_READ_DELAY (10000) // 10ms
  57. #define NCI_RESET_RESP_TIMEOUT (500) // 500ms
  58. // FW DNLD packet details
  59. #define FW_MSG_CMD_RSP 0x00
  60. #define DL_HDR_LEN (2)
  61. #define DL_CRC_LEN (2)
  62. #define NCI_RSP_PKT_TYPE (0x40)
  63. #define MAX_NCI_PAYLOAD_LEN (255)
  64. #define MAX_NCI_BUFFER_SIZE (NCI_HDR_LEN + MAX_NCI_PAYLOAD_LEN)
  65. /*
  66. * From MW 11.04 buffer size increased to support
  67. * frame size of 554 in FW download mode
  68. * Frame len(2) + Frame Header(6) + DATA(512) + HASH(32) + CRC(2) + RFU(4)
  69. */
  70. #define MAX_DL_PAYLOAD_LEN (550)
  71. #define MAX_DL_BUFFER_SIZE (DL_HDR_LEN + DL_CRC_LEN + \
  72. MAX_DL_PAYLOAD_LEN)
  73. /* Retry count for normal write */
  74. #define NO_RETRY (1)
  75. /* Maximum retry count for standby writes */
  76. #define MAX_RETRY_COUNT (3)
  77. #define MAX_WRITE_IRQ_COUNT (5)
  78. #define MAX_IRQ_WAIT_TIME (90)
  79. #define WAKEUP_SRC_TIMEOUT (2000)
  80. /* command response timeout */
  81. #define NCI_CMD_RSP_TIMEOUT_MS (2000)
  82. /* Time to wait for NFCC to be ready again after any change in the GPIO */
  83. #define NFC_GPIO_SET_WAIT_TIME_US (10000)
  84. /* Time to wait before retrying writes */
  85. #define WRITE_RETRY_WAIT_TIME_US (3000)
  86. /* Time to wait before retrying read for some specific usecases */
  87. #define READ_RETRY_WAIT_TIME_US (3500)
  88. #define NFC_MAGIC (0xE9)
  89. // Ioctls
  90. // The type should be aligned with MW HAL definitions
  91. #define NFC_SET_PWR _IOW(NFC_MAGIC, 0x01, uint32_t)
  92. #define ESE_SET_PWR _IOW(NFC_MAGIC, 0x02, uint32_t)
  93. #define ESE_GET_PWR _IOR(NFC_MAGIC, 0x03, uint32_t)
  94. #define NFC_SECURE_ZONE _IOW(NFC_MAGIC, 0x0A, uint32_t)
  95. #define DTS_IRQ_GPIO_STR "qcom,sn-irq"
  96. #define DTS_VEN_GPIO_STR "qcom,sn-ven"
  97. #define DTS_FWDN_GPIO_STR "qcom,sn-firm"
  98. #define DTS_CLKREQ_GPIO_STR "qcom,sn-clkreq"
  99. #define DTS_CLKSRC_GPIO_STR "qcom,clk-src"
  100. #define DTS_SZONE_STR "qcom,sn-szone"
  101. #define NFC_LDO_SUPPLY_DT_NAME "qcom,sn-vdd-1p8"
  102. #define NFC_LDO_SUPPLY_NAME "qcom,sn-vdd-1p8-supply"
  103. #define NFC_LDO_VOL_DT_NAME "qcom,sn-vdd-1p8-voltage"
  104. #define NFC_LDO_CUR_DT_NAME "qcom,sn-vdd-1p8-current"
  105. //as per SN1x0 datasheet
  106. #define NFC_VDDIO_MIN 1650000 //in uV
  107. #define NFC_VDDIO_MAX 1950000 //in uV
  108. #define NFC_CURRENT_MAX 157000 //in uA
  109. //NFC ID for registration with secure libraries
  110. #define HW_STATE_UID 0x108
  111. #define HW_OP_GET_STATE 1
  112. #define HW_NFC_UID 0x506
  113. #define FEATURE_NOT_SUPPORTED 12
  114. #define PERIPHERAL_NOT_FOUND 10
  115. #define NUM_OF_IPC_LOG_PAGES (2)
  116. #define PKT_MAX_LEN (4) // no of max bytes to print for cmd/resp
  117. #define GET_IPCLOG_MAX_PKT_LEN(c) ((c > PKT_MAX_LEN) ? PKT_MAX_LEN : c)
  118. #define NFCLOG_IPC(nfc_dev, log_to_dmesg, x...) \
  119. do { \
  120. ipc_log_string(nfc_dev->ipcl, x); \
  121. if (log_to_dmesg) { \
  122. if (nfc_dev->nfc_device) \
  123. dev_err((nfc_dev->nfc_device), x); \
  124. else \
  125. pr_err(x); \
  126. } \
  127. } while (0)
  128. static struct semaphore sem_eSE_pwr_off;
  129. static bool chk_eSE_pwr_off;
  130. enum ese_ioctl_request {
  131. /* eSE POWER ON */
  132. ESE_POWER_ON = 0,
  133. /* eSE POWER OFF */
  134. ESE_POWER_OFF,
  135. /* eSE POWER STATE */
  136. ESE_POWER_STATE
  137. };
  138. enum nfcc_ioctl_request {
  139. /* NFC disable request with VEN LOW */
  140. NFC_POWER_OFF = 0,
  141. /* NFC enable request with VEN Toggle */
  142. NFC_POWER_ON,
  143. /* firmware download request with VEN Toggle */
  144. NFC_FW_DWL_VEN_TOGGLE,
  145. /* ISO reset request */
  146. NFC_ISO_RESET,
  147. /* request for firmware download gpio HIGH */
  148. NFC_FW_DWL_HIGH,
  149. /* VEN hard reset request */
  150. NFC_VEN_FORCED_HARD_RESET,
  151. /* request for firmware download gpio LOW */
  152. NFC_FW_DWL_LOW,
  153. /* NFC enable without VEN gpio modification */
  154. NFC_ENABLE,
  155. /* NFC disable without VEN gpio modification */
  156. NFC_DISABLE,
  157. };
  158. /* nfc platform interface type */
  159. enum interface_flags {
  160. /* I2C physical IF for NFCC */
  161. PLATFORM_IF_I2C = 0,
  162. };
  163. /* nfc state flags */
  164. enum nfc_state_flags {
  165. /* nfc in unknown state */
  166. NFC_STATE_UNKNOWN = 0,
  167. /* nfc in download mode */
  168. NFC_STATE_FW_DWL = 0x1,
  169. /* nfc booted in NCI mode */
  170. NFC_STATE_NCI = 0x2,
  171. /* nfc booted in Fw teared mode */
  172. NFC_STATE_FW_TEARED = 0x4,
  173. };
  174. /*
  175. * Power state for IBI handing, mainly needed to defer the IBI handling
  176. * for the IBI received in suspend state to do it later in resume call
  177. */
  178. enum pm_state_flags {
  179. PM_STATE_NORMAL = 0,
  180. PM_STATE_SUSPEND,
  181. PM_STATE_IBI_BEFORE_RESUME,
  182. };
  183. /* Enum for GPIO values */
  184. enum gpio_values {
  185. GPIO_INPUT = 0x0,
  186. GPIO_OUTPUT = 0x1,
  187. GPIO_HIGH = 0x2,
  188. GPIO_OUTPUT_HIGH = 0x3,
  189. GPIO_IRQ = 0x4,
  190. };
  191. /* NFC GPIO variables */
  192. struct platform_gpio {
  193. unsigned int irq;
  194. unsigned int ven;
  195. unsigned int clkreq;
  196. unsigned int dwl_req;
  197. };
  198. // NFC LDO entries from DT
  199. struct platform_ldo {
  200. int vdd_levels[2];
  201. int max_current;
  202. };
  203. /* NFC Struct to get all the required configs from DTS */
  204. struct platform_configs {
  205. struct platform_gpio gpio;
  206. struct platform_ldo ldo;
  207. const char *clk_src_name;
  208. /* NFC_CLK pin voting state */
  209. bool clk_pin_voting;
  210. const char *szone;
  211. bool CNSS_NFC_HW_SECURE_ENABLE;
  212. };
  213. /* Device specific structure */
  214. struct nfc_dev {
  215. wait_queue_head_t read_wq;
  216. struct mutex read_mutex;
  217. struct mutex write_mutex;
  218. uint8_t *read_kbuf;
  219. uint8_t *write_kbuf;
  220. struct mutex dev_ref_mutex;
  221. unsigned int dev_ref_count;
  222. struct class *nfc_class;
  223. struct device *nfc_device;
  224. struct cdev c_dev;
  225. dev_t devno;
  226. /* Interface flag */
  227. uint8_t interface;
  228. /* nfc state flags */
  229. uint8_t nfc_state;
  230. /* NFC VEN pin state */
  231. bool nfc_ven_enabled;
  232. /* current firmware major version */
  233. uint8_t fw_major_version;
  234. bool is_vreg_enabled;
  235. bool is_ese_session_active;
  236. bool release_read;
  237. union {
  238. struct i2c_dev i2c_dev;
  239. };
  240. struct platform_configs configs;
  241. struct cold_reset cold_reset;
  242. struct regulator *reg;
  243. /* read buffer*/
  244. size_t kbuflen;
  245. u8 *kbuf;
  246. union nqx_uinfo nqx_info;
  247. /*secure zone state*/
  248. bool secure_zone;
  249. /* CLK control */
  250. bool clk_run;
  251. struct clk *s_clk;
  252. void *ipcl;
  253. /* function pointers for the common i2c functionality */
  254. int (*nfc_read)(struct nfc_dev *dev, char *buf, size_t count,
  255. int timeout);
  256. int (*nfc_write)(struct nfc_dev *dev, const char *buf,
  257. const size_t count, int max_retry_cnt);
  258. int (*nfc_enable_intr)(struct nfc_dev *dev);
  259. int (*nfc_disable_intr)(struct nfc_dev *dev);
  260. };
  261. int nfc_dev_open(struct inode *inode, struct file *filp);
  262. int nfc_dev_flush(struct file *pfile, fl_owner_t id);
  263. int nfc_dev_close(struct inode *inode, struct file *filp);
  264. long nfc_dev_compat_ioctl(struct file *pfile, unsigned int cmd,
  265. unsigned long arg);
  266. long nfc_dev_ioctl(struct file *pfile, unsigned int cmd, unsigned long arg);
  267. int nfc_parse_dt(struct device *dev, struct platform_configs *nfc_configs,
  268. uint8_t interface);
  269. int nfc_misc_register(struct nfc_dev *nfc_dev,
  270. const struct file_operations *nfc_fops, int count,
  271. char *devname, char *classname);
  272. void nfc_misc_unregister(struct nfc_dev *nfc_dev, int count);
  273. int configure_gpio(unsigned int gpio, int flag);
  274. void gpio_set_ven(struct nfc_dev *nfc_dev, int value);
  275. void set_valid_gpio(int gpio, int value);
  276. int nfcc_hw_check(struct nfc_dev *nfc_dev);
  277. unsigned int nfc_ioctl_nfcc_info(struct file *, unsigned long);
  278. void gpio_free_all(struct nfc_dev *nfc_dev);
  279. int nfc_ldo_config(struct device *dev, struct nfc_dev *nfc_dev);
  280. int nfc_ldo_vote(struct nfc_dev *nfc_dev);
  281. int nfc_ese_pwr(struct nfc_dev *nfc_dev, unsigned long arg);
  282. int nfc_ldo_unvote(struct nfc_dev *nfc_dev);
  283. int is_nfc_data_available_for_read(struct nfc_dev *nfc_dev);
  284. int validate_nfc_state_nci(struct nfc_dev *nfc_dev);
  285. int nfc_clock_select(struct nfc_dev *nfc_dev);
  286. int nfc_clock_deselect(struct nfc_dev *nfc_dev);
  287. int nfc_post_init(struct nfc_dev *nfc_dev);
  288. int nfc_dynamic_protection_ioctl(struct nfc_dev *nfc_dev, unsigned long sec_zone_trans);
  289. bool nfc_hw_secure_check(void);
  290. #endif /* _COMMON_H_ */