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         int (*xmit) (struct nfc_hci_dev *hdev, struct sk_buff *skb);
  34         int (*start_poll) (struct nfc_hci_dev *hdev,
  35                            u32 im_protocols, u32 tm_protocols);
  36         int (*target_from_gate) (struct nfc_hci_dev *hdev, u8 gate,
  37                                  struct nfc_target *target);
  38         int (*complete_target_discovered) (struct nfc_hci_dev *hdev, u8 gate,
  39                                            struct nfc_target *target);
  40         int (*data_exchange) (struct nfc_hci_dev *hdev,
  41                               struct nfc_target *target,
  42                               struct sk_buff *skb, struct sk_buff **res_skb);
  43         int (*check_presence)(struct nfc_hci_dev *hdev,
  44                               struct nfc_target *target);
  45 };
  46
  47 #define NFC_HCI_MAX_CUSTOM_GATES        15
  48 struct nfc_hci_init_data {
  49         u8 gate_count;
  50         u8 gates[NFC_HCI_MAX_CUSTOM_GATES];
  51         char session_id[9];
  52 };
  53
  54 typedef int (*xmit) (struct sk_buff *skb, void *cb_data);
  55
  56 #define NFC_HCI_MAX_GATES               256
  57
  58 struct nfc_hci_dev {
  59         struct nfc_dev *ndev;
  60
  61         u32 max_data_link_payload;
  62
  63         struct mutex msg_tx_mutex;
  64
  65         struct list_head msg_tx_queue;
  66
  67         struct workqueue_struct *msg_tx_wq;
  68         struct work_struct msg_tx_work;
  69
  70         struct timer_list cmd_timer;
  71         struct hci_msg *cmd_pending_msg;
  72
  73         struct sk_buff_head rx_hcp_frags;
  74
  75         struct workqueue_struct *msg_rx_wq;
  76         struct work_struct msg_rx_work;
  77
  78         struct sk_buff_head msg_rx_queue;
  79
  80         struct nfc_hci_ops *ops;
  81
  82         struct nfc_hci_init_data init_data;
  83
  84         void *clientdata;
  85
  86         u8 gate2pipe[NFC_HCI_MAX_GATES];
  87
  88         u8 sw_romlib;
  89         u8 sw_patch;
  90         u8 sw_flashlib_major;
  91         u8 sw_flashlib_minor;
  92
  93         u8 hw_derivative;
  94         u8 hw_version;
  95         u8 hw_mpw;
  96         u8 hw_software;
  97         u8 hw_bsid;
  98 };
  99
 100 /* hci device allocation */
 101 struct nfc_hci_dev *nfc_hci_allocate_device(struct nfc_hci_ops *ops,
 102                                             struct nfc_hci_init_data *init_data,
 103                                             u32 protocols,
 104                                             int tx_headroom,
 105                                             int tx_tailroom,
 106                                             int max_link_payload);
 107 void nfc_hci_free_device(struct nfc_hci_dev *hdev);
 108
 109 int nfc_hci_register_device(struct nfc_hci_dev *hdev);
 110 void nfc_hci_unregister_device(struct nfc_hci_dev *hdev);
 111
 112 void nfc_hci_set_clientdata(struct nfc_hci_dev *hdev, void *clientdata);
 113 void *nfc_hci_get_clientdata(struct nfc_hci_dev *hdev);
 114
 115 /* Host IDs */
 116 #define NFC_HCI_HOST_CONTROLLER_ID      0x00
 117 #define NFC_HCI_TERMINAL_HOST_ID        0x01
 118 #define NFC_HCI_UICC_HOST_ID            0x02
 119
 120 /* Host Controller Gates and registry indexes */
 121 #define NFC_HCI_ADMIN_GATE 0x00
 122 #define NFC_HCI_ADMIN_SESSION_IDENTITY  0x01
 123 #define NFC_HCI_ADMIN_MAX_PIPE          0x02
 124 #define NFC_HCI_ADMIN_WHITELIST         0x03
 125 #define NFC_HCI_ADMIN_HOST_LIST         0x04
 126
 127 #define NFC_HCI_LOOPBACK_GATE           0x04
 128
 129 #define NFC_HCI_ID_MGMT_GATE            0x05
 130 #define NFC_HCI_ID_MGMT_VERSION_SW      0x01
 131 #define NFC_HCI_ID_MGMT_VERSION_HW      0x03
 132 #define NFC_HCI_ID_MGMT_VENDOR_NAME     0x04
 133 #define NFC_HCI_ID_MGMT_MODEL_ID        0x05
 134 #define NFC_HCI_ID_MGMT_HCI_VERSION     0x02
 135 #define NFC_HCI_ID_MGMT_GATES_LIST      0x06
 136
 137 #define NFC_HCI_LINK_MGMT_GATE          0x06
 138 #define NFC_HCI_LINK_MGMT_REC_ERROR     0x01
 139
 140 #define NFC_HCI_RF_READER_B_GATE                        0x11
 141 #define NFC_HCI_RF_READER_B_PUPI                        0x03
 142 #define NFC_HCI_RF_READER_B_APPLICATION_DATA            0x04
 143 #define NFC_HCI_RF_READER_B_AFI                         0x02
 144 #define NFC_HCI_RF_READER_B_HIGHER_LAYER_RESPONSE       0x01
 145 #define NFC_HCI_RF_READER_B_HIGHER_LAYER_DATA           0x05
 146
 147 #define NFC_HCI_RF_READER_A_GATE                0x13
 148 #define NFC_HCI_RF_READER_A_UID                 0x02
 149 #define NFC_HCI_RF_READER_A_ATQA                0x04
 150 #define NFC_HCI_RF_READER_A_APPLICATION_DATA    0x05
 151 #define NFC_HCI_RF_READER_A_SAK                 0x03
 152 #define NFC_HCI_RF_READER_A_FWI_SFGT            0x06
 153 #define NFC_HCI_RF_READER_A_DATARATE_MAX        0x01
 154
 155 #define NFC_HCI_TYPE_A_SEL_PROT(x)              (((x) & 0x60) >> 5)
 156 #define NFC_HCI_TYPE_A_SEL_PROT_MIFARE          0
 157 #define NFC_HCI_TYPE_A_SEL_PROT_ISO14443        1
 158 #define NFC_HCI_TYPE_A_SEL_PROT_DEP             2
 159 #define NFC_HCI_TYPE_A_SEL_PROT_ISO14443_DEP    3
 160
 161 /* Generic events */
 162 #define NFC_HCI_EVT_HCI_END_OF_OPERATION        0x01
 163 #define NFC_HCI_EVT_POST_DATA                   0x02
 164 #define NFC_HCI_EVT_HOT_PLUG                    0x03
 165
 166 /* Reader RF gates events */
 167 #define NFC_HCI_EVT_READER_REQUESTED    0x10
 168 #define NFC_HCI_EVT_END_OPERATION       0x11
 169
 170 /* Reader Application gate events */
 171 #define NFC_HCI_EVT_TARGET_DISCOVERED   0x10
 172
 173 /* receiving messages from lower layer */
 174 void nfc_hci_resp_received(struct nfc_hci_dev *hdev, u8 result,
 175                            struct sk_buff *skb);
 176 void nfc_hci_cmd_received(struct nfc_hci_dev *hdev, u8 pipe, u8 cmd,
 177                           struct sk_buff *skb);
 178 void nfc_hci_event_received(struct nfc_hci_dev *hdev, u8 pipe, u8 event,
 179                             struct sk_buff *skb);
 180 void nfc_hci_recv_frame(struct nfc_hci_dev *hdev, struct sk_buff *skb);
 181
 182 /* connecting to gates and sending hci instructions */
 183 int nfc_hci_connect_gate(struct nfc_hci_dev *hdev, u8 dest_host, u8 dest_gate);
 184 int nfc_hci_disconnect_gate(struct nfc_hci_dev *hdev, u8 gate);
 185 int nfc_hci_disconnect_all_gates(struct nfc_hci_dev *hdev);
 186 int nfc_hci_get_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx,
 187                       struct sk_buff **skb);
 188 int nfc_hci_set_param(struct nfc_hci_dev *hdev, u8 gate, u8 idx,
 189                       const u8 *param, size_t param_len);
 190 int nfc_hci_send_cmd(struct nfc_hci_dev *hdev, u8 gate, u8 cmd,
 191                      const u8 *param, size_t param_len, struct sk_buff **skb);
 192 int nfc_hci_send_response(struct nfc_hci_dev *hdev, u8 gate, u8 response,
 193                           const u8 *param, size_t param_len);
 194 int nfc_hci_send_event(struct nfc_hci_dev *hdev, u8 gate, u8 event,
 195                        const u8 *param, size_t param_len);
 196
 197 #endif /* __NET_HCI_H */