1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

sys/luid: provide luid_get_lb(), fix documentation

This does two things:

The documentation of `luid_get()` is wrong, or at least confusing.

It talks about

> an 8-bit incrementing counter value into the most significant byte

while the implementation does

    ((uint8_t *)buf)[0] ^= lastused++;	// 0 is LSB!

Now it could be argued that the intention was that the ID is supposed
to be used in Big Endian contexts and that was an omission, however
to keep everyone's sanity, let's keep it simple and just state that this
actually changes the LSB.

Also add a `luid_get_lb()` function that does the same, but modifies the
most significant byte - or the last byte if looking at the index.

This can then be used directly by e.g. #13743
This commit is contained in:
Benjamin Valentin 2020-05-04 16:29:35 +02:00
parent fbae0a1117
commit e195e0269c
2 changed files with 23 additions and 1 deletions

View File

@ -74,7 +74,7 @@ extern "C" {
* @brief Get a unique ID
*
* The resulting ID is built from the base ID generated with luid_base(), which
* isXORed with an 8-bit incrementing counter value into the most significant
* isXORed with an 8-bit incrementing counter value into the first (lowest index)
* byte.
*
* @note The resulting LUID will repeat after 255 calls.
@ -85,6 +85,21 @@ extern "C" {
*/
void luid_get(void *buf, size_t len);
/**
* @brief Get a unique ID with change in the last byte
*
* The resulting ID is built from the base ID generated with luid_base(), which
* isXORed with an 8-bit incrementing counter value into the last (highest index)
* byte.
*
* @note The resulting LUID will repeat after 255 calls.
*
* @param[out] buf memory location to copy the LUID into. MUST be able to
* hold at least @p len bytes
* @param[in] len length of the LUID in bytes
*/
void luid_get_lb(void *buf, size_t len);
/**
* @brief Get a unique short unicast address
*

View File

@ -54,6 +54,13 @@ void luid_get(void *buf, size_t len)
((uint8_t *)buf)[0] ^= lastused++;
}
void luid_get_lb(void *buf, size_t len)
{
luid_base(buf, len);
((uint8_t *)buf)[len - 1] ^= lastused++;
}
void luid_custom(void *buf, size_t len, int gen)
{
luid_base(buf, len);