[mirror_ubuntu-bionic-kernel.git] / drivers / net / wireless / rtlwifi / usb.h

/******************************************************************************
 *
 * Copyright(c) 2009-2012  Realtek Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of version 2 of the GNU General Public License as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
 *
 * The full GNU General Public License is included in this distribution in the
 * file called LICENSE.
 *
 * Contact Information:
 * wlanfae <wlanfae@realtek.com>
 * Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
 * Hsinchu 300, Taiwan.
 *
 *****************************************************************************/

#ifndef __RTL_USB_H__
#define __RTL_USB_H__

#include <linux/usb.h>
#include <linux/skbuff.h>

#define RTL_RX_DESC_SIZE		24

#define RTL_USB_DEVICE(vend, prod, cfg) \
	.match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
	.idVendor = (vend), \
	.idProduct = (prod), \
	.driver_info = (kernel_ulong_t)&(cfg)

#define USB_HIGH_SPEED_BULK_SIZE	512
#define USB_FULL_SPEED_BULK_SIZE	64


#define RTL_USB_MAX_TXQ_NUM		4		/* max tx queue */
#define RTL_USB_MAX_EP_NUM		6		/* max ep number */
#define RTL_USB_MAX_TX_URBS_NUM		8

enum rtl_txq {
	/* These definitions shall be consistent with value
	 * returned by skb_get_queue_mapping
	 *------------------------------------*/
	RTL_TXQ_BK,
	RTL_TXQ_BE,
	RTL_TXQ_VI,
	RTL_TXQ_VO,
	/*------------------------------------*/
	RTL_TXQ_BCN,
	RTL_TXQ_MGT,
	RTL_TXQ_HI,

	/* Must be last */
	__RTL_TXQ_NUM,
};

struct rtl_ep_map {
	u32 ep_mapping[__RTL_TXQ_NUM];
};

struct _trx_info {
	struct rtl_usb *rtlusb;
	u32 ep_num;
};

static inline void _rtl_install_trx_info(struct rtl_usb *rtlusb,
					 struct sk_buff *skb,
					 u32 ep_num)
{
	struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
	info->rate_driver_data[0] = rtlusb;
	info->rate_driver_data[1] = (void *)(__kernel_size_t)ep_num;
}


/*  Add suspend/resume later */
enum rtl_usb_state {
	USB_STATE_STOP	= 0,
	USB_STATE_START	= 1,
};

#define IS_USB_STOP(rtlusb_ptr) (USB_STATE_STOP == (rtlusb_ptr)->state)
#define IS_USB_START(rtlusb_ptr) (USB_STATE_START == (rtlusb_ptr)->state)
#define SET_USB_STOP(rtlusb_ptr) \
	do {							\
		(rtlusb_ptr)->state = USB_STATE_STOP;		\
	} while (0)

#define SET_USB_START(rtlusb_ptr)				\
	do { \
		(rtlusb_ptr)->state = USB_STATE_START;		\
	} while (0)

struct rtl_usb {
	struct usb_device *udev;
	struct usb_interface *intf;
	enum rtl_usb_state state;

	/* Bcn control register setting */
	u32 reg_bcn_ctrl_val;
	/* for 88/92cu card disable */
	u8	disableHWSM;
	/*QOS & EDCA */
	enum acm_method acm_method;
	/* irq  . HIMR,HIMR_EX */
	u32 irq_mask[2];
	bool irq_enabled;

	u16 (*usb_mq_to_hwq)(__le16 fc, u16 mac80211_queue_index);

	/* Tx */
	u8 out_ep_nums ;
	u8 out_queue_sel;
	struct rtl_ep_map ep_map;

	u32 max_bulk_out_size;
	u32 tx_submitted_urbs;
	struct sk_buff_head tx_skb_queue[RTL_USB_MAX_EP_NUM];

	struct usb_anchor tx_pending[RTL_USB_MAX_EP_NUM];
	struct usb_anchor tx_submitted;

	struct sk_buff *(*usb_tx_aggregate_hdl)(struct ieee80211_hw *,
						struct sk_buff_head *);
	int (*usb_tx_post_hdl)(struct ieee80211_hw *,
			       struct urb *, struct sk_buff *);
	void (*usb_tx_cleanup)(struct ieee80211_hw *, struct sk_buff *);

	/* Rx */
	u8 in_ep_nums ;
	u32 in_ep;		/* Bulk IN endpoint number */
	u32 rx_max_size;	/* Bulk IN max buffer size */
	u32 rx_urb_num;		/* How many Bulk INs are submitted to host. */
	struct usb_anchor	rx_submitted;
	void (*usb_rx_segregate_hdl)(struct ieee80211_hw *, struct sk_buff *,
				     struct sk_buff_head *);
	void (*usb_rx_hdl)(struct ieee80211_hw *, struct sk_buff *);
};

struct rtl_usb_priv {
	struct rtl_usb dev;
	struct rtl_led_ctl ledctl;
};

#define rtl_usbpriv(hw)	 (((struct rtl_usb_priv *)(rtl_priv(hw))->priv))
#define rtl_usbdev(usbpriv)	(&((usbpriv)->dev))


int __devinit rtl_usb_probe(struct usb_interface *intf,
			    const struct usb_device_id *id);
void rtl_usb_disconnect(struct usb_interface *intf);
int rtl_usb_suspend(struct usb_interface *pusb_intf, pm_message_t message);
int rtl_usb_resume(struct usb_interface *pusb_intf);

#endif
Commit	Line	Data
2ca20f79 G	1	/******************************************************************************
2ca20f79 G	2	*
a8d76066	3	* Copyright(c) 2009-2012 Realtek Corporation. All rights reserved.
2ca20f79 G	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	* You should have received a copy of the GNU General Public License along with
	15	* this program; if not, write to the Free Software Foundation, Inc.,
	16	* 51 Franklin Street, Fifth Floor, Boston, MA 02110, USA
	17	*
	18	* The full GNU General Public License is included in this distribution in the
	19	* file called LICENSE.
	20	*
	21	* Contact Information:
	22	* wlanfae <wlanfae@realtek.com>
	23	* Realtek Corporation, No. 2, Innovation Road II, Hsinchu Science Park,
	24	* Hsinchu 300, Taiwan.
	25	*
	26	*****************************************************************************/
	27
	28	#ifndef __RTL_USB_H__
	29	#define __RTL_USB_H__
	30
	31	#include <linux/usb.h>
	32	#include <linux/skbuff.h>
	33
acd48572 C	34	#define RTL_RX_DESC_SIZE 24
acd48572 C	35
2ca20f79 G	36	#define RTL_USB_DEVICE(vend, prod, cfg) \
	37	.match_flags = USB_DEVICE_ID_MATCH_DEVICE, \
	38	.idVendor = (vend), \
	39	.idProduct = (prod), \
	40	.driver_info = (kernel_ulong_t)&(cfg)
	41
	42	#define USB_HIGH_SPEED_BULK_SIZE 512
	43	#define USB_FULL_SPEED_BULK_SIZE 64
	44
	45
	46	#define RTL_USB_MAX_TXQ_NUM 4 /* max tx queue */
	47	#define RTL_USB_MAX_EP_NUM 6 /* max ep number */
	48	#define RTL_USB_MAX_TX_URBS_NUM 8
	49
	50	enum rtl_txq {
	51	/* These definitions shall be consistent with value
	52	* returned by skb_get_queue_mapping
	53	------------------------------------/
	54	RTL_TXQ_BK,
	55	RTL_TXQ_BE,
	56	RTL_TXQ_VI,
	57	RTL_TXQ_VO,
	58	/------------------------------------/
	59	RTL_TXQ_BCN,
	60	RTL_TXQ_MGT,
	61	RTL_TXQ_HI,
	62
	63	/* Must be last */
	64	__RTL_TXQ_NUM,
	65	};
	66
	67	struct rtl_ep_map {
	68	u32 ep_mapping[__RTL_TXQ_NUM];
	69	};
	70
	71	struct _trx_info {
	72	struct rtl_usb *rtlusb;
	73	u32 ep_num;
	74	};
	75
	76	static inline void _rtl_install_trx_info(struct rtl_usb *rtlusb,
	77	struct sk_buff *skb,
	78	u32 ep_num)
	79	{
	80	struct ieee80211_tx_info *info = IEEE80211_SKB_CB(skb);
	81	info->rate_driver_data[0] = rtlusb;
	82	info->rate_driver_data[1] = (void *)(__kernel_size_t)ep_num;
	83	}
	84
	85
	86	/* Add suspend/resume later */
	87	enum rtl_usb_state {
	88	USB_STATE_STOP = 0,
	89	USB_STATE_START = 1,
	90	};
	91
	92	#define IS_USB_STOP(rtlusb_ptr) (USB_STATE_STOP == (rtlusb_ptr)->state)
	93	#define IS_USB_START(rtlusb_ptr) (USB_STATE_START == (rtlusb_ptr)->state)
	94	#define SET_USB_STOP(rtlusb_ptr) \
	95	do { \
	96	(rtlusb_ptr)->state = USB_STATE_STOP; \
	97	} while (0)
	98
	99	#define SET_USB_START(rtlusb_ptr) \
100	do { \
101	(rtlusb_ptr)->state = USB_STATE_START; \
102	} while (0)
103
104	struct rtl_usb {
105	struct usb_device *udev;
106	struct usb_interface *intf;
107	enum rtl_usb_state state;
108
109	/* Bcn control register setting */
110	u32 reg_bcn_ctrl_val;
111	/* for 88/92cu card disable */
112	u8 disableHWSM;
113	/QOS & EDCA /
114	enum acm_method acm_method;
115	/* irq . HIMR,HIMR_EX */
116	u32 irq_mask[2];
117	bool irq_enabled;
118
17c9ac62	119	u16 (*usb_mq_to_hwq)(__le16 fc, u16 mac80211_queue_index);
2ca20f79 G	120
	121	/* Tx */
	122	u8 out_ep_nums ;
	123	u8 out_queue_sel;
	124	struct rtl_ep_map ep_map;
	125
	126	u32 max_bulk_out_size;
	127	u32 tx_submitted_urbs;
	128	struct sk_buff_head tx_skb_queue[RTL_USB_MAX_EP_NUM];
	129
	130	struct usb_anchor tx_pending[RTL_USB_MAX_EP_NUM];
	131	struct usb_anchor tx_submitted;
	132
	133	struct sk_buff (usb_tx_aggregate_hdl)(struct ieee80211_hw *,
	134	struct sk_buff_head *);
	135	int (usb_tx_post_hdl)(struct ieee80211_hw ,
	136	struct urb , struct sk_buff );
	137	void (usb_tx_cleanup)(struct ieee80211_hw , struct sk_buff *);
	138
	139	/* Rx */
	140	u8 in_ep_nums ;
	141	u32 in_ep; /* Bulk IN endpoint number */
	142	u32 rx_max_size; /* Bulk IN max buffer size */
	143	u32 rx_urb_num; /* How many Bulk INs are submitted to host. */
	144	struct usb_anchor rx_submitted;
	145	void (usb_rx_segregate_hdl)(struct ieee80211_hw , struct sk_buff *,
	146	struct sk_buff_head *);
	147	void (usb_rx_hdl)(struct ieee80211_hw , struct sk_buff *);
	148	};
	149
	150	struct rtl_usb_priv {
	151	struct rtl_usb dev;
	152	struct rtl_led_ctl ledctl;
	153	};
	154
	155	#define rtl_usbpriv(hw) (((struct rtl_usb_priv *)(rtl_priv(hw))->priv))
	156	#define rtl_usbdev(usbpriv) (&((usbpriv)->dev))
	157
	158
	159
	160	int __devinit rtl_usb_probe(struct usb_interface *intf,
	161	const struct usb_device_id *id);
	162	void rtl_usb_disconnect(struct usb_interface *intf);
	163	int rtl_usb_suspend(struct usb_interface *pusb_intf, pm_message_t message);
	164	int rtl_usb_resume(struct usb_interface *pusb_intf);
	165
	166	#endif