SourceLevelDebugPkg/SourceLevelDebugPkg.dec

   1 ## @file  SourceLevelDebugPkg.dec
   2 #
   3 # This package provides target side modules to support source level debug.
   4 # The target side components includes the Debug Agent Library instance
   5 # to communicate with host side modules, Debug Communication Library and
   6 # instances to provide the communication I/O functions between Debug Agent
   7 # and host, PeCoffExtraActionLib instance to report symbol path information,
   8 # etc.
   9 #
  10 # Copyright (c) 2010 - 2014, Intel Corporation. All rights reserved.<BR>
  11 # This program and the accompanying materials are licensed and made available under
  12 # the terms and conditions of the BSD License that accompanies this distribution.
  13 # The full text of the license may be found at
  14 # http://opensource.org/licenses/bsd-license.php.
  15 #
  16 # THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  17 # WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  18 #
  19 ##
  20
  21 [Defines]
  22   DEC_SPECIFICATION              = 0x00010005
  23   PACKAGE_NAME                   = SourceLevelDebugPkg
  24   PACKAGE_UNI_FILE               = SourceLevelDebugPkg.uni
  25   PACKAGE_GUID                   = DBF00C27-D8D7-443d-918B-4E85CDA1373B
  26   PACKAGE_VERSION                = 0.86
  27
  28 [Includes]
  29   Include
  30
  31 [Includes.IA32]
  32   Include/Ia32
  33
  34 [Includes.X64]
  35   Include/Ia32
  36
  37 [LibraryClasses]
  38   ##  @libraryclass  Provides communication I/O functions between Debug Agent and HOST.
  39   ##
  40   DebugCommunicationLib|Include/Library/DebugCommunicationLib.h
  41
  42 [Guids]
  43   ## MdeModule package token space guid
  44   # Include/Guid/DebugAgentGuid.h
  45   gEfiDebugAgentGuid       = {0x865a5a9b, 0xb85d, 0x474c, { 0x84, 0x55, 0x65, 0xd1, 0xbe, 0x84, 0x4b, 0xe2 }}
  46   gEfiSourceLevelDebugPkgTokenSpaceGuid = {0x865a5aab, 0xb85d, 0x474c, { 0x84, 0x55, 0x65, 0xd1, 0xbe, 0x84, 0x4b, 0xe2 }}
  47
  48 #
  49 # [Error.gEfiSourceLevelDebugPkgTokenSpaceGuid]
  50 #   0x80000001 | Invalid value provided.
  51 #
  52
  53 [PcdsFixedAtBuild, PcdsPatchableInModule]
  54   ## The memory BAR of usb debug port, it may be different with the memory bar of ehci host controller.
  55   #  Note that the memory BAR address is only used before Pci bus resource allocation.
  56   # @Prompt Configure usb debug port memory BAR.
  57   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbDebugPortMemorySpaceBase|0xd0000000|UINT32|0x00000001
  58
  59   ## The memory BAR of ehci host controller, in which usb debug feature is enabled.
  60   #  Note that the memory BAR address is only used before Pci bus resource allocation.
  61   # @Prompt Configure ehci host controller memory BAR.
  62   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciMemorySpaceBase|0xd0000000|UINT32|0x00000002
  63
  64   ## The pci address of ehci host controller, in which usb debug feature is enabled.
  65   #  The format of pci address is :<BR>
  66   #      -----------------------------------------------------------------------<BR>
  67   #      | Bits 28..31 | Bits 20..27 | Bits 15..19 | Bits 12..14 | Bits 00..11 |<BR>
  68   #      -----------------------------------------------------------------------<BR>
  69   #      |      0      |     Bus     |   Device    |   Function  |      0      |<BR>
  70   #      -----------------------------------------------------------------------<BR>
  71   #  For the value 0x000EF000, it means the pci address at bus 0x0, device 0x1D, function 0x7.
  72   # @Prompt Configure ehci host controller pci address.
  73   # @Expression  0x80000001 | (gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciPciAddress & 0xF0000FFF) == 0
  74   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciPciAddress|0x000EF000|UINT32|0x00000003
  75
  76   ## The mask of exception numbers whose handlers would be ignored and cannot be replaced or
  77   #  hooked by Debug Agent Library. Masking INT1/INT3 is invalid.
  78   # @Prompt Configure exception numbers not to be hooked by Debug Agent.
  79   # @Expression  0x80000001 | (gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger & 0xA) == 0
  80   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger|0x00000000|UINT32|0x00000004
  81
  82   ## The method to issue break point to Debug Agent Library when Loading/UnLoading image.<BR><BR>
  83   #  1: Use I/O Port 84 to issue hardware break point<BR>
  84   #  2: Use INT3 to issue software break point<BR>
  85   # @Prompt Configure Loading/UnLoading image break method.
  86   # @ValidRange  0x80000001 | 1 - 2
  87   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugLoadImageMethod|0x1|UINT8|0x00000005
  88
  89   ## The data buffer size used by debug port in debug communication library instances.
  90   #  Its value is not suggested to be changed in platform DSC file.
  91   # @Prompt Assign debug port buffer size.
  92   gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize|0x0|UINT16|0x00000006
  93
  94 [UserExtensions.TianoCore."ExtraFiles"]
  95   SourceLevelDebugPkgExtra.uni