Home

CS+ V3.00.00 Integrated Development Environment User`s Manual

1. Hardware gt gt gt print info Enable True gt gt gt print info 0 Addressl testl c _maint 2 gt gt gt print info 0 Address2 None gt gt gt print info Number 2 gt gt gt print info Name Break0002 gt gt gt print info BreakType Hardware gt gt gt print info Enable False gt gt gt print info 1 Addressl test2 c _sub4 10 gt gt gt print info 1 Address2 None gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 157 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS BuildCompletedEventArgs This class holds the parameters when a build completes Type class BuildCompletedEventArgs Error None Cancelled False HasBuildError False HasBuildWarning False Variable Variable Description When an exception occurs in the build this holds the error contents Sys tem Exception Cancelled This holds whether the build execution was canceled or not HasBuildError This holds whether an error occurred in the build or not HasBuildWarning This holds whether a warning occurred in the build or not Detailed description BreakCompletedEventArgs is a class and it is passed as the argument only when the build BuildCompleted event is issued It is not therefore possible to generate an instance of this class Example of use gt gt gt def buildCompleted sender a print Error 0
2. gt gt gt debugger Watch Lue testVal WatchOption Hexdecimal 0x256 R20UT3097EJ0100 Rev 1 00 RENESAS Page 136 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Where This function displays a stack backtrace Specification format debugger Where Argument s None Return value List of a backtrace see the Stacklnfo property for detail Detailed description This function displays a stack backtrace Caution If Information below might be inaccurate is displayed then the information displayed below may not be reliable RL78 78KOR Example of use gt gt gt debugger Where 1 test2 c sub2 13 Information below might be inaccurate 2 func c func 34 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 137 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Whereami This function displays a location Specification format debugger Whereami address Argument s Argument Description address Specify the address of the location to display Return value Strings of the location Detailed description This function displays the location at the address specified by address The location is normally displayed in the following format file name function name at file name line number However if the function or line number at that address is not found
3. Example of use E TestFile TestScript testScriptFile2 py R20UT3097EJ0100 Rev 1 00 ztENESAS Page 17 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Save This function saves all editing files and projects Specification format Save Argument s None Return value If all editing files and projects were saved successfully True If there was an error when saving all editing files and projects False Detailed description This function saves all editing files and projects Example of use gt gt gt Save True Pee R20UT3097EJ0100 Rev 1 00 ztENESAS Page 18 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Source This function runs a script file Specification format Source scriptFile Argument s Argument Description scriptFile Specify the script file to run Return value None Detailed description This function runs the script file specified by scriptFile This function operates the same as execfile of IronPython Example of use gt gt gt Source testScriptFile2 py gt gt gt Source E TestFile TestScript testScriptFile py gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 19 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS B 3 2 CS Python function common Below is a list of CS Python functions c
4. Specification format debugger Memory ReadRange address count memoryOption MemoryOption Byte Argument s Argument Description address Specify the start address to reference count Specify the number of locations in memory for reference memoryOption Specify the display unit The units that can be specified are shown below Type Description MemoryOption Byte Byte unit 8 bits default MemoryOption HalfWord Half word unit 16 bits RH850 RX V850 MemoryOption Word Word unit RL78 78K 16 bits RH850 RX V850 32 bits Return value List of referenced memory value numeric value Detailed description This function displays in hexadecimal notation the number of values specified by count with the width in memory specified by memoryOption in the range from the address specified by address 32 bit cases respectively Example of use gt gt gt debugger Memory ReadRange 0x100 3 MemoryOption Word 0x00000011 Ox0000ff30 Ox0000ff40 gt gt gt mem debugger Memory ReadRange Oxlffffd 5 MemoryOption Byte 0x23 0x43 0x32 0x Ox gt gt gt print mem 35 67 50 None None R20UT3097EJ0100 Rev 1 00 ztENESAS Page 100 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Memory Write This function writes to the memory Specification format debugger Memory Write address value memoryOption M
5. AfterTraceMemoryFull Stop Stop execution stop the program accessStopExecution Set whether to instantaneously stop execution and make an access True Stop execution for a moment and make an access False Stop execution for a moment but do not make an access coverage Set whether to use the coverage function IECUBE IECUBE2 Simulator True Use the coverage function False Do not use the coverage function openBreak Set whether to use the open break function True Use the open break function False Do not use the open break function reuseCoverageData Set whether to reuse the coverage result True Reuse the coverage result False Do not reuse the coverage result Set whether to use the timer function True Use the timer function False Do not use the timer function R20UT3097EJ0100 Rev 1 00 ztENESAS Page 214 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Setting Description Set whether to use the trace function IECUBE IECUBE2 Simulator True Use the trace function False Do not use the trace function useTraceDataType Set which function to use the trace data in IECUBE V850 IECUBE2 The functions that can be specified are shown below Type Description UseTraceDataType RRM RRM function UseTraceDataType Trace Trace function UseTraceDataType Coverage Coverage function Reference Set value Caution If a PM worksp
6. Example of use gt gt gt libl alignment R1 gt gt gt secl append R_2 gt gt gt build Link SectionAlignment build Link LibraryFile Refer th secl gt gt gt print build Link SectionAlignment R Li RA2 gt gt gt gt gt gt sec2 Ro1 R 2t gt gt gt build Link SectionAlignment current setting and add section Set multiple section alignment sec2 gt gt gt print build Link SectionAlignment LR R2 R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 203 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS build Link SectionROMtoRAM This property sets or refers to the link options for the active project regarding sections where symbols are mapped from ROM to RAM CC RH CC RX CC RL Specification format build Link SectionROMtoRAM sectionlist Setting s Setting Description sectionlist Set the section that maps symbols from ROM to RAM as a list of strings Reference List of the section that maps symbols from ROM to RAM Detailed description This property sets or refers to the link options for the active project regarding sections where symbols are mapped from ROM to RAM Add or change for the referred list to change the setting Example of use gt gt gt sec build Link SectionROMtoRAM Refer the current setting and add the sec tion that maps symbols from ROM to RAM gt
7. debugger Memory ReadRange This function refers to the specified number of locations in memory debugger Memory Write This function writes to the memory debugger Memory WriteRange This function writes multiple data to the memory debugger Next This function performs procedure step execution debugger Register GetValue This function refers to register IO register SFR debugger Register SetValue This function sets the value of a register IO register SFR debugger Reset This function resets the CPU debugger ReturnOut This function runs until control returns to the program that called the current function debugger Run This function resets and then run the program debugger Step This function performs step execution debugger Stop This function stops the execution of the debug tool debugger Timer Clear This function clears the result measured by a conditional timer debugger Timer Delete This function deletes a conditional timer debugger Timer Disable This function disables a conditional timer debugger Timer Enable This function enables a conditional timer debugger Timer Get This function references the result measured by a conditional timer debugger Timer Information This function displays conditional timer information debugger Timer Set This function sets a conditional timer debugger Trace Clear
8. Vector 0 Priority 1 ActionEventType ActionEventType Printf Variable Variable Description Number This holds the action event number Name This holds the name of the action event Enable This holds whether the action event is enabled or not True Enabled False Disabled This holds the address of the action event This holds the string to be attached at output Caution This should be referenced only when ActionEventType is ActionEventType Printf Expression This holds the variable expression string Caution This should be referenced only when ActionEventType is ActionEventType Printf Vector This holds the interrupt vector number numerical value Caution This should be referenced only when ActionEventType is ActionEventType Interrupt Priority This holds the interrupt priority numerical value Caution This should be referenced only when ActionEventType is ActionEventType Interrupt ActionEventType This holds the type of the action event Type Description ActionEventType Printf Printf event ActionEventType Interrupt Interrupt event Detailed description ActionEventinfo is a class and it is passed as the return value when the debugger ActionEvent Information function is executed R20UT3097EJ0100 Rev 1 00 ztENESAS Page 151 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Example of u
9. Description ActionEventType Printf Printf event default ActionEventType Interrupt Interrupt event R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 149 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Detailed description ActionEventCondition is in class format and the action event condition is set in the variable In order to create an action event condition create an instance and set conditions for that instance Example of use gt gt gt ae ActionEventCondition Printf event gt gt gt ae Address 0x3000 gt gt gt ae Output chData gt gt gt ae Expression chData gt gt gt ae ActionEventType ActionEventType Printf gt gt gt debugger ActionEvent Set ae 1 gt gt gt gt gt gt ae ActionEventCondition Interrupt event gt gt gt ae Address 0x4000 gt gt gt ae Vector 10 gt gt gt ae Priority 2 gt gt gt ae ActionEventType ActionEventType Interrupt gt gt gt debugger ActionEvent Set ae 2 gt gt gt R20UT3097EJ0100 Rev 1 00 RENESAS Page 150 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS ActionEventInfo This class holds action event information return value of the debugger ActionEvent Information function Type class ActionEventInfo umber 0 ame Enable True Address Output Expression
10. For V850 specify either 8 16 or 32 For 78KOR IECUBE specify either 8 or 16 Specify the chip select default not specified When mapping emulation memory alternative ROM RAM in the IECUBE V850E1 specify the one of the following chip selects as a string cs0 cs1 cs2 cs3 cs4 cs5 cs6 or cs7 For models in the V850ES series however the chip select allocation is fixed or the chip select will not function so this can be omitted If chip select is specified then accessSize cannot be omitted Return value If memory mapping was configured successfully True If there was an error when configuring memory mapping False Detailed description This function configures memory mapping with the memory type specified by mapType R20UT3097EJ0100 Rev 1 00 ztENESAS Page 95 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Example of use gt gt gt debugger Map Set MapType EmulationRom 0x100000 Oxl0ffff True gt gt gt R20UT3097Ev0100 Rev 1 00 ztENESAS Page 96 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Memory Copy This function copies the memory Specification format debugger Memory Copy addressi address2 address3 Argument s Argument Description address1 Specify the start address to copy from address2 Specify the end address to copy from address3 Specify the address to cop
11. Specification format debugger Download HexIdTag fileName offset 0 append False flashErase False Argument s Argument Description fileName Specify a download file offset Specify an offset default 0 append Specify whether to make an additional download True Perform additional download False Perform overwrite download default flashErase Specify whether to initialize a flash memory before download True Initialize a flash memory before download False Do not initialize a flash memory before download default Caution If two or more parameters are specified then three parameters must be specified It is not possible to specify only fileName and offset Return value If a binary file was downloaded successfully True If there was an error when downloading a binary file False Detailed description This function downloads a hex file with ID tag Example of use gt gt gt debugger Download HexIdTag C test testModule hex True gt gt gt debugger Download HexIdTag C test testModule2 hex 0x1000 True False gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 76 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Download nformation This function displays download information Specification format debugger Download Information Argument s None Return value List of download information se
12. break name is PythonBreakxxxx xxxx 4 digit number Example of use gt gt gt Condition BreakCondition gt gt gt Condition Address main gt gt gt breakNumber debugger Breakpoint Set Condition 1 gt gt gt print breakNumber 1 gt gt gt debugger Breakpoin 1 PythonBreak0001 t Information Enable 0x000002dc R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 63 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Connect This function connects to the debug tool Specification format debugger Connect Argument s None Return value If the debug tool was connected successfully True If there was an error when connecting to the debug tool False Detailed description This function connects to the debug tool Example of use gt gt gt debugger Connect True Pee R20UT3097EJ0100 Rev 1 00 ztENESAS Page 64 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger DebugTool Change This function changes the debug tool Specification format debugger DebugTool Change debugTool Argument s Argument Description debugTool Specify the debug tool to change The debug tools that can be specified are shown below Type Description DebugTool Simulator Simulator DebugTool Minicube MINICUBE Debug Tool Minicube2 MINICUBE2 Serial connect
13. Break due to event Software Software break TraceFull Break due to trace full NonMap Access to non mapped area WriteProtect Write to write protected area TimerOver Execution timeout detected FlashMacroService Flash macro service active Temporary Temporary break lllegalOpcodeTrap Break due to illegal instruction exception Step Step execution breakNote 3 ExecutionFails Execution failedNote 4 Waitlnstruction Break caused by executing WAIT instruction UndefinedInstruction Exception Break caused by undefined instruc tion exception PrivilegelnstructionEx ception Break caused by privileged instruc tion exception AccessException Break caused by access exception FloatingPointException Break caused by floating point exception InterruptException Break caused by interrupt IntInstructionException Break caused by INT instruction exception BrkinstructionExcep tion R20UT3097EJ0100 Rev 1 00 Aug 01 2014 Break caused by BRK instruction exception Page 82 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS po x lt oO a m N Break trigger String Description levesoza Peroza penosa Beir 13 Joye NWIs z ajop ANOUN aope ANONUIN JOye NUWIS Joyejnuwa 9ads jnN4 IOFunctionSimulation Break caused by peripheral func Break tion simulat
14. Debug Tool Minicube2Jtag MINICUBE2 JTAG connect DebugTool lecube IECUBE Debug Tool lecube2 IECUBE2 DebugTool E1Jtag E1 JTAG connect DebugTool E1 Serial E1 Serial connect DebugTool E1Lpd E1 LPD connect DebugTool E20Jtag E20 JTAG connect DebugTool E20Serial E20 Serial connect DebugTool E20Lpd E20 LPD connect Return value If the debug tool was changed successfully True If there was an error when changing the debug tool False Detailed description This function changes the debug tool to the one specified by DebugTool However the debug tool that can be changed differs depending on the using device Select Debug Tool on the proj ect tree and select Using Debug Tool on the context menu And then confirm the debug tool that can be changed Caution It is possible to specify non selectable emulators Only specify emulators that can be selected in CS s debugging tool R20UT3097EJ0100 Rev 1 00 ztENESAS Page 65 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Example of use gt gt gt debugger DebugTool Change DebugTool Simulator True gt gt gt R20UT3097Ev0100 Rev 1 00 ztENESAS Page 66 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Debug Tool GetType This function displays information about the debug tool Specification format debugger DebugTool GetType Argume
15. Kind of active project Type Description Application Project for application Library Project for library DebugOnly Debug dedicated project Empty Project for empty application CppApplication Project for C application RI600V4 Project for RIG00V4 RI600PX Project for RIG00PX RI850V4 Project for RI850V4 RI850MP Project for RISSOMP RI78V4 Project for RI78V4 MulticoreBootLoader Project for boot loader for multi core MulticoreApplication Project for application for multi core Detailed description This property refers to the kind of the active project Example of use gt gt gt print project Kind Application gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 194 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project Name This property refers to the active project file name without path Specification format project Name Setting s None Reference Active project file name without path Detailed description This property refers to the active project file name without path Example of use gt gt gt print project Name test mtpj R20UT3097EJ0100 Rev 1 00 ztENESAS Page 195 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project Nickname This property refers to the nickname of the microcontroller of the active project Specification format
16. None Detailed description This function performs step execution If a function call is being performed then stop at the top of the function Example of use gt gt gt debugger Step gt gt gt debugger Step StepOption Instruction R20UT3097EJ0100 Rev 1 00 ztENESAS Page 109 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Stop This function stops the execution of the debug tool Specification format debugger Stop Argument s None Return value None Detailed description This function stops the execution of the debug tool Forcibly halt the program Example of use gt gt gt debugger Stop gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 110 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Timer Clear This function clears the result measured by a conditional timer Specification format debugger Timer Clear Argument s None Return value If the result measured by a conditional timer was cleared successfully True If there was an error when clearing the result measured by a conditional timer False Detailed description This function clears the result measured by a conditional timer Example of use gt gt gt debugger Timer Get 1 Total 2000 ns Pass Count 4 Average 500 ns Max 800 ns Min 300 ns gt gt gt debugger Timer Clear Tr
17. This function clears the trace memory debugger Trace Delete R20UT3097EJ0100 Rev 1 00 Aug 01 2014 This function deletes a conditional trace ztENESAS Page 47 of 225 CS V3 00 00 Function Name B Python CONSOLE Python FUNCTIONS Function Description debugger Trace Disable This function disables a conditional trace debugger Trace Enable This function enables a conditional trace debugger Trace Get This function dumps the trace data debugger Trace Information This function displays conditional trace information debugger Trace Set This function sets a conditional trace debugger Upload Binary This function saves the memory data in binary format debugger Upload Coverage This function saves the coverage data debugger Upload Intel This function saves the memory data in Intel format debugger Upload IntelldTag This function saves the memory data in ID tagged Intel format debugger Upload Motorola This function saves the memory data in Motorola format debugger Upload MotorolaldTag This function saves the memory data in ID tagged Motorola format debugger Upload Tektronix This function saves the memory data in Techtronics format debugger Upload TektronixldTag This function saves the memory data in ID tagged Techtronics format debugger Watch GetValue This function refers to a variable value debugger
18. This holds the timer event number Name This holds the name of the timer Enable This holds whether the timer is enabled or not True Enabled False Disabled StartAddress This holds the address starting timer measurement StartData This holds the data condition number of an address starting timer measurement StartTimerType This holds the type of timers which start timer measurement Type Description TimerType Execution Start a timer at execution TimerType Read Start a timer at data read TimerType Write Start a timer at data write TimerType Access Start a timer at data access EndAddress This holds the address ending timer measurement EndData This holds the data condition number of an address ending timer measurement EndTimerType This holds the type of timers which end timer measurement Type Description TimerType Execution End a timer at execution TimerType Read End a timer at data read TimerType Write End a timer at data write TimerType Access End a timer at data access R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 168 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Detailed description TimerEventinfo is a class and it is passed as the return value when the debugger Timer nformation function is exe cuted Example of use gt
19. main 0x00004088 F545 br _TestInit 0x8e gt gt gt debugger Assemble Disassemble 0x0000408A OAS5A mov Oxa r11 gt gt gt debugger Assemble LineAssemble main mov r13 r12 True gt gt gt debugger Assemble Disassemble main 1 False 0x00004088 mov r13 r12 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 58 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Breakpoint Delete This function deletes a break point Specification format debugger Breakpoint Delete breakNumber Argument s Argument Description breakNumber Specify the break event number to delete Return value If a break point was deleted successfully True If there was an error when deleting a break point False Detailed description This function deletes the break event specified by breakNumber If breakNumber is not specified then breaks of all break event numbers will be deleted Example of use gt gt gt debugger Breakpoint Enable 1 True gt gt gt debugger Breakpoint Disable 1 True gt gt gt debugger Breakpoint Delete 1 True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 59 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Breakpoint Disable This function disables a break point setting Specification format debugger Breakpoint Disable breakNumber Arg
20. CENESAS C n D TE 7 lt A 3 E D CS V3 00 00 Integrated Development Environment User s Manual Python Console Target Device 78KO Microcontroller RL78 Family 78KOR Microcontroller V850 Family RX Family RH850 Family All information contained in these materials including products and product specifications represents information on the product at the time of publication and is subject to change by Renesas Electronics Corp without notice Please review the latest information published by Renesas Electronics Corp through various means including the Renesas Electronics Corp website http www renesas com Renesas Electronics www renesas com Rev 1 00 2014 08 10 11 12 Notice Descriptions of circuits software and other related information in this document are provided only to illustrate the operation of semiconductor products and application examples You are fully responsible for the incorporation of these circuits software and information in the design of your equipment Renesas Electronics assumes no responsibility for any losses incurred by you or third parties arising from the use of these circuits software or information Renesas Electronics has used reasonable care in preparing the information included in this document but Renesas Electronics does not warrant that such information is error free Renesas Electronics assumes no liability whatsoever for any damages incurred
21. CS V3 00 00 B Python CONSOLE Python FUNCTIONS Example of use gt gt gt print debugger XTrace Addup False gt gt gt debugger XTrace Addup True gt gt gt print debugger XTrace Addup True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 218 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS B 3 11 CS Python event Below is a list of CS Python events Table B 11 CS Python Event Event Name Function Description build BuildCompleted This event informs that a build has been completed R20UT3097EJ0100 Rev 1 00 ztENESAS Page 219 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS build BuildCompleted This event informs that a build has been completed Handler format build BuildCompleted sender Handler argument s Argument Description The sender of the build event are passed The parameters at the end of build execution are passed Return value None Detailed description This event informs that a build has been completed Example of use gt gt gt def buildCompleted sender ya print Error 0 format e Error print BuildError e HasBuildError ToString print BuildWarning e HasBuildWarning ToString print BuildCancelled e Cancelled ToString gt gt gt build BuildCompleted buildCompleted Event connection gt
22. File Exists This function confirms whether the file exists in the active project Specification format project File Exists fileName Argument s Argument Description fileName Specify the full path of the file whose existence in the active project is to be checked Return value If the specified file existed in the active project True If the specified file did not exist in the active project False Detailed description This function confirms whether the file specified in fileName exists in the active project Example of use gt gt gt project File Exists C project sample src test c True Pee R20UT3097EJ0100 Rev 1 00 ztENESAS Page 32 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project File Information This function displays the list of the files registered in the active project Specification format project File Information Argument s None Return value List of the files registered in the active project in a full path Detailed description This function displays the list of the full path of the files registered in the active project Example of use gt gt gt project File Information C prj srce filel c C prj srce file2 c C prj srce file3 c gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 33 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project Fi
23. R20UT3097EJ0100 Rev 1 00 ztENESAS Page 10 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS B 3 CS Python Function Class Property Event This section describes CS Python functions classes and properties Below is a list of CS Python functions classes and properties CS Python functions have the following rules If a parameter has a default value then the Specification format parameter is described in the form parameter name default value You can also specify parameters by value only Example If the Specification format is function arg1 arg2 1 arg3 True then arg has no default value arg2 has a default value of 1 and arg3 has a default value of True The parameters can be specified as follows function main 1 True Parameters with default values can be omitted This is only possible however if the parameter can be determined Example If the Specification format is function arg arg2 1 arg3 True gt gt gt function main It is assumed that function main 1 True gt gt gt function main 2 It is assumed that function main 2 True gt gt gt function main arg3 False It is assumed that function main 1 False gt gt gt function main False NG because it is assumed that argl False arg2 main arg3 3 You can change the order in which parameters are specified by using the format parameter name def
24. This function starts CS s integrated help and displays the help for CS Python functions Example of use gt gt gt Help R20UT3097EJ0100 Rev 1 00 ztENESAS Page 15 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Hook This function registers a hook or callback function Specification format Hook scriptFile Argument s Argument Description scriptFile Specify the script file where the hook or callback function is defined Return value None Detailed description This function loads scriptFile and registers a hook or callback function in the script file There is no problem even if functions other than a hook or callback function are declared The hook or the callback function is registered when the script file is ended If Hook functions are declared they are called after CS events occur The types of hook function are shown below Note that hook functions do not take parameters Hook Function BeforeBuild Before build BeforeDownload Before download AfterDownload After download AfterCpuReset After CPU reset BeforeCpuRun Before execute AfterCpuStop After break AfterActionEvent After action event only Printf event Example Sample script file def BeforeDownload Processing you want to perform before the download Hook functions are initialized by the following operations When a project file
25. True gt gt gt debugger Memory Fill 0x2000 0x3000 Ox0A MemoryOption Word False gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 98 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Memory Read This function refers to the memory Specification format debugger Memory Read address memoryOption MemoryOption Byte Argument s Argument Description address Specify the address to reference memoryOption Specify the display unit The units that can be specified are shown below Type Description MemoryOption Byte Byte unit 8 bits default MemoryOption HalfWord Half word unit 16 bits RH850 RX V850 MemoryOption Word Word unit RL78 78K 16 bits RH850 RX V850 32 bits Return value Referenced memory value numeric value Detailed description This function displays the address specified by address according to memoryOption in hexadecimal format Example of use gt gt gt debugger Memory Read 0x100 0x10 gt gt gt value debugger Memory Read 0x100 0x10 gt gt gt print value 16 gt gt gt debugger Memory Read 0x100 MemoryOption HalfWord 0x0010 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 99 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Memory ReadRange This function refers to the specified number of locations in memory
26. V3 00 00 B Python CONSOLE Python FUNCTIONS debugger GetlOR List This function displays a list of the IORs and SFRs Specification format debugger GetIORList category Argument s Argument Description category Specify the category in which IORs and SFRs are defined default not specified Return value List of IOR and SFR information see the IORInfo class for detail Detailed description This function displays a list of the IORs and SFRs of the active project This function displays a list of the IORs and SFRs defined in category If category is not specified a list of all ORs and SFRs This function displays a list of the IORs and SFRs in the following format IOR or SFR name value type size address Example of use gt gt gt ior debugger GetIORList ADO ADDRA 0x0000 IOR 2 0x00088040 ADO ADDRB 0x0000 IOR 2 0x00088042 ADO ADDRC 0x0000 IOR 2 0x00088044 gt gt gt print ior 0 IORName ADO ADDRA gt gt gt print funcinfo 0 Type IOR gt gt gt print funcinfo 0 Address 557120 gt gt gt project GetIORList DMA0 DMACO DMCSA 0x00000000 IOR 4 0x00082000 DMACO DMMOD SMOD 0x0 IOR 3bits 0x8200c 12 DMACO DMMOD SZSEL 0x0 IOR 3bits 0x8200c 16 R20UT3097EJ0100 Rev 1 00 ztENESAS Page 86 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger GetPC This function displays the PC value Specification
27. format e Error print BuildError e HasBuildError ToString print BuildWarning e HasBuildWarning ToString print BuildCancelled e Cancelled ToString gt gt gt build BuildCompleted buildCompleted Event connection gt gt gt build All True Error None BuildError False BuildWarning False BuildCancelled False True gt gt gt When an exception occurs displayed as follows gt gt gt build All True Error System Exception An error occurred during build E0203001 BuildError False BuildWarning False BuildCancelled False False gt gt gt gt gt gt When a build error occurs displayed as follows gt gt gt build All True Error None R20UT3097EJ0100 Rev 1 00 ztENESAS Page 158 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS BuildError True BuildWarning False BuildCancelled False False gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 159 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Disassemblelnfo This class holds disassembly information return value of the debugger Assemble Disassemble function Type class DisassembleInfo Address 0 Code None Mnemonic None Variable Variable Description Address This holds the address Code This holds code information as a collection of bytes Mnemonic Th
28. gt gt build All True Error None BuildError False BuildWarning False BuildCancelled False True gt gt gt gt gt gt build File C sample src test1l c Error None BuildError False BuildWarning False BuildCancelled False True gt gt gt gt gt gt gt gt gt build Clean Error None BuildError False BuildWarning False BuildCancelled False True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 220 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS B 4 Cautions for Python Console 1 2 Caution for Japanese input The Japanese input feature cannot be activated from the Python Console To enter Japanese text write it in an external text editor or the like and copy and paste it into the console Caution for prompt displays The Python Console prompt of gt gt gt may be displayed multiply as gt gt gt gt gt gt or results may be displayed after the gt gt gt and there may be no gt gt gt prompt before the caret If this happens it is still possible to continue to enter functions Caution for executing scripts for projects without load modules If a script is specified in the startup options that uses a project without a load module file or if project_filename py is placed in the same folder as the project file then although the script will be executed automatically after normal project loading it will not be
29. gt gt debugger Breakpoint Delete 1 True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 61 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Breakpoint Information This function displays break point information Specification format debugger Breakpoint Information Argument s None Return value List of break point information see the Breakpointlnfo property for detail Detailed description This function displays the break point settings in the following format break event number break name state address location Example of use gt gt gt debugger Breakpoint Information 1 PythonBreak0001 Enable 0x000002dc Break0001 Enable testl c _subl 2 3 PythonBreak0002 Enable 0x000002ec 4 Break0002 Enable testl c _sub1 10 gt AS R20UT3097EJ0100 Rev 1 00 ztENESAS Page 62 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Breakpoint Set This function configures a break point Specification format debugger Breakpoint Set BreakCondition Argument s Argument Description BreakCondition Specify a break condition Return value Set break event number numerical value Detailed description See the BreakCondition property for details about creating break conditions This function sets a break point according to the specifications in BreakCondition
30. progName Specify the name of the load module containing the function If there is only one load module then this can be omitted default fileName Specify the name of the file containing the function If it is a global function then this can be omitted default Caution If two or more parameters are specified then three parameters must be specified Return value Value without numeric value Remark The results of function execution are displayed with a sign added Detailed description This function gets coverage for the function specified by funcName If there are multiple load modules specify progName In the case of a static function specify fileName Caution When a load module name progName or file name fileName is specified it needs to be enclosed in double quotation marks in some cases See CS Integrated Development Environment User s Manual Debug Tool for details Example When file name C path test c is specified C path test c Or C path test c Example of use gt gt gt debugger XCoverage GetCoverage TestInit C test Test out C test Test c 81 50 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 140 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger XRunBreak Delete This function deletes XRunBreak information V850 Simulator Specification format debugger XRunBreak Del
31. project Nickname Setting s None Reference Nickname of the microcontroller of the active project Detailed description This property refers to the nickname of the microcontroller of the active project Example of use gt gt gt print project Nickname RL78 G13 ROM 64KB R20UT3097EJ0100 Rev 1 00 ztENESAS Page 196 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project Path This property refers to the active project file name with path Specification format project Path Setting s None Reference Active project file name with path Detailed description This property refers to the active project file name with path Example of use gt gt gt print project Path C project test mtpj R20UT3097EJ0100 Rev 1 00 ztENESAS Page 197 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS B 3 9 CS Python property for build tool Below is a list of CS Python properties for the build tool Table B 9 CS Python Property For Build Tool Property Name Function Description build Compile IncludePath This property sets or refers to the compile options for the active project regarding additional include paths build Compile Macro This property sets or refers to the compile options for the active project regarding defined macros build IsBuilding This property confirms whether a build is run
32. then the location is displayed in the following for mat at symbol namet offset value If the symbol is not found then the location is displayed in the following format at address value If address is omitted then the location of the pc value is displayed Example of use gt gt gt debugger Whereami foo c func at foo c 100 gt gt gt debugger Whereami 0x100 foo c main at foo c 20 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 138 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger XCoverage Clear This function clears the coverage memory IECUBE IECUBE2 Simulator Specification format debugger XCoverage Clear Argument s None Return value If the coverage memory was cleared successfully True If there was an error when clearing the coverage memory False Detailed description This function clears the coverage memory Example of use gt gt gt debugger XCoverageClear True Pee R20UT3097EJ0100 Rev 1 00 ztENESAS Page 139 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger XCoverage GetCoverage This function gets the coverage IECUBE IECUBE2 Simulator Specification format debugger XCoverage GetCoverage funcName progName fileName Argument s Argument Description funcName Specify the function name to retrieve coverage for
33. 123 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Trace Set This function sets a conditional trace Specification format debugger Trace Set TraceCondition Argument s Argument Description TraceCondition Specify a condition of a conditional trace Return value See the TraceCondition class for creating a conditional trace Set trace event number numerical value Detailed description This function sets a conditional trace according to the contents specified with TraceCondition The specified conditional trace is registered with the following name Trace Example of use gt gt gt te TraceCondition gt gt gt tc StartAddress main gt gt gt tc EndAddress chData gt gt gt tc EndData 0x20 gt gt gt tc EndTraceType TraceType Writ gt gt gt ts_number debugger Trace Set tc 1 gt gt gt print ts_number 1 R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 124 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Upload Binary This function saves the memory data in binary format Specification format debugger Upload Binary fileName addressl1 address2 force False Argument s Argument Description fileName Specify a file name address1 Specify an upload start address address2 Specify an upload end address
34. 49 211 6503 1327 Renesas Electronics China Co Ltd Room 1709 Quantum Plaza No 27 ZhiChunLu Haidian District Beijing 100191 P R China Tel 86 10 8235 1155 Fax 86 10 8235 7679 Renesas Electronics Shanghai Co Ltd Unit 301 Tower A Central Towers 555 Langao Road Putuo District Shanghai P R China 200333 Tel 86 21 2226 0888 Fax 86 21 2226 0999 Renesas Electronics Hong Kong Limited Unit 1601 1613 16 F Tower 2 Grand Century Place 193 Prince Edward Road West Mongkok Kowloon Hong Kong Tel 852 2265 6688 Fax 852 2886 9022 9044 Renesas Electronics Taiwan Co Ltd 13F No 363 Fu Shing North Road Taipei 10543 Taiwan Tel 886 2 8175 9600 Fax 886 2 8175 9670 Renesas Electronics Singapore Pte Ltd 80 Bendemeer Road Unit 06 02 Hyflux Innovation Centre Singapore 339949 Tel 65 6213 0200 Fax 65 6213 0300 Renesas Electronics Malaysia Sdn Bhd Unit 906 Block B Menara Amcorp Amcorp Trade Centre No 18 Jin Persiaran Barat 46050 Petaling Jaya Selangor Darul Ehsan Malaysia Tel 60 3 7955 9390 Fax 60 3 7955 9510 Renesas Electronics Korea Co Ltd 12F 234 Teheran ro Gangnam Ku Seoul 135 920 Korea Tel 82 2 558 3737 Fax 82 2 558 5141 2014 Renesas Electronics Corporation and Renesas Solutions Corp All rights reserved Colophon 3 0 CS V3 00 00 RENESAS Renesas Electronics Corporation R20UT3097EJ0100
35. FUNCTIONS ActionEventCondition This class creates an action event condition Type class Ac Variable tionEventCondition Address Output T Expression Vector 0 Priority 1 ActionEventType ActionEventType Printf Variable ActionEventType Specification Description Address ActionEventType Printf Specify an address of an action event Must be specified ActionEventType Interrupt Specify an address of an action event Must be specified ActionEventType Printf Specify a string to be attached at output ActionEventType Interrupt Ignored Expressi on ActionEventType Printf Specify a variable expression Up to ten can be specified by delimiting them with a comma ActionEventType Interrupt Ignored ActionEventType Printf Ignored ActionEventType Interrupt Specify the interrupt vector number RX Simu lator Specify a value between the range from 0 to 255 Priority ActionEventType Printf Ignored ActionEventType Interrupt Specify the interrupt priority RX Simulator Specify a value between the range from 0 to 255 The specifiable range differs for each series See CS Integrated Development Environ ment User s Manual RX Debug Tool for details ActionEv entType Specify the action event type The break types that can be specified are shown below Type
36. Manual This manual describes the role of the CS integrated development environment for developing applications and sys tems for RH850 family RX family V850 family RL78 family 78KOR microcontrollers and 78KO microcontrollers and pro vides an outline of its features CS is an integrated development environment IDE for RH850 family RX family V850 family RL78 family 78KOR microcontrollers and 78KO microcontrollers integrating the necessary tools for the development phase of software e g design implementation and debugging into a single platform By providing an integrated environment it is possible to perform all development using just this product without the need to use many different tools separately Readers Purpose Organization How to Read This Manual Conventions This manual is intended for users who wish to understand the functions of the CS and design software and hardware application systems This manual is intended to give users an understanding of the functions of the CS to use for reference in developing the hardware or software of systems using these devices This manual can be broadly divided into the following units 1 GENERAL 2 FUNCTIONS A WINDOW REFERENCE B Python CONSOLE Python FUNCTIONS It is assumed that the readers of this manual have general knowledge of electricity logic circuits and microcontrollers Data significance Higher digits on the left and lower digits on the rig
37. Rev 1 00 ztENESAS Page 208 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS B 3 10 CS Python property for debug tool Below is a list of CS Python properties for the debug tool Table B 10 CS Python Property For Debug Tool Property Name Function Description debugger ActionEvent GetLine This property sets or refers to the number of action event results debugger ADConvertDatalnExecution This property sets or refers to data collected in debugging debugger IsMulticore This property checks whether or not the microcontroller of the active proj ect is multi core debugger Memory NoVerify This property switches the write time verification setting debugger Option AccessStopExecution This property sets or refers to the options of the debug tool debugger Option AfterTraceMemoryFull debugger Opiton Coverage debugger Option OpenBreak debugger Option ReuseCoverageData debugger Option Timer debugger Option Trace debugger Option UseTraceData debugger ProcessorElement This property sets or refers to the PE of the multi core debugger XTrace Addup This property sets or refers to the tracing options of the debug tool debugger XTrace Complement debugger XTrace Mode R20UT3097EJ0100 Rev 1 00 ztENESAS Page 209 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger ActionEvent GetLine This property sets or refers to the number of action event
38. This class creates an action event condition ActionEventInfo This class holds action event information ActionInfo This class holds result information of the action event BreakCondition This class creates a break condition BreakpointInfo This class holds break point information BuildCompletedEventArgs This class holds the parameters when a build completes Disassemblelnfo This class holds disassembly information DownloadInfo This class holds download information FunctionI Info This class holds function information IORInfo This class holds IOR and SFR information MapInfo This class holds map information StackInfo This class holds stack information TimerCondition This class creates conditions of a conditional timer TimerEventinfo This class holds conditional timer event information TimerInfo This class holds conditional timer information TraceCondition This class creates conditions of a conditional trace TraceEventinfo This class holds conditional trace event information Tracelnfo This class holds trace information Variablelnfo This class holds variable information XRunBreakinfo This class holds XRunBreak information XTimelnfo R20UT3097EJ0100 Rev 1 00 Aug 01 2014 This class holds timer information ztENESAS Page 148 of 225 CS V3 00 00 B Python CONSOLE Python
39. This function downloads a load module debugger Erase This function erases the Flash memory debugger GetBreakStatus This function displays a break condition debugger GetCpuStatus This function displays the current CPU status debugger GetleStatus R20UT3097EJ0100 Rev 1 00 Aug 01 2014 This function displays the current IE status ztENESAS Page 46 of 225 CS V3 00 00 Function Name B Python CONSOLE Python FUNCTIONS Function Description debugger GetlORList This function displays a list of the IORs and SFRs debugger GetPC This function displays the PC value debugger Go This function continues program execution debugger le GetValue debugger le SetValue This function sets or refers to the IE register or DCU register debugger lsConnected This function checks the connection status of the debug tool debugger I sRunning This function checks the execution status of the debug tool debugger Jump File debugger Jump Address This function displays each panel debugger Map Clear This function clears the mapping settings debugger Map Information This function displays map information debugger Map Set This function configures memory mapping debugger Memory Copy This function copies the memory debugger Memory Fill This function fills the memory debugger Memory Read This function refers to the memory
40. This function saves the memory data from address to address2 in D tagged Intel format Example of use gt gt gt debugger Upload IntellIdTag C test testIidTagIntel hex 0x1000 0x2000 True True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 128 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Upload Motorola This function saves the memory data in Motorola format Specification format debugger Upload Motorola fileName addressl address2 force False Argument s Argument Description fileName Specify a file name address1 Specify an upload start address address2 Specify an upload end address force Specify whether to overwrite True Overwrite False Do not overwrite default Return value If the memory data was uploaded successfully True If there was an error when uploading the memory data False Detailed description This function saves the memory data from address to address2 in Motorola format Example of use gt gt gt debugger Upload Motorola C test testMotorola hex 0x1000 0x2000 True True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 129 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Upload MotorolaldTag This function saves the memory data in ID tagged Motorola format Specification format debugger Upload MotorolaIdTag fileNa
41. an action event Return value Set action event number numerical value Detailed description This function sets an action event according to the contents specified with ActionEventCondition The specified action event is registered with the following name Python Action Eventnumerical value Example of use gt gt gt ae ActionEventCondition gt gt gt ae Address main gt gt gt ae Output chData gt gt gt ae Expression chData gt gt gt ae ActionEventType ActionEventType Printf gt gt gt ae_number debugger ActionEvent Set ae 1 gt gt gt print ae_number 1 R20UT3097EJ0100 Rev 1 00 RENESAS Aug 01 2014 Page 55 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Address This function evaluates an address expression Specification format debugger Address expression Argument s Argument Description expression Specify an address expression Return value Converted address numerical value Detailed description This function converts the address expression specified by expression into the address Caution 1 If a script is specified to execute in the CubeSuite exe startup options then the symbol conversion func tion will not be available until the debugging tool is connected In other words this function cannot be used so execute it after connection Caution 2 When a load
42. an exception during the Python function is executed Specification format common ThrowExcept bool Setting s Setting Description Set whether to throw an exception during the Python function is executed True Throw an exception False Do not throw an exception default Reference Current set value Detailed description This property sets or refers to whether to throw an exception during the Python function is executed To use the try except statement set bool to True Example of use gt gt gt print common ThrowExcept False gt gt gt common ThrowExcept True R20UT3097EJ0100 Rev 1 00 ztENESAS Page 186 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS common UseRemoting This property sets and displays the setting for enabling or disabling the function for linking to an external tool at CS startup Specification format common UseRemoting bool Setting s Setting Description Set whether to enable or disable the function for linking to an external tool at CS startup True Enable the function for linking to an external tool default False Disable the function for linking to an external tool This will be True if the common EnableRemotingStartup property is set to True on startup and False otherwise Reference Current set value Detailed description This property sets and displays the s
43. gt gt info debugger Timer Information 1 PythonTimer0001 gt gt gt print info 0 1 gt gt gt print info 0 PythonTimer0001 gt gt gt print info 0 True gt gt gt Enable Number Name Enable main sub R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 169 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Timerl nfo This class holds conditional timer information return value of the debugger Timer Get function Type class TimerInfo Number 0 MaxTime 0 MaxClockCount IsMaxOverflow MinTime 0 MinClockCount IsMinOverflow AverageTime 0 False AverageClockCount IsAverageOverflow TotalTime 0 TotalClockCount 0 IsTotalOverflow Fals PassCount 0 IsPassCountOverflow Fals Variable Variable Description Number This holds the timer event number MaxTime This holds the maximum execution time MaxClockCount This holds the maximum number of clocks to be executed IsMaxOverflow This holds whether the maximum execution time or number of clocks was over flowed True The maximum execution time or number of clocks was overflowed False The maximum execution time or number of clocks was not overflowed MinTime This holds the minimum execution time MinClockCount This holds the minimum number of clocks to be executed IsMinOverflow This holds whether
44. gt gt print sec D R D_1 R_1 D_2 R_2 gt gt gt sec append D_3 R_3 gt gt gt build Link SectionROMtoRAM sec gt gt gt print build Link SectionROMtoRAM D R D_1 R_1 D_2 R_2 D_3 R_3 R20UT3097EJ0100 Rev 1 00 ztENESAS Page 204 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS build Link SectionStartAddress This property sets or refers to the link options for the active project regarding the addresses where sections start CC RH CC RX CC RL Specification format build Link SectionStartAddress section Setting s Setting Description section Set the start address of the section as strings Reference Start address of the section strings Detailed description This property sets or refers to the link options for the active project regarding the addresses where sections start Add or change for the referred strings to change the setting Example of use gt gt gt sec build Link SectionStartAddress Refer the current setting and change the start address of the section gt gt gt print sec B_1 R_1 B_2 R_2 B R SU SI 01000 PReset PRG OFFFF8000 gt gt gt sec B_1 0200 R_1 B_2 R_2 B R SU SI 01000 PResetPRG 0FFFF8000 gt gt gt build Link SectionStartAddress sec gt gt gt print build Link SectionStartAddress B_1 0200 R_1 B_2 R_2 B R SU SI 01000 PResetPRG 0FFFF8000 R20UT3097EJ0100 Rev 1 0
45. is the value of the ROMization pro cess option for the active project CA850 CX CA78KOR Specification format build ROMization OutputObjectFile bool Setting s Setting Description Set whether or not to output the ROMized object file True Output the ROMized object file False Do not output the ROMized object file Reference If the ROMized object file is output True If the ROMized object file is not output False If the compiler is not supported None Detailed description This property sets or refers to the setting for output of a ROMized object file that is the value of the ROMization pro cess option for the active project Example of use gt gt gt setting build ROMization OutputObjectFile gt gt gt print setting True gt gt gt build ROMization OutputObjectFile Fals gt gt gt print build ROMization OutputObjectFile False R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 207 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS build Version This property refers to the version of the compiler package Specification format build Version Setting s None Reference Version of compiler package used in active project Detailed description This property refers to the version of the compiler package used in the active project Example of use gt gt gt print build Version v2 00 00 R20UT3097EJ0100
46. is loaded When a new project file is created When the active project is changed When the debugging tool is switched When Python is initialized R20UT3097EJ0100 Rev 1 00 ztENESAS Page 16 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS If Callback functions are declared they are called after CS events occur The name of the callback function is pythonConsoleCallback The parameter of the callback function is the callback trigger Argument Value Callback Trigger After event registration After event deletion Before start of execution After break After CPU reset After debug tool properties are changed Before download After memory or register is changed After action event only Printf event Before build After time specified by XRunBreak has elapsed Example Sample script file def pythonConsoleCallback Id if Id 63 Processing you want to perform after time specified by XRunBreak has elapsed Caution 1 Do not use the following functions in the callback function debugger Reset function debugger Run function debugger Breakpoint function Caution 2 Itis not possible to call debugger XRunBreak Set with different conditions in the callback function Do not make a specification like the following def pythonConsoleCallback Id if Id 63 debugger XRunBreak Delete debugger XRunBreak Set 1 TimeType Ms True
47. of the active project shown by the following format function name return value type start address end address file nam When fileName is specified only the functions included in the specified file are displayed When fileName is not specified then all the functions will be displayed Caution This function uses the information displayed in the list of functions for program analysis Example of use gt gt gt project GetFunctionList funcl int 0x00200 0x00224 C project srce testl c func2 int 0x00225 0x002ff C project srce test2 c gt gt gt project GetFunctionList C project src testl c funcl int 0x00200 0x00224 C project sre testl c gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 36 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project GetVariableList This function displays the list of the variables of the active project Specification format project GetVariableList fileName Argument s Argument Description fileName Specify the full path of the file that the list of the variables are displayed default not specified Return value List of variable information see the Variablelnfo property for detail Detailed description This function displays the list of the variables of the active project shown by the following format variable name attribute type address size file nam When fileName is specified only
48. result matching output is output Comparison is performed to detect a perfect match If output is not specified the results of all accumulated action events are output To acquire the result at the timing when an action event has occurred use Hook For the maximum number of results that can be held in the Python console see the debugger ActionEvent GetLine property Caution After a result has been referenced the result of the action event which was held in the Python console is initialized Therefore once a result has been referenced it cannot be referenced again The result of an action event is displayed in the following format string to be attached at output variable expression R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 52 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Example of use gt gt gt ae ActionEventCondition gt gt gt ae Address main gt gt gt ae Output result gt gt gt ae Expression chData gt gt gt ae ActionEventType ActionEventType Printf gt gt gt ae_number debugger ActionEvent Set ae gt gt gt out debugger ActionEvent Get result chData 0x64 result chData 0x65 result chData 0x66 gt gt gt print out 0 Address main gt gt gt print out 0 Expression chData 0x64 R20UT3097Ev0100 Rev 1 00 ztENESAS Page 53 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger
49. results Specification format debugger ActionEvent GetLine number Setting s Setting Description number Set the number of action event results that can be held in the Python console default 10000 Reference Current set value Detailed description This property sets or refers to the number of action event results that can be held in the Python console If the number that was set is exceeded action event results cannot be held Deletion is performed from old action events The valid range is from 5000 to 100000 Example of use gt gt gt print debugger ActionEvent GetLine 10000 gt gt gt debugger ActionEvent GetLine 50000 gt gt gt print debugger ActionEvent GetLine 50000 R20UT3097EJ0100 Rev 1 00 ztENESAS Page 210 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger ADConvertDatalnExecution This property sets or refers to data collected in debugging Smart Analog Specification format debugger ADConvertDataInExecution adConvertDataInExecution Setting s Setting Description adConvertDatalnExecution Set whether to collect data during debugging True Collect data during debugging False Do not collect data during debugging Reference Setting for data collection during execution Detailed description This property sets or refers to data collected in debugging Exampl
50. the following format timer event number Total total execution time ns Pass Count pass count Average average execution time ns Max maximum execution time ns Min minimum execution time ns Example of use gt gt gt debugger Timer Get 1 Total 2000 ns Pass Count 4 Average 500 ns Max 800 ns Min 300 ns gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 115 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Timer Information This function displays conditional timer information Specification format debugger Timer Information Argument s None Return value List of conditional timer event information see the TimerEventinfo class for detail Detailed description This function displays conditional timer information displays in the following format timer event number timer name state start address nd address Example of use gt gt gt ti debugger Timer Information 1 PythonTimer0001 Enable main sub gt gt gt print ti 0 Number al gt gt gt print ti 0 Name PythonTimer0001 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 116 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Timer Set This function sets a conditional timer Specification format debugger Timer Set TimerCondition Argument s Argument Description TimerCondi
51. the func tion for linking to an external tool at CS startup common Output This property refers to the return value or the contents of an error of the CS Python function common ThrowExcept This property sets or refers to whether to throw an exception during the Python function is executed common UseRemoting This property sets and displays the setting for enabling or disabling the func tion for linking to an external tool at CS startup common Version This property refers to the version of CS common ViewLine This property sets or refers to the number of screen lines for the Python con sole common ViewOutput R20UT3097EJ0100 Rev 1 00 Aug 01 2014 This property sets and displays the setting for whether or not to display results of Python functions for CS and error messages in the Python con sole ztENESAS Page 181 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS common ExecutePath This property refers to the absolute path of the folder containing the exe file of the currently running CS Specification format common ExecutePath Setting s None Reference Absolute path of the folder containing the exe file of the currently running CS Detailed description This property refers to the absolute path of the folder containing the exe file CubeSuiteW exe or CubeSuite exe of the currently running CS Example of use gt
52. the timer event specified by timerNumber If timerNumber is not specified then timers of all timer event numbers will be disabled Example of use gt gt gt debugger Timer Disable 1 True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 113 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Timer Enable This function enables a conditional timer Specification format debugger Timer Enable timerNumber Argument s Argument Description timerNumber Specify the timer event number to enable Return value If a timer setting was enabled successfully True If there was an error when enabling a timer setting False Detailed description This function enables the timer of the timer event specified by timerNumber If timerNumber is not specified then timers of all timer event numbers will be enabled Example of use gt gt gt debugger Timer True 22 gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 114 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Timer Get This function references the result measured by a conditional timer Specification format debugger Timer Get Argument s None Return value List of conditional timer information see the Timerlnfo class for detail Detailed description The result measured by a conditional timer is shown by
53. the variables included in the specified file are displayed When fileName is not specified then all the variables will be displayed Caution This function uses the information displayed in the list of variables for program analysis Example of use gt gt gt project GetVariableList varl volatile int 0x000014e4 4 C project srce testl c var2 static int 0x000014e8 4 C project srce test2 c gt gt gt project GetVariableList C project src testl c varl volatile int 0x000014e4 4 C project srce testl c gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 37 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project Information This function displays the list of project files Specification format project Information Argument s None Return value List of project file names Detailed description This function displays the list of project files of the main project and subprojects included in the loaded project Example of use gt gt gt project Information C project sample test mtpj C project sample subl1 sublproject mtsp C project sample sub2 sub2project mtsp gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 38 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project Open This function opens a project Specification format project Open fileName save False Argument s Argument Desc
54. to non mapped area o o o o o o WriteProtect Write to write protected area o o o o 0 o ReadProtect Read from read protected o 5 E E area Sfrlllegal Illegal SFR access o z E SfrReadProtect Read from non readable o o SFR SfrWriteProtect Write to non writable SFR o o lorillegal Illegal access to peripheral I 3 z o 2 O register with address R20UT3097EJ0100 Rev 1 00 tENESAS Page 80 of 225 Aug 01 2014 CS V3 00 00 Break trigger String Description B Python CONSOLE Python FUNCTIONS RL78 78KOR ajonZOANOIUI Joye NWIS ajonZOQNOIUI Joyejnwis z ayop NOUIN ajonZOQNoIUlyy Joyejnwis StackOverflow Break due to stack overflow StackUnderflow Break due to stack underflow UninitializeStackPointer Break due to uninitialized stack pointer UninitializeMemoryRead Read uninitialized memory TimerOver Execution timeout detected Unspecifiedlllegal Illegal operation in user pro gram relating to peripheral chip features Imslxslllegal Break due to illegal write to IMS IXS register BeforeExecution Pre execution break SecurityProtect Accessed security protected region FlashMacroService Flash macro service active RetryOver Number of retries exceeded limit Flashlllegal Illegal Flash break Peripheral Break from peripheral WordMis
55. value If a binary file was downloaded successfully True If there was an error when downloading a binary file False Detailed description This function downloads coverage data Example of use gt gt gt debugger Download Coverage C test testModule csrcv True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 72 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Download Hex This function downloads a hex file Specification format debugger Download Hex fileName offset 0 append False flashErase False Argument s Argument Description fileName Specify a download file offset Specify an offset default 0 append Specify whether to make an additional download True Perform additional download False Perform overwrite download default flashErase Specify whether to initialize a flash memory before download True Initialize a flash memory before download False Do not initialize a flash memory before download default Caution If two or more parameters are specified then three parameters must be specified It is not possible to specify only fileName and offset Return value If a binary file was downloaded successfully True If there was an error when downloading a binary file False Detailed description This function downloads data in hex format Example of use gt gt gt debugger Downlo
56. 0 IOR 2 0x00088044 gt gt gt prin t ior 0 IORName ADO ADDRA gt gt gt prin IOR gt gt gt prin 557120 t funcinfo 0 Type t funcinfo 0 Address R20UT3097EJ0100 Rev 1 00 ztENESAS Page 163 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS MapInfo This class holds map information return value of the debugger Map Information function Type class MapInfo umber 0 StartAddress EndAddress AccessSize apTypeName None Variable Variable Description Number This holds the number StartAddress This holds the start address of the map area EndAddress This holds the end address of the map area AccessSize This holds the access size of the map area apTypeName This holds the type name of the map area Detailed description MapInfo is a class and it is the structure of the return value from the debugger Map nformation function Example of use gt gt gt info debugger Map Information Execute Map Information function 0x00000000 Ox0003FFFF 32 Internal ROM area 0x00040000 Ox00048FFF 8 Non map area 0x00049000 Ox001003FF 8 Emulation ROM area 0x00100400 Ox03FF8FFF 8 Non map area 0 0 gt Ox03FF90 OxO3FFEFFF 32 Internal RAM area Ox03FFFO OxO3FFFFFF 8 I O register area gt gt gt print info StartAddress 0 gt gt gt print info 0 EndAddress 262143 gt gt gt print info AccessSi
57. 0 ztENESAS Page 205 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS build Link SectionSymbolFile This property sets or refers to the link options for the active project regarding sections whose external defined symbols are to be output to a file CC RH CC RX CC RL Specification format build Link SectionSymbolFile sectionlist Setting s Setting Description sectionlist Set the section whose external defined symbols are output to a file as a list of strings Reference List of the section whose external defined symbols are output to a file Detailed description This property sets or refers to the link options for the active project regarding sections whose external defined sym bols are to be output to a file Add or change for the referred list to change the setting Example of use gt gt gt sec build Link SectionSymbolFile Refer the current setting and add the sec tion whos xternal defined symbols are output to a file gt gt gt print sec IRT WRe2 gt gt gt sec append R_3 gt gt gt build Link SectionSymbolFile sec gt gt gt print build Link SectionSymbolFile PRE TR 2 TRS R20UT3097EJ0100 Rev 1 00 ztENESAS Page 206 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS build ROMization OutputObjectFile This property sets or refers to the setting for output of a ROMized object file that
58. 0UT3097EJ0100 Rev 1 00 ztENESAS Page 120 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Trace Enable This function enables a conditional trace Specification format debugger Trace Enable traceNumber Argument s Argument Description traceNumber Specify the trace event number to enable Return value If a trace setting was enabled successfully True If there was an error when enabling a trace setting False Detailed description This function enables the timer of the trace event specified by traceNumber If traceNumber is not specified then traces of all trace event numbers will be enabled Example of use gt gt gt debugger Trace enable 1 True 22 gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 121 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Trace Get This function dumps the trace data Remark This function provides the same function as debugger XTrace Dump Specification format debugger Trace Get frameCount fileName append False Argument s Argument Description frameCount Specify the number of dumps fileName Specify the name of the file to dump to default not specified append Specify whether to append trace data to the file True Append trace data to the file False Do not append trace data to the file default Return v
59. 2 ReadAddress 0x000002c2 0x000002c6 0x000002ca 0x000002ce 0x000002d2 0x000002dc 0x00000312 0x00000316 movhi Oxffff gp rl id w Ox7 f4 rl r6 Ox03ff9000 R movhi Oxffff gp rl movea Ox7ff8 rl r7 jarl _main 0x36 br _main 0x36 prepare lp 0x4 Ox03ff9308 W br _main4 R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 177 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Variablelnfo This class holds variable information return value of the project GetVariableList function Type class VariableInfo VariableName None FileName None Attribute None Type None Address None Size None Variable Variable Description VariableName This holds the variable name FileName This holds the full path of the file that the variable is defined Attribute This holds the attribute Type This holds the type Address This holds the address Size This holds the size Detailed description Variablelnfo is a class and it is the structure of the return value from the project GetVariableList function Example of use gt gt gt info project GetVariableList varl volatile int 0x000014e4 4 C project srce testl c var2 static int 0x000014e8 4 C project sre test2 c gt gt gt print info 0 VariableName varl gt gt gt print info 1 FileName C project srce test2 c gt gt gt print info 0 Attribute volatile g
60. 5 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS build Update This function updates the dependencies for the build tool Specification format build Update Argument s None Return value None Detailed description This function updates the dependencies of the files during build Example of use gt gt gt build Update gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 45 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS B 3 5 CS Python function for debug tool Below is a list of CS Python functions for the debug tool Table B 5 CS Python Function For Debug Tool Function Name Function Description debugger ActionEvent Delete This function deletes an action event debugger ActionEvent Disable This function disables an action event setting debugger ActionEvent Enable This function enables an action event setting debugger ActionEvent Get This function references the result of the action event Printf event debugger ActionEvent Information This function displays action event information debugger ActionEvent Set This function sets an action event debugger Address This function evaluates an address expression debugger Assemble Disassemble This function performs disassembly debugger Assemble LineAssemble This function performs line assembly debugger Bre
61. ActionEvent Information This function displays action event information Specification format debugger ActionEvent Information Argument s None Return value List of action event information see the ActionEventinfo class for detail Detailed description This function displays information on the action event that has been set in the following format For the Printf event action event number action event name state address string to be attached at output variable expression For the interrupt event action event number action event name state address Interrupt vector interrupt vector number Priority level interrupt priority Example of use gt gt gt ai debugger ActionEvent Information 1 Python Action Event0001 Enable main results chData 2 Python Action Event0002 Disable sub Interrupt vector Oxlc Priority level 7 gt gt gt print ai 0 Number 1 gt gt gt print ai 0 Name Python Action Event0001 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 54 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger ActionEvent Set This function sets an action event Specification format debugger ActionEvent Set ActionEventCondition Argument s Argument Description ActionEventCondition Specify a condition of an action event See the ActionEventCondition class for creating
62. BreakpointInfo umber 0 ame None Enable True BreakType BreakType Hardware Addressl None Address2 None Address3 None Address4 None Variable Variable Description This holds the event number This holds the name of the break point This holds whether the break point is enabled or not True Enabled False Disabled BreakType This holds the break type Type Description BreakType Software Software break except a simulator BreakType Hardware Hardware break BreakType Read Data read break BreakType Write Data write break Addressl This holds address information 1 as a string Address2 This holds address information 2 as a string Only for combined breaks Address3 This holds address information 3 as a string Only for combined breaks Address4 This holds address information 4 as a string Only for combined breaks Detailed description Breakpointlnfo is a class and it is passed as the return value when the debugger Breakpoint Information function is executed R20UT3097EJ0100 Rev 1 00 ztENESAS Page 156 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Example of use gt gt gt info debugger Breakpoint Information 1 Break0001 Enable testl c _maint2 2 Break0002 Disable test2 c _sub4 10 gt gt gt print info 0 Number 1 gt gt gt print info Name Break0001 gt gt gt print info BreakType
63. CS V3 00 00 B Python CONSOLE Python FUNCTIONS build All This function runs a build Specification format build All rebuild False waitBuild True Argument s Argument Description rebuild Specify whether to run a rebuild of a project True Run a rebuild of a project False Run a build of a project default waitBuild Specify whether to wait until completing a build True Wait until completing a build default False Return a prompt without waiting to complete a build Return value When waitBuild is set to True If a build was completed successfully True If a build failed or was canceled False When waitBuild is set to False If a build successfully started execution True If a build failed to start execution False Detailed description This function runs a build of a project If a subproject is added to the project a build of the subproject is run If rebuild is set to True then a rebuild of a project is run If waitBuild is set to False then a prompt is returned without waiting to complete a build Regardless of whether a build is successful the build BuildCompleted event is issued when a build completes Example of use gt gt gt build All True gt gt gt R20UT3097EJ0100 Rev 1 00 7tENESAS Page 41 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS build ChangeBuildMode This function changes the b
64. Example of use gt gt gt info debugger Timer Get 1 Total 2000 ns Pass Count 4 Average 500 ns Max 800 ns Min 300 ns gt gt gt print info 0 I gt gt gt print info 800 gt gt gt print info 4 gt gt gt print info False gt gt gt Number MaxTime PassCount IsMaxOverflow R20UT3097EJ0100 Rev 1 00 ztENESAS Page 171 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS TraceCondition This class creates conditions of a conditional trace Type class TraceCondition StartAddress StartData StartTraceType TraceType Execution EndAddress EndData EndTraceType TraceType Execution Variable Variable Description StartAddress Specify an address starting a trace Must be specified StartData Specify a data condition number of an address starting a trace This specification is ignored if TraceType Execution is specified for Start TraceType StartTraceType Specify the type of timers which start a trace The types that can be specified are shown below Type Description TraceType Execution Start a trace at execution default TraceType Read Start a trace at data read TraceType Write Start a trace at data write TraceType Access Start a trace at data access EndAddress Specify the type of timers which end a trace Must be specified Specify a dat
65. LE Python FUNCTIONS debugger Trace Delete This function deletes a conditional trace Specification format debugger Trace Delete timerNumber Argument s Argument Description timerNumber Specify the trace event number to delete Return value If a trace was deleted successfully True If there was an error when deleting a trace False Detailed description This function deletes the trace of the trace event number specified by tracenumber If traceNumber is not specified then traces of all trace event numbers will be deleted Example of use gt gt gt debugger Trace Delete 1 True 22 gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 119 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Trace Disable This function disables a conditional trace Specification format debugger Trace Disable traceNumber Argument s Argument Description traceNumber Specify the trace event number to disable Return value If a trace setting was disabled successfully True If there was an error when disabling a trace setting False Detailed description This function disables the timer of the trace event specified by traceNumber If traceNumber is not specified then traces of all trace event numbers will be disabled Example of use gt gt gt debugger Trace Disable l1 True 22 gt R2
66. ONS B Python CONSOLE Python FUNCTIONS This section describes the Python Console and Python functions provided by CS B 1 Overview The Python Console plug in is a console tool using the IronPython language In addition to the functions and control statements supported by the IronPython language you can also use CS Python functions added in order to control CS The functions provided by CS are shown below On the Python Console panel you can execute IronPython functions and control statements and CS Python func tions see B 3 CS Python Function Class Property Event and 2 1 Execute Python Functions When you start CS from the command line you can specify and execute a script file see CS Integrated Develop ment Environment User s Manual Project Operation When loading a project file you can run a script you have prepared in advance see B 2 Related File B 2 Related File Below is a related file of CS Python functions project file name py If there is a file in the same folder as the project file and with the same name as the project file but with the py extension then that file is executed automatically when the project file is loaded The active project will be processed download file name py If there is a file in the same folder as the download file and with the same name as the download file but with the py extension then that file is executed automatically after downloading
67. Python FUNCTIONS Example of use gt gt gt debugger XRunBreak Refer None gt gt gt debugger XRunBreak Set 1 TimeType S True True gt gt gt debugger XRunBreak Refer 1Second Periodic R20UT3097EJ0100 Rev 1 00 ztENESAS Page 144 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger XTime This function displays timing information between Go and Break Specification format debugger XTime Argument s None Return value List of timing information see the XTimelnfo property for detail Detailed description This function displays timing information between Go and Break in nanoseconds Example of use gt gt gt debugger XTime 9820214200nsec gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 145 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger XTrace Clear This function clears the trace memory IECUBE IECUBE2 Simulator Specification format debugger XTrace Clear Argument s None Return value If the trace memory was cleared successfully True If there was an error when clearing the trace memory False Detailed description This function clears the trace memory Example of use gt gt gt debugger XTrace Clear False Pee R20UT3097EJ0100 Rev 1 00 ztENESAS Page 146 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS de
68. S debugger Download HexBank This function downloads a hex file in memory bank format Specification format debugger Download HexBank fileName offset 0 append False flashErase False Argument s Argument Description fileName Specify a download file offset Specify an offset default 0 append Specify whether to make an additional download True Perform additional download False Perform overwrite download default flashErase Specify whether to initialize a flash memory before download True Initialize a flash memory before download False Do not initialize a flash memory before download default Caution If two or more parameters are specified then three parameters must be specified It is not possible to specify only fileName and offset Return value If a binary file was downloaded successfully True If there was an error when downloading a binary file False Detailed description When using the memory bank this function downloads hex files in memory bank format Example of use gt gt gt debugger Download HexBank C test testModule hex True gt gt gt debugger Download HexBank C test testModule2 hex 0x1000 True False gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 75 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Download HexldTag This function downloads a hex file with ID tag
69. Watch SetValue This function sets a variable value debugger Where This function displays a stack backtrace debugger Whereami This function displays a location debugger XCoverage Clear This function clears the coverage memory debugger XCoverage GetCoverage This function gets the coverage debugger XRunBreak Delete This function deletes XRunBreak setting information debugger XRunBreak Refer This function displays XRunBreak setting information debugger XRunBreak Set This function configures XRunBreak settings debugger XTime This function displays timing information between Go and Break debugger XTrace Clear This function clears the trace memory debugger XTrace Dump R20UT3097EJ0100 Rev 1 00 Aug 01 2014 This function dumps the trace data ztENESAS Page 48 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger ActionEvent Delete This function deletes an action event Specification format debugger ActionEvent Delete actionEventNumber Argument s Argument Description actionEventNumber Specify the action event number to delete Return value If an action event was deleted successfully True If there was an error when deleting an action event False Detailed description This function deletes the action event specified by actionEventNumber If actionEventNumber is not specif
70. XTrace Addup debugger XTrace Complement debugger XTrace Mode This property sets or refers to the tracing options of the debug tool IECUBE IECUBE2 Simulator Specification format debugger XTrace Addup addup Simulator debugger XTrace Complement complement IECUB debugger XTrace Mode traceMode Simulator I Setting s Setting Description Set whether to add up times tags True Add up times tags False Do not add up times tags complement Set whether to supplement the trace True Supplement the trace False Do not supplement the trace traceMode Set the trace control mode The trace control modes that can be specified are shown below Type Description TraceMode FullBreak Stop program execution and writing of trace data after all trace data has been used up TraceMode FullStop Stop writing trace data after all trace data has been used up TraceMode NonStop Continue writing trace data even if all trace data has been used up Reference Set value Caution If a PM workspace is converted to a CS project then there will be no debugging tool in the main proj ect For this reason None will be returned if the main project is the active project Detailed description This property sets or refers to the tracing options of the debug tool R20UT3097EJ0100 Rev 1 00 ztENESAS Page 217 of 225 Aug 01 2014
71. a binary file False Detailed description This function downloads a load module If fileName is not specified the file specified on the Download File Settings tab in the Property panel of the debug ging tool is downloaded If downloadOption is specified the processing is performed in accordance with the specification Example of use gt gt gt debugger Download LoadModule C test testModule 1lmf True gt gt gt debugger Download LoadModule C test testModule2 1mf DownloadOption SymbolOnly True False gt gt gt R20UT3097EJ0100 Rev 1 00 tENESAS Page 78 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Erase This function erases the flash memory Specification format Erase eraseOption EraseOption Code Argument s Argument Description eraseOption Specify an option The options that can be specified are shown below Type Description EraseOption Code Erase the code flash memory default EraseOption Data Erase the data flash memory EraseOption External Erase the flash memory in external space Caution IECUBE IECUBE2 and the simulator do not have functionality to delete code flash memory For this reason if you are using IECUBE IECUBE2 or the simulator you cannot omit eraseOption or specify EraseOption Code Return value If the flash memory was erased successfully True I
72. a condition number of an address ending a trace This specification is ignored if TraceType Execution is specified for EndTracetType EndTraceType Specify the type of timers which end a trace The types that can be specified are shown below Type Description TraceType Execution Start a trace at execution default TraceType Read Start a trace at data read TraceType Write Start a trace at data write TraceType Access Start a trace at data access R20UT3097EJ0100 Rev 1 00 ztENESAS Page 172 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Detailed description TraceCondition is in class format and the condition of a conditional trace is set in the variable In order to create a condition of a conditional trace create an instance and set conditions for that instance Example of use gt gt gt execute_trace TraceCondition Create instance gt gt gt execute_trace StartAddress main gt gt gt execute_trace StartTraceType TraceType Execution gt gt gt execute_trace EndAddress sub gt gt gt execute_trace EndTraceType TraceType Execution gt gt gt debugger Trace Set execute_trace Specify function in which to set the con ditional trace in parameter 1 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 173 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Tr
73. ace is converted to a CS project then there will be no debugging tool in the main proj ect For this reason None will be returned if the main project is the active project Detailed description This property sets or refers to the options of the debug tool Example of use gt gt gt print debugger Option UseTraceData Trace gt gt gt debugger Option UseTraceData UseTraceDataType Coverage gt gt gt print debugger Option Coverage False gt gt gt debugger Option Coverage True gt gt gt print debugger Option Coverage True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 215 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger ProcessorElement This property sets or refers to the PE of the multi core RH850 Specification format debugger ProcessorElement number Setting s Setting Description number Set the PE number with the number Reference Current set value Detailed description This function sets or refers to the PE of the multi core Caution When the PE is set it must be connected to the debugging tool Example of use gt gt gt print debugger Processor 1 gt gt gt debugger ProcessorElement gt gt gt print debugger Processor 2 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 216 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger
74. aceEventInfo This class holds conditional trace event information return value of the debugger Trace lnformation function Type class TraceEventInfo umber 0 ame Enable True StartAddress StartData StartTraceType TraceType Execution EndAddress EndData Variable EndTraceType TraceType Execution Variable Description Number This holds the trace event number Name This holds the name of the trace Enable This holds whether the trace is enabled or not True Enabled False Disabled StartAddress This holds an address starting a trace StartData This holds a data condition number of an address starting a trace StartTraceType This holds the type of timers which start a trace Type Description TraceType Execution Start a trace at execution TraceType Read Start a trace at data read TraceType Write Start a trace at data write TraceType Access Start a trace at data access EndAddress This holds an address ending a trace EndData This holds a data condition number of an address ending a trace EndTraceType This holds the type of timers which end a trace Type Description TraceType Execution Start a trace at execution TraceType Read Start a trace at data read TraceType Write Start a trace at data write Tr
75. aceType Access Start a trace at data access R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 174 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Detailed description TraceEventinfo is a class and it is passed as the return value when the debugger Trace Information function is exe cuted Example of use gt gt gt info debugger Trace Information 1 Trace Enable main sub gt gt gt print info 0 Number gt gt gt print info 0 Name Trace gt gt gt print info 0 Enable True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 175 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Tracelnfo This class holds trace information return value of the debugger XTrace Dump function Type class TraceInfo FrameNumber Non Timestamp None FetchAddress None Mnemonic None ReadAddress Non ReadData None WriteAddress Non WriteData None VectorAddress None VectorData None IsDma True Variable FrameNumber This holds frame number information Timestamp This holds time stamp information FetchAddress This holds fetch address information Mnemonic This holds mnemonic information ReadAddress This holds read address information ReadData This holds read data information WriteAddress This holds write address information WriteData This holds write data information V
76. ad Hex C test testModule hex True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 73 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Download Hex64Kb This function downloads a hex file in within 64 KB format Specification format debugger Download Hex64Kb fileName offset 0 append False flashErase False Argument s Argument Description fileName Specify a download file offset Specify an offset default 0 append Specify whether to make an additional download True Perform additional download False Perform overwrite download default flashErase Specify whether to initialize a flash memory before download True Initialize a flash memory before download False Do not initialize a flash memory before download default Caution If two or more parameters are specified then three parameters must be specified It is not possible to specify only fileName and offset Return value If a binary file was downloaded successfully True If there was an error when downloading a binary file False Detailed description When using the memory bank this function downloads hex files in within 64 KB format Example of use gt gt gt debugger Download Hex64Kb C test testModule hex True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 74 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTION
77. ailed description This function closes a currently opened project If save is set to True then all files being edited and a project are saved Example of use gt gt gt project Close True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 26 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project Create This function creates a new project Specification format project Create fileName micomType deviceName projectKind ProjectKind Auto com piler Compiler Auto subProject False registerNaming RegisterNaming Structured Argument s Argument Description fileName Specify the full path of a new project file If no file extension is specified the filename is automatically supplemented If the project to be created is a main project subProject False or a subproject subProject True the name is supplemented by mtpj or mtsp respectively When the extension is other than that specified it is replaced by the actual exten sion micomType Specify the microcontroller type of a new project The types that can be specified are shown below Type Description MicomType RH850 Project for RH850 MicomType RX Project for RX MicomType V850 Project for V850 MicomType RL78 Project for RL78 MicomType KOR Project for 78KOR MicomType KO Project for 78KO deviceName Specify the device name of the m
78. akpoint Delete This function deletes a break point debugger Breakpoint Disable This function disables a break point setting debugger Breakpoint Enable This function enables a break point setting debugger Breakpoint Information This function displays break point information debugger Breakpoint Set This function configures a break point debugger Connect This function connects to the debug tool debugger Debug Tool Change This function changes the debug tool debugger DebugTool GetType This function displays information about the debug tool debugger Disconnect This function disconnects from the debug tool debugger Download Binary This function downloads a binary file debugger Download Binary64Kb This function downloads a binary file in within 64 KB format debugger Download BinaryBank This function downloads a binary file in memory bank format debugger Download Coverage This function downloads coverage data debugger Download Hex This function downloads a hex file debugger Download Hex64Kb This function downloads a hex file in within 64 KB format debugger Download HexBank This function downloads a hex file in memory bank format debugger Download HexldTag This function downloads a hex file with ID tag debugger Download nformation This function displays download information debugger Download LoadModule
79. alue List of trace information see the Tracelnfo property for detail Detailed description This function dumps trace data for the number of frames specified by frameCount If fileName is specified then the trace data is written to the file If append is set to True then the trace data is appended to the file Example of use gt gt gt debugger Trace Get 3 1851 00h00min00s003ms696us000ns O0x000003be cmp rll r14 1852 00h00min00s003ms700us000ns 0x000003c0 blt _func_static3 0x2c 1853 00h 00min00s003ms702us000ns 0x000003c2 jarl _errfunc lp gt gt gt debugger XTrace Dump 10 C test TestTrace txt gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 122 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Trace Information This function displays conditional trace information Specification format debugger Trace Information Argument s None Return value List of conditional trace information see the TraceEventinfo class for detail Detailed description This function displays conditional trace information is shown by the following format trace event number Trace state start address nd address Example of use gt gt gt ti debugger Trace Information 1 Trace Enable main sub gt gt gt print ti 0 Number 1 gt gt gt print ti 0 Name Trace gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page
80. ame ncode Encoding Default watchOption WatchOption Auto Argument s Argument Description variableName Specify the variable name register name or I O register name SFR register name to reference encode Specify the encoding to use when displaying strings By default the system encoding is used The encoding name conforms to the NET specifications Examples Encoding utf 8 Encoding euc jp watchOption Return value Specify an option The options that can be specified are shown below Type Description WatchOption Auto Automatically detect when displaying default WatchOption Binary Display in binary format WatchOption Octal Display in octal format WatchOption Decimal Display in decimal format WatchOption SignedDecimal Display in signed decimal format WatchOption UnsignedDecimal Display in unsigned decimal format WatchOption Hexdecimal Display in hexadecimal format WatchOption String Display as a string WatchOption Sizeof Display the variable size in decimal format WatchOption Float Display in float type WatchOption Double Display in double type The displayed value is returned in the format specified by watchOption When waitchOption is specified as WatchOption Auto the format is returned to match the variable value However if the return value is a double type it i
81. ault value Example If the Specification format is function arg arg2 1 arg3 True gt gt gt function arg3 False argl main arg2 3 wow OK gt gt gt function False main 3 NG because it is assumed that argl False arg2 main arg3 3 You should be careful when you describe a path for a folder or file as parameters IronPython recognizes the backslash character as a control character For example if a folder or file name starts with a t then the sequence t will be recognized as a tab character Do the following to avoid this Example 1 In a quoted string prepend the letter r to make IronPython recognize the string as a path r C test test py Example 2 Use a forward slash instead of a backslash C test test py A slash is used in this document R20UT3097EJ0100 Rev 1 00 ztENESAS Page 11 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS B 3 1 CS Python function for basic operation Below is a list of CS Python functions for basic operation Table B 1 CS Python Function For Basic Operation Function Name Function Description ClearConsole This function clears the string displayed on the Python console CubeSuiteExit This function exits from CS Help This function displays the help for the CS Python functions Hook This function registers a hook or callback function Save This funct
82. ble Return value If an action event setting was enabled successfully True If there was an error when enabling an action event setting False Detailed description This function enables the action event specified by actionEventNumber If actionEventNumber is not specified then events of all action event numbers will be enabled Example of use gt gt gt debugger Action True gt gt gt debugger Action R20UT3097EJ0100 Rev 1 00 ztENESAS Page 51 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger ActionEvent Get This function references the result of the action event Printf event Specification format debugger ActionEvent Get output Argument s Argument Description Specify the string to be attached when the result of an action event is output default not specified Note that this argument should be specified when wishing to acquire only a result matching this argument Return value List of result of action event see the Actionlnfo class for detail Detailed description This function holds the result acquired when executing the instruction at the address set as a condition of an action event Printf event in the Python console and all results held up to that moment will be referenced at the timing of this function debugger ActionEvent Get being called If output is specified only the
83. bugger XTrace Dump This function dumps the trace data IECUBE IECUBE2 Simulator Specification format debugger XTrace Dump frameCount fileName append False Argument s Argument Description frameCount Specify the number of dumps fileName Specify the name of the file to dump to default not specified append Specify whether to append trace data to the file True Append trace data to the file False Do not append trace data to the file default Return value List of trace information see the Tracelnfo property for detail Detailed description This function dumps trace data for the number of frames specified by frameCount If fileName is specified then the trace data is written to the file If append is set to True then the trace data is appended to the file Example of use gt gt gt debugger XTrace Dump 3 1851 OOhOOminO00sOO03ms696usO00ns Ox000003be cmp rll r14 1852 OQOhOOminO00sOO03ms700uUsO00ns 0x000003c0 blt _func_static3 0x2c 1853 00h00min00s003ms702us000ns 0x000003c2 jarl _errfunc lp gt gt gt debugger XTrace Dump 10 C test TestTrace txt gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 147 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS B 3 6 CS Python class Below is a list of CS Python classes Table B 6 CS Python Class Class Name Function Description ActionEventCondition
84. by you resulting from errors in or omissions from the information included herein Renesas Electronics does not assume any liability for infringement of patents copyrights or other intellectual property rights of third parties by or arising from the use of Renesas Electronics products or technical information described in this document No license express implied or otherwise is granted hereby under any patents copyrights or other intellectual property rights of Renesas Electronics or others You should not alter modify copy or otherwise misappropriate any Renesas Electronics product whether in whole or in part Renesas Electronics assumes no responsibility for any losses incurred by you or third parties arising from such alteration modification copy or otherwise misappropriation of Renesas Electronics product Renesas Electronics products are classified according to the following two quality grades Standard and High Quality The recommended applications for each Renesas Electronics product depends on the product s quality grade as indicated below Standard Computers office equipment communications equipment test and measurement equipment audio and visual equipment home electronic appliances machine tools personal electronic equipment and industrial robots etc High Quality Transportation equipment automobiles trains ships etc traffic control systems anti disaster systems anti crime systems an
85. c operation 0 0 c eee eee 12 B 3 2 CS Python function COMMON 6 eee eee 20 B 3 3 CS Python function for project 6 eet eee eee 24 B 3 4 CS Python function for build tool 20 ketene eens 40 B 3 5 CS Python function for debug tool n assan teens 46 B 3 6 CS Python Classi icn teri boat e e a A ie ae ba i ke ee ed at ge ee 148 B 3 7 CS Python property COMMON aenea saaan ttt ae 181 B 3 8 CS Python property for project 2 0 cette eee ae 191 B 3 9 CS Python property for build tool 2 2 teeta 198 B 3 10 CS Python property for debug tool 0 0 cette eee eee 209 B 3 11 CS Python eventt s seiere a NE A e EE EAA Wate piping hha a a daddies edocs 219 B 4 Cautions for Python Console 1 0 eect tenet eee eee 221 Revision Record 000 eee ee ee ee eee ee eens 222 CS V3 00 00 1 GENERAL 1 GENERAL CS is an integrated development environment for use with microcontrollers The Python console can control CS using IronPython Python that runs on NET Framework which is a script language The functions properties classes and events to control CS are added to the Python console This manual describes the usage of the Python console and the functions properties classes and events that have been extended for CS 1 1 Introduction This manual covers how to control CS in creating building and debugging projects by using the CS control func tions
86. d it is the structure of the return value from the project GetFunctionList function Example of use gt gt gt info project GetFunctionList funcl int 0x00200 0x00224 C project src testl c func2 int 0x00225 0x002ff C project src test2 c gt gt gt print info 0 FunctionName funcl gt gt gt print info 1 FileName C project srce test2 c gt gt gt print info 0 StartAddress 512 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 162 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS IORInfo This class holds IOR and SFR information return value of the debugger GetlOR List function Type class IO Variable RInfo IORName Value Type Size Address Category Variable Description IORName This holds the name of IOR or SFR Value This holds the value Type This holds the type Size This holds the size The number of bytes is held when the unit of the size is bytes and the number of bits bits is held when the unit of the size is bits Address This holds the address Category Detailed d This holds the category escription IORInfo is a class and it is passed as the return value when the debugger GetlORList function is executed Example of use gt gt gt ior project GetIORList ADO ADDRA 0x0000 IOR 2 0x00088040 ADO ADDRB 0x0000 IOR 2 0x00088042 ADO ADDRC 0x000
87. d safety equipment etc Renesas Electronics products are neither intended nor authorized for use in products or systems that may pose a direct threat to human life or bodily injury artificial life support devices or systems surgical implantations etc or may cause serious property damages nuclear reactor control systems military equipment etc You must check the quality grade of each Renesas Electronics product before using it in a particular application You may not use any Renesas Electronics product for any application for which it is not intended Renesas Electronics shall not be in any way liable for any damages or losses incurred by you or third parties arising from the use of any Renesas Electronics product for which the product is not intended by Renesas Electronics You should use the Renesas Electronics products described in this document within the range specified by Renesas Electronics especially with respect to the maximum rating operating supply voltage range movement power voltage range heat radiation characteristics installation and other product characteristics Renesas Electronics shall have no liability for malfunctions or damages arising out of the use of Renesas Electronics products beyond such specified ranges Although Renesas Electronics endeavors to improve the quality and reliability of its products semiconductor products have specific characteristics such as the occurrence of failure at a certain rate and malfunction
88. described in this document for any purpose relating to military applications or use by the military including but not limited to the development of weapons of mass destruction When exporting the Renesas Electronics products or technology described in this document you should comply with the applicable export control laws and regulations and follow the procedures required by such laws and regulations It is the responsibility of the buyer or distributor of Renesas Electronics products who distributes disposes of or otherwise places the product with a third party to notify such third party in advance of the contents and conditions set forth in this document Renesas Electronics assumes no responsibility for any losses incurred by you or third parties as a result of unauthorized use of Renesas Electronics products This document may not be reproduced or duplicated in any form in whole or in part without prior written consent of Renesas Electronics Please contact a Renesas Electronics sales office if you have any questions regarding the information contained in this document or Renesas Electronics products or if you have any other inquiries Note 1 Renesas Electronics as used in this document means Renesas Electronics Corporation and also includes its majority owned subsidiaries Note 2 Renesas Electronics product s means any product developed or manufactured by or for Renesas Electronics 2012 4 How to Use This
89. e RL78 Project for RL78 MicomType KOR Project for 78KOR MicomType KO Project for 78KO nickName Specify the nickname of the microcontroller by a string default not specified Specify a character string displayed in the first layer of the Using microcontroller list in the Create Project dialog box that is used to create a new project Return value List of device names Detailed description This function displays the list of the device names of the microcontroller specified by micomType When nickName is specified only the names of the devices specified by nickName are displayed Example of use gt gt gt project GetDeviceNameList MicomType RL78 R5F10BAF R5F10AGF R5F10BAG gt gt gt devlist project GetDeviceNameList MicomType RL78 RL78 F13 ROM 128KB 10BAG R20UT3097EJ0100 Rev 1 00 ztENESAS Page 35 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project GetFunctionList This function displays the list of the functions of the active project Specification format project GetFunctionList fileName Argument s Argument Description fileName Specify the full path of the file that the list of the functions are displayed default not specified Return value List of function information see the Functionlnfo property for detail Detailed description This function displays the list of the functions
90. e of use gt gt gt print debugeer ADConvertDataInExecution False gt gt gt debugger ADConvertDataInExecution True gt gt gt print debugger ADConvertDataInExecution True gt gt gt R20UT3097EJ0100 Rev 1 00 RENESAS Aug 01 2014 Page 211 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger IsMulticore This property checks whether or not the microcontroller of the active project is multi core Specification format debugger IsMulticore Setting s None Reference When the microcontroller is multi core True When the microcontroller is not multi core False Detailed description This function checks whether or not the microcontroller of the active project is multi core Example of use gt gt gt print debugger IsMulticore False Pee R20UT3097EJ0100 Rev 1 00 ztENESAS Page 212 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Memory NoVerify This property switches the write time verification setting Except simulator Specification format debugger Memory NoVerify noverify Setting s Setting Description noverify Set whether to verify during writes True Verify during writes False Do not verify during writes Reference Set value Caution If a PM workspace is converted to a CS project then there will be no debugging tool in the main proj ect For this reason None will b
91. e returned if the main project is the active project Detailed description This property switches the write time verification setting Example of use gt gt gt print debugger Memory NoVerify False gt gt gt debugger Memory NoVerify True gt gt gt print debugger Memory NoVerify True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 213 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Option AccessStopExecution debugger Option AfterTraceMemoryFull debugger Opiton Coverage debugger Option OpenBreak debugger Option ReuseCoverageData debugger Option Timer debugger Option Trace debugger Option UseTraceData This property sets or refers to the options of the debug tool Specification format debugger Option AccessStopExecution afterTrace debugger Option AfterTraceMemoryFull accessStopExecution debugger Opiton Coverage coverag debugger Option OpenBreak openBreak debugger Option ReuseCoverageData reuseCoverageData debugger Option Timer timer debugger Option Trace trace debugger Option UseTraceData useTraceDataType Setting s Setting Description afterTrace Set the operation to be taken after using up trace memory The values that can be specified are shown below Value Description AfterTraceMemoryFull NoneStop Overwrite trace memory and continue exe cution AfterTraceMemoryFull StopTrace Stop tracing
92. e the DownloadInfo property for detail Detailed description This function displays download information in the following format download number download file name Example of use gt gt gt debugger Download Information 1 DefaultBuild test 1lmf R20UT3097EJ0100 Rev 1 00 ztENESAS Page 77 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Download LoadModule This function downloads a load module Specification format debugger Download LoadModule fileName downloadOption DownloadOption Both append False flashErase False Argument s Argument Description fileName Specify a download file downloadOption Specify an option The options that can be specified are shown below Type Description DownloadOption NoSymbol Do not load symbol information DownloadOption SymbolOnly Only load symbol information DownloadOption Both Load both symbol information and object infor mation default Specify whether to make an additional download True Perform additional download False Perform overwrite download default flashErase Specify whether to initialize a flash memory before download True Initialize a flash memory before download False Do not initialize a flash memory before download default Return value If a binary file was downloaded successfully True If there was an error when downloading
93. eName address append False flashErase False Argument s Argument Description fileName Specify a download file address Specify a download start address append Specify whether to make an additional download True Perform additional download False Perform overwrite download default flashErase Specify whether to initialize a flash memory before download True Initialize a flash memory before download False Do not initialize a flash memory before download default Caution If two or more parameters are specified then three parameters must be specified It is not possible to specify only fileName and address Return value If a binary file was downloaded successfully True If there was an error when downloading a binary file False Detailed description When using the memory bank this function downloads binary files in within 64 KB format Example of use gt gt gt debugger Download Binary64Kb C test testModule bin 0x1000 False True gt gt gt debugger Download Binary64Kb C test testModule2 bin 0x2000 True False gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 70 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Download BinaryBank This function downloads a binary file in memory bank format Specification format debugger Download BinaryBank fileName address append False flashErase False Arg
94. eName Specify the variable name register name and I O register name or SFR register name to set Specify the value to set Return value If a variable value was set successfully True If there was an error when setting a variable value False Detailed description This function sets the value specified by value in the variable register and I O register or SFR register specified by variableName Caution When a load module name or file name is specified as a variable variableName it needs to be enclosed in double quotation marks in some cases See CS Integrated Development Environment User s Manual Debug Tool for details Example When file name C path test c and variable var are specified C path test c var c path test c var Or R20UT3097EJ0100 Rev 1 00 ztENESAS Page 135 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Example of use gt gt gt debugger tch tValue testVal 128 gt gt gt debugger Ech tValue testVal WatchOption Hexdecimal 0x80 gt gt gt debugger tch tValue testVal WatchOption Binary 0610000000 gt gt gt debugger tch tValue testVal 100 True gt gt gt debugger tch lue testVal 100 gt gt gt debugger tch tValue testVal WatchOption Hexdecimal 0x64 gt gt gt debugger Watch Lue testVal WatchOption Binary 0b1100100 gt gt gt debugger T tValue testVal 0x256 True
95. eak Detailed description BreakCondition is in class format and the break condition is set in the variable In order to create a break condition create an instance and set conditions for that instance R20UT3097EJ0100 Rev 1 00 ztENESAS Page 154 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Example of use gt gt gt executeBreak BreakCondition Create instance gt gt gt executeBreak Address main gt gt gt executeBreak BreakType BreakType Software gt gt gt debugger Breakpoint Set executeBreak Specify function in which to set the break point in parameter gt gt gt gt gt gt dataBreak BreakCondition Create instance gt gt gt dataBreak Address chData gt gt gt dataBreak Data 0x10 gt gt gt dataBreak BreakType BreakType Access gt gt gt debugger Breakpoint Set dataBreak Specify function in which to set the break point in parameter gt gt gt gt gt gt executeBreak Address sub 0x10 Reuse break condition gt gt gt debugger Breakpoint Set executeBreak Specify function in which to set the break point in parameter gt gt gt R20UT3097EJ0100 Rev 1 00 RENESAS Page 155 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Breakpointlnfo This class holds break point information return value of the debugger Breakpoint Information function Type class
96. ectorAddress This holds vector address information VectorData This holds the vector data IsDma This holds whether the data is DMA or not True The data is DMA False The data is other than DMA Detailed description Tracelnfo is a class and it is the structure of the return value from the debugger XTrace Dump function R20UT3097EJ0100 Rev 1 00 ztENESAS Page 176 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Example of use gt gt gt info debugger XTrace Dump 10 853 00hO0Omin00s001ms704us000ns 854 O00hO0OO0Omin00s001ms706us000ns 855 O00hOO0Omin00s001ms706us000ns 0x00000000 856 O00OhO0OO0Omin00s001ms706us000ns 857 00hO0O0Omin00s001ms710us000ns 858 O00OhOO0Omin00s001ms712us000ns 859 O00OhO0OO0Omin00s001ms716us000ns 860 O00hO0OOmin00s001ms720us000ns 861 O00hOOmin00s001ms720us000ns 0x000002d6 862 O00hOOmin00s001ms724us000ns gt gt gt print info 0 FrameNumber 853 gt gt gt prin 1704000 gt gt gt print 706 gt gt gt prin info Timestamp info FetchAddress Mnemonic gp rl ReadAddress info FEEL info movhi 0 gt gt gt prin None gt gt gt print info ReadData None info IsDma gt gt gt prin False gt gt gt gt gt gt print info FrameNumber 855 gt gt gt print info 2 Timestamp 1706000 gt gt gt print None gt gt gt print info 2 FetchAddress info 2 Mnemonic None gt gt gt print 67080192 info
97. emoryOption Byte Argument s Argument Description address Specify the address to set value Specify the value to set memoryOption Specify the unit to set The units that can be specified are shown below Type Description MemoryOption Byte Byte unit 8 bits default MemoryOption HalfWord Half word unit 16 bits RH850 RX V850 MemoryOption Word Word unit RL78 78K 16 bits RH850 RX V850 32 bits Return value If the memory was written to successfully True If there was an error when writing to the memory False Detailed description This function sets the value at the address specified by address according to memoryOption Example of use gt gt gt debugger Memory Read 0x100 0x10 gt gt gt debugger Memory Write 0x100 OxFF True gt gt gt debugger Memory Read 0x100 OxFF gt gt gt debugger Memory Write 0x100 OxFE MemoryOption HalfWord False gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 101 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Memory WriteRange This function writes multiple data to the memory Specification format debugger Memory WriteRange address valuelist memoryOption MemoryOption Byte Argument s Argument Description address Specify the start address to write valuelist Specify the list of the value to set memoryOption Specif
98. ess value Argument s Argument Description ieType Specify a register The registers that can be specified are shown below Type Description leType Reg IE register 78K0 RL78 78KOR IECUBE V850 IECUBE2 V850 leType Dcu DCU register IECUBE V850 address Specify the address to reference set value Specify the setting value Return value debugger le GetValue is the register value numeric value debugger le SetValue is True if the setting was completed successfully or False if there was an error when setting the register Detailed description debugger le GetValue displays the value of the register specified by address The register type is specified by ieType debugger le SetValue writes value to the register specified by address The register type is specified by ieType Remark When the DCU register is referenced the register value is reset to 0 Example of use gt gt gt debugger Ie GetValue IeType Reg 0x100 0x12 gt gt gt debugger Ie SetValue IeType Reg 0x100 0x10 True gt gt gt debugger Ie GetValue IeType Reg 0x100 0x10 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Aug 01 2014 Page 89 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger sConnected This function checks the connection status of the debug tool Specification format debugger IsConnected Argu
99. ete Argument s None Return value If XRunBreak information was deleted successfully True If there was an error when deleting XRunBreak information False Detailed description This function deletes XRunBreak information Example of use gt gt gt debugger XRunBreak fer None gt gt gt debugger XRunBreak Set TimeType S True True gt gt gt debugger XRunBreak 1Second Periodic gt gt gt debugger XRunBreak True gt gt gt debugger XRunBreak None R20UT3097EJ0100 Rev 1 00 ztENESAS Page 141 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger XRunBreak Refer This function displays XRunBreak setting information V850 Simulator Specification format debugger XRunBreak Refer Argument s None Return value List of period time value and period information TimeType see the XRunBreaklnfo property for detail Detailed description This function displays the period information period time Periodic of the set XRunBreak If there is no XRunBreak setting None is displayed Example of use gt gt gt debugger XRunBreak Refer None gt gt gt debugger XRunBreak Set 1 TimeType S True True gt gt gt debugger XRunBreak Refer 1Second Periodic R20UT3097EJ0100 Rev 1 00 ztENESAS Page 142 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger XRunBreak Set This funct
100. etting for enabling or disabling the function for linking to an external tool at CS startup Example of use gt gt gt print common UseRemoting False gt gt gt common UseRemoting True R20UT3097EJ0100 Rev 1 00 ztENESAS Page 187 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS common Version This property refers to the version of CS Specification format common Version Setting s None Reference Version of CS Detailed description This property refers to the version of CS Example of use gt gt gt print common Version v1 02 00 01 Apr 2012 R20UT3097EJ0100 Rev 1 00 ztENESAS Page 188 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS common ViewLine This property sets or refers to the number of screen lines for the Python console Specification format common ViewLine number Setting s Setting Description number Set the number of screen lines for the Python console default 10000 Reference Current set value Detailed description This property sets or refers to the number of screen lines for the Python console Example of use gt gt gt print common ViewLine 10000 gt gt gt common ViewLine 20000 R20UT3097EJ0100 Rev 1 00 ztENESAS Page 189 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS common ViewOutput This property set
101. executed if there is no load module file Cautions for forced termination If the following operations are performed while a script like an infinite loop is running then the results of function execution may be an error because the function execution will be terminated forcibly Forcible termination by selecting Forcibly terminate from the context menu or pressing Ctrl D in the Python Console Changing the active project in a project with multiple projects R20UT3097EJ0100 Rev 1 00 ztENESAS Page 221 of 225 Aug 01 2014 Revision Record Description Summary Aug 01 2014 First Edition issued CS V3 00 00 User s Manual Python Console Publication Date Rev 1 00 Aug 01 2014 Published by Renesas Electronics Corporation CENESAS SALES OFFICES Renesas Electronics Corporation http www renesas com Refer to http Awww renesas com for the latest and detailed information Renesas Electronics America Inc 2801 Scott Boulevard Santa Clara CA 95050 2549 U S A Tel 1 408 588 6000 Fax 1 408 588 6130 Renesas Electronics Canada Limited 1101 Nicholson Road Newmarket Ontario L3Y 9C3 Canada Tel 1 905 898 5441 Fax 1 905 898 3220 Renesas Electronics Europe Limited Dukes Meadow Millboard Road Bourne End Buckinghamshire SL8 5FH U K Tel 44 1628 585 100 Fax 44 1628 585 900 Renesas Electronics Europe GmbH Arcadiastrasse 10 40472 D sseldorf Germany Tel 49 211 6503 0 Fax
102. f there was an error when erasing the flash memory False Detailed description This function erases the flash memory specified by eraseOption Example of use gt gt gt debugger Erase True gt gt gt debugger Erase EraseOption External False gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 79 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger GetBreakStatus This function displays a break condition Specification format debugger GetBreakStatus Argument s None Return value Break trigger string See Detailed description Remark 1 Remark 2 Detailed description This function displays break trigger During execution this will be None Returns the string portion of the BreakStatus enum Determine conditions by writing in the format BreakStatus string Break trigger String Description 78K0 RL78 78KOR V850 Sheet al ee Fl O F a 5 O mi 5 2 8115 212 515 2 s 8 a B s cs giS gs 7 z259 z g g v None No break o o o o o o o Manual Forced break o o o o o o o o o o Event Break due to event o o o o o o 0 0 fe o Software Software break o o o o o o o TraceFull Break due to trace full o o o o o s o TraceDelay Break due to trace delay o o NonMap Access
103. ference List of library files Detailed description This property sets or refers to library files of the active project Add or change for the referred list Example of use gt gt gt lib1 gt gt gt print libl testl lib test2 lib build Link LibraryFile to change the setting Refer th current setting and add a library file gt gt gt libl append test3 lib gt gt gt build Link LibraryFile libl gt gt gt print build Link LibraryFile testl lib gt gt gt gt gt gt 1lib2 testl lib gt gt gt build Link LibraryFile test2 lib test2 lib test3 lib Set multiple library files lib2 gt gt gt print build Link LibraryFile testi lib test2 lab R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 202 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS build Link SectionAlignment This property sets or refers to the link options for the active project regarding section alignment CC RH CC RX CC RL Specification format build Link SectionAlignment sectionlist Setting s Setting Description sectionlist Reference List of section alignment Detailed description Set section alignment as a list of strings This property sets or refers to the link options for the active project regarding section alignment Add or change for the referred list to change the setting
104. force Specify whether to overwrite True Overwrite False Do not overwrite default Return value If the memory data was uploaded successfully True If there was an error when uploading the memory data False Detailed description This function saves the memory data from address7 to address2 in binary format Example of use gt gt gt debugger Upload Binary C test testBinary bin 0x1000 0x2000 True True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 125 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Upload Coverage This function saves the coverage data Simulator Specification format debugger Upload Coverage fileName force False Argument s Argument Description fileName Specify a file name force Specify whether to overwrite True Overwrite False Do not overwrite default Return value If the memory data was uploaded successfully True If there was an error when uploading the memory data False Detailed description This function saves the coverage data to a file Example of use gt gt gt debugger Upload Coverage C test coverageData csrcv True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 126 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Upload Intel This function saves the memory data in Intel format Specifica
105. format debugger GetPC Argument s None Return value PC value numeric value Detailed description This function displays the PC value Example of use gt gt gt debugger GetPC 0x92B0 R20UT3097EJ0100 Rev 1 00 ztENESAS Page 87 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Go This function continues program execution Specification format debugger Go goOption GoOption Normal Argument s Argument Description goOption Specify an option The options that can be specified are shown below Type Description GoOption gnoreBreak Execute ignoring breakpoints GoOption WaitBreak Wait until program stops GoOption Normal Breakpoints enabled do not wait until program stops default Return value None Detailed description This function continues program execution If goOption is specified the processing is performed in accordance with the specification Example of use gt gt gt debugger Go gt gt gt debugger Go GoOption WaitBreak gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 88 of 225 Aug 01 2014 CS V3 00 00 debugger le GetValue debugger le SetValue B Python CONSOLE Python FUNCTIONS This function sets or refers to the IE register or DCU register Specification format debugger Ie GetValue ieType address debugger Ie SetValue ieType addr
106. function Example of use gt gt gt debugger ReturnoOut gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 107 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Run This function resets and then run the program Specification format debugger Run runOption RunOption Normal Argument s Argument Description runOption Specify an option The options that can be specified are shown below Type Description RunOption WaitBreak Wait until program stops RunOption Normal Breakpoints enabled do not wait until program stops default Return value None Detailed description This function resets and then run the program If RunOption WaitBreak is specified in runOption then it will wait until the program stops Example of use gt gt gt debugger Run gt gt gt debugger Run RunOption WaitBreak R20UT3097EJ0100 Rev 1 00 ztENESAS Page 108 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Step This function performs step execution Specification format debugger Step stepOption StepOption Source Argument s Argument Description stepOption Specify the execution unit The units that can be specified are shown below Type Description StepOption Source Source line unit default StepOption Instruction Instruction unit Return value
107. ger DebugTaal Geclype Simulator gt debugger Connect True gt gt gt Remark See B Python CONSOLE Python FUNCTIONS for details about the Python console and Python func tions R20UT3097EJ0100 Rev 1 00 ztENESAS Page 6 of 225 Aug 01 2014 CS V3 00 00 A WINDOW REFERENCE A WINDOW REFERENCE This section describes the panel related to the Python console A 1 Description Below is a list of the panel related to the Python console Table A 1 Panel List Panel Name Function Description Python Console panel This panel is used to use IronPython to control CS and the debug tool via the command input method R20UT3097EJ0100 Rev 1 00 ztENESAS Page 7 of 225 Aug 01 2014 CS V3 00 00 A WINDOW REFERENCE Python Console panel This panel is used to use IronPython to control CS and the debug tool via the command input method Figure A 1 Python Console Panel Python Correale gt gt iebugger DebugTosl Change Debuglael Simulater Trua petdebugger Debuglaal CerType Simulator 2rdebuggear Connect Trua so The following items are explained here How to open Description of each area File menu Python Console panel dedicated items Context menu How to open From the View menu select Python Console Description of each area 1 IO area Enter and run IronPython functions and control statements and CS Python fu
108. gt gt print common ExecutePath C Program Files Renesas Electronics CS CC R20UT3097EJ0100 Rev 1 00 ztENESAS Page 182 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS common ConsoleClear This property sets or refers to whether to clear the display of the Python console when changing the active project Specification format common ConsoleClear bool Setting s Setting Description Set whether to verify during writes True Verify during writes False Do not verify during writes Reference Current set value Detailed description This property sets or refers to whether to clear the display of the Python console when changing the active project Example of use gt gt gt print common ConsoleClear True gt gt gt common ConsoleClear Fals R20UT3097EJ0100 Rev 1 00 ztENESAS Page 183 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS common EnableRemotingStartup This property sets and displays the setting for enabling or disabling the function for linking to an external tool at CS startup Specification format common EnableRemotingStartup bool Setting s Setting Description Set whether to enable or disable the function for linking to an external tool at CS startup True Enable the function for linking to an external tool default False Disable the function for linking to an exte
109. he Option dialog box Type Description MessageType Error Error MessageType Information Standard default MessageType Warning Warning Return value If the string was displayed on the Output panel successfully True If there was an error when displaying the string on the Output panel False Detailed description This function displays the string specified by output on the Output panel Example of use gt gt gt common OutputPanel An error occured MessageType Error True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 22 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS common PythonInitialize This function initializes Python Specification format common PythonInitialize scriptFile Argument s Argument Description scriptFile Specify the script file to run after initializing Python default not specified Specify the absolute path Return value None Detailed description This function initializes Python Initialization is performed by discarding all defined functions or imported modules If this function is executed while executing a script Python is forcibly initialized regardless of the execution state If a script file is specified in scriptFile the specified script file is executed after initialization has finished If scriptFile is not specified Python is merely initialized Caution Si
110. he nickname of the microcontroller of the active proj ect project Path This property refers to the active project file name with path R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 191 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project Device This property refers to the microcontroller of the active project Specification format project Device Setting s None Reference Microcontroller of the active project Detailed description This property refers to the microcontroller of the active project Example of use gt gt gt print project Device RS5F100LE R20UT3097EJ0100 Rev 1 00 ztENESAS Page 192 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project lsOpen This property confirms whether the project has been opened Specification format project IsOopen Setting s None Reference If the project has been opened True If the project has not been opened False Detailed description This property confirms whether the project has been opened Example of use gt gt gt print project IsOpen True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 193 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project Kind This property refers to the kind of the active project Specification format project Kind Setting s None Reference
111. ht Active low representation XXX overscore over pin or signal name Note Footnote for item marked with Note in the text Caution Information requiring particular attention Remarks Supplementary information Numeric representation Decimal XXXX Hexadecimal OxXXXXX All trademarks or registered trademarks in this document are the property of their respective owners TABLE OF CONTENTS 1 GENERAL titre eea ans a aaa ea Aad hls ht DIC Le nice Serer eR Cath Rh he eth S 5 1 1 IntrOduCtOn a 2022 eee ake pete see ates un a alc oe alah pee ere ea ea dade a Hg ene ee leg 5 1 2 Features tenn ge m eth ate ae Sl ee eh oho ak a ea cole oh Su kotha we ag Rae es ok eS 5 2 FUNCTIONS ae tarde ad R a Ee EAEE EE din getter anaes ae EE AEE NE E i GR E seats 6 2 1 Execute Python FUNCIONS ie sees sonra e a e adap pp a o a gee pos Benoa epee eon cea 6 A WINDOW REFERENCE oes sues aa canted asa decinacesan ec tveem era tece glade dntucaegteravers 7 A 1 Description ossaa i r euS aa E aa ead a Sed een ede a dg AO E See ew nic ate A E E 7 B Python CONSOLE Python FUNCTIONS 00 00 eee eee eee 10 B 1 OVERVIEW ara seach Reena cei et fate descend hes aidan on Sate Gad Steet et aaa aunty ae Role nin a E A PR G 10 B 2 Related File s of 2c eat ee See bel S ota gt alia toa i Soca A set avele a fad alee aoaga na eo yl 10 B 3 CS Python Function Class Property Event 2 0 0 c cece cette teens 11 B 3 1 CS Python function for basi
112. icrocontroller of a new project by a string R20UT3097EJ0100 Rev 1 00 ztENESAS Page 27 of 225 Aug 01 2014 CS V3 00 00 Argument B Python CONSOLE Python FUNCTIONS Description projectKind R20UT3097EJ0100 Rev 1 00 Aug 01 2014 Specify the type of a new project The types that can be specified are shown below The following is automatically specified if the microcontroller type is RH850 and ProjectKind Auto is specified or projectKind is not specified When the microcontroller is single core ProjectKind Application When the microcontroller is multi core and main project ProjectKind Multicore BootLoader When the microcontroller is multi core and subproject ProjectKind MulticoreAp plication Type Description ProjectKind Application Project for application ProjectKind Library Project for library ProjectKind DebugOnly Debug dedicated project ProjectKind Empty Project for empty application ProjectKind CppApplication Project for C application ProjectKind RI600V4 Project for RIGO0V4 ProjectKind RI600PX Project for RIG00PX ProjectKind RI850V4 Project for RI850V4 ProjectKind RI850MP Project for RI850MP ProjectKind RI78V4 Project for RI78V4 ProjectKind MulticoreBootLoader Project for boot loader for multi core ProjectKind MulticoreApplication Project for application for multi core ProjectKind Aut
113. ied then events of all action event numbers will be deleted Example of use gt gt gt debugger ActionEvent Delete 1 True gt gt gt debugger ActionEvent Delete R20UT3097EJ0100 Rev 1 00 ztENESAS Page 49 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger ActionEvent Disable This function disables an action event setting Specification format debugger ActionEvent Disable actionEventNumber Argument s Argument Description actionEventNumber Specify the action event number to disable Return value If an action event setting was disabled successfully True If there was an error when disabling an action event setting False Detailed description This function disables the action event specified by actionEventNumber If actionEventNumber is not specified then events of all action event numbers will be disabled Example of use gt gt gt debugger ActionEvent Disable 1 True gt gt gt debugger ActionEvent Disable R20UT3097EJ0100 Rev 1 00 ztENESAS Page 50 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger ActionEvent Enable This function enables an action event setting Specification format debugger ActionEvent Enable actionEventNumber Argument s Argument Description actionEventNumber Specify the action event number to ena
114. iles project Open R20UT3097EJ0100 Rev 1 00 Aug 01 2014 This function opens a project ztENESAS Page 24 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project Change This function changes the active project Specification format project Change projectName Argument s Argument Description projectName Specify the full path of the project or subproject to be changed Return value If the active project was changed successfully True If there was an error when changing the active project False Detailed description This function changes the project specified in projectName to the active project The project file specified in projectName must be included the currently opened project Example of use gt gt gt project Close C project sample sub1 subproject mtpj True 22 gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 25 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project Close This function closes a project Specification format project Close save False Argument s Argument Description Specify whether to save all files being edited and a project True Save all editing files and a project False Do not save all editing files and a project default Return value If the project was closed successfully True If there was an error when closing the project False Det
115. ings Reference List of additional include paths Detailed description This property sets or refers to the compile options for the active project regarding additional include paths Add or change for the referred list to change the setting Example of use gt gt gt incpathl build Compile IncludePath Refer the current setting and add an include path gt gt gt print incpathl include C project inc gt gt gt incpathl append include2 gt gt gt build Compile IncludePath incpathl gt gt gt print build Compile IncludePath include C project ine include2 gt gt gt gt gt gt incpath2 includel include2 Set multiple include paths gt gt gt build Compile IncludePath incpath2 gt gt gt print build Compile IncludePath iancludel include2 R20UT3097EJ0100 Rev 1 00 ztENESAS Page 199 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS build Compile Macro This property sets or refers to the compile options for the active project regarding defined macros Specification format build Compile Macro macrolist Setting s Setting Description macrolist Set the defined macros as a list of strings Reference List of defined macros Detailed description This property sets or refers to the compile options for the active project regarding defined macros Add or change for
116. ion IllegalMemoryAccess Break caused by illegal memory Break access StreamloError Break caused by stream I O error CoverageMemoryAllo Failed to allocate coverage memory cationFailure TraceMemoryAlloca Failed to allocate trace memory tionFailure StepCountOver Step count over DebuggingInformation Failed to acquire debugging infor AcquisitionFailure mation Note 1 Applies to all of the following MINICUBE2 E1Serial and E20Serial Note 2 Applies to all of the following MINICUBE E1Jtag E20Jtag and MINICUBE2utag Note 3 This is only a break cause during trace Note 4 This is only a break cause during a break Example of use gt gt gt debugger GetBreakStatus Temporary gt gt gt a debugger GetBreakStatus Temporary gt gt gt print a Temporary gt gt gt if debugger GetBreakStatus BreakStatus Temporary print Temporary break Temporary Temporary break gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 83 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger GetCpuStatus This function displays the current CPU status Specification format debugger GetCpuStatus Argument s None Return value Current CPU status string CPU Status Description Hold In bus hold HoldStopldle Bus hold Software STOP Hardware STOP IDLE mode PowOff Power not su
117. ion configures XRunBreak information V850 Simulator Specification format debugger XRunBreak Set time timeType TimeType Ms periodic False Argument s Argument Description time Specify the break time timeType Specify the break time unit The units that can be specified are shown below Type Description TimeType Min Minute unit TimeType S Second unit TimeType Ms Millisecond unit default TimeType Us Microsecond unit TimeType Ns Nanosecond unit periodic Specify whether to call the callback every time the specified time elapses True Call at every specified time interval False Call one time only default Return value If XRunBreak information was configured successfully True If there was an error when configuring XRunBreak information False Detailed description This function configures XRunBreak information The XRunBreak calling interval depends on the simulator Register the Python function that is processed after the specified time passes See Hook for detail Caution If you use the following operations while program is running after the XRunBreak information is set please use these operations after program is stopped Resets the CPU Resets the CPU and then executes the program from the reset address Set Remove Breakpoints R20UT3097EJ0100 Rev 1 00 ztENESAS Page 143 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE
118. ion saves all editing files and projects Source This function runs a script file R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 12 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS ClearConsole This function clears the string displayed on the Python console Specification format ClearConsole Argument s None Return value If the string was cleared successfully True If there was an error when clearing the string False Detailed description This function clears the string displayed on the Python console Example of use gt gt gt ClearConsole True Pee R20UT3097EJ0100 Rev 1 00 ztENESAS Page 13 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS CubeSuiteExit This function exits from CS Specification format CubeSuiteExit Argument s None Return value None Detailed description This function exits from CS Caution The editing file will not be saved even if the project file has been modified Use Save function to save the editing file Example of use gt gt gt CubeSuiteExit R20UT3097EJ0100 Rev 1 00 ztENESAS Page 14 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Help This function displays the help for the CS Python functions Specification format Help Argument s None Return value None Detailed description
119. is holds mnemonic information Detailed description Disassemblelnfo is a class and it is the structure of the return value from the debugger Assemble Disassemble func tion Example of use gt gt gt info debugger Assemble Disassemble main 4 Disassemble command 0x000002DC B51D br _main 0x36 0x000002DE 0132 movOxl r6 0x000002E0 60FF3800 jarl _func_staticl lp 0x000002E4 63570100 st w r10 Ox0 sp gt gt gt print info 0 Address T32 gt gt gt print info 0 Code 0 181 gt gt gt print info 0 Code 1 29 gt gt gt print Mnemonic br _main 0x36 gt gt gt print info 3 Address 740 gt gt gt print info Code 99 gt gt gt print info Code 87 gt gt gt print info Code 1 gt gt gt print info Code 0 gt gt gt print info Mnemonic st w r10 0x0 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 160 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS DownloadInfo This class holds download information return value of the debugger Download Information function Type class DownloadInfo Number None Name None ObjectDownload SymbolDownload Variable Variable Description Number This holds the download number Name This holds the file name ObjectDownload This holds whether object information has been downloaded or not True Object information has been downloaded False Object informati
120. le Remove This function removes a file from the active project Specification format project File Remove fileName Argument s Argument Description fileName Specify the full path of the file to be removed from the active project When specifying multiple files specify in the format file1 file2 Return value If a file was removed from the active project successfully True If there was an error when a file was removed from the active project False Detailed description This function removes the file specified in fileName from the active project The file is not deleted Example of use gt gt gt project File Remove C project sample src test c True gt gt gt project File Remove C project sample src testl c C project sample src test2 c True R20UT3097EJ0100 Rev 1 00 ztENESAS Page 34 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project GetDeviceNameList This function displays the list of the device names of the microcontroller Specification format project GetDeviceNameList micomType nickName Argument s Argument Description micomType Specify the microcontroller type of a new project The types that can be specified are shown below Type Description MicomType RH850 Project for RH850 MicomType RX Project for RX MicomType V850 Project for V850 MicomTyp
121. me addressl address2 force False Argument s Argument Description fileName Specify a file name address1 Specify an upload start address address2 Specify an upload end address force Specify whether to overwrite True Overwrite False Do not overwrite default Return value If the memory data was uploaded successfully True If there was an error when uploading the memory data False Detailed description This function saves the memory data from address1 to address2 in D tagged Motorola format Example of use gt gt gt debugger Upload MotorolaldTag C test testIdTagMotorola hex 0x1000 0x2000 True True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 130 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Upload Tektronix This function saves the memory data in Techtronics format Specification format debugger Upload Tektronix fileName addressl address2 force False Argument s Argument Description fileName Specify a file name address1 Specify an upload start address address2 Specify an upload end address force Specify whether to overwrite True Overwrite False Do not overwrite default Return value If the memory data was uploaded successfully True If there was an error when uploading the memory data False Detailed description This function saves
122. ment s None Return value If the debug tool is connected True If the debug tool is not connected False Detailed description This function checks the connection status of the debug tool Example of use gt gt gt if debugger IsConnected Tru print OK True OK gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 90 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger sRunning This function checks the execution status of the user program Specification format debugger IsRunning Argument s None Return value If the user program is running True If the user program is not running False Detailed description This function checks the execution status of the user program Example of use gt gt gt if debugger IsRunning True print OK True OK gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 91 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Jump File debugger Jump Address This function displays each panel Specification format debugger Jump File fileName lineNumber 1 debugger Jump Address jumpType adddress 0 Argument s Argument Description fileName Specify the name of the file to display lineNumber Specify the line to display default 1 jumpType Specify the type of panel to display The panel types that can be specified a
123. mer at data write TimerType Access End a timer at data access Detailed description TimerCondition is in class format and the condition of a conditional timer is set in the variable In order to create a condition of a conditional timer create an instance and set conditions for that instance R20UT3097EJ0100 Rev 1 00 ztENESAS Page 166 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Example of use gt gt gt execute_timer TimerCondition Create instance gt gt gt execute_timer StartAddress main gt gt gt execute_timer StartTimerType TimerType Execution gt gt gt execute_timer EndAddress sub gt gt gt execute_timer EndTimerType TimerType Execution gt gt gt debugger Timer Set execute_timer Specify function in which to set the con ditional timer in parameter all gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 167 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS TimerEventInfo This class holds conditional timer event information return value of the debugger Timer Information function Type class TimerEventInfo umber 0 ame wee Enable True StartAddress StartData StartTimerType TimerType Execution EndAddress EndData Variable EndTimerType TimerType Execution Variable Description Number
124. module name or file name is specified in an address expression it needs to be enclosed in double quotation marks in some cases See CS Integrated Development Environment User s Manual Debug Tool for details Example When file name C path test c and function sub are specified C path test c sub Or C path test c sub Example of use gt gt gt debugger Address main 0x4088 gt gt gt debugger Address main 1 0x4089 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 56 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Assemble Disassemble This function performs disassembly Specification format debugger Assemble Disassemble address number 1 code True Argument s Argument Description address Specify the address at which to start disassembly number Specify the number of lines to display default 1 code Return value Specify whether to display instruction codes True Display instruction codes default False Do not display instruction codes List of result of disassembly see the Disassemblelnfo property for detail Detailed description This function performs disassembly from the address specified by address If number is specified the specified number of lines are displayed If code is set to False then instruction codes are not displayed If is s
125. n True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 43 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS build File This function runs a build of a specified file Specification format build File fileName rebuild False waitBuild True Argument s Argument Description fileName Specify a file to run a build rebuild Specify whether to run a rebuild of a specified file True Run a rebuild of a specified file False Run a build of a specified file default waitBuild Specify whether to wait until completing a build True Wait until completing a build default False Return a prompt without waiting to complete a build Return value When waitBuild is set to True If a build was completed successfully True If there was an error when running a build False When waitBuild is set to False If a build successfully started execution True If a build failed to start execution False Detailed description This function runs a build of a file specified by fileName If rebuild is set to True then a rebuild of a specified file is run If waitBuild is set to False then a prompt is returned without waiting to complete a build The build BuildCompleted event is issued when a build completes Example of use gt gt gt build File C test test c True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 44 of 22
126. nce Python is forcibly initialized an error may be displayed depending on the execution state Example of use gt gt gt common PythonInitialize gt gt gt gt gt gt common PythonInitialize C Test script py R20UT3097EJ0100 Rev 1 00 ztENESAS Page 23 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS B 3 3 CS Python function for project Below is a list of CS Python functions for a project Table B 3 CS Python Function For Project Function Name Function Description project Change This function changes the active project project Close This function closes a project project Create This function creates a new project project File Add This function adds a file to the active project project File Exists This function confirms whether the file exists in the active project project File Information This function displays the list of the files registered in the active project project File Remove This function removes a file from the active project project GetDeviceNameList This function displays the list of the device names of the microcontroller project GetFunctionList This function displays the list of the functions of the active project project GetVariableList This function displays the list of the variables of the active project project Information This function displays the list of project f
127. nction is executed Example of use gt gt gt ae ActionEventCondition gt gt gt ae Address main gt gt gt ae Output result gt gt gt ae Expression chData gt gt gt ae ActionEventType ActionEventType Printf gt gt gt ae_number debugger ActionEvent Set ae gt gt gt out debugger ActionEvent Get result chData 0x64 result chData 0x65 result chData 0x66 gt gt gt print out 0 Address main R20UT3097EJ0100 Rev 1 00 ztENESAS Page 153 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS BreakCondition This class creates a break condition Type class BreakCondition Address Data None AccessSize Non BreakType BreakType Hardware Variable Variable Description Address Specify the address at which to set a break Must be specified Specify the number to set as a break condition for the data If None is specified then the data condition is ignored AccessSize Specify the access size 8 16 or 32 If None is specified then all access sizes will be specified BreakType Specify the break type The break types that can be specified are shown below Type Description BreakType Software Software break except a simulator BreakType Hardware Hardware break default BreakType Read Data read break BreakType Write Data write break BreakType Access Data access br
128. nctions The results of function execution and errors are also displayed Use a print statement to display the result of IronPython functions File menu Python Console panel dedicated items The following items are exclusive for File menu in the Python Console panel other items are common to all the pan els Save Python Console Saves the content displayed in the current panel in the last text file txt to be saved Note that if this item is selected first after the program starts then the behavior is the same as selecting Save Python Console As Save Python Console As Opens the Save As dialog box to save the contents currently displayed on this panel in the designated text file txt Context menu Cuts the selected characters and copies them to the clip board Copies the selected characters to the clip board Inserts the contents of the clipboard into the caret position R20UT3097EJ0100 Rev 1 00 2tENESAS Page 8 of 225 Aug 01 2014 CS V3 00 00 A WINDOW REFERENCE Select All Selects allcharacters displayed on this panel Abort Forces the currently running command to stop Clear Clears all output results Python Initialize Initializes Python Select Script File Opens the Select Script File dialog box to execute the selected Python script file R20UT3097EJ0100 Rev 1 00 ztENESAS Page 9 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTI
129. ning build Link LibraryFile This property sets or refers to library files of the active project build Link SectionAlignment This property sets or refers to the link options for the active project regarding section alignment build Link SectionROMtoRAM This property sets or refers to the link options for the active project regarding sections where symbols are mapped from ROM to RAM build Link SectionStartAddress This property sets or refers to the link options for the active project regarding the addresses where sections start build Link SectionSymbolFile This property sets or refers to the link options for the active project regarding sections whose external defined symbols are to be output to a file build ROMization OutputObjectFile This property sets or refers to the setting for output of a ROMized object file that is the value of the ROMization process option for the active project build Version This property refers to the version of the compiler package R20UT3097EJ0100 Rev 1 00 Aug 01 2014 RENESAS Page 198 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS build Compile IncludePath This property sets or refers to the compile options for the active project regarding additional include paths Specification format build Compile IncludePath dirlist Setting s Setting Description dirlist Set the additional include paths as a list of str
130. nt s None Return value Debug tool type Description Simulator Simulator Minicube MINICUBE Minicube2 MINICUBE2 Serial connect Minicube2Jtag MINICUBE2 JTAG connect lecube IECUBE lecube2 IECUBE2 EiJtag E1 JTAG connect E1Serial E1 Serial connect E1Lpd E1 LPD connect E20Jtag E20 JTAG connect E20Serial E20 Serial connect E20Lpd E20 LPD connect Detailed description This function displays information about the debug tool Example of use gt gt gt debugType debugger DebugTool GetType Minicube2 gt gt gt if debugTyp DebugTool Simulator debugger DebugTool Change DebugTool Simulator R20UT3097EJ0100 Rev 1 00 ztENESAS Page 67 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Disconnect This function disconnects from the debug tool Specification format debugger Disconnect Argument s None Return value If the debug tool was disconnected successfully True If there was an error when disconnecting from the debug tool False Detailed description This function disconnects from the debug tool Example of use gt gt gt debugger Disconnect True Pee R20UT3097EJ0100 Rev 1 00 ztENESAS Page 68 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Download Bina
131. o ztENESAS The type of a project is selected in accord with the specification for micomType device Name and subProject default Page 28 of 225 CS V3 00 00 Argument B Python CONSOLE Python FUNCTIONS Description compiler Specify the compiler to be used If the compiler is not specified it is selected automatically depending on the microcontroller type Type Description Compiler Auto The compiler to be used is selected in accord with the specification for micomType default Compiler CC_RH CC RH If this argument is not specified when micom Type is set to MicomType RH850 CC RH is selected automatically Compiler CC_RX CC RX If this argument is not specified when micom Type is set to MicomType RX CC RX is selected automatically Compiler CA850 CA850 If this argument is not specified when micom Type is set to MicomType V850 and device Name is set to V850E or V850ES CA850 is selected automatically Compiler CX CX If this argument is not specified when micom Type is set to MicomType V850 and device Name is set to V850E2 CX is selected automatically Compiler CC_RL CC RL If this argument is not specified when Micom Type RL78 in CS for CC CC RL is selected automatically Compiler CA78KOR CA78KOR If this argument is not specified when micom Type is set to MicomType KOR or Micom Type RL78 in CS for CACX CA78KOR is selected au
132. ommon Table B 2 CS Python Function Common Function Name Function Description common GetOutputPanel This function displays the contents of the Output panel common OutputPanel This function displays the string on the Output panel common Pythonlnitialize This function initializes Python R20UT3097EJ0100 Rev 1 00 ztENESAS Page 20 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS common GetOutputPanel This function displays the contents of the Output panel Specification format common GetOutputPanel Argument s None Return value String displayed on the Output panel Detailed description This function displays the string displayed on the Output panel Example of use gt gt gt common OutputPanel True gt gt gt com common GetOutputPanel gt gt gt print com R20UT3097EJ0100 Rev 1 00 ztENESAS Page 21 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS common OutputPanel This function displays the string on the Output panel Specification format common OutputPanel output messageType MessageType Information Argument s Argument Description output Specify the string displayed on the Output panel messageType Specify the type of messages to be colored in the Output panel The colors are in accord with the settings for the General Font and Color cate gory in t
133. on has not been downloaded SymbolDownload This holds whether symbol information has been downloaded or not True Symbol information has been downloaded False Symbol information has not been downloaded Detailed description Downloadinfo is a class and it is the structure of the return value from the debugger Download Information function Example of use gt gt gt info debugger Download Information 1 DefaultBuild sample out gt gt gt print info 0 Number il gt gt gt print info 0 Name DefaultBuild sample out gt gt gt print info 0 ObjectDownload True gt gt gt print info 0 SymbolDownload True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 161 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS FunctionI Info This class holds function information return value of the project GetFunctionList function Type class FunctionInfo FunctionName None FileName None ReturnType None StartAddress None EndAddress None Variable Variable Description FunctionName This holds the function name FileName This holds the full path of the file that the function is defined ReturnType This holds the type of the return value StartAddress This holds the start address of the function EndAddress This holds the end address of the function Detailed description FunctionInfo is a class an
134. pecified in address then it is interpreted as the address following the last address disassembled Example of use gt gt gt debugger Assembl 0x00004088 F545 gt gt gt debugger Assembl 0x00004088 F545 Ox0000408A OA5A 0x00004088 br _TestInit4 0x0000408A mov Oxa 0x0000408C movea 0x19 0x00004090 mov r13 0x00004092 movhi Oxffff gt gt gt Disassemble main br _TestInit 0x8e Disassemble main 2 br _TestInit 0x8e mov Oxa ril gt gt gt debugger Assemble Disassemble main 5 False ELL r12 tOx8e x0 ELS gp rl R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 57 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Assemble LineAssemble This function performs line assembly Specification format debugger Assemble LineAssemble address code Argument s Argument Description address Specify the address at which to start assembly code Specify the string to assemble Return value If line assembly was performed successfully True If there was an error when performing line assembly False Detailed description This function performs assembly of the string specified by code from the address specified by address If is specified in address then it is interpreted as the address following the last address assembled Example of use gt gt gt debugger Assemble Disassemble
135. pplied to the target Reset In reset state Standby In standby mode Stop In STOP mode Stopldle Software STOP Hardware STOP IDLE mode Wait In wait state Halt In HALT mode Sleep In sleep state None N A Detailed description This function displays the current CPU status Example of use gt gt gt debugger GetCpuStatus Stop SSS R20UT3097EJ0100 Rev 1 00 ztENESAS Page 84 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger GetleStatus This function displays the current IE status Specification format debugger GetIeStatus Argument s None Return value Current IE status string IE Status Description Break Break in effect Coverage Coverage running Timer Timer running Tracer Trace running Step Step executing Run User program running RunOrStep User program running or step executing Caution If a PM workspace is converted to a CS project then there will be no debugging tool in the main proj ect For this reason None will be returned if the main project is the active project In addition None will be returned before the debugging tool is connected Detailed description This function displays the current IE status Example of use gt gt gt debugger GetIeStatus gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 85 of 225 Aug 01 2014 CS
136. properties classes and events which are provided by CS 1 2 Features The features of the Python console are shown below lronPython The features of IronPython can be used In the IronPython language usable in the Python console in addition to the features of the Python language various class libraries of INET Framework can be used For the language specifications of IronPython see the following URL http ironpython net Project Projects can be created and loaded The active project can also be changed Build Build can be executed in the entire project or in file units Debug The debug tool can be connected or disconnected program execution can be controlled and memory data or vari ables can be referred to or set R20UT3097EJ0100 Rev 1 00 ztENESAS Page 5 of 225 Aug 01 2014 CS V3 00 00 2 FUNCTIONS 2 FUNCTIONS This chapter describes how to use the Python console 2 1 Execute Python Functions CS enables the execution of IronPython functions and control statements and CS Python functions see B 3 CS Python Function Class Property Event added for controlling CS via command input method Select Python Console from the View menu The Python Console panel opens You can control CS and the debugging tool by executing Python functions and control statements in the panel Figure 2 1 Python Console Panel Python Conde debugger DebugTaal Change DebugTaal Simulacar True epedebug
137. re shown below Type Description JumpType Source Editor panel JumpType Assemble Disassemble panel JumpType Memory Memory panel address Specify the address to display default 0 Return value None Detailed description debugger Jump File displays the file specified by fileName in the Editor panel If lineNumber is specified then the line specified by ineNumber in the file specified by fileName is displayed debugger Jump Address displays the panel specified by jumpType If address is specified then the area corresponding to the specified address is displayed Example of use gt gt gt debugger Jump File C test testJump c gt gt gt debugger Jump File C test testJump h 25 gt gt gt debugger Jump Address JumpType Memory 0x2000 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 92 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Map Clear This function clears the mapping settings Specification format debugger Map Clear Argument s None Return value If the memory map was cleared successfully True If there was an error when clearing the memory map False Detailed description This function clears the mapping settings Example of use gt gt gt debugger Map Clear True Pee R20UT3097EJ0100 Rev 1 00 ztENESAS Page 93 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Py
138. ription fileName Specify a project file save If another project was opened specify whether to save any files being edited and the project when you close it True Save all editing files and a project False Do not save all editing files and a project default Return value If the project was closed successfully True If there was an error when closing the project False Detailed description This function opens a project specified by fileName If other project is opened that project is closed If save is set to True then all files being edited and a project are saved If other project is not opened the setting of save is ignored Example of use gt gt gt project Open r C test test mtpj True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 39 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS B 3 4 CS Python function for build tool Below is a list of CS Python functions for the build tool Table B 4 CS Python Function For build Tool Function Name Function Description build All This function runs a build build ChangeBuildMode This function changes the build mode build Clean This function runs a clean build File This function runs a build of a specified file build Update This function updates the dependencies for the build tool R20UT3097EJ0100 Rev 1 00 ztENESAS Page 40 of 225 Aug 01 2014
139. rnal tool Use the common UseRemoting property to enable or disable linking to an external tool while running Reference Current set value Detailed description This property sets and displays the setting for enabling or disabling the function for linking to an external tool at CS startup Example of use gt gt gt print common EnableRemotingStartup False gt gt gt common EnableRemotingStartup True R20UT3097EJ0100 Rev 1 00 ztENESAS Page 184 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS common Output This property refers to the execution result or the contents of an error of the CS Python function Specification format common Output Setting s None Reference Execution result or an error message of the CS Python function strings Caution Error messages can only be referred to when the common ThrowExcept property is set not to throw an exception False Remark The reference content is retained until the next CS Python function call Detailed description This property refers to the execution result or the contents of an error Example of use gt gt gt debugger Memory Read data 0x0 gt gt gt print common Output 0 R20UT3097EJ0100 Rev 1 00 ztENESAS Page 185 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS common ThrowExcept This property sets or refers to whether to throw
140. ry This function downloads a binary file Specification format debugger Download Binary fileName address append False flashErase False Argument s Argument Description fileName Specify a download file address Specify a download start address append Specify whether to make an additional download True Perform additional download False Perform overwrite download default flashErase Specify whether to initialize a flash memory before download True Initialize a flash memory before download False Do not initialize a flash memory before download default Caution If two or more parameters are specified then three parameters must be specified It is not possible to specify only fileName and address Return value If a binary file was downloaded successfully True If there was an error when downloading a binary file False Detailed description This function downloads data in binary format Example of use gt gt gt debugger Download Binary C test testModule bin 0x1000 False True gt gt gt debugger Download Binary C test testModule2 bin 0x2000 True False gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 69 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Download Binary64Kb This function downloads a binary file in within 64 KB format Specification format debugger Download Binary64Kb fil
141. s and displays the setting for whether or not to display results of Python functions for CS and error messages in the Python console Specification format common ViewOutput bool Setting s Setting Description Set whether or not to display results of Python functions for CS and error mes sages in the Python console True Display in the Python console default False Do not display in the Python console Reference Current set value Detailed description This property sets and displays the setting for whether or not to display results of Python functions for CS and error messages in the Python console Example of use gt gt gt print common ViewOutput False gt gt gt common ViewOutput True R20UT3097EJ0100 Rev 1 00 ztENESAS Page 190 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS B 3 8 CS Python property for project Below is a list of CS Python properties for a project Table B 8 CS Python Property For Project Property Name Function Description project Device This property refers to the microcontroller of the active project project lsOpen This property confirms whether the project has been opened project Kind This property refers to the kind of the active project project Name This property refers to the active project file name without path project Nickname This property refers to t
142. s function creates conditions of a conditional timer Type class TimerCondition StartAddress StartData StartTimerType TimerType Execution EndAddress EndData EndTimerType TimerType Execution Variable Variable Description StartAddress Specify an address starting timer measurement Must be specified StartData Specify a data condition number of an address starting timer measurement This specification is ignored if TimerType Execution is specified for Start TimerType StartTimerType Specify the type of timers which start timer measurement The types that can be specified are shown below Type Description TimerType Execution Start a timer at execution default TimerType Read Start a timer at data read TimerType Write Start a timer at data write TimerType Access Start a timer at data access EndAddress Specify the type of timers which end timer measurement Must be specified Specify a data condition number of an address ending timer measurement This specification is ignored if TimerType Execution is specified for EndTimer Type EndTimerType Specify the type of timers which end timer measurement The types that can be specified are shown below Type Description TimerType Execution End a timer at execution default TimerType Read End a timer at data read TimerType Write End a ti
143. s returned as a string when watchOption is specified as WatchOp tion Double or watchOption is specified as WatchOption Auto and the return value is a double type Detailed description This function displays the value of the variable specified by variableName If encode is specified then perform encoding using encode If watchOption is specified display according to watchOption R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 133 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Caution When a load module name or file name is specified as a variable variableName it needs to be enclosed in double quotation marks in some cases See CS Integrated Development Environment User s Manual Debug Tool for details Example When file name C path test c and variable var are specified C path test c var Or C path test c var Example of use gt gt gt debugger Watch GetValue testVal 128 gt gt gt debugger Watch GetValue testVal WatchOption Hexdecimal 0x80 gt gt gt debugger Watch GetValue testVal WatchOption Binary 0b10000000 R20UT3097EJ0100 Rev 1 00 ztENESAS Page 134 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Watch SetValue This function sets a variable value Specification format debugger Watch SetValue variableName value Argument s Argument Description variabl
144. s under certain use conditions Further Renesas Electronics products are not subject to radiation resistance design Please be sure to implement safety measures to guard them against the possibility of physical injury and injury or damage caused by fire in the event of the failure of a Renesas Electronics product such as safety design for hardware and software including but not limited to redundancy fire control and malfunction prevention appropriate treatment for aging degradation or any other appropriate measures Because the evaluation of microcomputer software alone is very difficult please evaluate the safety of the final products or systems manufactured by you Please contact a Renesas Electronics sales office for details as to environmental matters such as the environmental compatibility of each Renesas Electronics product Please use Renesas Electronics products in compliance with all applicable laws and regulations that regulate the inclusion or use of controlled substances including without limitation the EU RoHS Directive Renesas Electronics assumes no liability for damages or losses occurring as a result of your noncompliance with applicable laws and regulations Renesas Electronics products and technology may not be used for or incorporated into any products or systems whose manufacture use or sale is prohibited under any applicable domestic or foreign laws or regulations You should not use Renesas Electronics products or technology
145. sAlignAccess Word access to odd address Temporary Temporary break Escape Escape break Fetch Fetched from guard area or area where fetches are pro hibited IRamWriteProtect Wrote to IRAM guard area with address Note 3 IllegalOpcodeTrap Break due to illegal instruc tion exception Step Step execution break te 4 FetchGuard Fetch guard breakNote 4 TraceStop Trace stop ote 4 ExecutionFails Note 1 Note 2 R20UT3097EJ0100 Rev 1 00 Aug 01 2014 Execution failedNote 5 ztENESAS Applies to all of the following MINICUBE2 E1Serial and E20Serial Applies to all of the following MINICUBE E1Jtag E20Jtag and MINICUBE2utag Page 81 of 225 CS V3 00 00 Note 3 Note 4 Note 5 Note 6 Break trigger String This is only a break cause during trace This is only a break cause during a break Description D B Python CONSOLE Python FUNCTIONS Performed a verification check on the IRAM guard area during break and the value was overwritten if this affects multiple addresses only the first address is shown Not displayed with V850 MINICUBE on V850E ME2 etc same core when a post execution event is used jeuesozy Peroza penos Bara JOye NWIS Z aope ANNUIN L aop ANUIN Joyejnuis Joyejnwa 9eds jn4 None No break e Manual Forced break e Event
146. se gt gt gt info debugger Actionl Event0001 1 Python Action gt gt gt print info 0 1 gt gt gt print info 0 Python Action Event0001 gt gt gt print info 0 True gt gt gt Number Name Enable Event Information Enable main sub R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 152 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS ActionInfo This class holds result information of the action event return value of the debugger ActionEvent Get function Type class ActionEventInfo umber 0 ame Address Output Expression ActionEventType ActionEventType Printf HostDate n Variable Variable Description Number This holds the action event number numerical value Name This holds the name of the action event string Address This holds the address of the action event Output This holds the string to be attached at output Expression This holds the variable expression string ActionEventType This holds the type of the action event Type Description ActionEventType Printf Printf event HostDate This holds the time in the host PC when an action event occurred Take account of the time being that in the host PC Detailed description ActionInfo is a class and it is passed as the return value when the debugger ActionEvent Get fu
147. ss XTimeInfo Value 0 IsCpuClock False IsOverFlow Fals Variable Variable Description Value This holds the timer measurement IsCpuClock This holds whether this is a CPU clock measurement or not True This is a CPU clock measurement False Otherwise IsOverFlow This holds whether an overflow has occurred or not True An overflow has occurred False An overflow has not occurred Detailed description XTimelnfo is a class and it is the structure of the return value from the debugger XTime function Example of use gt gt gt info debugger XTime 9820214200nsec gt gt gt print info Value 9820214200 gt gt gt print info IsCpuClock False gt gt gt print info IsOverFlow False gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 180 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS B 3 7 CS Python property common Below is a list of CS Python properties common Table B 7 CS Python Property Common Property Name Function Description common ExecutePath This property refers to the absolute path of the folder containing the exe file of the currently running CS common ConsoleClear This property sets or refers to whether to clear the display of the Python con sole when changing the active project common EnableRemotingStartup This property sets and displays the setting for enabling or disabling
148. t gt gt print info 0 Type int gt gt gt R20UT3097EJ0100 Rev 1 00 7tENESAS Aug 01 2014 Page 178 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS XRunBreaklInfo This class holds XRunBreak information return value of the debugger XRunBreak Refer function Type class XRunBreakInfo Value 0 TimeType Timetype Min IsPeriodic True Variable Variable Description Value This holds the event interval value TimeType This holds the unit of the interval value Type Description TimeType Min Minute unit TimeType S Second unit TimeType Ms Millisecond unit TimeType Us Microsecond unit TimeType Ns Nanosecond unit IsPeriodic This holds whether the callback is used periodically Detailed description XRunBreaklnfo is a class and it is passed as the return value when the debugger XRunBreak Refer function is exe cuted Example of use gt gt gt debugger XRunBreak Set 10 TimeType S True gt gt gt info debugger XRunBreak Refer 10Second Periodic gt gt gt print info Value 10 gt gt gt print info TimeType S gt gt gt print info IsPeriodic True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 179 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS XTimelnfo This class holds timer information return value of the debugger XTime function Type cla
149. tOption Source Source line unit default NextOption Instruction Instruction unit Return value None Detailed description This function performs procedure step execution If a function call is being performed then stop after the function executes Example of use gt gt gt debugger Next gt gt gt debugger Next NextOption Instruction gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 103 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Register GetValue This function refers register IO register SFR Specification format debugger Register GetValue regName Argument s Argument Description regName Specify the register name to reference Return value Register value numeric value Detailed description This function displays the value of the register specified by regName Example of use gt gt gt debugger Register GetValue pc 0x100 gt gt gt debugger Register GetValue A RB1 0x20 gt gt gt debugger Register SetValue pc 0x200 True gt gt gt debugger Register GetValue pc 0x200 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 104 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Register SetValue This function sets the value of a register IO register and SFR Specification format debugger Regis
150. ter SetValue regName value Argument s Argument Description regName Specify the register name to set value Specify the value to set Return value If the value was set successfully True If there was an error when setting the value False Detailed description This function sets the value specified by value in the register specified by regName Example of use gt gt gt debugg GetValue pc 0x100 gt gt gt debugg GetValue A RB1 0x20 gt gt gt debugg SetValue pc 0x200 True gt gt gt debugg GetValue pc 0x200 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 105 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Reset This function resets the CPU Specification format debugger Reset Argument s None Return value None Detailed description This function resets the CPU Example of use gt gt gt debugger Reset gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 106 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger ReturnOut This function runs until control returns to the program that called the current function Specification format debugger ReturnoOut Argument s None Return value None Detailed description This function runs until control returns to the program that called the current
151. the memory data from address to address2 in Techtronics format Example of use gt gt gt debugger Upload Tektronix C test testTektronix hex 0x1000 0x2000 True True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 131 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Upload TektronixldTag This function saves the memory data in ID tagged Techtronics format Specification format debugger Upload TektronixIdTag fileName addressl address2 force False Argument s Argument Description fileName Specify a file name address1 Specify an upload start address address2 Specify an upload end address force Specify whether to overwrite True Overwrite False Do not overwrite default Return value If the memory data was uploaded successfully True If there was an error when uploading the memory data False Detailed description This function saves the memory data from address to address2 in D tagged Techtronics format Example of use gt gt gt debugger Upload TektronixIdTag C test testIdTagTektronix hex 0x1000 0x2000 True True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 132 of 225 Aug 01 2014 CS V3 00 00 debugger Watch GetValue This function refers to a variable value B Python CONSOLE Python FUNCTIONS Specification format debugger Watch GetValue variableN
152. the minimum execution time or number of clocks was over flowed True The minimum execution time or number of clocks was overflowed False The minimum execution time or number of clocks was not overflowed AverageTime This holds the average execution time AverageClockCount This holds the average execution number of clocks IsAverageOverflow This holds whether the average execution time or number of clocks was over flowed True The average execution time or number of clocks was overflowed False The average execution time or number of clocks was not overflowed TotalTime This holds the total execution time TotalClockCount R20UT3097EJ0100 Rev 1 00 Aug 01 2014 This holds the total execution number of clocks RENESAS Page 170 of 225 CS V3 00 00 Variable B Python CONSOLE Python FUNCTIONS Description IsTotalOverflow This holds whether the total execution time or number of clocks was overflowed True The total execution time or number of clocks was overflowed False The total execution time or number of clocks was not overflowed PassCount This holds the pass count IsPassCountOverflow This holds whether the pass count was overflowed True The pass count was overflowed False The pass count was not overflowed Detailed description Timerinfo is a class and it is passed as the return value when the debugger Timer Get function is executed
153. the referred list Example of use to change the setting gt gt gt macrolist build Compile Macro Refer the current setting and add a defined macro gt gt gt print macrolist RL78 gt gt gt macrolist append 78K gt gt gt build Compile Macro macrolist gt gt gt print build Compile Macro RL78 78K gt gt gt gt gt gt macrolist macrol macro2 Set multiple defined macros gt gt gt build Compile Macro macrolist gt gt gt print build Compile Macro macrol macro2 R20UT3097EJ0100 Rev 1 00 Aug 01 2014 ztENESAS Page 200 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS build lsBuilding This property confirms whether a build is running Specification format build IsBuilding Setting s None Reference If a build is running True If a build is not run False Detailed description This property confirms whether a build is running Example of use gt gt gt print build IsBuilding False Pee R20UT3097EJ0100 Rev 1 00 ztENESAS Page 201 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS build Link LibraryFile This property sets or refers to library files of the active project Specification format build Link LibraryFile filelist Setting s Setting Description filelist Set the library files of the active project as a list of strings Re
154. thon FUNCTIONS debugger Map Information This function displays map information Specification format debugger Map Information Argument s None Return value List of map information see the Maplnfo class for detail Detailed description This function displays map information number start address end address access size memory typ Example of use gt gt gt debugger Map Information 1 0x00000000 0x0005FFFF 32 Internal ROM area 2 0x00060000 Ox03FF6FFF 8 Non map area 3 OxO03FF7000 OxO03FFEFFF 32 Internal RAM area OxO3FFFO00O OxO3FFFFFF 8 SFR gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 94 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Map Set This function configures memory mapping Specification format debugger Map Set mapType addressl address2 accessSize 8 cs Argument s Argument Description mapType Specify a memory type The memory types that can be specified are shown below Type Description MapType EmulationRom Emulation ROM area MapType EmulationRam Emulation RAM area MapType Target Target memory area MapType TargetRom Target ROM area MapType Stack Stack area MapType Protect I O protect area address1 Specify a map start address address2 Specify a map end address accessSize Specify an access size bit default 8
155. tion Specify a condition of a conditional timer See the TimerCondition class for creating a conditional timer Return value Set timer event number numerical value Detailed description This function sets a conditional timer according to the contents specified with TimerCondition The specified conditional timer is registered with the following name number is a four digit decimal Python Timer number Example of use gt gt gt tc TimerCondition gt gt gt tc StartAddress main gt gt gt tc EndAddress chData gt gt gt tc EndData 0x20 gt gt gt tc EndTimerType TimerType Writ gt gt gt ts_number debugger Timer Set tc T gt gt gt print ts_number al R20UT3097EJ0100 Rev 1 00 ztENESAS Page 117 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Trace Clear This function clears the trace memory Remark This function provides the same function as debugger XTrace Clear Specification format debugger Trace Clear Argument s None Return value If the trace memory was cleared successfully True If there was an error when clearing the trace memory False Detailed description This function clears the trace memory Example of use gt gt gt debugger Trace Clear False gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 118 of 225 Aug 01 2014 CS V3 00 00 B Python CONSO
156. tion format debugger Upload Intel fileName addressl address2 force False Argument s Argument Description fileName Specify a file name address1 Specify an upload start address address2 Specify an upload end address force Specify whether to overwrite True Overwrite False Do not overwrite default Return value If the memory data was uploaded successfully True If there was an error when uploading the memory data False Detailed description This function saves the memory data from address7 to address2 in Intel format Example of use gt gt gt debugger Upload Intel C test testIntel hex 0x1000 0x2000 True True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 127 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Upload IntelldTag This function saves the memory data in ID tagged Intel format Specification format debugger Upload IntelIdTag fileName addressi address2 force False Argument s Argument Description fileName Specify a file name address1 Specify an upload start address address2 Specify an upload end address force Specify whether to overwrite True Overwrite False Do not overwrite default Return value If the memory data was uploaded successfully True If there was an error when uploading the memory data False Detailed description
157. tomatically Compiler CA78KO CA78K0 If this argument is not specified when micom Type is set to MicomType KO CA78KO is selected automatically subProject Specify whether to create a main project or a subproject False Create a main project default True Create a subproject registerNaming R20UT3097EJ0100 Rev 1 00 Aug 01 2014 When the microcontroller of the project to be created is RH850 the IOR display type is specified This argument is ignored if it is specified when the microcontroller is not RH850 The types that can be specified are shown below Type Description RegisterNaming Combined The combined naming is selected as the IOR display type RegisterNaming Structured The structured naming is selected as the IOR display type default ztENESAS Page 29 of 225 CS V3 00 00 B Python CONSOLE Python FUNCTIONS Return value If a new project was created successfully True If there was an error when creating a new project False Detailed description This function creates a new project file specified by fileName Specify the microcontroller of the project by micomType and deviceName Specify the kind of the project by projectKind If subProject is set to True then a subproject is created Example of use gt gt gt project Create c project test mtpj MicomType RX R5F52105AxFN Project Kind Application True gt gt gt R20UT3097EJ0100 Re
158. ue gt gt gt debugger Timer Get 1 Total 0 ns Pass Count 0 Average 0 ns Max 0 ns Min 0 gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 111 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Timer Delete This function deletes a conditional timer Specification format debugger Timer Delete timerNumber Argument s Argument Description timerNumber Specify the timer event number to delete Return value If a timer was deleted successfully True If there was an error when deleting a timer False Detailed description This function deletes the timer of the timer event number specified by timerNumber If timerNumber is not specified then timers of all timer event numbers will be deleted Example of use gt gt gt debugger Timer Delete 1 True 22 gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 112 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Timer Disable This function disables a conditional timer Specification format debugger Timer Disable timerNumber Argument s Argument Description timerNumber Specify the timer event number to disable Return value If a timer setting was disabled successfully True If there was an error when disabling a timer setting False Detailed description This function disables the timer of
159. uild mode Specification format build ChangeBuildMode buildmode Argument s Argument Description buildmode Specify the build mode to be changed to with a string Return value If the build mode was changed successfully True If there was an error when changing the build mode False Detailed description This function changes the build modes of the main project and subprojects to the build mode specified in buildmode If buildmode does not exist in the project a new build mode is created based on DefaultBuild and then the build mode is changed to that Example of use gt gt gt build ChangeBuildMode test_release True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 42 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS build Clean This function runs a clean Specification format build Clean all False Argument s Argument Description Specify whether to clean a project including subprojects True Clean all project including subprojects False Clean an active project default Return value If a clean was completed successfully True If there was an error when running a clean False Detailed description This function runs a clean of a project removes the files generated by a build If allis set to True then a clean of the subproject is run Example of use gt gt gt build Clea
160. ument s Argument Description breakNumber Specify the break event number to disable Return value If a break point setting was disabled successfully True If there was an error when disabling a break point setting False Detailed description This function disables the break event specified by breakNumber If breakNumber is not specified then breaks of all break event numbers will be disabled Example of use gt gt gt debugger Breakpoint Enable 1 True gt gt gt debugger Breakpoint Disable 1 True gt gt gt debugger Breakpoint Delete 1 True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 60 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Breakpoint Enable This function enables a break point setting Specification format debugger Breakpoint Enable breakNumber Argument s Argument Description breakNumber Specify the break event number to enable Return value If a break point setting was enabled successfully True If there was an error when enabling a break point setting False Detailed description This function enables the break event specified by breakNumber If breakNumber is not specified then breaks of all break event numbers will be enabled Example of use gt gt gt debugger Breakpoint Enable 1 True gt gt gt debugger Breakpoint Disable 1 True gt
161. ument s Argument Description fileName Specify a download file address Specify a download start address append Specify whether to make an additional download True Perform additional download False Perform overwrite download default flashErase Specify whether to initialize a flash memory before download True Initialize a flash memory before download False Do not initialize a flash memory before download default Caution If two or more parameters are specified then three parameters must be specified It is not possible to specify only fileName and address Return value If a binary file was downloaded successfully True If there was an error when downloading a binary file False Detailed description When using the memory bank this function downloads binary files in memory bank format Example of use gt gt gt debugger Download BinaryBank C test testModule bin 0x1000 False True gt gt gt debugger Download BinaryBank C test testModule2 bin 0x2000 True False gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 71 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Download Coverage This function downloads coverage data IECUBE IECUBE2 Simulator Specification format debugger Download Coverage fileName Argument s Argument Description fileName Specify a coverage data file Return
162. v 1 00 ztENESAS Page 30 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project File Add This function adds a file to the active project Specification format project File Add fileName category Argument s Argument Description fileName Specify the full path of the file to be added to the active project When specifying multiple files specify in the format file1 file2 category Specify the category that the file is added default not specified When specifying multiple levels specify in the format one two Return value If a file was added to the active project successfully True If there was an error when a file was added to the active project False If there was an error when any files were added to the active project when multiple files were specified for fileName False Detailed description This function adds the file specified in fileName to the active project If category is specified the file is added below that category If the specified category does not exist it is created newly Example of use gt gt gt project File Add C project sample src test c test True gt gt gt project File Add C project sample src testl c C project sample src test2Z c test sre True R20UT3097EJ0100 Rev 1 00 ztENESAS Page 31 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS project
163. y the unit to set The units that can be specified are shown below Type Description MemoryOption Byte Byte unit 8 bits default MemoryOption HalfWord Half word unit 16 bits RH850 RX V850 MemoryOption Word Word unit RL78 78K 16 bits RH850 RX V850 32 bits Return value If the memory was written to successfully True If there was an error when writing to the memory False Detailed description This function writes in accord with the setting of memoryOption the list of values specified by valuelist to the address range starting at the address specified by address Example of use gt gt gt mem 0x10 0x20 0x30 gt gt gt debugger Memory WriteRange 0x100 mem MemoryOption Byte True gt gt gt debugger Memory ReadRange 0x100 3 MemoryOption Byte 0x10 0x20 0x30 gt gt gt debugger Memory WriteRange 0x100 mem MemoryOption Word True gt gt gt debugger Memory ReadRange 0x100 3 MemoryOption Word 0x00000010 0x00000020 0x00000030 R20UT3097EJ0100 Rev 1 00 ztENESAS Page 102 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Next This function performs procedure step execution Specification format debugger Next nextOption NextOption Source Argument s Argument Description nextOption Specify the execution unit The units that can be specified are shown below Type Description Nex
164. y to Return value If the memory was copied successfully True If there was an error when copying the memory False Detailed description This function copies the memory from address1 to address2 into address3 Example of use gt gt gt debugger Memory Copy 0x1000 0x2000 0x3000 True gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 97 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS debugger Memory Fill This function fills the memory Specification format debugger Memory Fill address1 address2 value memoryOption MemoryOption Byte Argument s Argument Description address1 Specify the start address to fill address2 Specify the end address to fill to value Specify the fill value memoryOption Specify the fill unit The units that can be specified are shown below Type Description MemoryOption Byte Byte unit 8 bits default MemoryOption HalfWord Half word unit 16 bits RH850 RX V850 MemoryOption Word Word unit RL78 78K 16 bits RH850 RX V850 32 bits Return value If the memory was filled successfully True If there was an error when filling the memory False Detailed description This function fills from address to address2 with value If memoryOption is specified fill according to that specification Example of use gt gt gt debugger Memory Fill 0x1000 0x2000 OxFF
165. ze 32 gt gt gt print info 0 MapTypeName Internal ROM area gt gt gt print info 5 StartAddress 67104768 gt gt gt print info EndAddress 67108863 gt gt gt print info AccessSize 8 gt gt gt print info 5 MapTypeName I O register area gt gt gt OO O O7 O R20UT3097EJ0100 Rev 1 00 ztENESAS Page 164 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS StackInfo This class holds stack information return value of the debugger Where function Type class StackInfo Number 0 AddressInfoText None Variable Variable Description Number This holds the stack number AddressInfoText This holds the stack address information as a string Detailed description Stacklnfo is a class and it is the structure of the return value from the debugger Where function Example of use gt gt gt info debugger Where 1 test2 c 2 testl c main 41 gt gt gt print info 0 Number 1 gt gt gt print info 0 AddressInfoText test2 c gt gt gt info debugger Where 1 test2 c Information below might be inaccurate 2 testl c main 41 gt gt gt print a 1 Number None gt gt gt print a 1 AddressInfoText Information below might be inaccurate gt gt gt R20UT3097EJ0100 Rev 1 00 ztENESAS Page 165 of 225 Aug 01 2014 CS V3 00 00 B Python CONSOLE Python FUNCTIONS TimerCondition Thi

CS+ V3.00.00 Integrated Development Environment User`s Manual

Contents

Download Pdf Manuals

Related Search

Related Contents