1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */ 2*4882a593Smuzhiyun /* 3*4882a593Smuzhiyun * NCI based Driver for STMicroelectronics NFC Chip 4*4882a593Smuzhiyun * 5*4882a593Smuzhiyun * Copyright (C) 2014 STMicroelectronics SAS. All rights reserved. 6*4882a593Smuzhiyun */ 7*4882a593Smuzhiyun 8*4882a593Smuzhiyun #ifndef __LOCAL_ST_NCI_H_ 9*4882a593Smuzhiyun #define __LOCAL_ST_NCI_H_ 10*4882a593Smuzhiyun 11*4882a593Smuzhiyun #include "ndlc.h" 12*4882a593Smuzhiyun 13*4882a593Smuzhiyun /* Define private flags: */ 14*4882a593Smuzhiyun #define ST_NCI_RUNNING 1 15*4882a593Smuzhiyun 16*4882a593Smuzhiyun #define ST_NCI_CORE_PROP 0x01 17*4882a593Smuzhiyun #define ST_NCI_SET_NFC_MODE 0x02 18*4882a593Smuzhiyun 19*4882a593Smuzhiyun /* 20*4882a593Smuzhiyun * ref ISO7816-3 chap 8.1. the initial character TS is followed by a 21*4882a593Smuzhiyun * sequence of at most 32 characters. 22*4882a593Smuzhiyun */ 23*4882a593Smuzhiyun #define ST_NCI_ESE_MAX_LENGTH 33 24*4882a593Smuzhiyun 25*4882a593Smuzhiyun #define ST_NCI_DEVICE_MGNT_GATE 0x01 26*4882a593Smuzhiyun 27*4882a593Smuzhiyun #define ST_NCI_VENDOR_OUI 0x0080E1 /* STMicroelectronics */ 28*4882a593Smuzhiyun #define ST_NCI_FACTORY_MODE 2 29*4882a593Smuzhiyun 30*4882a593Smuzhiyun struct nci_mode_set_cmd { 31*4882a593Smuzhiyun u8 cmd_type; 32*4882a593Smuzhiyun u8 mode; 33*4882a593Smuzhiyun } __packed; 34*4882a593Smuzhiyun 35*4882a593Smuzhiyun struct nci_mode_set_rsp { 36*4882a593Smuzhiyun u8 status; 37*4882a593Smuzhiyun } __packed; 38*4882a593Smuzhiyun 39*4882a593Smuzhiyun struct st_nci_se_status { 40*4882a593Smuzhiyun bool is_ese_present; 41*4882a593Smuzhiyun bool is_uicc_present; 42*4882a593Smuzhiyun }; 43*4882a593Smuzhiyun 44*4882a593Smuzhiyun struct st_nci_se_info { 45*4882a593Smuzhiyun struct st_nci_se_status *se_status; 46*4882a593Smuzhiyun u8 atr[ST_NCI_ESE_MAX_LENGTH]; 47*4882a593Smuzhiyun struct completion req_completion; 48*4882a593Smuzhiyun 49*4882a593Smuzhiyun struct timer_list bwi_timer; 50*4882a593Smuzhiyun int wt_timeout; /* in msecs */ 51*4882a593Smuzhiyun bool bwi_active; 52*4882a593Smuzhiyun 53*4882a593Smuzhiyun struct timer_list se_active_timer; 54*4882a593Smuzhiyun bool se_active; 55*4882a593Smuzhiyun 56*4882a593Smuzhiyun bool xch_error; 57*4882a593Smuzhiyun 58*4882a593Smuzhiyun se_io_cb_t cb; 59*4882a593Smuzhiyun void *cb_context; 60*4882a593Smuzhiyun }; 61*4882a593Smuzhiyun 62*4882a593Smuzhiyun /** 63*4882a593Smuzhiyun * enum nfc_vendor_cmds - supported nfc vendor commands 64*4882a593Smuzhiyun * 65*4882a593Smuzhiyun * @FACTORY_MODE: Allow to set the driver into a mode where no secure element 66*4882a593Smuzhiyun * are activated. It does not consider any NFC_ATTR_VENDOR_DATA. 67*4882a593Smuzhiyun * @HCI_CLEAR_ALL_PIPES: Allow to execute a HCI clear all pipes command. 68*4882a593Smuzhiyun * It does not consider any NFC_ATTR_VENDOR_DATA. 69*4882a593Smuzhiyun * @HCI_DM_PUT_DATA: Allow to configure specific CLF registry as for example 70*4882a593Smuzhiyun * RF trimmings or low level drivers configurations (I2C, SPI, SWP). 71*4882a593Smuzhiyun * @HCI_DM_UPDATE_AID: Allow to configure an AID routing into the CLF routing 72*4882a593Smuzhiyun * table following RF technology, CLF mode or protocol. 73*4882a593Smuzhiyun * @HCI_DM_GET_INFO: Allow to retrieve CLF information. 74*4882a593Smuzhiyun * @HCI_DM_GET_DATA: Allow to retrieve CLF configurable data such as low 75*4882a593Smuzhiyun * level drivers configurations or RF trimmings. 76*4882a593Smuzhiyun * @HCI_DM_DIRECT_LOAD: Allow to load a firmware into the CLF. A complete 77*4882a593Smuzhiyun * packet can be more than 8KB. 78*4882a593Smuzhiyun * @HCI_DM_RESET: Allow to run a CLF reset in order to "commit" CLF 79*4882a593Smuzhiyun * configuration changes without CLF power off. 80*4882a593Smuzhiyun * @HCI_GET_PARAM: Allow to retrieve an HCI CLF parameter (for example the 81*4882a593Smuzhiyun * white list). 82*4882a593Smuzhiyun * @HCI_DM_FIELD_GENERATOR: Allow to generate different kind of RF 83*4882a593Smuzhiyun * technology. When using this command to anti-collision is done. 84*4882a593Smuzhiyun * @LOOPBACK: Allow to echo a command and test the Dh to CLF connectivity. 85*4882a593Smuzhiyun * @HCI_DM_VDC_MEASUREMENT_VALUE: Allow to measure the field applied on the 86*4882a593Smuzhiyun * CLF antenna. A value between 0 and 0x0f is returned. 0 is maximum. 87*4882a593Smuzhiyun * @HCI_DM_FWUPD_START: Allow to put CLF into firmware update mode. It is a 88*4882a593Smuzhiyun * specific CLF command as there is no GPIO for this. 89*4882a593Smuzhiyun * @HCI_DM_FWUPD_END: Allow to complete firmware update. 90*4882a593Smuzhiyun * @HCI_DM_VDC_VALUE_COMPARISON: Allow to compare the field applied on the 91*4882a593Smuzhiyun * CLF antenna to a reference value. 92*4882a593Smuzhiyun * @MANUFACTURER_SPECIFIC: Allow to retrieve manufacturer specific data 93*4882a593Smuzhiyun * received during a NCI_CORE_INIT_CMD. 94*4882a593Smuzhiyun */ 95*4882a593Smuzhiyun enum nfc_vendor_cmds { 96*4882a593Smuzhiyun FACTORY_MODE, 97*4882a593Smuzhiyun HCI_CLEAR_ALL_PIPES, 98*4882a593Smuzhiyun HCI_DM_PUT_DATA, 99*4882a593Smuzhiyun HCI_DM_UPDATE_AID, 100*4882a593Smuzhiyun HCI_DM_GET_INFO, 101*4882a593Smuzhiyun HCI_DM_GET_DATA, 102*4882a593Smuzhiyun HCI_DM_DIRECT_LOAD, 103*4882a593Smuzhiyun HCI_DM_RESET, 104*4882a593Smuzhiyun HCI_GET_PARAM, 105*4882a593Smuzhiyun HCI_DM_FIELD_GENERATOR, 106*4882a593Smuzhiyun LOOPBACK, 107*4882a593Smuzhiyun HCI_DM_FWUPD_START, 108*4882a593Smuzhiyun HCI_DM_FWUPD_END, 109*4882a593Smuzhiyun HCI_DM_VDC_MEASUREMENT_VALUE, 110*4882a593Smuzhiyun HCI_DM_VDC_VALUE_COMPARISON, 111*4882a593Smuzhiyun MANUFACTURER_SPECIFIC, 112*4882a593Smuzhiyun }; 113*4882a593Smuzhiyun 114*4882a593Smuzhiyun struct st_nci_info { 115*4882a593Smuzhiyun struct llt_ndlc *ndlc; 116*4882a593Smuzhiyun unsigned long flags; 117*4882a593Smuzhiyun 118*4882a593Smuzhiyun struct st_nci_se_info se_info; 119*4882a593Smuzhiyun }; 120*4882a593Smuzhiyun 121*4882a593Smuzhiyun void st_nci_remove(struct nci_dev *ndev); 122*4882a593Smuzhiyun int st_nci_probe(struct llt_ndlc *ndlc, int phy_headroom, 123*4882a593Smuzhiyun int phy_tailroom, struct st_nci_se_status *se_status); 124*4882a593Smuzhiyun 125*4882a593Smuzhiyun int st_nci_se_init(struct nci_dev *ndev, struct st_nci_se_status *se_status); 126*4882a593Smuzhiyun void st_nci_se_deinit(struct nci_dev *ndev); 127*4882a593Smuzhiyun 128*4882a593Smuzhiyun int st_nci_discover_se(struct nci_dev *ndev); 129*4882a593Smuzhiyun int st_nci_enable_se(struct nci_dev *ndev, u32 se_idx); 130*4882a593Smuzhiyun int st_nci_disable_se(struct nci_dev *ndev, u32 se_idx); 131*4882a593Smuzhiyun int st_nci_se_io(struct nci_dev *ndev, u32 se_idx, 132*4882a593Smuzhiyun u8 *apdu, size_t apdu_length, 133*4882a593Smuzhiyun se_io_cb_t cb, void *cb_context); 134*4882a593Smuzhiyun int st_nci_hci_load_session(struct nci_dev *ndev); 135*4882a593Smuzhiyun void st_nci_hci_event_received(struct nci_dev *ndev, u8 pipe, 136*4882a593Smuzhiyun u8 event, struct sk_buff *skb); 137*4882a593Smuzhiyun void st_nci_hci_cmd_received(struct nci_dev *ndev, u8 pipe, u8 cmd, 138*4882a593Smuzhiyun struct sk_buff *skb); 139*4882a593Smuzhiyun 140*4882a593Smuzhiyun int st_nci_vendor_cmds_init(struct nci_dev *ndev); 141*4882a593Smuzhiyun 142*4882a593Smuzhiyun #endif /* __LOCAL_ST_NCI_H_ */ 143