MdeModulePkg/Bus/Pci/UhciDxe/UhciDebug.h

   1 /** @file
   2
   3 Copyright (c) 2007, Intel Corporation
   4 All rights reserved. This program and the accompanying materials
   5 are licensed and made available under the terms and conditions of the BSD License
   6 which accompanies this distribution.  The full text of the license may be found at
   7 http://opensource.org/licenses/bsd-license.php
   8
   9 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  10 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  11
  12 Module Name:
  13
  14   UhciDebug.h
  15
  16 Abstract:
  17
  18   This file contains the definination for host controller debug support routines
  19
  20 Revision History
  21
  22
  23 **/
  24
  25 #ifndef _EFI_UHCI_DEBUG_H_
  26 #define _EFI_UHCI_DEBUG_H_
  27
  28 //
  29 // DEBUG support
  30 //
  31 #define USB_DEBUG_FORCE_OUTPUT  (UINTN) (1 << 0)
  32 #define UHCI_DEBUG_QH           (UINTN) (1 << 2)
  33 #define UHCI_DEBUG_TD           (UINTN) (1 << 3)
  34
  35 VOID
  36 UhciDebugPrint (
  37   IN  UINTN               Level,
  38   IN  CHAR8               *Format,
  39   ...
  40   )
  41 /*++
  42
  43 Routine Description:
  44
  45   Debug print interface for UHCI
  46
  47 Arguments:
  48
  49   Level   - Level to control debug print
  50   Format  - String to use for the print, followed by print arguments
  51
  52 Returns:
  53
  54   None
  55
  56 --*/
  57 ;
  58
  59
  60 /**
  61   Debug print interface for UHCI
  62
  63   @param  Format  String to use for the print, followed by print arguments
  64
  65   @return None
  66
  67 **/
  68 VOID
  69 UhciDebug (
  70   IN  CHAR8               *Format,
  71   ...
  72   )
  73 ;
  74
  75
  76 /**
  77   Debug error print interface for UHCI
  78
  79   @param  Format  String to use for the print, followed by print arguments
  80
  81   @return None
  82
  83 **/
  84 VOID
  85 UhciError (
  86   IN  CHAR8               *Format,
  87   ...
  88   )
  89 ;
  90
  91
  92 /**
  93   Dump the content of QH structure
  94
  95   @param  QhSw    Pointer to software QH structure
  96
  97   @return None
  98
  99 **/
 100 VOID
 101 UhciDumpQh (
 102   IN UHCI_QH_SW         *QhSw
 103   )
 104 ;
 105
 106
 107 /**
 108   Dump the content of TD structure.
 109
 110   @param  TdSw    Pointer to software TD structure
 111
 112   @return None
 113
 114 **/
 115 VOID
 116 UhciDumpTds (
 117   IN UHCI_TD_SW           *TdSw
 118   )
 119 ;
 120
 121
 122 #ifdef EFI_DEBUG
 123   #define UHCI_DEBUG(arg)             UhciDebug arg
 124   #define UHCI_ERROR(arg)             UhciError arg
 125   #define UHCI_DUMP_TDS(arg)          UhciDumpTds arg
 126   #define UHCI_DUMP_QH(arg)           UhciDumpQh arg
 127 #else
 128   #define UHCI_DEBUG(arg)
 129   #define UHCI_ERROR(arg)
 130   #define UHCI_DUMP_TDS(arg)
 131   #define UHCI_DUMP_QH(arg)
 132 #endif
 133
 134 #endif