/* SPDX-License-Identifier: GPL-2.0 */
/* Copyright(c) 2009-2012  Realtek Corporation.*/

#ifndef __RTL_USB_H__
#define __RTL_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_BULKOUT_NUM         4
#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_eps[RTL_USB_MAX_BULKOUT_NUM];
        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;
        struct usb_anchor       rx_cleanup_urbs;
        struct tasklet_struct   rx_work_tasklet;
        struct sk_buff_head     rx_queue;
        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 bt_coexist_info bt_coexist;
        struct rtl_usb dev;
};

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

int rtl_usb_probe(struct usb_interface *intf,
                  const struct usb_device_id *id,
                  const struct rtl_hal_cfg *rtl92cu_hal_cfg);
void rtl_usb_disconnect(struct usb_interface *intf);

#endif