Documentation update for Pinmux and GPIO

Also update reference manual based on GPIO array.
The tables in the pinmux are automatically generated.

Author: marnovandermaas

.gitattributes

@@ -2,6 +2,7 @@
 # Licensed under the Apache License, Version 2.0, see LICENSE for details.
 # SPDX-License-Identifier: Apache-2.0
 data/xbar_main_generated.hjson linguist-generated=true
+doc/ip/pinmux.md linguist-generated=true
 rtl/bus/sonata_xbar_main.sv linguist-generated=true
 rtl/bus/tl_main_pkg.sv linguist-generated=true
 rtl/bus/tl_ifetch_pkg.sv linguist-generated=true

doc/dev/ref-manual.md

@@ -46,9 +46,6 @@ For all registers in this section, the functionality is mapped onto the least si
 | 0x8000_3000  |   4 KiB | [HyperRAM][]         |
 | 0x8000_4000  |   4 KiB | Reserved             |
 | 0x8000_5000  |   4 KiB | [Pinmux][]           |
-| 0x8000_6000  |   4 KiB | R-Pi Header GPIO     |
-| 0x8000_7000  |   4 KiB | Arduino GPIO         |
-| 0x8000_8000  |   4 KiB | PMOD GPIO            |
 | 0x8000_9000  |   4 KiB | RGB LED controller   |
 | 0x8000_A000  |   4 KiB | [Hardware revoker][] |
 | 0x8000_B000  |   4 KiB | [ADC][]              |

doc/ip/gpio.md

@@ -8,24 +8,24 @@ For the input this module provides a raw value as well as a debounced value.
 Debouncing is useful to avoid counting a single button press multiple times.
 For more information on contact bounce, see [this Wikipedia page](https://en.wikipedia.org/wiki/Switch#Contact_bounce).
 
-| Offset | Register |
-|--------|----------|
-| 0x0000 | Output   |
-| 0x0004 | Input    |
-| 0x0008 | Debounced input |
-| 0x000C | Debounce threshold |
-| 0x6000 | R-Pi output |
-| 0x6004 | R-Pi input |
-| 0x6008 | R-pi debounced input |
-| 0x600C | R-pi debounce threshold |
-| 0x7000 | Arduino output |
-| 0x7004 | Arduino input |
-| 0x7008 | Arduino debounced input |
-| 0x700C | Arduino debounce threshold |
-| 0x8000 | PMOD output |
-| 0x8004 | PMOD input |
-| 0x8008 | PMOD debounced input |
-| 0x800C | PMOD debounce threshold |
+| Offset | Register                |
+|--------|-------------------------|
+| 0x0000 | Output                  |
+| 0x0004 | Input                   |
+| 0x0008 | Debounced input         |
+| 0x000C | Output enable           |
+| 0x0010 | R-Pi output             |
+| 0x0014 | R-Pi input              |
+| 0x0018 | R-pi debounced input    |
+| 0x001C | R-pi output enable      |
+| 0x0020 | Arduino output          |
+| 0x0024 | Arduino input           |
+| 0x0028 | Arduino debounced input |
+| 0x002C | Arduino output enable   |
+| 0x0030 | PMOD output             |
+| 0x0034 | PMOD input              |
+| 0x0038 | PMOD debounced input    |
+| 0x003C | PMOD output enable      |
 
 ## Output
 
@@ -66,69 +66,28 @@ The only difference between the registers is that the latter has debounced signa
 
 The input registers are used to interact with the joystick, the button and the DIP switches that are available on the Sonata board.
 
-## Debounce threshold
-
-**Not implemented yet.**
-
-This register indicates how many clock cycles an input needs to be stable before it shows up on the output.
-The same threshold applies to all of the inputs.
-
-| Bit offset | Description |
-|------------|-------------|
-| 31-0       | Threshold   |
-
 ## Raspberry Pi HAT
 
-The Raspberry Pi HAT header has 11 GPIO pins.
+The Raspberry Pi HAT header has 27 pins that can act as GPIO.
+Some can be remapped to other IP blocks (see Pinmux).
 When writing, it only writes the bits for which the output is set to enable.
 The input and output registers have the same bit mapping.
 
 | Bit offset | Description |
 |------------|-------------|
-|   10       | GPIO  27    |
-|   9        | GPIO  26    |
-|   8        | GPIO  25    |
-|   7        | GPIO  24    |
-|   6        | GPIO  23    |
-|   5        | GPIO  22    |
-|   4        | GPIO  13    |
-|   3        | GPIO  12    |
-|   2        | GPIO  6     |
-|   1        | GPIO  5     |
-|   0        | GPIO  4     |
-
-For the output register it is teh same order as above:
-| Bit offset | Description |
-|------------|-------------|
-|   26-16    | Output enable |
-|   10-0     | Output value |
+| 27-0       | g27 - g0    |
 
 When the output enable is set to zero it instead acts as an input pin.
 
 ## Arduino Shield
 
-The Arduino Shield header has 10 GPIO pins.
+The Arduino Shield header has 17 pins that can act as GPIO.
 When writing, it only writes the bits for which the output is set to enable.
 The input and output registers have the same bit mapping.
 
-| Bit offset | Description |
-|------------|-------------|
-|   9        | GPIO  9     |
-|   8        | GPIO  8     |
-|   7        | GPIO  7     |
-|   6        | GPIO  6     |
-|   5        | GPIO  5     |
-|   4        | GPIO  4     |
-|   3        | GPIO  3     |
-|   2        | GPIO  2     |
-|   1        | GPIO  1     |
-|   0        | GPIO  0     |
-
-For the output register it is teh same order as above:
-| Bit offset | Description |
-|------------|-------------|
-|   25-16    | Output enable |
-|   9-0      | Output value |
+| Bit offset | Description  |
+|------------|--------------|
+| 17-0       | GPIO 17 to 0 |
 
 When the output enable is set to zero it instead acts as an input pin.
 
@@ -143,10 +102,4 @@ The input and output registers have the same bit mapping.
 |   15-8     | PMOD 1      |
 |   7-0      | PMOD 0      |
 
-For the output register it is teh same order as above:
-| Bit offset | Description |
-|------------|-------------|
-|   31-16    | Output enable |
-|   15-0     | Output value |
-
 When the output enable is set to zero it instead acts as an input pin.