Documentation improvements.
[bertos.git] / mware / byteorder.h
1 /*!
2  * \file
3  * <!--
4  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
5  * This file is part of DevLib - See devlib/README for information.
6  * -->
7  *
8  * \brief Functions to convert integers to/from host byte-order.
9  *
10  * \version $Id$
11  *
12  * \author Bernardo Innocenti <bernie@develer.com>
13  * \author Stefano Fedrigo <aleph@develer.com>
14  */
15
16 /*
17  * $Log$
18  * Revision 1.4  2004/07/22 01:08:43  bernie
19  * swab32(): Fix a very serious bug.
20  *
21  * Revision 1.3  2004/07/20 23:47:12  bernie
22  * Finally remove redundant protos.
23  *
24  * Revision 1.2  2004/07/20 17:09:11  bernie
25  * swab16(), swab32(), cpu_to_be32(), cpu_to_le32(): New functions.
26  *
27  * Revision 1.1  2004/07/20 16:26:15  bernie
28  * Import byte-order macros into DevLib.
29  *
30  */
31
32 #ifndef MWARE_BYTEORDER_H
33 #define MWARE_BYTEORDER_H
34
35 #include <compiler.h>
36 #include <cpu.h>
37
38 /*!
39  * \brief Swap upper and lower bytes in a 16-bit value.
40  */
41 INLINE uint16_t swab16(uint16_t x)
42 {
43         return    ((x & (uint16_t)0x00FFU) << 8)
44                 | ((x & (uint16_t)0xFF00U) >> 8);
45 }
46
47 /*!
48  * \brief Reverse bytes in a 32-bit value (e.g.: 0x12345678 -> 0x78563412).
49  */
50 INLINE uint32_t swab32(uint32_t x)
51 {
52         return    ((x & (uint32_t)0x000000FFUL) << 24)
53                 | ((x & (uint32_t)0x0000FF00UL) <<  8)
54                 | ((x & (uint32_t)0x00FF0000UL) >>  8)
55                 | ((x & (uint32_t)0xFF000000UL) >> 24);
56 }
57
58 INLINE uint16_t cpu_to_be16(uint16_t x)
59 {
60         return (CPU_BYTE_ORDER == CPU_LITTLE_ENDIAN) ? swab16(x) : x;
61 }
62
63 INLINE uint16_t cpu_to_le16(uint16_t x)
64 {
65         return (CPU_BYTE_ORDER == CPU_BIG_ENDIAN) ? swab16(x) : x;
66 }
67
68 INLINE uint32_t cpu_to_be32(uint32_t x)
69 {
70         return (CPU_BYTE_ORDER == CPU_LITTLE_ENDIAN) ? swab32(x) : x;
71 }
72
73 INLINE uint32_t cpu_to_le32(uint32_t x)
74 {
75         return (CPU_BYTE_ORDER == CPU_BIG_ENDIAN) ? swab32(x) : x;
76 }
77
78 #endif /* MWARE_BYTEORDER_H */