src/jtag/drivers/usb_blaster/ublast_access.h

   1 /*
   2  *   Driver for USB-JTAG, Altera USB-Blaster and compatibles
   3  *
   4  *   Inspired from original code from Kolja Waschk's USB-JTAG project
   5  *   (http://www.ixo.de/info/usb_jtag/), and from openocd project.
   6  *
   7  *   Copyright (C) 2013 Franck Jullien franck.jullien@gmail.com
   8  *   Copyright (C) 2012 Robert Jarzmik robert.jarzmik@free.fr
   9  *   Copyright (C) 2011 Ali Lown ali@lown.me.uk
  10  *   Copyright (C) 2009 Catalin Patulea cat@vv.carleton.ca
  11  *   Copyright (C) 2006 Kolja Waschk usbjtag@ixo.de
  12  *
  13  *   This program is free software; you can redistribute it and/or modify
  14  *   it under the terms of the GNU General Public License as published by
  15  *   the Free Software Foundation; either version 2 of the License, or
  16  *   (at your option) any later version.
  17  *
  18  *   This program is distributed in the hope that it will be useful,
  19  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  *   GNU General Public License for more details.
  22  *
  23  *   You should have received a copy of the GNU General Public License
  24  *   along with this program.  If not, see <http://www.gnu.org/licenses/>.
  25  *
  26  */
  27
  28 #ifndef JTAG_UBLAST_ACCESS_H
  29 #define JTAG_UBLAST_ACCESS_H
  30
  31 #include <libusb_common.h>
  32
  33 /* Low level flags */
  34 #define COPY_TDO_BUFFER         (1 << 0)
  35
  36 struct ublast_lowlevel {
  37         uint16_t ublast_vid;
  38         uint16_t ublast_pid;
  39         uint16_t ublast_vid_uninit;
  40         uint16_t ublast_pid_uninit;
  41         char *ublast_device_desc;
  42         struct jtag_libusb_device_handle *libusb_dev;
  43         char *firmware_path;
  44
  45         int (*write)(struct ublast_lowlevel *low, uint8_t *buf, int size,
  46                      uint32_t *bytes_written);
  47         int (*read)(struct ublast_lowlevel *low, uint8_t *buf, unsigned size,
  48                     uint32_t *bytes_read);
  49         int (*open)(struct ublast_lowlevel *low);
  50         int (*close)(struct ublast_lowlevel *low);
  51         int (*speed)(struct ublast_lowlevel *low, int speed);
  52
  53         void *priv;
  54         int flags;
  55 };
  56
  57 /**
  58  * ublast_register_ftdi - get a lowlevel USB Blaster driver
  59  * ublast_register_ftd2xx - get a lowlevel USB Blaster driver
  60  * ublast2_register_libusb - get a lowlevel USB Blaster II driver
  61  *
  62  * Get a lowlevel USB-Blaster driver. In the current implementation, there are 3
  63  * possible lowlevel drivers :
  64  *  - one based on libftdi from ftdichip.com
  65  *  - one based on libftdxx, the free alternative
  66  *  - one based on libusb, specific to the USB-Blaster II
  67  *
  68  * Returns the lowlevel driver structure.
  69  */
  70 extern struct ublast_lowlevel *ublast_register_ftdi(void);
  71 extern struct ublast_lowlevel *ublast_register_ftd2xx(void);
  72 extern struct ublast_lowlevel *ublast2_register_libusb(void);
  73
  74 #endif /* JTAG_UBLAST_ACCESS_H */