Merge TinyOS 2.1.1 into master.

[tinyos-2.x.git] / apps / tosthreads / apps / TestBlockStorage / TestBlockStorageP.nc

diff --git a/apps/tosthreads/apps/TestBlockStorage/TestBlockStorageP.nc b/apps/tosthreads/apps/TestBlockStorage/TestBlockStorageP.nc
index 316cbece9354112837c1a8083fa938e4c2298d30..81b191b0cc4aec65e5b1532e5f03649fe3c027a5 100644 (file)
--- a/apps/tosthreads/apps/TestBlockStorage/TestBlockStorageP.nc
+++ b/apps/tosthreads/apps/TestBlockStorage/TestBlockStorageP.nc
@@ -21,6 +21,18 @@
 */
 
 /**
+ * This application is used to test the threaded version of the API for performing
+ * block storage.
+ * 
+ * This application first checks the size of the block storage volume, and
+ * erases it. Then, it randomly writes records, followed by a verification
+ * with read.
+ * 
+ * Successful running of this application results in LED0 being ON
+ * throughout the duration of the erase, write, and read sequence. Finally,
+ * if all tests pass, LED1 is turned ON. Otherwise, all three LEDs are
+ * turned ON to indicate problems.
+ *
  * @author Chieh-Jan Mike Liang <cliang4@cs.jhu.edu>
  */