40ab42ddca
Signed-off-by: Olivier Martin <olivier.martin@arm.com> git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13255 6f19259b-4bc3-4df7-8a09-765794883524
289 lines
8.8 KiB
C
289 lines
8.8 KiB
C
/** @file
|
|
Serial IO Abstraction for GDB stub. This allows an EFI consoles that shows up on the system
|
|
running GDB. One console for error information and another console for user input/output.
|
|
|
|
Basic packet format is $packet-data#checksum. So every command has 4 bytes of overhead: $,
|
|
#, 0, 0. The 0 and 0 are the ascii characters for the checksum.
|
|
|
|
|
|
Copyright (c) 2008 - 2009, Apple Inc. 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.
|
|
|
|
**/
|
|
|
|
#include <PiDxe.h>
|
|
#include <Library/UefiLib.h>
|
|
#include <Library/UefiBootServicesTableLib.h>
|
|
#include <Library/DebugLib.h>
|
|
#include <Library/SerialPortLib.h>
|
|
#include <Library/PcdLib.h>
|
|
|
|
#include <Protocol/SerialIo.h>
|
|
|
|
/**
|
|
Reset the serial device.
|
|
|
|
@param This Protocol instance pointer.
|
|
|
|
@retval EFI_SUCCESS The device was reset.
|
|
@retval EFI_DEVICE_ERROR The serial device could not be reset.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SerialReset (
|
|
IN EFI_SERIAL_IO_PROTOCOL *This
|
|
)
|
|
{
|
|
SerialPortInitialize ();
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
|
|
/**
|
|
Sets the baud rate, receive FIFO depth, transmit/receive time out, parity,
|
|
data buts, and stop bits on a serial device.
|
|
|
|
@param This Protocol instance pointer.
|
|
@param BaudRate The requested baud rate. A BaudRate value of 0 will use the the
|
|
device's default interface speed.
|
|
@param ReceiveFifoDepth 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.
|
|
@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 time
|
|
out value.
|
|
@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.
|
|
@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.
|
|
@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.
|
|
|
|
@retval EFI_SUCCESS The device was reset.
|
|
@retval EFI_DEVICE_ERROR The serial device could not be reset.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SerialSetAttributes (
|
|
IN EFI_SERIAL_IO_PROTOCOL *This,
|
|
IN UINT64 BaudRate,
|
|
IN UINT32 ReceiveFifoDepth,
|
|
IN UINT32 Timeout,
|
|
IN EFI_PARITY_TYPE Parity,
|
|
IN UINT8 DataBits,
|
|
IN EFI_STOP_BITS_TYPE StopBits
|
|
)
|
|
{
|
|
return EFI_UNSUPPORTED;
|
|
}
|
|
|
|
|
|
/**
|
|
Set the control bits on a serial device
|
|
|
|
@param This Protocol instance pointer.
|
|
@param Control Set the bits of Control that are settable.
|
|
|
|
@retval EFI_SUCCESS The new control bits were set on the serial device.
|
|
@retval EFI_UNSUPPORTED The serial device does not support this operation.
|
|
@retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SerialSetControl (
|
|
IN EFI_SERIAL_IO_PROTOCOL *This,
|
|
IN UINT32 Control
|
|
)
|
|
{
|
|
return EFI_UNSUPPORTED;
|
|
}
|
|
|
|
|
|
/**
|
|
Retrieves the status of the control bits on a serial device
|
|
|
|
@param This Protocol instance pointer.
|
|
@param Control A pointer to return the current Control signals from the serial device.
|
|
|
|
@retval EFI_SUCCESS The control bits were read from the serial device.
|
|
@retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SerialGetControl (
|
|
IN EFI_SERIAL_IO_PROTOCOL *This,
|
|
OUT UINT32 *Control
|
|
)
|
|
{
|
|
if (SerialPortPoll ()) {
|
|
// If a character is pending don't set EFI_SERIAL_INPUT_BUFFER_EMPTY
|
|
*Control = EFI_SERIAL_OUTPUT_BUFFER_EMPTY;
|
|
} else {
|
|
*Control = EFI_SERIAL_INPUT_BUFFER_EMPTY | EFI_SERIAL_OUTPUT_BUFFER_EMPTY;
|
|
}
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
|
|
/**
|
|
Writes data to a serial device.
|
|
|
|
@param This Protocol instance pointer.
|
|
@param BufferSize On input, the size of the Buffer. On output, the amount of
|
|
data actually written.
|
|
@param Buffer The buffer of data to write
|
|
|
|
@retval EFI_SUCCESS The data was written.
|
|
@retval EFI_DEVICE_ERROR The device reported an error.
|
|
@retval EFI_TIMEOUT The data write was stopped due to a timeout.
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SerialWrite (
|
|
IN EFI_SERIAL_IO_PROTOCOL *This,
|
|
IN OUT UINTN *BufferSize,
|
|
IN VOID *Buffer
|
|
)
|
|
{
|
|
UINTN Count;
|
|
|
|
Count = SerialPortWrite (Buffer, *BufferSize);
|
|
*BufferSize = Count;
|
|
return (Count == 0) ? EFI_DEVICE_ERROR : EFI_SUCCESS;
|
|
}
|
|
|
|
/**
|
|
Reads data from a serial device.
|
|
|
|
@param This Protocol instance pointer.
|
|
@param BufferSize On input, the size of the Buffer. On output, the amount of
|
|
data returned in Buffer.
|
|
@param Buffer The buffer to return the data into.
|
|
|
|
@retval EFI_SUCCESS The data was read.
|
|
@retval EFI_DEVICE_ERROR The device reported an error.
|
|
@retval EFI_TIMEOUT The data write was stopped due to a timeout.
|
|
|
|
**/
|
|
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SerialRead (
|
|
IN EFI_SERIAL_IO_PROTOCOL *This,
|
|
IN OUT UINTN *BufferSize,
|
|
OUT VOID *Buffer
|
|
)
|
|
{
|
|
UINTN Count = 0;
|
|
|
|
if (SerialPortPoll()) {
|
|
Count = SerialPortRead (Buffer, *BufferSize);
|
|
}
|
|
|
|
if (Count != *BufferSize) {
|
|
*BufferSize = Count;
|
|
return EFI_TIMEOUT;
|
|
}
|
|
|
|
return EFI_SUCCESS;
|
|
}
|
|
|
|
|
|
EFI_HANDLE gHandle = NULL;
|
|
|
|
//
|
|
// Template used to initialize the GDB Serial IO protocols
|
|
//
|
|
EFI_SERIAL_IO_MODE gSerialIoMode = {
|
|
0, // ControlMask
|
|
0, // Timeout
|
|
FixedPcdGet64 (PcdUartDefaultBaudRate), // BaudRate
|
|
1, // ReceiveFifoDepth
|
|
FixedPcdGet8 (PcdUartDefaultDataBits), // DataBits
|
|
FixedPcdGet8 (PcdUartDefaultParity), // Parity
|
|
FixedPcdGet8 (PcdUartDefaultStopBits) // StopBits
|
|
};
|
|
|
|
|
|
EFI_SERIAL_IO_PROTOCOL gSerialIoTemplate = {
|
|
SERIAL_IO_INTERFACE_REVISION,
|
|
SerialReset,
|
|
SerialSetAttributes,
|
|
SerialSetControl,
|
|
SerialGetControl,
|
|
SerialWrite,
|
|
SerialRead,
|
|
&gSerialIoMode
|
|
};
|
|
|
|
typedef struct {
|
|
VENDOR_DEVICE_PATH Guid;
|
|
UART_DEVICE_PATH Uart;
|
|
EFI_DEVICE_PATH_PROTOCOL End;
|
|
} SIMPLE_TEXT_OUT_DEVICE_PATH;
|
|
|
|
SIMPLE_TEXT_OUT_DEVICE_PATH mDevicePath = {
|
|
{
|
|
{ HARDWARE_DEVICE_PATH, HW_VENDOR_DP, sizeof (VENDOR_DEVICE_PATH), 0},
|
|
EFI_CALLER_ID_GUID // Use the drivers GUID
|
|
},
|
|
{
|
|
{ MESSAGING_DEVICE_PATH, MSG_UART_DP, sizeof (UART_DEVICE_PATH), 0},
|
|
0, // Reserved
|
|
FixedPcdGet64 (PcdUartDefaultBaudRate), // BaudRate
|
|
FixedPcdGet8 (PcdUartDefaultDataBits), // DataBits
|
|
FixedPcdGet8 (PcdUartDefaultParity), // Parity (N)
|
|
FixedPcdGet8 (PcdUartDefaultStopBits) // StopBits
|
|
},
|
|
{ END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE, sizeof (EFI_DEVICE_PATH_PROTOCOL), 0}
|
|
};
|
|
|
|
|
|
/**
|
|
Initialize the state information for the Serial Io Protocol
|
|
|
|
@param ImageHandle of the loaded driver
|
|
@param SystemTable Pointer to the System Table
|
|
|
|
@retval EFI_SUCCESS Protocol registered
|
|
@retval EFI_OUT_OF_RESOURCES Cannot allocate protocol data structure
|
|
@retval EFI_DEVICE_ERROR Hardware problems
|
|
|
|
**/
|
|
EFI_STATUS
|
|
EFIAPI
|
|
SerialDxeInitialize (
|
|
IN EFI_HANDLE ImageHandle,
|
|
IN EFI_SYSTEM_TABLE *SystemTable
|
|
)
|
|
{
|
|
EFI_STATUS Status;
|
|
|
|
|
|
// Make a new handle with Serial IO protocol and its device path on it.
|
|
Status = gBS->InstallMultipleProtocolInterfaces (
|
|
&gHandle,
|
|
&gEfiSerialIoProtocolGuid, &gSerialIoTemplate,
|
|
&gEfiDevicePathProtocolGuid, &mDevicePath,
|
|
NULL
|
|
);
|
|
ASSERT_EFI_ERROR (Status);
|
|
|
|
return Status;
|
|
}
|
|
|