SourceLevelDebugPkg.dec 6.3 KB

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