smapi(4) [debian man page]
SMAPI(4) BSD/i386 Kernel Interfaces Manual SMAPI(4) NAME
smapi -- System Management Application Program Interface driver DESCRIPTION
Many IBM Thinkpad laptops utilize a special software interface known as SMAPI (System Management Application Program Interface). This inter- face controls various aspects of the system including: o System Interface (the BIOS can store system information such as the system identifier), o System Configuration (where devices such as the display can be configured), o Power Management (software can interact with the SMAPI BIOS for Power Management control). Client software must locate a ``header image'' stored in the F000 segment in the Thinkpad ROM (read-only memory), which resides at the 16-byte boundary. This is considered the ``Entry Point'' for the service. The ``header image'' stores information like: o signature, o SMAPI version (major and minor), o header image length, o checksum information (which verifies the image), o an Information Word (used to identify the BIOS service level), o Real Mode Entry Point (where clients using the Real/V86 mode for the far-call value), o and finally a 16-bit/32-bit Protected Mode Entry Point: base code address which specifies the BIOS physical address. The client must prepare a 64 kilobyte selector for this BIOS). To invoke the SMAPI BIOS, a far-call must be used on the entry point specified in the header file. All other information should be stored in the client data area. The client is required to prepare both an input and output parameter in a data area of its own. This area can be ``informed'' by pushing those pointers into its stack before the far-calls. The SMAPI BIOS uses the stack and data areas with the selector during a BIOS invocation, thus the caller must define the same privilege area as the BIOS. The parameter structure will be made up by using the input and output fields prepared by the caller. The input field will specify the func- tion request to the BIOS. The BIOS will then drop a return value into the output field. These fields are made up of three parts. The first holds parameters, function numbers, and return codes. The next will contain an offset in hexadecimal. Finally a length field which is com- prised of Byte, Word, or Double Word. SEE ALSO
IBM Thinkpad 560/560E Technical Reference, 06J0536 S76H-7587-01. IBM Thinkpad 560Z Technical Reference, xxxxxxx xxxx-xxxx-xx. IBM Thinkpad 600 Technical Reference, xxxxxxx xxxx-xxxx-xx. IBM Thinkpad 760XD/760XL/765D/765L Technical Reference, 06J0537 S30H-2433-02. IBM Thinkpad 770 Technical Reference, 05L1739 S05L-1739-00. AUTHORS
The smapi driver was written by Matthew N. Dodd <mdodd@FreeBSD.org>. This manual page was written by Tom Rhodes <trhodes@FreeBSD.org> and Matthew N. Dodd <mdodd@FreeBSD.org>. BSD
April 1, 2003 BSD
Check Out this Related Man Page
smbios(1M) System Administration Commands smbios(1M) NAME
smbios - display the contents of a System Management BIOS image SYNOPSIS
smbios [-BeOsx] [-i id] [-t type] [-w file] [file] DESCRIPTION
The smbios utility displays the contents of the System Management BIOS (SMBIOS) image exported by the current system or stored in a file. SMBIOS is an industry-standard mechanism for low-level system software to export hardware configuration information to higher-level system management software. The SMBIOS data format itself is defined by the Distributed Management Task Force (DMTF). Refer to http://www.dmtf.org for more information about SMBIOS and to obtain a copy of the SMBIOS specification and implementation guidelines. The SMBIOS image consists of a table of structures, each describing some aspect of the system software or hardware configuration. By default, smbios displays the entire contents of the current SMBIOS image. If the -s option is specified, smbios displays a summary of the structures that are present in the image. If the -w option is specified, smbios writes a copy of the SMBIOS image to the specified file. smbios can then be applied to the resulting file to display its content. smbios attempts to display each structure and its content in a human- readable fashion. If smbios does not recognize a structure's type or content, the raw hexadecimal data for the structure is displayed. OPTIONS
The following options are supported: -B Disable header validation for broken BIOSes. By default, smbios attempts to validate the SMBIOS header by verifying the anchor strings, header checksums, and version number. This option might be necessary when a BIOS has a non-compliant header. -e Display the contents of the SMBIOS entry point rather than the contents of the SMBIOS structure table. -i id Display only the specified structure, named by its integer id. -O Display obsolete structure types. By default, smbios elides output for structures whose type is marked as obsolete in the DMTF SMBIOS specification. -s Display only a summary listing of the structure identifiers and types, instead of the content of each selected structure. -t type Display only those structures whose type matches the specified integer type, as defined the DMTF SMBIOS specification. -w file Write a copy of the SMBIOS image to the specified file and exit. The SMBIOS entry point is written to the start of the file with its structure table address set to the file offset of the struc- ture table, and a new entry point checksum is computed. -x Display raw hexadecimal data for the selected structures in addition to human-readable output. By default, hexadecimal data is only displayed if smbios cannot display human-readable output for the selected structures. OPERANDS
The following operands are supported: file Specifies an alternate SMBIOS image to display instead of the current system's SMBIOS image. EXIT STATUS
The following exit values are returned: 0 Successful completion. All structures in the SMBIOS image were examined successfully. 1 A fatal error occurred, such as failure to open the specified file or device, or corruption in the image. 2 Invalid command-line options were specified. FILES
/dev/smbios Kernel SMBIOS image device. This device special file is used to export a snapshot of the current system SMBIOS image. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Availability |SUNWcsu | +-----------------------------+-----------------------------+ |Interface Stability |See below. | +-----------------------------+-----------------------------+ The command-line options are Evolving. The human-readable output is Unstable. SEE ALSO
prtdiag(1M), attributes(5), smbios(7D) System Management BIOS Reference Specification (see http://www.dmtf.org) NOTES
The implementation of a System Management BIOS image is entirely at the discretion of the system and BIOS vendors. Not all systems export an SMBIOS. The SMBIOS structure content varies widely between systems and BIOS vendors and frequently does not comply with the guidelines included in the specification. Some structure fields might not be filled in by the BIOS at all, and others might be filled inwith non-con- forming values. SunOS 5.11 31 Aug 2005 smbios(1M)