Fx2lafw

2015-01-02T10:53:13Z

Spider: /* Hardware overview */

{{DISPLAYTITLE:fx2lafw}}
'''fx2lafw''' is an open-source firmware for Cypress FX2 chips which makes them usable as simple logic analyzer hardware.

It is licensed under the terms of the '''GNU GPL (version 2, or later)''' and written in C, using [http://sdcc.sourceforge.net/ sdcc] as compiler, and [https://github.com/mulicheng/fx2lib fx2lib] as helper library.

== Hardware overview ==

The fx2lafw firmware is meant to work on any FX2-based hardware, including logic analyzers, FX2 eval boards, or other hardware which has this chip on-board.

Here's a quick overview of some of the relevant hardware information we have about the various devices.

The devices marked as '''Clone''' are those that clone the USB VID/PID of the original product, and also have no own PC software/firmware, but instead illegally ship the software of the original product/manufacturer.

{| border="0" style="font-size: smaller" class="alternategrey sortable sigroktable"
|-
!Device
!USB VID:PID
!Product type
!Probes (pins)
!FX2 package
!Buffer / ESD-protection
!Resistors
!I2C EEPROM
!Status

|-
| [http://translate.google.com/translate?sl=ru&tl=en&u=http%3A%2F%2Fwww.6-lab.com%2Fen%2Flogic-u.html 6-Lab LOGIC-U]5
| ?
| Clone (Logic)
| ?
| ?
| ?
| ?
| ?
| bgcolor="lime" | 100%

|-
| [http://translate.google.com/translate?sl=ru&tl=en&u=http://www.6-lab.com/en/logic-u-plus.html 6-Lab LOGIC-U PLUS]5
| ?
| Clone (AX-Pro)
| ?
| ?
| ?
| ?
| ?
| bgcolor="lime" | 95%1

|-
| [http://translate.google.com/translate?sl=ru&tl=en&u=http%3A%2F%2F6-lab.com%2Fen%2Flogicupro.html 6-Lab LOGIC-U PRO]5
| ?
| Clone (AX-Pro)
| ?
| ?
| ?
| ?
| ?
| bgcolor="lime" | 95%1

|-
| [http://translate.google.com/translate?sl=ru&tl=en&u=http%3A%2F%2F6-lab.com%2Fen%2Flogicuisl.html 6-Lab LOGIC-U ISL]5
| ?
| Clone (Logic)
| ?
| ?
| ?
| ?
| ?
| bgcolor="lime" | 100%

|-
| [[ARMFLY AX-Pro]]
| 08a9:0014
| Clone (AX-Pro)
| 8 (+1 analog)
| 56LTXC (QFN)
| ?
| 100 Ω
| Atmel ATML920 24C02N SU27 D
| bgcolor="lime" | 95%1

|-
| [[ARMFLY Mini-Logic]]2
| 08a9:0014
| Clone (AX-Pro w/o scope)
| 8
| 56LTXC (QFN)
| ?
| 100 Ω
| Atmel ATML920 24C02N SU27 D
| bgcolor="lime" | 100%

|-
| [[Braintechnology USB Interface V2.x]]
| 04b4:8613
| bgcolor="lime" | Eval board
| 8/16
| 56PVXC (SSOP)
| none
| none
| Microchip 24LC64I
| bgcolor="lime" | 100%

|-
| [[Braintechnology USB-LPS]]
| 16d0:0498
| bgcolor="lime" | Original product
| 8/16
| 56PVXC (SSOP)
| none
| ? 68 Ω
| Atmel ATML0816 TINY13 20SU
| bgcolor="lime" | 100%

|-
| [[CWAV BusBee]]
| ?
| bgcolor="lime" | Original product
| 4
| ?
| ?
| ?
| ?
| bgcolor="red" | TODO

|-
| [[CWAV USBee AX-Standard]]
| [http://www.mikrocontroller.net/topic/136039#1878129 08a9:0012]
| bgcolor="lime" | Original product
| ?
| ?
| ?
| ?
| ?
| bgcolor="red" | TODO

|-
| [[CWAV USBee AX-Plus]]
| [http://www.mikrocontroller.net/topic/136039#1878129 08a9:0013]
| bgcolor="lime" | Original product
| ?
| ?
| ?
| ?
| ?
| bgcolor="red" | TODO

|-
| [[CWAV USBee AX-Pro]]
| [http://www.mikrocontroller.net/topic/136039#1878129 08a9:0014]
| bgcolor="lime" | Original product
| 8 (+1 analog)
| ?
| ?
| ?
| ?
| bgcolor="lime" | 95%1

|-
| [[CWAV USBee DX]]
| [http://www.mikrocontroller.net/topic/136039#1878129 08a9:0015]
| bgcolor="lime" | Original product
| 16 (+2 analog)
| ?
| ?
| ?
| ?
| bgcolor="red" | TODO

|-
| [[CWAV USBee EX2]]
| ?
| bgcolor="lime" | Original product
| 8
| ?
| ?
| ?
| ?
| bgcolor="red" | TODO

|-
| [[CWAV USBee SX]]
| 08a9:0009
| bgcolor="lime" | Original product
| 8
| 56PVXC (SSOP)
| none
| 560 Ω
| Microchip 24LC01B
| bgcolor="lime" | 100%

|-
| [[CWAV USBee ZX]]
| 08a9:0005
| bgcolor="lime" | Original product
| 8
| 56PVXC (SSOP)
| none
| ?
| ?
| bgcolor="red" | TODO

|-
| [[EE Electronics ESLA100]]
| 0925:3881
| Clone (Logic)
| 8
| 56LFXC (QFN)
| NXP 74HC245D
| 100 Ω
| Atmel ATMLH911 02B 1
| bgcolor="lime" | 100%

|-
| [[EE Electronics ESLA201A]]
| 08a9:0014
| Clone (AX)
| 8 (+1 analog)
| 56LFXC (QFN)
| none
| 100 Ω
| Atmel ATMLH113
| bgcolor="lime" | 95%1

|-
| [http://iteadstudio.com/store/index.php?main_page=product_info&cPath=2&products_id=221 ITead Studio MiniLogic]4
| ?
| Clone (Logic, AX w/o scope)
| ?
| ?
| ?
| ?
| ?
| bgcolor="lime" | 100%

|-
| [http://iteadstudio.com/store/index.php?main_page=product_info&cPath=1&products_id=51 ITead Studio ITDB01]
| ?
| bgcolor="lime" | Eval board
| ?
| ?
| ?
| ?
| ?
| bgcolor="lime" | 100%

|-
| [[Lcsoft Mini Board]]
| 04b4:8613 / 0925:3881
| Eval board / Clone (Logic)
| 8/16
| 56PVXC (SSOP)
| none
| none
| Shenzhen First-Rank Technology T24C128A
| bgcolor="lime" | 100%

|-
| [[MCU123 Saleae Logic clone]]
| 0925:3881
| Clone (Logic)
| 8
| 56PVC (SSOP)
| NXP 74HC245
| 100 Ω
| Atmel AT24C02
| bgcolor="lime" | 100%

|-
| [[MCU123 USBee AX Pro clone]]2
| 08a9:0014
| Clone (AX-Pro w/o scope)
| 8
| 56PVXC (SSOP)
| NXP 74HC245
| 100 Ω
| Atmel AT24C02
| bgcolor="lime" | 100%

|-
| [http://www.ebay.co.uk/itm/MDSO-LA-20MHz-USB-Digital-oscilloscope-48M-Sampling-16-channel-logic-analyzer-/251119761248?pt=UK_BOI_Electrical_Test_Measurement_Equipment_ET&hash=item3a77e77760&_uhb=1 MDSO-LA]
| ?
| Clone (SX, AX-Pro)
| ?
| ?
| ?
| ?
| ?
| bgcolor="lime" | 100%

|-
| [http://translate.google.com/translate?sl=ru&tl=en&js=n&prev=_t&hl=de&ie=UTF-8&layout=2&eotf=1&u=http%3A%2F%2Fwww.rom.by%2Fforum%2FLogicheskij_analizator_signalov_USBee_AX_Saleae_Logic_45&act=url Mollex Logic Analyzer]3
| ?
| Clone (Logic, AX w/o scope)
| ?
| ?
| ?
| ?
| ?
| bgcolor="lime" | 100%

|-
| [http://translate.google.com/translate?hl=de&sl=zh-CN&tl=en&u=http%3A%2F%2Fitem.taobao.com%2Fitem.htm%3Fid%3D6076642324 Noname Saleae Logic clone I]
| ?
| Clone (Logic)
| ?
| ?
| ?
| ?
| ?
| bgcolor="lime" | 100%

|-
| [http://translate.google.com/translate?sl=cs&tl=en&js=n&prev=_t&ie=UTF-8&eotf=1&u=http%3A%2F%2Fpandatron.cz%2F%3F2729%26klon_logickeho_analyzatoru_saleae&act=url Pandatron PLA8] ([https://translate.googleusercontent.com/translate_c?act=url&depth=1&hl=de&ie=UTF8&prev=_t&rurl=translate.google.com&sl=cs&tl=en&u=http://pandatron.cz/%3Fshop%26sla%3D2%26pn%3D90113%26tx%3Dpla8_modul_-_logicky_analyzator_pro_usb&usg=ALkJrhjOD7bJQd1xRz_BFS3hxg31kE7FSQ S], [http://www.ebay.de/itm/USB-Logic-Analyzer-and-decoder-8-CH-10-GS-CY7C68013A-USB-2-0-/221154315071 E])
| ?
| Clone (Logic)
| 8
| 56PVXC (SSOP)
| SN74LVC245APWR
| 100 Ω
| ?
| bgcolor="lime" | 100%

|-
| [http://translate.google.com/translate?sl=ru&tl=en&u=http%3A%2F%2Fpicavr.kr1.ru%2FUSBAnalyzer%2FDigital_USB_Analyzer_v1.html picavr Digital USB Analyzer v1]
| ?
| Clone (Logic, AX w/o scope)
| ?
| ?
| ?
| ?
| ?
| bgcolor="lime" | 100%

|-
| [http://translate.google.com/translate?sl=ru&tl=en&u=http%3A%2F%2Fpicavr.kr1.ru%2FUSBAnalyzer%2FAD_USB_Analyzer_v2.html picavr A/D USB Analyzer v2]
| ?
| Clone (Logic, AX)
| ?
| ?
| ?
| ?
| ?
| bgcolor="lime" | 95%1

|-
| [http://translate.google.com/translate?sl=ru&tl=en&u=http%3A%2F%2Fpicavr.kr1.ru%2FUSBAnalyzer%2FAD_USB_Analyzer_v3.html picavr A/D USB Analyzer v3]
| ?
| Clone (Logic, AX)
| ?
| ?
| ?
| ?
| ?
| bgcolor="lime" | 95%1

|-
| [http://translate.google.com/translate?sl=ru&tl=en&u=http%3A%2F%2Fpicavr.kr1.ru%2FUSBAnalyzer%2FAD_USB_Analyzer_v4.html picavr A/D USB Analyzer v4]
| ?
| Clone (Logic, AX)
| ?
| ?
| ?
| ?
| ?
| bgcolor="lime" | 95%1

|-
| [http://lab.robomotic.com/index.php?page=shop.product_details&flypage=flypage.tpl&product_id=22&category_id=6&vmcchk=1&option=com_virtuemart&Itemid=56 Robomotic BugLogic 2]
| ?
| Clone (Logic, SX/ZX)
| ?
| ?
| ?
| ?
| ?
| bgcolor="lime" | 100%

|-
| [[Robomotic BugLogic 3]]
| 0925:3881
| Clone (Logic)
| 8
| ?
| ?
| ?
| ?
| bgcolor="lime" | 100%

|-
| [[Robomotic MiniLogic]]
| 0925:3881
| Clone (Logic, AX w/o scope)
| 8
| 56PVXC (SSOP)
| 74HC244A
| ?
| 2x Microchip 24LC02BI, 1x 24LC64I
| bgcolor="lime" | 100%

|-
| [http://lab.robomotic.com/index.php?page=shop.product_details&flypage=flypage.tpl&product_id=26&category_id=6&vmcchk=1&option=com_virtuemart&Itemid=56 Robomotic XZL024]7
| 08a9:0014
| Clone (AX-Pro)
| 8 (+2 analog)
| 56LTXC (QFN)
| ?
| 100 Ω
| Atmel 24C02N
| bgcolor="lime" | 95%1

|-
| [[Saleae Logic]]
| 0925:3881
| bgcolor="lime" | Original product
| 8
| 56PVXC (SSOP)
| ST DVIULC6-4SC6
| ?
| ?
| bgcolor="lime" | 100%

|-
| [http://www.wholesale-in-china.org/articles/article-194265.htm Sysclk Box]
| ?
| Clone (SX, AX-Pro w/o scope)
| ?
| ?
| ?
| ?
| ?
| bgcolor="lime" | 100%

|-
| [[XZL_Studio AX]]
| 08a9:0014
| Clone (AX-Pro)
| 8 (+2 analog)
| 56LTXC (QFN)
| ?
| 100 Ω
| Atmel 24C02N
| bgcolor="lime" | 95%1

|-
| [[XZL Studio DX]]6
| 2x 08a9:0015
| Clone (DX)
| 8/16
| 56PVXC (SSOP)
| ?
| ?
| Atmel ATML H136 24C02C M Y
| bgcolor="red" | TODO

|}

All devices use a 24MHz crystal. For 8 probes the FX2 pins PB0-PB7 are used, for 16 probes PB0-PB7 and PD0-PD7. For analog support PD0-PD7 (plus additional hardware) is usually used.


1 Analog signal support is not yet implemented. 
2 Even though this device has the same USB VID/PID as the CWAV USBee AX-Pro, it only has 8 channels and no analog support. 
3 Clone of the USBee AX and Saleae Logic. "Mollex" is the name of the guy who seems to sell it on some forum. 
4 Clone of the USBee AX (SX?) and Saleae Logic, see also [http://iteadstudio.com/copied/hack-a-saleae-logic-analyzer/ here] and [http://iteadstudio.com/produce/seleae-logic-usbee-ax-usb-blaster/ here]. Dissection by a user [http://www.todopic.com.ar/foros/index.php?topic=32657.0 here]. Seems to be the same hardware as the [[Robomotic MiniLogic]]. 
5 It seems 6-Labs [http://electronicsjunk.com/index.php?option=com_content&view=article&id=52:saleae-logic-analyzer-&catid=34:electronics&Itemid=59 has/had permission from Saleae] to distribute the hardware in Ukraine (only)? [http://translate.google.com/translate?sl=ru&tl=en&u=http%3A%2F%2F6-lab.com%2Fen%2Flogic-u-adapters.html Various adapters] are available, for example RS422/RS232/CAN, galvanic isolation, "BNC divider". 
6 There is apparently [http://we.easyelectronics.ru/Turtleblast/poluchil-xzl-studio-ax.html#comment53143 a post from the author of XZL-Studio DX] in some forum. 
7 There's [http://lab.robomotic.com/shop?page=shop.product_details&flypage=flypage.tpl&product_id=27&category_id=6 an RS232/RS485/RS422/CAN converter board] for this. 


== Download ==

Released versions of the source code can be downloaded here:

http://sigrok.org/download/source/sigrok-firmware-fx2lafw/

There are also '''pre-built firmware files''' that can be used without having to build them from source:

http://sigrok.org/download/binary/sigrok-firmware-fx2lafw/

Or you can get the latest development snapshot of the source code from git:

$ '''git clone git://sigrok.org/sigrok-firmware-fx2lafw'''

You can also [http://sigrok.org/gitweb/?p=sigrok-firmware-fx2lafw.git;a=tree browse the source code] via gitweb.

== Usage ==

=== Build sigrok ===

* Build and install a [[libsigrok]] frontend (CLI or GUI) with libsigrok >= 0.1.1 (or latest git HEAD) for your platform as usual, see [[Building]].

=== Install the udev rules file ===

These steps prevent the need to run libsigrok frontends as superuser.

* Copy the udev rules file from '''libsigrok/contrib/z60_libsigrok.rules''' to '''/etc/udev/rules.d/''' (or where-ever your distribution stores udev rules files).
* Restart udev: '''sudo /etc/init.d/udev restart'''.

=== Build fx2lafw ===

$ '''cd sigrok-firmware-fx2lafw'''
$ '''./autogen.sh'''
$ '''./configure'''
$ '''make'''
$ '''sudo make install'''

This will install the firmware files into '''/usr/local/share/sigrok-firmware/''', per default.

=== Pre-built firmware files ===

There are also pre-built firmware files that can be used without having to build them from source (see [[#Download|above]]).

== Cypress FX2 vs. FX2LP ==

Various devices supported by fx2lafw can use either the older Cypress CY7C68013 (FX2) or the more recent Cypress CY7C68013A (FX2LP).

There are [http://www.cypress.com/?id=4&rID=31723 various differences] between the two ICs, see [http://www.cypress.com/?rID=12968 AN4078 - Migrating From EZ-USB FX2 to EZ-USB FX2LP] ([http://www.cypress.com/?docID=39449 PDF]) for the details.

There are known cases of e.g. the [[CWAV USBee SX]] having shipped with an FX2 at some point, and more recent units shipping with an FX2LP. Also, it's not too uncommon that some FX2 "eval board" or clone of an existing logic analyser (e.g. [[CWAV USBee SX]] or [[Saleae Logic]] ones) has "CY7C68013A (FX2LP)" chip markings, but in reality it really is an older "CY7C68013 (FX2)".

The fx2lafw firmware supports both devices (FX2 and FX2LP).

== Resources ==

* [http://sdcc.sourceforge.net/ sdcc] (C compiler for 8051 microcontrollers, usable for FX2)
* fx2lib: [http://sourceforge.net/projects/fx2lib/ SF project page], [http://allmybrain.com/2008/12/05/an-open-source-library-for-writing-firmware-on-the-cypress-fx2-with-sdcc/ blog article], [https://github.com/mulicheng/fx2lib github repo], [http://sourceforge.net/mailarchive/forum.php?forum_name=fx2lib-devel mailing list]
* [http://www.cypress.com/?id=193 Cypress FX2] docs:
** [http://www.cypress.com/?rID=38801 CY7C68013A, CY7C68014A, CY7C68015A, CY7C68016A datasheet] ([http://www.cypress.com/?docID=34060 PDF])
** [http://www.cypress.com/?rID=38232 EZ-USB Technical Reference Manual (TRM)] ([http://www.cypress.com/?docID=27095&dlm=1 PDF])
** [http://www.cypress.com/?id=193&rtID=76 EZ-USB FX2LP appnotes]
** [http://www.cypress.com/?id=193&rtID=111 EZ-USB FX2LP errata]
** [http://www.cypress.com/?rID=14448 GPIF Designer] (Windows software, requires login)
*** [http://www.cypress.com/?rID=14319 CY3681 EZ-USB FX2 Development Kit] (GPIF designer downloadable without login)
** [http://www.cypress.com/?rID=12968 AN4078 - Migrating From EZ-USB FX2 to EZ-USB FX2LP] ([http://www.cypress.com/?docID=39449 PDF])

sigrok - User contributions [en]

Fx2lafw