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