1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /* Copyright (c) 2021, Linaro Ltd <loic.poulain@linaro.org> */
3
4 #ifndef __WWAN_H
5 #define __WWAN_H
6
7 #include <linux/poll.h>
8 #include <linux/netdevice.h>
9 #include <linux/types.h>
10
11 /**
12 * enum wwan_port_type - WWAN port types
13 * @WWAN_PORT_AT: AT commands
14 * @WWAN_PORT_MBIM: Mobile Broadband Interface Model control
15 * @WWAN_PORT_QMI: Qcom modem/MSM interface for modem control
16 * @WWAN_PORT_QCDM: Qcom Modem diagnostic interface
17 * @WWAN_PORT_FIREHOSE: XML based command protocol
18 * @WWAN_PORT_XMMRPC: Control protocol for Intel XMM modems
19 *
20 * @WWAN_PORT_MAX: Highest supported port types
21 * @WWAN_PORT_UNKNOWN: Special value to indicate an unknown port type
22 * @__WWAN_PORT_MAX: Internal use
23 */
24 enum wwan_port_type {
25 WWAN_PORT_AT,
26 WWAN_PORT_MBIM,
27 WWAN_PORT_QMI,
28 WWAN_PORT_QCDM,
29 WWAN_PORT_FIREHOSE,
30 WWAN_PORT_XMMRPC,
31
32 /* Add new port types above this line */
33
34 __WWAN_PORT_MAX,
35 WWAN_PORT_MAX = __WWAN_PORT_MAX - 1,
36 WWAN_PORT_UNKNOWN,
37 };
38
39 struct device;
40 struct file;
41 struct netlink_ext_ack;
42 struct sk_buff;
43 struct wwan_port;
44
45 /** struct wwan_port_ops - The WWAN port operations
46 * @start: The routine for starting the WWAN port device.
47 * @stop: The routine for stopping the WWAN port device.
48 * @tx: Non-blocking routine that sends WWAN port protocol data to the device.
49 * @tx_blocking: Optional blocking routine that sends WWAN port protocol data
50 * to the device.
51 * @tx_poll: Optional routine that sets additional TX poll flags.
52 *
53 * The wwan_port_ops structure contains a list of low-level operations
54 * that control a WWAN port device. All functions are mandatory unless specified.
55 */
56 struct wwan_port_ops {
57 int (*start)(struct wwan_port *port);
58 void (*stop)(struct wwan_port *port);
59 int (*tx)(struct wwan_port *port, struct sk_buff *skb);
60
61 /* Optional operations */
62 int (*tx_blocking)(struct wwan_port *port, struct sk_buff *skb);
63 __poll_t (*tx_poll)(struct wwan_port *port, struct file *filp,
64 poll_table *wait);
65 };
66
67 /**
68 * wwan_create_port - Add a new WWAN port
69 * @parent: Device to use as parent and shared by all WWAN ports
70 * @type: WWAN port type
71 * @ops: WWAN port operations
72 * @drvdata: Pointer to caller driver data
73 *
74 * Allocate and register a new WWAN port. The port will be automatically exposed
75 * to user as a character device and attached to the right virtual WWAN device,
76 * based on the parent pointer. The parent pointer is the device shared by all
77 * components of a same WWAN modem (e.g. USB dev, PCI dev, MHI controller...).
78 *
79 * drvdata will be placed in the WWAN port device driver data and can be
80 * retrieved with wwan_port_get_drvdata().
81 *
82 * This function must be balanced with a call to wwan_remove_port().
83 *
84 * Returns a valid pointer to wwan_port on success or PTR_ERR on failure
85 */
86 struct wwan_port *wwan_create_port(struct device *parent,
87 enum wwan_port_type type,
88 const struct wwan_port_ops *ops,
89 void *drvdata);
90
91 /**
92 * wwan_remove_port - Remove a WWAN port
93 * @port: WWAN port to remove
94 *
95 * Remove a previously created port.
96 */
97 void wwan_remove_port(struct wwan_port *port);
98
99 /**
100 * wwan_port_rx - Receive data from the WWAN port
101 * @port: WWAN port for which data is received
102 * @skb: Pointer to the rx buffer
103 *
104 * A port driver calls this function upon data reception (MBIM, AT...).
105 */
106 void wwan_port_rx(struct wwan_port *port, struct sk_buff *skb);
107
108 /**
109 * wwan_port_txoff - Stop TX on WWAN port
110 * @port: WWAN port for which TX must be stopped
111 *
112 * Used for TX flow control, a port driver calls this function to indicate TX
113 * is temporary unavailable (e.g. due to ring buffer fullness).
114 */
115 void wwan_port_txoff(struct wwan_port *port);
116
117
118 /**
119 * wwan_port_txon - Restart TX on WWAN port
120 * @port: WWAN port for which TX must be restarted
121 *
122 * Used for TX flow control, a port driver calls this function to indicate TX
123 * is available again.
124 */
125 void wwan_port_txon(struct wwan_port *port);
126
127 /**
128 * wwan_port_get_drvdata - Retrieve driver data from a WWAN port
129 * @port: Related WWAN port
130 */
131 void *wwan_port_get_drvdata(struct wwan_port *port);
132
133 /**
134 * struct wwan_netdev_priv - WWAN core network device private data
135 * @link_id: WWAN device data link id
136 * @drv_priv: driver private data area, size is determined in &wwan_ops
137 */
138 struct wwan_netdev_priv {
139 u32 link_id;
140
141 /* must be last */
142 u8 drv_priv[] __aligned(sizeof(void *));
143 };
144
wwan_netdev_drvpriv(struct net_device * dev)145 static inline void *wwan_netdev_drvpriv(struct net_device *dev)
146 {
147 return ((struct wwan_netdev_priv *)netdev_priv(dev))->drv_priv;
148 }
149
150 /*
151 * Used to indicate that the WWAN core should not create a default network
152 * link.
153 */
154 #define WWAN_NO_DEFAULT_LINK U32_MAX
155
156 /**
157 * struct wwan_ops - WWAN device ops
158 * @priv_size: size of private netdev data area
159 * @setup: set up a new netdev
160 * @newlink: register the new netdev
161 * @dellink: remove the given netdev
162 */
163 struct wwan_ops {
164 unsigned int priv_size;
165 void (*setup)(struct net_device *dev);
166 int (*newlink)(void *ctxt, struct net_device *dev,
167 u32 if_id, struct netlink_ext_ack *extack);
168 void (*dellink)(void *ctxt, struct net_device *dev,
169 struct list_head *head);
170 };
171
172 int wwan_register_ops(struct device *parent, const struct wwan_ops *ops,
173 void *ctxt, u32 def_link_id);
174
175 void wwan_unregister_ops(struct device *parent);
176
177 #ifdef CONFIG_WWAN_DEBUGFS
178 struct dentry *wwan_get_debugfs_dir(struct device *parent);
179 void wwan_put_debugfs_dir(struct dentry *dir);
180 #else
wwan_get_debugfs_dir(struct device * parent)181 static inline struct dentry *wwan_get_debugfs_dir(struct device *parent)
182 {
183 return ERR_PTR(-ENODEV);
184 }
wwan_put_debugfs_dir(struct dentry * dir)185 static inline void wwan_put_debugfs_dir(struct dentry *dir) {}
186 #endif
187
188 #endif /* __WWAN_H */
189