MdeModulePkg/Universal/SerialDxe/SerialIo.c

   1 /** @file
   2   Serial driver that layers on top of a Serial Port Library instance.
   3
   4   Copyright (c) 2008 - 2009, Apple Inc. All rights reserved.<BR>
   5   Copyright (c) 2013-2014, ARM Ltd. All rights reserved.<BR>
   6   Copyright (c) 2015, Intel Corporation. All rights reserved.<BR>
   7
   8   This program and the accompanying materials
   9   are licensed and made available under the terms and conditions of the BSD License
  10   which accompanies this distribution.  The full text of the license may be found at
  11   http://opensource.org/licenses/bsd-license.php
  12
  13   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  14   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  15
  16 **/
  17
  18 #include <Library/UefiBootServicesTableLib.h>
  19 #include <Library/SerialPortLib.h>
  20 #include <Library/DebugLib.h>
  21 #include <Library/PcdLib.h>
  22
  23 #include <Protocol/SerialIo.h>
  24 #include <Protocol/DevicePath.h>
  25
  26 typedef struct {
  27   VENDOR_DEVICE_PATH        Guid;
  28   UART_DEVICE_PATH          Uart;
  29   EFI_DEVICE_PATH_PROTOCOL  End;
  30 } SERIAL_DEVICE_PATH;
  31
  32 /**
  33   Reset the serial device.
  34
  35   @param  This              Protocol instance pointer.
  36
  37   @retval EFI_SUCCESS       The device was reset.
  38   @retval EFI_DEVICE_ERROR  The serial device could not be reset.
  39
  40 **/
  41 EFI_STATUS
  42 EFIAPI
  43 SerialReset (
  44   IN EFI_SERIAL_IO_PROTOCOL *This
  45   );
  46
  47 /**
  48   Sets the baud rate, receive FIFO depth, transmit/receive time out, parity,
  49   data bits, and stop bits on a serial device.
  50
  51   @param  This             Protocol instance pointer.
  52   @param  BaudRate         The requested baud rate. A BaudRate value of 0 will use the the
  53                            device's default interface speed.
  54   @param  ReceiveFifoDepth The requested depth of the FIFO on the receive side of the
  55                            serial interface. A ReceiveFifoDepth value of 0 will use
  56                            the device's default FIFO depth.
  57   @param  Timeout          The requested time out for a single character in microseconds.
  58                            This timeout applies to both the transmit and receive side of the
  59                            interface. A Timeout value of 0 will use the device's default time
  60                            out value.
  61   @param  Parity           The type of parity to use on this serial device. A Parity value of
  62                            DefaultParity will use the device's default parity value.
  63   @param  DataBits         The number of data bits to use on the serial device. A DataBits
  64                            value of 0 will use the device's default data bit setting.
  65   @param  StopBits         The number of stop bits to use on this serial device. A StopBits
  66                            value of DefaultStopBits will use the device's default number of
  67                            stop bits.
  68
  69   @retval EFI_SUCCESS      The device was reset.
  70   @retval EFI_DEVICE_ERROR The serial device could not be reset.
  71
  72 **/
  73 EFI_STATUS
  74 EFIAPI
  75 SerialSetAttributes (
  76   IN EFI_SERIAL_IO_PROTOCOL *This,
  77   IN UINT64                 BaudRate,
  78   IN UINT32                 ReceiveFifoDepth,
  79   IN UINT32                 Timeout,
  80   IN EFI_PARITY_TYPE        Parity,
  81   IN UINT8                  DataBits,
  82   IN EFI_STOP_BITS_TYPE     StopBits
  83   );
  84
  85 /**
  86   Set the control bits on a serial device
  87
  88   @param  This             Protocol instance pointer.
  89   @param  Control          Set the bits of Control that are settable.
  90
  91   @retval EFI_SUCCESS      The new control bits were set on the serial device.
  92   @retval EFI_UNSUPPORTED  The serial device does not support this operation.
  93   @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
  94
  95 **/
  96 EFI_STATUS
  97 EFIAPI
  98 SerialSetControl (
  99   IN EFI_SERIAL_IO_PROTOCOL *This,
 100   IN UINT32                 Control
 101   );
 102
 103 /**
 104   Retrieves the status of the control bits on a serial device
 105
 106   @param  This              Protocol instance pointer.
 107   @param  Control           A pointer to return the current Control signals from the serial device.
 108
 109   @retval EFI_SUCCESS       The control bits were read from the serial device.
 110   @retval EFI_DEVICE_ERROR  The serial device is not functioning correctly.
 111
 112 **/
 113 EFI_STATUS
 114 EFIAPI
 115 SerialGetControl (
 116   IN EFI_SERIAL_IO_PROTOCOL *This,
 117   OUT UINT32                *Control
 118   );
 119
 120 /**
 121   Writes data to a serial device.
 122
 123   @param  This              Protocol instance pointer.
 124   @param  BufferSize        On input, the size of the Buffer. On output, the amount of
 125                             data actually written.
 126   @param  Buffer            The buffer of data to write
 127
 128   @retval EFI_SUCCESS       The data was written.
 129   @retval EFI_DEVICE_ERROR  The device reported an error.
 130   @retval EFI_TIMEOUT       The data write was stopped due to a timeout.
 131
 132 **/
 133 EFI_STATUS
 134 EFIAPI
 135 SerialWrite (
 136   IN EFI_SERIAL_IO_PROTOCOL *This,
 137   IN OUT UINTN              *BufferSize,
 138   IN VOID                   *Buffer
 139   );
 140
 141 /**
 142   Reads data from a serial device.
 143
 144   @param  This              Protocol instance pointer.
 145   @param  BufferSize        On input, the size of the Buffer. On output, the amount of
 146                             data returned in Buffer.
 147   @param  Buffer            The buffer to return the data into.
 148
 149   @retval EFI_SUCCESS       The data was read.
 150   @retval EFI_DEVICE_ERROR  The device reported an error.
 151   @retval EFI_TIMEOUT       The data write was stopped due to a timeout.
 152
 153 **/
 154 EFI_STATUS
 155 EFIAPI
 156 SerialRead (
 157   IN EFI_SERIAL_IO_PROTOCOL *This,
 158   IN OUT UINTN              *BufferSize,
 159   OUT VOID                  *Buffer
 160   );
 161
 162 EFI_HANDLE mSerialHandle = NULL;
 163
 164 SERIAL_DEVICE_PATH mSerialDevicePath = {
 165   {
 166     { HARDWARE_DEVICE_PATH, HW_VENDOR_DP, { sizeof (VENDOR_DEVICE_PATH), 0} },
 167     EFI_CALLER_ID_GUID  // Use the driver's GUID
 168   },
 169   {
 170     { MESSAGING_DEVICE_PATH, MSG_UART_DP, { sizeof (UART_DEVICE_PATH), 0} },
 171     0,                  // Reserved
 172     0,                  // BaudRate
 173     0,                  // DataBits
 174     0,                  // Parity
 175     0                   // StopBits
 176   },
 177   { END_DEVICE_PATH_TYPE, END_ENTIRE_DEVICE_PATH_SUBTYPE, { sizeof (EFI_DEVICE_PATH_PROTOCOL), 0 } }
 178 };
 179
 180 //
 181 // Template used to initialize the Serial IO protocols.
 182 //
 183 EFI_SERIAL_IO_MODE mSerialIoMode = {
 184   //
 185   //    value  field                set in SerialDxeInitialize()?
 186   //---------  -------------------  -----------------------------
 187             0, // ControlMask
 188   1000 * 1000, // Timeout
 189             0, // BaudRate          yes
 190             1, // ReceiveFifoDepth
 191             0, // DataBits          yes
 192             0, // Parity            yes
 193             0  // StopBits          yes
 194 };
 195
 196 EFI_SERIAL_IO_PROTOCOL mSerialIoTemplate = {
 197   SERIAL_IO_INTERFACE_REVISION,
 198   SerialReset,
 199   SerialSetAttributes,
 200   SerialSetControl,
 201   SerialGetControl,
 202   SerialWrite,
 203   SerialRead,
 204   &mSerialIoMode
 205 };
 206
 207 /**
 208   Reset the serial device.
 209
 210   @param  This              Protocol instance pointer.
 211
 212   @retval EFI_SUCCESS       The device was reset.
 213   @retval EFI_DEVICE_ERROR  The serial device could not be reset.
 214
 215 **/
 216 EFI_STATUS
 217 EFIAPI
 218 SerialReset (
 219   IN EFI_SERIAL_IO_PROTOCOL *This
 220   )
 221 {
 222   EFI_STATUS    Status;
 223
 224   Status = SerialPortInitialize ();
 225   if (EFI_ERROR (Status)) {
 226     return Status;
 227   }
 228
 229   //
 230   // Go set the current attributes
 231   //
 232   Status = This->SetAttributes (
 233                    This,
 234                    This->Mode->BaudRate,
 235                    This->Mode->ReceiveFifoDepth,
 236                    This->Mode->Timeout,
 237                    (EFI_PARITY_TYPE) This->Mode->Parity,
 238                    (UINT8) This->Mode->DataBits,
 239                    (EFI_STOP_BITS_TYPE) This->Mode->StopBits
 240                    );
 241
 242   return Status;
 243 }
 244
 245 /**
 246   Sets the baud rate, receive FIFO depth, transmit/receive time out, parity,
 247   data bits, and stop bits on a serial device.
 248
 249   @param  This             Protocol instance pointer.
 250   @param  BaudRate         The requested baud rate. A BaudRate value of 0 will use the the
 251                            device's default interface speed.
 252   @param  ReceiveFifoDepth The requested depth of the FIFO on the receive side of the
 253                            serial interface. A ReceiveFifoDepth value of 0 will use
 254                            the device's default FIFO depth.
 255   @param  Timeout          The requested time out for a single character in microseconds.
 256                            This timeout applies to both the transmit and receive side of the
 257                            interface. A Timeout value of 0 will use the device's default time
 258                            out value.
 259   @param  Parity           The type of parity to use on this serial device. A Parity value of
 260                            DefaultParity will use the device's default parity value.
 261   @param  DataBits         The number of data bits to use on the serial device. A DataBits
 262                            value of 0 will use the device's default data bit setting.
 263   @param  StopBits         The number of stop bits to use on this serial device. A StopBits
 264                            value of DefaultStopBits will use the device's default number of
 265                            stop bits.
 266
 267   @retval EFI_SUCCESS      The device was reset.
 268   @retval EFI_DEVICE_ERROR The serial device could not be reset.
 269
 270 **/
 271 EFI_STATUS
 272 EFIAPI
 273 SerialSetAttributes (
 274   IN EFI_SERIAL_IO_PROTOCOL *This,
 275   IN UINT64                 BaudRate,
 276   IN UINT32                 ReceiveFifoDepth,
 277   IN UINT32                 Timeout,
 278   IN EFI_PARITY_TYPE        Parity,
 279   IN UINT8                  DataBits,
 280   IN EFI_STOP_BITS_TYPE     StopBits
 281   )
 282 {
 283   EFI_STATUS    Status;
 284   EFI_TPL       Tpl;
 285
 286   Status = SerialPortSetAttributes (&BaudRate, &ReceiveFifoDepth, &Timeout, &Parity, &DataBits, &StopBits);
 287   if (EFI_ERROR (Status)) {
 288     return Status;
 289   }
 290
 291   //
 292   // Set the Serial I/O mode and update the device path
 293   //
 294
 295   Tpl = gBS->RaiseTPL (TPL_NOTIFY);
 296
 297   //
 298   // Set the Serial I/O mode
 299   //
 300   This->Mode->ReceiveFifoDepth  = ReceiveFifoDepth;
 301   This->Mode->Timeout           = Timeout;
 302   This->Mode->BaudRate          = BaudRate;
 303   This->Mode->DataBits          = (UINT32) DataBits;
 304   This->Mode->Parity            = (UINT32) Parity;
 305   This->Mode->StopBits          = (UINT32) StopBits;
 306
 307   //
 308   // Check if the device path has actually changed
 309   //
 310   if (mSerialDevicePath.Uart.BaudRate == BaudRate &&
 311       mSerialDevicePath.Uart.DataBits == DataBits &&
 312       mSerialDevicePath.Uart.Parity   == (UINT8) Parity &&
 313       mSerialDevicePath.Uart.StopBits == (UINT8) StopBits
 314      ) {
 315     gBS->RestoreTPL (Tpl);
 316     return EFI_SUCCESS;
 317   }
 318
 319   //
 320   // Update the device path
 321   //
 322   mSerialDevicePath.Uart.BaudRate = BaudRate;
 323   mSerialDevicePath.Uart.DataBits = DataBits;
 324   mSerialDevicePath.Uart.Parity   = (UINT8) Parity;
 325   mSerialDevicePath.Uart.StopBits = (UINT8) StopBits;
 326
 327   Status = gBS->ReinstallProtocolInterface (
 328                   mSerialHandle,
 329                   &gEfiDevicePathProtocolGuid,
 330                   &mSerialDevicePath,
 331                   &mSerialDevicePath
 332                   );
 333
 334   gBS->RestoreTPL (Tpl);
 335
 336   return Status;
 337 }
 338
 339 /**
 340   Set the control bits on a serial device
 341
 342   @param  This             Protocol instance pointer.
 343   @param  Control          Set the bits of Control that are settable.
 344
 345   @retval EFI_SUCCESS      The new control bits were set on the serial device.
 346   @retval EFI_UNSUPPORTED  The serial device does not support this operation.
 347   @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
 348
 349 **/
 350 EFI_STATUS
 351 EFIAPI
 352 SerialSetControl (
 353   IN EFI_SERIAL_IO_PROTOCOL *This,
 354   IN UINT32                 Control
 355   )
 356 {
 357   return SerialPortSetControl (Control);
 358 }
 359
 360 /**
 361   Retrieves the status of the control bits on a serial device
 362
 363   @param  This              Protocol instance pointer.
 364   @param  Control           A pointer to return the current Control signals from the serial device.
 365
 366   @retval EFI_SUCCESS       The control bits were read from the serial device.
 367   @retval EFI_DEVICE_ERROR  The serial device is not functioning correctly.
 368
 369 **/
 370 EFI_STATUS
 371 EFIAPI
 372 SerialGetControl (
 373   IN EFI_SERIAL_IO_PROTOCOL *This,
 374   OUT UINT32                *Control
 375   )
 376 {
 377   return SerialPortGetControl (Control);
 378 }
 379
 380 /**
 381   Writes data to a serial device.
 382
 383   @param  This              Protocol instance pointer.
 384   @param  BufferSize        On input, the size of the Buffer. On output, the amount of
 385                             data actually written.
 386   @param  Buffer            The buffer of data to write
 387
 388   @retval EFI_SUCCESS       The data was written.
 389   @retval EFI_DEVICE_ERROR  The device reported an error.
 390   @retval EFI_TIMEOUT       The data write was stopped due to a timeout.
 391
 392 **/
 393 EFI_STATUS
 394 EFIAPI
 395 SerialWrite (
 396   IN EFI_SERIAL_IO_PROTOCOL *This,
 397   IN OUT UINTN              *BufferSize,
 398   IN VOID                   *Buffer
 399   )
 400 {
 401   UINTN Count;
 402
 403   Count = SerialPortWrite (Buffer, *BufferSize);
 404
 405   if (Count != *BufferSize) {
 406     *BufferSize = Count;
 407     return EFI_TIMEOUT;
 408   }
 409
 410   return EFI_SUCCESS;
 411 }
 412
 413 /**
 414   Reads data from a serial device.
 415
 416   @param  This              Protocol instance pointer.
 417   @param  BufferSize        On input, the size of the Buffer. On output, the amount of
 418                             data returned in Buffer.
 419   @param  Buffer            The buffer to return the data into.
 420
 421   @retval EFI_SUCCESS       The data was read.
 422   @retval EFI_DEVICE_ERROR  The device reported an error.
 423   @retval EFI_TIMEOUT       The data write was stopped due to a timeout.
 424
 425 **/
 426 EFI_STATUS
 427 EFIAPI
 428 SerialRead (
 429   IN EFI_SERIAL_IO_PROTOCOL *This,
 430   IN OUT UINTN              *BufferSize,
 431   OUT VOID                  *Buffer
 432   )
 433 {
 434   UINTN Count;
 435   UINTN TimeOut;
 436
 437   Count = 0;
 438
 439   while (Count < *BufferSize) {
 440     TimeOut = 0;
 441     while (TimeOut < mSerialIoMode.Timeout) {
 442       if (SerialPortPoll ()) {
 443         break;
 444       }
 445       gBS->Stall (10);
 446       TimeOut += 10;
 447     }
 448     if (TimeOut >= mSerialIoMode.Timeout) {
 449       break;
 450     }
 451     SerialPortRead (Buffer, 1);
 452     Count++;
 453     Buffer = (VOID *) ((UINT8 *) Buffer + 1);
 454   }
 455
 456   if (Count != *BufferSize) {
 457     *BufferSize = Count;
 458     return EFI_TIMEOUT;
 459   }
 460
 461   return EFI_SUCCESS;
 462 }
 463
 464 /**
 465   Initialization for the Serial Io Protocol.
 466
 467   @param[in] ImageHandle    The firmware allocated handle for the EFI image.
 468   @param[in] SystemTable    A pointer to the EFI System Table.
 469
 470   @retval EFI_SUCCESS       The entry point is executed successfully.
 471   @retval other             Some error occurs when executing this entry point.
 472
 473 **/
 474 EFI_STATUS
 475 EFIAPI
 476 SerialDxeInitialize (
 477   IN EFI_HANDLE         ImageHandle,
 478   IN EFI_SYSTEM_TABLE   *SystemTable
 479   )
 480 {
 481   EFI_STATUS            Status;
 482
 483   mSerialIoMode.BaudRate = PcdGet64 (PcdUartDefaultBaudRate);
 484   mSerialIoMode.DataBits = (UINT32) PcdGet8 (PcdUartDefaultDataBits);
 485   mSerialIoMode.Parity   = (UINT32) PcdGet8 (PcdUartDefaultParity);
 486   mSerialIoMode.StopBits = (UINT32) PcdGet8 (PcdUartDefaultStopBits);
 487   mSerialIoMode.ReceiveFifoDepth = PcdGet16 (PcdUartDefaultReceiveFifoDepth);
 488   mSerialDevicePath.Uart.BaudRate = PcdGet64 (PcdUartDefaultBaudRate);
 489   mSerialDevicePath.Uart.DataBits = PcdGet8 (PcdUartDefaultDataBits);
 490   mSerialDevicePath.Uart.Parity   = PcdGet8 (PcdUartDefaultParity);
 491   mSerialDevicePath.Uart.StopBits = PcdGet8 (PcdUartDefaultStopBits);
 492
 493   //
 494   // Issue a reset to initialize the Serial Port
 495   //
 496   Status = mSerialIoTemplate.Reset (&mSerialIoTemplate);
 497   if (EFI_ERROR (Status)) {
 498     return Status;
 499   }
 500
 501   //
 502   // Make a new handle with Serial IO protocol and its device path on it.
 503   //
 504   Status = gBS->InstallMultipleProtocolInterfaces (
 505                   &mSerialHandle,
 506                   &gEfiSerialIoProtocolGuid,   &mSerialIoTemplate,
 507                   &gEfiDevicePathProtocolGuid, &mSerialDevicePath,
 508                   NULL
 509                   );
 510   ASSERT_EFI_ERROR (Status);
 511
 512   return Status;
 513 }
 514