Loading...
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 | /* SPDX-License-Identifier: BSD-3-Clause */
/*
* Copyright (c) 2015-2019, Arm Limited and Contributors. All rights reserved.
* Copyright (c) 2019-2021, Linaro Limited
*/
#ifndef SCMI_MSG_H
#define SCMI_MSG_H
#include <compiler.h>
#include <kernel/panic.h>
#include <mm/core_memprot.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
/* Minimum size expected for SMT based shared memory message buffers */
#define SMT_BUF_SLOT_SIZE U(128)
/* Standard values for SCMI voltage domain protocol configuration state */
#define SCMI_VOLTAGE_DOMAIN_CONFIG_ARCH_ON U(0x7)
#define SCMI_VOLTAGE_DOMAIN_CONFIG_ARCH_OFF U(0)
/* A channel abstract a communication path between agent and server */
struct scmi_msg_channel;
/*
* struct scmi_msg_channel - Shared memory buffer for a agent-to-server channel
*
* @shm_addr: Address of the shared memory for the SCMI channel
* @shm_size: Byte size of the shared memory for the SCMI channel
* @busy: True when channel is busy, flase when channel is free
* @threaded: True is executed in a threaded context, false otherwise
*/
struct scmi_msg_channel {
struct io_pa_va shm_addr;
size_t shm_size;
bool busy;
bool threaded;
};
#ifdef CFG_SCMI_MSG_SMT
/*
* Initialize SMT memory buffer, called by platform at init for each
* agent channel using the SMT header format.
* This function depends on CFG_SCMI_MSG_SMT.
*
* @chan: Pointer to the channel shared memory to be initialized
*/
void scmi_smt_init_agent_channel(struct scmi_msg_channel *channel);
/*
* Set SMT shared buffer location
*
* @channel: SCMI channel reference
* @base: virtual address of the shared buffer or NULL to clear the reference
*/
void scmi_smt_set_shared_buffer(struct scmi_msg_channel *channel, void *base);
#else
static inline
void scmi_smt_init_agent_channel(struct scmi_msg_channel *channel __unused)
{
panic();
}
static inline
void scmi_smt_set_shared_buffer(struct scmi_msg_channel *channel __unused,
void *base __unused)
{
}
#endif /* CFG_SCMI_MSG_SMT */
#ifdef CFG_SCMI_MSG_SMT_FASTCALL_ENTRY
/*
* Process SMT formatted message in a fastcall SMC execution context.
* Called by platform on SMC entry. When returning, output message is
* available in shared memory for agent to read the response.
* This function depends on CFG_SCMI_MSG_SMT_FASTCALL_ENTRY.
*
* @channel_id: SCMI channel ID the SMT belongs to
*/
void scmi_smt_fastcall_smc_entry(unsigned int channel_id);
#else
static inline void scmi_smt_fastcall_smc_entry(unsigned int channel_id __unused)
{
}
#endif
#ifdef CFG_SCMI_MSG_SMT_INTERRUPT_ENTRY
/*
* Process SMT formatted message in a secure interrupt execution context.
* Called by platform interrupt handler. When returning, output message is
* available in shared memory for agent to read the response.
* This function depends on CFG_SCMI_MSG_SMT_INTERRUPT_ENTRY.
*
* @channel_id: SCMI channel ID the SMT belongs to
*/
void scmi_smt_interrupt_entry(unsigned int channel_id);
#else
static inline void scmi_smt_interrupt_entry(unsigned int channel_id __unused)
{
}
#endif
#ifdef CFG_SCMI_MSG_SMT_THREAD_ENTRY
/*
* Process SMT formatted message in a TEE thread execution context.
* When returning, output message is available in shared memory for
* agent to read the response.
* This function depends on CFG_SCMI_MSG_SMT_THREAD_ENTRY.
*
* @channel_id: SCMI channel ID the SMT belongs to
*/
void scmi_smt_threaded_entry(unsigned int channel_id);
#else
static inline void scmi_smt_threaded_entry(unsigned int channel_id __unused)
{
}
#endif
/* Platform callback functions */
/*
* Return the SCMI channel related to an agent
* @channel_id: SCMI channel ID
* Return a pointer to channel on success, NULL otherwise
*/
struct scmi_msg_channel *plat_scmi_get_channel(unsigned int channel_id);
/* Scmi-msg uses the channel ID as handle. Must channel_id is valid */
static inline unsigned int scmi_smt_channel_handle(unsigned int channel_id)
{
assert(plat_scmi_get_channel(channel_id));
return channel_id;
}
/*
* Return how many SCMI protocols supported by the platform
* According to the SCMI specification, this function does not target
* a specific channel ID and shall return all platform known capabilities.
*/
size_t plat_scmi_protocol_count(void);
/*
* Get the count and list of SCMI protocols (but base) supported for an agent
*
* @channel_id: SCMI channel ID
* Return a pointer to a null terminated array supported protocol IDs.
*/
const uint8_t *plat_scmi_protocol_list(unsigned int channel_id);
/* Get the name of the SCMI vendor for the platform */
const char *plat_scmi_vendor_name(void);
/* Get the name of the SCMI sub-vendor for the platform */
const char *plat_scmi_sub_vendor_name(void);
/* Handlers for SCMI Clock protocol services */
/*
* Return number of clock controllers for an agent
* @channel_id: SCMI channel ID
* Return number of clock controllers
*/
size_t plat_scmi_clock_count(unsigned int channel_id);
/*
* Get clock controller string ID (aka name)
* @channel_id: SCMI channel ID
* @scmi_id: SCMI clock ID
* Return pointer to name or NULL
*/
const char *plat_scmi_clock_get_name(unsigned int channel_id,
unsigned int scmi_id);
/*
* Get clock possible rate as an array of frequencies in Hertz.
*
* @channel_id: SCMI channel ID
* @scmi_id: SCMI clock ID
* @start_index: Requested start index for the exposed rates array
* @rates: If NULL, function returns, else output rates array
* @nb_elts: Array size of @rates.
* Return an SCMI compliant error code
*/
int32_t plat_scmi_clock_rates_array(unsigned int channel_id,
unsigned int scmi_id, size_t start_index,
unsigned long *rates, size_t *nb_elts);
/*
* Get clock possible rate as range with regular steps in Hertz
*
* @channel_id: SCMI channel ID
* @scmi_id: SCMI clock ID
* @min_max_step: 3 cell array for min, max and step rate data
* Return an SCMI compliant error code
*/
int32_t plat_scmi_clock_rates_by_step(unsigned int channel_id,
unsigned int scmi_id,
unsigned long *min_max_step);
/*
* Get clock rate in Hertz
* @channel_id: SCMI channel ID
* @scmi_id: SCMI clock ID
* Return clock rate or 0 if not supported
*/
unsigned long plat_scmi_clock_get_rate(unsigned int channel_id,
unsigned int scmi_id);
/*
* Set clock rate in Hertz
* @channel_id: SCMI channel ID
* @scmi_id: SCMI clock ID
* @rate: Target clock frequency in Hertz
* Return a compliant SCMI error code
*/
int32_t plat_scmi_clock_set_rate(unsigned int channel_id, unsigned int scmi_id,
unsigned long rate);
/*
* Get clock state (enabled or disabled)
* @channel_id: SCMI channel ID
* @scmi_id: SCMI clock ID
* Return 1 if clock is enabled, 0 if disables, or a negative SCMI error code
*/
int32_t plat_scmi_clock_get_state(unsigned int channel_id,
unsigned int scmi_id);
/*
* Get clock state (enabled or disabled)
* @channel_id: SCMI channel ID
* @scmi_id: SCMI clock ID
* @enable_not_disable: Enable clock if true, disable clock otherwise
* Return a compliant SCMI error code
*/
int32_t plat_scmi_clock_set_state(unsigned int channel_id, unsigned int scmi_id,
bool enable_not_disable);
/* Handlers for SCMI Reset Domain protocol services */
/*
* Return number of reset domains for the agent
* @channel_id: SCMI channel ID
* Return number of reset domains
*/
size_t plat_scmi_rd_count(unsigned int channel_id);
/*
* Get reset domain string ID (aka name)
* @channel_id: SCMI channel ID
* @scmi_id: SCMI reset domain ID
* Return pointer to name or NULL
*/
const char *plat_scmi_rd_get_name(unsigned int channel_id,
unsigned int scmi_id);
/*
* Perform a reset cycle on a target reset domain
* @channel_id: SCMI channel ID
* @scmi_id: SCMI reset domain ID
* @state: Target reset state (see SCMI specification, 0 means context loss)
* Return a compliant SCMI error code
*/
int32_t plat_scmi_rd_autonomous(unsigned int channel_id, unsigned int scmi_id,
unsigned int state);
/*
* Assert or deassert target reset domain
* @channel_id: SCMI channel ID
* @scmi_id: SCMI reset domain ID
* @assert_not_deassert: Assert domain if true, otherwise deassert domain
* Return a compliant SCMI error code
*/
int32_t plat_scmi_rd_set_state(unsigned int channel_id, unsigned int scmi_id,
bool assert_not_deassert);
/* Handlers for SCMI Voltage Domain protocol services */
/*
* Return number of voltage domain for an agent
* @channel_id: SCMI channel ID
* Return number of voltage domains
*/
size_t plat_scmi_voltd_count(unsigned int channel_id);
/*
* Get clock controller string ID (aka name)
* @channel_id: SCMI channel ID
* @scmi_id: SCMI voltage domain ID
* Return pointer to name or NULL
*/
const char *plat_scmi_voltd_get_name(unsigned int channel_id,
unsigned int scmi_id);
/*
* Get voltage domain possible levels as an array of voltages in microvolt.
*
* @channel_id: SCMI channel ID
* @scmi_id: SCMI voltage domain ID
* @start_index: Level index to start from.
* @levels: If NULL, function returns, else output rates array
* @nb_elts: Array size of @levels.
* Return an SCMI compliant error code
*/
int32_t plat_scmi_voltd_levels_array(unsigned int channel_id,
unsigned int scmi_id, size_t start_index,
long *levels, size_t *nb_elts);
/*
* Get voltage domain possible levels as range with regular steps in microvolt
*
* @channel_id: SCMI channel ID
* @scmi_id: SCMI voltage domain ID
* @min_max_step: 3 cell array for min, max and step voltage data
* Return an SCMI compliant error code
*/
int32_t plat_scmi_voltd_levels_by_step(unsigned int channel_id,
unsigned int scmi_id,
long *min_max_step);
/*
* Get current voltage domain level in microvolt
* @channel_id: SCMI channel ID
* @scmi_id: SCMI voltage domain ID
* Return clock rate or 0 if not supported
*/
long plat_scmi_voltd_get_level(unsigned int channel_id, unsigned int scmi_id);
/*
* Set voltage domain level voltage domain
* @channel_id: SCMI channel ID
* @scmi_id: SCMI clock ID
* @level: Target voltage domain level in microvolt
* Return a compliant SCMI error code
*/
int32_t plat_scmi_voltd_set_level(unsigned int channel_id, unsigned int scmi_id,
long level);
/*
* Get voltage domain state configuration (enabled or disabled)
* @channel_id: SCMI channel ID
* @scmi_id: SCMI voltage domain ID
* @config: output state configuration value SCMI_VOLTAGE_DOMAIN_CONFIG_*
* Return a compliant SCMI error code
*/
int32_t plat_scmi_voltd_get_config(unsigned int channel_id,
unsigned int scmi_id, uint32_t *config);
/*
* Get voltage domain state configuration (enabled or disabled)
* @channel_id: SCMI channel ID
* @scmi_id: SCMI voltage domain ID
* @config: Target state configuration value SCMI_VOLTAGE_DOMAIN_CONFIG_*
* Return a compliant SCMI error code
*/
int32_t plat_scmi_voltd_set_config(unsigned int channel_id,
unsigned int scmi_id, uint32_t config);
#endif /* SCMI_MSG_H */
|