Remove the EDK prefix from library instance folder's name

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Isa / IsaBusDxe / InternalIsaBus.h

/*++\r
\r
  Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
  All rights reserved. This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
Module Name:\r
\r
  IsaBus.h\r
  \r
Abstract:\r
  \r
  The header file for ISA bus driver\r
  \r
Revision History:\r
\r
--*/\r
\r
#ifndef _EFI_ISA_BUS_H\r
#define _EFI_ISA_BUS_H\r
\r
//\r
// Include common header file for this module.\r
//\r
#include "CommonHeader.h"\r
\r
#include "ComponentName.h"\r
\r
extern EFI_ISA_IO_PROTOCOL    IsaIoInterface;\r
\r
typedef enum {\r
  IsaAccessTypeUnknown,\r
  IsaAccessTypeIo,\r
  IsaAccessTypeMem,\r
  IsaAccessTypeMaxType\r
} ISA_ACCESS_TYPE;\r
\r
//\r
// 16 MB Memory Range\r
//\r
#define ISA_MAX_MEMORY_ADDRESS  0x1000000\r
//\r
// 64K I/O Range\r
//\r
#define ISA_MAX_IO_ADDRESS  0x10000\r
\r
typedef struct {\r
  UINT8 Address;\r
  UINT8 Page;\r
  UINT8 Count;\r
} EFI_ISA_DMA_REGISTERS;\r
\r
//\r
// ISA I/O Device Structure\r
//\r
#define ISA_IO_DEVICE_SIGNATURE EFI_SIGNATURE_32 ('i', 's', 'a', 'i')\r
\r
typedef struct {\r
  UINT32                                    Signature;\r
  EFI_HANDLE                                Handle;\r
  EFI_ISA_IO_PROTOCOL                       IsaIo;\r
  EFI_DEVICE_PATH_PROTOCOL                  *DevicePath;\r
  EFI_PCI_IO_PROTOCOL                       *PciIo;\r
} ISA_IO_DEVICE;\r
\r
#define ISA_IO_DEVICE_FROM_ISA_IO_THIS(a) CR (a, ISA_IO_DEVICE, IsaIo, ISA_IO_DEVICE_SIGNATURE)\r
\r
//\r
// Global Variables\r
//\r
extern EFI_DRIVER_BINDING_PROTOCOL  gIsaBusControllerDriver;\r
\r
//\r
// Mapping structure for performing ISA DMA to a buffer above 16 MB\r
//\r
typedef struct {\r
  EFI_ISA_IO_PROTOCOL_OPERATION Operation;\r
  UINTN                         NumberOfBytes;\r
  UINTN                         NumberOfPages;\r
  EFI_PHYSICAL_ADDRESS          HostAddress;\r
  EFI_PHYSICAL_ADDRESS          MappedHostAddress;\r
} ISA_MAP_INFO;\r
\r
//\r
// EFI Driver Binding Protocol Interface Functions\r
//\r
\r
EFI_STATUS\r
EFIAPI\r
IsaBusControllerDriverSupported (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  * This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL\r
  )\r
/*++\r
\r
  Routine Description:\r
  \r
    This function checks to see if a controller can be managed by the ISA Bus \r
    Driver. This is done by checking to see if the controller supports the \r
    EFI_PCI_IO_PROTOCOL protocol, and then looking at the PCI Configuration \r
    Header to see if the device is a PCI to ISA bridge. The class code of \r
    PCI to ISA bridge: Base class 06h, Sub class 01h Interface 00h \r
  \r
  Arguments:\r
  \r
    This                 - The EFI_DRIVER_BINDING_PROTOCOL instance.\r
    Controller           - The handle of the device to check.\r
    RemainingDevicePath  - A pointer to the remaining portion of a device path.\r
\r
  Returns:\r
  \r
    EFI_SUCCESS          - The device is supported by this driver.\r
    EFI_UNSUPPORTED      - The device is not supported by this driver.\r
\r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
IsaBusControllerDriverStart (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  * This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_DEVICE_PATH_PROTOCOL     * RemainingDevicePath OPTIONAL\r
  )\r
/*++\r
\r
  Routine Description:\r
  \r
    This function tells the ISA Bus Driver to start managing a PCI to ISA \r
    Bridge controller. \r
  \r
  Arguments:\r
  \r
    This                  - The EFI_DRIVER_BINDING_PROTOCOL instance.\r
    Controller            - A handle to the device being started. \r
    RemainingDevicePath   - A pointer to the remaining portion of a device path.\r
\r
  Returns:\r
  \r
    EFI_SUCCESS           - The device was started.\r
    EFI_UNSUPPORTED       - The device is not supported.\r
    EFI_DEVICE_ERROR      - The device could not be started due to a device error.\r
    EFI_ALREADY_STARTED   - The device has already been started.\r
    EFI_INVALID_PARAMETER - One of the parameters has an invalid value.\r
    EFI_OUT_OF_RESOURCES  - The request could not be completed due to a lack of \r
                            resources.\r
  \r
--*/\r
;\r
\r
EFI_STATUS\r
EFIAPI\r
IsaBusControllerDriverStop (\r
  IN  EFI_DRIVER_BINDING_PROTOCOL  * This,\r
  IN  EFI_HANDLE                   Controller,\r
  IN  UINTN                        NumberOfChildren,\r
  IN  EFI_HANDLE                   * ChildHandleBuffer OPTIONAL\r
  )\r
/*++\r
\r
  Routine Description:\r
  \r
    This function tells the ISA Bus Driver to stop managing a PCI to ISA \r
    Bridge controller. \r
     \r
  Arguments:\r
  \r
    This                   - The EFI_DRIVER_BINDING_PROTOCOL instance.\r
    Controller             - A handle to the device being stopped.\r
    NumberOfChindren       - The number of child device handles in ChildHandleBuffer.\r
    ChildHandleBuffer      - An array of child handles to be freed.\r
\r
  \r
  Returns:\r
  \r
    EFI_SUCCESS            - The device was stopped.\r
    EFI_DEVICE_ERROR       - The device could not be stopped due to a device error.\r
    EFI_NOT_STARTED        - The device has not been started.\r
    EFI_INVALID_PARAMETER  - One of the parameters has an invalid value.\r
    EFI_OUT_OF_RESOURCES   - The request could not be completed due to a lack of \r
                             resources.\r
\r
--*/\r
;\r
\r
//\r
// Function Prototypes\r
//\r
\r
EFI_STATUS\r
IsaCreateDevice (\r
  IN EFI_DRIVER_BINDING_PROTOCOL  *This,\r
  IN EFI_HANDLE                   Controller,\r
  IN EFI_PCI_IO_PROTOCOL          *PciIo,\r
  IN EFI_DEVICE_PATH_PROTOCOL     *ParentDevicePath,\r
  IN EFI_ISA_ACPI_RESOURCE_LIST   *IsaDeviceResourceList,\r
  OUT EFI_DEVICE_PATH_PROTOCOL    **ChildDevicePath\r
  )\r
/*++\r
\r
  Routine Description:\r
  \r
    Create ISA device found by IsaPnpProtocol \r
\r
  Arguments:\r
  \r
    This                   - The EFI_DRIVER_BINDING_PROTOCOL instance.\r
    Controller             - The handle of ISA bus controller(PCI to ISA bridge)\r
    PciIo                  - The Pointer to the PCI protocol \r
    ParentDevicePath       - Device path of the ISA bus controller\r
    IsaDeviceResourceList  - The resource list of the ISA device\r
    ChildDevicePath        - The pointer to the child device.\r
\r
  Returns:\r
  \r
    EFI_SUCCESS            - Create the child device.\r
    EFI_OUT_OF_RESOURCES   - The request could not be completed due to a lack of \r
                             resources.\r
    EFI_DEVICE_ERROR       - Can not create child device.\r
    \r
--*/\r
;\r
\r
EFI_STATUS\r
InitializeIsaIoInstance (\r
  IN ISA_IO_DEVICE               *IsaIoDevice,\r
  IN EFI_ISA_ACPI_RESOURCE_LIST  *IsaDevice\r
  )\r
/*++\r
\r
Routine Description:\r
\r
  Initializes an ISA I/O Instance\r
\r
Arguments:\r
\r
  IsaIoDevice            - The iso device to be initialized.\r
  IsaDevice              - The resource list.\r
  \r
Returns:\r
\r
  EFI_SUCCESS            - Initial success.\r
  \r
--*/\r
;\r
\r
#endif\r