1 /* SPDX-License-Identifier: BSD-3-Clause */
3 * Remote processor messaging
5 * Copyright (C) 2011 Texas Instruments, Inc.
6 * Copyright (C) 2011 Google, Inc.
10 #ifndef _LINUX_RPMSG_H
11 #define _LINUX_RPMSG_H
13 #include <linux/types.h>
14 #include <linux/device.h>
15 #include <linux/err.h>
16 #include <linux/mod_devicetable.h>
17 #include <linux/kref.h>
18 #include <linux/mutex.h>
19 #include <linux/poll.h>
21 #define RPMSG_ADDR_ANY 0xFFFFFFFF
24 struct rpmsg_endpoint;
25 struct rpmsg_device_ops;
26 struct rpmsg_endpoint_ops;
29 * struct rpmsg_channel_info - channel info representation
30 * @name: name of service
32 * @dst: destination address
34 struct rpmsg_channel_info {
35 char name[RPMSG_NAME_SIZE];
41 * rpmsg_device - device that belong to the rpmsg bus
42 * @dev: the device struct
43 * @id: device id (used to match between rpmsg drivers and devices)
44 * @driver_override: driver name to force a match; do not set directly,
45 * because core frees it; use driver_set_override() to
48 * @dst: destination address
49 * @ept: the rpmsg endpoint of this channel
50 * @announce: if set, rpmsg will announce the creation/removal of this channel
54 struct rpmsg_device_id id;
55 const char *driver_override;
58 struct rpmsg_endpoint *ept;
61 const struct rpmsg_device_ops *ops;
64 typedef int (*rpmsg_rx_cb_t)(struct rpmsg_device *, void *, int, void *, u32);
67 * struct rpmsg_endpoint - binds a local rpmsg address to its user
68 * @rpdev: rpmsg channel device
69 * @refcount: when this drops to zero, the ept is deallocated
70 * @cb: rx callback handler
71 * @cb_lock: must be taken before accessing/changing @cb
72 * @addr: local rpmsg address
73 * @priv: private data for the driver's use
75 * In essence, an rpmsg endpoint represents a listener on the rpmsg bus, as
76 * it binds an rpmsg address with an rx callback handler.
78 * Simple rpmsg drivers shouldn't use this struct directly, because
79 * things just work: every rpmsg driver provides an rx callback upon
80 * registering to the bus, and that callback is then bound to its rpmsg
81 * address when the driver is probed. When relevant inbound messages arrive
82 * (i.e. messages which their dst address equals to the src address of
83 * the rpmsg channel), the driver's handler is invoked to process it.
85 * More complicated drivers though, that do need to allocate additional rpmsg
86 * addresses, and bind them to different rx callbacks, must explicitly
87 * create additional endpoints by themselves (see rpmsg_create_ept()).
89 struct rpmsg_endpoint {
90 struct rpmsg_device *rpdev;
97 const struct rpmsg_endpoint_ops *ops;
101 * struct rpmsg_driver - rpmsg driver struct
102 * @drv: underlying device driver
103 * @id_table: rpmsg ids serviced by this driver
104 * @probe: invoked when a matching rpmsg channel (i.e. device) is found
105 * @remove: invoked when the rpmsg channel is removed
106 * @callback: invoked when an inbound message is received on the channel
108 struct rpmsg_driver {
109 struct device_driver drv;
110 const struct rpmsg_device_id *id_table;
111 int (*probe)(struct rpmsg_device *dev);
112 void (*remove)(struct rpmsg_device *dev);
113 int (*callback)(struct rpmsg_device *, void *, int, void *, u32);
116 #if IS_ENABLED(CONFIG_RPMSG)
118 int rpmsg_register_device_override(struct rpmsg_device *rpdev,
119 const char *driver_override);
120 int register_rpmsg_device(struct rpmsg_device *dev);
121 void unregister_rpmsg_device(struct rpmsg_device *dev);
122 int __register_rpmsg_driver(struct rpmsg_driver *drv, struct module *owner);
123 void unregister_rpmsg_driver(struct rpmsg_driver *drv);
124 void rpmsg_destroy_ept(struct rpmsg_endpoint *);
125 struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_device *,
126 rpmsg_rx_cb_t cb, void *priv,
127 struct rpmsg_channel_info chinfo);
129 int rpmsg_send(struct rpmsg_endpoint *ept, void *data, int len);
130 int rpmsg_sendto(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
131 int rpmsg_send_offchannel(struct rpmsg_endpoint *ept, u32 src, u32 dst,
132 void *data, int len);
134 int rpmsg_trysend(struct rpmsg_endpoint *ept, void *data, int len);
135 int rpmsg_trysendto(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
136 int rpmsg_trysend_offchannel(struct rpmsg_endpoint *ept, u32 src, u32 dst,
137 void *data, int len);
139 __poll_t rpmsg_poll(struct rpmsg_endpoint *ept, struct file *filp,
144 static inline int rpmsg_register_device_override(struct rpmsg_device *rpdev,
145 const char *driver_override)
150 static inline int register_rpmsg_device(struct rpmsg_device *dev)
155 static inline void unregister_rpmsg_device(struct rpmsg_device *dev)
157 /* This shouldn't be possible */
161 static inline int __register_rpmsg_driver(struct rpmsg_driver *drv,
162 struct module *owner)
164 /* This shouldn't be possible */
170 static inline void unregister_rpmsg_driver(struct rpmsg_driver *drv)
172 /* This shouldn't be possible */
176 static inline void rpmsg_destroy_ept(struct rpmsg_endpoint *ept)
178 /* This shouldn't be possible */
182 static inline struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_device *rpdev,
185 struct rpmsg_channel_info chinfo)
187 /* This shouldn't be possible */
193 static inline int rpmsg_send(struct rpmsg_endpoint *ept, void *data, int len)
195 /* This shouldn't be possible */
201 static inline int rpmsg_sendto(struct rpmsg_endpoint *ept, void *data, int len,
204 /* This shouldn't be possible */
211 static inline int rpmsg_send_offchannel(struct rpmsg_endpoint *ept, u32 src,
212 u32 dst, void *data, int len)
214 /* This shouldn't be possible */
220 static inline int rpmsg_trysend(struct rpmsg_endpoint *ept, void *data, int len)
222 /* This shouldn't be possible */
228 static inline int rpmsg_trysendto(struct rpmsg_endpoint *ept, void *data,
231 /* This shouldn't be possible */
237 static inline int rpmsg_trysend_offchannel(struct rpmsg_endpoint *ept, u32 src,
238 u32 dst, void *data, int len)
240 /* This shouldn't be possible */
246 static inline __poll_t rpmsg_poll(struct rpmsg_endpoint *ept,
247 struct file *filp, poll_table *wait)
249 /* This shouldn't be possible */
255 #endif /* IS_ENABLED(CONFIG_RPMSG) */
257 /* use a macro to avoid include chaining to get THIS_MODULE */
258 #define register_rpmsg_driver(drv) \
259 __register_rpmsg_driver(drv, THIS_MODULE)
262 * module_rpmsg_driver() - Helper macro for registering an rpmsg driver
263 * @__rpmsg_driver: rpmsg_driver struct
265 * Helper macro for rpmsg drivers which do not do anything special in module
266 * init/exit. This eliminates a lot of boilerplate. Each module may only
267 * use this macro once, and calling it replaces module_init() and module_exit()
269 #define module_rpmsg_driver(__rpmsg_driver) \
270 module_driver(__rpmsg_driver, register_rpmsg_driver, \
271 unregister_rpmsg_driver)
273 #endif /* _LINUX_RPMSG_H */