summaryrefslogtreecommitdiff
path: root/ArmPlatformPkg/Library/NS16550SerialPortLib/NS16550SerialPortLib.c
blob: 61362b9855d0d217cce2a2231af69aa6aa8d5a3e (plain)
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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
/** @file
  Copyright (c) 2006 - 2008, Intel Corporation
  Copyright (c) 2018 Microsoft Corporation. All rights reserved.
  All rights reserved. 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.
**/

#include <Base.h>
#include <Library/BaseLib.h>
#include <Library/IoLib.h>
#include <Library/SerialPortLib.h>
#include "iMXUart.h"

/**
  Initialize the serial device hardware.
  If no initialization is required, then return RETURN_SUCCESS.
  If the serial device was successfully initialized, then return RETURN_SUCCESS.
  If the serial device could not be initialized, then return RETURN_DEVICE_ERROR.
  @retval RETURN_SUCCESS        The serial device was initialized.
  @retval RETURN_DEVICE_ERROR   The serial device could not be initialized.
**/
RETURN_STATUS
EFIAPI
SerialPortInitialize (
  VOID
  )
{
  MX6UART_REGISTERS   *UartBase;
  UINT32              Data;

  UartBase = (MX6UART_REGISTERS*)FixedPcdGet32 (PcdSerialRegisterBase);
  Data = MmioRead32 ((UINTN)&UartBase->Ucr1);
  if ((Data & MX6UART_UCR1_UARTEN) == 0) {
    // UART should have been initialized by previous boot stage
    return RETURN_DEVICE_ERROR;
  }

  return RETURN_SUCCESS;
}

/**
  Write data from buffer to serial device.
  Writes NumberOfBytes data bytes from Buffer to the serial device.
  The number of bytes actually written to the serial device is returned.
  If the return value is less than NumberOfBytes, then the write operation failed.
  If Buffer is NULL, then ASSERT().
  If NumberOfBytes is zero, then return 0.
  @param  Buffer           Pointer to the data buffer to be written.
  @param  NumberOfBytes    Number of bytes to written to the serial device.
  @retval 0                NumberOfBytes is 0.
  @retval >0               The number of bytes written to the serial device.
                           If this value is less than NumberOfBytes, then the
                           read operation failed.
**/
UINTN
EFIAPI
SerialPortWrite (
  IN  UINT8   *Buffer,
  IN  UINTN   NumberOfBytes
  )
{
  MX6UART_REGISTERS   *UartBase;
  UINTN               BytesSent;

  UartBase = (MX6UART_REGISTERS*)FixedPcdGet32 (PcdSerialRegisterBase);
  BytesSent = 0;
  while (BytesSent < NumberOfBytes) {
    // Check if FIFO is full and wait if it is.
    while ((MmioRead32 ((UINTN)&UartBase->Uts) & MX6UART_UTS_TXFULL) != 0);
    MmioWrite32 ((UINTN)&UartBase->Txd, Buffer[BytesSent]);
    BytesSent++;
  }

  return BytesSent;
}

/**
  Read data from serial device and save the datas in buffer.
  Reads NumberOfBytes data bytes from a serial device into the buffer
  specified by Buffer. The number of bytes actually read is returned.
  If the return value is less than NumberOfBytes, then the rest operation failed.
  If Buffer is NULL, then ASSERT().
  If NumberOfBytes is zero, then return 0.
  @param  Buffer            Pointer to the data buffer to store the data read
                            from the serial device.
  @param  NumberOfBytes     Number of bytes which will be read.
  @retval 0                 Read data failed, No data is to be read.
  @retval >0                Actual number of bytes read from serial device.
**/
UINTN
EFIAPI
SerialPortRead (
  OUT UINT8   *Buffer,
  IN  UINTN   NumberOfBytes
  )
{
  MX6UART_REGISTERS   *UartBase;
  UINTN               BytesRead;
  UINT32              Data;

  UartBase = (MX6UART_REGISTERS*)FixedPcdGet32 (PcdSerialRegisterBase);
  BytesRead = 0;
  while (BytesRead < NumberOfBytes) {
    Data = MmioRead32 ((UINTN)&UartBase->Rxd);
    if ((Data & MX6UART_RXD_CHARRDY) == 0) {
      break;
    }

    Buffer[BytesRead] = (UINT8) (Data & MX6UART_RXD_RX_DATA_MASK);
    BytesRead++;
  }

  return BytesRead;
}

/**
  Polls a serial device to see if there is any data waiting to be read.
  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.
  @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
SerialPortPoll (
  VOID
  )
{
  MX6UART_REGISTERS *UartBase;
  UINT32 Data;

  UartBase = (MX6UART_REGISTERS*)FixedPcdGet32 (PcdSerialRegisterBase);
  Data = MmioRead32 ((UINTN)&UartBase->Usr2);

  return (Data & MX6UART_USR2_RDR) != 0;
}

/**
  Sets the control bits on a serial device.
  @param Control                Sets the bits of Control that are settable.
  @retval RETURN_UNSUPPORTED    The serial device does not support this operation.
**/
RETURN_STATUS
EFIAPI
SerialPortSetControl (
  IN UINT32   Control
  )
{
  return RETURN_UNSUPPORTED;
}

/**
  Retrieve the status of the control bits on a serial device.
  @param Control                A pointer to return the current control signals
                                from the serial device.
  @retval RETURN_UNSUPPORTED    The serial device does not support this operation.
**/
RETURN_STATUS
EFIAPI
SerialPortGetControl (
  OUT UINT32  *Control
  )
{
  return RETURN_UNSUPPORTED;
}

/**
  Sets the baud rate, receive FIFO depth, transmit/receice time out, parity,
  data bits, and stop bits on a serial device.
  @param BaudRate           The requested baud rate. A BaudRate value of 0 will
                            use the device's default interface speed.
                            On output, the value actually set.
  @param ReveiveFifoDepth   The requested depth of the FIFO on the receive side
                            of the serial interface. A ReceiveFifoDepth value
                            of 0 will use the device's default FIFO depth.
                            On output, the value actually set.
  @param Timeout            The requested time out for a single character in
                            microseconds. This timeout applies to both the
                            transmit and receive side of the interface. A
                            Timeout value of 0 will use the device's default
                            timeout value.
                            On output, the value actually set.
  @param Parity             The type of parity to use on this serial device. A
                            Parity value of DefaultParity will use the device's
                            default parity value.
                            On output, the value actually set.
  @param DataBits           The number of data bits to use on the serial device.
                            A DataBits value of 0 will use the device's default
                            data bit setting.
                            On output, the value actually set.
  @param StopBits           The number of stop bits to use on this serial device.
                            A StopBits value of DefaultStopBits will use the
                            device's default number of stop bits.
                            On output, the value actually set.
  @retval RETURN_UNSUPPORTED        The serial device does not support this operation.
**/
RETURN_STATUS
EFIAPI
SerialPortSetAttributes (
  IN OUT UINT64             *BaudRate,
  IN OUT UINT32             *ReceiveFifoDepth,
  IN OUT UINT32             *Timeout,
  IN OUT EFI_PARITY_TYPE    *Parity,
  IN OUT UINT8              *DataBits,
  IN OUT EFI_STOP_BITS_TYPE *StopBits
  )
{
  return RETURN_UNSUPPORTED;
}