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 #include <linux/tty.h>
  35
  36 #include <net/nfc/nfc.h>
  37 #include <net/nfc/nci.h>
  38
  39 /* NCI device flags */
  40 enum nci_flag {
  41         NCI_INIT,
  42         NCI_UP,
  43         NCI_DATA_EXCHANGE,
  44         NCI_DATA_EXCHANGE_TO,
  45 };
  46
  47 /* NCI device states */
  48 enum nci_state {
  49         NCI_IDLE,
  50         NCI_DISCOVERY,
  51         NCI_W4_ALL_DISCOVERIES,
  52         NCI_W4_HOST_SELECT,
  53         NCI_POLL_ACTIVE,
  54         NCI_LISTEN_ACTIVE,
  55         NCI_LISTEN_SLEEP,
  56 };
  57
  58 /* NCI timeouts */
  59 #define NCI_RESET_TIMEOUT                       5000
  60 #define NCI_INIT_TIMEOUT                        5000
  61 #define NCI_SET_CONFIG_TIMEOUT                  5000
  62 #define NCI_RF_DISC_TIMEOUT                     5000
  63 #define NCI_RF_DISC_SELECT_TIMEOUT              5000
  64 #define NCI_RF_DEACTIVATE_TIMEOUT               30000
  65 #define NCI_CMD_TIMEOUT                         5000
  66 #define NCI_DATA_TIMEOUT                        700
  67
  68 struct nci_dev;
  69
  70 struct nci_prop_ops {
  71         __u16 opcode;
  72         int (*rsp)(struct nci_dev *dev, struct sk_buff *skb);
  73         int (*ntf)(struct nci_dev *dev, struct sk_buff *skb);
  74 };
  75
  76 struct nci_ops {
  77         int   (*init)(struct nci_dev *ndev);
  78         int   (*open)(struct nci_dev *ndev);
  79         int   (*close)(struct nci_dev *ndev);
  80         int   (*send)(struct nci_dev *ndev, struct sk_buff *skb);
  81         int   (*setup)(struct nci_dev *ndev);
  82         int   (*fw_download)(struct nci_dev *ndev, const char *firmware_name);
  83         __u32 (*get_rfprotocol)(struct nci_dev *ndev, __u8 rf_protocol);
  84         int   (*discover_se)(struct nci_dev *ndev);
  85         int   (*disable_se)(struct nci_dev *ndev, u32 se_idx);
  86         int   (*enable_se)(struct nci_dev *ndev, u32 se_idx);
  87         int   (*se_io)(struct nci_dev *ndev, u32 se_idx,
  88                                 u8 *apdu, size_t apdu_length,
  89                                 se_io_cb_t cb, void *cb_context);
  90         int   (*hci_load_session)(struct nci_dev *ndev);
  91         void  (*hci_event_received)(struct nci_dev *ndev, u8 pipe, u8 event,
  92                                     struct sk_buff *skb);
  93         void  (*hci_cmd_received)(struct nci_dev *ndev, u8 pipe, u8 cmd,
  94                                   struct sk_buff *skb);
  95
  96         struct nci_prop_ops *prop_ops;
  97         size_t n_prop_ops;
  98 };
  99
 100 #define NCI_MAX_SUPPORTED_RF_INTERFACES         4
 101 #define NCI_MAX_DISCOVERED_TARGETS              10
 102 #define NCI_MAX_NUM_NFCEE   255
 103 #define NCI_MAX_CONN_ID         7
 104 #define NCI_MAX_PROPRIETARY_CMD 64
 105
 106 struct nci_conn_info {
 107         struct list_head list;
 108         __u8    id; /* can be an RF Discovery ID or an NFCEE ID */
 109         __u8    conn_id;
 110         __u8    max_pkt_payload_len;
 111
 112         atomic_t credits_cnt;
 113         __u8     initial_num_credits;
 114
 115         data_exchange_cb_t      data_exchange_cb;
 116         void *data_exchange_cb_context;
 117
 118         struct sk_buff *rx_skb;
 119 };
 120
 121 #define NCI_INVALID_CONN_ID 0x80
 122
 123 #define NCI_HCI_ANY_OPEN_PIPE      0x03
 124
 125 /* Gates */
 126 #define NCI_HCI_ADMIN_GATE         0x00
 127 #define NCI_HCI_LINK_MGMT_GATE     0x06
 128
 129 /* Pipes */
 130 #define NCI_HCI_LINK_MGMT_PIPE             0x00
 131 #define NCI_HCI_ADMIN_PIPE                 0x01
 132
 133 /* Generic responses */
 134 #define NCI_HCI_ANY_OK                     0x00
 135 #define NCI_HCI_ANY_E_NOT_CONNECTED        0x01
 136 #define NCI_HCI_ANY_E_CMD_PAR_UNKNOWN      0x02
 137 #define NCI_HCI_ANY_E_NOK                  0x03
 138 #define NCI_HCI_ANY_E_PIPES_FULL           0x04
 139 #define NCI_HCI_ANY_E_REG_PAR_UNKNOWN      0x05
 140 #define NCI_HCI_ANY_E_PIPE_NOT_OPENED      0x06
 141 #define NCI_HCI_ANY_E_CMD_NOT_SUPPORTED    0x07
 142 #define NCI_HCI_ANY_E_INHIBITED            0x08
 143 #define NCI_HCI_ANY_E_TIMEOUT              0x09
 144 #define NCI_HCI_ANY_E_REG_ACCESS_DENIED    0x0a
 145 #define NCI_HCI_ANY_E_PIPE_ACCESS_DENIED   0x0b
 146
 147 #define NCI_HCI_DO_NOT_OPEN_PIPE           0x81
 148 #define NCI_HCI_INVALID_PIPE               0x80
 149 #define NCI_HCI_INVALID_GATE               0xFF
 150 #define NCI_HCI_INVALID_HOST               0x80
 151
 152 #define NCI_HCI_MAX_CUSTOM_GATES   50
 153 /*
 154  * According to specification 102 622 chapter 4.4 Pipes,
 155  * the pipe identifier is 7 bits long.
 156  */
 157 #define NCI_HCI_MAX_PIPES          127
 158
 159 struct nci_hci_gate {
 160         u8 gate;
 161         u8 pipe;
 162         u8 dest_host;
 163 } __packed;
 164
 165 struct nci_hci_pipe {
 166         u8 gate;
 167         u8 host;
 168 } __packed;
 169
 170 struct nci_hci_init_data {
 171         u8 gate_count;
 172         struct nci_hci_gate gates[NCI_HCI_MAX_CUSTOM_GATES];
 173         char session_id[9];
 174 };
 175
 176 #define NCI_HCI_MAX_GATES          256
 177
 178 struct nci_hci_dev {
 179         u8 nfcee_id;
 180         struct nci_dev *ndev;
 181         struct nci_conn_info *conn_info;
 182
 183         struct nci_hci_init_data init_data;
 184         struct nci_hci_pipe pipes[NCI_HCI_MAX_PIPES];
 185         u8 gate2pipe[NCI_HCI_MAX_GATES];
 186         int expected_pipes;
 187         int count_pipes;
 188
 189         struct sk_buff_head rx_hcp_frags;
 190         struct work_struct msg_rx_work;
 191         struct sk_buff_head msg_rx_queue;
 192 };
 193
 194 /* NCI Core structures */
 195 struct nci_dev {
 196         struct nfc_dev          *nfc_dev;
 197         struct nci_ops          *ops;
 198         struct nci_hci_dev      *hci_dev;
 199
 200         int                     tx_headroom;
 201         int                     tx_tailroom;
 202
 203         atomic_t                state;
 204         unsigned long           flags;
 205
 206         atomic_t                cmd_cnt;
 207         __u8                    cur_conn_id;
 208
 209         struct list_head        conn_info_list;
 210         struct nci_conn_info    *rf_conn_info;
 211
 212         struct timer_list       cmd_timer;
 213         struct timer_list       data_timer;
 214
 215         struct workqueue_struct *cmd_wq;
 216         struct work_struct      cmd_work;
 217
 218         struct workqueue_struct *rx_wq;
 219         struct work_struct      rx_work;
 220
 221         struct workqueue_struct *tx_wq;
 222         struct work_struct      tx_work;
 223
 224         struct sk_buff_head     cmd_q;
 225         struct sk_buff_head     rx_q;
 226         struct sk_buff_head     tx_q;
 227
 228         struct mutex            req_lock;
 229         struct completion       req_completion;
 230         __u32                   req_status;
 231         __u32                   req_result;
 232
 233         void                    *driver_data;
 234
 235         __u32                   poll_prots;
 236         __u32                   target_active_prot;
 237
 238         struct nfc_target       targets[NCI_MAX_DISCOVERED_TARGETS];
 239         int                     n_targets;
 240
 241         /* received during NCI_OP_CORE_RESET_RSP */
 242         __u8                    nci_ver;
 243
 244         /* received during NCI_OP_CORE_INIT_RSP */
 245         __u32                   nfcc_features;
 246         __u8                    num_supported_rf_interfaces;
 247         __u8                    supported_rf_interfaces
 248                                 [NCI_MAX_SUPPORTED_RF_INTERFACES];
 249         __u8                    max_logical_connections;
 250         __u16                   max_routing_table_size;
 251         __u8                    max_ctrl_pkt_payload_len;
 252         __u16                   max_size_for_large_params;
 253         __u8                    manufact_id;
 254         __u32                   manufact_specific_info;
 255
 256         /* Save RF Discovery ID or NFCEE ID under conn_create */
 257         __u8                    cur_id;
 258
 259         /* stored during nci_data_exchange */
 260         struct sk_buff          *rx_data_reassembly;
 261
 262         /* stored during intf_activated_ntf */
 263         __u8 remote_gb[NFC_MAX_GT_LEN];
 264         __u8 remote_gb_len;
 265 };
 266
 267 /* ----- NCI Devices ----- */
 268 struct nci_dev *nci_allocate_device(struct nci_ops *ops,
 269                                     __u32 supported_protocols,
 270                                     int tx_headroom,
 271                                     int tx_tailroom);
 272 void nci_free_device(struct nci_dev *ndev);
 273 int nci_register_device(struct nci_dev *ndev);
 274 void nci_unregister_device(struct nci_dev *ndev);
 275 int nci_request(struct nci_dev *ndev,
 276                 void (*req)(struct nci_dev *ndev,
 277                             unsigned long opt),
 278                 unsigned long opt, __u32 timeout);
 279 int nci_prop_cmd(struct nci_dev *ndev, __u8 oid, size_t len, __u8 *payload);
 280
 281 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
 282 int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val);
 283
 284 int nci_nfcee_discover(struct nci_dev *ndev, u8 action);
 285 int nci_nfcee_mode_set(struct nci_dev *ndev, u8 nfcee_id, u8 nfcee_mode);
 286 int nci_core_conn_create(struct nci_dev *ndev, u8 destination_type,
 287                          u8 number_destination_params,
 288                          size_t params_len,
 289                          struct core_conn_create_dest_spec_params *params);
 290 int nci_core_conn_close(struct nci_dev *ndev, u8 conn_id);
 291
 292 struct nci_hci_dev *nci_hci_allocate(struct nci_dev *ndev);
 293 int nci_hci_send_event(struct nci_dev *ndev, u8 gate, u8 event,
 294                        const u8 *param, size_t param_len);
 295 int nci_hci_send_cmd(struct nci_dev *ndev, u8 gate,
 296                      u8 cmd, const u8 *param, size_t param_len,
 297                      struct sk_buff **skb);
 298 int nci_hci_open_pipe(struct nci_dev *ndev, u8 pipe);
 299 int nci_hci_connect_gate(struct nci_dev *ndev, u8 dest_host,
 300                          u8 dest_gate, u8 pipe);
 301 int nci_hci_set_param(struct nci_dev *ndev, u8 gate, u8 idx,
 302                       const u8 *param, size_t param_len);
 303 int nci_hci_get_param(struct nci_dev *ndev, u8 gate, u8 idx,
 304                       struct sk_buff **skb);
 305 int nci_hci_dev_session_init(struct nci_dev *ndev);
 306
 307 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
 308                                             unsigned int len,
 309                                             gfp_t how)
 310 {
 311         struct sk_buff *skb;
 312
 313         skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
 314         if (skb)
 315                 skb_reserve(skb, ndev->tx_headroom);
 316
 317         return skb;
 318 }
 319
 320 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
 321 {
 322         nfc_set_parent_dev(ndev->nfc_dev, dev);
 323 }
 324
 325 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
 326 {
 327         ndev->driver_data = data;
 328 }
 329
 330 static inline void *nci_get_drvdata(struct nci_dev *ndev)
 331 {
 332         return ndev->driver_data;
 333 }
 334
 335 static inline int nci_set_vendor_cmds(struct nci_dev *ndev,
 336                                       struct nfc_vendor_cmd *cmds,
 337                                       int n_cmds)
 338 {
 339         return nfc_set_vendor_cmds(ndev->nfc_dev, cmds, n_cmds);
 340 }
 341
 342 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
 343 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
 344 int nci_prop_rsp_packet(struct nci_dev *ndev, __u16 opcode,
 345                         struct sk_buff *skb);
 346 int nci_prop_ntf_packet(struct nci_dev *ndev, __u16 opcode,
 347                         struct sk_buff *skb);
 348 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
 349 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
 350 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
 351 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
 352                                 __u8 conn_id, int err);
 353 void nci_hci_data_received_cb(void *context, struct sk_buff *skb, int err);
 354
 355 void nci_clear_target_list(struct nci_dev *ndev);
 356
 357 /* ----- NCI requests ----- */
 358 #define NCI_REQ_DONE            0
 359 #define NCI_REQ_PEND            1
 360 #define NCI_REQ_CANCELED        2
 361
 362 void nci_req_complete(struct nci_dev *ndev, int result);
 363 struct nci_conn_info *nci_get_conn_info_by_conn_id(struct nci_dev *ndev,
 364                                                    int conn_id);
 365
 366 /* ----- NCI status code ----- */
 367 int nci_to_errno(__u8 code);
 368
 369 /* ----- NCI over SPI acknowledge modes ----- */
 370 #define NCI_SPI_CRC_DISABLED    0x00
 371 #define NCI_SPI_CRC_ENABLED     0x01
 372
 373 /* ----- NCI SPI structures ----- */
 374 struct nci_spi {
 375         struct nci_dev          *ndev;
 376         struct spi_device       *spi;
 377
 378         unsigned int            xfer_udelay;    /* microseconds delay between
 379                                                   transactions */
 380         u8                      acknowledge_mode;
 381
 382         struct completion       req_completion;
 383         u8                      req_result;
 384 };
 385
 386 /* ----- NCI SPI ----- */
 387 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
 388                                      u8 acknowledge_mode, unsigned int delay,
 389                                      struct nci_dev *ndev);
 390 int nci_spi_send(struct nci_spi *nspi,
 391                  struct completion *write_handshake_completion,
 392                  struct sk_buff *skb);
 393 struct sk_buff *nci_spi_read(struct nci_spi *nspi);
 394
 395 /* ----- NCI UART ---- */
 396
 397 /* Ioctl */
 398 #define NCIUARTSETDRIVER        _IOW('U', 0, char *)
 399
 400 enum nci_uart_driver {
 401         NCI_UART_DRIVER_MARVELL = 0,
 402         NCI_UART_DRIVER_MAX
 403 };
 404
 405 struct nci_uart;
 406
 407 struct nci_uart_ops {
 408         int (*open)(struct nci_uart *nci_uart);
 409         void (*close)(struct nci_uart *nci_uart);
 410         int (*recv)(struct nci_uart *nci_uart, struct sk_buff *skb);
 411         int (*recv_buf)(struct nci_uart *nci_uart, const u8 *data, char *flags,
 412                         int count);
 413         int (*send)(struct nci_uart *nci_uart, struct sk_buff *skb);
 414         void (*tx_start)(struct nci_uart *nci_uart);
 415         void (*tx_done)(struct nci_uart *nci_uart);
 416 };
 417
 418 struct nci_uart {
 419         struct module           *owner;
 420         struct nci_uart_ops     ops;
 421         const char              *name;
 422         enum nci_uart_driver    driver;
 423
 424         /* Dynamic data */
 425         struct nci_dev          *ndev;
 426         spinlock_t              rx_lock;
 427         struct work_struct      write_work;
 428         struct tty_struct       *tty;
 429         unsigned long           tx_state;
 430         struct sk_buff_head     tx_q;
 431         struct sk_buff          *tx_skb;
 432         struct sk_buff          *rx_skb;
 433         int                     rx_packet_len;
 434         void                    *drv_data;
 435 };
 436
 437 int nci_uart_register(struct nci_uart *nu);
 438 void nci_uart_unregister(struct nci_uart *nu);
 439 void nci_uart_set_config(struct nci_uart *nu, int baudrate, int flow_ctrl);
 440
 441 #endif /* __NCI_CORE_H */