Skip to content

Commit

Permalink
Split README.md into theory_of_operation.md and programmers_guide.md
Browse files Browse the repository at this point in the history
- Modify SUMMARY.md to add newly-split files to book
- Utilize util/mdbook/move_md.py to re-calculate all relative links
- See PR message (lowRISC#17647) for the script that did the splitting

Signed-off-by: Harry Callahan <hcallahan@lowrisc.org>
  • Loading branch information
hcallahan-lowrisc authored and andreaskurth committed Mar 21, 2023
1 parent b5d7c13 commit 2759055
Show file tree
Hide file tree
Showing 89 changed files with 12,186 additions and 11,681 deletions.
56 changes: 56 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@
- [Device Interface Functions](./sw/device/lib/dif/dif_rv_plic.h)
- [Checklist](./hw/top_earlgrey/ip_autogen/rv_plic/doc/checklist.md)
- [Sensor Control](./hw/top_earlgrey/ip/sensor_ctrl/README.md)
- [Theory of Operation](./hw/top_earlgrey/ip/sensor_ctrl/doc/theory_of_operation.md)
- [Programmer's Guide](./hw/top_earlgrey/ip/sensor_ctrl/doc/programmers_guide.md)
- [Interface and Registers](./hw/top_earlgrey/ip/sensor_ctrl/data/sensor_ctrl.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_sensor_ctrl.h)
- [Checklist](./hw/top_earlgrey/ip/sensor_ctrl/doc/checklist.md)
Expand Down Expand Up @@ -59,127 +61,169 @@

- [Hardware IP Blocks](./hw/ip/README.md)
- [Analog to Digital Converter Control](./hw/ip/adc_ctrl/README.md)
- [Theory of Operation](./hw/ip/adc_ctrl/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/adc_ctrl/dv/README.md)
- [Testplan](./hw/ip/adc_ctrl/data/adc_ctrl_testplan.hjson)
- [Programmer's Guide](./hw/ip/adc_ctrl/doc/programmers_guide.md)
- [Checklist](./hw/ip/adc_ctrl/doc/checklist.md)
- [Interface and Registers](./hw/ip/adc_ctrl/data/adc_ctrl.hjson)
- [AES](./hw/ip/aes/README.md)
- [Theory of Operation](./hw/ip/aes/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/aes/dv/README.md)
- [Testplan](./hw/ip/aes/data/aes_testplan.hjson)
- [Programmer's Guide](./hw/ip/aes/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/aes/data/aes.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_aes.h)
- [Checklist](./hw/ip/aes/doc/checklist.md)
- [AON Timer](./hw/ip/aon_timer/README.md)
- [Theory of Operation](./hw/ip/aon_timer/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/aon_timer/dv/README.md)
- [Testplan](./hw/ip/aon_timer/data/aon_timer_testplan.hjson)
- [Programmer's Guide](./hw/ip/aon_timer/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/aon_timer/data/aon_timer.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_aon_timer.h)
- [Checklist](./hw/ip/aon_timer/doc/checklist.md)
- [Clock Manager](./hw/ip/clkmgr/README.md)
- [Theory of Operation](./hw/ip/clkmgr/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/clkmgr/dv/README.md)
- [Testplan](./hw/ip/clkmgr/data/clkmgr_testplan.hjson)
- [Programmer's Guide](./hw/ip/clkmgr/doc/programmers_guide.md)
- [Interface and Registers](./hw/top_earlgrey/ip/clkmgr/data/autogen/clkmgr.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_clkmgr.h)
- [Checklist](./hw/ip/clkmgr/doc/checklist.md)
- [CSRNG](./hw/ip/csrng/README.md)
- [Theory of Operation](./hw/ip/csrng/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/csrng/dv/README.md)
- [Testplan](./hw/ip/csrng/data/csrng_testplan.hjson)
- [Programmer's Guide](./hw/ip/csrng/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/csrng/data/csrng.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_csrng.h)
- [Checklist](./hw/ip/csrng/doc/checklist.md)
- [EDN](./hw/ip/edn/README.md)
- [Theory of Operation](./hw/ip/edn/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/edn/dv/README.md)
- [Testplan](./hw/ip/edn/data/edn_testplan.hjson)
- [Programmer's Guide](./hw/ip/edn/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/edn/data/edn.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_edn.h)
- [Checklist](./hw/ip/edn/doc/checklist.md)
- [Entropy Source](./hw/ip/entropy_src/README.md)
- [Theory of Operation](./hw/ip/entropy_src/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/entropy_src/dv/README.md)
- [Testplan](./hw/ip/entropy_src/data/entropy_src_testplan.hjson)
- [Programmer's Guide](./hw/ip/entropy_src/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/entropy_src/data/entropy_src.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_entropy_src.h)
- [Checklist](./hw/ip/entropy_src/doc/checklist.md)
- [Flash Controller](./hw/ip/flash_ctrl/README.md)
- [Theory of Operation](./hw/ip/flash_ctrl/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/flash_ctrl/dv/README.md)
- [Testplan](./hw/ip/flash_ctrl/data/flash_ctrl_testplan.hjson)
- [Programmer's Guide](./hw/ip/flash_ctrl/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/flash_ctrl/data/flash_ctrl.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_flash_ctrl.h)
- [Checklist](./hw/ip/flash_ctrl/doc/checklist.md)
- [GPIO](./hw/ip/gpio/README.md)
- [Theory of Operation](./hw/ip/gpio/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/gpio/dv/README.md)
- [Testplan](./hw/ip/gpio/data/gpio_testplan.hjson)
- [Programmer's Guide](./hw/ip/gpio/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/gpio/data/gpio.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_gpio.h)
- [Checklist](./hw/ip/gpio/doc/checklist.md)
- [HMAC](./hw/ip/hmac/README.md)
- [Theory of Operation](./hw/ip/hmac/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/hmac/dv/README.md)
- [Testplan](./hw/ip/hmac/data/hmac_testplan.hjson)
- [Programmer's Guide](./hw/ip/hmac/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/hmac/data/hmac.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_hmac.h)
- [Checklist](./hw/ip/hmac/doc/checklist.md)
- [I2C](./hw/ip/i2c/README.md)
- [Theory of Operation](./hw/ip/i2c/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/i2c/dv/README.md)
- [Testplan](./hw/ip/i2c/data/i2c_testplan.hjson)
- [Programmer's Guide](./hw/ip/i2c/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/i2c/data/i2c.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_i2c.h)
- [Checklist](./hw/ip/i2c/doc/checklist.md)
- [Key Manager](./hw/ip/keymgr/README.md)
- [Theory of Operation](./hw/ip/keymgr/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/keymgr/dv/README.md)
- [Testplan](./hw/ip/keymgr/data/keymgr_testplan.hjson)
- [Programmer's Guide](./hw/ip/keymgr/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/keymgr/data/keymgr.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_keymgr.h)
- [Checklist](./hw/ip/keymgr/doc/checklist.md)
- [KMAC](./hw/ip/kmac/README.md)
- [Theory of Operation](./hw/ip/kmac/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/kmac/dv/README.md)
- [Testplan](./hw/ip/kmac/data/kmac_testplan.hjson)
- [Programmer's Guide](./hw/ip/kmac/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/kmac/data/kmac.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_kmac.h)
- [Checklist](./hw/ip/kmac/doc/checklist.md)
- [Life Cycle Controller](./hw/ip/lc_ctrl/README.md)
- [Theory of Operation](./hw/ip/lc_ctrl/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/lc_ctrl/dv/README.md)
- [Testplan](./hw/ip/lc_ctrl/data/lc_ctrl_testplan.hjson)
- [Programmer's Guide](./hw/ip/lc_ctrl/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/lc_ctrl/data/lc_ctrl.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_lc_ctrl.h)
- [Checklist](./hw/ip/lc_ctrl/doc/checklist.md)
- [OTP Controller](./hw/ip/otp_ctrl/README.md)
- [Theory of Operation](./hw/ip/otp_ctrl/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/otp_ctrl/dv/README.md)
- [Testplan](./hw/ip/otp_ctrl/data/otp_ctrl_testplan.hjson)
- [Programmer's Guide](./hw/ip/otp_ctrl/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/otp_ctrl/data/otp_ctrl.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_otp_ctrl.h)
- [Checklist](./hw/ip/otp_ctrl/doc/checklist.md)
- [Pattern Generator](./hw/ip/pattgen/README.md)
- [Theory of Operation](./hw/ip/pattgen/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/pattgen/dv/README.md)
- [Testplan](./hw/ip/pattgen/data/pattgen_testplan.hjson)
- [Programmer's Guide](./hw/ip/pattgen/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/pattgen/data/pattgen.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_pattgen.h)
- [Checklist](./hw/ip/pattgen/doc/checklist.md)
- [Pinmux](./hw/ip/pinmux/README.md)
- [Theory of Operation](./hw/ip/pinmux/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/pinmux/doc/dv/README.md)
- [Testplan](./hw/ip/pinmux/data/pinmux_fpv_testplan.hjson)
- [Programmer's Guide](./hw/ip/pinmux/doc/programmers_guide.md)
- [Interface and Registers](./hw/top_earlgrey/ip/pinmux/data/autogen/pinmux.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_pinmux.h)
- [Checklist](./hw/ip/pinmux/doc/checklist.md)
- [Pulse Width Modulator](./hw/ip/pwm/README.md)
- [Theory of Operation](./hw/ip/pwm/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/pwm/dv/README.md)
- [Testplan](./hw/ip/pwm/data/pwm_testplan.hjson)
- [Programmer's Guide](./hw/ip/pwm/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/pwm/data/pwm.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_pwm.h)
- [Checklist](./hw/ip/pwm/doc/checklist.md)
- [Power Management](./hw/ip/pwrmgr/README.md)
- [Theory of Operation](./hw/ip/pwrmgr/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/pwrmgr/dv/README.md)
- [Testplan](./hw/ip/pwrmgr/data/pwrmgr_testplan.hjson)
- [Programmer's Guide](./hw/ip/pwrmgr/doc/programmers_guide.md)
- [Interface and Registers](./hw/top_earlgrey/ip/pwrmgr/data/autogen/pwrmgr.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_pwrmgr.h)
- [Checklist](./hw/ip/pwrmgr/doc/checklist.md)
- [ROM Control](./hw/ip/rom_ctrl/README.md)
- [Theory of Operation](./hw/ip/rom_ctrl/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/rom_ctrl/dv/README.md)
- [Testplan](./hw/ip/rom_ctrl/data/rom_ctrl_testplan.hjson)
- [Programmer's Guide](./hw/ip/rom_ctrl/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/rom_ctrl/data/rom_ctrl.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_rom_ctrl.h)
- [Checklist](./hw/ip/rom_ctrl/doc/checklist.md)
- [Reset Manager](./hw/ip/rstmgr/README.md)
- [Theory of Operation](./hw/ip/rstmgr/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/rstmgr/dv/README.md)
- [Testplan](./hw/ip/rstmgr/data/rstmgr_testplan.hjson)
- [Programmer's Guide](./hw/ip/rstmgr/doc/programmers_guide.md)
- [Interface and Registers](./hw/top_earlgrey/ip/rstmgr/data/autogen/rstmgr.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_rstmgr.h)
- [Checklist](./hw/ip/rstmgr/doc/checklist.md)
Expand All @@ -189,20 +233,26 @@
- [Interface and Registers](./hw/ip/rv_dm/data/rv_dm.hjson)
- [Checklist](./hw/ip/rv_dm/doc/checklist.md)
- [SPI Device](./hw/ip/spi_device/README.md)
- [Theory of Operation](./hw/ip/spi_device/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/spi_device/dv/README.md)
- [Testplan](./hw/ip/spi_device/data/spi_device_testplan.hjson)
- [Programmer's Guide](./hw/ip/spi_device/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/spi_device/data/spi_device.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_spi_device.h)
- [Checklist](./hw/ip/spi_device/doc/checklist.md)
- [SPI Host](./hw/ip/spi_host/README.md)
- [Theory of Operation](./hw/ip/spi_host/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/spi_host/dv/README.md)
- [Testplan](./hw/ip/spi_host/data/spi_host_testplan.hjson)
- [Programmer's Guide](./hw/ip/spi_host/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/spi_host/data/spi_host.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_spi_host.h)
- [Checklist](./hw/ip/spi_host/doc/checklist.md)
- [SRAM Controller](./hw/ip/sram_ctrl/README.md)
- [Theory of Operation](./hw/ip/sram_ctrl/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/sram_ctrl/dv/README.md)
- [Testplan](./hw/ip/sram_ctrl/data/sram_ctrl_testplan.hjson)
- [Programmer's Guide](./hw/ip/sram_ctrl/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/sram_ctrl/data/sram_ctrl.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_sram_ctrl.h)
- [Checklist](./hw/ip/sram_ctrl/doc/checklist.md)
Expand All @@ -213,8 +263,10 @@
- [Device Interface Functions](./sw/device/lib/dif/dif_sysrst_ctrl.h)
- [Checklist](./hw/ip/sysrst_ctrl/doc/checklist.md)
- [Timer](./hw/ip/rv_timer/README.md)
- [Theory of Operation](./hw/ip/rv_timer/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/rv_timer/dv/README.md)
- [Testplan](./hw/ip/rv_timer/data/rv_timer_testplan.hjson)
- [Programmer's Guide](./hw/ip/rv_timer/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/rv_timer/data/rv_timer.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_rv_timer.h)
- [Checklist](./hw/ip/rv_timer/doc/checklist.md)
Expand All @@ -223,14 +275,18 @@
- [Testplan](./hw/ip/tlul/data/tlul_testplan.hjson)
- [Protocol Checker](./hw/ip/tlul/doc/TlulProtocolChecker.md)
- [UART](./hw/ip/uart/README.md)
- [Theory of Operation](./hw/ip/uart/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/uart/dv/README.md)
- [Testplan](./hw/ip/uart/data/uart_testplan.hjson)
- [Programmer's Guide](./hw/ip/uart/doc/programmers_guide.md)
- [Interface and Registers](./hw/ip/uart/data/uart.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_uart.h)
- [Checklist](./hw/ip/uart/doc/checklist.md)
- [USB 2.0](./hw/ip/usbdev/README.md)
- [Theory of Operation](./hw/ip/usbdev/doc/theory_of_operation.md)
- [Design Verification](./hw/ip/usbdev/dv/README.md)
- [Testplan](./hw/ip/usbdev/data/usbdev_testplan.hjson)
- [Programmer's Guide](./hw/ip/usbdev/doc/programmers_guide.md)
- [Suspending and Resuming](./hw/ip/usbdev/doc/wake_resume.md)
- [Interface and Registers](./hw/ip/usbdev/data/usbdev.hjson)
- [Device Interface Functions](./sw/device/lib/dif/dif_usbdev.h)
Expand Down
Loading

0 comments on commit 2759055

Please sign in to comment.