To our customers, Old Company Name in Catalogs and Other Documents On April 1st, 2010, NEC Electronics Corporation merged with Renesas Technology Corporation, and Renesas Electronics Corporation took over all the business of both companies. Therefore, although the old company name remains in this document, it is a valid Renesas Electronics document. We appreciate your understanding. Renesas Electronics website: http://www.renesas.
Notice 1. 2. 3. 4. 5. 6. 7. All information included in this document is current as of the date this document is issued. Such information, however, is subject to change without any prior notice. Before purchasing or using any Renesas Electronics products listed herein, please confirm the latest product information with a Renesas Electronics sales office.
User’s Manual Renesas FLASH Development Toolkit 3.0 (for Windows® 98/Me, Windows NT® 4.0, Windows® 2000 and Windows® XP) User’s Manual Renesas FLASH Microcomputer Programming System HS6400FDIW3S Rev.1.0 2003.
Cautions Keep safety first in your circuit designs! 1. Renesas Technology Corporation puts the maximum effort into making semiconductor products better and more reliable, but there is always the possibility that trouble may occur with them. Trouble with semiconductors may lead to personal injury, fire or property damage.
Contents Contents ......................................................................................................... i Preface ......................................................................................................... iii Abbreviations ...................................................................................................... iv Document Conventions ....................................................................................... v Chapter 1 1.1 1.2 Chapter 2 2.
.7 6.8 6.9 6.10 6.11 6.12 6.13 6.14 6.15 6.16 6.17 6.18 6.19 6.20 Project Properties.............................................................................................................45 Flash Properties ...............................................................................................................46 S-Record Properties .........................................................................................................51 Output Window .........................................
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, Basic Operation, describes how FDT is activated and the FLASH ROM is written.
Abbreviations Device Refers to programmable microcontroller or microcomputers DLL Dynamic Linked Library FDT Flash Development Toolkit F-ZTAT FLASH ZTAT HEW Renesas High-performance Embedded Workshop PC Personal Computer ZTAT Zero Turn-Around Technology iv
Document Conventions This manual uses the following typographic conventions: Table 1: Typographic Conventions CONVENTION MEANING [Menu->Menu Option] Bold text with ‘->’ is used to indicate menu options (for example, [File->Save As…]). ‘dialog name’ The ‘’ is used to indicate the name of a dialog box or menu. FILENAME.C Uppercase names are used to indicate filenames. “enter this string” Used to indicate text that must be entered (excluding the “” quotes).
Chapter 1 Introduction The Renesas FLASH 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 Binary editor. 1.
Chapter 2 System Overview FDT is a modular software system, utilising self-contained modules for specific tasks. These modules are linked to a general purpose Graphical User Interface, which provides a common look & feel independent of the particular modules with which the system is configured. FDT employs a hierarchical structure so that work can be organised in a logical manner. The top level of the structure is the workspace. To be useful, the workspace must contain at least one project.
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.
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. Clicking the left mouse button on a menu title will pull down that menu, from which a selection can be made. If a menu item does not perform an action directly, but instead displays a dialog box or window for further user interaction, then its name is appended with an ellipsis (three dots, …).
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.
Edit toolbar New File Open File Save File Save All Print Cut Copy Paste Match Braces Insert Template Toggle Bookmark Open an S-Record Figure 2-6 Edit Toolbar New File - launches a new file. Open File - launches the ‘Open’ dialog box. Save File – saves the active file. Save All – saves all the open files. Print – prints active file. Cut – cuts data to the clipboard. Copy – copies data to the clipboard. Paste – pastes data from the clipboard. Match Braces – finds the matching brace.
FDT toolbar Connect Disconnect Erase Blocks Blank Check Upload Download Active File Checksum Go from Address Cancel Configure Flash Project 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.
S Record toolbar View as Bytes View as Words View as DWords Align view to 8 bytes Toggle ASCII Find Find and Replace Create Selection Fill Selection Properties 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.
Search toolbar Find in Files Data Find Find Next Find Previous Figure 2-9 Search Toolbar Find in Files – finds selected data in selected files. Data – is used for the searches. Find – locates data in active file. Find Next – locates next occurrence of search criteria. Find Previous - locates previous occurrence of search criteria. Status Bar The Status Bar is located at the bottom of the FDT application window. It provides the user with information about what the application is doing.
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-10 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 6, Windows.
2.3 Hot Keys There are various hot keys for frequently used operations.
Chapter 3 Basic Operation 3.1 Starting FDT To start FDT, open the ‘Start’ menu of Windows and select ‘Renesas’ from ‘Program’, ‘FLASH Development Toolkit 3.0’, and the FDT shortcut. The ‘Welcome!’ dialog box will open by default. To create a new workspace, select ‘Create a new project workspace’ and click the ‘OK’ button. To open a recent workspace, select ‘Open a recent project workspace’ and click the ‘OK’ button.
3.2 Creating a New Workspace (1) Enter the workspace name(Project name is same as a default), then click the ‘OK’ button. (If you wish to change or create a directory, input a directory name or use ‘Browse...
(2) Select the device you wish to use from the drop-down list. If there exists a user-created kernel in addition to the default path, select ‘Other…’ to specify the kernel file (.fcf). 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).
Figure 3-4 Communications Port If the 0.18um Generic Wizard is being used, then to communicate with the device, if the FDM is also used, the following screen will be shown. Figure 3-5 FDM Generic 0.18um Setup Note Setting the FDM pins requires caution. Please confirm the pin settings with the hardware manual even if a default setting is available.
If the FDM is selected, then the user may be able to select the FDM pin settings as determined by the subsequent dialogs. Figure 3-6 FDM Pin Settings The previous dialog shows the settings for a number of FDM pins. This is for BOOT mode. If there are a number of settings available the ‘Operating Mode’ list box can determine which setting to use. Note 16 Setting the FDM pins requires caution. Please confirm the pin settings with the hardware manual even if a default setting is available.
The following dialog shows a similar dialog, this time to set the pins after a reset signal has been sent to the device.
(4) Enter the numerical values for the input clock, select the main or peripheral multiplier from the dropdown list, and click the ‘Next’ button. Figure 3-8 Device Settings Supplementary: 1. CPU Crystal Frequency Enter the frequency of the CPU clock or the crystal generator as integers or in a format such as xx.xx. You can only input two digits to the right of the decimal point. 2. Clock Mode A clock mode needs to be selected depending on the target device. Select a value from the drop-down list. 3.
(5) Select the operating mode and baud rate from the drop-down lists, then click the ‘Next’ button. Note For the serial port baud rate, refer to the hardware manual and select a rate where the variance is within 3% for the clock frequency used. Figure 3-9 Connection Type Supplementary: 1. Use Default Baud Rate When this check mark is removed, other than the default value can be selected from the drop-down list.
(6) Select the protection level for programming the FLASH ROM and the messaging level, then click the ‘Finish’ button.
(7) If a Generic 0.18um device is selected, then a series of screens appear. Once selected, there is little information available, since FDT will establish the correct information. Figure 3-11 Generic Boot Device Selection Pressing the ‘Next’ button will result in confirmation being required that the process should be continued. Figure 3-12 Generic Boot Confirmation After this, FDT displays a dialog that displays the progress, and pauses on the device.
A similar process occurs with Clock Modes.
Having selected the Clock Mode, the Generic wizard completes as below. Figure 3-14 Clock Mode Figure 3-15 Generic 0.
3.3 Saving a Workspace When the [File->Save Workspace] menu option is selected, the FDT workspace can be saved. 3.4 Closing a Workspace Select [File->Close Workspace] to close the FDT workspace. If the workspace or its project has changed, a dialog box asks if the user wishes to save the project. Select ‘Yes’ if the workspace is to be saved, ‘No’ if the workspace is not to be saved, and ‘Cancel’ to return to the workspace. 3.
3.7 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 to be erased. (When Name of the block is clicked, the block name is inversely displayed.)* Click the ‘Erase’ button to start erasure. When ‘Erase complete’ is displayed in the message window, erasure is completed. Figure 3-16 Erase Blocks Note To erase all blocks, clicking the ‘Select All’ button inversely displays all blocks.
3.8 1. 2. 3. 4. Reading the FLASH ROM Data Display the ‘Upload Image’ dialog box from [Device->Upload Image]. Enter the start and end addresses. Click the ‘Upload’ button to start reading. When ‘Successfully read xxx bytes from device’ is displayed in the message window, reading is complete. If the user specifies an Absolute image, the uploaded data will be placed in an image the size of the FLASH memory at the same address it was uploaded from.
Chapter 4 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 customization.
4.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. To disable the display of the Toolbar, select each of the displayed toolbars, and disable their view. To display the toolbar, use the [Tools->Customize…] menu option. 4.4 Enabling/disabling the Workspace The user has the option to enable or disable the Workspace. By default, the Workspace is displayed.
4.6 Customizing the Toolbar The selection and arrangement of buttons displayed on the Toolbar can be customized to suit a user’s requirements. To change the display invokes the [Tools->Customize…] menu option. The ‘Customize’ dialog box will be displayed: Figure 4-1 Customize FDT The ‘Customize’ dialog box has a number of tabs, which are further described in Chapter 6 Windows. Toolbars The ‘Toolbars’ tab allows the user to select a group (e.g. workspace) and to select the functions for that group.
Commands This tab shows the buttons and describes the action for each button in each group and allows the user to customize the toolbar according to an individual application. Clicking on an item in the ‘Categories’ box displays the buttons available for that category. The ‘Buttons’ area displays a picture for each button in the selected category. To obtain a description of the action of a button, click on that button. The description will appear in the ‘Description’ area.
Chapter 5 Menus This document follows the standard Microsoft menu naming convention: Menu Bar Menu Title Hot Key Drop-down Menu Ellipsis Cascading Menu Menu Option Figure 5-1 FDT Menus 5.1 File The ‘File’ menu is used for aspects of the program that access data files. New This creates a new text file in the editor window. Open… This opens a file for display in the editor window. It assumes a text file. Close This will close the current active file in the editor window.
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 SRecord file (.rec, .mot, .a20, .a37) or a Device Image file (.fpr). Save Session This feature is not used in FDT. Refresh Session This feature is not used in FDT. Save Saves the current active file. Save All Saves all files that have not been saved on the Editor window.
Paste This will copy the contents of the Windows clipboard into the child window at the current cursor position. Note If more than one byte is selected, the Paste option is not available. Clear Deletes selected characters. In an S-Record file, this has no function. Select All Selects all the information in the active file in the editor window. Find… This will launch the ‘Find’ dialog box allowing the user to enter either hexadecimal or ASCII data.
Columns This has no effect with S Records, but with text files allows a gutter on the left hand side. Define Column Format… This feature is not currently used in FDT. 5.3 View The ‘View’ menu is used to display Workspace window and Output winodw. Workspace Display Workspace window. Output Display Output window. 5.4 Project The ‘Project’ menu provides high-level control and facilities for projects within the workspace.
File Extensions… This option allows the user to select which file extensions are recognized by FDT. Components… This option shows any additional components used in FDT (currently not used). Download Image Loads the open Device Image file into the target FLASH memory. Rebuild Image Rebuilds the target files into a Device image file (Binary Image) for subsequent downloading to the target FLASH memory. 5.
5.6 Window 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. Cascade This option allows multiple windows to be staggered so that each file is visible. Tile Horizontally This option allows the windows to be displayed with maximum possible horizontal width.
Blank Check This launches a blank check on the device FLASH and reports back to the Output window. 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. Download Active File This downloads the current active file into the target FLASH memory.
38
Chapter 6 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.
Allow Docking Invoking this option allows the user to select if the window is docked, or if it can “float” around the main window. Hide Invoking Hide conceals the Workspace window. It is restored by [View->Workspace]. Properties This option displays information about the Workspace including the file path.
6.3 Project The Project is the next item in the hierarchy below the Workspace. In the following example, both “Display” and “Motor Control” are Project names. Figure 6-3 Workspace Project The pop-up menu for Project has the following items: Add Folder… Allows an additional folder to be included. Add Files … Launches the ‘Open’ dialog box allowing the user to add S-Record files to the project. Remove Files… Launches a dialog to select the files to remove.
Hide Hides the Workspace window. Properties Displays the project properties. Add Files From Kernel Dir… This allows the user to select files from the current kernel directory and add those files to the current project. 6.4 Device Image - Folder This contains the Device Image file the project. Figure 6-4 Workspace Folder The Device Image - Sub Folder pop-up menu has the following items: Remove Folder Allows the user to delete folders. Rename Folder Allows the folder to be renamed.
6.5 Device File The Device File is the item containing the data to Flash into the device. Figure 6-5 Device File The pop-up menu for Device File has the following items: Open ‘filename’ This feature is not used in FDT. Add Files… Allows additional files to be added to the project. Remove Files… Removes files from the project. Allow Docking Allows the Workspace window to dock or be floating. Hide Hides the Workspace window. Properties Launches the device file properties dialog box.
Display Block usage… Launches the ‘S-Record Properties’ dialog box and displays the Block usage tab. 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’”. Download File Downloads the active file to the device FLASH memory.
Figure 6-6 Workspace Properties 6.7 Project Properties The ‘Properties’ dialog box can be invoked from the Properties right click action when the mouse is over the project in the workspace window.
6.8 Flash Properties The ‘Flash Properties’ dialog box can be invoked from Configure Flash Project in the FDT toolbar. For the items that can be changed, double-click on them to change those contents. # Kernel This shows the kernel path, frequency, protocol, multiplier, and clock mode. It also allows the user to change those contents. Figure 6-8 Kernel Properties Kernel Path This shows the kernel path. Frequency This shows the input clock. Protocol This shows the type of communication protocols (B: 0.
# Communications This shows the default and current baud rates and the current port. It also allows the user to change the Port and Baud Rate. Figure 6-9 Communications Properties Port This shows COM ports or USB port for connection to the device. Baud Rate This shows the Target Baud Rate for connection. Default Baud Rate This shows the default Baud Rate. Use Default Baud This shows whether default baud is used or not.
# Device This shows the device information. It also allows the user to select ‘BOOT Mode’ or ‘USER Program Mode’ and the ‘Direct Connection’ interface. In addition, it can specify whether or not the kernel is in the target device. Figure 6-10 Device Properties Device, RAM Size, and FLASH Size These show the information on the device. Connection Boot mode connection type specifies that the on-board programming BOOT mode sequence is to be initiated if a kernel cannot be found running on the target device.
Buffer Size This shows a size of programming the flash memory. Device ID This is not used in communication protocol B or C.
# Programmer This shows the state of the Function Map and allows the user to select the Device Protection Option of Automatic, Interactive, or None and the message level option of Advanced or Standard. Figure 6-11 Programmer Properties 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.
Reinterrogate on Disconnect This option forces FDT to reinterrogate Generic 0.18um devices on connection. With this option set to "No" (default), the device settings are saved in an automatically generated fcf file and re-used. With this option set to "Yes", FDT will always reinterrogate the device for its details upon connection; this allows one project to work with many 0.18um devices. If this option is set to "Query", FDT will ask you to select whether to reinterrogate the device.
6.10 Output Window The Output window is one of the main windows contained in the FDT GUI. Figure 6-14 Output Window The window has available pop-up menu that contains the following items: Clear Window This will clear the Output window. 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. Hide Invoking Hide conceals the Message log. It is restored by [View->Output].
6.11 Editor Window The Editor window is one of the main windows contained in the FDT GUI. Figure 6-15 Editor Window The window has available pop-up menu that contains the following items: Cut This will remove the contents of the highlighted block from the window and place it on the clipboard in the standard Windows manner. This is only available if a block is highlighted. Copy This will copy the contents of the highlighted block to the clipboard in the standard Windows manner.
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. 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. Toggle ASCII Column Allows the ASCII column to be removed or displayed.
6.12 Erase Blocks ‘Erase Blocks’ dialog box is invoked by [Device->Erase FLASH blocks] or the Toolbar Erase Blocks. The ‘Erase Blocks’ dialog box allows the user to specify which blocks to erase. The Written column indicates whether data exists in the block. Figure 6-16 Erase Blocks Select All Clicking on ‘Select All’ will select all the blocks of the device FLASH memory. Select Written Clicking on ‘Select Written’ will select only those blocks that are not empty.
6.13 Customize - Toolbars Invoked by [Tools->Customize…] and then select the Toolbars tab in the ‘Customize’ dialog box. Figure 6-17 Customize Toolbars Dialog Show Tooltips A check mark in the ‘Show Tooltips’ box indicates that the action of the button will be displayed when the mouse arrow is pointing to the button. If the box is unchecked, no action is displayed. New… The ‘New…’ button launches the ‘Toolbar Name’ dialog box which allows the user to name and generate a new toolbar.
Clicking on ‘OK’ in the ‘Customize’ dialog box saves any changes made and closes the dialog box. Delete If a new toolbar has been added to the ‘Toolbars’ list and it is selected, the ‘Reset’ button is renamed to ‘Delete’. Clicking on this button will remove the new toolbar from the list and from the GUI. 6.14 Customize - Commands Invoked by [Tools->Customize…] and then select the ‘Commands’ tab in the ‘Customize’ dialog box.
Figure 6-19 Customize Menu Dialog ! To add a new menu option: 1. Select [Tools->Customize…]. 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. Or whether you wish to add a workspace wide tool (‘Workspace wide tool’), which is only valid for the current workspace.
Figure 6-20 Add Tool Dialog New menu options are added to the bottom of the list (i.e. bottom of the tools menu) by default. ! To modify a menu option: 1. Select [Tools->Customize…]. 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’.
Figure 6-21 Modify Tool Dialog ! To remove a menu option: 1. Select [Tools->Customize…]. The dialog shown in Figure 6-19 will be displayed. Select the ‘Menu’ tab. 2. Select the menu option that you would like to remove and then click the ‘Remove’ button.
6.16 Customize – Placeholders Invoked by [Tools->Customize…] and then select the ‘Placeholders’ tab in the ‘Customize’ dialog box. Figure 6-22 Customize Placeholders Dialog This allows the user to choose placeholders for directories.
6.17 Customize – Debugger Invoked by [Tools->Customize…] and then select the ‘Debugger’ tab in the ‘Customize’ dialog box. Figure 6-23 Customize Debugger Dialog This option is not currently used in FDT.
6.18 Customize – Log Invoked by [Tools->Customize…] and then select the ‘Log’ tab in the ‘Customize’ dialog box. Figure 6-24 Customize Log Dialog Currently this tab is not used in FDT.
6.19 Customize – Help Invoked by [Tools->Customize…] and then select the ‘Help’ tab in the ‘Customize’ dialog box. Figure 6-25 Customize Help Dialog This allows the user to add additional help files.
6.20 Simple Interface Invoked by [Tools->Simple Interface…]. Clicking on ‘Back’ displays the previous screen. Figure 6-26 FDT Simple Interface Program Flash Clicking on ‘Program Flash’ allows FDT to download the specified file to the FLASH memory.
Chapter 7 Upgrading to FDT 3.0 If the project being used needs to be upgraded to FDT 3.0, it is recommended that a new workspace and project is created using the wizard. This will ensure that the new settings are generated as required by FDT. The workspace files used by FDT 2.2 are not compatible with FDT 3.0 due to the enhancements included in FDT 3.0. If the project specifically requires the kernels distributed from the earlier version of FDT 2.
Renesas FLASH Development Toolkit 3.0 (for Windowsâ 98/Me, Windows NT â 4.0, Windowsâ 2000 and Windowsâ XP) User's Manual Publication Date: Rev.1.00, June 16, 2003 Published by: Sales Strategic Planning Div. Renesas Technology Corp. Edited by: Technical Documentation & Information Department Renesas Kodaira Semiconductor Co., Ltd. 2003 Renesas Technology Corp. All rights reserved. Printed in Japan.
Renesas FLASH Development Toolkit 3.0 (for Windows® 98/Me, Windows NT® 4.