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 /*
 142  * According to specification 102 622 chapter 4.4 Pipes,
 143  * the pipe identifier is 7 bits long.
 144  */
 145 #define NCI_HCI_MAX_PIPES          127
 146
 147 struct nci_hci_gate {
 148         u8 gate;
 149         u8 pipe;
 150         u8 dest_host;
 151 } __packed;
 152
 153 struct nci_hci_pipe {
 154         u8 gate;
 155         u8 host;
 156 } __packed;
 157
 158 struct nci_hci_init_data {
 159         u8 gate_count;
 160         struct nci_hci_gate gates[NCI_HCI_MAX_CUSTOM_GATES];
 161         char session_id[9];
 162 };
 163
 164 #define NCI_HCI_MAX_GATES          256
 165
 166 struct nci_hci_dev {
 167         u8 nfcee_id;
 168         struct nci_dev *ndev;
 169         struct nci_conn_info *conn_info;
 170
 171         struct nci_hci_init_data init_data;
 172         struct nci_hci_pipe pipes[NCI_HCI_MAX_PIPES];
 173         u8 gate2pipe[NCI_HCI_MAX_GATES];
 174         int expected_pipes;
 175         int count_pipes;
 176
 177         struct sk_buff_head rx_hcp_frags;
 178         struct work_struct msg_rx_work;
 179         struct sk_buff_head msg_rx_queue;
 180 };
 181
 182 /* NCI Core structures */
 183 struct nci_dev {
 184         struct nfc_dev          *nfc_dev;
 185         struct nci_ops          *ops;
 186         struct nci_hci_dev      *hci_dev;
 187
 188         int                     tx_headroom;
 189         int                     tx_tailroom;
 190
 191         atomic_t                state;
 192         unsigned long           flags;
 193
 194         atomic_t                cmd_cnt;
 195         __u8                    cur_conn_id;
 196
 197         struct list_head        conn_info_list;
 198         struct nci_conn_info    *rf_conn_info;
 199
 200         struct timer_list       cmd_timer;
 201         struct timer_list       data_timer;
 202
 203         struct workqueue_struct *cmd_wq;
 204         struct work_struct      cmd_work;
 205
 206         struct workqueue_struct *rx_wq;
 207         struct work_struct      rx_work;
 208
 209         struct workqueue_struct *tx_wq;
 210         struct work_struct      tx_work;
 211
 212         struct sk_buff_head     cmd_q;
 213         struct sk_buff_head     rx_q;
 214         struct sk_buff_head     tx_q;
 215
 216         struct mutex            req_lock;
 217         struct completion       req_completion;
 218         __u32                   req_status;
 219         __u32                   req_result;
 220
 221         void                    *driver_data;
 222
 223         __u32                   poll_prots;
 224         __u32                   target_active_prot;
 225
 226         struct nfc_target       targets[NCI_MAX_DISCOVERED_TARGETS];
 227         int                     n_targets;
 228
 229         /* received during NCI_OP_CORE_RESET_RSP */
 230         __u8                    nci_ver;
 231
 232         /* received during NCI_OP_CORE_INIT_RSP */
 233         __u32                   nfcc_features;
 234         __u8                    num_supported_rf_interfaces;
 235         __u8                    supported_rf_interfaces
 236                                 [NCI_MAX_SUPPORTED_RF_INTERFACES];
 237         __u8                    max_logical_connections;
 238         __u16                   max_routing_table_size;
 239         __u8                    max_ctrl_pkt_payload_len;
 240         __u16                   max_size_for_large_params;
 241         __u8                    manufact_id;
 242         __u32                   manufact_specific_info;
 243
 244         /* Save RF Discovery ID or NFCEE ID under conn_create */
 245         __u8                    cur_id;
 246
 247         /* stored during nci_data_exchange */
 248         struct sk_buff          *rx_data_reassembly;
 249
 250         /* stored during intf_activated_ntf */
 251         __u8 remote_gb[NFC_MAX_GT_LEN];
 252         __u8 remote_gb_len;
 253 };
 254
 255 /* ----- NCI Devices ----- */
 256 struct nci_dev *nci_allocate_device(struct nci_ops *ops,
 257                                     __u32 supported_protocols,
 258                                     int tx_headroom,
 259                                     int tx_tailroom);
 260 void nci_free_device(struct nci_dev *ndev);
 261 int nci_register_device(struct nci_dev *ndev);
 262 void nci_unregister_device(struct nci_dev *ndev);
 263 int nci_request(struct nci_dev *ndev,
 264                 void (*req)(struct nci_dev *ndev,
 265                             unsigned long opt),
 266                 unsigned long opt, __u32 timeout);
 267 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
 268 int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val);
 269
 270 int nci_nfcee_discover(struct nci_dev *ndev, u8 action);
 271 int nci_nfcee_mode_set(struct nci_dev *ndev, u8 nfcee_id, u8 nfcee_mode);
 272 int nci_core_conn_create(struct nci_dev *ndev, u8 destination_type,
 273                          u8 number_destination_params,
 274                          size_t params_len,
 275                          struct core_conn_create_dest_spec_params *params);
 276 int nci_core_conn_close(struct nci_dev *ndev, u8 conn_id);
 277
 278 struct nci_hci_dev *nci_hci_allocate(struct nci_dev *ndev);
 279 int nci_hci_send_event(struct nci_dev *ndev, u8 gate, u8 event,
 280                        const u8 *param, size_t param_len);
 281 int nci_hci_send_cmd(struct nci_dev *ndev, u8 gate,
 282                      u8 cmd, const u8 *param, size_t param_len,
 283                      struct sk_buff **skb);
 284 int nci_hci_open_pipe(struct nci_dev *ndev, u8 pipe);
 285 int nci_hci_connect_gate(struct nci_dev *ndev, u8 dest_host,
 286                          u8 dest_gate, u8 pipe);
 287 int nci_hci_set_param(struct nci_dev *ndev, u8 gate, u8 idx,
 288                       const u8 *param, size_t param_len);
 289 int nci_hci_get_param(struct nci_dev *ndev, u8 gate, u8 idx,
 290                       struct sk_buff **skb);
 291 int nci_hci_dev_session_init(struct nci_dev *ndev);
 292
 293 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
 294                                             unsigned int len,
 295                                             gfp_t how)
 296 {
 297         struct sk_buff *skb;
 298
 299         skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
 300         if (skb)
 301                 skb_reserve(skb, ndev->tx_headroom);
 302
 303         return skb;
 304 }
 305
 306 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
 307 {
 308         nfc_set_parent_dev(ndev->nfc_dev, dev);
 309 }
 310
 311 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
 312 {
 313         ndev->driver_data = data;
 314 }
 315
 316 static inline void *nci_get_drvdata(struct nci_dev *ndev)
 317 {
 318         return ndev->driver_data;
 319 }
 320
 321 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
 322 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
 323 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
 324 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
 325 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
 326 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
 327                                 __u8 conn_id, int err);
 328 void nci_hci_data_received_cb(void *context, struct sk_buff *skb, int err);
 329
 330 void nci_clear_target_list(struct nci_dev *ndev);
 331
 332 /* ----- NCI requests ----- */
 333 #define NCI_REQ_DONE            0
 334 #define NCI_REQ_PEND            1
 335 #define NCI_REQ_CANCELED        2
 336
 337 void nci_req_complete(struct nci_dev *ndev, int result);
 338 struct nci_conn_info *nci_get_conn_info_by_conn_id(struct nci_dev *ndev,
 339                                                    int conn_id);
 340
 341 /* ----- NCI status code ----- */
 342 int nci_to_errno(__u8 code);
 343
 344 /* ----- NCI over SPI acknowledge modes ----- */
 345 #define NCI_SPI_CRC_DISABLED    0x00
 346 #define NCI_SPI_CRC_ENABLED     0x01
 347
 348 /* ----- NCI SPI structures ----- */
 349 struct nci_spi {
 350         struct nci_dev          *ndev;
 351         struct spi_device       *spi;
 352
 353         unsigned int            xfer_udelay;    /* microseconds delay between
 354                                                   transactions */
 355         u8                      acknowledge_mode;
 356
 357         struct completion       req_completion;
 358         u8                      req_result;
 359 };
 360
 361 /* ----- NCI SPI ----- */
 362 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
 363                                      u8 acknowledge_mode, unsigned int delay,
 364                                      struct nci_dev *ndev);
 365 int nci_spi_send(struct nci_spi *nspi,
 366                  struct completion *write_handshake_completion,
 367                  struct sk_buff *skb);
 368 struct sk_buff *nci_spi_read(struct nci_spi *nspi);
 369
 370 #endif /* __NCI_CORE_H */