Added two wireless drivers: atheros5000.device and realtek8180.device.

[AROS.git] / workbench / devs / networks / atheros5000 / hal / ah.h

/*
 * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
 * Copyright (c) 2002-2008 Atheros Communications, 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.
 *
 * $Id$
 */

#ifndef _ATH_AH_H_
#define _ATH_AH_H_
/*
 * Atheros Hardware Access Layer
 *
 * Clients of the HAL call ath_hal_attach to obtain a reference to an ath_hal
 * structure for use with the device.  Hardware-related operations that
 * follow must call back into the HAL through interface, supplying the
 * reference as the first parameter.
 */

/*
 * Bus i/o type definitions.  We define a platform-independent
 * set of types that are mapped to platform-dependent data for
 * register read/write operations.  We use types that are large
 * enough to hold a pointer; smaller data should fit and only
 * require type coercion to work.  Larger data can be stored
 * elsewhere and a reference passed for the bus tag and/or handle.
 */
typedef void* HAL_SOFTC;                /* pointer to driver/OS state */
typedef void* HAL_BUS_TAG;              /* opaque bus i/o id tag */
typedef void* HAL_BUS_HANDLE;           /* opaque bus i/o handle */

#include "ah_osdep.h"

/*
 * __ahdecl is analogous to _cdecl; it defines the calling
 * convention used within the HAL.  For most systems this
 * can just default to be empty and the compiler will (should)
 * use _cdecl.  For systems where _cdecl is not compatible this
 * must be defined.  See linux/ah_osdep.h for an example.
 */
#ifndef __ahdecl
#define __ahdecl
#endif

/*
 * Status codes that may be returned by the HAL.  Note that
 * interfaces that return a status code set it only when an
 * error occurs--i.e. you cannot check it for success.
 */
typedef enum {
        HAL_OK          = 0,    /* No error */
        HAL_ENXIO       = 1,    /* No hardware present */
        HAL_ENOMEM      = 2,    /* Memory allocation failed */
        HAL_EIO         = 3,    /* Hardware didn't respond as expected */
        HAL_EEMAGIC     = 4,    /* EEPROM magic number invalid */
        HAL_EEVERSION   = 5,    /* EEPROM version invalid */
        HAL_EELOCKED    = 6,    /* EEPROM unreadable */
        HAL_EEBADSUM    = 7,    /* EEPROM checksum invalid */
        HAL_EEREAD      = 8,    /* EEPROM read problem */
        HAL_EEBADMAC    = 9,    /* EEPROM mac address invalid */
        HAL_EESIZE      = 10,   /* EEPROM size not supported */
        HAL_EEWRITE     = 11,   /* Attempt to change write-locked EEPROM */
        HAL_EINVAL      = 12,   /* Invalid parameter to function */
        HAL_ENOTSUPP    = 13,   /* Hardware revision not supported */
        HAL_ESELFTEST   = 14,   /* Hardware self-test failed */
        HAL_EINPROGRESS = 15,   /* Operation incomplete */
} HAL_STATUS;

typedef enum {
        AH_FALSE = 0,           /* NB: lots of code assumes false is zero */
        AH_TRUE  = 1,
} HAL_BOOL;

typedef enum {
        HAL_CAP_REG_DMN         = 0,    /* current regulatory domain */
        HAL_CAP_CIPHER          = 1,    /* hardware supports cipher */
        HAL_CAP_TKIP_MIC        = 2,    /* handle TKIP MIC in hardware */
        HAL_CAP_TKIP_SPLIT      = 3,    /* hardware TKIP uses split keys */
        HAL_CAP_PHYCOUNTERS     = 4,    /* hardware PHY error counters */
        HAL_CAP_DIVERSITY       = 5,    /* hardware supports fast diversity */
        HAL_CAP_KEYCACHE_SIZE   = 6,    /* number of entries in key cache */
        HAL_CAP_NUM_TXQUEUES    = 7,    /* number of hardware xmit queues */
        HAL_CAP_VEOL            = 9,    /* hardware supports virtual EOL */
        HAL_CAP_PSPOLL          = 10,   /* hardware has working PS-Poll support */
        HAL_CAP_DIAG            = 11,   /* hardware diagnostic support */
        HAL_CAP_COMPRESSION     = 12,   /* hardware supports compression */
        HAL_CAP_BURST           = 13,   /* hardware supports packet bursting */
        HAL_CAP_FASTFRAME       = 14,   /* hardware supoprts fast frames */
        HAL_CAP_TXPOW           = 15,   /* global tx power limit  */
        HAL_CAP_TPC             = 16,   /* per-packet tx power control  */
        HAL_CAP_PHYDIAG         = 17,   /* hardware phy error diagnostic */
        HAL_CAP_BSSIDMASK       = 18,   /* hardware supports bssid mask */
        HAL_CAP_MCAST_KEYSRCH   = 19,   /* hardware has multicast key search */
        HAL_CAP_TSF_ADJUST      = 20,   /* hardware has beacon tsf adjust */
        /* 21 was HAL_CAP_XR */
        HAL_CAP_WME_TKIPMIC     = 22,   /* hardware can support TKIP MIC when WMM is turned on */
        HAL_CAP_CHAN_HALFRATE   = 23,   /* hardware can support half rate channels */
        HAL_CAP_CHAN_QUARTERRATE = 24,  /* hardware can support quarter rate channels */
        HAL_CAP_RFSILENT        = 25,   /* hardware has rfsilent support  */
        HAL_CAP_TPC_ACK         = 26,   /* ack txpower with per-packet tpc */
        HAL_CAP_TPC_CTS         = 27,   /* cts txpower with per-packet tpc */
        HAL_CAP_11D             = 28,   /* 11d beacon support for changing cc */
        HAL_CAP_INTMIT          = 29,   /* interference mitigation */
        HAL_CAP_RXORN_FATAL     = 30,   /* HAL_INT_RXORN treated as fatal */
        HAL_CAP_HT              = 31,   /* hardware can support HT */
        HAL_CAP_TX_CHAINMASK    = 32,   /* mask of TX chains supported */
        HAL_CAP_RX_CHAINMASK    = 33,   /* mask of RX chains supported */
        HAL_CAP_RXTSTAMP_PREC   = 34,   /* rx desc tstamp precision (bits) */
        HAL_CAP_BB_HANG         = 35,   /* can baseband hang */
        HAL_CAP_MAC_HANG        = 36,   /* can MAC hang */
} HAL_CAPABILITY_TYPE;

/* 
 * "States" for setting the LED.  These correspond to
 * the possible 802.11 operational states and there may
 * be a many-to-one mapping between these states and the
 * actual hardware state for the LED's (i.e. the hardware
 * may have fewer states).
 */
typedef enum {
        HAL_LED_INIT    = 0,
        HAL_LED_SCAN    = 1,
        HAL_LED_AUTH    = 2,
        HAL_LED_ASSOC   = 3,
        HAL_LED_RUN     = 4
} HAL_LED_STATE;

/*
 * Transmit queue types/numbers.  These are used to tag
 * each transmit queue in the hardware and to identify a set
 * of transmit queues for operations such as start/stop dma.
 */
typedef enum {
        HAL_TX_QUEUE_INACTIVE   = 0,            /* queue is inactive/unused */
        HAL_TX_QUEUE_DATA       = 1,            /* data xmit q's */
        HAL_TX_QUEUE_BEACON     = 2,            /* beacon xmit q */
        HAL_TX_QUEUE_CAB        = 3,            /* "crap after beacon" xmit q */
        HAL_TX_QUEUE_UAPSD      = 4,            /* u-apsd power save xmit q */
} HAL_TX_QUEUE;

#define HAL_NUM_TX_QUEUES       10              /* max possible # of queues */

/*
 * Transmit queue subtype.  These map directly to
 * WME Access Categories (except for UPSD).  Refer
 * to Table 5 of the WME spec.
 */
typedef enum {
        HAL_WME_AC_BK   = 0,                    /* background access category */
        HAL_WME_AC_BE   = 1,                    /* best effort access category*/
        HAL_WME_AC_VI   = 2,                    /* video access category */
        HAL_WME_AC_VO   = 3,                    /* voice access category */
        HAL_WME_UPSD    = 4,                    /* uplink power save */
} HAL_TX_QUEUE_SUBTYPE;

/*
 * Transmit queue flags that control various
 * operational parameters.
 */
typedef enum {
        /*
         * Per queue interrupt enables.  When set the associated
         * interrupt may be delivered for packets sent through
         * the queue.  Without these enabled no interrupts will
         * be delivered for transmits through the queue.
         */
        HAL_TXQ_TXOKINT_ENABLE     = 0x0001,    /* enable TXOK interrupt */
        HAL_TXQ_TXERRINT_ENABLE    = 0x0001,    /* enable TXERR interrupt */
        HAL_TXQ_TXDESCINT_ENABLE   = 0x0002,    /* enable TXDESC interrupt */
        HAL_TXQ_TXEOLINT_ENABLE    = 0x0004,    /* enable TXEOL interrupt */
        HAL_TXQ_TXURNINT_ENABLE    = 0x0008,    /* enable TXURN interrupt */
        /*
         * Enable hardware compression for packets sent through
         * the queue.  The compression buffer must be setup and
         * packets must have a key entry marked in the tx descriptor.
         */
        HAL_TXQ_COMPRESSION_ENABLE  = 0x0010,   /* enable h/w compression */
        /*
         * Disable queue when veol is hit or ready time expires.
         * By default the queue is disabled only on reaching the
         * physical end of queue (i.e. a null link ptr in the
         * descriptor chain).
         */
        HAL_TXQ_RDYTIME_EXP_POLICY_ENABLE = 0x0020,
        /*
         * Schedule frames on delivery of a DBA (DMA Beacon Alert)
         * event.  Frames will be transmitted only when this timer
         * fires, e.g to transmit a beacon in ap or adhoc modes.
         */
        HAL_TXQ_DBA_GATED           = 0x0040,   /* schedule based on DBA */
        /*
         * Each transmit queue has a counter that is incremented
         * each time the queue is enabled and decremented when
         * the list of frames to transmit is traversed (or when
         * the ready time for the queue expires).  This counter
         * must be non-zero for frames to be scheduled for
         * transmission.  The following controls disable bumping
         * this counter under certain conditions.  Typically this
         * is used to gate frames based on the contents of another
         * queue (e.g. CAB traffic may only follow a beacon frame).
         * These are meaningful only when frames are scheduled
         * with a non-ASAP policy (e.g. DBA-gated).
         */
        HAL_TXQ_CBR_DIS_QEMPTY      = 0x0080,   /* disable on this q empty */
        HAL_TXQ_CBR_DIS_BEMPTY      = 0x0100,   /* disable on beacon q empty */

        /*
         * Fragment burst backoff policy.  Normally the no backoff
         * is done after a successful transmission, the next fragment
         * is sent at SIFS.  If this flag is set backoff is done
         * after each fragment, regardless whether it was ack'd or
         * not, after the backoff count reaches zero a normal channel
         * access procedure is done before the next transmit (i.e.
         * wait AIFS instead of SIFS).
         */
        HAL_TXQ_FRAG_BURST_BACKOFF_ENABLE = 0x00800000,
        /*
         * Disable post-tx backoff following each frame.
         */
        HAL_TXQ_BACKOFF_DISABLE     = 0x00010000, /* disable post backoff  */
        /*
         * DCU arbiter lockout control.  This controls how
         * lower priority tx queues are handled with respect to
         * to a specific queue when multiple queues have frames
         * to send.  No lockout means lower priority queues arbitrate
         * concurrently with this queue.  Intra-frame lockout
         * means lower priority queues are locked out until the
         * current frame transmits (e.g. including backoffs and bursting).
         * Global lockout means nothing lower can arbitrary so
         * long as there is traffic activity on this queue (frames,
         * backoff, etc).
         */
        HAL_TXQ_ARB_LOCKOUT_INTRA   = 0x00020000, /* intra-frame lockout */
        HAL_TXQ_ARB_LOCKOUT_GLOBAL  = 0x00040000, /* full lockout s */

        HAL_TXQ_IGNORE_VIRTCOL      = 0x00080000, /* ignore virt collisions */
        HAL_TXQ_SEQNUM_INC_DIS      = 0x00100000, /* disable seqnum increment */
} HAL_TX_QUEUE_FLAGS;

typedef struct {
        uint32_t        tqi_ver;                /* hal TXQ version */
        HAL_TX_QUEUE_SUBTYPE tqi_subtype;       /* subtype if applicable */
        HAL_TX_QUEUE_FLAGS tqi_qflags;          /* flags (see above) */
        uint32_t        tqi_priority;           /* (not used) */
        uint32_t        tqi_aifs;               /* aifs */
        uint32_t        tqi_cwmin;              /* cwMin */
        uint32_t        tqi_cwmax;              /* cwMax */
        uint16_t        tqi_shretry;            /* rts retry limit */
        uint16_t        tqi_lgretry;            /* long retry limit (not used)*/
        uint32_t        tqi_cbrPeriod;          /* CBR period (us) */
        uint32_t        tqi_cbrOverflowLimit;   /* threshold for CBROVF int */
        uint32_t        tqi_burstTime;          /* max burst duration (us) */
        uint32_t        tqi_readyTime;          /* frame schedule time (us) */
        uint32_t        tqi_compBuf;            /* comp buffer phys addr */
} HAL_TXQ_INFO;

#define HAL_TQI_NONVAL 0xffff

/* token to use for aifs, cwmin, cwmax */
#define HAL_TXQ_USEDEFAULT      ((uint32_t) -1)

/* compression definitions */
#define HAL_COMP_BUF_MAX_SIZE           9216            /* 9K */
#define HAL_COMP_BUF_ALIGN_SIZE         512

/*
 * Transmit packet types.  This belongs in ah_desc.h, but
 * is here so we can give a proper type to various parameters
 * (and not require everyone include the file).
 *
 * NB: These values are intentionally assigned for
 *     direct use when setting up h/w descriptors.
 */
typedef enum {
        HAL_PKT_TYPE_NORMAL     = 0,
        HAL_PKT_TYPE_ATIM       = 1,
        HAL_PKT_TYPE_PSPOLL     = 2,
        HAL_PKT_TYPE_BEACON     = 3,
        HAL_PKT_TYPE_PROBE_RESP = 4,
        HAL_PKT_TYPE_CHIRP      = 5,
        HAL_PKT_TYPE_GRP_POLL   = 6,
        HAL_PKT_TYPE_AMPDU      = 7,
} HAL_PKT_TYPE;

/* Rx Filter Frame Types */
typedef enum {
        HAL_RX_FILTER_UCAST     = 0x00000001,   /* Allow unicast frames */
        HAL_RX_FILTER_MCAST     = 0x00000002,   /* Allow multicast frames */
        HAL_RX_FILTER_BCAST     = 0x00000004,   /* Allow broadcast frames */
        HAL_RX_FILTER_CONTROL   = 0x00000008,   /* Allow control frames */
        HAL_RX_FILTER_BEACON    = 0x00000010,   /* Allow beacon frames */
        HAL_RX_FILTER_PROM      = 0x00000020,   /* Promiscuous mode */
        HAL_RX_FILTER_PROBEREQ  = 0x00000080,   /* Allow probe request frames */
        HAL_RX_FILTER_PHYERR    = 0x00000100,   /* Allow phy errors */
        HAL_RX_FILTER_PHYRADAR  = 0x00000200,   /* Allow phy radar errors */
        HAL_RX_FILTER_COMPBAR   = 0x00000400,   /* Allow compressed BAR */
} HAL_RX_FILTER;

typedef enum {
        HAL_PM_AWAKE            = 0,
        HAL_PM_FULL_SLEEP       = 1,
        HAL_PM_NETWORK_SLEEP    = 2,
        HAL_PM_UNDEFINED        = 3
} HAL_POWER_MODE;

/*
 * NOTE WELL:
 * These are mapped to take advantage of the common locations for many of
 * the bits on all of the currently supported MAC chips. This is to make
 * the ISR as efficient as possible, while still abstracting HW differences.
 * When new hardware breaks this commonality this enumerated type, as well
 * as the HAL functions using it, must be modified. All values are directly
 * mapped unless commented otherwise.
 */
typedef enum {
        HAL_INT_RX      = 0x00000001,   /* Non-common mapping */
        HAL_INT_RXDESC  = 0x00000002,
        HAL_INT_RXNOFRM = 0x00000008,
        HAL_INT_RXEOL   = 0x00000010,
        HAL_INT_RXORN   = 0x00000020,
        HAL_INT_TX      = 0x00000040,   /* Non-common mapping */
        HAL_INT_TXDESC  = 0x00000080,
        HAL_INT_TXURN   = 0x00000800,
        HAL_INT_MIB     = 0x00001000,
        HAL_INT_RXPHY   = 0x00004000,
        HAL_INT_RXKCM   = 0x00008000,
        HAL_INT_SWBA    = 0x00010000,
        HAL_INT_BMISS   = 0x00040000,
        HAL_INT_BNR     = 0x00100000,   /* Non-common mapping */
        HAL_INT_TIM     = 0x00200000,   /* Non-common mapping */
        HAL_INT_DTIM    = 0x00400000,   /* Non-common mapping */
        HAL_INT_DTIMSYNC= 0x00800000,   /* Non-common mapping */
        HAL_INT_GPIO    = 0x01000000,
        HAL_INT_CABEND  = 0x02000000,   /* Non-common mapping */
        HAL_INT_TSFOOR  = 0x04000000,   /* Non-common mapping */
        HAL_INT_CST     = 0x10000000,   /* Non-common mapping */
        HAL_INT_GTT     = 0x20000000,   /* Non-common mapping */
        HAL_INT_FATAL   = 0x40000000,   /* Non-common mapping */
#define HAL_INT_GLOBAL  0x80000000      /* Set/clear IER */
        HAL_INT_BMISC   = HAL_INT_TIM
                        | HAL_INT_DTIM
                        | HAL_INT_DTIMSYNC
                        | HAL_INT_CABEND,

        /* Interrupt bits that map directly to ISR/IMR bits */
        HAL_INT_COMMON  = HAL_INT_RXNOFRM
                        | HAL_INT_RXDESC
                        | HAL_INT_RXEOL
                        | HAL_INT_RXORN
                        | HAL_INT_TXURN
                        | HAL_INT_TXDESC
                        | HAL_INT_MIB
                        | HAL_INT_RXPHY
                        | HAL_INT_RXKCM
                        | HAL_INT_SWBA
                        | HAL_INT_BMISS
                        | HAL_INT_GPIO,
} HAL_INT;

typedef enum {
        HAL_RFGAIN_INACTIVE             = 0,
        HAL_RFGAIN_READ_REQUESTED       = 1,
        HAL_RFGAIN_NEED_CHANGE          = 2
} HAL_RFGAIN;

/*
 * Channels are specified by frequency.
 */
typedef struct {
        uint32_t        channelFlags;   /* see below */
        uint16_t        channel;        /* setting in Mhz */
        uint8_t         privFlags;
        int8_t          maxRegTxPower;  /* max regulatory tx power in dBm */
        int8_t          maxTxPower;     /* max true tx power in 0.5 dBm */
        int8_t          minTxPower;     /* min true tx power in 0.5 dBm */
} HAL_CHANNEL;

/* channelFlags */
#define CHANNEL_CW_INT  0x00002 /* CW interference detected on channel */
#define CHANNEL_TURBO   0x00010 /* Turbo Channel */
#define CHANNEL_CCK     0x00020 /* CCK channel */
#define CHANNEL_OFDM    0x00040 /* OFDM channel */
#define CHANNEL_2GHZ    0x00080 /* 2 GHz spectrum channel */
#define CHANNEL_5GHZ    0x00100 /* 5 GHz spectrum channel */
#define CHANNEL_PASSIVE 0x00200 /* Only passive scan allowed in the channel */
#define CHANNEL_DYN     0x00400 /* dynamic CCK-OFDM channel */
#define CHANNEL_STURBO  0x02000 /* Static turbo, no 11a-only usage */
#define CHANNEL_HALF    0x04000 /* Half rate channel */
#define CHANNEL_QUARTER 0x08000 /* Quarter rate channel */
#define CHANNEL_HT20    0x10000 /* 11n 20MHZ channel */ 
#define CHANNEL_HT40PLUS 0x20000 /* 11n 40MHZ channel w/ ext chan above */
#define CHANNEL_HT40MINUS 0x40000 /* 11n 40MHZ channel w/ ext chan below */

/* privFlags */
#define CHANNEL_INTERFERENCE    0x01 /* Software use: channel interference 
                                        used for as AR as well as RADAR 
                                        interference detection */
#define CHANNEL_DFS             0x02 /* DFS required on channel */
#define CHANNEL_4MS_LIMIT       0x04 /* 4msec packet limit on this channel */
#define CHANNEL_DFS_CLEAR       0x08 /* if channel has been checked for DFS */

#define CHANNEL_A       (CHANNEL_5GHZ|CHANNEL_OFDM)
#define CHANNEL_B       (CHANNEL_2GHZ|CHANNEL_CCK)
#define CHANNEL_PUREG   (CHANNEL_2GHZ|CHANNEL_OFDM)
#ifdef notdef
#define CHANNEL_G       (CHANNEL_2GHZ|CHANNEL_DYN)
#else
#define CHANNEL_G       (CHANNEL_2GHZ|CHANNEL_OFDM)
#endif
#define CHANNEL_T       (CHANNEL_5GHZ|CHANNEL_OFDM|CHANNEL_TURBO)
#define CHANNEL_ST      (CHANNEL_T|CHANNEL_STURBO)
#define CHANNEL_108G    (CHANNEL_2GHZ|CHANNEL_OFDM|CHANNEL_TURBO)
#define CHANNEL_108A    CHANNEL_T
#define CHANNEL_G_HT20          (CHANNEL_G|CHANNEL_HT20)
#define CHANNEL_A_HT20          (CHANNEL_A|CHANNEL_HT20)
#define CHANNEL_G_HT40PLUS      (CHANNEL_G|CHANNEL_HT40PLUS)
#define CHANNEL_G_HT40MINUS     (CHANNEL_G|CHANNEL_HT40MINUS)
#define CHANNEL_A_HT40PLUS      (CHANNEL_A|CHANNEL_HT40PLUS)
#define CHANNEL_A_HT40MINUS     (CHANNEL_A|CHANNEL_HT40MINUS)
#define CHANNEL_ALL \
        (CHANNEL_OFDM | CHANNEL_CCK| CHANNEL_2GHZ | CHANNEL_5GHZ | \
         CHANNEL_TURBO | CHANNEL_HT20 | CHANNEL_HT40PLUS | CHANNEL_HT40MINUS)
#define CHANNEL_ALL_NOTURBO     (CHANNEL_ALL &~ CHANNEL_TURBO)

#define HAL_ANTENNA_MIN_MODE  0
#define HAL_ANTENNA_FIXED_A   1
#define HAL_ANTENNA_FIXED_B   2
#define HAL_ANTENNA_MAX_MODE  3

typedef struct {
        uint32_t        ackrcv_bad;
        uint32_t        rts_bad;
        uint32_t        rts_good;
        uint32_t        fcs_bad;
        uint32_t        beacons;
} HAL_MIB_STATS;

typedef uint16_t HAL_CTRY_CODE;         /* country code */
typedef uint16_t HAL_REG_DOMAIN;                /* regulatory domain code */

enum {
        CTRY_DEBUG      = 0x1ff,                /* debug country code */
        CTRY_DEFAULT    = 0                     /* default country code */
};

enum {
        HAL_MODE_11A    = 0x001,                /* 11a channels */
        HAL_MODE_TURBO  = 0x002,                /* 11a turbo-only channels */
        HAL_MODE_11B    = 0x004,                /* 11b channels */
        HAL_MODE_PUREG  = 0x008,                /* 11g channels (OFDM only) */
#ifdef notdef
        HAL_MODE_11G    = 0x010,                /* 11g channels (OFDM/CCK) */
#else
        HAL_MODE_11G    = 0x008,                /* XXX historical */
#endif
        HAL_MODE_108G   = 0x020,                /* 11g+Turbo channels */
        HAL_MODE_108A   = 0x040,                /* 11a+Turbo channels */
        HAL_MODE_11A_HALF_RATE = 0x200,         /* 11A half rate channels */
        HAL_MODE_11A_QUARTER_RATE = 0x400,      /* 11A quarter rate channels */
        HAL_MODE_11NG_HT20      = 0x008000,
        HAL_MODE_11NA_HT20      = 0x010000,
        HAL_MODE_11NG_HT40PLUS  = 0x020000,
        HAL_MODE_11NG_HT40MINUS = 0x040000,
        HAL_MODE_11NA_HT40PLUS  = 0x080000,
        HAL_MODE_11NA_HT40MINUS = 0x100000,
        HAL_MODE_ALL    = 0xffffff
};

typedef struct {
        int             rateCount;              /* NB: for proper padding */
        uint8_t         rateCodeToIndex[144];   /* back mapping */
        struct {
                uint8_t valid;          /* valid for rate control use */
                uint8_t phy;            /* CCK/OFDM/XR */
                uint32_t        rateKbps;       /* transfer rate in kbs */
                uint8_t         rateCode;       /* rate for h/w descriptors */
                uint8_t         shortPreamble;  /* mask for enabling short
                                                 * preamble in CCK rate code */
                uint8_t         dot11Rate;      /* value for supported rates
                                                 * info element of MLME */
                uint8_t         controlRate;    /* index of next lower basic
                                                 * rate; used for dur. calcs */
                uint16_t        lpAckDuration;  /* long preamble ACK duration */
                uint16_t        spAckDuration;  /* short preamble ACK duration*/
        } info[32];
} HAL_RATE_TABLE;

typedef struct {
        u_int           rs_count;               /* number of valid entries */
        uint8_t rs_rates[32];           /* rates */
} HAL_RATE_SET;

/*
 * 802.11n specific structures and enums
 */
typedef enum {
        HAL_CHAINTYPE_TX        = 1,    /* Tx chain type */
        HAL_CHAINTYPE_RX        = 2,    /* RX chain type */
} HAL_CHAIN_TYPE;

typedef struct {
        u_int   Tries;
        u_int   Rate;
        u_int   PktDuration;
        u_int   ChSel;
        u_int   RateFlags;
#define HAL_RATESERIES_RTS_CTS          0x0001  /* use rts/cts w/this series */
#define HAL_RATESERIES_2040             0x0002  /* use ext channel for series */
#define HAL_RATESERIES_HALFGI           0x0004  /* use half-gi for series */
} HAL_11N_RATE_SERIES;

typedef enum {
        HAL_HT_MACMODE_20       = 0,    /* 20 MHz operation */
        HAL_HT_MACMODE_2040     = 1,    /* 20/40 MHz operation */
} HAL_HT_MACMODE;

typedef enum {
        HAL_HT_PHYMODE_20       = 0,    /* 20 MHz operation */
        HAL_HT_PHYMODE_2040     = 1,    /* 20/40 MHz operation */
} HAL_HT_PHYMODE;

typedef enum {
        HAL_HT_EXTPROTSPACING_20 = 0,   /* 20 MHz spacing */
        HAL_HT_EXTPROTSPACING_25 = 1,   /* 25 MHz spacing */
} HAL_HT_EXTPROTSPACING;


typedef enum {
        HAL_RX_CLEAR_CTL_LOW    = 0x1,  /* force control channel to appear busy */
        HAL_RX_CLEAR_EXT_LOW    = 0x2,  /* force extension channel to appear busy */
} HAL_HT_RXCLEAR;

/*
 * Antenna switch control.  By default antenna selection
 * enables multiple (2) antenna use.  To force use of the
 * A or B antenna only specify a fixed setting.  Fixing
 * the antenna will also disable any diversity support.
 */
typedef enum {
        HAL_ANT_VARIABLE = 0,                   /* variable by programming */
        HAL_ANT_FIXED_A  = 1,                   /* fixed antenna A */
        HAL_ANT_FIXED_B  = 2,                   /* fixed antenna B */
} HAL_ANT_SETTING;

typedef enum {
        HAL_M_STA       = 1,                    /* infrastructure station */
        HAL_M_IBSS      = 0,                    /* IBSS (adhoc) station */
        HAL_M_HOSTAP    = 6,                    /* Software Access Point */
        HAL_M_MONITOR   = 8                     /* Monitor mode */
} HAL_OPMODE;

typedef struct {
        uint8_t         kv_type;                /* one of HAL_CIPHER */
        uint8_t         kv_pad;
        uint16_t        kv_len;                 /* length in bits */
        uint8_t         kv_val[16];             /* enough for 128-bit keys */
        uint8_t         kv_mic[8];              /* TKIP MIC key */
        uint8_t         kv_txmic[8];            /* TKIP TX MIC key (optional) */
} HAL_KEYVAL;

typedef enum {
        HAL_CIPHER_WEP          = 0,
        HAL_CIPHER_AES_OCB      = 1,
        HAL_CIPHER_AES_CCM      = 2,
        HAL_CIPHER_CKIP         = 3,
        HAL_CIPHER_TKIP         = 4,
        HAL_CIPHER_CLR          = 5,            /* no encryption */

        HAL_CIPHER_MIC          = 127           /* TKIP-MIC, not a cipher */
} HAL_CIPHER;

enum {
        HAL_SLOT_TIME_6  = 6,                   /* NB: for turbo mode */
        HAL_SLOT_TIME_9  = 9,
        HAL_SLOT_TIME_20 = 20,
};

/*
 * Per-station beacon timer state.  Note that the specified
 * beacon interval (given in TU's) can also include flags
 * to force a TSF reset and to enable the beacon xmit logic.
 * If bs_cfpmaxduration is non-zero the hardware is setup to
 * coexist with a PCF-capable AP.
 */
typedef struct {
        uint32_t        bs_nexttbtt;            /* next beacon in TU */
        uint32_t        bs_nextdtim;            /* next DTIM in TU */
        uint32_t        bs_intval;              /* beacon interval+flags */
#define HAL_BEACON_PERIOD       0x0000ffff      /* beacon interval period */
#define HAL_BEACON_ENA          0x00800000      /* beacon xmit enable */
#define HAL_BEACON_RESET_TSF    0x01000000      /* clear TSF */
        uint32_t        bs_dtimperiod;
        uint16_t        bs_cfpperiod;           /* CFP period in TU */
        uint16_t        bs_cfpmaxduration;      /* max CFP duration in TU */
        uint32_t        bs_cfpnext;             /* next CFP in TU */
        uint16_t        bs_timoffset;           /* byte offset to TIM bitmap */
        uint16_t        bs_bmissthreshold;      /* beacon miss threshold */
        uint32_t        bs_sleepduration;       /* max sleep duration */
} HAL_BEACON_STATE;

/*
 * Like HAL_BEACON_STATE but for non-station mode setup.
 * NB: see above flag definitions for bt_intval. 
 */
typedef struct {
        uint32_t        bt_intval;              /* beacon interval+flags */
        uint32_t        bt_nexttbtt;            /* next beacon in TU */
        uint32_t        bt_nextatim;            /* next ATIM in TU */
        uint32_t        bt_nextdba;             /* next DBA in 1/8th TU */
        uint32_t        bt_nextswba;            /* next SWBA in 1/8th TU */
        uint32_t        bt_flags;               /* timer enables */
#define HAL_BEACON_TBTT_EN      0x00000001
#define HAL_BEACON_DBA_EN       0x00000002
#define HAL_BEACON_SWBA_EN      0x00000004
} HAL_BEACON_TIMERS;

/*
 * Per-node statistics maintained by the driver for use in
 * optimizing signal quality and other operational aspects.
 */
typedef struct {
        uint32_t        ns_avgbrssi;    /* average beacon rssi */
        uint32_t        ns_avgrssi;     /* average data rssi */
        uint32_t        ns_avgtxrssi;   /* average tx rssi */
} HAL_NODE_STATS;

#define HAL_RSSI_EP_MULTIPLIER  (1<<7)  /* pow2 to optimize out * and / */

struct ath_desc;
struct ath_tx_status;
struct ath_rx_status;

/*
 * Hardware Access Layer (HAL) API.
 *
 * Clients of the HAL call ath_hal_attach to obtain a reference to an
 * ath_hal structure for use with the device.  Hardware-related operations
 * that follow must call back into the HAL through interface, supplying
 * the reference as the first parameter.  Note that before using the
 * reference returned by ath_hal_attach the caller should verify the
 * ABI version number.
 */
struct ath_hal {
        uint32_t        ah_magic;       /* consistency check magic number */
        uint32_t        ah_abi;         /* HAL ABI version */
#define HAL_ABI_VERSION 0x08110600      /* YYMMDDnn */
        uint16_t        ah_devid;       /* PCI device ID */
        uint16_t        ah_subvendorid; /* PCI subvendor ID */
        HAL_SOFTC       ah_sc;          /* back pointer to driver/os state */
        HAL_BUS_TAG     ah_st;          /* params for register r+w */
        HAL_BUS_HANDLE  ah_sh;
        HAL_CTRY_CODE   ah_countryCode;

        uint32_t        ah_macVersion;  /* MAC version id */
        uint16_t        ah_macRev;      /* MAC revision */
        uint16_t        ah_phyRev;      /* PHY revision */
        /* NB: when only one radio is present the rev is in 5Ghz */
        uint16_t        ah_analog5GhzRev;/* 5GHz radio revision */
        uint16_t        ah_analog2GhzRev;/* 2GHz radio revision */

        const HAL_RATE_TABLE *__ahdecl(*ah_getRateTable)(struct ath_hal *,
                                u_int mode);
        void      __ahdecl(*ah_detach)(struct ath_hal*);

        /* Reset functions */
        HAL_BOOL  __ahdecl(*ah_reset)(struct ath_hal *, HAL_OPMODE,
                                HAL_CHANNEL *, HAL_BOOL bChannelChange,
                                HAL_STATUS *status);
        HAL_BOOL  __ahdecl(*ah_phyDisable)(struct ath_hal *);
        HAL_BOOL  __ahdecl(*ah_disable)(struct ath_hal *);
        void      __ahdecl(*ah_setPCUConfig)(struct ath_hal *);
        HAL_BOOL  __ahdecl(*ah_perCalibration)(struct ath_hal*, HAL_CHANNEL *, HAL_BOOL *);
        HAL_BOOL  __ahdecl(*ah_setTxPowerLimit)(struct ath_hal *, uint32_t);

        /* Transmit functions */
        HAL_BOOL  __ahdecl(*ah_updateTxTrigLevel)(struct ath_hal*,
                                HAL_BOOL incTrigLevel);
        int       __ahdecl(*ah_setupTxQueue)(struct ath_hal *, HAL_TX_QUEUE,
                                const HAL_TXQ_INFO *qInfo);
        HAL_BOOL  __ahdecl(*ah_setTxQueueProps)(struct ath_hal *, int q, 
                                const HAL_TXQ_INFO *qInfo);
        HAL_BOOL  __ahdecl(*ah_getTxQueueProps)(struct ath_hal *, int q, 
                                HAL_TXQ_INFO *qInfo);
        HAL_BOOL  __ahdecl(*ah_releaseTxQueue)(struct ath_hal *ah, u_int q);
        HAL_BOOL  __ahdecl(*ah_resetTxQueue)(struct ath_hal *ah, u_int q);
        uint32_t __ahdecl(*ah_getTxDP)(struct ath_hal*, u_int);
        HAL_BOOL  __ahdecl(*ah_setTxDP)(struct ath_hal*, u_int, uint32_t txdp);
        uint32_t __ahdecl(*ah_numTxPending)(struct ath_hal *, u_int q);
        HAL_BOOL  __ahdecl(*ah_startTxDma)(struct ath_hal*, u_int);
        HAL_BOOL  __ahdecl(*ah_stopTxDma)(struct ath_hal*, u_int);
        HAL_BOOL  __ahdecl(*ah_setupTxDesc)(struct ath_hal *, struct ath_desc *,
                                u_int pktLen, u_int hdrLen,
                                HAL_PKT_TYPE type, u_int txPower,
                                u_int txRate0, u_int txTries0,
                                u_int keyIx, u_int antMode, u_int flags,
                                u_int rtsctsRate, u_int rtsctsDuration,
                                u_int compicvLen, u_int compivLen,
                                u_int comp);
        HAL_BOOL  __ahdecl(*ah_setupXTxDesc)(struct ath_hal *, struct ath_desc*,
                                u_int txRate1, u_int txTries1,
                                u_int txRate2, u_int txTries2,
                                u_int txRate3, u_int txTries3);
        HAL_BOOL  __ahdecl(*ah_fillTxDesc)(struct ath_hal *, struct ath_desc *,
                                u_int segLen, HAL_BOOL firstSeg,
                                HAL_BOOL lastSeg, const struct ath_desc *);
        HAL_STATUS __ahdecl(*ah_procTxDesc)(struct ath_hal *,
                                struct ath_desc *, struct ath_tx_status *);
        void       __ahdecl(*ah_getTxIntrQueue)(struct ath_hal *, uint32_t *);
        void       __ahdecl(*ah_reqTxIntrDesc)(struct ath_hal *, struct ath_desc*);

        /* Receive Functions */
        uint32_t __ahdecl(*ah_getRxDP)(struct ath_hal*);
        void      __ahdecl(*ah_setRxDP)(struct ath_hal*, uint32_t rxdp);
        void      __ahdecl(*ah_enableReceive)(struct ath_hal*);
        HAL_BOOL  __ahdecl(*ah_stopDmaReceive)(struct ath_hal*);
        void      __ahdecl(*ah_startPcuReceive)(struct ath_hal*);
        void      __ahdecl(*ah_stopPcuReceive)(struct ath_hal*);
        void      __ahdecl(*ah_setMulticastFilter)(struct ath_hal*,
                                uint32_t filter0, uint32_t filter1);
        HAL_BOOL  __ahdecl(*ah_setMulticastFilterIndex)(struct ath_hal*,
                                uint32_t index);
        HAL_BOOL  __ahdecl(*ah_clrMulticastFilterIndex)(struct ath_hal*,
                                uint32_t index);
        uint32_t __ahdecl(*ah_getRxFilter)(struct ath_hal*);
        void      __ahdecl(*ah_setRxFilter)(struct ath_hal*, uint32_t);
        HAL_BOOL  __ahdecl(*ah_setupRxDesc)(struct ath_hal *, struct ath_desc *,
                                uint32_t size, u_int flags);
        HAL_STATUS __ahdecl(*ah_procRxDesc)(struct ath_hal *,
                                struct ath_desc *, uint32_t phyAddr,
                                struct ath_desc *next, uint64_t tsf,
                                struct ath_rx_status *);
        void      __ahdecl(*ah_rxMonitor)(struct ath_hal *,
                                const HAL_NODE_STATS *, HAL_CHANNEL *);
        void      __ahdecl(*ah_procMibEvent)(struct ath_hal *,
                                const HAL_NODE_STATS *);

        /* Misc Functions */
        HAL_STATUS __ahdecl(*ah_getCapability)(struct ath_hal *,
                                HAL_CAPABILITY_TYPE, uint32_t capability,
                                uint32_t *result);
        HAL_BOOL   __ahdecl(*ah_setCapability)(struct ath_hal *,
                                HAL_CAPABILITY_TYPE, uint32_t capability,
                                uint32_t setting, HAL_STATUS *);
        HAL_BOOL   __ahdecl(*ah_getDiagState)(struct ath_hal *, int request,
                                const void *args, uint32_t argsize,
                                void **result, uint32_t *resultsize);
        void      __ahdecl(*ah_getMacAddress)(struct ath_hal *, uint8_t *);
        HAL_BOOL  __ahdecl(*ah_setMacAddress)(struct ath_hal *, const uint8_t*);
        void      __ahdecl(*ah_getBssIdMask)(struct ath_hal *, uint8_t *);
        HAL_BOOL  __ahdecl(*ah_setBssIdMask)(struct ath_hal *, const uint8_t*);
        HAL_BOOL  __ahdecl(*ah_setRegulatoryDomain)(struct ath_hal*,
                                uint16_t, HAL_STATUS *);
        void      __ahdecl(*ah_setLedState)(struct ath_hal*, HAL_LED_STATE);
        void      __ahdecl(*ah_writeAssocid)(struct ath_hal*,
                                const uint8_t *bssid, uint16_t assocId);
        HAL_BOOL  __ahdecl(*ah_gpioCfgOutput)(struct ath_hal *, uint32_t gpio);
        HAL_BOOL  __ahdecl(*ah_gpioCfgInput)(struct ath_hal *, uint32_t gpio);
        uint32_t __ahdecl(*ah_gpioGet)(struct ath_hal *, uint32_t gpio);
        HAL_BOOL  __ahdecl(*ah_gpioSet)(struct ath_hal *,
                                uint32_t gpio, uint32_t val);
        void      __ahdecl(*ah_gpioSetIntr)(struct ath_hal*, u_int, uint32_t);
        uint32_t __ahdecl(*ah_getTsf32)(struct ath_hal*);
        uint64_t __ahdecl(*ah_getTsf64)(struct ath_hal*);
        void      __ahdecl(*ah_resetTsf)(struct ath_hal*);
        HAL_BOOL  __ahdecl(*ah_detectCardPresent)(struct ath_hal*);
        void      __ahdecl(*ah_updateMibCounters)(struct ath_hal*,
                                HAL_MIB_STATS*);
        HAL_RFGAIN __ahdecl(*ah_getRfGain)(struct ath_hal*);
        u_int     __ahdecl(*ah_getDefAntenna)(struct ath_hal*);
        void      __ahdecl(*ah_setDefAntenna)(struct ath_hal*, u_int);
        HAL_ANT_SETTING  __ahdecl(*ah_getAntennaSwitch)(struct ath_hal*);
        HAL_BOOL  __ahdecl(*ah_setAntennaSwitch)(struct ath_hal*,
                                HAL_ANT_SETTING);
        HAL_BOOL  __ahdecl(*ah_setSifsTime)(struct ath_hal*, u_int);
        u_int     __ahdecl(*ah_getSifsTime)(struct ath_hal*);
        HAL_BOOL  __ahdecl(*ah_setSlotTime)(struct ath_hal*, u_int);
        u_int     __ahdecl(*ah_getSlotTime)(struct ath_hal*);
        HAL_BOOL  __ahdecl(*ah_setAckTimeout)(struct ath_hal*, u_int);
        u_int     __ahdecl(*ah_getAckTimeout)(struct ath_hal*);
        HAL_BOOL  __ahdecl(*ah_setAckCTSRate)(struct ath_hal*, u_int);
        u_int     __ahdecl(*ah_getAckCTSRate)(struct ath_hal*);
        HAL_BOOL  __ahdecl(*ah_setCTSTimeout)(struct ath_hal*, u_int);
        u_int     __ahdecl(*ah_getCTSTimeout)(struct ath_hal*);
        HAL_BOOL  __ahdecl(*ah_setDecompMask)(struct ath_hal*, uint16_t, int);
        void      __ahdecl(*ah_setCoverageClass)(struct ath_hal*, uint8_t, int);

        /* Key Cache Functions */
        uint32_t __ahdecl(*ah_getKeyCacheSize)(struct ath_hal*);
        HAL_BOOL  __ahdecl(*ah_resetKeyCacheEntry)(struct ath_hal*, uint16_t);
        HAL_BOOL  __ahdecl(*ah_isKeyCacheEntryValid)(struct ath_hal *,
                                uint16_t);
        HAL_BOOL  __ahdecl(*ah_setKeyCacheEntry)(struct ath_hal*,
                                uint16_t, const HAL_KEYVAL *,
                                const uint8_t *, int);
        HAL_BOOL  __ahdecl(*ah_setKeyCacheEntryMac)(struct ath_hal*,
                                uint16_t, const uint8_t *);

        /* Power Management Functions */
        HAL_BOOL  __ahdecl(*ah_setPowerMode)(struct ath_hal*,
                                HAL_POWER_MODE mode, int setChip);
        HAL_POWER_MODE __ahdecl(*ah_getPowerMode)(struct ath_hal*);
        int16_t   __ahdecl(*ah_getChanNoise)(struct ath_hal *, HAL_CHANNEL *);

        /* Beacon Management Functions */
        void      __ahdecl(*ah_setBeaconTimers)(struct ath_hal*,
                                const HAL_BEACON_TIMERS *);
        /* NB: deprecated, use ah_setBeaconTimers instead */
        void      __ahdecl(*ah_beaconInit)(struct ath_hal *,
                                uint32_t nexttbtt, uint32_t intval);
        void      __ahdecl(*ah_setStationBeaconTimers)(struct ath_hal*,
                                const HAL_BEACON_STATE *);
        void      __ahdecl(*ah_resetStationBeaconTimers)(struct ath_hal*);

        /* Interrupt functions */
        HAL_BOOL  __ahdecl(*ah_isInterruptPending)(struct ath_hal*);
        HAL_BOOL  __ahdecl(*ah_getPendingInterrupts)(struct ath_hal*, HAL_INT*);
        HAL_INT   __ahdecl(*ah_getInterrupts)(struct ath_hal*);
        HAL_INT   __ahdecl(*ah_setInterrupts)(struct ath_hal*, HAL_INT);
};

/* 
 * Check the PCI vendor ID and device ID against Atheros' values
 * and return a printable description for any Atheros hardware.
 * AH_NULL is returned if the ID's do not describe Atheros hardware.
 */
extern  const char *__ahdecl ath_hal_probe(uint16_t vendorid, uint16_t devid);

/*
 * Attach the HAL for use with the specified device.  The device is
 * defined by the PCI device ID.  The caller provides an opaque pointer
 * to an upper-layer data structure (HAL_SOFTC) that is stored in the
 * HAL state block for later use.  Hardware register accesses are done
 * using the specified bus tag and handle.  On successful return a
 * reference to a state block is returned that must be supplied in all
 * subsequent HAL calls.  Storage associated with this reference is
 * dynamically allocated and must be freed by calling the ah_detach
 * method when the client is done.  If the attach operation fails a
 * null (AH_NULL) reference will be returned and a status code will
 * be returned if the status parameter is non-zero.
 */
extern  struct ath_hal * __ahdecl ath_hal_attach(uint16_t devid, HAL_SOFTC,
                HAL_BUS_TAG, HAL_BUS_HANDLE, HAL_STATUS* status);

/*
 * Return a list of channels available for use with the hardware.
 * The list is based on what the hardware is capable of, the specified
 * country code, the modeSelect mask, and whether or not outdoor
 * channels are to be permitted.
 *
 * The channel list is returned in the supplied array.  maxchans
 * defines the maximum size of this array.  nchans contains the actual
 * number of channels returned.  If a problem occurred or there were
 * no channels that met the criteria then AH_FALSE is returned.
 */
extern  HAL_BOOL __ahdecl ath_hal_init_channels(struct ath_hal *,
                HAL_CHANNEL *chans, u_int maxchans, u_int *nchans,
                uint8_t *regclassids, u_int maxregids, u_int *nregids,
                HAL_CTRY_CODE cc, u_int modeSelect,
                HAL_BOOL enableOutdoor, HAL_BOOL enableExtendedChannels);

/*
 * Calibrate noise floor data following a channel scan or similar.
 * This must be called prior retrieving noise floor data.
 */
extern  void __ahdecl ath_hal_process_noisefloor(struct ath_hal *ah);

/*
 * Return bit mask of wireless modes supported by the hardware.
 */
extern  u_int __ahdecl ath_hal_getwirelessmodes(struct ath_hal*, HAL_CTRY_CODE);

/*
 * Calculate the transmit duration of a frame.
 */
extern uint16_t __ahdecl ath_hal_computetxtime(struct ath_hal *,
                const HAL_RATE_TABLE *rates, uint32_t frameLen,
                uint16_t rateix, HAL_BOOL shortPreamble);

/*
 * Return if device is public safety.
 */
extern HAL_BOOL __ahdecl ath_hal_ispublicsafetysku(struct ath_hal *);

/*
 * Return if device is operating in 900 MHz band.
 */
extern HAL_BOOL ath_hal_isgsmsku(struct ath_hal *);

/*
 * Convert between IEEE channel number and channel frequency
 * using the specified channel flags; e.g. CHANNEL_2GHZ.
 */
extern  int __ahdecl ath_hal_mhz2ieee(struct ath_hal *, u_int mhz, u_int flags);

/*
 * Return a version string for the HAL release.
 */
extern  char ath_hal_version[];
/*
 * Return a NULL-terminated array of build/configuration options.
 */
extern  const char* ath_hal_buildopts[];
#endif /* _ATH_AH_H_ */