include/net/nfc/nci_core.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  *  The NFC Controller Interface is the communication protocol between an
   4  *  NFC Controller (NFCC) and a Device Host (DH).
   5  *
   6  *  Copyright (C) 2011 Texas Instruments, Inc.
   7  *  Copyright (C) 2013 Intel Corporation. All rights reserved.
   8  *  Copyright (C) 2014 Marvell International Ltd.
   9  *
  10  *  Written by Ilan Elias <ilane@ti.com>
  11  *
  12  *  Acknowledgements:
  13  *  This file is based on hci_core.h, which was written
  14  *  by Maxim Krasnyansky.
  15  */
  16
  17 #ifndef __NCI_CORE_H
  18 #define __NCI_CORE_H
  19
  20 #include <linux/interrupt.h>
  21 #include <linux/skbuff.h>
  22 #include <linux/tty.h>
  23
  24 #include <net/nfc/nfc.h>
  25 #include <net/nfc/nci.h>
  26
  27 /* NCI device flags */
  28 enum nci_flag {
  29         NCI_INIT,
  30         NCI_UP,
  31         NCI_DATA_EXCHANGE,
  32         NCI_DATA_EXCHANGE_TO,
  33 };
  34
  35 /* NCI device states */
  36 enum nci_state {
  37         NCI_IDLE,
  38         NCI_DISCOVERY,
  39         NCI_W4_ALL_DISCOVERIES,
  40         NCI_W4_HOST_SELECT,
  41         NCI_POLL_ACTIVE,
  42         NCI_LISTEN_ACTIVE,
  43         NCI_LISTEN_SLEEP,
  44 };
  45
  46 /* NCI timeouts */
  47 #define NCI_RESET_TIMEOUT                       5000
  48 #define NCI_INIT_TIMEOUT                        5000
  49 #define NCI_SET_CONFIG_TIMEOUT                  5000
  50 #define NCI_RF_DISC_TIMEOUT                     5000
  51 #define NCI_RF_DISC_SELECT_TIMEOUT              5000
  52 #define NCI_RF_DEACTIVATE_TIMEOUT               30000
  53 #define NCI_CMD_TIMEOUT                         5000
  54 #define NCI_DATA_TIMEOUT                        700
  55
  56 struct nci_dev;
  57
  58 struct nci_driver_ops {
  59         __u16 opcode;
  60         int (*rsp)(struct nci_dev *dev, struct sk_buff *skb);
  61         int (*ntf)(struct nci_dev *dev, struct sk_buff *skb);
  62 };
  63
  64 struct nci_ops {
  65         int   (*init)(struct nci_dev *ndev);
  66         int   (*open)(struct nci_dev *ndev);
  67         int   (*close)(struct nci_dev *ndev);
  68         int   (*send)(struct nci_dev *ndev, struct sk_buff *skb);
  69         int   (*setup)(struct nci_dev *ndev);
  70         int   (*post_setup)(struct nci_dev *ndev);
  71         int   (*fw_download)(struct nci_dev *ndev, const char *firmware_name);
  72         __u32 (*get_rfprotocol)(struct nci_dev *ndev, __u8 rf_protocol);
  73         int   (*discover_se)(struct nci_dev *ndev);
  74         int   (*disable_se)(struct nci_dev *ndev, u32 se_idx);
  75         int   (*enable_se)(struct nci_dev *ndev, u32 se_idx);
  76         int   (*se_io)(struct nci_dev *ndev, u32 se_idx,
  77                                 u8 *apdu, size_t apdu_length,
  78                                 se_io_cb_t cb, void *cb_context);
  79         int   (*hci_load_session)(struct nci_dev *ndev);
  80         void  (*hci_event_received)(struct nci_dev *ndev, u8 pipe, u8 event,
  81                                     struct sk_buff *skb);
  82         void  (*hci_cmd_received)(struct nci_dev *ndev, u8 pipe, u8 cmd,
  83                                   struct sk_buff *skb);
  84
  85         const struct nci_driver_ops *prop_ops;
  86         size_t n_prop_ops;
  87
  88         const struct nci_driver_ops *core_ops;
  89         size_t n_core_ops;
  90 };
  91
  92 #define NCI_MAX_SUPPORTED_RF_INTERFACES         4
  93 #define NCI_MAX_DISCOVERED_TARGETS              10
  94 #define NCI_MAX_NUM_NFCEE   255
  95 #define NCI_MAX_CONN_ID         7
  96 #define NCI_MAX_PROPRIETARY_CMD 64
  97
  98 struct nci_conn_info {
  99         struct list_head list;
 100         /* NCI specification 4.4.2 Connection Creation
 101          * The combination of destination type and destination specific
 102          * parameters shall uniquely identify a single destination for the
 103          * Logical Connection
 104          */
 105         struct dest_spec_params *dest_params;
 106         __u8    dest_type;
 107         __u8    conn_id;
 108         __u8    max_pkt_payload_len;
 109
 110         atomic_t credits_cnt;
 111         __u8     initial_num_credits;
 112
 113         data_exchange_cb_t      data_exchange_cb;
 114         void *data_exchange_cb_context;
 115
 116         struct sk_buff *rx_skb;
 117 };
 118
 119 #define NCI_INVALID_CONN_ID 0x80
 120
 121 #define NCI_HCI_ANY_OPEN_PIPE      0x03
 122
 123 /* Gates */
 124 #define NCI_HCI_ADMIN_GATE         0x00
 125 #define NCI_HCI_LOOPBACK_GATE      0x04
 126 #define NCI_HCI_IDENTITY_MGMT_GATE 0x05
 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          128
 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         const 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         struct dest_spec_params cur_params;
 258         /* Save destination type under conn_create */
 259         __u8                    cur_dest_type;
 260
 261         /* stored during nci_data_exchange */
 262         struct sk_buff          *rx_data_reassembly;
 263
 264         /* stored during intf_activated_ntf */
 265         __u8 remote_gb[NFC_MAX_GT_LEN];
 266         __u8 remote_gb_len;
 267 };
 268
 269 /* ----- NCI Devices ----- */
 270 struct nci_dev *nci_allocate_device(const struct nci_ops *ops,
 271                                     __u32 supported_protocols,
 272                                     int tx_headroom,
 273                                     int tx_tailroom);
 274 void nci_free_device(struct nci_dev *ndev);
 275 int nci_register_device(struct nci_dev *ndev);
 276 void nci_unregister_device(struct nci_dev *ndev);
 277 int nci_request(struct nci_dev *ndev,
 278                 void (*req)(struct nci_dev *ndev,
 279                             unsigned long opt),
 280                 unsigned long opt, __u32 timeout);
 281 int nci_prop_cmd(struct nci_dev *ndev, __u8 oid, size_t len,
 282                  const __u8 *payload);
 283 int nci_core_cmd(struct nci_dev *ndev, __u16 opcode, size_t len,
 284                  const __u8 *payload);
 285 int nci_core_reset(struct nci_dev *ndev);
 286 int nci_core_init(struct nci_dev *ndev);
 287
 288 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
 289 int nci_send_frame(struct nci_dev *ndev, struct sk_buff *skb);
 290 int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, const __u8 *val);
 291
 292 int nci_nfcee_discover(struct nci_dev *ndev, u8 action);
 293 int nci_nfcee_mode_set(struct nci_dev *ndev, u8 nfcee_id, u8 nfcee_mode);
 294 int nci_core_conn_create(struct nci_dev *ndev, u8 destination_type,
 295                          u8 number_destination_params,
 296                          size_t params_len,
 297                          const struct core_conn_create_dest_spec_params *params);
 298 int nci_core_conn_close(struct nci_dev *ndev, u8 conn_id);
 299 int nci_nfcc_loopback(struct nci_dev *ndev, const void *data, size_t data_len,
 300                       struct sk_buff **resp);
 301
 302 struct nci_hci_dev *nci_hci_allocate(struct nci_dev *ndev);
 303 void nci_hci_deallocate(struct nci_dev *ndev);
 304 int nci_hci_send_event(struct nci_dev *ndev, u8 gate, u8 event,
 305                        const u8 *param, size_t param_len);
 306 int nci_hci_send_cmd(struct nci_dev *ndev, u8 gate,
 307                      u8 cmd, const u8 *param, size_t param_len,
 308                      struct sk_buff **skb);
 309 int nci_hci_open_pipe(struct nci_dev *ndev, u8 pipe);
 310 int nci_hci_connect_gate(struct nci_dev *ndev, u8 dest_host,
 311                          u8 dest_gate, u8 pipe);
 312 int nci_hci_set_param(struct nci_dev *ndev, u8 gate, u8 idx,
 313                       const u8 *param, size_t param_len);
 314 int nci_hci_get_param(struct nci_dev *ndev, u8 gate, u8 idx,
 315                       struct sk_buff **skb);
 316 int nci_hci_clear_all_pipes(struct nci_dev *ndev);
 317 int nci_hci_dev_session_init(struct nci_dev *ndev);
 318
 319 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
 320                                             unsigned int len,
 321                                             gfp_t how)
 322 {
 323         struct sk_buff *skb;
 324
 325         skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
 326         if (skb)
 327                 skb_reserve(skb, ndev->tx_headroom);
 328
 329         return skb;
 330 }
 331
 332 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
 333 {
 334         nfc_set_parent_dev(ndev->nfc_dev, dev);
 335 }
 336
 337 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
 338 {
 339         ndev->driver_data = data;
 340 }
 341
 342 static inline void *nci_get_drvdata(struct nci_dev *ndev)
 343 {
 344         return ndev->driver_data;
 345 }
 346
 347 static inline int nci_set_vendor_cmds(struct nci_dev *ndev,
 348                                       const struct nfc_vendor_cmd *cmds,
 349                                       int n_cmds)
 350 {
 351         return nfc_set_vendor_cmds(ndev->nfc_dev, cmds, n_cmds);
 352 }
 353
 354 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
 355 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
 356 int nci_prop_rsp_packet(struct nci_dev *ndev, __u16 opcode,
 357                         struct sk_buff *skb);
 358 int nci_prop_ntf_packet(struct nci_dev *ndev, __u16 opcode,
 359                         struct sk_buff *skb);
 360 int nci_core_rsp_packet(struct nci_dev *ndev, __u16 opcode,
 361                         struct sk_buff *skb);
 362 int nci_core_ntf_packet(struct nci_dev *ndev, __u16 opcode,
 363                         struct sk_buff *skb);
 364 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
 365 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, const void *payload);
 366 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
 367 int nci_conn_max_data_pkt_payload_size(struct nci_dev *ndev, __u8 conn_id);
 368 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
 369                                 __u8 conn_id, int err);
 370 void nci_hci_data_received_cb(void *context, struct sk_buff *skb, int err);
 371
 372 void nci_clear_target_list(struct nci_dev *ndev);
 373
 374 /* ----- NCI requests ----- */
 375 #define NCI_REQ_DONE            0
 376 #define NCI_REQ_PEND            1
 377 #define NCI_REQ_CANCELED        2
 378
 379 void nci_req_complete(struct nci_dev *ndev, int result);
 380 struct nci_conn_info *nci_get_conn_info_by_conn_id(struct nci_dev *ndev,
 381                                                    int conn_id);
 382 int nci_get_conn_info_by_dest_type_params(struct nci_dev *ndev, u8 dest_type,
 383                                           const struct dest_spec_params *params);
 384
 385 /* ----- NCI status code ----- */
 386 int nci_to_errno(__u8 code);
 387
 388 /* ----- NCI over SPI acknowledge modes ----- */
 389 #define NCI_SPI_CRC_DISABLED    0x00
 390 #define NCI_SPI_CRC_ENABLED     0x01
 391
 392 /* ----- NCI SPI structures ----- */
 393 struct nci_spi {
 394         struct nci_dev          *ndev;
 395         struct spi_device       *spi;
 396
 397         unsigned int            xfer_udelay;    /* microseconds delay between
 398                                                   transactions */
 399
 400         unsigned int            xfer_speed_hz; /*
 401                                                 * SPI clock frequency
 402                                                 * 0 => default clock
 403                                                 */
 404
 405         u8                      acknowledge_mode;
 406
 407         struct completion       req_completion;
 408         u8                      req_result;
 409 };
 410
 411 /* ----- NCI SPI ----- */
 412 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
 413                                      u8 acknowledge_mode, unsigned int delay,
 414                                      struct nci_dev *ndev);
 415 int nci_spi_send(struct nci_spi *nspi,
 416                  struct completion *write_handshake_completion,
 417                  struct sk_buff *skb);
 418 struct sk_buff *nci_spi_read(struct nci_spi *nspi);
 419
 420 /* ----- NCI UART ---- */
 421
 422 /* Ioctl */
 423 #define NCIUARTSETDRIVER        _IOW('U', 0, char *)
 424
 425 enum nci_uart_driver {
 426         NCI_UART_DRIVER_MARVELL = 0,
 427         NCI_UART_DRIVER_MAX
 428 };
 429
 430 struct nci_uart;
 431
 432 struct nci_uart_ops {
 433         int (*open)(struct nci_uart *nci_uart);
 434         void (*close)(struct nci_uart *nci_uart);
 435         int (*recv)(struct nci_uart *nci_uart, struct sk_buff *skb);
 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 */