vgatext.h

Go to the documentation of this file.

#ifndef __VGATEXT_H
#define __VGATEXT_H

#ifdef __cplusplus
extern "C"
{
#endif

#include "simpletext.h"

/*
 * This defines vgatext as a type alias to text_t
 * Spelling is choice of Parallax education, not the author.
 */
typedef text_t vgatext;

#define VGA_TEXT_WHITE_BLUE     0
#define VGA_TEXT_YELLOW_BROWN   1
#define VGA_TEXT_MAGENTA_BLACK  2
#define VGA_TEXT_GREY_WHITE     3
#define VGA_TEXT_CYAN_DARKCYAN  4
#define VGA_TEXT_GREEN_WHITE    5
#define VGA_TEST_RED_PINK       6
#define VGA_TEXT_CYAN_BLUE      7

#define VGA_TEXT_COLORS 8

#define VGA_TEXT_PAL_WHITE_BLUE     0
#define VGA_TEXT_PAL_YELLOW_BROWN   2
#define VGA_TEXT_PAL_MAGENTA_BLACK  4
#define VGA_TEXT_PAL_GREY_WHITE     6
#define VGA_TEXT_PAL_CYAN_DARKCYAN  8
#define VGA_TEXT_PAL_GREEN_WHITE    10
#define VGA_TEST_PAL_RED_PINK       12
#define VGA_TEXT_PAL_CYAN_BLUE      14


#define VGA_TEXT_COLORTABLE_SIZE 8*2

#define  VGA_TEXT_COLS 30

#define  VGA_TEXT_ROWS 14

#define  VGA_TEXT_SCREENSIZE (VGA_TEXT_COLS * VGA_TEXT_ROWS)

#define  VGA_TEXT_LASTROW (VGA_TEXT_SCREENSIZE-VGA_TEXT_COLS)

typedef enum {
    VGA_TEXT_STAT_DISABLED,
    VGA_TEXT_STAT_INVISIBLE,
    VGA_TEXT_STAT_VISIBLE
} vgaTextStat_t;

typedef struct _vga_text_struct
{
    long status    ; // 0/1/2 = off/visible/invisible      read-only   (21 longs)
    long enable    ; // 0/non-0 = off/on                   write-only
    long pins      ; // %pppttt = pins                     write-only
    long mode      ; // %tihv = tile,interlace,hpol,vpol   write-only
    long screen    ; // pointer to screen (words)          write-only
    long colors    ; // pointer to colors (longs)          write-only            
    long ht        ; // horizontal tiles                   write-only
    long vt        ; // vertical tiles                     write-only
    long hx        ; // horizontal tile expansion          write-only
    long vx        ; // vertical tile expansion            write-only
    long ho        ; // horizontal offset                  write-only
    long vo        ; // vertical offset                    write-only
    long hd        ; // horizontal display ticks           write-only
    long hf        ; // horizontal front porch ticks       write-only
    long hs        ; // horizontal sync ticks              write-only
    long hb        ; // horizontal back porch ticks        write-only
    long vd        ; // vertical display lines             write-only
    long vf        ; // vertical front porch lines         write-only
    long vs        ; // vertical sync lines                write-only
    long vb        ; // vertical back porch lines          write-only
    long rate      ; // tick rate (Hz)                     write-only
    char *palette  ; // color palette
} vgatextdev_t;

/*
 * Starts VGA on a cog
 * @param basepin is first pin number (out of 8) connected to VGA
 * param clockrate is the clockrate defined for the platform.
 * @returns non-zero cogid on success
 */
int     vgatext_start(volatile vgatextdev_t* vga, int basepin);

/*
 * VGA_Text stop function stops VGA cog
 * @param id is cog id returned from start function.
 */
void    vgatext_stop(int id);

/*
 * VGA_Text public API
 */

vgatext *vgatext_open(int basepin);

void    vgatext_close(vgatext *device);

int     vgatext_out(int c);

int    vgatext_putchar(vgatext *vga, int c);

void    vgatext_setColorPalette(char* palette);

void vgatext_clear(void);

void vgatext_home(void);


void vgatext_clearEOL(void);


void    vgatext_setXY(int x, int y);

void    vgatext_setX(int x);

void    vgatext_setY(int y);

void    vgatext_setCoordPosition(int x, int y);

int vgatext_getX(void);

int vgatext_getY(void);

void vgatext_setColors(int value);

int vgatext_getColors(void);

int vgatext_getColumns(void);

int vgatext_getRows(void);

#ifdef __cplusplus
}
#endif

#endif
//__VGATEXT_H