Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • FALSE (0) : failed

  • FlashPro-ARM - TRUE (1) : succeeded

  • GangPro-ARM - TRUE MASK (0x01..0x3F) : 0x01 - target 1, 0x02 - target 2, 0x04 - target 3, 0x08 - target
    4, 0x10 - target 5, 0x20 - target 6

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F_LastStatus

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with Multi API-DLL Functions | F_OpenInstancesAndFPAs or index out of range

2. F_Close_Target_Device
Anchor
F_Close_Target_Device
F_Close_Target_Device

...

  • FALSE (0) : failed

  • FlashPro-ARM - TRUE (1) : succeeded

  • GangPro-ARM - TRUE MASK (0x01..0x3F) : 0x01 - target 1, 0x02 - target 2, 0x04 - target 3, 0x08 - target
    4, 0x10 - target 5, 0x20 - target 6

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F_LastStatus

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with Multi API-DLL Functions | F_OpenInstancesAndFPAs or index out of range

3. F_Segment_Erase

...

Code Block
languagecpp
INT_X F_Segment_Erase( INT_X address );

Input

INT_X address : address of segment/sector to be erased

...

  • FALSE (0) : failed

  • FlashPro-ARM - TRUE (1) : succeeded

  • GangPro-ARM - TRUE MASK (0x01..0x3F) : 0x01 - target 1, 0x02 - target 2, 0x04 - target 3, 0x08 - target
    4, 0x10 - target 5, 0x20 - target 6

  • STATUS_ADDRESS_OUT_OF_FLASH_SPACE_ERR (534) : address out of range

  • STATUS_ERASE_SEGMENT_FAILED (549) : erase operation failed

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F_LastStatus

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with Multi API-DLL Functions | F_OpenInstancesAndFPAs or index out of range

4. F_Sectors_Blank_Check

...

Code Block
languagecpp
INT_X F_Sectors_Blank_Check( INT_X start_addr, INT_X stop_addr );

Input

INT_X start_addr : first memory address to be included in blank check (inclusive)
INT_X stop_addr : last memory address to be included in blank check (inclusive)

...

  • FALSE (0) : failed

  • FlashPro-ARM - TRUE (1) : succeeded

  • GangPro-ARM - TRUE MASK (0x01..0x3F) : 0x01 - target 1, 0x02 - target 2, 0x04 - target 3, 0x08 - target
    4, 0x10 - target 5, 0x20 - target 6

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F_LastStatus

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with Multi API-DLL Functions | F_OpenInstancesAndFPAs or index out of range

5. F_Copy_Buffer_to_Flash
Anchor
F_Copy_Buffer_to_Flash
F_Copy_Buffer_to_Flash

...

Code Block
languagecpp
INT_X F_Copy_Buffer_to_Flash( INT_X start_addr, INT_X size );

Input

INT_X start_addr : valid flash address
INT_X size : number of bytes to copy beginning at start address

...

  • FALSE (0) : failed

  • FlashPro-ARM - TRUE (1) : succeeded

  • GangPro-ARM - TRUE MASK (0x01..0x3F) : 0x01 - target 1, 0x02 - target 2, 0x04 - target 3, 0x08 - target
    4, 0x10 - target 5, 0x20 - target 6

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F_LastStatus

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with Multi API-DLL Functions | F_OpenInstancesAndFPAs or index out of range

Example

...

Code Block
INT_X F_Copy_Flash_to_Buffer( INT_X start_addr, INT_X size );

Input

INT_X start_addr : valid flash address
INT_X size : number of bytes to copy beginning at start address

...

Example

...

Code Block
languagecpp
INT_X F_Copy_Gang_Buffer_to_Flash( INT_X start_addr, INT_X size );

Input

INT_X start_addr : valid flash address
INT_X size : number of bytes to copy beginning at start address

...

Example

...

Code Block
INT_X F_Copy_Flash_to_Gang_Buffer( INT_X start_addr, INT_X size );

Input

INT_X start_addr : valid flash address
INT_X size : number of bytes to copy beginning at start address

...

Example

...

  • FALSE (0) : failed

  • FlashPro-ARM - TRUE (1) : succeeded

  • GangPro-ARM - TRUE MASK (0x01..0x3F) : 0x01 - target 1, 0x02 - target 2, 0x04 - target 3, 0x08 - target
    4, 0x10 - target 5, 0x20 - target 6

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F_LastStatus

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with Multi API-DLL Functions | F_OpenInstancesAndFPAs or index out of range

10. F_Write_Word16_to_RAM

...

  • FALSE (0) : failed

  • FlashPro-ARM - TRUE (1) : succeeded

  • GangPro-ARM - TRUE MASK (0x01..0x3F) : 0x01 - target 1, 0x02 - target 2, 0x04 - target 3, 0x08 - target
    4, 0x10 - target 5, 0x20 - target 6

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F_LastStatus

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with Multi API-DLL Functions | F_OpenInstancesAndFPAs or index out of range

11. F_Write_Word32_to_RAM

...

  • FALSE (0) : failed

  • FlashPro-ARM - TRUE (1) : succeeded

  • GangPro-ARM - TRUE MASK (0x01..0x3F) : 0x01 - target 1, 0x02 - target 2, 0x04 - target 3, 0x08 - target
    4, 0x10 - target 5, 0x20 - target 6

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F_LastStatus

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with Multi API-DLL Functions | F_OpenInstancesAndFPAs or index out of range

12. F_Write_Bytes_Block_to_RAM

...

  • FALSE (0) : failed

  • FlashPro-ARM - TRUE (1) : succeeded

  • GangPro-ARM - TRUE MASK (0x01..0x3F) : 0x01 - target 1, 0x02 - target 2, 0x04 - target 3, 0x08 - target
    4, 0x10 - target 5, 0x20 - target 6

  • STATUS ADDR ALIGNMENT ERROR (543) : not 32-bit word aligned address

  • STATUS SIZE ALIGNMENT ERROR (544) : number of bytes not a multiple of four

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F_LastStatus

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with Multi API-DLL Functions | F_OpenInstancesAndFPAs or index out of range

...

13. F_Read_Byte

...

General Description

(FlashPro-ARM only)

General Description

Use the FPA to read one byte from any address (RAM, flash, etc.).

Syntax

Code Block
languagecpp
INT_X F_Read_Byte( INT_X addr )

Input

INT_X addr : address of byte to be read

...

Select FPA to perform operation on using Multi API-DLL Functions | F_Set_FPA_index, index 1 to 64. Use index 0 to perform operation on all FPAs (if results differ, use Multi API-DLL Functions | F_LastStatus to get individual results).

Output

INT_X : data read

  • 0-0xFF : byte value

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F

...

...

...

...

14. F_Read_Word16

...

(FlashPro-ARM only)

General Description

Use the FPA to read two bytes from any address (RAM, flash, etc.).

Syntax

Code Block
languagecpp
INT_X F_Read_Word16( INT_X addr )

Input

INT_X addr : address of 16-bit word to be read

...

Select FPA to perform operation on using Multi API-DLL Functions | F_Set_FPA_index, index 1 to 64. Use index 0 to perform operation on all FPAs (if results differ, use Multi API-DLL Functions | F_LastStatus to get individual results).

Output

INT_X : data read

  • 0-0xFFFF : 16-bit word value

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F

...

...

...

...

15. F_Read_Word32 (FlashPro-ARM only)

General Description

Use the FPA to read four bytes from any address (RAM, flash, etc.).

Syntax

Code Block
languagecpp
INT_X F_Read_Word32( INT_X addr )

Input

INT_X addr : address of 32-bit word to be read

...

Select FPA to perform operation on using Multi API-DLL Functions | F_Set_FPA_index, index 1 to 64. Use index 0 to perform operation on all FPAs (if results differ, use Multi API-DLL Functions | F_LastStatus to get individual results).

Output

INT_X : data read

  • 0-0xFFFFFFFF : 32-bit word value

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F

...

...

...

...

16. F_Read_Bytes_Block

...

(FlashPro-ARM only)

General Description

Use the FPA to read a block of bytes from any address (RAM, flash, etc.).

Syntax

Code Block
languagecpp
INT_X F_Read_Bytes_Block( INT_X addr, INT_X size, BYTE *data );

Input

INT_X addr : first byte address to be read (byte addressable)
INT X size : number of bytes to be read
BYTE *data : array of bytes that will be written with memory contents

...

Select FPA to perform operation on using Multi API-DLL Functions | F_Set_FPA_index, index 1 to 64. Use index 0 to perform operation on all FPAs (if results differ, use Multi API-DLL Functions | F_LastStatus to get individual results).

Output

INT X : result of operation

...

Output

INT_X : result of operation

...

17. F_

...

Gang_

...

General Description

Start target MCU from specified program counter (PC). There should be a valid instruction at the target address.

Syntax

INT_X F_Set_PC_and_RUN( INT_X PC_addr )

Input

...

Read_Byte (GangPro-ARM only)

General Description

Use the FPA to read one byte from any address (RAM, flash, etc.).

Syntax

Code Block
languagecpp
INT_X F_Gang_Read_Byte( BYTE target_no, INT_X addr )

Input

BYTE target no : MCU target number 1 to 6
INT_X addr : address of byte to be read

Select FPA to perform operation on using Multi API-DLL Functions | F_Set_FPA_index, index 1 to 64. Use index 0 to perform operation on all FPAs (if results differ, use index 0 to perform operation on all FPAs (if results differ, use Multi API-DLL Functions | F_LastStatus to get individual results).

Output

INT_X : data read

18. F_Gang_Read_Word16 (GangPro-ARM only)

General Description

Use the FPA to read two bytes from any address (RAM, flash, etc.).

Syntax

Code Block
languagecpp
INT_X F_Gang_Read_Word16( BYTE target_no, INT_X addr )

Input

BYTE target no : MCU target number 1 to 6
INT_X addr : address of 16-bit word to be read

Select FPA to perform operation on using Multi API-DLL Functions | F_Set_FPA_index, index 1 to 64. Use index 0 to perform operation on all FPAs (if results differ, use Multi API-DLL Functions | F_LastStatus to get individual results).

Output

INT_X : data read

19. F_Gang_Read_Word32 (GangPro-ARM only)

General Description

Use the FPA to read four bytes from any address (RAM, flash, etc.).

Syntax

Code Block
languagecpp
INT_X F_Gang_Read_Word32( BYTE target_no, INT_X addr )

Input

BYTE target no : MCU target number 1 to 6
INT_X addr : address of 32-bit word to be read

Select FPA to perform operation on using Multi API-DLL Functions | F_Set_FPA_index, index 1 to 64. Use index 0 to perform operation on all FPAs (if results differ, use Multi API-DLL Functions | F_LastStatus to get individual results).

Output

INT_X : data read

20. F_Gang_Bytes_Block (GangPro-ARM only)

General Description

Use the FPA to read a block of bytes from any address (RAM, flash, etc.).

Syntax

Code Block
languagecpp
INT_X F_Gang_Read_Bytes_Block( INT_X addr, INT_X size, BYTE data[][GANG_SIZE] );

Input

INT_X addr : first byte address to be read (byte addressable)
INT_X size : number of bytes to be read
BYTE data[][GANG SIZE] : array of bytes that will be written with memory contents

Select FPA to perform operation on using Multi API-DLL Functions | F_Set_FPA_index, index 1 to 64.

Output

INT_X : result of operation

21. F_Set_PC_and_RUN

General Description

Start target MCU from specified program counter (PC). There should be a valid instruction at the target address.

This function has some exclusive GangPro-ARM return values.

Syntax

Code Block
languagecpp
INT_X F_Set_PC_and_RUN( INT_X PC_addr )

Input

INT_X PC addr : set program counter to this address and start processor

Select FPA to perform operation on using Multi API-DLL Functions | F_Set_FPA_index, index 1 to 64. Use index 0 to perform operation on all FPAs (if results differ, use Multi API-DLL Functions | F_LastStatus to get individual results).

Output

INT_X : result of operation

  • FALSE (0) : failed

  • FlashPro-ARM - TRUE (1) : succeeded

  • GangPro-ARM - TRUE MASK (0x01..0x3F) : 0x01 - target 1, 0x02 - target 2, 0x04 - target 3, 0x08 - target
    4, 0x10 - target 5, 0x20 - target 6

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F_LastStatus

...

INT X : result of operation

TRUE (1) : succeeded

...

...

...

22. F_Write_Locking_Registers

General Description

Write to non-volatile memory protection bits, option bytes, and/or persistent user-data registers (if supported). Does not block communication over debug interface, but can disable writing and/or reading from target device’s memory. These bits option bytes can be reset to factory settings using the Encapsulated Functions | F_Clear_Locked_Device function if the device supports it. To write protection bits, enable the WriteLockingBitsEn config- uration option.

...

Memory Protection Configuration | WriteLockingBitsEn configuration option has to be enabled. To control the exact data that is program, consult in detail the Main FP/GP ARM GUI->Setup->Memory protection, or section 2. Configuration and select the correct MCU vendor.

This function has some exclusive GangPro-ARM return values.

Syntax

Code Block
languagecpp
INT_X F_Write_Locking_Registers( void )

Input

none.

Select FPA to perform operation on using Multi API-DLL Functions | F_Set_FPA_index, index 1 to 64. Use index 0 to perform operation on all FPAs (if results differ, use Multi API-DLL Functions | F_LastStatus to get individual results).

Output

INT_X : result of operation

  • FALSE (0) : failed

  • FlashPro-ARM - TRUE (1) : succeeded

  • GangPro-ARM - TRUE MASK (0x01..0x3F) : 0x01 - target 1, 0x02 - target 2, 0x04 - target 3, 0x08 - target
    4, 0x10 - target 5, 0x20 - target 6

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F_LastStatus

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with

...

...

23. F_Write_Debug_Register

...

...

General Description

Write to non-volatile protection bits, or option bytes to disable communication over debug interface. These bits can be reset to factory settings using the Encapsulated Functions | F_Clear_Locked_Device function if the device supports it. To disable debug access, enable WriteLockingBitsEn and (vendor) USER DBG WrEn configuration options.

Syntax

INT_X , the Memory Protection Configuration | WriteLockingBitsEn configuration option has to be enabled. To control the exact data that is program, consult in detail the Main FP/GP ARM GUI->Setup->Memory protection, or section 2. Configuration and select the correct MCU vendor.

This function has some exclusive GangPro-ARM return values.

Syntax

Code Block
languagecpp
INT_X F_Write_Debug_Register(  void  )

Input

none.

Select FPA to perform operation on using Multi API-DLL Functions | F_Set_FPA_index, index 1 to 64. Use index 0 to perform operation on all FPAs (if results differ, use Multi API-DLL Functions | F_LastStatus to get individual results).

Output

INT_X : result of operation

  • FALSE (0) : failed

  • FlashPro-ARM - TRUE (1) : succeeded

  • TRUE (1) : succeeded

...

  • GangPro-ARM - TRUE MASK (0x01..0x3F) : 0x01 - target 1, 0x02 - target 2, 0x04 - target 3, 0x08 - target
    4, 0x10 - target 5, 0x20 - target 6

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F_LastStatus

...

24. F_Get_MCU

...

_

...

Data

General Description

Return the actual MCU ID, flash size, and/or RAM size read by the FPA to identify a specific from target device, if supported by vendor.

This function has some exclusive GangPro-ARM return values.

Syntax

INT_X F_Get_MCU_Data( INT_X type )

Input

INT X type : select type of information to receive

...

Select FPA to perform operation on using Multi API-DLL Functions | F_Set_FPA_index, index 1 to 64. Use index 0 to perform operation on all FPAs (if results differ, use Multi API-DLL Functions | F_LastStatus to get individual results).

Output

INT_X : result of operation

  • FALSE (0) : failed. No communication or incorrect parameters.

  • any postive value: MCU ID, flash size, RAM size

...

  • TRUE (1) : succeeded

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F

...

...

Anchor
F_Capture_PC_Addr
F_Capture_PC_Addr
Anchor
_bookmark262
_bookmark262
Anchor
_bookmark262
_bookmark262
F Capture PC Addr

General Description

Read program counter (PC) register using debug interface.

Syntax

INT_X F_Capture_PC_Addr( void );

Input

none.

Select FPA to perform operation on using Multi API-DLL Functions | F_Set_FPA_index, index 1 to 64. Use index 0 to perform operation on all FPAs (if results differ, use Multi API-DLL Functions | F_LastStatus to get individual results).

Output

INT_X : result of operation

  • FALSE (0) : failed.any postive value: program counter

  • TRUE (1) : succeeded

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer

...

...

...

Anchor
F_Synch_CPU_JTAG
F_Synch_CPU_JTAG
Anchor
_bookmark263
_bookmark263
Anchor
_bookmark263
_bookmark263
F Synch CPU JTAG

General Description

Stop target device (debug enable and halt).

Syntax

INT_X F_Synch_CPU_JTAG();

Input

none.

Select FPA to perform operation on using Multi API-DLL Functions | F_Set_FPA_index, index 1 to 64. Use index 0 to perform operation on all FPAs (if results differ, use Multi API-DLL Functions | F_LastStatus to get individual results).

Output

INT_X : result of operation

  • FALSE (0) : failed.

  • TRUE (1) : succeeded. MCU stopped.

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to Multi API-DLL Functions | F

...

...

...