isys::CCfg_debug_basic Class Reference

Description

This class provides methods to manage winIDEA configuration in Basic mode.

Once the instance is configured, it can be used in CWorkspaceController's create, get_cfg_debug and set_cfg_debug functions.

Python example.

#include <CWorkspaceController.h>

Public Types
enum class	EPresetPC {   none , EntryPoint ,   Address }
	How to preset the PC. More...

Public Member Functions
std::string	get_AppName () const
	gets the application name
bool	get_CreateSMP () const
	gets the SMP configuration
std::string	get_Device () const
	gets the device(SoC) to use
std::string	get_DeviceName () const
	gets the user name of the device(SoC)
std::string	get_PgmPath () const
	gets the path to the program file
EPresetPC	get_PresetPC () const
	gets the PC preset mode
std::string	get_PresetPC_symbol () const
	gets the PC preset symbol
std::string	get_Probe () const
	gets the probe name to use
std::string	get_ReplaceDir () const
	gets the source file path remapping
std::string	get_SymPath () const
	gets the path to the application's symbol file
bool	get_UseSymForPgm () const
	gets the program file = symbol file setting
CCfg_debug_basic &	set_AppName (const std::string &val)
	Sets the application name.
CCfg_debug_basic &	set_CreateSMP (bool val)
	sets the SMP configuration
CCfg_debug_basic &	set_Device (const std::string &val)
	Sets the device(SoC) to use.
CCfg_debug_basic &	set_DeviceName (const std::string &val)
	Sets the user name of the device(SoC).
CCfg_debug_basic &	set_PgmPath (const std::string &val)
	Sets the program file.
CCfg_debug_basic &	set_PresetPC (EPresetPC preset_mode, const std::string &symbol)
	Sets the PC preset for primary core.
CCfg_debug_basic &	set_Probe (const std::string &val)
	Sets the probe name.
CCfg_debug_basic &	set_ReplaceDir (const std::string &val)
	Sets the source file path remapping rules.
CCfg_debug_basic &	set_SymPath (const std::string &val)
	Sets the application's symbol file.
CCfg_debug_basic &	set_UseSymForPgm (bool val)
	specifies whether same file should be used for both symbolic information as well as FLASH/RAM programming

Member Enumeration Documentation

EPresetPC

enum class isys::CCfg_debug_basic::EPresetPC

strong

How to preset the PC.

Enumerator
none	PC is not preset. default SoC behaviour is used.
EntryPoint	PC for primary core is preset to the application's symbols file's entry point.
Address	PC for primary core is preset to strPresetPC.

Member Function Documentation

get_AppName()

std::string isys::CCfg_debug_basic::get_AppName

(

)

const

gets the application name

Returns

name of the application

get_CreateSMP()

bool isys::CCfg_debug_basic::get_CreateSMP

(

)

const

gets the SMP configuration

Returns

true if device cores are configured for SMP operation

get_Device()

std::string isys::CCfg_debug_basic::get_Device

(

)

const

gets the device(SoC) to use

Returns

manufacturer name of the device

get_DeviceName()

std::string isys::CCfg_debug_basic::get_DeviceName

(

)

const

gets the user name of the device(SoC)

Returns

user name of the device

get_PgmPath()

std::string isys::CCfg_debug_basic::get_PgmPath

(

)

const

gets the path to the program file

Returns

path to the program file

get_PresetPC()

EPresetPC isys::CCfg_debug_basic::get_PresetPC

(

)

const

gets the PC preset mode

Returns

EPresetPC the preset mode

get_PresetPC_symbol()

std::string isys::CCfg_debug_basic::get_PresetPC_symbol

(

)

const

gets the PC preset symbol

Returns

the preset symbol. used when preset mode is 'Symbol'

get_Probe()

std::string isys::CCfg_debug_basic::get_Probe

(

)

const

gets the probe name to use

Returns

probe name

get_ReplaceDir()

std::string isys::CCfg_debug_basic::get_ReplaceDir

(

)

const

gets the source file path remapping

Returns

source file path remapping rules string

get_SymPath()

std::string isys::CCfg_debug_basic::get_SymPath

(

)

const

gets the path to the application's symbol file

Returns

path to the application's symbol file

get_UseSymForPgm()

bool isys::CCfg_debug_basic::get_UseSymForPgm

(

)

const

gets the program file = symbol file setting

Returns

true if same file should be used for both symbolic information as well as FLASH/RAM programming

set_AppName()

CCfg_debug_basic & isys::CCfg_debug_basic::set_AppName

(

const std::string &

val

)

Sets the application name.

If this is not set, the default 'App' will be used. Setting a distinctive name is necessary when multiple applications are defined (in Full configuration mode)

Parameters

val	application name

set_CreateSMP()

CCfg_debug_basic & isys::CCfg_debug_basic::set_CreateSMP

(

bool

val

)

sets the SMP configuration

Parameters

val	true if applicable cores (those with identical core types) should be bound into SMP

set_Device()

CCfg_debug_basic & isys::CCfg_debug_basic::set_Device

(

const std::string &

val

)

Sets the device(SoC) to use.

This parameter is required.

Parameters

val	manufacturer name of the device

set_DeviceName()

CCfg_debug_basic & isys::CCfg_debug_basic::set_DeviceName

(

const std::string &

val

)

Sets the user name of the device(SoC).

If this parameter is not set, the manufacturer name will be used

Parameters

val	user name of the device

set_PgmPath()

CCfg_debug_basic & isys::CCfg_debug_basic::set_PgmPath

(

const std::string &

val

)

Sets the program file.

This is typically a hex or an Elf file containing target program image. If more than one program file is required, use CConfigurationController::ide_SoC_files

Parameters

val	path to the program file

set_PresetPC()

CCfg_debug_basic & isys::CCfg_debug_basic::set_PresetPC	(	EPresetPC	preset_mode,
		const std::string &	symbol )

Sets the PC preset for primary core.

Parameters

preset_mode	how to preset the PC
symbol	the symbol or numeric value to which the PC should be preset. used then ePresetPC is 'Symbol'

set_Probe()

CCfg_debug_basic & isys::CCfg_debug_basic::set_Probe

(

const std::string &

val

)

Sets the probe name.

This parameter is required when multiple connections from the debugger to the SoC are possible. Available probes are displayed in winIDEA. Typically this needs to be specified only if multiple Active Probes are used.

Parameters

val	probe name

set_ReplaceDir()

CCfg_debug_basic & isys::CCfg_debug_basic::set_ReplaceDir

(

const std::string &

val

)

Sets the source file path remapping rules.

Remapping is required when the Application was built on a different PC than the debug PC. ELF file then references files on the build PC and these cannot be found on the debug PC.

Parameters

val	source file path remapping rules string. "Syntax: [path old 1]=[path new 1];[path old 2]=[path new 2];... "Example: /usr/src/kernel/=../kernel-source/ "

set_SymPath()

CCfg_debug_basic & isys::CCfg_debug_basic::set_SymPath

(

const std::string &

val

)

Sets the application's symbol file.

This is typically the Elf file containing symbolic informatin. If more than one symbols file is required, use CConfigurationController::ide_app_files

Parameters

val	path to the application's symbol file

set_UseSymForPgm()

CCfg_debug_basic & isys::CCfg_debug_basic::set_UseSymForPgm

(

bool

val

)

specifies whether same file should be used for both symbolic information as well as FLASH/RAM programming

Parameters

val	true if same file should be used. In such case the path set with set_PgmPath is ignored