/* SPDX-License-Identifier: GPL-2.0-or-later */
/*
 * Copyright (c) 2002,2003 Oliver Kurth
 *           (c) 2003,2004 Joerg Albert <joerg.albert@gmx.de>
 *           (c) 2007 Guido Guenther <agx@sigxcpu.org>
 *
 * This driver was based on information from the Sourceforge driver
 * released and maintained by Atmel:
 *
 *  http://sourceforge.net/projects/atmelwlandriver/
 *
 * Although the code was completely re-written,
 * it would have been impossible without Atmel's decision to
 * release an Open Source driver (unfortunately the firmware was
 * kept binary only). Thanks for that decision to Atmel!
 */

#ifndef _AT76_USB_H
#define _AT76_USB_H

/* Board types */
enum board_type {
        BOARD_503_ISL3861 = 1,
        BOARD_503_ISL3863 = 2,
        BOARD_503 = 3,
        BOARD_503_ACC = 4,
        BOARD_505 = 5,
        BOARD_505_2958 = 6,
        BOARD_505A = 7,
        BOARD_505AMX = 8
};

#define CMD_STATUS_IDLE                         0x00
#define CMD_STATUS_COMPLETE                     0x01
#define CMD_STATUS_UNKNOWN                      0x02
#define CMD_STATUS_INVALID_PARAMETER            0x03
#define CMD_STATUS_FUNCTION_NOT_SUPPORTED       0x04
#define CMD_STATUS_TIME_OUT                     0x07
#define CMD_STATUS_IN_PROGRESS                  0x08
#define CMD_STATUS_HOST_FAILURE                 0xff
#define CMD_STATUS_SCAN_FAILED                  0xf0

/* answers to get op mode */
#define OPMODE_NONE                             0x00
#define OPMODE_NORMAL_NIC_WITH_FLASH            0x01
#define OPMODE_HW_CONFIG_MODE                   0x02
#define OPMODE_DFU_MODE_WITH_FLASH              0x03
#define OPMODE_NORMAL_NIC_WITHOUT_FLASH         0x04

#define CMD_SET_MIB             0x01
#define CMD_GET_MIB             0x02
#define CMD_SCAN                0x03
#define CMD_JOIN                0x04
#define CMD_START_IBSS          0x05
#define CMD_RADIO_ON            0x06
#define CMD_RADIO_OFF           0x07
#define CMD_STARTUP             0x0B

#define MIB_LOCAL               0x01
#define MIB_MAC_ADDR            0x02
#define MIB_MAC                 0x03
#define MIB_MAC_MGMT            0x05
#define MIB_MAC_WEP             0x06
#define MIB_PHY                 0x07
#define MIB_FW_VERSION          0x08
#define MIB_MDOMAIN             0x09

#define ADHOC_MODE              1
#define INFRASTRUCTURE_MODE     2

/* values for struct mib_local, field preamble_type */
#define PREAMBLE_TYPE_LONG      0
#define PREAMBLE_TYPE_SHORT     1
#define PREAMBLE_TYPE_AUTO      2

/* values for tx_rate */
#define TX_RATE_1MBIT           0
#define TX_RATE_2MBIT           1
#define TX_RATE_5_5MBIT         2
#define TX_RATE_11MBIT          3
#define TX_RATE_AUTO            4

/* power management modes */
#define AT76_PM_OFF             1
#define AT76_PM_ON              2
#define AT76_PM_SMART           3

struct hwcfg_r505 {
        u8 cr39_values[14];
        u8 reserved1[14];
        u8 bb_cr[14];
        u8 pidvid[4];
        u8 mac_addr[ETH_ALEN];
        u8 regulatory_domain;
        u8 reserved2[14];
        u8 cr15_values[14];
        u8 reserved3[3];
} __packed;

struct hwcfg_rfmd {
        u8 cr20_values[14];
        u8 cr21_values[14];
        u8 bb_cr[14];
        u8 pidvid[4];
        u8 mac_addr[ETH_ALEN];
        u8 regulatory_domain;
        u8 low_power_values[14];
        u8 normal_power_values[14];
        u8 reserved1[3];
} __packed;

struct hwcfg_intersil {
        u8 mac_addr[ETH_ALEN];
        u8 cr31_values[14];
        u8 cr58_values[14];
        u8 pidvid[4];
        u8 regulatory_domain;
        u8 reserved[1];
} __packed;

union at76_hwcfg {
        struct hwcfg_intersil i;
        struct hwcfg_rfmd r3;
        struct hwcfg_r505 r5;
};

#define WEP_SMALL_KEY_LEN       (40 / 8)
#define WEP_LARGE_KEY_LEN       (104 / 8)
#define WEP_KEYS                (4)

struct at76_card_config {
        u8 exclude_unencrypted;
        u8 promiscuous_mode;
        u8 short_retry_limit;
        u8 encryption_type;
        __le16 rts_threshold;
        __le16 fragmentation_threshold; /* 256..2346 */
        u8 basic_rate_set[4];
        u8 auto_rate_fallback;  /* 0,1 */
        u8 channel;
        u8 privacy_invoked;
        u8 wep_default_key_id;  /* 0..3 */
        u8 current_ssid[32];
        u8 wep_default_key_value[4][WEP_LARGE_KEY_LEN];
        u8 ssid_len;
        u8 short_preamble;
        __le16 beacon_period;
} __packed;

struct at76_command {
        u8 cmd;
        u8 reserved;
        __le16 size;
        u8 data[] __counted_by_le(size);
} __packed;

/* Length of Atmel-specific Rx header before 802.11 frame */
#define AT76_RX_HDRLEN offsetof(struct at76_rx_buffer, packet)

struct at76_rx_buffer {
        __le16 wlength;
        u8 rx_rate;
        u8 newbss;
        u8 fragmentation;
        u8 rssi;
        u8 link_quality;
        u8 noise_level;
        __le32 rx_time;
        u8 packet[IEEE80211_MAX_FRAG_THRESHOLD];
} __packed;

/* Length of Atmel-specific Tx header before 802.11 frame */
#define AT76_TX_HDRLEN offsetof(struct at76_tx_buffer, packet)

struct at76_tx_buffer {
        __le16 wlength;
        u8 tx_rate;
        u8 padding;
        u8 reserved[4];
        u8 packet[IEEE80211_MAX_FRAG_THRESHOLD];
} __packed;

/* defines for scan_type below */
#define SCAN_TYPE_ACTIVE        0
#define SCAN_TYPE_PASSIVE       1

struct at76_req_scan {
        u8 bssid[ETH_ALEN];
        u8 essid[32];
        u8 scan_type;
        u8 channel;
        __le16 probe_delay;
        __le16 min_channel_time;
        __le16 max_channel_time;
        u8 essid_size;
        u8 international_scan;
} __packed;

struct at76_req_ibss {
        u8 bssid[ETH_ALEN];
        u8 essid[32];
        u8 bss_type;
        u8 channel;
        u8 essid_size;
        u8 reserved[3];
} __packed;

struct at76_req_join {
        u8 bssid[ETH_ALEN];
        u8 essid[32];
        u8 bss_type;
        u8 channel;
        __le16 timeout;
        u8 essid_size;
        u8 reserved;
} __packed;

struct mib_local {
        u16 reserved0;
        u8 beacon_enable;
        u8 txautorate_fallback;
        u8 reserved1;
        u8 ssid_size;
        u8 promiscuous_mode;
        u16 reserved2;
        u8 preamble_type;
        u16 reserved3;
} __packed;

struct mib_mac_addr {
        u8 mac_addr[ETH_ALEN];
        u8 res[2];              /* ??? */
        u8 group_addr[4][ETH_ALEN];
        u8 group_addr_status[4];
} __packed;

struct mib_mac {
        __le32 max_tx_msdu_lifetime;
        __le32 max_rx_lifetime;
        __le16 frag_threshold;
        __le16 rts_threshold;
        __le16 cwmin;
        __le16 cwmax;
        u8 short_retry_time;
        u8 long_retry_time;
        u8 scan_type;           /* active or passive */
        u8 scan_channel;
        __le16 probe_delay;     /* delay before ProbeReq in active scan, RO */
        __le16 min_channel_time;
        __le16 max_channel_time;
        __le16 listen_interval;
        u8 desired_ssid[32];
        u8 desired_bssid[ETH_ALEN];
        u8 desired_bsstype;     /* ad-hoc or infrastructure */
        u8 reserved2;
} __packed;

struct mib_mac_mgmt {
        __le16 beacon_period;
        __le16 CFP_max_duration;
        __le16 medium_occupancy_limit;
        __le16 station_id;      /* assoc id */
        __le16 ATIM_window;
        u8 CFP_mode;
        u8 privacy_option_implemented;
        u8 DTIM_period;
        u8 CFP_period;
        u8 current_bssid[ETH_ALEN];
        u8 current_essid[32];
        u8 current_bss_type;
        u8 power_mgmt_mode;
        /* rfmd and 505 */
        u8 ibss_change;
        u8 res;
        u8 multi_domain_capability_implemented;
        u8 multi_domain_capability_enabled;
        u8 country_string[IEEE80211_COUNTRY_STRING_LEN];
        u8 reserved[3];
} __packed;

struct mib_mac_wep {
        u8 privacy_invoked;     /* 0 disable encr., 1 enable encr */
        u8 wep_default_key_id;
        u8 wep_key_mapping_len;
        u8 exclude_unencrypted;
        __le32 wep_icv_error_count;
        __le32 wep_excluded_count;
        u8 wep_default_keyvalue[WEP_KEYS][WEP_LARGE_KEY_LEN];
        u8 encryption_level;    /* 1 for 40bit, 2 for 104bit encryption */
} __packed;

struct mib_phy {
        __le32 ed_threshold;

        __le16 slot_time;
        __le16 sifs_time;
        __le16 preamble_length;
        __le16 plcp_header_length;
        __le16 mpdu_max_length;
        __le16 cca_mode_supported;

        u8 operation_rate_set[4];
        u8 channel_id;
        u8 current_cca_mode;
        u8 phy_type;
        u8 current_reg_domain;
} __packed;

struct mib_fw_version {
        u8 major;
        u8 minor;
        u8 patch;
        u8 build;
} __packed;

struct mib_mdomain {
        u8 tx_powerlevel[14];
        u8 channel_list[14];    /* 0 for invalid channels */
} __packed;

struct set_mib_buffer {
        u8 type;
        u8 size;
        u8 index;
        u8 reserved;
        union {
                u8 byte;
                __le16 word;
                u8 addr[ETH_ALEN];
                struct mib_mac_wep wep_mib;
        } data;
} __packed;

struct at76_fw_header {
        __le32 crc;             /* CRC32 of the whole image */
        __le32 board_type;      /* firmware compatibility code */
        u8 build;               /* firmware build number */
        u8 patch;               /* firmware patch level */
        u8 minor;               /* firmware minor version */
        u8 major;               /* firmware major version */
        __le32 str_offset;      /* offset of the copyright string */
        __le32 int_fw_offset;   /* internal firmware image offset */
        __le32 int_fw_len;      /* internal firmware image length */
        __le32 ext_fw_offset;   /* external firmware image offset */
        __le32 ext_fw_len;      /* external firmware image length */
} __packed;

/* a description of a regulatory domain and the allowed channels */
struct reg_domain {
        u16 code;
        char const *name;
        u32 channel_map;        /* if bit N is set, channel (N+1) is allowed */
};

/* Data for one loaded firmware file */
struct fwentry {
        const char *const fwname;
        const struct firmware *fw;
        int extfw_size;
        int intfw_size;
        /* pointer to loaded firmware, no need to free */
        u8 *extfw;              /* external firmware, extfw_size bytes long */
        u8 *intfw;              /* internal firmware, intfw_size bytes long */
        enum board_type board_type;     /* board type */
        struct mib_fw_version fw_version;
        int loaded;             /* Loaded and parsed successfully */
};

struct at76_priv {
        struct usb_device *udev;        /* USB device pointer */

        struct sk_buff *rx_skb; /* skbuff for receiving data */
        struct sk_buff *tx_skb; /* skbuff for transmitting data */
        void *bulk_out_buffer;  /* buffer for sending data */

        struct urb *tx_urb;     /* URB for sending data */
        struct urb *rx_urb;     /* URB for receiving data */

        unsigned int tx_pipe;   /* bulk out pipe */
        unsigned int rx_pipe;   /* bulk in pipe */

        struct mutex mtx;       /* locks this structure */

        /* work queues */
        struct work_struct work_set_promisc;
        struct work_struct work_submit_rx;
        struct work_struct work_join_bssid;
        struct delayed_work dwork_hw_scan;

        struct tasklet_struct rx_tasklet;

        /* the WEP stuff */
        int wep_enabled;        /* 1 if WEP is enabled */
        int wep_key_id;         /* key id to be used */
        u8 wep_keys[WEP_KEYS][WEP_LARGE_KEY_LEN];       /* WEP keys */
        u8 wep_keys_len[WEP_KEYS];      /* length of WEP keys */

        int channel;
        int iw_mode;
        u8 bssid[ETH_ALEN];
        u8 essid[IW_ESSID_MAX_SIZE];
        int essid_size;
        int radio_on;
        int promisc;

        int preamble_type;      /* 0 - long, 1 - short, 2 - auto */
        int auth_mode;          /* authentication type: 0 open, 1 shared key */
        int txrate;             /* 0,1,2,3 = 1,2,5.5,11 Mbps, 4 is auto */
        int frag_threshold;     /* threshold for fragmentation of tx packets */
        int rts_threshold;      /* threshold for RTS mechanism */
        int short_retry_limit;

        int scan_min_time;      /* scan min channel time */
        int scan_max_time;      /* scan max channel time */
        int scan_mode;          /* SCAN_TYPE_ACTIVE, SCAN_TYPE_PASSIVE */
        int scan_need_any;      /* if set, need to scan for any ESSID */
        bool scanning;          /* if set, the scan is running */

        u16 assoc_id;           /* current association ID, if associated */

        u8 pm_mode;             /* power management mode */
        u32 pm_period;          /* power management period in microseconds */

        struct reg_domain const *domain;        /* reg domain description */

        /* These fields contain HW config provided by the device (not all of
         * these fields are used by all board types) */
        u8 mac_addr[ETH_ALEN];
        u8 regulatory_domain;

        struct at76_card_config card_config;

        enum board_type board_type;
        struct mib_fw_version fw_version;

        unsigned int device_unplugged:1;
        unsigned int netdev_registered:1;
        struct set_mib_buffer mib_buf;  /* global buffer for set_mib calls */

        int beacon_period;      /* period of mgmt beacons, Kus */

        struct ieee80211_hw *hw;
        int mac80211_registered;
};

#define AT76_SUPPORTED_FILTERS 0

#define SCAN_POLL_INTERVAL      (HZ / 4)

#define CMD_COMPLETION_TIMEOUT  (5 * HZ)

#define DEF_RTS_THRESHOLD       1536
#define DEF_FRAG_THRESHOLD      1536
#define DEF_SHORT_RETRY_LIMIT   8
#define DEF_CHANNEL             10
#define DEF_SCAN_MIN_TIME       10
#define DEF_SCAN_MAX_TIME       120

/* the max padding size for tx in bytes (see calc_padding) */
#define MAX_PADDING_SIZE        53

#endif                          /* _AT76_USB_H */