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>
20 #include <linux/rpmsg/byteorder.h>
22 #define RPMSG_ADDR_ANY 0xFFFFFFFF
25 struct rpmsg_endpoint
;
26 struct rpmsg_device_ops
;
27 struct rpmsg_endpoint_ops
;
30 * struct rpmsg_channel_info - channel info representation
31 * @name: name of service
33 * @dst: destination address
35 struct rpmsg_channel_info
{
36 char name
[RPMSG_NAME_SIZE
];
42 * rpmsg_device - device that belong to the rpmsg bus
43 * @dev: the device struct
44 * @id: device id (used to match between rpmsg drivers and devices)
45 * @driver_override: driver name to force a match
47 * @dst: destination address
48 * @ept: the rpmsg endpoint of this channel
49 * @announce: if set, rpmsg will announce the creation/removal of this channel
50 * @little_endian: True if transport is using little endian byte representation
54 struct rpmsg_device_id id
;
55 char *driver_override
;
58 struct rpmsg_endpoint
*ept
;
62 const struct rpmsg_device_ops
*ops
;
65 typedef int (*rpmsg_rx_cb_t
)(struct rpmsg_device
*, void *, int, void *, u32
);
68 * struct rpmsg_endpoint - binds a local rpmsg address to its user
69 * @rpdev: rpmsg channel device
70 * @refcount: when this drops to zero, the ept is deallocated
71 * @cb: rx callback handler
72 * @cb_lock: must be taken before accessing/changing @cb
73 * @addr: local rpmsg address
74 * @priv: private data for the driver's use
76 * In essence, an rpmsg endpoint represents a listener on the rpmsg bus, as
77 * it binds an rpmsg address with an rx callback handler.
79 * Simple rpmsg drivers shouldn't use this struct directly, because
80 * things just work: every rpmsg driver provides an rx callback upon
81 * registering to the bus, and that callback is then bound to its rpmsg
82 * address when the driver is probed. When relevant inbound messages arrive
83 * (i.e. messages which their dst address equals to the src address of
84 * the rpmsg channel), the driver's handler is invoked to process it.
86 * More complicated drivers though, that do need to allocate additional rpmsg
87 * addresses, and bind them to different rx callbacks, must explicitly
88 * create additional endpoints by themselves (see rpmsg_create_ept()).
90 struct rpmsg_endpoint
{
91 struct rpmsg_device
*rpdev
;
98 const struct rpmsg_endpoint_ops
*ops
;
102 * struct rpmsg_driver - rpmsg driver struct
103 * @drv: underlying device driver
104 * @id_table: rpmsg ids serviced by this driver
105 * @probe: invoked when a matching rpmsg channel (i.e. device) is found
106 * @remove: invoked when the rpmsg channel is removed
107 * @callback: invoked when an inbound message is received on the channel
109 struct rpmsg_driver
{
110 struct device_driver drv
;
111 const struct rpmsg_device_id
*id_table
;
112 int (*probe
)(struct rpmsg_device
*dev
);
113 void (*remove
)(struct rpmsg_device
*dev
);
114 int (*callback
)(struct rpmsg_device
*, void *, int, void *, u32
);
117 static inline u16
rpmsg16_to_cpu(struct rpmsg_device
*rpdev
, __rpmsg16 val
)
120 return __rpmsg16_to_cpu(rpmsg_is_little_endian(), val
);
122 return __rpmsg16_to_cpu(rpdev
->little_endian
, val
);
125 static inline __rpmsg16
cpu_to_rpmsg16(struct rpmsg_device
*rpdev
, u16 val
)
128 return __cpu_to_rpmsg16(rpmsg_is_little_endian(), val
);
130 return __cpu_to_rpmsg16(rpdev
->little_endian
, val
);
133 static inline u32
rpmsg32_to_cpu(struct rpmsg_device
*rpdev
, __rpmsg32 val
)
136 return __rpmsg32_to_cpu(rpmsg_is_little_endian(), val
);
138 return __rpmsg32_to_cpu(rpdev
->little_endian
, val
);
141 static inline __rpmsg32
cpu_to_rpmsg32(struct rpmsg_device
*rpdev
, u32 val
)
144 return __cpu_to_rpmsg32(rpmsg_is_little_endian(), val
);
146 return __cpu_to_rpmsg32(rpdev
->little_endian
, val
);
149 static inline u64
rpmsg64_to_cpu(struct rpmsg_device
*rpdev
, __rpmsg64 val
)
152 return __rpmsg64_to_cpu(rpmsg_is_little_endian(), val
);
154 return __rpmsg64_to_cpu(rpdev
->little_endian
, val
);
157 static inline __rpmsg64
cpu_to_rpmsg64(struct rpmsg_device
*rpdev
, u64 val
)
160 return __cpu_to_rpmsg64(rpmsg_is_little_endian(), val
);
162 return __cpu_to_rpmsg64(rpdev
->little_endian
, val
);
165 #if IS_ENABLED(CONFIG_RPMSG)
167 int rpmsg_register_device(struct rpmsg_device
*rpdev
);
168 int rpmsg_unregister_device(struct device
*parent
,
169 struct rpmsg_channel_info
*chinfo
);
170 int __register_rpmsg_driver(struct rpmsg_driver
*drv
, struct module
*owner
);
171 void unregister_rpmsg_driver(struct rpmsg_driver
*drv
);
172 void rpmsg_destroy_ept(struct rpmsg_endpoint
*);
173 struct rpmsg_endpoint
*rpmsg_create_ept(struct rpmsg_device
*,
174 rpmsg_rx_cb_t cb
, void *priv
,
175 struct rpmsg_channel_info chinfo
);
177 int rpmsg_send(struct rpmsg_endpoint
*ept
, void *data
, int len
);
178 int rpmsg_sendto(struct rpmsg_endpoint
*ept
, void *data
, int len
, u32 dst
);
179 int rpmsg_send_offchannel(struct rpmsg_endpoint
*ept
, u32 src
, u32 dst
,
180 void *data
, int len
);
182 int rpmsg_trysend(struct rpmsg_endpoint
*ept
, void *data
, int len
);
183 int rpmsg_trysendto(struct rpmsg_endpoint
*ept
, void *data
, int len
, u32 dst
);
184 int rpmsg_trysend_offchannel(struct rpmsg_endpoint
*ept
, u32 src
, u32 dst
,
185 void *data
, int len
);
187 __poll_t
rpmsg_poll(struct rpmsg_endpoint
*ept
, struct file
*filp
,
192 static inline int rpmsg_register_device(struct rpmsg_device
*rpdev
)
197 static inline int rpmsg_unregister_device(struct device
*parent
,
198 struct rpmsg_channel_info
*chinfo
)
200 /* This shouldn't be possible */
206 static inline int __register_rpmsg_driver(struct rpmsg_driver
*drv
,
207 struct module
*owner
)
209 /* This shouldn't be possible */
215 static inline void unregister_rpmsg_driver(struct rpmsg_driver
*drv
)
217 /* This shouldn't be possible */
221 static inline void rpmsg_destroy_ept(struct rpmsg_endpoint
*ept
)
223 /* This shouldn't be possible */
227 static inline struct rpmsg_endpoint
*rpmsg_create_ept(struct rpmsg_device
*rpdev
,
230 struct rpmsg_channel_info chinfo
)
232 /* This shouldn't be possible */
235 return ERR_PTR(-ENXIO
);
238 static inline int rpmsg_send(struct rpmsg_endpoint
*ept
, void *data
, int len
)
240 /* This shouldn't be possible */
246 static inline int rpmsg_sendto(struct rpmsg_endpoint
*ept
, void *data
, int len
,
249 /* This shouldn't be possible */
256 static inline int rpmsg_send_offchannel(struct rpmsg_endpoint
*ept
, u32 src
,
257 u32 dst
, void *data
, int len
)
259 /* This shouldn't be possible */
265 static inline int rpmsg_trysend(struct rpmsg_endpoint
*ept
, void *data
, int len
)
267 /* This shouldn't be possible */
273 static inline int rpmsg_trysendto(struct rpmsg_endpoint
*ept
, void *data
,
276 /* This shouldn't be possible */
282 static inline int rpmsg_trysend_offchannel(struct rpmsg_endpoint
*ept
, u32 src
,
283 u32 dst
, void *data
, int len
)
285 /* This shouldn't be possible */
291 static inline __poll_t
rpmsg_poll(struct rpmsg_endpoint
*ept
,
292 struct file
*filp
, poll_table
*wait
)
294 /* This shouldn't be possible */
300 #endif /* IS_ENABLED(CONFIG_RPMSG) */
302 /* use a macro to avoid include chaining to get THIS_MODULE */
303 #define register_rpmsg_driver(drv) \
304 __register_rpmsg_driver(drv, THIS_MODULE)
307 * module_rpmsg_driver() - Helper macro for registering an rpmsg driver
308 * @__rpmsg_driver: rpmsg_driver struct
310 * Helper macro for rpmsg drivers which do not do anything special in module
311 * init/exit. This eliminates a lot of boilerplate. Each module may only
312 * use this macro once, and calling it replaces module_init() and module_exit()
314 #define module_rpmsg_driver(__rpmsg_driver) \
315 module_driver(__rpmsg_driver, register_rpmsg_driver, \
316 unregister_rpmsg_driver)
318 #endif /* _LINUX_RPMSG_H */