diff mbox series

[v2,3/4] input: docs: Fix Amiga joysticks grammar

Message ID 20250526135957.180254-4-contact@gvernon.com
State New
Headers show
Series Multiple fixes to Amiga joystick documentation | expand

Commit Message

George Anthony Vernon May 26, 2025, 1:59 p.m. UTC
Make small grammar fixes to Amiga joystick documentation.

Signed-off-by: George Anthony Vernon <contact@gvernon.com>
---
 Documentation/input/devices/amijoy.rst | 85 +++++++++++++-------------
 1 file changed, 42 insertions(+), 43 deletions(-)

Comments

Bagas Sanjaya May 29, 2025, 1:20 a.m. UTC | #1
On Mon, May 26, 2025 at 02:59:51PM +0100, George Anthony Vernon wrote:
> diff --git a/Documentation/input/devices/amijoy.rst b/Documentation/input/devices/amijoy.rst
> index ea4de1ac0360..cbc5240f8af3 100644
> --- a/Documentation/input/devices/amijoy.rst
> +++ b/Documentation/input/devices/amijoy.rst
> @@ -1,14 +1,13 @@
> -~~~~~~~~~~~~~~~~~~~~~~~~~
> -Amiga joystick extensions
> -~~~~~~~~~~~~~~~~~~~~~~~~~
> +~~~~~~~~~~~~~~~
> +Amiga joysticks
> +~~~~~~~~~~~~~~~
>  
>  
> -Amiga 4-joystick parport extension
> -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +Amiga 4-joystick parallel port extension
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>  
>  Parallel port pins:
>  
> -
>  =====  ======== ====   ==========
>  Pin    Meaning  Pin    Meaning
>  =====  ======== ====   ==========
> @@ -90,17 +89,17 @@ Pin Meaning
>  
>  -------------------------------------------------------------------------------
>  
> -======== === ==== ==== ====== ========================================
> +======== === ==== ==== ====== ===========================================
>  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)
> -======== === ==== ==== ====== ========================================
> +======== === ==== ==== ====== ===========================================
> +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
> +        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
> @@ -108,7 +107,7 @@ JOY1DAT      00C   R   Denise Joystick-mouse 1 data (right vert,horiz)
>  
>          Register bits are as follows:
>  
> -        - Mouse counter usage (pins  1,3 =Yclock, pins 2,4 =Xclock)
> +        - 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
> @@ -179,12 +178,12 @@ JOYTEST       036   W   Denise  Write to all 4  joystick-mouse counters at once.
>  
>  -------------------------------------------------------------------------------
>  
> -======= === ==== ==== ====== ========================================
> +======= === ==== ==== ====== ===========================================
>  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)
> -======= === ==== ==== ====== ========================================
> +======= === ==== ==== ====== ===========================================
> +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
> @@ -213,8 +212,8 @@ POT1DAT  h  014   R   Paula  Pot counter data right pair (vert,horiz)
>           +-------+------+-----+-----+-------+
>  
>           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,
> +         give a full scale (FF) reading with about 500k ohm 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.
>  
> @@ -238,26 +237,26 @@ 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) |
> -         +-------+----------+---------------------------------------------+
> +         +-------+----------+----------------------------------------------+
> +         | 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) |
> +         +-------+----------+----------------------------------------------+
 
LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
Bagas Sanjaya May 29, 2025, 1:23 a.m. UTC | #2
On Mon, May 26, 2025 at 02:59:51PM +0100, George Anthony Vernon wrote:
> -         +-------+----------+---------------------------------------------+
> -         | 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) |
> -         +-------+----------+---------------------------------------------+
> +         +-------+----------+----------------------------------------------+
> +         | 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              |
                                "Output"
> +         +-------+----------+----------------------------------------------+
> +         | 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) |
> +         +-------+----------+----------------------------------------------+

Thanks.
diff mbox series

Patch

diff --git a/Documentation/input/devices/amijoy.rst b/Documentation/input/devices/amijoy.rst
index ea4de1ac0360..cbc5240f8af3 100644
--- a/Documentation/input/devices/amijoy.rst
+++ b/Documentation/input/devices/amijoy.rst
@@ -1,14 +1,13 @@ 
-~~~~~~~~~~~~~~~~~~~~~~~~~
-Amiga joystick extensions
-~~~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~
+Amiga joysticks
+~~~~~~~~~~~~~~~
 
 
-Amiga 4-joystick parport extension
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Amiga 4-joystick parallel port extension
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Parallel port pins:
 
-
 =====  ======== ====   ==========
 Pin    Meaning  Pin    Meaning
 =====  ======== ====   ==========
@@ -90,17 +89,17 @@  Pin Meaning
 
 -------------------------------------------------------------------------------
 
-======== === ==== ==== ====== ========================================
+======== === ==== ==== ====== ===========================================
 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)
-======== === ==== ==== ====== ========================================
+======== === ==== ==== ====== ===========================================
+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
+        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
@@ -108,7 +107,7 @@  JOY1DAT      00C   R   Denise Joystick-mouse 1 data (right vert,horiz)
 
         Register bits are as follows:
 
-        - Mouse counter usage (pins  1,3 =Yclock, pins 2,4 =Xclock)
+        - 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
@@ -179,12 +178,12 @@  JOYTEST       036   W   Denise  Write to all 4  joystick-mouse counters at once.
 
 -------------------------------------------------------------------------------
 
-======= === ==== ==== ====== ========================================
+======= === ==== ==== ====== ===========================================
 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)
-======= === ==== ==== ====== ========================================
+======= === ==== ==== ====== ===========================================
+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
@@ -213,8 +212,8 @@  POT1DAT  h  014   R   Paula  Pot counter data right pair (vert,horiz)
          +-------+------+-----+-----+-------+
 
          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,
+         give a full scale (FF) reading with about 500k ohm 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.
 
@@ -238,26 +237,26 @@  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) |
-         +-------+----------+---------------------------------------------+
+         +-------+----------+----------------------------------------------+
+         | 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) |
+         +-------+----------+----------------------------------------------+