From 634077786ed9fd23c4a4dbe854792898411564f3 Mon Sep 17 00:00:00 2001
From: regehr <regehr>
Date: Sat, 11 Apr 2009 20:51:04 +0000
Subject: [PATCH] update docs, todos

---
 tools/tinyos/safe/tos-ramsize   | 48 +++++++++++++++++++++------------
 tools/tinyos/safe/tos-ramsize.1 |  7 ++++-
 2 files changed, 37 insertions(+), 18 deletions(-)

diff --git a/tools/tinyos/safe/tos-ramsize b/tools/tinyos/safe/tos-ramsize
index b9576827..06344845 100755
--- a/tools/tinyos/safe/tos-ramsize
+++ b/tools/tinyos/safe/tos-ramsize
@@ -26,23 +26,37 @@ use warnings;
 use Getopt::Long;
 
 # TODO: 
-#   tighten results by keeping track of atomic sections
-#   support overriding the default heuristic for detecting atomic vectors
-#   get rid of hard-coded non-terminating functions, just derive this
-#     when no "ret" is executed
-#   test for tightness / soundness using randprog
-#   read config info from a file
-#     chip parameters
-#     libc information
-#     recursion and interrupt info
-#   support TOSThreads
-#   support msp430
-#   enumerate soundness requirements
-#     stores to SP are direct and use "out"
-#     no indirect stores to registers
-#     no reentrant interrupts
-#     outs to 0x3f are ending atomic blocks, seis are enabling interrupts for real
-#     return instructions go back to their callers' successors
+#
+# flesh out the man page
+#
+# make a page on the TinyOS wiki
+#
+# tighten results by keeping track of depths inside and out of
+# atomic sections
+#
+# support overriding the default heuristic for detecting atomic
+# interrupts
+#
+# get rid of hard-coded non-terminating functions, just derive this
+# when no "ret" is executed
+#
+# test for tightness / soundness using randprog and Avrora
+#
+# read config info from a file
+#   chip parameters
+#   libc information
+#   recursion and interrupt info
+#
+# support TOSThreads
+#
+# support msp430
+#
+# enumerate soundness requirements
+#   stores to SP are direct and use "out"
+#   no reentrant interrupts
+#   outs to SREG are for ending atomic blocks, seis are enabling interrupts for real
+#   return instructions go back to their callers' successors
+#   special-cases are correct
 
 ##########################################################################
 
diff --git a/tools/tinyos/safe/tos-ramsize.1 b/tools/tinyos/safe/tos-ramsize.1
index 1dde39c6..20ddd7b5 100755
--- a/tools/tinyos/safe/tos-ramsize.1
+++ b/tools/tinyos/safe/tos-ramsize.1
@@ -8,4 +8,9 @@ tos-ramsize - Compute RAM usage of a TinyOS application including the stack
 \fBtos-ramsize\fR [-verbosity=n] mica2|micaz|iris elf-file
 .SH DESCRIPTION
 
-Write me.
+This tool disassembles an elf file for AVR-based TinyOS platforms and
+estimates the maximum extent of its call stack.  This number is
+reported, along with the total static and dynamic RAM usage.
+
+The primary documentation for this tool can be found on the TinyOS
+Documentation Wiki.
-- 
2.39.2