SourceLevelDebugPkg: Fix typos in comments

[mirror_edk2.git] / SourceLevelDebugPkg / Include / Library / DebugCommunicationLib.h

/** @file\r
  Debug Communication Library definitions.\r
\r
  Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php.\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef __DEBUG_COMMUNICATION_LIB_H__\r
#define __DEBUG_COMMUNICATION_LIB_H__\r
\r
typedef VOID *    DEBUG_PORT_HANDLE;\r
\r
/**\r
  Caller provided function to be invoked at the end of DebugPortInitialize().\r
\r
  Refer to the description for DebugPortInitialize() for more details.\r
\r
  @param[in] Context           The first input argument of DebugPortInitialize().\r
  @param[in] DebugPortHandle   Debug port handle created by Debug Communication Library.\r
\r
**/\r
typedef\r
VOID\r
(EFIAPI * DEBUG_PORT_CONTINUE)(\r
  IN VOID                *Context,\r
  IN DEBUG_PORT_HANDLE   DebugPortHandle\r
  );\r
\r
/**\r
  Initialize the debug port.\r
\r
  This function will initialize debug port to get it ready for data transmition. If\r
  certain Debug Communication Library instance has to save some private data in the\r
  stack, this function must work on the mode that doesn't return to the caller, then\r
  the caller needs to wrap up all rest of logic after DebugPortInitialize() into one\r
  function and pass it into DebugPortInitialize(). DebugPortInitialize() is\r
  responsible to invoke the passing-in function at the end of DebugPortInitialize().\r
\r
  If the parameter Function is not NULL, Debug Communication Library instance will\r
  invoke it by passing in the Context to be the first parameter. Debug Communication\r
  Library instance could create one debug port handle to be the second parameter\r
  passing into the Function. Debug Communication Library instance also could pass\r
  NULL to be the second parameter if it doesn't create the debug port handle.\r
\r
  If the parameter Function is NULL, and Context is not NULL. At this time, Context\r
  is the debug port handle created by the previous Debug Communication Library\r
  instance.\r
  a) If the instance can understand and continue use the private data of the previous\r
     instance, it could return the same handle as passed in (as Context parameter).\r
  b) If the instance does not understand, or does not want to continue use the\r
     private data of the previous instance, it could ignore the input Context parameter\r
     and create the new handle to be returned.\r
\r
  If Function() is NULL and Context is NULL, Debug Communication Library could create a\r
  new handle and return it. NULL is also a valid handle to be returned.\r
\r
  @param[in] Context      Context needed by callback function; it was optional.\r
  @param[in] Function     Continue function called by Debug Communication library;\r
                          it was optional.\r
\r
  @return  The debug port handle created by Debug Communication Library if Function\r
           is not NULL.\r
\r
**/\r
DEBUG_PORT_HANDLE\r
EFIAPI\r
DebugPortInitialize (\r
  IN VOID                 *Context,\r
  IN DEBUG_PORT_CONTINUE  Function\r
  );\r
\r
\r
/**\r
  Read data from debug device and save the datas in buffer.\r
\r
  Reads NumberOfBytes data bytes from a debug device into the buffer\r
  specified by Buffer. The number of bytes actually read is returned.\r
  If the return value is less than NumberOfBytes, then the rest operation failed.\r
  If NumberOfBytes is zero, then return 0.\r
\r
  @param  Handle           Debug port handle.\r
  @param  Buffer           Pointer to the data buffer to store the data read from the debug device.\r
  @param  NumberOfBytes    Number of bytes which will be read.\r
  @param  Timeout          Timeout value for reading from debug device. It unit is Microsecond.\r
\r
  @retval 0                Read data failed, no data is to be read.\r
  @retval >0               Actual number of bytes read from debug device.\r
\r
**/\r
UINTN\r
EFIAPI\r
DebugPortReadBuffer (\r
  IN DEBUG_PORT_HANDLE     Handle,\r
  IN UINT8                 *Buffer,\r
  IN UINTN                 NumberOfBytes,\r
  IN UINTN                 Timeout\r
  );\r
\r
\r
/**\r
  Write data from buffer to debug device.\r
\r
  Writes NumberOfBytes data bytes from Buffer to the debug device.\r
  The number of bytes actually written to the debug device is returned.\r
  If the return value is less than NumberOfBytes, then the write operation failed.\r
  If NumberOfBytes is zero, then return 0.\r
\r
  @param  Handle           Debug port handle.\r
  @param  Buffer           Pointer to the data buffer to be written.\r
  @param  NumberOfBytes    Number of bytes to written to the debug device.\r
\r
  @retval 0                NumberOfBytes is 0.\r
  @retval >0               The number of bytes written to the debug device.\r
                           If this value is less than NumberOfBytes, then the read operation failed.\r
\r
**/\r
UINTN\r
EFIAPI\r
DebugPortWriteBuffer (\r
  IN DEBUG_PORT_HANDLE     Handle,\r
  IN UINT8                 *Buffer,\r
  IN UINTN                 NumberOfBytes\r
  );\r
\r
/**\r
  Polls a debug device to see if there is any data waiting to be read.\r
\r
  Polls a debug device to see if there is any data waiting to be read.\r
  If there is data waiting to be read from the debug device, then TRUE is returned.\r
  If there is no data waiting to be read from the debug device, then FALSE is returned.\r
\r
  @param  Handle           Debug port handle.\r
\r
  @retval TRUE             Data is waiting to be read from the debug device.\r
  @retval FALSE            There is no data waiting to be read from the serial device.\r
\r
**/\r
BOOLEAN\r
EFIAPI\r
DebugPortPollBuffer (\r
  IN DEBUG_PORT_HANDLE     Handle\r
  );\r
\r
#endif\r
\r