Synchronization of MDE Library Spec., Mde.dec, and corresponding head files in MdePkg...

[mirror_edk2.git] / MdePkg / Include / Library / SerialPortLib.h

/** @file\r
  Provides three common serial I/O port functions.\r
\r
Copyright (c) 2006 - 2008, Intel Corporation\r
All rights reserved. This program and the accompanying materials\r
are licensed and made available under the terms and conditions of the BSD License\r
which accompanies this distribution.  The full text of the license may be found at\r
http://opensource.org/licenses/bsd-license.php\r
\r
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __SERIAL_PORT_LIB__\r
#define __SERIAL_PORT_LIB__\r
\r
/**\r
  Initialize the serial device hardware.\r
  \r
  If no initialization is required, then return RETURN_SUCCESS.\r
  If the serial device was successfuly initialized, then return RETURN_SUCCESS.\r
  If the serial device could not be initialized, then return RETURN_DEVICE_ERROR.\r
  \r
  @retval RETURN_SUCCESS        The serial device was initialized.\r
  @retval RETURN_DEVICE_ERROR   The serail device could not be initialized.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
SerialPortInitialize (\r
  VOID\r
  );\r
\r
/**\r
  Write data from buffer to serial device. \r
 \r
  Writes NumberOfBytes data bytes from Buffer to the serial device.  \r
  The number of bytes actually written to the serial device is returned.\r
  If the return value is less than NumberOfBytes, then the write operation failed.\r
\r
  If Buffer is NULL, then ASSERT(). \r
\r
  If NumberOfBytes is zero, then return 0.\r
\r
  @param  Buffer           Pointer to the data buffer to be written.\r
  @param  NumberOfBytes    Number of bytes to written to the serial device.\r
\r
  @retval 0                NumberOfBytes is 0.\r
  @retval >0               The number of bytes written to the serial device.  \r
                           If this value is less than NumberOfBytes, then the read operation failed.\r
\r
**/\r
UINTN\r
EFIAPI\r
SerialPortWrite (\r
  IN UINT8 	   *Buffer,\r
  IN UINTN 	   NumberOfBytes\r
  );\r
\r
\r
/**\r
  Read data from serial device and save the datas in buffer.\r
 \r
  Reads NumberOfBytes data bytes from a serial device into the buffer\r
  specified by Buffer. The number of bytes actually read is returned. \r
  If the return value is less than NumberOfBytes, then the rest operation failed.\r
\r
  If Buffer is NULL, then ASSERT(). \r
\r
  If NumberOfBytes is zero, then return 0.\r
\r
  @param  Buffer           Pointer to the data buffer to store the data read from the serial device.\r
  @param  NumberOfBytes    Number of bytes which will be read.\r
\r
  @retval 0                Read data failed, No data is to be read.\r
  @retval !0               Aactual number of bytes read from serial device.\r
\r
**/\r
UINTN\r
EFIAPI\r
SerialPortRead (\r
  OUT UINT8 	*Buffer,\r
  IN  UINTN 	NumberOfBytes\r
  );\r
\r
/**\r
  Polls a serial device to see if there is any data waiting to be read.\r
\r
  Polls aserial device to see if there is any data waiting to be read.\r
  If there is data waiting to be read from the serial device, then TRUE is returned.\r
  If there is no data waiting to be read from the serial device, then FALSE is returned.\r
\r
  @retval TRUE             Data is waiting to be read from the serial device.\r
  @retval FALSE            There is no data waiting to be read from the serial device.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
SerialPortPoll (\r
  VOID\r
  );\r
\r
#endif\r