USBwiz™ User Manual Revision 2.07
Contents
1. Value Description 0x00 No Error 0x01 ERROR_READ_ SECTOR 0x02 ERROR_WRITE_ SECTOR 0x03 ERROR_ERASE_ SECTOR 0x11 ERROR_MBR_SIGNATURE_MISSMATCH 0x12 ERROR_BS_SIGNATURE_MISSMATCH 0x13 ERROR_SECTOR_SIZE NOT 512 0x14 ERROR_FSINFO_ SIGNATURE _MISSMATCH 0x21 ERROR_CLUSTER_OVER_RANGE 0x22 ERROR_CLUSTER_UNDER_RANGE 0x23 ERROR_NEXT_CLUSTER_VALUE_OVER_RANGE 0x24 ERROR_NEXT_CLUSTER_VALUE_UNDER_RANGE 0x25 ERROR_NO_FREE_CLUSTERS 0x31 ERROR_FILE_ NAME FORBIDDEN CHAR 0x32 DIR OVER 8 0x33 NAME DIR EXTENSION OVER 0x34 ERROR_FILE _ FIRST 7 0x35 ERROR_MEDIA_ FULL 0x40 FOUND 0x41 FOUND 0x42 ERROR_FOLDER_IS CORRUPTED _ FIRST CLUSTER 0x43 ERROR _FOLDER_IS_ CORRUPTED _DIR_DOT NOT FOUND 0x44 ERROR_FOLDER_IS CORRUPTED DIR _DOTDOT FOUND 0x45 15 FULL 0 46 ERROR_OPEN FOLDER FILE 0x47 ERROR_WRTIE_TO READ MODE FILE 0x48 ERROR_SEEK_REQUIER_ READ MODE 0x49 ERROR_INVALID SEEK POINTER 4 ERROR_FOLDER 0x4B 15 FOLDER 0x4C ERROR_READ_MODE_REQUIRED 0x4D ERROR_END_OF_DIR_LIST 0x4E ERROR PARAMETERS Ox4F HANDLE 0 50 ERROR_EOF 0x51 ERROR_NEW_SIZE_ ZERO 0x60 ERROR FOUND 0x612. Value Description 0x00 No Error 0x11 ERROR_MBR_SIGNATURE_MISSMATCH 0x12 ERROR_BS_SIGNATURE_MISSMATCH 0x13 ERROR_SECTOR_SIZE_ 512 0 14 ERROR_FSINFO_SIGNATURE_MISSMATCH 0x21 ERROR_CLUSTER_OVER_RANGE 0x22 ERROR_CLUSTER_UNDER_RANGE 0x23 ERROR_NEXT_CLUSTER_VALUE_OVER_RANGE 0x24 ERROR_NEXT CLUSTER_VALUE_UNDER_RANGE 0x25 ERROR_NO FREE_CLUSTERS 0x31 ERROR_FILE_ NAME_FORBIDDEN_ CHAR 0x32 ERROR_FILE_NAME_DIR_NAME OVER 8 0x33 ERROR_FILE_NAME_DIR_EXTENSION 0 34 7 0 35 ERROR_MEDIA_FULL 0x40 FOUND 0x41 FOUND 0x42 ERROR_FOLDER_IS_CORRUPTED_FIRST_CLUSTER 0x43 ERROR_FOLDER_IS_CORRUPTED_DIR_DOT_ FOUND 0x44 ERROR_FOLDER_IS_CORRUPTED_DIR_DOTDOT FOUND 0x45 ERROR_ROOT_DIRECTORY_IS_ FULL 0x46 ERROR_OPEN_ FOLDER_FILE 0x47 ERROR_WRTIE_TO READ 0x48 ERROR_SEEK REQUIER_ READ MODE 0x49 ERROR_INVALID SEEK POINTER Ox4A ERROR_FOLDER_NOT_EMPTY 0 4 15 FOLDER MODE_REQUIRED 0x4D ERROR_END_OF_DIR_LIST Ox4E ERROR_FILE_PARAMETERS Ox4F HANDLE 0 50 ERROR_MMC_INIT_TIMEOUT 0x51 ERROR_SD_UNEXPECTED_VALUE 0x51 ERROR_SET_BLOCK_SIZE_ 0x52 ERROR_MMC_SEND_COMMAND_ 0x60 ERROR_HCD_CHIP_NOT FOUND 0x61 ERROR_HCD_PTD_COMP_CRC 0x62 ERROR_HCD_PTD_COMP_BIT_S
3. 12 5 1 GENERAL DESCRIPTION Ea a ae eee to 12 5 2 USING THE BOOT LOADER 12 5 3 BooT LADER COMMA D S 12 5 4 BOOT LOADER ERROR CODES hoes 13 COMMANDING WITH 0 2 4004 4 14 6 1 SELECTING AN INTERFACE 14 6 2 tare tata A ek cect cae ad a Sat ak bea 14 6 3 hs E 15 6 4 26 INTERFACE MODE ws beset aaah 16 8 2 2 17 7 1 FAT STORAGE MEDIA 5 58 17 7 1 1 Directories Toldos 18 7 1 2 FIGS pied ane as AE Ea 18 7 2 WSB MASS STORAGE 18 7 3 USB HUMAN INTERFACE DEVICE 19 7 4 USB PRINTERS eerie Batic ates teat eee dia te a ee eevee 20 7 5 USB COMMUNICATION DEVICE
4. 43 8 53 43 8 54 5 5 44 8 55 OR OPENIUSB PIPE 44 8 565 45 8 577 5 esate 45 8 58 WRIWRITEUSBiPIPE 45 APPENDIX FIRMWARE ERROR CODES 46 APPENDIX BOOT LOADER ERROR 49 02 51 GHI Electronics LLC 3 of 51 User Manual USBwiz USB Devices Made Accessible 1 USB Bus 1 1 Introduction Universal Standard Bus USB dominates when it comes to peripheral s interfaces From a mice and keyboards to printers and external hard drives most utilize USB interface As any other protocol USB has its positives and negatives On the positive side USB is designed for hot swappable devic
5. E E 38 841 0 38 842 RATE 39 8 43 5 39 844 39 9 45 AEA 40 8 46 cate weston 40 847 secant deol anes E team 40 8 48 DISPLAY USB DESCRIPTOR BUFFER 00 41 849 SC renee 42 8 50 42 8 51 SUESETUSBANTERFAGCE tec 42 8 52 ENDPOINT
6. weet 33 827 A dite alee area 34 8 28 ND RENAME FILE OR 804000 34 8 29 USB 000000000 0 0 60 34 8 30 UR RELEASE USB DEVICE 47 22000000 00000000 35 8 31 UM REGISTER USB MASS STORAGE 0000 35 8 32 UH REGISTER USB HUMAN INTERFACE 35 8 33 RAI READ AID REPORT de ein dhe OA eee 36 8 34 2 36 8 35 USBiPRINTER ee a hee 36 8 36 PS USB PRINTER 5 5 88 37 8 37 SEND DATA TO USB PRINTER TO 00 0000 37 8 38 UA REGISTER COMMUNICATION DEVICE 0 37 8 39 38 8 40
7. ea ee ede tral rent teeta ede bette cere deeded 28 813 CD CHANGE DIRECTORY a aa 29 814 4 29 8 15 OF OPEN A FILE FOR READ WRITE OR 29 8 16 toes sae sence dane 30 8 17 5 sive odes 30 8418 EE coeds 30 8 19 31 8 20 SW SHADOW WRITE TO MULTIPLE 6 0000 31 8 21 RW READ FROM FILE WRITE OTHER 32 B22 A sah doves eed 32 8 23 APE SEEK FILE vic 33 8 24 CURRENT FILE POINTER 00000 00 33 825 ZF RESIZE PU Bis 33 8 26 dave add
8. 20 7 6 FUDI DEVICE wad aan neh nial ake i ei aa 21 7 7 802 11 dees Hd ead 22 7 8 RAW USB ACCESS lo ee dees ddd ede 22 2555 2 nee dee ee bh 25 8 1 VR GET VERSIONINUMBER 5 25 8 2 ees 25 8 3 ATTACH STORAGE DEVICE STORAGE 26 8 4 RS READ SECTOR ear amet 26 8 5 WS WRITE SECTOR 26 8 6 MU MOUNT FILE SYSTEM MEDIA 27 8 7 SS SWITCH BETWEEN FILE SYSTEM MEDIAS 2 1242 00 000000000000000900 27 8 8 6525 oe eis baa atl 28 8 9 QE QUICK FORMAT MEDIAS ss certs 28 8 10 IL INITIALIZE LIST FILES AND 28 8 11 5 NEXT DIRECTORY ENTRY a aA 28 GHI Electronics LLC 2 of 51 User Manual USBwiz USB Devices Made Accessible 812
9. 1 FI 03010200 USB Class is 03 HID 100 USB Subclass is 01 Bootable device USB Protocol is 02 Mouse Outputs the 1st found interface descriptor 100 that matches these criteria Example2 FI 0301 0201 USB Class is 03 HID 100 Outputs the 2 found interface descriptor that matches these criteria No matter Subclass or Protocol is 100 Related Commands UI UR SI and LD 8 51 51 Set USB Interface This command is used after Fl command to set the found interface GHI Electronics LLC 42 of 51 User Manual USBwiz USB Devices Made Accessible Format Sl Example SI Related Commands UI UR FI and LD 8 52 FE Find USB Endpoint This command finds Endpoint of the PERVIOUSLY FOUND INTERFACE in the PERVIOUSLY LOADED configuration in the internal buffer The return is the found interface s descriptor s size which is always fixed to 07 bytes followed with the found interface descriptor Data ASCll translated format and the bytes are separated by space characters Format FE tt dd itis USB Endpoint Type 100 00 Control 5 01 Isochronous 02 03 Interrupt 90 dd is USB Endpoint Direction 00 Setup 01 Output 02 Input Data Size is HEX Byte Example FE 03 01 USB Endpoint type is Interrupt 100 USB Endpoint direction is Input 100 Related Commands UI UR FI FE OP CP and LD 8 53 FD Find Descriptor This command finds Descriptor in Configuration Internal Buffer contents according to Descriptor
10. 1 5 Mbps which include keyboards mice joysticks and other devices that does not require high transfer data rate Full Speed devices with speed of 12 Mbps For example Flash disks Communication devices and others This is the highest speed supported by USB1 1 High Speed devices with speed of 480 Mbps which is defined in USB 2 0 Specification only High Speed is more suitable for Disks Communication devices and video devices High Speed devices are required to be backward compatible with USB1 1 therefore supporting Full Speed Since USBwiz drives USB 1 1 Host Controller so it supports Low Speed and Full Speed only and capable of running High Speed devices in Full Speed compatibility mode 1 3 3 Transfer Types There are 4 types of data transfer which are classified in a way to suit the most common cases of communication between the host and the clients a Control Transfers They are used to get information from or send commands to USB devices Control Transfers are sent to Endpoint 0 Some Requests are Standard and required by every USB device Requests can be Device Request USB class specific requests or Vendor specific requests Bulk Transfers Large data blocks are transferred using Bulk Transfers There is no guarantee on when the data will be transferred but data integrity is guaranteed through CRC calculations It can be used for sending data to printer or thumb Flash devices Interrupt Transfers Basically
11. 44 D13 Data line 13 Used for USB host chip 45 D7 Data line 7 Used for USB host chip 46 UH_IRQ IRQ Used for USB host chip 47 Clock for SPI bus 48 012 Data line 12 Used for USB host chip 49 VBAT Optional 3V battery to run the RTC 50 VSS Ground 51 V3 3 3V power 52 TMS Leave unconnected 53 SPI_MISO In SPI mode this pin is data output from USBwiz on SPI bus UART_RTS In UART mode this pin is Ready To Send Signal 54 SPI_MOSI In SPI mode this pin is data input to USBwiz on SPI bus UART_CTS In UART mode this pin is Clear To Send Signal 55 SPI_SSEL Select line for USBwiz in SPI mode 56 TCK Leave unconnected 57 USBwiz_RESET Reset signal for USBwiz USBwiz reset is required after power up 58 UH_CS Chip Select Used for USB host chip must have a pull up resistor on this pin or UH_RD 59 VSSA Analog Ground 60 TDI Leave unconnected 61 XTAL2 Connect to 14 7456Mhz crystal 62 XTAL1 Connect to 14 7456Mhz crystal 63 VREF 3 3V reference for analog inputs 64 TDO Leave unconnected GHI Electronics LLC 11 of 51 User Manual USBwiz USB Devices Made Accessible 5 USBwiz Boot Loader 5 1 General Description The boot loader is used to update the firmware of USBwiz The firmware is the code that sits inside the USBwiz chip and does all the work When there is a new firmware release you can simply download the file from our website and using simple commands you can load it on USBwiz
12. 0x83 ERROR 5 WORNG LUN NUMBER 0x84 ERROR 5 WORNG_CSW_ SIGNATURE 0x85 ERROR 5 WORNG MISSMATCHED 0x90 ERROR USB MASS STORAGE DEVICE NOT READY 0x91 ERROR USB 555 PROTOCOL NOT SUPPORTED 0x92 ERROR USB MASSSTORAGE SUBCLASS NOT SUPPORTED 0x93 ERROR SPC_INVALID_ SENSE 0x94 ERROR 5 0x95 ERROR 058 555 FOUND 1 ERROR COMMANDER 2 ERROR COMMANDER STR LEN LONG ERROR COMMANDER VALID 4 ERROR COMMANDER 5 ERROR COMMANDER WRITE PARTIAL FAILURE OxA6 ERROR COMMANDER UNKNOWN OxA7 ERROR COMMANDER FAILED OPEN MEDIA 8 ERROR COMMANDER_INCORRECT CMD PARAMETER 9 ERROR 058 COMMANDER CONFIG LOADED GHI Electronics LLC 47 of 51 User Manual USBwiz USB Devices Made Accessible ERROR_CHECK_SUM ERROR_FILE_ SYSTEM MOUNTED 0 1 ERROR_FTDI_DEVICE_ 5 0 2 ERROR_INCORRECT_VENDORID OxB3 ERROR_INCORRECT_ PRODUCTID 0 4 REGISTERED 5 5 DATA OxFD ERROR_COMMANDER_UNKNOWN_ERROR GHI Electronics LLC 48 of 51 User Manual USBwiz USB Devices Made Accessible Appendix B Boot Loader Error Codes
13. Changes the current folder access Folder must exist Format foldername Foldername follows the short name formation Example MYFOLDER The current root is in MYFOLDER 8 14 RD Remove Directory This command removes Directory The directory must be empty from any files or subdirectories Format RD foldername follows the short name formation Example RD MYFOLDER Remove the folder with name MYFOLDER 8 15 Open a file for read write or append To open a file for read write or append in the current Folder use OF command The commands require a file handle and the access mode Open Modes are R Open for read requires the file to already exist the current media and the current accessed folder VV Open for read will create a new file and give write privilege to it If the file already exists it will be erased first then will open a new one for write A Open for append is similar to write with one exception If the file already existed it will be opened and the incoming data will be appended at the end Important Note The file name must be in standard short name 8 3 formation Note USBwiz currently has 4 available file handles Format OF nM gt foldername Open file fo dername to file handle n with access mode which can be R W or A Example OF 1R gt VOLTAGE LOG Open file VOLTAGE LOG to file handle 1 with READ access mode OF OW gt CURRENT LOG Open fi
14. DBA 100 100 DBA 100 100 DB H 100 100 DB H 100 100 Related Commands LD GHI Electronics LLC Display Data Translated into ASCII Data Size is HEX WORD Display Data as they are in the buffer Data Size is HEX WORD Load the first configuration descriptor 41 of 51 User Manual USBwiz USB Devices Made Accessible 8 49 SC Set USB Configuration Format 5 gt 0 his USB device handle of an enumerated device n is Configuration number The first configuration number is 1 0 is No Configuration set Example SC 0 gt 1 Set the first Configuration for device of handle 0 Related Commands UI UR LD and DB 8 50 Find USB Interface This command finds interface in the PERVIOUSLY LOADED configuration in the internal buffer with specific description Since several interface descriptors might match the criteria descriptor type parameter Index specifies how many matching descriptors shall be skipped The return is the found interface s descriptor s size which is always fixed to 09 bytes followed with the found interface descriptor Data ASCll translated format and the bytes are separated by space characters Format FI cc ss pp ii cc is USB Class use FF if class is not 100 determined ss is USB Subclass use FF if class is not determined 100 pp is USB Protocol use FF if class is not determined is zero based index of the interface to return Data Size is HEX Byte
15. 16 Day 1 31 15 11 Hour 0 23 10 5 0 59 4 0 2 Seconds divided by 2 0 30 8 28 ND Rename File or Folder Format ND filename newname filename follows the short name formation newname follows the short name formation Example ND TEST TXT CURRENT LOG Rename the with the name TEST TXT with name CURRENT LOG 8 29 01 Enumerate USB Device It is a major command in USBwiz since it is a USB Driver function that Enumerates newly connected USB Device and conjunct it with a logical USB Device Handle So it is the first step command to deal with any USB commands Currently USBwiz supports three USB device handles Format Ul p gt h Example 10 gt 1 GHI Electronics LLC p is USB port order h is USB device handle Enumerates the USB device connected to port O and conjunct it to device handle 1 34 of 51 User Manual USBwiz USB Devices Made Accessible Related Commands All USB commands like for instance UR UM UH UA UP etc 8 30 UR Release USB Device Handle It Releases USB Device Handle so it can be dedicated by enumeration to new device IT importance comes when re enumeration of one connected device or changing the connected device is needed Format UR h h is USB device handle Example UR 1 Release USB device handle 1 8 31 UM Register USB Mass Storage Device USBwiz has an internal USB Mass Storage Driver that can control two Mass Storage Devices at t
16. AM and MU GHI Electronics LLC 27 of 51 User Manual USBwiz USB Devices Made Accessible 8 8 MS Get Media Statistics Format MS HEX DWORD Media Size 100 HEX DWORD Free Size 100 8 9 Quick Format Media This command resets File Allocation Only No change occurs to Boot Sector or MBR Format QF CONFIRM FORMAT Note the function will not be executed till the right confirming string follows the command 8 10 IL Initialize List Files and Folders It sets List Files and Folders Function pointer to the first Directory entry in the current root Format IL Example IL Related Command NF 8 11 NF Get Next Directory Entry This command will print out the Directory Entry File or Folder and increments List Files and Folders pointer Format NF File Name 100 File Extension HEX Byte File Attributes 100 ssss HEX DWORD File Size Example NF Passing NF command two times and 100 get the 100 NF 100 100 Related Command IL File Attributes are one byte Standard Attribute Structure in FAT system 7 6 5 4 3 2 2 0 Reserved Archive Folder Volume ID System Hidden Read Only 8 12 MD Make Directory Creates a folder GHI Electronics LLC 28 of 51 User Manual USBwiz USB Devices Made Accessible Format MD foldername foldername follows the short name formation Example MD MYFOLDER Create a folder with name MYFOLDER 8 13 CD Change Directory
17. Data Logger Picture viewer USB thumb drive MP3 player Digital camera Automated machine Keyboard mouse joystick interface RS232 to USB printer server Automated SMS Sending A Electronics LLC 9 of 51 User Manual USBwiz USB Devices Made Accessible 4 Pin Out and Description Pin Name Description 1 UH_RD Read strobe Used for USB host chip must have a pull up resistor on this pin or UH_CS 2 UH_WR Write strobe Used for USB host chip 3 RTXC1 32KHz crystal for RTC 4 011 Data line 11 Used for USB host chip 5 2 32KHz crystal for RTC 6 VSS Connect to ground 7 V3A Analog supply source 3 3V 8 D10 Data line 10 Used for USB host chip 9 MISC For future expansion Can be Analog in or out 10 UH_RESET Reset pin Used for USB host chip 11 AO AO Used for USB host chip 12 D9 Data line 9 Used for USB host chip 13 MISC1 Currently not used 14 5 2 Currently not used 15 SD_DET Detects if SD card Edge sensitive signal 16 D8 Data line 8 Used for USB host chip 17 SD_CS Chip select line for MMC or SD card 18 VSS Connect to ground 19 UART_TX In UART mode this is the transmit pin SPI and 2 modes this indicates that USBwiz has data ready SPI or 2 buffer and master must read it I2C_DATARDY USBwiz will ignore any incoming command when th
18. Interrupt Transfers are small Bulk transfers that guarantee timing It is the responsibility of the software to constantly read Interrupt Pipes periodically Interrupt pipes are used in mice keyboards for example isochronous Transfers When data integrity is not important but speed must be guaranteed Isochronous Transfers are used For example USB sound cards don t GHI Electronics LLC 5 of 51 User Manual USBwiz USB Devices Made Accessible care if a value was received incorrectly as in most case the user wouldn t notice it But it is very important that the sound card receives the data continuously USBwiz supports Control Bulk and Interrupt Transfers GHI Electronics LLC 6 of 51 User Manual USBwiz USB Devices Made Accessible 2 From USBwiz V1 to USBwiz V2 This section is related only to users who have experience with USBwiz version 1 USBwiz V1 was a great success for over a year Knowing exact customer needs helped us define the new version of the firmware The new firmware will load on any USBwiz chip without anything special There is no need to make any change on your current circuit board designs but you may want to add the new pins if needed for example the SD card detect pin For firmware version 2 xx we provide a full C library that does all the work for you Note that updating the firmware will not update the boot loader There will be a separate document explaining how to update the boot
19. Select SCK is the Serial Clock 7Mhz running and 1 75Mhz for boot loader MISO is the data line going from USBwiz to your microcontroller and MOSI is the data line going from your microcontroller to USBwiz The other two pins are used for handshaking they are DATARDY and BUSY DATARDY pin goes high when there is data in the USBwiz s SPI buffer When BUSY is high a user must not send any new data to USBwiz The boot loader in SPI is half duplex When DATARDY pin is high USBwiz will not accept any commands and will assume the SPI transaction is for reading the data therefore the incoming data will be discarded The other handshaking pin is BUSY Before sending any command to USBwiz this pin must be checked and data can be sent only when BUSY pin is low On the other hand the firmware runs SPI in full duplex mode When SPI is full duplex USBwiz will accept any incoming data while it is sending simultaneously If USBwiz has no data to send back it will send NDT No Data Token The NDT is Oxff and is completely ignored by USBwiz and should be ignored by your system as well When reading data from USBwiz but there is nothing to send use NDT In some rare cases there could be a need to send OxFF writing the hex value OxFF not ASCII This is resolved by using HDT Half Data Token HDT is the value OxFE Whenever USBwiz or your system sees HDT it must wait for one more byte to decide what that value actually is HDT followed by a
20. USB device handle 1 Related Commands UI UR BQ DQ FQ RQ and WQ 8 42 BQ Set FTDI Baud Rate Format UQ bbbb bbbb is Baud rate value Example UQ 4138 Set Baud Rate to 9600 clock is 48Mhz Some calculated baud rate values when Xtal is 48Mhz referenced from FTDI Specifications Baud Rate Value Actual Baud Rate 04E2 2400 0271 4800 4138 9600 809C 19200 4 38400 0034 57600 001A 115200 000D 230400 Related Commands UQ DQ FQ RQ and WQ 8 43 DQ Set FTDI Data Format Format DQbps b is bits number typically 8 p is parity 0 no parity 1 Odd 2 Even 3 Mark 4 Space s is stop bit count 01 11 5 23 Example DQ 800 Number of bits is 8 No parity bit one Stop bit Related Commands BQ UQ FQ RQ and WQ 8 44 FQ Set FTDI Handshaking Mode Format1 FQN No handshaking FQR Hardware Handshaking using DTR DSR lines FQS Hardware Handshaking using CTS RTS lines Format2 FQ X NF Xon Xoff Handshaking where N is Xon character and F is Xoff character GHI Electronics LLC 39 of 51 User Manual USBwiz USB Devices Made Accessible Related Commands BQ DQ UQ RQ and WQ 8 45 RQ Read FTDI Output buffer This command reads out the internal OUT buffer of the FTDI device Format RQ Read FTDI OUT Buffer 100 Data Size is HEX Byte 100 Example 100 5 100 Note Sometimes multiple RQ commands must be passed to flush out all the data in the buffer like when you fir
21. loader GHI Electronics LLC 7 of 51 User Manual USBwiz USB Devices Made Accessible 3 What is USBwiz 3 1 Introduction USBwiz is a single chip that performs all work needed for USB hosting and FAT file system USBwiz connects to a USB host ISP1160 one side and to your product on the other side PIC AVR etc Using simple commands over 2 SPI or UART serial you can talk to almost any USB device on the market If the device falls under a supported USB class no USB knowledge is necessary USBwiz does the work This includes many of the shelf devices such as mouse keyboard joystick USB memory printers modems cell phones Wi Fi 802 11 and many USBwiz includes FAT file system Microsoft s FAT file system allows your product to create files on a media card SD or MMC or on a USB storage device thumb drive or external hard drive Finally there is away for your product to read files from USB thumb drives 3 2 Supported USB Client Classes The USB organization defines many classes for different USB devices This means all USB devices of a certain type keyboards for example should run the same way This is the reason why you do not need to install drivers when connecting a mouse to your PC Your operating system includes the USB class drivers USBwiz comes with many USB class drivers If a class is not supported by USBwiz you can still use it by accessing the raw USB commands USB supported D
22. the data it promised to return it will send a filler symbol instead It is up to the user to decide what the filler is going to be Format RF nM gt ssssssss n File Handle 100 M Filler Character 55555555 HEX DWORD desirable data size to be read HEX DWORD actual read data from file size 100 Example We have file with 8 bytes ABCDEFGH in it and it is opened for read with handle number 2 RF 22 gt 5 Read 5 bytes from a file 2 with filler Z 100 USBwiz accepted the command This is the data coming from the file All 5 bytes are valid 100 No errors has occurred RF 24 gt 5 Read more data We will request 5 but only 3 are left GHI Electronics LLC 30 of 51 User Manual USBwiz USB Devices Made Accessible 100 errors has occurred az USBwiz returned the last bytes but added 2 fillers USBwiz indicating it was able to read gt bytes only 100 USBwiz no error indication Related Commands OF CF PF and FP 8 19 WF Write to File After a file is opened for write you can use WF to write to that file handle After WF command USBwiz will respond with error code If the error code is 00 then writing data to the file is ready Now everything goes into the interface goes directly to the file with no interpretation what so ever After sending all requested data USBwiz will return the actual write count In some instances USBwiz could fail writing all the data and it will inform the user of the data loss Finally WF ret
23. At power up USBwiz will send B and L indicating that the boot loader is ready to load new file To exit the boot loader and start USBwiz firmware send R character If USBwiz detects invalid firmware it returns BL again In such case reprogramming USBwiz is required 5 2 Using the Boot Loader The easiest way to update USBwiz is by placing the new firmware on a SD card or a USB mass storage device Then connect the media to USBwiz and send the boot loader a command to load the new firmware The file MUST be placed in the root directory not in any folder We recommend formatting the media first If needed user can update the new firmware by sending it over SPI 2 UART All commands return followed by the error number 00 means no error The boot loader responds with Wxx CR on every sector write where xx is the sector number 5 3 Boot Loader Commands Command Use Notes R Load and run USBwiz If Boot loader return BL then firmware reprogramming USBwiz is required LQUx Load firmware file from The x is the drive letter For example connected media LQUA will load the firmware from MMC SD card and LQUB will load the firmware from the first Logical Unit LUN of the attached USB mass storage device on port 0 or port 1 W Write one sector to internal Follow W by the sector number then 512 FLASH bytes of sector data Transaction must be terminated by a checksum byte Checksum b
24. B MASS STORAGE DEVICE NOT READY 0x91 ERROR USB PROTOCOL SUPPORTED 0x92 ERROR USB MASSSTORAGE SUBCLASS SUPPORTED 0x93 ERROR SPC_INVALID_ SENSE 0x94 ERROR 5 0x95 ERROR 058 FOUND OxD1 ERROR FLASH BLANK OxD2 ERROR_VERIFY 0xD3 ERROR_INTERNAL OxD4 ERROR CHECKSUM 0 07 ERROR_INVALID_ OxD8 ERROR OxDA FILE IS EMPTY ERROR 0xDB FILE FOUND OxDE ERROR UNKNOWN COMMAND GHI Electronics LLC 50 of 51 User Manual USBwiz USB Devices Made Accessible Appendix C Licensing Each uALFAT chip comes with unconditional license of use from GHI Electronics LLC There are many patented technologies utilized in that must be account for e SD card is used in MMC compatibility mode therefore no license is required from the SD organization e FAT file system is a patent of Microsoft Corporation Licensing fee for using FAT file system must be paid by companies who wish to use FAT file system in their products For more information visit Microsoft s website http www microsoft com mscorp ip tech fat asp GHI Electronics LLC provides a technology that allows users to read and write raw sectors and read and write FAT files If FAT functions are used by USBwiz users then they must contact Microsoft for licensing GHI Electronics LLC should NOT be liable for any unpaid lice
25. ERROR_HCD_PTD_COMP_CRC 0x62 ERROR_HCD_PTD_COMP_BIT_STUFFING 0x63 ERROR_HCD_ PTD TOGGLE GHI Electronics LLC 46 of 51 User Manual USBwiz USB Devices Made Accessible 0x64 ERROR PTD STALL 0x65 ERROR HCD PTD COMP RESPOND 0x66 ERROR PTD COMP PID CHECK FAIL 0x67 ERROR HCD UNEXPECTED PID 0x68 ERROR HCD PTD COMP OVERRUN 0x69 ERROR PTD COMP UNDERRUN Ox6A ERROR HCD PTD COMP RESERVED1 0x6B ERROR HCD COMP RESERVED2 0x6C ERROR HCD PTD COMP BUFFER OVERRUN Ox6D Ox6E ERROR HCD 10 Ox6F ERROR HCD 058 CONNECTED 0x70 ERROR PORT NMBER AVILABLE 0x71 ERROR 0580 NO ENOUGH PIPES 0x72 ERROR 0580 HANDLE _INUSE 0x73 ERROR 0580 INCORRECT DESCRIPTOR 0x74 ERROR 0580 FUNCTION 0x75 ERROR USBD DATA SIZE 15 0x76 ERROR USBD_ TIMEOUT 0x77 ERROR 0580 CONTROL TRANSFER REQUIERED 0x78 ERROR 0580 0x79 ERROR 0580 HANDLE CORRUPTED Ox7A ERROR 0580 DESCRIPTOR CORRUPTED 0x7B ERROR DESCRIPTOR FOUND Ox7C ERROR 058 FOUND 0x81 ERROR 5 CSW_COMMAND FAILD 0x82 ERROR BOMS CSW_STATUS PHASE ERROR
26. If the file doesn t exist then a new file will be made With USBwiz you can open up to 4 files at the same time using file handles Handles are used for fast access to a file If a user needs to log data to 2 files at the same time VOLTAGE LOG and CURRENT LOG file handles become very useful To do so open VOLTAGE LOG under handle 1 and CURRENT LOG under handle 2 Now start sending your data to handle 1 and 2 instead to the file name 7 2 USB Mass Storage USBwiz has an internal USB Mass Storage Driver that can control two Mass Storage Devices at the same time UM Command is responsible for the manual Registering of USB Devices as Mass Storage Devices after enumerating it by UI command Then comes the role of AM to attached Storage IO Driver then the MU command to Mount the file system on then it is ready to open close manipulate data on To access USB mass storage Device some initialization commands must be performed before which will be clarified in the following example Let s Say that a Four LUN Card Reader is connected to USB port 0 to access card connected to this Reader at the 1st LUN i e logic drive the following procedures must be performed First this USB Card Reader must be enumerated like any other USB device We will initialize it to USB device handle 0 UI 0 gt 0 Second Mass Storage Driver must be initialized to take care of this card reader using UM command Here we assign this device to M
27. Printer Example PR Related Commands UP PS and PP GHI Electronics LLC 36 of 51 User Manual USBwiz USB Devices Made Accessible 8 36 PS Get USB Printer Status Format PS h is USB device handle of an enumerated device 100 p is a free USB Pipe Handle 100 5 Register USB device of USB device handle 0 as HID and use 100 Pipe Handle 3 r Printer status indicates Not paper in the feeder Note Some USB printers may not always able to determine Status Bits s Field Description 7 6 Reserved Reserved 5 Paper Empty 1 Paper Empty 0 Paper Not Empty 4 Select 1 Selected 0 Not Selected 3 Not Error 1 No Error 1 Error 2 1 0 Reserved Reserved Related Commands PR UP and PP 8 37 PP Send Data to USB Printer to print PP ss ss is Byte data to be sent to printer size Format Example Related Commands PR PS and UP 100 Data to Print 100 PP D 100 Hello Word 100 8 38 UA Register Communication Device USBwiz has an internal CDC Driver UA Command is responsible for the manual Registering of USB Devices as CDC after enumerating it by Ul command Then the roles of RA and WA commands come to send and receive data with the device Currently USBwiz CDC driver support those that has Interface that has Abstract Control Model Subclass and accepts pure ASCII similarly to hyper terminal program Port So User can Send AT Command and receive respo
28. TUFFING 0x63 ERROR_HCD_PTD_COMP_DATA_TOGGLE 0x64 ERROR_HCD_PTD_COMP_STALL 0x65 ERROR_HCD_PTD_COMP_DEVICE_NO_RESPOND GHI Electronics LLC 49 of 51 User Manual USBwiz USB Devices Made Accessible 0x66 ERROR PTD COMP FAIL 0x67 ERROR HCD PTD PID 0x68 ERROR HCD PTD COMP OVERRUN 0x69 ERROR HCD PTD COMP Ox6A ERROR HCD PTD COMP RESERVED1 0x6B ERROR HCD COMP RESERVED2 0x6C ERROR HCD PTD COMP BUFFER OVERRUN Ox6D ERROR HCD PTD COMP BUFFER UNDERRUN Ox6E ERROR HCD_INALID_CHIP_ID Ox6F ERROR HCD USB DEVICE NOT CONNECTED 0x70 ERROR PORT NMBER AVILABLE 0x71 ERROR 0580 ENOUGH PIPES 0x72 ERROR 0580 HANDLE INUSE 0x73 ERROR USBD_INCORRECT DESCRIPTOR 0x74 ERROR USBD_NONCONTROL_TRANSFER_FUNCTION 0x75 ERROR USBD DATA SIZE_IS BIG FOR ENDPOINT 0x76 ERROR 0980 TIMEOUT 0x77 ERROR 0580 TRANSFER REQUIERED 0x78 ERROR 0580 0x79 ERROR 0580 HANDLE CORRUPTED 0x7A ERROR 0580 DESCRIPTOR CORRUPTED 0x7B ERROR DESCRIPTOR FOUND Ox7C ERROR 058 FOUND 0x81 ERROR 5 CSW_COMMAND FAILD 0x82 ERROR BOMS CSW _ STATUS PHASE ERROR 0x83 ERROR 5 WORNG LUN NUMBER 0x84 ERROR BOMS WORNG CSW_SIGNATURE 0x85 ERROR 5 WORNG MISSMATCHED 0x90 ERROR US
29. Type field Since several interface descriptors might match the criteria descriptor type parameter Index specifies how many matching descriptors shall be skipped Format FD ff ii itis USB Endpoint Type se Ii is zero based index of the interface to i return 100 Data Size is HEX Byte lt Example FD 2100 Find the 1 HID Type 0x21 Descriptor 100 the contents of the loaded Configuration 0 Buffer GHI Electronics LLC 43 of 51 User Manual USBwiz USB Devices Made Accessible 100 Related Commands UI UR and LD 8 54 SR Send USB Request USB Setup Request is a Control Transfer to Device s Default Endpoint 0 so this transfer is an order for the device which include sending data to device through this endpoint or receiving data from it or in most cases at does not include sending or receiving data but only and order for the device like setting some parameters SR is dedicated to send such USB Requests It automatically figures out weather the request include sending data from user to device or from device to user or no data transfers from bmRequestT ype Field So in the first case USBwiz will send 00 waiting for user to send wLength bytes followed by the error code In the second case USBwiz will send 00 followed bye wLenght bytes then error code In the third case USBwiz will send only 00 or the error code If any error occurred during the previous stages USBwiz will send with error code and does
30. USBwiz User Manual Revision 2 07 GHI Electronics LLC Preliminary and Incomplete document Updated May 24 2006 USBwiz USB Devices Made Accessible Table of Contents 1 4 5 6 USB 4 1 1 5 4 1 2 USB ONE HOST AND MULTIPLE DEVICES 1 20242 2 0000000000 000000000000 0 0000 4 1 3 IN SHORT WHAT IS USB Z cele aed 4 1 3 1 a ieee ee ee ee eee 4 1 3 2 5 ieee Ah eee one ee 5 1 3 3 Transfer 5 FROM USBWIZ V1 USBWIZ 2 48 8 0000 7 WHAT IS USBWIZ 2 8 3 1 INTRODUCTION 5522 a S aan 8 3 2 SUPPORTED USB CLIENT CLASSES 8 3 3 KEY FEATURES S 8 3 4 SOME EXAMPLE APPLICATIONS oj 255 9 5 10 USBWIZ BOOT LOADER
31. X DWORD actual written data to the second part file Example Suppose that the source file is represented by file handle 1 with size 32 Bytes And we want to split it at the position 16 and save the parts into files represented in file handles 0 and 2 which are opened in write mode GHI Electronics LLC 32 of 51 User Manual USBwiz USB Devices Made Accessible SF 1 gt 0 2 10 Split file 1 at position 16 into two files 0 and 2 100 USBwiz accepted the command USBwiz was able to write 16 bytes to the first part 100 errors has occurred USBwiz was able to write 16 bytes to the first part 100 errors has occurred Related Commands OF 8 23 PF Seek File This command changes the file pointer position File must be opened in Read Mode Format n gt ssssssss File Handle ssssssss HEX DWORD new position Example PF 1210 Set file pointer at position the 16 byte in file supposing that its size is less than 16 bytes Related Commands OF and RF 8 24 FP Get Current File Pointer Position This command gets the current sector address and the position in that sector of file pointer File must be opened in Read Mode Format FP n n File Handle 100 555 HEX DWORD Sector address s HEX WROD position in Sector 100 8 25 ZF Resize File This command sets file size to a certain position less than its size and omits the data after that position File must be opened in Read Mode File handle will be automatical
32. ach SD or MMC Attach USB Mass Storage Device Where m is order of the pre Registered USB Mass Storage Handle 7 is the LUN order which is usually zero for thumb flash drives Attach Thumb Flash that is registered on handle 0 and use the first LUN which order s is zero Related commands MU SS UI and UM 8 4 RS Read Sector Formatt 1 12 2 RS 55555555 100 100 RS 0 RS C gt ssssssss RS Um gt ssssssss 100 100 RS 00 gt 1 8 5 WS Write Sector Formatt WS ssssssss 100 512 Bytes must be sent to USBwiz GHI Electronics LLC Read Sector from the current File System Media 55555555 HEX DWORD sector address Read Sector 0 Read Sector from Specific Attached Media even m is Mass Storage Device Handle ssssssss HEX DWORD sector address Read Sector 1 from attached USB Mass Storage Device Media to Mass Storage Handle 0 Write to Sector from the current File System Media 55555555 HEX DWORD sector address 26 of 51 User Manual USBwiz USB Devices Made Accessible 100 Example1 50 Write to Sector 0 Format2 WS gt 55555555 Write to Sector from Specific Attached Media even mis Mass Storage Device Handle 55555555 HEX DWORD sector address 100 512 Bytes must be sent to USBwiz 100 Example2 WS U0 gt 1 Write to Sector 1 from attached USB Mass Storage Device Media to Mass Storage Handle 0 8 6 MU Mount File S
33. ass Storage Device Handle 0 UM 0 gt 0 00 GHI Electronics LLC 18 of 51 User Manual USBwiz USB Devices Made Accessible 03 00 Where 03 is the last LUN order Now the Card reader is ready to accept Attach command AM and mount the file system MU Suppose that File System 0 is already mounted for MMC AM 00 lt 2 mass storage handle 0 and attach the third LUN 00 MU 1 lt 00 Mount the second File System on the mass storage of mass storage handle 0 00 551 100 MD TEST 00 SS 0 00 CD FOLDER 00 Note the previous initialization processes is required to perform only once after connecting the mass storage device 7 3 USB Human Interface Device This USB class includes vast range of HID devices USBwiz HID driver support those that has only output interrupt Endpoint for HID Report sending To access HID First this HID must be enumerated like any other USB device We will initialize HID which is Attached to USB port 1 to USB device handle 0 as an example UI 1 gt 0 Second HID Driver must be initialized to take care of this HID using the registering command and USB pipe must be chosen to access the Output Endpoint UH 0 gt 3 Then USBwiz will output Data size that is send by the HID which is 4 Bytes for Mice and 8 Bytes for Keyboards Now the USBwiz is ready get Data from HID which can be performed by Read HID Pipe RH 3 Note the previous initialization process is required to perform o
34. class like Nokia or Motorola Cell phones To access Communication Device First Communication Device must be enumerated Supposing that the device is attached to USB port 1 to USB device handle 0 as an example UI 1 gt 0 Second the driver must be initialized to take care of this device using the Register Communication Device Command UA UA 0 Now the USBwiz is ready exchange Data with the device which can be performed by RA and WA commands Example Nokia Cell phone is connected to port 0 UI 0 gt 0 00 GHI Electronics LLC 20 of 51 User Manual USBwiz USB Devices Made Accessible UA 0 00 WA 3 AT 00 RA 00 03 AT 00 RA 00 06 OK 00 7 6 FTDI Device FTDI is a very popular USB to UART chip USBwiz has a driver to drive this chip and set its serial port parameters like Baud rate And user can send data to that serial port by WQ and receive by RQ To FTDI Device First Communication Device must be enumerated Supposing that the device is attached to USB port 1 to USB device handle 0 as an example UI 1 gt 0 Second the driver must be initialized to take care of this device using the Register Communication Device Command 00 000 Now the USBwiz is ready exchange Data with the device which be performed by WQ WQ commands Of course User must set the right parameters for the serial port through the following commands BQ DQ and FQ Example FTDI device with the de
35. e Related Commands OF CF and FF 8 21 RW Read from File Write to other file This command is very powerful and fast If we have two files one is opened for Read and the other for write this command allows copying data from a file to another even if they were opened in different storage media devices Format RW w gt ssssssss 100 100 Read Mode File Handle w Write Mode File Handle ssssssss HEX DWORD desirable data size to be read and written 2 HEX DWORD actual written data from file size Example Suppose that a file is opened for read and represented in handle 0 and another file is opened for write and represented in handle 1 RW 1 0 gt 100 100 100 Read 256 bytes from file 1 and write them into 0 USBwiz accepted the command All bytes are valid No errors has occurred Related Commands OF CF and FF 8 22 SF Split file SF splits a file into 2 new files The files can be opened on different drives or the same drive It requires one file to be open for read and 2 other files to be open for write Files handles will be automatically closed after successful executing of the command Format SF 1 gt m o ssssssss N Source Read Mode File Handle 100 100 100 First part destination Write Mode File Handle o Second part destination Write Mode File Handle ssssssss HEX DWORD desirable split position in the source file HEX DWORD actual written data to the first part file HE
36. e parameters and others don t For example VR command doesn t take any parameters it returns the version number On the other hand MD requires parameter to run MD creates makes a folder on the accessed media device MD LOG creates a folder with the name LOG Also every command must be terminated with Carriage return This is the enter key on your keyboard When programming in it is or OxOD The backspace key is supported in case there is a need to discard the last entry There are many restrictions that must be noticed or USBwiz will not accept the command Commands must be 2 characters Every command must have the exact number of arguments Spaces must be used whenever is required Extra spaces count as errors All numbers are hexadecimal 7 1 FAT Storage Media USBwiz can connect to two kinds of storage media types The media types are SD MMC cards and USB Mass Storage device SCSI command subclass bulk only protocol which includes thumb flash USB hard drives and card readers USBwiz supports 3 simultaneous FAT devices Keep in mind that all devices must be formatted 12 FAT16 or FAT32 USBwiz can mount up to 3 File System Medias that are independent from each other which means that all opened files and operations in one file system has no effect on the others This gives USBwiz very great capability of flexible switching between the file system Medias and providing other valuable functi
37. es This means you can connect or disconnect any device at any time Also you can have up to 12 8 devices connected at the same time to one host On the negative side USB is not easy to add to a product From the complexity of the hardware to the many issues that need to be addressed for the software For more info check out www usb org 1 2 USB One Host and Multiple Devices If you ever noticed all USB devices connect to the PC but they don t connect to each other not counting USB OTG USB protocol runs on a pyramid base The PC is the top of the pyramid and the devices connect to the PC directly or multiple devices can connect to a HUB and the HUB will connect to the PC So on a USB system there is one and only one HOST your PC and one or more device s Adding a USB device to a product can be simple by using one of the USB lt gt UART chips FTDI www ftdichip com offers one of the most popular USB lt gt UART chips This is on the hardware side but what about software and drivers FTDI offers drivers for multiple operating systems as well That is all great but about adding a host When adding a USB device chip to your product your product will be able to connect to a PC Now what if you want to use any USB device with your product To connect a USB printer to your product you need a USB host Before there wasn t any easy or efficient way to add a USB host to a product Most USB hosts run on PCI bus and required a full operating s
38. evices Most Human Interface Devices HID such as mouse keyboard and joystick Printers with plain ASCII support Mass Storage Thumb drives and external USB hard drives Communication Modems and cell phones that contain Abstract Control Mode Subclass Interface like Nokia Cell phones Ralink Tech Wi Fi 802 11 USB devices with Ralink Tech chipset Not a standard class and still under development 3 3 Key Features FAT32 FAT16 and FAT12 support Multi Media Card MMC and Secure Digital SD memory cards USB host stack and raw access to USB devices HID USB class support Printer USB class support Mass storage USB class support Supports ISP1160 Easily used with any microcontroller including PIC AVR Zilog etc Runs with simple robust protocol on UART I2C or SPI A A GHI Electronics LLC 8 of 51 User Manual USBwiz USB Devices Made Accessible UART runs as high as 921 6 K baud 2 up to 400kbps and SPI clock is up to 7 MHz Field upgradeable firmware Firmware can be updated from a file on the connected media Built in RTC Real Time Clock Very few external components are needed Small LQFP 64 package 40 to 50 mA power consumption with capability of power down Single supply 3 3V 5V tolerant I O pins 40 C to 85 C temperature operating range Lead free 3 4 Some Example Applications Digital camera
39. fault PID and VID is connected to port 0 UI 0 gt 0 100 000 100 4138 baud rate 9600 WQ 6 Hello 100 GHI Electronics LLC 21 of 51 User Manual USBwiz USB Devices Made Accessible RA 100 503 100 7 7 USB Ralink Wi Fi 802 11 Not Supported yet We hope to have the driver ready in 4Q 2006 7 8 Raw USB Access Accessing any USB device has been divided into 3 stages 1 Enumeration stage which includes USB addressing 2 Learning Stage and querying about USB device stage which includes also opening the required Pipes sending setup commands on the default control pipe 3 Read or write Pipe stage sending setup commands on the default control pipe too Example on accessing a USB mouse Stage 1 Assign Device handle 0 for device connected on port 0 UI 0 gt 0 Output nothing if no error Stage 2 Load Device descriptor into the internal Buffer LD 0 gt D Output nothing if no error It is optional command since it is just to display internal buffer contents DBA Output Device descriptor size Device descriptor data in the internal buffer Load the first configuration descriptor into the internal buffer LD 0 gt 0 Output nothing if no error It is optional command since it is just to display internal buffer contents GHI Electronics LLC 22 of 51 User Manual USBwiz USB Devices Made Accessible DBA Output configuration descriptor size configuration descriptor data in the in
40. h gt p his USB device handle of an enumerated device 100 p is a free USB Pipe Handle GHI Electronics LLC 35 of 51 User Manual USBwiz USB Devices Made Accessible is HID Report Size 100 Example 0 gt 3 Register USB device of USB device handle 0 as HID use 100 Pipe Handle 3 2 100 Report size is 4 Bytes Related Commands UI UR RH and CP 8 33 RH Read HID Report This command read HID Report s Data Format p is an opened USB Pipe Handle by UH command 100 Report s Data may not be readable since it is not converted to ASCII HEX Bytes but they are returned as they came 100 from the Pipe Example RH Register USB device of USB device handle 0 as HID and 100 use Pipe Handle 3 100 Related Commands UI UR UH and 8 34 UP Register USB Printer USBwiz has an internal Simple Printer Driver UP Command is responsible for the manual Registering of USB Devices as Printer after enumerating it by UI command Then comes the role of PP command to send printing Data Currently USBwiz Printer driver support those that has Interface that has Unidirectional protocol and accepts pure ASCII similarly to Parallel Port Printers About 60 of USB printers out there support the previous requirements Format UP h his USB device handle of an enumerated device Example 1 Register USB device of USB device handle 1 Related Commands UI UR PR PS and PP 8 35 PR Reset USB Printer Format PR Reset USB
41. he same time UM Command is responsible for the manual Registering of USB Devices as Mass Storage Devices after enumerating it by UI command Then comes the role of AM to attached Storage IO Driver then the MU command to Mount the file system on then it is ready to open close manipulate data on USB Mass Storage Device be a Thumb Flash which usually has only one LUN Logical Unit or a card Reader which has more than one LUN one for each Card Type USB Floppy Disk Drives are not Supported Format UM h gt m his USB device handle of an enumerated device m is USB Mass Storage device handle 0 or 1 s Last LUN Order which is usually zero for thumb flashes 100 Example UM 1 gt 0 Register USB device of USB device handle 1 to USB Mass 100 Storage handle 0 The device is 4 LUN Card Reader 100 Related Commands UI UR AM and MU 8 32 UH Register USB Human Interface Device USBwiz has an internal Simple HID Driver that can control as many HID as required only HID like Mice Keyboards and Joysticks UH Command is responsible for the manual Registering of USB Devices as HID after enumerating it by Ul command and opening a certain USB Pipe to be the input channel to get HID Report which is the output targeted data of HID Then the role of RH command comes to read this pipe This command also returns HID Report Size which defines the quantity of Data that will be returned by RH command Format UH
42. is pin is high 20 TRST Leave Unconnected 21 UART_RX In UART mode this is the data receive pin SPI_BUSY In SPI and 2 modes this pin is a flag that indicates that USBwiz is busy and it will not accept any commands I2C_BUSY 22 I2C_SCL The SCL line for 2 bus 23 VCC 3 3V power pin 24 RT CK DBG Leave unconnected 25 VSS Ground power pin 26 I2C_SDA The SDA line for 2 27 MMC SD_SCK Clock signal for MMC and SD memory cards 28 MODEO Together with select the interface mode for USBwiz 29 MMC SD_MISO Data signal from MMC or SD memory cards Pull up resistor is required on this pin GHI Electronics LLC 10 of 51 User Manual USBwiz USB Devices Made Accessible 30 MMC SD_MOSI Data signal to MMC or SD memory cards 31 SD_WP SD write protect detect 32 MODE1 Together with MODEO select the interface mode for USBwiz 33 DO Data line 0 Used for USB host chip 34 D1 Data line 1 Used for USB host chip 35 D2 Data line 2 Used for USB host chip 36 D15 Data line 15 Used for USB host chip 37 D3 Data line 3 Used for USB host chip 38 D4 Data line 4 Used for USB host chip 39 D5 Data line 5 Used for USB host chip 40 D14 Data line 14 Used for USB host chip 41 D6 BL Data line 6 This line MUST be high at USBwiz power up and reset Make sure it has pull up resistor 42 VSS Ground 43 V3 VCC power
43. le CURRENT LOG to file handle 0 with WRITE access mode Related Commands CF FF RF PF FP WF RW SP ZF and SW GHI Electronics LLC 29 of 51 User Manual USBwiz USB Devices Made Accessible 8 16 CF Close File Handle This command closes the opened file and updates file parameters in the file system and confirm that all data in file buffer is written to the media Then it releases the file handle to be available for new file opening It is an important command especially for file functions that add or modify on files to confirm that data is written on the media and file parameters are updated Format Close File handle n Example 0 Close File handle 0 Related Commands OF FF RF WF RW and SW 8 17 FF Flush File Data This command does the same function of CF function except releasing the file handle So it updates file parameters and flushes file buffer data into storage media and keep file handle ready for another write command It is made especially for file functions that add or modify on files to confirm that data is written on the media and file parameters are updated Format FF n Close File handle n Example FFO Close File handle 0 Related Commands OF CF WF RW and SW 8 18 RF Read from File Sending RF with the file handle and the byte count and USBwiz will return your data The file must be opened for read first To read more data from the file send another RF If USBwiz couldn t get all
44. ly closed after successful executing of this command Format ZF gt 55555555 File Handle ssssssss HEX DWORD desirable data size to be written Example ZF 1210 Resize the file to 16 bytes supposing that its original size is less than 16 bytes Related Commands OF 8 26 DF Delete File Format RD filename filename follows the short name formation Example RD TEST 1TXT Remove the file with TEST TXT GHI Electronics LLC 33 of 51 User Manual USBwiz USB Devices Made Accessible 8 27 IF Find File or Folder This command search for a specific file or folder name in the current folder and print out file s major information which includes size attributes and date amp time of modification Format IF filename filename follows the short name formation 100 HEX DWORD File Size AA ddc HEX Byte File Attributes 100 HEX DWORD time date structure Example IF TEST TXT File has been found and its size is 3892 100 bytes with no special attributes gt 00 Last modification time is 00 00 00 date is 1 1 2006 File Attributes are one byte Standard Attribute Structure in FAT system 7 6 5 4 3 2 2 0 Reserved Archive Folder Volume ID System Hidden Read Only Time and Date structure is DWORD Standard structure FAT system Bits s Field Description 31 25 Year1980 Years since 1980 24 21 Month 1 12 20
45. mand and Find Descriptor Command It is possible to send setup requests on the default control pipe using SR command Example Get Device descriptor SR device_handle gt 80 06 0100 0000 0012 Output 0x12 0x01 0x10 0x01 0x00 0x00 0x00 0x08 0 2 0x06 0x00 0x00 0x00 0x00 0x00 0x00 0x00 0x01 GHI Electronics LLC 24 of 51 User Manual USBwiz USB Devices Made Accessible 8 USBwiz Commands Set All commands below are entered in ASCII We choose to use ASCII to simplify troubleshooting and to allow humans to enter commands easily A special case is when accessing the data inside or outside a file When writing reading to from a file or USB Pipe USBwiz will use any kind of data Basically wnat you send is what goes on the file It doesn t have to be ASCII When USBwiz is done processing a command it will return an error code in the form Ixx lt CR gt where is the error number Also some commands require returning some extra information Returned data will come after the symbol unless noted otherwise You can send multiple commands to USBwiz until its FIFO is full indicated by BUSY or RTS USBwiz will take the commands in one at the time process them and send responses for each one Always terminate commands with carriage return character Note in all commands descriptions of their outputs will consider the successful executing of the command 8 1 VR Get Version Number It prints the version number of USBwiz firmwa
46. nly once after connecting the mass storage device GHI Electronics LLC 19 of 51 User Manual USBwiz USB Devices Made Accessible 7 4 USB Printers USBwiz Printer driver support those that has Interface that has unidirectional protocol and accepts pure ASCII similarly to Parallel Port Printers About 60 of USB printers out there support the previous requirements To access Printer First this Printer must be enumerated like any other USB device We will initialize HID which is Attached to USB port 1 to USB device handle 0 as an example UI 1 gt 0 Second Printer Driver must be initialized to take care of this Printer using the Register Printer Command UP Now the USBwiz is ready Send Data to the printer which be performed by Print Data Command UPP PP F4 Get Printer Status Command PS is used to Get Printer Standard Status Byte which is identical to status byte that is usually returned from Parallel Port check PS command for more information USBwiz also provides Reset Printer Command PR 7 5 USB Communication Device Communication Device could be under standard USB class CDC 02 or a special vendor defined device USBwiz currently support CDC device that have Interface that has Abstract Control Model Subclass 02 which accepts pure ASCII similarly to hyper terminal program on COM Port So User can Send AT Command and receive response by means of this Driver About 80 of Cell Phones support this Sub
47. not continue the rest stages This command is very important command for advanced USB users For more information about USB Requests check USB Specifications Format SR hett rr vvvv tt is bmRequestType rr is bRequest vvvv is WORD wValue is WORD wlndex Illl is WORD wLength Example1 SR 0 gt 08 06 0100 0000 0012 Get Device Descriptor 100 100 Related Commands UI UR 8 55 Open USB Pipe This command opens pipe to the PREVIOUSLY FOUND ENDPOINT by FE command Format pisa free USB pipe handle Example OP 1 Related Commands UI UR CP and FE GHI Electronics LLC 44 of 51 User Manual USBwiz USB Devices Made Accessible 8 56 CP Close USB Pipe Format pisa free USB pipe handle Example 1 Related Commands UI UR OP UH UP 8 57 RP Read USB Pipe Sending RP with the pipe handle and the byte count and USBwiz will return data from Endpoint Format p gt ss p Pipe Handle 100 ss HEX Byte desirable data size to be read HEX Byte actual read data from file size 100 Example RF 0 gt F0 100 5 100 Related Commands 8 58 WP Write USB Pipe Format WP p gt ss p Pipe Handle 100 ss HEX Byte desirable data size to be read User sends data 100 Example WP 1 gt 10 100 1234567890 100 Related Commands GHI Electronics LLC 45 of 51 User Manual USBwiz USB Devices Made Accessible Appendix A Firmware Error Codes
48. nother HDT results in OxFE otherwise it is OxFF Keep mind OxFF is always ignored even if it came after HDT Here is a simple C code example void SendSPitoUSBwiz int8 PutSPI OxFE PutSPI 0x00 else c OxFE PutSPI OxFE PutSPI OxFE jelse PutSPI c Note that this example ignores the incoming data from SPI and it shouldn t be used Please consult the code library we provide Important USBwiz requires the following in order for SPI to work SCK is output from your system SCK is idle high GHI Electronics LLC 15 of 51 User Manual USBwiz USB Devices Made Accessible SCK is lower that 7Mhz 1 75 boot loader Data is shifted out MSB first a Data is shifted on the rising edge 6 4 I2C Interface Mode Four pins are needed for 2 communication The USER_I2C_SCL USER_I2C_SDA the two 2 bus lines I2C_DATARDY I2C_BUSY lines work exactly the same way as SPI_DATARDY SPI_BUSY work USBwiz runs in slave 2 mode always The slave address of USBwiz is 4 This address is fixed and can t be changed GHI Electronics LLC 16 of 51 User Manual USBwiz USB Devices Made Accessible 7 USBwiz Functions The commands and response in USBwiz are made in a way where they can be understood and read by a human and can be easily parsed by any simple 8 bit micro Each command is 2 characters Some commands tak
49. nse by means of this Driver About 80 of Cell Phones support this Subclass like Nokia or Motorola Cell phones Format Example his USB device handle of an enumerated device UA 1 Register USB device of USB device handle 1 GHI Electronics LLC 37 of 51 User Manual USBwiz USB Devices Made Accessible Related Commands UI UR RA and WA 8 39 RA Read CDC Buffer This command reads out the internal OUT buffer of the communication device Format RA Read CDC Buffer 100 Data Size is HEX Byte 100 Example 100 9 100 Note Sometimes multiple RA commands must be passed to flush out all the data the buffer like when you first get the echo of the command and the get the result of it Related Commands UA and WA 8 40 WA Send Data to CDC Format ss ss is Byte data to be sent to printer size 100 Data to CD 100 Example WA 100 100 Related Commands RA UA 8 41 UQ Register FTDI Device USBwiz has an internal FTDI Driver UQ Command is responsible for the manual Registering of USB Devices as FTDI after enumerating it by Ul command Format1 h h is USB device handle of an enumerated device PID and VID are the default ones 0x6001 and 0x0403 Format2 UQ h vvvv pppp his USB device handle of an enumerated device vvvv is Vendor ID pppp is Product ID GHI Electronics LLC 38 of 51 User Manual USBwiz USB Devices Made Accessible Example UQ 1 Register USB device of
50. nses USBwiz uses USB through USB host controllers no USB licensing is necessary Copyright GHI Electronics LLC Trademarks are owned by their respective companies ALFAT ALFATxp USBwiz and USBizi are trademarks of Electronics LLC panino lane DISCLAIMER EVENT SHALL GHI ELECTRONICS LLC OR ITS CONTRIBUTORS LIABLE FOR ANY DIRECT INDIRECT INCIDENTAL SPECIAL EXEMPLARY OR CONSEQUENTIAL DAMAGES INCLUDING BUT NOT LIMITED TO PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES LOSS OF USE DATA OR PROFITS OR BUSINESS INTERRUPTION HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY WHETHER IN CONTRACT STRICT IABILITY OR TORT INCLUDING NEGLIGENCE OR OTHERWISE ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE COMPANIES WHO UNITIZE ALFAT OR USBwiz or USBwiz IN THEIR PRODUCTS MUST CONTACT MICROSOFT CORPORATION FOR FAT FILE SYSTEM LICENCING GHI ELECTRONICS LLC SHALL NOT BE LIABLE FOR UNPAID LICENSE SPECIFICATONS ARE SUBJECT TO CHANGE WITHOUT ANY NOTICE GHI Electronics LLC 51 of 51 User Manual
51. ons like reading from file in one Media and write it back in other file in another media at the same time To access FAT Storage Media Storage device low level driver must be attached by AM command then File System can be mounted by MU command Then SS command is used to switch between the file systems Check AM MU and SS commands for more details Example Mount File System 0 on MMC AMC 00 MU 0 gt C 00 550 100 MD FOLDER 00 GHI Electronics LLC 17 of 51 User Manual USBwiz USB Devices Made Accessible USBwiz supports the original FAT file system where files are 8 characters long with extension that is 3 characters long No long file name is supported This allows us to speed up the file access time and simplify the user s work 7 1 1 Directories folders Folders are supported by USBwiz And it is possible to move over Folders by CD command User must be sure about the current folder that is working in be cause there is no current way to retrieve the current location in folder tree MD USBwiz this command will create USBwiz folder 7 1 2 Files Files can be opened for read write or append Opening a file for read requires that the file exists on the media Opening a file for write requires that the file doesn t exist on the media If the file that is being open for read already exists on the media USBwiz will erase the old folder Opening a file for append will add data to a file if it exists
52. re Note that this version is not same or related to the version number of the boot loader The return value is always in the form USBwiz Format VR Example VR 8 2 BR Set UART Baud Rate UART defaults to 9600 at power up This is extremely slow but some systems don t support faster bauds The baud rate can be set to many different standard baud rates BR command sets the internal divider registers of the UART hardware This way any possible baud rate can be set To calculate the divider value use OSC 4 BaudRate 16 The OSC we use on USBwiz is 14745600 The baud rate value is lost on reset and UART goes back to 9600 Format vvvv vvvv WORD HEX Baud Rate Divider Example BR 0020 Baud Rate is 115200 Some common values Baud Rate Divider in decimal Divider HEX 9600 384 0180 19200 192 00 0 38400 96 0060 57600 64 0040 GHI Electronics LLC 25 of 51 User Manual USBwiz USB Devices Made Accessible 115200 32 0020 921600 4 0004 To be used with BR command 8 3 AM Attach Storage Device Storage Media This command is simple and important It prepares USBwiz to communicate with the Storage media at Sector Level IO and check the availability of this media Usually it prompted just before MU command and after UM command for USB Mass Storage Device Format Example AM Um lt n 00 lt 0 Att
53. st get the echo of the command and the get the result of it Related Commands BQ DQ UQ FQ and WQ 8 46 WQ Send Data to FTDI Format WQ ss ss is Byte data to be sent to printer size 100 Data to FTDI 100 Example WQ 3 100 AT 100 Related Commands BQ DQ UQ RQ and FQ 8 47 LD Load USB Descriptor Load descriptor to configuration internal buffer then DB command can read out the data Other commands like FI FE or FD can be performed after loading the Configuration Descriptor Note the maximum size of the internal buffer Is 512 bytes Format1 LD h gt D Load Device Descriptor h is USB device handle of an enumerated device Example1 LD 0 gt D GHI Electronics LLC 40 of 51 User Manual USBwiz USB Devices Made Accessible Formatz2 LD h gt Cn Example2 LD 0 gt 0 Format3 Example3 LD 0 gt 5 01 0012 20 Related Commands UI UR LD gt ii Illl ss Load Configuration Descriptor h is USB device handle of an enumerated device n is Configuration Number The first configuration number is 0 Load the first configuration descriptor Load String Descriptor h is USB device handle of an enumerated device ii is HEX Byte String Descriptor Index Illl is HEX WORD String Descriptor LanguagelD ss is HEX Byte String Descriptor Size 8 48 DB Display USB Descriptor Buffer This command displays the Loaded Data in configuration Internal Buffer Formatt 1 Formatz2 Example2
54. ternal buffer Set desired configuration which is the first configuration SC 0 gt 1 Note that 0 means go back to addressing mode stage Find specific Interface Descriptor in the previously loaded Config Descriptor in the internal buffer FI 03 01 02 00 class HID subclass bootable protocol mouse index the 1st found interface descriptor that match this criteria Output The found interface descriptor size the data Or It is possible can do the following FI 03 FF FF 00 class HID subclass don t care protocol don t care index the ist found interface descriptor that match this criteria Output The found interface descriptor size the data Which is the same result if the device is USB mouse with no other HID interfaces Set the Found Interface SI Output nothing if no error Find specific Endpoint that belongs to the previously found Interface FE 03 02 transfer interrupt direction input Output found Endpoint descriptor size the data Open Pipe to the found endpoint to the handle 6 OP 6 It is possible to search for any kind of descriptors in the loaded internal buffer using FD command GHI Electronics LLC 23 of 51 User Manual USBwiz USB Devices Made Accessible Example Find the 1st HID descriptor in a previously loaded configuration into the internal buffer FD 21 00 Output 00 09 09 21 1001 0001 22 34 00 100 Stage 3 Read 4 bytes from Pipe 6 RP 6 04 Close Pipe 6 Using Setup com
55. urns another error code You can send as many WF as you need to write more data to the file We recommend sending small block of data around 100 bytes Format WF gt 55555555 n File Handle 100 55555555 HEX DWORD desirable data size to be User sends data written 3 DWORD actual written data to file size 100 Example WF 1 gt 10 Write 16 bytes to the file opened for handle 1 100 USBwiz accepted the command 1234567890abcdef 16 bytes of data to go into the file l USBwiz was able to write 16 bytes 100 No errors has occurred Related Commands OF CF and FF 8 20 SW Shadow Write to multiple Files This command is similar to WF command except that it writes the same data into two or three files simultaneously Format 1 SW n M gt SSSSSSSS N First File Handle 100 m Second File Handle User sends data ssssssss HEX DWORD desirable data size to be 100 written 100 DWORD actual written data to size Format 2 SW n 0255555555 Same as the previous Format except for having 100 third shadow o Third File Handle User sends data 100 100 100 GHI Electronics LLC 31 of 51 User Manual USBwiz USB Devices Made Accessible Example SW 1 0 3 gt 10 100 1234567890abcdef 100 5 100 100 Write 16 bytes to the opened for handle 1 0 3 USBwiz accepted the command 16 bytes of data to go into the file USBwiz was able to write 16 bytes to the three files successfully with no errors occurrenc
56. will run in UART mode but if the firmware is valid the boot loader will automatically run the firmware executes R command on its own 6 2 UART Interface In UART mode UART_TX pin is used to send data responses to your microcontroller and UART_RX pin to receive commands data from your microcontroller The default baud rate for UART is 9600 baud 8 bit no parity and 1 stop bit USBwiz can be set to different baud rates CTS and RTS lines must be used in high band width applications CTS pin is an input to USBwiz When it is high USBwiz will not send data and will wait for CTS to go low CTS should be high as long as possible to not slow down USBwiz RTS pin is an output from USBwiz and it is set high when USBwiz FIFO is near full Depending on data transfer speed RTS may never high because USBwiz is contentiously emptying the FIFO Note The internal UART has hardware TX FIFO that is 16 byte long After asserting CTS USBwiz may still send the internal FIFO up to 16 bytes Important USBwiz will NOT send any data if CTS pin is high If this pin is not used then it must be connected to ground GHI Electronics LLC 14 of 51 User Manual USBwiz USB Devices Made Accessible 6 3 SPI Interface Mode In SPI mode six pins are used for communication to implement slave SPI including two pins for handshaking SPI_SSEL 5 5 SPI_MOSI the standard SPI pins where SSEL is used for Slave
57. ystem Media USBwiz can mount up to 3 File System Medias that are independent from each other which means that all opened files and operations in one file system has no effect on the others This gives USBwiz very great capability of flexible switching between the file system Medias and providing other valuable functions like reading from file in one Media and write it back in other file in another media at the same time MU takes the responsibility of mounting the dedicated File System to the dedicated Pre Attached device Attached Device could be MMC SD and one or two USB Mass Storage Devices simultaneously Always use SS command after the use of MU to switch between mounted file systems The file handles will be closed after executing MU command Format MU m gt C Mount File System with order m to SD or MMC MU m gt Un Mount File System with order m to USB Mass Storage Device Handle n Example MU 0 gt C File System 0 is dedicated for SD or MMC 1 gt U0 File System 1 is dedicated for the USB Mass Storage Device handle 0 Related Commands UI UM AM and SS 8 7 SS Switch between File System Medias Switch Media command switch the file access to different File System Medias The media must be already mounted This command doesn t close any opened file handles and it is possible to switch between the Medias at any time Format 55 m Switch to File System Media m Example SS 2 Switch to File System Media 2 Related Commands UI UM
58. ystem to run it Some vendors introduced hosts that run on ISA bus but even with ISA a little microcontroller as PIC or AVR can t run the USB host stack affectively USBwiz solves the USB host problem 1 3 In short what is USB 1 3 1 05 101 The USB specification manual is hundreds of pages We will try to simplify it in few points Every USB Devices has at least one Configuration Set which logically contains at least one interface Every interface contains Endpoints Those Endpoints are the main elements USB client host communication Endpoints are used to opening logical channels which are called Pipes The host software uses pipes to communicate with devices GHI Electronics LLC 4 of 51 User Manual USBwiz USB Devices Made Accessible Configurations Interfaces Endpoints are described in Descriptors in every USB Device There is only one endpoint that has no descriptor with is Endpoint 0 This one is common endpoint that is available in every USB device and opening a pipe to this endpoint is important for USB deriver to control the device since standard class vendor specific requests are transferred on this pipe USBwiz takes the role of USB host driver and provides the functions to fully control USB devices and can manage multiple pipes simultaneously 1 3 2 Transfer Speeds USB 2 0 defines three different transfer speeds according to Device Low Speed devices with speed
59. yte is calculated by adding all 512 data bytes V Returns the loader version Returned value is ASCII Note The boot loader is entirely separate program that loads USBwiz firmware The version number of the boot loader may not mach the version number of USBwiz Important Note New USBwiz chips come with no firmware on them GHI Electronics LLC 12 of 51 User Manual USBwiz USB Devices Made Accessible 5 4 Boot Loader Error Codes The boot loader error codes are not the same as USBwiz error codes Appendix B lists all the boot loader error codes GHI Electronics LLC 13 of 51 User Manual USBwiz USB Devices Made Accessible 6 Commanding with USBwiz 6 1 Selecting an Interface USBwiz uses UART SPI or 2 to communicate with any external microcontroller At power USBwiz samples MODEO MODE 1 to determine what interface to use The MODE pins have a built in pull up resistors to default the pin to 1 Do not connect these pins to VCC leave unconnected for 1 or connect to GND for 0 MODEO Interface 0 0 Don t USE 1 0 2 0 1 1 1 USBizi special version and not for public samples 5 SPI_SSEL to determine what interface to use The following table describes the states SPI_SSEL Interface 0 0 UART 0 1 Skip boot loader 1 0 2 1 1 SPI This mode
Download Pdf Manuals
Related Search