[Tinyos-2-commits] CVS: tinyos-2.x/tos/interfaces AMPacket.nc, 1.5, 1.6 AMSend.nc, 1.5, 1.6 BlockRead.nc, 1.4, 1.5 BlockWrite.nc, 1.5, 1.6 ConfigStorage.nc, 1.4, 1.5 Crc.nc, 1.2, 1.3 CsmaBackoff.nc, 1.2, 1.3 I2CPacket.nc, 1.5, 1.6 Intercept.nc, 1.5, 1.6 InternalFlash.nc, 1.1, 1.2 LinkPacketMetadata.nc, 1.1, 1.2 LogRead.nc, 1.4, 1.5 LogWrite.nc, 1.4, 1.5 LowPowerListening.nc, 1.1, 1.2 Packet.nc, 1.6, 1.7 PacketAcknowledgements.nc, 1.2, 1.3 PacketLink.nc, 1.1, 1.2 Pool.nc, 1.4, 1.5 Queue.nc, 1.4, 1.5 RadioTimeStamping.nc, 1.2, 1.3 ReadRef.nc, 1.4, 1.5 ReadStream.nc, 1.4, 1.5 Receive.nc, 1.5, 1.6 Send.nc, 1.5, 1.6 SendNotifier.nc, 1.1, 1.2 SpiPacket.nc, 1.4, 1.5 UartByte.nc, 1.4, 1.5 UartStream.nc, 1.4, 1.5
John Regehr
regehr at users.sourceforge.net
Tue Jun 3 20:00:43 PDT 2008
Update of /cvsroot/tinyos/tinyos-2.x/tos/interfaces
In directory sc8-pr-cvs10.sourceforge.net:/tmp/cvs-serv5975
Modified Files:
AMPacket.nc AMSend.nc BlockRead.nc BlockWrite.nc
ConfigStorage.nc Crc.nc CsmaBackoff.nc I2CPacket.nc
Intercept.nc InternalFlash.nc LinkPacketMetadata.nc LogRead.nc
LogWrite.nc LowPowerListening.nc Packet.nc
PacketAcknowledgements.nc PacketLink.nc Pool.nc Queue.nc
RadioTimeStamping.nc ReadRef.nc ReadStream.nc Receive.nc
Send.nc SendNotifier.nc SpiPacket.nc UartByte.nc UartStream.nc
Log Message:
safe tinyos annotations (all in nesdoc comments)
Index: AMPacket.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/AMPacket.nc,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** AMPacket.nc 20 Jun 2007 23:49:02 -0000 1.5
--- AMPacket.nc 4 Jun 2008 03:00:25 -0000 1.6
***************
*** 61,65 ****
* If <tt>amsg</tt> is not an AM packet, the results of this command
* are undefined.
! * @param amsg the packet
* @return the destination address of the packet.
*/
--- 61,65 ----
* If <tt>amsg</tt> is not an AM packet, the results of this command
* are undefined.
! * @param 'message_t* ONE amsg' the packet
* @return the destination address of the packet.
*/
***************
*** 71,75 ****
* If <tt>amsg</tt> is not an AM packet, the results of this command
* are undefined.
! * @param amsg the packet
* @return the source address of the packet.
*/
--- 71,75 ----
* If <tt>amsg</tt> is not an AM packet, the results of this command
* are undefined.
! * @param 'message_t* ONE amsg' the packet
* @return the source address of the packet.
*/
***************
*** 86,90 ****
* not an AM packet, the results of this command are undefined.
*
! * @param amsg the packet
* @param addr the address
*/
--- 86,90 ----
* not an AM packet, the results of this command are undefined.
*
! * @param 'message_t* ONE amsg' the packet
* @param addr the address
*/
***************
*** 104,108 ****
* not an AM packet, the results of this command are undefined.
*
! * @param amsg the packet
* @param addr the address
*/
--- 104,108 ----
* not an AM packet, the results of this command are undefined.
*
! * @param 'message_t* ONE amsg' the packet
* @param addr the address
*/
***************
*** 120,124 ****
* the results of this command are undefined.
*
! * @param amsg the packet
* @return whether the packet is addressed to this AM stack
*/
--- 120,124 ----
* the results of this command are undefined.
*
! * @param 'message_t* ONE amsg' the packet
* @return whether the packet is addressed to this AM stack
*/
***************
*** 130,134 ****
* are undefined.
*
! * @param amsg the packet
* @return the AM type
*/
--- 130,134 ----
* are undefined.
*
! * @param 'message_t* ONE amsg' the packet
* @return the AM type
*/
***************
*** 145,149 ****
* this command are undefined.
*
! * @param amsg the packet
* @param t the AM type
*/
--- 145,149 ----
* this command are undefined.
*
! * @param 'message_t* ONE amsg' the packet
* @param t the AM type
*/
***************
*** 160,164 ****
* own.
*
! * @param amsg the packet
* @return the AM group of this packet
*/
--- 160,164 ----
* own.
*
! * @param 'message_t* ONE amsg' the packet
* @return the AM group of this packet
*/
***************
*** 171,175 ****
* may overwrite changes made with this command.
*
! * @param amsg the packet
* @param group the packet's new AM group value
*/
--- 171,175 ----
* may overwrite changes made with this command.
*
! * @param 'message_t* ONE amsg' the packet
* @param group the packet's new AM group value
*/
Index: AMSend.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/AMSend.nc,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** AMSend.nc 13 Sep 2007 23:10:17 -0000 1.5
--- AMSend.nc 4 Jun 2008 03:00:25 -0000 1.6
***************
*** 58,62 ****
*
* @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
--- 58,62 ----
*
* @param addr address to which to send the packet
! * @param 'message_t* ONE msg' the packet
* @param len the length of the data in the packet payload
* @return SUCCESS if the request to send succeeded and a
***************
*** 79,83 ****
* 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
--- 79,83 ----
* sendFailed event, and never a sendSucceeded event.
*
! * @param 'message_t* ONE msg' the packet whose transmission should be cancelled.
* @return SUCCESS if the transmission was cancelled, FAIL otherwise.
* @see sendDone
***************
*** 90,94 ****
* 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
--- 90,94 ----
* the send was successful.
*
! * @param 'message_t* ONE 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
***************
*** 119,124 ****
* as a convenience.
*
! * @param msg the packet
! * @return the payload of the packet
*/
command void* getPayload(message_t* msg, uint8_t len);
--- 119,124 ----
* as a convenience.
*
! * @param 'message_t* ONE msg' the packet
! * @return 'void* COUNT(len)' the payload of the packet
*/
command void* getPayload(message_t* msg, uint8_t len);
Index: BlockRead.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/BlockRead.nc,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** BlockRead.nc 12 Dec 2006 18:23:14 -0000 1.4
--- BlockRead.nc 4 Jun 2008 03:00:25 -0000 1.5
***************
*** 47,51 ****
*
* @param addr starting address to begin reading.
! * @param buf buffer to place read data.
* @param len number of bytes to read.
* @return
--- 47,51 ----
*
* @param addr starting address to begin reading.
! * @param 'void* COUNT(len) buf' buffer to place read data.
* @param len number of bytes to read.
* @return
***************
*** 60,64 ****
*
* @param addr starting address of read.
! * @param buf buffer where read data was placed.
* @param len number of bytes read.
* @param error SUCCESS if the operation was successful, FAIL if
--- 60,64 ----
*
* @param addr starting address of read.
! * @param 'void* COUNT(len) buf' buffer where read data was placed.
* @param len number of bytes read.
* @param error SUCCESS if the operation was successful, FAIL if
Index: BlockWrite.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/BlockWrite.nc,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** BlockWrite.nc 2 May 2008 19:50:00 -0000 1.5
--- BlockWrite.nc 4 Jun 2008 03:00:25 -0000 1.6
***************
*** 49,53 ****
*
* @param addr starting address to begin write.
! * @param buf buffer to write data from.
* @param len number of bytes to write.
* @return
--- 49,53 ----
*
* @param addr starting address to begin write.
! * @param 'void* COUNT(len) buf' buffer to write data from.
* @param len number of bytes to write.
* @return
***************
*** 64,68 ****
*
* @param addr starting address of write.
! * @param buf buffer that written data was read from.
* @param len number of bytes written.
* @param error SUCCESS if the operation was successful, FAIL if
--- 64,68 ----
*
* @param addr starting address of write.
! * @param 'void* COUNT(len) buf' buffer that written data was read from.
* @param len number of bytes written.
* @param error SUCCESS if the operation was successful, FAIL if
Index: ConfigStorage.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/ConfigStorage.nc,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** ConfigStorage.nc 12 Dec 2006 18:23:14 -0000 1.4
--- ConfigStorage.nc 4 Jun 2008 03:00:25 -0000 1.5
***************
*** 57,61 ****
*
* @param addr starting address to begin reading.
! * @param buf buffer to place read data.
* @param len number of bytes to read.
* @return
--- 57,61 ----
*
* @param addr starting address to begin reading.
! * @param 'void* COUNT(len) buf' buffer to place read data.
* @param len number of bytes to read.
* @return
***************
*** 73,77 ****
*
* @param addr starting address of read.
! * @param buf buffer where read data was placed.
* @param len number of bytes read.
* @param error SUCCESS if the operation was successful, FAIL if
--- 73,77 ----
*
* @param addr starting address of read.
! * @param 'void* COUNT(len) buf' buffer where read data was placed.
* @param len number of bytes read.
* @param error SUCCESS if the operation was successful, FAIL if
***************
*** 87,91 ****
*
* @param addr starting address to begin write.
! * @param buf buffer to write data from.
* @param len number of bytes to write.
* @return
--- 87,91 ----
*
* @param addr starting address to begin write.
! * @param 'void* COUNT(len) buf' buffer to write data from.
* @param len number of bytes to write.
* @return
***************
*** 103,107 ****
*
* @param addr starting address of write.
! * @param buf buffer that written data was read from.
* @param len number of bytes written.
* @param error SUCCESS if the operation was successful, FAIL if
--- 103,107 ----
*
* @param addr starting address of write.
! * @param 'void* COUNT(len) buf' buffer that written data was read from.
* @param len number of bytes written.
* @param error SUCCESS if the operation was successful, FAIL if
Index: Crc.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/Crc.nc,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** Crc.nc 27 Sep 2007 23:27:00 -0000 1.2
--- Crc.nc 4 Jun 2008 03:00:25 -0000 1.3
***************
*** 36,40 ****
* Compute the CRC-16 value of a byte array.
*
! * @param buf A pointer to the buffer over which to compute CRC.
* @param len The length of the buffer over which to compute CRC.
* @return The CRC-16 value.
--- 36,40 ----
* Compute the CRC-16 value of a byte array.
*
! * @param 'void* COUNT(len) buf' A pointer to the buffer over which to compute CRC.
* @param len The length of the buffer over which to compute CRC.
* @return The CRC-16 value.
***************
*** 47,51 ****
*
* @param startCrc An initial CRC value to begin with
! * @param buf A pointer to a buffer of data
* @param len The length of the buffer
* @return The CRC-16 value.
--- 47,51 ----
*
* @param startCrc An initial CRC value to begin with
! * @param 'void* COUNT(len) buf' A pointer to a buffer of data
* @param len The length of the buffer
* @return The CRC-16 value.
Index: CsmaBackoff.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/CsmaBackoff.nc,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** CsmaBackoff.nc 12 Jul 2006 17:02:16 -0000 1.2
--- CsmaBackoff.nc 4 Jun 2008 03:00:25 -0000 1.3
***************
*** 32,35 ****
--- 32,36 ----
* Return initial backoff time before attempting to send message m. The
* units are radio dependent.
+ * @param 'message_t* ONE m'
* @return Initial backoff time
*/
***************
*** 39,42 ****
--- 40,44 ----
* Return backoff time after message m could not be send due to congestion.
* The units are raio dependent.
+ * @param 'message_t* ONE m'
* @return Backoff time after congestion
*/
Index: I2CPacket.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/I2CPacket.nc,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** I2CPacket.nc 2 May 2008 19:50:10 -0000 1.5
--- I2CPacket.nc 4 Jun 2008 03:00:25 -0000 1.6
***************
*** 59,63 ****
* @param addr The slave device address. Only used if I2C_START is set.
* @param length Length, in bytes, to be read
! * @param data A point to a data buffer to read into
*
* @return SUCCESS if bus available and request accepted.
--- 59,63 ----
* @param addr The slave device address. Only used if I2C_START is set.
* @param length Length, in bytes, to be read
! * @param 'uint8_t* COUNT(length) data' A point to a data buffer to read into
*
* @return SUCCESS if bus available and request accepted.
***************
*** 75,79 ****
* @param addr The slave device address. Only used if I2C_START is set.
* @param length Length, in bytes, to be read
! * @param data A point to a data buffer to read into
*
* @return SUCCESS if bus available and request accepted.
--- 75,79 ----
* @param addr The slave device address. Only used if I2C_START is set.
* @param length Length, in bytes, to be read
! * @param 'uint8_t* COUNT(length) data' A point to a data buffer to read into
*
* @return SUCCESS if bus available and request accepted.
***************
*** 86,90 ****
* @param addr The slave device address
* @param length Length, in bytes, read
! * @param data Pointer to the received data buffer
* @param success SUCCESS if transfer completed without error.
*/
--- 86,90 ----
* @param addr The slave device address
* @param length Length, in bytes, read
! * @param 'uint8_t* COUNT(length) data' Pointer to the received data buffer
* @param success SUCCESS if transfer completed without error.
*/
***************
*** 96,100 ****
* @param addr The slave device address
* @param length Length, in bytes, written
! * @param data Pointer to the data buffer written
* @param success SUCCESS if transfer completed without error.
*/
--- 96,100 ----
* @param addr The slave device address
* @param length Length, in bytes, written
! * @param 'uint8_t* COUNT(length) data' Pointer to the data buffer written
* @param success SUCCESS if transfer completed without error.
*/
Index: Intercept.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/Intercept.nc,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** Intercept.nc 9 Feb 2008 05:44:09 -0000 1.5
--- Intercept.nc 4 Jun 2008 03:00:26 -0000 1.6
***************
*** 18,24 ****
* forwarded to another destination.
*
! * @param msg The complete message received.
*
! * @param payload The payload portion of the packet for this
* protocol layer.
*
--- 18,24 ----
* forwarded to another destination.
*
! * @param 'message_t* ONE msg' The complete message received.
*
! * @param 'void* COUNT(len) payload' The payload portion of the packet for this
* protocol layer.
*
Index: InternalFlash.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/InternalFlash.nc,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** InternalFlash.nc 2 Apr 2007 06:49:32 -0000 1.1
--- InternalFlash.nc 4 Jun 2008 03:00:26 -0000 1.2
***************
*** 40,44 ****
*
* @param addr A pointer to the starting address from which to read.
! * @param buf A pointer to the buffer into which read bytes are
* placed.
* @param size The number of bytes to read.
--- 40,44 ----
*
* @param addr A pointer to the starting address from which to read.
! * @param 'void* COUNT(size) buf' A pointer to the buffer into which read bytes are
* placed.
* @param size The number of bytes to read.
***************
*** 53,57 ****
*
* @param addr A pointer to the starting address to which to write.
! * @param buf A pointer to the buffer from which bytes are read.
* @param size The number of bytes to write.
* @return SUCCESS if the bytes were successfully written.
--- 53,57 ----
*
* @param addr A pointer to the starting address to which to write.
! * @param 'void* COUNT(size) buf' A pointer to the buffer from which bytes are read.
* @param size The number of bytes to write.
* @return SUCCESS if the bytes were successfully written.
Index: LinkPacketMetadata.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/LinkPacketMetadata.nc,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** LinkPacketMetadata.nc 14 Sep 2007 00:10:08 -0000 1.1
--- LinkPacketMetadata.nc 4 Jun 2008 03:00:29 -0000 1.2
***************
*** 42,46 ****
* would enable MTU packets to have a reception rate of 90% or greater.
*
! * @param msg A received packet during which the channel was measured.
* @return Whether the channel had high quality.
*/
--- 42,46 ----
* would enable MTU packets to have a reception rate of 90% or greater.
*
! * @param 'message_t* ONE msg' A received packet during which the channel was measured.
* @return Whether the channel had high quality.
*/
Index: LogRead.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/LogRead.nc,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** LogRead.nc 12 Dec 2006 18:23:14 -0000 1.4
--- LogRead.nc 4 Jun 2008 03:00:29 -0000 1.5
***************
*** 55,59 ****
* completion of the operation.
*
! * @param buf buffer to place read data.
* @param len number of bytes to read.
* @return
--- 55,59 ----
* completion of the operation.
*
! * @param 'void* COUNT(len) buf' buffer to place read data.
* @param len number of bytes to read.
* @return
***************
*** 68,72 ****
*
* @param addr starting address of read.
! * @param buf buffer where read data was placed.
* @param len number of bytes read - this may be less than requested
* (even equal to 0) if the end of the log was reached
--- 68,72 ----
*
* @param addr starting address of read.
! * @param 'void* COUNT(len) buf' buffer where read data was placed.
* @param len number of bytes read - this may be less than requested
* (even equal to 0) if the end of the log was reached
Index: LogWrite.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/LogWrite.nc,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** LogWrite.nc 12 Dec 2006 18:23:14 -0000 1.4
--- LogWrite.nc 4 Jun 2008 03:00:29 -0000 1.5
***************
*** 45,49 ****
* event will signal completion of the operation.
*
! * @param buf buffer to write data from.
* @param len number of bytes to write.
* @return
--- 45,49 ----
* event will signal completion of the operation.
*
! * @param 'void* COUNT(len) buf' buffer to write data from.
* @param len number of bytes to write.
* @return
***************
*** 59,63 ****
* been completed.
*
! * @param buf buffer that written data was read from.
* @param len number of bytes actually written (valid even in case of error)
* @param records_lost TRUE if this append destroyed some old records from
--- 59,63 ----
* been completed.
*
! * @param 'void* COUNT(len) buf' buffer that written data was read from.
* @param len number of bytes actually written (valid even in case of error)
* @param records_lost TRUE if this append destroyed some old records from
Index: LowPowerListening.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/LowPowerListening.nc,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** LowPowerListening.nc 12 Apr 2007 17:11:25 -0000 1.1
--- LowPowerListening.nc 4 Jun 2008 03:00:30 -0000 1.2
***************
*** 85,89 ****
* Configure this outgoing message so it can be transmitted to a neighbor mote
* with the specified Rx sleep interval.
! * @param msg Pointer to the message that will be sent
* @param sleepInterval The receiving node's sleep interval, in [ms]
*/
--- 85,89 ----
* Configure this outgoing message so it can be transmitted to a neighbor mote
* with the specified Rx sleep interval.
! * @param 'message_t* ONE msg' Pointer to the message that will be sent
* @param sleepInterval The receiving node's sleep interval, in [ms]
*/
***************
*** 91,94 ****
--- 91,95 ----
/**
+ * @param 'message_t* ONE msg'
* @return the destination node's sleep interval configured in this message
*/
***************
*** 100,104 ****
* Duty cycle is in units of [percentage*100], i.e. 0.25% duty cycle = 25.
*
! * @param msg Pointer to the message that will be sent
* @param dutyCycle The duty cycle of the receiving mote, in units of
* [percentage*100]
--- 101,105 ----
* Duty cycle is in units of [percentage*100], i.e. 0.25% duty cycle = 25.
*
! * @param 'message_t* ONE msg' Pointer to the message that will be sent
* @param dutyCycle The duty cycle of the receiving mote, in units of
* [percentage*100]
***************
*** 107,110 ****
--- 108,112 ----
/**
+ * @param 'message_t* ONE msg'
* @return the destination node's duty cycle configured in this message
* in units of [percentage*100]
Index: Packet.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/Packet.nc,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -d -r1.6 -r1.7
*** Packet.nc 5 Dec 2007 09:45:25 -0000 1.6
--- Packet.nc 4 Jun 2008 03:00:30 -0000 1.7
***************
*** 49,53 ****
* total operation: calling clear() on any layer will completely
* clear the packet for reuse.
! * @param msg the packet to clear
*/
--- 49,53 ----
* total operation: calling clear() on any layer will completely
* clear the packet for reuse.
! * @param 'message_t* ONE msg' the packet to clear
*/
***************
*** 61,65 ****
* the same value as maxPayloadLength().
*
! * @param msg the packet to examine
* @return the length of its current payload
*/
--- 61,65 ----
* the same value as maxPayloadLength().
*
! * @param 'message_t* ONE msg' the packet to examine
* @return the length of its current payload
*/
***************
*** 77,81 ****
* sending.
*
! * @param msg the packet
* @param len the value to set its length field to
*/
--- 77,81 ----
* sending.
*
! * @param 'message_t* ONE msg' the packet
* @param len the value to set its length field to
*/
***************
*** 108,114 ****
* pointer or NULL.
*
! * @param msg the packet
* @param len the length of payload required
! * @return a pointer to the packet's data payload for this layer
* or NULL if <tt>len</tt> is too big
*/
--- 108,114 ----
* pointer or NULL.
*
! * @param 'message_t* ONE msg' the packet
* @param len the length of payload required
! * @return 'void* COUNT_NOK(len)' a pointer to the packet's data payload for this layer
* or NULL if <tt>len</tt> is too big
*/
Index: PacketAcknowledgements.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/PacketAcknowledgements.nc,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** PacketAcknowledgements.nc 12 Jul 2006 17:02:17 -0000 1.2
--- PacketAcknowledgements.nc 4 Jun 2008 03:00:30 -0000 1.3
***************
*** 40,44 ****
* completes.
*
! * @param msg - A message which should be acknowledged when transmitted.
* @return SUCCESS if acknowledgements are enabled, EBUSY
* if the communication layer cannot enable them at this time, FAIL
--- 40,44 ----
* completes.
*
! * @param 'message_t* ONE msg' - A message which should be acknowledged when transmitted.
* @return SUCCESS if acknowledgements are enabled, EBUSY
* if the communication layer cannot enable them at this time, FAIL
***************
*** 52,56 ****
* synchronous acknowledgments.
*
! * @param msg - A message which should not be acknowledged when transmitted.
* @return SUCCESS if acknowledgements are disabled, EBUSY
* if the communication layer cannot disable them at this time, FAIL
--- 52,56 ----
* synchronous acknowledgments.
*
! * @param 'message_t* ONE msg' - A message which should not be acknowledged when transmitted.
* @return SUCCESS if acknowledgements are disabled, EBUSY
* if the communication layer cannot disable them at this time, FAIL
***************
*** 67,71 ****
* return FALSE.
*
! * @param msg - A transmitted message.
* @return Whether the packet was acknowledged.
*
--- 67,71 ----
* return FALSE.
*
! * @param 'message_t* ONE msg' - A transmitted message.
* @return Whether the packet was acknowledged.
*
Index: PacketLink.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/PacketLink.nc,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** PacketLink.nc 19 Jun 2007 18:11:44 -0000 1.1
--- PacketLink.nc 4 Jun 2008 03:00:30 -0000 1.2
***************
*** 40,44 ****
* Set the maximum number of times attempt message delivery
* Default is 0
! * @param msg
* @param maxRetries the maximum number of attempts to deliver
* the message
--- 40,44 ----
* Set the maximum number of times attempt message delivery
* Default is 0
! * @param 'message_t* ONE msg'
* @param maxRetries the maximum number of attempts to deliver
* the message
***************
*** 54,57 ****
--- 54,58 ----
/**
+ * @param 'message_t* ONE msg'
* @return the maximum number of retry attempts for this message
*/
***************
*** 59,62 ****
--- 60,64 ----
/**
+ * @param 'message_t* ONE msg'
* @return the delay between retry attempts in ms for this message
*/
***************
*** 64,67 ****
--- 66,70 ----
/**
+ * @param 'message_t* ONE msg'
* @return TRUE if the message was delivered.
*/
Index: Pool.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/Pool.nc,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** Pool.nc 12 Dec 2006 18:23:14 -0000 1.4
--- Pool.nc 4 Jun 2008 03:00:31 -0000 1.5
***************
*** 83,86 ****
--- 83,87 ----
* Deallocate an object, putting it back into the pool.
*
+ * @param 't* ONE newVal'
* @return SUCCESS if the entry was put in successfully, FAIL
* if the pool is full.
***************
*** 91,95 ****
* Allocate an element from the pool.
*
! * @return A pointer if the pool is not empty, NULL if
* the pool is empty.
*/
--- 92,96 ----
* Allocate an element from the pool.
*
! * @return 't* ONE_NOK' A pointer if the pool is not empty, NULL if
* the pool is empty.
*/
Index: Queue.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/Queue.nc,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** Queue.nc 12 Dec 2006 18:23:14 -0000 1.4
--- Queue.nc 4 Jun 2008 03:00:31 -0000 1.5
***************
*** 69,73 ****
* is empty, the return value is undefined.
*
! * @return The head of the queue.
*/
command t head();
--- 69,73 ----
* is empty, the return value is undefined.
*
! * @return 't ONE' The head of the queue.
*/
command t head();
***************
*** 77,81 ****
* value is undefined.
*
! * @return The head of the queue.
*/
command t dequeue();
--- 77,81 ----
* value is undefined.
*
! * @return 't ONE' The head of the queue.
*/
command t dequeue();
***************
*** 84,88 ****
* Enqueue an element to the tail of the queue.
*
! * @param newVal - the element to enqueue
* @return SUCCESS if the element was enqueued successfully, FAIL
* if it was not enqueued.
--- 84,88 ----
* Enqueue an element to the tail of the queue.
*
! * @param 't ONE newVal' - the element to enqueue
* @return SUCCESS if the element was enqueued successfully, FAIL
* if it was not enqueued.
***************
*** 97,101 ****
*
* @param index - the index of the element to return
! * @return the requested element in the queue.
*/
command t element(uint8_t idx);
--- 97,101 ----
*
* @param index - the index of the element to return
! * @return 't ONE' the requested element in the queue.
*/
command t element(uint8_t idx);
Index: RadioTimeStamping.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/RadioTimeStamping.nc,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** RadioTimeStamping.nc 12 Jul 2006 17:02:18 -0000 1.2
--- RadioTimeStamping.nc 4 Jun 2008 03:00:31 -0000 1.3
***************
*** 36,39 ****
--- 36,40 ----
* Provides the time at which start of frame delimiter has been
* transmitted: units are in terms of a 32kHz clock.
+ * @param 'message_t* ONE p_msg'
*/
async event void transmittedSFD( uint16_t time, message_t* p_msg );
Index: ReadRef.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/ReadRef.nc,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** ReadRef.nc 12 Dec 2006 18:23:15 -0000 1.4
--- ReadRef.nc 4 Jun 2008 03:00:31 -0000 1.5
***************
*** 52,56 ****
* Initiates a read of the value.
*
! * @param val a pointer to space that will be filled by the value
*
* @return SUCCESS if a readDone() event will eventually come back.
--- 52,56 ----
* Initiates a read of the value.
*
! * @param 'val_t* ONE val' a pointer to space that will be filled by the value
*
* @return SUCCESS if a readDone() event will eventually come back.
***************
*** 63,67 ****
*
* @param result SUCCESS if the read() was successful
! * @param val a pointer to the value that has been read
*/
event void readDone( error_t result, val_t* val );
--- 63,67 ----
*
* @param result SUCCESS if the read() was successful
! * @param 'val_t* ONE val' a pointer to the value that has been read
*/
event void readDone( error_t result, val_t* val );
Index: ReadStream.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/ReadStream.nc,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** ReadStream.nc 12 Dec 2006 18:23:15 -0000 1.4
--- ReadStream.nc 4 Jun 2008 03:00:31 -0000 1.5
***************
*** 61,65 ****
* overrun the buffer.
*
! * @param buf a pointer to the buffer
* @param count the number of values the buffer should hold
*
--- 61,65 ----
* overrun the buffer.
*
! * @param 'val_t* COUNT(count) buf' a pointer to the buffer
* @param count the number of values the buffer should hold
*
***************
*** 84,88 ****
*
* @param result SUCCESS if the buffer was filled without errors
! * @param buf a pointer to the buffer that has been filled
* @param count the number of values actually read
*/
--- 84,88 ----
*
* @param result SUCCESS if the buffer was filled without errors
! * @param 'val_t* COUNT(count) buf' a pointer to the buffer that has been filled
* @param count the number of values actually read
*/
Index: Receive.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/Receive.nc,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** Receive.nc 13 Sep 2007 23:10:17 -0000 1.5
--- Receive.nc 4 Jun 2008 03:00:32 -0000 1.6
***************
*** 58,65 ****
* instead send a packet it most recently received.
*
! * @param msg the receied packet
! * @param payload a pointer to the packet's payload
* @param len the length of the data region pointed to by payload
! * @return a packet buffer for the stack to use for the next
* received packet.
*/
--- 58,65 ----
* instead send a packet it most recently received.
*
! * @param 'message_t* ONE msg' the receied packet
! * @param 'void* COUNT(len) payload' a pointer to the packet's payload
* @param len the length of the data region pointed to by payload
! * @return 'message_t* ONE' a packet buffer for the stack to use for the next
* received packet.
*/
Index: Send.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/Send.nc,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** Send.nc 13 Sep 2007 23:10:17 -0000 1.5
--- Send.nc 4 Jun 2008 03:00:33 -0000 1.6
***************
*** 54,58 ****
* appropriate error code.
*
! * @param msg the packet to send
* @param len the length of the packet payload
* @return SUCCESS if the request was accepted and will issue
--- 54,58 ----
* appropriate error code.
*
! * @param 'message_t* ONE msg' the packet to send
* @param len the length of the packet payload
* @return SUCCESS if the request was accepted and will issue
***************
*** 72,76 ****
* should be conservative and return an appropriate error code.
*
! * @param msg the packet whose transmission should be cancelled
* @return SUCCESS if the packet was successfully cancelled, FAIL
* otherwise
--- 72,76 ----
* should be conservative and return an appropriate error code.
*
! * @param 'message_t* ONE msg' the packet whose transmission should be cancelled
* @return SUCCESS if the packet was successfully cancelled, FAIL
* otherwise
***************
*** 83,87 ****
* send was succesful, and if not, the cause of the failure.
*
! * @param msg the message which was requested to send
* @param error SUCCESS if it was transmitted successfully, FAIL if
* it was not, ECANCEL if it was cancelled via <tt>cancel</tt>
--- 83,87 ----
* send was succesful, and if not, the cause of the failure.
*
! * @param 'message_t* ONE msg' the message which was requested to send
* @param error SUCCESS if it was transmitted successfully, FAIL if
* it was not, ECANCEL if it was cancelled via <tt>cancel</tt>
***************
*** 109,114 ****
* included in this interface as a convenience.
*
! * @param msg the packet
! * @return a pointer to the packet's payload
*/
command void* getPayload(message_t* msg, uint8_t len);
--- 109,114 ----
* included in this interface as a convenience.
*
! * @param 'message_t* ONE msg' the packet
! * @return 'void* COUNT_NOK(len)' a pointer to the packet's payload
*/
command void* getPayload(message_t* msg, uint8_t len);
Index: SendNotifier.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/SendNotifier.nc,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** SendNotifier.nc 4 Feb 2008 23:10:19 -0000 1.1
--- SendNotifier.nc 4 Jun 2008 03:00:33 -0000 1.2
***************
*** 55,59 ****
*
* @param dest The destination address of the messsage
! * @param msg The message about to be transmitted
*/
event void aboutToSend(am_addr_t dest, message_t *msg);
--- 55,59 ----
*
* @param dest The destination address of the messsage
! * @param 'message_t* ONE msg' The message about to be transmitted
*/
event void aboutToSend(am_addr_t dest, message_t *msg);
Index: SpiPacket.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/SpiPacket.nc,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** SpiPacket.nc 12 Dec 2006 18:23:15 -0000 1.4
--- SpiPacket.nc 4 Jun 2008 03:00:35 -0000 1.5
***************
*** 46,52 ****
* Send a message over the SPI bus.
*
! * @param txBuf A pointer to the buffer to send over the bus. If this
* parameter is NULL, then the SPI will send zeroes.
! * @param rxBuf A pointer to the buffer where received data should
* be stored. If this parameter is NULL, then the SPI will
* discard incoming bytes.
--- 46,52 ----
* Send a message over the SPI bus.
*
! * @param 'uint8_t* COUNT_NOK(len) txBuf' A pointer to the buffer to send over the bus. If this
* parameter is NULL, then the SPI will send zeroes.
! * @param 'uint8_t* COUNT_NOK(len) rxBuf' A pointer to the buffer where received data should
* be stored. If this parameter is NULL, then the SPI will
* discard incoming bytes.
***************
*** 62,67 ****
* Notification that the send command has completed.
*
! * @param txBuf The buffer used for transmission
! * @param rxBuf The buffer used for reception
* @param len The request length of the transfer, but not necessarily
* the number of bytes that were actually transferred
--- 62,67 ----
* Notification that the send command has completed.
*
! * @param 'uint8_t* COUNT(len) txBuf' The buffer used for transmission
! * @param 'uint8_t* COUNT(len) rxBuf' The buffer used for reception
* @param len The request length of the transfer, but not necessarily
* the number of bytes that were actually transferred
Index: UartByte.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/UartByte.nc,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** UartByte.nc 12 Dec 2006 18:23:15 -0000 1.4
--- UartByte.nc 4 Jun 2008 03:00:35 -0000 1.5
***************
*** 50,54 ****
* received.
*
! * @param byte Where to place received byte.
* @param timeout How long in byte times to wait.
* @return SUCCESS if a byte was received, FAIL if timed out.
--- 50,54 ----
* received.
*
! * @param 'uint8_t* ONE byte' Where to place received byte.
* @param timeout How long in byte times to wait.
* @return SUCCESS if a byte was received, FAIL if timed out.
Index: UartStream.nc
===================================================================
RCS file: /cvsroot/tinyos/tinyos-2.x/tos/interfaces/UartStream.nc,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** UartStream.nc 12 Dec 2006 18:23:15 -0000 1.4
--- UartStream.nc 4 Jun 2008 03:00:35 -0000 1.5
***************
*** 42,46 ****
* complete.
*
! * @param buf Buffer for bytes to send.
* @param len Number of bytes to send.
* @return SUCCESS if request was accepted, FAIL otherwise.
--- 42,46 ----
* complete.
*
! * @param 'uint8_t* COUNT(len) buf' Buffer for bytes to send.
* @param len Number of bytes to send.
* @return SUCCESS if request was accepted, FAIL otherwise.
***************
*** 51,55 ****
* Signal completion of sending a stream.
*
! * @param buf Bytes sent.
* @param len Number of bytes sent.
* @param error SUCCESS if the transmission was successful, FAIL otherwise.
--- 51,55 ----
* Signal completion of sending a stream.
*
! * @param 'uint8_t* COUNT(len) buf' Bytes sent.
* @param len Number of bytes sent.
* @param error SUCCESS if the transmission was successful, FAIL otherwise.
***************
*** 84,88 ****
* complete.
*
! * @param buf Buffer for received bytes.
* @param len Number of bytes to receive.
* @return SUCCESS if request was accepted, FAIL otherwise.
--- 84,88 ----
* complete.
*
! * @param 'uint8_t* COUNT(len) buf' Buffer for received bytes.
* @param len Number of bytes to receive.
* @return SUCCESS if request was accepted, FAIL otherwise.
***************
*** 93,97 ****
* Signal completion of receiving a stream.
*
! * @param buf Buffer for bytes received.
* @param len Number of bytes received.
* @param error SUCCESS if the reception was successful, FAIL otherwise.
--- 93,97 ----
* Signal completion of receiving a stream.
*
! * @param 'uint8_t* COUNT(len) buf' Buffer for bytes received.
* @param len Number of bytes received.
* @param error SUCCESS if the reception was successful, FAIL otherwise.
More information about the Tinyos-2-commits
mailing list