xref: /openbmc/qemu/hw/display/sm501.c (revision 4fe6d78b)
1 /*
2  * QEMU SM501 Device
3  *
4  * Copyright (c) 2008 Shin-ichiro KAWASAKI
5  * Copyright (c) 2016 BALATON Zoltan
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/cutils.h"
28 #include "qapi/error.h"
29 #include "qemu-common.h"
30 #include "cpu.h"
31 #include "hw/hw.h"
32 #include "hw/char/serial.h"
33 #include "ui/console.h"
34 #include "hw/devices.h"
35 #include "hw/sysbus.h"
36 #include "hw/pci/pci.h"
37 #include "qemu/range.h"
38 #include "ui/pixel_ops.h"
39 #include "exec/address-spaces.h"
40 
41 /*
42  * Status: 2010/05/07
43  *   - Minimum implementation for Linux console : mmio regs and CRT layer.
44  *   - 2D graphics acceleration partially supported : only fill rectangle.
45  *
46  * Status: 2016/12/04
47  *   - Misc fixes: endianness, hardware cursor
48  *   - Panel support
49  *
50  * TODO:
51  *   - Touch panel support
52  *   - USB support
53  *   - UART support
54  *   - More 2D graphics engine support
55  *   - Performance tuning
56  */
57 
58 /*#define DEBUG_SM501*/
59 /*#define DEBUG_BITBLT*/
60 
61 #ifdef DEBUG_SM501
62 #define SM501_DPRINTF(fmt, ...) printf(fmt, ## __VA_ARGS__)
63 #else
64 #define SM501_DPRINTF(fmt, ...) do {} while (0)
65 #endif
66 
67 #define MMIO_BASE_OFFSET 0x3e00000
68 #define MMIO_SIZE 0x200000
69 #define DC_PALETTE_ENTRIES (0x400 * 3)
70 
71 /* SM501 register definitions taken from "linux/include/linux/sm501-regs.h" */
72 
73 /* System Configuration area */
74 /* System config base */
75 #define SM501_SYS_CONFIG                (0x000000)
76 
77 /* config 1 */
78 #define SM501_SYSTEM_CONTROL            (0x000000)
79 
80 #define SM501_SYSCTRL_PANEL_TRISTATE    (1 << 0)
81 #define SM501_SYSCTRL_MEM_TRISTATE      (1 << 1)
82 #define SM501_SYSCTRL_CRT_TRISTATE      (1 << 2)
83 
84 #define SM501_SYSCTRL_PCI_SLAVE_BURST_MASK (3 << 4)
85 #define SM501_SYSCTRL_PCI_SLAVE_BURST_1 (0 << 4)
86 #define SM501_SYSCTRL_PCI_SLAVE_BURST_2 (1 << 4)
87 #define SM501_SYSCTRL_PCI_SLAVE_BURST_4 (2 << 4)
88 #define SM501_SYSCTRL_PCI_SLAVE_BURST_8 (3 << 4)
89 
90 #define SM501_SYSCTRL_PCI_CLOCK_RUN_EN  (1 << 6)
91 #define SM501_SYSCTRL_PCI_RETRY_DISABLE (1 << 7)
92 #define SM501_SYSCTRL_PCI_SUBSYS_LOCK   (1 << 11)
93 #define SM501_SYSCTRL_PCI_BURST_READ_EN (1 << 15)
94 
95 /* miscellaneous control */
96 
97 #define SM501_MISC_CONTROL              (0x000004)
98 
99 #define SM501_MISC_BUS_SH               (0x0)
100 #define SM501_MISC_BUS_PCI              (0x1)
101 #define SM501_MISC_BUS_XSCALE           (0x2)
102 #define SM501_MISC_BUS_NEC              (0x6)
103 #define SM501_MISC_BUS_MASK             (0x7)
104 
105 #define SM501_MISC_VR_62MB              (1 << 3)
106 #define SM501_MISC_CDR_RESET            (1 << 7)
107 #define SM501_MISC_USB_LB               (1 << 8)
108 #define SM501_MISC_USB_SLAVE            (1 << 9)
109 #define SM501_MISC_BL_1                 (1 << 10)
110 #define SM501_MISC_MC                   (1 << 11)
111 #define SM501_MISC_DAC_POWER            (1 << 12)
112 #define SM501_MISC_IRQ_INVERT           (1 << 16)
113 #define SM501_MISC_SH                   (1 << 17)
114 
115 #define SM501_MISC_HOLD_EMPTY           (0 << 18)
116 #define SM501_MISC_HOLD_8               (1 << 18)
117 #define SM501_MISC_HOLD_16              (2 << 18)
118 #define SM501_MISC_HOLD_24              (3 << 18)
119 #define SM501_MISC_HOLD_32              (4 << 18)
120 #define SM501_MISC_HOLD_MASK            (7 << 18)
121 
122 #define SM501_MISC_FREQ_12              (1 << 24)
123 #define SM501_MISC_PNL_24BIT            (1 << 25)
124 #define SM501_MISC_8051_LE              (1 << 26)
125 
126 
127 
128 #define SM501_GPIO31_0_CONTROL          (0x000008)
129 #define SM501_GPIO63_32_CONTROL         (0x00000C)
130 #define SM501_DRAM_CONTROL              (0x000010)
131 
132 /* command list */
133 #define SM501_ARBTRTN_CONTROL           (0x000014)
134 
135 /* command list */
136 #define SM501_COMMAND_LIST_STATUS       (0x000024)
137 
138 /* interrupt debug */
139 #define SM501_RAW_IRQ_STATUS            (0x000028)
140 #define SM501_RAW_IRQ_CLEAR             (0x000028)
141 #define SM501_IRQ_STATUS                (0x00002C)
142 #define SM501_IRQ_MASK                  (0x000030)
143 #define SM501_DEBUG_CONTROL             (0x000034)
144 
145 /* power management */
146 #define SM501_POWERMODE_P2X_SRC         (1 << 29)
147 #define SM501_POWERMODE_V2X_SRC         (1 << 20)
148 #define SM501_POWERMODE_M_SRC           (1 << 12)
149 #define SM501_POWERMODE_M1_SRC          (1 << 4)
150 
151 #define SM501_CURRENT_GATE              (0x000038)
152 #define SM501_CURRENT_CLOCK             (0x00003C)
153 #define SM501_POWER_MODE_0_GATE         (0x000040)
154 #define SM501_POWER_MODE_0_CLOCK        (0x000044)
155 #define SM501_POWER_MODE_1_GATE         (0x000048)
156 #define SM501_POWER_MODE_1_CLOCK        (0x00004C)
157 #define SM501_SLEEP_MODE_GATE           (0x000050)
158 #define SM501_POWER_MODE_CONTROL        (0x000054)
159 
160 /* power gates for units within the 501 */
161 #define SM501_GATE_HOST                 (0)
162 #define SM501_GATE_MEMORY               (1)
163 #define SM501_GATE_DISPLAY              (2)
164 #define SM501_GATE_2D_ENGINE            (3)
165 #define SM501_GATE_CSC                  (4)
166 #define SM501_GATE_ZVPORT               (5)
167 #define SM501_GATE_GPIO                 (6)
168 #define SM501_GATE_UART0                (7)
169 #define SM501_GATE_UART1                (8)
170 #define SM501_GATE_SSP                  (10)
171 #define SM501_GATE_USB_HOST             (11)
172 #define SM501_GATE_USB_GADGET           (12)
173 #define SM501_GATE_UCONTROLLER          (17)
174 #define SM501_GATE_AC97                 (18)
175 
176 /* panel clock */
177 #define SM501_CLOCK_P2XCLK              (24)
178 /* crt clock */
179 #define SM501_CLOCK_V2XCLK              (16)
180 /* main clock */
181 #define SM501_CLOCK_MCLK                (8)
182 /* SDRAM controller clock */
183 #define SM501_CLOCK_M1XCLK              (0)
184 
185 /* config 2 */
186 #define SM501_PCI_MASTER_BASE           (0x000058)
187 #define SM501_ENDIAN_CONTROL            (0x00005C)
188 #define SM501_DEVICEID                  (0x000060)
189 /* 0x050100A0 */
190 
191 #define SM501_DEVICEID_SM501            (0x05010000)
192 #define SM501_DEVICEID_IDMASK           (0xffff0000)
193 #define SM501_DEVICEID_REVMASK          (0x000000ff)
194 
195 #define SM501_PLLCLOCK_COUNT            (0x000064)
196 #define SM501_MISC_TIMING               (0x000068)
197 #define SM501_CURRENT_SDRAM_CLOCK       (0x00006C)
198 
199 #define SM501_PROGRAMMABLE_PLL_CONTROL  (0x000074)
200 
201 /* GPIO base */
202 #define SM501_GPIO                      (0x010000)
203 #define SM501_GPIO_DATA_LOW             (0x00)
204 #define SM501_GPIO_DATA_HIGH            (0x04)
205 #define SM501_GPIO_DDR_LOW              (0x08)
206 #define SM501_GPIO_DDR_HIGH             (0x0C)
207 #define SM501_GPIO_IRQ_SETUP            (0x10)
208 #define SM501_GPIO_IRQ_STATUS           (0x14)
209 #define SM501_GPIO_IRQ_RESET            (0x14)
210 
211 /* I2C controller base */
212 #define SM501_I2C                       (0x010040)
213 #define SM501_I2C_BYTE_COUNT            (0x00)
214 #define SM501_I2C_CONTROL               (0x01)
215 #define SM501_I2C_STATUS                (0x02)
216 #define SM501_I2C_RESET                 (0x02)
217 #define SM501_I2C_SLAVE_ADDRESS         (0x03)
218 #define SM501_I2C_DATA                  (0x04)
219 
220 /* SSP base */
221 #define SM501_SSP                       (0x020000)
222 
223 /* Uart 0 base */
224 #define SM501_UART0                     (0x030000)
225 
226 /* Uart 1 base */
227 #define SM501_UART1                     (0x030020)
228 
229 /* USB host port base */
230 #define SM501_USB_HOST                  (0x040000)
231 
232 /* USB slave/gadget base */
233 #define SM501_USB_GADGET                (0x060000)
234 
235 /* USB slave/gadget data port base */
236 #define SM501_USB_GADGET_DATA           (0x070000)
237 
238 /* Display controller/video engine base */
239 #define SM501_DC                        (0x080000)
240 
241 /* common defines for the SM501 address registers */
242 #define SM501_ADDR_FLIP                 (1 << 31)
243 #define SM501_ADDR_EXT                  (1 << 27)
244 #define SM501_ADDR_CS1                  (1 << 26)
245 #define SM501_ADDR_MASK                 (0x3f << 26)
246 
247 #define SM501_FIFO_MASK                 (0x3 << 16)
248 #define SM501_FIFO_1                    (0x0 << 16)
249 #define SM501_FIFO_3                    (0x1 << 16)
250 #define SM501_FIFO_7                    (0x2 << 16)
251 #define SM501_FIFO_11                   (0x3 << 16)
252 
253 /* common registers for panel and the crt */
254 #define SM501_OFF_DC_H_TOT              (0x000)
255 #define SM501_OFF_DC_V_TOT              (0x008)
256 #define SM501_OFF_DC_H_SYNC             (0x004)
257 #define SM501_OFF_DC_V_SYNC             (0x00C)
258 
259 #define SM501_DC_PANEL_CONTROL          (0x000)
260 
261 #define SM501_DC_PANEL_CONTROL_FPEN     (1 << 27)
262 #define SM501_DC_PANEL_CONTROL_BIAS     (1 << 26)
263 #define SM501_DC_PANEL_CONTROL_DATA     (1 << 25)
264 #define SM501_DC_PANEL_CONTROL_VDD      (1 << 24)
265 #define SM501_DC_PANEL_CONTROL_DP       (1 << 23)
266 
267 #define SM501_DC_PANEL_CONTROL_TFT_888  (0 << 21)
268 #define SM501_DC_PANEL_CONTROL_TFT_333  (1 << 21)
269 #define SM501_DC_PANEL_CONTROL_TFT_444  (2 << 21)
270 
271 #define SM501_DC_PANEL_CONTROL_DE       (1 << 20)
272 
273 #define SM501_DC_PANEL_CONTROL_LCD_TFT  (0 << 18)
274 #define SM501_DC_PANEL_CONTROL_LCD_STN8 (1 << 18)
275 #define SM501_DC_PANEL_CONTROL_LCD_STN12 (2 << 18)
276 
277 #define SM501_DC_PANEL_CONTROL_CP       (1 << 14)
278 #define SM501_DC_PANEL_CONTROL_VSP      (1 << 13)
279 #define SM501_DC_PANEL_CONTROL_HSP      (1 << 12)
280 #define SM501_DC_PANEL_CONTROL_CK       (1 << 9)
281 #define SM501_DC_PANEL_CONTROL_TE       (1 << 8)
282 #define SM501_DC_PANEL_CONTROL_VPD      (1 << 7)
283 #define SM501_DC_PANEL_CONTROL_VP       (1 << 6)
284 #define SM501_DC_PANEL_CONTROL_HPD      (1 << 5)
285 #define SM501_DC_PANEL_CONTROL_HP       (1 << 4)
286 #define SM501_DC_PANEL_CONTROL_GAMMA    (1 << 3)
287 #define SM501_DC_PANEL_CONTROL_EN       (1 << 2)
288 
289 #define SM501_DC_PANEL_CONTROL_8BPP     (0 << 0)
290 #define SM501_DC_PANEL_CONTROL_16BPP    (1 << 0)
291 #define SM501_DC_PANEL_CONTROL_32BPP    (2 << 0)
292 
293 
294 #define SM501_DC_PANEL_PANNING_CONTROL  (0x004)
295 #define SM501_DC_PANEL_COLOR_KEY        (0x008)
296 #define SM501_DC_PANEL_FB_ADDR          (0x00C)
297 #define SM501_DC_PANEL_FB_OFFSET        (0x010)
298 #define SM501_DC_PANEL_FB_WIDTH         (0x014)
299 #define SM501_DC_PANEL_FB_HEIGHT        (0x018)
300 #define SM501_DC_PANEL_TL_LOC           (0x01C)
301 #define SM501_DC_PANEL_BR_LOC           (0x020)
302 #define SM501_DC_PANEL_H_TOT            (0x024)
303 #define SM501_DC_PANEL_H_SYNC           (0x028)
304 #define SM501_DC_PANEL_V_TOT            (0x02C)
305 #define SM501_DC_PANEL_V_SYNC           (0x030)
306 #define SM501_DC_PANEL_CUR_LINE         (0x034)
307 
308 #define SM501_DC_VIDEO_CONTROL          (0x040)
309 #define SM501_DC_VIDEO_FB0_ADDR         (0x044)
310 #define SM501_DC_VIDEO_FB_WIDTH         (0x048)
311 #define SM501_DC_VIDEO_FB0_LAST_ADDR    (0x04C)
312 #define SM501_DC_VIDEO_TL_LOC           (0x050)
313 #define SM501_DC_VIDEO_BR_LOC           (0x054)
314 #define SM501_DC_VIDEO_SCALE            (0x058)
315 #define SM501_DC_VIDEO_INIT_SCALE       (0x05C)
316 #define SM501_DC_VIDEO_YUV_CONSTANTS    (0x060)
317 #define SM501_DC_VIDEO_FB1_ADDR         (0x064)
318 #define SM501_DC_VIDEO_FB1_LAST_ADDR    (0x068)
319 
320 #define SM501_DC_VIDEO_ALPHA_CONTROL    (0x080)
321 #define SM501_DC_VIDEO_ALPHA_FB_ADDR    (0x084)
322 #define SM501_DC_VIDEO_ALPHA_FB_OFFSET  (0x088)
323 #define SM501_DC_VIDEO_ALPHA_FB_LAST_ADDR (0x08C)
324 #define SM501_DC_VIDEO_ALPHA_TL_LOC     (0x090)
325 #define SM501_DC_VIDEO_ALPHA_BR_LOC     (0x094)
326 #define SM501_DC_VIDEO_ALPHA_SCALE      (0x098)
327 #define SM501_DC_VIDEO_ALPHA_INIT_SCALE (0x09C)
328 #define SM501_DC_VIDEO_ALPHA_CHROMA_KEY (0x0A0)
329 #define SM501_DC_VIDEO_ALPHA_COLOR_LOOKUP (0x0A4)
330 
331 #define SM501_DC_PANEL_HWC_BASE         (0x0F0)
332 #define SM501_DC_PANEL_HWC_ADDR         (0x0F0)
333 #define SM501_DC_PANEL_HWC_LOC          (0x0F4)
334 #define SM501_DC_PANEL_HWC_COLOR_1_2    (0x0F8)
335 #define SM501_DC_PANEL_HWC_COLOR_3      (0x0FC)
336 
337 #define SM501_HWC_EN                    (1 << 31)
338 
339 #define SM501_OFF_HWC_ADDR              (0x00)
340 #define SM501_OFF_HWC_LOC               (0x04)
341 #define SM501_OFF_HWC_COLOR_1_2         (0x08)
342 #define SM501_OFF_HWC_COLOR_3           (0x0C)
343 
344 #define SM501_DC_ALPHA_CONTROL          (0x100)
345 #define SM501_DC_ALPHA_FB_ADDR          (0x104)
346 #define SM501_DC_ALPHA_FB_OFFSET        (0x108)
347 #define SM501_DC_ALPHA_TL_LOC           (0x10C)
348 #define SM501_DC_ALPHA_BR_LOC           (0x110)
349 #define SM501_DC_ALPHA_CHROMA_KEY       (0x114)
350 #define SM501_DC_ALPHA_COLOR_LOOKUP     (0x118)
351 
352 #define SM501_DC_CRT_CONTROL            (0x200)
353 
354 #define SM501_DC_CRT_CONTROL_TVP        (1 << 15)
355 #define SM501_DC_CRT_CONTROL_CP         (1 << 14)
356 #define SM501_DC_CRT_CONTROL_VSP        (1 << 13)
357 #define SM501_DC_CRT_CONTROL_HSP        (1 << 12)
358 #define SM501_DC_CRT_CONTROL_VS         (1 << 11)
359 #define SM501_DC_CRT_CONTROL_BLANK      (1 << 10)
360 #define SM501_DC_CRT_CONTROL_SEL        (1 << 9)
361 #define SM501_DC_CRT_CONTROL_TE         (1 << 8)
362 #define SM501_DC_CRT_CONTROL_PIXEL_MASK (0xF << 4)
363 #define SM501_DC_CRT_CONTROL_GAMMA      (1 << 3)
364 #define SM501_DC_CRT_CONTROL_ENABLE     (1 << 2)
365 
366 #define SM501_DC_CRT_CONTROL_8BPP       (0 << 0)
367 #define SM501_DC_CRT_CONTROL_16BPP      (1 << 0)
368 #define SM501_DC_CRT_CONTROL_32BPP      (2 << 0)
369 
370 #define SM501_DC_CRT_FB_ADDR            (0x204)
371 #define SM501_DC_CRT_FB_OFFSET          (0x208)
372 #define SM501_DC_CRT_H_TOT              (0x20C)
373 #define SM501_DC_CRT_H_SYNC             (0x210)
374 #define SM501_DC_CRT_V_TOT              (0x214)
375 #define SM501_DC_CRT_V_SYNC             (0x218)
376 #define SM501_DC_CRT_SIGNATURE_ANALYZER (0x21C)
377 #define SM501_DC_CRT_CUR_LINE           (0x220)
378 #define SM501_DC_CRT_MONITOR_DETECT     (0x224)
379 
380 #define SM501_DC_CRT_HWC_BASE           (0x230)
381 #define SM501_DC_CRT_HWC_ADDR           (0x230)
382 #define SM501_DC_CRT_HWC_LOC            (0x234)
383 #define SM501_DC_CRT_HWC_COLOR_1_2      (0x238)
384 #define SM501_DC_CRT_HWC_COLOR_3        (0x23C)
385 
386 #define SM501_DC_PANEL_PALETTE          (0x400)
387 
388 #define SM501_DC_VIDEO_PALETTE          (0x800)
389 
390 #define SM501_DC_CRT_PALETTE            (0xC00)
391 
392 /* Zoom Video port base */
393 #define SM501_ZVPORT                    (0x090000)
394 
395 /* AC97/I2S base */
396 #define SM501_AC97                      (0x0A0000)
397 
398 /* 8051 micro controller base */
399 #define SM501_UCONTROLLER               (0x0B0000)
400 
401 /* 8051 micro controller SRAM base */
402 #define SM501_UCONTROLLER_SRAM          (0x0C0000)
403 
404 /* DMA base */
405 #define SM501_DMA                       (0x0D0000)
406 
407 /* 2d engine base */
408 #define SM501_2D_ENGINE                 (0x100000)
409 #define SM501_2D_SOURCE                 (0x00)
410 #define SM501_2D_DESTINATION            (0x04)
411 #define SM501_2D_DIMENSION              (0x08)
412 #define SM501_2D_CONTROL                (0x0C)
413 #define SM501_2D_PITCH                  (0x10)
414 #define SM501_2D_FOREGROUND             (0x14)
415 #define SM501_2D_BACKGROUND             (0x18)
416 #define SM501_2D_STRETCH                (0x1C)
417 #define SM501_2D_COLOR_COMPARE          (0x20)
418 #define SM501_2D_COLOR_COMPARE_MASK     (0x24)
419 #define SM501_2D_MASK                   (0x28)
420 #define SM501_2D_CLIP_TL                (0x2C)
421 #define SM501_2D_CLIP_BR                (0x30)
422 #define SM501_2D_MONO_PATTERN_LOW       (0x34)
423 #define SM501_2D_MONO_PATTERN_HIGH      (0x38)
424 #define SM501_2D_WINDOW_WIDTH           (0x3C)
425 #define SM501_2D_SOURCE_BASE            (0x40)
426 #define SM501_2D_DESTINATION_BASE       (0x44)
427 #define SM501_2D_ALPHA                  (0x48)
428 #define SM501_2D_WRAP                   (0x4C)
429 #define SM501_2D_STATUS                 (0x50)
430 
431 #define SM501_CSC_Y_SOURCE_BASE         (0xC8)
432 #define SM501_CSC_CONSTANTS             (0xCC)
433 #define SM501_CSC_Y_SOURCE_X            (0xD0)
434 #define SM501_CSC_Y_SOURCE_Y            (0xD4)
435 #define SM501_CSC_U_SOURCE_BASE         (0xD8)
436 #define SM501_CSC_V_SOURCE_BASE         (0xDC)
437 #define SM501_CSC_SOURCE_DIMENSION      (0xE0)
438 #define SM501_CSC_SOURCE_PITCH          (0xE4)
439 #define SM501_CSC_DESTINATION           (0xE8)
440 #define SM501_CSC_DESTINATION_DIMENSION (0xEC)
441 #define SM501_CSC_DESTINATION_PITCH     (0xF0)
442 #define SM501_CSC_SCALE_FACTOR          (0xF4)
443 #define SM501_CSC_DESTINATION_BASE      (0xF8)
444 #define SM501_CSC_CONTROL               (0xFC)
445 
446 /* 2d engine data port base */
447 #define SM501_2D_ENGINE_DATA            (0x110000)
448 
449 /* end of register definitions */
450 
451 #define SM501_HWC_WIDTH                       (64)
452 #define SM501_HWC_HEIGHT                      (64)
453 
454 /* SM501 local memory size taken from "linux/drivers/mfd/sm501.c" */
455 static const uint32_t sm501_mem_local_size[] = {
456     [0] = 4 * M_BYTE,
457     [1] = 8 * M_BYTE,
458     [2] = 16 * M_BYTE,
459     [3] = 32 * M_BYTE,
460     [4] = 64 * M_BYTE,
461     [5] = 2 * M_BYTE,
462 };
463 #define get_local_mem_size(s) sm501_mem_local_size[(s)->local_mem_size_index]
464 
465 typedef struct SM501State {
466     /* graphic console status */
467     QemuConsole *con;
468 
469     /* status & internal resources */
470     uint32_t local_mem_size_index;
471     uint8_t *local_mem;
472     MemoryRegion local_mem_region;
473     MemoryRegion mmio_region;
474     MemoryRegion system_config_region;
475     MemoryRegion disp_ctrl_region;
476     MemoryRegion twoD_engine_region;
477     uint32_t last_width;
478     uint32_t last_height;
479 
480     /* mmio registers */
481     uint32_t system_control;
482     uint32_t misc_control;
483     uint32_t gpio_31_0_control;
484     uint32_t gpio_63_32_control;
485     uint32_t dram_control;
486     uint32_t arbitration_control;
487     uint32_t irq_mask;
488     uint32_t misc_timing;
489     uint32_t power_mode_control;
490 
491     uint32_t uart0_ier;
492     uint32_t uart0_lcr;
493     uint32_t uart0_mcr;
494     uint32_t uart0_scr;
495 
496     uint8_t dc_palette[DC_PALETTE_ENTRIES];
497 
498     uint32_t dc_panel_control;
499     uint32_t dc_panel_panning_control;
500     uint32_t dc_panel_fb_addr;
501     uint32_t dc_panel_fb_offset;
502     uint32_t dc_panel_fb_width;
503     uint32_t dc_panel_fb_height;
504     uint32_t dc_panel_tl_location;
505     uint32_t dc_panel_br_location;
506     uint32_t dc_panel_h_total;
507     uint32_t dc_panel_h_sync;
508     uint32_t dc_panel_v_total;
509     uint32_t dc_panel_v_sync;
510 
511     uint32_t dc_panel_hwc_addr;
512     uint32_t dc_panel_hwc_location;
513     uint32_t dc_panel_hwc_color_1_2;
514     uint32_t dc_panel_hwc_color_3;
515 
516     uint32_t dc_video_control;
517 
518     uint32_t dc_crt_control;
519     uint32_t dc_crt_fb_addr;
520     uint32_t dc_crt_fb_offset;
521     uint32_t dc_crt_h_total;
522     uint32_t dc_crt_h_sync;
523     uint32_t dc_crt_v_total;
524     uint32_t dc_crt_v_sync;
525 
526     uint32_t dc_crt_hwc_addr;
527     uint32_t dc_crt_hwc_location;
528     uint32_t dc_crt_hwc_color_1_2;
529     uint32_t dc_crt_hwc_color_3;
530 
531     uint32_t twoD_source;
532     uint32_t twoD_destination;
533     uint32_t twoD_dimension;
534     uint32_t twoD_control;
535     uint32_t twoD_pitch;
536     uint32_t twoD_foreground;
537     uint32_t twoD_background;
538     uint32_t twoD_stretch;
539     uint32_t twoD_color_compare;
540     uint32_t twoD_color_compare_mask;
541     uint32_t twoD_mask;
542     uint32_t twoD_clip_tl;
543     uint32_t twoD_clip_br;
544     uint32_t twoD_mono_pattern_low;
545     uint32_t twoD_mono_pattern_high;
546     uint32_t twoD_window_width;
547     uint32_t twoD_source_base;
548     uint32_t twoD_destination_base;
549     uint32_t twoD_alpha;
550     uint32_t twoD_wrap;
551 } SM501State;
552 
553 static uint32_t get_local_mem_size_index(uint32_t size)
554 {
555     uint32_t norm_size = 0;
556     int i, index = 0;
557 
558     for (i = 0; i < ARRAY_SIZE(sm501_mem_local_size); i++) {
559         uint32_t new_size = sm501_mem_local_size[i];
560         if (new_size >= size) {
561             if (norm_size == 0 || norm_size > new_size) {
562                 norm_size = new_size;
563                 index = i;
564             }
565         }
566     }
567 
568     return index;
569 }
570 
571 static inline int get_width(SM501State *s, int crt)
572 {
573     int width = crt ? s->dc_crt_h_total : s->dc_panel_h_total;
574     return (width & 0x00000FFF) + 1;
575 }
576 
577 static inline int get_height(SM501State *s, int crt)
578 {
579     int height = crt ? s->dc_crt_v_total : s->dc_panel_v_total;
580     return (height & 0x00000FFF) + 1;
581 }
582 
583 static inline int get_bpp(SM501State *s, int crt)
584 {
585     int bpp = crt ? s->dc_crt_control : s->dc_panel_control;
586     return 1 << (bpp & 3);
587 }
588 
589 /**
590  * Check the availability of hardware cursor.
591  * @param crt  0 for PANEL, 1 for CRT.
592  */
593 static inline int is_hwc_enabled(SM501State *state, int crt)
594 {
595     uint32_t addr = crt ? state->dc_crt_hwc_addr : state->dc_panel_hwc_addr;
596     return addr & SM501_HWC_EN;
597 }
598 
599 /**
600  * Get the address which holds cursor pattern data.
601  * @param crt  0 for PANEL, 1 for CRT.
602  */
603 static inline uint8_t *get_hwc_address(SM501State *state, int crt)
604 {
605     uint32_t addr = crt ? state->dc_crt_hwc_addr : state->dc_panel_hwc_addr;
606     return state->local_mem + (addr & 0x03FFFFF0);
607 }
608 
609 /**
610  * Get the cursor position in y coordinate.
611  * @param crt  0 for PANEL, 1 for CRT.
612  */
613 static inline uint32_t get_hwc_y(SM501State *state, int crt)
614 {
615     uint32_t location = crt ? state->dc_crt_hwc_location
616                             : state->dc_panel_hwc_location;
617     return (location & 0x07FF0000) >> 16;
618 }
619 
620 /**
621  * Get the cursor position in x coordinate.
622  * @param crt  0 for PANEL, 1 for CRT.
623  */
624 static inline uint32_t get_hwc_x(SM501State *state, int crt)
625 {
626     uint32_t location = crt ? state->dc_crt_hwc_location
627                             : state->dc_panel_hwc_location;
628     return location & 0x000007FF;
629 }
630 
631 /**
632  * Get the hardware cursor palette.
633  * @param crt  0 for PANEL, 1 for CRT.
634  * @param palette  pointer to a [3 * 3] array to store color values in
635  */
636 static inline void get_hwc_palette(SM501State *state, int crt, uint8_t *palette)
637 {
638     int i;
639     uint32_t color_reg;
640     uint16_t rgb565;
641 
642     for (i = 0; i < 3; i++) {
643         if (i + 1 == 3) {
644             color_reg = crt ? state->dc_crt_hwc_color_3
645                             : state->dc_panel_hwc_color_3;
646         } else {
647             color_reg = crt ? state->dc_crt_hwc_color_1_2
648                             : state->dc_panel_hwc_color_1_2;
649         }
650 
651         if (i + 1 == 2) {
652             rgb565 = (color_reg >> 16) & 0xFFFF;
653         } else {
654             rgb565 = color_reg & 0xFFFF;
655         }
656         palette[i * 3 + 0] = (rgb565 << 3) & 0xf8; /* red */
657         palette[i * 3 + 1] = (rgb565 >> 3) & 0xfc; /* green */
658         palette[i * 3 + 2] = (rgb565 >> 8) & 0xf8; /* blue */
659     }
660 }
661 
662 static inline void hwc_invalidate(SM501State *s, int crt)
663 {
664     int w = get_width(s, crt);
665     int h = get_height(s, crt);
666     int bpp = get_bpp(s, crt);
667     int start = get_hwc_y(s, crt);
668     int end = MIN(h, start + SM501_HWC_HEIGHT) + 1;
669 
670     start *= w * bpp;
671     end *= w * bpp;
672 
673     memory_region_set_dirty(&s->local_mem_region, start, end - start);
674 }
675 
676 static void sm501_2d_operation(SM501State *s)
677 {
678     /* obtain operation parameters */
679     int operation = (s->twoD_control >> 16) & 0x1f;
680     int rtl = s->twoD_control & 0x8000000;
681     int src_x = (s->twoD_source >> 16) & 0x01FFF;
682     int src_y = s->twoD_source & 0xFFFF;
683     int dst_x = (s->twoD_destination >> 16) & 0x01FFF;
684     int dst_y = s->twoD_destination & 0xFFFF;
685     int operation_width = (s->twoD_dimension >> 16) & 0x1FFF;
686     int operation_height = s->twoD_dimension & 0xFFFF;
687     uint32_t color = s->twoD_foreground;
688     int format_flags = (s->twoD_stretch >> 20) & 0x3;
689     int addressing = (s->twoD_stretch >> 16) & 0xF;
690 
691     /* get frame buffer info */
692     uint8_t *src = s->local_mem + (s->twoD_source_base & 0x03FFFFFF);
693     uint8_t *dst = s->local_mem + (s->twoD_destination_base & 0x03FFFFFF);
694     int src_width = (s->dc_crt_h_total & 0x00000FFF) + 1;
695     int dst_width = (s->dc_crt_h_total & 0x00000FFF) + 1;
696 
697     if (addressing != 0x0) {
698         printf("%s: only XY addressing is supported.\n", __func__);
699         abort();
700     }
701 
702     if ((s->twoD_source_base & 0x08000000) ||
703         (s->twoD_destination_base & 0x08000000)) {
704         printf("%s: only local memory is supported.\n", __func__);
705         abort();
706     }
707 
708     switch (operation) {
709     case 0x00: /* copy area */
710 #define COPY_AREA(_bpp, _pixel_type, rtl) {                                   \
711         int y, x, index_d, index_s;                                           \
712         for (y = 0; y < operation_height; y++) {                              \
713             for (x = 0; x < operation_width; x++) {                           \
714                 if (rtl) {                                                    \
715                     index_s = ((src_y - y) * src_width + src_x - x) * _bpp;   \
716                     index_d = ((dst_y - y) * dst_width + dst_x - x) * _bpp;   \
717                 } else {                                                      \
718                     index_s = ((src_y + y) * src_width + src_x + x) * _bpp;   \
719                     index_d = ((dst_y + y) * dst_width + dst_x + x) * _bpp;   \
720                 }                                                             \
721                 *(_pixel_type *)&dst[index_d] = *(_pixel_type *)&src[index_s];\
722             }                                                                 \
723         }                                                                     \
724     }
725         switch (format_flags) {
726         case 0:
727             COPY_AREA(1, uint8_t, rtl);
728             break;
729         case 1:
730             COPY_AREA(2, uint16_t, rtl);
731             break;
732         case 2:
733             COPY_AREA(4, uint32_t, rtl);
734             break;
735         }
736         break;
737 
738     case 0x01: /* fill rectangle */
739 #define FILL_RECT(_bpp, _pixel_type) {                                      \
740         int y, x;                                                           \
741         for (y = 0; y < operation_height; y++) {                            \
742             for (x = 0; x < operation_width; x++) {                         \
743                 int index = ((dst_y + y) * dst_width + dst_x + x) * _bpp;   \
744                 *(_pixel_type *)&dst[index] = (_pixel_type)color;           \
745             }                                                               \
746         }                                                                   \
747     }
748 
749         switch (format_flags) {
750         case 0:
751             FILL_RECT(1, uint8_t);
752             break;
753         case 1:
754             FILL_RECT(2, uint16_t);
755             break;
756         case 2:
757             FILL_RECT(4, uint32_t);
758             break;
759         }
760         break;
761 
762     default:
763         printf("non-implemented SM501 2D operation. %d\n", operation);
764         abort();
765         break;
766     }
767 }
768 
769 static uint64_t sm501_system_config_read(void *opaque, hwaddr addr,
770                                          unsigned size)
771 {
772     SM501State *s = (SM501State *)opaque;
773     uint32_t ret = 0;
774     SM501_DPRINTF("sm501 system config regs : read addr=%x\n", (int)addr);
775 
776     switch (addr) {
777     case SM501_SYSTEM_CONTROL:
778         ret = s->system_control;
779         break;
780     case SM501_MISC_CONTROL:
781         ret = s->misc_control;
782         break;
783     case SM501_GPIO31_0_CONTROL:
784         ret = s->gpio_31_0_control;
785         break;
786     case SM501_GPIO63_32_CONTROL:
787         ret = s->gpio_63_32_control;
788         break;
789     case SM501_DEVICEID:
790         ret = 0x050100A0;
791         break;
792     case SM501_DRAM_CONTROL:
793         ret = (s->dram_control & 0x07F107C0) | s->local_mem_size_index << 13;
794         break;
795     case SM501_ARBTRTN_CONTROL:
796         ret = s->arbitration_control;
797         break;
798     case SM501_COMMAND_LIST_STATUS:
799         ret = 0x00180002; /* FIFOs are empty, everything idle */
800     case SM501_IRQ_MASK:
801         ret = s->irq_mask;
802         break;
803     case SM501_MISC_TIMING:
804         /* TODO : simulate gate control */
805         ret = s->misc_timing;
806         break;
807     case SM501_CURRENT_GATE:
808         /* TODO : simulate gate control */
809         ret = 0x00021807;
810         break;
811     case SM501_CURRENT_CLOCK:
812         ret = 0x2A1A0A09;
813         break;
814     case SM501_POWER_MODE_CONTROL:
815         ret = s->power_mode_control;
816         break;
817     case SM501_ENDIAN_CONTROL:
818         ret = 0; /* Only default little endian mode is supported */
819         break;
820 
821     default:
822         printf("sm501 system config : not implemented register read."
823                " addr=%x\n", (int)addr);
824         abort();
825     }
826 
827     return ret;
828 }
829 
830 static void sm501_system_config_write(void *opaque, hwaddr addr,
831                                       uint64_t value, unsigned size)
832 {
833     SM501State *s = (SM501State *)opaque;
834     SM501_DPRINTF("sm501 system config regs : write addr=%x, val=%x\n",
835                   (uint32_t)addr, (uint32_t)value);
836 
837     switch (addr) {
838     case SM501_SYSTEM_CONTROL:
839         s->system_control = value & 0xE300B8F7;
840         break;
841     case SM501_MISC_CONTROL:
842         s->misc_control = value & 0xFF7FFF20;
843         break;
844     case SM501_GPIO31_0_CONTROL:
845         s->gpio_31_0_control = value;
846         break;
847     case SM501_GPIO63_32_CONTROL:
848         s->gpio_63_32_control = value;
849         break;
850     case SM501_DRAM_CONTROL:
851         s->local_mem_size_index = (value >> 13) & 0x7;
852         /* TODO : check validity of size change */
853         s->dram_control |=  value & 0x7FFFFFC3;
854         break;
855     case SM501_ARBTRTN_CONTROL:
856         s->arbitration_control =  value & 0x37777777;
857         break;
858     case SM501_IRQ_MASK:
859         s->irq_mask = value;
860         break;
861     case SM501_MISC_TIMING:
862         s->misc_timing = value & 0xF31F1FFF;
863         break;
864     case SM501_POWER_MODE_0_GATE:
865     case SM501_POWER_MODE_1_GATE:
866     case SM501_POWER_MODE_0_CLOCK:
867     case SM501_POWER_MODE_1_CLOCK:
868         /* TODO : simulate gate & clock control */
869         break;
870     case SM501_POWER_MODE_CONTROL:
871         s->power_mode_control = value & 0x00000003;
872         break;
873     case SM501_ENDIAN_CONTROL:
874         if (value & 0x00000001) {
875             printf("sm501 system config : big endian mode not implemented.\n");
876             abort();
877         }
878         break;
879 
880     default:
881         printf("sm501 system config : not implemented register write."
882                " addr=%x, val=%x\n", (int)addr, (uint32_t)value);
883         abort();
884     }
885 }
886 
887 static const MemoryRegionOps sm501_system_config_ops = {
888     .read = sm501_system_config_read,
889     .write = sm501_system_config_write,
890     .valid = {
891         .min_access_size = 4,
892         .max_access_size = 4,
893     },
894     .endianness = DEVICE_LITTLE_ENDIAN,
895 };
896 
897 static uint32_t sm501_palette_read(void *opaque, hwaddr addr)
898 {
899     SM501State *s = (SM501State *)opaque;
900     SM501_DPRINTF("sm501 palette read addr=%x\n", (int)addr);
901 
902     /* TODO : consider BYTE/WORD access */
903     /* TODO : consider endian */
904 
905     assert(range_covers_byte(0, 0x400 * 3, addr));
906     return *(uint32_t *)&s->dc_palette[addr];
907 }
908 
909 static void sm501_palette_write(void *opaque, hwaddr addr,
910                                 uint32_t value)
911 {
912     SM501State *s = (SM501State *)opaque;
913     SM501_DPRINTF("sm501 palette write addr=%x, val=%x\n",
914                   (int)addr, value);
915 
916     /* TODO : consider BYTE/WORD access */
917     /* TODO : consider endian */
918 
919     assert(range_covers_byte(0, 0x400 * 3, addr));
920     *(uint32_t *)&s->dc_palette[addr] = value;
921 }
922 
923 static uint64_t sm501_disp_ctrl_read(void *opaque, hwaddr addr,
924                                      unsigned size)
925 {
926     SM501State *s = (SM501State *)opaque;
927     uint32_t ret = 0;
928     SM501_DPRINTF("sm501 disp ctrl regs : read addr=%x\n", (int)addr);
929 
930     switch (addr) {
931 
932     case SM501_DC_PANEL_CONTROL:
933         ret = s->dc_panel_control;
934         break;
935     case SM501_DC_PANEL_PANNING_CONTROL:
936         ret = s->dc_panel_panning_control;
937         break;
938     case SM501_DC_PANEL_COLOR_KEY:
939         /* Not implemented yet */
940         break;
941     case SM501_DC_PANEL_FB_ADDR:
942         ret = s->dc_panel_fb_addr;
943         break;
944     case SM501_DC_PANEL_FB_OFFSET:
945         ret = s->dc_panel_fb_offset;
946         break;
947     case SM501_DC_PANEL_FB_WIDTH:
948         ret = s->dc_panel_fb_width;
949         break;
950     case SM501_DC_PANEL_FB_HEIGHT:
951         ret = s->dc_panel_fb_height;
952         break;
953     case SM501_DC_PANEL_TL_LOC:
954         ret = s->dc_panel_tl_location;
955         break;
956     case SM501_DC_PANEL_BR_LOC:
957         ret = s->dc_panel_br_location;
958         break;
959 
960     case SM501_DC_PANEL_H_TOT:
961         ret = s->dc_panel_h_total;
962         break;
963     case SM501_DC_PANEL_H_SYNC:
964         ret = s->dc_panel_h_sync;
965         break;
966     case SM501_DC_PANEL_V_TOT:
967         ret = s->dc_panel_v_total;
968         break;
969     case SM501_DC_PANEL_V_SYNC:
970         ret = s->dc_panel_v_sync;
971         break;
972 
973     case SM501_DC_PANEL_HWC_ADDR:
974         ret = s->dc_panel_hwc_addr;
975         break;
976     case SM501_DC_PANEL_HWC_LOC:
977         ret = s->dc_panel_hwc_location;
978         break;
979     case SM501_DC_PANEL_HWC_COLOR_1_2:
980         ret = s->dc_panel_hwc_color_1_2;
981         break;
982     case SM501_DC_PANEL_HWC_COLOR_3:
983         ret = s->dc_panel_hwc_color_3;
984         break;
985 
986     case SM501_DC_VIDEO_CONTROL:
987         ret = s->dc_video_control;
988         break;
989 
990     case SM501_DC_CRT_CONTROL:
991         ret = s->dc_crt_control;
992         break;
993     case SM501_DC_CRT_FB_ADDR:
994         ret = s->dc_crt_fb_addr;
995         break;
996     case SM501_DC_CRT_FB_OFFSET:
997         ret = s->dc_crt_fb_offset;
998         break;
999     case SM501_DC_CRT_H_TOT:
1000         ret = s->dc_crt_h_total;
1001         break;
1002     case SM501_DC_CRT_H_SYNC:
1003         ret = s->dc_crt_h_sync;
1004         break;
1005     case SM501_DC_CRT_V_TOT:
1006         ret = s->dc_crt_v_total;
1007         break;
1008     case SM501_DC_CRT_V_SYNC:
1009         ret = s->dc_crt_v_sync;
1010         break;
1011 
1012     case SM501_DC_CRT_HWC_ADDR:
1013         ret = s->dc_crt_hwc_addr;
1014         break;
1015     case SM501_DC_CRT_HWC_LOC:
1016         ret = s->dc_crt_hwc_location;
1017         break;
1018     case SM501_DC_CRT_HWC_COLOR_1_2:
1019         ret = s->dc_crt_hwc_color_1_2;
1020         break;
1021     case SM501_DC_CRT_HWC_COLOR_3:
1022         ret = s->dc_crt_hwc_color_3;
1023         break;
1024 
1025     case SM501_DC_PANEL_PALETTE ... SM501_DC_PANEL_PALETTE + 0x400 * 3 - 4:
1026         ret = sm501_palette_read(opaque, addr - SM501_DC_PANEL_PALETTE);
1027         break;
1028 
1029     default:
1030         printf("sm501 disp ctrl : not implemented register read."
1031                " addr=%x\n", (int)addr);
1032         abort();
1033     }
1034 
1035     return ret;
1036 }
1037 
1038 static void sm501_disp_ctrl_write(void *opaque, hwaddr addr,
1039                                   uint64_t value, unsigned size)
1040 {
1041     SM501State *s = (SM501State *)opaque;
1042     SM501_DPRINTF("sm501 disp ctrl regs : write addr=%x, val=%x\n",
1043                   (unsigned)addr, (unsigned)value);
1044 
1045     switch (addr) {
1046     case SM501_DC_PANEL_CONTROL:
1047         s->dc_panel_control = value & 0x0FFF73FF;
1048         break;
1049     case SM501_DC_PANEL_PANNING_CONTROL:
1050         s->dc_panel_panning_control = value & 0xFF3FFF3F;
1051         break;
1052     case SM501_DC_PANEL_COLOR_KEY:
1053         /* Not implemented yet */
1054         break;
1055     case SM501_DC_PANEL_FB_ADDR:
1056         s->dc_panel_fb_addr = value & 0x8FFFFFF0;
1057         break;
1058     case SM501_DC_PANEL_FB_OFFSET:
1059         s->dc_panel_fb_offset = value & 0x3FF03FF0;
1060         break;
1061     case SM501_DC_PANEL_FB_WIDTH:
1062         s->dc_panel_fb_width = value & 0x0FFF0FFF;
1063         break;
1064     case SM501_DC_PANEL_FB_HEIGHT:
1065         s->dc_panel_fb_height = value & 0x0FFF0FFF;
1066         break;
1067     case SM501_DC_PANEL_TL_LOC:
1068         s->dc_panel_tl_location = value & 0x07FF07FF;
1069         break;
1070     case SM501_DC_PANEL_BR_LOC:
1071         s->dc_panel_br_location = value & 0x07FF07FF;
1072         break;
1073 
1074     case SM501_DC_PANEL_H_TOT:
1075         s->dc_panel_h_total = value & 0x0FFF0FFF;
1076         break;
1077     case SM501_DC_PANEL_H_SYNC:
1078         s->dc_panel_h_sync = value & 0x00FF0FFF;
1079         break;
1080     case SM501_DC_PANEL_V_TOT:
1081         s->dc_panel_v_total = value & 0x0FFF0FFF;
1082         break;
1083     case SM501_DC_PANEL_V_SYNC:
1084         s->dc_panel_v_sync = value & 0x003F0FFF;
1085         break;
1086 
1087     case SM501_DC_PANEL_HWC_ADDR:
1088         value &= 0x8FFFFFF0;
1089         if (value != s->dc_panel_hwc_addr) {
1090             hwc_invalidate(s, 0);
1091             s->dc_panel_hwc_addr = value;
1092         }
1093         break;
1094     case SM501_DC_PANEL_HWC_LOC:
1095         value &= 0x0FFF0FFF;
1096         if (value != s->dc_panel_hwc_location) {
1097             hwc_invalidate(s, 0);
1098             s->dc_panel_hwc_location = value;
1099         }
1100         break;
1101     case SM501_DC_PANEL_HWC_COLOR_1_2:
1102         s->dc_panel_hwc_color_1_2 = value;
1103         break;
1104     case SM501_DC_PANEL_HWC_COLOR_3:
1105         s->dc_panel_hwc_color_3 = value & 0x0000FFFF;
1106         break;
1107 
1108     case SM501_DC_VIDEO_CONTROL:
1109         s->dc_video_control = value & 0x00037FFF;
1110         break;
1111 
1112     case SM501_DC_CRT_CONTROL:
1113         s->dc_crt_control = value & 0x0003FFFF;
1114         break;
1115     case SM501_DC_CRT_FB_ADDR:
1116         s->dc_crt_fb_addr = value & 0x8FFFFFF0;
1117         break;
1118     case SM501_DC_CRT_FB_OFFSET:
1119         s->dc_crt_fb_offset = value & 0x3FF03FF0;
1120         break;
1121     case SM501_DC_CRT_H_TOT:
1122         s->dc_crt_h_total = value & 0x0FFF0FFF;
1123         break;
1124     case SM501_DC_CRT_H_SYNC:
1125         s->dc_crt_h_sync = value & 0x00FF0FFF;
1126         break;
1127     case SM501_DC_CRT_V_TOT:
1128         s->dc_crt_v_total = value & 0x0FFF0FFF;
1129         break;
1130     case SM501_DC_CRT_V_SYNC:
1131         s->dc_crt_v_sync = value & 0x003F0FFF;
1132         break;
1133 
1134     case SM501_DC_CRT_HWC_ADDR:
1135         value &= 0x8FFFFFF0;
1136         if (value != s->dc_crt_hwc_addr) {
1137             hwc_invalidate(s, 1);
1138             s->dc_crt_hwc_addr = value;
1139         }
1140         break;
1141     case SM501_DC_CRT_HWC_LOC:
1142         value &= 0x0FFF0FFF;
1143         if (value != s->dc_crt_hwc_location) {
1144             hwc_invalidate(s, 1);
1145             s->dc_crt_hwc_location = value;
1146         }
1147         break;
1148     case SM501_DC_CRT_HWC_COLOR_1_2:
1149         s->dc_crt_hwc_color_1_2 = value;
1150         break;
1151     case SM501_DC_CRT_HWC_COLOR_3:
1152         s->dc_crt_hwc_color_3 = value & 0x0000FFFF;
1153         break;
1154 
1155     case SM501_DC_PANEL_PALETTE ... SM501_DC_PANEL_PALETTE + 0x400 * 3 - 4:
1156         sm501_palette_write(opaque, addr - SM501_DC_PANEL_PALETTE, value);
1157         break;
1158 
1159     default:
1160         printf("sm501 disp ctrl : not implemented register write."
1161                " addr=%x, val=%x\n", (int)addr, (unsigned)value);
1162         abort();
1163     }
1164 }
1165 
1166 static const MemoryRegionOps sm501_disp_ctrl_ops = {
1167     .read = sm501_disp_ctrl_read,
1168     .write = sm501_disp_ctrl_write,
1169     .valid = {
1170         .min_access_size = 4,
1171         .max_access_size = 4,
1172     },
1173     .endianness = DEVICE_LITTLE_ENDIAN,
1174 };
1175 
1176 static uint64_t sm501_2d_engine_read(void *opaque, hwaddr addr,
1177                                      unsigned size)
1178 {
1179     SM501State *s = (SM501State *)opaque;
1180     uint32_t ret = 0;
1181     SM501_DPRINTF("sm501 2d engine regs : read addr=%x\n", (int)addr);
1182 
1183     switch (addr) {
1184     case SM501_2D_SOURCE:
1185         ret = s->twoD_source;
1186         break;
1187     case SM501_2D_DESTINATION:
1188         ret = s->twoD_destination;
1189         break;
1190     case SM501_2D_DIMENSION:
1191         ret = s->twoD_dimension;
1192         break;
1193     case SM501_2D_CONTROL:
1194         ret = s->twoD_control;
1195         break;
1196     case SM501_2D_PITCH:
1197         ret = s->twoD_pitch;
1198         break;
1199     case SM501_2D_FOREGROUND:
1200         ret = s->twoD_foreground;
1201         break;
1202     case SM501_2D_BACKGROUND:
1203         ret = s->twoD_background;
1204         break;
1205     case SM501_2D_STRETCH:
1206         ret = s->twoD_stretch;
1207         break;
1208     case SM501_2D_COLOR_COMPARE:
1209         ret = s->twoD_color_compare;
1210         break;
1211     case SM501_2D_COLOR_COMPARE_MASK:
1212         ret = s->twoD_color_compare_mask;
1213         break;
1214     case SM501_2D_MASK:
1215         ret = s->twoD_mask;
1216         break;
1217     case SM501_2D_CLIP_TL:
1218         ret = s->twoD_clip_tl;
1219         break;
1220     case SM501_2D_CLIP_BR:
1221         ret = s->twoD_clip_br;
1222         break;
1223     case SM501_2D_MONO_PATTERN_LOW:
1224         ret = s->twoD_mono_pattern_low;
1225         break;
1226     case SM501_2D_MONO_PATTERN_HIGH:
1227         ret = s->twoD_mono_pattern_high;
1228         break;
1229     case SM501_2D_WINDOW_WIDTH:
1230         ret = s->twoD_window_width;
1231         break;
1232     case SM501_2D_SOURCE_BASE:
1233         ret = s->twoD_source_base;
1234         break;
1235     case SM501_2D_DESTINATION_BASE:
1236         ret = s->twoD_destination_base;
1237         break;
1238     case SM501_2D_ALPHA:
1239         ret = s->twoD_alpha;
1240         break;
1241     case SM501_2D_WRAP:
1242         ret = s->twoD_wrap;
1243         break;
1244     case SM501_2D_STATUS:
1245         ret = 0; /* Should return interrupt status */
1246         break;
1247     default:
1248         printf("sm501 disp ctrl : not implemented register read."
1249                " addr=%x\n", (int)addr);
1250         abort();
1251     }
1252 
1253     return ret;
1254 }
1255 
1256 static void sm501_2d_engine_write(void *opaque, hwaddr addr,
1257                                   uint64_t value, unsigned size)
1258 {
1259     SM501State *s = (SM501State *)opaque;
1260     SM501_DPRINTF("sm501 2d engine regs : write addr=%x, val=%x\n",
1261                   (unsigned)addr, (unsigned)value);
1262 
1263     switch (addr) {
1264     case SM501_2D_SOURCE:
1265         s->twoD_source = value;
1266         break;
1267     case SM501_2D_DESTINATION:
1268         s->twoD_destination = value;
1269         break;
1270     case SM501_2D_DIMENSION:
1271         s->twoD_dimension = value;
1272         break;
1273     case SM501_2D_CONTROL:
1274         s->twoD_control = value;
1275 
1276         /* do 2d operation if start flag is set. */
1277         if (value & 0x80000000) {
1278             sm501_2d_operation(s);
1279             s->twoD_control &= ~0x80000000; /* start flag down */
1280         }
1281 
1282         break;
1283     case SM501_2D_PITCH:
1284         s->twoD_pitch = value;
1285         break;
1286     case SM501_2D_FOREGROUND:
1287         s->twoD_foreground = value;
1288         break;
1289     case SM501_2D_BACKGROUND:
1290         s->twoD_background = value;
1291         break;
1292     case SM501_2D_STRETCH:
1293         s->twoD_stretch = value;
1294         break;
1295     case SM501_2D_COLOR_COMPARE:
1296         s->twoD_color_compare = value;
1297         break;
1298     case SM501_2D_COLOR_COMPARE_MASK:
1299         s->twoD_color_compare_mask = value;
1300         break;
1301     case SM501_2D_MASK:
1302         s->twoD_mask = value;
1303         break;
1304     case SM501_2D_CLIP_TL:
1305         s->twoD_clip_tl = value;
1306         break;
1307     case SM501_2D_CLIP_BR:
1308         s->twoD_clip_br = value;
1309         break;
1310     case SM501_2D_MONO_PATTERN_LOW:
1311         s->twoD_mono_pattern_low = value;
1312         break;
1313     case SM501_2D_MONO_PATTERN_HIGH:
1314         s->twoD_mono_pattern_high = value;
1315         break;
1316     case SM501_2D_WINDOW_WIDTH:
1317         s->twoD_window_width = value;
1318         break;
1319     case SM501_2D_SOURCE_BASE:
1320         s->twoD_source_base = value;
1321         break;
1322     case SM501_2D_DESTINATION_BASE:
1323         s->twoD_destination_base = value;
1324         break;
1325     case SM501_2D_ALPHA:
1326         s->twoD_alpha = value;
1327         break;
1328     case SM501_2D_WRAP:
1329         s->twoD_wrap = value;
1330         break;
1331     case SM501_2D_STATUS:
1332         /* ignored, writing 0 should clear interrupt status */
1333         break;
1334     default:
1335         printf("sm501 2d engine : not implemented register write."
1336                " addr=%x, val=%x\n", (int)addr, (unsigned)value);
1337         abort();
1338     }
1339 }
1340 
1341 static const MemoryRegionOps sm501_2d_engine_ops = {
1342     .read = sm501_2d_engine_read,
1343     .write = sm501_2d_engine_write,
1344     .valid = {
1345         .min_access_size = 4,
1346         .max_access_size = 4,
1347     },
1348     .endianness = DEVICE_LITTLE_ENDIAN,
1349 };
1350 
1351 /* draw line functions for all console modes */
1352 
1353 typedef void draw_line_func(uint8_t *d, const uint8_t *s,
1354                             int width, const uint32_t *pal);
1355 
1356 typedef void draw_hwc_line_func(uint8_t *d, const uint8_t *s,
1357                                 int width, const uint8_t *palette,
1358                                 int c_x, int c_y);
1359 
1360 #define DEPTH 8
1361 #include "sm501_template.h"
1362 
1363 #define DEPTH 15
1364 #include "sm501_template.h"
1365 
1366 #define BGR_FORMAT
1367 #define DEPTH 15
1368 #include "sm501_template.h"
1369 
1370 #define DEPTH 16
1371 #include "sm501_template.h"
1372 
1373 #define BGR_FORMAT
1374 #define DEPTH 16
1375 #include "sm501_template.h"
1376 
1377 #define DEPTH 32
1378 #include "sm501_template.h"
1379 
1380 #define BGR_FORMAT
1381 #define DEPTH 32
1382 #include "sm501_template.h"
1383 
1384 static draw_line_func *draw_line8_funcs[] = {
1385     draw_line8_8,
1386     draw_line8_15,
1387     draw_line8_16,
1388     draw_line8_32,
1389     draw_line8_32bgr,
1390     draw_line8_15bgr,
1391     draw_line8_16bgr,
1392 };
1393 
1394 static draw_line_func *draw_line16_funcs[] = {
1395     draw_line16_8,
1396     draw_line16_15,
1397     draw_line16_16,
1398     draw_line16_32,
1399     draw_line16_32bgr,
1400     draw_line16_15bgr,
1401     draw_line16_16bgr,
1402 };
1403 
1404 static draw_line_func *draw_line32_funcs[] = {
1405     draw_line32_8,
1406     draw_line32_15,
1407     draw_line32_16,
1408     draw_line32_32,
1409     draw_line32_32bgr,
1410     draw_line32_15bgr,
1411     draw_line32_16bgr,
1412 };
1413 
1414 static draw_hwc_line_func *draw_hwc_line_funcs[] = {
1415     draw_hwc_line_8,
1416     draw_hwc_line_15,
1417     draw_hwc_line_16,
1418     draw_hwc_line_32,
1419     draw_hwc_line_32bgr,
1420     draw_hwc_line_15bgr,
1421     draw_hwc_line_16bgr,
1422 };
1423 
1424 static inline int get_depth_index(DisplaySurface *surface)
1425 {
1426     switch (surface_bits_per_pixel(surface)) {
1427     default:
1428     case 8:
1429         return 0;
1430     case 15:
1431         return 1;
1432     case 16:
1433         return 2;
1434     case 32:
1435         if (is_surface_bgr(surface)) {
1436             return 4;
1437         } else {
1438             return 3;
1439         }
1440     }
1441 }
1442 
1443 static void sm501_update_display(void *opaque)
1444 {
1445     SM501State *s = (SM501State *)opaque;
1446     DisplaySurface *surface = qemu_console_surface(s->con);
1447     DirtyBitmapSnapshot *snap;
1448     int y, c_x = 0, c_y = 0;
1449     int crt = (s->dc_crt_control & SM501_DC_CRT_CONTROL_SEL) ? 1 : 0;
1450     int width = get_width(s, crt);
1451     int height = get_height(s, crt);
1452     int src_bpp = get_bpp(s, crt);
1453     int dst_bpp = surface_bytes_per_pixel(surface);
1454     int dst_depth_index = get_depth_index(surface);
1455     draw_line_func *draw_line = NULL;
1456     draw_hwc_line_func *draw_hwc_line = NULL;
1457     int full_update = 0;
1458     int y_start = -1;
1459     ram_addr_t offset = 0;
1460     uint32_t *palette;
1461     uint8_t hwc_palette[3 * 3];
1462     uint8_t *hwc_src = NULL;
1463 
1464     if (!((crt ? s->dc_crt_control : s->dc_panel_control)
1465           & SM501_DC_CRT_CONTROL_ENABLE)) {
1466         return;
1467     }
1468 
1469     palette = (uint32_t *)(crt ? &s->dc_palette[SM501_DC_CRT_PALETTE -
1470                                                 SM501_DC_PANEL_PALETTE]
1471                                : &s->dc_palette[0]);
1472 
1473     /* choose draw_line function */
1474     switch (src_bpp) {
1475     case 1:
1476         draw_line = draw_line8_funcs[dst_depth_index];
1477         break;
1478     case 2:
1479         draw_line = draw_line16_funcs[dst_depth_index];
1480         break;
1481     case 4:
1482         draw_line = draw_line32_funcs[dst_depth_index];
1483         break;
1484     default:
1485         printf("sm501 update display : invalid control register value.\n");
1486         abort();
1487         break;
1488     }
1489 
1490     /* set up to draw hardware cursor */
1491     if (is_hwc_enabled(s, crt)) {
1492         /* choose cursor draw line function */
1493         draw_hwc_line = draw_hwc_line_funcs[dst_depth_index];
1494         hwc_src = get_hwc_address(s, crt);
1495         c_x = get_hwc_x(s, crt);
1496         c_y = get_hwc_y(s, crt);
1497         get_hwc_palette(s, crt, hwc_palette);
1498     }
1499 
1500     /* adjust console size */
1501     if (s->last_width != width || s->last_height != height) {
1502         qemu_console_resize(s->con, width, height);
1503         surface = qemu_console_surface(s->con);
1504         s->last_width = width;
1505         s->last_height = height;
1506         full_update = 1;
1507     }
1508 
1509     /* draw each line according to conditions */
1510     memory_region_sync_dirty_bitmap(&s->local_mem_region);
1511     snap = memory_region_snapshot_and_clear_dirty(&s->local_mem_region,
1512               offset, width * height * src_bpp, DIRTY_MEMORY_VGA);
1513     for (y = 0, offset = 0; y < height; y++, offset += width * src_bpp) {
1514         int update, update_hwc;
1515 
1516         /* check if hardware cursor is enabled and we're within its range */
1517         update_hwc = draw_hwc_line && c_y <= y && y < c_y + SM501_HWC_HEIGHT;
1518         update = full_update || update_hwc;
1519         /* check dirty flags for each line */
1520         update |= memory_region_snapshot_get_dirty(&s->local_mem_region, snap,
1521                                                    offset, width * src_bpp);
1522 
1523         /* draw line and change status */
1524         if (update) {
1525             uint8_t *d = surface_data(surface);
1526             d +=  y * width * dst_bpp;
1527 
1528             /* draw graphics layer */
1529             draw_line(d, s->local_mem + offset, width, palette);
1530 
1531             /* draw hardware cursor */
1532             if (update_hwc) {
1533                 draw_hwc_line(d, hwc_src, width, hwc_palette, c_x, y - c_y);
1534             }
1535 
1536             if (y_start < 0) {
1537                 y_start = y;
1538             }
1539         } else {
1540             if (y_start >= 0) {
1541                 /* flush to display */
1542                 dpy_gfx_update(s->con, 0, y_start, width, y - y_start);
1543                 y_start = -1;
1544             }
1545         }
1546     }
1547     g_free(snap);
1548 
1549     /* complete flush to display */
1550     if (y_start >= 0) {
1551         dpy_gfx_update(s->con, 0, y_start, width, y - y_start);
1552     }
1553 }
1554 
1555 static const GraphicHwOps sm501_ops = {
1556     .gfx_update  = sm501_update_display,
1557 };
1558 
1559 static void sm501_reset(SM501State *s)
1560 {
1561     s->system_control = 0x00100000; /* 2D engine FIFO empty */
1562     /* Bits 17 (SH), 7 (CDR), 6:5 (Test), 2:0 (Bus) are all supposed
1563      * to be determined at reset by GPIO lines which set config bits.
1564      * We hardwire them:
1565      *  SH = 0 : Hitachi Ready Polarity == Active Low
1566      *  CDR = 0 : do not reset clock divider
1567      *  TEST = 0 : Normal mode (not testing the silicon)
1568      *  BUS = 0 : Hitachi SH3/SH4
1569      */
1570     s->misc_control = SM501_MISC_DAC_POWER;
1571     s->gpio_31_0_control = 0;
1572     s->gpio_63_32_control = 0;
1573     s->dram_control = 0;
1574     s->arbitration_control = 0x05146732;
1575     s->irq_mask = 0;
1576     s->misc_timing = 0;
1577     s->power_mode_control = 0;
1578     s->dc_panel_control = 0x00010000; /* FIFO level 3 */
1579     s->dc_video_control = 0;
1580     s->dc_crt_control = 0x00010000;
1581     s->twoD_source = 0;
1582     s->twoD_destination = 0;
1583     s->twoD_dimension = 0;
1584     s->twoD_control = 0;
1585     s->twoD_pitch = 0;
1586     s->twoD_foreground = 0;
1587     s->twoD_background = 0;
1588     s->twoD_stretch = 0;
1589     s->twoD_color_compare = 0;
1590     s->twoD_color_compare_mask = 0;
1591     s->twoD_mask = 0;
1592     s->twoD_clip_tl = 0;
1593     s->twoD_clip_br = 0;
1594     s->twoD_mono_pattern_low = 0;
1595     s->twoD_mono_pattern_high = 0;
1596     s->twoD_window_width = 0;
1597     s->twoD_source_base = 0;
1598     s->twoD_destination_base = 0;
1599     s->twoD_alpha = 0;
1600     s->twoD_wrap = 0;
1601 }
1602 
1603 static void sm501_init(SM501State *s, DeviceState *dev,
1604                        uint32_t local_mem_bytes)
1605 {
1606     s->local_mem_size_index = get_local_mem_size_index(local_mem_bytes);
1607     SM501_DPRINTF("sm501 local mem size=%x. index=%d\n", get_local_mem_size(s),
1608                   s->local_mem_size_index);
1609 
1610     /* local memory */
1611     memory_region_init_ram(&s->local_mem_region, OBJECT(dev), "sm501.local",
1612                            get_local_mem_size(s), &error_fatal);
1613     memory_region_set_log(&s->local_mem_region, true, DIRTY_MEMORY_VGA);
1614     s->local_mem = memory_region_get_ram_ptr(&s->local_mem_region);
1615 
1616     /* mmio */
1617     memory_region_init(&s->mmio_region, OBJECT(dev), "sm501.mmio", MMIO_SIZE);
1618     memory_region_init_io(&s->system_config_region, OBJECT(dev),
1619                           &sm501_system_config_ops, s,
1620                           "sm501-system-config", 0x6c);
1621     memory_region_add_subregion(&s->mmio_region, SM501_SYS_CONFIG,
1622                                 &s->system_config_region);
1623     memory_region_init_io(&s->disp_ctrl_region, OBJECT(dev),
1624                           &sm501_disp_ctrl_ops, s,
1625                           "sm501-disp-ctrl", 0x1000);
1626     memory_region_add_subregion(&s->mmio_region, SM501_DC,
1627                                 &s->disp_ctrl_region);
1628     memory_region_init_io(&s->twoD_engine_region, OBJECT(dev),
1629                           &sm501_2d_engine_ops, s,
1630                           "sm501-2d-engine", 0x54);
1631     memory_region_add_subregion(&s->mmio_region, SM501_2D_ENGINE,
1632                                 &s->twoD_engine_region);
1633 
1634     /* create qemu graphic console */
1635     s->con = graphic_console_init(DEVICE(dev), 0, &sm501_ops, s);
1636 }
1637 
1638 static const VMStateDescription vmstate_sm501_state = {
1639     .name = "sm501-state",
1640     .version_id = 1,
1641     .minimum_version_id = 1,
1642     .fields = (VMStateField[]) {
1643         VMSTATE_UINT32(local_mem_size_index, SM501State),
1644         VMSTATE_UINT32(system_control, SM501State),
1645         VMSTATE_UINT32(misc_control, SM501State),
1646         VMSTATE_UINT32(gpio_31_0_control, SM501State),
1647         VMSTATE_UINT32(gpio_63_32_control, SM501State),
1648         VMSTATE_UINT32(dram_control, SM501State),
1649         VMSTATE_UINT32(arbitration_control, SM501State),
1650         VMSTATE_UINT32(irq_mask, SM501State),
1651         VMSTATE_UINT32(misc_timing, SM501State),
1652         VMSTATE_UINT32(power_mode_control, SM501State),
1653         VMSTATE_UINT32(uart0_ier, SM501State),
1654         VMSTATE_UINT32(uart0_lcr, SM501State),
1655         VMSTATE_UINT32(uart0_mcr, SM501State),
1656         VMSTATE_UINT32(uart0_scr, SM501State),
1657         VMSTATE_UINT8_ARRAY(dc_palette, SM501State, DC_PALETTE_ENTRIES),
1658         VMSTATE_UINT32(dc_panel_control, SM501State),
1659         VMSTATE_UINT32(dc_panel_panning_control, SM501State),
1660         VMSTATE_UINT32(dc_panel_fb_addr, SM501State),
1661         VMSTATE_UINT32(dc_panel_fb_offset, SM501State),
1662         VMSTATE_UINT32(dc_panel_fb_width, SM501State),
1663         VMSTATE_UINT32(dc_panel_fb_height, SM501State),
1664         VMSTATE_UINT32(dc_panel_tl_location, SM501State),
1665         VMSTATE_UINT32(dc_panel_br_location, SM501State),
1666         VMSTATE_UINT32(dc_panel_h_total, SM501State),
1667         VMSTATE_UINT32(dc_panel_h_sync, SM501State),
1668         VMSTATE_UINT32(dc_panel_v_total, SM501State),
1669         VMSTATE_UINT32(dc_panel_v_sync, SM501State),
1670         VMSTATE_UINT32(dc_panel_hwc_addr, SM501State),
1671         VMSTATE_UINT32(dc_panel_hwc_location, SM501State),
1672         VMSTATE_UINT32(dc_panel_hwc_color_1_2, SM501State),
1673         VMSTATE_UINT32(dc_panel_hwc_color_3, SM501State),
1674         VMSTATE_UINT32(dc_video_control, SM501State),
1675         VMSTATE_UINT32(dc_crt_control, SM501State),
1676         VMSTATE_UINT32(dc_crt_fb_addr, SM501State),
1677         VMSTATE_UINT32(dc_crt_fb_offset, SM501State),
1678         VMSTATE_UINT32(dc_crt_h_total, SM501State),
1679         VMSTATE_UINT32(dc_crt_h_sync, SM501State),
1680         VMSTATE_UINT32(dc_crt_v_total, SM501State),
1681         VMSTATE_UINT32(dc_crt_v_sync, SM501State),
1682         VMSTATE_UINT32(dc_crt_hwc_addr, SM501State),
1683         VMSTATE_UINT32(dc_crt_hwc_location, SM501State),
1684         VMSTATE_UINT32(dc_crt_hwc_color_1_2, SM501State),
1685         VMSTATE_UINT32(dc_crt_hwc_color_3, SM501State),
1686         VMSTATE_UINT32(twoD_source, SM501State),
1687         VMSTATE_UINT32(twoD_destination, SM501State),
1688         VMSTATE_UINT32(twoD_dimension, SM501State),
1689         VMSTATE_UINT32(twoD_control, SM501State),
1690         VMSTATE_UINT32(twoD_pitch, SM501State),
1691         VMSTATE_UINT32(twoD_foreground, SM501State),
1692         VMSTATE_UINT32(twoD_background, SM501State),
1693         VMSTATE_UINT32(twoD_stretch, SM501State),
1694         VMSTATE_UINT32(twoD_color_compare, SM501State),
1695         VMSTATE_UINT32(twoD_color_compare_mask, SM501State),
1696         VMSTATE_UINT32(twoD_mask, SM501State),
1697         VMSTATE_UINT32(twoD_clip_tl, SM501State),
1698         VMSTATE_UINT32(twoD_clip_br, SM501State),
1699         VMSTATE_UINT32(twoD_mono_pattern_low, SM501State),
1700         VMSTATE_UINT32(twoD_mono_pattern_high, SM501State),
1701         VMSTATE_UINT32(twoD_window_width, SM501State),
1702         VMSTATE_UINT32(twoD_source_base, SM501State),
1703         VMSTATE_UINT32(twoD_destination_base, SM501State),
1704         VMSTATE_UINT32(twoD_alpha, SM501State),
1705         VMSTATE_UINT32(twoD_wrap, SM501State),
1706         VMSTATE_END_OF_LIST()
1707      }
1708 };
1709 
1710 #define TYPE_SYSBUS_SM501 "sysbus-sm501"
1711 #define SYSBUS_SM501(obj) \
1712     OBJECT_CHECK(SM501SysBusState, (obj), TYPE_SYSBUS_SM501)
1713 
1714 typedef struct {
1715     /*< private >*/
1716     SysBusDevice parent_obj;
1717     /*< public >*/
1718     SM501State state;
1719     uint32_t vram_size;
1720     uint32_t base;
1721     void *chr_state;
1722 } SM501SysBusState;
1723 
1724 static void sm501_realize_sysbus(DeviceState *dev, Error **errp)
1725 {
1726     SM501SysBusState *s = SYSBUS_SM501(dev);
1727     SysBusDevice *sbd = SYS_BUS_DEVICE(dev);
1728     DeviceState *usb_dev;
1729 
1730     sm501_init(&s->state, dev, s->vram_size);
1731     if (get_local_mem_size(&s->state) != s->vram_size) {
1732         error_setg(errp, "Invalid VRAM size, nearest valid size is %" PRIu32,
1733                    get_local_mem_size(&s->state));
1734         return;
1735     }
1736     sysbus_init_mmio(sbd, &s->state.local_mem_region);
1737     sysbus_init_mmio(sbd, &s->state.mmio_region);
1738 
1739     /* bridge to usb host emulation module */
1740     usb_dev = qdev_create(NULL, "sysbus-ohci");
1741     qdev_prop_set_uint32(usb_dev, "num-ports", 2);
1742     qdev_prop_set_uint64(usb_dev, "dma-offset", s->base);
1743     qdev_init_nofail(usb_dev);
1744     memory_region_add_subregion(&s->state.mmio_region, SM501_USB_HOST,
1745                        sysbus_mmio_get_region(SYS_BUS_DEVICE(usb_dev), 0));
1746     sysbus_pass_irq(sbd, SYS_BUS_DEVICE(usb_dev));
1747 
1748     /* bridge to serial emulation module */
1749     if (s->chr_state) {
1750         serial_mm_init(&s->state.mmio_region, SM501_UART0, 2,
1751                        NULL, /* TODO : chain irq to IRL */
1752                        115200, s->chr_state, DEVICE_LITTLE_ENDIAN);
1753     }
1754 }
1755 
1756 static Property sm501_sysbus_properties[] = {
1757     DEFINE_PROP_UINT32("vram-size", SM501SysBusState, vram_size, 0),
1758     DEFINE_PROP_UINT32("base", SM501SysBusState, base, 0),
1759     DEFINE_PROP_PTR("chr-state", SM501SysBusState, chr_state),
1760     DEFINE_PROP_END_OF_LIST(),
1761 };
1762 
1763 static void sm501_reset_sysbus(DeviceState *dev)
1764 {
1765     SM501SysBusState *s = SYSBUS_SM501(dev);
1766     sm501_reset(&s->state);
1767 }
1768 
1769 static const VMStateDescription vmstate_sm501_sysbus = {
1770     .name = TYPE_SYSBUS_SM501,
1771     .version_id = 1,
1772     .minimum_version_id = 1,
1773     .fields = (VMStateField[]) {
1774         VMSTATE_STRUCT(state, SM501SysBusState, 1,
1775                        vmstate_sm501_state, SM501State),
1776         VMSTATE_END_OF_LIST()
1777      }
1778 };
1779 
1780 static void sm501_sysbus_class_init(ObjectClass *klass, void *data)
1781 {
1782     DeviceClass *dc = DEVICE_CLASS(klass);
1783 
1784     dc->realize = sm501_realize_sysbus;
1785     set_bit(DEVICE_CATEGORY_DISPLAY, dc->categories);
1786     dc->desc = "SM501 Multimedia Companion";
1787     dc->props = sm501_sysbus_properties;
1788     dc->reset = sm501_reset_sysbus;
1789     dc->vmsd = &vmstate_sm501_sysbus;
1790     /* Note: pointer property "chr-state" may remain null, thus
1791      * no need for dc->user_creatable = false;
1792      */
1793 }
1794 
1795 static const TypeInfo sm501_sysbus_info = {
1796     .name          = TYPE_SYSBUS_SM501,
1797     .parent        = TYPE_SYS_BUS_DEVICE,
1798     .instance_size = sizeof(SM501SysBusState),
1799     .class_init    = sm501_sysbus_class_init,
1800 };
1801 
1802 #define TYPE_PCI_SM501 "sm501"
1803 #define PCI_SM501(obj) OBJECT_CHECK(SM501PCIState, (obj), TYPE_PCI_SM501)
1804 
1805 typedef struct {
1806     /*< private >*/
1807     PCIDevice parent_obj;
1808     /*< public >*/
1809     SM501State state;
1810     uint32_t vram_size;
1811 } SM501PCIState;
1812 
1813 static void sm501_realize_pci(PCIDevice *dev, Error **errp)
1814 {
1815     SM501PCIState *s = PCI_SM501(dev);
1816 
1817     sm501_init(&s->state, DEVICE(dev), s->vram_size);
1818     if (get_local_mem_size(&s->state) != s->vram_size) {
1819         error_setg(errp, "Invalid VRAM size, nearest valid size is %" PRIu32,
1820                    get_local_mem_size(&s->state));
1821         return;
1822     }
1823     pci_register_bar(dev, 0, PCI_BASE_ADDRESS_SPACE_MEMORY,
1824                      &s->state.local_mem_region);
1825     pci_register_bar(dev, 1, PCI_BASE_ADDRESS_SPACE_MEMORY,
1826                      &s->state.mmio_region);
1827 }
1828 
1829 static Property sm501_pci_properties[] = {
1830     DEFINE_PROP_UINT32("vram-size", SM501PCIState, vram_size, 64 * M_BYTE),
1831     DEFINE_PROP_END_OF_LIST(),
1832 };
1833 
1834 static void sm501_reset_pci(DeviceState *dev)
1835 {
1836     SM501PCIState *s = PCI_SM501(dev);
1837     sm501_reset(&s->state);
1838     /* Bits 2:0 of misc_control register is 001 for PCI */
1839     s->state.misc_control |= 1;
1840 }
1841 
1842 static const VMStateDescription vmstate_sm501_pci = {
1843     .name = TYPE_PCI_SM501,
1844     .version_id = 1,
1845     .minimum_version_id = 1,
1846     .fields = (VMStateField[]) {
1847         VMSTATE_PCI_DEVICE(parent_obj, SM501PCIState),
1848         VMSTATE_STRUCT(state, SM501PCIState, 1,
1849                        vmstate_sm501_state, SM501State),
1850         VMSTATE_END_OF_LIST()
1851      }
1852 };
1853 
1854 static void sm501_pci_class_init(ObjectClass *klass, void *data)
1855 {
1856     DeviceClass *dc = DEVICE_CLASS(klass);
1857     PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1858 
1859     k->realize = sm501_realize_pci;
1860     k->vendor_id = PCI_VENDOR_ID_SILICON_MOTION;
1861     k->device_id = PCI_DEVICE_ID_SM501;
1862     k->class_id = PCI_CLASS_DISPLAY_OTHER;
1863     set_bit(DEVICE_CATEGORY_DISPLAY, dc->categories);
1864     dc->desc = "SM501 Display Controller";
1865     dc->props = sm501_pci_properties;
1866     dc->reset = sm501_reset_pci;
1867     dc->hotpluggable = false;
1868     dc->vmsd = &vmstate_sm501_pci;
1869 }
1870 
1871 static const TypeInfo sm501_pci_info = {
1872     .name          = TYPE_PCI_SM501,
1873     .parent        = TYPE_PCI_DEVICE,
1874     .instance_size = sizeof(SM501PCIState),
1875     .class_init    = sm501_pci_class_init,
1876     .interfaces = (InterfaceInfo[]) {
1877         { INTERFACE_CONVENTIONAL_PCI_DEVICE },
1878         { },
1879     },
1880 };
1881 
1882 static void sm501_register_types(void)
1883 {
1884     type_register_static(&sm501_sysbus_info);
1885     type_register_static(&sm501_pci_info);
1886 }
1887 
1888 type_init(sm501_register_types)
1889