diff --git a/Documentation/user-guide/build-system.md b/Documentation/user-guide/build-system.md index 2d776ccf7c..a7f3f8f4e2 100644 --- a/Documentation/user-guide/build-system.md +++ b/Documentation/user-guide/build-system.md @@ -102,7 +102,7 @@ The following sections present the available [Build Configuration Variables](#bu | `MAXIM_PATH` | (Optional) Specify the location of the MSDK | This optional variable can be used to change where the Makefile looks for the MSDK installation. By default, the build system will attempt to locate the MSDK with a relative path. If a project is moved _outside_ of the SDK, this variable must be set to the absolute path of the MSDK installation. | | `TARGET` | Set the _Target Microcontroller_ | **If you are using an IDE, set this variable in the IDE's settings instead of project.mk** | | `BOARD` | Set the _Board Support Package (BSP)_ | **If you are using an IDE, set this variable in the IDE's settings instead of project.mk.** See [Board Support Packages](board-support-pkgs.md) for more details. When you change this option, it's usually a good idea to fully clean your project, then rebuild. | -| `BSP_SEARCH_DIR` | Set the directory to search for the _Board Support Package (BSP)_ | By default, the `Libraries/Boards` folder of the MSDK is searched for the `TARGET` microcontroller. This setting is useful for loading custom BSPs from outside of the MSDK. When `LIB_BOARD=1`, the build system looks for the file path at `$(BSP_SEARCH_DIR)/$(BOARD)/board.mk`. See [BSP Search Directory](board-support-pkgs.md/bsp-search-directory) for more details. | +| `BSP_SEARCH_DIR` | Set the directory to search for the _Board Support Package (BSP)_ | By default, the `Libraries/Boards` folder of the MSDK is searched for the `TARGET` microcontroller. This setting is useful for loading custom BSPs from outside of the MSDK. When `LIB_BOARD=1`, the build system looks for the file path at `$(BSP_SEARCH_DIR)/$(BOARD)/board.mk`. See [BSP Search Directory](board-support-pkgs.md#bsp-search-directory) for more details. | ### Project Build Variables @@ -114,7 +114,7 @@ The following variables deal with fundamental project tasks such as adding sourc | `IPATH` | Where to search for header (.h) files | **Use the `+=` operator with this variable**. This controls where the Makefile will look for **header** files. _Unlike_ the `VPATH` option, this is not related to `AUTOSEARCH`. Individual header files are _not_ ever manually added to the build. Instead, you only need to specify the _location_ of your header files. | | `SRCS` | List of source (.c/.cpp) files to add to the build | **Use the `+=` operator with this variable**. All of the files in this list will be added to the build. If `AUTOSEARCH` is enabled, this is most useful for adding the full absolute path to a singular source file to selectively add to the build. If `AUTOSEARCH` is disabled, _all_ of the source files for the project must be added to `SRCS`, and they must also all be located on an entry in `VPATH`. Otherwise, a full path relative to the Makefile must be used. | | `AUTOSEARCH` | Automatically search for source (.c/.cpp) files | Enable or disable the automatic detection of .c files on `VPATH` (enabled by default). Set to `0` to disable or `1` to enable. If auto-search is disabled, source files must be manually added to `SRCS`. | -| `PROJECT` | Set the output filename | This controls the output filename of the build. File extensions should _not_ be included in the filename. **For VS Code, you should use the [project_name](visual-studio-code.md/project_name) advanced config option instead of project.mk.** | +| `PROJECT` | Set the output filename | This controls the output filename of the build. File extensions should _not_ be included in the filename. **For VS Code, you should use the [project_name](visual-studio-code.md#project_name) advanced config option instead of project.mk.** | | `PROJ_LIBS` | Add a static library file (.a) to the project | **Use the `+=` operator with this variable**. Additional static libraries to link against can be added with this option. It should be noted that static library files are named with the `lib.a` convention. Only add `` to this variable. Example: Give a file called `libEXAMPLE.a`, write `PROJ_LIBS += EXAMPLE` Additionally, ensure that the location of the library is added to `PROJ_LDFLAGS`. Example: `PROJ_LDFLAGS += -Lsome/library/search/directory` | ### Build Variables for the Compiler diff --git a/Documentation/user-guide/libraries.md b/Documentation/user-guide/libraries.md index 4691ef18f7..3eab756aea 100644 --- a/Documentation/user-guide/libraries.md +++ b/Documentation/user-guide/libraries.md @@ -175,7 +175,7 @@ The `Libraries/MiscDrivers` folder of the MSDK contains drivers for miscellaneou | Configuration Variable | Description | Details | | ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | | | | | -| `CAMERA` | (Optional) Set the Camera drivers to use | This option is only useful for the MAX78000 and MAX78002 and sets the camera drivers to use for the project. Permitted values are `HM01B0`, `HM0360_MONO`, `HM0360_COLOR`, `OV5642`, `OV7692` (default), or `PAG7920`. Camera drivers can be found in the [`Libraries/MiscDrivers/Camera`](../Libraries/MiscDrivers/Camera) folder. Depending on the selected camera, a compiler definition may be added to the build. See the `board.mk` file for the active BSP for more details. | +| `CAMERA` | (Optional) Set the Camera drivers to use | This option is only useful for the MAX78000 and MAX78002 and sets the camera drivers to use for the project. Permitted values are `HM01B0`, `HM0360_MONO`, `HM0360_COLOR`, `OV5642`, `OV7692` (default), or `PAG7920`. Camera drivers can be found in the `Libraries/MiscDrivers/Camera` folder. Depending on the selected camera, a compiler definition may be added to the build. See the `board.mk` file for the active BSP for more details. | --- @@ -230,7 +230,7 @@ FreeRTOS is supported by all parts in the MSDK. See the `FreeRTOSDemo` example Developing a UART Command-Line Interface (CLI) is a common task while developing embedded firmware. The MSDK contains a pre-made command processing library in the `Libraries/CLI` that can be used to simplify and speed up development. -See the [`Libraries/CLI/README.md`](../Libraries/CLI/README.md) document for more details. +See the [`Libraries/CLI/README.md`](../../Libraries/CLI/README.md) document for more details. ## CoreMark diff --git a/Documentation/user-guide/visual-studio-code.md b/Documentation/user-guide/visual-studio-code.md index d437e2156d..bfc0bea480 100644 --- a/Documentation/user-guide/visual-studio-code.md +++ b/Documentation/user-guide/visual-studio-code.md @@ -175,7 +175,7 @@ To open the disassembly view: ![Figure 49](res/Fig49.jpg) - Alternatively, right click -> "Open Disassembly View" + Alternatively, right-click -> "Open Disassembly View" ![Figure 50](res/Fig50.jpg) @@ -190,7 +190,7 @@ For microcontrollers with _both_ an Arm M4 and a RISC-V core, the _GDB (RISC-V)_ ???+ note "ℹ️ **Note**" The RISC-V core requires setup and handoff from the Arm M4 core. As a result, this is an advanced configuration requiring a unique combination of the project's source code, Makefiles, and VSCode-Maxim project settings. Such projects are appended with the `-riscv` suffix in the project's folder name. -This section demonstrates how to debug `-riscv` projects in VS Code using the [mnist-riscv](/Examples/MAX78000/CNN/mnist-riscv) project for the MAX78000 as an example. +This section demonstrates how to debug `-riscv` projects in VS Code using the mnist-riscv project for the MAX78000 as an example. Example files are located in the `Examples/MAX78000/CNN/mnist-riscv` directory. 1. Connect _both_ your Arm (SWD) and RISC-V (JTAG) debuggers. VSCode-Maxim projects come pre-configured to use the [ARM-USB-OCD-H](https://www.olimex.com/Products/ARM/JTAG/ARM-USB-OCD-H/) + [ARM-JTAG-20-10](https://www.olimex.com/Products/ARM/JTAG/ARM-JTAG-20-10/) adapters for the RISC-V JTAG port. Ex: diff --git a/mkdocs.yml b/mkdocs.yml index 8923fd2a22..eb6eb1f1e1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,7 +6,21 @@ docs_dir: 'Documentation' site_dir: 'docs' nav: - Home: 'index.md' - - MSDK User Guide: 'user-guide/index.md' + - MSDK User Guide: + - Overview: 'user-guide/index.md' + - Installation: 'user-guide/installation.md' + - Getting Started: 'user-guide/getting-started.md' + - Visual Studio Code: 'user-guide/visual-studio-code.md' + - Eclipse: 'user-guide/eclipse.md' + - Keil MDK: 'user-guide/keil-mdk.md' + - IAR Embedded Workbench: 'user-guide/iar-embed-wkbench.md' + - Command-Line Development: 'user-guide/command-line-dev.md' + - Build System: 'user-guide/build-system.md' + - Board Support Packages: 'user-guide/board-support-pkgs.md' + - Libraries: 'user-guide/libraries.md' + - Examples: 'user-guide/examples.md' + - Debuggers: 'user-guide/debuggers.md' + - Developer Notes: 'user-guide/developer-notes.md' - Cordio BLE User Guide: 'Libraries/Cordio/docs/CORDIO_USERGUIDE.md' - Contributing: 'CONTRIBUTING.md' theme: