include/net/nfc/hci.h

   1 /*
   2  * Copyright (C) 2011  Intel Corporation. All rights reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the
  16  * Free Software Foundation, Inc.,
  17  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  18  */
  19
  20 #ifndef __NET_HCI_H
  21 #define __NET_HCI_H
  22
  23 #include <linux/skbuff.h>
  24
  25 #include <net/nfc/nfc.h>
  26
  27 struct nfc_phy_ops {
  28         int (*write)(void *dev_id, struct sk_buff *skb);
  29         int (*enable)(void *dev_id);
  30         void (*disable)(void *dev_id);
  31 };
  32
  33 struct nfc_hci_dev;
  34
  35 struct nfc_hci_ops {
  36         int (*open) (struct nfc_hci_dev *hdev);
  37         void (*close) (struct nfc_hci_dev *hdev);
  38         int (*hci_ready) (struct nfc_hci_dev *hdev);
  39         /*
  40          * xmit must always send the complete buffer before
  41          * returning. Returned result must be 0 for success
  42          * or negative for failure.
  43          */
  44         int (*xmit) (struct nfc_hci_dev *hdev, struct sk_buff *skb);
  45         int (*start_poll) (struct nfc_hci_dev *hdev,
  46                            u32 im_protocols, u32 tm_protocols);
  47         int (*dep_link_up)(struct nfc_hci_dev *hdev, struct nfc_target *target,
  48                            u8 comm_mode, u8 *gb, size_t gb_len);
  49         int (*dep_link_down)(struct nfc_hci_dev *hdev);
  50         int (*target_from_gate) (struct nfc_hci_dev *hdev, u8 gate,
  51                                  struct nfc_target *target);
  52         int (*complete_target_discovered) (struct nfc_hci_dev *hdev, u8 gate,
  53                                            struct nfc_target *target);
  54         int (*im_transceive) (struct nfc_hci_dev *hdev,
  55                               struct nfc_target *target, struct sk_buff *skb,
  56                               data_exchange_cb_t cb, void *cb_context);
  57         int (*tm_send)(struct nfc_hci_dev *hdev, struct sk_buff *skb);
  58         int (*check_presence)(struct nfc_hci_dev *hdev,
  59                               struct nfc_target *target);
  60         int (*event_received)(struct nfc_hci_dev *hdev, u8 gate, u8 event,
  61                               struct sk_buff *skb);
  62         int (*fw_download)(struct nfc_hci_dev *hdev, const char *firmware_name);
  63         int (*discover_se)(struct nfc_hci_dev *dev);
  64         int (*enable_se)(struct nfc_hci_dev *dev, u32 se_idx);
  65         int (*disable_se)(struct nfc_hci_dev *dev, u32 se_idx);
  66 };
  67
  68 /* Pipes */
  69 #define NFC_HCI_INVALID_PIPE    0x80
  70 #define NFC_HCI_LINK_MGMT_PIPE  0x00
  71 #define NFC_HCI_ADMIN_PIPE      0x01
  72
  73 struct nfc_hci_gate {
  74         u8 gate;
  75         u8 pipe;
  76 };
  77
  78 #define NFC_HCI_MAX_CUSTOM_GATES        50
  79 struct nfc_hci_init_data {
  80         u8 gate_count;
  81         struct nfc_hci_gate gates[NFC_HCI_MAX_CUSTOM_GATES];
  82         char session_id[9];
  83 };
  84
  85 typedef int (*xmit) (struct sk_buff *skb, void *cb_data);
  86
  87 #define NFC_HCI_MAX_GATES               256
  88
  89 /*
  90  * These values can be specified by a driver to indicate it requires some
  91  * adaptation of the HCI standard.
  92  *
  93  * NFC_HCI_QUIRK_SHORT_CLEAR - send HCI_ADM_CLEAR_ALL_PIPE cmd with no params
  94  */
  95 enum {
  96         NFC_HCI_QUIRK_SHORT_CLEAR       = 0,
  97 };
  98
  99 struct nfc_hci_dev {
 100         struct nfc_dev *ndev;
 101
 102         u32 max_data_link_payload;
 103
 104         bool shutting_down;
 105
 106         struct mutex msg_tx_mutex;
 107
 108         struct list_head msg_tx_queue;
 109
 110         struct work_struct msg_tx_work;
 111
 112         struct timer_list cmd_timer;
 113         struct hci_msg *cmd_pending_msg;
 114
 115         struct sk_buff_head rx_hcp_frags;
 116
 117         struct work_struct msg_rx_work;
 118
 119         struct sk_buff_head msg_rx_queue;
 120
 121         struct nfc_hci_ops *ops;
 122
 123         struct nfc_llc *llc;
 124
 125         struct nfc_hci_init_data init_data;
 126
 127         void *clientdata;
 128
 129         u8 gate2pipe[NFC_HCI_MAX_GATES];
 130
 131         u8 sw_romlib;
 132         u8 sw_patch;
 133         u8 sw_flashlib_major;
 134         u8 sw_flashlib_minor;
 135
 136         u8 hw_derivative;
 137         u8 hw_version;
 138         u8 hw_mpw;
 139         u8 hw_software;
 140         u8 hw_bsid;
 141
 142         int async_cb_type;
 143         data_exchange_cb_t async_cb;
 144         void *async_cb_context;
 145
 146         u8 *gb;
 147         size_t gb_len;
 148
 149         unsigned long quirks;
 150 };
 151
 152 /* hci device allocation */
 153 struct nfc_hci_dev *nfc_hci_allocate_device(struct nfc_hci_ops *ops,
 154                                             struct nfc_hci_init_data *init_data,
 155                                             unsigned long quirks,
 156                                             u32 protocols,
 157                                             const char *llc_name,
 158                                             int tx_headroom,
 159                                             int tx_tailroom,
 160                                             int max_link_payload);
 161 void nfc_hci_free_device(struct nfc_hci_dev *hdev);
 162
 163 int nfc_hci_register_device(struct nfc_hci_dev *hdev);
 164 void nfc_hci_unregister_device(struct nfc_hci_dev *hdev);
 165
 166 void nfc_hci_set_clientdata(struct nfc_hci_dev *hdev, void *clientdata);
 167 void *nfc_hci_get_clientdata(struct nfc_hci_dev *hdev);
 168
 169 void nfc_hci_driver_failure(struct nfc_hci_dev *hdev, int err);
 170
 171 int nfc_hci_result_to_errno(u8 result);
 172
 173 /* Host IDs */
 174 #define NFC_HCI_HOST_CONTROLLER_ID      0x00
 175 #define NFC_HCI_TERMINAL_HOST_ID        0x01
 176 #define NFC_HCI_UICC_HOST_ID            0x02
 177
 178 /* Host Controller Gates and registry indexes */
 179 #define NFC_HCI_ADMIN_GATE 0x00
 180 #define NFC_HCI_ADMIN_SESSION_IDENTITY  0x01
 181 #define NFC_HCI_ADMIN_MAX_PIPE          0x02
 182 #define NFC_HCI_ADMIN_WHITELIST         0x03
 183 #define NFC_HCI_ADMIN_HOST_LIST         0x04
 184
 185 #define NFC_HCI_LOOPBACK_GATE           0x04
 186
 187 #define NFC_HCI_ID_MGMT_GATE            0x05
 188 #define NFC_HCI_ID_MGMT_VERSION_SW      0x01
 189 #define NFC_HCI_ID_MGMT_VERSION_HW      0x03
 190 #define NFC_HCI_ID_MGMT_VENDOR_NAME     0x04
 191 #define NFC_HCI_ID_MGMT_MODEL_ID        0x05
 192 #define NFC_HCI_ID_MGMT_HCI_VERSION     0x02
 193 #define NFC_HCI_ID_MGMT_GATES_LIST      0x06
 194
 195 #define NFC_HCI_LINK_MGMT_GATE          0x06
 196 #define NFC_HCI_LINK_MGMT_REC_ERROR     0x01
 197
 198 #define NFC_HCI_RF_READER_B_GATE                        0x11
 199 #define NFC_HCI_RF_READER_B_PUPI                        0x03
 200 #define NFC_HCI_RF_READER_B_APPLICATION_DATA            0x04
 201 #define NFC_HCI_RF_READER_B_AFI                         0x02
 202 #define NFC_HCI_RF_READER_B_HIGHER_LAYER_RESPONSE       0x01
 203 #define NFC_HCI_RF_READER_B_HIGHER_LAYER_DATA           0x05
 204
 205 #define NFC_HCI_RF_READER_A_GATE                0x13
 206 #define NFC_HCI_RF_READER_A_UID                 0x02
 207 #define NFC_HCI_RF_READER_A_ATQA                0x04
 208 #define NFC_HCI_RF_READER_A_APPLICATION_DATA    0x05
 209 #define NFC_HCI_RF_READER_A_SAK                 0x03
 210 #define NFC_HCI_RF_READER_A_FWI_SFGT            0x06
 211 #define NFC_HCI_RF_READER_A_DATARATE_MAX        0x01
 212
 213 #define NFC_HCI_TYPE_A_SEL_PROT(x)              (((x) & 0x60) >> 5)
 214 #define NFC_HCI_TYPE_A_SEL_PROT_MIFARE          0
 215 #define NFC_HCI_TYPE_A_SEL_PROT_ISO14443        1
 216 #define NFC_HCI_TYPE_A_SEL_PROT_DEP             2
 217 #define NFC_HCI_TYPE_A_SEL_PROT_ISO14443_DEP    3
 218
 219 /* Generic events */
 220 #define NFC_HCI_EVT_HCI_END_OF_OPERATION        0x01
 221 #define NFC_HCI_EVT_POST_DATA                   0x02
 222 #define NFC_HCI_EVT_HOT_PLUG                    0x03
 223
 224 /* Reader RF gates events */
 225 #define NFC_HCI_EVT_READER_REQUESTED    0x10
 226 #define NFC_HCI_EVT_END_OPERATION       0x11
 227
 228 /* Reader Application gate events */
 229 #define NFC_HCI_EVT_TARGET_DISCOVERED   0x10
 230
 231 /* receiving messages from lower layer */
 232 void nfc_hci_resp_received(struct nfc_hci_dev *hdev, u8 result,
 233                            struct sk_buff *skb);
 234 void nfc_hci_cmd_received(struct nfc_hci_dev *hdev, u8 pipe, u8 cmd,
 235                           struct sk_buff *skb);
 236 void nfc_hci_event_received(struct nfc_hci_dev *hdev, u8 pipe, u8 event,
 237                             struct sk_buff *skb);
 238 void nfc_hci_recv_frame(struct nfc_hci_dev *hdev, struct sk_buff *skb);
 239
 240 /* connecting to gates and sending hci instructions */
 241 int nfc_hci_connect_gate(struct nfc_hci_dev *hdev, u8 dest_host, u8 dest_gate,
 242                          u8 pipe);
 243 int nfc_hci_disconnect_gate(struct nfc_hci_dev *hdev, u8 gate);
 244 int nfc_hci_disconnect_all_gates(struct nfc_hci_dev *hdev);
 245 int nfc_hci_get_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx,
 246                       struct sk_buff **skb);
 247 int nfc_hci_set_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx,
 248                       const u8 *param, size_t param_len);
 249 int nfc_hci_send_cmd(struct nfc_hci_dev *hdev, u8 gate, u8 cmd,
 250                      const u8 *param, size_t param_len, struct sk_buff **skb);
 251 int nfc_hci_send_cmd_async(struct nfc_hci_dev *hdev, u8 gate, u8 cmd,
 252                            const u8 *param, size_t param_len,
 253                            data_exchange_cb_t cb, void *cb_context);
 254 int nfc_hci_send_response(struct nfc_hci_dev *hdev, u8 gate, u8 response,
 255                           const u8 *param, size_t param_len);
 256 int nfc_hci_send_event(struct nfc_hci_dev *hdev, u8 gate, u8 event,
 257                        const u8 *param, size_t param_len);
 258 int nfc_hci_target_discovered(struct nfc_hci_dev *hdev, u8 gate);
 259 u32 nfc_hci_sak_to_protocol(u8 sak);
 260
 261 #endif /* __NET_HCI_H */