xref: /openbmc/qemu/hw/arm/nrf51_soc.c (revision 354908ce)
1 /*
2  * Nordic Semiconductor nRF51 SoC
3  * http://infocenter.nordicsemi.com/pdf/nRF51_RM_v3.0.1.pdf
4  *
5  * Copyright 2018 Joel Stanley <joel@jms.id.au>
6  *
7  * This code is licensed under the GPL version 2 or later.  See
8  * the COPYING file in the top-level directory.
9  */
10 
11 #include "qemu/osdep.h"
12 #include "qapi/error.h"
13 #include "hw/arm/boot.h"
14 #include "hw/sysbus.h"
15 #include "hw/misc/unimp.h"
16 #include "exec/address-spaces.h"
17 #include "qemu/log.h"
18 #include "cpu.h"
19 
20 #include "hw/arm/nrf51.h"
21 #include "hw/arm/nrf51_soc.h"
22 
23 /*
24  * The size and base is for the NRF51822 part. If other parts
25  * are supported in the future, add a sub-class of NRF51SoC for
26  * the specific variants
27  */
28 #define NRF51822_FLASH_PAGES    256
29 #define NRF51822_SRAM_PAGES     16
30 #define NRF51822_FLASH_SIZE     (NRF51822_FLASH_PAGES * NRF51_PAGE_SIZE)
31 #define NRF51822_SRAM_SIZE      (NRF51822_SRAM_PAGES * NRF51_PAGE_SIZE)
32 
33 #define BASE_TO_IRQ(base) ((base >> 12) & 0x1F)
34 
35 static uint64_t clock_read(void *opaque, hwaddr addr, unsigned int size)
36 {
37     qemu_log_mask(LOG_UNIMP, "%s: 0x%" HWADDR_PRIx " [%u]\n",
38                   __func__, addr, size);
39     return 1;
40 }
41 
42 static void clock_write(void *opaque, hwaddr addr, uint64_t data,
43                         unsigned int size)
44 {
45     qemu_log_mask(LOG_UNIMP, "%s: 0x%" HWADDR_PRIx " <- 0x%" PRIx64 " [%u]\n",
46                   __func__, addr, data, size);
47 }
48 
49 static const MemoryRegionOps clock_ops = {
50     .read = clock_read,
51     .write = clock_write
52 };
53 
54 
55 static void nrf51_soc_realize(DeviceState *dev_soc, Error **errp)
56 {
57     NRF51State *s = NRF51_SOC(dev_soc);
58     MemoryRegion *mr;
59     Error *err = NULL;
60     uint8_t i = 0;
61     hwaddr base_addr = 0;
62 
63     if (!s->board_memory) {
64         error_setg(errp, "memory property was not set");
65         return;
66     }
67 
68     object_property_set_link(OBJECT(&s->cpu), OBJECT(&s->container), "memory",
69             &err);
70     if (err) {
71         error_propagate(errp, err);
72         return;
73     }
74     sysbus_realize(SYS_BUS_DEVICE(&s->cpu), &err);
75     if (err) {
76         error_propagate(errp, err);
77         return;
78     }
79 
80     memory_region_add_subregion_overlap(&s->container, 0, s->board_memory, -1);
81 
82     memory_region_init_ram(&s->sram, OBJECT(s), "nrf51.sram", s->sram_size,
83                            &err);
84     if (err) {
85         error_propagate(errp, err);
86         return;
87     }
88     memory_region_add_subregion(&s->container, NRF51_SRAM_BASE, &s->sram);
89 
90     /* UART */
91     sysbus_realize(SYS_BUS_DEVICE(&s->uart), &err);
92     if (err) {
93         error_propagate(errp, err);
94         return;
95     }
96     mr = sysbus_mmio_get_region(SYS_BUS_DEVICE(&s->uart), 0);
97     memory_region_add_subregion_overlap(&s->container, NRF51_UART_BASE, mr, 0);
98     sysbus_connect_irq(SYS_BUS_DEVICE(&s->uart), 0,
99                        qdev_get_gpio_in(DEVICE(&s->cpu),
100                        BASE_TO_IRQ(NRF51_UART_BASE)));
101 
102     /* RNG */
103     sysbus_realize(SYS_BUS_DEVICE(&s->rng), &err);
104     if (err) {
105         error_propagate(errp, err);
106         return;
107     }
108 
109     mr = sysbus_mmio_get_region(SYS_BUS_DEVICE(&s->rng), 0);
110     memory_region_add_subregion_overlap(&s->container, NRF51_RNG_BASE, mr, 0);
111     sysbus_connect_irq(SYS_BUS_DEVICE(&s->rng), 0,
112                        qdev_get_gpio_in(DEVICE(&s->cpu),
113                        BASE_TO_IRQ(NRF51_RNG_BASE)));
114 
115     /* UICR, FICR, NVMC, FLASH */
116     object_property_set_uint(OBJECT(&s->nvm), s->flash_size, "flash-size",
117                              &err);
118     if (err) {
119         error_propagate(errp, err);
120         return;
121     }
122 
123     sysbus_realize(SYS_BUS_DEVICE(&s->nvm), &err);
124     if (err) {
125         error_propagate(errp, err);
126         return;
127     }
128 
129     mr = sysbus_mmio_get_region(SYS_BUS_DEVICE(&s->nvm), 0);
130     memory_region_add_subregion_overlap(&s->container, NRF51_NVMC_BASE, mr, 0);
131     mr = sysbus_mmio_get_region(SYS_BUS_DEVICE(&s->nvm), 1);
132     memory_region_add_subregion_overlap(&s->container, NRF51_FICR_BASE, mr, 0);
133     mr = sysbus_mmio_get_region(SYS_BUS_DEVICE(&s->nvm), 2);
134     memory_region_add_subregion_overlap(&s->container, NRF51_UICR_BASE, mr, 0);
135     mr = sysbus_mmio_get_region(SYS_BUS_DEVICE(&s->nvm), 3);
136     memory_region_add_subregion_overlap(&s->container, NRF51_FLASH_BASE, mr, 0);
137 
138     /* GPIO */
139     sysbus_realize(SYS_BUS_DEVICE(&s->gpio), &err);
140     if (err) {
141         error_propagate(errp, err);
142         return;
143     }
144 
145     mr = sysbus_mmio_get_region(SYS_BUS_DEVICE(&s->gpio), 0);
146     memory_region_add_subregion_overlap(&s->container, NRF51_GPIO_BASE, mr, 0);
147 
148     /* Pass all GPIOs to the SOC layer so they are available to the board */
149     qdev_pass_gpios(DEVICE(&s->gpio), dev_soc, NULL);
150 
151     /* TIMER */
152     for (i = 0; i < NRF51_NUM_TIMERS; i++) {
153         object_property_set_uint(OBJECT(&s->timer[i]), i, "id", &err);
154         if (err) {
155             error_propagate(errp, err);
156             return;
157         }
158         sysbus_realize(SYS_BUS_DEVICE(&s->timer[i]), &err);
159         if (err) {
160             error_propagate(errp, err);
161             return;
162         }
163 
164         base_addr = NRF51_TIMER_BASE + i * NRF51_PERIPHERAL_SIZE;
165 
166         sysbus_mmio_map(SYS_BUS_DEVICE(&s->timer[i]), 0, base_addr);
167         sysbus_connect_irq(SYS_BUS_DEVICE(&s->timer[i]), 0,
168                            qdev_get_gpio_in(DEVICE(&s->cpu),
169                                             BASE_TO_IRQ(base_addr)));
170     }
171 
172     /* STUB Peripherals */
173     memory_region_init_io(&s->clock, OBJECT(dev_soc), &clock_ops, NULL,
174                           "nrf51_soc.clock", NRF51_PERIPHERAL_SIZE);
175     memory_region_add_subregion_overlap(&s->container,
176                                         NRF51_IOMEM_BASE, &s->clock, -1);
177 
178     create_unimplemented_device("nrf51_soc.io", NRF51_IOMEM_BASE,
179                                 NRF51_IOMEM_SIZE);
180     create_unimplemented_device("nrf51_soc.private",
181                                 NRF51_PRIVATE_BASE, NRF51_PRIVATE_SIZE);
182 }
183 
184 static void nrf51_soc_init(Object *obj)
185 {
186     uint8_t i = 0;
187 
188     NRF51State *s = NRF51_SOC(obj);
189 
190     memory_region_init(&s->container, obj, "nrf51-container", UINT64_MAX);
191 
192     object_initialize_child(OBJECT(s), "armv6m", &s->cpu, TYPE_ARMV7M);
193     qdev_prop_set_string(DEVICE(&s->cpu), "cpu-type",
194                          ARM_CPU_TYPE_NAME("cortex-m0"));
195     qdev_prop_set_uint32(DEVICE(&s->cpu), "num-irq", 32);
196 
197     object_initialize_child(obj, "uart", &s->uart, TYPE_NRF51_UART);
198     object_property_add_alias(obj, "serial0", OBJECT(&s->uart), "chardev");
199 
200     object_initialize_child(obj, "rng", &s->rng, TYPE_NRF51_RNG);
201 
202     object_initialize_child(obj, "nvm", &s->nvm, TYPE_NRF51_NVM);
203 
204     object_initialize_child(obj, "gpio", &s->gpio, TYPE_NRF51_GPIO);
205 
206     for (i = 0; i < NRF51_NUM_TIMERS; i++) {
207         object_initialize_child(obj, "timer[*]", &s->timer[i],
208                                 TYPE_NRF51_TIMER);
209 
210     }
211 }
212 
213 static Property nrf51_soc_properties[] = {
214     DEFINE_PROP_LINK("memory", NRF51State, board_memory, TYPE_MEMORY_REGION,
215                      MemoryRegion *),
216     DEFINE_PROP_UINT32("sram-size", NRF51State, sram_size, NRF51822_SRAM_SIZE),
217     DEFINE_PROP_UINT32("flash-size", NRF51State, flash_size,
218                        NRF51822_FLASH_SIZE),
219     DEFINE_PROP_END_OF_LIST(),
220 };
221 
222 static void nrf51_soc_class_init(ObjectClass *klass, void *data)
223 {
224     DeviceClass *dc = DEVICE_CLASS(klass);
225 
226     dc->realize = nrf51_soc_realize;
227     device_class_set_props(dc, nrf51_soc_properties);
228 }
229 
230 static const TypeInfo nrf51_soc_info = {
231     .name          = TYPE_NRF51_SOC,
232     .parent        = TYPE_SYS_BUS_DEVICE,
233     .instance_size = sizeof(NRF51State),
234     .instance_init = nrf51_soc_init,
235     .class_init    = nrf51_soc_class_init,
236 };
237 
238 static void nrf51_soc_types(void)
239 {
240     type_register_static(&nrf51_soc_info);
241 }
242 type_init(nrf51_soc_types)
243