Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / bmcweb / 530520eae687a10f2fb03d2ce23ca4188b0e2440 / . / static / redfish / v1 / JsonSchemas / SerialInterface / SerialInterface.json
blob: 58810c4d123535c8fa095910f21f656845e95625 [file] [log] [blame]
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]1{
2 "$ref": "#/definitions/SerialInterface",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame^]3 "$schema": "http://redfish.dmtf.org/schemas/v1/redfish-schema-v1.json",
4 "copyright": "Copyright 2014-2018 DMTF. For the full DMTF copyright policy, see http://www.dmtf.org/about/policies/copyright",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]5 "definitions": {
6 "Actions": {
7 "additionalProperties": false,
8 "description": "The available actions for this resource.",
9 "longDescription": "This type shall contain the available actions for this resource.",
10 "patternProperties": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame^]11 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]12 "description": "This property shall specify a valid odata or Redfish property.",
13 "type": [
14 "array",
15 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame^]16 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]17 "number",
18 "null",
19 "object",
20 "string"
21 ]
22 }
23 },
24 "properties": {
25 "Oem": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame^]26 "$ref": "#/definitions/OemActions",
27 "description": "This property contains the available OEM specific actions for this resource.",
28 "longDescription": "This property shall contain any additional OEM actions for this resource."
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]29 }
30 },
31 "type": "object"
32 },
33 "BitRate": {
34 "enum": [
35 "1200",
36 "2400",
37 "4800",
38 "9600",
39 "19200",
40 "38400",
41 "57600",
42 "115200",
43 "230400"
44 ],
45 "enumDescriptions": {
46 "115200": "A bit rate of 115200bps.",
47 "1200": "A bit rate of 1200bps.",
48 "19200": "A bit rate of 19200bps.",
49 "230400": "A bit rate of 230400bps.",
50 "2400": "A bit rate of 2400bps.",
51 "38400": "A bit rate of 38400bps.",
52 "4800": "A bit rate of 4800bps.",
53 "57600": "A bit rate of 57600bps.",
54 "9600": "A bit rate of 9600bps."
55 },
56 "type": "string"
57 },
58 "ConnectorType": {
59 "enum": [
60 "RJ45",
61 "RJ11",
62 "DB9 Female",
63 "DB9 Male",
64 "DB25 Female",
65 "DB25 Male",
66 "USB",
67 "mUSB",
68 "uUSB"
69 ],
70 "enumDescriptions": {
71 "DB25 Female": "A DB25 Female connector.",
72 "DB25 Male": "A DB25 Male connector.",
73 "DB9 Female": "A DB9 Female connector.",
74 "DB9 Male": "A DB9 Male connector.",
75 "RJ11": "An RJ11 connector.",
76 "RJ45": "An RJ45 connector.",
77 "USB": "A USB connector.",
78 "mUSB": "A mUSB connector.",
79 "uUSB": "A uUSB connector."
80 },
81 "type": "string"
82 },
83 "DataBits": {
84 "enum": [
85 "5",
86 "6",
87 "7",
88 "8"
89 ],
90 "enumDescriptions": {
91 "5": "5 bits of data following the start bit.",
92 "6": "6 bits of data following the start bit.",
93 "7": "7 bits of data following the start bit.",
94 "8": "8 bits of data following the start bit."
95 },
96 "type": "string"
97 },
98 "FlowControl": {
99 "enum": [
100 "None",
101 "Software",
102 "Hardware"
103 ],
104 "enumDescriptions": {
105 "Hardware": "Out of band flow control imposed.",
106 "None": "No flow control imposed.",
107 "Software": "XON/XOFF in-band flow control imposed."
108 },
109 "type": "string"
110 },
111 "OemActions": {
112 "additionalProperties": true,
113 "description": "The available OEM specific actions for this resource.",
114 "longDescription": "This type shall contain any additional OEM actions for this resource.",
115 "patternProperties": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame^]116 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]117 "description": "This property shall specify a valid odata or Redfish property.",
118 "type": [
119 "array",
120 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame^]121 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]122 "number",
123 "null",
124 "object",
125 "string"
126 ]
127 }
128 },
129 "properties": {},
130 "type": "object"
131 },
132 "Parity": {
133 "enum": [
134 "None",
135 "Even",
136 "Odd",
137 "Mark",
138 "Space"
139 ],
140 "enumDescriptions": {
141 "Even": "An even parity bit.",
142 "Mark": "A mark parity bit.",
143 "None": "No parity bit.",
144 "Odd": "An odd parity bit.",
145 "Space": "A space parity bit."
146 },
147 "type": "string"
148 },
149 "PinOut": {
150 "enum": [
151 "Cisco",
152 "Cyclades",
153 "Digi"
154 ],
155 "enumDescriptions": {
156 "Cisco": "The Cisco pin configuration.",
157 "Cyclades": "The Cyclades pin configuration.",
158 "Digi": "The Digi pin configuration."
159 },
160 "type": "string"
161 },
162 "SerialInterface": {
163 "additionalProperties": false,
164 "description": "This schema defines an asynchronous serial interface resource.",
165 "longDescription": "This resource shall be used to represent serial resources as part of the Redfish specification.",
166 "patternProperties": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame^]167 "^([a-zA-Z_][a-zA-Z0-9_]*)?@(odata|Redfish|Message)\\.[a-zA-Z_][a-zA-Z0-9_.]+$": {
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]168 "description": "This property shall specify a valid odata or Redfish property.",
169 "type": [
170 "array",
171 "boolean",
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame^]172 "integer",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]173 "number",
174 "null",
175 "object",
176 "string"
177 ]
178 }
179 },
180 "properties": {
181 "@odata.context": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame^]182 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/context"
183 },
184 "@odata.etag": {
185 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/etag"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]186 },
187 "@odata.id": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame^]188 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/id"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]189 },
190 "@odata.type": {
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame^]191 "$ref": "http://redfish.dmtf.org/schemas/v1/odata.v4_0_3.json#/definitions/type"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]192 },
193 "Actions": {
194 "$ref": "#/definitions/Actions",
195 "description": "The available actions for this resource.",
196 "longDescription": "The Actions property shall contain the available actions for this resource."
197 },
198 "BitRate": {
199 "$ref": "#/definitions/BitRate",
200 "description": "The receive and transmit rate of data flow, typically in bits-per-second (bps), over the serial connection.",
201 "longDescription": "This property shall indicate the transmit and receive speed of the serial connection.",
202 "readonly": false
203 },
204 "ConnectorType": {
205 "$ref": "#/definitions/ConnectorType",
206 "description": "The type of connector used for this interface.",
207 "longDescription": "This property shall indicate the type of phyiscal connector used for this serial connection.",
208 "readonly": true
209 },
210 "DataBits": {
211 "$ref": "#/definitions/DataBits",
212 "description": "The number of data bits that will follow the start bit over the serial connection.",
213 "longDescription": "This property shall indicate number of data bits for the serial connection.",
214 "readonly": false
215 },
216 "Description": {
217 "anyOf": [
218 {
219 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Description"
220 },
221 {
222 "type": "null"
223 }
224 ],
225 "readonly": true
226 },
227 "FlowControl": {
228 "$ref": "#/definitions/FlowControl",
229 "description": "The type of flow control, if any, that will be imposed on the serial connection.",
230 "longDescription": "This property shall indicate the flow control mechanism for the serial connection.",
231 "readonly": false
232 },
233 "Id": {
234 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Id",
235 "readonly": true
236 },
237 "InterfaceEnabled": {
238 "description": "This indicates whether this interface is enabled.",
239 "longDescription": "The value of this property shall be a boolean indicating whether this interface is enabled.",
240 "readonly": false,
241 "type": [
242 "boolean",
243 "null"
244 ]
245 },
246 "Name": {
247 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Name",
248 "readonly": true
249 },
250 "Oem": {
251 "$ref": "http://redfish.dmtf.org/schemas/v1/Resource.json#/definitions/Oem",
252 "description": "This is the manufacturer/provider specific extension moniker used to divide the Oem object into sections.",
253 "longDescription": "The value of this string shall be of the format for the reserved word *Oem*."
254 },
255 "Parity": {
256 "$ref": "#/definitions/Parity",
257 "description": "The type of parity used by the sender and receiver in order to detect errors over the serial connection.",
258 "longDescription": "This property shall indicate parity information for a serial connection.",
259 "readonly": false
260 },
261 "PinOut": {
262 "anyOf": [
263 {
264 "$ref": "#/definitions/PinOut"
265 },
266 {
267 "type": "null"
268 }
269 ],
270 "description": "The physical pin configuration needed for a serial connector.",
271 "longDescription": "This property shall indicate the physical pin out for the serial connection.",
272 "readonly": true
273 },
274 "SignalType": {
275 "$ref": "#/definitions/SignalType",
276 "description": "The type of signal used for the communication connection - RS232 or RS485.",
277 "longDescription": "This property shall indicate the type of serial signalling that will be utilized for the serial connection.",
278 "readonly": true
279 },
280 "StopBits": {
281 "$ref": "#/definitions/StopBits",
282 "description": "The period of time before the next start bit is transmitted.",
283 "longDescription": "This property shall indicate the stop bits for the serial connection.",
284 "readonly": false
285 }
286 },
287 "required": [
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame^]288 "@odata.id",
289 "@odata.type",
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]290 "Id",
291 "Name"
292 ],
293 "type": "object"
294 },
295 "SignalType": {
296 "enum": [
297 "Rs232",
298 "Rs485"
299 ],
300 "enumDescriptions": {
301 "Rs232": "The serial interface follows RS232.",
302 "Rs485": "The serial interface follows RS485."
303 },
304 "type": "string"
305 },
306 "StopBits": {
307 "enum": [
308 "1",
309 "2"
310 ],
311 "enumDescriptions": {
312 "1": "1 stop bit following the data bits.",
313 "2": "2 stop bits following the data bits."
314 },
315 "type": "string"
316 }
317 },
Ed Tanous530520e2019-01-02 13:41:37 -0800[diff] [blame^]318 "owningEntity": "DMTF",
319 "title": "#SerialInterface.v1_1_3.SerialInterface"
Ed Tanous118b1c72018-09-13 13:45:51 -0700[diff] [blame]320}