Getting started with DfuSe USB device firmware upgrade
Contents
1. Select the manufacturer and model of pour hardware device and then click Nest If vou dep have a disk that contains the driver vou want to install click Have Disk IV Show compatible hardware STM Device in DFU Mode A This driver is not digitally signed Have Disk Tell me why driver signing is important lt Back Cancel e Inthe Install From Disk dialog box click Browse to specify the driver files location the driver directory is located in your install path C Program files STMicroelectronics DfuSe Driver then click OK The PC autoselects the correct INF file in this case STDFU INF Once Windows has found the required driver INF file the compatible hardware model will be displayed in the model list Click Next to proceed ky Doc ID 13379 Rev 4 9 22 Getting started UM0412 Figure 5 Installation from disk Found New Hardware wizard Select the device driver you want to install for this hardware va x Insert the manufacturer s installation disk and then OK H H make sure that the correct drive is selected below Mt Cancel Copy manufacturer s files from CA Program Files STMicroelectronics DfuSe Diive v CA Program Files STMicroelectronics DfuSe Diive v Files STMicroelectronics DfuSe Drive gt Cance e When Windows is performing the driver installation a warning dialog will be displayed indicating that the drive2. Ti UM0412 Yy User manual Getting started with DfuSe USB device firmware upgrade STMicroelectronics extension Introduction This document describes the demonstration user interface that was developed to illustrate use of the STMicroelectronics device firmware upgrade library A description of this library including its application programming interface is contained in the DfuSe application programming interface document and installed with the DfuSe software July 2009 Doc ID 13379 Rev 4 1 22 www st com Contents UM0412 Contents 1 Getting started ita cn no nc Sa me a ng a i QR 5 1 1 System requirements Es eee ee 5 1 2 Package contents nese coon ee vies Se DERE EERS BEE REX EG REDE RR RAS 6 1 3 DfuSe demonstration installation llle 6 1 3 1 Software installation EE ES EE tenes 6 1 3 2 Hardware installation is liliis 6 2 DEU file pio c ch r 12 3 User interface description lsesssess 13 3 1 DfuSe demonstration si is si d rc ec d aa wea ee RIESE Ra Cea 13 3 2 DFU file manager EERS ee REOR QUEE ETE S BOOR DERE DEER PRE 15 3 2 1 Want to do dialog box 0 000 cece 15 3 2 2 File generation dialog BOX EE EE EE EE kk eee 16 3 2 3 File extraction dialog box ee EE EE Ee ee 17 4 Step by step procedures ss ss se EER ER RE RR RR RR RR Re ee 19 4 1 DfuSe demonstration procedures 00 eee eee 19 4 1 1 How to
3. MAY ONLY BE USED IN AUTOMOTIVE APPLICATIONS AT USER S OWN RISK Resale of ST products with provisions different from the statements and or technical features set forth in this document shall immediately void any warranty granted by ST for the ST product or service described herein and shall not create or extend in any manner whatsoever any liability of ST ST and the ST logo are trademarks or registered trademarks of ST in various countries Information in this document supersedes and replaces all information previously supplied The ST logo is a registered trademark of STMicroelectronics All other names are the property of their respective owners 2009 STMicroelectronics All rights reserved STMicroelectronics group of companies Australia Belgium Brazil Canada China Czech Republic Finland France Germany Hong Kong India Israel Italy Japan Malaysia Malta Morocco Philippines Singapore Spain Sweden Switzerland United Kingdom United States of America www st com 22 22 Doc ID 13379 Rev 4 ky
4. upload a DFU file 0 000 ee 19 4 1 2 How to download a DFU file 0 ee Ee ee ee ee 19 4 2 DFU file manager procedures EE EE ee 20 4 2 1 How to generate DFU files from S19 Hex Bin files 20 4 2 2 How to extract S19 Hex Bin files from DFU files 20 5 Revision history ou sus ed ESE RE EE DE ed ed CCCII RE e 21 2 22 Doc ID 13379 Rev 4 ky UMO0412 List of tables List of tables Table 1 DfuSe demo dialog box description EE EE ER EE Ee Ee eke ek ee ke ee 14 Table 2 File generation dialog box description EE EE EE EE eee 16 Table 3 Multi bin injection dialog box description EE EE EE EE Ee ee ee ee ke 17 Table 4 File extraction dialog box description EE EE EE ER EE Ee eee 18 Table 5 Document revision history ie ee ke ee ek ee rn 21 ky Doc ID 13379 Rev 4 3 22 List of figures UM0412 List of figures Figure 1 Figure 2 Figure 3 Figure 4 Figure 5 Figure 6 Figure 7 Figure 8 Figure 9 Figure 10 Figure 11 Figure 12 Figure 13 Figure 14 4 22 System properties dialog box n 5 Selecting the installation location lille 7 Driver selection option iss EE RE EE ER EE EER ee ek ee rr 8 BET od ER ER eee 9 Installation from disk os EE EG EE akri eee 10 Progress message iss eee 10 Warning message EE EE Ee ee ee ee ee ee EEES ee ke cen 11 Installation finish EE EE EE eee 11 DfuS
5. 6 in Table 2 Figure 4 and select your file a DFU image will be created for each added file d Tocreate the image from one or more binary files click the Multi Bin button Item 7 in Table 2 Figure 12 to show the Multi Bin Injection dialog box Figure 13 Click the Browse button Item 2 in Table S Figure 13 to select a binary file bin or other format of file Wave Video Text Set the start address in the address field Item 3 in Table S Figure 13 Click the Add to list button Item 4 in Table S Figure 13 to add the selected binary file with the given address To delete an existing file select it then click the Delete button Item 5 in Table 3 Figure 13 Redo the same sequence to add other binary files Click OK to validate Repeat step 3 to create other DFU images To create the DFU file click Generate How to extract S19 Hex Bin files from DFU files 1 Run DFU File Manager application Start gt All Programs STMicroelectronics gt DfuSe gt DFU File Manage Select want to EXTRACT S19 HEX or BIN files from a DFU one radio button in the Want to do dialog box Figure 11 then click OK Extract an S19 Hex or binary file from a DFU file a Click the Browse button Item 4 in Table 4 Figure 14 to select a DFU file The contained images will be listed in the images list Item 4 in Table 4 Figure 14 b Select an image from the images list c Select Hex S19
6. and services described herein and ST assumes no liability whatsoever relating to the choice selection or use of the ST products and services described herein No license express or implied by estoppel or otherwise to any intellectual property rights is granted under this document If any part of this document refers to any third party products or services it shall not be deemed a license grant by ST for the use of such third party products or services or any intellectual property contained therein or considered as a warranty covering the use in any manner whatsoever of such third party products or services or any intellectual property contained therein UNLESS OTHERWISE SET FORTH IN ST S TERMS AND CONDITIONS OF SALE ST DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY WITH RESPECT TO THE USE AND OR SALE OF ST PRODUCTS INCLUDING WITHOUT LIMITATION IMPLIED WARRANTIES OF MERCHANTABILITY FITNESS FOR A PARTICULAR PURPOSE AND THEIR EQUIVALENTS UNDER THE LAWS OF ANY JURISDICTION OR INFRINGEMENT OF ANY PATENT COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT UNLESS EXPRESSLY APPROVED IN WRITING BY AN AUTHORIZED ST REPRESENTATIVE ST PRODUCTS ARE NOT RECOMMENDED AUTHORIZED OR WARRANTED FOR USE IN MILITARY AIR CRAFT SPACE LIFE SAVING OR LIFE SUSTAINING APPLICATIONS NOR IN PRODUCTS OR SYSTEMS WHERE FAILURE OR MALFUNCTION MAY RESULT IN PERSONAL INJURY DEATH OR SEVERE PROPERTY OR ENVIRONMENTAL DAMAGE ST PRODUCTS WHICH ARE NOT SPECIFIED AS AUTOMOTIVE GRADE
7. ap Item 6 in Table 1 Figure 9 opens a new dialog box that displays the read option bytes You can use this box to edit and apply your own configuration see Figure 10 The tool is able to detect the capabilities of the selected memory part read write and erase In case of an unreadable memory readout protection activated it indicates the memory read status and prompts to ask whether to deactivate the read protection or not Doc ID 13379 Rev 4 ky UM0412 User interface description 3 2 3 2 1 Figure 10 Edit option byte dialog box m DfuSe Demo JL EI X Available DFU and compatible HID Devices STM Device in DFU Mode iv Application Mode DFU Mode Sareea STAR 2 7 E Vendor ID Vendor ID 0483 Supports Upload Manifestation tolerant Suppo mme Can Di Edit option byte DFI Read Protection option byte Actions RDP fh 45 C Read out protection enabled Select Tar User option byte USER h FF v nRST STDBY v nRST STOP v wDG SW Bytes for user data storage Upload Al Data 0 h FF Data1 h FF Flash memory write protection option byte d WRP h FF WRP1 h FF Transfera WRP2 h FF WRP3 h FF Kec Time dur Target 00 Upgrade successful DFU file manager Want to do dialog box When DFU file manager application is executed the Want to do dialog box appears the user has to choose the file operation he wants to do Select the first Radio butt
8. e demo dialog box ii EE EE eee 13 Edit option byte dialog BOX 1 Ee EE RE rn 15 Want to do dialog DOK as ria rn 15 Generation dialog box LE EE EE Re Ee Ee Re Re Se ee ee ee de ed dee ee 16 Multi bin injection dialog box EE EE EE EE RII 17 Extract dialog BOX ee Cera merra Ee ee ek ee ee ee de m rr 17 Doc ID 13379 Rev 4 ky UM0412 Getting started 1 1 Getting started System requirements In order to use the DfuSe demonstration with the Windows operating system a recent version of Windows such as Windows 98SE Millennium 2000 XP or VISTA must be installed on the PC The version of the Windows OS installed on your PC may be determined by right clicking on the My Computer icon in the desktop then clicking on the Properties item in the displayed PopUpMenu The OS type is displayed in the System properties dialog box under the System label in the General tabsheet see Figure 1 Figure 1 System properties dialog box System Properties 2 xj System Restore Automatic Updates Remote General Computer Name Hardware Advanced Terosoft Windows Professional Version 2002 Service Pack 2 Registered to STMicroelectronics STMicroelectronics Manufactured and supported by ETE ei aan HP dc7600 Corporate Master Intel R Pentium R 4 CPU 3 20GHz 2 39 GHz 504 MB of RAM Physical Address Extension Support Information Ca
9. entifier Product identifier Firmware version Available images to be inserted in the DFU file Target identifier number Open S19 or Hex file Open Binary files Target name OON OMI AJOJN Delete selected image from the images list Generate DFU file mk eo 11 Cancel and exit application Because S19 Hex and Bin files do not contain the target specification the user must enter the Device properties VID PID and version the Target ID and the target name before generating the DFU file 16 22 Doc ID 13379 Rev 4 ky UM0412 User interface description Figure 13 Multi bin injection dialog box C Multi Bin injection m 7 File C TouchScreenDemo bin 1 BE Address Ox 08001 000 3 Add to list 4 Delete 5 0x08001000 0x0800B5B7 C XTouchScreenDemo bin 8 OK 7 Cancel 8 Table 3 Multi bin injection dialog box description Control Description 1 Path of the last opened binary file 2 Open binary files A binary file could be a file of any format Wave video Text etc 3 Start address of the loaded file 4 Add file to the file list 5 Delete file from file list 6 File list 7 Confirm file selection 8 Cancel and exit operation 3 2 3 File extraction dialog box If the second choice in the Want to do dialog box was selected Click the OK button to display the File extraction dialog box Thi
10. etach 0x15 0x00 LOGICAL MINIMUM 0 0x26 OxFF 0x00 LOGICAL MAXIMUM 255 0x75 0x08 REPORT SIZE 8 bits 0x95 0x01 REPORT COUNT 1 OxB1 0x82 FEATURE Data Var Abs Vol OxCO END COLLECTION Vendor defined 2 Device identifiers for DFU mode PID VID and Version 3 Device identifiers for Application mode PID VID and Version 4 Send Enter DFU mode command Target will switch from Application to DFU mode or send a HID Detach if the device is a compatible HID device 5 Send Leave DFU mode command Target will switch from DFU to Application mode 6 Memory mapping Double click each item to view more details about the memory part 7 Choose destination DFU file the uploaded data will be copied into this file 8 Start Upload operation 9 Size of the transferred data during the current operation Upload Upgrade 10 Duration time of the current operation Upload Upgrade 11 Available targets in the loaded DFU file 12 Choose source DFU file the downloaded data will be loaded from this file 13 Start upgrade operation Erase then download 14 Verify if data was successfully uploaded 15 Show the progress of the operation 16 Abort current operation 17 Exit application If the microcontroller in use in an STM32F105xx or an STM32F107xx the DfuSe demo shows a new feature that consists in reading the option byte data over the exported Option byte memory part A double click on the related item in the memory m
11. ile 1 Run the DfuSe demonstration application Start gt All Programs gt STMicroelectronics gt DfuSe gt DfuSe Demonstration Click the Choose button Item 12 in Table 1 Figure 9 to select a DFU file the displayed Information such as VID PID Version and target number is read from the DFU file Check the Optimize upgrade duration checkbox to ignore FF blocks during the upload Check the Verify after download checkbox if you want to launch the verification process after downloading data Click the Upgrade button Item 13 in Table 1 Figure 9 to start upgrading file content to the memory Click the Verify button Item 14 in Table 1 Figure 9 to verify if the data was successfully downloaded Doc ID 13379 Rev 4 19 22 Step by step procedures UM0412 4 2 4 2 1 4 2 2 20 22 DFU file manager procedures How to generate DFU files from S19 Hex Bin files 1 4 5 Run the DFU File Manager application Start gt All Programs gt STMicroelectronics DfuSe DFU File Manager Select want to GENERATE a DFU file from S19 HEX or BIN files item in the Want to do dialog box Table 11 then click OK Create a DFU image from an S19 Hex or binary file a Seta non used Target ID number Item 5 in Table 2 Figure 12 b Fill the VID PID Version and the target name C To create the image from an S19 or Hex file click the S19 or Hex button Item
12. ncel Apply Doc ID 13379 Rev 4 5 22 Getting started UM0412 1 2 1 3 1 3 1 1 3 2 6 22 Package contents The following items are supplied in this package Software contents 1 STTube driver consisting of the two following files STTub30 sys Driver to be loaded for demo board STDFUinf Configuration file for driver 2 DfuSe Demo V3 0 Setup exe Installation file which installs the DfuSe applications and source code on your computer Hardware contents This tool is designed to work with all STMicroelectronics devices which supports the Device Firmware Upgrade via an USB interface For more details please contact your ST representative or visit the ST web site http www st com DfuSe demonstration installation Software installation Run DfuSe Demo V3 0 Setup exe file the InstallShield Wizard will guide you to install DfuSe applications and source code on your computer When the software is successfully installed click the Finish button You can then explore the driver directory The driver files are located in the Driver folder in your install path C Program files STMicroelectronics DfuSe The source code for the Demo application and DfuSe library is located in the C Program Files ST Microelectronics DfuSe Sources folder Documentation is located in the C Program Files STMicroelectronics DfuSe Sources Doc folder Hardware installation e Connect the device t
13. o a spare USB port on your PC e The Found New Hardware Wizard then starts Select the Install from a list or specific location as shown below and then click Next Doc ID 13379 Rev 4 ky UM0412 Getting started Figure 2 Selecting the installation location Found New Hardware Wizard Welcome to the Found New D Hardware Wizard This wizard helps you install software for DFU Aware STM Device If your hardware came with an installation CD 389 or floppy disk insert it now What do you want the wizard to do C Install the software automatically Recommended Install from a list or specific location Advanced Click Next to continue Back Cancel Select Don t search will choose the driver to install as shown below and then click Next Doc ID 13379 Rev 4 7 22 Getting started UM0412 Figure 3 Driver selection option Found New Hardware Wizard E Please choose your search and installation options Search removable media floppy COFA FH Include this location in the search zj Browse e Ifa driver is already installed the model list will show the compatible hardware models else click Have Disk to locate the driver files 8 22 Doc ID 13379 Rev 4 ky UM0412 Getting started Figure 4 Driver selection Found New Hardware Wizard Select the device driver you want to install for this hardware Dia agt
14. on Mode 3 DFU Mode F s Vendor ID Vendor ID 0483 Supports Lipload Manifestation tolerant Supports Download Accelerated Upload ST Procuct ID Procuct ID DF11 3 Can Detach Version Version 1000 Actions Select Targets Targetld Name Available Sectors Double Click for more 00 Internal Flash 128 sectors 01 Option Bytes 1 sectors GB Avon Upload Action Upgrade or Verify Action File Internal flash dfu File Internal flash dfu Vendor ID 0483 Targets in file dy T Char 00 Internal Flash rium Procuct ID DF11 Transfered data size Version 1000 107 KB 110100 Bytes of 256 KB 262144 Bytes C Verity after download C Optimize Upgrade duration Remove some FFs Time duration 00 00 16 2 43 14 Verify IE TC S S MI IGTHing Download Phase 4294 Doc ID 13379 Rev 4 13 22 User interface description UM0412 14 22 Table 1 DfuSe demo dialog box description Control Description Lists the available DFU and compatible HID devices the selected one is the one currently used Compatible HID device is a HID class device providing the HID detach feature USAGE PAGE OXFFOO and USAGE_DETACH 0x0055 in its report descriptor Example Oxal 0x00 Collection Physical 1 0x06 0x00 OxFF Vendor defined usage page OxFF00 0x85 0x80 REPORT ID 128 0x09 0x55 USAGE HID D
15. on to generate a DFU file from an S19 Hex or Bin file or the second to extract an S19 Hex or Bin file from a DFU file see Figure 11 Figure 11 Want to do dialog box C DFU File Manager Want to do m m Choose your action G want to GENERATE a DFU file from 19 HEX or BIN files O I want to EXTRACT 519 HEX or BIN files from a DFU one Select I want to GENERATE a DFU file from S19 HEX or BIN files radio button if you want to generate a DFU file from S19 Hex or Binary files Doc ID 13379 Rev 4 15 22 User interface description UM0412 Select I want to EXTRACT S19 HEX or BIN files from a DFU one radio button if you want to extract an S19 Hex or Binary file from a DFU file 3 2 2 File generation dialog box If the first choice was selected click the OK button to display the File Generation dialog box This interface allows the user to generate a DFU file from an S19 Hex or Bin file Figure 12 Generation dialog box CB DFU File Manager Generation mm X Device Images Image for Target ID 00 InternalFlash Image for Target ID 01 ExtemalFlash 4 Vendor ID Ox 10483 1 Product ID Ox DF11 Injection Target ID 1 5 s19orHex 6 Multi BIN 7 E Target Name ExternalFlash 8 Deletion Delete selected Image 9 ever G Cancel 13 Table 2 File generation dialog box description Control Description i Vendor id
16. or Multiple Bin radio button Item 6 in Table 4 Figure 14 d Click the Extract button Item 7 in Table 4 Figure 14 to extract the selected image Repeat step 3 to extract other DFU images Doc ID 13379 Rev 4 ky UM0412 Revision history 5 4 Revision history Table 5 Document revision history Date Revision Changes 06 Jun 2007 1 Initial release 02 Jan 2008 2 Added Section 4 24 Sep 2008 3 Updated Figure 9 to Figure 14 DfuSe demo upgraded to version V3 0 Section 3 1 DfuSe demonstration updated Figure 9 DfuSe demo dialog box updated New feature added for STM32F105 107xx devices 02 Jul 2009 4 Figure 10 Edit option byte dialog box added Updated in Section 3 2 DFU file manager Figure 11 Want to do dialog box Figure 12 Generation dialog box Figure 13 Multi bin injection dialog box Figure 14 Extract dialog box Doc ID 13379 Rev 4 21 22 UM0412 Please Read Carefully Information in this document is provided solely in connection with ST products STMicroelectronics NV and its subsidiaries ST reserve the right to make changes corrections modifications or improvements to this document and the products and services described herein at any time without notice All ST products are sold pursuant to ST s terms and conditions of sale Purchasers are solely responsible for the choice selection and use of the ST products
17. pgrade the firmware of these devices Traditionally firmware is stored in Hex S19 or Binary files but these formats do not contain the necessary information to perform the upgrade operation they contain only the actual data of the program to be downloaded However the DFU operation requires more information such as the product identifier vendor identifier Firmware version and the Alternate setting number Target ID of the target to be used this information makes the upgrade targeted and more secure To add this information a new file format should be used to be called DFU file format For more details refer to the DfuSe File Format Specification document UM0391 Doc ID 13379 Rev 4 ky UM0412 User interface description 3 3 1 User interface description This section describes the different user interfaces available in the DfuSe package and explains how to use them to perform DFU operations such as Upload Download and firmware file management DfuSe demonstration Firmware upgrades need to be able to be performed without any special training even by novice users Hence the user interface was designed to be as robust and simple to use as possible see Figure 9 The numbers in Figure 9 refer to the description in Table 7 listing the available controls in the DfuSe Demonstration interface Figure 9 DfuSe demo dialog box e DfuSe Demo Available DFU and compatible HID Devices Q SE Applicati
18. r has not passed Windows logo testing click continue Anyway to continue Figure 6 Progress message Please wait while the wizard installs the software eS lt STM Device in DFU Mode Cancel 3 10 22 Doc ID 13379 Rev 4 UM0412 Getting started Figure 7 Warning message Hardware Installation AN The software vou are installing for this hardware STM Device in DFU Mode has not passed Windows Logo testing to verify its compatibility with Windows XP Tell me why this testing is important Continuing your installation of this software may impair or destabilize the correct operation of your system either immediately or in the future Microsoft strongly recommends that you stop this installation now and contact the hardware vendor for software that has passed Windows Logo testing Continue Anyway STOP Installation e Windows should then display a message indicating that the installation was successful Click Finish to complete the installation Figure 8 Installation finish Found New Hardware Wizard Completing the Found New Hardware Wizard The wizard has finished installing the software for STM Device in DFU Mode Click Finish to close the wizard lt Back Cancel Doc ID 13379 Rev 4 11 22 DFU file UM0412 2 12 22 DFU file Users that have purchased DFU devices require the ability to u
19. s interface allows you to generate an S19 Hex or Bin file from a DFU file Figure 14 Extract dialog box CB DFU File Manager Extract Device Images Vendor ID Ox ED Image for Target ID 00 InternalFlash Product ID Ox FT Image for Target ID 01 EstemalFlash O Version Ox TAGS Extraction 319 C Hex C Multiple Bin 6 Extract 7 Cancel 8 ky Doc ID 13379 Rev 4 17 22 User interface description UM0412 18 22 Table 4 File extraction dialog box description Control 1 Description Device vendor identifier Device product identifier Firmware version Open DFU file Image list in the loaded DFU file Type of the file to be generated Extract image to S19 Hex or Bin file ON OO AJOJN Cancel and exit application Doc ID 13379 Rev 4 x UM0412 Step by step procedures 4 Step by step procedures 4 1 DfuSe demonstration procedures 4 1 1 How to upload a DFU file 1 Run the DfuSe demonstration application Start gt All Programs gt STMicroelectronics gt DfuSe gt DfuSe Demonstration 2 Click Choose button Item 7 in Table 1 Figure 9 to select a DFU file 3 Select the memory target s in the memory mapping list Item 6 in Table 1 Figure 9 4 Click Upload button Item 8 in Table 1 Figure 9 to start uploading memory content to the selected DFU file 4 1 2 How to download a DFU f
Download Pdf Manuals
Related Search