Star, There are a few comments included below for the SerialPortSetAttributes() function header comment block.
With those comment block fixes: Reviewed-by: Michael Kinney <michael.d.kin...@intel.com> Best regards, Mike > -----Original Message----- > From: edk2-devel [mailto:edk2-devel-boun...@lists.01.org] On Behalf Of Star > Zeng > Sent: Tuesday, November 17, 2015 3:07 AM > To: edk2-devel@lists.01.org > Cc: Kinney, Michael D <michael.d.kin...@intel.com>; Gao, Liming > <liming....@intel.com> > Subject: [edk2] [PATCH V2 01/12] MdePkg SerialPortLib: Upstream > GetControl/SetControl/SetAttributes interfaces > > The extended interfaces GetControl/SetControl/SetAttributes are from > EmbeddedPkg/Include/Library/SerialPortExtLib.h. > > Cc: Michael D Kinney <michael.d.kin...@intel.com> > Cc: Liming Gao <liming....@intel.com> > Contributed-under: TianoCore Contribution Agreement 1.0 > Signed-off-by: Star Zeng <star.z...@intel.com> > --- > MdePkg/Include/Library/SerialPortLib.h | 76 +++++++++++++++++++- > .../BaseSerialPortLibNull/BaseSerialPortLibNull.c | 81 > +++++++++++++++++++++- > 2 files changed, 155 insertions(+), 2 deletions(-) > > diff --git a/MdePkg/Include/Library/SerialPortLib.h > b/MdePkg/Include/Library/SerialPortLib.h > index 8f95786..28a3a23 100644 > --- a/MdePkg/Include/Library/SerialPortLib.h > +++ b/MdePkg/Include/Library/SerialPortLib.h > @@ -1,7 +1,8 @@ > /** @file > This library class provides common serial I/O port functions. > > -Copyright (c) 2006 - 2008, Intel Corporation. All rights reserved.<BR> > +Copyright (c) 2006 - 2015, Intel Corporation. All rights reserved.<BR> > +Copyright (c) 2012 - 2014, ARM Ltd. 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 @@ -15,6 +16,9 @@ WITHOUT WARRANTIES OR > REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED. > #ifndef __SERIAL_PORT_LIB__ > #define __SERIAL_PORT_LIB__ > > +#include <Uefi/UefiBaseType.h> > +#include <Protocol/SerialIo.h> > + > /** > Initialize the serial device hardware. > > @@ -97,4 +101,74 @@ SerialPortPoll ( > VOID > ); > > +/** > + Sets the control bits on a serial device. > + > + @param Control Sets the bits of Control that are settable. > + > + @retval RETURN_SUCCESS The new control bits were set on the serial > device. > + @retval RETURN_UNSUPPORTED The serial device does not support this > operation. > + @retval RETURN_DEVICE_ERROR The serial device is not functioning > correctly. > + > +**/ > +RETURN_STATUS > +EFIAPI > +SerialPortSetControl ( > + IN UINT32 Control > + ); > + > +/** > + Retrieve the status of the control bits on a serial device. > + > + @param Control A pointer to return the current control > signals from the serial device. > + > + @retval RETURN_SUCCESS The control bits were read from the serial > device. > + @retval RETURN_UNSUPPORTED The serial device does not support this > operation. > + @retval RETURN_DEVICE_ERROR The serial device is not functioning > correctly. > + > +**/ > +RETURN_STATUS > +EFIAPI > +SerialPortGetControl ( > + OUT UINT32 *Control > + ); > + > +/** > + Sets the baud rate, receive FIFO depth, transmit/receice time out, > +parity, > + data buts, and stop bits on a serial device. > + > + @param BaudRate The requested baud rate. A BaudRate value of 0 > will use the > + device's default interface speed. > + @param ReveiveFifoDepth The requested depth of the FIFO on the receive > side of the > + serial interface. A ReceiveFifoDepth value of 0 > will use > + the device's default FIFO depth. > + @param Timeout The requested time out for a single character in > microseconds. > + This timeout applies to both the transmit and > receive side of the > + interface. A Timeout value of 0 will use the > device's default time > + out value. > + @param Parity The type of parity to use on this serial device. > A Parity value of > + DefaultParity will use the device's default > parity value. > + @param DataBits The number of data bits to use on the serial > device. A DataBits > + vaule of 0 will use the device's default data > bit setting. > + @param StopBits The number of stop bits to use on this serial > device. A StopBits > + value of DefaultStopBits will use the device's > default number of > + stop bits. > + > + @retval RETURN_SUCCESS The new attributes were set on the > serial device. > + @retval RETURN_UNSUPPORTED The serial device does not support this > operation. > + @retval RETURN_INVALID_PARAMETER One or more of the attributes has an > unsupported value. > + @retval RETURN_DEVICE_ERROR The serial device is not functioning > correctly. > + > +**/ > +RETURN_STATUS > +EFIAPI > +SerialPortSetAttributes ( > + IN OUT UINT64 *BaudRate, > + IN OUT UINT32 *ReceiveFifoDepth, > + IN OUT UINT32 *Timeout, > + IN OUT EFI_PARITY_TYPE *Parity, > + IN OUT UINT8 *DataBits, > + IN OUT EFI_STOP_BITS_TYPE *StopBits > + ); > + > #endif > diff --git a/MdePkg/Library/BaseSerialPortLibNull/BaseSerialPortLibNull.c > b/MdePkg/Library/BaseSerialPortLibNull/BaseSerialPortLibNull.c > index d44fa52..a4475ae 100644 > --- a/MdePkg/Library/BaseSerialPortLibNull/BaseSerialPortLibNull.c > +++ b/MdePkg/Library/BaseSerialPortLibNull/BaseSerialPortLibNull.c > @@ -1,7 +1,7 @@ > /** @file > Null Serial Port library instance with empty functions. > > - Copyright (c) 2006 - 2010, Intel Corporation. All rights reserved.<BR> > + Copyright (c) 2006 - 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 @@ -110,3 +110,82 @@ SerialPortPoll ( > return FALSE; > } > > +/** > + Sets the control bits on a serial device. > + > + @param Control Sets the bits of Control that are settable. > + > + @retval RETURN_SUCCESS The new control bits were set on the serial > device. > + @retval RETURN_UNSUPPORTED The serial device does not support this > operation. > + @retval RETURN_DEVICE_ERROR The serial device is not functioning > correctly. > + > +**/ > +RETURN_STATUS > +EFIAPI > +SerialPortSetControl ( > + IN UINT32 Control > + ) > +{ > + return RETURN_UNSUPPORTED; > +} > + > +/** > + Retrieve the status of the control bits on a serial device. > + > + @param Control A pointer to return the current control > signals from the serial device. > + > + @retval RETURN_SUCCESS The control bits were read from the serial > device. > + @retval RETURN_UNSUPPORTED The serial device does not support this > operation. > + @retval RETURN_DEVICE_ERROR The serial device is not functioning > correctly. > + > +**/ > +RETURN_STATUS > +EFIAPI > +SerialPortGetControl ( > + OUT UINT32 *Control > + ) > +{ > + return RETURN_UNSUPPORTED; > +} > + > +/** > + Sets the baud rate, receive FIFO depth, transmit/receice time out, > +parity, > + data buts, and stop bits on a serial device. Typo in comment above. Should be "data bits". > + > + @param BaudRate The requested baud rate. A BaudRate value of 0 > will use the > + device's default interface speed. > + @param ReveiveFifoDepth The requested depth of the FIFO on the receive > side of the > + serial interface. A ReceiveFifoDepth value of 0 > will use > + the device's default FIFO depth. > + @param Timeout The requested time out for a single character in > microseconds. > + This timeout applies to both the transmit and > receive side of the > + interface. A Timeout value of 0 will use the > device's default time > + out value. > + @param Parity The type of parity to use on this serial device. > A Parity value of > + DefaultParity will use the device's default > parity value. > + @param DataBits The number of data bits to use on the serial > device. A DataBits > + vaule of 0 will use the device's default data > bit setting. > + @param StopBits The number of stop bits to use on this serial > device. A StopBits > + value of DefaultStopBits will use the device's > default number of > + stop bits. The parameters above are declared as IN OUT in function prototype below, and the parameters are updated with the value actually set, but the description of the parameters above does not describe that the parameter value is updated and returned to the caller. Please update parameter description for all IN OUT parameters to describe the OUT behavior. > + > + @retval RETURN_SUCCESS The new attributes were set on the > serial device. > + @retval RETURN_UNSUPPORTED The serial device does not support this > operation. > + @retval RETURN_INVALID_PARAMETER One or more of the attributes has an > unsupported value. > + @retval RETURN_DEVICE_ERROR The serial device is not functioning > correctly. > + > +**/ > +RETURN_STATUS > +EFIAPI > +SerialPortSetAttributes ( > + IN OUT UINT64 *BaudRate, > + IN OUT UINT32 *ReceiveFifoDepth, > + IN OUT UINT32 *Timeout, > + IN OUT EFI_PARITY_TYPE *Parity, > + IN OUT UINT8 *DataBits, > + IN OUT EFI_STOP_BITS_TYPE *StopBits > + ) > +{ > + return RETURN_UNSUPPORTED; > +} > + > -- > 1.9.5.msysgit.0 > > _______________________________________________ > edk2-devel mailing list > edk2-devel@lists.01.org > https://lists.01.org/mailman/listinfo/edk2-devel _______________________________________________ edk2-devel mailing list edk2-devel@lists.01.org https://lists.01.org/mailman/listinfo/edk2-devel
