~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

TOMOYO Linux Cross Reference
Linux/include/net/nfc/hci.h

Version: ~ [ linux-5.8 ] ~ [ linux-5.7.12 ] ~ [ linux-5.6.19 ] ~ [ linux-5.5.19 ] ~ [ linux-5.4.55 ] ~ [ linux-5.3.18 ] ~ [ linux-5.2.21 ] ~ [ linux-5.1.21 ] ~ [ linux-5.0.21 ] ~ [ linux-4.20.17 ] ~ [ linux-4.19.136 ] ~ [ linux-4.18.20 ] ~ [ linux-4.17.19 ] ~ [ linux-4.16.18 ] ~ [ linux-4.15.18 ] ~ [ linux-4.14.191 ] ~ [ linux-4.13.16 ] ~ [ linux-4.12.14 ] ~ [ linux-4.11.12 ] ~ [ linux-4.10.17 ] ~ [ linux-4.9.232 ] ~ [ linux-4.8.17 ] ~ [ linux-4.7.10 ] ~ [ linux-4.6.7 ] ~ [ linux-4.5.7 ] ~ [ linux-4.4.232 ] ~ [ linux-4.3.6 ] ~ [ linux-4.2.8 ] ~ [ linux-4.1.52 ] ~ [ linux-4.0.9 ] ~ [ linux-3.19.8 ] ~ [ linux-3.18.140 ] ~ [ linux-3.17.8 ] ~ [ linux-3.16.85 ] ~ [ linux-3.15.10 ] ~ [ linux-3.14.79 ] ~ [ linux-3.13.11 ] ~ [ linux-3.12.74 ] ~ [ linux-3.11.10 ] ~ [ linux-3.10.108 ] ~ [ linux-2.6.32.71 ] ~ [ linux-2.6.0 ] ~ [ linux-2.4.37.11 ] ~ [ unix-v6-master ] ~ [ ccs-tools-1.8.5 ] ~ [ policy-sample ] ~
Architecture: ~ [ i386 ] ~ [ alpha ] ~ [ m68k ] ~ [ mips ] ~ [ ppc ] ~ [ sparc ] ~ [ sparc64 ] ~

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

~ [ source navigation ] ~ [ diff markup ] ~ [ identifier search ] ~

kernel.org | git.kernel.org | LWN.net | Project Home | Wiki (Japanese) | Wiki (English) | SVN repository | Mail admin

Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.

osdn.jp