blob: 356012bf925f5f6aec073dbe7e80c475c2698667 [file] [log] [blame]
Soby Mathewea26bad2016-11-14 12:25:45 +00001/*
Nicola Mazzucato7baee442021-04-08 14:17:25 +01002 * Copyright (c) 2017-2021, ARM Limited and Contributors. All rights reserved.
Soby Mathewea26bad2016-11-14 12:25:45 +00003 *
4 * SPDX-License-Identifier: BSD-3-Clause
5 */
6
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +00007#ifndef SCMI_H
8#define SCMI_H
Soby Mathewea26bad2016-11-14 12:25:45 +00009
Soby Mathewea26bad2016-11-14 12:25:45 +000010#include <stddef.h>
11#include <stdint.h>
Antonio Nino Diaze0f90632018-12-14 00:18:21 +000012
13#include <lib/bakery_lock.h>
14#include <lib/psci/psci.h>
15#include <lib/spinlock.h>
Soby Mathewea26bad2016-11-14 12:25:45 +000016
17/* Supported SCMI Protocol Versions */
Dimitris Papastamosaeaf1f02018-04-03 14:58:17 +010018#define SCMI_AP_CORE_PROTO_VER MAKE_SCMI_VERSION(1, 0)
Nicola Mazzucato7baee442021-04-08 14:17:25 +010019#define SCMI_PWR_DMN_PROTO_VER MAKE_SCMI_VERSION(2, 0)
Soby Mathewea26bad2016-11-14 12:25:45 +000020#define SCMI_SYS_PWR_PROTO_VER MAKE_SCMI_VERSION(1, 0)
21
22#define GET_SCMI_MAJOR_VER(ver) (((ver) >> 16) & 0xffff)
23#define GET_SCMI_MINOR_VER(ver) ((ver) & 0xffff)
24
25#define MAKE_SCMI_VERSION(maj, min) \
26 ((((maj) & 0xffff) << 16) | ((min) & 0xffff))
27
Nicola Mazzucato4dc37a12021-06-07 22:53:27 +010028/*
29 * Check that the driver's version is same or higher than the reported SCMI
30 * version. We accept lower major version numbers, as all affected protocols
31 * so far stay backwards compatible. This might need to be revisited in the
32 * future.
33 */
Soby Mathewea26bad2016-11-14 12:25:45 +000034#define is_scmi_version_compatible(drv, scmi) \
Nicola Mazzucato4dc37a12021-06-07 22:53:27 +010035 ((GET_SCMI_MAJOR_VER(drv) > GET_SCMI_MAJOR_VER(scmi)) || \
Soby Mathewea26bad2016-11-14 12:25:45 +000036 ((GET_SCMI_MAJOR_VER(drv) == GET_SCMI_MAJOR_VER(scmi)) && \
Nicola Mazzucato4dc37a12021-06-07 22:53:27 +010037 (GET_SCMI_MINOR_VER(drv) <= GET_SCMI_MINOR_VER(scmi))))
Soby Mathewea26bad2016-11-14 12:25:45 +000038
39/* SCMI Protocol identifiers */
40#define SCMI_PWR_DMN_PROTO_ID 0x11
41#define SCMI_SYS_PWR_PROTO_ID 0x12
Dimitris Papastamosaeaf1f02018-04-03 14:58:17 +010042/* The AP core protocol is a CSS platform-specific extension */
43#define SCMI_AP_CORE_PROTO_ID 0x90
Soby Mathewea26bad2016-11-14 12:25:45 +000044
45/* Mandatory messages IDs for all SCMI protocols */
46#define SCMI_PROTO_VERSION_MSG 0x0
47#define SCMI_PROTO_ATTR_MSG 0x1
48#define SCMI_PROTO_MSG_ATTR_MSG 0x2
49
50/* SCMI power domain management protocol message IDs */
51#define SCMI_PWR_STATE_SET_MSG 0x4
52#define SCMI_PWR_STATE_GET_MSG 0x5
53
54/* SCMI system power management protocol message IDs */
55#define SCMI_SYS_PWR_STATE_SET_MSG 0x3
56#define SCMI_SYS_PWR_STATE_GET_MSG 0x4
57
Dimitris Papastamosaeaf1f02018-04-03 14:58:17 +010058/* SCMI AP core protocol message IDs */
59#define SCMI_AP_CORE_RESET_ADDR_SET_MSG 0x3
60#define SCMI_AP_CORE_RESET_ADDR_GET_MSG 0x4
61
Soby Mathewea26bad2016-11-14 12:25:45 +000062/* Helper macros for system power management protocol commands */
63
64/*
65 * Macros to describe the bit-fields of the `attribute` of system power domain
66 * protocol PROTOCOL_MSG_ATTRIBUTE message.
67 */
68#define SYS_PWR_ATTR_WARM_RESET_SHIFT 31
69#define SCMI_SYS_PWR_WARM_RESET_SUPPORTED (1U << SYS_PWR_ATTR_WARM_RESET_SHIFT)
70
71#define SYS_PWR_ATTR_SUSPEND_SHIFT 30
72#define SCMI_SYS_PWR_SUSPEND_SUPPORTED (1 << SYS_PWR_ATTR_SUSPEND_SHIFT)
73
74/*
75 * Macros to describe the bit-fields of the `flags` parameter of system power
76 * domain protocol SYSTEM_POWER_STATE_SET message.
77 */
78#define SYS_PWR_SET_GRACEFUL_REQ_SHIFT 0
79#define SCMI_SYS_PWR_GRACEFUL_REQ (1 << SYS_PWR_SET_GRACEFUL_REQ_SHIFT)
80#define SCMI_SYS_PWR_FORCEFUL_REQ (0 << SYS_PWR_SET_GRACEFUL_REQ_SHIFT)
81
82/*
83 * Macros to describe the `system_state` parameter of system power
84 * domain protocol SYSTEM_POWER_STATE_SET message.
85 */
86#define SCMI_SYS_PWR_SHUTDOWN 0x0
87#define SCMI_SYS_PWR_COLD_RESET 0x1
88#define SCMI_SYS_PWR_WARM_RESET 0x2
89#define SCMI_SYS_PWR_POWER_UP 0x3
90#define SCMI_SYS_PWR_SUSPEND 0x4
91
Dimitris Papastamosaeaf1f02018-04-03 14:58:17 +010092/*
93 * Macros to describe the bit-fields of the `attribute` of AP core protocol
94 * AP_CORE_RESET_ADDR set/get messages.
95 */
96#define SCMI_AP_CORE_LOCK_ATTR_SHIFT 0x0
97#define SCMI_AP_CORE_LOCK_ATTR (1U << SCMI_AP_CORE_LOCK_ATTR_SHIFT)
98
Soby Mathewea26bad2016-11-14 12:25:45 +000099/* SCMI Error code definitions */
100#define SCMI_E_QUEUED 1
101#define SCMI_E_SUCCESS 0
102#define SCMI_E_NOT_SUPPORTED -1
103#define SCMI_E_INVALID_PARAM -2
104#define SCMI_E_DENIED -3
105#define SCMI_E_NOT_FOUND -4
106#define SCMI_E_OUT_OF_RANGE -5
107#define SCMI_E_BUSY -6
108
109/*
110 * SCMI driver platform information. The details of the doorbell mechanism
111 * can be found in the SCMI specification.
112 */
113typedef struct scmi_channel_plat_info {
114 /* SCMI mailbox memory */
115 uintptr_t scmi_mbx_mem;
116 /* The door bell register address */
117 uintptr_t db_reg_addr;
118 /* The bit mask that need to be preserved when ringing doorbell */
119 uint32_t db_preserve_mask;
120 /* The bit mask that need to be set to ring doorbell */
121 uint32_t db_modify_mask;
Samarth Parikh59cfa132017-11-23 14:23:21 +0530122 /* The handler for ringing doorbell */
123 void (*ring_doorbell)(struct scmi_channel_plat_info *plat_info);
124 /* cookie is unused now. But added for future enhancements. */
125 void *cookie;
Soby Mathewea26bad2016-11-14 12:25:45 +0000126} scmi_channel_plat_info_t;
127
Roberto Vargas00996942017-11-13 13:41:58 +0000128
129#if HW_ASSISTED_COHERENCY
130typedef spinlock_t scmi_lock_t;
131#else
132typedef bakery_lock_t scmi_lock_t;
133#endif
134
Soby Mathewea26bad2016-11-14 12:25:45 +0000135/*
136 * Structure to represent an SCMI channel.
137 */
138typedef struct scmi_channel {
139 scmi_channel_plat_info_t *info;
140 /* The lock for channel access */
Roberto Vargas00996942017-11-13 13:41:58 +0000141 scmi_lock_t *lock;
Soby Mathewea26bad2016-11-14 12:25:45 +0000142 /* Indicate whether the channel is initialized */
143 int is_initialized;
144} scmi_channel_t;
145
146/* External Common API */
147void *scmi_init(scmi_channel_t *ch);
148int scmi_proto_msg_attr(void *p, uint32_t proto_id, uint32_t command_id,
149 uint32_t *attr);
150int scmi_proto_version(void *p, uint32_t proto_id, uint32_t *version);
151
152/*
153 * Power domain protocol commands. Refer to the SCMI specification for more
154 * details on these commands.
155 */
156int scmi_pwr_state_set(void *p, uint32_t domain_id, uint32_t scmi_pwr_state);
157int scmi_pwr_state_get(void *p, uint32_t domain_id, uint32_t *scmi_pwr_state);
158
159/*
160 * System power management protocol commands. Refer SCMI specification for more
161 * details on these commands.
162 */
163int scmi_sys_pwr_state_set(void *p, uint32_t flags, uint32_t system_state);
164int scmi_sys_pwr_state_get(void *p, uint32_t *system_state);
165
Dimitris Papastamosaeaf1f02018-04-03 14:58:17 +0100166/* SCMI AP core configuration protocol commands. */
167int scmi_ap_core_set_reset_addr(void *p, uint64_t reset_addr, uint32_t attr);
168int scmi_ap_core_get_reset_addr(void *p, uint64_t *reset_addr, uint32_t *attr);
169
Chandni Cherukuri61f3a7c2018-10-11 14:08:08 +0530170/* API to get the platform specific SCMI channel information. */
Tony K Nadackal1b116a82022-12-07 20:44:05 +0000171scmi_channel_plat_info_t *plat_css_get_scmi_info(unsigned int channel_id);
Chandni Cherukuri61f3a7c2018-10-11 14:08:08 +0530172
Chandni Cherukurie4bf6a02018-11-14 13:43:59 +0530173/* API to override default PSCI callbacks for platforms that support SCMI. */
174const plat_psci_ops_t *css_scmi_override_pm_ops(plat_psci_ops_t *ops);
175
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +0000176#endif /* SCMI_H */