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
  35 #include <net/nfc/nfc.h>
  36 #include <net/nfc/nci.h>
  37
  38 /* NCI device flags */
  39 enum nci_flag {
  40         NCI_INIT,
  41         NCI_UP,
  42         NCI_DATA_EXCHANGE,
  43         NCI_DATA_EXCHANGE_TO,
  44 };
  45
  46 /* NCI device states */
  47 enum nci_state {
  48         NCI_IDLE,
  49         NCI_DISCOVERY,
  50         NCI_W4_ALL_DISCOVERIES,
  51         NCI_W4_HOST_SELECT,
  52         NCI_POLL_ACTIVE,
  53         NCI_LISTEN_ACTIVE,
  54         NCI_LISTEN_SLEEP,
  55 };
  56
  57 /* NCI timeouts */
  58 #define NCI_RESET_TIMEOUT                       5000
  59 #define NCI_INIT_TIMEOUT                        5000
  60 #define NCI_SET_CONFIG_TIMEOUT                  5000
  61 #define NCI_RF_DISC_TIMEOUT                     5000
  62 #define NCI_RF_DISC_SELECT_TIMEOUT              5000
  63 #define NCI_RF_DEACTIVATE_TIMEOUT               30000
  64 #define NCI_CMD_TIMEOUT                         5000
  65 #define NCI_DATA_TIMEOUT                        700
  66
  67 struct nci_dev;
  68
  69 struct nci_ops {
  70         int   (*open)(struct nci_dev *ndev);
  71         int   (*close)(struct nci_dev *ndev);
  72         int   (*send)(struct nci_dev *ndev, struct sk_buff *skb);
  73         int   (*setup)(struct nci_dev *ndev);
  74         __u32 (*get_rfprotocol)(struct nci_dev *ndev, __u8 rf_protocol);
  75         int   (*discover_se)(struct nci_dev *ndev);
  76         int   (*disable_se)(struct nci_dev *ndev, u32 se_idx);
  77         int   (*enable_se)(struct nci_dev *ndev, u32 se_idx);
  78         int   (*se_io)(struct nci_dev *ndev, u32 se_idx,
  79                                 u8 *apdu, size_t apdu_length,
  80                                 se_io_cb_t cb, void *cb_context);
  81 };
  82
  83 #define NCI_MAX_SUPPORTED_RF_INTERFACES         4
  84 #define NCI_MAX_DISCOVERED_TARGETS              10
  85 #define NCI_MAX_NUM_NFCEE   255
  86 #define NCI_MAX_CONN_ID         7
  87
  88 struct nci_conn_info {
  89         struct list_head list;
  90         __u8    id; /* can be an RF Discovery ID or an NFCEE ID */
  91         __u8    conn_id;
  92         __u8    max_pkt_payload_len;
  93
  94         atomic_t credits_cnt;
  95         __u8     initial_num_credits;
  96
  97         data_exchange_cb_t      data_exchange_cb;
  98         void *data_exchange_cb_context;
  99
 100         struct sk_buff *rx_skb;
 101 };
 102
 103 #define NCI_INVALID_CONN_ID 0x80
 104
 105 /* NCI Core structures */
 106 struct nci_dev {
 107         struct nfc_dev          *nfc_dev;
 108         struct nci_ops          *ops;
 109
 110         int                     tx_headroom;
 111         int                     tx_tailroom;
 112
 113         atomic_t                state;
 114         unsigned long           flags;
 115
 116         atomic_t                cmd_cnt;
 117         __u8                    cur_conn_id;
 118
 119         struct list_head        conn_info_list;
 120
 121         struct timer_list       cmd_timer;
 122         struct timer_list       data_timer;
 123
 124         struct workqueue_struct *cmd_wq;
 125         struct work_struct      cmd_work;
 126
 127         struct workqueue_struct *rx_wq;
 128         struct work_struct      rx_work;
 129
 130         struct workqueue_struct *tx_wq;
 131         struct work_struct      tx_work;
 132
 133         struct sk_buff_head     cmd_q;
 134         struct sk_buff_head     rx_q;
 135         struct sk_buff_head     tx_q;
 136
 137         struct mutex            req_lock;
 138         struct completion       req_completion;
 139         __u32                   req_status;
 140         __u32                   req_result;
 141
 142         void                    *driver_data;
 143
 144         __u32                   poll_prots;
 145         __u32                   target_active_prot;
 146
 147         struct nfc_target       targets[NCI_MAX_DISCOVERED_TARGETS];
 148         int                     n_targets;
 149
 150         /* received during NCI_OP_CORE_RESET_RSP */
 151         __u8                    nci_ver;
 152
 153         /* received during NCI_OP_CORE_INIT_RSP */
 154         __u32                   nfcc_features;
 155         __u8                    num_supported_rf_interfaces;
 156         __u8                    supported_rf_interfaces
 157                                 [NCI_MAX_SUPPORTED_RF_INTERFACES];
 158         __u8                    max_logical_connections;
 159         __u16                   max_routing_table_size;
 160         __u8                    max_ctrl_pkt_payload_len;
 161         __u16                   max_size_for_large_params;
 162         __u8                    manufact_id;
 163         __u32                   manufact_specific_info;
 164
 165         /* Save RF Discovery ID or NFCEE ID under conn_create */
 166         __u8                    cur_id;
 167
 168         /* stored during nci_data_exchange */
 169         struct sk_buff          *rx_data_reassembly;
 170
 171         /* stored during intf_activated_ntf */
 172         __u8 remote_gb[NFC_MAX_GT_LEN];
 173         __u8 remote_gb_len;
 174 };
 175
 176 /* ----- NCI Devices ----- */
 177 struct nci_dev *nci_allocate_device(struct nci_ops *ops,
 178                                     __u32 supported_protocols,
 179                                     int tx_headroom,
 180                                     int tx_tailroom);
 181 void nci_free_device(struct nci_dev *ndev);
 182 int nci_register_device(struct nci_dev *ndev);
 183 void nci_unregister_device(struct nci_dev *ndev);
 184 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
 185 int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val);
 186
 187 int nci_nfcee_discover(struct nci_dev *ndev, u8 action);
 188
 189 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
 190                                             unsigned int len,
 191                                             gfp_t how)
 192 {
 193         struct sk_buff *skb;
 194
 195         skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
 196         if (skb)
 197                 skb_reserve(skb, ndev->tx_headroom);
 198
 199         return skb;
 200 }
 201
 202 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
 203 {
 204         nfc_set_parent_dev(ndev->nfc_dev, dev);
 205 }
 206
 207 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
 208 {
 209         ndev->driver_data = data;
 210 }
 211
 212 static inline void *nci_get_drvdata(struct nci_dev *ndev)
 213 {
 214         return ndev->driver_data;
 215 }
 216
 217 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
 218 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
 219 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
 220 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
 221 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
 222 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
 223                                 __u8 conn_id, int err);
 224 void nci_clear_target_list(struct nci_dev *ndev);
 225
 226 /* ----- NCI requests ----- */
 227 #define NCI_REQ_DONE            0
 228 #define NCI_REQ_PEND            1
 229 #define NCI_REQ_CANCELED        2
 230
 231 void nci_req_complete(struct nci_dev *ndev, int result);
 232 struct nci_conn_info *nci_get_conn_info_by_conn_id(struct nci_dev *ndev,
 233                                                    int conn_id);
 234
 235 /* ----- NCI status code ----- */
 236 int nci_to_errno(__u8 code);
 237
 238 /* ----- NCI over SPI acknowledge modes ----- */
 239 #define NCI_SPI_CRC_DISABLED    0x00
 240 #define NCI_SPI_CRC_ENABLED     0x01
 241
 242 /* ----- NCI SPI structures ----- */
 243 struct nci_spi {
 244         struct nci_dev          *ndev;
 245         struct spi_device       *spi;
 246
 247         unsigned int            xfer_udelay;    /* microseconds delay between
 248                                                   transactions */
 249         u8                      acknowledge_mode;
 250
 251         struct completion       req_completion;
 252         u8                      req_result;
 253 };
 254
 255 /* ----- NCI SPI ----- */
 256 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
 257                                      u8 acknowledge_mode, unsigned int delay,
 258                                      struct nci_dev *ndev);
 259 int nci_spi_send(struct nci_spi *nspi,
 260                  struct completion *write_handshake_completion,
 261                  struct sk_buff *skb);
 262 struct sk_buff *nci_spi_read(struct nci_spi *nspi);
 263
 264 #endif /* __NCI_CORE_H */