Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / ea4aa750f42ec86f39b4b3899a66dcae03f7ddb1 / . / static / redfish / v1 / schema / SerialInterface_v1.xml
blob: fd2270bb3b4f700b2e0d2489846ba104025064c7 [file] [log] [blame]
Jason M. Billsea4aa752018-06-05 13:29:11 -0700[diff] [blame^]1<?xml version="1.0" encoding="UTF-8"?>
2<!---->
3<!--################################################################################ -->
4<!--# Redfish Schema: SerialInterface v1.1.2-->
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-2017 Distributed Management Task Force, Inc. (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://redfish.dmtf.org/schemas/v1/RedfishExtensions_v1.xml">
21 <edmx:Include Namespace="RedfishExtensions.v1_0_0" Alias="Redfish"/>
22 </edmx:Reference>
23 <edmx:Reference Uri="http://redfish.dmtf.org/schemas/v1/Resource_v1.xml">
24 <edmx:Include Namespace="Resource.v1_0_0"/>
25 </edmx:Reference>
26
27 <edmx:DataServices>
28
29 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface">
30 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
31
32 <EntityType Name="SerialInterface" BaseType="Resource.v1_0_0.Resource" Abstract="true">
33 <Annotation Term="OData.Description" String="This resource describes an asynchronous serial interface, such as an RS-232 interface, available to a system or device."/>
34 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent serial resources as part of the Redfish specification."/>
35 <Annotation Term="Capabilities.InsertRestrictions">
36 <Record>
37 <PropertyValue Property="Insertable" Bool="false"/>
38 </Record>
39 </Annotation>
40 <Annotation Term="Capabilities.UpdateRestrictions">
41 <Record>
42 <PropertyValue Property="Updatable" Bool="true"/>
43 <Annotation Term="OData.Description" String="A Serial Interface can be updated to enable or disable it or to change the configuration."/>
44 </Record>
45 </Annotation>
46 <Annotation Term="Capabilities.DeleteRestrictions">
47 <Record>
48 <PropertyValue Property="Deletable" Bool="false"/>
49 </Record>
50 </Annotation>
51 </EntityType>
52
53 </Schema>
54
55 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_0_0">
56 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
57
58 <EntityType Name="SerialInterface" BaseType="SerialInterface.SerialInterface">
59 <Annotation Term="OData.Description" String="This schema defines an asynchronous serial interface resource."/>
60 <Annotation Term="OData.LongDescription" String="This resource shall be used to represent serial resources as part of the Redfish specification."/>
61 <Property Name="InterfaceEnabled" Type="Edm.Boolean">
62 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
63 <Annotation Term="OData.Description" String="This indicates whether this interface is enabled."/>
64 <Annotation Term="OData.LongDescription" String="The value of this property shall be a boolean indicating whether this interface is enabled."/>
65 </Property>
66 <Property Name="SignalType" Type="SerialInterface.v1_0_0.SignalType" Nullable="false">
67 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
68 <Annotation Term="OData.Description" String="The type of signal used for the communication connection - RS232 or RS485."/>
69 <Annotation Term="OData.LongDescription" String="This property shall indicate the type of serial signalling that will be utilized for the serial connection."/>
70 </Property>
71 <Property Name="BitRate" Type="SerialInterface.v1_0_0.BitRate" Nullable="false">
72 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
73 <Annotation Term="OData.Description" String="The receive and transmit rate of data flow, typically in bits-per-second (bps), over the serial connection."/>
74 <Annotation Term="OData.LongDescription" String="This property shall indicate the transmit and receive speed of the serial connection."/>
75 </Property>
76 <Property Name="Parity" Type="SerialInterface.v1_0_0.Parity" Nullable="false">
77 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
78 <Annotation Term="OData.Description" String="The type of parity used by the sender and receiver in order to detect errors over the serial connection."/>
79 <Annotation Term="OData.LongDescription" String="This property shall indicate parity information for a serial connection."/>
80 </Property>
81 <Property Name="DataBits" Type="SerialInterface.v1_0_0.DataBits" Nullable="false">
82 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
83 <Annotation Term="OData.Description" String="The number of data bits that will follow the start bit over the serial connection."/>
84 <Annotation Term="OData.LongDescription" String="This property shall indicate number of data bits for the serial connection."/>
85 </Property>
86 <Property Name="StopBits" Type="SerialInterface.v1_0_0.StopBits" Nullable="false">
87 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
88 <Annotation Term="OData.Description" String="The period of time before the next start bit is transmitted."/>
89 <Annotation Term="OData.LongDescription" String="This property shall indicate the stop bits for the serial connection."/>
90 </Property>
91 <Property Name="FlowControl" Type="SerialInterface.v1_0_0.FlowControl" Nullable="false">
92 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/ReadWrite"/>
93 <Annotation Term="OData.Description" String="The type of flow control, if any, that will be imposed on the serial connection."/>
94 <Annotation Term="OData.LongDescription" String="This property shall indicate the flow control mechanism for the serial connection."/>
95 </Property>
96 <Property Name="ConnectorType" Type="SerialInterface.v1_0_0.ConnectorType" Nullable="false">
97 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
98 <Annotation Term="OData.Description" String="The type of connector used for this interface."/>
99 <Annotation Term="OData.LongDescription" String="This property shall indicate the type of phyiscal connector used for this serial connection."/>
100 </Property>
101 <Property Name="PinOut" Type="SerialInterface.v1_0_0.PinOut">
102 <Annotation Term="OData.Permissions" EnumMember="OData.Permission/Read"/>
103 <Annotation Term="OData.Description" String="The physical pin configuration needed for a serial connector."/>
104 <Annotation Term="OData.LongDescription" String="This property shall indicate the physical pin out for the serial connection."/>
105 </Property>
106 </EntityType>
107
108 <EnumType Name="SignalType">
109 <Member Name="Rs232">
110 <Annotation Term="OData.Description" String="The serial interface follows RS232."/>
111 </Member>
112 <Member Name="Rs485">
113 <Annotation Term="OData.Description" String="The serial interface follows RS485."/>
114 </Member>
115 </EnumType>
116
117 <TypeDefinition Name="BitRate" UnderlyingType="Edm.String">
118 <Annotation Term="Redfish.Enumeration">
119 <Collection>
120 <Record>
121 <PropertyValue Property="Member" String="1200"/>
122 <Annotation Term="OData.Description" String="A bit rate of 1200bps."/>
123 </Record>
124 <Record>
125 <PropertyValue Property="Member" String="2400"/>
126 <Annotation Term="OData.Description" String="A bit rate of 2400bps."/>
127 </Record>
128 <Record>
129 <PropertyValue Property="Member" String="4800"/>
130 <Annotation Term="OData.Description" String="A bit rate of 4800bps."/>
131 </Record>
132 <Record>
133 <PropertyValue Property="Member" String="9600"/>
134 <Annotation Term="OData.Description" String="A bit rate of 9600bps."/>
135 </Record>
136 <Record>
137 <PropertyValue Property="Member" String="19200"/>
138 <Annotation Term="OData.Description" String="A bit rate of 19200bps."/>
139 </Record>
140 <Record>
141 <PropertyValue Property="Member" String="38400"/>
142 <Annotation Term="OData.Description" String="A bit rate of 38400bps."/>
143 </Record>
144 <Record>
145 <PropertyValue Property="Member" String="57600"/>
146 <Annotation Term="OData.Description" String="A bit rate of 57600bps."/>
147 </Record>
148 <Record>
149 <PropertyValue Property="Member" String="115200"/>
150 <Annotation Term="OData.Description" String="A bit rate of 115200bps."/>
151 </Record>
152 <Record>
153 <PropertyValue Property="Member" String="230400"/>
154 <Annotation Term="OData.Description" String="A bit rate of 230400bps."/>
155 </Record>
156 </Collection>
157 </Annotation>
158 </TypeDefinition>
159
160 <EnumType Name="Parity">
161 <Member Name="None">
162 <Annotation Term="OData.Description" String="No parity bit."/>
163 </Member>
164 <Member Name="Even">
165 <Annotation Term="OData.Description" String="An even parity bit."/>
166 </Member>
167 <Member Name="Odd">
168 <Annotation Term="OData.Description" String="An odd parity bit."/>
169 </Member>
170 <Member Name="Mark">
171 <Annotation Term="OData.Description" String="A mark parity bit."/>
172 </Member>
173 <Member Name="Space">
174 <Annotation Term="OData.Description" String="A space parity bit."/>
175 </Member>
176 </EnumType>
177
178 <TypeDefinition Name="DataBits" UnderlyingType="Edm.String">
179 <Annotation Term="Redfish.Enumeration">
180 <Collection>
181 <Record>
182 <PropertyValue Property="Member" String="5"/>
183 <Annotation Term="OData.Description" String="5 bits of data following the start bit."/>
184 </Record>
185 <Record>
186 <PropertyValue Property="Member" String="6"/>
187 <Annotation Term="OData.Description" String="6 bits of data following the start bit."/>
188 </Record>
189 <Record>
190 <PropertyValue Property="Member" String="7"/>
191 <Annotation Term="OData.Description" String="7 bits of data following the start bit."/>
192 </Record>
193 <Record>
194 <PropertyValue Property="Member" String="8"/>
195 <Annotation Term="OData.Description" String="8 bits of data following the start bit."/>
196 </Record>
197 </Collection>
198 </Annotation>
199 </TypeDefinition>
200
201 <TypeDefinition Name="StopBits" UnderlyingType="Edm.String">
202 <Annotation Term="Redfish.Enumeration">
203 <Collection>
204 <Record>
205 <PropertyValue Property="Member" String="1"/>
206 <Annotation Term="OData.Description" String="1 stop bit following the data bits."/>
207 </Record>
208 <Record>
209 <PropertyValue Property="Member" String="2"/>
210 <Annotation Term="OData.Description" String="2 stop bits following the data bits."/>
211 </Record>
212 </Collection>
213 </Annotation>
214 </TypeDefinition>
215
216 <EnumType Name="FlowControl">
217 <Member Name="None">
218 <Annotation Term="OData.Description" String="No flow control imposed."/>
219 </Member>
220 <Member Name="Software">
221 <Annotation Term="OData.Description" String="XON/XOFF in-band flow control imposed."/>
222 </Member>
223 <Member Name="Hardware">
224 <Annotation Term="OData.Description" String="Out of band flow control imposed."/>
225 </Member>
226 </EnumType>
227
228 <EnumType Name="PinOut">
229 <Member Name="Cisco">
230 <Annotation Term="OData.Description" String="The Cisco pin configuration."/>
231 </Member>
232 <Member Name="Cyclades">
233 <Annotation Term="OData.Description" String="The Cyclades pin configuration."/>
234 </Member>
235 <Member Name="Digi">
236 <Annotation Term="OData.Description" String="The Digi pin configuration."/>
237 </Member>
238 </EnumType>
239
240 <TypeDefinition Name="ConnectorType" UnderlyingType="Edm.String">
241 <Annotation Term="Redfish.Enumeration">
242 <Collection>
243 <Record>
244 <PropertyValue Property="Member" String="RJ45"/>
245 <Annotation Term="OData.Description" String="An RJ45 connector."/>
246 </Record>
247 <Record>
248 <PropertyValue Property="Member" String="RJ11"/>
249 <Annotation Term="OData.Description" String="An RJ11 connector."/>
250 </Record>
251 <Record>
252 <PropertyValue Property="Member" String="DB9 Female"/>
253 <Annotation Term="OData.Description" String="A DB9 Female connector."/>
254 </Record>
255 <Record>
256 <PropertyValue Property="Member" String="DB9 Male"/>
257 <Annotation Term="OData.Description" String="A DB9 Male connector."/>
258 </Record>
259 <Record>
260 <PropertyValue Property="Member" String="DB25 Female"/>
261 <Annotation Term="OData.Description" String="A DB25 Female connector."/>
262 </Record>
263 <Record>
264 <PropertyValue Property="Member" String="DB25 Male"/>
265 <Annotation Term="OData.Description" String="A DB25 Male connector."/>
266 </Record>
267 <Record>
268 <PropertyValue Property="Member" String="USB"/>
269 <Annotation Term="OData.Description" String="A USB connector."/>
270 </Record>
271 <Record>
272 <PropertyValue Property="Member" String="mUSB"/>
273 <Annotation Term="OData.Description" String="A mUSB connector."/>
274 </Record>
275 <Record>
276 <PropertyValue Property="Member" String="uUSB"/>
277 <Annotation Term="OData.Description" String="A uUSB connector."/>
278 </Record>
279 </Collection>
280 </Annotation>
281 </TypeDefinition>
282
283 </Schema>
284
285 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_0_2">
286 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
287 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
288 <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_0_0.SerialInterface"/>
289 </Schema>
290
291 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_0_3">
292 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
293 <Annotation Term="OData.Description" String="This version was created to show annotations in previous namespaces were updated."/>
294 <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_0_2.SerialInterface"/>
295 </Schema>
296
297 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_0_4">
298 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
299 <Annotation Term="OData.Description" String="This version was created to correct the ConnectorType enum values to match orginal publication."/>
300 <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_0_3.SerialInterface"/>
301 </Schema>
302
303 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_0_5">
304 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
305 <Annotation Term="OData.Description" String="This version was created to add descriptions to various enum values."/>
306 <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_0_4.SerialInterface"/>
307 </Schema>
308
309 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_1_0">
310 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
311 <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_0_3.SerialInterface">
312 <Property Name="Actions" Type="SerialInterface.v1_1_0.Actions" Nullable="false">
313 <Annotation Term="OData.Description" String="The available actions for this resource."/>
314 <Annotation Term="OData.LongDescription" String="The Actions property shall contain the available actions for this resource."/>
315 </Property>
316 </EntityType>
317
318 <ComplexType Name="Actions">
319 <Annotation Term="OData.AdditionalProperties" Bool="false"/>
320 <Annotation Term="OData.Description" String="The available actions for this resource."/>
321 <Annotation Term="OData.LongDescription" String="This type shall contain the available actions for this resource."/>
322 <Property Name="Oem" Type="SerialInterface.v1_1_0.OemActions" Nullable="false"/>
323 </ComplexType>
324
325 <ComplexType Name="OemActions">
326 <Annotation Term="OData.AdditionalProperties" Bool="true"/>
327 <Annotation Term="OData.Description" String="The available OEM specific actions for this resource."/>
328 <Annotation Term="OData.LongDescription" String="This type shall contain any additional OEM actions for this resource."/>
329 </ComplexType>
330 </Schema>
331
332 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_1_1">
333 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
334 <Annotation Term="OData.Description" String="This version was created to correct the ConnectorType enum values to match orginal publication."/>
335 <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_1_0.SerialInterface"/>
336 </Schema>
337
338 <Schema xmlns="http://docs.oasis-open.org/odata/ns/edm" Namespace="SerialInterface.v1_1_2">
339 <Annotation Term="Redfish.OwningEntity" String="DMTF"/>
340 <Annotation Term="OData.Description" String="This version was created to add descriptions to various enum values."/>
341 <EntityType Name="SerialInterface" BaseType="SerialInterface.v1_1_1.SerialInterface"/>
342 </Schema>
343
344 </edmx:DataServices>
345</edmx:Edmx>