Versions Compared

Key

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

...

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

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

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

...

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, 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

  • 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

24. F_Get_MCU_Data

General Description

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

This function has some exclusive GangPro-ARM input values.

Syntax

Code Block
languagecpp
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

25. F_Capture_PC_Addr

General Description

Read program counter (PC) register using debug interface.

Syntax

Code Block
languagecpp
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

26. F_Synch_CPU_JTAG

General Description

Stop target device (debug enable and halt).

This function has some exclusive GangPro-ARM return values.

Syntax

Code Block
languagecpp
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

...

27. F_Get_Targets_Result
Anchor
F_Get_Targets_Result
F_Get_Targets_Result
(GangPro-ARM only)

General Description

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

Code Block
languagecpp
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

...

28. F_Get_Active_Targets_Mask
Anchor
F_Get_Active_Targets_Mask
F_Get_Active_Targets_Mask
(GangPro-ARM 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

Code Block
languagecpp
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

...