REJ10J1131-0900 Renesas FLASH Development Toolkit 3.07 (for Windows® 98SE/Me, Windows NT® 4.0, Windows® 2000 and Windows® XP) User's Manual Renesas FLASH Microcomputer Programming System HS6400FDIW3S Rev. 9.00 Revision Date: Oct. 31, 2006 www.renesas.
Notes regarding these materials 1. This document is provided for reference purposes only so that Renesas customers may select the appropriate Renesas products for their use. Renesas neither makes warranties or representations with respect to the accuracy or completeness of the information contained in this document nor grants any license to any intellectual property rights or any other rights of Renesas or any third party with respect to the information in this document. 2.
Table of Contents i. Cautions............................................................................................ i ii. Preface.............................................................................................. ii iii. Abbreviations ................................................................................... iii iv. Document Conventions.................................................................... iv Chapter 1 1.1 1.2 Chapter 2 2.1 2.2 2.3 3.3 System Overview ....
3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.3.9.3. Opening data files from the command line with Access Rights password security enabled...................................................................................................19 3.3.9.4. Opening w4f Script Configuration files from the command line.........................19 3.3.9.5. Opening w4f Script Configuration files from the command line with Access Rights password security enabled...................................................
Chapter 4 4.1 4.2 4.3 4.4 4.5 4.6 4.7 Chapter 5 5.1 5.2 5.3 Wait For Script................................................................................. 43 Wait For Script Overview.................................................................................................43 Wait For Script – New Configuration...............................................................................43 4.2.1 Script File Page ...................................................................................
5.3.6 Close....................................................................................................................59 Chapter 6 Configuring the User Interface ........................................................ 61 6.1 6.2 6.3 6.4 6.5 6.6 Arranging Windows .........................................................................................................61 6.1.1 Minimising windows ...........................................................................................61 6.1.
.5 7.6 7.7 7.8 7.4.8 Field Programming..............................................................................................69 Tools Menu ......................................................................................................................70 7.5.1 Administration.....................................................................................................70 7.5.2 Customise... .................................................................................................
.2 8.3 8.4 8.5 8.6 8.7 8.8 8.1.2.6. Properties.............................................................................................................77 8.1.2.7. Set as current Project ...........................................................................................78 8.1.2.8. Remove Project ...................................................................................................78 8.1.2.9. Unload Project.........................................................................
8.8.8 Toggle ASCII Column.........................................................................................93 8.8.9 Create Selection...................................................................................................93 8.8.10 Fill... ....................................................................................................................93 8.8.11 Find... ..................................................................................................................93 8.8.
.2 Dialog Controls ................................................................................................................105 10.2.1 Exit ......................................................................................................................105 10.2.2 Download File radio button .................................................................................105 10.2.3 Download File Area ............................................................................................
i. Cautions Renesas neither warrants nor grants licenses of any rights of Renesas’ or any third party’s patent, copyright, trademark, or other intellectual property rights for information contained in this document. Renesas bears no responsibility for problems that may arise with third party’s rights, including intellectual property rights, in connection with use of the information contained in this document. Products and product specifications may be subject to change without notice.
ii. Preface About this guide This guide explains the use of the Renesas Flash Development Toolkit(hereafter referred to as FDT). Chapter 1 , Introduction, provides a brief explanation to the tool and lists its key features. Chapter 2 , System Overview, describes how the different facilities make up the FDT Graphical User Interface. Chapter 3 , Using FDT, describes how FDT is activated and the FLASH ROM is written.
iii. Abbreviations Target / Device Refers to the programmable microcontroller or microcomputer that is connected to the PC ready for programming. DLL Dynamic Linked Library FDT Flash Development Toolkit F-ZTAT ® Flexible Zero Turn-Around Time QzROM One time programmable memory HEW Renesas High-performance Embedded Workshop PC Personal Computer USB Universal Serial Bus 1.
iv. Document Conventions This manual uses the following typographic conventions: CONVENTION MEANING [Menu->Menu Option] ‘dialog name’ Bold text with ‘->’ is used to indicate menu options (for example, [File->Save As...]). The ‘’ is used to indicate the name of a dialog box or menu. ‘Filename.ext’ Bold Courier Font is used to indicate filenames. “enter this string” Used to indicate text that must be entered (excluding the “” quotes). Key+Key Used to indicate required key presses. For example.
Chapter 1 Introduction The RenesasFlash Development Toolkit (FDT) is an on-board FLASH programming tool for Renesas FZTAT microcomputers that provides a high-performance and user-friendly Graphical User Interface (GUI). Embedded software development projects created using the Renesas High-performance Embedded Workshop (HEW) may be programmed into Renesas F-ZTAT devices using FDT. FDT may also be used as a general purpose S-Record or Hex editor. 1.
2
Chapter 2 System Overview FDT provides a method of programming, erasing and reading from Renesas Flash devices. Workspaces and Projects can be used in order to save the settings between sessions, for easy switching between different settings, and to allow experienced users to configure the settings for less experienced operators. FDT is designed to provide a common look and feel, independent of the actual device to be programmed.
2.1 User Interface The FDT Graphical User Interface is a Windows® application that presents a work environment, which allows the user to program FLASH memory. Figure 2-1 2.1.1 FDT Graphical User Interface Menu bar Commands are grouped into related areas on the Menu bar as indicated by the menu titles. Using the mouse the user can select a command operation, invoke a dialog box or a window to interact with the system.
Figure 2-2 Menu Ellipsis If a menu item can also be invoked by pressing a hot key (a combination of keys), then the hot key is displayed to the right of the item. If a menu item toggles a feature ON or OFF then a check mark (9) will be displayed next to its text when it is ON: Figure 2-3 Checked Menu Items If a menu item has the symbol (8) next to it then a cascading or hierarchical menu is available.
2.1.2 Toolbars FDT has several toolbars located below the Menu bar. This provides quick access to FDT features by clicking the respective button with the mouse. Figure 2-5 FDT Toolbars The buttons on each toolbar are arranged in associated groups. To find out the function of the button, move the mouse over the button and a hint will be displayed next to the button and in the status bar.
FDT toolbar Figure 2-7 FDT Toolbar Connect - connects the device to the interface. Disconnect - disconnects the device from the interface. Erase Blocks - launches the ‘Erase Block’ dialog box to erase all or individual blocks of the device FLASH memory. Blank Check - checks whether or not the FLASH section of the target device is blank. Upload - launches the ‘Upload Image’ dialog box to allow data to be obtained from the target device.
S Record toolbar Figure 2-8 S Record Toolbar View as Bytes - view the file data as 8 bit bytes. View as Words - view the file data as 16 bit words. View as DWords - view the file data as 32 bit double words. Align view to 8 bytes - data is displayed on each line as 8 bytes. The number of bytes that can be accommodated on each line is dependent upon the size of the window. Toggle ASCII - turns ASCII data ON or OFF Find - launches the ‘Find’ dialog box. Find and Replace - launches the ‘Replace’ dialog box.
Automatic Protection – Set QzROM security protection automatically on disconnect (if more than one option is available a dialog will appear to select which type to automatically apply) Query Protection – Ask the user whether to set QzROM security protection on disconnect. No Protection – Never set QzROM security protection on disconnect.
2.1.4 Pop-up menus Many windows have local pop-up menus in order to make commonly used features easier to access. These menus are invoked by clicking the right mouse button in the window (or pressing SHIFT+F10) and then selecting the required menu option. An example pop-up menu is: Figure 2-11 Pop-up Menu The contents and operation of specific pop-up menus are explained in detail in the description of each FDT window, see the Chapter 8 ,Windows. 2.2 Help FDT has a standard Windows® help system.
2.3 Hot Keys There are various hot keys for frequently used operations.
Description Hot Key View as ASCII Alt+A View as Bytes Alt+1 View as Word Alt+2 View as Dword Alt+4 Align to 8 Bytes Alt+8 Connect Ctrl+Alt+C Erase Flash Blocks Ctrl+Alt+E Blank Check Ctrl+Alt+B Upload Image Ctrl+Alt+U Download Active File Ctrl+Alt+P Flash Checksum Ctrl+Alt+S Go From Address Ctrl+Alt+G Block Locking...
Chapter 3 Using FDT 3.1 Quickstart The stages required in order to program a device are as follows: 1) Start FDT by selecting ‘Start’->‘Programs’ -> ‘Renesas’ -> ‘Flash Development Toolkit3.07’, then the ‘Flash Development Toolkit3.07’ shortcut [see section 3.3] 2) Create a Workspace and Project [see section 3.4.1] 3) Configure the Project using the Flash Project Wizard (select device, kernel, port, mode etc) [see sections 3.4.2 to 3.4.8 or section 3.
3.2.2 What is the difference between Boot Mode and User Mode? The Renesas Flash devices have different modes of operation which are controlled by the state of the mode pins when the device is brought out of reset. Most devices have an asynchronous serial Boot Mode and a User/User Program Mode. Generally, (asynchronous serial) Boot Mode connections, start with an autobaud – sending synchronisation data packets to setup initial communications at a given baud rate.
User Mode – The User Mode Test Program and User Mode Micro-Kernel need to be already programmed and executing on the device. The initial Bit Rate Register value is held in the ‘gentest.h’ file and is compiled into the User Mode Test Program; this allows the kernel initialise the serial communications interface to 9600 baud. If the clock frequency changes from the default supplied value, the initial Bit Rate Register setting in ‘gentest.
for changing settings such as fine tuning of timeouts, requires the Local Machine Administrator rights to save the settings. Password administration also requires Local PC Administrator rights. 3.2.7 How do I recompile a kernel? It is recommended that the original kernel is copied to another directory and that this copy is edited, thus leaving the original kernel unmodified. When using the kernel for the first time, you will need to browse to the alternate location to find the fcf file.
3.2.9 Can I modify the User Mode kernels to work for a different clock frequency? It is recommended that the original kernel is copied to another directory and that this copy is edited, thus leaving the original kernel unmodified. When using the kernel for the first time, you will need to browse to the alternate location to find the fcf file. The User Mode kernels need to be rebuilt if a different clock frequency is going to be used. The initial Bit Rate Register value is held in the ‘gentest.
3.3.3 Starting FDT by double clicking on a workspace file FDT can be started by double clicking on a workspace file from Windows® Explorer. This will cause FDT to load the selected workspace upon start up. 3.3.4 Starting FDT by double clicking on a data file FDT can be started by double clicking on a registered data file from Windows® Explorer (if this default option was not unselected during installation). This will cause FDT to load the selected data file upon start up. 3.3.
This is the method used when an FDT workspace is double clicked in Windows® Explorer 3.3.9.3. Opening data files from the command line with Access Rights password security enabled "\FDT.exe" "arl \"\" \"\"" /DISCRETESTARTUP "osre \"< Filename >\"" eg "C:\Program Files\Renesas\FDT3.07\FDT.exe" "arl \"Administrator\" \"password\"" /DISCRETESTARTUP "osre \"C:\Program Files\Renesas\files\myfile.mot\"" 3.3.9.4.
3.4 Creating a New Workspace and Project When FDT is started in full mode (not FDT Basic Simple Interface Mode), a workspace and project must be opened or created. See Chapter 10 Basic Simple Interface Mode for details on programming without setting up a workspace and project. 3.4.1 New Project Workspace Figure 3-2 New Workspace Enter the workspace name (the project name is the same by default), then click the ‘OK’ button.
3.4.2 Choose Device and Kernel (not Generic Boot*) Select the device you wish to use from the drop-down list. It is possible to have more than one kernel option displayed, and double clicking on a kernel will open an optional “readme.txt” file that has information about the kernel (such as the device, version number and the compilers it was created with). Select the required kernel from the displayed list, or if you have an alternative kernel elsewhere, which is not in the list, select ‘Other...
3.4.3 Communications Port Select the port (and interface if available) from the drop-down list, then click the ‘Next’ button. Note that in addition to the serial ports, there is also an option to use the FDM (USB interface board). For some kernels there are also other port options, such as USB Direct (eg. for the 2215UF), E8, E8Direct and FoUSB. For Protocol A (legacy) kernels the ‘HMSE UPB’ interface is available in addition to Direct Connection.
3.4.4 Device Settings Enter values for the device settings; enter the input clock, then select the main and peripheral clock multipliers from the drop-down lists, and click the ‘Next’ button. Figure 3-5 Device Settings Supplementary: 1. Clock Setting Allow selection of the device external clock (default) or one or more of the device internal clock speeds. 2. CPU Crystal Frequency Enter the frequency of the CPU clock or the crystal generator. This can be specified up to 4 decimal places.
3.4.5 Connection Type Select whether the connection is for Boot Mode or User Mode in the ‘Connection Type’ dialog. Additionally, for a connection to a kernel that is still running on the device from a previous session, select the ‘Kernel already running’ check box. Next, select the communication speed (bps) if the default value is not correct or not present.
3.4.6 Programming Options Select the protection level for programming the FLASH ROM and the messaging level, then click the ‘Finish’ button, or if the FDM\E8Direct was selected, click ‘Next’ to continue. Figure 3-7 3.4.7 Programming Options FDM\E8Direct Pin Settings [Only if the FDM or E8Direct is selected] Select the ‘Operating Mode’ and ‘Clock Mode’ and if ‘User Defined’, set the pin settings.
Figure 3-8 Figure 3-9 26 FDM Pin Settings E8Direct Pin Settings
3.4.8 Reset Pin Settings [Only if the FDM or E8Direct is selected] Select the ‘Operating Mode’ and ‘Clock Mode’ and if ‘User Defined’, set the Reset pin settings. Set the ‘Reset Outputs’ and the ‘Reset Setting’ for the mode required immediately after disconnection. Click the ‘Finish’ button. “*Mode Outputs” sets which pins are driven by the FDM, “*Mode Setting” sets whether output pins are driven High (checked) or Low (Unchecked). Notes: Setting the mode pins using the FDM or E8Direct requires caution.
Figure 3-11 28 E8DirectRESET Pin Settings
3.5 Configuring a Project for a Generic Boot Device It is also possible to connect to a Generic Boot Renesas Device - where you do not need a kernel or configuration file installed, instead FDT extracts the required information from the device itself. Because of this, the device must be connected and set into Boot Mode at the time you create the project.
3.5.2 Generic Boot - Choose Device and Kernel Select ‘Generic Boot Device’ (or a device supported by Generic Boot) and click ‘Next’. Figure 3-13 Generic Boot Device Selection Note - Some Protocol C devices which appear in the device list are supported by using Generic Boot.
3.5.3 Generic Boot - Communications Port Select the port (and interface if available) from the drop-down list, then click the ‘Next’ button. Figure 3-15 3.5.4 Communications Port Generic Boot - FDM Pin Settings [FDM connection only] If the FDM is selected the following screen will be shown. Set the mode pin settings required to place the device into Boot Mode.Click ‘OK’ to continue.
Note Setting the mode pins using the FDM requires caution. Please confirm the pin settings with the hardware manual even if a default setting is available. Note that in some devices, changing the mode pin setting changes the maximum supply voltage. When the ‘Select USB Device’ Dialog is displayed you must select which FDM unit is to be used to set up the connection. Figure 3-17 3.5.
Figure 3-19 Note E8DirectGeneric Device Pin Settings Setting the mode pins using the E8Direct requires caution. Please confirm the pin settings with the hardware manual even if a default setting is available. Note that in some devices, changing the mode pin setting changes the maximum supply voltage. If the E8 has not yet been restarted as an E8Direct device then the following messages will appear in the FDT output window: Preparing for re-enumeration of E8 to E8Direct... Sending re-enumeration command...
3.5.6 Generic Boot - Confirmation FDT then waits for you to confirm that the device is connected and powered, and if not using the FDM or E8Direct, in Boot mode. FDT will try to connect to the device when you click ‘OK’. Figure 3-21 Generic Boot Confirmation After this, FDT displays a dialog that displays the boot progress. At various points during the Generic Boot process, the user is required to select or confirm details of the device; see below for details. 3.5.
3.5.8 Generic Boot – Select Clock Mode Because some devices have a number of Clock Modes, a list is provided of all possible Clock Modes. The user should select the correct Clock Mode from the list then click ‘OK’. Please check with the hardware manual / target board manual to ensure that the correct mode is chosen.
3.5.9 Generic Boot – Setup Complete Having selected the Clock Mode, the Generic wizard completes as below. Figure 3-24 Generic Boot setup complete The Project Wizard will then continue through the remaining pages 3.5.10 Generic Boot – Device Settings Please Refer to Section 3.4.4 3.5.11 Generic Boot - Connection Type Please Refer to Section 3.4.5 3.5.12 Generic Boot – Programming Options Please Refer to Section 3.4.6 3.5.
3.6 Connecting to the device This is achieved by selecting the Device->Connect to Device menu item, using the Ctrl-Alt-C hotkey, or clicking the Connect toolbar button. If a flash operation (Upload, Download, Blank Check, Checksum etc) is selected before a connection is established, FDT will automatically perform a connect operation first. 3.6.
3.6.3 Locking For devices which support locking of erase blocks FDT may also check with the user whether to unlock the device. This is dependent on the current locking settings (see more on this in the Locking Connection section ) Figure 3-27 Locking Query Dialog 3.7 Programming the Data to the FLASH ROM 3.7.1 Programming an individual file to the User Area (normal flash area) 1. Select [Project->Add Files...] or press the INS key to add the file to be downloaded to the project. 2.
3.7.4 Programming multiple files to the User Boot Area 1. Add all the required target files to the project by selecting [Project->Add Files...] or pressing the INS key. Note that multiple files can be added at once from the ‘Add File(s)’ dialog. 2. Click the right mouse button on each file displayed in the workspace window which is destined for the User Boot Area, and select ‘User Boot Area File’ to mark it as being for the User Boot Area. 3.
3.8 1. 2. 3. 4. Erasing Data from the FLASH ROM Select [Device -> Erase FLASH blocks...] to display the ‘Erase Blocks’ dialog box. Select the block(s) to be erased. (When the checkbox is ticked, the block is selected.)* Click the ‘Erase’ button to start erasure. When ‘Erase complete’ is displayed in the output window, erasure is completed. Figure 3-28 Erase Blocks *Note To erase all blocks, clicking the ‘Select All’ button will tick every available check box.
3.9 Uploading the FLASH ROM Data 1. Display the ‘Upload Image’ dialog box from [Device -> Upload Image...].either 2. Select the Address tab 3. Enter the start and end addresses, or the start address and length. 4. Click the ‘Upload’ button to start reading. or 5. Select the Tree tab 6. Select the blocks to be uploaded (corresponding to the erase blocks and\or the device flash areas). 7. Click the ‘Upload’ button to start reading.
Figure 3-30 Upload Image Dialog – Tree The Upload via erase block has the same selection functionality as the Erase block dialog itself, i.e. ‘Select All’ will check every block (a complete device upload) and ‘Select Written’ will check the non-blank blocks (an upload of programmed areas). 3.10 Performing a Blank Check For kernels which support it, a blank check can be performed by selecting the ‘Device->Blank Check’ menu item. This will perform a blank check on all available device areas (e.g.
Chapter 4 Wait For Script 4.1 Wait For Script Overview This mode allows FDT to be automated and controlled by a text file containing a script of commands. Once in this mode FDT acts as a server which polls for the existence of a file in a predetermined location. Once this file is found, FDT executes each command in order and can then optionally delete or move the script file upon completion, so that FDT is ready to look for the next script file.
4.2.1.1. Description This is an optional text description that may be used to describe, e.g. who created the file, why it was created, what it does, etc. It is not used in any way, other than for display. 4.2.1.2. Script Path This is the only mandatory field. This edit box allows the user to set up where to find the script file to run. This can either be a specific file (e.g. c:\Scripts\MyScript.fsf) or a directory and wildcard combination (e.g. c:\Scripts\*.fsf). The File...
4.2.2.1. Log File Directory Enter the directory that the optional log file should be created in. FDT can insert additional details into the directory path such as the user name, machine name, date or time by using the %U, %M, %D and %T delimiters. 4.2.2.2. Log File Name Enter the name of the optional log file. FDT can insert additional details into the file name such as the user name, machine name, date or time by using the %U, %M, %D and %T delimiters. 4.2.2.3.
4.2.3.3. Save This saves the FDT Script Configuration file (with the default extension .w4f). FDT will prompt to ask if you want to execute the saved script immediately. 4.2.4 Error Handling Page This is an optional page. Figure 4-4 Error Handling Page 4.2.4.1. On Script Fail Abort - leave the On Script Fail radio button set to the default Abort to cause FDT to abort processing of further scripts upon encountering an error.
Alert output|** Please reset the board and regenerate the script to retry ** Alert output|****************************************************************** # Delete the script file which failed # so that FDT will wait for it to be regenerated before retrying delete $script # Script processing failure handling script example 2 # Disconnect to allow reconnection Disconnect # Display a message to the user Alert output|****************************************************************** Alert output|********** T
4.3 Wait For Script – Edit Configuration... This is invoked from the ‘Tools’, ‘Wait For Script’, ‘Edit Configuration...’ menu and allows you to edit the configuration settings for a given configuration file. 4.4 Wait For Script Run Configuration... This is invoked from the Tools, Wait For Script, Run Configuration... menu and allows the user to browse to select the desired Wait For Script Configuration file (.w4f). FDT then enters Wait For Script mode: Figure 4-5 4.
Workspace 4.5.1 Description = loads a specified workspace into FDT (Note: a valid workspace and configured project must be opened to use any of the device-related commands) Arguments: Required The path to the workspace Example: Workspace C:\Workspaces\3069serial\3069serial.AWS NB: FDT will use the active project from this workspace – there is currently no facility for changing which is the active project from the script Connect 4.5.
Connect USB|0x000D|0 Connect USB|FDM|SN: 93506 Connect USB|E8|0001|5.0|0.0 Download 4.5.3 Description = download the selected project image to the device Arguments: “image” “user” “userboot” “both” Required (One of) Required (One of) “norebuild” Optional “verify” Optional Download the device image Download the named file Download the user image\Download to the user area Download the user boot image\Download to the user boot area. This can also be used to download to the User Area.
BlankCheck 4.5.5 Description = check if the device is blank Arguments: “userboot” “stoponwritten” “stoponblank” Example: Optional Optional Optional Tells FDT to check the user boot area of flash (if supported) Stop processing the script if the device is not blank Stop processing the script if the device is blank BlankCheck BlankCheck userboot|stoponwritten Upload 4.5.
Disconnect 4.5.8 Description = disconnect from a device. Note that issuing of a disconnect command even if FDT is not connected is allowed. This can be useful for ensuring that FDT is disconnected before a connect operation. Arguments: “reset” Optional Tells FDT to perform a reset as part of the disconnect Example: Disconnect Disconnect reset RebuildImage 4.5.
Alert 4.5.11 Description = indicate to the user that something has happened Arguments: Required (One of) “beep” “output” FDT will output a warning beep FDT will output a message on the active project tab Example: Alert output|Please make sure the board is connected Pause 4.5.12 Description = this command will pause script file execution for the specified number of milliseconds Arguments:
Move \ Copy 4.5.14 Description = move or copy the script file. NB: FDT will process the script no further than this line Arguments: “$script” Required Required Copy\move\rename this script file The file\directory the source file is to be copied\moved\renamed to Example: Move $script |\\server\networkfiles\done.txt Copy $script|C:\backups\ Abort 4.5.15 Description = stop processing the script and return failure.
4.6 Wait For Script – Example Script File What follows is an example of how a script file for FDT may look. This highlights some of the available commands and gives an idea of how they might be used: # EXAMPLE SCRIPT FILE # open this workspace and associated project # (for which the flash project wizard must have completed successfully) workspace C:\Workspaces\2215usbdirect\2215UsbDirect.
# Display message in output window alert output|This text will be displayed in the output window and the log file # delete this script # (will stop FDT from running through the file again) delete $script 4.7 Wait For Script – Status File Format While FDT is in Wait For Script mode, a remote user may wish to find out what state the application is currently in. This is achieved by having a status file that FDT writes to as it carries out actions and which an external user can read.
Chapter 5 Access Rights 5.1 Access RightsOverview To prevent accidental changing of settings when using FDT to program devices (especially in a multi-user environment), the Access Rights feature allows creation of usernames and passwords to give different levels of access to different users.
5.3.1 Disable All This button allows disables all user accounts and switches off Access Rights password security 5.3.2 Modify User This button allows modification of the settings for the selected user by invoking the Modify User dialog.
5.3.4 Delete User This button allows deletion of user accounts. 5.3.5 Reset Pwd This button allows setting of the password for the selected user. 5.3.6 Close This button closes the User Admin Dialog.
60
Chapter 6 Configuring the User Interface When the user interface for FDT was designed an attempt was made to make frequently used operations quickly accessible and have related operations grouped in a logical order. However, when the user is in the middle of a long session he may find it more useful to have a different arrangement of the user interface items. FDT facilitates this user customisation.
2. A specific window can also be selected by clicking on the tab containing the file name at the bottom of the Editor window. If the window is not minimised it will be brought to the front of the display. If it is minimised, the minimised icon will be brought to the front of the display. 6.3 Enabling/disabling the Toolbar The user has the option to enable or disable the Toolbar. By default, the Toolbar is displayed at the top of the FDT application window.
6.6 Customising the Toolbar The selection and arrangement of buttons displayed on the Toolbar can be customised to suit a user’s requirements. To change the display, invoke the [Tools->Customise...] menu option. The defaults are to display the Editor, Search, FDT, QzROM and S-Record toolbars. Note that the S-Record Toolbar option is only available when there is a data file open.
64
Chapter 7 Menus Figure 7-1 7.1 FDT Menus File Menu The ‘File’ menu is used for aspects of the program that access data files. 7.1.1 Close This will close the current active file in the editor window. 7.1.2 New Workspace... Launches the ‘New Workspace’ dialog box allowing the user to specify the name and location of a new workspace and creates a new workspace directory. 7.1.3 Open Workspace... Launches the ‘Open’ dialog box allowing the user to open an existing FDT Workspace file (.aws). 7.1.
7.1.6 Open an S-Record... Launches the ‘Open an S-Record’ dialog box allowing the user to open an existing file. The file may be an S-Record file (.rec, .mot, .a20, .a37, .s2), a Device Image file (.fpr, .ddi), or a binary file (.bin, .cde). 7.1.7 Save Saves the current active file. 7.1.8 Save As... Launches the ‘Save As’ dialog box allowing the user to save and name the currently open file.. 7.1.9 Exit Closes and exits the FDT application. 7.
7.2.8 Find In Files... This launches a dialog to allow data to be located in files external to the active file. 7.2.9 Replace... This will launch the ‘Replace’ dialog box allowing the user to enter either the hexadecimal or ASCII data to be found and the replacement data, in the same format. The scope of the search is bounded by the area selected, for the active file in the Editor window.
Figure 7-2 File Extensions Dialog 7.4.5.1. File Extensions Add... Selecting ‘Add...
7.4.5.2. File Extensions Modify... Selecting ‘Modify...’ allows selection of how FDT handles files of this extension type. Figure 7-4 7.4.6 Modify File Extensions Dialog Rebuild Image Rebuilding the image merges all files in the project that are not excluded. The default ROM area is the User Area, some devices also have a User Boot Area or a Data Area. FDT will warn if the component files overlap.
7.5 Tools Menu The ‘Tools’ menu is used to launch additional FDT features, which are not related to either projects or target devices. 7.5.1 Administration... This displays a dialog with the tools available to the user under different categories. 7.5.2 Customise... This allows the user to customise FDT, and is covered in more detail in section 8.9Customise - Toolbars. 7.5.3 Options... Allows access to additional features, some of which are reserved for future enhancements.
7.6 Window Menu The ‘Window’ menu is used to alter the display of currently open windows within the FDT GUI. Files displayed in the Editor window are appended to the following list, these files are identified by their filename and the currently active file is denoted by check mark. 7.6.1 Cascade This option allows multiple windows to be staggered so that each file is visible. 7.6.2 Tile Horizontally This option allows the windows to be displayed with maximum possible horizontal width. 7.6.
7.7.4 Blank check This launches a blank check on the device FLASH and reports back to the Output window. 7.7.5 Upload Image This launches the ‘Upload Image’ dialog box, which enables the uploading of a range of data from the target device. This is intended for access with FLASH memory. The data is placed in the Editor window. 7.7.6 Download Active File This downloads the current active file into the target FLASH memory. 7.7.
7.8.3 About... Launches the ‘About Flash Development Toolkit’ dialog box, through which additional information regarding FDT can be accessed: • FDT version. • Copyright information.
74
Chapter 8 Windows This chapter describes each child window type, the features each supports and the options available through their associated pop-up menus. There are three main windows - Workspace window, Editor window and Output window. Most windows have local pop-up menus in order to make commonly used features easier to access. These menus are invoked by clicking the right mouse button within the window (or pressing SHIFT+F10) and then selecting the required menu option.
8.1.1.2. Allow Docking Invoking this option allows the user to select if the window is docked, or if it can “float” around the main window. 8.1.1.3. Hide Invoking Hide conceals the Workspace window. It is restored by [View->Workspace]. 8.1.1.4. Properties This option displays information about the Workspace including the file path.
8.1.2 Project The Project is the next item in the hierarchy below the Workspace. In the following example, the Workspace is called “Industrial Controller” and there are two projects: the first is also called “Industrial Controller” and the second is called “User Mode Reprogramming”. Figure 8-3 Workspace Project In addition to the Allow Docking and Hidemenu items inherited from the workspace, the pop-up menu for Projects has the following items: 8.1.2.1. Add Files...
8.1.2.7. Set as current Project Sets the highlighted project as the current active project. This option is not available if the highlighted project is already the active project. 8.1.2.8. Remove Project Remove the highlighted project from the Workspace. This option is not available if the highlighted project is the active project. 8.1.2.9. Unload Project Unloads the highlighted project from the Workspace. This option is not available if the highlighted project is the active project.
8.2 Device File The Device File is the item containing the data to Flash into the device. Figure 8-5 Device File The pop-up menu for Device File has the following items: 8.2.1 Open ‘filename’ This feature opens the selected file. 8.2.2 Add Files... Allows additional files to be added to the project. 8.2.3 Remove Files... Removes files from the project. 8.2.4 Allow Docking Allows the Workspace window to dock or be floating. 8.2.5 Hide Hides the Workspace window.
8.2.6 Properties... Launches the device file properties dialog box. 8.2.7 Display Block usage... Launches the ‘S-Record Properties’ dialog box and displays the Block usage tab. 8.2.8 Exclude ‘filename’ If a file is excluded, it will not be used to form the built image if Rebuild Image is selected. Once selected as excluded, using the right mouse click, it is possible to “Include ‘filename’”. 8.2.
8.2.13 Compare File->Device (Complete Device) This mode would compare the data in the device flash (starting at the device start address) to the corresponding data in the file. The process would only stop once the entire device had been checked, or differences were found. Areas that are not covered by the file would be assumed to be 0xFF and would therefore require a corresponding blank area on the device to be verified correctly. 8.2.
8.4 Project Properties Invoked from the Project pop-up menu item Properties....
8.5 Configure Flash Project (Flash Properties) The ‘Configure Flash Project’ dialog box can be invoked from the ‘Configure Flash Project’ toolbar button or Device Menu item. It defaults to being docked at the bottom of the FDT window but can be dragged to dock in other locations or to float. To prevent unintentional docking, hold the Ctrl key whilst dragging. 8.5.1 KernelTab This shows the kernel path, frequency, protocol, clock multipliers, and clock mode.
CKP This shows the multiplier of the peripheral clock for the input clock. Clock Mode This shows the clock mode. 8.5.2 Communications Tab This shows the default and current baud rates and the current port. It also allows the user to change the Port and Baud Rate when disconnected. Figure 8-9 Communications Properties Port This drop-down list provides the user with a list of supported COM ports available for connection to the device. This list includes the USB port options.
If this is checked, the default Baud Rate will be used. (This option should be set only when the RenesasEvaluation Board or Evaluation Development Kit is used.) FDM\E8Direct Pins This section displays the direction and state of the controlled mode pins for the Connect and Disconnect with Reset operations. 8.5.3 Device Tab This shows the device information. It also allows the user to select BOOT Mode or USER Program Mode and the ‘Direct Connection’interface.
Interface If the target is connected directly to the host computer, the connection interface should be selected to ‘Direct Connection’. Alternative options include FDM and for Protocol A (legacy) kernels, the UPB. Double clicking invokes the Project Wizard to allow editing of this item. Kernel Resident This specifies that a main kernel is already resident and running on the target device before connection by FDT. Double clicking invokes the Project Wizard to allow editing of this item.
Device Protection This allows the user to select either automatic protection (Automatic) or interactive protection (Interactive) to protect the FLASH device from accidental over-erasure and over-programming. Automatic protection will erase blocks from the device prior to programming, as necessary. Interactive protection will ask the user before an erase occurs.In addition, None can be selected to disable device protection. Double click to edit the setting.
project to work with many Generic Boot devices. If this option is set to "Query", FDT will ask you to select whether to reinterrogate the device. Double click to edit the setting. Security Protection This option controls whether FDT should security protect QzROM devices as it disconnects. It echoes the setting on the QzROM toolbar (see 2.1.2). Select “Automatic” to always protect the device at disconnection.
8.6 S-Record Properties Window This dialog is invoked by clicking the Properties toolbar button or from the Right-Click, Properties Menu when the file is open and selected in the Hex Editor window. 8.6.1 Block Usage Tab This tab shows the starting, finishing address and sizes of the data blocks contained in the active file tab. If the file is open in the editor window, double clicking on a range highlights the selected data. Figure 8-13 8.6.
8.6.3 Selection Value This tab shows various representations of the data that is currently selected. The display depends upon whether the selection is a Byte, Word or DWord. Figure 8-15 8.7 S Record Properties – Selection Value Output Window The Output window is one of the main windows contained in the FDT GUI. Figure 8-16 Output Window The window has available pop-up menu that contains the following items: 8.7.1 Copy Copies any selected text to the clipboard 8.7.
8.7.4 Allow Docking With this option checked the Output window is capable of being docked within the FDT application window. With the option unchecked the Output window is a floating window. 8.7.5 Hide Invoking Hide conceals the output window. It is restored by [View->Output]. Note – the output window will not log messages indefinitely. The current default is 500 lines of text, after which older messages will be purged. 8.
multiple tabs simultaneously. Normal S-record and binary files (and uploads via address) will only have data for one flash area at a time, which will leave the other tabs empty (although they can still be edited manually). To close an open file, click the cross in the top right corner of that file. If the file is unsaved, FDT will prompt to ask if you want to save the open file unless the shift key is held down whilst the cross is clicked.
8.8.6 Display Unit Invokes the cascaded menu as follows: Byte - view the data as 8-bit bytes. Word - view the data as 16-bit words. DWord - view the data as 32-bit double words. 8.8.7 Align to 8 Bytes Data is displayed on each line as 8 bytes. The number of bytes that can be accommodated on each line is dependent upon the size of the window. 8.8.8 Toggle ASCII Column Allows the ASCII column to be removed or displayed. 8.8.9 Create Selection...
8.8.15 Data EntryNote When entering data in the ‘Find’, ‘Replace’ or ‘Fill’ dialog boxes only hexadecimal or ASCII values can be used, based on the ASCII Search check box. When entering hexadecimal values a preceding ‘0x’ is fixed in the entry text box, so hexadecimal values are appended. 8.8.16 Goto Address Double clicking on the address column displays the Goto Address dialog. This allows entry of a hex address to set the hex editor cursor position to.
Selecting the Commands tab allows the user to select and add buttons to the new toolbar. The user can place the new toolbar anywhere on the GUI by dragging it with the mouse. 8.9.3 Reset The Reset button resets the toolbar to the default. 8.9.4 Toolbar name Reflects the toolbar selected in the list. 8.9.5 OK Clicking on OK, in the ‘Toolbar Name’ dialog box adds the new name to the Toolbars list on the Toolbars window and invokes a blank toolbar on the GUI.
8.10 Customise – Menu Invoked by [Tools->Customise...] and then select the Menu tab in the ‘Customise’ dialog box. Figure 8-19 Customise Menu Dialog  To add a new menu option: 1. Select [Tools->Customise...]. The dialog shown above will be displayed. Select the “Menu” tab. The first thing for you to decide is whether you are adding a global application wide tool (“Application wide tools:”), which will be available to all of your workspaces.
Figure 8-20 Add Tool Dialog New menu options are added to the bottom of the list (i.e. bottom of the tools menu) by default. The order of menu options in the [Tools] menu can also be modified. Â To modify a menu option: 1. Select [Tools->Customise...]. The dialog shown below will be displayed. Select the “Menu” tab. 2. Select the menu option that you would like to modify and then click the “Modify...” button. 3. Make the desired changes on the “Modify Tool” dialog and then click “OK”.
98
Chapter 9 Simple Interface Mode Invoked by [Tools->Simple Interface...]. This is used to simplify the look and feel of FDT once a project is configured. See Chapter 5 Access Rights for details about using this in conjunction with user names and passwords. This chapter describes the full Simple Interface Mode; see Chapter 10 for details of Basic Simple Interface Mode.
9.1 Options Menu 9.1.1 Login... This allows changing of which user is logged in to FDT. The hotkey Ctrl+Shift+U also invokes the Login dialog. 9.1.2 Batch Erase Mode... This will change the dialog to be erase based, rather than programming based. The ‘Program Flash’ button will change to ‘Erase’, the file\image selection buttons will be disabled and the programming options will also be disabled. Clicking ‘Erase’ will erase the whole device (it is not possible to specify the area to erase). 9.1.
9.2 Dialog Controls 9.2.1 Back to Project This returns to the full FDT view. This will be disabled if the user currently logged in to FDT does not have the ‘FDT:Project Edit’ access. [see Chapter 5 for details] 9.2.2 Exit Clicking this will exit FDT and FDT will start up in the Simple Interface Mode next time it is loaded. This will be disabled if the user currently logged in to FDT does not have the ‘SimpleInterface:Exit’ access. [see Chapter 5 for details] 9.2.
102
Chapter 10 Basic Simple Interface Mode Invoked from the start menu “Flash Development Toolkit3.07 Basic”. This is used to simplify the look and feel of FDT and does not need a Workspace and Project. See Chapter 5 Access Rights for details about using this in conjunction with user names and passwords. This chapter describes the Basic Simple Interface Mode; see Chapter 9 for details of the full Simple Interface Mode. Basic Simple Interface Mode will restore any previous settings on start up.
10.1 Options Menu 10.1.1 Login... This allows changing of which user is logged in to FDT. The hotkey Ctrl+Shift+U also invokes the Login dialog. 10.1.2 Batch Erase Mode... This will change the dialog to be erase based, rather than programming based. The ‘Program Flash’ button will change to ‘Erase’, the file\image selection buttons will be disabled and the programming options will also be disabled. Clicking ‘Erase’ will erase the whole device (it is not possible to specify the area to erase). 10.1.
10.2 Dialog Controls 10.2.1 Exit Clicking this will exit FDT and FDT will start up in the Simple Interface Mode next time it is loaded. This will be disabled if the user currently logged in to FDT does not have the ‘SimpleInterface:Exit’ access. [see Chapter 5 for details] 10.2.2 Download File radio button This will be disabled if the user currently logged in to FDT does not have the ‘SimpleInterface:Download File’ access. [see Chapter 5 for details] 10.2.
106
Chapter 11 Field Programming This is a feature designed to assist FDT users to send their FDT projects to other FDT users. Once a project is configured correctly and the project images are built, FDT can package all required files (Kernel and data files) into a single .fpf file. This can be sent to another FDT user (using the same version of FDT), who can simply double click on the .fpf file to start FDT and unpack the project files.
11.1 Options Menu 11.1.1 Login... This allows changing of which user is logged in to FDT. The hotkey Ctrl+Shift+U also invokes the Login dialog. 11.1.2 Batch Erase Mode... This will change the dialog to be erase based, rather than programming based. The ‘Program Flash’ button will change to ‘Erase’, the file\image selection buttons will be disabled and the programming options will also be disabled. Clicking ‘Erase’ will erase the whole device (it is not possible to specify the area to erase). 11.1.
11.2 Dialog Controls 11.2.1 Back to Project This returns to the full FDT Workspace view. This will be disabled if the user currently logged in to FDT does not have the ‘FDT:Project Edit’ access. [see Chapter 5 for details] 11.2.2 Exit Clicking this will exit FDT and FDT will start up in the Simple Interface Mode next time it is loaded. This will be disabled if the user currently logged in to FDT does not have the ‘SimpleInterface:Exit’ access. [see Chapter 5 for details] 11.2.
110
Chapter 12 E8 Update When connecting to an E8 interface adaptor board, FDT will check that the E8 firmware (adaptor software) is the correct version and correct type for supporting the connection to the selected device. If there is a mismatch then FDT will offer to update the E8 firmware in order that the connection can be continued. Also if the E8 Adaptor checksum is incorrect, an update will be required.
Level 1 only update: E8 target power has been set to ON at 5.0V Connecting to device 'R5F21174' on 'E8' Configuration: 'BOOT Mode' connection - using emulated interface Opening port 'E8' ... Checking for E8 update... Adaptor checksum OK Processing Data file :'c:\FDT\ADPFiles\E8-Rel-Img.mot' Adaptor version number OK (current E8 Bootstub (Level 0) version = 2.00.00.000, FDT holds version 2.00.00.000, FDT requires version 2.00.XX.
Chapter 13 E8Direct The E8 is an existing USB interface board, which has been used to implement the communications protocol for programming R8C, and M16C devices. Originally this did not support a low level interface allowing its use without the E8 having knowledge of the device protocol. From FDT 3.05 onwards a new E8 firmware is supported that offers “E8Direct” - a low level interface using the existing E8 hardware, designed to be as similar as possible to the FDM.
Preparing for re-enumeration of E8 to E8Direct... Sending re-enumeration command... Request sent successfully, closing E8 Comms... At this point the E8 will re-identify itself to Windows as an E8Direct device. NOTE – it will remain as an E8Direct device until next unplugged or the machine is powered down.
13.2 Hardware Differences The FDM had no capability of supplying the target power whereas the E8Direct can supply 3.3V or 5V and the FDM-E8Direct pin usage is different. This means that it is not possible to simply swap an FDM for an E8. The general purpose I/O pins on the FDM were labelled as MD0 to MD4 and FWE, and they had a direct mapping with the mode pins with matching names on the target devices.
The FDM used a H8S/2148AF with an 18.432MHz crystal, but the E8 uses an H8S/2215UF with a 16MHz crystal. The numbering system above applies to the 14-pin FDM and E8. This numbering system does not apply to the 20-pin FDM connector.
Chapter 14 QzROM Programming QzROM is a new type of programmable flash memory, found in some 4 and 8 bit MCUs. It is based most closely around the Protocol D style device but has several important differences: • One time programming - each byte of QzROM can only be written once. • QzROM cannot be erased - there is no erase command. • Security Protection - QzROM has security protection. After protection, attempts to start the target MCU for connection can result in an error status, i.e.
14.2 Security Protection QzROM also introduces the concept of Security Protection into FDT, which is optionally set as FDT disconnects (Note – once set, this cannot be undone). The majority of devices have two levels of protection, Full (which prevents any later reconnection to the device) or None (which allows reconnection normally). Newer devices have more levels - allowing a partial protection of the device and yet still allowing a later connection (but with the protected data region masked).
14.2.1 Toolbar In full FDT mode and with a QzROM based project the QzROM toolbar will be enabled. This shows the currently chosen option, which can be changed by simply clicking on an adjoining icon. Figure 14-4 Figure 14-5 Figure 14-6 Automatic Prompt None Note – clicking on the icons will not immediately protect the device. This is still merely the current disconnect setting. 14.2.
Figure 14-8 14.2.3 Security Protect dialog change Simple Interface \ Basic Mode Should the user be in a mode where only the Simple Interface dialog is accessible, this setting can instead be changed via a menu option. Figure 14-9 Security Protect Simple Interface The check mark shows the currently selected option. Note – these menu options will be disabled if the project is not QzROM based.
Chapter 15 Locking 15.1 Locking Overview Locking of erase blocks against writing or erasing is a feature supported by some of the M16C family devices. FDT offers control over these locking settings at connection, disconnection and during normal operations.
15.2 Connection If FDT is connecting to a device that supports the locking feature it will check the current locked state of each erase block that has a corresponding lock bit (as defined in the project configuration file). Then, depending on the current connection setting (selectable from the Locking Dialog - see section 15.3), FDT will do one of three things: 1. Automatically Disable Locks FDT will automatically disable the locking of device on connection.
15.3 Locking Dialog The Locking Dialog, accessible from either the toolbar or the 'Device->Block Locking...' menu, controls how FDT behaves with those devices that support protected erase blocks. The dialog, with example device is shown below: Figure 15-4 1. Block Lock Configuration Dialog On Connect The left hand side of the dialog controls how FDT behaves as it connects to a device with locking ability. See more on this in the Connection section. 2.
Lock State at Connection The 'Lock State at Connection' column shows the lock state of each erase block as FDT made the initial connection. There are two symbols to show this state: - the erase block was found to be locked at the initial connection - the erase block was found to be unlocked at the initial connection The erase block may have no symbol at all and be greyed. This is a sign that the block does not have locking support. This is automatically detected by FDT from the project configuration file.
15.4 Disconnection Depending on the current disconnection setting (selectable from the Locking Dialog - see section 15.3), FDT will do one of three things when a user chooses 'Disconnect' from the toolbar or menu: 1. Automatically Set As part of the disconnection process FDT will automatically lock and unlock those blocks specified in the locking dialog. NB - should locked blocks need unlocking FDT will prompt to confirm the action as it would require those blocks to be erased.
Selecting to set the locks will cause FDT to lock and unlock the blocks as appropriate and also set the master lock enable - as in (1) above. Selecting to do nothing will cause FDT to ignore any locking settings and skip straight to the disconnection process - as in (3) below. Clicking 'Cancel' at this point will cancel both the dialog and the disconnect operation as a whole. 3. Do Nothing FDT will issue no lock or unlock commands and the device will be left in its current locking state.
Chapter 16 Upgrading to FDT3.07 Installing FDT3.07 should not adversely affect your other FDT version installations. The USB drivers may be upgraded by installing FDT3.07, and the Access Rights usernames and passwords will be common, but these are the only shared components. Each version of FDT installs its own set of kernels and keeps its own settings. Installing FDT3.07will also update the support email addresses for some previous versions of FDT.
128
Renesas FLASH Microcomputer Programming System User's Manual Renesas FLASH Development Toolkit 3.07 (for Windows® 98SE/Me, Windows NT® 4.0, Windows® 2000 and Windows® XP) Publication Date: Rev.8.00, October 31, 2006 Published by: Sales Strategic Planning Div. Renesas Technology Corp. Edited by: Customer Support Department Global Strategic Communication Div. Renesas Solutions Corp. © 2006. Renesas Technology Corp., All rights reserved. Printed in Japan.
Sales Strategic Planning Div. Nippon Bldg., 2-6-2, Ohte-machi, Chiyoda-ku, Tokyo 100-0004, Japan RENESAS SALES OFFICES http://www.renesas.com Refer to "http://www.renesas.com/en/network" for the latest and detailed information. Renesas Technology America, Inc. 450 Holger Way, San Jose, CA 95134-1368, U.S.A Tel: <1> (408) 382-7500, Fax: <1> (408) 382-7501 Renesas Technology Europe Limited Dukes Meadow, Millboard Road, Bourne End, Buckinghamshire, SL8 5FH, U.K.
Renesas FLASH Development Toolkit 3.07 (for Windows® 98SE/Me, Windows NT® 4.
