Code Composer Studio

https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/
Admin
Code Composer Studio is an integrated development environment (IDE) for developing and debugging...
Tokens:114,148
Snippets:1,342
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Full Debugger Script Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_debug-scripting.html

This comprehensive script demonstrates initializing the scripting environment, configuring a debug session, loading a program, setting and managing breakpoints, running the target, and handling timeouts. It's a good starting point for creating custom scripts.

```javascript
// Since we don't know where CCS will be installed, we must find files relative
// to this script. To this end, we will need access to node.js's path.join function.
const { join } = require ("path");

// Initialize scripting and obtain the main debugger scripting interface
const ds = initScripting();

// Configure a 10 second timeout on all operations (by default there is no timeout)
ds.setScriptingTimeout(10000);

// Configure the debugger and open a debug session to the cortex M core
ds.configure(join(__dirname, "mspm0g3507/mspm0g3507.ccxml"));
const session = ds.openSession(/cortex/i);

session.target.connect();

// Load program
// The path provided must be an absolute path. Here we use the current script's location
// to resolve the location.
session.memory.loadProgram(join(__dirname, "mspm0g3507/modem.out"));

// Set a breakpoint at ReadNextData
const bp1 = session.breakpoints.add("ReadNextData");

// Set a second breakpoint using the address of the function ShapingFilter
const bp2Addr = session.expressions.evaluate("ShapingFilter");
const bp2 = session.breakpoints.add(bp2Addr);

// Let's define a function to run the target and check if it halts at the correct symbol
function expectRunToHaltAt(symbol) {
    // Run the target and wait for it to halt
    session.target.run();

    const symbolAddr = session.expressions.evaluate(symbol);
    const pc = session.registers.read("PC")
    if (pc === symbolAddr) {
        console.log(`Success: target is halted at ${symbol} as expected.`);
    } else {
        console.error(
            `Failure: Expected target to be halted at 0x${symbolAddr.toString(16)}, `
            `but is actually halted at 0x${pc.toString(16)}.`
        );
        process.exit(1);
    }
}

// If we run, we should hit our first breakpoint at ReadNextData
expectRunToHaltAt("ReadNextData");

// If we run a second time, we expect to halt at our second breakpoint
expectRunToHaltAt("ShapingFilter");

// Remove our first breakpoint
session.breakpoints.remove(bp1);

// The program runs in an infinite loop, so running a third time should, once again, halt at the second breakpoint
expectRunToHaltAt("ShapingFilter");

// If we remove our second breakpoint as well, we expect to run in a loop until we time out
session.breakpoints.remove(bp2);

// We expect the next run to timeout, let's reduce the timeout duration so we don't have to wait as long
ds.setScriptingTimeout(2000);

try {
    console.log("Expecting target to not halt for 2 seconds");
    session.target.run();
    console.error("Failure: Halted unexpectedly after removing both breakpoints.");
} catch (err) {
    // Check if we actually timed out, or if some other error occurred
    if (err instanceof ScriptingTimeoutError) {
        console.log("Success: we timed out while waiting for the target to halt");
        session.target.halt();
    } else {
        console.error(`Failure: unexpected error while running ${err}`);
    }
}

// shutdown the debugger
ds.shutdown();

```

--------------------------------

### Full Multi-core Debug Session Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/sdto_dss_handbook.html

This comprehensive example demonstrates configuring a debug server, opening sessions for multiple cores, connecting to them, loading programs, and running them individually or simultaneously. It requires a specific ccxml configuration file and output executable.

```javascript
...

// Get the Debug Server and start a Debug Session
debugServer = script.getServer("DebugServer.1");

// Configure target for a TCI6488 EVM with SD XDS510 USB emulator
script.traceWrite("Configuring debug server for TCI6488 EVM...");
debugServer.setConfig("TCI6488EVM_SD510USB.ccxml");
script.traceWrite("Done!");

// Open a debug session for each TCI6488 CPU
script.traceWrite("Opening a debug session for all TCI6488 cores...");
debugSessionF1A = debugServer.openSession("TCI6488EVM_XDS510USB/C64PLUS_F1A");
debugSessionF1B = debugServer.openSession("TCI6488EVM_XDS510USB/C64PLUS_F1B");
debugSessionF1C = debugServer.openSession("TCI6488EVM_XDS510USB/C64PLUS_F1C");
debugSessionF2A = debugServer.openSession("TCI6488EVM_XDS510USB/C64PLUS_F2A");
debugSessionF2B = debugServer.openSession("TCI6488EVM_XDS510USB/C64PLUS_F2B");
debugSessionF2C = debugServer.openSession("TCI6488EVM_XDS510USB/C64PLUS_F2C");
script.traceWrite("Done!");

// Connect to each TCI6488 CPU
script.traceWrite("Connecting to all TCI6488 CPUs...");
debugSessionF1A.target.connect();
debugSessionF1B.target.connect();
debugSessionF1C.target.connect();
debugSessionF2A.target.connect();
debugSessionF2B.target.connect();
debugSessionF2C.target.connect();
script.traceWrite("Done!");

// Load a program for just the first TCI6488 CPU
script.traceWrite("Loading program to first TCI6488 CPU...");
debugSessionF1A.memory.loadProgram("HelloTCI6488.out");
script.traceWrite("Done!");

// Load a program for just the second TCI6488 CPU
script.traceWrite("Loading program to second TCI6488 CPU...");
debugSessionF1B.memory.loadProgram("HelloTCI6488.out");
script.traceWrite("Done!");

// Run the program for just the first TCI6488 CPU
script.traceWrite("Executing program on first TCI6488 CPU...");
debugSessionF1A.target.run();
script.traceWrite("Execution complete!");

// Reload program for just the first TCI6488 CPU
script.traceWrite("Loading program to first TCI6488 CPU...");
debugSessionF1A.memory.loadProgram("HelloTCI6488.out");
script.traceWrite("Done!");

// Run the program for the first and second TCI6488 CPU simultaneously
script.traceWrite("Executing program on first and second TCI6488 CPU...");

var dsArray = new Array();
dsArray[0] = debugSessionF1A;
dsArray[1] = debugSessionF1B;

debugServer.simultaneous.run(dsArray); // Run CPUs 1 and 2
script.traceWrite("Done!");

...
```

--------------------------------

### GEL hotmenu Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/hotmenu.html

Example demonstrating how to add multiple GEL functions to the Scripts menu using the hotmenu keyword. These functions execute immediately when selected.

```gel
menuitem "My Functions";
hotmenu InitTarget()
{
   *waitState = 0x11;
}
hotmenu LoadMyProg()
{
   GEL_Load("c:\\mydir\\myfile.out");
}

```

--------------------------------

### GEL while and do-while Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/while.html

Demonstrates the practical application of both GEL while and do-while loops for initializing an array segment.

```gel
while (a != Count)
{
   dataspace[a] = 0;
   a--;
}
```

```gel
do
{
   dataspace[a] = 0;
   a--;
} while (a != Count);
```

--------------------------------

### GEL Callback Trace Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/debug.html

This example demonstrates the trace output for GEL callbacks, such as OnHalt and OnFileLoaded. It is useful for understanding the sequence of events when specific target actions occur.

```gel
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:65      Enter function OnHalt
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:66         GEL_TextOut("Halted!!!\n")
TMS470R2x_0: GEL Output: Halted!!!
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:66      Leave function OnHalt
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:65      Enter function OnHalt
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:66         GEL_TextOut("Halted!!!\n")
TMS470R2x_0: GEL Output: Halted!!!
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:66      Leave function OnHalt
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:6       Enter function load_module_symbol
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:7          GEL_TextOut("Loading  C:/Users/Documents/ptzfi.ko\n")
TMS470R2x_0: GEL Output: Loading  C:/Users/Documents/ptzfi.ko
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:12         GEL_TextOut("Relocate section .bss to 0xbf015964\n")
TMS470R2x_0: GEL Output: Relocate section .bss to 0xbf015964
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:13         GEL_SymbolShowSection("C:/Users/Documents/ptzfi.ko", ".bss", 0xbf015964, 0xbf015964)
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:14         GEL_TextOut("Relocate section .data to 0xbf015208\n")
TMS470R2x_0: GEL Output: Relocate section .data to 0xbf015208
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:15         GEL_SymbolShowSection("C:/Users/Documents/ptzfi.ko", ".data", 0xbf015208, 0xbf015208)
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:16         GEL_TextOut("Relocate section .data..cacheline_aligned to 0xbf015800\n")
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:83      Enter function OnFileLoaded
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:83      Enter function OnFileLoaded
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:83      Enter function OnFileLoaded
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:83      Enter function OnFileLoaded
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:83      Enter function OnFileLoaded
TMS470R2x_0: GEL Output: Relocate section .data..cacheline_aligned to 0xbf015800
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:17         GEL_SymbolShowSection("C:/Users/Documents/ptzfi.ko", ".data..cacheline_aligned", 0xbf015800, 0xbf015800)
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:84         GEL_TextOut("OnFileLoaded!!!\n")
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:84         GEL_TextOut("OnFileLoaded!!!\n")
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:84         GEL_TextOut("OnFileLoaded!!!\n")
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:84         GEL_TextOut("OnFileLoaded!!!\n")
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:84         GEL_TextOut("OnFileLoaded!!!\n")
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:18         GEL_TextOut("Relocate section .exit.text to 0xbf01268c\n")
TMS470R2x_0: GEL Output: OnFileLoaded!!!
TMS470R2x_0: GEL Trace: ccs_modsyms.gel:84      Leave function OnFileLoaded
```

--------------------------------

### Get buildProject Help

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line-buildProject-options.html

Run this command to display the list of available buildProject options for your specific Code Composer Studio version.

```bash
ccs-server-cli -noSplash -workspace "<workspace_dir>" -application com.ti.ccs.apps.projectBuild -ccs.help

```

--------------------------------

### Get Help for createProject Options

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line-createProject-options.html

Run this command to display a list of available options for the `createProject` application, specific to your Code Composer Studio version.

```bash
ccs-server-cli -noSplash -workspace "<workspace_dir>" -application com.ti.ccs.apps.createProject -ccs.help

```

--------------------------------

### GEL Code Example 2

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/debug.html

Another GEL code example demonstrating function calls.

```gel
foo_cmd5( )
{
   foo_cmd2();
}

foo_cmd4( )
{
   foo_cmd7();
}

```

--------------------------------

### GEL Script Execution Trace Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/debug.html

This example shows the detailed trace output generated during the target launch, including function entry/exit and statement execution. It is useful for debugging complex GEL script behavior during initialization.

```gel
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:23   Enter function StartUp
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:25      GEL_LoadGel("$(GEL_file_dir)/CortexM3_util.gel")
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:27      GEL_MapOff()
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:28      GEL_MapReset()
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:29      GEL_MapOn()
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:30      F28M35H52C1_Memory_Map()
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:73      Enter function F28M35H52C1_Memory_Map
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:100        GEL_MapAddStr(0x0, 0, 0x10000, "R", 0)
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:101        GEL_MapAddStr(0x200000, 0, 0x80000, "R", 0)
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:102        GEL_MapAddStr(0x600000, 0, 0x10000, "R", 0)
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:103        GEL_MapAddStr(0x680000, 0, 0x00800, "R", 0)
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:104        GEL_MapAddStr(0x680800, 0, 0x00004, "R", 0)
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:241        GEL_MapAddStr(0xE000E000, 0, 0x1000, "R|W", 0)
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:243        GEL_TextOut("Memory Map Initialization Complete\n")
Cortex_M3_0: GEL Output: Memory Map Initialization Complete
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:243     Leave function F28M35H52C1_Memory_Map
Cortex_M3_0: GEL Trace: f28m35h52c1_m3.gel:30   Leave function StartUp
C28xx_0: GEL Trace: f28m35h52c1_c28.gel:21      Enter function StartUp
C28xx_0: GEL Trace: f28m35h52c1_c28.gel:0       Leave function StartUp
```

--------------------------------

### Example CCS Initialization Script

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_debug-main.html

This script demonstrates how to connect to a target CPU and load a program using CCS scripting. It's useful for automating debug session launches.

```javascript
// Create scripting instance for the initialization script
ds = initScripting();

// No need to configure debugger ( ds.configure() ) since the target information obtained from the launch configuration

// Open a debug session for the below connection/CPU
session = ds.openSession("Texas Instruments XDS110 USB Debug Probe/C28xx_CPU1");

// Connect to the target
session.target.connect();

// Load a program
session.memory.loadProgram("C:/Users/user/workspace_ccstheia2/gpio_ex2_toggle/CPU1_RAM/gpio_ex2_toggle.out");

// initialization scripts will not return unless the debug server instance for it is shutdown. This is not needed for CCS 20.1.0 and greater
ds.shutdown();

```

--------------------------------

### Breakpoint Property Names Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_debug-scripting.html

Illustrates example property names and their hierarchy for advanced breakpoints. These names are used with the setProperty() API.

```text
"Hardware Configuration.Location"
"Debugger Response.Action.Expression"
"Debugger Response.Skip Count"

```

--------------------------------

### Get Help for importProject Options

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line-importProject-options.html

Run this command to display the help message for the importProject command, which lists all available options for your specific Code Composer Studio version.

```bash
ccs-server-cli -noSplash -workspace "<workspace_dir>" -application com.ti.ccs.apps.projectImport -ccs.help

```

--------------------------------

### GEL Code Example 1

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/debug.html

Example GEL code defining command functions.

```gel
foo_cmd2( )
{
   foo_cmd();
}

cmd()
{
   foo_cmd4();
}

```

--------------------------------

### GEL Dialog Function with Parameter Descriptions

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/function.html

An example of a GEL dialog function 'Init' that includes descriptions for each parameter. These descriptions appear in the dialog box when the function is invoked.

```gel
dialog Init(filename "File to be Loaded", cpuName "CPU Name", initValue "Initialization Value")
{
   GEL_Load(filename, cpuName);
   a = initValue;
}

```

--------------------------------

### Configure Debugger and Start Session

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_debug-main.html

Configure the debugger for a specific target, open a debug session for a core, connect to it, load a program, and run the target.

```javascript
js:> ds.configure("MSPM0G3507.ccxml")

js:> session = ds.openSession("CORTEX_M0P")

js:> session.target.connect()

js:> session.memory.loadProgram("myApp.out")

js:> session.target.run()
```

--------------------------------

### GEL OnPreFileLoaded() Callback Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/OnPreFileLoaded.html

This GEL callback function is invoked before a program is loaded. It logs a message to the GEL text output.

```gel
OnPreFileLoaded()
{
    GEL_TextOut("OnPreFileLoaded called …\n")
}

```

--------------------------------

### GEL OnPreTargetConnect Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/OnPreTargetConnect.html

This snippet demonstrates the basic usage of the OnPreTargetConnect() function to output a message indicating it has been called. It is executed synchronously.

```gel
OnPreTargetConnect()
{
    GEL_TextOut("OnPreTargetConnect called …\n");
}


```

--------------------------------

### GEL Comment Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/comments.html

Demonstrates the use of multi-line C-style comments delimited by /* */ and single-line C++-style comments delimited by //.

```gel
/* this comment
spans two lines */
// this comment continues to the end of this line


```

--------------------------------

### Recursive GEL Function Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/recursion.html

Demonstrates a recursive GEL function that prints output and calls itself until a condition is met. Be cautious of infinite recursion.

```GEL
RecursiveTest(num)
{
   int i = num;
   do
   {
      GEL_TextOut("@%d ", "Test Output", 0, 0, 0, i);
      i++;
   }
   while (i <= 5);
   GEL_TextOut("\n", "Test Output");
   if (num < 5)
   RecursiveTest(num+1);
}

```

--------------------------------

### SysConfig Generated Code Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-management2.html

This snippet shows how SysConfig adds source code when a GPIO is configured. It highlights the unified diff view.

```text
--- a/main.c
+++ b/main.c
@@ -65,5 +65,10 @@
 // ... existing code ...
 
 // SysConfig generated code for GPIO
+GPIO_init();
+GPIO_write(Board_GPIO_LED0, 1);
+GPIO_write(Board_GPIO_LED1, 0);
+
 // ... rest of the code ...
 
```

--------------------------------

### GEL OnFileLoaded() Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/OnFileLoaded.html

This GEL code snippet demonstrates how to implement the OnFileLoaded() callback function. It checks the error code and symbol-only status to provide appropriate output messages using GEL_TextOut().

```gel
OnFileLoaded(int nErrorCode, int bSymbolsOnly)
{
    if (nErrorCode)
    {
        GEL_TextOut("An error occurred while loading a file. -%d-\n",,,,,ErrorCode);
    }
    else
    {
        GEL_TextOut("File was loaded successfully. -%d-\n",,,,, nErrorCode);
    }
    if (bSymbolsOnly)
    {
        GEL_TextOut("Only symbols were loaded.\n");
    }
    else
    {
        GEL_TextOut("Full load.\n");
    }
}

```

--------------------------------

### GEL OnReset() Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/OnReset.html

This GEL function is called after a target processor reset. Use it to log success or failure based on the nErrorCode parameter.

```gel
OnReset(int nErrorCode)
{
    if (nErrorCode)
    {
        GEL_TextOut("An error occurred while resetting. -%d-\n",,,,,nErrorCode);
    }
    else
    {
        GEL_TextOut("Reset was successful. -%d-\n",,,,, nErrorCode);
    }
}


```

--------------------------------

### Install Debug Probe Drivers on Ubuntu

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_installation.html

On Ubuntu 24.04, these commands are necessary to set correct permissions for the chrome-sandbox if the install_drivers.sh script fails.

```bash
sudo chown root chrome-sandbox
sudo chmod 4755 chrome-sandbox

```

--------------------------------

### GEL OnPreReset() Callback Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/OnPreReset.html

This GEL callback function is invoked before a reset is issued to the target processor. It logs the index of the reset that is about to occur. The reset will proceed even if this callback encounters an error.

```gel
OnPreReset(int resetIndex)
{
    GEL_TextOut("Reset %d is about to be issued.\n",,,,,resetIndex);
}
```

--------------------------------

### GEL OnTargetConnect() Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/OnTargetConnect.html

This snippet demonstrates the basic usage of the OnTargetConnect() function. It prints a message to the GEL output when a target is connected. Avoid state-modifying commands if unobtrusive connections are required.

```gel
OnTargetConnect()
{
    GEL_TextOut("OnTargetConnect called …\n");
}


```

--------------------------------

### GEL_LoadBin()

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/GEL_LoadBin.html

Loads a raw binary file into target memory, starting at the specified address. The entire contents of the file are treated as binary data to be written to the target memory.

```APIDOC
## GEL_LoadBin()

### Description
Loads a raw binary file into target memory, starting at the specified address. The entire contents of the file are treated as binary data to be written to the target memory.

### Syntax
GEL_LoadBin( "file_path" [, start_address] [, "cpu_name"] [, "board_name"] );

### Parameters
#### Path Parameters
- **file_path** (string) - Required - Path to the binary file to be loaded. The file_path must be enclosed in quotation marks.
- **start_address** (integer) - Optional - Address on the target at which the contents of the file should be written. Default is 0.
- **cpu_name** (string) - Optional - Names the CPU on which to load the file (useful in a multiprocessor environment). The cpuName must be enclosed in quotation marks.
- **board_name** (string) - Optional - is the text string specified as the Board Name in the target configuration. The boardName must be enclosed in quotation marks.

### Example
```
GEL_LoadBin( "C:/path/to/file.bin", 0x8000 );

```

```
GEL_LoadBin( "C:/path/to/file.bin", 0x8000, "cpu_a", "Emulator" );

```
```

--------------------------------

### Node.js Debug Launch Configuration

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_debug-scripting.html

Example launch configuration for debugging a Node.js script in an IDE. Ensure the `runtimeExecutable` path points to your CCS Node.js installation.

```JSON
{
    "name": "Debug Script",
    "type": "node",
    "runtimeExecutable": "C:/ti/ccs2040/ccs/tools/node/node",
    "request": "launch",
    "program": "C:/Users/user/workspace_ccstheia/led_ex1_blinky_cpu1/example_scripting_f28379d.js",
    "skipFiles": [
        "<node_internals>/**"
    ]
}
```

--------------------------------

### Get Numeric Debug Property Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/GEL_GetNumericDebugProperty.html

Demonstrates how to retrieve a numeric debug property value using GEL_GetNumericDebugProperty. This snippet also shows related functions for boolean and string properties.

```C
int autoResetOnConnect = GEL_GetBoolDebugProperty("AutoResetOnConnect");
string flashFiles = GEL_GetStringDebugProperty("FlashFiles");
int flashTimeout = GEL_GetNumericDebugProperty("FlashTimeoutValue");

```

--------------------------------

### Load Memory from .dat File

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/GEL_MemoryLoad.html

Loads a block of target memory from a .dat file. The data is interpreted based on the file's header information. This example loads 0x100 words starting from address 0x1000 in data memory (page 1).

```GEL
GEL_MemoryLoad(0x1000, 1, 0x100, "c:\\mydir\\myfile.dat");
```

--------------------------------

### Create a Code Composer Studio Project

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line.html

Use this command to create a new project. You can specify the project name and device, or provide a project specification file. Ensure forward slashes are used for paths.

```bash
ccs-server-cli -noSplash -workspace "<workspace_dir>" -application com.ti.ccs.apps.createProject (-ccs.projectSpec <file> | -ccs.name <name> -ccs.device <id>) [<options>]
```

```bash
ccs-server-cli -noSplash -workspace "C:/Users/user/workspace_ccstheia" -application com.ti.ccs.apps.createProject -ccs.name newProject -ccs.device MSPM0L1306
```

--------------------------------

### Create New Project from Command Line

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_faqs.html

Use this command to create a new empty static library project for a specified device via the command line interface. Ensure the workspace path is valid.

```bash
ccs-server-cli -noSplash -workspace "C:/temp/workspace_cli" -application com.ti.ccs.apps.createProject -ccs.name F2800157_staticLib -ccs.device TMS320C28XX.TMS320F2800157 -ccs.outputType staticLibrary - ccs.toolChain TI -ccs.outputFormat ELF

```

--------------------------------

### Print Help Message

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line-buildProject-options.html

Use the '-ccs.help' option to print this help message, listing all available buildProject options.

```bash
-ccs.help

```

--------------------------------

### GEL Format Specifier Examples

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/format.html

Examples of GEL format specifiers and their corresponding data types and output formats. The string type requires a constant string declared on the host.

```gel
%d
```

```gel
%u
```

```gel
%x
```

```gel
%f
```

```gel
%e
```

```gel
%s
```

--------------------------------

### Get String Length and Substring

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/GEL_StrCat.html

Demonstrates using GEL_StrLen to get the length of a concatenated string and GEL_SubStr to extract a portion of a string. These functions are often used in conjunction with string manipulation.

```gel
int length = GEL_StrLen(product_str);  // length == 26
string state = GEL_SubStr(company, 0, 5); // state == "Texas"

```

--------------------------------

### Enable Products for Project

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line-createProject-options.html

List products to enable for the project using the `-ccs.products` option, specifying IDs and optional versions.

```bash
ccs-server-cli -noSplash -workspace "<workspace_dir>" -application com.ti.ccs.apps.createProject -ccs.products '[<id>:<version>];+'

```

--------------------------------

### Example DSS Log File Output

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/sdto_dss_handbook.html

This is an example of raw XML output from a DSS log file, showing timestamps, sequence IDs, and log levels. Note the second line which references the XSLT stylesheet for browser rendering.

```xml
<?xml version="1.0" encoding="windows-1252" standalone="no"?>
<?xml-stylesheet type="text/xsl" href="DefaultStylesheet.xsl"?>
<log>
<record>
 <date>2008-10-30T17:16:53</date>
 <millis>1225401413228</millis>
 <sequence>6</sequence>
 <logger>com.ti</logger>
 <level>FINER</level>
 <class>com.ti.ccstudio.scripting.environment.ScriptingEnvironment</class>
 <method>traceSetFileLevel</method>
 <thread>10</thread>
 <message>RETURN</message>
</record>
<record>
 <date>2008-10-30T17:16:53</date>
 <millis>1225401413238</millis>
 <sequence>7</sequence>
 <logger>com.ti</logger>
 <level>FINER</level>
 <class>com.ti.ccstudio.scripting.environment.ScriptingEnvironment</class>
 <method>getServer</method>
 <thread>10</thread>
 <message>ENTRY sServerName: DebugServer.1</message>
</record>

...


```

--------------------------------

### Create Target Configuration Command

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line-full-api-guide.html

Use this command to create a target configuration file. Specify the workspace, application, and device. Optional arguments include connection details and the save path.

```bash
ccs-server-cli.bat -workspace '<workspace-dir>' -application com.ti.ccs.apps.createTargetConfiguration -ccs.device <arg> [-ccs.connection <arg> -ccs.saveAs '<file>']

```

--------------------------------

### Library Error - Dynamic Library Not Found

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_troubleshooting-jtag-errors.html

This error indicates that required software or device drivers are not properly installed, or a required dynamic library could not be located. Reinstalling TI Emulators, checking installation directory accessibility, verifying target configuration, or reinstalling drivers may resolve this.

```text
This error is generated by TI's USCIF driver or utilities.

The value is '-600' (0xfffffda8).
The title is 'SC_ERR_LIB_ANY_LOCATE'.

The explanation is:
A required dynamic library could not be located.
The library isn't on the search path.


```

--------------------------------

### Import Project Options

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line-full-api-guide.html

These options configure the project import process, including the source location, device targeting, path variable management, and handling of existing files.

```bash
-ccs.location '<path>'
        Absolute or relative path to the location containing the project.
        Relative paths will be assumed to be relative to the working directory.
```

```bash
-ccs.device <id>
        The device-variant ID. Applicable only when '-ccs.location' flag resolves to a .projectspec file.
```

```bash
-ccs.definePathVariable <name> <value> [@scope (global|project)]
        Defines the given path-variable for resolving portable linked file paths (optional)
        (also defines a global build-macro with the same name and value).
        Optionally, specify the scope (defaults to 'global').
```

```bash
-ccs.copyIntoWorkspace
        Copy project folder and contents into the workspace directory (optional).
        Defaults to 'false'.
```

```bash
-ccs.renameTo <name>
        Rename the imported project to the specified name.
```

```bash
-ccs.overwrite
        Forces overwrite of existing file-system resources (optional).
```

```bash
-ccs.autoBuild
        Performs an incremental build on the imported/created project (optional).
```

```bash
-ccs.autoImportReferencedProjects
        If 'true', an attempt is made to automatically import any referenced projects found in the same parent directory as the main project.
```

```bash
-ccs.autoRenameReferencedProjects
        If 'true', and iff the '-ccs.renameTo' flag is present, any imported referenced projects will also be renamed automatically.
```

```bash
-ccs.referencedProjectSearchDirectory
        Directory to search for referenced projects. Applicable only when '-ccs.autoImportReferencedProjects' flag is present.
```

```bash
-ccs.captureCopiedFileOrigins
        Capture the original locations of all resources copied into the project during the import. These will be captured into a text file named 'copiedFileOrigins.txt'.
```

```bash
-ccs.captureProjectspecApplicability
        Capture the list of devices that the imported projectspec is applicable to. These will be captured into a text file named 'projectSpecApplicability.txt'.
```

```bash
-ccs.defaultImportDestination '<dir>'
        Default import-destination. This is the workspace where user-projects will be created/imported by default.
```

```bash
-ccs.args '<file>'
        File containing any extra arguments (optional).
```

```bash
-ccs.help
        Print this help message.
```

--------------------------------

### GEL Code Example 3

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/debug.html

GEL code containing GEL_TextOut function call.

```gel
foo_cmd7( )
{
   foo_cmd5();
}

foo_cmd()
{
   GEL_TextOut( "address of cmd = %x\n", 0, 0, 0, 0, &cmd2 );
}

```

--------------------------------

### Initializing Scripting with Options (Dictionary)

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_debug-scripting.html

Initializes scripting by passing ScriptingOptions as a dictionary. This method is functional but not recommended.

```javascript
ds = initScripting({"ccsRoot":"/home/user/ti/ccs2030/ccs", "logFile":"/home/user/log.txt"})
```

--------------------------------

### Load Program Only Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/GEL_LoadProgramOnly.html

Demonstrates how to load a program file onto the target CPU without loading symbol information. Ensure to use double backslashes for paths in Windows environments. This function is useful when symbol information is not required or when dealing with specific loading scenarios.

```GEL
GEL_LoadProgramOnly("c:\\mydir\\myfile.out", "cpu_a", "Emulator");

```

--------------------------------

### Load Symbol Information with Absolute Relocation

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/GEL_SymbolAddRel.html

Use this function to load symbol information from a specified file with absolute addresses for code and data sections. Provide the file name, code start address, data start address, and optionally CPU and board names. Ensure correct path formatting with double backslashes for Windows paths.

```GEL
GEL_SymbolAddRel("c:\\mydir\\myfile.out", 16, 64, "cpu_a", "Emulator");
```

--------------------------------

### Adding GEL Functions to Scripts Menu with dialog

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/dialog.html

Example demonstrating how to use the dialog keyword to add two functions, 'InitTarget' and 'LoadMyProg', to the Scripts menu. 'InitTarget' accepts two parameters with descriptions for the dialog box.

```gel
menuitem "My Functions";
dialog InitTarget(startAddress "Starting Address", EndAddress "End Address")
{
   statements
}
dialog LoadMyProg()
{
   statements
}
```

--------------------------------

### Inspect Discovered Products

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line-full-api-guide.html

Use this option to inspect the discovered third-party products and tools installed in CCS.

```bash
-ccs.products
```

--------------------------------

### Show Basic Product Details

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line-full-api-guide.html

Append this option to '-ccs.products' to output only basic details for each discovered product or tool.

```bash
-ccs.products:showBasicDetails
```

--------------------------------

### Verify Target Memory with GEL_VerifyBinProgram()

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/GEL_VerifyBinProgram.html

Use this function to verify that target memory matches a specified raw binary file without actually loading the file. Provide the full path if the file is not in the current directory, using double backslashes for path separators. Optional parameters include the start address, CPU name, and board name.

```gel
GEL_VerifyBinProgram("c:\\mydir\\myfile.bin", 0x8000, "cpu_a", "Emulator");

```

--------------------------------

### GEL Debugging Output

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/debug.html

Example of runtime error message and call stack output in the CCS scripting console when evaluating 'cmd()'.

```javascript
js:> eval('cmd()')
    Error evaluating "cmd()": identifier not found: cmd2
        at GEL_TextOut("address of cmd = %x\n", 0, 0, 0, 0, &(cmd2)) [test3.gel:8]
        at foo_cmd() [test.gel:3]
        at foo_cmd2() [test2.gel:3]
        at foo_cmd5() [test3.gel:3]
        at foo_cmd7() [test2.gel:8]
        at foo_cmd4() [test.gel:8]
        at cmd()
(C:\\ti\\ccs\\eclipse\\configuration\\org.eclipse.osgi\\bundles\\361\\1\\.cp\\resources\\debugserver\\expression.js#10)
js:>
```

--------------------------------

### GEL break Statement Example

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/break.html

Demonstrates the use of the break statement within a for loop to exit the loop when a specific condition is met.

```gel
for (j=0; j<i; j++)
{
   if (j == k)
   break;
}
```

--------------------------------

### Add Product Discovery Path

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line.html

Use this command to add paths for new discoverable software products (like SDKs) so Code Composer Studio can detect them. Paths are separated by semicolons.

```bash
ccs-server-cli -noSplash -workspace "<workspace_dir>" -application com.ti.ccs.apps.initialize -ccs.productDiscoveryPath "<path1>;<path2>"
```

--------------------------------

### Connection Option for Create Target Configuration

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line-full-api-guide.html

Optionally specify the connection configuration. This can be a connection XML file name or a Java regular expression to match connection names.

```bash
-ccs.connection <arg>

```

--------------------------------

### List Applicable Build Options

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line-createProject-options.html

Use `-ccs.listBuildOptions` to print a list of all applicable build options without creating the project.

```bash
ccs-server-cli -noSplash -workspace "<workspace_dir>" -application com.ti.ccs.apps.createProject -ccs.listBuildOptions

```

--------------------------------

### Simple GEL Function: Squaring a Parameter

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/function.html

An example of a GEL function that squares its input parameter 'a'. This function can be called directly or from other GEL functions.

```gel
square(a)
{
   return a*a;
}

```

--------------------------------

### Create Project with Project Specification File

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line-createProject-options.html

Use the `-ccs.projectSpec` option to define the project(s) to be created using a project specification file.

```bash
ccs-server-cli -noSplash -workspace "<workspace_dir>" -application com.ti.ccs.apps.createProject -ccs.projectSpec '<file>'

```

--------------------------------

### Show Basic Device Details

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line-full-api-guide.html

Append this option to '-ccs.devices' to output some basic details for each device in the list.

```bash
-ccs.devices:showBasicDetails
```

--------------------------------

### Import Project with Relative Path

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line.html

Demonstrates importing a project using a relative path for the workspace directory. This is useful for maintaining project portability.

```bash
ccs-server-cli -noSplash -workspace "C:/Users/user/workspace_ccstheia" -application com.ti.ccs.apps.importProject -ccs.location ..\dsp\proj\acm
```

--------------------------------

### Unconditional and Conditional Execution with GEL_Run()

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/GEL_Run.html

Starts code execution on the target. The optional condition halts execution at breakpoints if the condition evaluates to false.

```GEL
GEL_Run();
```

```GEL
GEL_Run("A != B");
```

--------------------------------

### Disable Auto-Run on Program Load/Restart

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_debug-scripting.html

Example of disabling the 'AutoRunToLabelOnRestart' debugger setting. This prevents the debugger from automatically running the program when it's loaded or restarted.

```javascript
// disable auto-run to main
session.settings.set("AutoRunToLabelOnRestart", false);
```

--------------------------------

### Device Option for Create Target Configuration

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/ccs_project-command-line-full-api-guide.html

Specify the target device for configuration. This can be a device XML file name or a Java regular expression to match device names or IDs.

```bash
-ccs.device <arg>

```

--------------------------------

### Load Program with GEL_Load()

Source: https://software-dl.ti.com/ccs/esd/documents/users_guide_ccs_20.4.0/gel/GEL_Load.html

Loads a program file, optionally specifying the CPU and board name. Ensure correct path escaping for file names.

```gel
GEL_Load("c:\\mydir\\myfile.out", "cpu_a", "Emulator");

```
Tokens:
Raw