Interfacing to a USB Printer using Vinculum
Contents
1. VINCULUM BEQ FIND USBO NOT IF JUMP CLR USB_RESP CLEAR RESPONSE MODE CMPB 1 QUERY RESPONSE BNE USB P1A NOT IF JUMP LDY USB1_TYPE SAVE TO APPROPRIATE DEVICE LDAB USBCMD LDAA USBBUFF GET DEVICE TYPE JSR GET DEVICE TYPE FIND WHAT TYPE OF DEVICE IS CONNECTED STAA B Y SAVE DEVICE TYPE BCLR FLAG4 10 DEFAULT TO NOT KEYBOARD DEVICE CMPA 502 KEYBOARD BNE USB P1X NOT IF JUMP BSET FLAG4 10 SET KEYBOARD DEVICE READ LDAB USBCMD GET WHICH PORT IS PLUGGED IN LDY DEVICE_SET1 COMMAND TABLE JSR GET_COMMAND JSR USB WRITE ACTIVATE APPROPRIATE PORT BRA USB P1X USB PlA LDD USBBUFF KEYBOARD RESPONSE PARSE CPD 080D 8 BYTES RECEIVED BNE USB P1X NOT IF JUMP LDD USBBUFF 10 CORRECT END STRING CPD 3E0D BNE USB P1X NOT IF JUMP USB PlX JMP USBPX EXIT FIND USB1 TST 0 Y END OF MATCHING STRING BEO FIND USBOK MORE DATA ENTERED THAN TO COMARE WITH LDAA 0 X GET FIRST CHAR OF COMMAND CMPA 61 LOWER CASE LETTER BLO FIND USB1A NOT IF JUMP CMPA S7A a z BHI FIND USB1A NOT IF JUMP ANDA SDF CONVERT TO UPPER CASE FIND USBIA CMPA 0 Y MATCHES TABLE ENTRY BNE FIND UNEXT NOT IF JUMP E 1 X MOVE TO NEXT CHAR IN BUFFER EAY 1 Y MOVE TO NEXT CHAR IN TABLE BRA FIND USB1 KEEP TESTING MORE CHARS FIND USBOK CLRA CLEAR MSB PULB RESTORE INDEX POINTER LSB BAS 2 SP DEALLOCATE LOCAL BRA US2. Version 1 0 Clearance No FTDI 68 VINCULUM Device Send Data DSD The DSD command sends a packet of data to a USB device The target device must be set as the current device using the SC command The data sent to the device is taken directly from the Monitor input There is no conversion from AScii to binary nor is a carriage return required after writing the data to the Monitor port USB byte ordering applies to the data received Up to 64 bytes can be transferred in a single packet VNC1L Printer Specific Commands VNC1L implements following printer specific commands corresponding to USB printer class commands Printer Get Status PGS and Printer Soft Reset PSR See Table 4 for hex codes and details Extended Command Set Short Command Set Function Hexadecimal Codes A 81 OD Pese Get printer status A 82 OD P BP printer soft reset Table 4 VNC1L Printer Specific Commands Printer Get Status PGS The PGS command retrieves the status of a printer The response is one byte in size and is decoded using the information below Bit Selected Table 5 Printer Get Status Response Printer Soft Reset PSR Sends a soft reset command to a printer 3 4 Printer PCL Commands Printer Command Language or PCL was first developed by HP as a printer protocol and has since become a de facto industry standard PCL commands provide access to the printer s PCL control structure The PCL structure controls all of the print
3. By default the processor initializes resources to be disabled and I O to be input pins and SPI mode is enabled The program is also configured for UART communication with the VNC1L with possibility of allowing RS 232 communication at a later time After the system is initialized the program enters the main loop which scans for time based events or asynchronous events At any time the main loop can be interrupted for processing interrupt events such as timers or RS 232 input MAIN This is the program loop that runs all of the routine operations of the system This includes waiting for time based functions scanning for keys and checking for new messages from the VNC1L Time based functions are triggered by setting Flags in the Timer Flag variable The timers interrupt routine TIMER sets the individual bits or Flags in the Timer Flag variable based on how much time has elapsed There are time based events pre configured for 0 1 sec 0 5 sec 1 sec 0 1min and 1 min intervals For this demonstration only a single key is being scanned But note that for any keys that are used a debounce routine should be used to eliminate erroneous key presses Keypads and switches are notorious for ringing as the key is pressed and released As soon as key is pressed DSD command with PCL control codes is given to VNC1L chip on SPI bus which results in printing the data on printer connected on USB port of VNC1L The Main loop also scans the
4. Host Controller Printer Interface Application Note AN 106 Version 1 0 Clearance No FTDI 68 VINCULUM i 5 Summary This application note demonstrates how a USB printer interface can be added to an embedded system using Vinculum USB Host controller VNC1L A 16 bit Freescale HC12 microcontroller has been used to control the VNC1L chip using SPI interface on V Eval board and give PCL commands to the printer Complete details of project hardware firmware details step by step instructions for setting up the hardware and running the application demo are included in this application note Copyrig it 2008 Future Techno ogy Devices International Limited 13 ty p Document Reference No FT 000064 Using Vinculum USB Host Controller Printer Interface Application Note AN 106 Version 1 0 Clearance No FTDI 68 VINCULUM 6 Contact Information Head Office Glasgow UK Future Technology Devices International Limited Unit 1 2 Seaward Place Centurion Business Park Glasgow G41 1HH United Kingdom Tel 44 0 141 429 2777 Fax 44 0 141 429 2758 E mail Sales sales ftdichip com E mail Support support ftdichip com E mail General Enquiries admin1 ftdichip com Web Site URL http www ftdichip com Web Shop URL http www ftdichip com Branch Office Taipei Taiwan Future Technology Devices International Limited Taiwan 4F No 18 3 Sec 6 Mincyuan East Road Neihu District Taipei 114 Taiwan R O C Tel 8
5. VNC1L for any new messages When a new message is detected it is read and parsed to determine if any further action should be taken For example when a new device is connected it should be polled to indentify the device type and device number INTERRUPTS Two interrupts are used for this demonstration One is for timekeeping the other is to run the RS 232 interface The CPU timer register is configured to increment every 4 bus clocks The bus is driven by a PLL and is configured for a 23 9616 MHz clock Copyrig j 2008 Future Techno ogy Devices International Limited 5 uy gh Document Reference No FT_000064 Using Vinculum USB Host Controller Printer Interface Application Note AN_106 Version 1 0 Clearance No FTDI 68 VINCULUM TIMER This routine is triggered once every 5990 timer ticks or every 1 mS Each of the mS interrupts are counted and stored in variables so that the Timer_Flag bits can be set to identify periodic time events The RS 232 interrupt is used to receive data from the USB port which should be connected to a PC running a terminal program at 115 200 baud Each byte that is received triggers an interrupt that gets the incoming character and stores it to a buffer When a form feed command 0x0C is received the incoming data is then sent to the VNC1L to be printed If a form feed is not received any data in the input buffer is printed after timer based pre configured timeouts 3 5 2 Firmware Routines There are te
6. to the printer The printer takes the data parses it using PCL and prints the data to the paper LED7 and LED8 on V Eval board are used to indicate the status of printer see details in Section 4 2 The same concept can be implemented in Windows Mobile devices based on Win CE that interface with Vinculum VNC1L chip on monitor port Applications can be written to send PCL commands to the printer 3 2 USB Printer Class Details USB Printer Class specification defines three class specific requests GET_DEVICE_ID GET_PORT_STATUS and SOFT_RESET GET_DEVICE_ID bRequest 0 This class specific request returns a device ID string that is compatible with IEEE 1284 See IEEE 1284 for syntax and formatting information A printer with multiple configurations interfaces or alternate settings may contain multiple IEEE 1284 device ID strings The wValue field is used to specify a zero Copyrig t 2008 Future Techno ogy Devices International Limited 4 Document Reference No FT_000064 p Y Using Vinculum USB Host Controller Printer Interface Application Note AN_106 Version 1 0 Clearance No FTDI 68 VINCULUM based configuration index The high byte of the wIndex field is used to specify the zero based interface index The low byte of the wIndex field is used to specify the zero based alternate setting GET PORT STATUS bReguest 1 This class specific request returns the printer s current status in a format that is compatible wit
7. 8 01 08 81 40 01 40 03 04 01 02 00 07 01 02 FO 03 12 13 00 0 01 00 00 00 00 00 00 00 00 00 00 00 Is Figure 3 USB device information using QD command 1 Byte represents USB address which is 0x01 see Figure 3 2 4 Byte corresponds to Control End Point 0 size of 0x08 bytes 8 Byte represents device type whose value is 0x04 representing a printer class see Table 3 10t byte shows location of the USB device on the V Eval here the printer was connected on Port 2 and thus the value of 0x02 Bytes 12 13 and 14 are USB device class subclass and protocol that have values of 0x08 0x06 and 0x50 respectively Two bytes 15 and 16 correspond to Vendor ID and 17 and 18 byte correspond to Product ID which have value of OxFO 0x03 and 0x12 0x13 respectively 0x01 in 21 Byte represents a full speed USB device Set Current SC This command is used to select an interface on a USB device for communication All output from SSU Send Setup DSD Device Send Data and DRD Device Read Data commands are routed to this device The device used in data mode is also selected with this command Valid values for Device Number are 0 to 15 and this must match the device number used in the QD Query Device command Copyrig t 2008 Future Techno ogy Devices International Limited 6 Uy p Document Reference No FT_000064 5 Using Vinculum USB Host Controller Printer Interface Application Note AN_106
8. 86 0 2 8791 3570 Fax 886 0 2 8791 3576 E mail Sales tw sales1 ftdichip com E mail Support tw support1 ftdichip com E mail General Enquiries tw admin1 eftdichip com Web Site URL http www ftdichip com Branch Office Hillsboro Oregon USA Future Technology Devices International Limited USA 7235 NW Evergreen Parkway Suite 600 Hillsboro OR 97123 5803 USA Tel 1 503 547 0988 Fax 1 503 547 0987 E Mail Sales us sales eftdichip com E Mail Support us admin ftdichip com Web Site URL http www ftdichip com Distributor and Sales Representatives Please visit the Sales Network page of the FTDI Web site for the contact details of our distributor s and sales representative s in your country Disclaimer Vinculum is part of Future Technology Devices International Ltd Neither the whole nor any part of the information contained in or the product described in this manual may be adapted or reproduced in any material or electronic form without the prior written consent of the copyright holder This product and its documentation are supplied on an as is basis and no warranty as to their suitability for any particular purpose is either made or implied Future Technology Devices International Ltd will not accept any claim for damages howsoever arising as a result of use or failure of this product Your statutory rights are not affected This product or any variant of it is not intended for use in any medical
9. BPO FIND USBERR END OF INCOMING CHARS NO MATCH BAS 3 SP DEALLOCATE LOCALS BRA USBPX USBPX RTS KKK KKK KKK KKK A A A X ZA AZ X A A X KKK KKK XX A KZ KA KKK KKK KK KA GET USB DEVICE TYPE FROM MASK ESC DI M EYBOARD Copyright 2008 Future Technology Devices International Limited y ty p Document Reference No FT 000064 Using Vinculum USB Host Controller Printer Interface Application Note AN 106 gt Version 1 0 VINCULUM Clearance No FTDI 68 4 10 CDC CLASS DEVICE 5 20 BOMS CLASS DEVICE FLASH DRIVE 6 40 UNKNOWN DEVICE 7 80 HUB DEVICE ENTERS gt A DEVICE TYPE RETURNS gt A 0 NOTHING CONNECTED 1 PRINTER 2 KEYBOARD 3 FLASH DISK 4 OTHER UNRECOGNIZED KEKE KK KKK KKK KKK KA KA KA AZ A A X A X A X X A KA XK A A Z X K KKK GET DEVICE TYPE BITA 04 PRINTER BEQ GET DT1 NOT IF JUMP LDAA 1 YES SET PRINTER TYPE BRA GET DTX EXIT GET DT1 BITA 08 HID DEVICE KEYBOARD BEQ GET DT2 NOT IF JUMP LDAA 02 SET KEYBOARD DEVICE BRA GET DTX GET DT2 BITA 20 FLASH DISK BEQ GET DT3 NOT IF JUMP LDAA 03 SET FLASH DISK B
10. D NEW MESSAGE PARSE NEW MESSAGE FOR COMMANDS LOOK FOR MORE COMMANDS KKK KK KKK KKK KKK KKK KKK KKK KKK KKK KKK KKK KK KKK KKK KEK USB CONTROLLER READ THIS ROUTINE READS A MESSAGE FROM THE USB IC KKK KKK KKK KKK KKK KKK KKK KK KKK KKK KKK KKK KK KKK KKK KKK USB_READ LDAA LEN USBBUFF LDX USBBUFF Copyrig j 2008 Future Techno ogy Devices International Limited m ty p _ Document Reference No FT_000064 W Using Vinculum USB Host Controller Printer Interface Application Note AN_106 Version 1 0 VINCULUM Clearance No FTDI 68 usB_RO MOVW 0 2 X l DBNE A USB_RO LDX USBBUFF USB RI BSET USBPORT USBCS ENABLE USB IC LDAA CO READ USB DATA JSR RUNSPI TAB SAVE FOR LATER JSR RUNSPI BCLR USBPORT USBCS DISABLE USB IC PSHD LDAB 12 DBNE B PULD EXG A B REVERSE DATA ORDER SLD ALIGN BYTES SLD SLD CMPA 1 SAME AS LAST DATA BNE USB R2 NOT IF JUMP BITB 580 OLD OR NEW DATA BEQ USB R2 NEW DATA IF JUMP CMPA 0D END OF XMISSION BEQ USB RX 7 YES IF JUMP BRA USB R1 USB R2 STAA 1 X BRA USB R1 GET NEXT BYTE USB RX RTS KKK KK KKK AX AXA AK A A A XK AXA AZ X A A X X A KZ AA XX A ZX A KZ K K KA USB CONTROLLER WRITI THIS ROUTINE Writes A MESSA
11. ECMD USB WC1 LYF G EXT BYTE TO WRITI USB WCX DONE IF JUMP USBPORT USBCS ENABLE USB IC REFORMAT DATA 590 A E STATUS R RUNSPI SB RUNSPI USBPORT USBCS DISABILI 55 B USB WC1 USB WCX KKK KK KKK AX AXA AK A A A XX A AZ X A A X X A KZ AA XX A ZX A KKK KK KKK KA PARSE USB RESPONSE THIS ROUTINE LOOKS AT THE COMMANDS SENT FROM TERMINES WHAT ACTION THE USB CONTROLLER AND D TO TAKE USB_PARSE LDAB USB RI WAITING RESPONSE FROM COMMAND Copyrig it 2008 Future Techno ogy Devices International Limited 19 uy P Document Reference No FT 000064 Using Vinculum USB Host Controller Printer Interface Application Note AN 106 d Version 1 0 Clearance No FTDI 68
12. GE TO USB IC ENTERS gt Y ADDRESS OF MESSAGE TO SEND USB_WRITE MOVB 1 Y 1 SP SAVE CHAR COUNT USB W1 LDAA Ly Xr GET NEXT BYTE TO W STAA TTEMP1 USB WIA BSET USBPORT USBCS ENABLE USB IC CLRB REFORMAT DATA LSRD LSRD LSRD ORAA 580 JSR RUNSPI RUNSPI USBPORT USBCS DISABLI 55 B 510 USB W2 PR NOT FULL IF JUMP Copyrig T 2008 Future Techno ogy Devices International Limited m ty p Document Reference No FT 000064 Using Vinculum USB Host Controller Printer Interface Application Note AN 106 W Version 1 0 Clearance No FTDI 68 VINCULUM JSR USB_QUERY PULY LDAA TTEMP1 BRA USB_W1A RE TRANSMIT USB W2 DEC 0 SP DONE WITH COMMAND BNE USB W1 NO GET NEXT BYTE EAS 1 SP DEALLOCATE LOOP COUNTER S AX X KKK KKK KKK XZ ZA AZ X AXA XZ X A AX X AX A XK Z AX XZ Z K ZA A KAZ K K K USB CONTROLLER WRIT THIS ROUTINE SENDS NULL TREMINATED DATA to USB IC ENTERS gt Y ADDRESS OF MESSAGE TO SEND KKK KK KKK KKK KKK KKK KKK A A X KKK KKK KKK KKK KKK KKK KKK KK USB WRIT
13. I i t o USB 1 4 r HP Dest 460 Daughter 4 board gt VEval Board Figure 2 Block Diagram of VNC1L USB Printer Interface Figure 2 shows the connections between the various devices used in this application note An FTDI V Eval board is used as the base development platform This includes the VNC1L device prototyping area external connectors and two USB Host ports An external microcontroller is required to control the VNC1L In this application note a Freescale micro controller on a daughter board is connected to the V Eval on the SPI bus The VNCiL monitor port is selected on V Eval board through jumper settings see Section 4 1 Three interface options are possible UART SPI and FIFO In this set up the monitor port SPI interface was used The Freescale micro controller is then connected to the V Eval SPI header When a printer is attached to Type A USB port of the V Eval board it is enumerated and a status message is sent to the monitor port This status message is captured by the HC12 micro controller The VNC1L has two modes of commands text based command and binary commands To reduce the bandwidth on the SPI bus the binary command set also called the Short Command Set is used In the micro controller unit firmware pressing switch SW1 on the V Eval board generates a set of PCL commands which are sent to the VNC1L on the V Eval board via the SPI interface VNC1L sends the corresponding data on the USB
14. OD TRA A o Set device specified in the lst parameter as an FTDI device 98 OD oe Query Slave Status only available on VDPS Table 2 USB Device Commands Query Port QP1 QP2 The Query Port commands display two bytes of information about devices connected to USB Port 1 for QP1 or USB Port 2 for QP2 The first byte shows the class or classes of opyrig uture lechnology Devices international Limite uy P Document Reference No FT 000064 Using Vinculum USB Host Controller Printer Interface Application Note AN 106 Version 1 0 Clearance No FTDI 68 VINCULUM connected devices The second byte is always zero The connected devices bitmask is described in Table 3 Hub Device on Port Unknown Device BOMS Class Device CDC Class Device HID Class Device Printer Class Device Reserved always 0 eg FTDI FT232 FT245 FT2232 Device Table 3 Device Type Bit Definitions Query Device QD This command is used to find information on a device interface The device number can be a valid device in the range of 0 to 15 This will return a block of 32 bytes of USB device information record The byte values retuned from the design in the application note are as shown in Figure 3 below Further details on this can be found in Vinculum Firmware User Manual FE VNC1 Evaluation Board Program Version 0 97 Select Port Programmer Mode Terminal Mode Spy Mode Mode Interface Enabled D
15. PE IS PORT 1 PRINTER CMPA 01 BNE PINITY NOT IF JUMP LDY DEVICE SET1 SET CURRENT DEVICE BRA PINIT2 PINIT1 LDAA USB2 TYPE IS PORT 2 PRINTER CMPA 01 BNE PINITY NO ERROR LDY DEVICE_SET2 SET PORT 2 AS ACTIVE DEVICE PINIT2 JSR USB WRITE LDY HP SETUP1 SEND PRINT ENABLE COMMAND JSR USB WRITE JSR VAR 30MS JSR USB OUERY LDY HP SETUP SEND PRINT ENABLE COMMAND JSR USB WRITE JSR VAR 30MS JSR USB OUERY CLRA RETURN ZERO FOR PRINTER READY BRA PINITX PINITY LDAA SFF RETURN NON ZERO FOR ERROR PINITX RTS USB PRINT HIS ROUTINE SENDS AN ASCII STRING TO TH STRING MUST BE NULL TERMINATED E USB COMMAND DSD IS ADDED TO THE BEGINNING OF THI KKKKKKKKKKKKKKKKKKKKKK KKKKKKKKKKKKKKKKKKKKKKKHK PRINT MOVW 8320 PRINT BUFF 1 SETUP DEVICE SEND DATA COMMAND MOVB 0D PRINT BUFF 4 SETUP CARRIAGE RETURN LDAA SFF INIT CHAR COUNTER PRINT BUFF 5 START OF PRINT BUFFER DATA COUNT CHARS IN STRING 1 Y 1 X F0351 P TILL END OF ST N S PRINT_BUFF 3 E CHARS TO S 4 CONTROL BYTI PRINT BUFF m F M m F a ENT STRING AD PRINT_BUFF Gl START OF COMMAN USB WRIT SEND TO PRINTER Copyrig it 2008 Future Techno ogy Devices International Limited 22 Document Reference No FT_000064 q Q a p Y Using Vinculum USB Host Controller Printer Interfac
16. RA GET DTX GET DT3 LDAA 04 SET UNKNOWN DEVICE TYPE GET DTX RTS RUNSPI THIS ROUTINE SENDS THE DATA IN RI AND RETURNS DATA IN REGISTER A KEKE KK KKK KKK KKK KK KKK KKK KKK KK KK KKK M AA KKK KK KKK RUNSPI STAA SPODR SEND DATA BRCLR POSR 580 WAIT FOR DATA R LDAA POSR CLEAR FLAGS LDAA PODR READ RETURNED DATA RTS DONI KKK KK KKK KK KKK KKK KKK A X A A XX KKK KKK KKK XX A KKK KKK KKK KK KKK KKK KKK INITIALIZE PRINTER THIS ROUTINE RESETS THE PRINTER AND SETS IT TO ASCII PRINT PCL3 LANGUAGE PE ERS ONLY RETURNS WITH Z SET IF OK Z CLR IF DY OR NOT PRE Copyrig a 2008 Future Techno ogy Devices International Limited zi Uy gt Document Reference No FT_000064 Using Vinculum USB Host Controller Printer Interface Application Note AN_106 x W Version 1 0 Clearance No FTDI 68 VINCULUM KKKKK KKK KK KKK KKK KKK AX X A KKK KKK KKK KKK KKK KKK KK KKK KKK KKK KKK KKK INIT PRINTER LDAA USB1 TY
17. al Limited a ty p Document Reference No FT 000064 Using Vinculum USB Host Controller Printer Interface Application Note AN 106 Version 1 0 Clearance No FTDI 68 VINCULUM Appendix C HC12 Firmware Source Code USB CONTROLLER INIT THIS ROUTINE INITIALIZES THE USB IC AND SETS THE COMMAND MODE TO SHORT KKK KK KKK KKK KKK KKK KKK KKK KKK KKK KKK KKK KKK KKK KKK KK USB_INIT JSR USB_QUERY HECK FOR STARTU LDY USB CMD SHORT SET SHORT MESSAGE JSR USB WRITI SEND COMMAND TO RTS AA X Z KAZ AAA AZ AA XK ZA A X AXA XZ X A AX XX A X Z AZ XX K ZA A KAZ K K K USB CONTROLLER OUERY THIS ROUTINE POLLS THE USB IC FOR ANY NI DATA USB OUERY BSET USBPORT USBCS ENABLE USB IC LDAA SE0 READ USB STATUS JSR RUNSPI TAB SAVE FOR LATER JSR RUNSPI BCL USBPORT USBCS DISABILI 12 By A B REVERSE DATA ORDI ALIGN BYTES NEW DATA AVAILABLI NOT IF JUMP REA
18. appliance device or system in which the failure of the product might reasonably be expected to result in personal injury This document provides preliminary information that may be subject to change without notice No freedom to use patents or other intellectual property rights is implied by the publication of this document Future Technology Devices International Ltd Uniti 2 Seaward Place Centurion Business Park Glasgow G41 1HH United Kingdom Scotland Registered Number SC136640 Copyrig it 2008 Future Techno ogy Devices International Limited 44 uy s Document Reference No FT_000064 Using Vinculum USB Host Controller Printer Interface Application Note AN_106 Version 1 0 Clearance No FTDI 68 VINCULUM Appendix A Acknowledgements We would like to thank Lucio Simoni of JPC controls for collaboration on both hardware daughter board design and firmware development for this application note Special thanks for obtaining permission to showcase their customer Quantifit s Occupational Health Dynamics product as a part of this application note Product Show Case Quantifit Occupational Health Dynamics OHD provides top quality instruments for industry and government compliance in the fields of industrial Hygiene and Occupational Health tests Quantifit is an embedded mobile respiratory test unit shown in Figure 9 Figure 9 OHD s Quantifit Product Vinculum features are extensively used in this product for providing prin
19. e Application Note AN_106 Version 1 0 Clearance No FTDI 68 VINCULUM Appendix D Revision History Version 1 00 First Release 24 11 2008 Copyrig it 2008 Future Techno ogy Devices International Limited 23
20. er but doesn t contain source listing when loaded into debugger Vdem7 mrk Assembler output file used for debugging Vdem7 bbt Assembler Output file probably used for debugging Vdem7 dbg Debugger File Vdem7 abs File to be loaded into debugger hiwave exe PCB This folder contains all the Gerber Solder Mask Silk Screen and Drill files for designing the Printer daughter board Readmes This folder contains readme files with more details on firmware files version etc Source This folder contains the assembly source code and list files for memory maps Vdem7 asm Assembly source code text file Vdem7 st Listing file provides memory locations for program code text file Tools For developing this demo application we have used the FTDI V Eval utility V Eval exe This provides the user with a terminal application that acts as a debug tool to intercept the messages on the VNC1L monitor port This application is provided in the tools folder along with the links to the IDE used for writing the Freescale assembly code Copyrig t 2008 Future Techno ogy Devices International Limited 3 Document Reference No FT_000064 UY Y Using Vinculum USB Host Controller Printer Interface Application Note AN_106 Version 1 0 Clearance No FTDI 68 VINCULUM 3 Software Theory and Command Structure 3 1 Block Diagram VNC1L Printer Interface Design SW1 M o USB 2 n SP
21. er s features except those used for vector graphics which are controlled by the HP GL 2 commands PCL printer commands consist of two or more characters The first character is always the Ascii escape character identified by the decimal value of 027 or hexadecimal value of 1B Escape character is a special control code which identifies the subsequent string of characters as a printer command As the printer monitors incoming data from a computer it polls for this character When this character appears the printer reads it and its associated characters as a command to perform and not as data to print The PCL commands used in this application note are as follows For further details on PCL commands please refer to HP PCL Reference Manual Printer Control Language Reference Manual 5 Appendix B Printer Reset Ec E Restores the User Default Environment deletes temporary fonts and macros and prints any remaining data Number of Copies Ec amp X Prints the specified number of copies of each page Copyrig j 2008 Future Techno ogy Devices International Limited gt Vy g Document Reference No FT_000064 Using Vinculum USB Host Controller Printer Interface Application Note AN_106 Version 1 0 Clearance No FTDI 68 VINCULUM Page Size Ec amp A Designates the physical paper size which in turn defines the logical page 2 Letter 8 5 x 11 Left Margin Ec amp a L Sets the left ma
22. ethods outlined in this application note Copyrig it 2008 Future Techno ogy Devices International Limited 2 uy s PL Document Reference No FT_000064 Using Vinculum USB Host Controller Printer Interface Application Note AN_106 Version 1 0 VINCULUM Clearance No FTDI 68 2 Project framework 2 1 Project Installation The VPD msi is the installation file for the project When this file is run the installer will install the project files into C Program Files Vinculum Printer Demo folder the installer will give an option for selecting the target folder After successful installation the target folder is created and all source code files will be present as per the file structure shown in Figure 1 below 2 2 Project Structure Project Folder C Program Files Vinculum Printer Demo contains a project repository of all the files needed to implement the project These include source code PCB Gerber s output files readme files and tools used for implementing the demo The structure of the project folder is shown in Figure 1 r C Program FilesWinculum Printer Demo File Edit View Favorites Tools Help air wi P Search E Fa Address C Program FilesWwinculum Printer Demo B o O Output PCB Readmes Source O Tools Folders Figure 1 Directory Structure Output This folder contains following files Vdem7 sx Distributable source code It can be used to flash into microcontroll
23. h the status register of a standard PC parallel port Table 1 defines the data returned 7 6 R Reserved for future use 5 Paper Empty 1 Paper Empty 0 Paper Not Empty Sel t 1 Selected 0 Not Selected Not E 1 No Error 0 Error R d R Reserved for future use Table 1 GET_PORT_STATUS return byte details SOFT_RESET bRequest 2 This class specific request flushes all buffers and resets the Bulk OUT and Bulk IN pipes to their default states This request clears all stall conditions This reset does NOT change the USB addressing or USB configuration 3 3 VNC1L Printer Interface Commands VNCI1L is used in the command mode to send commands to the printer VNC1L USB Host controller uses standard commands to set up the communication channel and check the status of slave device printer The commands relevant to this application are tabulated in Table 2 and described below Extended Command Set Short Command Set Hexadecimal Codes 2B 0D a 2 D Query port 2 85 20 byte 0D Obepy ber ae Query device specified in the 1 parameter 86 20 byte 0D bees Ber Byte vee Set device specified in the 1 parameter as the current device lt 83 20 byte OD Dyte Pu ae Send data to USB device where the size oe of the data is specified in the 1 parameter 84 OD pore P Read back data from USB device 9A 20 d 0D ee ae data eo Send setup data to device control ara endpoint with optional follow on data 87 20 byte
24. ignal interference with FT2232 device on V Eval Board PRE EA n E C Bs Bs m Ecs Si coca w cs Hm lt E B OFF On USB Terminal mg LEDs Enable VINCULUM MODE BINDING USB TECHNOLOGIES Beas Sekesebeds EHHA HEEE JPL LEDID pas r JA 72 on LEDS ppp cto R78 cn Figure 4 V Eval board Key Components Next select SPI mode of operation for the monitor port by setting jumpers JP1 and JP2 as shown in Figure 5 according to settings in Table 6 o o Q a N 1 bj Figure 5 Jumpers for SPI mode selection Opyrig uture Technology Devices International Limite uy 5 Document Reference No FT_000064 Using Vinculum USB Host Controller Printer Interface Application Note AN_106 x W Version 1 0 Clearance No FTDI 68 VINCULUM UAR Table 6 Jumper Settings for SPI mode Selection Connection of Printer daughter board to V Eval s SPI Port Ensure Jumper J7 is open Connect the Printer daughter Board on SPI port of V Eval Board see highlighted in Figure 4 V Eval board Key Components for V Eval board and Figure 6 SPI Port on Printer Daughter board for daughter board SPI port Apply the power to V Eval Board Load the printer with A4 sheets Connect the printer to the USB port highlighted in Figure 4 V Eval board Key Components wait till LED8 goes solid green V Eval and HC12 printer daughter board assembly used in this application note ooo0o000000000000 Q J4 9 o
25. ited Uy g Document Reference No FT_000064 y Using Vinculum USB Host Controller Printer Interface Application Note AN_106 Version 1 0 Clearance No FTDI 68 VINCULUM Table of Contents 1 MND ES 110 ee 2 2 Project framework nn 3 2 1 Project Installation 4 3 22 Project Sr ee GUM ss 3 3 Software Theory and Command Structure ee 4 3 1 Block Diagram VNC1L Printer Interface Design eeeeeeeeeeeeeeeeeeeeeeennnne 4 3 2 USB Printer Class Details ee 4 3 3 VNC1L Printer Interface Commands pe 5 3 4 Printer PCL CommandS ee 7 3 5 HC12 Firmware Details ee 8 3 5 1 Theory of OPOratiOn mi nn 8 3 5 2 Firmware ROUtNES cansino ee E 9 4 Hardware Connections and Running the Demo pp 10 4 1 Jumper Settings 00 ie u buku kase 10 4 2 ED DET o ne ma 12 43 Printer Qutp t sson aes ee 12 5 SUMM TY 0a a aaa EENG 13 6 Contactlnformation 14 Appendix A Acknowledgements nn 15 Appendix B References es 16 Appendix C HC12 Firmware Source Code pp 17 Appendix D Revision History pe 25 TT Copyright 2008 Future Technology Devices International Limited SSS 1 Vy g Document Reference No FT_000064 Using Vinculum USB Host Controller Printer Interface Application Note AN_106 Version 1 0 Clearance No FTDI 68 VINCULUM 1 Introduction In the printer marketplace USB is the defacto interconnect standard for personal printers The Universal Serial Bus USB has severa
26. l advantages over previous generation of connection methods such as parallel ports A USB port is much faster than a parallel port can handle 12Mbps and a single port can handle different devices e g a USB port can handle USB Flash disks mouse and keyboard whereas the parallel port was dedicated for the printer connection The USB enumeration process that occurs when a device is connected to the USB host handles the device requirements using standard USB descriptors supplied by the device This is completely transparent to user Users just plug in the printer and see it is ready for use USB 2 0 specification defines a specific device class for printing devices VNC1L USB Host controller implements and supports USB print class device configuration and interface and endpoint descriptors as per USB printer device specification It also supports USB printer class specific request and response structure used by basic Printer Command language PCL interface Note The VNC1iL Host does not provide drivers for printers Most modern printers support built in fonts and as such they can print text using basic printer control codes directly from the Vinculum Monitor Other printers will require embedded fonts or graphics to be sent as part of a print job Most modern printers support a PCL language as the protocol for an operating system driver to communicate with the printer If the printer supports PCL language it can be controlled by the VNC1L using the m
27. n VINCULUM Future Technology Devices International Ltd Application Note AN 106 Interfacing to a USB Printer using Vinculum VNC1L Host Controller Document Reference No FT_000064 Version 1 0 Issue Date 2008 11 24 This application note describes how to add printing capability to an embedded design via a USB interface using FTDI s Vinculum Host controller VNC1L VNC1L implements USB Printer Class and gives a command monitor port interface for controlling USB printers using standard PCL ASCII commands Details of how a battery operated portable printer HP DeskJet 460 printer was interfaced with Freescale s 16 bit micro controller HC12 using VNC1L on SPI monitor port are presented This design can be applied to a variety of real life embedded applications including medical portable devices field tester devices logistics point of sales rentals queuing systems ticketing system gas receipts etc that require a printer interface We highlight a product in the market Ouantifit from OHD that uses VNC1L to provide USB printer capability to a field fitness testing device using the design in this application note Future Technology Devices International Limited Unit 1 2 Seaward Place Centurion Business Park Glasgow G41 1HH United Kingdom Tel 44 0 141 429 2777 Fax 44 0 141 429 2758 E Mail Support vinculum support ftdichip com Web http www ftdichip com Copyright 2008 Future Technology Devices International Lim
28. n major routines in the HC12 firmware developed for this application The brief explanation of each routine is given here The source code with detailed comments on each line of instruction can be found in Appendix C 1 USB_INIT Initializes the VNC1L chip and sets the command mode to Short Command Set SCS Hexadecimal format 2 USB QUERY Checks if any new data is available from VNC1L chip 3 USB_READ Reads data from the VNCiL chip 4 USB_WRITE Sends known length Command Data to the VNCiL chip 5 USB WRITECMD Sends null terminated data to VNC1L chip 6 USB_PARSE Processes the data received from VNC1L chip and determines the action to take 7 GET DEVICE TYPE Determines which device is connected to the VNC1L USB port 8 RUNSPI Sends the data through SPI interface by loading the data in register REG A 9 INIT PRINTER Selects and sets up the printer connected to VNC1L USB port 10 USB PRINT Sends the VNC1L DSD command with the data string to the printer for printing Copyrig it 2008 Future Techno ogy Devices International Limited j Document Reference No FT_000064 M J p P Using Vinculum USB Host Controller Printer Interface Application Note AN_106 Version 1 0 Clearance No FTDI 68 VINCULUM 4 Hardware Connections and Running the Demo 4 1 Jumper Settings Figure 4 shows key components that need attention for this demo To configure the V Eval board for this application remove the jumper J7 avoid SPI s
29. o o Ee OC510 P El MN OOOOOOOOOOODO o cs3 HIN O Cm wb t59 2 TTT o o i o RR Siz o Figure 6 SPI Port on Printer Daughter board OO cs ese oL_ 3_Jo Copyright 2008 Future Technology Devices International Limited a vy p Document Reference No FT 000064 Using Vinculum USB Host Controller Printer Interface Application Note AN 106 Version 1 0 Clearance No FTDI 68 VINCULUM Figure 7 V Eval and Printer Daughter Board Assembly 4 2 LED Usage LED7 and LED8 on V Eval board are used for indicating various states of USB printer in this application Specifically various printer states are represented using LED states as shown below Power On LED7 and LED8 flash alternately for 2 seconds This is repeated until monitor connects USB Printer Ready LED7 off LED8 on USB Printer Removed LED7 off LED8 off Commands from monitor Port to USB Printer LED7 off LED8 flashes Commands from monitor Port with USB Printer removed LED7 off LED8 off 4 3 Printer Output On pressing the button SW1 the printer will print out the test pattern shown in Figure 8 VINCULUM DEMO BOARD Test Printou BOLD TEXT NORMAL TEXT This pitch is 10 characters inch This pitch is 12 5 characters inch This pitch is 16 67 characters inch Figure 8 Printer Test Output Copyright 2008 Future Technology Devices International Limited ty p Document Reference No FT 000064 Using Vinculum USB
30. rgin to the left edge of the specified column Column number Right Margin Ec 8 a M Sets the right margin to the right edge of the specified column Column number Line Termination Ec amp k G Controls the way the printer interprets CR LF and FF control codes 0 CR CR LF LF FF FF Font Selection by ID Ec X or Eg X Selects a soft font using its specific ID EG X Designates soft font as primary Ec X Designates soft font as secondary Font Identification number Spacing Ec s ff P Primary Ec s P Secondary Designates either a fixed or proportionally spaced font 0 means Fixed spacing 1 means Proportional spacing Pitch Ec s H Primary Ec s H Secondary Designates the horizontal spacing of a fixed spaced font in terms of the number of characters per inch Pitch in characters inch Stroke Weight Ec s B Primary Ec s B Secondary Designates the thickness or weight of the stroke that composes the characters of a font 3 5 HC12 Firmware Details We assume basic familiarity with H12 assembler tools Further details on H12 assembler can be found in H12 Assembler manual 6 Appendix B 3 5 1 Theory of Operation The program begins by initializing the processor resources Programmable resources include RAM address location I O definitions SPI UART and EEPROM Only the resources that are used in the project need to be initialized
31. ter keyboard PC USB interface and data logging For further details on application and device please refer 4 in Appendix B This product performs respiration testing with on board data storage more than 1000 tests USB keyboard and Printer connection USB Flash disk storage and data transfer USB Computer interface The OHD design uses Vinculum chip VNC1L for Printer and Keyboard operation Copyright 2008 Future Technology Devices International Limited uy p Document Reference No FT 000064 Using Vinculum USB Host Controller Printer Interface Application Note AN 106 a W Version 1 0 VINCULUM Clearance No FTDI 68 Appendix B References 1 Vinculum Website The main website for the Vinculum family of USB Host Controllers on the FTDI website http www ftdichip com 2 Vinculum Datasheet DS_VNC1L 1A Vinculum Embedded USB Host Controller IC Data Sheet http www ftdichip com 3 USB Device Class Definition for Printing Devices http www usb org developers devclass docs usbprint11 pdf 4 Product Showcase OHD s Quantifit http expweb magiccitywebs net OHD default aspx id 798 5 HP PCL Reference Manual Printer Control Language Reference Manual http h20000 www2 hp com bc docs support SupportManual bpl13210 bpl13210 pdf 6 HC12 Assembler User Manual http www freescale com files microcontrollers doc user guide MCUEZASM12 pdf Copyrig it 2008 Future Techno ogy Devices Internation
Download Pdf Manuals
Related Search