- re-designed the radio driver interfaces, restructured/improved the CC2420 radio...

[tinyos-2.x.git] / tos / lib / mac / tkn154 / README.txt

diff --git a/tos/lib/mac/tkn154/README.txt b/tos/lib/mac/tkn154/README.txt
index c94d0190bfcc5139cf59f98c17b22df01a1ec716..01e3989edc674adbe2578933d991a33696e776aa 100644 (file)
--- a/tos/lib/mac/tkn154/README.txt
+++ b/tos/lib/mac/tkn154/README.txt
@@ -1,25 +1,29 @@
 This directory contains "TKN15.4", a platform-independent IEEE 802.15.4-2006
-MAC implementation. The code is in alpha state, under active development, but
-most of the functionality described in the standard is implemented (and
-cursorily tested). The MAC itself is platform-independent, but it requires
-(1) a suitable radio driver, (2) Alarms/Timers with symbol precision and (3)
-some "platform glue" code (defining guard times, etc.). Currently the only
-supported platform is TelosB (however: without additional hardware support on
-TelosB the timing in beacon-enabled mode is not standard compliant).
+MAC implementation. The code is under active development, but most of the 
+functionality described in the standard is implemented (and cursorily tested). 
+The MAC itself is platform-independent, but it requires (1) a suitable radio 
+driver, (2) Alarms/Timers with symbol precision and (3) some "platform glue" 
+code (defining guard times, etc.). Currently the only supported platform is 
+TelosB (but without additional hardware support on TelosB the timing in 
+beacon-enabled mode is not standard compliant).
 
-Status 6/16/08
---------------
+This code is the basis for the implementation of the TinyOS 15.4 WG:
+http://tinyos.stanford.edu:8000/15.4_WG
+
+Status 3/4/09
+-------------
 
-missing functionality:
-- security (not planned)
-- GTS (not planned)
+Missing functionality:
+- security 
+- GTS 
 - PAN ID conflict resolution
 - multiple indirect transmissions to the same destination
 
-missing documentation:
-- overview on the architecture of TKN15.4
-- porting TKN15.4 to a new platform
-- ...
+Documentation
+-------------
+
+A technical report on TKN15.4 is under way and will be available at:
+http://www.tkn.tu-berlin.de/publications/reports.jsp
 
 Implementation 
 --------------
@@ -30,6 +34,11 @@ CC2420 driver: tinyos-2.x/tos/chips/cc2420_tkn154
 TelosB "platform glue" code: tinyos-2.x/tos/platforms/telosb/mac/tkn154
 Example applications: tinyos-2.x/apps/tests/tkn154
 
+Note: TEP3 recommends that interface names "should be mixed case, starting
+upper case". To match the syntax used in the IEEE 802.15.4 standard the
+interfaces provided by the MAC to the next higher layer deviate from this
+convention (they are all caps, e.g. MLME_START).
+
 Copyright
 ---------