EZ-USB FX2 Development Kit Manual Getting Started Rev 1.3

Transcription

1 EZ-USB FX2 Development Kit Manual Getting Started Rev 1.3 Cypress Semiconductor Interface Products Division Avenue of Science Suite 200 San Diego, CA 92128

2 Table of Contents EZ-USB FX2 Development Kit Overview Introduction Tools Needed Required Tools Not Included Other Suggested Tools Final EZ-USB System Block Diagram Initial Download Process EZ-USB FX2 Development System Block Diagram Setting up the Development Environment EZ-USB FX2 Development Kit Contents Development Kit Contents EZ-USB Development Kit Software Beginning the Install Procedure Verifying that the host PC supports USB Installing the EZ-USB Control Panel, Drivers and Documentation Installing the Hardware Confirm Successful Installation using the Control Panel EZ-USB FX2 Development Board Introduction Schematic Summary Jumpers EEPROM Select & Enable Switches SW1 and SW Interface Connectors ATA Connector P8 (Subject to Change) CPLD (U2) Memory Maps I2C-Compatible Expanders Indicators Power and Breakpoint General Purpose Indicators Frequently Asked Questions Appendix A: U2 (CY37064) Verilog code (file is fx2rev1.v ) Appendix B: U2 (CY37064) Warp.ctl file

3 Getting Started 1.0 EZ-USB FX2 Development Kit Overview 1.1 Introduction The Cypress Semiconductor EZ-USB FX2 is a compact integrated circuit that provides a highly integrated solution for a USB peripheral device. Three key EZ-USB FX2 features are: The EZ-USB family provides a soft (RAM-based) solution that allows unlimited configuration and upgrades. The EZ-USB Fx2 delivers full and high speed USB throughput. The EZ-USB family does much of the USB housekeeping in the EZ-USB core, simplifying code and accelerating the USB learning curve. To help reduce the development time and learning curve for making a USB peripheral using the Cypress Semiconductor EZ-USB device, Cypress provides the EZ-USB Development Kit which this manual describes. The Cypress Semiconductor EZ-USB family provides significant improvements over other USB architectures including an enhanced 8051 core, 4 or 8 Kbytes of RAM, and an intelligent USB core. The family includes many different products to accommodate the needs of different systems. The enhanced 8051 core provides ten times the performance of the standard 8051, while maintaining 8051 software compatibility. With on-chip RAM, firmware code can be downloaded from the host PC. This allows the peripheral manufacturer to easily modify and transfer new code to current and new users. This on-chip memory eliminates the need for external memory in many systems. The EZ-USB FX2 members of the family extend this impressive feature list even further. The EZ-USB family provides a slave FIFO interface for connecting to 8 or 16-bit external microprocessors, FIFOs, or ASICs. This interface supports asynchronous and synchronous interfaces without external glue logic. All EZ-USB devices are software-compatible. EZ-USB Development Board Page -1

4 EZ-USB FX2 Development Kit Manual - Getting Started 1.2 Tools Needed The following list shows the components supplied in the EZ-USB FX2 Development Kit. They represent most of the development tools required to build a USB system. EZ-USB FX2 Development Board EZ-USB FX2 Prototyping Board ( Breadboard ) EZ-USB Firmware Library and Firmware Frameworks EZ-USB General-Purpose Device Driver EZ-USB Driver and Firmware Sample Code Cypress Loader Driver sample code and driver EZ-USB Control Panel EZ-USB FX2 Documentation Reference Schematics K Limited C Compiler from Keil Software K Assembler from Keil Software K Limited Debugger from Keil Software Required Tools Not Included Full retail Keil Development System (Keil uvision2) Microsoft Visual C++ (all PC sample code is developed under this platform) Microsoft WDM DDK (available free on Microsoft s website) Windows 98 PC Other Suggested Tools Numega Softice for PC driver debugging CATC USB Protocol Analyzer Page -2 EZ-USB FX2 Development Kit Manual - Getting Started Rev 1.3

5 1.3 Final EZ-USB System Block Diagram Your final USB application will contain a few major pieces: A custom Windows USB device driver or a class driver included with the OS The standard Windows or Apple USB drivers EZ-USB Application firmware An (optional) custom Windows USB application program. Figure 1-2 shows a typical EZ-USB Peripheral application block diagram. USB-Capable computer Windows Host USB Device Application Program Your Custom USB Device Driver EZ-USB USBD.SYS 8051 Application Firmware USB Bus Figure 1-1. Final EZ-USB System Block Diagram. 1.4 Initial Download Process The EZ-USB family provides a soft (RAM-based) solution that allows unlimited reconfiguration and upgrades. In order to accomplish this, your system must go through an initial download process before your final application is running. The following example describes in detail the steps that a host and EZ-USB-based device perform when the device is plugged into a USB bus. EZ-USB Development Board Page -3

6 EZ-USB FX2 Development Kit Manual - Getting Started This example is for renumerating operation, that is, where the host downloads the 8051 code. There are many variations to this scheme for special applications, such as loading the 8051 code from an external EEPROM. See the EZ-USB FX2 TRM for more details. 1. Power is applied to the device from the USB bus. 2. The Reset circuit holds the EZ-USB chip in Reset briefly until the PLL (Phase Lock Loop) locks to the 24 MHz oscillator, at which time the EZ-USB chip emits a stable CLKOUT (24 or 48Mhz). 3. The Cypress Core detects an EEPROM plugged into the I 2 C-compatible bus. The Core reads the VID and PID from the EEPROM and overwrites its hardwired VID and PID. (Refer to the FX2 Technical Reference Manual.) 4. The Host detects that the device is plugged in and asks the device for its IDs (via a GetDescriptor request to the Core s Endpoint 0), most importantly Vendor ID (VID) and Product ID (PID). The device responds with IDs that represent your non-downloaded device: (Vendor=XYZ Corp, Product=GIZMOLOADER). 5. The Host PC sees these IDs and knows to load your Loader Driver (based on the EZLOADER example in the Driver directory on the CD). 6. Your Loader Driver performs a Cypress download of the embedded 8051 firmware into the EZ-USB chip. 7. The Loader Driver then releases the Reset of the EZ-USB 8051 processor and your firmware application code starts running. 8. Your 8051 firmware electrically disconnects the EZ-USB from the USB bus. 9. The host, seeing the original device disappear, discards the Loader Driver from host memory. 10. Your 8051 firmware reconnects the EZ-USB to the USB bus. 11. The Host detects that your device is plugged in and asks the device for its IDs. 12. The 8051 firmware responds with IDs that represent a your fully downloaded and configured device: (Vendor=XYZ Corp, Product=GIZMO). 13. The Host PC sees these IDs and knows to load a Class Driver or your Custom Device Driver (based on the Generic Driver example). 14. The Host Driver and EZ-USB firmware are now loaded and running and perform the data transfers and control functions necessary for your application. You may also have a Windows application that calls your device driver that sends and receives data. 1.5 EZ-USB FX2 Development System Block Diagram During system development, the EZ-USB system looks slightly different than your final system. The development environment provides debugging tools for the system under development. In order to accomplish this, a Monitor program is first downloaded and run in the EZ-USB 8051 processor. Then, using the Keil Debugger, you can load programs and debug your firmware application by single stepping and setting breakpoints. Once your firmware is loaded, the Cypress Control panel (which uses the Windows USB driver) allows you to generate USB traffic to test your USB control firmware. Page -4 EZ-USB FX2 Development Kit Manual - Getting Started Rev 1.3

7 USB-Capable computer Windows Host USB Device Anchor's EZ-USB Control Panel Application Anchor's EZ-MON Device Driver (knows how to download the monitor to the board via USB) USBD.SYS EZ-USB Your Application Firmware (loaded by the monitor via a serial port on the board) Keil Monitor/Debugger (downloaded by the EZ-MON Driver) Plugging in the Development board (with development board Vendor, Product, and Device ID's) signals host to load the EZ-MON driver USB Bus Figure 1-2. EZ-USB Development Kit System Block Diagram. 1.6 Setting up the Development Environment The following list outlines the steps needed for setting up and using the development environment. The Host detects that a USB device has been plugged in and asks the device for its IDs The device responds with IDs that indicate a Cypress non-downloaded Development Kit device: (Vendor Cypress Semiconductor, Product EZ-USB Development Kit) The Host PC sees these IDs and knows to load the EZMON Driver (this driver knows how to download the Keil Monitor program to the EZ-USB Development Board). The EZMON Driver performs a Cypress download of the Keil Monitor firmware to the embedded 8051 RAM outside of the EZ-USB chip. The EZMON Driver then releases the Reset of the EZ-USB 8051 processor and starts the Keil Monitor code running. The green light on the development board turns on when the Keil monitor firmware is running. Once the Keil Monitor is running, you run the Keil Debugger on the Host computer and download your application code using the serial port on the Development Kit board to the 8051 RAM, either internal or external (but not on top of the Monitor). The Keil Debugger then starts running your Application firmware, allowing you to set breakpoints and single step. From here, your 8051 Application firmware is running. EZ-USB Development Board Page -5

8 EZ-USB FX2 Development Kit Manual - Getting Started Your 8051 firmware Disconnects the EZ-USB from the USB bus The host, seeing the EZ-USB Development Kit device disappear, discards the EZMON Driver from host memory. Your 8051 firmware Reconnects the EZ-USB to the USB bus The Host detects that your device is plugged in and asks the device for its IDs The 8051 firmware responds with IDs that represent a your fully downloaded and configured device: (Vendor XYZ Corp, Product GIZMO) The Host PC sees these IDs and knows to load your Custom Device Driver (based on the Generic Driver example). The Host Driver and EZ-USB firmware are now loaded and running and perform the data transfers and control functions necessary for your application. You may also have a Windows application that calls your device driver that sends and receives data. 2.0 EZ-USB FX2 Development Kit Contents The EZ-USB Fx2 development kit provides a complete hardware and software solution for accelerating the firmware and device driver development for all the members of the EZ-USB family. Other USB development kits use emulation of the eventual USB device. The EZ-USB Fx2 developer kit uses the actual device during the entire development. 2.1 Development Kit Contents Hardware EZ-USB FX2 Hardware Developer Board Shielded A-B USB Cable Breadboard RS-232 Cable Software on CD-ROM Custom Software Utilities & Documentation EZ-USB HTML Tutorial USB Control Panel USB Generic Driver Page -6 EZ-USB FX2 Development Kit Manual - Getting Started Rev 1.3

9 Source file for USB Generic Driver USB Generic Driver Documentation EZ-USB Loader Driver Example Source file for EZ-USB Loader Driver EZ-USB Loader Driver Documentation EZ-USB Firmware Library EZ-USB Applications Framework Source file for Firmware Frameworks and Firmware Library 8051 Example Code Getting Started Manual EZ-USB Control Panel User's Guide 8051 Firmware Library Documentation EZ-USB FX2 Technical Reference Manual Keil Development Tools (4K Limited Edition) Compiler Assembler Linker Debugger Monitor Documentation and User Guide 3.0 EZ-USB Development Kit Software 3.1 Beginning the Install Procedure Start by collecting the following materials: Installation CD. The EZ-USB FX2 Development Board. EZ-USB Development Board Page -7

10 EZ-USB FX2 Development Kit Manual - Getting Started USB A-B Cable. A Development Platform (PC) with USB support. imac Note: The EZ-USB Development kit is designed to work only on a Windows based PC. If you are developing on an imac, please go to and download the imac Development for EZ-USB application note. 3.2 Verifying that the host PC supports USB Identify that USB support is present on the development PC before proceeding. There should be at least one USB connector socket available on the PC chassis (a flat connector socket). The motherboard BIOS must contain USB support. Generally speaking, you must have one of the following operating systems which provide USB support. Note: Win 95 OSR2.1 (NOT supported) 1. Windows Windows 98 Second Edition (Recommended) 3. Windows 2000 (Recommended for USB 2.0 development) 4. Windows Millennium The OS version can be found in the registry at: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion -> VersionNumber To quickly determine if USB support is present on your PC, do the following: Select "Start\Settings\Control Panel". Double-click on the "System" icon. Select the "Device Manager" tab. You should see a "Universal Serial Bus Controller" icon with a USB Root Hub listed beneath it. If not, USB has been disabled in the BIOS, or there is no USB controller in the PC, or there is no USB support in your Operating System. 3.3 Installing the EZ-USB Control Panel, Drivers and Documentation Insert the installation CD into your CD ROM drive and run the program "setup.exe" by going to the start menu and running Setup.exe on the CD root directory. Page -8 EZ-USB FX2 Development Kit Manual - Getting Started Rev 1.3

11 You will see a menu of possible install options: Cypress Semiconductor EZ-USB Control Panel Keil K Development Tools Important Note: You must run the Setup.exe program once for every item you would like to install. The typical installation includes the Cypress Semiconductor EZ-USB Control Panel and the Keil K Development Tools. The Cypress Semiconductor EZ-USB Control Panel is a Windows program that allows sending and receiving of data over the USB to a Cypress Semiconductor EZ-USB FX2 chip. This selection also installs all of the sample code, examples, drivers and documentation. After you have clicked "Finish" to complete the Cypress Control Panel installation, you may run the application by selecting: "Start\Programs\Cypress\EzMr." The Control Panel application may be uninstalled completely by using the "Add/Remove Programs" component available in the Windows Control Panel under Win95/Win98. Keil K Development tools loads a Keil firmware development system onto your PC. This version can compile and locate up to 4K of code, but the code must be located above 4000h in the program memory space of the 8051, which means it must reside external to the EZ-USB FX2 onchip RAM. The Keil Development Environment allows you to compile C and assembly code for the 8051, link the object files and debug your program using the Monitor program included with the kit. The package includes the uvision C Source code development environment, and the dscope debugger. The Keil C compiler and linker are limited versions intended for evaluation and beginning development. You may need to restart your PC after installing the Keil software. For information on how to operate the Keil Development environment, refer to Keil manuals that come in the EZ-USB development kit. 4.0 Installing the Hardware The hardware installation procedure is simple and goes as follows: Connect the EZ_USB Development board to a USB port on your development PC using the USB cable. When the OS finds the new USB device, it will notify you that it is installing the driver. The driver, which was installed in the steps before, will be automatically located and loaded. EZ-USB Development Board Page -9

12 EZ-USB FX2 Development Kit Manual - Getting Started The green light (BKPT/Monitor) should illuminate, indicating that the 8051 Keil monitor code is loaded and running. The driver, ezusb.sys, was automatically installed into the Windows\System directory during setup of the Control Panel. An.INF file was also created in the Windows\INF directory 4.1 Confirm Successful Installation using the Control Panel Run the Control Panel application and perform a "Get Device Descriptor" operation by clicking the GetDev button. The control panel should display the response from the Development board shown below. The idvendor value of 0x4b4 is the Cypress Semiconductor vendor ID, and the idproduct value of 0x8613 identifies an un-programmed Fx2 chip. You may wish first to clear the screen by clicking the Clear button. The GetDev button may be clicked anytime, as many times as you wish. Opened Driver Successfully Device Descriptor: blength: 18 bdescriptortype: 1 bcdusb: 256 bdeviceclass: 0xff bdevicesubclass: 0xff bdeviceprotocol: 0xff bmaxpacketsize0: 0x40 idvendor: 0x4b4 idproduct: 0x8613 bcddevice: 0x1 imanufacturer: 0x0 iproduct: 0x0 iserialnumber: 0x0 bnumconfigurations: 0x1 More detailed instructions on this procedure are available in the first tutorial which can be viewed in the Help files from the application main menu. Start the EZ-USB Control Panel and then select "Help\Help Topics" and choose the topic, "EZ-USB Development Kit Manual", sub-topic EZ-USB Development Kit Tutorials." Page -10 EZ-USB FX2 Development Kit Manual - Getting Started Rev 1.3

13 5.0 EZ-USB FX2 Development Board 5.1 Introduction The Cypress Semiconductor EZ-USB FX2 Development Board provides a compact evaluation and design vehicle for the EZ-USB family. The board provides expansion and interface signals on six 20-pin headers. A mating prototype board allows quick construction and testing of USB designs. All ICs on the board operate at 3.3 volts. The board may be powered from the USB connector or an external power supply. The EZ-USB FX2 Development Board is supplied as part of the Cypress Semiconductor Fx2 Development Kit, which includes an evaluation version of Cypress-customized software development tools from Keil Software Inc. The Keil 8051 assembler, C and debugger work in concert with the development board to provide a complete code development environment. An 8051 debug monitor is typically loaded into development board expansion RAM to leave the internal RAM free for code development. Even though you can use only 4K of external RAM with the evaluation version of the Keil tools, the full retail version allows code of any size to be located anywhere. 5.2 Schematic Summary This description should be read while referring to the EZ-USB FX2 Development Board Schematic, Document Number CY7C NC, and the FX2 Development Board PCB silkscreen drawing. Both drawings are attached to the end of this document. U1 is the CY7C NC version of the FX2 part. This is the full-function FX2 chip which brings out the 8051 address and data buses for external memory expansion. U2, a re-programmable 3.3V Cypress CY37064 CPLD, provides RAM enable signals for four jumper-selectable memory maps. U3 is a 128 Kilobyte RAM, used for external 8051 memory expansion. Only 64K of this memory is addressed by the 8051; the A16 pin is connected to a CPLD output which is programmed to zero for all memory map selections. U4 is a 3.3V, 500 milliamp voltage regulator. U5 and U6 are socketed EEPROMS, used for FX2 initialization and 8051 general purpose access. U7 converts the 3.3V 8051 serial port signals to bipolar RS-232 levels. U8 and U10 are Philips PCF8574 IO expanders, which attach to the FX2 I 2 C- compatible bus and provide 8 general purpose input-output pins. U10 reads the four push-button switches S2-S5, and U11 drives the seven-segment readout U9. Six 20-pin headers, P1-P6, provide interface signals to the plug-in prototyping board supplied in this kit, as well as serving as connection points for HP(Agilent) logic analyzer pods. P7 is used to program the on-board CPLD using a Cypress ISR (In-System-Reprogramming) cable. P8 contains a subset of signals from P1-P6 on a connector that is pinned out for connection to a straightthrough ATA cable. EZ-USB Development Board Page -11

14 EZ-USB FX2 Development Kit Manual - Getting Started Two slide switches, SW1 and SW2, control the connection and selection of the two socketed EEPROMS at U5 and U Jumpers Table 1. FX2 Development Board Jumpers Jumper Function Default Notes JP1 Connects 3.3 volt power to the FX2 chip. IN (1-2) JP2 JP3 Powers the onboard 3.3 volt regulator from USB Vbus pin Connects four CPLD pins to LEDS D2,D3,D4,D5 IN (1-2) IN (1-2) (3-4) (5-6) (7-8) To operate the board in self-powered mode, remove JP2 and supply 4-5V to JP2-1, and GND to a ground pin (TP1 is a convenient GND point). U2, the onboard CPLD, contains code to use the four LED s as software settable indicators. If you wish to (a) use the CPLD pins for something else which requires re-programming the CPLD or (b) wire the general purpose indicators D2-D5 to other parts of the board, first remove the appropriate shorting plug(s). JP4 JTAGEN OUT At some later date, firmware and software may be available that allows the FX2 chip to program the U2 CPLD, rather than using the Cypress Download Cable (see P7 description). IO ports PC0,PC1,PC2, PC3 and PC4 are connected to the ISR programming socket P7 (through series resistors) for this purpose. NOTE: The JTAGEN signal, which is internally pulled down in U2, disables the four U2 programming pins to which PC0,1,2, and 4 are connected. Therefore removing JP4 floats these U2 pins and there is no interference with the PORTC connections. JP5 3.3 Volt Power IN (1-2) JP6 JP7 Memory map selection OUT (1-2) JP8 Wakeup2 Pin OUT (1-2) JP9 I 2 C-compatible bus test points n/a Supplies 3.3 volt power to the board. It may be removed and replaced with ammeter probes in series to measure board current. These jumpers select one of four memory maps for U3, the external 128 Kilobyte RAM. See the Memory Map section for details. Inserting a shorting plug into JP8 connects an onboard RC network (R42,C43) to the secondary remote wakeup pin WU2. This R-C network can be used to test periodic remote wakeup firmware when this dual-purpose pin (it defaults to PA3) is programmed as WU2. The I 2 C-compatible bus SCL and SDA lines may be monitored or externally connected using JP9. Page -12 EZ-USB FX2 Development Kit Manual - Getting Started Rev 1.3

15 5.4 EEPROM Select & Enable Switches SW1 and SW2 SW1 selects between two socketed EEPROMS, one strapped to address 000 (U6), and the other strapped to address 001(U5). SW2 enables or disables the EEPROM selected by SW1. The FX2 chip has various start-up modes, which depend on the existence of an EEPROM connected to its SCL and SDA lines. Switches SW1 and SW2 allow the EEPROMS to be disconnected from FX2, or to be connected using one of two EEPROMS installed in sockets U5 and U6. The FX2 chip contains two I 2 C-compatible controllers, a boot load controller, and an 8051 controller. The boot load controller operates when FX2 comes out of reset, and the 8051 controller operates under firmware control once the 8051 is running, permitting the 8051 to access generalpurpose I 2 C-compatible devices connected to the SCL and SDA lines. The discussion below deals with the roles of SW1 and SW2 in accommodating the various boot load mechanisms. The FX2 boot loader accommodates two EEPROM types, in Small and Large versions, as shown by Table 2. Table 2. Typical FX2 external EEPROMS EEPROM Type Size A2A1A0 Typical P/N Small 16x LC00 128x LC01 256x LC02 Large 8Kx LC64/5 Small EEPROMS are typically used to supply custom VID and PID information, allowing the FX2 to enumerate with a driver associated with your FX2 design. Large EEPROMS are typically used to boot-load code into internal FX2 RAM, and then start up the 8051 to execute this internal code which performs the enumeration. The FX2 loader determines the EEPROM size by first initiating an I 2 C-compatible transfer to address (1010 is the EEPROM class address, and 000 is the sub-address). If the device supplies an I 2 C-compatible acknowledge pulse, the FX2 loader writes a single EEPROM address byte to initialize the internal EEPROM address pointer to zero. If the above transfer does not return an ACK pulse, the FX2 loader initiates a second I 2 C-compatible transfer, this time to address (1010=EEPROM, sub-address 001). If an ACK is returned by the I 2 C-compatible-device, the FX2 loader writes two EEPROM address bytes to initialize the internal EEPROM address pointer to 0. EZ-USB Development Board Page -13

16 EZ-USB FX2 Development Kit Manual - Getting Started If neither transfer returns an ACK pulse, the FX2 loader boots in generic mode (explained below). Tree FX2 startup sequences, and the associated settings for SW1 and SW2, are shown below. 1. Generic : SW2=OFF, SW1=either position When no EEPROM is connected to SCL and SDA, the FX2 chip enumerates using its internal, hard-wired VID and PID values. This mode can be selected without requiring the removal of any socketed EEPROMS by switching SW2 to the off (down) position. This electrically disconnects any EEPROMS that occupy the EEPROM sockets U5 and U6. The OFF mode is handy for starting up FX2 in a manner (using internal VID/PID) that binds the development system board to the Cypress debug tools such as the Control Panel and Keil debug tools. Once running, SW2 can be switched to the ON position to allow 8051 access, for example to re-program the EEPROM. 2. C0 Load : SW2=ON, SW1=SMALL A C0 load provides FX2 with external VID, PID and DID values, allowing it to enumerate with the EEPROM-supplied VID/PID/DID. At power-on, if the FX2 chip detects an EEPROM with the hex value C0 as its first byte, it continues to load seven additional EEPROM bytes, which correspond to the USB Vendor ID (VID), Product ID (PID), Device ID (DID), and an FX2 configuration byte. Then when FX2 enumerates, it uses these EEPROM values rather than the hard-wired internal values. Since only eight bytes of data are required, a small EEPROM is generally used for this mode, for example the 16-byte 24LC C2 Load : SW2=ON, SW1=LARGE A C2 load provides a method for loading the FX2 internal RAM with 8051 firmware before enumeration. This boot load mechanism allows FX2 to enumerate as a fully custom device, since the 8051 code handles enumeration using VID/PID values embedded in the code. At power-on, if the FX2 chip detects an EEPROM with the hex value C2 as its first byte, it continues to load an FX2 configuration byte, followed by blocks of 8051 code. The last byte loaded takes the 8051 out of reset. This mode usually requires a large EEPROM, such as the 8 Kilobyte 24LC64. NOTE: If an EEPROM is connected to the SCL and SDA lines, but does not contain 0xC0 or 0xC2 as its first byte, the loader reverts to case 1, generic. In other words, the boot loader operates as though no EEPROM is connected. Once the 8051 is running, however, it has full access to any connected EEPROM, since the 8051 I 2 C-compatible controller is completely independent of the boot load logic. Page -14 EZ-USB FX2 Development Kit Manual - Getting Started Rev 1.3

17 5.5 Interface Connectors Table 3. Logic Analyzer Pinout Agilent Pod Pins CLK1 3 4 D15 D D13 D D11 D D9 D D7 D D5 D D3 D D1 D GND Six 20-pin headers P1-P6 on the FX2 Development Board have pins assigned to be compatible with HP (Agilent) logic analyzers, as shown in Table 3. The slight bulge in the middle rows of the table (pins 9 and 11) indicates the connector key. The six headers P1-P6 serve three purposes. They mate with the prototyping board supplied in the FX2 Development Kit. They allow direct connection of HP (Agilent) Logic Analyzer pods (Agilent P/N ). They allow general purpose probing by other logic analyzers or oscilloscopes. Table 3 shows the logic analyzer pod pin designations. The FX2 signals on P1-P6 are arranged to fulfill the following requirements: High speed FX2 strobe signals (PSEN, WR#, CLKOUT, IFCLK, and RD#) are connected to pin 3 of each of the five connectors P1-P6, so that they may be used as the logic analyzer clock CLK1. CLK2 is not used. Instead, each connector brings 3.3V power from the FX2 Development Board up to the prototype board using pin 2. The signals are logically grouped. For example, the 8051 address bus is on P5, and the FX2 FIFO data (which shares PORTB and PORTD pins) is on P1. Because the 20-pin headers on the prototyping board are stackable, it is possible to build custom circuitry on the proto board, plug the board into the FX2 Development board, and still plug logic analyzer pods into the six connectors P1-P6. EZ-USB Development Board Page -15

18 EZ-USB FX2 Development Kit Manual - Getting Started Tables 4-9 show the FX2 pin designations for P1 through P6. For dual-mode pins, the power-on default signal names are shown in bold type, and the alternate pin names are shown in the outside columns. {note: format all of them this way with default and alternate columns} Table 4. Alternate Default P1 Default Alternate N.C V PSEN# 3 4 PD7 FD[15] FD[14] PD6 5 6 PD5 FD[13] FD[12] PD4 7 8 PD3 FD[11] FD[10] PD PD1 FD[9] FD[8] PD PB7 FD[7] FD[6] PB PB5 FD[5] FD[4] PB PB3 FD[3] FD[2] PB PB1 FD[1] FD[0] PB GND Table 5. P2 N.C V N.C. 3 4 RDY1 SLWR SLRD RDY0 5 6 CTL5 CTL4 7 8 CTL3 FLAGC CTL CTL1 FLAGB FLAGA CTL PA7 FLAGD PKTEND PA PA5 FIFOADR1 FIFOADR0 PA PA3 WU2 SLOE PA PA1 INT1# INT0# PA GND Page -16 EZ-USB FX2 Development Kit Manual - Getting Started Rev 1.3

19 Table 6. P3 N.C V WR# 3 4 RDY5 RDY4 5 6 RDY3 RDY2 7 8 BKPT RESET# 9 10 N.C. N.C PC7 GPIFADR7 GPIFADR6 PC PC5 GPIFADR5 GPIFADR4 PC PC3 GPIFADR3 GPIFADR2 PC PC1 GPIFADR1 GPIFADR0 PC GND Table 7. P4 N.C V CLKOUT 3 4 GND OE# 5 6 CS# 5V 7 8 5V PLD PLD1 N.C D7 D D5 D D3 D D1 D GND Table 8. P5 N.C V IFCLK 3 4 A15 A A13 A A11 A A9 A A7 A A5 A A3 A A1 A GND EZ-USB Development Board Page -17

20 EZ-USB FX2 Development Kit Manual - Getting Started Table 9. P6 N.C V RD# 3 4 INT5# INT4 5 6 T2 T1 7 8 T0 WAKEUP# 9 10 SDA SCL PE7 GPIFADR8 T2EX PE PE5 INT6 RxD1OUT PE PE3 RxD0OUT T2OUT PE PE1 T1OUT T0OUT PE GND 5.6 ATA Connector P8 (Subject to Change) Table 10 shows the pinout for P8, a 40-pin connector that interfaces with a standard ATA cable. Note that a special cable is required for ATA, since the PB and PD signals are reversed. The final PCB release will correct this so a straight-through cable can be used. The PC Board to which Table 10 applies is marked PDC-9018 REV * and dated JUNE 00. Table 10. SUBJECT TO CHANGE. Applies only to PDC-9018, June 00 PCB. P8 (ATA) RESET# PA3 1 2 GND GND DD7 PB7 3 4 PD0 DD8 DD6 PB6 5 6 PD1 DD9 DD5 PB5 7 8 PD2 DD10 DD4 PB PD3 DD11 DD3 PB PD4 DD12 DD2 PB PD5 DD13 DD1 PB PD6 DD14 DD0 PB PD7 DD15 GND GND N.C. KEYPIN DMARQ RDY GND GND DIOW# CTL GND GND DIOR# CTL GND GND IORDY RDY GND CSEL DMACK# CTL GND GND INTRQ PC RDY1 RESERVED DA1 PC TV1 PDIAG# DA0 PC PC5 DA2 CS0# PC PC7 CS1# DASP# PC GND GND Page -18 EZ-USB FX2 Development Kit Manual - Getting Started Rev 1.3

21 5.7 CPLD (U2) U2, a Cypress CY37064 CPLD, provides the following functions: Decodes four different address maps for U3, a 128 Kbyte RAM. The four memory maps are selected using jumpers JP6(MM1) and JP7(MM0). Figure 1 illustrates the four memory maps. Drives four debug lights (LEDS at D2-D5). These lights are turned on and off when the 8051 reads certain external RAM addresses (see the General Purpose Indicators section). The lights are useful as software test points, since you can write 8051 code to turn them on and off at various points in your running program. Because the LED s are controlled by external RAM reads, their use does not disrupt RAM data that may happen to exist at the accessed locations. Provides seven uncommitted PLD IO pins. Two CPLD I/O signals are available to the plug-in prototype board on P4 (PLD1 and PLD2 signals), and five CPLD I/O signals are available on test vias (TV2-TV6). NOTE: A test via is a plated through hole that is annotated with a TVn silkscreen label. It is available for probing or connecting a small (30 gauge) wire. The CY37064 is in-system re-programmable using connector P7. P7 is pin compatible with the Cypress UltraISR download cable, part number 37KISR03, which connects P7 to a standard PC parallel port. Using Cypress Warp software, you can write new Verilog or VHDL code to customize the function of U2. Using the download cable, you can then erase and re-program U2 without removing it from the circuit. If you choose to do this, be sure to duplicate the equations dealing with memory map decoding to insure proper operation of the FX2 development board with the Keil software tools. NOTE: If you reprogram U2, be sure to set the Warp Compiler option to disable bus hold. Do this by navigating to the Compiler Options window and checking the Disable Bus-Hold box. This is necessary to prevent the bus hold circuitry from holding the FX2 RESET# pin low when the reset pushbutton S1 is released. Appendix A is a listing of the Verilog code programmed into U2 for the standard FX2 Development Board. Appendix B is the control file that locks the pins to the development board layout. EZ-USB Development Board Page -19

22 EZ-USB FX2 Development Kit Manual - Getting Started 5.8 Memory Maps 0xFFFF Factory Default 24K gap Ext Flash Single Chip on-chip off-chip on-chip off-chip on-chip off-chip on-chip off-chip 64K Ext RAM Code & Data 32K Ext RAM Code & Data 64K Ext RAM Code 0x2000 0x0000 8K RAM internal C&D not used 8K RAM internal C&D 8K RAM internal Data 8K RAM internal C&D jumpers MM1: out MM0: out MM1: in MM0: out MM1: out MM0: in MM1: in MM0: in Figure 1-3. The four FX2 Dev Board memory maps. The CPLD sets EA=1 for the Ext Flash configuration only, enabling external code memory. The factory default is to have both MM1 and MM0 jumpers removed. This setting should be used for all development work using the Keil software tools. The default configuration provides 8 Kilobytes of on-chip code and data memory, plus 56 Kilobytes of external RAM. The 8051 begins execution from internal RAM (the CPLD sets EA=0). Note that even though there is an apparent overlap between the internal 8 Kilobytes and bottom 8 Kilobytes of the external RAM, FX2 disables RAM strobes for the bottom 8 Kilobytes, so there is no conflict. This FX2 decoding allows a standard 64 Kilobyte RAM to be used without requiring external decoding to inhibit access to the bottom 8 Kilobytes. The second column, 24K gap, enables the external RAM only for access to its upper 32 Kilobytes. This configuration is useful for systems that add external devices that require memorymapped access. As with the default configuration, the 8051 begins execution from internal RAM (the CPLD sets EA=0). Page -20 EZ-USB FX2 Development Kit Manual - Getting Started Rev 1.3

23 The third column, Ext Flash, allows a flash memory (or other ROM) to be connected to the 8051 bus. This is the only config that starts 8051 execution from external memory (the CPLD sets EA=1). Since external memory occupies the bottom 8K, the internal FX2 RAM is addressed only as data memory, instead of combined prog/data memory in the other three configurations. The fourth column, Single Chip, disables all external memory. This config is useful for testing final code to insure that it uses no external resources present in the development environment. 5.9 I 2 C-Compatible Expanders U8 and U10 are Philips PCF8574 I/O expanders. They connect to the I 2 C-compatible bus SCL and SDA pins, and provide 8 general-purpose input-output pins. U8 provides 8 output bits, connected to the seven-segment readout U9. U10 provides 8 input bits, four of which connect to pushbuttons S2-S5, and four of which are uncommitted. U8 connects to the 7-segment readout (U9) using the following bit assignments: bit 0 bit 4 bit 5 bit 6 bit 1 bit 2 bit 3 bit 7 U8 has the group address 0100, and is strapped to unit address 001. Therefore to write a value to the 7-segment readout, 8051 firmware sends a control byte of (the LSB indicates a write operation), followed by the data byte. U10 uses its I/O pins as inputs, connected to S2-S5 according to the following table: Bit Switch 0 S2 1 S3 2 S4 3 S5 U9 has the group address 0100, and is strapped to unit address 000. Therefore to read the switch values, 8051 firmware sends a control byte of (the LSB indicates a read operation), and then reads the data byte. EZ-USB Development Board Page -21

24 EZ-USB FX2 Development Kit Manual - Getting Started 5.10 Indicators Power and Breakpoint LED D1 is connected to the PCB 5 volt supply, which is normally supplied from the USB cable (VBUS pin). Alternatively, JP2 may be removed and external 5 volt power can be applied to JP2 pin 1. In either case, D1 indicates the presence of the 5 volt power. LED D6 is connected to the 3.3 volt voltage regulator output. LED D7 is connected to the FX2 BKPT (Breakpoint) pin, via the CPLD U2, which acts as a simple inverter/buffer for the LED. When using the Keil software development tools, this green LED indicates that the FX2 Development Board has enumerated, and the Keil monitor has loaded and started running General Purpose Indicators A portion of the CPLD (U2) decodes 8051 reads to certain external memory addresses to turn the four general-purpose indicators D2-D5 on and off. The following figure shows the positions of the four indicator LEDS, and a table of the external 8051 addresses which are read to turn them on and off. Note that the four jumpers above the LEDS must be installed to use this feature. These jumpers connect the LEDS to four CPLD outputs. NOTE: If you wish to use the LEDS for other purposes, for example to wire to other PC board signals for observation, first remove the shorting plug to disconnect the LED from the CPLD. The LED terminal is the bottom pin of the connector, and the CPLD I/O pin is the top pin. These 4 jumpers must be in place D5 D4 D3 D2 Indicator Turn ON by reading Turn OFF by reading D2 0x80-- 0x81-- D3 0x90-- 0x91-- D4 0xA0-- 0xA1-- D5 0xB0-- 0xB1-- Page -22 EZ-USB FX2 Development Kit Manual - Getting Started Rev 1.3

25 The low address byte is don t care. This means you can very efficiently add software test points using the following code: D5ON: mov MPAGE,#B0h ; turn D5 on movx a,@r0 ; dummy read ; D5OFF: mov MPAGE,#B1h ; turn D5 off movx a,@r0 ; dummy read This code example uses the bit indirect addressing mode. The MPAGE register (SFR 0x92) supplies the high address byte, and r0 supplies the low address byte. Register r0 does not require initialization since the low address byte is don t care for the LED decoding. To turn the LEDS on and off using C code, declare the external memory locations, and then read their values into dummy variables: xdata volatile unsigned char D5ON _at_ 0xB000; xdata volatile unsigned char D5OFF _at_ 0xB100; unsigned char dum; dum = D5ON; dum = D5OFF; // turn D5 on // turn D5 off EZ-USB Development Board Page -23

26 EZ-USB FX2 Development Kit Manual - Getting Started 6.0 Frequently Asked Questions Q1: What should I do first (after viewing the printed material from the box)? A1: Make sure the hardware works well enough to run the Tutorial. After software installation, plug in a Dev Board, then start "Cypress\USB\EZUSB Control Panel" and select "Help\Contents and Tutorial". The tutorial is short and worthwhile. Q2: What is the first example to try? A2: While following the tutorial, you will read the Device ID from the Development Board, and then load the dev_io example. It turns on the LED so you know that firmware has been loaded and runs OK. Q3: Where's a soft copy of the FX2 Getting Started? A3: Look at "C:\CYPRESS\USB\Doc\Fx2\FX2 Getting Started.PDF". Q4: Where's a soft copy of the FX2 Technical Reference Manual? A4: Look at "C:\CYPRESS\USB\Doc\Fx2\FX2 TechRefManual.pdf". This is a very well written and readable manual, and is the key reference you will want to use. Bring up the soft copy so you can search for the material you are most interested in very quickly. Q5: Where's the FX2 datasheet? A5: See "C:\CYPRESS\USB\Doc\Fx2\CY7C68013.pdf". Q6: Where's the FX2 Development Board schematic (pdf and Orcad files)? A6: See"C:\CYPRESS\USB\Hardware\Fx2\DEVBD REVx\" where "x" is the latest Rev. Q7: Where can I find the errata sheet(s)? A7: Look at: "C:\CYPRESS\USB\Doc\Fx2\Fx2 beta release notes.pdf" and "C:\CYPRESS\USB\Doc\Fx2\Fx2 Chip Errata.pdf" Q8: How do I to generate "myapp" from (frameworks)? A8: Create a (frameworks based) project folder by just copying the "fw" example folder (C:\CYPRESS\USB\Target\Fw\Fx2) to a new location (i.e. under "Examples") and then rename the folder to the new project name. Remove the.hex file, and.uv2 file. Rename periph.c to <NewPrj>.c, and then create a new uv2 project file. See: "C:\CYPRESS\USB\Doc\EZ-USB\General\Anchor Firmware FW.pdf". Page -24 EZ-USB FX2 Development Kit Manual - Getting Started Rev 1.3

27 Q9: Where's the GPIFTool located? A9: The GPIFTool allows you to implement a General Programmable Interface quickly. Start the tool by pressing the "G" button on the toolbar. There is documentation on how to use the tool by selecting: "Help\GPIF Tool User Guide" within the GPIF Tool. Q10: Where do I go to find out more about the General Purpose Driver? A10: See: "C:\CYPRESS\USB\Doc\EZ-USB General\EZ-USB General Purpose Driver Spec.pdf". Q11: Where can I find the GPD source code? A11: Look in: "C:\CYPRESS\USB\Drivers". Q12: Where can I find the source code for the EZUSB Control Panel? A12: See: "C:\CYPRESS\USB\Util\ezmr". Q13: How do I build an EEPROM image for burning my code? A13: See the tutorial for information about generating EEPROMs. Q14: Where can I get a summary of the registers? A14: See the register summary in the TRM. Q15: Are there any examples? A15: Yes, see the examples and readme files in the Examples folder. Q16: What's all this set environment stuff? A16: If you install into the default directory, "C:\CYPRESS\USB" then you can build and debug examples with the Keil uv2 project files provided. Since the project files have hard-coded paths in them, installing to a different, non-default directory location will break these project files. Also, there are build.bat files for the projects in the Example folders. In order to run the build.bat files from the command line, you need to set some paths and environment variables, which can be done for you by running the batch file C:\CYPRESS\USB\Bin\setenv.bat prior to typing "build". Again, if the Dev Kit software or Keil tools are installed to a nondefault location, you would need to modify the setenv.bat file. The setenv.bat also has directions on how to create a Start menu option to open an MS-DOS window with the correct environment set up. Q17: Which DB-9 do I plug my mon-51 cable into? A17: Use SIO-1 by default. There are other versions of the monitor in "C:\CYPRESS\USB\Target\Monitor". They can be loaded using the Control Panel. There are different versions which load internal or external, and use SIO-0 or SIO-1, as indicated by the name and the readme.txt file. EZ-USB Development Board Page -25

28 EZ-USB FX2 Development Kit Manual - Getting Started 7.0 Appendix A: U2 (CY37064) Verilog code (file is fx2rev1.v ) module fx2 (A,BKPT,nRES,nPSEN,CLKOUT,nRD,nWR,// Inputs from FX2 EA, // Output to FX2 MM1,MM0, // mem select jumpers TV2,TV3,TV4,TV5,TV6, // test vias LED2,LED3,LED4,LED5, // IO15,16,28,19 nramce,nramoe,nramwr,rama16, // outputs to RAM BKMONLED, // Breakpoint/Monitor LED (green) PLD1,PLD2); // gp outputs to P4-10,9 input [15:8]A; input BKPT,nRES,nPSEN,CLKOUT,nRD,nWR,MM1,MM0; output EA,TV2,TV3,TV4,TV5,TV6,LED2,LED3,LED4,LED5; output nramce,nramoe,nramwr,rama16,pld1,pld2,bkmonled; assign BKMONLED =!BKPT; assign TV2 = 0; // placeholders for your logic equations assign TV3 = 0; // a "TV" is a test via assign TV4 = 0; assign TV5 = 0; assign TV6 = A[15]&A[14]&A[13]&A[12]&A[11]&A[10]&A[9]&A[8]&CLKOUT; assign PLD1 = 0; // PLD1 and PLD2 go to the breadboard assign PLD2 = 0; // Define 4 external memory maps based on two jumpers MM1-MM0 // 00: Internal code/data mem at FFF // No external memory (FX2 single chip operation) // 01: Internal code/data mem at FFF // External code/data mem at 8000-FFFF // 10: Internal data mem at FFF // External code mem at 0000-FFFF, data mem at 2000-FFFF // 11: Internal code/data mem at FFF, (DEFAULT) // External code/data mem at 2000-FFFF assign RAMA16 = 0; wire a15 = A[15]; reg nramce,nramoe,nramwr,ea; // no bank switching // for Warp (MM1 or MM0 or nrd or npsen or nwr or a15) case ({MM1,MM0}) 2'b00: // no external memory begin nramce = 1; nramoe = 1; nramwr = 1; EA = 0; // Use internal prog mem at FFF end 2'b01: // 32KB pgm/data memory at 8000-FFFF begin nramce =!a15; // Top 32K only enabled nramoe =!(!nrd!npsen); // combined pgm & data memory nramwr = nwr; // FX2 gates nrd,nwr,npsen for outside access EA = 0; // Use internal prog mem at FFF end Page -26 EZ-USB FX2 Development Kit Manual - Getting Started Rev 1.3

29 2'b10: // 64K pgm, 56K data begin nramce = 0; // entire RAM enabled nramoe =!(!nrd!npsen); // combined pgm & data memory nramwr = nwr; // FX2 gates nrd,nwr,npsen for outside access EA = 1; // Use EXTERNAL prog mem at FFF end 2'b11: // 56K pgm, 56K data begin nramce = 0; // entire RAM enabled nramoe =!(!nrd!npsen); // combined pgm & data memory nramwr = nwr; // FX2 gates nrd,nwr,npsen for outside access EA = 0; // Use internal mem at FFF end endcase // This section demonstrates a nifty use for the uncommitted LED's 2-5. Turn them // on and off by doing memory reads to external RAM. For example: // // mov MPAGE,#80h // movx a,@r0 ; turns on LED2, and // mov MPAGE,#81h // movx a,@r0 ; turns off LED2 reg L2,L3,L4,L5; (negedge nrd or negedge nres) if (!nres) begin L2=1; L3=1; L4=1; L5=1; end else case (A[15:8]) 8'h80: L2=0; // LED2 on 8'h81: L2=1; // off 8'h90: L3=0; // LED3 on 8'h91: L3=1; // off 8'hA0: L4=0; // LED4 on 8'hA1: L4=1; // off 8'hB0: L5=0; // LED5 on 8'hB1: L5=1; // off endcase assign LED2 = L2; assign LED3 = L3; assign LED4 = L4; assign LED5 = L5; endmodule NOTE: The TV6 equation simply collects all unused input signals, so that Warp will include them in the.ctl file pin assignments. EZ-USB Development Board Page -27

30 EZ-USB FX2 Development Kit Manual - Getting Started 8.0 Appendix B: U2 (CY37064) Warp.ctl file This file locks the U2 pins to the proper signals on the FX2 Development Board. Copy this file to your Warp project directory, and Warp will fit any new design using these same pin assignments. --fx2rev1.ctl --Reserve JTAG pins for programming only, so the Warp compiler won't try to --use them. 1=TCK, 5=JTAGEN, 13=TMS, 21=TDO, 33=TDI. Attribute PIN_AVOID is "1,5,13,21,33"; Attribute PIN_NUMBERS of BKPT is "2" ; Attribute PIN_NUMBERS of nres is "3" ; Attribute PIN_NUMBERS of npsen is "4" ; Attribute PIN_NUMBERS of CLKOUT is "7" ; Attribute PIN_NUMBERS of TV4 is "8" ; Attribute PIN_NUMBERS of BKMONLED is "9" ; Attribute PIN_NUMBERS of PLD1 is "10" ; Attribute PIN_NUMBERS of PLD2 is "11" ; Attribute PIN_NUMBERS of TV5 is "12" ; Attribute PIN_NUMBERS of TV6 is "14" ; Attribute PIN_NUMBERS of LED2 is "15" ; Attribute PIN_NUMBERS of LED3 is "18" ; Attribute PIN_NUMBERS of A(8) is "19" ; Attribute PIN_NUMBERS of A(9) is "20" ; Attribute PIN_NUMBERS of A(10) is "22" ; Attribute PIN_NUMBERS of A(11) is "23" ; Attribute PIN_NUMBERS of A(12) is "24" ; Attribute PIN_NUMBERS of A(13) is "25" ; Attribute PIN_NUMBERS of nwr is "26" ; Attribute PIN_NUMBERS of nrd is "27" ; Attribute PIN_NUMBERS of A(14) is "29" ; Attribute PIN_NUMBERS of A(15) is "30" ; Attribute PIN_NUMBERS of MM0 is "31" ; Attribute PIN_NUMBERS of MM1 is "32" ; Attribute PIN_NUMBERS of LED4 is "34" ; Attribute PIN_NUMBERS of LED5 is "35" ; Attribute PIN_NUMBERS of TV3 is "36" ; Attribute PIN_NUMBERS of TV2 is "37" ; Attribute PIN_NUMBERS of EA is "40" ; Attribute PIN_NUMBERS of nramoe is "41" ; Attribute PIN_NUMBERS of nramwr is "42" ; Attribute PIN_NUMBERS of nramce is "43" ; Attribute PIN_NUMBERS of RAMA16 is "44" ; NOTE: In a Warp control file, Verilog vector variables (e.g. A[5]) must be written using parentheses (e.g. A(15)). Page -28 EZ-USB FX2 Development Kit Manual - Getting Started Rev 1.3