git.sur5r.net Git - cc65/blob - include/atari.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 atari.h                                   */
   4 /*                                                                           */
   5 /*                      Atari system specific definitions                    */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2000-2006 Mark Keates <markk@dendrite.co.uk>                          */
  10 /*               Freddy Offenga <taf_offenga@yahoo.com>                      */
  11 /*               Christian Groessler <cpg@aladdin.de>                        */
  12 /*                                                                           */
  13 /*                                                                           */
  14 /* This software is provided 'as-is', without any expressed or implied       */
  15 /* warranty.  In no event will the authors be held liable for any damages    */
  16 /* arising from the use of this software.                                    */
  17 /*                                                                           */
  18 /* Permission is granted to anyone to use this software for any purpose,     */
  19 /* including commercial applications, and to alter it and redistribute it    */
  20 /* freely, subject to the following restrictions:                            */
  21 /*                                                                           */
  22 /* 1. The origin of this software must not be misrepresented; you must not   */
  23 /*    claim that you wrote the original software. If you use this software   */
  24 /*    in a product, an acknowledgment in the product documentation would be  */
  25 /*    appreciated but is not required.                                       */
  26 /* 2. Altered source versions must be plainly marked as such, and must not   */
  27 /*    be misrepresented as being the original software.                      */
  28 /* 3. This notice may not be removed or altered from any source              */
  29 /*    distribution.                                                          */
  30 /*                                                                           */
  31 /*****************************************************************************/
  32
  33
  34
  35 #ifndef _ATARI_H
  36 #define _ATARI_H
  37
  38
  39
  40 /* Check for errors */
  41 #if !defined(__ATARI__)
  42 #  error This module may only be used when compiling for the Atari!
  43 #endif
  44
  45
  46
  47 /* Character codes */
  48 #define CH_DELCHR       0xFE   /* delete char under the cursor */
  49 #define CH_ESC          0x1B
  50 #define CH_CURS_UP      28
  51 #define CH_CURS_DOWN    29
  52 #define CH_CURS_LEFT    30
  53 #define CH_CURS_RIGHT   31
  54
  55 #define CH_TAB          0x7F   /* tabulator */
  56 #define CH_EOL          0x9B   /* end-of-line marker */
  57 #define CH_CLR          0x7D   /* clear screen */
  58 #define CH_BEL          0xFD   /* bell */
  59 #define CH_DEL          0x7E   /* back space (delete char to the left) */
  60 #define CH_RUBOUT       0x7E   /* back space (old, deprecated) */
  61 #define CH_DELLINE      0x9C   /* delete line */
  62 #define CH_INSLINE      0x9D   /* insert line */
  63
  64 /* These are defined to be Atari + NumberKey */
  65 #define CH_F1           177
  66 #define CH_F2           178
  67 #define CH_F3           179
  68 #define CH_F4           180
  69 #define CH_F5           181
  70 #define CH_F6           182
  71 #define CH_F7           183
  72 #define CH_F8           184
  73 #define CH_F9           185
  74 #define CH_F10          176
  75
  76 #define CH_ULCORNER     0x11
  77 #define CH_URCORNER     0x05
  78 #define CH_LLCORNER     0x1A
  79 #define CH_LRCORNER     0x03
  80 #define CH_TTEE         0x17
  81 #define CH_BTEE         0x18
  82 #define CH_LTEE         0x01
  83 #define CH_RTEE         0x04
  84 #define CH_CROSS        0x13
  85 #define CH_HLINE        0x12
  86 #define CH_VLINE        0x7C
  87
  88 /* color defines */
  89
  90 /* make GTIA color value */
  91 #define _gtia_mkcolor(hue,lum) (((hue) << 4) | ((lum) << 1))
  92
  93 /* luminance values go from 0 (black) to 7 (white) */
  94
  95 /* hue values */
  96 #define HUE_GREY        0
  97 #define HUE_GOLD        1
  98 #define HUE_GOLDORANGE  2
  99 #define HUE_REDORANGE   3
 100 #define HUE_ORANGE      4
 101 #define HUE_MAGENTA     5
 102 #define HUE_PURPLE      6
 103 #define HUE_BLUE        7
 104 #define HUE_BLUE2       8
 105 #define HUE_CYAN        9
 106 #define HUE_BLUEGREEN   10
 107 #define HUE_BLUEGREEN2  11
 108 #define HUE_GREEN       12
 109 #define HUE_YELLOWGREEN 13
 110 #define HUE_YELLOW      14
 111 #define HUE_YELLOWRED   15
 112
 113 /* Color defines, similar to c64 colors (untested) */
 114 /* Note that the conio color implementation is monochrome (bgcolor and textcolor are only placeholders) */
 115 /* Use the defines with the setcolor() or _atari_xxxcolor() functions */
 116 #define COLOR_BLACK             _gtia_mkcolor(HUE_GREY,0)
 117 #define COLOR_WHITE             _gtia_mkcolor(HUE_GREY,7)
 118 #define COLOR_RED               _gtia_mkcolor(HUE_REDORANGE,1)
 119 #define COLOR_CYAN              _gtia_mkcolor(HUE_CYAN,3)
 120 #define COLOR_VIOLET            _gtia_mkcolor(HUE_PURPLE,4)
 121 #define COLOR_GREEN             _gtia_mkcolor(HUE_GREEN,2)
 122 #define COLOR_BLUE              _gtia_mkcolor(HUE_BLUE,2)
 123 #define COLOR_YELLOW            _gtia_mkcolor(HUE_YELLOW,7)
 124 #define COLOR_ORANGE            _gtia_mkcolor(HUE_ORANGE,5)
 125 #define COLOR_BROWN             _gtia_mkcolor(HUE_YELLOW,2)
 126 #define COLOR_LIGHTRED          _gtia_mkcolor(HUE_REDORANGE,6)
 127 #define COLOR_GRAY1             _gtia_mkcolor(HUE_GREY,2)
 128 #define COLOR_GRAY2             _gtia_mkcolor(HUE_GREY,3)
 129 #define COLOR_LIGHTGREEN        _gtia_mkcolor(HUE_GREEN,6)
 130 #define COLOR_LIGHTBLUE         _gtia_mkcolor(HUE_BLUE,6)
 131 #define COLOR_GRAY3             _gtia_mkcolor(HUE_GREY,5)
 132
 133 /* color register functions */
 134 extern void __fastcall__ _setcolor     (unsigned char color_reg, unsigned char hue, unsigned char luminace);
 135 extern void __fastcall__ _setcolor_low (unsigned char color_reg, unsigned char color_value);
 136 extern unsigned char __fastcall__ _getcolor (unsigned char color_reg);
 137
 138 /* other screen functions */
 139 extern int  __fastcall__ _graphics (unsigned char mode); /* mode value same as in BASIC */
 140 extern void __fastcall__ _scroll (signed char numlines);
 141                                           /* numlines > 0  scrolls up */
 142                                           /* numlines < 0  scrolls down */
 143
 144 /* misc. functions */
 145 extern unsigned char get_ostype(void);  /* get ROM version */
 146 extern unsigned char get_tv(void);      /* get TV system */
 147 extern void _save_vecs(void);           /* save system vectors */
 148 extern void _rest_vecs(void);           /* restore system vectors */
 149 extern char *_getdefdev(void);          /* get default floppy device */
 150
 151 /* global variables */
 152 extern unsigned char _dos_type;        /* the DOS flavour */
 153
 154 /* provide old names for backwards compatibility */
 155 #ifdef ATARI_COMPAT_PRE_2_11
 156 #define setcolor     _setcolor
 157 #define setcolor_low _setcolor_low
 158 #define getcolor     _getcolor
 159 #define graphics     _graphics
 160 #define scroll       _scroll
 161 #define save_vecs    _save_vecs
 162 #define rest_vecs    _rest_vecs
 163 #define getdefdev    _getdefdev
 164 #endif  /* #ifdef ATARI_COMPAT_PRE_2_11 */
 165
 166 /* get_ostype return value defines (for explanation, see ostype.s) */
 167 /* masks */
 168 #define AT_OS_TYPE_MAIN  7
 169 #define AT_OS_TYPE_MINOR (7 << 3)
 170 /* AT_OS_TYPE_MAIN values */
 171 #define AT_OS_UNKNOWN  0
 172 #define AT_OS_400800   1
 173 #define AT_OS_1200XL   2
 174 #define AT_OS_XLXE     3
 175 /* AS_OS_TYPE_MINOR values */
 176 /* for 400/800 remember this are the ROM versions */
 177 /* to check whether the hw is PAL or NTSC, use get_tv() */
 178 #define AT_OS_400800PAL_A  1
 179 #define AT_OS_400800PAL_B  2
 180 #define AT_OS_400800NTSC_A 1
 181 #define AT_OS_400800NTSC_B 2
 182 #define AT_OS_1200_10  1
 183 #define AT_OS_1200_11  2
 184 #define AT_OS_XLXE_1   1
 185 #define AT_OS_XLXE_2   2
 186 #define AT_OS_XLXE_3   3
 187 #define AT_OS_XLXE_4   4
 188
 189 /* get_tv return values */
 190 #define AT_NTSC     0
 191 #define AT_PAL      1
 192
 193 /* valid _dos_type values */
 194 #define ATARIDOS    0
 195 #define SPARTADOS   1
 196 #define OSADOS      2
 197 #define MYDOS       3
 198 #define NODOS       255
 199
 200 /* Define hardware */
 201 #include <_gtia.h>
 202 #define GTIA_READ  (*(struct __gtia_read*)0xD000)
 203 #define GTIA_WRITE (*(struct __gtia_write*)0xD000)
 204
 205 #include <_pbi.h>
 206
 207 #include <_pokey.h>
 208 #define POKEY_READ  (*(struct __pokey_read*)0xD200)
 209 #define POKEY_WRITE (*(struct __pokey_write*)0xD200)
 210
 211 #include <_pia.h>
 212 #define PIA (*(struct __pia*)0xD300)
 213
 214 #include <_antic.h>
 215 #define ANTIC (*(struct __antic*)0xD400)
 216
 217 /* device control block */
 218 struct __dcb {
 219     unsigned char device;     /* device id */
 220     unsigned char unit;       /* unit number */
 221     unsigned char command;    /* command */
 222     unsigned char status;     /* command type / status return */
 223     void          *buffer;    /* pointer to buffer */
 224     unsigned char timeout;    /* device timeout in seconds */
 225     unsigned char unused;
 226     unsigned int  xfersize;   /* # of bytes to transfer */
 227     unsigned char aux1;       /* 1st command auxiliary byte */
 228     unsigned char aux2;       /* 2nd command auxiliary byte */
 229 };
 230 #define DCB (*(struct __dcb *)0x300)
 231
 232 /* I/O control block */
 233 struct __iocb {
 234     unsigned char handler;    /* handler index number (0xff free) */
 235     unsigned char drive;      /* device number (drive) */
 236     unsigned char command;    /* command */
 237     unsigned char status;     /* status of last operation */
 238     void          *buffer;    /* pointer to buffer */
 239     void          *put_byte;  /* pointer to device's PUT BYTE routine */
 240     unsigned int  buflen;     /* length of buffer */
 241     unsigned char aux1;       /* 1st auxiliary byte */
 242     unsigned char aux2;       /* 2nd auxiliary byte */
 243     unsigned char aux3;       /* 3rd auxiliary byte */
 244     unsigned char aux4;       /* 4th auxiliary byte */
 245     unsigned char aux5;       /* 5th auxiliary byte */
 246     unsigned char spare;      /* spare byte */
 247 };
 248 #define ZIOCB (*(struct __iocb *)0x20)  /* zero page IOCB */
 249 #define IOCB (*(struct __iocb *)0x340)  /* system IOCB buffers */
 250
 251 /* End of atari.h */
 252 #endif /* #ifndef _ATARI_H */