[mirror_ubuntu-bionic-kernel.git] / Documentation / input / devices / amijoy.rst

~~~~~~~~~~~~~~~~~~~~~~~~~
Amiga joystick extensions
~~~~~~~~~~~~~~~~~~~~~~~~~


Amiga 4-joystick parport extension
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Parallel port pins:


=====  ======== ====   ==========
Pin    Meaning  Pin    Meaning
=====  ======== ====   ==========
 2     Up1	 6     Up2
 3     Down1	 7     Down2
 4     Left1	 8     Left2
 5     Right1	 9     Right2
13     Fire1	11     Fire2
18     Gnd1	18     Gnd2
=====  ======== ====   ==========

Amiga digital joystick pinout
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

=== ============
Pin Meaning
=== ============
1   Up
2   Down
3   Left
4   Right
5   n/c
6   Fire button
7   +5V (50mA)
8   Gnd
9   Thumb button
=== ============

Amiga mouse pinout
~~~~~~~~~~~~~~~~~~

=== ============
Pin Meaning
=== ============
1   V-pulse
2   H-pulse
3   VQ-pulse
4   HQ-pulse
5   Middle button
6   Left button
7   +5V (50mA)
8   Gnd
9   Right button
=== ============

Amiga analog joystick pinout
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

=== ==============
Pin Meaning
=== ==============
1   Top button
2   Top2 button
3   Trigger button
4   Thumb button
5   Analog X
6   n/c
7   +5V (50mA)
8   Gnd
9   Analog Y
=== ==============

Amiga lightpen pinout
~~~~~~~~~~~~~~~~~~~~~

=== =============
Pin Meaning
=== =============
1   n/c
2   n/c
3   n/c
4   n/c
5   Touch button
6   /Beamtrigger
7   +5V (50mA)
8   Gnd
9   Stylus button
=== =============

-------------------------------------------------------------------------------

======== === ==== ==== ====== ========================================
NAME     rev ADDR type chip   Description
======== === ==== ==== ====== ========================================
JOY0DAT      00A   R   Denise Joystick-mouse 0 data (left vert, horiz)
JOY1DAT      00C   R   Denise Joystick-mouse 1 data (right vert,horiz)
======== === ==== ==== ====== ========================================

        These addresses each read a 16 bit register. These in turn
        are loaded from the MDAT serial stream and are clocked in on
        the rising edge of SCLK. MLD output is used to parallel load
        the external parallel-to-serial converter.This in turn is
        loaded with the 4 quadrature inputs from each of two game
        controller ports (8 total) plus 8 miscellaneous control bits
        which are new for LISA and can be read in upper 8 bits of
        LISAID.

        Register bits are as follows:

        - Mouse counter usage (pins  1,3 =Yclock, pins 2,4 =Xclock)

======== === === === === === === === === ====== === === === === === === ===
    BIT#  15  14  13  12  11  10  09  08     07  06  05  04  03  02  01  00
======== === === === === === === === === ====== === === === === === === ===
JOY0DAT   Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0     X7  X6  X5  X4  X3  X2  X1  X0
JOY1DAT   Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0     X7  X6  X5  X4  X3  X2  X1  X0
======== === === === === === === === === ====== === === === === === === ===

        0=LEFT CONTROLLER PAIR, 1=RIGHT CONTROLLER PAIR.
        (4 counters total). The bit usage for both left and right
        addresses is shown below. Each 6 bit counter (Y7-Y2,X7-X2) is
        clocked by 2 of the signals input from the mouse serial
        stream. Starting with first bit received:

         +-------------------+-----------------------------------------+
         | Serial | Bit Name | Description                             |
         +========+==========+=========================================+
         |   0    | M0H      | JOY0DAT Horizontal Clock                |
         +--------+----------+-----------------------------------------+
         |   1    | M0HQ     | JOY0DAT Horizontal Clock (quadrature)   |
         +--------+----------+-----------------------------------------+
         |   2    | M0V      | JOY0DAT Vertical Clock                  |
         +--------+----------+-----------------------------------------+
         |   3    | M0VQ     | JOY0DAT Vertical Clock  (quadrature)    |
         +--------+----------+-----------------------------------------+
         |   4    | M1V      | JOY1DAT Horizontal Clock                |
         +--------+----------+-----------------------------------------+
         |   5    | M1VQ     | JOY1DAT Horizontal Clock (quadrature)   |
         +--------+----------+-----------------------------------------+
         |   6    | M1V      | JOY1DAT Vertical Clock                  |
         +--------+----------+-----------------------------------------+
         |   7    | M1VQ     | JOY1DAT Vertical Clock (quadrature)     |
         +--------+----------+-----------------------------------------+

         Bits 1 and 0 of each counter (Y1-Y0,X1-X0) may be
         read to determine the state of the related input signal pair.
         This allows these pins to double as joystick switch inputs.
         Joystick switch closures can be deciphered as follows:

         +------------+------+---------------------------------+
         | Directions | Pin# | Counter bits                    |
         +============+======+=================================+
         | Forward    |  1   | Y1 xor Y0 (BIT#09 xor BIT#08)   |
         +------------+------+---------------------------------+
         | Left       |  3   | Y1                              |
         +------------+------+---------------------------------+
         | Back       |  2   | X1 xor X0 (BIT#01 xor BIT#00)   |
         +------------+------+---------------------------------+
         | Right      |  4   | X1                              |
         +------------+------+---------------------------------+

-------------------------------------------------------------------------------

========  === ==== ==== ====== =================================================
NAME      rev ADDR type chip    Description
========  === ==== ==== ====== =================================================
JOYTEST       036   W   Denise  Write to all 4  joystick-mouse counters at once.
========  === ==== ==== ====== =================================================

                  Mouse counter write test data:

========= === === === === === === === === ====== === === === === === === ===
     BIT#  15  14  13  12  11  10  09  08     07  06  05  04  03  02  01  00
========= === === === === === === === === ====== === === === === === === ===
  JOYxDAT  Y7  Y6  Y5  Y4  Y3  Y2  xx  xx     X7  X6  X5  X4  X3  X2  xx  xx
  JOYxDAT  Y7  Y6  Y5  Y4  Y3  Y2  xx  xx     X7  X6  X5  X4  X3  X2  xx  xx
========= === === === === === === === === ====== === === === === === === ===

-------------------------------------------------------------------------------

======= === ==== ==== ====== ========================================
NAME    rev ADDR type chip   Description
======= === ==== ==== ====== ========================================
POT0DAT  h  012   R   Paula  Pot counter data left pair (vert, horiz)
POT1DAT  h  014   R   Paula  Pot counter data right pair (vert,horiz)
======= === ==== ==== ====== ========================================

        These addresses each read a pair of 8 bit pot counters.
        (4 counters total). The bit assignment for both
        addresses is shown below. The counters are stopped by signals
        from 2 controller connectors (left-right) with 2 pins each.

====== === === === === === === === === ====== === === === === === === ===
  BIT#  15  14  13  12  11  10  09  08     07  06  05  04  03  02  01  00
====== === === === === === === === === ====== === === === === === === ===
 RIGHT  Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0     X7  X6  X5  X4  X3  X2  X1  X0
  LEFT  Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0     X7  X6  X5  X4  X3  X2  X1  X0
====== === === === === === === === === ====== === === === === === === ===

         +--------------------------+-------+
         | CONNECTORS               | PAULA |
         +-------+------+-----+-----+-------+
         | Loc.  | Dir. | Sym | pin | pin   |
         +=======+======+=====+=====+=======+
         | RIGHT | Y    | RX  | 9   | 33    |
         +-------+------+-----+-----+-------+
         | RIGHT | X    | RX  | 5   | 32    |
         +-------+------+-----+-----+-------+
         | LEFT  | Y    | LY  | 9   | 36    |
         +-------+------+-----+-----+-------+
         | LEFT  | X    | LX  | 5   | 35    |
         +-------+------+-----+-----+-------+

         With normal (NTSC or PAL) horiz. line rate, the pots will
         give a full scale (FF) reading with about 500kohms in one
         frame time. With proportionally faster horiz line times,
         the counters will count proportionally faster.
         This should be noted when doing variable beam displays.

-------------------------------------------------------------------------------

====== === ==== ==== ====== ================================================
NAME   rev ADDR type chip   Description
====== === ==== ==== ====== ================================================
POTGO      034   W   Paula  Pot port (4 bit) bi-direction and data, and pot
			    counter start.
====== === ==== ==== ====== ================================================

-------------------------------------------------------------------------------

====== === ==== ==== ====== ================================================
NAME   rev ADDR type chip   Description
====== === ==== ==== ====== ================================================
POTINP     016   R   Paula  Pot pin data read
====== === ==== ==== ====== ================================================

        This register controls a 4 bit bi-direction I/O port
        that shares the same 4 pins as the 4 pot counters above.

         +-------+----------+---------------------------------------------+
         | BIT#  | FUNCTION | DESCRIPTION                                 |
         +=======+==========+=============================================+
         | 15    | OUTRY    | Output enable for Paula pin 33              |
         +-------+----------+---------------------------------------------+
         | 14    | DATRY    | I/O data Paula pin 33                       |
         +-------+----------+---------------------------------------------+
         | 13    | OUTRX    | Output enable for Paula pin 32              |
         +-------+----------+---------------------------------------------+
         | 12    | DATRX    | I/O data Paula pin 32                       |
         +-------+----------+---------------------------------------------+
         | 11    | OUTLY    | Out put enable for Paula pin 36             |
         +-------+----------+---------------------------------------------+
         | 10    | DATLY    | I/O data Paula pin 36                       |
         +-------+----------+---------------------------------------------+
         | 09    | OUTLX    | Output enable for Paula pin 35              |
         +-------+----------+---------------------------------------------+
         | 08    | DATLX    | I/O data  Paula pin 35                      |
         +-------+----------+---------------------------------------------+
         | 07-01 |   X      | Not used                                    |
         +-------+----------+---------------------------------------------+
         | 00    | START    | Start pots (dump capacitors,start counters) |
         +-------+----------+---------------------------------------------+
Commit	Line	Data
691d8706 MCC	1	~~~~~~~~~~~~~~~~~~~~~~~~~
	2	Amiga joystick extensions
	3	~~~~~~~~~~~~~~~~~~~~~~~~~
	4
	5
1da177e4 LT	6	Amiga 4-joystick parport extension
1da177e4 LT	7	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
691d8706	8
1da177e4 LT	9	Parallel port pins:
1da177e4 LT	10
691d8706 MCC	11
	12	===== ======== ==== ==========
	13	Pin Meaning Pin Meaning
	14	===== ======== ==== ==========
	15	2 Up1 6 Up2
	16	3 Down1 7 Down2
	17	4 Left1 8 Left2
	18	5 Right1 9 Right2
	19	13 Fire1 11 Fire2
	20	18 Gnd1 18 Gnd2
	21	===== ======== ==== ==========
1da177e4 LT	22
	23	Amiga digital joystick pinout
	24	~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
691d8706 MCC	25
	26	=== ============
	27	Pin Meaning
	28	=== ============
	29	1 Up
	30	2 Down
	31	3 Left
	32	4 Right
	33	5 n/c
	34	6 Fire button
	35	7 +5V (50mA)
	36	8 Gnd
	37	9 Thumb button
	38	=== ============
1da177e4 LT	39
	40	Amiga mouse pinout
	41	~~~~~~~~~~~~~~~~~~
691d8706 MCC	42
	43	=== ============
	44	Pin Meaning
	45	=== ============
	46	1 V-pulse
	47	2 H-pulse
	48	3 VQ-pulse
	49	4 HQ-pulse
	50	5 Middle button
	51	6 Left button
	52	7 +5V (50mA)
	53	8 Gnd
	54	9 Right button
	55	=== ============
1da177e4 LT	56
	57	Amiga analog joystick pinout
	58	~~~~~~~~~~~~~~~~~~~~~~~~~~~~
691d8706 MCC	59
	60	=== ==============
	61	Pin Meaning
	62	=== ==============
	63	1 Top button
	64	2 Top2 button
	65	3 Trigger button
	66	4 Thumb button
	67	5 Analog X
	68	6 n/c
	69	7 +5V (50mA)
	70	8 Gnd
	71	9 Analog Y
	72	=== ==============
1da177e4 LT	73
	74	Amiga lightpen pinout
	75	~~~~~~~~~~~~~~~~~~~~~
691d8706 MCC	76
	77	=== =============
	78	Pin Meaning
	79	=== =============
	80	1 n/c
	81	2 n/c
	82	3 n/c
	83	4 n/c
	84	5 Touch button
	85	6 /Beamtrigger
	86	7 +5V (50mA)
	87	8 Gnd
	88	9 Stylus button
	89	=== =============
1da177e4 LT	90
	91	-------------------------------------------------------------------------------
	92
691d8706	93	======== === ==== ==== ====== ========================================
1da177e4	94	NAME rev ADDR type chip Description
691d8706	95	======== === ==== ==== ====== ========================================
1da177e4 LT	96	JOY0DAT 00A R Denise Joystick-mouse 0 data (left vert, horiz)
1da177e4 LT	97	JOY1DAT 00C R Denise Joystick-mouse 1 data (right vert,horiz)
691d8706	98	======== === ==== ==== ====== ========================================
1da177e4 LT	99
	100	These addresses each read a 16 bit register. These in turn
	101	are loaded from the MDAT serial stream and are clocked in on
	102	the rising edge of SCLK. MLD output is used to parallel load
	103	the external parallel-to-serial converter.This in turn is
	104	loaded with the 4 quadrature inputs from each of two game
	105	controller ports (8 total) plus 8 miscellaneous control bits
	106	which are new for LISA and can be read in upper 8 bits of
	107	LISAID.
691d8706	108
1da177e4	109	Register bits are as follows:
1da177e4	110
691d8706 MCC	111	- Mouse counter usage (pins 1,3 =Yclock, pins 2,4 =Xclock)
	112
	113	======== === === === === === === === === ====== === === === === === === ===
1da177e4	114	BIT# 15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00
691d8706	115	======== === === === === === === === === ====== === === === === === === ===
1da177e4 LT	116	JOY0DAT Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0 X7 X6 X5 X4 X3 X2 X1 X0
1da177e4 LT	117	JOY1DAT Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0 X7 X6 X5 X4 X3 X2 X1 X0
691d8706	118	======== === === === === === === === === ====== === === === === === === ===
1da177e4 LT	119
1da177e4 LT	120	0=LEFT CONTROLLER PAIR, 1=RIGHT CONTROLLER PAIR.
d6bc8ac9	121	(4 counters total). The bit usage for both left and right
1da177e4 LT	122	addresses is shown below. Each 6 bit counter (Y7-Y2,X7-X2) is
1da177e4 LT	123	clocked by 2 of the signals input from the mouse serial
d6bc8ac9	124	stream. Starting with first bit received:
1da177e4 LT	125
	126	+-------------------+-----------------------------------------+
	127	\| Serial \| Bit Name \| Description \|
691d8706	128	+========+==========+=========================================+
1da177e4	129	\| 0 \| M0H \| JOY0DAT Horizontal Clock \|
691d8706	130	+--------+----------+-----------------------------------------+
1da177e4	131	\| 1 \| M0HQ \| JOY0DAT Horizontal Clock (quadrature) \|
691d8706	132	+--------+----------+-----------------------------------------+
1da177e4	133	\| 2 \| M0V \| JOY0DAT Vertical Clock \|
691d8706	134	+--------+----------+-----------------------------------------+
1da177e4	135	\| 3 \| M0VQ \| JOY0DAT Vertical Clock (quadrature) \|
691d8706	136	+--------+----------+-----------------------------------------+
5d3f083d	137	\| 4 \| M1V \| JOY1DAT Horizontal Clock \|
691d8706	138	+--------+----------+-----------------------------------------+
5d3f083d	139	\| 5 \| M1VQ \| JOY1DAT Horizontal Clock (quadrature) \|
691d8706	140	+--------+----------+-----------------------------------------+
1da177e4	141	\| 6 \| M1V \| JOY1DAT Vertical Clock \|
691d8706	142	+--------+----------+-----------------------------------------+
1da177e4 LT	143	\| 7 \| M1VQ \| JOY1DAT Vertical Clock (quadrature) \|
	144	+--------+----------+-----------------------------------------+
	145
	146	Bits 1 and 0 of each counter (Y1-Y0,X1-X0) may be
	147	read to determine the state of the related input signal pair.
	148	This allows these pins to double as joystick switch inputs.
	149	Joystick switch closures can be deciphered as follows:
	150
	151	+------------+------+---------------------------------+
	152	\| Directions \| Pin# \| Counter bits \|
691d8706	153	+============+======+=================================+
1da177e4	154	\| Forward \| 1 \| Y1 xor Y0 (BIT#09 xor BIT#08) \|
691d8706	155	+------------+------+---------------------------------+
1da177e4	156	\| Left \| 3 \| Y1 \|
691d8706	157	+------------+------+---------------------------------+
1da177e4	158	\| Back \| 2 \| X1 xor X0 (BIT#01 xor BIT#00) \|
691d8706	159	+------------+------+---------------------------------+
1da177e4 LT	160	\| Right \| 4 \| X1 \|
	161	+------------+------+---------------------------------+
	162
	163	-------------------------------------------------------------------------------
	164
691d8706	165	======== === ==== ==== ====== =================================================
1da177e4	166	NAME rev ADDR type chip Description
691d8706	167	======== === ==== ==== ====== =================================================
1da177e4	168	JOYTEST 036 W Denise Write to all 4 joystick-mouse counters at once.
691d8706	169	======== === ==== ==== ====== =================================================
1da177e4 LT	170
1da177e4 LT	171	Mouse counter write test data:
691d8706 MCC	172
691d8706 MCC	173	========= === === === === === === === === ====== === === === === === === ===
1da177e4	174	BIT# 15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00
691d8706	175	========= === === === === === === === === ====== === === === === === === ===
1da177e4 LT	176	JOYxDAT Y7 Y6 Y5 Y4 Y3 Y2 xx xx X7 X6 X5 X4 X3 X2 xx xx
1da177e4 LT	177	JOYxDAT Y7 Y6 Y5 Y4 Y3 Y2 xx xx X7 X6 X5 X4 X3 X2 xx xx
691d8706	178	========= === === === === === === === === ====== === === === === === === ===
1da177e4 LT	179
	180	-------------------------------------------------------------------------------
	181
691d8706	182	======= === ==== ==== ====== ========================================
1da177e4	183	NAME rev ADDR type chip Description
691d8706	184	======= === ==== ==== ====== ========================================
1da177e4 LT	185	POT0DAT h 012 R Paula Pot counter data left pair (vert, horiz)
1da177e4 LT	186	POT1DAT h 014 R Paula Pot counter data right pair (vert,horiz)
691d8706	187	======= === ==== ==== ====== ========================================
1da177e4 LT	188
	189	These addresses each read a pair of 8 bit pot counters.
	190	(4 counters total). The bit assignment for both
	191	addresses is shown below. The counters are stopped by signals
	192	from 2 controller connectors (left-right) with 2 pins each.
	193
691d8706	194	====== === === === === === === === === ====== === === === === === === ===
1da177e4	195	BIT# 15 14 13 12 11 10 09 08 07 06 05 04 03 02 01 00
691d8706	196	====== === === === === === === === === ====== === === === === === === ===
1da177e4 LT	197	RIGHT Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0 X7 X6 X5 X4 X3 X2 X1 X0
1da177e4 LT	198	LEFT Y7 Y6 Y5 Y4 Y3 Y2 Y1 Y0 X7 X6 X5 X4 X3 X2 X1 X0
691d8706	199	====== === === === === === === === === ====== === === === === === === ===
1da177e4 LT	200
	201	+--------------------------+-------+
	202	\| CONNECTORS \| PAULA \|
	203	+-------+------+-----+-----+-------+
	204	\| Loc. \| Dir. \| Sym \| pin \| pin \|
691d8706	205	+=======+======+=====+=====+=======+
1da177e4	206	\| RIGHT \| Y \| RX \| 9 \| 33 \|
691d8706	207	+-------+------+-----+-----+-------+
1da177e4	208	\| RIGHT \| X \| RX \| 5 \| 32 \|
691d8706	209	+-------+------+-----+-----+-------+
1da177e4	210	\| LEFT \| Y \| LY \| 9 \| 36 \|
691d8706	211	+-------+------+-----+-----+-------+
1da177e4 LT	212	\| LEFT \| X \| LX \| 5 \| 35 \|
	213	+-------+------+-----+-----+-------+
	214
	215	With normal (NTSC or PAL) horiz. line rate, the pots will
	216	give a full scale (FF) reading with about 500kohms in one
	217	frame time. With proportionally faster horiz line times,
	218	the counters will count proportionally faster.
	219	This should be noted when doing variable beam displays.
	220
	221	-------------------------------------------------------------------------------
	222
691d8706	223	====== === ==== ==== ====== ================================================
1da177e4	224	NAME rev ADDR type chip Description
691d8706 MCC	225	====== === ==== ==== ====== ================================================
	226	POTGO 034 W Paula Pot port (4 bit) bi-direction and data, and pot
	227	counter start.
	228	====== === ==== ==== ====== ================================================
1da177e4 LT	229
	230	-------------------------------------------------------------------------------
	231
691d8706	232	====== === ==== ==== ====== ================================================
1da177e4	233	NAME rev ADDR type chip Description
691d8706	234	====== === ==== ==== ====== ================================================
1da177e4	235	POTINP 016 R Paula Pot pin data read
691d8706	236	====== === ==== ==== ====== ================================================
1da177e4 LT	237
	238	This register controls a 4 bit bi-direction I/O port
	239	that shares the same 4 pins as the 4 pot counters above.
	240
	241	+-------+----------+---------------------------------------------+
	242	\| BIT# \| FUNCTION \| DESCRIPTION \|
691d8706	243	+=======+==========+=============================================+
1da177e4	244	\| 15 \| OUTRY \| Output enable for Paula pin 33 \|
691d8706	245	+-------+----------+---------------------------------------------+
1da177e4	246	\| 14 \| DATRY \| I/O data Paula pin 33 \|
691d8706	247	+-------+----------+---------------------------------------------+
1da177e4	248	\| 13 \| OUTRX \| Output enable for Paula pin 32 \|
691d8706	249	+-------+----------+---------------------------------------------+
1da177e4	250	\| 12 \| DATRX \| I/O data Paula pin 32 \|
691d8706	251	+-------+----------+---------------------------------------------+
1da177e4	252	\| 11 \| OUTLY \| Out put enable for Paula pin 36 \|
691d8706	253	+-------+----------+---------------------------------------------+
1da177e4	254	\| 10 \| DATLY \| I/O data Paula pin 36 \|
691d8706	255	+-------+----------+---------------------------------------------+
1da177e4	256	\| 09 \| OUTLX \| Output enable for Paula pin 35 \|
691d8706	257	+-------+----------+---------------------------------------------+
1da177e4	258	\| 08 \| DATLX \| I/O data Paula pin 35 \|
691d8706	259	+-------+----------+---------------------------------------------+
1da177e4	260	\| 07-01 \| X \| Not used \|
691d8706	261	+-------+----------+---------------------------------------------+
1da177e4 LT	262	\| 00 \| START \| Start pots (dump capacitors,start counters) \|
1da177e4 LT	263	+-------+----------+---------------------------------------------+