123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198 |
- /** @file
- Serial I/O Port library implementation for the HDMI I2C Debug Port
- Copyright (c) 2022, Intel Corporation. All rights reserved.<BR>
- SPDX-License-Identifier: BSD-2-Clause-Patent
- **/
- #include <Base.h>
- #include <Library/BaseLib.h>
- #include <Library/SerialPortLib.h>
- #include <Library/PcdLib.h>
- #include <Library/TimerLib.h>
- #include <IgfxI2c.h>
- #include <I2cDebugPortProtocol.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
- )
- {
- 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 write operation failed.
- **/
- UINTN
- EFIAPI
- SerialPortWrite (
- IN UINT8 *Buffer,
- IN UINTN NumberOfBytes
- )
- {
- EFI_STATUS Status;
- /******************************************************/
- /* WARNING: The GPIOs Need to be programmed first. */
- /* Make sure HdmiDebugGpioInit() runs before */
- /* this function is called!!! */
- /******************************************************/
- if (Buffer == NULL) {
- return 0;
- }
- if (NumberOfBytes == 0) {
- return 0;
- }
- Status = I2cDebugPortWrite (Buffer, (UINT32) NumberOfBytes);
- if (EFI_ERROR (Status)) {
- return 0;
- } else {
- return NumberOfBytes;
- }
- }
- /**
- 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
- )
- {
- EFI_STATUS Status;
- UINT32 BytesRead;
- if (Buffer == NULL) {
- return 0;
- }
- if (NumberOfBytes == 0) {
- return 0;
- }
- BytesRead = (UINT32) NumberOfBytes;
- Status = I2cDebugPortRead (Buffer, &BytesRead);
- if (EFI_ERROR (Status)) {
- return 0;
- } else {
- return (UINTN) 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
- )
- {
- EFI_STATUS Status;
- UINT8 NumberOfBytesInFifoBuffer;
- Status = I2cDebugPortReadyToRead (&NumberOfBytesInFifoBuffer);
- if (EFI_ERROR (Status)) {
- return FALSE;
- }
- if (NumberOfBytesInFifoBuffer <= 0) {
- return FALSE;
- }
- return TRUE;
- }
- /**
- 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 time
- out 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
- vaule 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_SUCCESS The new attributes were set on the serial device.
- @retval RETURN_UNSUPPORTED The serial device does not support this operation.
- @retval RETURN_INVALID_PARAMETER One or more of the attributes has an unsupported value.
- @retval RETURN_DEVICE_ERROR The serial device is not functioning correctly.
- **/
- 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 EFI_UNSUPPORTED;
- }
|