diff options
Diffstat (limited to 'Include/Protocol')
| -rw-r--r-- | Include/Protocol/IsaHc.h | 116 | ||||
| -rw-r--r-- | Include/Protocol/SuperIoControl.h | 92 |
2 files changed, 208 insertions, 0 deletions
diff --git a/Include/Protocol/IsaHc.h b/Include/Protocol/IsaHc.h new file mode 100644 index 0000000000..4677c7ec66 --- /dev/null +++ b/Include/Protocol/IsaHc.h @@ -0,0 +1,116 @@ +/** @file
+ 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.<BR>
+ 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.
+
+ @par Revision Reference:
+ This protocol is from PI Version 1.2.1.
+
+**/
+
+#ifndef __ISA_HC_PROTOCOL_H__
+#define __ISA_HC_PROTOCOL_H__
+
+#define EFI_ISA_HC_PROTOCOL_GUID \
+ { \
+ 0xbcdaf080, 0x1bde, 0x4e22, {0xae, 0x6a, 0x43, 0x54, 0x1e, 0x12, 0x8e, 0xc4} \
+ }
+
+#define EFI_ISA_HC_SERVICE_BINDING_PROTOCOL_GUID \
+ { \
+ 0xfad7933a, 0x6c21, 0x4234, {0xa4, 0x34, 0x0a, 0x8a, 0x0d, 0x2b, 0x07, 0x81} \
+ }
+
+typedef struct _EFI_ISA_HC_PROTOCOL EFI_ISA_HC_PROTOCOL;
+typedef struct _EFI_ISA_HC_PROTOCOL *PEFI_ISA_HC_PROTOCOL;
+
+/**
+ 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.
+
+ @param This A pointer to this instance of the EFI_ISA_HC_PROTOCOL.
+ @param IoAddress An unsigned integer that specifies the first byte of the
+ I/O space required.
+ @param IoLength An unsigned integer that specifies the number of bytes
+ of the I/O space required.
+ @param IoApertureHandle A pointer to the returned I/O aperture handle. This
+ value can be used on subsequent calls to CloseIoAperture().
+
+ @retval EFI_SUCCESS The I/O aperture was opened successfully.
+ @retval EFI_UNSUPPORTED The ISA Host Controller is a subtractive-decode controller.
+ @retval EFI_OUT_OF_RESOURCES There is no available I/O aperture.
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_ISA_HC_OPEN_IO) (
+ IN CONST EFI_ISA_HC_PROTOCOL *This,
+ IN UINT16 IoAddress,
+ IN UINT16 IoLength,
+ OUT UINT64 *IoApertureHandle
+ );
+
+/**
+ 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.
+
+ @param This A pointer to this instance of the EFI_ISA_HC_PROTOCOL.
+ @param IoApertureHandle The I/O aperture handle previously returned from a
+ call to OpenIoAperture().
+
+ @retval EFI_SUCCESS The IO aperture was closed successfully.
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_ISA_HC_CLOSE_IO) (
+ IN CONST EFI_ISA_HC_PROTOCOL *This,
+ IN UINT64 IoApertureHandle
+ );
+
+///
+/// ISA HC Protocol
+///
+struct _EFI_ISA_HC_PROTOCOL {
+ ///
+ /// The version of this protocol. Higher version numbers are backward
+ /// compatible with lower version numbers.
+ ///
+ UINT32 Version;
+ ///
+ /// Open an I/O aperture.
+ ///
+ EFI_ISA_HC_OPEN_IO OpenIoAperture;
+ ///
+ /// Close an I/O aperture.
+ ///
+ EFI_ISA_HC_CLOSE_IO CloseIoAperture;
+};
+
+///
+/// Reference to variable defined in the .DEC file
+///
+extern EFI_GUID gEfiIsaHcProtocolGuid;
+extern EFI_GUID gEfiIsaHcServiceBindingProtocolGuid;
+
+#endif // __ISA_HC_H__
diff --git a/Include/Protocol/SuperIoControl.h b/Include/Protocol/SuperIoControl.h new file mode 100644 index 0000000000..e68fce8118 --- /dev/null +++ b/Include/Protocol/SuperIoControl.h @@ -0,0 +1,92 @@ +/** @file
+ The Super I/O Control Protocol is installed by the Super I/O driver. It provides
+ the low-level services for SIO devices that enable them to be used in the UEFI
+ driver model.
+
+ Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
+ 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.
+
+ @par Revision Reference:
+ This protocol is from PI Version 1.2.1.
+
+**/
+
+#ifndef __EFI_SUPER_IO_CONTROL_PROTOCOL_H__
+#define __EFI_SUPER_IO_CONTROL_PROTOCOL_H__
+
+#define EFI_SIO_CONTROL_PROTOCOL_GUID \
+ { \
+ 0xb91978df, 0x9fc1, 0x427d, { 0xbb, 0x5, 0x4c, 0x82, 0x84, 0x55, 0xca, 0x27 } \
+ }
+
+typedef struct _EFI_SIO_CONTROL_PROTOCOL EFI_SIO_CONTROL_PROTOCOL;
+typedef struct _EFI_SIO_CONTROL_PROTOCOL *PEFI_SIO_CONTROL_PROTOCOL;
+
+/**
+ Enable an ISA-style device.
+
+ This function enables a logical ISA device and, if necessary, configures it
+ to default settings, including memory, I/O, DMA and IRQ resources.
+
+ @param This A pointer to this instance of the EFI_SIO_CONTROL_PROTOCOL.
+
+ @retval EFI_SUCCESS The device is enabled successfully.
+ @retval EFI_OUT_OF_RESOURCES The device could not be enabled because there
+ were insufficient resources either for the device
+ itself or for the records needed to track the device.
+ @retval EFI_ALREADY_STARTED The device is already enabled.
+ @retval EFI_UNSUPPORTED The device cannot be enabled.
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_SIO_CONTROL_ENABLE)(
+ IN CONST EFI_SIO_CONTROL_PROTOCOL *This
+ );
+
+/**
+ Disable a logical ISA device.
+
+ This function disables a logical ISA device so that it no longer consumes
+ system resources, such as memory, I/O, DMA and IRQ resources. Enough information
+ must be available so that subsequent Enable() calls would properly reconfigure
+ the device.
+
+ @param This A pointer to this instance of the EFI_SIO_CONTROL_PROTOCOL.
+
+ @retval EFI_SUCCESS The device is disabled successfully.
+ @retval EFI_OUT_OF_RESOURCES The device could not be disabled because there
+ were insufficient resources either for the device
+ itself or for the records needed to track the device.
+ @retval EFI_ALREADY_STARTED The device is already disabled.
+ @retval EFI_UNSUPPORTED The device cannot be disabled.
+**/
+typedef
+EFI_STATUS
+(EFIAPI *EFI_SIO_CONTROL_DISABLE)(
+ IN CONST EFI_SIO_CONTROL_PROTOCOL *This
+ );
+
+struct _EFI_SIO_CONTROL_PROTOCOL {
+ ///
+ /// The version of this protocol.
+ ///
+ UINT32 Version;
+ ///
+ /// Enable a device.
+ ///
+ EFI_SIO_CONTROL_ENABLE EnableDevice;
+ ///
+ /// Disable a device.
+ ///
+ EFI_SIO_CONTROL_DISABLE DisableDevice;
+};
+
+extern EFI_GUID gEfiSioControlProtocolGuid;
+
+#endif // __EFI_SUPER_IO_CONTROL_PROTOCOL_H__
|