]> git.sur5r.net Git - cc65/blob - include/atari.h
0840468fd0d56b8e4230d6b17338d8505eef414f
[cc65] / include / atari.h
1 /*****************************************************************************/
2 /*                                                                           */
3 /*                                 atari.h                                   */
4 /*                                                                           */
5 /*                      Atari system specific definitions                    */
6 /*                                                                           */
7 /*                                                                           */
8 /*                                                                           */
9 /* (C) 2000 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_DEL          0xFE
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_RUBOUT       0x7E   /* back space (rubout) */
60 #define CH_DELLINE      0x9C   /* delete line */
61 #define CH_INSLINE      0x9D   /* insert line */
62
63 /* These are defined to be Atari + NumberKey */
64 #define CH_F1           177
65 #define CH_F2           178
66 #define CH_F3           179
67 #define CH_F4           180
68 #define CH_F5           181
69 #define CH_F6           182
70 #define CH_F7           183
71 #define CH_F8           184
72 #define CH_F9           185
73 #define CH_F10          176
74
75 #define CH_ULCORNER     0x11
76 #define CH_URCORNER     0x05
77 #define CH_LLCORNER     0x1A
78 #define CH_LRCORNER     0x03
79 #define CH_TTEE         0x17
80 #define CH_BTEE         0x18
81 #define CH_LTEE         0x01
82 #define CH_RTEE         0x04
83 #define CH_CROSS        0x19
84 #define CH_HLINE        0x12
85 #define CH_VLINE        0x16
86
87 /* color defines */
88
89 /* make GTIA color value */
90 #define _gtia_mkcolor(hue,lum) (((hue) << 4) | ((lum) << 1))
91
92 /* luminance values go from 0 (black) to 7 (white) */
93
94 /* hue values */
95 #define HUE_GREY        0
96 #define HUE_GOLD        1
97 #define HUE_GOLDORANGE  2
98 #define HUE_REDORANGE   3
99 #define HUE_ORANGE      4
100 #define HUE_MAGENTA     5
101 #define HUE_PURPLE      6
102 #define HUE_BLUE        7
103 #define HUE_BLUE2       8
104 #define HUE_CYAN        9
105 #define HUE_BLUEGREEN   10
106 #define HUE_BLUEGREEN2  11
107 #define HUE_GREEN       12
108 #define HUE_YELLOWGREEN 13
109 #define HUE_YELLOW      14
110 #define HUE_YELLOWRED   15                                        
111
112 /* Color defines, similar to c64 colors (untested) */
113 #define COLOR_BLACK             _gtia_mkcolor(HUE_GREY,0)
114 #define COLOR_WHITE             _gtia_mkcolor(HUE_GREY,7)
115 #define COLOR_RED               _gtia_mkcolor(HUE_REDORANGE,1)
116 #define COLOR_CYAN              _gtia_mkcolor(HUE_CYAN,3)
117 #define COLOR_VIOLET            _gtia_mkcolor(HUE_PURPLE,4)
118 #define COLOR_GREEN             _gtia_mkcolor(HUE_GREEN,2)
119 #define COLOR_BLUE              _gtia_mkcolor(HUE_BLUE,2)
120 #define COLOR_YELLOW            _gtia_mkcolor(HUE_YELLOW,7)
121 #define COLOR_ORANGE            _gtia_mkcolor(HUE_ORANGE,5)
122 #define COLOR_BROWN             _gtia_mkcolor(HUE_YELLOW,2)
123 #define COLOR_LIGHTRED          _gtia_mkcolor(HUE_REDORANGE,6)
124 #define COLOR_GRAY1             _gtia_mkcolor(HUE_GREY,2)
125 #define COLOR_GRAY2             _gtia_mkcolor(HUE_GREY,3)
126 #define COLOR_LIGHTGREEN        _gtia_mkcolor(HUE_GREEN,6)
127 #define COLOR_LIGHTBLUE         _gtia_mkcolor(HUE_BLUE,6)
128 #define COLOR_GRAY3             _gtia_mkcolor(HUE_GREY,5)
129
130 /* color register functions */
131 extern void __fastcall__ setcolor     (unsigned char color_reg, unsigned char hue, unsigned char luminace);
132 extern void __fastcall__ setcolor_low (unsigned char color_reg, unsigned char color_value);
133 extern unsigned char __fastcall__ getcolor (unsigned char color_reg);
134
135 /* other screen functions */
136 extern int  __fastcall__ graphics(unsigned char mode); /* mode value same as in BASIC */
137 extern void __fastcall__ scroll (signed char numlines);
138                                           /* numlines > 0  scrolls up */
139                                           /* numlines < 0  scrolls down */
140
141 /* misc. functions */
142 extern void save_vecs(void);           /* save system vectors */
143 extern void rest_vecs(void);           /* restore system vectors */
144 extern unsigned char get_ostype(void); /* get ROM version */
145 extern unsigned char get_tv(void);     /* get TV system */
146
147 /* get_ostype return value defines (for explanation, see ostype.s) */
148 /* masks */
149 #define AT_OS_TYPE_MAIN  7
150 #define AT_OS_TYPE_MINOR (7 << 3)
151 /* AT_OS_TYPE_MAIN values */
152 #define AT_OS_UNKNOWN  0
153 #define AT_OS_400800   1
154 #define AT_OS_1200XL   2
155 #define AT_OS_XLXE     3
156 /* AS_OS_TYPE_MINOR values */
157 /* for 400/800 remember this are the ROM versions */
158 /* to check whether the hw is PAL or NTSC, use get_tv() */
159 #define AT_OS_400800PAL_A  1
160 #define AT_OS_400800PAL_B  2
161 #define AT_OS_400800NTSC_A 1
162 #define AT_OS_400800NTSC_B 2
163 #define AT_OS_1200_10  1
164 #define AT_OS_1200_11  2
165 #define AT_OS_XLXE_1   1
166 #define AT_OS_XLXE_2   2
167 #define AT_OS_XLXE_3   3
168 #define AT_OS_XLXE_4   4
169
170 /* get_tv return values */
171 #define AT_NTSC     0
172 #define AT_PAL      1
173
174 /* Define hardware */
175 #include <_gtia.h>
176 #define GTIA_READ  (*(struct __gtia_read*)0xD000)
177 #define GTIA_WRITE (*(struct __gtia_write*)0xD000)
178
179 #include <_pbi.h>
180
181 #include <_pokey.h>
182 #define POKEY_READ  (*(struct __pokey_read*)0xD200)
183 #define POKEY_WRITE (*(struct __pokey_write*)0xD200)
184
185 #include <_pia.h>
186 #define PIA (*(struct __pia*)0xD300)
187
188 #include <_antic.h>
189 #define ANTIC (*(struct __antic*)0xD400)
190
191 /* device control block */
192 struct __dcb {
193     unsigned char device;     /* device id */
194     unsigned char unit;       /* unit number */
195     unsigned char command;    /* command */
196     unsigned char status;     /* command type / status return */
197     void          *buffer;    /* pointer to buffer */
198     unsigned char timeout;    /* device timeout in seconds */
199     unsigned char unused;
200     unsigned int  xfersize;   /* # of bytes to transfer */
201     unsigned char aux1;       /* 1st command auxiliary byte */
202     unsigned char aux2;       /* 2nd command auxiliary byte */
203 };
204 #define DCB (*(struct __dcb *)0x300)
205
206 /* End of atari.h */
207 #endif /* #ifndef _ATARI_H */