MdeModulePkg: Replace BSD License with BSD+Patent License

[mirror_edk2.git] / MdeModulePkg / Bus / Pci / EhciDxe / EhciDebug.c

/** @file\r
\r
  This file provides the information dump support for EHCI when in debug mode.\r
\r
Copyright (c) 2007 - 2013, Intel Corporation. All rights reserved.<BR>\r
SPDX-License-Identifier: BSD-2-Clause-Patent\r
\r
**/\r
\r
\r
#include "Ehci.h"\r
\r
/**\r
  Dump the status byte in QTD/QH to a more friendly format.\r
\r
  @param  State    The state in the QTD/QH.\r
\r
**/\r
VOID\r
EhcDumpStatus (\r
  IN UINT32               State\r
  )\r
{\r
  if (EHC_BIT_IS_SET (State, QTD_STAT_DO_PING)) {\r
    DEBUG ((EFI_D_VERBOSE, "  Do_Ping"));\r
  } else {\r
    DEBUG ((EFI_D_VERBOSE, "  Do_Out"));\r
  }\r
\r
  if (EHC_BIT_IS_SET (State, QTD_STAT_DO_CS)) {\r
    DEBUG ((EFI_D_VERBOSE, "  Do_CS"));\r
  } else {\r
    DEBUG ((EFI_D_VERBOSE, "  Do_SS"));\r
  }\r
\r
  if (EHC_BIT_IS_SET (State, QTD_STAT_TRANS_ERR)) {\r
    DEBUG ((EFI_D_VERBOSE, "  Transfer_Error"));\r
  }\r
\r
  if (EHC_BIT_IS_SET (State, QTD_STAT_BABBLE_ERR)) {\r
    DEBUG ((EFI_D_VERBOSE, "  Babble_Error"));\r
  }\r
\r
  if (EHC_BIT_IS_SET (State, QTD_STAT_BUFF_ERR)) {\r
    DEBUG ((EFI_D_VERBOSE, "  Buffer_Error"));\r
  }\r
\r
  if (EHC_BIT_IS_SET (State, QTD_STAT_HALTED)) {\r
    DEBUG ((EFI_D_VERBOSE, "  Halted"));\r
  }\r
\r
  if (EHC_BIT_IS_SET (State, QTD_STAT_ACTIVE)) {\r
    DEBUG ((EFI_D_VERBOSE, "  Active"));\r
  }\r
\r
  DEBUG ((EFI_D_VERBOSE, "\n"));\r
}\r
\r
\r
/**\r
  Dump the fields of a QTD.\r
\r
  @param  Qtd      The QTD to dump.\r
  @param  Msg      The message to print before the dump.\r
\r
**/\r
VOID\r
EhcDumpQtd (\r
  IN EHC_QTD              *Qtd,\r
  IN CHAR8                *Msg\r
  )\r
{\r
  QTD_HW                  *QtdHw;\r
  UINTN                   Index;\r
\r
  if (Msg != NULL) {\r
    DEBUG ((EFI_D_VERBOSE, Msg));\r
  }\r
\r
  DEBUG ((EFI_D_VERBOSE, "Queue TD @ 0x%p, data length %d\n", Qtd, (UINT32)Qtd->DataLen));\r
\r
  QtdHw = &Qtd->QtdHw;\r
\r
  DEBUG ((EFI_D_VERBOSE, "Next QTD     : %x\n", QtdHw->NextQtd));\r
  DEBUG ((EFI_D_VERBOSE, "AltNext QTD  : %x\n", QtdHw->AltNext));\r
  DEBUG ((EFI_D_VERBOSE, "Status       : %x\n", QtdHw->Status));\r
  EhcDumpStatus (QtdHw->Status);\r
\r
  if (QtdHw->Pid == QTD_PID_SETUP) {\r
    DEBUG ((EFI_D_VERBOSE, "PID          : Setup\n"));\r
\r
  } else if (QtdHw->Pid == QTD_PID_INPUT) {\r
    DEBUG ((EFI_D_VERBOSE, "PID          : IN\n"));\r
\r
  } else if (QtdHw->Pid == QTD_PID_OUTPUT) {\r
    DEBUG ((EFI_D_VERBOSE, "PID          : OUT\n"));\r
\r
  }\r
\r
  DEBUG ((EFI_D_VERBOSE, "Error Count  : %d\n", QtdHw->ErrCnt));\r
  DEBUG ((EFI_D_VERBOSE, "Current Page : %d\n", QtdHw->CurPage));\r
  DEBUG ((EFI_D_VERBOSE, "IOC          : %d\n", QtdHw->Ioc));\r
  DEBUG ((EFI_D_VERBOSE, "Total Bytes  : %d\n", QtdHw->TotalBytes));\r
  DEBUG ((EFI_D_VERBOSE, "Data Toggle  : %d\n", QtdHw->DataToggle));\r
\r
  for (Index = 0; Index < 5; Index++) {\r
    DEBUG ((EFI_D_VERBOSE, "Page[%d]      : 0x%x\n", (UINT32)Index, QtdHw->Page[Index]));\r
  }\r
}\r
\r
\r
/**\r
  Dump the queue head.\r
\r
  @param  Qh       The queue head to dump.\r
  @param  Msg      The message to print before the dump.\r
  @param  DumpBuf  Whether to dump the memory buffer of the associated QTD.\r
\r
**/\r
VOID\r
EhcDumpQh (\r
  IN EHC_QH               *Qh,\r
  IN CHAR8                *Msg,\r
  IN BOOLEAN              DumpBuf\r
  )\r
{\r
  EHC_QTD                 *Qtd;\r
  QH_HW                   *QhHw;\r
  LIST_ENTRY              *Entry;\r
  UINTN                   Index;\r
\r
  if (Msg != NULL) {\r
    DEBUG ((EFI_D_VERBOSE, Msg));\r
  }\r
\r
  DEBUG ((EFI_D_VERBOSE, "Queue head @ 0x%p, interval %ld, next qh %p\n",\r
                                Qh, (UINT64)Qh->Interval, Qh->NextQh));\r
\r
  QhHw = &Qh->QhHw;\r
\r
  DEBUG ((EFI_D_VERBOSE, "Hoziontal link: %x\n", QhHw->HorizonLink));\r
  DEBUG ((EFI_D_VERBOSE, "Device address: %d\n", QhHw->DeviceAddr));\r
  DEBUG ((EFI_D_VERBOSE, "Inactive      : %d\n", QhHw->Inactive));\r
  DEBUG ((EFI_D_VERBOSE, "EP number     : %d\n", QhHw->EpNum));\r
  DEBUG ((EFI_D_VERBOSE, "EP speed      : %d\n", QhHw->EpSpeed));\r
  DEBUG ((EFI_D_VERBOSE, "DT control    : %d\n", QhHw->DtCtrl));\r
  DEBUG ((EFI_D_VERBOSE, "Reclaim head  : %d\n", QhHw->ReclaimHead));\r
  DEBUG ((EFI_D_VERBOSE, "Max packet len: %d\n", QhHw->MaxPacketLen));\r
  DEBUG ((EFI_D_VERBOSE, "Ctrl EP       : %d\n", QhHw->CtrlEp));\r
  DEBUG ((EFI_D_VERBOSE, "Nak reload    : %d\n", QhHw->NakReload));\r
\r
  DEBUG ((EFI_D_VERBOSE, "SMask         : %x\n", QhHw->SMask));\r
  DEBUG ((EFI_D_VERBOSE, "CMask         : %x\n", QhHw->CMask));\r
  DEBUG ((EFI_D_VERBOSE, "Hub address   : %d\n", QhHw->HubAddr));\r
  DEBUG ((EFI_D_VERBOSE, "Hub port      : %d\n", QhHw->PortNum));\r
  DEBUG ((EFI_D_VERBOSE, "Multiplier    : %d\n", QhHw->Multiplier));\r
\r
  DEBUG ((EFI_D_VERBOSE, "Cur QTD       : %x\n", QhHw->CurQtd));\r
\r
  DEBUG ((EFI_D_VERBOSE, "Next QTD      : %x\n", QhHw->NextQtd));\r
  DEBUG ((EFI_D_VERBOSE, "AltNext QTD   : %x\n", QhHw->AltQtd));\r
  DEBUG ((EFI_D_VERBOSE, "Status        : %x\n", QhHw->Status));\r
\r
  EhcDumpStatus (QhHw->Status);\r
\r
  if (QhHw->Pid == QTD_PID_SETUP) {\r
    DEBUG ((EFI_D_VERBOSE, "PID           : Setup\n"));\r
\r
  } else if (QhHw->Pid == QTD_PID_INPUT) {\r
    DEBUG ((EFI_D_VERBOSE, "PID           : IN\n"));\r
\r
  } else if (QhHw->Pid == QTD_PID_OUTPUT) {\r
    DEBUG ((EFI_D_VERBOSE, "PID           : OUT\n"));\r
  }\r
\r
  DEBUG ((EFI_D_VERBOSE, "Error Count   : %d\n", QhHw->ErrCnt));\r
  DEBUG ((EFI_D_VERBOSE, "Current Page  : %d\n", QhHw->CurPage));\r
  DEBUG ((EFI_D_VERBOSE, "IOC           : %d\n", QhHw->Ioc));\r
  DEBUG ((EFI_D_VERBOSE, "Total Bytes   : %d\n", QhHw->TotalBytes));\r
  DEBUG ((EFI_D_VERBOSE, "Data Toggle   : %d\n", QhHw->DataToggle));\r
\r
  for (Index = 0; Index < 5; Index++) {\r
    DEBUG ((EFI_D_VERBOSE, "Page[%d]       : 0x%x\n", Index, QhHw->Page[Index]));\r
  }\r
\r
  DEBUG ((EFI_D_VERBOSE, "\n"));\r
\r
  EFI_LIST_FOR_EACH (Entry, &Qh->Qtds) {\r
    Qtd = EFI_LIST_CONTAINER (Entry, EHC_QTD, QtdList);\r
    EhcDumpQtd (Qtd, NULL);\r
\r
    if (DumpBuf && (Qtd->DataLen != 0)) {\r
      EhcDumpBuf (Qtd->Data, Qtd->DataLen);\r
    }\r
  }\r
}\r
\r
\r
/**\r
  Dump the buffer in the form of hex.\r
\r
  @param  Buf      The buffer to dump.\r
  @param  Len      The length of buffer.\r
\r
**/\r
VOID\r
EhcDumpBuf (\r
  IN UINT8                *Buf,\r
  IN UINTN                Len\r
  )\r
{\r
  UINTN                   Index;\r
\r
  for (Index = 0; Index < Len; Index++) {\r
    if (Index % 16 == 0) {\r
      DEBUG ((EFI_D_VERBOSE,"\n"));\r
    }\r
\r
    DEBUG ((EFI_D_VERBOSE, "%02x ", Buf[Index]));\r
  }\r
\r
  DEBUG ((EFI_D_VERBOSE, "\n"));\r
}\r
\r
\r