Page Comparison

...

This function has some exclusive GangPro-ARM M return values.

Syntax

INT_X F_Open_Target_Device( void );

...

• FALSE (0) : failed

• FlashPro-ARMM - TRUE (1) : succeeded

• GangPro-ARM M - 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

...

This function has some exclusive GangPro-ARM M return values.

Syntax

INT_X F_Close_Target_Device( void );

...

• FALSE (0) : failed

• FlashPro-ARMM - TRUE (1) : succeeded

• GangPro-ARM M - 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

...

This function has some exclusive GangPro-ARM M return values.

Syntax

INT_X F_Segment_Erase( INT_X address );

...

• FALSE (0) : failed

• FlashPro-ARMM - TRUE (1) : succeeded

• GangPro-ARM M - 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

...

This function has some exclusive GangPro-ARM M return values.

Syntax

INT_X F_Sectors_Blank_Check( INT_X start_addr, INT_X stop_addr );

...

• FALSE (0) : failed

• FlashPro-ARMM - TRUE (1) : succeeded

• GangPro-ARM M - 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

...

Write specified number of bytes from Write Buffer in FlashPro-ARM M Data Buffer Functions | FlashPro-ARMM-buffers or GangPro-ARM M Data Buffer Functions | GangPro-ARMM-buffers to target flash.

This function has some exclusive GangPro-ARM M return values.

Syntax

INT_X F_Copy_Buffer_to_Flash( INT_X start_addr, INT_X size );

...

• FALSE (0) : failed

• FlashPro-ARMM - TRUE (1) : succeeded

• GangPro-ARM M - 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

...

6. F_Copy_Flash_to_Buffer (FlashPro-

...

M only)

General Description

Read specified number of bytes from MCU flash to Read Data Buffer in FlashPro-ARM M Data Buffer Functions | FlashPro-ARMM-buffers.

Syntax

INT_X F_Copy_Flash_to_Buffer( INT_X start_addr, INT_X size );

...

Refer to Sequential Functions | F_Copy_Buffer_to_Flash.

7. F_Copy_Gang_Buffer_to_Flash

Anchor
F_Copy_Gang_Buffer_to_Flash F_Copy_Gang_Buffer_to_Flash

(GangPro-

...

M only)

General Description

Write specified number of bytes from Gang Write Buffer in GangPro-ARM M Data Buffer Functions | GangPro-ARMM-buffers to target flash.

Syntax

INT_X F_Copy_Gang_Buffer_to_Flash( INT_X start_addr, INT_X size );

...

8. F_Copy_Flash_to_Gang_Buffer (GangPro-

...

M only)

General Description

Read specified number of bytes from targets' MCU flash to Gang Read Buffers in GangPro-ARM M Data Buffer Functions | GangPro-ARMM-buffers.

Syntax

INT_X F_Copy_Flash_to_Gang_Buffer( INT_X start_addr, INT_X size );

...

Use the FPA to write a byte to the target device(s) RAM. This write is not verified (no read performed). Use F_Read_Byte (FlashPro-ARMM) or F_Gang_Read_Byte (GangPro-ARMM) to verify.

This function has some exclusive GangPro-ARM M return values.

Syntax

INT_X F_Write_Byte_to_RAM( INT_X addr, BYTE data );

...

• FALSE (0) : failed

• FlashPro-ARMM - TRUE (1) : succeeded

• GangPro-ARM M - 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

...

Use the FPA to write two bytes to the target device(s) RAM. This write is not verified (no read performed). Use F_Read_Word16 (FlashPro-ARMM) or F_Gang_Read_Word16 (GangPro-ARMM) to verify.

This function has some exclusive GangPro-ARM M return values.

Syntax

INT_X F_Write_Word16_to_RAM( INT_X addr, INT_X data )

...

• FALSE (0) : failed

• FlashPro-ARMM - TRUE (1) : succeeded

• GangPro-ARM M - 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

...

Use the FPA to write four bytes to the target device(s) RAM. This write is not verified (no read performed). Use F_Read_Word32 (FlashPro-ARMM) or F_Gang_Read_Word32 (GangPro-ARMM) to verify.

This function has some exclusive GangPro-ARM M return values.

Syntax

INT_X F_Write_Word32_to_RAM( INT_X addr, INT_X data )

...

• FALSE (0) : failed

• FlashPro-ARMM - TRUE (1) : succeeded

• GangPro-ARM M - 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

...

Use the FPA to write a block of bytes to RAM. Currently this function only writes a block of bytes with a size that is a multiple of four, to a 32-bit word aligned address. These writes are not verified (no reads performed). Use F_Read_Bytes_Block (FlashPro-ARMM) or F_Gang_Read_Bytes_Block (GangPro-ARMM) to verify.

This function has some exclusive GangPro-ARM M return values.

Syntax

INT_X F_Write_Bytes_Block_to_RAM( INT_X addr, INT_X size, BYTE *data )

...

• FALSE (0) : failed

• FlashPro-ARMM - TRUE (1) : succeeded

• GangPro-ARM M - 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 (FlashPro-

...

M only)

General Description

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

...

• 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_LastStatus

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

14. F_Read_Word16 (FlashPro-

...

M only)

General Description

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

...

• 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_LastStatus

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

15. F_Read_Word32 (FlashPro-

...

M only)

General Description

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

...

• 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_LastStatus

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

16. F_Read_Bytes_Block (FlashPro-

...

M only)

General Description

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

...

• FALSE (0) : failed

• TRUE (1) : succeeded

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

17. F_Gang_Read_Byte (GangPro-

...

M only)

General Description

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

...

• 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_LastStatus

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

18. F_Gang_Read_Word16 (GangPro-

...

M only)

General Description

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

...

• 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_LastStatus

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

19. F_Gang_Read_Word32 (GangPro-

...

M only)

General Description

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

...

• 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_LastStatus

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

20. F_Gang_Bytes_Block (GangPro-

...

M only)

General Description

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

...

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 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, 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 M GUI->Setup->Memory protection, or section 2. Configuration and select the correct MCU vendor.

This function has some exclusive GangPro-ARM M return values.

Syntax

INT_X F_Write_Locking_Registers( void )

...

• FALSE (0) : failed

• FlashPro-ARMM - TRUE (1) : succeeded

• GangPro-ARM M - 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

...

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, 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 M GUI->Setup->Memory protection, or section 2. Configuration and select the correct MCU vendor.

This function has some exclusive GangPro-ARM M return values.

Syntax

INT_X F_Write_Debug_Register(  void  )

...

• FALSE (0) : failed

• FlashPro-ARMM - TRUE (1) : succeeded

• GangPro-ARM M - 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

...

This function has some exclusive GangPro-ARM M input values.

Syntax

INT_X F_Get_MCU_Data( INT_X type )

...

• GET_MCU_ID (1) : connected MCU package identifier (MCU family and group, etc.), not a unique silicon ID

• GET_MCU_FLASH_SIZE (2) : connected MCU flash size, if available

• GET_MCU_RAM_SIZE (3) : connected MCU RAM size, if available

• GET_MCU_TARGET_1 (0x10) : read from target 1, OR with type of info. requested (GangPro-ARM M only)

• GET_MCU_TARGET_2 (0x20) : read from target 2, OR with type of info. requested (GangPro-ARM M only)

• GET_MCU_TARGET_3 (0x30) : read from target 3, OR with type of info. requested (GangPro-ARM M only)

• GET_MCU_TARGET_4 (0x40) : read from target 4, OR with type of info. requested (GangPro-ARM M only)

• GET_MCU_TARGET_5 (0x50) : read from target 5, OR with type of info. requested (GangPro-ARM M only)

• GET_MCU_TARGET_6 (0x60) : read from target 6, OR with type of info. requested (GangPro-ARM M only)

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).

...

• FALSE (0) : failed

• any positive value : program counter

• 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

...

27. F_Get_Targets_Result

Anchor
F_Get_Targets_Result F_Get_Targets_Result

(GangPro-M only)

General Description

Stop target device (debug enable and halt).

This function has some exclusive GangPro-ARM return values.

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

• 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

...

General Description

Return per-target Return per-target success result for encapsulated functions. An error mask can be produced by
subtracting F_Get_Targets_Result() from F_Get_Active_Targets_Mask().

Syntax

INT_X F_Get_Targets_Result( 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

• 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

28. F_Get_Active_Targets_Mask

Anchor
F_Get_Active_Targets_Mask F_Get_Active_Targets_Mask

(GangPro-

...

M only)

General Description

Return per-target active status. Set intended target mask using: Generic Functions | F_Set_Config_Value_By_Name. Value returned by this function is updated during communication initialization, after any encapsulated function or Sequential Functions | F_Open_Target_Device . An error mask can be produced by subtracting F_Get_Targets_Result() from F_Get_Active_Targets_Mask().

Syntax

INT_X F_Get_Active_Targets_Mask( 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

...