xref: /openbmc/qemu/hw/arm/max78000_soc.c (revision 5adeb160322ff827f3e81f38e9481fb4896670e8)
1 /*
2  * MAX78000 SOC
3  *
4  * Copyright (c) 2025 Jackson Donaldson <jcksn@duck.com>
5  *
6  * SPDX-License-Identifier: GPL-2.0-or-later
7  *
8  * Implementation based on stm32f205 and Max78000 user guide at
9  * https://www.analog.com/media/en/technical-documentation/user-guides/max78000-user-guide.pdf
10  */
11 
12 #include "qemu/osdep.h"
13 #include "qapi/error.h"
14 #include "system/address-spaces.h"
15 #include "system/system.h"
16 #include "hw/arm/max78000_soc.h"
17 #include "hw/qdev-clock.h"
18 #include "hw/misc/unimp.h"
19 
20 static const uint32_t max78000_icc_addr[] = {0x4002a000, 0x4002a800};
21 static const uint32_t max78000_uart_addr[] = {0x40042000, 0x40043000,
22                                               0x40044000};
23 
24 static const int max78000_uart_irq[] = {14, 15, 34};
25 
26 static void max78000_soc_initfn(Object *obj)
27 {
28     MAX78000State *s = MAX78000_SOC(obj);
29     int i;
30 
31     object_initialize_child(obj, "armv7m", &s->armv7m, TYPE_ARMV7M);
32 
33     object_initialize_child(obj, "gcr", &s->gcr, TYPE_MAX78000_GCR);
34 
35     for (i = 0; i < MAX78000_NUM_ICC; i++) {
36         g_autofree char *name = g_strdup_printf("icc%d", i);
37         object_initialize_child(obj, name, &s->icc[i], TYPE_MAX78000_ICC);
38     }
39 
40     for (i = 0; i < MAX78000_NUM_UART; i++) {
41         g_autofree char *name = g_strdup_printf("uart%d", i);
42         object_initialize_child(obj, name, &s->uart[i],
43                                 TYPE_MAX78000_UART);
44     }
45 
46     object_initialize_child(obj, "trng", &s->trng, TYPE_MAX78000_TRNG);
47 
48     s->sysclk = qdev_init_clock_in(DEVICE(s), "sysclk", NULL, NULL, 0);
49 }
50 
51 static void max78000_soc_realize(DeviceState *dev_soc, Error **errp)
52 {
53     MAX78000State *s = MAX78000_SOC(dev_soc);
54     MemoryRegion *system_memory = get_system_memory();
55     DeviceState *dev, *gcrdev, *armv7m;
56     SysBusDevice *busdev;
57     Error *err = NULL;
58     int i;
59 
60     if (!clock_has_source(s->sysclk)) {
61         error_setg(errp, "sysclk clock must be wired up by the board code");
62         return;
63     }
64 
65     memory_region_init_rom(&s->flash, OBJECT(dev_soc), "MAX78000.flash",
66                            FLASH_SIZE, &err);
67     if (err != NULL) {
68         error_propagate(errp, err);
69         return;
70     }
71 
72     memory_region_add_subregion(system_memory, FLASH_BASE_ADDRESS, &s->flash);
73 
74     memory_region_init_ram(&s->sram, NULL, "MAX78000.sram", SRAM_SIZE,
75                            &err);
76 
77     gcrdev = DEVICE(&s->gcr);
78     object_property_set_link(OBJECT(gcrdev), "sram", OBJECT(&s->sram),
79                                  &err);
80 
81     if (err != NULL) {
82         error_propagate(errp, err);
83         return;
84     }
85     memory_region_add_subregion(system_memory, SRAM_BASE_ADDRESS, &s->sram);
86 
87     armv7m = DEVICE(&s->armv7m);
88 
89     /*
90      * The MAX78000 user guide's Interrupt Vector Table section
91      * suggests that there are 120 IRQs in the text, while only listing
92      * 104 in table 5-1. Implement the more generous of the two.
93      * This has not been tested in hardware.
94      */
95     qdev_prop_set_uint32(armv7m, "num-irq", 120);
96     qdev_prop_set_uint8(armv7m, "num-prio-bits", 3);
97     qdev_prop_set_string(armv7m, "cpu-type", ARM_CPU_TYPE_NAME("cortex-m4"));
98     qdev_prop_set_bit(armv7m, "enable-bitband", true);
99     qdev_connect_clock_in(armv7m, "cpuclk", s->sysclk);
100     object_property_set_link(OBJECT(&s->armv7m), "memory",
101                              OBJECT(system_memory), &error_abort);
102     if (!sysbus_realize(SYS_BUS_DEVICE(&s->armv7m), errp)) {
103         return;
104     }
105 
106     for (i = 0; i < MAX78000_NUM_ICC; i++) {
107         dev = DEVICE(&(s->icc[i]));
108         sysbus_realize(SYS_BUS_DEVICE(dev), errp);
109         sysbus_mmio_map(SYS_BUS_DEVICE(dev), 0, max78000_icc_addr[i]);
110     }
111 
112     for (i = 0; i < MAX78000_NUM_UART; i++) {
113         g_autofree char *link = g_strdup_printf("uart%d", i);
114         dev = DEVICE(&(s->uart[i]));
115         qdev_prop_set_chr(dev, "chardev", serial_hd(i));
116         if (!sysbus_realize(SYS_BUS_DEVICE(&s->uart[i]), errp)) {
117             return;
118         }
119 
120         object_property_set_link(OBJECT(gcrdev), link, OBJECT(dev),
121                                  &err);
122 
123         busdev = SYS_BUS_DEVICE(dev);
124         sysbus_mmio_map(busdev, 0, max78000_uart_addr[i]);
125         sysbus_connect_irq(busdev, 0, qdev_get_gpio_in(armv7m,
126                                                        max78000_uart_irq[i]));
127     }
128 
129     dev = DEVICE(&s->trng);
130     sysbus_realize(SYS_BUS_DEVICE(dev), errp);
131     sysbus_mmio_map(SYS_BUS_DEVICE(dev), 0, 0x4004d000);
132     sysbus_connect_irq(SYS_BUS_DEVICE(dev), 0, qdev_get_gpio_in(armv7m, 4));
133 
134     object_property_set_link(OBJECT(gcrdev), "trng", OBJECT(dev), &err);
135 
136     dev = DEVICE(&s->gcr);
137     sysbus_realize(SYS_BUS_DEVICE(dev), errp);
138     sysbus_mmio_map(SYS_BUS_DEVICE(dev), 0, 0x40000000);
139 
140     create_unimplemented_device("systemInterface",      0x40000400, 0x400);
141     create_unimplemented_device("functionControl",      0x40000800, 0x400);
142     create_unimplemented_device("watchdogTimer0",       0x40003000, 0x400);
143     create_unimplemented_device("dynamicVoltScale",     0x40003c00, 0x40);
144     create_unimplemented_device("SIMO",                 0x40004400, 0x400);
145     create_unimplemented_device("trimSystemInit",       0x40005400, 0x400);
146     create_unimplemented_device("generalCtrlFunc",      0x40005800, 0x400);
147     create_unimplemented_device("wakeupTimer",          0x40006400, 0x400);
148     create_unimplemented_device("powerSequencer",       0x40006800, 0x400);
149     create_unimplemented_device("miscControl",          0x40006c00, 0x400);
150 
151     create_unimplemented_device("aes",                  0x40007400, 0x400);
152     create_unimplemented_device("aesKey",               0x40007800, 0x400);
153 
154     create_unimplemented_device("gpio0",                0x40008000, 0x1000);
155     create_unimplemented_device("gpio1",                0x40009000, 0x1000);
156 
157     create_unimplemented_device("parallelCamInterface", 0x4000e000, 0x1000);
158     create_unimplemented_device("CRC",                  0x4000f000, 0x1000);
159 
160     create_unimplemented_device("timer0",               0x40010000, 0x1000);
161     create_unimplemented_device("timer1",               0x40011000, 0x1000);
162     create_unimplemented_device("timer2",               0x40012000, 0x1000);
163     create_unimplemented_device("timer3",               0x40013000, 0x1000);
164 
165     create_unimplemented_device("i2c0",                 0x4001d000, 0x1000);
166     create_unimplemented_device("i2c1",                 0x4001e000, 0x1000);
167     create_unimplemented_device("i2c2",                 0x4001f000, 0x1000);
168 
169     create_unimplemented_device("standardDMA",          0x40028000, 0x1000);
170     create_unimplemented_device("flashController0",     0x40029000, 0x400);
171 
172     create_unimplemented_device("adc",                  0x40034000, 0x1000);
173     create_unimplemented_device("pulseTrainEngine",     0x4003c000, 0xa0);
174     create_unimplemented_device("oneWireMaster",        0x4003d000, 0x1000);
175     create_unimplemented_device("semaphore",            0x4003e000, 0x1000);
176 
177     create_unimplemented_device("spi1",                 0x40046000, 0x2000);
178     create_unimplemented_device("i2s",                  0x40060000, 0x1000);
179     create_unimplemented_device("lowPowerControl",      0x40080000, 0x400);
180     create_unimplemented_device("gpio2",                0x40080400, 0x200);
181     create_unimplemented_device("lowPowerWatchdogTimer",    0x40080800, 0x400);
182     create_unimplemented_device("lowPowerTimer4",       0x40080c00, 0x400);
183 
184     create_unimplemented_device("lowPowerTimer5",       0x40081000, 0x400);
185     create_unimplemented_device("lowPowerUART0",        0x40081400, 0x400);
186     create_unimplemented_device("lowPowerComparator",   0x40088000, 0x400);
187 
188     create_unimplemented_device("spi0",                 0x400be000, 0x400);
189 
190     /*
191      * The MAX78000 user guide's base address map lists the CNN TX FIFO as
192      * beginning at 0x400c0400 and ending at 0x400c0400. Given that CNN_FIFO
193      * is listed as having data accessible up to offset 0x1000, the user
194      * guide is likely incorrect.
195      */
196     create_unimplemented_device("cnnTxFIFO",            0x400c0400, 0x2000);
197 
198     create_unimplemented_device("cnnGlobalControl",     0x50000000, 0x10000);
199     create_unimplemented_device("cnnx16quad0",          0x50100000, 0x40000);
200     create_unimplemented_device("cnnx16quad1",          0x50500000, 0x40000);
201     create_unimplemented_device("cnnx16quad2",          0x50900000, 0x40000);
202     create_unimplemented_device("cnnx16quad3",          0x50d00000, 0x40000);
203 
204 }
205 
206 static void max78000_soc_class_init(ObjectClass *klass, const void *data)
207 {
208     DeviceClass *dc = DEVICE_CLASS(klass);
209 
210     dc->realize = max78000_soc_realize;
211 }
212 
213 static const TypeInfo max78000_soc_info = {
214     .name          = TYPE_MAX78000_SOC,
215     .parent        = TYPE_SYS_BUS_DEVICE,
216     .instance_size = sizeof(MAX78000State),
217     .instance_init = max78000_soc_initfn,
218     .class_init    = max78000_soc_class_init,
219 };
220 
221 static void max78000_soc_types(void)
222 {
223     type_register_static(&max78000_soc_info);
224 }
225 
226 type_init(max78000_soc_types)
227