xref: /qemu/hw/avr/arduino.c (revision db1015e92e04835c9eb50c29625fe566d1202dbd)
1 /*
2  * QEMU Arduino boards
3  *
4  * Copyright (c) 2019-2020 Philippe Mathieu-Daudé
5  *
6  * This work is licensed under the terms of the GNU GPLv2 or later.
7  * See the COPYING file in the top-level directory.
8  * SPDX-License-Identifier: GPL-2.0-or-later
9  */
10 
11 /* TODO: Implement the use of EXTRAM */
12 
13 #include "qemu/osdep.h"
14 #include "qapi/error.h"
15 #include "hw/boards.h"
16 #include "atmega.h"
17 #include "boot.h"
18 #include "qom/object.h"
19 
20 struct ArduinoMachineState {
21     /*< private >*/
22     MachineState parent_obj;
23     /*< public >*/
24     AtmegaMcuState mcu;
25 };
26 typedef struct ArduinoMachineState ArduinoMachineState;
27 
28 struct ArduinoMachineClass {
29     /*< private >*/
30     MachineClass parent_class;
31     /*< public >*/
32     const char *mcu_type;
33     uint64_t xtal_hz;
34 };
35 typedef struct ArduinoMachineClass ArduinoMachineClass;
36 
37 #define TYPE_ARDUINO_MACHINE \
38         MACHINE_TYPE_NAME("arduino")
39 #define ARDUINO_MACHINE(obj) \
40         OBJECT_CHECK(ArduinoMachineState, (obj), TYPE_ARDUINO_MACHINE)
41 #define ARDUINO_MACHINE_CLASS(klass) \
42         OBJECT_CLASS_CHECK(ArduinoMachineClass, (klass), TYPE_ARDUINO_MACHINE)
43 #define ARDUINO_MACHINE_GET_CLASS(obj) \
44         OBJECT_GET_CLASS(ArduinoMachineClass, (obj), TYPE_ARDUINO_MACHINE)
45 
46 static void arduino_machine_init(MachineState *machine)
47 {
48     ArduinoMachineClass *amc = ARDUINO_MACHINE_GET_CLASS(machine);
49     ArduinoMachineState *ams = ARDUINO_MACHINE(machine);
50 
51     object_initialize_child(OBJECT(machine), "mcu", &ams->mcu, amc->mcu_type);
52     object_property_set_uint(OBJECT(&ams->mcu), "xtal-frequency-hz",
53                              amc->xtal_hz, &error_abort);
54     sysbus_realize(SYS_BUS_DEVICE(&ams->mcu), &error_abort);
55 
56     if (machine->firmware) {
57         if (!avr_load_firmware(&ams->mcu.cpu, machine,
58                                &ams->mcu.flash, machine->firmware)) {
59             exit(1);
60         }
61     }
62 }
63 
64 static void arduino_machine_class_init(ObjectClass *oc, void *data)
65 {
66     MachineClass *mc = MACHINE_CLASS(oc);
67 
68     mc->init = arduino_machine_init;
69     mc->default_cpus = 1;
70     mc->min_cpus = mc->default_cpus;
71     mc->max_cpus = mc->default_cpus;
72     mc->no_floppy = 1;
73     mc->no_cdrom = 1;
74     mc->no_parallel = 1;
75 }
76 
77 static void arduino_duemilanove_class_init(ObjectClass *oc, void *data)
78 {
79     MachineClass *mc = MACHINE_CLASS(oc);
80     ArduinoMachineClass *amc = ARDUINO_MACHINE_CLASS(oc);
81 
82     /* https://www.arduino.cc/en/Main/ArduinoBoardDuemilanove */
83     mc->desc        = "Arduino Duemilanove (ATmega168)",
84     mc->alias       = "2009";
85     amc->mcu_type   = TYPE_ATMEGA168_MCU;
86     amc->xtal_hz    = 16 * 1000 * 1000;
87 };
88 
89 static void arduino_uno_class_init(ObjectClass *oc, void *data)
90 {
91     MachineClass *mc = MACHINE_CLASS(oc);
92     ArduinoMachineClass *amc = ARDUINO_MACHINE_CLASS(oc);
93 
94     /* https://store.arduino.cc/arduino-uno-rev3 */
95     mc->desc        = "Arduino UNO (ATmega328P)";
96     mc->alias       = "uno";
97     amc->mcu_type   = TYPE_ATMEGA328_MCU;
98     amc->xtal_hz    = 16 * 1000 * 1000;
99 };
100 
101 static void arduino_mega_class_init(ObjectClass *oc, void *data)
102 {
103     MachineClass *mc = MACHINE_CLASS(oc);
104     ArduinoMachineClass *amc = ARDUINO_MACHINE_CLASS(oc);
105 
106     /* https://www.arduino.cc/en/Main/ArduinoBoardMega */
107     mc->desc        = "Arduino Mega (ATmega1280)";
108     mc->alias       = "mega";
109     amc->mcu_type   = TYPE_ATMEGA1280_MCU;
110     amc->xtal_hz    = 16 * 1000 * 1000;
111 };
112 
113 static void arduino_mega2560_class_init(ObjectClass *oc, void *data)
114 {
115     MachineClass *mc = MACHINE_CLASS(oc);
116     ArduinoMachineClass *amc = ARDUINO_MACHINE_CLASS(oc);
117 
118     /* https://store.arduino.cc/arduino-mega-2560-rev3 */
119     mc->desc        = "Arduino Mega 2560 (ATmega2560)";
120     mc->alias       = "mega2560";
121     amc->mcu_type   = TYPE_ATMEGA2560_MCU;
122     amc->xtal_hz    = 16 * 1000 * 1000; /* CSTCE16M0V53-R0 */
123 };
124 
125 static const TypeInfo arduino_machine_types[] = {
126     {
127         .name          = MACHINE_TYPE_NAME("arduino-duemilanove"),
128         .parent        = TYPE_ARDUINO_MACHINE,
129         .class_init    = arduino_duemilanove_class_init,
130     }, {
131         .name          = MACHINE_TYPE_NAME("arduino-uno"),
132         .parent        = TYPE_ARDUINO_MACHINE,
133         .class_init    = arduino_uno_class_init,
134     }, {
135         .name          = MACHINE_TYPE_NAME("arduino-mega"),
136         .parent        = TYPE_ARDUINO_MACHINE,
137         .class_init    = arduino_mega_class_init,
138     }, {
139         .name          = MACHINE_TYPE_NAME("arduino-mega-2560-v3"),
140         .parent        = TYPE_ARDUINO_MACHINE,
141         .class_init    = arduino_mega2560_class_init,
142     }, {
143         .name           = TYPE_ARDUINO_MACHINE,
144         .parent         = TYPE_MACHINE,
145         .instance_size  = sizeof(ArduinoMachineState),
146         .class_size     = sizeof(ArduinoMachineClass),
147         .class_init     = arduino_machine_class_init,
148         .abstract       = true,
149     }
150 };
151 
152 DEFINE_TYPES(arduino_machine_types)
153