bitbang: document bitbang callbacks

[openocd.git] / src / jtag / drivers / bitbang.h

diff --git a/src/jtag/drivers/bitbang.h b/src/jtag/drivers/bitbang.h
index bbbc693df5634fcffca85a33950b619937a4f17c..7516c24a612a471d08a2501c2ae9aeadba740833 100644 (file)
--- a/src/jtag/drivers/bitbang.h
+++ b/src/jtag/drivers/bitbang.h
@@ -38,21 +38,29 @@ typedef enum {
  * sample requests together. Not waiting for a value to come back can greatly
  * increase throughput. */
 struct bitbang_interface {
-       /** Sample TDO. */
+       /** Sample TDO and return the value. */
        bb_value_t (*read)(void);
 
        /** 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. */
        int (*sample)(void);
+
        /** Return the next unread value from the buffer. */
        bb_value_t (*read_sample)(void);
 
        /** Set TCK, TMS, and TDI to the given values. */
        int (*write)(int tck, int tms, int tdi);
+
+       /** Blink led (optional). */
        int (*blink)(int on);
+
+       /** Sample SWDIO and return the value. */
        int (*swdio_read)(void);
+
+       /** Set direction of SWDIO. */
        void (*swdio_drive)(bool on);
 };