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