SEGGER Knowledge Base

https://kb.segger.com/
Admin
SEGGER Knowledge Base is a comprehensive repository of technical documentation and resources for...
Tokens:4,312,208
Snippets:27,134
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Example project setup with folders and files

Source: https://kb.segger.com/Embedded_Studio_project_file_format

A complete example showing how folders and files are nested within a project solution.

```xml
<!DOCTYPE CrossStudio_Project_File>
<solution Name="Solution Name" target="8" version="2">
  <project Name="Project Name">
    <folder Name="Src" filter="*.c;*.cpp;*.h;*.s" path="Src" recurse="Yes"/>
    <folder Name="Doc>
      <file file_name="README.txt"/>
      <file file_name="Doc/index.html"/>
    </folder>
  </project>
</solution>
```

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

### AUTO command example

Source: https://kb.segger.com/Flasher_Hub_%28Legacy%29

Example of starting production programming for modules 1 and 2.

```text
#AUTO 1,2
#ACK
#RESULT:1:OK (Total 13.993s, Erase 0.483s, Prog 9.183s, Verify 2.514s)
#RESULT:2:OK (Total 13.995s, Erase 0.483s, Prog 9.189s, Verify 2.510s)
#DONE
```

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

### Execute #START command in Console

Source: https://kb.segger.com/Flasher/How_to_use_WireCheck

Example output after running the #START command in the Flasher Console tab to verify device communication.

```text
< #START
> #ACK
> #STATUS:INITIALIZING
> #STATUS:CONNECTING
> #INFO:20230921 MEGA_ISP.PEX
> #INFO:Verbosity: info
> #INFO:Device Identification OK:
> #INFO:Manufacturer read:      0000001E
> #INFO:MemSizeID read:         00000097
> #INFO:Part Number read:       00000006 
> #INFO:Fuse Byte Low:          000000E2
> #INFO:Fuse Byte High:         00000099
> #INFO:Fuse Bits Extended:     000000FF
> #INFO:Read Calib  Byte:       00000000
> #INFO:Calibration Byte:       0000008B
> #INFO:EEPROM destination Addr:00000000
> #INFO:High speed programming possible
> #INFO:*********************************
> #INFO:--- No config words written   ---
> #INFO:--- No lock bits written      ---
> #INFO:--- Keep application in reset ---
> #OK (Total 0.177s)
```

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

### J-Run Example Output

Source: https://kb.segger.com/api.php?action=feedcontributions&feedformat=atom&user=Daniel

Example command line output for J-Run showing the execution of a demo ELF file with the --wait option.

```text
C:> jrun --wait JRun_Demo.elf
J-Run compiled Aug 15 2019 12:09:19
(c) 2018-2019 SEGGER Microcontroller GmbH www.segger.com

Open application...OK
Set target device to STM32F407IE...OK
Select SWD interface...OK
Set interface speed to 4000 kHz...OK
Reset target...OK
Download 08000000-08002E19...OK
SEGGER_SEMIHOST_DebugHalt found at 0x08000734
Start target application...OK
Reading output from target until exit command.
==============================================

SEGGER J-Run demo.

Took 2582433 cycles

J-Run finished. Press any key to exit.
C:>
```

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

### SetupTarget()

Source: https://kb.segger.com/api.php?action=feedcontributions&feedformat=atom&user=Daniel

Called after the general debug connect sequence to perform high-level CPU setup like memory writes or PLL initialization.

```APIDOC
## int SetupTarget(void)

### Description
Extends DLL functionality by allowing high-level CPU debug setup after the connection sequence. May use MEM_ API functions.

### Prototype
int SetupTarget(void);

### Return Values
- >= 0: O.K.
- < 0: Error
```

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

### J-Link Script File JTAG Initialization

Source: https://kb.segger.com/api.php?action=feedcontributions&feedformat=atom&user=Daniel

Example of a JTAG initialization script for a chain with two devices, including manual CoreSight base address configuration.

```c
void InitTarget(void) {
JLINK_SYS_Report("J-Link script example.");
JTAG_Reset(); // Perform TAP reset and J-Link JTAG auto-detection
if (JTAG_TotalIRLen != 9) { // Basic check if JTAG chain information matches
MessageBox("Can not find xxx device");
return 1;
}
JTAG_DRPre = 0; // Cortex-A8 is closest to TDO, no no pre devices
JTAG_DRPost = 1; // 1 device (custom device) comes after the Cortex-A8
JTAG_IRPre = 0; // Cortex-A8 is closest to TDO, no no pre IR bits
JTAG_IRPost = 5; // Custom device after Cortex-A8 has 5 bits IR len
JTAG_IRLen = 4; // We selected the Cortex-A8, it has 4 bits IRLen
CPU = CORTEX_A8; // We are connected to a Cortex-A8
JTAG_AllowTAPReset = 1; // We are allowed to enter JTAG TAP reset
//
// We have a non-CoreSight compliant Cortex-A8 here
// which does not allow auto-detection of the Core debug components base address.
// so set it manually to overwrite the DLL auto-detection
//
CORESIGHT_CoreBaseAddr = 0x80030000;
}
```

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

### XML Database Tag Example

Source: https://kb.segger.com/api.php?action=feedcontributions&feedformat=atom&user=Arne.kulinna

Example of the top-level Database tag containing a Device definition with ChipInfo and FlashBankInfo.

```xml
<Database>
<Device>
<ChipInfo Vendor="SEGGER" Name="SEGGER_DemoDevice1" WorkRAMAddr="0x20001000" WorkRAMSize="0x10000" Core="JLINK_CORE_CORTEX_M33" />
<!-- 1 MB internal flash with 2 loaders -->
<FlashBankInfo Name="Internal Flash Bank" BaseAddr="0x08000000" AlwaysPresent="1">
<LoaderInfo Name="PrimaryLoader" MaxSize="0x100000" Loader="Flashloader_DemoDevice1_Primary.elf" LoaderType="FLASH_ALGO_TYPE_OPEN" />
<LoaderInfo Name="BackupLoader" MaxSize="0x100000" Loader="Flashloader_DemoDevice1_Backup.elf" LoaderType="FLASH_ALGO_TYPE_OPEN" />
</FlashBankInfo>
</Device>
</Database>
```

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

### #AUTO

Source: https://kb.segger.com/api.php?action=feedcontributions&feedformat=atom&user=Arne.kulinna

The #AUTO command triggers the automated programming sequence, behaving identically to the physical start button or external remote control input.

```APIDOC
## #AUTO

### Description
Triggers the automated flash programming sequence (Erase, Program, Verify) as configured in the J-Flash Production tab.

### Response
- **#OK** - Success
- **#ERRxxx** - Error occurred during operation
```

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

### FlashBankInfo and LoaderInfo XML Configuration

Source: https://kb.segger.com/api.php?action=feedcontributions&feedformat=atom&user=Arne.kulinna

Example XML configuration defining flash bank base addresses and multiple loader configurations for external QSPI flash.

```xml
<FlashBankInfo Name="Internal code flash" BaseAddr="0x60000000" AlwaysPresent="1" >
 <LoaderInfo Name="CLK@PIO0_D0@PIO1_D1@PIO2_D2@PIO3_D3@PIO4_CS@PIO5" MaxSize="0x1000000" Loader="Flashloader_Device0_ExternalQSPIFlash_PinConfig0.elf" LoaderType="FLASH_ALGO_TYPE_OPEN" />
 <LoaderInfo Name="CLK@PIO20_D0@PIO21_D1@PIO22_D2@PIO23_D3@PIO24_CS@PIO25" MaxSize="0x1000000" Loader="Flashloader_Device0_ExternalQSPIFlash_PinConfig1.elf" LoaderType="FLASH_ALGO_TYPE_OPEN" />
 <LoaderInfo Name="CLK@PIO30_D0@PIO31_D1@PIO32_D2@PIO33_D3@PIO34_CS@PIO35" MaxSize="0x1000000" Loader="Flashloader_Device0_ExternalQSPIFlash_PinConfig2.elf" LoaderType="FLASH_ALGO_TYPE_OPEN" />
</FlashBankInfo>
</Device>
</Database>
</source>
```

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

### AUTO PATCH command example

Source: https://kb.segger.com/Flasher_Hub_%28Legacy%29

Example of starting production programming with a patch applied to module 1.

```text
#AUTO PATCH 1 1,08000000,4:DEADBEEF
#ACK
#RESULT:1:OK (Total 10.476s, Erase 8.293s, Prog 1.832s, Verify 0.137s)
#DONE
```

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

### #RESTART Example

Source: https://kb.segger.com/Flasher_Hub_-_Remote_control

Example sequence for restarting the firmware.

```text
#RESTART
#ACK
#OK:Restarting Flasher Hub-4 now...
```

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

### AUTO NOPATCH command example

Source: https://kb.segger.com/Flasher_Hub_%28Legacy%29

Example of starting production programming without patches for modules 1 and 2.

```text
#AUTO NOPATCH 1,2
#ACK
#RESULT:1:OK (Total 13.993s, Erase 0.483s, Prog 9.183s, Verify 2.514s)
#RESULT:2:OK (Total 13.995s, Erase 0.483s, Prog 9.189s, Verify 2.510s)
#DONE
```

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

### Base application structure

Source: https://kb.segger.com/Adding_user_data_to_windows

Initial setup including the parent window callback, child window callback, and the MainTask to initialize the GUI.

```c
#include "DIALOG.h"
#include <stdio.h>

/*********************************************************************
*
*       Static code
*
**********************************************************************
*/
/*********************************************************************
*
*       _cbChild
*/
static void _cbChild(WM_MESSAGE * pMsg) {
  char acBuffer[64];
  
  switch(pMsg->MsgId) {
  case WM_PAINT:
    GUI_SetBkColor(GUI_RED);
    GUI_Clear();
    break;
  default:
    WM_DefaultProc(pMsg);
  }
}

/*********************************************************************
*
*       _cbParent
*/
static void _cbParent(WM_MESSAGE * pMsg) {
  static int       Counter;
  static WM_HWIN   hChild;
  WM_HWIN          hItem;
  int              Id, NCode;
  char             acBuffer[64];

  switch(pMsg->MsgId) {
  case WM_CREATE:
    hItem = BUTTON_CreateEx(10, 30, 100, 20, pMsg->hWin, WM_CF_SHOW, 0, GUI_ID_BUTTON0);
    BUTTON_SetText(hItem, "Increase Counter");
    //
    // Create child window with the size of an int pointer as extra bytes.
    //
    hChild = WM_CreateWindowAsChild(10, 70, 150, 100, pMsg->hWin, WM_CF_SHOW, _cbChild, 0);
    break;
  case WM_PAINT:
    GUI_SetBkColor(GUI_WHITE);
    GUI_Clear();
    //
    // Display counter.
    //
    GUI_SetColor(GUI_BLACK);
    GUI_SetFont(&GUI_Font16B_1);
    sprintf(acBuffer, "Counter: %d", Counter);
    GUI_DispStringAt(acBuffer, 10, 10);
    break;
  case WM_NOTIFY_PARENT:
    Id    = WM_GetId(pMsg->hWinSrc);
    NCode = pMsg->Data.v;
    switch(Id) {
    case GUI_ID_BUTTON0:
      switch(NCode) {
      case WM_NOTIFICATION_RELEASED:
        //
        // Increase counter when button is pressed and redraw window.
        //
        Counter++;
        WM_InvalidateWindow(pMsg->hWin);
        //
        // Also redraw the child window.
        //
        WM_InvalidateWindow(hChild);
        break;
      }
      break;
    }
    break;
  default:
    WM_DefaultProc(pMsg);
  }
}

/*********************************************************************
*
*       Public code
*
**********************************************************************
*/
/*********************************************************************
*
*       MainTask
*/
void MainTask(void) {
  GUI_Init();
  //
  // Create parent window.
  //
  WM_CreateWindow(0, 0, LCD_GetXSize(), LCD_GetYSize(), WM_CF_SHOW, _cbParent, 0);

  while(1) {
    GUI_Delay(100);
  }
}
```

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

### Starting J-Flash minimized

Source: https://kb.segger.com/CRC_calculation

Example command to launch J-Flash in a minimized state using the Windows start command.

```batch
start /min /wait "J-Flash" "JFlash.exe" -openprjC:\Projects\Default.jflash -
openC:\Data\data.bin,0x100000 -auto -exit
```

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

### MainTask entry point

Source: https://kb.segger.com/WM_Late_Clipping_%28Sample%29

Initializes the GUI and runs the demo loop.

```c
/*********************************************************************
*
*       Public code
*
**********************************************************************
*/
/*********************************************************************
*
*       MainTask
*/
void MainTask(void) {
  //
  // Init GUI
  //
  GUI_Init();

  while(1) {
    _ShowDemo();
  }
}
```

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

### Erase the secure installer command and output

Source: https://kb.segger.com/NXP_MCX_A_SiErase

Example command to erase the secure installer and the corresponding output from the SEGGER Device Provisioner.

```text
C:\Program Files\SEGGER\JLink\DevPro.Exe -operation EraseSI -if SWD -speed 4000 -ScriptFile PCode_DevPro_NXP_MCXA.pex
SEGGER Device Provisioner V9.28
Compiled Mar 18 2026 14:17:48
Command line: -operation EraseSI -if SWD -speed 1000 -ScriptFile PCode_DevPro_NXP_MCXA.pex
Firmware: J-Link Pro V5-1 compiled Apr 27 2026 10:28:36
S/N: 175103947

J-Link log:   DAP initialized successfully.
J-Link log:   DMAP_REG_ID: DM-AP IDCODE detected: 0x002A0000
J-Link log:   Reset via SYSRESETREQ + halt after bootloader
J-Link log:   Halting at application.
J-Link log:   Erase prepared, resetting device.
J-Link log:   Reset via SYSRESETREQ + halt after bootloader
J-Link log:   Halting at application.
J-Link log:   Secure Installer region is available.
J-Link log:   Attention: Keep the erase token at offset 0xD0 to 0xDF in CMPA flash bank forever present!
```
Tokens:
Raw