Code Composer Studio

https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/
Admin
Code Composer Studio is an integrated development environment (IDE) that supports TI’s...
Tokens:100,324
Snippets:1,241
Trust Score:10
Update:4 months ago
Show doc for...
Tokens:
Raw
### Full Multi-core Debug Session Example

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.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.

```javascript
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 while and do-while Example

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/while.html

Demonstrates the usage of both GEL while and do-while loops to initialize elements of a dataspace array.

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

```

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

### GEL Script Example 1

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/debug.html

Example GEL script defining command functions.

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

cmd()
{
   foo_cmd4();
}

```

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

### GEL Script Example 3

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/debug.html

GEL script demonstrating GEL_TextOut for outputting information.

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

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

```

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

### GEL Script Example 2

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/debug.html

Another GEL script example with nested function calls.

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

foo_cmd4( )
{
   foo_cmd7();
}

```

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

### Get Help for createProject Options

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-createProject-options.html

Run this command to display a list of all 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 OnPreReset() Example

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/OnPreReset.html

This snippet demonstrates how to define the OnPreReset() callback function in GEL. It logs a message indicating which reset is about to occur.

```gel
OnPreReset(0)
{
    GEL_TextOut("Reset 0 is about to be issued.\n");
}

```

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

### Example GEL hotmenu Usage

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/hotmenu.html

Demonstrates adding 'InitTarget' and 'LoadMyProg' functions to the GEL menu using the hotmenu keyword. 'InitTarget' sets a wait state, and 'LoadMyProg' loads a specified output file.

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

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

### SysConfig Generated Code Example (Unified Diff)

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-management2.html

This snippet shows an example of how source code is added when a GPIO is configured using SysConfig. It displays the unified diff view, highlighting the changes made to the generated files.

```text
--- a/main.c
+++ b/main.c
@@ -65,7 +65,12 @@
 
 void main(void) {
 
-    // Initialize the board
-    Board_init();
+    // Initialize the GPIO module
+    GPIO_init();
+
+    // Configure GPIO pins
+    GPIO_setConfig(Board_GPIO_LED0, GPIO_CFG_OUTPUT | GPIO_CFG_INVERT);
+    GPIO_setConfig(Board_GPIO_BUTTON0, GPIO_CFG_INPUT);
 
     // Application loop
     while (1) {
```

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

### Execute DOS Command with Wildcards and Parameters

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/GEL_System.html

Demonstrates executing a DOS command with wildcards and passing parameters using format specifiers. The second example shows the correct way to pass a parameter for wildcard matching.

```gel
GEL_System("dir \*.dat")
/* Which is equivalent to: */
GEL_System("dir %s", "\*.dat");
/* But not */
GEL_System("dir", "\*.dat");

```

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

### Run Target Program

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_debug-main.html

Starts the execution of the loaded program on the target.

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

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

### Adding GEL Menu Items with Dialogs

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/dialog.html

Example demonstrating how to use the dialog keyword to add two menu items to the Scripts menu, one with parameters and one without.

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

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

### Show Symbol Section Example

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/GEL_SymbolShowSection.html

Demonstrates how to use GEL_SymbolShowSection to display the '.text' section from a specified output file, loading code and data at address 0, and targeting a specific CPU and board.

```GEL
GEL_SymbolShowSection( "C:\\mydir\\myfile.out", ".text", 0x0, 0x0,
"Cortex_M4_0", "Texas Instruments XDS110 USB Debug Probe_0" );


```

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

### GEL_SyncRun Example

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/GEL_SyncRun.html

This snippet demonstrates the basic usage of the GEL_SyncRun function. It performs a run operation on all targets in the same group as the current target.

```gel
GEL_SyncRun( );

```

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

### OnPreTargetConnect() Example

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/OnPreTargetConnect.html

This snippet demonstrates the basic structure of the OnPreTargetConnect() callback. It is executed synchronously after the parent router connects and before the target connects.

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

```

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

### GEL Trace Output During Target Launch

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/debug.html

This example shows the detailed trace output generated when a GEL script executes during the target launch process. It includes function entry/exit and statement execution.

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

```

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

### Execute DOS Command with Formatted Parameters

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/GEL_System.html

Shows how to pass multiple parameters to a system command using format specifiers like %f, %d, and %s. The example illustrates how target variables and literal values are substituted into the command string.

```gel
GEL_System("myfunc %f %d %s", targVar, 3, "-ol");
/*
If we assume that targVar is a variable defined on the target and that
its value is 3.14, then the final DOS command that is executed is:
>>myfunc 3.14 3 -ol
*/

```

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

### GEL Trace Output for Callbacks

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/debug.html

This example demonstrates the trace output when GEL callbacks are triggered, such as OnHalt or OnFileLoaded. It shows function calls, GEL_TextOut messages, and symbol operations.

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

```

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

### GEL Dialog Function with Parameter Descriptions

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/function.html

An example of a GEL dialog function 'Init' that includes descriptive strings for its parameters. These descriptions appear in the function's dialog box and are used for loading files and initializing values.

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

```

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

### GEL OnFileLoaded() Callback Example

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/OnFileLoaded.html

Implement this GEL callback function to handle events after a program is loaded. It checks for loading errors and whether only symbols were loaded, providing output messages accordingly.

```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");
    }
}

```

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

### Get Boolean Target DB Property Example

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/GEL_GetBoolTargetDbProperty.html

Demonstrates how to retrieve boolean, string, and numeric properties from the target database using GEL functions. Ensure the property names are valid.

```c
int bHaltOnConnect = GEL_GetBoolTargetDbProperty("haltOnConnectByDefault");
string defConn = GEL_GetStringTargetDbProperty("DefaultConnection");
int numIntrs = GEL_GetNumericTargetDbProperty("Number of Interrupt Supported");

```

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

### Display Target Formatted String

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/GEL_TargetTextOut.html

This example shows how to call GEL_TargetTextOut to display a formatted string starting at address 0x800. The default parameters will be used for page, maxLength, Format, outputLabel, textColor, lineNumber, appendToEnd, and changeHighlight.

```GEL
GEL_TargetTextOut(0x800);
```

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

### Load Memory from .dat File

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/GEL_MemoryLoad.html

Loads a block of memory from a .dat file into the target. The debugger uses header information to determine the file format. This example specifies the start address, memory page (1 for data memory), length, and filename.

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

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

### Display Target Formatted String with Options

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/GEL_TargetTextOut.html

This example demonstrates calling GEL_TargetTextOut with specific parameters: starting at address 0x1000, using data memory (page 0), a maximum length of 400 bytes, packed ASCII format (little endian, format 1), and a custom output label 'My Window'. The textColor parameter is also set to 1, though it is ignored in this version of CCS.

```GEL
GEL_TargetTextOut(0x1000, 0, 400, 1, "My Window", 1);
```

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

### Enable Products

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-createProject-options.html

Use the `-ccs.products` option to specify a list of products to enable for the project. The format is "<id>[:<version>];+".

```bash
-ccs.products "[<id>[:<version>];]+"

```

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

### List Build Options Command

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-full-api-guide.html

Prints a list of all applicable build-options without creating the project. This is useful for discovery.

```bash
-ccs.listBuildOptions
```

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

### Run CCS Driver Install Script (Linux)

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_installation.html

Execute the driver installation script with sudo after installing Code Composer Studio as a user on Linux systems. This is crucial for debugging and IDE functionality on current Ubuntu versions.

```bash
sudo <CCS_INSTALL_DIR>/ccs/install_scripts/install_drivers.sh
```

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

### GEL Debugging Output Example

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/debug.html

Example of GEL runtime error message with call stack 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:3]
        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:>
```

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

### Products Option

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-full-api-guide.html

List of products to enable for the project, specified as '<id>[:<version>]'.

```bash
-ccs.products "[<id>[:<version>];]+"
```

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

### Get a Specific Debugger Setting Value

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_debug-scripting.html

Use the `get(settingId)` API to retrieve the current value of a specific debugger setting by providing its unique ID.

```javascript
get(settingId): string | number | boolean
```

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

### Display buildProject Help Message

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-buildProject-options.html

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

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

```

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

### Breakpoint Property Names Example

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_debug-scripting.html

Illustrates example property names for advanced breakpoint configurations. These names are derived from the CCS debugger's breakpoint properties hierarchy.

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

```

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

### Inspect Products with Basic Details Option

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-full-api-guide.html

Outputs basic details for each discovered product or tool when used with '-ccs.products'.

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

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

### Add Compiler Tool Discovery Path

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line.html

Specify a path for newly installed compiler tools so Code Composer Studio can detect them. This is useful for custom compiler installations.

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

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

### List Build Options

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-createProject-options.html

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

```bash
-ccs.listBuildOptions

```

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

### GEL break Statement Example

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.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. This example shows how to break out of the loop when the variable 'j' equals 'k'.

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

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

### Runtime Support Library Option

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-full-api-guide.html

Specify a runtime support library file. Defaults to device-specific settings.

```bash
-ccs.rts "<file>"
```

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

### Get String Length and Substring

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/GEL_StrCat.html

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

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

```

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

### Automate Debug Actions with Initialization Script

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_debug-main.html

This JavaScript snippet demonstrates an initialization script for a manual launch. It connects to a specific CPU and loads a program. Ensure the scripting instance is properly initialized.

```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();

```

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

### Connect to Target

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_debug-main.html

Establishes a connection to the target core.

```javascript
js:> session.target.connect()
```

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

### Print Help Message

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-buildProject-options.html

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

```bash
-ccs.help

```

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

### GEL if Statement with Block

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/if.html

Executes a single statement if the condition is true. This example shows a simple assignment.

```gel
if (a == 25)
b = 30;
```

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

### GEL Function Call with Integer Value

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/param.html

Example of calling the Initialize GEL function with an integer value for the 'value' parameter.

```gel
Initialize(targetSymbol, "c:\\workspace\\myProject\\Debug\\myProject.dat", 10);
```

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

### Import Project Options

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-full-api-guide.html

These options manage the import process, including specifying the source path, device, copying behavior, and handling of referenced projects.

```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.overwrite
        Forces overwrite of existing file-system resources (optional).

```

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

```

```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.args <file>
        File containing any extra arguments (optional).

```

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

```

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

### GEL for Statement Example

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/for.html

This snippet demonstrates the basic usage of the GEL 'for' statement to iterate and initialize array elements.

```gel
for (i = 0; i < 9; i++)
{
   data1[i] = 0;
   data2[i] = 0;
}

```

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

### Build Configurations Option

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-full-api-guide.html

Define a space-separated list of build-configurations to create. Defaults to 'Debug Release'.

```bash
-ccs.configurations <name1>[ <name2>]*
```

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

### Inspect Devices Option

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-full-api-guide.html

Use this option to inspect the listing of supported devices.

```bash
-ccs.devices
```

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

### GEL Comment Example

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/comments.html

Demonstrates the usage 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


```

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

### GEL Function Call with Real Value

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/param.html

Example of calling the Initialize GEL function with a real (floating-point) value for the 'value' parameter.

```gel
Initialize(targetSymbol, "c:\\workspace\\myProject\\Debug\\myProject.dat", 1.2);
```

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

### Enable Objcopy Tool

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-full-api-guide.html

Enable the Objcopy tool with its default build-options. Defaults to 'false'.

```bash
-ccs.enableObjcopyTool
```

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

### Run Code with GEL_Run()

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/GEL_Run.html

Use GEL_Run() to start code execution on the target. A condition can be provided to stop execution when the condition is no longer met.

```GEL
GEL_Run();
```

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

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

### Display importProject Help Message

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-importProject-options.html

Run this command to display the help message for the importProject application, 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

```

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

### Simple GEL Function: Squaring a Parameter

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/function.html

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

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

```

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

### com.ti.ccs.apps.createProject

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-full-api-guide.html

This section details the command-line options for creating and configuring projects. These options allow for customization of build steps, file inclusion, path variables, build variables, makefile generation, build directories, build commands, build targets, project templates, and overwrite behavior.

```APIDOC
## com.ti.ccs.apps.createProject

### Description
This command is used to create a new project with various customizable options.

### Options

- **-ccs.setPostBuildStep "<command>" [@configurations [&lt;name&gt; ]+]**
  Command to be used as a post-build step. Optionally, specify build-configurations.

- **-ccs.copyFile "<file>" [@dir "<dir>"] [@configurations [&lt;name&gt; ]+]**
  Copies a file or directory into the project. Optionally specify destination directory and build-configurations.

- **-ccs.linkFile "<file>" [@dir "<dir>" [@virtual]] [@configurations [&lt;name&gt; ]+]**
  Links a file or directory into the project. Optionally specify destination directory, virtual creation, and build-configurations.

- **-ccs.definePathVariable &lt;name&gt; &lt;value&gt; [@scope (global|project)]**
  Defines a path-variable for portable linked file paths. Optionally specify scope.

- **-ccs.defineBuildVariable &lt;name&gt; &lt;value&gt; [@type (string|dir|file)] [@scope (global|project|configuration)] [@configurations [&lt;name&gt; ]+]**
  Defines a build-variable. Optionally specify type, scope, and build-configurations.

- **-ccs.autoGenerateMakefiles (true|false)**
  Turns automatic makefile-generation on or off. Defaults to 'true'.

- **-ccs.buildLocation "<path>"**
  Specifies the build directory. Applies only when '-ccs.autoGenerateMakefiles' is 'false'. Defaults to project root.

- **-ccs.buildCommand "<path>"**
  Specifies an alternative build utility. Defaults to the gmake utility.

- **-ccs.buildCommandFlags "<flags>"**
  Overrides default build-command flags.

- **-ccs.buildTarget &lt;name&gt;**
  Specifies the target to run during an incremental build. Defaults to 'all'.

- **-ccs.cleanTarget &lt;name&gt;**
  Specifies the target to run during a clean build. Defaults to 'clean'.

- **-ccs.template &lt;id&gt;**
  Specifies the project-template ID to use. A list of applicable IDs is printed if unrecognized.

- **-ccs.ignoreDefaultDeviceSettings**
  Ignores default settings specified by the selected device.

- **-ccs.ignoreDefaultCCSSettings**
  Ignores non-essential default settings made by Code Composer Studio.

- **-ccs.overwrite (full | keep)**
  Forces overwrite of existing file-system resources. 'full' deletes and recreates the project folder; 'keep' preserves existing contents.

- **-ccs.autoBuild**
  Performs an incremental build on the imported/created project.

- **-ccs.kind &lt;id&gt;**
  The project kind ID. [Deprecated] - use -ccs.outputType

- **-ccs.listBuildOptionIDs**
  Prints a list of all applicable build-option IDs. [Deprecated] - use -ccs.listBuildOptions

- **-ccs.setBuildOption &lt;id&gt; "&lt;value&gt;" [@prepend] [@configurations &lt;name1&gt;[ &lt;name2&gt;]*]**
  Sets a build-option on the created project. Optionally prepend and specify build-configurations. [Deprecated] - use -ccs.setCompilerOptions/-ccs.setLinkerOptions

- **-ccs.args &lt;file&gt;**
  Specifies a file containing arguments for the create project command.
```

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

### Create CCS Project with DSP/BIOSv5.x Support

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-full-api-guide.html

Use this command to create a CCS project with support for DSP/BIOSv5.x, specifying the tools version.

```bash
ccs_project create -bios.version 5.41.00.06
```

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

### Get Debugger Settings Information

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_debug-scripting.html

The `getDetailedSettings()` API returns an array of objects, each describing a configurable debugger setting. This is useful for understanding available options.

```javascript
getDetailedSettings(): DebugSetting[]
```

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

### Show Basic Device Details Option

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-full-api-guide.html

Outputs basic details for each device when used with '-ccs.devices'.

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

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

### Recursive GEL Function Example

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/recursion.html

Demonstrates a recursive GEL function that prints output and calls itself with an incremented value 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);
}

```

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

### GEL OnPreFileLoaded() Callback Example

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/gel/OnPreFileLoaded.html

This snippet shows how to define the OnPreFileLoaded() callback function in a GEL file. It is called before a program is loaded and can be used to output a message.

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

```

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

### Enable SysConfig Tool

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-full-api-guide.html

Enable the SysConfig tool with its default build-options. Defaults to 'false'.

```bash
-ccs.enableSysConfigTool
```

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

### Set a Debugger Property

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_debug-scripting.html

Use the `set(settingId, value)` API to modify debugger properties. This example disables the auto-run feature on program load or restart.

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

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

### Inspect Products Option

Source: https://downloads.ti.com/ccs/esd/documents/users_guide_ccs_20.2.0/ccs_project-command-line-full-api-guide.html

Use this option to inspect discovered third-party products and tools.

```bash
-ccs.products
```
Tokens:
Raw