diff options
Diffstat (limited to 'IntelFrameworkModulePkg/Include/Protocol')
| -rw-r--r-- | IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h | 50 | ||||
| -rw-r--r-- | IntelFrameworkModulePkg/Include/Protocol/IsaIo.h | 110 | ||||
| -rw-r--r-- | IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h | 18 | ||||
| -rw-r--r-- | IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h | 32 |
4 files changed, 105 insertions, 105 deletions
diff --git a/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h b/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h index 7de3504417..4ac2bea127 100644 --- a/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h +++ b/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h @@ -2,13 +2,13 @@ EFI ISA ACPI Protocol is used to enumerate and manage all the ISA controllers on
the platform's ISA Bus.
-Copyright (c) 2006 - 2010, 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 that accompanies this distribution.
+Copyright (c) 2006 - 2018, 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 that 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,
+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.
**/
@@ -71,13 +71,13 @@ typedef struct _EFI_ISA_ACPI_PROTOCOL EFI_ISA_ACPI_PROTOCOL; #define EFI_ISA_ACPI_IO_DECODE_16_BITS 0x02 ///< ISA controllers uses a 16-bit address decoder for I/O cycles.
///
-/// EFI ISA ACPI resource type
+/// EFI ISA ACPI resource type
///
typedef enum {
EfiIsaAcpiResourceEndOfList, ///< Marks the end if a resource list.
EfiIsaAcpiResourceIo, ///< ISA I/O port resource range.
EfiIsaAcpiResourceMemory, ///< ISA MMIO resource range.
- EfiIsaAcpiResourceDma, ///< ISA DMA resource.
+ EfiIsaAcpiResourceDma, ///< ISA DMA resource.
EfiIsaAcpiResourceInterrupt ///< ISA interrupt resource.
} EFI_ISA_ACPI_RESOURCE_TYPE;
@@ -112,10 +112,10 @@ typedef struct { This service allows all the ISA controllers on an ISA bus to be enumerated. If
Device is a pointer to a NULL value, then the first ISA controller on the ISA
- bus is returned in Device and EFI_SUCCESS is returned. If Device is a pointer
- to a value that was returned on a prior call to DeviceEnumerate(), then the next
+ bus is returned in Device and EFI_SUCCESS is returned. If Device is a pointer
+ to a value that was returned on a prior call to DeviceEnumerate(), then the next
ISA controller on the ISA bus is returned in Device and EFI_SUCCESS is returned.
- If Device is a pointer to the last ISA controller on the ISA bus, then
+ If Device is a pointer to the last ISA controller on the ISA bus, then
EFI_NOT_FOUND is returned.
@param[in] This The pointer to the EFI_ISA_ACPI_PROTOCOL instance.
@@ -135,8 +135,8 @@ EFI_STATUS /**
Sets the power state of an ISA controller.
- This services sets the power state of the ISA controller specified by Device to
- the power state specified by OnOff. TRUE denotes on, FALSE denotes off.
+ This services sets the power state of the ISA controller specified by Device to
+ the power state specified by OnOff. TRUE denotes on, FALSE denotes off.
If the power state is sucessfully set on the ISA Controller, then
EFI_SUCCESS is returned.
@@ -155,11 +155,11 @@ EFI_STATUS IN EFI_ISA_ACPI_DEVICE_ID *Device,
IN BOOLEAN OnOff
);
-
+
/**
Retrieves the current set of resources associated with an ISA controller.
- Retrieves the set of I/O, MMIO, DMA, and interrupt resources currently
+ Retrieves the set of I/O, MMIO, DMA, and interrupt resources currently
assigned to the ISA controller specified by Device. These resources
are returned in ResourceList.
@@ -209,7 +209,7 @@ EFI_STATUS @param[in] This The pointer to the EFI_ISA_ACPI_PROTOCOL instance.
@param[in] Device The pointer to an ISA controller named by ACPI HID/UID.
- @param[in] ResourceList The pointer to a resources list that must be one of the
+ @param[in] ResourceList The pointer to a resources list that must be one of the
resource lists returned by GetPosResource() for the
ISA controller specified by Device.
@@ -223,7 +223,7 @@ EFI_STATUS IN EFI_ISA_ACPI_PROTOCOL *This,
IN EFI_ISA_ACPI_DEVICE_ID *Device,
IN EFI_ISA_ACPI_RESOURCE_LIST *ResourceList
- );
+ );
/**
Enables or disables an ISA controller.
@@ -243,7 +243,7 @@ EFI_STATUS IN EFI_ISA_ACPI_PROTOCOL *This,
IN EFI_ISA_ACPI_DEVICE_ID *Device,
IN BOOLEAN Enable
- );
+ );
/**
Initializes an ISA controller, so that it can be used. This service must be called
@@ -261,14 +261,14 @@ EFI_STATUS (EFIAPI *EFI_ISA_ACPI_INIT_DEVICE)(
IN EFI_ISA_ACPI_PROTOCOL *This,
IN EFI_ISA_ACPI_DEVICE_ID *Device
- );
+ );
/**
- Initializes all the HW states required for the ISA controllers on the ISA bus
+ Initializes all the HW states required for the ISA controllers on the ISA bus
to be enumerated and managed by the rest of the services in this prorotol.
This service must be called before any of the other services in this
protocol will function as expected.
-
+
@param[in] This The pointer to the EFI_ISA_ACPI_PROTOCOL instance.
@retval EFI_SUCCESS Successfully initialized all required hardware states.
@@ -283,9 +283,9 @@ EFI_STATUS ///
/// The EFI_ISA_ACPI_PROTOCOL provides the services to enumerate and manage
-/// ISA controllers on an ISA bus. These services include the ability to initialize,
-/// enable, disable, and manage the power state of ISA controllers. It also
-/// includes services to query current resources, query possible resources,
+/// ISA controllers on an ISA bus. These services include the ability to initialize,
+/// enable, disable, and manage the power state of ISA controllers. It also
+/// includes services to query current resources, query possible resources,
/// and assign resources to an ISA controller.
///
struct _EFI_ISA_ACPI_PROTOCOL {
@@ -300,5 +300,5 @@ struct _EFI_ISA_ACPI_PROTOCOL { };
extern EFI_GUID gEfiIsaAcpiProtocolGuid;
-
+
#endif
diff --git a/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h b/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h index cf6632e737..c81a5d1e0e 100644 --- a/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h +++ b/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h @@ -1,14 +1,14 @@ /** @file
- ISA I/O Protocol is used by ISA device drivers to perform I/O, MMIO and DMA
+ ISA I/O Protocol is used by ISA device drivers to perform I/O, MMIO and DMA
operations on the ISA controllers they manage.
-
-Copyright (c) 2006 - 2010, 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 that accompanies this distribution.
+
+Copyright (c) 2006 - 2018, 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 that 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,
+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.
**/
@@ -84,7 +84,7 @@ typedef enum { EfiIsaIoOperationBusMasterWrite,
///
/// Provides both read and write access to system memory by both the processor
- /// and a bus master. The buffer is coherent from both the processor's and the
+ /// and a bus master. The buffer is coherent from both the processor's and the
/// bus master's point of view.
///
EfiIsaIoOperationBusMasterCommonBuffer,
@@ -102,15 +102,15 @@ typedef enum { /**
Performs ISA I/O and MMIO Read/Write Cycles
- @param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
+ @param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@param[in] Width Specifies the width of the I/O or MMIO operation.
- @param[in] Offset The offset into the ISA I/O or MMIO space to start the
- operation.
+ @param[in] Offset The offset into the ISA I/O or MMIO space to start the
+ operation.
@param[in] Count The number of I/O or MMIO operations to perform.
- @param[in, out] Buffer For read operations, the destination buffer to store
- the results. For write operations, the source buffer to
- write data from.
-
+ @param[in, out] Buffer For read operations, the destination buffer to store
+ the results. For write operations, the source buffer to
+ write data from.
+
@retval EFI_SUCCESS The data was successfully read from or written to the device.
@retval EFI_UNSUPPORTED The Offset is not valid for this device.
@retval EFI_INVALID_PARAMETER Width or Count, or both, were invalid.
@@ -171,48 +171,48 @@ EFI_STATUS Maps a memory region for DMA.
This function returns the device-specific addresses required to access system memory.
- This function is used to map system memory for ISA DMA operations. All ISA DMA
- operations must be performed through their mapped addresses, and such mappings must
+ This function is used to map system memory for ISA DMA operations. All ISA DMA
+ operations must be performed through their mapped addresses, and such mappings must
be freed with EFI_ISA_IO_PROTOCOL.Unmap() after the DMA operation is completed.
-
- If the DMA operation is a single read or write data transfer through an ISA bus
- master, then EfiIsaIoOperationBusMasterRead or EfiIsaIoOperationBusMasterWrite
+
+ If the DMA operation is a single read or write data transfer through an ISA bus
+ master, then EfiIsaIoOperationBusMasterRead or EfiIsaIoOperationBusMasterWrite
is used and the range is unmapped to complete the operation. If the DMA operation
- is a single read or write data transfer through an ISA slave controller, then
- EfiIsaIoOperationSlaveRead or EfiIsaIoOperationSlaveWrite is used and the range
- is unmapped to complete the operation.
-
- If performing a DMA read operation, all the data must be present in system memory before the Map() is performed. Similarly,
- if performing a DMA write operation, the data must not be accessed in system
- memory until EFI_ISA_IO_PROTOCOL.Unmap() is performed. Bus master operations that
- require both read and write access or require multiple host device interactions
- within the same mapped region must use EfiIsaIoOperationBusMasterCommonBuffer.
- However, only memory allocated via the EFI_ISA_IO_PROTOCOL.AllocateBuffer() interface
- is guaranteed to be able to be mapped for this operation type. In all mapping
+ is a single read or write data transfer through an ISA slave controller, then
+ EfiIsaIoOperationSlaveRead or EfiIsaIoOperationSlaveWrite is used and the range
+ is unmapped to complete the operation.
+
+ If performing a DMA read operation, all the data must be present in system memory before the Map() is performed. Similarly,
+ if performing a DMA write operation, the data must not be accessed in system
+ memory until EFI_ISA_IO_PROTOCOL.Unmap() is performed. Bus master operations that
+ require both read and write access or require multiple host device interactions
+ within the same mapped region must use EfiIsaIoOperationBusMasterCommonBuffer.
+ However, only memory allocated via the EFI_ISA_IO_PROTOCOL.AllocateBuffer() interface
+ is guaranteed to be able to be mapped for this operation type. In all mapping
requests the NumberOfBytes returned may be less than originally requested. It is
the caller's responsibility to make additional requests to complete the entire
transfer.
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
- @param[in] Operation Indicates the type of DMA (slave or bus master),
- and if the DMA operation is going to read or
- write to system memory.
- @param[in] ChannelNumber The slave channel number to use for this DMA
- operation. If Operation and ChannelAttributes
- shows that this device performs bus mastering
- DMA, then this field is ignored. The legal
+ @param[in] Operation Indicates the type of DMA (slave or bus master),
+ and if the DMA operation is going to read or
+ write to system memory.
+ @param[in] ChannelNumber The slave channel number to use for this DMA
+ operation. If Operation and ChannelAttributes
+ shows that this device performs bus mastering
+ DMA, then this field is ignored. The legal
range for this field is 0..7.
@param[in] ChannelAttributes A bitmask of the attributes used to configure
- the slave DMA channel for this DMA operation.
+ the slave DMA channel for this DMA operation.
See EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_* for the
legal bit combinations.
@param[in] HostAddress The system memory address to map to the device.
- @param[in, out] NumberOfBytes On input the number of bytes to map. On
+ @param[in, out] NumberOfBytes On input the number of bytes to map. On
output the number of bytes that were mapped.
- @param[out] DeviceAddress The resulting map address for the bus master
- device to use to access the hosts HostAddress.
+ @param[out] DeviceAddress The resulting map address for the bus master
+ device to use to access the hosts HostAddress.
@param[out] Mapping A returned value that must be passed to into
- EFI_ISA_IO_PROTOCOL.Unmap() to free all the the
+ EFI_ISA_IO_PROTOCOL.Unmap() to free all the the
resources associated with this map request.
@retval EFI_SUCCESS The range was mapped for the returned NumberOfBytes.
@@ -239,9 +239,9 @@ EFI_STATUS /**
Unmaps a memory region that was previously mapped with EFI_ISA_IO_PROTOCOL.Map().
- The EFI_ISA_IO_PROTOCOL.Map() operation is completed and any corresponding
- resources are released. If the operation was EfiIsaIoOperationSlaveWrite
- or EfiIsaIoOperationBusMasterWrite, the data is committed to system memory.
+ The EFI_ISA_IO_PROTOCOL.Map() operation is completed and any corresponding
+ resources are released. If the operation was EfiIsaIoOperationSlaveWrite
+ or EfiIsaIoOperationBusMasterWrite, the data is committed to system memory.
Any resources used for the mapping are freed.
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
@@ -259,10 +259,10 @@ EFI_STATUS /**
Allocates pages that are suitable for an EfiIsaIoOperationBusMasterCommonBuffer
- mapping.
+ mapping.
@param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance.
- @param[in] Type The type allocation to perform.
+ @param[in] Type The type allocation to perform.
@param[in] MemoryType The type of memory to allocate.
@param[in] Pages The number of pages to allocate.
@param[out] HostAddress A pointer to store the base address of the allocated range.
@@ -325,10 +325,10 @@ EFI_STATUS );
///
-/// The EFI_ISA_IO_PROTOCOL provides the basic Memory, I/O, and DMA interfaces
-/// used to abstract accesses to ISA controllers. There is one EFI_ISA_IO_PROTOCOL
-/// instance for each ISA controller on a ISA bus. A device driver that wishes
-/// to manage an ISA controller in a system will have to retrieve the
+/// The EFI_ISA_IO_PROTOCOL provides the basic Memory, I/O, and DMA interfaces
+/// used to abstract accesses to ISA controllers. There is one EFI_ISA_IO_PROTOCOL
+/// instance for each ISA controller on a ISA bus. A device driver that wishes
+/// to manage an ISA controller in a system will have to retrieve the
/// ISA_PCI_IO_PROTOCOL instance associated with the ISA controller.
///
struct _EFI_ISA_IO_PROTOCOL {
@@ -350,10 +350,10 @@ struct _EFI_ISA_IO_PROTOCOL { ///
UINT32 RomSize;
///
- /// A pointer to the in memory copy of the ROM image. The ISA Bus Driver is responsible
+ /// A pointer to the in memory copy of the ROM image. The ISA Bus Driver is responsible
/// for allocating memory for the ROM image, and copying the contents of the ROM to memory
/// during ISA Bus initialization.
- ///
+ ///
VOID *RomImage;
};
diff --git a/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h b/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h index c56b7e725b..0e1d8cd137 100644 --- a/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h +++ b/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h @@ -1,14 +1,14 @@ /** @file
- The OEM Badging Protocol defines the interface to get the OEM badging
+ The OEM Badging Protocol defines the interface to get the OEM badging
image with the display attribute. This protocol can be produced based on OEM badging images.
-Copyright (c) 2006 - 2010, 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 that accompanies this distribution.
+Copyright (c) 2006 - 2018, 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 that 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,
+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.
**/
@@ -53,8 +53,8 @@ typedef enum { @param This The pointer to this protocol instance.
@param Instance The visible image instance is found.
@param Format The format of the image. Examples: BMP, JPEG.
- @param ImageData The image data for the badge file. Currently only
- supports the .bmp file format.
+ @param ImageData The image data for the badge file. Currently only
+ supports the .bmp file format.
@param ImageSize The size of the image returned.
@param Attribute The display attributes of the image returned.
@param CoordinateX The X coordinate of the image.
diff --git a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h index e912eed213..7e6906023c 100644 --- a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h +++ b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h @@ -1,13 +1,13 @@ /** @file
The VGA Mini Port Protocol used to set the text display mode of a VGA controller.
-Copyright (c) 2006 - 2010, 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 that accompanies this distribution.
+Copyright (c) 2006 - 2018, 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 that 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,
+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.
**/
@@ -30,22 +30,22 @@ typedef struct _EFI_VGA_MINI_PORT_PROTOCOL EFI_VGA_MINI_PORT_PROTOCOL; /**
Sets the text display mode of a VGA controller.
-
- Sets the text display mode of the VGA controller to the mode specified by
- ModeNumber. A ModeNumber of 0 is a request for an 80x25 text mode. A
+
+ Sets the text display mode of the VGA controller to the mode specified by
+ ModeNumber. A ModeNumber of 0 is a request for an 80x25 text mode. A
ModeNumber of 1 is a request for an 80x50 text mode. If ModeNumber is greater
- than MaxModeNumber, then EFI_UNSUPPORTED is returned. If the VGA controller
+ than MaxModeNumber, then EFI_UNSUPPORTED is returned. If the VGA controller
is not functioning properly, then EFI_DEVICE_ERROR is returned. If the VGA
- controller is sucessfully set to the mode number specified by ModeNumber, then
+ controller is sucessfully set to the mode number specified by ModeNumber, then
EFI_SUCCESS is returned.
-
+
@param[in] This A pointer to the EFI_VGA_MINI_PORT_PROTOCOL instance.
@param[in] ModeNumber The requested mode number. 0 for 80x25. 1 for 80x5.
@retval EFI_SUCCESS The mode number was set.
@retval EFI_UNSUPPORTED The mode number specified by ModeNumber is not supported.
@retval EFI_DEVICE_ERROR The device is not functioning properly.
-
+
**/
typedef
EFI_STATUS
@@ -69,17 +69,17 @@ struct _EFI_VGA_MINI_PORT_PROTOCOL { ///
UINT64 CrtcDataRegisterOffset;
///
- /// PCI Controller MMIO BAR index of the VGA text mode frame buffer. Typically
+ /// PCI Controller MMIO BAR index of the VGA text mode frame buffer. Typically
/// set to EFI_PCI_IO_PASS_THROUGH_BAR
///
UINT8 VgaMemoryBar;
///
- /// PCI Controller I/O BAR index of the VGA CRTC address register. Typically
+ /// PCI Controller I/O BAR index of the VGA CRTC address register. Typically
/// set to EFI_PCI_IO_PASS_THROUGH_BAR
///
UINT8 CrtcAddressRegisterBar;
///
- /// PCI Controller I/O BAR index of the VGA CRTC data register. Typically set
+ /// PCI Controller I/O BAR index of the VGA CRTC data register. Typically set
/// to EFI_PCI_IO_PASS_THROUGH_BAR
///
UINT8 CrtcDataRegisterBar;
|