1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
/** @file
Header file for PCH Serial IO UART Lib implementation.
Copyright (c) 2014 - 2016, Intel Corporation. All rights reserved.<BR>
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
http://opensource.org/licenses/bsd-license.php.
THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
**/
#ifndef _PCH_SERIAL_IO_UART_LIB_H_
#define _PCH_SERIAL_IO_UART_LIB_H_
/**
Initialize selected SerialIo UART.
This init function MUST be used prior any SerialIo UART functions to init serial io controller if platform is going use serialio UART as debug output.
@param[in] UartNumber Selects Serial IO UART device (0-2)
@param[in] FifoEnable When TRUE, enables 64-byte FIFOs.
@param[in] BaudRate Baud rate.
@param[in] LineControl Data length, parity, stop bits.
@param[in] HardwareFlowControl Automated hardware flow control. If TRUE, hardware automatically checks CTS when sending data, and sets RTS when receiving data.
@retval BOOLEAN Initilization succeeded.
**/
BOOLEAN
EFIAPI
PchSerialIoUartInit (
IN UINT8 UartNumber,
IN BOOLEAN FifoEnable,
IN UINT32 BaudRate,
IN UINT8 LineControl,
IN BOOLEAN HardwareFlowControl
);
/**
Write data to serial device.
If the buffer is NULL, then return 0;
if NumberOfBytes is zero, then return 0.
@param[in] UartNumber Selects Serial IO UART device (0-2)
@param[in] Buffer Point of data buffer which need to be writed.
@param[in] NumberOfBytes Number of output bytes which are cached in Buffer.
@retval UINTN Actual number of bytes writed to serial device.
**/
UINTN
EFIAPI
PchSerialIoUartOut (
IN UINT8 UartNumber,
IN UINT8 *Buffer,
IN UINTN NumberOfBytes
);
/**
Read data from serial device and save the datas in buffer.
If the buffer is NULL, then return 0;
if NumberOfBytes is zero, then return 0.
@param[in] UartNumber Selects Serial IO UART device (0-2)
@param[out] Buffer Point of data buffer which need to be writed.
@param[in] NumberOfBytes Number of output bytes which are cached in Buffer.
@param[in] WaitUntilBufferFull When TRUE, function waits until whole buffer is filled. When FALSE,
function returns as soon as no new characters are available.
@retval UINTN Actual number of bytes raed to serial device.
**/
UINTN
EFIAPI
PchSerialIoUartIn (
IN UINT8 UartNumber,
OUT UINT8 *Buffer,
IN UINTN NumberOfBytes,
IN BOOLEAN WaitUntilBufferFull
);
/**
Polls a serial device to see if there is any data waiting to be read.
If there is data waiting to be read from the serial device, then TRUE is returned.
If there is no data waiting to be read from the serial device, then FALSE is returned.
@param[in] UartNumber Selects Serial IO UART device (0-2)
@retval TRUE Data is waiting to be read from the serial device.
@retval FALSE There is no data waiting to be read from the serial device.
**/
BOOLEAN
EFIAPI
PchSerialIoUartPoll (
IN UINT8 UartNumber
);
#endif // _PEI_DXE_SMM_PCH_SERIAL_IO_UART_LIB_H_
|
