2 * Texas Instrument's NFC Driver For Shared Transport.
4 * NFC Driver acts as interface between NCI core and
5 * TI Shared Transport Layer.
7 * Copyright (C) 2011 Texas Instruments, Inc.
9 * Written by Ilan Elias <ilane@ti.com>
12 * This file is based on btwilink.c, which was written
13 * by Raja Mani and Pavan Savoy.
15 * This program is free software; you can redistribute it and/or modify
16 * it under the terms of the GNU General Public License version 2 as
17 * published by the Free Software Foundation.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 #include <linux/platform_device.h>
30 #include <linux/module.h>
31 #include <linux/types.h>
32 #include <linux/firmware.h>
33 #include <linux/nfc.h>
34 #include <net/nfc/nci.h>
35 #include <net/nfc/nci_core.h>
36 #include <linux/ti_wilink_st.h>
38 #define NFCWILINK_CHNL 12
39 #define NFCWILINK_OPCODE 7
40 #define NFCWILINK_MAX_FRAME_SIZE 300
41 #define NFCWILINK_HDR_LEN 4
42 #define NFCWILINK_OFFSET_LEN_IN_HDR 1
43 #define NFCWILINK_LEN_SIZE 2
44 #define NFCWILINK_REGISTER_TIMEOUT 8000 /* 8 sec */
45 #define NFCWILINK_CMD_TIMEOUT 5000 /* 5 sec */
47 #define BTS_FILE_NAME_MAX_SIZE 40
48 #define BTS_FILE_HDR_MAGIC 0x42535442
49 #define BTS_FILE_CMD_MAX_LEN 0xff
50 #define BTS_FILE_ACTION_TYPE_SEND_CMD 1
52 #define NCI_VS_NFCC_INFO_CMD_GID 0x2f
53 #define NCI_VS_NFCC_INFO_CMD_OID 0x12
54 #define NCI_VS_NFCC_INFO_RSP_GID 0x4f
55 #define NCI_VS_NFCC_INFO_RSP_OID 0x12
57 struct nfcwilink_hdr
{
63 struct nci_vs_nfcc_info_cmd
{
69 struct nci_vs_nfcc_info_rsp
{
87 struct bts_file_action
{
94 struct platform_device
*pdev
;
98 char st_register_cb_status
;
99 long (*st_write
) (struct sk_buff
*);
101 struct completion completed
;
103 struct nci_vs_nfcc_info_rsp nfcc_info
;
106 /* NFCWILINK driver flags */
109 NFCWILINK_FW_DOWNLOAD
,
112 static int nfcwilink_send(struct nci_dev
*ndev
, struct sk_buff
*skb
);
114 static inline struct sk_buff
*nfcwilink_skb_alloc(unsigned int len
, gfp_t how
)
118 skb
= alloc_skb(len
+ NFCWILINK_HDR_LEN
, how
);
120 skb_reserve(skb
, NFCWILINK_HDR_LEN
);
125 static void nfcwilink_fw_download_receive(struct nfcwilink
*drv
,
128 struct nci_vs_nfcc_info_rsp
*rsp
= (void *)skb
->data
;
130 /* Detect NCI_VS_NFCC_INFO_RSP and store the result */
131 if ((skb
->len
> 3) && (rsp
->gid
== NCI_VS_NFCC_INFO_RSP_GID
) &&
132 (rsp
->oid
== NCI_VS_NFCC_INFO_RSP_OID
)) {
133 memcpy(&drv
->nfcc_info
, rsp
,
134 sizeof(struct nci_vs_nfcc_info_rsp
));
139 complete(&drv
->completed
);
142 static int nfcwilink_get_bts_file_name(struct nfcwilink
*drv
, char *file_name
)
144 struct nci_vs_nfcc_info_cmd
*cmd
;
146 unsigned long comp_ret
;
149 skb
= nfcwilink_skb_alloc(sizeof(struct nci_vs_nfcc_info_cmd
),
152 nfc_err(&drv
->pdev
->dev
,
153 "no memory for nci_vs_nfcc_info_cmd\n");
157 cmd
= (struct nci_vs_nfcc_info_cmd
*)
158 skb_put(skb
, sizeof(struct nci_vs_nfcc_info_cmd
));
159 cmd
->gid
= NCI_VS_NFCC_INFO_CMD_GID
;
160 cmd
->oid
= NCI_VS_NFCC_INFO_CMD_OID
;
163 drv
->nfcc_info
.plen
= 0;
165 rc
= nfcwilink_send(drv
->ndev
, skb
);
169 comp_ret
= wait_for_completion_timeout(&drv
->completed
,
170 msecs_to_jiffies(NFCWILINK_CMD_TIMEOUT
));
171 dev_dbg(&drv
->pdev
->dev
, "wait_for_completion_timeout returned %ld\n",
174 nfc_err(&drv
->pdev
->dev
,
175 "timeout on wait_for_completion_timeout\n");
179 dev_dbg(&drv
->pdev
->dev
, "nci_vs_nfcc_info_rsp: plen %d, status %d\n",
180 drv
->nfcc_info
.plen
, drv
->nfcc_info
.status
);
182 if ((drv
->nfcc_info
.plen
!= 5) || (drv
->nfcc_info
.status
!= 0)) {
183 nfc_err(&drv
->pdev
->dev
, "invalid nci_vs_nfcc_info_rsp\n");
187 snprintf(file_name
, BTS_FILE_NAME_MAX_SIZE
,
188 "TINfcInit_%d.%d.%d.%d.bts",
189 drv
->nfcc_info
.hw_id
,
190 drv
->nfcc_info
.sw_ver_x
,
191 drv
->nfcc_info
.sw_ver_z
,
192 drv
->nfcc_info
.patch_id
);
194 nfc_info(&drv
->pdev
->dev
, "nfcwilink FW file name: %s\n", file_name
);
199 static int nfcwilink_send_bts_cmd(struct nfcwilink
*drv
, __u8
*data
, int len
)
201 struct nfcwilink_hdr
*hdr
= (struct nfcwilink_hdr
*)data
;
203 unsigned long comp_ret
;
206 /* verify valid cmd for the NFC channel */
207 if ((len
<= sizeof(struct nfcwilink_hdr
)) ||
208 (len
> BTS_FILE_CMD_MAX_LEN
) ||
209 (hdr
->chnl
!= NFCWILINK_CHNL
) ||
210 (hdr
->opcode
!= NFCWILINK_OPCODE
)) {
211 nfc_err(&drv
->pdev
->dev
,
212 "ignoring invalid bts cmd, len %d, chnl %d, opcode %d\n",
213 len
, hdr
->chnl
, hdr
->opcode
);
217 /* remove the ST header */
218 len
-= sizeof(struct nfcwilink_hdr
);
219 data
+= sizeof(struct nfcwilink_hdr
);
221 skb
= nfcwilink_skb_alloc(len
, GFP_KERNEL
);
223 nfc_err(&drv
->pdev
->dev
, "no memory for bts cmd\n");
227 memcpy(skb_put(skb
, len
), data
, len
);
229 rc
= nfcwilink_send(drv
->ndev
, skb
);
233 comp_ret
= wait_for_completion_timeout(&drv
->completed
,
234 msecs_to_jiffies(NFCWILINK_CMD_TIMEOUT
));
235 dev_dbg(&drv
->pdev
->dev
, "wait_for_completion_timeout returned %ld\n",
238 nfc_err(&drv
->pdev
->dev
,
239 "timeout on wait_for_completion_timeout\n");
246 static int nfcwilink_download_fw(struct nfcwilink
*drv
)
248 unsigned char file_name
[BTS_FILE_NAME_MAX_SIZE
];
249 const struct firmware
*fw
;
250 __u16 action_type
, action_len
;
254 set_bit(NFCWILINK_FW_DOWNLOAD
, &drv
->flags
);
256 rc
= nfcwilink_get_bts_file_name(drv
, file_name
);
260 rc
= request_firmware(&fw
, file_name
, &drv
->pdev
->dev
);
262 nfc_err(&drv
->pdev
->dev
, "request_firmware failed %d\n", rc
);
264 /* if the file is not found, don't exit with failure */
272 ptr
= (__u8
*)fw
->data
;
274 if ((len
== 0) || (ptr
== NULL
)) {
275 dev_dbg(&drv
->pdev
->dev
,
276 "request_firmware returned size %d\n", len
);
280 if (__le32_to_cpu(((struct bts_file_hdr
*)ptr
)->magic
) !=
281 BTS_FILE_HDR_MAGIC
) {
282 nfc_err(&drv
->pdev
->dev
, "wrong bts magic number\n");
287 /* remove the BTS header */
288 len
-= sizeof(struct bts_file_hdr
);
289 ptr
+= sizeof(struct bts_file_hdr
);
293 __le16_to_cpu(((struct bts_file_action
*)ptr
)->type
);
295 __le16_to_cpu(((struct bts_file_action
*)ptr
)->len
);
297 dev_dbg(&drv
->pdev
->dev
, "bts_file_action type %d, len %d\n",
298 action_type
, action_len
);
300 switch (action_type
) {
301 case BTS_FILE_ACTION_TYPE_SEND_CMD
:
302 rc
= nfcwilink_send_bts_cmd(drv
,
303 ((struct bts_file_action
*)ptr
)->data
,
310 /* advance to the next action */
311 len
-= (sizeof(struct bts_file_action
) + action_len
);
312 ptr
+= (sizeof(struct bts_file_action
) + action_len
);
316 release_firmware(fw
);
319 clear_bit(NFCWILINK_FW_DOWNLOAD
, &drv
->flags
);
323 /* Called by ST when registration is complete */
324 static void nfcwilink_register_complete(void *priv_data
, char data
)
326 struct nfcwilink
*drv
= priv_data
;
328 /* store ST registration status */
329 drv
->st_register_cb_status
= data
;
331 /* complete the wait in nfc_st_open() */
332 complete(&drv
->completed
);
335 /* Called by ST when receive data is available */
336 static long nfcwilink_receive(void *priv_data
, struct sk_buff
*skb
)
338 struct nfcwilink
*drv
= priv_data
;
349 dev_dbg(&drv
->pdev
->dev
, "receive entry, len %d\n", skb
->len
);
351 /* strip the ST header
352 (apart for the chnl byte, which is not received in the hdr) */
353 skb_pull(skb
, (NFCWILINK_HDR_LEN
-1));
355 if (test_bit(NFCWILINK_FW_DOWNLOAD
, &drv
->flags
)) {
356 nfcwilink_fw_download_receive(drv
, skb
);
360 /* Forward skb to NCI core layer */
361 rc
= nci_recv_frame(drv
->ndev
, skb
);
363 nfc_err(&drv
->pdev
->dev
, "nci_recv_frame failed %d\n", rc
);
370 /* protocol structure registered with ST */
371 static struct st_proto_s nfcwilink_proto
= {
372 .chnl_id
= NFCWILINK_CHNL
,
373 .max_frame_size
= NFCWILINK_MAX_FRAME_SIZE
,
374 .hdr_len
= (NFCWILINK_HDR_LEN
-1), /* not including chnl byte */
375 .offset_len_in_hdr
= NFCWILINK_OFFSET_LEN_IN_HDR
,
376 .len_size
= NFCWILINK_LEN_SIZE
,
378 .recv
= nfcwilink_receive
,
379 .reg_complete_cb
= nfcwilink_register_complete
,
383 static int nfcwilink_open(struct nci_dev
*ndev
)
385 struct nfcwilink
*drv
= nci_get_drvdata(ndev
);
386 unsigned long comp_ret
;
389 if (test_and_set_bit(NFCWILINK_RUNNING
, &drv
->flags
)) {
394 nfcwilink_proto
.priv_data
= drv
;
396 init_completion(&drv
->completed
);
397 drv
->st_register_cb_status
= -EINPROGRESS
;
399 rc
= st_register(&nfcwilink_proto
);
401 if (rc
== -EINPROGRESS
) {
402 comp_ret
= wait_for_completion_timeout(
404 msecs_to_jiffies(NFCWILINK_REGISTER_TIMEOUT
));
406 dev_dbg(&drv
->pdev
->dev
,
407 "wait_for_completion_timeout returned %ld\n",
414 } else if (drv
->st_register_cb_status
!= 0) {
415 rc
= drv
->st_register_cb_status
;
416 nfc_err(&drv
->pdev
->dev
,
417 "st_register_cb failed %d\n", rc
);
421 nfc_err(&drv
->pdev
->dev
, "st_register failed %d\n", rc
);
426 /* st_register MUST fill the write callback */
427 BUG_ON(nfcwilink_proto
.write
== NULL
);
428 drv
->st_write
= nfcwilink_proto
.write
;
430 if (nfcwilink_download_fw(drv
)) {
431 nfc_err(&drv
->pdev
->dev
, "nfcwilink_download_fw failed %d\n",
433 /* open should succeed, even if the FW download failed */
439 clear_bit(NFCWILINK_RUNNING
, &drv
->flags
);
445 static int nfcwilink_close(struct nci_dev
*ndev
)
447 struct nfcwilink
*drv
= nci_get_drvdata(ndev
);
450 if (!test_and_clear_bit(NFCWILINK_RUNNING
, &drv
->flags
))
453 rc
= st_unregister(&nfcwilink_proto
);
455 nfc_err(&drv
->pdev
->dev
, "st_unregister failed %d\n", rc
);
457 drv
->st_write
= NULL
;
462 static int nfcwilink_send(struct nci_dev
*ndev
, struct sk_buff
*skb
)
464 struct nfcwilink
*drv
= nci_get_drvdata(ndev
);
465 struct nfcwilink_hdr hdr
= {NFCWILINK_CHNL
, NFCWILINK_OPCODE
, 0x0000};
468 dev_dbg(&drv
->pdev
->dev
, "send entry, len %d\n", skb
->len
);
470 if (!test_bit(NFCWILINK_RUNNING
, &drv
->flags
)) {
475 /* add the ST hdr to the start of the buffer */
476 hdr
.len
= cpu_to_le16(skb
->len
);
477 memcpy(skb_push(skb
, NFCWILINK_HDR_LEN
), &hdr
, NFCWILINK_HDR_LEN
);
479 /* Insert skb to shared transport layer's transmit queue.
480 * Freeing skb memory is taken care in shared transport layer,
481 * so don't free skb memory here.
483 len
= drv
->st_write(skb
);
486 nfc_err(&drv
->pdev
->dev
, "st_write failed %ld\n", len
);
493 static struct nci_ops nfcwilink_ops
= {
494 .open
= nfcwilink_open
,
495 .close
= nfcwilink_close
,
496 .send
= nfcwilink_send
,
499 static int nfcwilink_probe(struct platform_device
*pdev
)
501 static struct nfcwilink
*drv
;
505 drv
= devm_kzalloc(&pdev
->dev
, sizeof(struct nfcwilink
), GFP_KERNEL
);
513 protocols
= NFC_PROTO_JEWEL_MASK
514 | NFC_PROTO_MIFARE_MASK
| NFC_PROTO_FELICA_MASK
515 | NFC_PROTO_ISO14443_MASK
516 | NFC_PROTO_ISO14443_B_MASK
517 | NFC_PROTO_NFC_DEP_MASK
;
519 drv
->ndev
= nci_allocate_device(&nfcwilink_ops
,
524 nfc_err(&pdev
->dev
, "nci_allocate_device failed\n");
529 nci_set_parent_dev(drv
->ndev
, &pdev
->dev
);
530 nci_set_drvdata(drv
->ndev
, drv
);
532 rc
= nci_register_device(drv
->ndev
);
534 nfc_err(&pdev
->dev
, "nci_register_device failed %d\n", rc
);
538 dev_set_drvdata(&pdev
->dev
, drv
);
543 nci_free_device(drv
->ndev
);
549 static int nfcwilink_remove(struct platform_device
*pdev
)
551 struct nfcwilink
*drv
= dev_get_drvdata(&pdev
->dev
);
552 struct nci_dev
*ndev
;
559 nci_unregister_device(ndev
);
560 nci_free_device(ndev
);
565 static struct platform_driver nfcwilink_driver
= {
566 .probe
= nfcwilink_probe
,
567 .remove
= nfcwilink_remove
,
570 .owner
= THIS_MODULE
,
574 module_platform_driver(nfcwilink_driver
);
576 /* ------ Module Info ------ */
578 MODULE_AUTHOR("Ilan Elias <ilane@ti.com>");
579 MODULE_DESCRIPTION("NFC Driver for TI Shared Transport");
580 MODULE_LICENSE("GPL");