pipes: add documentation for pipes

[fw/openocd] / src / target / target_type.h

diff --git a/src/target/target_type.h b/src/target/target_type.h
index d3db8b55decc7aa8ce82eb031d78a0e90527b0bc..10fcd4fd28592f2f430900bf34256c1562984cb5 100644 (file)
--- a/src/target/target_type.h
+++ b/src/target/target_type.h
@@ -2,7 +2,7 @@
  *   Copyright (C) 2005 by Dominic Rath                                    *
  *   Dominic.Rath@gmx.de                                                   *
  *                                                                         *
- *   Copyright (C) 2007,2008,2009 Øyvind Harboe                            *
+ *   Copyright (C) 2007-2010 Øyvind Harboe                                 *
  *   oyvind.harboe@zylin.com                                               *
  *                                                                         *
  *   Copyright (C) 2008 by Spencer Oliver                                  *
@@ -73,6 +73,17 @@ struct target_type
         *
         */
        int (*assert_reset)(struct target *target);
+       /**
+        * The implementation is responsible for polling the
+        * target such that target->state reflects the
+        * state correctly.
+        *
+        * Otherwise the following would fail, as there will not
+        * be any "poll" invoked inbetween the "reset run" and
+        * "halt".
+        *
+        * reset run; halt
+     */
        int (*deassert_reset)(struct target *target);
        int (*soft_reset_halt_imp)(struct target *target);
        int (*soft_reset_halt)(struct target *target);