farcall.lst

A Programmer s Reference to BIOS, DOS, and Third-Party Calls

--------N-@xxxxxxxx--------------------------
CALL xxxxh:xxxxh - Novell NetWare Lite - CLIENT
InstallCheck:	see INT 2F/AX=D800h
SeeAlso: INT 2F/AX=D800h
--------N-@xxxxxxxx--------------------------
CALL xxxxh:xxxxh - Novell NetWare Lite - NLCACHE/NWCACHE
InstallCheck:	see INT 2F/AX=D8C0h
SeeAlso: INT 2F/AX=D8C0h
--------N-@xxxxxxxx--------------------------
CALL xxxxh:xxxxh - Novell NetWare Lite - SERVER
InstallCheck:	see INT 2F/AX=D880h
SeeAlso: INT 2F/AX=D880h
--------R-@xxxxxxxx--------------------------
CALL xxxxh:xxxxh - pcANYWHERE IV/LAN
InstallCheck:	see INT 21/AX=2B44h/BX=4D41h
SeeAlso: INT 21/AX=2B44h/BX=4D41h
--------X-@xxxxxxxx--------------------------
CALL xxxxh:xxxxh - PCI BIOS v2.0c Protected-Mode API
InstallCheck:	see INT 1A/AX=B101h
SeeAlso: INT 1A/AX=B101h
----------@xxxxxxxx--------------------------
CALL xxxxh:xxxxh - PenDOS PENDEV.SYS
InstallCheck:	see INT 21/AX=4402h"PENDEV"
SeeAlso: INT 21/AX=4402h"PENDEV"
--------E-@xxxxxxxx--------------------------
CALL xxxxh:xxxxh - Phar Lap 386/DOS-Extender v4.1
InstallCheck:	see INT 2F/AX=ED03h
SeeAlso: INT 2F/AX=ED03h
--------X-@xxxxxxxx--------------------------
CALL xxxxh:xxxxh - Plug-and-Play BIOS v1.0A
InstallCheck:	scan paragraph boundaries F000h to FFFFh for signature string
	  "$PnP" followed by a valid Plug-and-Play header structure
	  (see #F0024)
SeeAlso: @xxxxh:xxxxh"BIOS32 Service Directory",INT 1A/AH=B4h

Format of Plug-and-Play Installation Structure:
Offset	Size	Description	(Table F0024)
 00h  4 BYTEs	signature "$PnP"
 04h	BYTE	Plug-and-Play version (major in high nybble, BCD minor in low)
		10h for current specification
 05h	BYTE	length of Installation Structure in bytes
 06h	WORD	control field
		bits 15-2 reserved
		bits 1-0: event notification mechanism
		     00 not supported
		     01 polling
		     10 asynchronous (interrupt time)
 08h	BYTE	checksum (8-bit sum of all bytes in structure, including this
		  one, should equal zero)
 09h	DWORD	physical address of event notification flag if using polling
		(bit 0 set when a system even occurs)
 0Dh	WORD	real mode entry offset (see #F0025)
 0Fh	WORD	real mode code segment
 11h	WORD	16-bit protected mode entry point offset (see #F0025)
 13h	DWORD	16-bit protected mode code segment base address
 17h	DWORD	OEM device identifier
 1Bh	WORD	real mode data segment
 1Dh	DWORD	16-bit protected mode data segment base address

(Table F0025)
Call Plug-and-Play BIOS entry point with:
	STACK:	WORD	function number
			0000h Get Number of System Device Nodes (see #F0026)
			0001h Get System Device Node (see #F0027)
			0002h Set System Device Node (see #F0028)
			0003h Get Event (see #F0029)
			0004h Send Message (see #F0031)
			0005h Get Docking Station Information (see #F0033)
			0006h reserved for future versions
			0007h Select Primary Boot Devices (see #F0034)
			0008h Get Primary Boot Devices (see #F0035)
			0009h Set Statically Allocated Resource Information
			      (see #F0037)
			000Ah Get Statically Allocated Resource Information
			      (see #F0038)
			000Bh Get APM ID Table (see #F0039)
			0040h Get Plug-and-Play ISA Configuration Structure
			      (see #F0041)
			0041h Get Extended System Configuration Data Info
			      (see #F0043)
			0042h Read Extended SYstem Configuration Data
			      (see #F0044)
			0043h Write Extended SYstem Configuration Data
			      (see #F0045)
			---Desktop Management Interface v2.0+---
			0050h Get DMI Information (see #F0046)
			0051h Get DMI structure (see #F0047)
			---SMBIOS v2.1+ (formerly Desktop Management I'face---
			0052h Set DMI structure (see #F0048)
			0053h Get DMI structure-change information (see #F0051)
			0054h SMBIOS control (see #F0053)
			0055h Get GP Non-Volatile Storage info (see #F0056)
			0056h Read GP Non-Volatile Storage data (see #F0057)
			0057h Write GP Non-Volatile Storage data (see #F0058)
			0058h-005Fh reserved for future use
			---BIOS Boot Specification---
			0060h Get Version and Installation Check (see #F0074)
			0061h Get IPL Device Count (see #F0075)
			0062h Get Boot Priority and IPL Table (see #F0076)
			0063h Set Boot Priority (see #F0077)
			0064h Get IPL Device from Last Boot (see #F0078)
			0065h Get Boot First (see #F0079)
			0066h Set Boot First (see #F0080)
			0067h-006Fh reserved
		var	function arguments
		WORD	PnP BIOS writable segment/selector
Return: AX = status (see #F0081)
Notes:	the caller must provide at least 1024 bytes of stack space for use by
	  the Plug-and-Play BIOS
	this API is bi-modal; all calls are available in both real mode and
	  16-bit protected mode (if calling from 32-bit protected mode, care
	  must be taken to ensure proper alignment of the stack arguments)
SeeAlso: #F0024

(Table F0026)
Call Plug-and-Play BIOS function 00h with:
	STACK:	WORD	0000h (function "Get Number of System Device Nodes")
		DWORD	-> BYTE in which to return number of device nodes
		DWORD	-> WORD in which to return size of largest device node
		WORD	PnP BIOS writable segment/selector
Return: AX = status (see #F0081)
Note:	the large-model C declaration is
	  int (*entry)(int, unsigned char *, unsigned int *, unsigned int);

(Table F0027)
Call Plug-and-Play BIOS function 01h with:
	STACK:	WORD	0001h (function "Get System Device Node")
		DWORD	-> BYTE containing node number or handle
		DWORD	-> buffer for device node
		WORD	control flag
			bits 15-2 reserved (0)
			bit 1: get static config (values for next boot)
			bit 0: get current (dynamic) configuration
		WORD	PnP BIOS writable segment/selector
Return: AX = status (see #F0081)
Notes:	the large-model C declaration is
	  int (*entry)(int, unsigned char *, DEV_NODE *, unsigned int,
		unsigned int);
	exactly one of the two defined bits in the control flag must be set

(Table F0028)
Call Plug-and-Play BIOS function 02h with:
	STACK:	WORD	0002h (function "Set System Device Node")
		DWORD	-> BYTE containing node number or handle
		DWORD	-> buffer containing device node
		WORD	control flag
			bits 15-2 reserved (0)
			bit 1: set static config (values for next boot)
			bit 0: set current (dynamic) configuration
		WORD	PnP BIOS writable segment/selector
Return: AX = status (see #F0081)
Notes:	the large-model C declaration is
	  int (*entry)(int, unsigned char *, DEV_NODE *, unsigned int,
		unsigned int);
	exactly one of the two defined bits in the control flag must be set

(Table F0029)
Call Plug-and-Play BIOS function 03h with:
	STACK:	WORD	0003h (function "Get Event")
		DWORD	-> WORD buffer for event message identifier (see #F0030)
		WORD	PnP BIOS writable segment/selector
Return: AX = status (see #F0081)
Note:	the large-model C declaration is
	  int (*entry)(int, unsigned int *, unsigned int);

(Table F0030)
Values for PnP Event Identifier:
 0001h	"ABOUT_TO_CHANGE_CONFIG" preliminary notification of changes, including
	  docking and undocking
 0002h	"DOCK_CHANGED" devices have been added to or removed from system
 0003h	"SYSTEM_DEVICE_CHANGED" removable system devices have been inserted
	  or removed
 0004h	"CONFIG_CHANGE_FAILED" error detected while atempting to add or remove
	  devices
 8000h-FFFEh OEM-defined events
 FFFFh	"UNKNOWN_SYSTEM_EVENT"

(Table F0031)
Call Plug-and-Play BIOS function 04h with:
	STACK:	WORD	0004h (function "Send Message")
		WORD	message identifier (see #F0032)
		WORD	PnP BIOS writable segment/selector
Return: AX = status (see #F0081)
Note:	the large-model C declaration is
	  int (*entry)(int, unsigned int, unsigned int);
SeeAlso: #F0031,#F0033

(Table F0032)
Values for PnP Message Identifier:
 0000h	"OK"
 0001h	"ABORT" action which caused an ABOUT_TO_X message
 0002h-003Fh reserved for future Response Messages
 0040h	"UNDOCK_DEFAULT_ACTION"
 0041h	"POWER_OFF"
 0042h	"PNP_OS_ACTIVE"
 0043h	"PNP_OS_INACTIVE"
 0044h-007Fh reserved for future Control Messages
 8000h-FFFFh OEM-defined messages

(Table F0033)
Call Plug-and-Play BIOS function 05h with:
	STACK:	WORD	0005h (function "Get Docking Station Information")
		DWORD	-> buffer for docking station info (see #F0036)
		WORD	PnP BIOS writable segment/selector
Return: AX = status (see #F0081)
Note:	the large-model C declaration is
	  int (*entry)(int, unsigned char *, unsigned int);
SeeAlso: #F0031,#F0034

(Table F0034)
Call Plug-and-Play BIOS function 07h with:
	STACK:	WORD	0007h (function "Select Primary Boot Devices")
		WORD	type of primary boot device
			0000h primary input
			0001h primary output
			0002h primary IPL
		DWORD	Plug-and-Play 32-bit device ID or FFFFFFFFh for ISA
		DWORD	device serial number or FFFFFFFFh
		DWORD	32-bit logical device ID or FFFFFFFFh for ISA device
		WORD	physical unit number
		WORD	control flag
			bits 15-1 reserved (0)
			bit 0: do not check for attached device during PnP POST
				  boot device selection
		DWORD	-> preferred resource allocation or -> END_TAG if none
		WORD	PnP BIOS writable segment/selector
Return: AX = status (see #F0081)
Note:	the large-model C declaration is
	  int (*entry)(int, int, unsigned long, unsigned long, unsigned long,
		int, int, char *, unsigned int);

(Table F0035)
Call Plug-and-Play BIOS function 08h with:
	STACK:	WORD	0008h (function "Get Primary Boot Devices")
		WORD	type of primary boot device
			0000h primary input
			0001h primary output
			0002h primary IPL
		DWORD	-> DWORD buffer for Plug-and-Play 32-bit device ID
		DWORD	-> DWORD buffer for device serial number
		DWORD	-> DWORD buffer for logical device ID
		DWORD	-> WORD buffer for physical unit number
		DWORD	-> buffer for preferred resource allocation
		WORD	PnP BIOS writable segment/selector
Return: AX = status (see #F0081)
Note:	the large-model C declaration is
	  int (*entry)(int, int, unsigned long *, unsigned long *,
		unsigned long *, unsigned int *, char *, unsigned int);

Format of Plug-and-Play Docking Station Information:
Offset	Size	Description	(Table F0036)
 00h	DWORD	docking station location identifier (EISA device ID format)
		FFFFFFFFh if unknown or no product identifier
 04h	DWORD	serial number or 00000000h
 08h	WORD	capabilities
		bits 15-3 reserved (0)
		bits 2-1: hot-pluggability
		    00 power-down required to dock/undock
		    01 must be in suspend mode ("warm" dock/undock)
		    10 system can be hot-docked
		    11 reserved
		bit 0: docking station provides support for controlling
		      sequence of docking/undocking

(Table F0037)
Call Plug-and-Play BIOS function 09h with:
	STACK:	WORD	0009h (function "Set Statically Allocated Resource
			  Information")
		DWORD	-> block of statically-allocated resources as described
			  in the Plug-and-Play ISA Spec
		WORD	PnP BIOS writable segment/selector
Return: AX = status (see #F0081)
Notes:	the large-model C declaration is
	  int (*entry)(int, unsigned char *, unsigned int);
	if the returned status is 008Dh, the Plug-and-Play BIOS supports
	  ESCD, and the caller should thus use functions 41h to 43h instead
	  of 09h and 0Ah

(Table F0038)
Call Plug-and-Play BIOS function 0Ah with:
	STACK:	WORD	000Ah (function "Get Statically Allocated Resource
			  Information")
		DWORD	-> buffer for statically-allocated resources as
			  described in the Plug-and-Play ISA Spec
		WORD	PnP BIOS writable segment/selector
Return: AX = status (see #F0081)
Notes:	the large-model C declaration is
	  int (*entry)(int, unsigned char *, unsigned int);
	if the returned status is 008Dh, the Plug-and-Play BIOS supports
	  ESCD, and the caller should thus use functions 41h to 43h instead
	  of 09h and 0Ah

(Table F0039)
Call Plug-and-Play BIOS function 0Bh with:
	STACK:	WORD	000Bh (function "Get APM ID Table")
			  Information")
		DWORD	-> WORD buffer for size of data buffer
		DWORD	-> buffer for storing APM ID table (see #F0040)
		WORD	PnP BIOS writable segment/selector
Return: AX = status (see #F0081)
Desc:	copies the Advanced Power Management v1.1 device identifier table to
	  Plug-and-Play device identifier mappings
Note:	the large-model C declaration is
	  int (*entry)(int, unsigned int *, unsigned char *, unsigned int);
SeeAlso: INT 15/AX=5300h

Format of Plug-and-Play APM ID Table:
Offset	Size	Description	(Table F0040)
 00h	DWORD	Plug-and-Play device identifier
 04h	WORD	APM v1.1+ identifier
SeeAlso: #F0039

(Table F0041)
Call Plug-and-Play BIOS function 40h with:
	STACK:	WORD	0040h (function "Get Plug-and-Play ISA Configuration
			  Structure")
		DWORD	-> buffer for configuration structure (see #F0042)
		WORD	PnP BIOS writable segment/selector
Return: AX = status (see #F0081)
Note:	the large-model C declaration is
	  int (*entry)(int, unsigned char *, unsigned int);

Format of Plug-and-Play ISA Configuration Structure:
Offset	Size	Description	(Table F0042)
 00h	BYTE	structure revision level (01h)
 01h	BYTE	total Card Select Numbers (CSNs) assigned
 02h	WORD	ISA Read Data Port (see also PORT 0A79h)
 04h	WORD	reserved (0)
SeeAlso: #F0041

(Table F0043)
Call Plug-and-Play BIOS function 41h with:
	STACK:	WORD	0041h (function "Get Extended System Configuration
			  Information")
		DWORD	-> WORD buffer for size of nonvolatile storage
		DWORD	-> WORD buffer for size of ESCD allocated
		DWORD	-> DWORD buffer for physical base address of NV storage
			  (if memory-mapped, else 00000000h)
		WORD	PnP BIOS writable segment/selector
Return: AX = status (see #F0081)
Note:	the large-model C declaration is
	  int (*entry)(int, unsigned int *, unsigned int *, unsigned long *,
		  unsigned int);
SeeAlso: INT 1A/AX=B401h

(Table F0044)
Call Plug-and-Play BIOS function 42h with: