Skip to end of banner
Go to start of banner

Generic Functions

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Having correctly configured the top-level Multi API-DLL using Multi API-DLL Functions, the functions in this section can be used to initialize and configure each FPA individually (and it’s API-DLL instance).

Generic functions read and write the API-DLL’s configuration, access status messages and can instruct the FPA to power or reset the target device. The functions described in this section require that each FPA already be opened using F OpenInstancesAndFPAs.

After the following functions have been used to configure each FPA correctly for its target device, use Data Buffer Functions to determine what code should be written during programming. Finally, Encapsulated Functions can perform the process of programming, writing, erasing, verifying, etc., according to the aforementioned settings.

1. F_Initialization

General Description

Initialize FPA after it has been successfully opened using F_OpenInstancesAndFPAs. F_Initialization performs the following tasks:

  • all internal data is cleared and set to default values,

  • USB driver is initialized if has not been initialized before.

Select which FPA to initialize, using the function F_Set_FPA index with desired parameter (0-all, 1-64 for individual FPA). After successful initialization, call F_ConfigFileLoad to read settings from file, or configure settings manually using the function F_Set_Config_Value_By_Name.

For backwards compatibility, F _nitialization will call F OpenInstancesAndFPAs(*# *) if no instances are currently opened, and perform initialization on FPA 1. If F_OpenInstancesAndFPAs was already invoked successfully then initialization is performed on the selected FPA index from the function F_Set_FPA_index.

Default config file used to perform initialization is config.ini (Use F_Use_Config_INI(FALSE) to disable automatic load of config.ini).

Syntax

INT_X F_Initialization( void );

Input

none.

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

Output

INT_X : result of operation

  • FALSE (0) : failed

  • TRUE (1) : succeeded

  • 4 : Programming adapter not detected

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

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

2. F_Use_Config_INI

General Description

Configure F_Initialization to use (default) or skip config.ini file. When skipping config.ini it is necessary to use F_ConfigFileLoad or F_Set_Config_Value_By_Name functions to configure the adapter.

Syntax

INT_X F_Use_Config_INI(BYTE use);

Input

BYTE use : 1 to use config.ini, 0 to skip

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

Output

INT_X : result of operation

  • FALSE (0) : failed

  • TRUE (1) : succeeded

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

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

3. F_Get_Config_Name_List

General Description

Iterate over configuration parameter names, starting from index 0. Increase index until return is null character. Will return a pointer to a character array with name of parameter or null character once index is too high.

Requires the target FPA to be opened using F_OpenInstancesAndFPAs and initialized using F_Initialization.

Syntax

char * F_Get_Config_Name_List( INT_X index );

Input

INT X : configuration parameter index, starting from zero. Increment until return value is null character.

Select FPA to perform operation on using F_Set_FPA_index, index 1 to 64.

Output

char * : configuration parameter name

  • a valid character array pointer containing name of configuration parameter (do not free after use)

  • null character : end of parameter list

  • ”” : invalid fpa index, cannot be zero

4. F_Get_Config_Value_By_Name

General Description

Access the current FPA’s configuration. Use F_Get_Config_Name_List to get configuration parameter names, then use them as input to this function. Select input type to validate name, and get current, minimum, maximum, and default values.

Because normal return values from this function can be any value, from 0 to 0xFFFFFFFF, it is important to pick a correct fpa index (use F_Check_FPA_index to validate) and validate the configuration parameter name first (using CONFSEL_VALIDATE), before retrieving the current, minimum, maximum or default values. Unless all FPAs are to be configured identically, avoid using FPA index 0 to prevent confusion in results (when results don’t match using FPA index 0 (all FPAs) the result is simply FPA_UNMATCHED_RESULTS (-1)).

Requires the target FPA to be opened using F_OpenInstancesAndFPAs and initialized using F_Initialization.

Syntax

unsigned int  F_Get_Config_Value_By_Name(char  *name,  INT_X  type);

Input

char * name : parameter name INT X type : select action

  • CONFSEL VALIDATE (0) : returns TRUE if name was found in configuration list

  • CONFSEL VALUE (1) : returns current value of configuration parameter

  • CONFSEL MIN (2) : returns minimum value that this configuration parameter can have

  • CONFSEL MAX (3) : returns maximum value that this configuration parameter can have

  • CONFSEL DEFAULT (4) : returns default value for this configuration parameter if not set by user/file

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

Output

unsigned int : depends on input

  • FALSE (0) : failed name validation (CONFSEL_VALIDATE)

  • TRUE (1) : successful name validation (CONFSEL_VALIDATE)

  • any : actual parameter value, minimum and maximum bounds, and default value if not set by user/file (CONFSEL_VALUE, CONFSEL_MIN, CONFSEL_MAX, CONFSEL_DEFAULT)

  • -1 or 0xFFFFFFFF : name not found (avoid this by using CONFSEL_VALIDATE first)

  • FPA_UNMATCHED_RESULTS (-1 or 0xFFFFFFFF) : Result of operation inconsistent across all selected FPAs, refer to F LastStatus(avoid this by not using FPA index 0)

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F OpenInstancesAndFPAs or index out of range(avoid this by using F Check FPA index first)

Example

Use the example code below to read full configuration:

//#define		CONFSEL_VALIDATE	0 
//#define		CONFSEL_VALUE		1 
//#define		CONFSEL_MIN			2 
//#define		CONFSEL_MAX			3 
//#define		CONFSEL_DEFAULT		4 
stringstream msg;
char *tmp=NULL;
int i=0;
while((tmp = F_Get_Config_Name_List(i++)) !=  NULL && strcmp(tmp, "\0") != 0) {
	//Check if parameter name is correct, should be redundant
	if(F_Get_Config_Value_By_Name(tmp, 0)) {
		unsigned int val = F_Get_Config_Value_By_Name(tmp, 1);
		unsigned int min = F_Get_Config_Value_By_Name(tmp, 2);
		unsigned int max = F_Get_Config_Value_By_Name(tmp, 3);
		unsigned int def = F_Get_Config_Value_By_Name(tmp, 4);
		msg << tmp << "=0x" << hex << val << ", 0x" << hex << min << "<=X<=0x" << hex << max <<  "(def=0x" << hex << def << ")\r\n";
		//sanity check on current value
		if(val < min || val > max) {
			msg << "======= " << tmp << " value outside min/max =======\r\n";
			msg << "DLL failed to trim\r\n";
		}
		//sanity check on default value
		if(def < min || def > max) {
			msg << "======= " << tmp << " default outside min/max =======\r\n";
			msg << "Param default OUT OF RANGE\r\n";
		}			
	} else {
		msg << "config parameter name invalid  " << tmp << "\r\n";
	}
}

5. F_Set_Config_Value_By_Name

General Description

Set the current FPA’s configuration. Use F_Get_Config_Name_List to get configuration parameter names, then use them as input to this function. New value for configuration parameter will be trimmed by minimum and maximum values allowed for this parameter. If not initialized, this parameter will have a default value. Double check parameters after configuration using F_Get_Config_Value_By_Name.

Requires the target FPA to be opened using F_OpenInstancesAndFPAs and initialized using F_Initialization.

Syntax

INT_X F_Set_Config_Value_By_Name(char *name, unsigned int newValue);

Input

char * name : parameter name

unsigned int newValue : assign new configuration parameter value (will be trimmed by min/max if necessary)

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

Output

INT_X : result of operation

  • FALSE (0) : parameter name not found

  • TRUE (1) : name found and parameter value changed

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

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

6. F_Get_Device_Info

General Description

Get information about selected microcontroller.

Syntax

INT_X F_Get_Device_Info( INT_X index );

Input

INT_X : select type of information to receive

  • DEVICE_NAME (0) : get character 0, increase index up to 19 to get last character

  • DEVICE_FAMILY_INDEX (20) : Family Index (subset of MCU vendor, index 30)

  • DEVICE_GROUP_INDEX (21) : Group Index (subset of MCU family, index 20)

  • DEVICE_NAME_INDEX (22) : Name Index (subset of MCU group, index 21)

  • DEVICE_GROUP (23) : Obsolete

  • DEVICE_FLASH_START_ADDR (24) : Flash Start Address, i.e. 0x00000

  • DEVICE_FLASH_END_ADDR (25) : Flash End Address, i.e. 0x1FFFF

  • DEVICE_OTP_START_ADDR (26) : OTP Start Address, i.e. 0x400FE1E0

  • DEVICE_OTP_END_ADDR (27) : OTP End Address, i.e. 0x400FE1EF

  • DEVICE_RAM_START_ADDR (28) : RAM Start Address, i.e. 0x20000000

  • DEVICE_RAM_END_ADDR (29) : RAM Start Address, i.e. 0x20010000

  • DEVICE_VENDOR_INDEX (30) : Vendor Index (superset of all supported MCUs, i.e. company name)

  • DEVICE_EEPROM_START_ADDR (31) : EEPROM Start Address, i.e. 0x08080000

  • DEVICE_EEPROM_END_ADDR (32) : EEPROM End Address, i.e. 0x080803FF

  • DEVICE_COMM_INTERFACES (33) : MCU communication interfaces eg 0x30 ( COMM_JTAG | COMM_SWD

  • DEVICE_EXTFLASH_START_ADDR (34) : External Flash Start Address, i.e. 0x10000000

  • DEVICE_EXTFLASH_END_ADDR (35) : External Flash End Address, i.e. 0x1001FFFF

Select FPA to perform operation on using F Set FPA index, index 1 to 64.

Output

INT_X : value dependent on input parameter

  • any : based on input parameter

  • -1 (0xFFFFFFFF) : invalid input parameter

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

7. F_Set_MCU_Name

General Description

Set target microcontroller name. A list of acceptable names can be obtained using the functions F_Set_MCU_Family_Group, F_Get_MCU_Name_list, and F_Search_MCU_Name.

Syntax

INT_X F_Set_MCU_Name( char *MCU_name );

Input

char * MCU_name: Exact name of target microcontroller.

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

Output

INT_X : microcontroller index if successful

  • microcontroller index if input name was found and set, index is greater than or equal to zero (0)

  • -1 (0xFFFFFFFF) : name not found (avoid by getting list of proper names using F_Get_MCU_Name_list)

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

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

8. F_Search_MCU_Name

General Description

Get microcontroller names that match regular expression from selected vendor.

Syntax

void* F_Search_MCU_Name( char *MCU_name_regex, char *Vendor_filter, int mode, int flags );

Input

char * MCU_name_regex : regular expression. i.e.:

  '.'        Dot, matches any character
  '^'        Start anchor, matches beginning of string
  '$'        End anchor, matches end of string
  '*'        Asterisk, match zero or more (greedy)
  '+'        Plus, match one or more (greedy)
  '?'        Question, match zero or one (non-greedy)
  '[abc]'    Character class, match if one of {'a', 'b', 'c'}
  '[a-zA-Z]' Character ranges, the character set of the ranges { a-z | A-Z }
  '\s'       Whitespace, \t \f \r \n \v and spaces
  '\S'       Non-whitespace
  '\w'       Alphanumeric, [a-zA-Z0-9_]
  '\W'       Non-alphanumeric
  '\d'       Digits, [0-9]
  '\D'       Non-digits

char * Vendor_filter : Preferably limit to one vendor only, to speed up search function especially in mode with more than first match result. i.e.:

 NULL all enabled lists on this adapter
 "Active-Semi"
 "Analog Devices"
 "Cypress"
 "Microchip/Atmel"
 "Marvell Tech."
 "Maxim Integrated"
 "Nordic Semiconductor"
 "NXP/Freescale"
 "Renesas"
 "Silergy"
 "Silicon Labs"
 "ST Microelectronics"
 "Texas Instruments-ARM"
 "Texas Instruments-Chipcon"

int mode : search mode

  • 0, returns the first match to MCU_name_regex, a type (char *). Library will alloc and free this memory by itself, do not modify contents

  • 1, returns the pointer to a list of matches to MCU_name_regex, a type (char **). Library will alloc and free this memory by itself, do not modify contents

int flags : used to control mode 1 search

  • for mode 0, not used

  • for mode 1, max number of results to return > 0

Select FPA to perform operation on using F_Set_FPA_index, index 1 to 64.

Output

void * : pointer to results

  • if mode 0 used, one char * name, or NULL if no match

  • if mode 1 used, a list of matches returned as (char **). The list will continue with string matches or NULL when search results have finished.

9. F_Reset_Config

General Description

Reset all configuration values to default values for selected MCU.

Syntax

void  MSPPRG_API	F_Reset_Config();

Input

none.

Output

none.

10. F_Get_MCU_Name_list

General Description

Obtain a list of supported vendors, families, groups, and MCUs for the specified FPA. Use this function in conjunction with F_Set_MCU_Family_Group to get all supported MCU names. First obtain the names of supported vendors, then select one vendor. Then, for the selected vendor obtain the names of supported families, then select one family, etc.

The MCU names obtained from this function are the exact names used to configure the FPA using the function F_Set_MCU_Name for the target device you want to program.

Syntax

char *  F_Get_MCU_Name_list( INT_X type, INT_X index );

Input

INT_X type : specify which list to get names from

  • MCU_VENDOR_LIST (0) : get name of vendors enabled on this FPA

  • MCU_FAMILY_LIST (1) : get name of MCU families supported from the selected vendor

  • MCU_GROUP_LIST (2) : get name of MCU groups supported from the selected MCU family

  • MCU_NAME_LIST (3) : get name of MCU supported from the selected MCU group

INT_X index : list index starting from zero, increment until returned string is null character.

Select FPA to perform operation on using F_Set_FPA_index, index 1 to 64.

Output

char * : Name of vendor, family, group, or MCU for the given index.

  • valid name : if correct parameters provided

  • ”” : incorrect FPA index provided (avoid using F_Check_FPA index)

Example

Refer to F_Set_MCU_Family_Group.

11. F_Set_MCU_Family_Group

General Description

Select vendor, family, group and MCU index. Use this function in conjunction with F_Get_MCU_Name_list to get all supported MCU names. First obtain the names of supported vendors, then select one vendor. Then, for the selected vendor obtain the names of supported families, then select one family, etc.

Use MCU names to configure the FPA using the function F Set MCU Name. Use this function only to obtain the list of supported MCU names, not to configure the FPA. When NEW MCUs are supported then these indices will change.

Syntax

INT_X F_Set_MCU_Family_Group( INT_X type, INT_X index );

Input

INT_X type : specify which list to set index for

  • MCU_VENDOR_LIST (0) : set vendor index on this FPA

  • MCU_FAMILY_LIST (1) : set family index from the selected vendor

  • MCU_GROUP_LIST (2) : set group index from selected MCU family

  • MCU_NAME_LIST (3) : set MCU index from selected MCU group (use actual INT X index : set list index

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

Output

INT_X : result of operation

  • FALSE (0) : index parameter out of range

  • TRUE (1) : index parameter set correctly

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

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

Example

Extract MCU Part Number Directory
This code example prints the full list of supported MCU vendors, families, groups, and individual MCU part numbers. The condition for this example to work properly is that F_OpenInstancesAndFPAs, and F_Initialization has correctly initialized the given fpa index (1 to 64). If testing adapter 1, the user should call F_Set_FPA_index(1) before this code executes.

The code below is used to initialize the drop-down menus seen in the GUI demos that can be found in the install Elprotronic\ARM\API-DLL directory.

The sequence is as follows:

  • Get Vendor List

    • Call F_Get_MCU_Name_list( MCU_VENDOR_LIST, k ); in a loop to read all supported vendors

      • This generates a list of vendors but doesn’t actually select one, i.e. TI, ST, or NXP

    • Set current vendor using F_Set_MCU_Family_Group( MCU_VENDOR_LIST, Vendor_list_index );

      • This function selects one vendor from the list, with given index, i.e. select ST vendor.

  • Get Family List from selected vendor:

    • Call F_Get_MCU_Name_list( MCU_FAMILY_LIST, k ); in a loop to read all families in selected vendor

      • This generates a list of MCU families for one specific vendor, i.e. STM32-F0, STM32-F1, etc.

    • Set current family using F_Set_MCU_Family_Group( MCU_FAMILY_LIST, Family_list_index );

      • This function selects one family from the list, with given index. At this point the code has selected one vendor and one family from that vendor, i.e. select STM32-F0 family.

  • Get Group List from selected family of selected vendor. Groups sub-divide families into similar MCUs.

    • Call F_Get_MCU_Name_list( MCU_GROUP_LIST, k ); in a loop to read all groups in selected family in selected vendor.

      • This generates a list of groups for selected family within selected vendor, i.e. STM32F0x0, STM32F0x1, STM32F0x2, and STM32F0x8

    • Set current group using F_Set_MCU_Family_Group( MCU_GROUP_LIST, MCU_Group_list_index );

      • This functions selects one group from the list, with given index. At this point the code has selected one vendor, and one family, and one group, i.e. select STM32F0x8.

  • Get MCU part number list from selected group. This is the final MCU name actually used in the “MCU_name” parameter of the configuration file.

    • Call F_Get_MCU_Name_list( MCU_NAME_LIST, k ); in a loop to read all MCUs in selected group, in selected family, in selected vendor.

      • This generates a list of MCU part numbers, i.e. STM32F038C6, STM32F038E6, etc.

    • Select (not shown below) one MCU from the list by using INT_X F_Set_MCU_Name(char *MCU_name );

      • This function selects one MCU, and changes the configuration of the library to program this specific MCU.

Snippet taken from Elprotronic\ARM\API-DLL\FP-ARM-Demo-C++:

//C++ and C# are available in the installation package
//that implement this code
//Example from demo included in installation package
//Select one FPA index to perform this sequence on.
//If all FPA are the same then iterating over other FPA indices is not necessary.
//Iterate over supported vendors, then select vendor zero in this case
//Pull-down menu in demo allows user to change selected vendor index
void ProgDemoDlg::Init_MCU_Vendor_ComboBox( void )
{
  int k;
  char *name;
  SelMCU_Vendor->ResetContent();//Reset list of vendors
  k = 0;
  Vendor_list_size = 0;
  do
  {
    //----------------------------------------------------
    name = F_Get_MCU_Name_list( MCU_VENDOR_LIST, k );//get name of vendor at index k
    if( strlen( name ) == 0 ) break; //reached end of list of vendors
    //----------------------------------------------------
    if(SelMCU_Vendor)
    {
      //----------------------------------------------------
      SelMCU_Vendor->AddString( name ); //add newly acquired vendor name to GUI list
      //----------------------------------------------------
      Vendor_list_size++;
    }
    k++;
  }while(1);
  //Select vendor zero in demo GUI (will not affect DLL yet)
  SelMCU_Vendor->SetCurSel(0);
  //Select chosen vendor and read supported MCU families
  OnCbnSelchangeMcuVendor();
}
//Initialize list of supported families for selected vendor
void ProgDemoDlg::OnCbnSelchangeMcuVendor( void )
{
  Vendor_list_index = SelMCU_Vendor->GetCurSel();
  //----------------------------------------------------
  //Set vendor to selected index (during initialization this is usually zero)
  F_Set_MCU_Family_Group( MCU_VENDOR_LIST, Vendor_list_index );
  //----------------------------------------------------
  Init_MCU_Family_ComboBox();
}
//Iterate over supported families for selected vendor, then select family zero in this case
//Pull-down menu in demo allows user to change selected family index
void ProgDemoDlg::Init_MCU_Family_ComboBox( void )
{
  int k;
  char *name;
  SelMCU_Family->ResetContent();
  k = 0;
  Family_list_size = 0;
  do
  {
    //----------------------------------------------------
    name = F_Get_MCU_Name_list( MCU_FAMILY_LIST, k ); //get name of family at index k
    if( strlen( name ) == 0 ) break; //reached end of list of families
    //----------------------------------------------------
    if(SelMCU_Family)
    {
      //----------------------------------------------------
      SelMCU_Family->AddString( name ); //add newly acquired family name to GUI list
      //----------------------------------------------------
      Family_list_size++;
    }
    k++;
  }while(1);
  //Select family zero in demo GUI (will not affect DLL yet)
  SelMCU_Family->SetCurSel(0);
  //Select chosen family and read supported MCU groups
  OnCbnSelchangeMcuFamily();
}
//Initialize list of supported groups for selected family
void ProgDemoDlg::OnCbnSelchangeMcuFamily( void )
{
  Family_list_index = SelMCU_Family->GetCurSel();
  //----------------------------------------------------
  //Set family to selected index (during initialization this is usually zero)
  F_Set_MCU_Family_Group( MCU_FAMILY_LIST, Family_list_index );
  //----------------------------------------------------
  Init_MCU_Group_ComboBox();
}
//Iterate over supported groups for selected family, then select group zero in this case
//Pull-down menu in demo allows user to change selected group index
void ProgDemoDlg::Init_MCU_Group_ComboBox( void )
{
  int k;
  char *name;
  SelMCU_Group->ResetContent();
  MCU_Group_list_size = 0;
  k = 0;
  do
  {
    //----------------------------------------------------
    name = F_Get_MCU_Name_list( MCU_GROUP_LIST, k ); //get name of group at index k
    if( strlen( name ) == 0 ) break; //reached end of list of groups
    //----------------------------------------------------
    if(SelMCU_Group)
    {
      //----------------------------------------------------
      SelMCU_Group->AddString( name ); //add newly acquired group name to GUI list
      //----------------------------------------------------
      MCU_Group_list_size++;
    }
    k++;
  }while(1);
  //Select group zero in demo GUI (will not affect DLL yet)
  SelMCU_Group->SetCurSel(0);
  //Select chosen group and read supported MCUs
  OnCbnSelchangeMcuGroup();
}
//Initialize list of supported MCUs for selected group
void ProgDemoDlg::OnCbnSelchangeMcuGroup( void )
{
  MCU_Group_list_index = SelMCU_Group->GetCurSel();
  //----------------------------------------------------
  //Set group to selected index (during initialization this is usually zero)
  F_Set_MCU_Family_Group( MCU_GROUP_LIST, MCU_Group_list_index );
  //----------------------------------------------------
  Init_MCU_List_ComboBox();
}
//Iterate over supported MCUs for selected group, then select MCU zero in this case
//Pull-down menu in demo allows user to change selected MCU index
void ProgDemoDlg::Init_MCU_List_ComboBox( void )
{
  int k;
  char *name;
  SelMCU_List->ResetContent();
  MCU_Name_list_size = 0;
  k = 0;
  do
  {
    //----------------------------------------------------
    name = F_Get_MCU_Name_list( MCU_NAME_LIST, k ); //get name of MCU at index k
    if( strlen( name ) == 0 ) break; //reached end of list of MCUs
    //----------------------------------------------------
    if(SelMCU_List)
    {
      //----------------------------------------------------
      SelMCU_List->AddString( name ); //add newly acquired MCU name to GUI list
      //----------------------------------------------------
      MCU_Name_list_size++;
    }
    k++;
  }while(1);
  //Select MCU zero in demo GUI (will not affect DLL yet)
  SelMCU_List->SetCurSel(0);
}

12. F_ReportMessage, F_Report_Message

General Description

Get the last report message from the programmer. When any of the DLL functions are called, an output message is usually created. The GUI uses these messages to print to the dialog box. The user application can use these messages to populate its own dialog box. The last report message can be read by user application using these functions.

When these functions are called, then a report message of up to REPORT_MESSAGE_MAX_SIZE characters is copied to the character array passed as input parameter, or in the case of the latter function, a pointer to a statically allocated character array is returned with the output message text.

Calling F_ReportMessage clears the message buffer. If F_ReportMessage is not called, then the report message will collect all reported information up to REPORT MESSAGE MAX SIZE most recent characters.

Syntax

void F_ReportMessage( char * text ); 
char* F_Report_Message( void );

Input

char * text : F_ReportMessage, allocated text buffer of up to REPORT_MESSAGE_MAX_SIZE (2000) characters.

Select FPA to perform operation on using F_Set_FPA_index, index 1 to 64.

Output

char * : F_Report_Message, pointer to statically allocated character array containing output message text

13. F_GetReportMessageChar

General Description

Get one character from the report message buffer.

Syntax

char F_GetReportMessageChar( INT_X index );

Input

INT_X index : character index, starting from 0 to REPORT_MESSAGE_MAX_SIZE - 1.

Select FPA to perform operation on using F_Set_FPA_index, index 1 to 64.

Output

char : character from report message buffer.

14. F_DLLTypeVer

General Description

Get information about DLL software type and version. This function returns integer number with DLL ID and software revision version and copies a text message to the report message buffer about DLL ID and software revision. Text content can als0 be read using F_ReportMessage, F_Report_Message, or F_GetReportMessageChar functions.

Syntax

INT_X F_DLLTypeVer( void );

Input

none.

Select FPA to perform operation on using F_Set_FPA_index, index 1 to 64.

Output

INT X : (DLL ID) | (0x0FFF & Version)

  •     // return	 Type + Version	
	//           Type   0x1000 - Single FlashPro430 - Parallel Port type  
	//					0x2000 - Single FlashPro430 - USB type  
	//					0x3000 - Single GangPro430  - USB type  
	//					0x4000 - Single FlashPro-CC - USB type  
	//					0x5000 - Single GangPro-CC  - USB type  
	//					0xA000 - Single FlashPro2000- USB type  
	//					0xB000 - Single GangPro2000 - USB type  
	//					0xE000 - Single FlashPro-ARM - USB type  
	//					0xF000 - Single GangPro-ARM - USB type  
	//			 Version = 0x0FFF & version

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

15. F_ConfigFileLoad

General Description

Modify programmer’s configuration according to data taken from specified configuration file. This setup will override previous values and leave omitted parameters untouched. When loaded for the first time, unspecified configuration parameters take on default values as given by F_Get_Config_Value_By_Name. When calling this function multiple times with different configuration files, make sure to specify all relevant configuration parameters.

A configuration file can be created using the FlashPro-ARM/GangPro-ARM GUI software, or use the functions F_Get_Config_Name_List, F_Get_Config_Value_By_Name to extract a list of configuration names and values. The F_Set_Config_Value_By_Name function can be used to set configuration parameters instead of F_ConfigFileLoad.

Requires the target FPA to be opened using F_OpenInstancesAndFPAs and initialized using F_Initialization.

Syntax

INT_X F_ConfigFileLoad( char * filename );

Input

char * filename : path to configuration file including filename and extension

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

Output

INT X : result of operation

  • FALSE (0) : failed

  • TRUE (1) : succeeded

  • STATUS_OPEN_FILE_ERROR (535) : could not open file

  • STATUS_CORRUPT_CONFIG_ERROR (554) : malformed configuration file (missing header, etc.)

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

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

16. F_Power_Target

General Description

Enable power from FPA to target device. For this function to have its desired effect, configuration settings “PowerFromFpaEn” must be set to 1. If “PowerFromFpaEn” is set to 0, then power from FPA is always off regardless of this function’s input parameter.

Syntax

INT X F_Power_Target( INT X OnOff );

Input

INT X : power setting

  • FALSE (0) : power off

  • TRUE (1) : power on

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

Output

INT_X : result of operation

  • FALSE (0) : failed

  • TRUE (1) : succeeded

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

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

17. F_Reset_Target

General Description

Generate short reset pulse on target device’s reset line. The length of the reset pulse can be selected using configuration options. The “ResetTimeIndex” is used to select pre-set times, or for custom setup select the last index and specify “ResetPulseTime”, and “ResetIdleTime”.

Syntax

INT_X F_Reset_Target( void );

Input

none.

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

Output

INT_X : result of operation

  • FALSE (0) : failed

  • TRUE (1) : succeeded

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

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

18. F_Get_Targets_Vcc

General Description

Get Vcc in millivolts as read from target device.

This function is supported on all adapters (USB-FPA 6.1, XStream-Iso, and XStreamPro-Iso).

Syntax

INT_X F_Get_Targets_Vcc( void );

Input

none.

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

Output

INT_X : returns target voltage in millivolts

  • value of zero or greater : voltage in millivolts

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

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

19. F_Get_Power_Results

General Description

Get detailed Voltage and Current measurement results based on Power Configuration

This function is supported on all adapters (USB-FPA 6.1, XStream-Iso, and XStreamPro-Iso).

Syntax

INT_X F_Get_Targets_Vcc( void );

Input

none.

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

Output

INT_X : returns target voltage in millivolts

  • value of zero or greater : voltage in millivolts

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

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

DLL_OUTSIDE_CALLONE(return, INT_X, Get_Power_Results, double *, xs_adc)
DLL_OUTSIDE_CALLONE(return, INT_X, Get_Last_Power_Results_data, double *, xs_adc)
DLL_OUTSIDE_CALLONE(return, INT_X, XS_Current_zeroing, int, state, char *, txt )
DLL_OUTSIDE_CALLONE(return, INT_X, XS_Update_HW_State, BYTE, mode, INT_X, data )
DLL_OUTSIDE_CALLALL(return, INT_X, XS_Clr_ADC_av_history )

19. F_Set_fpa_io_state

General Description

Set state of the Reset, Vcc and JTAG lines after programming is finished.

Syntax

INT_X F_Set_fpa_io_state( BYTE jtag, BYTE reset, BYTE VccOn )

Input

BYTE jtag : set JTAG lines (TMS, TCK, TDI)

  • DEFAULT_JTAG_3ST (0) : JTAG lines set to tri-state

  • DEFAULT_JTAG_HI (1) : JTAG lines set to Vcc

  • DEFAULT_JTAG_LO (2) : JTAG lines set to GND

BYTE reset : set reset line

  • 0 : reset line set to GND

  • 1 : reset line set to Vcc

BYTE VccOn : set Vcc line from adapter

  • 0 : set to tri-state

  • 1 : set to configured Vcc (configuration parameter VccFromFPAin mV)

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

Output

INT_X : result of operation

  • FALSE (0) : failed

  • TRUE (1) : succeeded

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

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

20. F_Get_Sector_Size

General Description

Will return the segment/sector size for memory region that contains given address. This function will access the FPA’s meta-data for the target device specified in configuration options. No communication with target device actually takes place.

Syntax

INT_X F_Get_Sector_Size( INT_X address );

Input

INT X address : address contained by segment/sector

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

Output

INT_X : result of operation

  • FALSE (0) : address out of range

  • positive number : actual sector size

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

  • FPA_INVALID_NO (-2 or 0xFFFFFFFE) : FPA not opened with F_OpenInstancesAndFPAs or index out of range

  • No labels