Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / af8f791296511553e11643d0bbbd80dfe9cd30e3 / . / static / redfish / v1 / schema / OemManager_v1.xml
blob: 164f2728b3371e7528430a27d2a3059215dbe2c2 [file] [log] [blame]
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
2<edmx:Edmx xmlns:edmx="http://docs.oasis-open.org/odata/ns/edmx" Version="4.0">
3 <edmx:Reference Uri="http://docs.oasis-open.org/odata/odata/v4.0/errata03/csd01/complete/vocabularies/Org.OData.Core.V1.xml">
4 <edmx:Include Namespace="Org.OData.Core.V1" Alias="OData" />
5 </edmx:Reference>
6 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
7 <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
8 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
9 </edmx:Reference>
10 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Manager_v1.xml">
11 <edmx:Include Namespace="Manager"/>
12 <edmx:Include Namespace="Manager.v1_4_0"/>
13 </edmx:Reference>
14 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
15 <edmx:Include Namespace="Resource"/>
16 <edmx:Include Namespace="Resource.v1_0_0"/>
17 </edmx:Reference>
18 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Chassis_v1.xml">
19 <edmx:Include Namespace="Chassis"/>
20 </edmx:Reference>
21
22 <edmx:DataServices>
23 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="OemManager">
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]24 <ComplexType Name="Oem" BaseType="Resource.OemObject">
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]25 <Annotation Term="OData.AdditionalProperties" Bool="true" />
26 <Annotation Term="OData.Description" String="OemManager Oem properties." />
27 <Annotation Term="OData.AutoExpand"/>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]28 <Property Name="OpenBmc" Type="OemManager.OpenBmc"/>
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]29 </ComplexType>
30
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]31 <ComplexType Name="OpenBmc">
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]32 <Annotation Term="OData.AdditionalProperties" Bool="true" />
33 <Annotation Term="OData.Description" String="Oem properties for OpenBmc." />
34 <Annotation Term="OData.AutoExpand"/>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]35 <Property Name="Fan" Type="OemManager.Fan"/>
36 </ComplexType>
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]37
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]38 <ComplexType Name="Fan">
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]39 <Annotation Term="OData.AdditionalProperties" Bool="true" />
40 <Annotation Term="OData.Description" String="OpenBmc oem fan properties." />
41 <Annotation Term="OData.AutoExpand"/>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]42 <Property Name="FanControllers" Type="OemManager.FanControllers"/>
43 <Property Name="PidControllers" Type="OemManager.PidControllers"/>
44 <Property Name="StepwiseControllers" Type="OemManager.StepwiseControllers"/>
45 <Property Name="FanZones" Type="OemManager.FanZones"/>
46 <Property Name="Profile" Type="Edm.String">
47 <Annotation Term="OData.Description" String="Current thermal profile."/>
48 <Annotation Term="OData.LongDescription" String="Current thermal profile."/>
49 </Property>
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]50
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]51 </ComplexType>
52
53 <ComplexType Name="FanControllers" BaseType="Resource.OemObject">
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]54 <Annotation Term="OData.AdditionalProperties" Bool="true" />
55 <Annotation Term="OData.Description" String="OpenBmc FanControllers." />
56 <Annotation Term="OData.LongDescription" String="Container for OpenBmc fan controllers." />
57 <Annotation Term="Redfish.DynamicPropertyPatterns">
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]58 <Collection>
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]59 <NavigationProperty Type="OemManager.FanController">
60 <Annotation Term="OData.AutoExpand"/>
61 <PropertyValue Property="Pattern" String="[A-Za-z0-9_.:]+" />
62 <PropertyValue Property="Type" String="OemManager.FanController" />
63 </NavigationProperty>
64 </Collection>
65 </Annotation>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]66 </ComplexType>
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]67
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]68 <ComplexType Name="PidControllers" BaseType="Resource.OemObject">
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]69 <Annotation Term="OData.AdditionalProperties" Bool="true" />
70 <Annotation Term="OData.Description" String="OpenBmc PidControllers." />
71 <Annotation Term="OData.LongDescription" String="Container for OpenBmc pid controllers." />
72 <Annotation Term="Redfish.DynamicPropertyPatterns">
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]73 <Collection>
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]74 <NavigationProperty>
75 <Annotation Term="OData.AutoExpand"/>
76 <PropertyValue Property="Pattern" String="[A-Za-z0-9_.:]+" />
77 <PropertyValue Property="Type" String="OemManager.PidController" />
78 </NavigationProperty>
79 </Collection>
80 </Annotation>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]81 </ComplexType>
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]82
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]83 <ComplexType Name="StepwiseControllers" BaseType="Resource.OemObject">
James Feistbaa5c142018-12-12 17:28:36 -0800[diff] [blame]84 <Annotation Term="OData.AdditionalProperties" Bool="true" />
85 <Annotation Term="OData.Description" String="OpenBmc StepwiseControllers." />
86 <Annotation Term="OData.LongDescription" String="Container for OpenBmc Stepwise controllers." />
87 <Annotation Term="Redfish.DynamicPropertyPatterns">
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]88 <Collection>
James Feistbaa5c142018-12-12 17:28:36 -0800[diff] [blame]89 <NavigationProperty>
90 <Annotation Term="OData.AutoExpand"/>
91 <PropertyValue Property="Pattern" String="[A-Za-z0-9_.:]+" />
92 <PropertyValue Property="Type" String="OemManager.StepwiseController" />
93 </NavigationProperty>
94 </Collection>
95 </Annotation>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]96 </ComplexType>
James Feistbaa5c142018-12-12 17:28:36 -0800[diff] [blame]97
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]98 <ComplexType Name="FanZones" BaseType="Resource.OemObject">
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]99 <Annotation Term="OData.AdditionalProperties" Bool="true" />
100 <Annotation Term="OData.Description" String="OpenBmc FanZones." />
101 <Annotation Term="OData.LongDescription" String="Container for OpenBmc fan zones." />
102 <Annotation Term="Redfish.DynamicPropertyPatterns">
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]103 <Collection>
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]104 <NavigationProperty>
105 <Annotation Term="OData.AutoExpand"/>
106 <PropertyValue Property="Pattern" String="[A-Za-z0-9_.:]+" />
107 <PropertyValue Property="Type" String="OemManager.FanZone" />
108 </NavigationProperty>
109 </Collection>
110 </Annotation>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]111 </ComplexType>
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]112
113 <ComplexType Name="FanController" BaseType="Resource.OemObject">
114 <Annotation Term="OData.AdditionalProperties" Bool="false" />
115 <Annotation Term="OData.Description" String="Configuration data for Fan Controllers." />
116 <Property Name="FFGainCoefficient" Type="Edm.Decimal" Nullable="false">
117 <Annotation Term="OData.Description" String="Feed forward gain coefficent for the PID." />
118 <Annotation Term="OData.LongDescription" String="Feed forward gain coefficent for the PID." />
119 </Property>
120 <Property Name="FFOffCoefficient" Type="Edm.Decimal" Nullable="false">
121 <Annotation Term="OData.Description" String="Feed forward offset coefficent for the PID." />
122 <Annotation Term="OData.LongDescription" String="Feed forward offset coefficent for the PID." />
123 </Property>
124 <Property Name="ICoefficient" Type="Edm.Decimal" Nullable="false">
125 <Annotation Term="OData.Description" String="Integral Coefficent for the PID." />
126 <Annotation Term="OData.LongDescription" String="Integral Coefficent for the PID." />
127 </Property>
128 <Property Name="ILimitMax" Type="Edm.Decimal" Nullable="false">
129 <Annotation Term="OData.Description" String="Integral limit maxiumum for the PID." />
130 <Annotation Term="OData.LongDescription" String="Integral limit maxiumum for the PID." />
131 </Property>
132 <Property Name="ILimitMin" Type="Edm.Decimal" Nullable="false">
133 <Annotation Term="OData.Description" String="Integral limit miniumum for the PID." />
134 <Annotation Term="OData.LongDescription" String="Integral limit miniumum for the PID." />
135 </Property>
136 <Property Name="Inputs" Type="Collection(Edm.String)">
137 <Annotation Term="OData.Description" String="Input sensors to the PID controller."/>
138 <Annotation Term="OData.LongDescription" String="Input sensors to the PID controller."/>
139 </Property>
140 <Property Name="OutLimitMax" Type="Edm.Decimal" Nullable="false">
141 <Annotation Term="OData.Description" String="Output limit maxiumum for the pwm." />
142 <Annotation Term="OData.LongDescription" String="Output limit maxiumum for the pwm." />
143 </Property>
144 <Property Name="OutLimitMin" Type="Edm.Decimal" Nullable="false">
145 <Annotation Term="OData.Description" String="Output limit minimum for the pwm." />
146 <Annotation Term="OData.LongDescription" String="Output limit minimum for the pwm." />
147 </Property>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]148 <Property Name="NegativeHysteresis" Type="Edm.Decimal" Nullable="false">
149 <Annotation Term="OData.Description" String="Negative hysteresis for the controller." />
150 <Annotation Term="OData.LongDescription" String="Negative hysteresis for the controller." />
151 </Property>
152 <Property Name="PositiveHysteresis" Type="Edm.Decimal" Nullable="false">
153 <Annotation Term="OData.Description" String="Positive hysteresis for the controller." />
154 <Annotation Term="OData.LongDescription" String="Positive hysteresis for the controller." />
155 </Property>
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]156 <Property Name="Outputs" Type="Collection(Edm.String)">
157 <Annotation Term="OData.Description" String="Output sensors to the PID controller."/>
158 <Annotation Term="OData.LongDescription" String="Output sensors to the PID controller."/>
159 </Property>
160 <Property Name="PCoefficient" Type="Edm.Decimal" Nullable="false">
161 <Annotation Term="OData.Description" String="Polynomial coefficent for the PID." />
162 <Annotation Term="OData.LongDescription" String="Polynomial coefficent for the PID." />
163 </Property>
164 <Property Name="SlewNeg" Type="Edm.Decimal" Nullable="false">
165 <Annotation Term="OData.Description" String="Negative slew rate for the PID." />
166 <Annotation Term="OData.LongDescription" String="Negative slew rate for the PID." />
167 </Property>
168 <Property Name="SlewPos" Type="Edm.Decimal" Nullable="false">
169 <Annotation Term="OData.Description" String="Positive slew rate for the PID." />
170 <Annotation Term="OData.LongDescription" String="Positive slew rate for the PID." />
171 </Property>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]172 <NavigationProperty Name="Zones" Type="Collection(OemManager.FanZone)">
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]173 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read" />
174 <Annotation Term="OData.Description" String="Contains the Zones that this PID contributes to." />
175 <Annotation Term="OData.AutoExpandReferences"/>
176 </NavigationProperty>
177 </ComplexType>
178
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]179 <ComplexType Name="FanZone" BaseType="Resource.OemObject">
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]180 <Annotation Term="OData.AdditionalProperties" Bool="false" />
181 <Annotation Term="OData.Description" String="Configuration data for Fan Controllers." />
182 <Property Name="FailSafePercent" Type="Edm.Decimal" Nullable="false">
183 <Annotation Term="OData.Description" String="If the sensors are in fail-safe mode, this is the percentage to use." />
184 <Annotation Term="OData.LongDescription" String="If the sensors are in fail-safe mode, this is the percentage to use." />
185 </Property>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]186 <Property Name="MinThermalOutput" Type="Edm.Decimal" Nullable="false">
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]187 <Annotation Term="OData.Description" String="Minimum thermal RPM that can be set in this Zone." />
188 <Annotation Term="OData.LongDescription" String="Minimum thermal RPM that can be set in this Zone." />
189 </Property>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]190 <NavigationProperty Name="Chassis" Type="Chassis.Chassis">
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]191 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
192 <Annotation Term="OData.Description" String="The Chassis that enables this Zone."/>
193 <Annotation Term="OData.AutoExpandReferences"/>
194 </NavigationProperty>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]195 </ComplexType>
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]196
197 <ComplexType Name="PidController" BaseType="Resource.OemObject">
198 <Annotation Term="OData.AdditionalProperties" Bool="false" />
199 <Annotation Term="OData.Description" String="Configuration data for Fan Controllers." />
200 <Property Name="FFGainCoefficient" Type="Edm.Decimal" Nullable="false">
201 <Annotation Term="OData.Description" String="Feed forward gain coefficent for the PID." />
202 <Annotation Term="OData.LongDescription" String="Feed forward gain coefficent for the PID." />
203 </Property>
204 <Property Name="FFOffCoefficient" Type="Edm.Decimal" Nullable="false">
205 <Annotation Term="OData.Description" String="Feed forward offset coefficent for the PID." />
206 <Annotation Term="OData.LongDescription" String="Feed forward offset coefficent for the PID." />
207 </Property>
208 <Property Name="ICoefficient" Type="Edm.Decimal" Nullable="false">
209 <Annotation Term="OData.Description" String="Integral Coefficent for the PID." />
210 <Annotation Term="OData.LongDescription" String="Integral Coefficent for the PID." />
211 </Property>
212 <Property Name="ILimitMax" Type="Edm.Decimal" Nullable="false">
213 <Annotation Term="OData.Description" String="Integral limit maxiumum for the PID." />
214 <Annotation Term="OData.LongDescription" String="Integral limit maxiumum for the PID." />
215 </Property>
216 <Property Name="ILimitMin" Type="Edm.Decimal" Nullable="false">
217 <Annotation Term="OData.Description" String="Integral limit miniumum for the PID." />
218 <Annotation Term="OData.LongDescription" String="Integral limit miniumum for the PID." />
219 </Property>
220 <Property Name="Inputs" Type="Collection(Edm.String)">
221 <Annotation Term="OData.Description" String="Input sensors to the PID controller."/>
222 <Annotation Term="OData.LongDescription" String="Input sensors to the PID controller."/>
223 </Property>
224 <Property Name="OutLimitMax" Type="Edm.Decimal" Nullable="false">
225 <Annotation Term="OData.Description" String="Output limit maxiumum for the pwm." />
226 <Annotation Term="OData.LongDescription" String="Output limit maxiumum for the pwm." />
227 </Property>
228 <Property Name="OutLimitMin" Type="Edm.Decimal" Nullable="false">
229 <Annotation Term="OData.Description" String="Output limit minimum for the pwm." />
230 <Annotation Term="OData.LongDescription" String="Output limit minimum for the pwm." />
231 </Property>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]232 <Property Name="NegativeHysteresis" Type="Edm.Decimal" Nullable="false">
233 <Annotation Term="OData.Description" String="Negative hysteresis for the controller." />
234 <Annotation Term="OData.LongDescription" String="Negative hysteresis for the controller." />
235 </Property>
236 <Property Name="PositiveHysteresis" Type="Edm.Decimal" Nullable="false">
237 <Annotation Term="OData.Description" String="Positive hysteresis for the controller." />
238 <Annotation Term="OData.LongDescription" String="Positive hysteresis for the controller." />
239 </Property>
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]240 <Property Name="PCoefficient" Type="Edm.Decimal" Nullable="false">
241 <Annotation Term="OData.Description" String="Polynomial coefficent for the PID." />
242 <Annotation Term="OData.LongDescription" String="Polynomial coefficent for the PID." />
243 </Property>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]244 <Property Name="SetPoint" Type="Edm.Decimal" Nullable="false">
245 <Annotation Term="OData.Description" String="Setpoint for the PID." />
246 <Annotation Term="OData.LongDescription" String="Setpoint for the PID." />
247 </Property>
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]248 <Property Name="SlewNeg" Type="Edm.Decimal" Nullable="false">
249 <Annotation Term="OData.Description" String="Negative slew rate for the PID." />
250 <Annotation Term="OData.LongDescription" String="Negative slew rate for the PID." />
251 </Property>
252 <Property Name="SlewPos" Type="Edm.Decimal" Nullable="false">
253 <Annotation Term="OData.Description" String="Positive slew rate for the PID." />
254 <Annotation Term="OData.LongDescription" String="Positive slew rate for the PID." />
255 </Property>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]256 <NavigationProperty Name="Zones" Type="Collection(OemManager.FanZone)">
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]257 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read" />
258 <Annotation Term="OData.Description" String="Contains the Zones that this PID contributes to." />
259 <Annotation Term="OData.AutoExpandReferences"/>
260 </NavigationProperty>
261 </ComplexType>
James Feistbaa5c142018-12-12 17:28:36 -0800[diff] [blame]262
263 <ComplexType Name="StepwiseController" BaseType="Resource.OemObject">
264 <Annotation Term="OData.AdditionalProperties" Bool="false" />
265 <Annotation Term="OData.Description" String="Configuration data for Stepwise Controllers." />
266 <Property Name="Inputs" Type="Collection(Edm.String)">
267 <Annotation Term="OData.Description" String="Input sensors to the Stepwise controller."/>
268 <Annotation Term="OData.LongDescription" String="Input sensors to the Stepwise controller."/>
269 </Property>
270 <Property Name="NegativeHysteresis" Type="Edm.Decimal" Nullable="false">
271 <Annotation Term="OData.Description" String="Negative Hysteresis for the stepwise controller." />
272 <Annotation Term="OData.LongDescription" String="Negative Hysteresis for the stepwise controller." />
273 </Property>
274 <Property Name="PositiveHysteresis" Type="Edm.Decimal" Nullable="false">
275 <Annotation Term="OData.Description" String="Positive Hysteresis for the stepwise controller." />
276 <Annotation Term="OData.LongDescription" String="Positive Hysteresis for the stepwise controller." />
277 </Property>
278 <Property Name="Steps" Type="Collection(OemManager.StepwiseSteps)">
279 <Annotation Term="OData.Description" String="Temperature vs RPM steps for the stepwise controller." />
280 <Annotation Term="OData.LongDescription" String="Temperature vs RPM steps for the stepwise controller." />
281 <Annotation Term="OData.AutoExpand"/>
282 </Property>
James Feistc33a90e2019-03-01 10:17:44 -0800[diff] [blame]283 <Property Name="Direction" Type="Edm.String">
284 <Annotation Term="OData.Description" String="Direction that the stepwise controller applies."/>
285 <Annotation Term="OData.LongDescription" String="Direction that the stepwise controller applies. Options include Ceiling and Floor."/>
286 </Property>
James Feistaf8f7912019-03-29 11:52:12 -0700[diff] [blame^]287 <NavigationProperty Name="Zones" Type="Collection(OemManager.FanZone)">
James Feistbaa5c142018-12-12 17:28:36 -0800[diff] [blame]288 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read" />
289 <Annotation Term="OData.Description" String="Contains the Zones that this controller contributes to." />
290 <Annotation Term="OData.AutoExpandReferences"/>
291 </NavigationProperty>
292 </ComplexType>
293
294 <ComplexType Name="StepwiseSteps" BaseType="Resource.OemObject">
295 <Property Name="Target" Type="Edm.Decimal" Nullable="false">
296 <Annotation Term="OData.Description" String="Input sensor reading for step."/>
297 <Annotation Term="OData.LongDescription" String="Input sensor reading for step."/>
298 </Property>
299 <Property Name="Output" Type="Edm.Decimal" Nullable="false">
300 <Annotation Term="OData.Description" String="Fan speed setting for step."/>
301 <Annotation Term="OData.LongDescription" String="Fan speed setting for step."/>
302 </Property>
James Feistc33a90e2019-03-01 10:17:44 -0800[diff] [blame]303 </ComplexType>
James Feistaf996fe2018-09-14 16:02:44 -0700[diff] [blame]304 </Schema>
305 </edmx:DataServices>
306</edmx:Edmx>