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