IsaHc.h File Reference

Data Structures
struct	_EFI_ISA_HC_PPI

Macros
#define	EFI_ISA_HC_PPI_GUID

Typedefs
typedef struct _EFI_ISA_HC_PPI	EFI_ISA_HC_PPI
typedef struct _EFI_ISA_HC_PPI *	PEFI_ISA_HC_PPI
typedef IN UINT16	IoAddress
typedef IN UINT16 IN UINT16	IoLength
typedef IN UINT16 IN UINT16 OUT UINT64 *	IoApertureHandle

Functions
typedef	EFI_STATUS (EFIAPI *EFI_PEI_ISA_HC_OPEN_IO)(IN CONST EFI_ISA_HC_PPI *This

Variables
EFI_GUID	gEfiIsaHcPpiGuid

Detailed Description

This PPI opens or closes an I/O aperture in a ISA HOST controller.

Copyright (c) 2015 - 2018, Intel Corporation. All rights reserved.
SPDX-License-Identifier: BSD-2-Clause-Patent

Revision Reference:

This PPI is from PI Version 1.2.1.

Macro Definition Documentation

#define EFI_ISA_HC_PPI_GUID

Value:

{ \
    0x8d48bd70, 0xc8a3, 0x4c06, {0x90, 0x1b, 0x74, 0x79, 0x46, 0xaa, 0xc3, 0x58} \
  }

Typedef Documentation

typedef struct _EFI_ISA_HC_PPI EFI_ISA_HC_PPI

typedef IN UINT16 IoAddress

typedef IN UINT64 IoApertureHandle

typedef IN UINT16 IN UINT16 IoLength

typedef struct _EFI_ISA_HC_PPI* PEFI_ISA_HC_PPI

Function Documentation

typedef EFI_STATUS

(

EFIAPI *

EFI_PEI_ISA_HC_CLOSE_IO

)

Open I/O aperture.

This function opens an I/O aperture in a ISA Host Controller for the I/O addresses specified by IoAddress to IoAddress + IoLength - 1. It is possible that more than one caller may be assigned to the same aperture. It may be possible that a single hardware aperture may be used for more than one device. This function tracks the number of times that each aperture is referenced, and does not close the hardware aperture (via CloseIoAperture()) until there are no more references to it.

Parameters

This	A pointer to this instance of the EFI_ISA_HC_PPI.
IoAddress	An unsigned integer that specifies the first byte of the I/O space required.
IoLength	An unsigned integer that specifies the number of bytes of the I/O space required.
IoApertureHandle	A pointer to the returned I/O aperture handle. This value can be used on subsequent calls to CloseIoAperture().

Return values

EFI_SUCCESS	The I/O aperture was opened successfully.
EFI_UNSUPPORTED	The ISA Host Controller is a subtractive-decode controller.
EFI_OUT_OF_RESOURCES	There is no available I/O aperture.

Close I/O aperture.

This function closes a previously opened I/O aperture handle. If there are no more I/O aperture handles that refer to the hardware I/O aperture resource, then the hardware I/O aperture is closed. It may be possible that a single hardware aperture may be used for more than one device. This function tracks the number of times that each aperture is referenced, and does not close the hardware aperture (via CloseIoAperture()) until there are no more references to it.

Parameters

This	A pointer to this instance of the EFI_ISA_HC_PPI.
IoApertureHandle	The I/O aperture handle previously returned from a call to OpenIoAperture().

Return values

EFI_SUCCESS

The I/O aperture was closed successfully.

Variable Documentation

EFI_GUID gEfiIsaHcPpiGuid