/*

 * public_infoele.h

 *

 * Copyright(c) 1998 - 2010 Texas Instruments. All rights reserved.      

 * All rights reserved.      

 * 

 * This program and the accompanying materials are made available under the 

 * terms of the Eclipse Public License v1.0 or BSD License which accompanies

 * this distribution. The Eclipse Public License is available at

 * http://www.eclipse.org/legal/epl-v10.html and the BSD License is as below.                                   

 *                                                                       

 * Redistribution and use in source and binary forms, with or without    

 * modification, are permitted provided that the following conditions    

 * are met:                                                              

 *                                                                       

 *  * Redistributions of source code must retain the above copyright     

 *    notice, this list of conditions and the following disclaimer.      

 *  * Redistributions in binary form must reproduce the above copyright  

 *    notice, this list of conditions and the following disclaimer in    

 *    the documentation and/or other materials provided with the         

 *    distribution.                                                      

 *  * Neither the name Texas Instruments nor the names of its            

 *    contributors may be used to endorse or promote products derived    

 *    from this software without specific prior written permission.      

 *                                                                       

 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS   

 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT     

 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 

 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT  

 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 

 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT      

 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 

 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 

 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT   

 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 

 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

 */

/**********************************************************************************************************************

  FILENAME:       public_infoele.h

  DESCRIPTION:    Contains information element defines/structures used by the FW and host.

***********************************************************************************************************************/

#ifndef PUBLIC_INFOELE_H

#define PUBLIC_INFOELE_H

#include "public_types.h"

#include "public_commands.h"

#include "public_radio.h" 

typedef enum

{

    ACX_WAKE_UP_CONDITIONS      = 0x0002,

    ACX_MEM_CFG                 = 0x0003,

    ACX_SLOT                    = 0x0004,

    ACX_AC_CFG                  = 0x0007,

    ACX_MEM_MAP                 = 0x0008,

    ACX_AID                     = 0x000A,

    ACX_MEDIUM_USAGE            = 0x000F,

    ACX_RX_CFG                  = 0x0010,

    ACX_TX_QUEUE_CFG            = 0x0011,

    ACX_STATISTICS              = 0x0013, /* Debug API*/

    ACX_PWR_CONSUMPTION_STATISTICS       =0x0014,

    ACX_FEATURE_CFG             = 0x0015,

    ACX_TID_CFG                 = 0x001A,

    ACX_PS_RX_STREAMING         = 0x001B, 

    ACX_BEACON_FILTER_OPT       = 0x001F,

    ACX_NOISE_HIST              = 0x0021,

    ACX_HDK_VERSION             = 0x0022, /* ???*/

    ACX_PD_THRESHOLD            = 0x0023,

    ACX_TX_CONFIG_OPT           = 0x0024,

    ACX_CCA_THRESHOLD           = 0x0025,

    ACX_EVENT_MBOX_MASK         = 0x0026,

    ACX_CONN_MONIT_PARAMS       = 0x002D,

    ACX_CONS_TX_FAILURE         = 0x002F,

    ACX_BCN_DTIM_OPTIONS        = 0x0031,

    ACX_SG_ENABLE               = 0x0032,

    ACX_SG_CFG                  = 0x0033,

    ACX_FM_COEX_CFG             = 0x0034,

    ACX_BEACON_FILTER_TABLE     = 0x0038,

    ACX_ARP_IP_FILTER           = 0x0039,

    ACX_ROAMING_STATISTICS_TBL  = 0x003B,

    ACX_RATE_POLICY             = 0x003D, 

    ACX_CTS_PROTECTION          = 0x003E, 

    ACX_SLEEP_AUTH              = 0x003F,

    ACX_PREAMBLE_TYPE           = 0x0040,

    ACX_ERROR_CNT               = 0x0041,

    ACX_IBSS_FILTER             = 0x0044,

    ACX_SERVICE_PERIOD_TIMEOUT  = 0x0045,

    ACX_TSF_INFO                = 0x0046,

    ACX_CONFIG_PS_WMM           = 0x0049,

    ACX_ENABLE_RX_DATA_FILTER   = 0x004A,

    ACX_SET_RX_DATA_FILTER      = 0x004B,

    ACX_GET_DATA_FILTER_STATISTICS = 0x004C,

    ACX_RX_CONFIG_OPT           = 0x004E,

    ACX_FRAG_CFG                = 0x004F,

    ACX_BET_ENABLE              = 0x0050,

#ifdef RADIO_SCOPE  /* RADIO MODULE SECTION START */

	ACX_RADIO_MODULE_START      = 0x0500,

	ACX_RS_ENABLE				= ACX_RADIO_MODULE_START,

	ACX_RS_RX					= 0x0501,

    /* Add here ... */

	ACX_RADIO_MODULE_END        = 0x0600,

#endif /* RADIO MODULE SECTION END */

    ACX_RSSI_SNR_TRIGGER        = 0x0051,

    ACX_RSSI_SNR_WEIGHTS        = 0x0052,

    ACX_KEEP_ALIVE_MODE         = 0x0053,

    ACX_SET_KEEP_ALIVE_CONFIG   = 0x0054,

    ACX_BA_SESSION_RESPONDER_POLICY = 0x0055,

    ACX_BA_SESSION_INITIATOR_POLICY = 0x0056,

    ACX_PEER_HT_CAP             = 0x0057,

    ACX_HT_BSS_OPERATION        = 0x0058,

    ACX_COEX_ACTIVITY           = 0x0059,

    ACX_SET_SMART_REFLEX_DEBUG  = 0x005A,

	ACX_SET_SMART_REFLEX_STATE  = 0x005B,

	ACX_SET_SMART_REFLEX_PARAMS = 0x005F,

	ACX_BURST_MODE				= 0x005C,

    ACX_SET_RATE_MAMAGEMENT_PARAMS = 0x005D,

    ACX_GET_RATE_MAMAGEMENT_PARAMS = 0x005E,

	ACX_SET_RATE_ADAPT_PARAMS 	= 0x0060,

    ACX_SET_DCO_ITRIM_PARAMS    = 0x0061,

    DOT11_RX_MSDU_LIFE_TIME     = 0x1004,

    DOT11_CUR_TX_PWR            = 0x100D,

    DOT11_RX_DOT11_MODE         = 0x1012,

    DOT11_RTS_THRESHOLD         = 0x1013, 

    DOT11_GROUP_ADDRESS_TBL     = 0x1014,

    ACX_SET_RADIO_PARAMS		= 0x1015,

	ACX_PM_CONFIG               = 0x1016,

    MAX_DOT11_IE = ACX_PM_CONFIG,

    MAX_IE = 0xFFFF   /*force enumeration to 16bits*/

} InfoElement_enum;

#ifdef HOST_COMPILE

typedef uint16 InfoElement_e;

#else

typedef InfoElement_enum InfoElement_e;

#endif

typedef struct

{

    InfoElement_e id;

    uint16 length;

    uint32 dataLoc; /*use this to point to for following variable-length data*/

} InfoElement_t;

typedef struct 

{

    uint16 id;

    uint16 len;

} EleHdrStruct;

#define MAX_NUM_AID     4 /* max number of STAs in IBSS */  

#ifdef HOST_COMPILE

#define INFO_ELE_HDR    EleHdrStruct    EleHdr;

#else

#define INFO_ELE_HDR

#endif

/******************************************************************************

    Name:   ACX_WAKE_UP_CONDITIONS

    Type:   Configuration

    Access: Write Only

    Length: 2

******************************************************************************/

typedef enum

{

    WAKE_UP_EVENT_BEACON_BITMAP     = 0x01, /* Wake on every Beacon*/

    WAKE_UP_EVENT_DTIM_BITMAP       = 0x02, /* Wake on every DTIM*/

    WAKE_UP_EVENT_N_DTIM_BITMAP     = 0x04, /* Wake on every Nth DTIM (Listen interval)*/

    WAKE_UP_EVENT_N_BEACONS_BITMAP  = 0x08, /* Wake on every Nth Beacon (Nx Beacon)*/

    WAKE_UP_EVENT_BITS_MASK         = 0x0F

} WakeUpEventBitMask_e;

typedef struct

{

    INFO_ELE_HDR

    uint8  wakeUpConditionBitmap;   /* The host can set one bit only. */

                                    /* WakeUpEventBitMask_e describes the Possible */

                                    /* Wakeup configuration bits*/

    uint8  listenInterval;          /* 0 for Beacon and Dtim, */

                                    /* xDtims (1-10) for Listen Interval and */

                                    /* xBeacons (1-255) for NxBeacon*/

    uint8  padding[2];              /* alignment to 32bits boundry   */

}WakeUpCondition_t;

/******************************************************************************

    Name:   ACX_MEM_CFG

    Type:   Configuration

    Access: Write Only

    Length: 12

******************************************************************************/

typedef struct

{

    INFO_ELE_HDR

    uint8   rxMemblockNumber;           /* specifies the number of memory buffers that */

                                        /* is allocated to the Rx memory pool. The */

                                        /* actual number allocated may be less than*/

                                        /* this number if there are not enough memory */

                                        /* blocks left over for the Minimum Number of */

                                        /* Tx Blocks. Returns the actual number of RX */

                                        /* buffers allocated in the memory map*/

    uint8   txMinimumMemblockNumber;    /* specifies the minimum number of blocks that */

                                        /* must be allocated to the TX pool. Follows */

                                        /* this limit even if the Number of Rx Memory */

                                        /* Blocks parameter is ignored.*/

    uint8   numStations;                /* The number of STAs supported in IBSS mode. */

                                        /* The FW uses this field to allocate memory */

                                        /* for STA context data such as security keys*/

    uint8   numSsidProfiles;            /* The number of SSID profiles used in IBSS mode */

                                        /* Enables different profiles for different STAs */

    uint32  totalTxDescriptors;         /* Total TX Descriptors - in the past it was configured per AC */

} ACXConfigMemory_t;

/******************************************************************************

    Name:   ACX_SLOT

    Type:   Configuration

    Access: Write Only

    Length: 8

******************************************************************************/

typedef enum

{

    SLOT_TIME_LONG = 0,     /* the WiLink uses long (20 us) slots*/

    SLOT_TIME_SHORT = 1,    /* the WiLink uses short (9 us) slots*/

    DEFAULT_SLOT_TIME = SLOT_TIME_SHORT,

    MAX_SLOT_TIMES = 0xFF

} SlotTime_enum;

#ifdef HOST_COMPILE

typedef uint8 SlotTime_e;

#else

typedef SlotTime_enum SlotTime_e;

#endif

typedef struct

{

    INFO_ELE_HDR

    uint8      woneIndex;   /* reserved*/

    SlotTime_e slotTime;    /* The slot size to be used. refer to SlotTime_enum.    */

    uint8      reserved[6];

} ACXSlot_t;

/******************************************************************************

    Name:   ACX_AC_CFG

    Type:   Configuration

    Access: Write Only

    Length: 8

******************************************************************************/

typedef enum

{

    AC_BE = 0,          /* Best Effort/Legacy*/

    AC_BK = 1,          /* Background*/

    AC_VI = 2,          /* Video*/

    AC_VO = 3,          /* Voice*/

    /* AC_BCAST    = 4, */  /* Broadcast dummy access category      */ 

    AC_CTS2SELF = 4,        /* CTS2Self fictitious AC,              */  

                            /* uses #4 to follow AC_VO, as          */

                            /* AC_BCAST does not seem to be in use. */

        AC_ANY_TID = 0x1F,

	AC_INVALID = 0xFF,  /* used for gTxACconstraint */

    NUM_ACCESS_CATEGORIES = 4

} AccessCategory_enum;

typedef enum

{

	TID0 = 0,			/* Best Effort/Legacy*/

	TID1 = 1,			/* Best Effort/Legacy*/

	TID2 = 2,			/* Background*/

	TID3 = 3,			/* Video*/

	TID4 = 4,			/* Voice*/

	TID5 = 5,		/* Broadcast dummy access category*/

	TID6 = 6,

	TID7 = 7,           /* managment */

	NUM_TRAFFIC_CATEGORIES = 8

} TrafficCategory_enum;

#define AC_REQUEST                      0xfe    /* Special access category type for */

                                                /* requests*/

/* following are defult values for the IE fields*/

#define CWMIN_BK  15

#define CWMIN_BE  15

#define CWMIN_VI  7

#define CWMIN_VO  3

#define CWMAX_BK  1023

#define CWMAX_BE  63

#define CWMAX_VI  15

#define CWMAX_VO  7

#define AIFS_PIFS 1 /* slot number setting to start transmission at PIFS interval */

#define AIFS_DIFS 2 /* slot number setting to start transmission at DIFS interval - */

                    /* normal DCF access */

#define AIFS_MIN AIFS_PIFS

#define AIFSN_BK  7

#define AIFSN_BE  3

#define AIFSN_VI  AIFS_PIFS

#define AIFSN_VO  AIFS_PIFS

#define TXOP_BK   0

#define TXOP_BE   0

#define TXOP_VI   3008

#define TXOP_VO   1504

#define DEFAULT_AC_SHORT_RETRY_LIMIT 7

#define DEFAULT_AC_LONG_RETRY_LIMIT 4

/* rxTimeout values */

#define NO_RX_TIMEOUT 0

typedef struct 

{

    INFO_ELE_HDR

    uint8   ac;         /* Access Category - The TX queue's access category */

                        /* (refer to AccessCategory_enum)*/

    uint8   cwMin;      /* The contention window minimum size (in slots) for */

                        /* the access class.*/

    uint16  cwMax;      /* The contention window maximum size (in slots) for */

                        /* the access class.*/

    uint8   aifsn;      /* The AIF value (in slots) for the access class.*/

    uint8   reserved;

    uint16  txopLimit;  /* The TX Op Limit (in microseconds) for the access class.*/

} ACXAcCfg_t;

/******************************************************************************

    Name:   ACX_MEM_MAP

    Type:   Configuration

    Access: Read Only

    Length: 72

    Note:   Except for the numTxMemBlks, numRxMemBlks fields, this is

            used in MASTER mode only!!!

******************************************************************************/

#define MEM_MAP_NUM_FIELDS  24

typedef struct 

{

    uint32 *controlBlock; /* array of two 32-bit entries in the following order:

                            1. Tx-Result entries counter written by the FW

                            2. Tx-Result entries counter read by the host */

    void   *txResultQueueStart; /* points t first descriptor in TRQ */

} TxResultPointers_t;

typedef struct

{

    INFO_ELE_HDR

    void *codeStart;                

    void *codeEnd;                  

    void *wepDefaultKeyStart;

    void *wepDefaultKeyEnd;         

    void *staTableStart;

    void *staTableEnd;              

    void *packetTemplateStart;

    void *packetTemplateEnd;        

    TxResultPointers_t  trqBlock;             

    void *queueMemoryStart;

    void *queueMemoryEnd; 

    void *packetMemoryPoolStart;

    void *packetMemoryPoolEnd;

    void *debugBuffer1Start;

    void *debugBuffer1End;

    void *debugBuffer2Start;

    void *debugBuffer2End;

    uint32 numTxMemBlks;    /* Number of blocks that FW allocated for TX packets.*/

    uint32 numRxMemBlks;    /* Number of blocks that FW allocated for RX packets.   */

    /* the following 4 fields are valid in SLAVE mode only */

    uint8   *txCBufPtr;

    uint8   *rxCBufPtr;

    void    *rxControlPtr;

    void    *txControlPtr;

} MemoryMap_t;

/******************************************************************************

    Name:   ACX_AID

    Type:   Configuration

    Access: Write Only

    Length: 2

******************************************************************************/

typedef struct

{

    INFO_ELE_HDR

    uint16  Aid;    /* The Association ID to the WiLink. The WiLink uses this */

                    /* field to determine when the STA's AID bit is set in a */

                    /* received beacon and when a PS Poll frame should be */

                    /* transmitted to the AP. The host configures this information */

                    /* element after it has associated with an AP. This information */

                    /* element does not need to be set in Ad Hoc mode.*/

    uint8  padding[2];  /* alignment to 32bits boundry   */

} ACXAid_t;

/******************************************************************************

    Name:   ACX_ERROR_CNT

    Type:   Operation

    Access: Read Only

    Length: 12

******************************************************************************/

typedef struct

{

    INFO_ELE_HDR

    uint32 PLCPErrorCount;  /* The number of PLCP errors since the last time this */

                            /* information element was interrogated. This field is */

                            /* automatically cleared when it is interrogated.*/

    uint32 FCSErrorCount;   /* The number of FCS errors since the last time this */

                            /* information element was interrogated. This field is */

                            /* automatically cleared when it is interrogated.*/

    uint32 validFrameCount; /* The number of MPDUÂ’s without PLCP header errors received*/

                            /* since the last time this information element was interrogated. */

                            /* This field is automatically cleared when it is interrogated.*/

    uint32 seqNumMissCount; /* the number of missed sequence numbers in the squentially */

                            /* values of frames seq numbers */

} ACXErrorCounters_t;

/******************************************************************************

    Name:   ACX_MEDIUM_USAGE

    Type:   Configuration

    Access: Read Only

    Length: 8

******************************************************************************/

typedef struct

{

    INFO_ELE_HDR

    uint32 mediumUsage; /* report to the host the value of medium usage registers*/

    uint32 period;      /* report to the host the value of medium period registers*/

} ACXMediumUsage_t;

/******************************************************************************

    Name:   ACX_RX_CFG

    Type:   Filtering Configuration

    Access: Write Only

    Length: 8

******************************************************************************/

/*

 * Rx configuration (filter) information element

 * ---------------------------------------------

 */

/*

    RX ConfigOptions Table

    Bit     Definition

    ===     ==========

    31:14   Reserved

    13      Copy RX Status - when set, write three receive status words to top of 

            rx'd MPDU.

            When clear, do not write three status words (added rev 1.5)

    12      Reserved

    11      RX Complete upon FCS error - when set, give rx complete interrupt for 

            FCS errors, after the rx filtering, e.g. unicast frames not to us with 

            FCS error will not generate an interrupt

    10      SSID Filter Enable - When set, the WiLink discards all beacon, 

            probe request, and probe response frames with an SSID that does not 

            match the SSID specified by the host in the START/JOIN command. 

            When clear, the WiLink receives frames with any SSID.

    9       Broadcast Filter Enable - When set, the WiLink discards all broadcast 

            frames. When clear, the WiLink receives all received broadcast frames.

    8:6     Reserved

    5       BSSID Filter Enable - When set, the WiLink discards any frames with a 

            BSSID that does not match the BSSID specified by the host. 

            When clear, the WiLink receives frames from any BSSID.

    4       MAC Addr Filter - When set, the WiLink discards any frames with a 

            destination address that does not match the MAC address of the adaptor. 

            When clear, the WiLink receives frames destined to any MAC address.

    3       Promiscuous - When set, the WiLink receives all valid frames 

            (i.e., all frames that pass the FCS check). 

            When clear, only frames that pass the other filters specified are received.