include/net/nfc/nci_core.h

   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  *  Copyright (C) 2014 Marvell International Ltd.
   8  *
   9  *  Written by Ilan Elias <ilane@ti.com>
  10  *
  11  *  Acknowledgements:
  12  *  This file is based on hci_core.h, which was written
  13  *  by Maxim Krasnyansky.
  14  *
  15  *  This program is free software; you can redistribute it and/or modify
  16  *  it under the terms of the GNU General Public License version 2
  17  *  as published by the Free Software Foundation
  18  *
  19  *  This program is distributed in the hope that it will be useful,
  20  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  *  GNU General Public License for more details.
  23  *
  24  *  You should have received a copy of the GNU General Public License
  25  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
  26  *
  27  */
  28
  29 #ifndef __NCI_CORE_H
  30 #define __NCI_CORE_H
  31
  32 #include <linux/interrupt.h>
  33 #include <linux/skbuff.h>
  34
  35 #include <net/nfc/nfc.h>
  36 #include <net/nfc/nci.h>
  37
  38 /* NCI device flags */
  39 enum nci_flag {
  40         NCI_INIT,
  41         NCI_UP,
  42         NCI_DATA_EXCHANGE,
  43         NCI_DATA_EXCHANGE_TO,
  44 };
  45
  46 /* NCI device states */
  47 enum nci_state {
  48         NCI_IDLE,
  49         NCI_DISCOVERY,
  50         NCI_W4_ALL_DISCOVERIES,
  51         NCI_W4_HOST_SELECT,
  52         NCI_POLL_ACTIVE,
  53         NCI_LISTEN_ACTIVE,
  54         NCI_LISTEN_SLEEP,
  55 };
  56
  57 /* NCI timeouts */
  58 #define NCI_RESET_TIMEOUT                       5000
  59 #define NCI_INIT_TIMEOUT                        5000
  60 #define NCI_SET_CONFIG_TIMEOUT                  5000
  61 #define NCI_RF_DISC_TIMEOUT                     5000
  62 #define NCI_RF_DISC_SELECT_TIMEOUT              5000
  63 #define NCI_RF_DEACTIVATE_TIMEOUT               30000
  64 #define NCI_CMD_TIMEOUT                         5000
  65 #define NCI_DATA_TIMEOUT                        700
  66
  67 struct nci_dev;
  68
  69 struct nci_prop_ops {
  70         __u16 opcode;
  71         int (*rsp)(struct nci_dev *dev, struct sk_buff *skb);
  72         int (*ntf)(struct nci_dev *dev, struct sk_buff *skb);
  73 };
  74
  75 struct nci_ops {
  76         int   (*init)(struct nci_dev *ndev);
  77         int   (*open)(struct nci_dev *ndev);
  78         int   (*close)(struct nci_dev *ndev);
  79         int   (*send)(struct nci_dev *ndev, struct sk_buff *skb);
  80         int   (*setup)(struct nci_dev *ndev);
  81         int   (*fw_download)(struct nci_dev *ndev, const char *firmware_name);
  82         __u32 (*get_rfprotocol)(struct nci_dev *ndev, __u8 rf_protocol);
  83         int   (*discover_se)(struct nci_dev *ndev);
  84         int   (*disable_se)(struct nci_dev *ndev, u32 se_idx);
  85         int   (*enable_se)(struct nci_dev *ndev, u32 se_idx);
  86         int   (*se_io)(struct nci_dev *ndev, u32 se_idx,
  87                                 u8 *apdu, size_t apdu_length,
  88                                 se_io_cb_t cb, void *cb_context);
  89         int   (*hci_load_session)(struct nci_dev *ndev);
  90         void  (*hci_event_received)(struct nci_dev *ndev, u8 pipe, u8 event,
  91                                     struct sk_buff *skb);
  92         void  (*hci_cmd_received)(struct nci_dev *ndev, u8 pipe, u8 cmd,
  93                                   struct sk_buff *skb);
  94
  95         struct nci_prop_ops *prop_ops;
  96         size_t n_prop_ops;
  97 };
  98
  99 #define NCI_MAX_SUPPORTED_RF_INTERFACES         4
 100 #define NCI_MAX_DISCOVERED_TARGETS              10
 101 #define NCI_MAX_NUM_NFCEE   255
 102 #define NCI_MAX_CONN_ID         7
 103 #define NCI_MAX_PROPRIETARY_CMD 64
 104
 105 struct nci_conn_info {
 106         struct list_head list;
 107         __u8    id; /* can be an RF Discovery ID or an NFCEE ID */
 108         __u8    conn_id;
 109         __u8    max_pkt_payload_len;
 110
 111         atomic_t credits_cnt;
 112         __u8     initial_num_credits;
 113
 114         data_exchange_cb_t      data_exchange_cb;
 115         void *data_exchange_cb_context;
 116
 117         struct sk_buff *rx_skb;
 118 };
 119
 120 #define NCI_INVALID_CONN_ID 0x80
 121
 122 #define NCI_HCI_ANY_OPEN_PIPE      0x03
 123
 124 /* Gates */
 125 #define NCI_HCI_ADMIN_GATE         0x00
 126 #define NCI_HCI_LINK_MGMT_GATE     0x06
 127
 128 /* Pipes */
 129 #define NCI_HCI_LINK_MGMT_PIPE             0x00
 130 #define NCI_HCI_ADMIN_PIPE                 0x01
 131
 132 /* Generic responses */
 133 #define NCI_HCI_ANY_OK                     0x00
 134 #define NCI_HCI_ANY_E_NOT_CONNECTED        0x01
 135 #define NCI_HCI_ANY_E_CMD_PAR_UNKNOWN      0x02
 136 #define NCI_HCI_ANY_E_NOK                  0x03
 137 #define NCI_HCI_ANY_E_PIPES_FULL           0x04
 138 #define NCI_HCI_ANY_E_REG_PAR_UNKNOWN      0x05
 139 #define NCI_HCI_ANY_E_PIPE_NOT_OPENED      0x06
 140 #define NCI_HCI_ANY_E_CMD_NOT_SUPPORTED    0x07
 141 #define NCI_HCI_ANY_E_INHIBITED            0x08
 142 #define NCI_HCI_ANY_E_TIMEOUT              0x09
 143 #define NCI_HCI_ANY_E_REG_ACCESS_DENIED    0x0a
 144 #define NCI_HCI_ANY_E_PIPE_ACCESS_DENIED   0x0b
 145
 146 #define NCI_HCI_DO_NOT_OPEN_PIPE           0x81
 147 #define NCI_HCI_INVALID_PIPE               0x80
 148 #define NCI_HCI_INVALID_GATE               0xFF
 149 #define NCI_HCI_INVALID_HOST               0x80
 150
 151 #define NCI_HCI_MAX_CUSTOM_GATES   50
 152 /*
 153  * According to specification 102 622 chapter 4.4 Pipes,
 154  * the pipe identifier is 7 bits long.
 155  */
 156 #define NCI_HCI_MAX_PIPES          127
 157
 158 struct nci_hci_gate {
 159         u8 gate;
 160         u8 pipe;
 161         u8 dest_host;
 162 } __packed;
 163
 164 struct nci_hci_pipe {
 165         u8 gate;
 166         u8 host;
 167 } __packed;
 168
 169 struct nci_hci_init_data {
 170         u8 gate_count;
 171         struct nci_hci_gate gates[NCI_HCI_MAX_CUSTOM_GATES];
 172         char session_id[9];
 173 };
 174
 175 #define NCI_HCI_MAX_GATES          256
 176
 177 struct nci_hci_dev {
 178         u8 nfcee_id;
 179         struct nci_dev *ndev;
 180         struct nci_conn_info *conn_info;
 181
 182         struct nci_hci_init_data init_data;
 183         struct nci_hci_pipe pipes[NCI_HCI_MAX_PIPES];
 184         u8 gate2pipe[NCI_HCI_MAX_GATES];
 185         int expected_pipes;
 186         int count_pipes;
 187
 188         struct sk_buff_head rx_hcp_frags;
 189         struct work_struct msg_rx_work;
 190         struct sk_buff_head msg_rx_queue;
 191 };
 192
 193 /* NCI Core structures */
 194 struct nci_dev {
 195         struct nfc_dev          *nfc_dev;
 196         struct nci_ops          *ops;
 197         struct nci_hci_dev      *hci_dev;
 198
 199         int                     tx_headroom;
 200         int                     tx_tailroom;
 201
 202         atomic_t                state;
 203         unsigned long           flags;
 204
 205         atomic_t                cmd_cnt;
 206         __u8                    cur_conn_id;
 207
 208         struct list_head        conn_info_list;
 209         struct nci_conn_info    *rf_conn_info;
 210
 211         struct timer_list       cmd_timer;
 212         struct timer_list       data_timer;
 213
 214         struct workqueue_struct *cmd_wq;
 215         struct work_struct      cmd_work;
 216
 217         struct workqueue_struct *rx_wq;
 218         struct work_struct      rx_work;
 219
 220         struct workqueue_struct *tx_wq;
 221         struct work_struct      tx_work;
 222
 223         struct sk_buff_head     cmd_q;
 224         struct sk_buff_head     rx_q;
 225         struct sk_buff_head     tx_q;
 226
 227         struct mutex            req_lock;
 228         struct completion       req_completion;
 229         __u32                   req_status;
 230         __u32                   req_result;
 231
 232         void                    *driver_data;
 233
 234         __u32                   poll_prots;
 235         __u32                   target_active_prot;
 236
 237         struct nfc_target       targets[NCI_MAX_DISCOVERED_TARGETS];
 238         int                     n_targets;
 239
 240         /* received during NCI_OP_CORE_RESET_RSP */
 241         __u8                    nci_ver;
 242
 243         /* received during NCI_OP_CORE_INIT_RSP */
 244         __u32                   nfcc_features;
 245         __u8                    num_supported_rf_interfaces;
 246         __u8                    supported_rf_interfaces
 247                                 [NCI_MAX_SUPPORTED_RF_INTERFACES];
 248         __u8                    max_logical_connections;
 249         __u16                   max_routing_table_size;
 250         __u8                    max_ctrl_pkt_payload_len;
 251         __u16                   max_size_for_large_params;
 252         __u8                    manufact_id;
 253         __u32                   manufact_specific_info;
 254
 255         /* Save RF Discovery ID or NFCEE ID under conn_create */
 256         __u8                    cur_id;
 257
 258         /* stored during nci_data_exchange */
 259         struct sk_buff          *rx_data_reassembly;
 260
 261         /* stored during intf_activated_ntf */
 262         __u8 remote_gb[NFC_MAX_GT_LEN];
 263         __u8 remote_gb_len;
 264 };
 265
 266 /* ----- NCI Devices ----- */
 267 struct nci_dev *nci_allocate_device(struct nci_ops *ops,
 268                                     __u32 supported_protocols,
 269                                     int tx_headroom,
 270                                     int tx_tailroom);
 271 void nci_free_device(struct nci_dev *ndev);
 272 int nci_register_device(struct nci_dev *ndev);
 273 void nci_unregister_device(struct nci_dev *ndev);
 274 int nci_request(struct nci_dev *ndev,
 275                 void (*req)(struct nci_dev *ndev,
 276                             unsigned long opt),
 277                 unsigned long opt, __u32 timeout);
 278 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
 279 int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val);
 280
 281 int nci_nfcee_discover(struct nci_dev *ndev, u8 action);
 282 int nci_nfcee_mode_set(struct nci_dev *ndev, u8 nfcee_id, u8 nfcee_mode);
 283 int nci_core_conn_create(struct nci_dev *ndev, u8 destination_type,
 284                          u8 number_destination_params,
 285                          size_t params_len,
 286                          struct core_conn_create_dest_spec_params *params);
 287 int nci_core_conn_close(struct nci_dev *ndev, u8 conn_id);
 288
 289 struct nci_hci_dev *nci_hci_allocate(struct nci_dev *ndev);
 290 int nci_hci_send_event(struct nci_dev *ndev, u8 gate, u8 event,
 291                        const u8 *param, size_t param_len);
 292 int nci_hci_send_cmd(struct nci_dev *ndev, u8 gate,
 293                      u8 cmd, const u8 *param, size_t param_len,
 294                      struct sk_buff **skb);
 295 int nci_hci_open_pipe(struct nci_dev *ndev, u8 pipe);
 296 int nci_hci_connect_gate(struct nci_dev *ndev, u8 dest_host,
 297                          u8 dest_gate, u8 pipe);
 298 int nci_hci_set_param(struct nci_dev *ndev, u8 gate, u8 idx,
 299                       const u8 *param, size_t param_len);
 300 int nci_hci_get_param(struct nci_dev *ndev, u8 gate, u8 idx,
 301                       struct sk_buff **skb);
 302 int nci_hci_dev_session_init(struct nci_dev *ndev);
 303
 304 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
 305                                             unsigned int len,
 306                                             gfp_t how)
 307 {
 308         struct sk_buff *skb;
 309
 310         skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
 311         if (skb)
 312                 skb_reserve(skb, ndev->tx_headroom);
 313
 314         return skb;
 315 }
 316
 317 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
 318 {
 319         nfc_set_parent_dev(ndev->nfc_dev, dev);
 320 }
 321
 322 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
 323 {
 324         ndev->driver_data = data;
 325 }
 326
 327 static inline void *nci_get_drvdata(struct nci_dev *ndev)
 328 {
 329         return ndev->driver_data;
 330 }
 331
 332 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
 333 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
 334 int nci_prop_rsp_packet(struct nci_dev *ndev, __u16 opcode,
 335                         struct sk_buff *skb);
 336 int nci_prop_ntf_packet(struct nci_dev *ndev, __u16 opcode,
 337                         struct sk_buff *skb);
 338 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
 339 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
 340 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
 341 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
 342                                 __u8 conn_id, int err);
 343 void nci_hci_data_received_cb(void *context, struct sk_buff *skb, int err);
 344
 345 void nci_clear_target_list(struct nci_dev *ndev);
 346
 347 /* ----- NCI requests ----- */
 348 #define NCI_REQ_DONE            0
 349 #define NCI_REQ_PEND            1
 350 #define NCI_REQ_CANCELED        2
 351
 352 void nci_req_complete(struct nci_dev *ndev, int result);
 353 struct nci_conn_info *nci_get_conn_info_by_conn_id(struct nci_dev *ndev,
 354                                                    int conn_id);
 355
 356 /* ----- NCI status code ----- */
 357 int nci_to_errno(__u8 code);
 358
 359 /* ----- NCI over SPI acknowledge modes ----- */
 360 #define NCI_SPI_CRC_DISABLED    0x00
 361 #define NCI_SPI_CRC_ENABLED     0x01
 362
 363 /* ----- NCI SPI structures ----- */
 364 struct nci_spi {
 365         struct nci_dev          *ndev;
 366         struct spi_device       *spi;
 367
 368         unsigned int            xfer_udelay;    /* microseconds delay between
 369                                                   transactions */
 370         u8                      acknowledge_mode;
 371
 372         struct completion       req_completion;
 373         u8                      req_result;
 374 };
 375
 376 /* ----- NCI SPI ----- */
 377 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
 378                                      u8 acknowledge_mode, unsigned int delay,
 379                                      struct nci_dev *ndev);
 380 int nci_spi_send(struct nci_spi *nspi,
 381                  struct completion *write_handshake_completion,
 382                  struct sk_buff *skb);
 383 struct sk_buff *nci_spi_read(struct nci_spi *nspi);
 384
 385 #endif /* __NCI_CORE_H */