X-Git-Url: https://oss.titaniummirror.com/gitweb/?p=tinyos-2.x.git;a=blobdiff_plain;f=tos%2Flib%2Fmac%2Ftkn154%2Finterfaces%2Fpublic%2FIEEE154TxBeaconPayload.nc;h=33768e3c99d4176fb592edea32e9e22b6a678d89;hp=4415ee60373e2955ca6f08468874d03ba8766738;hb=e9bfab607e051bae6afb47b44892ce37541d1b44;hpb=adf1de6c009d13b7b52e68535c63b28f59c97400 diff --git a/tos/lib/mac/tkn154/interfaces/public/IEEE154TxBeaconPayload.nc b/tos/lib/mac/tkn154/interfaces/public/IEEE154TxBeaconPayload.nc index 4415ee60..33768e3c 100644 --- a/tos/lib/mac/tkn154/interfaces/public/IEEE154TxBeaconPayload.nc +++ b/tos/lib/mac/tkn154/interfaces/public/IEEE154TxBeaconPayload.nc @@ -33,6 +33,12 @@ * ======================================================================== */ +/** + * The IEEE154TxBeaconPayload interface allows to access the payload portion of + * the beacon frame that is periodically transmitted by a coordinator in a + * beacon-enabled PAN. This interface replaces the MLME-SET command for the PIB + * attribute values 0x45 (macBeaconPayload) and 0x46 (macBeaconPayloadLength). + */ #include @@ -42,33 +48,33 @@ interface IEEE154TxBeaconPayload * Sets the beacon payload portion for all subsequently transmitted beacons. * This command replaces the MLME-SET command for the PIB attribute values * 0x45 (macBeaconPayload) and 0x46 (macBeaconPayloadLength). The - * setBeaconPayloadDone()<\code> event will be signalled when the - * beacon payload has been set -- until then beaconPayload<\code> must + * setBeaconPayloadDone() event will be signalled when the + * beacon payload has been set -- until then beaconPayload must * not be modified. * * @param beaconPayload the new beacon payload * @param length the length of the new beacon payload (in byte) * * @return EBUSY if another transaction is pending, ESIZE if length is too big, - * SUCCESS otherwise (and only then the setBeaconPayloadDone<\code> event + * SUCCESS otherwise (and only then the setBeaconPayloadDone event * will be signalled) */ command error_t setBeaconPayload(void *beaconPayload, uint8_t length); /** - * Signalled in response to a setBeaconPayload()<\code> request. + * Signalled in response to a setBeaconPayload() request. * Indicates that the beacon payload has been copied and returns the * ownership of the buffer to the next higher layer. * - * @param beaconPayload the beaconPayload<\code> passed in the - * setBeaconPayload()<\code> command - * @param length the length<\code> passed in the - * setBeaconPayload()<\code> command + * @param beaconPayload the beaconPayload passed in the + * setBeaconPayload() command + * @param length the length passed in the + * setBeaconPayload() command */ event void setBeaconPayloadDone(void *beaconPayload, uint8_t length); /** - * Returns a pointer to the current beacon payload. + * Returns a pointer to the current beacon payload. * * @return the current beacon payload */ @@ -84,31 +90,31 @@ interface IEEE154TxBeaconPayload /** * Replaces (overwrites) a portion of the current beacon payload. Whenever * possible, to minimize overhead, the next higher layer should prefer this - * command over the setBeaconPayload()<\code> command. The - * modifyBeaconPayloadDone()<\code> event will be signalled when the - * beacon payload has been updated -- until then buffer<\code> must - * not be modified. + * command over the setBeaconPayload() command. The + * modifyBeaconPayloadDone() event will be signalled when the beacon + * payload has been updated -- until then buffer must not be + * modified. * * @param offset offset into the current beacon payload * @param buffer the buffer to be written * @param length the length of the buffer * - * @return EBUSY if another transaction is pending, ESIZE if offset+length is too big, - * SUCCESS otherwise (and only then the modifyBeaconPayloadDone<\code> event - * will be signalled) + * @return EBUSY if another transaction is pending, ESIZE if offset+length is + * too big, SUCCESS otherwise (and only then the + * modifyBeaconPayloadDone event will be signalled) */ command error_t modifyBeaconPayload(uint8_t offset, void *buffer, uint8_t bufferLength); /** - * Signalled in response to a modifyBeaconPayload()<\code> request. + * Signalled in response to a modifyBeaconPayload() request. * Indicates that the beacon payload has been updated. * - * @param offset the offset<\code> passed in the - * modifyBeaconPayload()<\code> command - * @param buffer the buffer<\code> passed in the - * modifyBeaconPayload()<\code> command - * @param bufferLength the bufferLength<\code> passed in the - * modifyBeaconPayload()<\code> command + * @param offset the offset passed in the + * modifyBeaconPayload() command + * @param buffer the buffer passed in the + * modifyBeaconPayload() command + * @param bufferLength the bufferLength passed in the + * modifyBeaconPayload() command */ event void modifyBeaconPayloadDone(uint8_t offset, void *buffer, uint8_t bufferLength); @@ -117,8 +123,8 @@ interface IEEE154TxBeaconPayload * time to update the beacon payload (if desired). * * The usual policy is that (1) this event is signalled before every beacon - * transmission, and (2) that a subsequent call to setPayload<\code> - * will update the beacon payload portion of this beacon. However, + * transmission, and (2) that a subsequent call to setPayload + * will still update the beacon payload portion of this beacon. However, * because of tight timing constraints in beacon-enabled mode neither can be * guaranteed! */ @@ -126,7 +132,7 @@ interface IEEE154TxBeaconPayload /** * Indicates that a beacon frame has been transmitted (the - * getBeaconPayload<\code> command can be used to inspect the + * getBeaconPayload command can be used to inspect the * beacon payload). */ event void beaconTransmitted();