doc: Gave pinmux it's own doc directory

This is preperation for adding content. Co-authored-by: Marno van der Maas <[email protected]>
lowRISC · Oct 29, 2024 · e2fe676 · e2fe676
1 parent f9515a9
commit e2fe676
Show file tree

Hide file tree

Showing 5 changed files with 3 additions and 3 deletions.
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -23,7 +23,7 @@
     - [PWM](doc/ip/pwm.md)
     - [HyperRAM](doc/ip/ram.md)
     - [ADC](doc/ip/adc.md)
-    - [Pinmux](doc/ip/pinmux.md)
+    - [Pinmux](doc/ip/pinmux/README.md)
     - [Revoker](doc/ip/revoker.md)
     - [System info](doc/ip/system_info.md)
     - [Timer](doc/ip/timer.md)

diff --git a/doc/dev/ref-manual.md b/doc/dev/ref-manual.md
@@ -65,7 +65,7 @@ For all registers in this section, the functionality is mapped onto the least si
 [PWM]: ../ip/pwm.md
 [HyperRAM]: ../ip/ram.md
 [ADC]: ../ip/adc.md
-[Pinmux]: ../ip/pinmux.md
+[Pinmux]: ../ip/pinmux/README.md
 [System info]: ../ip/system_info.md
 [Hardware revoker]: ../ip/revoker.md
 [Timer]: ../ip/timer.md

diff --git a/doc/ip/pinmux.md → doc/ip/pinmux/README.md b/doc/ip/pinmux.md → doc/ip/pinmux/README.md
diff --git a/doc/ip/pinmux.md.tpl → util/templates/pinmux.md.tpl b/doc/ip/pinmux.md.tpl → util/templates/pinmux.md.tpl
diff --git a/util/top_gen/generator.py b/util/top_gen/generator.py
@@ -343,7 +343,7 @@ def legacy_ordering(input_pin: OutputBlockIo) -> tuple[int, int, int]:
         ),
         ("rtl/templates/sonata_pkg.sv.tpl", "rtl/system/sonata_pkg.sv"),
         ("rtl/templates/pinmux.sv.tpl", "rtl/system/pinmux.sv"),
-        ("doc/ip/pinmux.md.tpl", "doc/ip/pinmux.md"),
+        ("util/templates/pinmux.md.tpl", "doc/ip/pinmux/README.md"),
         (
             "sw/cheri/common/platform-pinmux.hh.tpl",
             "sw/cheri/common/platform-pinmux.hh",