boxlambda/mkdocs.yml at master · epsilon537/boxlambda · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
site_name: BoxLambda Documentation
site_url: !ENV READTHEDOCS_CANONICAL_URL
docs_dir: site_docs

markdown_extensions:
  - pymdownx.arithmatex:
      generic: true
  - attr_list
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 4

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

theme:
    name: material
    logo: assets/boxlambda-logo-simple-white.png
    favicon: assets/boxlambda-logo-simple.png
      - navigation.tracking
      - navigation.instant
      - navigation.sections
      - navigation.expand
      - navigation.path
      - navigation.top
      - navigation.indexes

extra:
  social:
    - icon: fontawesome/brands/x-twitter
      link: https://x.com/@2Lysens
    - icon: fontawesome/brands/bluesky
      link: https://bsky.app/profile/epsilon537.bsky.social
    - icon: fontawesome/brands/github
      link: https://github.com/epsilon537/boxlambda
    - icon: fontawesome/solid/paper-plane
      link: mailto:ruben.lysens2@gmail.com

repo_url: https://github.com/epsilon537/boxlambda

nav:
  - About: index.md
  - Start Here: start-here.md
  - Full Index: full-index.md
  - Terms and Abbreviations: terms-and-abbreviations.md
  - Requirements: requirements.md
  - Installation:
      - Prerequisites: installation/prerequisites.md
      - Peripherals/PMODs: installation/pmods.md
      - Installation: installation/installation.md
  - The SoC:
    - Top-Level:
        - SoC Architecture: soc/top-level/soc-architecture.md
        - Clocks and Reset: soc/top-level/clocks-and-reset.md
        - Interrupts: soc/top-level/interrupts.md
        - LEDs and Switches: soc/top-level/leds-and-switches.md
        - FPGA Resource Utilization: soc/top-level/fpga-resource-utilization.md
    - Components:
        - BoxLambda SoC: soc/components/boxlambda-soc.md
        - Wishbone Interconnect: soc/components/wb-interconnect.md
        - RISCV Ibex Processor: soc/components/ibex.md
        - IMEM: soc/components/imem.md
        - RISCV-DBG Debug Core: soc/components/riscv-dbg.md
        - LiteDRAM Memory Controller: soc/components/litedram.md
        - VERA (Wishbone) Graphics: soc/components/vera.md
        - SDSPI SD Card Controller: soc/components/sdspi.md
        - SPI Flash Controller: soc/components/spiflash.md
        - Dual YM2149 PSG Sound Core: soc/components/dual-ym2149.md
        - USB HID Keyboard and Mouse: soc/components/usb-hid.md
        - UART: soc/components/uart.md
        - GPIO: soc/components/gpio.md
        - Timer: soc/components/timer.md
        - I2C: soc/components/i2c.md
        - RTCC: soc/components/rtcc.md
        - VS0: soc/components/vs0.md
        - DFX Controller: soc/components/dfx-controller.md
    - Builds:
        - BoxLambda Base: soc/projects/boxlambda-base.md
        - BoxLambda DFX (Experimental/Advanced): soc/projects/boxlambda-dfx.md
    - Testing:
      - The Test Bench:
          - The Test Bench: soc/test/bench/test-bench.md
          - The System-Level Test Bench: soc/test/bench/system-level.md
          - The Component-Level Test Bench: soc/test/bench/component-level.md
      - Test Builds:
          - Hello World: soc/test/builds/hello-world.md
          - DDR Test: soc/test/builds/ddr.md
          - VERA Test: soc/test/builds/vera.md
          - SDSPI and FatFS Test: soc/test/builds/sdspi-and-fatfs.md
          - YM2149 PSG, Audio DAC, and ST-Sound Test: soc/test/builds/ym2149.md
          - USB HID Keyboard and Mouse Test: soc/test/builds/usb-hid.md
          - SPI Flash Test: soc/test/builds/spi-flash.md
          - Timer, UART, and GPIO Interrupt Test: soc/test/builds/timer-uart-gpio-irqs.md
          - I2C Test: soc/test/builds/i2c.md
          - Real-Time Clock and Calendar Test: soc/test/builds/rtcc.md
          - Reset Test: soc/test/builds/reset.md
          - DFX Test: soc/test/builds/dfx.md
          - Invalid Address Test: soc/test/builds/invalid-addr.md
          - Ibex Performance Test: soc/test/builds/ibex-perf.md
    - The Build System:
      - The Gateware Build System: soc/build-sys/build-sys.md
      - Building the SoC: soc/build-sys/building.md
  - Software:
    - The Base Platform:
        - Architecture: software/base-platform/architecture.md
        - Bootstrap:
          - Bootstrap: software/base-platform/bootstrap/bootstrap.md
          - Bootloader: software/base-platform/bootstrap/bootloader.md
          - The Linker Script: software/base-platform/bootstrap/linker-script.md
          - Interrupts: software/base-platform/bootstrap/irqs.md
        - C Components:
            - About C Components: software/base-platform/c-components/about.md
            - Register Access Layer: software/base-platform/c-components/register-access-layer.md
            - LiteDRAM Initialization: software/base-platform/c-components/litedram-initialization.md
            - SDSPI: software/base-platform/c-components/sdspi.md
            - FatFs: software/base-platform/c-components/fat-fs.md
            - ST-Sound: software/base-platform/c-components/st-sound.md
            - VERA HAL: software/base-platform/c-components/vera-hal.md
            - USB HID: software/base-platform/c-components/usb-hid.md
            - Flash Driver: software/base-platform/c-components/flashdrvr.md
            - UART: software/base-platform/c-components/uart.md
            - GPIO: software/base-platform/c-components/gpio.md
            - RISC-V: software/base-platform/c-components/riscv.md
            - I2C: software/base-platform/c-components/i2c.md
            - Real-Time Clock and Calendar: software/base-platform/c-components/rtcc.md
            - DFX Controller HAL: software/base-platform/c-components/dfx-controller-hal.md
            - Common: software/base-platform/c-components/common.md
        - Test C Components:
            - About Test C Components: software/base-platform/c-components/test/about.md
            - Timer: software/base-platform/c-components/test/timer.md
            - Interrupt Handling: software/base-platform/c-components/test/irqs.md
            - Embedded CLI: software/base-platform/c-components/test/cli.md
            - Ymodem: software/base-platform/c-components/test/ymodem.md
            - Memory and File System CLI: software/base-platform/c-components/test/mem-fs-cli.md
            - Peek and Poke CLI: software/base-platform/c-components/test/peek-poke-cli.md
            - J1B HAL: software/base-platform/c-components/test/j1b-hal.md
            - VS0 HAL: software/base-platform/c-components/test/vs0-hal.md
        - The Software Build System:
          - The Build System: software/base-platform/build-sys/build-sys.md
          - Building the Software: software/base-platform/build-sys/building.md
    - BoxLambda OS:
      - Requirements: software/boxlambda-os/requirements.md
      - Architecture: software/boxlambda-os/architecture.md
      - Memory Layout: software/boxlambda-os/mem-layout.md
      - OS Top-Level and Boot Sequence: software/boxlambda-os/top-level-and-boot-seq.md
      - User Interface: software/boxlambda-os/ui.md
      - Filesystem: software/boxlambda-os/filesystem.md
      - Forth:
        - The Mecrisp Forth Core: software/boxlambda-os/forth/core.md
        - The Forth-C FFI: software/boxlambda-os/forth/c-ffi.md
        - Stack Notation: software/boxlambda-os/forth/stack-notation.md
        - Forth Word List: software/boxlambda-os/forth/words.md
        - Interrupt Handling: software/boxlambda-os/forth/irqs.md
        - Exception Handling: software/boxlambda-os/forth/exception-handling.md
        - Interpreting: software/boxlambda-os/forth/interpreting.md
        - Include: software/boxlambda-os/forth/include.md
        - Filesystem Stack: software/boxlambda-os/forth/fs-stack.md
      - Try It Out: software/boxlambda-os/try-it-out.md
      - Testing:
        - Forth Test Suite: software/boxlambda-os/test/forth-testsuite.md
  - The Directory Structure and Build Trees: dir-struct.md
  - Tools:
      - Target.py: tools/target_py.md
      - The Cross-Compiler: tools/cross-compiler.md
      - Bender: tools/bender.md
      - Debugging: tools/debugging.md
  - Register and Memory Map:
      - Reset: registers/reset-regs.md
      - UART: registers/uart-regs.md
      - GPIO: registers/gpio-regs.md
      - MTIMER: registers/mtimer-regs.md
      - I2C Master: registers/i2c-master-regs.md
      - USB HID: registers/usb-hid-regs.md
      - SDSPI: registers/sdspi-regs.md
      - SPI Flash: registers/spiflash-regs.md
      - VERA: registers/vera-regs.md
      - YM2149: registers/ym2149-regs.md
      - DFX Controller Control Register: registers/dfx-controller-ctrl-reg.md
      - DFX Controller Other Registers: registers/dfx-controller-other-regs.md
      - LiteDRAM Registers: registers/litedram-index.md
      - Memory Map: registers/memory-map.md
  - Misc.:
    - Git Workflow: misc/git-workflow.md
    - Blog: misc/blog.md