xref: /qemu/hw/ssi/pl022.c (revision 275ff67f40b60592d5c4e709ead1fe3e41b2ece5)
1 /*
2  * Arm PrimeCell PL022 Synchronous Serial Port
3  *
4  * Copyright (c) 2007 CodeSourcery.
5  * Written by Paul Brook
6  *
7  * This code is licensed under the GPL.
8  */
9 
10 #include "qemu/osdep.h"
11 #include "hw/sysbus.h"
12 #include "hw/ssi/pl022.h"
13 #include "hw/ssi/ssi.h"
14 #include "qemu/log.h"
15 
16 //#define DEBUG_PL022 1
17 
18 #ifdef DEBUG_PL022
19 #define DPRINTF(fmt, ...) \
20 do { printf("pl022: " fmt , ## __VA_ARGS__); } while (0)
21 #define BADF(fmt, ...) \
22 do { fprintf(stderr, "pl022: error: " fmt , ## __VA_ARGS__); exit(1);} while (0)
23 #else
24 #define DPRINTF(fmt, ...) do {} while(0)
25 #define BADF(fmt, ...) \
26 do { fprintf(stderr, "pl022: error: " fmt , ## __VA_ARGS__);} while (0)
27 #endif
28 
29 #define PL022_CR1_LBM 0x01
30 #define PL022_CR1_SSE 0x02
31 #define PL022_CR1_MS  0x04
32 #define PL022_CR1_SDO 0x08
33 
34 #define PL022_SR_TFE  0x01
35 #define PL022_SR_TNF  0x02
36 #define PL022_SR_RNE  0x04
37 #define PL022_SR_RFF  0x08
38 #define PL022_SR_BSY  0x10
39 
40 #define PL022_INT_ROR 0x01
41 #define PL022_INT_RT  0x04
42 #define PL022_INT_RX  0x04
43 #define PL022_INT_TX  0x08
44 
45 static const unsigned char pl022_id[8] =
46   { 0x22, 0x10, 0x04, 0x00, 0x0d, 0xf0, 0x05, 0xb1 };
47 
48 static void pl022_update(PL022State *s)
49 {
50     s->sr = 0;
51     if (s->tx_fifo_len == 0)
52         s->sr |= PL022_SR_TFE;
53     if (s->tx_fifo_len != 8)
54         s->sr |= PL022_SR_TNF;
55     if (s->rx_fifo_len != 0)
56         s->sr |= PL022_SR_RNE;
57     if (s->rx_fifo_len == 8)
58         s->sr |= PL022_SR_RFF;
59     if (s->tx_fifo_len)
60         s->sr |= PL022_SR_BSY;
61     s->is = 0;
62     if (s->rx_fifo_len >= 4)
63         s->is |= PL022_INT_RX;
64     if (s->tx_fifo_len <= 4)
65         s->is |= PL022_INT_TX;
66 
67     qemu_set_irq(s->irq, (s->is & s->im) != 0);
68 }
69 
70 static void pl022_xfer(PL022State *s)
71 {
72     int i;
73     int o;
74     int val;
75 
76     if ((s->cr1 & PL022_CR1_SSE) == 0) {
77         pl022_update(s);
78         DPRINTF("Disabled\n");
79         return;
80     }
81 
82     DPRINTF("Maybe xfer %d/%d\n", s->tx_fifo_len, s->rx_fifo_len);
83     i = (s->tx_fifo_head - s->tx_fifo_len) & 7;
84     o = s->rx_fifo_head;
85     /* ??? We do not emulate the line speed.
86        This may break some applications.  The are two problematic cases:
87         (a) A driver feeds data into the TX FIFO until it is full,
88          and only then drains the RX FIFO.  On real hardware the CPU can
89          feed data fast enough that the RX fifo never gets chance to overflow.
90         (b) A driver transmits data, deliberately allowing the RX FIFO to
91          overflow because it ignores the RX data anyway.
92 
93        We choose to support (a) by stalling the transmit engine if it would
94        cause the RX FIFO to overflow.  In practice much transmit-only code
95        falls into (a) because it flushes the RX FIFO to determine when
96        the transfer has completed.  */
97     while (s->tx_fifo_len && s->rx_fifo_len < 8) {
98         DPRINTF("xfer\n");
99         val = s->tx_fifo[i];
100         if (s->cr1 & PL022_CR1_LBM) {
101             /* Loopback mode.  */
102         } else {
103             val = ssi_transfer(s->ssi, val);
104         }
105         s->rx_fifo[o] = val & s->bitmask;
106         i = (i + 1) & 7;
107         o = (o + 1) & 7;
108         s->tx_fifo_len--;
109         s->rx_fifo_len++;
110     }
111     s->rx_fifo_head = o;
112     pl022_update(s);
113 }
114 
115 static uint64_t pl022_read(void *opaque, hwaddr offset,
116                            unsigned size)
117 {
118     PL022State *s = (PL022State *)opaque;
119     int val;
120 
121     if (offset >= 0xfe0 && offset < 0x1000) {
122         return pl022_id[(offset - 0xfe0) >> 2];
123     }
124     switch (offset) {
125     case 0x00: /* CR0 */
126       return s->cr0;
127     case 0x04: /* CR1 */
128       return s->cr1;
129     case 0x08: /* DR */
130         if (s->rx_fifo_len) {
131             val = s->rx_fifo[(s->rx_fifo_head - s->rx_fifo_len) & 7];
132             DPRINTF("RX %02x\n", val);
133             s->rx_fifo_len--;
134             pl022_xfer(s);
135         } else {
136             val = 0;
137         }
138         return val;
139     case 0x0c: /* SR */
140         return s->sr;
141     case 0x10: /* CPSR */
142         return s->cpsr;
143     case 0x14: /* IMSC */
144         return s->im;
145     case 0x18: /* RIS */
146         return s->is;
147     case 0x1c: /* MIS */
148         return s->im & s->is;
149     case 0x20: /* DMACR */
150         /* Not implemented.  */
151         return 0;
152     default:
153         qemu_log_mask(LOG_GUEST_ERROR,
154                       "pl022_read: Bad offset %x\n", (int)offset);
155         return 0;
156     }
157 }
158 
159 static void pl022_write(void *opaque, hwaddr offset,
160                         uint64_t value, unsigned size)
161 {
162     PL022State *s = (PL022State *)opaque;
163 
164     switch (offset) {
165     case 0x00: /* CR0 */
166         s->cr0 = value;
167         /* Clock rate and format are ignored.  */
168         s->bitmask = (1 << ((value & 15) + 1)) - 1;
169         break;
170     case 0x04: /* CR1 */
171         s->cr1 = value;
172         if ((s->cr1 & (PL022_CR1_MS | PL022_CR1_SSE))
173                    == (PL022_CR1_MS | PL022_CR1_SSE)) {
174             BADF("SPI slave mode not implemented\n");
175         }
176         pl022_xfer(s);
177         break;
178     case 0x08: /* DR */
179         if (s->tx_fifo_len < 8) {
180             DPRINTF("TX %02x\n", (unsigned)value);
181             s->tx_fifo[s->tx_fifo_head] = value & s->bitmask;
182             s->tx_fifo_head = (s->tx_fifo_head + 1) & 7;
183             s->tx_fifo_len++;
184             pl022_xfer(s);
185         }
186         break;
187     case 0x10: /* CPSR */
188         /* Prescaler.  Ignored.  */
189         s->cpsr = value & 0xff;
190         break;
191     case 0x14: /* IMSC */
192         s->im = value;
193         pl022_update(s);
194         break;
195     case 0x20: /* DMACR */
196         if (value) {
197             qemu_log_mask(LOG_UNIMP, "pl022: DMA not implemented\n");
198         }
199         break;
200     default:
201         qemu_log_mask(LOG_GUEST_ERROR,
202                       "pl022_write: Bad offset %x\n", (int)offset);
203     }
204 }
205 
206 static void pl022_reset(DeviceState *dev)
207 {
208     PL022State *s = PL022(dev);
209 
210     s->rx_fifo_len = 0;
211     s->tx_fifo_len = 0;
212     s->im = 0;
213     s->is = PL022_INT_TX;
214     s->sr = PL022_SR_TFE | PL022_SR_TNF;
215 }
216 
217 static const MemoryRegionOps pl022_ops = {
218     .read = pl022_read,
219     .write = pl022_write,
220     .endianness = DEVICE_NATIVE_ENDIAN,
221 };
222 
223 static int pl022_post_load(void *opaque, int version_id)
224 {
225     PL022State *s = opaque;
226 
227     if (s->tx_fifo_head < 0 ||
228         s->tx_fifo_head >= ARRAY_SIZE(s->tx_fifo) ||
229         s->rx_fifo_head < 0 ||
230         s->rx_fifo_head >= ARRAY_SIZE(s->rx_fifo)) {
231         return -1;
232     }
233     return 0;
234 }
235 
236 static const VMStateDescription vmstate_pl022 = {
237     .name = "pl022_ssp",
238     .version_id = 1,
239     .minimum_version_id = 1,
240     .post_load = pl022_post_load,
241     .fields = (VMStateField[]) {
242         VMSTATE_UINT32(cr0, PL022State),
243         VMSTATE_UINT32(cr1, PL022State),
244         VMSTATE_UINT32(bitmask, PL022State),
245         VMSTATE_UINT32(sr, PL022State),
246         VMSTATE_UINT32(cpsr, PL022State),
247         VMSTATE_UINT32(is, PL022State),
248         VMSTATE_UINT32(im, PL022State),
249         VMSTATE_INT32(tx_fifo_head, PL022State),
250         VMSTATE_INT32(rx_fifo_head, PL022State),
251         VMSTATE_INT32(tx_fifo_len, PL022State),
252         VMSTATE_INT32(rx_fifo_len, PL022State),
253         VMSTATE_UINT16(tx_fifo[0], PL022State),
254         VMSTATE_UINT16(rx_fifo[0], PL022State),
255         VMSTATE_UINT16(tx_fifo[1], PL022State),
256         VMSTATE_UINT16(rx_fifo[1], PL022State),
257         VMSTATE_UINT16(tx_fifo[2], PL022State),
258         VMSTATE_UINT16(rx_fifo[2], PL022State),
259         VMSTATE_UINT16(tx_fifo[3], PL022State),
260         VMSTATE_UINT16(rx_fifo[3], PL022State),
261         VMSTATE_UINT16(tx_fifo[4], PL022State),
262         VMSTATE_UINT16(rx_fifo[4], PL022State),
263         VMSTATE_UINT16(tx_fifo[5], PL022State),
264         VMSTATE_UINT16(rx_fifo[5], PL022State),
265         VMSTATE_UINT16(tx_fifo[6], PL022State),
266         VMSTATE_UINT16(rx_fifo[6], PL022State),
267         VMSTATE_UINT16(tx_fifo[7], PL022State),
268         VMSTATE_UINT16(rx_fifo[7], PL022State),
269         VMSTATE_END_OF_LIST()
270     }
271 };
272 
273 static int pl022_init(SysBusDevice *sbd)
274 {
275     DeviceState *dev = DEVICE(sbd);
276     PL022State *s = PL022(dev);
277 
278     memory_region_init_io(&s->iomem, OBJECT(s), &pl022_ops, s, "pl022", 0x1000);
279     sysbus_init_mmio(sbd, &s->iomem);
280     sysbus_init_irq(sbd, &s->irq);
281     s->ssi = ssi_create_bus(dev, "ssi");
282     return 0;
283 }
284 
285 static void pl022_class_init(ObjectClass *klass, void *data)
286 {
287     SysBusDeviceClass *sdc = SYS_BUS_DEVICE_CLASS(klass);
288     DeviceClass *dc = DEVICE_CLASS(klass);
289 
290     sdc->init = pl022_init;
291     dc->reset = pl022_reset;
292     dc->vmsd = &vmstate_pl022;
293 }
294 
295 static const TypeInfo pl022_info = {
296     .name          = TYPE_PL022,
297     .parent        = TYPE_SYS_BUS_DEVICE,
298     .instance_size = sizeof(PL022State),
299     .class_init    = pl022_class_init,
300 };
301 
302 static void pl022_register_types(void)
303 {
304     type_register_static(&pl022_info);
305 }
306 
307 type_init(pl022_register_types)
308