1 /*
2  * remote processor messaging bus internals
3  *
4  * Copyright (C) 2011 Texas Instruments, Inc.
5  * Copyright (C) 2011 Google, Inc.
6  *
7  * Ohad Ben-Cohen <ohad@wizery.com>
8  * Brian Swetland <swetland@google.com>
9  *
10  * This software is licensed under the terms of the GNU General Public
11  * License version 2, as published by the Free Software Foundation, and
12  * may be copied, distributed, and modified under those terms.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  */
19 
20 #ifndef __RPMSG_INTERNAL_H__
21 #define __RPMSG_INTERNAL_H__
22 
23 #include <linux/rpmsg.h>
24 
25 #define to_rpmsg_device(d) container_of(d, struct rpmsg_device, dev)
26 #define to_rpmsg_driver(d) container_of(d, struct rpmsg_driver, drv)
27 
28 /**
29  * struct rpmsg_device_ops - indirection table for the rpmsg_device operations
30  * @create_ept:		create backend-specific endpoint, requried
31  * @announce_create:	announce presence of new channel, optional
32  * @announce_destroy:	announce destruction of channel, optional
33  *
34  * Indirection table for the operations that a rpmsg backend should implement.
35  * @announce_create and @announce_destroy are optional as the backend might
36  * advertise new channels implicitly by creating the endpoints.
37  */
38 struct rpmsg_device_ops {
39 	struct rpmsg_endpoint *(*create_ept)(struct rpmsg_device *rpdev,
40 					    rpmsg_rx_cb_t cb, void *priv,
41 					    struct rpmsg_channel_info chinfo);
42 
43 	int (*announce_create)(struct rpmsg_device *ept);
44 	int (*announce_destroy)(struct rpmsg_device *ept);
45 };
46 
47 /**
48  * struct rpmsg_endpoint_ops - indirection table for rpmsg_endpoint operations
49  * @destroy_ept:	destroy the given endpoint, required
50  * @send:		see @rpmsg_send(), required
51  * @sendto:		see @rpmsg_sendto(), optional
52  * @send_offchannel:	see @rpmsg_send_offchannel(), optional
53  * @trysend:		see @rpmsg_trysend(), required
54  * @trysendto:		see @rpmsg_trysendto(), optional
55  * @trysend_offchannel:	see @rpmsg_trysend_offchannel(), optional
56  *
57  * Indirection table for the operations that a rpmsg backend should implement.
58  * In addition to @destroy_ept, the backend must at least implement @send and
59  * @trysend, while the variants sending data off-channel are optional.
60  */
61 struct rpmsg_endpoint_ops {
62 	void (*destroy_ept)(struct rpmsg_endpoint *ept);
63 
64 	int (*send)(struct rpmsg_endpoint *ept, void *data, int len);
65 	int (*sendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
66 	int (*send_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
67 				  void *data, int len);
68 
69 	int (*trysend)(struct rpmsg_endpoint *ept, void *data, int len);
70 	int (*trysendto)(struct rpmsg_endpoint *ept, void *data, int len, u32 dst);
71 	int (*trysend_offchannel)(struct rpmsg_endpoint *ept, u32 src, u32 dst,
72 			     void *data, int len);
73 };
74 
75 int rpmsg_register_device(struct rpmsg_device *rpdev);
76 int rpmsg_unregister_device(struct device *parent,
77 			    struct rpmsg_channel_info *chinfo);
78 
79 struct device *rpmsg_find_device(struct device *parent,
80 				 struct rpmsg_channel_info *chinfo);
81 
82 #endif
83