contrib/firmware/angie/c/README

   1 #SPDX-License-Identifier: GPL-2.0-or-later
   2
   3 This is the ANGIE firmware for ANGIE USB-JTAG adapter.
   4
   5 The main components of ANGIE adapter are:
   6 - Cypress EZ-USB FX2 microcontroller
   7 - Spartan-6 FPGA
   8 - SRAM memory chip
   9 - Pin headers for various JTAG pin assignments
  10
  11 To compile the firmware, the SDCC compiler package is required. Most Linux
  12 distributions include SDCC in their official package repositories. The SDCC
  13 source code can be found at http://sdcc.sourceforge.net/
  14
  15 Simply type "make hex" in the ANGIE directory to compile the firmware.
  16 "make clean" will remove all generated files except the Intel HEX file
  17 required for downloading the firmware to ANGIE.
  18
  19 Note that the EZ-USB FX2 microcontroller does not have on-chip flash,
  20 ANGIE include on-board EEPROM memory to store the firmware program of
  21 the FX2, but we are not going to use this method.
  22
  23 Instead, upon initial connection of the ANGIE adapter to the host PC
  24 via USB, the EZ-USB FX2 core has enough intelligence to act as a
  25 stand-alone USB device, responding to USB control requests and allowing
  26 firmware download via a special VENDOR-type control request. Then, the
  27 EZ-USB microcontroller simulates a disconnect and re-connect to the USB bus.
  28 It may take up to two seconds for the host to recognize the newly connected
  29 device before OpenOCD can proceed to execute JTAG commands. This delay is
  30 only visible when OpenOCD first uses a blank (unconfigured) ANGIE device.
  31
  32 Once the firmware downloaded, the FX2 microcontroller activate its GPIF mode,
  33 download the Spartan-6 FPGA's bitstream, program the FPGA rapidly, and switch
  34 back to default io mode.
  35
  36 Once the user disconnects the ANGIE adapter, all its memory contents are lost
  37 and the firmware & bitstream download process has to be executed again.