types.h File Reference

#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
#include <limits.h>
#include <stdalign.h>
#include <zrtos/cast.h>

Include dependency graph for types.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	ZRTOS_TYPES__BYTE_ALIGNMENT   (__alignof__(max_align_t))
#define	ZRTOS_TYPES__BYTE_ALIGNMENT_MASK   (__alignof__(max_align_t)-1)
#define	zrtos_types__get_offset_of(type, member)   __builtin_offsetof(type,member)
#define	zrtos_types__get_container_of(ptr, type, member)
#define	zrtos_types__get_container_of_ex(ptr, type, member)   ((ptr) ? zrtos_types__get_container_of(ptr, type, member) : 0) \
#define	ZRTOS_TYPES__MIN(a, b)   ((a)<(b)?(a):(b))
#define	ZRTOS_TYPES__MAX(a, b)   ((a)>(b)?(a):(b))
#define	ZRTOS_TYPES__CMP(type, a_len, b_len)   ((a_len) < (b_len) ? - 1 : ((a_len) > (b_len) ? 1 : 0))
#define	ZRTOS_TYPES__TYPEOF(a)   typeof(a)
#define	ZRTOS_TYPES__SWAP(a, b)
#define	ZRTOS_TYPES__SWAP_PTR_CONTENTS(a, b)
#define	ZRTOS_TYPES__IS_ADD_OVERFLOW(a, b)   (((a + b ) < a))
#define	ZRTOS_TYPES__GET_STATIC_ARRAY_LENGTH(arr)   (sizeof(arr)/sizeof((arr)[0]))
#define	ZRTOS_TYPES__SIZE_MIN   (0)
#define	ZRTOS_TYPES__SIZE_MAX   SIZE_MAX
#define	ZRTOS_TYPES__INT8_MIN   INT8_MIN
#define	ZRTOS_TYPES__INT8_MAX   INT8_MAX
#define	ZRTOS_TYPES__INT16_MIN   INT16_MIN
#define	ZRTOS_TYPES__INT16_MAX   INT16_MAX
#define	ZRTOS_TYPES__INT32_MIN   INT32_MIN
#define	ZRTOS_TYPES__INT32_MAX   INT32_MAX
#define	ZRTOS_TYPES__INT64_MIN   INT64_MIN
#define	ZRTOS_TYPES__INT64_MAX   INT64_MAX
#define	ZRTOS_TYPES__UINT8_MIN   (0)
#define	ZRTOS_TYPES__UINT8_MAX   UINT8_MAX
#define	ZRTOS_TYPES__UINT16_MIN   (0)
#define	ZRTOS_TYPES__UINT16_MAX   UINT16_MAX
#define	ZRTOS_TYPES__UINT32_MIN   (0)
#define	ZRTOS_TYPES__UINT32_MAX   UINT32_MAX
#define	ZRTOS_TYPES__UINT64_MIN   (0)
#define	ZRTOS_TYPES__UINT64_MAX   UINT64_MAX
#define	ZRTOS_TYPES__MAP(value, in_min, in_max, out_min, out_max)   (((value)-(in_min))*((out_max)-(out_min))/((in_max)-(in_min))+(out_min))
#define	zrtos_types__htobe16(x)   zrtos_types__uint16_bswap(x)
#define	zrtos_types__htole16(x)   (x)
#define	zrtos_types__be16toh(x)   zrtos_types__uint16_bswap(x)
#define	zrtos_types__le16toh(x)   (x)
#define	zrtos_types__htobe32(x)   zrtos_types__uint32_bswap(x)
#define	zrtos_types__htole32(x)   (x)
#define	zrtos_types__be32toh(x)   zrtos_types__uint32_bswap(x)
#define	zrtos_types__le32toh(x)   (x)
#define	zrtos_types__htobe64(x)   zrtos_types__uint64_bswap(x)
#define	zrtos_types__htole64(x)   (x)
#define	zrtos_types__be64toh(x)   zrtos_types__uint64_bswap(x)
#define	zrtos_types__le64toh(x)   (x)

Typedefs
typedef uint16_t	size_t
typedef int16_t	ssize_t

Functions
int	zrtos_types__ptr_cmp (void *a, void *b)
void *	zrtos_types__ptr_add (void *ptr, size_t byte_len)
void *	zrtos_types__ptr_subtract (void *ptr, size_t byte_len)
size_t	zrtos_types__ptr_get_byte_distance (void *bigger, void *smaller)
void *	zrtos_types__ptr_to_alignment (void *ptr)
size_t	zrtos_types__ceil_size_to_alignment (size_t len)
bool	zrtos_types__uint32_is_valid_address_range (uint32_t first_address, uint32_t last_address, uint32_t offset, size_t *length)
bool	zrtos_types__ptr_is_valid_address_range (void *first_address, void *last_address, size_t offset, size_t *length)
bool	zrtos_types__uint64_is_valid_address_range (uint64_t first_address, uint64_t last_address, uint64_t offset, size_t *length)
size_t	zrtos_types__uint8_to_hex (uint8_t *dest, uint8_t src)
uint16_t	zrtos_types__uint16_bswap (uint16_t x)
uint32_t	zrtos_types__uint32_bswap (uint32_t x)
uint64_t	zrtos_types__uint64_bswap (uint64_t x)
bool	zrtos_types__is_digit (char c)
bool	zrtos_types__is_whitespace (char c)
bool	zrtos_types__is_newline (char c)

Macro Definition Documentation

zrtos_types__be16toh

#define zrtos_types__be16toh

(

x

)

zrtos_types__uint16_bswap(x)

Definition at line 235 of file types.h.

zrtos_types__be32toh

#define zrtos_types__be32toh

(

x

)

zrtos_types__uint32_bswap(x)

Definition at line 240 of file types.h.

zrtos_types__be64toh

#define zrtos_types__be64toh

(

x

)

zrtos_types__uint64_bswap(x)

Definition at line 245 of file types.h.

ZRTOS_TYPES__BYTE_ALIGNMENT

#define ZRTOS_TYPES__BYTE_ALIGNMENT   (__alignof__(max_align_t))

Definition at line 47 of file types.h.

ZRTOS_TYPES__BYTE_ALIGNMENT_MASK

#define ZRTOS_TYPES__BYTE_ALIGNMENT_MASK   (__alignof__(max_align_t)-1)

Definition at line 48 of file types.h.

ZRTOS_TYPES__CMP

#define ZRTOS_TYPES__CMP	(		type,
			a_len,
			b_len
	)		((a_len) < (b_len) ? - 1 : ((a_len) > (b_len) ? 1 : 0))

Definition at line 80 of file types.h.

zrtos_types__get_container_of

#define zrtos_types__get_container_of	(		ptr,
			type,
			member
	)

Value:

({                                                                      \
        typeof( ((type *)0)->member ) *mptr__ = (typeof( ((type *)0)->member ) *)(ptr);         \
        (type *)((char *)mptr__ - zrtos_types__get_offset_of(type,member)); \
    })

Definition at line 69 of file types.h.

zrtos_types__get_container_of_ex

#define zrtos_types__get_container_of_ex	(		ptr,
			type,
			member
	)		((ptr) ? zrtos_types__get_container_of(ptr, type, member) : 0) \

Definition at line 75 of file types.h.

zrtos_types__get_offset_of

#define zrtos_types__get_offset_of	(		type,
			member
	)		__builtin_offsetof(type,member)

Definition at line 66 of file types.h.

ZRTOS_TYPES__GET_STATIC_ARRAY_LENGTH

#define ZRTOS_TYPES__GET_STATIC_ARRAY_LENGTH

(

arr

)

(sizeof(arr)/sizeof((arr)[0]))

Definition at line 166 of file types.h.

zrtos_types__htobe16

#define zrtos_types__htobe16

(

x

)

zrtos_types__uint16_bswap(x)

Definition at line 233 of file types.h.

zrtos_types__htobe32

#define zrtos_types__htobe32

(

x

)

zrtos_types__uint32_bswap(x)

Definition at line 238 of file types.h.

zrtos_types__htobe64

#define zrtos_types__htobe64

(

x

)

zrtos_types__uint64_bswap(x)

Definition at line 243 of file types.h.

zrtos_types__htole16

#define zrtos_types__htole16

(

x

)

(x)

Definition at line 234 of file types.h.

zrtos_types__htole32

#define zrtos_types__htole32

(

x

)

(x)

Definition at line 239 of file types.h.

zrtos_types__htole64

#define zrtos_types__htole64

(

x

)

(x)

Definition at line 244 of file types.h.

ZRTOS_TYPES__INT16_MAX

#define ZRTOS_TYPES__INT16_MAX   INT16_MAX

Definition at line 175 of file types.h.

ZRTOS_TYPES__INT16_MIN

#define ZRTOS_TYPES__INT16_MIN   INT16_MIN

Definition at line 174 of file types.h.

ZRTOS_TYPES__INT32_MAX

#define ZRTOS_TYPES__INT32_MAX   INT32_MAX

Definition at line 177 of file types.h.

ZRTOS_TYPES__INT32_MIN

#define ZRTOS_TYPES__INT32_MIN   INT32_MIN

Definition at line 176 of file types.h.

ZRTOS_TYPES__INT64_MAX

#define ZRTOS_TYPES__INT64_MAX   INT64_MAX

Definition at line 179 of file types.h.

ZRTOS_TYPES__INT64_MIN

#define ZRTOS_TYPES__INT64_MIN   INT64_MIN

Definition at line 178 of file types.h.

ZRTOS_TYPES__INT8_MAX

#define ZRTOS_TYPES__INT8_MAX   INT8_MAX

Definition at line 173 of file types.h.

ZRTOS_TYPES__INT8_MIN

#define ZRTOS_TYPES__INT8_MIN   INT8_MIN

Definition at line 172 of file types.h.

ZRTOS_TYPES__IS_ADD_OVERFLOW

#define ZRTOS_TYPES__IS_ADD_OVERFLOW	(		a,
			b
	)		(((a + b ) < a))

Definition at line 163 of file types.h.

zrtos_types__le16toh

#define zrtos_types__le16toh

(

x

)

(x)

Definition at line 236 of file types.h.

zrtos_types__le32toh

#define zrtos_types__le32toh

(

x

)

(x)

Definition at line 241 of file types.h.

zrtos_types__le64toh

#define zrtos_types__le64toh

(

x

)

(x)

Definition at line 246 of file types.h.

ZRTOS_TYPES__MAP

#define ZRTOS_TYPES__MAP	(		value,
			in_min,
			in_max,
			out_min,
			out_max
	)		(((value)-(in_min))*((out_max)-(out_min))/((in_max)-(in_min))+(out_min))

Definition at line 207 of file types.h.

ZRTOS_TYPES__MAX

#define ZRTOS_TYPES__MAX	(		a,
			b
	)		((a)>(b)?(a):(b))

Definition at line 79 of file types.h.

ZRTOS_TYPES__MIN

#define ZRTOS_TYPES__MIN	(		a,
			b
	)		((a)<(b)?(a):(b))

Definition at line 78 of file types.h.

ZRTOS_TYPES__SIZE_MAX

#define ZRTOS_TYPES__SIZE_MAX   SIZE_MAX

Definition at line 170 of file types.h.

ZRTOS_TYPES__SIZE_MIN

#define ZRTOS_TYPES__SIZE_MIN   (0)

Definition at line 169 of file types.h.

ZRTOS_TYPES__SWAP

#define ZRTOS_TYPES__SWAP	(		a,
			b
	)

Value:

do{                                           \
        ZRTOS_TYPES__TYPEOF(a) a____ = (a);       \
        (a) = (b);                                \
        (b) = a____;                              \
    }while(0);

Definition at line 149 of file types.h.

ZRTOS_TYPES__SWAP_PTR_CONTENTS

#define ZRTOS_TYPES__SWAP_PTR_CONTENTS	(		a,
			b
	)

Value:

do{                                       \
        ZRTOS_TYPES__TYPEOF(*a) a____ = *(a); \
        *(a) = *(b);                          \
        *(b) = a____;                         \
    }while(0);

Definition at line 156 of file types.h.

ZRTOS_TYPES__TYPEOF

#define ZRTOS_TYPES__TYPEOF

(

a

)

typeof(a)

Definition at line 146 of file types.h.

ZRTOS_TYPES__UINT16_MAX

#define ZRTOS_TYPES__UINT16_MAX   UINT16_MAX

Definition at line 184 of file types.h.

ZRTOS_TYPES__UINT16_MIN

#define ZRTOS_TYPES__UINT16_MIN   (0)

Definition at line 183 of file types.h.

ZRTOS_TYPES__UINT32_MAX

#define ZRTOS_TYPES__UINT32_MAX   UINT32_MAX

Definition at line 186 of file types.h.

ZRTOS_TYPES__UINT32_MIN

#define ZRTOS_TYPES__UINT32_MIN   (0)

Definition at line 185 of file types.h.

ZRTOS_TYPES__UINT64_MAX

#define ZRTOS_TYPES__UINT64_MAX   UINT64_MAX

Definition at line 188 of file types.h.

ZRTOS_TYPES__UINT64_MIN

#define ZRTOS_TYPES__UINT64_MIN   (0)

Definition at line 187 of file types.h.

ZRTOS_TYPES__UINT8_MAX

#define ZRTOS_TYPES__UINT8_MAX   UINT8_MAX

Definition at line 182 of file types.h.

ZRTOS_TYPES__UINT8_MIN

#define ZRTOS_TYPES__UINT8_MIN   (0)

Definition at line 181 of file types.h.

Typedef Documentation

size_t

typedef uint16_t size_t

Definition at line 22 of file types.h.

ssize_t

typedef int16_t ssize_t

Definition at line 23 of file types.h.

Function Documentation

zrtos_types__ceil_size_to_alignment()

size_t zrtos_types__ceil_size_to_alignment

(

size_t

len

)

Definition at line 59 of file types.h.

                                                      {
    return len
         + ZRTOS_TYPES__BYTE_ALIGNMENT
         - (len & ZRTOS_TYPES__BYTE_ALIGNMENT_MASK)
    ;
}

Here is the caller graph for this function:

zrtos_types__is_digit()

bool zrtos_types__is_digit

(

char

c

)

Definition at line 264 of file types.h.

                                  {
    return c >= '0' && c <= '9';
}

Here is the caller graph for this function:

zrtos_types__is_newline()

bool zrtos_types__is_newline

(

char

c

)

Definition at line 272 of file types.h.

                                    {
    return c == '\r' || c == '\n';
}

zrtos_types__is_whitespace()

bool zrtos_types__is_whitespace

(

char

c

)

Definition at line 268 of file types.h.

                                       {
    return c == ' ' || c == '\t';
}

zrtos_types__ptr_add()

void* zrtos_types__ptr_add	(	void *	ptr,
		size_t	byte_len
	)

Definition at line 35 of file types.h.

                                                     {
    return ((uint8_t*)ptr)+byte_len;
}

Here is the caller graph for this function:

zrtos_types__ptr_cmp()

int zrtos_types__ptr_cmp	(	void *	a,
		void *	b
	)

Definition at line 31 of file types.h.

                                         {
    return ((ptrdiff_t)a)-((ptrdiff_t)b);
}

Here is the caller graph for this function:

zrtos_types__ptr_get_byte_distance()

size_t zrtos_types__ptr_get_byte_distance	(	void *	bigger,
		void *	smaller
	)

Definition at line 43 of file types.h.

                                                                     {
    return ((uint8_t*)bigger)-((uint8_t*)smaller);
}

Here is the caller graph for this function:

zrtos_types__ptr_is_valid_address_range()

bool zrtos_types__ptr_is_valid_address_range	(	void *	first_address,
		void *	last_address,
		size_t	offset,
		size_t *	length
	)

Definition at line 100 of file types.h.

 {
    if(offset <= zrtos_types__ptr_get_byte_distance(
         last_address
        ,first_address
    )){
        *length = ZRTOS_TYPES__MIN(
             *length
            ,zrtos_types__ptr_get_byte_distance(
                 last_address
                ,zrtos_types__ptr_subtract(
                     last_address
                    ,offset
                )
            )
        );
        return true;
    }
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

zrtos_types__ptr_subtract()

void* zrtos_types__ptr_subtract	(	void *	ptr,
		size_t	byte_len
	)

Definition at line 39 of file types.h.

                                                          {
    return ((uint8_t*)ptr)-byte_len;
}

Here is the caller graph for this function:

zrtos_types__ptr_to_alignment()

void* zrtos_types__ptr_to_alignment

(

void *

ptr

)

Definition at line 50 of file types.h.

                                              {
    uintptr_t ret = (uintptr_t)ptr;
    ret = ret
        + ZRTOS_TYPES__BYTE_ALIGNMENT
        - (ret & ZRTOS_TYPES__BYTE_ALIGNMENT_MASK)
    ;
    return (void*)ret;
}

zrtos_types__uint16_bswap()

uint16_t zrtos_types__uint16_bswap

(

uint16_t

x

)

Definition at line 210 of file types.h.

                                              {
    return ((__uint16_t) ((((x) >> 8) & 0xff) | (((x) & 0xff) << 8)));
}

zrtos_types__uint32_bswap()

uint32_t zrtos_types__uint32_bswap

(

uint32_t

x

)

Definition at line 214 of file types.h.

                                              {
    return ((((x) & 0xff000000u) >> 24) | (((x) & 0x00ff0000u) >> 8)
   | (((x) & 0x0000ff00u) << 8) | (((x) & 0x000000ffu) << 24));
}

zrtos_types__uint32_is_valid_address_range()

bool zrtos_types__uint32_is_valid_address_range	(	uint32_t	first_address,
		uint32_t	last_address,
		uint32_t	offset,
		size_t *	length
	)

Definition at line 83 of file types.h.

 {
    if(offset >= first_address
    && offset <= last_address){
        *length = ZRTOS_TYPES__MIN(
             *length
            ,last_address - offset
        );
        return true;
    }
    return false;
}

Here is the caller graph for this function:

zrtos_types__uint64_bswap()

uint64_t zrtos_types__uint64_bswap

(

uint64_t

x

)

Definition at line 219 of file types.h.

                                              {
    return 
  ((((x) & 0xff00000000000000ull) >> 56)
   | (((x) & 0x00ff000000000000ull) >> 40)
   | (((x) & 0x0000ff0000000000ull) >> 24)
   | (((x) & 0x000000ff00000000ull) >> 8)
   | (((x) & 0x00000000ff000000ull) << 8)
   | (((x) & 0x0000000000ff0000ull) << 24)
   | (((x) & 0x000000000000ff00ull) << 40)
   | (((x) & 0x00000000000000ffull) << 56))
   ;
}

zrtos_types__uint64_is_valid_address_range()

bool zrtos_types__uint64_is_valid_address_range	(	uint64_t	first_address,
		uint64_t	last_address,
		uint64_t	offset,
		size_t *	length
	)

Definition at line 125 of file types.h.

 {
    if(offset >= first_address
    && offset <= last_address){
        *length = ZRTOS_TYPES__MIN(
             *length
            ,last_address - offset
        );
        return true;
    }
    return false;
}

zrtos_types__uint8_to_hex()

size_t zrtos_types__uint8_to_hex	(	uint8_t *	dest,
		uint8_t	src
	)

Definition at line 190 of file types.h.

                                                           {
    uint8_t h = (src & 0xF) + '0';
    uint8_t l = (src >> 4) + '0';

    if(h > '9'){
        h += 'A' - '9';
    }
    if(l > '9'){
        l += 'A' - '9';
    }

    dest[0] = h;
    dest[1] = l;

    return 2;
}