common.h 9.3 KB

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