c802_11mini.cpp

Atheros Communications AR6001 WLAN Driver for SDIO installation Read Me March 26,2007 (based on

//------------------------------------------------------------------------------
// <copyright file="c802_11mini.cpp" company="Atheros and Microsoft">
//    Copyright (c) 2006 Microsoft Corporation.  All rights reserved.
//    Copyright (c) 2006 Atheros Corporation.  All rights reserved.
//
//    The use and distribution terms for this software are covered by the
//    Microsoft Limited Permissive License (Ms-LPL) 
//    http://www.microsoft.com/resources/sharedsource/licensingbasics/limitedpermissivelicense.mspx 
//    which can be found in the file MS-LPL.txt at the root of this distribution.
//    By using this software in any fashion, you are agreeing to be bound by
//    the terms of this license.
//
//    You must not remove this notice, or any other, from this software.
// </copyright>
// 
// <summary>
//    Windows CE Wifi Driver for AR-6000
// </summary>
//------------------------------------------------------------------------------
//==============================================================================
// NDIS 802.11 Miniport class.
//
// Author(s): ="Atheros and Microsoft"
//==============================================================================

#include <windows.h>
#include <ndis.h>

#include "cmini.hpp"
#include "c802_3mini.hpp"
#include "c802_11mini.hpp"
#include "osapi.h"

C802_11Miniport::C802_11Miniport()
{
	m_numMulticastAddresses  = 0;
	m_bRSSITriggerSet        = false;
	m_bInfrastructureModeSet = false;
}

C802_11Miniport::~C802_11Miniport()
{
}

boolean
C802_11Miniport::SSIDIsValid(
	const NDIS_802_11_SSID *pSSID)
//
//  WZC will set the SSID to a random string of 32 invalid
//  characters in the range 0x01 - 0x1F in order to stop
//  an adapter from associating with any SSID.
//
//  Return false if the SSID is one of these special values
//  being set by WZC.
{
	boolean isValid = true;
	UINT    i;

	if (pSSID->SsidLength == 32)
	{
		isValid = false;
		for (i = 0; i < 32; i++)
			if (!(0 < pSSID->Ssid[i] && pSSID->Ssid[i] <= 0x1F))
			{
				isValid = true;
				break;
			}
	}
	return isValid;
}

#ifdef DEBUG

static const char *
GetInfrastructureModeString(
	NDIS_802_11_NETWORK_INFRASTRUCTURE Mode)
{
	switch (Mode)
	{
	case Ndis802_11IBSS:              return "Ndis802_11IBSS";
	case Ndis802_11Infrastructure:    return "Ndis802_11Infrastructure";
	case Ndis802_11AutoUnknown:       return "Ndis802_11AutoUnknown";
	default: return "???";
	}
}


static const char *
GetAuthenticationModeString(
	NDIS_802_11_AUTHENTICATION_MODE Mode)
{
	switch (Mode)
	{
	case Ndis802_11AuthModeOpen:        return "Ndis802_11AuthModeOpen";
	case Ndis802_11AuthModeShared:      return "Ndis802_11AuthModeShared";
	case Ndis802_11AuthModeAutoSwitch:  return "Ndis802_11AuthModeAutoSwitch";
	case Ndis802_11AuthModeWPA:         return "Ndis802_11AuthModeWPA";
	case Ndis802_11AuthModeWPAPSK:      return "Ndis802_11AuthModeWPAPSK";
	case Ndis802_11AuthModeWPANone:     return "Ndis802_11AuthModeWPANone";
	case Ndis802_11AuthModeWPA2:        return "Ndis802_11AuthModeWPA2";
	case Ndis802_11AuthModeWPA2PSK:     return "Ndis802_11AuthModeWPA2PSK";					    
	default: return "???";
	}
}

static const char *
GetEncryptionStatusString(
	NDIS_802_11_ENCRYPTION_STATUS Status)
{
	switch (Status)
	{
	case Ndis802_11WEPEnabled:          return "Ndis802_11WEPEnabled";
	case Ndis802_11EncryptionDisabled:  return "Ndis802_11EncryptionDisabled";
	case Ndis802_11WEPKeyAbsent:        return "Ndis802_11WEPKeyAbsent";
	case Ndis802_11WEPNotSupported:     return "Ndis802_11WEPNotSupported";
	case Ndis802_11Encryption2Enabled:  return "Ndis802_11Encryption2Enabled";
	case Ndis802_11Encryption2KeyAbsent: return "Ndis802_11Encryption2KeyAbsent";
	case Ndis802_11Encryption3Enabled:  return "Ndis802_11Encryption3Enabled";
	case Ndis802_11Encryption3KeyAbsent: return "Ndis802_11Encryption3KeyAbsent";
	default: return "???";
	}
}

void
C802_11Miniport::Get80211OidTypeAndData(
	OUT char    *szBuffer,
	IN NDIS_OID Oid,
	IN PBYTE    Data)
{
	switch(Oid)
	{
	case OID_802_11_BSSID:
		sprintf(szBuffer, "OID_802_11_BSSID %02X%02X%02X%02X%02X%02X", Data[0], Data[1], Data[2], Data[3], Data[4], Data[5]);
		break;

	case OID_802_11_SSID:
		{
		NDIS_802_11_SSID *SSID = (NDIS_802_11_SSID *)Data;

		if (SSIDIsValid(SSID))
			sprintf(szBuffer, "OID_802_11_SSID Len=%u '%.32s'", SSID->SsidLength, SSID->Ssid);
		else
			sprintf(szBuffer, "OID_802_11_SSID Len=%u INVALID SSID String (non printable ASCII)", SSID->SsidLength);
		}
		break;

	case OID_802_11_NETWORK_TYPES_SUPPORTED:
		sprintf(szBuffer, "OID_802_11_NETWORK_TYPES_SUPPORTED");
		break;

	case OID_802_11_NETWORK_TYPE_IN_USE:
		sprintf(szBuffer, "OID_802_11_NETWORK_TYPE_IN_USE");
		break;

	case OID_802_11_TX_POWER_LEVEL:
		sprintf(szBuffer, "OID_802_11_TX_POWER_LEVEL");
		break;

	case OID_802_11_RSSI:
		sprintf(szBuffer, "OID_802_11_RSSI");
		break;

	case OID_802_11_RSSI_TRIGGER:
		sprintf(szBuffer, "OID_802_11_RSSI_TRIGGER");
		break;

	case OID_802_11_INFRASTRUCTURE_MODE:
		{
		NDIS_802_11_NETWORK_INFRASTRUCTURE Mode = *(NDIS_802_11_NETWORK_INFRASTRUCTURE *)Data;

		sprintf(szBuffer, "OID_802_11_INFRASTRUCTURE_MODE %hs", GetInfrastructureModeString(Mode));
		}
		break;

	case OID_802_11_FRAGMENTATION_THRESHOLD:
		sprintf(szBuffer, "OID_802_11_FRAGMENTATION_THRESHOLD");
		break;

	case OID_802_11_RTS_THRESHOLD:
		sprintf(szBuffer, "OID_802_11_RTS_THRESHOLD");
		break;

	case OID_802_11_NUMBER_OF_ANTENNAS:
		sprintf(szBuffer, "OID_802_11_NUMBER_OF_ANTENNAS");
		break;

	case OID_802_11_RX_ANTENNA_SELECTED:
		sprintf(szBuffer, "OID_802_11_RX_ANTENNA_SELECTED");
		break;

	case OID_802_11_TX_ANTENNA_SELECTED:
		sprintf(szBuffer, "OID_802_11_TX_ANTENNA_SELECTED");
		break;

	case OID_802_11_SUPPORTED_RATES:
		sprintf(szBuffer, "OID_802_11_SUPPORTED_RATES");
		break;

	case OID_802_11_DESIRED_RATES:
		sprintf(szBuffer, "OID_802_11_DESIRED_RATES");
		break;

	case OID_802_11_CONFIGURATION:
		sprintf(szBuffer, "OID_802_11_CONFIGURATION");
		break;

	case OID_802_11_DISASSOCIATE:
		sprintf(szBuffer, "OID_802_11_DISASSOCIATE");
		break;

	case OID_802_11_STATISTICS:
		sprintf(szBuffer, "OID_802_11_STATISTICS");
		break;

	case OID_802_11_POWER_MODE:
		sprintf(szBuffer, "OID_802_11_POWER_MODE");
		break;

	case OID_802_11_BSSID_LIST_SCAN:
		sprintf(szBuffer, "OID_802_11_BSSID_LIST_SCAN");
		break;

	case OID_802_11_BSSID_LIST:
		sprintf(szBuffer, "OID_802_11_BSSID_LIST");
		break;

	case OID_802_11_PRIVACY_FILTER:
		sprintf(szBuffer, "OID_802_11_PRIVACY_FILTER");
		break;

	case OID_802_11_RELOAD_DEFAULTS:
		sprintf(szBuffer, "OID_802_11_RELOAD_DEFAULTS");
		break;

	case OID_802_11_AUTHENTICATION_MODE:
		{

		NDIS_802_11_AUTHENTICATION_MODE Mode = *(NDIS_802_11_AUTHENTICATION_MODE *)Data;
		sprintf(szBuffer, "OID_802_11_AUTHENTICATION_MODE %hs", GetAuthenticationModeString(Mode));
		}
		break;

	case OID_802_11_ENCRYPTION_STATUS:
		{
		NDIS_802_11_ENCRYPTION_STATUS EncryptionStatus = *(NDIS_802_11_ENCRYPTION_STATUS *)Data;

		sprintf(szBuffer, "OID_802_11_ENCRYPTION_STATUS %hs", GetEncryptionStatusString(EncryptionStatus));
		}
		break;

	case OID_802_11_ADD_WEP:
		sprintf(szBuffer, "OID_802_11_ADD_WEP");
		break;

	case OID_802_11_REMOVE_WEP:
		sprintf(szBuffer, "OID_802_11_REMOVE_WEP");
		break;

	case OID_802_11_ADD_KEY:
		sprintf(szBuffer, "OID_802_11_ADD_KEY");
		break;

	case OID_802_11_REMOVE_KEY:
		sprintf(szBuffer, "OID_802_11_REMOVE_KEY");
		break;

	case OID_802_11_ASSOCIATION_INFORMATION:
		sprintf(szBuffer, "OID_802_11_ASSOCIATION_INFORMATION");
		break;

	case OID_802_11_TEST:
		sprintf(szBuffer, "OID_802_11_TEST");
		break;

#ifdef SUPPORT_WPA2
	case OID_802_11_CAPABILITY:
		sprintf(szBuffer, "OID_802_11_CAPABILITY");
		break;

	case OID_802_11_PMKID:
		sprintf(szBuffer, "OID_802_11_PMKID");
		break;
#endif

	default:
		sprintf(szBuffer, "???");
		break;
	}
}
#endif // DEBUG

static MPOidInfo g_802_11SupportedQueryOids[] =
{
	{ OID_802_11_BSSID,                    sizeof(NDIS_802_11_MAC_ADDRESS) },
	{ OID_802_11_SSID,                     sizeof(NDIS_802_11_SSID) },
	{ OID_802_11_NETWORK_TYPES_SUPPORTED,  sizeof(ULONG) },
	{ OID_802_11_NETWORK_TYPE_IN_USE,      sizeof(NDIS_802_11_NETWORK_TYPE) },
	{ OID_802_11_TX_POWER_LEVEL,           sizeof(NDIS_802_11_TX_POWER_LEVEL) },
	{ OID_802_11_RSSI,                     sizeof(NDIS_802_11_RSSI) },
	{ OID_802_11_RSSI_TRIGGER,             sizeof(NDIS_802_11_RSSI) },
	{ OID_802_11_INFRASTRUCTURE_MODE,      sizeof(NDIS_802_11_NETWORK_INFRASTRUCTURE) },
	{ OID_802_11_FRAGMENTATION_THRESHOLD,  sizeof(NDIS_802_11_FRAGMENTATION_THRESHOLD) },
	{ OID_802_11_RTS_THRESHOLD,            sizeof(NDIS_802_11_RTS_THRESHOLD) },
	{ OID_802_11_NUMBER_OF_ANTENNAS,       sizeof(ULONG) },
	{ OID_802_11_RX_ANTENNA_SELECTED,      sizeof(NDIS_802_11_ANTENNA) },
	{ OID_802_11_TX_ANTENNA_SELECTED,      sizeof(NDIS_802_11_ANTENNA) },
	{ OID_802_11_SUPPORTED_RATES,          sizeof(NDIS_802_11_RATES) },
	{ OID_802_11_DESIRED_RATES,            sizeof(NDIS_802_11_RATES) },
	{ OID_802_11_CONFIGURATION,            sizeof(NDIS_802_11_CONFIGURATION) },
	{ OID_802_11_STATISTICS,               sizeof(NDIS_802_11_STATISTICS) },
	{ OID_802_11_POWER_MODE,               sizeof(NDIS_802_11_POWER_MODE) },
	{ OID_802_11_BSSID_LIST,               sizeof(ULONG) },
	{ OID_802_11_PRIVACY_FILTER,           sizeof(NDIS_802_11_PRIVACY_FILTER) },
	{ OID_802_11_AUTHENTICATION_MODE,      sizeof(NDIS_802_11_AUTHENTICATION_MODE) },
	{ OID_802_11_ENCRYPTION_STATUS,        sizeof(NDIS_802_11_ENCRYPTION_STATUS) },
	{ OID_802_11_ASSOCIATION_INFORMATION,  sizeof(NDIS_802_11_ASSOCIATION_INFORMATION) },
#ifdef SUPPORT_WPA2
	{ OID_802_11_CAPABILITY,               sizeof(NDIS_802_11_CAPABILITY) },
	{ OID_802_11_PMKID,                    sizeof(NDIS_802_11_PMKID) },
//	{ OID_802_11_MEDIA_STREAM_MODE,        sizeof(ULONG) },
#endif
	{ 0,                             0 }
};

NDIS_STATUS
C802_11Miniport::QueryInformation(
	IN  NDIS_OID Oid, 
	OUT PVOID    Buffer, 
	IN  ULONG    cbBuffer,
	OUT PULONG   pcbWritten,
	OUT PULONG   pcbNeeded)
//
// QueryInformation is a required function that returns information
// about the capabilities and staus of the driver and/or its NIC.
//
{
	NDIS_STATUS                 Status = NDIS_STATUS_SUCCESS;

	// Check that OID is supported and buffer size is reasonable.
	Status = CheckOidRequest(&g_802_11SupportedQueryOids[0], Oid, cbBuffer, pcbNeeded);
	if (NDIS_STATUS_INVALID_OID == Status)
	{
		// OID is not a supported 802_11 OID. Check to see if it is an 802_3 OID.
		Status = C802_3Miniport::QueryInformation(Oid, Buffer, cbBuffer, pcbWritten, pcbNeeded);
		goto done;
	}
	if (NDIS_STATUS_SUCCESS != Status)
		goto done;

	switch (Oid)
	{
		//
		// 802_11 OIDS
		//
		case OID_802_11_BSSID:
			// When queried, this OID requests that the miniport driver return the MAC address 
			// of the associated AP. If the device is operating in ad hoc mode,
			// the miniport driver returns the IBSS MAC address. The miniport driver
			// must return an error code of NDIS_STATUS_ADAPTER_NOT_READY if the device
			// is neither operating in ad hoc mode nor associated with an AP.
			Status = Get802_11AssociatedAPBSSID((NDIS_802_11_MAC_ADDRESS *)Buffer);
			break;

		case OID_802_11_SSID:
			// When queried, this OID requests that the miniport driver return the SSID
			// with which the device is associated. The miniport driver returns zero for
			// the SsidLength member if the device is not associated with an SSID.
			Get802_11SSID((NDIS_802_11_SSID *)Buffer);
			break;

		case OID_802_11_NETWORK_TYPES_SUPPORTED:
			// When queried, the OID_802_11_NETWORK_TYPES_SUPPORTED OID requests that
			// the miniport driver return an array of all the network types that the
			// underlying NIC's physical layer (PHY) supports. If the NIC supports
			// multiple 802.11 radios, the driver returns all applicable network types.
			{
				NDIS_802_11_NETWORK_TYPE *pTypes;
				ULONG                     numTypes;

				Get802_11NetworkTypesSupported(&pTypes, &numTypes);

				NDIS_802_11_NETWORK_TYPE_LIST *pNetTypeList = (NDIS_802_11_NETWORK_TYPE_LIST *)Buffer;
				*pcbNeeded = offsetof(NDIS_802_11_NETWORK_TYPE_LIST, NetworkType[0])
				           + numTypes * sizeof(NDIS_802_11_NETWORK_TYPE);
				pNetTypeList->NumberOfItems = numTypes;
				if (*pcbNeeded <= cbBuffer)
					memcpy((PBYTE) Buffer + offsetof(NDIS_802_11_NETWORK_TYPE_LIST, NetworkType[0]), pTypes, numTypes * sizeof(NDIS_802_11_NETWORK_TYPE));
			}
			break;

		case OID_802_11_NETWORK_TYPE_IN_USE:
			// Return the network type that the underlying NIC's physical layer (PHY) will use:
			//   Ndis802_11FH       - Indicates the physical layer for the frequency-hopping spread-spectrum radio. 
            //   Ndis802_11DS       - Indicates the physical layer for the direct-sequence spread-spectrum radio. 
            //   Ndis802_11OFDM5    - Indicates the physical layer for 5-GHz OFDM radios. 
            //   Ndis802_11OFDM24   - Indicates the physical layer for 2.4-GHz OFDM radios. 
            //   Ndis802_11Automode - Indicates that the NIC will operate on all supported and enabled physical layers.
			Get802_11NetworkTypeInUse((PNDIS_802_11_NETWORK_TYPE)Buffer);
			break;

		case OID_802_11_TX_POWER_LEVEL:
			// When queried, this OID requests that the miniport driver return the transmit
			// power level, in mW, of the NIC.
			Status = Get802_11TxPowerLevel((NDIS_802_11_TX_POWER_LEVEL *)Buffer);
			break;

		case OID_802_11_RSSI:
			// When queried, the OID_802_11_RSSI OID requests that the miniport driver
			// return the current value of the received signal strength indication (RSSI).
			Status = Get802_11RSSI((NDIS_802_11_RSSI *)Buffer);
			break;

		case OID_802_11_RSSI_TRIGGER:
			// When queried, this OID requests that the miniport driver return the current
			// RSSI trigger value. The driver must return NDIS_STATUS_ADAPTER_NOT_READY if
			// an RSSI trigger has not been previously set.