staging: r8188eu: Convert header copyright info to SPDX format, part 3
[linux-2.6-microblaze.git] / drivers / staging / r8188eu / include / rtl8188e_xmit.h
1 /* SPDX-License-Identifier: GPL-2.0 OR BSD-3-Clause */
2 /* Copyright(c) 2007 - 2011 Realtek Corporation. */
3
4 #ifndef __RTL8188E_XMIT_H__
5 #define __RTL8188E_XMIT_H__
6
7 #define         MAX_TX_AGG_PACKET_NUMBER        0xFF
8 /*  */
9 /*  Queue Select Value in TxDesc */
10 /*  */
11 #define QSLT_BK                                                 0x2/* 0x01 */
12 #define QSLT_BE                                                 0x0
13 #define QSLT_VI                                                 0x5/* 0x4 */
14 #define QSLT_VO                                                 0x7/* 0x6 */
15 #define QSLT_BEACON                                             0x10
16 #define QSLT_HIGH                                               0x11
17 #define QSLT_MGNT                                               0x12
18 #define QSLT_CMD                                                0x13
19
20 /* For 88e early mode */
21 #define SET_EARLYMODE_PKTNUM(__pAddr, __Value)                  \
22         SET_BITS_TO_LE_4BYTE(__pAddr, 0, 3, __Value)
23 #define SET_EARLYMODE_LEN0(__pAddr, __Value)                    \
24         SET_BITS_TO_LE_4BYTE(__pAddr, 4, 12, __Value)
25 #define SET_EARLYMODE_LEN1(__pAddr, __Value)                    \
26         SET_BITS_TO_LE_4BYTE(__pAddr, 16, 12, __Value)
27 #define SET_EARLYMODE_LEN2_1(__pAddr, __Value)                  \
28         SET_BITS_TO_LE_4BYTE(__pAddr, 28, 4, __Value)
29 #define SET_EARLYMODE_LEN2_2(__pAddr, __Value)                  \
30         SET_BITS_TO_LE_4BYTE(__pAddr+4, 0, 8, __Value)
31 #define SET_EARLYMODE_LEN3(__pAddr, __Value)                    \
32         SET_BITS_TO_LE_4BYTE(__pAddr+4, 8, 12, __Value)
33 #define SET_EARLYMODE_LEN4(__pAddr, __Value)                    \
34         SET_BITS_TO_LE_4BYTE(__pAddr+4, 20, 12, __Value)
35
36 /*  */
37 /* defined for TX DESC Operation */
38 /*  */
39
40 #define MAX_TID (15)
41
42 /* OFFSET 0 */
43 #define OFFSET_SZ       0
44 #define OFFSET_SHT      16
45 #define BMC             BIT(24)
46 #define LSG             BIT(26)
47 #define FSG             BIT(27)
48 #define OWN             BIT(31)
49
50 /* OFFSET 4 */
51 #define PKT_OFFSET_SZ           0
52 #define QSEL_SHT                8
53 #define RATE_ID_SHT             16
54 #define NAVUSEHDR               BIT(20)
55 #define SEC_TYPE_SHT            22
56 #define PKT_OFFSET_SHT          26
57
58 /* OFFSET 8 */
59 #define AGG_EN                  BIT(12)
60 #define AGG_BK                  BIT(16)
61 #define AMPDU_DENSITY_SHT       20
62 #define ANTSEL_A                BIT(24)
63 #define ANTSEL_B                BIT(25)
64 #define TX_ANT_CCK_SHT          26
65 #define TX_ANTL_SHT             28
66 #define TX_ANT_HT_SHT           30
67
68 /* OFFSET 12 */
69 #define SEQ_SHT                 16
70 #define EN_HWSEQ                BIT(31)
71
72 /* OFFSET 16 */
73 #define QOS                     BIT(6)
74 #define HW_SSN                  BIT(7)
75 #define USERATE                 BIT(8)
76 #define DISDATAFB               BIT(10)
77 #define CTS_2_SELF              BIT(11)
78 #define RTS_EN                  BIT(12)
79 #define HW_RTS_EN               BIT(13)
80 #define DATA_SHORT              BIT(24)
81 #define PWR_STATUS_SHT          15
82 #define DATA_SC_SHT             20
83 #define DATA_BW                 BIT(25)
84
85 /* OFFSET 20 */
86 #define RTY_LMT_EN              BIT(17)
87
88 enum TXDESC_SC {
89         SC_DONT_CARE = 0x00,
90         SC_UPPER = 0x01,
91         SC_LOWER = 0x02,
92         SC_DUPLICATE = 0x03
93 };
94 /* OFFSET 20 */
95 #define SGI                     BIT(6)
96 #define USB_TXAGG_NUM_SHT       24
97
98 #define txdesc_set_ccx_sw_88e(txdesc, value) \
99         do { \
100                 ((struct txdesc_88e *)(txdesc))->sw1 = (((value)>>8) & 0x0f); \
101                 ((struct txdesc_88e *)(txdesc))->sw0 = ((value) & 0xff); \
102         } while (0)
103
104 struct txrpt_ccx_88e {
105         /* offset 0 */
106         u8 tag1:1;
107         u8 pkt_num:3;
108         u8 txdma_underflow:1;
109         u8 int_bt:1;
110         u8 int_tri:1;
111         u8 int_ccx:1;
112
113         /* offset 1 */
114         u8 mac_id:6;
115         u8 pkt_ok:1;
116         u8 bmc:1;
117
118         /* offset 2 */
119         u8 retry_cnt:6;
120         u8 lifetime_over:1;
121         u8 retry_over:1;
122
123         /* offset 3 */
124         u8 ccx_qtime0;
125         u8 ccx_qtime1;
126
127         /* offset 5 */
128         u8 final_data_rate;
129
130         /* offset 6 */
131         u8 sw1:4;
132         u8 qsel:4;
133
134         /* offset 7 */
135         u8 sw0;
136 };
137
138 #define txrpt_ccx_sw_88e(txrpt_ccx) ((txrpt_ccx)->sw0 + ((txrpt_ccx)->sw1<<8))
139 #define txrpt_ccx_qtime_88e(txrpt_ccx)                  \
140         ((txrpt_ccx)->ccx_qtime0+((txrpt_ccx)->ccx_qtime1<<8))
141
142 void rtl8188e_fill_fake_txdesc(struct adapter *padapter, u8 *pDesc,
143                                u32 BufferLen, u8 IsPsPoll, u8 IsBTQosNull);
144 s32 rtl8188eu_init_xmit_priv(struct adapter *padapter);
145 void rtl8188eu_free_xmit_priv(struct adapter *padapter);
146 s32 rtl8188eu_hal_xmit(struct adapter *padapter, struct xmit_frame *frame);
147 s32 rtl8188eu_mgnt_xmit(struct adapter *padapter, struct xmit_frame *frame);
148 s32 rtl8188eu_xmit_buf_handler(struct adapter *padapter);
149 #define hal_xmit_handler rtl8188eu_xmit_buf_handler
150 void rtl8188eu_xmit_tasklet(void *priv);
151 s32 rtl8188eu_xmitframe_complete(struct adapter *padapter,
152                                  struct xmit_priv *pxmitpriv,
153                                  struct xmit_buf *pxmitbuf);
154
155 void dump_txrpt_ccx_88e(void *buf);
156 void handle_txrpt_ccx_88e(struct adapter *adapter, u8 *buf);
157
158 void _dbg_dump_tx_info(struct adapter *padapter, int frame_tag,
159                        struct tx_desc *ptxdesc);
160
161 #endif /* __RTL8188E_XMIT_H__ */