1 // SPDX-License-Identifier: GPL-2.0
3 * remote processor messaging bus
5 * Copyright (C) 2011 Texas Instruments, Inc.
6 * Copyright (C) 2011 Google, Inc.
8 * Ohad Ben-Cohen <ohad@wizery.com>
9 * Brian Swetland <swetland@google.com>
12 #define pr_fmt(fmt) "%s: " fmt, __func__
14 #include <linux/kernel.h>
15 #include <linux/module.h>
16 #include <linux/rpmsg.h>
17 #include <linux/of_device.h>
18 #include <linux/pm_domain.h>
19 #include <linux/slab.h>
21 #include "rpmsg_internal.h"
23 struct class *rpmsg_class;
24 EXPORT_SYMBOL(rpmsg_class);
27 * rpmsg_create_channel() - create a new rpmsg channel
28 * using its name and address info.
29 * @rpdev: rpmsg device
30 * @chinfo: channel_info to bind
32 * Return: a pointer to the new rpmsg device on success, or NULL on error.
34 struct rpmsg_device *rpmsg_create_channel(struct rpmsg_device *rpdev,
35 struct rpmsg_channel_info *chinfo)
39 if (!rpdev->ops || !rpdev->ops->create_channel) {
40 dev_err(&rpdev->dev, "no create_channel ops found\n");
44 return rpdev->ops->create_channel(rpdev, chinfo);
46 EXPORT_SYMBOL(rpmsg_create_channel);
49 * rpmsg_release_channel() - release a rpmsg channel
50 * using its name and address info.
51 * @rpdev: rpmsg device
52 * @chinfo: channel_info to bind
54 * Return: 0 on success or an appropriate error value.
56 int rpmsg_release_channel(struct rpmsg_device *rpdev,
57 struct rpmsg_channel_info *chinfo)
61 if (!rpdev->ops || !rpdev->ops->release_channel) {
62 dev_err(&rpdev->dev, "no release_channel ops found\n");
66 return rpdev->ops->release_channel(rpdev, chinfo);
68 EXPORT_SYMBOL(rpmsg_release_channel);
71 * rpmsg_create_ept() - create a new rpmsg_endpoint
72 * @rpdev: rpmsg channel device
73 * @cb: rx callback handler
74 * @priv: private data for the driver's use
75 * @chinfo: channel_info with the local rpmsg address to bind with @cb
77 * Every rpmsg address in the system is bound to an rx callback (so when
78 * inbound messages arrive, they are dispatched by the rpmsg bus using the
79 * appropriate callback handler) by means of an rpmsg_endpoint struct.
81 * This function allows drivers to create such an endpoint, and by that,
82 * bind a callback, and possibly some private data too, to an rpmsg address
83 * (either one that is known in advance, or one that will be dynamically
86 * Simple rpmsg drivers need not call rpmsg_create_ept, because an endpoint
87 * is already created for them when they are probed by the rpmsg bus
88 * (using the rx callback provided when they registered to the rpmsg bus).
90 * So things should just work for simple drivers: they already have an
91 * endpoint, their rx callback is bound to their rpmsg address, and when
92 * relevant inbound messages arrive (i.e. messages which their dst address
93 * equals to the src address of their rpmsg channel), the driver's handler
94 * is invoked to process it.
96 * That said, more complicated drivers might need to allocate
97 * additional rpmsg addresses, and bind them to different rx callbacks.
98 * To accomplish that, those drivers need to call this function.
100 * Drivers should provide their @rpdev channel (so the new endpoint would belong
101 * to the same remote processor their channel belongs to), an rx callback
102 * function, an optional private data (which is provided back when the
103 * rx callback is invoked), and an address they want to bind with the
104 * callback. If @addr is RPMSG_ADDR_ANY, then rpmsg_create_ept will
105 * dynamically assign them an available rpmsg address (drivers should have
106 * a very good reason why not to always use RPMSG_ADDR_ANY here).
108 * Return: a pointer to the endpoint on success, or NULL on error.
110 struct rpmsg_endpoint *rpmsg_create_ept(struct rpmsg_device *rpdev,
111 rpmsg_rx_cb_t cb, void *priv,
112 struct rpmsg_channel_info chinfo)
117 return rpdev->ops->create_ept(rpdev, cb, priv, chinfo);
119 EXPORT_SYMBOL(rpmsg_create_ept);
122 * rpmsg_destroy_ept() - destroy an existing rpmsg endpoint
123 * @ept: endpoing to destroy
125 * Should be used by drivers to destroy an rpmsg endpoint previously
126 * created with rpmsg_create_ept(). As with other types of "free" NULL
127 * is a valid parameter.
129 void rpmsg_destroy_ept(struct rpmsg_endpoint *ept)
132 ept->ops->destroy_ept(ept);
134 EXPORT_SYMBOL(rpmsg_destroy_ept);
137 * rpmsg_send() - send a message across to the remote processor
138 * @ept: the rpmsg endpoint
139 * @data: payload of message
140 * @len: length of payload
142 * This function sends @data of length @len on the @ept endpoint.
143 * The message will be sent to the remote processor which the @ept
144 * endpoint belongs to, using @ept's address and its associated rpmsg
145 * device destination addresses.
146 * In case there are no TX buffers available, the function will block until
147 * one becomes available, or a timeout of 15 seconds elapses. When the latter
148 * happens, -ERESTARTSYS is returned.
150 * Can only be called from process context (for now).
152 * Return: 0 on success and an appropriate error value on failure.
154 int rpmsg_send(struct rpmsg_endpoint *ept, void *data, int len)
161 return ept->ops->send(ept, data, len);
163 EXPORT_SYMBOL(rpmsg_send);
166 * rpmsg_sendto() - send a message across to the remote processor, specify dst
167 * @ept: the rpmsg endpoint
168 * @data: payload of message
169 * @len: length of payload
170 * @dst: destination address
172 * This function sends @data of length @len to the remote @dst address.
173 * The message will be sent to the remote processor which the @ept
174 * endpoint belongs to, using @ept's address as source.
175 * In case there are no TX buffers available, the function will block until
176 * one becomes available, or a timeout of 15 seconds elapses. When the latter
177 * happens, -ERESTARTSYS is returned.
179 * Can only be called from process context (for now).
181 * Return: 0 on success and an appropriate error value on failure.
183 int rpmsg_sendto(struct rpmsg_endpoint *ept, void *data, int len, u32 dst)
187 if (!ept->ops->sendto)
190 return ept->ops->sendto(ept, data, len, dst);
192 EXPORT_SYMBOL(rpmsg_sendto);
195 * rpmsg_send_offchannel() - send a message using explicit src/dst addresses
196 * @ept: the rpmsg endpoint
197 * @src: source address
198 * @dst: destination address
199 * @data: payload of message
200 * @len: length of payload
202 * This function sends @data of length @len to the remote @dst address,
203 * and uses @src as the source address.
204 * The message will be sent to the remote processor which the @ept
205 * endpoint belongs to.
206 * In case there are no TX buffers available, the function will block until
207 * one becomes available, or a timeout of 15 seconds elapses. When the latter
208 * happens, -ERESTARTSYS is returned.
210 * Can only be called from process context (for now).
212 * Return: 0 on success and an appropriate error value on failure.
214 int rpmsg_send_offchannel(struct rpmsg_endpoint *ept, u32 src, u32 dst,
219 if (!ept->ops->send_offchannel)
222 return ept->ops->send_offchannel(ept, src, dst, data, len);
224 EXPORT_SYMBOL(rpmsg_send_offchannel);
227 * rpmsg_trysend() - send a message across to the remote processor
228 * @ept: the rpmsg endpoint
229 * @data: payload of message
230 * @len: length of payload
232 * This function sends @data of length @len on the @ept endpoint.
233 * The message will be sent to the remote processor which the @ept
234 * endpoint belongs to, using @ept's address as source and its associated
235 * rpdev's address as destination.
236 * In case there are no TX buffers available, the function will immediately
237 * return -ENOMEM without waiting until one becomes available.
239 * Can only be called from process context (for now).
241 * Return: 0 on success and an appropriate error value on failure.
243 int rpmsg_trysend(struct rpmsg_endpoint *ept, void *data, int len)
247 if (!ept->ops->trysend)
250 return ept->ops->trysend(ept, data, len);
252 EXPORT_SYMBOL(rpmsg_trysend);
255 * rpmsg_trysendto() - send a message across to the remote processor, specify dst
256 * @ept: the rpmsg endpoint
257 * @data: payload of message
258 * @len: length of payload
259 * @dst: destination address
261 * This function sends @data of length @len to the remote @dst address.
262 * The message will be sent to the remote processor which the @ept
263 * endpoint belongs to, using @ept's address as source.
264 * In case there are no TX buffers available, the function will immediately
265 * return -ENOMEM without waiting until one becomes available.
267 * Can only be called from process context (for now).
269 * Return: 0 on success and an appropriate error value on failure.
271 int rpmsg_trysendto(struct rpmsg_endpoint *ept, void *data, int len, u32 dst)
275 if (!ept->ops->trysendto)
278 return ept->ops->trysendto(ept, data, len, dst);
280 EXPORT_SYMBOL(rpmsg_trysendto);
283 * rpmsg_poll() - poll the endpoint's send buffers
284 * @ept: the rpmsg endpoint
285 * @filp: file for poll_wait()
286 * @wait: poll_table for poll_wait()
288 * Return: mask representing the current state of the endpoint's send buffers
290 __poll_t rpmsg_poll(struct rpmsg_endpoint *ept, struct file *filp,
298 return ept->ops->poll(ept, filp, wait);
300 EXPORT_SYMBOL(rpmsg_poll);
303 * rpmsg_trysend_offchannel() - send a message using explicit src/dst addresses
304 * @ept: the rpmsg endpoint
305 * @src: source address
306 * @dst: destination address
307 * @data: payload of message
308 * @len: length of payload
310 * This function sends @data of length @len to the remote @dst address,
311 * and uses @src as the source address.
312 * The message will be sent to the remote processor which the @ept
313 * endpoint belongs to.
314 * In case there are no TX buffers available, the function will immediately
315 * return -ENOMEM without waiting until one becomes available.
317 * Can only be called from process context (for now).
319 * Return: 0 on success and an appropriate error value on failure.
321 int rpmsg_trysend_offchannel(struct rpmsg_endpoint *ept, u32 src, u32 dst,
326 if (!ept->ops->trysend_offchannel)
329 return ept->ops->trysend_offchannel(ept, src, dst, data, len);
331 EXPORT_SYMBOL(rpmsg_trysend_offchannel);
334 * rpmsg_get_mtu() - get maximum transmission buffer size for sending message.
335 * @ept: the rpmsg endpoint
337 * This function returns maximum buffer size available for a single outgoing message.
339 * Return: the maximum transmission size on success and an appropriate error
343 ssize_t rpmsg_get_mtu(struct rpmsg_endpoint *ept)
347 if (!ept->ops->get_mtu)
350 return ept->ops->get_mtu(ept);
352 EXPORT_SYMBOL(rpmsg_get_mtu);
355 * match a rpmsg channel with a channel info struct.
356 * this is used to make sure we're not creating rpmsg devices for channels
357 * that already exist.
359 static int rpmsg_device_match(struct device *dev, void *data)
361 struct rpmsg_channel_info *chinfo = data;
362 struct rpmsg_device *rpdev = to_rpmsg_device(dev);
364 if (chinfo->src != RPMSG_ADDR_ANY && chinfo->src != rpdev->src)
367 if (chinfo->dst != RPMSG_ADDR_ANY && chinfo->dst != rpdev->dst)
370 if (strncmp(chinfo->name, rpdev->id.name, RPMSG_NAME_SIZE))
373 /* found a match ! */
377 struct device *rpmsg_find_device(struct device *parent,
378 struct rpmsg_channel_info *chinfo)
380 return device_find_child(parent, chinfo, rpmsg_device_match);
383 EXPORT_SYMBOL(rpmsg_find_device);
385 /* sysfs show configuration fields */
386 #define rpmsg_show_attr(field, path, format_string) \
388 field##_show(struct device *dev, \
389 struct device_attribute *attr, char *buf) \
391 struct rpmsg_device *rpdev = to_rpmsg_device(dev); \
393 return sprintf(buf, format_string, rpdev->path); \
395 static DEVICE_ATTR_RO(field);
397 #define rpmsg_string_attr(field, member) \
399 field##_store(struct device *dev, struct device_attribute *attr, \
400 const char *buf, size_t sz) \
402 struct rpmsg_device *rpdev = to_rpmsg_device(dev); \
406 new = kstrndup(buf, sz, GFP_KERNEL); \
409 new[strcspn(new, "\n")] = '\0'; \
412 old = rpdev->member; \
414 rpdev->member = new; \
417 rpdev->member = NULL; \
419 device_unlock(dev); \
426 field##_show(struct device *dev, \
427 struct device_attribute *attr, char *buf) \
429 struct rpmsg_device *rpdev = to_rpmsg_device(dev); \
431 return sprintf(buf, "%s\n", rpdev->member); \
433 static DEVICE_ATTR_RW(field)
435 /* for more info, see Documentation/ABI/testing/sysfs-bus-rpmsg */
436 rpmsg_show_attr(name, id.name, "%s\n");
437 rpmsg_show_attr(src, src, "0x%x\n");
438 rpmsg_show_attr(dst, dst, "0x%x\n");
439 rpmsg_show_attr(announce, announce ? "true" : "false", "%s\n");
440 rpmsg_string_attr(driver_override, driver_override);
442 static ssize_t modalias_show(struct device *dev,
443 struct device_attribute *attr, char *buf)
445 struct rpmsg_device *rpdev = to_rpmsg_device(dev);
448 len = of_device_modalias(dev, buf, PAGE_SIZE);
452 return sprintf(buf, RPMSG_DEVICE_MODALIAS_FMT "\n", rpdev->id.name);
454 static DEVICE_ATTR_RO(modalias);
456 static struct attribute *rpmsg_dev_attrs[] = {
458 &dev_attr_modalias.attr,
461 &dev_attr_announce.attr,
462 &dev_attr_driver_override.attr,
465 ATTRIBUTE_GROUPS(rpmsg_dev);
467 /* rpmsg devices and drivers are matched using the service name */
468 static inline int rpmsg_id_match(const struct rpmsg_device *rpdev,
469 const struct rpmsg_device_id *id)
471 return strncmp(id->name, rpdev->id.name, RPMSG_NAME_SIZE) == 0;
474 /* match rpmsg channel and rpmsg driver */
475 static int rpmsg_dev_match(struct device *dev, struct device_driver *drv)
477 struct rpmsg_device *rpdev = to_rpmsg_device(dev);
478 struct rpmsg_driver *rpdrv = to_rpmsg_driver(drv);
479 const struct rpmsg_device_id *ids = rpdrv->id_table;
482 if (rpdev->driver_override)
483 return !strcmp(rpdev->driver_override, drv->name);
486 for (i = 0; ids[i].name[0]; i++)
487 if (rpmsg_id_match(rpdev, &ids[i])) {
488 rpdev->id.driver_data = ids[i].driver_data;
492 return of_driver_match_device(dev, drv);
495 static int rpmsg_uevent(struct device *dev, struct kobj_uevent_env *env)
497 struct rpmsg_device *rpdev = to_rpmsg_device(dev);
500 ret = of_device_uevent_modalias(dev, env);
504 return add_uevent_var(env, "MODALIAS=" RPMSG_DEVICE_MODALIAS_FMT,
509 * when an rpmsg driver is probed with a channel, we seamlessly create
510 * it an endpoint, binding its rx callback to a unique local rpmsg
513 * if we need to, we also announce about this channel to the remote
514 * processor (needed in case the driver is exposing an rpmsg service).
516 static int rpmsg_dev_probe(struct device *dev)
518 struct rpmsg_device *rpdev = to_rpmsg_device(dev);
519 struct rpmsg_driver *rpdrv = to_rpmsg_driver(rpdev->dev.driver);
520 struct rpmsg_channel_info chinfo = {};
521 struct rpmsg_endpoint *ept = NULL;
524 err = dev_pm_domain_attach(dev, true);
528 if (rpdrv->callback) {
529 strncpy(chinfo.name, rpdev->id.name, RPMSG_NAME_SIZE);
530 chinfo.src = rpdev->src;
531 chinfo.dst = RPMSG_ADDR_ANY;
533 ept = rpmsg_create_ept(rpdev, rpdrv->callback, NULL, chinfo);
535 dev_err(dev, "failed to create endpoint\n");
541 rpdev->src = ept->addr;
544 err = rpdrv->probe(rpdev);
546 dev_err(dev, "%s: failed: %d\n", __func__, err);
550 if (ept && rpdev->ops->announce_create) {
551 err = rpdev->ops->announce_create(rpdev);
553 dev_err(dev, "failed to announce creation\n");
562 rpdrv->remove(rpdev);
565 rpmsg_destroy_ept(ept);
570 static void rpmsg_dev_remove(struct device *dev)
572 struct rpmsg_device *rpdev = to_rpmsg_device(dev);
573 struct rpmsg_driver *rpdrv = to_rpmsg_driver(rpdev->dev.driver);
575 if (rpdev->ops->announce_destroy)
576 rpdev->ops->announce_destroy(rpdev);
579 rpdrv->remove(rpdev);
581 dev_pm_domain_detach(dev, true);
584 rpmsg_destroy_ept(rpdev->ept);
587 static struct bus_type rpmsg_bus = {
589 .match = rpmsg_dev_match,
590 .dev_groups = rpmsg_dev_groups,
591 .uevent = rpmsg_uevent,
592 .probe = rpmsg_dev_probe,
593 .remove = rpmsg_dev_remove,
597 * A helper for registering rpmsg device with driver override and name.
598 * Drivers should not be using it, but instead rpmsg_register_device().
600 int rpmsg_register_device_override(struct rpmsg_device *rpdev,
601 const char *driver_override)
603 struct device *dev = &rpdev->dev;
607 strscpy_pad(rpdev->id.name, driver_override, RPMSG_NAME_SIZE);
609 dev_set_name(dev, "%s.%s.%d.%d", dev_name(dev->parent),
610 rpdev->id.name, rpdev->src, rpdev->dst);
612 dev->bus = &rpmsg_bus;
614 device_initialize(dev);
615 if (driver_override) {
616 ret = driver_set_override(dev, &rpdev->driver_override,
618 strlen(driver_override));
620 dev_err(dev, "device_set_override failed: %d\n", ret);
626 ret = device_add(dev);
628 dev_err(dev, "device_add failed: %d\n", ret);
629 kfree(rpdev->driver_override);
630 rpdev->driver_override = NULL;
636 EXPORT_SYMBOL(rpmsg_register_device_override);
638 int rpmsg_register_device(struct rpmsg_device *rpdev)
640 return rpmsg_register_device_override(rpdev, NULL);
642 EXPORT_SYMBOL(rpmsg_register_device);
645 * find an existing channel using its name + address properties,
648 int rpmsg_unregister_device(struct device *parent,
649 struct rpmsg_channel_info *chinfo)
653 dev = rpmsg_find_device(parent, chinfo);
657 device_unregister(dev);
663 EXPORT_SYMBOL(rpmsg_unregister_device);
666 * __register_rpmsg_driver() - register an rpmsg driver with the rpmsg bus
667 * @rpdrv: pointer to a struct rpmsg_driver
668 * @owner: owning module/driver
670 * Return: 0 on success, and an appropriate error value on failure.
672 int __register_rpmsg_driver(struct rpmsg_driver *rpdrv, struct module *owner)
674 rpdrv->drv.bus = &rpmsg_bus;
675 rpdrv->drv.owner = owner;
676 return driver_register(&rpdrv->drv);
678 EXPORT_SYMBOL(__register_rpmsg_driver);
681 * unregister_rpmsg_driver() - unregister an rpmsg driver from the rpmsg bus
682 * @rpdrv: pointer to a struct rpmsg_driver
684 * Return: 0 on success, and an appropriate error value on failure.
686 void unregister_rpmsg_driver(struct rpmsg_driver *rpdrv)
688 driver_unregister(&rpdrv->drv);
690 EXPORT_SYMBOL(unregister_rpmsg_driver);
693 static int __init rpmsg_init(void)
697 rpmsg_class = class_create(THIS_MODULE, "rpmsg");
698 if (IS_ERR(rpmsg_class)) {
699 pr_err("failed to create rpmsg class\n");
700 return PTR_ERR(rpmsg_class);
703 ret = bus_register(&rpmsg_bus);
705 pr_err("failed to register rpmsg bus: %d\n", ret);
706 class_destroy(rpmsg_class);
710 postcore_initcall(rpmsg_init);
712 static void __exit rpmsg_fini(void)
714 bus_unregister(&rpmsg_bus);
715 class_destroy(rpmsg_class);
717 module_exit(rpmsg_fini);
719 MODULE_DESCRIPTION("remote processor messaging bus");
720 MODULE_LICENSE("GPL v2");