mirror of https://github.com/acidanthera/audk.git
Update function description per UEFI2.3d. The main changes include:
1. If string is a unicode string, its description doesn’t need to specify unicode word again, because by default, string is UCS-2 (Table 6) encoded. 2. EFI_UNSUPPORTED return status is missing for EFI_EAP_PROTOCOL.SetDesiredAuthMethod() function. 3. For LoadImage() service, EFI_ACCESS_DENIED return status is added, and EFI_SECURITY_VIOLATION return status description is updated. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@11305 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
parent
2ab7038ce1
commit
9095e76b3d
|
@ -20,7 +20,7 @@
|
||||||
may then need to be reconnected or the system may need to be rebooted for the
|
may then need to be reconnected or the system may need to be rebooted for the
|
||||||
configuration changes to take affect.
|
configuration changes to take affect.
|
||||||
|
|
||||||
Copyright (c) 2009, Intel Corporation. All rights reserved.<BR>
|
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
|
||||||
This program and the accompanying materials
|
This program and the accompanying materials
|
||||||
are licensed and made available under the terms and conditions of the BSD License
|
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
|
which accompanies this distribution. The full text of the license may be found at
|
||||||
|
@ -30,7 +30,7 @@
|
||||||
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
|
||||||
|
|
||||||
@par Revision Reference:
|
@par Revision Reference:
|
||||||
This Protocol is defined in UEFI Specification 2.2
|
This Protocol is defined in UEFI Specification 2.3d
|
||||||
|
|
||||||
**/
|
**/
|
||||||
|
|
||||||
|
@ -131,7 +131,7 @@ EFI_STATUS
|
||||||
containing a EFI_HII_HANDLE with a value of NULL. The
|
containing a EFI_HII_HANDLE with a value of NULL. The
|
||||||
EFI_HII_STRING_PROTOCOL.GetString() function can be used to
|
EFI_HII_STRING_PROTOCOL.GetString() function can be used to
|
||||||
retrieve the warning or error message as a Null-terminated
|
retrieve the warning or error message as a Null-terminated
|
||||||
Unicode string in a specific language. Messages may be
|
string in a specific language. Messages may be
|
||||||
returned for any of the HealthStatus values except
|
returned for any of the HealthStatus values except
|
||||||
EfiDriverHealthStatusReconnectRequired and
|
EfiDriverHealthStatusReconnectRequired and
|
||||||
EfiDriverHealthStatusRebootRequired.
|
EfiDriverHealthStatusRebootRequired.
|
||||||
|
|
|
@ -5,7 +5,7 @@
|
||||||
The definitions in this file are defined in UEFI Specification 2.3, which have
|
The definitions in this file are defined in UEFI Specification 2.3, which have
|
||||||
not been verified by one implementation yet.
|
not been verified by one implementation yet.
|
||||||
|
|
||||||
Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>
|
Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
|
||||||
This program and the accompanying materials
|
This program and the accompanying materials
|
||||||
are licensed and made available under the terms and conditions of the BSD License
|
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
|
which accompanies this distribution. The full text of the license may be found at
|
||||||
|
@ -83,8 +83,8 @@ EFI_STATUS
|
||||||
|
|
||||||
If EapAuthType is an invalid EAP authentication type, then EFI_INVALID_PARAMETER is
|
If EapAuthType is an invalid EAP authentication type, then EFI_INVALID_PARAMETER is
|
||||||
returned.
|
returned.
|
||||||
If the EAP authentication method of EapAuthType is unsupported by the Ports, then this
|
If the EAP authentication method of EapAuthType is unsupported by the Ports, then it will
|
||||||
function will return EFI_UNSUPPORTED.
|
return EFI_UNSUPPORTED.
|
||||||
|
|
||||||
@param[in] This A pointer to the EFI_EAP_PROTOCOL instance that indicates
|
@param[in] This A pointer to the EFI_EAP_PROTOCOL instance that indicates
|
||||||
the calling context.
|
the calling context.
|
||||||
|
@ -95,7 +95,8 @@ EFI_STATUS
|
||||||
@retval EFI_SUCCESS The EAP authentication method of EapAuthType is
|
@retval EFI_SUCCESS The EAP authentication method of EapAuthType is
|
||||||
registered successfully.
|
registered successfully.
|
||||||
@retval EFI_INVALID_PARAMETER EapAuthType is an invalid EAP authentication type.
|
@retval EFI_INVALID_PARAMETER EapAuthType is an invalid EAP authentication type.
|
||||||
@retval EFI_OUT_OF_RESOURCES There is not enough system memory to perform the registration.
|
@retval EFI_UNSUPPORTED The EAP authentication method of EapAuthType is
|
||||||
|
unsupported by the Port.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
typedef
|
typedef
|
||||||
|
|
|
@ -5,7 +5,7 @@
|
||||||
by a UEFI Driver in its Start() function. This protocol allows the driver to receive
|
by a UEFI Driver in its Start() function. This protocol allows the driver to receive
|
||||||
configuration information as part of being started.
|
configuration information as part of being started.
|
||||||
|
|
||||||
Copyright (c) 2006 - 2009, Intel Corporation. All rights reserved.<BR>
|
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
|
||||||
This program and the accompanying materials
|
This program and the accompanying materials
|
||||||
are licensed and made available under the terms and conditions of the BSD License
|
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
|
which accompanies this distribution. The full text of the license may be found at
|
||||||
|
@ -289,14 +289,15 @@ struct _EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOCOL {
|
||||||
used.
|
used.
|
||||||
**/
|
**/
|
||||||
typedef struct {
|
typedef struct {
|
||||||
CHAR8 *CLPCommand; ///< A pointer to the DMTF SM CLP command line null-terminated string that the
|
CHAR8 *CLPCommand; ///< A pointer to the null-terminated UTF-8 string that specifies the DMTF SM CLP command
|
||||||
///< driver is required to parse and process when this function is called.
|
///< line that the driver is required to parse and process when this function is called.
|
||||||
///< See the DMTF SM CLP Specification 1.0 Final Standard for details on the
|
///< See the DMTF SM CLP Specification 1.0 Final Standard for details on the
|
||||||
///< format and syntax of the CLP command line string. CLPCommand buffer
|
///< format and syntax of the CLP command line string. CLPCommand buffer
|
||||||
///< is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.
|
///< is allocated by the producer of the EFI_PLATFORM_TO_DRIVER_CONFIGURATION_PROTOOL.
|
||||||
UINT32 CLPCommandLength; ///< The length of the CLP Command in bytes.
|
UINT32 CLPCommandLength; ///< The length of the CLP Command in bytes.
|
||||||
CHAR8 *CLPReturnString; ///< A pointer to the CLP return status string that the driver is required to
|
CHAR8 *CLPReturnString; ///< A pointer to the null-terminated UTF-8 string that indicates the CLP return status
|
||||||
///< provide to the calling agent. The calling agent may parse and/ or pass
|
///< that the driver is required to provide to the calling agent.
|
||||||
|
///< The calling agent may parse and/ or pass
|
||||||
///< this for processing and user feedback. The SM CLP Command Response string
|
///< this for processing and user feedback. The SM CLP Command Response string
|
||||||
///< buffer is filled in by the UEFI driver in the "keyword=value" format
|
///< buffer is filled in by the UEFI driver in the "keyword=value" format
|
||||||
///< described in the SM CLP Specification, unless otherwise requested via the SM
|
///< described in the SM CLP Specification, unless otherwise requested via the SM
|
||||||
|
|
|
@ -1,11 +1,11 @@
|
||||||
/** @file
|
/** @file
|
||||||
Include file that supports UEFI.
|
Include file that supports UEFI.
|
||||||
|
|
||||||
This include file must only contain things defined in the UEFI 2.1 specification.
|
This include file must contain things defined in the UEFI 2.3 specification.
|
||||||
If a code construct is defined in the UEFI 2.1 specification it must be included
|
If a code construct is defined in the UEFI 2.3 specification it must be included
|
||||||
by this include file.
|
by this include file.
|
||||||
|
|
||||||
Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR>
|
Copyright (c) 2006 - 2011, Intel Corporation. All rights reserved.<BR>
|
||||||
This program and the accompanying materials are licensed and made available under
|
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 terms and conditions of the BSD License that accompanies this distribution.
|
||||||
The full text of the license may be found at
|
The full text of the license may be found at
|
||||||
|
@ -821,7 +821,11 @@ EFI_STATUS
|
||||||
@retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
|
@retval EFI_LOAD_ERROR Image was not loaded because the image format was corrupt or not
|
||||||
understood.
|
understood.
|
||||||
@retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
|
@retval EFI_DEVICE_ERROR Image was not loaded because the device returned a read error.
|
||||||
|
@retval EFI_ACCESS_DENIED Image was not loaded because the platform policy prohibits the
|
||||||
|
image from being loaded. NULL is returned in *ImageHandle.
|
||||||
|
@retval EFI_SECURITY_VIOLATION Image was loaded and an ImageHandle was created with a
|
||||||
|
valid EFI_LOADED_IMAGE_PROTOCOL. However, the current
|
||||||
|
platform policy specifies that the image should not be started.
|
||||||
**/
|
**/
|
||||||
typedef
|
typedef
|
||||||
EFI_STATUS
|
EFI_STATUS
|
||||||
|
|
Loading…
Reference in New Issue