xref: /xnu-11215.61.5/libkern/libkern/machine/OSByteOrder.h (revision 4f1223e81cd707a65cc109d0b8ad6653699da3c4)
1 /*
2  * Copyright (c) 2000-2023 Apple Computer, Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 
29 #ifndef _OS_OSBYTEORDERMACHINE_H
30 #define _OS_OSBYTEORDERMACHINE_H
31 
32 #if !defined(__GNUC__) || (!defined(__i386__) && !defined(__x86_64__) && !defined (__arm__) && !defined(__arm64__))
33 
34 #include <stdint.h>
35 
36 #if !defined(OS_INLINE)
37 # if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199901L
38 #        define OS_INLINE static inline
39 # elif defined(__MWERKS__) || defined(__cplusplus)
40 #        define OS_INLINE static inline
41 # else
42 #        define OS_INLINE static __inline__
43 # endif
44 #endif
45 
46 /* Generic byte swapping functions. */
47 
48 OS_INLINE
49 uint16_t
_OSSwapInt16(uint16_t data)50 _OSSwapInt16(
51 	uint16_t                      data
52 	)
53 {
54 	return OSSwapConstInt16(data);
55 }
56 
57 OS_INLINE
58 uint32_t
_OSSwapInt32(uint32_t data)59 _OSSwapInt32(
60 	uint32_t                      data
61 	)
62 {
63 	return OSSwapConstInt32(data);
64 }
65 
66 OS_INLINE
67 uint64_t
_OSSwapInt64(uint64_t data)68 _OSSwapInt64(
69 	uint64_t                        data
70 	)
71 {
72 	return OSSwapConstInt64(data);
73 }
74 
75 /* Functions for byte reversed loads. */
76 
77 OS_INLINE
78 uint16_t
OSReadSwapInt16(const volatile void * base,uintptr_t byteOffset)79 OSReadSwapInt16(
80 	const volatile void               * base,
81 	uintptr_t                     byteOffset
82 	)
83 {
84 	uint16_t data = *(volatile uint16_t *)((uintptr_t)base + byteOffset);
85 	return _OSSwapInt16(data);
86 }
87 
88 OS_INLINE
89 uint32_t
OSReadSwapInt32(const volatile void * base,uintptr_t byteOffset)90 OSReadSwapInt32(
91 	const volatile void               * base,
92 	uintptr_t                     byteOffset
93 	)
94 {
95 	uint32_t data = *(volatile uint32_t *)((uintptr_t)base + byteOffset);
96 	return _OSSwapInt32(data);
97 }
98 
99 OS_INLINE
100 uint64_t
OSReadSwapInt64(const volatile void * base,uintptr_t byteOffset)101 OSReadSwapInt64(
102 	const volatile void               * base,
103 	uintptr_t                     byteOffset
104 	)
105 {
106 	uint64_t data = *(volatile uint64_t *)((uintptr_t)base + byteOffset);
107 	return _OSSwapInt64(data);
108 }
109 
110 /* Functions for byte reversed stores. */
111 
112 OS_INLINE
113 void
OSWriteSwapInt16(volatile void * base,uintptr_t byteOffset,uint16_t data)114 OSWriteSwapInt16(
115 	volatile void               * base,
116 	uintptr_t                     byteOffset,
117 	uint16_t                      data
118 	)
119 {
120 	*(volatile uint16_t *)((uintptr_t)base + byteOffset) = _OSSwapInt16(data);
121 }
122 
123 OS_INLINE
124 void
OSWriteSwapInt32(volatile void * base,uintptr_t byteOffset,uint32_t data)125 OSWriteSwapInt32(
126 	volatile void               * base,
127 	uintptr_t                     byteOffset,
128 	uint32_t                      data
129 	)
130 {
131 	*(volatile uint32_t *)((uintptr_t)base + byteOffset) = _OSSwapInt32(data);
132 }
133 
134 OS_INLINE
135 void
OSWriteSwapInt64(volatile void * base,uintptr_t byteOffset,uint64_t data)136 OSWriteSwapInt64(
137 	volatile void               * base,
138 	uintptr_t                     byteOffset,
139 	uint64_t                      data
140 	)
141 {
142 	*(volatile uint64_t *)((uintptr_t)base + byteOffset) = _OSSwapInt64(data);
143 }
144 
145 #endif /* !defined(__GNUC__) || (!defined(__i386__) && !defined(__x86_64__) && !defined (__arm__) && !defined(__arm64__)) */
146 
147 #endif /* ! _OS_OSBYTEORDERMACHINE_H */
148