1 /*****************************************************************************/
5 /* Atari system specific definitions */
9 /* (C) 2000-2018 Mark Keates <markk@dendrite.co.uk> */
10 /* Freddy Offenga <taf_offenga@yahoo.com> */
11 /* Christian Groessler <chris@groessler.org> */
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. */
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: */
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 */
31 /*****************************************************************************/
40 /* Check for errors */
41 #if !defined(__ATARI__)
42 # error This module may only be used when compiling for the Atari!
48 #define CH_DELCHR 0xFE /* delete char under the cursor */
52 #define CH_CURS_DOWN 29
53 #define CH_CURS_LEFT 30
54 #define CH_CURS_RIGHT 31
56 #define CH_TAB 0x7F /* tabulator */
57 #define CH_EOL 0x9B /* end-of-line marker */
58 #define CH_CLR 0x7D /* clear screen */
59 #define CH_BEL 0xFD /* bell */
60 #define CH_DEL 0x7E /* back space (delete char to the left) */
61 #define CH_RUBOUT 0x7E /* back space (old, deprecated) */
62 #define CH_DELLINE 0x9C /* delete line */
63 #define CH_INSLINE 0x9D /* insert line */
65 /* These are defined to be Atari + NumberKey */
77 #define CH_ULCORNER 0x11
78 #define CH_URCORNER 0x05
79 #define CH_LLCORNER 0x1A
80 #define CH_LRCORNER 0x03
91 /* make GTIA color value */
92 #define _gtia_mkcolor(hue,lum) (((hue) << 4) | ((lum) << 1))
94 /* luminance values go from 0 (black) to 7 (white) */
96 /* hue values (these can vary depending on TV standard (NTSC vs PAL), tint potentiometer settings, TV tint settings, emulator palette, etc. */
99 #define HUE_GOLDORANGE 2
100 #define HUE_REDORANGE 3
102 #define HUE_MAGENTA 5
107 #define HUE_BLUEGREEN 10
108 #define HUE_BLUEGREEN2 11
110 #define HUE_YELLOWGREEN 13
111 #define HUE_YELLOW 14
112 #define HUE_YELLOWRED 15
114 /* Color defines, similar to c64 colors (untested) */
115 /* Note that the conio color implementation is monochrome (bgcolor and textcolor are only placeholders) */
116 /* Use the defines with the setcolor() or _atari_xxxcolor() functions */
117 #define COLOR_BLACK _gtia_mkcolor(HUE_GREY,0)
118 #define COLOR_WHITE _gtia_mkcolor(HUE_GREY,7)
119 #define COLOR_RED _gtia_mkcolor(HUE_REDORANGE,1)
120 #define COLOR_CYAN _gtia_mkcolor(HUE_CYAN,3)
121 #define COLOR_VIOLET _gtia_mkcolor(HUE_PURPLE,4)
122 #define COLOR_GREEN _gtia_mkcolor(HUE_GREEN,2)
123 #define COLOR_BLUE _gtia_mkcolor(HUE_BLUE,2)
124 #define COLOR_YELLOW _gtia_mkcolor(HUE_YELLOW,7)
125 #define COLOR_ORANGE _gtia_mkcolor(HUE_ORANGE,5)
126 #define COLOR_BROWN _gtia_mkcolor(HUE_YELLOW,2)
127 #define COLOR_LIGHTRED _gtia_mkcolor(HUE_REDORANGE,6)
128 #define COLOR_GRAY1 _gtia_mkcolor(HUE_GREY,2)
129 #define COLOR_GRAY2 _gtia_mkcolor(HUE_GREY,3)
130 #define COLOR_LIGHTGREEN _gtia_mkcolor(HUE_GREEN,6)
131 #define COLOR_LIGHTBLUE _gtia_mkcolor(HUE_BLUE,6)
132 #define COLOR_GRAY3 _gtia_mkcolor(HUE_GREY,5)
134 /* TGI color defines */
135 #define TGI_COLOR_BLACK COLOR_BLACK
136 #define TGI_COLOR_WHITE COLOR_WHITE
137 #define TGI_COLOR_RED COLOR_RED
138 #define TGI_COLOR_CYAN COLOR_CYAN
139 #define TGI_COLOR_VIOLET COLOR_VIOLET
140 #define TGI_COLOR_GREEN COLOR_GREEN
141 #define TGI_COLOR_BLUE COLOR_BLUE
142 #define TGI_COLOR_YELLOW COLOR_YELLOW
143 #define TGI_COLOR_ORANGE COLOR_ORANGE
144 #define TGI_COLOR_BROWN COLOR_BROWN
145 #define TGI_COLOR_LIGHTRED COLOR_LIGHTRED
146 #define TGI_COLOR_GRAY1 COLOR_GRAY1
147 #define TGI_COLOR_GRAY2 COLOR_GRAY2
148 #define TGI_COLOR_LIGHTGREEN COLOR_LIGHTGREEN
149 #define TGI_COLOR_LIGHTBLUE COLOR_LIGHTBLUE
150 #define TGI_COLOR_GRAY3 COLOR_GRAY3
152 /* Masks for joy_read */
153 #define JOY_UP_MASK 0x01
154 #define JOY_DOWN_MASK 0x02
155 #define JOY_LEFT_MASK 0x04
156 #define JOY_RIGHT_MASK 0x08
157 #define JOY_BTN_1_MASK 0x10
159 #define JOY_FIRE_MASK JOY_BTN_1_MASK
160 #define JOY_FIRE(v) ((v) & JOY_FIRE_MASK)
162 /* Keyboard values returned by kbcode / CH */
163 #define KEY_NONE ((unsigned char) 0xFF)
165 #define KEY_0 ((unsigned char) 0x32)
166 #define KEY_1 ((unsigned char) 0x1F)
167 #define KEY_2 ((unsigned char) 0x1E)
168 #define KEY_3 ((unsigned char) 0x1A)
169 #define KEY_4 ((unsigned char) 0x18)
170 #define KEY_5 ((unsigned char) 0x1D)
171 #define KEY_6 ((unsigned char) 0x1B)
172 #define KEY_7 ((unsigned char) 0x33)
173 #define KEY_8 ((unsigned char) 0x35)
174 #define KEY_9 ((unsigned char) 0x30)
176 #define KEY_A ((unsigned char) 0x3F)
177 #define KEY_B ((unsigned char) 0x15)
178 #define KEY_C ((unsigned char) 0x12)
179 #define KEY_D ((unsigned char) 0x3A)
180 #define KEY_E ((unsigned char) 0x2A)
181 #define KEY_F ((unsigned char) 0x38)
182 #define KEY_G ((unsigned char) 0x3D)
183 #define KEY_H ((unsigned char) 0x39)
184 #define KEY_I ((unsigned char) 0x0D)
185 #define KEY_J ((unsigned char) 0x01)
186 #define KEY_K ((unsigned char) 0x05)
187 #define KEY_L ((unsigned char) 0x00)
188 #define KEY_M ((unsigned char) 0x25)
189 #define KEY_N ((unsigned char) 0x23)
190 #define KEY_O ((unsigned char) 0x08)
191 #define KEY_P ((unsigned char) 0x0A)
192 #define KEY_Q ((unsigned char) 0x2F)
193 #define KEY_R ((unsigned char) 0x28)
194 #define KEY_S ((unsigned char) 0x3E)
195 #define KEY_T ((unsigned char) 0x2D)
196 #define KEY_U ((unsigned char) 0x0B)
197 #define KEY_V ((unsigned char) 0x10)
198 #define KEY_W ((unsigned char) 0x2E)
199 #define KEY_X ((unsigned char) 0x16)
200 #define KEY_Y ((unsigned char) 0x2B)
201 #define KEY_Z ((unsigned char) 0x17)
203 #define KEY_COMMA ((unsigned char) 0x20)
204 #define KEY_PERIOD ((unsigned char) 0x22)
205 #define KEY_SLASH ((unsigned char) 0x26)
206 #define KEY_SEMICOLON ((unsigned char) 0x02)
207 #define KEY_PLUS ((unsigned char) 0x06)
208 #define KEY_ASTERISK ((unsigned char) 0x07)
209 #define KEY_DASH ((unsigned char) 0x0E)
210 #define KEY_EQUALS ((unsigned char) 0x0F)
211 #define KEY_LESSTHAN ((unsigned char) 0x36)
212 #define KEY_GREATERTHAN ((unsigned char) 0x37)
214 #define KEY_ESC ((unsigned char) 0x1C)
215 #define KEY_TAB ((unsigned char) 0x2C)
216 #define KEY_SPACE ((unsigned char) 0x21)
217 #define KEY_RETURN ((unsigned char) 0x0C)
218 #define KEY_DELETE ((unsigned char) 0x34)
219 #define KEY_CAPS ((unsigned char) 0x3C)
220 #define KEY_INVERSE ((unsigned char) 0x27)
221 #define KEY_HELP ((unsigned char) 0x11)
223 #define KEY_F1 ((unsigned char) 0x03)
224 #define KEY_F2 ((unsigned char) 0x04)
225 #define KEY_F3 ((unsigned char) 0x13)
226 #define KEY_F4 ((unsigned char) 0x14)
228 #define KEY_CTRL ((unsigned char) 0x80)
229 #define KEY_SHIFT ((unsigned char) 0x40)
233 #define KEY_EXCLAMATIONMARK (KEY_1 | KEY_SHIFT)
234 #define KEY_QUOTE (KEY_2 | KEY_SHIFT)
235 #define KEY_HASH (KEY_3 | KEY_SHIFT)
236 #define KEY_DOLLAR (KEY_4 | KEY_SHIFT)
237 #define KEY_PERCENT (KEY_5 | KEY_SHIFT)
238 #define KEY_AMPERSAND (KEY_6 | KEY_SHIFT)
239 #define KEY_APOSTROPHE (KEY_7 | KEY_SHIFT)
240 #define KEY_AT (KEY_8 | KEY_SHIFT)
241 #define KEY_OPENINGPARAN (KEY_9 | KEY_SHIFT)
242 #define KEY_CLOSINGPARAN (KEY_0 | KEY_SHIFT)
243 #define KEY_UNDERLINE (KEY_DASH | KEY_SHIFT)
244 #define KEY_BAR (KEY_EQUALS | KEY_SHIFT)
245 #define KEY_COLON (KEY_SEMICOLON | KEY_SHIFT)
246 #define KEY_BACKSLASH (KEY_PLUS | KEY_SHIFT)
247 #define KEY_CIRCUMFLEX (KEY_ASTERISK | KEY_SHIFT)
248 #define KEY_OPENINGBRACKET (KEY_COMMA | KEY_SHIFT)
249 #define KEY_CLOSINGBRACKET (KEY_PERIOD | KEY_SHIFT)
250 #define KEY_QUESTIONMARK (KEY_SLASH | KEY_SHIFT)
251 #define KEY_CLEAR (KEY_LESSTHAN | KEY_SHIFT)
252 #define KEY_INSERT (KEY_GREATERTHAN | KEY_SHIFT)
254 #define KEY_UP (KEY_UNDERLINE | KEY_CTRL)
255 #define KEY_DOWN (KEY_EQUALS | KEY_CTRL)
256 #define KEY_LEFT (KEY_PLUS | KEY_CTRL)
257 #define KEY_RIGHT (KEY_ASTERISK | KEY_CTRL)
259 /* color register functions */
260 extern void __fastcall__ _setcolor (unsigned char color_reg, unsigned char hue, unsigned char luminace);
261 extern void __fastcall__ _setcolor_low (unsigned char color_reg, unsigned char color_value);
262 extern unsigned char __fastcall__ _getcolor (unsigned char color_reg);
264 /* other screen functions */
265 extern int __fastcall__ _graphics (unsigned char mode); /* mode value same as in BASIC */
266 extern void __fastcall__ _scroll (signed char numlines);
267 /* numlines > 0 scrolls up */
268 /* numlines < 0 scrolls down */
270 /* misc. functions */
271 extern unsigned char get_ostype(void); /* get ROM version */
272 extern unsigned char get_tv(void); /* get TV system */
273 extern void _save_vecs(void); /* save system vectors */
274 extern void _rest_vecs(void); /* restore system vectors */
275 extern char *_getdefdev(void); /* get default floppy device */
276 extern unsigned char _is_cmdline_dos(void); /* does DOS support command lines */
278 /* global variables */
279 extern unsigned char _dos_type; /* the DOS flavour */
281 extern void atr130_emd[];
282 extern void atrstd_joy[]; /* referred to by joy_static_stddrv[] */
283 extern void atrmj8_joy[];
284 extern void atrjoy_mou[];
285 extern void atrst_mou[]; /* referred to by mouse_static_stddrv[] */
286 extern void atrami_mou[];
287 extern void atrtrk_mou[];
288 extern void atrtt_mou[];
289 extern void atrrdev_ser[];
290 extern void atr3_tgi[];
291 extern void atr4_tgi[];
292 extern void atr5_tgi[];
293 extern void atr6_tgi[];
294 extern void atr7_tgi[];
295 extern void atr8_tgi[]; /* referred to by tgi_static_stddrv[] */
296 extern void atr8p2_tgi[];
297 extern void atr9_tgi[];
298 extern void atr9p2_tgi[];
299 extern void atr10_tgi[];
300 extern void atr10p2_tgi[];
301 extern void atr11_tgi[];
302 extern void atr14_tgi[];
303 extern void atr15_tgi[];
304 extern void atr15p2_tgi[];
306 extern void atrx130_emd[];
307 extern void atrxstd_joy[]; /* referred to by joy_static_stddrv[] */
308 extern void atrxmj8_joy[];
309 extern void atrxjoy_mou[];
310 extern void atrxst_mou[]; /* referred to by mouse_static_stddrv[] */
311 extern void atrxami_mou[];
312 extern void atrxtrk_mou[];
313 extern void atrxtt_mou[];
314 extern void atrxrdev_ser[];
315 extern void atrx3_tgi[];
316 extern void atrx4_tgi[];
317 extern void atrx5_tgi[];
318 extern void atrx6_tgi[];
319 extern void atrx7_tgi[];
320 extern void atrx8_tgi[]; /* referred to by tgi_static_stddrv[] */
321 extern void atrx8p2_tgi[];
322 extern void atrx9_tgi[];
323 extern void atrx9p2_tgi[];
324 extern void atrx10_tgi[];
325 extern void atrx10p2_tgi[];
326 extern void atrx11_tgi[];
327 extern void atrx14_tgi[];
328 extern void atrx15_tgi[];
329 extern void atrx15p2_tgi[];
332 /* get_ostype return value defines (for explanation, see ostype.s) */
334 #define AT_OS_TYPE_MAIN 7
335 #define AT_OS_TYPE_MINOR (7 << 3)
336 /* AT_OS_TYPE_MAIN values */
337 #define AT_OS_UNKNOWN 0
338 #define AT_OS_400800 1
339 #define AT_OS_1200XL 2
341 /* AS_OS_TYPE_MINOR values */
342 /* for 400/800 remember this are the ROM versions */
343 /* to check whether the hw is PAL or NTSC, use get_tv() */
344 #define AT_OS_400800PAL_A 1
345 #define AT_OS_400800PAL_B 2
346 #define AT_OS_400800NTSC_A 1
347 #define AT_OS_400800NTSC_B 2
348 #define AT_OS_1200_10 1
349 #define AT_OS_1200_11 2
350 #define AT_OS_XLXE_1 1
351 #define AT_OS_XLXE_2 2
352 #define AT_OS_XLXE_3 3
353 #define AT_OS_XLXE_4 4
355 /* get_tv return values */
359 /* valid _dos_type values */
369 /* Define hardware */
371 #define GTIA_READ (*(struct __gtia_read*)0xD000)
372 #define GTIA_WRITE (*(struct __gtia_write*)0xD000)
377 #define POKEY_READ (*(struct __pokey_read*)0xD200)
378 #define POKEY_WRITE (*(struct __pokey_write*)0xD200)
381 #define PIA (*(struct __pia*)0xD300)
384 #define ANTIC (*(struct __antic*)0xD400)
386 /* device control block */
388 unsigned char device; /* device id */
389 unsigned char unit; /* unit number */
390 unsigned char command; /* command */
391 unsigned char status; /* command type / status return */
392 void *buffer; /* pointer to buffer */
393 unsigned char timeout; /* device timeout in seconds */
394 unsigned char unused;
395 unsigned int xfersize; /* # of bytes to transfer */
396 unsigned char aux1; /* 1st command auxiliary byte */
397 unsigned char aux2; /* 2nd command auxiliary byte */
399 #define DCB (*(struct __dcb *)0x300)
401 /* I/O control block */
403 unsigned char handler; /* handler index number (0xff free) */
404 unsigned char drive; /* device number (drive) */
405 unsigned char command; /* command */
406 unsigned char status; /* status of last operation */
407 void *buffer; /* pointer to buffer */
408 void *put_byte; /* pointer to device's PUT BYTE routine */
409 unsigned int buflen; /* length of buffer */
410 unsigned char aux1; /* 1st auxiliary byte */
411 unsigned char aux2; /* 2nd auxiliary byte */
412 unsigned char aux3; /* 3rd auxiliary byte */
413 unsigned char aux4; /* 4th auxiliary byte */
414 unsigned char aux5; /* 5th auxiliary byte */
415 unsigned char spare; /* spare byte */
417 #define ZIOCB (*(struct __iocb *)0x20) /* zero page IOCB */
418 #define IOCB (*(struct __iocb *)0x340) /* system IOCB buffers */
420 /* IOCB Command Codes */
421 #define IOCB_OPEN 0x03 /* open */
422 #define IOCB_GETREC 0x05 /* get record */
423 #define IOCB_GETCHR 0x07 /* get character(s) */
424 #define IOCB_PUTREC 0x09 /* put record */
425 #define IOCB_PUTCHR 0x0B /* put character(s) */
426 #define IOCB_CLOSE 0x0C /* close */
427 #define IOCB_STATIS 0x0D /* status */
428 #define IOCB_SPECIL 0x0E /* special */
429 #define IOCB_DRAWLN 0x11 /* draw line */
430 #define IOCB_FILLIN 0x12 /* draw line with right fill */
431 #define IOCB_RENAME 0x20 /* rename disk file */
432 #define IOCB_DELETE 0x21 /* delete disk file */
433 #define IOCB_LOCKFL 0x23 /* lock file (set to read-only) */
434 #define IOCB_UNLOCK 0x24 /* unlock file */
435 #define IOCB_POINT 0x25 /* point sector */
436 #define IOCB_NOTE 0x26 /* note sector */
437 #define IOCB_GETFL 0x27 /* get file length */
438 #define IOCB_CHDIR_MYDOS 0x29 /* change directory (MyDOS) */
439 #define IOCB_MKDIR 0x2A /* make directory (MyDOS/SpartaDOS) */
440 #define IOCB_RMDIR 0x2B /* remove directory (SpartaDOS) */
441 #define IOCB_CHDIR_SPDOS 0x2C /* change directory (SpartaDOS) */
442 #define IOCB_GETCWD 0x30 /* get current directory (MyDOS/SpartaDOS) */
443 #define IOCB_FORMAT 0xFE /* format */