xref: /openbmc/qemu/include/hw/misc/aspeed_scu.h (revision a9ded601)
1 /*
2  * ASPEED System Control Unit
3  *
4  * Andrew Jeffery <andrew@aj.id.au>
5  *
6  * Copyright 2016 IBM Corp.
7  *
8  * This code is licensed under the GPL version 2 or later.  See
9  * the COPYING file in the top-level directory.
10  */
11 #ifndef ASPEED_SCU_H
12 #define ASPEED_SCU_H
13 
14 #include "hw/sysbus.h"
15 
16 #define TYPE_ASPEED_SCU "aspeed.scu"
17 #define ASPEED_SCU(obj) OBJECT_CHECK(AspeedSCUState, (obj), TYPE_ASPEED_SCU)
18 
19 #define ASPEED_SCU_NR_REGS (0x1A8 >> 2)
20 
21 typedef struct AspeedSCUState {
22     /*< private >*/
23     SysBusDevice parent_obj;
24 
25     /*< public >*/
26     MemoryRegion iomem;
27 
28     uint32_t regs[ASPEED_SCU_NR_REGS];
29     uint32_t silicon_rev;
30     uint32_t hw_strap1;
31     uint32_t hw_strap2;
32 } AspeedSCUState;
33 
34 #define AST2400_A0_SILICON_REV   0x02000303U
35 #define AST2400_A1_SILICON_REV   0x02010303U
36 #define AST2500_A0_SILICON_REV   0x04000303U
37 #define AST2500_A1_SILICON_REV   0x04010303U
38 
39 extern bool is_supported_silicon_rev(uint32_t silicon_rev);
40 
41 /*
42  * Extracted from Aspeed SDK v00.03.21. Fixes and extra definitions
43  * were added.
44  *
45  * Original header file :
46  *    arch/arm/mach-aspeed/include/mach/regs-scu.h
47  *
48  *    Copyright (C) 2012-2020  ASPEED Technology Inc.
49  *
50  *    This program is free software; you can redistribute it and/or modify
51  *    it under the terms of the GNU General Public License version 2 as
52  *    published by the Free Software Foundation.
53  *
54  *      History      :
55  *       1. 2012/12/29 Ryan Chen Create
56  */
57 
58 /* Hardware Strapping Register definition (for Aspeed AST2400 SOC)
59  *
60  * 31:29  Software defined strapping registers
61  * 28:27  DRAM size setting (for VGA driver use)
62  * 26:24  DRAM configuration setting
63  * 23     Enable 25 MHz reference clock input
64  * 22     Enable GPIOE pass-through mode
65  * 21     Enable GPIOD pass-through mode
66  * 20     Disable LPC to decode SuperIO 0x2E/0x4E address
67  * 19     Disable ACPI function
68  * 23,18  Clock source selection
69  * 17     Enable BMC 2nd boot watchdog timer
70  * 16     SuperIO configuration address selection
71  * 15     VGA Class Code selection
72  * 14     Enable LPC dedicated reset pin function
73  * 13:12  SPI mode selection
74  * 11:10  CPU/AHB clock frequency ratio selection
75  * 9:8    H-PLL default clock frequency selection
76  * 7      Define MAC#2 interface
77  * 6      Define MAC#1 interface
78  * 5      Enable VGA BIOS ROM
79  * 4      Boot flash memory extended option
80  * 3:2    VGA memory size selection
81  * 1:0    BMC CPU boot code selection
82  */
83 #define SCU_AST2400_HW_STRAP_SW_DEFINE(x)          ((x) << 29)
84 #define SCU_AST2400_HW_STRAP_SW_DEFINE_MASK        (0x7 << 29)
85 
86 #define SCU_AST2400_HW_STRAP_DRAM_SIZE(x)          ((x) << 27)
87 #define SCU_AST2400_HW_STRAP_DRAM_SIZE_MASK        (0x3 << 27)
88 #define     DRAM_SIZE_64MB                             0
89 #define     DRAM_SIZE_128MB                            1
90 #define     DRAM_SIZE_256MB                            2
91 #define     DRAM_SIZE_512MB                            3
92 
93 #define SCU_AST2400_HW_STRAP_DRAM_CONFIG(x)        ((x) << 24)
94 #define SCU_AST2400_HW_STRAP_DRAM_CONFIG_MASK      (0x7 << 24)
95 
96 #define SCU_HW_STRAP_GPIOE_PT_EN                   (0x1 << 22)
97 #define SCU_HW_STRAP_GPIOD_PT_EN                   (0x1 << 21)
98 #define SCU_HW_STRAP_LPC_DEC_SUPER_IO              (0x1 << 20)
99 #define SCU_AST2400_HW_STRAP_ACPI_DIS              (0x1 << 19)
100 
101 /* bit 23, 18 [1,0] */
102 #define SCU_AST2400_HW_STRAP_SET_CLK_SOURCE(x)     (((((x) & 0x3) >> 1) << 23) \
103                                                     | (((x) & 0x1) << 18))
104 #define SCU_AST2400_HW_STRAP_GET_CLK_SOURCE(x)     (((((x) >> 23) & 0x1) << 1) \
105                                                     | (((x) >> 18) & 0x1))
106 #define SCU_AST2400_HW_STRAP_CLK_SOURCE_MASK       ((0x1 << 23) | (0x1 << 18))
107 #define     AST2400_CLK_25M_IN                         (0x1 << 23)
108 #define     AST2400_CLK_24M_IN                         0
109 #define     AST2400_CLK_48M_IN                         1
110 #define     AST2400_CLK_25M_IN_24M_USB_CKI             2
111 #define     AST2400_CLK_25M_IN_48M_USB_CKI             3
112 
113 #define SCU_HW_STRAP_2ND_BOOT_WDT                  (0x1 << 17)
114 #define SCU_HW_STRAP_SUPER_IO_CONFIG               (0x1 << 16)
115 #define SCU_HW_STRAP_VGA_CLASS_CODE                (0x1 << 15)
116 #define SCU_HW_STRAP_LPC_RESET_PIN                 (0x1 << 14)
117 
118 #define SCU_HW_STRAP_SPI_MODE(x)                   ((x) << 12)
119 #define SCU_HW_STRAP_SPI_MODE_MASK                 (0x3 << 12)
120 #define     SCU_HW_STRAP_SPI_DIS                       0
121 #define     SCU_HW_STRAP_SPI_MASTER                    1
122 #define     SCU_HW_STRAP_SPI_M_S_EN                    2
123 #define     SCU_HW_STRAP_SPI_PASS_THROUGH              3
124 
125 #define SCU_AST2400_HW_STRAP_SET_CPU_AHB_RATIO(x)  ((x) << 10)
126 #define SCU_AST2400_HW_STRAP_GET_CPU_AHB_RATIO(x)  (((x) >> 10) & 3)
127 #define SCU_AST2400_HW_STRAP_CPU_AHB_RATIO_MASK    (0x3 << 10)
128 #define     AST2400_CPU_AHB_RATIO_1_1                  0
129 #define     AST2400_CPU_AHB_RATIO_2_1                  1
130 #define     AST2400_CPU_AHB_RATIO_4_1                  2
131 #define     AST2400_CPU_AHB_RATIO_3_1                  3
132 
133 #define SCU_AST2400_HW_STRAP_GET_H_PLL_CLK(x)      (((x) >> 8) & 0x3)
134 #define SCU_AST2400_HW_STRAP_H_PLL_CLK_MASK        (0x3 << 8)
135 #define     AST2400_CPU_384MHZ                         0
136 #define     AST2400_CPU_360MHZ                         1
137 #define     AST2400_CPU_336MHZ                         2
138 #define     AST2400_CPU_408MHZ                         3
139 
140 #define SCU_HW_STRAP_MAC1_RGMII                    (0x1 << 7)
141 #define SCU_HW_STRAP_MAC0_RGMII                    (0x1 << 6)
142 #define SCU_HW_STRAP_VGA_BIOS_ROM                  (0x1 << 5)
143 #define SCU_HW_STRAP_SPI_WIDTH                     (0x1 << 4)
144 
145 #define SCU_HW_STRAP_VGA_SIZE_GET(x)               (((x) >> 2) & 0x3)
146 #define SCU_HW_STRAP_VGA_MASK                      (0x3 << 2)
147 #define SCU_HW_STRAP_VGA_SIZE_SET(x)               ((x) << 2)
148 #define     VGA_8M_DRAM                                0
149 #define     VGA_16M_DRAM                               1
150 #define     VGA_32M_DRAM                               2
151 #define     VGA_64M_DRAM                               3
152 
153 #define SCU_AST2400_HW_STRAP_BOOT_MODE(x)          (x)
154 #define     AST2400_NOR_BOOT                           0
155 #define     AST2400_NAND_BOOT                          1
156 #define     AST2400_SPI_BOOT                           2
157 #define     AST2400_DIS_BOOT                           3
158 
159 /*
160  * Hardware strapping register definition (for Aspeed AST2500 SoC and
161  * higher)
162  *
163  * 31     Enable SPI Flash Strap Auto Fetch Mode
164  * 30     Enable GPIO Strap Mode
165  * 29     Select UART Debug Port
166  * 28     Reserved (1)
167  * 27     Enable fast reset mode for ARM ICE debugger
168  * 26     Enable eSPI flash mode
169  * 25     Enable eSPI mode
170  * 24     Select DDR4 SDRAM
171  * 23     Select 25 MHz reference clock input mode
172  * 22     Enable GPIOE pass-through mode
173  * 21     Enable GPIOD pass-through mode
174  * 20     Disable LPC to decode SuperIO 0x2E/0x4E address
175  * 19     Enable ACPI function
176  * 18     Select USBCKI input frequency
177  * 17     Enable BMC 2nd boot watchdog timer
178  * 16     SuperIO configuration address selection
179  * 15     VGA Class Code selection
180  * 14     Select dedicated LPC reset input
181  * 13:12  SPI mode selection
182  * 11:9   AXI/AHB clock frequency ratio selection
183  * 8      Reserved (0)
184  * 7      Define MAC#2 interface
185  * 6      Define MAC#1 interface
186  * 5      Enable dedicated VGA BIOS ROM
187  * 4      Reserved (0)
188  * 3:2    VGA memory size selection
189  * 1      Reserved (1)
190  * 0      Disable CPU boot
191  */
192 #define SCU_AST2500_HW_STRAP_SPI_AUTOFETCH_ENABLE  (0x1 << 31)
193 #define SCU_AST2500_HW_STRAP_GPIO_STRAP_ENABLE     (0x1 << 30)
194 #define SCU_AST2500_HW_STRAP_UART_DEBUG            (0x1 << 29)
195 #define     UART_DEBUG_UART1                           0
196 #define     UART_DEBUG_UART5                           1
197 #define SCU_AST2500_HW_STRAP_RESERVED28            (0x1 << 28)
198 
199 #define SCU_AST2500_HW_STRAP_FAST_RESET_DBG        (0x1 << 27)
200 #define SCU_AST2500_HW_STRAP_ESPI_FLASH_ENABLE     (0x1 << 26)
201 #define SCU_AST2500_HW_STRAP_ESPI_ENABLE           (0x1 << 25)
202 #define SCU_AST2500_HW_STRAP_DDR4_ENABLE           (0x1 << 24)
203 
204 #define SCU_AST2500_HW_STRAP_ACPI_ENABLE           (0x1 << 19)
205 #define SCU_AST2500_HW_STRAP_USBCKI_FREQ           (0x1 << 18)
206 #define     USBCKI_FREQ_24MHZ                          0
207 #define     USBCKI_FREQ_28MHZ                          1
208 
209 #define SCU_AST2500_HW_STRAP_SET_AXI_AHB_RATIO(x)  ((x) << 9)
210 #define SCU_AST2500_HW_STRAP_GET_AXI_AHB_RATIO(x)  (((x) >> 9) & 7)
211 #define SCU_AST2500_HW_STRAP_CPU_AXI_RATIO_MASK    (0x7 << 9)
212 #define     AXI_AHB_RATIO_UNDEFINED                    0
213 #define     AXI_AHB_RATIO_2_1                          1
214 #define     AXI_AHB_RATIO_3_1                          2
215 #define     AXI_AHB_RATIO_4_1                          3
216 #define     AXI_AHB_RATIO_5_1                          4
217 #define     AXI_AHB_RATIO_6_1                          5
218 #define     AXI_AHB_RATIO_7_1                          6
219 #define     AXI_AHB_RATIO_8_1                          7
220 
221 #define SCU_AST2500_HW_STRAP_RESERVED1             (0x1 << 1)
222 #define SCU_AST2500_HW_STRAP_DIS_BOOT              (0x1 << 0)
223 
224 #define AST2500_HW_STRAP1_DEFAULTS (                                    \
225         SCU_AST2500_HW_STRAP_RESERVED28 |                               \
226         SCU_HW_STRAP_2ND_BOOT_WDT |                                     \
227         SCU_HW_STRAP_VGA_CLASS_CODE |                                   \
228         SCU_HW_STRAP_LPC_RESET_PIN |                                    \
229         SCU_AST2500_HW_STRAP_SET_AXI_AHB_RATIO(AXI_AHB_RATIO_2_1) |     \
230         SCU_HW_STRAP_VGA_SIZE_SET(VGA_16M_DRAM) |                       \
231         SCU_AST2500_HW_STRAP_RESERVED1)
232 
233 #endif /* ASPEED_SCU_H */
234