xref: /qemu/include/hw/arm/npcm8xx.h (revision f07a5674cf97b8473e5d06d7b1df9b51e97d553f)
1 /*
2  * Nuvoton NPCM8xx SoC family.
3  *
4  * Copyright 2022 Google LLC
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms of the GNU General Public License as published by the
8  * Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14  * for more details.
15  */
16 #ifndef NPCM8XX_H
17 #define NPCM8XX_H
18 
19 #include "hw/adc/npcm7xx_adc.h"
20 #include "hw/core/split-irq.h"
21 #include "hw/cpu/cluster.h"
22 #include "hw/gpio/npcm7xx_gpio.h"
23 #include "hw/i2c/npcm7xx_smbus.h"
24 #include "hw/intc/arm_gic_common.h"
25 #include "hw/mem/npcm7xx_mc.h"
26 #include "hw/misc/npcm_clk.h"
27 #include "hw/misc/npcm_gcr.h"
28 #include "hw/misc/npcm7xx_mft.h"
29 #include "hw/misc/npcm7xx_pwm.h"
30 #include "hw/misc/npcm7xx_rng.h"
31 #include "hw/net/npcm7xx_emc.h"
32 #include "hw/nvram/npcm7xx_otp.h"
33 #include "hw/sd/npcm7xx_sdhci.h"
34 #include "hw/timer/npcm7xx_timer.h"
35 #include "hw/ssi/npcm7xx_fiu.h"
36 #include "hw/usb/hcd-ehci.h"
37 #include "hw/usb/hcd-ohci.h"
38 #include "target/arm/cpu.h"
39 
40 #define NPCM8XX_MAX_NUM_CPUS    (4)
41 
42 /* The first half of the address space is reserved for DDR4 DRAM. */
43 #define NPCM8XX_DRAM_BA         (0x00000000)
44 #define NPCM8XX_DRAM_SZ         (2 * GiB)
45 
46 /* Magic addresses for setting up direct kernel booting and SMP boot stubs. */
47 #define NPCM8XX_LOADER_START            (0x00000000)  /* Start of SDRAM */
48 #define NPCM8XX_SMP_LOADER_START        (0xffff0000)  /* Boot ROM */
49 #define NPCM8XX_SMP_BOOTREG_ADDR        (0xf080013c)  /* GCR.SCRPAD */
50 #define NPCM8XX_BOARD_SETUP_ADDR        (0xffff1000)  /* Boot ROM */
51 
52 #define NPCM8XX_NR_PWM_MODULES 3
53 
54 struct NPCM8xxMachine {
55     MachineState        parent_obj;
56 
57     /*
58      * PWM fan splitter. each splitter connects to one PWM output and
59      * multiple MFT inputs.
60      */
61     SplitIRQ            fan_splitter[NPCM8XX_NR_PWM_MODULES *
62                                      NPCM7XX_PWM_PER_MODULE];
63 };
64 
65 
66 struct NPCM8xxMachineClass {
67     MachineClass        parent_class;
68 
69     const char          *soc_type;
70 };
71 
72 #define TYPE_NPCM8XX_MACHINE MACHINE_TYPE_NAME("npcm8xx")
73 OBJECT_DECLARE_TYPE(NPCM8xxMachine, NPCM8xxMachineClass, NPCM8XX_MACHINE)
74 
75 struct NPCM8xxState {
76     DeviceState         parent_obj;
77 
78     ARMCPU              cpu[NPCM8XX_MAX_NUM_CPUS];
79     CPUClusterState     cpu_cluster;
80     GICState            gic;
81 
82     MemoryRegion        sram;
83     MemoryRegion        irom;
84     MemoryRegion        ram3;
85     MemoryRegion        *dram;
86 
87     NPCMGCRState        gcr;
88     NPCMCLKState        clk;
89     NPCM7xxTimerCtrlState tim[3];
90     NPCM7xxADCState     adc;
91     NPCM7xxPWMState     pwm[NPCM8XX_NR_PWM_MODULES];
92     NPCM7xxMFTState     mft[8];
93     NPCM7xxOTPState     fuse_array;
94     NPCM7xxMCState      mc;
95     NPCM7xxRNGState     rng;
96     NPCM7xxGPIOState    gpio[8];
97     NPCM7xxSMBusState   smbus[27];
98     EHCISysBusState     ehci[2];
99     OHCISysBusState     ohci[2];
100     NPCM7xxFIUState     fiu[3];
101     NPCM7xxSDHCIState   mmc;
102 };
103 
104 struct NPCM8xxClass {
105     DeviceClass         parent_class;
106 
107     /* Bitmask of modules that are permanently disabled on this chip. */
108     uint32_t            disabled_modules;
109     /* Number of CPU cores enabled in this SoC class. */
110     uint32_t            num_cpus;
111 };
112 
113 #define TYPE_NPCM8XX    "npcm8xx"
114 OBJECT_DECLARE_TYPE(NPCM8xxState, NPCM8xxClass, NPCM8XX)
115 
116 /**
117  * npcm8xx_load_kernel - Loads memory with everything needed to boot
118  * @machine - The machine containing the SoC to be booted.
119  * @soc - The SoC containing the CPU to be booted.
120  *
121  * This will set up the ARM boot info structure for the specific NPCM8xx
122  * derivative and call arm_load_kernel() to set up loading of the kernel, etc.
123  * into memory, if requested by the user.
124  */
125 void npcm8xx_load_kernel(MachineState *machine, NPCM8xxState *soc);
126 
127 #endif /* NPCM8XX_H */
128