net/nfc/nci_core.h

0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  *  The NFC Controller Interface is the communication protocol between an
0004  *  NFC Controller (NFCC) and a Device Host (DH).
0005  *
0006  *  Copyright (C) 2011 Texas Instruments, Inc.
0007  *  Copyright (C) 2013 Intel Corporation. All rights reserved.
0008  *  Copyright (C) 2014 Marvell International Ltd.
0009  *
0010  *  Written by Ilan Elias <ilane@ti.com>
0011  *
0012  *  Acknowledgements:
0013  *  This file is based on hci_core.h, which was written
0014  *  by Maxim Krasnyansky.
0015  */
0016
0017 #ifndef __NCI_CORE_H
0018 #define __NCI_CORE_H
0019
0020 #include <linux/interrupt.h>
0021 #include <linux/skbuff.h>
0022 #include <linux/tty.h>
0023
0024 #include <net/nfc/nfc.h>
0025 #include <net/nfc/nci.h>
0026
0027 /* NCI device flags */
0028 enum nci_flag {
0029     NCI_INIT,
0030     NCI_UP,
0031     NCI_DATA_EXCHANGE,
0032     NCI_DATA_EXCHANGE_TO,
0033     NCI_UNREG,
0034 };
0035
0036 /* NCI device states */
0037 enum nci_state {
0038     NCI_IDLE,
0039     NCI_DISCOVERY,
0040     NCI_W4_ALL_DISCOVERIES,
0041     NCI_W4_HOST_SELECT,
0042     NCI_POLL_ACTIVE,
0043     NCI_LISTEN_ACTIVE,
0044     NCI_LISTEN_SLEEP,
0045 };
0046
0047 /* NCI timeouts */
0048 #define NCI_RESET_TIMEOUT           5000
0049 #define NCI_INIT_TIMEOUT            5000
0050 #define NCI_SET_CONFIG_TIMEOUT          5000
0051 #define NCI_RF_DISC_TIMEOUT         5000
0052 #define NCI_RF_DISC_SELECT_TIMEOUT      5000
0053 #define NCI_RF_DEACTIVATE_TIMEOUT       30000
0054 #define NCI_CMD_TIMEOUT             5000
0055 #define NCI_DATA_TIMEOUT            700
0056
0057 struct nci_dev;
0058
0059 struct nci_driver_ops {
0060     __u16 opcode;
0061     int (*rsp)(struct nci_dev *dev, struct sk_buff *skb);
0062     int (*ntf)(struct nci_dev *dev, struct sk_buff *skb);
0063 };
0064
0065 struct nci_ops {
0066     int   (*init)(struct nci_dev *ndev);
0067     int   (*open)(struct nci_dev *ndev);
0068     int   (*close)(struct nci_dev *ndev);
0069     int   (*send)(struct nci_dev *ndev, struct sk_buff *skb);
0070     int   (*setup)(struct nci_dev *ndev);
0071     int   (*post_setup)(struct nci_dev *ndev);
0072     int   (*fw_download)(struct nci_dev *ndev, const char *firmware_name);
0073     __u32 (*get_rfprotocol)(struct nci_dev *ndev, __u8 rf_protocol);
0074     int   (*discover_se)(struct nci_dev *ndev);
0075     int   (*disable_se)(struct nci_dev *ndev, u32 se_idx);
0076     int   (*enable_se)(struct nci_dev *ndev, u32 se_idx);
0077     int   (*se_io)(struct nci_dev *ndev, u32 se_idx,
0078                 u8 *apdu, size_t apdu_length,
0079                 se_io_cb_t cb, void *cb_context);
0080     int   (*hci_load_session)(struct nci_dev *ndev);
0081     void  (*hci_event_received)(struct nci_dev *ndev, u8 pipe, u8 event,
0082                     struct sk_buff *skb);
0083     void  (*hci_cmd_received)(struct nci_dev *ndev, u8 pipe, u8 cmd,
0084                   struct sk_buff *skb);
0085
0086     const struct nci_driver_ops *prop_ops;
0087     size_t n_prop_ops;
0088
0089     const struct nci_driver_ops *core_ops;
0090     size_t n_core_ops;
0091 };
0092
0093 #define NCI_MAX_SUPPORTED_RF_INTERFACES     4
0094 #define NCI_MAX_DISCOVERED_TARGETS      10
0095 #define NCI_MAX_NUM_NFCEE   255
0096 #define NCI_MAX_CONN_ID     7
0097 #define NCI_MAX_PROPRIETARY_CMD 64
0098
0099 struct nci_conn_info {
0100     struct list_head list;
0101     /* NCI specification 4.4.2 Connection Creation
0102      * The combination of destination type and destination specific
0103      * parameters shall uniquely identify a single destination for the
0104      * Logical Connection
0105      */
0106     struct dest_spec_params *dest_params;
0107     __u8    dest_type;
0108     __u8    conn_id;
0109     __u8    max_pkt_payload_len;
0110
0111     atomic_t credits_cnt;
0112     __u8     initial_num_credits;
0113
0114     data_exchange_cb_t  data_exchange_cb;
0115     void *data_exchange_cb_context;
0116
0117     struct sk_buff *rx_skb;
0118 };
0119
0120 #define NCI_INVALID_CONN_ID 0x80
0121
0122 #define NCI_HCI_ANY_OPEN_PIPE      0x03
0123
0124 /* Gates */
0125 #define NCI_HCI_ADMIN_GATE         0x00
0126 #define NCI_HCI_LOOPBACK_GATE      0x04
0127 #define NCI_HCI_IDENTITY_MGMT_GATE 0x05
0128 #define NCI_HCI_LINK_MGMT_GATE     0x06
0129
0130 /* Pipes */
0131 #define NCI_HCI_LINK_MGMT_PIPE             0x00
0132 #define NCI_HCI_ADMIN_PIPE                 0x01
0133
0134 /* Generic responses */
0135 #define NCI_HCI_ANY_OK                     0x00
0136 #define NCI_HCI_ANY_E_NOT_CONNECTED        0x01
0137 #define NCI_HCI_ANY_E_CMD_PAR_UNKNOWN      0x02
0138 #define NCI_HCI_ANY_E_NOK                  0x03
0139 #define NCI_HCI_ANY_E_PIPES_FULL           0x04
0140 #define NCI_HCI_ANY_E_REG_PAR_UNKNOWN      0x05
0141 #define NCI_HCI_ANY_E_PIPE_NOT_OPENED      0x06
0142 #define NCI_HCI_ANY_E_CMD_NOT_SUPPORTED    0x07
0143 #define NCI_HCI_ANY_E_INHIBITED            0x08
0144 #define NCI_HCI_ANY_E_TIMEOUT              0x09
0145 #define NCI_HCI_ANY_E_REG_ACCESS_DENIED    0x0a
0146 #define NCI_HCI_ANY_E_PIPE_ACCESS_DENIED   0x0b
0147
0148 #define NCI_HCI_DO_NOT_OPEN_PIPE           0x81
0149 #define NCI_HCI_INVALID_PIPE               0x80
0150 #define NCI_HCI_INVALID_GATE               0xFF
0151 #define NCI_HCI_INVALID_HOST               0x80
0152
0153 #define NCI_HCI_MAX_CUSTOM_GATES   50
0154 /*
0155  * According to specification 102 622 chapter 4.4 Pipes,
0156  * the pipe identifier is 7 bits long.
0157  */
0158 #define NCI_HCI_MAX_PIPES          128
0159
0160 struct nci_hci_gate {
0161     u8 gate;
0162     u8 pipe;
0163     u8 dest_host;
0164 } __packed;
0165
0166 struct nci_hci_pipe {
0167     u8 gate;
0168     u8 host;
0169 } __packed;
0170
0171 struct nci_hci_init_data {
0172     u8 gate_count;
0173     struct nci_hci_gate gates[NCI_HCI_MAX_CUSTOM_GATES];
0174     char session_id[9];
0175 };
0176
0177 #define NCI_HCI_MAX_GATES          256
0178
0179 struct nci_hci_dev {
0180     u8 nfcee_id;
0181     struct nci_dev *ndev;
0182     struct nci_conn_info *conn_info;
0183
0184     struct nci_hci_init_data init_data;
0185     struct nci_hci_pipe pipes[NCI_HCI_MAX_PIPES];
0186     u8 gate2pipe[NCI_HCI_MAX_GATES];
0187     int expected_pipes;
0188     int count_pipes;
0189
0190     struct sk_buff_head rx_hcp_frags;
0191     struct work_struct msg_rx_work;
0192     struct sk_buff_head msg_rx_queue;
0193 };
0194
0195 /* NCI Core structures */
0196 struct nci_dev {
0197     struct nfc_dev      *nfc_dev;
0198     const struct nci_ops    *ops;
0199     struct nci_hci_dev  *hci_dev;
0200
0201     int         tx_headroom;
0202     int         tx_tailroom;
0203
0204     atomic_t        state;
0205     unsigned long       flags;
0206
0207     atomic_t        cmd_cnt;
0208     __u8            cur_conn_id;
0209
0210     struct list_head    conn_info_list;
0211     struct nci_conn_info    *rf_conn_info;
0212
0213     struct timer_list   cmd_timer;
0214     struct timer_list   data_timer;
0215
0216     struct workqueue_struct *cmd_wq;
0217     struct work_struct  cmd_work;
0218
0219     struct workqueue_struct *rx_wq;
0220     struct work_struct  rx_work;
0221
0222     struct workqueue_struct *tx_wq;
0223     struct work_struct  tx_work;
0224
0225     struct sk_buff_head cmd_q;
0226     struct sk_buff_head rx_q;
0227     struct sk_buff_head tx_q;
0228
0229     struct mutex        req_lock;
0230     struct completion   req_completion;
0231     __u32           req_status;
0232     __u32           req_result;
0233
0234     void            *driver_data;
0235
0236     __u32           poll_prots;
0237     __u32           target_active_prot;
0238
0239     struct nfc_target   targets[NCI_MAX_DISCOVERED_TARGETS];
0240     int         n_targets;
0241
0242     /* received during NCI_OP_CORE_RESET_RSP */
0243     __u8            nci_ver;
0244
0245     /* received during NCI_OP_CORE_INIT_RSP */
0246     __u32           nfcc_features;
0247     __u8            num_supported_rf_interfaces;
0248     __u8            supported_rf_interfaces
0249                 [NCI_MAX_SUPPORTED_RF_INTERFACES];
0250     __u8            max_logical_connections;
0251     __u16           max_routing_table_size;
0252     __u8            max_ctrl_pkt_payload_len;
0253     __u16           max_size_for_large_params;
0254     __u8            manufact_id;
0255     __u32           manufact_specific_info;
0256
0257     /* Save RF Discovery ID or NFCEE ID under conn_create */
0258     struct dest_spec_params cur_params;
0259     /* Save destination type under conn_create */
0260     __u8            cur_dest_type;
0261
0262     /* stored during nci_data_exchange */
0263     struct sk_buff      *rx_data_reassembly;
0264
0265     /* stored during intf_activated_ntf */
0266     __u8 remote_gb[NFC_MAX_GT_LEN];
0267     __u8 remote_gb_len;
0268 };
0269
0270 /* ----- NCI Devices ----- */
0271 struct nci_dev *nci_allocate_device(const struct nci_ops *ops,
0272                     __u32 supported_protocols,
0273                     int tx_headroom,
0274                     int tx_tailroom);
0275 void nci_free_device(struct nci_dev *ndev);
0276 int nci_register_device(struct nci_dev *ndev);
0277 void nci_unregister_device(struct nci_dev *ndev);
0278 int nci_request(struct nci_dev *ndev,
0279         void (*req)(struct nci_dev *ndev,
0280                 const void *opt),
0281         const void *opt, __u32 timeout);
0282 int nci_prop_cmd(struct nci_dev *ndev, __u8 oid, size_t len,
0283          const __u8 *payload);
0284 int nci_core_cmd(struct nci_dev *ndev, __u16 opcode, size_t len,
0285          const __u8 *payload);
0286 int nci_core_reset(struct nci_dev *ndev);
0287 int nci_core_init(struct nci_dev *ndev);
0288
0289 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
0290 int nci_send_frame(struct nci_dev *ndev, struct sk_buff *skb);
0291 int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, const __u8 *val);
0292
0293 int nci_nfcee_discover(struct nci_dev *ndev, u8 action);
0294 int nci_nfcee_mode_set(struct nci_dev *ndev, u8 nfcee_id, u8 nfcee_mode);
0295 int nci_core_conn_create(struct nci_dev *ndev, u8 destination_type,
0296              u8 number_destination_params,
0297              size_t params_len,
0298              const struct core_conn_create_dest_spec_params *params);
0299 int nci_core_conn_close(struct nci_dev *ndev, u8 conn_id);
0300 int nci_nfcc_loopback(struct nci_dev *ndev, const void *data, size_t data_len,
0301               struct sk_buff **resp);
0302
0303 struct nci_hci_dev *nci_hci_allocate(struct nci_dev *ndev);
0304 void nci_hci_deallocate(struct nci_dev *ndev);
0305 int nci_hci_send_event(struct nci_dev *ndev, u8 gate, u8 event,
0306                const u8 *param, size_t param_len);
0307 int nci_hci_send_cmd(struct nci_dev *ndev, u8 gate,
0308              u8 cmd, const u8 *param, size_t param_len,
0309              struct sk_buff **skb);
0310 int nci_hci_open_pipe(struct nci_dev *ndev, u8 pipe);
0311 int nci_hci_connect_gate(struct nci_dev *ndev, u8 dest_host,
0312              u8 dest_gate, u8 pipe);
0313 int nci_hci_set_param(struct nci_dev *ndev, u8 gate, u8 idx,
0314               const u8 *param, size_t param_len);
0315 int nci_hci_get_param(struct nci_dev *ndev, u8 gate, u8 idx,
0316               struct sk_buff **skb);
0317 int nci_hci_clear_all_pipes(struct nci_dev *ndev);
0318 int nci_hci_dev_session_init(struct nci_dev *ndev);
0319
0320 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
0321                         unsigned int len,
0322                         gfp_t how)
0323 {
0324     struct sk_buff *skb;
0325
0326     skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
0327     if (skb)
0328         skb_reserve(skb, ndev->tx_headroom);
0329
0330     return skb;
0331 }
0332
0333 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
0334 {
0335     nfc_set_parent_dev(ndev->nfc_dev, dev);
0336 }
0337
0338 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
0339 {
0340     ndev->driver_data = data;
0341 }
0342
0343 static inline void *nci_get_drvdata(struct nci_dev *ndev)
0344 {
0345     return ndev->driver_data;
0346 }
0347
0348 static inline int nci_set_vendor_cmds(struct nci_dev *ndev,
0349                       const struct nfc_vendor_cmd *cmds,
0350                       int n_cmds)
0351 {
0352     return nfc_set_vendor_cmds(ndev->nfc_dev, cmds, n_cmds);
0353 }
0354
0355 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
0356 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
0357 int nci_prop_rsp_packet(struct nci_dev *ndev, __u16 opcode,
0358             struct sk_buff *skb);
0359 int nci_prop_ntf_packet(struct nci_dev *ndev, __u16 opcode,
0360             struct sk_buff *skb);
0361 int nci_core_rsp_packet(struct nci_dev *ndev, __u16 opcode,
0362             struct sk_buff *skb);
0363 int nci_core_ntf_packet(struct nci_dev *ndev, __u16 opcode,
0364             struct sk_buff *skb);
0365 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
0366 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, const void *payload);
0367 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
0368 int nci_conn_max_data_pkt_payload_size(struct nci_dev *ndev, __u8 conn_id);
0369 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
0370                 __u8 conn_id, int err);
0371 void nci_hci_data_received_cb(void *context, struct sk_buff *skb, int err);
0372
0373 void nci_clear_target_list(struct nci_dev *ndev);
0374
0375 /* ----- NCI requests ----- */
0376 #define NCI_REQ_DONE        0
0377 #define NCI_REQ_PEND        1
0378 #define NCI_REQ_CANCELED    2
0379
0380 void nci_req_complete(struct nci_dev *ndev, int result);
0381 struct nci_conn_info *nci_get_conn_info_by_conn_id(struct nci_dev *ndev,
0382                            int conn_id);
0383 int nci_get_conn_info_by_dest_type_params(struct nci_dev *ndev, u8 dest_type,
0384                       const struct dest_spec_params *params);
0385
0386 /* ----- NCI status code ----- */
0387 int nci_to_errno(__u8 code);
0388
0389 /* ----- NCI over SPI acknowledge modes ----- */
0390 #define NCI_SPI_CRC_DISABLED    0x00
0391 #define NCI_SPI_CRC_ENABLED 0x01
0392
0393 /* ----- NCI SPI structures ----- */
0394 struct nci_spi {
0395     struct nci_dev      *ndev;
0396     struct spi_device   *spi;
0397
0398     unsigned int        xfer_udelay;    /* microseconds delay between
0399                           transactions */
0400
0401     unsigned int        xfer_speed_hz; /*
0402                         * SPI clock frequency
0403                         * 0 => default clock
0404                         */
0405
0406     u8          acknowledge_mode;
0407
0408     struct completion   req_completion;
0409     u8          req_result;
0410 };
0411
0412 /* ----- NCI SPI ----- */
0413 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
0414                      u8 acknowledge_mode, unsigned int delay,
0415                      struct nci_dev *ndev);
0416 int nci_spi_send(struct nci_spi *nspi,
0417          struct completion *write_handshake_completion,
0418          struct sk_buff *skb);
0419 struct sk_buff *nci_spi_read(struct nci_spi *nspi);
0420
0421 /* ----- NCI UART ---- */
0422
0423 /* Ioctl */
0424 #define NCIUARTSETDRIVER    _IOW('U', 0, char *)
0425
0426 enum nci_uart_driver {
0427     NCI_UART_DRIVER_MARVELL = 0,
0428     NCI_UART_DRIVER_MAX
0429 };
0430
0431 struct nci_uart;
0432
0433 struct nci_uart_ops {
0434     int (*open)(struct nci_uart *nci_uart);
0435     void (*close)(struct nci_uart *nci_uart);
0436     int (*recv)(struct nci_uart *nci_uart, struct sk_buff *skb);
0437     int (*send)(struct nci_uart *nci_uart, struct sk_buff *skb);
0438     void (*tx_start)(struct nci_uart *nci_uart);
0439     void (*tx_done)(struct nci_uart *nci_uart);
0440 };
0441
0442 struct nci_uart {
0443     struct module       *owner;
0444     struct nci_uart_ops ops;
0445     const char      *name;
0446     enum nci_uart_driver    driver;
0447
0448     /* Dynamic data */
0449     struct nci_dev      *ndev;
0450     spinlock_t      rx_lock;
0451     struct work_struct  write_work;
0452     struct tty_struct   *tty;
0453     unsigned long       tx_state;
0454     struct sk_buff_head tx_q;
0455     struct sk_buff      *tx_skb;
0456     struct sk_buff      *rx_skb;
0457     int         rx_packet_len;
0458     void            *drv_data;
0459 };
0460
0461 int nci_uart_register(struct nci_uart *nu);
0462 void nci_uart_unregister(struct nci_uart *nu);
0463 void nci_uart_set_config(struct nci_uart *nu, int baudrate, int flow_ctrl);
0464
0465 #endif /* __NCI_CORE_H */