interesting
/
riscv-openocd
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Format comments to be doxygen style. 

Change-Id: I7a757b92926b9cd65846551893f78ffb5e462370
This commit is contained in:
Tim Newsome 2018-01-22 12:11:36 -08:00
parent 2fc53c1faa
commit ba6c65f2bc
1 changed files with 12 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
src/jtag/drivers/bitbang.h
View File

@ -24,27 +24,26 @@
#include <jtag/swd.h> #include <jtag/swd.h>
/** Low level callbacks (for bitbang).
*
* Either read(), or sample() and read_sample() must be implemented.
*
* The sample functions allow an interface to batch a number of writes and
* sample requests together. Not waiting for a value to come back can greatly
* increase throughput. */
struct bitbang_interface { struct bitbang_interface {
/* low level callbacks (for bitbang) /** Sample TDO and return 0 or 1. */
*/
/* Either read() or sample()/read_sample() must be implemented. */
/* Sample TDO and return 0 or 1. */
int (*read)(void); int (*read)(void);
/* The sample functions allow an interface to batch a number of writes and /** The number of TDO samples that can be buffered up before the caller has
* sample requests together. Not waiting for a value to come back can
* greatly increase throughput. */
/* The number of TDO samples that can be buffered up before the caller has
* to call read_sample. */ * to call read_sample. */
size_t buf_size; size_t buf_size;
/* Sample TDO and put the result in a buffer. */ /** Sample TDO and put the result in a buffer. */
void (*sample)(void); void (*sample)(void);
/* Return the next unread value from the buffer. */ /** Return the next unread value from the buffer. */
int (*read_sample)(void); int (*read_sample)(void);
/* Set TCK, TMS, and TDI to the given values. */ /** Set TCK, TMS, and TDI to the given values. */
void (*write)(int tck, int tms, int tdi); void (*write)(int tck, int tms, int tdi);
void (*reset)(int trst, int srst); void (*reset)(int trst, int srst);
void (*blink)(int on); void (*blink)(int on);