EmbeddedPkg/Include/Library/SerialPortExtLib.h

   1 /** @file
   2
   3   Copyright (c) 2012, ARM Ltd. All rights reserved.
   4
   5   This program and the accompanying materials
   6   are licensed and made available under the terms and conditions of the BSD License
   7   which accompanies this distribution.  The full text of the license may be found at
   8   http://opensource.org/licenses/bsd-license.php
   9
  10   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  11   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  12
  13 **/
  14
  15 #ifndef __SERIAL_PORT_EXT_LIB_H__
  16 #define __SERIAL_PORT_EXT_LIB_H__
  17
  18 #include <Uefi/UefiBaseType.h>
  19 #include <Protocol/SerialIo.h>
  20
  21 /**
  22   Set the serial device control bits.
  23
  24   @return    Always return EFI_UNSUPPORTED.
  25
  26 **/
  27 RETURN_STATUS
  28 EFIAPI
  29 SerialPortSetControl (
  30   IN UINT32                   Control
  31   );
  32
  33 /**
  34   Get the serial device control bits.
  35
  36   @param  Control                 Control signals read from the serial device.
  37
  38   @retval EFI_SUCCESS             The control bits were read from the serial device.
  39   @retval EFI_DEVICE_ERROR        The serial device is not functioning correctly.
  40
  41 **/
  42 RETURN_STATUS
  43 EFIAPI
  44 SerialPortGetControl (
  45   OUT UINT32                  *Control
  46   );
  47
  48 /**
  49   Set the serial device attributes.
  50
  51   @return    Always return EFI_UNSUPPORTED.
  52
  53 **/
  54 RETURN_STATUS
  55 EFIAPI
  56 SerialPortSetAttributes (
  57   IN OUT UINT64              *BaudRate,
  58   IN OUT UINT32              *ReceiveFifoDepth,
  59   IN OUT UINT32              *Timeout,
  60   IN OUT EFI_PARITY_TYPE     *Parity,
  61   IN OUT UINT8               *DataBits,
  62   IN OUT EFI_STOP_BITS_TYPE  *StopBits
  63   );
  64
  65 #endif
  66