This version (22 May 2023 19:36) was approved by Rebecca Butler.The Previously approved version (22 May 2023 17:18) is available.

Sharc Audio Module - Environment Setup and Compilation

The following instructions detail how to set up the rest of the PC environment and how to compile the program.

PATH Setup

The system needs to know where it can access make, the compilers for the SHARC and ARM cores and other tools. These tools reside within the installation of the CrossCore Embedded Studio that was installed previously.

To include a specific CCES Installation to PATH:¹²

1. Navigate in a Windows directory to the root of Sam-Audio-Starter project within the cloned repository and open the env.sh file using a preferred text editor.
2. Modify the CCES_VERSION parameter of env.sh to match the version of CCES installed on your PC³
3. Open the Git Bash application and navigate to the root of the Sam-Audio-Starter of the cloned repository
4. Run the command . ./env.sh noting the two periods in the command
5. Verify that CCES has been added to your path by running the command echo $PATH

If you already have CCES in your path by default, this section can be skipped.
These instructions need to be re-run every time a new instance of your command terminal is opened if CCES is not in your path by default.
If you have multiple versions of CCESS installed, pick either the latest or the version specific to your project. CCES is typically installed in C:\Analog Devices\CrossCore Embedded Studio <CCES VERSION>

CLD CDC USB Driver Setup

Only required for software that can be updated using the SAM Flasher! See Software Compatibility

The CLD CDC Driver is a driver that lives on the PC that acts as an interface between a serial terminal, such as TeraTerm, or the SAM GUI Flash Tool. This driver is required for USB to Serial emulation and to be able to interact with the bootloader or application at run-time on the physical SAM hardware.

To install the CLD CDC Driver:

1. In a Windows directory, navigate to <project_root>/utilities/bootloader/prebuilt/driver and unzip driver.zip
2. Power on your SAM board and plug in the 12V Power Supply to the 12V connector. If the board is properly powered, the green LED9/PWR will light up.
3. Plug the USB Micro Type B side to the SAM board USB connector and the USB Type A side to a USB connection on the PC. Note that the PC may say that the USB driver did not install or is not functioning properly. This is ok for now.
4. On the PC, open up Device Manager and navigate to Other Devices. Here you will see the CDC device recognized but with no associated driver.
5. Right click on CLD CDC Ctrl and select Update driver.
6. Select Browse my computer for drivers and navigate to the location which contains the unzipped .inf file (unzipped from driver.zip)
7. Once the driver has finished installing, it will appear under Ports as SC5xx Communications Port (COM12)

SAM GUI Flash Tool Installation

Only available for software that can be updated using the SAM Flasher! See Software Compatibility

The SAM GUI Flash Tool is a standalone tool that allows for application reflash of the SAM once the bootloader is installed.

To install the GUI:

1. In a Windows directory, navigate to <project_root>/utilities/bootloader/prebuilt and double-click sam-flasher_v0.0.5_setup.exe to run the installer.
2. Follow the default setup instructions to install the tool.
3. Once installed, it can be searched for, or found under SAM Flasher.

Application Compilation

The following instructions are used to compile the application binaries.

To compile the application:

1. In a Windows directory, navigate to <project_root>/build
2. On the command line, type make -j4
3. A successful compilation creates four binaries in the build folder, one for each core (For debugging) and one combined binary (for reflash): ARM Core (Debug): SAM-Audio-Starter-ARM.exe SHARC0 Core (Debug): SAM-Audio-Starter-SHARC0.dxe SHARC1 Core (Debug): SAM-Audio-Starter-SHARC1.dxe Combined Flash File: SAM-Audio-Starter.ldr