MdePkg/Include/Protocol/IsaHc.h File Reference


Data Structures

struct  _EFI_ISA_HC_PROTOCOL

Defines

#define EFI_ISA_HC_PROTOCOL_GUID
#define EFI_ISA_HC_SERVICE_BINDING_PROTOCOL_GUID

Typedefs

typedef struct _EFI_ISA_HC_PROTOCOL EFI_ISA_HC_PROTOCOL
typedef struct
_EFI_ISA_HC_PROTOCOL
PEFI_ISA_HC_PROTOCOL
typedef IN UINT16 IoAddress
typedef IN UINT16 IN UINT16 IoLength
typedef IN UINT16 IN UINT16
OUT UINT64
IoApertureHandle

Functions

typedef EFI_STATUS (EFIAPI *EFI_ISA_HC_OPEN_IO)(IN CONST EFI_ISA_HC_PROTOCOL *This

Variables

EFI_GUID gEfiIsaHcProtocolGuid
EFI_GUID gEfiIsaHcServiceBindingProtocolGuid

Detailed Description

ISA HC Protocol as defined in the PI 1.2.1 specification.

This protocol provides registration for ISA devices on a positive- or subtractive-decode ISA bus. It allows devices to be registered and also handles opening and closing the apertures which are positively-decoded.

Copyright (c) 2015, Intel Corporation. All rights reserved.
This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

Revision Reference:
This protocol is from PI Version 1.2.1.

Define Documentation

#define EFI_ISA_HC_PROTOCOL_GUID

Value:

{ \
    0xbcdaf080, 0x1bde, 0x4e22, {0xae, 0x6a, 0x43, 0x54, 0x1e, 0x12, 0x8e, 0xc4} \
  }

#define EFI_ISA_HC_SERVICE_BINDING_PROTOCOL_GUID

Value:

{ \
    0xfad7933a, 0x6c21, 0x4234, {0xa4, 0x34, 0x0a, 0x8a, 0x0d, 0x2b, 0x07, 0x81} \
  }


Typedef Documentation

typedef IN UINT16 IoAddress

typedef IN UINT16 IN UINT16 IoLength


Function Documentation

typedef EFI_STATUS ( EFIAPI EFI_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 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_PROTOCOL.
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_PROTOCOL.
IoApertureHandle The I/O aperture handle previously returned from a call to OpenIoAperture().
Return values:
EFI_SUCCESS The IO aperture was closed successfully.


Variable Documentation

Reference to variable defined in the .DEC file


Generated on Thu Sep 24 23:14:19 2015 for MdePkg[ALL] by  doxygen 1.5.7.1