1 /* 2 * Copyright (c) 2014, ARM Limited and Contributors. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are met: 6 * 7 * Redistributions of source code must retain the above copyright notice, this 8 * list of conditions and the following disclaimer. 9 * 10 * Redistributions in binary form must reproduce the above copyright notice, 11 * this list of conditions and the following disclaimer in the documentation 12 * and/or other materials provided with the distribution. 13 * 14 * Neither the name of ARM nor the names of its contributors may be used 15 * to endorse or promote products derived from this software without specific 16 * prior written permission. 17 * 18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28 * POSSIBILITY OF SUCH DAMAGE. 29 */ 30 31 #ifndef __SCPI_H__ 32 #define __SCPI_H__ 33 34 #include <stddef.h> 35 #include <stdint.h> 36 37 extern void *scpi_secure_message_start(void); 38 extern void scpi_secure_message_send(unsigned command, size_t size); 39 extern unsigned scpi_secure_message_receive(void **message_out, size_t *size_out); 40 extern void scpi_secure_message_end(void); 41 42 43 enum { 44 SCP_OK = 0, /* Success */ 45 SCP_E_PARAM, /* Invalid parameter(s) */ 46 SCP_E_ALIGN, /* Invalid alignment */ 47 SCP_E_SIZE, /* Invalid size */ 48 SCP_E_HANDLER, /* Invalid handler or callback */ 49 SCP_E_ACCESS, /* Invalid access or permission denied */ 50 SCP_E_RANGE, /* Value out of range */ 51 SCP_E_TIMEOUT, /* Time out has ocurred */ 52 SCP_E_NOMEM, /* Invalid memory area or pointer */ 53 SCP_E_PWRSTATE, /* Invalid power state */ 54 SCP_E_SUPPORT, /* Feature not supported or disabled */ 55 }; 56 57 typedef uint32_t scpi_status_t; 58 59 typedef enum { 60 SCPI_CMD_SCP_READY = 0x01, 61 SCPI_CMD_SET_CSS_POWER_STATE = 0x04, 62 SCPI_CMD_SYS_POWER_STATE = 0x08 63 } scpi_command_t; 64 65 typedef enum { 66 scpi_power_on = 0, 67 scpi_power_retention = 1, 68 scpi_power_off = 3, 69 } scpi_power_state_t; 70 71 typedef enum { 72 scpi_system_shutdown = 0, 73 scpi_system_reboot = 1, 74 scpi_system_reset = 2 75 } scpi_system_state_t; 76 77 extern int scpi_wait_ready(void); 78 extern void scpi_set_css_power_state(unsigned mpidr, scpi_power_state_t cpu_state, 79 scpi_power_state_t cluster_state, scpi_power_state_t css_state); 80 uint32_t scpi_sys_power_state(scpi_system_state_t system_state); 81 82 #endif /* __SCPI_H__ */ 83