1 // SPDX-License-Identifier: GPL-2.0
8  * Ohad Ben-Cohen <ohad@wizery.com>
16 #include <linux/rpmsg.h>
27  * rpmsg_create_channel() - create a new rpmsg channel
29  * @rpdev: rpmsg device
32  * Return: a pointer to the new rpmsg device on success, or NULL on error.
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
51  * @rpdev: rpmsg device
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
72  * @rpdev: rpmsg channel device
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
82  * bind a callback, and possibly some private data too, to an rpmsg address
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).
91  * endpoint, their rx callback is bound to their rpmsg address, and when
93  * equals to the src address of their rpmsg channel), the driver's handler
97  * additional rpmsg addresses, and bind them to different rx callbacks.
105  * dynamically assign them an available rpmsg address (drivers should have
117 	return rpdev->ops->create_ept(rpdev, cb, priv, chinfo);  in rpmsg_create_ept()
122  * rpmsg_destroy_ept() - destroy an existing rpmsg endpoint
125  * Should be used by drivers to destroy an rpmsg endpoint previously
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
138  * @ept: the rpmsg endpoint
144  * endpoint belongs to, using @ept's address and its associated rpmsg
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
167  * @ept: the rpmsg endpoint
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
196  * @ept: the rpmsg endpoint
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
228  * @ept: the rpmsg endpoint
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
256  * @ept: the rpmsg endpoint
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
284  * @ept:	the rpmsg endpoint
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
304  * @ept: the rpmsg endpoint
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_set_flow_control() - request remote to pause/resume transmission
335  * @ept:	the rpmsg endpoint
344 		return -EINVAL;  in rpmsg_set_flow_control()
345 	if (!ept->ops->set_flow_control)  in rpmsg_set_flow_control()
346 		return -EOPNOTSUPP;  in rpmsg_set_flow_control()
348 	return ept->ops->set_flow_control(ept, pause, dst);  in rpmsg_set_flow_control()
353  * rpmsg_get_mtu() - get maximum transmission buffer size for sending message.
354  * @ept: the rpmsg endpoint
365 		return -EINVAL;  in rpmsg_get_mtu()
366 	if (!ept->ops->get_mtu)  in rpmsg_get_mtu()
367 		return -ENOTSUPP;  in rpmsg_get_mtu()
369 	return ept->ops->get_mtu(ept);  in rpmsg_get_mtu()
374  * match a rpmsg channel with a channel info struct.
375  * this is used to make sure we're not creating rpmsg devices for channels
383 	if (chinfo->src != RPMSG_ADDR_ANY && chinfo->src != rpdev->src)  in rpmsg_device_match()
386 	if (chinfo->dst != RPMSG_ADDR_ANY && chinfo->dst != rpdev->dst)  in rpmsg_device_match()
389 	if (strncmp(chinfo->name, rpdev->id.name, RPMSG_NAME_SIZE))  in rpmsg_device_match()
412 	return sprintf(buf, format_string, rpdev->path);		\
427 		return -ENOMEM;						\
431 	old = rpdev->member;						\
433 		rpdev->member = new;					\
436 		rpdev->member = NULL;					\
450 	return sprintf(buf, "%s\n", rpdev->member);			\
454 /* for more info, see Documentation/ABI/testing/sysfs-bus-rpmsg */
468 	if (len != -ENODEV)  in modalias_show()
471 	return sprintf(buf, RPMSG_DEVICE_MODALIAS_FMT "\n", rpdev->id.name);  in modalias_show()
486 /* rpmsg devices and drivers are matched using the service name */
490 	return strncmp(id->name, rpdev->id.name, RPMSG_NAME_SIZE) == 0;  in rpmsg_id_match()
493 /* match rpmsg channel and rpmsg driver */
498 	const struct rpmsg_device_id *ids = rpdrv->id_table;  in rpmsg_dev_match()
501 	if (rpdev->driver_override)  in rpmsg_dev_match()
502 		return !strcmp(rpdev->driver_override, drv->name);  in rpmsg_dev_match()
507 				rpdev->id.driver_data = ids[i].driver_data;  in rpmsg_dev_match()
520 	if (ret != -ENODEV)  in rpmsg_uevent()
524 					rpdev->id.name);  in rpmsg_uevent()
528  * when an rpmsg driver is probed with a channel, we seamlessly create
529  * it an endpoint, binding its rx callback to a unique local rpmsg
533  * processor (needed in case the driver is exposing an rpmsg service).
538 	struct rpmsg_driver *rpdrv = to_rpmsg_driver(rpdev->dev.driver);  in rpmsg_dev_probe()
545 		goto out;  in rpmsg_dev_probe()
547 	if (rpdrv->callback) {  in rpmsg_dev_probe()
548 		strncpy(chinfo.name, rpdev->id.name, RPMSG_NAME_SIZE);  in rpmsg_dev_probe()
549 		chinfo.src = rpdev->src;  in rpmsg_dev_probe()
552 		ept = rpmsg_create_ept(rpdev, rpdrv->callback, NULL, chinfo);  in rpmsg_dev_probe()
555 			err = -ENOMEM;  in rpmsg_dev_probe()
556 			goto out;  in rpmsg_dev_probe()
559 		rpdev->ept = ept;  in rpmsg_dev_probe()
560 		rpdev->src = ept->addr;  in rpmsg_dev_probe()
562 		ept->flow_cb = rpdrv->flowcontrol;  in rpmsg_dev_probe()
565 	err = rpdrv->probe(rpdev);  in rpmsg_dev_probe()
571 	if (ept && rpdev->ops->announce_create) {  in rpmsg_dev_probe()
572 		err = rpdev->ops->announce_create(rpdev);  in rpmsg_dev_probe()
582 	if (rpdrv->remove)  in rpmsg_dev_probe()
583 		rpdrv->remove(rpdev);  in rpmsg_dev_probe()
587 out:  in rpmsg_dev_probe()
594 	struct rpmsg_driver *rpdrv = to_rpmsg_driver(rpdev->dev.driver);  in rpmsg_dev_remove()
596 	if (rpdev->ops->announce_destroy)  in rpmsg_dev_remove()
597 		rpdev->ops->announce_destroy(rpdev);  in rpmsg_dev_remove()
599 	if (rpdrv->remove)  in rpmsg_dev_remove()
600 		rpdrv->remove(rpdev);  in rpmsg_dev_remove()
604 	if (rpdev->ept)  in rpmsg_dev_remove()
605 		rpmsg_destroy_ept(rpdev->ept);  in rpmsg_dev_remove()
609 	.name		= "rpmsg",
618  * A helper for registering rpmsg device with driver override and name.
624 	struct device *dev = &rpdev->dev;  in rpmsg_register_device_override()
628 		strscpy_pad(rpdev->id.name, driver_override, RPMSG_NAME_SIZE);  in rpmsg_register_device_override()
630 	dev_set_name(dev, "%s.%s.%d.%d", dev_name(dev->parent),  in rpmsg_register_device_override()
631 		     rpdev->id.name, rpdev->src, rpdev->dst);  in rpmsg_register_device_override()
633 	dev->bus = &rpmsg_bus;  in rpmsg_register_device_override()
637 		ret = driver_set_override(dev, &rpdev->driver_override,  in rpmsg_register_device_override()
650 		kfree(rpdev->driver_override);  in rpmsg_register_device_override()
651 		rpdev->driver_override = NULL;  in rpmsg_register_device_override()
676 		return -EINVAL;  in rpmsg_unregister_device()
687  * __register_rpmsg_driver() - register an rpmsg driver with the rpmsg bus
695 	rpdrv->drv.bus = &rpmsg_bus;  in __register_rpmsg_driver()
696 	rpdrv->drv.owner = owner;  in __register_rpmsg_driver()
697 	return driver_register(&rpdrv->drv);  in __register_rpmsg_driver()
702  * unregister_rpmsg_driver() - unregister an rpmsg driver from the rpmsg bus
709 	driver_unregister(&rpdrv->drv);  in unregister_rpmsg_driver()
718 	rpmsg_class = class_create("rpmsg");  in rpmsg_init()
720 		pr_err("failed to create rpmsg class\n");  in rpmsg_init()
726 		pr_err("failed to register rpmsg bus: %d\n", ret);  in rpmsg_init()