Changes between Version 14 and Version 15 of CSMAMAC

Timestamp:

Feb 7, 2008, 11:01:09 PM (16 years ago)

Author:

chunter

Comment:

--

CSMAMAC

@@ -108 +108 @@
 {{{
 #!c
-warpmac_setRxBuffer(&rxBuffer,0);
+warpmac_setRxBuffer(-,0);
 warpmac_setTxBuffer(1);
 }}}
 
-The newest version of the [wiki:OFDM PHY]
-
+The newest version of the [wiki:OFDM OFDM PHY] supports a large chunk of memory that can be used to queue multiple packets. By default, the system is configured with enough memory to support 4 full-size packets. This block of code instructs the framework to use the first 1/4th of memory to receive packets into, and the second 1/4th of memory to send from. In principle, these functions can be used to help juggle packets in the event of a busy wireless medium. For example, one can receive into a separate piece of memory in order to avoid overwriting a packet that has not been processed by higher layers yet.
+
+
+{{{
+#!c
+warpmac_setGoodPacketHandler(receiveGoodPacket);
+warpmac_setBadPacketHandler(receiveBadPacket);
+warpmac_setTimerHandler(timerExpire);
+warpmac_setEmacHandler(ethernet_callback);
+}}}
+
+This block of code attaches user-level callbacks to interrupt service routines. These functions perform the behaviors that they sound like: receiving a packet that passes checksum, receiving a packet that fails checksum, processing a timer expiration, and handling Ethernet activity respectively.
+
+{{{
+#!c
+warpmac_setChannel(-, -);
+}}}
+
+This function sets the center frequency of the radio in either the 2.4 or 5 GHz spectrum.
+
+{{{
+#!c
+warpmac_enableCSMA();
+warpmac_enableEthernetInterrupt();
+}}}
+
+These function enable the carrier-sensing functionality of the hardware and the Ethernet interrupt.
+
+= Carrier-Sense Medium Access Reference Design (CSMAMAC) =
+
+The CSMAMAC is serves as the user-level MAC layer in [wiki:OFDMReferenceDesign reference design]. The basic algorithm is simple:
+
+ * Do I have a packet to send?
+       * If the medium is idle, send it, enter a timeout, and wait for an acknowledgment from the destination
+       * If the medium is busy, enter a backoff period and wait for the medium to become idle
+ * Did I receive a data packet?
+       * If the packet pass checksum and is addressed to me, send an acknowledgment
+ * Did no know acknowledgment happen during a timeout period?
+       * If the maximum number of retransmits has not occurred, enter a backoff and try retransmitting
+       * If the maximum number of retransmits has occurred, drop the packet
+ * Did I wait through a backoff period?
+       * If the medium is busy, retransmit, increment the total number of resends, enter a timeout, and wait for an acknowledgment from the destination
+       * If the medium is busy, enter a backoff period and wait for the medium to become idle
+
+This simple algorithm encompasses much of the behavior in commercial 802.11 MAC/PHY chipsets. This algorithm lends itself nicely to a state diagram, which in turn, translates into C-code that can be executed in the PowerPC of the FPGA on WARP. In the following section, we track the "Life of a Packet" as it might journey through these states.
+
+
+
+
+== Life of a Packet ==
+
+Below is the state-machine representation of the above algorithm. Each state can be "clicked" and is described in detail in the accompanying link. The up-to-date code can be found here: [source:/ResearchApps/MAC/CSMAMAC/csmaMac.c@L csmaMac.c]. The API documentation for the code can be found here: [http://warp.rice.edu/WARP_API/csma_mac_8c.html CSMAMAC API]
+
+{{{
+#!html
+<map name="GraffleExport">
+        <area shape=poly coords="106,224,154,250,106,276,59,250,106,224" href="#MediumState">
+        <area shape=poly coords="681,414,728,440,681,466,633,440,681,414" href="#MaximumResends">
+        <area shape=poly coords="681,318,728,344,681,370,634,344,681,318" href="#MediumState">
+        <area shape=rect coords="690,508,784,545" href="#DropPacket">
+        <area shape=rect coords="577,592,671,630" href="#IncrementResendCounter">
+        <area shape=rect coords="577,508,671,546" href="#TransmitPacketviaPHY">
+        <area shape=rect coords="319,508,414,545" href="#TransmitPacketviaPHY">
+        <area shape=rect coords="3,326,97,364" href="#TransmitPacketviaPHY">
+        <area shape=rect coords="691,130,785,168" href="#TimerExpired">
+        <area shape=rect coords="375,131,470,168" href="#ReceivedPacketviaPHY">
+        <area shape=rect coords="60,130,155,168" href="#AcceptedPacketfromSource">
+        <area shape=rect coords="320,592,414,630" href="#DeliverPackettoSink">
+        <area shape=rect coords="747,419,842,457" href="#SetBACKOFFTimer">
+        <area shape=rect coords="577,677,671,715" href="#SetTIMEOUTTimer">
+        <area shape=rect coords="116,326,210,364" href="#SetBACKOFFTimer">
+        <area shape=poly coords="738,225,785,250,738,276,691,250,738,225" href="#TimerType">
+        <area shape=rect coords="432,508,527,546" href="#ClearTIMEOUT">
+        <area shape=poly coords="423,413,470,439,423,465,376,439,423,413" href="#PacketType">
+        <area shape=rect coords="3,412,97,450" href="#SetTIMEOUTTimer">
+        <area shape=poly coords="423,319,470,345,423,371,376,345,423,319" href="$DestinationAddress">
+        <area shape=poly coords="423,225,470,250,423,276,376,250,423,225" href="#Checksum">
+        <area shape=poly coords="393,45,453,45,465,62,453,79,393,79,380,62,393,45" href="#Idle">
+</map>
+
+
+
+<a style="padding:0; border:none" href="/trac/attachment/wiki/CSMAMAC/files/csmaMac_state.png"><img src="/trac/attachment/wiki/CSMAMAC/files/csmaMac_state.png?format=raw" usemap="#GraffleExport" align=left/></a>
+
+}}}
+
+----
+
+Note: Through all of the following descriptions, a "-" is used in place of arguments to functions when those arguments are not important to the overall purpose of the description. Howeverm, that is not to say that these arguments can be changed to ''anything'' and have the code still compile and run successfully. Care must be taken in modifying the reference design.
+
+=== Idle ===
+
+There are two purposes of this state: At startup must initialize the framework and WARP hardware, and in the steady state it must sit and wait for an event to take place. This state maps to the 
 
 {{{
@@ -120 +211 @@
 }}}
 
-
-{{{
-#!c
-int main()
-}}}
-
-
-{{{
-#!c
-int main()
-}}}
-
-
-----
+function of [source:/ResearchApps/MAC/CSMAMAC/csmaMac.c@L csmaMac.c].
+
+==== Startup ====
+This block of code calls the following [http://warp.rice.edu/WARP_API/warpmac_8c.html WARPMAC] functions:
+
+{{{
+#!c
+warpmac_getMyId();
+}}}
+
+This function reads the current setting on the [wiki:HardwareUsersGuides/FPGABoard_v1.2/UserIO#DIPSwitch Dip Switches]. The value is used simply to identify the node in the network. For the purposes of the Reference Design, one node must be identified as "0" and the other as "1."
+
+{{{
+#!c
+warpmac_init()
+}}}
+
+This function sets reasonable default values for many of the parameters of the MAC, configures interrupts and exceptions, configures Ethernet, and finally initializes the custom peripherals such as the radio controller, the PHY, the packet detector, and the automatic gain control block.
+
+{{{
+#!c
+warpmac_setMacAddr(-);
+}}}
+
+This function sets the wireless MAC address of the node.
+
+{{{
+#!c
+warpmac_setMaxResend(-);
+warpmac_setMaxCW(-);
+warpmac_setTimeout(-);
+warpmac_setSlotTime(-);
+}}}
+
+These function set up internal parameters of the MAC. The maximum number of resends is the maximum number of times that a packet should be retransmitted, in the event of not receiving an acknowledgment. The maximum contention window defines "how random" backoffs should be in the worst case. The timeout time is the amount of time that the MAC should wait on an acknowledgment before retransmitting. Finally, the slot time is a length of the minimum contention window.
+
+{{{
+#!c
+warpmac_setRxBuffer(-,0);
+warpmac_setTxBuffer(1);
+}}}
+
+The newest version of the [wiki:OFDM OFDM PHY] supports a large chunk of memory that can be used to queue multiple packets. By default, the system is configured with enough memory to support 4 full-size packets. This block of code instructs the framework to use the first 1/4th of memory to receive packets into, and the second 1/4th of memory to send from. In principle, these functions can be used to help juggle packets in the event of a busy wireless medium. For example, one can receive into a separate piece of memory in order to avoid overwriting a packet that has not been processed by higher layers yet.
+
+
+{{{
+#!c
+warpmac_setGoodPacketHandler(receiveGoodPacket);
+warpmac_setBadPacketHandler(receiveBadPacket);
+warpmac_setTimerHandler(timerExpire);
+warpmac_setEmacHandler(ethernet_callback);
+}}}
+
+This block of code attaches user-level callbacks to interrupt service routines. These functions perform the behaviors that they sound like: receiving a packet that passes checksum, receiving a packet that fails checksum, processing a timer expiration, and handling Ethernet activity respectively.
+
+{{{
+#!c
+warpmac_setChannel(-, -);
+}}}
+
+This function sets the center frequency of the radio in either the 2.4 or 5 GHz spectrum.
+
+{{{
+#!c
+warpmac_setBaseRate(-)
+}}}
+
+Finally, the base rate modulation order is set. This rate must be agreed upon by all nodes in the network ''a priori.'' Within the base rate symbols is a field that specifies the modulation order of the rest of the packet (i.e. the full rate symbols). This enables dynamic modulation for autorate systems.
+
+==== Steady State ====
+
+The steady state behavior of the "Idle" state is very simple: it's nothing. At the bottom of the main function is a while loop that spins in place, waiting for an interrupt service routine to be called by a hardware event.
+
+
+
+----
+
+
 
 === Accepted Packet from Source ===