Add MPSSE communications layer for FTDI chips

This is a higher-level libftdi replacement for use when implementing
protocol drivers for FT2232, FT2232H or FT4232H. It takes care of device
open/close and, unlike libftdi, also MPSSE command abstraction, command
queueing, buffer handling and return data parsing.

The FTDI device is accessed through libusb-1.0 in asynchronous mode.

Change-Id: I051adb574dcc39f8ca9cd7f6dbe6ae4aeea5f4c8
Signed-off-by: Andreas Fritiofson <andreas.fritiofson@gmail.com>
Reviewed-on: http://openocd.zylin.com/451
Tested-by: jenkins
Reviewed-by: Freddie Chopin <freddie.chopin@gmail.com>
Reviewed-by: Peter Stuge <peter@stuge.se>

1 files changed, 79 insertions, 0 deletions

diff --git a/src/jtag/drivers/mpsse.h b/src/jtag/drivers/mpsse.h
new file mode 100644
index 00000000..766a2158
--- /dev/null
+++ b/src/jtag/drivers/mpsse.h
@@ -0,0 +1,79 @@
+/**************************************************************************
+ *   Copyright (C) 2012 by Andreas Fritiofson                              *
+ *   andreas.fritiofson@gmail.com                                          *
+ *                                                                         *
+ *   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.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+
+#ifndef MPSSE_H_
+#define MPSSE_H_
+
+#include <stdbool.h>
+#include "helper/binarybuffer.h"
+
+/* Mode flags */
+#define POS_EDGE_OUT 0x00
+#define NEG_EDGE_OUT 0x01
+#define POS_EDGE_IN 0x00
+#define NEG_EDGE_IN 0x04
+#define MSB_FIRST 0x00
+#define LSB_FIRST 0x08
+
+enum ftdi_chip_type {
+	TYPE_FT2232C,
+	TYPE_FT2232H,
+	TYPE_FT4232H,
+};
+
+struct mpsse_ctx;
+
+/* Device handling */
+struct mpsse_ctx *mpsse_open(const uint16_t *vid, const uint16_t *pid, const char *description,
+	const char *serial, int channel);
+void mpsse_close(struct mpsse_ctx *ctx);
+bool mpsse_is_high_speed(struct mpsse_ctx *ctx);
+
+/* Command queuing. These correspond to the MPSSE commands with the same names, but no need to care
+ * about bit/byte transfer or data length limitation. Read data is guaranteed to be available only
+ * after the following mpsse_flush(). */
+int mpsse_clock_data_out(struct mpsse_ctx *ctx, const uint8_t *out, unsigned out_offset,
+			 unsigned length, uint8_t mode);
+int mpsse_clock_data_in(struct mpsse_ctx *ctx, uint8_t *in, unsigned in_offset, unsigned length,
+			uint8_t mode);
+int mpsse_clock_data(struct mpsse_ctx *ctx, const uint8_t *out, unsigned out_offset, uint8_t *in,
+		     unsigned in_offset, unsigned length, uint8_t mode);
+int mpsse_clock_tms_cs_out(struct mpsse_ctx *ctx, const uint8_t *out, unsigned out_offset,
+			   unsigned length, bool tdi, uint8_t mode);
+int mpsse_clock_tms_cs(struct mpsse_ctx *ctx, const uint8_t *out, unsigned out_offset, uint8_t *in,
+		       unsigned in_offset, unsigned length, bool tdi, uint8_t mode);
+int mpsse_set_data_bits_low_byte(struct mpsse_ctx *ctx, uint8_t data, uint8_t dir);
+int mpsse_set_data_bits_high_byte(struct mpsse_ctx *ctx, uint8_t data, uint8_t dir);
+int mpsse_read_data_bits_low_byte(struct mpsse_ctx *ctx, uint8_t *data);
+int mpsse_read_data_bits_high_byte(struct mpsse_ctx *ctx, uint8_t *data);
+int mpsse_loopback_config(struct mpsse_ctx *ctx, bool enable);
+int mpsse_set_divisor(struct mpsse_ctx *ctx, uint16_t divisor);
+int mpsse_divide_by_5_config(struct mpsse_ctx *ctx, bool enable);
+int mpsse_rtck_config(struct mpsse_ctx *ctx, bool enable);
+
+/* Helper to set frequency in Hertz. Returns actual realizable frequency or negative error.
+ * Frequency 0 means RTCK. */
+int mpsse_set_frequency(struct mpsse_ctx *ctx, int frequency);
+
+/* Queue handling */
+int mpsse_flush(struct mpsse_ctx *ctx);
+void mpsse_purge(struct mpsse_ctx *ctx);
+
+#endif /* MPSSE_H_ */