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_ops {
  70         int   (*open)(struct nci_dev *ndev);
  71         int   (*close)(struct nci_dev *ndev);
  72         int   (*send)(struct nci_dev *ndev, struct sk_buff *skb);
  73         int   (*setup)(struct nci_dev *ndev);
  74         int   (*fw_download)(struct nci_dev *ndev, const char *firmware_name);
  75         __u32 (*get_rfprotocol)(struct nci_dev *ndev, __u8 rf_protocol);
  76         int   (*discover_se)(struct nci_dev *ndev);
  77         int   (*disable_se)(struct nci_dev *ndev, u32 se_idx);
  78         int   (*enable_se)(struct nci_dev *ndev, u32 se_idx);
  79         int   (*se_io)(struct nci_dev *ndev, u32 se_idx,
  80                                 u8 *apdu, size_t apdu_length,
  81                                 se_io_cb_t cb, void *cb_context);
  82         int   (*hci_load_session)(struct nci_dev *ndev);
  83         void  (*hci_event_received)(struct nci_dev *ndev, u8 pipe, u8 event,
  84                                     struct sk_buff *skb);
  85         void  (*hci_cmd_received)(struct nci_dev *ndev, u8 pipe, u8 cmd,
  86                                   struct sk_buff *skb);
  87 };
  88
  89 #define NCI_MAX_SUPPORTED_RF_INTERFACES         4
  90 #define NCI_MAX_DISCOVERED_TARGETS              10
  91 #define NCI_MAX_NUM_NFCEE   255
  92 #define NCI_MAX_CONN_ID         7
  93
  94 struct nci_conn_info {
  95         struct list_head list;
  96         __u8    id; /* can be an RF Discovery ID or an NFCEE ID */
  97         __u8    conn_id;
  98         __u8    max_pkt_payload_len;
  99
 100         atomic_t credits_cnt;
 101         __u8     initial_num_credits;
 102
 103         data_exchange_cb_t      data_exchange_cb;
 104         void *data_exchange_cb_context;
 105
 106         struct sk_buff *rx_skb;
 107 };
 108
 109 #define NCI_INVALID_CONN_ID 0x80
 110
 111 #define NCI_HCI_ANY_OPEN_PIPE      0x03
 112
 113 /* Gates */
 114 #define NCI_HCI_ADMIN_GATE         0x00
 115 #define NCI_HCI_LINK_MGMT_GATE     0x06
 116
 117 /* Pipes */
 118 #define NCI_HCI_LINK_MGMT_PIPE             0x00
 119 #define NCI_HCI_ADMIN_PIPE                 0x01
 120
 121 /* Generic responses */
 122 #define NCI_HCI_ANY_OK                     0x00
 123 #define NCI_HCI_ANY_E_NOT_CONNECTED        0x01
 124 #define NCI_HCI_ANY_E_CMD_PAR_UNKNOWN      0x02
 125 #define NCI_HCI_ANY_E_NOK                  0x03
 126 #define NCI_HCI_ANY_E_PIPES_FULL           0x04
 127 #define NCI_HCI_ANY_E_REG_PAR_UNKNOWN      0x05
 128 #define NCI_HCI_ANY_E_PIPE_NOT_OPENED      0x06
 129 #define NCI_HCI_ANY_E_CMD_NOT_SUPPORTED    0x07
 130 #define NCI_HCI_ANY_E_INHIBITED            0x08
 131 #define NCI_HCI_ANY_E_TIMEOUT              0x09
 132 #define NCI_HCI_ANY_E_REG_ACCESS_DENIED    0x0a
 133 #define NCI_HCI_ANY_E_PIPE_ACCESS_DENIED   0x0b
 134
 135 #define NCI_HCI_DO_NOT_OPEN_PIPE           0x81
 136 #define NCI_HCI_INVALID_PIPE               0x80
 137 #define NCI_HCI_INVALID_GATE               0xFF
 138 #define NCI_HCI_INVALID_HOST               0x80
 139
 140 #define NCI_HCI_MAX_CUSTOM_GATES   50
 141 #define NCI_HCI_MAX_PIPES          127
 142
 143 struct nci_hci_gate {
 144         u8 gate;
 145         u8 pipe;
 146         u8 dest_host;
 147 } __packed;
 148
 149 struct nci_hci_pipe {
 150         u8 gate;
 151         u8 host;
 152 } __packed;
 153
 154 struct nci_hci_init_data {
 155         u8 gate_count;
 156         struct nci_hci_gate gates[NCI_HCI_MAX_CUSTOM_GATES];
 157         char session_id[9];
 158 };
 159
 160 #define NCI_HCI_MAX_GATES          256
 161
 162 struct nci_hci_dev {
 163         u8 nfcee_id;
 164         struct nci_dev *ndev;
 165         struct nci_conn_info *conn_info;
 166
 167         struct nci_hci_init_data init_data;
 168         struct nci_hci_pipe pipes[NCI_HCI_MAX_PIPES];
 169         u8 gate2pipe[NCI_HCI_MAX_GATES];
 170         int expected_pipes;
 171         int count_pipes;
 172
 173         struct sk_buff_head rx_hcp_frags;
 174         struct work_struct msg_rx_work;
 175         struct sk_buff_head msg_rx_queue;
 176 };
 177
 178 /* NCI Core structures */
 179 struct nci_dev {
 180         struct nfc_dev          *nfc_dev;
 181         struct nci_ops          *ops;
 182         struct nci_hci_dev      *hci_dev;
 183
 184         int                     tx_headroom;
 185         int                     tx_tailroom;
 186
 187         atomic_t                state;
 188         unsigned long           flags;
 189
 190         atomic_t                cmd_cnt;
 191         __u8                    cur_conn_id;
 192
 193         struct list_head        conn_info_list;
 194         struct nci_conn_info    *rf_conn_info;
 195
 196         struct timer_list       cmd_timer;
 197         struct timer_list       data_timer;
 198
 199         struct workqueue_struct *cmd_wq;
 200         struct work_struct      cmd_work;
 201
 202         struct workqueue_struct *rx_wq;
 203         struct work_struct      rx_work;
 204
 205         struct workqueue_struct *tx_wq;
 206         struct work_struct      tx_work;
 207
 208         struct sk_buff_head     cmd_q;
 209         struct sk_buff_head     rx_q;
 210         struct sk_buff_head     tx_q;
 211
 212         struct mutex            req_lock;
 213         struct completion       req_completion;
 214         __u32                   req_status;
 215         __u32                   req_result;
 216
 217         void                    *driver_data;
 218
 219         __u32                   poll_prots;
 220         __u32                   target_active_prot;
 221
 222         struct nfc_target       targets[NCI_MAX_DISCOVERED_TARGETS];
 223         int                     n_targets;
 224
 225         /* received during NCI_OP_CORE_RESET_RSP */
 226         __u8                    nci_ver;
 227
 228         /* received during NCI_OP_CORE_INIT_RSP */
 229         __u32                   nfcc_features;
 230         __u8                    num_supported_rf_interfaces;
 231         __u8                    supported_rf_interfaces
 232                                 [NCI_MAX_SUPPORTED_RF_INTERFACES];
 233         __u8                    max_logical_connections;
 234         __u16                   max_routing_table_size;
 235         __u8                    max_ctrl_pkt_payload_len;
 236         __u16                   max_size_for_large_params;
 237         __u8                    manufact_id;
 238         __u32                   manufact_specific_info;
 239
 240         /* Save RF Discovery ID or NFCEE ID under conn_create */
 241         __u8                    cur_id;
 242
 243         /* stored during nci_data_exchange */
 244         struct sk_buff          *rx_data_reassembly;
 245
 246         /* stored during intf_activated_ntf */
 247         __u8 remote_gb[NFC_MAX_GT_LEN];
 248         __u8 remote_gb_len;
 249 };
 250
 251 /* ----- NCI Devices ----- */
 252 struct nci_dev *nci_allocate_device(struct nci_ops *ops,
 253                                     __u32 supported_protocols,
 254                                     int tx_headroom,
 255                                     int tx_tailroom);
 256 void nci_free_device(struct nci_dev *ndev);
 257 int nci_register_device(struct nci_dev *ndev);
 258 void nci_unregister_device(struct nci_dev *ndev);
 259 int nci_request(struct nci_dev *ndev,
 260                 void (*req)(struct nci_dev *ndev,
 261                             unsigned long opt),
 262                 unsigned long opt, __u32 timeout);
 263 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
 264 int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val);
 265
 266 int nci_nfcee_discover(struct nci_dev *ndev, u8 action);
 267 int nci_nfcee_mode_set(struct nci_dev *ndev, u8 nfcee_id, u8 nfcee_mode);
 268 int nci_core_conn_create(struct nci_dev *ndev, u8 destination_type,
 269                          u8 number_destination_params,
 270                          size_t params_len,
 271                          struct core_conn_create_dest_spec_params *params);
 272 int nci_core_conn_close(struct nci_dev *ndev, u8 conn_id);
 273
 274 struct nci_hci_dev *nci_hci_allocate(struct nci_dev *ndev);
 275 int nci_hci_send_event(struct nci_dev *ndev, u8 gate, u8 event,
 276                        const u8 *param, size_t param_len);
 277 int nci_hci_send_cmd(struct nci_dev *ndev, u8 gate,
 278                      u8 cmd, const u8 *param, size_t param_len,
 279                      struct sk_buff **skb);
 280 int nci_hci_open_pipe(struct nci_dev *ndev, u8 pipe);
 281 int nci_hci_connect_gate(struct nci_dev *ndev, u8 dest_host,
 282                          u8 dest_gate, u8 pipe);
 283 int nci_hci_set_param(struct nci_dev *ndev, u8 gate, u8 idx,
 284                       const u8 *param, size_t param_len);
 285 int nci_hci_get_param(struct nci_dev *ndev, u8 gate, u8 idx,
 286                       struct sk_buff **skb);
 287 int nci_hci_dev_session_init(struct nci_dev *ndev);
 288
 289 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
 290                                             unsigned int len,
 291                                             gfp_t how)
 292 {
 293         struct sk_buff *skb;
 294
 295         skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
 296         if (skb)
 297                 skb_reserve(skb, ndev->tx_headroom);
 298
 299         return skb;
 300 }
 301
 302 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
 303 {
 304         nfc_set_parent_dev(ndev->nfc_dev, dev);
 305 }
 306
 307 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
 308 {
 309         ndev->driver_data = data;
 310 }
 311
 312 static inline void *nci_get_drvdata(struct nci_dev *ndev)
 313 {
 314         return ndev->driver_data;
 315 }
 316
 317 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
 318 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
 319 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
 320 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
 321 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
 322 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
 323                                 __u8 conn_id, int err);
 324 void nci_hci_data_received_cb(void *context, struct sk_buff *skb, int err);
 325
 326 void nci_clear_target_list(struct nci_dev *ndev);
 327
 328 /* ----- NCI requests ----- */
 329 #define NCI_REQ_DONE            0
 330 #define NCI_REQ_PEND            1
 331 #define NCI_REQ_CANCELED        2
 332
 333 void nci_req_complete(struct nci_dev *ndev, int result);
 334 struct nci_conn_info *nci_get_conn_info_by_conn_id(struct nci_dev *ndev,
 335                                                    int conn_id);
 336
 337 /* ----- NCI status code ----- */
 338 int nci_to_errno(__u8 code);
 339
 340 /* ----- NCI over SPI acknowledge modes ----- */
 341 #define NCI_SPI_CRC_DISABLED    0x00
 342 #define NCI_SPI_CRC_ENABLED     0x01
 343
 344 /* ----- NCI SPI structures ----- */
 345 struct nci_spi {
 346         struct nci_dev          *ndev;
 347         struct spi_device       *spi;
 348
 349         unsigned int            xfer_udelay;    /* microseconds delay between
 350                                                   transactions */
 351         u8                      acknowledge_mode;
 352
 353         struct completion       req_completion;
 354         u8                      req_result;
 355 };
 356
 357 /* ----- NCI SPI ----- */
 358 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
 359                                      u8 acknowledge_mode, unsigned int delay,
 360                                      struct nci_dev *ndev);
 361 int nci_spi_send(struct nci_spi *nspi,
 362                  struct completion *write_handshake_completion,
 363                  struct sk_buff *skb);
 364 struct sk_buff *nci_spi_read(struct nci_spi *nspi);
 365
 366 #endif /* __NCI_CORE_H */