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  *
   7  *  Written by Ilan Elias <ilane@ti.com>
   8  *
   9  *  Acknowledgements:
  10  *  This file is based on hci_core.h, which was written
  11  *  by Maxim Krasnyansky.
  12  *
  13  *  This program is free software; you can redistribute it and/or modify
  14  *  it under the terms of the GNU General Public License version 2
  15  *  as published by the Free Software Foundation
  16  *
  17  *  This program is distributed in the hope that it will be useful,
  18  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  *  GNU General Public License for more details.
  21  *
  22  *  You should have received a copy of the GNU General Public License
  23  *  along with this program; if not, write to the Free Software
  24  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  25  *
  26  */
  27
  28 #ifndef __NCI_CORE_H
  29 #define __NCI_CORE_H
  30
  31 #include <linux/interrupt.h>
  32 #include <linux/skbuff.h>
  33
  34 #include <net/nfc/nfc.h>
  35 #include <net/nfc/nci.h>
  36
  37 /* NCI device flags */
  38 enum nci_flag {
  39         NCI_INIT,
  40         NCI_UP,
  41         NCI_DATA_EXCHANGE,
  42         NCI_DATA_EXCHANGE_TO,
  43 };
  44
  45 /* NCI device states */
  46 enum nci_state {
  47         NCI_IDLE,
  48         NCI_DISCOVERY,
  49         NCI_POLL_ACTIVE,
  50 };
  51
  52 /* NCI timeouts */
  53 #define NCI_RESET_TIMEOUT                       5000
  54 #define NCI_INIT_TIMEOUT                        5000
  55 #define NCI_RF_DISC_TIMEOUT                     5000
  56 #define NCI_RF_DEACTIVATE_TIMEOUT               30000
  57 #define NCI_CMD_TIMEOUT                         5000
  58 #define NCI_DATA_TIMEOUT                        700
  59
  60 struct nci_dev;
  61
  62 struct nci_ops {
  63         int (*open)(struct nci_dev *ndev);
  64         int (*close)(struct nci_dev *ndev);
  65         int (*send)(struct sk_buff *skb);
  66 };
  67
  68 #define NCI_MAX_SUPPORTED_RF_INTERFACES         4
  69
  70 /* NCI Core structures */
  71 struct nci_dev {
  72         struct nfc_dev          *nfc_dev;
  73         struct nci_ops          *ops;
  74
  75         int                     tx_headroom;
  76         int                     tx_tailroom;
  77
  78         atomic_t                state;
  79         unsigned long           flags;
  80
  81         atomic_t                cmd_cnt;
  82         atomic_t                credits_cnt;
  83
  84         struct timer_list       cmd_timer;
  85         struct timer_list       data_timer;
  86
  87         struct workqueue_struct *cmd_wq;
  88         struct work_struct      cmd_work;
  89
  90         struct workqueue_struct *rx_wq;
  91         struct work_struct      rx_work;
  92
  93         struct workqueue_struct *tx_wq;
  94         struct work_struct      tx_work;
  95
  96         struct sk_buff_head     cmd_q;
  97         struct sk_buff_head     rx_q;
  98         struct sk_buff_head     tx_q;
  99
 100         struct mutex            req_lock;
 101         struct completion       req_completion;
 102         __u32                   req_status;
 103         __u32                   req_result;
 104
 105         void                    *driver_data;
 106
 107         __u32                   poll_prots;
 108         __u32                   target_available_prots;
 109         __u32                   target_active_prot;
 110
 111         /* received during NCI_OP_CORE_RESET_RSP */
 112         __u8                    nci_ver;
 113
 114         /* received during NCI_OP_CORE_INIT_RSP */
 115         __u32                   nfcc_features;
 116         __u8                    num_supported_rf_interfaces;
 117         __u8                    supported_rf_interfaces
 118                                 [NCI_MAX_SUPPORTED_RF_INTERFACES];
 119         __u8                    max_logical_connections;
 120         __u16                   max_routing_table_size;
 121         __u8                    max_ctrl_pkt_payload_len;
 122         __u16                   max_size_for_large_params;
 123         __u8                    manufact_id;
 124         __u32                   manufact_specific_info;
 125
 126         /* received during NCI_OP_RF_INTF_ACTIVATED_NTF */
 127         __u8                    max_data_pkt_payload_size;
 128         __u8                    initial_num_credits;
 129
 130         /* stored during nci_data_exchange */
 131         data_exchange_cb_t      data_exchange_cb;
 132         void                    *data_exchange_cb_context;
 133         struct sk_buff          *rx_data_reassembly;
 134 };
 135
 136 /* ----- NCI Devices ----- */
 137 struct nci_dev *nci_allocate_device(struct nci_ops *ops,
 138                                 __u32 supported_protocols,
 139                                 int tx_headroom,
 140                                 int tx_tailroom);
 141 void nci_free_device(struct nci_dev *ndev);
 142 int nci_register_device(struct nci_dev *ndev);
 143 void nci_unregister_device(struct nci_dev *ndev);
 144 int nci_recv_frame(struct sk_buff *skb);
 145
 146 static inline struct sk_buff *nci_skb_alloc(struct nci_dev *ndev,
 147                                                 unsigned int len,
 148                                                 gfp_t how)
 149 {
 150         struct sk_buff *skb;
 151
 152         skb = alloc_skb(len + ndev->tx_headroom + ndev->tx_tailroom, how);
 153         if (skb)
 154                 skb_reserve(skb, ndev->tx_headroom);
 155
 156         return skb;
 157 }
 158
 159 static inline void nci_set_parent_dev(struct nci_dev *ndev, struct device *dev)
 160 {
 161         nfc_set_parent_dev(ndev->nfc_dev, dev);
 162 }
 163
 164 static inline void nci_set_drvdata(struct nci_dev *ndev, void *data)
 165 {
 166         ndev->driver_data = data;
 167 }
 168
 169 static inline void *nci_get_drvdata(struct nci_dev *ndev)
 170 {
 171         return ndev->driver_data;
 172 }
 173
 174 void nci_rsp_packet(struct nci_dev *ndev, struct sk_buff *skb);
 175 void nci_ntf_packet(struct nci_dev *ndev, struct sk_buff *skb);
 176 void nci_rx_data_packet(struct nci_dev *ndev, struct sk_buff *skb);
 177 int nci_send_cmd(struct nci_dev *ndev, __u16 opcode, __u8 plen, void *payload);
 178 int nci_send_data(struct nci_dev *ndev, __u8 conn_id, struct sk_buff *skb);
 179 void nci_data_exchange_complete(struct nci_dev *ndev, struct sk_buff *skb,
 180                                 int err);
 181
 182 /* ----- NCI requests ----- */
 183 #define NCI_REQ_DONE            0
 184 #define NCI_REQ_PEND            1
 185 #define NCI_REQ_CANCELED        2
 186
 187 void nci_req_complete(struct nci_dev *ndev, int result);
 188
 189 /* ----- NCI status code ----- */
 190 int nci_to_errno(__u8 code);
 191
 192 #endif /* __NCI_CORE_H */