API Guide Home (Online version only) |

# PalmWiFiCommon.h File Reference

## Detailed Description

Constants and structures common to the wifi network panel and driver.

Version:
  1.0

Definition in file PalmWiFiCommon.h.

Include dependency graph for PalmWiFiCommon.h:

Go to the source code of this file.

## Data Structures

- struct NetBssInfoType
    Structure to hold BSS Info data. More...
- struct NetworkDeviceQueryData
    Structure to hold network query data. More...
- struct BSSListStruct
    BSS list. More...
- struct NetSSID
    Structure used to get and set the current SSID for the driver (not the Network interface). More...
- struct NetWepKey
    Structure used to set the wep keys. More...

## Defines

- #define WIFI_MIN_OS_VERSION sysMakeROMVersion(3,0,0,sysROMStageDevelopment,0)
- #define PALM_OS_20_VERSION sysMakeROMVersion(2,0,0,sysROMStageDevelopment,0)
- #define WIFI_CREATOR_ID 'WiFi'
- #define WIFI_CONFIG_NAME "WiFi Config"
- #define WIFI_DB_TYPE 'DATA'
- #define WIFI_DB_NAME "WiFiDB"
- #define WIFI_DRIVER_PREFIX "wi"
- #define WIFI_DRIVER_NAME "WiFi Prism3"
- #define ESS 1
- #define IBSS 4
- #define net80211ResetWepPasscode 0x41149339
- #define netMediaDisconnected 0
- #define netMediaConnected 1
- #define netMacAddrLength 6
- #define netSSIDMaxLength 32
- #define netNum80211Rates 8
- #define BSSINFO_SIZE (BSSINFO_ANL_OFFSET + BSSINFO_ANL_SIZE)

Event Notifications
Event notifications from the WiFi -- can be used for SysNotifyRegister

- #define WIFI_ASSOCIATED_EVENT 'WiAs'
- #define WIFI_DISASSOCIATED_EVENT 'WiDi'
- #define WIFI_SCAN_COMPLETE_EVENT 'WiSc'
- #define WIFI_IF_UP_EVENT 'WiUp'
- #define WIFI_IF_DOWN_EVENT 'WiDn'

Encryption Algorithm

- #define AUTHENTICATION_ALGORITHM_OPEN_SYSTEM 1
- #define AUTHENTICATION_ALGORITHM_SHARED_KEY 2
- #define AUTHENTICATION_ALGORITHM_SHARED_KEY_128 3

ESS TX power mode.

- #define AUTO_TX_POWER 0
- #define ENHANCED_TX_POWER 1

AdHoc power modes.

- #define FULL_TX_POWER 0
- #define _30_MW_TX_POWER 1
- #define _15_MW_TX_POWER 2
- #define _5_MW_TX_POWER 3
- #define _1_MW_TX_POWER 4

AP density constants.
Referred as netIFSetting80211Environment in configuration.

- #define AP_DENSITY_LOW 0
- #define AP_DENSITY_MED 1
- #define AP_DENSITY_HIGH 2

Adapter Preamble

- #define LONG_PREAMBLE 0
- #define SHORT_PREAMBLE 1
- #define AUTO_PREAMBLE 2

Network Device Driver Interface Error Codes

- #define errNetQueryBufTooSmall 11
- #define errNetOutOfMemory 12
- #define errNetLibMissing 13
- #define errNetInterfaceNotFound 14

- #define BSSINFO_VFLAG 0
- #define BSSINFO_VFLAG_SIZE 4

- #define BSSINFO_MAC_ADDR_OFFSET (BSSINFO_VFLAG + BSSINFO_VFLAG_SIZE)
- #define BSSINFO_MAC_ADDR_SIZE 8
- #define BSSINFO_MAC_ADDR_VFLAG 0x00000001L

- #define BSSINFO_SSIDLENGTH_OFFSET (BSSINFO_MAC_ADDR_OFFSET + BSSINFO_MAC_ADDR_SIZE)
- #define BSSINFO_SSIDLENGTH_SIZE 4
- #define BSSINFO_SSIDLENGTH_VFLAG 0x00000002L

- #define BSSINFO_SSID_OFFSET (BSSINFO_SSIDLENGTH_OFFSET + BSSINFO_SSIDLENGTH_SIZE)
- #define BSSINFO_SSID_SIZE netSSIDMaxLength
- #define BSSINFO_SSID_VFLAG 0x00000004L

- #define BSSINFO_WEP_OFFSET (BSSINFO_SSID_OFFSET + BSSINFO_SSID_SIZE)
- #define BSSINFO_WEP_SIZE 4
- #define BSSINFO_WEP_VFLAG 0x00000008L

- #define BSSINFO_RSSI_OFFSET (BSSINFO_WEP_OFFSET + BSSINFO_WEP_SIZE)
- #define BSSINFO_RSSI_SIZE 4
- #define BSSINFO_RSSI_VFLAG 0x00000010L

- #define BSSINFO_NETWORK_TYPE_OFFSET (BSSINFO_RSSI_OFFSET + BSSINFO_RSSI_SIZE)
- #define BSSINFO_NETWORK_TYPE_SIZE 4
- #define BSSINFO_NETWORK_TYPE_VFLAG 0x00000020L

- #define BSSINFO_BEACON_PERIOD_OFFSET (BSSINFO_NETWORK_TYPE_OFFSET + BSSINFO_NETWORK_TYPE_SIZE)
- #define BSSINFO_BEACON_PERIOD_SIZE 4
- #define BSSINFO_BEACON_PERIOD_VFLAG 0x00000040L

- #define BSSINFO_ATIM_WINDOW_OFFSET (BSSINFO_BEACON_PERIOD_OFFSET + BSSINFO_BEACON_PERIOD_SIZE)
- #define BSSINFO_ATIM_WINDOW_SIZE 4
- #define BSSINFO_ATIM_WINDOW_VFLAG 0x00000080L

- #define BSSINFO_DSFREQ_OFFSET (BSSINFO_ATIM_WINDOW_OFFSET + BSSINFO_ATIM_WINDOW_SIZE)
- #define BSSINFO_DSFREQ_SIZE 4
- #define BSSINFO_DSFREQ_VFLAG 0x00000100L

- #define BSSINFO_HOPPATTERN_OFFSET (BSSINFO_DSFREQ_OFFSET + BSSINFO_DSFREQ_SIZE)
- #define BSSINFO_HOPPATTERN_SIZE 4
- #define BSSINFO_HOPPATTERN_VFLAG 0x00000200L

- #define BSSINFO_HOPSET_OFFSET (BSSINFO_HOPPATTERN_OFFSET + BSSINFO_HOPPATTERN_SIZE)
- #define BSSINFO_HOPSET_SIZE 4
- #define BSSINFO_HOPSET_VFLAG 0x00000400L

- #define BSSINFO_HOPDWELL_OFFSET (BSSINFO_HOPSET_OFFSET + BSSINFO_HOPSET_SIZE)
- #define BSSINFO_HOPDWELL_SIZE 4
- #define BSSINFO_HOPDWELL_VFLAG 0x00000800L

- #define BSSINFO_NETWORK_MODE_OFFSET (BSSINFO_HOPDWELL_OFFSET + BSSINFO_HOPDWELL_SIZE)
- #define BSSINFO_NETWORK_MODE_SIZE 4
- #define BSSINFO_NETWORK_MODE_VFLAG 0x00001000L

- #define BSSINFO_SUPPORTED_RATES_OFFSET (BSSINFO_NETWORK_MODE_OFFSET + BSSINFO_NETWORK_MODE_SIZE)
- #define BSSINFO_SUPPORTED_RATES_SIZE 8
- #define BSSINFO_SUPPORTED_RATES_VFLAG 0x00002000L

- #define BSSINFO_CHID_OFFSET (BSSINFO_SUPPORTED_RATES_OFFSET + BSSINFO_SUPPORTED_RATES_SIZE)
- #define BSSINFO_CHID_SIZE 4
- #define BSSINFO_CHID_VFLAG 0x00004000L

- #define BSSINFO_ANL_OFFSET (BSSINFO_CHID_OFFSET + BSSINFO_CHID_SIZE)
- #define BSSINFO_ANL_SIZE 4
- #define BSSINFO_ANL_VFLAG 0x00008000L

Macros for accessing individual fields

- #define BssInfoMacAddr(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_MAC_ADDR_OFFSET], BSSINFO_MAC_ADDR_SIZE )
- #define BssInfoSsidLength(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_SSIDLENGTH_OFFSET], BSSINFO_SSIDLENGTH_SIZE )
- #define BssInfoSsid(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_SSID_OFFSET], BSSINFO_SSID_SIZE )
- #define BssInfoWep(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_WEP_OFFSET], BSSINFO_WEP_SIZE )
- #define BssInfoRssi(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_RSSI_OFFSET], BSSINFO_RSSI_SIZE )
- #define BssInfoNetworkType(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_NETWORK_TYPE_OFFSET], BSSINFO_NETWORK_TYPE_SIZE )
- #define BssInfoBeaconPeriod(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_BEACON_PERIOD_OFFSET], BSSINFO_BEACON_PERIOD_SIZE )
- #define BssInfoAtimWindow(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_ATIM_WINDOW_OFFSET], BSSINFO_ATIM_WINDOW_SIZE )
- #define BssInfoDSFreq(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_DSFREQ_OFFSET], BSSINFO_DSFREQ_SIZE )
- #define BssInfoHopPattern(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_HOPPATTERN_OFFSET], BSSINFO_HOPPATTERN_SIZE )
- #define BssInfoHopSet(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_HOPSET_OFFSET], BSSINFO_HOPSET_SIZE )
- #define BssInfoHopDwell(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_HOPDWELL_OFFSET], BSSINFO_HOPDWELL_SIZE )
- #define BssInfoNetworkMode(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_NETWORK_MODE_OFFSET], BSSINFO_NETWORK_MODE_SIZE )
- #define BssInfoSupportedRates(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_SUPPORTED_RATES_OFFSET], BSSINFO_SUPPORTED_RATES_SIZE )
- #define BssInfoChannelId(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_CHID_OFFSET], BSSINFO_CHID_SIZE )
- #define BssInfoANL(infoP, destP) MemMove( destP, &((UInt8 *) infoP)[BSSINFO_ANL_OFFSET], BSSINFO_ANL_SIZE )

## Typedefs

- typedef NetBssInfoType * NetBssInfoTypeP
    Structure to hold BSS Info data.
- typedef NetworkDeviceQueryData NetQueryType
    Structure to hold network query data.
- typedef NetworkDeviceQueryData * NetQueryTypeP
    Structure to hold network query data.
- typedef enum _80211NetworkTypeEnum Net80211NetworkType
- typedef enum _80211InfrastructureEnum Net80211InfrastructureModeType
- typedef BSSListStruct NetBssListType
    BSS list.
- typedef NetSSID * NetSSIDP
    Structure used to get and set the current SSID for the driver (not the Network interface).
- typedef NetWepKey * NetWepKeyP
    Structure used to set the wep keys.

## Enumerations

- enum NetQueryId {
  netQuery80211SignalStrength = 0x100,
  netQuery80211SignalQuality,
  netQuery80211AuthenticationMode,
  netQuery80211BssScan,
  netQuery80211BssScanList,
  netQuery80211Channel,
  netQuery80211PowerState,
  netQuery80211RadioState,
  netQuery80211SSID,
  netQuery80211Key,
  netQuery80211KeyIndex,
  netQuery80211ResetKeys,
  netQuery80211OperatingMode,
  netQuery80211WepStatus,
  netQuery80211FirmwareVersion,
  netQuery80211SerialNumber,
  netQuery80211FWName,
  netQuery80211DriverDate,
  netQuery80211WEPRequired,
  netQuery80211ChannelList,
  netQuery80211BSSID,
  netQueryCancel,
  netQuery80211MediaState,
  netQuery80211SecurityMode,
  netQuery80211StartConnection,
  netQuery80211Last
  }
- enum IPAllocType {
  IPAllocType_DHCP = 0,
  IPAllocType_APIPA = 1,
  IPAllocType_STATIC = 2
  }
- enum SecurityModeType {
  SecurityModeOpenSystem = 0,
  SecurityModeWEP,
  SecurityModeWPAPSK,
  SecurityModeLast
  }
- enum WiFiCustomIFSettings {
  netIFSetting80211PowerMode = netIFSettingCustom,
  netIFSetting80211Diversity,
  netIFSetting80211Channel,
  netIFSetting80211EncryptionKey1,
  netIFSetting80211EncryptionKey2,
  netIFSetting80211EncryptionKey3,
  netIFSetting80211EncryptionKey4,
  netIFSetting80211EncryptionKeyID,
  netIFSetting80211MandatoryBSSId,
  netIFSetting80211MUEncryptionAlgorithm,
  netIFSetting80211PortType,
  netIFSetting80211EssTxPower,
  netIFSetting80211AdhocTxPower,
  netIFSetting80211StationName,
  netIFSetting80211Environment,
  netIFSetting80211LongPreamble,
  netIFSetting80211Gateway,
  netIFSettingPrimaryDNS,
  netIFSettingSecondaryDNS,
  netIFSettingDHCPRequestDNS,
  netIFSettingIPAllocType,
  netIFSetting80211SmartConnect,
  netIFSettingUIProgHoldOff,
  netIFSettingWiFiHideProgress,
  netIFSettingAutoPowerDownOnClose,
  netIFSettingInterfaceQSize,
  netIFSettingDriverQSize,
  netIFSetting8021x,
  netIFSetting80211MediaDisconnectLingerTime,
  netIFSetting80211MobileIP,
  netIFSetting80211Last
  }
- enum NetWepStatus {
  netWEPEnabled,
  netWEPDisabled,
  netWEPKeyAbsent,
  netWEPNotSupported
  }
- enum _80211NetworkTypeEnum {
  net80211_FH,
  net80211_DS,
  net80211_Max
  }
- enum _80211InfrastructureEnum {
  net80211Bss,
  net80211Infrastructure,
  net80211AutoUnknown,
  net80211InfrastructureMax
  }

## Define Documentation

#define _15_MW_TX_POWER 2

Definition at line 125 of file PalmWiFiCommon.h.

#define _1_MW_TX_POWER 4

Definition at line 127 of file PalmWiFiCommon.h.

#define _30_MW_TX_POWER 1

Definition at line 124 of file PalmWiFiCommon.h.

#define _5_MW_TX_POWER 3

Definition at line 126 of file PalmWiFiCommon.h.

#define AP_DENSITY_HIGH 2

Definition at line 136 of file PalmWiFiCommon.h.

#define AP_DENSITY_LOW 0

Definition at line 134 of file PalmWiFiCommon.h.

#define AP_DENSITY_MED 1

Definition at line 135 of file PalmWiFiCommon.h.

#define AUTHENTICATION_ALGORITHM_OPEN_SYSTEM 1

Definition at line 103 of file PalmWiFiCommon.h.

#define AUTHENTICATION_ALGORITHM_SHARED_KEY 2

Definition at line 104 of file PalmWiFiCommon.h.

#define AUTHENTICATION_ALGORITHM_SHARED_KEY_128 3

Definition at line 105 of file PalmWiFiCommon.h.

#define AUTO_PREAMBLE 2

Definition at line 143 of file PalmWiFiCommon.h.

#define AUTO_TX_POWER 0

Definition at line 117 of file PalmWiFiCommon.h.

#define BSSINFO_ANL_OFFSET (BSSINFO_CHID_OFFSET + BSSINFO_CHID_SIZE)

Offset = 96 (0x60). Channel ID

Definition at line 337 of file PalmWiFiCommon.h.

#define BSSINFO_ANL_SIZE 4

Offset = 96 (0x60). Channel ID

Definition at line 338 of file PalmWiFiCommon.h.

#define BSSINFO_ANL_VFLAG 0x00008000L

Offset = 96 (0x60). Channel ID

Definition at line 339 of file PalmWiFiCommon.h.

#define BSSINFO_ATIM_WINDOW_OFFSET (BSSINFO_BEACON_PERIOD_OFFSET + BSSINFO_BEACON_PERIOD_SIZE)

Offset = 64 (0x40). ATim window (in KuSec)

Definition at line 281 of file PalmWiFiCommon.h.

#define BSSINFO_ATIM_WINDOW_SIZE 4

Offset = 64 (0x40). ATim window (in KuSec)

Definition at line 282 of file PalmWiFiCommon.h.

#define BSSINFO_ATIM_WINDOW_VFLAG 0x00000080L

Offset = 64 (0x40). ATim window (in KuSec)

Definition at line 283 of file PalmWiFiCommon.h.

#define BSSINFO_BEACON_PERIOD_OFFSET (BSSINFO_NETWORK_TYPE_OFFSET + BSSINFO_NETWORK_TYPE_SIZE)

Offset = 60 (0x3C). Beacon period (in KuSec)

Definition at line 274 of file PalmWiFiCommon.h.

#define BSSINFO_BEACON_PERIOD_SIZE 4

Offset = 60 (0x3C). Beacon period (in KuSec)

Definition at line 275 of file PalmWiFiCommon.h.

#define BSSINFO_BEACON_PERIOD_VFLAG 0x00000040L

Offset = 60 (0x3C). Beacon period (in KuSec)

Definition at line 276 of file PalmWiFiCommon.h.

#define BSSINFO_CHID_OFFSET (BSSINFO_SUPPORTED_RATES_OFFSET + BSSINFO_SUPPORTED_RATES_SIZE)

Offset = 96 (0x60). Channel ID

Definition at line 330 of file PalmWiFiCommon.h.

#define BSSINFO_CHID_SIZE 4

Offset = 96 (0x60). Channel ID

Definition at line 331 of file PalmWiFiCommon.h.

#define BSSINFO_CHID_VFLAG 0x00004000L

Offset = 96 (0x60). Channel ID

Definition at line 332 of file PalmWiFiCommon.h.

#define BSSINFO_DSFREQ_OFFSET (BSSINFO_ATIM_WINDOW_OFFSET + BSSINFO_ATIM_WINDOW_SIZE)

Offset = 68 (0x44). DS frequency (in kHz)

Definition at line 288 of file PalmWiFiCommon.h.

#define BSSINFO_DSFREQ_SIZE 4

Offset = 68 (0x44). DS frequency (in kHz)

Definition at line 289 of file PalmWiFiCommon.h.

#define BSSINFO_DSFREQ_VFLAG 0x00000100L

Offset = 68 (0x44). DS frequency (in kHz)

Definition at line 290 of file PalmWiFiCommon.h.

#define BSSINFO_HOPDWELL_OFFSET (BSSINFO_HOPSET_OFFSET + BSSINFO_HOPSET_SIZE)

Offset = 80 (0x50). Frequency hopping dwell time

Definition at line 309 of file PalmWiFiCommon.h.

#define BSSINFO_HOPDWELL_SIZE 4

Offset = 80 (0x50). Frequency hopping dwell time

Definition at line 310 of file PalmWiFiCommon.h.

#define BSSINFO_HOPDWELL_VFLAG 0x00000800L

Offset = 80 (0x50). Frequency hopping dwell time

Definition at line 311 of file PalmWiFiCommon.h.

#define BSSINFO_HOPPATTERN_OFFSET (BSSINFO_DSFREQ_OFFSET + BSSINFO_DSFREQ_SIZE)

Offset = 72 (0x48). Frequency hopping pattern

Definition at line 295 of file PalmWiFiCommon.h.

#define BSSINFO_HOPPATTERN_SIZE 4

Offset = 72 (0x48). Frequency hopping pattern

Definition at line 296 of file PalmWiFiCommon.h.

#define BSSINFO_HOPPATTERN_VFLAG 0x00000200L

Offset = 72 (0x48). Frequency hopping pattern

Definition at line 297 of file PalmWiFiCommon.h.

#define BSSINFO_HOPSET_OFFSET (BSSINFO_HOPPATTERN_OFFSET + BSSINFO_HOPPATTERN_SIZE)

Offset = 76 (0x4C). Frequency hopping set

Definition at line 302 of file PalmWiFiCommon.h.

#define BSSINFO_HOPSET_SIZE 4

Offset = 76 (0x4C). Frequency hopping set

Definition at line 303 of file PalmWiFiCommon.h.

#define BSSINFO_HOPSET_VFLAG 0x00000400L

Offset = 76 (0x4C). Frequency hopping set

Definition at line 304 of file PalmWiFiCommon.h.

#define BSSINFO_MAC_ADDR_OFFSET (BSSINFO_VFLAG + BSSINFO_VFLAG_SIZE)

Offset = 4. MAC/HW Address for device.

Definition at line 232 of file PalmWiFiCommon.h.

#define BSSINFO_MAC_ADDR_SIZE 8

Offset = 4. MAC/HW Address for device.

Definition at line 233 of file PalmWiFiCommon.h.

#define BSSINFO_MAC_ADDR_VFLAG 0x00000001L

Offset = 4. MAC/HW Address for device.

Definition at line 234 of file PalmWiFiCommon.h.

#define BSSINFO_NETWORK_MODE_OFFSET (BSSINFO_HOPDWELL_OFFSET + BSSINFO_HOPDWELL_SIZE)

Offset = 84 (0x54). 802.11 network mode

Definition at line 316 of file PalmWiFiCommon.h.

#define BSSINFO_NETWORK_MODE_SIZE 4

Offset = 84 (0x54). 802.11 network mode

Definition at line 317 of file PalmWiFiCommon.h.

#define BSSINFO_NETWORK_MODE_VFLAG 0x00001000L

Offset = 84 (0x54). 802.11 network mode

Definition at line 318 of file PalmWiFiCommon.h.

#define BSSINFO_NETWORK_TYPE_OFFSET (BSSINFO_RSSI_OFFSET + BSSINFO_RSSI_SIZE)

Offset = 56 (0x38). Network type in use (Freq. hopping, DSS)

Definition at line 267 of file PalmWiFiCommon.h.

#define BSSINFO_NETWORK_TYPE_SIZE 4

Offset = 56 (0x38). Network type in use (Freq. hopping, DSS)

Definition at line 268 of file PalmWiFiCommon.h.

#define BSSINFO_NETWORK_TYPE_VFLAG 0x00000020L

Offset = 56 (0x38). Network type in use (Freq. hopping, DSS)

Definition at line 269 of file PalmWiFiCommon.h.

#define BSSINFO_RSSI_OFFSET (BSSINFO_WEP_OFFSET + BSSINFO_WEP_SIZE)

Offset = 52 (0x34). Received Signal Strength

Definition at line 260 of file PalmWiFiCommon.h.

#define BSSINFO_RSSI_SIZE 4

Offset = 52 (0x34). Received Signal Strength

Definition at line 261 of file PalmWiFiCommon.h.

#define BSSINFO_RSSI_VFLAG 0x00000010L

Offset = 52 (0x34). Received Signal Strength

Definition at line 262 of file PalmWiFiCommon.h.

#define BSSINFO_SIZE (BSSINFO_ANL_OFFSET + BSSINFO_ANL_SIZE)

Total size of the BSS info supplied.

Definition at line 343 of file PalmWiFiCommon.h.

#define BSSINFO_SSID_OFFSET (BSSINFO_SSIDLENGTH_OFFSET + BSSINFO_SSIDLENGTH_SIZE)

Offset = 16 (0x10). SSID

Definition at line 246 of file PalmWiFiCommon.h.

#define BSSINFO_SSID_SIZE netSSIDMaxLength

Offset = 16 (0x10). SSID

Definition at line 247 of file PalmWiFiCommon.h.

#define BSSINFO_SSID_VFLAG 0x00000004L

Offset = 16 (0x10). SSID

Definition at line 248 of file PalmWiFiCommon.h.

#define BSSINFO_SSIDLENGTH_OFFSET (BSSINFO_MAC_ADDR_OFFSET + BSSINFO_MAC_ADDR_SIZE)

Offset = 12. Length of the following SSID

Definition at line 239 of file PalmWiFiCommon.h.

#define BSSINFO_SSIDLENGTH_SIZE 4

Offset = 12. Length of the following SSID

Definition at line 240 of file PalmWiFiCommon.h.

#define BSSINFO_SSIDLENGTH_VFLAG 0x00000002L

Offset = 12. Length of the following SSID

Definition at line 241 of file PalmWiFiCommon.h.

#define BSSINFO_SUPPORTED_RATES_OFFSET (BSSINFO_NETWORK_MODE_OFFSET + BSSINFO_NETWORK_MODE_SIZE)

Offset = 88 (0x58). Supported rates on interface.

Definition at line 323 of file PalmWiFiCommon.h.

#define BSSINFO_SUPPORTED_RATES_SIZE 8

Offset = 88 (0x58). Supported rates on interface.

Definition at line 324 of file PalmWiFiCommon.h.

#define BSSINFO_SUPPORTED_RATES_VFLAG 0x00002000L

Offset = 88 (0x58). Supported rates on interface.

Definition at line 325 of file PalmWiFiCommon.h.

#define BSSINFO_VFLAG 0

Offset = 0. Present/validity flags for each of the entities defined below

Definition at line 226 of file PalmWiFiCommon.h.

#define BSSINFO_VFLAG_SIZE 4

Offset = 0. Present/validity flags for each of the entities defined below

Definition at line 227 of file PalmWiFiCommon.h.

#define BSSINFO_WEP_OFFSET (BSSINFO_SSID_OFFSET + BSSINFO_SSID_SIZE)

Offset = 48 (0x30). WEP enabled boolean

Definition at line 253 of file PalmWiFiCommon.h.

#define BSSINFO_WEP_SIZE 4

Offset = 48 (0x30). WEP enabled boolean

Definition at line 254 of file PalmWiFiCommon.h.

#define BSSINFO_WEP_VFLAG 0x00000008L

Offset = 48 (0x30). WEP enabled boolean

Definition at line 255 of file PalmWiFiCommon.h.

#define BssInfoANL | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_ANL_OFFSET], BSSINFO_ANL_SIZE )

Definition at line 362 of file PalmWiFiCommon.h.

#define BssInfoAtimWindow | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_ATIM_WINDOW_OFFSET], BSSINFO_ATIM_WINDOW_SIZE )

Definition at line 354 of file PalmWiFiCommon.h.

#define BssInfoBeaconPeriod | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_BEACON_PERIOD_OFFSET], BSSINFO_BEACON_PERIOD_SIZE )

Definition at line 353 of file PalmWiFiCommon.h.

#define BssInfoChannelId | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_CHID_OFFSET], BSSINFO_CHID_SIZE )

Definition at line 361 of file PalmWiFiCommon.h.

#define BssInfoDSFreq | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_DSFREQ_OFFSET], BSSINFO_DSFREQ_SIZE )

Definition at line 355 of file PalmWiFiCommon.h.

#define BssInfoHopDwell | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_HOPDWELL_OFFSET], BSSINFO_HOPDWELL_SIZE )

Definition at line 358 of file PalmWiFiCommon.h.

#define BssInfoHopPattern | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_HOPPATTERN_OFFSET], BSSINFO_HOPPATTERN_SIZE )

Definition at line 356 of file PalmWiFiCommon.h.

#define BssInfoHopSet | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_HOPSET_OFFSET], BSSINFO_HOPSET_SIZE )

Definition at line 357 of file PalmWiFiCommon.h.

#define BssInfoMacAddr | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_MAC_ADDR_OFFSET], BSSINFO_MAC_ADDR_SIZE )

Definition at line 347 of file PalmWiFiCommon.h.

#define BssInfoNetworkMode | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_NETWORK_MODE_OFFSET], BSSINFO_NETWORK_MODE_SIZE )

Definition at line 359 of file PalmWiFiCommon.h.

#define BssInfoNetworkType | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_NETWORK_TYPE_OFFSET], BSSINFO_NETWORK_TYPE_SIZE )

Definition at line 352 of file PalmWiFiCommon.h.

#define BssInfoRssi | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_RSSI_OFFSET], BSSINFO_RSSI_SIZE )

Definition at line 351 of file PalmWiFiCommon.h.

#define BssInfoSsid | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_SSID_OFFSET], BSSINFO_SSID_SIZE )

Definition at line 349 of file PalmWiFiCommon.h.

#define BssInfoSsidLength | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_SSIDLENGTH_OFFSET], BSSINFO_SSIDLENGTH_SIZE )

Definition at line 348 of file PalmWiFiCommon.h.

#define BssInfoSupportedRates | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_SUPPORTED_RATES_OFFSET], BSSINFO_SUPPORTED_RATES_SIZE )

Definition at line 360 of file PalmWiFiCommon.h.

#define BssInfoWep | ( | infoP,
|  | destP |  | ) | MemMove( destP, &((UInt8 *) infoP)[BSSINFO_WEP_OFFSET], BSSINFO_WEP_SIZE )

Definition at line 350 of file PalmWiFiCommon.h.

#define ENHANCED_TX_POWER 1

Definition at line 118 of file PalmWiFiCommon.h.

#define errNetInterfaceNotFound 14

Definition at line 214 of file PalmWiFiCommon.h.

#define errNetLibMissing 13

Definition at line 213 of file PalmWiFiCommon.h.

#define errNetOutOfMemory 12

Definition at line 212 of file PalmWiFiCommon.h.

#define errNetQueryBufTooSmall 11

Definition at line 211 of file PalmWiFiCommon.h.

#define ESS 1

Operating mode, referred to as port type in the configuration.

Definition at line 109 of file PalmWiFiCommon.h.

#define FULL_TX_POWER 0

Definition at line 123 of file PalmWiFiCommon.h.

#define IBSS 4

Definition at line 113 of file PalmWiFiCommon.h.

#define LONG_PREAMBLE 0

Definition at line 141 of file PalmWiFiCommon.h.

#define net80211ResetWepPasscode 0x41149339

Special code required to be passed to reset wep keys

Definition at line 147 of file PalmWiFiCommon.h.

#define netMacAddrLength 6

max length MAC address

Definition at line 196 of file PalmWiFiCommon.h.

#define netMediaConnected 1

Definitions of media states returned from netQuery80211MediaState

Definition at line 152 of file PalmWiFiCommon.h.

#define netMediaDisconnected 0

Definitions of media states returned from netQuery80211MediaState

Definition at line 150 of file PalmWiFiCommon.h.

#define netNum80211Rates 8

no definition

Definition at line 198 of file PalmWiFiCommon.h.

#define netSSIDMaxLength 32

max length SSID

Definition at line 197 of file PalmWiFiCommon.h.

#define PALM_OS_20_VERSION sysMakeROMVersion(2,0,0,sysROMStageDevelopment,0)

Define the appropriate minimum OS version we support

Definition at line 25 of file PalmWiFiCommon.h.

#define SHORT_PREAMBLE 1

Definition at line 142 of file PalmWiFiCommon.h.

#define WIFI_ASSOCIATED_EVENT 'WiAs'

Definition at line 45 of file PalmWiFiCommon.h.

#define WIFI_CONFIG_NAME "WiFi Config"

WiFi configuration name

Definition at line 30 of file PalmWiFiCommon.h.

#define WIFI_CREATOR_ID 'WiFi'

WiFi creator ID.

Definition at line 28 of file PalmWiFiCommon.h.

#define WIFI_DB_NAME "WiFiDB"

WiFi database name

Definition at line 35 of file PalmWiFiCommon.h.

#define WIFI_DB_TYPE 'DATA'

WiFi database type

Definition at line 33 of file PalmWiFiCommon.h.

#define WIFI_DISASSOCIATED_EVENT 'WiDi'

Definition at line 46 of file PalmWiFiCommon.h.

#define WIFI_DRIVER_NAME "WiFi Prism3"

WiFi driver name

Definition at line 40 of file PalmWiFiCommon.h.

#define WIFI_DRIVER_PREFIX "wi"

WiFi driver prefix

Definition at line 38 of file PalmWiFiCommon.h.

#define WIFI_IF_DOWN_EVENT 'WiDn'

Definition at line 49 of file PalmWiFiCommon.h.

#define WIFI_IF_UP_EVENT 'WiUp'

Definition at line 48 of file PalmWiFiCommon.h.

#define WIFI_MIN_OS_VERSION sysMakeROMVersion(3,0,0,sysROMStageDevelopment,0)

Define the appropriate minimum OS version we support

Definition at line 23 of file PalmWiFiCommon.h.

#define WIFI_SCAN_COMPLETE_EVENT 'WiSc'

Definition at line 47 of file PalmWiFiCommon.h.

## Typedef Documentation

typedef enum _80211InfrastructureEnum Net80211InfrastructureModeType

Infrastructure mode info returned from a BSS scan

typedef enum _80211NetworkTypeEnum Net80211NetworkType

typedef struct NetBssInfoType * NetBssInfoTypeP

Structure to hold BSS Info data.

Accessing the BSS scan info returned via the network interface via the following structure needs to be verified for each specific toolchain and compiler. It has been verified with the combination of ADS V1.2 and CW 8.3. The data format has been done to be as toolchain/architecture/alignment independent as possible, however, if a different combination other than the one listed is used, the format must be verified. The macro's defined above can also be used to access the individual entities of the returned BSS scan data.

typedef struct BSSListStruct NetBssListType

BSS list.

This data structure is returned from a BSS scan. The count field indicates how many BSS structures are provide.

typedef struct NetworkDeviceQueryData NetQueryType

Structure to hold network query data.

typedef struct NetworkDeviceQueryData * NetQueryTypeP

Structure to hold network query data.

typedef struct NetSSID * NetSSIDP

Structure used to get and set the current SSID for the driver (not the Network interface).

typedef struct NetWepKey * NetWepKeyP

Structure used to set the wep keys.

The API's do not return the wep keys via a query.

## Enumeration Type Documentation

enum _80211InfrastructureEnum

Infrastructure mode info returned from a BSS scan

Enumerator:

  net80211Bss |
  net80211Infrastructure |
  net80211AutoUnknown |
  net80211InfrastructureMax |

Definition at line 425 of file PalmWiFiCommon.h.

    00426 {
    00427     net80211Bss,
    00428     net80211Infrastructure,
    00429     net80211AutoUnknown,
    00430     net80211InfrastructureMax           // Never returned from scan.  Can be used for bounds checking.
    00431 } Net80211InfrastructureModeType;

enum _80211NetworkTypeEnum

Enumerator:

  net80211_FH |
  net80211_DS |
  net80211_Max |

Definition at line 417 of file PalmWiFiCommon.h.

    00418 {
    00419     net80211_FH,
    00420     net80211_DS,
    00421     net80211_Max            // Never returned from scan.  Can be used for bounds checking
    00422 } Net80211NetworkType;

enum IPAllocType

IP address allocation strategies

Enumerator:

  IPAllocType_DHCP |
  IPAllocType_APIPA |
  IPAllocType_STATIC |

Definition at line 86 of file PalmWiFiCommon.h.

    00087 {
    00088     IPAllocType_DHCP   = 0,
    00089     IPAllocType_APIPA  = 1,
    00090     IPAllocType_STATIC = 2
    00091 };

enum NetQueryId

Supported Query requests for WiFi driver.

Enumerator:

  netQuery80211SignalStrength |
  netQuery80211SignalQuality |
  netQuery80211AuthenticationMode |
  netQuery80211BssScan |
  netQuery80211BssScanList |
  netQuery80211Channel |
  netQuery80211PowerState |
  netQuery80211RadioState |
  netQuery80211SSID |
  netQuery80211Key |
  netQuery80211KeyIndex |
  netQuery80211ResetKeys |
  netQuery80211OperatingMode |
  netQuery80211WepStatus |
  netQuery80211FirmwareVersion |
  netQuery80211SerialNumber |
  netQuery80211FWName |
  netQuery80211DriverDate |
  netQuery80211WEPRequired |
  netQuery80211ChannelList |
  netQuery80211BSSID |
  netQueryCancel |
  netQuery80211MediaState |
  netQuery80211SecurityMode |
  netQuery80211StartConnection |
  netQuery80211Last |

Definition at line 54 of file PalmWiFiCommon.h.

    00055 {
    00056     netQuery80211SignalStrength = 0x100,
    00057     netQuery80211SignalQuality,
    00058     netQuery80211AuthenticationMode,
    00059     netQuery80211BssScan,
    00060     netQuery80211BssScanList,
    00061     netQuery80211Channel,
    00062     netQuery80211PowerState,
    00063     netQuery80211RadioState,
    00064     netQuery80211SSID,
    00065     netQuery80211Key,
    00066     netQuery80211KeyIndex,
    00067     netQuery80211ResetKeys,
    00068     netQuery80211OperatingMode,
    00069     netQuery80211WepStatus,
    00070     netQuery80211FirmwareVersion,
    00071     netQuery80211SerialNumber,
    00072     netQuery80211FWName,
    00073     netQuery80211DriverDate,
    00074     netQuery80211WEPRequired,
    00075     netQuery80211ChannelList,
    00076     netQuery80211BSSID,
    00077     netQueryCancel,
    00078     netQuery80211MediaState,
    00079     netQuery80211SecurityMode, // use security mode #defines
    00080     netQuery80211StartConnection,
    00081     netQuery80211Last
    00082 } NetQueryId;

enum NetWepStatus

Wep status codes

Enumerator:

  netWEPEnabled |
  netWEPDisabled |
  netWEPKeyAbsent |
  netWEPNotSupported |

Definition at line 201 of file PalmWiFiCommon.h.

    00202 {
    00203     netWEPEnabled,
    00204     netWEPDisabled,
    00205     netWEPKeyAbsent,
    00206     netWEPNotSupported
    00207 };

enum SecurityModeType

Enumerator:

  SecurityModeOpenSystem |
  SecurityModeWEP |
  SecurityModeWPAPSK |
  SecurityModeLast |

Definition at line 93 of file PalmWiFiCommon.h.

    00094 {
    00095     SecurityModeOpenSystem = 0,
    00096     SecurityModeWEP,
    00097     SecurityModeWPAPSK,
    00098     SecurityModeLast
    00099 };

enum WiFiCustomIFSettings

Enumerator:

  netIFSetting80211PowerMode |
  netIFSetting80211Diversity |
  netIFSetting80211Channel |
  netIFSetting80211EncryptionKey1 |
  netIFSetting80211EncryptionKey2 |
  netIFSetting80211EncryptionKey3 |
  netIFSetting80211EncryptionKey4 |
  netIFSetting80211EncryptionKeyID |
  netIFSetting80211MandatoryBSSId |
  netIFSetting80211MUEncryptionAlgorithm |
  netIFSetting80211PortType |
  netIFSetting80211EssTxPower |
  netIFSetting80211AdhocTxPower |
  netIFSetting80211StationName |
  netIFSetting80211Environment |
  netIFSetting80211LongPreamble |
  netIFSetting80211Gateway |
  netIFSettingPrimaryDNS |
  netIFSettingSecondaryDNS |
  netIFSettingDHCPRequestDNS |
  netIFSettingIPAllocType |
  netIFSetting80211SmartConnect |
  netIFSettingUIProgHoldOff |
  netIFSettingWiFiHideProgress |
  netIFSettingAutoPowerDownOnClose |
  netIFSettingInterfaceQSize |
  netIFSettingDriverQSize |
  netIFSetting8021x |
  netIFSetting80211MediaDisconnectLingerTime |
  netIFSetting80211MobileIP |
  netIFSetting80211Last |

Definition at line 154 of file PalmWiFiCommon.h.

    00155 {
    00156     netIFSetting80211PowerMode = netIFSettingCustom,
    00157     netIFSetting80211Diversity,
    00158     netIFSetting80211Channel,
    00159     netIFSetting80211EncryptionKey1,
    00160     netIFSetting80211EncryptionKey2,
    00161     netIFSetting80211EncryptionKey3,
    00162     netIFSetting80211EncryptionKey4,
    00163     netIFSetting80211EncryptionKeyID,
    00164     netIFSetting80211MandatoryBSSId,
    00165     netIFSetting80211MUEncryptionAlgorithm,
    00166     netIFSetting80211PortType,  // ESS, PsIBBS, IBSS
    00167     netIFSetting80211EssTxPower,
    00168     netIFSetting80211AdhocTxPower,
    00169     netIFSetting80211StationName,
    00170     netIFSetting80211Environment,
    00171     netIFSetting80211LongPreamble,
    00172     netIFSetting80211Gateway,
    00173     netIFSettingPrimaryDNS,
    00174     netIFSettingSecondaryDNS,
    00175     netIFSettingDHCPRequestDNS,
    00176     netIFSettingIPAllocType, // 0,1,2=DHCP,APIPA,STATIC
    00177     netIFSetting80211SmartConnect,
    00178     netIFSettingUIProgHoldOff,
    00179     netIFSettingWiFiHideProgress,
    00180     netIFSettingAutoPowerDownOnClose,
    00181     netIFSettingInterfaceQSize,
    00182     netIFSettingDriverQSize,
    00183     netIFSetting8021x,
    00184     netIFSetting80211MediaDisconnectLingerTime,
    00185     netIFSetting80211MobileIP,
    00186
    00187 #ifdef WIFI_DOT1X_SUPPORT
    00188     netIFSettingDot1XWPPICreator,
    00189     netIFSettingDot1XAuthenticationMethodID,
    00190     netIFSettingDot1XAuthenticationCookie,
    00191 #endif // WIFI_DOT1X_SUPPORT
    00192
    00193     netIFSetting80211Last
    00194 };

Top | Palm Developer Network © 2004-2008, Palm, Inc. All rights reserved. Generated on Fri Jun 13 10:08:00 2008 for Palm API Guide