195a15d80SSudeep Holla // SPDX-License-Identifier: GPL-2.0
295a15d80SSudeep Holla /*
395a15d80SSudeep Holla * System Control and Management Interface (SCMI) Reset Protocol
495a15d80SSudeep Holla *
523136bffSCristian Marussi * Copyright (C) 2019-2022 ARM Ltd.
695a15d80SSudeep Holla */
795a15d80SSudeep Holla
8469ca182SCristian Marussi #define pr_fmt(fmt) "SCMI Notifications RESET - " fmt
9469ca182SCristian Marussi
10f5800e0bSCristian Marussi #include <linux/module.h>
11469ca182SCristian Marussi #include <linux/scmi_protocol.h>
12469ca182SCristian Marussi
1323136bffSCristian Marussi #include "protocols.h"
14469ca182SCristian Marussi #include "notify.h"
1595a15d80SSudeep Holla
1695a15d80SSudeep Holla enum scmi_reset_protocol_cmd {
1795a15d80SSudeep Holla RESET_DOMAIN_ATTRIBUTES = 0x3,
1895a15d80SSudeep Holla RESET = 0x4,
1995a15d80SSudeep Holla RESET_NOTIFY = 0x5,
20b260fccaSCristian Marussi RESET_DOMAIN_NAME_GET = 0x6,
2195a15d80SSudeep Holla };
2295a15d80SSudeep Holla
2395a15d80SSudeep Holla #define NUM_RESET_DOMAIN_MASK 0xffff
2495a15d80SSudeep Holla #define RESET_NOTIFY_ENABLE BIT(0)
2595a15d80SSudeep Holla
2695a15d80SSudeep Holla struct scmi_msg_resp_reset_domain_attributes {
2795a15d80SSudeep Holla __le32 attributes;
2895a15d80SSudeep Holla #define SUPPORTS_ASYNC_RESET(x) ((x) & BIT(31))
2995a15d80SSudeep Holla #define SUPPORTS_NOTIFY_RESET(x) ((x) & BIT(30))
30b260fccaSCristian Marussi #define SUPPORTS_EXTENDED_NAMES(x) ((x) & BIT(29))
3195a15d80SSudeep Holla __le32 latency;
32b260fccaSCristian Marussi u8 name[SCMI_SHORT_NAME_MAX_SIZE];
3395a15d80SSudeep Holla };
3495a15d80SSudeep Holla
3595a15d80SSudeep Holla struct scmi_msg_reset_domain_reset {
3695a15d80SSudeep Holla __le32 domain_id;
3795a15d80SSudeep Holla __le32 flags;
3895a15d80SSudeep Holla #define AUTONOMOUS_RESET BIT(0)
3995a15d80SSudeep Holla #define EXPLICIT_RESET_ASSERT BIT(1)
4095a15d80SSudeep Holla #define ASYNCHRONOUS_RESET BIT(2)
4195a15d80SSudeep Holla __le32 reset_state;
4245b9e04dSEtienne Carriere #define ARCH_COLD_RESET 0
4395a15d80SSudeep Holla };
4495a15d80SSudeep Holla
45469ca182SCristian Marussi struct scmi_msg_reset_notify {
46469ca182SCristian Marussi __le32 id;
47469ca182SCristian Marussi __le32 event_control;
48469ca182SCristian Marussi #define RESET_TP_NOTIFY_ALL BIT(0)
49469ca182SCristian Marussi };
50469ca182SCristian Marussi
51469ca182SCristian Marussi struct scmi_reset_issued_notify_payld {
52469ca182SCristian Marussi __le32 agent_id;
53469ca182SCristian Marussi __le32 domain_id;
54469ca182SCristian Marussi __le32 reset_state;
55469ca182SCristian Marussi };
56469ca182SCristian Marussi
5795a15d80SSudeep Holla struct reset_dom_info {
5895a15d80SSudeep Holla bool async_reset;
5995a15d80SSudeep Holla bool reset_notify;
6095a15d80SSudeep Holla u32 latency_us;
6195a15d80SSudeep Holla char name[SCMI_MAX_STR_SIZE];
6295a15d80SSudeep Holla };
6395a15d80SSudeep Holla
6495a15d80SSudeep Holla struct scmi_reset_info {
65b55b06b7SSudeep Holla u32 version;
6695a15d80SSudeep Holla int num_domains;
6795a15d80SSudeep Holla struct reset_dom_info *dom_info;
6895a15d80SSudeep Holla };
6995a15d80SSudeep Holla
scmi_reset_attributes_get(const struct scmi_protocol_handle * ph,struct scmi_reset_info * pi)707e029344SCristian Marussi static int scmi_reset_attributes_get(const struct scmi_protocol_handle *ph,
7195a15d80SSudeep Holla struct scmi_reset_info *pi)
7295a15d80SSudeep Holla {
7395a15d80SSudeep Holla int ret;
7495a15d80SSudeep Holla struct scmi_xfer *t;
7595a15d80SSudeep Holla u32 attr;
7695a15d80SSudeep Holla
777e029344SCristian Marussi ret = ph->xops->xfer_get_init(ph, PROTOCOL_ATTRIBUTES,
787e029344SCristian Marussi 0, sizeof(attr), &t);
7995a15d80SSudeep Holla if (ret)
8095a15d80SSudeep Holla return ret;
8195a15d80SSudeep Holla
827e029344SCristian Marussi ret = ph->xops->do_xfer(ph, t);
8395a15d80SSudeep Holla if (!ret) {
8495a15d80SSudeep Holla attr = get_unaligned_le32(t->rx.buf);
8595a15d80SSudeep Holla pi->num_domains = attr & NUM_RESET_DOMAIN_MASK;
8695a15d80SSudeep Holla }
8795a15d80SSudeep Holla
887e029344SCristian Marussi ph->xops->xfer_put(ph, t);
8995a15d80SSudeep Holla return ret;
9095a15d80SSudeep Holla }
9195a15d80SSudeep Holla
9295a15d80SSudeep Holla static int
scmi_reset_domain_attributes_get(const struct scmi_protocol_handle * ph,u32 domain,struct reset_dom_info * dom_info,u32 version)937e029344SCristian Marussi scmi_reset_domain_attributes_get(const struct scmi_protocol_handle *ph,
94b260fccaSCristian Marussi u32 domain, struct reset_dom_info *dom_info,
95b260fccaSCristian Marussi u32 version)
9695a15d80SSudeep Holla {
9795a15d80SSudeep Holla int ret;
98b260fccaSCristian Marussi u32 attributes;
9995a15d80SSudeep Holla struct scmi_xfer *t;
10095a15d80SSudeep Holla struct scmi_msg_resp_reset_domain_attributes *attr;
10195a15d80SSudeep Holla
1027e029344SCristian Marussi ret = ph->xops->xfer_get_init(ph, RESET_DOMAIN_ATTRIBUTES,
1037e029344SCristian Marussi sizeof(domain), sizeof(*attr), &t);
10495a15d80SSudeep Holla if (ret)
10595a15d80SSudeep Holla return ret;
10695a15d80SSudeep Holla
10795a15d80SSudeep Holla put_unaligned_le32(domain, t->tx.buf);
10895a15d80SSudeep Holla attr = t->rx.buf;
10995a15d80SSudeep Holla
1107e029344SCristian Marussi ret = ph->xops->do_xfer(ph, t);
11195a15d80SSudeep Holla if (!ret) {
112b260fccaSCristian Marussi attributes = le32_to_cpu(attr->attributes);
11395a15d80SSudeep Holla
11495a15d80SSudeep Holla dom_info->async_reset = SUPPORTS_ASYNC_RESET(attributes);
11595a15d80SSudeep Holla dom_info->reset_notify = SUPPORTS_NOTIFY_RESET(attributes);
11695a15d80SSudeep Holla dom_info->latency_us = le32_to_cpu(attr->latency);
11795a15d80SSudeep Holla if (dom_info->latency_us == U32_MAX)
11895a15d80SSudeep Holla dom_info->latency_us = 0;
1194314f9f4SCristian Marussi strscpy(dom_info->name, attr->name, SCMI_SHORT_NAME_MAX_SIZE);
12095a15d80SSudeep Holla }
12195a15d80SSudeep Holla
1227e029344SCristian Marussi ph->xops->xfer_put(ph, t);
123b260fccaSCristian Marussi
124b260fccaSCristian Marussi /*
125b260fccaSCristian Marussi * If supported overwrite short name with the extended one;
126b260fccaSCristian Marussi * on error just carry on and use already provided short name.
127b260fccaSCristian Marussi */
128b260fccaSCristian Marussi if (!ret && PROTOCOL_REV_MAJOR(version) >= 0x3 &&
129b260fccaSCristian Marussi SUPPORTS_EXTENDED_NAMES(attributes))
130b260fccaSCristian Marussi ph->hops->extended_name_get(ph, RESET_DOMAIN_NAME_GET, domain,
131b260fccaSCristian Marussi dom_info->name, SCMI_MAX_STR_SIZE);
132b260fccaSCristian Marussi
13395a15d80SSudeep Holla return ret;
13495a15d80SSudeep Holla }
13595a15d80SSudeep Holla
scmi_reset_num_domains_get(const struct scmi_protocol_handle * ph)1367e029344SCristian Marussi static int scmi_reset_num_domains_get(const struct scmi_protocol_handle *ph)
13795a15d80SSudeep Holla {
1387e029344SCristian Marussi struct scmi_reset_info *pi = ph->get_priv(ph);
13995a15d80SSudeep Holla
14095a15d80SSudeep Holla return pi->num_domains;
14195a15d80SSudeep Holla }
14295a15d80SSudeep Holla
143992be5d3SCristian Marussi static const char *
scmi_reset_name_get(const struct scmi_protocol_handle * ph,u32 domain)144992be5d3SCristian Marussi scmi_reset_name_get(const struct scmi_protocol_handle *ph, u32 domain)
1457e029344SCristian Marussi {
1467e029344SCristian Marussi struct scmi_reset_info *pi = ph->get_priv(ph);
1477e029344SCristian Marussi
14895a15d80SSudeep Holla struct reset_dom_info *dom = pi->dom_info + domain;
14995a15d80SSudeep Holla
15095a15d80SSudeep Holla return dom->name;
15195a15d80SSudeep Holla }
15295a15d80SSudeep Holla
scmi_reset_latency_get(const struct scmi_protocol_handle * ph,u32 domain)1537e029344SCristian Marussi static int scmi_reset_latency_get(const struct scmi_protocol_handle *ph,
1547e029344SCristian Marussi u32 domain)
1557e029344SCristian Marussi {
1567e029344SCristian Marussi struct scmi_reset_info *pi = ph->get_priv(ph);
15795a15d80SSudeep Holla struct reset_dom_info *dom = pi->dom_info + domain;
15895a15d80SSudeep Holla
15995a15d80SSudeep Holla return dom->latency_us;
16095a15d80SSudeep Holla }
16195a15d80SSudeep Holla
scmi_domain_reset(const struct scmi_protocol_handle * ph,u32 domain,u32 flags,u32 state)1627e029344SCristian Marussi static int scmi_domain_reset(const struct scmi_protocol_handle *ph, u32 domain,
16395a15d80SSudeep Holla u32 flags, u32 state)
16495a15d80SSudeep Holla {
16595a15d80SSudeep Holla int ret;
16695a15d80SSudeep Holla struct scmi_xfer *t;
16795a15d80SSudeep Holla struct scmi_msg_reset_domain_reset *dom;
1687e029344SCristian Marussi struct scmi_reset_info *pi = ph->get_priv(ph);
169e9076ffbSCristian Marussi struct reset_dom_info *rdom;
17095a15d80SSudeep Holla
171e9076ffbSCristian Marussi if (domain >= pi->num_domains)
172e9076ffbSCristian Marussi return -EINVAL;
173e9076ffbSCristian Marussi
174e9076ffbSCristian Marussi rdom = pi->dom_info + domain;
175*b75c83d9SCristian Marussi if (rdom->async_reset && flags & AUTONOMOUS_RESET)
17695a15d80SSudeep Holla flags |= ASYNCHRONOUS_RESET;
17795a15d80SSudeep Holla
1787e029344SCristian Marussi ret = ph->xops->xfer_get_init(ph, RESET, sizeof(*dom), 0, &t);
17995a15d80SSudeep Holla if (ret)
18095a15d80SSudeep Holla return ret;
18195a15d80SSudeep Holla
18295a15d80SSudeep Holla dom = t->tx.buf;
18395a15d80SSudeep Holla dom->domain_id = cpu_to_le32(domain);
18495a15d80SSudeep Holla dom->flags = cpu_to_le32(flags);
18511ed5cf0SSudeep Holla dom->reset_state = cpu_to_le32(state);
18695a15d80SSudeep Holla
187*b75c83d9SCristian Marussi if (flags & ASYNCHRONOUS_RESET)
1887e029344SCristian Marussi ret = ph->xops->do_xfer_with_response(ph, t);
18995a15d80SSudeep Holla else
1907e029344SCristian Marussi ret = ph->xops->do_xfer(ph, t);
19195a15d80SSudeep Holla
1927e029344SCristian Marussi ph->xops->xfer_put(ph, t);
19395a15d80SSudeep Holla return ret;
19495a15d80SSudeep Holla }
19595a15d80SSudeep Holla
scmi_reset_domain_reset(const struct scmi_protocol_handle * ph,u32 domain)1967e029344SCristian Marussi static int scmi_reset_domain_reset(const struct scmi_protocol_handle *ph,
1977e029344SCristian Marussi u32 domain)
19895a15d80SSudeep Holla {
1997e029344SCristian Marussi return scmi_domain_reset(ph, domain, AUTONOMOUS_RESET,
2007e029344SCristian Marussi ARCH_COLD_RESET);
2017e029344SCristian Marussi }
2027e029344SCristian Marussi
2037e029344SCristian Marussi static int
scmi_reset_domain_assert(const struct scmi_protocol_handle * ph,u32 domain)2047e029344SCristian Marussi scmi_reset_domain_assert(const struct scmi_protocol_handle *ph, u32 domain)
2057e029344SCristian Marussi {
2067e029344SCristian Marussi return scmi_domain_reset(ph, domain, EXPLICIT_RESET_ASSERT,
20795a15d80SSudeep Holla ARCH_COLD_RESET);
20895a15d80SSudeep Holla }
20995a15d80SSudeep Holla
21095a15d80SSudeep Holla static int
scmi_reset_domain_deassert(const struct scmi_protocol_handle * ph,u32 domain)2117e029344SCristian Marussi scmi_reset_domain_deassert(const struct scmi_protocol_handle *ph, u32 domain)
21295a15d80SSudeep Holla {
2137e029344SCristian Marussi return scmi_domain_reset(ph, domain, 0, ARCH_COLD_RESET);
2147e029344SCristian Marussi }
2157e029344SCristian Marussi
2167e029344SCristian Marussi static const struct scmi_reset_proto_ops reset_proto_ops = {
21795a15d80SSudeep Holla .num_domains_get = scmi_reset_num_domains_get,
21895a15d80SSudeep Holla .name_get = scmi_reset_name_get,
21995a15d80SSudeep Holla .latency_get = scmi_reset_latency_get,
22095a15d80SSudeep Holla .reset = scmi_reset_domain_reset,
22195a15d80SSudeep Holla .assert = scmi_reset_domain_assert,
22295a15d80SSudeep Holla .deassert = scmi_reset_domain_deassert,
22395a15d80SSudeep Holla };
22495a15d80SSudeep Holla
scmi_reset_notify(const struct scmi_protocol_handle * ph,u32 domain_id,bool enable)2257e029344SCristian Marussi static int scmi_reset_notify(const struct scmi_protocol_handle *ph,
2267e029344SCristian Marussi u32 domain_id, bool enable)
227469ca182SCristian Marussi {
228469ca182SCristian Marussi int ret;
229469ca182SCristian Marussi u32 evt_cntl = enable ? RESET_TP_NOTIFY_ALL : 0;
230469ca182SCristian Marussi struct scmi_xfer *t;
231469ca182SCristian Marussi struct scmi_msg_reset_notify *cfg;
232469ca182SCristian Marussi
2337e029344SCristian Marussi ret = ph->xops->xfer_get_init(ph, RESET_NOTIFY, sizeof(*cfg), 0, &t);
234469ca182SCristian Marussi if (ret)
235469ca182SCristian Marussi return ret;
236469ca182SCristian Marussi
237469ca182SCristian Marussi cfg = t->tx.buf;
238469ca182SCristian Marussi cfg->id = cpu_to_le32(domain_id);
239469ca182SCristian Marussi cfg->event_control = cpu_to_le32(evt_cntl);
240469ca182SCristian Marussi
2417e029344SCristian Marussi ret = ph->xops->do_xfer(ph, t);
242469ca182SCristian Marussi
2437e029344SCristian Marussi ph->xops->xfer_put(ph, t);
244469ca182SCristian Marussi return ret;
245469ca182SCristian Marussi }
246469ca182SCristian Marussi
scmi_reset_set_notify_enabled(const struct scmi_protocol_handle * ph,u8 evt_id,u32 src_id,bool enable)2473cb8c95fSCristian Marussi static int scmi_reset_set_notify_enabled(const struct scmi_protocol_handle *ph,
248469ca182SCristian Marussi u8 evt_id, u32 src_id, bool enable)
249469ca182SCristian Marussi {
250469ca182SCristian Marussi int ret;
251469ca182SCristian Marussi
2527e029344SCristian Marussi ret = scmi_reset_notify(ph, src_id, enable);
253469ca182SCristian Marussi if (ret)
254469ca182SCristian Marussi pr_debug("FAIL_ENABLED - evt[%X] dom[%d] - ret:%d\n",
255469ca182SCristian Marussi evt_id, src_id, ret);
256469ca182SCristian Marussi
257469ca182SCristian Marussi return ret;
258469ca182SCristian Marussi }
259469ca182SCristian Marussi
2603cb8c95fSCristian Marussi static void *
scmi_reset_fill_custom_report(const struct scmi_protocol_handle * ph,u8 evt_id,ktime_t timestamp,const void * payld,size_t payld_sz,void * report,u32 * src_id)2613cb8c95fSCristian Marussi scmi_reset_fill_custom_report(const struct scmi_protocol_handle *ph,
26272a5eb9dSCristian Marussi u8 evt_id, ktime_t timestamp,
263469ca182SCristian Marussi const void *payld, size_t payld_sz,
264469ca182SCristian Marussi void *report, u32 *src_id)
265469ca182SCristian Marussi {
266469ca182SCristian Marussi const struct scmi_reset_issued_notify_payld *p = payld;
267469ca182SCristian Marussi struct scmi_reset_issued_report *r = report;
268469ca182SCristian Marussi
269469ca182SCristian Marussi if (evt_id != SCMI_EVENT_RESET_ISSUED || sizeof(*p) != payld_sz)
270469ca182SCristian Marussi return NULL;
271469ca182SCristian Marussi
272469ca182SCristian Marussi r->timestamp = timestamp;
273469ca182SCristian Marussi r->agent_id = le32_to_cpu(p->agent_id);
274469ca182SCristian Marussi r->domain_id = le32_to_cpu(p->domain_id);
275469ca182SCristian Marussi r->reset_state = le32_to_cpu(p->reset_state);
276469ca182SCristian Marussi *src_id = r->domain_id;
277469ca182SCristian Marussi
278469ca182SCristian Marussi return r;
279469ca182SCristian Marussi }
280469ca182SCristian Marussi
scmi_reset_get_num_sources(const struct scmi_protocol_handle * ph)2813cb8c95fSCristian Marussi static int scmi_reset_get_num_sources(const struct scmi_protocol_handle *ph)
282533c7095SCristian Marussi {
2833cb8c95fSCristian Marussi struct scmi_reset_info *pinfo = ph->get_priv(ph);
284533c7095SCristian Marussi
285533c7095SCristian Marussi if (!pinfo)
286533c7095SCristian Marussi return -EINVAL;
287533c7095SCristian Marussi
288533c7095SCristian Marussi return pinfo->num_domains;
289533c7095SCristian Marussi }
290533c7095SCristian Marussi
291469ca182SCristian Marussi static const struct scmi_event reset_events[] = {
292469ca182SCristian Marussi {
293469ca182SCristian Marussi .id = SCMI_EVENT_RESET_ISSUED,
294469ca182SCristian Marussi .max_payld_sz = sizeof(struct scmi_reset_issued_notify_payld),
295469ca182SCristian Marussi .max_report_sz = sizeof(struct scmi_reset_issued_report),
296469ca182SCristian Marussi },
297469ca182SCristian Marussi };
298469ca182SCristian Marussi
299469ca182SCristian Marussi static const struct scmi_event_ops reset_event_ops = {
300533c7095SCristian Marussi .get_num_sources = scmi_reset_get_num_sources,
301469ca182SCristian Marussi .set_notify_enabled = scmi_reset_set_notify_enabled,
302469ca182SCristian Marussi .fill_custom_report = scmi_reset_fill_custom_report,
303469ca182SCristian Marussi };
304469ca182SCristian Marussi
305533c7095SCristian Marussi static const struct scmi_protocol_events reset_protocol_events = {
306533c7095SCristian Marussi .queue_sz = SCMI_PROTO_QUEUE_SZ,
307533c7095SCristian Marussi .ops = &reset_event_ops,
308533c7095SCristian Marussi .evts = reset_events,
309533c7095SCristian Marussi .num_events = ARRAY_SIZE(reset_events),
310533c7095SCristian Marussi };
311533c7095SCristian Marussi
scmi_reset_protocol_init(const struct scmi_protocol_handle * ph)3127e029344SCristian Marussi static int scmi_reset_protocol_init(const struct scmi_protocol_handle *ph)
31395a15d80SSudeep Holla {
3144de1b36fSCristian Marussi int domain, ret;
31595a15d80SSudeep Holla u32 version;
31695a15d80SSudeep Holla struct scmi_reset_info *pinfo;
31795a15d80SSudeep Holla
3184de1b36fSCristian Marussi ret = ph->xops->version_get(ph, &version);
3194de1b36fSCristian Marussi if (ret)
3204de1b36fSCristian Marussi return ret;
32195a15d80SSudeep Holla
3227e029344SCristian Marussi dev_dbg(ph->dev, "Reset Version %d.%d\n",
32395a15d80SSudeep Holla PROTOCOL_REV_MAJOR(version), PROTOCOL_REV_MINOR(version));
32495a15d80SSudeep Holla
3257e029344SCristian Marussi pinfo = devm_kzalloc(ph->dev, sizeof(*pinfo), GFP_KERNEL);
32695a15d80SSudeep Holla if (!pinfo)
32795a15d80SSudeep Holla return -ENOMEM;
32895a15d80SSudeep Holla
3294de1b36fSCristian Marussi ret = scmi_reset_attributes_get(ph, pinfo);
3304de1b36fSCristian Marussi if (ret)
3314de1b36fSCristian Marussi return ret;
33295a15d80SSudeep Holla
3337e029344SCristian Marussi pinfo->dom_info = devm_kcalloc(ph->dev, pinfo->num_domains,
33495a15d80SSudeep Holla sizeof(*pinfo->dom_info), GFP_KERNEL);
33595a15d80SSudeep Holla if (!pinfo->dom_info)
33695a15d80SSudeep Holla return -ENOMEM;
33795a15d80SSudeep Holla
33895a15d80SSudeep Holla for (domain = 0; domain < pinfo->num_domains; domain++) {
33995a15d80SSudeep Holla struct reset_dom_info *dom = pinfo->dom_info + domain;
34095a15d80SSudeep Holla
341b260fccaSCristian Marussi scmi_reset_domain_attributes_get(ph, domain, dom, version);
34295a15d80SSudeep Holla }
34395a15d80SSudeep Holla
344b55b06b7SSudeep Holla pinfo->version = version;
3457e029344SCristian Marussi return ph->set_priv(ph, pinfo);
34695a15d80SSudeep Holla }
34795a15d80SSudeep Holla
34848dc16e2SCristian Marussi static const struct scmi_protocol scmi_reset = {
34948dc16e2SCristian Marussi .id = SCMI_PROTOCOL_RESET,
350f5800e0bSCristian Marussi .owner = THIS_MODULE,
3517e029344SCristian Marussi .instance_init = &scmi_reset_protocol_init,
3527e029344SCristian Marussi .ops = &reset_proto_ops,
353533c7095SCristian Marussi .events = &reset_protocol_events,
35448dc16e2SCristian Marussi };
35548dc16e2SCristian Marussi
35648dc16e2SCristian Marussi DEFINE_SCMI_PROTOCOL_REGISTER_UNREGISTER(reset, scmi_reset)
357