/*-
 * Copyright (c) 2005, 2006 Damien Bergamini <damien.bergamini@free.fr>
 * Copyright (c) 2006 Niall O'Higgins <niallo@openbsd.org>
 *
 * Permission to use, copy, modify, and distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

#define RUM_TX_LIST_COUNT       8
#define RUM_TX_MINFREE          2

struct rum_rx_radiotap_header {
        struct ieee80211_radiotap_header wr_ihdr;
        uint64_t        wr_tsf;
        uint8_t         wr_flags;
        uint8_t         wr_rate;
        uint16_t        wr_chan_freq;
        uint16_t        wr_chan_flags;
        int8_t          wr_antsignal;
        int8_t          wr_antnoise;
        uint8_t         wr_antenna;
} __packed __aligned(8);

#define RT2573_RX_RADIOTAP_PRESENT                                      \
        ((1 << IEEE80211_RADIOTAP_TSFT) |                               \
         (1 << IEEE80211_RADIOTAP_FLAGS) |                              \
         (1 << IEEE80211_RADIOTAP_RATE) |                               \
         (1 << IEEE80211_RADIOTAP_CHANNEL) |                            \
         (1 << IEEE80211_RADIOTAP_DBM_ANTSIGNAL) |                      \
         (1 << IEEE80211_RADIOTAP_DBM_ANTNOISE) |                       \
         (1 << IEEE80211_RADIOTAP_ANTENNA) |                            \
         0)

struct rum_tx_radiotap_header {
        struct ieee80211_radiotap_header wt_ihdr;
        uint8_t         wt_flags;
        uint8_t         wt_rate;
        uint16_t        wt_chan_freq;
        uint16_t        wt_chan_flags;
        uint8_t         wt_antenna;
} __packed;

#define RT2573_TX_RADIOTAP_PRESENT                                      \
        ((1 << IEEE80211_RADIOTAP_FLAGS) |                              \
         (1 << IEEE80211_RADIOTAP_RATE) |                               \
         (1 << IEEE80211_RADIOTAP_CHANNEL) |                            \
         (1 << IEEE80211_RADIOTAP_ANTENNA))

struct rum_softc;

struct rum_tx_data {
        STAILQ_ENTRY(rum_tx_data)       next;
        struct rum_softc                *sc;
        struct rum_tx_desc              desc;
        struct mbuf                     *m;
        struct ieee80211_node           *ni;
        int                             rate;
};
typedef STAILQ_HEAD(, rum_tx_data) rum_txdhead;

union sec_param {
        struct ieee80211_key            key;
        uint8_t                         macaddr[IEEE80211_ADDR_LEN];
        struct ieee80211vap             *vap;
};
#define CMD_FUNC_PROTO                  void (*func)(struct rum_softc *, \
                                            union sec_param *, uint8_t)

struct rum_cmdq {
        union sec_param                 data;
        uint8_t                         rvp_id;

        CMD_FUNC_PROTO;
};
#define RUM_CMDQ_SIZE                   16

struct rum_vap {
        struct ieee80211vap             vap;
        struct mbuf                     *bcn_mbuf;
        struct usb_callout              ratectl_ch;
        struct task                     ratectl_task;
        uint8_t                         maxretry;

        int                             (*newstate)(struct ieee80211vap *,
                                            enum ieee80211_state, int);
        void                            (*bmiss)(struct ieee80211vap *);
        void                            (*recv_mgmt)(struct ieee80211_node *,
                                            struct mbuf *, int,
                                            const struct ieee80211_rx_stats *,
                                            int, int);
};
#define RUM_VAP(vap)    ((struct rum_vap *)(vap))

enum {
        RUM_BULK_WR,
        RUM_BULK_RD,
        RUM_N_TRANSFER = 2,
};

struct rum_softc {
        struct ieee80211com             sc_ic;
        struct ieee80211_ratectl_tx_stats sc_txs;
        struct mbufq                    sc_snd;
        device_t                        sc_dev;
        struct usb_device               *sc_udev;

        struct usb_xfer                 *sc_xfer[RUM_N_TRANSFER];

        uint8_t                         rf_rev;
        uint8_t                         rffreq;

        struct rum_tx_data              tx_data[RUM_TX_LIST_COUNT];
        rum_txdhead                     tx_q;
        rum_txdhead                     tx_free;
        int                             tx_nfree;
        struct rum_rx_desc              sc_rx_desc;

        struct mtx                      sc_mtx;

        int                             sc_sleep_end;
        int                             sc_sleep_time;
        uint8_t                         last_rx_flags;

        struct rum_cmdq                 cmdq[RUM_CMDQ_SIZE];
        struct mtx                      cmdq_mtx;
        struct task                     cmdq_task;
        uint8_t                         cmdq_first;
        uint8_t                         cmdq_last;

        uint32_t                        sta[6];
        uint32_t                        rf_regs[4];
        uint8_t                         txpow[44];
        u_int                           sc_detached:1,
                                        sc_running:1,
                                        sc_sleeping:1,
                                        sc_clr_shkeys:1;

        uint8_t                         sc_bssid[IEEE80211_ADDR_LEN];
        struct wmeParams                wme_params[WME_NUM_AC];

        uint8_t                         vap_key_count[1];
        uint64_t                        keys_bmap;

        struct {
                uint8_t val;
                uint8_t reg;
        } __packed                      bbp_prom[16];

        int                             hw_radio;
        int                             rx_ant;
        int                             tx_ant;
        int                             nb_ant;
        int                             ext_2ghz_lna;
        int                             ext_5ghz_lna;
        int                             rssi_2ghz_corr;
        int                             rssi_5ghz_corr;
        uint8_t                         bbp17;

        struct rum_rx_radiotap_header   sc_rxtap;
        struct rum_tx_radiotap_header   sc_txtap;
};

#define RUM_LOCK_INIT(sc) \
        mtx_init(&(sc)->sc_mtx, device_get_nameunit((sc)->sc_dev), \
            MTX_NETWORK_LOCK, MTX_DEF);
#define RUM_LOCK(sc)                    mtx_lock(&(sc)->sc_mtx)
#define RUM_UNLOCK(sc)                  mtx_unlock(&(sc)->sc_mtx)
#define RUM_LOCK_ASSERT(sc)             mtx_assert(&(sc)->sc_mtx, MA_OWNED)
#define RUM_LOCK_DESTROY(sc)            mtx_destroy(&(sc)->sc_mtx)

#define RUM_CMDQ_LOCK_INIT(sc) \
        mtx_init(&(sc)->cmdq_mtx, "cmdq lock", NULL, MTX_DEF)
#define RUM_CMDQ_LOCK(sc)               mtx_lock(&(sc)->cmdq_mtx)
#define RUM_CMDQ_UNLOCK(sc)             mtx_unlock(&(sc)->cmdq_mtx)
#define RUM_CMDQ_LOCK_DESTROY(sc)       mtx_destroy(&(sc)->cmdq_mtx)