1a8803055SCristian Marussi // SPDX-License-Identifier: GPL-2.0
2a8803055SCristian Marussi /*
3a8803055SCristian Marussi * System Control and Management Interface (SCMI) System Power Protocol
4a8803055SCristian Marussi *
523136bffSCristian Marussi * Copyright (C) 2020-2022 ARM Ltd.
6a8803055SCristian Marussi */
7a8803055SCristian Marussi
8a8803055SCristian Marussi #define pr_fmt(fmt) "SCMI Notifications SYSTEM - " fmt
9a8803055SCristian Marussi
10f5800e0bSCristian Marussi #include <linux/module.h>
11a8803055SCristian Marussi #include <linux/scmi_protocol.h>
12a8803055SCristian Marussi
1323136bffSCristian Marussi #include "protocols.h"
14a8803055SCristian Marussi #include "notify.h"
15a8803055SCristian Marussi
16a8803055SCristian Marussi #define SCMI_SYSTEM_NUM_SOURCES 1
17a8803055SCristian Marussi
18a8803055SCristian Marussi enum scmi_system_protocol_cmd {
19a8803055SCristian Marussi SYSTEM_POWER_STATE_NOTIFY = 0x5,
20a8803055SCristian Marussi };
21a8803055SCristian Marussi
22a8803055SCristian Marussi struct scmi_system_power_state_notify {
23a8803055SCristian Marussi __le32 notify_enable;
24a8803055SCristian Marussi };
25a8803055SCristian Marussi
26a8803055SCristian Marussi struct scmi_system_power_state_notifier_payld {
27a8803055SCristian Marussi __le32 agent_id;
28a8803055SCristian Marussi __le32 flags;
29a8803055SCristian Marussi __le32 system_state;
30*7097f298SCristian Marussi __le32 timeout;
31a8803055SCristian Marussi };
32a8803055SCristian Marussi
33a8803055SCristian Marussi struct scmi_system_info {
34a8803055SCristian Marussi u32 version;
35*7097f298SCristian Marussi bool graceful_timeout_supported;
36a8803055SCristian Marussi };
37a8803055SCristian Marussi
scmi_system_request_notify(const struct scmi_protocol_handle * ph,bool enable)38b46d8527SCristian Marussi static int scmi_system_request_notify(const struct scmi_protocol_handle *ph,
39a8803055SCristian Marussi bool enable)
40a8803055SCristian Marussi {
41a8803055SCristian Marussi int ret;
42a8803055SCristian Marussi struct scmi_xfer *t;
43a8803055SCristian Marussi struct scmi_system_power_state_notify *notify;
44a8803055SCristian Marussi
45b46d8527SCristian Marussi ret = ph->xops->xfer_get_init(ph, SYSTEM_POWER_STATE_NOTIFY,
46b46d8527SCristian Marussi sizeof(*notify), 0, &t);
47a8803055SCristian Marussi if (ret)
48a8803055SCristian Marussi return ret;
49a8803055SCristian Marussi
50a8803055SCristian Marussi notify = t->tx.buf;
51a8803055SCristian Marussi notify->notify_enable = enable ? cpu_to_le32(BIT(0)) : 0;
52a8803055SCristian Marussi
53b46d8527SCristian Marussi ret = ph->xops->do_xfer(ph, t);
54a8803055SCristian Marussi
55b46d8527SCristian Marussi ph->xops->xfer_put(ph, t);
56a8803055SCristian Marussi return ret;
57a8803055SCristian Marussi }
58a8803055SCristian Marussi
scmi_system_set_notify_enabled(const struct scmi_protocol_handle * ph,u8 evt_id,u32 src_id,bool enable)593cb8c95fSCristian Marussi static int scmi_system_set_notify_enabled(const struct scmi_protocol_handle *ph,
60a8803055SCristian Marussi u8 evt_id, u32 src_id, bool enable)
61a8803055SCristian Marussi {
62a8803055SCristian Marussi int ret;
63a8803055SCristian Marussi
64b46d8527SCristian Marussi ret = scmi_system_request_notify(ph, enable);
65a8803055SCristian Marussi if (ret)
66a8803055SCristian Marussi pr_debug("FAIL_ENABLE - evt[%X] - ret:%d\n", evt_id, ret);
67a8803055SCristian Marussi
68a8803055SCristian Marussi return ret;
69a8803055SCristian Marussi }
70a8803055SCristian Marussi
713cb8c95fSCristian Marussi static void *
scmi_system_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)723cb8c95fSCristian Marussi scmi_system_fill_custom_report(const struct scmi_protocol_handle *ph,
73a8803055SCristian Marussi u8 evt_id, ktime_t timestamp,
74a8803055SCristian Marussi const void *payld, size_t payld_sz,
75a8803055SCristian Marussi void *report, u32 *src_id)
76a8803055SCristian Marussi {
77*7097f298SCristian Marussi size_t expected_sz;
78a8803055SCristian Marussi const struct scmi_system_power_state_notifier_payld *p = payld;
79a8803055SCristian Marussi struct scmi_system_power_state_notifier_report *r = report;
80*7097f298SCristian Marussi struct scmi_system_info *pinfo = ph->get_priv(ph);
81a8803055SCristian Marussi
82*7097f298SCristian Marussi expected_sz = pinfo->graceful_timeout_supported ?
83*7097f298SCristian Marussi sizeof(*p) : sizeof(*p) - sizeof(__le32);
84a8803055SCristian Marussi if (evt_id != SCMI_EVENT_SYSTEM_POWER_STATE_NOTIFIER ||
85*7097f298SCristian Marussi payld_sz != expected_sz)
86a8803055SCristian Marussi return NULL;
87a8803055SCristian Marussi
88a8803055SCristian Marussi r->timestamp = timestamp;
89a8803055SCristian Marussi r->agent_id = le32_to_cpu(p->agent_id);
90a8803055SCristian Marussi r->flags = le32_to_cpu(p->flags);
91a8803055SCristian Marussi r->system_state = le32_to_cpu(p->system_state);
92*7097f298SCristian Marussi if (pinfo->graceful_timeout_supported &&
93*7097f298SCristian Marussi r->system_state == SCMI_SYSTEM_SHUTDOWN &&
94*7097f298SCristian Marussi SCMI_SYSPOWER_IS_REQUEST_GRACEFUL(r->flags))
95*7097f298SCristian Marussi r->timeout = le32_to_cpu(p->timeout);
96*7097f298SCristian Marussi else
97*7097f298SCristian Marussi r->timeout = 0x00;
98a8803055SCristian Marussi *src_id = 0;
99a8803055SCristian Marussi
100a8803055SCristian Marussi return r;
101a8803055SCristian Marussi }
102a8803055SCristian Marussi
103a8803055SCristian Marussi static const struct scmi_event system_events[] = {
104a8803055SCristian Marussi {
105a8803055SCristian Marussi .id = SCMI_EVENT_SYSTEM_POWER_STATE_NOTIFIER,
106a8803055SCristian Marussi .max_payld_sz =
107a8803055SCristian Marussi sizeof(struct scmi_system_power_state_notifier_payld),
108a8803055SCristian Marussi .max_report_sz =
109a8803055SCristian Marussi sizeof(struct scmi_system_power_state_notifier_report),
110a8803055SCristian Marussi },
111a8803055SCristian Marussi };
112a8803055SCristian Marussi
113a8803055SCristian Marussi static const struct scmi_event_ops system_event_ops = {
114a8803055SCristian Marussi .set_notify_enabled = scmi_system_set_notify_enabled,
115a8803055SCristian Marussi .fill_custom_report = scmi_system_fill_custom_report,
116a8803055SCristian Marussi };
117a8803055SCristian Marussi
118533c7095SCristian Marussi static const struct scmi_protocol_events system_protocol_events = {
119533c7095SCristian Marussi .queue_sz = SCMI_PROTO_QUEUE_SZ,
120533c7095SCristian Marussi .ops = &system_event_ops,
121533c7095SCristian Marussi .evts = system_events,
122533c7095SCristian Marussi .num_events = ARRAY_SIZE(system_events),
123533c7095SCristian Marussi .num_sources = SCMI_SYSTEM_NUM_SOURCES,
124533c7095SCristian Marussi };
125533c7095SCristian Marussi
scmi_system_protocol_init(const struct scmi_protocol_handle * ph)126b46d8527SCristian Marussi static int scmi_system_protocol_init(const struct scmi_protocol_handle *ph)
127a8803055SCristian Marussi {
1284de1b36fSCristian Marussi int ret;
129a8803055SCristian Marussi u32 version;
130a8803055SCristian Marussi struct scmi_system_info *pinfo;
131a8803055SCristian Marussi
1324de1b36fSCristian Marussi ret = ph->xops->version_get(ph, &version);
1334de1b36fSCristian Marussi if (ret)
1344de1b36fSCristian Marussi return ret;
135a8803055SCristian Marussi
136b46d8527SCristian Marussi dev_dbg(ph->dev, "System Power Version %d.%d\n",
137a8803055SCristian Marussi PROTOCOL_REV_MAJOR(version), PROTOCOL_REV_MINOR(version));
138a8803055SCristian Marussi
139b46d8527SCristian Marussi pinfo = devm_kzalloc(ph->dev, sizeof(*pinfo), GFP_KERNEL);
140a8803055SCristian Marussi if (!pinfo)
141a8803055SCristian Marussi return -ENOMEM;
142a8803055SCristian Marussi
143a8803055SCristian Marussi pinfo->version = version;
144*7097f298SCristian Marussi if (PROTOCOL_REV_MAJOR(pinfo->version) >= 0x2)
145*7097f298SCristian Marussi pinfo->graceful_timeout_supported = true;
146*7097f298SCristian Marussi
147b46d8527SCristian Marussi return ph->set_priv(ph, pinfo);
148a8803055SCristian Marussi }
149a8803055SCristian Marussi
15048dc16e2SCristian Marussi static const struct scmi_protocol scmi_system = {
15148dc16e2SCristian Marussi .id = SCMI_PROTOCOL_SYSTEM,
152f5800e0bSCristian Marussi .owner = THIS_MODULE,
153b46d8527SCristian Marussi .instance_init = &scmi_system_protocol_init,
15448dc16e2SCristian Marussi .ops = NULL,
155533c7095SCristian Marussi .events = &system_protocol_events,
15648dc16e2SCristian Marussi };
15748dc16e2SCristian Marussi
15848dc16e2SCristian Marussi DEFINE_SCMI_PROTOCOL_REGISTER_UNREGISTER(system, scmi_system)
159