1 // SPDX-License-Identifier: GPL-2.0
2 // Copyright (c) 2011-2017, The Linux Foundation. All rights reserved.
3 // Copyright (c) 2018, Linaro Limited
5 #include <linux/kernel.h>
6 #include <linux/module.h>
7 #include <linux/device.h>
8 #include <linux/spinlock.h>
10 #include <linux/slab.h>
11 #include <linux/workqueue.h>
12 #include <linux/of_device.h>
13 #include <linux/soc/qcom/apr.h>
14 #include <linux/soc/qcom/pdr.h>
15 #include <linux/rpmsg.h>
23 /* Some random values tbh which does not collide with static modules */
24 #define GPR_DYNAMIC_PORT_START 0x10000000
25 #define GPR_DYNAMIC_PORT_END 0x20000000
27 struct packet_router {
28 struct rpmsg_endpoint *ch;
35 struct pdr_handle *pdr;
36 struct workqueue_struct *rxwq;
37 struct work_struct rx_work;
38 struct list_head rx_list;
42 struct list_head node;
48 * apr_send_pkt() - Send a apr message from apr device
50 * @adev: Pointer to previously registered apr device.
51 * @pkt: Pointer to apr packet to send
53 * Return: Will be an negative on packet size on success.
55 int apr_send_pkt(struct apr_device *adev, struct apr_pkt *pkt)
57 struct packet_router *apr = dev_get_drvdata(adev->dev.parent);
62 spin_lock_irqsave(&adev->svc.lock, flags);
65 hdr->src_domain = APR_DOMAIN_APPS;
66 hdr->src_svc = adev->svc.id;
67 hdr->dest_domain = adev->domain_id;
68 hdr->dest_svc = adev->svc.id;
70 ret = rpmsg_trysend(apr->ch, pkt, hdr->pkt_size);
71 spin_unlock_irqrestore(&adev->svc.lock, flags);
73 return ret ? ret : hdr->pkt_size;
75 EXPORT_SYMBOL_GPL(apr_send_pkt);
77 void gpr_free_port(gpr_port_t *port)
79 struct packet_router *gpr = port->pr;
82 spin_lock_irqsave(&gpr->svcs_lock, flags);
83 idr_remove(&gpr->svcs_idr, port->id);
84 spin_unlock_irqrestore(&gpr->svcs_lock, flags);
88 EXPORT_SYMBOL_GPL(gpr_free_port);
90 gpr_port_t *gpr_alloc_port(struct apr_device *gdev, struct device *dev,
91 gpr_port_cb cb, void *priv)
93 struct packet_router *pr = dev_get_drvdata(gdev->dev.parent);
95 struct pkt_router_svc *svc;
98 port = kzalloc(sizeof(*port), GFP_KERNEL);
100 return ERR_PTR(-ENOMEM);
107 spin_lock_init(&svc->lock);
109 spin_lock(&pr->svcs_lock);
110 id = idr_alloc_cyclic(&pr->svcs_idr, svc, GPR_DYNAMIC_PORT_START,
111 GPR_DYNAMIC_PORT_END, GFP_ATOMIC);
113 dev_err(dev, "Unable to allocate dynamic GPR src port\n");
115 spin_unlock(&pr->svcs_lock);
120 spin_unlock(&pr->svcs_lock);
124 EXPORT_SYMBOL_GPL(gpr_alloc_port);
126 static int pkt_router_send_svc_pkt(struct pkt_router_svc *svc, struct gpr_pkt *pkt)
128 struct packet_router *pr = svc->pr;
135 spin_lock_irqsave(&svc->lock, flags);
136 ret = rpmsg_trysend(pr->ch, pkt, hdr->pkt_size);
137 spin_unlock_irqrestore(&svc->lock, flags);
139 return ret ? ret : hdr->pkt_size;
142 int gpr_send_pkt(struct apr_device *gdev, struct gpr_pkt *pkt)
144 return pkt_router_send_svc_pkt(&gdev->svc, pkt);
146 EXPORT_SYMBOL_GPL(gpr_send_pkt);
148 int gpr_send_port_pkt(gpr_port_t *port, struct gpr_pkt *pkt)
150 return pkt_router_send_svc_pkt(port, pkt);
152 EXPORT_SYMBOL_GPL(gpr_send_port_pkt);
154 static void apr_dev_release(struct device *dev)
156 struct apr_device *adev = to_apr_device(dev);
161 static int apr_callback(struct rpmsg_device *rpdev, void *buf,
162 int len, void *priv, u32 addr)
164 struct packet_router *apr = dev_get_drvdata(&rpdev->dev);
165 struct apr_rx_buf *abuf;
168 if (len <= APR_HDR_SIZE) {
169 dev_err(apr->dev, "APR: Improper apr pkt received:%p %d\n",
174 abuf = kzalloc(sizeof(*abuf) + len, GFP_ATOMIC);
179 memcpy(abuf->buf, buf, len);
181 spin_lock_irqsave(&apr->rx_lock, flags);
182 list_add_tail(&abuf->node, &apr->rx_list);
183 spin_unlock_irqrestore(&apr->rx_lock, flags);
185 queue_work(apr->rxwq, &apr->rx_work);
190 static int apr_do_rx_callback(struct packet_router *apr, struct apr_rx_buf *abuf)
192 uint16_t hdr_size, msg_type, ver, svc_id;
193 struct pkt_router_svc *svc;
194 struct apr_device *adev;
195 struct apr_driver *adrv = NULL;
196 struct apr_resp_pkt resp;
199 void *buf = abuf->buf;
203 ver = APR_HDR_FIELD_VER(hdr->hdr_field);
204 if (ver > APR_PKT_VER + 1)
207 hdr_size = APR_HDR_FIELD_SIZE_BYTES(hdr->hdr_field);
208 if (hdr_size < APR_HDR_SIZE) {
209 dev_err(apr->dev, "APR: Wrong hdr size:%d\n", hdr_size);
213 if (hdr->pkt_size < APR_HDR_SIZE || hdr->pkt_size != len) {
214 dev_err(apr->dev, "APR: Wrong packet size\n");
218 msg_type = APR_HDR_FIELD_MT(hdr->hdr_field);
219 if (msg_type >= APR_MSG_TYPE_MAX) {
220 dev_err(apr->dev, "APR: Wrong message type: %d\n", msg_type);
224 if (hdr->src_domain >= APR_DOMAIN_MAX ||
225 hdr->dest_domain >= APR_DOMAIN_MAX ||
226 hdr->src_svc >= APR_SVC_MAX ||
227 hdr->dest_svc >= APR_SVC_MAX) {
228 dev_err(apr->dev, "APR: Wrong APR header\n");
232 svc_id = hdr->dest_svc;
233 spin_lock_irqsave(&apr->svcs_lock, flags);
234 svc = idr_find(&apr->svcs_idr, svc_id);
235 if (svc && svc->dev->driver) {
236 adev = svc_to_apr_device(svc);
237 adrv = to_apr_driver(adev->dev.driver);
239 spin_unlock_irqrestore(&apr->svcs_lock, flags);
241 if (!adrv || !adev) {
242 dev_err(apr->dev, "APR: service is not registered (%d)\n",
248 resp.payload_size = hdr->pkt_size - hdr_size;
251 * NOTE: hdr_size is not same as APR_HDR_SIZE as remote can include
252 * optional headers in to apr_hdr which should be ignored
254 if (resp.payload_size > 0)
255 resp.payload = buf + hdr_size;
257 adrv->callback(adev, &resp);
262 static int gpr_do_rx_callback(struct packet_router *gpr, struct apr_rx_buf *abuf)
264 uint16_t hdr_size, ver;
265 struct pkt_router_svc *svc = NULL;
266 struct gpr_resp_pkt resp;
269 void *buf = abuf->buf;
274 if (ver > GPR_PKT_VER + 1)
277 hdr_size = hdr->hdr_size;
278 if (hdr_size < GPR_PKT_HEADER_WORD_SIZE) {
279 dev_err(gpr->dev, "GPR: Wrong hdr size:%d\n", hdr_size);
283 if (hdr->pkt_size < GPR_PKT_HEADER_BYTE_SIZE || hdr->pkt_size != len) {
284 dev_err(gpr->dev, "GPR: Wrong packet size\n");
289 resp.payload_size = hdr->pkt_size - (hdr_size * 4);
292 * NOTE: hdr_size is not same as GPR_HDR_SIZE as remote can include
293 * optional headers in to gpr_hdr which should be ignored
295 if (resp.payload_size > 0)
296 resp.payload = buf + (hdr_size * 4);
299 spin_lock_irqsave(&gpr->svcs_lock, flags);
300 svc = idr_find(&gpr->svcs_idr, hdr->dest_port);
301 spin_unlock_irqrestore(&gpr->svcs_lock, flags);
304 dev_err(gpr->dev, "GPR: Port(%x) is not registered\n",
310 svc->callback(&resp, svc->priv, 0);
315 static void apr_rxwq(struct work_struct *work)
317 struct packet_router *apr = container_of(work, struct packet_router, rx_work);
318 struct apr_rx_buf *abuf, *b;
321 if (!list_empty(&apr->rx_list)) {
322 list_for_each_entry_safe(abuf, b, &apr->rx_list, node) {
325 apr_do_rx_callback(apr, abuf);
328 gpr_do_rx_callback(apr, abuf);
333 spin_lock_irqsave(&apr->rx_lock, flags);
334 list_del(&abuf->node);
335 spin_unlock_irqrestore(&apr->rx_lock, flags);
341 static int apr_device_match(struct device *dev, struct device_driver *drv)
343 struct apr_device *adev = to_apr_device(dev);
344 struct apr_driver *adrv = to_apr_driver(drv);
345 const struct apr_device_id *id = adrv->id_table;
347 /* Attempt an OF style match first */
348 if (of_driver_match_device(dev, drv))
354 while (id->domain_id != 0 || id->svc_id != 0) {
355 if (id->domain_id == adev->domain_id &&
356 id->svc_id == adev->svc.id)
364 static int apr_device_probe(struct device *dev)
366 struct apr_device *adev = to_apr_device(dev);
367 struct apr_driver *adrv = to_apr_driver(dev->driver);
370 ret = adrv->probe(adev);
372 adev->svc.callback = adrv->gpr_callback;
377 static void apr_device_remove(struct device *dev)
379 struct apr_device *adev = to_apr_device(dev);
380 struct apr_driver *adrv = to_apr_driver(dev->driver);
381 struct packet_router *apr = dev_get_drvdata(adev->dev.parent);
385 spin_lock(&apr->svcs_lock);
386 idr_remove(&apr->svcs_idr, adev->svc.id);
387 spin_unlock(&apr->svcs_lock);
390 static int apr_uevent(const struct device *dev, struct kobj_uevent_env *env)
392 const struct apr_device *adev = to_apr_device(dev);
395 ret = of_device_uevent_modalias(dev, env);
399 return add_uevent_var(env, "MODALIAS=apr:%s", adev->name);
402 struct bus_type aprbus = {
404 .match = apr_device_match,
405 .probe = apr_device_probe,
406 .uevent = apr_uevent,
407 .remove = apr_device_remove,
409 EXPORT_SYMBOL_GPL(aprbus);
411 static int apr_add_device(struct device *dev, struct device_node *np,
412 u32 svc_id, u32 domain_id)
414 struct packet_router *apr = dev_get_drvdata(dev);
415 struct apr_device *adev = NULL;
416 struct pkt_router_svc *svc;
419 adev = kzalloc(sizeof(*adev), GFP_KERNEL);
423 adev->svc_id = svc_id;
430 spin_lock_init(&svc->lock);
432 adev->domain_id = domain_id;
435 snprintf(adev->name, APR_NAME_SIZE, "%pOFn", np);
439 dev_set_name(&adev->dev, "aprsvc:%s:%x:%x", adev->name,
443 dev_set_name(&adev->dev, "gprsvc:%s:%x:%x", adev->name,
450 adev->dev.bus = &aprbus;
451 adev->dev.parent = dev;
452 adev->dev.of_node = np;
453 adev->dev.release = apr_dev_release;
454 adev->dev.driver = NULL;
456 spin_lock(&apr->svcs_lock);
457 ret = idr_alloc(&apr->svcs_idr, svc, svc_id, svc_id + 1, GFP_ATOMIC);
458 spin_unlock(&apr->svcs_lock);
460 dev_err(dev, "idr_alloc failed: %d\n", ret);
464 /* Protection domain is optional, it does not exist on older platforms */
465 ret = of_property_read_string_index(np, "qcom,protection-domain",
466 1, &adev->service_path);
467 if (ret < 0 && ret != -EINVAL) {
468 dev_err(dev, "Failed to read second value of qcom,protection-domain\n");
472 dev_info(dev, "Adding APR/GPR dev: %s\n", dev_name(&adev->dev));
474 ret = device_register(&adev->dev);
476 dev_err(dev, "device_register failed: %d\n", ret);
477 put_device(&adev->dev);
484 static int of_apr_add_pd_lookups(struct device *dev)
486 const char *service_name, *service_path;
487 struct packet_router *apr = dev_get_drvdata(dev);
488 struct device_node *node;
489 struct pdr_service *pds;
492 for_each_child_of_node(dev->of_node, node) {
493 ret = of_property_read_string_index(node, "qcom,protection-domain",
498 ret = of_property_read_string_index(node, "qcom,protection-domain",
501 dev_err(dev, "pdr service path missing: %d\n", ret);
506 pds = pdr_add_lookup(apr->pdr, service_name, service_path);
507 if (IS_ERR(pds) && PTR_ERR(pds) != -EALREADY) {
508 dev_err(dev, "pdr add lookup failed: %ld\n", PTR_ERR(pds));
517 static void of_register_apr_devices(struct device *dev, const char *svc_path)
519 struct packet_router *apr = dev_get_drvdata(dev);
520 struct device_node *node;
521 const char *service_path;
524 for_each_child_of_node(dev->of_node, node) {
529 * This function is called with svc_path NULL during
530 * apr_probe(), in which case we register any apr devices
531 * without a qcom,protection-domain specified.
533 * Then as the protection domains becomes available
534 * (if applicable) this function is again called, but with
535 * svc_path representing the service becoming available. In
536 * this case we register any apr devices with a matching
537 * qcom,protection-domain.
540 ret = of_property_read_string_index(node, "qcom,protection-domain",
543 /* skip APR services that are PD independent */
547 /* skip APR services whose PD paths don't match */
548 if (strcmp(service_path, svc_path))
551 /* skip APR services whose PD lookups are registered */
556 if (of_property_read_u32(node, "reg", &svc_id))
559 domain_id = apr->dest_domain_id;
561 if (apr_add_device(dev, node, svc_id, domain_id))
562 dev_err(dev, "Failed to add apr %d svc\n", svc_id);
566 static int apr_remove_device(struct device *dev, void *svc_path)
568 struct apr_device *adev = to_apr_device(dev);
570 if (svc_path && adev->service_path) {
571 if (!strcmp(adev->service_path, (char *)svc_path))
572 device_unregister(&adev->dev);
574 device_unregister(&adev->dev);
580 static void apr_pd_status(int state, char *svc_path, void *priv)
582 struct packet_router *apr = (struct packet_router *)priv;
585 case SERVREG_SERVICE_STATE_UP:
586 of_register_apr_devices(apr->dev, svc_path);
588 case SERVREG_SERVICE_STATE_DOWN:
589 device_for_each_child(apr->dev, svc_path, apr_remove_device);
594 static int apr_probe(struct rpmsg_device *rpdev)
596 struct device *dev = &rpdev->dev;
597 struct packet_router *apr;
600 apr = devm_kzalloc(dev, sizeof(*apr), GFP_KERNEL);
604 ret = of_property_read_u32(dev->of_node, "qcom,domain", &apr->dest_domain_id);
606 if (of_device_is_compatible(dev->of_node, "qcom,gpr")) {
607 apr->type = PR_TYPE_GPR;
609 if (ret) /* try deprecated apr-domain property */
610 ret = of_property_read_u32(dev->of_node, "qcom,apr-domain",
611 &apr->dest_domain_id);
612 apr->type = PR_TYPE_APR;
616 dev_err(dev, "Domain ID not specified in DT\n");
620 dev_set_drvdata(dev, apr);
621 apr->ch = rpdev->ept;
623 apr->rxwq = create_singlethread_workqueue("qcom_apr_rx");
625 dev_err(apr->dev, "Failed to start Rx WQ\n");
628 INIT_WORK(&apr->rx_work, apr_rxwq);
630 apr->pdr = pdr_handle_alloc(apr_pd_status, apr);
631 if (IS_ERR(apr->pdr)) {
632 dev_err(dev, "Failed to init PDR handle\n");
633 ret = PTR_ERR(apr->pdr);
637 INIT_LIST_HEAD(&apr->rx_list);
638 spin_lock_init(&apr->rx_lock);
639 spin_lock_init(&apr->svcs_lock);
640 idr_init(&apr->svcs_idr);
642 ret = of_apr_add_pd_lookups(dev);
646 of_register_apr_devices(dev, NULL);
651 pdr_handle_release(apr->pdr);
653 destroy_workqueue(apr->rxwq);
657 static void apr_remove(struct rpmsg_device *rpdev)
659 struct packet_router *apr = dev_get_drvdata(&rpdev->dev);
661 pdr_handle_release(apr->pdr);
662 device_for_each_child(&rpdev->dev, NULL, apr_remove_device);
663 destroy_workqueue(apr->rxwq);
667 * __apr_driver_register() - Client driver registration with aprbus
669 * @drv:Client driver to be associated with client-device.
670 * @owner: owning module/driver
672 * This API will register the client driver with the aprbus
673 * It is called from the driver's module-init function.
675 int __apr_driver_register(struct apr_driver *drv, struct module *owner)
677 drv->driver.bus = &aprbus;
678 drv->driver.owner = owner;
680 return driver_register(&drv->driver);
682 EXPORT_SYMBOL_GPL(__apr_driver_register);
685 * apr_driver_unregister() - Undo effect of apr_driver_register
687 * @drv: Client driver to be unregistered
689 void apr_driver_unregister(struct apr_driver *drv)
691 driver_unregister(&drv->driver);
693 EXPORT_SYMBOL_GPL(apr_driver_unregister);
695 static const struct of_device_id pkt_router_of_match[] = {
696 { .compatible = "qcom,apr"},
697 { .compatible = "qcom,apr-v2"},
698 { .compatible = "qcom,gpr"},
701 MODULE_DEVICE_TABLE(of, pkt_router_of_match);
703 static struct rpmsg_driver packet_router_driver = {
705 .remove = apr_remove,
706 .callback = apr_callback,
709 .of_match_table = pkt_router_of_match,
713 static int __init apr_init(void)
717 ret = bus_register(&aprbus);
719 ret = register_rpmsg_driver(&packet_router_driver);
721 bus_unregister(&aprbus);
726 static void __exit apr_exit(void)
728 bus_unregister(&aprbus);
729 unregister_rpmsg_driver(&packet_router_driver);
732 subsys_initcall(apr_init);
733 module_exit(apr_exit);
735 MODULE_LICENSE("GPL v2");
736 MODULE_DESCRIPTION("Qualcomm APR Bus");