umi.h

Microsoft WinCE 6.0 BSP FINAL release source code for use with the i.MX27ADS TO2 WCE600_FINAL_MX27_S

/***************************************************************************
**
** NAME         UM_MAN_SET_KEY_REQ
**
** PARAMETERS   u16Status           UMI_OK
**                                  UMI_NOT_INITIALISED
**                                  UMI_STATION_UNKNOWN
**              u16KeyType          Pairwise or group key
**              sStationID          MAC address of station
**              u16StationRole      Authenticator or supplicant
**              u16CipherSuite      Cipher suite selector
**              u16DefaultKeyIndex  For legacy WEP modes
**              au8RxSeqNum         Initial RX sequence number (little endian)
**              au8TxSeqNum         Initial TX sequence number (little endian)
**              au8Tk1              Temporal key 1
**              au8Tk2              Temporal key 2
**
** DESCRIPTION  Sets the temporal encryption key for the specified station
**
****************************************************************************/
PREPACK typedef struct
{
    uint16      u16Status;
    uint16      u16KeyType;
    IEEE_ADDR   sStationID;
    uint16      u16StationRole;
    uint16      u16CipherSuite;
    uint16      u16DefaultKeyIndex;
    uint8       au8RxSeqNum[UMI_RSN_SEQ_NUM_LEN];
    uint8       au8TxSeqNum[UMI_RSN_SEQ_NUM_LEN];
    uint8       au8Tk1[UMI_RSN_TK1_LEN];
    uint8       au8Tk2[UMI_RSN_TK2_LEN];
} POSTPACK UMI_SET_KEY;

/***************************************************************************
**
** NAME         UM_MAN_CLEAR_KEY_REQ
**
** PARAMETERS   u16Status           UMI_OK
**                                  UMI_NOT_INITIALISED
**                                  UMI_STATION_UNKNOWN
**              u16KeyType          Pairwise or group key
**              sStationID          MAC address of station
**
** DESCRIPTION  Clears the temporal encryption key for the specified station
**
****************************************************************************/
PREPACK typedef struct
{
    uint16      u16Status;
    uint16      u16KeyType;
    IEEE_ADDR   sStationID;
} POSTPACK UMI_CLEAR_KEY;

/***************************************************************************
**
** NAME         UM_MAN_SECURITY_ALERT_IND
**
** PARAMETERS   u16Status           Event code - see rsn.h
**              u16KeyType          Pairwise or group key
**              sStationID          MAC address of station
**
** DESCRIPTION  Alerts higher layers that a security related event has
**              occurred that may need acting on by re-keying or
**              disconnecting
**
****************************************************************************/
PREPACK typedef struct
{
    uint16      u16EventCode;
    uint16      u16KeyType;
    IEEE_ADDR   sStationID;
} POSTPACK UMI_SECURITY_ALERT;


// jkim - begin
// The payload data types are included as a part of union UMI_MAN since we 
// severly reduced the DBG buffer.
/***************************************************************************
**
** NAME         UM_UWA_CLEAR_STATS_REQ
**
** PARAMETERS   u8StatId              Describes which statistic to clear
**
** DESCRIPTION  Clears RX statistic
**
****************************************************************************/
PREPACK typedef struct
{
    uint8  u8StatId;
} POSTPACK UMI_UWA_CLEAR_STATS;

/***************************************************************************
**
** NAME         UM_MAN_SLEEP_RES
**
** PARAMETERS   u16Status               Describes whether it's OK to go to sleep
**
** DESCRIPTION  Sets a new TX VGA value
**
****************************************************************************/
PREPACK typedef struct
{
    uint16  u16Status;
} POSTPACK UMI_SLEEP_RES;
// jkim - end

/***************************************************************************
**
** NAME         UM_MAN_POWER_OFF_REQ
**
** PARAMETERS   none
**
** DESCRIPTION  This message is sent to request that the device enter a 
**              deep sleep mode.  In this mode the device is not connected
**              to any BSS or IBSS.  The device switches to Slow Clock to 
**              minimize power consumption.
**
**              The device will remain in this state until the host 
**              explicitly wakes up the device - this is accomplished by  
**              sending any Management message to the device.
**
**              The host must issue a disconnect request to the device and
**              wait for the disconnect confirmation prior to sending this 
**              message.
**
****************************************************************************/


/***************************************************************************
**
** NAME         MC_MAN_POWER_OFF_CFM
**
** PARAMETERS   u16Status           UMI_OK
**                                  UMI_BSS_ALREADY_ACTIVE - device has rejected the request
**                                  UMI_INTERNAL_MAC_ERROR - HIM is already powered off
**
** DESCRIPTION  Response to request for device to enter deep sleep.
**
****************************************************************************/
PREPACK typedef struct
{
    uint16 u16Status;
} POSTPACK UMI_POWER_OFF;


/***************************************************************************
**
** NAME         UM_MAN_LINK_MEASUREMENT_REQ
**
** PARAMETERS   u8DialogToken; 
**              i8TxPwr;
**              i8MaxTxPwr;
**
** DESCRIPTION  This message is sent to request that the device transmit an 
**              an 802.11k Link Measurement Request Management Action Frame
**              to the AP that it is currently connected to.
**
**
****************************************************************************/
PREPACK typedef struct
{
    uint16 u16Status;       // set in UM_MAN_LINK_MEASUREMENT_CFM
    uint8  u8DialogToken; 

} POSTPACK UMI_LINK_MEASUREMENT;

/***************************************************************************
**
** NAME         MC_MAN_LINK_MEASUREMENT_CFM
**
** PARAMETERS   u16Status           UMI_OK - Link Measurement has been started
**                                  UMI_FAILED - device has rejected the request
**
** DESCRIPTION  Response to request for device to perform the Link Measurement.
**
****************************************************************************/



/***************************************************************************
**
** NAME         MC_MAN_LINK_MEAS_REPORT_IND
**
** PARAMETERS   u8DialogToken  - Parameter from UM_MAN_LINK_MEASUREMENT_REQ
**              i8TxPowerdBm   - Measurement result
**              i8LinkMargindb - Measurement result
**
** DESCRIPTION  Reports the Link Measurement that the device has received
**              from the AP.
**
**              This message is sent under 2 conditions:
**
**              1. Returns the results after a Host request for the device
**                 to perform a Link Measurement (refer to 
**                 UM_MAN_LINK_MEASUREMENT_REQ).  In this case the 
**                 u8DialogToken will be a non-zero value.
**
**              2. The TPC Report IE in the AP's Beacon indicates that
**                 the device's Link Margin has changed (need to define
**                 threshold).  In this case the u8DialogToken will be zero.   
**
****************************************************************************/
PREPACK typedef struct
{
    IEEE_ADDR                          sBSSID;
    uint8                              u8DialogToken;
    int8                               i8TxPowerdBm;
    int8                               i8LinkMargindb;

} POSTPACK UMI_LINK_MEAS_REPORT;

/***************************************************************************
**
** NAME         UM_MAN_LINK_MEAS_REPORT_RES
**
** PARAMETERS   none
**
** DESCRIPTION  Returns the Link Measurement Report message resource.
**
****************************************************************************/



/***************************************************************************
**
** NAME         UM_MAN_TX_NEIGHBOR_REPORT_REQ
**
** PARAMETERS   u8DialogToken; 
**              i8TxPwr;
**              i8MaxTxPwr;
**
** DESCRIPTION  This message is sent to request that the device transmit an 
**              an 802.11k Neighbor Report Request Management Action Frame
**              to the AP that it is currently connected to.
**
**
****************************************************************************/
PREPACK typedef struct
{
    uint16 u16Status;       // set in UM_MAN_NEIGHBOR_REPORT_CFM

    uint8  u8DialogToken; 

} POSTPACK UMI_TX_NEIGHBOR_REPORT_REQ;

/***************************************************************************
**
** NAME         MC_MAN_TX_NEIGHBOR_REPORT_CFM
**
** PARAMETERS   u16Status           UMI_OK - device has Tx'd Neighbor Report
**                                           Request to AP
**                                  UMI_FAILED - device has rejected the request
**
** DESCRIPTION  Response to request for device to request a Neighbor Report
**              from the AP it is connected to.
**
****************************************************************************/



/***************************************************************************
**
** NAME         MC_MAN_RX_NEIGHBOR_REPORT_IND
**
** PARAMETERS   u8DialogToken  - Parameter from UM_MAN_LINK_MEASUREMENT_REQ
**
** DESCRIPTION  Forwards the Neighbor Report that the device has received
**              from the AP.
**
**
****************************************************************************/


PREPACK typedef struct
{
    uint16                             u16TsfOffset;
    uint16                             u16BeaconInterval;

} UMI_NEIGHBOR_TSF_OFFSET_FIELD;

PREPACK typedef struct
{
    IEEE_ADDR                          sBssid;
    uint16                             u16BssidInfo;
    uint8                              u8Channel;
    uint8                              u8RegClass;
    uint8                              u8PhyOptions;
    UMI_NEIGHBOR_TSF_OFFSET_FIELD      sTsfField;  // optional - present if b7 of u8PhyOptions = 1 

} POSTPACK UMI_NEIGHBOR_LIST_ENTRY;

#define  UMI_NEIGHBOR_ENTRY_SIZE       (sizeof(UMI_NEIGHBOR_LIST_ENTRY))  // 15 bytes
#define  UMI_NEIGHBOR_ENTRY_MIN_SIZE   (UMI_NEIGHBOR_ENTRY_SIZE - sizeof(UMI_NEIGHBOR_TSF_OFFSET_FIELD))  // 11 bytes



PREPACK typedef struct
{
    uint8                              au8VariablePayload[255];

} POSTPACK UMI_NEIGHBOR_REP_IE_PAYLOAD;

#define UMI_NEIGHBOR_REP_IE_SIZE (sizeof(UMI_NEIGHBOR_REP_IE_PAYLOAD))


PREPACK typedef struct
{
    uint8                              u8ElementId;
    uint8                              u8Length;
    UMI_NEIGHBOR_REP_IE_PAYLOAD        sPayload;

} POSTPACK UMI_NEIGHBOR_REP_IE;

#define UMI_NEIGHBOR_REP_ELEMENT_SIZE (sizeof(UMI_NEIGHBOR_REP_IE))


PREPACK typedef struct
{
    uint8                              u8DialogToken;
    UMI_NEIGHBOR_REP_IE                sNeighborReportIe;

} POSTPACK UMI_RX_NEIGHBOR_REPORT;


/***************************************************************************
**
** NAME         UM_MAN_RX_NEIGHBOR_REPORT_RES
**
** PARAMETERS   none
**
** DESCRIPTION  Returns the Rx Neighbor Report Indication message resource.
**