]> git.sur5r.net Git - cc65/blob - include/atari.h
e06967ff97edff06b090e0962c987137d2727812
[cc65] / include / atari.h
1 /*****************************************************************************/
2 /*                                                                           */
3 /*                                 atari.h                                   */
4 /*                                                                           */
5 /*                      Atari system specific definitions                    */
6 /*                                                                           */
7 /*                                                                           */
8 /*                                                                           */
9 /* (C) 2000-2019 Mark Keates <markk@dendrite.co.uk>                          */
10 /*               Freddy Offenga <taf_offenga@yahoo.com>                      */
11 /*               Christian Groessler <chris@groessler.org>                   */
12 /*               Bill Kendrick <nbs@sonic.net>                               */
13 /*                                                                           */
14 /*                                                                           */
15 /* This software is provided 'as-is', without any expressed or implied       */
16 /* warranty.  In no event will the authors be held liable for any damages    */
17 /* arising from the use of this software.                                    */
18 /*                                                                           */
19 /* Permission is granted to anyone to use this software for any purpose,     */
20 /* including commercial applications, and to alter it and redistribute it    */
21 /* freely, subject to the following restrictions:                            */
22 /*                                                                           */
23 /* 1. The origin of this software must not be misrepresented; you must not   */
24 /*    claim that you wrote the original software. If you use this software   */
25 /*    in a product, an acknowledgment in the product documentation would be  */
26 /*    appreciated but is not required.                                       */
27 /* 2. Altered source versions must be plainly marked as such, and must not   */
28 /*    be misrepresented as being the original software.                      */
29 /* 3. This notice may not be removed or altered from any source              */
30 /*    distribution.                                                          */
31 /*                                                                           */
32 /*****************************************************************************/
33
34
35
36 #ifndef _ATARI_H
37 #define _ATARI_H
38
39
40
41 /* Check for errors */
42 #if !defined(__ATARI__)
43 #  error This module may only be used when compiling for the Atari!
44 #endif
45
46
47
48 /*****************************************************************************/
49 /* Character codes                                                           */
50 /*****************************************************************************/
51
52 #define CH_DELCHR       0xFE   /* delete char under the cursor */
53 #define CH_ENTER        0x9B
54 #define CH_ESC          0x1B
55 #define CH_CURS_UP      28
56 #define CH_CURS_DOWN    29
57 #define CH_CURS_LEFT    30
58 #define CH_CURS_RIGHT   31
59
60 #define CH_TAB          0x7F   /* tabulator */
61 #define CH_EOL          0x9B   /* end-of-line marker */
62 #define CH_CLR          0x7D   /* clear screen */
63 #define CH_BEL          0xFD   /* bell */
64 #define CH_DEL          0x7E   /* back space (delete char to the left) */
65 #define CH_RUBOUT       0x7E   /* back space (old, deprecated) */
66 #define CH_DELLINE      0x9C   /* delete line */
67 #define CH_INSLINE      0x9D   /* insert line */
68
69 /* These are defined to be Atari + NumberKey */
70 #define CH_F1           177
71 #define CH_F2           178
72 #define CH_F3           179
73 #define CH_F4           180
74 #define CH_F5           181
75 #define CH_F6           182
76 #define CH_F7           183
77 #define CH_F8           184
78 #define CH_F9           185
79 #define CH_F10          176
80
81 #define CH_ULCORNER     0x11
82 #define CH_URCORNER     0x05
83 #define CH_LLCORNER     0x1A
84 #define CH_LRCORNER     0x03
85 #define CH_TTEE         0x17
86 #define CH_BTEE         0x18
87 #define CH_LTEE         0x01
88 #define CH_RTEE         0x04
89 #define CH_CROSS        0x13
90 #define CH_HLINE        0x12
91 #define CH_VLINE        0x7C
92
93
94 /*****************************************************************************/
95 /* Masks for joy_read                                                        */
96 /*****************************************************************************/
97
98 #define JOY_UP_MASK     0x01
99 #define JOY_DOWN_MASK   0x02
100 #define JOY_LEFT_MASK   0x04
101 #define JOY_RIGHT_MASK  0x08
102 #define JOY_BTN_1_MASK  0x10
103
104 #define JOY_FIRE_MASK   JOY_BTN_1_MASK
105 #define JOY_FIRE(v)     ((v) & JOY_FIRE_MASK)
106
107
108 /*****************************************************************************/
109 /* Keyboard values returned by kbcode / CH                                   */
110 /*****************************************************************************/
111
112 #define KEY_NONE        ((unsigned char) 0xFF)
113
114 #define KEY_0           ((unsigned char) 0x32)
115 #define KEY_1           ((unsigned char) 0x1F)
116 #define KEY_2           ((unsigned char) 0x1E)
117 #define KEY_3           ((unsigned char) 0x1A)
118 #define KEY_4           ((unsigned char) 0x18)
119 #define KEY_5           ((unsigned char) 0x1D)
120 #define KEY_6           ((unsigned char) 0x1B)
121 #define KEY_7           ((unsigned char) 0x33)
122 #define KEY_8           ((unsigned char) 0x35)
123 #define KEY_9           ((unsigned char) 0x30)
124
125 #define KEY_A           ((unsigned char) 0x3F)
126 #define KEY_B           ((unsigned char) 0x15)
127 #define KEY_C           ((unsigned char) 0x12)
128 #define KEY_D           ((unsigned char) 0x3A)
129 #define KEY_E           ((unsigned char) 0x2A)
130 #define KEY_F           ((unsigned char) 0x38)
131 #define KEY_G           ((unsigned char) 0x3D)
132 #define KEY_H           ((unsigned char) 0x39)
133 #define KEY_I           ((unsigned char) 0x0D)
134 #define KEY_J           ((unsigned char) 0x01)
135 #define KEY_K           ((unsigned char) 0x05)
136 #define KEY_L           ((unsigned char) 0x00)
137 #define KEY_M           ((unsigned char) 0x25)
138 #define KEY_N           ((unsigned char) 0x23)
139 #define KEY_O           ((unsigned char) 0x08)
140 #define KEY_P           ((unsigned char) 0x0A)
141 #define KEY_Q           ((unsigned char) 0x2F)
142 #define KEY_R           ((unsigned char) 0x28)
143 #define KEY_S           ((unsigned char) 0x3E)
144 #define KEY_T           ((unsigned char) 0x2D)
145 #define KEY_U           ((unsigned char) 0x0B)
146 #define KEY_V           ((unsigned char) 0x10)
147 #define KEY_W           ((unsigned char) 0x2E)
148 #define KEY_X           ((unsigned char) 0x16)
149 #define KEY_Y           ((unsigned char) 0x2B)
150 #define KEY_Z           ((unsigned char) 0x17)
151
152 #define KEY_COMMA       ((unsigned char) 0x20)
153 #define KEY_PERIOD      ((unsigned char) 0x22)
154 #define KEY_SLASH       ((unsigned char) 0x26)
155 #define KEY_SEMICOLON   ((unsigned char) 0x02)
156 #define KEY_PLUS        ((unsigned char) 0x06)
157 #define KEY_ASTERISK    ((unsigned char) 0x07)
158 #define KEY_DASH        ((unsigned char) 0x0E)
159 #define KEY_EQUALS      ((unsigned char) 0x0F)
160 #define KEY_LESSTHAN    ((unsigned char) 0x36)
161 #define KEY_GREATERTHAN ((unsigned char) 0x37)
162
163 #define KEY_ESC         ((unsigned char) 0x1C)
164 #define KEY_TAB         ((unsigned char) 0x2C)
165 #define KEY_SPACE       ((unsigned char) 0x21)
166 #define KEY_RETURN      ((unsigned char) 0x0C)
167 #define KEY_DELETE      ((unsigned char) 0x34)
168 #define KEY_CAPS        ((unsigned char) 0x3C)
169 #define KEY_INVERSE     ((unsigned char) 0x27)
170 #define KEY_HELP        ((unsigned char) 0x11)
171
172 /* Function keys only exist on the 1200XL model. */
173 #define KEY_F1          ((unsigned char) 0x03)
174 #define KEY_F2          ((unsigned char) 0x04)
175 #define KEY_F3          ((unsigned char) 0x13)
176 #define KEY_F4          ((unsigned char) 0x14)
177
178 /* N.B. Cannot read Ctrl key alone */
179 #define KEY_CTRL        ((unsigned char) 0x80)
180
181 /* N.B. Cannot read Shift key alone via KBCODE;
182 ** instead, check "Shfit key press" bit of SKSTAT register.
183 ** Also, no way to tell left Shift from right Shift.
184 */
185 #define KEY_SHIFT       ((unsigned char) 0x40)
186
187
188 /* Composed keys
189 ** (Other combinations are possible, including Shift+Ctrl+key,
190 ** though not all such combinations are available.)
191 */
192
193 #define KEY_EXCLAMATIONMARK     (KEY_1 | KEY_SHIFT)
194 #define KEY_QUOTE               (KEY_2 | KEY_SHIFT)
195 #define KEY_HASH                (KEY_3 | KEY_SHIFT)
196 #define KEY_DOLLAR              (KEY_4 | KEY_SHIFT)
197 #define KEY_PERCENT             (KEY_5 | KEY_SHIFT)
198 #define KEY_AMPERSAND           (KEY_6 | KEY_SHIFT)
199 #define KEY_APOSTROPHE          (KEY_7 | KEY_SHIFT)
200 #define KEY_AT                  (KEY_8 | KEY_SHIFT)
201 #define KEY_OPENINGPARAN        (KEY_9 | KEY_SHIFT)
202 #define KEY_CLOSINGPARAN        (KEY_0 | KEY_SHIFT)
203 #define KEY_UNDERLINE           (KEY_DASH | KEY_SHIFT)
204 #define KEY_BAR                 (KEY_EQUALS | KEY_SHIFT)
205 #define KEY_COLON               (KEY_SEMICOLON | KEY_SHIFT)
206 #define KEY_BACKSLASH           (KEY_PLUS | KEY_SHIFT)
207 #define KEY_CIRCUMFLEX          (KEY_ASTERISK | KEY_SHIFT)
208 #define KEY_OPENINGBRACKET      (KEY_COMMA | KEY_SHIFT)
209 #define KEY_CLOSINGBRACKET      (KEY_PERIOD | KEY_SHIFT)
210 #define KEY_QUESTIONMARK        (KEY_SLASH | KEY_SHIFT)
211 #define KEY_CLEAR               (KEY_LESSTHAN | KEY_SHIFT)
212 #define KEY_INSERT              (KEY_GREATERTHAN | KEY_SHIFT)
213
214 #define KEY_UP      (KEY_UNDERLINE | KEY_CTRL)
215 #define KEY_DOWN    (KEY_EQUALS | KEY_CTRL)
216 #define KEY_LEFT    (KEY_PLUS | KEY_CTRL)
217 #define KEY_RIGHT   (KEY_ASTERISK | KEY_CTRL)
218
219
220 /*****************************************************************************/
221 /* Color register functions                                                  */
222 /*****************************************************************************/
223
224 extern void __fastcall__ _setcolor     (unsigned char color_reg, unsigned char hue, unsigned char luminace);
225 extern void __fastcall__ _setcolor_low (unsigned char color_reg, unsigned char color_value);
226 extern unsigned char __fastcall__ _getcolor (unsigned char color_reg);
227
228 /*****************************************************************************/
229 /* Other screen functions                                                    */
230 /*****************************************************************************/
231
232 extern int  __fastcall__ _graphics (unsigned char mode); /* mode value same as in BASIC */
233 extern void __fastcall__ _scroll (signed char numlines);
234                                           /* numlines > 0  scrolls up */
235                                           /* numlines < 0  scrolls down */
236
237
238 /*****************************************************************************/
239 /* Misc. functions                                                           */
240 /*****************************************************************************/
241
242 extern unsigned char get_ostype(void);       /* get ROM version */
243 extern unsigned char get_tv(void);           /* get TV system */
244 extern void _save_vecs(void);                /* save system vectors */
245 extern void _rest_vecs(void);                /* restore system vectors */
246 extern char *_getdefdev(void);               /* get default floppy device */
247 extern unsigned char _is_cmdline_dos(void);  /* does DOS support command lines */
248
249
250 /*****************************************************************************/
251 /* Global variables                                                          */
252 /*****************************************************************************/
253
254 extern unsigned char _dos_type;         /* the DOS flavour */
255 #ifndef __ATARIXL__
256 extern void atr130_emd[];
257 extern void atrstd_joy[];               /* referred to by joy_static_stddrv[] */
258 extern void atrmj8_joy[];
259 extern void atrjoy_mou[];
260 extern void atrst_mou[];                /* referred to by mouse_static_stddrv[] */
261 extern void atrami_mou[];
262 extern void atrtrk_mou[];
263 extern void atrtt_mou[];
264 extern void atrrdev_ser[];
265 extern void atr3_tgi[];
266 extern void atr4_tgi[];
267 extern void atr5_tgi[];
268 extern void atr6_tgi[];
269 extern void atr7_tgi[];
270 extern void atr8_tgi[];                 /* referred to by tgi_static_stddrv[] */
271 extern void atr8p2_tgi[];
272 extern void atr9_tgi[];
273 extern void atr9p2_tgi[];
274 extern void atr10_tgi[];
275 extern void atr10p2_tgi[];
276 extern void atr11_tgi[];
277 extern void atr14_tgi[];
278 extern void atr15_tgi[];
279 extern void atr15p2_tgi[];
280 #else
281 extern void atrx130_emd[];
282 extern void atrxstd_joy[];              /* referred to by joy_static_stddrv[] */
283 extern void atrxmj8_joy[];
284 extern void atrxjoy_mou[];
285 extern void atrxst_mou[];               /* referred to by mouse_static_stddrv[] */
286 extern void atrxami_mou[];
287 extern void atrxtrk_mou[];
288 extern void atrxtt_mou[];
289 extern void atrxrdev_ser[];
290 extern void atrx3_tgi[];
291 extern void atrx4_tgi[];
292 extern void atrx5_tgi[];
293 extern void atrx6_tgi[];
294 extern void atrx7_tgi[];
295 extern void atrx8_tgi[];                /* referred to by tgi_static_stddrv[] */
296 extern void atrx8p2_tgi[];
297 extern void atrx9_tgi[];
298 extern void atrx9p2_tgi[];
299 extern void atrx10_tgi[];
300 extern void atrx10p2_tgi[];
301 extern void atrx11_tgi[];
302 extern void atrx14_tgi[];
303 extern void atrx15_tgi[];
304 extern void atrx15p2_tgi[];
305 #endif
306
307
308 /*****************************************************************************/
309 /* get_ostype return value defines (for explanation, see ostype.s)           */
310 /*****************************************************************************/
311
312 /* masks */
313 #define AT_OS_TYPE_MAIN  7
314 #define AT_OS_TYPE_MINOR (7 << 3)
315 /* AT_OS_TYPE_MAIN values */
316 #define AT_OS_UNKNOWN  0
317 #define AT_OS_400800   1
318 #define AT_OS_1200XL   2
319 #define AT_OS_XLXE     3
320 /* AS_OS_TYPE_MINOR values */
321 /* for 400/800 remember this are the ROM versions */
322 /* to check whether the hw is PAL or NTSC, use get_tv() */
323 #define AT_OS_400800PAL_A  1
324 #define AT_OS_400800PAL_B  2
325 #define AT_OS_400800NTSC_A 1
326 #define AT_OS_400800NTSC_B 2
327 #define AT_OS_1200_10  1
328 #define AT_OS_1200_11  2
329 #define AT_OS_XLXE_1   1
330 #define AT_OS_XLXE_2   2
331 #define AT_OS_XLXE_3   3
332 #define AT_OS_XLXE_4   4
333
334
335 /*****************************************************************************/
336 /* get_tv return values                                                      */
337 /*****************************************************************************/
338
339 #define AT_NTSC     0
340 #define AT_PAL      1
341
342
343 /*****************************************************************************/
344 /* valid _dos_type values                                                    */
345 /*****************************************************************************/
346
347 #define SPARTADOS   0
348 #define REALDOS     1
349 #define BWDOS       2
350 #define OSADOS      3
351 #define XDOS        4
352 #define ATARIDOS    5
353 #define MYDOS       6
354 #define NODOS       255
355
356
357 /*****************************************************************************/
358 /* Define hardware and where they're mapped in memory                        */
359 /*****************************************************************************/
360
361 #include <_gtia.h>
362 #define GTIA_READ  (*(struct __gtia_read*)0xD000)
363 #define GTIA_WRITE (*(struct __gtia_write*)0xD000)
364
365 #include <_pbi.h>
366
367 #include <_pokey.h>
368 #define POKEY_READ  (*(struct __pokey_read*)0xD200)
369 #define POKEY_WRITE (*(struct __pokey_write*)0xD200)
370
371 #include <_pia.h>
372 #define PIA (*(struct __pia*)0xD300)
373
374 #include <_antic.h>
375 #define ANTIC (*(struct __antic*)0xD400)
376
377
378 /*****************************************************************************/
379 /* Shadow registers for hardware registers                                   */
380 /*****************************************************************************/
381
382 /* GTIA */
383 #define STRIG0 (*(unsigned char*)0x284) /* TRIG0 */
384 #define STRIG1 (*(unsigned char*)0x285) /* TRIG1 */
385 #define STRIG2 (*(unsigned char*)0x286) /* TRIG2 */
386 #define STRIG3 (*(unsigned char*)0x287) /* TRIG3 */
387 #define PCOLR0 (*(unsigned char*)0x2C0) /* COLPM0 */
388 #define PCOLR1 (*(unsigned char*)0x2C1) /* COLPM1 */
389 #define PCOLR2 (*(unsigned char*)0x2C2) /* COLPM2 */
390 #define PCOLR3 (*(unsigned char*)0x2C3) /* COLPM3 */
391 #define COLOR0 (*(unsigned char*)0x2C4) /* COLPF0 */
392 #define COLOR1 (*(unsigned char*)0x2C5) /* COLPF1 */
393 #define COLOR2 (*(unsigned char*)0x2C6) /* COLPF2 */
394 #define COLOR3 (*(unsigned char*)0x2C7) /* COLPF3 */
395 #define COLOR4 (*(unsigned char*)0x2C8) /* COLPBK */
396 #define GPRIOR (*(unsigned char*)0x264) /* PRIOR */
397
398 /* ANTIC */
399 #define SDMCTL (*(unsigned char*)0x22F) /* DMACTL */
400 #define CHACT  (*(unsigned char*)0x2F3) /* CHACTL */
401 #define SDLSTL (*(unsigned char*)0x230) /* DLISTL */
402 #define SDLSTH (*(unsigned char*)0x231) /* DLISTH */
403 #define SDLST  (*(unsigned int*)0x230)  /* DLISTL/H together */
404 #define CHBAS  (*(unsigned char*)0x2F4) /* CHBASE */
405 #define LPENH  (*(unsigned char*)0x233) /* PENH */
406 #define LPENV  (*(unsigned char*)0x234) /* PENV */
407
408 /* POKEY */
409 #define PADDL0 (*(unsigned char*)0x270) /* POT0 */
410 #define PADDL1 (*(unsigned char*)0x271) /* POT1 */
411 #define PADDL2 (*(unsigned char*)0x272) /* POT2 */
412 #define PADDL3 (*(unsigned char*)0x273) /* POT3 */
413 #define PADDL4 (*(unsigned char*)0x274) /* POT4 */
414 #define PADDL5 (*(unsigned char*)0x275) /* POT5 */
415 #define PADDL6 (*(unsigned char*)0x276) /* POT6 */
416 #define PADDL7 (*(unsigned char*)0x277) /* POT7 */
417 #define CH     (*(unsigned char*)0x2FC) /* KBCODE */
418 #define POKMSK (*(unsigned char*)0x10)  /* IRQEN */
419
420 /* PIA */
421 #define STICK0 (*(unsigned char*)0x278) /* PORTA for controller port 1 */
422 #define STICK1 (*(unsigned char*)0x279) /* PORTA for controller port 2 */
423 #define STICK2 (*(unsigned char*)0x27A) /* PORTB for controller port 3 */
424 #define STICK3 (*(unsigned char*)0x27B) /* PORTB for controller port 4 */
425 #define PTRIG0 (*(unsigned char*)0x27C) /* PORTA for controller port 1, paddle 1 */
426 #define PTRIG1 (*(unsigned char*)0x27D) /* PORTA for controller port 1, paddle 2 */
427 #define PTRIG2 (*(unsigned char*)0x27E) /* PORTA for controller port 1, paddle 3 */
428 #define PTRIG3 (*(unsigned char*)0x27F) /* PORTA for controller port 1, paddle 4 */
429 #define PTRIG4 (*(unsigned char*)0x280) /* PORTA for controller port 2, paddle 5 */
430 #define PTRIG5 (*(unsigned char*)0x281) /* PORTA for controller port 2, paddle 6 */
431 #define PTRIG6 (*(unsigned char*)0x282) /* PORTA for controller port 2, paddle 7 */
432 #define PTRIG7 (*(unsigned char*)0x283) /* PORTA for controller port 2, paddle 8 */
433
434
435 /*****************************************************************************/
436 /* Device control block                                                      */
437 /*****************************************************************************/
438
439 struct __dcb {
440     unsigned char device;     /* device id */
441     unsigned char unit;       /* unit number */
442     unsigned char command;    /* command */
443     unsigned char status;     /* command type / status return */
444     void          *buffer;    /* pointer to buffer */
445     unsigned char timeout;    /* device timeout in seconds */
446     unsigned char unused;
447     unsigned int  xfersize;   /* # of bytes to transfer */
448     unsigned char aux1;       /* 1st command auxiliary byte */
449     unsigned char aux2;       /* 2nd command auxiliary byte */
450 };
451 #define DCB (*(struct __dcb *)0x300)
452
453
454 /*****************************************************************************/
455 /* I/O control block                                                         */
456 /*****************************************************************************/
457
458 struct __iocb {
459     unsigned char handler;    /* handler index number (0xff free) */
460     unsigned char drive;      /* device number (drive) */
461     unsigned char command;    /* command */
462     unsigned char status;     /* status of last operation */
463     void          *buffer;    /* pointer to buffer */
464     void          *put_byte;  /* pointer to device's PUT BYTE routine */
465     unsigned int  buflen;     /* length of buffer */
466     unsigned char aux1;       /* 1st auxiliary byte */
467     unsigned char aux2;       /* 2nd auxiliary byte */
468     unsigned char aux3;       /* 3rd auxiliary byte */
469     unsigned char aux4;       /* 4th auxiliary byte */
470     unsigned char aux5;       /* 5th auxiliary byte */
471     unsigned char spare;      /* spare byte */
472 };
473 #define ZIOCB (*(struct __iocb *)0x20)  /* zero page IOCB */
474 #define IOCB (*(struct __iocb *)0x340)  /* system IOCB buffers */
475
476 /* IOCB Command Codes */
477 #define IOCB_OPEN        0x03  /* open */
478 #define IOCB_GETREC      0x05  /* get record */
479 #define IOCB_GETCHR      0x07  /* get character(s) */
480 #define IOCB_PUTREC      0x09  /* put record */
481 #define IOCB_PUTCHR      0x0B  /* put character(s) */
482 #define IOCB_CLOSE       0x0C  /* close */
483 #define IOCB_STATIS      0x0D  /* status */
484 #define IOCB_SPECIL      0x0E  /* special */
485 #define IOCB_DRAWLN      0x11  /* draw line */
486 #define IOCB_FILLIN      0x12  /* draw line with right fill */
487 #define IOCB_RENAME      0x20  /* rename disk file */
488 #define IOCB_DELETE      0x21  /* delete disk file */
489 #define IOCB_LOCKFL      0x23  /* lock file (set to read-only) */
490 #define IOCB_UNLOCK      0x24  /* unlock file */
491 #define IOCB_POINT       0x25  /* point sector */
492 #define IOCB_NOTE        0x26  /* note sector */
493 #define IOCB_GETFL       0x27  /* get file length */
494 #define IOCB_CHDIR_MYDOS 0x29  /* change directory (MyDOS) */
495 #define IOCB_MKDIR       0x2A  /* make directory (MyDOS/SpartaDOS) */
496 #define IOCB_RMDIR       0x2B  /* remove directory (SpartaDOS) */
497 #define IOCB_CHDIR_SPDOS 0x2C  /* change directory (SpartaDOS) */
498 #define IOCB_GETCWD      0x30  /* get current directory (MyDOS/SpartaDOS) */
499 #define IOCB_FORMAT      0xFE  /* format */
500
501
502 /* End of atari.h */
503 #endif