From c3883cc4248da15cd63ee2f490cfef1a50e444dd Mon Sep 17 00:00:00 2001 From: "Anderson, Glen" Date: Mon, 30 Sep 2024 17:26:18 -0400 Subject: [PATCH 01/18] Updated theme to adi-harmonic-mkdocs --- .gitignore | 7 +++- Documentation/CONTRIBUTING.md | 15 ++++++-- Documentation/css/extra.css | 69 ---------------------------------- Documentation/requirements.txt | 1 + mkdocs.yml | 9 ++--- 5 files changed, 21 insertions(+), 80 deletions(-) delete mode 100644 Documentation/css/extra.css diff --git a/.gitignore b/.gitignore index 3573714a36..8885fc7d07 100644 --- a/.gitignore +++ b/.gitignore @@ -5,8 +5,13 @@ Examples/*/*/*/buildrv .vscode/settings.json Libraries/PeriphDrivers/Documentation/MAX* Libraries/PeriphDrivers/bin +docs/ Documentation/Libraries Documentation/res +Documentation/USERGUIDE.md +Documentation/LICENSE.md +Documentation/README.md +Documentation/Tools/Bluetooth/README.md Examples/MAX78000/PowerTest Examples/MAX32570 Examples/MAX32572 @@ -40,4 +45,4 @@ package.json mxc_version.h mxc_version.mk Packetcraft-ADI -packetcraft-adi +packetcraft-adi \ No newline at end of file diff --git a/Documentation/CONTRIBUTING.md b/Documentation/CONTRIBUTING.md index d75c4c8a51..1425417dc7 100644 --- a/Documentation/CONTRIBUTING.md +++ b/Documentation/CONTRIBUTING.md @@ -276,10 +276,17 @@ To **build** the docs: 1. Install [doxygen](https://www.doxygen.nl/download.html) 2. Add doxygen's binary diretory to the [Environmental Path](https://learn.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v=office.14)) Variable -3. Install Python 3 -4. `pip install -r Documentation/requirements.txt` -5. `python Documentation/build.py` -6. The site will be built in the `docs` folder of the repo. +3. Install Python 3.10 or greater +4. Run the following commands + + ```sh + python -m venv venv + source venv/bin/activate # (MacOS/Linux) or venv\Scripts\activate (Windows) + pip install -r Documentation/requirements.txt + python Documentation/build.py + ``` + +The site will be built in the `docs` folder of the repo. To **preview** the generated site: diff --git a/Documentation/css/extra.css b/Documentation/css/extra.css deleted file mode 100644 index 9ea4defda5..0000000000 --- a/Documentation/css/extra.css +++ /dev/null @@ -1,69 +0,0 @@ -/* Set note color */ -.rst-content .note { - background:#d7eeff; - border-radius: 8px; -} - -/* Prevent tables from stretching off infinitely to the right */ -.wy-table-responsive table td,.wy-table-responsive table th { - white-space: normal -} - -/* center images */ -img { - display: block; - margin-left: auto; - margin-right: auto; - max-width: 100%; -} - -.rst-content pre code { - border-color: black; - border-radius: 8px; -} - -.rst-content h1, .rst-content h2, .rst-content h3, .rst-content h4 { - margin-bottom:0px; - margin-top:0px; -} - -h1::after { - display: inline-block; - content: ""; - border-top: .2rem solid; - border-radius: 1rem; - flex-grow: 1; /* This property makes the pseudo-element take up the remaining space */ - width: 100%; /* Set the width to 100% */ - transform: translateY(-0.5rem); -} - -h2::after { - display: inline-block; - content: ""; - border-top: .1rem solid lightgray; - border-radius: 1rem; - flex-grow: 1; /* This property makes the pseudo-element take up the remaining space */ - width: 100%; /* Set the width to 100% */ - transform: translateY(-0.5rem); -} - -h3::after -{ - display: inline-block; - content: ""; - border-top: .1rem solid lightgray; /* Change this line to adjust the style */ - flex-grow: 1; - width: 100%; - transform: translateY(-0.5rem); -} - -h4::after -{ - font-style: italic; - display: inline-block; - content: ""; - border-top: .1rem solid lightgray; /* Change this line to adjust the style */ - flex-grow: 1; - width: 100%; - transform: translateY(-0.5rem); -} \ No newline at end of file diff --git a/Documentation/requirements.txt b/Documentation/requirements.txt index f7f58c060e..b2395075cf 100644 --- a/Documentation/requirements.txt +++ b/Documentation/requirements.txt @@ -1,2 +1,3 @@ mkdocs >= 1.4.2 +adi-mkdocs-harmonic >= 0.7.0 pymdown-extensions>=10.0.1 \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 6ef077efa7..4a981b293d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,19 +1,16 @@ site_name: Analog Devices MSDK Documentation -site_author: Analog Devices -copyright: 'Copyright (C) 2022-2023 Maxim Integrated Products, Inc. All Rights Reserved. (now owned by Analog Devices, Inc.), Copyright (C) 2023 Analog Devices, Inc. All Rights Reserved. This software is proprietary to Analog Devices, Inc. and its licensors.' +site_author: Analog Devices, Inc. +copyright: 'Copyright (C) 2022-2023 Maxim Integrated Products, Inc. All Rights Reserved. (now owned by Analog Devices, Inc.), Copyright (C) 2023-2024 Analog Devices, Inc. All Rights Reserved. This software is proprietary to Analog Devices, Inc. and its licensors.' repo_url: https://github.com/analogdevicesinc/msdk -edit_uri: null docs_dir: 'Documentation' site_dir: 'docs' -extra_css: [css/extra.css] nav: - Home: 'index.md' - MSDK User Guide: 'USERGUIDE.md' - Cordio BLE User Guide: 'Libraries/Cordio/docs/CORDIO_USERGUIDE.md' - Contributing: 'CONTRIBUTING.md' - - License: 'LICENSE.md' theme: - name: readthedocs + name: harmonic analytics: gtag: G-79C65FSVL6 markdown_extensions: From 2505feb079b9df615157538b7558ee80ba147656 Mon Sep 17 00:00:00 2001 From: "Kernion, Juliette" Date: Tue, 1 Oct 2024 16:57:58 -0700 Subject: [PATCH 02/18] Split UG into separate files by H1, copied res dir into Documentation --- Documentation/ug-board-support-pkgs.md | 217 +++++++++++++ Documentation/ug-build-system.md | 210 +++++++++++++ Documentation/ug-command-line-dev.md | 278 +++++++++++++++++ Documentation/ug-debuggers.md | 119 +++++++ Documentation/ug-developer-notes.md | 150 +++++++++ Documentation/ug-eclipse.md | 119 +++++++ Documentation/ug-examples.md | 15 + Documentation/ug-getting-started.md | 390 +++++++++++++++++++++++ Documentation/ug-iar-embed-wkbench.md | 5 + Documentation/ug-installation.md | 218 +++++++++++++ Documentation/ug-keil-mdk.md | 5 + Documentation/ug-libraries.md | 222 +++++++++++++ Documentation/ug-overview.md | 158 ++++++++++ Documentation/ug-visual-studio-code.md | 416 +++++++++++++++++++++++++ 14 files changed, 2522 insertions(+) create mode 100644 Documentation/ug-board-support-pkgs.md create mode 100644 Documentation/ug-build-system.md create mode 100644 Documentation/ug-command-line-dev.md create mode 100644 Documentation/ug-debuggers.md create mode 100644 Documentation/ug-developer-notes.md create mode 100644 Documentation/ug-eclipse.md create mode 100644 Documentation/ug-examples.md create mode 100644 Documentation/ug-getting-started.md create mode 100644 Documentation/ug-iar-embed-wkbench.md create mode 100644 Documentation/ug-installation.md create mode 100644 Documentation/ug-keil-mdk.md create mode 100644 Documentation/ug-libraries.md create mode 100644 Documentation/ug-overview.md create mode 100644 Documentation/ug-visual-studio-code.md diff --git a/Documentation/ug-board-support-pkgs.md b/Documentation/ug-board-support-pkgs.md new file mode 100644 index 0000000000..b3b49e6fc6 --- /dev/null +++ b/Documentation/ug-board-support-pkgs.md @@ -0,0 +1,217 @@ +# Board Support Packages + +The MSDK supports multiple parts and evaluation platforms (see [supported parts](#supported-parts)) through **"Board Support Packages" (BSPs)**. For microcontrollers with multiple evaluation platforms, multiple BSPs will be available. + +The role of a _BSP_ is to provide a hardware abstraction layer for the initialization and management of board-level hardware such as serial interfaces, pushbuttons, LEDs, external peripheral devices, TFT displays, etc. which will vary between evaluation platforms. The BSP abstraction layer also improves code portability to custom devices. + +???+ note "ℹ️ **Note**" + The first task when opening or creating any project is to ensure the BSP is set correctly. + +## How to Set the BSP + +To set the BSP for a project: + +- In **VS Code**: [How to Set the BSP (VS Code)](#how-to-set-the-bsp-vs-code) +- In **Eclipse**: [How to Set the BSP (Eclipse)](#how-to-set-the-bsp-eclipse) +- **Command-Line** Development: [How to Set the BSP (Command-Line)](#how-to-set-the-bsp-command-line) + +## BSP Table + +Available BSPs are located in the `Libraries/Boards` folder for each _Target Microcontroller_. + +![Figure 34](res/Fig34.jpg) + +The name of a BSP's folder is used with the `BOARD` [build configuration variable](#build-configuration-variables) to build a project for a specific BSP. The table below matches the correct `BOARD` values to _external part numbers_. + +| External Part Number | `TARGET` | `BOARD` | +| ---------------------------------------------|--------------- | -------------- | +| [MAX32520-KIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32520-kit.html) | `MAX32520` | `EvKit_V1` | +| [MAX32520FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32520fthr.html) | `MAX32520` | `MAX32520FTHR` | +| [MAX32650-EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32650-evkit.html) | `MAX32650` | `EvKit_V1` | +| [MAX32650FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32650fthr.html) | `MAX32650` | `FTHR_APPS_A` | +| [MAX32655EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32655evkit.html) | `MAX32655` | `EvKit_V1` | +| [MAX32655FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32655fthr.html) | `MAX32655` | `FTHR_Apps_P1` | +| [MAX32660-EVSYS](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32660-evsys.html) | `MAX32660` | `EvKit_V1` | +| [MAX32662EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/MAX32662EVKIT.html) | `MAX32662` | `EvKit_V1` | +| [MAX32666EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32666evkit.html) | `MAX32665` | `EvKit_V1` | +| [MAX32666FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32666fthr.html) | `MAX32665` | `FTHR` | +| MAX32666FTHR2 | `MAX32665` | `FTHR2` | +| [MAX32670EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32670evkit.html) | `MAX32670` | `EvKit_V1` | +| [MAX32672EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32672evkit.html) | `MAX32672` | `EvKit_V1` | +| [MAX32672FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32672fthr.html) | `MAX32672` | `FTHR` | +| [MAX32675EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32675evkit.html) | `MAX32675` | `EvKit_V1` | +| MAX32675FTHR | `MAX32675` | `FTHR_Apps_B` | +| [MAX32680EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32680evkit.html) | `MAX32680` | `EvKit_V1` | +| [MAX32690EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/MAX32690EVKIT.html) | `MAX32690` | `EvKit_V1` | +| [AD-APARD32690-SL](https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/ad-apard32690-sl.html) | `MAX32690` | `APARD` | +| [MAX78000EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000evkit.html) | `MAX78000` | `EvKit_V1` | +| [MAX78000FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000fthr.html) | `MAX78000` | `FTHR_RevA` | +| [MAXREFDES178](https://www.analog.com/en/design-center/reference-designs/maxrefdes178.html) | `MAX78000` | `MAXREFDES178` | +| MAX78000CAM01 (Engineering samples only) | `MAX78000` | `CAM01_RevA` | +| MAX78000CAM02 (Engineering samples only) | `MAX78000` | `CAM02_RevA` | +| [MAX78002EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78002evkit.html) | `MAX78002` | `EvKit_V1` | + +## Custom BSPs + +For custom boards, additional BSPs can be easily created and added to the MSDK. Inspecting the `Libraries/CMSIS/Device/Maxim/TARGET/Source/system_TARGET.c` for a target microcontroller shows how the BSP is integrated into the microcontroller's startup code. + +For example, the MAX78000's `system_max78000.c` startup file shows that `Board_Init` is a weak function that can be overridden. `Board_Init` is called from the default `SystemInit` implementation, which can also be overridden. + + :::C + /* This function is called before C runtime initialization and can be + * implemented by the application for early initializations. If a value other + * than '0' is returned, the C runtime initialization will be skipped. + * + * You may over-ride this function in your program by defining a custom + * PreInit(), but care should be taken to reproduce the initialization steps + * or a non-functional system may result. + */ + __weak int PreInit(void) + { + /* Do nothing */ + return 0; + } + + /* This function can be implemented by the application to initialize the board */ + __weak int Board_Init(void) + { + /* Do nothing */ + return 0; + } + + /* This function is called just before control is transferred to main(). + * + * You may over-ride this function in your program by defining a custom + * SystemInit(), but care should be taken to reproduce the initialization + * steps or a non-functional system may result. + */ + __weak void SystemInit(void) + { + /* Configure the interrupt controller to use the application vector table in */ + /* the application space */ + #if defined(__CC_ARM) || defined(__GNUC__) + /* IAR sets the VTOR pointer incorrectly and causes stack corruption */ + SCB->VTOR = (uint32_t)__isr_vector; + #endif /* __CC_ARM || __GNUC__ */ + + /* Enable instruction cache */ + MXC_ICC_Enable(MXC_ICC0); + + /* Enable FPU on Cortex-M4, which occupies coprocessor slots 10 and 11 */ + /* Grant full access, per "Table B3-24 CPACR bit assignments". */ + /* DDI0403D "ARMv7-M Architecture Reference Manual" */ + SCB->CPACR |= SCB_CPACR_CP10_Msk | SCB_CPACR_CP11_Msk; + __DSB(); + __ISB(); + + SystemCoreClockUpdate(); + + Board_Init(); + } + +A custom BSP can implement one or all of the weak functions. The file structure for a typical BSP can be found below. **The board.mk file is required**, while the rest of the project structure is a recommendation. + + :::bash + CustomBSP (defines BOARD value) + ├─ board.mk (required file!) + ├─ Include + | └─ board.h + └─ Source + └─ board.c + +The name of the BSP's root folder will be the string used with the `BOARD` [build configuration variable](#build-configuration-variables) to select it for a project. In the example above, one would use `BOARD = CustomBSP` to select it as the active BSP. + +### BSP Search Directory + +By default, the MSDK searches for BSPs in the `Libraries/Boards` folder for each microcontroller. This can be changed using the `BSP_SEARCH_DIR` [build configuration variable](#build-configuration-variables), which allows users to load a BSP from a directory outside of the MSDK. The MSDK also uses the `BOARD` variable in its search path. + +For example, the configuration... + + :::Makefile + # project.mk + + BSP_SEARCH_DIR = /home/username/mybsps + # ^ "root" of the BSP search path + BOARD = CustomBSP + # "stem" of the BSP search path + +... will attempt to load the `/home/username/msbsps/CustomBSP/board.mk` file. + +### Custom BSP Template + +The following contents can be used as a bare-bones starter template for a custom BSP. + +* _board.h_ + + :::C + // board.h + + #define BOARD_CUSTOM + // ^ This type of compiler definition is + // sometimes useful. It allows application code + // to check if a specific BSP is being used. + // Ex: #ifdef BOARD_CUSTOM + // ... + // #endif + + /** + * \brief Initialize the BSP and board interfaces. + * \returns #E_NO_ERROR if everything is successful + */ + int Board_Init(void); + +* _board.c_ + + :::C + //board.c + #include "board.h" + #include "mxc_error.h" + + int Board_Init(void) + { + // Implement me! + return E_NO_ERROR; + } + +* _board.mk_ + + :::Makefile + # board.mk + + ifeq "$(BOARD_DIR)" "" + # This Makefile will self-locate if BOARD_DIR is not specified. + BOARD_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST)))) + endif + + SRCS += board.c + VPATH += $(BOARD_DIR)/Source + IPATH += $(BOARD_DIR)/Include + +## Disabling BSPs + +It should also be noted that BSP integration can be disabled entirely by setting the `LIB_BOARD` [build configuration variable](#build-configuration-variables) to 0. This will skip the inclusion of the BSP's `board.mk` file entirely, and the default system initialization functions will be used. + +This option can also be used to implement a custom BSP inside of a project's application code. For example, a user could implement `Board_Init` inside of a project's `main.c` file without having to create a separate BSP folder with `LIB_BOARD = 0`. + +* _project.mk_ + + :::Makefile + # project.mk + + LIB_BOARD = 0 + +* _main.c_ + + :::C + // main.c + int Board_Init(void) + { + // Implement me! + return E_NO_ERROR; + } + + int main(void) + { + Board_Init(); + // ... + } diff --git a/Documentation/ug-build-system.md b/Documentation/ug-build-system.md new file mode 100644 index 0000000000..bef9fe250b --- /dev/null +++ b/Documentation/ug-build-system.md @@ -0,0 +1,210 @@ +# Build System + +## Build System Overview + +The **Build System** manages the compilation of source code into program binaries and offers a **Command-Line Interface (CLI)** for setting **Build Configuration Variables**. All IDEs interface with this system. + +The Build System is managed by two files found in a project's root directory, one called **Makefile** and one called **project.mk**. These files are used by the [GNU Make](https://www.gnu.org/software/make/) program (which is a part of the MSDK toolchain) to locate and build a project's source code. + +* **Makefile** is the "core" file and should not be edited directly. Instead, it exposes the **CLI** that can be accessed in the _project.mk_ file, on the command line, in your system's environment, or through your IDE. It also comes with a default configuration that is suitable for most projects. +* **project.mk** offers a convenient and stable access point for advanced build configuration, and this is the file that should be edited if necessary. + +When the command + + make + +is run from inside of a project folder, the program `make` will resolve any project-specific settings and then build the project's source code. + +## Default Build Behavior + +By default, the build system will **auto-search** the **root** project directory for _source code_ (**`*.c`**) and _header files_ (**`*.h`**) to compile into a program binary. The _optional_ **include** and **src** directories are also searched if they exist. + + :::bash + Root Project Directory + ├─ project.mk + ├─ Makefile + ├─ *.h + ├─ *.c + ├─include # <-- Optional + └─ *.h + ├─src # <-- Optional + └─ *.c + +Additionally, a project's build system will come pre-configured for a specific _Target Microcontroller_ and its primary _BSP_. + +The default configuration is suitable for most use cases, but a system of _Build Configuration Variables_ is available if additional configuration is needed. + +## Build Configuration Variables + +A **Build Configuration Variable** is a [Makefile variable](https://www.gnu.org/software/make/manual/make.html#Using-Variables) and therefore follows the same rules. However, they have been streamlined to be made much easier to use, so most of the [official GNU Make documentation](https://www.gnu.org/software/make/manual/make.html) is only needed for advanced use cases. + +### How to Set a Build Configuration Variable + +To set a **standard** configuration variable, **use the `=` syntax**... + + VARIABLE=VALUE + +The **`=`** operator is used for _most_ configuration variables with a few exceptions (documented in the [reference table](#build-tables)) when a variable should contain a **_list_ of values**. In such cases, **use `+=` the syntax** to _add_ values to the list. + + VARIABLE+=VALUE1 + VARIABLE+=VALUE2 + +### Where to Set a Build Configuration Variable + +For most variables, you should set them in the **project.mk** file (exceptions are documented in the [reference table](#build-tables) and IDE-specific sections). + +For example, to enable hardware floating-point acceleration for a project, the **`MFLOAT_ABI`** configuration variable can be used with a value of **`hard`**. The contents of **project.mk** might then look as follows: + +(_Inside project.mk_) + + :::Make + # This file can be used to set build configuration + # variables. These variables are defined in a file called + # "Makefile" that is located next to this one. + + # For instructions on how to use this system, see + # https://analogdevicesinc.github.io/msdk/USERGUIDE/ + + # ********************************************************** + + MFLOAT_ABI=hard # Enable hardware floating point acceleration + +It should also be noted that configuration variables can be set on the **command line** as well. For example + + make MFLOAT_ABI=hard + +will have the same effect. + +Additionally, **environment variables** can be used. For example (on Linux) + + export MFLOAT_ABI=hard + +will set the hardware floating point acceleration as the default for all projects with an environment variable. + +However, there is a _precedence hierarchy_ that should be taken into consideration. + +### Precedence Hierarchy + +The precedence hierarchy for the value of a configuration variable is: + +- **IDE/command-line > project.mk > environment variable > default value** + +If a value is set in an IDE _and_ project.mk, the IDE's value will take precedence. However, the ["override" directive](https://www.gnu.org/software/make/manual/make.html#Override-Directive) can be used in project.mk to give it max precedence. + +## Build Tables + +The following sections present the available [Build Configuration Variables](#build-configuration-variables). + +### Primary Build Variables + +| Configuration Variable | Description | Details | +| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| `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-packages) 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](#bsp-search-directory) for more details. | + +### Project Build Variables + +The following variables deal with fundamental project tasks such as adding source code, include paths, changing the output filename, etc. + +| Configuration Variable | Description | Details | +| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| `VPATH` | Where to search for source (.c/.cpp) files | **Use the `+=` operator with this variable**. This controls where the Makefile will look for **source code** files. If `AUTOSEARCH` is enabled (which it is by default), all source code files in the directories specified by this option will be automatically added to the build. If `AUTOSEARCH` is disabled, this tells the Makefile where to look for the files specified by `SRCS`. | +| `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](#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.
Ex: Give a file called `libEXAMPLE.a`, write `PROJ_LIBS += EXAMPLE`
Additionally, ensure that the location of the library is added to `PROJ_LDFLAGS`.
Ex: `PROJ_LDFLAGS += -Lsome/library/search/directory` | + +### Build Variables for the Compiler + +The following variables can be used to interface with the compiler to perform common tasks such as changing the optimization level, adding compiler definitions to the build, and changing floating point acceleration. + +| Configuration Variable | Description | Details | +| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| `MXC_OPTIMIZE_CFLAGS` | Set the optimization level | See [Optimize Options](https://gcc.gnu.org/onlinedocs/gcc/Optimize-Options.html) for more details. Normal builds will default to `-Og`, which is good for debugging, while release builds will default to `-O2`. | +| `PROJ_CFLAGS` | Add compiler flags to the build | **Use the `+=` operator with this variable**. Compiler flags can be added with this option, including compiler definitions. For each value, the same syntax should be used as if the compiler flag was passed in over the command line. These can include standard [GCC options](https://gcc.gnu.org/onlinedocs/gcc-10.4.0/gcc/Option-Summary.html#Option-Summary) and/or [ARM-specific](https://gcc.gnu.org/onlinedocs/gcc/ARM-Options.html) options. | +| `PROJ_AFLAGS` | Add assemblers flag to the build | **Use the `+=` operator with this variable**. Assembler flags can be added with this option. | +| `PROJ_OBJS` | Add object files to the build | **Use the `+=` operator with this variable**. If needed, object files (.o) can be added to the build with this option. | +| `DEBUG` | Toggle extra debug information | Set this to `1` to enable extra debug information at compile time. This generally improves the reliability of debugging at some increase in code size. Set to `0` to disable. + +### Build Variables for the Linker + +| Configuration Variable | Description | Details | +| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| `LINKERFILE` | Set the linkerfile to use | A linkerfile is responsible for specifying the available memory banks, their layout, and the organization of program binaries memory. The file should exist in `Libraries/CMSIS/Device/Maxim/TARGET/Source/GCC` in the MSDK, or it should be placed inside the root directory of the project. | +| `PROJ_LDFLAGS` | Add a linker flag to the build | **Use the `+=` operator with this variable**. Flags can be passed to the linker with this option. See [GCC Options for Linking](https://gcc.gnu.org/onlinedocs/gcc/Link-Options.html#Link-Options) | + +### Build Variables for Arm Cores + +The following build variables are used to control options specific to the Arm Cortex-M4 core available. They are available on all microcontrollers, and for all projects unless that project is built for a RISC-V core. + +| Configuration Variable | Description | Details | +| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| `MFLOAT_ABI` | Set the floating point acceleration level | Sets the floating-point acceleration level. Permitted values are `hard`, `soft`, and `softfp` (default). To enable full hardware acceleration instructions, use `hard`, but keep in mind that _all_ libraries your source code uses must also be compiled with `hard`. If there is any conflict, you'll get a linker error. For more details, see `-mfloat-abi` under [ARM Options](https://gcc.gnu.org/onlinedocs/gcc/ARM-Options.html). | +| `DEFAULT_OPTIMIZE_FLAGS` | Override the default extra optimization flags | Extra compiler optimization flags are added to the build. They are defined in `Libraries/CMSIS/Device/Maxim/GCC/gcc.mk`. These can be disabled entirely by setting this variable to empty (`DEFAULT_OPTIMIZE_FLAGS=`). | +| `DEFAULT_WARNING_FLAGS` | Override the default warning flags | Default flags controlling warning output are added in `Libraries/CMSIS/Device/Maxim/GCC/gcc.mk`. These can be disabled entirely by setting this variable to empty (`DEFAULT_OPTIMIZE_FLAGS=`). | +| `MCPU` | Set the processor type | Set the target ARM processor. Directly maps to `-mcpu` under [ARM Options](https://gcc.gnu.org/onlinedocs/gcc/ARM-Options.html). This flag is handled by the MSDK and not typically changed manually. | +| `MFPU` | Set the FPU architecture | Set the floating point unit (FPU) architecture. Directly maps to `-mfpu` under [ARM Options](https://gcc.gnu.org/onlinedocs/gcc/ARM-Options.html). This flag is handled by the MSDK and not typically changed manually. | + +### Build Variables for RISC-V Cores + +The following build variables are used for RISC-V development. They are only available on microcontrollers with RISC-V cores. + +| Configuration Variable | Description | Details | +| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| `RISCV_CORE` | Build a project for the RISC-V core | Set to `1` to convert an entire project to use the RISC-V toolchain. Only available on microcontrollers with a RISC-V core. | +| `RISCV_LOAD` | Compile and load project for the RISC-V core | **Only available on the MAX32655, MAX32680, and MAX32690**. Set to `1` compile the project specified by `RISCV_APP` for the RISC-V core and link it into the same binary as the current project. Useful for dual-core projects. +| `RISCV_APP` | Project folder to compile for the `RISCV_LOAD` option | **Only available on the MAX32655, MAX32680, and MAX32690**. This option specifies the project to build for the RISC-V core when `RISCV_LOAD` is enabled. Must be a path relative to the project that enables `RISCV_LOAD`, or an absolute path. | +| `RISCV_PREFIX` | Change the toolchain prefix | This option can be used to override the GCC toolchain prefix if needed. For example, to use the legacy RISC-V toolchain `RISCV_PREFIX = riscv-none-embed` will attempt to compile with `riscv-none-embed-gcc`. | + +### Build Variables for Toggling Libraries + +The following variables can be used to enable the [available libraries](#libraries) in the MSDK. Each library may also offer its own build configuration variables when enabled, which are documented in the [libraries](#libraries) section. + +| Configuration Variable | Description | Details | +| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| `LIB_BOARD` | Include the BSP library (enabled by default) | Inclusion of the Board-Support Package (BSP) library, which is enabled by default, can be toggled with this variable. Set to `0` to disable or `1` to enable. | +| `LIB_PERIPHDRIVERS` | Include the peripheral driver library (enabled by default) | The peripheral driver library can be toggled with this option. If disabled, you'll lose access to the higher-level driver functions but still have access to the register-level files. Set to `0` to disable or `1` to enable. | +| `LIB_CMSIS_DSP` | Include the CMSIS-DSP library | The [CMSIS-DSP library](https://www.keil.com/pack/doc/CMSIS/DSP/html/index.html) can be enabled with this option. Set to `0` to disable or `1` to enable. | +| `LIB_CORDIO` | Include the Cordio library | The Cordio BLE library can be included with this option. This is only applicable for microcontrollers with an integrated BLE controller. | +| `LIB_FCL` | Include the Free Cryptographic Library (FCL) | This option toggles the Free Cryptographic Library (FCL), which is a collection of software-implemented common cryptographic functions that can be included with this option. Set to `0` to disable or `1` to enable. | +| `LIB_FREERTOS` | Include the FreeRTOS library | The [FreeRTOS](https://freertos.org/) library can be enabled with this option, which is an open-source Real-Time Operating System (RTOS). Set to `0` to disable or `1` to enable. | +| `LIB_LC3` | Include the LC3 codec library | This option enables the inclusion of the Low Complexity Communication Codec (LC3), which is an efficient low latency audio codec. Set to `0` to disable or `1` to enable. | +| `LIB_LITTLEFS` | Include the littleFS library | This option toggles the ["Little File System"](https://github.com/littlefs-project/littlefs) library - a small filesystem library designed for microcontrollers. Set to `0` to disable or `1` to enable. | +| `LIB_LWIP` | Include the lwIP library | | +| `LIB_MAXUSB` | Include the MaxUSB library | This option toggles the inclusion of the MAXUSB library, which facilitates the use of the native USB peripherals on some microcontrollers. Set to `0` to disable or `1` to enable. | +| `LIB_TINY_USB` | Include the TinyUSB library | This option toggles the inclusion of the TinyUSB library, which facilitates the use of the native USB peripherals on some microcontrollers. Set to `0` to disable or `1` to enable. | +| `LIB_SDHC` | Include the SDHC library | This option toggles the Secure Digital High Capacity (SDHC) library, which can be used to interface with SD cards. Additionally, it enables the [FatFS](http://elm-chan.org/fsw/ff/00index_e.html) library, which implements a generic FAT filesystem. | +| `LIB_CLI` | Include the MSDK's built-in CLI library | This option toggles the MSDK's built-in CLI library, which can be used to process received commands over UART. | +| `LIB_USS` | Include the USS Library | This option toggles the Unified Security Software library. It is only available via NDA. | + +### Build Variables for the PeriphDrivers Library + +The following variables are specific to the PeriphDrivers library. + +| Configuration Variable | Description | Details | +| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| `MXC_SPI_VERSION` | Set the SPI drivers to use (default is `v1`) | The PeriphDrivers offer two versions of the SPI API in order to maintain backwards compatibility. Acceptable values are `v1` (legacy) or `v2`. See [The SPI V2 Developer Note](#spi-v2-library) for more details. | + +### Build Variables for Secure Boot Tools (SBTs) + +For microcontrollers with a secure bootloader, the following build configuration variables can be used to enable integration with the Secure Boot Tools. These are a suite of applications designed for use with microcontrollers that have secure bootloaders. + +| Configuration Variable | Description | Details | +| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| `SBT` | Toggle SBT integration | Toggles integration with the [Secure Boot Tools (SBTs)](https://www.analog.com/en/design-center/evaluation-hardware-and-software/software/software-download.html?swpart=SFW0015360C). These are a suite of applications designed for use with microcontrollers that have secure bootloaders. When this is enabled, some additional rules become available such as `make sla` and `make scpa`. Set to `0` to disable or `1` to enable. | +| `MAXIM_SBT_DIR` | Where to find the SBTs | This option can be used to manually specify the location of the SBTs. Usually, this is not necessary. By default, the `Tools/SBT` directory of the MaximSDK will be searched. If the [SBT installer](https://www.analog.com/en/design-center/evaluation-hardware-and-software/software/software-download.html?swpart=SFW0015360C) is used, it will set the `MAXIM_SBT_DIR` environment variable to point to itself automatically. | +| `TARGET_SEC` | Secure part number to use | Some secure microcontrollers have multiple secure variants, and this option can be used to specify the variant to use with the SBTs. Defaults are intelligently selected and can be found in `$(MAXIM_SBT_DIR)/SBT-config.mk` | +| `SCP_PACKETS` | Where to build the scp_packets folder | Defaults to `build/scp_packets` | +| `TEST_KEY` | Which test key to sign applications with | Defaults to `$(MAXIM_SBT_DIR)/devices/$(TARGET_SEC)/keys/maximtestcrk.key`, which is the Maxim test key that can be used for development. | + +### Build Variables Controlling the Output + +The following build variables can be used to control how to build output is formatted. + +| Configuration Variable | Description | Details | +| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| `VERBOSE` | Toggle verbose builds | Set to `1` to enable a verbose build that prints exactly what the compiler is doing for each step. This is useful for troubleshooting. +| `FORCE_COLOR` | Force colorized compiler output | By default, GCC will attempt to autodetect whether colorized output is supported or not. Set to `1` to force color (equivalent to `PROJ_CFLAGS += -fdiagnostics-color=always`). This is useful for forcing color in CI systems. | diff --git a/Documentation/ug-command-line-dev.md b/Documentation/ug-command-line-dev.md new file mode 100644 index 0000000000..fbbc5a3f98 --- /dev/null +++ b/Documentation/ug-command-line-dev.md @@ -0,0 +1,278 @@ +# Command-Line Development + +This section offers more detailed info on command-line development. + +For setup/quick-start, see ["Getting Started with Command-Line Development"](#getting-started-with-command-line-development). + +## How to Set the BSP (Command-Line) + +- To _persistently_ the BSP, set the **`BOARD`** _[Build Configuration Variable](#build-configuration-variables)_ by editing the **project.mk** that can be found inside each project. + + :::makefile + # This file can be used to set build configuration + # variables. These variables are defined in a file called + # "Makefile" that is located next to this one. + + # For instructions on how to use this system, see + # https://analogdevicesinc.github.io/msdk/USERGUIDE/ + + # ********************************************************** + + # Add your config here! + + BOARD=FTHR_RevA # Set the BSP for the MAX78000FTHR + +- Alternatively, set **`BOARD`** on the command line when building (i.e., `make -r -j BOARD=FTHR_RevA`) to set/override the BSP for a single build. + +## Building on the Command-Line + +1. `cd` into the project folder. + +2. Run `make` + + - **Parallel Build** (fastest build, but console message formatting may be mangled): + + make -r -j + + - **Serial Build** + + make -r + +3. Take note of the output filename and location, which by default is the lowercase name of the _Target microcontroller_ and created in the `build` folder. + +## Cleaning on the Command-Line + +1. `cd` into the project folder. +2. Run `make clean` + - **Project clean**: `make clean` deletes the project `build` folder and all of its contents. + - **Library clean**: `make distclean` can be used to clean out _all_ build products, including the project `build` folder and all [peripheral driver](#peripheral-driver-api) libraries. + +## Flashing on the Command-Line + +???+ note "ℹ️ **A Note on Flashing**" + The commands below are not a comprehensive list of all the possible options for flashing. They are the most common and useful ones. For full documentation, see the "Flash Programming" section of the [**OpenOCD User Manual**](https://openocd.org/doc/pdf/openocd.pdf) + +1. [Build](#building-on-the-command-line) the project. + +2. Connect a debug adapter between the host PC and the evaluation platform. For more detailed instructions on this hardware setup, refer to the evaluation platform's Datasheet and Quick-Start Guide, which are available on its [analog.com](https://analog.com) product page. + +3. Flash the program using `openocd`. It's recommended to use the `make` command below for convenience. + + - ???+ note "ℹ️ **Flashing with Make**" + + :::shell + make flash.openocd + + Expected output: + + :::bash + Open On-Chip Debugger 0.11.0+dev-g4cdaa275b (2022-03-02-09:57) + Licensed under GNU GPL v2 + For bug reports, read + http://openocd.org/doc/doxygen/bugs.html + DEPRECATED! use 'adapter driver' not 'interface' + Info : CMSIS-DAP: SWD supported + Info : CMSIS-DAP: Atomic commands supported + Info : CMSIS-DAP: Test domain timer supported + Info : CMSIS-DAP: FW Version = 0256 + Info : CMSIS-DAP: Serial# = 044417016af50c6500000000000000000000000097969906 + Info : CMSIS-DAP: Interface Initialised (SWD) + Info : SWCLK/TCK = 1 SWDIO/TMS = 1 TDI = 0 TDO = 0 nTRST = 0 nRESET = 1 + Info : CMSIS-DAP: Interface ready + Info : clock speed 2000 kHz + Info : SWD DPIDR 0x2ba01477 + Info : max32xxx.cpu: Cortex-M4 r0p1 processor detected + Info : max32xxx.cpu: target has 6 breakpoints, 4 watchpoints + Info : starting gdb server for max32xxx.cpu on 3333 + Info : Listening on port 3333 for gdb connections + Info : SWD DPIDR 0x2ba01477 + target halted due to debug-request, current mode: Thread + xPSR: 0x81000000 pc: 0x0000fff4 msp: 0x20003ff0 + ** Programming Started ** + ** Programming Finished ** + ** Verify Started ** + ** Verified OK ** + ** Resetting Target ** + Info : SWD DPIDR 0x2ba01477 + shutdown command invoked + + This command is a build target added to the MSDK as of the [June 2023 Release](https://github.com/analogdevicesinc/msdk/releases/tag/v2023_06) to make flashing over the command-line easier. It will **flash** _and_ **run** the project with OpenOCD. See the `Tools/Flash/flash.mk` file for implementation details. + + - ???+ note "ℹ️ **OpenOCD Flash & Hold**" + The following command template can be used if you just want to flash the program with OpenOCD manually, and halt the target micro. This is used when you want to start a command-line debugging session. + + :::shell + openocd -s $MAXIM_PATH/Tools/OpenOCD/scripts -f interface/cmsis-dap.cfg -f target/.cfg -c "program build/.elf verify; init; reset halt" + + - ???+ note "**ℹ️ `-s $MAXIM_PATH/Tools/OpenOCD/scripts`**" + This option tells OpenOCD to search the `Tools/OpenOCD/scripts` folder of the MSDK installation for files. + ???+ warning "**⚠️ Warning: Windows**" + On Windows you should use `%MAXIM_PATH%` (Command Prompt) or `$env:MAXIM_PATH` (PowerShell) to dereference the `MAXIM_PATH` environment variable + + - ???+ note "**ℹ️ `-f target/.cfg`**" + This option loads an OpenOCD config file for the _target microcontroller_. Supported options can be found in the `Tools/OpenOCD/scripts/target` folder. + ???+ warning "⚠️**Change `` to match the target micro**" + + - ???+ note "**ℹ️ `-f interface/cmsis-dap.cfg`**" + This option loads an OpenOCD config file for the MAX32625PICO SWD debugger that is included with most EVKITs. You may need to change this option for other debuggers. Supported options can be found in the `Tools/OpenOCD/scripts/interface` folder. + + - ???+ note "`-c "program build/.elf verify; init; reset halt"`" + This command flashes the program binary (`program`), performs a flash verification (`verify`), initializes the connection to the target micro (`init`), and finally resets/halts the micro to prepare for debug (`reset halt`). + + Expected output: + + :::bash + Open On-Chip Debugger 0.11.0+dev-g4cdaa275b (2022-03-02-09:57) + Licensed under GNU GPL v2 + For bug reports, read + http://openocd.org/doc/doxygen/bugs.html + DEPRECATED! use 'adapter driver' not 'interface' + Info : CMSIS-DAP: SWD supported + Info : CMSIS-DAP: Atomic commands supported + Info : CMSIS-DAP: Test domain timer supported + Info : CMSIS-DAP: FW Version = 0256 + Info : CMSIS-DAP: Serial# = 044417016af50c6500000000000000000000000097969906 + Info : CMSIS-DAP: Interface Initialised (SWD) + Info : SWCLK/TCK = 1 SWDIO/TMS = 1 TDI = 0 TDO = 0 nTRST = 0 nRESET = 1 + Info : CMSIS-DAP: Interface ready + Info : clock speed 2000 kHz + Info : SWD DPIDR 0x2ba01477 + Info : max32xxx.cpu: Cortex-M4 r0p1 processor detected + Info : max32xxx.cpu: target has 6 breakpoints, 4 watchpoints + Info : starting gdb server for max32xxx.cpu on 3333 + Info : Listening on port 3333 for gdb connections + Info : SWD DPIDR 0x2ba01477 + target halted due to debug-request, current mode: Thread + xPSR: 0x81000000 pc: 0x0000fff4 msp: 0x20003ff0 + ** Programming Started ** + ** Programming Finished ** + ** Verify Started ** + ** Verified OK ** + Info : Listening on port 6666 for tcl connections + Info : Listening on port 4444 for telnet connections + # Note: OpenOCD is now waiting for a GDB client connection + +## Debugging on the Command-Line + +1. [Flash](#flashing-on-the-command-line) the program using the **Flash and Hold** command above. + +2. Launch an **_new_ separate terminal**. + + ???+ warning "⚠️ On **Windows**, use the MinGW shortcut or `Tools/MSYS2/msys.bat` file to launch the MSYS2 terminal." + +3. `cd` into the location of the copied example project. + +4. Run the following command to launch a **GDB *client***. + + arm-none-eabi-gdb --se=build/.elf + + - ???+ note "**ℹ️ `--se=build/.elf`**" + This sets the symbol and executable file to the compiled program file. + ???+ warning "⚠️ **Change this to match the build output filename.**" + + Expected output: + + :::bash + GNU gdb (GNU Arm Embedded Toolchain 10.3-2021.10) 10.2.90.20210621-git + Copyright (C) 2021 Free Software Foundation, Inc. + License GPLv3+: GNU GPL version 3 or later + This is free software: you are free to change and redistribute it. + There is NO WARRANTY, to the extent permitted by law. + Type "show copying" and "show warranty" for details. + This GDB was configured as "--host=i686-w64-mingw32 --target=arm-none-eabi". + Type "show configuration" for configuration details. + For bug reporting instructions, please see: + . + Find the GDB manual and other documentation resources online at: + . + + For help, type "help". + Type "apropos word" to search for commands related to "word"... + Reading symbols from build/max78002.elf... + (gdb) + + ???+ note "**ℹ️ Note**" + The terminal is now in an interactive GDB client window. It accepts GDB commands. Run `help` at any time, or see [Common GDB Commands](#common-gdb-commands) in this document. + +5. Connect the GDB Client to the OpenOCD server with the following command. + + target extended-remote localhost:3333 + + Expected output: + + :::bash + Remote debugging using localhost:3333 + 0x0000fff4 in ?? () # Note: ?? may be present at this stage, which is OK. + +6. Reset the target microcontroller. + + monitor reset halt + + Expected output: + + :::bash + SWD DPIDR 0x2ba01477 + target halted due to debug-request, current mode: Thread + xPSR: 0x81000000 pc: 0x0000fff4 msp: 0x20003ff0 + +7. Set a breakpoint on `main`. + + b main + + Expected output: + + :::bash + Breakpoint 1 at 0x10000224: file main.c, line 62. + Note: automatically using hardware breakpoints for read-only addresses. + +8. Continue the debugger. + + continue + + Expected output (for the Hello World example): + + :::bash + Continuing. + + Breakpoint 1, main () at main.c:62 + 62 printf("Hello World!\n"); + +9. (Optional) Continue exercising the debugger. + +10. Quit GDB. + + quit + + Expected output: + + :::bash + A debugging session is active. + + Inferior 1 [Remote target] will be detached. + + Quit anyway? (y or n) [answered Y; input not from terminal] + Detaching from program: C:\Users\User\codespace\Hello_World\build\max78002.elf, Remote target + [Inferior 1 (Remote target) detached] + +11. Quit OpenOCD. In the terminal window running the OpenOCD _server_, press `CTRL + C` to issue the shutdown command. + +## Common GDB Commands + +| **Command** | **Short Command** | **Description** | +| ------------------------------- | ----------------- | ------------------------------------------------------------ | +| `monitor halt` | | Halt the microcontroller. | +| `monitor reset halt` | | Reset the microcontroller and immediately halt. | +| `monitor max32xxx mass_erase 0` | | Mass erase flash bank 0. | +| `file ` | | Set the program file to `` | +| `load` | | Flash the current program file | +| `continue` | `c` | Continue execution. | +| `break ` | `b ` | Set a breakpoint. `` can be a function name, file:line\_number, or address. | +| `print ` | `p` | Print the value of a variable. The variable must be in the current scope. | +| `backtrace` | `bt` | Print contents of the stack frame. | +| `step` | `s` | Execute the next instruction. | +| `next` | `n` | Execute the next line of code. | +| `finish` | `f` | Continue to the end of the current function. | +| `info reg` | | Print the values of the ARM registers. | +| `help` | | Print descriptions for available commands | +| `help ` | | Print description for given command. | +| `quit` | `q` | Quit the GDB client | diff --git a/Documentation/ug-debuggers.md b/Documentation/ug-debuggers.md new file mode 100644 index 0000000000..ca7793eea7 --- /dev/null +++ b/Documentation/ug-debuggers.md @@ -0,0 +1,119 @@ +# Debuggers + +## Debug Limitations + +- ???+ warning "**⚠️ Warning**" + It’s important to note some fundamental limitations of debugging the MSDK's supported parts. These limitations may make the device difficult (or impossible) for the debugger to connect in certain states. In such cases, the device can attempt to be recovered using a [MAX32625PICO](#max32625pico-pico). See [How to Unlock a Microcontroller That Can No Longer Be Programmed](#how-to-unlock-a-microcontroller-that-can-no-longer-be-programmed) + * A debugger can not be connected to a microcontroller _while_ the device is in reset. + * A microcontroller can not be debugged while it's _Sleep_, _Low Power Mode_, _Micro Power Mode_, _Standby_, _Backup_, or _Shutdown_ mode. These modes shut down the SWD clock. + * For low-power development, it's recommended to place a 2-second blocking delay at the start of `main`. + +## MAX32625PICO (PICO) + +A MAX32625PICO (affectionately called the "PICO") debug adapter is provided with almost all the evaluation platforms supported by the MSDK. Additionally, most small form-factor evaluation kits have a PICO _embedded_ into the PCB. + +It's good practice to update the PICO's firmware to the latest version, which can be found on the [MAX32625PICO Firmware Images](https://github.com/MaximIntegrated/max32625pico-firmware-images) Github page. + +### Updating the MAX32625PICO (PICO) Debug Adapter Firmware + +1. Download the correct image for your evaluation platform from the [MAX32625PICO Firmware Images](https://github.com/MaximIntegrated/max32625pico-firmware-images) Github page. + +2. Connect the included micro-USB cable to the PICO _without_ connecting the other side of the cable to your host PC yet. + + ![Pico USB Connection](res/pico_partial_connected.jpg) + +3. Press and hold the pushbutton on the top of the PICO. + + ![Pico Pushbutton](res/pico_pushbutton.jpg) + +4. _While holding down the pushbutton on the PICO_ connect the other side of the micro-USB cable to your host PC. + + Keep the pushbutton held down until the LED on the PICO blinks and becomes solid. + + ![Pico Connected](res/pico_connected.jpg) + +5. A `MAINTENANCE` drive should now appear on your file system. + + ![Maintenance Drive](res/MAINTENANCE.jpg) + +6. Drag and drop the downloaded file from step 1 onto the `MAINTENANCE` drive. This will flash the PICO with the updated firmware. + + ![Maintenance Drive](res/MAINTENANCE.jpg) + + ![Drag and Drop](res/drag_and_drop.JPG) + + ![Flashing](res/pico_flashing.JPG) + +7. Once the flashing is complete, the PICO will restart and present itself as a `DAPLINK` drive. + + ![DAPLINK Drive](res/DAPLINK.jpg) + +8. Open the `DAPLINK` drive. + + ![Opened DAPLINK Drive](res/DAPLINK_opened.jpg) + +9. Open the `DETAILS.TXT` file and verify the Git SHA matches the expected value for the updated file. + + ![DETAILS.TXT](res/DETAILS_Git_SHA.jpg) + +10. Your PICO debugger is now ready to use with the latest firmware. + +### How to Unlock a Microcontroller That Can No Longer Be Programmed + +The [debug limitations](#debug-limitations) of the MSDK's supported parts may make some devices difficult to connect to if bad firmware has been flashed. In such cases, the device can attempt to be recovered from the "locked out" firmware by mass erasing the application code from the flash memory bank. Note that this does not always work. Success will depend on a small window being available for the debugger to connect immediately after reset. + +Before following the procedure below, ensure that you have updated the PICO debugger firmware to the latest version. See [Updating the MAX32625PICO (PICO) Debug Adapter Firmware](#updating-the-max32625pico-pico-debug-adapter-firmware) + +#### Unlock with VS Code + +For VS Code users, the `"erase flash"` [build task](#build-tasks) can be used to attempt a mass erase. If this task fails to recover the part, attempt the procedure below. + +#### Unlock with `erase.act` + +1. Connect the PICO debugger to the microcontroller to recover. + +2. Connect the PICO debugger to the host PC with the included micro-USB cable. + +3. Open the DAPLINK` drive on the host PC. + + ![DAPLINK Drive](res/DAPLINK.jpg) + +4. Open the `DETAILS.TXT` inside of the `DAPLINK` drive in a text editor. + + ![DAPLINK Opened](res/DAPLINK_opened.jpg) + +5. Verify that the “Automation allowed” field is set to 1. + + ![Automation Allowed](res/DETAILS_automation_allowed.jpg) + + ??? note "ℹ️ **Enabling Automation**" + If this field is _not_ set to 1, follow the procedure below: + + 1. Create a new _empty_ file, and save it as `auto_on.cfg`. + + 2. Press and hold the pushbutton on top of the PICO. + + ![PICO Pushbutton](res/pico_pushbutton.jpg) + + 3. _While holding the pushbutton_, drag and drop the `auto_on.cfg` file onto the `DAPLINK` drive. + + ![Drag and Drop File](res/auto_on.cfg.jpg) + + 4. Continue holding the pushbutton until the file is finished transferring over, then release it. + + 5. The PICO should power cycle, and the DAPLINK drive should re-appear with “Automation allowed” set to 1. + +6. Power on the evaluation platform (if it isn’t already). + +7. Create an empty file called `erase.act`. + +8. Drag and drop the `erase.act` file onto the `DAPLINK` drive. + + ![Drag and Drop erase.act](res/erase.act.jpg) + +9. The PICO debugger will attempt to mass erase the microcontroller's flash bank, which will completely wipe any application firmware that is programmed on the device. + + ???+ note "ℹ️ **Note**" + If this process fails, a `FAIL.TXT` file will be present in the DAPLINK drive with an additional error message inside of it. A failure is generally indicative of firmware that has completely shut down the debug port, or has entered low power loop immediately on power-up. In these cases, it's not possible to recover the device. + +10. Power cycle the microcontroller. It step 8 succeeded, it's blank and ready to re-program. The debugger should have no issues connecting to the device in this blank state. diff --git a/Documentation/ug-developer-notes.md b/Documentation/ug-developer-notes.md new file mode 100644 index 0000000000..ba0f97508c --- /dev/null +++ b/Documentation/ug-developer-notes.md @@ -0,0 +1,150 @@ +# Developer Notes + +## SPI v2 Library + +The SPI v2 Library is the latest version of the MSDK SPI drivers which highlights: + +- Target Select (TS) Control Scheme which provides users the option to drive their own TS pins. +- Optional`MXC_SPI_Config(...)` and `mxc_spi_cfg_t` struct to reduce the use of multiple functions to select proper SPI settings. +- Re-mapped the `MXC_SPI_Init(...)` function input parameters (same behavior as SPI v1). +- Allow for re-arming an SPI transaction within the callback function for chained SPI messages. +- Decrease in setup overhead in a Transaction function call. Less nested function calls within drivers. +- Improved SPI DMA support and DMA Channel IRQ vector flexibility by providing acquired DMA channel numbers before a SPI DMA transaction call. +- The use of Controller and Target terms instead of Master and Slave, respectively. +- Still supports SPI v1 function prototypes for backwards-compatibility. +- Bug fixes from the SPI v1 API. + +### SPI v2 Supported Parts + +- MAX32572 +- MAX32690 +- MAX78002 + +### Porting Projects to use SPI v2 + +The latest SPI examples in the MSDK defaults to build the SPI v1 libraries. Set the `MXC_SPI_VERSION` [build configuration variable](#build-configuration-variables) to `v2` (case sensitive) use the SPI v2 API. + +This guide shows how to update an existing project that is using the SPI v1 API to SPI v2. The SPI v2 Library still supports the SPI v1 function prototypes for backwards-compatibility with the main difference being the SPI DMA interrupt handling (see [SPI DMA Interrupt Handling](#spi-dma-interrupt-handling) section below for more info). + +Note: The SPI v2 API is only a drop in replacement to SPI v1 if SPI DMA is **not** used; should the user choose to continue building with the SPI v1 convention but with the underlying SPI v2 implementation. This porting guide demonstrates how to use the full extent of the SPI v2 features. + +#### SPI Init Function + +The input parameters for the `MXC_SPI_Init(...)` function were updated in SPI v2 to allow for more user-selectable options during initialization. This should not cause any errors or behavioral differences with the `MXC_SPI_Init(...)` function when switching between SPI v1 and SPI v2 builds as the input parameters were essentially re-mapped to more descriptive names. + +SPI v1: + + :::C + int MXC_SPI_Init(mxc_spi_regs_t *spi, + int masterMode, + int quadModeUsed, + int numSlaves, + unsigned ssPolarity, + unsigned int hz, + mxc_spi_pins_t pins) + +SPI v2: + + :::C + int MXC_SPI_Init(mxc_spi_regs_t *spi, + mxc_spi_type_t controller_target, + mxc_spi_interface_t if_mode, + int numTargets, + uint8_t ts_active_pol_mask, + uint32_t freq, + mxc_spi_pins_t pins) + +Input Parameters: + +- `mxc_spi_regs_t *spi` remains unchanged. +- `int masterMode` -> `mxc_spi_type_t controller_target`. The enum `mxc_spi_type_t` was added for increased code readability. +- `int quadModeUsed` -> `mxc_spi_interface_t if_mode`. Previously, the `MXC_SPI_Init(...)` function could only select between standard (4wire) and quad interface modes. With SPI v2, the user can select either standard (`MXC_SPI_INTERFACE_STANDARD`), quad (`MXC_SPI_INTERFACE_QUAD`), 3wire (`MXC_SPI_INTERFACE_3WIRE`), or dual (`MXC_SPI_INTERFACE_DUAL`) mode. +- `int numSlaves` -> `int numTargets`. SPI v2 does not use this parameter and was kept to continue supporting SPI v1. +- `unsigned ssPolarity` -> `uint8_t ts_active_pol_mask`. Updated to a more descriptive name. +- `unsigned int hz` -> `uint32_t freq`. +- `mxc_spi_pins_t pins` remains unchanged. + +#### SPI Config Function + +The `int MXC_SPI_Config(mxc_spi_cfg_t cfg)` function was added to reduce the number of helper function calls to set the appropriate settings that the `MXC_SPI_Init(...)` function did not set. + +This function also sets up the DMA and acquires DMA TX/RX channels for SPI DMA transactions. + +`mxc_spi_cfg_t` struct: + +- `mxc_spi_regs_t *spi` - Select SPI Instance to configure. +- `mxc_spi_clkmode_t clk_mode` - Select clock mode. +- `uint8_t frame_size` - Select single frame size (2 - 16 bits). +- `bool use_dma_tx` - Enable SPI DMA TX (acquire and configure TX channel). +- `bool use_dma_rx` - Enable SPI DMA RX (acquire and configure RX channel). +- `mxc_dma_regs_t *dma` - Select DMA Instance to configure for SPI DMA (Valid only if `use_dma_tx` or `use_dma_rx` is set to true). + +#### SPI Request Struct + +`mxc_spi_req_t` struct: + +- `mxc_spi_regs_t *spi` - Remains unchanged. +- `int ssIdx` - Remains unchanged. +- `int ssDeassert` - Remains unchanged. +- `uint8_t *txData` - Remains unchanged. +- `uint8_t *rxData` - Remains unchanged. +- `uint32_t txLen` - Remains unchanged. +- `uint32_t rxLen` - Remains unchanged. +- `uint32_t txCnt` - Not used in SPI v2. +- `uint32_t rxCnt` - Not used in SPI v2. +- `mxc_spi_callback_t completeCB` - Type was renamed, but funtionally, remains unchanged. + +#### SPI Transaction Functions + +The SPI v2 Libraries follows the terms used in the user guide: Controller and Target instead of Master and Slave, respectively. + +- `MXC_SPI_MasterTransaction(...)` -> `MXC_SPI_ControllerTransaction(...)` +- `MXC_SPI_MasterTransactionAsync(...)` -> `MXC_SPI_ControllerTransactionAsync(...)` +- `MXC_SPI_MasterTransactionDMA(...)` -> `MXC_SPI_ControllerTransactionDMA(...)` +- `MXC_SPI_SlaveTransaction(...)` -> `MXC_SPI_TargetTransaction(...)` +- `MXC_SPI_SlaveTransactionAsync(...)` -> `MXC_SPI_TargetTransactionAsync(...)` +- `MXC_SPI_SlaveTransactionDMA(...)` -> `MXC_SPI_TargetTransactionDMA(...)` + +#### SPI DMA Setup for `MXC_SPI_ControllerTransactionDMA(...)` + +The SPI v2 library allows for more flexibility in setting generic DMA TX/RX channel vectors for SPI DMA transactions during run-time. Compared to SPI v1 where the user must know the acquired SPI DMA TX/RX channel numbers and define the appropriate DMA channel handlers before compile-time. + +There are two ways to initialize and configure the DMA before starting a SPI DMA transaction. + +Method 1: Call `int MXC_SPI_DMA_Init(mxc_spi_regs_t *spi, mxc_dma_regs_t *dma, bool use_dma_tx, bool use_dma_rx)`. + +Method 2: Set up the DMA options in the `mxc_spi_cfg_t` struct and call `int MXC_SPI_Config(mxc_spi_cfg_t cfg)`. + + :::C + ... + // Initialize SPI DMA ahead of time. + MXC_SPI_DMA_Init(SPI, DMA, true, true); + + int TX_DMA_CH = MXC_SPI_DMA_GetTXChannel(SPI); + int RX_DMA_CH = MXC_SPI_DMA_GetRXChannel(SPI); + + NVIC_EnableIRQ(MXC_DMA_CH_GET_IRQ(TX_DMA_CH)); + NVIC_EnableIRQ(MXC_DMA_CH_GET_IRQ(RX_DMA_CH)); + + MXC_NVIC_SetVector(MXC_DMA_CH_GET_IRQ(TX_DMA_CH), DMA_TX_IRQHandler); + MXC_NVIC_SetVector(MXC_DMA_CH_GET_IRQ(RX_DMA_CH), DMA_RX_IRQHandler); + + MXC_SPI_ControllerTransactionDMA(&req); + ... + +The DMA is initialized in `MXC_SPI_DMA_Init(...)` or `MXC_SPI_Config(...)`. This provides information on what DMA channels were acquired for a SPI instance's TX and RX DMA before calling the DMA transaction function. Following the example above, it is recommended to set up a generic-named DMA TX/RX vector because the SPI TX and RX DMA channels won't always acquire DMA_CH0 and DMA_CH1, respectively. + +#### SPI DMA Interrupt Handling + + :::C + void DMA_TX_IRQHandler(void) + { + MXC_SPI_DMA_TX_Handler(SPI); + } + + void DMA_RX_IRQHandler(void) + { + MXC_SPI_DMA_RX_Handler(SPI); + } + +The SPI v1 API requires `MXC_DMA_Handler()` to be called in the TX and RX DMA Channel interrupt handlers. Following the generic vector names used in the previous section, the SPI v2 supplies its own TX/RX DMA Handler processing functions (`MXC_SPI_DMA_RX_Handler(...)` and `MXC_SPI_DMA_RX_Handler(...)`) that must be called within their appropriate DMA channel interrupt handlers. diff --git a/Documentation/ug-eclipse.md b/Documentation/ug-eclipse.md new file mode 100644 index 0000000000..e8f2c1c5f1 --- /dev/null +++ b/Documentation/ug-eclipse.md @@ -0,0 +1,119 @@ +# Eclipse + +For setup/quick-start instructions, see ["Getting Started with Eclipse"](#getting-started-with-eclipse) first. This section offers detailed usage info focusing on the typical development cycle. + +## Running Eclipse + +Eclipse _must_ be launched with the **Eclipse MaximSDK** shortcut. The shortcut points to the `Tools/Eclipse/cdt/eclipse(.bat/.sh)` file, which configures Eclipse's system environment for use with the MSDK toolchain. + +![Figure 22](res/Fig22.jpg) + +When Eclipse is launched, it will prompt for a **_workspace_** location. This is a local folder that Eclipse will copy its projects into. + +![Figure 39](res/Fig39.jpg) + +## Creating a New Project + +1. [Launch](#running-eclipse) Eclipse. + +2. Ensure that the Eclipse is set to the **C/C++ perspective** in the top right corner. Otherwise, the new project wizard will not show up. + +3. Navigate to **File -> New -> Maxim Microcontrollers**. + + ![Figure 31](res/Fig31.jpg) + +4. Enter the project name and hit **Next**. + + ![Figure 32](res/Fig32.jpg) + +5. Follow the new project wizard. + + - Chip type selects the _Target Microcontroller_ + - Board type selects the [_Board Support Package (BSP)_](#board-support-packages) + - Example type selects the example project to be copied as the template for the new project. + - Adapter type selects the debug adapter to use. + + ![Figure 33](res/Fig33.jpg) + +6. Select **Finish** to create the new project. + +## Importing Examples + +1. [Launch](#running-eclipse) Eclipse. + +2. Use **File -> Import** to open the import wizard. + +3. Select **General -> Existing Projects into Workspace** and hit **Next**. + + ![Figure 23](res/Fig23.jpg) + +4. **Browse** to the [`Examples`](https://github.com/analogdevicesinc/msdk/tree/main/Examples) folder in the MSDK installation for your target microcontroller and select the example projects to import into the workspace. + + ![Figure 24](res/Fig24.jpg) + +5. Ensure that **Copy projects into workspace** is selected. This will copy the projects out of the MSDK and leave the originals unmodified. + +6. Select **Finish** to import the project(s). + +7. The projects should now show up in the Project Explorer. + + ![Figure 25](res/Fig25.jpg) + +## How to Set the BSP (Eclipse) + +[Imported](#importing-examples) Eclipse projects files are configured for the **EVKIT**-type _BSP_ by default. To set the BSP: + +1. Right click the project name and select _Properties_. Navigate to **C/C++ Build -> Environment**. +2. Set the **`BOARD`** _[Build Configuration Variable](#build-tables)_ to match the target evaluation platform. + + See [Board Support Packages](#board-support-packages) for a table of possible values. + + ![Figure 26](res/Fig26.jpg) + +3. **clean** and rebuild the project. + +## Building a Project + +1. Ensure that the Eclipse is set to the **C/C++ perspective** (top right). + +2. Select the correct project in the **Launch Configuration** dropdown. + +3. Use the **Build** hammer button (top left) to build the project. + + ![Figure 27](res/Fig27.jpg) + +## Flashing and Debugging + +1. Connect a debug adapter between the host PC and the evaluation platform. For more detailed instructions on this hardware setup, refer to the evaluation platform's Datasheet and Quick-Start Guide, which are available on its [analog.com](https://analog.com) product page. + +2. Ensure the correct project in the **Launch Configuration** dropdown is selected in **Debug** mode. + +3. Use the **Debug** button (top left) to flash the program binary and connect the debugger. + + ![Figure 28](res/Fig28.jpg) + +4. The Eclipse view will switch to debug mode, and the debugger will break on entry into the main. + + ![Figure 29](res/Fig29.jpg) + +5. **Resume** the program (**`F8`**) using the top control bar and exercise the debugger. + + ![Figure 30](res/Fig30.jpg) + +6. **Terminate** the debugger (**`CTRL+F2`**) when finished. + +### Segger J-Link Setup Guide (Eclipse) + +Eclipse offers built-in support for Segger J-Link debuggers. J-Link debugging can be enabled following the steps below: + +1. Download and install the latest Segger J-Link Software and Documentation from [**here**](https://www.segger.com/downloads/jlink/) + +2. Follow the instructions from the Segger J-Link Eclipse plugin [**here**](https://eclipse-embed-cdt.github.io/debug/jlink/) with the following modifications specific to the MSDK. Other options an be left at their defaults. + + 1. Modify the Executable name under "GDB Client Setup" to `arm-none-eabi-gdb${cross_suffix}` + + ![Figure 44](res/Fig44.jpg) + + 2. Modify the "Startup" options to issue a `monitor reset halt` under initialization commands and _uncheck_ `Pre-run/Restart reset` + + ![Figure 45](res/Fig45.jpg) diff --git a/Documentation/ug-examples.md b/Documentation/ug-examples.md new file mode 100644 index 0000000000..be084cbef5 --- /dev/null +++ b/Documentation/ug-examples.md @@ -0,0 +1,15 @@ +# Examples + +The MSDK contains examples for each microcontroller that demonstrate the usage of its [Peripheral APIs](#peripheral-driver-api) and other supported libraries. They can be found in the `Examples` folder of an MSDK installation. + +![Figure 40](res/Fig40.jpg) + +???+ warning "**⚠️ Copying Examples**" + It's strongly recommended to copy example projects to an _outside_ folder before modifying them. This keeps the MSDK's "source" copy preserved for reference. Project folders must be copied to a location _without_ any spaces in its filepath. + +Each example contains a `README.md` file describing what it does. In general, there is at least one example per peripheral block, and the example's name will indicate what it matches (i.e., `DMA`, `ADC`, `SPI`). + +The tables below are offered to facilitate easier browsing through the MSDK examples. They are autogenerated from the available projects for each microcontroller. A link to the example's source code on Github is available, as well as its location inside of the MSDK. + + +##__EXAMPLES_LIST__## \ No newline at end of file diff --git a/Documentation/ug-getting-started.md b/Documentation/ug-getting-started.md new file mode 100644 index 0000000000..146498f231 --- /dev/null +++ b/Documentation/ug-getting-started.md @@ -0,0 +1,390 @@ +# Getting Started + +The MSDK is designed for both evaluation and end-application development. The typical **evaluation** cycle usually involves setting up the development environment, running demos, and exercising the peripheral driver API on an _evaluation platform_. The typical **development** cycle typically involves building a prototype application on an _evaluation platform_ first, then porting the application to a custom board. This section describes how to get started with the MSDK focusing on the _evaluation_ cycle. + +**First**, review the [**Key Concepts**](#key-concepts) below. Then, proceed to the section for your preferred IDE. Each sub-section is written as a self-contained quick-start with links to additional documentation on important topics. + +- [Getting Started with Visual Studio Code](#getting-started-with-visual-studio-code) +- [Getting Started with Eclipse](#getting-started-with-eclipse) +- [Getting Started with Command-Line Development](#getting-started-with-command-line-development) + +## Key Concepts + +The MSDK supports multiple development environments with different features that may tailor to the user's preferences. There are a few key concepts to remember that are universal to MSDK development. + +- **Target Microcontroller**: The _target microcontroller_ refers to the base part number of the microcontroller used for development. The MSDK contains register-level support and startup files for each of its [supported parts](#supported-parts), and it's important to note that support files for a target microcontroller and its _Board Support Packages_ are distinct from each other. + + For example, if the [MAX78000EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000evkit.html) _or_ [MAX78000FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000fthr.html) is being used, the _Target Microcontroller_ is the MAX78000. + +--- + +- **Board Support Package (BSP)**: The MSDK supports evaluation platforms for target microcontrollers with _Board Support Packages_. For microcontrollers with multiple evaluation platforms, multiple BSPs are available. These can be found in the `Libraries/Boards` folder of the MSDK installation. + + By default, most projects in the MSDK come pre-configured for the "EVKIT"-type BSP, which is generally the largest evaluation platform for that device with most (or all) pins broken out. It's important to note that the active BSP may need to be reconfigured for a project, which is done slightly differently for each development environment. + +--- + +- **System Environment**: Your system's _environment_ is a broad term that encapsulates the programs and variables available to your system's shell on the command line. The user is expected to have some basic familiarity with this concept. + +--- + +- **System Path**: Your system's _Path_ is a unique environment variable that tells it where to search for program binaries. The user is expected to be familiar with this concept and how to modify the system Path if necessary. + +--- + +- **Integrated Development Environment (IDE)**: An IDE offers a higher-level user interface (typically with a GUI) that manages the tools for **editing** source code, **building** source code, **flashing** program binaries, and **debugging**. The abbreviation is frequently used in this document, and the MSDK supports _multiple_ IDEs that can be used depending on preference. (See ["Supported Development Environments"](#supported-development-environments)) + +--- + +- **Build Configuration vs. Project Configuration**: An MSDK project is comprised of two complementary systems: The _Build System_ and the _Integrated Development Environment (IDE)_. These systems each offer their own configuration interfaces, and it's important to note what each is used for. + + The **Build System** manages source code compilation into program binaries and offers a **Command-Line Interface (CLI)** for setting **Build Configuration Variables**. + + The **IDE** offers a higher-level user interface (typically with a GUI) for managing a project and sits _on top_ of the build system's _CLI_. Each IDE offers its own settings for managing fundamental aspects of the build, such as: + + - Setting the _Target Microcontroller_ + - Setting the _Board Support Package_ + - Configuring the _Environment_ and _System Path_ for use with the MSDK toolchain + +## Getting Started with Visual Studio Code + +The MSDK includes Visual Studio Code ("VS Code") support through the [VSCode-Maxim](https://github.com/MaximIntegratedTechSupport/VSCode-Maxim) project. + +This section walks through setup, opening, and running an example project with VS Code. This material is also available in video form targeting the MAX78000 in ["Understanding Artificial Intelligence Episode 8.5 - Visual Studio Code"](https://www.analog.com/en/education/education-library/videos/6313212752112.html). + +For complete documentation, see the [Visual Studio Code](#visual-studio-code) section of this User Guide. + +### Setup (VS Code) + +The setup below only needs to be done once per MSDK [installation](#installation). + +1. Download and install Visual Studio Code for your OS [here](https://code.visualstudio.com/Download). + +2. Launch Visual Studio Code. + +3. Install the Microsoft [C/C++ extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools). + +4. Install the [Cortex-Debug extension](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug) + +5. Use **`CTRL + SHIFT + P`** (or **`COMMAND + SHIFT + P`** on MacOS) to open the developer prompt. + +6. Type "open user settings" and select the **"Preferences: Open User Settings (JSON)"** option. + + ![Open Settings JSON Command](res/Fig42.jpg) + +7. Add the entries below to your user settings.json file. + + :::json + // There may be other settings up here... + + "MAXIM_PATH": "Change me! Only use forward slashes (/) for this path", + "update.mode": "manual", + "extensions.autoUpdate": false, + + // There may be other settings down here... + + ???+ warning "⚠️ **Setting MAXIM_PATH**" + Set the `MAXIM_PATH` option to the _absolute path_ of the MSDK installation. + For example, you might set `"MAXIM_PATH":"C:/MaximSDK"` on Windows and `"MAXIM_PATH":"/home/username/MaximSDK"` on Ubuntu/MacOS. + + ???+ note "ℹ️ **Note: Automatic Updates**" + `"update.mode: "manual"` and `"extensions.autoUpdate": false` _disable_ automatic updates of VS Code and its extensions, respectively. This is an _optional_ (but recommended) addition left over from the early days of VS Code development when there was lots of feature churn. Things have stabilized more as of version 1.70+, but updates remain frequent. For the VSCode-Maxim project files, the exact version numbers tested with each release can be found on the [VSCode-Maxim Releases](https://github.com/analogdevicesinc/VSCode-Maxim/releases) page. + +8. Save your changes to the file with **`CTRL + S`** and restart VS Code. + +### Building and Running a Project (VS Code) + +1. Launch Visual Studio Code. + +2. Select **File -> Open Folder...** + + ![File -> Open Folder](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/file_openfolder.JPG) + +3. Navigate to an example project for the target microcontroller in the MSDK's `Examples` folder. + + ![Figure 43](res/Fig43.jpg) + + ???+ warning "**⚠️ Copying Examples**" + It's strongly recommended to copy example projects to an _outside_ folder before modifying them. This keeps the MSDK's "source" copy preserved for reference. Project folders must be copied to a location _without_ any spaces in its filepath. + +4. VS Code will prompt for trust the first time. Select _Trust folder and enable all features_ + + ![Trust Prompt](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/workspaceTrustPrompt.JPG) + +5. The opened project should look something like this. + + ![Figure 16](res/Fig16.jpg) + +6. Set the **Board Support Package** to match your evaluation platform. In VS Code, this is done by editing the `.vscode/settings.json` file and setting the `"board"` project configuration option. + + ???+ note "ℹ️ **Note**" + See [Board Support Packages](#board-support-packages) for more details and a table of values. + + ![Figure 17](res/Fig17.jpg) + +7. Save your changes to `settings.json` with `CTRL+S`. + +8. Reload the VS Code window. After changing any options in `settings.json`, a reload is necessary to force it to re-index VS Code's Intellisense engine. + + VS Code can be conveniently reloaded with the **Reload Window** developer command accessed with **`CTRL + SHIFT + P`** (or **`COMMAND + SHIFT + P`** on MacOS). + + ![Reload window](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/reload_window.JPG) + +9. Press the shortcut **`Ctrl+Shift+B`** to open the available **Build Tasks** (alternatively navigate to _Terminal -> Run Build task..._). + + ![Build Tasks Image](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/buildtasks.JPG) + +10. Run the **"build"** task to compile the project for the configured _Target Microcontroller_ and _BSP_. Notice that the `TARGET` and `BOARD` Build Configuration Variables are set on the command line. The program binary is successfully compiled into the `.elf` program binary in the **build** sub-folder of the project. + + ![Figure 18](res/Fig18.jpg) + +11. Connect a debug adapter between the host PC and the evaluation platform. Detailed instructions on this hardware setup can be found in the evaluation platform's Datasheet and Quick-Start Guide, which are available on its [analog.com](https://analog.com) product page. + +12. Run the **`flash`** build task. Running this task will automatically build the project if needed, flash the program binary, and halt the program execution to await a debugger connection. + + ![Figure 19](res/Fig19.jpg) + +13. Open the **Run and Debug** window (**`CTRL+SHIFT+D`**) and launch the debugger (**`F5`**). + + ![Figure 20](res/Fig20.jpg) + +14. Verify the program counter enters `main` successfully. + + ![Figure 21](res/Fig21.jpg) + +15. Press **Continue** (**`F5`**) to run the program. + + ![Debugger Control Bar Image](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/debugger_bar.JPG) + + Continue | Step Over | Step Into | Step Out | Restart | Stop + +16. Exercise the debugger and press stop to disconnect when finished. + + ???+ note "ℹ️ **Note**" + See [Visual Studio Code](#visual-studio-code) for additional more detailed documentation. + +--- + +## Getting Started with Eclipse + +### Setup (Eclipse) + +The only setup required to use Eclipse is to ensure that the "Eclipse" component has been selected during the [MSDK installation](#installation). If the MSDK is already installed, Eclipse can be retrieved using the [Maintenance Tool](#maintenance). + +This section is an Eclipse "quick-start" that walks through creating, building, and running a project. For complete documentation, see the [Eclipse](#eclipse) section of this User Guide. + +### Building and Running a Project (Eclipse) + +1. Launch Eclipse with its start menu shortcut. + + ![Figure 22](res/Fig22.jpg) + +2. Ensure Eclipse is set to the **C/C++ perspective** in the top right corner. Otherwise, the new project wizard will not show up. + +3. Navigate to **File -> New -> Maxim Microcontrollers**. + + ![Figure 31](res/Fig31.jpg) + +4. Enter the project name and hit **Next**. + + ![Figure 32](res/Fig32.jpg) + +5. Follow the new project wizard. + + - Chip type selects the _Target Microcontroller_ + - Board type selects the [_Board Support Package (BSP)_](#board-support-packages) + - Example type selects the example project to be copied as the template for the new project. + - Adapter type selects the debug adapter to use. + + ![Figure 33](res/Fig33.jpg) + +6. Select **Finish** to create the new project. + +7. Build the project using the **Build** hammer button (top left). + + ![Figure 27](res/Fig27.jpg) + +8. Select the correct project in the **Launch Configuration** dropdown and set it to **Debug** mode. + +9. Use the **Debug** button (top left) to flash the program binary and connect the debugger. + + ![Figure 28](res/Fig28.jpg) + +10. The Eclipse view will switch to debug mode, and the debugger will break on entry into `main`. + + ![Figure 29](res/Fig29.jpg) + +11. **Resume** the program (**`F8`**) using the top control bar and exercise the debugger. + + ![Figure 30](res/Fig30.jpg) + +12. **Terminate** the debugger (**`CTRL+F2`**) when finished. + + ???+ note "ℹ️ **Note**" + See [Eclipse](#eclipse) for additional more detailed documentation. + +--- + +## Getting Started with Command-Line Development + +This section demonstrates how to build MSDK example projects on the command line. It also shows how to flash and debug over the command line. The [MAX78002EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78002evkit.html) will be used as an example, but the same concepts apply to all parts. + +For more detailed documentation, see the [Command-Line Development](#command-line-development) section of this User Guide. + +### Setup (Command-Line) + +#### Windows + +On Windows, use the MinGW shortcut to launch an MSYS2/MinGW terminal. This shortcut points to `Tools/MSYS2/msys.bat` in an MSDK installation and correctly configures the user's environment for development. + +![Figure 22](res/Fig22.jpg) + +#### Linux/MacOS + +##### Sourcing `setenv` + +A `setenv.sh` script is available in the root directory of an MSDK installation. This file can be sourced to facilitate the setup of an environment for MSDK development. + +```bash +source ~/MaximSDK/setenv.sh +``` + +This command can also be added to shell startup scripts (`~/.bashrc`, `~/.zshrc`, etc.) to automate the environment setup. + +???+ note "ℹ️ **Note: Automatic Updates**" + `setenv.sh` will automatically check for available updates to the MSDK. This can be permanently disabled by following its prompt on startup, or by deleting/moving the `updates.sh` script in the root directory of the MSDK installation. + + ![Figure 51](res/Fig51.jpg) + +##### Manual Setup + +1. On Linux and MacOS, copy the following contents into your shell's terminal profile/startup script to manually configure your environment for MSDK development. Depending on your system and shell, this could be `~/.profile`, `~/.zprofile`, `~/.bashrc`, `~/.zshrc`, etc. Command-line Linux/MacOS users are expected to know which file to edit for their particular system and preferences. + + # Set MAXIM_PATH to point to the MSDK + export MAXIM_PATH=#changeme! + + # Add Arm Embedded GCC to path (v10.3) + export ARM_GCC_ROOT=$MAXIM_PATH/Tools/GNUTools/10.3 + export PATH=$ARM_GCC_ROOT/bin:$PATH + + # Add xPack RISC-V GCC to path (v12.2) + export XPACK_GCC_ROOT=$MAXIM_PATH/Tools/xPack/riscv-none-elf-gcc/12.2.0-3.1 + export PATH=$XPACK_GCC_ROOT/bin:$PATH + + # Add OpenOCD to path + export OPENOCD_ROOT=$MAXIM_PATH/Tools/OpenOCD + export PATH=$OPENOCD_ROOT:$PATH + +2. Change `export MAXIM_PATH=#changeme!` to the installation location of the MSDK. This will make the toolchain accessible from the command line by adding it to your *system's path*. + + # Set MAXIM_PATH environment variable + export MAXIM_PATH=$HOME/MaximSDK + +#### Verification + +Run the following commands to verify that the toolchain is accessible. They should display version numbers successfully. + +- `arm-none-eabi-gcc -v` +- `arm-none-eabi-gdb -v` +- `make -v` +- `openocd -v` + +Any "file not found" errors indicate that `MAXIM_PATH` has not been set correctly or the system's Path has not been configured correctly. + +### Building and Running an Example (Command-Line) + +1. First, copy an [example project](https://github.com/analogdevicesinc/msdk/tree/main/Examples) to an accessible directory outside of the SDK. The `Hello_World` project is a good one to start with. + + ???+ warning "**⚠️ Copying Examples**" + It's strongly recommended to copy example projects to an _outside_ folder before modifying them. This keeps the MSDK's "source" copy preserved for reference. Project folders must be copied to a location _without_ any spaces in its filepath. + +2. Launch your terminal. On Windows, use the MinGW shortcut or `Tools/MSYS2/msys.bat` file to launch the MSYS2 terminal. + +3. `cd` into the location of the copied example project. + +4. Run the following command to build the example: + + make + + ???+ note "ℹ️ **Note: Improving Build Speed**" + The following command can be used to enable parallel builds and drastically improve build speed: + + :::shell + make -r -j --output-sync=target --no-print-directory + + - `-r` is an option that ignores some of Make's implicit rules to improve build speed. + - `-j` enables parallel execution of the build in the maximum number of threads. + + ???+ warning "**⚠️ Parallel Builds**" + Parallel builds can mangle the console output. To deal with this, the `--output-sync=target` option can be used. However, _this is only available in Make version 4 or higher_. When this option is used, `--no-print-directory` is also used to declutter the build output. + + Expected output: + + :::bash + Loaded project.mk + CC main.c + CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/Source/board.c + CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/stdio.c + CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/LED/led.c + CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/PushButton/pb.c + CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/Display/adafruit_3315_tft.c + CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/Touchscreen/adafruit_3315_touch.c + CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/Camera/camera.c + CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/Camera/mipi_camera.c + CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/Camera/ov7692.c + CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/Camera/sccb.c + AS /home/msdk/Libraries/CMSIS/Device/Maxim/MAX78002/Source/GCC/startup_max78002.S + CC /home/msdk/Libraries/CMSIS/Device/Maxim/MAX78002/Source/heap.c + CC /home/msdk/Libraries/CMSIS/Device/Maxim/MAX78002/Source/system_max78002.c + LD /home/msdk/Examples/MAX78002/Hello_World/build/max78002.elf + arm-none-eabi-size --format=berkeley /home/msdk/Examples/MAX78002/Hello_World/build/max78002.elf + text data bss dec hex filename + 35708 2504 1156 39368 99c8 /home/msdk/Examples/MAX78002/Hello_World/build/max78002.elf + +5. Connect a debug adapter between the host PC and the evaluation platform. Detailed instructions on this hardware setup can be found in the evaluation platform's Datasheet and Quick-Start Guide, which are available on its [analog.com](https://analog.com) product page. + +6. Flash and run the program with OpenOCD. + + :::shell + make flash.openocd + + ???+ note "ℹ️ **Note: Flashing with Make**" + The command `make flash.openocd` is a build target added to the MSDK as of the [June 2023 Release](https://github.com/analogdevicesinc/msdk/releases/tag/v2023_06) to make flashing over the command-line easier. It launches and drives an OpenOCD server behind the scenes to flash the project's binary. See the `Tools/Flash/flash.mk` file for implementation details, and [Flashing on the Command-Line](#flashing-on-the-command-line) for more details on launching debug server/clients manually. + + Expected output: + + :::bash + Open On-Chip Debugger 0.11.0+dev-g4cdaa275b (2022-03-02-09:57) + Licensed under GNU GPL v2 + For bug reports, read + http://openocd.org/doc/doxygen/bugs.html + DEPRECATED! use 'adapter driver' not 'interface' + Info : CMSIS-DAP: SWD supported + Info : CMSIS-DAP: Atomic commands supported + Info : CMSIS-DAP: Test domain timer supported + Info : CMSIS-DAP: FW Version = 0256 + Info : CMSIS-DAP: Serial# = 044417016af50c6500000000000000000000000097969906 + Info : CMSIS-DAP: Interface Initialised (SWD) + Info : SWCLK/TCK = 1 SWDIO/TMS = 1 TDI = 0 TDO = 0 nTRST = 0 nRESET = 1 + Info : CMSIS-DAP: Interface ready + Info : clock speed 2000 kHz + Info : SWD DPIDR 0x2ba01477 + Info : max32xxx.cpu: Cortex-M4 r0p1 processor detected + Info : max32xxx.cpu: target has 6 breakpoints, 4 watchpoints + Info : starting gdb server for max32xxx.cpu on 3333 + Info : Listening on port 3333 for gdb connections + Info : SWD DPIDR 0x2ba01477 + target halted due to debug-request, current mode: Thread + xPSR: 0x81000000 pc: 0x0000fff4 msp: 0x20003ff0 + ** Programming Started ** + ** Programming Finished ** + ** Verify Started ** + ** Verified OK ** + ** Resetting Target ** + Info : SWD DPIDR 0x2ba01477 + shutdown command invoked + +7. The program has been flashed and the target micro has been reset. The flashed program should now be running. For the `Hello_World` example, an LED on the board should be blinking. + + ???+ note "ℹ️ **Note**" + See [Command-Line Development](#command-line-development) for additional more detailed documentation. diff --git a/Documentation/ug-iar-embed-wkbench.md b/Documentation/ug-iar-embed-wkbench.md new file mode 100644 index 0000000000..2b3f92862f --- /dev/null +++ b/Documentation/ug-iar-embed-wkbench.md @@ -0,0 +1,5 @@ +# IAR Embedded Workbench + +IAR Embedded Workbench is a third-party IDE that requires a software license. ADI maintains support files for this IDE in the form of CMSIS Pack files. + +Supporting documentation is maintained by IAR, and can be found on the [**Embedded Workbench Product Page**](https://www.iar.com/products/architectures/arm/iar-embedded-workbench-for-arm/) under "User Guides and documentation". diff --git a/Documentation/ug-installation.md b/Documentation/ug-installation.md new file mode 100644 index 0000000000..c433e03eb7 --- /dev/null +++ b/Documentation/ug-installation.md @@ -0,0 +1,218 @@ +# Installation + +## Prerequisites + +- **Elevated/Administrator rights** + +- ???+ warning "**⚠️ MacOS**" + On MacOS, please also download and install [Homebrew](https://brew.sh/). It will be used in [Completing the Installation on MacOS](#completing-the-installation-on-macos) later on. + +- ???+ warning "**⚠️ Ubuntu**" + Several GUI packages are required by the QT installer framework _even on headless systems_. Run the following command _before_ running the installer to retrieve them. + + :::shell + sudo apt update && sudo apt install libxcb-glx0 libxcb-icccm4 libxcb-image0 libxcb-shm0 libxcb-util1 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-render0 libxcb-shape0 libxcb-sync1 libxcb-xfixes0 libxcb-xinerama0 libxcb-xkb1 libxcb1 libxkbcommon-x11-0 libxkbcommon0 libgl1 libusb-0.1-4 libhidapi-libusb0 libhidapi-hidraw0 + +## Download + +The MSDK installer is available for supported Operating Systems from the download links below. + +- [**Windows 10**](https://www.analog.com/en/design-center/evaluation-hardware-and-software/software/software-download?swpart=SFW0010820B) + +- [**Linux (Ubuntu)**](https://www.analog.com/en/design-center/evaluation-hardware-and-software/software/software-download?swpart=SFW0018720B) + + - ???+ note "ℹ️ **Note**" + This file must be made executable before running (`chmod +x MaximMicrosSDK_linux.run`). Alternatively, set `Allow executing as program" in the Ubuntu GUI. + ![Figure 1](res/Fig1.jpg) + +- [**MacOS**](https://www.analog.com/en/design-center/evaluation-hardware-and-software/software/software-download?swpart=SFW0018610B) + + - ???+ note "ℹ️ **Note**" + On MacOS, the installer is distributed inside a .dmg disk image file. Double-click the downloaded file to mount it. Afterward, the installer executable will be made available inside the mounted drive. + +## Setup + +The MSDK installer can be run through a [**GUI Installation**](#gui-installation) or a [**Command-Line Installation**](#command-line-installation) + +### GUI Installation + +1. [**Download**](#download) the installer executable to an accessible location and launch it. + +2. Click **Next** to proceed from the Welcome screen. + +3. Choose the installation location. + + ![Figure 2](res/Fig2.jpg) + +4. Select the components to install. It's recommended to install all components. + + ![Figure 3](res/Fig3.jpg) + +5. Continue to the installation page, and click **install** to begin. Installation can be safely canceled at any time. + + ![Figure 6](res/Fig6.jpg) + + ![Figure 7](res/Fig7.jpg) + +6. Click **Finish** to complete the installation. + + ![Figure 8](res/Fig8.jpg) + +7. You should now see the contents of the installation directory populated with the MSDK. + + ![Figure 10](res/Fig10.jpg) + + ???+ warning "⚠️ **Warning**" + On MacOS, some [_additional steps_](#completing-the-installation-on-macos) are required. + + +### Command-Line Installation + +The MSDK installer features a command-line interface that can be used as an alternative to its GUI. This is useful for installations on "headless" systems and scripting. + +??? note "ℹ️ **Note:**" The `--help` Command" + The available commands can be retrieved by running the MSDK installer executable with the `--help` option on the command line. For example: + + :::shell + $ ./MaximMicrosSDK_linux.run --help + + Usage: ./MaximMicrosSDK_linux.run [options] command + + Qt Installer Framework supports both GUI and headless mode. The installation operations can be invoked with the following commands and options. Note that the options marked with "CLI" are available in the headless mode only. + + Commands: + in, install - install default or selected packages - + ch, check-updates - show available updates information on maintenance tool + up, update - update all or selected packages - + rm, remove - uninstall packages and their child components - + li, list - list currently installed packages - + se, search - search available packages - + Note: The --filter-packages option can be used to specify + additional filters for the search operation + co, create-offline - create offline installer from selected packages - + pr, purge - uninstall all packages and remove entire program directory + + Options: + -h, --help Displays help on commandline + options. + # ... + +To run a _headless_ installation: + +1. [**Download**](#download) the installer executable to an accessible location. + +2. Ensure that you are able to run the installer with **_elevated permissions_**. + + ???+ note "Windows" + Open a Command Prompt or PowerShell **_as administrator_**. + + ???+ note "Ubuntu and MacOS" + Ensure you have `sudo` rights. + +3. Run the installer with the arguments `in --root ` + + ???+ note "Windows" + :::shell + .\MaximMicrosSDK_win.exe in --root C:/MaximSDK + + ???+ note "Ubuntu and MacOS" + :::shell + sudo ./MaximMicrosSDK_linux.run in --root ~/MaximSDK + +4. Follow the installer's command-line instructions to accept licenses and confirm installation size. + + ??? note "ℹ️ **Note: Unattended Installations**" + You can run the installer without any user input by auto-accepting all licenses, messages, and input. + + :::shell + sudo ./MaximMicrosSDK_linux.run in --root ~/MaximSDK --accept-licenses --accept-messages --confirm-command + +5. (Ubuntu and MacOS) Change ownership of the installation folder with: + + :::shell + sudo chown -R $(whoami):$(whoami) + + ??? note "ℹ️ **Note: Folder Ownership**" + Usually, running the installation with `sudo` results in an installation owned by the `root` user. + + You can verify this with the `ls -la` command. + + :::shell + ls -la ~/MaximSDK + total 29656 + drwxr-xr-x 8 root root 4096 Jul 13 20:41 . + drwxr-x--- 17 username username 4096 Jul 13 20:41 .. + drwxr-xr-x 2 root root 4096 Jul 13 20:41 Documentation + drwxr-xr-x 15 root root 4096 Jul 13 20:41 Examples + -rw-r--r-- 1 root root 171189 Jul 13 20:41 InstallationLog.txt + drwxr-xr-x 17 root root 4096 Jun 28 23:42 Libraries + drwxr-xr-x 2 root root 4096 Jul 13 20:41 Licenses + -rwxr-xr-x 1 root root 28287992 Jul 13 20:41 MaintenanceTool + -rw-r--r-- 1 root root 1719694 Jul 13 20:41 MaintenanceTool.dat + -rw-r--r-- 1 root root 9770 Jul 13 20:41 MaintenanceTool.ini + drwxr-xr-x 11 root root 4096 Jun 28 23:42 Tools + -rw-r--r-- 1 root root 13123 Jun 28 23:48 changelog.txt + -rw-r--r-- 1 root root 67664 Jul 13 20:41 components.xml + -rw-r--r-- 1 root root 48 Jul 13 20:41 installer.dat + drwxr-xr-x 112 root root 12288 Jul 13 20:41 installerResources + -rw-r--r-- 1 root root 25214 Jun 29 00:47 maxim.ico + -rw-r--r-- 1 root root 362 Jul 13 20:41 network.xml + -rwxrwxrwx 1 root root 1129 Jun 29 00:47 setenv.sh + -rwxrwxrwx 1 root root 300 Jun 29 00:47 updates.sh + + The owner of the MSDK installation should be changed back to the normal user with the command above. Otherwise, the toolchain may behave inconsistently against file permission issues. + + Once complete, `ls -la` should look similar to below (where `username` is your username). + + :::shell + ls -la ~/MaximSDK + total 29656 + drwxr-xr-x 8 username username 4096 Jul 13 20:41 . + drwxr-x--- 17 username username 4096 Jul 13 20:41 .. + drwxr-xr-x 2 username username 4096 Jul 13 20:41 Documentation + drwxr-xr-x 15 username username 4096 Jul 13 20:41 Examples + -rw-r--r-- 1 username username 171189 Jul 13 20:41 InstallationLog.txt + drwxr-xr-x 17 username username 4096 Jun 28 23:42 Libraries + drwxr-xr-x 2 username username 4096 Jul 13 20:41 Licenses + -rwxr-xr-x 1 username username 28287992 Jul 13 20:41 MaintenanceTool + -rw-r--r-- 1 username username 1719694 Jul 13 20:41 MaintenanceTool.dat + -rw-r--r-- 1 username username 9770 Jul 13 20:41 MaintenanceTool.ini + drwxr-xr-x 11 username username 4096 Jun 28 23:42 Tools + -rw-r--r-- 1 username username 13123 Jun 28 23:48 changelog.txt + -rw-r--r-- 1 username username 67664 Jul 13 20:41 components.xml + -rw-r--r-- 1 username username 48 Jul 13 20:41 installer.dat + drwxr-xr-x 112 username username 12288 Jul 13 20:41 installerResources + -rw-r--r-- 1 username username 25214 Jun 29 00:47 maxim.ico + -rw-r--r-- 1 username username 362 Jul 13 20:41 network.xml + -rwxrwxrwx 1 username username 1129 Jun 29 00:47 setenv.sh + -rwxrwxrwx 1 username username 300 Jun 29 00:47 updates.sh + +### Completing the Installation on MacOS + +???+ warning "⚠️ **Warning**" + On MacOS, some additional missing packages must be manually installed with [Homebrew](https://brew.sh/). There are also some manual setup steps required to retrieve `make` version 4. The instructions in this section are critical. + +1. Install [Homebrew](https://brew.sh/). + +2. Run the command below to install dependencies for OpenOCD. + + :::shell + brew install libusb-compat libftdi hidapi libusb + +## Maintenance + +An MSDK installation contains a `MaintenanceTool` executable program in its root directory. Use the Maintenance Tool to retrieve updates, manage components, and uninstall the MSDK. + +![Figure 11](res/Fig11.jpg) + +### Updates + +The MSDK releases updates quarterly, and the Maintenance Tool will retrieve the latest release when **Update components** is run. + +### Older Versions and Offline Installer + +Older versions of the MSDK are available as an **_offline installer_** for each release tag. They are available on the [Releases page](https://github.com/analogdevicesinc/msdk/releases) of the MSDK GitHub and can be used to roll back to a specific MSDK release. + +### Development Resources + +Users can obtain development copies of the MSDK resources from [Github](https://github.com/analogdevicesinc/msdk). Setup instructions can be found in the repository's [README](https://github.com/analogdevicesinc/msdk/blob/main/README.md). diff --git a/Documentation/ug-keil-mdk.md b/Documentation/ug-keil-mdk.md new file mode 100644 index 0000000000..9e957aabc0 --- /dev/null +++ b/Documentation/ug-keil-mdk.md @@ -0,0 +1,5 @@ +# Keil MDK + +The [Keil MDK Microcontroller Development Kit](https://www2.keil.com/mdk5) is developed and maintained by Arm. ADI maintains CMSIS Pack files supporting this environment. + +Supporting documentation is maintained by Arm, and can be found on the [**MDK5 page**](https://www2.keil.com/mdk5). The latest pack files can be found under the "Maxim" section of the [device list](https://www.keil.com/dd2/). diff --git a/Documentation/ug-libraries.md b/Documentation/ug-libraries.md new file mode 100644 index 0000000000..23cdf086e9 --- /dev/null +++ b/Documentation/ug-libraries.md @@ -0,0 +1,222 @@ +# Libraries + +The MSDK contains a large number of libraries, both third-party and in-house. The main library is the [Peripheral Driver API](#peripheral-driver-api), but the MSDK also contains drivers for various _external_ components such as TFT displays, cameras, accelerometers, audio codecs, and other devices. Additionally, dedicated libraries for more complex _internal_ hardware peripherals such as USB, the SDHC interface, and the Cordio BLE stack are also available. These usually build on _top_ of the Peripheral Driver API. + +???+ note "ℹ️ **Note: Enabling Libraries**" + Libraries can be enabled for a project with a convenient *toggle switch* provided by the build system (See [Build Variables for Toggling Libraries](#build-variables-for-toggling-libraries)). + +## Peripheral Driver API + +A microcontroller is made up of a Central Processing Unit (CPU) that is surrounded by additional _peripheral_ hardware blocks such as timers, memory controllers, UART controllers, ADCs, RTCs, audio interfaces, and many more. The **Peripheral Driver API** is an important core library in the MSDK that allows the CPU to utilize the microcontroller's hardware blocks over a higher-level **_Application Programming Interface (API)_**. + +![Figure 38](res/Fig38.jpg) + +### API Documentation (PeriphDrivers) + +The links below will open detailed API references for each microcontroller. Offline copies of these API references can also be found in the `Documentation` folder of the MSDK installation. + +- [MAX32520 API](Libraries/PeriphDrivers/Documentation/MAX32520/index.html) + +- [MAX32650 API](Libraries/PeriphDrivers/Documentation/MAX32650/index.html) + +- [MAX32655 API](Libraries/PeriphDrivers/Documentation/MAX32655/index.html) + +- [MAX32660 API](Libraries/PeriphDrivers/Documentation/MAX32660/index.html) + +- [MAX32665-MAX32666 API](Libraries/PeriphDrivers/Documentation/MAX32665/index.html) + +- [MAX32670 API](Libraries/PeriphDrivers/Documentation/MAX32670/index.html) + +- [MAX32672 API](Libraries/PeriphDrivers/Documentation/MAX32672/index.html) + +- [MAX32675 API](Libraries/PeriphDrivers/Documentation/MAX32675/index.html) + +- [MAX32680 API](Libraries/PeriphDrivers/Documentation/MAX32680/index.html) + +- [MAX32690 API](Libraries/PeriphDrivers/Documentation/MAX32690/index.html) + +- [MAX78000 API](Libraries/PeriphDrivers/Documentation/MAX78000/index.html) + +- [MAX78002 API](Libraries/PeriphDrivers/Documentation/MAX78002/index.html) + +### PeriphDrivers Organization + +The Peripheral Driver API's source code is organized as follows: + +- **Header files _(.h)_** can be found in the `Libraries/PeriphDrivers/Include` folder. + - These files contain function _declarations_ for the API, describing the function prototypes and their associated documentation. +- **Source files _(.c)_** can be found in the `Libraries/PeriphDrivers/Source` folder. + - These files contain the function _definitions_ for the API - the _implementations_ of the functions declared by the header files. + +The _**implementation**_ files are further organized based on _**die type**_ and **_hardware revision_**. This is worth noting when browsing or debugging through the drivers. + +- The **_die type_** files follow the **`_ESXX`** , **`_MEXX`** , or **`_AIXX`** naming convention. + - These files' responsibility is to manage microcontroller-specific implementation details that may interact with other peripheral APIs _before_ ultimately calling the revision-specific files. See [Die Types to Part Numbers](#die-types-to-part-numbers) + +- The **_hardware revision_** files follow the **`_revX`** naming convention. + - These files contain the _pure_ driver implementation for a peripheral block and typically interact with the hardware almost entirely at the register level. + +### Die Types to Part Numbers + +The following table matches external part numbers to internal die types. This is useful for browsing through the PeriphDrivers source code, which uses the die types. + +- ???+ note "ℹ️ **Note: Die Types Table**" + + | Part Number | Die Type + | -------- | ----------- | + | MAX32520 | ES17 | + | MAX32570 | ME13 | + | MAX32650 | ME10 | + | MAX32655 | ME17 | + | MAX32660 | ME11 | + | MAX32662 | ME12 | + | MAX32665 | ME14 | + | MAX32670 | ME15 | + | MAX32672 | ME21 | + | MAX32675 | ME16 | + | MAX32680 | ME20 | + | MAX32690 | ME18 | + | MAX78000 | AI85 | + | MAX78002 | AI87 | + +--- + +## CMSIS-DSP + +The CMSIS-DSP library provides a suite of common **Digital Signal Processing _(DSP)_** functions that take advantage of hardware accelerated _Floating Point Unit (FPU)_ available on microcontrollers with Arm Cortex-M cores. This library is distributed in the MSDK as a pre-compiled static library file, and the MSDK maintains a port of the official code examples in the **ARM-DSP** [Examples](https://github.com/analogdevicesinc/msdk/tree/main/Examples) folder for each microcontroller. + +Please refer to the [CMSIS-DSP official documentation](https://arm-software.github.io/CMSIS-DSP/v1.16.2/index.html) for more detailed documentation on the library functions and usage. + +### CMSIS-DSP Supported Parts + +- All microcontrollers with a Cortex M4 core are supported. + +### CMSIS-DSP Build Variables + +| Configuration Variable | Description | Details | +| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| | | | +| `CMSIS_DSP_VERSION` | (Optional) Set the CMSIS-DSP version to use. | Defaults to `1.16.2`, which is currently the only supported version. | + +--- + +## Cordio Bluetooth Low Energy + +The Cordio Bluetooth Low Energy (BLE) library provides a full BLE stack for microcontrollers with an integrated BLE controller. + +The Cordio library warrants its own separate documentation. See the **[Cordio BLE User Guide](Libraries/Cordio/docs/CORDIO_USERGUIDE.md)**. + +### Cordio Supported Parts + +- MAX32655 +- MAX32665 +- MAX32680 +- MAX32690 + +--- + +## MAXUSB + +The MAXUSB library provides a higher-level interface for utilizing the built-in USB controller hardware available on some microcontrollers. This allows the microcontroller to enumerate as a USB device without the need for an external USB controller IC. MAXUSB provides a finer level of control of USB events and classes than TinyUSB. + +### MAXUSB Supported Parts + +- MAX32570 +- MAX32650 +- MAX32655 and MAX32656 +- MAX32665-MAX32666 +- MAX32690 +- MAX78002 + +--- + +## TinyUSB + +The TinyUSB library provides a high-level interface for utilizing the built-in USB controller hardware available on some microcontrollers. This allows the microcontroller to enumerate as a USB device without the need for an external USB controller IC. **[TinyUSB](https://github.com/hathach/tinyusb) provides a cross-platform USB stack for embedded systems, with a higher level of abstraction than MAXUSB, +supporting most standard USB device classes. + +### TinyUSB Supported Parts + +- MAX32650 +- MAX32665-MAX32666 +- MAX32690 +- MAX78002 + +--- + +## Miscellaneous Drivers + +The `Libraries/MiscDrivers` folder of the MSDK contains drivers for miscellaneous external components such as TFT displays, cameras, audio codecs, PMICs, pushbuttons, etc. These resources are usually closely tied with the [Board Support Packages](#board-support-packages). + +### Miscellaneous Build Variables + +| 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. | + +--- + +## SDHC + +The **Secure Digital High Capacity *(SDHC)*** library offers a higher-level interface built on top of the SDHC [Peripheral Driver API](#peripheral-driver-api) that includes a [FatFS File System](http://elm-chan.org/fsw/ff/00index_e.html) implementation for managing files on SD cards. + +See [Build Variables for Toggling Libraries](#build-variables-for-toggling-libraries) for instructions on enabling the SDHC library. + +### SDHC Supported Parts + +- MAX32650 +- MAX32570 +- MAX32665-MAX32666 +- MAX78000 +- MAX78002 + +### SDHC Build Variables + +Once enabled, the following [build configuration variables](#build-configuration-variables) become available. + +| Configuration Variable | Description | Details | +| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| `FATFS_VERSION` | Specify the version of [FatFS](http://elm-chan.org/fsw/ff/00index_e.html) to use | FatFS is a generic FAT/exFAT filesystem that comes as a sub-component of the SDHC library. This variable can be used to change the [version](http://elm-chan.org/fsw/ff/updates.html) to use. Acceptable values are `ff13` (R0.13), `ff14` (R0.14b), or `ff15` (R0.15) | +| `SDHC_CLK_FREQ` | Sets the clock freq. for the SDHC library (Hz) | Sets the target clock frequency in units of Hz (Default is 30Mhz). Reducing the SDHC clock frequency is a good troubleshooting step when debugging communication issues. | +| `FF_CONF_DIR` | Sets the search directory for `ffconf.h` | (Available for `FATFS_VERSION = ff15` only) FatFS configuration is done via an `ffconf.h` file. This option allows specifying the location of a custom `ffconf.h` file for a project. | + +--- + +## FreeRTOS + +[FreeRTOS](https://www.freertos.org/index.html) is a Real-Time Operating System (RTOS), which offers basic abstractions for multi-tasking and an OS layer specifically targeted at embedded systems with real-time requirements. The MSDK maintains an official support layer for the FreeRTOS kernel. Official documentation can be found on the [FreeRTOS website](https://www.freertos.org/index.html). + +### FreeRTOS Supported Parts + +FreeRTOS is supported by all parts in the MSDK. See the `FreeRTOSDemo` example application. + +### FreeRTOS Build Variables + +| Configuration Variable | Description | Details | +| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| `FREERTOS_HEAP_TYPE` | Specify the method of heap allocation to use for the FreeRTOS API | FreeRTOS provides options for the heap management alogirthms to optimize for memory size, speed, and risk of heap fragmentation. For more details, visit the [FreeRTOS MemMang Docs](https://www.freertos.org/a00111.html). Acceptable values are `1`, `2`, `3`, `4`, or `5`. The default value is `4` for heap_4. | + +### FreeRTOS-Plus + +[FreeRTOS-Plus](https://www.freertos.org/FreeRTOS-Plus/index.html) is an additional library that implements addon functionality for the FreeRTOS kernel. The MSDK maintains support for some, but not all, available addons. + +- [FreeRTOS-Plus-CLI](https://www.freertos.org/FreeRTOS-Plus/index.html): **Supported** +- [FreeRTOS-Plus-TCP](https://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/index.html): **Not supported** (Contributions welcome!) + +## CLI + +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. + +## CoreMark + +[EEMBC’s CoreMark®](https://www.eembc.org/coremark/) is a benchmark that measures the performance of microcontrollers (MCUs) and central processing units (CPUs) used in embedded systems. CoreMark is a simple, yet sophisticated benchmark that is designed specifically to test the functionality of a processor core. Running CoreMark produces a single-number score allowing users to make quick comparisons between processors. + +### CoreMark Supported Parts + +All parts in the MSDK support the Coremark library via a `Coremark` example application. + +???+ note "ℹ️ **Note**" + The source code of the `Coremark` examples are somewhat unique. They only contain a `core_portme.c`/`core_portme.h`. These files are provided by CoreMark libraries to give the MSDK an implementation layer for a few hardware-dependent functions. Otherwise, the remainder of the source code (located in `Libraries/Coremark`) must remain unmodified to comply with the CoreMark rules. diff --git a/Documentation/ug-overview.md b/Documentation/ug-overview.md new file mode 100644 index 0000000000..6cd5423a79 --- /dev/null +++ b/Documentation/ug-overview.md @@ -0,0 +1,158 @@ +# Overview + +The MAX Microcontrollers SDK (MSDK), now a part of [Analog Devices](https://www.analog.com/en/index.html), contains the necessary software and tools to develop firmware for the [MAX32xxx and MAX78xxx Microcontrollers](https://www.analog.com/en/parametricsearch/10984). That includes register and system startup files to enable low-level development for its [supported parts](#supported-parts). It also provides higher-level peripheral driver APIs (written in C) alongside various utilities, third-party libraries, Board Support Packages (BSPs), and a set of example programs for each microcontroller. + +Additionally, the MSDK includes a GCC-based toolchain, and builds are managed by a system of Makefiles (See [GNU Make](https://www.gnu.org/software/make/manual/)). A [custom fork of OpenOCD](https://github.com/analogdevicesinc/openocd) enables flashing and debugging. The MSDK's toolchain and build system offers a Command Line Interface (CLI), and project files for [supported development environments](#supported-development-environments) are maintained that build on top of that CLI. + +This document describes the MSDK's installation, setup, and usage. + +## Supported Operating Systems + +- Windows (Windows 10 only) + +- Linux (Ubuntu only) + +- MacOS + +## Supported Parts + +The MSDK officially supports the following microcontrollers and evaluation platforms. + +* [**MAX32520**](https://www.analog.com/en/products/max32520.html): ChipDNA Secure Microcontroller with Secure Boot for IoT Applications + + - [MAX32520-KIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32520-kit.html) + + - [MAX32520FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32520fthr.html) + + +--- + +* [**MAX32570**](https://www.analog.com/en/products/max32570.html): Low-Power Arm Cortex-M4 Microcontroller with Contactless Radio for Secure Applications **(Available by NDA only**) + + - [MAX32570-QNKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32570-qnkit.html) + + - [MAX32570-MNKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32570-mnkit.html) + +--- + +* **MAX32572** **(Not Yet Publicly Available)** + - MAX32572EVKIT **(Not Yet Publicly Available)** + +--- + +* [**MAX32650**](https://www.analog.com/en/products/max32650.html): Ultra-Low-Power Arm Cortex-M4 with FPU-Based Microcontroller (MCU) with 3MB Flash and 1MB SRAM + + - [MAX32650-EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32650-evkit.html) + + - [MAX32650FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32650fthr.html) + +--- + +* [**MAX32651**](https://www.analog.com/en/products/max32651.html): Ultra-Low-Power Arm Cortex-M4 with FPU-Based Microcontroller (MCU) with 3MB Flash and 1MB SRAM + + - [MAX32651-EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32651-evkit.html) + +--- + +* [**MAX32655**](https://www.analog.com/en/products/max32655.html): Low-Power, Arm Cortex-M4 Processor with FPU-Based Microcontroller and Bluetooth 5.2 + + - [MAX32655EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32655evkit.html) + + - [MAX32655FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32655fthr.html) + +--- + +* [**MAX32660**](https://www.analog.com/en/products/max32660.html): Tiny, Ultra-Low-Power Arm Cortex-M4 Processor with FPU-Based Microcontroller (MCU) with 256KB Flash and 96KB SRAM + + - [MAX32660-EVSYS](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32660-evsys.html) + +--- + +* [**MAX32662**](https://www.analog.com/en/products/max32662.html): Arm Cortex-M4 Processor with FPU-Based Microcontroller (MCU) with 256KB Flash and 80KB SRAM + + - [MAX32662EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/MAX32662EVKIT.html) + +--- + +* [**MAX32665-MAX32666 Family**](https://www.analog.com/en/products/max32665.html): Low-Power Arm Cortex-M4 with FPU-Based Microcontroller with Bluetooth 5 for Wearables + + - [MAX32666EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32666evkit.html) + + - [MAX32666FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32666fthr.html) + + - MAX32666FTHR2 (Product Page Not Yet Available) + +--- + +* [**MAX32670**](https://www.analog.com/en/products/max32670.html): High-Reliability, Ultra-Low-Power Microcontroller Powered by Arm Cortex-M4 Processor with FPU for Industrial and IoT + + - [MAX32670EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32670evkit.html) + +--- + +* [**MAX32672**](https://www.analog.com/en/products/max32672.html): High-Reliability, Tiny, Ultra-Low-Power Arm Cortex-M4F Microcontroller with 12-Bit 1MSPS ADC + + - [MAX32672EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32672evkit.html) + +--- + +* [**MAX32675**](https://www.analog.com/en/products/max32675.html): Ultra-Low-Power Arm Cortex-M4F with Precision Analog Front-End for Industrial and Medical Sensors + + - [MAX32675EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32675evkit.html) + + - MAX32675FTHR (Product Page Not Yet Available) + +--- + +* [**MAX32680**](https://www.analog.com/en/products/max32680.html): Ultra-Low-Power Arm Cortex-M4F with Precision Analog Front-End and Bluetooth LE 5.2 + + - [MAX32680EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32680evkit.html) + +--- + +* [**MAX32690**](https://www.analog.com/en/products/max32690.html): Arm Cortex-M4 with FPU Microcontroller and Bluetooth LE 5 for Industrial and Wearables + + - [MAX32690EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/MAX32690EVKIT.html) + - [AD-APARD32690-SL](https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/ad-apard32690-sl.html) + +--- + +* [**MAX78000**](https://www.analog.com/en/products/max78000.html): Artificial Intelligence Microcontroller with Ultra-Low-Power Convolutional Neural Network Accelerator + + - [MAX78000EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000evkit.html) + + - [MAX78000FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000fthr.html) + + - [MAXREFDES178](https://www.analog.com/en/design-center/reference-designs/maxrefdes178.html) + +--- + +* [**MAX78002**](https://www.analog.com/en/products/max78002.html): Artificial Intelligence Microcontroller with Low-Power Convolutional Neural Network Accelerator + + - [MAX78002EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78002evkit.html) + +--- + +## Supported Development Environments + +- [Visual Studio Code](https://code.visualstudio.com/) +- [Eclipse IDE](https://www.eclipseide.org/) +- [IAR Embedded Workbench](https://www.iar.com/ewarm) +- [Keil MDK](https://www2.keil.com/mdk5/) +- Command-line Development + + - Supported shells (Windows) + - [MSYS2](https://www.msys2.org/) + + - Supported shells (Ubuntu) + - [Bash](https://tiswww.case.edu/php/chet/bash/bashtop.html) + - [Zsh](https://www.zsh.org/) + + - Supported shells (MacOS) + - [Zsh](https://www.zsh.org/) + +## Supported Languages + +- C +- C++ +- Assembly (Arm and/or RISC-V instruction set depending on the microcontroller) diff --git a/Documentation/ug-visual-studio-code.md b/Documentation/ug-visual-studio-code.md new file mode 100644 index 0000000000..26e8fab4cc --- /dev/null +++ b/Documentation/ug-visual-studio-code.md @@ -0,0 +1,416 @@ +# Visual Studio Code + +Support for [Visual Studio Code](https://code.visualstudio.com/) is maintained for the MSDK and developed on the [VSCode-Maxim](https://github.com/analogdevicesinc/VSCode-Maxim) GitHub repository. + +For setup/quick-start instructions, see ["Getting Started with Visual Studio Code"](#getting-started-with-visual-studio-code) first. This section offers detailed usage info focusing on the typical development cycle. + +## Opening Example Projects + +Visual Studio Code is built around a "working directory" paradigm. The editor is always rooted in a working directory, and the main mechanism for changing that directory is **File -> Open Folder...** + +![File -> Open Folder](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/file_openfolder.JPG) + +As a result, you'll notice that there is no "New Project" mechanism. A "project" in VS Code is simply a folder. It will look inside the opened folder for a `.vscode` _sub_-folder to load project-specific settings from. + +![Example Directory Contents](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/opening_projects_2.jpg) + +_(Note: You may need to enable viewing of hidden items in your file explorer to see the .vscode sub-folder)._ + +To open a project: + +1. Launch Visual Studio Code. + +2. Select **File -> Open Folder...** + + ![File -> Open Folder](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/file_openfolder.JPG) + +3. Navigate to an example project for the target microcontroller in the MSDK's `Examples` folder. + + ![Figure 43](res/Fig43.jpg) + + ???+ warning "**⚠️ Copying Examples**" + It's strongly recommended to copy example projects to an _outside_ folder before modifying them. This keeps the MSDK's "source" copy preserved for reference. Project folders must be copied to a location _without_ any spaces in its filepath. + +4. VS Code will prompt for trust the first time. Select _Trust folder and enable all features_ + + ![Trust Prompt](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/workspaceTrustPrompt.JPG) + +5. The opened project should look something like this. + + ![Figure 16](res/Fig16.jpg) + +6. Verify the **_Board Support Package_** for the project is set correctly. + +## How to Set the BSP (VS Code) + +To set the BSP for an open project: + +1. Set the `"board"` [project configuration](https://github.com/analogdevicesinc/VSCode-Maxim/tree/main#project-configuration) option in `.vscode/settings.json`, which maps to the `BOARD` _[Build Configuration Variable](#build-tables)_. + + See [Board Support Packages](#board-support-packages) for a table of possible values. + + ![Figure 17](res/Fig17.jpg) + +2. **Reload the VS Code window** to re-index its Intellisense engine. + + VS Code can be conveniently reloaded with the **Reload Window** developer command accessed with **`CTRL + SHIFT + P`** (or **`COMMAND + SHIFT + P`** on MacOS). + + ![Reload window](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/reload_window.JPG) + +## Build Tasks + +Once a project is opened 4 available build tasks will become available via `Terminal > Run Build task...` or the shortcut `Ctrl+Shift+B`. These tasks are configured by the `.vscode/task.json` file. + +![Build Tasks Image](https://raw.githubusercontent.com/analogdevicesinc/VSCode-Maxim/main/img/buildtasks.JPG) + +### Build + +* Compiles the code with a `make all` command. +* Additional options are passed into Make on the command-line based on the project's settings.json file. +* The `./build` directory will be created and will contain the output binary, as well as all intermediary object files. +* Notice the **`TARGET`**, **`BOARD`** , and **`PROJECT`** Build Configuration Variables being set on the command line, and the program binary successfully compiled into the `.elf` program binary in the **build** sub-folder of the project. + + ![Figure 18](res/Fig18.jpg) + +### Clean + +* Cleans the build output, removing the `./build` directory and all of its contents. + +### Clean-Periph + +* This task is the same as 'clean', but it also removes the build output for the MSDK's peripheral drivers. +* Use this if you would like to recompile the peripheral drivers from source on the next build. + +### Flash + +* Launching this task automatically runs the `Build` task first. Then, it flashes the output binary to the microcontroller. +* It uses the GDB `load` and `compare-sections` commands, and handles launching an OpenOCD internally via a pipe connection. +* The flashed program will be halted until the microcontroller is reset, power cycled, or a debugger is connected. +* A debugger must be connected correctly to use this task. Refer to the datasheet of your microcontroller's evaluation board for instructions. + +### Flash & Run + +* This is the same as the `Flash` task, but it also will launch execution of the program once flashing is complete. + +### Erase Flash + +* Completely erases all of the application code in the flash memory bank. +* Once complete, the target microcontroller will be effectively "blank". +* This can be useful for recovering from Low-Power (LP) lockouts, bad firmware, etc. + +## Flashing and Debugging + +This section assumes a debugger is connected between the host PC and the evaluation platform. For more detailed instructions on this hardware setup, refer to the evaluation platform's Datasheet and Quick-Start Guide, which are available on its [analog.com](https://analog.com) product page. + +### Arm Core Debugging + +1. Run the **`flash`** [build task](#build-tasks). Running this task will automatically build the project if needed, flash the program binary, and halt the program execution to await a debugger connection. + + **Flashing does not happen automatically when launching the debugger**. This is an intentional design choice for VS Code to allow the debugger to quickly restart the program under debug without a lengthy re-flash procedure. + + ![Figure 19](res/Fig19.jpg) + +2. Open the **Run and Debug** window (**`CTRL+SHIFT+D`**) and select the `Debug Arm (Cortex-debug)` profile. + + ![Figure 20](res/Fig20.jpg) + + ![Figure 46](res/Fig46.jpg) + +3. Verify the program counter enters `main` successfully. + + ![Figure 21](res/Fig21.jpg) + +4. Press **Continue** (**`F5`**) to run the program. The debugger control bar can be used to exercise the debugger further. + + ![Debugger Control Bar Image](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/debugger_bar.JPG) + + Continue | Step Over | Step Into | Step Out | Restart | Stop + +### Breakpoints + +Breakpoints can be set by clicking next to a line number in VS Code's editor. They are removed by clicking on them again. + +![Figure 35](res/Fig35.jpg) + +Additionally _conditional_ breakpoints can be added by _right-clicking_ on a line. + +![Figure 36](res/Fig36.jpg) + +The condition and condition type can be modified with the dropdown. This is useful for setting a breakpoint on a certain value in a `for` loop iterator or when a specific bit in a register is set, for example. + +![Figure 37](res/Fig37.jpg) + +### Peripheral Browsing + +A peripheral browser lets you quickly view the formatted register-level contents of the peripheral blocks on a target microcontroller under debug. + +As of the [v1.6.0](https://github.com/analogdevicesinc/VSCode-Maxim/releases/tag/v1.6.0) VSCode-Maxim project files, pre-made [Cortex-Debug](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug) launch profiles are included in each project. These profiles enable peripheral browsing via an embedded "Cortex Peripherals"window. + +![Figure 47](res/Fig47.jpg) + +Alternatively, *watch expressions* can be used. These can be set for registers and variables. (For example, the `sysctrl` register below). + +![image](https://user-images.githubusercontent.com/38844790/177819247-ccf90782-e1e6-44f2-8605-c39fc15c09a6.png) + +- Adding **`,b`** lets you print out the value in **binary** +- Adding **`,x`** prints the value in **hex**. +- Standard **logical** and **bitwise** operations are supported inside the watch expression. +- **Register** and **variable** values can be **modified** through these same watch-points. _(Right click -> Set Value)_ + +It should be noted that the debugger's watch points are *contextual*, meaning that its symbol look-ups will depend on the active point in your program. + +### Disassembly View + +Stepping through disassembly is supported and enabled by the [Cortex-Debug](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug) launch profile. + +![Figure 48](res/Fig48.jpg) + +To open the disassembly view: + +1. [Launch a debug session](#arm-core-debugging) with the `Debug Arm (Cortex-Debug)` profile. + +2. Open the developer command prompt with `CTRL + SHIFT + P`. + +3. Run the "Open Disassembly View" developer command. + + ![Figure 49](res/Fig49.jpg) + + Alternatively, right click -> "Open Disassembly View" + + ![Figure 50](res/Fig50.jpg) + +4. The debugger will step through whichever window has the active focus. Set the focus to the disassembly window to step through the assembly code. + +See the [Cortex-Debug Wiki](https://github.com/Marus/cortex-debug/wiki/Disassembly-Debugging) for more details. + +### Dual Core Debugging + +For microcontrollers with _both_ an Arm M4 and a RISC-V core, the _GDB (RISC-V)_ launch profile is provided to enable RISC-V debugging. + +???+ 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. + +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: + + ![Debugger-EvKIT Connections](https://user-images.githubusercontent.com/38844790/190749647-f4ef066a-afcc-4749-bb9c-53c7e33e2cf9.jpg) + + ???+ warning "**⚠️ Olimex Drivers**" + If connection issues occur with the Olimex adapter, verify that the drivers are installed correctly. See Section 3.3.3 of the [Olimex User Manual](https://www.olimex.com/Products/ARM/JTAG/_resources/ARM-USB-OCD_and_OCD_H_manual.pdf). The [Zadig](https://zadig.akeo.ie/) tool to install WinUSB drivers. + +2. [Open](#opening-example-projects) the project in VS Code. + +3. Run the "Flash" task. + + ![image](https://user-images.githubusercontent.com/38844790/168398354-2ac2961b-6d45-4f84-8805-0ab5339a4b98.png) + +4. Launch the debugger using the **Debug Arm (Cortex-Debug)** or **GDB (Arm M4)** profile **first**: + + ![Figure 46](res/Fig46.jpg) + + ... which should hit the breakpoint in `main.c`... + ![image](https://user-images.githubusercontent.com/38844790/168398503-0f2ae9c1-f535-4d41-aed9-9d9e19b16303.png) + +5. **Continue** the debugger. The code in `main.c` will boot up the RISC-V core. You can optionally set a breakpoint on `WakeISR` to see when the RISC-V core has signaled it's ready. + + ![image](https://user-images.githubusercontent.com/38844790/168398665-9486e1b6-73bd-481e-a4b5-15dd44c7d7b9.png) + +6. Now, switch the debugger profile to the **GDB (RISC-V) profile** and launch it. This will launch an additional instance on a separate port and connect to the Olimex adapter. + + ![image](https://user-images.githubusercontent.com/38844790/168398707-b6771bf3-b6bf-47a2-b963-b0b9fc003ca4.png) + + ???+ note "ℹ️ **Note: Signal 0 Exception**" + The "Signal 0" exception below is a known issue caused by a signaling mismatch between the RISC-V core and VS Code's debugger engine. The exception message is harmless and can be safely ignored. + + ![image](https://user-images.githubusercontent.com/38844790/168399130-95fe7539-fb46-4c06-a268-6b720403b539.png) + +7. From here, the debugger should be fully functional. The Arm vs. RISC-V debugger instance can be selected with the dropdown on the debugger control bar. + + ![image](https://user-images.githubusercontent.com/38844790/168399419-d0488a0e-2068-4cc7-9108-0a296fdc04b4.png) + +## Project Settings + +`.vscode/settings.json` is the main project configuration file. Values set here are parsed into the other .json config files. + +**When a change is made to this file, VS Code should be reloaded with CTRL+SHIFT+P -> Reload Window (or alternatively restarted completely) to force a re-parse.** + +![Reload Window](https://raw.githubusercontent.com/analogdevicesinc/VSCode-Maxim/main/img/reload_window.JPG) + +The default project configuration should work for most use cases as long as [`"target"`](#target) and [`"board"`](#board) are set correctly. + +???+ note "ℹ️ **Note**" + Any field from `settings.json` can be referenced from any other VS Code config file (including itself) with `"${config:[fieldname]}"` + +The following configuration options are available: + +### `"MAXIM_PATH"` + +* This option must point to the root installation directory of the MSDK. +* It should be placed in the _global_ user settings.json file during first-time VSCode-Maxim setup. See [Getting Started with Visual Studio Code](#getting-started-with-visual-studio-code). + +### `"target"` + +* This sets the target microcontroller for the project. +* It sets the `TARGET` [Build Configuration](#build-configuration-variables) variable. + +### `"board"` + +* This sets the target board for the project (ie. Evaluation Kit, Feather board, etc.) +* See [How to Set the BSP (VS Code)](#how-to-set-the-bsp-vs-code) + +### `"terminal.integrated.env.[platform]:Path"` + +* This prepends the location of the MSDK toolchain binaries to the system `Path` used by VSCode's integrated terminal. +* The Path is not sanitized by default, which means that the terminal inherits the system path. + +### `"project_name"` + +* Sets the name of project. This is used in other config options such as `program_file`. +* Default value: `"${workspaceFolderBasename}"` + +### `"program_file"` + +* Sets the name of the file to flash and debug. This is provided in case it's needed, but for most use cases should be left at its default. +* File extension must be included. +* Default value: `"${config:project_name}.elf"` + +### `"symbol_file"` + +* Sets the name of the file that GDB will load debug symbols from. +* File extension must be included. +* Default value: `"${config:program_file}"` + +### `"M4_OCD_interface_file"` + +* Sets the OpenOCD interface file to use to connect to the Arm M4 core. This should match the debugger being used for the M4 core. +* The `MaximSDK/Tools/OpenOCD/scripts/interface` folder is searched for the file specified by this setting. +* `.cfg` file extension must be included. +* Default value: `"cmsis-dap.cfg"` + +### `"M4_OCD_target_file"` + +* Sets the OpenOCD target file to use for the Arm M4 core. This should match the target microcontroller. +* `.cfg` file extension must be included. +* The `MaximSDK/Tools/OpenOCD/scripts/target` folder is searched for the file specified by this setting. +* Default value: `"${config:target}.cfg"` + +### `"RV_OCD_interface_file"` + +* Sets the OpenOCD interface file to use to connect to the RISC-V core. This should match the debugger being used for the RISC-V core. +* The `MaximSDK/Tools/OpenOCD/scripts/interface` folder is searched for the file specified by this setting. +* `.cfg` file extension must be included. +* Default value: `"ftdi/olimex-arm-usb-ocd-h.cfg"` + +### `"RV_OCD_target_file"` + +* Sets the OpenOCD target file to use for the RISC-V core. +* The `MaximSDK/Tools/OpenOCD/scripts/target` folder is searched for the file specified by this setting. +* `.cfg` file extension must be included. +* Default value: `"${config:target}_riscv.cfg"` + +### `"v_Arm_GCC"` + +* Sets the version of the Arm Embedded GCC to use, including toolchain binaries and the standard library version. +* This gets parsed into `ARM_GCC_path`. +* Default value: `"10.3"` + +### `"v_xPack_GCC"` + +* Sets the version of the xPack RISC-V GCC to use. +* This gets parsed into `xPack_GCC_path`. +* Default value: `"12.2.0-3.1"` + +### `"OCD_path"` + +* Where to find the OpenOCD. +* Default value: `"${config:MAXIM_PATH}/Tools/OpenOCD"` + +### `"ARM_GCC_path"` + +* Where to find the Arm Embedded GCC Toolchain. +* Default value: `"${config:MAXIM_PATH}/Tools/GNUTools/${config:v_Arm_GCC}"` + +### `"xPack_GCC_path"` + +* Where to find the RISC-V GCC Toolchain. +* Default value: `"${config:MAXIM_PATH}/Tools/xPack/riscv-none-elf-gcc/${config:v_xPack_GCC}"` + +### `"Make_path"` + +* Where to find Make binaries (only used on Windows) +* Default value: `"${config:MAXIM_PATH}/Tools/MSYS2/usr/bin"` + +### `"C_Cpp.default.includePath"` + +* Which paths to search to find header (.h) files. +* Does not recursively search by default. To recursively search, use `/**`. + +### `"C_Cpp.default.browse.path"` + +* Which paths to search to find source (.c) files. +* Does not recursively search by default. To recursively search, use `/**`. + +### `"C_Cpp.default.defines"` + +* Sets the compiler definitions to use for the intellisense engine. +* Most definitions should be defined in header files, but if a definition is missing it can be entered here to get the intellisense engine to recognize it. + +## Setting Search Paths for Intellisense + +VS Code's intellisense engine must be told where to find the header files for your source code. By default, the MSDK's peripheral drivers, the C standard libraries, and all of the sub-directories of the workspace will be searched for header files to use with Intellisense. If VS Code throws an error on an `#include` statement (and the file exists), then a search path is most likely missing. + +To add additional search paths : + +1. Open the `.vscode/settings.json` file. + +2. Add the include path(s) to the `C_Cpp.default.includePath` list. The paths set here should contain header files, and will be searched by the Intellisense engine and when using "Go to Declaration" in the editor. + +3. Add the path(s) to any relevant implementation files to the `C_Cpp.default.browse.path` list. This list contains the paths that will be searched when using "Go to Definition". + +## Project Creation + +### Option 1. Copying a Pre-Made Project + +Copying a pre-made example project is a great way to get rolling quickly, and is currently the recommended method for creating new projects. + +The release package for this project (Located at `Tools/VSCode-Maxim` in the MSDK) contains a `New_Project` folder designed for such purposes. Additionally, any of the VS Code-enabled Example projects can be copied from the MSDK. + +1. Copy the existing project folder to an accessible location. This will be the location of your new project. + + ???+ warning "**⚠️ Warning**" + The full path to the project must _not_ have any spaces in it. + +2. (Optional) Rename the folder. For example, I might rename the folder to `MyProject`. + +3. Open the project in VS Code (`File -> Open Folder...`) + +4. Set your [target](#target) microcontroller and [board](#board) correctly. + +5. `CTRL+SHIFT+P -> Reload Window` to re-parse the project settings. + +6. That's it! The existing project is ready to build, debug, and modify. + +### Option 2 - Injecting + +VSCode-Maxim releases provide the `Inject` folder for "injecting" into an existing folder. If you want to start from scratch or use the project files with existing source code, take this option. + +1. Create your project folder if necessary. For example, I might create a new project in a workspace folder with the path: `C:/Users/Jake.Carter/workspace/MyNewProject`. + +2. Copy the **contents** of the `Inject` folder into the project folder from step 1. The contents to copy include a `.vscode` folder, a `Makefile`, and a `project.mk` file. For this example, the contents of the 'MyProject' folder would be the following: + + :::shell + C:/Users/Jake.Carter/workspace/MyNewProject + |- .vscode + |- Makefile + |- project.mk + +3. Open the project in VS Code (`File -> Open Folder...`) + +4. Set your [target](#target) microcontroller and [board](#board) correctly. + +5. `CTRL+SHIFT+P -> Reload Window` to re-parse the project settings. + +6. Configure the [build system](#build-system) for use with any pre-existing source code. + +7. That's it! Your new project can now be opened with `File > Open Folder` from within VS Code. From 5a0717cd367edb83fb357d7a4026c11a34021bc5 Mon Sep 17 00:00:00 2001 From: "Kernion, Juliette" Date: Wed, 2 Oct 2024 17:28:18 -0700 Subject: [PATCH 03/18] Incorporated Glen's suggestions re file locations / naming, updated main doc index page --- Documentation/index.md | 6 +++--- .../board-support-pkgs.md} | 0 .../build-system.md} | 0 .../command-line-dev.md} | 0 .../{ug-debuggers.md => user-guide/debuggers.md} | 0 .../developer-notes.md} | 0 .../{ug-eclipse.md => user-guide/eclipse.md} | 0 .../{ug-examples.md => user-guide/examples.md} | 0 .../getting-started.md} | 0 .../iar-embed-wkbench.md} | 0 .../{ug-overview.md => user-guide/index.md} | 0 .../installation.md} | 0 .../{ug-keil-mdk.md => user-guide/keil-mdk.md} | 0 .../{ug-libraries.md => user-guide/libraries.md} | 0 {res => Documentation/user-guide/res}/DAPLINK.jpg | Bin .../user-guide/res}/DAPLINK_opened.jpg | Bin .../user-guide/res}/DETAILS_Git_SHA.jpg | Bin .../user-guide/res}/DETAILS_automation_allowed.jpg | Bin {res => Documentation/user-guide/res}/Fig1.jpg | Bin {res => Documentation/user-guide/res}/Fig10.jpg | Bin {res => Documentation/user-guide/res}/Fig11.jpg | Bin {res => Documentation/user-guide/res}/Fig16.jpg | Bin {res => Documentation/user-guide/res}/Fig17.jpg | Bin {res => Documentation/user-guide/res}/Fig18.jpg | Bin {res => Documentation/user-guide/res}/Fig19.jpg | Bin {res => Documentation/user-guide/res}/Fig2.jpg | Bin {res => Documentation/user-guide/res}/Fig20.jpg | Bin {res => Documentation/user-guide/res}/Fig21.jpg | Bin {res => Documentation/user-guide/res}/Fig22.jpg | Bin {res => Documentation/user-guide/res}/Fig23.jpg | Bin {res => Documentation/user-guide/res}/Fig24.jpg | Bin {res => Documentation/user-guide/res}/Fig25.jpg | Bin {res => Documentation/user-guide/res}/Fig26.jpg | Bin {res => Documentation/user-guide/res}/Fig27.jpg | Bin {res => Documentation/user-guide/res}/Fig28.jpg | Bin {res => Documentation/user-guide/res}/Fig29.jpg | Bin {res => Documentation/user-guide/res}/Fig3.jpg | Bin {res => Documentation/user-guide/res}/Fig30.jpg | Bin {res => Documentation/user-guide/res}/Fig31.jpg | Bin {res => Documentation/user-guide/res}/Fig32.jpg | Bin {res => Documentation/user-guide/res}/Fig33.jpg | Bin {res => Documentation/user-guide/res}/Fig34.jpg | Bin {res => Documentation/user-guide/res}/Fig35.jpg | Bin {res => Documentation/user-guide/res}/Fig36.jpg | Bin {res => Documentation/user-guide/res}/Fig37.jpg | Bin {res => Documentation/user-guide/res}/Fig38.jpg | Bin {res => Documentation/user-guide/res}/Fig39.jpg | Bin {res => Documentation/user-guide/res}/Fig4.jpg | Bin {res => Documentation/user-guide/res}/Fig40.jpg | Bin {res => Documentation/user-guide/res}/Fig41.jpg | Bin {res => Documentation/user-guide/res}/Fig42.jpg | Bin {res => Documentation/user-guide/res}/Fig43.jpg | Bin {res => Documentation/user-guide/res}/Fig44.jpg | Bin {res => Documentation/user-guide/res}/Fig45.jpg | Bin {res => Documentation/user-guide/res}/Fig46.jpg | Bin {res => Documentation/user-guide/res}/Fig47.jpg | Bin {res => Documentation/user-guide/res}/Fig48.jpg | Bin {res => Documentation/user-guide/res}/Fig49.jpg | Bin {res => Documentation/user-guide/res}/Fig5.jpg | Bin {res => Documentation/user-guide/res}/Fig50.jpg | Bin {res => Documentation/user-guide/res}/Fig51.jpg | Bin {res => Documentation/user-guide/res}/Fig6.jpg | Bin {res => Documentation/user-guide/res}/Fig7.jpg | Bin {res => Documentation/user-guide/res}/Fig8.jpg | Bin {res => Documentation/user-guide/res}/Fig9.jpg | Bin .../user-guide/res}/MAINTENANCE.jpg | Bin .../user-guide/res}/auto_on.cfg.jpg | Bin .../user-guide/res}/drag_and_drop.JPG | Bin .../user-guide/res}/eclipse_start.jpg | Bin {res => Documentation/user-guide/res}/erase.act.jpg | Bin .../user-guide/res}/pico_connected.jpg | Bin .../user-guide/res}/pico_flashing.JPG | Bin .../user-guide/res}/pico_partial_connected.jpg | Bin .../user-guide/res}/pico_pushbutton.jpg | Bin .../user-guide/res}/symlinks-windows.jpg | Bin .../visual-studio-code.md} | 0 76 files changed, 3 insertions(+), 3 deletions(-) rename Documentation/{ug-board-support-pkgs.md => user-guide/board-support-pkgs.md} (100%) rename Documentation/{ug-build-system.md => user-guide/build-system.md} (100%) rename Documentation/{ug-command-line-dev.md => user-guide/command-line-dev.md} (100%) rename Documentation/{ug-debuggers.md => user-guide/debuggers.md} (100%) rename Documentation/{ug-developer-notes.md => user-guide/developer-notes.md} (100%) rename Documentation/{ug-eclipse.md => user-guide/eclipse.md} (100%) rename Documentation/{ug-examples.md => user-guide/examples.md} (100%) rename Documentation/{ug-getting-started.md => user-guide/getting-started.md} (100%) rename Documentation/{ug-iar-embed-wkbench.md => user-guide/iar-embed-wkbench.md} (100%) rename Documentation/{ug-overview.md => user-guide/index.md} (100%) rename Documentation/{ug-installation.md => user-guide/installation.md} (100%) rename Documentation/{ug-keil-mdk.md => user-guide/keil-mdk.md} (100%) rename Documentation/{ug-libraries.md => user-guide/libraries.md} (100%) rename {res => Documentation/user-guide/res}/DAPLINK.jpg (100%) rename {res => Documentation/user-guide/res}/DAPLINK_opened.jpg (100%) rename {res => Documentation/user-guide/res}/DETAILS_Git_SHA.jpg (100%) rename {res => Documentation/user-guide/res}/DETAILS_automation_allowed.jpg (100%) rename {res => Documentation/user-guide/res}/Fig1.jpg (100%) rename {res => Documentation/user-guide/res}/Fig10.jpg (100%) rename {res => Documentation/user-guide/res}/Fig11.jpg (100%) rename {res => Documentation/user-guide/res}/Fig16.jpg (100%) rename {res => Documentation/user-guide/res}/Fig17.jpg (100%) rename {res => Documentation/user-guide/res}/Fig18.jpg (100%) rename {res => Documentation/user-guide/res}/Fig19.jpg (100%) rename {res => Documentation/user-guide/res}/Fig2.jpg (100%) rename {res => Documentation/user-guide/res}/Fig20.jpg (100%) rename {res => Documentation/user-guide/res}/Fig21.jpg (100%) rename {res => Documentation/user-guide/res}/Fig22.jpg (100%) rename {res => Documentation/user-guide/res}/Fig23.jpg (100%) rename {res => Documentation/user-guide/res}/Fig24.jpg (100%) rename {res => Documentation/user-guide/res}/Fig25.jpg (100%) rename {res => Documentation/user-guide/res}/Fig26.jpg (100%) rename {res => Documentation/user-guide/res}/Fig27.jpg (100%) rename {res => Documentation/user-guide/res}/Fig28.jpg (100%) rename {res => Documentation/user-guide/res}/Fig29.jpg (100%) rename {res => Documentation/user-guide/res}/Fig3.jpg (100%) rename {res => Documentation/user-guide/res}/Fig30.jpg (100%) rename {res => Documentation/user-guide/res}/Fig31.jpg (100%) rename {res => Documentation/user-guide/res}/Fig32.jpg (100%) rename {res => Documentation/user-guide/res}/Fig33.jpg (100%) rename {res => Documentation/user-guide/res}/Fig34.jpg (100%) rename {res => Documentation/user-guide/res}/Fig35.jpg (100%) rename {res => Documentation/user-guide/res}/Fig36.jpg (100%) rename {res => Documentation/user-guide/res}/Fig37.jpg (100%) rename {res => Documentation/user-guide/res}/Fig38.jpg (100%) rename {res => Documentation/user-guide/res}/Fig39.jpg (100%) rename {res => Documentation/user-guide/res}/Fig4.jpg (100%) rename {res => Documentation/user-guide/res}/Fig40.jpg (100%) rename {res => Documentation/user-guide/res}/Fig41.jpg (100%) rename {res => Documentation/user-guide/res}/Fig42.jpg (100%) rename {res => Documentation/user-guide/res}/Fig43.jpg (100%) rename {res => Documentation/user-guide/res}/Fig44.jpg (100%) rename {res => Documentation/user-guide/res}/Fig45.jpg (100%) rename {res => Documentation/user-guide/res}/Fig46.jpg (100%) rename {res => Documentation/user-guide/res}/Fig47.jpg (100%) rename {res => Documentation/user-guide/res}/Fig48.jpg (100%) rename {res => Documentation/user-guide/res}/Fig49.jpg (100%) rename {res => Documentation/user-guide/res}/Fig5.jpg (100%) rename {res => Documentation/user-guide/res}/Fig50.jpg (100%) rename {res => Documentation/user-guide/res}/Fig51.jpg (100%) rename {res => Documentation/user-guide/res}/Fig6.jpg (100%) rename {res => Documentation/user-guide/res}/Fig7.jpg (100%) rename {res => Documentation/user-guide/res}/Fig8.jpg (100%) rename {res => Documentation/user-guide/res}/Fig9.jpg (100%) rename {res => Documentation/user-guide/res}/MAINTENANCE.jpg (100%) rename {res => Documentation/user-guide/res}/auto_on.cfg.jpg (100%) rename {res => Documentation/user-guide/res}/drag_and_drop.JPG (100%) rename {res => Documentation/user-guide/res}/eclipse_start.jpg (100%) rename {res => Documentation/user-guide/res}/erase.act.jpg (100%) rename {res => Documentation/user-guide/res}/pico_connected.jpg (100%) rename {res => Documentation/user-guide/res}/pico_flashing.JPG (100%) rename {res => Documentation/user-guide/res}/pico_partial_connected.jpg (100%) rename {res => Documentation/user-guide/res}/pico_pushbutton.jpg (100%) rename {res => Documentation/user-guide/res}/symlinks-windows.jpg (100%) rename Documentation/{ug-visual-studio-code.md => user-guide/visual-studio-code.md} (100%) diff --git a/Documentation/index.md b/Documentation/index.md index 7cc6a522a2..ff387e8eef 100644 --- a/Documentation/index.md +++ b/Documentation/index.md @@ -1,10 +1,10 @@ # Analog Devices MSDK Documentation -Welcome to the MSDK Documentation. +Welcome to the MSDK documentation resources. -The Maxim Microcontrollers SDK (MSDK), now a part of [Analog Devices](https://www.analog.com/en/index.html), contains the necessary software and tools to develop firmware for the [MAX32xxx and MAX78xxx Microcontrollers](https://www.analog.com/en/parametricsearch/10984). +The MAX Microcontrollers SDK (MSDK), now a part of [Analog Devices](https://www.analog.com/en/index.html), contains the necessary software and tools to develop firmware for the [MAX32xxx and MAX78xxx Microcontrollers](https://www.analog.com/en/parametricsearch/10984). -To **get started** see the [**User Guide**](USERGUIDE.md). +To **get started**, see the [**User Guide**](user-guide/index.md). For **development resources**: diff --git a/Documentation/ug-board-support-pkgs.md b/Documentation/user-guide/board-support-pkgs.md similarity index 100% rename from Documentation/ug-board-support-pkgs.md rename to Documentation/user-guide/board-support-pkgs.md diff --git a/Documentation/ug-build-system.md b/Documentation/user-guide/build-system.md similarity index 100% rename from Documentation/ug-build-system.md rename to Documentation/user-guide/build-system.md diff --git a/Documentation/ug-command-line-dev.md b/Documentation/user-guide/command-line-dev.md similarity index 100% rename from Documentation/ug-command-line-dev.md rename to Documentation/user-guide/command-line-dev.md diff --git a/Documentation/ug-debuggers.md b/Documentation/user-guide/debuggers.md similarity index 100% rename from Documentation/ug-debuggers.md rename to Documentation/user-guide/debuggers.md diff --git a/Documentation/ug-developer-notes.md b/Documentation/user-guide/developer-notes.md similarity index 100% rename from Documentation/ug-developer-notes.md rename to Documentation/user-guide/developer-notes.md diff --git a/Documentation/ug-eclipse.md b/Documentation/user-guide/eclipse.md similarity index 100% rename from Documentation/ug-eclipse.md rename to Documentation/user-guide/eclipse.md diff --git a/Documentation/ug-examples.md b/Documentation/user-guide/examples.md similarity index 100% rename from Documentation/ug-examples.md rename to Documentation/user-guide/examples.md diff --git a/Documentation/ug-getting-started.md b/Documentation/user-guide/getting-started.md similarity index 100% rename from Documentation/ug-getting-started.md rename to Documentation/user-guide/getting-started.md diff --git a/Documentation/ug-iar-embed-wkbench.md b/Documentation/user-guide/iar-embed-wkbench.md similarity index 100% rename from Documentation/ug-iar-embed-wkbench.md rename to Documentation/user-guide/iar-embed-wkbench.md diff --git a/Documentation/ug-overview.md b/Documentation/user-guide/index.md similarity index 100% rename from Documentation/ug-overview.md rename to Documentation/user-guide/index.md diff --git a/Documentation/ug-installation.md b/Documentation/user-guide/installation.md similarity index 100% rename from Documentation/ug-installation.md rename to Documentation/user-guide/installation.md diff --git a/Documentation/ug-keil-mdk.md b/Documentation/user-guide/keil-mdk.md similarity index 100% rename from Documentation/ug-keil-mdk.md rename to Documentation/user-guide/keil-mdk.md diff --git a/Documentation/ug-libraries.md b/Documentation/user-guide/libraries.md similarity index 100% rename from Documentation/ug-libraries.md rename to Documentation/user-guide/libraries.md diff --git a/res/DAPLINK.jpg b/Documentation/user-guide/res/DAPLINK.jpg similarity index 100% rename from res/DAPLINK.jpg rename to Documentation/user-guide/res/DAPLINK.jpg diff --git a/res/DAPLINK_opened.jpg b/Documentation/user-guide/res/DAPLINK_opened.jpg similarity index 100% rename from res/DAPLINK_opened.jpg rename to Documentation/user-guide/res/DAPLINK_opened.jpg diff --git a/res/DETAILS_Git_SHA.jpg b/Documentation/user-guide/res/DETAILS_Git_SHA.jpg similarity index 100% rename from res/DETAILS_Git_SHA.jpg rename to Documentation/user-guide/res/DETAILS_Git_SHA.jpg diff --git a/res/DETAILS_automation_allowed.jpg b/Documentation/user-guide/res/DETAILS_automation_allowed.jpg similarity index 100% rename from res/DETAILS_automation_allowed.jpg rename to Documentation/user-guide/res/DETAILS_automation_allowed.jpg diff --git a/res/Fig1.jpg b/Documentation/user-guide/res/Fig1.jpg similarity index 100% rename from res/Fig1.jpg rename to Documentation/user-guide/res/Fig1.jpg diff --git a/res/Fig10.jpg b/Documentation/user-guide/res/Fig10.jpg similarity index 100% rename from res/Fig10.jpg rename to Documentation/user-guide/res/Fig10.jpg diff --git a/res/Fig11.jpg b/Documentation/user-guide/res/Fig11.jpg similarity index 100% rename from res/Fig11.jpg rename to Documentation/user-guide/res/Fig11.jpg diff --git a/res/Fig16.jpg b/Documentation/user-guide/res/Fig16.jpg similarity index 100% rename from res/Fig16.jpg rename to Documentation/user-guide/res/Fig16.jpg diff --git a/res/Fig17.jpg b/Documentation/user-guide/res/Fig17.jpg similarity index 100% rename from res/Fig17.jpg rename to Documentation/user-guide/res/Fig17.jpg diff --git a/res/Fig18.jpg b/Documentation/user-guide/res/Fig18.jpg similarity index 100% rename from res/Fig18.jpg rename to Documentation/user-guide/res/Fig18.jpg diff --git a/res/Fig19.jpg b/Documentation/user-guide/res/Fig19.jpg similarity index 100% rename from res/Fig19.jpg rename to Documentation/user-guide/res/Fig19.jpg diff --git a/res/Fig2.jpg b/Documentation/user-guide/res/Fig2.jpg similarity index 100% rename from res/Fig2.jpg rename to Documentation/user-guide/res/Fig2.jpg diff --git a/res/Fig20.jpg b/Documentation/user-guide/res/Fig20.jpg similarity index 100% rename from res/Fig20.jpg rename to Documentation/user-guide/res/Fig20.jpg diff --git a/res/Fig21.jpg b/Documentation/user-guide/res/Fig21.jpg similarity index 100% rename from res/Fig21.jpg rename to Documentation/user-guide/res/Fig21.jpg diff --git a/res/Fig22.jpg b/Documentation/user-guide/res/Fig22.jpg similarity index 100% rename from res/Fig22.jpg rename to Documentation/user-guide/res/Fig22.jpg diff --git a/res/Fig23.jpg b/Documentation/user-guide/res/Fig23.jpg similarity index 100% rename from res/Fig23.jpg rename to Documentation/user-guide/res/Fig23.jpg diff --git a/res/Fig24.jpg b/Documentation/user-guide/res/Fig24.jpg similarity index 100% rename from res/Fig24.jpg rename to Documentation/user-guide/res/Fig24.jpg diff --git a/res/Fig25.jpg b/Documentation/user-guide/res/Fig25.jpg similarity index 100% rename from res/Fig25.jpg rename to Documentation/user-guide/res/Fig25.jpg diff --git a/res/Fig26.jpg b/Documentation/user-guide/res/Fig26.jpg similarity index 100% rename from res/Fig26.jpg rename to Documentation/user-guide/res/Fig26.jpg diff --git a/res/Fig27.jpg b/Documentation/user-guide/res/Fig27.jpg similarity index 100% rename from res/Fig27.jpg rename to Documentation/user-guide/res/Fig27.jpg diff --git a/res/Fig28.jpg b/Documentation/user-guide/res/Fig28.jpg similarity index 100% rename from res/Fig28.jpg rename to Documentation/user-guide/res/Fig28.jpg diff --git a/res/Fig29.jpg b/Documentation/user-guide/res/Fig29.jpg similarity index 100% rename from res/Fig29.jpg rename to Documentation/user-guide/res/Fig29.jpg diff --git a/res/Fig3.jpg b/Documentation/user-guide/res/Fig3.jpg similarity index 100% rename from res/Fig3.jpg rename to Documentation/user-guide/res/Fig3.jpg diff --git a/res/Fig30.jpg b/Documentation/user-guide/res/Fig30.jpg similarity index 100% rename from res/Fig30.jpg rename to Documentation/user-guide/res/Fig30.jpg diff --git a/res/Fig31.jpg b/Documentation/user-guide/res/Fig31.jpg similarity index 100% rename from res/Fig31.jpg rename to Documentation/user-guide/res/Fig31.jpg diff --git a/res/Fig32.jpg b/Documentation/user-guide/res/Fig32.jpg similarity index 100% rename from res/Fig32.jpg rename to Documentation/user-guide/res/Fig32.jpg diff --git a/res/Fig33.jpg b/Documentation/user-guide/res/Fig33.jpg similarity index 100% rename from res/Fig33.jpg rename to Documentation/user-guide/res/Fig33.jpg diff --git a/res/Fig34.jpg b/Documentation/user-guide/res/Fig34.jpg similarity index 100% rename from res/Fig34.jpg rename to Documentation/user-guide/res/Fig34.jpg diff --git a/res/Fig35.jpg b/Documentation/user-guide/res/Fig35.jpg similarity index 100% rename from res/Fig35.jpg rename to Documentation/user-guide/res/Fig35.jpg diff --git a/res/Fig36.jpg b/Documentation/user-guide/res/Fig36.jpg similarity index 100% rename from res/Fig36.jpg rename to Documentation/user-guide/res/Fig36.jpg diff --git a/res/Fig37.jpg b/Documentation/user-guide/res/Fig37.jpg similarity index 100% rename from res/Fig37.jpg rename to Documentation/user-guide/res/Fig37.jpg diff --git a/res/Fig38.jpg b/Documentation/user-guide/res/Fig38.jpg similarity index 100% rename from res/Fig38.jpg rename to Documentation/user-guide/res/Fig38.jpg diff --git a/res/Fig39.jpg b/Documentation/user-guide/res/Fig39.jpg similarity index 100% rename from res/Fig39.jpg rename to Documentation/user-guide/res/Fig39.jpg diff --git a/res/Fig4.jpg b/Documentation/user-guide/res/Fig4.jpg similarity index 100% rename from res/Fig4.jpg rename to Documentation/user-guide/res/Fig4.jpg diff --git a/res/Fig40.jpg b/Documentation/user-guide/res/Fig40.jpg similarity index 100% rename from res/Fig40.jpg rename to Documentation/user-guide/res/Fig40.jpg diff --git a/res/Fig41.jpg b/Documentation/user-guide/res/Fig41.jpg similarity index 100% rename from res/Fig41.jpg rename to Documentation/user-guide/res/Fig41.jpg diff --git a/res/Fig42.jpg b/Documentation/user-guide/res/Fig42.jpg similarity index 100% rename from res/Fig42.jpg rename to Documentation/user-guide/res/Fig42.jpg diff --git a/res/Fig43.jpg b/Documentation/user-guide/res/Fig43.jpg similarity index 100% rename from res/Fig43.jpg rename to Documentation/user-guide/res/Fig43.jpg diff --git a/res/Fig44.jpg b/Documentation/user-guide/res/Fig44.jpg similarity index 100% rename from res/Fig44.jpg rename to Documentation/user-guide/res/Fig44.jpg diff --git a/res/Fig45.jpg b/Documentation/user-guide/res/Fig45.jpg similarity index 100% rename from res/Fig45.jpg rename to Documentation/user-guide/res/Fig45.jpg diff --git a/res/Fig46.jpg b/Documentation/user-guide/res/Fig46.jpg similarity index 100% rename from res/Fig46.jpg rename to Documentation/user-guide/res/Fig46.jpg diff --git a/res/Fig47.jpg b/Documentation/user-guide/res/Fig47.jpg similarity index 100% rename from res/Fig47.jpg rename to Documentation/user-guide/res/Fig47.jpg diff --git a/res/Fig48.jpg b/Documentation/user-guide/res/Fig48.jpg similarity index 100% rename from res/Fig48.jpg rename to Documentation/user-guide/res/Fig48.jpg diff --git a/res/Fig49.jpg b/Documentation/user-guide/res/Fig49.jpg similarity index 100% rename from res/Fig49.jpg rename to Documentation/user-guide/res/Fig49.jpg diff --git a/res/Fig5.jpg b/Documentation/user-guide/res/Fig5.jpg similarity index 100% rename from res/Fig5.jpg rename to Documentation/user-guide/res/Fig5.jpg diff --git a/res/Fig50.jpg b/Documentation/user-guide/res/Fig50.jpg similarity index 100% rename from res/Fig50.jpg rename to Documentation/user-guide/res/Fig50.jpg diff --git a/res/Fig51.jpg b/Documentation/user-guide/res/Fig51.jpg similarity index 100% rename from res/Fig51.jpg rename to Documentation/user-guide/res/Fig51.jpg diff --git a/res/Fig6.jpg b/Documentation/user-guide/res/Fig6.jpg similarity index 100% rename from res/Fig6.jpg rename to Documentation/user-guide/res/Fig6.jpg diff --git a/res/Fig7.jpg b/Documentation/user-guide/res/Fig7.jpg similarity index 100% rename from res/Fig7.jpg rename to Documentation/user-guide/res/Fig7.jpg diff --git a/res/Fig8.jpg b/Documentation/user-guide/res/Fig8.jpg similarity index 100% rename from res/Fig8.jpg rename to Documentation/user-guide/res/Fig8.jpg diff --git a/res/Fig9.jpg b/Documentation/user-guide/res/Fig9.jpg similarity index 100% rename from res/Fig9.jpg rename to Documentation/user-guide/res/Fig9.jpg diff --git a/res/MAINTENANCE.jpg b/Documentation/user-guide/res/MAINTENANCE.jpg similarity index 100% rename from res/MAINTENANCE.jpg rename to Documentation/user-guide/res/MAINTENANCE.jpg diff --git a/res/auto_on.cfg.jpg b/Documentation/user-guide/res/auto_on.cfg.jpg similarity index 100% rename from res/auto_on.cfg.jpg rename to Documentation/user-guide/res/auto_on.cfg.jpg diff --git a/res/drag_and_drop.JPG b/Documentation/user-guide/res/drag_and_drop.JPG similarity index 100% rename from res/drag_and_drop.JPG rename to Documentation/user-guide/res/drag_and_drop.JPG diff --git a/res/eclipse_start.jpg b/Documentation/user-guide/res/eclipse_start.jpg similarity index 100% rename from res/eclipse_start.jpg rename to Documentation/user-guide/res/eclipse_start.jpg diff --git a/res/erase.act.jpg b/Documentation/user-guide/res/erase.act.jpg similarity index 100% rename from res/erase.act.jpg rename to Documentation/user-guide/res/erase.act.jpg diff --git a/res/pico_connected.jpg b/Documentation/user-guide/res/pico_connected.jpg similarity index 100% rename from res/pico_connected.jpg rename to Documentation/user-guide/res/pico_connected.jpg diff --git a/res/pico_flashing.JPG b/Documentation/user-guide/res/pico_flashing.JPG similarity index 100% rename from res/pico_flashing.JPG rename to Documentation/user-guide/res/pico_flashing.JPG diff --git a/res/pico_partial_connected.jpg b/Documentation/user-guide/res/pico_partial_connected.jpg similarity index 100% rename from res/pico_partial_connected.jpg rename to Documentation/user-guide/res/pico_partial_connected.jpg diff --git a/res/pico_pushbutton.jpg b/Documentation/user-guide/res/pico_pushbutton.jpg similarity index 100% rename from res/pico_pushbutton.jpg rename to Documentation/user-guide/res/pico_pushbutton.jpg diff --git a/res/symlinks-windows.jpg b/Documentation/user-guide/res/symlinks-windows.jpg similarity index 100% rename from res/symlinks-windows.jpg rename to Documentation/user-guide/res/symlinks-windows.jpg diff --git a/Documentation/ug-visual-studio-code.md b/Documentation/user-guide/visual-studio-code.md similarity index 100% rename from Documentation/ug-visual-studio-code.md rename to Documentation/user-guide/visual-studio-code.md From 4d7180d99762028ea5053267c2579161086fd697 Mon Sep 17 00:00:00 2001 From: "Anderson, Glen" Date: Mon, 7 Oct 2024 12:32:24 -0400 Subject: [PATCH 04/18] Add markdownlint for doc linting --- .markdownlint.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .markdownlint.yml diff --git a/.markdownlint.yml b/.markdownlint.yml new file mode 100644 index 0000000000..769b132f36 --- /dev/null +++ b/.markdownlint.yml @@ -0,0 +1,23 @@ +# start with the default markdownlint configuration +default: true + +# ignore line length limitations +line-length: false + +# prefer # style headings +heading-style: + style: atx + +# disable block style checks since they interfere with material admonitions +code-block-style: false + +# default for Python-Markdown is 4 spaces +ul-indent: + indent: 4 + start_indented: false + start_indent: 4 + +# allow img tags to set specific image sizes +no-inline-html: + allowed_elements: + - img From 49054e5db1a12b78293fe398c870e7e1891d6f01 Mon Sep 17 00:00:00 2001 From: "Anderson, Glen" Date: Mon, 7 Oct 2024 14:36:22 -0400 Subject: [PATCH 05/18] Refactored Documentation/build.py for new directory layout --- .gitignore | 2 +- Documentation/build.py | 404 ++- .../{examples.md => examples.md.tpl} | 2 +- Documentation/user-guide/libraries.md | 26 +- USERGUIDE.md | 2577 ----------------- 5 files changed, 207 insertions(+), 2804 deletions(-) rename Documentation/user-guide/{examples.md => examples.md.tpl} (98%) delete mode 100644 USERGUIDE.md diff --git a/.gitignore b/.gitignore index 8885fc7d07..98cb376592 100644 --- a/.gitignore +++ b/.gitignore @@ -8,10 +8,10 @@ Libraries/PeriphDrivers/bin docs/ Documentation/Libraries Documentation/res -Documentation/USERGUIDE.md Documentation/LICENSE.md Documentation/README.md Documentation/Tools/Bluetooth/README.md +Documentation/user-guide/examples.md Examples/MAX78000/PowerTest Examples/MAX32570 Examples/MAX32572 diff --git a/Documentation/build.py b/Documentation/build.py index 7e5c521849..90ee89601b 100644 --- a/Documentation/build.py +++ b/Documentation/build.py @@ -1,245 +1,203 @@ +# Copyright (c) 2024 Analog Devices, Inc. All Rights Reserved +# pylint: disable=C0103,C0114,C0115,C0116,C0301 + +import re +import shutil from dataclasses import dataclass +from operator import attrgetter from pathlib import Path -import shutil from subprocess import run -from mkdocs.commands.build import build -from mkdocs.config import load_config -from os import listdir -import os -import re -from operator import attrgetter # Locate some directories relative to this file here = Path(__file__).parent.absolute() repo = here.parent -periph_docs_dir = repo / "Libraries" / "PeriphDrivers" / "Documentation" -examples_dir = repo / "Examples" -target_blacklist = ["MAX32572"] +target_excludelist = ["MAX32572"] + @dataclass -class ExampleInfo(): +class ExampleInfo: folder: Path name: str description: str details: str -# Given a path to a directory, look for a main.c file and attempt to parse -# information from a @file-tagged Doxygen block (if it exists) -def parse_example_info(f: Path) -> ExampleInfo: - example_folder = f.parent - example_name = f.parent.name - example_description = "Empty Description" + +# Given a path to a main.c file, attempt to parse information from a +# @file-tagged Doxygen block if it exists +def parse_example_info(source_file: Path) -> ExampleInfo: example_details = "No details" - with open(f, "r", encoding="utf-8") as file: - file_content = file.read() - lines = file_content.splitlines() - for i in range(len(lines)): - if "/*" in lines[i]: - comment_block = [ lines[i] ] - while "*/" not in lines[i] and i < len(lines) - 1: - i += 1 - comment_block.append(lines[i]) - if "@file" in "\n".join(comment_block): - for l in comment_block: - if "@brief" in l: - regex = re.compile(r"@brief[\s]*[^\n]*") - # Match @brief, - # then any whitespace [\s]* - # then any character except newline [^\n]* - match = regex.findall(l) - if match: - example_description = str(match[0]).partition(" ")[2].strip() - break - - # TODO: @details (this is more difficult because it spans multiple lines) - - return ExampleInfo(example_folder, example_name, example_description, example_details) + example_description = "No description" + expr = re.compile(r"(@brief|@details)\s+([\s\S]*?)(?=\n\s*\*\s*@|\n\s*\*)") + for match in expr.finditer(source_file.read_text()): + tag, value = match.groups() + match tag: + case "@brief": + example_description = value + case "@details": + example_details = value + return ExampleInfo( + folder=source_file.parent, + name=source_file.parent.name, + description=example_description, + details=example_details, + ) + @dataclass class CommonExampleInfo(ExampleInfo): supported_parts: list -markdown_content = "" -common_examples = [] -print("Searching for shared examples...") -# Start a table -markdown_content += f"### Common Examples\n\n" -markdown_content += "The following common examples are supported across multiple microcontrollers.\n\n" -markdown_content += "| Example | Description | Supported Parts |\n" -markdown_content += "| --- | --- | --- |\n" -for i in sorted(Path(dir) for dir in os.scandir(examples_dir)): - target_micro = Path(i).name - if target_micro not in target_blacklist: - for main_file in Path(i).rglob("**/main.c"): - example_info = parse_example_info(main_file) - if example_info: - if example_info.name not in [i.name for i in common_examples]: - # Example does not exist in the table yet. - common_examples.append( - CommonExampleInfo( - example_info.folder, - example_info.name, - example_info.description, - example_info.details, - [target_micro] - ) + +def generate_examples_md(): + all_examples = [] + all_target_micros = set() + examples_dir = repo / "Examples" + print("Searching for shared examples...") + for directory in examples_dir.glob("*"): + if directory.name in target_excludelist: + print(f"Skipping {directory.name}... (in exclude-list)") + continue + target_micro = directory.name + all_target_micros.add(target_micro) + for main_file in directory.rglob("**/main.c"): + info = parse_example_info(main_file) + existing_example = [e for e in all_examples if e.name == info.name] + if not existing_example: + # Example does not exist in the table yet. + all_examples.append( + CommonExampleInfo( + info.folder, + info.name, + info.description, + info.details, + [target_micro], ) - else: - idx = [example_info.name == i.name for i in common_examples].index(True) - if target_micro not in common_examples[idx].supported_parts: - # Example exists in the table, but the current micro has not been added - # to the list of suppored parts yet. - common_examples[idx].supported_parts.append(target_micro) - -# Remove entries with only 1 micro -common_examples = [i for i in common_examples if len(i.supported_parts) > 1] -common_examples.sort(key=attrgetter("name")) # Sort using example name attribute - -for i in common_examples: - _list = '
'.join(i.supported_parts) - markdown_content += f"| **{i.name}** | {i.description} | {_list} |\n" - -markdown_content += "\n\n" - -common_example_names = [i.name for i in common_examples] # We'll use this as a filter for the part-specific tables below - -# Create an auto-generated table of examples for each micro. -example_md_files_list = [] -for i in sorted(Path(dir) for dir in os.scandir(examples_dir)): - target_micro = Path(i).name - if target_micro in target_blacklist: - print(f"Skipping {target_micro}... (in blacklist)") - else: - print(f"Generating examples table for {target_micro}") - markdown_content += f"### {target_micro.upper()} Examples\n\n" # Add header - markdown_content += f"In addition to the [Common Examples](#common-examples), the following examples are available specifically for the {target_micro.upper()}.\n\n" - markdown_content += "| Example | Description | MSDK Location |\n" # Start a table - markdown_content += "| --- | --- | --- |\n" - table_entries = [] - for main_file in Path(i).rglob("**/main.c"): - example_info = parse_example_info(main_file) - if example_info and example_info.name not in common_example_names: - link = f"https://github.com/analogdevicesinc/msdk/tree/release/{Path(example_info.folder).relative_to(repo).as_posix()}" - table_entries.append(f"| **{example_info.name}** | {example_info.description} | _Local:_`{Path(example_info.folder).relative_to(repo)}`
_Github:_ [link]({link})") - markdown_content += "\n".join(sorted(table_entries)) - markdown_content += "\n\n" - -# Pre-populate markdown files -print("Copying markdown files") -for f in repo.glob("*.md"): - print(f.name) - if (f.name != "README.md"): shutil.copy(f, here) # Workaround for https://github.com/mkdocs/mkdocs/issues/3313 - -(here / "Libraries" / "CLI").mkdir(exist_ok=True, parents=True) -shutil.copy(Path("Libraries") / "CLI" / "README.md", here / "Libraries" / "CLI" / "README.md") # TODO: Less hard-coded way of pulling these in - -# String replace "##__EXAMPLES_LIST__##" with autogenerated tables -# Note: We use the copy for the site build in the Documentation folder so that the -# tracked "source" doc in the root of the repo is unmodified. -ug_content = "" -with open(repo / "Documentation" / "USERGUIDE.md", "r", encoding="utf-8") as userguide: - ug_content = userguide.read() -with open(repo / "Documentation" / "USERGUIDE.md", "w", encoding="utf-8") as userguide: - userguide.write(ug_content.replace("##__EXAMPLES_LIST__##", markdown_content)) - -# Run Doxygen builds -for f in periph_docs_dir.glob("*_Doxyfile"): - micro = f.name.split("_")[0].upper() # max32xxx_Doxyfile -> MAX32XXX - if not (periph_docs_dir / micro).exists(): - run(f"doxygen {f.name}", cwd=f.parent, shell=True) - else: - print(f"{micro} Doxygen exists, skipping") - dest = here / "Libraries" / "PeriphDrivers" / "Documentation" / micro - # ^ Recreate directory structure so built links work - shutil.copytree(periph_docs_dir / micro, dest, dirs_exist_ok=True) - -# Copy res (resources) folder -print("Copying res folder") -shutil.copytree(repo / "res", repo / "Documentation" / "res", dirs_exist_ok=True) - -for f in (repo / "Tools" / "Bluetooth").glob("*.md"): - print(f.name) - dest = here / "Tools" / "Bluetooth" - if not dest.exists(): - dest.mkdir(parents=True, exist_ok=True) - shutil.copy(f, dest) - -############################## UPDATE USER GUIDE FOR CORDIO ################### -# TEMPLATE = "- [%s](%s/%s)\n" -cordio_docs_dir = repo / "Libraries" / "Cordio" / "docs" -platform_docs_dir = repo / "Libraries" / "Cordio" / "platform" / "Documentation" - -# cordio_doc_files = [f for f in listdir(cordio_docs_dir) if f.endswith('.md')] -platform_doc_files = [f for f in listdir(platform_docs_dir) if f.endswith('.pdf')] - -# with open(repo / "USERGUIDE.md", 'r') as f: -# lines = f.readlines() - -# idx = 0 -# foundStart = False - -# for line in lines: -# if foundStart: -# if line[0] == '#': -# end_idx = idx -# break - -# if '#### Cordio Documentation' in line: -# start_idx = idx -# foundStart = True - -# idx += 1 - -# comp_lines = lines[start_idx+1:end_idx] - -# for cfile in cordio_doc_files: -# for line in lines: -# if cfile in line: -# cordio_doc_files.remove(cfile) - -# for pfile in platform_doc_files: -# for line in lines: -# if pfile in line: -# platform_doc_files.remove(pfile) - -# if len(cordio_doc_files) > 0: -# entries = [] -# for f in cordio_doc_files: -# if 'LICENSE' in f: -# continue -# nav_name = f.split('.')[0].replace("_", " ").title() -# entries.append(TEMPLATE % (nav_name, cordio_docs_dir, f)) - -# if len(platform_doc_files) > 0: -# for f in platform_doc_files: -# if 'LICENSE' in f: -# continue -# nav_name = f.split('.')[0].replace("-", " ").title() -# entries.append(TEMPLATE % (nav_name, platform_docs_dir, f)) - -# while True: -# if lines[end_idx][0] == '-': -# end_idx -= 1 -# break -# end_idx -= 1 - -# idx = 0 -# for entry in entries: -# lines.insert(end_idx, entry) -# end_idx += 1 - -# content = "".join(lines) - -# with open(repo / "USERGUIDE.md", 'w') as f: -# f.write(content) -############################################################################### - -shutil.copytree(cordio_docs_dir, here / "Libraries" / "Cordio" / "docs", dirs_exist_ok=True) -shutil.copytree(platform_docs_dir, here / "Libraries" / "Cordio" / "platform" / "Documentation", dirs_exist_ok=True) - -# Run mkdocs build -# A subprocess is used because the Mkdocs Python API does not print any logging info -print("Building docs (this could take a few minutes)...") -run(f"mkdocs build", cwd=repo, shell=True) # Build with CLI -# build(load_config()) # Build with Python API + ) + elif target_micro not in existing_example[0].supported_parts: + # Example exists, but not for this micro. + existing_example[0].supported_parts.append(target_micro) + + all_examples.sort(key=attrgetter("name")) # Sort using example name attribute + + # Generate markdown content for common examples + common_entries = "" + for e in all_examples: + if len(e.supported_parts) > 1: + common_entries += f"| **{e.name}** | {e.description} | {'
'.join(e.supported_parts)} |\n" + + markdown_content = f""" + ### Common Examples + + The following common examples are supported across multiple microcontrollers. + + | Example | Description | Supported Parts | + | ------- | ----------- | --------------- | + {common_entries} + + """ + + # Generate markdown content for part-specific examples + all_target_micros = sorted(all_target_micros) + specific_examples = {} + for micro in all_target_micros: + specific_examples[micro] = [ + e + for e in all_examples + if micro in e.supported_parts and len(e.supported_parts) == 1 + ] + + for target, examples in specific_examples.items(): + markdown_content += f""" + ### {target.upper()} Examples + + In addition to the [Common Examples](#common-examples), the following examples + are available specifically for the {target.upper()}. + + | Example | Description | MSDK Location | + | ------- | ----------- | ------------- | + """ + for e in examples: + relative_path = e.folder.relative_to(repo).as_posix() + github = ( + f"https://github.com/analogdevicesinc/msdk/tree/release/{relative_path}" + ) + markdown_content += f"| **{e.name}** | {e.description} | _Local:_`{relative_path}`
_Github:_ [link]({github})\n" + + # generate examples.md from the template + src_path = repo / "Documentation/user-guide/examples.md.tpl" + dst_path = repo / "Documentation/user-guide/examples.md" + dst_path.write_text( + src_path.read_text(encoding="utf-8").replace( + "{{EXAMPLES_LIST}}", markdown_content + ), + encoding="utf-8", + ) + + +def copy_sources(): + print("Copying root markdown files") + for f in repo.glob("*.md"): + print(f"-> {f.name}") + if f.name != "README.md": + shutil.copy( + f, here + ) # Workaround for https://github.com/mkdocs/mkdocs/issues/3313 + + print("Copying CLI markdown files") + cli_path = repo / "Libraries/CLI" + cli_path.mkdir(exist_ok=True, parents=True) + shutil.copy( + cli_path / "README.md", + here / "Libraries/CLI/README.md", + ) + + print("Copying bluetooth markdown files") + src = repo / "Tools/Bluetooth" + dst = here / "Tools/Bluetooth" + for f in src.glob("*.md"): + print(f"-> {f.name}") + if not dst.exists(): + dst.mkdir(parents=True, exist_ok=True) + shutil.copy(f, dst) + + cordio_docs_dir = repo / "Libraries/Cordio/docs" + platform_docs_dir = repo / "Libraries/Cordio/platform/Documentation" + + print("Copying Cordio markdown files") + shutil.copytree(cordio_docs_dir, here / "Libraries/Cordio/docs", dirs_exist_ok=True) + + print("Copying platform markdown files") + shutil.copytree( + platform_docs_dir, + here / "Libraries/Cordio/platform/Documentation", + dirs_exist_ok=True, + ) + + +def build_doxygen_docs(): + # Run Doxygen builds + periph_docs_dir = repo / "Libraries/PeriphDrivers/Documentation" + for f in periph_docs_dir.glob("*_Doxyfile"): + micro = f.name.split("_")[0].upper() # max32xxx_Doxyfile -> MAX32XXX + if not (periph_docs_dir / micro).exists(): + run(f"doxygen {f.name}", cwd=f.parent, shell=True, check=False) + else: + print(f"{micro} Doxygen exists, skipping") + dest = here / "Libraries/PeriphDrivers/Documentation" / micro + # ^ Recreate directory structure so built links work + shutil.copytree(periph_docs_dir / micro, dest, dirs_exist_ok=True) + + +def build_mkdocs(): + # Run mkdocs build + # A subprocess is used because the Mkdocs Python API does not print any logging info + print("Building docs (this could take a few minutes)...") + run("mkdocs build", cwd=repo, shell=True, check=False) # Build with CLI + + +if __name__ == "__main__": + generate_examples_md() + copy_sources() + build_doxygen_docs() + build_mkdocs() diff --git a/Documentation/user-guide/examples.md b/Documentation/user-guide/examples.md.tpl similarity index 98% rename from Documentation/user-guide/examples.md rename to Documentation/user-guide/examples.md.tpl index be084cbef5..b59ff6a860 100644 --- a/Documentation/user-guide/examples.md +++ b/Documentation/user-guide/examples.md.tpl @@ -12,4 +12,4 @@ Each example contains a `README.md` file describing what it does. In general, th The tables below are offered to facilitate easier browsing through the MSDK examples. They are autogenerated from the available projects for each microcontroller. A link to the example's source code on Github is available, as well as its location inside of the MSDK. -##__EXAMPLES_LIST__## \ No newline at end of file +{{EXAMPLES_LIST}} diff --git a/Documentation/user-guide/libraries.md b/Documentation/user-guide/libraries.md index 23cdf086e9..cea2a58abf 100644 --- a/Documentation/user-guide/libraries.md +++ b/Documentation/user-guide/libraries.md @@ -3,7 +3,7 @@ The MSDK contains a large number of libraries, both third-party and in-house. The main library is the [Peripheral Driver API](#peripheral-driver-api), but the MSDK also contains drivers for various _external_ components such as TFT displays, cameras, accelerometers, audio codecs, and other devices. Additionally, dedicated libraries for more complex _internal_ hardware peripherals such as USB, the SDHC interface, and the Cordio BLE stack are also available. These usually build on _top_ of the Peripheral Driver API. ???+ note "ℹ️ **Note: Enabling Libraries**" - Libraries can be enabled for a project with a convenient *toggle switch* provided by the build system (See [Build Variables for Toggling Libraries](#build-variables-for-toggling-libraries)). + Libraries can be enabled for a project with a convenient _toggle switch_ provided by the build system (See [Build Variables for Toggling Libraries](#build-variables-for-toggling-libraries)). ## Peripheral Driver API @@ -79,6 +79,28 @@ The following table matches external part numbers to internal die types. This i | MAX78000 | AI85 | | MAX78002 | AI87 | +### `MSDK_NO_GPIO_CLK_INIT` + +Most Peripheral Driver initialization routines involve enabling system clocks, setting clock dividers, and configuring GPIO pins. In some cases (such as for Zephyr), frameworks or tools offer their own mechanisms for handling this, or it's desirable to manually handle it in custom application code. + +The MSDK offers a mechanism for disabling the automatic initialization of clocks and GPIO pins via the `MSDK_NO_GPIO_CLK_INIT` compiler definition. To enable this for a project, add it via the `PROJ_CFLAGS` [build configuration variable](#build-variables-for-the-compiler) using the following syntax: + +```Makefile +#project.mk + +PROJ_CFLAGS += -DMSDK_NO_GPIO_CLK_INIT +``` + +???+ note "ℹ️ **Syntax Note:**" + The `-D` flag tells the compiler to define a symbol at compile-time. It should be followed by the symbol we wish to define. In this case, `MSDK_NO_GPIO_CLK_INIT`. + +#### Peripheral Driver Build Variables + +| Configuration Variable | Description | Details | +| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | +| | | | +| `PINS_FILE` | Override pin definitions | This option can be used to override the default GPIO definitions used by the peripheral drivers, which can be found in the `Libraries/PeriphDrivers/Source/SYS/pins_xx.c` files in the MSDK. The file specified by this option will be passed to the build instead of the default. It's suggested to copy the default file first as a template before making modifications. | + --- ## CMSIS-DSP @@ -159,7 +181,7 @@ The `Libraries/MiscDrivers` folder of the MSDK contains drivers for miscellaneou ## SDHC -The **Secure Digital High Capacity *(SDHC)*** library offers a higher-level interface built on top of the SDHC [Peripheral Driver API](#peripheral-driver-api) that includes a [FatFS File System](http://elm-chan.org/fsw/ff/00index_e.html) implementation for managing files on SD cards. +The **Secure Digital High Capacity _(SDHC)_** library offers a higher-level interface built on top of the SDHC [Peripheral Driver API](#peripheral-driver-api) that includes a [FatFS File System](http://elm-chan.org/fsw/ff/00index_e.html) implementation for managing files on SD cards. See [Build Variables for Toggling Libraries](#build-variables-for-toggling-libraries) for instructions on enabling the SDHC library. diff --git a/USERGUIDE.md b/USERGUIDE.md deleted file mode 100644 index 0be21b87af..0000000000 --- a/USERGUIDE.md +++ /dev/null @@ -1,2577 +0,0 @@ -# MSDK User Guide - -## Overview - -The Maxim Microcontrollers SDK (MSDK), now a part of [Analog Devices](https://www.analog.com/en/index.html), contains the necessary software and tools to develop firmware for the [MAX32xxx and MAX78xxx Microcontrollers](https://www.analog.com/en/parametricsearch/10984). That includes register and system startup files to enable low-level development for its [supported parts](#supported-parts). It also provides higher-level peripheral driver APIs (written in C) alongside various utilities, third-party libraries, Board Support Packages (BSPs), and a set of example programs for each microcontroller. - -Additionally, the MSDK includes a GCC-based toolchain, and builds are managed by a system of Makefiles (See [GNU Make](https://www.gnu.org/software/make/manual/)). A [custom fork of OpenOCD](https://github.com/analogdevicesinc/openocd) enables flashing and debugging. The MSDK's toolchain and build system offers a Command Line Interface (CLI), and project files for [supported development environments](#supported-development-environments) are maintained that build on top of that CLI. - -This document describes the MSDK's installation, setup, and usage. - -### Supported Operating Systems - -- Windows (Windows 10 only) - -- Linux (Ubuntu only) - -- MacOS - -### Supported Parts - -The MSDK officially supports the following microcontrollers and evaluation platforms. - -* [**MAX32520**](https://www.analog.com/en/products/max32520.html): ChipDNA Secure Microcontroller with Secure Boot for IoT Applications - - - [MAX32520-KIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32520-kit.html) - - - [MAX32520FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32520fthr.html) - - ---- - -* [**MAX32570**](https://www.analog.com/en/products/max32570.html): Low-Power Arm Cortex-M4 Microcontroller with Contactless Radio for Secure Applications **(Available by NDA only**) - - - [MAX32570-QNKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32570-qnkit.html) - - - [MAX32570-MNKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32570-mnkit.html) - - ---- - -* **MAX32572** **(Not Yet Publicly Available)** - - MAX32572EVKIT **(Not Yet Publicly Available)** - - ---- - -* [**MAX32650**](https://www.analog.com/en/products/max32650.html): Ultra-Low-Power Arm Cortex-M4 with FPU-Based Microcontroller (MCU) with 3MB Flash and 1MB SRAM - - - [MAX32650-EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32650-evkit.html) - - - [MAX32650FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32650fthr.html) - - ---- - -* [**MAX32651**](https://www.analog.com/en/products/max32651.html): Ultra-Low-Power Arm Cortex-M4 with FPU-Based Microcontroller (MCU) with 3MB Flash and 1MB SRAM - - - [MAX32651-EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32651-evkit.html) - - ---- - -* [**MAX32655**](https://www.analog.com/en/products/max32655.html): Low-Power, Arm Cortex-M4 Processor with FPU-Based Microcontroller and Bluetooth 5.2 - - - [MAX32655EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32655evkit.html) - - - [MAX32655FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32655fthr.html) - - ---- - -* [**MAX32660**](https://www.analog.com/en/products/max32660.html): Tiny, Ultra-Low-Power Arm Cortex-M4 Processor with FPU-Based Microcontroller (MCU) with 256KB Flash and 96KB SRAM - - - [MAX32660-EVSYS](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32660-evsys.html) - - ---- - -* [**MAX32662**](https://www.analog.com/en/products/max32662.html): Arm Cortex-M4 Processor with FPU-Based Microcontroller (MCU) with 256KB Flash and 80KB SRAM - - - [MAX32662EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/MAX32662EVKIT.html) - - ---- - -* [**MAX32665-MAX32666 Family**](https://www.analog.com/en/products/max32665.html): Low-Power Arm Cortex-M4 with FPU-Based Microcontroller with Bluetooth 5 for Wearables - - - [MAX32666EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32666evkit.html) - - - [MAX32666FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32666fthr.html) - - - MAX32666FTHR2 (Product Page Not Yet Available) - - ---- - -* [**MAX32670**](https://www.analog.com/en/products/max32670.html): High-Reliability, Ultra-Low-Power Microcontroller Powered by Arm Cortex-M4 Processor with FPU for Industrial and IoT - - - [MAX32670EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32670evkit.html) - - ---- - -* [**MAX32672**](https://www.analog.com/en/products/max32672.html): High-Reliability, Tiny, Ultra-Low-Power Arm Cortex-M4F Microcontroller with 12-Bit 1MSPS ADC - - - [MAX32672EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32672evkit.html) - - ---- - -* [**MAX32675**](https://www.analog.com/en/products/max32675.html): Ultra-Low-Power Arm Cortex-M4F with Precision Analog Front-End for Industrial and Medical Sensors - - - [MAX32675EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32675evkit.html) - - - MAX32675FTHR (Product Page Not Yet Available) - - ---- - -* [**MAX32680**](https://www.analog.com/en/products/max32680.html): Ultra-Low-Power Arm Cortex-M4F with Precision Analog Front-End and Bluetooth LE 5.2 - - - [MAX32680EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32680evkit.html) - - ---- - -* [**MAX32690**](https://www.analog.com/en/products/max32690.html): Arm Cortex-M4 with FPU Microcontroller and Bluetooth LE 5 for Industrial and Wearables - - - [MAX32690EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/MAX32690EVKIT.html) - - [AD-APARD32690-SL](https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/ad-apard32690-sl.html) - ---- - -* [**MAX78000**](https://www.analog.com/en/products/max78000.html): Artificial Intelligence Microcontroller with Ultra-Low-Power Convolutional Neural Network Accelerator - - - [MAX78000EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000evkit.html) - - - [MAX78000FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000fthr.html) - - - [MAXREFDES178](https://www.analog.com/en/design-center/reference-designs/maxrefdes178.html) - - ---- - -* [**MAX78002**](https://www.analog.com/en/products/max78002.html): Artificial Intelligence Microcontroller with Low-Power Convolutional Neural Network Accelerator - - - [MAX78002EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78002evkit.html) - - ---- - -### Supported Development Environments - -- [Visual Studio Code](https://code.visualstudio.com/) -- [Eclipse IDE](https://www.eclipseide.org/) -- [IAR Embedded Workbench](https://www.iar.com/ewarm) -- [Keil MDK](https://www2.keil.com/mdk5/) -- Command-line Development - - - Supported shells (Windows) - - [MSYS2](https://www.msys2.org/) - - - Supported shells (Ubuntu) - - [Bash](https://tiswww.case.edu/php/chet/bash/bashtop.html) - - [Zsh](https://www.zsh.org/) - - - Supported shells (MacOS) - - [Zsh](https://www.zsh.org/) - -### Supported Languages - -- C -- C++ -- Assembly (Arm and/or RISC-V instruction set depending on the microcontroller) - -## Installation - -### Prerequisites - -- **Elevated/Administrator rights** - -- ???+ warning "**⚠️ MacOS**" - On MacOS, please also download and install [Homebrew](https://brew.sh/). It will be used in [Completing the Installation on MacOS](#completing-the-installation-on-macos) later on. - -- ???+ warning "**⚠️ Ubuntu**" - Several GUI packages are required by the QT installer framework _even on headless systems_. Run the following command _before_ running the installer to retrieve them. - - :::shell - sudo apt update && sudo apt install libxcb-glx0 libxcb-icccm4 libxcb-image0 libxcb-shm0 libxcb-util1 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-render0 libxcb-shape0 libxcb-sync1 libxcb-xfixes0 libxcb-xinerama0 libxcb-xkb1 libxcb1 libxkbcommon-x11-0 libxkbcommon0 libgl1 libusb-0.1-4 libhidapi-libusb0 libhidapi-hidraw0 - -### Download - -The MSDK installer is available for supported Operating Systems from the download links below. - -- [**Windows 10**](https://www.analog.com/en/design-center/evaluation-hardware-and-software/software/software-download?swpart=SFW0010820B) - -- [**Linux (Ubuntu)**](https://www.analog.com/en/design-center/evaluation-hardware-and-software/software/software-download?swpart=SFW0018720B) - - - ???+ note "ℹ️ **Note**" - This file must be made executable before running (`chmod +x MaximMicrosSDK_linux.run`). Alternatively, set `Allow executing as program" in the Ubuntu GUI. - ![Figure 1](res/Fig1.jpg) - -- [**MacOS**](https://www.analog.com/en/design-center/evaluation-hardware-and-software/software/software-download?swpart=SFW0018610B) - - - ???+ note "ℹ️ **Note**" - On MacOS, the installer is distributed inside a .dmg disk image file. Double-click the downloaded file to mount it. Afterward, the installer executable will be made available inside the mounted drive. - -### Setup - -The MSDK installer can be run through a [**GUI Installation**](#gui-installation) or a [**Command-Line Installation**](#command-line-installation) - -#### GUI Installation - -1. [**Download**](#download) the installer executable to an accessible location and launch it. - -2. Click **Next** to proceed from the Welcome screen. - -3. Choose the installation location. - - ![Figure 2](res/Fig2.jpg) - -4. Select the components to install. It's recommended to install all components. - - ![Figure 3](res/Fig3.jpg) - -5. Continue to the installation page, and click **install** to begin. Installation can be safely canceled at any time. - - ![Figure 6](res/Fig6.jpg) - - ![Figure 7](res/Fig7.jpg) - -6. Click **Finish** to complete the installation. - - ![Figure 8](res/Fig8.jpg) - -7. You should now see the contents of the installation directory populated with the MSDK. - - ![Figure 10](res/Fig10.jpg) - - ???+ warning "⚠️ **Warning**" - On MacOS, some [_additional steps_](#completing-the-installation-on-macos) are required. - - -#### Command-Line Installation - -The MSDK installer features a command-line interface that can be used as an alternative to its GUI. This is useful for installations on "headless" systems and scripting. - -??? note "ℹ️ **Note:**" The `--help` Command" - The available commands can be retrieved by running the MSDK installer executable with the `--help` option on the command line. For example: - - :::shell - $ ./MaximMicrosSDK_linux.run --help - - Usage: ./MaximMicrosSDK_linux.run [options] command - - Qt Installer Framework supports both GUI and headless mode. The installation operations can be invoked with the following commands and options. Note that the options marked with "CLI" are available in the headless mode only. - - Commands: - in, install - install default or selected packages - - ch, check-updates - show available updates information on maintenance tool - up, update - update all or selected packages - - rm, remove - uninstall packages and their child components - - li, list - list currently installed packages - - se, search - search available packages - - Note: The --filter-packages option can be used to specify - additional filters for the search operation - co, create-offline - create offline installer from selected packages - - pr, purge - uninstall all packages and remove entire program directory - - Options: - -h, --help Displays help on commandline - options. - # ... - -To run a _headless_ installation: - -1. [**Download**](#download) the installer executable to an accessible location. - -2. Ensure that you are able to run the installer with **_elevated permissions_**. - - ???+ note "Windows" - Open a Command Prompt or PowerShell **_as administrator_**. - - ???+ note "Ubuntu and MacOS" - Ensure you have `sudo` rights. - -3. Run the installer with the arguments `in --root ` - - ???+ note "Windows" - :::shell - .\MaximMicrosSDK_win.exe in --root C:/MaximSDK - - ???+ note "Ubuntu and MacOS" - :::shell - sudo ./MaximMicrosSDK_linux.run in --root ~/MaximSDK - -4. Follow the installer's command-line instructions to accept licenses and confirm installation size. - - ??? note "ℹ️ **Note: Unattended Installations**" - You can run the installer without any user input by auto-accepting all licenses, messages, and input. - - :::shell - sudo ./MaximMicrosSDK_linux.run in --root ~/MaximSDK --accept-licenses --accept-messages --confirm-command - -5. (Ubuntu and MacOS) Change ownership of the installation folder with: - - :::shell - sudo chown -R $(whoami):$(whoami) - - ??? note "ℹ️ **Note: Folder Ownership**" - Usually, running the installation with `sudo` results in an installation owned by the `root` user. - - You can verify this with the `ls -la` command. - - :::shell - ls -la ~/MaximSDK - total 29656 - drwxr-xr-x 8 root root 4096 Jul 13 20:41 . - drwxr-x--- 17 username username 4096 Jul 13 20:41 .. - drwxr-xr-x 2 root root 4096 Jul 13 20:41 Documentation - drwxr-xr-x 15 root root 4096 Jul 13 20:41 Examples - -rw-r--r-- 1 root root 171189 Jul 13 20:41 InstallationLog.txt - drwxr-xr-x 17 root root 4096 Jun 28 23:42 Libraries - drwxr-xr-x 2 root root 4096 Jul 13 20:41 Licenses - -rwxr-xr-x 1 root root 28287992 Jul 13 20:41 MaintenanceTool - -rw-r--r-- 1 root root 1719694 Jul 13 20:41 MaintenanceTool.dat - -rw-r--r-- 1 root root 9770 Jul 13 20:41 MaintenanceTool.ini - drwxr-xr-x 11 root root 4096 Jun 28 23:42 Tools - -rw-r--r-- 1 root root 13123 Jun 28 23:48 changelog.txt - -rw-r--r-- 1 root root 67664 Jul 13 20:41 components.xml - -rw-r--r-- 1 root root 48 Jul 13 20:41 installer.dat - drwxr-xr-x 112 root root 12288 Jul 13 20:41 installerResources - -rw-r--r-- 1 root root 25214 Jun 29 00:47 maxim.ico - -rw-r--r-- 1 root root 362 Jul 13 20:41 network.xml - -rwxrwxrwx 1 root root 1129 Jun 29 00:47 setenv.sh - -rwxrwxrwx 1 root root 300 Jun 29 00:47 updates.sh - - The owner of the MSDK installation should be changed back to the normal user with the command above. Otherwise, the toolchain may behave inconsistently against file permission issues. - - Once complete, `ls -la` should look similar to below (where `username` is your username). - - :::shell - ls -la ~/MaximSDK - total 29656 - drwxr-xr-x 8 username username 4096 Jul 13 20:41 . - drwxr-x--- 17 username username 4096 Jul 13 20:41 .. - drwxr-xr-x 2 username username 4096 Jul 13 20:41 Documentation - drwxr-xr-x 15 username username 4096 Jul 13 20:41 Examples - -rw-r--r-- 1 username username 171189 Jul 13 20:41 InstallationLog.txt - drwxr-xr-x 17 username username 4096 Jun 28 23:42 Libraries - drwxr-xr-x 2 username username 4096 Jul 13 20:41 Licenses - -rwxr-xr-x 1 username username 28287992 Jul 13 20:41 MaintenanceTool - -rw-r--r-- 1 username username 1719694 Jul 13 20:41 MaintenanceTool.dat - -rw-r--r-- 1 username username 9770 Jul 13 20:41 MaintenanceTool.ini - drwxr-xr-x 11 username username 4096 Jun 28 23:42 Tools - -rw-r--r-- 1 username username 13123 Jun 28 23:48 changelog.txt - -rw-r--r-- 1 username username 67664 Jul 13 20:41 components.xml - -rw-r--r-- 1 username username 48 Jul 13 20:41 installer.dat - drwxr-xr-x 112 username username 12288 Jul 13 20:41 installerResources - -rw-r--r-- 1 username username 25214 Jun 29 00:47 maxim.ico - -rw-r--r-- 1 username username 362 Jul 13 20:41 network.xml - -rwxrwxrwx 1 username username 1129 Jun 29 00:47 setenv.sh - -rwxrwxrwx 1 username username 300 Jun 29 00:47 updates.sh - - - -#### Completing the Installation on MacOS - -???+ warning "⚠️ **Warning**" - On MacOS, some additional missing packages must be manually installed with [Homebrew](https://brew.sh/). There are also some manual setup steps required to retrieve `make` version 4. The instructions in this section are critical. - -1. Install [Homebrew](https://brew.sh/). - -2. Run the command below to install dependencies for OpenOCD. - - :::shell - brew install libusb-compat libftdi hidapi libusb - -### Maintenance - -An MSDK installation contains a `MaintenanceTool` executable program in its root directory. Use the Maintenance Tool to retrieve updates, manage components, and uninstall the MSDK. - -![Figure 11](res/Fig11.jpg) - -#### Updates - -The MSDK releases updates quarterly, and the Maintenance Tool will retrieve the latest release when **Update components** is run. - -#### Older Versions and Offline Installer - -Older versions of the MSDK are available as an **_offline installer_** for each release tag. They are available on the [Releases page](https://github.com/analogdevicesinc/msdk/releases) of the MSDK GitHub and can be used to roll back to a specific MSDK release. - -#### Development Resources - -Users can obtain development copies of the MSDK resources from [Github](https://github.com/analogdevicesinc/msdk). Setup instructions can be found in the repository's [README](https://github.com/analogdevicesinc/msdk/blob/main/README.md). - -## Getting Started - -The MSDK is designed for both evaluation and end-application development. The typical **evaluation** cycle usually involves setting up the development environment, running demos, and exercising the peripheral driver API on an _evaluation platform_. The typical **development** cycle typically involves building a prototype application on an _evaluation platform_ first, then porting the application to a custom board. This section describes how to get started with the MSDK focusing on the _evaluation_ cycle. - -**First**, review the [**Key Concepts**](#key-concepts) below. Then, proceed to the section for your preferred IDE. Each sub-section is written as a self-contained quick-start with links to additional documentation on important topics. - -- [Getting Started with Visual Studio Code](#getting-started-with-visual-studio-code) -- [Getting Started with Eclipse](#getting-started-with-eclipse) -- [Getting Started with Command-Line Development](#getting-started-with-command-line-development) - -### Key Concepts - -The MSDK supports multiple development environments with different features that may tailor to the user's preferences. There are a few key concepts to remember that are universal to MSDK development. - -- **Target Microcontroller**: The _target microcontroller_ refers to the base part number of the microcontroller used for development. The MSDK contains register-level support and startup files for each of its [supported parts](#supported-parts), and it's important to note that support files for a target microcontroller and its _Board Support Packages_ are distinct from each other. - - For example, if the [MAX78000EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000evkit.html) _or_ [MAX78000FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000fthr.html) is being used, the _Target Microcontroller_ is the MAX78000. - ---- - -- **Board Support Package (BSP)**: The MSDK supports evaluation platforms for target microcontrollers with _Board Support Packages_. For microcontrollers with multiple evaluation platforms, multiple BSPs are available. These can be found in the `Libraries/Boards` folder of the MSDK installation. - - By default, most projects in the MSDK come pre-configured for the "EVKIT"-type BSP, which is generally the largest evaluation platform for that device with most (or all) pins broken out. It's important to note that the active BSP may need to be reconfigured for a project, which is done slightly differently for each development environment. - ---- - -- **System Environment**: Your system's _environment_ is a broad term that encapsulates the programs and variables available to your system's shell on the command line. The user is expected to have some basic familiarity with this concept. - ---- - -- **System Path**: Your system's _Path_ is a unique environment variable that tells it where to search for program binaries. The user is expected to be familiar with this concept and how to modify the system Path if necessary. - ---- - -- **Integrated Development Environment (IDE)**: An IDE offers a higher-level user interface (typically with a GUI) that manages the tools for **editing** source code, **building** source code, **flashing** program binaries, and **debugging**. The abbreviation is frequently used in this document, and the MSDK supports _multiple_ IDEs that can be used depending on preference. (See ["Supported Development Environments"](#supported-development-environments)) - ---- - -- **Build Configuration vs. Project Configuration**: An MSDK project is comprised of two complementary systems: The _Build System_ and the _Integrated Development Environment (IDE)_. These systems each offer their own configuration interfaces, and it's important to note what each is used for. - - The **Build System** manages source code compilation into program binaries and offers a **Command-Line Interface (CLI)** for setting **Build Configuration Variables**. - - The **IDE** offers a higher-level user interface (typically with a GUI) for managing a project and sits _on top_ of the build system's _CLI_. Each IDE offers its own settings for managing fundamental aspects of the build, such as: - - - Setting the _Target Microcontroller_ - - Setting the _Board Support Package_ - - Configuring the _Environment_ and _System Path_ for use with the MSDK toolchain - -### Getting Started with Visual Studio Code - -The MSDK includes Visual Studio Code ("VS Code") support through the [VSCode-Maxim](https://github.com/MaximIntegratedTechSupport/VSCode-Maxim) project. - -This section walks through setup, opening, and running an example project with VS Code. This material is also available in video form targeting the MAX78000 in ["Understanding Artificial Intelligence Episode 8.5 - Visual Studio Code"](https://www.analog.com/en/education/education-library/videos/6313212752112.html). - -For complete documentation, see the [Visual Studio Code](#visual-studio-code) section of this User Guide. - -#### Setup (VS Code) - -The setup below only needs to be done once per MSDK [installation](#installation). - -1. Download and install Visual Studio Code for your OS [here](https://code.visualstudio.com/Download). - -2. Launch Visual Studio Code. - -3. Install the Microsoft [C/C++ extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode.cpptools). - -4. Install the [Cortex-Debug extension](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug) - -5. Use **`CTRL + SHIFT + P`** (or **`COMMAND + SHIFT + P`** on MacOS) to open the developer prompt. - -6. Type "open user settings" and select the **"Preferences: Open User Settings (JSON)"** option. - - ![Open Settings JSON Command](res/Fig42.jpg) - -7. Add the entries below to your user settings.json file. - - :::json - // There may be other settings up here... - - "MAXIM_PATH": "Change me! Only use forward slashes (/) for this path", - "update.mode": "manual", - "extensions.autoUpdate": false, - - // There may be other settings down here... - - ???+ warning "⚠️ **Setting MAXIM_PATH**" - Set the `MAXIM_PATH` option to the _absolute path_ of the MSDK installation. - For example, you might set `"MAXIM_PATH":"C:/MaximSDK"` on Windows and `"MAXIM_PATH":"/home/username/MaximSDK"` on Ubuntu/MacOS. - - ???+ note "ℹ️ **Note: Automatic Updates**" - `"update.mode: "manual"` and `"extensions.autoUpdate": false` _disable_ automatic updates of VS Code and its extensions, respectively. This is an _optional_ (but recommended) addition left over from the early days of VS Code development when there was lots of feature churn. Things have stabilized more as of version 1.70+, but updates remain frequent. For the VSCode-Maxim project files, the exact version numbers tested with each release can be found on the [VSCode-Maxim Releases](https://github.com/analogdevicesinc/VSCode-Maxim/releases) page. - -8. Save your changes to the file with **`CTRL + S`** and restart VS Code. - -#### Building and Running a Project (VS Code) - -1. Launch Visual Studio Code. - -2. Select **File -> Open Folder...** - - ![File -> Open Folder](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/file_openfolder.JPG) - -3. Navigate to an example project for the target microcontroller in the MSDK's `Examples` folder. - - ![Figure 43](res/Fig43.jpg) - - ???+ warning "**⚠️ Copying Examples**" - It's strongly recommended to copy example projects to an _outside_ folder before modifying them. This keeps the MSDK's "source" copy preserved for reference. Project folders must be copied to a location _without_ any spaces in its filepath. - -4. VS Code will prompt for trust the first time. Select _Trust folder and enable all features_ - - ![Trust Prompt](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/workspaceTrustPrompt.JPG) - -5. The opened project should look something like this. - - ![Figure 16](res/Fig16.jpg) - -6. Set the **Board Support Package** to match your evaluation platform. In VS Code, this is done by editing the `.vscode/settings.json` file and setting the `"board"` project configuration option. - - ???+ note "ℹ️ **Note**" - See [Board Support Packages](#board-support-packages) for more details and a table of values. - - ![Figure 17](res/Fig17.jpg) - -7. Save your changes to `settings.json` with `CTRL+S`. - -8. Reload the VS Code window. After changing any options in `settings.json`, a reload is necessary to force it to re-index VS Code's Intellisense engine. - - VS Code can be conveniently reloaded with the **Reload Window** developer command accessed with **`CTRL + SHIFT + P`** (or **`COMMAND + SHIFT + P`** on MacOS). - - ![Reload window](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/reload_window.JPG) - -9. Press the shortcut **`Ctrl+Shift+B`** to open the available **Build Tasks** (alternatively navigate to _Terminal -> Run Build task..._). - - ![Build Tasks Image](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/buildtasks.JPG) - -10. Run the **"build"** task to compile the project for the configured _Target Microcontroller_ and _BSP_. Notice that the `TARGET` and `BOARD` Build Configuration Variables are set on the command line. The program binary is successfully compiled into the `.elf` program binary in the **build** sub-folder of the project. - - ![Figure 18](res/Fig18.jpg) - -11. Connect a debug adapter between the host PC and the evaluation platform. Detailed instructions on this hardware setup can be found in the evaluation platform's Datasheet and Quick-Start Guide, which are available on its [analog.com](https://analog.com) product page. - -12. Run the **`flash`** build task. Running this task will automatically build the project if needed, flash the program binary, and halt the program execution to await a debugger connection. - - ![Figure 19](res/Fig19.jpg) - -13. Open the **Run and Debug** window (**`CTRL+SHIFT+D`**) and launch the debugger (**`F5`**). - - ![Figure 20](res/Fig20.jpg) - -14. Verify the program counter enters `main` successfully. - - ![Figure 21](res/Fig21.jpg) - -15. Press **Continue** (**`F5`**) to run the program. - - ![Debugger Control Bar Image](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/debugger_bar.JPG) - - Continue | Step Over | Step Into | Step Out | Restart | Stop - -16. Exercise the debugger and press stop to disconnect when finished. - - ???+ note "ℹ️ **Note**" - See [Visual Studio Code](#visual-studio-code) for additional more detailed documentation. - ---- - -### Getting Started with Eclipse - -#### Setup (Eclipse) - -The only setup required to use Eclipse is to ensure that the "Eclipse" component has been selected during the [MSDK installation](#installation). If the MSDK is already installed, Eclipse can be retrieved using the [Maintenance Tool](#maintenance). - -This section is an Eclipse "quick-start" that walks through creating, building, and running a project. For complete documentation, see the [Eclipse](#eclipse) section of this User Guide. - -#### Building and Running a Project (Eclipse) - -1. Launch Eclipse with its start menu shortcut. - - ![Figure 22](res/Fig22.jpg) - -2. Ensure Eclipse is set to the **C/C++ perspective** in the top right corner. Otherwise, the new project wizard will not show up. - -3. Navigate to **File -> New -> Maxim Microcontrollers**. - - ![Figure 31](res/Fig31.jpg) - -4. Enter the project name and hit **Next**. - - ![Figure 32](res/Fig32.jpg) - -5. Follow the new project wizard. - - - Chip type selects the _Target Microcontroller_ - - Board type selects the [_Board Support Package (BSP)_](#board-support-packages) - - Example type selects the example project to be copied as the template for the new project. - - Adapter type selects the debug adapter to use. - - ![Figure 33](res/Fig33.jpg) - -6. Select **Finish** to create the new project. - -7. Build the project using the **Build** hammer button (top left). - - ![Figure 27](res/Fig27.jpg) - -8. Select the correct project in the **Launch Configuration** dropdown and set it to **Debug** mode. - -9. Use the **Debug** button (top left) to flash the program binary and connect the debugger. - - ![Figure 28](res/Fig28.jpg) - -10. The Eclipse view will switch to debug mode, and the debugger will break on entry into `main`. - - ![Figure 29](res/Fig29.jpg) - -11. **Resume** the program (**`F8`**) using the top control bar and exercise the debugger. - - ![Figure 30](res/Fig30.jpg) - -12. **Terminate** the debugger (**`CTRL+F2`**) when finished. - - ???+ note "ℹ️ **Note**" - See [Eclipse](#eclipse) for additional more detailed documentation. - ---- - -### Getting Started with Command-Line Development - -This section demonstrates how to build MSDK example projects on the command line. It also shows how to flash and debug over the command line. The [MAX78002EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78002evkit.html) will be used as an example, but the same concepts apply to all parts. - -For more detailed documentation, see the [Command-Line Development](#command-line-development) section of this User Guide. - -#### Setup (Command-Line) - -##### Windows - -On Windows, use the MinGW shortcut to launch an MSYS2/MinGW terminal. This shortcut points to `Tools/MSYS2/msys.bat` in an MSDK installation and correctly configures the user's environment for development. - -![Figure 22](res/Fig22.jpg) - -##### Linux/MacOS - -###### Sourcing `setenv` - -A `setenv.sh` script is available in the root directory of an MSDK installation. This file can be sourced to facilitate the setup of an environment for MSDK development. - -```bash -source ~/MaximSDK/setenv.sh -``` - -This command can also be added to shell startup scripts (`~/.bashrc`, `~/.zshrc`, etc.) to automate the environment setup. - -???+ note "ℹ️ **Note: Automatic Updates**" - `setenv.sh` will automatically check for available updates to the MSDK. This can be permanently disabled by following its prompt on startup, or by deleting/moving the `updates.sh` script in the root directory of the MSDK installation. - - ![Figure 51](res/Fig51.jpg) - -###### Manual Setup - -1. On Linux and MacOS, copy the following contents into your shell's terminal profile/startup script to manually configure your environment for MSDK development. Depending on your system and shell, this could be `~/.profile`, `~/.zprofile`, `~/.bashrc`, `~/.zshrc`, etc. Command-line Linux/MacOS users are expected to know which file to edit for their particular system and preferences. - - # Set MAXIM_PATH to point to the MSDK - export MAXIM_PATH=#changeme! - - # Add Arm Embedded GCC to path (v10.3) - export ARM_GCC_ROOT=$MAXIM_PATH/Tools/GNUTools/10.3 - export PATH=$ARM_GCC_ROOT/bin:$PATH - - # Add xPack RISC-V GCC to path (v12.2) - export XPACK_GCC_ROOT=$MAXIM_PATH/Tools/xPack/riscv-none-elf-gcc/12.2.0-3.1 - export PATH=$XPACK_GCC_ROOT/bin:$PATH - - # Add OpenOCD to path - export OPENOCD_ROOT=$MAXIM_PATH/Tools/OpenOCD - export PATH=$OPENOCD_ROOT:$PATH - -2. Change `export MAXIM_PATH=#changeme!` to the installation location of the MSDK. This will make the toolchain accessible from the command line by adding it to your *system's path*. - - # Set MAXIM_PATH environment variable - export MAXIM_PATH=$HOME/MaximSDK - -##### Verification - -Run the following commands to verify that the toolchain is accessible. They should display version numbers successfully. - -- `arm-none-eabi-gcc -v` -- `arm-none-eabi-gdb -v` -- `make -v` -- `openocd -v` - -Any "file not found" errors indicate that `MAXIM_PATH` has not been set correctly or the system's Path has not been configured correctly. - -#### Building and Running an Example (Command-Line) - -1. First, copy an [example project](https://github.com/analogdevicesinc/msdk/tree/main/Examples) to an accessible directory outside of the SDK. The `Hello_World` project is a good one to start with. - - ???+ warning "**⚠️ Copying Examples**" - It's strongly recommended to copy example projects to an _outside_ folder before modifying them. This keeps the MSDK's "source" copy preserved for reference. Project folders must be copied to a location _without_ any spaces in its filepath. - -2. Launch your terminal. On Windows, use the MinGW shortcut or `Tools/MSYS2/msys.bat` file to launch the MSYS2 terminal. - -3. `cd` into the location of the copied example project. - -4. Run the following command to build the example: - - make - - ???+ note "ℹ️ **Note: Improving Build Speed**" - The following command can be used to enable parallel builds and drastically improve build speed: - - :::shell - make -r -j --output-sync=target --no-print-directory - - - `-r` is an option that ignores some of Make's implicit rules to improve build speed. - - `-j` enables parallel execution of the build in the maximum number of threads. - - ???+ warning "**⚠️ Parallel Builds**" - Parallel builds can mangle the console output. To deal with this, the `--output-sync=target` option can be used. However, _this is only available in Make version 4 or higher_. When this option is used, `--no-print-directory` is also used to declutter the build output. - - - Expected output: - - :::bash - Loaded project.mk - CC main.c - CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/Source/board.c - CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/stdio.c - CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/LED/led.c - CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/PushButton/pb.c - CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/Display/adafruit_3315_tft.c - CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/Touchscreen/adafruit_3315_touch.c - CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/Camera/camera.c - CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/Camera/mipi_camera.c - CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/Camera/ov7692.c - CC /home/msdk/Libraries/Boards/MAX78002/EvKit_V1/../../../MiscDrivers/Camera/sccb.c - AS /home/msdk/Libraries/CMSIS/Device/Maxim/MAX78002/Source/GCC/startup_max78002.S - CC /home/msdk/Libraries/CMSIS/Device/Maxim/MAX78002/Source/heap.c - CC /home/msdk/Libraries/CMSIS/Device/Maxim/MAX78002/Source/system_max78002.c - LD /home/msdk/Examples/MAX78002/Hello_World/build/max78002.elf - arm-none-eabi-size --format=berkeley /home/msdk/Examples/MAX78002/Hello_World/build/max78002.elf - text data bss dec hex filename - 35708 2504 1156 39368 99c8 /home/msdk/Examples/MAX78002/Hello_World/build/max78002.elf - -5. Connect a debug adapter between the host PC and the evaluation platform. Detailed instructions on this hardware setup can be found in the evaluation platform's Datasheet and Quick-Start Guide, which are available on its [analog.com](https://analog.com) product page. - -6. Flash and run the program with OpenOCD. - - :::shell - make flash.openocd - - ???+ note "ℹ️ **Note: Flashing with Make**" - The command `make flash.openocd` is a build target added to the MSDK as of the [June 2023 Release](https://github.com/analogdevicesinc/msdk/releases/tag/v2023_06) to make flashing over the command-line easier. It launches and drives an OpenOCD server behind the scenes to flash the project's binary. See the `Tools/Flash/flash.mk` file for implementation details, and [Flashing on the Command-Line](#flashing-on-the-command-line) for more details on launching debug server/clients manually. - - Expected output: - - :::bash - Open On-Chip Debugger 0.11.0+dev-g4cdaa275b (2022-03-02-09:57) - Licensed under GNU GPL v2 - For bug reports, read - http://openocd.org/doc/doxygen/bugs.html - DEPRECATED! use 'adapter driver' not 'interface' - Info : CMSIS-DAP: SWD supported - Info : CMSIS-DAP: Atomic commands supported - Info : CMSIS-DAP: Test domain timer supported - Info : CMSIS-DAP: FW Version = 0256 - Info : CMSIS-DAP: Serial# = 044417016af50c6500000000000000000000000097969906 - Info : CMSIS-DAP: Interface Initialised (SWD) - Info : SWCLK/TCK = 1 SWDIO/TMS = 1 TDI = 0 TDO = 0 nTRST = 0 nRESET = 1 - Info : CMSIS-DAP: Interface ready - Info : clock speed 2000 kHz - Info : SWD DPIDR 0x2ba01477 - Info : max32xxx.cpu: Cortex-M4 r0p1 processor detected - Info : max32xxx.cpu: target has 6 breakpoints, 4 watchpoints - Info : starting gdb server for max32xxx.cpu on 3333 - Info : Listening on port 3333 for gdb connections - Info : SWD DPIDR 0x2ba01477 - target halted due to debug-request, current mode: Thread - xPSR: 0x81000000 pc: 0x0000fff4 msp: 0x20003ff0 - ** Programming Started ** - ** Programming Finished ** - ** Verify Started ** - ** Verified OK ** - ** Resetting Target ** - Info : SWD DPIDR 0x2ba01477 - shutdown command invoked - -7. The program has been flashed and the target micro has been reset. The flashed program should now be running. For the `Hello_World` example, an LED on the board should be blinking. - - ???+ note "ℹ️ **Note**" - See [Command-Line Development](#command-line-development) for additional more detailed documentation. - -## Visual Studio Code - -Support for [Visual Studio Code](https://code.visualstudio.com/) is maintained for the MSDK and developed on the [VSCode-Maxim](https://github.com/analogdevicesinc/VSCode-Maxim) GitHub repository. - -For setup/quick-start instructions, see ["Getting Started with Visual Studio Code"](#getting-started-with-visual-studio-code) first. This section offers detailed usage info focusing on the typical development cycle. - -### Opening Example Projects - -Visual Studio Code is built around a "working directory" paradigm. The editor is always rooted in a working directory, and the main mechanism for changing that directory is **File -> Open Folder...** - -![File -> Open Folder](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/file_openfolder.JPG) - -As a result, you'll notice that there is no "New Project" mechanism. A "project" in VS Code is simply a folder. It will look inside the opened folder for a `.vscode` _sub_-folder to load project-specific settings from. - -![Example Directory Contents](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/opening_projects_2.jpg) - -_(Note: You may need to enable viewing of hidden items in your file explorer to see the .vscode sub-folder)._ - -To open a project: - -1. Launch Visual Studio Code. - -2. Select **File -> Open Folder...** - - ![File -> Open Folder](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/file_openfolder.JPG) - -3. Navigate to an example project for the target microcontroller in the MSDK's `Examples` folder. - - ![Figure 43](res/Fig43.jpg) - - ???+ warning "**⚠️ Copying Examples**" - It's strongly recommended to copy example projects to an _outside_ folder before modifying them. This keeps the MSDK's "source" copy preserved for reference. Project folders must be copied to a location _without_ any spaces in its filepath. - -4. VS Code will prompt for trust the first time. Select _Trust folder and enable all features_ - - ![Trust Prompt](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/workspaceTrustPrompt.JPG) - -5. The opened project should look something like this. - - ![Figure 16](res/Fig16.jpg) - -6. Verify the **_Board Support Package_** for the project is set correctly. - -### How to Set the BSP (VS Code) - -To set the BSP for an open project: - -1. Set the `"board"` [project configuration](https://github.com/analogdevicesinc/VSCode-Maxim/tree/main#project-configuration) option in `.vscode/settings.json`, which maps to the `BOARD` _[Build Configuration Variable](#build-tables)_. - - See [Board Support Packages](#board-support-packages) for a table of possible values. - - ![Figure 17](res/Fig17.jpg) - -2. **Reload the VS Code window** to re-index its Intellisense engine. - - VS Code can be conveniently reloaded with the **Reload Window** developer command accessed with **`CTRL + SHIFT + P`** (or **`COMMAND + SHIFT + P`** on MacOS). - - ![Reload window](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/reload_window.JPG) - -### Build Tasks - -Once a project is opened 4 available build tasks will become available via `Terminal > Run Build task...` or the shortcut `Ctrl+Shift+B`. These tasks are configured by the `.vscode/task.json` file. - -![Build Tasks Image](https://raw.githubusercontent.com/analogdevicesinc/VSCode-Maxim/main/img/buildtasks.JPG) - -#### Build - -* Compiles the code with a `make all` command. -* Additional options are passed into Make on the command-line based on the project's settings.json file. -* The `./build` directory will be created and will contain the output binary, as well as all intermediary object files. -* Notice the **`TARGET`**, **`BOARD`** , and **`PROJECT`** Build Configuration Variables being set on the command line, and the program binary successfully compiled into the `.elf` program binary in the **build** sub-folder of the project. - - ![Figure 18](res/Fig18.jpg) - -#### Clean - -* Cleans the build output, removing the `./build` directory and all of its contents. - -#### Clean-Periph - -* This task is the same as 'clean', but it also removes the build output for the MSDK's peripheral drivers. -* Use this if you would like to recompile the peripheral drivers from source on the next build. - -#### Flash - -* Launching this task automatically runs the `Build` task first. Then, it flashes the output binary to the microcontroller. -* It uses the GDB `load` and `compare-sections` commands, and handles launching an OpenOCD internally via a pipe connection. -* The flashed program will be halted until the microcontroller is reset, power cycled, or a debugger is connected. -* A debugger must be connected correctly to use this task. Refer to the datasheet of your microcontroller's evaluation board for instructions. - -#### Flash & Run - -* This is the same as the `Flash` task, but it also will launch execution of the program once flashing is complete. - -#### Erase Flash - -* Completely erases all of the application code in the flash memory bank. -* Once complete, the target microcontroller will be effectively "blank". -* This can be useful for recovering from Low-Power (LP) lockouts, bad firmware, etc. - -### Flashing and Debugging - -This section assumes a debugger is connected between the host PC and the evaluation platform. For more detailed instructions on this hardware setup, refer to the evaluation platform's Datasheet and Quick-Start Guide, which are available on its [analog.com](https://analog.com) product page. - -#### Arm Core Debugging - -1. Run the **`flash`** [build task](#build-tasks). Running this task will automatically build the project if needed, flash the program binary, and halt the program execution to await a debugger connection. - - **Flashing does not happen automatically when launching the debugger**. This is an intentional design choice for VS Code to allow the debugger to quickly restart the program under debug without a lengthy re-flash procedure. - - ![Figure 19](res/Fig19.jpg) - -2. Open the **Run and Debug** window (**`CTRL+SHIFT+D`**) and select the `Debug Arm (Cortex-debug)` profile. - - ![Figure 20](res/Fig20.jpg) - - ![Figure 46](res/Fig46.jpg) - -3. Verify the program counter enters `main` successfully. - - ![Figure 21](res/Fig21.jpg) - -4. Press **Continue** (**`F5`**) to run the program. The debugger control bar can be used to exercise the debugger further. - - ![Debugger Control Bar Image](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/debugger_bar.JPG) - - Continue | Step Over | Step Into | Step Out | Restart | Stop - -#### Breakpoints - -Breakpoints can be set by clicking next to a line number in VS Code's editor. They are removed by clicking on them again. - -![Figure 35](res/Fig35.jpg) - -Additionally _conditional_ breakpoints can be added by _right-clicking_ on a line. - -![Figure 36](res/Fig36.jpg) - -The condition and condition type can be modified with the dropdown. This is useful for setting a breakpoint on a certain value in a `for` loop iterator or when a specific bit in a register is set, for example. - -![Figure 37](res/Fig37.jpg) - -#### Peripheral Browsing - -A peripheral browser lets you quickly view the formatted register-level contents of the peripheral blocks on a target microcontroller under debug. - -As of the [v1.6.0](https://github.com/analogdevicesinc/VSCode-Maxim/releases/tag/v1.6.0) VSCode-Maxim project files, pre-made [Cortex-Debug](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug) launch profiles are included in each project. These profiles enable peripheral browsing via an embedded "Cortex Peripherals"window. - -![Figure 47](res/Fig47.jpg) - -Alternatively, *watch expressions* can be used. These can be set for registers and variables. (For example, the `sysctrl` register below). - -![image](https://user-images.githubusercontent.com/38844790/177819247-ccf90782-e1e6-44f2-8605-c39fc15c09a6.png) - -- Adding **`,b`** lets you print out the value in **binary** -- Adding **`,x`** prints the value in **hex**. -- Standard **logical** and **bitwise** operations are supported inside the watch expression. -- **Register** and **variable** values can be **modified** through these same watch-points. _(Right click -> Set Value)_ - -It should be noted that the debugger's watch points are *contextual*, meaning that its symbol look-ups will depend on the active point in your program. - -#### Disassembly View - -Stepping through disassembly is supported and enabled by the [Cortex-Debug](https://marketplace.visualstudio.com/items?itemName=marus25.cortex-debug) launch profile. - -![Figure 48](res/Fig48.jpg) - -To open the disassembly view: - -1. [Launch a debug session](#arm-core-debugging) with the `Debug Arm (Cortex-Debug)` profile. - -2. Open the developer command prompt with `CTRL + SHIFT + P`. - -3. Run the "Open Disassembly View" developer command. - - ![Figure 49](res/Fig49.jpg) - - Alternatively, right click -> "Open Disassembly View" - - ![Figure 50](res/Fig50.jpg) - -4. The debugger will step through whichever window has the active focus. Set the focus to the disassembly window to step through the assembly code. - -See the [Cortex-Debug Wiki](https://github.com/Marus/cortex-debug/wiki/Disassembly-Debugging) for more details. - -#### Dual Core Debugging - -For microcontrollers with _both_ an Arm M4 and a RISC-V core, the _GDB (RISC-V)_ launch profile is provided to enable RISC-V debugging. - -???+ 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. - -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: - - ![Debugger-EvKIT Connections](https://user-images.githubusercontent.com/38844790/190749647-f4ef066a-afcc-4749-bb9c-53c7e33e2cf9.jpg) - - ???+ warning "**⚠️ Olimex Drivers**" - If connection issues occur with the Olimex adapter, verify that the drivers are installed correctly. See Section 3.3.3 of the [Olimex User Manual](https://www.olimex.com/Products/ARM/JTAG/_resources/ARM-USB-OCD_and_OCD_H_manual.pdf). The [Zadig](https://zadig.akeo.ie/) tool to install WinUSB drivers. - -2. [Open](#opening-example-projects) the project in VS Code. - -3. Run the "Flash" task. - - ![image](https://user-images.githubusercontent.com/38844790/168398354-2ac2961b-6d45-4f84-8805-0ab5339a4b98.png) - -4. Launch the debugger using the **Debug Arm (Cortex-Debug)** or **GDB (Arm M4)** profile **first**: - - ![Figure 46](res/Fig46.jpg) - - ... which should hit the breakpoint in `main.c`... - ![image](https://user-images.githubusercontent.com/38844790/168398503-0f2ae9c1-f535-4d41-aed9-9d9e19b16303.png) - -5. **Continue** the debugger. The code in `main.c` will boot up the RISC-V core. You can optionally set a breakpoint on `WakeISR` to see when the RISC-V core has signaled it's ready. - - ![image](https://user-images.githubusercontent.com/38844790/168398665-9486e1b6-73bd-481e-a4b5-15dd44c7d7b9.png) - -6. Now, switch the debugger profile to the **GDB (RISC-V) profile** and launch it. This will launch an additional instance on a separate port and connect to the Olimex adapter. - - ![image](https://user-images.githubusercontent.com/38844790/168398707-b6771bf3-b6bf-47a2-b963-b0b9fc003ca4.png) - - ???+ note "ℹ️ **Note: Signal 0 Exception**" - The "Signal 0" exception below is a known issue caused by a signaling mismatch between the RISC-V core and VS Code's debugger engine. The exception message is harmless and can be safely ignored. - - ![image](https://user-images.githubusercontent.com/38844790/168399130-95fe7539-fb46-4c06-a268-6b720403b539.png) - -7. From here, the debugger should be fully functional. The Arm vs. RISC-V debugger instance can be selected with the dropdown on the debugger control bar. - - ![image](https://user-images.githubusercontent.com/38844790/168399419-d0488a0e-2068-4cc7-9108-0a296fdc04b4.png) - -### Project Settings - -`.vscode/settings.json` is the main project configuration file. Values set here are parsed into the other .json config files. - -**When a change is made to this file, VS Code should be reloaded with CTRL+SHIFT+P -> Reload Window (or alternatively restarted completely) to force a re-parse.** - -![Reload Window](https://raw.githubusercontent.com/analogdevicesinc/VSCode-Maxim/main/img/reload_window.JPG) - -The default project configuration should work for most use cases as long as [`"target"`](#target) and [`"board"`](#board) are set correctly. - -???+ note "ℹ️ **Note**" - Any field from `settings.json` can be referenced from any other VS Code config file (including itself) with `"${config:[fieldname]}"` - -The following configuration options are available: - -#### `"MAXIM_PATH"` - -* This option must point to the root installation directory of the MSDK. -* It should be placed in the _global_ user settings.json file during first-time VSCode-Maxim setup. See [Getting Started with Visual Studio Code](#getting-started-with-visual-studio-code). - -#### `"target"` - -* This sets the target microcontroller for the project. -* It sets the `TARGET` [Build Configuration](#build-configuration-variables) variable. - -#### `"board"` - -* This sets the target board for the project (ie. Evaluation Kit, Feather board, etc.) -* See [How to Set the BSP (VS Code)](#how-to-set-the-bsp-vs-code) - -#### `"terminal.integrated.env.[platform]:Path"` - -* This prepends the location of the MSDK toolchain binaries to the system `Path` used by VSCode's integrated terminal. -* The Path is not sanitized by default, which means that the terminal inherits the system path. - -#### `"project_name"` - -* Sets the name of project. This is used in other config options such as `program_file`. -* Default value: `"${workspaceFolderBasename}"` - -#### `"program_file"` - -* Sets the name of the file to flash and debug. This is provided in case it's needed, but for most use cases should be left at its default. -* File extension must be included. -* Default value: `"${config:project_name}.elf"` - -#### `"symbol_file"` - -* Sets the name of the file that GDB will load debug symbols from. -* File extension must be included. -* Default value: `"${config:program_file}"` - -#### `"M4_OCD_interface_file"` - -* Sets the OpenOCD interface file to use to connect to the Arm M4 core. This should match the debugger being used for the M4 core. -* The `MaximSDK/Tools/OpenOCD/scripts/interface` folder is searched for the file specified by this setting. -* `.cfg` file extension must be included. -* Default value: `"cmsis-dap.cfg"` - -#### `"M4_OCD_target_file"` - -* Sets the OpenOCD target file to use for the Arm M4 core. This should match the target microcontroller. -* `.cfg` file extension must be included. -* The `MaximSDK/Tools/OpenOCD/scripts/target` folder is searched for the file specified by this setting. -* Default value: `"${config:target}.cfg"` - -#### `"RV_OCD_interface_file"` - -* Sets the OpenOCD interface file to use to connect to the RISC-V core. This should match the debugger being used for the RISC-V core. -* The `MaximSDK/Tools/OpenOCD/scripts/interface` folder is searched for the file specified by this setting. -* `.cfg` file extension must be included. -* Default value: `"ftdi/olimex-arm-usb-ocd-h.cfg"` - -#### `"RV_OCD_target_file"` - -* Sets the OpenOCD target file to use for the RISC-V core. -* The `MaximSDK/Tools/OpenOCD/scripts/target` folder is searched for the file specified by this setting. -* `.cfg` file extension must be included. -* Default value: `"${config:target}_riscv.cfg"` - -#### `"v_Arm_GCC"` - -* Sets the version of the Arm Embedded GCC to use, including toolchain binaries and the standard library version. -* This gets parsed into `ARM_GCC_path`. -* Default value: `"10.3"` - -#### `"v_xPack_GCC"` - -* Sets the version of the xPack RISC-V GCC to use. -* This gets parsed into `xPack_GCC_path`. -* Default value: `"12.2.0-3.1"` - -#### `"OCD_path"` - -* Where to find the OpenOCD. -* Default value: `"${config:MAXIM_PATH}/Tools/OpenOCD"` - -#### `"ARM_GCC_path"` - -* Where to find the Arm Embedded GCC Toolchain. -* Default value: `"${config:MAXIM_PATH}/Tools/GNUTools/${config:v_Arm_GCC}"` - -#### `"xPack_GCC_path"` - -* Where to find the RISC-V GCC Toolchain. -* Default value: `"${config:MAXIM_PATH}/Tools/xPack/riscv-none-elf-gcc/${config:v_xPack_GCC}"` - -#### `"Make_path"` - -* Where to find Make binaries (only used on Windows) -* Default value: `"${config:MAXIM_PATH}/Tools/MSYS2/usr/bin"` - -#### `"C_Cpp.default.includePath"` - -* Which paths to search to find header (.h) files. -* Does not recursively search by default. To recursively search, use `/**`. - -#### `"C_Cpp.default.browse.path"` - -* Which paths to search to find source (.c) files. -* Does not recursively search by default. To recursively search, use `/**`. - -#### `"C_Cpp.default.defines"` - -* Sets the compiler definitions to use for the intellisense engine. -* Most definitions should be defined in header files, but if a definition is missing it can be entered here to get the intellisense engine to recognize it. - -### Setting Search Paths for Intellisense - -VS Code's intellisense engine must be told where to find the header files for your source code. By default, the MSDK's peripheral drivers, the C standard libraries, and all of the sub-directories of the workspace will be searched for header files to use with Intellisense. If VS Code throws an error on an `#include` statement (and the file exists), then a search path is most likely missing. - -To add additional search paths : - -1. Open the `.vscode/settings.json` file. - -2. Add the include path(s) to the `C_Cpp.default.includePath` list. The paths set here should contain header files, and will be searched by the Intellisense engine and when using "Go to Declaration" in the editor. - -3. Add the path(s) to any relevant implementation files to the `C_Cpp.default.browse.path` list. This list contains the paths that will be searched when using "Go to Definition". - -### Project Creation - -#### Option 1. Copying a Pre-Made Project - -Copying a pre-made example project is a great way to get rolling quickly, and is currently the recommended method for creating new projects. - -The release package for this project (Located at `Tools/VSCode-Maxim` in the MSDK) contains a `New_Project` folder designed for such purposes. Additionally, any of the VS Code-enabled Example projects can be copied from the MSDK. - -1. Copy the existing project folder to an accessible location. This will be the location of your new project. - - ???+ warning "**⚠️ Warning**" - The full path to the project must _not_ have any spaces in it. - -2. (Optional) Rename the folder. For example, I might rename the folder to `MyProject`. - -3. Open the project in VS Code (`File -> Open Folder...`) - -4. Set your [target](#target) microcontroller and [board](#board) correctly. - -5. `CTRL+SHIFT+P -> Reload Window` to re-parse the project settings. - -6. That's it! The existing project is ready to build, debug, and modify. - -#### Option 2 - Injecting - -VSCode-Maxim releases provide the `Inject` folder for "injecting" into an existing folder. If you want to start from scratch or use the project files with existing source code, take this option. - -1. Create your project folder if necessary. For example, I might create a new project in a workspace folder with the path: `C:/Users/Jake.Carter/workspace/MyNewProject`. - -2. Copy the **contents** of the `Inject` folder into the project folder from step 1. The contents to copy include a `.vscode` folder, a `Makefile`, and a `project.mk` file. For this example, the contents of the 'MyProject' folder would be the following: - - :::shell - C:/Users/Jake.Carter/workspace/MyNewProject - |- .vscode - |- Makefile - |- project.mk - -3. Open the project in VS Code (`File -> Open Folder...`) - -4. Set your [target](#target) microcontroller and [board](#board) correctly. - -5. `CTRL+SHIFT+P -> Reload Window` to re-parse the project settings. - -6. Configure the [build system](#build-system) for use with any pre-existing source code. - -7. That's it! Your new project can now be opened with `File > Open Folder` from within VS Code. - -## Eclipse - -For setup/quick-start instructions, see ["Getting Started with Eclipse"](#getting-started-with-eclipse) first. This section offers detailed usage info focusing on the typical development cycle. - -### Running Eclipse - -Eclipse _must_ be launched with the **Eclipse MaximSDK** shortcut. The shortcut points to the `Tools/Eclipse/cdt/eclipse(.bat/.sh)` file, which configures Eclipse's system environment for use with the MSDK toolchain. - -![Figure 22](res/Fig22.jpg) - -When Eclipse is launched, it will prompt for a **_workspace_** location. This is a local folder that Eclipse will copy its projects into. - -![Figure 39](res/Fig39.jpg) - -### Creating a New Project - -1. [Launch](#running-eclipse) Eclipse. - -2. Ensure that the Eclipse is set to the **C/C++ perspective** in the top right corner. Otherwise, the new project wizard will not show up. - -3. Navigate to **File -> New -> Maxim Microcontrollers**. - - ![Figure 31](res/Fig31.jpg) - -4. Enter the project name and hit **Next**. - - ![Figure 32](res/Fig32.jpg) - -5. Follow the new project wizard. - - - Chip type selects the _Target Microcontroller_ - - Board type selects the [_Board Support Package (BSP)_](#board-support-packages) - - Example type selects the example project to be copied as the template for the new project. - - Adapter type selects the debug adapter to use. - - ![Figure 33](res/Fig33.jpg) - -6. Select **Finish** to create the new project. - -### Importing Examples - -1. [Launch](#running-eclipse) Eclipse. - -2. Use **File -> Import** to open the import wizard. - -3. Select **General -> Existing Projects into Workspace** and hit **Next**. - - ![Figure 23](res/Fig23.jpg) - -4. **Browse** to the [`Examples`](https://github.com/analogdevicesinc/msdk/tree/main/Examples) folder in the MSDK installation for your target microcontroller and select the example projects to import into the workspace. - - ![Figure 24](res/Fig24.jpg) - -5. Ensure that **Copy projects into workspace** is selected. This will copy the projects out of the MSDK and leave the originals unmodified. - -6. Select **Finish** to import the project(s). - -7. The projects should now show up in the Project Explorer. - - ![Figure 25](res/Fig25.jpg) - -### How to Set the BSP (Eclipse) - -[Imported](#importing-examples) Eclipse projects files are configured for the **EVKIT**-type _BSP_ by default. To set the BSP: - -1. Right click the project name and select _Properties_. Navigate to **C/C++ Build -> Environment**. -2. Set the **`BOARD`** _[Build Configuration Variable](#build-tables)_ to match the target evaluation platform. - - See [Board Support Packages](#board-support-packages) for a table of possible values. - - ![Figure 26](res/Fig26.jpg) - -3. **clean** and rebuild the project. - -### Building a Project - -1. Ensure that the Eclipse is set to the **C/C++ perspective** (top right). - -2. Select the correct project in the **Launch Configuration** dropdown. - -3. Use the **Build** hammer button (top left) to build the project. - - ![Figure 27](res/Fig27.jpg) - -### Flashing and Debugging - -1. Connect a debug adapter between the host PC and the evaluation platform. For more detailed instructions on this hardware setup, refer to the evaluation platform's Datasheet and Quick-Start Guide, which are available on its [analog.com](https://analog.com) product page. - -2. Ensure the correct project in the **Launch Configuration** dropdown is selected in **Debug** mode. - -3. Use the **Debug** button (top left) to flash the program binary and connect the debugger. - - ![Figure 28](res/Fig28.jpg) - -4. The Eclipse view will switch to debug mode, and the debugger will break on entry into the main. - - ![Figure 29](res/Fig29.jpg) - -5. **Resume** the program (**`F8`**) using the top control bar and exercise the debugger. - - ![Figure 30](res/Fig30.jpg) - -6. **Terminate** the debugger (**`CTRL+F2`**) when finished. - -#### Segger J-Link Setup Guide (Eclipse) - -Eclipse offers built-in support for Segger J-Link debuggers. J-Link debugging can be enabled following the steps below: - -1. Download and install the latest Segger J-Link Software and Documentation from [**here**](https://www.segger.com/downloads/jlink/) - -2. Follow the instructions from the Segger J-Link Eclipse plugin [**here**](https://eclipse-embed-cdt.github.io/debug/jlink/) with the following modifications specific to the MSDK. Other options an be left at their defaults. - - 1. Modify the Executable name under "GDB Client Setup" to `arm-none-eabi-gdb${cross_suffix}` - - ![Figure 44](res/Fig44.jpg) - - 2. Modify the "Startup" options to issue a `monitor reset halt` under initialization commands and _uncheck_ `Pre-run/Restart reset` - - ![Figure 45](res/Fig45.jpg) - -## Keil MDK - -The [Keil MDK Microcontroller Development Kit](https://www2.keil.com/mdk5) is developed and maintained by Arm. ADI maintains CMSIS Pack files supporting this environment. - -Supporting documentation is maintained by Arm, and can be found on the [**MDK5 page**](https://www2.keil.com/mdk5). The latest pack files can be found under the "Maxim" section of the [device list](https://www.keil.com/dd2/). - -## IAR Embedded Workbench - -IAR Embedded Workbench is a third-party IDE that requires a software license. ADI maintains support files for this IDE in the form of CMSIS Pack files. - -Supporting documentation is maintained by IAR, and can be found on the [**Embedded Workbench Product Page**](https://www.iar.com/products/architectures/arm/iar-embedded-workbench-for-arm/) under "User Guides and documentation". - -## Command-Line Development - -This section offers more detailed info on command-line development. - -For setup/quick-start, see ["Getting Started with Command-Line Development"](#getting-started-with-command-line-development). - -### How to Set the BSP (Command-Line) - -- To _persistently_ the BSP, set the **`BOARD`** _[Build Configuration Variable](#build-configuration-variables)_ by editing the **project.mk** that can be found inside each project. - - :::makefile - # This file can be used to set build configuration - # variables. These variables are defined in a file called - # "Makefile" that is located next to this one. - - # For instructions on how to use this system, see - # https://analogdevicesinc.github.io/msdk/USERGUIDE/ - - # ********************************************************** - - # Add your config here! - - BOARD=FTHR_RevA # Set the BSP for the MAX78000FTHR - -- Alternatively, set **`BOARD`** on the command line when building (i.e., `make -r -j BOARD=FTHR_RevA`) to set/override the BSP for a single build. - -### Building on the Command-Line - -1. `cd` into the project folder. - -2. Run `make` - - - **Parallel Build** (fastest build, but console message formatting may be mangled): - - make -r -j - - - **Serial Build** - - make -r - -3. Take note of the output filename and location, which by default is the lowercase name of the _Target microcontroller_ and created in the `build` folder. - -### Cleaning on the Command-Line - -1. `cd` into the project folder. -2. Run `make clean` - - **Project clean**: `make clean` deletes the project `build` folder and all of its contents. - - **Library clean**: `make distclean` can be used to clean out _all_ build products, including the project `build` folder and all [peripheral driver](#peripheral-driver-api) libraries. - -### Flashing on the Command-Line - -???+ note "ℹ️ **A Note on Flashing**" - The commands below are not a comprehensive list of all the possible options for flashing. They are the most common and useful ones. For full documentation, see the "Flash Programming" section of the [**OpenOCD User Manual**](https://openocd.org/doc/pdf/openocd.pdf) - -1. [Build](#building-on-the-command-line) the project. - -2. Connect a debug adapter between the host PC and the evaluation platform. For more detailed instructions on this hardware setup, refer to the evaluation platform's Datasheet and Quick-Start Guide, which are available on its [analog.com](https://analog.com) product page. - -3. Flash the program using `openocd`. It's recommended to use the `make` command below for convenience. - - - ???+ note "ℹ️ **Flashing with Make**" - - :::shell - make flash.openocd - - Expected output: - - :::bash - Open On-Chip Debugger 0.11.0+dev-g4cdaa275b (2022-03-02-09:57) - Licensed under GNU GPL v2 - For bug reports, read - http://openocd.org/doc/doxygen/bugs.html - DEPRECATED! use 'adapter driver' not 'interface' - Info : CMSIS-DAP: SWD supported - Info : CMSIS-DAP: Atomic commands supported - Info : CMSIS-DAP: Test domain timer supported - Info : CMSIS-DAP: FW Version = 0256 - Info : CMSIS-DAP: Serial# = 044417016af50c6500000000000000000000000097969906 - Info : CMSIS-DAP: Interface Initialised (SWD) - Info : SWCLK/TCK = 1 SWDIO/TMS = 1 TDI = 0 TDO = 0 nTRST = 0 nRESET = 1 - Info : CMSIS-DAP: Interface ready - Info : clock speed 2000 kHz - Info : SWD DPIDR 0x2ba01477 - Info : max32xxx.cpu: Cortex-M4 r0p1 processor detected - Info : max32xxx.cpu: target has 6 breakpoints, 4 watchpoints - Info : starting gdb server for max32xxx.cpu on 3333 - Info : Listening on port 3333 for gdb connections - Info : SWD DPIDR 0x2ba01477 - target halted due to debug-request, current mode: Thread - xPSR: 0x81000000 pc: 0x0000fff4 msp: 0x20003ff0 - ** Programming Started ** - ** Programming Finished ** - ** Verify Started ** - ** Verified OK ** - ** Resetting Target ** - Info : SWD DPIDR 0x2ba01477 - shutdown command invoked - - This command is a build target added to the MSDK as of the [June 2023 Release](https://github.com/analogdevicesinc/msdk/releases/tag/v2023_06) to make flashing over the command-line easier. It will **flash** _and_ **run** the project with OpenOCD. See the `Tools/Flash/flash.mk` file for implementation details. - - - ???+ note "ℹ️ **OpenOCD Flash & Hold**" - The following command template can be used if you just want to flash the program with OpenOCD manually, and halt the target micro. This is used when you want to start a command-line debugging session. - - :::shell - openocd -s $MAXIM_PATH/Tools/OpenOCD/scripts -f interface/cmsis-dap.cfg -f target/.cfg -c "program build/.elf verify; init; reset halt" - - - ???+ note "**ℹ️ `-s $MAXIM_PATH/Tools/OpenOCD/scripts`**" - This option tells OpenOCD to search the `Tools/OpenOCD/scripts` folder of the MSDK installation for files. - ???+ warning "**⚠️ Warning: Windows**" - On Windows you should use `%MAXIM_PATH%` (Command Prompt) or `$env:MAXIM_PATH` (PowerShell) to dereference the `MAXIM_PATH` environment variable - - - ???+ note "**ℹ️ `-f target/.cfg`**" - This option loads an OpenOCD config file for the _target microcontroller_. Supported options can be found in the `Tools/OpenOCD/scripts/target` folder. - ???+ warning "⚠️**Change `` to match the target micro**" - - - ???+ note "**ℹ️ `-f interface/cmsis-dap.cfg`**" - This option loads an OpenOCD config file for the MAX32625PICO SWD debugger that is included with most EVKITs. You may need to change this option for other debuggers. Supported options can be found in the `Tools/OpenOCD/scripts/interface` folder. - - - ???+ note "`-c "program build/.elf verify; init; reset halt"`" - This command flashes the program binary (`program`), performs a flash verification (`verify`), initializes the connection to the target micro (`init`), and finally resets/halts the micro to prepare for debug (`reset halt`). - - Expected output: - - :::bash - Open On-Chip Debugger 0.11.0+dev-g4cdaa275b (2022-03-02-09:57) - Licensed under GNU GPL v2 - For bug reports, read - http://openocd.org/doc/doxygen/bugs.html - DEPRECATED! use 'adapter driver' not 'interface' - Info : CMSIS-DAP: SWD supported - Info : CMSIS-DAP: Atomic commands supported - Info : CMSIS-DAP: Test domain timer supported - Info : CMSIS-DAP: FW Version = 0256 - Info : CMSIS-DAP: Serial# = 044417016af50c6500000000000000000000000097969906 - Info : CMSIS-DAP: Interface Initialised (SWD) - Info : SWCLK/TCK = 1 SWDIO/TMS = 1 TDI = 0 TDO = 0 nTRST = 0 nRESET = 1 - Info : CMSIS-DAP: Interface ready - Info : clock speed 2000 kHz - Info : SWD DPIDR 0x2ba01477 - Info : max32xxx.cpu: Cortex-M4 r0p1 processor detected - Info : max32xxx.cpu: target has 6 breakpoints, 4 watchpoints - Info : starting gdb server for max32xxx.cpu on 3333 - Info : Listening on port 3333 for gdb connections - Info : SWD DPIDR 0x2ba01477 - target halted due to debug-request, current mode: Thread - xPSR: 0x81000000 pc: 0x0000fff4 msp: 0x20003ff0 - ** Programming Started ** - ** Programming Finished ** - ** Verify Started ** - ** Verified OK ** - Info : Listening on port 6666 for tcl connections - Info : Listening on port 4444 for telnet connections - # Note: OpenOCD is now waiting for a GDB client connection - -### Debugging on the Command-Line - -1. [Flash](#flashing-on-the-command-line) the program using the **Flash and Hold** command above. - -2. Launch an **_new_ separate terminal**. - - ???+ warning "⚠️ On **Windows**, use the MinGW shortcut or `Tools/MSYS2/msys.bat` file to launch the MSYS2 terminal." - -3. `cd` into the location of the copied example project. - -4. Run the following command to launch a **GDB *client***. - - arm-none-eabi-gdb --se=build/.elf - - - ???+ note "**ℹ️ `--se=build/.elf`**" - This sets the symbol and executable file to the compiled program file. - ???+ warning "⚠️ **Change this to match the build output filename.**" - - Expected output: - - :::bash - GNU gdb (GNU Arm Embedded Toolchain 10.3-2021.10) 10.2.90.20210621-git - Copyright (C) 2021 Free Software Foundation, Inc. - License GPLv3+: GNU GPL version 3 or later - This is free software: you are free to change and redistribute it. - There is NO WARRANTY, to the extent permitted by law. - Type "show copying" and "show warranty" for details. - This GDB was configured as "--host=i686-w64-mingw32 --target=arm-none-eabi". - Type "show configuration" for configuration details. - For bug reporting instructions, please see: - . - Find the GDB manual and other documentation resources online at: - . - - For help, type "help". - Type "apropos word" to search for commands related to "word"... - Reading symbols from build/max78002.elf... - (gdb) - - ???+ note "**ℹ️ Note**" - The terminal is now in an interactive GDB client window. It accepts GDB commands. Run `help` at any time, or see [Common GDB Commands](#common-gdb-commands) in this document. - -5. Connect the GDB Client to the OpenOCD server with the following command. - - target extended-remote localhost:3333 - - Expected output: - - :::bash - Remote debugging using localhost:3333 - 0x0000fff4 in ?? () # Note: ?? may be present at this stage, which is OK. - -6. Reset the target microcontroller. - - monitor reset halt - - Expected output: - - :::bash - SWD DPIDR 0x2ba01477 - target halted due to debug-request, current mode: Thread - xPSR: 0x81000000 pc: 0x0000fff4 msp: 0x20003ff0 - -7. Set a breakpoint on `main`. - - b main - - Expected output: - - :::bash - Breakpoint 1 at 0x10000224: file main.c, line 62. - Note: automatically using hardware breakpoints for read-only addresses. - -8. Continue the debugger. - - continue - - Expected output (for the Hello World example): - - :::bash - Continuing. - - Breakpoint 1, main () at main.c:62 - 62 printf("Hello World!\n"); - -9. (Optional) Continue exercising the debugger. - -10. Quit GDB. - - quit - - Expected output: - - :::bash - A debugging session is active. - - Inferior 1 [Remote target] will be detached. - - Quit anyway? (y or n) [answered Y; input not from terminal] - Detaching from program: C:\Users\User\codespace\Hello_World\build\max78002.elf, Remote target - [Inferior 1 (Remote target) detached] - -11. Quit OpenOCD. In the terminal window running the OpenOCD _server_, press `CTRL + C` to issue the shutdown command. - -### Common GDB Commands - -| **Command** | **Short Command** | **Description** | -| ------------------------------- | ----------------- | ------------------------------------------------------------ | -| `monitor halt` | | Halt the microcontroller. | -| `monitor reset halt` | | Reset the microcontroller and immediately halt. | -| `monitor max32xxx mass_erase 0` | | Mass erase flash bank 0. | -| `file ` | | Set the program file to `` | -| `load` | | Flash the current program file | -| `continue` | `c` | Continue execution. | -| `break ` | `b ` | Set a breakpoint. `` can be a function name, file:line\_number, or address. | -| `print ` | `p` | Print the value of a variable. The variable must be in the current scope. | -| `backtrace` | `bt` | Print contents of the stack frame. | -| `step` | `s` | Execute the next instruction. | -| `next` | `n` | Execute the next line of code. | -| `finish` | `f` | Continue to the end of the current function. | -| `info reg` | | Print the values of the ARM registers. | -| `help` | | Print descriptions for available commands | -| `help ` | | Print description for given command. | -| `quit` | `q` | Quit the GDB client | - -## Build System - -### Build System Overview - -The **Build System** manages the compilation of source code into program binaries and offers a **Command-Line Interface (CLI)** for setting **Build Configuration Variables**. All IDEs interface with this system. - -The Build System is managed by two files found in a project's root directory, one called **Makefile** and one called **project.mk**. These files are used by the [GNU Make](https://www.gnu.org/software/make/) program (which is a part of the MSDK toolchain) to locate and build a project's source code. - -* **Makefile** is the "core" file and should not be edited directly. Instead, it exposes the **CLI** that can be accessed in the _project.mk_ file, on the command line, in your system's environment, or through your IDE. It also comes with a default configuration that is suitable for most projects. -* **project.mk** offers a convenient and stable access point for advanced build configuration, and this is the file that should be edited if necessary. - -When the command - - make - -is run from inside of a project folder, the program `make` will resolve any project-specific settings and then build the project's source code. - -### Default Build Behavior - -By default, the build system will **auto-search** the **root** project directory for _source code_ (**`*.c`**) and _header files_ (**`*.h`**) to compile into a program binary. The _optional_ **include** and **src** directories are also searched if they exist. - - :::bash - Root Project Directory - ├─ project.mk - ├─ Makefile - ├─ *.h - ├─ *.c - ├─include # <-- Optional - └─ *.h - ├─src # <-- Optional - └─ *.c - -Additionally, a project's build system will come pre-configured for a specific _Target Microcontroller_ and its primary _BSP_. - -The default configuration is suitable for most use cases, but a system of _Build Configuration Variables_ is available if additional configuration is needed. - -### Build Configuration Variables - -A **Build Configuration Variable** is a [Makefile variable](https://www.gnu.org/software/make/manual/make.html#Using-Variables) and therefore follows the same rules. However, they have been streamlined to be made much easier to use, so most of the [official GNU Make documentation](https://www.gnu.org/software/make/manual/make.html) is only needed for advanced use cases. - -#### How to Set a Build Configuration Variable - -To set a **standard** configuration variable, **use the `=` syntax**... - - VARIABLE=VALUE - -The **`=`** operator is used for _most_ configuration variables with a few exceptions (documented in the [reference table](#build-tables)) when a variable should contain a **_list_ of values**. In such cases, **use `+=` the syntax** to _add_ values to the list. - - VARIABLE+=VALUE1 - VARIABLE+=VALUE2 - -#### Where to Set a Build Configuration Variable - -For most variables, you should set them in the **project.mk** file (exceptions are documented in the [reference table](#build-tables) and IDE-specific sections). - -For example, to enable hardware floating-point acceleration for a project, the **`MFLOAT_ABI`** configuration variable can be used with a value of **`hard`**. The contents of **project.mk** might then look as follows: - -(_Inside project.mk_) - - :::Make - # This file can be used to set build configuration - # variables. These variables are defined in a file called - # "Makefile" that is located next to this one. - - # For instructions on how to use this system, see - # https://analogdevicesinc.github.io/msdk/USERGUIDE/ - - # ********************************************************** - - MFLOAT_ABI=hard # Enable hardware floating point acceleration - -It should also be noted that configuration variables can be set on the **command line** as well. For example - - make MFLOAT_ABI=hard - -will have the same effect. - -Additionally, **environment variables** can be used. For example (on Linux) - - export MFLOAT_ABI=hard - -will set the hardware floating point acceleration as the default for all projects with an environment variable. - -However, there is a _precedence hierarchy_ that should be taken into consideration. - -#### Precedence Hierarchy - -The precedence hierarchy for the value of a configuration variable is: - -- **IDE/command-line > project.mk > environment variable > default value** - -If a value is set in an IDE _and_ project.mk, the IDE's value will take precedence. However, the ["override" directive](https://www.gnu.org/software/make/manual/make.html#Override-Directive) can be used in project.mk to give it max precedence. - -### Build Tables - -The following sections present the available [Build Configuration Variables](#build-configuration-variables). - -#### Primary Build Variables - -| Configuration Variable | Description | Details | -| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| `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-packages) 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](#bsp-search-directory) for more details. | - -#### Project Build Variables - -The following variables deal with fundamental project tasks such as adding source code, include paths, changing the output filename, etc. - -| Configuration Variable | Description | Details | -| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| `VPATH` | Where to search for source (.c/.cpp) files | **Use the `+=` operator with this variable**. This controls where the Makefile will look for **source code** files. If `AUTOSEARCH` is enabled (which it is by default), all source code files in the directories specified by this option will be automatically added to the build. If `AUTOSEARCH` is disabled, this tells the Makefile where to look for the files specified by `SRCS`. | -| `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](#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.
Ex: Give a file called `libEXAMPLE.a`, write `PROJ_LIBS += EXAMPLE`
Additionally, ensure that the location of the library is added to `PROJ_LDFLAGS`.
Ex: `PROJ_LDFLAGS += -Lsome/library/search/directory` | - -#### Build Variables for the Compiler - -The following variables can be used to interface with the compiler to perform common tasks such as changing the optimization level, adding compiler definitions to the build, and changing floating point acceleration. - -| Configuration Variable | Description | Details | -| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| `MXC_OPTIMIZE_CFLAGS` | Set the optimization level | See [Optimize Options](https://gcc.gnu.org/onlinedocs/gcc/Optimize-Options.html) for more details. Normal builds will default to `-Og`, which is good for debugging, while release builds will default to `-O2`. | -| `PROJ_CFLAGS` | Add compiler flags to the build | **Use the `+=` operator with this variable**. Compiler flags can be added with this option, including compiler definitions. For each value, the same syntax should be used as if the compiler flag was passed in over the command line. These can include standard [GCC options](https://gcc.gnu.org/onlinedocs/gcc-10.4.0/gcc/Option-Summary.html#Option-Summary) and/or [ARM-specific](https://gcc.gnu.org/onlinedocs/gcc/ARM-Options.html) options. | -| `PROJ_AFLAGS` | Add assemblers flag to the build | **Use the `+=` operator with this variable**. Assembler flags can be added with this option. | -| `PROJ_OBJS` | Add object files to the build | **Use the `+=` operator with this variable**. If needed, object files (.o) can be added to the build with this option. | -| `DEBUG` | Toggle extra debug information | Set this to `1` to enable extra debug information at compile time. This generally improves the reliability of debugging at some increase in code size. Set to `0` to disable. - -#### Build Variables for the Linker - -| Configuration Variable | Description | Details | -| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| `LINKERFILE` | Set the linkerfile to use | A linkerfile is responsible for specifying the available memory banks, their layout, and the organization of program binaries memory. The file should exist in `Libraries/CMSIS/Device/Maxim/TARGET/Source/GCC` in the MSDK, or it should be placed inside the root directory of the project. | -| `PROJ_LDFLAGS` | Add a linker flag to the build | **Use the `+=` operator with this variable**. Flags can be passed to the linker with this option. See [GCC Options for Linking](https://gcc.gnu.org/onlinedocs/gcc/Link-Options.html#Link-Options) | - -#### Build Variables for Arm Cores - -The following build variables are used to control options specific to the Arm Cortex-M4 core available. They are available on all microcontrollers, and for all projects unless that project is built for a RISC-V core. - -| Configuration Variable | Description | Details | -| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| `MFLOAT_ABI` | Set the floating point acceleration level | Sets the floating-point acceleration level. Permitted values are `hard`, `soft`, and `softfp` (default). To enable full hardware acceleration instructions, use `hard`, but keep in mind that _all_ libraries your source code uses must also be compiled with `hard`. If there is any conflict, you'll get a linker error. For more details, see `-mfloat-abi` under [ARM Options](https://gcc.gnu.org/onlinedocs/gcc/ARM-Options.html). | -| `DEFAULT_OPTIMIZE_FLAGS` | Override the default extra optimization flags | Extra compiler optimization flags are added to the build. They are defined in `Libraries/CMSIS/Device/Maxim/GCC/gcc.mk`. These can be disabled entirely by setting this variable to empty (`DEFAULT_OPTIMIZE_FLAGS=`). | -| `DEFAULT_WARNING_FLAGS` | Override the default warning flags | Default flags controlling warning output are added in `Libraries/CMSIS/Device/Maxim/GCC/gcc.mk`. These can be disabled entirely by setting this variable to empty (`DEFAULT_OPTIMIZE_FLAGS=`). | -| `MCPU` | Set the processor type | Set the target ARM processor. Directly maps to `-mcpu` under [ARM Options](https://gcc.gnu.org/onlinedocs/gcc/ARM-Options.html). This flag is handled by the MSDK and not typically changed manually. | -| `MFPU` | Set the FPU architecture | Set the floating point unit (FPU) architecture. Directly maps to `-mfpu` under [ARM Options](https://gcc.gnu.org/onlinedocs/gcc/ARM-Options.html). This flag is handled by the MSDK and not typically changed manually. | - -#### Build Variables for RISC-V Cores - -The following build variables are used for RISC-V development. They are only available on microcontrollers with RISC-V cores. - -| Configuration Variable | Description | Details | -| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| `RISCV_CORE` | Build a project for the RISC-V core | Set to `1` to convert an entire project to use the RISC-V toolchain. Only available on microcontrollers with a RISC-V core. | -| `RISCV_LOAD` | Compile and load project for the RISC-V core | **Only available on the MAX32655, MAX32680, and MAX32690**. Set to `1` compile the project specified by `RISCV_APP` for the RISC-V core and link it into the same binary as the current project. Useful for dual-core projects. -| `RISCV_APP` | Project folder to compile for the `RISCV_LOAD` option | **Only available on the MAX32655, MAX32680, and MAX32690**. This option specifies the project to build for the RISC-V core when `RISCV_LOAD` is enabled. Must be a path relative to the project that enables `RISCV_LOAD`, or an absolute path. | -| `RISCV_PREFIX` | Change the toolchain prefix | This option can be used to override the GCC toolchain prefix if needed. For example, to use the legacy RISC-V toolchain `RISCV_PREFIX = riscv-none-embed` will attempt to compile with `riscv-none-embed-gcc`. | - -#### Build Variables for Toggling Libraries - -The following variables can be used to enable the [available libraries](#libraries) in the MSDK. Each library may also offer its own build configuration variables when enabled, which are documented in the [libraries](#libraries) section. - -| Configuration Variable | Description | Details | -| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| `LIB_BOARD` | Include the BSP library (enabled by default) | Inclusion of the Board-Support Package (BSP) library, which is enabled by default, can be toggled with this variable. Set to `0` to disable or `1` to enable. | -| `LIB_PERIPHDRIVERS` | Include the peripheral driver library (enabled by default) | The peripheral driver library can be toggled with this option. If disabled, you'll lose access to the higher-level driver functions but still have access to the register-level files. Set to `0` to disable or `1` to enable. | -| `LIB_CMSIS_DSP` | Include the CMSIS-DSP library | The [CMSIS-DSP library](https://www.keil.com/pack/doc/CMSIS/DSP/html/index.html) can be enabled with this option. Set to `0` to disable or `1` to enable. | -| `LIB_CORDIO` | Include the Cordio library | The Cordio BLE library can be included with this option. This is only applicable for microcontrollers with an integrated BLE controller. | -| `LIB_FCL` | Include the Free Cryptographic Library (FCL) | This option toggles the Free Cryptographic Library (FCL), which is a collection of software-implemented common cryptographic functions that can be included with this option. Set to `0` to disable or `1` to enable. | -| `LIB_FREERTOS` | Include the FreeRTOS library | The [FreeRTOS](https://freertos.org/) library can be enabled with this option, which is an open-source Real-Time Operating System (RTOS). Set to `0` to disable or `1` to enable. | -| `LIB_LC3` | Include the LC3 codec library | This option enables the inclusion of the Low Complexity Communication Codec (LC3), which is an efficient low latency audio codec. Set to `0` to disable or `1` to enable. | -| `LIB_LITTLEFS` | Include the littleFS library | This option toggles the ["Little File System"](https://github.com/littlefs-project/littlefs) library - a small filesystem library designed for microcontrollers. Set to `0` to disable or `1` to enable. | -| `LIB_LWIP` | Include the lwIP library | | -| `LIB_MAXUSB` | Include the MaxUSB library | This option toggles the inclusion of the MAXUSB library, which facilitates the use of the native USB peripherals on some microcontrollers. Set to `0` to disable or `1` to enable. | -| `LIB_TINY_USB` | Include the TinyUSB library | This option toggles the inclusion of the TinyUSB library, which facilitates the use of the native USB peripherals on some microcontrollers. Set to `0` to disable or `1` to enable. | -| `LIB_SDHC` | Include the SDHC library | This option toggles the Secure Digital High Capacity (SDHC) library, which can be used to interface with SD cards. Additionally, it enables the [FatFS](http://elm-chan.org/fsw/ff/00index_e.html) library, which implements a generic FAT filesystem. | -| `LIB_CLI` | Include the MSDK's built-in CLI library | This option toggles the MSDK's built-in CLI library, which can be used to process received commands over UART. | -| `LIB_USS` | Include the USS Library | This option toggles the Unified Security Software library. It is only available via NDA. | - -#### Build Variables for the PeriphDrivers Library - -The following variables are specific to the PeriphDrivers library. - -| Configuration Variable | Description | Details | -| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| `MXC_SPI_VERSION` | Set the SPI drivers to use (default is `v1`) | The PeriphDrivers offer two versions of the SPI API in order to maintain backwards compatibility. Acceptable values are `v1` (legacy) or `v2`. See [The SPI V2 Developer Note](#spi-v2-library) for more details. | - -#### Build Variables for Secure Boot Tools (SBTs) - -For microcontrollers with a secure bootloader, the following build configuration variables can be used to enable integration with the Secure Boot Tools. These are a suite of applications designed for use with microcontrollers that have secure bootloaders. - -| Configuration Variable | Description | Details | -| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| `SBT` | Toggle SBT integration | Toggles integration with the [Secure Boot Tools (SBTs)](https://www.analog.com/en/design-center/evaluation-hardware-and-software/software/software-download.html?swpart=SFW0015360C). These are a suite of applications designed for use with microcontrollers that have secure bootloaders. When this is enabled, some additional rules become available such as `make sla` and `make scpa`. Set to `0` to disable or `1` to enable. | -| `MAXIM_SBT_DIR` | Where to find the SBTs | This option can be used to manually specify the location of the SBTs. Usually, this is not necessary. By default, the `Tools/SBT` directory of the MaximSDK will be searched. If the [SBT installer](https://www.analog.com/en/design-center/evaluation-hardware-and-software/software/software-download.html?swpart=SFW0015360C) is used, it will set the `MAXIM_SBT_DIR` environment variable to point to itself automatically. | -| `TARGET_SEC` | Secure part number to use | Some secure microcontrollers have multiple secure variants, and this option can be used to specify the variant to use with the SBTs. Defaults are intelligently selected and can be found in `$(MAXIM_SBT_DIR)/SBT-config.mk` | -| `SCP_PACKETS` | Where to build the scp_packets folder | Defaults to `build/scp_packets` | -| `TEST_KEY` | Which test key to sign applications with | Defaults to `$(MAXIM_SBT_DIR)/devices/$(TARGET_SEC)/keys/maximtestcrk.key`, which is the Maxim test key that can be used for development. | - -#### Build Variables Controlling the Output - -The following build variables can be used to control how to build output is formatted. - -| Configuration Variable | Description | Details | -| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| `VERBOSE` | Toggle verbose builds | Set to `1` to enable a verbose build that prints exactly what the compiler is doing for each step. This is useful for troubleshooting. -| `FORCE_COLOR` | Force colorized compiler output | By default, GCC will attempt to autodetect whether colorized output is supported or not. Set to `1` to force color (equivalent to `PROJ_CFLAGS += -fdiagnostics-color=always`). This is useful for forcing color in CI systems. | - -## Board Support Packages - -The MSDK supports multiple parts and evaluation platforms (see [supported parts](#supported-parts)) through **"Board Support Packages" (BSPs)**. For microcontrollers with multiple evaluation platforms, multiple BSPs will be available. - -The role of a _BSP_ is to provide a hardware abstraction layer for the initialization and management of board-level hardware such as serial interfaces, pushbuttons, LEDs, external peripheral devices, TFT displays, etc. which will vary between evaluation platforms. The BSP abstraction layer also improves code portability to custom devices. - -???+ note "ℹ️ **Note**" - The first task when opening or creating any project is to ensure the BSP is set correctly. - -### How to Set the BSP - -To set the BSP for a project: - -- In **VS Code**: [How to Set the BSP (VS Code)](#how-to-set-the-bsp-vs-code) -- In **Eclipse**: [How to Set the BSP (Eclipse)](#how-to-set-the-bsp-eclipse) -- **Command-Line** Development: [How to Set the BSP (Command-Line)](#how-to-set-the-bsp-command-line) - -### BSP Table - -Available BSPs are located in the `Libraries/Boards` folder for each _Target Microcontroller_. - -![Figure 34](res/Fig34.jpg) - -The name of a BSP's folder is used with the `BOARD` [build configuration variable](#build-configuration-variables) to build a project for a specific BSP. The table below matches the correct `BOARD` values to _external part numbers_. - -| External Part Number | `TARGET` | `BOARD` | -| ---------------------------------------------|--------------- | -------------- | -| [MAX32520-KIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32520-kit.html) | `MAX32520` | `EvKit_V1` | -| [MAX32520FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32520fthr.html) | `MAX32520` | `MAX32520FTHR` | -| [MAX32650-EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32650-evkit.html) | `MAX32650` | `EvKit_V1` | -| [MAX32650FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32650fthr.html) | `MAX32650` | `FTHR_APPS_A` | -| [MAX32655EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32655evkit.html) | `MAX32655` | `EvKit_V1` | -| [MAX32655FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32655fthr.html) | `MAX32655` | `FTHR_Apps_P1` | -| [MAX32660-EVSYS](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32660-evsys.html) | `MAX32660` | `EvKit_V1` | -| [MAX32662EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/MAX32662EVKIT.html) | `MAX32662` | `EvKit_V1` | -| [MAX32666EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32666evkit.html) | `MAX32665` | `EvKit_V1` | -| [MAX32666FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32666fthr.html) | `MAX32665` | `FTHR` | -| MAX32666FTHR2 | `MAX32665` | `FTHR2` | -| [MAX32670EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32670evkit.html) | `MAX32670` | `EvKit_V1` | -| [MAX32672EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32672evkit.html) | `MAX32672` | `EvKit_V1` | -| [MAX32672FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32672fthr.html) | `MAX32672` | `FTHR` | -| [MAX32675EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32675evkit.html) | `MAX32675` | `EvKit_V1` | -| MAX32675FTHR | `MAX32675` | `FTHR_Apps_B` | -| [MAX32680EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32680evkit.html) | `MAX32680` | `EvKit_V1` | -| [MAX32690EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/MAX32690EVKIT.html) | `MAX32690` | `EvKit_V1` | -| [AD-APARD32690-SL](https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/ad-apard32690-sl.html) | `MAX32690` | `APARD` | -| [MAX78000EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000evkit.html) | `MAX78000` | `EvKit_V1` | -| [MAX78000FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000fthr.html) | `MAX78000` | `FTHR_RevA` | -| [MAXREFDES178](https://www.analog.com/en/design-center/reference-designs/maxrefdes178.html) | `MAX78000` | `MAXREFDES178` | -| MAX78000CAM01 (Engineering samples only) | `MAX78000` | `CAM01_RevA` | -| MAX78000CAM02 (Engineering samples only) | `MAX78000` | `CAM02_RevA` | -| [MAX78002EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78002evkit.html) | `MAX78002` | `EvKit_V1` | - -### Custom BSPs - -For custom boards, additional BSPs can be easily created and added to the MSDK. Inspecting the `Libraries/CMSIS/Device/Maxim/TARGET/Source/system_TARGET.c` for a target microcontroller shows how the BSP is integrated into the microcontroller's startup code. - -For example, the MAX78000's `system_max78000.c` startup file shows that `Board_Init` is a weak function that can be overridden. `Board_Init` is called from the default `SystemInit` implementation, which can also be overridden. - - :::C - /* This function is called before C runtime initialization and can be - * implemented by the application for early initializations. If a value other - * than '0' is returned, the C runtime initialization will be skipped. - * - * You may over-ride this function in your program by defining a custom - * PreInit(), but care should be taken to reproduce the initialization steps - * or a non-functional system may result. - */ - __weak int PreInit(void) - { - /* Do nothing */ - return 0; - } - - /* This function can be implemented by the application to initialize the board */ - __weak int Board_Init(void) - { - /* Do nothing */ - return 0; - } - - /* This function is called just before control is transferred to main(). - * - * You may over-ride this function in your program by defining a custom - * SystemInit(), but care should be taken to reproduce the initialization - * steps or a non-functional system may result. - */ - __weak void SystemInit(void) - { - /* Configure the interrupt controller to use the application vector table in */ - /* the application space */ - #if defined(__CC_ARM) || defined(__GNUC__) - /* IAR sets the VTOR pointer incorrectly and causes stack corruption */ - SCB->VTOR = (uint32_t)__isr_vector; - #endif /* __CC_ARM || __GNUC__ */ - - /* Enable instruction cache */ - MXC_ICC_Enable(MXC_ICC0); - - /* Enable FPU on Cortex-M4, which occupies coprocessor slots 10 and 11 */ - /* Grant full access, per "Table B3-24 CPACR bit assignments". */ - /* DDI0403D "ARMv7-M Architecture Reference Manual" */ - SCB->CPACR |= SCB_CPACR_CP10_Msk | SCB_CPACR_CP11_Msk; - __DSB(); - __ISB(); - - SystemCoreClockUpdate(); - - Board_Init(); - } - -A custom BSP can implement one or all of the weak functions. The file structure for a typical BSP can be found below. **The board.mk file is required**, while the rest of the project structure is a recommendation. - - :::bash - CustomBSP (defines BOARD value) - ├─ board.mk (required file!) - ├─ Include - | └─ board.h - └─ Source - └─ board.c - -The name of the BSP's root folder will be the string used with the `BOARD` [build configuration variable](#build-configuration-variables) to select it for a project. In the example above, one would use `BOARD = CustomBSP` to select it as the active BSP. - -#### BSP Search Directory - -By default, the MSDK searches for BSPs in the `Libraries/Boards` folder for each microcontroller. This can be changed using the `BSP_SEARCH_DIR` [build configuration variable](#build-configuration-variables), which allows users to load a BSP from a directory outside of the MSDK. The MSDK also uses the `BOARD` variable in its search path. - -For example, the configuration... - - :::Makefile - # project.mk - - BSP_SEARCH_DIR = /home/username/mybsps - # ^ "root" of the BSP search path - BOARD = CustomBSP - # "stem" of the BSP search path - -... will attempt to load the `/home/username/msbsps/CustomBSP/board.mk` file. - -#### Custom BSP Template - -The following contents can be used as a bare-bones starter template for a custom BSP. - -* _board.h_ - - :::C - // board.h - - #define BOARD_CUSTOM - // ^ This type of compiler definition is - // sometimes useful. It allows application code - // to check if a specific BSP is being used. - // Ex: #ifdef BOARD_CUSTOM - // ... - // #endif - - /** - * \brief Initialize the BSP and board interfaces. - * \returns #E_NO_ERROR if everything is successful - */ - int Board_Init(void); - -* _board.c_ - - :::C - //board.c - #include "board.h" - #include "mxc_error.h" - - int Board_Init(void) - { - // Implement me! - return E_NO_ERROR; - } - -* _board.mk_ - - :::Makefile - # board.mk - - ifeq "$(BOARD_DIR)" "" - # This Makefile will self-locate if BOARD_DIR is not specified. - BOARD_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST)))) - endif - - SRCS += board.c - VPATH += $(BOARD_DIR)/Source - IPATH += $(BOARD_DIR)/Include - -### Disabling BSPs - -It should also be noted that BSP integration can be disabled entirely by setting the `LIB_BOARD` [build configuration variable](#build-configuration-variables) to 0. This will skip the inclusion of the BSP's `board.mk` file entirely, and the default system initialization functions will be used. - -This option can also be used to implement a custom BSP inside of a project's application code. For example, a user could implement `Board_Init` inside of a project's `main.c` file without having to create a separate BSP folder with `LIB_BOARD = 0`. - -* _project.mk_ - - :::Makefile - # project.mk - - LIB_BOARD = 0 - -* _main.c_ - - :::C - // main.c - int Board_Init(void) - { - // Implement me! - return E_NO_ERROR; - } - - int main(void) - { - Board_Init(); - // ... - } - -## Libraries - -The MSDK contains a large number of libraries, both third-party and in-house. The main library is the [Peripheral Driver API](#peripheral-driver-api), but the MSDK also contains drivers for various _external_ components such as TFT displays, cameras, accelerometers, audio codecs, and other devices. Additionally, dedicated libraries for more complex _internal_ hardware peripherals such as USB, the SDHC interface, and the Cordio BLE stack are also available. These usually build on _top_ of the Peripheral Driver API. - -???+ note "ℹ️ **Note: Enabling Libraries**" - Libraries can be enabled for a project with a convenient *toggle switch* provided by the build system (See [Build Variables for Toggling Libraries](#build-variables-for-toggling-libraries))). - -### Peripheral Driver API - -A microcontroller is made up of a Central Processing Unit (CPU) that is surrounded by additional _peripheral_ hardware blocks such as timers, memory controllers, UART controllers, ADCs, RTCs, audio interfaces, and many more. The **Peripheral Driver API** is an important core library in the MSDK that allows the CPU to utilize the microcontroller's hardware blocks over a higher-level **_Application Programming Interface (API)_**. - -![Figure 38](res/Fig38.jpg) - -#### API Documentation (PeriphDrivers) - -The links below will open detailed API references for each microcontroller. Offline copies of these API references can also be found in the `Documentation` folder of the MSDK installation. - -- [MAX32520 API](Libraries/PeriphDrivers/Documentation/MAX32520/index.html) - -- [MAX32650 API](Libraries/PeriphDrivers/Documentation/MAX32650/index.html) - -- [MAX32655 API](Libraries/PeriphDrivers/Documentation/MAX32655/index.html) - -- [MAX32660 API](Libraries/PeriphDrivers/Documentation/MAX32660/index.html) - -- [MAX32665-MAX32666 API](Libraries/PeriphDrivers/Documentation/MAX32665/index.html) - -- [MAX32670 API](Libraries/PeriphDrivers/Documentation/MAX32670/index.html) - -- [MAX32672 API](Libraries/PeriphDrivers/Documentation/MAX32672/index.html) - -- [MAX32675 API](Libraries/PeriphDrivers/Documentation/MAX32675/index.html) - -- [MAX32680 API](Libraries/PeriphDrivers/Documentation/MAX32680/index.html) - -- [MAX32690 API](Libraries/PeriphDrivers/Documentation/MAX32690/index.html) - -- [MAX78000 API](Libraries/PeriphDrivers/Documentation/MAX78000/index.html) - -- [MAX78002 API](Libraries/PeriphDrivers/Documentation/MAX78002/index.html) - -#### PeriphDrivers Organization - -The Peripheral Driver API's source code is organized as follows: - -- **Header files _(.h)_** can be found in the `Libraries/PeriphDrivers/Include` folder. - - These files contain function _declarations_ for the API, describing the function prototypes and their associated documentation. -- **Source files _(.c)_** can be found in the `Libraries/PeriphDrivers/Source` folder. - - These files contain the function _definitions_ for the API - the _implementations_ of the functions declared by the header files. - -The _**implementation**_ files are further organized based on _**die type**_ and **_hardware revision_**. This is worth noting when browsing or debugging through the drivers. - -- The **_die type_** files follow the **`_ESXX`** , **`_MEXX`** , or **`_AIXX`** naming convention. - - These files' responsibility is to manage microcontroller-specific implementation details that may interact with other peripheral APIs _before_ ultimately calling the revision-specific files. See [Die Types to Part Numbers](#die-types-to-part-numbers) - -- The **_hardware revision_** files follow the **`_revX`** naming convention. - - These files contain the _pure_ driver implementation for a peripheral block and typically interact with the hardware almost entirely at the register level. - -#### Die Types to Part Numbers - -The following table matches external part numbers to internal die types. This is useful for browsing through the PeriphDrivers source code, which uses the die types. - -- ???+ note "ℹ️ **Note: Die Types Table**" - | Part Number | Die Type - | -------- | ----------- | - | MAX32520 | ES17 | - | MAX32570 | ME13 | - | MAX32650 | ME10 | - | MAX32655 | ME17 | - | MAX32660 | ME11 | - | MAX32662 | ME12 | - | MAX32665 | ME14 | - | MAX32670 | ME15 | - | MAX32672 | ME21 | - | MAX32675 | ME16 | - | MAX32680 | ME20 | - | MAX32690 | ME18 | - | MAX78000 | AI85 | - | MAX78002 | AI87 | - -#### `MSDK_NO_GPIO_CLK_INIT` - -Most Peripheral Driver initialization routines involve enabling system clocks, setting clock dividers, and configuring GPIO pins. In some cases (such as for Zephyr), frameworks or tools offer their own mechanisms for handling this, or it's desirable to manually handle it in custom application code. - -The MSDK offers a mechanism for disabling the automatic initialization of clocks and GPIO pins via the `MSDK_NO_GPIO_CLK_INIT` compiler definition. To enable this for a project, add it via the `PROJ_CFLAGS` [build configuration variable](#build-variables-for-the-compiler) using the following syntax: - -```Makefile -#project.mk - -PROJ_CFLAGS += -DMSDK_NO_GPIO_CLK_INIT -``` - -???+ note "ℹ️ **Syntax Note:**" - The `-D` flag tells the compiler to define a symbol at compile-time. It should be followed by the symbol we wish to define. In this case, `MSDK_NO_GPIO_CLK_INIT`. - -#### Peripheral Driver Build Variables - -| Configuration Variable | Description | Details | -| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| | | | -| `PINS_FILE` | Override pin definitions | This option can be used to override the default GPIO definitions used by the peripheral drivers, which can be found in the `Libraries/PeriphDrivers/Source/SYS/pins_xx.c` files in the MSDK. The file specified by this option will be passed to the build instead of the default. It's suggested to copy the default file first as a template before making modifications. | - ---- - -### CMSIS-DSP - -The CMSIS-DSP library provides a suite of common **Digital Signal Processing _(DSP)_** functions that take advantage of hardware accelerated _Floating Point Unit (FPU)_ available on microcontrollers with Arm Cortex-M cores. This library is distributed in the MSDK as a pre-compiled static library file, and the MSDK maintains a port of the official code examples in the **ARM-DSP** [Examples](https://github.com/analogdevicesinc/msdk/tree/main/Examples) folder for each microcontroller. - -Please refer to the [CMSIS-DSP official documentation](https://arm-software.github.io/CMSIS-DSP/v1.16.2/index.html) for more detailed documentation on the library functions and usage. - -#### CMSIS-DSP Supported Parts - -- All microcontrollers with a Cortex M4 core are supported. - -#### CMSIS-DSP Build Variables - -| Configuration Variable | Description | Details | -| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| | | | -| `CMSIS_DSP_VERSION` | (Optional) Set the CMSIS-DSP version to use. | Defaults to `1.16.2`, which is currently the only supported version. | - - ---- - -### Cordio Bluetooth Low Energy - -The Cordio Bluetooth Low Energy (BLE) library provides a full BLE stack for microcontrollers with an integrated BLE controller. - -The Cordio library warrants its own separate documentation. See the **[Cordio BLE User Guide](Libraries/Cordio/docs/CORDIO_USERGUIDE.md)**. - -#### Cordio Supported Parts - -- MAX32655 -- MAX32665 -- MAX32680 -- MAX32690 - ---- - -### MAXUSB - -The MAXUSB library provides a higher-level interface for utilizing the built-in USB controller hardware available on some microcontrollers. This allows the microcontroller to enumerate as a USB device without the need for an external USB controller IC. MAXUSB provides a finer level of control of USB events and classes than TinyUSB. - -#### MAXUSB Supported Parts - -- MAX32570 -- MAX32650 -- MAX32655 and MAX32656 -- MAX32665-MAX32666 -- MAX32690 -- MAX78002 - ---- - -### TinyUSB - -The TinyUSB library provides a high-level interface for utilizing the built-in USB controller hardware available on some microcontrollers. This allows the microcontroller to enumerate as a USB device without the need for an external USB controller IC. **[TinyUSB](https://github.com/hathach/tinyusb) provides a cross-platform USB stack for embedded systems, with a higher level of abstraction than MAXUSB, -supporting most standard USB device classes. - -#### TinyUSB Supported Parts - -- MAX32650 -- MAX32665-MAX32666 -- MAX32690 -- MAX78002 - ---- - -### Miscellaneous Drivers - -The `Libraries/MiscDrivers` folder of the MSDK contains drivers for miscellaneous external components such as TFT displays, cameras, audio codecs, PMICs, pushbuttons, etc. These resources are usually closely tied with the [Board Support Packages](#board-support-packages). - -#### Miscellaneous Build Variables - -| 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. | - ---- - -### SDHC - -The **Secure Digital High Capacity *(SDHC)*** library offers a higher-level interface built on top of the SDHC [Peripheral Driver API](#peripheral-driver-api) that includes a [FatFS File System](http://elm-chan.org/fsw/ff/00index_e.html) implementation for managing files on SD cards. - -See [Build Variables for Toggling Libraries](#build-variables-for-toggling-libraries) for instructions on enabling the SDHC library. - -#### SDHC Supported Parts - -- MAX32650 -- MAX32570 -- MAX32665-MAX32666 -- MAX78000 -- MAX78002 - -#### SDHC Build Variables - -Once enabled, the following [build configuration variables](#build-configuration-variables) become available. - -| Configuration Variable | Description | Details | -| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| `FATFS_VERSION` | Specify the version of [FatFS](http://elm-chan.org/fsw/ff/00index_e.html) to use | FatFS is a generic FAT/exFAT filesystem that comes as a sub-component of the SDHC library. This variable can be used to change the [version](http://elm-chan.org/fsw/ff/updates.html) to use. Acceptable values are `ff13` (R0.13), `ff14` (R0.14b), or `ff15` (R0.15) | -| `SDHC_CLK_FREQ` | Sets the clock freq. for the SDHC library (Hz) | Sets the target clock frequency in units of Hz (Default is 30Mhz). Reducing the SDHC clock frequency is a good troubleshooting step when debugging communication issues. | -| `FF_CONF_DIR` | Sets the search directory for `ffconf.h` | (Available for `FATFS_VERSION = ff15` only) FatFS configuration is done via an `ffconf.h` file. This option allows specifying the location of a custom `ffconf.h` file for a project. | - ---- - -### FreeRTOS - -[FreeRTOS](https://www.freertos.org/index.html) is a Real-Time Operating System (RTOS), which offers basic abstractions for multi-tasking and an OS layer specifically targeted at embedded systems with real-time requirements. The MSDK maintains an official support layer for the FreeRTOS kernel. Official documentation can be found on the [FreeRTOS website](https://www.freertos.org/index.html). - -#### FreeRTOS Supported Parts - -FreeRTOS is supported by all parts in the MSDK. See the `FreeRTOSDemo` example application. - -#### FreeRTOS Build Variables - -| Configuration Variable | Description | Details | -| ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| `FREERTOS_HEAP_TYPE` | Specify the method of heap allocation to use for the FreeRTOS API | FreeRTOS provides options for the heap management alogirthms to optimize for memory size, speed, and risk of heap fragmentation. For more details, visit the [FreeRTOS MemMang Docs](https://www.freertos.org/a00111.html). Acceptable values are `1`, `2`, `3`, `4`, or `5`. The default value is `4` for heap_4. | - -#### FreeRTOS-Plus - -[FreeRTOS-Plus](https://www.freertos.org/FreeRTOS-Plus/index.html) is an additional library that implements addon functionality for the FreeRTOS kernel. The MSDK maintains support for some, but not all, available addons. - -- [FreeRTOS-Plus-CLI](https://www.freertos.org/FreeRTOS-Plus/index.html): **Supported** -- [FreeRTOS-Plus-TCP](https://www.freertos.org/FreeRTOS-Plus/FreeRTOS_Plus_TCP/index.html): **Not supported** (Contributions welcome!) - - -### CLI - -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. - -### CoreMark - -[EEMBC’s CoreMark®](https://www.eembc.org/coremark/) is a benchmark that measures the performance of microcontrollers (MCUs) and central processing units (CPUs) used in embedded systems. CoreMark is a simple, yet sophisticated benchmark that is designed specifically to test the functionality of a processor core. Running CoreMark produces a single-number score allowing users to make quick comparisons between processors. - -#### CoreMark Supported Parts - -All parts in the MSDK support the Coremark library via a `Coremark` example application. - -???+ note "ℹ️ **Note**" - The source code of the `Coremark` examples are somewhat unique. They only contain a `core_portme.c`/`core_portme.h`. These files are provided by CoreMark libraries to give the MSDK an implementation layer for a few hardware-dependent functions. Otherwise, the remainder of the source code (located in `Libraries/Coremark`) must remain unmodified to comply with the CoreMark rules. - -## Examples - -The MSDK contains examples for each microcontroller that demonstrate the usage of its [Peripheral APIs](#peripheral-driver-api) and other supported libraries. They can be found in the `Examples` folder of an MSDK installation. - -![Figure 40](res/Fig40.jpg) - -???+ warning "**⚠️ Copying Examples**" - It's strongly recommended to copy example projects to an _outside_ folder before modifying them. This keeps the MSDK's "source" copy preserved for reference. Project folders must be copied to a location _without_ any spaces in its filepath. - -Each example contains a `README.md` file describing what it does. In general, there is at least one example per peripheral block, and the example's name will indicate what it matches (i.e., `DMA`, `ADC`, `SPI`). - -The tables below are offered to facilitate easier browsing through the MSDK examples. They are autogenerated from the available projects for each microcontroller. A link to the example's source code on Github is available, as well as its location inside of the MSDK. - - -##__EXAMPLES_LIST__## - -## Debuggers - -### Debug Limitations - -- ???+ warning "**⚠️ Warning**" - It’s important to note some fundamental limitations of debugging the MSDK's supported parts. These limitations may make the device difficult (or impossible) for the debugger to connect in certain states. In such cases, the device can attempt to be recovered using a [MAX32625PICO](#max32625pico-pico). See [How to Unlock a Microcontroller That Can No Longer Be Programmed](#how-to-unlock-a-microcontroller-that-can-no-longer-be-programmed) - * A debugger can not be connected to a microcontroller _while_ the device is in reset. - * A microcontroller can not be debugged while it's _Sleep_, _Low Power Mode_, _Micro Power Mode_, _Standby_, _Backup_, or _Shutdown_ mode. These modes shut down the SWD clock. - * For low-power development, it's recommended to place a 2-second blocking delay at the start of `main`. - -### MAX32625PICO (PICO) - -A MAX32625PICO (affectionately called the "PICO") debug adapter is provided with almost all the evaluation platforms supported by the MSDK. Additionally, most small form-factor evaluation kits have a PICO _embedded_ into the PCB. - -It's good practice to update the PICO's firmware to the latest version, which can be found on the [MAX32625PICO Firmware Images](https://github.com/MaximIntegrated/max32625pico-firmware-images) Github page. - -#### Updating the MAX32625PICO (PICO) Debug Adapter Firmware - -1. Download the correct image for your evaluation platform from the [MAX32625PICO Firmware Images](https://github.com/MaximIntegrated/max32625pico-firmware-images) Github page. - -2. Connect the included micro-USB cable to the PICO _without_ connecting the other side of the cable to your host PC yet. - - ![Pico USB Connection](res/pico_partial_connected.jpg) - -3. Press and hold the pushbutton on the top of the PICO. - - ![Pico Pushbutton](res/pico_pushbutton.jpg) - -4. _While holding down the pushbutton on the PICO_ connect the other side of the micro-USB cable to your host PC. - - Keep the pushbutton held down until the LED on the PICO blinks and becomes solid. - - ![Pico Connected](res/pico_connected.jpg) - -5. A `MAINTENANCE` drive should now appear on your file system. - - ![Maintenance Drive](res/MAINTENANCE.jpg) - -6. Drag and drop the downloaded file from step 1 onto the `MAINTENANCE` drive. This will flash the PICO with the updated firmware. - - ![Maintenance Drive](res/MAINTENANCE.jpg) - - ![Drag and Drop](res/drag_and_drop.JPG) - - ![Flashing](res/pico_flashing.JPG) - -7. Once the flashing is complete, the PICO will restart and present itself as a `DAPLINK` drive. - - ![DAPLINK Drive](res/DAPLINK.jpg) - -8. Open the `DAPLINK` drive. - - ![Opened DAPLINK Drive](res/DAPLINK_opened.jpg) - -9. Open the `DETAILS.TXT` file and verify the Git SHA matches the expected value for the updated file. - - ![DETAILS.TXT](res/DETAILS_Git_SHA.jpg) - -10. Your PICO debugger is now ready to use with the latest firmware. - -#### How to Unlock a Microcontroller That Can No Longer Be Programmed - -The [debug limitations](#debug-limitations) of the MSDK's supported parts may make some devices difficult to connect to if bad firmware has been flashed. In such cases, the device can attempt to be recovered from the “locked out” firmware by mass erasing the application code from the flash memory bank. Note that this does not always work. Success will depend on a small window being available for the debugger to connect immediately after reset. - -Before following the procedure below, ensure that you have updated the PICO debugger firmware to the latest version. See [Updating the MAX32625PICO (PICO) Debug Adapter Firmware](#updating-the-max32625pico-pico-debug-adapter-firmware) - -##### Unlock with VS Code - -For VS Code users, the `"erase flash"` [build task](#build-tasks) can be used to attempt a mass erase. If this task fails to recover the part, attempt the procedure below. - -##### Unlock with `erase.act` - -1. Connect the PICO debugger to the microcontroller to recover. - -2. Connect the PICO debugger to the host PC with the included micro-USB cable. - -3. Open the DAPLINK` drive on the host PC. - - ![DAPLINK Drive](res/DAPLINK.jpg) - -4. Open the `DETAILS.TXT` inside of the `DAPLINK` drive in a text editor. - - ![DAPLINK Opened](res/DAPLINK_opened.jpg) - -5. Verify that the “Automation allowed” field is set to 1. - - ![Automation Allowed](res/DETAILS_automation_allowed.jpg) - - ??? note "ℹ️ **Enabling Automation**" - If this field is _not_ set to 1, follow the procedure below: - - 1. Create a new _empty_ file, and save it as `auto_on.cfg`. - - 2. Press and hold the pushbutton on top of the PICO. - - ![PICO Pushbutton](res/pico_pushbutton.jpg) - - 3. _While holding the pushbutton_, drag and drop the `auto_on.cfg` file onto the `DAPLINK` drive. - - ![Drag and Drop File](res/auto_on.cfg.jpg) - - 4. Continue holding the pushbutton until the file is finished transferring over, then release it. - - 5. The PICO should power cycle, and the DAPLINK drive should re-appear with “Automation allowed” set to 1. - -6. Power on the evaluation platform (if it isn’t already). - -7. Create an empty file called `erase.act`. - -8. Drag and drop the `erase.act` file onto the `DAPLINK` drive. - - ![Drag and Drop erase.act](res/erase.act.jpg) - -9. The PICO debugger will attempt to mass erase the microcontroller's flash bank, which will completely wipe any application firmware that is programmed on the device. - - ???+ note "ℹ️ **Note**" - If this process fails, a `FAIL.TXT` file will be present in the DAPLINK drive with an additional error message inside of it. A failure is generally indicative of firmware that has completely shut down the debug port, or has entered low power loop immediately on power-up. In these cases, it's not possible to recover the device. - -10. Power cycle the microcontroller. It step 8 succeeded, it's blank and ready to re-program. The debugger should have no issues connecting to the device in this blank state. - -## Developer Notes - -### SPI v2 Library - -The SPI v2 Library is the latest version of the MSDK SPI drivers which highlights: - -- Target Select (TS) Control Scheme which provides users the option to drive their own TS pins. -- Optional`MXC_SPI_Config(...)` and `mxc_spi_cfg_t` struct to reduce the use of multiple functions to select proper SPI settings. -- Re-mapped the `MXC_SPI_Init(...)` function input parameters (same behavior as SPI v1). -- Allow for re-arming an SPI transaction within the callback function for chained SPI messages. -- Decrease in setup overhead in a Transaction function call. Less nested function calls within drivers. -- Improved SPI DMA support and DMA Channel IRQ vector flexibility by providing acquired DMA channel numbers before a SPI DMA transaction call. -- The use of Controller and Target terms instead of Master and Slave, respectively. -- Still supports SPI v1 function prototypes for backwards-compatibility. -- Bug fixes from the SPI v1 API. - -#### SPI v2 Supported Parts - -- MAX32572 -- MAX32690 -- MAX78002 - -#### Porting Projects to use SPI v2 - -The latest SPI examples in the MSDK defaults to build the SPI v1 libraries. Set the `MXC_SPI_VERSION` [build configuration variable](#build-configuration-variables) to `v2` (case sensitive) use the SPI v2 API. - -This guide shows how to update an existing project that is using the SPI v1 API to SPI v2. The SPI v2 Library still supports the SPI v1 function prototypes for backwards-compatibility with the main difference being the SPI DMA interrupt handling (see [SPI DMA Interrupt Handling](#spi-dma-interrupt-handling) section below for more info). - -Note: The SPI v2 API is only a drop in replacement to SPI v1 if SPI DMA is **not** used; should the user choose to continue building with the SPI v1 convention but with the underlying SPI v2 implementation. This porting guide demonstrates how to use the full extent of the SPI v2 features. - -##### SPI Init Function - -The input parameters for the `MXC_SPI_Init(...)` function were updated in SPI v2 to allow for more user-selectable options during initialization. This should not cause any errors or behavioral differences with the `MXC_SPI_Init(...)` function when switching between SPI v1 and SPI v2 builds as the input parameters were essentially re-mapped to more descriptive names. - -SPI v1: - - :::C - int MXC_SPI_Init(mxc_spi_regs_t *spi, - int masterMode, - int quadModeUsed, - int numSlaves, - unsigned ssPolarity, - unsigned int hz, - mxc_spi_pins_t pins) - -SPI v2: - - :::C - int MXC_SPI_Init(mxc_spi_regs_t *spi, - mxc_spi_type_t controller_target, - mxc_spi_interface_t if_mode, - int numTargets, - uint8_t ts_active_pol_mask, - uint32_t freq, - mxc_spi_pins_t pins) - -Input Parameters: - -- `mxc_spi_regs_t *spi` remains unchanged. -- `int masterMode` -> `mxc_spi_type_t controller_target`. The enum `mxc_spi_type_t` was added for increased code readability. -- `int quadModeUsed` -> `mxc_spi_interface_t if_mode`. Previously, the `MXC_SPI_Init(...)` function could only select between standard (4wire) and quad interface modes. With SPI v2, the user can select either standard (`MXC_SPI_INTERFACE_STANDARD`), quad (`MXC_SPI_INTERFACE_QUAD`), 3wire (`MXC_SPI_INTERFACE_3WIRE`), or dual (`MXC_SPI_INTERFACE_DUAL`) mode. -- `int numSlaves` -> `int numTargets`. SPI v2 does not use this parameter and was kept to continue supporting SPI v1. -- `unsigned ssPolarity` -> `uint8_t ts_active_pol_mask`. Updated to a more descriptive name. -- `unsigned int hz` -> `uint32_t freq`. -- `mxc_spi_pins_t pins` remains unchanged. - -##### SPI Config Function - -The `int MXC_SPI_Config(mxc_spi_cfg_t cfg)` function was added to reduce the number of helper function calls to set the appropriate settings that the `MXC_SPI_Init(...)` function did not set. - -This function also sets up the DMA and acquires DMA TX/RX channels for SPI DMA transactions. - -`mxc_spi_cfg_t` struct: - -- `mxc_spi_regs_t *spi` - Select SPI Instance to configure. -- `mxc_spi_clkmode_t clk_mode` - Select clock mode. -- `uint8_t frame_size` - Select single frame size (2 - 16 bits). -- `bool use_dma_tx` - Enable SPI DMA TX (acquire and configure TX channel). -- `bool use_dma_rx` - Enable SPI DMA RX (acquire and configure RX channel). -- `mxc_dma_regs_t *dma` - Select DMA Instance to configure for SPI DMA (Valid only if `use_dma_tx` or `use_dma_rx` is set to true). - -##### SPI Request Struct - -`mxc_spi_req_t` struct: - -- `mxc_spi_regs_t *spi` - Remains unchanged. -- `int ssIdx` - Remains unchanged. -- `int ssDeassert` - Remains unchanged. -- `uint8_t *txData` - Remains unchanged. -- `uint8_t *rxData` - Remains unchanged. -- `uint32_t txLen` - Remains unchanged. -- `uint32_t rxLen` - Remains unchanged. -- `uint32_t txCnt` - Not used in SPI v2. -- `uint32_t rxCnt` - Not used in SPI v2. -- `mxc_spi_callback_t completeCB` - Type was renamed, but funtionally, remains unchanged. - -##### SPI Transaction Functions - -The SPI v2 Libraries follows the terms used in the user guide: Controller and Target instead of Master and Slave, respectively. - -- `MXC_SPI_MasterTransaction(...)` -> `MXC_SPI_ControllerTransaction(...)` -- `MXC_SPI_MasterTransactionAsync(...)` -> `MXC_SPI_ControllerTransactionAsync(...)` -- `MXC_SPI_MasterTransactionDMA(...)` -> `MXC_SPI_ControllerTransactionDMA(...)` -- `MXC_SPI_SlaveTransaction(...)` -> `MXC_SPI_TargetTransaction(...)` -- `MXC_SPI_SlaveTransactionAsync(...)` -> `MXC_SPI_TargetTransactionAsync(...)` -- `MXC_SPI_SlaveTransactionDMA(...)` -> `MXC_SPI_TargetTransactionDMA(...)` - -##### SPI DMA Setup for `MXC_SPI_ControllerTransactionDMA(...)` - -The SPI v2 library allows for more flexibility in setting generic DMA TX/RX channel vectors for SPI DMA transactions during run-time. Compared to SPI v1 where the user must know the acquired SPI DMA TX/RX channel numbers and define the appropriate DMA channel handlers before compile-time. - -There are two ways to initialize and configure the DMA before starting a SPI DMA transaction. - -Method 1: Call `int MXC_SPI_DMA_Init(mxc_spi_regs_t *spi, mxc_dma_regs_t *dma, bool use_dma_tx, bool use_dma_rx)`. - -Method 2: Set up the DMA options in the `mxc_spi_cfg_t` struct and call `int MXC_SPI_Config(mxc_spi_cfg_t cfg)`. - - :::C - ... - // Initialize SPI DMA ahead of time. - MXC_SPI_DMA_Init(SPI, DMA, true, true); - - int TX_DMA_CH = MXC_SPI_DMA_GetTXChannel(SPI); - int RX_DMA_CH = MXC_SPI_DMA_GetRXChannel(SPI); - - NVIC_EnableIRQ(MXC_DMA_CH_GET_IRQ(TX_DMA_CH)); - NVIC_EnableIRQ(MXC_DMA_CH_GET_IRQ(RX_DMA_CH)); - - MXC_NVIC_SetVector(MXC_DMA_CH_GET_IRQ(TX_DMA_CH), DMA_TX_IRQHandler); - MXC_NVIC_SetVector(MXC_DMA_CH_GET_IRQ(RX_DMA_CH), DMA_RX_IRQHandler); - - MXC_SPI_ControllerTransactionDMA(&req); - ... - -The DMA is initialized in `MXC_SPI_DMA_Init(...)` or `MXC_SPI_Config(...)`. This provides information on what DMA channels were acquired for a SPI instance's TX and RX DMA before calling the DMA transaction function. Following the example above, it is recommended to set up a generic-named DMA TX/RX vector because the SPI TX and RX DMA channels won't always acquire DMA_CH0 and DMA_CH1, respectively. - -##### SPI DMA Interrupt Handling - - :::C - void DMA_TX_IRQHandler(void) - { - MXC_SPI_DMA_TX_Handler(SPI); - } - - void DMA_RX_IRQHandler(void) - { - MXC_SPI_DMA_RX_Handler(SPI); - } - -The SPI v1 API requires `MXC_DMA_Handler()` to be called in the TX and RX DMA Channel interrupt handlers. Following the generic vector names used in the previous section, the SPI v2 supplies its own TX/RX DMA Handler processing functions (`MXC_SPI_DMA_RX_Handler(...)` and `MXC_SPI_DMA_RX_Handler(...)`) that must be called within their appropriate DMA channel interrupt handlers. From 5810271d56062e7cacd714e4b6712b4640b33e8d Mon Sep 17 00:00:00 2001 From: "Anderson, Glen" Date: Mon, 7 Oct 2024 14:42:31 -0400 Subject: [PATCH 06/18] Remove unneeded static html --- Documentation/MAX32520.html | 170 ---------------------------- Documentation/MAX32570.html | 189 ------------------------------- Documentation/MAX32650.html | 191 ------------------------------- Documentation/MAX32655.html | 189 ------------------------------- Documentation/MAX32660.html | 170 ---------------------------- Documentation/MAX32662.html | 171 ---------------------------- Documentation/MAX32665.html | 203 --------------------------------- Documentation/MAX32670.html | 170 ---------------------------- Documentation/MAX32672.html | 174 ---------------------------- Documentation/MAX32675.html | 170 ---------------------------- Documentation/MAX32680.html | 174 ---------------------------- Documentation/MAX32690.html | 193 ------------------------------- Documentation/MAX78000.html | 219 ------------------------------------ Documentation/MAX78002.html | 200 -------------------------------- Documentation/index.html | 82 -------------- 15 files changed, 2665 deletions(-) delete mode 100644 Documentation/MAX32520.html delete mode 100644 Documentation/MAX32570.html delete mode 100644 Documentation/MAX32650.html delete mode 100644 Documentation/MAX32655.html delete mode 100644 Documentation/MAX32660.html delete mode 100644 Documentation/MAX32662.html delete mode 100644 Documentation/MAX32665.html delete mode 100644 Documentation/MAX32670.html delete mode 100644 Documentation/MAX32672.html delete mode 100644 Documentation/MAX32675.html delete mode 100644 Documentation/MAX32680.html delete mode 100644 Documentation/MAX32690.html delete mode 100644 Documentation/MAX78000.html delete mode 100644 Documentation/MAX78002.html delete mode 100644 Documentation/index.html diff --git a/Documentation/MAX32520.html b/Documentation/MAX32520.html deleted file mode 100644 index d662240200..0000000000 --- a/Documentation/MAX32520.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - MAX32520 Documentation - - - - -

MAX32520 Documentation

-
- -

SDK

-
    -
  • -
  • Toolchain
    • -
      -
    • -
    • - -
    • -
    • -
    • -
    • -
    • -
    -
-
- -

Example Applications

- The following examples can be found in the Examples/MAX32520 directory of the SDK installation: -
    -
  • AES - Advanced Encryption Standard
    • -
  • DSP - Digital Signal Processing
    • -
  • CRC - Cyclic Redundancy Check
    • -
  • DMA - Direct Memory Access
    • -
  • ECDSA - Elliptic Curve Digital Signature Algorithm
    • -
  • Flash - Flash Memory
    • -
  • Flash-CLI - Flash Memory - Demonstration of storing non-volatile data
    • -
  • FreeRTOSDemo - FreeRTOSDemo
    • -
  • GPIO - General Purpose Input/Output
    • -
  • Hello_World
    • -
  • I2C_MNGR - Demonstration of managing simultaneous I2C transaction requests
    • -
  • I2C_SCAN - Demonstration of discovering I2C devices on the bus
    • -
  • I2C_Sensor - Demonstration of communicating with an I2C temperature sensor
    • -
  • ICC - Internal Cache Controller
    • -
  • LP - Low Power
    • -
  • LockDebug - Debug Lock-out
    • -
  • SCPA_OTP_Dump - Secure Communication Protocal Applet
    • -
  • SFE - Serial Flash Emulator
    • -
  • SFE_Host - Serial Flash Emulator Host
    • -
  • SMON - Security Monitor
    • -
  • SPI - Serial Peripheral Interface
    • -
  • SPI - Serial Peripheral Interface
    • -
  • TMR - General Purpose Timer
    • -
  • TRNG - True Random Number Generator
    • -
  • Watchdog
    • -
-
- -

Device Information

- Additional information about the MAX32520 can be found in these documents: - - - - - \ No newline at end of file diff --git a/Documentation/MAX32570.html b/Documentation/MAX32570.html deleted file mode 100644 index c9f00a63c3..0000000000 --- a/Documentation/MAX32570.html +++ /dev/null @@ -1,189 +0,0 @@ - - - - - MAX32570 Documentation - - - - -

MAX32570 Documentation

-
- -

SDK

-
    -
  • -
  • Toolchain
    • -
      -
    • -
    • - -
    • -
    • -
    • -
    • -
    • -
    -
-
- -

Example Applications

- The following examples can be found in the Examples/MAX32570 directory of the SDK installation: - -
- -

Device Information

- The MAX32570 documents are only released under an NDA. Contact Maxim for details on accessing this document. - - For more information, Click Here. - - - - \ No newline at end of file diff --git a/Documentation/MAX32650.html b/Documentation/MAX32650.html deleted file mode 100644 index fef0420265..0000000000 --- a/Documentation/MAX32650.html +++ /dev/null @@ -1,191 +0,0 @@ - - - - - MAX32650 Documentation - - - - -

MAX32650 Documentation

-
- -

SDK

-
    -
  • -
  • Toolchain
    • -
      -
    • -
    • - -
    • -
    • -
    • -
    • -
    • -
    -
-
- -

Example Applications

- The following examples can be found in the Examples/MAX32650 directory of the SDK installation: -
    -
  • ADC - Analog-to-Digital Converter
    • -
  • AES - Advanced Encryption Standard
    • -
  • DSP - Digital Signal Processing
    • -
  • CLCD - Color LCD
    • -
  • CRC - Cyclic Redundancy Check
    • -
  • DES - Data Encryption Standard
    • -
  • DMA - Direct Memory Access
    • -
  • EMCC - External Memory Cache Controller
    • -
  • Flash - Flash Memory
    • -
  • Flash-CLI - Flash Memory - Demonstration of storing non-volatile data
    • -
  • FreeRTOSDemo
    • -
  • GPIO - General Purpose Input/Output
    • -
  • HBMC - Hyperbus
    • -
  • Hello_World
    • -
  • I2C - The Standard 2-Wire Serial Protocol
    • -
  • I2C_MNGR - Demonstration of managing simultaneous I2C transaction requests
    • -
  • I2C_SCAN - Demonstration of discovering I2C devices on the bus
    • -
  • I2C_Sensor - Demonstration of communicating with an I2C temperature sensor
    • -
  • I2S - Inter-IC Sound
    • -
  • ICC - Internal Cache Controller
    • -
  • LP - Low Power
    • -
  • MAA - Modular Arithmetic Accelerator
    • -
  • OWM - Dallas 1-Wire Master
    • -
  • Pulse_Train
    • -
  • RTC - Real Time Clock
    • -
  • RTC_Backup - Demonstration of the RTC running in Backup mode
    • -
  • SCPA_OTP_Dump - Secure Communication Protocal Applet
    • -
  • SDHC_FAT
    • -
  • SDHC_Raw
    • -
  • Semaphore
    • -
  • SPI - Serial Peripheral Interface
    • -
  • SPIMSS - SPI/I2S
    • -
  • SPIXF - SPI Execute-in-Place Flash
    • -
  • SPIXF_ICC - Demonstrates the advantages of using the instruction cache with the SPIXF
    • -
  • SPIXR - SPI Execute-in-Place RAM
    • -
  • SysTick
    • -
  • TMR - General Purpose Timer
    • -
  • TRNG - True Random Number Generator
    • -
  • UART - Universal Asynchronous Receive/Transmitter
    • -
  • USB_CDCACM - USB CDC-ACM Driver Class
    • -
  • USB_CompositeDevice_MSC_CDC - USB Composite Device with Mass Storage and CDC-ACM Driver Class
    • -
  • USB_CompositeDevice_MSC_HID - USB Composite Device with Mass Storage and HID Driver Class
    • -
  • USB_HIDKeyboard - USB HID Driver Class
    • -
  • USB_MassStorage - USB Mass Storage Driver Class
    • -
  • Watchdog
    • -
  • WearLeveling
    • -
-
- -

Device Information

- Additional information about the MAX32650 can be found in these documents: - - - - - \ No newline at end of file diff --git a/Documentation/MAX32655.html b/Documentation/MAX32655.html deleted file mode 100644 index ae6ca7ab8d..0000000000 --- a/Documentation/MAX32655.html +++ /dev/null @@ -1,189 +0,0 @@ - - - - - MAX32655 Documentation - - - - -

MAX32655 Documentation

-
- -

SDK

-
    -
  • -
  • Toolchain
    • -
      -
    • -
    • -
    • -
    • -
    • -
    • -
    • -
    • -
    -
-
- -

Example Applications

- The following examples can be found in the Examples/MAX32655 directory of the SDK installation: -
    -
  • ADC - Analog-to-Digital Converter
    • -
  • AES - Advanced Encryption Standard
    • -
  • DSP - Digital Signal Processing
    • -
  • BLE_datc - Bluetooth Data Client
    • -
  • BLE_dats - Bluetooth Data Server
    • -
  • BLE_fcc - Bluetooth Sample for FCC Testing
    • -
  • BLE_fit - Bluetooth Fitness Device
    • -
  • BLE_FreeRTOS - BLE and Free-RTOS Application
    • -
  • BLE_mcs - Maxim custom Bluetooth Profile and Services
    • -
  • BLE_otac - Bluetooth Data Client with Over-the-Air Updates
    • -
  • BLE_otas - Bluetooth Data Server with Over-the-Air Updates
    • -
  • BLE_periph - Bluetooth Peripheral
    • -
  • BLE4_ctr - Bluetooth v4.2 Controller
    • -
  • BLE5_ctr - Bluetooth v5.2 Controller
    • -
  • Bootloader
    • -
  • CRC - Cyclic Redundancy Check
    • -
  • DMA - Direct Memory Access
    • -
  • Dual_core_sync - Dual Core Inter-Communication
    • -
  • Flash - Flash Memory
    • -
  • Flash-CLI - Flash Memory - Demonstration of storing non-volatile data
    • -
  • FreeRTOSDemo
    • -
  • FTHR_I2C - I2C for Featherboard
    • -
  • GPIO - General Purpose Input/Output
    • -
  • Hello_World
    • -
  • Hello_World-riscv
    • -
  • I2C - The Standard 2-Wire Serial Protocol
    • -
  • I2C_MNGR - Demonstration of managing simultaneous I2C transaction requests
    • -
  • I2C_SCAN - Demonstration of discovering I2C devices on the bus
    • -
  • I2C_Sensor - Demonstration of communicating with an I2C temperature sensor
    • -
  • I2S - Inter-IC Sound
    • -
  • I2S_Playback - Demonstration of playback of audio sample using I2S
    • -
  • ICC - Internal Cache Controller
    • -
  • LP - Low Power
    • -
  • LPCMP - Low Power Comparator
    • -
  • Pulse_Train
    • -
  • RTC - Real Time Clock
    • -
  • RTC_Backup - Demonstration of the RTC running in Backup mode
    • -
  • RV_ARM_Loader
    • -
  • SPI - Serial Peripheral Interface
    • -
  • TFT_Demo - Thin-Film Transistor Display
    • -
  • TMR - General Purpose Timer
    • -
  • TRNG - True Random Number Generator
    • -
  • UART - Universal Asynchronous Receive/Transmitter
    • -
  • Watchdog
    • -
  • WearLeveling
    • -
  • WUT - Wakeup Timer
    • -
-
- -

Device Information

- Additional information about the MAX32655 can be found in these documents: - - - - - \ No newline at end of file diff --git a/Documentation/MAX32660.html b/Documentation/MAX32660.html deleted file mode 100644 index 0f8a17fb95..0000000000 --- a/Documentation/MAX32660.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - MAX32660 Documentation - - - - -

MAX32660 Documentation

-
- -

SDK

-
    -
  • -
  • Toolchain
    • -
      -
    • -
    • - -
    • -
    • -
    • -
    • -
    • -
    -
-
- -

Example Applications

- The following examples can be found in the Examples/MAX32660 directory of the SDK installation: - -
- -

Device Information

- Additional information about the MAX32660 can be found in these documents: - - - - - \ No newline at end of file diff --git a/Documentation/MAX32662.html b/Documentation/MAX32662.html deleted file mode 100644 index b5f0983cef..0000000000 --- a/Documentation/MAX32662.html +++ /dev/null @@ -1,171 +0,0 @@ - - - - - MAX32662 Documentation - - - - -

MAX32662 Documentation

-
- -

SDK

-
    -
  • -
  • Toolchain
    • -
      -
    • -
    • - -
    • -
    • -
    • -
    • -
    • -
    -
-
- -

Example Applications

- The following examples can be found in the Examples/MAX32662 directory of the SDK installation: -
    -
  • ADC - Analog-to-Digital Converter
    • -
  • DSP - Digital Signal Processing
    • -
  • Bootloader_Host
    • -
  • CAN - Controller Area Network
    • -
  • DMA - Direct Memory Access
    • -
  • Flash - Flash Memory
    • -
  • Flash_CLI - Flash Memory - Command Line Interface
    • -
  • GPIO - General Purpose Input/Output
    • -
  • Hello_World
    • -
  • I2C - The Standard 2-Wire Serial Protocol
    • -
  • I2C_MNGR - Demonstration of managing simultaneous I2C transaction requests
    • -
  • I2C_SCAN - Demonstration of discovering I2C devices on the bus
    • -
  • I2C_Sensor - Demonstration of communicating with an I2C temperature sensor
    • -
  • I2S - Inter-IC Sound
    • -
  • ICC - Instruction Cache Controller
    • -
  • Info_Block_Usecase
    • -
  • LP - Low Power
    • -
  • RTC - Real Time Clock
    • -
  • RTC_Backup - Real Time Clock Backup
    • -
  • SCPA_OTP_Dump - Secure Communication Protocal Applet
    • -
  • SPI - Serial Peripheral Interface
    • -
  • TMR - General Purpose Timer
    • -
  • UART - Universal Asynchronous Receiver/Transmitter
    • -
  • UART_Wakeup - Universal Asynchronous Receiver/Transmitter Wakeup
    • -
  • Watchdog
    • -
  • WearLeveling
    • -
-
- -

Device Information

- Additional information about the MAX32662 can be found in these documents: -
    -
  • IC Datasheet - Coming Soong!
    • -
  • IC User Guide - Coming Soon!
    • -
  • Evaluation Kit Schematic - Coming Soon!
    • -
- - - - \ No newline at end of file diff --git a/Documentation/MAX32665.html b/Documentation/MAX32665.html deleted file mode 100644 index 276659faf5..0000000000 --- a/Documentation/MAX32665.html +++ /dev/null @@ -1,203 +0,0 @@ - - - - - MAX32665 Documentation - - - - -

MAX32665 Documentation

-
- -

SDK

-
    -
  • -
  • Toolchain
    • -
      -
    • -
    • - -
    • -
    • -
    • -
    • -
    • -
    -
-
- -

Example Applications

- The following examples can be found in the Examples/MAX32665 directory of the SDK installation: -
    -
  • ADC - Analog-to-Digital Converter
    • -
  • AES - Advanced Encryption Standard
    • -
  • DSP - Digital Signal Processing
    • -
  • BLE_datc - Bluetooth Data Client
    • -
  • BLE_dats - Bluetooth Data Server
    • -
  • BLE_fcc - Bluetooth Sample for FCC Testing
    • -
  • BLE_fit - Bluetooth Fitness Device
    • -
  • BLE_FreeRTOS - BLE and Free-RTOS Application
    • -
  • BLE_mcs - Maxim custom Bluetooth Profile and Services
    • -
  • BLE_otac - Bluetooth Data Client with Over-the-Air Updates
    • -
  • BLE_otas - Bluetooth Data Server with Over-the-Air Updates
    • -
  • BLE_periph - Bluetooth Peripheral
    • -
  • BLE4_ctr - Bluetooth v4.2 Controller
    • -
  • BLE5_ctr - Bluetooth v5.2 Controller
    • -
  • Bootloader
    • -
  • Bootloader_Host
    • -
  • CRC - Cyclic Redundancy Check
    • -
  • DES - Data Encryption Standard
    • -
  • DMA - Direct Memory Access
    • -
  • ECC - Error Correction Code
    • -
  • Flash - Flash Memory
    • -
  • Flash-CLI - Flash Memory - Demonstration of storing non-volatile data
    • -
  • FreeRTOSDemo
    • -
  • GPIO - General Purpose Input/Output
    • -
  • Hash - CTB Hash
    • -
  • Hello_World
    • -
  • HTMR - High Speed Timer
    • -
  • I2C - The Standard 2-Wire Serial Protocol
    • -
  • I2C_MNGR - Demonstration of managing simultaneous I2C transaction requests
    • -
  • I2C_SCAN - Demonstration of discovering I2C devices on the bus
    • -
  • I2C_Sensor - Demonstration of communicating with an I2C temperature sensor
    • -
  • ICC - Internal Cache Controller
    • -
  • LP - Low Power
    • -
  • MAA - Modular Arithmetic Accelerator
    • -
  • OWM - 1-Wire Protocol
    • -
  • Pulse_Train
    • -
  • RPU - Resource Protection Unit
    • -
  • RTC - Real Time Clock
    • -
  • RTC_Backup - Demonstration of the RTC running in Backup mode
    • -
  • SCPA_OTP_Dump - Secure Communication Protocal Applet
    • -
  • SDHC_FAT
    • -
  • SDHC_Raw
    • -
  • Semaphore
    • -
  • SPI - Serial Peripheral Interface
    • -
  • SPIXF - SPI Execute-in-Place Flash
    • -
  • SPIXR - SPI Execute-in-Place RAM
    • -
  • SRCC - SPIXR Cache Controller
    • -
  • TMR - General Purpose Timer
    • -
  • TRNG - True Random Number Generator
    • -
  • UART - Universal Asynchronous Receiver/Transmitter
    • -
  • USB_CDCACM - USB CDC-ACM Driver Class
    • -
  • USB_CompositeDevice_MSC_CDC - USB Composite Device with Mass Storage and CDC-ACM Driver Class
    • -
  • USB_CompositeDevice_MSC_HID - USB Composite Device with Mass Storage and HID Driver Class
    • -
  • USB_HIDKeyboard - USB HID Driver Class
    • -
  • USB_MassStorage - USB Mass Storage Driver Class
    • -
  • Watchdog
    • -
  • WearLeveling
    • -
  • WUT - Wake Up Timer
    • -
-
- -

Device Information

- Additional information about the MAX32665 can be found in these documents: - - - - - \ No newline at end of file diff --git a/Documentation/MAX32670.html b/Documentation/MAX32670.html deleted file mode 100644 index a553939b50..0000000000 --- a/Documentation/MAX32670.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - MAX32670 Documentation - - - - -

MAX32670 Documentation

-
- -

SDK

-
    -
  • -
  • Toolchain
    • -
      -
    • -
    • - -
    • -
    • -
    • -
    • -
    • -
    -
-
- -

Example Applications

- The following examples can be found in the Examples/MAX32670 directory of the SDK installation: -
    -
  • AES - Advanced Encryption Standard
    • -
  • DSP - Digital Signal Processing
    • -
  • CRC - Cyclic Redundancy Check
    • -
  • DMA - Direct Memory Access
    • -
  • Flash - Flash Memory
    • -
  • Flash-CLI - Flash Memory - Demonstration of storing non-volatile data
    • -
  • FreeRTOSDemo
    • -
  • GPIO - General Purpose Input/Output
    • -
  • Hello_World
    • -
  • I2C - The Standard 2-Wire Serial Protocol
    • -
  • I2C_MNGR - Demonstration of managing simultaneous I2C transaction requests
    • -
  • I2C_SCAN - Demonstration of discovering I2C devices on the bus
    • -
  • I2C_Sensor - Demonstration of communicating with an I2C temperature sensor
    • -
  • I2S - Inter-IC Sound
    • -
  • ICC - Internal Cache Controller
    • -
  • LP - Low Power
    • -
  • RTC - Real Time Clock
    • -
  • RTC_Backup - Demonstration of the RTC running in Backup mode
    • -
  • SPI - Serial Peripheral Interface
    • -
  • SPI_Usecase - Serial Peripheral Interface Use Case
    • -
  • TMR - General Purpose Timer
    • -
  • TRNG - True Random Number Generator
    • -
  • UART - Universal Asynchronous Receiver/Transmitter
    • -
  • Watchdog
    • -
  • WearLeveling
    • -
-
- -

Device Information

- Additional information about the MAX32670 can be found in these documents: - - - - - \ No newline at end of file diff --git a/Documentation/MAX32672.html b/Documentation/MAX32672.html deleted file mode 100644 index 27536168cf..0000000000 --- a/Documentation/MAX32672.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - MAX32672 Documentation - - - - -

MAX32672 Documentation

-
- -

SDK

-
    -
  • -
  • Toolchain
    • -
      -
    • -
    • - -
    • -
    • -
    • -
    • -
    • -
    -
-
- -

Example Applications

- The following examples can be found in the Examples/MAX32672 directory of the SDK installation: -
    -
  • ADC - Analog-to-Digital Converter
    • -
  • AES - Advanced Encryption Standard
    • -
  • DSP - Digital Signal Processing
    • -
  • Comparator
    • -
  • CRC - Cyclic Redundancy Check
    • -
  • CTB_AES - Cryptographic Toolbox Advanced Encryption Standard
    • -
  • DMA - Direct Memory Access
    • -
  • Flash - Flash Memory
    • -
  • Flash-CLI - Flash Memory - Demonstration of storing non-volatile data
    • -
  • FreeRTOSDemo
    • -
  • GPIO - General Purpose Input/Output
    • -
  • Hello_World
    • -
  • I2C - The Standard 2-Wire Serial Protocol
    • -
  • I2C_MNGR - Demonstration of managing simultaneous I2C transaction requests
    • -
  • I2C_SCAN - Demonstration of discovering I2C devices on the bus
    • -
  • I2C_Sensor - Demonstration of communicating with an I2C temperature sensor
    • -
  • I2S - Inter-IC Sound
    • -
  • ICC - Internal Cache Controller
    • -
  • LP - Low Power
    • -
  • QDEC - Quadrature Encoder Interface
    • -
  • RTC - Real Time Clock
    • -
  • RTC_Backup - Demonstration of the RTC running in Backup mode
    • -
  • SCPA_OTP_Dump - Secure Communication Protocal Applet
    • -
  • SPI - Serial Peripheral Interface
    • -
  • TMR - General Purpose Timer
    • -
  • TRNG - True Random Number Generator
    • -
  • UART - Universal Asynchronous Receiver/Transmitter
    • -
  • Watchdog
    • -
  • WearLeveling
    • -
-
- -

Device Information

- Additional information about the MAX32672 can be found in these documents: - - - - - \ No newline at end of file diff --git a/Documentation/MAX32675.html b/Documentation/MAX32675.html deleted file mode 100644 index 92eaa0827d..0000000000 --- a/Documentation/MAX32675.html +++ /dev/null @@ -1,170 +0,0 @@ - - - - - MAX32675 Documentation - - - - -

MAX32675 Documentation

-
- -

SDK

-
    -
  • -
  • Toolchain
    • -
      -
    • -
    • - -
    • -
    • -
    • -
    • -
    • -
    -
-
- -

Example Applications

- The following examples can be found in the Examples/MAX32675 directory of the SDK installation: -
    -
  • ADC - Analog-to-Digital Converter
    • -
  • AES - Advanced Encryption Standard
    • -
  • AFE_DAC - Digital-to-Analog Converter
    • -
  • DSP - Digital Signal Processing
    • -
  • CRC - Cyclic Redundancy Check
    • -
  • DMA - Direct Memory Access
    • -
  • Flash - Flash Memory
    • -
  • Flash-CLI - Flash Memory - Demonstration of storing non-volatile data
    • -
  • FreeRTOSDemo
    • -
  • GPIO - General Purpose Input/Output
    • -
  • HART_UART - HART Modem UART
    • -
  • Hello_World
    • -
  • I2C - The Standard 2-Wire Serial Protocol
    • -
  • I2C_MNGR - Demonstration of managing simultaneous I2C transaction requests
    • -
  • I2C_SCAN - Demonstration of discovering I2C devices on the bus
    • -
  • I2C_Sensor - Demonstration of communicating with an I2C temperature sensor
    • -
  • I2S - Inter-IC Sound
    • -
  • ICC - Instruction Cache Controller
    • -
  • LP - Low Power
    • -
  • SPI - Serial Peripheral Interface
    • -
  • TMR - General Purpose Timer
    • -
  • TRNG - True Random Number Generator
    • -
  • UART - Universal Asynchronous Receiver/Transmitter
    • -
  • Watchdog
    • -
  • WearLeveling
    • -
-
- -

Device Information

- Additional information about the MAX32675 can be found in these documents: -
    -
  • IC Datasheet
    • -
  • IC User Guide - Coming Soon!
    • -
  • Evaluation Kit Schematic - Coming Soon!
    • -
- - - - \ No newline at end of file diff --git a/Documentation/MAX32680.html b/Documentation/MAX32680.html deleted file mode 100644 index 05e7d54726..0000000000 --- a/Documentation/MAX32680.html +++ /dev/null @@ -1,174 +0,0 @@ - - - - - MAX32680 Documentation - - - - -

MAX32680 Documentation

-
- -

SDK

-
    -
  • -
  • Toolchain
    • -
      -
    • -
    • -
    • -
    • -
    • -
    • -
    • -
    • -
    -
-
- -

Example Applications

- The following examples can be found in the Examples/MAX32680 directory of the SDK installation: -
    -
  • ADC - Analog-to-Digital Converter
    • -
  • AES - Advanced Encryption Standard
    • -
  • ADC - Analog Front-End Analog-to-Digital Converter
    • -
  • DSP - Digital Signal Processing
    • -
  • BLE_dats - Bluetooth Data Server
    • -
  • BLE4_ctr - Bluetooth v4.2 Controller
    • -
  • CRC - Cyclic Redundancy Check
    • -
  • DMA - Direct Memory Access
    • -
  • Flash - Flash Memory
    • -
  • Flash-CLI - Flash Memory - Demonstration of storing non-volatile data
    • -
  • FreeRTOSDemo
    • -
  • GPIO - General Purpose Input/Output
    • -
  • HART_UART - HART Modem UART
    • -
  • Hello_World
    • -
  • Hello_World-riscv
    • -
  • I2C - The Standard 2-Wire Serial Protocol
    • -
  • I2C_MNGR - Demonstration of managing simultaneous I2C transaction requests
    • -
  • I2C_SCAN - Demonstration of discovering I2C devices on the bus
    • -
  • I2C_Sensor - Demonstration of communicating with an I2C temperature sensor
    • -
  • I2S - Inter-IC Sound
    • -
  • ICC - Instruction Cache Controller
    • -
  • LP - Low Power
    • -
  • Pulse_Train
    • -
  • RV_ARM_Loader
    • -
  • SPI - Serial Peripheral Interface
    • -
  • TMR - General Purpose Timer
    • -
  • TRNG - True Random Number Generator
    • -
  • UART - Universal Asynchronous Receiver/Transmitter
    • -
  • Watchdog
    • -
  • WearLeveling
    • -
  • WUT - Wakeup Timer
    • -
-
- -

Device Information

- Additional information about the MAX32680 can be found in these documents: -
    -
  • IC Datasheet
    • -
  • IC User Guide - Coming Soon!
    • -
  • Evaluation Kit Schematic - Coming Soon!
    • -
- - - - \ No newline at end of file diff --git a/Documentation/MAX32690.html b/Documentation/MAX32690.html deleted file mode 100644 index 991844ddd5..0000000000 --- a/Documentation/MAX32690.html +++ /dev/null @@ -1,193 +0,0 @@ - - - - - MAX32690 Documentation - - - - -

MAX32690 Documentation

-
- -

SDK

-
    -
  • -
  • Toolchain
    • -
      -
    • -
    • -
    • -
    • -
    • -
    • -
    • -
    • -
    -
-
- -

Example Applications

- The following examples can be found in the Examples/MAX32690 directory of the SDK installation: -
    -
  • ADC - Analog-to-Digital Converter
    • -
  • DSP - Digital Signal Processing
    • -
  • BLE_datc - Bluetooth Data Client
    • -
  • BLE_dats - Bluetooth Data Server
    • -
  • BLE_fcc - Bluetooth FCC Testing
    • -
  • BLE_fit - Bluetooth Fitness
    • -
  • BLE_FreeRTOS - Bluetooth FreeRTOS
    • -
  • BLE_mcs - Bluetooth Maxim Custom Profile
    • -
  • BLE_otac - Bluetooth Over-The-Air Client
    • -
  • BLE_otas - Bluetooth Over-The-Air Server
    • -
  • BLE_periph - Bluetooth - advertises as Peripheral
    • -
  • BLE4_ctr - Bluetooth v4.2 Controller
    • -
  • BLE5_ctr - Bluetooth v5.2 Controller
    • -
  • Bootloader
    • -
  • CAN - Controller Area Network
    • -
  • CRC - Cyclic Redundancy Check
    • -
  • CTB_AES - Cryptographic Toobox - Advanced Encryption Standard
    • -
  • DMA - Direct Memory Access
    • -
  • Flash - Flash Memory
    • -
  • Flash_CLI - Flash Memory - Command Line Interface
    • -
  • FreeRTOSDemo
    • -
  • GPIO - General Purpose Input/Output
    • -
  • Hash - SHA-256 Secure Hash Algorithm
    • -
  • HBMC - Hyberbus Memory Controller example that works with HyperRam or Xcellabus memories
    • -
  • Hello_World
    • -
  • I2C - The Standard 2-Wire Serial Protocol
    • -
  • I2C_MNGR - Demonstration of managing simultaneous I2C transaction requests
    • -
  • I2C_SCAN - Demonstration of discovering I2C devices on the bus
    • -
  • I2C_Sensor - Demonstration of communicating with an I2C temperature sensor
    • -
  • I2S - Inter-IC Sound
    • -
  • ICC - Instruction Cache Controller
    • -
  • LP - Low Power
    • -
  • LPCMP - Low Power Comparator
    • -
  • Pulse_Train
    • -
  • RTC - Real Time Clock
    • -
  • RTC_Backup - Real Time Clock Backup
    • -
  • RV_ARM_Loader - RISCV/ARM Loader
    • -
  • SCPA_OTP_Dump - Secure Communication Protocal Applet
    • -
  • SPI - Serial Peripheral Interface
    • -
  • TMR - General Purpose Timer
    • -
  • TRNG - True Random Number Generator
    • -
  • UART - Universal Asynchronous Receiver/Transmitter
    • -
  • USB_CDCACM - USB CDC-ACM Driver Class
    • -
  • USB_CompositeDevice_MSC_CDC - USB Composite Device with Mass Storage and CDC-ACM Driver Class
    • -
  • USB_CompositeDevice_MSC_HID - USB Composite Device with Mass Storage and HID Driver Class
    • -
  • USB_HIDKeyboard - USB HID Driver Class
    • -
  • USB_MassStorage - USB Mass Storage Driver Class
    • -
  • Watchdog
    • -
  • WearLeveling
    • -
  • WUT - Wakeup Timer
    • -
-
- -

Device Information

- Additional information about the MAX32690 can be found in these documents: -
    -
  • IC Datasheet - Coming Soon!
    • -
  • IC User Guide - Coming Soon!
    • -
  • Evaluation Kit Schematic - Coming Soon!
    • -
- - - - \ No newline at end of file diff --git a/Documentation/MAX78000.html b/Documentation/MAX78000.html deleted file mode 100644 index 90e85bec88..0000000000 --- a/Documentation/MAX78000.html +++ /dev/null @@ -1,219 +0,0 @@ - - - - - MAX78000 Documentation - - - - -

MAX78000 Documentation

-
- - Please visit Maxim's MAX78000 GitHub repository for: -
    -
  1. The latest versions of all files
    2. -
  2. Instructions for getting started with the evaluation kit. You may need to log in to GitHub before accessing.
    3. -
- - Additional information can be found in the following links. - -

SDK

-
    -
  • -
  • Toolchain
    • -
      -
    • -
    • -
    • -
    • -
    • -
    • -
    • -
    • -
    -
-
- -

Example Applications

- The following examples can be found in the Examples/MAX78000 directory of the SDK installation: - -
- -

Device Information

- Additional information about the MAX78000 can be found in these documents: - - - - - \ No newline at end of file diff --git a/Documentation/MAX78002.html b/Documentation/MAX78002.html deleted file mode 100644 index e2923690ed..0000000000 --- a/Documentation/MAX78002.html +++ /dev/null @@ -1,200 +0,0 @@ - - - - - MAX78002 Documentation - - - - -

MAX78002 Documentation

-
- - Please visit Maxim's MAX78002 GitHub repository for: -
    -
  1. The latest versions of all files - No location
    2. -
  2. Instructions for getting started with the evaluation kit - No location
    3. -
- - Additional information can be found in the following links. - -

SDK

-
    -
  • -
  • Toolchain
    • -
      -
    • -
    • -
    • -
    • -
    • -
    • -
    • -
    • -
    -
-
- -

Example Applications

- The following examples can be found in the Examples/MAX78002 directory of the SDK installation: - -
- -

Device Information

- Additional information about the MAX78002 can be found in these documents: -
    -
  • IC Datasheet - Coming Soon!
    • -
  • IC User Guide - Coming Soon!
    • -
  • Evaluation Kit Schematic - Coming Soon!
    • -
- - - - \ No newline at end of file diff --git a/Documentation/index.html b/Documentation/index.html deleted file mode 100644 index b31fbd62c8..0000000000 --- a/Documentation/index.html +++ /dev/null @@ -1,82 +0,0 @@ - - - - - Maxim SDK Documentation - - - - -

Maxim SDK Documentation

-
-

Supported Devices

-
    - -
  • MAX32520 (not currently installed)
    •  - - -
  • MAX32570 (not currently installed)
    •  - - -
  • MAX32650 (not currently installed)
    •  - - -
  • MAX32655 (not currently installed)
    •  - - -
  • MAX32660 (not currently installed)
    •  - - -
  • MAX32662 (not currently installed)
    •  - - -
  • MAX32665 (not currently installed)
    •  - - -
  • MAX32670 (not currently installed)
    •  - - -
  • MAX32672 (not currently installed)
    •  - - -
  • MAX32675 (not currently installed)
    •  - - -
  • MAX32680 (not currently installed)
    •  - - -
  • MAX32690 (not currently installed)
    •  - - -
  • MAX78000 (not currently installed)
    •  - - -
  • MAX78002 (not currently installed)
    •  - - -
- - \ No newline at end of file From 91db2e0e5f20c8284cbf7ae2d644063ea2eabc08 Mon Sep 17 00:00:00 2001 From: "Anderson, Glen" Date: Tue, 8 Oct 2024 09:13:47 -0400 Subject: [PATCH 07/18] Refactored file copying --- CONTRIBUTING.md | 303 +++++++++++++++++++++++++++++++++++++++++ Documentation/build.py | 63 ++++----- mkdocs.yml | 2 +- 3 files changed, 331 insertions(+), 37 deletions(-) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..1425417dc7 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,303 @@ +# Analog Devices MSDK Development and Contribution Guidelines + +## Development Flow + +Development for the MSDK also follows the official [GitHub development flow guidelines](https://docs.github.com/en/get-started/quickstart/github-flow). + +For beginners, [learngitbranching.js.org](https://learngitbranching.js.org/) is a great hands-on starting resource. + +## Contribution Guidelines + +The MSDK follows the [GitHub contribution guidelines](https://docs.github.com/en/get-started/quickstart/contributing-to-projects). + +External contributions from outside the [Analog Devices organization](https://github.com/analogdevicesinc) should be made via a Pull Request opened from a fork. Internal contributions should also preferrably use a fork where possible. + +If a direct branch on the mainline MSDK repo is made, the following branch naming conventions should be used when possible: + +- Bugfix/ticket: `fix/ticketnumber` +- New feature: `feature/branchname` +- Generic development branch: `dev/branchname` +- New and/or modified example branch: `example/branchname` + +## PR Title - Subject Responsibilites for Reviewers/Mergers/PR Owners + +Format: +`type(scope): Subject` + +For more information of the format, please review the [pull_request_template.md](https://github.com/analogdevicesinc/msdk/blob/main/Documentation/pull_request_template.md). + +These are the rules for the `Subject`. + +1. The first character is capitalized and the subject must not end with any punctuation (!,.?) +2. Use imperative mood in the Subjects - meaning the tone of the Subject should be like giving an order or request. + * “Add” instead of “Added” or “Adding”. + * “Fix” instead of “Fixed” or “Fixing”. + * “Update” instead of “Updated” or “Updating”. + * “Delete” instead of “Deleted” or “Deleting”. +3. The Subject contents should have useful and concise wording. + * No long descriptive subjects - not concise if it gets too descriptive. + * You can be more descriptive in the body or footer of the commit by running: + `git commit -m “Title contents” -m “Body contents” -m “Footer contents”` + * No simple titles like “Add small SPI change” +4. The Subject should include what parts are affected, if any. Only the parts’ CHIP NAME should be used in the Subject. No die names are allowed. + * For the most readability, append the affected parts list at the end of the Subject, so the important, beginning part of the commit message is visible when traversing through the MSDK repo on GitHub. + * The list of chip names should be in ascending numerical order in the Subject. + * Examples: + 1. `fix(CMSIS): Rename TRIMSIR registers for MAX32670 and MAX32675` + 2. `fix(Third-Party): Remove USB DMA support for MAX32655, MAX32665, MAX32690, MAX78000, and MAX78002` + 3. `feat(Examples): Add console output in Hello_World READMEs for all parts` + 4. `fix(Examples,PeriphDrivers): Deprecate MXC\_RTC\_GetSecond and MXC\_RTC\_GetSubSecond for all parts except for MAX32520` + * Use this type of wording if all but a few parts were affected to shorten the Subject. + * **TIP**: The auto-labeler workflow adds part labels to a PR depending on what specific files were updated. Use the list of labels to figure out what parts were affected by the PR's changes. +5. If the PR title is related to a Jira ticket or an issue, the Subject should begin with the ticket designation. + * Examples: + 1. `fix(CMSIS): MSDK-123: Add missing I2C Target registers for MAX32670, MAX32672, and MAX32675` + 2. `fix(PeriphDrivers): Ticket-321: Fix SPI hanging on 9-bit wide messages for all parts` + 3. `fix(Documentation): Issue #123: Revise steps for MSDK installation in the user guides` +6. When a merger “Squash and Merges” an approved PR to main, do not delete the PR number that is automatically appended to the title. Ideally, the PR title should be following our rules before approval, so the merger just needs to press the “Squash and Merge” button. + * Using previous examples from rule 4, this is what the commit should look like in the main branch: + 1. `fix(CMSIS): MSDK-123: Add missing I2C Target registers for all parts (#412)` + 2. `fix(PeriphDrivers): Ticket-321: Fix SPI hanging on 9-bit wide messages for all parts (#646)` + 3. `feat(Examples): Add console output in Hello_World READMEs for all parts (#342)` + 4. `fix(Examples,PeriphDrivers): Deprecate MXC\_RTC\_GetSecond and MXC\_RTC\_GetSubSecond for all parts except for MAX32520 (#248)` + +Please ensure all actions have passed or successfully completed before merging a PR into `main`. MSDK maintainers have permissions to merge approved PRs even with a failing action. + +## PR Format Rules (Workflow Enforced) +1. The type is case-sensitive and must be one of the listed types. +2. The scope is case-sensitive and must be one of the listed scopes. +3. The first word of the Subject must be capitalized. +4. The Subject must not end with any punctuation (periods, commas, exclamation marks). + +## Style Guide + +The MSDK code-base, for the most-part, follows the [Linux Kernel coding style](https://www.kernel.org/doc/html/v4.10/process/coding-style.html#linux-kernel-coding-style) _and_ [Google's C++ Style Guide](https://google.github.io/styleguide/cppguide.html) with the following exception(s): + +- Indentations are 4 spaces. + +Formatting and styling is enforced via [clang-format](https://www.kernel.org/doc/html/latest/process/clang-format.html) **version 14** and [cpplint](https://github.com/cpplint/cpplint), which automatically run checks against all PRs. A PR cannot be merged until it passes these checks. + +### Running the Linter & Formatter + +Both utilities can be run locally. cpplint should be run first, then clang-format. Additionally, both should be run from the root directory of the MSDK repo so that their config files are loaded properly. + +clang-format rules are loaded from the **.clang-format** and cpplint rules are loaded from **CPPLINT.cfg** in the root directory of the repo. As a result, the utilities must also be run from the root directory of the repo. + +#### cpplint + +[cpplint](https://github.com/cpplint/cpplint) enforces good code practices by scanning for common mistakes and ensuring certain higher-level code patterns are followed. It's a good idea to resolve the errors found by cpplint before before running clang-format, which deals with lower-level code styling and syntax patterns. + +1. `cd` into the root directory of the MSDK repo. + +2. Run cpplint. + + To run cpplint on a **file**, use `cpplint `. + + $ cpplint Examples/MAX78000/Hello_World/main.c + Done processing Examples/MAX78000/Hello_World/main.c + + To recursively run cpplint on an **entire directory**, use `cpplint --recursive `. + + $ cpplint --recursive Examples/MAX78000 + + Examples/MAX78000/ADC/example_config.h:1: #ifndef header guard has wrong style, please use: EXAMPLES_MAX78000_ADC_EXAMPLE_CONFIG_H_ [build/header_guard] [5] + Examples/MAX78000/ADC/example_config.h:14: #endif line should be "#endif // EXAMPLES_MAX78000_ADC_EXAMPLE_CONFIG_H_" [build/header_guard] [5] + Done processing Examples/MAX78000/ADC/example_config.h + Done processing Examples/MAX78000/ADC/main.c + Done processing Examples/MAX78000/AES/main.c + Done processing Examples/MAX78000/ARM-DSP/arm_bayes_example/arm_bayes_example_f32.c + ... + +3. Resolve any errors. + +4. `git add` and `git commit` any changes to your code. + +#### clang-format + +[clang-format](https://www.kernel.org/doc/html/latest/process/clang-format.html) is a code formatter and style checker that enforces a common style for the code-base. +**The MSDK uses version 14**, which is sometimes not available by default on some Linux distributions. It can be retrieved from [https://apt.llvm.org/](https://apt.llvm.org/). + +1. `cd` into the root directory of the MSDK repo. + +2. Run clang-format. + + To run a clang-format **_check_** on a file, use the `-n` "dry-run" flag. + + `clang-format-14 --style=file --Werror --verbose -n ` + + For example: + + $ clang-format-14 --style=file --Werror --verbose -n Examples/MAX78000/CRC/main.c + + Formatting [1/1] Examples/MAX78000/CRC/main.c + Examples/MAX78000/CRC/main.c:86:40: error: code should be clang-formatted [-Wclang-format-violations] + for (i = 0; i < DATA_LENGTH; i++) { array[i] = i; } + ^ + + To _apply_ the formatter to automatically format a file, use the `-i` flag. + + `clang-format-14 --style=file --Werror --verbose -i ` + + For example: + + $ clang-format-14 --style=file --verbose -i Examples/MAX78000/CRC/main.c + Formatting [1/1] Examples/MAX78000/CRC/main.c + + This will apply the formatter and overwrite the file. Check the formatter's work using `git diff`. + + :::diff + $ diff --git a/Examples/MAX78000/CRC/main.c b/Examples/MAX78000/CRC/main.c + index 1dda1feed..c16ceb962 100644 + --- a/Examples/MAX78000/CRC/main.c + +++ b/Examples/MAX78000/CRC/main.c + @@ -83,7 +83,9 @@ void Test_CRC(int asynchronous) + + printf(asynchronous ? "TEST CRC ASYNC\n" : "TEST CRC SYNC\n"); + + - for (i = 0; i < DATA_LENGTH; i++) { array[i] = i; } + + for (i = 0; i < DATA_LENGTH; i++) { + + array[i] = i; + + } + + To apply the formatter to multiple files, the `*` and `**` wildcard characters can be used. `*` matches any file or folder, and `**` _recursively_ matches any file or folder. + + To recursively run clang-format on all C files in an entire directory, use: + + `clang-format-14 --style=file --verbose -n /**/*.c`. + + For example: + + $ clang-format-14 --style=file --verbose -i Examples/MAX78000/ARM-DSP/**/*.c + + Formatting [1/24] Examples/MAX78000/ARM-DSP/arm_bayes_example/arm_bayes_example_f32.c + Formatting [2/24] Examples/MAX78000/ARM-DSP/arm_class_marks_example/arm_class_marks_example_f32.c + Formatting [3/24] Examples/MAX78000/ARM-DSP/arm_convolution_example/arm_convolution_example_f32.c + Formatting [4/24] Examples/MAX78000/ARM-DSP/arm_convolution_example/math_helper.c + Formatting [5/24] Examples/MAX78000/ARM-DSP/arm_dotproduct_example_f32/arm_dotproduct_example_f32.c + ... + + ... which runs the formatter for all C files in the `Examples/MAX78000/ARM-DSP` directory _and all its subdirectories_. It should be noted that `**` is not supported on native Windows, but `*` is. + +3. `git add` and `git commit` any changes to your code. Now, it's ready for a PR! The same checks will be automatically run against any PRs that are opened in the MSDK, and they must pass before the code can be approved. + +## Contributing Examples + +1. First, ensure that the example project has been linted and formatted to follow the [Style Guide](#style-guide) + +2. Copy the example project into the [Examples](https://github.com/analogdevicesinc/msdk/tree/main/Examples) folder of the SDK for the applicable target microcontrollers. + +3. `git add` and `git commit` the Example project. **Commit your project files before running MSDKGen.** + +4. Run the [MSDKGen](https://github.com/analogdevicesinc/MSDKGen) utility to ensure the example project's support files are updated to the latest version. + + python msdkgen.py update-all --projects yourprojectname --overwrite + +5. Re-test the project if applicable. + +6. If the updated files break any projects they can be restored to the previously working version using the `git restore` command. + + For example, the command below will restore all files in your current working directory. + + git restore ** + + The `git diff` command can also be used to inspect local changes to help identify the root cause. Ex: + + git diff ./ + +## Contributing Libraries + +Libraries should be added to the `Libraries` sub-folder of the MSDK. + +- All libraries should include a `libraryname.mk` file that can be added to `Libraries/libs.mk` via a toggle-switch. The filename should match the name of library as closely as possible, and expose any required [configuration variables](https://github.com/analogdevicesinc/VSCode-Maxim/tree/develop#build-configuration). + +- If necessary, a library may also include a "core" Makefile or set of Makefiles to build it as a standalone static library file. The naming convention is `lib.a`. + +### Self-Locating Makefile + +The first thing that the `libraryname.mk` file should do is locate its own directory and store it in a variable. The code snippet can be used to achieve this. + + :::Makefile + ifeq "$(LIBRARYNAME_DIR)" "" + # If LIBRARYNAME_DIR is not specified, this Makefile will locate itself. + LIBRARYNAME_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST)))) + endif + +All filepaths for the library should then use this `$(LIBRARYNAME_DIR)`-type variable as their "root" for all filepaths. This is a safe and reliable way to self-reference internal library files. + +For an example, see the `Libraries/PeriphDrivers/periphdriver.mk` file. + +### Simple Libraries + +For simple libraries, it may be sufficient to just add the library's source files to the build using `VPATH` and `IPATH`. + +For example: + + :::Makefile + IPATH += $(LIBRARY_NAME_DIR)/include + VPATH += $(LIBRARY_NAME_DIR)/src + SRCS += libfile1.c + SRCS += libfile2.c + +An example of this is `MiscDrivers`, which is a simple source-file-only library. It gets its source code selectively added to the build via files like `Libraries/Boards/MAX78000/EvKit_V1/board.mk`. + +### Advanced Libraries + +More advanced libraries (including those with a large number of source files) should include a rule to build as a static library file with a [recursive Make call](https://www.gnu.org/software/make/manual/make.html#Recursion). + +This type of library should also set up the appropriate [configuration variables](https://github.com/analogdevicesinc/VSCode-Maxim/tree/develop#build-configuration) to include that static library to the build. + +## Contributing Documentation + +### Code Maintainers + +MSDK code should be documented using Doxygen syntax on all public functions, data structures, and variables. See the [**DoxyGen Manual**](https://www.doxygen.nl/manual/docblocks.html) for more details on syntax for C-like languages. + +DoxyGen is automatically run across the MSDK code as part of the User Guide's build process. A Peripheral API reference is generated for each target microcontroller using the Doxygen files located in `Libraries/PeriphDrivers/Documentation`, and the output is packaged as a sub-component of the User Guide when it's built. For code maintainers no action is needed other than maintaining up to date Doxygen documentation for all source code. + +### User Guide + +An MSDK User Guide is maintained in the [USERGUIDE.md](USERGUIDE.md) file. This document contains higher-level usage info for the MSDK. If a part, IDE, or library is supported by the MSDK then there should be some relevant info in the User Guide covering its setup, configuration, and usage. + +When writing markdown links, relative paths should always be used. Additionally, links to local files on the user's filesystem **cannot** be used, since the online copy of the docs will throw a 404 on them. See [Writing Your Docs](https://www.mkdocs.org/user-guide/writing-your-docs/) for more details. + +Static resources such as images should be placed in the `res` folder. + +### Building the Documentation + +#### Local Builds + +The `Documentation/build.py` script can be used to build the MSDK User Guide and supporting documentation locally. This script: + +- Builds all the Peripheral API references using Doxygen and copies them into `Documentation` +- Copies any markdown (.md) files from the root of the repo into `Documentation` +- Builds the MSDK User Guide using [Mkdocs](https://www.mkdocs.org/), which packages everything in `Documentation` into a static HTML/CSS/JavaScript site in the `docs` folder. + +To **build** the docs: + +1. Install [doxygen](https://www.doxygen.nl/download.html) +2. Add doxygen's binary diretory to the [Environmental Path](https://learn.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v=office.14)) Variable +3. Install Python 3.10 or greater +4. Run the following commands + + ```sh + python -m venv venv + source venv/bin/activate # (MacOS/Linux) or venv\Scripts\activate (Windows) + pip install -r Documentation/requirements.txt + python Documentation/build.py + ``` + +The site will be built in the `docs` folder of the repo. + +To **preview** the generated site: + +`mkdocs serve` + +This will open a localhost test server with live re-loading. + +To **configure** the generated site, use `mkdocs.yml`. See [Mkdocs Configuration](https://www.mkdocs.org/user-guide/configuration/) for more details. + +#### Auto Builds and Deployment + +The **"Build & Deploy Docs"** Github Action will perform all the local steps above. Additionally, it will deploy the static site to the `gh-pages` branch of the repository for use with [Github Pages](https://pages.github.com/). When the `gh-pages` branch is updated, Pages will refresh the online copy of the documentation within ~5-10 mins. + +This auto-deploy procedure is triggered on every push to the `release` branch. diff --git a/Documentation/build.py b/Documentation/build.py index 90ee89601b..202ab581d8 100644 --- a/Documentation/build.py +++ b/Documentation/build.py @@ -136,54 +136,45 @@ def generate_examples_md(): def copy_sources(): - print("Copying root markdown files") - for f in repo.glob("*.md"): - print(f"-> {f.name}") - if f.name != "README.md": - shutil.copy( - f, here - ) # Workaround for https://github.com/mkdocs/mkdocs/issues/3313 - - print("Copying CLI markdown files") - cli_path = repo / "Libraries/CLI" - cli_path.mkdir(exist_ok=True, parents=True) - shutil.copy( - cli_path / "README.md", - here / "Libraries/CLI/README.md", - ) - - print("Copying bluetooth markdown files") - src = repo / "Tools/Bluetooth" - dst = here / "Tools/Bluetooth" - for f in src.glob("*.md"): - print(f"-> {f.name}") - if not dst.exists(): - dst.mkdir(parents=True, exist_ok=True) - shutil.copy(f, dst) - - cordio_docs_dir = repo / "Libraries/Cordio/docs" - platform_docs_dir = repo / "Libraries/Cordio/platform/Documentation" - print("Copying Cordio markdown files") - shutil.copytree(cordio_docs_dir, here / "Libraries/Cordio/docs", dirs_exist_ok=True) + files_to_copy = [ + (repo / "LICENSE.md", here), + (repo / "CONTRIBUTING.md", here), + (repo / "Libraries/CLI/README.md", here / "Libraries/CLI"), + (repo / "Tools/Bluetooth/*.md", here / "Tools/Bluetooth"), + (repo / "Libraries/Cordio/docs", here / "Libraries/Cordio/docs"), + ( + repo / "Libraries/Cordio/platform/Documentation", + here / "Libraries/Cordio/platform/Documentation", + ), + ] - print("Copying platform markdown files") - shutil.copytree( - platform_docs_dir, - here / "Libraries/Cordio/platform/Documentation", - dirs_exist_ok=True, - ) + print("Copying source documentation") + for src, dst in files_to_copy: + if not dst.exists(): + dst.mkdir(parents=True) + if "*" in str(src): + for f in src.parent.glob(src.name): + print(f"-> {f}") + shutil.copy(f, dst) + elif src.is_file(): + print(f"-> {src}") + shutil.copy(src, dst) + elif src.is_dir(): + print(f"-> {src}") + shutil.copytree(src, dst, dirs_exist_ok=True) def build_doxygen_docs(): # Run Doxygen builds + print("Building Doxygen docs...") periph_docs_dir = repo / "Libraries/PeriphDrivers/Documentation" for f in periph_docs_dir.glob("*_Doxyfile"): micro = f.name.split("_")[0].upper() # max32xxx_Doxyfile -> MAX32XXX if not (periph_docs_dir / micro).exists(): run(f"doxygen {f.name}", cwd=f.parent, shell=True, check=False) else: - print(f"{micro} Doxygen exists, skipping") + print(f"-> {micro} Doxygen exists, skipping") dest = here / "Libraries/PeriphDrivers/Documentation" / micro # ^ Recreate directory structure so built links work shutil.copytree(periph_docs_dir / micro, dest, dirs_exist_ok=True) diff --git a/mkdocs.yml b/mkdocs.yml index 4a981b293d..8923fd2a22 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -6,7 +6,7 @@ docs_dir: 'Documentation' site_dir: 'docs' nav: - Home: 'index.md' - - MSDK User Guide: 'USERGUIDE.md' + - MSDK User Guide: 'user-guide/index.md' - Cordio BLE User Guide: 'Libraries/Cordio/docs/CORDIO_USERGUIDE.md' - Contributing: 'CONTRIBUTING.md' theme: From 87b8dbf6428e754a5028f33f089835f01adfd00b Mon Sep 17 00:00:00 2001 From: "Anderson, Glen" Date: Tue, 8 Oct 2024 09:32:49 -0400 Subject: [PATCH 08/18] Fix table indentation --- Documentation/build.py | 37 +++++++++++++++++++++---------------- 1 file changed, 21 insertions(+), 16 deletions(-) diff --git a/Documentation/build.py b/Documentation/build.py index 202ab581d8..232cbf55f0 100644 --- a/Documentation/build.py +++ b/Documentation/build.py @@ -3,6 +3,7 @@ import re import shutil +import textwrap from dataclasses import dataclass from operator import attrgetter from pathlib import Path @@ -56,8 +57,9 @@ def generate_examples_md(): print("Searching for shared examples...") for directory in examples_dir.glob("*"): if directory.name in target_excludelist: - print(f"Skipping {directory.name}... (in exclude-list)") + print(f"Skipping {directory.name}... (in exclude-list)") continue + print(f"-> {directory.name}") target_micro = directory.name all_target_micros.add(target_micro) for main_file in directory.rglob("**/main.c"): @@ -86,16 +88,17 @@ def generate_examples_md(): if len(e.supported_parts) > 1: common_entries += f"| **{e.name}** | {e.description} | {'
'.join(e.supported_parts)} |\n" - markdown_content = f""" - ### Common Examples - - The following common examples are supported across multiple microcontrollers. + markdown_content = textwrap.dedent( + """ + ### Common Examples - | Example | Description | Supported Parts | - | ------- | ----------- | --------------- | - {common_entries} + The following common examples are supported across multiple microcontrollers. - """ + | Example | Description | Supported Parts | + | ------- | ----------- | --------------- | + """ + ) + markdown_content += common_entries # Generate markdown content for part-specific examples all_target_micros = sorted(all_target_micros) @@ -108,15 +111,17 @@ def generate_examples_md(): ] for target, examples in specific_examples.items(): - markdown_content += f""" - ### {target.upper()} Examples + markdown_content += textwrap.dedent( + f""" + ### {target.upper()} Examples - In addition to the [Common Examples](#common-examples), the following examples - are available specifically for the {target.upper()}. + In addition to the [Common Examples](#common-examples), the following examples + are available specifically for the {target.upper()}. - | Example | Description | MSDK Location | - | ------- | ----------- | ------------- | - """ + | Example | Description | MSDK Location | + | ------- | ----------- | ------------- | + """ + ) for e in examples: relative_path = e.folder.relative_to(repo).as_posix() github = ( From 9a7860ad407cc5dd80b224b80b0131bff4684fec Mon Sep 17 00:00:00 2001 From: "Anderson, Glen" Date: Tue, 8 Oct 2024 09:41:58 -0400 Subject: [PATCH 09/18] Remove CONTRIBUTING.md from Documentation --- .gitignore | 1 + CONTRIBUTING.md | 59 +++---- Documentation/CONTRIBUTING.md | 303 ---------------------------------- 3 files changed, 31 insertions(+), 332 deletions(-) delete mode 100644 Documentation/CONTRIBUTING.md diff --git a/.gitignore b/.gitignore index 98cb376592..d151e4634c 100644 --- a/.gitignore +++ b/.gitignore @@ -10,6 +10,7 @@ Documentation/Libraries Documentation/res Documentation/LICENSE.md Documentation/README.md +Documentation/CONTRIBUTING.md Documentation/Tools/Bluetooth/README.md Documentation/user-guide/examples.md Examples/MAX78000/PowerTest diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1425417dc7..339024d289 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,41 +21,41 @@ If a direct branch on the mainline MSDK repo is made, the following branch namin ## PR Title - Subject Responsibilites for Reviewers/Mergers/PR Owners -Format: +Format: `type(scope): Subject` For more information of the format, please review the [pull_request_template.md](https://github.com/analogdevicesinc/msdk/blob/main/Documentation/pull_request_template.md). These are the rules for the `Subject`. -1. The first character is capitalized and the subject must not end with any punctuation (!,.?) -2. Use imperative mood in the Subjects - meaning the tone of the Subject should be like giving an order or request. - * “Add” instead of “Added” or “Adding”. - * “Fix” instead of “Fixed” or “Fixing”. - * “Update” instead of “Updated” or “Updating”. - * “Delete” instead of “Deleted” or “Deleting”. -3. The Subject contents should have useful and concise wording. - * No long descriptive subjects - not concise if it gets too descriptive. - * You can be more descriptive in the body or footer of the commit by running: - `git commit -m “Title contents” -m “Body contents” -m “Footer contents”` - * No simple titles like “Add small SPI change” -4. The Subject should include what parts are affected, if any. Only the parts’ CHIP NAME should be used in the Subject. No die names are allowed. - * For the most readability, append the affected parts list at the end of the Subject, so the important, beginning part of the commit message is visible when traversing through the MSDK repo on GitHub. - * The list of chip names should be in ascending numerical order in the Subject. - * Examples: +1. The first character is capitalized and the subject must not end with any punctuation (!,.?) +2. Use imperative mood in the Subjects - meaning the tone of the Subject should be like giving an order or request. + - “Add” instead of “Added” or “Adding”. + - “Fix” instead of “Fixed” or “Fixing”. + - “Update” instead of “Updated” or “Updating”. + - “Delete” instead of “Deleted” or “Deleting”. +3. The Subject contents should have useful and concise wording. + - No long descriptive subjects - not concise if it gets too descriptive. + - You can be more descriptive in the body or footer of the commit by running: + `git commit -m “Title contents” -m “Body contents” -m “Footer contents”` + - No simple titles like “Add small SPI change” +4. The Subject should include what parts are affected, if any. Only the parts’ CHIP NAME should be used in the Subject. No die names are allowed. + - For the most readability, append the affected parts list at the end of the Subject, so the important, beginning part of the commit message is visible when traversing through the MSDK repo on GitHub. + - The list of chip names should be in ascending numerical order in the Subject. + - Examples: 1. `fix(CMSIS): Rename TRIMSIR registers for MAX32670 and MAX32675` 2. `fix(Third-Party): Remove USB DMA support for MAX32655, MAX32665, MAX32690, MAX78000, and MAX78002` 3. `feat(Examples): Add console output in Hello_World READMEs for all parts` 4. `fix(Examples,PeriphDrivers): Deprecate MXC\_RTC\_GetSecond and MXC\_RTC\_GetSubSecond for all parts except for MAX32520` - * Use this type of wording if all but a few parts were affected to shorten the Subject. - * **TIP**: The auto-labeler workflow adds part labels to a PR depending on what specific files were updated. Use the list of labels to figure out what parts were affected by the PR's changes. -5. If the PR title is related to a Jira ticket or an issue, the Subject should begin with the ticket designation. - * Examples: - 1. `fix(CMSIS): MSDK-123: Add missing I2C Target registers for MAX32670, MAX32672, and MAX32675` - 2. `fix(PeriphDrivers): Ticket-321: Fix SPI hanging on 9-bit wide messages for all parts` + - Use this type of wording if all but a few parts were affected to shorten the Subject. + - **TIP**: The auto-labeler workflow adds part labels to a PR depending on what specific files were updated. Use the list of labels to figure out what parts were affected by the PR's changes. +5. If the PR title is related to a Jira ticket or an issue, the Subject should begin with the ticket designation. + - Examples: + 1. `fix(CMSIS): MSDK-123: Add missing I2C Target registers for MAX32670, MAX32672, and MAX32675` + 2. `fix(PeriphDrivers): Ticket-321: Fix SPI hanging on 9-bit wide messages for all parts` 3. `fix(Documentation): Issue #123: Revise steps for MSDK installation in the user guides` -6. When a merger “Squash and Merges” an approved PR to main, do not delete the PR number that is automatically appended to the title. Ideally, the PR title should be following our rules before approval, so the merger just needs to press the “Squash and Merge” button. - * Using previous examples from rule 4, this is what the commit should look like in the main branch: +6. When a merger “Squash and Merges” an approved PR to main, do not delete the PR number that is automatically appended to the title. Ideally, the PR title should be following our rules before approval, so the merger just needs to press the “Squash and Merge” button. + - Using previous examples from rule 4, this is what the commit should look like in the main branch: 1. `fix(CMSIS): MSDK-123: Add missing I2C Target registers for all parts (#412)` 2. `fix(PeriphDrivers): Ticket-321: Fix SPI hanging on 9-bit wide messages for all parts (#646)` 3. `feat(Examples): Add console output in Hello_World READMEs for all parts (#342)` @@ -64,10 +64,11 @@ These are the rules for the `Subject`. Please ensure all actions have passed or successfully completed before merging a PR into `main`. MSDK maintainers have permissions to merge approved PRs even with a failing action. ## PR Format Rules (Workflow Enforced) -1. The type is case-sensitive and must be one of the listed types. -2. The scope is case-sensitive and must be one of the listed scopes. -3. The first word of the Subject must be capitalized. -4. The Subject must not end with any punctuation (periods, commas, exclamation marks). + +1. The type is case-sensitive and must be one of the listed types. +2. The scope is case-sensitive and must be one of the listed scopes. +3. The first word of the Subject must be capitalized. +4. The Subject must not end with any punctuation (periods, commas, exclamation marks). ## Style Guide @@ -115,7 +116,7 @@ clang-format rules are loaded from the **.clang-format** and cpplint rules are l #### clang-format [clang-format](https://www.kernel.org/doc/html/latest/process/clang-format.html) is a code formatter and style checker that enforces a common style for the code-base. -**The MSDK uses version 14**, which is sometimes not available by default on some Linux distributions. It can be retrieved from [https://apt.llvm.org/](https://apt.llvm.org/). +**The MSDK uses version 14**, which is sometimes not available by default on some Linux distributions. It can be retrieved from [https://apt.llvm.org/](https://apt.llvm.org/). 1. `cd` into the root directory of the MSDK repo. diff --git a/Documentation/CONTRIBUTING.md b/Documentation/CONTRIBUTING.md deleted file mode 100644 index 1425417dc7..0000000000 --- a/Documentation/CONTRIBUTING.md +++ /dev/null @@ -1,303 +0,0 @@ -# Analog Devices MSDK Development and Contribution Guidelines - -## Development Flow - -Development for the MSDK also follows the official [GitHub development flow guidelines](https://docs.github.com/en/get-started/quickstart/github-flow). - -For beginners, [learngitbranching.js.org](https://learngitbranching.js.org/) is a great hands-on starting resource. - -## Contribution Guidelines - -The MSDK follows the [GitHub contribution guidelines](https://docs.github.com/en/get-started/quickstart/contributing-to-projects). - -External contributions from outside the [Analog Devices organization](https://github.com/analogdevicesinc) should be made via a Pull Request opened from a fork. Internal contributions should also preferrably use a fork where possible. - -If a direct branch on the mainline MSDK repo is made, the following branch naming conventions should be used when possible: - -- Bugfix/ticket: `fix/ticketnumber` -- New feature: `feature/branchname` -- Generic development branch: `dev/branchname` -- New and/or modified example branch: `example/branchname` - -## PR Title - Subject Responsibilites for Reviewers/Mergers/PR Owners - -Format: -`type(scope): Subject` - -For more information of the format, please review the [pull_request_template.md](https://github.com/analogdevicesinc/msdk/blob/main/Documentation/pull_request_template.md). - -These are the rules for the `Subject`. - -1. The first character is capitalized and the subject must not end with any punctuation (!,.?) -2. Use imperative mood in the Subjects - meaning the tone of the Subject should be like giving an order or request. - * “Add” instead of “Added” or “Adding”. - * “Fix” instead of “Fixed” or “Fixing”. - * “Update” instead of “Updated” or “Updating”. - * “Delete” instead of “Deleted” or “Deleting”. -3. The Subject contents should have useful and concise wording. - * No long descriptive subjects - not concise if it gets too descriptive. - * You can be more descriptive in the body or footer of the commit by running: - `git commit -m “Title contents” -m “Body contents” -m “Footer contents”` - * No simple titles like “Add small SPI change” -4. The Subject should include what parts are affected, if any. Only the parts’ CHIP NAME should be used in the Subject. No die names are allowed. - * For the most readability, append the affected parts list at the end of the Subject, so the important, beginning part of the commit message is visible when traversing through the MSDK repo on GitHub. - * The list of chip names should be in ascending numerical order in the Subject. - * Examples: - 1. `fix(CMSIS): Rename TRIMSIR registers for MAX32670 and MAX32675` - 2. `fix(Third-Party): Remove USB DMA support for MAX32655, MAX32665, MAX32690, MAX78000, and MAX78002` - 3. `feat(Examples): Add console output in Hello_World READMEs for all parts` - 4. `fix(Examples,PeriphDrivers): Deprecate MXC\_RTC\_GetSecond and MXC\_RTC\_GetSubSecond for all parts except for MAX32520` - * Use this type of wording if all but a few parts were affected to shorten the Subject. - * **TIP**: The auto-labeler workflow adds part labels to a PR depending on what specific files were updated. Use the list of labels to figure out what parts were affected by the PR's changes. -5. If the PR title is related to a Jira ticket or an issue, the Subject should begin with the ticket designation. - * Examples: - 1. `fix(CMSIS): MSDK-123: Add missing I2C Target registers for MAX32670, MAX32672, and MAX32675` - 2. `fix(PeriphDrivers): Ticket-321: Fix SPI hanging on 9-bit wide messages for all parts` - 3. `fix(Documentation): Issue #123: Revise steps for MSDK installation in the user guides` -6. When a merger “Squash and Merges” an approved PR to main, do not delete the PR number that is automatically appended to the title. Ideally, the PR title should be following our rules before approval, so the merger just needs to press the “Squash and Merge” button. - * Using previous examples from rule 4, this is what the commit should look like in the main branch: - 1. `fix(CMSIS): MSDK-123: Add missing I2C Target registers for all parts (#412)` - 2. `fix(PeriphDrivers): Ticket-321: Fix SPI hanging on 9-bit wide messages for all parts (#646)` - 3. `feat(Examples): Add console output in Hello_World READMEs for all parts (#342)` - 4. `fix(Examples,PeriphDrivers): Deprecate MXC\_RTC\_GetSecond and MXC\_RTC\_GetSubSecond for all parts except for MAX32520 (#248)` - -Please ensure all actions have passed or successfully completed before merging a PR into `main`. MSDK maintainers have permissions to merge approved PRs even with a failing action. - -## PR Format Rules (Workflow Enforced) -1. The type is case-sensitive and must be one of the listed types. -2. The scope is case-sensitive and must be one of the listed scopes. -3. The first word of the Subject must be capitalized. -4. The Subject must not end with any punctuation (periods, commas, exclamation marks). - -## Style Guide - -The MSDK code-base, for the most-part, follows the [Linux Kernel coding style](https://www.kernel.org/doc/html/v4.10/process/coding-style.html#linux-kernel-coding-style) _and_ [Google's C++ Style Guide](https://google.github.io/styleguide/cppguide.html) with the following exception(s): - -- Indentations are 4 spaces. - -Formatting and styling is enforced via [clang-format](https://www.kernel.org/doc/html/latest/process/clang-format.html) **version 14** and [cpplint](https://github.com/cpplint/cpplint), which automatically run checks against all PRs. A PR cannot be merged until it passes these checks. - -### Running the Linter & Formatter - -Both utilities can be run locally. cpplint should be run first, then clang-format. Additionally, both should be run from the root directory of the MSDK repo so that their config files are loaded properly. - -clang-format rules are loaded from the **.clang-format** and cpplint rules are loaded from **CPPLINT.cfg** in the root directory of the repo. As a result, the utilities must also be run from the root directory of the repo. - -#### cpplint - -[cpplint](https://github.com/cpplint/cpplint) enforces good code practices by scanning for common mistakes and ensuring certain higher-level code patterns are followed. It's a good idea to resolve the errors found by cpplint before before running clang-format, which deals with lower-level code styling and syntax patterns. - -1. `cd` into the root directory of the MSDK repo. - -2. Run cpplint. - - To run cpplint on a **file**, use `cpplint `. - - $ cpplint Examples/MAX78000/Hello_World/main.c - Done processing Examples/MAX78000/Hello_World/main.c - - To recursively run cpplint on an **entire directory**, use `cpplint --recursive `. - - $ cpplint --recursive Examples/MAX78000 - - Examples/MAX78000/ADC/example_config.h:1: #ifndef header guard has wrong style, please use: EXAMPLES_MAX78000_ADC_EXAMPLE_CONFIG_H_ [build/header_guard] [5] - Examples/MAX78000/ADC/example_config.h:14: #endif line should be "#endif // EXAMPLES_MAX78000_ADC_EXAMPLE_CONFIG_H_" [build/header_guard] [5] - Done processing Examples/MAX78000/ADC/example_config.h - Done processing Examples/MAX78000/ADC/main.c - Done processing Examples/MAX78000/AES/main.c - Done processing Examples/MAX78000/ARM-DSP/arm_bayes_example/arm_bayes_example_f32.c - ... - -3. Resolve any errors. - -4. `git add` and `git commit` any changes to your code. - -#### clang-format - -[clang-format](https://www.kernel.org/doc/html/latest/process/clang-format.html) is a code formatter and style checker that enforces a common style for the code-base. -**The MSDK uses version 14**, which is sometimes not available by default on some Linux distributions. It can be retrieved from [https://apt.llvm.org/](https://apt.llvm.org/). - -1. `cd` into the root directory of the MSDK repo. - -2. Run clang-format. - - To run a clang-format **_check_** on a file, use the `-n` "dry-run" flag. - - `clang-format-14 --style=file --Werror --verbose -n ` - - For example: - - $ clang-format-14 --style=file --Werror --verbose -n Examples/MAX78000/CRC/main.c - - Formatting [1/1] Examples/MAX78000/CRC/main.c - Examples/MAX78000/CRC/main.c:86:40: error: code should be clang-formatted [-Wclang-format-violations] - for (i = 0; i < DATA_LENGTH; i++) { array[i] = i; } - ^ - - To _apply_ the formatter to automatically format a file, use the `-i` flag. - - `clang-format-14 --style=file --Werror --verbose -i ` - - For example: - - $ clang-format-14 --style=file --verbose -i Examples/MAX78000/CRC/main.c - Formatting [1/1] Examples/MAX78000/CRC/main.c - - This will apply the formatter and overwrite the file. Check the formatter's work using `git diff`. - - :::diff - $ diff --git a/Examples/MAX78000/CRC/main.c b/Examples/MAX78000/CRC/main.c - index 1dda1feed..c16ceb962 100644 - --- a/Examples/MAX78000/CRC/main.c - +++ b/Examples/MAX78000/CRC/main.c - @@ -83,7 +83,9 @@ void Test_CRC(int asynchronous) - - printf(asynchronous ? "TEST CRC ASYNC\n" : "TEST CRC SYNC\n"); - - - for (i = 0; i < DATA_LENGTH; i++) { array[i] = i; } - + for (i = 0; i < DATA_LENGTH; i++) { - + array[i] = i; - + } - - To apply the formatter to multiple files, the `*` and `**` wildcard characters can be used. `*` matches any file or folder, and `**` _recursively_ matches any file or folder. - - To recursively run clang-format on all C files in an entire directory, use: - - `clang-format-14 --style=file --verbose -n /**/*.c`. - - For example: - - $ clang-format-14 --style=file --verbose -i Examples/MAX78000/ARM-DSP/**/*.c - - Formatting [1/24] Examples/MAX78000/ARM-DSP/arm_bayes_example/arm_bayes_example_f32.c - Formatting [2/24] Examples/MAX78000/ARM-DSP/arm_class_marks_example/arm_class_marks_example_f32.c - Formatting [3/24] Examples/MAX78000/ARM-DSP/arm_convolution_example/arm_convolution_example_f32.c - Formatting [4/24] Examples/MAX78000/ARM-DSP/arm_convolution_example/math_helper.c - Formatting [5/24] Examples/MAX78000/ARM-DSP/arm_dotproduct_example_f32/arm_dotproduct_example_f32.c - ... - - ... which runs the formatter for all C files in the `Examples/MAX78000/ARM-DSP` directory _and all its subdirectories_. It should be noted that `**` is not supported on native Windows, but `*` is. - -3. `git add` and `git commit` any changes to your code. Now, it's ready for a PR! The same checks will be automatically run against any PRs that are opened in the MSDK, and they must pass before the code can be approved. - -## Contributing Examples - -1. First, ensure that the example project has been linted and formatted to follow the [Style Guide](#style-guide) - -2. Copy the example project into the [Examples](https://github.com/analogdevicesinc/msdk/tree/main/Examples) folder of the SDK for the applicable target microcontrollers. - -3. `git add` and `git commit` the Example project. **Commit your project files before running MSDKGen.** - -4. Run the [MSDKGen](https://github.com/analogdevicesinc/MSDKGen) utility to ensure the example project's support files are updated to the latest version. - - python msdkgen.py update-all --projects yourprojectname --overwrite - -5. Re-test the project if applicable. - -6. If the updated files break any projects they can be restored to the previously working version using the `git restore` command. - - For example, the command below will restore all files in your current working directory. - - git restore ** - - The `git diff` command can also be used to inspect local changes to help identify the root cause. Ex: - - git diff ./ - -## Contributing Libraries - -Libraries should be added to the `Libraries` sub-folder of the MSDK. - -- All libraries should include a `libraryname.mk` file that can be added to `Libraries/libs.mk` via a toggle-switch. The filename should match the name of library as closely as possible, and expose any required [configuration variables](https://github.com/analogdevicesinc/VSCode-Maxim/tree/develop#build-configuration). - -- If necessary, a library may also include a "core" Makefile or set of Makefiles to build it as a standalone static library file. The naming convention is `lib.a`. - -### Self-Locating Makefile - -The first thing that the `libraryname.mk` file should do is locate its own directory and store it in a variable. The code snippet can be used to achieve this. - - :::Makefile - ifeq "$(LIBRARYNAME_DIR)" "" - # If LIBRARYNAME_DIR is not specified, this Makefile will locate itself. - LIBRARYNAME_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST)))) - endif - -All filepaths for the library should then use this `$(LIBRARYNAME_DIR)`-type variable as their "root" for all filepaths. This is a safe and reliable way to self-reference internal library files. - -For an example, see the `Libraries/PeriphDrivers/periphdriver.mk` file. - -### Simple Libraries - -For simple libraries, it may be sufficient to just add the library's source files to the build using `VPATH` and `IPATH`. - -For example: - - :::Makefile - IPATH += $(LIBRARY_NAME_DIR)/include - VPATH += $(LIBRARY_NAME_DIR)/src - SRCS += libfile1.c - SRCS += libfile2.c - -An example of this is `MiscDrivers`, which is a simple source-file-only library. It gets its source code selectively added to the build via files like `Libraries/Boards/MAX78000/EvKit_V1/board.mk`. - -### Advanced Libraries - -More advanced libraries (including those with a large number of source files) should include a rule to build as a static library file with a [recursive Make call](https://www.gnu.org/software/make/manual/make.html#Recursion). - -This type of library should also set up the appropriate [configuration variables](https://github.com/analogdevicesinc/VSCode-Maxim/tree/develop#build-configuration) to include that static library to the build. - -## Contributing Documentation - -### Code Maintainers - -MSDK code should be documented using Doxygen syntax on all public functions, data structures, and variables. See the [**DoxyGen Manual**](https://www.doxygen.nl/manual/docblocks.html) for more details on syntax for C-like languages. - -DoxyGen is automatically run across the MSDK code as part of the User Guide's build process. A Peripheral API reference is generated for each target microcontroller using the Doxygen files located in `Libraries/PeriphDrivers/Documentation`, and the output is packaged as a sub-component of the User Guide when it's built. For code maintainers no action is needed other than maintaining up to date Doxygen documentation for all source code. - -### User Guide - -An MSDK User Guide is maintained in the [USERGUIDE.md](USERGUIDE.md) file. This document contains higher-level usage info for the MSDK. If a part, IDE, or library is supported by the MSDK then there should be some relevant info in the User Guide covering its setup, configuration, and usage. - -When writing markdown links, relative paths should always be used. Additionally, links to local files on the user's filesystem **cannot** be used, since the online copy of the docs will throw a 404 on them. See [Writing Your Docs](https://www.mkdocs.org/user-guide/writing-your-docs/) for more details. - -Static resources such as images should be placed in the `res` folder. - -### Building the Documentation - -#### Local Builds - -The `Documentation/build.py` script can be used to build the MSDK User Guide and supporting documentation locally. This script: - -- Builds all the Peripheral API references using Doxygen and copies them into `Documentation` -- Copies any markdown (.md) files from the root of the repo into `Documentation` -- Builds the MSDK User Guide using [Mkdocs](https://www.mkdocs.org/), which packages everything in `Documentation` into a static HTML/CSS/JavaScript site in the `docs` folder. - -To **build** the docs: - -1. Install [doxygen](https://www.doxygen.nl/download.html) -2. Add doxygen's binary diretory to the [Environmental Path](https://learn.microsoft.com/en-us/previous-versions/office/developer/sharepoint-2010/ee537574(v=office.14)) Variable -3. Install Python 3.10 or greater -4. Run the following commands - - ```sh - python -m venv venv - source venv/bin/activate # (MacOS/Linux) or venv\Scripts\activate (Windows) - pip install -r Documentation/requirements.txt - python Documentation/build.py - ``` - -The site will be built in the `docs` folder of the repo. - -To **preview** the generated site: - -`mkdocs serve` - -This will open a localhost test server with live re-loading. - -To **configure** the generated site, use `mkdocs.yml`. See [Mkdocs Configuration](https://www.mkdocs.org/user-guide/configuration/) for more details. - -#### Auto Builds and Deployment - -The **"Build & Deploy Docs"** Github Action will perform all the local steps above. Additionally, it will deploy the static site to the `gh-pages` branch of the repository for use with [Github Pages](https://pages.github.com/). When the `gh-pages` branch is updated, Pages will refresh the online copy of the documentation within ~5-10 mins. - -This auto-deploy procedure is triggered on every push to the `release` branch. From 430272ccb32a8a00909be60201caa440dcb1cd20 Mon Sep 17 00:00:00 2001 From: "Kernion, Juliette" Date: Tue, 8 Oct 2024 16:33:25 -0700 Subject: [PATCH 10/18] Fixed UG broken links, linter errors, etc. post-file migration/split --- .../user-guide/board-support-pkgs.md | 26 +++--- Documentation/user-guide/build-system.md | 26 +++--- Documentation/user-guide/command-line-dev.md | 8 +- Documentation/user-guide/debuggers.md | 16 ++-- Documentation/user-guide/developer-notes.md | 2 +- Documentation/user-guide/eclipse.md | 8 +- Documentation/user-guide/examples.md.tpl | 6 +- Documentation/user-guide/getting-started.md | 88 +++++++++--------- Documentation/user-guide/index.md | 91 +++++++++---------- Documentation/user-guide/installation.md | 3 +- Documentation/user-guide/libraries.md | 48 +++++----- .../user-guide/visual-studio-code.md | 26 +++--- 12 files changed, 173 insertions(+), 175 deletions(-) diff --git a/Documentation/user-guide/board-support-pkgs.md b/Documentation/user-guide/board-support-pkgs.md index b3b49e6fc6..26424aaefd 100644 --- a/Documentation/user-guide/board-support-pkgs.md +++ b/Documentation/user-guide/board-support-pkgs.md @@ -1,6 +1,6 @@ # Board Support Packages -The MSDK supports multiple parts and evaluation platforms (see [supported parts](#supported-parts)) through **"Board Support Packages" (BSPs)**. For microcontrollers with multiple evaluation platforms, multiple BSPs will be available. +The MSDK supports multiple parts and evaluation platforms (see [supported parts](index.md#supported-parts)) through **"Board Support Packages" (BSPs)**. For microcontrollers with multiple evaluation platforms, multiple BSPs will be available. The role of a _BSP_ is to provide a hardware abstraction layer for the initialization and management of board-level hardware such as serial interfaces, pushbuttons, LEDs, external peripheral devices, TFT displays, etc. which will vary between evaluation platforms. The BSP abstraction layer also improves code portability to custom devices. @@ -11,9 +11,9 @@ The role of a _BSP_ is to provide a hardware abstraction layer for the initializ To set the BSP for a project: -- In **VS Code**: [How to Set the BSP (VS Code)](#how-to-set-the-bsp-vs-code) -- In **Eclipse**: [How to Set the BSP (Eclipse)](#how-to-set-the-bsp-eclipse) -- **Command-Line** Development: [How to Set the BSP (Command-Line)](#how-to-set-the-bsp-command-line) +- In **VS Code**: [How to Set the BSP (VS Code)](visual-studio-code.md#how-to-set-the-bsp-vs-code) +- In **Eclipse**: [How to Set the BSP (Eclipse)](eclipse.md#how-to-set-the-bsp-eclipse) +- **Command-Line** Development: [How to Set the BSP (Command-Line)](command-line-dev.md#how-to-set-the-bsp-command-line) ## BSP Table @@ -21,7 +21,7 @@ Available BSPs are located in the `Libraries/Boards` folder for each _Target Mic ![Figure 34](res/Fig34.jpg) -The name of a BSP's folder is used with the `BOARD` [build configuration variable](#build-configuration-variables) to build a project for a specific BSP. The table below matches the correct `BOARD` values to _external part numbers_. +The name of a BSP's folder is used with the `BOARD` [build configuration variable](build-system.md#build-configuration-variables) to build a project for a specific BSP. The table below matches the correct `BOARD` values to _external part numbers_. | External Part Number | `TARGET` | `BOARD` | | ---------------------------------------------|--------------- | -------------- | @@ -119,11 +119,11 @@ A custom BSP can implement one or all of the weak functions. The file structure └─ Source └─ board.c -The name of the BSP's root folder will be the string used with the `BOARD` [build configuration variable](#build-configuration-variables) to select it for a project. In the example above, one would use `BOARD = CustomBSP` to select it as the active BSP. +The name of the BSP's root folder will be the string used with the `BOARD` [build configuration variable](build-system.md#build-configuration-variables) to select it for a project. In the example above, one would use `BOARD = CustomBSP` to select it as the active BSP. ### BSP Search Directory -By default, the MSDK searches for BSPs in the `Libraries/Boards` folder for each microcontroller. This can be changed using the `BSP_SEARCH_DIR` [build configuration variable](#build-configuration-variables), which allows users to load a BSP from a directory outside of the MSDK. The MSDK also uses the `BOARD` variable in its search path. +By default, the MSDK searches for BSPs in the `Libraries/Boards` folder for each microcontroller. This can be changed using the `BSP_SEARCH_DIR` [build configuration variable](build-system.md#build-configuration-variables), which allows users to load a BSP from a directory outside of the MSDK. The MSDK also uses the `BOARD` variable in its search path. For example, the configuration... @@ -141,7 +141,7 @@ For example, the configuration... The following contents can be used as a bare-bones starter template for a custom BSP. -* _board.h_ +- _board.h_ :::C // board.h @@ -160,7 +160,7 @@ The following contents can be used as a bare-bones starter template for a custom */ int Board_Init(void); -* _board.c_ +- _board.c_ :::C //board.c @@ -173,7 +173,7 @@ The following contents can be used as a bare-bones starter template for a custom return E_NO_ERROR; } -* _board.mk_ +- _board.mk_ :::Makefile # board.mk @@ -189,18 +189,18 @@ The following contents can be used as a bare-bones starter template for a custom ## Disabling BSPs -It should also be noted that BSP integration can be disabled entirely by setting the `LIB_BOARD` [build configuration variable](#build-configuration-variables) to 0. This will skip the inclusion of the BSP's `board.mk` file entirely, and the default system initialization functions will be used. +It should also be noted that BSP integration can be disabled entirely by setting the `LIB_BOARD` [build configuration variable](build-system.md#build-configuration-variables) to 0. This will skip the inclusion of the BSP's `board.mk` file entirely, and the default system initialization functions will be used. This option can also be used to implement a custom BSP inside of a project's application code. For example, a user could implement `Board_Init` inside of a project's `main.c` file without having to create a separate BSP folder with `LIB_BOARD = 0`. -* _project.mk_ +- _project.mk_ :::Makefile # project.mk LIB_BOARD = 0 -* _main.c_ +- _main.c_ :::C // main.c diff --git a/Documentation/user-guide/build-system.md b/Documentation/user-guide/build-system.md index bef9fe250b..2d776ccf7c 100644 --- a/Documentation/user-guide/build-system.md +++ b/Documentation/user-guide/build-system.md @@ -63,7 +63,7 @@ For example, to enable hardware floating-point acceleration for a project, the * # "Makefile" that is located next to this one. # For instructions on how to use this system, see - # https://analogdevicesinc.github.io/msdk/USERGUIDE/ + # https://analogdevicesinc.github.io/msdk/Documentation/user-guide/index.md # ********************************************************** @@ -87,7 +87,7 @@ However, there is a _precedence hierarchy_ that should be taken into considerati The precedence hierarchy for the value of a configuration variable is: -- **IDE/command-line > project.mk > environment variable > default value** +* **IDE/command-line > project.mk > environment variable > default value** If a value is set in an IDE _and_ project.mk, the IDE's value will take precedence. However, the ["override" directive](https://www.gnu.org/software/make/manual/make.html#Override-Directive) can be used in project.mk to give it max precedence. @@ -101,8 +101,8 @@ 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-packages) 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](#bsp-search-directory) for more details. | +| `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. | ### Project Build Variables @@ -114,8 +114,8 @@ 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](#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.
Ex: Give a file called `libEXAMPLE.a`, write `PROJ_LIBS += EXAMPLE`
Additionally, ensure that the location of the library is added to `PROJ_LDFLAGS`.
Ex: `PROJ_LDFLAGS += -Lsome/library/search/directory` | +| `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 @@ -127,7 +127,7 @@ The following variables can be used to interface with the compiler to perform co | `PROJ_CFLAGS` | Add compiler flags to the build | **Use the `+=` operator with this variable**. Compiler flags can be added with this option, including compiler definitions. For each value, the same syntax should be used as if the compiler flag was passed in over the command line. These can include standard [GCC options](https://gcc.gnu.org/onlinedocs/gcc-10.4.0/gcc/Option-Summary.html#Option-Summary) and/or [ARM-specific](https://gcc.gnu.org/onlinedocs/gcc/ARM-Options.html) options. | | `PROJ_AFLAGS` | Add assemblers flag to the build | **Use the `+=` operator with this variable**. Assembler flags can be added with this option. | | `PROJ_OBJS` | Add object files to the build | **Use the `+=` operator with this variable**. If needed, object files (.o) can be added to the build with this option. | -| `DEBUG` | Toggle extra debug information | Set this to `1` to enable extra debug information at compile time. This generally improves the reliability of debugging at some increase in code size. Set to `0` to disable. +| `DEBUG` | Toggle extra debug information | Set this to `1` to enable extra debug information at compile time. This generally improves the reliability of debugging at some increase in code size. Set to `0` to disable. | ### Build Variables for the Linker @@ -143,10 +143,10 @@ The following build variables are used to control options specific to the Arm Co | Configuration Variable | Description | Details | | ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | | `MFLOAT_ABI` | Set the floating point acceleration level | Sets the floating-point acceleration level. Permitted values are `hard`, `soft`, and `softfp` (default). To enable full hardware acceleration instructions, use `hard`, but keep in mind that _all_ libraries your source code uses must also be compiled with `hard`. If there is any conflict, you'll get a linker error. For more details, see `-mfloat-abi` under [ARM Options](https://gcc.gnu.org/onlinedocs/gcc/ARM-Options.html). | -| `DEFAULT_OPTIMIZE_FLAGS` | Override the default extra optimization flags | Extra compiler optimization flags are added to the build. They are defined in `Libraries/CMSIS/Device/Maxim/GCC/gcc.mk`. These can be disabled entirely by setting this variable to empty (`DEFAULT_OPTIMIZE_FLAGS=`). | +| `DEFAULT_OPTIMIZE_FLAGS` | Override the default extra optimization flags | Extra compiler optimization flags are added to the build. They are defined in `Libraries/CMSIS/Device/Maxim/GCC/gcc.mk`. These can be disabled entirely by setting this variable to empty (`DEFAULT_OPTIMIZE_FLAGS=`). | | `DEFAULT_WARNING_FLAGS` | Override the default warning flags | Default flags controlling warning output are added in `Libraries/CMSIS/Device/Maxim/GCC/gcc.mk`. These can be disabled entirely by setting this variable to empty (`DEFAULT_OPTIMIZE_FLAGS=`). | | `MCPU` | Set the processor type | Set the target ARM processor. Directly maps to `-mcpu` under [ARM Options](https://gcc.gnu.org/onlinedocs/gcc/ARM-Options.html). This flag is handled by the MSDK and not typically changed manually. | -| `MFPU` | Set the FPU architecture | Set the floating point unit (FPU) architecture. Directly maps to `-mfpu` under [ARM Options](https://gcc.gnu.org/onlinedocs/gcc/ARM-Options.html). This flag is handled by the MSDK and not typically changed manually. | +| `MFPU` | Set the FPU architecture | Set the floating point unit (FPU) architecture. Directly maps to `-mfpu` under [ARM Options](https://gcc.gnu.org/onlinedocs/gcc/ARM-Options.html). This flag is handled by the MSDK and not typically changed manually. | ### Build Variables for RISC-V Cores @@ -155,13 +155,13 @@ The following build variables are used for RISC-V development. They are only av | Configuration Variable | Description | Details | | ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | | `RISCV_CORE` | Build a project for the RISC-V core | Set to `1` to convert an entire project to use the RISC-V toolchain. Only available on microcontrollers with a RISC-V core. | -| `RISCV_LOAD` | Compile and load project for the RISC-V core | **Only available on the MAX32655, MAX32680, and MAX32690**. Set to `1` compile the project specified by `RISCV_APP` for the RISC-V core and link it into the same binary as the current project. Useful for dual-core projects. +| `RISCV_LOAD` | Compile and load project for the RISC-V core | **Only available on the MAX32655, MAX32680, and MAX32690**. Set to `1` compile the project specified by `RISCV_APP` for the RISC-V core and link it into the same binary as the current project. Useful for dual-core projects. | | `RISCV_APP` | Project folder to compile for the `RISCV_LOAD` option | **Only available on the MAX32655, MAX32680, and MAX32690**. This option specifies the project to build for the RISC-V core when `RISCV_LOAD` is enabled. Must be a path relative to the project that enables `RISCV_LOAD`, or an absolute path. | | `RISCV_PREFIX` | Change the toolchain prefix | This option can be used to override the GCC toolchain prefix if needed. For example, to use the legacy RISC-V toolchain `RISCV_PREFIX = riscv-none-embed` will attempt to compile with `riscv-none-embed-gcc`. | ### Build Variables for Toggling Libraries -The following variables can be used to enable the [available libraries](#libraries) in the MSDK. Each library may also offer its own build configuration variables when enabled, which are documented in the [libraries](#libraries) section. +The following variables can be used to enable the [available libraries](libraries.md) in the MSDK. Each library may also offer its own build configuration variables when enabled, which are documented in the [libraries](libraries.md) section. | Configuration Variable | Description | Details | | ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | @@ -186,7 +186,7 @@ The following variables are specific to the PeriphDrivers library. | Configuration Variable | Description | Details | | ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| `MXC_SPI_VERSION` | Set the SPI drivers to use (default is `v1`) | The PeriphDrivers offer two versions of the SPI API in order to maintain backwards compatibility. Acceptable values are `v1` (legacy) or `v2`. See [The SPI V2 Developer Note](#spi-v2-library) for more details. | +| `MXC_SPI_VERSION` | Set the SPI drivers to use (default is `v1`) | The PeriphDrivers offer two versions of the SPI API in order to maintain backwards compatibility. Acceptable values are `v1` (legacy) or `v2`. See [The SPI V2 Developer Note](developer-notes.md#spi-v2-library) for more details. | ### Build Variables for Secure Boot Tools (SBTs) @@ -206,5 +206,5 @@ The following build variables can be used to control how to build output is form | Configuration Variable | Description | Details | | ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| `VERBOSE` | Toggle verbose builds | Set to `1` to enable a verbose build that prints exactly what the compiler is doing for each step. This is useful for troubleshooting. +| `VERBOSE` | Toggle verbose builds | Set to `1` to enable a verbose build that prints exactly what the compiler is doing for each step. This is useful for troubleshooting. | | `FORCE_COLOR` | Force colorized compiler output | By default, GCC will attempt to autodetect whether colorized output is supported or not. Set to `1` to force color (equivalent to `PROJ_CFLAGS += -fdiagnostics-color=always`). This is useful for forcing color in CI systems. | diff --git a/Documentation/user-guide/command-line-dev.md b/Documentation/user-guide/command-line-dev.md index fbbc5a3f98..76f82a21a2 100644 --- a/Documentation/user-guide/command-line-dev.md +++ b/Documentation/user-guide/command-line-dev.md @@ -2,11 +2,11 @@ This section offers more detailed info on command-line development. -For setup/quick-start, see ["Getting Started with Command-Line Development"](#getting-started-with-command-line-development). +For setup/quick-start, see ["Getting Started with Command-Line Development"](getting-started.md#getting-started-with-command-line-development). ## How to Set the BSP (Command-Line) -- To _persistently_ the BSP, set the **`BOARD`** _[Build Configuration Variable](#build-configuration-variables)_ by editing the **project.mk** that can be found inside each project. +- To _persistently_ the BSP, set the **`BOARD`** _[Build Configuration Variable](build-system.md#build-configuration-variables)_ by editing the **project.mk** that can be found inside each project. :::makefile # This file can be used to set build configuration @@ -45,7 +45,7 @@ For setup/quick-start, see ["Getting Started with Command-Line Development"](#ge 1. `cd` into the project folder. 2. Run `make clean` - **Project clean**: `make clean` deletes the project `build` folder and all of its contents. - - **Library clean**: `make distclean` can be used to clean out _all_ build products, including the project `build` folder and all [peripheral driver](#peripheral-driver-api) libraries. + - **Library clean**: `make distclean` can be used to clean out _all_ build products, including the project `build` folder and all [peripheral driver](libraries.md#peripheral-driver-api) libraries. ## Flashing on the Command-Line @@ -162,7 +162,7 @@ For setup/quick-start, see ["Getting Started with Command-Line Development"](#ge 3. `cd` into the location of the copied example project. -4. Run the following command to launch a **GDB *client***. +4. Run the following command to launch a **GDB _client_**. arm-none-eabi-gdb --se=build/.elf diff --git a/Documentation/user-guide/debuggers.md b/Documentation/user-guide/debuggers.md index ca7793eea7..473cdc0860 100644 --- a/Documentation/user-guide/debuggers.md +++ b/Documentation/user-guide/debuggers.md @@ -4,19 +4,19 @@ - ???+ warning "**⚠️ Warning**" It’s important to note some fundamental limitations of debugging the MSDK's supported parts. These limitations may make the device difficult (or impossible) for the debugger to connect in certain states. In such cases, the device can attempt to be recovered using a [MAX32625PICO](#max32625pico-pico). See [How to Unlock a Microcontroller That Can No Longer Be Programmed](#how-to-unlock-a-microcontroller-that-can-no-longer-be-programmed) - * A debugger can not be connected to a microcontroller _while_ the device is in reset. - * A microcontroller can not be debugged while it's _Sleep_, _Low Power Mode_, _Micro Power Mode_, _Standby_, _Backup_, or _Shutdown_ mode. These modes shut down the SWD clock. - * For low-power development, it's recommended to place a 2-second blocking delay at the start of `main`. + - A debugger can not be connected to a microcontroller _while_ the device is in reset. + - A microcontroller can not be debugged while it's _Sleep_, _Low Power Mode_, _Micro Power Mode_, _Standby_, _Backup_, or _Shutdown_ mode. These modes shut down the SWD clock. + - For low-power development, it's recommended to place a 2-second blocking delay at the start of `main`. ## MAX32625PICO (PICO) A MAX32625PICO (affectionately called the "PICO") debug adapter is provided with almost all the evaluation platforms supported by the MSDK. Additionally, most small form-factor evaluation kits have a PICO _embedded_ into the PCB. -It's good practice to update the PICO's firmware to the latest version, which can be found on the [MAX32625PICO Firmware Images](https://github.com/MaximIntegrated/max32625pico-firmware-images) Github page. +It's good practice to update the PICO's firmware to the latest version, which can be found on the [MAX32625PICO Firmware Images](https://github.com/MaximIntegrated/max32625pico-firmware-images) GitHub page. ### Updating the MAX32625PICO (PICO) Debug Adapter Firmware -1. Download the correct image for your evaluation platform from the [MAX32625PICO Firmware Images](https://github.com/MaximIntegrated/max32625pico-firmware-images) Github page. +1. Download the correct image for your evaluation platform from the [MAX32625PICO Firmware Images](https://github.com/MaximIntegrated/max32625pico-firmware-images) GitHub page. 2. Connect the included micro-USB cable to the PICO _without_ connecting the other side of the cable to your host PC yet. @@ -66,7 +66,7 @@ Before following the procedure below, ensure that you have updated the PICO debu #### Unlock with VS Code -For VS Code users, the `"erase flash"` [build task](#build-tasks) can be used to attempt a mass erase. If this task fails to recover the part, attempt the procedure below. +For VS Code users, the `"erase flash"` [build task](visual-studio-code.md#build-tasks) can be used to attempt a mass erase. If this task fails to recover the part, attempt the procedure below. #### Unlock with `erase.act` @@ -114,6 +114,6 @@ For VS Code users, the `"erase flash"` [build task](#build-tasks) can be used to 9. The PICO debugger will attempt to mass erase the microcontroller's flash bank, which will completely wipe any application firmware that is programmed on the device. ???+ note "ℹ️ **Note**" - If this process fails, a `FAIL.TXT` file will be present in the DAPLINK drive with an additional error message inside of it. A failure is generally indicative of firmware that has completely shut down the debug port, or has entered low power loop immediately on power-up. In these cases, it's not possible to recover the device. + If this process fails, a `FAIL.TXT` file will be present in the DAPLINK drive with an additional error message inside of it. A failure is generally indicative of firmware that has completely shut down the debug port, or has entered low power loop immediately on power-up. In these cases, it's not possible to recover the device. -10. Power cycle the microcontroller. It step 8 succeeded, it's blank and ready to re-program. The debugger should have no issues connecting to the device in this blank state. +10. Power cycle the microcontroller. If step 8 succeeded, it's blank and ready to re-program. The debugger should have no issues connecting to the device in this blank state. diff --git a/Documentation/user-guide/developer-notes.md b/Documentation/user-guide/developer-notes.md index ba0f97508c..4665a74441 100644 --- a/Documentation/user-guide/developer-notes.md +++ b/Documentation/user-guide/developer-notes.md @@ -22,7 +22,7 @@ The SPI v2 Library is the latest version of the MSDK SPI drivers which highlight ### Porting Projects to use SPI v2 -The latest SPI examples in the MSDK defaults to build the SPI v1 libraries. Set the `MXC_SPI_VERSION` [build configuration variable](#build-configuration-variables) to `v2` (case sensitive) use the SPI v2 API. +The latest SPI examples in the MSDK defaults to build the SPI v1 libraries. Set the `MXC_SPI_VERSION` [build configuration variable](build-system.md#build-configuration-variables) to `v2` (case sensitive) use the SPI v2 API. This guide shows how to update an existing project that is using the SPI v1 API to SPI v2. The SPI v2 Library still supports the SPI v1 function prototypes for backwards-compatibility with the main difference being the SPI DMA interrupt handling (see [SPI DMA Interrupt Handling](#spi-dma-interrupt-handling) section below for more info). diff --git a/Documentation/user-guide/eclipse.md b/Documentation/user-guide/eclipse.md index e8f2c1c5f1..302c7bb86b 100644 --- a/Documentation/user-guide/eclipse.md +++ b/Documentation/user-guide/eclipse.md @@ -1,6 +1,6 @@ # Eclipse -For setup/quick-start instructions, see ["Getting Started with Eclipse"](#getting-started-with-eclipse) first. This section offers detailed usage info focusing on the typical development cycle. +For setup/quick-start instructions, see ["Getting Started with Eclipse"](getting-started.md#getting-started-with-eclipse) first. This section offers detailed usage info focusing on the typical development cycle. ## Running Eclipse @@ -29,7 +29,7 @@ When Eclipse is launched, it will prompt for a **_workspace_** location. This is 5. Follow the new project wizard. - Chip type selects the _Target Microcontroller_ - - Board type selects the [_Board Support Package (BSP)_](#board-support-packages) + - Board type selects the [_Board Support Package (BSP)_](board-support-pkgs.md) - Example type selects the example project to be copied as the template for the new project. - Adapter type selects the debug adapter to use. @@ -64,9 +64,9 @@ When Eclipse is launched, it will prompt for a **_workspace_** location. This is [Imported](#importing-examples) Eclipse projects files are configured for the **EVKIT**-type _BSP_ by default. To set the BSP: 1. Right click the project name and select _Properties_. Navigate to **C/C++ Build -> Environment**. -2. Set the **`BOARD`** _[Build Configuration Variable](#build-tables)_ to match the target evaluation platform. +2. Set the **`BOARD`** _[Build Configuration Variable](build-system.md#build-tables)_ to match the target evaluation platform. - See [Board Support Packages](#board-support-packages) for a table of possible values. + See [Board Support Packages](board-support-pkgs.md) for a table of possible values. ![Figure 26](res/Fig26.jpg) diff --git a/Documentation/user-guide/examples.md.tpl b/Documentation/user-guide/examples.md.tpl index b59ff6a860..4ab247ddc2 100644 --- a/Documentation/user-guide/examples.md.tpl +++ b/Documentation/user-guide/examples.md.tpl @@ -1,15 +1,15 @@ # Examples -The MSDK contains examples for each microcontroller that demonstrate the usage of its [Peripheral APIs](#peripheral-driver-api) and other supported libraries. They can be found in the `Examples` folder of an MSDK installation. +The MSDK contains examples for each microcontroller that demonstrate the usage of its [Peripheral APIs](libraries.md#peripheral-driver-api) and other supported libraries. They can be found in the `Examples` folder of an MSDK installation. ![Figure 40](res/Fig40.jpg) ???+ warning "**⚠️ Copying Examples**" - It's strongly recommended to copy example projects to an _outside_ folder before modifying them. This keeps the MSDK's "source" copy preserved for reference. Project folders must be copied to a location _without_ any spaces in its filepath. + It's strongly recommended to copy example projects to an _outside_ folder before modifying them. This keeps the MSDK's "source" copy preserved for reference. Project folders must be copied to a location _without_ any spaces in its filepath. Each example contains a `README.md` file describing what it does. In general, there is at least one example per peripheral block, and the example's name will indicate what it matches (i.e., `DMA`, `ADC`, `SPI`). -The tables below are offered to facilitate easier browsing through the MSDK examples. They are autogenerated from the available projects for each microcontroller. A link to the example's source code on Github is available, as well as its location inside of the MSDK. +The tables below are offered to facilitate easier browsing through the MSDK examples. They are autogenerated from the available projects for each microcontroller. A link to each example's source code on GitHub is available, as well as its location inside of the MSDK. {{EXAMPLES_LIST}} diff --git a/Documentation/user-guide/getting-started.md b/Documentation/user-guide/getting-started.md index 146498f231..efe29864a2 100644 --- a/Documentation/user-guide/getting-started.md +++ b/Documentation/user-guide/getting-started.md @@ -2,49 +2,49 @@ The MSDK is designed for both evaluation and end-application development. The typical **evaluation** cycle usually involves setting up the development environment, running demos, and exercising the peripheral driver API on an _evaluation platform_. The typical **development** cycle typically involves building a prototype application on an _evaluation platform_ first, then porting the application to a custom board. This section describes how to get started with the MSDK focusing on the _evaluation_ cycle. -**First**, review the [**Key Concepts**](#key-concepts) below. Then, proceed to the section for your preferred IDE. Each sub-section is written as a self-contained quick-start with links to additional documentation on important topics. +**First**, review the [**Key Concepts**](#key-concepts) below. Then proceed to the section for your preferred IDE. Each subsection is a self-contained quick-start that includes links to additional documentation on important topics. -- [Getting Started with Visual Studio Code](#getting-started-with-visual-studio-code) -- [Getting Started with Eclipse](#getting-started-with-eclipse) -- [Getting Started with Command-Line Development](#getting-started-with-command-line-development) +* [Getting Started with Visual Studio Code](#getting-started-with-visual-studio-code) +* [Getting Started with Eclipse](#getting-started-with-eclipse) +* [Getting Started with Command-Line Development](#getting-started-with-command-line-development) ## Key Concepts -The MSDK supports multiple development environments with different features that may tailor to the user's preferences. There are a few key concepts to remember that are universal to MSDK development. +The MSDK supports multiple development environments with different features that can be tailored to the user's preferences. A few concepts are key to remember that are universal to MSDK development. -- **Target Microcontroller**: The _target microcontroller_ refers to the base part number of the microcontroller used for development. The MSDK contains register-level support and startup files for each of its [supported parts](#supported-parts), and it's important to note that support files for a target microcontroller and its _Board Support Packages_ are distinct from each other. +* **Target Microcontroller**: The _target microcontroller_ refers to the base part number of the microcontroller used for development. The MSDK contains register-level support and startup files for each of its [supported parts](index.md#supported-parts), and it's important to note that support files for a target microcontroller and its _Board Support Packages_ are distinct from each other. For example, if the [MAX78000EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000evkit.html) _or_ [MAX78000FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000fthr.html) is being used, the _Target Microcontroller_ is the MAX78000. --- -- **Board Support Package (BSP)**: The MSDK supports evaluation platforms for target microcontrollers with _Board Support Packages_. For microcontrollers with multiple evaluation platforms, multiple BSPs are available. These can be found in the `Libraries/Boards` folder of the MSDK installation. +* **Board Support Package (BSP)**: The MSDK supports evaluation platforms for target microcontrollers with _Board Support Packages_. For microcontrollers with multiple evaluation platforms, multiple BSPs are available. These can be found in the `Libraries/Boards` folder of the MSDK installation. By default, most projects in the MSDK come pre-configured for the "EVKIT"-type BSP, which is generally the largest evaluation platform for that device with most (or all) pins broken out. It's important to note that the active BSP may need to be reconfigured for a project, which is done slightly differently for each development environment. --- -- **System Environment**: Your system's _environment_ is a broad term that encapsulates the programs and variables available to your system's shell on the command line. The user is expected to have some basic familiarity with this concept. +* **System Environment**: Your system's _environment_ is a broad term that encapsulates the programs and variables available to your system's shell on the command line. The user is expected to have some basic familiarity with this concept. --- -- **System Path**: Your system's _Path_ is a unique environment variable that tells it where to search for program binaries. The user is expected to be familiar with this concept and how to modify the system Path if necessary. +* **System Path**: Your system's _Path_ is a unique environment variable that tells it where to search for program binaries. The user is expected to be familiar with this concept and how to modify the system Path if necessary. --- -- **Integrated Development Environment (IDE)**: An IDE offers a higher-level user interface (typically with a GUI) that manages the tools for **editing** source code, **building** source code, **flashing** program binaries, and **debugging**. The abbreviation is frequently used in this document, and the MSDK supports _multiple_ IDEs that can be used depending on preference. (See ["Supported Development Environments"](#supported-development-environments)) +* **Integrated Development Environment (IDE)**: An IDE offers a higher-level user interface (typically with a GUI) that manages the tools for **editing** source code, **building** source code, **flashing** program binaries, and **debugging**. The abbreviation is frequently used in this document, and the MSDK supports _multiple_ IDEs that can be used depending on preference. (See ["Supported Development Environments"](index.md#supported-development-environments)) --- -- **Build Configuration vs. Project Configuration**: An MSDK project is comprised of two complementary systems: The _Build System_ and the _Integrated Development Environment (IDE)_. These systems each offer their own configuration interfaces, and it's important to note what each is used for. +* **Build Configuration vs. Project Configuration**: An MSDK project is comprised of two complementary systems: The _Build System_ and the _Integrated Development Environment (IDE)_. These systems each offer their own configuration interfaces, and it's important to note what each is used for. The **Build System** manages source code compilation into program binaries and offers a **Command-Line Interface (CLI)** for setting **Build Configuration Variables**. The **IDE** offers a higher-level user interface (typically with a GUI) for managing a project and sits _on top_ of the build system's _CLI_. Each IDE offers its own settings for managing fundamental aspects of the build, such as: - - Setting the _Target Microcontroller_ - - Setting the _Board Support Package_ - - Configuring the _Environment_ and _System Path_ for use with the MSDK toolchain + * Setting the _Target Microcontroller_ + * Setting the _Board Support Package_ + * Configuring the _Environment_ and _System Path_ for use with the MSDK toolchain ## Getting Started with Visual Studio Code @@ -52,11 +52,11 @@ The MSDK includes Visual Studio Code ("VS Code") support through the [VSCode-Max This section walks through setup, opening, and running an example project with VS Code. This material is also available in video form targeting the MAX78000 in ["Understanding Artificial Intelligence Episode 8.5 - Visual Studio Code"](https://www.analog.com/en/education/education-library/videos/6313212752112.html). -For complete documentation, see the [Visual Studio Code](#visual-studio-code) section of this User Guide. +For complete documentation, see the [Visual Studio Code](visual-studio-code.md) section of this User Guide. ### Setup (VS Code) -The setup below only needs to be done once per MSDK [installation](#installation). +The setup below only needs to be done once per MSDK [installation](installation.md). 1. Download and install Visual Studio Code for your OS [here](https://code.visualstudio.com/Download). @@ -88,7 +88,7 @@ The setup below only needs to be done once per MSDK [installation](#installation For example, you might set `"MAXIM_PATH":"C:/MaximSDK"` on Windows and `"MAXIM_PATH":"/home/username/MaximSDK"` on Ubuntu/MacOS. ???+ note "ℹ️ **Note: Automatic Updates**" - `"update.mode: "manual"` and `"extensions.autoUpdate": false` _disable_ automatic updates of VS Code and its extensions, respectively. This is an _optional_ (but recommended) addition left over from the early days of VS Code development when there was lots of feature churn. Things have stabilized more as of version 1.70+, but updates remain frequent. For the VSCode-Maxim project files, the exact version numbers tested with each release can be found on the [VSCode-Maxim Releases](https://github.com/analogdevicesinc/VSCode-Maxim/releases) page. + `"update.mode: "manual"` and `"extensions.autoUpdate": false` _disable_ automatic updates of VS Code and its extensions, respectively. This is an _optional_ (but recommended) addition left over from the early days of VS Code development when there was lots of feature churn. Things have stabilized more as of version 1.70+, but updates remain frequent. For the VSCode-Maxim project files, the exact version numbers tested with each release can be found on the [VSCode-Maxim Releases](https://github.com/analogdevicesinc/VSCode-Maxim/releases) page. 8. Save your changes to the file with **`CTRL + S`** and restart VS Code. @@ -118,7 +118,7 @@ The setup below only needs to be done once per MSDK [installation](#installation 6. Set the **Board Support Package** to match your evaluation platform. In VS Code, this is done by editing the `.vscode/settings.json` file and setting the `"board"` project configuration option. ???+ note "ℹ️ **Note**" - See [Board Support Packages](#board-support-packages) for more details and a table of values. + See [Board Support Packages](board-support-pkgs.md) for more details and a table of values. ![Figure 17](res/Fig17.jpg) @@ -134,13 +134,13 @@ The setup below only needs to be done once per MSDK [installation](#installation ![Build Tasks Image](https://raw.githubusercontent.com/MaximIntegratedTechSupport/VSCode-Maxim/main/img/buildtasks.JPG) -10. Run the **"build"** task to compile the project for the configured _Target Microcontroller_ and _BSP_. Notice that the `TARGET` and `BOARD` Build Configuration Variables are set on the command line. The program binary is successfully compiled into the `.elf` program binary in the **build** sub-folder of the project. +10. Run the **"build"** task to compile the project for the configured _Target Microcontroller_ and _BSP_. Notice that the `TARGET` and `BOARD` Build Configuration Variables are set on the command line. The program binary is successfully compiled into the `.elf` program binary in the **build** sub-folder of the project. ![Figure 18](res/Fig18.jpg) 11. Connect a debug adapter between the host PC and the evaluation platform. Detailed instructions on this hardware setup can be found in the evaluation platform's Datasheet and Quick-Start Guide, which are available on its [analog.com](https://analog.com) product page. -12. Run the **`flash`** build task. Running this task will automatically build the project if needed, flash the program binary, and halt the program execution to await a debugger connection. +12. Run the **`flash`** build task. Running this task will automatically build the project if needed, flash the program binary, and halt the program execution to await a debugger connection. ![Figure 19](res/Fig19.jpg) @@ -161,7 +161,7 @@ The setup below only needs to be done once per MSDK [installation](#installation 16. Exercise the debugger and press stop to disconnect when finished. ???+ note "ℹ️ **Note**" - See [Visual Studio Code](#visual-studio-code) for additional more detailed documentation. + See [Visual Studio Code](visual-studio-code.md) for additional more detailed documentation. --- @@ -169,9 +169,9 @@ The setup below only needs to be done once per MSDK [installation](#installation ### Setup (Eclipse) -The only setup required to use Eclipse is to ensure that the "Eclipse" component has been selected during the [MSDK installation](#installation). If the MSDK is already installed, Eclipse can be retrieved using the [Maintenance Tool](#maintenance). +The only setup required to use Eclipse is to ensure that the "Eclipse" component has been selected during the [MSDK installation](installation.md). If the MSDK is already installed, Eclipse can be retrieved using the [Maintenance Tool](installation.md#maintenance). -This section is an Eclipse "quick-start" that walks through creating, building, and running a project. For complete documentation, see the [Eclipse](#eclipse) section of this User Guide. +This section is an Eclipse "quick-start" that walks through creating, building, and running a project. For complete documentation, see the [Eclipse](eclipse.md) section of this User Guide. ### Building and Running a Project (Eclipse) @@ -179,7 +179,7 @@ This section is an Eclipse "quick-start" that walks through creating, building, ![Figure 22](res/Fig22.jpg) -2. Ensure Eclipse is set to the **C/C++ perspective** in the top right corner. Otherwise, the new project wizard will not show up. +2. Ensure Eclipse is set to the **C/C++ perspective** in the top right corner. Otherwise, the new project wizard will not show up. 3. Navigate to **File -> New -> Maxim Microcontrollers**. @@ -191,10 +191,10 @@ This section is an Eclipse "quick-start" that walks through creating, building, 5. Follow the new project wizard. - - Chip type selects the _Target Microcontroller_ - - Board type selects the [_Board Support Package (BSP)_](#board-support-packages) - - Example type selects the example project to be copied as the template for the new project. - - Adapter type selects the debug adapter to use. + * Chip type selects the _Target Microcontroller_ + * Board type selects the [_Board Support Package (BSP)_](board-support-pkgs.md) + * Example type selects the example project to be copied as the template for the new project. + * Adapter type selects the debug adapter to use. ![Figure 33](res/Fig33.jpg) @@ -204,7 +204,7 @@ This section is an Eclipse "quick-start" that walks through creating, building, ![Figure 27](res/Fig27.jpg) -8. Select the correct project in the **Launch Configuration** dropdown and set it to **Debug** mode. +8. Select the correct project in the **Launch Configuration** dropdown and set it to **Debug** mode. 9. Use the **Debug** button (top left) to flash the program binary and connect the debugger. @@ -221,7 +221,7 @@ This section is an Eclipse "quick-start" that walks through creating, building, 12. **Terminate** the debugger (**`CTRL+F2`**) when finished. ???+ note "ℹ️ **Note**" - See [Eclipse](#eclipse) for additional more detailed documentation. + See [Eclipse](eclipse.md) for additional more detailed documentation. --- @@ -229,7 +229,7 @@ This section is an Eclipse "quick-start" that walks through creating, building, This section demonstrates how to build MSDK example projects on the command line. It also shows how to flash and debug over the command line. The [MAX78002EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78002evkit.html) will be used as an example, but the same concepts apply to all parts. -For more detailed documentation, see the [Command-Line Development](#command-line-development) section of this User Guide. +For more detailed documentation, see the [Command-Line Development](command-line-dev.md) section of this User Guide. ### Setup (Command-Line) @@ -243,7 +243,7 @@ On Windows, use the MinGW shortcut to launch an MSYS2/MinGW terminal. This short ##### Sourcing `setenv` -A `setenv.sh` script is available in the root directory of an MSDK installation. This file can be sourced to facilitate the setup of an environment for MSDK development. +A `setenv.sh` script is available in the root directory of an MSDK installation. This file can be sourced to facilitate the setup of an environment for MSDK development. ```bash source ~/MaximSDK/setenv.sh @@ -252,7 +252,7 @@ source ~/MaximSDK/setenv.sh This command can also be added to shell startup scripts (`~/.bashrc`, `~/.zshrc`, etc.) to automate the environment setup. ???+ note "ℹ️ **Note: Automatic Updates**" - `setenv.sh` will automatically check for available updates to the MSDK. This can be permanently disabled by following its prompt on startup, or by deleting/moving the `updates.sh` script in the root directory of the MSDK installation. + `setenv.sh` will automatically check for available updates to the MSDK. This can be permanently disabled by following its prompt on startup, or by deleting/moving the `updates.sh` script in the root directory of the MSDK installation. ![Figure 51](res/Fig51.jpg) @@ -275,7 +275,7 @@ This command can also be added to shell startup scripts (`~/.bashrc`, `~/.zshrc` export OPENOCD_ROOT=$MAXIM_PATH/Tools/OpenOCD export PATH=$OPENOCD_ROOT:$PATH -2. Change `export MAXIM_PATH=#changeme!` to the installation location of the MSDK. This will make the toolchain accessible from the command line by adding it to your *system's path*. +2. Change `export MAXIM_PATH=#changeme!` to the installation location of the MSDK. This will make the toolchain accessible from the command line by adding it to your _system's path_. # Set MAXIM_PATH environment variable export MAXIM_PATH=$HOME/MaximSDK @@ -284,10 +284,10 @@ This command can also be added to shell startup scripts (`~/.bashrc`, `~/.zshrc` Run the following commands to verify that the toolchain is accessible. They should display version numbers successfully. -- `arm-none-eabi-gcc -v` -- `arm-none-eabi-gdb -v` -- `make -v` -- `openocd -v` +* `arm-none-eabi-gcc -v` +* `arm-none-eabi-gdb -v` +* `make -v` +* `openocd -v` Any "file not found" errors indicate that `MAXIM_PATH` has not been set correctly or the system's Path has not been configured correctly. @@ -312,11 +312,11 @@ Any "file not found" errors indicate that `MAXIM_PATH` has not been set correctl :::shell make -r -j --output-sync=target --no-print-directory - - `-r` is an option that ignores some of Make's implicit rules to improve build speed. - - `-j` enables parallel execution of the build in the maximum number of threads. + * `-r` is an option that ignores some of Make's implicit rules to improve build speed. + * `-j` enables parallel execution of the build in the maximum number of threads. ???+ warning "**⚠️ Parallel Builds**" - Parallel builds can mangle the console output. To deal with this, the `--output-sync=target` option can be used. However, _this is only available in Make version 4 or higher_. When this option is used, `--no-print-directory` is also used to declutter the build output. + Parallel builds can mangle the console output. To deal with this, the `--output-sync=target` option can be used. However, _this is only available in Make version 4 or higher_. When this option is used, `--no-print-directory` is also used to declutter the build output. Expected output: @@ -349,7 +349,7 @@ Any "file not found" errors indicate that `MAXIM_PATH` has not been set correctl make flash.openocd ???+ note "ℹ️ **Note: Flashing with Make**" - The command `make flash.openocd` is a build target added to the MSDK as of the [June 2023 Release](https://github.com/analogdevicesinc/msdk/releases/tag/v2023_06) to make flashing over the command-line easier. It launches and drives an OpenOCD server behind the scenes to flash the project's binary. See the `Tools/Flash/flash.mk` file for implementation details, and [Flashing on the Command-Line](#flashing-on-the-command-line) for more details on launching debug server/clients manually. + The command `make flash.openocd` is a build target added to the MSDK as of the [June 2023 Release](https://github.com/analogdevicesinc/msdk/releases/tag/v2023_06) to make flashing over the command-line easier. It launches and drives an OpenOCD server behind the scenes to flash the project's binary. See the `Tools/Flash/flash.mk` file for implementation details, and [Flashing on the Command-Line](command-line-dev.md#flashing-on-the-command-line) for more details on launching debug server/clients manually. Expected output: @@ -384,7 +384,7 @@ Any "file not found" errors indicate that `MAXIM_PATH` has not been set correctl Info : SWD DPIDR 0x2ba01477 shutdown command invoked -7. The program has been flashed and the target micro has been reset. The flashed program should now be running. For the `Hello_World` example, an LED on the board should be blinking. +7. The program has been flashed and the target micro has been reset. The flashed program should now be running. For the `Hello_World` example, an LED on the board should be blinking. ???+ note "ℹ️ **Note**" - See [Command-Line Development](#command-line-development) for additional more detailed documentation. + See [Command-Line Development](command-line-dev.md) for additional detailed documentation. diff --git a/Documentation/user-guide/index.md b/Documentation/user-guide/index.md index 6cd5423a79..ce8e3a146b 100644 --- a/Documentation/user-guide/index.md +++ b/Documentation/user-guide/index.md @@ -2,17 +2,17 @@ The MAX Microcontrollers SDK (MSDK), now a part of [Analog Devices](https://www.analog.com/en/index.html), contains the necessary software and tools to develop firmware for the [MAX32xxx and MAX78xxx Microcontrollers](https://www.analog.com/en/parametricsearch/10984). That includes register and system startup files to enable low-level development for its [supported parts](#supported-parts). It also provides higher-level peripheral driver APIs (written in C) alongside various utilities, third-party libraries, Board Support Packages (BSPs), and a set of example programs for each microcontroller. -Additionally, the MSDK includes a GCC-based toolchain, and builds are managed by a system of Makefiles (See [GNU Make](https://www.gnu.org/software/make/manual/)). A [custom fork of OpenOCD](https://github.com/analogdevicesinc/openocd) enables flashing and debugging. The MSDK's toolchain and build system offers a Command Line Interface (CLI), and project files for [supported development environments](#supported-development-environments) are maintained that build on top of that CLI. +Additionally, the MSDK includes a GCC-based toolchain, and builds are managed by a system of Makefiles (see [GNU Make](https://www.gnu.org/software/make/manual/)). A [custom fork of OpenOCD](https://github.com/analogdevicesinc/openocd) enables flashing and debugging. The MSDK's toolchain and build system offers a Command Line Interface (CLI), and project files for [supported development environments](#supported-development-environments) are maintained that build on top of that CLI. This document describes the MSDK's installation, setup, and usage. ## Supported Operating Systems -- Windows (Windows 10 only) +* Windows (Windows 10 only) -- Linux (Ubuntu only) +* Linux (Ubuntu only) -- MacOS +* MacOS ## Supported Parts @@ -20,139 +20,138 @@ The MSDK officially supports the following microcontrollers and evaluation platf * [**MAX32520**](https://www.analog.com/en/products/max32520.html): ChipDNA Secure Microcontroller with Secure Boot for IoT Applications - - [MAX32520-KIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32520-kit.html) - - - [MAX32520FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32520fthr.html) + * [MAX32520-KIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32520-kit.html) + * [MAX32520FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32520fthr.html) --- * [**MAX32570**](https://www.analog.com/en/products/max32570.html): Low-Power Arm Cortex-M4 Microcontroller with Contactless Radio for Secure Applications **(Available by NDA only**) - - [MAX32570-QNKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32570-qnkit.html) + * [MAX32570-QNKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32570-qnkit.html) - - [MAX32570-MNKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32570-mnkit.html) + * [MAX32570-MNKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32570-mnkit.html) --- * **MAX32572** **(Not Yet Publicly Available)** - - MAX32572EVKIT **(Not Yet Publicly Available)** + * MAX32572EVKIT **(Not Yet Publicly Available)** --- * [**MAX32650**](https://www.analog.com/en/products/max32650.html): Ultra-Low-Power Arm Cortex-M4 with FPU-Based Microcontroller (MCU) with 3MB Flash and 1MB SRAM - - [MAX32650-EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32650-evkit.html) + * [MAX32650-EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32650-evkit.html) - - [MAX32650FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32650fthr.html) + * [MAX32650FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32650fthr.html) --- * [**MAX32651**](https://www.analog.com/en/products/max32651.html): Ultra-Low-Power Arm Cortex-M4 with FPU-Based Microcontroller (MCU) with 3MB Flash and 1MB SRAM - - [MAX32651-EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32651-evkit.html) + * [MAX32651-EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32651-evkit.html) --- * [**MAX32655**](https://www.analog.com/en/products/max32655.html): Low-Power, Arm Cortex-M4 Processor with FPU-Based Microcontroller and Bluetooth 5.2 - - [MAX32655EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32655evkit.html) + * [MAX32655EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32655evkit.html) - - [MAX32655FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32655fthr.html) + * [MAX32655FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32655fthr.html) --- * [**MAX32660**](https://www.analog.com/en/products/max32660.html): Tiny, Ultra-Low-Power Arm Cortex-M4 Processor with FPU-Based Microcontroller (MCU) with 256KB Flash and 96KB SRAM - - [MAX32660-EVSYS](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32660-evsys.html) + * [MAX32660-EVSYS](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32660-evsys.html) --- * [**MAX32662**](https://www.analog.com/en/products/max32662.html): Arm Cortex-M4 Processor with FPU-Based Microcontroller (MCU) with 256KB Flash and 80KB SRAM - - [MAX32662EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/MAX32662EVKIT.html) + * [MAX32662EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/MAX32662EVKIT.html) --- * [**MAX32665-MAX32666 Family**](https://www.analog.com/en/products/max32665.html): Low-Power Arm Cortex-M4 with FPU-Based Microcontroller with Bluetooth 5 for Wearables - - [MAX32666EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32666evkit.html) + * [MAX32666EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32666evkit.html) - - [MAX32666FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32666fthr.html) + * [MAX32666FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32666fthr.html) - - MAX32666FTHR2 (Product Page Not Yet Available) + * MAX32666FTHR2 (Product Page Not Yet Available) --- * [**MAX32670**](https://www.analog.com/en/products/max32670.html): High-Reliability, Ultra-Low-Power Microcontroller Powered by Arm Cortex-M4 Processor with FPU for Industrial and IoT - - [MAX32670EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32670evkit.html) + * [MAX32670EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32670evkit.html) --- * [**MAX32672**](https://www.analog.com/en/products/max32672.html): High-Reliability, Tiny, Ultra-Low-Power Arm Cortex-M4F Microcontroller with 12-Bit 1MSPS ADC - - [MAX32672EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32672evkit.html) + * [MAX32672EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32672evkit.html) --- * [**MAX32675**](https://www.analog.com/en/products/max32675.html): Ultra-Low-Power Arm Cortex-M4F with Precision Analog Front-End for Industrial and Medical Sensors - - [MAX32675EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32675evkit.html) + * [MAX32675EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32675evkit.html) - - MAX32675FTHR (Product Page Not Yet Available) + * MAX32675FTHR (Product Page Not Yet Available) --- * [**MAX32680**](https://www.analog.com/en/products/max32680.html): Ultra-Low-Power Arm Cortex-M4F with Precision Analog Front-End and Bluetooth LE 5.2 - - [MAX32680EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32680evkit.html) + * [MAX32680EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max32680evkit.html) --- * [**MAX32690**](https://www.analog.com/en/products/max32690.html): Arm Cortex-M4 with FPU Microcontroller and Bluetooth LE 5 for Industrial and Wearables - - [MAX32690EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/MAX32690EVKIT.html) - - [AD-APARD32690-SL](https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/ad-apard32690-sl.html) + * [MAX32690EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/MAX32690EVKIT.html) + * [AD-APARD32690-SL](https://www.analog.com/en/resources/evaluation-hardware-and-software/evaluation-boards-kits/ad-apard32690-sl.html) --- * [**MAX78000**](https://www.analog.com/en/products/max78000.html): Artificial Intelligence Microcontroller with Ultra-Low-Power Convolutional Neural Network Accelerator - - [MAX78000EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000evkit.html) + * [MAX78000EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000evkit.html) - - [MAX78000FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000fthr.html) + * [MAX78000FTHR](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78000fthr.html) - - [MAXREFDES178](https://www.analog.com/en/design-center/reference-designs/maxrefdes178.html) + * [MAXREFDES178](https://www.analog.com/en/design-center/reference-designs/maxrefdes178.html) --- * [**MAX78002**](https://www.analog.com/en/products/max78002.html): Artificial Intelligence Microcontroller with Low-Power Convolutional Neural Network Accelerator - - [MAX78002EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78002evkit.html) + * [MAX78002EVKIT](https://www.analog.com/en/design-center/evaluation-hardware-and-software/evaluation-boards-kits/max78002evkit.html) --- ## Supported Development Environments -- [Visual Studio Code](https://code.visualstudio.com/) -- [Eclipse IDE](https://www.eclipseide.org/) -- [IAR Embedded Workbench](https://www.iar.com/ewarm) -- [Keil MDK](https://www2.keil.com/mdk5/) -- Command-line Development +* [Visual Studio Code](https://code.visualstudio.com/) +* [Eclipse IDE](https://www.eclipseide.org/) +* [IAR Embedded Workbench](https://www.iar.com/ewarm) +* [Keil MDK](https://www2.keil.com/mdk5/) +* Command-line Development - - Supported shells (Windows) - - [MSYS2](https://www.msys2.org/) + * Supported shells (Windows) + * [MSYS2](https://www.msys2.org/) - - Supported shells (Ubuntu) - - [Bash](https://tiswww.case.edu/php/chet/bash/bashtop.html) - - [Zsh](https://www.zsh.org/) + * Supported shells (Ubuntu) + * [Bash](https://tiswww.case.edu/php/chet/bash/bashtop.html) + * [Zsh](https://www.zsh.org/) - - Supported shells (MacOS) - - [Zsh](https://www.zsh.org/) + * Supported shells (MacOS) + * [Zsh](https://www.zsh.org/) ## Supported Languages -- C -- C++ -- Assembly (Arm and/or RISC-V instruction set depending on the microcontroller) +* C +* C++ +* Assembly (Arm and/or RISC-V instruction set depending on the microcontroller) diff --git a/Documentation/user-guide/installation.md b/Documentation/user-guide/installation.md index c433e03eb7..44e5c4ac9d 100644 --- a/Documentation/user-guide/installation.md +++ b/Documentation/user-guide/installation.md @@ -65,7 +65,6 @@ The MSDK installer can be run through a [**GUI Installation**](#gui-installation ???+ warning "⚠️ **Warning**" On MacOS, some [_additional steps_](#completing-the-installation-on-macos) are required. - ### Command-Line Installation The MSDK installer features a command-line interface that can be used as an alternative to its GUI. This is useful for installations on "headless" systems and scripting. @@ -215,4 +214,4 @@ Older versions of the MSDK are available as an **_offline installer_** for each ### Development Resources -Users can obtain development copies of the MSDK resources from [Github](https://github.com/analogdevicesinc/msdk). Setup instructions can be found in the repository's [README](https://github.com/analogdevicesinc/msdk/blob/main/README.md). +Users can obtain development copies of the MSDK resources from [GitHub](https://github.com/analogdevicesinc/msdk). Setup instructions can be found in the repository's [README](https://github.com/analogdevicesinc/msdk/blob/main/README.md). diff --git a/Documentation/user-guide/libraries.md b/Documentation/user-guide/libraries.md index cea2a58abf..4691ef18f7 100644 --- a/Documentation/user-guide/libraries.md +++ b/Documentation/user-guide/libraries.md @@ -3,7 +3,7 @@ The MSDK contains a large number of libraries, both third-party and in-house. The main library is the [Peripheral Driver API](#peripheral-driver-api), but the MSDK also contains drivers for various _external_ components such as TFT displays, cameras, accelerometers, audio codecs, and other devices. Additionally, dedicated libraries for more complex _internal_ hardware peripherals such as USB, the SDHC interface, and the Cordio BLE stack are also available. These usually build on _top_ of the Peripheral Driver API. ???+ note "ℹ️ **Note: Enabling Libraries**" - Libraries can be enabled for a project with a convenient _toggle switch_ provided by the build system (See [Build Variables for Toggling Libraries](#build-variables-for-toggling-libraries)). + Libraries can be enabled for a project with a convenient _toggle switch_ provided by the build system (See [Build Variables for Toggling Libraries](build-system.md#build-variables-for-toggling-libraries)). ## Peripheral Driver API @@ -15,29 +15,29 @@ A microcontroller is made up of a Central Processing Unit (CPU) that is surround The links below will open detailed API references for each microcontroller. Offline copies of these API references can also be found in the `Documentation` folder of the MSDK installation. -- [MAX32520 API](Libraries/PeriphDrivers/Documentation/MAX32520/index.html) +- [MAX32520 API](../Libraries/PeriphDrivers/Documentation/MAX32520/index.html) -- [MAX32650 API](Libraries/PeriphDrivers/Documentation/MAX32650/index.html) +- [MAX32650 API](../Libraries/PeriphDrivers/Documentation/MAX32650/index.html) -- [MAX32655 API](Libraries/PeriphDrivers/Documentation/MAX32655/index.html) +- [MAX32655 API](../Libraries/PeriphDrivers/Documentation/MAX32655/index.html) -- [MAX32660 API](Libraries/PeriphDrivers/Documentation/MAX32660/index.html) +- [MAX32660 API](../Libraries/PeriphDrivers/Documentation/MAX32660/index.html) -- [MAX32665-MAX32666 API](Libraries/PeriphDrivers/Documentation/MAX32665/index.html) +- [MAX32665-MAX32666 API](../Libraries/PeriphDrivers/Documentation/MAX32665/index.html) -- [MAX32670 API](Libraries/PeriphDrivers/Documentation/MAX32670/index.html) +- [MAX32670 API](../Libraries/PeriphDrivers/Documentation/MAX32670/index.html) -- [MAX32672 API](Libraries/PeriphDrivers/Documentation/MAX32672/index.html) +- [MAX32672 API](../Libraries/PeriphDrivers/Documentation/MAX32672/index.html) -- [MAX32675 API](Libraries/PeriphDrivers/Documentation/MAX32675/index.html) +- [MAX32675 API](../Libraries/PeriphDrivers/Documentation/MAX32675/index.html) -- [MAX32680 API](Libraries/PeriphDrivers/Documentation/MAX32680/index.html) +- [MAX32680 API](../Libraries/PeriphDrivers/Documentation/MAX32680/index.html) -- [MAX32690 API](Libraries/PeriphDrivers/Documentation/MAX32690/index.html) +- [MAX32690 API](../Libraries/PeriphDrivers/Documentation/MAX32690/index.html) -- [MAX78000 API](Libraries/PeriphDrivers/Documentation/MAX78000/index.html) +- [MAX78000 API](../Libraries/PeriphDrivers/Documentation/MAX78000/index.html) -- [MAX78002 API](Libraries/PeriphDrivers/Documentation/MAX78002/index.html) +- [MAX78002 API](../Libraries/PeriphDrivers/Documentation/MAX78002/index.html) ### PeriphDrivers Organization @@ -62,7 +62,7 @@ The following table matches external part numbers to internal die types. This i - ???+ note "ℹ️ **Note: Die Types Table**" - | Part Number | Die Type + | Part Number | Die Type | | -------- | ----------- | | MAX32520 | ES17 | | MAX32570 | ME13 | @@ -83,7 +83,7 @@ The following table matches external part numbers to internal die types. This i Most Peripheral Driver initialization routines involve enabling system clocks, setting clock dividers, and configuring GPIO pins. In some cases (such as for Zephyr), frameworks or tools offer their own mechanisms for handling this, or it's desirable to manually handle it in custom application code. -The MSDK offers a mechanism for disabling the automatic initialization of clocks and GPIO pins via the `MSDK_NO_GPIO_CLK_INIT` compiler definition. To enable this for a project, add it via the `PROJ_CFLAGS` [build configuration variable](#build-variables-for-the-compiler) using the following syntax: +The MSDK offers a mechanism for disabling the automatic initialization of clocks and GPIO pins via the `MSDK_NO_GPIO_CLK_INIT` compiler definition. To enable this for a project, add it via the `PROJ_CFLAGS` [build configuration variable](build-system.md#build-variables-for-the-compiler) using the following syntax: ```Makefile #project.mk @@ -126,7 +126,7 @@ Please refer to the [CMSIS-DSP official documentation](https://arm-software.gith The Cordio Bluetooth Low Energy (BLE) library provides a full BLE stack for microcontrollers with an integrated BLE controller. -The Cordio library warrants its own separate documentation. See the **[Cordio BLE User Guide](Libraries/Cordio/docs/CORDIO_USERGUIDE.md)**. +The Cordio library warrants its own separate documentation. See the **[Cordio BLE User Guide](../Libraries/Cordio/docs/CORDIO_USERGUIDE.md)**. ### Cordio Supported Parts @@ -139,7 +139,7 @@ The Cordio library warrants its own separate documentation. See the **[Cordio BL ## MAXUSB -The MAXUSB library provides a higher-level interface for utilizing the built-in USB controller hardware available on some microcontrollers. This allows the microcontroller to enumerate as a USB device without the need for an external USB controller IC. MAXUSB provides a finer level of control of USB events and classes than TinyUSB. +The MAXUSB library provides a higher-level interface for utilizing the built-in USB controller hardware available on some microcontrollers. This allows the microcontroller to enumerate as a USB device without the need for an external USB controller IC. MAXUSB provides a finer level of control of USB events and classes than TinyUSB. ### MAXUSB Supported Parts @@ -168,14 +168,14 @@ supporting most standard USB device classes. ## Miscellaneous Drivers -The `Libraries/MiscDrivers` folder of the MSDK contains drivers for miscellaneous external components such as TFT displays, cameras, audio codecs, PMICs, pushbuttons, etc. These resources are usually closely tied with the [Board Support Packages](#board-support-packages). +The `Libraries/MiscDrivers` folder of the MSDK contains drivers for miscellaneous external components such as TFT displays, cameras, audio codecs, PMICs, pushbuttons, etc. These resources are usually closely tied with the [Board Support Packages](board-support-pkgs.md). ### Miscellaneous Build Variables | 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`](../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. | --- @@ -183,7 +183,7 @@ The `Libraries/MiscDrivers` folder of the MSDK contains drivers for miscellaneou The **Secure Digital High Capacity _(SDHC)_** library offers a higher-level interface built on top of the SDHC [Peripheral Driver API](#peripheral-driver-api) that includes a [FatFS File System](http://elm-chan.org/fsw/ff/00index_e.html) implementation for managing files on SD cards. -See [Build Variables for Toggling Libraries](#build-variables-for-toggling-libraries) for instructions on enabling the SDHC library. +See [Build Variables for Toggling Libraries](build-system.md#build-variables-for-toggling-libraries) for instructions on enabling the SDHC library. ### SDHC Supported Parts @@ -195,7 +195,7 @@ See [Build Variables for Toggling Libraries](#build-variables-for-toggling-libra ### SDHC Build Variables -Once enabled, the following [build configuration variables](#build-configuration-variables) become available. +Once enabled, the following [build configuration variables](build-system.md#build-configuration-variables) become available. | Configuration Variable | Description | Details | | ---------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | @@ -228,13 +228,13 @@ FreeRTOS is supported by all parts in the MSDK. See the `FreeRTOSDemo` example ## CLI -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. +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 -[EEMBC’s CoreMark®](https://www.eembc.org/coremark/) is a benchmark that measures the performance of microcontrollers (MCUs) and central processing units (CPUs) used in embedded systems. CoreMark is a simple, yet sophisticated benchmark that is designed specifically to test the functionality of a processor core. Running CoreMark produces a single-number score allowing users to make quick comparisons between processors. +[EEMBC’s CoreMark®](https://www.eembc.org/coremark/) is a benchmark that measures the performance of microcontrollers (MCUs) and central processing units (CPUs) used in embedded systems. CoreMark is a simple, yet sophisticated benchmark that is designed specifically to test the functionality of a processor core. Running CoreMark produces a single-number score allowing users to make quick comparisons between processors. ### CoreMark Supported Parts diff --git a/Documentation/user-guide/visual-studio-code.md b/Documentation/user-guide/visual-studio-code.md index 26e8fab4cc..d437e2156d 100644 --- a/Documentation/user-guide/visual-studio-code.md +++ b/Documentation/user-guide/visual-studio-code.md @@ -2,7 +2,7 @@ Support for [Visual Studio Code](https://code.visualstudio.com/) is maintained for the MSDK and developed on the [VSCode-Maxim](https://github.com/analogdevicesinc/VSCode-Maxim) GitHub repository. -For setup/quick-start instructions, see ["Getting Started with Visual Studio Code"](#getting-started-with-visual-studio-code) first. This section offers detailed usage info focusing on the typical development cycle. +For setup/quick-start instructions, see ["Getting Started with Visual Studio Code"](getting-started.md#getting-started-with-visual-studio-code) first. This section offers detailed usage info focusing on the typical development cycle. ## Opening Example Projects @@ -45,9 +45,9 @@ To open a project: To set the BSP for an open project: -1. Set the `"board"` [project configuration](https://github.com/analogdevicesinc/VSCode-Maxim/tree/main#project-configuration) option in `.vscode/settings.json`, which maps to the `BOARD` _[Build Configuration Variable](#build-tables)_. +1. Set the `"board"` [project configuration](https://github.com/analogdevicesinc/VSCode-Maxim/tree/main#project-configuration) option in `.vscode/settings.json`, which maps to the `BOARD` _[Build Configuration Variable](build-system.md#build-tables)_. - See [Board Support Packages](#board-support-packages) for a table of possible values. + See [Board Support Packages](board-support-pkgs.md) for a table of possible values. ![Figure 17](res/Fig17.jpg) @@ -148,16 +148,16 @@ As of the [v1.6.0](https://github.com/analogdevicesinc/VSCode-Maxim/releases/tag ![Figure 47](res/Fig47.jpg) -Alternatively, *watch expressions* can be used. These can be set for registers and variables. (For example, the `sysctrl` register below). +Alternatively, _watch expressions_ can be used. These can be set for registers and variables. (For example, the `sysctrl` register below). ![image](https://user-images.githubusercontent.com/38844790/177819247-ccf90782-e1e6-44f2-8605-c39fc15c09a6.png) -- Adding **`,b`** lets you print out the value in **binary** -- Adding **`,x`** prints the value in **hex**. -- Standard **logical** and **bitwise** operations are supported inside the watch expression. -- **Register** and **variable** values can be **modified** through these same watch-points. _(Right click -> Set Value)_ +* Adding **`,b`** lets you print out the value in **binary** +* Adding **`,x`** prints the value in **hex**. +* Standard **logical** and **bitwise** operations are supported inside the watch expression. +* **Register** and **variable** values can be **modified** through these same watch-points. _(Right click -> Set Value)_ -It should be noted that the debugger's watch points are *contextual*, meaning that its symbol look-ups will depend on the active point in your program. +It should be noted that the debugger's watch points are _contextual, meaning that its symbol look-ups will depend on the active point in your program. ### Disassembly View @@ -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](/Examples/MAX78000/CNN/mnist-riscv) project for the MAX78000 as an example. 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: @@ -247,12 +247,12 @@ The following configuration options are available: ### `"MAXIM_PATH"` * This option must point to the root installation directory of the MSDK. -* It should be placed in the _global_ user settings.json file during first-time VSCode-Maxim setup. See [Getting Started with Visual Studio Code](#getting-started-with-visual-studio-code). +* It should be placed in the _global_ user settings.json file during first-time VSCode-Maxim setup. See [Getting Started with Visual Studio Code](getting-started.md#getting-started-with-visual-studio-code). ### `"target"` * This sets the target microcontroller for the project. -* It sets the `TARGET` [Build Configuration](#build-configuration-variables) variable. +* It sets the `TARGET` [Build Configuration](build-system.md#build-configuration-variables) variable. ### `"board"` @@ -411,6 +411,6 @@ VSCode-Maxim releases provide the `Inject` folder for "injecting" into an existi 5. `CTRL+SHIFT+P -> Reload Window` to re-parse the project settings. -6. Configure the [build system](#build-system) for use with any pre-existing source code. +6. Configure the [build system](build-system.md) for use with any pre-existing source code. 7. That's it! Your new project can now be opened with `File > Open Folder` from within VS Code. From e03ae92c7b6c5af6624696fcbead654afc1bcfbb Mon Sep 17 00:00:00 2001 From: "Kernion, Juliette" Date: Wed, 9 Oct 2024 12:04:56 -0700 Subject: [PATCH 11/18] Minor edits to pass linter --- Documentation/user-guide/installation.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Documentation/user-guide/installation.md b/Documentation/user-guide/installation.md index 44e5c4ac9d..a7e1bac3c8 100644 --- a/Documentation/user-guide/installation.md +++ b/Documentation/user-guide/installation.md @@ -5,10 +5,10 @@ - **Elevated/Administrator rights** - ???+ warning "**⚠️ MacOS**" - On MacOS, please also download and install [Homebrew](https://brew.sh/). It will be used in [Completing the Installation on MacOS](#completing-the-installation-on-macos) later on. + On MacOS, please also download and install [Homebrew](https://brew.sh/). It will be used in [Completing the Installation on MacOS](#completing-the-installation-on-macos) later on. - ???+ warning "**⚠️ Ubuntu**" - Several GUI packages are required by the QT installer framework _even on headless systems_. Run the following command _before_ running the installer to retrieve them. + Several GUI packages are required by the QT installer framework _even on headless systems_. Run the following command _before_ running the installer to retrieve them. :::shell sudo apt update && sudo apt install libxcb-glx0 libxcb-icccm4 libxcb-image0 libxcb-shm0 libxcb-util1 libxcb-keysyms1 libxcb-randr0 libxcb-render-util0 libxcb-render0 libxcb-shape0 libxcb-sync1 libxcb-xfixes0 libxcb-xinerama0 libxcb-xkb1 libxcb1 libxkbcommon-x11-0 libxkbcommon0 libgl1 libusb-0.1-4 libhidapi-libusb0 libhidapi-hidraw0 @@ -63,14 +63,14 @@ The MSDK installer can be run through a [**GUI Installation**](#gui-installation ![Figure 10](res/Fig10.jpg) ???+ warning "⚠️ **Warning**" - On MacOS, some [_additional steps_](#completing-the-installation-on-macos) are required. + On MacOS, [_additional steps_](#completing-the-installation-on-macos) are required. ### Command-Line Installation -The MSDK installer features a command-line interface that can be used as an alternative to its GUI. This is useful for installations on "headless" systems and scripting. +The MSDK installer features a command-line interface that can be used as an alternative to its GUI. This is useful for installations on "headless" systems and scripting. ??? note "ℹ️ **Note:**" The `--help` Command" - The available commands can be retrieved by running the MSDK installer executable with the `--help` option on the command line. For example: + The available commands can be retrieved by running the MSDK installer executable with the `--help` option on the command line. For example: :::shell $ ./MaximMicrosSDK_linux.run --help @@ -189,7 +189,7 @@ To run a _headless_ installation: ### Completing the Installation on MacOS ???+ warning "⚠️ **Warning**" - On MacOS, some additional missing packages must be manually installed with [Homebrew](https://brew.sh/). There are also some manual setup steps required to retrieve `make` version 4. The instructions in this section are critical. + On MacOS, some additional missing packages must be manually installed with [Homebrew](https://brew.sh/). There are also some manual setup steps required to retrieve `make` version 4. The instructions in this section are critical. 1. Install [Homebrew](https://brew.sh/). @@ -214,4 +214,4 @@ Older versions of the MSDK are available as an **_offline installer_** for each ### Development Resources -Users can obtain development copies of the MSDK resources from [GitHub](https://github.com/analogdevicesinc/msdk). Setup instructions can be found in the repository's [README](https://github.com/analogdevicesinc/msdk/blob/main/README.md). +Users can obtain development copies of the MSDK resources from [GitHub](https://github.com/analogdevicesinc/msdk). Setup instructions can be found in the repository's [README](https://github.com/analogdevicesinc/msdk/blob/main/README.md). From a0f48e9407d950359b6557c98db57b5d0fdceacd Mon Sep 17 00:00:00 2001 From: "Anderson, Glen" Date: Mon, 7 Oct 2024 14:36:22 -0400 Subject: [PATCH 12/18] Refactored Documentation/build.py for new directory layout --- Documentation/build.py | 116 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 113 insertions(+), 3 deletions(-) diff --git a/Documentation/build.py b/Documentation/build.py index 232cbf55f0..60763c29e4 100644 --- a/Documentation/build.py +++ b/Documentation/build.py @@ -4,7 +4,6 @@ import re import shutil import textwrap -from dataclasses import dataclass from operator import attrgetter from pathlib import Path from subprocess import run @@ -57,9 +56,8 @@ def generate_examples_md(): print("Searching for shared examples...") for directory in examples_dir.glob("*"): if directory.name in target_excludelist: - print(f"Skipping {directory.name}... (in exclude-list)") + print(f"Skipping {directory.name}... (in exclude-list)") continue - print(f"-> {directory.name}") target_micro = directory.name all_target_micros.add(target_micro) for main_file in directory.rglob("**/main.c"): @@ -88,6 +86,7 @@ def generate_examples_md(): if len(e.supported_parts) > 1: common_entries += f"| **{e.name}** | {e.description} | {'
'.join(e.supported_parts)} |\n" +<<<<<<< HEAD markdown_content = textwrap.dedent( """ ### Common Examples @@ -192,6 +191,117 @@ def build_mkdocs(): run("mkdocs build", cwd=repo, shell=True, check=False) # Build with CLI +======= + markdown_content = f""" + ### Common Examples + + The following common examples are supported across multiple microcontrollers. + + | Example | Description | Supported Parts | + | ------- | ----------- | --------------- | + {common_entries} + + """ + + # Generate markdown content for part-specific examples + all_target_micros = sorted(all_target_micros) + specific_examples = {} + for micro in all_target_micros: + specific_examples[micro] = [ + e + for e in all_examples + if micro in e.supported_parts and len(e.supported_parts) == 1 + ] + + for target, examples in specific_examples.items(): + markdown_content += f""" + ### {target.upper()} Examples + + In addition to the [Common Examples](#common-examples), the following examples + are available specifically for the {target.upper()}. + + | Example | Description | MSDK Location | + | ------- | ----------- | ------------- | + """ + for e in examples: + relative_path = e.folder.relative_to(repo).as_posix() + github = ( + f"https://github.com/analogdevicesinc/msdk/tree/release/{relative_path}" + ) + markdown_content += f"| **{e.name}** | {e.description} | _Local:_`{relative_path}`
_Github:_ [link]({github})\n" + + # generate examples.md from the template + src_path = repo / "Documentation/user-guide/examples.md.tpl" + dst_path = repo / "Documentation/user-guide/examples.md" + dst_path.write_text( + src_path.read_text(encoding="utf-8").replace( + "{{EXAMPLES_LIST}}", markdown_content + ), + encoding="utf-8", + ) + + +def copy_sources(): + print("Copying root markdown files") + for f in repo.glob("*.md"): + print(f"-> {f.name}") + if f.name != "README.md": + shutil.copy( + f, here + ) # Workaround for https://github.com/mkdocs/mkdocs/issues/3313 + + print("Copying CLI markdown files") + cli_path = repo / "Libraries/CLI" + cli_path.mkdir(exist_ok=True, parents=True) + shutil.copy( + cli_path / "README.md", + here / "Libraries/CLI/README.md", + ) + + print("Copying bluetooth markdown files") + src = repo / "Tools/Bluetooth" + dst = here / "Tools/Bluetooth" + for f in src.glob("*.md"): + print(f"-> {f.name}") + if not dst.exists(): + dst.mkdir(parents=True, exist_ok=True) + shutil.copy(f, dst) + + cordio_docs_dir = repo / "Libraries/Cordio/docs" + platform_docs_dir = repo / "Libraries/Cordio/platform/Documentation" + + print("Copying Cordio markdown files") + shutil.copytree(cordio_docs_dir, here / "Libraries/Cordio/docs", dirs_exist_ok=True) + + print("Copying platform markdown files") + shutil.copytree( + platform_docs_dir, + here / "Libraries/Cordio/platform/Documentation", + dirs_exist_ok=True, + ) + + +def build_doxygen_docs(): + # Run Doxygen builds + periph_docs_dir = repo / "Libraries/PeriphDrivers/Documentation" + for f in periph_docs_dir.glob("*_Doxyfile"): + micro = f.name.split("_")[0].upper() # max32xxx_Doxyfile -> MAX32XXX + if not (periph_docs_dir / micro).exists(): + run(f"doxygen {f.name}", cwd=f.parent, shell=True, check=False) + else: + print(f"{micro} Doxygen exists, skipping") + dest = here / "Libraries/PeriphDrivers/Documentation" / micro + # ^ Recreate directory structure so built links work + shutil.copytree(periph_docs_dir / micro, dest, dirs_exist_ok=True) + + +def build_mkdocs(): + # Run mkdocs build + # A subprocess is used because the Mkdocs Python API does not print any logging info + print("Building docs (this could take a few minutes)...") + run("mkdocs build", cwd=repo, shell=True, check=False) # Build with CLI + + if __name__ == "__main__": generate_examples_md() copy_sources() From f0ff6791bc07d26645c3d3ec5842760ec8d4c604 Mon Sep 17 00:00:00 2001 From: "Anderson, Glen" Date: Fri, 11 Oct 2024 10:26:50 -0400 Subject: [PATCH 13/18] Fixed merge issue in build.py --- Documentation/build.py | 116 ++--------------------------------------- 1 file changed, 3 insertions(+), 113 deletions(-) diff --git a/Documentation/build.py b/Documentation/build.py index 60763c29e4..232cbf55f0 100644 --- a/Documentation/build.py +++ b/Documentation/build.py @@ -4,6 +4,7 @@ import re import shutil import textwrap +from dataclasses import dataclass from operator import attrgetter from pathlib import Path from subprocess import run @@ -56,8 +57,9 @@ def generate_examples_md(): print("Searching for shared examples...") for directory in examples_dir.glob("*"): if directory.name in target_excludelist: - print(f"Skipping {directory.name}... (in exclude-list)") + print(f"Skipping {directory.name}... (in exclude-list)") continue + print(f"-> {directory.name}") target_micro = directory.name all_target_micros.add(target_micro) for main_file in directory.rglob("**/main.c"): @@ -86,7 +88,6 @@ def generate_examples_md(): if len(e.supported_parts) > 1: common_entries += f"| **{e.name}** | {e.description} | {'
'.join(e.supported_parts)} |\n" -<<<<<<< HEAD markdown_content = textwrap.dedent( """ ### Common Examples @@ -191,117 +192,6 @@ def build_mkdocs(): run("mkdocs build", cwd=repo, shell=True, check=False) # Build with CLI -======= - markdown_content = f""" - ### Common Examples - - The following common examples are supported across multiple microcontrollers. - - | Example | Description | Supported Parts | - | ------- | ----------- | --------------- | - {common_entries} - - """ - - # Generate markdown content for part-specific examples - all_target_micros = sorted(all_target_micros) - specific_examples = {} - for micro in all_target_micros: - specific_examples[micro] = [ - e - for e in all_examples - if micro in e.supported_parts and len(e.supported_parts) == 1 - ] - - for target, examples in specific_examples.items(): - markdown_content += f""" - ### {target.upper()} Examples - - In addition to the [Common Examples](#common-examples), the following examples - are available specifically for the {target.upper()}. - - | Example | Description | MSDK Location | - | ------- | ----------- | ------------- | - """ - for e in examples: - relative_path = e.folder.relative_to(repo).as_posix() - github = ( - f"https://github.com/analogdevicesinc/msdk/tree/release/{relative_path}" - ) - markdown_content += f"| **{e.name}** | {e.description} | _Local:_`{relative_path}`
_Github:_ [link]({github})\n" - - # generate examples.md from the template - src_path = repo / "Documentation/user-guide/examples.md.tpl" - dst_path = repo / "Documentation/user-guide/examples.md" - dst_path.write_text( - src_path.read_text(encoding="utf-8").replace( - "{{EXAMPLES_LIST}}", markdown_content - ), - encoding="utf-8", - ) - - -def copy_sources(): - print("Copying root markdown files") - for f in repo.glob("*.md"): - print(f"-> {f.name}") - if f.name != "README.md": - shutil.copy( - f, here - ) # Workaround for https://github.com/mkdocs/mkdocs/issues/3313 - - print("Copying CLI markdown files") - cli_path = repo / "Libraries/CLI" - cli_path.mkdir(exist_ok=True, parents=True) - shutil.copy( - cli_path / "README.md", - here / "Libraries/CLI/README.md", - ) - - print("Copying bluetooth markdown files") - src = repo / "Tools/Bluetooth" - dst = here / "Tools/Bluetooth" - for f in src.glob("*.md"): - print(f"-> {f.name}") - if not dst.exists(): - dst.mkdir(parents=True, exist_ok=True) - shutil.copy(f, dst) - - cordio_docs_dir = repo / "Libraries/Cordio/docs" - platform_docs_dir = repo / "Libraries/Cordio/platform/Documentation" - - print("Copying Cordio markdown files") - shutil.copytree(cordio_docs_dir, here / "Libraries/Cordio/docs", dirs_exist_ok=True) - - print("Copying platform markdown files") - shutil.copytree( - platform_docs_dir, - here / "Libraries/Cordio/platform/Documentation", - dirs_exist_ok=True, - ) - - -def build_doxygen_docs(): - # Run Doxygen builds - periph_docs_dir = repo / "Libraries/PeriphDrivers/Documentation" - for f in periph_docs_dir.glob("*_Doxyfile"): - micro = f.name.split("_")[0].upper() # max32xxx_Doxyfile -> MAX32XXX - if not (periph_docs_dir / micro).exists(): - run(f"doxygen {f.name}", cwd=f.parent, shell=True, check=False) - else: - print(f"{micro} Doxygen exists, skipping") - dest = here / "Libraries/PeriphDrivers/Documentation" / micro - # ^ Recreate directory structure so built links work - shutil.copytree(periph_docs_dir / micro, dest, dirs_exist_ok=True) - - -def build_mkdocs(): - # Run mkdocs build - # A subprocess is used because the Mkdocs Python API does not print any logging info - print("Building docs (this could take a few minutes)...") - run("mkdocs build", cwd=repo, shell=True, check=False) # Build with CLI - - if __name__ == "__main__": generate_examples_md() copy_sources() From c41d8e954b3a8c85a2b8cc361f545926a3d733de Mon Sep 17 00:00:00 2001 From: "Anderson, Glen" Date: Fri, 11 Oct 2024 11:28:37 -0400 Subject: [PATCH 14/18] Add .venv to .gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index d151e4634c..456531df08 100644 --- a/.gitignore +++ b/.gitignore @@ -27,6 +27,7 @@ Tools/MSYS2 *.d /**/make.log /**/.idea/ +/**/.venv/ /**/venv/ session.txt.log flash.log From 8d899f27f2f9e244a88cb90d10f4bc9120597fab Mon Sep 17 00:00:00 2001 From: "Kernion, Juliette" Date: Wed, 16 Oct 2024 18:31:34 -0700 Subject: [PATCH 15/18] Added subtopic nav to .yml, fixed linter/mkdocs warnings --- Documentation/user-guide/build-system.md | 4 ++-- Documentation/user-guide/libraries.md | 4 ++-- Documentation/user-guide/visual-studio-code.md | 4 ++-- mkdocs.yml | 16 +++++++++++++++- 4 files changed, 21 insertions(+), 7 deletions(-) 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: From b11695ab678abbed46cf691c07e7d872d8ce4be7 Mon Sep 17 00:00:00 2001 From: "Kernion, Juliette" Date: Fri, 18 Oct 2024 17:34:05 -0700 Subject: [PATCH 16/18] Updated link/dir structure for UG --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 339024d289..1d6e45259b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -257,11 +257,11 @@ DoxyGen is automatically run across the MSDK code as part of the User Guide's bu ### User Guide -An MSDK User Guide is maintained in the [USERGUIDE.md](USERGUIDE.md) file. This document contains higher-level usage info for the MSDK. If a part, IDE, or library is supported by the MSDK then there should be some relevant info in the User Guide covering its setup, configuration, and usage. +The [MSDK User Guide](Documentation/user-guide/index.md) is maintained in the `Documentation/user-guide` folder. This document contains higher-level usage info for the MSDK. If a part, IDE, or library is supported by the MSDK then there should be some relevant info in the User Guide covering its setup, configuration, and usage. When writing markdown links, relative paths should always be used. Additionally, links to local files on the user's filesystem **cannot** be used, since the online copy of the docs will throw a 404 on them. See [Writing Your Docs](https://www.mkdocs.org/user-guide/writing-your-docs/) for more details. -Static resources such as images should be placed in the `res` folder. +Static resources such as images should be placed in the `user-guide/res` folder. ### Building the Documentation From 5a5a759fd1096f3f93736f9e02ac1f45d9892c15 Mon Sep 17 00:00:00 2001 From: "Kernion, Juliette" Date: Fri, 25 Oct 2024 12:15:45 -0700 Subject: [PATCH 17/18] Eliminated build errors in/around non-UG files --- Documentation/user-guide/libraries.md | 4 ++-- Libraries/CLI/README.md | 8 ++++---- Libraries/Cordio/docs/CORDIO_USERGUIDE.md | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Documentation/user-guide/libraries.md b/Documentation/user-guide/libraries.md index 3eab756aea..8e4c72835a 100644 --- a/Documentation/user-guide/libraries.md +++ b/Documentation/user-guide/libraries.md @@ -230,9 +230,9 @@ 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 +## CoreMarkS [EEMBC’s CoreMark®](https://www.eembc.org/coremark/) is a benchmark that measures the performance of microcontrollers (MCUs) and central processing units (CPUs) used in embedded systems. CoreMark is a simple, yet sophisticated benchmark that is designed specifically to test the functionality of a processor core. Running CoreMark produces a single-number score allowing users to make quick comparisons between processors. diff --git a/Libraries/CLI/README.md b/Libraries/CLI/README.md index 9e8bf026cb..eb1a8fabed 100644 --- a/Libraries/CLI/README.md +++ b/Libraries/CLI/README.md @@ -2,7 +2,7 @@ ## Description -#### What is a Command Line Interface(CLI)? +### What is a Command Line Interface(CLI)? A command-line interface or command language interpreter (CLI), also known as command-line user interface, console user interface, and character user interface (CUI), is a means of interacting with an embedded system where the user (or client) issues commands to the program in the form of successive lines of text (command lines). @@ -25,7 +25,7 @@ The current CLI Library includes the following features: To use the CLI library, users are expected to implement the following steps in their application: -1. Add the following line to your [project.mk](../../USERGUIDE.md#build-configuration-variables) file to enable the CLI library for your project: +1. Add the following line to your [project.mk](../../user-guide/build-system.md#build-configuration-variables) file to enable the CLI library for your project: :::Makefile LIB_CLI = 1 @@ -76,6 +76,6 @@ To use the CLI library, users are expected to implement the following steps in t Pass in the UART instance for the CLI to use, a pointer to the command table, and the number of commands in the command table. -6. (OPTIONAL) The CLI library will enable and handle UART interrupts automatically. Users who would like more control over the interrupt handling have the option to disable the default handler and define their own. +6. (OPTIONAL) The CLI library will enable and handle UART interrupts automatically. Users who would like more control over the interrupt handling have the option to disable the default handler and define their own. - To do so, set the `LIB_CLI_USE_DEFAULT_HANDLER` [build configuration variable](../../USERGUIDE.md#build-configuration-variables) to `0`. Users may now enable and handle the interrupt with a custom function. However, users must call `MXC_CLI_Handler()` from the custom function for the CLI to work. + To do so, set the `LIB_CLI_USE_DEFAULT_HANDLER` [build configuration variable](../../user-guide/build-system.md#build-configuration-variables) to `0`. Users may now enable and handle the interrupt with a custom function. However, users must call `MXC_CLI_Handler()` from the custom function for the CLI to work. diff --git a/Libraries/Cordio/docs/CORDIO_USERGUIDE.md b/Libraries/Cordio/docs/CORDIO_USERGUIDE.md index 120874e065..9b9abf8986 100644 --- a/Libraries/Cordio/docs/CORDIO_USERGUIDE.md +++ b/Libraries/Cordio/docs/CORDIO_USERGUIDE.md @@ -24,7 +24,7 @@ This library implements the Bluetooth Low Energy stack, forked from [Packetcraft The best application to get started with is the [BLE_periph](../docs/Applications/BLE_periph.md) application. It is a simple peripheral application that will allow you to advertise and connect with a central device such as a smartphone. -Follow the MSDK [User Guide](../../../USERGUIDE.md) instructions to install the necessary tools and create a new project. Build and run the `BLE_periph` application for the appropriate target. +Follow the MSDK [User Guide](../../../user-guide/index.md) instructions to install the necessary tools and create a new project. Build and run the `BLE_periph` application for the appropriate target. ## Building Most of the source code will be built in a library that can be shared between applications. Different variants will be built based on settings in **project.mk**. From d31eb082b8a5b51b4f4c1988204a6183b83b4bf5 Mon Sep 17 00:00:00 2001 From: "Anderson, Glen" Date: Wed, 30 Oct 2024 09:22:39 -0400 Subject: [PATCH 18/18] No need to manually build Doxygen since it's done in build.py --- .github/workflows/build-docs.yml | 122 +------------------------------ 1 file changed, 1 insertion(+), 121 deletions(-) diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 13e0884a5d..a5dc6a59bf 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -41,130 +41,10 @@ jobs: uses: actions/setup-python@v2.3.3 with: cache: pip - + - name: Install mkdocs run: pip install -r Documentation/requirements.txt - - name: Doxygen (MAX32520) - uses: mattnotmitt/doxygen-action@1.9.4 - with: - # Path to Doxyfile - doxyfile-path: max32520_Doxyfile - # Working directory - working-directory: Libraries/PeriphDrivers/Documentation - - - name: Doxygen (MAX32570) - uses: mattnotmitt/doxygen-action@1.9.4 - with: - # Path to Doxyfile - doxyfile-path: max32570_Doxyfile - # Working directory - working-directory: Libraries/PeriphDrivers/Documentation - - - name: Doxygen (MAX32572) - uses: mattnotmitt/doxygen-action@1.9.4 - with: - # Path to Doxyfile - doxyfile-path: max32572_Doxyfile - # Working directory - working-directory: Libraries/PeriphDrivers/Documentation - - - name: Doxygen (MAX32650) - uses: mattnotmitt/doxygen-action@1.9.4 - with: - # Path to Doxyfile - doxyfile-path: max32650_Doxyfile - # Working directory - working-directory: Libraries/PeriphDrivers/Documentation - - - name: Doxygen (MAX32655) - uses: mattnotmitt/doxygen-action@1.9.4 - with: - # Path to Doxyfile - doxyfile-path: max32655_Doxyfile - # Working directory - working-directory: Libraries/PeriphDrivers/Documentation - - - name: Doxygen (MAX32660) - uses: mattnotmitt/doxygen-action@1.9.4 - with: - # Path to Doxyfile - doxyfile-path: max32660_Doxyfile - # Working directory - working-directory: Libraries/PeriphDrivers/Documentation - - - name: Doxygen (MAX32662) - uses: mattnotmitt/doxygen-action@1.9.4 - with: - # Path to Doxyfile - doxyfile-path: max32662_Doxyfile - # Working directory - working-directory: Libraries/PeriphDrivers/Documentation - - - name: Doxygen (MAX32665) - uses: mattnotmitt/doxygen-action@1.9.4 - with: - # Path to Doxyfile - doxyfile-path: max32665_Doxyfile - # Working directory - working-directory: Libraries/PeriphDrivers/Documentation - - - name: Doxygen (MAX32670) - uses: mattnotmitt/doxygen-action@1.9.4 - with: - # Path to Doxyfile - doxyfile-path: max32670_Doxyfile - # Working directory - working-directory: Libraries/PeriphDrivers/Documentation - - - name: Doxygen (MAX32672) - uses: mattnotmitt/doxygen-action@1.9.4 - with: - # Path to Doxyfile - doxyfile-path: max32672_Doxyfile - # Working directory - working-directory: Libraries/PeriphDrivers/Documentation - - - name: Doxygen (MAX32675) - uses: mattnotmitt/doxygen-action@1.9.4 - with: - # Path to Doxyfile - doxyfile-path: max32675_Doxyfile - # Working directory - working-directory: Libraries/PeriphDrivers/Documentation - - - name: Doxygen (MAX32680) - uses: mattnotmitt/doxygen-action@1.9.4 - with: - # Path to Doxyfile - doxyfile-path: max32680_Doxyfile - # Working directory - working-directory: Libraries/PeriphDrivers/Documentation - - - name: Doxygen (MAX32690) - uses: mattnotmitt/doxygen-action@1.9.4 - with: - # Path to Doxyfile - doxyfile-path: max32690_Doxyfile - # Working directory - working-directory: Libraries/PeriphDrivers/Documentation - - - name: Doxygen (MAX78000) - uses: mattnotmitt/doxygen-action@1.9.4 - with: - # Path to Doxyfile - doxyfile-path: max78000_Doxyfile - # Working directory - working-directory: Libraries/PeriphDrivers/Documentation - - - name: Doxygen (MAX78002) - uses: mattnotmitt/doxygen-action@1.9.4 - with: - # Path to Doxyfile - doxyfile-path: max78002_Doxyfile - # Working directory - working-directory: Libraries/PeriphDrivers/Documentation - - name: Build User Guide run: | # Build Documentation Folder and run mkdocs python3 Documentation/build.py