xref: /openbmc/qemu/hw/display/cg3.c (revision 500eb6db)
1 /*
2  * QEMU CG3 Frame buffer
3  *
4  * Copyright (c) 2012 Bob Breuer
5  * Copyright (c) 2013 Mark Cave-Ayland
6  *
7  * Permission is hereby granted, free of charge, to any person obtaining a copy
8  * of this software and associated documentation files (the "Software"), to deal
9  * in the Software without restriction, including without limitation the rights
10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11  * copies of the Software, and to permit persons to whom the Software is
12  * furnished to do so, subject to the following conditions:
13  *
14  * The above copyright notice and this permission notice shall be included in
15  * all copies or substantial portions of the Software.
16  *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23  * THE SOFTWARE.
24  */
25 
26 #include "qemu/osdep.h"
27 #include "qemu-common.h"
28 #include "qapi/error.h"
29 #include "qemu/error-report.h"
30 #include "ui/console.h"
31 #include "hw/sysbus.h"
32 #include "hw/loader.h"
33 #include "qemu/log.h"
34 #include "qemu/module.h"
35 
36 /* Change to 1 to enable debugging */
37 #define DEBUG_CG3 0
38 
39 #define CG3_ROM_FILE  "QEMU,cgthree.bin"
40 #define FCODE_MAX_ROM_SIZE 0x10000
41 
42 #define CG3_REG_SIZE            0x20
43 
44 #define CG3_REG_BT458_ADDR      0x0
45 #define CG3_REG_BT458_COLMAP    0x4
46 #define CG3_REG_FBC_CTRL        0x10
47 #define CG3_REG_FBC_STATUS      0x11
48 #define CG3_REG_FBC_CURSTART    0x12
49 #define CG3_REG_FBC_CUREND      0x13
50 #define CG3_REG_FBC_VCTRL       0x14
51 
52 /* Control register flags */
53 #define CG3_CR_ENABLE_INTS      0x80
54 
55 /* Status register flags */
56 #define CG3_SR_PENDING_INT      0x80
57 #define CG3_SR_1152_900_76_B    0x60
58 #define CG3_SR_ID_COLOR         0x01
59 
60 #define CG3_VRAM_SIZE 0x100000
61 #define CG3_VRAM_OFFSET 0x800000
62 
63 #define DPRINTF(fmt, ...) do { \
64     if (DEBUG_CG3) { \
65         printf("CG3: " fmt , ## __VA_ARGS__); \
66     } \
67 } while (0)
68 
69 #define TYPE_CG3 "cgthree"
70 #define CG3(obj) OBJECT_CHECK(CG3State, (obj), TYPE_CG3)
71 
72 typedef struct CG3State {
73     SysBusDevice parent_obj;
74 
75     QemuConsole *con;
76     qemu_irq irq;
77     hwaddr prom_addr;
78     MemoryRegion vram_mem;
79     MemoryRegion rom;
80     MemoryRegion reg;
81     uint32_t vram_size;
82     int full_update;
83     uint8_t regs[16];
84     uint8_t r[256], g[256], b[256];
85     uint16_t width, height, depth;
86     uint8_t dac_index, dac_state;
87 } CG3State;
88 
89 static void cg3_update_display(void *opaque)
90 {
91     CG3State *s = opaque;
92     DisplaySurface *surface = qemu_console_surface(s->con);
93     const uint8_t *pix;
94     uint32_t *data;
95     uint32_t dval;
96     int x, y, y_start;
97     unsigned int width, height;
98     ram_addr_t page;
99     DirtyBitmapSnapshot *snap = NULL;
100 
101     if (surface_bits_per_pixel(surface) != 32) {
102         return;
103     }
104     width = s->width;
105     height = s->height;
106 
107     y_start = -1;
108     pix = memory_region_get_ram_ptr(&s->vram_mem);
109     data = (uint32_t *)surface_data(surface);
110 
111     if (!s->full_update) {
112         snap = memory_region_snapshot_and_clear_dirty(&s->vram_mem, 0x0,
113                                               memory_region_size(&s->vram_mem),
114                                               DIRTY_MEMORY_VGA);
115     }
116 
117     for (y = 0; y < height; y++) {
118         int update;
119 
120         page = (ram_addr_t)y * width;
121 
122         if (s->full_update) {
123             update = 1;
124         } else {
125             update = memory_region_snapshot_get_dirty(&s->vram_mem, snap, page,
126                                                       width);
127         }
128 
129         if (update) {
130             if (y_start < 0) {
131                 y_start = y;
132             }
133 
134             for (x = 0; x < width; x++) {
135                 dval = *pix++;
136                 dval = (s->r[dval] << 16) | (s->g[dval] << 8) | s->b[dval];
137                 *data++ = dval;
138             }
139         } else {
140             if (y_start >= 0) {
141                 dpy_gfx_update(s->con, 0, y_start, width, y - y_start);
142                 y_start = -1;
143             }
144             pix += width;
145             data += width;
146         }
147     }
148     s->full_update = 0;
149     if (y_start >= 0) {
150         dpy_gfx_update(s->con, 0, y_start, width, y - y_start);
151     }
152     /* vsync interrupt? */
153     if (s->regs[0] & CG3_CR_ENABLE_INTS) {
154         s->regs[1] |= CG3_SR_PENDING_INT;
155         qemu_irq_raise(s->irq);
156     }
157     g_free(snap);
158 }
159 
160 static void cg3_invalidate_display(void *opaque)
161 {
162     CG3State *s = opaque;
163 
164     memory_region_set_dirty(&s->vram_mem, 0, CG3_VRAM_SIZE);
165 }
166 
167 static uint64_t cg3_reg_read(void *opaque, hwaddr addr, unsigned size)
168 {
169     CG3State *s = opaque;
170     int val;
171 
172     switch (addr) {
173     case CG3_REG_BT458_ADDR:
174     case CG3_REG_BT458_COLMAP:
175         val = 0;
176         break;
177     case CG3_REG_FBC_CTRL:
178         val = s->regs[0];
179         break;
180     case CG3_REG_FBC_STATUS:
181         /* monitor ID 6, board type = 1 (color) */
182         val = s->regs[1] | CG3_SR_1152_900_76_B | CG3_SR_ID_COLOR;
183         break;
184     case CG3_REG_FBC_CURSTART ... CG3_REG_SIZE - 1:
185         val = s->regs[addr - 0x10];
186         break;
187     default:
188         qemu_log_mask(LOG_UNIMP,
189                   "cg3: Unimplemented register read "
190                   "reg 0x%" HWADDR_PRIx " size 0x%x\n",
191                   addr, size);
192         val = 0;
193         break;
194     }
195     DPRINTF("read %02x from reg %" HWADDR_PRIx "\n", val, addr);
196     return val;
197 }
198 
199 static void cg3_reg_write(void *opaque, hwaddr addr, uint64_t val,
200                           unsigned size)
201 {
202     CG3State *s = opaque;
203     uint8_t regval;
204     int i;
205 
206     DPRINTF("write %" PRIx64 " to reg %" HWADDR_PRIx " size %d\n",
207             val, addr, size);
208 
209     switch (addr) {
210     case CG3_REG_BT458_ADDR:
211         s->dac_index = val;
212         s->dac_state = 0;
213         break;
214     case CG3_REG_BT458_COLMAP:
215         /* This register can be written to as either a long word or a byte */
216         if (size == 1) {
217             val <<= 24;
218         }
219 
220         for (i = 0; i < size; i++) {
221             regval = val >> 24;
222 
223             switch (s->dac_state) {
224             case 0:
225                 s->r[s->dac_index] = regval;
226                 s->dac_state++;
227                 break;
228             case 1:
229                 s->g[s->dac_index] = regval;
230                 s->dac_state++;
231                 break;
232             case 2:
233                 s->b[s->dac_index] = regval;
234                 /* Index autoincrement */
235                 s->dac_index = (s->dac_index + 1) & 0xff;
236                 /* fall through */
237             default:
238                 s->dac_state = 0;
239                 break;
240             }
241             val <<= 8;
242         }
243         s->full_update = 1;
244         break;
245     case CG3_REG_FBC_CTRL:
246         s->regs[0] = val;
247         break;
248     case CG3_REG_FBC_STATUS:
249         if (s->regs[1] & CG3_SR_PENDING_INT) {
250             /* clear interrupt */
251             s->regs[1] &= ~CG3_SR_PENDING_INT;
252             qemu_irq_lower(s->irq);
253         }
254         break;
255     case CG3_REG_FBC_CURSTART ... CG3_REG_SIZE - 1:
256         s->regs[addr - 0x10] = val;
257         break;
258     default:
259         qemu_log_mask(LOG_UNIMP,
260                   "cg3: Unimplemented register write "
261                   "reg 0x%" HWADDR_PRIx " size 0x%x value 0x%" PRIx64 "\n",
262                   addr, size, val);
263         break;
264     }
265 }
266 
267 static const MemoryRegionOps cg3_reg_ops = {
268     .read = cg3_reg_read,
269     .write = cg3_reg_write,
270     .endianness = DEVICE_NATIVE_ENDIAN,
271     .valid = {
272         .min_access_size = 1,
273         .max_access_size = 4,
274     },
275 };
276 
277 static const GraphicHwOps cg3_ops = {
278     .invalidate = cg3_invalidate_display,
279     .gfx_update = cg3_update_display,
280 };
281 
282 static void cg3_initfn(Object *obj)
283 {
284     SysBusDevice *sbd = SYS_BUS_DEVICE(obj);
285     CG3State *s = CG3(obj);
286 
287     memory_region_init_ram_nomigrate(&s->rom, obj, "cg3.prom", FCODE_MAX_ROM_SIZE,
288                            &error_fatal);
289     memory_region_set_readonly(&s->rom, true);
290     sysbus_init_mmio(sbd, &s->rom);
291 
292     memory_region_init_io(&s->reg, obj, &cg3_reg_ops, s, "cg3.reg",
293                           CG3_REG_SIZE);
294     sysbus_init_mmio(sbd, &s->reg);
295 }
296 
297 static void cg3_realizefn(DeviceState *dev, Error **errp)
298 {
299     SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
300     CG3State *s = CG3(dev);
301     int ret;
302     char *fcode_filename;
303 
304     /* FCode ROM */
305     vmstate_register_ram_global(&s->rom);
306     fcode_filename = qemu_find_file(QEMU_FILE_TYPE_BIOS, CG3_ROM_FILE);
307     if (fcode_filename) {
308         ret = load_image_mr(fcode_filename, &s->rom);
309         g_free(fcode_filename);
310         if (ret < 0 || ret > FCODE_MAX_ROM_SIZE) {
311             warn_report("cg3: could not load prom '%s'", CG3_ROM_FILE);
312         }
313     }
314 
315     memory_region_init_ram(&s->vram_mem, NULL, "cg3.vram", s->vram_size,
316                            &error_fatal);
317     memory_region_set_log(&s->vram_mem, true, DIRTY_MEMORY_VGA);
318     sysbus_init_mmio(sbd, &s->vram_mem);
319 
320     sysbus_init_irq(sbd, &s->irq);
321 
322     s->con = graphic_console_init(DEVICE(dev), 0, &cg3_ops, s);
323     qemu_console_resize(s->con, s->width, s->height);
324 }
325 
326 static int vmstate_cg3_post_load(void *opaque, int version_id)
327 {
328     CG3State *s = opaque;
329 
330     cg3_invalidate_display(s);
331 
332     return 0;
333 }
334 
335 static const VMStateDescription vmstate_cg3 = {
336     .name = "cg3",
337     .version_id = 1,
338     .minimum_version_id = 1,
339     .post_load = vmstate_cg3_post_load,
340     .fields = (VMStateField[]) {
341         VMSTATE_UINT16(height, CG3State),
342         VMSTATE_UINT16(width, CG3State),
343         VMSTATE_UINT16(depth, CG3State),
344         VMSTATE_BUFFER(r, CG3State),
345         VMSTATE_BUFFER(g, CG3State),
346         VMSTATE_BUFFER(b, CG3State),
347         VMSTATE_UINT8(dac_index, CG3State),
348         VMSTATE_UINT8(dac_state, CG3State),
349         VMSTATE_END_OF_LIST()
350     }
351 };
352 
353 static void cg3_reset(DeviceState *d)
354 {
355     CG3State *s = CG3(d);
356 
357     /* Initialize palette */
358     memset(s->r, 0, 256);
359     memset(s->g, 0, 256);
360     memset(s->b, 0, 256);
361 
362     s->dac_state = 0;
363     s->full_update = 1;
364     qemu_irq_lower(s->irq);
365 }
366 
367 static Property cg3_properties[] = {
368     DEFINE_PROP_UINT32("vram-size",    CG3State, vram_size, -1),
369     DEFINE_PROP_UINT16("width",        CG3State, width,     -1),
370     DEFINE_PROP_UINT16("height",       CG3State, height,    -1),
371     DEFINE_PROP_UINT16("depth",        CG3State, depth,     -1),
372     DEFINE_PROP_END_OF_LIST(),
373 };
374 
375 static void cg3_class_init(ObjectClass *klass, void *data)
376 {
377     DeviceClass *dc = DEVICE_CLASS(klass);
378 
379     dc->realize = cg3_realizefn;
380     dc->reset = cg3_reset;
381     dc->vmsd = &vmstate_cg3;
382     dc->props = cg3_properties;
383 }
384 
385 static const TypeInfo cg3_info = {
386     .name          = TYPE_CG3,
387     .parent        = TYPE_SYS_BUS_DEVICE,
388     .instance_size = sizeof(CG3State),
389     .instance_init = cg3_initfn,
390     .class_init    = cg3_class_init,
391 };
392 
393 static void cg3_register_types(void)
394 {
395     type_register_static(&cg3_info);
396 }
397 
398 type_init(cg3_register_types)
399