1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
|
/*
* Copyright 2008-2012 Freescale Semiconductor Inc.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of Freescale Semiconductor nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
*
* ALTERNATIVELY, this software may be distributed under the terms of the
* GNU General Public License ("GPL") as published by the Free Software
* Foundation, either version 2 of that License or (at your option) any
* later version.
*
* THIS SOFTWARE IS PROVIDED BY Freescale Semiconductor ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL Freescale Semiconductor BE LIABLE FOR ANY
* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
/**************************************************************************//**
@File endian_ext.h
@Description Big/little endian swapping routines.
*//***************************************************************************/
#ifndef __ENDIAN_EXT_H
#define __ENDIAN_EXT_H
#include "std_ext.h"
/**************************************************************************//**
@Group gen_id General Drivers Utilities
@Description General usage API. This API is intended for usage by both the
internal modules and the user's application.
@{
*//***************************************************************************/
/**************************************************************************//**
@Group endian_id Big/Little-Endian Conversion
@Description Routines and macros for Big/Little-Endian conversion and
general byte swapping.
All routines and macros are expecting unsigned values as
parameters, but will generate the correct result also for
signed values. Therefore, signed/unsigned casting is allowed.
@{
*//***************************************************************************/
/**************************************************************************//**
@Collection Byte-Swap Macros
Macros for swapping byte order.
@Cautions The parameters of these macros are evaluated multiple times.
For calculated expressions or expressions that contain function
calls it is recommended to use the byte-swap routines.
@{
*//***************************************************************************/
/**************************************************************************//**
@Description Swaps the byte order of a given 16-bit value.
@Param[in] val - The 16-bit value to swap.
@Return The byte-swapped value..
@Cautions The given value is evaluated multiple times by this macro.
For calculated expressions or expressions that contain function
calls it is recommended to use the SwapUint16() routine.
@hideinitializer
*//***************************************************************************/
#define SWAP_UINT16(val) \
((uint16_t)((((val) & 0x00FF) << 8) | (((val) & 0xFF00) >> 8)))
/**************************************************************************//**
@Description Swaps the byte order of a given 32-bit value.
@Param[in] val - The 32-bit value to swap.
@Return The byte-swapped value..
@Cautions The given value is evaluated multiple times by this macro.
For calculated expressions or expressions that contain function
calls it is recommended to use the SwapUint32() routine.
@hideinitializer
*//***************************************************************************/
#define SWAP_UINT32(val) \
((uint32_t)((((val) & 0x000000FF) << 24) | \
(((val) & 0x0000FF00) << 8) | \
(((val) & 0x00FF0000) >> 8) | \
(((val) & 0xFF000000) >> 24)))
/**************************************************************************//**
@Description Swaps the byte order of a given 64-bit value.
@Param[in] val - The 64-bit value to swap.
@Return The byte-swapped value..
@Cautions The given value is evaluated multiple times by this macro.
For calculated expressions or expressions that contain function
calls it is recommended to use the SwapUint64() routine.
@hideinitializer
*//***************************************************************************/
#define SWAP_UINT64(val) \
((uint64_t)((((val) & 0x00000000000000FFULL) << 56) | \
(((val) & 0x000000000000FF00ULL) << 40) | \
(((val) & 0x0000000000FF0000ULL) << 24) | \
(((val) & 0x00000000FF000000ULL) << 8) | \
(((val) & 0x000000FF00000000ULL) >> 8) | \
(((val) & 0x0000FF0000000000ULL) >> 24) | \
(((val) & 0x00FF000000000000ULL) >> 40) | \
(((val) & 0xFF00000000000000ULL) >> 56)))
/* @} */
/**************************************************************************//**
@Collection Byte-Swap Routines
Routines for swapping the byte order of a given parameter and
returning the swapped value.
These inline routines are safer than the byte-swap macros,
because they evaluate the parameter expression only once.
@{
*//***************************************************************************/
/**************************************************************************//**
@Function SwapUint16
@Description Returns the byte-swapped value of a given 16-bit value.
@Param[in] val - The 16-bit value.
@Return The byte-swapped value of the parameter.
*//***************************************************************************/
static __inline__ uint16_t SwapUint16(uint16_t val)
{
return (uint16_t)(((val & 0x00FF) << 8) |
((val & 0xFF00) >> 8));
}
/**************************************************************************//**
@Function SwapUint32
@Description Returns the byte-swapped value of a given 32-bit value.
@Param[in] val - The 32-bit value.
@Return The byte-swapped value of the parameter.
*//***************************************************************************/
static __inline__ uint32_t SwapUint32(uint32_t val)
{
return (uint32_t)(((val & 0x000000FF) << 24) |
((val & 0x0000FF00) << 8) |
((val & 0x00FF0000) >> 8) |
((val & 0xFF000000) >> 24));
}
/**************************************************************************//**
@Function SwapUint64
@Description Returns the byte-swapped value of a given 64-bit value.
@Param[in] val - The 64-bit value.
@Return The byte-swapped value of the parameter.
*//***************************************************************************/
static __inline__ uint64_t SwapUint64(uint64_t val)
{
return (uint64_t)(((val & 0x00000000000000FFULL) << 56) |
((val & 0x000000000000FF00ULL) << 40) |
((val & 0x0000000000FF0000ULL) << 24) |
((val & 0x00000000FF000000ULL) << 8) |
((val & 0x000000FF00000000ULL) >> 8) |
((val & 0x0000FF0000000000ULL) >> 24) |
((val & 0x00FF000000000000ULL) >> 40) |
((val & 0xFF00000000000000ULL) >> 56));
}
/* @} */
/**************************************************************************//**
@Collection In-place Byte-Swap-And-Set Routines
Routines for swapping the byte order of a given variable and
setting the swapped value back to the same variable.
@{
*//***************************************************************************/
/**************************************************************************//**
@Function SwapUint16P
@Description Swaps the byte order of a given 16-bit variable.
@Param[in] p_Val - Pointer to the 16-bit variable.
@Return None.
*//***************************************************************************/
static __inline__ void SwapUint16P(uint16_t *p_Val)
{
*p_Val = SwapUint16(*p_Val);
}
/**************************************************************************//**
@Function SwapUint32P
@Description Swaps the byte order of a given 32-bit variable.
@Param[in] p_Val - Pointer to the 32-bit variable.
@Return None.
*//***************************************************************************/
static __inline__ void SwapUint32P(uint32_t *p_Val)
{
*p_Val = SwapUint32(*p_Val);
}
/**************************************************************************//**
@Function SwapUint64P
@Description Swaps the byte order of a given 64-bit variable.
@Param[in] p_Val - Pointer to the 64-bit variable.
@Return None.
*//***************************************************************************/
static __inline__ void SwapUint64P(uint64_t *p_Val)
{
*p_Val = SwapUint64(*p_Val);
}
/* @} */
/**************************************************************************//**
@Collection Little-Endian Conversion Macros
These macros convert given parameters to or from Little-Endian
format. Use these macros when you want to read or write a specific
Little-Endian value in memory, without a-priori knowing the CPU
byte order.
These macros use the byte-swap routines. For conversion of
constants in initialization structures, you may use the CONST
versions of these macros (see below), which are using the
byte-swap macros instead.
@{
*//***************************************************************************/
/**************************************************************************//**
@Description Converts a given 16-bit value from CPU byte order to
Little-Endian byte order.
@Param[in] val - The 16-bit value to convert.
@Return The converted value.
@hideinitializer
*//***************************************************************************/
#define CPU_TO_LE16(val) SwapUint16(val)
/**************************************************************************//**
@Description Converts a given 32-bit value from CPU byte order to
Little-Endian byte order.
@Param[in] val - The 32-bit value to convert.
@Return The converted value.
@hideinitializer
*//***************************************************************************/
#define CPU_TO_LE32(val) SwapUint32(val)
/**************************************************************************//**
@Description Converts a given 64-bit value from CPU byte order to
Little-Endian byte order.
@Param[in] val - The 64-bit value to convert.
@Return The converted value.
@hideinitializer
*//***************************************************************************/
#define CPU_TO_LE64(val) SwapUint64(val)
/**************************************************************************//**
@Description Converts a given 16-bit value from Little-Endian byte order to
CPU byte order.
@Param[in] val - The 16-bit value to convert.
@Return The converted value.
@hideinitializer
*//***************************************************************************/
#define LE16_TO_CPU(val) CPU_TO_LE16(val)
/**************************************************************************//**
@Description Converts a given 32-bit value from Little-Endian byte order to
CPU byte order.
@Param[in] val - The 32-bit value to convert.
@Return The converted value.
@hideinitializer
*//***************************************************************************/
#define LE32_TO_CPU(val) CPU_TO_LE32(val)
/**************************************************************************//**
@Description Converts a given 64-bit value from Little-Endian byte order to
CPU byte order.
@Param[in] val - The 64-bit value to convert.
@Return The converted value.
@hideinitializer
*//***************************************************************************/
#define LE64_TO_CPU(val) CPU_TO_LE64(val)
/* @} */
/**************************************************************************//**
@Collection Little-Endian Constant Conversion Macros
These macros convert given constants to or from Little-Endian
format. Use these macros when you want to read or write a specific
Little-Endian constant in memory, without a-priori knowing the
CPU byte order.
These macros use the byte-swap macros, therefore can be used for
conversion of constants in initialization structures.
@Cautions The parameters of these macros are evaluated multiple times.
For non-constant expressions, use the non-CONST macro versions.
@{
*//***************************************************************************/
/**************************************************************************//**
@Description Converts a given 16-bit constant from CPU byte order to
Little-Endian byte order.
@Param[in] val - The 16-bit value to convert.
@Return The converted value.
@hideinitializer
*//***************************************************************************/
#define CONST_CPU_TO_LE16(val) SWAP_UINT16(val)
/**************************************************************************//**
@Description Converts a given 32-bit constant from CPU byte order to
Little-Endian byte order.
@Param[in] val - The 32-bit value to convert.
@Return The converted value.
@hideinitializer
*//***************************************************************************/
#define CONST_CPU_TO_LE32(val) SWAP_UINT32(val)
/**************************************************************************//**
@Description Converts a given 64-bit constant from CPU byte order to
Little-Endian byte order.
@Param[in] val - The 64-bit value to convert.
@Return The converted value.
@hideinitializer
*//***************************************************************************/
#define CONST_CPU_TO_LE64(val) SWAP_UINT64(val)
/**************************************************************************//**
@Description Converts a given 16-bit constant from Little-Endian byte order
to CPU byte order.
@Param[in] val - The 16-bit value to convert.
@Return The converted value.
@hideinitializer
*//***************************************************************************/
#define CONST_LE16_TO_CPU(val) CONST_CPU_TO_LE16(val)
/**************************************************************************//**
@Description Converts a given 32-bit constant from Little-Endian byte order
to CPU byte order.
@Param[in] val - The 32-bit value to convert.
@Return The converted value.
@hideinitializer
*//***************************************************************************/
#define CONST_LE32_TO_CPU(val) CONST_CPU_TO_LE32(val)
/**************************************************************************//**
@Description Converts a given 64-bit constant from Little-Endian byte order
to CPU byte order.
@Param[in] val - The 64-bit value to convert.
@Return The converted value.
@hideinitializer
*//***************************************************************************/
#define CONST_LE64_TO_CPU(val) CONST_CPU_TO_LE64(val)
/* @} */
/** @} */ /* end of endian_id group */
/** @} */ /* end of gen_id group */
#endif /* __ENDIAN_EXT_H */
|
