X-Writer. User Guide for TK Series. Revision 1.8 Dec. 2015

Size: px

Start display at page:

Download "X-Writer. User Guide for TK Series. Revision 1.8 Dec. 2015"

Patience Bradley
5 years ago
Views:

for TK Series Revision 1.8 Dec. 2015 ENE RESERVES THE RIGHT TO AMEND THIS DOCUMENT WITHOUT NOTICE AT ANY TIME.

1 for TK Series Revision 1.8 Dec ENE RESERVES THE RIGHT TO AMEND THIS DOCUMENT WITHOUT NOTICE AT ANY TIME. ENE ASSUMES NO RESPONSIBILITY FOR ANY ERRORS APPEAR IN THE DOCUMENT, AND ENE DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO SALE AND/OR USE OF ENE PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, OR INFRINGEMENT OF ANY PATENTS, COPYRIGHTS OR OTHER INTELLECTUAL PROPERTY RIGHTS. Headquarters 4F-1, No.9, Prosperity Rd., Science-based Industrial Park, Hsinchu City, Taiwan, R.O.C TEL: FAX: Copyright 2014, ENE Technology Inc. All rights reserved.

2 Revision History Version Content Date 0.9 Initial Release 2014/ Formal Release 2014/ Include TK18 products 2. Add Auto-Machine Mode (Ch ) 2014/ Internal review 2014/ Modify the Auto-machine mode connector s pin definition on page / Modify outlook with a case 2. Modify Auto-machine mode connectors 2015/ Updated UI guide of section 4 2. Add How to burn ENE MCU in section / Add How to updated F/W from 4.4 section 2015/ Add display message note 2015/ Add universal socket user guide 2015/12 REV 1.8 ii All rights reserved

3 Index 1. Summary System Requirements Hardware Product Appearance Hardware sections Hardware Sections Descriptions LED Display Status Indicators IC Programming Adaptor Board Installation of Operation PC Connect Mode Isolation Mode ISP Mode Auto-Machine Mode Software Software Contents Software Manual Installation Software Operation How to burn ENE MCU How to updated F/W Malfunctions Display Message Note TK18 Socket Board Selection Guide Contact Details REV 1.8 iii All rights reserved

4 1. Summary is the tool developed specifically for the embedded flash microcontroller product series. The tool supports two modes, PC Connect Mode and Isolation Mode. When on the PC Connect Mode, user is able to write/edit programs and upload to the tool. When on the Isolation Mode, user simply connects the power source to initiate the single step to work on the chip. Please read this instruction for the details on hardware and software. 2. System Requirements hardware is functional with 5V power supply. software is able to update the MCU FW codes on the as well as to write and update programmed FW codes on the tested chip (DUT) directly. Software is to be executed on the PC. The minimum operation system requirement is Windows XP SP3 or higher. Please note, you may be requested to install the MICROSOFT.NET FRAMEWORK via internet connection. REV All rights reserved

3. Hardware 3.1 Product Appearance Picture 3-1 Top view of the 3.

LED Display (please refer to Ch. 3.3.1) 4.

Connectors for IC Programming Adaptor Board 6.

5 3. Hardware 3.1 Product Appearance Picture 3-1 Top view of the 3.2 Hardware sections Picture 3-2 Side view of the 1. Programming Start Bottom 2. Clear Button to reset the IC number on LED Display 3. LED Display (please refer to Ch ) 4. Status Indicators (please refer to Ch ) 5. Connectors for IC Programming Adaptor Board 6. USB port for power adapter or PC/NB connection 7. IC Programming Adaptor Board (please refer to Ch ) 8. Connector for Auto Machine (please refer to Ch ) REV All rights reserved

3.3 Hardware Sections Descriptions 3.3.1 LED Display 1. The LED Display indicates the quantity of IC programmed. Numbers accumulate after each successful programming. 2.

6 3.3 Hardware Sections Descriptions LED Display 1. The LED Display indicates the quantity of IC programmed. Numbers accumulate after each successful programming. 2. After displaying the quantity of IC programmed, a verification code for the successful programming will be shown. 3. If programming was unsuccessful, an error message will be shown (Err) Status Indicators There are 3 Status Indicators on the : 1. PASS Indicator: Programming is completed correctly. 2. FAIL Indicator: Programming is not completed correctly. 3. C.FAIL Indicator: IC is not placed correctly in the tool. Please position the IC again IC Programming Adaptor Board supports multiple ENE product parts. However, each product part requires different Programming Adaptor. Picture 3-3 IC Programming Adaptor Board REV All rights reserved

3.4 Installation of 1. Use Type A to Mini B USB connection cable to connect PC and. To use 5V power adaptors to connect Pro. 2. Install the suitable IC Programming Adaptor Board. 3.

7 3.4 Installation of 1. Use Type A to Mini B USB connection cable to connect PC and. To use 5V power adaptors to connect Pro. 2. Install the suitable IC Programming Adaptor Board. 3. Place the IC to be programmed. Please ensure to position the IC correctly and firmly to avoid damages. 3.5 Operation PC Connect Mode 1. To use USB connection cable to connect PC and. PC is to supply power to the and to execute the software. Please refer to Chapter 4 for software contents and instructions. S/W USB Cable Picture 3-4 Connect to PC 2. Position the IC correctly. 3. Press the Programming Bottom and wait till the Pass Indicator is on. 4. Repeat Step 2 and 3 to continue programming other ICs. REV All rights reserved

3.5.2 Isolation Mode 1. Use Power Adaptor to connect 5V power source. Picture 3-5 Power Adaptor 2. Position the IC correctly. 3. Press the Programming Bottom and wait till the Pass Indicator is on. 4.

8 3.5.2 Isolation Mode 1. Use Power Adaptor to connect 5V power source. Picture 3-5 Power Adaptor 2. Position the IC correctly. 3. Press the Programming Bottom and wait till the Pass Indicator is on. 4. Repeat Step 2 and 3 to continue programming other ICs ISP Mode supports ISP programming mode. Under the ISP programming mode, ENE X-ANA tool is compulsory for the user interface and operating environment. Please refer to ENE X-ANA manual for details Auto-Machine Mode supports Auto-Machine programming mode, the connector is located on the side of (please refer to Picture 3-5). The supported auto-machine mode interface and corresponding signal timing diagram of are described below: Auto-Machine Mode Auto-Machine connector Picture 3-6 Auto-Machine connector REV All rights reserved

This Auto-Machine connector includes 6 pins, they are ST, NG, OK, BY, +5V and GND, the pin descriptions are: The pin definitions of connector Pin Name Signal Direction Description ST START Machine

OK PASS Machine The signal outputs LOW once IC programming success is detected, this signal is valid only during EOP is LOW. BY EOP Machine +5V Power Machine VCC 5V. GND GND Machine GND. 3.5.4.

9 This Auto-Machine connector includes 6 pins, they are ST, NG, OK, BY, +5V and GND, the pin descriptions are: The pin definitions of connector Pin Name Signal Direction Description ST START Machine Flash programming starts, it s ACTIVE LOW. NG BUSY Machine Corresponding to START signal, IC drives BUSY LOW to indicate flash programming process. OK PASS Machine The signal outputs LOW once IC programming success is detected, this signal is valid only during EOP is LOW. BY EOP Machine +5V Power Machine VCC 5V. GND GND Machine GND Auto-Machine universal socket Once the flash programming is finishes, the EOP will active LOW for 100ms, and check PASS, FAIL and CONTACT status during this 100ms period. 16Pin Socket Picture 3-7 Auto-Machin Socket 20 ~ 32Pin Socket The pin definitions of auto-machine interface (J4) Pin Name Signal Direction Description VCC5V VCC5V Machine VCC 5V. Bin0 FAIL Machine FAIL stands for CONTACT FAIL or PROGRAM FAIL, it s valid during EOP is LOW. Bin1 START Machine Flash programming starts, it s ACTIVE LOW. Bin2 EOP Machine Once the flash programming is finishes, the EOP will active LOW for 100ms, and check PASS, FAIL and CONTACT status during this 100ms period. Bin3 The signal outputs LOW once IC contact failure is CONTACT Machine detected, this signal is valid only during EOP is FAIL LOW. REV All rights reserved

10 Pin Name Signal Direction Description Bin4 BUSY Machine Bin5 PROGRAM FAIL Machine Bin6 PASS Machine Bin7 Reserved Reserved Reserved GND GND Machine GND. The interface signals timing diagram: 1. IC ISP signals (J3 on auto-machine adaptor board): VPP (3.3V), GND, ICLK, IDAT ICLK Corresponding to START signal, IC drives BUSY LOW to indicate flash programming process. The signal outputs LOW once IC programming failure is detected, this signal is valid only during EOP is LOW. The signal outputs LOW once IC programming success is detected, this signal is valid only during EOP is LOW. IDAT 2.Auto-machine interface signals (J4 on auto-machine adaptor board): START, BUSY, EOP, PASS, FAIL START 15 ~ 500ms BUSY EOP PASS FAIL CONTACT FAIL PROGRAM FAIL 100ms Picture 3-8 Auto-Machine connect timing REV All rights reserved

4. Software 4.1 Software Contents PC Software enables user to modify programming contents (Programmer Software and the default programs) via PC.

11 4. Software 4.1 Software Contents PC Software enables user to modify programming contents (Programmer Software and the default programs) via PC. It also provides flexibility to program the IC, which is in the programming tool, directly from the PC. The modifications will be saved in the for future use under the Isolation Mode. Software pack includes an installation file (setup.exe) and a driver. Please note that the enclosed driver is for operation without Internet connection. Please download the latest driver when required. 4.2 Software Manual Installation Installation steps for the first time user: 1. To connect and PC by USB cable and this will turn on the power of automatically. Once X-writer is connected to PC, Windows will detect as Picture 4-1. Choose Searching driver from the PC to install as demonstrated in Picture 4-2. Select the driver path provided by ENE as demonstrated in Picture 4-3. Select correct path to start installation as demonstrated in Picture 4-4. As USB IC on the provides two interfaces, I 2 C and SPI, Windows will request installation twice. When installation is completed and without error messages, Windows Device Manager will show two available ports, USB Serial Converter A/B and USB Serial Port (COM5) as demonstrated in Figure 4-5. When USB driver is properly installed, is able to function. Picture 4-1 Software setup window REV All rights reserved

After Driver installation finished, the USB Serial Port & USB Serial Converter A/B

2. Execute the installation program (setup.

15 2. Execute the installation program (setup.exe) in the Software Pack (It need administrator mode): Picture 4-6 Install S/W setup.exe Software (ENE ) will be installed in the PC once the setup program is completed. A shortcut icon will appear on the PC table: REV All rights reserved

If connection fails, please unplug and reconnect.

16 4.2.2 Software Operation Initiate software after connect to PC in accordance to Picture 3-4. A conversation window will pop up if connection is established correctly as demonstrated in Picture 4-8. If connection fails, please unplug and reconnect. If fail to connect after two attempts, please contact ENE Support before further action. Picture 4-7 Connection established correctly Picture 4-8 Connection fail REV All rights reserved

S/W user guide Picture 4-9 S/W As Picture 4-9 demonstrates, main functions of are as follow: 1. Burn functions and the part number and package of destined MCU a.

17 S/W user guide Picture 4-9 S/W As Picture 4-9 demonstrates, main functions of are as follow: 1. Burn functions and the part number and package of destined MCU a. Fast keys for most frequently used functions. b. Select MCU part number and package type. 2. Smart burn function: to combine various burn attempts into one burn configuration. This will reduce selection key-in time. 3. Burn result history: result history logs number of successful or failed burn attempts. 4. File path for burn object: to select the source file path for burn object 5. Burn content: display the content to be burn into MCU 6. Others REV All rights reserved

1. Program Function Descriptions Click on this Icon to designate the Binary Files (programming code) to be downloaded.

Click on the downward arrow in the Icon will see the Binary files that had been read.

Following conversation window will pop up when select this Setting icon: Picture 4-10 Burn setting A.

18 1. Program Function Descriptions Click on this Icon to designate the Binary Files (programming code) to be downloaded. User can assign the index for the document. User need to click the Update Document icon to complete the program update in the. Click on the downward arrow in the Icon will see the Binary files that had been read. Click on this icon to write the selected Binary file into or MCU. Following conversation window will pop up when select this Setting icon: Picture 4-10 Burn setting A. MCU part number selection. This item must be configured before continuing following items. Refer to Picture 4-11 and Picture4-11 MCU Part NO. and Package selection Picture 4-12 Show the MCU part NO. and package type REV All rights reserved

19 B. Rolling number: to be selected according to user requirements. Please note, once this item is selected, verification code for each programming job (checksum) maybe different. User will need to check manually. C. Programming configuration: every programming operation will update setting. If user wants to program the selected programming code into the IC Chip, please select option item program IC directly. Read Protection will prevent others from retrieving the Binary Files from and IC. If Read Protection is not initiated in the beginning of the programming, and user wants to turn on the Read Protection later during the process without aborting the current programming, Read Protection function is applicable. Please refer to the description in the Read Protection section below. D. Please note, once Read Protection is initiated, Files Retrieving function will be affected. Click Confirm after configuration, setting will be updated. If Program IC directly is selected, the updated setting will also be programmed to ENE IC placed in the. Picture 4-13 Write MCU Bin Setting REV All rights reserved

Messages relating to operation will be shown in the Message Section. All messages will be saved in the designated file when this icon is selected.

20 By Selecting this icon, user is able to retrieve the Bin setting from or IC chip. Retrieving information from the IC chip will not affect setting. A dialogue window will pop up: Click OK after selection. Picture 4-14 Read MCU Bin Setting Select this icon will change the display language. Languages available in English and Simplified Chinese. Messages relating to operation will be shown in the Message Section. All messages will be saved in the designated file when this icon is selected. If user neglects to configure this function, messages can still be saved. Please refer to the description on Message Section below. Picture4-15 Log area Messages related to operation will be shown in this area. All messages can be deleted or saved by right clicking mouse as shown in Picture REV All rights reserved

21 Picture 4-16 Log area instruction Click on this icon for assistance (User Manual) Select this icon to retrieve the Binary Files in the and the programmed IC, and compare the retrieved File with the default one to assure the accuracy of the Binary File. Please note, this function is disabled if Read Protection is configured in the or configured during the programming. Select this icon to initiate Read Protection for the programmed IC. User does not require executing the settings under Update Document operation. To program IC repetitively, please select the Binary Files to be downloaded and select the functional setup options under the Update Document setting. Press space bar to program IC. Please Note, this icon is locked if Binary Files selection and function setups are not completed. REV All rights reserved

Selection items provided by Smart Burn function key are identical to those of Burn function key. Please refer to related sections for details.

22 1. Smart Burn provides smart burn function that enable user to pre-select all desired functions before clicking the smart burn function. All selected burn functions will be executed sequentially and report the final burn results. Selection items provided by Smart Burn function key are identical to those of Burn function key. Please refer to related sections for details. Picture 4-17 Smart Burn 2. Result Counter provides complete burn records for each current operation as shown in Picture User is able to reset the counter as shown in Picture Picture 4-18 Burn Counter Picture 4-19 Reset Counter REV All rights reserved

3. Program file path After open the file to be burn to MCU, will also display the file path as shown in Picture 4-20.

23 3. Program file path After open the file to be burn to MCU, will also display the file path as shown in Picture Picture 4-20 Program file path Furthermore, will provide information on selected files to be burn and the checksum of target file in the as shown in Picture Picture 4-21 Checksum and selection 4. Program bin or hex file path When the file is open and loaded to the, user will see information as shown in Picture It is for user to check the file content. However, information is for viewing only. User needs to modify the original file and reload to if file contents need to be updated. Picture 4-22 Program information 5. Other When open software, user will be notified of software version and hardware serial number as shown in Picture Picture 4-23 S/W Version and H/W series NO. When software is open, connection status will be shown in the bottom-left corner of the software as seen in Picture A red X indicating connection fails, please disconnect the hardware and try again. Picture 4-24 Link status REV All rights reserved

24 During the operation, user can check the current status of from the bottom left corner of software as shown in Picture Picture 4-25 Status and result 4.3 How to burn ENE MCU Please follow the steps to burn MCU using : Step1. Connect software and hardware as demonstrated in Picture 4-3. Step2. Click on File icon: select the files to be burn Step3. Click on Configuration: select MCU part number and package type, select Write directly into the chip, then click OK. Step4. Confirm file path, MCU part number and package type. Step5. Click ERASE function key to erase MCU Flash. Step6. Click Blank Check function key to confirm MCU flash is cleared before start the burning procedure. Step7. Click Burn function key to burn pre-stored program from to MCU flash. Step8. Click Verify function key to check if procedure in MCU is identical to file content. Step9. Burn procedure is complete. Remove MCU and turn off software and hardware. REV All rights reserved

25 4.4 How to updated F/W Please follow the steps to updated F/W: Step1. Connect software and hardware as demonstrated in Picture 4-3. Step2. Press Alt+W hot key than showed file as demonstrated in Picture Picture 4-26 Alt+W hot key than showed file Step3. Click on and open F/W file. Picture 4-27 File path REV All rights reserved

27 5. Malfunctions Simple Diagnostics Phenomenon Possible Cause Rectification Unable to install the Software Incompatible PC operation system An existing operating environment installed previously Please refer to the Operation System requirement in Chapter 2 Please remove the old version environment from the Control Panel before updating to the latest version Software is unable to detect Programming fail Another is in operation simultaneously Poor USB connection No power Poor connection of IC and the tool Poor power supply Turn off the other Software Replace a new USB cable, or switch to another USB port Connect external 5V power source Adjust socket/port Change 5V power source REV All rights reserved

28 6. Display Message Note Display message Note PAxxxx CHxxxx erconn er--1d er8006 er00fa er0000 erxxxx eryyyy Pass number Checksum Link error Incorrect socket Read Flash error Writer Flash error Not blank Checksum error Checksum not match with source code and MCU REV All rights reserved

29 7. TK18 Socket Board Selection Guide Part NO. Package Order NO Note TK18A28Q4B LQFP44 XKTB44LQFPA TK18A26U2B QFN32 XKTB32QFNA TK18A26W2B SOP32 XKTB32SOPA TK18A22W8B SOP28 XKTB28SOPA TK18A18U4B QFN24 XKTB24QFNA TK18A18W4B SOP24 XKTB24SOPA TK18A14W0B SOP20 XKTB20SOPA TK18A10W6B NSOP16 XKTB16NSOPA REV All rights reserved

30 8. Contact Details Headquarters 4F-1, NO.9, Prosperity Rd I, Hsinchu Science Park, Taiwan TEL: FAX: Taipei Sales Office 4F, No. 88, Bauchiau Rd, Shindian City, Taipei, Taiwan TEL: FAX: Kunshan Sales Office Suite 1620, Building A, Modern Plaza, No.18 Weiye Road, Kunshan, JiangSu TEL: FAX: Shenzen Sales Office Suite 625, East Block, Tian An Technology & Innovation Plaza Phase II, Tian An Cyberpark, Futian, Shenzhen, Zip code P.R.C. TEL: FAX: REV All rights reserved