1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 * remote processor messaging bus internals
4 *
5 * Copyright (c) 2020 The Linux Foundation.
6 * Copyright (C) 2011 Texas Instruments, Inc.
7 * Copyright (C) 2011 Google, Inc.
8 *
9 * Ohad Ben-Cohen <ohad@wizery.com>
10 * Brian Swetland <swetland@google.com>
11 */
12
13 #ifndef __RPMSG_INTERNAL_H__
14 #define __RPMSG_INTERNAL_H__
15
16 #include <linux/rpmsg.h>
17 #include <linux/poll.h>
18
19 #define to_rpmsg_device(d) container_of(d, struct rpmsg_device, dev)
20 #define to_rpmsg_driver(d) container_of(d, struct rpmsg_driver, drv)
21
22 /**
23 * struct rpmsg_device_ops - indirection table for the rpmsg_device operations
24 * @create_ept: create backend-specific endpoint, required
25 * @announce_create: announce presence of new channel, optional
26 * @announce_destroy: announce destruction of channel, optional
27 *
28 * Indirection table for the operations that a rpmsg backend should implement.
29 * @announce_create and @announce_destroy are optional as the backend might
30 * advertise new channels implicitly by creating the endpoints.
31 */
32 struct rpmsg_device_ops {
33 struct rpmsg_endpoint *(*create_ept)(struct rpmsg_device *rpdev,
34 rpmsg_rx_cb_t cb, void *priv,
35 struct rpmsg_channel_info chinfo);
36
37 int (*announce_create)(struct rpmsg_device *ept);
38 int (*announce_destroy)(struct rpmsg_device *ept);
39 };
40
41 /**
42 * struct rpmsg_endpoint_ops - indirection table for rpmsg_endpoint operations
43 * @destroy_ept: see @rpmsg_destroy_ept(), required
44 * @send: see @rpmsg_send(), required
45 * @sendto: see @rpmsg_sendto(), optional
46 * @send_offchannel: see @rpmsg_send_offchannel(), optional
47 * @trysend: see @rpmsg_trysend(), required
48 * @trysendto: see @rpmsg_trysendto(), optional
49 * @trysend_offchannel: see @rpmsg_trysend_offchannel(), optional
50 * @poll: see @rpmsg_poll(), optional
51 * @get_signals: see @rpmsg_get_signals(), optional
52 * @set_signals: see @rpmsg_set_signals(), optional
53 *
54 * Indirection table for the operations that a rpmsg backend should implement.
55 * In addition to @destroy_ept, the backend must at least implement @send and
56 * @trysend, while the variants sending data off-channel are optional.
57 */
58 struct rpmsg_endpoint_ops {
59 void (*destroy_ept)(struct rpmsg_endpoint *ept);
60
61 int (*send)(struct rpmsg_endpoint *ept, void *data, int len);
62 int (*sendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
63 int (*send_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
64 void *data, int len);
65
66 int (*trysend)(struct rpmsg_endpoint *ept, void *data, int len);
67 int (*trysendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
68 int (*trysend_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
69 void *data, int len);
70 __poll_t (*poll)(struct rpmsg_endpoint *ept, struct file *filp,
71 poll_table *wait);
72 int (*get_signals)(struct rpmsg_endpoint *ept);
73 int (*set_signals)(struct rpmsg_endpoint *ept, u32 set, u32 clear);
74 };
75
76 int rpmsg_register_device(struct rpmsg_device *rpdev);
77 int rpmsg_unregister_device(struct device *parent,
78 struct rpmsg_channel_info *chinfo);
79
80 struct device *rpmsg_find_device(struct device *parent,
81 struct rpmsg_channel_info *chinfo);
82
83 /**
84 * rpmsg_chrdev_register_device() - register chrdev device based on rpdev
85 * @rpdev: prepared rpdev to be used for creating endpoints
86 *
87 * This function wraps rpmsg_register_device() preparing the rpdev for use as
88 * basis for the rpmsg chrdev.
89 */
rpmsg_chrdev_register_device(struct rpmsg_device * rpdev)90 static inline int rpmsg_chrdev_register_device(struct rpmsg_device *rpdev)
91 {
92 return rpmsg_register_device_override(rpdev, "rpmsg_ctrl");
93 }
94
95 #endif
96