StdLib/LibC/Uefi/Devices/Console/daConsole.c: Fix bug where unconvertable wide chara...

[mirror_edk2.git] / StdLib / LibC / Uefi / Devices / Console / daConsole.c

/** @file\r
  Abstract device driver for the UEFI Console.\r
\r
  Manipulates abstractions for stdin, stdout, stderr.\r
\r
  Copyright (c) 2010 - 2012, Intel Corporation. All rights reserved.<BR>\r
  This program and the accompanying materials are licensed and made available under\r
  the terms and conditions of the BSD License that accompanies this distribution.\r
  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
#include  <Uefi.h>\r
#include  <Library/BaseLib.h>\r
#include  <Library/MemoryAllocationLib.h>\r
#include  <Library/UefiBootServicesTableLib.h>\r
#include  <Protocol/SimpleTextIn.h>\r
#include  <Protocol/SimpleTextOut.h>\r
\r
#include  <LibConfig.h>\r
\r
#include  <errno.h>\r
#include  <wctype.h>\r
#include  <wchar.h>\r
#include  <stdarg.h>\r
#include  <sys/fcntl.h>\r
#include  <unistd.h>\r
#include  <kfile.h>\r
#include  <Device/Device.h>\r
#include  <MainData.h>\r
\r
static const CHAR16* const\r
stdioNames[NUM_SPECIAL]   = {\r
  L"stdin:", L"stdout:", L"stderr:"\r
};\r
\r
static const int stdioFlags[NUM_SPECIAL] = {\r
  O_RDONLY,             // stdin\r
  O_WRONLY,             // stdout\r
  O_WRONLY              // stderr\r
};\r
\r
static DeviceNode    *ConNode[NUM_SPECIAL];\r
static ConInstance   *ConInstanceList;\r
\r
static wchar_t       *ConReadBuf;\r
\r
/* Flags settable by Ioctl */\r
static BOOLEAN        TtyCooked;\r
static BOOLEAN        TtyEcho;\r
\r
/** Convert string from MBCS to WCS and translate \n to \r\n.\r
\r
    It is the caller's responsibility to ensure that dest is\r
    large enough to hold the converted results.  It is guaranteed\r
    that there will be fewer than n characters placed in dest.\r
\r
    @param  dest    WCS buffer to receive the converted string.\r
    @param  buf     MBCS string to convert to WCS.\r
    @param  n       Number of BYTES contained in buf.\r
    @param  Cs      Pointer to the character state object for this stream\r
\r
    @return   The number of BYTES consumed from buf.\r
**/\r
ssize_t\r
WideTtyCvt( CHAR16 *dest, const char *buf, ssize_t n, mbstate_t *Cs)\r
{\r
  ssize_t i     = 0;\r
  int     numB  = 0;\r
  wchar_t wc[2];\r
\r
  while(n > 0) {\r
    numB = (int)mbrtowc(wc, buf, MIN(MB_LEN_MAX,n), Cs);\r
    if( numB == 0) {\r
      break;\r
    };\r
    if(numB < 0) {    // If an unconvertable character, replace it.\r
      wc[0] = BLOCKELEMENT_LIGHT_SHADE;\r
      numB = 1;\r
    }\r
    if(wc[0] == L'\n') {\r
      *dest++ = L'\r';\r
      ++i;\r
    }\r
    *dest++ = (CHAR16)wc[0];\r
    i += numB;\r
    n -= numB;\r
    buf += numB;\r
  }\r
  *dest = 0;\r
  return i;\r
}\r
\r
static\r
int\r
EFIAPI\r
da_ConClose(\r
  IN      struct __filedes   *filp\r
)\r
{\r
  ConInstance    *Stream;\r
\r
  Stream = BASE_CR(filp->f_ops, ConInstance, Abstraction);\r
  // Quick check to see if Stream looks reasonable\r
  if(Stream->Cookie != CON_COOKIE) {    // Cookie == 'IoAb'\r
    EFIerrno = RETURN_INVALID_PARAMETER;\r
    return -1;    // Looks like a bad File Descriptor pointer\r
  }\r
  gMD->StdIo[Stream->InstanceNum] = NULL;   // Mark the stream as closed\r
  return RETURN_SUCCESS;\r
}\r
\r
static\r
off_t\r
EFIAPI\r
da_ConSeek(\r
  struct __filedes   *filp,\r
  off_t               Position,\r
  int                 whence      ///< Ignored by Console\r
)\r
{\r
  ConInstance                       *Stream;\r
  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL   *Proto;\r
  XY_OFFSET                          CursorPos;\r
\r
  Stream = BASE_CR(filp->f_ops, ConInstance, Abstraction);\r
  // Quick check to see if Stream looks reasonable\r
  if(Stream->Cookie != CON_COOKIE) {    // Cookie == 'IoAb'\r
    EFIerrno = RETURN_INVALID_PARAMETER;\r
    return -1;    // Looks like a bad This pointer\r
  }\r
  if(Stream->InstanceNum == STDIN_FILENO) {\r
    // Seek is not valid for stdin\r
    EFIerrno = RETURN_UNSUPPORTED;\r
    return -1;\r
  }\r
  // Everything is OK to do the final verification and "seek".\r
  Proto = (EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *)Stream->Dev;\r
  CursorPos.Offset = Position;\r
\r
  EFIerrno = Proto->SetCursorPosition(Proto,\r
                                      (INTN)CursorPos.XYpos.Column,\r
                                      (INTN)CursorPos.XYpos.Row);\r
\r
  if(RETURN_ERROR(EFIerrno)) {\r
    return -1;\r
  }\r
  else {\r
    return Position;\r
  }\r
}\r
\r
/* Write a NULL terminated WCS to the EFI console.\r
\r
  @param[in,out]  BufferSize  Number of bytes in Buffer.  Set to zero if\r
                              the string couldn't be displayed.\r
  @param[in]      Buffer      The WCS string to be displayed\r
\r
  @return   The number of BYTES written.  Because of MBCS, this may be more than number of characters.\r
*/\r
static\r
ssize_t\r
EFIAPI\r
da_ConWrite(\r
  IN  struct __filedes     *filp,\r
  IN  off_t                *Position,\r
  IN  size_t                BufferSize,\r
  IN  const void           *Buffer\r
  )\r
{\r
  EFI_STATUS                          Status;\r
  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *Proto;\r
  ConInstance                        *Stream;\r
  ssize_t                             NumBytes;\r
\r
  Stream = BASE_CR(filp->f_ops, ConInstance, Abstraction);\r
  // Quick check to see if Stream looks reasonable\r
  if(Stream->Cookie != CON_COOKIE) {    // Cookie == 'IoAb'\r
    EFIerrno = RETURN_INVALID_PARAMETER;\r
    return -1;    // Looks like a bad This pointer\r
  }\r
  if(Stream->InstanceNum == STDIN_FILENO) {\r
    // Write is not valid for stdin\r
    EFIerrno = RETURN_UNSUPPORTED;\r
    return -1;\r
  }\r
  // Everything is OK to do the write.\r
  Proto = (EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *)Stream->Dev;\r
\r
  // Convert string from MBCS to WCS and translate \n to \r\n.\r
  NumBytes = WideTtyCvt(gMD->UString, (const char *)Buffer, (ssize_t)BufferSize, &Stream->CharState);\r
  BufferSize = NumBytes;\r
\r
\r
  // Send the Unicode buffer to the console\r
  Status = Proto->OutputString( Proto, gMD->UString);\r
  // Depending on status, update BufferSize and return\r
  if(RETURN_ERROR(Status)) {\r
    BufferSize = 0;     // We don't really know how many characters made it out\r
  }\r
  else {\r
    //BufferSize = NumBytes;\r
    Stream->NumWritten += NumBytes;\r
  }\r
  EFIerrno = Status;      // Make error reason available to caller\r
  return BufferSize;\r
}\r
\r
/** Read characters from the console input device.\r
\r
    @param[in,out]  filp          Pointer to file descriptor for this file.\r
    @param[in,out]  offset        Ignored.\r
    @param[in]      BufferSize    Buffer size, in bytes.\r
    @param[out]     Buffer        Buffer in which to place the read characters.\r
\r
    @return     Number of bytes actually placed into Buffer.\r
\r
    @todo       Handle encodings other than ASCII-7 and UEFI.\r
**/\r
static\r
ssize_t\r
EFIAPI\r
da_ConRead(\r
  IN OUT  struct __filedes   *filp,\r
  IN OUT  off_t              *offset,         // Console ignores this\r
  IN      size_t              BufferSize,\r
     OUT  VOID               *Buffer\r
)\r
{\r
  EFI_SIMPLE_TEXT_INPUT_PROTOCOL   *Proto;\r
  ConInstance                      *Stream;\r
  wchar_t                          *OutPtr;\r
  EFI_INPUT_KEY                     Key;\r
  UINTN                             NumChar;\r
  UINTN                             Edex;\r
  EFI_STATUS                        Status = RETURN_SUCCESS;\r
  UINTN                             i;\r
  char                              EchoBuff[MB_CUR_MAX + 1];\r
  int                               NumEcho;\r
\r
  Stream = BASE_CR(filp->f_ops, ConInstance, Abstraction);\r
  // Quick check to see if Stream looks reasonable\r
  if(Stream->Cookie != CON_COOKIE) {    // Cookie == 'IoAb'\r
    EFIerrno = RETURN_INVALID_PARAMETER;\r
    return -1;    // Looks like a bad This pointer\r
  }\r
  if(Stream->InstanceNum != STDIN_FILENO) {\r
    // Read only valid for stdin\r
    EFIerrno = RETURN_UNSUPPORTED;\r
    return -1;\r
  }\r
  // It looks like things are OK for trying to read\r
  // We will accumulate *BufferSize characters or until we encounter\r
  // an "activation" character.  Currently any control character.\r
  Proto = (EFI_SIMPLE_TEXT_INPUT_PROTOCOL *)Stream->Dev;\r
  OutPtr = ConReadBuf;\r
  NumChar = (BufferSize > MAX_INPUT)? MAX_INPUT : BufferSize;\r
  i = 0;\r
  do {\r
    if((Stream->UnGetKey.UnicodeChar == CHAR_NULL) && (Stream->UnGetKey.ScanCode == SCAN_NULL)) {\r
      Status = gBS->WaitForEvent( 1, &Proto->WaitForKey, &Edex);\r
      if(Status != RETURN_SUCCESS) {\r
        break;\r
      }\r
      Status = Proto->ReadKeyStroke(Proto, &Key);\r
      if(Status != RETURN_SUCCESS) {\r
        break;\r
      }\r
    }\r
    else {\r
      Key.ScanCode          = Stream->UnGetKey.ScanCode;\r
      Key.UnicodeChar       = Stream->UnGetKey.UnicodeChar;\r
      Stream->UnGetKey.ScanCode     = SCAN_NULL;\r
      Stream->UnGetKey.UnicodeChar  = CHAR_NULL;\r
    }\r
    if(Key.ScanCode == SCAN_NULL) {\r
      NumEcho = 0;\r
      if(TtyCooked && (Key.UnicodeChar == CHAR_CARRIAGE_RETURN)) {\r
        *OutPtr++ = CHAR_LINEFEED;\r
        NumEcho = wctomb(EchoBuff, CHAR_LINEFEED);\r
      }\r
      else {\r
        *OutPtr++ = Key.UnicodeChar;\r
        NumEcho = wctomb(EchoBuff, Key.UnicodeChar);\r
      }\r
      ++i;\r
      EchoBuff[NumEcho] = 0;  /* Terminate the Echo buffer */\r
      if(TtyEcho) {\r
        /* Echo the character just input */\r
        da_ConWrite(&gMD->fdarray[STDOUT_FILENO], NULL, 2, EchoBuff);\r
      }\r
    }\r
    if(iswcntrl(Key.UnicodeChar)) {    // If a control character, or a scan code\r
      break;\r
    }\r
  } while(i < NumChar);\r
\r
  *OutPtr = L'\0';    // Terminate the input buffer\r
\r
  /*  Convert the input buffer and place in Buffer.\r
      If the fully converted input buffer won't fit, write what will and\r
      leave the rest in ConReadBuf with ConReadLeft indicating how many\r
      unconverted characters remain in ConReadBuf.\r
  */\r
  NumEcho = (int)wcstombs(Buffer, ConReadBuf, BufferSize);   /* Re-use NumEcho to hold number of bytes in Buffer */\r
  /* More work needs to be done before locales other than C can be supported. */\r
\r
  EFIerrno = Status;\r
  return (ssize_t)NumEcho;  // Will be 0 if we didn't get a key\r
}\r
\r
/** Console-specific helper function for the fstat() function.\r
\r
    st_size       Set to number of characters read for stdin and number written for stdout and stderr.\r
    st_physsize   1 for stdin, 0 if QueryMode error, else max X and Y coordinates for the current mode.\r
    st_curpos     0 for stdin, current X & Y coordinates for stdout and stderr\r
    st_blksize    Set to 1 since this is a character device\r
\r
    All other members of the stat structure are left unchanged.\r
**/\r
static\r
int\r
EFIAPI\r
da_ConStat(\r
  struct __filedes   *filp,\r
  struct stat        *Buffer,\r
  void               *Something\r
  )\r
{\r
  ConInstance                        *Stream;\r
  EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL    *Proto;\r
  XY_OFFSET                           CursorPos;\r
  INT32                               OutMode;\r
  UINTN                               ModeCol;\r
  UINTN                               ModeRow;\r
\r
// ConGetInfo\r
  Stream = BASE_CR(filp->f_ops, ConInstance, Abstraction);\r
  // Quick check to see if Stream looks reasonable\r
  if ((Stream->Cookie != CON_COOKIE) ||    // Cookie == 'IoAb'\r
      (Buffer == NULL))\r
  {\r
    EFIerrno = RETURN_INVALID_PARAMETER;\r
    return -1;\r
  }\r
  // All of our parameters are correct, so fill in the information.\r
  Buffer->st_blksize  = 0;   // Character device, not a block device\r
  Buffer->st_mode     = filp->f_iflags;\r
\r
// ConGetPosition\r
  if(Stream->InstanceNum == STDIN_FILENO) {\r
    // This is stdin\r
    Buffer->st_curpos    = 0;\r
    Buffer->st_size      = (off_t)Stream->NumRead;\r
    Buffer->st_physsize  = 1;\r
  }\r
  else {\r
    Proto = (EFI_SIMPLE_TEXT_OUTPUT_PROTOCOL *)Stream->Dev;\r
    CursorPos.XYpos.Column  = (UINT32)Proto->Mode->CursorColumn;\r
    CursorPos.XYpos.Row     = (UINT32)Proto->Mode->CursorRow;\r
    Buffer->st_curpos       = (off_t)CursorPos.Offset;\r
    Buffer->st_size         = (off_t)Stream->NumWritten;\r
\r
    OutMode  = Proto->Mode->Mode;\r
    EFIerrno = Proto->QueryMode(Proto, (UINTN)OutMode, &ModeCol, &ModeRow);\r
    if(RETURN_ERROR(EFIerrno)) {\r
      Buffer->st_physsize = 0;\r
    }\r
    else {\r
      CursorPos.XYpos.Column  = (UINT32)ModeCol;\r
      CursorPos.XYpos.Row     = (UINT32)ModeRow;\r
      Buffer->st_physsize     = (off_t)CursorPos.Offset;\r
    }\r
  }\r
  return 0;\r
}\r
\r
static\r
int\r
EFIAPI\r
da_ConIoctl(\r
  struct __filedes   *filp,\r
  ULONGN              cmd,\r
  va_list             argp\r
  )\r
{\r
  return -EPERM;\r
}\r
\r
/** Open an abstract Console Device.\r
**/\r
int\r
EFIAPI\r
da_ConOpen(\r
  DeviceNode         *DevNode,\r
  struct __filedes   *filp,\r
  int                 DevInstance,    // Not used for console devices\r
  wchar_t            *Path,           // Not used for console devices\r
  wchar_t            *MPath           // Not used for console devices\r
  )\r
{\r
  ConInstance                      *Stream;\r
\r
  if((filp == NULL)           ||\r
     (DevNode  == NULL))\r
  {\r
    EFIerrno = RETURN_INVALID_PARAMETER;\r
    errno = EINVAL;\r
    return -1;\r
  }\r
  Stream = (ConInstance *)DevNode->InstanceList;\r
  // Quick check to see if Stream looks reasonable\r
  if(Stream->Cookie != CON_COOKIE) {    // Cookie == 'IoAb'\r
    EFIerrno = RETURN_INVALID_PARAMETER;\r
    errno = EINVAL;\r
    return -1;    // Looks like a bad This pointer\r
  }\r
  gMD->StdIo[Stream->InstanceNum] = Stream;\r
  filp->f_iflags |= (S_IFREG | _S_IFCHR | _S_ICONSOLE);\r
  filp->f_offset = 0;\r
  filp->f_ops = &Stream->Abstraction;\r
\r
  return 0;\r
}\r
\r
#include  <sys/poll.h>\r
/*  Returns a bit mask describing which operations could be completed immediately.\r
\r
    (POLLIN | POLLRDNORM)   A Unicode character is available to read\r
    (POLLIN)                A ScanCode is ready.\r
    (POLLOUT)               The device is ready for output - always set on stdout and stderr.\r
\r
*/\r
static\r
short\r
EFIAPI\r
da_ConPoll(\r
  struct __filedes   *filp,\r
  short              events\r
  )\r
{\r
  EFI_SIMPLE_TEXT_INPUT_PROTOCOL   *Proto;\r
  ConInstance                      *Stream;\r
  EFI_STATUS                        Status = RETURN_SUCCESS;\r
  short                             RdyMask = 0;\r
\r
  Stream = BASE_CR(filp->f_ops, ConInstance, Abstraction);\r
  // Quick check to see if Stream looks reasonable\r
  if(Stream->Cookie != CON_COOKIE) {    // Cookie == 'IoAb'\r
    EFIerrno = RETURN_INVALID_PARAMETER;\r
    return POLLNVAL;    // Looks like a bad filp pointer\r
  }\r
  if(Stream->InstanceNum == 0) {\r
    // Only input is supported for this device\r
    Proto = (EFI_SIMPLE_TEXT_INPUT_PROTOCOL *)Stream->Dev;\r
    if((Stream->UnGetKey.UnicodeChar == CHAR_NULL) && (Stream->UnGetKey.ScanCode == SCAN_NULL)) {\r
      Status = Proto->ReadKeyStroke(Proto, &Stream->UnGetKey);\r
      if(Status == RETURN_SUCCESS) {\r
        RdyMask = POLLIN;\r
        if(Stream->UnGetKey.UnicodeChar != CHAR_NULL) {\r
          RdyMask |= POLLRDNORM;\r
        }\r
      }\r
      else {\r
        Stream->UnGetKey.ScanCode     = SCAN_NULL;\r
        Stream->UnGetKey.UnicodeChar  = CHAR_NULL;\r
      }\r
    }\r
  }\r
  else if(Stream->InstanceNum < NUM_SPECIAL) {  // Not 0, is it 1 or 2?\r
    // Only output is supported for this device\r
    RdyMask = POLLOUT;\r
  }\r
  else {\r
    RdyMask = POLLERR;    // Not one of the standard streams\r
  }\r
  EFIerrno = Status;\r
\r
  return (RdyMask & (events | POLL_RETONLY));\r
}\r
\r
/** Construct the Console stream devices: stdin, stdout, stderr.\r
\r
    Allocate the instance structure and populate it with the information for\r
    each stream device.\r
**/\r
RETURN_STATUS\r
EFIAPI\r
__Cons_construct(\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
)\r
{\r
  ConInstance    *Stream;\r
  RETURN_STATUS   Status = RETURN_SUCCESS;\r
  int             i;\r
\r
  ConInstanceList = (ConInstance *)AllocateZeroPool(NUM_SPECIAL * sizeof(ConInstance));\r
  ConReadBuf      = (wchar_t *)AllocateZeroPool((MAX_INPUT + 1) * sizeof(wchar_t));\r
  if((ConInstanceList == NULL) || (ConReadBuf == NULL))  {\r
    return RETURN_OUT_OF_RESOURCES;\r
  }\r
\r
  for( i = 0; i < NUM_SPECIAL; ++i) {\r
    // Get pointer to instance.\r
    Stream = &ConInstanceList[i];\r
\r
    Stream->Cookie      = CON_COOKIE;\r
    Stream->InstanceNum = i;\r
    Stream->CharState.A = 0;    // Start in the initial state\r
\r
    switch(i) {\r
      case STDIN_FILENO:\r
        Stream->Dev = SystemTable->ConIn;\r
        break;\r
      case STDOUT_FILENO:\r
        Stream->Dev = SystemTable->ConOut;\r
        break;\r
      case STDERR_FILENO:\r
        if(SystemTable->StdErr == NULL) {\r
          Stream->Dev = SystemTable->ConOut;\r
        }\r
        else {\r
          Stream->Dev = SystemTable->StdErr;\r
        }\r
        break;\r
      default:\r
        return RETURN_VOLUME_CORRUPTED;     // This is a "should never happen" case.\r
    }\r
\r
    Stream->Abstraction.fo_close    = &da_ConClose;\r
    Stream->Abstraction.fo_read     = &da_ConRead;\r
    Stream->Abstraction.fo_write    = &da_ConWrite;\r
    Stream->Abstraction.fo_stat     = &da_ConStat;\r
    Stream->Abstraction.fo_lseek    = &da_ConSeek;\r
    Stream->Abstraction.fo_fcntl    = &fnullop_fcntl;\r
    Stream->Abstraction.fo_ioctl    = &da_ConIoctl;\r
    Stream->Abstraction.fo_poll     = &da_ConPoll;\r
    Stream->Abstraction.fo_flush    = &fnullop_flush;\r
    Stream->Abstraction.fo_delete   = &fbadop_delete;\r
    Stream->Abstraction.fo_mkdir    = &fbadop_mkdir;\r
    Stream->Abstraction.fo_rmdir    = &fbadop_rmdir;\r
    Stream->Abstraction.fo_rename   = &fbadop_rename;\r
\r
    Stream->NumRead     = 0;\r
    Stream->NumWritten  = 0;\r
    Stream->UnGetKey.ScanCode     = SCAN_NULL;\r
    Stream->UnGetKey.UnicodeChar  = CHAR_NULL;\r
\r
    if(Stream->Dev == NULL) {\r
      continue;                 // No device for this stream.\r
    }\r
    ConNode[i] = __DevRegister(stdioNames[i], NULL, &da_ConOpen, Stream, 1, sizeof(ConInstance), stdioFlags[i]);\r
    if(ConNode[i] == NULL) {\r
      Status = EFIerrno;\r
      break;\r
    }\r
    Stream->Parent = ConNode[i];\r
  }\r
  /* Initialize Ioctl flags until Ioctl is really implemented. */\r
  TtyCooked = TRUE;\r
  TtyEcho   = TRUE;\r
\r
  return  Status;\r
}\r
\r
RETURN_STATUS\r
EFIAPI\r
__Cons_deconstruct(\r
  IN EFI_HANDLE        ImageHandle,\r
  IN EFI_SYSTEM_TABLE  *SystemTable\r
)\r
{\r
  int   i;\r
\r
  for(i = 0; i < NUM_SPECIAL; ++i) {\r
    if(ConNode[i] != NULL) {\r
      FreePool(ConNode[i]);\r
    }\r
  }\r
  if(ConInstanceList != NULL) {\r
    FreePool(ConInstanceList);\r
  }\r
  if(ConReadBuf != NULL) {\r
    FreePool(ConReadBuf);\r
  }\r
\r
  return RETURN_SUCCESS;\r
}\r
\r
/* ######################################################################### */\r
#if 0 /* Not implemented for Console */\r
\r
static\r
int\r
EFIAPI\r
da_ConCntl(\r
  struct __filedes *filp,\r
  UINT32,\r
  void *,\r
  void *\r
  )\r
{\r
}\r
\r
static\r
int\r
EFIAPI\r
da_ConFlush(\r
  struct __filedes *filp\r
  )\r
{\r
  return 0;\r
}\r
#endif  /* Not implemented for Console */\r