/*
 * Copyright (c) 2010 Broadcom Corporation
 *
 * 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.
 */

#ifndef GARNET_DRIVERS_WLAN_THIRD_PARTY_BROADCOM_INCLUDE_BRCMU_D11_H_
#define GARNET_DRIVERS_WLAN_THIRD_PARTY_BROADCOM_INCLUDE_BRCMU_D11_H_

#include <zircon/types.h>

/* d11 io type */
#define BRCMU_D11N_IOTYPE 1
#define BRCMU_D11AC_IOTYPE 2

/* A chanspec (channel specification) holds the channel number, band,
 * bandwidth and control sideband
 */

/* chanspec binary format */

// clang-format off

#define BRCMU_CHSPEC_INVALID 255
/* bit 0~7 channel number
 * for 80+80 channels: bit 0~3 low channel id, bit 4~7 high channel id
 */
#define BRCMU_CHSPEC_CH_MASK     0x00ff
#define BRCMU_CHSPEC_CH_SHIFT    0
#define BRCMU_CHSPEC_CHL_MASK    0x000f
#define BRCMU_CHSPEC_CHL_SHIFT   0
#define BRCMU_CHSPEC_CHH_MASK    0x00f0
#define BRCMU_CHSPEC_CHH_SHIFT   4

/* bit 8~16 for dot 11n IO types
 * bit 8~9 sideband
 * bit 10~11 bandwidth
 * bit 12~13 spectral band
 * bit 14~15 not used
 */
#define BRCMU_CHSPEC_D11N_SB_MASK   0x0300
#define BRCMU_CHSPEC_D11N_SB_SHIFT  8
#define BRCMU_CHSPEC_D11N_SB_L      0x0100 /* control lower */
#define BRCMU_CHSPEC_D11N_SB_U      0x0200 /* control upper */
#define BRCMU_CHSPEC_D11N_SB_N      0x0300 /* none */
#define BRCMU_CHSPEC_D11N_BW_MASK   0x0c00
#define BRCMU_CHSPEC_D11N_BW_SHIFT  10
#define BRCMU_CHSPEC_D11N_BW_10     0x0400
#define BRCMU_CHSPEC_D11N_BW_20     0x0800
#define BRCMU_CHSPEC_D11N_BW_40     0x0c00
#define BRCMU_CHSPEC_D11N_BND_MASK  0x3000
#define BRCMU_CHSPEC_D11N_BND_SHIFT 12
#define BRCMU_CHSPEC_D11N_BND_5G    0x1000
#define BRCMU_CHSPEC_D11N_BND_2G    0x2000

/* bit 8~16 for dot 11ac IO types
 * bit 8~10 sideband
 * bit 11~13 bandwidth
 * bit 14~15 spectral band
 */
#define BRCMU_CHSPEC_D11AC_SB_MASK   0x0700
#define BRCMU_CHSPEC_D11AC_SB_SHIFT  8
#define BRCMU_CHSPEC_D11AC_SB_LLL    0x0000
#define BRCMU_CHSPEC_D11AC_SB_LLU    0x0100
#define BRCMU_CHSPEC_D11AC_SB_LUL    0x0200
#define BRCMU_CHSPEC_D11AC_SB_LUU    0x0300
#define BRCMU_CHSPEC_D11AC_SB_ULL    0x0400
#define BRCMU_CHSPEC_D11AC_SB_ULU    0x0500
#define BRCMU_CHSPEC_D11AC_SB_UUL    0x0600
#define BRCMU_CHSPEC_D11AC_SB_UUU    0x0700
#define BRCMU_CHSPEC_D11AC_SB_LL     BRCMU_CHSPEC_D11AC_SB_LLL
#define BRCMU_CHSPEC_D11AC_SB_LU     BRCMU_CHSPEC_D11AC_SB_LLU
#define BRCMU_CHSPEC_D11AC_SB_UL     BRCMU_CHSPEC_D11AC_SB_LUL
#define BRCMU_CHSPEC_D11AC_SB_UU     BRCMU_CHSPEC_D11AC_SB_LUU
#define BRCMU_CHSPEC_D11AC_SB_L      BRCMU_CHSPEC_D11AC_SB_LLL
#define BRCMU_CHSPEC_D11AC_SB_U      BRCMU_CHSPEC_D11AC_SB_LLU
#define BRCMU_CHSPEC_D11AC_BW_MASK   0x3800
#define BRCMU_CHSPEC_D11AC_BW_SHIFT  11
#define BRCMU_CHSPEC_D11AC_BW_5      0x0000
#define BRCMU_CHSPEC_D11AC_BW_10     0x0800
#define BRCMU_CHSPEC_D11AC_BW_20     0x1000
#define BRCMU_CHSPEC_D11AC_BW_40     0x1800
#define BRCMU_CHSPEC_D11AC_BW_80     0x2000
#define BRCMU_CHSPEC_D11AC_BW_160    0x2800
#define BRCMU_CHSPEC_D11AC_BW_8080   0x3000
#define BRCMU_CHSPEC_D11AC_BND_MASK  0xc000
#define BRCMU_CHSPEC_D11AC_BND_SHIFT 14
#define BRCMU_CHSPEC_D11AC_BND_2G    0x0000
#define BRCMU_CHSPEC_D11AC_BND_3G    0x4000
#define BRCMU_CHSPEC_D11AC_BND_4G    0x8000
#define BRCMU_CHSPEC_D11AC_BND_5G    0xc000

#define BRCMU_CHAN_BAND_2G 0
#define BRCMU_CHAN_BAND_5G 1

// clang-format on

enum brcmu_chan_bw {
    BRCMU_CHAN_BW_20,
    BRCMU_CHAN_BW_40,
    BRCMU_CHAN_BW_80,
    BRCMU_CHAN_BW_80P80,
    BRCMU_CHAN_BW_160,
};

enum brcmu_chan_sb {
    BRCMU_CHAN_SB_NONE = -1,
    BRCMU_CHAN_SB_LLL,
    BRCMU_CHAN_SB_LLU,
    BRCMU_CHAN_SB_LUL,
    BRCMU_CHAN_SB_LUU,
    BRCMU_CHAN_SB_ULL,
    BRCMU_CHAN_SB_ULU,
    BRCMU_CHAN_SB_UUL,
    BRCMU_CHAN_SB_UUU,
    BRCMU_CHAN_SB_L = BRCMU_CHAN_SB_LLL,
    BRCMU_CHAN_SB_U = BRCMU_CHAN_SB_LLU,
    BRCMU_CHAN_SB_LL = BRCMU_CHAN_SB_LLL,
    BRCMU_CHAN_SB_LU = BRCMU_CHAN_SB_LLU,
    BRCMU_CHAN_SB_UL = BRCMU_CHAN_SB_LUL,
    BRCMU_CHAN_SB_UU = BRCMU_CHAN_SB_LUU,
};

/**
 * struct brcmu_chan - stores channel formats
 *
 * This structure can be used with functions translating chanspec into generic
 * channel info and the other way.
 *
 * @chspec: firmware specific format
 * @chnum: center channel number
 * @control_ch_num: control channel number
 * @band: frequency band
 * @bw: channel width
 * @sb: control sideband (location of control channel against the center one)
 */
struct brcmu_chan {
    uint16_t chspec;
    uint8_t chnum;
    uint8_t control_ch_num;
    uint8_t band;
    enum brcmu_chan_bw bw;
    enum brcmu_chan_sb sb;
};

/**
 * struct brcmu_d11inf - provides functions translating channel format
 *
 * @io_type: determines version of channel format used by firmware
 * @encchspec: encodes channel info into a chanspec, requires center channel
 *  number, ignores control one
 * @decchspec: decodes chanspec into generic info
 */
struct brcmu_d11inf {
    uint8_t io_type;

    void (*encchspec)(struct brcmu_chan* ch);
    void (*decchspec)(struct brcmu_chan* ch);
};

void brcmu_d11_attach(struct brcmu_d11inf* d11inf);

#endif /* GARNET_DRIVERS_WLAN_THIRD_PARTY_BROADCOM_INCLUDE_BRCMU_D11_H_ */