Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / d45d2d0f40413ca91af7fdc2f08b71f2bd828825 / . / static / redfish / v1 / schema / AccelerationFunction_v1.xml
blob: 50a7066da835bb1b547e53238cbce07e1325caf3 [file] [log] [blame]
Marri Devender Raod45d2d02019-01-21 10:11:34 -0600[diff] [blame^]1<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
4<!--# Redfish Schema: AccelerationFunction v1.0.0-->
5<!--# -->
6<!--# For a detailed change log, see the README file contained in the DSP8010 bundle, -->
7<!--# available at http://www.dmtf.org/standards/redfish -->
8<!--# Copyright 2014-2018 DMTF. -->
9<!--# For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright -->
10<!--################################################################################ -->
11<!---->
12<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
13
14 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
15 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData"/>
16 </edmx:Reference>
17 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Capabilities.V1.xml">
18 <edmx:Include Namespace="Org.OData.Capabilities.V1" Alias="Capabilities"/>
19 </edmx:Reference>
20 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Measures.V1.xml">
21 <edmx:Include Namespace="Org.OData.Measures.V1" Alias="Measures"/>
22 </edmx:Reference>
23 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
24 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
25 </edmx:Reference>
26 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
27 <edmx:Include Namespace="Resource"/>
28 <edmx:Include Namespace="Resource.v1_0_0"/>
29 </edmx:Reference>
30 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Endpoint_v1.xml">
31 <edmx:Include Namespace="Endpoint"/>
32 </edmx:Reference>
33 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/PCIeFunction_v1.xml">
34 <edmx:Include Namespace="PCIeFunction"/>
35 </edmx:Reference>
36
37 <edmx:DataServices>
38
39 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccelerationFunction">
40 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
41
42 <EntityType Name="AccelerationFunction" BaseType="Resource.v1_0_0.Resource" Abstract="true">
43 <Annotation Term="OData.Description" String="The AccelerationFunction schema defines the accelerator implemented in a Processor device."/>
44 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent the acceleration function, implemented in a Processor, in a Redfish implementation."/>
45 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
46 <Annotation Term="Capabilities.InsertRestrictions">
47 <Record>
48 <PropertyValue Property="Insertable" Bool="false"/>
49 </Record>
50 </Annotation>
51 <Annotation Term="Capabilities.UpdateRestrictions">
52 <Record>
53 <PropertyValue Property="Updatable" Bool="false"/>
54 </Record>
55 </Annotation>
56 <Annotation Term="Capabilities.DeleteRestrictions">
57 <Record>
58 <PropertyValue Property="Deletable" Bool="false"/>
59 </Record>
60 </Annotation>
61 <Annotation Term="Redfish.Uris">
62 <Collection>
63 <String>/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/AccelerationFunctions/{AccelerationFunctionId}</String>
64 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/AccelerationFunctions/{AccelerationFunctionId}</String>
65 <String>/redfish/v1/CompositionService/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/AccelerationFunctions/{AccelerationFunctionId}</String>
66 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Processors/{ProcessorId}/AccelerationFunctions/{AccelerationFunctionId}</String>
67 <String>/redfish/v1/ResourceBlocks/{ResourceBlockId}/Systems/{ComputerSystemId}/Processors/{ProcessorId}/AccelerationFunctions/{AccelerationFunctionId}</String>
68 </Collection>
69 </Annotation>
70 </EntityType>
71 </Schema>
72
73 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="AccelerationFunction.v1_0_0">
74 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
75 <Annotation Term="Redfish.Release" String="2018.3"/>
76
77 <EntityType Name="AccelerationFunction" BaseType="AccelerationFunction.AccelerationFunction">
78 <Property Name="Status" Type="Resource.Status" Nullable="false">
79 <Annotation Term="OData.Description" String="This property describes the status and health of the resource and its children."/>
80 <Annotation Term="OData.LongDescription" String="This property shall contain any status or health properties of the resource."/>
81 </Property>
82 <Property Name="UUID" Type="Resource.UUID">
83 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
84 <Annotation Term="OData.Description" String="The universal unique identifier (UUID) for this acceleration function."/>
85 <Annotation Term="OData.LongDescription" String="The value of this property shall be used to contain a universal unique identifier number for the acceleration function. RFC4122 describes methods that can be used to create the value. The value should be considered to be opaque. Client software should only treat the overall value as a universally unique identifier and should not interpret any sub-fields within the UUID."/>
86 </Property>
87 <Property Name="FpgaReconfigurationSlots" Type="Collection(Edm.String)" Nullable="false">
88 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
89 <Annotation Term="OData.Description" String="An array of the reconfiguration slot identifiers for an FPGA."/>
90 <Annotation Term="OData.LongDescription" String="The value of this property shall be an array of the FPGA reconfiguration slots identifiers that this acceleration function occupies."/>
91 </Property>
92 <Property Name="AccelerationFunctionType" Type="AccelerationFunction.v1_0_0.AccelerationFunctionType">
93 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
94 <Annotation Term="OData.Description" String="The type of acceleration function."/>
95 <Annotation Term="OData.LongDescription" String="This property shall contain the string which identifies the type of acceleration function."/>
96 </Property>
97 <Property Name="Manufacturer" Type="Edm.String" Nullable="false">
98 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
99 <Annotation Term="OData.Description" String="The acceleration function code manufacturer."/>
100 <Annotation Term="OData.LongDescription" String="This property shall contain a string which identifies the manufacturer of the acceleration function."/>
101 </Property>
102 <Property Name="Version" Type="Edm.String" Nullable="false">
103 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
104 <Annotation Term="OData.Description" String="The acceleration function version."/>
105 <Annotation Term="OData.LongDescription" String="The value of this property shall contain a string decsribing the acceleration function version."/>
106 </Property>
107 <Property Name="PowerWatts" Type="Edm.Int64" Nullable="false">
108 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
109 <Annotation Term="OData.Description" String="The acceleration function power consumption."/>
110 <Annotation Term="OData.LongDescription" String="The total acceleration function power consumtion in watts."/>
111 <Annotation Term="Measures.Unit" String="W"/>
112 </Property>
113 <Property Name="Links" Type="AccelerationFunction.v1_0_0.Links" Nullable="false">
114 <Annotation Term="OData.Description" String="Contains references to other resources that are related to this resource."/>
115 <Annotation Term="OData.LongDescription" String="The Links property, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource."/>
116 </Property>
117 <Property Name="Actions" Type="AccelerationFunction.v1_0_0.Actions" Nullable="false">
118 <Annotation Term="OData.Description" String="The available actions for this resource."/>
119 <Annotation Term="OData.LongDescription" String="The Actions property shall contain the available actions for this resource."/>
120 </Property>
121 </EntityType>
122
123 <ComplexType Name="Links" BaseType="Resource.Links">
124 <Annotation Term="OData.Description" String="Contains references to other resources that are related to this resource."/>
125 <Annotation Term="OData.LongDescription" String="This type, as described by the Redfish Specification, shall contain references to resources that are related to, but not contained by (subordinate to), this resource."/>
126 <NavigationProperty Name="Endpoints" Type="Collection(Endpoint.Endpoint)">
127 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
128 <Annotation Term="OData.Description" String="An array of references to the endpoints that connect to this acceleartion function."/>
129 <Annotation Term="OData.LongDescription" String="The value of this property shall be an array of references to resources of type Endpoint that are associated with this acceleration function."/>
130 <Annotation Term="OData.AutoExpandReferences"/>
131 </NavigationProperty>
132 <NavigationProperty Name="PCIeFunctions" Type="Collection(PCIeFunction.PCIeFunction)">
133 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
134 <Annotation Term="OData.Description" String="An array of references to the PCIeFunctions associated with this acceleration function."/>
135 <Annotation Term="OData.LongDescription" String="The value of this property shall be an array of references of type PCIeFunction that represent the PCI-e Functions associated with this acceleration function."/>
136 <Annotation Term="OData.AutoExpandReferences"/>
137 </NavigationProperty>
138 </ComplexType>
139
140 <ComplexType Name="Actions">
141 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
142 <Annotation Term="OData.Description" String="The available actions for this resource."/>
143 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
144 <Property Name="Oem" Type="AccelerationFunction.v1_0_0.OemActions" Nullable="false">
145 <Annotation Term="OData.Description" String="This property contains the available OEM specific actions for this resource."/>
146 <Annotation Term="OData.LongDescription" String="This property shall contain any additional OEM actions for this resource."/>
147 </Property>
148 </ComplexType>
149
150 <ComplexType Name="OemActions">
151 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
152 <Annotation Term="OData.Description" String="The available OEM specific actions for this resource."/>
153 <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/>
154 </ComplexType>
155
156 <EnumType Name="AccelerationFunctionType">
157 <Member Name="Encryption">
158 <Annotation Term="OData.Description" String="An encryption function."/>
159 </Member>
160 <Member Name="Compression">
161 <Annotation Term="OData.Description" String="A compression function."/>
162 </Member>
163 <Member Name="PacketInspection">
164 <Annotation Term="OData.Description" String="A packet inspection function."/>
165 </Member>
166 <Member Name="PacketSwitch">
167 <Annotation Term="OData.Description" String="A packet switch function."/>
168 </Member>
169 <Member Name="Scheduler">
170 <Annotation Term="OData.Description" String="A scheduler function."/>
171 </Member>
172 <Member Name="AudioProcessing">
173 <Annotation Term="OData.Description" String="An audio processing function."/>
174 </Member>
175 <Member Name="VideoProcessing">
176 <Annotation Term="OData.Description" String="A video processing function."/>
177 </Member>
178 <Member Name="OEM">
179 <Annotation Term="OData.Description" String="An OEM-defined acceleration function."/>
180 </Member>
181 </EnumType>
182 </Schema>
183
184 </edmx:DataServices>
185</edmx:Edmx>