1 /* 2 * Copyright (c) 2016, 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 __PLAT_PARAMS_H__ 32 #define __PLAT_PARAMS_H__ 33 34 #include <stdint.h> 35 36 /* 37 * We defined several plat parameter structs for BL2 to pass platform related 38 * parameters to Rockchip BL31 platform code. All plat parameters start with 39 * a common header, which has a type field to indicate the parameter type, and 40 * a next pointer points to next parameter. If the parameter is the last one in 41 * the list, next pointer will points to NULL. After the header comes the 42 * variable-sized members that describe the parameter. The picture below shows 43 * how the parameters are kept in memory. 44 * 45 * head of list ---> +----------------+ --+ 46 * | type | | 47 * +----------------+ |--> struct bl31_plat_param 48 * +----| next | | 49 * | +----------------+ --+ 50 * | | parameter data | 51 * | +----------------+ 52 * | 53 * +--> +----------------+ --+ 54 * | type | | 55 * +----------------+ |--> struct bl31_plat_param 56 * NULL <---| next | | 57 * +----------------+ --+ 58 * | parameter data | 59 * +----------------+ 60 * 61 * Note: The SCTLR_EL3.A bit (Alignment fault check enable) of ARM TF is set, 62 * so be sure each parameter struct starts on 64-bit aligned address. If not, 63 * alignment fault will occur during accessing its data member. 64 */ 65 66 #define BL31_GPIO_DIR_OUT 0 67 #define BL31_GPIO_DIR_IN 1 68 69 #define BL31_GPIO_LEVEL_LOW 0 70 #define BL31_GPIO_LEVEL_HIGH 1 71 72 #define BL31_GPIO_PULL_NONE 0 73 #define BL31_GPIO_PULL_UP 1 74 #define BL31_GPIO_PULL_DOWN 2 75 76 /* param type */ 77 enum { 78 PARAM_NONE = 0, 79 PARAM_RESET, 80 PARAM_POWEROFF, 81 PARAM_SUSPEND_GPIO, 82 PARAM_SUSPEND_APIO, 83 }; 84 85 struct apio_info { 86 uint8_t apio1 : 1; 87 uint8_t apio2 : 1; 88 uint8_t apio3 : 1; 89 uint8_t apio4 : 1; 90 uint8_t apio5 : 1; 91 }; 92 93 struct gpio_info { 94 uint8_t polarity; 95 uint8_t direction; 96 uint8_t pull_mode; 97 uint32_t index; 98 }; 99 100 /* common header for all plat parameter type */ 101 struct bl31_plat_param { 102 uint64_t type; 103 void *next; 104 }; 105 106 struct bl31_gpio_param { 107 struct bl31_plat_param h; 108 struct gpio_info gpio; 109 }; 110 111 struct bl31_apio_param { 112 struct bl31_plat_param h; 113 struct apio_info apio; 114 }; 115 116 #endif /* __PLAT_PARAMS_H__ */ 117