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 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 nfc_dev_dbg(&drv
->pdev
->dev
, "get_bts_file_name entry");
151 skb
= nfcwilink_skb_alloc(sizeof(struct nci_vs_nfcc_info_cmd
),
154 nfc_dev_err(&drv
->pdev
->dev
,
155 "no memory for nci_vs_nfcc_info_cmd");
159 skb
->dev
= (void *)drv
->ndev
;
161 cmd
= (struct nci_vs_nfcc_info_cmd
*)
162 skb_put(skb
, sizeof(struct nci_vs_nfcc_info_cmd
));
163 cmd
->gid
= NCI_VS_NFCC_INFO_CMD_GID
;
164 cmd
->oid
= NCI_VS_NFCC_INFO_CMD_OID
;
167 drv
->nfcc_info
.plen
= 0;
169 rc
= nfcwilink_send(skb
);
173 comp_ret
= wait_for_completion_timeout(&drv
->completed
,
174 msecs_to_jiffies(NFCWILINK_CMD_TIMEOUT
));
175 nfc_dev_dbg(&drv
->pdev
->dev
, "wait_for_completion_timeout returned %ld",
178 nfc_dev_err(&drv
->pdev
->dev
,
179 "timeout on wait_for_completion_timeout");
183 nfc_dev_dbg(&drv
->pdev
->dev
, "nci_vs_nfcc_info_rsp: plen %d, status %d",
185 drv
->nfcc_info
.status
);
187 if ((drv
->nfcc_info
.plen
!= 5) || (drv
->nfcc_info
.status
!= 0)) {
188 nfc_dev_err(&drv
->pdev
->dev
,
189 "invalid nci_vs_nfcc_info_rsp");
193 snprintf(file_name
, BTS_FILE_NAME_MAX_SIZE
,
194 "TINfcInit_%d.%d.%d.%d.bts",
195 drv
->nfcc_info
.hw_id
,
196 drv
->nfcc_info
.sw_ver_x
,
197 drv
->nfcc_info
.sw_ver_z
,
198 drv
->nfcc_info
.patch_id
);
200 nfc_dev_info(&drv
->pdev
->dev
, "nfcwilink FW file name: %s", file_name
);
205 static int nfcwilink_send_bts_cmd(struct nfcwilink
*drv
, __u8
*data
, int len
)
207 struct nfcwilink_hdr
*hdr
= (struct nfcwilink_hdr
*)data
;
209 unsigned long comp_ret
;
212 nfc_dev_dbg(&drv
->pdev
->dev
, "send_bts_cmd entry");
214 /* verify valid cmd for the NFC channel */
215 if ((len
<= sizeof(struct nfcwilink_hdr
)) ||
216 (len
> BTS_FILE_CMD_MAX_LEN
) ||
217 (hdr
->chnl
!= NFCWILINK_CHNL
) ||
218 (hdr
->opcode
!= NFCWILINK_OPCODE
)) {
219 nfc_dev_err(&drv
->pdev
->dev
,
220 "ignoring invalid bts cmd, len %d, chnl %d, opcode %d",
221 len
, hdr
->chnl
, hdr
->opcode
);
225 /* remove the ST header */
226 len
-= sizeof(struct nfcwilink_hdr
);
227 data
+= sizeof(struct nfcwilink_hdr
);
229 skb
= nfcwilink_skb_alloc(len
, GFP_KERNEL
);
231 nfc_dev_err(&drv
->pdev
->dev
, "no memory for bts cmd");
235 skb
->dev
= (void *)drv
->ndev
;
237 memcpy(skb_put(skb
, len
), data
, len
);
239 rc
= nfcwilink_send(skb
);
243 comp_ret
= wait_for_completion_timeout(&drv
->completed
,
244 msecs_to_jiffies(NFCWILINK_CMD_TIMEOUT
));
245 nfc_dev_dbg(&drv
->pdev
->dev
, "wait_for_completion_timeout returned %ld",
248 nfc_dev_err(&drv
->pdev
->dev
,
249 "timeout on wait_for_completion_timeout");
256 static int nfcwilink_download_fw(struct nfcwilink
*drv
)
258 unsigned char file_name
[BTS_FILE_NAME_MAX_SIZE
];
259 const struct firmware
*fw
;
260 __u16 action_type
, action_len
;
264 nfc_dev_dbg(&drv
->pdev
->dev
, "download_fw entry");
266 set_bit(NFCWILINK_FW_DOWNLOAD
, &drv
->flags
);
268 rc
= nfcwilink_get_bts_file_name(drv
, file_name
);
272 rc
= request_firmware(&fw
, file_name
, &drv
->pdev
->dev
);
274 nfc_dev_err(&drv
->pdev
->dev
, "request_firmware failed %d", rc
);
276 /* if the file is not found, don't exit with failure */
284 ptr
= (__u8
*)fw
->data
;
286 if ((len
== 0) || (ptr
== NULL
)) {
287 nfc_dev_dbg(&drv
->pdev
->dev
,
288 "request_firmware returned size %d", len
);
292 if (__le32_to_cpu(((struct bts_file_hdr
*)ptr
)->magic
) !=
293 BTS_FILE_HDR_MAGIC
) {
294 nfc_dev_err(&drv
->pdev
->dev
, "wrong bts magic number");
299 /* remove the BTS header */
300 len
-= sizeof(struct bts_file_hdr
);
301 ptr
+= sizeof(struct bts_file_hdr
);
305 __le16_to_cpu(((struct bts_file_action
*)ptr
)->type
);
307 __le16_to_cpu(((struct bts_file_action
*)ptr
)->len
);
309 nfc_dev_dbg(&drv
->pdev
->dev
, "bts_file_action type %d, len %d",
310 action_type
, action_len
);
312 switch (action_type
) {
313 case BTS_FILE_ACTION_TYPE_SEND_CMD
:
314 rc
= nfcwilink_send_bts_cmd(drv
,
315 ((struct bts_file_action
*)ptr
)->data
,
322 /* advance to the next action */
323 len
-= (sizeof(struct bts_file_action
) + action_len
);
324 ptr
+= (sizeof(struct bts_file_action
) + action_len
);
328 release_firmware(fw
);
331 clear_bit(NFCWILINK_FW_DOWNLOAD
, &drv
->flags
);
335 /* Called by ST when registration is complete */
336 static void nfcwilink_register_complete(void *priv_data
, char data
)
338 struct nfcwilink
*drv
= priv_data
;
340 nfc_dev_dbg(&drv
->pdev
->dev
, "register_complete entry");
342 /* store ST registration status */
343 drv
->st_register_cb_status
= data
;
345 /* complete the wait in nfc_st_open() */
346 complete(&drv
->completed
);
349 /* Called by ST when receive data is available */
350 static long nfcwilink_receive(void *priv_data
, struct sk_buff
*skb
)
352 struct nfcwilink
*drv
= priv_data
;
355 nfc_dev_dbg(&drv
->pdev
->dev
, "receive entry, len %d", skb
->len
);
365 /* strip the ST header
366 (apart for the chnl byte, which is not received in the hdr) */
367 skb_pull(skb
, (NFCWILINK_HDR_LEN
-1));
369 if (test_bit(NFCWILINK_FW_DOWNLOAD
, &drv
->flags
)) {
370 nfcwilink_fw_download_receive(drv
, skb
);
374 skb
->dev
= (void *) drv
->ndev
;
376 /* Forward skb to NCI core layer */
377 rc
= nci_recv_frame(skb
);
379 nfc_dev_err(&drv
->pdev
->dev
, "nci_recv_frame failed %d", rc
);
386 /* protocol structure registered with ST */
387 static struct st_proto_s nfcwilink_proto
= {
388 .chnl_id
= NFCWILINK_CHNL
,
389 .max_frame_size
= NFCWILINK_MAX_FRAME_SIZE
,
390 .hdr_len
= (NFCWILINK_HDR_LEN
-1), /* not including chnl byte */
391 .offset_len_in_hdr
= NFCWILINK_OFFSET_LEN_IN_HDR
,
392 .len_size
= NFCWILINK_LEN_SIZE
,
394 .recv
= nfcwilink_receive
,
395 .reg_complete_cb
= nfcwilink_register_complete
,
399 static int nfcwilink_open(struct nci_dev
*ndev
)
401 struct nfcwilink
*drv
= nci_get_drvdata(ndev
);
402 unsigned long comp_ret
;
405 nfc_dev_dbg(&drv
->pdev
->dev
, "open entry");
407 if (test_and_set_bit(NFCWILINK_RUNNING
, &drv
->flags
)) {
412 nfcwilink_proto
.priv_data
= drv
;
414 init_completion(&drv
->completed
);
415 drv
->st_register_cb_status
= -EINPROGRESS
;
417 rc
= st_register(&nfcwilink_proto
);
419 if (rc
== -EINPROGRESS
) {
420 comp_ret
= wait_for_completion_timeout(
422 msecs_to_jiffies(NFCWILINK_REGISTER_TIMEOUT
));
424 nfc_dev_dbg(&drv
->pdev
->dev
,
425 "wait_for_completion_timeout returned %ld",
432 } else if (drv
->st_register_cb_status
!= 0) {
433 rc
= drv
->st_register_cb_status
;
434 nfc_dev_err(&drv
->pdev
->dev
,
435 "st_register_cb failed %d", rc
);
439 nfc_dev_err(&drv
->pdev
->dev
,
440 "st_register failed %d", rc
);
445 /* st_register MUST fill the write callback */
446 BUG_ON(nfcwilink_proto
.write
== NULL
);
447 drv
->st_write
= nfcwilink_proto
.write
;
449 if (nfcwilink_download_fw(drv
)) {
450 nfc_dev_err(&drv
->pdev
->dev
, "nfcwilink_download_fw failed %d",
452 /* open should succeed, even if the FW download failed */
458 clear_bit(NFCWILINK_RUNNING
, &drv
->flags
);
464 static int nfcwilink_close(struct nci_dev
*ndev
)
466 struct nfcwilink
*drv
= nci_get_drvdata(ndev
);
469 nfc_dev_dbg(&drv
->pdev
->dev
, "close entry");
471 if (!test_and_clear_bit(NFCWILINK_RUNNING
, &drv
->flags
))
474 rc
= st_unregister(&nfcwilink_proto
);
476 nfc_dev_err(&drv
->pdev
->dev
, "st_unregister failed %d", rc
);
478 drv
->st_write
= NULL
;
483 static int nfcwilink_send(struct sk_buff
*skb
)
485 struct nci_dev
*ndev
= (struct nci_dev
*)skb
->dev
;
486 struct nfcwilink
*drv
= nci_get_drvdata(ndev
);
487 struct nfcwilink_hdr hdr
= {NFCWILINK_CHNL
, NFCWILINK_OPCODE
, 0x0000};
490 nfc_dev_dbg(&drv
->pdev
->dev
, "send entry, len %d", skb
->len
);
492 if (!test_bit(NFCWILINK_RUNNING
, &drv
->flags
)) {
497 /* add the ST hdr to the start of the buffer */
498 hdr
.len
= cpu_to_le16(skb
->len
);
499 memcpy(skb_push(skb
, NFCWILINK_HDR_LEN
), &hdr
, NFCWILINK_HDR_LEN
);
501 /* Insert skb to shared transport layer's transmit queue.
502 * Freeing skb memory is taken care in shared transport layer,
503 * so don't free skb memory here.
505 len
= drv
->st_write(skb
);
508 nfc_dev_err(&drv
->pdev
->dev
, "st_write failed %ld", len
);
515 static struct nci_ops nfcwilink_ops
= {
516 .open
= nfcwilink_open
,
517 .close
= nfcwilink_close
,
518 .send
= nfcwilink_send
,
521 static int nfcwilink_probe(struct platform_device
*pdev
)
523 static struct nfcwilink
*drv
;
527 nfc_dev_dbg(&pdev
->dev
, "probe entry");
529 drv
= kzalloc(sizeof(struct nfcwilink
), GFP_KERNEL
);
537 protocols
= NFC_PROTO_JEWEL_MASK
538 | NFC_PROTO_MIFARE_MASK
| NFC_PROTO_FELICA_MASK
539 | NFC_PROTO_ISO14443_MASK
540 | NFC_PROTO_ISO14443_B_MASK
541 | NFC_PROTO_NFC_DEP_MASK
;
543 drv
->ndev
= nci_allocate_device(&nfcwilink_ops
,
548 nfc_dev_err(&pdev
->dev
, "nci_allocate_device failed");
553 nci_set_parent_dev(drv
->ndev
, &pdev
->dev
);
554 nci_set_drvdata(drv
->ndev
, drv
);
556 rc
= nci_register_device(drv
->ndev
);
558 nfc_dev_err(&pdev
->dev
, "nci_register_device failed %d", rc
);
562 dev_set_drvdata(&pdev
->dev
, drv
);
567 nci_free_device(drv
->ndev
);
576 static int nfcwilink_remove(struct platform_device
*pdev
)
578 struct nfcwilink
*drv
= dev_get_drvdata(&pdev
->dev
);
579 struct nci_dev
*ndev
;
581 nfc_dev_dbg(&pdev
->dev
, "remove entry");
588 nci_unregister_device(ndev
);
589 nci_free_device(ndev
);
593 dev_set_drvdata(&pdev
->dev
, NULL
);
598 static struct platform_driver nfcwilink_driver
= {
599 .probe
= nfcwilink_probe
,
600 .remove
= nfcwilink_remove
,
603 .owner
= THIS_MODULE
,
607 /* ------- Module Init/Exit interfaces ------ */
608 static int __init
nfcwilink_init(void)
610 printk(KERN_INFO
"NFC Driver for TI WiLink");
612 return platform_driver_register(&nfcwilink_driver
);
615 static void __exit
nfcwilink_exit(void)
617 platform_driver_unregister(&nfcwilink_driver
);
620 module_init(nfcwilink_init
);
621 module_exit(nfcwilink_exit
);
623 /* ------ Module Info ------ */
625 MODULE_AUTHOR("Ilan Elias <ilane@ti.com>");
626 MODULE_DESCRIPTION("NFC Driver for TI Shared Transport");
627 MODULE_LICENSE("GPL");