/** @file
|
Super I/O Interface implementation.
|
|
Copyright (c) 2010 - 2019 Intel Corporation. All rights reserved. <BR>
|
|
SPDX-License-Identifier: BSD-2-Clause-Patent
|
**/
|
|
#include "SioDriver.h"
|
|
|
/**
|
Provides an interface to get a list of the current resources consumed by the device in the ACPI
|
Resource Descriptor format.
|
|
GetResources() returns a list of resources currently consumed by the device. The
|
ResourceList is a pointer to the buffer containing resource descriptors for the device. The
|
descriptors are in the format of Small or Large ACPI resource descriptor as defined by ACPI
|
specification (2.0 & 3.0). The buffer of resource descriptors is terminated with the 'End tag'
|
resource descriptor.
|
|
@param[in] This Indicates a pointer to the calling context.
|
@param[out] ResourceList A pointer to an ACPI resource descriptor list that defines the current resources
|
used by the device. Type ACPI_RESOURCE_HEADER_PTR is defined in the "Related
|
Definitions" below.
|
|
@retval EFI_SUCCESS The operation completed successfully
|
@retval EFI_INVALID_PARAMETER ResourceList is NULL
|
**/
|
EFI_STATUS
|
EFIAPI
|
SioGetResources (
|
IN CONST EFI_SIO_PROTOCOL *This,
|
OUT ACPI_RESOURCE_HEADER_PTR *ResourceList
|
)
|
{
|
SIO_DEV *SioDev;
|
|
if (ResourceList == NULL) {
|
return EFI_INVALID_PARAMETER;
|
}
|
|
SioDev = SIO_DEV_FROM_THIS (This);
|
|
return DeviceGetResources (&SioDev->Device, ResourceList);
|
}
|
|
|
/**
|
Provides a collection of resource descriptor lists. Each resource descriptor list in the collection
|
defines a combination of resources that can potentially be used by the device.
|
|
@param[in] This Indicates a pointer to the calling context.
|
@param[out] ResourceCollection Collection of the resource descriptor lists.
|
|
@retval EFI_SUCCESS The operation completed successfully
|
@retval EFI_INVALID_PARAMETER ResourceCollection is NULL
|
**/
|
EFI_STATUS
|
EFIAPI
|
SioPossibleResources (
|
IN CONST EFI_SIO_PROTOCOL *This,
|
OUT ACPI_RESOURCE_HEADER_PTR *ResourceCollection
|
)
|
{
|
SIO_DEV *SioDev;
|
|
if (ResourceCollection == NULL) {
|
return EFI_INVALID_PARAMETER;
|
}
|
|
SioDev = SIO_DEV_FROM_THIS (This);
|
|
return DevicePossibleResources (&SioDev->Device, ResourceCollection);
|
}
|
|
|
/**
|
Sets the resources for the device.
|
|
@param[in] This Indicates a pointer to the calling context.
|
@param[in] ResourceList Pointer to the ACPI resource descriptor list. Type ACPI_RESOURCE_HEADER_PTR
|
is defined in the "Related Definitions" section of
|
EFI_SIO_PROTOCOL.GetResources().
|
|
@retval EFI_SUCCESS The operation completed successfully
|
@retval EFI_INVALID_PARAMETER ResourceList is invalid
|
@retval EFI_ACCESS_DENIED Some of the resources in ResourceList are in use
|
**/
|
EFI_STATUS
|
EFIAPI
|
SioSetResources (
|
IN CONST EFI_SIO_PROTOCOL *This,
|
IN ACPI_RESOURCE_HEADER_PTR ResourceList
|
)
|
{
|
SIO_DEV *SioDev;
|
ACPI_RESOURCE_HEADER_PTR ResourcePtr;
|
ACPI_RESOURCE_HEADER_PTR ResourceCollection;
|
ACPI_RESOURCE_HEADER_PTR ResourcePtr2;
|
BOOLEAN Found;
|
|
ResourcePtr = ResourceList;
|
SioDev = SIO_DEV_FROM_THIS (This);
|
|
//
|
// Check whether the resource is in the possible resource collection
|
//
|
DevicePossibleResources (&SioDev->Device, &ResourceCollection);
|
|
while (ResourcePtr.SmallHeader->Byte != ACPI_END_TAG_DESCRIPTOR) {
|
|
Found = FALSE;
|
ResourcePtr2 = ResourceCollection;
|
while (ResourcePtr2.SmallHeader->Byte != ACPI_END_TAG_DESCRIPTOR) {
|
if (ResourcePtr2.SmallHeader->Bits.Type == 0) {
|
//
|
// Small Header
|
//
|
if (CompareMem (
|
ResourcePtr2.SmallHeader,
|
ResourcePtr.SmallHeader,
|
ResourcePtr2.SmallHeader->Bits.Length + sizeof (*ResourcePtr2.SmallHeader)
|
) == 0) {
|
Found = TRUE;
|
break;
|
}
|
|
ResourcePtr2.SmallHeader = (ACPI_SMALL_RESOURCE_HEADER *) ((UINT8 *) ResourcePtr2.SmallHeader
|
+ ResourcePtr2.SmallHeader->Bits.Length
|
+ sizeof (*ResourcePtr2.SmallHeader));
|
|
} else {
|
//
|
// Large Header
|
//
|
if (CompareMem (
|
ResourcePtr2.LargeHeader,
|
ResourcePtr.LargeHeader,
|
ResourcePtr2.LargeHeader->Length + sizeof (*ResourcePtr2.LargeHeader)
|
) == 0) {
|
Found = TRUE;
|
break;
|
}
|
|
ResourcePtr2.LargeHeader = (ACPI_LARGE_RESOURCE_HEADER *) ((UINT8 *) ResourcePtr2.LargeHeader
|
+ ResourcePtr2.LargeHeader->Length
|
+ sizeof (*ResourcePtr2.LargeHeader));
|
}
|
}
|
|
if (!Found) {
|
return EFI_ACCESS_DENIED;
|
}
|
|
if (ResourcePtr.SmallHeader->Bits.Type == 0) {
|
ResourcePtr.SmallHeader = (ACPI_SMALL_RESOURCE_HEADER *) ((UINT8 *) ResourcePtr.SmallHeader
|
+ ResourcePtr.SmallHeader->Bits.Length
|
+ sizeof (*ResourcePtr.SmallHeader));
|
} else {
|
ResourcePtr.LargeHeader = (ACPI_LARGE_RESOURCE_HEADER *) ((UINT8 *) ResourcePtr.LargeHeader
|
+ ResourcePtr.LargeHeader->Length
|
+ sizeof (*ResourcePtr.LargeHeader));
|
}
|
}
|
|
//
|
// ResourceList can be set
|
//
|
return DeviceSetResources (&SioDev->Device, ResourceList);
|
}
|
|
|
/**
|
Provides a low level access to the registers for the Super I/O.
|
|
@param[in] This Indicates a pointer to the calling context.
|
@param[in] Write Specifies the type of the register operation. If this parameter is TRUE,
|
Value is interpreted as an input parameter and the operation is a register write.
|
If this parameter is FALSE, Value is interpreted as an output parameter and the
|
operation is a register read.
|
@param[in] ExitCfgMode Exit Configuration Mode Indicator. If this parameter is set to TRUE, the
|
Super I/O driver will turn off configuration mode of the Super I/O prior to returning
|
from this function. If this parameter is set to FALSE, the Super I/O driver will
|
leave Super I/O in the configuration mode.
|
The Super I/O driver must track the current state of the Super I/O and enable the
|
configuration mode of Super I/O if necessary prior to register access.
|
@param[in] Register Register number.
|
@param[in, out] Value If Write is TRUE, Value is a pointer to the buffer containing the byte of data to be
|
written to the Super I/O register. If Write is FALSE, Value is a pointer to the
|
destination buffer for the byte of data to be read from the Super I/O register.
|
|
@retval EFI_SUCCESS The operation completed successfully
|
@retval EFI_INVALID_PARAMETER The Value is NULL
|
@retval EFI_INVALID_PARAMETER Invalid Register number
|
**/
|
EFI_STATUS
|
EFIAPI
|
SioRegisterAccess (
|
IN CONST EFI_SIO_PROTOCOL *This,
|
IN BOOLEAN Write,
|
IN BOOLEAN ExitCfgMode,
|
IN UINT8 Register,
|
IN OUT UINT8 *Value
|
)
|
{
|
if (Value == NULL) {
|
return EFI_INVALID_PARAMETER;
|
}
|
|
return EFI_SUCCESS;
|
}
|
|
|
/**
|
Provides an interface for a table based programming of the Super I/O registers.
|
|
The Modify() function provides an interface for table based programming of the Super I/O
|
registers. This function can be used to perform programming of multiple Super I/O registers with a
|
single function call. For each table entry, the Register is read, its content is bitwise ANDed with
|
AndMask, and then ORed with OrMask before being written back to the Register. The Super
|
I/O driver must track the current state of the Super I/O and enable the configuration mode of Super I/
|
O if necessary prior to table processing. Once the table is processed, the Super I/O device has to be
|
returned to the original state.
|
|
@param[in] This Indicates a pointer to the calling context.
|
@param[in] Command A pointer to an array of NumberOfCommands EFI_SIO_REGISTER_MODIFY
|
structures. Each structure specifies a single Super I/O register modify operation.
|
Type EFI_SIO_REGISTER_MODIFY is defined in the "Related Definitions" below.
|
@param[in] NumberOfCommands Number of elements in the Command array.
|
|
@retval EFI_SUCCESS The operation completed successfully
|
@retval EFI_INVALID_PARAMETER Command is NULL
|
**/
|
EFI_STATUS
|
EFIAPI
|
SioModify (
|
IN CONST EFI_SIO_PROTOCOL *This,
|
IN CONST EFI_SIO_REGISTER_MODIFY *Command,
|
IN UINTN NumberOfCommands
|
)
|
{
|
|
if (Command == NULL) {
|
return EFI_INVALID_PARAMETER;
|
}
|
|
return EFI_SUCCESS;
|
}
|
