2 Serial IO Abstraction for GDB stub. This allows an EFI consoles that shows up on the system
3 running GDB. One console for error information and another console for user input/output.
5 Basic packet format is $packet-data#checksum. So every command has 4 bytes of overhead: $,
6 #, 0, 0. The 0 and 0 are the ascii characters for the checksum.
9 Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
11 This program and the accompanying materials
12 are licensed and made available under the terms and conditions of the BSD License
13 which accompanies this distribution. The full text of the license may be found at
14 http://opensource.org/licenses/bsd-license.php
16 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
17 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
22 #include <Library/UefiLib.h>
23 #include <Library/UefiBootServicesTableLib.h>
24 #include <Library/DebugLib.h>
25 #include <Library/SerialPortLib.h>
26 #include <Library/SerialPortExtLib.h>
27 #include <Library/PcdLib.h>
29 #include <Protocol/SerialIo.h>
32 VENDOR_DEVICE_PATH Guid
;
33 UART_DEVICE_PATH Uart
;
34 EFI_DEVICE_PATH_PROTOCOL End
;
35 } SIMPLE_TEXT_OUT_DEVICE_PATH
;
37 SIMPLE_TEXT_OUT_DEVICE_PATH mDevicePath
= {
39 { HARDWARE_DEVICE_PATH
, HW_VENDOR_DP
, sizeof (VENDOR_DEVICE_PATH
), 0},
40 EFI_CALLER_ID_GUID
// Use the drivers GUID
43 { MESSAGING_DEVICE_PATH
, MSG_UART_DP
, sizeof (UART_DEVICE_PATH
), 0},
45 FixedPcdGet64 (PcdUartDefaultBaudRate
), // BaudRate
46 FixedPcdGet8 (PcdUartDefaultDataBits
), // DataBits
47 FixedPcdGet8 (PcdUartDefaultParity
), // Parity (N)
48 FixedPcdGet8 (PcdUartDefaultStopBits
) // StopBits
50 { END_DEVICE_PATH_TYPE
, END_ENTIRE_DEVICE_PATH_SUBTYPE
, sizeof (EFI_DEVICE_PATH_PROTOCOL
), 0}
53 EFI_HANDLE gHandle
= NULL
;
56 Reset the serial device.
58 @param This Protocol instance pointer.
60 @retval EFI_SUCCESS The device was reset.
61 @retval EFI_DEVICE_ERROR The serial device could not be reset.
67 IN EFI_SERIAL_IO_PROTOCOL
*This
73 Status
= SerialPortInitialize ();
74 if (EFI_ERROR(Status
)) {
79 // Set the Serial I/O mode and update the device path
82 Tpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
85 // Set the Serial I/O mode
87 This
->Mode
->ReceiveFifoDepth
= 0;
88 This
->Mode
->Timeout
= 1000000;
89 This
->Mode
->BaudRate
= PcdGet64 (PcdUartDefaultBaudRate
);
90 This
->Mode
->DataBits
= (UINT32
)PcdGet8 (PcdUartDefaultDataBits
);
91 This
->Mode
->Parity
= (UINT32
)PcdGet8 (PcdUartDefaultParity
);
92 This
->Mode
->StopBits
= (UINT32
)PcdGet8 (PcdUartDefaultStopBits
);
95 // Check if the device path has actually changed
97 if (mDevicePath
.Uart
.BaudRate
== This
->Mode
->BaudRate
&&
98 mDevicePath
.Uart
.DataBits
== (UINT8
)This
->Mode
->DataBits
&&
99 mDevicePath
.Uart
.Parity
== (UINT8
)This
->Mode
->Parity
&&
100 mDevicePath
.Uart
.StopBits
== (UINT8
)This
->Mode
->StopBits
102 gBS
->RestoreTPL (Tpl
);
107 // Update the device path
109 mDevicePath
.Uart
.BaudRate
= This
->Mode
->BaudRate
;
110 mDevicePath
.Uart
.DataBits
= (UINT8
)This
->Mode
->DataBits
;
111 mDevicePath
.Uart
.Parity
= (UINT8
)This
->Mode
->Parity
;
112 mDevicePath
.Uart
.StopBits
= (UINT8
)This
->Mode
->StopBits
;
114 Status
= gBS
->ReinstallProtocolInterface (
116 &gEfiDevicePathProtocolGuid
,
121 gBS
->RestoreTPL (Tpl
);
128 Sets the baud rate, receive FIFO depth, transmit/receive time out, parity,
129 data buts, and stop bits on a serial device.
131 @param This Protocol instance pointer.
132 @param BaudRate The requested baud rate. A BaudRate value of 0 will use the the
133 device's default interface speed.
134 @param ReceiveFifoDepth The requested depth of the FIFO on the receive side of the
135 serial interface. A ReceiveFifoDepth value of 0 will use
136 the device's default FIFO depth.
137 @param Timeout The requested time out for a single character in microseconds.
138 This timeout applies to both the transmit and receive side of the
139 interface. A Timeout value of 0 will use the device's default time
141 @param Parity The type of parity to use on this serial device. A Parity value of
142 DefaultParity will use the device's default parity value.
143 @param DataBits The number of data bits to use on the serial device. A DataBits
144 value of 0 will use the device's default data bit setting.
145 @param StopBits The number of stop bits to use on this serial device. A StopBits
146 value of DefaultStopBits will use the device's default number of
149 @retval EFI_SUCCESS The device was reset.
150 @retval EFI_DEVICE_ERROR The serial device could not be reset.
155 SerialSetAttributes (
156 IN EFI_SERIAL_IO_PROTOCOL
*This
,
158 IN UINT32 ReceiveFifoDepth
,
160 IN EFI_PARITY_TYPE Parity
,
162 IN EFI_STOP_BITS_TYPE StopBits
168 Status
= SerialPortSetAttributes (BaudRate
, ReceiveFifoDepth
, Timeout
, Parity
, DataBits
, StopBits
);
169 if (EFI_ERROR(Status
)) {
174 // Set the Serial I/O mode and update the device path
177 Tpl
= gBS
->RaiseTPL (TPL_NOTIFY
);
180 // Set the Serial I/O mode
182 This
->Mode
->BaudRate
= BaudRate
;
183 This
->Mode
->ReceiveFifoDepth
= ReceiveFifoDepth
;
184 This
->Mode
->Timeout
= Timeout
;
185 This
->Mode
->Parity
= (UINT32
)Parity
;
186 This
->Mode
->DataBits
= (UINT32
)DataBits
;
187 This
->Mode
->StopBits
= (UINT32
)StopBits
;
190 // Check if the device path has actually changed
192 if (mDevicePath
.Uart
.BaudRate
== BaudRate
&&
193 mDevicePath
.Uart
.Parity
== (UINT8
)Parity
&&
194 mDevicePath
.Uart
.DataBits
== DataBits
&&
195 mDevicePath
.Uart
.StopBits
== (UINT8
)StopBits
197 gBS
->RestoreTPL (Tpl
);
202 // Update the device path
204 mDevicePath
.Uart
.BaudRate
= BaudRate
;
205 mDevicePath
.Uart
.DataBits
= DataBits
;
206 mDevicePath
.Uart
.Parity
= (UINT8
) Parity
;
207 mDevicePath
.Uart
.StopBits
= (UINT8
) StopBits
;
209 Status
= gBS
->ReinstallProtocolInterface (
211 &gEfiDevicePathProtocolGuid
,
216 gBS
->RestoreTPL (Tpl
);
223 Set the control bits on a serial device
225 @param This Protocol instance pointer.
226 @param Control Set the bits of Control that are settable.
228 @retval EFI_SUCCESS The new control bits were set on the serial device.
229 @retval EFI_UNSUPPORTED The serial device does not support this operation.
230 @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
236 IN EFI_SERIAL_IO_PROTOCOL
*This
,
240 return SerialPortSetControl(Control
);
245 Retrieves the status of the control bits on a serial device
247 @param This Protocol instance pointer.
248 @param Control A pointer to return the current Control signals from the serial device.
250 @retval EFI_SUCCESS The control bits were read from the serial device.
251 @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
257 IN EFI_SERIAL_IO_PROTOCOL
*This
,
261 return SerialPortGetControl(Control
);
266 Writes data to a serial device.
268 @param This Protocol instance pointer.
269 @param BufferSize On input, the size of the Buffer. On output, the amount of
270 data actually written.
271 @param Buffer The buffer of data to write
273 @retval EFI_SUCCESS The data was written.
274 @retval EFI_DEVICE_ERROR The device reported an error.
275 @retval EFI_TIMEOUT The data write was stopped due to a timeout.
281 IN EFI_SERIAL_IO_PROTOCOL
*This
,
282 IN OUT UINTN
*BufferSize
,
288 Count
= SerialPortWrite (Buffer
, *BufferSize
);
290 if (Count
!= *BufferSize
) {
299 Reads data from a serial device.
301 @param This Protocol instance pointer.
302 @param BufferSize On input, the size of the Buffer. On output, the amount of
303 data returned in Buffer.
304 @param Buffer The buffer to return the data into.
306 @retval EFI_SUCCESS The data was read.
307 @retval EFI_DEVICE_ERROR The device reported an error.
308 @retval EFI_TIMEOUT The data write was stopped due to a timeout.
315 IN EFI_SERIAL_IO_PROTOCOL
*This
,
316 IN OUT UINTN
*BufferSize
,
322 if (SerialPortPoll()) {
323 Count
= SerialPortRead (Buffer
, *BufferSize
);
326 if (Count
!= *BufferSize
) {
335 // Template used to initialize the GDB Serial IO protocols
337 EFI_SERIAL_IO_MODE gSerialIoMode
= {
340 FixedPcdGet64 (PcdUartDefaultBaudRate
), // BaudRate
341 1, // ReceiveFifoDepth
342 FixedPcdGet8 (PcdUartDefaultDataBits
), // DataBits
343 FixedPcdGet8 (PcdUartDefaultParity
), // Parity
344 FixedPcdGet8 (PcdUartDefaultStopBits
) // StopBits
348 EFI_SERIAL_IO_PROTOCOL gSerialIoTemplate
= {
349 SERIAL_IO_INTERFACE_REVISION
,
360 Initialize the state information for the Serial Io Protocol
362 @param ImageHandle of the loaded driver
363 @param SystemTable Pointer to the System Table
365 @retval EFI_SUCCESS Protocol registered
366 @retval EFI_OUT_OF_RESOURCES Cannot allocate protocol data structure
367 @retval EFI_DEVICE_ERROR Hardware problems
372 SerialDxeInitialize (
373 IN EFI_HANDLE ImageHandle
,
374 IN EFI_SYSTEM_TABLE
*SystemTable
379 // Make a new handle with Serial IO protocol and its device path on it.
380 Status
= gBS
->InstallMultipleProtocolInterfaces (
382 &gEfiSerialIoProtocolGuid
, &gSerialIoTemplate
,
383 &gEfiDevicePathProtocolGuid
, &mDevicePath
,
386 ASSERT_EFI_ERROR (Status
);