Soby Mathew | ea26bad | 2016-11-14 12:25:45 +0000 | [diff] [blame] | 1 | /* |
Nicola Mazzucato | 7baee44 | 2021-04-08 14:17:25 +0100 | [diff] [blame] | 2 | * Copyright (c) 2017-2021, ARM Limited and Contributors. All rights reserved. |
Soby Mathew | ea26bad | 2016-11-14 12:25:45 +0000 | [diff] [blame] | 3 | * |
| 4 | * SPDX-License-Identifier: BSD-3-Clause |
| 5 | */ |
| 6 | |
Antonio Nino Diaz | 5eb8837 | 2018-11-08 10:20:19 +0000 | [diff] [blame] | 7 | #ifndef SCMI_H |
| 8 | #define SCMI_H |
Soby Mathew | ea26bad | 2016-11-14 12:25:45 +0000 | [diff] [blame] | 9 | |
Soby Mathew | ea26bad | 2016-11-14 12:25:45 +0000 | [diff] [blame] | 10 | #include <stddef.h> |
| 11 | #include <stdint.h> |
Antonio Nino Diaz | e0f9063 | 2018-12-14 00:18:21 +0000 | [diff] [blame] | 12 | |
| 13 | #include <lib/bakery_lock.h> |
| 14 | #include <lib/psci/psci.h> |
| 15 | #include <lib/spinlock.h> |
Soby Mathew | ea26bad | 2016-11-14 12:25:45 +0000 | [diff] [blame] | 16 | |
| 17 | /* Supported SCMI Protocol Versions */ |
Dimitris Papastamos | aeaf1f0 | 2018-04-03 14:58:17 +0100 | [diff] [blame] | 18 | #define SCMI_AP_CORE_PROTO_VER MAKE_SCMI_VERSION(1, 0) |
Nicola Mazzucato | 7baee44 | 2021-04-08 14:17:25 +0100 | [diff] [blame] | 19 | #define SCMI_PWR_DMN_PROTO_VER MAKE_SCMI_VERSION(2, 0) |
Soby Mathew | ea26bad | 2016-11-14 12:25:45 +0000 | [diff] [blame] | 20 | #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 Mazzucato | 4dc37a1 | 2021-06-07 22:53:27 +0100 | [diff] [blame^] | 28 | /* |
| 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 Mathew | ea26bad | 2016-11-14 12:25:45 +0000 | [diff] [blame] | 34 | #define is_scmi_version_compatible(drv, scmi) \ |
Nicola Mazzucato | 4dc37a1 | 2021-06-07 22:53:27 +0100 | [diff] [blame^] | 35 | ((GET_SCMI_MAJOR_VER(drv) > GET_SCMI_MAJOR_VER(scmi)) || \ |
Soby Mathew | ea26bad | 2016-11-14 12:25:45 +0000 | [diff] [blame] | 36 | ((GET_SCMI_MAJOR_VER(drv) == GET_SCMI_MAJOR_VER(scmi)) && \ |
Nicola Mazzucato | 4dc37a1 | 2021-06-07 22:53:27 +0100 | [diff] [blame^] | 37 | (GET_SCMI_MINOR_VER(drv) <= GET_SCMI_MINOR_VER(scmi)))) |
Soby Mathew | ea26bad | 2016-11-14 12:25:45 +0000 | [diff] [blame] | 38 | |
| 39 | /* SCMI Protocol identifiers */ |
| 40 | #define SCMI_PWR_DMN_PROTO_ID 0x11 |
| 41 | #define SCMI_SYS_PWR_PROTO_ID 0x12 |
Dimitris Papastamos | aeaf1f0 | 2018-04-03 14:58:17 +0100 | [diff] [blame] | 42 | /* The AP core protocol is a CSS platform-specific extension */ |
| 43 | #define SCMI_AP_CORE_PROTO_ID 0x90 |
Soby Mathew | ea26bad | 2016-11-14 12:25:45 +0000 | [diff] [blame] | 44 | |
| 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 Papastamos | aeaf1f0 | 2018-04-03 14:58:17 +0100 | [diff] [blame] | 58 | /* 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 Mathew | ea26bad | 2016-11-14 12:25:45 +0000 | [diff] [blame] | 62 | /* 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 Papastamos | aeaf1f0 | 2018-04-03 14:58:17 +0100 | [diff] [blame] | 92 | /* |
| 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 Mathew | ea26bad | 2016-11-14 12:25:45 +0000 | [diff] [blame] | 99 | /* 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 | */ |
| 113 | typedef 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 Parikh | 59cfa13 | 2017-11-23 14:23:21 +0530 | [diff] [blame] | 122 | /* 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 Mathew | ea26bad | 2016-11-14 12:25:45 +0000 | [diff] [blame] | 126 | } scmi_channel_plat_info_t; |
| 127 | |
Roberto Vargas | 0099694 | 2017-11-13 13:41:58 +0000 | [diff] [blame] | 128 | |
| 129 | #if HW_ASSISTED_COHERENCY |
| 130 | typedef spinlock_t scmi_lock_t; |
| 131 | #else |
| 132 | typedef bakery_lock_t scmi_lock_t; |
| 133 | #endif |
| 134 | |
Soby Mathew | ea26bad | 2016-11-14 12:25:45 +0000 | [diff] [blame] | 135 | /* |
| 136 | * Structure to represent an SCMI channel. |
| 137 | */ |
| 138 | typedef struct scmi_channel { |
| 139 | scmi_channel_plat_info_t *info; |
| 140 | /* The lock for channel access */ |
Roberto Vargas | 0099694 | 2017-11-13 13:41:58 +0000 | [diff] [blame] | 141 | scmi_lock_t *lock; |
Soby Mathew | ea26bad | 2016-11-14 12:25:45 +0000 | [diff] [blame] | 142 | /* Indicate whether the channel is initialized */ |
| 143 | int is_initialized; |
| 144 | } scmi_channel_t; |
| 145 | |
| 146 | /* External Common API */ |
| 147 | void *scmi_init(scmi_channel_t *ch); |
| 148 | int scmi_proto_msg_attr(void *p, uint32_t proto_id, uint32_t command_id, |
| 149 | uint32_t *attr); |
| 150 | int 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 | */ |
| 156 | int scmi_pwr_state_set(void *p, uint32_t domain_id, uint32_t scmi_pwr_state); |
| 157 | int 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 | */ |
| 163 | int scmi_sys_pwr_state_set(void *p, uint32_t flags, uint32_t system_state); |
| 164 | int scmi_sys_pwr_state_get(void *p, uint32_t *system_state); |
| 165 | |
Dimitris Papastamos | aeaf1f0 | 2018-04-03 14:58:17 +0100 | [diff] [blame] | 166 | /* SCMI AP core configuration protocol commands. */ |
| 167 | int scmi_ap_core_set_reset_addr(void *p, uint64_t reset_addr, uint32_t attr); |
| 168 | int scmi_ap_core_get_reset_addr(void *p, uint64_t *reset_addr, uint32_t *attr); |
| 169 | |
Chandni Cherukuri | 61f3a7c | 2018-10-11 14:08:08 +0530 | [diff] [blame] | 170 | /* API to get the platform specific SCMI channel information. */ |
Aditya Angadi | 7f8837b | 2019-12-31 14:23:53 +0530 | [diff] [blame] | 171 | scmi_channel_plat_info_t *plat_css_get_scmi_info(int channel_id); |
Chandni Cherukuri | 61f3a7c | 2018-10-11 14:08:08 +0530 | [diff] [blame] | 172 | |
Chandni Cherukuri | e4bf6a0 | 2018-11-14 13:43:59 +0530 | [diff] [blame] | 173 | /* API to override default PSCI callbacks for platforms that support SCMI. */ |
| 174 | const plat_psci_ops_t *css_scmi_override_pm_ops(plat_psci_ops_t *ops); |
| 175 | |
Antonio Nino Diaz | 5eb8837 | 2018-11-08 10:20:19 +0000 | [diff] [blame] | 176 | #endif /* SCMI_H */ |