MdePkg SerialPortLib: Upstream Get(Set)Control/SetAttributes interfaces

The extended interfaces GetControl/SetControl/SetAttributes are from
EmbeddedPkg/Include/Library/SerialPortExtLib.h.

(Sync patch r18963 from main trunk.)

Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Liming Gao <liming.gao@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Star Zeng <star.zeng@intel.com>
Reviewed-by: Liming Gao <liming.gao@intel.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/branches/UDK2015@19013 6f19259b-4bc3-4df7-8a09-765794883524

2 files changed, 165 insertions, 0 deletions

diff --git a/MdePkg/Include/Library/SerialPortLib.h b/MdePkg/Include/Library/SerialPortLib.h
index 1b129a71c1..965a2d964b 100644
--- a/MdePkg/Include/Library/SerialPortLib.h
+++ b/MdePkg/Include/Library/SerialPortLib.h
@@ -2,6 +2,7 @@
   This library class provides common serial I/O port functions.

 

 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,80 @@ 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 bits, 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.

+                            On output, the value actually set.

+  @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.

+                            On output, the value actually set.

+  @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.

+                            On output, the value actually set.

+  @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.

+                            On output, the value actually set.

+  @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.

+                            On output, the value actually set.

+  @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.

+                            On output, the value actually set.

+

+  @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 72ae23815b..e29fdf55bb 100644
--- a/MdePkg/Library/BaseSerialPortLibNull/BaseSerialPortLibNull.c
+++ b/MdePkg/Library/BaseSerialPortLibNull/BaseSerialPortLibNull.c
@@ -110,3 +110,88 @@ 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 bits, 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.

+                            On output, the value actually set.

+  @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.

+                            On output, the value actually set.

+  @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.

+                            On output, the value actually set.

+  @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.

+                            On output, the value actually set.

+  @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.

+                            On output, the value actually set.

+  @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.

+                            On output, the value actually set.

+

+  @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;

+}

+