MdePkg/Include/Protocol/SerialIo.h

   1 /** @file
   2   Serial IO protocol as defined in the UEFI 2.0 specification.
   3
   4   Abstraction of a basic serial device. Targeted at 16550 UART, but
   5   could be much more generic.
   6
   7   Copyright (c) 2006 - 2008, Intel Corporation
   8   All rights reserved. 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 #ifndef __SERIAL_IO_PROTOCOL_H__
  19 #define __SERIAL_IO_PROTOCOL_H__
  20
  21 #define EFI_SERIAL_IO_PROTOCOL_GUID \
  22   { \
  23     0xBB25CF6F, 0xF1D4, 0x11D2, {0x9A, 0x0C, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0xFD } \
  24   }
  25
  26 //
  27 // Protocol GUID defined in EFI1.1.
  28 //
  29 #define SERIAL_IO_PROTOCOL  EFI_SERIAL_IO_PROTOCOL_GUID
  30
  31 typedef struct _EFI_SERIAL_IO_PROTOCOL EFI_SERIAL_IO_PROTOCOL;
  32
  33
  34 //
  35 // Backward-compatible with EFI1.1.
  36 //
  37 typedef EFI_SERIAL_IO_PROTOCOL  SERIAL_IO_INTERFACE;
  38
  39 //
  40 // Serial IO Data structures
  41 //
  42 typedef enum {
  43   DefaultParity,
  44   NoParity,
  45   EvenParity,
  46   OddParity,
  47   MarkParity,
  48   SpaceParity
  49 } EFI_PARITY_TYPE;
  50
  51 typedef enum {
  52   DefaultStopBits,
  53   OneStopBit,
  54   OneFiveStopBits,
  55   TwoStopBits
  56 } EFI_STOP_BITS_TYPE;
  57
  58 //
  59 // define for Control bits, grouped by read only, write only, and read write
  60 //
  61 //
  62 // Read Only
  63 //
  64 #define EFI_SERIAL_CLEAR_TO_SEND        0x00000010
  65 #define EFI_SERIAL_DATA_SET_READY       0x00000020
  66 #define EFI_SERIAL_RING_INDICATE        0x00000040
  67 #define EFI_SERIAL_CARRIER_DETECT       0x00000080
  68 #define EFI_SERIAL_INPUT_BUFFER_EMPTY   0x00000100
  69 #define EFI_SERIAL_OUTPUT_BUFFER_EMPTY  0x00000200
  70
  71 //
  72 // Write Only
  73 //
  74 #define EFI_SERIAL_REQUEST_TO_SEND      0x00000002
  75 #define EFI_SERIAL_DATA_TERMINAL_READY  0x00000001
  76
  77 //
  78 // Read Write
  79 //
  80 #define EFI_SERIAL_HARDWARE_LOOPBACK_ENABLE     0x00001000
  81 #define EFI_SERIAL_SOFTWARE_LOOPBACK_ENABLE     0x00002000
  82 #define EFI_SERIAL_HARDWARE_FLOW_CONTROL_ENABLE 0x00004000
  83
  84 //
  85 // Serial IO Member Functions
  86 //
  87 /**
  88   Reset the serial device.
  89
  90   @param  This              Protocol instance pointer.
  91
  92   @retval EFI_SUCCESS       The device was reset.
  93   @retval EFI_DEVICE_ERROR  The serial device could not be reset.
  94
  95 **/
  96 typedef
  97 EFI_STATUS
  98 (EFIAPI *EFI_SERIAL_RESET)(
  99   IN EFI_SERIAL_IO_PROTOCOL *This
 100   )
 101 ;
 102
 103 /**
 104   Sets the baud rate, receive FIFO depth, transmit/receice time out, parity,
 105   data buts, and stop bits on a serial device.
 106
 107   @param  This             Protocol instance pointer.
 108   @param  BaudRate         The requested baud rate. A BaudRate value of 0 will use the the
 109                            device's default interface speed.
 110   @param  ReveiveFifoDepth The requested depth of the FIFO on the receive side of the
 111                            serial interface. A ReceiveFifoDepth value of 0 will use
 112                            the device's dfault FIFO depth.
 113   @param  Timeout          The requested time out for a single character in microseconds.
 114                            This timeout applies to both the transmit and receive side of the
 115                            interface. A Timeout value of 0 will use the device's default time
 116                            out value.
 117   @param  Parity           The type of parity to use on this serial device. A Parity value of
 118                            DefaultParity will use the device's default parity value.
 119   @param  DataBits         The number of data bits to use on the serial device. A DataBits
 120                            vaule of 0 will use the device's default data bit setting.
 121   @param  StopBits         The number of stop bits to use on this serial device. A StopBits
 122                            value of DefaultStopBits will use the device's default number of
 123                            stop bits.
 124
 125   @retval EFI_SUCCESS      The device was reset.
 126   @retval EFI_DEVICE_ERROR The serial device could not be reset.
 127
 128 **/
 129 typedef
 130 EFI_STATUS
 131 (EFIAPI *EFI_SERIAL_SET_ATTRIBUTES)(
 132   IN EFI_SERIAL_IO_PROTOCOL         *This,
 133   IN UINT64                         BaudRate,
 134   IN UINT32                         ReceiveFifoDepth,
 135   IN UINT32                         Timeout,
 136   IN EFI_PARITY_TYPE                Parity,
 137   IN UINT8                          DataBits,
 138   IN EFI_STOP_BITS_TYPE             StopBits
 139   )
 140 ;
 141
 142 /**
 143   Set the control bits on a serial device
 144
 145   @param  This             Protocol instance pointer.
 146   @param  Control          Set the bits of Control that are settable.
 147
 148   @retval EFI_SUCCESS      The new control bits were set on the serial device.
 149   @retval EFI_UNSUPPORTED  The serial device does not support this operation.
 150   @retval EFI_DEVICE_ERROR The serial device is not functioning correctly.
 151
 152 **/
 153 typedef
 154 EFI_STATUS
 155 (EFIAPI *EFI_SERIAL_SET_CONTROL_BITS)(
 156   IN EFI_SERIAL_IO_PROTOCOL         *This,
 157   IN UINT32                         Control
 158   )
 159 ;
 160
 161 /**
 162   Retrieves the status of thecontrol bits on a serial device
 163
 164   @param  This              Protocol instance pointer.
 165   @param  Control           A pointer to return the current Control signals from the serial device.
 166
 167   @retval EFI_SUCCESS       The control bits were read from the serial device.
 168   @retval EFI_DEVICE_ERROR  The serial device is not functioning correctly.
 169
 170 **/
 171 typedef
 172 EFI_STATUS
 173 (EFIAPI *EFI_SERIAL_GET_CONTROL_BITS)(
 174   IN EFI_SERIAL_IO_PROTOCOL         *This,
 175   OUT UINT32                        *Control
 176   )
 177 ;
 178
 179 /**
 180   Writes data to a serial device.
 181
 182   @param  This              Protocol instance pointer.
 183   @param  BufferSize        On input, the size of the Buffer. On output, the amount of
 184                             data actually written.
 185   @param  Buffer            The buffer of data to write
 186
 187   @retval EFI_SUCCESS       The data was written.
 188   @retval EFI_DEVICE_ERROR  The device reported an error.
 189   @retval EFI_TIMEOUT       The data write was stopped due to a timeout.
 190
 191 **/
 192 typedef
 193 EFI_STATUS
 194 (EFIAPI *EFI_SERIAL_WRITE)(
 195   IN EFI_SERIAL_IO_PROTOCOL         *This,
 196   IN OUT UINTN                      *BufferSize,
 197   IN VOID                           *Buffer
 198   )
 199 ;
 200
 201 /**
 202   Writes data to a serial device.
 203
 204   @param  This              Protocol instance pointer.
 205   @param  BufferSize        On input, the size of the Buffer. On output, the amount of
 206                             data returned in Buffer.
 207   @param  Buffer            The buffer to return the data into.
 208
 209   @retval EFI_SUCCESS       The data was read.
 210   @retval EFI_DEVICE_ERROR  The device reported an error.
 211   @retval EFI_TIMEOUT       The data write was stopped due to a timeout.
 212
 213 **/
 214 typedef
 215 EFI_STATUS
 216 (EFIAPI *EFI_SERIAL_READ)(
 217   IN EFI_SERIAL_IO_PROTOCOL         *This,
 218   IN OUT UINTN                      *BufferSize,
 219   OUT VOID                          *Buffer
 220   )
 221 ;
 222
 223 /**
 224   @par Data Structure Description:
 225   The data values in SERIAL_IO_MODE are read-only and are updated by the code
 226   that produces the SERIAL_IO_PROTOCOL member functions.
 227
 228   @param ControlMask
 229   A mask fo the Control bits that the device supports. The device
 230   must always support the Input Buffer Empty control bit.
 231
 232   @param TimeOut
 233   If applicable, the number of microseconds to wait before timing out
 234   a Read or Write operation.
 235
 236   @param BaudRate
 237   If applicable, the current baud rate setting of the device; otherwise,
 238   baud rate has the value of zero to indicate that device runs at the
 239   device's designed speed.
 240
 241   @param ReceiveFifoDepth
 242   The number of characters the device will buffer on input
 243
 244   @param DataBits
 245   The number of characters the device will buffer on input
 246
 247   @param Parity
 248   If applicable, this is the EFI_PARITY_TYPE that is computed or
 249   checked as each character is transmitted or reveived. If the device
 250   does not support parity the value is the default parity value.
 251
 252   @param StopBits
 253   If applicable, the EFI_STOP_BITS_TYPE number of stop bits per
 254   character. If the device does not support stop bits the value is
 255   the default stop bit values.
 256
 257 **/
 258 typedef struct {
 259   UINT32  ControlMask;
 260
 261   //
 262   // current Attributes
 263   //
 264   UINT32  Timeout;
 265   UINT64  BaudRate;
 266   UINT32  ReceiveFifoDepth;
 267   UINT32  DataBits;
 268   UINT32  Parity;
 269   UINT32  StopBits;
 270 } EFI_SERIAL_IO_MODE;
 271
 272 #define EFI_SERIAL_IO_PROTOCOL_REVISION    0x00010000
 273 #define SERIAL_IO_INTERFACE_REVISION  EFI_SERIAL_IO_PROTOCOL_REVISION
 274
 275 /**
 276   @par Protocol Description:
 277   The Serial I/O protocol is used to communicate with UART-style serial devices.
 278   These can be standard UART serial ports in PC-AT systems, serial ports attached
 279   to a USB interface, or potentially any character-based I/O device.
 280
 281   @param Revision
 282   The revision to which the EFI_SERIAL_IO_PROTOCOL adheres. All future revisions
 283   must be backwards compatible. If a future version is not back wards compatible,
 284   it is not the same GUID.
 285
 286   @param Reset
 287   Resets the hardware device.
 288
 289   @param SetAttributes
 290   Sets communication parameters for a serial device. These include
 291   the baud rate, receive FIFO depth, transmit/receive time out, parity, data bits,
 292   and stop bit attributes.
 293
 294   @param SetControl
 295   Sets the control bits on a serial device. These include Request to
 296   Send and Data Terminal Ready.
 297
 298   @param GetControl
 299   Reads the status of the control bits on a serial device. These include
 300   Clear to Send, Data Set Ready, Ring Indicator, and Carrier Detect.
 301
 302   @param Write
 303   Sends a buffer of characters to a serial device.
 304
 305   @param Read
 306   Receives a buffer of characters from a serial device.
 307
 308   @param Mode
 309   Pointer to SERIAL_IO_MODE data.
 310
 311 **/
 312 struct _EFI_SERIAL_IO_PROTOCOL {
 313   UINT32                      Revision;
 314   EFI_SERIAL_RESET            Reset;
 315   EFI_SERIAL_SET_ATTRIBUTES   SetAttributes;
 316   EFI_SERIAL_SET_CONTROL_BITS SetControl;
 317   EFI_SERIAL_GET_CONTROL_BITS GetControl;
 318   EFI_SERIAL_WRITE            Write;
 319   EFI_SERIAL_READ             Read;
 320
 321   EFI_SERIAL_IO_MODE          *Mode;
 322 };
 323
 324 extern EFI_GUID gEfiSerialIoProtocolGuid;
 325
 326 #endif