OvmfPkg/Csm/LegacyBiosDxe: Fix Legacy16GetTableAddress call for E820 data

[mirror_edk2.git] / OvmfPkg / SioBusDxe / SioService.h

/** @file\r
  The SioBusDxe driver is used to create child devices on the ISA bus and\r
  installs the Super I/O protocols on them.\r
\r
  Copyright (c) 2019, Intel Corporation. All rights reserved.<BR>\r
\r
  SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
#ifndef __SIO_SERVICE_H__\r
#define __SIO_SERVICE_H__\r
\r
#pragma pack(1)\r
\r
typedef struct {\r
  EFI_ACPI_FIXED_LOCATION_IO_PORT_DESCRIPTOR  Io;\r
  EFI_ACPI_END_TAG_DESCRIPTOR                 End;\r
} SIO_RESOURCES_IO;\r
\r
#pragma pack()\r
\r
typedef struct {\r
  UINT32                      Hid;\r
  UINT32                      Uid;\r
  ACPI_RESOURCE_HEADER_PTR    Resources;\r
} SIO_DEVICE_INFO;\r
\r
//\r
// SIO device private data structure\r
//\r
typedef struct {\r
  UINT32                      Signature;\r
  EFI_HANDLE                  Handle;\r
  EFI_PCI_IO_PROTOCOL         *PciIo;\r
  EFI_DEVICE_PATH_PROTOCOL    *DevicePath;\r
\r
  EFI_SIO_PROTOCOL            Sio;\r
  UINT32                      DeviceIndex;\r
} SIO_DEV;\r
#define SIO_DEV_SIGNATURE      SIGNATURE_32 ('S', 'I', 'O', 'D')\r
#define SIO_DEV_FROM_SIO(a)    CR (a, SIO_DEV, Sio, SIO_DEV_SIGNATURE)\r
\r
\r
//\r
// Super I/O Protocol interfaces\r
//\r
\r
/**\r
  Provides a low level access to the registers for the Super I/O.\r
\r
  @param[in]     This           Indicates a pointer to the calling context.\r
  @param[in]     Write          Specifies the type of the register operation.\r
                                If this parameter is TRUE, Value is interpreted\r
                                as an input parameter and the operation is a\r
                                register write. If this parameter is FALSE,\r
                                Value is interpreted as an output parameter and\r
                                the operation is a register read.\r
  @param[in]     ExitCfgMode    Exit Configuration Mode Indicator. If this\r
                                parameter is set to TRUE, the Super I/O driver\r
                                will turn off configuration mode of the Super\r
                                I/O prior to returning from this function. If\r
                                this parameter is set to FALSE, the Super I/O\r
                                driver will leave Super I/O in the\r
                                configuration mode. The Super I/O driver must\r
                                track the current state of the Super I/O and\r
                                enable the configuration mode of Super I/O if\r
                                necessary prior to register access.\r
  @param[in]     Register       Register number.\r
  @param[in,out] Value          If Write is TRUE, Value is a pointer to the\r
                                buffer containing the byte of data to be\r
                                written to the Super I/O register. If Write is\r
                                FALSE, Value is a pointer to the destination\r
                                buffer for the byte of data to be read from the\r
                                Super I/O register.\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER The Value is NULL.\r
  @retval EFI_INVALID_PARAMETER Invalid Register number.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SioRegisterAccess (\r
  IN CONST EFI_SIO_PROTOCOL    *This,\r
  IN       BOOLEAN             Write,\r
  IN       BOOLEAN             ExitCfgMode,\r
  IN       UINT8               Register,\r
  IN OUT   UINT8               *Value\r
  );\r
\r
/**\r
  Provides an interface to get a list of the current resources consumed by the\r
  device in the ACPI Resource Descriptor format.\r
\r
  GetResources() returns a list of resources currently consumed by the device.\r
  The ResourceList is a pointer to the buffer containing resource descriptors\r
  for the device. The descriptors are in the format of Small or Large ACPI\r
  resource descriptor as defined by ACPI specification (2.0 & 3.0). The buffer\r
  of resource descriptors is terminated with the 'End tag' resource descriptor.\r
\r
  @param[in]  This              Indicates a pointer to the calling context.\r
  @param[out] ResourceList      A pointer to an ACPI resource descriptor list\r
                                that defines the current resources used by the\r
                                device.\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER ResourceList is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SioGetResources (\r
  IN CONST EFI_SIO_PROTOCOL            *This,\r
  OUT      ACPI_RESOURCE_HEADER_PTR    *ResourceList\r
  );\r
\r
/**\r
  Sets the resources for the device.\r
\r
  @param[in] This               Indicates a pointer to the calling context.\r
  @param[in] ResourceList       Pointer to the ACPI resource descriptor list.\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER ResourceList is invalid.\r
  @retval EFI_ACCESS_DENIED     Some of the resources in ResourceList are in\r
                                use.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SioSetResources (\r
  IN CONST EFI_SIO_PROTOCOL            *This,\r
  IN       ACPI_RESOURCE_HEADER_PTR    ResourceList\r
  );\r
\r
/**\r
  Provides a collection of resource descriptor lists. Each resource descriptor\r
  list in the collection defines a combination of resources that can\r
  potentially be used by the device.\r
\r
  @param[in]  This                  Indicates a pointer to the calling context.\r
  @param[out] ResourceCollection    Collection of the resource descriptor\r
                                    lists.\r
\r
  @retval EFI_SUCCESS               The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER     ResourceCollection is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SioPossibleResources (\r
  IN CONST EFI_SIO_PROTOCOL            *This,\r
  OUT      ACPI_RESOURCE_HEADER_PTR    *ResourceCollection\r
  );\r
\r
/**\r
  Provides an interface for a table based programming of the Super I/O\r
  registers.\r
\r
  The Modify() function provides an interface for table based programming of\r
  the Super I/O registers. This function can be used to perform programming of\r
  multiple Super I/O registers with a single function call. For each table\r
  entry, the Register is read, its content is bitwise ANDed with AndMask, and\r
  then ORed with OrMask before being written back to the Register. The Super\r
  I/O driver must track the current state of the Super I/O and enable the\r
  configuration mode of Super I/O if necessary prior to table processing. Once\r
  the table is processed, the Super I/O device has to be returned to the\r
  original state.\r
\r
  @param[in] This               Indicates a pointer to the calling context.\r
  @param[in] Command            A pointer to an array of NumberOfCommands\r
                                EFI_SIO_REGISTER_MODIFY structures. Each\r
                                structure specifies a single Super I/O register\r
                                modify operation.\r
  @param[in] NumberOfCommands   Number of elements in the Command array.\r
\r
  @retval EFI_SUCCESS           The operation completed successfully.\r
  @retval EFI_INVALID_PARAMETER Command is NULL.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
SioModify (\r
  IN CONST EFI_SIO_PROTOCOL           *This,\r
  IN CONST EFI_SIO_REGISTER_MODIFY    *Command,\r
  IN       UINTN                      NumberOfCommands\r
  );\r
\r
//\r
// Internal functions\r
//\r
\r
/**\r
  Create all the ISA child devices on the ISA bus controller (PCI to ISA\r
  bridge).\r
\r
  @param[in] This              The EFI_DRIVER_BINDING_PROTOCOL instance.\r
  @param[in] Controller        The handle of ISA bus controller.\r
  @param[in] PciIo             The pointer to the PCI protocol.\r
  @param[in] ParentDevicePath  Device path of the ISA bus controller.\r
\r
  @retval The number of child device that is successfully created.\r
\r
**/\r
UINT32\r
SioCreateAllChildDevices (\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
  );\r
\r
#endif  // __SIO_SERVICE_H__\r