xref: /openbmc/qemu/hw/char/digic-uart.c (revision 99672c71)
1 /*
2  * QEMU model of the Canon DIGIC UART block.
3  *
4  * Copyright (C) 2013 Antony Pavlov <antonynpavlov@gmail.com>
5  *
6  * This model is based on reverse engineering efforts
7  * made by CHDK (http://chdk.wikia.com) and
8  * Magic Lantern (http://www.magiclantern.fm) projects
9  * contributors.
10  *
11  * See "Serial terminal" docs here:
12  *   http://magiclantern.wikia.com/wiki/Register_Map#Misc_Registers
13  *
14  * The QEMU model of the Milkymist UART block by Michael Walle
15  * is used as a template.
16  *
17  * This program is free software; you can redistribute it and/or modify
18  * it under the terms of the GNU General Public License as published by
19  * the Free Software Foundation; either version 2 of the License, or
20  * (at your option) any later version.
21  *
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25  * GNU General Public License for more details.
26  *
27  */
28 
29 #include "qemu/osdep.h"
30 #include "hw/hw.h"
31 #include "hw/sysbus.h"
32 #include "sysemu/char.h"
33 #include "qemu/log.h"
34 
35 #include "hw/char/digic-uart.h"
36 
37 enum {
38     ST_RX_RDY = (1 << 0),
39     ST_TX_RDY = (1 << 1),
40 };
41 
42 static uint64_t digic_uart_read(void *opaque, hwaddr addr,
43                                 unsigned size)
44 {
45     DigicUartState *s = opaque;
46     uint64_t ret = 0;
47 
48     addr >>= 2;
49 
50     switch (addr) {
51     case R_RX:
52         s->reg_st &= ~(ST_RX_RDY);
53         ret = s->reg_rx;
54         break;
55 
56     case R_ST:
57         ret = s->reg_st;
58         break;
59 
60     default:
61         qemu_log_mask(LOG_UNIMP,
62                       "digic-uart: read access to unknown register 0x"
63                       TARGET_FMT_plx, addr << 2);
64     }
65 
66     return ret;
67 }
68 
69 static void digic_uart_write(void *opaque, hwaddr addr, uint64_t value,
70                              unsigned size)
71 {
72     DigicUartState *s = opaque;
73     unsigned char ch = value;
74 
75     addr >>= 2;
76 
77     switch (addr) {
78     case R_TX:
79         if (s->chr) {
80             /* XXX this blocks entire thread. Rewrite to use
81              * qemu_chr_fe_write and background I/O callbacks */
82             qemu_chr_fe_write_all(s->chr, &ch, 1);
83         }
84         break;
85 
86     case R_ST:
87         /*
88          * Ignore write to R_ST.
89          *
90          * The point is that this register is actively used
91          * during receiving and transmitting symbols,
92          * but we don't know the function of most of bits.
93          *
94          * Ignoring writes to R_ST is only a simplification
95          * of the model. It has no perceptible side effects
96          * for existing guests.
97          */
98         break;
99 
100     default:
101         qemu_log_mask(LOG_UNIMP,
102                       "digic-uart: write access to unknown register 0x"
103                       TARGET_FMT_plx, addr << 2);
104     }
105 }
106 
107 static const MemoryRegionOps uart_mmio_ops = {
108     .read = digic_uart_read,
109     .write = digic_uart_write,
110     .valid = {
111         .min_access_size = 4,
112         .max_access_size = 4,
113     },
114     .endianness = DEVICE_NATIVE_ENDIAN,
115 };
116 
117 static int uart_can_rx(void *opaque)
118 {
119     DigicUartState *s = opaque;
120 
121     return !(s->reg_st & ST_RX_RDY);
122 }
123 
124 static void uart_rx(void *opaque, const uint8_t *buf, int size)
125 {
126     DigicUartState *s = opaque;
127 
128     assert(uart_can_rx(opaque));
129 
130     s->reg_st |= ST_RX_RDY;
131     s->reg_rx = *buf;
132 }
133 
134 static void uart_event(void *opaque, int event)
135 {
136 }
137 
138 static void digic_uart_reset(DeviceState *d)
139 {
140     DigicUartState *s = DIGIC_UART(d);
141 
142     s->reg_rx = 0;
143     s->reg_st = ST_TX_RDY;
144 }
145 
146 static void digic_uart_realize(DeviceState *dev, Error **errp)
147 {
148     DigicUartState *s = DIGIC_UART(dev);
149 
150     if (s->chr) {
151         qemu_chr_add_handlers(s->chr, uart_can_rx, uart_rx, uart_event, s);
152     }
153 }
154 
155 static void digic_uart_init(Object *obj)
156 {
157     DigicUartState *s = DIGIC_UART(obj);
158 
159     memory_region_init_io(&s->regs_region, OBJECT(s), &uart_mmio_ops, s,
160                           TYPE_DIGIC_UART, 0x18);
161     sysbus_init_mmio(SYS_BUS_DEVICE(obj), &s->regs_region);
162 }
163 
164 static const VMStateDescription vmstate_digic_uart = {
165     .name = "digic-uart",
166     .version_id = 1,
167     .minimum_version_id = 1,
168     .fields = (VMStateField[]) {
169         VMSTATE_UINT32(reg_rx, DigicUartState),
170         VMSTATE_UINT32(reg_st, DigicUartState),
171         VMSTATE_END_OF_LIST()
172     }
173 };
174 
175 static Property digic_uart_properties[] = {
176     DEFINE_PROP_CHR("chardev", DigicUartState, chr),
177     DEFINE_PROP_END_OF_LIST(),
178 };
179 
180 static void digic_uart_class_init(ObjectClass *klass, void *data)
181 {
182     DeviceClass *dc = DEVICE_CLASS(klass);
183 
184     dc->realize = digic_uart_realize;
185     dc->reset = digic_uart_reset;
186     dc->vmsd = &vmstate_digic_uart;
187     dc->props = digic_uart_properties;
188 }
189 
190 static const TypeInfo digic_uart_info = {
191     .name = TYPE_DIGIC_UART,
192     .parent = TYPE_SYS_BUS_DEVICE,
193     .instance_size = sizeof(DigicUartState),
194     .instance_init = digic_uart_init,
195     .class_init = digic_uart_class_init,
196 };
197 
198 static void digic_uart_register_types(void)
199 {
200     type_register_static(&digic_uart_info);
201 }
202 
203 type_init(digic_uart_register_types)
204