/*

 * public_commands.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_commands.h

  DESCRIPTION:    Command definitions shared with host

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

#ifndef PUBLIC_COMMANDS_H

#define PUBLIC_COMMANDS_H

#include "public_types.h"

#include "public_radio.h"

typedef enum

{

    CMD_INTERROGATE     = 1,    /*use this to read information elements*/

    CMD_CONFIGURE       = 2,    /*use this to write information elements*/

    CMD_ENABLE_RX       = 3,

    CMD_ENABLE_TX       = 4,

    CMD_DISABLE_RX      = 5,

    CMD_DISABLE_TX      = 6,

    CMD_SCAN            = 8,

    CMD_STOP_SCAN       = 9,

    CMD_START_JOIN      = 11,

    CMD_SET_KEYS        = 12,

    CMD_READ_MEMORY     = 13,

    CMD_WRITE_MEMORY    = 14,

    CMD_SET_TEMPLATE    = 19,

    CMD_TEST            = 23,

    CMD_NOISE_HIST      = 28,

    CMD_LNA_CONTROL     = 32,

    CMD_SET_BCN_MODE    = 33,

    CMD_MEASUREMENT      = 34,

    CMD_STOP_MEASUREMENT = 35,

    CMD_DISCONNECT       = 36,

    CMD_SET_PS_MODE      = 37,

    CMD_CHANNEL_SWITCH   = 38,

    CMD_STOP_CHANNEL_SWICTH = 39,

    CMD_AP_DISCOVERY     = 40,

    CMD_STOP_AP_DISCOVERY = 41,

    CMD_SPS_SCAN = 42,

    CMD_STOP_SPS_SCAN = 43,

    CMD_HEALTH_CHECK     = 45,     

    CMD_DEBUG            = 46, 

    CMD_TRIGGER_SCAN_TO  = 47,

    CMD_CONNECTION_SCAN_CFG        = 48,

    CMD_CONNECTION_SCAN_SSID_CFG   = 49,

    CMD_START_PERIODIC_SCAN        = 50,

    CMD_STOP_PERIODIC_SCAN         = 51,

    CMD_SET_STA_STATE              = 52,

NUM_COMMANDS,

    MAX_COMMAND_ID = 0xFFFF

} Command_enum;

#ifdef HOST_COMPILE

typedef uint16 Command_e;

#else

typedef Command_enum Command_e;

#endif

#ifdef HOST_COMPILE

#define     CMD_MAILBOX_IDLE               0

#define     CMD_STATUS_SUCCESS             1

#define     CMD_STATUS_UNKNOWN_CMD         2

#define     CMD_STATUS_UNKNOWN_IE          3

#define     CMD_STATUS_REJECT_MEAS_SG_ACTIVE    11

#define     CMD_STATUS_RX_BUSY             13

#define     CMD_STATUS_INVALID_PARAM       14

#define     CMD_STATUS_TEMPLATE_TOO_LARGE  15 

#define     CMD_STATUS_OUT_OF_MEMORY       16 

#define     CMD_STATUS_STA_TABLE_FULL      17

#define     CMD_STATUS_RADIO_ERROR         18

#define     CMD_STATUS_WRONG_NESTING       19

#define     CMD_STATUS_TIMEOUT             21 /* Driver internal use.*/

#define     CMD_STATUS_FW_RESET            22 /* Driver internal use.*/

#define     MAX_COMMAND_STATUS             MAX_POSITIVE16

#else

typedef enum

{

    CMD_MAILBOX_IDLE              =  0,

    CMD_STATUS_SUCCESS            =  1,

    CMD_STATUS_UNKNOWN_CMD        =  2,

    CMD_STATUS_UNKNOWN_IE         =  3,

    CMD_STATUS_REJECT_MEAS_SG_ACTIVE =  11,

    CMD_STATUS_RX_BUSY            = 13,

    CMD_STATUS_INVALID_PARAM      = 14,

    CMD_STATUS_TEMPLATE_TOO_LARGE = 15, 

    CMD_STATUS_OUT_OF_MEMORY      = 16, 

    CMD_STATUS_STA_TABLE_FULL     = 17,

    CMD_STATUS_RADIO_ERROR        = 18,

    CMD_STATUS_WRONG_NESTING      = 19,

    CMD_STATUS_TIMEOUT            = 21, /* Driver internal use.*/

    CMD_STATUS_FW_RESET           = 22, /* Driver internal use.*/

    MAX_COMMAND_STATUS            = MAX_POSITIVE16

} CommandStatus_enum;

#endif

#ifdef HOST_COMPILE

typedef uint16 CommandStatus_e;

#else

typedef CommandStatus_enum CommandStatus_e;

#endif

#define MAX_CMD_PARAMS 610

#define DEBUG_INDICATOR      0x8000    

typedef struct

{

    Command_e cmdID;

    CommandStatus_e cmdStatus;

    uint8 parameters[MAX_CMD_PARAMS];

} Command_t;

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

    ID:       CMD_INTERROGATE

    Desc:     This command requests an information element from the WiLink. The 

              interface for this command is somewhat different from other commands 

              since the interface is bi-directional and asymmetric. 

              The host structure consists of the Command ID, a Command Status 

              (returned by WiLink) place holder, and the Information Element Heading

              (ID and expected length).

              The response to that command is a buffer of the information element's 

              actual values returned by the WiLink just after the command is issued.

              The response to that command is a buffer of the information element's 

              actual values returned by the WiLink just after the command is issued.

    Params:   InfoElement_t - see below.

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

/*

Description of InfoElement structure - defined in "public_infoele.h"

offset  length  source  description

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

0       2       host    Information Element ID - contains the ID of the requested 

                        information element (refer to InfoElement_enum in 

                        pblic_infoele.h). In response to this command, the WiLink 

                        writes the requested information element to the response area 

                        for the command mailbox.

2       4       wilink  Length - the length of the response (different for each IE

                        according to definitions in public_infoele.h).

4       Length  wilink  IE payload according to definition in public_infoele.h.

*/

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

    ID:       CMD_CONFIGURE

    Desc:     This command configures an information element in the WiLink. 

    Params:   InfoElement_t - see below.

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

/*

Description of InfoElement structure - defined in "public_infoele.h"

offset  length  source  description

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

0       2       host    Information Element ID - contains the ID of the requested 

                        information element (refer to InfoElement_enum in 

                        pblic_infoele.h). In response to this command, the WiLink 

                        writes the requested information element to the response area 

                        for the command mailbox.

2       4       host    Length - the length of the response (different for each IE

                        according to definitions in public_infoele.h).

4       Length  host    IE payload according to definition in public_infoele.h.

*/

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

    ID:       CMD_ENABLE_RX

    Desc:     This command enables the normal reception of frames. 

    Params:   Channel Number - this field indicates the radio channel on which to

                               receive data. This parameter also sets the channel on

                               which to transmit. The last channel number used, 

                               regardless of the order in which the ENABLE_RX and 

                               ENABLE_TX commands are issued, is the channel number 

                               for both RX and TX. This command must be issued after 

                               the host has set all necessary configuration elements 

                               appropriately.

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

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

    ID:       CMD_ENABLE_TX

    Desc:     This command enables the normal transmission of frames.  

    Params:   Channel Number - this field indicates the radio channel on which to

                               transmit data. This parameter also sets the channel on

                               which to receive. The last channel number used, 

                               regardless of the order in which the ENABLE_RX and 

                               ENABLE_TX commands are issued, is the channel number 

                               for both RX and TX. This command must be issued after

                               the host has set all necessary configuration elements

                               appropriately.

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

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

    ID:       CMD_DISABLE_RX

    Desc:     This command disables the normal reception of packets over the 

              Baseband interface. 

    Params:   None

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

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

    ID:       CMD_DISABLE_TX

    Desc:     This command disables the normal transmission of frames. 

    Params:   None.

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

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

    ID:       CMD_SCAN

    Desc:     This command instructs the WiLink to scan for BSS/IBSSs. The host 

              may perform either an active scan or a passive scan. During an active

              scan, the WiLink transmits a probe request on the specified channel(s) 

              and then listens for beacon/probe responses. During a passive scan, the 

              WiLink monitors the specified channel(s) for beacons.

              The WiLink sends SCAN_COMPLETE event to notify the host when it has 

              completed a scan.

    Params:   ScanParameters_t - see below

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

/*

Offset  Length  Definition

0       8       RX filters for Scan (refer to ACXRxConfigStruct)

8       2       Scan options (Band select, Voice mode and Scan type = Active/Passive)

10      1       NumChannels 

11      1       Number of Probe requests (used for Active scan)

12      2       Probe request rate & modulation

14      1       AC trigger (for Voice mode only)

15      1       SSID length

16      32      SSID string (Null terminated)

48      2       Channel [0] ScanMinDuration

50      2       Channel [0] ScanMaxDuration 

52      6       Channel [0] BSSID (4 bytes LOW and 2 bytes HIGH)

58      1       Channel [0].bit0-3: Early Termination count. Bit 4-5: Condition

59      1       Channel [0] TX power level for Scan (0 means do not change - other values:1-5)

60      1       Channel [0] Channel  

61      3       Channel [0] Reserved

64-404  340     Optional Channel [1] - Channel [15] - same format as Channel [0] fields above.

*/

/* Defines for Rx "ConfigOptions".*/

/* Only bits 2-10 can be configured by the Driver".*/

#define CFG_RX_SERIAL           BIT_0    /* 0 = use parallel interface,         1 = use serial interface from ACX101- not valid.*/

#define CFG_RX_RAW              BIT_1    /* 1 = write all data from baseband to frame buffer including PHY header.*/

#define CFG_RX_FCS              BIT_2    /* 1 = write FCS to end of frame in memory, 0 = do not write FCS to memory.*/

#define CFG_RX_ALL_GOOD         BIT_3    /* promiscuous mode, receive all good frames.*/

#define CFG_UNI_FILTER_EN       BIT_4    /* local MAC address filter enable.*/

#define CFG_BSSID_FILTER_EN     BIT_5    /* BSSID filter enable.*/

#define CFG_MC_FILTER_EN        BIT_6    /* 0 = receive all multicast,          1 = use one or both multicast address filters.*/

#define CFG_MC_ADDR0_EN         BIT_7    /* 1 = receive frames from mc_addr0,   0 = do not use this filter.*/

#define CFG_MC_ADDR1_EN         BIT_8    /* 1 = receive frames from mc_addr1,   0 = do not use this filter .*/

#define CFG_BC_REJECT_EN        BIT_9    /* 0 = receive all broadcast,          1 = filter all broadcast.*/

#define CFG_SSID_FILTER_EN      BIT_10   /* SSID Filter Enable.*/

#define CFG_RX_INT_FCS_ERROR    BIT_11   /* 1 = give rx complete interrupt for FCS errors.*/

#define CFG_RX_INT_ENCRYPTED    BIT_12   /* 1 = only give rx header interrupt if frame is encrypted.*/

#define CFG_RX_WR_RX_STATUS     BIT_13   /* 0 = do not write three status words, 1 = write three receive status words to top of rx'd MPDU.*/

#define CFG_RX_FILTER_NULTI     BIT_14   /* 1 = filter multicast/broadcast frame if SA matchs local MAC addr->.*/

#define CFG_RX_RESERVE          BIT_15   /* reserve.*/

#define CFG_RX_TIMESTAMP_TSF    BIT_16   /* 1 = sample frame's' arrival time in 32bits TSF, 0 = write it in MAC time stamp.*/

/* Defines for Rx "FilterOptions".*/

/* The rx filter enables control what type of receive frames will be rejected or received by the rx hardware*/

/* 1 = frame is written to memory,*/

/* 0 = not written to memory, rejected.*/

#define CFG_RX_RSV_EN       BIT_0  /* reserved types and subtypes.*/

#define CFG_RX_RCTS_ACK     BIT_1  /* rts, cts, ack frames.*/

#define CFG_RX_PRSP_EN      BIT_2  /* probe response.*/

#define CFG_RX_PREQ_EN      BIT_3  /* probe request.*/

#define CFG_RX_MGMT_EN      BIT_4  /* type = management.*/

#define CFG_RX_FCS_ERROR    BIT_5  /* frames with FCS errors.*/

#define CFG_RX_DATA_EN      BIT_6  /* type = data.*/

#define CFG_RX_CTL_EN       BIT_7  /* type = control.*/

#define CFG_RX_CF_EN        BIT_8  /* contention free frames.*/

#define CFG_RX_BCN_EN       BIT_9  /* beacons.*/

#define CFG_RX_AUTH_EN      BIT_10 /* authentication, deauthentication.*/

#define CFG_RX_ASSOC_EN     BIT_11 /* association related frames (all 5 subtypes – assoc req/resp,*/

typedef struct

{

    uint32          ConfigOptions;

    uint32          FilterOptions;

} ACXRxConfigStruct;

/* ScanOptions bit mask field.*/

#define SCAN_ACTIVE         0

#define SCAN_PASSIVE        1   /* 1 = passive scan, 0 = active scan*/

/* #define SCAN_5GHZ_BAND      2  */  /* 1 = scan channel list in 5 Ghz band, 0 = scan channel list in 2.4 Ghz band*/ 

#define TRIGGERED_SCAN      2   /* 1 = Triggered scan, 0 = Normal scan*/

#define SCAN_PRIORITY_HIGH  4   /* 1 = High priority scan, 0 = Low priority scan*/

typedef uint8 TidTrigger_t;

/* General scan parameters.*/

typedef struct

{

    ACXRxConfigStruct  rxCfg;         /* Rx filter to be used for each channel scan. */

                                      /* The BSSID filter enable will be set (by the */

                                      /* scan process) to ON for a specific channel if*/

                                      /* the BSSID of this channel is a unicast address.*/

                                      /* Otherwise it will be set to OFF (Refer to */

                                      /* ACXRxConfig IE in public_infoele.h).*/

    uint16             scanOptions;   /* This bitwise field indicates the scan options. */

                                      /* Bits [4:15] are reserved. */

                                      /* Bits [0:3] are defined as follows: */

                                      /* Scan Type (bit 0) - When this bit is set, the */

                                      /*  WiLink performs a passive scan. When this bit*/

                                      /*  is cleared, the WiLink performs an active scan. */

                                      /* Band Select (bit 1) - When this bit is set, the*/

                                      /*  WiLink scans the specified channels in the */

                                      /*  5GHz band. When this bit is cleared, the */

                                      /*  WiLink scans the specified channels in the */

                                      /*  2.4GHz band. */

                                      /* Voice mode (bit 2) - When this bit is set, */

                                      /*  the request is for a voice scan. When this bit*/

                                      /*  is cleared, the request is for a normal scan. */

                                      /* Scan priority (bit 3) - When this bit is set, */

                                      /*  the request is for a high priority scan. When*/

                                      /*  this bit is cleared, the request is for a low*/

                                      /*  priority scan.*/

    uint8              numChannels;   /* Number of scan channels in the list (minimum is*/

                                      /* 1, maximum is 30).*/

    uint8              numOfProbRqst; /* This field indicates the number of probe */

                                      /* requests to send per channel, in active scan. */

    EHwRateBitFiled    txdRateSet;    /* This EHwRateBitFiled format field specifies the rate and */

                                      /* modulation to transmit the probe request during*/

	                                  /* an active scan. It is not used for passive scans.*/

    TidTrigger_t       tidTrigger;    /* used for TidTriggered scan only.*/

    uint8              ssidLength;    /* This field specifies the size of the SSID, */

                                      /* which can be up to 32 bytes long. If this field*/

                                      /* equals to zero, SSID filter is not applied. */

    uint8              padding1[2];    /* in order to align */ 

    uint32             ssidStr[8];    /* This field specifies the SSID packets from that*/

                                      /* are relevant for the Scan result. The WiLink*/

                                      /* uses this information to filter beacon, probe*/

                                      /* response frames (if the SSID length field of */

                                      /* this command structure is not zero) */

    RadioBand_e         band;         /* Band to scan */

    uint8               useSsidList;  /* Whether to use SSID list (configured seperately)

                                         when transmitting probe-requests */

    uint8               scanTag;      /* Scan results tag */

    uint8               padding2;     /* in order to align */ 

} BasicScanParameters_t;

#define SCAN_ET_COND_MASK  0x30

#define SCAN_ET_COUNT_MASK 0x0F

#define SCAN_MAX_NUM_OF_CHANNELS 24

/* Early Termination condition (bits 4-5) - This field can have one of the following */

/* values (note that bits 0-3 indicates Early Termination count): */

typedef enum 

{

    ET_COND_DISABLE = 0x00,          /* Disable - No early termination condition.*/

    ET_COND_BEACON  = 0x10,          /* Beacon only. When this value is selected, the */

                                     /* Early Termination count field specifies the */

                                     /* maximum number of beacons to collect before */

                                     /* ending a scan. */

    ET_COND_PROBE_RESP = 0x20,       /* Probe responses only. When this value is */

                                     /* selected, the Early Termination count field */

                                     /* specifies the maximum number of probe responses*/

                                     /* to collect before ending a scan. */

    ET_COND_BEACON_PROBE_RESP = 0x30,/* Beacon/probe response. When this value is */

                                     /* selected, the Early Termination count field */

                                     /* specifies the maximum number of beacons or probe*/

                                     /* responses to collect before ending a scan. */

    ET_COND_INVALID = 0xFF

} ETCondition_enum;

#ifdef HOST_COMPILE

typedef uint8 ETCondition_e;

#else

typedef ETCondition_enum ETCondition_e;

#endif

typedef uint8 ETCondCount_t;

#define PROCESS_SCAN_IS_HIGH(pScanParameters) ((pScanParameters)->basicScanParameters.scanOptions & SCAN_PRIORITY_HIGH)

#define PROCESS_SCAN_IS_LOW(pScanParameters) ((PROCESS_SCAN_IS_HIGH(pScanParameters)) == 0)

/* Per-Channel scan parameters.*/

typedef struct

{

    uint32        scanMinDuration;    /* For active scans, this field specifies the */

                                      /* minimum amount of time, in time units (TUs), */

                                      /* to wait for a frame on a channel. This */

                                      /* parameter is not used for passive scans. The*/

                                      /*  value can range from 0 to 65535 TUs */

                                      /* (67.1 seconds). */

    uint32        scanMaxDuration;    /* For active scans, this field specifies the */

                                      /* maximum amount of time, in time units (TUs), */

                                      /* to wait for a probe response on a channel.*/

                                      /* For passive scans, this field specifies the */

                                      /* amount of time, in time units (TUs), to listen*/

                                      /* on a channel. The value can range from 0 to */

                                      /* 65535 TUs (67.1 seconds). */

    uint32        bssIdL;             /* 32 LSBits of BSSID of the AP to scan for. */

                                      /* If scanning on this channel any BSSID, this */

                                      /* field shall be set to broadcast BSSID. */

    uint16        bssIdH;             /* 16 MSBits of BSSID of the AP to scan for.*/

    ETCondCount_t ETCondCount;        /* bit 0-3: Early Termination count - This field */

                                      /*          defines the maximum number of beacons*/

                                      /*          or probe responses or both (according*/

                                      /*          to condition) to collect before ending*/

                                      /*          a scan.*/

                                      /* Bit 4-5: Early Termination Condition (refer */

                                      /*          to ETCondition_enum).*/

    uint8         txPowerAttenuation; /* TX power level to be used per channel scanned. */

                                      /* If 0, leave normal TX power level for this */

                                      /* channel. Range: 0 - 20 [dB].*/

    Channel_e     channel;            /* Channel number to scan, valid range 0-255 */

                                      /* (1-14 for 802.11b). */

    Bool_e        dfsCandidate;       /* FW internal use only! */

    Bool_e        activityDetected;   /* FW internal use only! */

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

} BasicScanChannelParameters_t;

/* The Scan command structure.*/

typedef struct

{

    BasicScanParameters_t basicScanParameters; /* refer to BasicScanParameters_t */

                                               /* definition*/