xref: /OK3568_Linux_fs/kernel/drivers/nfc/nxp-nci/nxp-nci.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-only */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright (C) 2014  NXP Semiconductors  All rights reserved.
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  * Authors: Clément Perrochaud <clement.perrochaud@nxp.com>
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  * Derived from PN544 device driver:
8*4882a593Smuzhiyun  * Copyright (C) 2012  Intel Corporation. All rights reserved.
9*4882a593Smuzhiyun */
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #ifndef __LOCAL_NXP_NCI_H_
12*4882a593Smuzhiyun #define __LOCAL_NXP_NCI_H_
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #include <linux/completion.h>
15*4882a593Smuzhiyun #include <linux/firmware.h>
16*4882a593Smuzhiyun #include <linux/nfc.h>
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #include <net/nfc/nci_core.h>
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun #define NXP_NCI_FW_HDR_LEN	2
21*4882a593Smuzhiyun #define NXP_NCI_FW_CRC_LEN	2
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun #define NXP_NCI_FW_FRAME_LEN_MASK	0x03FF
24*4882a593Smuzhiyun 
25*4882a593Smuzhiyun enum nxp_nci_mode {
26*4882a593Smuzhiyun 	NXP_NCI_MODE_COLD,
27*4882a593Smuzhiyun 	NXP_NCI_MODE_NCI,
28*4882a593Smuzhiyun 	NXP_NCI_MODE_FW
29*4882a593Smuzhiyun };
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun struct nxp_nci_phy_ops {
32*4882a593Smuzhiyun 	int (*set_mode)(void *id, enum nxp_nci_mode mode);
33*4882a593Smuzhiyun 	int (*write)(void *id, struct sk_buff *skb);
34*4882a593Smuzhiyun };
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun struct nxp_nci_fw_info {
37*4882a593Smuzhiyun 	char name[NFC_FIRMWARE_NAME_MAXSIZE + 1];
38*4882a593Smuzhiyun 	const struct firmware *fw;
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun 	size_t size;
41*4882a593Smuzhiyun 	size_t written;
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun 	const u8 *data;
44*4882a593Smuzhiyun 	size_t frame_size;
45*4882a593Smuzhiyun 
46*4882a593Smuzhiyun 	struct work_struct work;
47*4882a593Smuzhiyun 	struct completion cmd_completion;
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun 	int cmd_result;
50*4882a593Smuzhiyun };
51*4882a593Smuzhiyun 
52*4882a593Smuzhiyun struct nxp_nci_info {
53*4882a593Smuzhiyun 	struct nci_dev *ndev;
54*4882a593Smuzhiyun 	void *phy_id;
55*4882a593Smuzhiyun 	struct device *pdev;
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun 	enum nxp_nci_mode mode;
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun 	const struct nxp_nci_phy_ops *phy_ops;
60*4882a593Smuzhiyun 	unsigned int max_payload;
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun 	struct mutex info_lock;
63*4882a593Smuzhiyun 
64*4882a593Smuzhiyun 	struct nxp_nci_fw_info fw_info;
65*4882a593Smuzhiyun };
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun int nxp_nci_fw_download(struct nci_dev *ndev, const char *firmware_name);
68*4882a593Smuzhiyun void nxp_nci_fw_work(struct work_struct *work);
69*4882a593Smuzhiyun void nxp_nci_fw_recv_frame(struct nci_dev *ndev, struct sk_buff *skb);
70*4882a593Smuzhiyun void nxp_nci_fw_work_complete(struct nxp_nci_info *info, int result);
71*4882a593Smuzhiyun 
72*4882a593Smuzhiyun int nxp_nci_probe(void *phy_id, struct device *pdev,
73*4882a593Smuzhiyun 		  const struct nxp_nci_phy_ops *phy_ops,
74*4882a593Smuzhiyun 		  unsigned int max_payload,
75*4882a593Smuzhiyun 		  struct nci_dev **ndev);
76*4882a593Smuzhiyun void nxp_nci_remove(struct nci_dev *ndev);
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun #endif /* __LOCAL_NXP_NCI_H_ */
79