1*9a40c0fbSSheetal Tigadoli /* 2*9a40c0fbSSheetal Tigadoli * Copyright (c) 2019-2020, ARM Limited and Contributors. All rights reserved. 3*9a40c0fbSSheetal Tigadoli * 4*9a40c0fbSSheetal Tigadoli * SPDX-License-Identifier: BSD-3-Clause 5*9a40c0fbSSheetal Tigadoli */ 6*9a40c0fbSSheetal Tigadoli 7*9a40c0fbSSheetal Tigadoli #ifndef BRCM_SCPI_H 8*9a40c0fbSSheetal Tigadoli #define BRCM_SCPI_H 9*9a40c0fbSSheetal Tigadoli 10*9a40c0fbSSheetal Tigadoli #include <stddef.h> 11*9a40c0fbSSheetal Tigadoli #include <stdint.h> 12*9a40c0fbSSheetal Tigadoli 13*9a40c0fbSSheetal Tigadoli /* 14*9a40c0fbSSheetal Tigadoli * An SCPI command consists of a header and a payload. 15*9a40c0fbSSheetal Tigadoli * The following structure describes the header. It is 64-bit long. 16*9a40c0fbSSheetal Tigadoli */ 17*9a40c0fbSSheetal Tigadoli typedef struct { 18*9a40c0fbSSheetal Tigadoli /* Command ID */ 19*9a40c0fbSSheetal Tigadoli uint32_t id : 7; 20*9a40c0fbSSheetal Tigadoli /* Set ID. Identifies whether this is a standard or extended command. */ 21*9a40c0fbSSheetal Tigadoli uint32_t set : 1; 22*9a40c0fbSSheetal Tigadoli /* Sender ID to match a reply. The value is sender specific. */ 23*9a40c0fbSSheetal Tigadoli uint32_t sender : 8; 24*9a40c0fbSSheetal Tigadoli /* Size of the payload in bytes (0 - 511) */ 25*9a40c0fbSSheetal Tigadoli uint32_t size : 9; 26*9a40c0fbSSheetal Tigadoli uint32_t reserved : 7; 27*9a40c0fbSSheetal Tigadoli /* 28*9a40c0fbSSheetal Tigadoli * Status indicating the success of a command. 29*9a40c0fbSSheetal Tigadoli * See the enum below. 30*9a40c0fbSSheetal Tigadoli */ 31*9a40c0fbSSheetal Tigadoli uint32_t status; 32*9a40c0fbSSheetal Tigadoli } scpi_cmd_t; 33*9a40c0fbSSheetal Tigadoli 34*9a40c0fbSSheetal Tigadoli typedef enum { 35*9a40c0fbSSheetal Tigadoli SCPI_SET_NORMAL = 0, /* Normal SCPI commands */ 36*9a40c0fbSSheetal Tigadoli SCPI_SET_EXTENDED /* Extended SCPI commands */ 37*9a40c0fbSSheetal Tigadoli } scpi_set_t; 38*9a40c0fbSSheetal Tigadoli 39*9a40c0fbSSheetal Tigadoli enum { 40*9a40c0fbSSheetal Tigadoli SCP_OK = 0, /* Success */ 41*9a40c0fbSSheetal Tigadoli SCP_E_PARAM, /* Invalid parameter(s) */ 42*9a40c0fbSSheetal Tigadoli SCP_E_ALIGN, /* Invalid alignment */ 43*9a40c0fbSSheetal Tigadoli SCP_E_SIZE, /* Invalid size */ 44*9a40c0fbSSheetal Tigadoli SCP_E_HANDLER, /* Invalid handler or callback */ 45*9a40c0fbSSheetal Tigadoli SCP_E_ACCESS, /* Invalid access or permission denied */ 46*9a40c0fbSSheetal Tigadoli SCP_E_RANGE, /* Value out of range */ 47*9a40c0fbSSheetal Tigadoli SCP_E_TIMEOUT, /* Time out has ocurred */ 48*9a40c0fbSSheetal Tigadoli SCP_E_NOMEM, /* Invalid memory area or pointer */ 49*9a40c0fbSSheetal Tigadoli SCP_E_PWRSTATE, /* Invalid power state */ 50*9a40c0fbSSheetal Tigadoli SCP_E_SUPPORT, /* Feature not supported or disabled */ 51*9a40c0fbSSheetal Tigadoli SCPI_E_DEVICE, /* Device error */ 52*9a40c0fbSSheetal Tigadoli SCPI_E_BUSY, /* Device is busy */ 53*9a40c0fbSSheetal Tigadoli }; 54*9a40c0fbSSheetal Tigadoli 55*9a40c0fbSSheetal Tigadoli typedef uint32_t scpi_status_t; 56*9a40c0fbSSheetal Tigadoli typedef enum { 57*9a40c0fbSSheetal Tigadoli SCPI_CMD_SCP_READY = 0x01, 58*9a40c0fbSSheetal Tigadoli SCPI_CMD_SET_POWER_STATE = 0x03, 59*9a40c0fbSSheetal Tigadoli SCPI_CMD_GET_POWER_STATE = 0x04, 60*9a40c0fbSSheetal Tigadoli SCPI_CMD_SYS_POWER_STATE = 0x05 61*9a40c0fbSSheetal Tigadoli } scpi_command_t; 62*9a40c0fbSSheetal Tigadoli 63*9a40c0fbSSheetal Tigadoli /* 64*9a40c0fbSSheetal Tigadoli * Macros to parse SCP response to GET_POWER_STATE command 65*9a40c0fbSSheetal Tigadoli * 66*9a40c0fbSSheetal Tigadoli * [3:0] : cluster ID 67*9a40c0fbSSheetal Tigadoli * [7:4] : cluster state: 0 = on; 3 = off; rest are reserved 68*9a40c0fbSSheetal Tigadoli * [15:8]: on/off state for individual CPUs in the cluster 69*9a40c0fbSSheetal Tigadoli * 70*9a40c0fbSSheetal Tigadoli * Payload is in little-endian 71*9a40c0fbSSheetal Tigadoli */ 72*9a40c0fbSSheetal Tigadoli #define CLUSTER_ID(_resp) ((_resp) & 0xf) 73*9a40c0fbSSheetal Tigadoli #define CLUSTER_POWER_STATE(_resp) (((_resp) >> 4) & 0xf) 74*9a40c0fbSSheetal Tigadoli 75*9a40c0fbSSheetal Tigadoli /* Result is a bit mask of CPU on/off states in the cluster */ 76*9a40c0fbSSheetal Tigadoli #define CPU_POWER_STATE(_resp) (((_resp) >> 8) & 0xff) 77*9a40c0fbSSheetal Tigadoli 78*9a40c0fbSSheetal Tigadoli /* 79*9a40c0fbSSheetal Tigadoli * For GET_POWER_STATE, SCP returns the power states of every cluster. The 80*9a40c0fbSSheetal Tigadoli * size of response depends on the number of clusters in the system. The 81*9a40c0fbSSheetal Tigadoli * SCP-to-AP payload contains 2 bytes per cluster. Make sure the response is 82*9a40c0fbSSheetal Tigadoli * large enough to contain power states of a given cluster 83*9a40c0fbSSheetal Tigadoli */ 84*9a40c0fbSSheetal Tigadoli #define CHECK_RESPONSE(_resp, _clus) (_resp.size >= (((_clus) + 1) * 2)) 85*9a40c0fbSSheetal Tigadoli 86*9a40c0fbSSheetal Tigadoli typedef enum { 87*9a40c0fbSSheetal Tigadoli scpi_power_on = 0, 88*9a40c0fbSSheetal Tigadoli scpi_power_retention = 1, 89*9a40c0fbSSheetal Tigadoli scpi_power_off = 3, 90*9a40c0fbSSheetal Tigadoli } scpi_power_state_t; 91*9a40c0fbSSheetal Tigadoli 92*9a40c0fbSSheetal Tigadoli typedef enum { 93*9a40c0fbSSheetal Tigadoli scpi_system_shutdown = 0, 94*9a40c0fbSSheetal Tigadoli scpi_system_reboot = 1, 95*9a40c0fbSSheetal Tigadoli scpi_system_reset = 2 96*9a40c0fbSSheetal Tigadoli } scpi_system_state_t; 97*9a40c0fbSSheetal Tigadoli 98*9a40c0fbSSheetal Tigadoli extern int scpi_wait_ready(void); 99*9a40c0fbSSheetal Tigadoli extern void scpi_set_brcm_power_state(unsigned int mpidr, 100*9a40c0fbSSheetal Tigadoli scpi_power_state_t cpu_state, 101*9a40c0fbSSheetal Tigadoli scpi_power_state_t cluster_state, 102*9a40c0fbSSheetal Tigadoli scpi_power_state_t css_state); 103*9a40c0fbSSheetal Tigadoli int scpi_get_brcm_power_state(unsigned int mpidr, unsigned int *cpu_state_p, 104*9a40c0fbSSheetal Tigadoli unsigned int *cluster_state_p); 105*9a40c0fbSSheetal Tigadoli uint32_t scpi_sys_power_state(scpi_system_state_t system_state); 106*9a40c0fbSSheetal Tigadoli 107*9a40c0fbSSheetal Tigadoli #endif /* BRCM_SCPI_H */ 108