xref: /OK3568_Linux_fs/kernel/drivers/net/wireless/realtek/rtlwifi/usb.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /* Copyright(c) 2009-2012  Realtek Corporation.*/
3*4882a593Smuzhiyun 
4*4882a593Smuzhiyun #ifndef __RTL_USB_H__
5*4882a593Smuzhiyun #define __RTL_USB_H__
6*4882a593Smuzhiyun 
7*4882a593Smuzhiyun #include <linux/skbuff.h>
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #define RTL_RX_DESC_SIZE		24
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #define RTL_USB_DEVICE(vend, prod, cfg) \
12*4882a593Smuzhiyun 	.match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
13*4882a593Smuzhiyun 	.idVendor = (vend), \
14*4882a593Smuzhiyun 	.idProduct = (prod), \
15*4882a593Smuzhiyun 	.driver_info = (kernel_ulong_t)&(cfg)
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun #define USB_HIGH_SPEED_BULK_SIZE	512
18*4882a593Smuzhiyun #define USB_FULL_SPEED_BULK_SIZE	64
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun #define RTL_USB_MAX_TXQ_NUM		4		/* max tx queue */
21*4882a593Smuzhiyun #define RTL_USB_MAX_EP_NUM		6		/* max ep number */
22*4882a593Smuzhiyun #define RTL_USB_MAX_TX_URBS_NUM		8
23*4882a593Smuzhiyun 
24*4882a593Smuzhiyun enum rtl_txq {
25*4882a593Smuzhiyun 	/* These definitions shall be consistent with value
26*4882a593Smuzhiyun 	 * returned by skb_get_queue_mapping
27*4882a593Smuzhiyun 	 *------------------------------------*/
28*4882a593Smuzhiyun 	RTL_TXQ_BK,
29*4882a593Smuzhiyun 	RTL_TXQ_BE,
30*4882a593Smuzhiyun 	RTL_TXQ_VI,
31*4882a593Smuzhiyun 	RTL_TXQ_VO,
32*4882a593Smuzhiyun 	/*------------------------------------*/
33*4882a593Smuzhiyun 	RTL_TXQ_BCN,
34*4882a593Smuzhiyun 	RTL_TXQ_MGT,
35*4882a593Smuzhiyun 	RTL_TXQ_HI,
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun 	/* Must be last */
38*4882a593Smuzhiyun 	__RTL_TXQ_NUM,
39*4882a593Smuzhiyun };
40*4882a593Smuzhiyun 
41*4882a593Smuzhiyun struct rtl_ep_map {
42*4882a593Smuzhiyun 	u32 ep_mapping[__RTL_TXQ_NUM];
43*4882a593Smuzhiyun };
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun struct _trx_info {
46*4882a593Smuzhiyun 	struct rtl_usb *rtlusb;
47*4882a593Smuzhiyun 	u32 ep_num;
48*4882a593Smuzhiyun };
49*4882a593Smuzhiyun 
_rtl_install_trx_info(struct rtl_usb * rtlusb,struct sk_buff * skb,u32 ep_num)50*4882a593Smuzhiyun static inline void _rtl_install_trx_info(struct rtl_usb *rtlusb,
51*4882a593Smuzhiyun 					 struct sk_buff *skb,
52*4882a593Smuzhiyun 					 u32 ep_num)
53*4882a593Smuzhiyun {
54*4882a593Smuzhiyun 	struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun 	info->rate_driver_data[0] = rtlusb;
57*4882a593Smuzhiyun 	info->rate_driver_data[1] = (void *)(__kernel_size_t)ep_num;
58*4882a593Smuzhiyun }
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun /*  Add suspend/resume later */
61*4882a593Smuzhiyun enum rtl_usb_state {
62*4882a593Smuzhiyun 	USB_STATE_STOP	= 0,
63*4882a593Smuzhiyun 	USB_STATE_START	= 1,
64*4882a593Smuzhiyun };
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun #define IS_USB_STOP(rtlusb_ptr) (USB_STATE_STOP == (rtlusb_ptr)->state)
67*4882a593Smuzhiyun #define IS_USB_START(rtlusb_ptr) (USB_STATE_START == (rtlusb_ptr)->state)
68*4882a593Smuzhiyun #define SET_USB_STOP(rtlusb_ptr) \
69*4882a593Smuzhiyun 	do {							\
70*4882a593Smuzhiyun 		(rtlusb_ptr)->state = USB_STATE_STOP;		\
71*4882a593Smuzhiyun 	} while (0)
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun #define SET_USB_START(rtlusb_ptr)				\
74*4882a593Smuzhiyun 	do { \
75*4882a593Smuzhiyun 		(rtlusb_ptr)->state = USB_STATE_START;		\
76*4882a593Smuzhiyun 	} while (0)
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun struct rtl_usb {
79*4882a593Smuzhiyun 	struct usb_device *udev;
80*4882a593Smuzhiyun 	struct usb_interface *intf;
81*4882a593Smuzhiyun 	enum rtl_usb_state state;
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun 	/* Bcn control register setting */
84*4882a593Smuzhiyun 	u32 reg_bcn_ctrl_val;
85*4882a593Smuzhiyun 	/* for 88/92cu card disable */
86*4882a593Smuzhiyun 	u8	disablehwsm;
87*4882a593Smuzhiyun 	/*QOS & EDCA */
88*4882a593Smuzhiyun 	enum acm_method acm_method;
89*4882a593Smuzhiyun 	/* irq  . HIMR,HIMR_EX */
90*4882a593Smuzhiyun 	u32 irq_mask[2];
91*4882a593Smuzhiyun 	bool irq_enabled;
92*4882a593Smuzhiyun 
93*4882a593Smuzhiyun 	u16 (*usb_mq_to_hwq)(__le16 fc, u16 mac80211_queue_index);
94*4882a593Smuzhiyun 
95*4882a593Smuzhiyun 	/* Tx */
96*4882a593Smuzhiyun 	u8 out_ep_nums ;
97*4882a593Smuzhiyun 	u8 out_queue_sel;
98*4882a593Smuzhiyun 	struct rtl_ep_map ep_map;
99*4882a593Smuzhiyun 
100*4882a593Smuzhiyun 	u32 max_bulk_out_size;
101*4882a593Smuzhiyun 	u32 tx_submitted_urbs;
102*4882a593Smuzhiyun 	struct sk_buff_head tx_skb_queue[RTL_USB_MAX_EP_NUM];
103*4882a593Smuzhiyun 
104*4882a593Smuzhiyun 	struct usb_anchor tx_pending[RTL_USB_MAX_EP_NUM];
105*4882a593Smuzhiyun 	struct usb_anchor tx_submitted;
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun 	struct sk_buff *(*usb_tx_aggregate_hdl)(struct ieee80211_hw *,
108*4882a593Smuzhiyun 						struct sk_buff_head *);
109*4882a593Smuzhiyun 	int (*usb_tx_post_hdl)(struct ieee80211_hw *,
110*4882a593Smuzhiyun 			       struct urb *, struct sk_buff *);
111*4882a593Smuzhiyun 	void (*usb_tx_cleanup)(struct ieee80211_hw *, struct sk_buff *);
112*4882a593Smuzhiyun 
113*4882a593Smuzhiyun 	/* Rx */
114*4882a593Smuzhiyun 	u8 in_ep_nums;
115*4882a593Smuzhiyun 	u32 in_ep;		/* Bulk IN endpoint number */
116*4882a593Smuzhiyun 	u32 rx_max_size;	/* Bulk IN max buffer size */
117*4882a593Smuzhiyun 	u32 rx_urb_num;		/* How many Bulk INs are submitted to host. */
118*4882a593Smuzhiyun 	struct usb_anchor	rx_submitted;
119*4882a593Smuzhiyun 	struct usb_anchor	rx_cleanup_urbs;
120*4882a593Smuzhiyun 	struct tasklet_struct   rx_work_tasklet;
121*4882a593Smuzhiyun 	struct sk_buff_head	rx_queue;
122*4882a593Smuzhiyun 	void (*usb_rx_segregate_hdl)(struct ieee80211_hw *, struct sk_buff *,
123*4882a593Smuzhiyun 				     struct sk_buff_head *);
124*4882a593Smuzhiyun 	void (*usb_rx_hdl)(struct ieee80211_hw *, struct sk_buff *);
125*4882a593Smuzhiyun };
126*4882a593Smuzhiyun 
127*4882a593Smuzhiyun struct rtl_usb_priv {
128*4882a593Smuzhiyun 	struct bt_coexist_info bt_coexist;
129*4882a593Smuzhiyun 	struct rtl_usb dev;
130*4882a593Smuzhiyun };
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun #define rtl_usbpriv(hw)	 (((struct rtl_usb_priv *)(rtl_priv(hw))->priv))
133*4882a593Smuzhiyun #define rtl_usbdev(usbpriv)	(&((usbpriv)->dev))
134*4882a593Smuzhiyun 
135*4882a593Smuzhiyun int rtl_usb_probe(struct usb_interface *intf,
136*4882a593Smuzhiyun 		  const struct usb_device_id *id,
137*4882a593Smuzhiyun 		  struct rtl_hal_cfg *rtl92cu_hal_cfg);
138*4882a593Smuzhiyun void rtl_usb_disconnect(struct usb_interface *intf);
139*4882a593Smuzhiyun int rtl_usb_suspend(struct usb_interface *pusb_intf, pm_message_t message);
140*4882a593Smuzhiyun int rtl_usb_resume(struct usb_interface *pusb_intf);
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun #endif
143