I3000 User's Guide
Contents
1. www holtek com e Step 2 Ensure that there is a connection to the bootloader Click the lt Program gt button to begin program operation as shown in figure 25 A process bar will then appear as shown in Figure 26 Process Partial Lock Partial Program Switch To User Program Figure 25 Program Figure 26 Rev 1 20 21 of 43 August 22 2014 13000 User s Guide por OF www holtek com When the program operation is completed the process bar will display 100 and a lt Close gt button will be shown as shown in Figure 27 Program Figure 27 Click the lt Close gt button to close the process bar thus finishing the program operation Rev 1 20 22 of 43 August 22 2014 13000 User s Guide vor OF www holtek com 2 Software Development Kit SDK After the 13000 installation is completed the installation directory includes an ISPDLL folder which contains two 13000 SDK versions the x86 used for 32 bit program and the x64 used for 64 bit program Both of the SDK versions contain all the 13000 functions Users can choose any one version according to their individual requirements 2 1 Operating Introduction There are two methods to access the DLL file explicit linking and implicit linking When using implicit linking an ISPDLL h file must be included in the project and linked to the library file ISPDLL lib To avoid conflict users should not define WRITERCMD_ API i2. 5555555555555555 555555552 5555555555555555 Show Checksum Bootloader Version Program oad Compieted L tatus Area Unable to connect bootloader R USB Connect Download Mode Figure 7 Rev 1 20 7 of 43 August 22 2014 13000 User s Guide por CF www holtek com Move the mouse near to the title bar and a tool bar will appear as shown below HOCLCEK T3000 E e CD e se e Figure 8 By using this tool bar users can open new files reset the data type or view the software information 1 3 Area Functions in the Main Interface The data area includes two sections one for code and one for options These can be switched between each other with a single click If not all the contents are shown move the mouse to the right border a scroll bar will then appear with which users can view the contents The function button area includes all the available operations The status area is mainly used to display the operation results 1 4 Functional Introduction 1 4 1 Erase This instruction erases the code or option information programmed to the IC Click the lt Erase gt button and a dialogue box as shown in Figure 9 will appear Rev 1 20 8 of 43 August 22 2014 pore H www holtek com 13000 User s Guide Erase Setting Start Page f g Addr H H MS End Page Select All Unselect All Click v Figure 9 9 of 43 August 22 2014 Rev 1 20 abesn 00091 pore CF 13000 User s
3. ISP Writer 2 1 Build20130621 Copyright C 2012 2013 Holtek Semiconductor Inc 13000 User s Guide USB Connect Download Mode Figure 4 Move the mouse to the button next to Exit When the button turns red as the following shows a single click on the button will exit the software Figure 5 Rev 1 20 5 of 43 August 22 2014 H H www holtek com 13000 User s Guide Click the lt Open gt button an open file dialogue box appears Only those files with an mtp suffix can be selected from any location on the computer Open File Look in e test e ea gt My Recent Documents Desktop My Documents My Computer a File name IE lt My Network Files of type MTP Files mtp X Cancel Places Open as read only Figure 6 Double click the required file or single click the file and click the lt Open gt button to open the file and enter the main interface as shown in Figure 6 Rev 1 20 6 of 43 August 22 2014 abesn 000 13000 User s Guide por OF www holtek com 1 2 Main Interface The main Interface is mainly composed of the title bar data area function button area and status area as Figure 7 shows HOLTEK 13000 itina L Process Erase Verify G Program ani Blank Check J Partial Lock g S Partial Program Switch To User Program MCU Start HIH 5555555
4. function succeeds the return value is 0 otherwise 1 Note This is a new and higher level function which is added from V2 2 5 14 In general cases users should not call this function directly but call the LockByAddr LoadByPage or Load AI function Ensure that the LoadFile or LoadProgdata function has already been called successfully before this function Sample Code Rev 1 20 37 of 43 August 22 2014 13000 User s Guide vor OF www holtek com LockAll This function locks the whole MCU BOOL LockAl1 Return Value If the function succeeds it returns TRUE otherwise FALSE Note Ensure that the LoadFile or LoadProgdata function has already been called successfully before this function GetTransProgress Rev 1 20 The function gets the current programming progress int GetTransProgress Return Value The function returns the current completion ratio Note After a program type function such as BlankCheck Program PartialProgram EraseByAddr EraseByPage VerifyByAddr or VerifyByPage is called this function can be called to get the related programming progress a completion ratio of 100 indicates that the program operation is finished Sample Code int nProgress GetTransProgress printf Curret Progress d nProgress 38 of 43 August 22 2014 YAS y JUsWdojanaq aeMyoS 13000 User s Guide por CF www holtek com GetBootloaderVer The function gets the Bootloader versi
5. will return 1 Return Value If the function fails the return value is 1 which stands for a hardware error If the function succeeds a return value of indicates wrong pages 0 indicates a successful lock Note This function converts the address range specified by wOffset wordLen into pages 256 words as one page If the specified address range is not enough for integer pages this function will internally align it into integer pages The Lock function usually locks two pages at once If the required pages number is odd the actual locked pages number is even If the address range specified by wOffset wordLen is equal to the MCU Code buffer size then the whole Code buffer will be locked Program Rom Ensure that the LoadFile or LoadProgdata function has already been called successfully before this function Sample Code Ensure that the LoadFile or LoadProgdata function has been called successfully here omit the detailed procedur Lock 320 words starting from address 0 int nRet LockByAddr 0 320 if 0 nRet puts hock Suceesis else if 1 nRet puts Wrong Pages else puts Lock Failed Rev 1 20 35 of 43 August 22 2014 WAS yy JUMWdojanaq aeMyos 13000 User s Guide pore H www holtek com LockByPage This function locks the specified pages int LockByPage WORD wStartPage WORD wCnt Parameters in wStartPage Specifies the zero based index of starting page to be locked If it i
6. 2 if nRet 1 puts PartialProgram Success else puts PartialProgram Failed Rev 1 20 30 of 43 August 22 2014 WS Wy JUsWdojanaq aeMYyoS 13000 User s Guide vor H www holtek com EraseByAddr The function erases the specified data by address int EraseByAddr WORD wOffset WORD worden BYTE ucType Parameters in wOffset The starting address of the address range to be erased in words If this parameter is greater than the maximum address of the MCU available space the function will fail in wordLen The total length of the address range to be erased in words Note that ucType 0 wordLen can not be 0 or the function will fail If this parameter exceeds the MCU available space size the excess part will be truncated in ucType Indicates the programmed data type 0 stands for Code 1 stands for Option For other values the function will fail When ucType 1 the above two parameters will be ignored Return Value If the function fails the return value is 1 otherwise 0 Note When ucType 0 this function will convert the specified address range into pages If the address range indicated by wOffset wordLen is not enough for integer pages the function will internally align it into integer pages If the address range exceeds the available space the excess part will be truncated Ensure that the LoadFile or LoadProgdata function has already been called successfully before this f
7. Guide www holtek com By inputting a hexadecimal number in the Start Page or End Page text box users can select the page where this address exists Press lt Click gt for a drop down list to check the selected pages Users can also select pages directly in the drop down list If the selected pages are consecutive then the corresponding start address and end address will be displayed in the Start Page and End Page text box respectively as shown in Figure 10 Erase Setting Start Page 0 f Addr 2 H 8 H End Page 4 Select All Unselect All PageO Page1 Page2 Page3 Page4 Click lt T Z ad E v Page1 E v Page2 Page3 mnn ree v Page4 Mi a Clicking the lt Select All gt button will select all pages clicking the lt Unselect All gt button will cancel all the selected pages Figure 10 Clicking the lt Cancel gt button will cancel the erase operation Clicking the lt Erase gt button will start the erase operation If no page is selected or the input address is not valid for a correct page range a warning as shown below appears Rev 1 20 10 of 43 August 22 2014 esn 000 nor H 13000 User s Guide www holtek com Figure 11 Erase Setting Warning Select at least one page Click Cancel Erase Rev 1 20 Otherwise a normal erase operation starts and a progress bar appears If only the code check box in the Setting menu is selected when the progress
8. HOLTEK SA 13000 User s Guide Revision V1 20 Date August 22 2014 wwiholitekK com 13000 User s Guide Table of Contents 1 13000 Usage 1 1 Start Interface 1 2 Main Interface 1 3 Area Functions in the Main Interface 1 4 Functional Introduction HN E L HN eA NSM ae e e taeee suse teeta itet erent cera coeee irae ee deo es lT TR a r Me eenia e E ee SorcEse Peaaenraerrcerrec Pers e426 PartialProgtanmn e eere a E cent eres sree gervieege emery secs 11a Siem ke WISE PN L6 FE LIN ee a WAS NA GUIS teat tere ee reece pa arrears eee eR PAO OWM C Nee kS EI LRR STele eT eT RST Tan 1 5 Using the 13000 for Program Operation 2 Software Development Kit SDK 2 1 Operating Introduction 2 2 Operating Flowchart 2 3 SDK API Introduction aagi oad Prog altel erea a e e eavoncave sevens ereecor avy scereurteyas TT a ESI ESTI caete ce ccs cece ees a a a BlankGheck TTT Progtanmi eee a E E tee paaga nee aeseteeeeres EraseByAddr cerna e e sey tau vcsx A E EraseByPage n e a a se recusere rents reet erecta sect eeaet ceaevieeetsrteets Nemthy BY ACG ieee soos aecerssse corer vy eceeeeueeerrseccerteteagons eesasecrnre ener SZT SU STL Bele 25 Clie resect te ees ote a E E E es Bee Te SG Enep DGT Ree AT ica sone as sees seca E a evageasmeverelarieere Gethrans Progress eae cerca seers ocr ere ener ee GetBootloadenn e eee reece cere ee caesar eee eee eee ConmectToBootloader me e ener eee eee DISConnectBootload e SWitehToUserero
9. MAT ini file in the application directory the function will fail Either the LoadFile or LoadProgdata function must be called before a program type function such as BlankCheck Program PartialProgram EraseByAddr EraseByPage VerifyByAddr VerifyByPage LockByAddr LockByPage LockAll or GetChksum Rev 1 20 25 of 43 August 22 2014 WAS yy JUMWdojanaq aeMyoS 13000 User s Guide pore CFE www holtek com Sample Code SaveFile Rev 1 20 This function is used to save the MTP file BOOL SaveFile LPCTSTR szFilePath Parameter in szFilePath This is the save path for the MTP file If this parameter is input incorrectly the function will fail Return Value If the function succeeds it returns TRUE otherwise FALSE Note Ensure that the LoadFile or LoadProgdata function has been called successfully before this function Sample Code 26 of 43 August 22 2014 WAS UY u wdoj n q aeMyos 13000 User s Guide vor CF www holtek com GetChksum Rev 1 20 This function is used to get the checksum int GetChksum BYTE calcMode Parameter in calcMode Specifies the check type 0 stands for Code 1 stands for Code Option 2 stands for Code Option Data For other values the function will fail Return Value If the function fails the return value is 1 which indicates a wrong check type otherwise the return value is a valid checksum Note Ensure that the LoadFil
10. ORMAT ini file int LoadFile LPCTSTR szMtpPath PBYTE amp pProgramBuf WORD amp wProgramSize PBYTE amp pOptionBuf WORD amp wOptionSize PBYTE amp pDataBuf WORD amp wDataSize Parameters in szMtpPath This is the full path of the MTP file to be loaded If this parameter is input incorrectly the function will fail out pProgramBuf Points to the Code buffer out wProgramSize Indicates the Code buffer size in words out pOptionBuf Points to the Option buffer out wOptionSize Indicates the Option buffer size in words out pDataBuf Points to the Data buffer if there is no data it will return NULL out wDataSize Indicates the Data buffer size in bytes If there is no data it will return 0 Return Value If the function fails the return value is 1 otherwise 0 Note This function needs to internally load an EFORMAT ini configuration file If there is no EFORMAT ini file in the application directory the function will fail Either the LoadFile or LoadProgdata function must be called before a program type function such as BlankCheck Program PartialProgram EraseByAddr EraseByPage VerifyByAddr VerifyByPage LockByAdrr LockByPage LockAll or GetChksum Sample Code char pszPath C HT68FB550 MTP PBYTE pProgram NULL pOption NULL pData NULL WORD wProgramSize 0 wOptionSize 0 wDataSize 0 if LoadFile pszPath pProgram wProgramSize pOption wOptionSize pData
11. S yy JUsWdojanaqg aeMyoS 13000 User s Guide vor OF www holtek com GetMCUInfo The function gets the MCU information BOOL GetMCUInfo MCUINFO pMculInfo Parameter in out pMculInfo Points to the MCUINFO structure which is defined in ISPDLL h typedef struct MCUINFO t DWORD cbSize structure size int nPageSize page size for the programming operation in words int nMaxProgramPage maximum page number that can be programmed int nMaxLockPage maximum page number that can be locked int nBootloaderSize Bootloader size in words char szMcuName 16 the current MCU name a new variable which is added in v2 2 5 14 MCUINFO Return Value If the function succeeds it returns TRUE otherwise FALSE Note When passing the parameter user must first assign to cbSize using sizeof MCUINFO Ensure that the LoadFile or LoadProgdata function has already been called successfully before this function The nMaxLockPage is a member of the MCUINFO structure indicating the whole Program Rom size the value of which is irrelevant to the bootloader The Program Rom whole size minus the nBootloaderSize value makes the nMaxProgramPage value Here nBootloaderSize is assigned based on the bootloader description in the MTP file If the MTP file includes no bootloader description then nBootloaderSize equals to 0 Sample Code Ensure that the LoadFile or LoadProgdata function has been called successfully here omit the d
12. a function has been called successfully here omit the detailed procedur Erase 100 pages starting from page 0 of the code buffer th following code runs in a separated thread int nRet EraseByPage 0 100 0 if nRet 1 puts Erase Success else puts Erase Failed Rev 1 20 32 of 43 August 22 2014 YAS Wy JUsWdojansq aeMYyoS 13000 User s Guide vor OF www holtek com VerifyByAddr Rev 1 20 The function verifies whether the data of the specified addresses in the MCU match the programmed data int VerifyByAddr WORD wOffset WORD wordLen BYTE ucType Parameters in wOffset The starting address of the specified address range to be verified in words If this parameter is greater than the maximum address of the MCU available space the function will fail in worden The total length of the addresses to be verified in words When ucType 0 wordLen can not be 0 or the function will fail If this parameter exceeds the MCU available space size the excess part will be truncated in ucType The data type to be verified 0 stands for Code stands for Option For other values the function will fail When ucType 1 the above two parameters will be ignored Return Value If the function fails the return value is 1 If the function succeeds a return value of 0 indicates that all data matched indicates unmatched Note When uclype 0 this function will convert th
13. bar displays 100 the status area will display Erase program OK and a lt Close gt button will appear This is used to close the progress bar as shown in Figure 12 11 of 43 August 22 2014 abesn 000 pore OF 13000 User s Guide www holtek com L Blank Check Erase Close Program H d j j MCU HT66FB550 Program Rom Size 7680 w Bootloader Version x Figure 12 Rev 1 20 12 of 43 August 22 2014 H H www holtek com 13000 User s Guide 1 4 2 Verify This instruction verifies whether the code or option information has been programmed to the IC successfully Click the lt Verify gt button and a Verify Setting dialogue box will appear Verify Setting Start Page Addr H End Page Select All Unselect All Click lt Figure 13 This dialogue box is operated in the same way as the Erase Setting dialogue box Rev 1 20 13 of 43 August 22 2014 abesn 000 13000 User s Guide por CF www holtek com 1 4 3 Program This instruction programs code or option information to the IC Click the lt Program gt button to start the program operation This instruction is executed according to the selection in the Setting menu Blank Check Program Close Program rt Show Checksum Figure 14 Note If an error warning appears during the program operation execute an erase operation and try aga
14. called successfully before this function Sample Code Rev 1 20 29 of 43 August 22 2014 13000 User s Guide vor OF www holtek com PartialProgram The function programs the specified data range to the IC int PartialProgram WORD wOffset WORD wordLen Parameters in wOffset The starting address of the specified data range in words If this address exceeds the maximum address of the MCU available space the function will fail in wordLen The total length of data to be programmed in words If this length is greater than the MCU available space size the excess part will be truncated Return Value If the function fails the return value is 1 otherwise 0 Note This function is only available for Code programming The Option programming does not support the function This function converts the specified address range into pages If the address range indicated by wOffset wordLen is not enough for integer pages the function will internally align it into integer pages If the address range exceeds the available space the excess part will be truncated Ensure that the LoadFile or LoadProgdata function has already been called successfully before this function Sample Code Ensure that the LoadFile or LoadProgdata function has been called successfully here omit the detailed procedur Program 32 words starting from address 0 the following code runs in a separate thread int nRet PartialProgram 0 3
15. e applications mentioned herein are used solely for the purpose of illustration and Holtek makes no warranty or representation that such applications will be suitable without further modification nor recommends the use of its products for application that may present a risk to human life due to malfunction or otherwise Holtek s products are not authorized for use as critical components in life support devices or systems Holtek reserves the right to alter its products without prior notification For the most up to date information please visit our web site at http www holtek com tw Rev 1 20 43 of 43 August 22 2014
16. e or LoadProgdata function has been called successfully before this function After the function is called the program must first check if the return value is 1 if not then convert the checksum in words or in bytes according to the requirement Sample Code 27 of 43 August 22 2014 13000 User s Guide pore CFE www holtek com BlankCheck The function checks whether the specified type of data in the MCU is blank int BlankCheck BYTE ucType Parameter in ucType Stands for the data type to be checked 0 stands for Code 1 stands for Option For other values the function will fail Return Value If the function fails the return value is 1 If the function succeeds a return value of 1 stands for non blank 0 stands for blank Note The size of the Code or Option buffer is read from the EFORMAT ini using the MTP file Ensure that the LoadFile or LoadProgdata function has already been called successfully before this function Sample Code Rev 1 20 28 of 43 August 22 2014 H FE 13000 User s Guide www holtek com Program The function programs the specified type of data to the IC int Program BYTE ucType Parameter in ucType Indicates the data type to be programmed 0 stands for Code 1 stands for Option For other values the function will fail Return Value If the function fails the return value is 1 otherwise 0 Note Ensure that the LoadFile or LoadProdata function has already been
17. e specified address range into pages If the address range indicated by wOffset wordLen is not enough for integer pages the function will internally align it into integer pages If the address range exceeds the available space the excess part will be truncated Ensure that the LoadFile or LoadProgdata function has already been called successfully before this function Sample Code Ensure that the LoadFile or LoadProgdata function has been called successfully here omit the detailed procedur Verify 64 words starting from address 0 of the code buffer th following code runs in a separated thread int nRet VerifyByAddr 0 64 0 if 0 nRet puts Data Matched else if 1 nRet puts Data Unmatched else joules Tisbincieiem TTT 33 of 43 August 22 2014 WAS yy JUsWdojanaq aeMyos 13000 User s Guide vor OF www holtek com VerifyByPage The function verifies whether the data of the specified pages in the MCU match the programmed data int VerifyByPage WORD wStartPage WORD wCnt BYTE ucType Parameters in wStartPage Specifies the zero based index of the starting page to be erased If it is greater than the maximum page number in the MCU the function will fail in wCnt The number of pages to be verified When ucType 0 this parameter can not be 0 or the function will fail If this parameter is greater than the maximum number of pages in the MCU the excess part will be truncat
18. ed in ucType Indicates the data type to be verified 0 stands for Code 1 stands for Option For other values the function will fail When ucType 1 the above two parameters will be ignored Return Value If the function fails the return value is 1 If the function succeeds a return value of 0 indicates that all data is matched indicates unmatched Note Ensure that the LoadFile or LoadProgdata function has already been called successfully before this function Sample Code Ensure that the LoadFile or LoadProgdata function has been called successfully here omit the detailed procedur Verify 100 pages starting from page 0 of the code buffer th following code runs in a separated thread int nRet VerifyByPage 0 100 0 if 0 nRet puts Data Matched else if 1 nRet puts Data Unmatched else H TOE TTT Rev 1 20 34 of 43 August 22 2014 WAS Wy JUsWdojanaq aeMYyoS 13000 User s Guide vor OF www holtek com LockByAddr The function locks pages where the specified addresses exit int LockByAddr WORD wOffset WORD wordLen Parameters in wOffset The starting address of the specified addresses to be locked in words If this parameter is greater than the maximum address of the MCU available space the function will return 1 in wordLen The total length of addresses to be locked in words If this parameter is greater than the MCU available space size the function
19. etailed procedur MCUINFO mi mi cbSize sizeof MCUINFO if GetMCUINFO amp mi printf Current MCU s PageSize d MaxProgramPage d MaxLockPage d Bootloader Size d mi szMcuName mi nPageSize mi nMaxProgramPage mi nMaxLockPage mi nBootloaderSize Rev 1 20 41 of 43 August 22 2014 WAS yy JUsWdojanaq aeMyos 13000 User s Guide pore CFE www holtek com i3kSys The function reads a given size of data from MCU Code buffer and compares them with the specified data BOOL i3kSys WORD wOffset WORD wSize BYTE buffer Parameter in wOffset The starting address of the MCU Code data to be compared in words in wSize The size of the MCU Code data to be compared in words If this parameter is 0 or not an integer multiple of the page size the function will return FALSE in buffer Points to the specified data buffer Return Value If the data read from the Code buffer match the specified data the function will return TRUE otherwise FALSE In addition if any one of the above parameters is invalid the function will also return FALSE Sample Code Rev 1 20 42 of 43 August 22 2014 13000 User s Guide pore OF www holtek com Copyright 2014 by HOLTEK SEMICONDUCTOR INC The information appearing in this Data Sheet is believed to be accurate at the time of publication However Holtek assumes no responsibility arising from the use of the specifications described Th
20. granmik a Exec teProgramE rom a a e e GetMG IIT certs vote tee eager epee eee ECS aaeteceeecceceoenace senna eae ee rr care pe eease eet cracorcocraseecreearcreersecerrree Rev 1 20 2 of 43 pore H www holtek com August 22 2014 U9 U09D jo jqeL H H 13000 User s Guide www holtek com 1 13000 Usage 1 1 Start Interface After the 13000 installation is finished double click the TEMNI interface will then appear icon on the desktop the following HOLLEK 13000 Setting Download Mode Figure 1 Rev 1 20 3 of 43 August 22 2014 abesn 000 13000 User s Guide por CF www holtek com USB Connect indicates whether the software has connected to the Bootloader Download Mode indicates if it is ready for program operations means yes pa means no Figure 1 indicates that it has been connected to the Bootloader and normal program operations are allowed while Figure 2 indicates no SB Connect Download Mode Figure 2 Click the lt Setting gt button to select the data type Regarding the white check boxes means has been selected and R means not selected Setting Code O Option Figure 3 Rev 1 20 4 of 43 August 22 2014 13000 User s Guide por CF www holtek com Click the lt Help gt button to view the software information clicking the following link will open this User s Guide a About HOLTEK 13000 HOLTEK 13000
21. gure 20 The functions of the three options shown should be self explanatory from their content Rev 1 20 18 of 43 August 22 2014 nor CF 13000 User s Guide www holtek com 1 4 9 Show Checksum Selecting Code means to check the Code ROM only Selecting Code Option means to check the Code ROM and the Option ROM Click the lt Show Checksum gt button and a dialogue box as shown in Figure 21 appears Checksum Code Code Option Figure 21 Select the Code or the Code Option check box and the text box will display the corresponding Checksum value 1 4 10 Bootloader Version This instruction is used to obtain the Bootloader version Click the lt Bootloader Version gt button and the Bootloader version information will be displayed in the status area as shown in Figure 22 MCU HT66FB550 Program Rom Size 7680 words Bootloader Version Download Program Download Completed Excute AP OK Bootloader Version Ver4 00 Figure 22 Rev 1 20 19 of 43 August 22 2014 abesn 000 13000 User s Guide por OF www holtek com 1 5 Using the 13000 for Program Operation e Step 1 Click the lt Open gt button in the 13000 start interface or main interface to open the required MTP file as shown in Figure 23 and Figure 24 Setting Figure 23 HOLLEK 13000 O rl C ae Figure 24 Rev 1 20 20 of 43 August 22 2014 13000 User s Guide por CF
22. in Rev 1 20 14 of 43 August 22 2014 nor CF 13000 User s Guide www holtek com 1 4 4 Blank Check This instruction checks if the IC has been previously programmed Click the lt Blank Check gt button If the IC has been programmed a Not Blank error warning will be displayed A lt Close gt button will then appear as shown in Figure 15 Otherwise the lt Close gt button appears only after the progress bar displays 100 as shown in Figure 16 Blank Check 0 Figure 15 Blank Check Figure 16 Rev 1 20 15 of 43 August 22 2014 13000 User s Guide por OF www holtek com 1 4 5 Partial Lock This instruction locks the selected code section After being locked the code cannot be read or erased Click the lt Partial Lock gt button and a dialogue box as shown below appears 0000 Be gm nan gt Partial Lock 0 o Program 9 __ Lock All o ilank Check k N ao Select All Unselect All 0 l o Click lt oO o Page0 1 a ser Program 0 B 0 Page2 3 Lock a o i Page4 5 DD Start 0000 gt L Page6 7 0000 0000 0000 0000 0000 0000 0000 oooo Show Checksum Figure 17 Press lt Click gt to view the drop down list Clicking the white check box will select the corresponding page Clicking the lt Select All gt or lt Unselect AI button will select all pages or cancel all the selected pages After selecting the required pages click the lt Lock gt bu
23. n the user application program When the application program is running the ISPDLL dll file HIDDLL dll file and EFORMAT ini file must be located in the application program folder The ISPDLL dll file includes the required API and the HIDDLL dIl file provides the underlying interface for the ISPDLL dIl file Note the ISPDLL dIl file uses multi byte encoding 2 2 Operating Flowchart Rev 1 20 lt Start gt Y ConnectToBootloader kas LoadFile LoadProgdata gt e Other Do Program dr Program Other ma T ae St GetBootloaderVer BlankCheck GetChksum Program PartialProgram SwitchToUserProgram EraseByAddr EraseByPage ExecuteProgramFrom VerifyByAddr VerifyByPage GetMCUInfo LockByAddr LockByPage SaveFile LockAll i3kSys m gt GetTransProgress No lt progress 1007 gt E P Yes No lt Quit Yes y DisConnectBootloader F 4 End K 23 of 43 August 22 2014 WAS yy JUsWdojanaq aeMyos 13000 User s Guide vor OF www holtek com 2 3 SDK API Introduction The ISPDLL dll file includes 23 functions which will be introduced below LoadFile Rev 1 20 The function is used to load the MTP file and return the pointers of the Code buffer Option buffer and Data buffer if there is any data and their buffer sizes Here the buffer sizes are based on the corresponding MCU description in the EF
24. on BYTE GetBootloaderVer Return Value The Bootloader version Sample Code ConnectToBootloader The function is used to connect to the Bootloader int ConnectToBootloader Return Value If the function fails the return value is 1 otherwise 0 Sample Code DisConnectBootloader The function is used to disconnect the Bootloader int DisConnectBootloader Return Value If the function fails the return value is 1 otherwise 0 Sample Code Rev 1 20 39 of 43 August 22 2014 13000 User s Guide vor OF www holtek com SwitchToUserProgram The function is used to switch to the user program void SwitchToUserProgram Note This function usually works together with the ExecuteProgramFrom function Sample Code if ExecuteProgramFrom 0 0 SwitchToUserProgram ExecuteProgramFrom The function is used to setup the program executing mode int ExecuteProgramFrom BYTE byMode Parameter in byMode Indicates the program executing mode 0 MCU Starts at the bootloader 1 MCU starts at the bootloader then executes the user firmware 2 MCU starts at the user firmware For other values the function will fail Return Value If the function fails the return value is 1 otherwise 0 Note This function is usually called before the SwitchToUserProgram function Sample Code if ExecuteProgramFrom 0 0 SwitchToUserProgram Rev 1 20 40 of 43 August 22 2014 W
25. s greater than the maximum page number to be locked the function will fail in wCnt The number of pages to be locked If this parameter is greater than the maximum number of pages in the MCU the excess part will be truncated Return Value If the function fails a return value of 1 indicates wrong pages 1 indicates a hardware error If the function succeeds the return value is 0 indicating a successful lock Note If the page range specified by wStartPage wCnt is equal to the MCU Code buffer size then the whole Code buffer will be locked Program Rom Ensure that the LoadFile or LoadProgdata function has already been called successfully before this function Sample Code Ensure that the LoadFile or LoadProgdata function has been called successfully here omit the detailed procedur Lock 5 pages starting from page0 page0 pagel page2 page3 and paded int nRet LockByPage 0 5 if 0 nRet OUIES lioele Success p else if 1 nRet puts Wrong Pages else puts Lock Failed Rev 1 20 36 of 43 August 22 2014 WAS y JUsWdojanaq aeMYOS H 13000 User s Guide www holtek com LockFromOption This function locks pages according to the option int LockFromOption PBYTE pOption WORD wordLen Parameters in pOption The address that points to the option buffer in wordLen Option length Return Value If any one of the above parameters is invalid the return value is 1 If the
26. tton to start the lock operation Rev 1 20 16 of 43 August 22 2014 H CF www holtek com 13000 User s Guide 1 4 6 Partial Program This instruction works in the same way as the Program instruction except that this instruction only programs specified pages Click the lt Partial Program gt button and the following dialogue box appears Partial Program Start Page f End Page Figure 18 Input a hexadecimal number in the Start Page and End Page text boxes respectively and ensure that the latter value is bigger than or equal to the former value Click the lt Program gt button to program the selected pages Rev 1 20 17 of 43 August 22 2014 abesn 00091 13000 User s Guide pore OF www holtek com 1 4 7 Switch to User Program This instruction simulates a USB plug in and plug out action Click the lt Switch to user program gt button and the following dialogue box appears Blank Check Switch to user program annan a 0000 0000 0000 Show Checksum Figure 19 1 4 8 MCU Start Only after verifying that the IC has been successfully programmed can this instruction be used to select the MCU start mode Click the lt MCU Start gt button and a dialogue box as shown in Figure 20 appears MCU Start C MCU starts at the bootloader C MCU starts at the bootloader then executes the user firmware MCU starts at the user firmware OK Fi
27. unction Sample Code Ensure that the LoadFile or LoadProgdata function has been called successfully here omit the detailed procedur Erase 32 words starting from address 0 of the code buffer th following code runs in a separated thread int nRet EraseByAddr 0 32 0 if nRet 1 puts Erase Success else puts Erase Failed Rev 1 20 31 of 43 August 22 2014 YAS yy u wdoj n q aeMyoSs 13000 User s Guide pore OF www holtek com EraseByPage The function erases the specified data by page int EraseByPage WORD wStartPage WORD wCnt BYTE ucType Parameters in wStartPage Specifies the zero based index of starting page to be erased If it is greater than the maximum page number in the MCU the function will fail in wCnt The number of pages to be erased When ucType 0 this parameter can not be 0 or the function will fail If this parameter is greater than the maximum number of pages in the MCU the excess part will be truncated in ucType Indicates the data type to be erased 0 stands for Code 1 stands for Option For other values the function will fail When ucType 1 the above two parameters will be ignored Return Value If the function fails the return value is 1 otherwise 0 Note Ensure that the LoadFile or LoadProgdata function has already been called successfully before this function Sample Code Ensure that the LoadFile or LoadProgdat
28. wDataSize 1 Execute other operations 24 of 43 August 22 2014 WS Wy JUswWdojanaqg aeMyoS 13000 User s Guide vor OF www holtek com LoadProgdata Being the same as the LoadFile function the function uses the loaded MTP file to return the pointers of the Code buffer Option buffer and Data buffer if there is any data and their buffer sizes Here the buffer sizes are based on the corresponding MCU description in the EFORMAT ini file int LoadProgdata PBYTE pMtpBuf DWORD dwMtpSize PBYTE amp pProgramBuf WORD amp wProgramSize PBYTE amp pOptionBuf WORD amp wOptionSize PBYTE amp pDataBuf WORDS wDataSize Parameters in pMtpBuf Points to the MTP buffer but can not be NULL or the function will fail in dwMtpSize Indicates the MTP buffer size but can not be 0 or the function will fail out pProgramBuf Points to the Code buffer out wProgramSize Indicates the Code buffer size in words out pOptionBuf Points to the Option buffer out wOptionSize Indicates the Option buffer size in words out pDataBuf Points to the Data buffer If there is no data it returns NULL out wDataSize Indicates the Data buffer size in bytes If there is no data it returns 0 Return Value If the function fails the return value is 1 otherwise 0 Note This function needs to load an EFORMAT ini configuration file internally If there is no EFOR
Download Pdf Manuals
Related Search