libws libws
WSwan hardware library for the Wonderful toolchain
Loading...
Searching...
No Matches
display.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2022, 2023 Adrian "asie" Siekierka
3 *
4 * This software is provided 'as-is', without any express or implied
5 * warranty. In no event will the authors be held liable for any damages
6 * arising from the use of this software.
7 *
8 * Permission is granted to anyone to use this software for any purpose,
9 * including commercial applications, and to alter it and redistribute it
10 * freely, subject to the following restrictions:
11 *
12 * 1. The origin of this software must not be misrepresented; you must not
13 * claim that you wrote the original software. If you use this software
14 * in a product, an acknowledgment in the product documentation would be
15 * appreciated but is not required.
16 *
17 * 2. Altered source versions must be plainly marked as such, and must not be
18 * misrepresented as being the original software.
19 *
20 * 3. This notice may not be removed or altered from any source distribution.
21 */
22
23#ifndef LIBWS_DISPLAY_H_
24#define LIBWS_DISPLAY_H_
25
26#include <stdbool.h>
27#include <stdint.h>
28#include <wonderful.h>
29#include "memory.h"
30#include "ports.h"
31
35
40
41#define WS_DISPLAY_WIDTH_TILES 28
42#define WS_DISPLAY_HEIGHT_TILES 18
43#define WS_DISPLAY_WIDTH_PIXELS (WS_DISPLAY_WIDTH_TILES * WS_DISPLAY_TILE_WIDTH)
44#define WS_DISPLAY_HEIGHT_PIXELS (WS_DISPLAY_HEIGHT_TILES * WS_DISPLAY_TILE_HEIGHT)
45
46#define WS_DISPLAY_TILE_WIDTH 8
47#define WS_DISPLAY_TILE_HEIGHT 8
48#define WS_DISPLAY_TILE_SIZE 16
49#define WS_DISPLAY_TILE_SIZE_4BPP 32
50
51typedef struct {
54
55typedef struct {
58
59#define WS_SCREEN_ATTR_TILE(x) (x)
60#define WS_SCREEN_ATTR_TILE_MASK (0x1FF)
61#define WS_SCREEN_ATTR_PALETTE(x) ((x) << 9)
62#define WS_SCREEN_ATTR_PALETTE_MASK (0xF << 9)
63#define WS_SCREEN_ATTR_BANK(x) ((x) << 13)
64#define WS_SCREEN_ATTR_BANK_MASK (0x2000)
65#define WS_SCREEN_ATTR_TILE_EX(x) (((x) & 0x1FF) | (((x) >> 13) << 13))
66#define WS_SCREEN_ATTR_TILE_EX_MASK (0x21FF)
67#define WS_SCREEN_ATTR_TILE_BANK_MASK (WS_SCREEN_ATTR_TILE_MASK | WS_SCREEN_ATTR_BANK_MASK)
68
69#define WS_SCREEN_ATTR_FLIP_H 0x4000
70#define WS_SCREEN_ATTR_FLIP_V 0x8000
71#define WS_SCREEN_ATTR_FLIP 0xC000
72#define WS_SCREEN_ATTR_FLIP_MASK 0xC000
73
74#define WS_SCREEN_WIDTH_TILES 32
75#define WS_SCREEN_HEIGHT_TILES 32
76#define WS_SCREEN_WIDTH_PIXELS (WS_SCREEN_WIDTH_TILES * WS_DISPLAY_TILE_WIDTH)
77#define WS_SCREEN_HEIGHT_PIXELS (WS_SCREEN_HEIGHT_TILES * WS_DISPLAY_TILE_HEIGHT)
78
79typedef struct {
80 uint16_t attr;
81 uint8_t y;
82 uint8_t x;
84
85#define WS_SPRITE_ATTR_PALETTE(x) ((x) << 9)
86#define WS_SPRITE_ATTR_PALETTE_MASK (0x7 << 9)
87#define WS_SPRITE_ATTR_INSIDE 0x1000
88#define WS_SPRITE_ATTR_PRIORITY 0x2000
89#define WS_SPRITE_ATTR_FLIP_H 0x4000
90#define WS_SPRITE_ATTR_FLIP_V 0x8000
91#define WS_SPRITE_ATTR_FLIP 0xC000
92#define WS_SPRITE_ATTR_FLIP_MASK 0xC000
93
94#define WS_SPRITE_MAX_COUNT 128
95
101#define WS_TILE_MEM(i) ((ws_display_tile_t ws_iram *) (0x2000 + ((i) << 4)))
102
108#define WS_TILE_4BPP_MEM(i) ((ws_display_tile_4bpp_t ws_iram *) (0x4000 + ((i) << 5)))
109
116#define WS_TILE_BANKED_MEM(b, i) ((ws_display_tile_t ws_iram *) (0x2000 + (!!(b) << 13) + ((i) << 4)))
117
124#define WS_TILE_4BPP_BANKED_MEM(b, i) ((ws_display_tile_4bpp_t ws_iram *) (0x4000 + (!!(b) << 14) + ((i) << 5)))
125
131#define WS_DISPLAY_COLOR_MEM(i) ((uint16_t ws_iram *) (0xFE00 + ((i) << 5)))
132
138#define WS_SCREEN_COLOR_MEM WS_DISPLAY_COLOR_MEM
139
145#define WS_SPRITE_COLOR_MEM(i) ((uint16_t ws_iram *) (0xFF00 + ((i) << 5)))
146
147#define WS_DISPLAY_SHADE_LUT(c0, c1, c2, c3, c4, c5, c6, c7) \
148 (((uint32_t)(c0)) | (((uint32_t)(c1)) << 4) | (((uint32_t)(c2)) << 8) | (((uint32_t)(c3)) << 12) | \
149 (((uint32_t)(c4)) << 16) | (((uint32_t)(c5)) << 20) | (((uint32_t)(c6)) << 24) | (((uint32_t)(c7)) << 28))
150#define WS_DISPLAY_SHADE_LUT_DEFAULT WS_DISPLAY_SHADE_LUT(0, 2, 4, 6, 9, 11, 13, 15)
151
159#define WS_RGB(r, g, b) (((r) << 8) | ((g) << 4) | (b))
160
164#define WS_DISPLAY_MONO_PALETTE(c0, c1, c2, c3) ((c0) | ((c1) << 4) | ((c2) << 8) | ((c3) << 12))
165
166// TODO: Add ws_display_set_backdrop (has to consider mono/color modes have different values)
167
174static inline void ws_display_set_screen_addresses(const void __wf_iram* scr1_addr, const void __wf_iram* scr2_addr) {
175 outportb(WS_SCR_BASE_PORT, WS_SCR_BASE_ADDR1(scr1_addr) | WS_SCR_BASE_ADDR2(scr2_addr));
176}
177
184static inline void ws_display_set_screen_address(uint8_t screen, const void __wf_iram* address) {
185 outportb(WS_SCR_BASE_PORT, (inportb(WS_SCR_BASE_PORT) & (0xF0 >> (screen * 4))) | (WS_SCR_BASE_ADDR1(address) << (screen * 4)));
186}
187
193#define ws_display_set_screen1_address(address) ws_display_set_screen_address(0, (address))
194
200#define ws_display_set_screen2_address(address) ws_display_set_screen_address(1, (address))
201
207static inline void ws_display_set_sprite_address(const void __wf_iram* address) {
208 outportb(WS_SPR_BASE_PORT, WS_SPR_BASE_ADDR(address));
209}
210
219static inline void ws_display_set_screen2_window(uint8_t x, uint8_t y, uint8_t width, uint8_t height) {
220 outportw(WS_SCR2_WIN_X1_PORT, x | (y << 8));
221 outportw(WS_SCR2_WIN_X2_PORT, ((x + width - 1) & 0xFF) | ((y + height - 1) << 8));
222}
223
232static inline void ws_display_set_screen2_window_corners(uint8_t left, uint8_t top, uint8_t right, uint8_t bottom) {
233 outportw(WS_SCR2_WIN_X1_PORT, left | (top << 8));
234 outportw(WS_SCR2_WIN_X2_PORT, right | (bottom << 8));
235}
236
245static inline void ws_display_set_sprite_window(uint8_t x, uint8_t y, uint8_t width, uint8_t height) {
246 outportw(WS_SPR_WIN_X1_PORT, x | (y << 8));
247 outportw(WS_SPR_WIN_X2_PORT, ((x + width - 1) & 0xFF) | ((y + height - 1) << 8));
248}
249
258static inline void ws_display_set_sprite_window_corners(uint8_t left, uint8_t top, uint8_t right, uint8_t bottom) {
259 outportw(WS_SPR_WIN_X1_PORT, left | (top << 8));
260 outportw(WS_SPR_WIN_X2_PORT, right | (bottom << 8));
261}
262
270static inline void ws_display_scroll_screen_to(uint8_t screen, uint8_t x, uint8_t y) {
271 outportw(WS_SCR1_SCRL_X_PORT + (screen * 2), x | (y << 8));
272}
273
280#define ws_display_scroll_screen1_to(x, y) ws_display_scroll_screen_to(0, (x), (y))
281
288#define ws_display_scroll_screen2_to(x, y) ws_display_scroll_screen_to(1, (x), (y))
289
297void ws_display_scroll_screen_by(uint8_t screen, int16_t x, int16_t y);
298
306static inline uint8_t ws_display_get_current_line(void) {
307 return inportb(WS_DISPLAY_LINE_PORT);
308}
309
316static inline void ws_display_scroll_screen1_by(uint8_t x, uint8_t y) {
317 __asm (
318 "in $0x10, %%ax\nadd %0, %%al\nadd %1, %%ah\nout %%ax, $0x10"
319 : : "g"(x), "g"(y) : "a", "cc"
320 );
321}
322
329static inline void ws_display_scroll_screen2_by(uint8_t x, uint8_t y) {
330 __asm (
331 "in $0x12, %%ax\nadd %0, %%al\nadd %1, %%ah\nout %%ax, $0x12"
332 : : "g"(x), "g"(y) : "a", "cc"
333 );
334}
335
347static inline void ws_display_set_icons(uint8_t mask) {
348 outportb(WS_LCD_ICON_PORT, mask);
349}
350
362static inline void ws_display_show_icons(uint8_t mask) {
363 outportb(WS_LCD_ICON_PORT, inportb(WS_LCD_ICON_PORT) | mask);
364}
365
377static inline void ws_display_hide_icons(uint8_t mask) {
378 outportb(WS_LCD_ICON_PORT, inportb(WS_LCD_ICON_PORT) & ~mask);
379}
380
392static inline void ws_display_toggle_icons(uint8_t mask) {
393 outportb(WS_LCD_ICON_PORT, inportb(WS_LCD_ICON_PORT) ^ mask);
394}
395
403__attribute__((no_assume_ds_data, no_assume_ss_data, save_all))
404void ws_display_set_shade_lut(uint32_t lut);
405
416static inline void ws_screen_put_tiles(void ws_iram *dest, const void __far *src, uint16_t x, uint16_t y, uint16_t width, uint16_t height) {
417 void __libws_screen_put_tiles(void ws_iram *dest, const void __far *src, uint16_t x, uint16_t y, uint16_t width, uint16_t height, uint16_t pitch);
418 __libws_screen_put_tiles(dest, src, x, y, width, height, width);
419}
420
435static inline void ws_screen_put_tiles_ex(void ws_iram *dest, const void __far *src, uint16_t sx, uint16_t sy, uint16_t pitch, uint16_t dx, uint16_t dy, uint16_t width, uint16_t height) {
436 void __libws_screen_put_tiles(void ws_iram *dest, const void __far *src, uint16_t x, uint16_t y, uint16_t width, uint16_t height, uint16_t pitch);
437 __libws_screen_put_tiles(dest, ((const uint16_t __far*) src) + (sy * pitch) + sx, dx, dy, width, height, pitch);
438}
439
450void ws_screen_get_tiles(void __far *dest, const void ws_iram *src, uint16_t x, uint16_t y, uint16_t width, uint16_t height);
451
462void ws_screen_fill_tiles(void ws_iram *dest, uint16_t src, uint16_t x, uint16_t y, uint16_t width, uint16_t height);
463
475void ws_screen_modify_tiles(void ws_iram *dest, uint16_t mask, uint16_t value, uint16_t x, uint16_t y, uint16_t width, uint16_t height);
476
485static inline void ws_screen_put_tile(void ws_iram *dest, uint16_t src, uint16_t x, uint16_t y) {
486 ((uint16_t ws_iram*) dest)[((y & 0x1F) << 5) | (x & 0x1F)] = src;
487}
488
496static inline uint16_t ws_screen_get_tile(void ws_iram *src, uint16_t x, uint16_t y) {
497 return ((uint16_t ws_iram*) src)[((y & 0x1F) << 5) | (x & 0x1F)];
498}
499
501
502#endif /* LIBWS_DISPLAY_H_ */
static void ws_display_scroll_screen1_by(uint8_t x, uint8_t y)
Scroll screen 1 by a specified number of pixels.
Definition display.h:316
static void ws_display_set_screen2_window(uint8_t x, uint8_t y, uint8_t width, uint8_t height)
Set the position and size of the screen 2 window.
Definition display.h:219
static void ws_screen_put_tiles_ex(void ws_iram *dest, const void __far *src, uint16_t sx, uint16_t sy, uint16_t pitch, uint16_t dx, uint16_t dy, uint16_t width, uint16_t height)
Place a map of tiles on the screen. This varianta llows specifying the source X position,...
Definition display.h:435
static void ws_display_toggle_icons(uint8_t mask)
Toggle specified LCD icons.
Definition display.h:392
static void ws_display_set_sprite_address(const void __wf_iram *address)
Set the base addresses of the sprite table.
Definition display.h:207
__attribute__((no_assume_ds_data, no_assume_ss_data, save_all)) void ws_display_set_shade_lut(uint32_t lut)
Configure the shade LUT.
static void ws_display_scroll_screen2_by(uint8_t x, uint8_t y)
Scroll screen 2 by a specified number of pixels.
Definition display.h:329
void ws_display_scroll_screen_by(uint8_t screen, int16_t x, int16_t y)
Scroll the specified screen by a specified number of pixels.
static void ws_screen_put_tile(void ws_iram *dest, uint16_t src, uint16_t x, uint16_t y)
Put a tile on the screen.
Definition display.h:485
static void ws_display_set_icons(uint8_t mask)
Set the list of displayed LCD icons, clearing any unspecified icons.
Definition display.h:347
static void ws_display_set_screen_address(uint8_t screen, const void __wf_iram *address)
Set the base addresses of the specified screen.
Definition display.h:184
void ws_screen_fill_tiles(void ws_iram *dest, uint16_t src, uint16_t x, uint16_t y, uint16_t width, uint16_t height)
Fill an area on the screen with a given tile.
static void ws_display_scroll_screen_to(uint8_t screen, uint8_t x, uint8_t y)
Scroll the specified screen to a specified location.
Definition display.h:270
static void ws_display_set_screen2_window_corners(uint8_t left, uint8_t top, uint8_t right, uint8_t bottom)
Set the corners of the screen 2 window.
Definition display.h:232
static void ws_display_hide_icons(uint8_t mask)
Hide specified LCD icons.
Definition display.h:377
static uint16_t ws_screen_get_tile(void ws_iram *src, uint16_t x, uint16_t y)
Get a tile on the screen.
Definition display.h:496
void ws_screen_get_tiles(void __far *dest, const void ws_iram *src, uint16_t x, uint16_t y, uint16_t width, uint16_t height)
Copy a map of tiles from the screen.
static void ws_display_show_icons(uint8_t mask)
Show specified LCD icons.
Definition display.h:362
static void ws_screen_put_tiles(void ws_iram *dest, const void __far *src, uint16_t x, uint16_t y, uint16_t width, uint16_t height)
Place a map of tiles on the screen.
Definition display.h:416
static void ws_display_set_sprite_window(uint8_t x, uint8_t y, uint8_t width, uint8_t height)
Set the position and size of the sprite window.
Definition display.h:245
void ws_screen_modify_tiles(void ws_iram *dest, uint16_t mask, uint16_t value, uint16_t x, uint16_t y, uint16_t width, uint16_t height)
Modify an area on the screen with given data.
static void ws_display_set_screen_addresses(const void __wf_iram *scr1_addr, const void __wf_iram *scr2_addr)
Set the base addresses of screens 1 and 2.
Definition display.h:174
static uint8_t ws_display_get_current_line(void)
Get the line currently being drawn to the line buffer.
Definition display.h:306
#define WS_DISPLAY_TILE_HEIGHT
Definition display.h:47
static void ws_display_set_sprite_window_corners(uint8_t left, uint8_t top, uint8_t right, uint8_t bottom)
Set the corners of the sprite window.
Definition display.h:258
#define WS_SCR2_WIN_X2_PORT
Definition ports.h:242
#define WS_SPR_BASE_PORT
Definition ports.h:209
#define WS_SPR_BASE_ADDR(n)
Definition ports.h:210
#define WS_SPR_WIN_X1_PORT
Definition ports.h:252
#define WS_DISPLAY_LINE_PORT
Definition ports.h:199
#define WS_SCR1_SCRL_X_PORT
Definition ports.h:272
#define WS_SCR_BASE_ADDR1(n)
Definition ports.h:226
#define WS_SCR_BASE_ADDR2(n)
Definition ports.h:227
#define WS_SPR_WIN_X2_PORT
Definition ports.h:262
#define WS_LCD_ICON_PORT
Definition ports.h:305
#define WS_SCR2_WIN_X1_PORT
Definition ports.h:232
#define WS_SCR_BASE_PORT
Definition ports.h:225
#define ws_iram
Definition memory.h:46
uint32_t row[WS_DISPLAY_TILE_HEIGHT]
Definition display.h:56
uint16_t row[WS_DISPLAY_TILE_HEIGHT]
Definition display.h:52
uint8_t x
Definition display.h:82
uint8_t y
Definition display.h:81
uint16_t attr
Definition display.h:80