Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 8b564558bafdf3e7a3babaafc29b0e5f904f4363 / . / static / redfish / v1 / schema / OperatingConfig_v1.xml
blob: 4523b09f00474505e380c5832bd93fa67145cd12 [file] [log] [blame]
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]1<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
Gunnar Mills262d7d42021-01-20 16:28:41 -0600[diff] [blame]4<!--# Redfish Schema: OperatingConfig v1.0.2 -->
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]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 -->
Gunnar Mills10f270b2021-05-19 15:34:06 -0500[diff] [blame]8<!--# Copyright 2014-2021 DMTF. -->
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]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/Resource_v1.xml">
24 <edmx:Include Namespace="Resource"/>
25 <edmx:Include Namespace="Resource.v1_0_0"/>
26 </edmx:Reference>
27 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
28 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
29 <edmx:Include Namespace="Validation.v1_0_0" Alias="Validation"/>
30 </edmx:Reference>
31
32 <edmx:DataServices>
33
34 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="OperatingConfig">
35 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
36
37 <EntityType Name="OperatingConfig" BaseType="Resource.v1_0_0.Resource" Abstract="true">
38 <Annotation Term="OData.Description" String="The OperatingConfig schema specifies a configuration that can be used when the processor is operational."/>
39 <Annotation Term="OData.LongDescription" String="This resource shall represent an operational configuration for a processor in the Redfish Specification."/>
40 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
41 <Annotation Term="Capabilities.InsertRestrictions">
42 <Record>
43 <PropertyValue Property="Insertable" Bool="false"/>
44 </Record>
45 </Annotation>
46 <Annotation Term="Capabilities.UpdateRestrictions">
47 <Record>
48 <PropertyValue Property="Updatable" Bool="false"/>
49 </Record>
50 </Annotation>
51 <Annotation Term="Capabilities.DeleteRestrictions">
52 <Record>
53 <PropertyValue Property="Deletable" Bool="false"/>
54 </Record>
55 </Annotation>
56 <Annotation Term="Redfish.Uris">
57 <Collection>
58 <String>/redfish/v1/Systems/{ComputerSystemId}/Processors/{ProcessorId}/OperatingConfigs/{OperatingConfigId}</String>
59 </Collection>
60 </Annotation>
61 </EntityType>
62 </Schema>
63
64 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="OperatingConfig.v1_0_0">
65 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
66 <Annotation Term="Redfish.Release" String="2020.2"/>
67
68 <EntityType Name="OperatingConfig" BaseType="OperatingConfig.OperatingConfig">
69 <Property Name="TotalAvailableCoreCount" Type="Edm.Int64">
70 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
71 <Annotation Term="OData.Description" String="The number of cores in the processor that can be configured."/>
72 <Annotation Term="OData.LongDescription" String="This property shall contain the number of cores in the processor that can be configured."/>
73 <Annotation Term="Validation.Minimum" Int="0"/>
74 </Property>
75 <Property Name="TDPWatts" Type="Edm.Int64">
76 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
77 <Annotation Term="OData.Description" String="The thermal design point of the processor in watts."/>
78 <Annotation Term="OData.LongDescription" String="This property shall contain the thermal design point of the processor in watts."/>
79 <Annotation Term="Validation.Minimum" Int="0"/>
80 <Annotation Term="Measures.Unit" String="W"/>
81 </Property>
82 <Property Name="BaseSpeedMHz" Type="Edm.Int64">
83 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]84 <Annotation Term="OData.Description" String="The base (nominal) clock speed of the processor in MHz."/>
85 <Annotation Term="OData.LongDescription" String="This property shall contain the base (nominal) clock speed of the processor in MHz."/>
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]86 <Annotation Term="Validation.Minimum" Int="0"/>
87 <Annotation Term="Measures.Unit" String="MHz"/>
88 </Property>
89 <Property Name="MaxSpeedMHz" Type="Edm.Int64">
90 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
91 <Annotation Term="OData.Description" String="The maximum clock speed to which the processor can be configured in MHz."/>
92 <Annotation Term="OData.LongDescription" String="This property shall contain the maximum clock speed to which the processor can be configured in MHz."/>
93 <Annotation Term="Validation.Minimum" Int="0"/>
94 <Annotation Term="Measures.Unit" String="MHz"/>
95 </Property>
96 <Property Name="MaxJunctionTemperatureCelsius" Type="Edm.Int64">
97 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
98 <Annotation Term="OData.Description" String="The maximum temperature of the junction in degrees Celsius."/>
99 <Annotation Term="OData.LongDescription" String="This property shall contain the maximum temperature of the junction in degrees Celsius."/>
100 <Annotation Term="Measures.Unit" String="Cel"/>
101 </Property>
102 <Property Name="BaseSpeedPrioritySettings" Type="Collection(OperatingConfig.v1_0_0.BaseSpeedPrioritySettings)">
103 <Annotation Term="OData.Description" String="The clock speed for sets of cores when the configuration is operational."/>
104 <Annotation Term="OData.LongDescription" String="This property shall contain an array of objects that specify the clock speed for sets of cores when the configuration is operational."/>
105 </Property>
106 <Property Name="TurboProfile" Type="Collection(OperatingConfig.v1_0_0.TurboProfileDatapoint)">
107 <Annotation Term="OData.Description" String="The turbo profiles for the processor. A turbo profile is the maximum turbo clock speed as a function of the number of active cores."/>
108 <Annotation Term="OData.LongDescription" String="The property shall contain an array of objects that specify the turbo profile for a set of active cores."/>
109 </Property>
110 <Property Name="Actions" Type="OperatingConfig.v1_0_0.Actions" Nullable="false">
111 <Annotation Term="OData.Description" String="The available actions for this resource."/>
112 <Annotation Term="OData.LongDescription" String="This property shall contain the available actions for this resource."/>
113 </Property>
114 </EntityType>
115
116 <ComplexType Name="TurboProfileDatapoint">
117 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
118 <Annotation Term="OData.Description" String="The turbo profile for a set of active cores."/>
119 <Annotation Term="OData.LongDescription" String="This type shall specify the turbo profile for a set of active cores."/>
120 <Property Name="ActiveCoreCount" Type="Edm.Int64">
121 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
122 <Annotation Term="OData.Description" String="The number of active cores to be configured with the specified maximum clock speed."/>
123 <Annotation Term="OData.LongDescription" String="This property shall contain the number of cores to be configured with the maximum turbo clock speed. The value shall be less than or equal the TotalAvailableCoreCount property."/>
124 <Annotation Term="Validation.Minimum" Int="0"/>
125 </Property>
126 <Property Name="MaxSpeedMHz" Type="Edm.Int64">
127 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
128 <Annotation Term="OData.Description" String="The maximum turbo clock speed that correspond to the number of active cores in MHz."/>
129 <Annotation Term="OData.LongDescription" String="This property shall contain the maximum turbo clock speed that correspond to the number of active cores in MHz."/>
130 <Annotation Term="Validation.Minimum" Int="0"/>
131 <Annotation Term="Measures.Unit" String="MHz"/>
132 </Property>
133 </ComplexType>
134
135 <ComplexType Name="BaseSpeedPrioritySettings">
136 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
137 <Annotation Term="OData.Description" String="The clock speed for a set of cores."/>
138 <Annotation Term="OData.LongDescription" String="This type shall specify the clock speed for a set of cores."/>
139 <Property Name="CoreCount" Type="Edm.Int64">
140 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
141 <Annotation Term="OData.Description" String="The number of cores to configure with a specified speed."/>
142 <Annotation Term="OData.LongDescription" String="This property shall contain the number of cores to configure with the speed specified by the BaseSpeedMHz property. The sum of all CoreCount properties shall equal the value of the TotalAvailableCoreCount property."/>
143 <Annotation Term="Validation.Minimum" Int="0"/>
144 </Property>
145 <Property Name="CoreIDs" Type="Collection(Edm.Int64)">
146 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
147 <Annotation Term="OData.Description" String="The identifier of the cores to configure with the specified speed."/>
148 <Annotation Term="OData.LongDescription" String="This property shall contain an array identifying the cores to configure with the speed specified by the BaseSpeedMHz property. The length of the array shall equal the value of the CoreCount property."/>
149 </Property>
150 <Property Name="BaseSpeedMHz" Type="Edm.Int64">
151 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
152 <Annotation Term="OData.Description" String="The clock speed to configure the set of cores in MHz."/>
153 <Annotation Term="OData.LongDescription" String="This property shall contain the clock speed to configure the set of cores in MHz."/>
154 <Annotation Term="Validation.Minimum" Int="0"/>
155 <Annotation Term="Measures.Unit" String="MHz"/>
156 </Property>
157 </ComplexType>
158
159 <ComplexType Name="Actions">
160 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
161 <Annotation Term="OData.Description" String="The available actions for this resource."/>
162 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
163 <Property Name="Oem" Type="OperatingConfig.v1_0_0.OemActions" Nullable="false">
164 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
165 <Annotation Term="OData.LongDescription" String="This property shall contain the available OEM-specific actions for this resource."/>
166 </Property>
167 </ComplexType>
168
169 <ComplexType Name="OemActions">
170 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
171 <Annotation Term="OData.Description" String="The available OEM-specific actions for this resource."/>
172 <Annotation Term="OData.LongDescription" String="This type shall contain the available OEM-specific actions for this resource."/>
173 </ComplexType>
174 </Schema>
175
Asmitha Karunanithic8ccb772020-09-22 10:56:46 -0500[diff] [blame]176 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="OperatingConfig.v1_0_1">
177 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
178 <Annotation Term="OData.Description" String="This version was created to clarify the description of BaseSpeedMHz."/>
179 <EntityType Name="OperatingConfig" BaseType="OperatingConfig.v1_0_0.OperatingConfig"/>
180 </Schema>
181
Gunnar Mills262d7d42021-01-20 16:28:41 -0600[diff] [blame]182 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="OperatingConfig.v1_0_2">
183 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
184 <Annotation Term="OData.Description" String="This version was created specify 64-bit integers in OpenAPI."/>
185 <EntityType Name="OperatingConfig" BaseType="OperatingConfig.v1_0_1.OperatingConfig"/>
186 </Schema>
187
Gunnar Mills844b4152020-06-22 12:44:09 -0500[diff] [blame]188 </edmx:DataServices>
189</edmx:Edmx>