From 49fd8a3553770c6e47af266245b62a143b362d85 Mon Sep 17 00:00:00 2001 From: myronporter Date: Tue, 16 Mar 2010 23:34:53 +0000 Subject: Grammatical and disclaimer changes (does not follow internal C coding stds.) git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10257 6f19259b-4bc3-4df7-8a09-765794883524 --- IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h | 132 ++++++++++----------- IntelFrameworkModulePkg/Include/Protocol/IsaIo.h | 80 ++++++------- .../Include/Protocol/OEMBadging.h | 33 +++--- .../Include/Protocol/Ps2Policy.h | 16 +-- .../Include/Protocol/VgaMiniPort.h | 24 ++-- 5 files changed, 143 insertions(+), 142 deletions(-) (limited to 'IntelFrameworkModulePkg/Include/Protocol') diff --git a/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h b/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h index 4445d98ff7..b31be2ff4f 100644 --- a/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h +++ b/IntelFrameworkModulePkg/Include/Protocol/IsaAcpi.h @@ -2,14 +2,14 @@ EFI ISA ACPI Protocol is used to enumerate and manage all the ISA controllers on the platform's ISA Bus. - Copyright (c) 2006 - 2009, Intel Corporation - All rights reserved. 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. +Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved
+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, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -17,7 +17,7 @@ #define __ISA_ACPI_H_ /// -/// Global ID for the EFI ISA ACPI Protocol +/// Global ID for the EFI ISA ACPI Protocol. /// #define EFI_ISA_ACPI_PROTOCOL_GUID \ { \ @@ -30,65 +30,65 @@ typedef struct _EFI_ISA_ACPI_PROTOCOL EFI_ISA_ACPI_PROTOCOL; /// -/// ISA ACPI Protocol interrupt resource attributes +/// ISA ACPI Protocol interrupt resource attributes. /// -#define EFI_ISA_ACPI_IRQ_TYPE_HIGH_TRUE_EDGE_SENSITIVE 0x01 ///< Edge triggered interrupt on a rising edge -#define EFI_ISA_ACPI_IRQ_TYPE_LOW_TRUE_EDGE_SENSITIVE 0x02 ///< Edge triggered interrupt on a falling edge -#define EFI_ISA_ACPI_IRQ_TYPE_HIGH_TRUE_LEVEL_SENSITIVE 0x04 ///< Level sensitive interrupt active high -#define EFI_ISA_ACPI_IRQ_TYPE_LOW_TRUE_LEVEL_SENSITIVE 0x08 ///< Level sensitive interrupt active low +#define EFI_ISA_ACPI_IRQ_TYPE_HIGH_TRUE_EDGE_SENSITIVE 0x01 ///< Edge triggered interrupt on a rising edge. +#define EFI_ISA_ACPI_IRQ_TYPE_LOW_TRUE_EDGE_SENSITIVE 0x02 ///< Edge triggered interrupt on a falling edge. +#define EFI_ISA_ACPI_IRQ_TYPE_HIGH_TRUE_LEVEL_SENSITIVE 0x04 ///< Level sensitive interrupt active high. +#define EFI_ISA_ACPI_IRQ_TYPE_LOW_TRUE_LEVEL_SENSITIVE 0x08 ///< Level sensitive interrupt active low. /// -/// ISA ACPI Protocol DMA resource attributes +/// ISA ACPI Protocol DMA resource attributes. /// -#define EFI_ISA_ACPI_DMA_SPEED_TYPE_MASK 0x03 ///< Bit mask of supported DMA speed attributes -#define EFI_ISA_ACPI_DMA_SPEED_TYPE_COMPATIBILITY 0x00 ///< ISA controller supports compatibility mode DMA transfers -#define EFI_ISA_ACPI_DMA_SPEED_TYPE_A 0x01 ///< ISA controller supports type A DMA transfers -#define EFI_ISA_ACPI_DMA_SPEED_TYPE_B 0x02 ///< ISA controller supports type B DMA transfers -#define EFI_ISA_ACPI_DMA_SPEED_TYPE_F 0x03 ///< ISA controller supports type F DMA transfers -#define EFI_ISA_ACPI_DMA_COUNT_BY_BYTE 0x04 ///< ISA controller increments DMA address by bytes (8-bit) -#define EFI_ISA_ACPI_DMA_COUNT_BY_WORD 0x08 ///< ISA controller increments DMA address by words (16-bit) -#define EFI_ISA_ACPI_DMA_BUS_MASTER 0x10 ///< ISA controller is a DMA bus master -#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_8_BIT 0x20 ///< ISA controller only supports 8-bit DMA transfers -#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_8_BIT_AND_16_BIT 0x40 ///< ISA controller both 8-bit and 16-bit DMA transfers -#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_16_BIT 0x80 ///< ISA controller only supports 16-bit DMA transfers +#define EFI_ISA_ACPI_DMA_SPEED_TYPE_MASK 0x03 ///< Bit mask of supported DMA speed attributes. +#define EFI_ISA_ACPI_DMA_SPEED_TYPE_COMPATIBILITY 0x00 ///< ISA controller supports compatibility mode DMA transfers. +#define EFI_ISA_ACPI_DMA_SPEED_TYPE_A 0x01 ///< ISA controller supports type A DMA transfers. +#define EFI_ISA_ACPI_DMA_SPEED_TYPE_B 0x02 ///< ISA controller supports type B DMA transfers. +#define EFI_ISA_ACPI_DMA_SPEED_TYPE_F 0x03 ///< ISA controller supports type F DMA transfers. +#define EFI_ISA_ACPI_DMA_COUNT_BY_BYTE 0x04 ///< ISA controller increments DMA address by bytes (8-bit). +#define EFI_ISA_ACPI_DMA_COUNT_BY_WORD 0x08 ///< ISA controller increments DMA address by words (16-bit). +#define EFI_ISA_ACPI_DMA_BUS_MASTER 0x10 ///< ISA controller is a DMA bus master. +#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_8_BIT 0x20 ///< ISA controller only supports 8-bit DMA transfers. +#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_8_BIT_AND_16_BIT 0x40 ///< ISA controller both 8-bit and 16-bit DMA transfers. +#define EFI_ISA_ACPI_DMA_TRANSFER_TYPE_16_BIT 0x80 ///< ISA controller only supports 16-bit DMA transfers. /// /// ISA ACPI Protocol MMIO resource attributes /// -#define EFI_ISA_ACPI_MEMORY_WIDTH_MASK 0x03 ///< Bit mask of supported ISA memory width attributes -#define EFI_ISA_ACPI_MEMORY_WIDTH_8_BIT 0x00 ///< ISA MMIO region only supports 8-bit access -#define EFI_ISA_ACPI_MEMORY_WIDTH_16_BIT 0x01 ///< ISA MMIO region only supports 16-bit access -#define EFI_ISA_ACPI_MEMORY_WIDTH_8_BIT_AND_16_BIT 0x02 ///< ISA MMIO region supports both 8-bit and 16-bit access -#define EFI_ISA_ACPI_MEMORY_WRITEABLE 0x04 ///< ISA MMIO region supports write transactions -#define EFI_ISA_ACPI_MEMORY_CACHEABLE 0x08 ///< ISA MMIO region supports being cached -#define EFI_ISA_ACPI_MEMORY_SHADOWABLE 0x10 ///< ISA MMIO region may be shadowed -#define EFI_ISA_ACPI_MEMORY_EXPANSION_ROM 0x20 ///< ISA MMIO region is an expansion ROM +#define EFI_ISA_ACPI_MEMORY_WIDTH_MASK 0x03 ///< Bit mask of supported ISA memory width attributes. +#define EFI_ISA_ACPI_MEMORY_WIDTH_8_BIT 0x00 ///< ISA MMIO region only supports 8-bit access. +#define EFI_ISA_ACPI_MEMORY_WIDTH_16_BIT 0x01 ///< ISA MMIO region only supports 16-bit access. +#define EFI_ISA_ACPI_MEMORY_WIDTH_8_BIT_AND_16_BIT 0x02 ///< ISA MMIO region supports both 8-bit and 16-bit access. +#define EFI_ISA_ACPI_MEMORY_WRITEABLE 0x04 ///< ISA MMIO region supports write transactions. +#define EFI_ISA_ACPI_MEMORY_CACHEABLE 0x08 ///< ISA MMIO region supports being cached. +#define EFI_ISA_ACPI_MEMORY_SHADOWABLE 0x10 ///< ISA MMIO region may be shadowed. +#define EFI_ISA_ACPI_MEMORY_EXPANSION_ROM 0x20 ///< ISA MMIO region is an expansion ROM. /// /// ISA ACPI Protocol I/O resource attributes /// -#define EFI_ISA_ACPI_IO_DECODE_10_BITS 0x01 ///< ISA controllers uses a 10-bit address decoder for I/O cycles -#define EFI_ISA_ACPI_IO_DECODE_16_BITS 0x02 ///< ISA controllers uses a 16-bit address decoder for I/O cycles +#define EFI_ISA_ACPI_IO_DECODE_10_BITS 0x01 ///< ISA controllers uses a 10-bit address decoder for I/O cycles. +#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 /// 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 - EfiIsaAcpiResourceInterrupt ///< ISA interrupt resource + EfiIsaAcpiResourceEndOfList, ///< Marks the end if a resource list. + EfiIsaAcpiResourceIo, ///< ISA I/O port resource range. + EfiIsaAcpiResourceMemory, ///< ISA MMIO resource range. + EfiIsaAcpiResourceDma, ///< ISA DMA resource. + EfiIsaAcpiResourceInterrupt ///< ISA interrupt resource. } EFI_ISA_ACPI_RESOURCE_TYPE; /// /// EFI ISA ACPI generic resource structure /// typedef struct { - EFI_ISA_ACPI_RESOURCE_TYPE Type; ///< The type of resource (I/O, MMIO, DMA, Interrupt) + EFI_ISA_ACPI_RESOURCE_TYPE Type; ///< The type of resource (I/O, MMIO, DMA, Interrupt). UINT32 Attribute; ///< Bit mask of attributes associated with this resource. See EFI_ISA_ACPI_xxx macros for valid combinations. - UINT32 StartRange; ///< The start of the resource range - UINT32 EndRange; ///< The end of the resource range + UINT32 StartRange; ///< The start of the resource range. + UINT32 EndRange; ///< The end of the resource range. } EFI_ISA_ACPI_RESOURCE; /// @@ -103,8 +103,8 @@ typedef struct { /// EFI ISA ACPI resource list /// typedef struct { - EFI_ISA_ACPI_DEVICE_ID Device; ///< The ACPI HID/UID associated with an ISA controller - EFI_ISA_ACPI_RESOURCE *ResourceItem; ///< Pointer to the list of resources associated with an ISA controller + EFI_ISA_ACPI_DEVICE_ID Device; ///< The ACPI HID/UID associated with an ISA controller. + EFI_ISA_ACPI_RESOURCE *ResourceItem; ///< A pointer to the list of resources associated with an ISA controller. } EFI_ISA_ACPI_RESOURCE_LIST; /** @@ -118,8 +118,8 @@ typedef struct { If Device is a pointer to the last ISA controller on the ISA bus, then EFI_NOT_FOUND is returned. - @param[in] This Pointer to the EFI_ISA_ACPI_PROTOCOL instance. - @param[out] Device Pointer to an ISA controller named by ACPI HID/UID. + @param[in] This The pointer to the EFI_ISA_ACPI_PROTOCOL instance. + @param[out] Device The pointer to an ISA controller named by ACPI HID/UID. @retval EFI_SUCCESS The next ISA controller on the ISA bus was returned. @retval EFI_NOT_FOUND No device found. @@ -140,12 +140,12 @@ EFI_STATUS If the power state is sucessfully set on the ISA Controller, then EFI_SUCCESS is returned. - @param[in] This Pointer to the EFI_ISA_ACPI_PROTOCOL instance. - @param[in] Device Pointer to an ISA controller named by ACPI HID/UID. + @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] OnOff TRUE denotes on, FALSE denotes off. @retval EFI_SUCCESS Successfully set the power state of the ISA controller. - @retval Other The ISA controller cound not be placed in the requested power state. + @retval Other The ISA controller could not be placed in the requested power state. **/ typedef @@ -163,9 +163,9 @@ EFI_STATUS assigned to the ISA controller specified by Device. These resources are returned in ResourceList. - @param[in] This Pointer to the EFI_ISA_ACPI_PROTOCOL instance. - @param[in] Device Pointer to an ISA controller named by ACPI HID/UID. - @param[out] ResourceList Pointer to the current resource list for Device. + @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[out] ResourceList The pointer to the current resource list for Device. @retval EFI_SUCCESS Successfully retrieved the current resource list. @retval EFI_NOT_FOUND The resource list could not be retrieved. @@ -186,9 +186,9 @@ EFI_STATUS Retrieves the possible sets of I/O, MMIO, DMA, and interrupt resources for the ISA controller specified by Device. The sets are returned in ResourceList. - @param[in] This Pointer to the EFI_ISA_ACPI_PROTOCOL instance. - @param[in] Device Pointer to an ISA controller named by ACPI HID/UID. - @param[out] ResourceList Pointer to the returned list of resource lists. + @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[out] ResourceList The pointer to the returned list of resource lists. @retval EFI_UNSUPPORTED This service is not supported. @@ -207,9 +207,9 @@ EFI_STATUS Assigns the I/O, MMIO, DMA, and interrupt resources specified by ResourceList to the ISA controller specified by Device. ResourceList must match a resource list returned by GetPosResource() for the same ISA controller. - @param[in] This Pointer to the EFI_ISA_ACPI_PROTOCOL instance. - @param[in] Device Pointer to an ISA controller named by ACPI HID/UID. - @param[in] ResourceList Pointer to a resources list that must be one of the + @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 resource lists returned by GetPosResource() for the ISA controller specified by Device. @@ -228,13 +228,13 @@ EFI_STATUS /** Enables or disables an ISA controller. - @param[in] This Pointer to the EFI_ISA_ACPI_PROTOCOL instance. - @param[in] Device Pointer to the ISA controller to enable/disable. + @param[in] This The pointer to the EFI_ISA_ACPI_PROTOCOL instance. + @param[in] Device The pointer to the ISA controller to enable/disable. @param[in] Enable TRUE to enable the ISA controller. FALSE to disable the ISA controller. @retval EFI_SUCCESS Successfully enabled/disabled the ISA controller. - @retval Other The ISA controller cound not be placed in the requested state. + @retval Other The ISA controller could not be placed in the requested state. **/ typedef @@ -249,8 +249,8 @@ EFI_STATUS Initializes an ISA controller, so that it can be used. This service must be called before SetResource(), EnableDevice(), or SetPower() will behave as expected. - @param[in] This Pointer to the EFI_ISA_ACPI_PROTOCOL instance. - @param[in] Device Pointer to an ISA controller named by ACPI HID/UID. + @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. @retval EFI_SUCCESS Successfully initialized an ISA controller. @retval Other The ISA controller could not be initialized. @@ -269,7 +269,7 @@ EFI_STATUS This service must be called before any of the other services in this protocol will function as expected. - @param[in] This Pointer to the EFI_ISA_ACPI_PROTOCOL instance. + @param[in] This The pointer to the EFI_ISA_ACPI_PROTOCOL instance. @retval EFI_SUCCESS Successfully initialized all required hardware states. @retval Other The ISA interface could not be initialized. diff --git a/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h b/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h index 395f295479..8322df8511 100644 --- a/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h +++ b/IntelFrameworkModulePkg/Include/Protocol/IsaIo.h @@ -2,14 +2,14 @@ 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 - 2009, Intel Corporation - All rights reserved. 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. +Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved
+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, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -27,51 +27,51 @@ } /// -/// Forward declaration for the EFI_ISA_IO_PROTOCOL +/// Forward declaration for the EFI_ISA_IO_PROTOCOL. /// typedef struct _EFI_ISA_IO_PROTOCOL EFI_ISA_IO_PROTOCOL; /// -/// Width of EFI_ISA_IO_PROTOCOL I/O Port and MMIO operations +/// Width of EFI_ISA_IO_PROTOCOL I/O Port and MMIO operations. /// typedef enum { - EfiIsaIoWidthUint8 = 0, ///< 8-bit operation - EfiIsaIoWidthUint16, ///< 16-bit operation + EfiIsaIoWidthUint8 = 0, ///< 8-bit operation. + EfiIsaIoWidthUint16, ///< 16-bit operation. EfiIsaIoWidthUint32, ///< 32-bit operation EfiIsaIoWidthReserved, - EfiIsaIoWidthFifoUint8, ///< 8-bit FIFO operation - EfiIsaIoWidthFifoUint16, ///< 16-bit FIFO operation - EfiIsaIoWidthFifoUint32, ///< 32-bit FIFO operation + EfiIsaIoWidthFifoUint8, ///< 8-bit FIFO operation. + EfiIsaIoWidthFifoUint16, ///< 16-bit FIFO operation. + EfiIsaIoWidthFifoUint32, ///< 32-bit FIFO operation. EfiIsaIoWidthFifoReserved, - EfiIsaIoWidthFillUint8, ///< 8-bit Fill operation - EfiIsaIoWidthFillUint16, ///< 16-bit Fill operation - EfiIsaIoWidthFillUint32, ///< 32-bit Fill operation + EfiIsaIoWidthFillUint8, ///< 8-bit Fill operation. + EfiIsaIoWidthFillUint16, ///< 16-bit Fill operation. + EfiIsaIoWidthFillUint32, ///< 32-bit Fill operation. EfiIsaIoWidthFillReserved, EfiIsaIoWidthMaximum } EFI_ISA_IO_PROTOCOL_WIDTH; /// -/// Attributes for the EFI_ISA_IO_PROTOCOL common DMA buffer allocations +/// Attributes for the EFI_ISA_IO_PROTOCOL common DMA buffer allocations. /// -#define EFI_ISA_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x080 ///< Map a memory range so write are combined -#define EFI_ISA_IO_ATTRIBUTE_MEMORY_CACHED 0x800 ///< Map a memory range so all read and write accesses are cached -#define EFI_ISA_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000 ///< Disable a memory range +#define EFI_ISA_IO_ATTRIBUTE_MEMORY_WRITE_COMBINE 0x080 ///< Map a memory range so write are combined. +#define EFI_ISA_IO_ATTRIBUTE_MEMORY_CACHED 0x800 ///< Map a memory range so all read and write accesses are cached. +#define EFI_ISA_IO_ATTRIBUTE_MEMORY_DISABLE 0x1000 ///< Disable a memory range. /// /// Channel attribute for EFI_ISA_IO_PROTOCOL slave DMA requests /// -#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_COMPATIBLE 0x001 ///< Set the speed of the DMA transfer in compatible mode -#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_A 0x002 ///< Not supported -#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_B 0x004 ///< Not supported -#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_C 0x008 ///< Not supported -#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_WIDTH_8 0x010 ///< Request 8-bit DMA transfers. Only available on channels 0..3 -#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_WIDTH_16 0x020 ///< Request 16-bit DMA transfers. Only available on channels 4..7 -#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SINGLE_MODE 0x040 ///< Request a single DMA transfer -#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_DEMAND_MODE 0x080 ///< Request multiple DMA transfers until TC (Terminal Count) or EOP (End of Process) -#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_AUTO_INITIALIZE 0x100 ///< Automatically reload base and count at the end of the DMA transfer +#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_COMPATIBLE 0x001 ///< Set the speed of the DMA transfer in compatible mode. +#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_A 0x002 ///< Not supported. +#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_B 0x004 ///< Not supported. +#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SPEED_C 0x008 ///< Not supported. +#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_WIDTH_8 0x010 ///< Request 8-bit DMA transfers. Only available on channels 0..3. +#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_WIDTH_16 0x020 ///< Request 16-bit DMA transfers. Only available on channels 4..7. +#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_SINGLE_MODE 0x040 ///< Request a single DMA transfer. +#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_DEMAND_MODE 0x080 ///< Request multiple DMA transfers until TC (Terminal Count) or EOP (End of Process). +#define EFI_ISA_IO_SLAVE_DMA_ATTRIBUTE_AUTO_INITIALIZE 0x100 ///< Automatically reload base and count at the end of the DMA transfer. /// -/// The DMA opreration type for EFI_ISA_IO_PROTOCOL DMA requests +/// The DMA opreration type for EFI_ISA_IO_PROTOCOL DMA requests. /// typedef enum { /// @@ -128,7 +128,7 @@ EFI_STATUS ); /// -/// Structure of functions for accessing ISA I/O and MMIO space +/// Structure of functions for accessing ISA I/O and MMIO space. /// typedef struct { /// @@ -147,9 +147,9 @@ typedef struct { @param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance. @param[in] Width Specifies the width of the MMIO copy operation. - @param[in] DestOffset The offset of the destination in ISA MMIO space - @param[in] SrcOffset The offset of the source in ISA MMIO space - @param[in] Count The number tranfers to perform for this copy operation + @param[in] DestOffset The offset of the destination in ISA MMIO space. + @param[in] SrcOffset The offset of the source in ISA MMIO space. + @param[in] Count The number tranfers to perform for this copy operation. @retval EFI_SUCCESS The data was copied sucessfully. @retval EFI_UNSUPPORTED The DestOffset or SrcOffset is not valid for this device. @@ -237,7 +237,7 @@ EFI_STATUS ); /** - Unmaps a memory region that was previously mapped with EFI_ISA_IO_PROTOCOL.Map() + 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 @@ -270,8 +270,8 @@ EFI_STATUS @retval EFI_SUCCESS The requested memory pages were allocated. @retval EFI_INVALID_PARAMETER Type is invalid. - @retval EFI_INVALID_PARAMETER MemoryType is invalid - @retval EFI_INVALID_PARAMETER HostAddress is NULL + @retval EFI_INVALID_PARAMETER MemoryType is invalid. + @retval EFI_INVALID_PARAMETER HostAddress is NULL. @retval EFI_UNSUPPORTED Attributes is unsupported. @retval EFI_UNSUPPORTED The memory range specified by HostAddress, Pages, and Type is not available for common buffer use. @@ -290,7 +290,7 @@ EFI_STATUS ); /** - Frees a common buffer that was allocated with EFI_ISA_IO_PROTOCOL.AllocateBuffer() + Frees a common buffer that was allocated with EFI_ISA_IO_PROTOCOL.AllocateBuffer(). @param[in] This A pointer to the EFI_ISA_IO_PROTOCOL instance. @param[in] Pages The number of pages to free from the previously allocated common buffer. diff --git a/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h b/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h index 147916e1f9..57782101dd 100644 --- a/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h +++ b/IntelFrameworkModulePkg/Include/Protocol/OEMBadging.h @@ -2,13 +2,13 @@ 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 - 2008, Intel Corporation.
-All rights reserved. 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, +Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved
+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, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -50,16 +50,17 @@ typedef enum { Load an OEM badge image and return its data and attributes. - @param This Pointer to this protocol instance. + @param This The pointer to this protocol instance. @param Instance The visible image instance is found. - @param Format Format of the image. Examples: BMP, JPEG. - @param ImageData Image data for the badge file. Currently only supports the .bmp file format. - @param ImageSize Size of the image returned. - @param Attribute Display attributes of the image returned. - @param CoordinateX X coordinate of the image. - @param CoordinateY Y coordinate of the image. - - @retval EFI_SUCCESS Image has been fetched successfully. + @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 ImageSize The size of the image returned. + @param Attribute The display attributes of the image returned. + @param CoordinateX The X coordinate of the image. + @param CoordinateY The Y coordinate of the image. + + @retval EFI_SUCCESS The image was fetched successfully. @retval EFI_NOT_FOUND The specified image could not be found. **/ diff --git a/IntelFrameworkModulePkg/Include/Protocol/Ps2Policy.h b/IntelFrameworkModulePkg/Include/Protocol/Ps2Policy.h index 0ea26bdfc5..039296c78c 100644 --- a/IntelFrameworkModulePkg/Include/Protocol/Ps2Policy.h +++ b/IntelFrameworkModulePkg/Include/Protocol/Ps2Policy.h @@ -1,12 +1,12 @@ /** @file - PS/2 policy protocol abstracts the specific platform initialization and setting. - -Copyright (c) 2006 - 2009, Intel Corporation -All rights reserved. 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 - + PS/2 policy protocol abstracts the specific platform initialization and settings. + +Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved
+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, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. diff --git a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h index d5ee730aad..164644aa12 100644 --- a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h +++ b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h @@ -1,14 +1,14 @@ /** @file - VGA Mini Port Protocol that is used to set the text display mode of a VGA controller. + The VGA Mini Port Protocol used to set the text display mode of a VGA controller. - Copyright (c) 2006 - 2009, Intel Corporation - All rights reserved. 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. +Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved
+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, +WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. **/ @@ -16,7 +16,7 @@ #define __VGA_MINI_PORT_H_ /// -/// Global ID for the EFI_VGA_MINI_PORT_PROTOCOL +/// Global ID for the EFI_VGA_MINI_PORT_PROTOCOL. /// #define EFI_VGA_MINI_PORT_PROTOCOL_GUID \ { \ @@ -24,7 +24,7 @@ } /// -/// Forward declaration for the EFI_VGA_MINI_PORT_PROTOCOL +/// Forward declaration for the EFI_VGA_MINI_PORT_PROTOCOL. /// typedef struct _EFI_VGA_MINI_PORT_PROTOCOL EFI_VGA_MINI_PORT_PROTOCOL; @@ -42,7 +42,7 @@ typedef struct _EFI_VGA_MINI_PORT_PROTOCOL EFI_VGA_MINI_PORT_PROTOCOL; @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_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. -- cgit v1.2.3