BaseTools/BinToPcd: Fix Python 2.7.x compatibility issue
[mirror_edk2.git] / SourceLevelDebugPkg / SourceLevelDebugPkg.dec
CommitLineData
18b144ea 1## @file SourceLevelDebugPkg.dec\r
18b144ea 2# This package provides target side modules to support source level debug.\r
3# The target side components includes the Debug Agent Library instance\r
4# to communicate with host side modules, Debug Communication Library and\r
5# instances to provide the communication I/O functions between Debug Agent\r
6# and host, PeCoffExtraActionLib instance to report symbol path information,\r
7# etc.\r
8#\r
f4043414 9# Copyright (c) 2010 - 2018, Intel Corporation. All rights reserved.<BR>\r
77695f4d
LG
10# This program and the accompanying materials are licensed and made available under\r
11# the terms and conditions of the BSD License that accompanies this distribution.\r
18b144ea 12# The full text of the license may be found at\r
77695f4d
LG
13# http://opensource.org/licenses/bsd-license.php.\r
14#\r
15# THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
16# WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
18b144ea 17#\r
18##\r
19\r
20[Defines]\r
21 DEC_SPECIFICATION = 0x00010005\r
894c9c6e 22 PACKAGE_NAME = SourceLevelDebugPkg\r
865ef843 23 PACKAGE_UNI_FILE = SourceLevelDebugPkg.uni\r
18b144ea 24 PACKAGE_GUID = DBF00C27-D8D7-443d-918B-4E85CDA1373B\r
29b3a749 25 PACKAGE_VERSION = 0.96\r
18b144ea 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
865ef843
LG
47#\r
48# [Error.gEfiSourceLevelDebugPkgTokenSpaceGuid]\r
49# 0x80000001 | Invalid value provided.\r
50#\r
51\r
18b144ea 52[PcdsFixedAtBuild, PcdsPatchableInModule]\r
53 ## The memory BAR of usb debug port, it may be different with the memory bar of ehci host controller.\r
865ef843
LG
54 # Note that the memory BAR address is only used before Pci bus resource allocation.\r
55 # @Prompt Configure usb debug port memory BAR.\r
18b144ea 56 gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbDebugPortMemorySpaceBase|0xd0000000|UINT32|0x00000001\r
57\r
58 ## The memory BAR of ehci host controller, in which usb debug feature is enabled.\r
865ef843
LG
59 # Note that the memory BAR address is only used before Pci bus resource allocation.\r
60 # @Prompt Configure ehci host controller memory BAR.\r
18b144ea 61 gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciMemorySpaceBase|0xd0000000|UINT32|0x00000002\r
62\r
63 ## The pci address of ehci host controller, in which usb debug feature is enabled.\r
865ef843
LG
64 # The format of pci address is :<BR>\r
65 # -----------------------------------------------------------------------<BR>\r
66 # | Bits 28..31 | Bits 20..27 | Bits 15..19 | Bits 12..14 | Bits 00..11 |<BR>\r
67 # -----------------------------------------------------------------------<BR>\r
68 # | 0 | Bus | Device | Function | 0 |<BR>\r
69 # -----------------------------------------------------------------------<BR>\r
70 # For the value 0x000EF000, it means the pci address at bus 0x0, device 0x1D, function 0x7.\r
71 # @Prompt Configure ehci host controller pci address.\r
72 # @Expression 0x80000001 | (gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciPciAddress & 0xF0000FFF) == 0\r
18b144ea 73 gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbEhciPciAddress|0x000EF000|UINT32|0x00000003\r
74\r
77695f4d 75 ## The mask of exception numbers whose handlers would be ignored and cannot be replaced or\r
865ef843
LG
76 # hooked by Debug Agent Library. Masking INT1/INT3 is invalid.\r
77 # @Prompt Configure exception numbers not to be hooked by Debug Agent.\r
78 # @Expression 0x80000001 | (gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger & 0xA) == 0\r
18b144ea 79 gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdExceptionsIgnoredByDebugger|0x00000000|UINT32|0x00000004\r
80\r
865ef843
LG
81 ## The method to issue break point to Debug Agent Library when Loading/UnLoading image.<BR><BR>\r
82 # 1: Use I/O Port 84 to issue hardware break point<BR>\r
83 # 2: Use INT3 to issue software break point<BR>\r
84 # @Prompt Configure Loading/UnLoading image break method.\r
85 # @ValidRange 0x80000001 | 1 - 2\r
18b144ea 86 gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugLoadImageMethod|0x1|UINT8|0x00000005\r
b422b62c 87\r
865ef843
LG
88 ## The data buffer size used by debug port in debug communication library instances.\r
89 # Its value is not suggested to be changed in platform DSC file.\r
90 # @Prompt Assign debug port buffer size.\r
b422b62c 91 gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdDebugPortHandleBufferSize|0x0|UINT16|0x00000006\r
92\r
2cb6eabe
EL
93 ## The memory BAR of xhci host controller, in which usb debug feature is enabled.\r
94 ## Note that the memory BAR address is only used before Pci bus resource allocation.\r
f4043414 95 # @Prompt Configure xhci host controller memory BAR.\r
2cb6eabe 96 gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciMemorySpaceBase|0xD0000000|UINT64|0x00000007\r
77695f4d 97\r
2cb6eabe
EL
98 ## The pci address of xhci host controller, in which usb debug feature is enabled.\r
99 # The format of pci address is :<BR>\r
100 # -----------------------------------------------------------------------<BR>\r
101 # | Bits 28..31 | Bits 20..27 | Bits 15..19 | Bits 12..14 | Bits 00..11 |<BR>\r
102 # -----------------------------------------------------------------------<BR>\r
103 # | 0 | Bus | Device | Function | 0 |<BR>\r
104 # -----------------------------------------------------------------------<BR>\r
105 # For the value 0x000A0000, it means the pci address at bus 0x0, device 0x14, function 0x0.\r
106 # @Prompt Configure xhci host controller pci address.\r
107 # @Expression 0x80000001 | (gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciPciAddress & 0xF0000FFF) == 0\r
108 gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciPciAddress|0x000A0000|UINT32|0x00000008\r
77695f4d
LG
109\r
110 ## Per XHCI spec, software shall impose a timeout between the detection of the Debug Host\r
2cb6eabe
EL
111 ## connection and the DbC Run transition to 1. This PCD specifies the timeout value in microsecond.\r
112 # @Prompt Configure debug device detection timeout value.\r
113 gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdUsbXhciDebugDetectTimeout|3000000|UINT64|0x00000009\r
114\r
c00ad623
HW
115 ## Default revision of the debug agent transfer protocol.\r
116 # The upper 16 bits indicate the major revision and the lower 16 bits indicate the minor revision.\r
117 # For example, a value of 0x00000004 stands for revision 0.4.\r
118 # Debug packet compression and decompression is supported since revision 0.4.\r
119 # @Prompt Default revision of the debug agent transfer protocol.\r
120 gEfiSourceLevelDebugPkgTokenSpaceGuid.PcdTransferProtocolRevision|0x00000004|UINT32|0x0000000a\r
121\r
865ef843
LG
122[UserExtensions.TianoCore."ExtraFiles"]\r
123 SourceLevelDebugPkgExtra.uni\r