projects / mirror_edk2.git / blame
| Commit | Line | Data |
|---|---|---|
| 1e57a462 | 1 | /** @file\r |
| 2 | \r | |
| 5f81a620 RC |
3 | Serial I/O port control interface extension.\r |
| 4 | \r | |
| 5 | This library provides an extension to the library providing common\r | |
| 6 | serial I/O port functions that is defined in MdePkg. The aim is to\r | |
| 7 | provide more control over the functionalities of a serial port. The\r | |
| 8 | extension covers all the needs of the UEFI Serial I/O Protocol.\r | |
| 9 | Though, its use is not restricted to the UEFI Serial I/O Protocol.\r | |
| 10 | It could for example be used in the PEI phase of the boot sequence\r | |
| 11 | as well.\r | |
| 12 | \r | |
| 13 | Copyright (c) 2012 - 2014, ARM Ltd. All rights reserved.\r | |
| 3402aac7 | 14 | \r |
| 1e57a462 | 15 | This program and the accompanying materials\r |
| 16 | are licensed and made available under the terms and conditions of the BSD License\r | |
| 17 | which accompanies this distribution. The full text of the license may be found at\r | |
| 18 | http://opensource.org/licenses/bsd-license.php\r | |
| 19 | \r | |
| 20 | THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r | |
| 21 | WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r | |
| 22 | \r | |
| 23 | **/\r | |
| 24 | \r | |
| 25 | #ifndef __SERIAL_PORT_EXT_LIB_H__\r | |
| 26 | #define __SERIAL_PORT_EXT_LIB_H__\r | |
| 27 | \r | |
| 28 | #include <Uefi/UefiBaseType.h>\r | |
| 29 | #include <Protocol/SerialIo.h>\r | |
| 30 | \r | |
| 31 | /**\r | |
| 32 | Set the serial device control bits.\r | |
| 33 | \r | |
| 34 | @return Always return EFI_UNSUPPORTED.\r | |
| 35 | \r | |
| 36 | **/\r | |
| 37 | RETURN_STATUS\r | |
| 38 | EFIAPI\r | |
| 39 | SerialPortSetControl (\r | |
| 40 | IN UINT32 Control\r | |
| 41 | );\r | |
| 42 | \r | |
| 43 | /**\r | |
| 44 | Get the serial device control bits.\r | |
| 45 | \r | |
| 46 | @param Control Control signals read from the serial device.\r | |
| 47 | \r | |
| 48 | @retval EFI_SUCCESS The control bits were read from the serial device.\r | |
| 49 | @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.\r | |
| 50 | \r | |
| 51 | **/\r | |
| 52 | RETURN_STATUS\r | |
| 53 | EFIAPI\r | |
| 54 | SerialPortGetControl (\r | |
| 55 | OUT UINT32 *Control\r | |
| 56 | );\r | |
| 57 | \r | |
| 58 | /**\r | |
| 59 | Set the serial device attributes.\r | |
| 60 | \r | |
| 61 | @return Always return EFI_UNSUPPORTED.\r | |
| 62 | \r | |
| 63 | **/\r | |
| 64 | RETURN_STATUS\r | |
| 65 | EFIAPI\r | |
| 66 | SerialPortSetAttributes (\r | |
| 15e277d5 | 67 | IN OUT UINT64 *BaudRate,\r |
| 68 | IN OUT UINT32 *ReceiveFifoDepth,\r | |
| 69 | IN OUT UINT32 *Timeout,\r | |
| 70 | IN OUT EFI_PARITY_TYPE *Parity,\r | |
| 71 | IN OUT UINT8 *DataBits,\r | |
| 72 | IN OUT EFI_STOP_BITS_TYPE *StopBits\r | |
| 1e57a462 | 73 | );\r |
| 74 | \r | |
| 75 | #endif\r | |
| 76 | \r |