include/linux/rpmsg.h

1 /* SPDX-License-Identifier: BSD-3-Clause */
20 #include <linux/rpmsg/byteorder.h>
21 #include <uapi/linux/rpmsg.h>
29  * struct rpmsg_channel_info - channel info representation
41  * rpmsg_device - device that belong to the rpmsg bus
43  * @id: device id (used to match between rpmsg drivers and devices)
49  * @ept: the rpmsg endpoint of this channel
50  * @announce: if set, rpmsg will announce the creation/removal of this channel
70  * struct rpmsg_endpoint - binds a local rpmsg address to its user
71  * @rpdev: rpmsg channel device
76  * @addr: local rpmsg address
79  * In essence, an rpmsg endpoint represents a listener on the rpmsg bus, as
80  * it binds an rpmsg address with an rx callback handler.
82  * Simple rpmsg drivers shouldn't use this struct directly, because
83  * things just work: every rpmsg driver provides an rx callback upon
84  * registering to the bus, and that callback is then bound to its rpmsg
87  * the rpmsg channel), the driver's handler is invoked to process it.
89  * More complicated drivers though, that do need to allocate additional rpmsg
106  * struct rpmsg_driver - rpmsg driver struct
108  * @id_table: rpmsg ids serviced by this driver
109  * @probe: invoked when a matching rpmsg channel (i.e. device) is found
110  * @remove: invoked when the rpmsg channel is removed
128 		return __rpmsg16_to_cpu(rpdev->little_endian, val);  in rpmsg16_to_cpu()
136 		return __cpu_to_rpmsg16(rpdev->little_endian, val);  in cpu_to_rpmsg16()
144 		return __rpmsg32_to_cpu(rpdev->little_endian, val);  in rpmsg32_to_cpu()
152 		return __cpu_to_rpmsg32(rpdev->little_endian, val);  in cpu_to_rpmsg32()
160 		return __rpmsg64_to_cpu(rpdev->little_endian, val);  in rpmsg64_to_cpu()
168 		return __cpu_to_rpmsg64(rpdev->little_endian, val);  in cpu_to_rpmsg64()
207 	return -ENXIO;  in rpmsg_register_device_override()
212 	return -ENXIO;  in rpmsg_register_device()
221 	return -ENXIO;  in rpmsg_unregister_device()
230 	return -ENXIO;  in __register_rpmsg_driver()
261 	return -ENXIO;  in rpmsg_send()
270 	return -ENXIO;  in rpmsg_sendto()
280 	return -ENXIO;  in rpmsg_send_offchannel()
288 	return -ENXIO;  in rpmsg_trysend()
297 	return -ENXIO;  in rpmsg_trysendto()
306 	return -ENXIO;  in rpmsg_trysend_offchannel()
323 	return -ENXIO;  in rpmsg_get_mtu()
331 	return -ENXIO;  in rpmsg_set_flow_control()
341  * module_rpmsg_driver() - Helper macro for registering an rpmsg driver
344  * Helper macro for rpmsg drivers which do not do anything special in module