From 34dda4f22e2b435b6ddec072706809f158e60c7f Mon Sep 17 00:00:00 2001 From: sdhsdh Date: Fri, 7 Aug 2009 18:36:46 +0000 Subject: [PATCH] add Ieee interfaces --- tos/interfaces/Ieee154Packet.nc | 43 ++++++++++++ tos/interfaces/Ieee154Send.nc | 114 ++++++++++++++++++++++++++++++++ 2 files changed, 157 insertions(+) create mode 100644 tos/interfaces/Ieee154Packet.nc create mode 100644 tos/interfaces/Ieee154Send.nc diff --git a/tos/interfaces/Ieee154Packet.nc b/tos/interfaces/Ieee154Packet.nc new file mode 100644 index 00000000..3f635ec1 --- /dev/null +++ b/tos/interfaces/Ieee154Packet.nc @@ -0,0 +1,43 @@ +/* + * "Copyright (c) 2008 The Regents of the University of California. + * All rights reserved." + * + * Permission to use, copy, modify, and distribute this software and its + * documentation for any purpose, without fee, and without written agreement is + * hereby granted, provided that the above copyright notice, the following + * two paragraphs and the author appear in all copies of this software. + * + * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR + * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT + * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF + * CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES, + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY + * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS + * ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO + * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS." + * + */ +#include + +interface Ieee154Packet { + + command ieee154_saddr_t address(); + + command ieee154_saddr_t destination(message_t* msg); + + command ieee154_saddr_t source(message_t* msg); + + command void setDestination(message_t* msg, ieee154_saddr_t addr); + + command void setSource(message_t* msg, ieee154_saddr_t addr); + + command bool isForMe(message_t* msg); + + command ieee154_panid_t pan(message_t* msg); + + command void setPan(message_t* msg, ieee154_panid_t grp); + + command ieee154_panid_t localPan(); +} diff --git a/tos/interfaces/Ieee154Send.nc b/tos/interfaces/Ieee154Send.nc new file mode 100644 index 00000000..3d998f53 --- /dev/null +++ b/tos/interfaces/Ieee154Send.nc @@ -0,0 +1,114 @@ +/* + * "Copyright (c) 2008 The Regents of the University of California. + * All rights reserved." + * + * Permission to use, copy, modify, and distribute this software and its + * documentation for any purpose, without fee, and without written agreement is + * hereby granted, provided that the above copyright notice, the following + * two paragraphs and the author appear in all copies of this software. + * + * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR + * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT + * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF + * CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES, + * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY + * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS + * ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO + * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS." + * + */ + +#include +#include +#include + +/* + * + * The only change from the AMSend interface is that instead of + * sending to an AMID, we now send to a ieee154_saddr_t. + * + */ + +interface Ieee154Send { + + /** + * Send a packet with a data payload of len to address + * addr. To determine the maximum available size, use the + * Packet interface of the component providing AMSend. If send + * returns SUCCESS, then the component will signal the sendDone + * event in the future; if send returns an error, it will not + * signal the event. Note that a component may accept a send + * request which it later finds it cannot satisfy; in this case, it + * will signal sendDone with error code. + * + * @param addr address to which to send the packet + * @param msg the packet + * @param len the length of the data in the packet payload + * @return SUCCESS if the request to send succeeded and a + * sendDone will be signaled later, EBUSY if the + * abstraction cannot send now but will be able to + * later, or FAIL if the communication layer is not + * in a state that can send (e.g., off). + * @see sendDone + */ + command error_t send(ieee154_saddr_t addr, message_t* msg, uint8_t len); + + /** + * Cancel a requested transmission. Returns SUCCESS if the + * transmission was canceled properly (not sent in its + * entirety). Note that the component may not know + * if the send was successfully canceled, if the radio is + * handling much of the logic; in this case, a component + * should be conservative and return an appropriate error code. + * A successful call to cancel must always result in a + * sendFailed event, and never a sendSucceeded event. + * + * @param msg the packet whose transmission should be cancelled. + * @return SUCCESS if the transmission was cancelled, FAIL otherwise. + * @see sendDone + */ + command error_t cancel(message_t* msg); + + /** + * Signaled in response to an accepted send request. msg is + * the message buffer sent, and error indicates whether + * the send was successful. + * + * @param msg the packet which was submitted as a send request + * @param error SUCCESS if it was sent successfully, FAIL if it was not, + * ECANCEL if it was cancelled + * @see send + * @see cancel + */ + + event void sendDone(message_t* msg, error_t error); + + + /** + * Return the maximum payload length that this communication layer + * can provide. This command behaves identically to + * Packet.maxPayloadLength and is included in this + * interface as a convenience. + * + * @return the maximum payload length + */ + + + command uint8_t maxPayloadLength(); + + + /** + * Return a pointer to a protocol's payload region in a packet. + * This command behaves identically to Packet.getPayload + * (minus the length parameter) and is included in this interface + * as a convenience. + * + * @param msg the packet + * @return the payload of the packet + */ + command void* getPayload(message_t* msg, uint8_t len); + + +} -- 2.39.2