1 // SPDX-License-Identifier: GPL-2.0
3 * System Control and Management Interface (SCMI) Reset Protocol
5 * Copyright (C) 2019 ARM Ltd.
8 #define pr_fmt(fmt) "SCMI Notifications RESET - " fmt
10 #include <linux/scmi_protocol.h>
15 enum scmi_reset_protocol_cmd {
16 RESET_DOMAIN_ATTRIBUTES = 0x3,
21 #define NUM_RESET_DOMAIN_MASK 0xffff
22 #define RESET_NOTIFY_ENABLE BIT(0)
24 struct scmi_msg_resp_reset_domain_attributes {
26 #define SUPPORTS_ASYNC_RESET(x) ((x) & BIT(31))
27 #define SUPPORTS_NOTIFY_RESET(x) ((x) & BIT(30))
29 u8 name[SCMI_MAX_STR_SIZE];
32 struct scmi_msg_reset_domain_reset {
35 #define AUTONOMOUS_RESET BIT(0)
36 #define EXPLICIT_RESET_ASSERT BIT(1)
37 #define ASYNCHRONOUS_RESET BIT(2)
39 #define ARCH_RESET_TYPE BIT(31)
40 #define COLD_RESET_STATE BIT(0)
41 #define ARCH_COLD_RESET (ARCH_RESET_TYPE | COLD_RESET_STATE)
44 struct scmi_msg_reset_notify {
47 #define RESET_TP_NOTIFY_ALL BIT(0)
50 struct scmi_reset_issued_notify_payld {
56 struct reset_dom_info {
60 char name[SCMI_MAX_STR_SIZE];
63 struct scmi_reset_info {
66 struct reset_dom_info *dom_info;
69 static int scmi_reset_attributes_get(const struct scmi_handle *handle,
70 struct scmi_reset_info *pi)
76 ret = scmi_xfer_get_init(handle, PROTOCOL_ATTRIBUTES,
77 SCMI_PROTOCOL_RESET, 0, sizeof(attr), &t);
81 ret = scmi_do_xfer(handle, t);
83 attr = get_unaligned_le32(t->rx.buf);
84 pi->num_domains = attr & NUM_RESET_DOMAIN_MASK;
87 scmi_xfer_put(handle, t);
92 scmi_reset_domain_attributes_get(const struct scmi_handle *handle, u32 domain,
93 struct reset_dom_info *dom_info)
97 struct scmi_msg_resp_reset_domain_attributes *attr;
99 ret = scmi_xfer_get_init(handle, RESET_DOMAIN_ATTRIBUTES,
100 SCMI_PROTOCOL_RESET, sizeof(domain),
105 put_unaligned_le32(domain, t->tx.buf);
108 ret = scmi_do_xfer(handle, t);
110 u32 attributes = le32_to_cpu(attr->attributes);
112 dom_info->async_reset = SUPPORTS_ASYNC_RESET(attributes);
113 dom_info->reset_notify = SUPPORTS_NOTIFY_RESET(attributes);
114 dom_info->latency_us = le32_to_cpu(attr->latency);
115 if (dom_info->latency_us == U32_MAX)
116 dom_info->latency_us = 0;
117 strlcpy(dom_info->name, attr->name, SCMI_MAX_STR_SIZE);
120 scmi_xfer_put(handle, t);
124 static int scmi_reset_num_domains_get(const struct scmi_handle *handle)
126 struct scmi_reset_info *pi = handle->reset_priv;
128 return pi->num_domains;
131 static char *scmi_reset_name_get(const struct scmi_handle *handle, u32 domain)
133 struct scmi_reset_info *pi = handle->reset_priv;
134 struct reset_dom_info *dom = pi->dom_info + domain;
139 static int scmi_reset_latency_get(const struct scmi_handle *handle, u32 domain)
141 struct scmi_reset_info *pi = handle->reset_priv;
142 struct reset_dom_info *dom = pi->dom_info + domain;
144 return dom->latency_us;
147 static int scmi_domain_reset(const struct scmi_handle *handle, u32 domain,
148 u32 flags, u32 state)
152 struct scmi_msg_reset_domain_reset *dom;
153 struct scmi_reset_info *pi = handle->reset_priv;
154 struct reset_dom_info *rdom = pi->dom_info + domain;
156 if (rdom->async_reset)
157 flags |= ASYNCHRONOUS_RESET;
159 ret = scmi_xfer_get_init(handle, RESET, SCMI_PROTOCOL_RESET,
160 sizeof(*dom), 0, &t);
165 dom->domain_id = cpu_to_le32(domain);
166 dom->flags = cpu_to_le32(flags);
167 dom->reset_state = cpu_to_le32(state);
169 if (rdom->async_reset)
170 ret = scmi_do_xfer_with_response(handle, t);
172 ret = scmi_do_xfer(handle, t);
174 scmi_xfer_put(handle, t);
178 static int scmi_reset_domain_reset(const struct scmi_handle *handle, u32 domain)
180 return scmi_domain_reset(handle, domain, AUTONOMOUS_RESET,
185 scmi_reset_domain_assert(const struct scmi_handle *handle, u32 domain)
187 return scmi_domain_reset(handle, domain, EXPLICIT_RESET_ASSERT,
192 scmi_reset_domain_deassert(const struct scmi_handle *handle, u32 domain)
194 return scmi_domain_reset(handle, domain, 0, ARCH_COLD_RESET);
197 static const struct scmi_reset_ops reset_ops = {
198 .num_domains_get = scmi_reset_num_domains_get,
199 .name_get = scmi_reset_name_get,
200 .latency_get = scmi_reset_latency_get,
201 .reset = scmi_reset_domain_reset,
202 .assert = scmi_reset_domain_assert,
203 .deassert = scmi_reset_domain_deassert,
206 static int scmi_reset_notify(const struct scmi_handle *handle, u32 domain_id,
210 u32 evt_cntl = enable ? RESET_TP_NOTIFY_ALL : 0;
212 struct scmi_msg_reset_notify *cfg;
214 ret = scmi_xfer_get_init(handle, RESET_NOTIFY,
215 SCMI_PROTOCOL_RESET, sizeof(*cfg), 0, &t);
220 cfg->id = cpu_to_le32(domain_id);
221 cfg->event_control = cpu_to_le32(evt_cntl);
223 ret = scmi_do_xfer(handle, t);
225 scmi_xfer_put(handle, t);
229 static int scmi_reset_set_notify_enabled(const struct scmi_handle *handle,
230 u8 evt_id, u32 src_id, bool enable)
234 ret = scmi_reset_notify(handle, src_id, enable);
236 pr_debug("FAIL_ENABLED - evt[%X] dom[%d] - ret:%d\n",
237 evt_id, src_id, ret);
242 static void *scmi_reset_fill_custom_report(const struct scmi_handle *handle,
243 u8 evt_id, ktime_t timestamp,
244 const void *payld, size_t payld_sz,
245 void *report, u32 *src_id)
247 const struct scmi_reset_issued_notify_payld *p = payld;
248 struct scmi_reset_issued_report *r = report;
250 if (evt_id != SCMI_EVENT_RESET_ISSUED || sizeof(*p) != payld_sz)
253 r->timestamp = timestamp;
254 r->agent_id = le32_to_cpu(p->agent_id);
255 r->domain_id = le32_to_cpu(p->domain_id);
256 r->reset_state = le32_to_cpu(p->reset_state);
257 *src_id = r->domain_id;
262 static const struct scmi_event reset_events[] = {
264 .id = SCMI_EVENT_RESET_ISSUED,
265 .max_payld_sz = sizeof(struct scmi_reset_issued_notify_payld),
266 .max_report_sz = sizeof(struct scmi_reset_issued_report),
270 static const struct scmi_event_ops reset_event_ops = {
271 .set_notify_enabled = scmi_reset_set_notify_enabled,
272 .fill_custom_report = scmi_reset_fill_custom_report,
275 static int scmi_reset_protocol_init(struct scmi_handle *handle)
279 struct scmi_reset_info *pinfo;
281 scmi_version_get(handle, SCMI_PROTOCOL_RESET, &version);
283 dev_dbg(handle->dev, "Reset Version %d.%d\n",
284 PROTOCOL_REV_MAJOR(version), PROTOCOL_REV_MINOR(version));
286 pinfo = devm_kzalloc(handle->dev, sizeof(*pinfo), GFP_KERNEL);
290 scmi_reset_attributes_get(handle, pinfo);
292 pinfo->dom_info = devm_kcalloc(handle->dev, pinfo->num_domains,
293 sizeof(*pinfo->dom_info), GFP_KERNEL);
294 if (!pinfo->dom_info)
297 for (domain = 0; domain < pinfo->num_domains; domain++) {
298 struct reset_dom_info *dom = pinfo->dom_info + domain;
300 scmi_reset_domain_attributes_get(handle, domain, dom);
303 scmi_register_protocol_events(handle,
304 SCMI_PROTOCOL_RESET, SCMI_PROTO_QUEUE_SZ,
305 &reset_event_ops, reset_events,
306 ARRAY_SIZE(reset_events),
309 pinfo->version = version;
310 handle->reset_ops = &reset_ops;
311 handle->reset_priv = pinfo;
316 DEFINE_SCMI_PROTOCOL_REGISTER_UNREGISTER(SCMI_PROTOCOL_RESET, reset)