1 // SPDX-License-Identifier: GPL-2.0
3  * remote processor messaging bus
8  * Ohad Ben-Cohen <ohad@wizery.com>
27  * rpmsg_create_channel() - create a new rpmsg channel
39 	if (!rpdev->ops || !rpdev->ops->create_channel) {  in rpmsg_create_channel()
40 		dev_err(&rpdev->dev, "no create_channel ops found\n");  in rpmsg_create_channel()
44 	return rpdev->ops->create_channel(rpdev, chinfo);  in rpmsg_create_channel()
49  * rpmsg_release_channel() - release a rpmsg channel
60 		return -EINVAL;  in rpmsg_release_channel()
61 	if (!rpdev->ops || !rpdev->ops->release_channel) {  in rpmsg_release_channel()
62 		dev_err(&rpdev->dev, "no release_channel ops found\n");  in rpmsg_release_channel()
63 		return -ENXIO;  in rpmsg_release_channel()
66 	return rpdev->ops->release_channel(rpdev, chinfo);  in rpmsg_release_channel()
71  * rpmsg_create_ept() - create a new rpmsg_endpoint
78  * inbound messages arrive, they are dispatched by the rpmsg bus using the
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).
101  * to the same remote processor their channel belongs to), an rx callback
117 	return rpdev->ops->create_ept(rpdev, cb, priv, chinfo);  in rpmsg_create_ept()
122  * rpmsg_destroy_ept() - destroy an existing rpmsg endpoint
131 	if (ept && ept->ops)  in rpmsg_destroy_ept()
132 		ept->ops->destroy_ept(ept);  in rpmsg_destroy_ept()
137  * rpmsg_send() - send a message across to the remote processor
143  * The message will be sent to the remote processor which the @ept
148  * happens, -ERESTARTSYS is returned.
157 		return -EINVAL;  in rpmsg_send()
158 	if (!ept->ops->send)  in rpmsg_send()
159 		return -ENXIO;  in rpmsg_send()
161 	return ept->ops->send(ept, data, len);  in rpmsg_send()
166  * rpmsg_sendto() - send a message across to the remote processor, specify dst
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
177  * happens, -ERESTARTSYS is returned.
186 		return -EINVAL;  in rpmsg_sendto()
187 	if (!ept->ops->sendto)  in rpmsg_sendto()
188 		return -ENXIO;  in rpmsg_sendto()
190 	return ept->ops->sendto(ept, data, len, dst);  in rpmsg_sendto()
195  * rpmsg_send_offchannel() - send a message using explicit src/dst addresses
202  * This function sends @data of length @len to the remote @dst address,
204  * The message will be sent to the remote processor which the @ept
208  * happens, -ERESTARTSYS is returned.
218 		return -EINVAL;  in rpmsg_send_offchannel()
219 	if (!ept->ops->send_offchannel)  in rpmsg_send_offchannel()
220 		return -ENXIO;  in rpmsg_send_offchannel()
222 	return ept->ops->send_offchannel(ept, src, dst, data, len);  in rpmsg_send_offchannel()
227  * rpmsg_trysend() - send a message across to the remote processor
233  * The message will be sent to the remote processor which the @ept
237  * return -ENOMEM without waiting until one becomes available.
246 		return -EINVAL;  in rpmsg_trysend()
247 	if (!ept->ops->trysend)  in rpmsg_trysend()
248 		return -ENXIO;  in rpmsg_trysend()
250 	return ept->ops->trysend(ept, data, len);  in rpmsg_trysend()
255  * rpmsg_trysendto() - send a message across to the remote processor, specify dst
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
265  * return -ENOMEM without waiting until one becomes available.
274 		return -EINVAL;  in rpmsg_trysendto()
275 	if (!ept->ops->trysendto)  in rpmsg_trysendto()
276 		return -ENXIO;  in rpmsg_trysendto()
278 	return ept->ops->trysendto(ept, data, len, dst);  in rpmsg_trysendto()
283  * rpmsg_poll() - poll the endpoint's send buffers
295 	if (!ept->ops->poll)  in rpmsg_poll()
298 	return ept->ops->poll(ept, filp, wait);  in rpmsg_poll()
303  * rpmsg_trysend_offchannel() - send a message using explicit src/dst addresses
310  * This function sends @data of length @len to the remote @dst address,
312  * The message will be sent to the remote processor which the @ept
315  * return -ENOMEM without waiting until one becomes available.
325 		return -EINVAL;  in rpmsg_trysend_offchannel()
326 	if (!ept->ops->trysend_offchannel)  in rpmsg_trysend_offchannel()
327 		return -ENXIO;  in rpmsg_trysend_offchannel()
329 	return ept->ops->trysend_offchannel(ept, src, dst, data, len);  in rpmsg_trysend_offchannel()
334  * rpmsg_get_mtu() - get maximum transmission buffer size for sending message.
346 		return -EINVAL;  in rpmsg_get_mtu()
347 	if (!ept->ops->get_mtu)  in rpmsg_get_mtu()
348 		return -ENOTSUPP;  in rpmsg_get_mtu()
350 	return ept->ops->get_mtu(ept);  in rpmsg_get_mtu()
364 	if (chinfo->src != RPMSG_ADDR_ANY && chinfo->src != rpdev->src)  in rpmsg_device_match()
367 	if (chinfo->dst != RPMSG_ADDR_ANY && chinfo->dst != rpdev->dst)  in rpmsg_device_match()
370 	if (strncmp(chinfo->name, rpdev->id.name, RPMSG_NAME_SIZE))  in rpmsg_device_match()
393 	return sprintf(buf, format_string, rpdev->path);		\
408 		return -ENOMEM;						\
412 	old = rpdev->member;						\
414 		rpdev->member = new;					\
417 		rpdev->member = NULL;					\
431 	return sprintf(buf, "%s\n", rpdev->member);			\
435 /* for more info, see Documentation/ABI/testing/sysfs-bus-rpmsg */
449 	if (len != -ENODEV)  in modalias_show()
452 	return sprintf(buf, RPMSG_DEVICE_MODALIAS_FMT "\n", rpdev->id.name);  in modalias_show()
471 	return strncmp(id->name, rpdev->id.name, RPMSG_NAME_SIZE) == 0;  in rpmsg_id_match()
479 	const struct rpmsg_device_id *ids = rpdrv->id_table;  in rpmsg_dev_match()
482 	if (rpdev->driver_override)  in rpmsg_dev_match()
483 		return !strcmp(rpdev->driver_override, drv->name);  in rpmsg_dev_match()
488 				rpdev->id.driver_data = ids[i].driver_data;  in rpmsg_dev_match()
501 	if (ret != -ENODEV)  in rpmsg_uevent()
505 					rpdev->id.name);  in rpmsg_uevent()
513  * if we need to, we also announce about this channel to the remote
519 	struct rpmsg_driver *rpdrv = to_rpmsg_driver(rpdev->dev.driver);  in rpmsg_dev_probe()
528 	if (rpdrv->callback) {  in rpmsg_dev_probe()
529 		strncpy(chinfo.name, rpdev->id.name, RPMSG_NAME_SIZE);  in rpmsg_dev_probe()
530 		chinfo.src = rpdev->src;  in rpmsg_dev_probe()
533 		ept = rpmsg_create_ept(rpdev, rpdrv->callback, NULL, chinfo);  in rpmsg_dev_probe()
536 			err = -ENOMEM;  in rpmsg_dev_probe()
540 		rpdev->ept = ept;  in rpmsg_dev_probe()
541 		rpdev->src = ept->addr;  in rpmsg_dev_probe()
544 	err = rpdrv->probe(rpdev);  in rpmsg_dev_probe()
550 	if (ept && rpdev->ops->announce_create) {  in rpmsg_dev_probe()
551 		err = rpdev->ops->announce_create(rpdev);  in rpmsg_dev_probe()
561 	if (rpdrv->remove)  in rpmsg_dev_probe()
562 		rpdrv->remove(rpdev);  in rpmsg_dev_probe()
573 	struct rpmsg_driver *rpdrv = to_rpmsg_driver(rpdev->dev.driver);  in rpmsg_dev_remove()
575 	if (rpdev->ops->announce_destroy)  in rpmsg_dev_remove()
576 		rpdev->ops->announce_destroy(rpdev);  in rpmsg_dev_remove()
578 	if (rpdrv->remove)  in rpmsg_dev_remove()
579 		rpdrv->remove(rpdev);  in rpmsg_dev_remove()
583 	if (rpdev->ept)  in rpmsg_dev_remove()
584 		rpmsg_destroy_ept(rpdev->ept);  in rpmsg_dev_remove()
603 	struct device *dev = &rpdev->dev;  in rpmsg_register_device_override()
607 		strscpy_pad(rpdev->id.name, driver_override, RPMSG_NAME_SIZE);  in rpmsg_register_device_override()
609 	dev_set_name(dev, "%s.%s.%d.%d", dev_name(dev->parent),  in rpmsg_register_device_override()
610 		     rpdev->id.name, rpdev->src, rpdev->dst);  in rpmsg_register_device_override()
612 	dev->bus = &rpmsg_bus;  in rpmsg_register_device_override()
616 		ret = driver_set_override(dev, &rpdev->driver_override,  in rpmsg_register_device_override()
629 		kfree(rpdev->driver_override);  in rpmsg_register_device_override()
630 		rpdev->driver_override = NULL;  in rpmsg_register_device_override()
655 		return -EINVAL;  in rpmsg_unregister_device()
666  * __register_rpmsg_driver() - register an rpmsg driver with the rpmsg bus
674 	rpdrv->drv.bus = &rpmsg_bus;  in __register_rpmsg_driver()
675 	rpdrv->drv.owner = owner;  in __register_rpmsg_driver()
676 	return driver_register(&rpdrv->drv);  in __register_rpmsg_driver()
681  * unregister_rpmsg_driver() - unregister an rpmsg driver from the rpmsg bus
688 	driver_unregister(&rpdrv->drv);  in unregister_rpmsg_driver()
705 		pr_err("failed to register rpmsg bus: %d\n", ret);  in rpmsg_init()
719 MODULE_DESCRIPTION("remote processor messaging bus");