xref: /openbmc/linux/drivers/nfc/s3fwrn5/s3fwrn5.h (revision f3539c12)
1 /*
2  * NCI based driver for Samsung S3FWRN5 NFC chip
3  *
4  * Copyright (C) 2015 Samsung Electrnoics
5  * Robert Baldyga <r.baldyga@samsung.com>
6  *
7  * This program is free software; you can redistribute it and/or modify it
8  * under the terms and conditions of the GNU General Public License,
9  * version 2 or later, as published by the Free Software Foundation.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19 
20 #ifndef __LOCAL_S3FWRN5_H_
21 #define __LOCAL_S3FWRN5_H_
22 
23 #include <linux/nfc.h>
24 
25 #include <net/nfc/nci_core.h>
26 
27 #include "firmware.h"
28 
29 enum s3fwrn5_mode {
30 	S3FWRN5_MODE_COLD,
31 	S3FWRN5_MODE_NCI,
32 	S3FWRN5_MODE_FW,
33 };
34 
35 struct s3fwrn5_phy_ops {
36 	void (*set_wake)(void *id, bool sleep);
37 	void (*set_mode)(void *id, enum s3fwrn5_mode);
38 	enum s3fwrn5_mode (*get_mode)(void *id);
39 	int (*write)(void *id, struct sk_buff *skb);
40 };
41 
42 struct s3fwrn5_info {
43 	struct nci_dev *ndev;
44 	void *phy_id;
45 	struct device *pdev;
46 
47 	const struct s3fwrn5_phy_ops *phy_ops;
48 	unsigned int max_payload;
49 
50 	struct s3fwrn5_fw_info fw_info;
51 
52 	struct mutex mutex;
53 };
54 
55 static inline int s3fwrn5_set_mode(struct s3fwrn5_info *info,
56 	enum s3fwrn5_mode mode)
57 {
58 	if (!info->phy_ops->set_mode)
59 		return -ENOTSUPP;
60 
61 	info->phy_ops->set_mode(info->phy_id, mode);
62 
63 	return 0;
64 }
65 
66 static inline enum s3fwrn5_mode s3fwrn5_get_mode(struct s3fwrn5_info *info)
67 {
68 	if (!info->phy_ops->get_mode)
69 		return -ENOTSUPP;
70 
71 	return info->phy_ops->get_mode(info->phy_id);
72 }
73 
74 static inline int s3fwrn5_set_wake(struct s3fwrn5_info *info, bool wake)
75 {
76 	if (!info->phy_ops->set_wake)
77 		return -ENOTSUPP;
78 
79 	info->phy_ops->set_wake(info->phy_id, wake);
80 
81 	return 0;
82 }
83 
84 static inline int s3fwrn5_write(struct s3fwrn5_info *info, struct sk_buff *skb)
85 {
86 	if (!info->phy_ops->write)
87 		return -ENOTSUPP;
88 
89 	return info->phy_ops->write(info->phy_id, skb);
90 }
91 
92 int s3fwrn5_probe(struct nci_dev **ndev, void *phy_id, struct device *pdev,
93 	const struct s3fwrn5_phy_ops *phy_ops, unsigned int max_payload);
94 void s3fwrn5_remove(struct nci_dev *ndev);
95 
96 int s3fwrn5_recv_frame(struct nci_dev *ndev, struct sk_buff *skb,
97 	enum s3fwrn5_mode mode);
98 
99 #endif /* __LOCAL_S3FWRN5_H_ */
100