Wiki

Below is the source of this page. To edit this source as well as other pages on the wiki, you must login.
 ====== 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 [[resources:tools-software:sharc-audio-module:advanced-audio-projects:prerequisites|installed previously]].//

  - //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>//

**To include a specific CCES Installation to PATH:**
| 1. Open a file explorer and navigate to the root of the Audio Starter project within the cloned repository and open the //env.sh// file using a preferred text editor. | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:env1.png?600 |}}|
| 2. Modify the **CCES_VERSION** parameter of //env.sh// to match the version of CCES installed on your PC. | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:env2.png?600 |}} {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:env4.png?600 |}}|
| 3. Open the Git Bash application and navigate to the root of the Sam-Audio-Starter of the cloned repository | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:path1.png |}}|  
| 4. Run the command //. ./env.sh // noting the two periods in the command |{{:resources:tools-software:sharc-audio-module:advanced-audio-projects:path3.png|}}|
| 5. Verify that CCES has been added to your path by running the command //echo $PATH// | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:path2.png |}}|

----

===== SAM GUI Flash Tool Installation =====
**Only available for software that can be updated using the SAM Flasher! [[:resources:tools-software:sharc-audio-module:advanced-audio-projects:appendix-a|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. Open a file explorer and navigate to //<BOOTLOADER_PROJECT_ROOT>/bootloader/prebuilt// and double-click //sam-flasher_v0.0.5_setup.exe// to run the installer. | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:sam1.png?400 |}}|
| 2. Follow the default setup instructions to install the tool. | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:sam2.png?400 |}} {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:sam3.png?400 |}} {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:sam5.png?400 |}} {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:sam6.png?400 |}}|
| 3. Once installed, it can be searched for, or found under //SAM Flasher//. | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:sam7.png?400 |}} {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:sam8.png?400 |}}|

----

===== USB to UART Bridge Driver Setup =====
**Only required for ADZS-SC589-MINI v2.1 when the USB/UART interface is needed.**

//The USB to UART Bridge Driver is a Windows library that is used to emulate a serial connection over USB to the USB/UART (type Micro) on the ADSZ-SC589-MINI v2.1 hardware.//

**To install the USB to UART Bridge Driver:**
| 1. In a web browser, navigate to https://www.silabs.com/developers/usb-to-uart-bridge-vcp-drivers?tab=downloads | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:uart0.png?200 |}}|
| 2. Under //Software//, select //CP210x Universal Windows Driver// to download the latest driver. | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:uartdriver.png?400 |}}|
| 3. 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. | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:cld2.png?400 |}}|
| 4. Plug the USB Micro Type B side to the SAM board USB/UART 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.// | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:uart1.png?200 |}}|
| 5. On the PC, open up //Device Manager// and navigate to //Other Devices//. Here you will see the USB to UART Bridge Controller recognized but with no associated driver. | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:cld4.png?400 |}} {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:uart2.png?400 |}}|
| 6. Right click on //USB to UART Bridge Controller// and select //Update driver//. | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:uart3.png?400 |}}|
| 7. Select //Browse my computer for drivers// and navigate to the location which contains the unzipped //.inf// file (unzipped from the downloaded zip file) | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:uart4.png?400 |}}|
| 8. Once the driver has finished installing, it will appear under //Ports// as //Silicon Labs CP210x USB to UART Bridge// or something similar.| {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:uart5.png?400 |}} |

----

===== 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 // | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:compile1.png |}}|
| 2. On the command line, type //make -j4// | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:compile2.png |}} |
| 3. A successful compilation creates four binaries in the //build// folder, one for each core (For debugging) and one combined binary (for reflash). For example: \\ \\ //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// \\ \\ //Note that the names of the DXEs and LDR may vary depending on the project.// | {{ :resources:tools-software:sharc-audio-module:advanced-audio-projects:compile3.png?400 |}} |

----

<note important>Having trouble? Check out our list of [[:resources:tools-software:sharc-audio-module:advanced-audio-projects:appendix-b|common issues]]!</note>

----
{{navigation Advanced Audio Projects#.prerequisites|Prerequisites#.|Advanced Audio Projects#.program-flash|Bootloader and Application Flash}}
Analog Devices Wiki

Page Tools
