#include "SioBusDxe.h"

Functions
EFI_STATUS EFIAPI	SioRegisterAccess (IN CONST EFI_SIO_PROTOCOL This, IN BOOLEAN Write, IN BOOLEAN ExitCfgMode, IN UINT8 Register, IN OUT UINT8 Value)

EFI_STATUS EFIAPI	SioGetResources (IN CONST EFI_SIO_PROTOCOL This, OUT ACPI_RESOURCE_HEADER_PTR ResourceList)

EFI_STATUS EFIAPI	SioSetResources (IN CONST EFI_SIO_PROTOCOL *This, IN ACPI_RESOURCE_HEADER_PTR ResourceList)

EFI_STATUS EFIAPI	SioPossibleResources (IN CONST EFI_SIO_PROTOCOL This, OUT ACPI_RESOURCE_HEADER_PTR ResourceCollection)

EFI_STATUS EFIAPI	SioModify (IN CONST EFI_SIO_PROTOCOL This, IN CONST EFI_SIO_REGISTER_MODIFY Command, IN UINTN NumberOfCommands)

EFI_STATUS	SioCreateChildDevice (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN EFI_PCI_IO_PROTOCOL PciIo, IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath, IN UINT32 DeviceIndex)

UINT32	SioCreateAllChildDevices (IN EFI_DRIVER_BINDING_PROTOCOL This, IN EFI_HANDLE Controller, IN EFI_PCI_IO_PROTOCOL PciIo, IN EFI_DEVICE_PATH_PROTOCOL *ParentDevicePath)

Variables
EFI_SIO_PROTOCOL	mSioInterface

GLOBAL_REMOVE_IF_UNREFERENCED SIO_RESOURCES_IO	mCom1Resources

GLOBAL_REMOVE_IF_UNREFERENCED SIO_RESOURCES_IO	mCom2Resources

GLOBAL_REMOVE_IF_UNREFERENCED SIO_RESOURCES_IO	mPs2KeyboardDeviceResources

GLOBAL_REMOVE_IF_UNREFERENCED SIO_DEVICE_INFO	mDevicesInfo []

GLOBAL_REMOVE_IF_UNREFERENCED ACPI_HID_DEVICE_PATH	mAcpiDeviceNodeTemplate

Detailed Description

The SioBusDxe driver is used to create child devices on the ISA bus and installs the Super I/O protocols on them.

SPDX-License-Identifier: BSD-2-Clause-Patent

Definition in file SioService.c.

Function Documentation

◆ SioCreateAllChildDevices()

UINT32 SioCreateAllChildDevices	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_PCI_IO_PROTOCOL *	PciIo,
		IN EFI_DEVICE_PATH_PROTOCOL *	ParentDevicePath
	)

Create all the ISA child devices on the ISA bus controller (PCI to ISA bridge).

Parameters

[in]	This	The EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	Controller	The handle of ISA bus controller.
[in]	PciIo	The pointer to the PCI protocol.
[in]	ParentDevicePath	Device path of the ISA bus controller.

Return values

The	number of child device that is successfully created.

Definition at line 376 of file SioService.c.

◆ SioCreateChildDevice()

EFI_STATUS SioCreateChildDevice	(	IN EFI_DRIVER_BINDING_PROTOCOL *	This,
		IN EFI_HANDLE	Controller,
		IN EFI_PCI_IO_PROTOCOL *	PciIo,
		IN EFI_DEVICE_PATH_PROTOCOL *	ParentDevicePath,
		IN UINT32	DeviceIndex
	)

Create the child device with a given device index.

Parameters

[in]	This	The EFI_DRIVER_BINDING_PROTOCOL instance.
[in]	Controller	The handle of ISA bus controller.
[in]	PciIo	The pointer to the PCI protocol.
[in]	ParentDevicePath	Device path of the ISA bus controller.
[in]	DeviceIndex	Index of the device supported by this driver.

Return values

EFI_SUCCESS	The child device has been created successfully.
Others	Error occurred during the child device creation.

Definition at line 277 of file SioService.c.

◆ SioGetResources()

EFI_STATUS EFIAPI SioGetResources	(	IN CONST EFI_SIO_PROTOCOL *	This,
		OUT ACPI_RESOURCE_HEADER_PTR *	ResourceList
	)

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.

Parameters

[in]	This	Indicates a pointer to the calling context.
[out]	ResourceList	A pointer to an ACPI resource descriptor list that defines the current resources used by the device.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	ResourceList is NULL.

Definition at line 163 of file SioService.c.

◆ SioModify()

EFI_STATUS EFIAPI SioModify	(	IN CONST EFI_SIO_PROTOCOL *	This,
		IN CONST EFI_SIO_REGISTER_MODIFY *	Command,
		IN UINTN	NumberOfCommands
	)

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.

Parameters

[in]	This	Indicates a pointer to the calling context.
[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.
[in]	NumberOfCommands	Number of elements in the Command array.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	Command is NULL.

Definition at line 254 of file SioService.c.

◆ SioPossibleResources()

EFI_STATUS EFIAPI SioPossibleResources	(	IN CONST EFI_SIO_PROTOCOL *	This,
		OUT ACPI_RESOURCE_HEADER_PTR *	ResourceCollection
	)

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.

Parameters

[in]	This	Indicates a pointer to the calling context.
[out]	ResourceCollection	Collection of the resource descriptor lists.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	ResourceCollection is NULL.

Definition at line 219 of file SioService.c.

◆ SioRegisterAccess()

EFI_STATUS EFIAPI SioRegisterAccess	(	IN CONST EFI_SIO_PROTOCOL *	This,
		IN BOOLEAN	Write,
		IN BOOLEAN	ExitCfgMode,
		IN UINT8	Register,
		IN OUT UINT8 *	Value
	)

Provides a low level access to the registers for the Super I/O.

Parameters

[in]	This	Indicates a pointer to the calling context.
[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.
[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.
[in]	Register	Register number.
[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.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	The Value is NULL.
EFI_INVALID_PARAMETER	Invalid Register number.

Definition at line 131 of file SioService.c.

◆ SioSetResources()

EFI_STATUS EFIAPI SioSetResources	(	IN CONST EFI_SIO_PROTOCOL *	This,
		IN ACPI_RESOURCE_HEADER_PTR	ResourceList
	)

Sets the resources for the device.

Parameters

[in]	This	Indicates a pointer to the calling context.
[in]	ResourceList	Pointer to the ACPI resource descriptor list.

Return values

EFI_SUCCESS	The operation completed successfully.
EFI_INVALID_PARAMETER	ResourceList is invalid.
EFI_ACCESS_DENIED	Some of the resources in ResourceList are in use.

Definition at line 196 of file SioService.c.

Variable Documentation

◆ mAcpiDeviceNodeTemplate

GLOBAL_REMOVE_IF_UNREFERENCED ACPI_HID_DEVICE_PATH mAcpiDeviceNodeTemplate

Initial value:

= {
  {        
    ACPI_DEVICE_PATH,
    ACPI_DP,
    {
      (UINT8)(sizeof (ACPI_HID_DEVICE_PATH)),
      (UINT8)((sizeof (ACPI_HID_DEVICE_PATH)) >> 8)
    }
  },
  0x0,     
  0x0      
}

Definition at line 83 of file SioService.c.

◆ mCom1Resources

GLOBAL_REMOVE_IF_UNREFERENCED SIO_RESOURCES_IO mCom1Resources

Initial value:

= {
  {
    { ACPI_FIXED_LOCATION_IO_PORT_DESCRIPTOR }, 0x3F8, 8
  },
  { ACPI_END_TAG_DESCRIPTOR, 0             }
}

Definition at line 28 of file SioService.c.

◆ mCom2Resources

GLOBAL_REMOVE_IF_UNREFERENCED SIO_RESOURCES_IO mCom2Resources

Initial value:

= {
  {
    { ACPI_FIXED_LOCATION_IO_PORT_DESCRIPTOR }, 0x2F8, 8
  },
  { ACPI_END_TAG_DESCRIPTOR, 0             }
}

Definition at line 39 of file SioService.c.

◆ mDevicesInfo

GLOBAL_REMOVE_IF_UNREFERENCED SIO_DEVICE_INFO mDevicesInfo[]

Initial value:

= {
  {
    EISA_PNP_ID (0x501),
    0,
    { (ACPI_SMALL_RESOURCE_HEADER *)&mCom1Resources              }
  },  
  {
    EISA_PNP_ID (0x501),
    1,
    { (ACPI_SMALL_RESOURCE_HEADER *)&mCom2Resources              }
  },  
  {
    EISA_PNP_ID (0x303),
    0,
    { (ACPI_SMALL_RESOURCE_HEADER *)&mPs2KeyboardDeviceResources }
  }   
}

Definition at line 61 of file SioService.c.

◆ mPs2KeyboardDeviceResources

GLOBAL_REMOVE_IF_UNREFERENCED SIO_RESOURCES_IO mPs2KeyboardDeviceResources

Initial value:

= {
  {
    { ACPI_FIXED_LOCATION_IO_PORT_DESCRIPTOR }, 0x60, 5
  },
  { ACPI_END_TAG_DESCRIPTOR, 0             }
}

Definition at line 50 of file SioService.c.

◆ mSioInterface

EFI_SIO_PROTOCOL mSioInterface

Initial value:

= {
  SioRegisterAccess,
  SioGetResources,
  SioSetResources,
  SioPossibleResources,
  SioModify
}

Definition at line 16 of file SioService.c.

Functions

Variables

Detailed Description

Function Documentation

◆ SioCreateAllChildDevices()

◆ SioCreateChildDevice()

◆ SioGetResources()

◆ SioModify()

◆ SioPossibleResources()

◆ SioRegisterAccess()

◆ SioSetResources()

Variable Documentation

◆ mAcpiDeviceNodeTemplate

◆ mCom1Resources

◆ mCom2Resources

◆ mDevicesInfo

◆ mPs2KeyboardDeviceResources

◆ mSioInterface