blob: e1358bfa4f73a1f8bd0e391bc41f372804943241 [file] [log] [blame]
Soby Mathewea26bad2016-11-14 12:25:45 +00001/*
Samarth Parikh59cfa132017-11-23 14:23:21 +05302 * Copyright (c) 2017-2018, 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
10#include <bakery_lock.h>
11#include <stddef.h>
12#include <stdint.h>
Roberto Vargas00996942017-11-13 13:41:58 +000013#include <spinlock.h>
Soby Mathewea26bad2016-11-14 12:25:45 +000014
15/* Supported SCMI Protocol Versions */
Dimitris Papastamosaeaf1f02018-04-03 14:58:17 +010016#define SCMI_AP_CORE_PROTO_VER MAKE_SCMI_VERSION(1, 0)
Soby Mathewea26bad2016-11-14 12:25:45 +000017#define SCMI_PWR_DMN_PROTO_VER MAKE_SCMI_VERSION(1, 0)
18#define SCMI_SYS_PWR_PROTO_VER MAKE_SCMI_VERSION(1, 0)
19
20#define GET_SCMI_MAJOR_VER(ver) (((ver) >> 16) & 0xffff)
21#define GET_SCMI_MINOR_VER(ver) ((ver) & 0xffff)
22
23#define MAKE_SCMI_VERSION(maj, min) \
24 ((((maj) & 0xffff) << 16) | ((min) & 0xffff))
25
26/* Macro to check if the driver is compatible with the SCMI version reported */
27#define is_scmi_version_compatible(drv, scmi) \
28 ((GET_SCMI_MAJOR_VER(drv) == GET_SCMI_MAJOR_VER(scmi)) && \
29 (GET_SCMI_MINOR_VER(drv) <= GET_SCMI_MINOR_VER(scmi)))
30
31/* SCMI Protocol identifiers */
32#define SCMI_PWR_DMN_PROTO_ID 0x11
33#define SCMI_SYS_PWR_PROTO_ID 0x12
Dimitris Papastamosaeaf1f02018-04-03 14:58:17 +010034/* The AP core protocol is a CSS platform-specific extension */
35#define SCMI_AP_CORE_PROTO_ID 0x90
Soby Mathewea26bad2016-11-14 12:25:45 +000036
37/* Mandatory messages IDs for all SCMI protocols */
38#define SCMI_PROTO_VERSION_MSG 0x0
39#define SCMI_PROTO_ATTR_MSG 0x1
40#define SCMI_PROTO_MSG_ATTR_MSG 0x2
41
42/* SCMI power domain management protocol message IDs */
43#define SCMI_PWR_STATE_SET_MSG 0x4
44#define SCMI_PWR_STATE_GET_MSG 0x5
45
46/* SCMI system power management protocol message IDs */
47#define SCMI_SYS_PWR_STATE_SET_MSG 0x3
48#define SCMI_SYS_PWR_STATE_GET_MSG 0x4
49
Dimitris Papastamosaeaf1f02018-04-03 14:58:17 +010050/* SCMI AP core protocol message IDs */
51#define SCMI_AP_CORE_RESET_ADDR_SET_MSG 0x3
52#define SCMI_AP_CORE_RESET_ADDR_GET_MSG 0x4
53
Soby Mathewea26bad2016-11-14 12:25:45 +000054/* Helper macros for system power management protocol commands */
55
56/*
57 * Macros to describe the bit-fields of the `attribute` of system power domain
58 * protocol PROTOCOL_MSG_ATTRIBUTE message.
59 */
60#define SYS_PWR_ATTR_WARM_RESET_SHIFT 31
61#define SCMI_SYS_PWR_WARM_RESET_SUPPORTED (1U << SYS_PWR_ATTR_WARM_RESET_SHIFT)
62
63#define SYS_PWR_ATTR_SUSPEND_SHIFT 30
64#define SCMI_SYS_PWR_SUSPEND_SUPPORTED (1 << SYS_PWR_ATTR_SUSPEND_SHIFT)
65
66/*
67 * Macros to describe the bit-fields of the `flags` parameter of system power
68 * domain protocol SYSTEM_POWER_STATE_SET message.
69 */
70#define SYS_PWR_SET_GRACEFUL_REQ_SHIFT 0
71#define SCMI_SYS_PWR_GRACEFUL_REQ (1 << SYS_PWR_SET_GRACEFUL_REQ_SHIFT)
72#define SCMI_SYS_PWR_FORCEFUL_REQ (0 << SYS_PWR_SET_GRACEFUL_REQ_SHIFT)
73
74/*
75 * Macros to describe the `system_state` parameter of system power
76 * domain protocol SYSTEM_POWER_STATE_SET message.
77 */
78#define SCMI_SYS_PWR_SHUTDOWN 0x0
79#define SCMI_SYS_PWR_COLD_RESET 0x1
80#define SCMI_SYS_PWR_WARM_RESET 0x2
81#define SCMI_SYS_PWR_POWER_UP 0x3
82#define SCMI_SYS_PWR_SUSPEND 0x4
83
Dimitris Papastamosaeaf1f02018-04-03 14:58:17 +010084/*
85 * Macros to describe the bit-fields of the `attribute` of AP core protocol
86 * AP_CORE_RESET_ADDR set/get messages.
87 */
88#define SCMI_AP_CORE_LOCK_ATTR_SHIFT 0x0
89#define SCMI_AP_CORE_LOCK_ATTR (1U << SCMI_AP_CORE_LOCK_ATTR_SHIFT)
90
Soby Mathewea26bad2016-11-14 12:25:45 +000091/* SCMI Error code definitions */
92#define SCMI_E_QUEUED 1
93#define SCMI_E_SUCCESS 0
94#define SCMI_E_NOT_SUPPORTED -1
95#define SCMI_E_INVALID_PARAM -2
96#define SCMI_E_DENIED -3
97#define SCMI_E_NOT_FOUND -4
98#define SCMI_E_OUT_OF_RANGE -5
99#define SCMI_E_BUSY -6
100
101/*
102 * SCMI driver platform information. The details of the doorbell mechanism
103 * can be found in the SCMI specification.
104 */
105typedef struct scmi_channel_plat_info {
106 /* SCMI mailbox memory */
107 uintptr_t scmi_mbx_mem;
108 /* The door bell register address */
109 uintptr_t db_reg_addr;
110 /* The bit mask that need to be preserved when ringing doorbell */
111 uint32_t db_preserve_mask;
112 /* The bit mask that need to be set to ring doorbell */
113 uint32_t db_modify_mask;
Samarth Parikh59cfa132017-11-23 14:23:21 +0530114 /* The handler for ringing doorbell */
115 void (*ring_doorbell)(struct scmi_channel_plat_info *plat_info);
116 /* cookie is unused now. But added for future enhancements. */
117 void *cookie;
Soby Mathewea26bad2016-11-14 12:25:45 +0000118} scmi_channel_plat_info_t;
119
Roberto Vargas00996942017-11-13 13:41:58 +0000120
121#if HW_ASSISTED_COHERENCY
122typedef spinlock_t scmi_lock_t;
123#else
124typedef bakery_lock_t scmi_lock_t;
125#endif
126
Soby Mathewea26bad2016-11-14 12:25:45 +0000127/*
128 * Structure to represent an SCMI channel.
129 */
130typedef struct scmi_channel {
131 scmi_channel_plat_info_t *info;
132 /* The lock for channel access */
Roberto Vargas00996942017-11-13 13:41:58 +0000133 scmi_lock_t *lock;
Soby Mathewea26bad2016-11-14 12:25:45 +0000134 /* Indicate whether the channel is initialized */
135 int is_initialized;
136} scmi_channel_t;
137
138/* External Common API */
139void *scmi_init(scmi_channel_t *ch);
140int scmi_proto_msg_attr(void *p, uint32_t proto_id, uint32_t command_id,
141 uint32_t *attr);
142int scmi_proto_version(void *p, uint32_t proto_id, uint32_t *version);
143
144/*
145 * Power domain protocol commands. Refer to the SCMI specification for more
146 * details on these commands.
147 */
148int scmi_pwr_state_set(void *p, uint32_t domain_id, uint32_t scmi_pwr_state);
149int scmi_pwr_state_get(void *p, uint32_t domain_id, uint32_t *scmi_pwr_state);
150
151/*
152 * System power management protocol commands. Refer SCMI specification for more
153 * details on these commands.
154 */
155int scmi_sys_pwr_state_set(void *p, uint32_t flags, uint32_t system_state);
156int scmi_sys_pwr_state_get(void *p, uint32_t *system_state);
157
Dimitris Papastamosaeaf1f02018-04-03 14:58:17 +0100158/* SCMI AP core configuration protocol commands. */
159int scmi_ap_core_set_reset_addr(void *p, uint64_t reset_addr, uint32_t attr);
160int scmi_ap_core_get_reset_addr(void *p, uint64_t *reset_addr, uint32_t *attr);
161
Chandni Cherukuri61f3a7c2018-10-11 14:08:08 +0530162/* API to get the platform specific SCMI channel information. */
163scmi_channel_plat_info_t *plat_css_get_scmi_info();
164
Antonio Nino Diaz5eb88372018-11-08 10:20:19 +0000165#endif /* SCMI_H */