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