Difference between revisions of "Adding Support for New Devices"
(→Frequently Problems) |
(Redirected page to Open Flashloader#Create a Flash Loader) |
||
| (29 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
| + | #REDIRECT [[Open_Flashloader#Create_a_Flash_Loader]] |
||
| − | __TOC__ |
||
| − | 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...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 '''Open Flashloader''' chapter in the J-Link User Manual (UM08001). In general, there are two possibilities to add support for a new device: |
||
| − | #'''Use a pre-compiled flash loader''' |
||
| − | #'''Compile / create the flash loader on your own''' |
||
| − | ##Using Keil uVision (a license is required, no trial available; Supports Cortex-M, only) |
||
| − | ##SEGGER Embedded Studio (can be evaluated without license; Supports Cortex-M and Cortex-A/R)<br>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. |
||
| − | = Creating a flash algorithm using SEGGER Embedded Studio = |
||
| − | This article describes how to create a flash loader using the template projects (Cortex-M and Cortex-A/R) for SEGGER Embedded Studio. |
||
| − | == Debug Configurations == |
||
| − | The example project contains two debug configurations: |
||
| − | *Debug |
||
| − | *Release |
||
| − | === Debug configuration === |
||
| − | This configuration 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. The optimization level for this configuration is set to "none". |
||
| − | === Release configuration === |
||
| − | This configuration does not allow debugging but creates the output elf file which can be referenced from within the JLinkDevices.xml file as "''Loader''". The optimization level is set to 3 (highest). |
||
| − | == Included files == |
||
| − | {| class="wikitable" |
||
| − | |- |
||
| − | ! Filename !! Content |
||
| − | |- |
||
| − | | '''FlashDev.c''' || Flash device description for the ST STM32F205RC |
||
| − | |- |
||
| − | | '''FlashOS.h''' || Function prototypes, definitions and structures |
||
| − | |- |
||
| − | | '''FlashPrg.c''' || Flash algorithm itself (e.g. ProgramPage(), EraseSector() |
||
| − | |- |
||
| − | | '''main.c''' || Flash algorithm debug code (used by debug configuration, only) |
||
| − | |- |
||
| − | | '''Cortex_M_Startup.s'''<br>'''ARM_Startup.s''' || Cortex-M startup code (used by debug configuration, only) <br> Cortex-A/R startup code (used by debug configuration, only) |
||
| − | |- |
||
| − | | '''MemoryMap.xml''' || Memory map of the ST STM32F205RC |
||
| − | |- |
||
| − | | '''Placement_debug.xml''' || Debug configuration section placement file. |
||
| − | |- |
||
| − | | '''Placement_release.xml''' || Release configuration section placement file. |
||
| − | |- |
||
| − | | '''thumb_crt0.s'''<br>'''crt0.s''' || Initialization file for Cortex-M (used by debug configuration, only)<br>Initialization file for Cortex-A/R(used by debug configuration, only) |
||
| − | |} |
||
| − | == Embedded Studio Template Projects == |
||
| − | The template projects below have been tested with SEGGER Embedded Studio V3.10. |
||
| − | *[[File:OpenFlashLoader_CortexM_Template_EmbeddedStudio.zip]] |
||
| − | *[[File:OpenFlashLoader_CortexAR_Template_EmbeddedStudio.zip]] |
||
| − | |||
| − | == Step-By-Step Instruction == |
||
| − | This step-by-step instruction explains how to create your own flash loader using the template projects for Embedded Studio and how to use add a new flash bank for an existing or new device to the J-Link DLL, so that it can be used from within any application using the DLL. |
||
| − | #Adapt the template project |
||
| − | ##'''FlashDev.c''': Modify the FlashDevice structure according to your device |
||
| − | ##'''FlashPrg.c''': Implement the flash routines Init(), UnInit(), EraseSector() and ProgramPage() |
||
| − | ##'''MemoryMap.xml''': Enter RAM base address and RAM size |
||
| − | ##'''main.c''': Make sure that the define ''_FLASH_BASE_ADDR'' defines the correct flash base address |
||
| − | #Test the debug configuration |
||
| − | ##Connect the target to the J-Link and the J-Link to the PC |
||
| − | ##Switch to the '''Debug''' configuration in Embedded Studio ('''Build''' -> '''Set Active Build Configuration''' -> '''Debug''') |
||
| − | ##Build the project by pressing '''F7''' |
||
| − | ##Start the debug session by pressing '''F5''' |
||
| − | ##PC should be halted at main. Now debug the flash algorithm and make sure that it behaves as expected. |
||
| − | #Build the flash loader using the release configuration |
||
| − | ##Switch to the '''Release''' configuration in Embedded Studio ('''Build''' -> '''Set Active Build Configuration''' -> '''Release''') |
||
| − | ##Build the project by pressing '''F7''' --> The flash loader file can be found here: $PROJ_DIR$\Output\Release\Exe\*.elf |
||
| − | #JLinkDevices.xml |
||
| − | ##Create or adapt the '''JLinkDevices.xml''' (described in the J-Link User Manual (UM08001)). |
||
| − | ##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 / ...). |
||
| − | == Frequently Asked Questions == |
||
| − | In which order does the J-Link DLL call the function during flash programming? |
||
| − | #Compare |
||
| − | ##Init() |
||
| − | ##Compare()<br>Memory is accessed so it has to be initialized during Init() so that it can be memory mapped accessed here. If it is not initialized correctly, the read access may results in confusing the MCU. |
||
| − | ##UnInit() |
||
| − | # Erase |
||
| − | ## Init() |
||
| − | ## Erase() |
||
| − | ## UnInit() |
||
| − | # Program |
||
| − | ## Init() |
||
| − | ## Program() |
||
| − | ## UnInit() |
||
| − | == 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. |
||
| − | #Get the latest version of the template project |
||
| − | #Follow the Step-By-Step instructions expect of 2.1 FlashPrg.c --> Functions should not contain any code that accesses any SFRs |
||
| − | #Build the flash loader using the release configuration |
||
| − | #Perform a flash download using J-Link Commander. Flash download should report an error during verify |
||
| − | #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(). |
||
| − | #Implement ProgramPage() and retry the flash download test. Expected result: Test reports O.K. --> Programmed successfully. If not, check ProgramPage() code. |
||
| − | |||
| − | = Using a Precompiled Flashloader = |
||
| − | <ul> |
||
| − | <ol> |
||
| − | <li>Make sure that J-Link software V6.16f or later is installed:<br>https://www.segger.com/downloads/jlink/</li> |
||
| − | <li>Browse to the installation of the J-Link software package.<br>You should now see JFlash.exe, JLinkDevices.xml, ...</li> |
||
| − | <li>Open JLinkDevices.xml in a text editor and add the device entry at the beginning, right after the <Database> opening tag.<br>Example:</li> |
||
| − | <!-- This entry will overwrite the existing device entry in the J-Link software, so that a custom flash algorithm is used for the internal flash --> |
||
| − | <ChipInfo Vendor="ST" Name="STM32F767ZI" Core="JLINK_CORE_CORTEX_M7" /> |
||
| − | <FlashBankInfo Name="Internes Flash" BaseAddr="0x08000000" MaxSize="0x00200000 " Loader="ST_STM32F7xxxx_2MB_DualBank.elf" LoaderType="FLASH_ALGO_TYPE_OPEN" /> |
||
| − | </Device> |
||
| − | <li>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).</li> |
||
| − | <li>Start JFlash.exe (or any other application which supports J-Link) and select the device</li> |
||
| − | </ol> |
||
| − | </ul> |
||
| − | |||
| − | = Information for Silicon Vendors = |
||
| − | SEGGER offers the opportunity to hand in custom created flash algorithms which will then be included in the official J-Link Software and Documentation Package hence distributed to any J-Link customer who is using the latest software package. |
||
| − | The following files need to be provided to SEGGER: |
||
| − | *JLinkDevices.xml - including the device entry / entries |
||
| − | *Flash loader file - referenced in the JLinkDevices.xml (source code is optional) |
||
| − | *Readme.txt which may includes additional information or at least a contact e-mail address which can be used by customers in case support is needed. |
||
| − | Apart from this, an evaluation board needs to provided to SEGGER which can be used to verify the functionality of the provided files. |
||
Latest revision as of 15:30, 4 April 2019
Redirect to:
