1 /* 2 * The NFC Controller Interface is the communication protocol between an 3 * NFC Controller (NFCC) and a Device Host (DH). 4 * 5 * Copyright (C) 2011 Texas Instruments, Inc. 6 * Copyright (C) 2013 Intel Corporation. All rights reserved. 7 * 8 * Written by Ilan Elias <ilane@ti.com> 9 * 10 * Acknowledgements: 11 * This file is based on hci_core.h, which was written 12 * by Maxim Krasnyansky. 13 * 14 * This program is free software; you can redistribute it and/or modify 15 * it under the terms of the GNU General Public License version 2 16 * as published by the Free Software Foundation 17 * 18 * This program is distributed in the hope that it will be useful, 19 * but WITHOUT ANY WARRANTY; without even the implied warranty of 20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 21 * GNU General Public License for more details. 22 * 23 * You should have received a copy of the GNU General Public License 24 * along with this program; if not, see <http://www.gnu.org/licenses/>. 25 * 26 */ 27 28 #ifndef __NCI_CORE_H 29 #define __NCI_CORE_H 30 31 #include <linux/interrupt.h> 32 #include <linux/skbuff.h> 33 34 #include <net/nfc/nfc.h> 35 #include <net/nfc/nci.h> 36 37 /* NCI device flags */ 38 enum nci_flag { 39 NCI_INIT, 40 NCI_UP, 41 NCI_DATA_EXCHANGE, 42 NCI_DATA_EXCHANGE_TO, 43 }; 44 45 /* NCI device states */ 46 enum nci_state { 47 NCI_IDLE, 48 NCI_DISCOVERY, 49 NCI_W4_ALL_DISCOVERIES, 50 NCI_W4_HOST_SELECT, 51 NCI_POLL_ACTIVE, 52 }; 53 54 /* NCI timeouts */ 55 #define NCI_RESET_TIMEOUT 5000 56 #define NCI_INIT_TIMEOUT 5000 57 #define NCI_SET_CONFIG_TIMEOUT 5000 58 #define NCI_RF_DISC_TIMEOUT 5000 59 #define NCI_RF_DISC_SELECT_TIMEOUT 5000 60 #define NCI_RF_DEACTIVATE_TIMEOUT 30000 61 #define NCI_CMD_TIMEOUT 5000 62 #define NCI_DATA_TIMEOUT 700 63 64 struct nci_dev; 65 66 struct nci_ops { 67 int (*open)(struct nci_dev *ndev); 68 int (*close)(struct nci_dev *ndev); 69 int (*send)(struct nci_dev *ndev, struct sk_buff *skb); 70 int (*setup)(struct nci_dev *ndev); 71 __u32 (*get_rfprotocol)(struct nci_dev *ndev, __u8 rf_protocol); 72 }; 73 74 #define NCI_MAX_SUPPORTED_RF_INTERFACES 4 75 #define NCI_MAX_DISCOVERED_TARGETS 10 76 77 /* NCI Core structures */ 78 struct nci_dev { 79 struct nfc_dev *nfc_dev; 80 struct nci_ops *ops; 81 82 int tx_headroom; 83 int tx_tailroom; 84 85 atomic_t state; 86 unsigned long flags; 87 88 atomic_t cmd_cnt; 89 atomic_t credits_cnt; 90 91 struct timer_list cmd_timer; 92 struct timer_list data_timer; 93 94 struct workqueue_struct *cmd_wq; 95 struct work_struct cmd_work; 96 97 struct workqueue_struct *rx_wq; 98 struct work_struct rx_work; 99 100 struct workqueue_struct *tx_wq; 101 struct work_struct tx_work; 102 103 struct sk_buff_head cmd_q; 104 struct sk_buff_head rx_q; 105 struct sk_buff_head tx_q; 106 107 struct mutex req_lock; 108 struct completion req_completion; 109 __u32 req_status; 110 __u32 req_result; 111 112 void *driver_data; 113 114 __u32 poll_prots; 115 __u32 target_active_prot; 116 117 struct nfc_target targets[NCI_MAX_DISCOVERED_TARGETS]; 118 int n_targets; 119 120 /* received during NCI_OP_CORE_RESET_RSP */ 121 __u8 nci_ver; 122 123 /* received during NCI_OP_CORE_INIT_RSP */ 124 __u32 nfcc_features; 125 __u8 num_supported_rf_interfaces; 126 __u8 supported_rf_interfaces 127 [NCI_MAX_SUPPORTED_RF_INTERFACES]; 128 __u8 max_logical_connections; 129 __u16 max_routing_table_size; 130 __u8 max_ctrl_pkt_payload_len; 131 __u16 max_size_for_large_params; 132 __u8 manufact_id; 133 __u32 manufact_specific_info; 134 135 /* received during NCI_OP_RF_INTF_ACTIVATED_NTF */ 136 __u8 max_data_pkt_payload_size; 137 __u8 initial_num_credits; 138 139 /* stored during nci_data_exchange */ 140 data_exchange_cb_t data_exchange_cb; 141 void *data_exchange_cb_context; 142 struct sk_buff *rx_data_reassembly; 143 144 /* stored during intf_activated_ntf */ 145 __u8 remote_gb[NFC_MAX_GT_LEN]; 146 __u8 remote_gb_len; 147 }; 148 149 /* ----- NCI Devices ----- */ 150 struct nci_dev *nci_allocate_device(struct nci_ops *ops, 151 __u32 supported_protocols, 152 int tx_headroom, 153 int tx_tailroom); 154 void nci_free_device(struct nci_dev *ndev); 155 int nci_register_device(struct nci_dev *ndev); 156 void nci_unregister_device(struct nci_dev *ndev); 157 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb); 158 int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val); 159 160 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev, 161 unsigned int len, 162 gfp_t how) 163 { 164 struct sk_buff *skb; 165 166 skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how); 167 if (skb) 168 skb_reserve(skb, ndev->tx_headroom); 169 170 return skb; 171 } 172 173 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev) 174 { 175 nfc_set_parent_dev(ndev->nfc_dev, dev); 176 } 177 178 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data) 179 { 180 ndev->driver_data = data; 181 } 182 183 static inline void *nci_get_drvdata(struct nci_dev *ndev) 184 { 185 return ndev->driver_data; 186 } 187 188 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb); 189 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb); 190 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb); 191 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload); 192 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb); 193 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb, 194 int err); 195 void nci_clear_target_list(struct nci_dev *ndev); 196 197 /* ----- NCI requests ----- */ 198 #define NCI_REQ_DONE 0 199 #define NCI_REQ_PEND 1 200 #define NCI_REQ_CANCELED 2 201 202 void nci_req_complete(struct nci_dev *ndev, int result); 203 204 /* ----- NCI status code ----- */ 205 int nci_to_errno(__u8 code); 206 207 /* ----- NCI over SPI acknowledge modes ----- */ 208 #define NCI_SPI_CRC_DISABLED 0x00 209 #define NCI_SPI_CRC_ENABLED 0x01 210 211 /* ----- NCI SPI structures ----- */ 212 struct nci_spi { 213 struct nci_dev *ndev; 214 struct spi_device *spi; 215 216 unsigned int xfer_udelay; /* microseconds delay between 217 transactions */ 218 u8 acknowledge_mode; 219 220 struct completion req_completion; 221 u8 req_result; 222 }; 223 224 /* ----- NCI SPI ----- */ 225 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi, 226 u8 acknowledge_mode, unsigned int delay, 227 struct nci_dev *ndev); 228 int nci_spi_send(struct nci_spi *nspi, 229 struct completion *write_handshake_completion, 230 struct sk_buff *skb); 231 struct sk_buff *nci_spi_read(struct nci_spi *nspi); 232 233 #endif /* __NCI_CORE_H */ 234