1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (C) 2020 The Linux Foundation. All rights reserved.
6 #include <linux/kernel.h>
7 #include <linux/module.h>
8 #include <linux/slab.h>
9 #include <linux/string.h>
10 #include <linux/workqueue.h>
12 #include "pdr_internal.h"
15 char service_name[SERVREG_NAME_LENGTH + 1];
16 char service_path[SERVREG_NAME_LENGTH + 1];
18 struct sockaddr_qrtr addr;
20 unsigned int instance;
22 u8 service_data_valid;
26 bool need_notifier_register;
27 bool need_notifier_remove;
28 bool need_locator_lookup;
29 bool service_connected;
31 struct list_head node;
35 struct qmi_handle locator_hdl;
36 struct qmi_handle notifier_hdl;
38 struct sockaddr_qrtr locator_addr;
40 struct list_head lookups;
41 struct list_head indack_list;
43 /* control access to pdr lookup/indack lists */
44 struct mutex list_lock;
46 /* serialize pd status invocation */
47 struct mutex status_lock;
49 /* control access to the locator state */
52 bool locator_init_complete;
54 struct work_struct locator_work;
55 struct work_struct notifier_work;
56 struct work_struct indack_work;
58 struct workqueue_struct *notifier_wq;
59 struct workqueue_struct *indack_wq;
61 void (*status)(int state, char *service_path, void *priv);
65 struct pdr_list_node {
66 enum servreg_service_state curr_state;
68 struct pdr_service *pds;
69 struct list_head node;
72 static int pdr_locator_new_server(struct qmi_handle *qmi,
73 struct qmi_service *svc)
75 struct pdr_handle *pdr = container_of(qmi, struct pdr_handle,
77 struct pdr_service *pds;
79 /* Create a local client port for QMI communication */
80 pdr->locator_addr.sq_family = AF_QIPCRTR;
81 pdr->locator_addr.sq_node = svc->node;
82 pdr->locator_addr.sq_port = svc->port;
84 mutex_lock(&pdr->lock);
85 pdr->locator_init_complete = true;
86 mutex_unlock(&pdr->lock);
88 /* Service pending lookup requests */
89 mutex_lock(&pdr->list_lock);
90 list_for_each_entry(pds, &pdr->lookups, node) {
91 if (pds->need_locator_lookup)
92 schedule_work(&pdr->locator_work);
94 mutex_unlock(&pdr->list_lock);
99 static void pdr_locator_del_server(struct qmi_handle *qmi,
100 struct qmi_service *svc)
102 struct pdr_handle *pdr = container_of(qmi, struct pdr_handle,
105 mutex_lock(&pdr->lock);
106 pdr->locator_init_complete = false;
107 mutex_unlock(&pdr->lock);
109 pdr->locator_addr.sq_node = 0;
110 pdr->locator_addr.sq_port = 0;
113 static const struct qmi_ops pdr_locator_ops = {
114 .new_server = pdr_locator_new_server,
115 .del_server = pdr_locator_del_server,
118 static int pdr_register_listener(struct pdr_handle *pdr,
119 struct pdr_service *pds,
122 struct servreg_register_listener_resp resp;
123 struct servreg_register_listener_req req;
127 ret = qmi_txn_init(&pdr->notifier_hdl, &txn,
128 servreg_register_listener_resp_ei,
134 strscpy(req.service_path, pds->service_path, sizeof(req.service_path));
136 ret = qmi_send_request(&pdr->notifier_hdl, &pds->addr,
137 &txn, SERVREG_REGISTER_LISTENER_REQ,
138 SERVREG_REGISTER_LISTENER_REQ_LEN,
139 servreg_register_listener_req_ei,
142 qmi_txn_cancel(&txn);
146 ret = qmi_txn_wait(&txn, 5 * HZ);
148 pr_err("PDR: %s register listener txn wait failed: %d\n",
149 pds->service_path, ret);
153 if (resp.resp.result != QMI_RESULT_SUCCESS_V01) {
154 pr_err("PDR: %s register listener failed: 0x%x\n",
155 pds->service_path, resp.resp.error);
159 pds->state = resp.curr_state;
164 static void pdr_notifier_work(struct work_struct *work)
166 struct pdr_handle *pdr = container_of(work, struct pdr_handle,
168 struct pdr_service *pds;
171 mutex_lock(&pdr->list_lock);
172 list_for_each_entry(pds, &pdr->lookups, node) {
173 if (pds->service_connected) {
174 if (!pds->need_notifier_register)
177 pds->need_notifier_register = false;
178 ret = pdr_register_listener(pdr, pds, true);
180 pds->state = SERVREG_SERVICE_STATE_DOWN;
182 if (!pds->need_notifier_remove)
185 pds->need_notifier_remove = false;
186 pds->state = SERVREG_SERVICE_STATE_DOWN;
189 mutex_lock(&pdr->status_lock);
190 pdr->status(pds->state, pds->service_path, pdr->priv);
191 mutex_unlock(&pdr->status_lock);
193 mutex_unlock(&pdr->list_lock);
196 static int pdr_notifier_new_server(struct qmi_handle *qmi,
197 struct qmi_service *svc)
199 struct pdr_handle *pdr = container_of(qmi, struct pdr_handle,
201 struct pdr_service *pds;
203 mutex_lock(&pdr->list_lock);
204 list_for_each_entry(pds, &pdr->lookups, node) {
205 if (pds->service == svc->service &&
206 pds->instance == svc->instance) {
207 pds->service_connected = true;
208 pds->need_notifier_register = true;
209 pds->addr.sq_family = AF_QIPCRTR;
210 pds->addr.sq_node = svc->node;
211 pds->addr.sq_port = svc->port;
212 queue_work(pdr->notifier_wq, &pdr->notifier_work);
215 mutex_unlock(&pdr->list_lock);
220 static void pdr_notifier_del_server(struct qmi_handle *qmi,
221 struct qmi_service *svc)
223 struct pdr_handle *pdr = container_of(qmi, struct pdr_handle,
225 struct pdr_service *pds;
227 mutex_lock(&pdr->list_lock);
228 list_for_each_entry(pds, &pdr->lookups, node) {
229 if (pds->service == svc->service &&
230 pds->instance == svc->instance) {
231 pds->service_connected = false;
232 pds->need_notifier_remove = true;
233 pds->addr.sq_node = 0;
234 pds->addr.sq_port = 0;
235 queue_work(pdr->notifier_wq, &pdr->notifier_work);
238 mutex_unlock(&pdr->list_lock);
241 static const struct qmi_ops pdr_notifier_ops = {
242 .new_server = pdr_notifier_new_server,
243 .del_server = pdr_notifier_del_server,
246 static int pdr_send_indack_msg(struct pdr_handle *pdr, struct pdr_service *pds,
249 struct servreg_set_ack_resp resp;
250 struct servreg_set_ack_req req;
254 ret = qmi_txn_init(&pdr->notifier_hdl, &txn, servreg_set_ack_resp_ei,
259 req.transaction_id = tid;
260 strscpy(req.service_path, pds->service_path, sizeof(req.service_path));
262 ret = qmi_send_request(&pdr->notifier_hdl, &pds->addr,
263 &txn, SERVREG_SET_ACK_REQ,
264 SERVREG_SET_ACK_REQ_LEN,
265 servreg_set_ack_req_ei,
268 /* Skip waiting for response */
269 qmi_txn_cancel(&txn);
273 static void pdr_indack_work(struct work_struct *work)
275 struct pdr_handle *pdr = container_of(work, struct pdr_handle,
277 struct pdr_list_node *ind, *tmp;
278 struct pdr_service *pds;
280 list_for_each_entry_safe(ind, tmp, &pdr->indack_list, node) {
283 mutex_lock(&pdr->status_lock);
284 pds->state = ind->curr_state;
285 pdr->status(pds->state, pds->service_path, pdr->priv);
286 mutex_unlock(&pdr->status_lock);
288 /* Ack the indication after clients release the PD resources */
289 pdr_send_indack_msg(pdr, pds, ind->transaction_id);
291 mutex_lock(&pdr->list_lock);
292 list_del(&ind->node);
293 mutex_unlock(&pdr->list_lock);
299 static void pdr_indication_cb(struct qmi_handle *qmi,
300 struct sockaddr_qrtr *sq,
301 struct qmi_txn *txn, const void *data)
303 struct pdr_handle *pdr = container_of(qmi, struct pdr_handle,
305 const struct servreg_state_updated_ind *ind_msg = data;
306 struct pdr_list_node *ind;
307 struct pdr_service *pds = NULL, *iter;
309 if (!ind_msg || !ind_msg->service_path[0] ||
310 strlen(ind_msg->service_path) > SERVREG_NAME_LENGTH)
313 mutex_lock(&pdr->list_lock);
314 list_for_each_entry(iter, &pdr->lookups, node) {
315 if (strcmp(iter->service_path, ind_msg->service_path))
321 mutex_unlock(&pdr->list_lock);
326 pr_info("PDR: Indication received from %s, state: 0x%x, trans-id: %d\n",
327 ind_msg->service_path, ind_msg->curr_state,
328 ind_msg->transaction_id);
330 ind = kzalloc(sizeof(*ind), GFP_KERNEL);
334 ind->transaction_id = ind_msg->transaction_id;
335 ind->curr_state = ind_msg->curr_state;
338 mutex_lock(&pdr->list_lock);
339 list_add_tail(&ind->node, &pdr->indack_list);
340 mutex_unlock(&pdr->list_lock);
342 queue_work(pdr->indack_wq, &pdr->indack_work);
345 static const struct qmi_msg_handler qmi_indication_handler[] = {
347 .type = QMI_INDICATION,
348 .msg_id = SERVREG_STATE_UPDATED_IND_ID,
349 .ei = servreg_state_updated_ind_ei,
350 .decoded_size = sizeof(struct servreg_state_updated_ind),
351 .fn = pdr_indication_cb,
356 static int pdr_get_domain_list(struct servreg_get_domain_list_req *req,
357 struct servreg_get_domain_list_resp *resp,
358 struct pdr_handle *pdr)
363 ret = qmi_txn_init(&pdr->locator_hdl, &txn,
364 servreg_get_domain_list_resp_ei, resp);
368 ret = qmi_send_request(&pdr->locator_hdl,
370 &txn, SERVREG_GET_DOMAIN_LIST_REQ,
371 SERVREG_GET_DOMAIN_LIST_REQ_MAX_LEN,
372 servreg_get_domain_list_req_ei,
375 qmi_txn_cancel(&txn);
379 ret = qmi_txn_wait(&txn, 5 * HZ);
381 pr_err("PDR: %s get domain list txn wait failed: %d\n",
382 req->service_name, ret);
386 if (resp->resp.result != QMI_RESULT_SUCCESS_V01) {
387 pr_err("PDR: %s get domain list failed: 0x%x\n",
388 req->service_name, resp->resp.error);
395 static int pdr_locate_service(struct pdr_handle *pdr, struct pdr_service *pds)
397 struct servreg_get_domain_list_resp *resp;
398 struct servreg_get_domain_list_req req;
399 struct servreg_location_entry *entry;
400 int domains_read = 0;
403 resp = kzalloc(sizeof(*resp), GFP_KERNEL);
407 /* Prepare req message */
408 strscpy(req.service_name, pds->service_name, sizeof(req.service_name));
409 req.domain_offset_valid = true;
410 req.domain_offset = 0;
413 req.domain_offset = domains_read;
414 ret = pdr_get_domain_list(&req, resp, pdr);
418 for (i = domains_read; i < resp->domain_list_len; i++) {
419 entry = &resp->domain_list[i];
421 if (strnlen(entry->name, sizeof(entry->name)) == sizeof(entry->name))
424 if (!strcmp(entry->name, pds->service_path)) {
425 pds->service_data_valid = entry->service_data_valid;
426 pds->service_data = entry->service_data;
427 pds->instance = entry->instance;
432 /* Update ret to indicate that the service is not yet found */
435 /* Always read total_domains from the response msg */
436 if (resp->domain_list_len > resp->total_domains)
437 resp->domain_list_len = resp->total_domains;
439 domains_read += resp->domain_list_len;
440 } while (domains_read < resp->total_domains);
446 static void pdr_notify_lookup_failure(struct pdr_handle *pdr,
447 struct pdr_service *pds,
450 pr_err("PDR: service lookup for %s failed: %d\n",
451 pds->service_name, err);
456 list_del(&pds->node);
457 pds->state = SERVREG_LOCATOR_ERR;
458 mutex_lock(&pdr->status_lock);
459 pdr->status(pds->state, pds->service_path, pdr->priv);
460 mutex_unlock(&pdr->status_lock);
464 static void pdr_locator_work(struct work_struct *work)
466 struct pdr_handle *pdr = container_of(work, struct pdr_handle,
468 struct pdr_service *pds, *tmp;
471 /* Bail out early if the SERVREG LOCATOR QMI service is not up */
472 mutex_lock(&pdr->lock);
473 if (!pdr->locator_init_complete) {
474 mutex_unlock(&pdr->lock);
475 pr_debug("PDR: SERVICE LOCATOR service not available\n");
478 mutex_unlock(&pdr->lock);
480 mutex_lock(&pdr->list_lock);
481 list_for_each_entry_safe(pds, tmp, &pdr->lookups, node) {
482 if (!pds->need_locator_lookup)
485 ret = pdr_locate_service(pdr, pds);
487 pdr_notify_lookup_failure(pdr, pds, ret);
491 ret = qmi_add_lookup(&pdr->notifier_hdl, pds->service, 1,
494 pdr_notify_lookup_failure(pdr, pds, ret);
498 pds->need_locator_lookup = false;
500 mutex_unlock(&pdr->list_lock);
504 * pdr_add_lookup() - register a tracking request for a PD
505 * @pdr: PDR client handle
506 * @service_name: service name of the tracking request
507 * @service_path: service path of the tracking request
509 * Registering a pdr lookup allows for tracking the life cycle of the PD.
511 * Return: pdr_service object on success, ERR_PTR on failure. -EALREADY is
512 * returned if a lookup is already in progress for the given service path.
514 struct pdr_service *pdr_add_lookup(struct pdr_handle *pdr,
515 const char *service_name,
516 const char *service_path)
518 struct pdr_service *pds, *tmp;
521 if (IS_ERR_OR_NULL(pdr))
522 return ERR_PTR(-EINVAL);
524 if (!service_name || strlen(service_name) > SERVREG_NAME_LENGTH ||
525 !service_path || strlen(service_path) > SERVREG_NAME_LENGTH)
526 return ERR_PTR(-EINVAL);
528 pds = kzalloc(sizeof(*pds), GFP_KERNEL);
530 return ERR_PTR(-ENOMEM);
532 pds->service = SERVREG_NOTIFIER_SERVICE;
533 strscpy(pds->service_name, service_name, sizeof(pds->service_name));
534 strscpy(pds->service_path, service_path, sizeof(pds->service_path));
535 pds->need_locator_lookup = true;
537 mutex_lock(&pdr->list_lock);
538 list_for_each_entry(tmp, &pdr->lookups, node) {
539 if (strcmp(tmp->service_path, service_path))
542 mutex_unlock(&pdr->list_lock);
547 list_add(&pds->node, &pdr->lookups);
548 mutex_unlock(&pdr->list_lock);
550 schedule_work(&pdr->locator_work);
557 EXPORT_SYMBOL(pdr_add_lookup);
560 * pdr_restart_pd() - restart PD
561 * @pdr: PDR client handle
562 * @pds: PD service handle
564 * Restarts the PD tracked by the PDR client handle for a given service path.
566 * Return: 0 on success, negative errno on failure.
568 int pdr_restart_pd(struct pdr_handle *pdr, struct pdr_service *pds)
570 struct servreg_restart_pd_resp resp;
571 struct servreg_restart_pd_req req = { 0 };
572 struct sockaddr_qrtr addr;
573 struct pdr_service *tmp;
577 if (IS_ERR_OR_NULL(pdr) || IS_ERR_OR_NULL(pds))
580 mutex_lock(&pdr->list_lock);
581 list_for_each_entry(tmp, &pdr->lookups, node) {
585 if (!pds->service_connected)
588 /* Prepare req message */
589 strscpy(req.service_path, pds->service_path, sizeof(req.service_path));
593 mutex_unlock(&pdr->list_lock);
595 if (!req.service_path[0])
598 ret = qmi_txn_init(&pdr->notifier_hdl, &txn,
599 servreg_restart_pd_resp_ei,
604 ret = qmi_send_request(&pdr->notifier_hdl, &addr,
605 &txn, SERVREG_RESTART_PD_REQ,
606 SERVREG_RESTART_PD_REQ_MAX_LEN,
607 servreg_restart_pd_req_ei, &req);
609 qmi_txn_cancel(&txn);
613 ret = qmi_txn_wait(&txn, 5 * HZ);
615 pr_err("PDR: %s PD restart txn wait failed: %d\n",
616 req.service_path, ret);
620 /* Check response if PDR is disabled */
621 if (resp.resp.result == QMI_RESULT_FAILURE_V01 &&
622 resp.resp.error == QMI_ERR_DISABLED_V01) {
623 pr_err("PDR: %s PD restart is disabled: 0x%x\n",
624 req.service_path, resp.resp.error);
628 /* Check the response for other error case*/
629 if (resp.resp.result != QMI_RESULT_SUCCESS_V01) {
630 pr_err("PDR: %s request for PD restart failed: 0x%x\n",
631 req.service_path, resp.resp.error);
637 EXPORT_SYMBOL(pdr_restart_pd);
640 * pdr_handle_alloc() - initialize the PDR client handle
641 * @status: function to be called on PD state change
642 * @priv: handle for client's use
644 * Initializes the PDR client handle to allow for tracking/restart of PDs.
646 * Return: pdr_handle object on success, ERR_PTR on failure.
648 struct pdr_handle *pdr_handle_alloc(void (*status)(int state,
650 void *priv), void *priv)
652 struct pdr_handle *pdr;
656 return ERR_PTR(-EINVAL);
658 pdr = kzalloc(sizeof(*pdr), GFP_KERNEL);
660 return ERR_PTR(-ENOMEM);
662 pdr->status = status;
665 mutex_init(&pdr->status_lock);
666 mutex_init(&pdr->list_lock);
667 mutex_init(&pdr->lock);
669 INIT_LIST_HEAD(&pdr->lookups);
670 INIT_LIST_HEAD(&pdr->indack_list);
672 INIT_WORK(&pdr->locator_work, pdr_locator_work);
673 INIT_WORK(&pdr->notifier_work, pdr_notifier_work);
674 INIT_WORK(&pdr->indack_work, pdr_indack_work);
676 pdr->notifier_wq = create_singlethread_workqueue("pdr_notifier_wq");
677 if (!pdr->notifier_wq) {
679 goto free_pdr_handle;
682 pdr->indack_wq = alloc_ordered_workqueue("pdr_indack_wq", WQ_HIGHPRI);
683 if (!pdr->indack_wq) {
685 goto destroy_notifier;
688 ret = qmi_handle_init(&pdr->locator_hdl,
689 SERVREG_GET_DOMAIN_LIST_RESP_MAX_LEN,
690 &pdr_locator_ops, NULL);
694 ret = qmi_add_lookup(&pdr->locator_hdl, SERVREG_LOCATOR_SERVICE, 1, 1);
696 goto release_qmi_handle;
698 ret = qmi_handle_init(&pdr->notifier_hdl,
699 SERVREG_STATE_UPDATED_IND_MAX_LEN,
701 qmi_indication_handler);
703 goto release_qmi_handle;
708 qmi_handle_release(&pdr->locator_hdl);
710 destroy_workqueue(pdr->indack_wq);
712 destroy_workqueue(pdr->notifier_wq);
718 EXPORT_SYMBOL(pdr_handle_alloc);
721 * pdr_handle_release() - release the PDR client handle
722 * @pdr: PDR client handle
724 * Cleans up pending tracking requests and releases the underlying qmi handles.
726 void pdr_handle_release(struct pdr_handle *pdr)
728 struct pdr_service *pds, *tmp;
730 if (IS_ERR_OR_NULL(pdr))
733 mutex_lock(&pdr->list_lock);
734 list_for_each_entry_safe(pds, tmp, &pdr->lookups, node) {
735 list_del(&pds->node);
738 mutex_unlock(&pdr->list_lock);
740 cancel_work_sync(&pdr->locator_work);
741 cancel_work_sync(&pdr->notifier_work);
742 cancel_work_sync(&pdr->indack_work);
744 destroy_workqueue(pdr->notifier_wq);
745 destroy_workqueue(pdr->indack_wq);
747 qmi_handle_release(&pdr->locator_hdl);
748 qmi_handle_release(&pdr->notifier_hdl);
752 EXPORT_SYMBOL(pdr_handle_release);
754 MODULE_LICENSE("GPL v2");
755 MODULE_DESCRIPTION("Qualcomm Protection Domain Restart helpers");