/* */
/* Internal include file, do not use directly */
/* */
+/* POKEY, Pot Keyboard Integrated Circuit, is a digital I/O chip designed */
+/* for the Atari 8-bit family of home computers; it combines functions for */
+/* sampling (ADC) potentiometers (such as game paddles) and scan matrices of */
+/* switches (such as a computer keyboard) as well as sound generation. */
+/* It produces four voices of distinctive square wave sound, either as clear */
+/* tones or modified with a number of distortion settings. - Wikipedia */
+/* "POKEY" article. */
/* */
/* */
/* (C) 2000 Freddy Offenga <taf_offenga@yahoo.com> */
+/* 2019-01-13: Bill Kendrick <nbs@sonic.net>: More defines for registers */
/* */
/* */
/* This software is provided 'as-is', without any expressed or implied */
-/* Define a structure with the pokey register offsets */
+/* Define a structure with the POKEY register offsets for write (W) */
struct __pokey_write {
unsigned char audf1; /* audio channel #1 frequency */
unsigned char audc1; /* audio channel #1 control */
unsigned char audc3; /* audio channel #3 control */
unsigned char audf4; /* audio channel #4 frequency */
unsigned char audc4; /* audio channel #4 control */
+
+/* The values for the distortion bits (AUDCx) are as follows;
+ the first process is to divide the clock value by the frequency,
+ then mask the output using the polys in the order below;
+ finally, the result is divided by two */
+#define AUDC_POLYS_5_17 0x00
+#define AUDC_POLYS_5 0x20 /* Same as 0x60 */
+#define AUDC_POLYS_5_4 0x40
+#define AUDC_POLYS_17 0x80
+#define AUDC_POLYS_NONE 0xA0 /* Same as 0xE0 */
+#define AUDC_POLYS_4 0xC0
+
+#define AUDC_VOLUME_ONLY 0x10
+
+
unsigned char audctl; /* audio control */
+
+#define AUDCTL_CLOCKBASE_15HZ 0x01 /* Switch main clock base from 64 KHz to 15 KHz */
+#define AUDCTL_HIGHPASS_CHAN2 0x02 /* Insert high pass filter into channel two, clocked by channel four */
+#define AUDCTL_HIGHPASS_CHAN1 0x04 /* Insert high pass filter into channel one, clocked by channel two */
+#define AUDCTL_JOIN_CHAN34 0x08 /* Join channels four and three (16 bit) */
+#define AUDCTL_JOIN_CHAN12 0x10 /* Join channels two and one (16 bit) */
+#define AUDCTL_CLOCK_CHAN3_179MHZ 0x20 /* Clock channel three with 1.79 MHz */
+#define AUDCTL_CLOCK_CHAN1_179MHZ 0x40 /* Clock channel one with 1.79 MHz */
+#define AUDCTL_9BIT_POLY 0x80 /* Makes the 17 bit poly counter into nine bit poly (see also: RANDOM) */
+
unsigned char stimer; /* start pokey timers */
- unsigned char skrest; /* reset serial port status reg. */
- unsigned char potgo; /* start paddle scan sequence */
+
+ unsigned char skrest; /* reset serial port status reg.;
+ Reset BITs 5 - 7 of the serial port status register (SKCTL) to "1" */
+
+ unsigned char potgo; /* start paddle scan sequence (see "ALLPOT") */
unsigned char unuse1; /* unused */
unsigned char serout; /* serial port data output */
+
unsigned char irqen; /* interrupt request enable */
+#define POKMSK *(unsigned char *) 0x10 /* POKEY interrupts: the IRQ service uses and alters this location */
+#define IRQEN_TIMER_1 0x01 /* The POKEY timer one interrupt is enabled */
+#define IRQEN_TIMER_2 0x02 /* The POKEY timer two interrupt is enabled */
+#define IRQEN_TIMER_4 0x04 /* The POKEY timer four interrupt is enabled */
+#define IRQEN_SERIAL_TRANS_FINISHED 0x08 /* The serial out transmission finished interrupt is enabled */
+#define IRQEN_SERIAL_OUT_DATA_REQUIRED 0x10 /* The serial output data required interrupt is enabled */
+#define IRQEN_SERIAL_IN_DATA_READY 0x20 /* The serial input data ready interrupt is enabled. */
+#define IRQEN_OTHER_KEY 0x40 /* The "other key" interrupt is enabled */
+#define IRQEN_BREAK_KEY 0x80 /* The BREAK key is enabled */
+
+
unsigned char skctl; /* serial port control */
+
+#define SKCTL_KEYBOARD_DEBOUNCE 0x01 /* Enable keyboard debounce circuits */
+#define SKCTL_KEYBOARD_SCANNING 0x02 /* Enable keyboard scanning circuit */
+#define SKCTL_FAST_POT_SCAN 0x04 /* Fast pot scan */
+/* the pot scan counter completes its sequence in two TV line times instead of
+ one frame time (228 scan lines). Not as accurate as the normal pot scan */
+#define SKCTL_TWO_TONE_MODE 0x08 /* Serial output is transmitted as a two-tone
+signal rather than a logic true/false. POKEY two-tone mode. */
+/* Serial port mode control used to set the bi-directional clock lines */
+#define SKCTL_BIT4 0x10 /* FIXME; more meaningful name */
+#define SKCTL_BIT5 0x20 /* FIXME; more meaningful name */
+#define SKCTL_BIT6 0x40 /* FIXME; more meaningful name */
+#define SKCTL_FORCE_BREAK 0x80 /* Force break (serial output to zero) */
};
+
+
+/* Define a structure with the POKEY register offsets for read (R) */
struct __pokey_read {
unsigned char pot0; /* paddle 0 value */
unsigned char pot1; /* paddle 1 value */
unsigned char pot5; /* paddle 5 value */
unsigned char pot6; /* paddle 6 value */
unsigned char pot7; /* paddle 7 value */
- unsigned char allpot; /* eight paddle port status */
+ unsigned char allpot; /* eight paddle port status (see "POTGO") */
unsigned char kbcode; /* keyboard code */
unsigned char random; /* random number generator */
unsigned char unuse2; /* unused */
unsigned char unuse3; /* unused */
unsigned char serin; /* serial port input */
unsigned char irqst; /* interrupt request status */
+
unsigned char skstat; /* serial port status */
+#define SKSTAT_SERIN_SHIFTREG_BUSY 0x02 /* Serial input shift register busy */
+#define SKSTAT_LASTKEY_PRESSED 0x04 /* the last key is still pressed */
+#define SKSTAT_SHIFTKEY_PRESSED 0x08 /* the [Shift] key is pressed */
+#define SKSTAT_DATA_READ_INGORING_SHIFTREG 0x10 /* Data can be read directly from the serial input port, ignoring the shift register. */
+#define SKSTAT_KEYBOARD_OVERRUN 0x20 /* Keyboard over-run; Reset BITs 7, 6 and 5 (latches) to 1, using SKREST */
+#define SKSTAT_INPUT_OVERRUN 0x40 /* Serial data input over-run. Reset latches as above. */
+#define SKSTAT_INPUT_FRAMEERROR 0x80 /* Serial data input frame error caused by missing or extra bits. Reset latches as above. */
};
+/* Internal keyboard codes from http://www.atariarchives.org/c3ba/page004.php */
+/* (Defined below in the order the keys appear on a 1200XL keyboard, from top left to bottom right) */
+/* (Note: Numerous Shift+Ctrl+key combos are unavailable) */
+
+#define KEYCODE_NONE 255 /* 255 = no key pressed (but is also same as Ctrl+Shift+A) */
+
+/* Fn (function) keys only available on 1200XL */
+#define KEYCODE_F1 3
+#define KEYCODE_F2 4
+#define KEYCODE_F3 19
+#define KEYCODE_F4 20
+
+/* HELP key only available on XL/XE series */
+#define KEYCODE_HELP 17
+
+#define KEYCODE_ESC 28
+#define KEYCODE_1 31
+#define KEYCODE_2 30
+#define KEYCODE_3 26
+#define KEYCODE_4 24
+#define KEYCODE_5 29
+#define KEYCODE_6 27
+#define KEYCODE_7 51
+#define KEYCODE_8 53
+#define KEYCODE_9 48
+#define KEYCODE_0 50
+#define KEYCODE_LT 54
+#define KEYCODE_GT 55
+#define KEYCODE_BKSPC 52
+
+#define KEYCODE_TAB 44
+#define KEYCODE_Q 47
+#define KEYCODE_W 46
+#define KEYCODE_E 42
+#define KEYCODE_R 40
+#define KEYCODE_T 45
+#define KEYCODE_Y 43
+#define KEYCODE_U 11
+#define KEYCODE_I 13
+#define KEYCODE_O 8
+#define KEYCODE_P 10
+#define KEYCODE_MINUS 14
+#define KEYCODE_EQUALS 15
+#define KEYCODE_RETURN 12
+
+#define KEYCODE_CTRL 128 /* binary OR'd */
+
+#define KEYCODE_A 63
+#define KEYCODE_S 62
+#define KEYCODE_D 58
+#define KEYCODE_F 56
+#define KEYCODE_G 61
+#define KEYCODE_H 57
+#define KEYCODE_J 1
+#define KEYCODE_K 5
+#define KEYCODE_L 0
+#define KEYCODE_; 2
+#define KEYCODE_PLUS 6
+#define KEYCODE_ASTERISK 7
+#define KEYCODE_CAPS 60
+
+#define KEYCODE_SHIFT 64 /* binary OR'd */
+
+#define KEYCODE_Z 23
+#define KEYCODE_X 22
+#define KEYCODE_C 18
+#define KEYCODE_V 16
+#define KEYCODE_B 21
+#define KEYCODE_N 35
+#define KEYCODE_M 37
+#define KEYCODE_COMMA 32
+#define KEYCODE_PERIOD 34
+#define KEYCODE_SLASH 38
+#define KEYCODE_FUJI 39 /* (as seen on 400/800) */
+#define KEYCODE_INVERSE 39 /* (alternative name; as seen on XL/XE) */
+
+#define KEYCODE_SPACE 33
+
+
/* End of _pokey.h */
#endif /* #ifndef __POKEY_H */
projects / cc65 / commitdiff