os/ossrv/genericopenlibs/openenvcore/include/sys/endian.dosc
author sl
Tue, 10 Jun 2014 14:32:02 +0200
changeset 1 260cb5ec6c19
permissions -rw-r--r--
Update contrib.
sl@0
     1
/** @file   ../include/sys/endian.h
sl@0
     2
@internalComponent	   
sl@0
     3
*/
sl@0
     4
 
sl@0
     5
/** @fn be16dec(const void *pp)
sl@0
     6
sl@0
     7
Alignment-agnostic encode or decode bytestream to or from little or big endian.
sl@0
     8
sl@0
     9
@publishedAll
sl@0
    10
@released
sl@0
    11
*/
sl@0
    12
sl@0
    13
sl@0
    14
/** @fn be32dec(const void *pp)
sl@0
    15
sl@0
    16
Alignment-agnostic encode or decode bytestream to or from little or big endian.
sl@0
    17
sl@0
    18
@publishedAll
sl@0
    19
@released
sl@0
    20
*/
sl@0
    21
sl@0
    22
/** @fn be64dec(const void *pp)
sl@0
    23
sl@0
    24
Alignment-agnostic encode or decode bytestream to or from little or big endian.
sl@0
    25
sl@0
    26
@publishedAll
sl@0
    27
@released
sl@0
    28
*/
sl@0
    29
sl@0
    30
sl@0
    31
/** @fn le16dec(const void *pp)
sl@0
    32
sl@0
    33
Alignment-agnostic encode or decode bytestream to or from little or big endian.
sl@0
    34
sl@0
    35
@publishedAll
sl@0
    36
@released
sl@0
    37
*/
sl@0
    38
sl@0
    39
sl@0
    40
/** @fn le32dec(const void *pp)
sl@0
    41
sl@0
    42
Alignment-agnostic encode or decode bytestream to or from little or big endian.
sl@0
    43
sl@0
    44
@publishedAll
sl@0
    45
@released
sl@0
    46
*/
sl@0
    47
sl@0
    48
sl@0
    49
/** @fn le64dec(const void *pp)
sl@0
    50
sl@0
    51
Alignment-agnostic encode or decode bytestream to or from little or big endian.
sl@0
    52
sl@0
    53
@publishedAll
sl@0
    54
@released
sl@0
    55
*/
sl@0
    56
sl@0
    57
sl@0
    58
/** @fn be16enc(void *pp, uint16_t u)
sl@0
    59
sl@0
    60
Alignment-agnostic encode or decode bytestream to or from little or big endian.
sl@0
    61
sl@0
    62
@publishedAll
sl@0
    63
@released
sl@0
    64
*/
sl@0
    65
sl@0
    66
/** @fn be32enc(void *pp, uint32_t u)
sl@0
    67
sl@0
    68
Alignment-agnostic encode or decode bytestream to or from little or big endian.
sl@0
    69
sl@0
    70
@publishedAll
sl@0
    71
@released
sl@0
    72
*/
sl@0
    73
sl@0
    74
sl@0
    75
/** @fn be64enc(void *pp, uint64_t u)
sl@0
    76
sl@0
    77
Alignment-agnostic encode or decode bytestream to or from little or big endian.
sl@0
    78
sl@0
    79
@publishedAll
sl@0
    80
@released
sl@0
    81
*/
sl@0
    82
sl@0
    83
/** @fn le16enc(void *pp, uint16_t u)
sl@0
    84
sl@0
    85
Alignment-agnostic encode or decode bytestream to or from little or big endian.
sl@0
    86
sl@0
    87
@publishedAll
sl@0
    88
@released
sl@0
    89
*/
sl@0
    90
sl@0
    91
/** @fn le32enc(void *pp, uint32_t u)
sl@0
    92
sl@0
    93
Alignment-agnostic encode or decode bytestream to or from little or big endian.
sl@0
    94
sl@0
    95
@publishedAll
sl@0
    96
@released
sl@0
    97
*/
sl@0
    98
sl@0
    99
/** @fn le64enc(void *pp, uint64_t u)
sl@0
   100
sl@0
   101
Alignment-agnostic encode or decode bytestream to or from little or big endian.
sl@0
   102
sl@0
   103
@publishedAll
sl@0
   104
@released
sl@0
   105
*/
sl@0
   106
sl@0
   107
sl@0
   108
/** @def bswap16(x)
sl@0
   109
sl@0
   110
General byte order swapping functions.
sl@0
   111
sl@0
   112
@publishedAll
sl@0
   113
@externallyDefinedApi
sl@0
   114
*/
sl@0
   115
sl@0
   116
sl@0
   117
/** @def bswap32(x)
sl@0
   118
sl@0
   119
General byte order swapping functions.
sl@0
   120
sl@0
   121
@publishedAll
sl@0
   122
@externallyDefinedApi
sl@0
   123
*/
sl@0
   124
sl@0
   125
sl@0
   126
/**@def	bswap64(x)
sl@0
   127
sl@0
   128
General byte order swapping functions.
sl@0
   129
sl@0
   130
@publishedAll
sl@0
   131
@externallyDefinedApi
sl@0
   132
*/
sl@0
   133
sl@0
   134
/** @def	htobe16(x)
sl@0
   135
sl@0
   136
Macro returning a integer in the system's native byte order converted to big endian byte order.  
sl@0
   137
The return value will be the same as the argument on big endian systems.
sl@0
   138
sl@0
   139
@publishedAll
sl@0
   140
@externallyDefinedApi
sl@0
   141
*/
sl@0
   142
sl@0
   143
sl@0
   144
/** @def	htobe32(x)
sl@0
   145
sl@0
   146
Macro returning a integer in the system's native byte order converted to big endian byte order.  
sl@0
   147
The return value will be the same as the argument on big endian systems.
sl@0
   148
sl@0
   149
@publishedAll
sl@0
   150
@externallyDefinedApi
sl@0
   151
*/
sl@0
   152
sl@0
   153
/** @def	htobe64(x)
sl@0
   154
sl@0
   155
Macro returning a integer in the system's native byte order converted to big endian byte order.  
sl@0
   156
The return value will be the same as the argument on big endian systems.
sl@0
   157
sl@0
   158
@publishedAll
sl@0
   159
@externallyDefinedApi
sl@0
   160
*/
sl@0
   161
sl@0
   162
sl@0
   163
/** @def	htole16(x)	
sl@0
   164
sl@0
   165
Macro returning a integer in the system's native byte order converted to big endian byte order.  
sl@0
   166
The return value will be the same as the argument on big endian systems.
sl@0
   167
sl@0
   168
@publishedAll
sl@0
   169
@externallyDefinedApi
sl@0
   170
*/
sl@0
   171
sl@0
   172
sl@0
   173
/** @def	htole32(x)	
sl@0
   174
sl@0
   175
Macro returning a integer in the system's native byte order converted to big endian byte order.  
sl@0
   176
The return value will be the same as the argument on big endian systems.
sl@0
   177
sl@0
   178
@publishedAll
sl@0
   179
@externallyDefinedApi
sl@0
   180
*/
sl@0
   181
sl@0
   182
/** @def	htole64(x)
sl@0
   183
sl@0
   184
Macro returning a integer in the system's native byte order converted to big endian byte order.  
sl@0
   185
The return value will be the same as the argument on big endian systems.
sl@0
   186
sl@0
   187
@publishedAll
sl@0
   188
@externallyDefinedApi
sl@0
   189
*/
sl@0
   190
sl@0
   191
/** @def	be16toh(x)
sl@0
   192
sl@0
   193
Macro returning a big endian byte ordered integer converted to the system's native byte order.	
sl@0
   194
The return value will be the same as the argument on big endian systems.
sl@0
   195
sl@0
   196
@publishedAll
sl@0
   197
@externallyDefinedApi
sl@0
   198
*/
sl@0
   199
sl@0
   200
/** @def	be32toh(x)
sl@0
   201
sl@0
   202
Macro returning a big endian byte ordered integer converted to the system's native byte order.	
sl@0
   203
The return value will be the same as the argument on big endian systems.
sl@0
   204
sl@0
   205
@publishedAll
sl@0
   206
@externallyDefinedApi
sl@0
   207
*/
sl@0
   208
sl@0
   209
/** @def	be64toh(x)
sl@0
   210
sl@0
   211
Macro returning a big endian byte ordered integer converted to the system's native byte order.	
sl@0
   212
The return value will be the same as the argument on big endian systems.
sl@0
   213
sl@0
   214
@publishedAll
sl@0
   215
@externallyDefinedApi
sl@0
   216
*/
sl@0
   217
sl@0
   218
/** @def	le16toh(x)
sl@0
   219
sl@0
   220
Macro returning a little endian byte ordered integer converted to the system's native byte order.	
sl@0
   221
The return value will be the same as the argument on little endian systems.
sl@0
   222
sl@0
   223
@publishedAll
sl@0
   224
@externallyDefinedApi
sl@0
   225
*/
sl@0
   226
sl@0
   227
/** @def	le32toh(x)
sl@0
   228
sl@0
   229
Macro returning a little endian byte ordered integer converted to the system's native byte order.	
sl@0
   230
The return value will be the same as the argument on little endian systems.
sl@0
   231
	
sl@0
   232
@publishedAll
sl@0
   233
@externallyDefinedApi
sl@0
   234
*/
sl@0
   235
sl@0
   236
/** @def	le64toh(x)
sl@0
   237
sl@0
   238
Macro returning a little endian byte ordered integer converted to the system's native byte order.	
sl@0
   239
The return value will be the same as the argument on little endian systems.
sl@0
   240
sl@0
   241
@publishedAll
sl@0
   242
@externallyDefinedApi
sl@0
   243
*/
sl@0
   244
sl@0
   245