vdc.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 Adrian "asie" Siekierka
 *
 * Licensed under the Apache License, Version 2.0 with LLVM Exceptions,
 * See https://github.com/llvm-mos/llvm-mos-sdk/blob/main/LICENSE for license
 * information.
 */
 
#ifndef _PCE_VDC_H_
#define _PCE_VDC_H_
 
#include <stdbool.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define VDC_SPRITE_COLOR(n) ((n))
#define VDC_SPRITE_COLOR_MASK (0xF)
#define VDC_SPRITE_BG 0
#define VDC_SPRITE_FG (0x1 << 7)
#define VDC_SPRITE_WIDTH_16 0
#define VDC_SPRITE_WIDTH_32 (0x1 << 8)
#define VDC_SPRITE_WIDTH_MASK (0x1 << 8)
#define VDC_SPRITE_HEIGHT_16 0
#define VDC_SPRITE_HEIGHT_32 (0x1 << 12)
#define VDC_SPRITE_HEIGHT_64 (0x3 << 12)
#define VDC_SPRITE_HEIGHT_MASK (0x3 << 12)
#define VDC_SPRITE_FLIP_X (0x1 << 11)
#define VDC_SPRITE_FLIP_Y (0x1 << 15)
 
typedef struct {
  uint16_t y;
  uint16_t x;
  uint16_t pattern;
  uint16_t attr;
} vdc_sprite_t;
 
uint16_t pce_vdc_peek(uint8_t index);
 
void pce_vdc_poke(uint8_t index, uint16_t data);
 
void pce_vdc_set_copy_word(void);
void pce_vdc_set_copy_row(void);
 
void pce_vdc_set_copy_32_words(void);
void pce_vdc_set_copy_column_32(void);
 
void pce_vdc_set_copy_64_words(void);
void pce_vdc_set_copy_column_64(void);
 
void pce_vdc_set_copy_128_words(void);
void pce_vdc_set_copy_column_128(void);
 
void pce_vdc_copy_to_vram(uint16_t dest, const void *source, uint16_t length);
 
void pce_vdc_copy_from_vram(void *dest, uint16_t source, uint16_t length);
 
void pce_vdc_dma_start(uint8_t mode, uint16_t source, uint16_t dest,
                       uint16_t length);
 
bool pce_vdc_dma_finished(void);
 
void pce_vdc_set_width_tiles(uint8_t tiles, uint8_t vce_flags);
void pce_vdc_set_width(uint16_t pixels, uint8_t vce_flags);
 
void pce_vdc_set_height(uint8_t lines);
void pce_vdc_set_resolution(uint16_t width_pixels, uint8_t height_pixels,
                            uint8_t vce_flags);
 
void pce_vdc_bg_set_size(uint8_t value);
 
void pce_vdc_sprite_set_table_start(uint16_t loc);
 
void pce_vdc_enable(uint8_t value);
 
void pce_vdc_disable(uint8_t value);
 
void pce_vdc_bg_enable(void);
 
void pce_vdc_bg_disable(void);
 
void pce_vdc_sprite_enable(void);
 
void pce_vdc_sprite_disable(void);
 
void pce_vdc_irq_scanline_enable(void);
 
void pce_vdc_irq_scanline_disable(void);
 
void pce_vdc_irq_sprite_collide_enable(void);
 
void pce_vdc_irq_sprite_collide_disable(void);
 
void pce_vdc_irq_sprite_overflow_enable(void);
 
void pce_vdc_irq_sprite_overflow_disable(void);
 
void pce_vdc_irq_vblank_enable(void);
 
void pce_vdc_irq_vblank_disable(void);
 
bool pce_sgx_detect(void);
 
void pce_sgx_vdc_init(void);
 
void pce_sgx_vdc1_set(void);
 
void pce_sgx_vdc2_set(void);
 
void pce_sgx_vdc_set(uint8_t id);
 
volatile uint8_t *pce_sgx_vdc_get_index(void);
 
volatile uint16_t *pce_sgx_vdc_get_data(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* _PCE_VDC_H_ */