xref: /qemu/include/hw/misc/aspeed_scu.h (revision 2e14ac3c9ca25c974bb300c45c5b0303862c177d)
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 #include "qom/object.h"
16 
17 #define TYPE_ASPEED_SCU "aspeed.scu"
18 OBJECT_DECLARE_TYPE(AspeedSCUState, AspeedSCUClass, ASPEED_SCU)
19 #define TYPE_ASPEED_2400_SCU TYPE_ASPEED_SCU "-ast2400"
20 #define TYPE_ASPEED_2500_SCU TYPE_ASPEED_SCU "-ast2500"
21 #define TYPE_ASPEED_2600_SCU TYPE_ASPEED_SCU "-ast2600"
22 #define TYPE_ASPEED_2700_SCU TYPE_ASPEED_SCU "-ast2700"
23 #define TYPE_ASPEED_2700_SCUIO TYPE_ASPEED_SCU "io" "-ast2700"
24 #define TYPE_ASPEED_1030_SCU TYPE_ASPEED_SCU "-ast1030"
25 
26 #define ASPEED_SCU_NR_REGS (0x1A8 >> 2)
27 #define ASPEED_AST2600_SCU_NR_REGS (0xE20 >> 2)
28 #define ASPEED_AST2700_SCU_NR_REGS (0xE20 >> 2)
29 
30 struct AspeedSCUState {
31     /*< private >*/
32     SysBusDevice parent_obj;
33 
34     /*< public >*/
35     MemoryRegion iomem;
36 
37     uint32_t regs[ASPEED_AST2700_SCU_NR_REGS];
38     uint32_t silicon_rev;
39     uint32_t hw_strap1;
40     uint32_t hw_strap2;
41     uint32_t hw_prot_key;
42 };
43 
44 #define AST2400_A0_SILICON_REV   0x02000303U
45 #define AST2400_A1_SILICON_REV   0x02010303U
46 #define AST2500_A0_SILICON_REV   0x04000303U
47 #define AST2500_A1_SILICON_REV   0x04010303U
48 #define AST2600_A0_SILICON_REV   0x05000303U
49 #define AST2600_A1_SILICON_REV   0x05010303U
50 #define AST2600_A2_SILICON_REV   0x05020303U
51 #define AST2600_A3_SILICON_REV   0x05030303U
52 #define AST1030_A0_SILICON_REV   0x80000000U
53 #define AST1030_A1_SILICON_REV   0x80010000U
54 #define AST2700_A0_SILICON_REV   0x06000103U
55 #define AST2720_A0_SILICON_REV   0x06000203U
56 #define AST2750_A0_SILICON_REV   0x06000003U
57 #define AST2700_A1_SILICON_REV   0x06010103U
58 #define AST2750_A1_SILICON_REV   0x06010003U
59 
60 #define ASPEED_IS_AST2500(si_rev)     ((((si_rev) >> 24) & 0xff) == 0x04)
61 
62 bool is_supported_silicon_rev(uint32_t silicon_rev);
63 
64 
65 struct AspeedSCUClass {
66     SysBusDeviceClass parent_class;
67 
68     const uint32_t *resets;
69     uint32_t (*calc_hpll)(AspeedSCUState *s, uint32_t hpll_reg);
70     uint32_t (*get_apb)(AspeedSCUState *s);
71     uint32_t apb_divider;
72     uint32_t nr_regs;
73     bool clkin_25Mhz;
74     const MemoryRegionOps *ops;
75 };
76 
77 #define ASPEED_SCU_PROT_KEY      0x1688A8A8
78 
79 uint32_t aspeed_scu_get_apb_freq(AspeedSCUState *s);
80 
81 /*
82  * Extracted from Aspeed SDK v00.03.21. Fixes and extra definitions
83  * were added.
84  *
85  * Original header file :
86  *    arch/arm/mach-aspeed/include/mach/regs-scu.h
87  *
88  *    Copyright (C) 2012-2020  ASPEED Technology Inc.
89  *
90  *    This program is free software; you can redistribute it and/or modify
91  *    it under the terms of the GNU General Public License version 2 as
92  *    published by the Free Software Foundation.
93  *
94  *      History      :
95  *       1. 2012/12/29 Ryan Chen Create
96  */
97 
98 /*
99  * SCU08   Clock Selection Register
100  *
101  *  31     Enable Video Engine clock dynamic slow down
102  *  30:28  Video Engine clock slow down setting
103  *  27     2D Engine GCLK clock source selection
104  *  26     2D Engine GCLK clock throttling enable
105  *  25:23  APB PCLK divider selection
106  *  22:20  LPC Host LHCLK divider selection
107  *  19     LPC Host LHCLK clock generation/output enable control
108  *  18:16  MAC AHB bus clock divider selection
109  *  15     SD/SDIO clock running enable
110  *  14:12  SD/SDIO divider selection
111  *  11     Reserved
112  *  10:8   Video port output clock delay control bit
113  *  7      ARM CPU/AHB clock slow down enable
114  *  6:4    ARM CPU/AHB clock slow down setting
115  *  3:2    ECLK clock source selection
116  *  1      CPU/AHB clock slow down idle timer
117  *  0      CPU/AHB clock dynamic slow down enable (defined in bit[6:4])
118  */
119 #define SCU_CLK_GET_PCLK_DIV(x)                    (((x) >> 23) & 0x7)
120 
121 /*
122  * SCU24   H-PLL Parameter Register (for Aspeed AST2400 SOC)
123  *
124  *  18     H-PLL parameter selection
125  *           0: Select H-PLL by strapping resistors
126  *           1: Select H-PLL by the programmed registers (SCU24[17:0])
127  *  17     Enable H-PLL bypass mode
128  *  16     Turn off H-PLL
129  *  10:5   H-PLL Numerator
130  *  4      H-PLL Output Divider
131  *  3:0    H-PLL Denumerator
132  *
133  *  (Output frequency) = 24MHz * (2-OD) * [(Numerator+2) / (Denumerator+1)]
134  */
135 
136 #define SCU_AST2400_H_PLL_PROGRAMMED               (0x1 << 18)
137 #define SCU_AST2400_H_PLL_BYPASS_EN                (0x1 << 17)
138 #define SCU_AST2400_H_PLL_OFF                      (0x1 << 16)
139 
140 /*
141  * SCU24   H-PLL Parameter Register (for Aspeed AST2500 SOC)
142  *
143  *  21     Enable H-PLL reset
144  *  20     Enable H-PLL bypass mode
145  *  19     Turn off H-PLL
146  *  18:13  H-PLL Post Divider
147  *  12:5   H-PLL Numerator (M)
148  *  4:0    H-PLL Denumerator (N)
149  *
150  *  (Output frequency) = CLKIN(24MHz) * [(M+1) / (N+1)] / (P+1)
151  *
152  * The default frequency is 792Mhz when CLKIN = 24MHz
153  */
154 
155 #define SCU_H_PLL_BYPASS_EN                        (0x1 << 20)
156 #define SCU_H_PLL_OFF                              (0x1 << 19)
157 
158 /*
159  * SCU70  Hardware Strapping Register definition (for Aspeed AST2400 SOC)
160  *
161  * 31:29  Software defined strapping registers
162  * 28:27  DRAM size setting (for VGA driver use)
163  * 26:24  DRAM configuration setting
164  * 23     Enable 25 MHz reference clock input
165  * 22     Enable GPIOE pass-through mode
166  * 21     Enable GPIOD pass-through mode
167  * 20     Disable LPC to decode SuperIO 0x2E/0x4E address
168  * 19     Disable ACPI function
169  * 23,18  Clock source selection
170  * 17     Enable BMC 2nd boot watchdog timer
171  * 16     SuperIO configuration address selection
172  * 15     VGA Class Code selection
173  * 14     Enable LPC dedicated reset pin function
174  * 13:12  SPI mode selection
175  * 11:10  CPU/AHB clock frequency ratio selection
176  * 9:8    H-PLL default clock frequency selection
177  * 7      Define MAC#2 interface
178  * 6      Define MAC#1 interface
179  * 5      Enable VGA BIOS ROM
180  * 4      Boot flash memory extended option
181  * 3:2    VGA memory size selection
182  * 1:0    BMC CPU boot code selection
183  */
184 #define SCU_AST2400_HW_STRAP_SW_DEFINE(x)          ((x) << 29)
185 #define SCU_AST2400_HW_STRAP_SW_DEFINE_MASK        (0x7 << 29)
186 
187 #define SCU_AST2400_HW_STRAP_DRAM_SIZE(x)          ((x) << 27)
188 #define SCU_AST2400_HW_STRAP_DRAM_SIZE_MASK        (0x3 << 27)
189 #define     DRAM_SIZE_64MB                             0
190 #define     DRAM_SIZE_128MB                            1
191 #define     DRAM_SIZE_256MB                            2
192 #define     DRAM_SIZE_512MB                            3
193 
194 #define SCU_AST2400_HW_STRAP_DRAM_CONFIG(x)        ((x) << 24)
195 #define SCU_AST2400_HW_STRAP_DRAM_CONFIG_MASK      (0x7 << 24)
196 
197 #define SCU_HW_STRAP_GPIOE_PT_EN                   (0x1 << 22)
198 #define SCU_HW_STRAP_GPIOD_PT_EN                   (0x1 << 21)
199 #define SCU_HW_STRAP_LPC_DEC_SUPER_IO              (0x1 << 20)
200 #define SCU_AST2400_HW_STRAP_ACPI_DIS              (0x1 << 19)
201 
202 /* bit 23, 18 [1,0] */
203 #define SCU_AST2400_HW_STRAP_SET_CLK_SOURCE(x)     (((((x) & 0x3) >> 1) << 23) \
204                                                     | (((x) & 0x1) << 18))
205 #define SCU_AST2400_HW_STRAP_GET_CLK_SOURCE(x)     (((((x) >> 23) & 0x1) << 1) \
206                                                     | (((x) >> 18) & 0x1))
207 #define SCU_AST2400_HW_STRAP_CLK_SOURCE_MASK       ((0x1 << 23) | (0x1 << 18))
208 #define SCU_HW_STRAP_CLK_25M_IN                    (0x1 << 23)
209 #define     AST2400_CLK_24M_IN                         0
210 #define     AST2400_CLK_48M_IN                         1
211 #define     AST2400_CLK_25M_IN_24M_USB_CKI             2
212 #define     AST2400_CLK_25M_IN_48M_USB_CKI             3
213 
214 #define SCU_HW_STRAP_CLK_48M_IN                    (0x1 << 18)
215 #define SCU_HW_STRAP_2ND_BOOT_WDT                  (0x1 << 17)
216 #define SCU_HW_STRAP_SUPER_IO_CONFIG               (0x1 << 16)
217 #define SCU_HW_STRAP_VGA_CLASS_CODE                (0x1 << 15)
218 #define SCU_HW_STRAP_LPC_RESET_PIN                 (0x1 << 14)
219 
220 #define SCU_HW_STRAP_SPI_MODE(x)                   ((x) << 12)
221 #define SCU_HW_STRAP_SPI_MODE_MASK                 (0x3 << 12)
222 #define     SCU_HW_STRAP_SPI_DIS                       0
223 #define     SCU_HW_STRAP_SPI_MASTER                    1
224 #define     SCU_HW_STRAP_SPI_M_S_EN                    2
225 #define     SCU_HW_STRAP_SPI_PASS_THROUGH              3
226 
227 #define SCU_AST2400_HW_STRAP_SET_CPU_AHB_RATIO(x)  ((x) << 10)
228 #define SCU_AST2400_HW_STRAP_GET_CPU_AHB_RATIO(x)  (((x) >> 10) & 3)
229 #define SCU_AST2400_HW_STRAP_CPU_AHB_RATIO_MASK    (0x3 << 10)
230 #define     AST2400_CPU_AHB_RATIO_1_1                  0
231 #define     AST2400_CPU_AHB_RATIO_2_1                  1
232 #define     AST2400_CPU_AHB_RATIO_4_1                  2
233 #define     AST2400_CPU_AHB_RATIO_3_1                  3
234 
235 #define SCU_AST2400_HW_STRAP_GET_H_PLL_CLK(x)      (((x) >> 8) & 0x3)
236 #define SCU_AST2400_HW_STRAP_H_PLL_CLK_MASK        (0x3 << 8)
237 #define     AST2400_CPU_384MHZ                         0
238 #define     AST2400_CPU_360MHZ                         1
239 #define     AST2400_CPU_336MHZ                         2
240 #define     AST2400_CPU_408MHZ                         3
241 
242 #define SCU_HW_STRAP_MAC1_RGMII                    (0x1 << 7)
243 #define SCU_HW_STRAP_MAC0_RGMII                    (0x1 << 6)
244 #define SCU_HW_STRAP_VGA_BIOS_ROM                  (0x1 << 5)
245 #define SCU_HW_STRAP_SPI_WIDTH                     (0x1 << 4)
246 
247 #define SCU_HW_STRAP_VGA_SIZE_GET(x)               (((x) >> 2) & 0x3)
248 #define SCU_HW_STRAP_VGA_MASK                      (0x3 << 2)
249 #define SCU_HW_STRAP_VGA_SIZE_SET(x)               ((x) << 2)
250 #define     VGA_8M_DRAM                                0
251 #define     VGA_16M_DRAM                               1
252 #define     VGA_32M_DRAM                               2
253 #define     VGA_64M_DRAM                               3
254 
255 #define SCU_AST2400_HW_STRAP_BOOT_MODE(x)          (x)
256 #define     AST2400_NOR_BOOT                           0
257 #define     AST2400_NAND_BOOT                          1
258 #define     AST2400_SPI_BOOT                           2
259 #define     AST2400_DIS_BOOT                           3
260 
261 /*
262  * SCU70  Hardware strapping register definition (for Aspeed AST2500
263  *        SoC and higher)
264  *
265  * 31     Enable SPI Flash Strap Auto Fetch Mode
266  * 30     Enable GPIO Strap Mode
267  * 29     Select UART Debug Port
268  * 28     Reserved (1)
269  * 27     Enable fast reset mode for ARM ICE debugger
270  * 26     Enable eSPI flash mode
271  * 25     Enable eSPI mode
272  * 24     Select DDR4 SDRAM
273  * 23     Select 25 MHz reference clock input mode
274  * 22     Enable GPIOE pass-through mode
275  * 21     Enable GPIOD pass-through mode
276  * 20     Disable LPC to decode SuperIO 0x2E/0x4E address
277  * 19     Enable ACPI function
278  * 18     Select USBCKI input frequency
279  * 17     Enable BMC 2nd boot watchdog timer
280  * 16     SuperIO configuration address selection
281  * 15     VGA Class Code selection
282  * 14     Select dedicated LPC reset input
283  * 13:12  SPI mode selection
284  * 11:9   AXI/AHB clock frequency ratio selection
285  * 8      Reserved (0)
286  * 7      Define MAC#2 interface
287  * 6      Define MAC#1 interface
288  * 5      Enable dedicated VGA BIOS ROM
289  * 4      Reserved (0)
290  * 3:2    VGA memory size selection
291  * 1      Reserved (1)
292  * 0      Disable CPU boot
293  */
294 #define SCU_AST2500_HW_STRAP_SPI_AUTOFETCH_ENABLE  (0x1 << 31)
295 #define SCU_AST2500_HW_STRAP_GPIO_STRAP_ENABLE     (0x1 << 30)
296 #define SCU_AST2500_HW_STRAP_UART_DEBUG            (0x1 << 29)
297 #define     UART_DEBUG_UART1                           0
298 #define     UART_DEBUG_UART5                           1
299 #define SCU_AST2500_HW_STRAP_RESERVED28            (0x1 << 28)
300 
301 #define SCU_AST2500_HW_STRAP_FAST_RESET_DBG        (0x1 << 27)
302 #define SCU_AST2500_HW_STRAP_ESPI_FLASH_ENABLE     (0x1 << 26)
303 #define SCU_AST2500_HW_STRAP_ESPI_ENABLE           (0x1 << 25)
304 #define SCU_AST2500_HW_STRAP_DDR4_ENABLE           (0x1 << 24)
305 #define SCU_AST2500_HW_STRAP_25HZ_CLOCK_MODE       (0x1 << 23)
306 
307 #define SCU_AST2500_HW_STRAP_ACPI_ENABLE           (0x1 << 19)
308 #define SCU_AST2500_HW_STRAP_USBCKI_FREQ           (0x1 << 18)
309 #define     USBCKI_FREQ_24MHZ                          0
310 #define     USBCKI_FREQ_28MHZ                          1
311 
312 #define SCU_AST2500_HW_STRAP_SET_AXI_AHB_RATIO(x)  ((x) << 9)
313 #define SCU_AST2500_HW_STRAP_GET_AXI_AHB_RATIO(x)  (((x) >> 9) & 7)
314 #define SCU_AST2500_HW_STRAP_CPU_AXI_RATIO_MASK    (0x7 << 9)
315 #define     AXI_AHB_RATIO_UNDEFINED                    0
316 #define     AXI_AHB_RATIO_2_1                          1
317 #define     AXI_AHB_RATIO_3_1                          2
318 #define     AXI_AHB_RATIO_4_1                          3
319 #define     AXI_AHB_RATIO_5_1                          4
320 #define     AXI_AHB_RATIO_6_1                          5
321 #define     AXI_AHB_RATIO_7_1                          6
322 #define     AXI_AHB_RATIO_8_1                          7
323 
324 #define SCU_AST2500_HW_STRAP_RESERVED1             (0x1 << 1)
325 #define SCU_AST2500_HW_STRAP_DIS_BOOT              (0x1 << 0)
326 
327 #define AST2500_HW_STRAP1_DEFAULTS (                                    \
328         SCU_AST2500_HW_STRAP_RESERVED28 |                               \
329         SCU_HW_STRAP_2ND_BOOT_WDT |                                     \
330         SCU_HW_STRAP_VGA_CLASS_CODE |                                   \
331         SCU_HW_STRAP_LPC_RESET_PIN |                                    \
332         SCU_AST2500_HW_STRAP_SET_AXI_AHB_RATIO(AXI_AHB_RATIO_2_1) |     \
333         SCU_HW_STRAP_VGA_SIZE_SET(VGA_16M_DRAM) |                       \
334         SCU_AST2500_HW_STRAP_RESERVED1)
335 
336 /*
337  * SCU200   H-PLL Parameter Register (for Aspeed AST2600 SOC)
338  *
339  *  28:26  H-PLL Parameters
340  *  25     Enable H-PLL reset
341  *  24     Enable H-PLL bypass mode
342  *  23     Turn off H-PLL
343  *  22:19  H-PLL Post Divider (P)
344  *  18:13  H-PLL Numerator (M)
345  *  12:0   H-PLL Denumerator (N)
346  *
347  *  (Output frequency) = CLKIN(25MHz) * [(M+1) / (N+1)] / (P+1)
348  *
349  * The default frequency is 1200Mhz when CLKIN = 25MHz
350  */
351 #define SCU_AST2600_H_PLL_BYPASS_EN                        (0x1 << 24)
352 #define SCU_AST2600_H_PLL_OFF                              (0x1 << 23)
353 
354 /* STRAP1 SCU500 */
355 #define SCU_AST2600_HW_STRAP_BOOT_SRC_EMMC            (0x1 << 2)
356 #define SCU_AST2600_HW_STRAP_BOOT_SRC_SPI             (0x0 << 2)
357 
358 /*
359  * SCU310   Clock Selection Register Set 4 (for Aspeed AST1030 SOC)
360  *
361  *  31     I3C Clock Source selection
362  *  30:28  I3C clock divider selection
363  *  26:24  MAC AHB clock divider selection
364  *  22:20  RGMII 125MHz clock divider ration
365  *  19:16  RGMII 50MHz clock divider ration
366  *  15     LHCLK clock generation/output enable control
367  *  14:12  LHCLK divider selection
368  *  11:8   APB Bus PCLK divider selection
369  *  7      Select PECI clock source
370  *  6      Select UART debug port clock source
371  *  5      Select UART6 clock source
372  *  4      Select UART5 clock source
373  *  3      Select UART4 clock source
374  *  2      Select UART3 clock source
375  *  1      Select UART2 clock source
376  *  0      Select UART1 clock source
377  */
378 #define SCU_AST1030_CLK_GET_PCLK_DIV(x)                    (((x) >> 8) & 0xf)
379 
380 /*
381  * SCU280   Clock Selection 1 Register (for Aspeed AST2700 SCUIO)
382  *
383  *  31:29  MHCLK_DIV
384  *  28     Reserved
385  *  27:25  RGMIICLK_DIV
386  *  24     Reserved
387  *  23:21  RMIICLK_DIV
388  *  20:18  PCLK_DIV
389  *  17:14  SDCLK_DIV
390  *  13     SDCLK_SEL
391  *  12     UART13CLK_SEL
392  *  11     UART12CLK_SEL
393  *  10     UART11CLK_SEL
394  *  9      UART10CLK_SEL
395  *  8      UART9CLK_SEL
396  *  7      UART8CLK_SEL
397  *  6      UART7CLK_SEL
398  *  5      UART6CLK_SEL
399  *  4      UARTDBCLK_SEL
400  *  3      UART4CLK_SEL
401  *  2      UART3CLK_SEL
402  *  1      UART2CLK_SEL
403  *  0      UART1CLK_SEL
404  */
405 #define SCUIO_AST2700_CLK_GET_PCLK_DIV(x)                    (((x) >> 18) & 0x7)
406 
407 #endif /* ASPEED_SCU_H */
408