GNU Linux-libre 4.14.257-gnu1
[releases.git] / drivers / staging / rtlwifi / halmac / halmac_rx_desc_nic.h
1 /******************************************************************************
2  *
3  * Copyright(c) 2016  Realtek Corporation.
4  *
5  * This program is free software; you can redistribute it and/or modify it
6  * under the terms of version 2 of the GNU General Public License as
7  * published by the Free Software Foundation.
8  *
9  * This program is distributed in the hope that it will be useful, but WITHOUT
10  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
12  * more details.
13  *
14  * The full GNU General Public License is included in this distribution in the
15  * file called LICENSE.
16  *
17  * Contact Information:
18  * wlanfae <wlanfae@realtek.com>
19  * Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
20  * Hsinchu 300, Taiwan.
21  *
22  * Larry Finger <Larry.Finger@lwfinger.net>
23  *
24  *****************************************************************************/
25 #ifndef _HALMAC_RX_DESC_NIC_H_
26 #define _HALMAC_RX_DESC_NIC_H_
27
28 /*RXDESC_WORD0*/
29
30 #define GET_RX_DESC_EOR(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x00, 30, 1)
31 #define GET_RX_DESC_PHYPKTIDC(__rx_desc)                                       \
32         LE_BITS_TO_4BYTE(__rx_desc + 0x00, 28, 1)
33 #define GET_RX_DESC_SWDEC(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x00, 27, 1)
34 #define GET_RX_DESC_PHYST(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x00, 26, 1)
35 #define GET_RX_DESC_SHIFT(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x00, 24, 2)
36 #define GET_RX_DESC_QOS(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x00, 23, 1)
37 #define GET_RX_DESC_SECURITY(__rx_desc)                                        \
38         LE_BITS_TO_4BYTE(__rx_desc + 0x00, 20, 3)
39 #define GET_RX_DESC_DRV_INFO_SIZE(__rx_desc)                                   \
40         LE_BITS_TO_4BYTE(__rx_desc + 0x00, 16, 4)
41 #define GET_RX_DESC_ICV_ERR(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x00, 15, 1)
42 #define GET_RX_DESC_CRC32(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x00, 14, 1)
43 #define GET_RX_DESC_PKT_LEN(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x00, 0, 14)
44
45 /*RXDESC_WORD1*/
46
47 #define GET_RX_DESC_BC(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x04, 31, 1)
48 #define GET_RX_DESC_MC(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x04, 30, 1)
49 #define GET_RX_DESC_TY_PE(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x04, 28, 2)
50 #define GET_RX_DESC_MF(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x04, 27, 1)
51 #define GET_RX_DESC_MD(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x04, 26, 1)
52 #define GET_RX_DESC_PWR(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x04, 25, 1)
53 #define GET_RX_DESC_PAM(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x04, 24, 1)
54 #define GET_RX_DESC_CHK_VLD(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x04, 23, 1)
55 #define GET_RX_DESC_RX_IS_TCP_UDP(__rx_desc)                                   \
56         LE_BITS_TO_4BYTE(__rx_desc + 0x04, 22, 1)
57 #define GET_RX_DESC_RX_IPV(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x04, 21, 1)
58 #define GET_RX_DESC_CHKERR(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x04, 20, 1)
59 #define GET_RX_DESC_PAGGR(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x04, 15, 1)
60 #define GET_RX_DESC_RXID_MATCH(__rx_desc)                                      \
61         LE_BITS_TO_4BYTE(__rx_desc + 0x04, 14, 1)
62 #define GET_RX_DESC_AMSDU(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x04, 13, 1)
63 #define GET_RX_DESC_MACID_VLD(__rx_desc)                                       \
64         LE_BITS_TO_4BYTE(__rx_desc + 0x04, 12, 1)
65 #define GET_RX_DESC_TID(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x04, 8, 4)
66
67 #define GET_RX_DESC_EXT_SECTYPE(__rx_desc)                                     \
68         LE_BITS_TO_4BYTE(__rx_desc + 0x04, 7, 1)
69
70 #define GET_RX_DESC_MACID(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x04, 0, 7)
71
72 /*RXDESC_WORD2*/
73
74 #define GET_RX_DESC_FCS_OK(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x08, 31, 1)
75
76 #define GET_RX_DESC_PPDU_CNT(__rx_desc)                                        \
77         LE_BITS_TO_4BYTE(__rx_desc + 0x08, 29, 2)
78
79 #define GET_RX_DESC_C2H(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x08, 28, 1)
80 #define GET_RX_DESC_HWRSVD(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x08, 24, 4)
81 #define GET_RX_DESC_WLANHD_IV_LEN(__rx_desc)                                   \
82         LE_BITS_TO_4BYTE(__rx_desc + 0x08, 18, 6)
83 #define GET_RX_DESC_RX_IS_QOS(__rx_desc)                                       \
84         LE_BITS_TO_4BYTE(__rx_desc + 0x08, 16, 1)
85 #define GET_RX_DESC_FRAG(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x08, 12, 4)
86 #define GET_RX_DESC_SEQ(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x08, 0, 12)
87
88 /*RXDESC_WORD3*/
89
90 #define GET_RX_DESC_MAGIC_WAKE(__rx_desc)                                      \
91         LE_BITS_TO_4BYTE(__rx_desc + 0x0C, 31, 1)
92 #define GET_RX_DESC_UNICAST_WAKE(__rx_desc)                                    \
93         LE_BITS_TO_4BYTE(__rx_desc + 0x0C, 30, 1)
94 #define GET_RX_DESC_PATTERN_MATCH(__rx_desc)                                   \
95         LE_BITS_TO_4BYTE(__rx_desc + 0x0C, 29, 1)
96
97 #define GET_RX_DESC_RXPAYLOAD_MATCH(__rx_desc)                                 \
98         LE_BITS_TO_4BYTE(__rx_desc + 0x0C, 28, 1)
99 #define GET_RX_DESC_RXPAYLOAD_ID(__rx_desc)                                    \
100         LE_BITS_TO_4BYTE(__rx_desc + 0x0C, 24, 4)
101
102 #define GET_RX_DESC_DMA_AGG_NUM(__rx_desc)                                     \
103         LE_BITS_TO_4BYTE(__rx_desc + 0x0C, 16, 8)
104 #define GET_RX_DESC_BSSID_FIT_1_0(__rx_desc)                                   \
105         LE_BITS_TO_4BYTE(__rx_desc + 0x0C, 12, 2)
106 #define GET_RX_DESC_EOSP(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x0C, 11, 1)
107 #define GET_RX_DESC_HTC(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x0C, 10, 1)
108
109 #define GET_RX_DESC_BSSID_FIT_4_2(__rx_desc)                                   \
110         LE_BITS_TO_4BYTE(__rx_desc + 0x0C, 7, 3)
111
112 #define GET_RX_DESC_RX_RATE(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x0C, 0, 7)
113
114 /*RXDESC_WORD4*/
115
116 #define GET_RX_DESC_A1_FIT(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x10, 24, 5)
117
118 #define GET_RX_DESC_MACID_RPT_BUFF(__rx_desc)                                  \
119         LE_BITS_TO_4BYTE(__rx_desc + 0x10, 17, 7)
120 #define GET_RX_DESC_RX_PRE_NDP_VLD(__rx_desc)                                  \
121         LE_BITS_TO_4BYTE(__rx_desc + 0x10, 16, 1)
122 #define GET_RX_DESC_RX_SCRAMBLER(__rx_desc)                                    \
123         LE_BITS_TO_4BYTE(__rx_desc + 0x10, 9, 7)
124 #define GET_RX_DESC_RX_EOF(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x10, 8, 1)
125
126 #define GET_RX_DESC_PATTERN_IDX(__rx_desc)                                     \
127         LE_BITS_TO_4BYTE(__rx_desc + 0x10, 0, 8)
128
129 /*RXDESC_WORD5*/
130
131 #define GET_RX_DESC_TSFL(__rx_desc) LE_BITS_TO_4BYTE(__rx_desc + 0x14, 0, 32)
132
133 #endif