]> oss.titaniummirror.com Git - tinyos-2.x.git/blobdiff - doc/txt/tep4.txt
Merge TinyOS 2.1.1 into master.
[tinyos-2.x.git] / doc / txt / tep4.txt
index 2d3c676ba0cdc403e3418035734ca93b234b8fc3..39009d286ac2e59781a75de81351e0b557bae1f9 100644 (file)
@@ -5,8 +5,8 @@ Active Message ID Allocation for Network Protocols and Applications
 :TEP: 4
 :Group: Network Protocol Working Group 
 :Type: Best Current Practice
-:Status: Draft
-:TinyOS-Version: 2.x
+:Status: Final
+:TinyOS-Version: > 2.1
 :Author: Omprakash Gnawali
 
 :Draft-Created: 07-May-2008
@@ -25,16 +25,17 @@ Active Message ID Allocation for Network Protocols and Applications
 1. Introduction
 ====================================================================
 
-In order to document the Active Message Type [1]_, also known as
+In order to document the Active Message Type [TEP_116]_, also known as
 Active Message Identifier (AM ID), used by the protocols and to
 prevent AM ID conflicts between applications and protocols distributed
 with TinyOS 2.x, the application and protocol developers MUST use AM
 IDs in the appropriate range. The network protocol implementors MUST
 use AM ID allocated by the Network Protocol Working Group for the
 specific protocol. The application developers MUST use AM IDs from the
-unreserved pool.
+unreserved pool. This TEP describes the process of AM ID allocations
+and deallocations and how the allocations are documented.
 
-2. Current Allocations
+2. AM ID pools
 ====================================================================
 
 The unreserved pool is in the range 128-255 (0x80-0xFF). The reserved
@@ -57,31 +58,6 @@ guaranteed to not conflict with AM IDs used by applications or other
 protocols that also use an allocated AM ID. The AM ID may conflict
 with the protocols and applications in the contrib tree.
 
-Here is a list of current allocations::
-
-  * 0x70 - 0x7F are reserved for collection protocols maintained by
-    the Network Protocol Working Group.
-
-    0x70 - CTP routing beacon and LEEP (''tos/lib/net/ctp'', TEP 119, 123, and 124)
-    0x71 - CTP data packets (''tos/lib/net/ctp'', TEP 119, 123)
-    0x72 - CTP debug messages (''tos/lib/net/ctp'')
-    0x73 - MultiHopLQI routing beacon (''tos/lib/net/lqi'')
-    0x74 - MultiHopLQI data packets (''tos/lib/net/lqi'')
-    0x75 - MultiHopLQI debug messages (''tos/lib/net/lqi'')
-
-  * 0x60 - 0x6F are reserved for dissemination protocols maintained by
-    the Network Protocol Working Group.
-
-    0x60 - Drip (''tos/lib/net/drip'', TEP 118)
-    0x61 - DIP (''tos/lib/net/dip'', TEP 118)
-
-  * 0x50 - DYMO (''tos/lib/net/dymo'') maintained by the Network
-    Protocol Working Group.
-
-  * 0x3F - TinyOS NALP code (TEP 125) reserved by the Core Working
-    Group.
-
-
 3. Requesting AM ID Allocation
 ====================================================================
 
@@ -95,12 +71,16 @@ protocols maintained by any working group.
 
 To receive an AM ID allocation, please send an email to the chair of
 Network Protocol Working Group with the following information:
-  * Working Group responsible for the protocol
-  * Name of the protocol and relevant TEPs
-  * Location of the protocol in TinyOS source tree
+* Working Group responsible for the protocol
+* Name of the protocol and relevant TEPs
+* Location of the protocol in TinyOS source tree
+* Number of AM IDs requested and description of each ID
+* Specific AM ID request (only if necessary)
 
-Upon receiving this information, the chair of the Network Protocol
-Working Group will allocate an AM ID and update this TEP.
+Upon receiving this request, the chair of the Network Protocol Working
+Group will allocate the AM ID(s) and document the allocation. If the
+request is made for a specific AM ID, the chair of the Network
+Protocol Work Group will try to accommodate that request.
 
 4. Reclaiming the AM ID Allocation
 ====================================================================
@@ -109,16 +89,24 @@ When the working group responsible for maintaining the protocol with
 an allocated AM ID obsoletes the protocol, the chair of the working
 group should send a deallocation request to the chair of the Network
 Protocol Working Group. The chair of the Network Protocol Working
-Group will update this TEP by deleting the entry for the obsolete
-protocol.
+Group will document the deallocation.
+
+5. Documenting allocations and deallocations
+====================================================================
+
+For each TinyOS 2.x release that introduces a new protocol or use of a
+new AM ID, the chair of the Network Protocol Working Group creates a
+new Informational TEP that lists all the AM ID allocations for that
+release. The TEP is finalized at the time of the release. [TEP_135]_
+documents the AM IDs allocated for TinyOS 2.1.
 
-5. Acknowledgments
+6. Acknowledgments
 ====================================================================
 
 Thanks to the TinyOS community at large for helping to formulate this
 ID allocation policy.
 
-6. Author's Address
+7. Author's Address
 ====================================================================
 
 | Omprakash Gnawali
@@ -129,9 +117,11 @@ ID allocation policy.
 | phone - +1 213 821-5627
 | email - gnawali@usc.edu
 
-7. Citations
+8. Citations
 ====================================================================
 
 .. [TEP_1] TEP 1: TEP Structure and Keywords 
 
-.. [1] TEP 116: Packet Protocols
+.. [TEP_116] TEP 116: Packet Protocols
+
+.. [TEP_135] TEP 135: Active Message ID Allocation in TinyOS 2.1