c979a08144
Simplify the API by making all MPSSE command functions return void instead of an error code. If there is an error during an implicit flush in a command call, further commands are ignored until an explicit flush is performed. The flush function returns and clears any error code set. The only command functions that still return an error code are those that can fail directly based on the type of the FTDI chip, i.e. when trying to enable RCLK or divide-by-5 on a non-high-speed chip. Adapt the ftdi adapter driver to the new API. Change-Id: I12979c723c81f7fd022c25821b029112f02b3f95 Signed-off-by: Andreas Fritiofson <andreas.fritiofson@gmail.com> Reviewed-on: http://openocd.zylin.com/1499 Tested-by: jenkins Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
81 lines
3.8 KiB
C
81 lines
3.8 KiB
C
/**************************************************************************
|
|
* 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., *
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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,
|
|
TYPE_FT232H,
|
|
};
|
|
|
|
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(). */
|
|
void mpsse_clock_data_out(struct mpsse_ctx *ctx, const uint8_t *out, unsigned out_offset,
|
|
unsigned length, uint8_t mode);
|
|
void mpsse_clock_data_in(struct mpsse_ctx *ctx, uint8_t *in, unsigned in_offset, unsigned length,
|
|
uint8_t mode);
|
|
void 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);
|
|
void mpsse_clock_tms_cs_out(struct mpsse_ctx *ctx, const uint8_t *out, unsigned out_offset,
|
|
unsigned length, bool tdi, uint8_t mode);
|
|
void 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);
|
|
void mpsse_set_data_bits_low_byte(struct mpsse_ctx *ctx, uint8_t data, uint8_t dir);
|
|
void mpsse_set_data_bits_high_byte(struct mpsse_ctx *ctx, uint8_t data, uint8_t dir);
|
|
void mpsse_read_data_bits_low_byte(struct mpsse_ctx *ctx, uint8_t *data);
|
|
void mpsse_read_data_bits_high_byte(struct mpsse_ctx *ctx, uint8_t *data);
|
|
void mpsse_loopback_config(struct mpsse_ctx *ctx, bool enable);
|
|
void 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_ */
|