SourceLevelDebugPkg/SourceLevelDebugPkg.dec

   1 ## @file  SourceLevelDebugPkg.dec
   2 # This package provides target side modules to support source level debug.
   3 # The target side components includes the Debug Agent Library instance
   4 # to communicate with host side modules, Debug Communication Library and
   5 # instances to provide the communication I/O functions between Debug Agent
   6 # and host, PeCoffExtraActionLib instance to report symbol path information,
   7 # etc.
   8 #
   9 # Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>
  10 # SPDX-License-Identifier: BSD-2-Clause-Patent
  11 #
  12 ##
  13
  14 [Defines]
  15   DEC_SPECIFICATION              = 0x00010005
  16   PACKAGE_NAME                   = SourceLevelDebugPkg
  17   PACKAGE_UNI_FILE               = SourceLevelDebugPkg.uni
  18   PACKAGE_GUID                   = DBF00C27-D8D7-443d-918B-4E85CDA1373B
  19   PACKAGE_VERSION                = 0.96
  20
  21 [Includes]
  22   Include
  23
  24 [Includes.IA32]
  25   Include/Ia32
  26
  27 [Includes.X64]
  28   Include/Ia32
  29
  30 [LibraryClasses]
  31   ##  @libraryclass  Provides communication I/O functions between Debug Agent and HOST.
  32   ##
  33   DebugCommunicationLib|Include/Library/DebugCommunicationLib.h
  34
  35 [Guids]
  36   ## MdeModule package token space guid
  37   # Include/Guid/DebugAgentGuid.h
  38   gEfiDebugAgentGuid       = {0x865a5a9b, 0xb85d, 0x474c, { 0x84, 0x55, 0x65, 0xd1, 0xbe, 0x84, 0x4b, 0xe2 }}
  39   gEfiSourceLevelDebugPkgTokenSpaceGuid = {0x865a5aab, 0xb85d, 0x474c, { 0x84, 0x55, 0x65, 0xd1, 0xbe, 0x84, 0x4b, 0xe2 }}
  40
  41 #
  42 # [Error.gEfiSourceLevelDebugPkgTokenSpaceGuid]
  43 #   0x80000001 | Invalid value provided.
  44 #
  45
  46 [PcdsFixedAtBuild, PcdsPatchableInModule]
  47   ## The memory BAR of usb debug port, it may be different with the memory bar of ehci host controller.
  48   #  Note that the memory BAR address is only used before Pci bus resource allocation.
  49   # @Prompt Configure usb debug port memory BAR.
  50   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbDebugPortMemorySpaceBase|0xd0000000|UINT32|0x00000001
  51
  52   ## The memory BAR of ehci host controller, in which usb debug feature is enabled.
  53   #  Note that the memory BAR address is only used before Pci bus resource allocation.
  54   # @Prompt Configure ehci host controller memory BAR.
  55   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciMemorySpaceBase|0xd0000000|UINT32|0x00000002
  56
  57   ## The pci address of ehci host controller, in which usb debug feature is enabled.
  58   #  The format of pci address is :<BR>
  59   #      -----------------------------------------------------------------------<BR>
  60   #      | Bits 28..31 | Bits 20..27 | Bits 15..19 | Bits 12..14 | Bits 00..11 |<BR>
  61   #      -----------------------------------------------------------------------<BR>
  62   #      |      0      |     Bus     |   Device    |   Function  |      0      |<BR>
  63   #      -----------------------------------------------------------------------<BR>
  64   #  For the value 0x000EF000, it means the pci address at bus 0x0, device 0x1D, function 0x7.
  65   # @Prompt Configure ehci host controller pci address.
  66   # @Expression  0x80000001 | (gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciPciAddress & 0xF0000FFF) == 0
  67   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciPciAddress|0x000EF000|UINT32|0x00000003
  68
  69   ## The mask of exception numbers whose handlers would be ignored and cannot be replaced or
  70   #  hooked by Debug Agent Library. Masking INT1/INT3 is invalid.
  71   # @Prompt Configure exception numbers not to be hooked by Debug Agent.
  72   # @Expression  0x80000001 | (gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger & 0xA) == 0
  73   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger|0x00000000|UINT32|0x00000004
  74
  75   ## The method to issue break point to Debug Agent Library when Loading/UnLoading image.<BR><BR>
  76   #  1: Use I/O Port 84 to issue hardware break point<BR>
  77   #  2: Use INT3 to issue software break point<BR>
  78   # @Prompt Configure Loading/UnLoading image break method.
  79   # @ValidRange  0x80000001 | 1 - 2
  80   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugLoadImageMethod|0x1|UINT8|0x00000005
  81
  82   ## The data buffer size used by debug port in debug communication library instances.
  83   #  Its value is not suggested to be changed in platform DSC file.
  84   # @Prompt Assign debug port buffer size.
  85   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize|0x0|UINT16|0x00000006
  86
  87   ## The memory BAR of xhci host controller, in which usb debug feature is enabled.
  88   ## Note that the memory BAR address is only used before Pci bus resource allocation.
  89   # @Prompt Configure xhci host controller memory BAR.
  90   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciMemorySpaceBase|0xD0000000|UINT64|0x00000007
  91
  92   ## The pci address of xhci host controller, in which usb debug feature is enabled.
  93   #  The format of pci address is :<BR>
  94   #      -----------------------------------------------------------------------<BR>
  95   #      | Bits 28..31 | Bits 20..27 | Bits 15..19 | Bits 12..14 | Bits 00..11 |<BR>
  96   #      -----------------------------------------------------------------------<BR>
  97   #      |      0      |     Bus     |   Device    |   Function  |      0      |<BR>
  98   #      -----------------------------------------------------------------------<BR>
  99   #  For the value 0x000A0000, it means the pci address at bus 0x0, device 0x14, function 0x0.
 100   # @Prompt Configure xhci host controller pci address.
 101   # @Expression  0x80000001 | (gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciPciAddress & 0xF0000FFF) == 0
 102   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciPciAddress|0x000A0000|UINT32|0x00000008
 103
 104   ## Per XHCI spec, software shall impose a timeout between the detection of the Debug Host
 105   ## connection and the DbC Run transition to 1. This PCD specifies the timeout value in microsecond.
 106   # @Prompt Configure debug device detection timeout value.
 107   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciDebugDetectTimeout|3000000|UINT64|0x00000009
 108
 109   ## Default revision of the debug agent transfer protocol.
 110   #  The upper 16 bits indicate the major revision and the lower 16 bits indicate the minor revision.
 111   #  For example, a value of 0x00000004 stands for revision 0.4.
 112   #  Debug packet compression and decompression is supported since revision 0.4.
 113   # @Prompt Default revision of the debug agent transfer protocol.
 114   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdTransferProtocolRevision|0x00000004|UINT32|0x0000000a
 115
 116 [UserExtensions.TianoCore."ExtraFiles"]
 117   SourceLevelDebugPkgExtra.uni