smi Namespace Reference

Classes
class	SmiFactory
class	ISmi
class	IDellCallingInterfaceSmi
class	SmiFactoryImpl
class	SmiStrategy
class	SmiMockStrategy
class	SmiArchStrategy
class	DellCallingInterfaceSmiImpl
struct	callintf_cmd
struct	calling_interface_command_buffer
Enumerations
enum	password_format_enum { PW_FORMAT_UNKNOWN, PW_FORMAT_SCAN_CODE, PW_FORMAT_ASCII }
enum	{ class_user_password = 9, class_admin_password = 10 }
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)
void	doSimpleCallingInterfaceSmi (u16 smiClass, u16 select, const u32 args[4], u32 res[4])
std::auto_ptr< smi::IDellCallingInterfaceSmi >	setupCallingInterfaceSmi (u16 smiClass, u16 select, const u32 args[4])
u32	getAuthenticationKey (const std::string &password)
password_format_enum	getPasswordFormat ()
std::string	getServiceTag ()
void	setServiceTag (const std::string &password, const std::string &newTag)
std::string	getAssetTag ()
void	setAssetTag (const std::string &password, const std::string &newTag)
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)
static bool	getPasswordPropertiesII (u16 which, u8 &maxLen, u8 &minLen, u8 &props)
static u32	getAuthenticationKeyII (const string &password)
u32	getAuthenticationKey (const string &password)
static u32	readSetting (u16 select, u32 location, u32 *minValue, u32 *maxValue)
static u32	writeSetting (const std::string &password, u16 select, u32 location, u32 newValue, u32 *minValue, u32 *maxValue)
void	setPropertyOwnershipTag (const string password, const char *newTag, size_t size)
	DEFINE_EXCEPTION_EX (InvalidSmiModeImpl, smi, InvalidSmiMode)
	DEFINE_EXCEPTION_EX (ParameterErrorImpl, smi, ParameterError)
	DEFINE_EXCEPTION_EX (UnsupportedSmiImpl, smi, UnsupportedSmi)
	DEFINE_EXCEPTION_EX (UnhandledSmiImpl, smi, UnhandledSmi)
	DEFINE_EXCEPTION_EX (SmiExecutedWithErrorImpl, smi, SmiExecutedWithError)
	DEFINE_EXCEPTION_EX (PasswordVerificationFailedImpl, smi, PasswordVerificationFailed)
Variables
smi::callintf_cmd	LIBSMBIOS_PACKED_ATTR
smi::calling_interface_command_buffer	LIBSMBIOS_PACKED_ATTR

---

Enumeration Type Documentation

enum password_format_enum

Enumerator:

PW_FORMAT_UNKNOWN
PW_FORMAT_SCAN_CODE
PW_FORMAT_ASCII

Definition at line 100 of file ISmi.h.

anonymous enum

Enumerator:

class_user_password
class_admin_password

Definition at line 81 of file SmiLowLevel.h.

---

Function Documentation

smi::DECLARE_EXCEPTION

(

SmiException

)

Abstract base class for the smi read write operations.

smi::DECLARE_EXCEPTION_EX	(	InvalidSmiMode	,
		smi	,
		SmiException
	)

smi::DECLARE_EXCEPTION_EX	(	ParameterError	,
		smi	,
		SmiException
	)

smi::DECLARE_EXCEPTION_EX	(	UnhandledSmi	,
		smi	,
		SmiException
	)

smi::DECLARE_EXCEPTION_EX	(	UnsupportedSmi	,
		smi	,
		SmiException
	)

smi::DECLARE_EXCEPTION_EX	(	SmiExecutedWithError	,
		smi	,
		SmiException
	)

smi::DECLARE_EXCEPTION_EX	(	PasswordVerificationFailed	,
		smi	,
		SmiException
	)

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

Definition at line 237 of file Smi.cpp.

References setupCallingInterfaceSmi().

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

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

Definition at line 190 of file Smi.cpp.

References calling_interface_structure::cmdIOAddress, calling_interface_structure::cmdIOCode, SmiFactory::DELL_CALLING_INTERFACE_SMI, SmiFactory::getFactory(), SmbiosFactory::getFactory(), SmiFactory::makeNew(), IDellCallingInterfaceSmi::setArg(), IDellCallingInterfaceSmi::setClass(), and IDellCallingInterfaceSmi::setSelect().

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

u32 smi::getAuthenticationKey

(

const std::string &

password

)

Referenced by smbios::executeWithPassword(), setPropertyOwnershipTag(), setTagUsingSMI(), and writeSetting().

password_format_enum getPasswordFormat

(

)

Definition at line 416 of file Smi.cpp.

References class_admin_password, class_user_password, doSimpleCallingInterfaceSmi(), getPasswordPropertiesII(), PW_FORMAT_ASCII, PW_FORMAT_SCAN_CODE, and PW_FORMAT_UNKNOWN.

Referenced by SMBIOSGetSmiPasswordCoding().

std::string smi::getServiceTag

(

)

void smi::setServiceTag	(	const std::string &	password,
		const std::string &	newTag
	)

std::string smi::getAssetTag

(

)

void smi::setAssetTag	(	const std::string &	password,
		const std::string &	newTag
	)

u32 readNVStorage	(	u32	location,
		u32 *	minValue,
		u32 *	maxValue
	)

Definition at line 479 of file Smi.cpp.

References readSetting().

u32 readBatteryModeSetting	(	u32	location,
		u32 *	minValue,
		u32 *	maxValue
	)

Definition at line 484 of file Smi.cpp.

References readSetting().

u32 readACModeSetting	(	u32	location,
		u32 *	minValue,
		u32 *	maxValue
	)

Definition at line 489 of file Smi.cpp.

References readSetting().

u32 readSystemStatus

(

u32 *

failingSensorHandle

)

Definition at line 494 of file Smi.cpp.

References readSetting().

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

Definition at line 533 of file Smi.cpp.

References writeSetting().

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

Definition at line 538 of file Smi.cpp.

References writeSetting().

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

Definition at line 543 of file Smi.cpp.

References writeSetting().

void getDisplayType	(	u32 &	type,
		u32 &	resolution,
		u32 &	memSizeX256kb
	)

Definition at line 548 of file Smi.cpp.

References doSimpleCallingInterfaceSmi().

void getPanelResolution	(	u32 &	horiz,
		u32 &	vert
	)

Definition at line 558 of file Smi.cpp.

References doSimpleCallingInterfaceSmi().

void getActiveDisplays

(

u32 &

bits

)

Definition at line 567 of file Smi.cpp.

References doSimpleCallingInterfaceSmi().

void setActiveDisplays

(

u32 &

bits

)

Definition at line 575 of file Smi.cpp.

References doSimpleCallingInterfaceSmi().

void getPropertyOwnershipTag	(	char *	tagBuf,
		size_t	size
	)

Definition at line 581 of file Smi.cpp.

References setupCallingInterfaceSmi().

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

static bool smi::getPasswordPropertiesII	(	u16	which,
		u8 &	maxLen,
		u8 &	minLen,
		u8 &	props
	)			[static]

Definition at line 263 of file Smi.cpp.

References DCERR, and doSimpleCallingInterfaceSmi().

Referenced by getAuthenticationKeyII(), and getPasswordFormat().

static u32 smi::getAuthenticationKeyII

(

const string &

password

)

[static]

Definition at line 294 of file Smi.cpp.

References class_admin_password, class_user_password, DCERR, getPasswordPropertiesII(), and setupCallingInterfaceSmi().

Referenced by getAuthenticationKey().

u32 smi::getAuthenticationKey

(

const string &

password

)

Definition at line 355 of file Smi.cpp.

References class_admin_password, class_user_password, DCERR, doSimpleCallingInterfaceSmi(), and getAuthenticationKeyII().

static u32 smi::readSetting	(	u16	select,
		u32	location,
		u32 *	minValue,
		u32 *	maxValue
	)			[static]

Definition at line 468 of file Smi.cpp.

References doSimpleCallingInterfaceSmi().

Referenced by readACModeSetting(), readBatteryModeSetting(), readNVStorage(), and readSystemStatus().

static u32 smi::writeSetting	(	const std::string &	password,
		u16	select,
		u32	location,
		u32	newValue,
		u32 *	minValue,
		u32 *	maxValue
	)			[static]

Definition at line 503 of file Smi.cpp.

References doSimpleCallingInterfaceSmi(), and getAuthenticationKey().

Referenced by writeACModeSetting(), writeBatteryModeSetting(), and writeNVStorage().

void smi::setPropertyOwnershipTag	(	const string	password,
		const char *	newTag,
		size_t	size
	)

Definition at line 592 of file Smi.cpp.

References getAuthenticationKey(), and setupCallingInterfaceSmi().

smi::DEFINE_EXCEPTION_EX	(	InvalidSmiModeImpl	,
		smi	,
		InvalidSmiMode
	)

smi::DEFINE_EXCEPTION_EX	(	ParameterErrorImpl	,
		smi	,
		ParameterError
	)

smi::DEFINE_EXCEPTION_EX	(	UnsupportedSmiImpl	,
		smi	,
		UnsupportedSmi
	)

smi::DEFINE_EXCEPTION_EX	(	UnhandledSmiImpl	,
		smi	,
		UnhandledSmi
	)

smi::DEFINE_EXCEPTION_EX	(	SmiExecutedWithErrorImpl	,
		smi	,
		SmiExecutedWithError
	)

smi::DEFINE_EXCEPTION_EX	(	PasswordVerificationFailedImpl	,
		smi	,
		PasswordVerificationFailed
	)

---

Variable Documentation

struct smi::callintf_cmd LIBSMBIOS_PACKED_ATTR

struct smi::calling_interface_command_buffer LIBSMBIOS_PACKED_ATTR

---