/*
 * Copyright (c) 2010-2011 Atheros Communications Inc.
 * Copyright (c) 2011-2012 Qualcomm Atheros, Inc.
 *
 * Permission to use, copy, modify, and/or 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.
 */

/*
 * This file contains the definitions of the WMI protocol specified in the
 * Wireless Module Interface (WMI).  It includes definitions of all the
 * commands and events. Commands are messages from the host to the WM.
 * Events and Replies are messages from the WM to the host.
 */

#ifndef WMI_H
#define WMI_H

#include <linux/ieee80211.h>

#include "htc.h"

#define HTC_PROTOCOL_VERSION            0x0002
#define WMI_PROTOCOL_VERSION            0x0002
#define WMI_CONTROL_MSG_MAX_LEN         256
#define is_ethertype(type_or_len)       ((type_or_len) >= 0x0600)

#define IP_ETHERTYPE            0x0800

#define WMI_IMPLICIT_PSTREAM    0xFF
#define WMI_MAX_THINSTREAM      15

#define SSID_IE_LEN_INDEX       13

/* Host side link management data structures */
#define SIG_QUALITY_THRESH_LVLS         6
#define SIG_QUALITY_UPPER_THRESH_LVLS   SIG_QUALITY_THRESH_LVLS
#define SIG_QUALITY_LOWER_THRESH_LVLS   SIG_QUALITY_THRESH_LVLS

#define A_BAND_24GHZ           0
#define A_BAND_5GHZ            1
#define ATH6KL_NUM_BANDS       2

/* in ms */
#define WMI_IMPLICIT_PSTREAM_INACTIVITY_INT 5000

/*
 * There are no signed versions of __le16 and __le32, so for a temporary
 * solution come up with our own version. The idea is from fs/ntfs/types.h.
 *
 * Use a_ prefix so that it doesn't conflict if we get proper support to
 * linux/types.h.
 */
typedef __s16 __bitwise a_sle16;
typedef __s32 __bitwise a_sle32;

static inline a_sle32 a_cpu_to_sle32(s32 val)
{
        return (__force a_sle32) cpu_to_le32(val);
}

static inline s32 a_sle32_to_cpu(a_sle32 val)
{
        return le32_to_cpu((__force __le32) val);
}

static inline a_sle16 a_cpu_to_sle16(s16 val)
{
        return (__force a_sle16) cpu_to_le16(val);
}

static inline s16 a_sle16_to_cpu(a_sle16 val)
{
        return le16_to_cpu((__force __le16) val);
}

struct sq_threshold_params {
        s16 upper_threshold[SIG_QUALITY_UPPER_THRESH_LVLS];
        s16 lower_threshold[SIG_QUALITY_LOWER_THRESH_LVLS];
        u32 upper_threshold_valid_count;
        u32 lower_threshold_valid_count;
        u32 polling_interval;
        u8 weight;
        u8 last_rssi;
        u8 last_rssi_poll_event;
};

struct wmi_data_sync_bufs {
        u8 traffic_class;
        struct sk_buff *skb;
};

/* WMM stream classes */
#define WMM_NUM_AC  4
#define WMM_AC_BE   0           /* best effort */
#define WMM_AC_BK   1           /* background */
#define WMM_AC_VI   2           /* video */
#define WMM_AC_VO   3           /* voice */

#define WMI_VOICE_USER_PRIORITY         0x7

struct wmi {
        u16 stream_exist_for_ac[WMM_NUM_AC];
        u8 fat_pipe_exist;
        struct ath6kl *parent_dev;
        u8 pwr_mode;

        /* protects fat_pipe_exist and stream_exist_for_ac */
        spinlock_t lock;
        enum htc_endpoint_id ep_id;
        struct sq_threshold_params
            sq_threshld[SIGNAL_QUALITY_METRICS_NUM_MAX];
        bool is_wmm_enabled;
        u8 traffic_class;
        bool is_probe_ssid;

        u8 *last_mgmt_tx_frame;
        size_t last_mgmt_tx_frame_len;
        u8 saved_pwr_mode;
};

struct host_app_area {
        __le32 wmi_protocol_ver;
} __packed;

enum wmi_msg_type {
        DATA_MSGTYPE = 0x0,
        CNTL_MSGTYPE,
        SYNC_MSGTYPE,
        OPT_MSGTYPE,
};

/*
 * Macros for operating on WMI_DATA_HDR (info) field
 */

#define WMI_DATA_HDR_MSG_TYPE_MASK  0x03
#define WMI_DATA_HDR_MSG_TYPE_SHIFT 0
#define WMI_DATA_HDR_UP_MASK        0x07
#define WMI_DATA_HDR_UP_SHIFT       2

/* In AP mode, the same bit (b5) is used to indicate Power save state in
 * the Rx dir and More data bit state in the tx direction.
 */
#define WMI_DATA_HDR_PS_MASK        0x1
#define WMI_DATA_HDR_PS_SHIFT       5

#define WMI_DATA_HDR_MORE       0x20

enum wmi_data_hdr_data_type {
        WMI_DATA_HDR_DATA_TYPE_802_3 = 0,
        WMI_DATA_HDR_DATA_TYPE_802_11,

        /* used to be used for the PAL */
        WMI_DATA_HDR_DATA_TYPE_ACL,
};

/* Bitmap of data header flags */
enum wmi_data_hdr_flags {
        WMI_DATA_HDR_FLAGS_MORE = 0x1,
        WMI_DATA_HDR_FLAGS_EOSP = 0x2,
        WMI_DATA_HDR_FLAGS_UAPSD = 0x4,
};

#define WMI_DATA_HDR_DATA_TYPE_MASK     0x3
#define WMI_DATA_HDR_DATA_TYPE_SHIFT    6

/* Macros for operating on WMI_DATA_HDR (info2) field */
#define WMI_DATA_HDR_SEQNO_MASK     0xFFF
#define WMI_DATA_HDR_SEQNO_SHIFT    0

#define WMI_DATA_HDR_AMSDU_MASK     0x1
#define WMI_DATA_HDR_AMSDU_SHIFT    12

#define WMI_DATA_HDR_META_MASK      0x7
#define WMI_DATA_HDR_META_SHIFT     13

#define WMI_DATA_HDR_PAD_BEFORE_DATA_MASK               0xFF
#define WMI_DATA_HDR_PAD_BEFORE_DATA_SHIFT              0x8

/* Macros for operating on WMI_DATA_HDR (info3) field */
#define WMI_DATA_HDR_IF_IDX_MASK    0xF

#define WMI_DATA_HDR_TRIG           0x10
#define WMI_DATA_HDR_EOSP           0x10

struct wmi_data_hdr {
        s8 rssi;

        /*
         * usage of 'info' field(8-bit):
         *
         *  b1:b0       - WMI_MSG_TYPE
         *  b4:b3:b2    - UP(tid)
         *  b5          - Used in AP mode.
         *  More-data in tx dir, PS in rx.
         *  b7:b6       - Dot3 header(0),
         *                Dot11 Header(1),
         *                ACL data(2)
         */
        u8 info;

        /*
         * usage of 'info2' field(16-bit):
         *
         * b11:b0       - seq_no
         * b12          - A-MSDU?
         * b15:b13      - META_DATA_VERSION 0 - 7
         */
        __le16 info2;

        /*
         * usage of info3, 16-bit:
         * b3:b0        - Interface index
         * b4           - uAPSD trigger in rx & EOSP in tx
         * b15:b5       - Reserved
         */
        __le16 info3;
} __packed;

static inline u8 wmi_data_hdr_get_up(struct wmi_data_hdr *dhdr)
{
        return (dhdr->info >> WMI_DATA_HDR_UP_SHIFT) & WMI_DATA_HDR_UP_MASK;
}

static inline void wmi_data_hdr_set_up(struct wmi_data_hdr *dhdr,
                                       u8 usr_pri)
{
        dhdr->info &= ~(WMI_DATA_HDR_UP_MASK << WMI_DATA_HDR_UP_SHIFT);
        dhdr->info |= usr_pri << WMI_DATA_HDR_UP_SHIFT;
}

static inline u8 wmi_data_hdr_get_dot11(struct wmi_data_hdr *dhdr)
{
        u8 data_type;

        data_type = (dhdr->info >> WMI_DATA_HDR_DATA_TYPE_SHIFT) &
                                   WMI_DATA_HDR_DATA_TYPE_MASK;
        return (data_type == WMI_DATA_HDR_DATA_TYPE_802_11);
}

static inline u16 wmi_data_hdr_get_seqno(struct wmi_data_hdr *dhdr)
{
        return (le16_to_cpu(dhdr->info2) >> WMI_DATA_HDR_SEQNO_SHIFT) &
                                WMI_DATA_HDR_SEQNO_MASK;
}

static inline u8 wmi_data_hdr_is_amsdu(struct wmi_data_hdr *dhdr)
{
        return (le16_to_cpu(dhdr->info2) >> WMI_DATA_HDR_AMSDU_SHIFT) &
                               WMI_DATA_HDR_AMSDU_MASK;
}

static inline u8 wmi_data_hdr_get_meta(struct wmi_data_hdr *dhdr)
{
        return (le16_to_cpu(dhdr->info2) >> WMI_DATA_HDR_META_SHIFT) &
                               WMI_DATA_HDR_META_MASK;
}

static inline u8 wmi_data_hdr_get_if_idx(struct wmi_data_hdr *dhdr)
{
        return le16_to_cpu(dhdr->info3) & WMI_DATA_HDR_IF_IDX_MASK;
}

/* Tx meta version definitions */
#define WMI_MAX_TX_META_SZ      12
#define WMI_META_VERSION_1      0x01
#define WMI_META_VERSION_2      0x02

/* Flag to signal to FW to calculate TCP checksum */
#define WMI_META_V2_FLAG_CSUM_OFFLOAD 0x01

struct wmi_tx_meta_v1 {
        /* packet ID to identify the tx request */
        u8 pkt_id;

        /* rate policy to be used for the tx of this frame */
        u8 rate_plcy_id;
} __packed;

struct wmi_tx_meta_v2 {
        /*
         * Offset from start of the WMI header for csum calculation to
         * begin.
         */
        u8 csum_start;

        /* offset from start of WMI header where final csum goes */
        u8 csum_dest;

        /* no of bytes over which csum is calculated */
        u8 csum_flags;
} __packed;

struct wmi_rx_meta_v1 {
        u8 status;

        /* rate index mapped to rate at which this packet was received. */
        u8 rix;

        /* rssi of packet */
        u8 rssi;

        /* rf channel during packet reception */
        u8 channel;

        __le16 flags;
} __packed;

struct wmi_rx_meta_v2 {
        __le16 csum;

        /* bit 0 set -partial csum valid bit 1 set -test mode */
        u8 csum_flags;
} __packed;

#define WMI_CMD_HDR_IF_ID_MASK 0xF

/* Control Path */
struct wmi_cmd_hdr {
        __le16 cmd_id;

        /* info1 - 16 bits
         * b03:b00 - id
         * b15:b04 - unused */
        __le16 info1;

        /* for alignment */