PebbleOS v4.47.0-512-g5285d4236
Loading...
Searching...
No Matches
Byte order

Conversions between the CPU byte order (always little-endian) and fixed byte orders. More...

Data Structures

struct  pbl_be16_t
 Big-endian 16-bit value, wrapped so it cannot be used without conversion. More...
 

Functions

static uint16_t pbl_be16_to_cpu (uint16_t v)
 Convert a big-endian 16-bit value to CPU order.
 
static uint16_t pbl_cpu_to_be16 (uint16_t v)
 Convert a 16-bit value in CPU order to big-endian.
 
static uint32_t pbl_be32_to_cpu (uint32_t v)
 Convert a big-endian 32-bit value to CPU order.
 
static uint32_t pbl_cpu_to_be32 (uint32_t v)
 Convert a 32-bit value in CPU order to big-endian.
 
static uint64_t pbl_be64_to_cpu (uint64_t v)
 Convert a big-endian 64-bit value to CPU order.
 
static uint64_t pbl_cpu_to_be64 (uint64_t v)
 Convert a 64-bit value in CPU order to big-endian.
 
static uint16_t pbl_le16_to_cpu (uint16_t v)
 Convert a little-endian 16-bit value to CPU order.
 
static uint16_t pbl_cpu_to_le16 (uint16_t v)
 Convert a 16-bit value in CPU order to little-endian.
 
static uint32_t pbl_le32_to_cpu (uint32_t v)
 Convert a little-endian 32-bit value to CPU order.
 
static uint32_t pbl_cpu_to_le32 (uint32_t v)
 Convert a 32-bit value in CPU order to little-endian.
 
static uint64_t pbl_le64_to_cpu (uint64_t v)
 Convert a little-endian 64-bit value to CPU order.
 
static uint64_t pbl_cpu_to_le64 (uint64_t v)
 Convert a 64-bit value in CPU order to little-endian.
 
static uint16_t pbl_be16_get (pbl_be16_t be)
 Read a wrapped big-endian 16-bit value.
 
static pbl_be16_t pbl_be16_make (uint16_t v)
 Wrap a 16-bit value as big-endian.
 
static uint16_t pbl_get_le16 (const void *src)
 Read a little-endian 16-bit value from a possibly unaligned buffer.
 
static void pbl_put_le16 (uint16_t val, void *dst)
 Write a 16-bit value as little-endian to a possibly unaligned buffer.
 
static uint16_t pbl_get_be16 (const void *src)
 Read a big-endian 16-bit value from a possibly unaligned buffer.
 
static void pbl_put_be16 (uint16_t val, void *dst)
 Write a 16-bit value as big-endian to a possibly unaligned buffer.
 
static uint32_t pbl_get_le24 (const void *src)
 Read a little-endian 24-bit value from a possibly unaligned buffer.
 
static void pbl_put_le24 (uint32_t val, void *dst)
 Write a 24-bit value as little-endian to a possibly unaligned buffer.
 
static uint32_t pbl_get_be24 (const void *src)
 Read a big-endian 24-bit value from a possibly unaligned buffer.
 
static void pbl_put_be24 (uint32_t val, void *dst)
 Write a 24-bit value as big-endian to a possibly unaligned buffer.
 
static uint32_t pbl_get_le32 (const void *src)
 Read a little-endian 32-bit value from a possibly unaligned buffer.
 
static void pbl_put_le32 (uint32_t val, void *dst)
 Write a 32-bit value as little-endian to a possibly unaligned buffer.
 
static uint32_t pbl_get_be32 (const void *src)
 Read a big-endian 32-bit value from a possibly unaligned buffer.
 
static void pbl_put_be32 (uint32_t val, void *dst)
 Write a 32-bit value as big-endian to a possibly unaligned buffer.
 
static uint64_t pbl_get_le64 (const void *src)
 Read a little-endian 64-bit value from a possibly unaligned buffer.
 
static void pbl_put_le64 (uint64_t val, void *dst)
 Write a 64-bit value as little-endian to a possibly unaligned buffer.
 
static uint64_t pbl_get_be64 (const void *src)
 Read a big-endian 64-bit value from a possibly unaligned buffer.
 
static void pbl_put_be64 (uint64_t val, void *dst)
 Write a 64-bit value as big-endian to a possibly unaligned buffer.
 

Detailed Description

Conversions between the CPU byte order (always little-endian) and fixed byte orders.

struct PBL_PACKED hdr {
pbl_be16_t length;
} hdr;
hdr.length = pbl_be16_make(payload_len);
uint16_t len = pbl_be16_get(hdr.length);
uint32_t addr = pbl_get_le32(&buf[1]);
pbl_put_be16(reg, cmd);
#define PBL_PACKED
Lay out the struct/union without padding.
Definition compiler.h:80
Big-endian 16-bit value, wrapped so it cannot be used without conversion.
Definition byteorder.h:33
static uint16_t pbl_be16_get(pbl_be16_t be)
Read a wrapped big-endian 16-bit value.
Definition byteorder.h:164
static pbl_be16_t pbl_be16_make(uint16_t v)
Wrap a 16-bit value as big-endian.
Definition byteorder.h:174
static void pbl_put_be16(uint16_t val, void *dst)
Write a 16-bit value as big-endian to a possibly unaligned buffer.
Definition byteorder.h:224
static uint32_t pbl_get_le32(const void *src)
Read a little-endian 32-bit value from a possibly unaligned buffer.
Definition byteorder.h:288

Data Structure Documentation

◆ pbl_be16_t

struct pbl_be16_t

Big-endian 16-bit value, wrapped so it cannot be used without conversion.

Data Fields
uint16_t v Raw big-endian value.

Function Documentation

◆ pbl_be16_get()

static uint16_t pbl_be16_get ( pbl_be16_t  be)
inlinestatic

Read a wrapped big-endian 16-bit value.

Parameters
beBig-endian value.
Returns
Value in CPU order.

References pbl_be16_to_cpu(), and pbl_be16_t::v.

◆ pbl_be16_make()

static pbl_be16_t pbl_be16_make ( uint16_t  v)
inlinestatic

Wrap a 16-bit value as big-endian.

Parameters
vValue in CPU order.
Returns
Big-endian value.

References pbl_cpu_to_be16().

◆ pbl_be16_to_cpu()

static uint16_t pbl_be16_to_cpu ( uint16_t  v)
inlinestatic

Convert a big-endian 16-bit value to CPU order.

Parameters
vBig-endian value.
Returns
Value in CPU order.

References PBL_BSWAP16.

Referenced by pbl_be16_get(), and pbl_get_be16().

◆ pbl_be32_to_cpu()

static uint32_t pbl_be32_to_cpu ( uint32_t  v)
inlinestatic

Convert a big-endian 32-bit value to CPU order.

Parameters
vBig-endian value.
Returns
Value in CPU order.

References PBL_BSWAP32.

Referenced by pbl_get_be32().

◆ pbl_be64_to_cpu()

static uint64_t pbl_be64_to_cpu ( uint64_t  v)
inlinestatic

Convert a big-endian 64-bit value to CPU order.

Parameters
vBig-endian value.
Returns
Value in CPU order.

References PBL_BSWAP64.

Referenced by pbl_get_be64().

◆ pbl_cpu_to_be16()

static uint16_t pbl_cpu_to_be16 ( uint16_t  v)
inlinestatic

Convert a 16-bit value in CPU order to big-endian.

Parameters
vValue in CPU order.
Returns
Big-endian value.

References PBL_BSWAP16.

Referenced by pbl_be16_make(), and pbl_put_be16().

◆ pbl_cpu_to_be32()

static uint32_t pbl_cpu_to_be32 ( uint32_t  v)
inlinestatic

Convert a 32-bit value in CPU order to big-endian.

Parameters
vValue in CPU order.
Returns
Big-endian value.

References PBL_BSWAP32.

Referenced by pbl_put_be32().

◆ pbl_cpu_to_be64()

static uint64_t pbl_cpu_to_be64 ( uint64_t  v)
inlinestatic

Convert a 64-bit value in CPU order to big-endian.

Parameters
vValue in CPU order.
Returns
Big-endian value.

References PBL_BSWAP64.

Referenced by pbl_put_be64().

◆ pbl_cpu_to_le16()

static uint16_t pbl_cpu_to_le16 ( uint16_t  v)
inlinestatic

Convert a 16-bit value in CPU order to little-endian.

Parameters
vValue in CPU order.
Returns
Little-endian value.

Referenced by pbl_put_le16().

◆ pbl_cpu_to_le32()

static uint32_t pbl_cpu_to_le32 ( uint32_t  v)
inlinestatic

Convert a 32-bit value in CPU order to little-endian.

Parameters
vValue in CPU order.
Returns
Little-endian value.

Referenced by pbl_put_le32().

◆ pbl_cpu_to_le64()

static uint64_t pbl_cpu_to_le64 ( uint64_t  v)
inlinestatic

Convert a 64-bit value in CPU order to little-endian.

Parameters
vValue in CPU order.
Returns
Little-endian value.

Referenced by pbl_put_le64().

◆ pbl_get_be16()

static uint16_t pbl_get_be16 ( const void *  src)
inlinestatic

Read a big-endian 16-bit value from a possibly unaligned buffer.

Parameters
srcBuffer holding 2 bytes.
Returns
Value in CPU order.

References pbl_be16_to_cpu().

◆ pbl_get_be24()

static uint32_t pbl_get_be24 ( const void *  src)
inlinestatic

Read a big-endian 24-bit value from a possibly unaligned buffer.

Parameters
srcBuffer holding 3 bytes.
Returns
Value in CPU order.

◆ pbl_get_be32()

static uint32_t pbl_get_be32 ( const void *  src)
inlinestatic

Read a big-endian 32-bit value from a possibly unaligned buffer.

Parameters
srcBuffer holding 4 bytes.
Returns
Value in CPU order.

References pbl_be32_to_cpu().

◆ pbl_get_be64()

static uint64_t pbl_get_be64 ( const void *  src)
inlinestatic

Read a big-endian 64-bit value from a possibly unaligned buffer.

Parameters
srcBuffer holding 8 bytes.
Returns
Value in CPU order.

References pbl_be64_to_cpu().

◆ pbl_get_le16()

static uint16_t pbl_get_le16 ( const void *  src)
inlinestatic

Read a little-endian 16-bit value from a possibly unaligned buffer.

Parameters
srcBuffer holding 2 bytes.
Returns
Value in CPU order.

References pbl_le16_to_cpu().

◆ pbl_get_le24()

static uint32_t pbl_get_le24 ( const void *  src)
inlinestatic

Read a little-endian 24-bit value from a possibly unaligned buffer.

Parameters
srcBuffer holding 3 bytes.
Returns
Value in CPU order.

◆ pbl_get_le32()

static uint32_t pbl_get_le32 ( const void *  src)
inlinestatic

Read a little-endian 32-bit value from a possibly unaligned buffer.

Parameters
srcBuffer holding 4 bytes.
Returns
Value in CPU order.

References pbl_le32_to_cpu().

◆ pbl_get_le64()

static uint64_t pbl_get_le64 ( const void *  src)
inlinestatic

Read a little-endian 64-bit value from a possibly unaligned buffer.

Parameters
srcBuffer holding 8 bytes.
Returns
Value in CPU order.

References pbl_le64_to_cpu().

◆ pbl_le16_to_cpu()

static uint16_t pbl_le16_to_cpu ( uint16_t  v)
inlinestatic

Convert a little-endian 16-bit value to CPU order.

Parameters
vLittle-endian value.
Returns
Value in CPU order.

Referenced by pbl_get_le16().

◆ pbl_le32_to_cpu()

static uint32_t pbl_le32_to_cpu ( uint32_t  v)
inlinestatic

Convert a little-endian 32-bit value to CPU order.

Parameters
vLittle-endian value.
Returns
Value in CPU order.

Referenced by pbl_get_le32().

◆ pbl_le64_to_cpu()

static uint64_t pbl_le64_to_cpu ( uint64_t  v)
inlinestatic

Convert a little-endian 64-bit value to CPU order.

Parameters
vLittle-endian value.
Returns
Value in CPU order.

Referenced by pbl_get_le64().

◆ pbl_put_be16()

static void pbl_put_be16 ( uint16_t  val,
void *  dst 
)
inlinestatic

Write a 16-bit value as big-endian to a possibly unaligned buffer.

Parameters
valValue in CPU order.
dstBuffer receiving 2 bytes.

References pbl_cpu_to_be16().

◆ pbl_put_be24()

static void pbl_put_be24 ( uint32_t  val,
void *  dst 
)
inlinestatic

Write a 24-bit value as big-endian to a possibly unaligned buffer.

Parameters
valValue in CPU order.
dstBuffer receiving 3 bytes.

◆ pbl_put_be32()

static void pbl_put_be32 ( uint32_t  val,
void *  dst 
)
inlinestatic

Write a 32-bit value as big-endian to a possibly unaligned buffer.

Parameters
valValue in CPU order.
dstBuffer receiving 4 bytes.

References pbl_cpu_to_be32().

◆ pbl_put_be64()

static void pbl_put_be64 ( uint64_t  val,
void *  dst 
)
inlinestatic

Write a 64-bit value as big-endian to a possibly unaligned buffer.

Parameters
valValue in CPU order.
dstBuffer receiving 8 bytes.

References pbl_cpu_to_be64().

◆ pbl_put_le16()

static void pbl_put_le16 ( uint16_t  val,
void *  dst 
)
inlinestatic

Write a 16-bit value as little-endian to a possibly unaligned buffer.

Parameters
valValue in CPU order.
dstBuffer receiving 2 bytes.

References pbl_cpu_to_le16().

◆ pbl_put_le24()

static void pbl_put_le24 ( uint32_t  val,
void *  dst 
)
inlinestatic

Write a 24-bit value as little-endian to a possibly unaligned buffer.

Parameters
valValue in CPU order.
dstBuffer receiving 3 bytes.

◆ pbl_put_le32()

static void pbl_put_le32 ( uint32_t  val,
void *  dst 
)
inlinestatic

Write a 32-bit value as little-endian to a possibly unaligned buffer.

Parameters
valValue in CPU order.
dstBuffer receiving 4 bytes.

References pbl_cpu_to_le32().

◆ pbl_put_le64()

static void pbl_put_le64 ( uint64_t  val,
void *  dst 
)
inlinestatic

Write a 64-bit value as little-endian to a possibly unaligned buffer.

Parameters
valValue in CPU order.
dstBuffer receiving 8 bytes.

References pbl_cpu_to_le64().