• 1Open Flashloader
  • 1.6JLinkDevices.xml Tags and Attributes
• 2Create a Flash Loader
  • 2.11Frequently Problems
• 3Algorithm Functions
• 4Function Overview
• 5FlashDevice struct

• Flash Preloader
• Flash Loader Tutorial
• Flash Preloader Tutorial
• Flash Loader Download

1. Unit: Samsung e2222. Problem: Blinking and restart. Guides: Install the driver located inside flash loader 7.4.7ssgv0.1lite. Download the file attach below. After flash phone got lock code. Here is the lock code. sim lock: 09093233. phone lock: 02091233.
2. Download flash loader 7.4.7 ssg shared files: C3512t flash loader 7 4 7 ssg v0 0 lite included punch wifi rar from 4shared.com (4 MB).
3. Gt E2220 Flash Loader 7 4 7 Ssg V0 1 Lite.zip - fancli.com/16hrqb.

Path: Product Name: Vendor: Version: Size: MD5: 1: I: FIRMWARE SAMSUNG C3322 Flash loader 7.4.7SSGv0.1Lite Flash loader 7.4.7SSGv0.1Lite.exe: bfloaderapp.

Introduction

As the number of devices being available is steadily growing and sometimes in an early stage of the MCU development only a few samples/boards are available that may not be provided to third parties (e.g. SEGGER) to add support for a new device. Also the existence of the device may have confidential status, so it might not be mentioned as being supported in public releases yet. Therefore it might be desirable to be able to add support for new devices on your own, without depending on SEGGER and a new release of the J-Link Software an Documentation Pack being available.

The J-Link DLL allows customers to add support for new devices on their own. It is also possible to edit / extend existing device support by for example adding new flash banks (e.g. to add support for internal EEPROM programming or SPIFI programming). This article explains how new devices can be added to the DLL and how existing ones can be edited / extended.

General Procedure

By default, the J-Link DLL comes with a build-in device database that defines which device names are known and therefore officially supported by the J-Link DLL and software that uses the J-Link DLL. This list can also be viewed on our website: https://www.segger.com/downloads/supported-devices.php

Additionally, the build-in device database can be extended by specifying devices in an XML file, named JLinkDevices.xml. It is also possible to edit / extend an device from the built-in device database via this XML file. There are different places where the JLinkDevices.xml can be referenced from (see list below). In case of several JLinkDevices.xml files are used, supplement each other as in the order specified below:

1. In the same directory as the J-Link DLL (JLinkARM.dll)
2. In the same directory as the J-Link settings file. The location of the settings file depends on the IDE / software being used.
3. In the directory specified using the J-Link Command String JLinkDevicesXMLPath = <Path>

Extending an Existing Device

In order to edit/extend a device that is already in the built-in device database of the J-Link DLL, the following needs to be added to the JLinkDevices.xml:

The attribute Name of the tag <ChipInfo> must specify exactly the same name as the device in the built-in device database specifies. In case the value of the attribute BaseAddr specifies an address of an existing flash bank for the existing device, in the built-in device database, the flash bank from the built-in database is replaced by the one from the XML file.

When adding new flash banks or if the device in the built-in database does not specify any flash banks so far, the same attribute requirements as for adding a new device, apply. For more information, please refer to Adding a new device.

In order to add more than one flash bank, just repeat the <FlashBankInfo … /> tag structure from above, inside the same <Device> tag. For more information about the tags and their attributes, please refer to XML Tags and Attributes.

Adding a New Device

In order to add support for a new device to the J-Link DLL, the following needs to be addedto the JLinkDevices.xml :

When adding a new device, the following attributes for the <ChipInfo> tag are mandatory:

• Vendor
• Name
• Core

In case a <FlashBankInfo> tag is also added, the following attributes in addition to the ones mentioned before, become mandatory:ChipInfo-Tag

• WorkRAMAddr
• WorkRAMSize
• FlashBankInfo

FlashBankInfo-Tag

• Name
• BaseAddr
• MaxSize
• Loader
• LoaderType
• AlwaysPresent

For more information about the tags and their attributes, please refer to XML Tags andAttributes .In order to add more than one device to the device database, just repeat the <Device> …</Device> tag structure from above for each device.

Adding a New Flash Bank

In general, there are two possibilities to add a new flash bank for a new or existing device:

1. Use a pre-compiled flash loader
2. Compile / create the flash loader on your own
   1. Using Keil uVision (a license is required, no trial available; Supports Cortex-M, only)
   2. SEGGER Embedded Studio (can be evaluated without license; Supports Cortex-M, Cortex-A/R and RISC-V)
      How to create a flash loader on your own using Embedded Studio is described below.

Note: The Open Flashloader concept replaces the previous RAMCode SDK.

JLinkDevices.xml Tags and Attributes

XML Tags and AttributesIn the following, the valid XML tags and their possible attributes are explained.General rules• Attributes may only occur inside an opening tag• Attribute values must be enclosed by quotation marksTag Description

<Database>

Opens the XML file top-level tag. Only present once per XML file.Valid attributesThis tag has no attributesNotes

• Must only occur once per XML file
• Must be closed via </Database>

<Device>

Opens the description for a new device.Valid attributesThis tag has no attributesNotes

• Must be closed via </Device> .
• May occur multiple times in an XML file

<ChipInfo>

Specifies basic information about the device to be added, like the core it incorporates etc.Valid attributes

Notes

• No separate closing tag.

Directly closed after attributes have been specified: <ChipInfo … />

• Must not occur outside a <Device> tag.

Attribute values - Core

For a list of all available values for the Core attribute, please expand the following list:

<FlashBankInfo>

Specifies a flash bank for the device. This allows to use the J-Link flash download functionality with IDEs, debuggers and other software that uses the J-Link DLL (e.g. J-Link Commander) for this device. The flash bank can then be programmed via the normal flash download functionality of the J-Link DLL. For more information about flash download, please refer to Flash download . For possible limitations etc. regarding newly added flash banks, please refer to Add. Info / Considerations / Limitations .Valid attributes

Notes

• No separate closing tag. Directly closed after attributes have been specified:

<FlashBankInfo … />

• Must not occur outside a <Device> tag

Attribute values - LoaderType

The following values are valid for the LoaderType attribute:

• FLASH_ALGO_TYPE_OPEN

Describes that the used algorithm is an Open Flashloader algorithm. CMSIS basedalgorithms are also supported via the Open Flashloader concept. For additionalinformation, see Add. Info / Considerations / Limitations .

Example JLinkDevices.xml file

Add. Information / Considerations / Limitations

This article describes how to add support for new devices / flash banks to the J-Link DLL so that they can be used with any J-Link DLL based application like for example J-Flash, J-Link Commander, IDEs, etc...The description is based on the template projects (Cortex-M, Cortex-A/R, ARM7/9 and RISC-V) for SEGGER Embedded Studio. This article assumes that there is already a basic understanding of the method of adding new devices using the Open Flashloader concept. If this is not the case, we recommend to read the article above. In general, there are two possibilities to add support for a new device:

1. Use a pre-compiled flash loader
2. Compile / create the flash loader on your own
   1. Using Keil uVision (a license is required, no trial available; Supports Cortex-M, only)
   2. SEGGER Embedded Studio (can be evaluated without license; Supports Cortex-M, Cortex-A/R and RISC-V)
      How to create a flash loader on your own using Embedded Studio is described below.

Supported cores:

• Cortex-M
• Cortex-A/R
• ARM7/9
• RISC-V

Note: The Open Flashloader concept replaces the previous RAMCode SDK.

Build Configurations

The example project contains two build configurations:

• Debug: Allows to debug the flash algorithm in Embedded Studio. The configuration includes a main.c containing the typical function call order, executed by the J-Link DLL during flash programming.
• Release: Creates elf file which can be referenced from within the JLinkDevices.xml file as 'Loader'.

Included files

ARM Cortex-A and Cortex-R template projects

The template projects below have been tested with SEGGER Embedded Studio for ARM V5.34.

ARM Cortex-M template projects

The template projects below have been tested with SEGGER Embedded Studio for ARM V5.34.

ARM7/9 template projects

The template projects below have been tested with SEGGER Embedded Studio for ARM V5.34.

RISC-V template projects

The template projects below have been tested with SEGGER Embedded Studio for RISC-V V5.34.

Note: The template project is configured for 'Enable Linker Relaxation = no'. Linker relaxation is not supported for open flash loaders.

Reference algorithms

Step-By-Step Instruction

This step-by-step instruction explains how to create your own flash loader using the template projects for Embedded Studio.

1. Adapt the template project
   1. FlashDev.c: Modify the FlashDevice structure according to your device
   2. FlashPrg.c: Implement the flash routines Init(), UnInit(), EraseSector() and ProgramPage()
   3. MemoryMap.xml: Enter RAM base address and RAM size
   4. Placement_debug.xml: Enter RAM address in the program section element.
   5. main.c: Make sure that the define _FLASH_BASE_ADDR defines the correct flash base address
2. Test the debug configuration
   1. Connect the target to the J-Link and the J-Link to the PC
   2. Switch to the Debug configuration in Embedded Studio (Build -> Set Active Build Configuration -> Debug)
   3. Build the project by pressing F7
   4. Start the debug session by pressing F5
   5. PC should be halted at main. Now debug the flash algorithm and make sure that it behaves as expected.
3. Build the flash loader using the release configuration
   1. Switch to the Release configuration in Embedded Studio (Build -> Set Active Build Configuration -> Release)
   2. Build the project by pressing F7 --> The flash loader file can be found here: $PROJ_DIR$OutputReleaseExe*.elf
4. JLinkDevices.xml
   1. Create or adapt the JLinkDevices.xml (described in the J-Link User Manual (UM08001)).
   2. Place the JLinkDevices.xml file at the correct location (described in the J-Link User Manual (UM08001)).

Now you can select and use the created or adapted device which uses the new flash bank in any J-Link DLL based application (e.g. J-Link Commander / IDE / ...).

FAQ

TBD

Flash Preloader

Troubleshoot

This section provides assistance in case of issues pops up when using custom added flash bank. The section assumes that the functionality has been verified using the debug configuration in Embedded Studio.

1. Get the latest version of the template project
2. Follow the Step-By-Step instructions except of 1.2 FlashPrg.c --> Functions should not contain any code that accesses any SFRs
3. Build the flash loader using the release configuration
4. Perform a flash download using J-Link Commander. Flash download should report an error during verify
5. Implement EraseSector() and retry the flash download test. J-Link Commander should still report verify failed but effected flash memory region should be empty. If not, check EraseSector().
6. Implement ProgramPage() and retry the flash download test. Expected result: Test reports O.K. --> Programmed successfully. If not, check ProgramPage() code.

Frequently Problems

PC has unexpected value after flash download

This error may have different root causes:

• Watchdog is enabled but not fed in the flash loader functions. This may result in a watchdog timeout pops up during RAMCode execution. The behavior is different but usually a reset will be triggered.
• Accessing not enabled / clocked special function registers / peripherals
• Accessing invalid memory regions (reserved)

(Q)SPI flashes

• The Init() code has to make sure that the (Q)SPI pins as well as the (Q)SPI controller are configured so that the flash can be memory mapped (read) accessed. This is necessary as the J-Link DLL reads the data before programming to check if flash content does already match. This can be validated by setting the compare method in J-Link Commander to 'skip' (exec SetCompareMode 0). Now start flash download. J-Link Commander should report a verify error but the flash should be memmory mapped accessible from now. If not, check the Init() code.

I get build errors in Release build config

If you get build errors when switching from Debug to Release build in the template project the main cause is that third party libraries are used. The Open Flashloader interface expects all program parts to be linked to sections PrgCode and PrgData. Third party libraries often use statically linked program parts which will not be put in the aforementioned sections which will cause a build or linker error. Generally we recommend not using any third party libraries when creating Flash loaders as they will increase the Flash loader size drastically while usually slowing down the maximum possible Flash loader speed. If you happen to have to use an external library in your project it is user responsibility to make sure this external library is linked to the aforementioned sections for all application parts.

Example projects

The projects below are based on the template projects (see links above). They can be used as reference when creating your own flashloader using the Open Flashloader.

The following tables provide an overview of all available functions. The tables are split into mandatory and optional functions.

Following functions are mandatory.Note: The functions EraseSector and ProgramPage have been extended by new functions optimized for speed. Either of these func

Note: In order to stay backward compatible, the DLL accepts both program / erase functions. In this case, the SEGGER_OPEN_XXX variant will be used.In general, users have to make sure that at least one program / erase function is implemented in the flashloader.

Following functions are optional:

Flash Erase Procedure

This procedure is executed to erase the flash before programming it.

Flash Program Procedure

This procedure is executed to program the flash. The DLL makes sure that the effected sectors are erased.

Flash Verify Procedure

This procedure verifies that the programmed data have been programmed successfully.

TBD

Flash Read Procedure

This procedure reads back the flash content. Please note that this sequence is executed in case of SEGGER_OPEN_Read() has been implemented. If this function is not available, the read back is done using memory mapped read accesses to the specified address.

TBD

Init

Prototype

Function description

Handles the initialization of the flash module. This function will be called prior any flash action (read, program, erase, etc...).

Parameters

• Addr: Specifies the base address of the flash.
• Freq: Specifies the CPU clock frequency.
• Func: Specifies the action followed by Init() (e.g.: 1 - Erase, 2 - Program, 3 - Verify / Read)

Return values

• 0: O.K.
• 1: Error

Code Example

UnInit

Prototype

Function description

Handles the de-initialization of the flash module.

Parameters

• Func: Specifies the previous flash action before the call of UniInit() (e.g.: 1 - Erase, 2 - Program, 3 - Verify / Read)

Return values

• 0: O.K.
• 1: Error

Code Example

SEGGER_OPEN_Erase

Prototype

Function description

Erases one or more flash sector(s).

Parameters

• SectorAddr: Address of the start sector to be erased
• SectorIndex: Index of the start sector to be erased
• NumSectors: Number of sectors to be erased

Return values

• 0: O.K.
• 1: Error

Code Example

EraseSector

Prototype

Function description

Erases one flash sector.

Parameters

• Addr: Address of the sector to be erased

Return values

• 0: O.K.
• 1: Error

Code Example

SEGGER_OPEN_Program

Prototype

Flash Loader Tutorial

Function description

Programs one flash page.

Parameters

Flash Preloader Tutorial

• DestAddr: Destination address
• NumBytes: Number of bytes to be programmed (always a multiple of program page size, defined in FlashDev.c)
• pSrcBuff: Point to the source buffer

Return values

• 0: O.K.
• 1: Error

Code Example

ProgramPage

Prototype

Function description

Programs one flash page.

Parameters

• DestAddr: Destination address
• NumBytes: Number of bytes to be programmed (Program page size, defined in FlashDev.c; The J-Link DLL is not allowed to pass multiple pages at once. We recommend to use SEGGER_OPEN_Program() instead.)
• pSrcBuff: Point to the source buffer

Return values

• 0: O.K.
• 1: Error

Code Example

BlankCheck

Prototype

Function description

Checks if a memory region is blank

Flash Loader Download

Parameters

• Addr: Blank check start address
• NumBytes: Number of bytes to be checked
• BlankData: Pointer to the destination data

Return values

• 0: O.K., blank
• 1: O.K., *not* blank
• < 0: Error

Code Example

EraseChip

Prototype

Function description

Erases the entire flash

Return values

• 0: O.K.
• 1: Error

Code Example

Verify

Prototype

Function description

Compares a specified number of bytes of a provided data buffer with the content of the device

Parameters

• Addr: Start address in memory which should be compared
• NumBytes: Number of bytes to be compared
• pBuff: Pointer to the data to be compared

Return values

• (Addr + NumBytes): O.K.
• != (Addr + NumBytes): *not* O.K. (ideally the fail address is returned)

Code Example

SEGGER_OPEN_Read

Prototype

Function description

Reads a specified number of bytes into the provided buffer

Parameters

• Addr: Start read address
• NumBytes: Number of bytes to be read
• pBuff: Pointer to the destination data

Return values

• >= 0: O.K., NumBytes read
• < 0: Error

Code Example

The FlashDevice structure variable contains all the static information about the flash algorithm like sectorization of the flash, programming chunk size, ... In the following, the structure elements are explained in detail to give a good idea about what needs to be filled in for a new flash loader.

AlgoVer

Set to <ALGO_VERSION>. Do not set to anything else!

Name

Name of the flash bank this flash loader handles. (E.g. 'internal flash', 'QSPI', ...). Must not exceed 127 characters (last character reserved for string termination)

Type

Currently ignored. Set to <ONCHIP> to get max. compatibility.

BaseAddr

This element describes the base address of the flash. It is recommended to always use the real address of the flash here, even if the flash is also available at other addresses, depending on the current settings of the device.

TotalSize

This describes the total size of the flash that is achieved when summing up all sector info from <SectorInfo>. If the flash is 512 KiB in size, <TotalSize> must be 0x80000 (524,288 => 512 KiB)

PageSize

This field describes in what chunks J-Link feeds the flash loader. The Program() function will be called with a data chunk of multiple of <PageSize> bytes. For example if the flash requires to be programmed in multiple of 128 bytes, <PageSize> should be set to 128. If the flash can be programmed 4 byte wise, <PageSize> should be set to 4.

Reserved

Set this element to 0

ErasedVal

Most flashes have an erased value of 0xFF (set this element to 0xFF in such cases). However, some flashes have different erased value like for example 0x00 (set element to 0x00 for such cases)

TimeoutProg

Timeout in miliseconds (ms) to program one chunk of <PageSize>

TimeoutErase

Timeout in miliseconds (ms) to erase one sector

SectorInfo

This element is actually a list of different sector sizes present on target flash. The define MAX_NUM_SECTORS does not describe the max. number of sectors the algorithm can handle, it describes how many blocks of sectors of different sizes can be handled. The MAX_NUM_SECTORS define must not be changed! This spec. comes from the original Keil MDK-ARM flash loaders the Open Flashloader is compatible to and is not really well explained.

Example

The algorithm handles a flash with the following sectorization:

Example for STM32F401VC (256 KiB internal flash):

1. Make sure that J-Link software V6.16f or later is installed:
   https://www.segger.com/downloads/jlink/
2. Browse to the installation of the J-Link software package.
   You should now see JFlash.exe, JLinkDevices.xml, ...
3. Open JLinkDevices.xml in a text editor and add the device entry at the beginning, right after the <Database> opening tag.
   Example:
4. Copy the flashloader file, referenced in the JLinkDevices.xml entry, into the same directory where also the JLinkDevices.xml is located (in this example ST_STM32F7xxxx_2MB_DualBank.elf).
5. Start JFlash.exe (or any other application which supports J-Link) and select the device