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 extern struct class *rpmsg_class;
23
24 /**
25 * struct rpmsg_device_ops - indirection table for the rpmsg_device operations
26 * @create_channel: create backend-specific channel, optional
27 * @release_channel: release backend-specific channel, optional
28 * @create_ept: create backend-specific endpoint, required
29 * @announce_create: announce presence of new channel, optional
30 * @announce_destroy: announce destruction of channel, optional
31 *
32 * Indirection table for the operations that a rpmsg backend should implement.
33 * @announce_create and @announce_destroy are optional as the backend might
34 * advertise new channels implicitly by creating the endpoints.
35 */
36 struct rpmsg_device_ops {
37 struct rpmsg_device *(*create_channel)(struct rpmsg_device *rpdev,
38 struct rpmsg_channel_info *chinfo);
39 int (*release_channel)(struct rpmsg_device *rpdev,
40 struct rpmsg_channel_info *chinfo);
41 struct rpmsg_endpoint *(*create_ept)(struct rpmsg_device *rpdev,
42 rpmsg_rx_cb_t cb, void *priv,
43 struct rpmsg_channel_info chinfo);
44
45 int (*announce_create)(struct rpmsg_device *ept);
46 int (*announce_destroy)(struct rpmsg_device *ept);
47 };
48
49 /**
50 * struct rpmsg_endpoint_ops - indirection table for rpmsg_endpoint operations
51 * @destroy_ept: see @rpmsg_destroy_ept(), required
52 * @send: see @rpmsg_send(), required
53 * @sendto: see @rpmsg_sendto(), optional
54 * @send_offchannel: see @rpmsg_send_offchannel(), optional
55 * @trysend: see @rpmsg_trysend(), required
56 * @trysendto: see @rpmsg_trysendto(), optional
57 * @trysend_offchannel: see @rpmsg_trysend_offchannel(), optional
58 * @poll: see @rpmsg_poll(), optional
59 * @get_signals: see @rpmsg_get_signals(), optional
60 * @set_signals: see @rpmsg_set_signals(), optional
61 *
62 * Indirection table for the operations that a rpmsg backend should implement.
63 * In addition to @destroy_ept, the backend must at least implement @send and
64 * @trysend, while the variants sending data off-channel are optional.
65 */
66 struct rpmsg_endpoint_ops {
67 void (*destroy_ept)(struct rpmsg_endpoint *ept);
68
69 int (*send)(struct rpmsg_endpoint *ept, void *data, int len);
70 int (*sendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
71 int (*send_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
72 void *data, int len);
73
74 int (*trysend)(struct rpmsg_endpoint *ept, void *data, int len);
75 int (*trysendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
76 int (*trysend_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
77 void *data, int len);
78 __poll_t (*poll)(struct rpmsg_endpoint *ept, struct file *filp,
79 poll_table *wait);
80 int (*rx_done)(struct rpmsg_endpoint *ept, void *data);
81 int (*get_signals)(struct rpmsg_endpoint *ept);
82 int (*set_signals)(struct rpmsg_endpoint *ept, u32 set, u32 clear);
83 };
84
85 struct device *rpmsg_find_device(struct device *parent,
86 struct rpmsg_channel_info *chinfo);
87
88 struct rpmsg_device *rpmsg_create_channel(struct rpmsg_device *rpdev,
89 struct rpmsg_channel_info *chinfo);
90 int rpmsg_release_channel(struct rpmsg_device *rpdev,
91 struct rpmsg_channel_info *chinfo);
92 /**
93 * rpmsg_ctrldev_register_device() - register a char device for control based on rpdev
94 * @rpdev: prepared rpdev to be used for creating endpoints
95 *
96 * This function wraps rpmsg_register_device() preparing the rpdev for use as
97 * basis for the rpmsg chrdev.
98 */
rpmsg_ctrldev_register_device(struct rpmsg_device * rpdev)99 static inline int rpmsg_ctrldev_register_device(struct rpmsg_device *rpdev)
100 {
101 return rpmsg_register_device_override(rpdev, "rpmsg_ctrl");
102 }
103
104 #endif
105