Contents

• Overview
• Getting Started
• A Basic KOS Program
  • A Note on C++ Compatibility
  
  
• The Fully Portable Subsystems
  • Data Types
  • ANSI C library
  • VFS (Virtual File System)
    • file_t fs_open(const char * fn, int mode)
    • void fs_close(file_t hnd)
    • ssize_t fs_read(file_t hnd, void * buffer, size_t cnt)
    • ssize_t fs_write(file_t hnd, const void * buffer, size_t cnt)
    • off_t fs_seek(file_t hnd, off_t offset, int whence)
    • off_t fs_tell(file_t hnd)
    • size_t fs_total(file_t hnd)
    • dirent_t * fs_readdir(file_t hnd)
    • int fs_ioctl(file_t hnd, void * data, size_t size)
    • int fs_rename(const char * fn1, const char * fn2)
    • int fs_unlink(const char * fn)
    • int fs_chdir(const char * fn)
    • void * fs_mmap(file_t hnd)
    • const char * fs_getwd()
    • int fs_handler_add(const char * prefix, vfs_handler * hnd)
    • int fs_handler_remove(const vfs_handler * hnd)
  • File System: fs_builtin
  • File System: fs_romdisk
  • Memory Allocation System
  • Network System
    • int net_input(netif_t * device, const uint8 * data, int len)
    • net_input_func net_input_set_target(net_input_func t)
    • int net_reg_device(netif_t * device)
    • int net_unreg_device(netif_t * device)
  • Thread System
    • kthread_t * thd_create(void (* routine)(void * param), void * param)
    • int thd_destroy(kthread_t * thd)
    • void thd_exit()
    • void thd_schedule()
    • void thd_schedule_next(kthread_t * thd)
    • void thd_pass()
    • void thd_sleep(int ms)
    • int thd_set_prio(kthread_t * thd, prio_t prio)
    • kthread_t * thd_get_current()
    • const char * thd_get_label(kthread_t * thd)
    • void thd_set_label(kthread_t * thd, const char * label)
    • const char * thd_get_pwd(kthread_t * thd)
    • void thd_set_pwd(kthread_t * thd, const char * pwd)
  • Sync Objects: Semaphore
    • semaphore_t * sem_create(int value)
    • void sem_destroy(semaphore_t * sem)
    • void sem_wait(semaphore_t * sem)
    • int sem_wait_timed(semaphore_t * sem, int timeout)
    • void sem_signal(semaphore_t * sem)
    • int sem_count(semaphore_t * sem)
  • Sync Objects: Condition Variable
    • condvar_t * cond_create()
    • void cond_destroy(condvar_t * cv)
    • void cond_wait(condvar_t * cv)
    • void cond_signal(condvar_t * cv)
  • Platform-Independent Images
  
  
• Hardware Abstraction Layer: Portable Parts
  • C/C++ Runtime
  • Misc Program Control Calls
  • Bootstrap Debug Input/Output
    • dbgio_printk_func dbgio_set_printk(dbgio_printk_func func)
    • void dbgio_set_parameters(int baud, int fifo)
    • void dbgio_write(int c)
    • void dbgio_flush()
    • void dbgio_write_buffer(const uint8 * data, int len)
    • void dbgio_read_buffer(uint8 * data, int len)
    • void dbgio_write_str(const char * str)
    • int dbgio_read()
    • void dbgio_disable()
    • void dbgio_enable()
    • int dbgio_printf(const char * fmt, ...)
  • IRQ/Context Management
    • int irq_inside_int()
    • void irq_force_return()
    • int irq_set_handler(irq_t source, irq_handler hnd)
    • int irq_set_global_handler(irq_handler hnd)
    • void irq_set_context(irq_context_t *regbank)
    • irq_context_t * irq_get_context()
    • void irq_create_context(irq_context_t * context, uint32 stack_pointer, uint32 routine, uint32 * args, int usermode)
    • int irq_disable()
    • void irq_enable()
    • void irq_restore(int v)
  • Realtime Clock (RTC) Management
  • Basic Memory Management
    • time_t rtc_unix_secs()
  • MMU Management
  • Timer Management
    • Totally Portable Parts
    • DC Parts
  • Cache Coherency Management
    • void icache_flush_range(uint32 start, uint32 count)
    • void dcache_inval_range(uint32 start, uint32 count)
    • void dcache_flush_range(uint32 start, uint32 count)
  • Program Image Replacement
    • void arch_exec_at(const void * image, uint32 length, uint32 address)
    • void arch_exec(const void * image, uint32 length)
  • Syscall
    • void syscall_set_return(irq_context_t * context, int value)
    • SET_RETURN(thread, value)
    • SET_MY_RETURN(value)
    • RETURN(value
    • SYSCALL(routine)
  • Spinlocks
    • void spinlock_init(spinlock_t * lock)
    • void spinlock_lock(spinlock_t * lock)
    • void spinlock_unlock(spinlock_t * lock)
    • int spinlock_is_locked(spinlock_t * lock)
  • PI API for Sound
    • int snd_mem_init(uint32 reserve)
    • void snd_mem_shutdown()
    • uint32 snd_mem_malloc(size_t size)
    • void snd_mem_free(uint32 addr)
    • uint32 snd_mem_available()
    • int snd_init()
    • void snd_shutdown()
    • int snd_sfx_load(const char * fn)
    • void snd_sfx_unload(int idx)
    • void snd_sfx_unload_all()
    • void snd_sfx_play(int idx, int vol, int pan)
    • int snd_stream_init(void* (* callback)(int, int *))
    • void snd_stream_shutdown()
    • void snd_stream_set_callback(void *(*func)(int req, int *ret))
    • void snd_stream_queue_enable()
    • void snd_stream_queue_disable()
    • void snd_stream_queue_go()
    • void snd_stream_start(uint32 freq, int st)
    • void snd_stream_stop()
    • int snd_stream_poll()
    • void snd_stream_volume(int vol)
  
  
• Hardware Abstraction Layer: DC Parts; OUT OF DATE
  • Basic Video (video.c)
    • uint32 *vram_l
    • uint32 *vram_s
    • int vram_config
    • int vram_size
    • int vid_cable_type
    • int vid_check_cable()
    • int vid_init(int cable_type, int disp_mode, int pixel_mode)
    • void vid_set_start(uint32 start)
    • void vid_border_color(int r, int g, int b)
    • void vid_clear(int r, int g, int b)
    • void vid_empty()
    • void vid_waitvbl()
  • BIOS Fonts (biosfont.c)
    • void* bfont_find_char(int ch)
    • void bfont_draw(uint16 *buffer, int bufwidth, int c)
    • void bfont_draw_str(uint16 *buffer, int bufwidth, char *str)
  • PC Fonts (font.c)
  • Sound Processor Unit (spu.c)
    • SMP_BASE
    • void snd_ram_write_wait()
    • void snd_load_arm(void *src, int size)
    • void snd_stop_arm()
    • void snd_init()
    • void snd_load(void *src, int dest, int len)
  • CD-Rom Access (cdfs.c)
    • uint32 iso_open(const char *path, int oflag)
    • void iso_close(uint32 fd)
    • int iso_read(uint32 fd, void *buf, int count)
    • long iso_lseek(uint32 fd, long offset, int whence)
    • long iso_tell(uint32 fd)
    • dirent_t *iso_readdir(uint32 dirfd)
    • int cdrom_init() int iso_init()
  • Timer Counters (timer.c)
    • TMU0, TMU1, TMU2, WDT
    • int timer_prime(int which, uint32 speed)
    • int timer_start(int which)
    • int timer_stop(int which)
    • uint32 timer_count(int which)
    • int timer_clear(int which)
    • void timer_sleep(int ms)
    • int timer_init()
  • Maple Access (maple.c)
    • void maple_init(int quiet)
    • void maple_shutdown()
    • uint8 maple_create_addr(uint8 port, uint8 unit)
    • int maple_docmd_block(...)
    • int maple_rescan_bus(int quiet)
    • uint8 maple_device_addr(int code)
    • uint8 maple_*_addr()
  • Maple Peripheral Support Modules
    • int cont_get_cond(uint8 addr, cont_cond_t *cond)
    • int kbd_get_cond(uint8 addr, kbd_cond_t *cond)
    • int vmu_draw_lcd(uint8 addr, void *bitmap)
    • int vmu_block_read(uint8 addr, uint16 blocknum, uint8 *buffer)
    • int vmu_block_write(uint8 addr, uint16 blocknum, uint8 *buffer)
    • int mouse_get_cond(uint8 addr, mouse_cond_t *cond)
  • Tile Accelerator (ta.c)
    • struct pv_str ta_page_values[2]
    • bkg_poly ta_bkg
    • poly_hdr_t
    • vertex_oc_t
    • vertex_ot_t
    • int ta_curpage
    • void ta_init()
    • void ta_send_queue(void *sql, int size)
    • void ta_begin_render()
    • void ta_commit_poly_hdr(poly_hdr_t *polyhdr)
    • void ta_commit_vertex(void *vertex, int size)
    • void ta_commit_eol()
    • void ta_finish_frame()
    • void ta_build_poly_hdr(poly_hdr_t *target, ...)
    • void ta_load_texture(uint32 dest, void *src, int size)
    • void *ta_texture_map(uint32 loc)
  
  
• DC Add-On Libraries
  • libconio - console
  • libdcplib - fonts for PVR
  • libdcutils - misc utility functions
  • libimageload - image loader / ditherer
  • libjpeg (KOS specific parts)
  • libmodplug (KOS specific parts)
  • libmp3 - mp3 playback lib
  • liboggvorbisplay - ogg playback lib
  • libpcx - PCX loader
  • libpng (KOS specific parts)
  • libtga - TGA loader
  • lua (KOS specific parts)
  • lwip (KOS specific parts)
  
  
• About this document