net/hns3: fix typos on comments
[dpdk.git] / drivers / net / txgbe / base / txgbe_osdep.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2015-2020
3  */
4
5 #ifndef _TXGBE_OS_H_
6 #define _TXGBE_OS_H_
7
8 #include <string.h>
9 #include <stdint.h>
10 #include <stdio.h>
11 #include <stdarg.h>
12 #include <rte_version.h>
13 #include <rte_common.h>
14 #include <rte_debug.h>
15 #include <rte_cycles.h>
16 #include <rte_log.h>
17 #include <rte_byteorder.h>
18 #include <rte_config.h>
19 #include <rte_io.h>
20
21 #include "../txgbe_logs.h"
22
23 #define RTE_LIBRTE_TXGBE_TM        DCPV(1, 0)
24 #define TMZ_PADDR(mz)  ((mz)->iova)
25 #define TMZ_VADDR(mz)  ((mz)->addr)
26 #define TDEV_NAME(eth_dev)  ((eth_dev)->device->name)
27
28 #define ASSERT(x) do {                  \
29         if (!(x))                       \
30                 PMD_DRV_LOG(ERR, "TXGBE: %d", x);       \
31 } while (0)
32
33 #define txgbe_unused __rte_unused
34
35 #define usec_delay(x) rte_delay_us(x)
36 #define msec_delay(x) rte_delay_ms(x)
37 #define usleep(x)     rte_delay_us(x)
38 #define msleep(x)     rte_delay_ms(x)
39 #define usec_stamp()    (rte_get_timer_cycles() * 1000000 / rte_get_timer_hz())
40
41 #define FALSE               0
42 #define TRUE                1
43
44 #define false               0
45 #define true                1
46 #define min(a, b)       RTE_MIN(a, b)
47 #define max(a, b)       RTE_MAX(a, b)
48
49 /* Bunch of defines for shared code bogosity */
50
51 static inline void UNREFERENCED(const char *a __rte_unused, ...) {}
52 #define UNREFERENCED_PARAMETER(args...) UNREFERENCED("", ##args)
53
54 #define STATIC static
55
56 typedef uint8_t         u8;
57 typedef int8_t          s8;
58 typedef uint16_t        u16;
59 typedef int16_t         s16;
60 typedef uint32_t        u32;
61 typedef int32_t         s32;
62 typedef uint64_t        u64;
63 typedef int64_t         s64;
64
65 /* Little Endian defines */
66 #ifndef __le16
67 #define __le16  u16
68 #define __le32  u32
69 #define __le64  u64
70 #endif
71 #ifndef __be16
72 #define __be16  u16
73 #define __be32  u32
74 #define __be64  u64
75 #endif
76
77 /* Bit shift and mask */
78 #define BIT_MASK4                 (0x0000000FU)
79 #define BIT_MASK8                 (0x000000FFU)
80 #define BIT_MASK16                (0x0000FFFFU)
81 #define BIT_MASK32                (0xFFFFFFFFU)
82 #define BIT_MASK64                (0xFFFFFFFFFFFFFFFFUL)
83
84 #ifndef cpu_to_le32
85 #define cpu_to_le16(v)          rte_cpu_to_le_16((u16)(v))
86 #define cpu_to_le32(v)          rte_cpu_to_le_32((u32)(v))
87 #define cpu_to_le64(v)          rte_cpu_to_le_64((u64)(v))
88 #define le_to_cpu16(v)          rte_le_to_cpu_16((u16)(v))
89 #define le_to_cpu32(v)          rte_le_to_cpu_32((u32)(v))
90 #define le_to_cpu64(v)          rte_le_to_cpu_64((u64)(v))
91
92 #define cpu_to_be16(v)          rte_cpu_to_be_16((u16)(v))
93 #define cpu_to_be32(v)          rte_cpu_to_be_32((u32)(v))
94 #define cpu_to_be64(v)          rte_cpu_to_be_64((u64)(v))
95 #define be_to_cpu16(v)          rte_be_to_cpu_16((u16)(v))
96 #define be_to_cpu32(v)          rte_be_to_cpu_32((u32)(v))
97 #define be_to_cpu64(v)          rte_be_to_cpu_64((u64)(v))
98
99 #define le_to_be16(v)           rte_bswap16((u16)(v))
100 #define le_to_be32(v)           rte_bswap32((u32)(v))
101 #define le_to_be64(v)           rte_bswap64((u64)(v))
102 #define be_to_le16(v)           rte_bswap16((u16)(v))
103 #define be_to_le32(v)           rte_bswap32((u32)(v))
104 #define be_to_le64(v)           rte_bswap64((u64)(v))
105
106 #define npu_to_le16(v)          (v)
107 #define npu_to_le32(v)          (v)
108 #define npu_to_le64(v)          (v)
109 #define le_to_npu16(v)          (v)
110 #define le_to_npu32(v)          (v)
111 #define le_to_npu64(v)          (v)
112
113 #define npu_to_be16(v)          le_to_be16((u16)(v))
114 #define npu_to_be32(v)          le_to_be32((u32)(v))
115 #define npu_to_be64(v)          le_to_be64((u64)(v))
116 #define be_to_npu16(v)          be_to_le16((u16)(v))
117 #define be_to_npu32(v)          be_to_le32((u32)(v))
118 #define be_to_npu64(v)          be_to_le64((u64)(v))
119 #endif /* !cpu_to_le32 */
120
121 static inline u16 REVERT_BIT_MASK16(u16 mask)
122 {
123         mask = ((mask & 0x5555) << 1) | ((mask & 0xAAAA) >> 1);
124         mask = ((mask & 0x3333) << 2) | ((mask & 0xCCCC) >> 2);
125         mask = ((mask & 0x0F0F) << 4) | ((mask & 0xF0F0) >> 4);
126         return ((mask & 0x00FF) << 8) | ((mask & 0xFF00) >> 8);
127 }
128
129 static inline u32 REVERT_BIT_MASK32(u32 mask)
130 {
131         mask = ((mask & 0x55555555) << 1) | ((mask & 0xAAAAAAAA) >> 1);
132         mask = ((mask & 0x33333333) << 2) | ((mask & 0xCCCCCCCC) >> 2);
133         mask = ((mask & 0x0F0F0F0F) << 4) | ((mask & 0xF0F0F0F0) >> 4);
134         mask = ((mask & 0x00FF00FF) << 8) | ((mask & 0xFF00FF00) >> 8);
135         return ((mask & 0x0000FFFF) << 16) | ((mask & 0xFFFF0000) >> 16);
136 }
137
138 static inline u64 REVERT_BIT_MASK64(u64 mask)
139 {
140         mask = ((mask & 0x5555555555555555) << 1) |
141                ((mask & 0xAAAAAAAAAAAAAAAA) >> 1);
142         mask = ((mask & 0x3333333333333333) << 2) |
143                ((mask & 0xCCCCCCCCCCCCCCCC) >> 2);
144         mask = ((mask & 0x0F0F0F0F0F0F0F0F) << 4) |
145                ((mask & 0xF0F0F0F0F0F0F0F0) >> 4);
146         mask = ((mask & 0x00FF00FF00FF00FF) << 8) |
147                ((mask & 0xFF00FF00FF00FF00) >> 8);
148         mask = ((mask & 0x0000FFFF0000FFFF) << 16) |
149                ((mask & 0xFFFF0000FFFF0000) >> 16);
150         return ((mask & 0x00000000FFFFFFFF) << 32) |
151                ((mask & 0xFFFFFFFF00000000) >> 32);
152 }
153
154 #define IOMEM
155
156 #define prefetch(x) rte_prefetch0(x)
157
158 #define ARRAY_SIZE(x) ((int32_t)RTE_DIM(x))
159
160 #ifndef MAX_UDELAY_MS
161 #define MAX_UDELAY_MS 5
162 #endif
163
164 #define ETH_ADDR_LEN    6
165 #define ETH_FCS_LEN     4
166
167 /* Check whether address is multicast. This is little-endian specific check.*/
168 #define TXGBE_IS_MULTICAST(address) \
169                 (bool)(((u8 *)(address))[0] & ((u8)0x01))
170
171 /* Check whether an address is broadcast. */
172 #define TXGBE_IS_BROADCAST(address) \
173                 ({typeof(address)addr = (address); \
174                 (((u8 *)(addr))[0] == ((u8)0xff)) && \
175                 (((u8 *)(addr))[1] == ((u8)0xff)); })
176
177 #define ETH_P_8021Q      0x8100
178 #define ETH_P_8021AD     0x88A8
179
180 #endif /* _TXGBE_OS_H_ */