Add MPSSE communications layer for FTDI chips
[openocd.git] / 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, write to the *
17 * Free Software Foundation, Inc., *
18 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
19 ***************************************************************************/
20
21 #ifndef MPSSE_H_
22 #define MPSSE_H_
23
24 #include <stdbool.h>
25 #include "helper/binarybuffer.h"
26
27 /* Mode flags */
28 #define POS_EDGE_OUT 0x00
29 #define NEG_EDGE_OUT 0x01
30 #define POS_EDGE_IN 0x00
31 #define NEG_EDGE_IN 0x04
32 #define MSB_FIRST 0x00
33 #define LSB_FIRST 0x08
34
35 enum ftdi_chip_type {
36 TYPE_FT2232C,
37 TYPE_FT2232H,
38 TYPE_FT4232H,
39 };
40
41 struct mpsse_ctx;
42
43 /* Device handling */
44 struct mpsse_ctx *mpsse_open(const uint16_t *vid, const uint16_t *pid, const char *description,
45 const char *serial, int channel);
46 void mpsse_close(struct mpsse_ctx *ctx);
47 bool mpsse_is_high_speed(struct mpsse_ctx *ctx);
48
49 /* Command queuing. These correspond to the MPSSE commands with the same names, but no need to care
50 * about bit/byte transfer or data length limitation. Read data is guaranteed to be available only
51 * after the following mpsse_flush(). */
52 int mpsse_clock_data_out(struct mpsse_ctx *ctx, const uint8_t *out, unsigned out_offset,
53 unsigned length, uint8_t mode);
54 int mpsse_clock_data_in(struct mpsse_ctx *ctx, uint8_t *in, unsigned in_offset, unsigned length,
55 uint8_t mode);
56 int mpsse_clock_data(struct mpsse_ctx *ctx, const uint8_t *out, unsigned out_offset, uint8_t *in,
57 unsigned in_offset, unsigned length, uint8_t mode);
58 int mpsse_clock_tms_cs_out(struct mpsse_ctx *ctx, const uint8_t *out, unsigned out_offset,
59 unsigned length, bool tdi, uint8_t mode);
60 int mpsse_clock_tms_cs(struct mpsse_ctx *ctx, const uint8_t *out, unsigned out_offset, uint8_t *in,
61 unsigned in_offset, unsigned length, bool tdi, uint8_t mode);
62 int mpsse_set_data_bits_low_byte(struct mpsse_ctx *ctx, uint8_t data, uint8_t dir);
63 int mpsse_set_data_bits_high_byte(struct mpsse_ctx *ctx, uint8_t data, uint8_t dir);
64 int mpsse_read_data_bits_low_byte(struct mpsse_ctx *ctx, uint8_t *data);
65 int mpsse_read_data_bits_high_byte(struct mpsse_ctx *ctx, uint8_t *data);
66 int mpsse_loopback_config(struct mpsse_ctx *ctx, bool enable);
67 int mpsse_set_divisor(struct mpsse_ctx *ctx, uint16_t divisor);
68 int mpsse_divide_by_5_config(struct mpsse_ctx *ctx, bool enable);
69 int mpsse_rtck_config(struct mpsse_ctx *ctx, bool enable);
70
71 /* Helper to set frequency in Hertz. Returns actual realizable frequency or negative error.
72 * Frequency 0 means RTCK. */
73 int mpsse_set_frequency(struct mpsse_ctx *ctx, int frequency);
74
75 /* Queue handling */
76 int mpsse_flush(struct mpsse_ctx *ctx);
77 void mpsse_purge(struct mpsse_ctx *ctx);
78
79 #endif /* MPSSE_H_ */