From ba6c65f2bca799a776468c746ac7bc614a03ced4 Mon Sep 17 00:00:00 2001 From: Tim Newsome Date: Mon, 22 Jan 2018 12:11:36 -0800 Subject: [PATCH] Format comments to be doxygen style. Change-Id: I7a757b92926b9cd65846551893f78ffb5e462370 --- src/jtag/drivers/bitbang.h | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/src/jtag/drivers/bitbang.h b/src/jtag/drivers/bitbang.h index f0b9263c1..8efdd2d82 100644 --- a/src/jtag/drivers/bitbang.h +++ b/src/jtag/drivers/bitbang.h @@ -24,27 +24,26 @@ #include +/** 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 { - /* low level callbacks (for bitbang) - */ - - /* Either read() or sample()/read_sample() must be implemented. */ - - /* Sample TDO and return 0 or 1. */ + /** Sample TDO and return 0 or 1. */ int (*read)(void); - /* 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. */ - /* The number of TDO samples that can be buffered up before the caller has + /** The number of TDO samples that can be buffered up before the caller has * to call read_sample. */ 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); - /* Return the next unread value from the buffer. */ + /** Return the next unread value from the buffer. */ 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 (*reset)(int trst, int srst); void (*blink)(int on);