Add gitreview file for Quirky Quillback branch
[apps/agl-service-unicens.git] / data / unicens.xsd
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!-- committed 2017-09-22 -->\r
3 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified">\r
4         <xs:element name="Unicens">\r
5                 <xs:annotation>\r
6                         <xs:documentation>\r
7                                 <UCSElementPath>/Unicens</UCSElementPath>\r
8 Schema for the description of a UNICENS configuration</xs:documentation>\r
9                 </xs:annotation>\r
10                 <xs:complexType>\r
11                         <xs:choice maxOccurs="unbounded">\r
12                                 <xs:element name="Node">\r
13                                         <xs:annotation>\r
14                                                 <xs:documentation>\r
15                                                         <UCSElementPath>/Unicens/Node</UCSElementPath>\r
16 Node is a connection point that can receive, create, store or send data along distributed network routes.</xs:documentation>\r
17                                         </xs:annotation>\r
18                                         <xs:complexType>\r
19                                                 <xs:sequence>\r
20                                                         <xs:choice minOccurs="0" maxOccurs="unbounded">\r
21                                                                 <xs:element name="USBPort">\r
22                                                                         <xs:annotation>\r
23                                                                                 <xs:documentation>\r
24                                                                                         <UCSElementPath>/Unicens/Node/USBPort</UCSElementPath>\r
25 Configuration Structure of a USB Port</xs:documentation>\r
26                                                                         </xs:annotation>\r
27                                                                         <xs:complexType>\r
28                                                                                 <xs:attribute name="PhysicalLayer" type="USBPortPhysicalLayer" use="required">\r
29                                                                                         <xs:annotation>\r
30                                                                                                 <xs:documentation>\r
31                                                                                                         <UCSElementPath>/Unicens/Node/USBPort/@PhysicalLayer</UCSElementPath>\r
32 Interface of the USB Ports Physical Layer\r
33 This attribute corresponds with the parameter PhysicalLayer of the INIC function INIC.USBPortCreate.\r
34 </xs:documentation>\r
35                                                                                         </xs:annotation>\r
36                                                                                 </xs:attribute>\r
37                                                                                 <xs:attribute name="DeviceInterfaces" type="Number" use="required">\r
38                                                                                         <xs:annotation>\r
39                                                                                                 <xs:documentation>\r
40                                                                                                         <UCSElementPath>/Unicens/Node/USBPort/@DeviceInterfaces</UCSElementPath>\r
41 USB Devices interfaces mask.\r
42 This attribute corresponds with the parameter DeviceInterfaces of the INIC function INIC.USBPortCreate.</xs:documentation>\r
43                                                                                         </xs:annotation>\r
44                                                                                 </xs:attribute>\r
45                                                                                 <xs:attribute name="StreamingIfEpInCount" type="Number" use="required">\r
46                                                                                         <xs:annotation>\r
47                                                                                                 <xs:documentation>\r
48                                                                                                         <UCSElementPath>/Unicens/Node/USBPort/@StreamingIfEpInCount</UCSElementPath>\r
49 IN Endpoints inside the streaming interfaces.\r
50 This attribute corresponds with the parameter StreamingIfEpInCount of the INIC function INIC.USBPortCreate.</xs:documentation>\r
51                                                                                         </xs:annotation>\r
52                                                                                 </xs:attribute>\r
53                                                                                 <xs:attribute name="StreamingIfEpOutCount" type="Number" use="required">\r
54                                                                                         <xs:annotation>\r
55                                                                                                 <xs:documentation>\r
56                                                                                                         <UCSElementPath>/Unicens/Node/USBPort/@StreamingIfEpOutCount</UCSElementPath>\r
57 OUT Endpoints inside the streaming interfaces.\r
58 This attribute corresponds with the parameter StreamingIfEpInCount of the INIC function INIC.USBPortCreate.</xs:documentation>\r
59                                                                                         </xs:annotation>\r
60                                                                                 </xs:attribute>\r
61                                                                         </xs:complexType>\r
62                                                                 </xs:element>\r
63                                                                 <xs:element name="MediaLBPort">\r
64                                                                         <xs:annotation>\r
65                                                                                 <xs:documentation>\r
66                                                                                         <UCSElementPath>/Unicens/Node/MediaLBPort</UCSElementPath>\r
67 Configuration Structure of a MediaLB Port\r
68 The MediaLB Port is the interface to the Media Local Bus. \r
69 It supports the handling of all MOST network data types and is available in two pin-out options: MediaLB 3-Pin (single-ended) and MediaLB 6-Pin (differential). </xs:documentation>\r
70                                                                         </xs:annotation>\r
71                                                                         <xs:complexType>\r
72                                                                                 <xs:attribute name="ClockConfig" type="MediaLBPortClockConfig" use="required">\r
73                                                                                         <xs:annotation>\r
74                                                                                                 <xs:documentation>\r
75                                                                                                         <UCSElementPath>/Unicens/Node/MediaLBPort/@ClockConfig</UCSElementPath>\r
76 Clock speed configuration.\r
77 This attribute corresponds with the parameter ClockConfig of the INIC function INIC.MediaLBPortCreate.</xs:documentation>\r
78                                                                                         </xs:annotation>\r
79                                                                                 </xs:attribute>\r
80                                                                         </xs:complexType>\r
81                                                                 </xs:element>\r
82                                                                 <xs:element name="StreamPort">\r
83                                                                         <xs:annotation>\r
84                                                                                 <xs:documentation>\r
85                                                                                         <UCSElementPath>/Unicens/Node/StreamPort</UCSElementPath>\r
86 Configuration Structure of a Stream Port</xs:documentation>\r
87                                                                         </xs:annotation>\r
88                                                                         <xs:complexType>\r
89                                                                                 <xs:attribute name="ClockConfig" type="StreamPortClockConfig" use="required">\r
90                                                                                         <xs:annotation>\r
91                                                                                                 <xs:documentation>\r
92                                                                                                         <UCSElementPath>/Unicens/Node/StreamPort/@ClockConfig</UCSElementPath>\r
93 Clock speed configuration.\r
94 This attribute corresponds with the parameter ClockConfig of the INIC function INIC.StreamPortCreate.</xs:documentation>\r
95                                                                                         </xs:annotation>\r
96                                                                                 </xs:attribute>\r
97                                                                                 <xs:attribute name="DataAlignment" type="StreamPortDataAlignment" use="required">\r
98                                                                                         <xs:annotation>\r
99                                                                                                 <xs:documentation>\r
100                                                                                                         <UCSElementPath>/Unicens/Node/StreamPort/@DataAlignment</UCSElementPath>\r
101 Alignment of the data bytes .\r
102 This attribute corresponds with the parameter DataAlignment of the INIC function INIC.StreamPortCreate</xs:documentation>\r
103                                                                                         </xs:annotation>\r
104                                                                                 </xs:attribute>\r
105                                                                         </xs:complexType>\r
106                                                                 </xs:element>\r
107                                                         </xs:choice>\r
108                                                         <xs:choice minOccurs="0" maxOccurs="unbounded">\r
109                                                                 <xs:element name="SyncConnection">\r
110                                                                         <xs:annotation>\r
111                                                                                 <xs:documentation>\r
112                                                                                         <UCSElementPath>/Unicens/Node/SyncConnection</UCSElementPath>\r
113 Configuration Structure of a SyncConnection It sets the connection in Sync mode.</xs:documentation>\r
114                                                                         </xs:annotation>\r
115                                                                         <xs:complexType>\r
116                                                                                 <xs:complexContent>\r
117                                                                                         <xs:extension base="Connection">\r
118                                                                                                 <xs:attribute name="MuteMode" type="SyncConnectionMuteMode" use="optional">\r
119                                                                                                         <xs:annotation>\r
120                                                                                                                 <xs:documentation>\r
121                                                                                                                         <UCSElementPath>/Unicens/Node/SyncConnection/@MuteMode</UCSElementPath>\r
122 Mode of operation of mute.\r
123 This attribute corresponds with the parameter MuteMode of the INIC function INIC.SyncCreate</xs:documentation>\r
124                                                                                                         </xs:annotation>\r
125                                                                                                 </xs:attribute>\r
126                                                                                         </xs:extension>\r
127                                                                                 </xs:complexContent>\r
128                                                                         </xs:complexType>\r
129                                                                 </xs:element>\r
130                                                                 <xs:element name="AVPConnection">\r
131                                                                         <xs:annotation>\r
132                                                                                 <xs:documentation>\r
133                                                                                         <UCSElementPath>/Unicens/Node/AVPConnection</UCSElementPath>\r
134 Configuration Structure of an AVP Connection. It sets the connection in AVP mode.</xs:documentation>\r
135                                                                         </xs:annotation>\r
136                                                                         <xs:complexType>\r
137                                                                                 <xs:complexContent>\r
138                                                                                         <xs:extension base="Connection">\r
139                                                                                                 <xs:attribute name="IsocPacketSize" type="AVPConnectionIsocPacketSize" use="required">\r
140                                                                                                         <xs:annotation>\r
141                                                                                                                 <xs:documentation>\r
142                                                                                                                         <UCSElementPath>/Unicens/Node/AVPConnection/@IsocPacketSize</UCSElementPath>\r
143 Size of data packets.\r
144 This attribute corresponds with the parameter IsocPacketSize of the INIC function INIC.AVPacketizedCreate</xs:documentation>\r
145                                                                                                         </xs:annotation>\r
146                                                                                                 </xs:attribute>\r
147                                                                                         </xs:extension>\r
148                                                                                 </xs:complexContent>\r
149                                                                         </xs:complexType>\r
150                                                                 </xs:element>\r
151                                                         </xs:choice>\r
152                                                 </xs:sequence>\r
153                                                 <xs:attribute name="Address" type="Number" use="required">\r
154                                                         <xs:annotation>\r
155                                                                 <xs:documentation>\r
156                                                                         <UCSElementPath>/Unicens/Node/@Address</UCSElementPath>\r
157 Address of the Unicens node</xs:documentation>\r
158                                                         </xs:annotation>\r
159                                                 </xs:attribute>\r
160                                                 <xs:attribute name="Script" type="xs:string" use="optional">\r
161                                                         <xs:annotation>\r
162                                                                 <xs:documentation>\r
163                                                                         <UCSElementPath>/Unicens/Node/@Script</UCSElementPath>\r
164 Script to which the node is linked.</xs:documentation>\r
165                                                         </xs:annotation>\r
166                                                 </xs:attribute>\r
167                                                 <xs:attribute name="Name" use="optional"/>\r
168                                         </xs:complexType>\r
169                                 </xs:element>\r
170                                 <xs:element name="Script">\r
171                                         <xs:annotation>\r
172                                                 <xs:documentation>\r
173                                                         <UCSElementPath>/Unicens/Script</UCSElementPath>\r
174 A script is a structure data composed of :\r
175 The command based on INIC FBlock-Syntax to be transmitted\r
176 The expected result also based on INIC FBlock-Syntax.\r
177 The amount time [in milliseconds] to pause before sending the Tx command.\r
178 \r
179 </xs:documentation>\r
180                                         </xs:annotation>\r
181                                         <xs:complexType>\r
182                                                 <xs:sequence>\r
183                                                         <xs:choice maxOccurs="unbounded">\r
184                                                                 <xs:element name="GPIOPortCreate">\r
185                                                                         <xs:annotation>\r
186                                                                                 <xs:documentation>\r
187                                                                                         <UCSElementPath>/Unicens/Script/GPIOPortCreate</UCSElementPath>\r
188 Creates the GPIO port with its associated port instance identifier.</xs:documentation>\r
189                                                                         </xs:annotation>\r
190                                                                         <xs:complexType>\r
191                                                                                 <xs:attribute name="DebounceTime" type="Number" use="required">\r
192                                                                                         <xs:annotation>\r
193                                                                                                 <xs:documentation>\r
194                                                                                                         <UCSElementPath>/Unicens/Script/GPIOPortCreate/@DebounceTime</UCSElementPath>\r
195 The timeout for the GPIO debounce timer (in ms).\r
196 </xs:documentation>\r
197                                                                                         </xs:annotation>\r
198                                                                                 </xs:attribute>\r
199                                                                         </xs:complexType>\r
200                                                                 </xs:element>\r
201                                                                 <xs:element name="GPIOPortPinMode">\r
202                                                                         <xs:annotation>\r
203                                                                                 <xs:documentation>\r
204                                                                                         <UCSElementPath>/Unicens/Script/GPIOPortPinMode</UCSElementPath>\r
205 This function is used for GPIO pin configuration.\r
206 To change a pin into a GPIO pin, it has to be configured via GPIOPortPinMode</xs:documentation>\r
207                                                                         </xs:annotation>\r
208                                                                         <xs:complexType>\r
209                                                                                 <xs:attribute name="PinConfiguration" type="HexData" use="required">\r
210                                                                                         <xs:annotation>\r
211                                                                                                 <xs:documentation>\r
212                                                                                                         <UCSElementPath>/Unicens/Script/GPIOPortPinMode/@PinConfiguration</UCSElementPath>\r
213 Defines the GPIO pin configuration and clears the trigger conditions on level-sensitive inputs and sticky inputs thereby allowing reporting of further trigger events.\r
214 Note that trigger conditions are automatically cleared for all edge-sensitive input/output GPIO classes when the INIC.GPIOPortTriggerEvent.Status message is sent.</xs:documentation>\r
215                                                                                         </xs:annotation>\r
216                                                                                 </xs:attribute>\r
217                                                                         </xs:complexType>\r
218                                                                 </xs:element>\r
219                                                                 <xs:element name="GPIOPinState">\r
220                                                                         <xs:annotation>\r
221                                                                                 <xs:documentation>\r
222                                                                                         <UCSElementPath>/Unicens/Script/GPIOPinState</UCSElementPath>TO DO - [State of GPIO Pin : High/Low]</xs:documentation>\r
223                                                                         </xs:annotation>\r
224                                                                         <xs:complexType>\r
225                                                                                 <xs:attribute name="Mask" type="Number" use="required">\r
226                                                                                         <xs:annotation>\r
227                                                                                                 <xs:documentation>\r
228                                                                                                         <UCSElementPath>/Unicens/Script/GPIOPinState/@Mask</UCSElementPath>\r
229 TO DO - [Changing certain data elements within a data store so that the structure remains similar while the information itself is changed to protect sensitive information]</xs:documentation>\r
230                                                                                         </xs:annotation>\r
231                                                                                 </xs:attribute>\r
232                                                                                 <xs:attribute name="Data" type="Number" use="required">\r
233                                                                                         <xs:annotation>\r
234                                                                                                 <xs:documentation>\r
235                                                                                                         <UCSElementPath>/Unicens/Script/GPIOPinState/@Data</UCSElementPath>  \r
236 TO DO - [Data to be given to GPIO Pin State]</xs:documentation>\r
237                                                                                         </xs:annotation>\r
238                                                                                 </xs:attribute>\r
239                                                                         </xs:complexType>\r
240                                                                 </xs:element>\r
241                                                                 <xs:element name="I2CPortCreate">\r
242                                                                         <xs:annotation>\r
243                                                                                 <xs:documentation>\r
244                                                                                         <UCSElementPath>/Unicens/Script/I2CPortCreate</UCSElementPath>\r
245 This function is used to define the I2C Port working as I2C-bus master. \r
246 The function creates the I2C Port with its associated port instance identifier. \r
247 \r
248 </xs:documentation>\r
249                                                                         </xs:annotation>\r
250                                                                         <xs:complexType>\r
251                                                                                 <xs:attribute name="Speed" type="I2CPortCreateSpeed" use="required">\r
252                                                                                         <xs:annotation>\r
253                                                                                                 <xs:documentation>\r
254                                                                                                         <UCSElementPath>/Unicens/Script/I2CPortCreate/@Speed</UCSElementPath>\r
255 The speed grade of I2C port.</xs:documentation>\r
256                                                                                         </xs:annotation>\r
257                                                                                 </xs:attribute>\r
258                                                                         </xs:complexType>\r
259                                                                 </xs:element>\r
260                                                                 <xs:element name="I2CPortWrite">\r
261                                                                         <xs:annotation>\r
262                                                                                 <xs:documentation>\r
263                                                                                         <UCSElementPath>/Unicens/Script/I2CPortWrite</UCSElementPath>\r
264 This function writes a block of bytes to an I2C device at a specified I2C address. \r
265 The function supports also a burst write mechanism for optimized transactions.\r
266 \r
267 </xs:documentation>\r
268                                                                         </xs:annotation>\r
269                                                                         <xs:complexType>\r
270                                                                                 <xs:attribute name="Mode" type="I2CPortWriteMode" use="optional">\r
271                                                                                         <xs:annotation>\r
272                                                                                                 <xs:documentation>\r
273                                                                                                         <UCSElementPath>/Unicens/Script/I2CPortWrite/@Mode</UCSElementPath>\r
274 The write transfer mode.</xs:documentation>\r
275                                                                                         </xs:annotation>\r
276                                                                                 </xs:attribute>\r
277                                                                                 <xs:attribute name="BlockCount" type="Number" use="optional">\r
278                                                                                         <xs:annotation>\r
279                                                                                                 <xs:documentation>\r
280                                                                                                         <UCSElementPath>/Unicens/Script/I2CPortWrite/@BlockCount</UCSElementPath>\r
281 The number of blocks to be written to the I2C address.\r
282 If parameter mode is not set to Burst Mode, the value of block_count has to be set to 0.\r
283 Otherwise the valid range of this parameter goes from 1 to 30. </xs:documentation>\r
284                                                                                         </xs:annotation>\r
285                                                                                 </xs:attribute>\r
286                                                                                 <xs:attribute name="Address" type="Number" use="required">\r
287                                                                                         <xs:annotation>\r
288                                                                                                 <xs:documentation>\r
289                                                                                                         <UCSElementPath>/Unicens/Script/I2CPortWrite/@Address</UCSElementPath>\r
290 Address of the target device. Use the UCS_ADDR_LOCAL_DEV macro to target the local device. \r
291 The following address ranges are supported:\r
292 â\80¢[0x10 ... 0x2FF]\r
293 â\80¢[0x500 ... 0xFEF]\r
294 â\80¢UCS_ADDR_LOCAL_DEV </xs:documentation>\r
295                                                                                         </xs:annotation>\r
296                                                                                 </xs:attribute>\r
297                                                                                 <xs:attribute name="Length" type="Number" use="optional">\r
298                                                                                         <xs:annotation>\r
299                                                                                                 <xs:documentation>\r
300                                                                                                         <UCSElementPath>/Unicens/Script/I2CPortWrite/@Length</UCSElementPath>\r
301 The total number of bytes to be written to the addressed I2C peripheral. \r
302 Even if parameter mode is set to Burst Mode, the data_len shall correspond to the whole size of the burst transfer.\r
303 That is, the data_len shall equal the size of a block times the block_count value.</xs:documentation>\r
304                                                                                         </xs:annotation>\r
305                                                                                 </xs:attribute>\r
306                                                                                 <xs:attribute name="Payload" type="HexData" use="required">\r
307                                                                                         <xs:annotation>\r
308                                                                                                 <xs:documentation>\r
309                                                                                                         <UCSElementPath>/Unicens/Script/I2CPortWrite/@PayLoad</UCSElementPath>\r
310 Payload bytes to be written on I2C</xs:documentation>\r
311                                                                                         </xs:annotation>\r
312                                                                                 </xs:attribute>\r
313                                                                                 <xs:attribute name="Timeout" type="Number" use="optional">\r
314                                                                                         <xs:annotation>\r
315                                                                                                 <xs:documentation>\r
316                                                                                                         <UCSElementPath>/Unicens/Script/I2CPortWrite/@Timeout</UCSElementPath>\r
317 The timeout for the I2C Port write. </xs:documentation>\r
318                                                                                         </xs:annotation>\r
319                                                                                 </xs:attribute>\r
320                                                                         </xs:complexType>\r
321                                                                 </xs:element>\r
322                                                                 <xs:element name="I2CPortRead">\r
323                                                                         <xs:annotation>\r
324                                                                                 <xs:documentation>\r
325                                                                                         <UCSElementPath>/Unicens/Script/I2CPortRead</UCSElementPath>\r
326 This function reads a block of bytes from an I2C device at a specified I2C address.\r
327 The function can only be used, if the I2C Port has been configured as Master. \r
328 If the I2C Port was configured as I2C-bus slave via the configuration string, an error message will be returned.  \r
329 </xs:documentation>\r
330                                                                         </xs:annotation>\r
331                                                                         <xs:complexType>\r
332                                                                                 <xs:attribute name="Address" type="Number" use="required">\r
333                                                                                         <xs:annotation>\r
334                                                                                                 <xs:documentation>\r
335                                                                                                         <UCSElementPath>/Unicens/Script/I2CPortRead/@Address</UCSElementPath>\r
336 Address of the target device. Use the UCS_ADDR_LOCAL_DEV macro to target the local device. \r
337 The following address ranges are supported:\r
338 â\80¢[0x10 ... 0x2FF]\r
339 â\80¢[0x500 ... 0xFEF]\r
340 â\80¢UCS_ADDR_LOCAL_DEV </xs:documentation>\r
341                                                                                         </xs:annotation>\r
342                                                                                 </xs:attribute>\r
343                                                                                 <xs:attribute name="Length" type="Number" use="required">\r
344                                                                                         <xs:annotation>\r
345                                                                                                 <xs:documentation>\r
346                                                                                                         <UCSElementPath>/Unicens/Script/I2CPortRead/@Length</UCSElementPath>\r
347 Number of bytes to be read from the address.</xs:documentation>\r
348                                                                                         </xs:annotation>\r
349                                                                                 </xs:attribute>\r
350                                                                                 <xs:attribute name="Timeout" type="Number" use="optional">\r
351                                                                                         <xs:annotation>\r
352                                                                                                 <xs:documentation>\r
353                                                                                                         <UCSElementPath>/Unicens/Script/I2CPortRead/@Timeout</UCSElementPath>\r
354 The timeout for the I2C Port read.</xs:documentation>\r
355                                                                                         </xs:annotation>\r
356                                                                                 </xs:attribute>\r
357                                                                         </xs:complexType>\r
358                                                                 </xs:element>\r
359                                                                 <xs:element name="MsgSend">\r
360                                                                         <xs:annotation>\r
361                                                                                 <xs:documentation>\r
362                                                                                         <UCSElementPath>/Unicens/Script/MsgSend</UCSElementPath>\r
363 TO DO</xs:documentation>\r
364                                                                         </xs:annotation>\r
365                                                                         <xs:complexType>\r
366                                                                                 <xs:attribute name="FBlockId" type="Number" use="required">\r
367                                                                                         <xs:annotation>\r
368                                                                                                 <xs:documentation>\r
369                                                                                                         <UCSElementPath>/Unicens/Script/MsgSend/@FBlockId</UCSElementPath>\r
370 FBlockId of the config msg.</xs:documentation>\r
371                                                                                         </xs:annotation>\r
372                                                                                 </xs:attribute>\r
373                                                                                 <xs:attribute name="FunctionId" type="Number" use="required">\r
374                                                                                         <xs:annotation>\r
375                                                                                                 <xs:documentation>\r
376                                                                                                         <UCSElementPath>/Unicens/Script/MsgSend/@FunctionId</UCSElementPath>\r
377 TO DO</xs:documentation>\r
378                                                                                         </xs:annotation>\r
379                                                                                 </xs:attribute>\r
380                                                                                 <xs:attribute name="OpTypeRequest" type="Number" use="required">\r
381                                                                                         <xs:annotation>\r
382                                                                                                 <xs:documentation>\r
383                                                                                                         <UCSElementPath>/Unicens/Script/MsgSend/@OpTypeRequest</UCSElementPath>\r
384 TO DO</xs:documentation>\r
385                                                                                         </xs:annotation>\r
386                                                                                 </xs:attribute>\r
387                                                                                 <xs:attribute name="OpTypeResponse" type="Number" use="optional">\r
388                                                                                         <xs:annotation>\r
389                                                                                                 <xs:documentation>\r
390                                                                                                         <UCSElementPath>/Unicens/Script/MsgSend/@OpTypeResponse</UCSElementPath>\r
391 TO DO</xs:documentation>\r
392                                                                                         </xs:annotation>\r
393                                                                                 </xs:attribute>\r
394                                                                                 <xs:attribute name="PayloadRequest" type="HexData" use="required">\r
395                                                                                         <xs:annotation>\r
396                                                                                                 <xs:documentation>\r
397                                                                                                         <UCSElementPath>/Unicens/Script/MsgSend/@PayloadRequest</UCSElementPath>\r
398 TO DO</xs:documentation>\r
399                                                                                         </xs:annotation>\r
400                                                                                 </xs:attribute>\r
401                                                                                 <xs:attribute name="PayloadResponse" type="HexData" use="optional">\r
402                                                                                         <xs:annotation>\r
403                                                                                                 <xs:documentation>\r
404                                                                                                         <UCSElementPath>/Unicens/Script/MsgSend/@PayloadResponse</UCSElementPath>\r
405 TO DO</xs:documentation>\r
406                                                                                         </xs:annotation>\r
407                                                                                 </xs:attribute>\r
408                                                                         </xs:complexType>\r
409                                                                 </xs:element>\r
410                                                                 <xs:element name="Pause">\r
411                                                                         <xs:annotation>\r
412                                                                                 <xs:documentation>\r
413                                                                                         <UCSElementPath>/Unicens/Script/Pause</UCSElementPath>\r
414 Specifies the pause which shall be set before sending the configuration message.</xs:documentation>\r
415                                                                         </xs:annotation>\r
416                                                                         <xs:complexType>\r
417                                                                                 <xs:attribute name="WaitTime" type="Number" use="required">\r
418                                                                                         <xs:annotation>\r
419                                                                                                 <xs:documentation>\r
420                                                                                                         <UCSElementPath>/Unicens/Script/Pause/@WaitTime</UCSElementPath>\r
421 TO DO -[Time for which pause is to be done]</xs:documentation>\r
422                                                                                         </xs:annotation>\r
423                                                                                 </xs:attribute>\r
424                                                                         </xs:complexType>\r
425                                                                 </xs:element>\r
426                                                         </xs:choice>\r
427                                                 </xs:sequence>\r
428                                                 <xs:attribute name="Name" type="xs:string" use="required">\r
429                                                         <xs:annotation>\r
430                                                                 <xs:documentation>\r
431                                                                         <UCSElementPath>/Unicens/Script/@Name</UCSElementPath>\r
432 Name of the Script</xs:documentation>\r
433                                                         </xs:annotation>\r
434                                                 </xs:attribute>\r
435                                         </xs:complexType>\r
436                                 </xs:element>\r
437                         </xs:choice>\r
438                         <xs:attribute name="AsyncBandwidth" type="Number" use="required">\r
439                                 <xs:annotation>\r
440                                         <xs:documentation>\r
441                                                 <UCSElementPath>/Unicens/@AsyncBandwidth</UCSElementPath>\r
442 Asynchronous bandwidth of the Unicens network.</xs:documentation>\r
443                                 </xs:annotation>\r
444                         </xs:attribute>\r
445                 </xs:complexType>\r
446         </xs:element>\r
447         <xs:complexType name="Connection">\r
448                 <xs:choice minOccurs="2" maxOccurs="2">\r
449                         <xs:element name="MOSTSocket" type="MOSTSocketType">\r
450                                 <xs:annotation>\r
451                                         <xs:documentation>\r
452                                                 <UCSElementPath>/Unicens/MOSTSocket</UCSElementPath>\r
453 Configuration Structure of a MOST Socket</xs:documentation>\r
454                                 </xs:annotation>\r
455                         </xs:element>\r
456                         <xs:element name="USBSocket">\r
457                                 <xs:annotation>\r
458                                         <xs:documentation>\r
459                                                 <UCSElementPath>/Unicens/USBSocket</UCSElementPath>\r
460 Configuration Structure of a USB Socket.</xs:documentation>\r
461                                 </xs:annotation>\r
462                                 <xs:complexType>\r
463                                         <xs:attribute name="EndpointAddress" type="Number" use="required">\r
464                                                 <xs:annotation>\r
465                                                         <xs:documentation>\r
466                                                                 <UCSElementPath>/Unicens/USBSocket/@EndpointAddress</UCSElementPath>\r
467 Address of a USB Endpoint.\r
468 This attribute corresponds with the parameter EndpointAddress of the INIC function INIC.USBSocketCreate</xs:documentation>\r
469                                                 </xs:annotation>\r
470                                         </xs:attribute>\r
471                                         <xs:attribute name="FramesPerTransaction" type="Number" use="required">\r
472                                                 <xs:annotation>\r
473                                                         <xs:documentation>\r
474                                                                 <UCSElementPath>/Unicens/USBSocket/@FramesPerTransaction</UCSElementPath>\r
475  FramesPerTransaction defines the number of data frames that are transferred within one USB bulk transaction.The value depends on the data type being used.\r
476  The MOST network frame is six times shorter than the duration of one USB Microframe, the minimum number of FramesPerTransaction must be 7.</xs:documentation>\r
477                                                 </xs:annotation>\r
478                                         </xs:attribute>\r
479                                 </xs:complexType>\r
480                         </xs:element>\r
481                         <xs:element name="MediaLBSocket">\r
482                                 <xs:annotation>\r
483                                         <xs:documentation>\r
484                                                 <UCSElementPath>/Unicens/MediaLBSocket</UCSElementPath>\r
485 Configuration Structure of MediaLB Socket</xs:documentation>\r
486                                 </xs:annotation>\r
487                                 <xs:complexType>\r
488                                         <xs:attribute name="ChannelAddress" type="Number" use="required">\r
489                                                 <xs:annotation>\r
490                                                         <xs:documentation>\r
491                                                                 <UCSElementPath>/Unicens/MediaLBSocket/@ChannelAddress</UCSElementPath>\r
492 MLB Channel address.\r
493 This attribute corresponds with the parameter ChannelAddress of the INIC function INIC.MediaLBSocketCreate.</xs:documentation>\r
494                                                 </xs:annotation>\r
495                                         </xs:attribute>\r
496                                         <xs:attribute name="Bandwidth" type="xs:integer" use="required">\r
497                                                 <xs:annotation>\r
498                                                         <xs:documentation>\r
499                                                                 <UCSElementPath>/Unicens/MediaLBSocket/@Bandwidth</UCSElementPath>\r
500 Required socket bandwidth in bytes.\r
501 This attribute corresponds with the parameter Bandwidth of the INIC function INIC.StreamSocketCreate.</xs:documentation>\r
502                                                 </xs:annotation>\r
503                                         </xs:attribute>\r
504                                 </xs:complexType>\r
505                         </xs:element>\r
506                         <xs:element name="StreamSocket">\r
507                                 <xs:annotation>\r
508                                         <xs:documentation>\r
509                                                 <UCSElementPath>/Unicens/StreamSocket</UCSElementPath>\r
510 Configuration Structure of a streaming data Socket</xs:documentation>\r
511                                 </xs:annotation>\r
512                                 <xs:complexType>\r
513                                         <xs:attribute name="StreamPinID" type="StreamSocketStreamPinID" use="required">\r
514                                                 <xs:annotation>\r
515                                                         <xs:documentation>\r
516                                                                 <UCSElementPath>/Unicens/StreamSocket/@StreamPinID</UCSElementPath>\r
517 ID of the serial interface pin.\r
518 This attribute corresponds with the parameter StreamPinID of the INIC function INIC.StreamSocketCreate.</xs:documentation>\r
519                                                 </xs:annotation>\r
520                                         </xs:attribute>\r
521                                         <xs:attribute name="Bandwidth" type="xs:integer" use="required">\r
522                                                 <xs:annotation>\r
523                                                         <xs:documentation>\r
524                                                                 <UCSElementPath>/Unicens/StreamSocket/@Bandwidth</UCSElementPath>\r
525 Required socket bandwidth in bytes.\r
526 This attribute corresponds with the parameter Bandwidth of the INIC function INIC.StreamSocketCreate.</xs:documentation>\r
527                                                 </xs:annotation>\r
528                                         </xs:attribute>\r
529                                 </xs:complexType>\r
530                         </xs:element>\r
531                         <xs:element name="Splitter" type="SplitterCombinerType">\r
532                                 <xs:annotation>\r
533                                         <xs:documentation>\r
534                                                 <UCSElementPath>/Unicens/Splitter</UCSElementPath>\r
535 Configuration Structure of a splitter resource.\r
536 A splitter enables two variants of routing to be set-up. The first variant is a splitter created with a peripheral socket.\r
537 It enables data routing from a specified segment of the peripheral socket to a MOST socket. \r
538 The second variant is a splitter created with a MOST socket. \r
539 This variant enables data routing in its whole (no segments) from the MOST socket to multiple peripheral sockets.\r
540 </xs:documentation>\r
541                                 </xs:annotation>\r
542                         </xs:element>\r
543                         <xs:element name="Combiner" type="SplitterCombinerType">\r
544                                 <xs:annotation>\r
545                                         <xs:documentation>\r
546                                                 <UCSElementPath>/Unicens/Combiner</UCSElementPath>\r
547 Configuration Structure of a combiner resource.\r
548 A combiner enables streaming data to be routed from a MOST socket to a specified segment of a peripheral socket. \r
549 The same combiner may be used in multiple connections, which enables grouping of data streams from multiple MOST sockets into the same peripheral socket.\r
550 </xs:documentation>\r
551                                 </xs:annotation>\r
552                         </xs:element>\r
553                 </xs:choice>\r
554         </xs:complexType>\r
555         <xs:simpleType name="Number">\r
556                 <xs:annotation>\r
557                         <xs:documentation>Hexadecimal or decimal number in the format 0xd..d</xs:documentation>\r
558                 </xs:annotation>\r
559                 <xs:restriction base="xs:string">\r
560                         <xs:pattern value="([0-9]+)|(0x(0|[1-9a-fA-F][0-9a-fA-F]*))"/>\r
561                 </xs:restriction>\r
562         </xs:simpleType>\r
563         <xs:simpleType name="USBPortPhysicalLayer">\r
564                 <xs:annotation>\r
565                         <xs:documentation>Physical Layer of USB port</xs:documentation>\r
566                 </xs:annotation>\r
567                 <xs:restriction base="xs:string">\r
568                         <xs:enumeration value="Standard"/>\r
569                         <xs:enumeration value="HSIC"/>\r
570                 </xs:restriction>\r
571         </xs:simpleType>\r
572         <xs:simpleType name="MediaLBPortClockConfig">\r
573                 <xs:annotation>\r
574                         <xs:documentation>Clock Config of MediaLB port</xs:documentation>\r
575                 </xs:annotation>\r
576                 <xs:restriction base="xs:string">\r
577                         <xs:enumeration value="256Fs"/>\r
578                         <xs:enumeration value="512Fs"/>\r
579                         <xs:enumeration value="1024Fs"/>\r
580                         <xs:enumeration value="2048Fs"/>\r
581                         <xs:enumeration value="3072Fs"/>\r
582                         <xs:enumeration value="4096Fs"/>\r
583                         <xs:enumeration value="6114Fs"/>\r
584                         <xs:enumeration value="8192Fs"/>\r
585                 </xs:restriction>\r
586         </xs:simpleType>\r
587         <xs:simpleType name="StreamPortClockConfig">\r
588                 <xs:annotation>\r
589                         <xs:documentation>Clock Config of Stream port</xs:documentation>\r
590                 </xs:annotation>\r
591                 <xs:restriction base="xs:string">\r
592                         <xs:enumeration value="8Fs"/>\r
593                         <xs:enumeration value="16fs"/>\r
594                         <xs:enumeration value="32Fs"/>\r
595                         <xs:enumeration value="64Fs"/>\r
596                         <xs:enumeration value="128Fs"/>\r
597                         <xs:enumeration value="256Fs"/>\r
598                         <xs:enumeration value="512Fs"/>\r
599                         <xs:enumeration value="Willdcard"/>\r
600                 </xs:restriction>\r
601         </xs:simpleType>\r
602         <xs:simpleType name="StreamPortDataAlignment">\r
603                 <xs:annotation>\r
604                         <xs:documentation>Data Alignment of Stream port</xs:documentation>\r
605                 </xs:annotation>\r
606                 <xs:restriction base="xs:string">\r
607                         <xs:enumeration value="Left16Bit"/>\r
608                         <xs:enumeration value="Left24Bit"/>\r
609                         <xs:enumeration value="Right16Bit"/>\r
610                         <xs:enumeration value="Right24Bit"/>\r
611                         <xs:enumeration value="Seq"/>\r
612                 </xs:restriction>\r
613         </xs:simpleType>\r
614         <xs:simpleType name="StreamSocketStreamPinID">\r
615                 <xs:annotation>\r
616                         <xs:documentation>Stream Pin ID of Stream socket</xs:documentation>\r
617                 </xs:annotation>\r
618                 <xs:restriction base="xs:string">\r
619                         <xs:enumeration value="SRXA0"/>\r
620                         <xs:enumeration value="SRXA1"/>\r
621                         <xs:enumeration value="SRXB0"/>\r
622                         <xs:enumeration value="SRXB1"/>\r
623                 </xs:restriction>\r
624         </xs:simpleType>\r
625         <xs:simpleType name="SyncConnectionMuteMode">\r
626                 <xs:annotation>\r
627                         <xs:documentation>Mute Mode of Sync connection</xs:documentation>\r
628                 </xs:annotation>\r
629                 <xs:restriction base="xs:string">\r
630                         <xs:enumeration value="NoMuting"/>\r
631                         <xs:enumeration value="MuteSignal"/>\r
632                 </xs:restriction>\r
633         </xs:simpleType>\r
634         <xs:simpleType name="AVPConnectionIsocPacketSize">\r
635                 <xs:annotation>\r
636                         <xs:documentation>Isoc Packet Size of AVP connection</xs:documentation>\r
637                 </xs:annotation>\r
638                 <xs:restriction base="xs:integer">\r
639                         <xs:enumeration value="188"/>\r
640                         <xs:enumeration value="196"/>\r
641                         <xs:enumeration value="206"/>\r
642                 </xs:restriction>\r
643         </xs:simpleType>\r
644         <xs:simpleType name="I2CPortCreateSpeed">\r
645                 <xs:annotation>\r
646                         <xs:documentation>Speed parameter of I2CPortCreate</xs:documentation>\r
647                 </xs:annotation>\r
648                 <xs:restriction base="xs:string">\r
649                         <xs:enumeration value="SlowMode"/>\r
650                         <xs:enumeration value="FastMode"/>\r
651                 </xs:restriction>\r
652         </xs:simpleType>\r
653         <xs:simpleType name="I2CPortWriteMode">\r
654                 <xs:annotation>\r
655                         <xs:documentation>Mode parameter of I2CPortWrite</xs:documentation>\r
656                 </xs:annotation>\r
657                 <xs:restriction base="xs:string">\r
658                         <xs:enumeration value="DefaultMode"/>\r
659                         <xs:enumeration value="RepeatedStartMode"/>\r
660                         <xs:enumeration value="BurstMode"/>\r
661                 </xs:restriction>\r
662         </xs:simpleType>\r
663         <xs:simpleType name="HexData">\r
664                 <xs:annotation>\r
665                         <xs:documentation>String which represents byte array as hexadecimal digits with space after each two digits</xs:documentation>\r
666                 </xs:annotation>\r
667                 <xs:restriction base="xs:string">\r
668                         <xs:pattern value="[0-9a-fA-F]{2}(\s+[0-9a-fA-F]{2})*"/>\r
669                 </xs:restriction>\r
670         </xs:simpleType>\r
671         <xs:complexType name="SplitterCombinerType">\r
672         <xs:annotation>\r
673                 <xs:documentation><UCSElementPath>/Unicens/SplitterCombinerType</UCSElementPath>TO DO</xs:documentation>\r
674         </xs:annotation>\r
675         <xs:sequence>\r
676                         <xs:element name="MOSTSocket" type="SCMOSTSocketType" maxOccurs="unbounded">\r
677                                 <xs:annotation>\r
678                                         <xs:documentation><UCSElementPath>/Unicens/SplitterCombinerType/MOSTSocket</UCSElementPath>TO DO - [Combination of Splitter and combiner.\r
679 Splitter : enables two variants of routing to be set-up. The first variant is a splitter created with a peripheral socket.\r
680 It enables data routing from a specified segment of the peripheral socket to a MOST socket. The second variant is a splitter created with a MOST socket. \r
681 This variant enables data routing in its whole (no segments) from the MOST socket to multiple peripheral sockets.\r
682 \r
683 Combiner : A combiner enables streaming data to be routed from a MOST socket to a specified segment of a peripheral socket. \r
684 The same combiner may be used in multiple connections, which enables grouping of data streams from multiple MOST sockets into the same peripheral socket ]</xs:documentation>\r
685                                 </xs:annotation>\r
686                         </xs:element>\r
687                 </xs:sequence>\r
688                 <xs:attribute name="BytesPerFrame" type="xs:integer" use="required">\r
689                         <xs:annotation>\r
690                                 <xs:documentation><UCSElementPath>/Unicens/SplitterCombinerType/@BytesPerFrame</UCSElementPath>\r
691 Total number of data bytes to be transferred each MOST network frame.\r
692 </xs:documentation>\r
693                         </xs:annotation>\r
694                 </xs:attribute>\r
695         </xs:complexType>\r
696         <xs:complexType name="MOSTSocketType">\r
697         <xs:annotation>\r
698                 <xs:documentation><UCSElementPath>/Unicens/MOSTSocketType</UCSElementPath>TO DO</xs:documentation>\r
699         </xs:annotation>\r
700         <xs:attribute name="Route" type="xs:string" use="required">\r
701                         <xs:annotation>\r
702                                 <xs:documentation><UCSElementPath>/Unicens/MOSTSocketType/@Route</UCSElementPath>\r
703 A (virtual) route is a logical unidirectional connection between two endpoints. An endpoint acts as a MOST connection in INIC plus the internal linked resources</xs:documentation>\r
704                         </xs:annotation>\r
705         </xs:attribute>\r
706                 <xs:attribute name="Bandwidth" type="xs:integer" use="required">\r
707                         <xs:annotation>\r
708                                 <xs:documentation><UCSElementPath>/Unicens/MOSTSocketType/@Bandwidth</UCSElementPath>TO DO - [Bandwidth of MOST Socket Type] </xs:documentation>\r
709                         </xs:annotation>\r
710                 </xs:attribute>\r
711                 <xs:attribute name="IsActive" type="xs:boolean" use="optional">\r
712                         <xs:annotation>\r
713                                 <xs:documentation><UCSElementPath>/Unicens/MOSTSocketType/@IsActive</UCSElementPath>TO DO -[Determines the state of MOST Socket type : Active/Inactive]</xs:documentation>\r
714                         </xs:annotation>\r
715                 </xs:attribute>\r
716                 <xs:attribute name="RouteId" type="Number" use="optional">\r
717                         <xs:annotation>\r
718                                 <xs:documentation><UCSElementPath>/Unicens/MOSTSocketType/@RouteId</UCSElementPath>\r
719 User-defined route identifier</xs:documentation>\r
720                         </xs:annotation>\r
721                 </xs:attribute>\r
722         </xs:complexType>\r
723         <xs:complexType name="SCMOSTSocketType">\r
724         <xs:annotation>\r
725                 <xs:documentation><UCSElementPath>/Unicens/SCMOSTSocketType</UCSElementPath>TO DO</xs:documentation>\r
726         </xs:annotation>\r
727         <xs:complexContent>\r
728                         <xs:extension base="MOSTSocketType">\r
729                                 <xs:attribute name="Offset" type="xs:integer" use="required">\r
730                                         <xs:annotation>\r
731                                                 <xs:documentation><UCSElementPath>/Unicens/SCMOSTSocketType/@Offset</UCSElementPath>\r
732 Offset from where the socket data should be routed from a splitter.\r
733 </xs:documentation>\r
734                                         </xs:annotation></xs:attribute>\r
735                         </xs:extension>\r
736                 </xs:complexContent>\r
737         </xs:complexType>\r
738 </xs:schema>\r