src/jtag/drivers/mpsse.h

   1 /**************************************************************************
   2  *   Copyright (C) 2012 by Andreas Fritiofson                              *
   3  *   andreas.fritiofson@gmail.com                                          *
   4  *                                                                         *
   5  *   This program is free software; you can redistribute it and/or modify  *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation; either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   This program is distributed in the hope that it will be useful,       *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
  17  ***************************************************************************/
  18
  19 #ifndef OPENOCD_JTAG_DRIVERS_MPSSE_H
  20 #define OPENOCD_JTAG_DRIVERS_MPSSE_H
  21
  22 #include <stdbool.h>
  23 #include "helper/binarybuffer.h"
  24
  25 /* Mode flags */
  26 #define POS_EDGE_OUT 0x00
  27 #define NEG_EDGE_OUT 0x01
  28 #define POS_EDGE_IN 0x00
  29 #define NEG_EDGE_IN 0x04
  30 #define MSB_FIRST 0x00
  31 #define LSB_FIRST 0x08
  32
  33 enum ftdi_chip_type {
  34         TYPE_FT2232C,
  35         TYPE_FT2232H,
  36         TYPE_FT4232H,
  37         TYPE_FT232H,
  38 };
  39
  40 struct mpsse_ctx;
  41
  42 /* Device handling */
  43 struct mpsse_ctx *mpsse_open(const uint16_t *vid, const uint16_t *pid, const char *description,
  44         const char *serial, const char *location, int channel);
  45 void mpsse_close(struct mpsse_ctx *ctx);
  46 bool mpsse_is_high_speed(struct mpsse_ctx *ctx);
  47
  48 /* Command queuing. These correspond to the MPSSE commands with the same names, but no need to care
  49  * about bit/byte transfer or data length limitation. Read data is guaranteed to be available only
  50  * after the following mpsse_flush(). */
  51 void mpsse_clock_data_out(struct mpsse_ctx *ctx, const uint8_t *out, unsigned out_offset,
  52                          unsigned length, uint8_t mode);
  53 void mpsse_clock_data_in(struct mpsse_ctx *ctx, uint8_t *in, unsigned in_offset, unsigned length,
  54                         uint8_t mode);
  55 void mpsse_clock_data(struct mpsse_ctx *ctx, const uint8_t *out, unsigned out_offset, uint8_t *in,
  56                      unsigned in_offset, unsigned length, uint8_t mode);
  57 void mpsse_clock_tms_cs_out(struct mpsse_ctx *ctx, const uint8_t *out, unsigned out_offset,
  58                            unsigned length, bool tdi, uint8_t mode);
  59 void mpsse_clock_tms_cs(struct mpsse_ctx *ctx, const uint8_t *out, unsigned out_offset, uint8_t *in,
  60                        unsigned in_offset, unsigned length, bool tdi, uint8_t mode);
  61 void mpsse_set_data_bits_low_byte(struct mpsse_ctx *ctx, uint8_t data, uint8_t dir);
  62 void mpsse_set_data_bits_high_byte(struct mpsse_ctx *ctx, uint8_t data, uint8_t dir);
  63 void mpsse_read_data_bits_low_byte(struct mpsse_ctx *ctx, uint8_t *data);
  64 void mpsse_read_data_bits_high_byte(struct mpsse_ctx *ctx, uint8_t *data);
  65 void mpsse_loopback_config(struct mpsse_ctx *ctx, bool enable);
  66 void mpsse_set_divisor(struct mpsse_ctx *ctx, uint16_t divisor);
  67 int mpsse_divide_by_5_config(struct mpsse_ctx *ctx, bool enable);
  68 int mpsse_rtck_config(struct mpsse_ctx *ctx, bool enable);
  69
  70 /* Helper to set frequency in Hertz. Returns actual realizable frequency or negative error.
  71  * Frequency 0 means RTCK. */
  72 int mpsse_set_frequency(struct mpsse_ctx *ctx, int frequency);
  73
  74 /* Queue handling */
  75 int mpsse_flush(struct mpsse_ctx *ctx);
  76 void mpsse_purge(struct mpsse_ctx *ctx);
  77
  78 #endif /* OPENOCD_JTAG_DRIVERS_MPSSE_H */