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