Mikrocontroller.net - Benutzerbeiträge [de]

Liste von FPGA Eval boards

2016-08-24T11:38:00Z

Stefan2: Lsite der ZTEX FPGA-Boards aktualisiert

Evalboards, bzw. "Starter-Kits", wie sie häufig bezeichnet werden, sind ein guter Ausgangspunkt für das Kennenlernen und eigene Entwicklungen. Diese boards sind meistens in grösseren Stückzahlen gefertigt und dienen den Herstellern zu Demonstrationszwecken, daher sind sie vergleichsweise billig.

Aufpassen muss man bei Drittanbietern, die auf EBAY verkaufen. Die dort angebotenen Kits kommen vielfach von noname Herstellern aus China, die zwar oft sehr viel Zubehör enthalten, aber nicht selten den jeweils kleinst möglichen FPGA einer Baureihe einsetzen. Diese sind dann nur zum Kennenlernen gut.

== Boards für Xilinx-FPGAs ==
Wichtig bei der Entscheidung, welches Board man nehmen sollte, ist die Verfügbarkeit von freier Software. Die kostenlose Webedition der Xilinx ISE ist für ausgewählte FPGA's zum Beispiel für nahezu alle Spartan3 + Derivate und für Spartan 6 LX4 bis LX75T verfügbar. Unterstüzte Typen sind dort gelistet: [http://www.xilinx.com/publications/matrix/Software_matrix.pdf]

=== Einige Boards tabellarisch===

{| border="1" class="wikitable sortable" id="fpgaevalboards"
|-
! Bezeichn.
! Preis (€)
! FPGA
! RAM (MByte)
! Flash (MByte)
! USB
! Ethernet
! RS-232
! µC
! Eingabe
! sonst.
|-
| [http://www.knjn.com/board_Xylo.html Xylo-L]
| 130
| XC3S500E
| -
| -
| 2.0
| 10base-T
| -
| LPC213x
| -
|
|-
| [http://www.xilinx.com/products/boards-and-kits/HW-SPAR3A-SK-UNI-G.htm Spartan3A Starter Kit]
| 189
| XC3S700A-FG484
| 32M x 16 DDR2 SDRAM
| 4 Mbit Platform Flash PROM, 32MB parallel Flash, 2-16 Mbit SPI Flash
| (JTAG)
| 10/100
| 1 In + 1 Out
| -
| 4 Taster, 1 Drehgeber, 4 Schalter
| 4-ch D/A, 2-ch A/D, Signal amplifier, Coolrunner CPLD, 100-pin expansion connector, Stereo mini-jack, 8 LEDs, 15-Pin VGA (4096)
|-
| [http://www.xilinx.com/s3estarter Digilent Spartan3e Starter Kit]
| 180
| XC3S500E, auch mit 1200er
| 64 DDR2-SDRAM
| 16
| (JTAG)
| 10/100
| 1 In + 1 Out
| -
| 4 Taster, 1 Drehgeber, 4 Schalter
| Coolrunner CPLD, LCD, 3-Bit VGA, PS/2
|-
| [http://www.digilentinc.com/Products/Detail.cfm?Nav1=Products&Nav2=Programmable&Prod=S3BOARD Digilent Spartan-3]
| 100
| XC3S200 XC3S400 XC3S1000
| 16 SDRAM
| -
| -
| -
| 1x
| -
| 4 Taster, 8 Schalter
| VGA, PS/2, 7seg
|-
| Digilent Atlys
| 399 (acad.: 199)
| XC6SLX45
| 16 (Cellular RAM)
| 16 (parallel) + 16 (SPI)
| 3x: USB prog. USB Host USB UART
| 10/100/1000 Marvel PHY
| 1x (virtueller COM-Port über USB)
| ... (USB HID Host)
| 5 Taster, 8 Schalter, X LEDs,
| Programmierbar über JTAG, USB Port oder USB Stick, Versorgung über Netzteil (5V), Clock: 100MHz, 1x PMOD Expansion, VHDC I/O-Port Connector
|-
| [[Digilent Nexys]]
| 100
| XC3S200/400/1000
| 16
| 4
| 2.0
| -
| -
| -
| 4 Taster, 8 Schalter
| 7seg, Programmierung & Stromversorgung über USB
|-
| [[Digilent Nexys 2]]
| 92 (121)
| XC3S500E (1200E)
| 16
| 16
| 2.0
| -
| 1x
| Cypress FX2
| 4 Taster, 8 Schalter, 8 LEDs, PS/2 Maus/Kbd.
| 4x7 Seg, Progr. & Versorg. über USB oder über Netzteil (5V-15V), VGA
|-
| Digilent Nexys 3
| 180 (acad.: 108)
| XC6SLX16
| 16 (Cellular RAM)
| 16 (parallel) + 16 (SPI)
| 3x: USB prog. USB Host USB UART
| 10/100 Ethernet PHY
| 1x (virtueller COM-Port über USB)
| PIC24FJ192 (USB HID Host)
| 5 Taster, 8 Schalter, 8 LEDs, USB Maus/Kbd.
| Programmierbar über JTAG, USB Port oder USB Stick, 4x7 Seg, Versorg. über USB oder über Netzteil (5V), 8bit VGA, Clock: 100MHz, 4x PMOD Expansion, VHDC I/O-Port Connector
|-
| [http://www.uxibo.de Uxibo]
| 88
| XC2S200E
| -
| -
| 1.1
| -
| -
| -
| 4 Taster, 8 Schalter
| VGA I/O, Videomux, dual PS/2, 7seg, Buzzer, IOs auf Pinleisten, dual-channel FTDI2232C, 48 MHz + prog. Oszillator, Programmierung & Stromversorgung über USB
|-
| [http://www.fpgaz.com/wiki/doku.php?id=fpgaz:usbp:hw FPGAz USBP]
| $135
| XC3S400
| -
| -
| 2.0
| -
| -
| Cypress FX2
| 2 Taster
| 8 LEDs, I2C-EEPROM
|-
| [http://www.cesys-shop.com/de/FPGA-Karten/Spartan-6/EFM02.html Cesys EFM02]
| 364
| XC6SLX45 oder XC6SLX150
| 256
| 16 Mb
| 3.0 SuperSpeed
| -
| -
| FX-3
| Leds
|191 I/O, USB 3.0 nach AMBA AXI4 bridge IP (via GPIF2), Referenz-Designs
|-
| [http://www.cesys-shop.com/de/FPGA-Karten/USBS6.html Cesys USBS6]
| 298
| XC6SLX16
| 128
| 16
| 2.0
| -
| -
| FX-2
| Drehschalter, Leds.
|115 I/O signale, einstellbarer IO Standard, zweiter USB Port (FT232), WIN 32&64 Bit und LINUX Treiber
|-
| [http://www.cesys-shop.com/de/FPGA-Karten/Spartan-3/EFM-01.html Cesys EFM01]
| 124
| XC3S500E
| -
| 4
| 2.0
| -
| -
| FX-2
| -
| 28 x 44mm, 50 I/O auf 2.54mm Stiftleiste, WIN und LINUX Treiber
|-
| [http://shop.trenz-electronic.de/catalog/product_info.php?products_id=456 Avnet Spartan 3A Evaluation Kit]
| 50
| XC3S400A
| -
| 16
| 2.0
| -
| -
| -
| -
| WIN und LINUX Treiber, 4 Sensortasten
|-
| [http://www.ct-lab.de FPGA-Karte aus dem c´t-Lab]
| 92
| XC3S400
| -
| SD-Kartenslot (Bitstream-File wird über µC ins FPGA geladen, Dateiauswahl via Systembus oder Panel oder fest einstellbar)
| via IFP-Karte und Systembus an µC
| via IFP-Karte und Systembus an µC
| via IFP-Karte und Systembus an µC
| ATmega644
| optionales Bedienpanel mit LCD-Display, Drehgeber und Taster
| Bestandteil des Laborsystems c´t-Lab der Zeitschrift c´t.
VGA-Buchse, SD-Kartenslot (u.a. auch zum Laden des FPGA). Preis für FPGA-Platine mit verlöteten SMD-Bauteilen und Teilesatz. Optionale Erweiterungskarten mit schnellen DACs, Eingangskomparator, SRAM, Echtzeituhr, PS/2, RS232 (am FPGA). Optionaler JTAG-Adapter.
http://www.ct-lab.de, http://www.segor.de, http://thoralt.ehecht.com/phpbb
|}

Weitere Details zu einigen Boards:

=== Avnet ===
==== Spartan 6 LX150T ====
* Spartan-6 FPGA LX 150T
* 64 bit, 66 MHz, 3.3 PCIe interface
* 32Mbit Flash Memory
* serielles EEproms
* 8 LEDs
* 4 SMD Drucktaster
* 10/100/1000 Intel Ethernet PHY (Intel)
* USB Controller Host
* Serial Interface RS 232
* Serial GB Transceiver Interface (GTP)
* SD-Card Slot
* 2 Stk SAMTEC FMC SteckPorts mit 160 Pins belegt
* Webseite: http://www.avnet.com
* Preis ca. €999,- (inkl MwSt.)
* Erhältlich solo und auch im S6 Video Kit sowie S6 Ethernet Kit
* optionales Zubehör: Videokarte DVI IO, Transceiver Kit,
* Auslaufmodell!! - Ist inzwischen nicht mehr verfügbar

==== Spartan-6 LX9 MicroBoard ====
* Spartan-6 LX9-2CSG324
* 64 MB LPDDR SDRAM
* 128 Mb Multi-I/O SPI Flash
* 10/100 Ethernet PHY
* USB-2-UART port
* On-board USB JTAG Schaltung
* Two 2x6 PMOD expansion ports
* Programmierbarer Taktgenerator
* USB-interface
* 4 User LEDs
* 4-fach DIP switch
* Reset und PROG buttons

=== Altium Evaluation Boards ===
Die Firma Altium hat verschiedene FPGA Evaluationbords entwickelt:
* Board EB1 (LiveDesign), obsolet; manchmal beim großen Versteigerer zu haben für ca. 100 EUR
* Board NB1 (Nanoboard 1), dürfte obsolet sein
* Board NB2, immer noch aktuell, mehrere Erweiterungskarten verfügbar, Kosten ca. 1.800 EUR
* Board NB3000, sehr gut ausgestattetes, kompaktes Board, Kosten ca. 340 EUR ~ 400 EUR, je nach FPGA-Familie. Erhältlich mit Altera, Xilinx oder Lattice-Chip

folgendes gilt für alle Altium FPGA Evaluation Boards:
* Kompatibel mit den LiveDesign-fähigen Entwicklungstools von Altium
* Die Altium-Software nutzt direkt die Programmier-Software des jeweiligen FPGA-Herstellers (nicht bei EB1)
* im Lieferumfang sind alle nötigen Kabeln und ein Netzteil, um mit dem entsprechenden Board loslegen zu können
* die Boards enthalten eine sogenannte "SoftDesign" Lizenz für Altium Designer, gültig 1 Jahr. Sehr große Software-Bibliothek, inkl. verschiedener 8Bit- und einem 32Bit-Softcore, mit passenden Compilern. Per JTAG sind auch eigene Boards programmierbar.

speziell für das nicht mehr erhältliche EB1 LiveDesign Board gelten folgende Punkte:
* Xilinx XC3S1000-4FG456C, wahlweise aber auch mit Altera EP1C12F324C8
* Peripherie: LEDs, Dip-Schalter, 6-stellige Siebensegmentanzeige, Taster, Stereo-DAC, zwei 256K x 16 RAMs
* ''kein'' on-board Flash RAM für FPGA-Konfiguration, diese muss nach dem Einschalten neu geladen werden
* Ports: PS2-Maus & -Tastatur, RS232, VGA (512 Farben), 2x18 IO-Pins für eigene Erweiterungen

=== CESYS ===
http://www.cesys.com

Cesys ist Entwickler und Hersteller von Xilinx FPGA-boards und all programmable soc boards mit Sitz in Herzogenaurach.

* Das Lieferprogramm beinhaltet boards mit USB, Ethernet, PCI und PCIe Schnittstellen.
* Je nach Ausführung mit Spartan, Virtex oder Zynq 7000 AP Soc.
* Es sind verschiedene Speichervarianten erhältlich: SO-DIMM, SRAM, SDRAM, LPDDR, DDR2, DDR3.
* Der Hersteller bietet kostenlose referenz-designs zum Download an.
* Sonderboards und Bestückungsvarianten nach Kundenwunsch.

=== Digilent ===
www.digilentinc.com
Digilent ist der Produzent der Standardboards von/für Xilinx. Siehe Tabelle.
==== Atlys ====
Das Atlys ist das aktuellste S6-Board von Digilent. Es enthält einen Spartan S6LX45, einen Marvel Alaska PHY, DDR2-SDRAM sowie auch SRAM sowie einen USB-Controller und Seriell-COM über USB. Auf das klassische VGA mit Widerständen wurde verzichtet. Stattdessen gibt es DVI/HDMI mit 2 Ein- und Ausgängen, davon sind 2 HDMI inputs und 1 HDMI output jeweils mit TMDS-buffern, sowie einen GP HDMI als Mini-D ohne jeglichen Buffer (als in oder output)

==== Nexys ====
siehe Tabelle oben

==== S3E ====
Das S3E Starterkit war das erste board für S3E. Es enthält standardmässig einen 500er Chip ist aber auch als 1500er erhältlich, was das mindeste für echte Entwicklungen ist. Es birgt einen 100MBi PHY, DDR2-RAM, Flash sowie sowie einen USB-Controller. VGA ist nur über 3 Pins realisierbar.
==== S3A ====
Das S3A Starterkit ist das aktuelle board für Spartan 3 FPGAs. Es enthält standardmässig einen GB-Phy, sowie einen USB-Controller. VGA ist über 12 Pins realisierbar.

=== Enterpoint ===
Enterpoint is ein Hersteller von FPGA-Boards in GB. Er bietet insbesondere Arrays mit mehreren FPGAs an. Siehe http://enterpoint.co.uk/

==== Raggedstone 1 - Spartan-3 PCI-Karte ====
* Spartan-3 FPGA FG456-Package
* 32 bit, 33 MHz, 3.3/5V PCI interface
* 4Mbit Flash Memory
* 16KBit serielles EEprom
* 4 x 7 Segment Anzeigen LED, abnehmbar
* LM75 Temperatursensor
* viele DIL-Header für eigene Erweiterungen, verschiedene werden auch durch Hersteller angeboten
* 2 Drucktaster
* Mit dem PCI-Interface kann bei entsprechender Programmierung des FPGA auf den PCI-Bus eines Hostrechners zugegriffen werden, Beispieldesign unter http://projects.varxec.net/raggedstone1
* Webseite: http://www.enterpoint.co.uk/moelbryn/raggedstone1.html
* Preis als Raggedstone1 RS1-400C £155.00 + £25 Versand -> ca 230 Euro inkl.

==== Raggedstone 2 - Spartan-6 PCI-Karte ====
* XilinxTM SpartanTM-6 FPGA, FGG484 package mit XC6SLX25T bis XC6SLX150T
* PCI Express Interface
* PCIe Gen1 (2.5 GBits-raw) interface
* 128Mbit SPI Flash Memory (configuration)
* 1 Gbit, X16, DDR3 SDRAM memory
* 1 x 16KBit serial EEprom
* LM75 Temperature Sensor fitted.
* DIL Header 68 I/O with LVDS support
* 4 digit LED - removable
* 4 LEDs.
* LVDS Clock Module Header
* 2 push switches fitted.
* Preis als Raggedstone2 RS2-45T £250.00 + £25 Versand

==== Merrick 1 - FPGA-Development Array ====
* 10 x 10 array mit Xilinx™ Spartan™-3A DSP XC3SD3400A-4CSG484C
* commercial -5 and industrial -4 grade
* auch mit XC3SD1800A alternativ bestückbar (free Webpack™ ISE™ software!)
* Controller FPGA – Xilinx™ Virtex™-5 XC5VLX30T.

==== Merrick 3 - Development Plattform mit 24 FPGAs ====
* 24 array FPGAs – mit entweder XC6SLX45, XC6SLX75, XC6SLX100 or XC6SLX150
* bis zu 180 DSP48 (18×18 multiplier + adder + accumulator) slices per FPGA
* bis zu 184K flip-flops
* bis zu 147K logic elemente
* bis zu 268 block SRAMs (18Kb) per array FPGA
* 16 DDR3 memories X16 interface at 625-800 Mbits/s

=== Trenz-Electronic ===
Trenz bietet im Bereich FPGAs vor allem Xilinx-Produkte an. Dazu zählen Eigenentwicklungen sowie der Vertrieb von Digilentboards. Siehe: http://www.trenz-electronic.de/products.html

==== Spartan 3E-Serie ====
* Kleines FPGA Board mit ucLinux und Virtex-II PowerPC, optional: ucLinux und Microblaze Softprozessor im Spartan-3 FPGA
* TE0320 (Spartan-3A DSP) Industrial Micromodule mit bis zu 18000 / 34000 Systemgattern
* TE0300 (Spartan-3E) Industrial Micromodule mit 200 bis 1000 Systemgattern
==== Spartan 6-Serie ====
* TE0630 (Spartan-6) Industrial Micromodule mit bis zu 150000 Gattern mit den Typen LX45, LX75, LX100 und LX150
* GigaBee XC6SLX (Spartan-6LX) Industrial Micromodule, Typen LX45, LX100 und LX150

==== Andere ====
* Pal/Gal kompatible FPGA und CPLD Module

=== Simple-Solutions ===
http://www.simple-solutions.de/de/products/index.php
Mehrere Spartan3-FPGAs - Boards

=== ZTEX ===

ZTEX ist Entwickler und Hersteller von FPGA-Boards mit Sitz in Deutschland. Die Homepage ist http://www.ztex.de.

Besonderheit bei ZTEX ist das quelloffene SDK für FPGA-Boards auf EZ-USB FX2 und FX3 Basis. Das SDK umfasst sowohl die Geräteseite (Firmware) als auch den Host (Host-Software). Die Firmware wird mittels Makrobefehlen konfiguriert und die USB-Deskriptoren (einschließlich der Endpoint-Deskriptoren) werden automatische erzeugt. Weitere Infos befinden sich auf http://www.ztex.de/firmware-kit/index.d.html

Eine weitere Besonderheit ist der DeviceServer (Bestandteil des SDK) welcher den Gerätezugriff via Web-Interface ermöglicht, siehe http://wiki.ztex.de/doku.php?id=en:software:deviceserver

==== Artix 7 USB-FPGA-Modul 2.16 ====
* FPGA-Board mit Xilinx Artix 7 XC7A200T FPGA (XC7A100T auf Anfrage)
* High-Speed (480 MBit/s) USB-Schnittstelle
* Cypress CY7C68013A EZ-USB FX2 Mikrocontroller
* 100 General-Purpose-I/O's (GPIO)
* On-Board Spannungsregler
* 128 MBit Flash-Speicher (z.B. für den Bitstream)
* 128+2 KBit EEPROM (z.B. zum Speichern von Firmware und Einstellungen)
* Schnelle FPGA-Konfiguration mittels CPLD
* Memory-Mapped-I/O zwischen EZ-USB FX2 und FPGA
* Open Source SDK mit vielen Bespielen
* Mehr Infos auf http://www.ztex.de/usb-fpga-2/usb-fpga-2.16.d.html

==== Artix 7 USB-FPGA-Modul 2.14 mit RAM ====
* Erhältlich mit 4 Artix 7 Varianten: XC7A15T, XC7A35T, XC7A50T, XC7A75T, XC7A100T
* '''USB 3.0 Schnittstelle via EZ-USB FX3 Mikrocontroller'''
* 100 General-Purpose-I/O's (GPIO)
* On-Board Spannungsregler
* 256 MByte DDR3 SDRAM
* 128 MBit Flash-Speicher (zum Speichern von Firmware und Bitstream)
* SD-Karten-Slot (SDIO wird unterstützt)
* 2 KBit EEPROM (zum Speichern von Einstellungen)
* Schnelle FPGA-Konfiguration mittels CPLD
* Open Source SDK mit vielen Bespielen
* Mehr Infos auf http://www.ztex.de/usb-fpga-2/usb-fpga-2.14.d.html

==== Artix 7 USB-FPGA-Modul 2.13 mit RAM ====
* Erhältlich mit 4 Artix 7 Varianten: XC7A35T, XC7A50T, XC7A75T, XC7A100T
* USB 2.0 Schnittstelle via EZ-USB FX2 Mikrocontroller
* 100 General-Purpose-I/O's (GPIO)
* On-Board Spannungsregler
* 256 MByte DDR3 SDRAM
* 128 MBit Flash-Speicher (z.B. für den Bitstream)
* 128+2 KBit EEPROM (z.B. zum Speichern von Firmware und Einstellungen)
* Schnelle FPGA-Konfiguration mittels CPLD
* Open Source SDK mit vielen Bespielen
* Mehr Infos auf http://www.ztex.de/usb-fpga-2/usb-fpga-2.13.d.html

==== Spartan 6 USB-FPGA-Modul 2.04 mit RAM ====
* FPGA-Board mit Xilinx Spartan XC6SLX16 FPGA
* High-Speed (480 MBit/s) USB-Schnittstelle
* Cypress CY7C68013A EZ-USB FX2 Mikrocontroller
* 96 General-Purpose-I/O's (GPIO)
* On-Board Spannungsregler
* 64 MByte DDR SDRAM
* 128 MBit Flash-Speicher (z.B. für den Bitstream)
* 128 + 2 KBit EEPROM (z.B. zum Speichern von Firmware und Einstellungen)
* Open Source SDK mit vielen Bespielen
* Mehr Infos auf http://www.ztex.de/usb-fpga-2/usb-fpga-2.04.d.html

==== Spartan 6 USB-FPGA-Modul 2.01 ====
* FPGA-Board mit Xilinx Spartan XC6SLX16 FPGA
* High-Speed (480 MBit/s) USB-Schnittstelle
* Cypress CY7C68013A EZ-USB FX2 Mikrocontroller
* 100 General-Purpose-I/O's (GPIO)
* On-Board Spannungsregler
* 128 MBit Flash-Speicher (z.B. für den Bitstream)
* 128 + 2 KBit EEPROM (z.B. zum Speichern von Firmware und Einstellungen)
* Open Source SDK mit vielen Bespielen
* Mehr Infos auf http://www.ztex.de/usb-fpga-2/usb-fpga-2.01.d.html

== Boards für Altera-FPGAs ==

Bei Altera ist die kostenlose Webversion von Quartus für kleine Stratix und die meisten Cyclone verfügbar.

=== Gleichmann Research ===

==== Hpe Mini AC II - Cyclone II board ====
* Altera Cyclone II EP2C35 FPGA (speed grade 6)
* Mit reprogrammierbarem Flash zur automatischen FPGA-Konfiguration
* 25 pin SUB-D connector (parallel) für direktes FPGA-Programmieren
* RS232 (9 pin SUB-D)
* VGA (15 pin SUB-D) mit 64 möglichen Farben
* Ethernet 10/100 Mbit/s, full/half duplex
* 1 USB 2.0 compatible full-speed target connector
* 3 USB 2.0 compatible full-speed host connectors
* Santa Cruz connector mit 40 nutzbaren I/Os
* Audio interface (line-in and line-out) mit CODEC
* SODIMM144 Sockel für (SDRAM) 256MB
* SDRAM-Speichersockel mit nur 32-Bit angebunden, die Hälfte des Speichers bleibt nicht nutzbar
* 25 MHz oscillator
* Prototyping area, Lötfläche
* 8 LEDs, grün, blau, 3x4 key matrix, 4-bit DIP switch
* LCD connector, 2-character 7-segment display
* Single step Knopf und Reset Knopf
* Parallelportkabel für PC
* Beispieldesign, Testprogramme, Datenblätter
* LEON3-CPU Design inkl. Source Code, Quartus IDE, SnapGear Linux
* Bilder http://www.96khz.org/htm/gleichmann%20hpe%20mini%20audio%20and%20music%20workstation.htm
* Der auf dem FPGA verbaute Chip Cyclone II wird in der neuesten Alteraversion nicht mehr unterstützt
* Nicht mehr im Programm - war ca 399,-
* Die neueste Version des Boards dieses Herstellers unterstützt Lattice

====HM-ALC-AS3====
* Modul mit zwei Altera Stratix™ III EP3S50F780-C2N FPGA oder EP3S150F780-C2N
* 126 single ended interconnections plus 28 LVDS pairs
* ALTERA USB Blaster® on board
* temperature controlled fan's(PWM)

=== Terasic ===
Terasic ist sozusagen der Haus- und Hoflieferant für Entwicklungsboards von Altera. Praktisch alle Altera Boards werden von Terasic (Taiwan) gebaut.

==== Altera Cyclone II 2C20 ====
* Altera Cyclone II EP2C20F484C7N FPGA mit 20000 LEs
* USB-BlasterTM download cable (integriert)
* EPCS4 serial configuration Flash
* 8-Mbyte SDRAM, 512-Kb SRAM, 4-Mbyte flash
* externer SMA - Clock-Eingang
* 24-bit Audio coder/decoder (CODEC)
* 10 Schalter, 4 Druckknöpfe inkl Reset
* 4St. 7-Segmentanzeigen, 10 rote LEDs + 8 grüne LEDs
* VGA, RS-232, and PS/2 Stecker
* Zwei 40-pin expansion ports + SD/MMC socket
* USB-Kabel, externes Steckernetztteil, CD-Rom
* Reference designs
* Qartus II Web Edition + NIOS II Web Edition
* http://www.altera.com/products/devkits/altera/kit-cyc2-2C20N.html
* Listenpreis $150,-

==== Altera DE2 - Development and Education Board V2 ====
* Altera Cyclone II 2C35 FPGA mit 35000 LEs
* Altera Serial Configuration devices (EPCS16) für Cyclone II 2C35
* USB Blaster board zur Programmierung und User API
* 8 MB SDRAM, 4 MB Flash Memory, 512KB SRAM
* SD Card Sockel, RS-232, Ethernet, 10-bit VGA, 24-bit Audio CODEC
* TV Decoder (NTSC/PAL), IrDA, USB (Host + Slave)
* Viele Besipiel mit Source Code wie TV, SD Music Player)
* [http://www.fh-wedel.de/fileadmin/mitarbeiter/bos/files/VHDL/VhdlEinfuehrung.pdf Kleines aber nettes Tutorial zum Altera DE2 Dev. Board]
* Listenpreis US $495,-

==== Altera DE2-115 - Development and Education Board V3 ====
* Altera Cyclone IV FPGA mit 115000 LEs
* Altera Serial Configuration device EPCS64
* USB Blaster zur Programmierung und für User API
* User-Applikations und Steuerungssoftware
* 128 MB SDRAM, 8 MB Flash Memory, 2 MB SRAM
* SD Card Sockel, RS-232, 2x GBit-Ethernet,
* 8-bit VGA, 24-bit Audio CODEC
* TV Decoder (NTSC/PAL), IrDA, USB (Host + Slave)
* 18 Schalter, 4 Drucktasten, PS2-Maus/Tastatur-Anschluss
* 27 LEDs, 16x2-LCD-Display, 8 7-Segment-Anzeigen
* IR-Fernsteuerung
* HSMC-Stecker
* Viele Beispiele mit Source Code wie TV, SD Music Player, Audiorecorder
* Listenpreis US $595,- (academic = $299,-)

==== Cyclone III Embedded Development Kit ====
* Altera Cyclone III EP3C25 FPGA
* 640x480 LCD Display mit Touchscreen-Function
* MiniSD-Card Sockel
* Audio Interface ADC CODEC
* 10/100 Mbit Fast Ethernet Schnittstelle
* FPGA-Konfiguration über USB
* NIOS II EVAL Lizenz
* IP LIB Altera
* Listenpreis US $495,- über Altera Webseite
* Bei EBV €349,- inkl. MwSt.

==== DE0-Nano ====
* Cyclone IV EP4CE22F17C6N
* 32MB SDRAM
* 2Kb I2C-EEPROM
* 64Mb (8MB) SPI-Flash
* 3-Achsen-Beschleunigungssensor ADXL345 (Analog Devices)
* AD-Wandler ADC128S022 (National Semiconductor)
* Zwei 40-Pin-GPIO-Header mit 72 verfügbaren IO-Pins, ein 26-Pin-Header mit 16 digitalen GPIOs und 8 ADC-Inputs
* On-Board-USB-Blaster zum Programmieren/Debuggen
* Herstellerpreis (www.terasic.com.tw): $79,- (für Studenten: $59,-)
* erhältlich bei Digikey

=== devboards GmbH ===
==== DBM-SOC2 Cyclone V SoC Dimm Modul====
http://www.devboards.de/de/startseite/boards/produkte-details/article/dbm-soc2/
* Cyclone V SoC 20K oder 40KLE
* 1Gbyte DDR3 Memory
* 256Mbit Konfigurations Flash
* 4Gbyte eMMC oder SDKarte
* Gigabit Ethernet
* USB OTG
* RTC
* 152 IO Pins
* DIMM 200 Formfaktor
* Made in Germany
* [http://devboards.de/home/boards/product-details/article/dbm-soc2-base1 Basisboard verfügbar]

=== Andere ===
==== FPGA-DEV====
www.fpga-dev.de
* Altera Cyclone II EP2C35F484C6N
* DIMM - Sockel
* Flash
* Erweiterungssockel
* nicht mehr hergestellt

==== Sasco Holz PABLO ====
* Altera Cyclone II EP2C20F484C6N
* EPCS16SI16N serial configuration Flash
* 2x32 MByte mDDR-333 RAM (unabhängige Daten-/Adressbusse)
* externer SMA-Clock-Eingang
* 25 MHz Oszillator
* 3 Taster, kleiner Joystick, 4 LEDs
* AD7843 SPI touch controller
* RS-232
* 2x Santa Cruz connector
* 60-Pin TFT, 14-Pin GPIO Wannenstecker
* 10-Pin JTAG & 10-Pin Passiv Seriell Wannenstecker
* Netzteil, CD-ROM
* [http://web.archive.org/web/20080907191153/http://www.sascoholz.com/designsupport/solutions/pablo http://www.sascoholz.com/designsupport/solutions/pablo]
* kein Programmierkabel, kein Kaltgerätekabel
* Restmengen hin und wieder günstig beim großen E

== Boards für Lattice-FPGAs ==
=== LatticeXP2 Brevia Development Kit ===
* FPGA: LFXP2-5E-6TN144C (non-volatile Konfiguration!)
* 2 MBit SPI-Flash, 1 MBit SRAM
* JTAG-Interface, RS232 (Sub-D-Buchse)
* Pinleisten: 2x20 und 2x5
* 4 Taster (+1 Reset-Taster), 4 DIP-Schalter, 8 LEDs
* Inkl. parallelem ISP-Download-Kabel, seriellem Nullmodem-Kabel, 6V/1A-Schaltnetzteil
* Offizielle [http://www.latticesemi.com/products/developmenthardware/developmentkits/xp2breviadevelopmentkit.cfm Produktbeschreibung von Lattice]
* Lieferant: [http://de.mouser.com/ProductDetail/Lattice/LFXP2-5E-B2-EVN/?qs=sGAEpiMZZMtvzEnwIFtdJf1kwhjc34f7 Mouser Electronics] 40,43 Euro +MwSt. (Lieferung nach Deutschland ohne zusätzliche Kosten problemlos möglich)
* Software kostenlos bei [http://www.latticesemi.com/products/developmenthardware/developmentkits/xp2breviadevelopmentkit.cfm Lattice] (Quick-Start, User's Guide, EDA, Reference Designs, 8-/32-Bit Soft-Cores Mico8/Mico32 etc.)
=== Weitere ===
* www.hardware-design.de
* bietet verschiedene einfache Boards mit Lattice-Bausteinen an
* FPGA-Board mit XP2-17/XP2-8/XP2-5 -> 113,- bis 101,- Euro
* CPLD-Boards u.a. mit MachXO640 -> 89,- Euro

== Weblinks ==

* [http://papilio.cc/ Papilio FPGA]: Ein Arduino-kompatibles (aber nur 3.3V I/O) FPGA Board mit Spartan 3E, recht große Community, viele Beispiele
* [http://pin4.at/pro_misc.php#fdil Projekt "FDIL v2"]: sehr kleines 5V DIL-Ersatz Board mit Xilinx Spartan II FPGA, open-source, keine Levelshifter erforderlich! (Englisch)
* [http://www.trenz-electronic.de/de/produkte/fpga-boards/oho-elektronik.html GODIL]: etwas größeres DIL Board mit Xilinx Spartan 3E und 5V Levelshifter (bidirektional, "open-drain-like") von Trenz Elektronik beziehbar

[[Kategorie:FPGA-Boards]]
[[Kategorie:Listen]]

[[Kategorie:FPGA_und_Co]]

ZTEX USB- und USB-FPGA-Module

2014-04-11T07:48:41Z

Stefan2: Tippos, Link korrigiert

Die Firma [http://www.ztex.de/index.d.html ZTEX] produziert und vertreibt unter Anderem USB- und USB-FPGA-Module mit EZ-USB Mikrocontroller zum Einsatz in Prototypen, Kleinserien oder als Entwickler bzw. Experimentierboard.

Alle Module haben die Eigenschaft, dass sie dem Entwickler einen schnellen Einstieg ermöglichen. Dies wird durch das auf einem Makro-Ansatz basierende
[http://www.ztex.de/firmware-kit/index.d.html Firmware-Kit] ermöglicht.

Dieser Artikel soll schwerpunktmäßig einen Überblick über die Vorteile und Eigenschaften des Firmware-Kits liefern. Dies ist auch für Benutzer anderer EZ-USB basierter Hardware (einschließlich FPGA-Boards) interessant, da das Firmware-Kit quelloffen und nicht an eine bestimmte Hardware gebunden ist. (Der EZ-USB Controller anderer Boards wird normalerweise ohne Anpassungen des Firmware-Kits unterstützt, für die Programmierung von FPGA's müssen normalerweise zusätzliche Routinen ergänzt werden.)

Wer nach der Lektüre dieses Artikel Interesse an dem Firmware-Kit hat, kann
kann beim [[EZ-USB_Firmware_Kit_-_Tutorial | EZ-USB Firmware Kit - Tutorial]] weiterlesen.

Um diese Wiki nicht mit allzu vielen redundanten Informationen zu fluten, werden die ZTEX-Module, für welche das Firmware-Kit schwerpunktmäßig entwickelt wurde, am Ende dieses Artikels zusammengefasst vorgestellt.

==Firmware-Kit==
Für den EZ-USB FX2 Mikrocontroller steht ein quelloffenes Firmware-Kit mit plattformunabhängiger Treiber API zur Verfügung.

Die allgemeinen (Modul-unabhängigen) Grundfunktionen sind
* Hochladen der Firmware direkt in den EZ-USB Mikrocontroller
* EEPROM-Interface zum Lesen / Scheiben von Daten in den / aus dem EEPROM-Speicher
* Hochladen der Firmware in den EEPROM

Diese Funktionen werden firmwareseitig mittels Endpoint 0-Interfaces und dazugehörigen Routinen realisiert, welche automatisch in die mit dem Firmware-Kit entwickelte Firmware eingebunden werden. PC-seitig können diese Interfaces mit einem Werkzeug angesprochen oder mittels der Treiber-API in eigene Programme eingebunden werden.

Um einen schnellen Einstieg in die Entwicklung zu ermöglichen, wird die Firmware mittels eine Makro-Prozessors zusammengebaut. Dieser ermöglicht es Beispielsweise, die Endpoint-Konfiguration mittels weniger Makros (ein Makro pro Endpoint) festzulegen. Alle notwendigen Device-Deskriptoren sowie die notwendigen Routinen zur Ausgabe der Deskriptoren werden vom Firmware-Kit automatisch erstellt.

Im Normalfall kann sich der Entwickler also auf seine selbst benötigten Funktionen konzentrieren und sich ein exzessives Studium der Datenblätter zumindest teilweise ersparen. Der Quelltext einer typischen Firmware ist somit recht kompakt, wie im [[EZ-USB_Firmware_Kit_-_Tutorial#ucecho.c|EZ-USB Firmware-Kit Tutorial]] demonstriert wird.

Zum dem Firmware-Kit gehört ferner eine Java Treiber-API. Mit dieser können plattformunabhängige (zurzeit Linux und Windows, weitere Portierungen möglich) PC-Programme zur Kommunikation mit dem Gerät geschrieben werden. Das Interessante daran ist, dass alle benötigten Dateien (Firmware für den Microcontroller, Bitstream für das FPGA, plattformabhängige Bibliotheken, ...) in ein einzelnes .jar-Archiv verfrachtet werden können. Der (End)Benutzter benötigt / sieht somit nur eine einzige Datei, welche von von jedem Verzeichnis aus aufgerufen werden kann und sowohl unter Windows als auch unter Linux funktioniert.

== FPGA-Programmierung ==
Die Programmierung des FPGA's (genauer gesagt die Konfiguration des FPGA's) bei den
[http://www.ztex.de/usb-fpga-2/index.d.html ZTEX FPGA Boards]
erfolgt über den EZ-USB Mikrocontroller und erfordert kein zusätzliches JTAG-Kabel.

Zu diesem Zweck steht ein Endpoint 0-Interface zur Verfügung, welches automatisch in die EZ-USB Firmware für diese Module eingebunden wird. Dieses Interface wird mittels eines zum Firmware-Kit gehörenden Werkzeuges oder mit selbst enwickelter Software mit der JAVA-API angesprochen.

== Tutorial ==
Interesse? [[EZ-USB_Firmware_Kit_-_Tutorial#ucecho.c|Hier gehts weiter zum EZ-USB Firmware-Kit Tutorial]].

== ZTEX FPGA-Booards ==
Die ZTEX FPGA-Boards sind hauptsächlich zum Einsatz bei Prototypen und Kleinserien gedacht und verfügen deshalb nur über notwendige oder wichtige Funktionen, d.h. keine Taster, Blinklichter, ... . Derartige Dinge können jedoch mittels Erweiterungskarten nachgerüstet werden.

Mittlerweile gibt es zwei Serien von FPGA-Boards. Da sich die erste Serie im Auslaufen befindet (Stand April 2014) werden hier nur Board der Serie 2 vorgestellt. Gegenwärtig noch verfügbare Serie-1-Board werden jedoch auf [[Liste_von_FPGA_Eval_boards#ZTEX|Liste der ZTEX FPGA-Boards]] aufgeführt.

=== USB-FPGA-Modul 2.13 ===

==== Eigenschaften ====
* USB 2.0-Schnittstelle mit Mini-USB-Buchse (Typ B)
* Cypress CY7C68013A EZ-USB FX2 Mikrocontroller (100 Pin Version)
* Vier Artix 7 Varianten: XC7A35T, XC7A50T, XC7A75T und XC7A100T
* Externer-I/O-Verbinder (bestehend aus zwei 2x32-Pin-Buchsenleisten mit 2.54mm-Raster) liefert:
** 100 mit dem FPGA verbundene General-Purpose-I/O's (GPIO's)
** JTAG-Signale
** Reset-Signal
** Externer Spannungseingang (4,5 V .. 16 V)
** 3,3V Ausgang
** I/O-Spannungs-Ausgang oder -Eingang, siehe Externer-I/O-Verbinder
* 256 MByte DDR3 SDRAM:
** Bis zu 400 MHz Speichertakt
** 16 Bit Busbreite
** Datenrate bis zu 1600 MByte/s
** Mit dem Xilinx Memory Interface Generator (MIG) nutzbar, Beispiele befinden sim im SDK
* 128 MBit on-board Flash Speicher
** Ermöglicht das Laden des Bitstream vom FPGA (16.5 MByte/s)
** Zugreifbar vom EZ-USB FX2 und vom FPGA
* 128 Kbit EEPROM-Speicher (kann zum Laden der Firmware genutzt werden)
* 2 Kbit MAC-EEPROM: enthält eindeutige, nicht löschbare MAC-Adresse und wird zum Speichern von Firmware-Einstellungen genutzt
* Schnelle FPGA configuration via USB mittels CPLD: bis zu 24MByte/s
* On-Board Stromversorgung:
** 3,3 V: 2000 mA
** 1,8 V: 1000 mA
** 1,5 V: 2000 mA
** 1,0 V; 4000 mA
* XC7A50T-, XC7A75T- und XC7A100T-Varianten: Kühlkörper für High-Performance- / Hochgeschwindigkeits-Anwendungen, siehe Abschnitt Kühlkörper
* Optional:
** Batterie zum Speichern eines Schlüssels für Bitstream-Verschlüsselung
** On-board JTAG-Steckverbinder

==== Verweise ====
*[http://www.ztex.de/usb-fpga-2/usb-fpga-2.13.d.html Homepage des USB-FPGA-Moduls 2.13 mit detaillierter Beschreibung]
*[http://www.ztex.de/downloads/usb-fpga-2.13.pdf Schaltplan]
*[http://www.ztex.de/usb-fpga-2/index.d.html Komplette Produktserie]

=== USB-FPGA-Modul 2.16 ===

==== Eigenschaften ====
* High-Speed (480 MBit/s) USB-Interface via Mini-USB-Buchse (Typ B)
* Cypress CY7C68013A EZ-USB FX2 Mikrocontroller (128 Pin-Version)
* Xilinx Artix 7 XC7A200T FPGA (XC7A100T auf Anfrage)
* Kompatibler externer-I/O-Verbinder (bestehend aus zwei 2x32-Pin-Buchsenleisten mit 2.54mm-Raster) mit:
** 100 mit dem FPGA verbundene General-Purpose-I/O's (GPIO's)
** JTAG-Signale
** Reset-Signal
** Externer Spannungseingang (4,5 V .. 16 V)
** 3,3V Ausgang
** I/O-Spannungs-Ausgang oder -Eingang, siehe Externer-I/O-Verbinder
* 128 MBit on-board Flash Speicher
** Ermöglicht das Laden des Bitstream vom FPGA (16.5 MByte/s)
** Zugreifbar vom EZ-USB FX2 und vom FPGA
* Schnelle FPGA-Konfiguration via USB mittels CPLD: bis zu 24MByte/s
* Memory-Mapped I/O zwischen EZ-USB FX2 und FPGA
* 128 Kbit EEPROM-Speicher (kann zum Laden der Firmware genutzt werden)
* 2 Kbit MAC-EEPROM: enthält eindeutige, nicht löschbare MAC-Adresse und wird zum Speichern von Firmware-Einstellungen genutzt
* On-Board Stromversorgung:
** 3.3 V: 2000 mA
** 1.8 V: 1000 mA
** 1.0 V; 14000 mA
* Kühlkörper für High-Performance- / Hochgeschwindigkeits-Anwendungen, siehe Abschnitt Kühlkörper
* Optional:
** Batterie zum Speichern eines Schlüssels für Bitstream-Verschlüsselung
** On-board JTAG-Steckverbinder

==== Verweise ====
*[http://www.ztex.de/usb-fpga-2/usb-fpga-2.16.d.html Homepage des USB-FPGA-Moduls 2.16 mit detaillierter Beschreibung]
*[http://www.ztex.de/downloads/usb-fpga-2.16.pdf Schaltplan]
*[http://www.ztex.de/usb-fpga-2/index.d.html Komplette Produktserie]

=== Debug-Board ===

==== Eigenschaften ====

* 30 LED's: an den I/O-Verbinder der FPGA-Boards angeschlossen und in 5er-Gruppen deaktivierbar
* 4 Schalter: an den I/O-Verbinder der FPGA-Boards angeschlossen
* JTAG-Steckverbinder
* Erhältlich in 2 Varianten:
** '''Variante 1''' ist mit stapelbaren Buchsenleisten ausgerüstet, kann zwischen das FPGA-Board und die Anwendungsschaltung gesteckt werden und dient hauptsächlich zum Debuggen. Die LED's können deaktiviert werden, falls die GPIO's in der Anwendungsschaltung Verwendung finden.
** '''Variante 2''' verfügt über ein Prototypen-Raster und kann alleine oder in Kombination mit weiteren Prototypen-Platinen verwendet werden.

==== Verweise ====
*[http://www.ztex.de/usb-fpga-2/debug.d.html Homepage des Debug-Boards]

=== Bilder ===
<gallery widths="350" heights="270" perrow="2">
Bild:Usb-fpga-2.13.jpg|ZTEX USB-FPGA-Modul 2.13 mit Artix 7 XC7A100T FPGA und 256 MB DDR3 SDRAM
Bild:Usb-fpga-2.16-1600.jpg|ZTEX USB-FPGA-Modul 2.16 mit Artix 7 XC7A200T FPGA
Bild:usb-fpga-2-debug-1600.jpg|Debug-Board für ZTEX FPGA-Boards der Serie 2. Variante mit Prototypen-Raster.
Bild:usb-fpga-2-debug-stackable-1600.jpg| Debug-Board für ZTEX FPGA-Boards der Serie 2. Variante mit stapeblaren Buchsenleisten
</gallery>

[[Kategorie:USB]]
[[Kategorie:FPGA-Projekte]]
[[Kategorie:8051]]

ZTEX USB- und USB-FPGA-Module

2014-04-11T07:43:45Z

Stefan2: Bilder aktualisiert

Die Firma [http://www.ztex.de/index.d.html ZTEX] produziert und vertreibt unter Anderem USB- und USB-FPGA-Module mit EZ-USB Mikrocontroller zum Einsatz in Prototypen, Kleinserien oder als Entwickler bzw. Experimentierboard.

Alle Module haben die Eigenschaft, dass sie dem Entwickler einen schnellen Einstieg ermöglichen. Dies wird durch das auf einem Makro-Ansatz basierende
[http://www.ztex.de/firmware-kit/index.d.html Firmware-Kit] ermöglicht.

Dieser Artikel soll schwerpunktmäßig einen Überblick über die Vorteile und Eigenschaften des Firmware-Kits liefern. Dies ist auch für Benutzer anderer EZ-USB basierter Hardware (einschließlich FPGA-Boards) interessant, da das Firmware-Kit quelloffen und nicht an eine bestimmte Hardware gebunden ist. (Der EZ-USB Controller anderer Boards wird normalerweise ohne Anpassungen des Firmware-Kits unterstützt, für die Programmierung von FPGA's müssen normalerweise zusätzliche Routinen ergänzt werden.)

Wer nach der Lektüre dieses Artikel Interesse an dem Firmware-Kit hat, kann
kann beim [[EZ-USB_Firmware_Kit_-_Tutorial | EZ-USB Firmware Kit - Tutorial]] weiterlesen.

Um diese Wiki nicht mit allzu vielen redundanten Informationen zu fluten, werden die ZTEX-Module, für welche das Firmware-Kit schwerpunktmäßig entwickelt wurde, am Ende dieses Artikels zusammengefasst vorgestellt.

==Firmware-Kit==
Für den EZ-USB FX2 Mikrocontroller steht ein quelloffenes Firmware-Kit mit plattformunabhängiger Treiber API zur Verfügung.

Die allgemeinen (Modul-unabhängigen) Grundfunktionen sind
* Hochladen der Firmware direkt in den EZ-USB Mikrocontroller
* EEPROM-Interface zum Lesen / Scheiben von Daten in den / aus dem EEPROM-Speicher
* Hochladen der Firmware in den EEPROM

Diese Funktionen werden firmwareseitig mittels Endpoint 0-Interfaces und dazugehörigen Routinen realisiert, welche automatisch in die mit dem Firmware-Kit entwickelte Firmware eingebunden werden. PC-seitig können diese Interfaces mit einem Werkzeug angesprochen oder mittels der Treiber-API in eigene Programme eingebunden werden.

Um einen schnellen Einstieg in die Entwicklung zu ermöglichen, wird die Firmware mittels eine Makro-Prozessors zusammengebaut. Dieser ermöglicht es Beispielsweise, die Endpoint-Konfiguration mittels weniger Makros (ein Makro pro Endpoint) festzulegen. Alle notwendigen Device-Deskriptoren sowie die notwendigen Routinen zur Ausgabe der Deskriptoren werden vom Firmware-Kit automatisch erstellt.

Im Normalfall kann sich der Entwickler also auf seine selbst benötigten Funktionen konzentrieren und sich ein exzessives Studium der Datenblätter zumindest teilweise ersparen. Der Quelltext einer typischen Firmware ist somit recht kompakt, wie im [[EZ-USB_Firmware_Kit_-_Tutorial#ucecho.c|EZ-USB Firmware-Kit Tutorial]] demonstriert wird.

Zum dem Firmware-Kit gehört ferner eine Java Treiber-API. Mit dieser können plattformunabhängige (zurzeit Linux und Windows, weitere Portierungen möglich) PC-Programme zur Kommunikation mit dem Gerät geschrieben werden. Das Interessante daran ist, dass alle benötigten Dateien (Firmware für den Microcontroller, Bitstream für das FPGA, plattformabhängige Bibliotheken, ...) in ein einzelnes .jar-Archiv verfrachtet werden können. Der (End)Benutzter benötigt / sieht somit nur eine einzige Datei, welche von von jedem Verzeichnis aus aufgerufen werden kann und sowohl unter Windows als auch unter Linux funktioniert.

== FPGA-Programmierung ==
Die Programmierung des FPGA's (genauer gesagt die Konfiguration des FPGA's) bei den
[http://www.ztex.de/usb-fpga-1/usb-fpga-1.2.d.html ZTEX USB-FPGA-Modulen]
erfolgt über den EZ-USB Mikrocontroller und erfordert kein zusätzliches JTAG-Kabel.

Zu diesem Zweck steht ein Endpoint 0-Interface zur Verfügung, welches automatisch in die EZ-USB Firmware für diese Module eingebunden wird. Dieses Interface wird mittels eines zum Firmware-Kit gehörenden Werkzeuges oder mit selbst enwickelter Software mit der JAVA-API angesprochen.

== Tutorial ==
Interesse? [[EZ-USB_Firmware_Kit_-_Tutorial#ucecho.c|Hier gehts weiter zum EZ-USB Firmware-Kit Tutorial]].

== ZTEX FPGA-Booards ==
Die ZTEX FPGA-Boards sind hauptsächlich zum Einsatz bei Prototypen und Kleinserien gedacht und verfügen deshalb nur über notwendige oder wichtige Funktionen, d.h. keine Taster, Blinklichter, ... . Derartige Dinge können jedoch mittels Erweiterungskarten nachgerüstet werden.

Mittlerweile gibt es zwei Serien von FPGA-Boards. Da sich die erste Serie im Auslaufen befindet (Stand April 2014) werden hier nur Board der Serie 2 vorgestellt. Gegenwärtig noch verügbare Serie-1-Board werden jedoch auf [[Liste_von_FPGA_Eval_boards#ZTEX|Liste der ZTEX FPGA-Boards]]

=== USB-FPGA-Modul 2.13 ===

==== Eigenschaften ====
* USB 2.0-Schnittstelle mit Mini-USB-Buchse (Typ B)
* Cypress CY7C68013A EZ-USB FX2 Mikrocontroller (100 Pin Version)
* Vier Artix 7 Varianten: XC7A35T, XC7A50T, XC7A75T und XC7A100T
* Externer-I/O-Verbinder (bestehend aus zwei 2x32-Pin-Buchsenleisten mit 2.54mm-Raster) liefert:
** 100 mit dem FPGA verbundene General-Purpose-I/O's (GPIO's)
** JTAG-Signale
** Reset-Signal
** Externer Spannungseingang (4,5 V .. 16 V)
** 3,3V Ausgang
** I/O-Spannungs-Ausgang oder -Eingang, siehe Externer-I/O-Verbinder
* 256 MByte DDR3 SDRAM:
** Bis zu 400 MHz Speichertakt
** 16 Bit Busbreite
** Datenrate bis zu 1600 MByte/s
** Mit dem Xilinx Memory Interface Generator (MIG) nutzbar, Beispiele befinden sim im SDK
* 128 MBit on-board Flash Speicher
** Ermöglicht das Laden des Bitstream vom FPGA (16.5 MByte/s)
** Zugreifbar vom EZ-USB FX2 und vom FPGA
* 128 Kbit EEPROM-Speicher (kann zum Laden der Firmware genutzt werden)
* 2 Kbit MAC-EEPROM: enthält eindeutige, nicht löschbare MAC-Adresse und wird zum Speichern von Firmware-Einstellungen genutzt
* Schnelle FPGA configuration via USB mittels CPLD: bis zu 24MByte/s
* On-Board Stromversorgung:
** 3,3 V: 2000 mA
** 1,8 V: 1000 mA
** 1,5 V: 2000 mA
** 1,0 V; 4000 mA
* XC7A50T-, XC7A75T- und XC7A100T-Varianten: Kühlkörper für High-Performance- / Hochgeschwindigkeits-Anwendungen, siehe Abschnitt Kühlkörper
* Optional:
** Batterie zum Speichern eines Schlüssels für Bitstream-Verschlüsselung
** On-board JTAG-Steckverbinder

==== Verweise ====
*[http://www.ztex.de/usb-fpga-2/usb-fpga-2.13.d.html Homepage des USB-FPGA-Moduls 2.13 mit detaillierter Beschreibung]
*[http://www.ztex.de/downloads/usb-fpga-2.13.pdf Schaltplan]
*[http://www.ztex.de/usb-fpga-2/index.d.html Komplette Produktserie]

=== USB-FPGA-Modul 2.16 ===

==== Eigenschaften ====
* High-Speed (480 MBit/s) USB-Interface via Mini-USB-Buchse (Typ B)
* Cypress CY7C68013A EZ-USB FX2 Mikrocontroller (128 Pin-Version)
* Xilinx Artix 7 XC7A200T FPGA (XC7A100T auf Anfrage)
* Kompatibler externer-I/O-Verbinder (bestehend aus zwei 2x32-Pin-Buchsenleisten mit 2.54mm-Raster) mit:
** 100 mit dem FPGA verbundene General-Purpose-I/O's (GPIO's)
** JTAG-Signale
** Reset-Signal
** Externer Spannungseingang (4,5 V .. 16 V)
** 3,3V Ausgang
** I/O-Spannungs-Ausgang oder -Eingang, siehe Externer-I/O-Verbinder
* 128 MBit on-board Flash Speicher
** Ermöglicht das Laden des Bitstream vom FPGA (16.5 MByte/s)
** Zugreifbar vom EZ-USB FX2 und vom FPGA
* Schnelle FPGA-Konfiguration via USB mittels CPLD: bis zu 24MByte/s
* Memory-Mapped I/O zwischen EZ-USB FX2 und FPGA
* 128 Kbit EEPROM-Speicher (kann zum Laden der Firmware genutzt werden)
* 2 Kbit MAC-EEPROM: enthält eindeutige, nicht löschbare MAC-Adresse und wird zum Speichern von Firmware-Einstellungen genutzt
* On-Board Stromversorgung:
** 3.3 V: 2000 mA
** 1.8 V: 1000 mA
** 1.0 V; 14000 mA
* Kühlkörper für High-Performance- / Hochgeschwindigkeits-Anwendungen, siehe Abschnitt Kühlkörper
* Optional:
** Batterie zum Speichern eines Schlüssels für Bitstream-Verschlüsselung
** On-board JTAG-Steckverbinder

==== Verweise ====
*[http://www.ztex.de/usb-fpga-2/usb-fpga-2.16.d.html Homepage des USB-FPGA-Moduls 2.16 mit detaillierter Beschreibung]
*[http://www.ztex.de/downloads/usb-fpga-2.16.pdf Schaltplan]
*[http://www.ztex.de/usb-fpga-2/index.d.html Komplette Produktserie]

=== Debug-Board ===

==== Eigenschaften ====

* 30 LED's: an den I/O-Verbinder der FPGA-Boards angeschlossen und in 5er-Gruppen deaktivierbar
* 4 Schalter: an den I/O-Verbinder der FPGA-Boards angeschlossen
* JTAG-Steckverbinder
* Erhältlich in 2 Varianten:
** '''Variante 1''' ist mit stapelbaren Buchsenleisten ausgerüstet, kann zwischen das FPGA-Board und die Anwendungsschaltung gesteckt werden und dient hauptsächlich zum Debuggen. Die LED's können deaktiviert werden, falls die GPIO's in der Anwendungsschaltung Verwendung finden.
** '''Variante 2''' verfügt über ein Prototypen-Raster und kann alleine oder in Kombination mit weiteren Prototypen-Platinen verwendet werden.

==== Verweise ====
*[http://www.ztex.de/usb-fpga-2/debug.d.html Homepage des Debug-Boards]

=== Bilder ===
<gallery widths="350" heights="270" perrow="2">
Bild:Usb-fpga-2.13.jpg|ZTEX USB-FPGA-Modul 2.13 mit Artix 7 XC7A100T FPGA und 256 MB DDR3 SDRAM
Bild:Usb-fpga-2.16-1600.jpg|ZTEX USB-FPGA-Modul 2.16 mit Artix 7 XC7A200T FPGA
Bild:usb-fpga-2-debug-1600.jpg|Debug-Board für ZTEX FPGA-Boards der Serie 2. Variante mit Prototypen-Raster.
Bild:usb-fpga-2-debug-stackable-1600.jpg| Debug-Board für ZTEX FPGA-Boards der Serie 2. Variante mit stapeblaren Buchsenleisten
</gallery>

[[Kategorie:USB]]
[[Kategorie:FPGA-Projekte]]
[[Kategorie:8051]]

Datei:Usb-fpga-2-debug-stackable-1600.jpg

2014-04-11T07:32:29Z

Stefan2: ZTEX Debug-Board für FPGA-Boards der Serie 2, Variante mit stapelbaren Buchsenleisten

ZTEX Debug-Board für FPGA-Boards der Serie 2, Variante mit stapelbaren Buchsenleisten

Datei:Usb-fpga-2-debug-1600.jpg

2014-04-11T07:30:31Z

Stefan2: ZTEX Debug-Board für FPGA-Boards der Serie 2, Variante mit Prototypen-Raster

ZTEX Debug-Board für FPGA-Boards der Serie 2, Variante mit Prototypen-Raster

Datei:Usb-fpga-2.16-1600.jpg

2014-04-11T07:28:26Z

Stefan2: ZTEX USB-FPGA Module 2.12 mit Artix 7 XC7A200T FPGA, Oberseite

ZTEX USB-FPGA Module 2.12 mit Artix 7 XC7A200T FPGA, Oberseite

Datei:Usb-fpga-2.13.jpg

2014-04-11T07:25:05Z

Stefan2: USB-FPGA Modul 2.13 mit Artix 7 XC7A100 FPGA, Oberseite

USB-FPGA Modul 2.13 mit Artix 7 XC7A100 FPGA, Oberseite

EZ-USB Firmware Kit - Tutorial

2009-08-20T14:43:54Z

Stefan2: /* Ausführen des Beispiels */

== Einleitung ==

[http://www.ztex.de ZTEX] stellt ein Firmware-Kit mit zugehörigem Treiber-API zur Verfügung, welches ursprünglich für [http://www.ztex.de/usb-1/index.d.html ZTEX USB-Module] und [http://www.ztex.de/usb-fpga-1/index.d.html ZTEX USB-FPGA-Module] entworfen wurde, aber auch mit anderer EZ-USB basierter Hardware zusammen arbeitet.

Das Paket ist quelloffen und wird wird unter GPLv3 vertrieben.

Das Paket läuft unter Linux und Windows. (Die Portierung auf andere Betriebssysteme sollte problemlos möglich sein). Die Java-Treiber-API ermöglicht die Entwicklung von plattformübergreifenden Geräte-Treibern.

Eine Einführung in das Firmware-Kit und eine Beschreibung der Vorzüge befindet sich bereits im Artikel [[ZTEX_USB-_und_USB-FPGA-Module | ZTEX USB- und USB-FPGA-Module]] und wird hier nicht wiederholt.

== Wichtigste Eigenschaften des Pakets ==

* Firmware-Kit (für EZ-USB Mikrocontroller) in C geschrieben (erfordert SDCC-Compiler).
* Zusammenbau der Firmware erfolgt mittels Makro-Prozessor. Dieser ermöglicht mit wenigen Makros alle erforderlichen Einstellungen festzulegen. Die benötigten '''USB-Deskriptoren und die dazugehörigen Routinen werden automatisch generiert'''.
* Treiber-API ist in Java geschrieben und ermöglicht Plattform-unabhängige Geräte-Treiber.
* Open-Source unter GPLv3 lizenziert
* Hauptfunktionen des Firmware-Kits / Treiber-API's:
** Hochladen der Firmware direkt in den EZ-USB Mikrocontroller
** EEPROM-Interface zum Lesen / Scheiben von Daten in den / aus dem EEPROM-Speicher
** Hochladen der Firmware in den EEPROM
** Hochladen des Bitstreams in das FPGA (für [http://http://www.ztex.de/usb-fpga-1/index.e.html ZTEX-USB-FPGA-Module])

== Systemvoraussetzungen ==
Die Systemvoraussetzungen für das Kompilieren der Firmware und der Treiber sind
* Java JDK 6 oder später
* SDCC
* MSys (nur für Windows)

Die Systemvoraussetzungen für das Ausführen der Beispiele bzw. der selbst erstellten Software sind

* Java JRE 6 oder später

== Download / Homepage / weitere Informationen ==
* '''[http://www.ztex.de/downloads/index.d.html#firmware_kit Downloads]'''
* [http://www.ztex.de/firmware-kit/index.d.html Homepage des Firmware Kits]
* [http://wiki.ztex.de/doku.php?id=de:start ZTEX Wiki]

== Beispiel ==

Das folgende Beispiel für [http://www.ztex.de/usb-fpga-1/usb-fpga-1.2.d.html ZTEX USB-FPGA-Module] demonstriert den verwendeten Makro-Ansatz des Firmware-Kits. Das Beispiel ist ein Bestandteil des Firmware-Kits.

Die Firmware (definiert in [[#ucecho.c| ucecho.c]])
legt die Endpoints 2 und 4 fest
(beide 512 Bytes, doppel-gepuffert, Bulk-Transfer, zu Interface 0 gehörig).
Alle zum Endpoint 4 geschriebenen Daten werden vom FPGA in Großbuchstaben konvertiert und können von Endpoint 2 zurückgelesen werden.

Der Bitstream für die FPGA-Konfiguration wird in [[#ucecho.vhd| ucecho.vhd]] definiert. Das FPGA liest pro Taktzyklus ein Byte von Port ''PC'', konvertiert es in Großbuchstaben und schreibt es nach Port ''PB'' zurück.

Der Treiber (definiert in [[#UCEcho.java| UCEcho.java]]) lädt bei Bedarf die Firmware in dem EZ-USB-Mikrocontroller
und den Bitstream in das FPGA hoch, sendet Benutzer-Strings zum Gerät und liest diese zurück.

Das Hochladen der Firmware in den EEPROM wird ebenfalls unterstützt (z.B. mittels des zum Paket gehörenden Werkzeugs ''FWLoader'').

=== ucecho.c ===
Das ist der C-Quellcode für die Firmware:
<c>
#include[ztex-conf.h] // Loads the configuration macros, see ztex-conf.h for the available macros
#include[ztex-utils.h] // include basic functions

// Cypress vendor ID and product ID may only (!) be used for experimental purposes
SET_VPID(0x4b4,0x8613);

// define endpoints 2 and 4, both belong to interface 0 (in/out are from the point of view of the host)
EP_CONFIG(2,0,BULK,IN,512,2);
EP_CONFIG(4,0,BULK,OUT,512,2);

// identify as ZTEX USB FPGA Module 1.2 (Important for FPGA configuration)
IDENTITY_UFM_1_2(1.0.0.0,0);

// give them a nice name
#define[PRODUCT_STRING]["ucecho for USB FPGA MODULE 1.2"]

// this is called automatically after FPGA configuration
#define[POST_FPGA_CONFIG][POST_FPGA_CONFIG
OEC = 255;
]

// include the main part of the firmware kit, define the descriptors, ...
#include[ztex.h]

void main(void)
{
WORD i,size;

// init everything
init_USB();

EP2CS &= ~bmBIT0; // stall = 0
SYNCDELAY;
EP4CS &= ~bmBIT0; // stall = 0

SYNCDELAY; // first two packages are waste
EP4BCL = 0x80; // skip package, (re)arm EP4
SYNCDELAY;
EP4BCL = 0x80; // skip package, (re)arm EP4

while (1) {
if ( !(EP4CS & bmBIT2) ) { // EP4 is not empty
size = (EP4BCH << 8) | EP4BCL;
if ( size>0 && size<=512 && !(EP2CS & bmBIT3)) { // EP2 is not full
for ( i=0; i<size; i++ ) {
IOC = EP4FIFOBUF[i]; // data from EP4 is converted to uppercase by the FPGA ...
EP2FIFOBUF[i] = IOB; // ... and written back to EP2 buffer
}
EP2BCH = size >> 8;
SYNCDELAY;
EP2BCL = size & 255; // arm EP2
}
SYNCDELAY;
EP4BCL = 0x80; // skip package, (re)arm EP4
}
}
}
</c>

=== ucecho.vhd ===
Das ist der VHDL-Quellcode für die FPGA-Konfiguration:
<vhdl>
library ieee;
use IEEE.std_logic_1164.all;
use IEEE.numeric_std.all;

entity ucecho is
port(
pc : in unsigned(7 downto 0);
pb : out unsigned(7 downto 0);
CLK : in std_logic
);
end ucecho;

--signal declaration
architecture RTL of ucecho is

begin
dpUCECHO: process(CLK)
begin
if CLK' event and CLK = '1' then
if ( pc >= 97 ) and ( pc <= 122)
then
pb <= pc - 32;
else
pb <= pc;
end if;
end if;
end process dpUCECHO;

end RTL;
</vhdl>

=== UCEcho.java ===
Das ist der Java-Quellcode für die PC-seitige Software / für den Treiber:
<c>
import java.io.*;
import java.util.*;

import ch.ntb.usb.*;

import ztex.*;

// *****************************************************************************
// ******* ParameterException **************************************************
// *****************************************************************************
// Exception the prints a help message
class ParameterException extends Exception {
public final static String helpMsg = new String (
"Parameters:\n"+
" -d <number> Device Number (default: 0)\n" +
" -f Force uploads\n" +
" -p Print bus info\n" +
" -h This help" );

public ParameterException (String msg) {
super( msg + "\n" + helpMsg );
}
}

// *****************************************************************************
// ******* Test0 ***************************************************************
// *****************************************************************************
class UCEcho extends Ztex1v1 {

// ******* UCEcho **************************************************************
// constructor
public UCEcho ( ZtexDevice1 pDev ) throws UsbException, ZtexDescriptorException {
super ( pDev );
}

// ******* claimInterface ******************************************************
// claims interface 0
public void claimInterface ( ) throws UsbException{
if ( LibusbJava.usb_claim_interface(handle(), 0) < 0 )
throw new UsbException("Claiming interface 0 failed: " + LibusbJava.usb_strerror());
}

// ******* releaseInterface ****************************************************
// releases interface 0
public void releaseInterface ( ) {
LibusbJava.usb_release_interface(handle(), 0);
}

// ******* echo ****************************************************************
// writes a string to Endpoint 4, reads it back from Endpoint 2 and writes the output to System.out
public void echo ( String input ) throws UsbException {
byte buf[] = input.getBytes();
int i = LibusbJava.usb_bulk_write(handle, 4, buf, buf.length, 1000);
if ( i<0 )
throw new UsbException("Error sending data: " + LibusbJava.usb_strerror());
System.out.println("Send "+i+" bytes: `"+input+"'" );

try {
Thread.sleep( 10 );
}
catch ( InterruptedException e ) {
}

buf = new byte[1024];
i = LibusbJava.usb_bulk_read(handle, 2, buf, 1024, 1000);
if ( i<0 )
throw new UsbException("Error receiving data: " + LibusbJava.usb_strerror());
System.out.println("Read "+i+" bytes: `"+new String(buf,0,i)+"'" );
}

// ******* main ****************************************************************
public static void main (String args[]) {

int devNum = 0;
boolean force = false;

try {
// init USB stuff
LibusbJava.usb_init();

// scan the USB bus
ZtexScanBus1 bus = new ZtexScanBus1( ZtexDevice1.cypressVendorId, ZtexDevice1.cypressProductId, true, false, 1);
if ( bus.numberOfDevices() <= 0) {
System.err.println("No devices found");
System.exit(0);
}

// scan the command line arguments
for (int i=0; i<args.length; i++ ) {
if ( args[i].equals("-d") ) {
i++;
try {
if (i>=args.length) throw new Exception();
devNum = Integer.parseInt( args[i] );
}
catch (Exception e) {
throw new ParameterException("Device number expected after -d");
}
}
else if ( args[i].equals("-f") ) {
force = true;
}
else if ( args[i].equals("-p") ) {
bus.printBus(System.out);
System.exit(0);
}
else if ( args[i].equals("-h") ) {
System.err.println(ParameterException.helpMsg);
System.exit(0);
}
else throw new ParameterException("Invalid Parameter: "+args[i]);
}

// create the main class
UCEcho ztex = new UCEcho ( bus.device(devNum) );

// upload the firmware if necessary
if ( force || ! ztex.valid() || ! ztex.dev().productString().equals("ucecho for USB FPGA MODULE 1.2") ) {
ztex.uploadFirmware( "ucecho.ihx", force );
}

// upload the bitstream if necessary
if ( force || ! ztex.getFpgaConfiguration() ) {
System.out.println("FPGA configuration time: " + ztex.configureFpga( "fpga/ucecho.bin" , force ) + " ms");
}

// claim interface 0
ztex.claimInterface();

// read string from stdin and write it to USB device
String str = "";
BufferedReader reader = new BufferedReader( new InputStreamReader( System.in ) );
while ( ! str.equals("quit") ) {
System.out.print("Enter a string or `quit' to exit the program: ");
str = reader.readLine();
ztex.echo(str);
System.out.println("");
}

// release interface 0
ztex.releaseInterface();

}
catch (Exception e) {
System.out.println("Error: "+e.getLocalizedMessage() );
}
}

}
</c>

== Installation des Pakets ==
Das Firmware-Kit ist als tar.bz2- und als zip-Archiv verfügbar und kann z.B. mittels der Kommandos

bunzip2 -c ztex-<release number>.tar.bz2 | tar -x

oder

unzip ztex-<release number>.zip,

entpackt werden.

== Kompilieren des Beispiels ==

Die Regeln zum Zusammenbauen der Binaries werden mittels ''Makefile'''s festgelegt, d.h. eine GNU-Umgebung ist erforderlich. Das Kompilieren geschieht in folgenden Schritten:

# Sicherstellen, dass die [[#Systemvoraussetzungen|Systemvoraussetzungen]] erfüllt sind, insbesondere dass ''javac'' bzw. ''javac.exe'' -- der Java-Kompiler gefunden werden kann (per ''PATH'' Umgebungsvariable)
# Ein Terminal (Linux) öffnen oder MSys (Windows) starten
# Angenommen das Firmware-Kit wurde im Verzeichnis $HOME/ztex (Linux) oder im Verzeichniss c:\ztex (Windows) installiert. (Das aufgelistete Beispiel befindet sich im Unterverzeichnis ''examples/usb-fpga-1.2/ucecho/''.) In dieses Verzeichnis kann mittels der Befehle <code>cd $HOME/ztex/examples/usb-fpga-1.2/ucecho/</code> unter Linux, bzw. <code> cd /c/ztex/examples/usb-fpga-1.2/ucecho/</code> unter Windows+MSys gewechselt werden.
# Das Kommando <code>make</code> baut alles zusammen (einschließlich der Firmware) und packt es in ein .jar-Archiv.

== Ausführen des Beispiels ==
Zum Ausführen des Beispiels wird nur die .jar-Datei benötigt, welche sowohl unter Linux als auch unter Windows läuft. (Unter Windows muss der Treiber libusb-win32 installiert sein.) Diese .jar-Datei enthält den Java-Bytecode, die Firmware für den EZ-USB Microcontroller, den Bitstream für das FPGA und die Betriebssystem-abhängigen Bibliotheken. Das Ausführen geschieht in folgenden Schritten:

# '''Nur Windows:''' Den Treiber libusb-win32 bei Bedarf installieren, d.h. libusb-win32 dem Gerät wie folgt zuweisen:
## Das Gerät anstecken
## Wenn Windows nach dem Treiber fragt, die Datei ''cypress.inf'' aus dem Unterverzeichnis ''libusb-win32'' des Firmware-Kits auswählen. (Diese Datei ist gültig, falls die Cypress Hersteller- und Produkt-ID verwendet wird, was nur zu experimentellen Zwecken bei nichtöffentlicher Verwendung gestattet ist. Im Fall einer anderen Hersteller- und Produkt-ID kann mittels des Werkzeuges ''inf-wizard.exe'' im Unterverzeichnis ''libusb-win32''eine neue .inf Datei erstellt werden.
# Das Beispiel mittels des Kommandos <code>java -cp UCEcho.jar UCEcho</code> ausführen. Da die .jar-Datei alles enthält, was zum Ausführen des Beispiels notwendig ist, kann die Datei an jede Stelle kopiert / von jeder Stelle aus ausgeführt werden.

Ein Beispielaufruf sieht wie folgt aus:
<code><pre>
stefan@ws2:/drv_a2/usb-fpga/ztex-1.1/examples/usb-fpga-1.2/ucecho$ java -cp UCEcho.jar UCEcho
FPGA configuration time: 1353 ms
Enter a string or `quit' to exit the program: Hello world!
Send 12 bytes: `Hello world!'
Read 12 bytes: `HELLO WORLD!'

Enter a string or `quit' to exit the program: quit
Send 4 bytes: `quit'
Read 4 bytes: `QUIT'
</pre></code>

[[Kategorie:Mikrocontroller]]
[[Kategorie:8051]]
[[Kategorie:Programmiersprachen]]

EZ-USB Firmware Kit - Tutorial

2009-08-20T14:42:56Z

Stefan2: /* Einleitung */

EZ-USB Firmware Kit - Tutorial

2009-08-20T14:42:43Z

Stefan2: /* Einleitung */

== Einleitung ==

[http://www.ztex.de ZTEX] stellt ein Firmware-Kit mit zugehörigem Treiber-API zur Verfügung, welches ursprünglich für [http://www.ztex.de/usb-1/index.d.html ZTEX USB-Module] und [http://www.ztex.de/usb-fpga-1/index.d.html ZTEX USB-FPGA-Module] entworfen wurde, aber auch mit anderer EZ-USB basierter Hardware zusammen arbeitet.

Das Paket ist quelloffen und wird wird unter GPLv3 vertrieben.

Das Paket läuft unter Linux und Windows. (Die Portierung auf andere Betriebssysteme sollte problemlos möglich sein). Die Java-Treiber-API ermöglicht die Entwicklung von plattformübergreifenden Geräte-Treibern.

Eine Einführung in das Firmware-Kit und eine Beschreibung der Vorzüge befindet sich bereits im Artikel [[ZTEX_USB-_und_USB-FPGA-Module|ZTEX USB- und USB-FPGA-Module]] und wird hier nicht wiederholt.

== Wichtigste Eigenschaften des Pakets ==

* Firmware-Kit (für EZ-USB Mikrocontroller) in C geschrieben (erfordert SDCC-Compiler).
* Zusammenbau der Firmware erfolgt mittels Makro-Prozessor. Dieser ermöglicht mit wenigen Makros alle erforderlichen Einstellungen festzulegen. Die benötigten '''USB-Deskriptoren und die dazugehörigen Routinen werden automatisch generiert'''.
* Treiber-API ist in Java geschrieben und ermöglicht Plattform-unabhängige Geräte-Treiber.
* Open-Source unter GPLv3 lizenziert
* Hauptfunktionen des Firmware-Kits / Treiber-API's:
** Hochladen der Firmware direkt in den EZ-USB Mikrocontroller
** EEPROM-Interface zum Lesen / Scheiben von Daten in den / aus dem EEPROM-Speicher
** Hochladen der Firmware in den EEPROM
** Hochladen des Bitstreams in das FPGA (für [http://http://www.ztex.de/usb-fpga-1/index.e.html ZTEX-USB-FPGA-Module])

== Systemvoraussetzungen ==
Die Systemvoraussetzungen für das Kompilieren der Firmware und der Treiber sind
* Java JDK 6 oder später
* SDCC
* MSys (nur für Windows)

Die Systemvoraussetzungen für das Ausführen der Beispiele bzw. der selbst erstellten Software sind

* Java JRE 6 oder später

== Download / Homepage / weitere Informationen ==
* '''[http://www.ztex.de/downloads/index.d.html#firmware_kit Downloads]'''
* [http://www.ztex.de/firmware-kit/index.d.html Homepage des Firmware Kits]
* [http://wiki.ztex.de/doku.php?id=de:start ZTEX Wiki]

== Beispiel ==

Das folgende Beispiel für [http://www.ztex.de/usb-fpga-1/usb-fpga-1.2.d.html ZTEX USB-FPGA-Module] demonstriert den verwendeten Makro-Ansatz des Firmware-Kits. Das Beispiel ist ein Bestandteil des Firmware-Kits.

Die Firmware (definiert in [[#ucecho.c| ucecho.c]])
legt die Endpoints 2 und 4 fest
(beide 512 Bytes, doppel-gepuffert, Bulk-Transfer, zu Interface 0 gehörig).
Alle zum Endpoint 4 geschriebenen Daten werden vom FPGA in Großbuchstaben konvertiert und können von Endpoint 2 zurückgelesen werden.

Der Bitstream für die FPGA-Konfiguration wird in [[#ucecho.vhd| ucecho.vhd]] definiert. Das FPGA liest pro Taktzyklus ein Byte von Port ''PC'', konvertiert es in Großbuchstaben und schreibt es nach Port ''PB'' zurück.

Der Treiber (definiert in [[#UCEcho.java| UCEcho.java]]) lädt bei Bedarf die Firmware in dem EZ-USB-Mikrocontroller
und den Bitstream in das FPGA hoch, sendet Benutzer-Strings zum Gerät und liest diese zurück.

Das Hochladen der Firmware in den EEPROM wird ebenfalls unterstützt (z.B. mittels des zum Paket gehörenden Werkzeugs ''FWLoader'').

=== ucecho.c ===
Das ist der C-Quellcode für die Firmware:
<c>
#include[ztex-conf.h] // Loads the configuration macros, see ztex-conf.h for the available macros
#include[ztex-utils.h] // include basic functions

// Cypress vendor ID and product ID may only (!) be used for experimental purposes
SET_VPID(0x4b4,0x8613);

// define endpoints 2 and 4, both belong to interface 0 (in/out are from the point of view of the host)
EP_CONFIG(2,0,BULK,IN,512,2);
EP_CONFIG(4,0,BULK,OUT,512,2);

// identify as ZTEX USB FPGA Module 1.2 (Important for FPGA configuration)
IDENTITY_UFM_1_2(1.0.0.0,0);

// give them a nice name
#define[PRODUCT_STRING]["ucecho for USB FPGA MODULE 1.2"]

// this is called automatically after FPGA configuration
#define[POST_FPGA_CONFIG][POST_FPGA_CONFIG
OEC = 255;
]

// include the main part of the firmware kit, define the descriptors, ...
#include[ztex.h]

void main(void)
{
WORD i,size;

// init everything
init_USB();

EP2CS &= ~bmBIT0; // stall = 0
SYNCDELAY;
EP4CS &= ~bmBIT0; // stall = 0

SYNCDELAY; // first two packages are waste
EP4BCL = 0x80; // skip package, (re)arm EP4
SYNCDELAY;
EP4BCL = 0x80; // skip package, (re)arm EP4

while (1) {
if ( !(EP4CS & bmBIT2) ) { // EP4 is not empty
size = (EP4BCH << 8) | EP4BCL;
if ( size>0 && size<=512 && !(EP2CS & bmBIT3)) { // EP2 is not full
for ( i=0; i<size; i++ ) {
IOC = EP4FIFOBUF[i]; // data from EP4 is converted to uppercase by the FPGA ...
EP2FIFOBUF[i] = IOB; // ... and written back to EP2 buffer
}
EP2BCH = size >> 8;
SYNCDELAY;
EP2BCL = size & 255; // arm EP2
}
SYNCDELAY;
EP4BCL = 0x80; // skip package, (re)arm EP4
}
}
}
</c>

=== ucecho.vhd ===
Das ist der VHDL-Quellcode für die FPGA-Konfiguration:
<vhdl>
library ieee;
use IEEE.std_logic_1164.all;
use IEEE.numeric_std.all;

entity ucecho is
port(
pc : in unsigned(7 downto 0);
pb : out unsigned(7 downto 0);
CLK : in std_logic
);
end ucecho;

--signal declaration
architecture RTL of ucecho is

begin
dpUCECHO: process(CLK)
begin
if CLK' event and CLK = '1' then
if ( pc >= 97 ) and ( pc <= 122)
then
pb <= pc - 32;
else
pb <= pc;
end if;
end if;
end process dpUCECHO;

end RTL;
</vhdl>

=== UCEcho.java ===
Das ist der Java-Quellcode für die PC-seitige Software / für den Treiber:
<c>
import java.io.*;
import java.util.*;

import ch.ntb.usb.*;

import ztex.*;

// *****************************************************************************
// ******* ParameterException **************************************************
// *****************************************************************************
// Exception the prints a help message
class ParameterException extends Exception {
public final static String helpMsg = new String (
"Parameters:\n"+
" -d <number> Device Number (default: 0)\n" +
" -f Force uploads\n" +
" -p Print bus info\n" +
" -h This help" );

public ParameterException (String msg) {
super( msg + "\n" + helpMsg );
}
}

// *****************************************************************************
// ******* Test0 ***************************************************************
// *****************************************************************************
class UCEcho extends Ztex1v1 {

// ******* UCEcho **************************************************************
// constructor
public UCEcho ( ZtexDevice1 pDev ) throws UsbException, ZtexDescriptorException {
super ( pDev );
}

// ******* claimInterface ******************************************************
// claims interface 0
public void claimInterface ( ) throws UsbException{
if ( LibusbJava.usb_claim_interface(handle(), 0) < 0 )
throw new UsbException("Claiming interface 0 failed: " + LibusbJava.usb_strerror());
}

// ******* releaseInterface ****************************************************
// releases interface 0
public void releaseInterface ( ) {
LibusbJava.usb_release_interface(handle(), 0);
}

// ******* echo ****************************************************************
// writes a string to Endpoint 4, reads it back from Endpoint 2 and writes the output to System.out
public void echo ( String input ) throws UsbException {
byte buf[] = input.getBytes();
int i = LibusbJava.usb_bulk_write(handle, 4, buf, buf.length, 1000);
if ( i<0 )
throw new UsbException("Error sending data: " + LibusbJava.usb_strerror());
System.out.println("Send "+i+" bytes: `"+input+"'" );

try {
Thread.sleep( 10 );
}
catch ( InterruptedException e ) {
}

buf = new byte[1024];
i = LibusbJava.usb_bulk_read(handle, 2, buf, 1024, 1000);
if ( i<0 )
throw new UsbException("Error receiving data: " + LibusbJava.usb_strerror());
System.out.println("Read "+i+" bytes: `"+new String(buf,0,i)+"'" );
}

// ******* main ****************************************************************
public static void main (String args[]) {

int devNum = 0;
boolean force = false;

try {
// init USB stuff
LibusbJava.usb_init();

// scan the USB bus
ZtexScanBus1 bus = new ZtexScanBus1( ZtexDevice1.cypressVendorId, ZtexDevice1.cypressProductId, true, false, 1);
if ( bus.numberOfDevices() <= 0) {
System.err.println("No devices found");
System.exit(0);
}

// scan the command line arguments
for (int i=0; i<args.length; i++ ) {
if ( args[i].equals("-d") ) {
i++;
try {
if (i>=args.length) throw new Exception();
devNum = Integer.parseInt( args[i] );
}
catch (Exception e) {
throw new ParameterException("Device number expected after -d");
}
}
else if ( args[i].equals("-f") ) {
force = true;
}
else if ( args[i].equals("-p") ) {
bus.printBus(System.out);
System.exit(0);
}
else if ( args[i].equals("-h") ) {
System.err.println(ParameterException.helpMsg);
System.exit(0);
}
else throw new ParameterException("Invalid Parameter: "+args[i]);
}

// create the main class
UCEcho ztex = new UCEcho ( bus.device(devNum) );

// upload the firmware if necessary
if ( force || ! ztex.valid() || ! ztex.dev().productString().equals("ucecho for USB FPGA MODULE 1.2") ) {
ztex.uploadFirmware( "ucecho.ihx", force );
}

// upload the bitstream if necessary
if ( force || ! ztex.getFpgaConfiguration() ) {
System.out.println("FPGA configuration time: " + ztex.configureFpga( "fpga/ucecho.bin" , force ) + " ms");
}

// claim interface 0
ztex.claimInterface();

// read string from stdin and write it to USB device
String str = "";
BufferedReader reader = new BufferedReader( new InputStreamReader( System.in ) );
while ( ! str.equals("quit") ) {
System.out.print("Enter a string or `quit' to exit the program: ");
str = reader.readLine();
ztex.echo(str);
System.out.println("");
}

// release interface 0
ztex.releaseInterface();

}
catch (Exception e) {
System.out.println("Error: "+e.getLocalizedMessage() );
}
}

}
</c>

== Installation des Pakets ==
Das Firmware-Kit ist als tar.bz2- und als zip-Archiv verfügbar und kann z.B. mittels der Kommandos

bunzip2 -c ztex-<release number>.tar.bz2 | tar -x

oder

unzip ztex-<release number>.zip,

entpackt werden.

== Kompilieren des Beispiels ==

Die Regeln zum Zusammenbauen der Binaries werden mittels ''Makefile'''s festgelegt, d.h. eine GNU-Umgebung ist erforderlich. Das Kompilieren geschieht in folgenden Schritten:

# Sicherstellen, dass die [[#Systemvoraussetzungen|Systemvoraussetzungen]] erfüllt sind, insbesondere dass ''javac'' bzw. ''javac.exe'' -- der Java-Kompiler gefunden werden kann (per ''PATH'' Umgebungsvariable)
# Ein Terminal (Linux) öffnen oder MSys (Windows) starten
# Angenommen das Firmware-Kit wurde im Verzeichnis $HOME/ztex (Linux) oder im Verzeichniss c:\ztex (Windows) installiert. (Das aufgelistete Beispiel befindet sich im Unterverzeichnis ''examples/usb-fpga-1.2/ucecho/''.) In dieses Verzeichnis kann mittels der Befehle <code>cd $HOME/ztex/examples/usb-fpga-1.2/ucecho/</code> unter Linux, bzw. <code> cd /c/ztex/examples/usb-fpga-1.2/ucecho/</code> unter Windows+MSys gewechselt werden.
# Das Kommando <code>make</code> baut alles zusammen (einschließlich der Firmware) und packt es in ein .jar-Archiv.

== Ausführen des Beispiels ==
Zum Ausführen des Beispiels wird nur die .jar-Datei benötigt, welche sowohl unter Linux als auch unter Windows läuft. (Unter Windows muss der Treiber libusb-win32 installiert sein.) Diese .jar-Datei enthält den Java-Bytecode, die Firmware für den EZ-USB Microcontroller, den Bitstream für das FPGA und die Betriebssystem-abhängigen Bibliotheken. Das Ausführen geschieht in folgenden Schritten:

# '''Nur Windows:''' Den Treiber libusb-win32 bei Bedarf installieren, d.h. libusb-win32 dem Gerät wie folgt zuweisen:
## Das Gerät anstecken
## Wenn Windows nach dem Treiber fragt, die Datei ''cypress.inf'' aus dem Unterverzeichnis ''libusb-win32'' des Firmware-Kits auswählen. (Diese Datei ist gültig, falls die Cypress Hersteller- und Produkt-ID verwendet wird, was nur zu experimentellen Zwecken bei nichtöffentlicher Verwendung gestattet ist. Im Fall einer anderen Hersteller- und Produkt-ID kann mittels des Werkzeuges ''inf-wizard.exe'' im Unterverzeichnis ''libusb-win32''eine neue .inf Datei erstellt werden.
# Das Beispiel mittels des Kommandos <code>java -cp UCEcho.jar UCEcho</code> ausführen. Da die .jar-Datei alles enthält, was zum Ausführen des Beispiels notwendig ist, kann die Datei an jede Stelle kopiert / von jeder Stelle aus ausgeführt werden.

Ein Beispielaufruf sieht wie folgt aus:
<code><pre>
stefan@ws2:/drv_a2/usb-fpga/ztex-1.1/examples/usb-fpga-1.2/ucecho$ java -cp UCEcho.jar UCEcho
FPGA configuration time: 1353 ms
Enter a string or `quit' to exit the program: Hello world!
Send 12 bytes: `Hello world!'
Read 12 bytes: `HELLO WORLD!'

Enter a string or `quit' to exit the program: quit
Send 4 bytes: `quit'
Read 4 bytes: `QUIT'
</pre></code>

EZ-USB Firmware Kit - Tutorial

2009-08-20T14:42:07Z

Stefan2: /* Einleitung */

== Einleitung ==

[http://www.ztex.de ZTEX] stellt ein Firmware-Kit mit zugehörigem Treiber-API zur Verfügung, welches ursprünglich für [http://www.ztex.de/usb-1/index.d.html ZTEX USB-Module] und [http://www.ztex.de/usb-fpga-1/index.d.html ZTEX USB-FPGA-Module] entworfen wurde, aber auch mit anderer EZ-USB basierter Hardware zusammen arbeitet.

Das Paket ist quelloffen und wird wird unter GPLv3 vertrieben.

Das Paket läuft unter Linux und Windows. (Die Portierung auf andere Betriebssysteme sollte problemlos möglich sein). Die Java-Treiber-API ermöglicht die Entwicklung von plattformübergreifenden Geräte-Treibern.

Eine Einführung in das Firmware-Kit und eine Beschreibung der Vorzüge befindet sich im Artikel [[ZTEX_USB-_und_USB-FPGA-Module|ZTEX USB- und USB-FPGA-Module]] und wird hier nicht wiederholt.

== Wichtigste Eigenschaften des Pakets ==

* Firmware-Kit (für EZ-USB Mikrocontroller) in C geschrieben (erfordert SDCC-Compiler).
* Zusammenbau der Firmware erfolgt mittels Makro-Prozessor. Dieser ermöglicht mit wenigen Makros alle erforderlichen Einstellungen festzulegen. Die benötigten '''USB-Deskriptoren und die dazugehörigen Routinen werden automatisch generiert'''.
* Treiber-API ist in Java geschrieben und ermöglicht Plattform-unabhängige Geräte-Treiber.
* Open-Source unter GPLv3 lizenziert
* Hauptfunktionen des Firmware-Kits / Treiber-API's:
** Hochladen der Firmware direkt in den EZ-USB Mikrocontroller
** EEPROM-Interface zum Lesen / Scheiben von Daten in den / aus dem EEPROM-Speicher
** Hochladen der Firmware in den EEPROM
** Hochladen des Bitstreams in das FPGA (für [http://http://www.ztex.de/usb-fpga-1/index.e.html ZTEX-USB-FPGA-Module])

== Systemvoraussetzungen ==
Die Systemvoraussetzungen für das Kompilieren der Firmware und der Treiber sind
* Java JDK 6 oder später
* SDCC
* MSys (nur für Windows)

Die Systemvoraussetzungen für das Ausführen der Beispiele bzw. der selbst erstellten Software sind

* Java JRE 6 oder später

== Download / Homepage / weitere Informationen ==
* '''[http://www.ztex.de/downloads/index.d.html#firmware_kit Downloads]'''
* [http://www.ztex.de/firmware-kit/index.d.html Homepage des Firmware Kits]
* [http://wiki.ztex.de/doku.php?id=de:start ZTEX Wiki]

== Beispiel ==

Das folgende Beispiel für [http://www.ztex.de/usb-fpga-1/usb-fpga-1.2.d.html ZTEX USB-FPGA-Module] demonstriert den verwendeten Makro-Ansatz des Firmware-Kits. Das Beispiel ist ein Bestandteil des Firmware-Kits.

Die Firmware (definiert in [[#ucecho.c| ucecho.c]])
legt die Endpoints 2 und 4 fest
(beide 512 Bytes, doppel-gepuffert, Bulk-Transfer, zu Interface 0 gehörig).
Alle zum Endpoint 4 geschriebenen Daten werden vom FPGA in Großbuchstaben konvertiert und können von Endpoint 2 zurückgelesen werden.

Der Bitstream für die FPGA-Konfiguration wird in [[#ucecho.vhd| ucecho.vhd]] definiert. Das FPGA liest pro Taktzyklus ein Byte von Port ''PC'', konvertiert es in Großbuchstaben und schreibt es nach Port ''PB'' zurück.

Der Treiber (definiert in [[#UCEcho.java| UCEcho.java]]) lädt bei Bedarf die Firmware in dem EZ-USB-Mikrocontroller
und den Bitstream in das FPGA hoch, sendet Benutzer-Strings zum Gerät und liest diese zurück.

Das Hochladen der Firmware in den EEPROM wird ebenfalls unterstützt (z.B. mittels des zum Paket gehörenden Werkzeugs ''FWLoader'').

=== ucecho.c ===
Das ist der C-Quellcode für die Firmware:
<c>
#include[ztex-conf.h] // Loads the configuration macros, see ztex-conf.h for the available macros
#include[ztex-utils.h] // include basic functions

// Cypress vendor ID and product ID may only (!) be used for experimental purposes
SET_VPID(0x4b4,0x8613);

// define endpoints 2 and 4, both belong to interface 0 (in/out are from the point of view of the host)
EP_CONFIG(2,0,BULK,IN,512,2);
EP_CONFIG(4,0,BULK,OUT,512,2);

// identify as ZTEX USB FPGA Module 1.2 (Important for FPGA configuration)
IDENTITY_UFM_1_2(1.0.0.0,0);

// give them a nice name
#define[PRODUCT_STRING]["ucecho for USB FPGA MODULE 1.2"]

// this is called automatically after FPGA configuration
#define[POST_FPGA_CONFIG][POST_FPGA_CONFIG
OEC = 255;
]

// include the main part of the firmware kit, define the descriptors, ...
#include[ztex.h]

void main(void)
{
WORD i,size;

// init everything
init_USB();

EP2CS &= ~bmBIT0; // stall = 0
SYNCDELAY;
EP4CS &= ~bmBIT0; // stall = 0

SYNCDELAY; // first two packages are waste
EP4BCL = 0x80; // skip package, (re)arm EP4
SYNCDELAY;
EP4BCL = 0x80; // skip package, (re)arm EP4

while (1) {
if ( !(EP4CS & bmBIT2) ) { // EP4 is not empty
size = (EP4BCH << 8) | EP4BCL;
if ( size>0 && size<=512 && !(EP2CS & bmBIT3)) { // EP2 is not full
for ( i=0; i<size; i++ ) {
IOC = EP4FIFOBUF[i]; // data from EP4 is converted to uppercase by the FPGA ...
EP2FIFOBUF[i] = IOB; // ... and written back to EP2 buffer
}
EP2BCH = size >> 8;
SYNCDELAY;
EP2BCL = size & 255; // arm EP2
}
SYNCDELAY;
EP4BCL = 0x80; // skip package, (re)arm EP4
}
}
}
</c>

=== ucecho.vhd ===
Das ist der VHDL-Quellcode für die FPGA-Konfiguration:
<vhdl>
library ieee;
use IEEE.std_logic_1164.all;
use IEEE.numeric_std.all;

entity ucecho is
port(
pc : in unsigned(7 downto 0);
pb : out unsigned(7 downto 0);
CLK : in std_logic
);
end ucecho;

--signal declaration
architecture RTL of ucecho is

begin
dpUCECHO: process(CLK)
begin
if CLK' event and CLK = '1' then
if ( pc >= 97 ) and ( pc <= 122)
then
pb <= pc - 32;
else
pb <= pc;
end if;
end if;
end process dpUCECHO;

end RTL;
</vhdl>

=== UCEcho.java ===
Das ist der Java-Quellcode für die PC-seitige Software / für den Treiber:
<c>
import java.io.*;
import java.util.*;

import ch.ntb.usb.*;

import ztex.*;

// *****************************************************************************
// ******* ParameterException **************************************************
// *****************************************************************************
// Exception the prints a help message
class ParameterException extends Exception {
public final static String helpMsg = new String (
"Parameters:\n"+
" -d <number> Device Number (default: 0)\n" +
" -f Force uploads\n" +
" -p Print bus info\n" +
" -h This help" );

public ParameterException (String msg) {
super( msg + "\n" + helpMsg );
}
}

// *****************************************************************************
// ******* Test0 ***************************************************************
// *****************************************************************************
class UCEcho extends Ztex1v1 {

// ******* UCEcho **************************************************************
// constructor
public UCEcho ( ZtexDevice1 pDev ) throws UsbException, ZtexDescriptorException {
super ( pDev );
}

// ******* claimInterface ******************************************************
// claims interface 0
public void claimInterface ( ) throws UsbException{
if ( LibusbJava.usb_claim_interface(handle(), 0) < 0 )
throw new UsbException("Claiming interface 0 failed: " + LibusbJava.usb_strerror());
}

// ******* releaseInterface ****************************************************
// releases interface 0
public void releaseInterface ( ) {
LibusbJava.usb_release_interface(handle(), 0);
}

// ******* echo ****************************************************************
// writes a string to Endpoint 4, reads it back from Endpoint 2 and writes the output to System.out
public void echo ( String input ) throws UsbException {
byte buf[] = input.getBytes();
int i = LibusbJava.usb_bulk_write(handle, 4, buf, buf.length, 1000);
if ( i<0 )
throw new UsbException("Error sending data: " + LibusbJava.usb_strerror());
System.out.println("Send "+i+" bytes: `"+input+"'" );

try {
Thread.sleep( 10 );
}
catch ( InterruptedException e ) {
}

buf = new byte[1024];
i = LibusbJava.usb_bulk_read(handle, 2, buf, 1024, 1000);
if ( i<0 )
throw new UsbException("Error receiving data: " + LibusbJava.usb_strerror());
System.out.println("Read "+i+" bytes: `"+new String(buf,0,i)+"'" );
}

// ******* main ****************************************************************
public static void main (String args[]) {

int devNum = 0;
boolean force = false;

try {
// init USB stuff
LibusbJava.usb_init();

// scan the USB bus
ZtexScanBus1 bus = new ZtexScanBus1( ZtexDevice1.cypressVendorId, ZtexDevice1.cypressProductId, true, false, 1);
if ( bus.numberOfDevices() <= 0) {
System.err.println("No devices found");
System.exit(0);
}

// scan the command line arguments
for (int i=0; i<args.length; i++ ) {
if ( args[i].equals("-d") ) {
i++;
try {
if (i>=args.length) throw new Exception();
devNum = Integer.parseInt( args[i] );
}
catch (Exception e) {
throw new ParameterException("Device number expected after -d");
}
}
else if ( args[i].equals("-f") ) {
force = true;
}
else if ( args[i].equals("-p") ) {
bus.printBus(System.out);
System.exit(0);
}
else if ( args[i].equals("-h") ) {
System.err.println(ParameterException.helpMsg);
System.exit(0);
}
else throw new ParameterException("Invalid Parameter: "+args[i]);
}

// create the main class
UCEcho ztex = new UCEcho ( bus.device(devNum) );

// upload the firmware if necessary
if ( force || ! ztex.valid() || ! ztex.dev().productString().equals("ucecho for USB FPGA MODULE 1.2") ) {
ztex.uploadFirmware( "ucecho.ihx", force );
}

// upload the bitstream if necessary
if ( force || ! ztex.getFpgaConfiguration() ) {
System.out.println("FPGA configuration time: " + ztex.configureFpga( "fpga/ucecho.bin" , force ) + " ms");
}

// claim interface 0
ztex.claimInterface();

// read string from stdin and write it to USB device
String str = "";
BufferedReader reader = new BufferedReader( new InputStreamReader( System.in ) );
while ( ! str.equals("quit") ) {
System.out.print("Enter a string or `quit' to exit the program: ");
str = reader.readLine();
ztex.echo(str);
System.out.println("");
}

// release interface 0
ztex.releaseInterface();

}
catch (Exception e) {
System.out.println("Error: "+e.getLocalizedMessage() );
}
}

}
</c>

== Installation des Pakets ==
Das Firmware-Kit ist als tar.bz2- und als zip-Archiv verfügbar und kann z.B. mittels der Kommandos

bunzip2 -c ztex-<release number>.tar.bz2 | tar -x

oder

unzip ztex-<release number>.zip,

entpackt werden.

== Kompilieren des Beispiels ==

Die Regeln zum Zusammenbauen der Binaries werden mittels ''Makefile'''s festgelegt, d.h. eine GNU-Umgebung ist erforderlich. Das Kompilieren geschieht in folgenden Schritten:

# Sicherstellen, dass die [[#Systemvoraussetzungen|Systemvoraussetzungen]] erfüllt sind, insbesondere dass ''javac'' bzw. ''javac.exe'' -- der Java-Kompiler gefunden werden kann (per ''PATH'' Umgebungsvariable)
# Ein Terminal (Linux) öffnen oder MSys (Windows) starten
# Angenommen das Firmware-Kit wurde im Verzeichnis $HOME/ztex (Linux) oder im Verzeichniss c:\ztex (Windows) installiert. (Das aufgelistete Beispiel befindet sich im Unterverzeichnis ''examples/usb-fpga-1.2/ucecho/''.) In dieses Verzeichnis kann mittels der Befehle <code>cd $HOME/ztex/examples/usb-fpga-1.2/ucecho/</code> unter Linux, bzw. <code> cd /c/ztex/examples/usb-fpga-1.2/ucecho/</code> unter Windows+MSys gewechselt werden.
# Das Kommando <code>make</code> baut alles zusammen (einschließlich der Firmware) und packt es in ein .jar-Archiv.

== Ausführen des Beispiels ==
Zum Ausführen des Beispiels wird nur die .jar-Datei benötigt, welche sowohl unter Linux als auch unter Windows läuft. (Unter Windows muss der Treiber libusb-win32 installiert sein.) Diese .jar-Datei enthält den Java-Bytecode, die Firmware für den EZ-USB Microcontroller, den Bitstream für das FPGA und die Betriebssystem-abhängigen Bibliotheken. Das Ausführen geschieht in folgenden Schritten:

# '''Nur Windows:''' Den Treiber libusb-win32 bei Bedarf installieren, d.h. libusb-win32 dem Gerät wie folgt zuweisen:
## Das Gerät anstecken
## Wenn Windows nach dem Treiber fragt, die Datei ''cypress.inf'' aus dem Unterverzeichnis ''libusb-win32'' des Firmware-Kits auswählen. (Diese Datei ist gültig, falls die Cypress Hersteller- und Produkt-ID verwendet wird, was nur zu experimentellen Zwecken bei nichtöffentlicher Verwendung gestattet ist. Im Fall einer anderen Hersteller- und Produkt-ID kann mittels des Werkzeuges ''inf-wizard.exe'' im Unterverzeichnis ''libusb-win32''eine neue .inf Datei erstellt werden.
# Das Beispiel mittels des Kommandos <code>java -cp UCEcho.jar UCEcho</code> ausführen. Da die .jar-Datei alles enthält, was zum Ausführen des Beispiels notwendig ist, kann die Datei an jede Stelle kopiert / von jeder Stelle aus ausgeführt werden.

Ein Beispielaufruf sieht wie folgt aus:
<code><pre>
stefan@ws2:/drv_a2/usb-fpga/ztex-1.1/examples/usb-fpga-1.2/ucecho$ java -cp UCEcho.jar UCEcho
FPGA configuration time: 1353 ms
Enter a string or `quit' to exit the program: Hello world!
Send 12 bytes: `Hello world!'
Read 12 bytes: `HELLO WORLD!'

Enter a string or `quit' to exit the program: quit
Send 4 bytes: `quit'
Read 4 bytes: `QUIT'
</pre></code>

ZTEX USB- und USB-FPGA-Module

2009-08-20T14:35:15Z

Stefan2: /* Bilder */

== Einleitung ==
Die Firma [http://www.ztex.de/index.d.html ZTEX] produziert und vertreibt unter Anderem USB- und USB-FPGA-Module mit EZ-USB Mikrocontroller zum Einsatz in Prototypen, Kleinserien oder als Entwickler bzw. Experimentierboard.

Alle Module haben die Eigenschaft, dass sie dem Entwickler einen schnellen Einstieg ermöglichen. Dies wird durch das auf einem Makro-Ansatz basierende
[http://www.ztex.de/firmware-kit/index.d.html Firmware-Kit] ermöglicht.

Dieser Artikel soll schwerpunktmäßig einen Überblick über die Vorteile und Eigenschaften des Firmware-Kits liefern. Dies ist auch für Benutzer anderer EZ-USB basierter Hardware (einschließlich FPGA-Boards) interessant, da das Firmware-Kit quelloffen und nicht an eine bestimmte Hardware gebunden ist. (Der EZ-USB Controller anderer Boards wird normalerweise ohne Anpassungen des Firmware-Kits unterstützt, für die Programmierung von FPGA's müssen normalerweise zusätzliche Routinen ergänzt werden.)

Wer nach der Lektüre dieses Artikel Interesse an dem Firmware-Kit hat, kann
kann beim [[EZ-USB_Firmware_Kit_-_Tutorial | EZ-USB Firmware Kit - Tutorial]] weiterlesen.

Um diese Wiki nicht mit allzu vielen redundanten Informationen zu fluten, werden die ZTEX-Module, für welche das Firmware-Kit schwerpunktmäßig entwickelt wurde, am Ende dieses Artikels zusammengefasst vorgestellt.

==Firmware-Kit==
Für den EZ-USB FX2 Mikrocontroller steht ein quelloffenes Firmware-Kit mit plattformunabhängiger Treiber API zur Verfügung.

Die allgemeinen (Modul-unabhängigen) Grundfunktionen sind
* Hochladen der Firmware direkt in den EZ-USB Mikrocontroller
* EEPROM-Interface zum Lesen / Scheiben von Daten in den / aus dem EEPROM-Speicher
* Hochladen der Firmware in den EEPROM

Diese Funktionen werden firmwareseitig mittels Endpoint 0-Interfaces und dazugehörigen Routinen realisiert, welche automatisch in die mit dem Firmware-Kit entwickelte Firmware eingebunden werden. PC-seitig können diese Interfaces mit einem Werkzeug angesprochen oder mittels der Treiber-API in eigene Programme eingebunden werden.

Um einen schnellen Einstieg in die Entwicklung zu ermöglichen, wird die Firmware mittels eine Makro-Prozessors zusammengebaut. Dieser ermöglicht es Beispielsweise, die Endpoint-Konfiguration mittels weniger Makros (ein Makro pro Endpoint) festzulegen. Alle notwendigen Device-Deskriptoren sowie die notwendigen Routinen zur Ausgabe der Deskriptoren werden vom Firmware-Kit automatisch erstellt.

Im Normalfall kann sich der Entwickler also auf seine selbst benötigten Funktionen konzentrieren und sich ein exzessives Studium der Datenblätter zumindest teilweise ersparen. Der Quelltext einer typischen Firmware ist somit recht kompakt, wie im [[EZ-USB_Firmware_Kit_-_Tutorial#ucecho.c|EZ-USB Firmware-Kit Tutorial]] demonstriert wird.

Zum dem Firmware-Kit gehört ferner eine Java Treiber-API. Mit dieser können plattformunabhängige (zurzeit Linux und Windows, weitere Portierungen möglich) PC-Programme zur Kommunikation mit dem Gerät geschrieben werden. Das Interessante daran ist, dass alle benötigten Dateien (Firmware für den Microcontroller, Bitstream für das FPGA, plattformabhängige Bibliotheken, ...) in ein einzelnes .jar-Archiv verfrachtet werden können. Der (End)Benutzter benötigt / sieht somit nur eine einzige Datei, welche von von jedem Verzeichnis aus aufgerufen werden kann und sowohl unter Windows als auch unter Linux funktioniert.

== FPGA-Programmierung ==
Die Programmierung des FPGA's (genauer gesagt die Konfiguration des FPGA's) bei den
[http://www.ztex.de/usb-fpga-1/usb-fpga-1.2.d.html ZTEX USB-FPGA-Modulen]
erfolgt über den EZ-USB Mikrocontroller und erfordert kein zusätzliches JTAG-Kabel.

Zu diesem Zweck steht ein Endpoint 0-Interface zur Verfügung, welches automatisch in die EZ-USB Firmware für diese Module eingebunden wird. Dieses Interface wird mittels eines zum Firmware-Kit gehörenden Werkzeuges oder mit selbst enwickelter Software mit der JAVA-API angesprochen.

== Tutorial ==
Interesse? [[EZ-USB_Firmware_Kit_-_Tutorial#ucecho.c|Hier gehts weiter zum EZ-USB Firmware-Kit Tutorial]].

== ZTEX-Module ==
Die ZTEX-Module sind hauptsächlich zum Einsatz bei Prototypen und Kleinserien gedacht und verfügen deshalb nur über notwendige oder wichtige Funktionen, d.h. keine Taster, Blinklichter, ... . Mittels Erweiterungen können diese Boards aber auch zu vollwertigen Experimentierboards ausgebaut werden.

=== USB-FPGA-Modul 1.2 ===

==== Eigenschaften ====
<ul>
<li> High-Speed (480 MBit/s) USB-Interface via Mini-USB-Buchse (Typ B)</li>
<li> Cypress CY7C68013A/14A EZ-USB-Mikrocontroller </li>
<li> Xilinx Spartan-3 XC3S400 FPGA </li>
<li>
60 General Purpose I/O's (GPIO):
<ul>
<li> 52 FPGA GPIO's </li>
<li> 8 EZ-USB FX2 GPIO's (4, wenn Flash-Option installiert) </li>
</ul>
</li>
<li>
20 spezial-I/O's (SIO):
<ul>
<li> 6 SIO's für die FPGA-Konfiguration einschließlich JTAG </li>
<li> 2 serielle Schnittstellen (4 Pins) </li>
<li> I2C-Interface (2 Pins) </li>
<li> 2 Interrupts </li>
<li> 3 Timer </li>
<li> 1 Takt-Ausgang </li>
<li> 1 Wakeup-Pin </li>
<li> 1 Breakpoint-Pin </li>
</ul>
</li>
<li> Externe Stromversorgung </li>
<li> FPGA-Konfiguration / -Programmierung via USB mittels des [http://www.ztex.de/firmware-kit/index.d.html Firmware-Kits]. (Keine JTAG-Adapter oder andere zusätzliche Hilfsmittel erforderlich.)</li>
<li> 128 Kbit EEPROM-Speicher </li>
<li> Flash-Speicher (optional) </li>
</ul>

==== Experimentierboard ====
<ul>
<li> Integrierte Stromversorgung
<ul>
<li> Großer Eingangs-Bereich von 8 bis 25 V </li>
<li> Liefert alle benötigten Spannungen mittels hocheffizienten Schaltreglern:
<ul>
<li> 1,2 V @ 1,6 A (3 A Spitze) </li>
<li> 2,5 V @ 1,6 A (3 A Spitze) </li>
<li> 3,3 V @ 1,6 A (3 A Spitze) </li>
</ul></li>
<li> I/O-Spannungen VCCO_RIGHT und VCCO_TOP können einfach und unabhängig voneinander auf
3,3 V; 2,5 V; 1,2 V oder eine externe Spannung gesetzt werden </li>
</ul></li>
<li> Alle I/O Ports sind auf einem 2,54 mm-Standard-Raster mittels vier 1x23-Pin-Verbindern verfügbar ([http://localhost/ztex/ztex/usb-fpga-1/exp3.d.html Erweiterungs-Boards] oder [http://localhost/ztex/ztex/usb-fpga-1/accessories.d.html#bread Breadboards] sind erhältlich) </li>
<li> Zwei serielle Interfaces mit Treiber </li>
<li> JTAG-Interface für das FPGA </li>
</ul>

==== Verweise ====
*[http://www.ztex.de/usb-fpga-1/usb-fpga-1.2.d.html Homepage des USB-FPGA-Moduls 1.2 mit detaillierter Beschreibung]
*[http://www.ztex.de/downloads/usb-fpga-1.2.pdf Schaltplan]
*[http://www.ztex.de/usb-fpga-1/exp-1.1.d.html Experimentierboard]
*[http://www.ztex.de/usb-fpga-1/pwr-1.0.d.html Stromversorgungsmodul]
*[http://www.ztex.de/usb-fpga-1/index.d.html Komplette Produktserie]

==== Bilder ====
[[Bild:usb-fpga-1.2-top1.jpg]] 
USB-FPGA Modul im Größenvergleich

[[Bild:usb-fpga-1.2-exp1.jpg]] 
USB-FPGA-Modul auf Experimentierboard mit zwei Erweiterungsplatinen

[[Bild:usb-fpga-1.2-exp2.jpg]] 
USB-FPGA-Modul auf Experimentierboard mit zwei Steckbrettern / Breadboards

=== USB-Modul ===

==== Eigenschaften ====
<ul>
<li> High-Speed (480 MBit/s) USB-Interface </li>
<li> Cypress EZ-USB FX2 CY7C68014A Mikrocontroller </li>
<li> microSD-Sockel für bis zu 2GB Flash-Speicher </li>
<li> 36 General-Purpose I/O's (GPIO); 40, wenn keine microSD-Karte eingesetzt </li>
<li>
28 spezial-I/O's (SIO):
<ul>
<li> 2 serielle Schnittstellen (4 Pins) </li>
<li> I2C-Interface (2 Pins) </li>
<li> 2 Interrupts </li>
<li> 3 Timer </li>
<li> 13 GPIF (General Purpose Interface) Signale (Control, Ready, programmierbare Flags) </li>
<li> 1 Takt-Ausgang </li>
<li> 1 Wakeup-Pin </li>
<li> 1 Breakpoint-Pin </li>
<li> 1 Reset-Pin </li>
</ul>
</li>
<li> 128 Kbit EEPROM </li>
<li> Hocheffizienter onboard 3,3 V / 700 mA (1,3 A Spitze) Schaltregler
<ul>
<li> Unterstützt Stromversorgung via USB </li>
<li> Unterstützt externe Stromversorgung mit 4,6 bis 20 V </li>
<li> Beide Versorgungseingänge sind mit Dioden geschützt und können somit sicher gleichzeitig betrieben werden </li>
</ul>
</li>
</ul>

==== Verweise ====
*[http://www.ztex.de/usb-1/usb-1.0.d.html Homepage des USB-Moduls mit detaillierter Beschreibung]
*[http://www.ztex.de/downloads/usb-1.0.pdf Schaltplan]
*[http://www.ztex.de/usb-1/index.d.html Komplette Produktserie]

==== Bilder ====
[[Bild:usb-1.0-top1.jpg|800px]] 
USB Modul auf 3er-Ketten-Prototypenboard

[[Kategorie:Mikrocontroller]]
[[Kategorie:FPGA_und_Co]]
[[Kategorie:Boards]]
[[Kategorie:8051]]

2009-08-19T14:35:14Z

Stefan2: initial release

== Einleitung ==

[http://www.ztex.de ZTEX] stellt ein Firmware-Kit mit zugehörigem Treiber-API zur Verfügung, welches speziell für die ZTEX USB-/FPGA-Module entworfen wurde aber auch mit anderer EZ-USB basierter Hardware zusammen arbeitet.

Das Paket ist quelloffen und wird wird unter GPLv3 vertrieben.

Das Paket läuft unter Linux und Windows. (Die Portierung auf andere Betriebssysteme sollte problemlos möglich sein). Die Java-Treiber-API ermöglicht die Entwicklung von plattformübergreifenden Geräte-Treibern.

== Wichtigste Eigenschaften des Pakets ==

* Firmware-Kit (für EZ-USB Mikrocontroller) in C geschrieben (erfordert SDCC-Compiler).
* Zusammenbau der Firmware erfolgt mittels Makro-Prozessor. Dieser ermöglicht mit wenigen Makros alle erforderlichen Einstellungen festzulegen. Die benötigten '''USB-Deskriptoren und die dazugehörigen Routinen werden automatisch generiert'''.
* Treiber-API ist in Java geschrieben und ermöglicht Plattform-unabhängige Geräte-Treiber.
* Open-Source unter GPLv3 lizenziert
* Hauptfunktionen des Firmware-Kits / Treiber-API's:
** Hochladen der Firmware direkt in den EZ-USB Mikrocontroller
** EEPROM-Interface zum Lesen / Scheiben von Daten in den / aus dem EEPROM-Speicher
** Hochladen der Firmware in den EEPROM
** Hochladen des Bitstreams in das FPGA (für [http://http://www.ztex.de/usb-fpga-1/index.e.html ZTEX-USB-FPGA-Module])

== Systemvoraussetzungen ==
Die Systemvoraussetzungen für das Kompilieren der Firmware und der Treiber sind
* Java JDK 6 oder später
* SDCC
* MSys (nur für Windows)

Die Systemvoraussetzungen für das Ausführen der Beispiele bzw. der selbst erstellten Software sind

* Java JRE 6 oder später

== Download / Homepage / weitere Informationen ==
* '''[http://www.ztex.de/downloads/index.d.html#firmware_kit Downloads]'''
* [http://www.ztex.de/firmware-kit/index.d.html Homepage des Firmware Kits]
* [http://wiki.ztex.de/doku.php?id=de:start ZTEX Wiki]

== Beispiel ==

Das folgende Beispiel für [http://www.ztex.de/usb-fpga-1/usb-fpga-1.2.d.html ZTEX USB-FPGA-Module] demonstriert den verwendeten Makro-Ansatz des Firmware-Kits. Das Beispiel ist ein Bestandteil des Firmware-Kits.

Die Firmware (definiert in [[#ucecho.c| ucecho.c]])
legt die Endpoints 2 und 4 fest
(beide 512 Bytes, doppel-gepuffert, Bulk-Transfer, zu Interface 0 gehörig).
Alle zum Endpoint 4 geschriebenen Daten werden vom FPGA in Großbuchstaben konvertiert und können von Endpoint 2 zurückgelesen werden.

Der Bitstream für die FPGA-Konfiguration wird in [[#ucecho.vhd| ucecho.vhd]] definiert. Das FPGA liest pro Taktzyklus ein Byte von Port ''PC'', konvertiert es in Großbuchstaben und schreibt es nach Port ''PB'' zurück.

Der Treiber (definiert in [[#UCEcho.java| UCEcho.java]]) lädt bei Bedarf die Firmware in dem EZ-USB-Mikrocontroller
und den Bitstream in das FPGA hoch, sendet Benutzer-Strings zum Gerät und liest diese zurück.

Das Hochladen der Firmware in den EEPROM wird ebenfalls unterstützt (z.B. mittels des zum Paket gehörenden Werkzeugs ''FWLoader'').

=== ucecho.c ===
Das ist der C-Quellcode für die Firmware:
<c>
#include[ztex-conf.h] // Loads the configuration macros, see ztex-conf.h for the available macros
#include[ztex-utils.h] // include basic functions

// Cypress vendor ID and product ID may only (!) be used for experimental purposes
SET_VPID(0x4b4,0x8613);

// define endpoints 2 and 4, both belong to interface 0 (in/out are from the point of view of the host)
EP_CONFIG(2,0,BULK,IN,512,2);
EP_CONFIG(4,0,BULK,OUT,512,2);

// identify as ZTEX USB FPGA Module 1.2 (Important for FPGA configuration)
IDENTITY_UFM_1_2(1.0.0.0,0);

// give them a nice name
#define[PRODUCT_STRING]["ucecho for USB FPGA MODULE 1.2"]

// this is called automatically after FPGA configuration
#define[POST_FPGA_CONFIG][POST_FPGA_CONFIG
OEC = 255;
]

// include the main part of the firmware kit, define the descriptors, ...
#include[ztex.h]

void main(void)
{
WORD i,size;

// init everything
init_USB();

EP2CS &= ~bmBIT0; // stall = 0
SYNCDELAY;
EP4CS &= ~bmBIT0; // stall = 0

SYNCDELAY; // first two packages are waste
EP4BCL = 0x80; // skip package, (re)arm EP4
SYNCDELAY;
EP4BCL = 0x80; // skip package, (re)arm EP4

while (1) {
if ( !(EP4CS & bmBIT2) ) { // EP4 is not empty
size = (EP4BCH << 8) | EP4BCL;
if ( size>0 && size<=512 && !(EP2CS & bmBIT3)) { // EP2 is not full
for ( i=0; i<size; i++ ) {
IOC = EP4FIFOBUF[i]; // data from EP4 is converted to uppercase by the FPGA ...
EP2FIFOBUF[i] = IOB; // ... and written back to EP2 buffer
}
EP2BCH = size >> 8;
SYNCDELAY;
EP2BCL = size & 255; // arm EP2
}
SYNCDELAY;
EP4BCL = 0x80; // skip package, (re)arm EP4
}
}
}
</c>

=== ucecho.vhd ===
Das ist der VHDL-Quellcode für die FPGA-Konfiguration:
<vhdl>
library ieee;
use IEEE.std_logic_1164.all;
use IEEE.numeric_std.all;

entity ucecho is
port(
pc : in unsigned(7 downto 0);
pb : out unsigned(7 downto 0);
CLK : in std_logic
);
end ucecho;

--signal declaration
architecture RTL of ucecho is

begin
dpUCECHO: process(CLK)
begin
if CLK' event and CLK = '1' then
if ( pc >= 97 ) and ( pc <= 122)
then
pb <= pc - 32;
else
pb <= pc;
end if;
end if;
end process dpUCECHO;

end RTL;
</vhdl>

=== UCEcho.java ===
Das ist der Java-Quellcode für die PC-seitige Software / für den Treiber:
<c>
import java.io.*;
import java.util.*;

import ch.ntb.usb.*;

import ztex.*;

// *****************************************************************************
// ******* ParameterException **************************************************
// *****************************************************************************
// Exception the prints a help message
class ParameterException extends Exception {
public final static String helpMsg = new String (
"Parameters:\n"+
" -d <number> Device Number (default: 0)\n" +
" -f Force uploads\n" +
" -p Print bus info\n" +
" -h This help" );

public ParameterException (String msg) {
super( msg + "\n" + helpMsg );
}
}

// *****************************************************************************
// ******* Test0 ***************************************************************
// *****************************************************************************
class UCEcho extends Ztex1v1 {

// ******* UCEcho **************************************************************
// constructor
public UCEcho ( ZtexDevice1 pDev ) throws UsbException, ZtexDescriptorException {
super ( pDev );
}

// ******* claimInterface ******************************************************
// claims interface 0
public void claimInterface ( ) throws UsbException{
if ( LibusbJava.usb_claim_interface(handle(), 0) < 0 )
throw new UsbException("Claiming interface 0 failed: " + LibusbJava.usb_strerror());
}

// ******* releaseInterface ****************************************************
// releases interface 0
public void releaseInterface ( ) {
LibusbJava.usb_release_interface(handle(), 0);
}

// ******* echo ****************************************************************
// writes a string to Endpoint 4, reads it back from Endpoint 2 and writes the output to System.out
public void echo ( String input ) throws UsbException {
byte buf[] = input.getBytes();
int i = LibusbJava.usb_bulk_write(handle, 4, buf, buf.length, 1000);
if ( i<0 )
throw new UsbException("Error sending data: " + LibusbJava.usb_strerror());
System.out.println("Send "+i+" bytes: `"+input+"'" );

try {
Thread.sleep( 10 );
}
catch ( InterruptedException e ) {
}

buf = new byte[1024];
i = LibusbJava.usb_bulk_read(handle, 2, buf, 1024, 1000);
if ( i<0 )
throw new UsbException("Error receiving data: " + LibusbJava.usb_strerror());
System.out.println("Read "+i+" bytes: `"+new String(buf,0,i)+"'" );
}

// ******* main ****************************************************************
public static void main (String args[]) {

int devNum = 0;
boolean force = false;

try {
// init USB stuff
LibusbJava.usb_init();

// scan the USB bus
ZtexScanBus1 bus = new ZtexScanBus1( ZtexDevice1.cypressVendorId, ZtexDevice1.cypressProductId, true, false, 1);
if ( bus.numberOfDevices() <= 0) {
System.err.println("No devices found");
System.exit(0);
}

// scan the command line arguments
for (int i=0; i<args.length; i++ ) {
if ( args[i].equals("-d") ) {
i++;
try {
if (i>=args.length) throw new Exception();
devNum = Integer.parseInt( args[i] );
}
catch (Exception e) {
throw new ParameterException("Device number expected after -d");
}
}
else if ( args[i].equals("-f") ) {
force = true;
}
else if ( args[i].equals("-p") ) {
bus.printBus(System.out);
System.exit(0);
}
else if ( args[i].equals("-h") ) {
System.err.println(ParameterException.helpMsg);
System.exit(0);
}
else throw new ParameterException("Invalid Parameter: "+args[i]);
}

// create the main class
UCEcho ztex = new UCEcho ( bus.device(devNum) );

// upload the firmware if necessary
if ( force || ! ztex.valid() || ! ztex.dev().productString().equals("ucecho for USB FPGA MODULE 1.2") ) {
ztex.uploadFirmware( "ucecho.ihx", force );
}

// upload the bitstream if necessary
if ( force || ! ztex.getFpgaConfiguration() ) {
System.out.println("FPGA configuration time: " + ztex.configureFpga( "fpga/ucecho.bin" , force ) + " ms");
}

// claim interface 0
ztex.claimInterface();

// read string from stdin and write it to USB device
String str = "";
BufferedReader reader = new BufferedReader( new InputStreamReader( System.in ) );
while ( ! str.equals("quit") ) {
System.out.print("Enter a string or `quit' to exit the program: ");
str = reader.readLine();
ztex.echo(str);
System.out.println("");
}

// release interface 0
ztex.releaseInterface();

}
catch (Exception e) {
System.out.println("Error: "+e.getLocalizedMessage() );
}
}

}
</c>

== Installation des Pakets ==
Das Paket ist als tar.bz2- und als zip-Archiv verfügbar und kann z.B. mittels der Kommandos

bunzip2 -c ztex-<release number>.tar.bz2 | tar -x

oder

unzip ztex-<release number>.zip,

entpackt werden.

== Kompilieren des Beispiels ==

Die Regeln zum Zusammenbauen der Binaries werden mittels ''Makefile'''s festgelegt, d.h. eine GNU-Umgebung ist erforderlich. Das Kompilieren geschieht in folgenden Schritten:

# Sicherstellen, dass die [[#Systemvoraussetzungen|Systemvoraussetzungen]] erfüllt sind, insbesondere dass ''javac'' bzw. ''javac.exe'' -- der Java-Kompiler gefunden werden kann (per ''PATH'' Umgebungsvariable)
# Ein Terminal (Linux) öffnen oder MSys (Windows) starten
# Angenommen das Firmware-Kit wurde im Verzeichnis $HOME/ztex (Linux) oder im Verzeichniss c:\ztex (Windows) installiert. (Das aufgelistete Beispiel befindet sich im Unterverzeichnis ''examples/usb-fpga-1.2/ucecho/''.) In dieses Verzeichnis kann mittels der Befehle <code>cd $HOME/ztex/examples/usb-fpga-1.2/ucecho/</code> unter Linux, bzw. <code> cd /c/ztex/examples/usb-fpga-1.2/ucecho/</code> unter Windows+MSys gewechselt werden.
# Das Kommando <code>make</code> baut alles zusammen (einschließlich der Firmware) und packt es in ein .jar-Archiv.

== Ausführen des Beispiels ==
Zum Ausführen des Beispiels wird nur die .jar-Datei benötigt, welche sowohl unter Linux als auch unter Windows läuft. (Unter Windows muss der Treiber libusb-win32 installiert sein.) Diese .jar-Datei enthält den Java-Bytecode, die Firmware für den EZ-USB Microcontroller, den Bitstream für das FPGA und die Betriebssystem-abhängigen Bibliotheken. Das Ausführen geschieht in folgenden Schritten:

# '''Nur Windows:''' Den Treiber libusb-win32 bei Bedarf installieren, d.h. libusb-win32 dem Gerät wie folgt zuweisen:
## Das Gerät anstecken
## Wenn Windows nach dem Treiber fragt, die Datei ''cypress.inf'' aus dem Unterverzeichnis ''libusb-win32'' des Firmware-Kits auswählen. (Diese Datei ist gültig, falls die Cypress Hersteller- und Produkt-ID verwendet wird, was nur zu experimentellen Zwecken bei nichtöffentlicher Verwendung gestattet ist. Im Fall einer anderen Hersteller- und Produkt-ID kann mittels des Werkzeuges ''inf-wizard.exe'' im Unterverzeichnis ''libusb-win32''eine neue .inf Datei erstellt werden.
# Das Beispiel mittels des Kommandos <code>java -cp UCEcho.jar UCEcho</code> ausführen. Da die .jar-Datei alles enthält, was zum Ausführen des Beispiels notwendig ist, kann die Datei an jede Stelle kopiert / von jeder Stelle aus ausgeführt werden.

Ein Beispielaufruf sieht wie folgt aus:
<code><pre>
stefan@ws2:/drv_a2/usb-fpga/ztex-1.1/examples/usb-fpga-1.2/ucecho$ java -cp UCEcho.jar UCEcho
FPGA configuration time: 1353 ms
Enter a string or `quit' to exit the program: Hello world!
Send 12 bytes: `Hello world!'
Read 12 bytes: `HELLO WORLD!'

Enter a string or `quit' to exit the program: quit
Send 4 bytes: `quit'
Read 4 bytes: `QUIT'
</pre></code>