Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

ISmi.h File Reference

#include "smbios/compat.h"
#include <iostream>
#include <memory>
#include "smbios/types.h"
#include "smbios/IFactory.h"
#include "smbios/IException.h"
#include "smbios/config/abi_prefix.hpp"
#include "smbios/config/abi_suffix.hpp"

Go to the source code of this file.

Namespaces

namespace  smi

Classes

class  IDellCallingInterfaceSmi
class  SmiFactory

Enumerations

enum  { cbARG1 = 0, cbARG2 = 1, cbARG3 = 2, cbARG4 = 3 }
enum  { cbRES1 = 0, cbRES2 = 1, cbRES3 = 2, cbRES4 = 3 }
enum  password_format_enum { PW_FORMAT_UNKNOWN, PW_FORMAT_SCAN_CODE, PW_FORMAT_ASCII }
enum  radioNum { WLAN_RADIO_NUM = 1, BLUETOOTH_RADIO_NUM = 2, WWAN_RADIO_NUM = 3 }
enum  { WLAN_SWITCH_CTL = 1, BLUETOOTH_SWITCH_CTL = 2, WWAN_SWITCH_CTL = 4, LOCATOR_SWITCH_CTL = 5 }
enum  radioStatusCode {
  STATUS_ENABLED, STATUS_DISABLED, STATUS_NOT_PRESENT, STATUS_UNSUPPORTED,
  STATUS_UNKNOWN
}

Functions

 DECLARE_EXCEPTION (SmiException)
 Abstract base class for the smi read write operations.
 DECLARE_EXCEPTION_EX (InvalidSmiMode, smi, SmiException)
 DECLARE_EXCEPTION_EX (ParameterError, smi, SmiException)
 DECLARE_EXCEPTION_EX (UnhandledSmi, smi, SmiException)
 DECLARE_EXCEPTION_EX (UnsupportedSmi, smi, SmiException)
 DECLARE_EXCEPTION_EX (SmiExecutedWithError, smi, SmiException)
 DECLARE_EXCEPTION_EX (PasswordVerificationFailed, smi, SmiException)
 DECLARE_EXCEPTION_EX (ConfigError, smi, SmiException)
void doSimpleCallingInterfaceSmi (u16 smiClass, u16 select, const u32 args[4], u32 res[4])
std::auto_ptr< smi::IDellCallingInterfaceSmisetupCallingInterfaceSmi (u16 smiClass, u16 select, const u32 args[4])
u32 getAuthenticationKey (const std::string &password)
password_format_enum getPasswordFormat ()
u32 readNVStorage (u32 location, u32 *minValue, u32 *maxValue)
u32 readBatteryModeSetting (u32 location, u32 *minValue, u32 *maxValue)
u32 readACModeSetting (u32 location, u32 *minValue, u32 *maxValue)
u32 readSystemStatus (u32 *failingSensorHandle)
u32 writeNVStorage (const std::string &password, u32 location, u32 value, u32 *minValue, u32 *maxValue)
u32 writeBatteryModeSetting (const std::string &password, u32 location, u32 value, u32 *minValue, u32 *maxValue)
u32 writeACModeSetting (const std::string &password, u32 location, u32 value, u32 *minValue, u32 *maxValue)
void getDisplayType (u32 &type, u32 &resolution, u32 &memSizeX256kb)
void getPanelResolution (u32 &horiz, u32 &vert)
void getActiveDisplays (u32 &bits)
void setActiveDisplays (u32 &bits)
void getPropertyOwnershipTag (char *tagBuf, size_t size)
void setPropertyOwnershipTag (const std::string password, const char *newTag, size_t size)
void wirelessRadioControl (bool enable, bool boot, bool runtime, int enable_token, int disable_token, int radioNum, std::string password)
void wirelessSwitchControl (bool enable, bool boot, bool runtime, int enable_token, int disable_token, int switchNum, std::string password)
radioStatusCode wirelessRadioStatus (radioNum which, std::ostream &cout=std::cout, u32 defRes2=0)

Variables

const int Bluetooth_Devices_Disable = 0x0153
const int Bluetooth_Devices_Enable = 0x0152
const int Cellular_Radio_Disable = 0x017B
const int Cellular_Radio_Enable = 0x017C
const int WiFi_Locator_Disable = 0x017D
const int WiFi_Locator_Enable = 0x017E
const int Wireless_LAN_Disable = 0x017F
const int Wireless_LAN_Enable = 0x0180
const int Wireless_Switch_Bluetooth_Control_Disable = 0x0181
const int Wireless_Switch_Bluetooth_Control_Enable = 0x0182
const int Wireless_Switch_Cellular_Control_Disable = 0x0183
const int Wireless_Switch_Cellular_Control_Enable = 0x0184
const int Wireless_Switch_Wireless_LAN_Control_Disable = 0x0185
const int Wireless_Switch_Wireless_LAN_Control_Enable = 0x0186
const int Radio_Transmission_Enable = 0x010c
const int Radio_Transmission_Disable = 0x010d
const int Wireless_Device_Disable = 0x0114
const int Wireless_Device_App_Control = 0x0115
const int Wireless_Device_App_Or_Hotkey_Control = 0x0116


Enumeration Type Documentation

anonymous enum
 

Enumeration values:
cbARG1 
cbARG2 
cbARG3 
cbARG4 

Definition at line 86 of file ISmi.h.

anonymous enum
 

Enumeration values:
cbRES1 
cbRES2 
cbRES3 
cbRES4 

Definition at line 87 of file ISmi.h.

anonymous enum
 

Enumeration values:
WLAN_SWITCH_CTL 
BLUETOOTH_SWITCH_CTL 
WWAN_SWITCH_CTL 
LOCATOR_SWITCH_CTL 

Definition at line 150 of file ISmi.h.

enum password_format_enum
 

Enumeration values:
PW_FORMAT_UNKNOWN 
PW_FORMAT_SCAN_CODE 
PW_FORMAT_ASCII 

Definition at line 96 of file ISmi.h.

Referenced by smi::getPasswordFormat().

enum radioNum
 

Enumeration values:
WLAN_RADIO_NUM 
BLUETOOTH_RADIO_NUM 
WWAN_RADIO_NUM 

Definition at line 147 of file ISmi.h.

enum radioStatusCode
 

Enumeration values:
STATUS_ENABLED 
STATUS_DISABLED 
STATUS_NOT_PRESENT 
STATUS_UNSUPPORTED 
STATUS_UNKNOWN 

Definition at line 153 of file ISmi.h.

Referenced by smi::wirelessRadioStatus().


Function Documentation

DECLARE_EXCEPTION SmiException   ) 
 

Abstract base class for the smi read write operations.

DECLARE_EXCEPTION_EX ConfigError  ,
smi  ,
SmiException 
 

DECLARE_EXCEPTION_EX PasswordVerificationFailed  ,
smi  ,
SmiException 
 

DECLARE_EXCEPTION_EX SmiExecutedWithError  ,
smi  ,
SmiException 
 

DECLARE_EXCEPTION_EX UnsupportedSmi  ,
smi  ,
SmiException 
 

DECLARE_EXCEPTION_EX UnhandledSmi  ,
smi  ,
SmiException 
 

DECLARE_EXCEPTION_EX ParameterError  ,
smi  ,
SmiException 
 

DECLARE_EXCEPTION_EX InvalidSmiMode  ,
smi  ,
SmiException 
 

void doSimpleCallingInterfaceSmi u16  smiClass,
u16  select,
const u32  args[4],
u32  res[4]
 

Definition at line 211 of file Smi.cpp.

References smi::setupCallingInterfaceSmi().

Referenced by smi::getActiveDisplays(), smi::getAuthenticationKey(), smi::getDisplayType(), smi::getPanelResolution(), smi::getPasswordFormat(), smi::getPasswordPropertiesII(), getTagFromSMI(), smi::readSetting(), smi::setActiveDisplays(), setTagUsingSMI(), smi::wirelessRadioControl(), smi::wirelessRadioStatus(), and smi::writeSetting().

void getActiveDisplays u32 bits  ) 
 

Definition at line 545 of file Smi.cpp.

References smi::doSimpleCallingInterfaceSmi(), and u32.

u32 getAuthenticationKey const std::string &  password  ) 
 

Referenced by smi::setPropertyOwnershipTag(), setTagUsingSMI(), and smi::writeSetting().

void getDisplayType u32 type,
u32 resolution,
u32 memSizeX256kb
 

Definition at line 526 of file Smi.cpp.

References smi::doSimpleCallingInterfaceSmi(), and u32.

void getPanelResolution u32 horiz,
u32 vert
 

Definition at line 536 of file Smi.cpp.

References smi::doSimpleCallingInterfaceSmi(), and u32.

password_format_enum getPasswordFormat  ) 
 

Definition at line 390 of file Smi.cpp.

References smi::class_admin_password, smi::class_user_password, smi::doSimpleCallingInterfaceSmi(), smi::getPasswordPropertiesII(), smi::password_format_enum, u32, and u8.

Referenced by SMBIOSGetSmiPasswordCoding().

void getPropertyOwnershipTag char *  tagBuf,
size_t  size
 

Definition at line 559 of file Smi.cpp.

References smi::setupCallingInterfaceSmi(), and u32.

u32 readACModeSetting u32  location,
u32 minValue,
u32 maxValue
 

Definition at line 463 of file Smi.cpp.

References smi::readSetting(), and u32.

u32 readBatteryModeSetting u32  location,
u32 minValue,
u32 maxValue
 

Definition at line 458 of file Smi.cpp.

References smi::readSetting(), and u32.

u32 readNVStorage u32  location,
u32 minValue,
u32 maxValue
 

Definition at line 453 of file Smi.cpp.

References smi::readSetting(), and u32.

Referenced by SmiTokenDA::isActive().

u32 readSystemStatus u32 failingSensorHandle  ) 
 

Definition at line 468 of file Smi.cpp.

References smi::readSetting(), and u32.

void setActiveDisplays u32 bits  ) 
 

Definition at line 553 of file Smi.cpp.

References smi::doSimpleCallingInterfaceSmi(), and u32.

void setPropertyOwnershipTag const std::string  password,
const char *  newTag,
size_t  size
 

std::auto_ptr< smi::IDellCallingInterfaceSmi > setupCallingInterfaceSmi u16  smiClass,
u16  select,
const u32  args[4]
 

Definition at line 194 of file Smi.cpp.

References SmiFactory::getFactory(), SmbiosFactory::getFactory(), and SmiFactory::makeNew().

Referenced by smi::doSimpleCallingInterfaceSmi(), smi::getAuthenticationKeyII(), smi::getPropertyOwnershipTag(), and smi::setPropertyOwnershipTag().

void wirelessRadioControl bool  enable,
bool  boot,
bool  runtime,
int  enable_token,
int  disable_token,
int  radioNum,
std::string  password
 

Definition at line 641 of file Smi.cpp.

References smbios::activateToken(), smi::doSimpleCallingInterfaceSmi(), smbios::isTokenActive(), and u32.

radioStatusCode wirelessRadioStatus radioNum  which,
std::ostream &  cout = std::cout,
u32  defRes2 = 0
 

Definition at line 740 of file Smi.cpp.

References smi::doSimpleCallingInterfaceSmi(), smi::radioStatusCode, and u32.

void wirelessSwitchControl bool  enable,
bool  boot,
bool  runtime,
int  enable_token,
int  disable_token,
int  switchNum,
std::string  password
 

Definition at line 705 of file Smi.cpp.

References smbios::activateToken(), smi::BLUETOOTH_SWITCH_CTL, smi::LOCATOR_SWITCH_CTL, smi::switchControl(), smi::WLAN_SWITCH_CTL, and smi::WWAN_SWITCH_CTL.

u32 writeACModeSetting const std::string &  password,
u32  location,
u32  value,
u32 minValue,
u32 maxValue
 

Definition at line 521 of file Smi.cpp.

References u32, and smi::writeSetting().

u32 writeBatteryModeSetting const std::string &  password,
u32  location,
u32  value,
u32 minValue,
u32 maxValue
 

Definition at line 516 of file Smi.cpp.

References u32, and smi::writeSetting().

u32 writeNVStorage const std::string &  password,
u32  location,
u32  value,
u32 minValue,
u32 maxValue
 

Definition at line 511 of file Smi.cpp.

References u32, and smi::writeSetting().

Referenced by SmiTokenDA::activate().


Variable Documentation

const int Bluetooth_Devices_Disable = 0x0153
 

Definition at line 602 of file Smi.cpp.

const int Bluetooth_Devices_Enable = 0x0152
 

Definition at line 603 of file Smi.cpp.

const int Cellular_Radio_Disable = 0x017B
 

Definition at line 604 of file Smi.cpp.

const int Cellular_Radio_Enable = 0x017C
 

Definition at line 605 of file Smi.cpp.

const int Radio_Transmission_Disable = 0x010d
 

Definition at line 617 of file Smi.cpp.

const int Radio_Transmission_Enable = 0x010c
 

Definition at line 616 of file Smi.cpp.

const int WiFi_Locator_Disable = 0x017D
 

Definition at line 606 of file Smi.cpp.

const int WiFi_Locator_Enable = 0x017E
 

Definition at line 607 of file Smi.cpp.

const int Wireless_Device_App_Control = 0x0115
 

Definition at line 619 of file Smi.cpp.

const int Wireless_Device_App_Or_Hotkey_Control = 0x0116
 

Definition at line 620 of file Smi.cpp.

const int Wireless_Device_Disable = 0x0114
 

Definition at line 618 of file Smi.cpp.

const int Wireless_LAN_Disable = 0x017F
 

Definition at line 608 of file Smi.cpp.

const int Wireless_LAN_Enable = 0x0180
 

Definition at line 609 of file Smi.cpp.

const int Wireless_Switch_Bluetooth_Control_Disable = 0x0181
 

Definition at line 610 of file Smi.cpp.

const int Wireless_Switch_Bluetooth_Control_Enable = 0x0182
 

Definition at line 611 of file Smi.cpp.

const int Wireless_Switch_Cellular_Control_Disable = 0x0183
 

Definition at line 612 of file Smi.cpp.

const int Wireless_Switch_Cellular_Control_Enable = 0x0184
 

Definition at line 613 of file Smi.cpp.

const int Wireless_Switch_Wireless_LAN_Control_Disable = 0x0185
 

Definition at line 614 of file Smi.cpp.

const int Wireless_Switch_Wireless_LAN_Control_Enable = 0x0186
 

Definition at line 615 of file Smi.cpp.


Generated on Tue Feb 26 14:39:36 2008 for SMBIOS Library by  doxygen 1.3.9.1