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
  86 /* NCI Core structures */
  87 struct nci_dev {
  88         struct nfc_dev          *nfc_dev;
  89         struct nci_ops          *ops;
  90
  91         int                     tx_headroom;
  92         int                     tx_tailroom;
  93
  94         atomic_t                state;
  95         unsigned long           flags;
  96
  97         atomic_t                cmd_cnt;
  98         atomic_t                credits_cnt;
  99
 100         struct timer_list       cmd_timer;
 101         struct timer_list       data_timer;
 102
 103         struct workqueue_struct *cmd_wq;
 104         struct work_struct      cmd_work;
 105
 106         struct workqueue_struct *rx_wq;
 107         struct work_struct      rx_work;
 108
 109         struct workqueue_struct *tx_wq;
 110         struct work_struct      tx_work;
 111
 112         struct sk_buff_head     cmd_q;
 113         struct sk_buff_head     rx_q;
 114         struct sk_buff_head     tx_q;
 115
 116         struct mutex            req_lock;
 117         struct completion       req_completion;
 118         __u32                   req_status;
 119         __u32                   req_result;
 120
 121         void                    *driver_data;
 122
 123         __u32                   poll_prots;
 124         __u32                   target_active_prot;
 125
 126         struct nfc_target       targets[NCI_MAX_DISCOVERED_TARGETS];
 127         int                     n_targets;
 128
 129         /* received during NCI_OP_CORE_RESET_RSP */
 130         __u8                    nci_ver;
 131
 132         /* received during NCI_OP_CORE_INIT_RSP */
 133         __u32                   nfcc_features;
 134         __u8                    num_supported_rf_interfaces;
 135         __u8                    supported_rf_interfaces
 136                                 [NCI_MAX_SUPPORTED_RF_INTERFACES];
 137         __u8                    max_logical_connections;
 138         __u16                   max_routing_table_size;
 139         __u8                    max_ctrl_pkt_payload_len;
 140         __u16                   max_size_for_large_params;
 141         __u8                    manufact_id;
 142         __u32                   manufact_specific_info;
 143
 144         /* received during NCI_OP_RF_INTF_ACTIVATED_NTF */
 145         __u8                    max_data_pkt_payload_size;
 146         __u8                    initial_num_credits;
 147
 148         /* stored during nci_data_exchange */
 149         data_exchange_cb_t      data_exchange_cb;
 150         void                    *data_exchange_cb_context;
 151         struct sk_buff          *rx_data_reassembly;
 152
 153         /* stored during intf_activated_ntf */
 154         __u8 remote_gb[NFC_MAX_GT_LEN];
 155         __u8 remote_gb_len;
 156 };
 157
 158 /* ----- NCI Devices ----- */
 159 struct nci_dev *nci_allocate_device(struct nci_ops *ops,
 160                                     __u32 supported_protocols,
 161                                     int tx_headroom,
 162                                     int tx_tailroom);
 163 void nci_free_device(struct nci_dev *ndev);
 164 int nci_register_device(struct nci_dev *ndev);
 165 void nci_unregister_device(struct nci_dev *ndev);
 166 int nci_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
 167 int nci_set_config(struct nci_dev *ndev, __u8 id, size_t len, __u8 *val);
 168
 169 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
 170                                             unsigned int len,
 171                                             gfp_t how)
 172 {
 173         struct sk_buff *skb;
 174
 175         skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
 176         if (skb)
 177                 skb_reserve(skb, ndev->tx_headroom);
 178
 179         return skb;
 180 }
 181
 182 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
 183 {
 184         nfc_set_parent_dev(ndev->nfc_dev, dev);
 185 }
 186
 187 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
 188 {
 189         ndev->driver_data = data;
 190 }
 191
 192 static inline void *nci_get_drvdata(struct nci_dev *ndev)
 193 {
 194         return ndev->driver_data;
 195 }
 196
 197 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
 198 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
 199 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
 200 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
 201 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
 202 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
 203                                 int err);
 204 void nci_clear_target_list(struct nci_dev *ndev);
 205
 206 /* ----- NCI requests ----- */
 207 #define NCI_REQ_DONE            0
 208 #define NCI_REQ_PEND            1
 209 #define NCI_REQ_CANCELED        2
 210
 211 void nci_req_complete(struct nci_dev *ndev, int result);
 212
 213 /* ----- NCI status code ----- */
 214 int nci_to_errno(__u8 code);
 215
 216 /* ----- NCI over SPI acknowledge modes ----- */
 217 #define NCI_SPI_CRC_DISABLED    0x00
 218 #define NCI_SPI_CRC_ENABLED     0x01
 219
 220 /* ----- NCI SPI structures ----- */
 221 struct nci_spi {
 222         struct nci_dev          *ndev;
 223         struct spi_device       *spi;
 224
 225         unsigned int            xfer_udelay;    /* microseconds delay between
 226                                                   transactions */
 227         u8                      acknowledge_mode;
 228
 229         struct completion       req_completion;
 230         u8                      req_result;
 231 };
 232
 233 /* ----- NCI SPI ----- */
 234 struct nci_spi *nci_spi_allocate_spi(struct spi_device *spi,
 235                                      u8 acknowledge_mode, unsigned int delay,
 236                                      struct nci_dev *ndev);
 237 int nci_spi_send(struct nci_spi *nspi,
 238                  struct completion *write_handshake_completion,
 239                  struct sk_buff *skb);
 240 struct sk_buff *nci_spi_read(struct nci_spi *nspi);
 241
 242 #endif /* __NCI_CORE_H */