f6b3715426680ddf86eb2d0f48cdb7cb2085d257
[mirror_edk2.git] / Tools / XMLSchema / FDPManifest.xsd
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3 Filename: SurfaceArea.xsd
4
5 Copyright (c) 2006, Intel Corp.
6 All rights reserved. This program and the accompanying materials
7 are licensed and made available under the terms and conditions of the BSD License
8 which may be found at http://opensource.org/licenses/bsd-license.php
9
10 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
11 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
12
13 -->
14 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified"
15 targetNamespace="http://www.TianoCore.org/2006/Edk2.0"
16 xmlns="http://www.TianoCore.org/2006/Edk2.0">
17 <xs:annotation>
18 <xs:documentation xml:lang="en"> This schema defines FDP Manifest </xs:documentation>
19 </xs:annotation>
20 <!--<xs:include schemaLocation="http://nwlxweb02.jf.intel.com/2006/Edk2.0/FrameworkHeaders.xsd"/>-->
21 <xs:include schemaLocation="FrameworkDataElements.xsd"/>
22 <xs:element name="FrameworkDevPkgManifest">
23 <xs:annotation>
24 <xs:documentation xml:lang="en">At the top level of the Manifest we have four sections:
25 Header, Private, Public and Contents.</xs:documentation>
26 </xs:annotation>
27 <xs:complexType>
28 <xs:sequence>
29 <xs:element minOccurs="1" maxOccurs="1" ref="Header"/>
30 <xs:element minOccurs="0" maxOccurs="1" ref="Private"/>
31 <xs:element minOccurs="0" maxOccurs="1" ref="Public"/>
32 <xs:element minOccurs="1" maxOccurs="1" ref="Contents"/>
33 </xs:sequence>
34 </xs:complexType>
35 </xs:element>
36 <xs:element name="Header">
37 <xs:annotation>
38 <xs:documentation xml:lang="en"> The Header contains some three elements that can
39 uniquely identify this package (PackageName, Guid, Version) as well as several
40 fields that identify the licensing and compyright status of the contents of the
41 package. The rest of the fields are there to idenify who created the package and
42 when it was made. The buid fields are here to identify when the package was created,
43 not when the package was compiled. </xs:documentation>
44 </xs:annotation>
45 <xs:complexType>
46 <xs:sequence>
47 <xs:element minOccurs="1" maxOccurs="1" ref="PackageName"/>
48 <xs:element minOccurs="1" maxOccurs="1" ref="Guid"/>
49 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>
50 <xs:element minOccurs="0" maxOccurs="1" ref="Copyright"/>
51 <xs:element minOccurs="1" maxOccurs="1" ref="License"/>
52 <xs:element minOccurs="1" maxOccurs="1" name="PackageType" type="PackageType"/>
53 <xs:element minOccurs="1" maxOccurs="1" ref="Description"/>
54 <xs:element minOccurs="1" maxOccurs="1" ref="Created"/>
55 <xs:element minOccurs="0" maxOccurs="1" ref="Creator"/>
56 <xs:element minOccurs="0" maxOccurs="1" ref="Vendor"/>
57 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Updated"/>
58 <xs:element minOccurs="0" maxOccurs="unbounded" ref="Modifier"/>
59 <xs:element minOccurs="0" maxOccurs="unbounded" ref="DefaultInstallDir"/>
60 <xs:element minOccurs="0" maxOccurs="1" ref="BuildNumber"/>
61 <xs:element minOccurs="0" maxOccurs="unbounded" ref="BuildTarget"/>
62 <xs:element minOccurs="0" maxOccurs="1" ref="BuildSystem"/>
63 <xs:element minOccurs="0" maxOccurs="1" ref="BuildType"/>
64 <xs:element minOccurs="0" maxOccurs="1" ref="ReleaseType"/>
65 </xs:sequence>
66 </xs:complexType>
67 </xs:element>
68 <xs:element name="BuildNumber" type="xs:integer">
69 <xs:annotation>
70 <xs:documentation> The Build number is an integer that is meant to represent the exact
71 build of the package. </xs:documentation>
72 </xs:annotation>
73 </xs:element>
74 <xs:element name="Type">
75 <xs:annotation>
76 <xs:documentation> In the Type field we can record what kinds of modules are contained
77 in the package. The possibilities are source, binary and mixed (both source and
78 binary.) </xs:documentation>
79 </xs:annotation>
80 <xs:complexType>
81 <xs:attributeGroup ref="attlist.Type"/>
82 </xs:complexType>
83 </xs:element>
84 <xs:attributeGroup name="attlist.Type">
85 <xs:attribute name="Value" use="required">
86 <xs:simpleType>
87 <xs:restriction base="xs:token">
88 <xs:enumeration value="Source"/>
89 <xs:enumeration value="Binary"/>
90 <xs:enumeration value="Mixed"/>
91 </xs:restriction>
92 </xs:simpleType>
93 </xs:attribute>
94 </xs:attributeGroup>
95 <xs:attributeGroup name="attlist.Guid">
96 <xs:attribute name="Value" use="required" type="xs:NMTOKEN"/>
97 </xs:attributeGroup>
98 <xs:element name="BuildTarget" type="SupportedArchitectures">
99 <xs:annotation>
100 <xs:documentation> The build target is used to record what target architecture the
101 modules within this package were compiled for. </xs:documentation>
102 </xs:annotation>
103 </xs:element>
104 <xs:element name="Creator">
105 <xs:annotation>
106 <xs:documentation> In the creator field, we can record the name, user id, and email
107 address of the person who created this package. </xs:documentation>
108 </xs:annotation>
109 <xs:complexType>
110 <xs:attributeGroup ref="attlist.Creator"/>
111 </xs:complexType>
112 </xs:element>
113 <xs:attributeGroup name="attlist.Creator">
114 <xs:attribute name="Name" use="required"/>
115 <xs:attribute name="UserId"/>
116 <xs:attribute name="Email"/>
117 </xs:attributeGroup>
118 <xs:element name="Modifier">
119 <xs:annotation>
120 <xs:documentation> In the Modifier field, we can record the name, user id, and email
121 address of the person who changed/updated or modified this package.
122 </xs:documentation>
123 </xs:annotation>
124 <xs:complexType>
125 <xs:attributeGroup ref="attlist.Modifier"/>
126 </xs:complexType>
127 </xs:element>
128 <xs:attributeGroup name="attlist.Modifier">
129 <xs:attribute name="Name" use="required"/>
130 <xs:attribute name="UserId"/>
131 <xs:attribute name="Email"/>
132 </xs:attributeGroup>
133 <xs:element name="Vendor" type="xs:token">
134 <xs:annotation>
135 <xs:documentation> The name of the company, organization or individual that created or
136 distributes the package. </xs:documentation>
137 </xs:annotation>
138 </xs:element>
139 <xs:element name="BuildSystem">
140 <xs:annotation>
141 <xs:documentation>This is the place to record the name and DNS name of the computer on
142 which the package was created.</xs:documentation>
143 </xs:annotation>
144 <xs:complexType>
145 <xs:attributeGroup ref="attlist.BuildSystem"/>
146 </xs:complexType>
147 </xs:element>
148 <xs:attributeGroup name="attlist.BuildSystem">
149 <xs:attribute name="Name" use="required"/>
150 <xs:attribute name="NetAddr"/>
151 </xs:attributeGroup>
152 <xs:element name="BuildType">
153 <xs:annotation>
154 <xs:documentation> The package may be Debug or Production. </xs:documentation>
155 </xs:annotation>
156 <xs:simpleType>
157 <xs:restriction base="xs:token">
158 <xs:enumeration value="Debug"/>
159 <xs:enumeration value="Production"/>
160 </xs:restriction>
161 </xs:simpleType>
162 </xs:element>
163 <xs:element name="ReleaseType">
164 <xs:annotation>
165 <xs:documentation> We may identify the quality level of the package here.
166 </xs:documentation>
167 </xs:annotation>
168 <xs:simpleType>
169 <xs:restriction base="xs:token">
170 <xs:enumeration value="Developer Build"/>
171 <xs:enumeration value="Experimental Release"/>
172 <xs:enumeration value="Alpha Release"/>
173 <xs:enumeration value="Beta Release"/>
174 <xs:enumeration value="Release Canidate"/>
175 <xs:enumeration value="Official Release"/>
176 <xs:enumeration value="Patch Release"/>
177 <xs:enumeration value="Integration Build Release"/>
178 </xs:restriction>
179 </xs:simpleType>
180 </xs:element>
181 <xs:element name="DefaultInstallDir">
182 <xs:annotation>
183 <xs:documentation> This is the directory, relative to the root of the workspace, where
184 the package will be installed by default. </xs:documentation>
185 </xs:annotation>
186 <xs:complexType>
187 <xs:attributeGroup ref="attlist.DefaultInstallDir"/>
188 </xs:complexType>
189 </xs:element>
190 <xs:attributeGroup name="attlist.DefaultInstallDir">
191 <xs:attribute name="Name" use="required"/>
192 </xs:attributeGroup>
193 <xs:element name="Dependencies">
194 <xs:annotation>
195 <xs:documentation> We can track the pakages that this package provides (these are the
196 packages contained in this pacakge.) We also record which packages are required by
197 this package. </xs:documentation>
198 </xs:annotation>
199 <xs:complexType>
200 <xs:sequence>
201 <xs:element minOccurs="0" ref="Requires"/>
202 <xs:element minOccurs="0" ref="Provides"/>
203 </xs:sequence>
204 </xs:complexType>
205 </xs:element>
206 <xs:element name="Requires">
207 <xs:annotation>
208 <xs:documentation> This is a list of the packages that this package requires to be
209 installed in the workspace for package to function and/or build correctly. In the
210 case of source packages, these are the necessary dependencies for successful
211 build-time operation of the package. For binary packages these dependencies are
212 necessary for successful runtime operation.</xs:documentation>
213 </xs:annotation>
214 <xs:complexType mixed="true">
215 <xs:choice minOccurs="0" maxOccurs="unbounded">
216 <xs:element name="Package">
217 <xs:annotation>
218 <xs:documentation xml:lang="en">This tag is used in the Framework Package
219 Database File to track individual package information. The Path is a
220 relative path to the SPD File.</xs:documentation>
221 </xs:annotation>
222 <xs:complexType>
223 <xs:sequence maxOccurs="unbounded">
224 <xs:element minOccurs="0" maxOccurs="1" ref="PackageName"/>
225 <xs:element minOccurs="1" maxOccurs="1" ref="Guid"/>
226 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>
227 <xs:element minOccurs="1" maxOccurs="1" ref="Path"/>
228 <xs:element minOccurs="1" maxOccurs="1" ref="InstalledDate"/>
229 </xs:sequence>
230 <xs:attributeGroup ref="PackageAttributes"/>
231 </xs:complexType>
232 </xs:element>
233 <xs:element ref="Includes"/>
234 <xs:element name="Library">
235 <xs:complexType>
236 <xs:simpleContent>
237 <xs:extension base="BaseNameConvention">
238 <xs:attributeGroup ref="LibraryAttributes"/>
239 </xs:extension>
240 </xs:simpleContent>
241 </xs:complexType>
242 </xs:element>
243 <xs:element name="Protocol">
244 <xs:complexType>
245 <xs:simpleContent>
246 <xs:extension base="C_Name">
247 <xs:attributeGroup ref="ProtocolAttributes"/>
248 </xs:extension>
249 </xs:simpleContent>
250 </xs:complexType>
251 </xs:element>
252 <xs:element ref="Guid"/>
253 <xs:element ref="File"/>
254 </xs:choice>
255 </xs:complexType>
256 </xs:element>
257 <xs:element name="Provides">
258 <xs:annotation>
259 <xs:documentation>The list of dependencies that the package fulfills.</xs:documentation>
260 </xs:annotation>
261 <xs:complexType>
262 <xs:choice minOccurs="0" maxOccurs="unbounded">
263 <xs:element name="Package">
264 <xs:annotation>
265 <xs:documentation xml:lang="en">This tag is used in the Framework Package
266 Database File to track individual package information. The Path is a
267 relative path to the SPD File.</xs:documentation>
268 </xs:annotation>
269 <xs:complexType>
270 <xs:sequence maxOccurs="unbounded">
271 <xs:element minOccurs="0" maxOccurs="1" ref="PackageName"/>
272 <xs:element minOccurs="1" maxOccurs="1" ref="Guid"/>
273 <xs:element minOccurs="1" maxOccurs="1" ref="Version"/>
274 <xs:element minOccurs="1" maxOccurs="1" ref="Path"/>
275 <xs:element minOccurs="1" maxOccurs="1" ref="InstalledDate"/>
276 </xs:sequence>
277 <xs:attributeGroup ref="PackageAttributes"/>
278 </xs:complexType>
279 </xs:element>
280 <xs:element ref="Includes"/>
281 <xs:element name="Library">
282 <xs:annotation><xs:documentation>
283 A library. It can be provided by or required by this or other packages.
284 </xs:documentation></xs:annotation>
285 <xs:complexType>
286 <xs:simpleContent>
287 <xs:extension base="BaseNameConvention">
288 <xs:attributeGroup ref="LibraryAttributes"/>
289 </xs:extension>
290 </xs:simpleContent>
291 </xs:complexType>
292 </xs:element>
293 <xs:element name="Protocol">
294 <xs:annotation>
295 <xs:documentation>
296 A protocol. It can be provided by or required by this or other packages.
297 </xs:documentation>
298 </xs:annotation>
299 <xs:complexType>
300 <xs:simpleContent>
301 <xs:extension base="C_Name">
302 <xs:attributeGroup ref="ProtocolAttributes"/>
303 </xs:extension>
304 </xs:simpleContent>
305 </xs:complexType>
306 </xs:element>
307 <xs:element ref="Guid"/>
308 <xs:element ref="File"/>
309 </xs:choice>
310 </xs:complexType>
311 </xs:element>
312 <xs:attributeGroup name="attlist.Library">
313 <xs:attribute name="Name" use="required"/>
314 </xs:attributeGroup>
315 <xs:attributeGroup name="attlist.Protocol">
316 <xs:attribute name="Name" use="required"/>
317 <xs:attribute name="Guid" use="required" type="xs:NMTOKEN"/>
318 </xs:attributeGroup>
319 <xs:element name="Private">
320 <xs:annotation>
321 <xs:documentation> The Private section is a place where the files are listed that should
322 not be seen by the users of this package. </xs:documentation>
323 </xs:annotation>
324 <xs:complexType mixed="true">
325 <xs:sequence>
326 <xs:element minOccurs="0" maxOccurs="unbounded" ref="File"/>
327 </xs:sequence>
328 </xs:complexType>
329 </xs:element>
330 <xs:element name="Public">
331 <xs:annotation>
332 <xs:documentation> The Public section is a list of files that are meant to be seen by
333 the users of the package. </xs:documentation>
334 </xs:annotation>
335 <xs:complexType mixed="true">
336 <xs:sequence>
337 <xs:element minOccurs="0" maxOccurs="unbounded" ref="File"/>
338 </xs:sequence>
339 </xs:complexType>
340 </xs:element>
341 <xs:element name="Contents">
342 <xs:annotation>
343 <xs:documentation>This is a list of all the files within this package. Each file is
344 identified by its path relative to the workspace root.</xs:documentation>
345 </xs:annotation>
346 <xs:complexType>
347 <xs:sequence>
348 <xs:element maxOccurs="unbounded" ref="File"/>
349 </xs:sequence>
350 </xs:complexType>
351 </xs:element>
352 <xs:element name="File">
353 <xs:annotation>
354 <xs:documentation xml:lang="en">Specify a filename including the path</xs:documentation>
355 </xs:annotation>
356 <xs:complexType>
357 <xs:simpleContent>
358 <xs:extension base="xs:normalizedString">
359 <xs:attributeGroup ref="attlist.File"/>
360 </xs:extension>
361 </xs:simpleContent>
362 </xs:complexType>
363 </xs:element>
364 <xs:attributeGroup name="attlist.File">
365 <xs:attribute name="Type"/>
366 <xs:attribute name="Desc"/>
367 <xs:attribute name="Size" type="xs:NMTOKEN"/>
368 <xs:attribute name="CDate" type="xs:NMTOKEN"/>
369 <xs:attribute name="CTime" type="xs:NMTOKEN"/>
370 <xs:attribute name="MDate" type="xs:NMTOKEN"/>
371 <xs:attribute name="MTime" type="xs:NMTOKEN"/>
372 <xs:attribute name="ADate" type="xs:NMTOKEN"/>
373 <xs:attribute name="ATime" type="xs:NMTOKEN"/>
374 <xs:attribute name="Checksum" type="xs:NMTOKEN"/>
375 </xs:attributeGroup>
376 </xs:schema>