xref: /openbmc/qemu/target/avr/cpu.c (revision dc495494)
1 /*
2  * QEMU AVR CPU
3  *
4  * Copyright (c) 2019-2020 Michael Rolnik
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, see
18  * <http://www.gnu.org/licenses/lgpl-2.1.html>
19  */
20 
21 #include "qemu/osdep.h"
22 #include "qapi/error.h"
23 #include "qemu/qemu-print.h"
24 #include "exec/exec-all.h"
25 #include "cpu.h"
26 #include "disas/dis-asm.h"
27 #include "tcg/debug-assert.h"
28 #include "hw/qdev-properties.h"
29 
30 static void avr_cpu_set_pc(CPUState *cs, vaddr value)
31 {
32     AVRCPU *cpu = AVR_CPU(cs);
33 
34     cpu->env.pc_w = value / 2; /* internally PC points to words */
35 }
36 
37 static vaddr avr_cpu_get_pc(CPUState *cs)
38 {
39     AVRCPU *cpu = AVR_CPU(cs);
40 
41     return cpu->env.pc_w * 2;
42 }
43 
44 static bool avr_cpu_has_work(CPUState *cs)
45 {
46     AVRCPU *cpu = AVR_CPU(cs);
47     CPUAVRState *env = &cpu->env;
48 
49     return (cs->interrupt_request & (CPU_INTERRUPT_HARD | CPU_INTERRUPT_RESET))
50             && cpu_interrupts_enabled(env);
51 }
52 
53 static void avr_cpu_synchronize_from_tb(CPUState *cs,
54                                         const TranslationBlock *tb)
55 {
56     AVRCPU *cpu = AVR_CPU(cs);
57     CPUAVRState *env = &cpu->env;
58 
59     tcg_debug_assert(!(cs->tcg_cflags & CF_PCREL));
60     env->pc_w = tb->pc / 2; /* internally PC points to words */
61 }
62 
63 static void avr_restore_state_to_opc(CPUState *cs,
64                                      const TranslationBlock *tb,
65                                      const uint64_t *data)
66 {
67     AVRCPU *cpu = AVR_CPU(cs);
68     CPUAVRState *env = &cpu->env;
69 
70     env->pc_w = data[0];
71 }
72 
73 static void avr_cpu_reset_hold(Object *obj)
74 {
75     CPUState *cs = CPU(obj);
76     AVRCPU *cpu = AVR_CPU(cs);
77     AVRCPUClass *mcc = AVR_CPU_GET_CLASS(cpu);
78     CPUAVRState *env = &cpu->env;
79 
80     if (mcc->parent_phases.hold) {
81         mcc->parent_phases.hold(obj);
82     }
83 
84     env->pc_w = 0;
85     env->sregI = 1;
86     env->sregC = 0;
87     env->sregZ = 0;
88     env->sregN = 0;
89     env->sregV = 0;
90     env->sregS = 0;
91     env->sregH = 0;
92     env->sregT = 0;
93 
94     env->rampD = 0;
95     env->rampX = 0;
96     env->rampY = 0;
97     env->rampZ = 0;
98     env->eind = 0;
99     env->sp = cpu->init_sp;
100 
101     env->skip = 0;
102 
103     memset(env->r, 0, sizeof(env->r));
104 }
105 
106 static void avr_cpu_disas_set_info(CPUState *cpu, disassemble_info *info)
107 {
108     info->mach = bfd_arch_avr;
109     info->print_insn = avr_print_insn;
110 }
111 
112 static void avr_cpu_realizefn(DeviceState *dev, Error **errp)
113 {
114     CPUState *cs = CPU(dev);
115     AVRCPUClass *mcc = AVR_CPU_GET_CLASS(dev);
116     Error *local_err = NULL;
117 
118     cpu_exec_realizefn(cs, &local_err);
119     if (local_err != NULL) {
120         error_propagate(errp, local_err);
121         return;
122     }
123     qemu_init_vcpu(cs);
124     cpu_reset(cs);
125 
126     mcc->parent_realize(dev, errp);
127 }
128 
129 static void avr_cpu_set_int(void *opaque, int irq, int level)
130 {
131     AVRCPU *cpu = opaque;
132     CPUAVRState *env = &cpu->env;
133     CPUState *cs = CPU(cpu);
134     uint64_t mask = (1ull << irq);
135 
136     if (level) {
137         env->intsrc |= mask;
138         cpu_interrupt(cs, CPU_INTERRUPT_HARD);
139     } else {
140         env->intsrc &= ~mask;
141         if (env->intsrc == 0) {
142             cpu_reset_interrupt(cs, CPU_INTERRUPT_HARD);
143         }
144     }
145 }
146 
147 static void avr_cpu_initfn(Object *obj)
148 {
149     AVRCPU *cpu = AVR_CPU(obj);
150 
151     /* Set the number of interrupts supported by the CPU. */
152     qdev_init_gpio_in(DEVICE(cpu), avr_cpu_set_int,
153                       sizeof(cpu->env.intsrc) * 8);
154 }
155 
156 static Property avr_cpu_properties[] = {
157     DEFINE_PROP_UINT32("init-sp", AVRCPU, init_sp, 0),
158     DEFINE_PROP_END_OF_LIST()
159 };
160 
161 static ObjectClass *avr_cpu_class_by_name(const char *cpu_model)
162 {
163     ObjectClass *oc;
164 
165     oc = object_class_by_name(cpu_model);
166     if (object_class_dynamic_cast(oc, TYPE_AVR_CPU) == NULL) {
167         oc = NULL;
168     }
169     return oc;
170 }
171 
172 static void avr_cpu_dump_state(CPUState *cs, FILE *f, int flags)
173 {
174     AVRCPU *cpu = AVR_CPU(cs);
175     CPUAVRState *env = &cpu->env;
176     int i;
177 
178     qemu_fprintf(f, "\n");
179     qemu_fprintf(f, "PC:    %06x\n", env->pc_w * 2); /* PC points to words */
180     qemu_fprintf(f, "SP:      %04x\n", env->sp);
181     qemu_fprintf(f, "rampD:     %02x\n", env->rampD >> 16);
182     qemu_fprintf(f, "rampX:     %02x\n", env->rampX >> 16);
183     qemu_fprintf(f, "rampY:     %02x\n", env->rampY >> 16);
184     qemu_fprintf(f, "rampZ:     %02x\n", env->rampZ >> 16);
185     qemu_fprintf(f, "EIND:      %02x\n", env->eind >> 16);
186     qemu_fprintf(f, "X:       %02x%02x\n", env->r[27], env->r[26]);
187     qemu_fprintf(f, "Y:       %02x%02x\n", env->r[29], env->r[28]);
188     qemu_fprintf(f, "Z:       %02x%02x\n", env->r[31], env->r[30]);
189     qemu_fprintf(f, "SREG:    [ %c %c %c %c %c %c %c %c ]\n",
190                  env->sregI ? 'I' : '-',
191                  env->sregT ? 'T' : '-',
192                  env->sregH ? 'H' : '-',
193                  env->sregS ? 'S' : '-',
194                  env->sregV ? 'V' : '-',
195                  env->sregN ? '-' : 'N', /* Zf has negative logic */
196                  env->sregZ ? 'Z' : '-',
197                  env->sregC ? 'I' : '-');
198     qemu_fprintf(f, "SKIP:    %02x\n", env->skip);
199 
200     qemu_fprintf(f, "\n");
201     for (i = 0; i < ARRAY_SIZE(env->r); i++) {
202         qemu_fprintf(f, "R[%02d]:  %02x   ", i, env->r[i]);
203 
204         if ((i % 8) == 7) {
205             qemu_fprintf(f, "\n");
206         }
207     }
208     qemu_fprintf(f, "\n");
209 }
210 
211 #include "hw/core/sysemu-cpu-ops.h"
212 
213 static const struct SysemuCPUOps avr_sysemu_ops = {
214     .get_phys_page_debug = avr_cpu_get_phys_page_debug,
215 };
216 
217 #include "hw/core/tcg-cpu-ops.h"
218 
219 static const struct TCGCPUOps avr_tcg_ops = {
220     .initialize = avr_cpu_tcg_init,
221     .synchronize_from_tb = avr_cpu_synchronize_from_tb,
222     .restore_state_to_opc = avr_restore_state_to_opc,
223     .cpu_exec_interrupt = avr_cpu_exec_interrupt,
224     .tlb_fill = avr_cpu_tlb_fill,
225     .do_interrupt = avr_cpu_do_interrupt,
226 };
227 
228 static void avr_cpu_class_init(ObjectClass *oc, void *data)
229 {
230     DeviceClass *dc = DEVICE_CLASS(oc);
231     CPUClass *cc = CPU_CLASS(oc);
232     AVRCPUClass *mcc = AVR_CPU_CLASS(oc);
233     ResettableClass *rc = RESETTABLE_CLASS(oc);
234 
235     device_class_set_parent_realize(dc, avr_cpu_realizefn, &mcc->parent_realize);
236 
237     device_class_set_props(dc, avr_cpu_properties);
238 
239     resettable_class_set_parent_phases(rc, NULL, avr_cpu_reset_hold, NULL,
240                                        &mcc->parent_phases);
241 
242     cc->class_by_name = avr_cpu_class_by_name;
243 
244     cc->has_work = avr_cpu_has_work;
245     cc->dump_state = avr_cpu_dump_state;
246     cc->set_pc = avr_cpu_set_pc;
247     cc->get_pc = avr_cpu_get_pc;
248     dc->vmsd = &vms_avr_cpu;
249     cc->sysemu_ops = &avr_sysemu_ops;
250     cc->disas_set_info = avr_cpu_disas_set_info;
251     cc->gdb_read_register = avr_cpu_gdb_read_register;
252     cc->gdb_write_register = avr_cpu_gdb_write_register;
253     cc->gdb_adjust_breakpoint = avr_cpu_gdb_adjust_breakpoint;
254     cc->gdb_num_core_regs = 35;
255     cc->gdb_core_xml_file = "avr-cpu.xml";
256     cc->tcg_ops = &avr_tcg_ops;
257 }
258 
259 /*
260  * Setting features of AVR core type avr5
261  * --------------------------------------
262  *
263  * This type of AVR core is present in the following AVR MCUs:
264  *
265  * ata5702m322, ata5782, ata5790, ata5790n, ata5791, ata5795, ata5831, ata6613c,
266  * ata6614q, ata8210, ata8510, atmega16, atmega16a, atmega161, atmega162,
267  * atmega163, atmega164a, atmega164p, atmega164pa, atmega165, atmega165a,
268  * atmega165p, atmega165pa, atmega168, atmega168a, atmega168p, atmega168pa,
269  * atmega168pb, atmega169, atmega169a, atmega169p, atmega169pa, atmega16hvb,
270  * atmega16hvbrevb, atmega16m1, atmega16u4, atmega32a, atmega32, atmega323,
271  * atmega324a, atmega324p, atmega324pa, atmega325, atmega325a, atmega325p,
272  * atmega325pa, atmega3250, atmega3250a, atmega3250p, atmega3250pa, atmega328,
273  * atmega328p, atmega328pb, atmega329, atmega329a, atmega329p, atmega329pa,
274  * atmega3290, atmega3290a, atmega3290p, atmega3290pa, atmega32c1, atmega32m1,
275  * atmega32u4, atmega32u6, atmega406, atmega64, atmega64a, atmega640, atmega644,
276  * atmega644a, atmega644p, atmega644pa, atmega645, atmega645a, atmega645p,
277  * atmega6450, atmega6450a, atmega6450p, atmega649, atmega649a, atmega649p,
278  * atmega6490, atmega16hva, atmega16hva2, atmega32hvb, atmega6490a, atmega6490p,
279  * atmega64c1, atmega64m1, atmega64hve, atmega64hve2, atmega64rfr2,
280  * atmega644rfr2, atmega32hvbrevb, at90can32, at90can64, at90pwm161, at90pwm216,
281  * at90pwm316, at90scr100, at90usb646, at90usb647, at94k, m3000
282  */
283 static void avr_avr5_initfn(Object *obj)
284 {
285     AVRCPU *cpu = AVR_CPU(obj);
286     CPUAVRState *env = &cpu->env;
287 
288     set_avr_feature(env, AVR_FEATURE_LPM);
289     set_avr_feature(env, AVR_FEATURE_IJMP_ICALL);
290     set_avr_feature(env, AVR_FEATURE_ADIW_SBIW);
291     set_avr_feature(env, AVR_FEATURE_SRAM);
292     set_avr_feature(env, AVR_FEATURE_BREAK);
293 
294     set_avr_feature(env, AVR_FEATURE_2_BYTE_PC);
295     set_avr_feature(env, AVR_FEATURE_2_BYTE_SP);
296     set_avr_feature(env, AVR_FEATURE_JMP_CALL);
297     set_avr_feature(env, AVR_FEATURE_LPMX);
298     set_avr_feature(env, AVR_FEATURE_MOVW);
299     set_avr_feature(env, AVR_FEATURE_MUL);
300 }
301 
302 /*
303  * Setting features of AVR core type avr51
304  * --------------------------------------
305  *
306  * This type of AVR core is present in the following AVR MCUs:
307  *
308  * atmega128, atmega128a, atmega1280, atmega1281, atmega1284, atmega1284p,
309  * atmega128rfa1, atmega128rfr2, atmega1284rfr2, at90can128, at90usb1286,
310  * at90usb1287
311  */
312 static void avr_avr51_initfn(Object *obj)
313 {
314     AVRCPU *cpu = AVR_CPU(obj);
315     CPUAVRState *env = &cpu->env;
316 
317     set_avr_feature(env, AVR_FEATURE_LPM);
318     set_avr_feature(env, AVR_FEATURE_IJMP_ICALL);
319     set_avr_feature(env, AVR_FEATURE_ADIW_SBIW);
320     set_avr_feature(env, AVR_FEATURE_SRAM);
321     set_avr_feature(env, AVR_FEATURE_BREAK);
322 
323     set_avr_feature(env, AVR_FEATURE_2_BYTE_PC);
324     set_avr_feature(env, AVR_FEATURE_2_BYTE_SP);
325     set_avr_feature(env, AVR_FEATURE_RAMPZ);
326     set_avr_feature(env, AVR_FEATURE_ELPMX);
327     set_avr_feature(env, AVR_FEATURE_ELPM);
328     set_avr_feature(env, AVR_FEATURE_JMP_CALL);
329     set_avr_feature(env, AVR_FEATURE_LPMX);
330     set_avr_feature(env, AVR_FEATURE_MOVW);
331     set_avr_feature(env, AVR_FEATURE_MUL);
332 }
333 
334 /*
335  * Setting features of AVR core type avr6
336  * --------------------------------------
337  *
338  * This type of AVR core is present in the following AVR MCUs:
339  *
340  * atmega2560, atmega2561, atmega256rfr2, atmega2564rfr2
341  */
342 static void avr_avr6_initfn(Object *obj)
343 {
344     AVRCPU *cpu = AVR_CPU(obj);
345     CPUAVRState *env = &cpu->env;
346 
347     set_avr_feature(env, AVR_FEATURE_LPM);
348     set_avr_feature(env, AVR_FEATURE_IJMP_ICALL);
349     set_avr_feature(env, AVR_FEATURE_ADIW_SBIW);
350     set_avr_feature(env, AVR_FEATURE_SRAM);
351     set_avr_feature(env, AVR_FEATURE_BREAK);
352 
353     set_avr_feature(env, AVR_FEATURE_3_BYTE_PC);
354     set_avr_feature(env, AVR_FEATURE_2_BYTE_SP);
355     set_avr_feature(env, AVR_FEATURE_RAMPZ);
356     set_avr_feature(env, AVR_FEATURE_EIJMP_EICALL);
357     set_avr_feature(env, AVR_FEATURE_ELPMX);
358     set_avr_feature(env, AVR_FEATURE_ELPM);
359     set_avr_feature(env, AVR_FEATURE_JMP_CALL);
360     set_avr_feature(env, AVR_FEATURE_LPMX);
361     set_avr_feature(env, AVR_FEATURE_MOVW);
362     set_avr_feature(env, AVR_FEATURE_MUL);
363 }
364 
365 typedef struct AVRCPUInfo {
366     const char *name;
367     void (*initfn)(Object *obj);
368 } AVRCPUInfo;
369 
370 
371 static void avr_cpu_list_entry(gpointer data, gpointer user_data)
372 {
373     const char *typename = object_class_get_name(OBJECT_CLASS(data));
374 
375     qemu_printf("%s\n", typename);
376 }
377 
378 void avr_cpu_list(void)
379 {
380     GSList *list;
381     list = object_class_get_list_sorted(TYPE_AVR_CPU, false);
382     g_slist_foreach(list, avr_cpu_list_entry, NULL);
383     g_slist_free(list);
384 }
385 
386 #define DEFINE_AVR_CPU_TYPE(model, initfn) \
387     { \
388         .parent = TYPE_AVR_CPU, \
389         .instance_init = initfn, \
390         .name = AVR_CPU_TYPE_NAME(model), \
391     }
392 
393 static const TypeInfo avr_cpu_type_info[] = {
394     {
395         .name = TYPE_AVR_CPU,
396         .parent = TYPE_CPU,
397         .instance_size = sizeof(AVRCPU),
398         .instance_align = __alignof(AVRCPU),
399         .instance_init = avr_cpu_initfn,
400         .class_size = sizeof(AVRCPUClass),
401         .class_init = avr_cpu_class_init,
402         .abstract = true,
403     },
404     DEFINE_AVR_CPU_TYPE("avr5", avr_avr5_initfn),
405     DEFINE_AVR_CPU_TYPE("avr51", avr_avr51_initfn),
406     DEFINE_AVR_CPU_TYPE("avr6", avr_avr6_initfn),
407 };
408 
409 DEFINE_TYPES(avr_cpu_type_info)
410