Code scrub for the Debug library, PostCode library, Print library, and ExtractGuidedS...

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

/** @file\r
  Serial I/O Port library functions definition.\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
\r
  Programmed hardware of Serial port.\r
\r
  @return  Status of Serial Port Device initialization.\r
\r
**/\r
RETURN_STATUS\r
EFIAPI\r
SerialPortInitialize (\r
  VOID\r
  );\r
\r
/**\r
  Write data from buffer to serial device. \r
 \r
  If the Buffer is NULL, then return 0; \r
  if NumberOfBytes is zero, then return 0. \r
\r
  @param  Buffer           Point of data buffer which need to be writed.\r
  @param  NumberOfBytes    Number of output bytes which are cached in Buffer.\r
\r
  @retval 0                Write data failed, or No data is to be written.\r
  @retval !0               Actual number of bytes writed to serial device.\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
  If the Buffer is NULL, then return zero;\r
  if NumberOfBytes is zero, then return zero.\r
\r
  @param  Buffer           Point of data buffer, which contains the data \r
                           returned 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
#endif\r