tyler.durden/audk
1
0
Fork 0
mirror of https://github.com/acidanthera/audk.git synced 2025-07-26 15:14:02 +02:00
Code Issues Packages Projects Releases Wiki Activity

MdeModulePkg/SerialDxe: Fix return valued in SerialSetAttributes

Browse Source 
SerialSetAttributes is meant to match the behavior of the function
EFI_SERIAL_IO_PROTOCOL.SetAttributes() in the UEFI spec (v2.7). This
means the function can only return:
    - EFI_SUCCESS
    - EFI_INVALID_PARAMETER
    - EFI_DEVICE_ERROR

However the function SerialPortSetAttributes may also validly return
EFI_UNSUPPORTED. For instance this is the case of the Xen Console
driver.

EFI_UNSUPPORTED could be also interpreted as "One or more of the attributes
has an unsupported value". So return EFI_INVALID_PARAMETER in that case.

Lastly, to prevent another return slipping in the future, all the errors
but EFI_INVALID_PARAMETER and EFI_UNSUPPORTED will return
EFI_DEVICE_ERROR.

Contributed-under: Tianocore Contribution Agreement 1.1
Signed-off-by: Julien Grall <julien.grall@linaro.org>
Reviewed-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Laszlo Ersek <lersek@redhat.com>
This commit is contained in:
Julien Grall 2017-11-30 01:28:22 +08:00 committed by Star Zeng
parent b462f25a21
commit 13d378fc82
2 changed files with 12 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
MdeModulePkg/Universal/SerialDxe/SerialIo.c
View File

@ -66,8 +66,9 @@ SerialReset (
value of DefaultStopBits will use the device's default number of value of DefaultStopBits will use the device's default number of
stop bits. stop bits.
@retval EFI_SUCCESS The device was reset. @retval EFI_SUCCESS The device was reset.
@retval EFI_DEVICE_ERROR The serial device is not functioning correctly. @retval EFI_INVALID_PARAMETER One or more attributes has an unsupported value.
@retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
**/ **/
EFI_STATUS EFI_STATUS
@ -264,8 +265,9 @@ SerialReset (
value of DefaultStopBits will use the device's default number of value of DefaultStopBits will use the device's default number of
stop bits. stop bits.
@retval EFI_SUCCESS The device was reset. @retval EFI_SUCCESS The device was reset.
@retval EFI_DEVICE_ERROR The serial device is not functioning correctly. @retval EFI_INVALID_PARAMETER One or more attributes has an unsupported value.
@retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
**/ **/
EFI_STATUS EFI_STATUS
@ -323,8 +325,10 @@ SerialSetAttributes (
DataBits = OriginalDataBits; DataBits = OriginalDataBits;
StopBits = OriginalStopBits; StopBits = OriginalStopBits;
Status = EFI_SUCCESS; Status = EFI_SUCCESS;
} else if (Status == EFI_INVALID_PARAMETER || Status == EFI_UNSUPPORTED) {
return EFI_INVALID_PARAMETER;
} else { } else {
return Status; return EFI_DEVICE_ERROR;
} }
} }

5
MdePkg/Include/Protocol/SerialIo.h
View File

@ -125,8 +125,9 @@ EFI_STATUS
value of DefaultStopBits will use the device's default number of value of DefaultStopBits will use the device's default number of
stop bits. stop bits.
@retval EFI_SUCCESS The device was reset. @retval EFI_SUCCESS The device was reset.
@retval EFI_DEVICE_ERROR The serial device is not functioning correctly. @retval EFI_INVALID_PARAMETER One or more attributes has an unsupported value.
@retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
**/ **/
typedef typedef