Skip to content

Commit 295becf

Browse files
authored
Fix 'refdes' Link, Point More Documentation to MSDK User Guide (#7)
1 parent f923ce8 commit 295becf

File tree

2 files changed

+15
-591
lines changed

2 files changed

+15
-591
lines changed

README.md

Lines changed: 5 additions & 83 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ADI’s MAX78000/MAX78002 project is comprised of five repositories:
1313
4. The synthesis repository, which is used to *convert a trained model into C code* using the “izer” tool:
1414
[ai8x-synthesis](https://github.com/MaximIntegratedAI/ai8x-synthesis) **(described in this document)**
1515
5. The reference design repository, which contains host applications and sample applications for reference designs such as [MAXREFDES178 (Cube Camera)](https://www.analog.com/en/design-center/reference-designs/maxrefdes178.html):
16-
[refdes](https://github.com/analogdevicesinc/refdes)
16+
[refdes](https://github.com/analogdevicesinc/MAX78xxx-RefDes)
1717
*Note: Examples for EVkits and Feather boards are part of the MSDK*
1818

1919
_Open the `.md` version of this file in a markdown enabled viewer, for example Typora (<http://typora.io>).
@@ -535,7 +535,7 @@ With the installation of Training and Synthesis projects completed it is importa
535535

536536
### Embedded Software Development Kit (MSDK)
537537

538-
The Software Development Kit (MSDK) for MAX78000 and MAX78002 is used to compile, flash, and debug the output of the *ai8x-synthesis* (“izer”) tool. It also enables general software development for the microcontroller cores of the MAX78000 and MAX78002. It consists of the following components:
538+
The Software Development Kit (MSDK) for the MAX78000 and MAX78002 is used to compile, flash, and debug the output of the *ai8x-synthesis* (“izer”) tool. It also enables general software development for the microcontroller cores of the MAX78000 and MAX78002. It consists of the following components:
539539

540540
* Peripheral Drivers
541541
* Board Support Packages (BSPs)
@@ -551,91 +551,13 @@ There are two ways to install the MSDK.
551551

552552
#### Method 1: MSDK Installer
553553

554-
The [Analog Devices MSDK](https://github.com/analogdevicesinc/msdk) for MAX78000/MAX7802 is available via the installer links below. These installers require a GUI on your system.
554+
An automatic installer is available for the MSDK. Instructions on downloading, installing, and getting started with the MSDK's supported development environments are found in the [**MSDK User Guide**](https://analogdevicesinc.github.io/msdk/USERGUIDE/).
555555

556-
1. Download the MSDK installer for your operating system from one of the links below.
557-
* [Windows](https://www.analog.com/en/design-center/evaluation-hardware-and-software/software/software-download?swpart=SFW0010820A)
558-
* [Ubuntu Linux](https://www.analog.com/en/design-center/evaluation-hardware-and-software/software/software-download?swpart=SFW0018720A)
559-
* [macOS](https://www.analog.com/en/design-center/evaluation-hardware-and-software/software/software-download?swpart=SFW0018610A)
560-
561-
2. Run the installer executable. Note: On Linux, this may require making the file executable with the following command:
562-
563-
```bash
564-
$ chmod +x MaximMicrosSDK_linux.run
565-
```
566-
567-
3. Follow the instructions in the installer to the component selection.
568-
569-
4. Select the components to install. At _minimum_, the following components must be selected. This will enable command-line development.
570-
571-
* GNU RISC-V Embedded GCC
572-
* GNU Tools for ARM Embedded Processors
573-
* Open On-Chip Debugger
574-
* MSYS2 (only on Windows)
575-
* Microcontrollers
576-
* MAX78000 Resources
577-
* MAX78002 Resources
578-
* Product Libs
579-
* CMSIS Core Libraries
580-
* Miscellaneous Drivers
581-
* Peripheral Drivers
582-
583-
5. (Optional) Select the “Eclipse” and/or “Visual Studio Code Support” components to add support for those IDEs.
584-
585-
6. Continue through the instructions to complete the installation of the MSDK.
586-
587-
7. (macOS only) Install OpenOCD dependencies using [Homebrew](https://brew.sh/)
588-
589-
```shell
590-
$ brew install libusb-compat libftdi hidapi libusb
591-
```
592-
593-
8. (Linux and macOS only) Add the location of the toolchain binaries to the system `PATH`.
594-
595-
On Linux and macOS, copy the following contents into `~/.profile`...
596-
On macOS, _also_ copy the following contents into `~/.zprofile`...
597-
...and change `MAXIM_PATH` to the installation location of the MSDK.
598-
599-
```shell
600-
# MSDK location
601-
MAXIM_PATH=$HOME/MaximSDK # Change me!
602-
export MAXIM_PATH
603-
604-
# Arm GCC -- adjust version number
605-
ARMGCC_DIR=$MAXIM_PATH/Tools/GNUTools/12.3
606-
echo $PATH | grep -q -s "$ARMGCC_DIR/bin"
607-
if [ $? -eq 1 ] ; then
608-
PATH=$PATH:"$ARMGCC_DIR/bin"
609-
export PATH
610-
export ARMGCC_DIR
611-
fi
612-
613-
# RISC-V GCC -- adjust version number
614-
RISCVGCC_DIR=$MAXIM_PATH/Tools/xPack/riscv-none-embed-gcc/12.3.0-2
615-
echo $PATH | grep -q -s "$RISCVGCC_DIR/bin"
616-
if [ $? -eq 1 ] ; then
617-
    PATH=$PATH:"$RISCVGCC_DIR/bin"
618-
    export PATH
619-
    export RISCVGCC_DIR
620-
fi
621-
622-
# OpenOCD
623-
OPENOCD_DIR=$MAXIM_PATH/Tools/OpenOCD
624-
echo $PATH | grep -q -s "$OPENOCD_DIR"
625-
if [ $? -eq 1 ] ; then
626-
    PATH=$PATH:$OPENOCD_DIR
627-
    export PATH
628-
    export OPENOCD_DIR
629-
fi
630-
```
631-
632-
On Windows, this step is not necessary. However, “MaximSDK/Tools/MSYS2/msys.bat” file _must_ be used to launch the MSYS2 terminal for command-line development.
633-
634-
Once the tools above have been installed, continue with [Final Check](#final-check).
556+
After installation and setup, continue with the [Final Check](#final-check).
635557

636558
#### Method 2: Manual Installation
637559

638-
The MAX78000/MAX78002 MSDK is available as a git repository. The repository contains all of the MSDK's components _except_ the Arm GCC, RISC-V GCC, and Make. These must be downloaded and installed manually.
560+
The MSDK is also available as a [git repository](https://github.com/analogdevicesinc/msdk), which can be used to obtain the latest development resources. The repository contains all of the MSDK's components _except_ the Arm GCC, RISC-V GCC, and Make. These can be downloaded and installed manually.
639561

640562
1. Clone the MSDK repository (recommendation: change to the *ai8x-synthesis* folder first):
641563

0 commit comments

Comments
 (0)