]> sigrok.org Git - sigrok-firmware-fx2lafw.git/commitdiff
Initial version (work in progress).
authorUwe Hermann <redacted>
Tue, 14 Feb 2012 20:22:55 +0000 (21:22 +0100)
committerUwe Hermann <redacted>
Tue, 14 Feb 2012 20:22:55 +0000 (21:22 +0100)
This does not work, yet.

COPYING [new file with mode: 0644]
Makefile [new file with mode: 0644]
README [new file with mode: 0644]
dscr.a51 [new file with mode: 0644]
fx2lafw.c [new file with mode: 0644]

diff --git a/COPYING b/COPYING
new file mode 100644 (file)
index 0000000..d511905
--- /dev/null
+++ b/COPYING
@@ -0,0 +1,339 @@
+                   GNU GENERAL PUBLIC LICENSE
+                      Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                           Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                   GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                           NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                    END OF TERMS AND CONDITIONS
+
+           How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.
diff --git a/Makefile b/Makefile
new file mode 100644 (file)
index 0000000..7a9f294
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,26 @@
+##
+## This file is part of the fx2lafw project.
+##
+## Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
+##
+## This program is free software; you can redistribute it and/or modify
+## it under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 2 of the License, or
+## (at your option) any later version.
+##
+## This program is distributed in the hope that it will be useful,
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+## GNU General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with this program; if not, write to the Free Software
+## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+##
+
+SOURCES = fx2lafw.c
+A51_SOURCES = dscr.a51
+BASENAME = fx2lafw
+
+include fx2lib/lib/fx2.mk
+
diff --git a/README b/README
new file mode 100644 (file)
index 0000000..2295a7e
--- /dev/null
+++ b/README
@@ -0,0 +1,45 @@
+------------------------------------------------------------------------------
+fx2lafw
+------------------------------------------------------------------------------
+
+fx2lafw is a free/libre/open-source firmware for logic analyzers based on
+the Cypress EZ-USB FX2(LP) chip.
+
+It is licensed under the terms of the GNU GPL (version 2 or later).
+
+Requirements
+------------
+
+In order to build fx2lafw you need the 'sdcc' compiler.
+
+On Debian you can install it via:
+
+  $ apt-get install sdcc
+
+In order to transfer the firmware onto the FX2 chip, you can use cycfx2prog:
+
+  $ apt-get install cycfx2prog
+
+Building
+--------
+
+  $ git clone ...
+  $ cd fx2lafw
+  $ git clone git://github.com/mulicheng/fx2lib.git
+  $ make
+
+Usage
+-----
+
+ $ cycfx2prog -id=vvvv:pppp prg:build/fx2lafw.ihx reset run delay:100
+
+You have to provide the USB VID/PID of the FX2 device (before firmware
+upload) using the -id parameter.
+
+Website
+-------
+
+See the fx2lafw website for further information:
+
+  http://sigrok.org/wiki/Fx2lafw
+
diff --git a/dscr.a51 b/dscr.a51
new file mode 100644 (file)
index 0000000..3a5e9dc
--- /dev/null
+++ b/dscr.a51
@@ -0,0 +1,227 @@
+;;
+;; This file is part of the fx2lafw project.
+;;
+;; Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
+;;
+;; This program is free software; you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation; either version 2 of the License, or
+;; (at your option) any later version.
+;;
+;; This program is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+;;
+;; You should have received a copy of the GNU General Public License
+;; along with this program; if not, write to the Free Software
+;; Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+;;
+
+.module DEV_DSCR
+
+; Descriptor types
+DSCR_DEVICE_TYPE       = 1
+DSCR_CONFIG_TYPE       = 2
+DSCR_STRING_TYPE       = 3
+DSCR_INTERFACE_TYPE    = 4
+DSCR_ENDPOINT_TYPE     = 5
+DSCR_DEVQUAL_TYPE      = 6
+
+; Descriptor lengths
+DSCR_INTERFACE_LEN     = 9
+DSCR_ENDPOINT_LEN      = 7
+
+; Endpoint types
+ENDPOINT_TYPE_CONTROL  = 0
+ENDPOINT_TYPE_ISO      = 1
+ENDPOINT_TYPE_BULK     = 2
+ENDPOINT_TYPE_INT      = 3
+
+.globl _dev_dscr, _dev_qual_dscr, _highspd_dscr, _fullspd_dscr, _dev_strings, _dev_strings_end
+.area DSCR_AREA (CODE)
+
+; -----------------------------------------------------------------------------
+; Device descriptor
+; -----------------------------------------------------------------------------
+_dev_dscr:
+       .db     dev_dscr_end - _dev_dscr
+       .db     DSCR_DEVICE_TYPE
+       .dw     0x0002                  ; USB 2.0
+       .db     0xff                    ; Class (vendor specific)
+       .db     0xff                    ; Subclass (vendor specific)
+       .db     0xff                    ; Protocol (vendor specific)
+       .db     64                      ; Max. EP0 packet size
+       .dw     0x6666                  ; Manufacturer ID (0x6666)
+       .dw     0x1900                  ; Product ID (0x0019)
+       .dw     0x0100                  ; Product version (0.01)
+       .db     1                       ; Manufacturer string index
+       .db     2                       ; Product string index
+       .db     0                       ; Serial number string index (none)
+       .db     1                       ; Number of configurations
+dev_dscr_end:
+
+; -----------------------------------------------------------------------------
+; Device qualifier (for "other device speed")
+; -----------------------------------------------------------------------------
+_dev_qual_dscr:
+       .db     dev_qualdscr_end - _dev_qual_dscr
+       .db     DSCR_DEVQUAL_TYPE
+       .dw     0x0002                  ; USB 2.0
+       .db     0xff                    ; Class (vendor specific)
+       .db     0xff                    ; Subclass (vendor specific)
+       .db     0xff                    ; Protocol (vendor specific)
+       .db     64                      ; Max. EP0 packet size
+       .db     1                       ; Number of configurations
+       .db     0                       ; Extra reserved byte
+dev_qualdscr_end:
+
+; -----------------------------------------------------------------------------
+; High-Speed configuration descriptor
+; -----------------------------------------------------------------------------
+_highspd_dscr:
+       .db     highspd_dscr_end - _highspd_dscr
+       .db     DSCR_CONFIG_TYPE
+       ; Total length of the configuration (1st line LSB, 2nd line MSB)
+       .db     (highspd_dscr_realend - _highspd_dscr) % 256
+       .db     (highspd_dscr_realend - _highspd_dscr) / 256
+       .db     1                       ; Number of interfaces
+       .db     1                       ; Configuration number
+       .db     0                       ; Configuration string (none)
+       .db     0x80                    ; Attributes (bus powered, no wakeup)
+       .db     0x32                    ; Max. power (100mA)
+highspd_dscr_end:
+
+       ; Interfaces (only one in our case)
+       .db     DSCR_INTERFACE_LEN
+       .db     DSCR_INTERFACE_TYPE
+       .db     0                       ; Interface index
+       .db     0                       ; Alternate setting index
+       .db     2                       ; Number of endpoints
+       .db     0xff                    ; Class (vendor specific)
+       .db     0xff                    ; Subclass (vendor specific)
+       .db     0xff                    ; Protocol (vendor specific)
+       .db     0                       ; String index (none)
+
+       ; Endpoint 1 (OUT)
+       .db     DSCR_ENDPOINT_LEN
+       .db     DSCR_ENDPOINT_TYPE
+       .db     0x01                    ; EP number (1), direction (OUT)
+       .db     ENDPOINT_TYPE_BULK      ; Endpoint type (bulk)
+       .db     0x00                    ; Max. packet size, LSB (512 bytes)
+       .db     0x02                    ; Max. packet size, MSB (512 bytes)
+       .db     0x00                    ; Polling interval
+
+       ; Endpoint 2 (IN)
+       .db     DSCR_ENDPOINT_LEN
+       .db     DSCR_ENDPOINT_TYPE
+       .db     0x82                    ; EP number (2), direction (IN)
+       .db     ENDPOINT_TYPE_BULK      ; Endpoint type (bulk)
+       .db     0x00                    ; Max. packet size, LSB (512 bytes)
+       .db     0x02                    ; Max. packet size, MSB (512 bytes)
+       .db     0x00                    ; Polling interval
+
+highspd_dscr_realend:
+
+       .even
+
+; -----------------------------------------------------------------------------
+; Full-Speed configuration descriptor
+; -----------------------------------------------------------------------------
+_fullspd_dscr:
+       .db     fullspd_dscr_end - _fullspd_dscr
+       .db     DSCR_CONFIG_TYPE
+       ; Total length of the configuration (1st line LSB, 2nd line MSB)
+       .db     (fullspd_dscr_realend - _fullspd_dscr) % 256
+       .db     (fullspd_dscr_realend - _fullspd_dscr) / 256
+       .db     1                       ; Number of interfaces
+       .db     1                       ; Configuration number
+       .db     0                       ; Configuration string (none)
+       .db     0x80                    ; Attributes (bus powered, no wakeup)
+       .db     0x32                    ; Max. power (100mA)
+fullspd_dscr_end:
+
+       ; Interfaces (only one in our case)
+       .db     DSCR_INTERFACE_LEN
+       .db     DSCR_INTERFACE_TYPE
+       .db     0                       ; Interface index
+       .db     0                       ; Alternate setting index
+       .db     2                       ; Number of endpoints
+       .db     0xff                    ; Class (vendor specific)
+       .db     0xff                    ; Subclass (vendor specific)
+       .db     0xff                    ; Protocol (vendor specific)
+       .db     0                       ; String index (none)
+
+       ; Endpoint 1 (OUT)
+       .db     DSCR_ENDPOINT_LEN
+       .db     DSCR_ENDPOINT_TYPE
+       .db     0x01                    ; EP number (1), direction (OUT)
+       .db     ENDPOINT_TYPE_BULK      ; Endpoint type (bulk)
+       .db     0x40                    ; Max. packet size, LSB (64 bytes)
+       .db     0x00                    ; Max. packet size, MSB (64 bytes)
+       .db     0x00                    ; Polling interval
+
+       ; Endpoint 2 (IN)
+       .db     DSCR_ENDPOINT_LEN
+       .db     DSCR_ENDPOINT_TYPE
+       .db     0x82                    ; EP number (2), direction (IN)
+       .db     ENDPOINT_TYPE_BULK      ; Endpoint type (bulk)
+       .db     0x40                    ; Max. packet size, LSB (64 bytes)
+       .db     0x00                    ; Max. packet size, MSB (64 bytes)
+       .db     0x00                    ; Polling interval
+
+fullspd_dscr_realend:
+
+       .even
+
+; -----------------------------------------------------------------------------
+; Strings
+; -----------------------------------------------------------------------------
+
+_dev_strings:
+
+_string0:
+       .db     string0end - _string0
+       .db     DSCR_STRING_TYPE
+       .db     0x09, 0x04              ; Language code 0x0409 (English)
+string0end:
+
+_string1:
+       .db     string1end - _string1
+       .db     DSCR_STRING_TYPE
+       .ascii  's'
+       .db     0
+       .ascii  'i'
+       .db     0
+       .ascii  'g'
+       .db     0
+       .ascii  'r'
+       .db     0
+       .ascii  'o'
+       .db     0
+       .ascii  'k'
+       .db     0
+string1end:
+
+_string2:
+       .db     string2end - _string2
+       .db     DSCR_STRING_TYPE
+       .ascii  'f'
+       .db     0
+       .ascii  'x'
+       .db     0
+       .ascii  '2'
+       .db     0
+       .ascii  'l'
+       .db     0
+       .ascii  'a'
+       .db     0
+       .ascii  'f'
+       .db     0
+       .ascii  'w'
+       .db     0
+string2end:
+
+_dev_strings_end:
+       .dw 0x0000
+
diff --git a/fx2lafw.c b/fx2lafw.c
new file mode 100644 (file)
index 0000000..0488cb7
--- /dev/null
+++ b/fx2lafw.c
@@ -0,0 +1,361 @@
+/*
+ * This file is part of the fx2lafw project.
+ *
+ * Copyright (C) 2011-2012 Uwe Hermann <uwe@hermann-uwe.de>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ */
+
+/*
+ * fx2lafw is an open-source firmware for Cypress FX2 based logic analyzers.
+ *
+ * It is written in C, using fx2lib as helper library, and sdcc as compiler.
+ * The code is licensed under the terms of the GNU GPL, version 2 or later.
+ *
+ * Technical notes:
+ *
+ *  - We use the FX2 in GPIF mode to sample the data (asynchronously).
+ *  - We use the internal 48MHz clock for GPIF.
+ *  - The 8 channels/pins we sample (the GPIF data bus) are PB0-PB7.
+ *    Support for 16 channels is not yet included, but might be added later.
+ *  - Endpoint 2 is used for data transfers from FX2 to host.
+ *  - The endpoint is quad-buffered.
+ *
+ * Documentation:
+ *
+ *  - See http://sigrok.org/wiki/Fx2lafw
+ */
+
+#include <fx2regs.h>
+#include <fx2macros.h>
+#include <delay.h>
+#include <autovector.h>
+#include <setupdat.h>
+#include <eputils.h>
+#include <gpif.h>
+
+#define SYNCDELAY() SYNCDELAY4
+
+/* ... */
+volatile bit got_sud;
+
+/* GPIF terminology: DP = decision point, NDP = non-decision-point */
+
+/* GPIF waveforms */
+static const BYTE wavedata[128] = {
+       /* Waveform 0: */
+
+       /* TODO: This is just a dummy entry, fill with useful data. */
+
+       /* S0-S6: LENGTH/BRANCH */
+       0x01, 0x01, 0x01, 0x01, 0x01, 0x01, 0x01,
+       /* TRM says "reserved", but GPIF designer always puts a 0x07 here. */
+       0x07,
+       /* S0-S6: OPCODE */
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       /* Reserved */
+       0x00,
+       /* S0-S6: OUTPUT */
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       /* Reserved */
+       0x00,
+       /* S0-S6: LOGIC FUNCTION (not used for NDPs) */
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       /* TRM says "reserved", but GPIF designer always puts a 0x3f here. */
+       0x3f,
+
+       /* TODO: Must unused waveforms be "valid"? */
+
+       /* Waveform 1 (unused): */
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+
+       /* Waveform 2 (unused): */
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+
+       /* Waveform 3 (unused): */
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+       0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+};
+
+static void gpif_setup_registers(void)
+{
+       /* TODO. Value probably irrelevant, as we don't use RDY* signals? */
+       GPIFREADYCFG = 0;
+
+       /*
+        * Set TRICTL = 0, thus CTL0-CTL5 are CMOS outputs.
+        * TODO: Probably irrelevant, as we don't use CTL0-CTL5?
+        */
+       GPIFCTLCFG = 0;
+
+       /* When GPIF is idle, tri-state the data bus. */
+       /* Bit 7: DONE, bit 0: IDLEDRV. TODO: Set/clear DONE bit? */
+       GPIFIDLECS = (1 << 0);
+
+       /* When GPIF is idle, set CTL0-CTL5 to 0. */
+       GPIFIDLECTL = 0;
+
+       /*
+        * Map index 0 in wavedata[] to FIFORD. The rest is assigned too,
+        * but not used by us.
+        *
+        * GPIFWFSELECT: [7:6] = SINGLEWR index, [5:4] = SINGLERD index,
+        *               [3:2] = FIFOWR index, [1:0] = FIFORD index
+        */
+       GPIFWFSELECT = (0x3 << 6) | (0x2 << 4) | (0x1 << 2) | (0x0 << 0);
+
+       /* Contains RDY* pin values. Read-only according to TRM. */
+       GPIFREADYSTAT = 0;
+}
+
+static void gpif_write_waveforms(void)
+{
+       int i;
+
+       /*
+        * Write the four waveforms into the respective WAVEDATA register
+        * locations (0xe400 - 0xe47f) using the FX2's autopointer feature.
+        */
+       AUTOPTRSETUP = 0x07;             /* Increment autopointers 1 & 2. */
+       AUTOPTRH1 = MSB((WORD)wavedata); /* Source is the 'wavedata' array. */
+       AUTOPTRL1 = LSB((WORD)wavedata);
+       AUTOPTRH2 = 0xe4;                /* Dest is WAVEDATA (0xe400). */
+       AUTOPTRL2 = 0x00;
+       for (i = 0; i < 128; i++)
+               EXTAUTODAT2 = EXTAUTODAT1;
+}
+
+static void gpif_init_addr_pins(void)
+{
+       /*
+        * Configure the 9 GPIF address pins (GPIFADR[8:0], which consist of
+        * PORTC[7:0] and PORTE[7]), and output an initial address (zero).
+        * TODO: Probably irrelevant, the 56pin FX2 has no ports C and E.
+        */
+       PORTCCFG = 0xff;    /* Set PORTC[7:0] as alt. func. (GPIFADR[7:0]). */
+       OEC = 0xff;         /* Configure PORTC[7:0] as outputs. */
+       PORTECFG |= 0x80;   /* Set PORTE[7] as alt. func. (GPIFADR[8]). */
+       OEE |= 0x80;        /* Configure PORTE[7] as output. */
+       SYNCDELAY();
+       GPIFADRL = 0x00;    /* Clear GPIFADR[7:0]. */
+       SYNCDELAY();
+       GPIFADRH = 0x00;    /* Clear GPIFADR[8]. */
+}
+
+static void gpif_init_flowstates(void)
+{
+       /* Clear all flowstate registers, we don't use this functionality. */
+       FLOWSTATE = 0;
+       FLOWLOGIC = 0;
+       FLOWEQ0CTL = 0;
+       FLOWEQ1CTL = 0;
+       FLOWHOLDOFF = 0;
+       FLOWSTB = 0;
+       FLOWSTBEDGE = 0;
+       FLOWSTBHPERIOD = 0;
+}
+
+static void gpif_init_la(void)
+{
+       /*
+        * Setup the FX2 in GPIF master mode, using the internal clock
+        * (non-inverted) at 48MHz, and using async sampling.
+        */
+       IFCONFIG = 0xee;
+
+       /* Abort currently executing GPIF waveform (if any). */
+       GPIFABORT = 0xff;
+
+       /* Setup the GPIF registers. */
+       gpif_setup_registers();
+
+       /* Write the four GPIF waveforms into the WAVEDATA register. */
+       gpif_write_waveforms();
+
+       /* Initialize GPIF address pins, output initial values. */
+       gpif_init_addr_pins();
+
+       /* Initialize flowstate registers (not used by us). */
+       gpif_init_flowstates();
+}
+
+static void setup_endpoints(void)
+{
+       /* Setup EP1 (OUT). */
+       EP1OUTCFG = (1 << 7) |            /* EP is valid/activated */
+                   (0 << 6) |            /* Reserved */
+                   (1 << 5) | (0 << 4) | /* EP Type: bulk */
+                   (0 << 3) |            /* Reserved */
+                   (0 << 2) |            /* Reserved */
+                   (0 << 1) | (0 << 0);  /* Reserved */
+       SYNCDELAY();
+
+       /* Setup EP2 (IN). */
+       EP2CFG = (1 << 7) |               /* EP is valid/activated */
+                (1 << 6) |               /* EP direction: IN */
+                (1 << 5) | (0 << 4) |    /* EP Type: bulk */
+                (0 << 3) |               /* EP buffer size: 512 */
+                (0 << 2) |               /* Reserved. */
+                (0 << 1) | (0 << 0);     /* EP buffering: quad buffering */
+       SYNCDELAY();
+
+       /* Disable all other EPs (EP4, EP6, and EP8). */
+       EP4CFG &= ~bmVALID;
+       SYNCDELAY();
+       EP6CFG &= ~bmVALID;
+       SYNCDELAY();
+       EP8CFG &= ~bmVALID;
+       SYNCDELAY();
+
+       /* Reset the FIFOs of EP1 and EP2. */
+       /* Note: RESETFIFO() gets the EP number WITHOUT bit 7 set/cleared. */
+       RESETFIFO(0x01)
+       RESETFIFO(0x02)
+
+       /* Set the GPIF flag for EP2 to 'empty'. */
+       EP2GPIFFLGSEL = (0 << 1) | (1 << 1);
+       SYNCDELAY();
+}
+
+BOOL handle_vendorcommand(BYTE cmd)
+{
+       (void)cmd;
+       return FALSE;
+}
+
+BOOL handle_get_interface(BYTE ifc, BYTE *alt_ifc)
+{
+       /* We only support interface 0, alternate interface 0. */
+       if (ifc != 0)
+               return FALSE;
+
+       *alt_ifc = 0;
+       return TRUE;
+}
+
+BOOL handle_set_interface(BYTE ifc, BYTE alt_ifc)
+{
+       /* We only support interface 0, alternate interface 0. */
+       if (ifc != 0 || alt_ifc != 0)
+               return FALSE;
+       
+       /* Perform procedure from TRM, section 2.3.7: */
+
+       /* (1) TODO. */
+
+       /* (2) Reset data toggles of the EPs in the interface. */
+       /* Note: RESETTOGGLE() gets the EP number WITH bit 7 set/cleared. */
+       RESETTOGGLE(0x01);
+       RESETTOGGLE(0x82);
+
+       /* (3) Restore EPs to their default conditions. */
+       /* Note: RESETFIFO() gets the EP number WITHOUT bit 7 set/cleared. */
+       RESETFIFO(0x01);
+       /* TODO */
+       RESETFIFO(0x02);
+       /* TODO */
+
+       /* (4) Clear the HSNAK bit. Not needed, fx2lib does this. */
+
+       return TRUE;
+}
+
+BYTE handle_get_configuration(void)
+{
+       /* We only support configuration 1. */
+       return 1;
+}
+
+BOOL handle_set_configuration(BYTE cfg)
+{
+       /* We only support configuration 1. */
+       return (cfg == 1) ? TRUE : FALSE;
+}
+
+void sudav_isr(void) interrupt SUDAV_ISR
+{
+       got_sud = TRUE;
+       CLEAR_SUDAV();
+}
+
+void sof_isr(void) interrupt SOF_ISR using 1
+{
+       CLEAR_SOF();
+}
+
+void usbreset_isr(void) interrupt USBRESET_ISR
+{
+       handle_hispeed(FALSE);
+       CLEAR_USBRESET();
+}
+
+void hispeed_isr(void) interrupt HISPEED_ISR
+{
+       handle_hispeed(TRUE);
+       CLEAR_HISPEED();
+}
+
+void main(void)
+{
+       /* Set DYN_OUT and ENH_PKT bits, as recommended by the TRM. */
+       REVCTL = (1 << 1) | (1 << 0);
+
+       got_sud = FALSE;
+
+       /* Renumerate. */
+       RENUMERATE_UNCOND();
+
+       SETCPUFREQ(CLK_48M);
+
+       USE_USB_INTS();
+
+       /* TODO: Does the order of the following lines matter? */
+       ENABLE_SUDAV();
+       ENABLE_SOF();
+       ENABLE_HISPEED();
+       ENABLE_USBRESET();
+
+       /* Global (8051) interrupt enable. */
+       EA = 1;
+
+       /* Setup the endpoints. */
+       setup_endpoints();
+
+       /* Put the FX2 into GPIF master mode and setup the GPIF. */
+       gpif_init_la();
+
+       /* TODO */
+       /* Initiate a GPIF read. */
+       (void)EP2GPIFTRIG;
+#if 0
+       /* TODO: This seems to hang? */
+       gpif_fifo_read(GPIF_EP2);
+#endif
+
+       while (1) {
+               if (got_sud) {
+                       handle_setupdata();
+                       got_sud = FALSE;
+               }
+       }
+}