SourceLevelDebugPkg: Use Pcd for the revision of transfer protocol

[mirror_edk2.git] / SourceLevelDebugPkg / SourceLevelDebugPkg.dec

## @file  SourceLevelDebugPkg.dec\r
# This package provides target side modules to support source level debug.\r
# The target side components includes the Debug Agent Library instance\r
# to communicate with host side modules, Debug Communication Library and\r
# instances to provide the communication I/O functions between Debug Agent\r
# and host, PeCoffExtraActionLib instance to report symbol path information,\r
# etc.\r
#\r
# Copyright (c) 2010 - 2017, 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
\r
[Defines]\r
  DEC_SPECIFICATION              = 0x00010005\r
  PACKAGE_NAME                   = SourceLevelDebugPkg\r
  PACKAGE_UNI_FILE               = SourceLevelDebugPkg.uni\r
  PACKAGE_GUID                   = DBF00C27-D8D7-443d-918B-4E85CDA1373B\r
  PACKAGE_VERSION                = 0.96\r
\r
[Includes]\r
  Include\r
\r
[Includes.IA32]\r
  Include/Ia32\r
\r
[Includes.X64]\r
  Include/Ia32\r
\r
[LibraryClasses]\r
  ##  @libraryclass  Provides communication I/O functions between Debug Agent and HOST.\r
  ##\r
  DebugCommunicationLib|Include/Library/DebugCommunicationLib.h\r
\r
[Guids]\r
  ## MdeModule package token space guid\r
  # Include/Guid/DebugAgentGuid.h\r
  gEfiDebugAgentGuid       = {0x865a5a9b, 0xb85d, 0x474c, { 0x84, 0x55, 0x65, 0xd1, 0xbe, 0x84, 0x4b, 0xe2 }}\r
  gEfiSourceLevelDebugPkgTokenSpaceGuid = {0x865a5aab, 0xb85d, 0x474c, { 0x84, 0x55, 0x65, 0xd1, 0xbe, 0x84, 0x4b, 0xe2 }}\r
\r
#\r
# [Error.gEfiSourceLevelDebugPkgTokenSpaceGuid]\r
#   0x80000001 | Invalid value provided.\r
#\r
\r
[PcdsFixedAtBuild, PcdsPatchableInModule]\r
  ## The memory BAR of usb debug port, it may be different with the memory bar of ehci host controller.\r
  #  Note that the memory BAR address is only used before Pci bus resource allocation.\r
  # @Prompt Configure usb debug port memory BAR.\r
  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbDebugPortMemorySpaceBase|0xd0000000|UINT32|0x00000001\r
\r
  ## The memory BAR of ehci host controller, in which usb debug feature is enabled.\r
  #  Note that the memory BAR address is only used before Pci bus resource allocation.\r
  # @Prompt Configure ehci host controller memory BAR.\r
  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciMemorySpaceBase|0xd0000000|UINT32|0x00000002\r
\r
  ## The pci address of ehci host controller, in which usb debug feature is enabled.\r
  #  The format of pci address is :<BR>\r
  #      -----------------------------------------------------------------------<BR>\r
  #      | Bits 28..31 | Bits 20..27 | Bits 15..19 | Bits 12..14 | Bits 00..11 |<BR>\r
  #      -----------------------------------------------------------------------<BR>\r
  #      |      0      |     Bus     |   Device    |   Function  |      0      |<BR>\r
  #      -----------------------------------------------------------------------<BR>\r
  #  For the value 0x000EF000, it means the pci address at bus 0x0, device 0x1D, function 0x7.\r
  # @Prompt Configure ehci host controller pci address.\r
  # @Expression  0x80000001 | (gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciPciAddress & 0xF0000FFF) == 0\r
  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciPciAddress|0x000EF000|UINT32|0x00000003\r
\r
  ## The mask of exception numbers whose handlers would be ignored and cannot be replaced or \r
  #  hooked by Debug Agent Library. Masking INT1/INT3 is invalid.\r
  # @Prompt Configure exception numbers not to be hooked by Debug Agent.\r
  # @Expression  0x80000001 | (gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger & 0xA) == 0\r
  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger|0x00000000|UINT32|0x00000004\r
\r
  ## The method to issue break point to Debug Agent Library when Loading/UnLoading image.<BR><BR>\r
  #  1: Use I/O Port 84 to issue hardware break point<BR>\r
  #  2: Use INT3 to issue software break point<BR>\r
  # @Prompt Configure Loading/UnLoading image break method.\r
  # @ValidRange  0x80000001 | 1 - 2\r
  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugLoadImageMethod|0x1|UINT8|0x00000005\r
\r
  ## The data buffer size used by debug port in debug communication library instances.\r
  #  Its value is not suggested to be changed in platform DSC file.\r
  # @Prompt Assign debug port buffer size.\r
  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize|0x0|UINT16|0x00000006\r
\r
  ## The memory BAR of xhci host controller, in which usb debug feature is enabled.\r
  ## Note that the memory BAR address is only used before Pci bus resource allocation.\r
  # @Prompt Configure ehci host controller memory BAR.\r
  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciMemorySpaceBase|0xD0000000|UINT64|0x00000007\r
  \r
  ## The pci address of xhci host controller, in which usb debug feature is enabled.\r
  #  The format of pci address is :<BR>\r
  #      -----------------------------------------------------------------------<BR>\r
  #      | Bits 28..31 | Bits 20..27 | Bits 15..19 | Bits 12..14 | Bits 00..11 |<BR>\r
  #      -----------------------------------------------------------------------<BR>\r
  #      |      0      |     Bus     |   Device    |   Function  |      0      |<BR>\r
  #      -----------------------------------------------------------------------<BR>\r
  #  For the value 0x000A0000, it means the pci address at bus 0x0, device 0x14, function 0x0.\r
  # @Prompt Configure xhci host controller pci address.\r
  # @Expression  0x80000001 | (gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciPciAddress & 0xF0000FFF) == 0\r
  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciPciAddress|0x000A0000|UINT32|0x00000008\r
  \r
  ## Per XHCI spec, software shall impose a timeout between the detection of the Debug Host \r
  ## connection and the DbC Run transition to 1. This PCD specifies the timeout value in microsecond.\r
  # @Prompt Configure debug device detection timeout value.\r
  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciDebugDetectTimeout|3000000|UINT64|0x00000009\r
\r
  ## Default revision of the debug agent transfer protocol.\r
  #  The upper 16 bits indicate the major revision and the lower 16 bits indicate the minor revision.\r
  #  For example, a value of 0x00000004 stands for revision 0.4.\r
  #  Debug packet compression and decompression is supported since revision 0.4.\r
  # @Prompt Default revision of the debug agent transfer protocol.\r
  gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdTransferProtocolRevision|0x00000004|UINT32|0x0000000a\r
\r
[UserExtensions.TianoCore."ExtraFiles"]\r
  SourceLevelDebugPkgExtra.uni\r