1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2017, Linaro Ltd.
5 #include <linux/firmware.h>
6 #include <linux/module.h>
7 #include <linux/notifier.h>
8 #include <linux/slab.h>
9 #include <linux/interrupt.h>
11 #include <linux/of_irq.h>
12 #include <linux/of_platform.h>
13 #include <linux/platform_device.h>
14 #include <linux/remoteproc/qcom_rproc.h>
15 #include <linux/rpmsg.h>
17 #include "qcom_common.h"
19 static BLOCKING_NOTIFIER_HEAD(sysmon_notifiers
);
22 struct rproc_subdev subdev
;
25 struct list_head node
;
33 struct notifier_block nb
;
37 struct rpmsg_endpoint
*ept
;
38 struct completion comp
;
39 struct completion ind_comp
;
40 struct completion shutdown_comp
;
45 struct qmi_handle qmi
;
46 struct sockaddr_qrtr ssctl
;
49 static DEFINE_MUTEX(sysmon_lock
);
50 static LIST_HEAD(sysmon_list
);
53 * sysmon_send_event() - send notification of other remote's SSR event
54 * @sysmon: sysmon context
55 * @name: other remote's name
57 static void sysmon_send_event(struct qcom_sysmon
*sysmon
, const char *name
)
63 len
= snprintf(req
, sizeof(req
), "ssr:%s:before_shutdown", name
);
64 if (len
>= sizeof(req
))
67 mutex_lock(&sysmon
->lock
);
68 reinit_completion(&sysmon
->comp
);
69 sysmon
->ssr_ack
= false;
71 ret
= rpmsg_send(sysmon
->ept
, req
, len
);
73 dev_err(sysmon
->dev
, "failed to send sysmon event\n");
77 ret
= wait_for_completion_timeout(&sysmon
->comp
,
78 msecs_to_jiffies(5000));
80 dev_err(sysmon
->dev
, "timeout waiting for sysmon ack\n");
85 dev_err(sysmon
->dev
, "unexpected response to sysmon event\n");
88 mutex_unlock(&sysmon
->lock
);
92 * sysmon_request_shutdown() - request graceful shutdown of remote
93 * @sysmon: sysmon context
95 static void sysmon_request_shutdown(struct qcom_sysmon
*sysmon
)
97 char *req
= "ssr:shutdown";
100 mutex_lock(&sysmon
->lock
);
101 reinit_completion(&sysmon
->comp
);
102 sysmon
->ssr_ack
= false;
104 ret
= rpmsg_send(sysmon
->ept
, req
, strlen(req
) + 1);
106 dev_err(sysmon
->dev
, "send sysmon shutdown request failed\n");
110 ret
= wait_for_completion_timeout(&sysmon
->comp
,
111 msecs_to_jiffies(5000));
113 dev_err(sysmon
->dev
, "timeout waiting for sysmon ack\n");
117 if (!sysmon
->ssr_ack
)
119 "unexpected response to sysmon shutdown request\n");
122 mutex_unlock(&sysmon
->lock
);
125 static int sysmon_callback(struct rpmsg_device
*rpdev
, void *data
, int count
,
126 void *priv
, u32 addr
)
128 struct qcom_sysmon
*sysmon
= priv
;
129 const char *ssr_ack
= "ssr:ack";
130 const int ssr_ack_len
= strlen(ssr_ack
) + 1;
135 if (count
>= ssr_ack_len
&& !memcmp(data
, ssr_ack
, ssr_ack_len
))
136 sysmon
->ssr_ack
= true;
138 complete(&sysmon
->comp
);
143 #define SSCTL_SHUTDOWN_REQ 0x21
144 #define SSCTL_SHUTDOWN_READY_IND 0x21
145 #define SSCTL_SUBSYS_EVENT_REQ 0x23
147 #define SSCTL_MAX_MSG_LEN 7
149 #define SSCTL_SUBSYS_NAME_LENGTH 15
152 SSCTL_SSR_EVENT_BEFORE_POWERUP
,
153 SSCTL_SSR_EVENT_AFTER_POWERUP
,
154 SSCTL_SSR_EVENT_BEFORE_SHUTDOWN
,
155 SSCTL_SSR_EVENT_AFTER_SHUTDOWN
,
159 SSCTL_SSR_EVENT_FORCED
,
160 SSCTL_SSR_EVENT_GRACEFUL
,
163 struct ssctl_shutdown_resp
{
164 struct qmi_response_type_v01 resp
;
167 static struct qmi_elem_info ssctl_shutdown_resp_ei
[] = {
169 .data_type
= QMI_STRUCT
,
171 .elem_size
= sizeof(struct qmi_response_type_v01
),
172 .array_type
= NO_ARRAY
,
174 .offset
= offsetof(struct ssctl_shutdown_resp
, resp
),
175 .ei_array
= qmi_response_type_v01_ei
,
180 struct ssctl_subsys_event_req
{
182 char subsys_name
[SSCTL_SUBSYS_NAME_LENGTH
];
188 static struct qmi_elem_info ssctl_subsys_event_req_ei
[] = {
190 .data_type
= QMI_DATA_LEN
,
192 .elem_size
= sizeof(uint8_t),
193 .array_type
= NO_ARRAY
,
195 .offset
= offsetof(struct ssctl_subsys_event_req
,
200 .data_type
= QMI_UNSIGNED_1_BYTE
,
201 .elem_len
= SSCTL_SUBSYS_NAME_LENGTH
,
202 .elem_size
= sizeof(char),
203 .array_type
= VAR_LEN_ARRAY
,
205 .offset
= offsetof(struct ssctl_subsys_event_req
,
210 .data_type
= QMI_SIGNED_4_BYTE_ENUM
,
212 .elem_size
= sizeof(uint32_t),
213 .array_type
= NO_ARRAY
,
215 .offset
= offsetof(struct ssctl_subsys_event_req
,
220 .data_type
= QMI_OPT_FLAG
,
222 .elem_size
= sizeof(uint8_t),
223 .array_type
= NO_ARRAY
,
225 .offset
= offsetof(struct ssctl_subsys_event_req
,
230 .data_type
= QMI_SIGNED_4_BYTE_ENUM
,
232 .elem_size
= sizeof(uint32_t),
233 .array_type
= NO_ARRAY
,
235 .offset
= offsetof(struct ssctl_subsys_event_req
,
242 struct ssctl_subsys_event_resp
{
243 struct qmi_response_type_v01 resp
;
246 static struct qmi_elem_info ssctl_subsys_event_resp_ei
[] = {
248 .data_type
= QMI_STRUCT
,
250 .elem_size
= sizeof(struct qmi_response_type_v01
),
251 .array_type
= NO_ARRAY
,
253 .offset
= offsetof(struct ssctl_subsys_event_resp
,
255 .ei_array
= qmi_response_type_v01_ei
,
260 static struct qmi_elem_info ssctl_shutdown_ind_ei
[] = {
264 static void sysmon_ind_cb(struct qmi_handle
*qmi
, struct sockaddr_qrtr
*sq
,
265 struct qmi_txn
*txn
, const void *data
)
267 struct qcom_sysmon
*sysmon
= container_of(qmi
, struct qcom_sysmon
, qmi
);
269 complete(&sysmon
->ind_comp
);
272 static struct qmi_msg_handler qmi_indication_handler
[] = {
274 .type
= QMI_INDICATION
,
275 .msg_id
= SSCTL_SHUTDOWN_READY_IND
,
276 .ei
= ssctl_shutdown_ind_ei
,
284 * ssctl_request_shutdown() - request shutdown via SSCTL QMI service
285 * @sysmon: sysmon context
287 static void ssctl_request_shutdown(struct qcom_sysmon
*sysmon
)
289 struct ssctl_shutdown_resp resp
;
293 reinit_completion(&sysmon
->ind_comp
);
294 reinit_completion(&sysmon
->shutdown_comp
);
295 ret
= qmi_txn_init(&sysmon
->qmi
, &txn
, ssctl_shutdown_resp_ei
, &resp
);
297 dev_err(sysmon
->dev
, "failed to allocate QMI txn\n");
301 ret
= qmi_send_request(&sysmon
->qmi
, &sysmon
->ssctl
, &txn
,
302 SSCTL_SHUTDOWN_REQ
, 0, NULL
, NULL
);
304 dev_err(sysmon
->dev
, "failed to send shutdown request\n");
305 qmi_txn_cancel(&txn
);
309 ret
= qmi_txn_wait(&txn
, 5 * HZ
);
311 dev_err(sysmon
->dev
, "failed receiving QMI response\n");
312 else if (resp
.resp
.result
)
313 dev_err(sysmon
->dev
, "shutdown request failed\n");
315 dev_dbg(sysmon
->dev
, "shutdown request completed\n");
317 if (sysmon
->shutdown_irq
> 0) {
318 ret
= wait_for_completion_timeout(&sysmon
->shutdown_comp
,
321 ret
= try_wait_for_completion(&sysmon
->ind_comp
);
324 "timeout waiting for shutdown ack\n");
330 * ssctl_send_event() - send notification of other remote's SSR event
331 * @sysmon: sysmon context
332 * @name: other remote's name
334 static void ssctl_send_event(struct qcom_sysmon
*sysmon
, const char *name
)
336 struct ssctl_subsys_event_resp resp
;
337 struct ssctl_subsys_event_req req
;
341 memset(&resp
, 0, sizeof(resp
));
342 ret
= qmi_txn_init(&sysmon
->qmi
, &txn
, ssctl_subsys_event_resp_ei
, &resp
);
344 dev_err(sysmon
->dev
, "failed to allocate QMI txn\n");
348 memset(&req
, 0, sizeof(req
));
349 strlcpy(req
.subsys_name
, name
, sizeof(req
.subsys_name
));
350 req
.subsys_name_len
= strlen(req
.subsys_name
);
351 req
.event
= SSCTL_SSR_EVENT_BEFORE_SHUTDOWN
;
352 req
.evt_driven_valid
= true;
353 req
.evt_driven
= SSCTL_SSR_EVENT_FORCED
;
355 ret
= qmi_send_request(&sysmon
->qmi
, &sysmon
->ssctl
, &txn
,
356 SSCTL_SUBSYS_EVENT_REQ
, 40,
357 ssctl_subsys_event_req_ei
, &req
);
359 dev_err(sysmon
->dev
, "failed to send shutdown request\n");
360 qmi_txn_cancel(&txn
);
364 ret
= qmi_txn_wait(&txn
, 5 * HZ
);
366 dev_err(sysmon
->dev
, "failed receiving QMI response\n");
367 else if (resp
.resp
.result
)
368 dev_err(sysmon
->dev
, "ssr event send failed\n");
370 dev_dbg(sysmon
->dev
, "ssr event send completed\n");
374 * ssctl_new_server() - QMI callback indicating a new service
376 * @svc: service information
378 * Return: 0 if we're interested in this service, -EINVAL otherwise.
380 static int ssctl_new_server(struct qmi_handle
*qmi
, struct qmi_service
*svc
)
382 struct qcom_sysmon
*sysmon
= container_of(qmi
, struct qcom_sysmon
, qmi
);
384 switch (svc
->version
) {
386 if (svc
->instance
!= 0)
388 if (strcmp(sysmon
->name
, "modem"))
392 if (svc
->instance
!= sysmon
->ssctl_instance
)
399 sysmon
->ssctl_version
= svc
->version
;
401 sysmon
->ssctl
.sq_family
= AF_QIPCRTR
;
402 sysmon
->ssctl
.sq_node
= svc
->node
;
403 sysmon
->ssctl
.sq_port
= svc
->port
;
411 * ssctl_del_server() - QMI callback indicating that @svc is removed
413 * @svc: service information
415 static void ssctl_del_server(struct qmi_handle
*qmi
, struct qmi_service
*svc
)
417 struct qcom_sysmon
*sysmon
= svc
->priv
;
419 sysmon
->ssctl_version
= 0;
422 static const struct qmi_ops ssctl_ops
= {
423 .new_server
= ssctl_new_server
,
424 .del_server
= ssctl_del_server
,
427 static int sysmon_start(struct rproc_subdev
*subdev
)
432 static void sysmon_stop(struct rproc_subdev
*subdev
, bool crashed
)
434 struct qcom_sysmon
*sysmon
= container_of(subdev
, struct qcom_sysmon
, subdev
);
436 blocking_notifier_call_chain(&sysmon_notifiers
, 0, (void *)sysmon
->name
);
438 /* Don't request graceful shutdown if we've crashed */
442 if (sysmon
->ssctl_version
)
443 ssctl_request_shutdown(sysmon
);
444 else if (sysmon
->ept
)
445 sysmon_request_shutdown(sysmon
);
449 * sysmon_notify() - notify sysmon target of another's SSR
450 * @nb: notifier_block associated with sysmon instance
452 * @data: SSR identifier of the remote that is going down
454 static int sysmon_notify(struct notifier_block
*nb
, unsigned long event
,
457 struct qcom_sysmon
*sysmon
= container_of(nb
, struct qcom_sysmon
, nb
);
458 struct rproc
*rproc
= sysmon
->rproc
;
459 const char *ssr_name
= data
;
461 /* Skip non-running rprocs and the originating instance */
462 if (rproc
->state
!= RPROC_RUNNING
|| !strcmp(data
, sysmon
->name
)) {
463 dev_dbg(sysmon
->dev
, "not notifying %s\n", sysmon
->name
);
467 /* Only SSCTL version 2 supports SSR events */
468 if (sysmon
->ssctl_version
== 2)
469 ssctl_send_event(sysmon
, ssr_name
);
470 else if (sysmon
->ept
)
471 sysmon_send_event(sysmon
, ssr_name
);
476 static irqreturn_t
sysmon_shutdown_interrupt(int irq
, void *data
)
478 struct qcom_sysmon
*sysmon
= data
;
480 complete(&sysmon
->shutdown_comp
);
486 * qcom_add_sysmon_subdev() - create a sysmon subdev for the given remoteproc
487 * @rproc: rproc context to associate the subdev with
488 * @name: name of this subdev, to use in SSR
489 * @ssctl_instance: instance id of the ssctl QMI service
491 * Return: A new qcom_sysmon object, or NULL on failure
493 struct qcom_sysmon
*qcom_add_sysmon_subdev(struct rproc
*rproc
,
497 struct qcom_sysmon
*sysmon
;
500 sysmon
= kzalloc(sizeof(*sysmon
), GFP_KERNEL
);
502 return ERR_PTR(-ENOMEM
);
504 sysmon
->dev
= rproc
->dev
.parent
;
505 sysmon
->rproc
= rproc
;
508 sysmon
->ssctl_instance
= ssctl_instance
;
510 init_completion(&sysmon
->comp
);
511 init_completion(&sysmon
->ind_comp
);
512 init_completion(&sysmon
->shutdown_comp
);
513 mutex_init(&sysmon
->lock
);
515 sysmon
->shutdown_irq
= of_irq_get_byname(sysmon
->dev
->of_node
,
517 if (sysmon
->shutdown_irq
< 0) {
518 if (sysmon
->shutdown_irq
!= -ENODATA
) {
520 "failed to retrieve shutdown-ack IRQ\n");
521 return ERR_PTR(sysmon
->shutdown_irq
);
524 ret
= devm_request_threaded_irq(sysmon
->dev
,
525 sysmon
->shutdown_irq
,
526 NULL
, sysmon_shutdown_interrupt
,
527 IRQF_TRIGGER_RISING
| IRQF_ONESHOT
,
528 "q6v5 shutdown-ack", sysmon
);
531 "failed to acquire shutdown-ack IRQ\n");
536 ret
= qmi_handle_init(&sysmon
->qmi
, SSCTL_MAX_MSG_LEN
, &ssctl_ops
,
537 qmi_indication_handler
);
539 dev_err(sysmon
->dev
, "failed to initialize qmi handle\n");
544 qmi_add_lookup(&sysmon
->qmi
, 43, 0, 0);
546 sysmon
->subdev
.start
= sysmon_start
;
547 sysmon
->subdev
.stop
= sysmon_stop
;
549 rproc_add_subdev(rproc
, &sysmon
->subdev
);
551 sysmon
->nb
.notifier_call
= sysmon_notify
;
552 blocking_notifier_chain_register(&sysmon_notifiers
, &sysmon
->nb
);
554 mutex_lock(&sysmon_lock
);
555 list_add(&sysmon
->node
, &sysmon_list
);
556 mutex_unlock(&sysmon_lock
);
560 EXPORT_SYMBOL_GPL(qcom_add_sysmon_subdev
);
563 * qcom_remove_sysmon_subdev() - release a qcom_sysmon
564 * @sysmon: sysmon context, as retrieved by qcom_add_sysmon_subdev()
566 void qcom_remove_sysmon_subdev(struct qcom_sysmon
*sysmon
)
571 mutex_lock(&sysmon_lock
);
572 list_del(&sysmon
->node
);
573 mutex_unlock(&sysmon_lock
);
575 blocking_notifier_chain_unregister(&sysmon_notifiers
, &sysmon
->nb
);
577 rproc_remove_subdev(sysmon
->rproc
, &sysmon
->subdev
);
579 qmi_handle_release(&sysmon
->qmi
);
583 EXPORT_SYMBOL_GPL(qcom_remove_sysmon_subdev
);
586 * sysmon_probe() - probe sys_mon channel
587 * @rpdev: rpmsg device handle
589 * Find the sysmon context associated with the ancestor remoteproc and assign
590 * this rpmsg device with said sysmon context.
592 * Return: 0 on success, negative errno on failure.
594 static int sysmon_probe(struct rpmsg_device
*rpdev
)
596 struct qcom_sysmon
*sysmon
;
599 rproc
= rproc_get_by_child(&rpdev
->dev
);
601 dev_err(&rpdev
->dev
, "sysmon device not child of rproc\n");
605 mutex_lock(&sysmon_lock
);
606 list_for_each_entry(sysmon
, &sysmon_list
, node
) {
607 if (sysmon
->rproc
== rproc
)
610 mutex_unlock(&sysmon_lock
);
612 dev_err(&rpdev
->dev
, "no sysmon associated with parent rproc\n");
617 mutex_unlock(&sysmon_lock
);
619 rpdev
->ept
->priv
= sysmon
;
620 sysmon
->ept
= rpdev
->ept
;
626 * sysmon_remove() - sys_mon channel remove handler
627 * @rpdev: rpmsg device handle
629 * Disassociate the rpmsg device with the sysmon instance.
631 static void sysmon_remove(struct rpmsg_device
*rpdev
)
633 struct qcom_sysmon
*sysmon
= rpdev
->ept
->priv
;
638 static const struct rpmsg_device_id sysmon_match
[] = {
643 static struct rpmsg_driver sysmon_driver
= {
644 .probe
= sysmon_probe
,
645 .remove
= sysmon_remove
,
646 .callback
= sysmon_callback
,
647 .id_table
= sysmon_match
,
649 .name
= "qcom_sysmon",
653 module_rpmsg_driver(sysmon_driver
);
655 MODULE_DESCRIPTION("Qualcomm sysmon driver");
656 MODULE_LICENSE("GPL v2");