xref: /openbmc/qemu/hw/arm/xilinx_zynq.c (revision 28004fb7)
1 /*
2  * Xilinx Zynq Baseboard System emulation.
3  *
4  * Copyright (c) 2010 Xilinx.
5  * Copyright (c) 2012 Peter A.G. Crosthwaite (peter.croshtwaite@petalogix.com)
6  * Copyright (c) 2012 Petalogix Pty Ltd.
7  * Written by Haibing Ma
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version
12  * 2 of the License, or (at your option) any later version.
13  *
14  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, see <http://www.gnu.org/licenses/>.
16  */
17 
18 #include "qemu/osdep.h"
19 #include "qemu/units.h"
20 #include "qapi/error.h"
21 #include "hw/sysbus.h"
22 #include "hw/arm/boot.h"
23 #include "net/net.h"
24 #include "sysemu/sysemu.h"
25 #include "hw/boards.h"
26 #include "hw/block/flash.h"
27 #include "hw/loader.h"
28 #include "hw/adc/zynq-xadc.h"
29 #include "hw/ssi/ssi.h"
30 #include "hw/usb/chipidea.h"
31 #include "qemu/error-report.h"
32 #include "hw/sd/sdhci.h"
33 #include "hw/char/cadence_uart.h"
34 #include "hw/net/cadence_gem.h"
35 #include "hw/cpu/a9mpcore.h"
36 #include "hw/qdev-clock.h"
37 #include "sysemu/reset.h"
38 #include "qom/object.h"
39 #include "exec/tswap.h"
40 #include "target/arm/cpu-qom.h"
41 
42 #define TYPE_ZYNQ_MACHINE MACHINE_TYPE_NAME("xilinx-zynq-a9")
43 OBJECT_DECLARE_SIMPLE_TYPE(ZynqMachineState, ZYNQ_MACHINE)
44 
45 /* board base frequency: 33.333333 MHz */
46 #define PS_CLK_FREQUENCY (100 * 1000 * 1000 / 3)
47 
48 #define NUM_SPI_FLASHES 4
49 #define NUM_QSPI_FLASHES 2
50 #define NUM_QSPI_BUSSES 2
51 
52 #define FLASH_SIZE (64 * 1024 * 1024)
53 #define FLASH_SECTOR_SIZE (128 * 1024)
54 
55 #define IRQ_OFFSET 32 /* pic interrupts start from index 32 */
56 
57 #define MPCORE_PERIPHBASE 0xF8F00000
58 #define ZYNQ_BOARD_MIDR 0x413FC090
59 
60 static const int dma_irqs[8] = {
61     46, 47, 48, 49, 72, 73, 74, 75
62 };
63 
64 #define BOARD_SETUP_ADDR        0x100
65 
66 #define SLCR_LOCK_OFFSET        0x004
67 #define SLCR_UNLOCK_OFFSET      0x008
68 #define SLCR_ARM_PLL_OFFSET     0x100
69 
70 #define SLCR_XILINX_UNLOCK_KEY  0xdf0d
71 #define SLCR_XILINX_LOCK_KEY    0x767b
72 
73 #define ZYNQ_SDHCI_CAPABILITIES 0x69ec0080  /* Datasheet: UG585 (v1.12.1) */
74 
75 #define ARMV7_IMM16(x) (extract32((x),  0, 12) | \
76                         extract32((x), 12,  4) << 16)
77 
78 /* Write immediate val to address r0 + addr. r0 should contain base offset
79  * of the SLCR block. Clobbers r1.
80  */
81 
82 #define SLCR_WRITE(addr, val) \
83     0xe3001000 + ARMV7_IMM16(extract32((val),  0, 16)), /* movw r1 ... */ \
84     0xe3401000 + ARMV7_IMM16(extract32((val), 16, 16)), /* movt r1 ... */ \
85     0xe5801000 + (addr)
86 
87 struct ZynqMachineState {
88     MachineState parent;
89     Clock *ps_clk;
90 };
91 
92 static void zynq_write_board_setup(ARMCPU *cpu,
93                                    const struct arm_boot_info *info)
94 {
95     int n;
96     uint32_t board_setup_blob[] = {
97         0xe3a004f8, /* mov r0, #0xf8000000 */
98         SLCR_WRITE(SLCR_UNLOCK_OFFSET, SLCR_XILINX_UNLOCK_KEY),
99         SLCR_WRITE(SLCR_ARM_PLL_OFFSET, 0x00014008),
100         SLCR_WRITE(SLCR_LOCK_OFFSET, SLCR_XILINX_LOCK_KEY),
101         0xe12fff1e, /* bx lr */
102     };
103     for (n = 0; n < ARRAY_SIZE(board_setup_blob); n++) {
104         board_setup_blob[n] = tswap32(board_setup_blob[n]);
105     }
106     rom_add_blob_fixed("board-setup", board_setup_blob,
107                        sizeof(board_setup_blob), BOARD_SETUP_ADDR);
108 }
109 
110 static struct arm_boot_info zynq_binfo = {};
111 
112 static void gem_init(NICInfo *nd, uint32_t base, qemu_irq irq)
113 {
114     DeviceState *dev;
115     SysBusDevice *s;
116 
117     dev = qdev_new(TYPE_CADENCE_GEM);
118     if (nd->used) {
119         qemu_check_nic_model(nd, TYPE_CADENCE_GEM);
120         qdev_set_nic_properties(dev, nd);
121     }
122     object_property_set_int(OBJECT(dev), "phy-addr", 7, &error_abort);
123     s = SYS_BUS_DEVICE(dev);
124     sysbus_realize_and_unref(s, &error_fatal);
125     sysbus_mmio_map(s, 0, base);
126     sysbus_connect_irq(s, 0, irq);
127 }
128 
129 static inline int zynq_init_spi_flashes(uint32_t base_addr, qemu_irq irq,
130                                         bool is_qspi, int unit0)
131 {
132     int unit = unit0;
133     DeviceState *dev;
134     SysBusDevice *busdev;
135     SSIBus *spi;
136     DeviceState *flash_dev;
137     int i, j;
138     int num_busses =  is_qspi ? NUM_QSPI_BUSSES : 1;
139     int num_ss = is_qspi ? NUM_QSPI_FLASHES : NUM_SPI_FLASHES;
140 
141     dev = qdev_new(is_qspi ? "xlnx.ps7-qspi" : "xlnx.ps7-spi");
142     qdev_prop_set_uint8(dev, "num-txrx-bytes", is_qspi ? 4 : 1);
143     qdev_prop_set_uint8(dev, "num-ss-bits", num_ss);
144     qdev_prop_set_uint8(dev, "num-busses", num_busses);
145     busdev = SYS_BUS_DEVICE(dev);
146     sysbus_realize_and_unref(busdev, &error_fatal);
147     sysbus_mmio_map(busdev, 0, base_addr);
148     if (is_qspi) {
149         sysbus_mmio_map(busdev, 1, 0xFC000000);
150     }
151     sysbus_connect_irq(busdev, 0, irq);
152 
153     for (i = 0; i < num_busses; ++i) {
154         char bus_name[16];
155         qemu_irq cs_line;
156 
157         snprintf(bus_name, 16, "spi%d", i);
158         spi = (SSIBus *)qdev_get_child_bus(dev, bus_name);
159 
160         for (j = 0; j < num_ss; ++j) {
161             DriveInfo *dinfo = drive_get(IF_MTD, 0, unit++);
162             flash_dev = qdev_new("n25q128");
163             if (dinfo) {
164                 qdev_prop_set_drive_err(flash_dev, "drive",
165                                         blk_by_legacy_dinfo(dinfo),
166                                         &error_fatal);
167             }
168             qdev_prop_set_uint8(flash_dev, "cs", j);
169             qdev_realize_and_unref(flash_dev, BUS(spi), &error_fatal);
170 
171             cs_line = qdev_get_gpio_in_named(flash_dev, SSI_GPIO_CS, 0);
172             sysbus_connect_irq(busdev, i * num_ss + j + 1, cs_line);
173         }
174     }
175 
176     return unit;
177 }
178 
179 static void zynq_init(MachineState *machine)
180 {
181     ZynqMachineState *zynq_machine = ZYNQ_MACHINE(machine);
182     ARMCPU *cpu;
183     MemoryRegion *address_space_mem = get_system_memory();
184     MemoryRegion *ocm_ram = g_new(MemoryRegion, 1);
185     DeviceState *dev, *slcr;
186     SysBusDevice *busdev;
187     qemu_irq pic[64];
188     int n;
189 
190     /* max 2GB ram */
191     if (machine->ram_size > 2 * GiB) {
192         error_report("RAM size more than 2 GiB is not supported");
193         exit(EXIT_FAILURE);
194     }
195 
196     cpu = ARM_CPU(object_new(machine->cpu_type));
197 
198     /* By default A9 CPUs have EL3 enabled.  This board does not
199      * currently support EL3 so the CPU EL3 property is disabled before
200      * realization.
201      */
202     if (object_property_find(OBJECT(cpu), "has_el3")) {
203         object_property_set_bool(OBJECT(cpu), "has_el3", false, &error_fatal);
204     }
205 
206     object_property_set_int(OBJECT(cpu), "midr", ZYNQ_BOARD_MIDR,
207                             &error_fatal);
208     object_property_set_int(OBJECT(cpu), "reset-cbar", MPCORE_PERIPHBASE,
209                             &error_fatal);
210     qdev_realize(DEVICE(cpu), NULL, &error_fatal);
211 
212     /* DDR remapped to address zero.  */
213     memory_region_add_subregion(address_space_mem, 0, machine->ram);
214 
215     /* 256K of on-chip memory */
216     memory_region_init_ram(ocm_ram, NULL, "zynq.ocm_ram", 256 * KiB,
217                            &error_fatal);
218     memory_region_add_subregion(address_space_mem, 0xFFFC0000, ocm_ram);
219 
220     DriveInfo *dinfo = drive_get(IF_PFLASH, 0, 0);
221 
222     /* AMD */
223     pflash_cfi02_register(0xe2000000, "zynq.pflash", FLASH_SIZE,
224                           dinfo ? blk_by_legacy_dinfo(dinfo) : NULL,
225                           FLASH_SECTOR_SIZE, 1,
226                           1, 0x0066, 0x0022, 0x0000, 0x0000, 0x0555, 0x2aa,
227                           0);
228 
229     /* Create the main clock source, and feed slcr with it */
230     zynq_machine->ps_clk = CLOCK(object_new(TYPE_CLOCK));
231     object_property_add_child(OBJECT(zynq_machine), "ps_clk",
232                               OBJECT(zynq_machine->ps_clk));
233     object_unref(OBJECT(zynq_machine->ps_clk));
234     clock_set_hz(zynq_machine->ps_clk, PS_CLK_FREQUENCY);
235 
236     /* Create slcr, keep a pointer to connect clocks */
237     slcr = qdev_new("xilinx-zynq_slcr");
238     qdev_connect_clock_in(slcr, "ps_clk", zynq_machine->ps_clk);
239     sysbus_realize_and_unref(SYS_BUS_DEVICE(slcr), &error_fatal);
240     sysbus_mmio_map(SYS_BUS_DEVICE(slcr), 0, 0xF8000000);
241 
242     dev = qdev_new(TYPE_A9MPCORE_PRIV);
243     qdev_prop_set_uint32(dev, "num-cpu", 1);
244     busdev = SYS_BUS_DEVICE(dev);
245     sysbus_realize_and_unref(busdev, &error_fatal);
246     sysbus_mmio_map(busdev, 0, MPCORE_PERIPHBASE);
247     sysbus_connect_irq(busdev, 0,
248                        qdev_get_gpio_in(DEVICE(cpu), ARM_CPU_IRQ));
249 
250     for (n = 0; n < 64; n++) {
251         pic[n] = qdev_get_gpio_in(dev, n);
252     }
253 
254     n = zynq_init_spi_flashes(0xE0006000, pic[58 - IRQ_OFFSET], false, 0);
255     n = zynq_init_spi_flashes(0xE0007000, pic[81 - IRQ_OFFSET], false, n);
256     n = zynq_init_spi_flashes(0xE000D000, pic[51 - IRQ_OFFSET], true, n);
257 
258     sysbus_create_simple(TYPE_CHIPIDEA, 0xE0002000, pic[53 - IRQ_OFFSET]);
259     sysbus_create_simple(TYPE_CHIPIDEA, 0xE0003000, pic[76 - IRQ_OFFSET]);
260 
261     dev = qdev_new(TYPE_CADENCE_UART);
262     busdev = SYS_BUS_DEVICE(dev);
263     qdev_prop_set_chr(dev, "chardev", serial_hd(0));
264     qdev_connect_clock_in(dev, "refclk",
265                           qdev_get_clock_out(slcr, "uart0_ref_clk"));
266     sysbus_realize_and_unref(busdev, &error_fatal);
267     sysbus_mmio_map(busdev, 0, 0xE0000000);
268     sysbus_connect_irq(busdev, 0, pic[59 - IRQ_OFFSET]);
269     dev = qdev_new(TYPE_CADENCE_UART);
270     busdev = SYS_BUS_DEVICE(dev);
271     qdev_prop_set_chr(dev, "chardev", serial_hd(1));
272     qdev_connect_clock_in(dev, "refclk",
273                           qdev_get_clock_out(slcr, "uart1_ref_clk"));
274     sysbus_realize_and_unref(busdev, &error_fatal);
275     sysbus_mmio_map(busdev, 0, 0xE0001000);
276     sysbus_connect_irq(busdev, 0, pic[82 - IRQ_OFFSET]);
277 
278     sysbus_create_varargs("cadence_ttc", 0xF8001000,
279             pic[42-IRQ_OFFSET], pic[43-IRQ_OFFSET], pic[44-IRQ_OFFSET], NULL);
280     sysbus_create_varargs("cadence_ttc", 0xF8002000,
281             pic[69-IRQ_OFFSET], pic[70-IRQ_OFFSET], pic[71-IRQ_OFFSET], NULL);
282 
283     gem_init(&nd_table[0], 0xE000B000, pic[54-IRQ_OFFSET]);
284     gem_init(&nd_table[1], 0xE000C000, pic[77-IRQ_OFFSET]);
285 
286     for (n = 0; n < 2; n++) {
287         int hci_irq = n ? 79 : 56;
288         hwaddr hci_addr = n ? 0xE0101000 : 0xE0100000;
289         DriveInfo *di;
290         BlockBackend *blk;
291         DeviceState *carddev;
292 
293         /* Compatible with:
294          * - SD Host Controller Specification Version 2.0 Part A2
295          * - SDIO Specification Version 2.0
296          * - MMC Specification Version 3.31
297          */
298         dev = qdev_new(TYPE_SYSBUS_SDHCI);
299         qdev_prop_set_uint8(dev, "sd-spec-version", 2);
300         qdev_prop_set_uint64(dev, "capareg", ZYNQ_SDHCI_CAPABILITIES);
301         sysbus_realize_and_unref(SYS_BUS_DEVICE(dev), &error_fatal);
302         sysbus_mmio_map(SYS_BUS_DEVICE(dev), 0, hci_addr);
303         sysbus_connect_irq(SYS_BUS_DEVICE(dev), 0, pic[hci_irq - IRQ_OFFSET]);
304 
305         di = drive_get(IF_SD, 0, n);
306         blk = di ? blk_by_legacy_dinfo(di) : NULL;
307         carddev = qdev_new(TYPE_SD_CARD);
308         qdev_prop_set_drive_err(carddev, "drive", blk, &error_fatal);
309         qdev_realize_and_unref(carddev, qdev_get_child_bus(dev, "sd-bus"),
310                                &error_fatal);
311     }
312 
313     dev = qdev_new(TYPE_ZYNQ_XADC);
314     sysbus_realize_and_unref(SYS_BUS_DEVICE(dev), &error_fatal);
315     sysbus_mmio_map(SYS_BUS_DEVICE(dev), 0, 0xF8007100);
316     sysbus_connect_irq(SYS_BUS_DEVICE(dev), 0, pic[39-IRQ_OFFSET]);
317 
318     dev = qdev_new("pl330");
319     object_property_set_link(OBJECT(dev), "memory",
320                              OBJECT(address_space_mem),
321                              &error_fatal);
322     qdev_prop_set_uint8(dev, "num_chnls",  8);
323     qdev_prop_set_uint8(dev, "num_periph_req",  4);
324     qdev_prop_set_uint8(dev, "num_events",  16);
325 
326     qdev_prop_set_uint8(dev, "data_width",  64);
327     qdev_prop_set_uint8(dev, "wr_cap",  8);
328     qdev_prop_set_uint8(dev, "wr_q_dep",  16);
329     qdev_prop_set_uint8(dev, "rd_cap",  8);
330     qdev_prop_set_uint8(dev, "rd_q_dep",  16);
331     qdev_prop_set_uint16(dev, "data_buffer_dep",  256);
332 
333     busdev = SYS_BUS_DEVICE(dev);
334     sysbus_realize_and_unref(busdev, &error_fatal);
335     sysbus_mmio_map(busdev, 0, 0xF8003000);
336     sysbus_connect_irq(busdev, 0, pic[45-IRQ_OFFSET]); /* abort irq line */
337     for (n = 0; n < ARRAY_SIZE(dma_irqs); ++n) { /* event irqs */
338         sysbus_connect_irq(busdev, n + 1, pic[dma_irqs[n] - IRQ_OFFSET]);
339     }
340 
341     dev = qdev_new("xlnx.ps7-dev-cfg");
342     busdev = SYS_BUS_DEVICE(dev);
343     sysbus_realize_and_unref(busdev, &error_fatal);
344     sysbus_connect_irq(busdev, 0, pic[40 - IRQ_OFFSET]);
345     sysbus_mmio_map(busdev, 0, 0xF8007000);
346 
347     zynq_binfo.ram_size = machine->ram_size;
348     zynq_binfo.board_id = 0xd32;
349     zynq_binfo.loader_start = 0;
350     zynq_binfo.board_setup_addr = BOARD_SETUP_ADDR;
351     zynq_binfo.write_board_setup = zynq_write_board_setup;
352 
353     arm_load_kernel(cpu, machine, &zynq_binfo);
354 }
355 
356 static void zynq_machine_class_init(ObjectClass *oc, void *data)
357 {
358     static const char * const valid_cpu_types[] = {
359         ARM_CPU_TYPE_NAME("cortex-a9"),
360         NULL
361     };
362     MachineClass *mc = MACHINE_CLASS(oc);
363     mc->desc = "Xilinx Zynq Platform Baseboard for Cortex-A9";
364     mc->init = zynq_init;
365     mc->max_cpus = 1;
366     mc->no_sdcard = 1;
367     mc->ignore_memory_transaction_failures = true;
368     mc->valid_cpu_types = valid_cpu_types;
369     mc->default_ram_id = "zynq.ext_ram";
370 }
371 
372 static const TypeInfo zynq_machine_type = {
373     .name = TYPE_ZYNQ_MACHINE,
374     .parent = TYPE_MACHINE,
375     .class_init = zynq_machine_class_init,
376     .instance_size = sizeof(ZynqMachineState),
377 };
378 
379 static void zynq_machine_register_types(void)
380 {
381     type_register_static(&zynq_machine_type);
382 }
383 
384 type_init(zynq_machine_register_types)
385