1 /* SPDX-License-Identifier: GPL-2.0 */
2 /******************************************************************************
4 * Copyright(c) 2007 - 2011 Realtek Corporation. All rights reserved.
6 ******************************************************************************/
7 #ifndef __BASIC_TYPES_H__
8 #define __BASIC_TYPES_H__
14 #include <linux/types.h>
16 typedef signed int sint;
18 #define FIELD_OFFSET(s, field) ((__kernel_ssize_t)&((s*)(0))->field)
20 #define SIZE_PTR __kernel_size_t
21 #define SSIZE_PTR __kernel_ssize_t
23 /* port from fw by thomas */
24 /* TODO: Belows are Sync from SD7-Driver. It is necessary to check correctness */
27 *Call endian free function when
28 * 1. Read/write packet content.
29 * 2. Before write integer to IO.
30 * 3. After read integer from IO.
34 /* Byte Swapping routine. */
37 #define EF2Byte le16_to_cpu
38 #define EF4Byte le32_to_cpu
40 /* Convert little data endian to host ordering */
41 #define EF1BYTE(_val) \
43 #define EF2BYTE(_val) \
45 #define EF4BYTE(_val) \
48 /* Read data from memory */
49 #define READEF1BYTE(_ptr) \
50 EF1BYTE(*((u8 *)(_ptr)))
51 /* Read le16 data from memory and convert to host ordering */
52 #define READEF2BYTE(_ptr) \
54 #define READEF4BYTE(_ptr) \
57 /* Write data to memory */
58 #define WRITEEF1BYTE(_ptr, _val) \
60 (*((u8 *)(_ptr))) = EF1BYTE(_val); \
62 /* Write le data to memory in host ordering */
63 #define WRITEEF2BYTE(_ptr, _val) \
65 (*((u16 *)(_ptr))) = EF2BYTE(_val); \
68 #define WRITEEF4BYTE(_ptr, _val) \
70 (*((u32 *)(_ptr))) = EF2BYTE(_val); \
75 * BIT_LEN_MASK_32(0) => 0x00000000
76 * BIT_LEN_MASK_32(1) => 0x00000001
77 * BIT_LEN_MASK_32(2) => 0x00000003
78 * BIT_LEN_MASK_32(32) => 0xFFFFFFFF
80 #define BIT_LEN_MASK_32(__bitlen) \
81 (0xFFFFFFFF >> (32 - (__bitlen)))
82 #define BIT_LEN_MASK_16(__bitlen) \
83 (0xFFFF >> (16 - (__bitlen)))
84 #define BIT_LEN_MASK_8(__bitlen) \
85 (0xFF >> (8 - (__bitlen)))
87 /* Create an offset bit mask
89 * BIT_OFFSET_LEN_MASK_32(0, 2) => 0x00000003
90 * BIT_OFFSET_LEN_MASK_32(16, 2) => 0x00030000
92 #define BIT_OFFSET_LEN_MASK_32(__bitoffset, __bitlen) \
93 (BIT_LEN_MASK_32(__bitlen) << (__bitoffset))
94 #define BIT_OFFSET_LEN_MASK_16(__bitoffset, __bitlen) \
95 (BIT_LEN_MASK_16(__bitlen) << (__bitoffset))
96 #define BIT_OFFSET_LEN_MASK_8(__bitoffset, __bitlen) \
97 (BIT_LEN_MASK_8(__bitlen) << (__bitoffset))
100 * Return 4-byte value in host byte ordering from
101 * 4-byte pointer in little-endian system.
103 #define LE_P4BYTE_TO_HOST_4BYTE(__pstart) \
104 (EF4BYTE(*((__le32 *)(__pstart))))
105 #define LE_P2BYTE_TO_HOST_2BYTE(__pstart) \
106 (EF2BYTE(*((__le16 *)(__pstart))))
107 #define LE_P1BYTE_TO_HOST_1BYTE(__pstart) \
108 (EF1BYTE(*((u8 *)(__pstart))))
112 /* Translate subfield (continuous bits in little-endian) of 4-byte value in litten byte to */
113 /* 4-byte value in host byte ordering. */
115 #define LE_BITS_TO_4BYTE(__pstart, __bitoffset, __bitlen) \
117 (LE_P4BYTE_TO_HOST_4BYTE(__pstart) >> (__bitoffset)) & \
118 BIT_LEN_MASK_32(__bitlen) \
120 #define LE_BITS_TO_2BYTE(__pstart, __bitoffset, __bitlen) \
122 (LE_P2BYTE_TO_HOST_2BYTE(__pstart) >> (__bitoffset)) & \
123 BIT_LEN_MASK_16(__bitlen) \
125 #define LE_BITS_TO_1BYTE(__pstart, __bitoffset, __bitlen) \
127 (LE_P1BYTE_TO_HOST_1BYTE(__pstart) >> (__bitoffset)) & \
128 BIT_LEN_MASK_8(__bitlen) \
133 /* Mask subfield (continuous bits in little-endian) of 4-byte value in litten byte oredering */
134 /* and return the result in 4-byte value in host byte ordering. */
136 #define LE_BITS_CLEARED_TO_4BYTE(__pstart, __bitoffset, __bitlen) \
138 LE_P4BYTE_TO_HOST_4BYTE(__pstart) & \
139 (~BIT_OFFSET_LEN_MASK_32(__bitoffset, __bitlen)) \
141 #define LE_BITS_CLEARED_TO_2BYTE(__pstart, __bitoffset, __bitlen) \
143 LE_P2BYTE_TO_HOST_2BYTE(__pstart) & \
144 (~BIT_OFFSET_LEN_MASK_16(__bitoffset, __bitlen)) \
146 #define LE_BITS_CLEARED_TO_1BYTE(__pstart, __bitoffset, __bitlen) \
148 LE_P1BYTE_TO_HOST_1BYTE(__pstart) & \
149 (~BIT_OFFSET_LEN_MASK_8(__bitoffset, __bitlen)) \
154 /* Set subfield of little-endian 4-byte value to specified value. */
156 #define SET_BITS_TO_LE_4BYTE(__pstart, __bitoffset, __bitlen, __val) \
157 *((u32 *)(__pstart)) = \
159 LE_BITS_CLEARED_TO_4BYTE(__pstart, __bitoffset, __bitlen) | \
160 ((((u32)__val) & BIT_LEN_MASK_32(__bitlen)) << (__bitoffset)) \
163 #define SET_BITS_TO_LE_2BYTE(__pstart, __bitoffset, __bitlen, __val) \
164 *((u16 *)(__pstart)) = \
166 LE_BITS_CLEARED_TO_2BYTE(__pstart, __bitoffset, __bitlen) | \
167 ((((u16)__val) & BIT_LEN_MASK_16(__bitlen)) << (__bitoffset)) \
170 #define SET_BITS_TO_LE_1BYTE(__pstart, __bitoffset, __bitlen, __val) \
171 *((u8 *)(__pstart)) = EF1BYTE \
173 LE_BITS_CLEARED_TO_1BYTE(__pstart, __bitoffset, __bitlen) | \
174 ((((u8)__val) & BIT_LEN_MASK_8(__bitlen)) << (__bitoffset)) \
177 #define LE_BITS_CLEARED_TO_1BYTE_8BIT(__pStart, __BitOffset, __BitLen) \
179 LE_P1BYTE_TO_HOST_1BYTE(__pStart) \
182 #define SET_BITS_TO_LE_1BYTE_8BIT(__pStart, __BitOffset, __BitLen, __Value) \
184 *((u8 *)(__pStart)) = \
186 LE_BITS_CLEARED_TO_1BYTE_8BIT(__pStart, __BitOffset, __BitLen) \
192 /* Get the N-bytes aligment offset from the current length */
193 #define N_BYTE_ALIGMENT(__Value, __Aligment) ((__Aligment == 1) ? (__Value) : (((__Value + __Aligment - 1) / __Aligment) * __Aligment))
195 #define TEST_FLAG(__Flag, __testFlag) (((__Flag) & (__testFlag)) != 0)
196 #define SET_FLAG(__Flag, __setFlag) ((__Flag) |= __setFlag)
197 #define CLEAR_FLAG(__Flag, __clearFlag) ((__Flag) &= ~(__clearFlag))
198 #define CLEAR_FLAGS(__Flag) ((__Flag) = 0)
199 #define TEST_FLAGS(__Flag, __testFlags) (((__Flag) & (__testFlags)) == (__testFlags))
201 #endif /* __BASIC_TYPES_H__ */