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