-
Notifications
You must be signed in to change notification settings - Fork 5
/
xcp.schema.json
533 lines (533 loc) · 20.1 KB
/
xcp.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
{
"type": "object",
"properties": {
"configurations": {
"type": "array",
"items": {
"type": "object",
"properties": {
"communication": {
"description": "This container represents the configuration of the communication channel of XCP (see ECUC_Xcp_00183)",
"type": "object",
"properties": {
"channel_rx_pdu_ref": {
"description": "Optional reference to the XCP Rx PDU (see ECUC_Xcp_00185)",
"type": "string",
"pattern": "[A-Z_][A-Z0-9_]*"
},
"channel_tx_pdu_ref": {
"description": "Reference to the XCP Tx PDU (see ECUC_Xcp_00184)",
"type": "string",
"pattern": "[A-Z_][A-Z0-9_]*"
},
"com_m_channel_ref": {
"description": "Reference to the ComM channel the PDUs belong to (see ECUC_Xcp_00186)",
"type": "string",
"pattern": "[A-Z_][A-Z0-9_]*"
}
},
"required": [
"channel_rx_pdu_ref",
"channel_tx_pdu_ref"
]
},
"events": {
"description": "This container contains the configuration of event channels on the XCP slave (see ECUC_Xcp_00150)",
"type": "array",
"items": {
"type": "object",
"properties": {
"consistency": {
"description": "Type of consistency used by event channel (see ECUC_Xcp_00171)",
"type": "string",
"enum": [
"DAQ",
"EVENT",
"ODT"
],
"default": "ODT"
},
"priority": {
"description": "Priority of the event channel",
"type": "integer",
"minimum": 0,
"maximum": 255
},
"time_cycle": {
"description": "The event channel time cycle indicates which sampling period is used to\nprocess this event channel. A value of 0 means 'Not cyclic' (see ECUC_Xcp_00173)",
"type": "integer",
"minimum": 0,
"maximum": 255
},
"time_unit": {
"description": "This configuration parameter indicates the unit of the event channel time cycle (see ECUC_Xcp_00174)",
"type": "string",
"enum": [
"TIMESTAMP_UNIT_1S",
"TIMESTAMP_UNIT_1MS",
"TIMESTAMP_UNIT_10MS",
"TIMESTAMP_UNIT_100MS",
"TIMESTAMP_UNIT_1US",
"TIMESTAMP_UNIT_10US",
"TIMESTAMP_UNIT_100US",
"TIMESTAMP_UNIT_1NS",
"TIMESTAMP_UNIT_10NS",
"TIMESTAMP_UNIT_100NS",
"TIMESTAMP_UNIT_1PS",
"TIMESTAMP_UNIT_10PS",
"TIMESTAMP_UNIT_100PS"
]
},
"type": {
"description": "This configuration parameter indicates what kind of DAQ list can be allocated to this event channel (see ECUC_Xcp_00172)",
"type": "string",
"enum": [
"DAQ",
"DAQ_STIM"
],
"default": "DAQ"
},
"triggered_daq_list_ref": {
"description": "References all DAQ lists that are trigged by this event channel (see ECUC_Xcp_00151)",
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"priority",
"time_cycle",
"time_unit",
"triggered_daq_list_ref"
]
},
"minItems": 1,
"maxItems": 65534
},
"daqs": {
"description": "This container contains the configuration of the DAQs.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "Name of the DAQ used as a reference within /configurations[x]/events[x]/triggered_daq_list_ref",
"type": "string",
"pattern": "[A-Z_][A-Z0-9_]*"
},
"type": {
"description": "This indicates whether this DAQ list represents a DAQ or a STIM (see ECUC_Xcp_00052)",
"type": "string",
"enum": [
"DAQ",
"DAQ_STIM",
"STIM"
]
},
"max_odt": {
"description": "MAX_ODT indicates the maximum amount of ODTs in this DAQ list (STATIC configuration) (see ECUC_Xcp_00053)",
"type": "integer",
"minimum": 0,
"maximum": 252
},
"max_odt_entries": {
"description": "This parameter indicates the maximum amount of entries in an ODT of this DAQ list (STATIC configuration) (see ECUC_Xcp_00058)",
"type": "integer",
"minimum": 0,
"maximum": 255
},
"pdu_mapping": {
"description": "This reference specifies the mapping of the DTO to the PDUs from the lower-layer interfaces (CanIf, FrIf, SoAd and Cdd). A reference to a XcpRxPdu is only feasible if the the DaqListType is DAQ_STIM. A reference to a XcpTxPdu is only feasible if the DaqListType is DAQ (see ECUC_Xcp_00067)",
"type": "string",
"pattern": "[A-Z_][A-Z0-9_]*"
},
"dtos": {
"description": "This container collects data transfer object specific parameters for the DAQ list (see ECUC_Xcp_00065)",
"type": "array",
"items": {
"type": "object",
"properties": {
"pid": {
"description": "Packet identifier (PID) of the DTO that identifies the ODT the content of the DTO (see ECUC_Xcp_00066)",
"type": "integer",
"minimum": 0,
"maximum": 251
}
},
"required": [
"pid"
]
},
"minItems": 1
}
},
"required": [
"name",
"type",
"max_odt",
"max_odt_entries",
"pdu_mapping",
"dtos"
]
},
"minItems": 1
},
"apis": {
"description": "This container allows the user to enable/disable optional APIs from the driver. This is not part of the specification",
"type": "object",
"properties": {
"xcp_set_request_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_get_id_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_get_seed_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_unlock_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_set_mta_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_upload_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_short_upload_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_build_checksum_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_download_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_download_max_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_short_download_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_set_cal_page_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_get_cal_page_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_clear_daq_list_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_set_daq_ptr_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_write_daq_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_set_daq_list_mode_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_get_daq_list_mode_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_start_stop_daq_list_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_start_stop_synch_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_get_daq_clock_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_read_daq_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_get_daq_processor_info_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_get_daq_resolution_info_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_get_daq_list_info_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_get_daq_event_info_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_free_daq_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_alloc_daq_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_alloc_odt_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_alloc_odt_entry_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_program_clear_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_program_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_program_max_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"xcp_get_comm_mode_info_api_enable": {
"$ref": "#/definitions/api_activation_information"
},
"resource_protection": {
"type": "object",
"properties": {
"calibration_paging": {
"type": "boolean",
"default": false
},
"data_acquisition": {
"type": "boolean",
"default": false
},
"data_stimulation": {
"type": "boolean",
"default": false
},
"programming": {
"type": "boolean",
"default": false
}
},
"required": [
"calibration_paging",
"data_acquisition",
"data_stimulation",
"programming"
]
}
},
"required": [
"xcp_set_request_api_enable",
"xcp_get_id_api_enable",
"xcp_get_seed_api_enable",
"xcp_unlock_api_enable",
"xcp_set_mta_api_enable",
"xcp_upload_api_enable",
"xcp_short_upload_api_enable",
"xcp_build_checksum_api_enable",
"xcp_download_api_enable",
"xcp_download_max_api_enable",
"xcp_short_download_api_enable",
"xcp_set_cal_page_api_enable",
"xcp_get_cal_page_api_enable",
"xcp_clear_daq_list_api_enable",
"xcp_set_daq_ptr_api_enable",
"xcp_write_daq_api_enable",
"xcp_set_daq_list_mode_api_enable",
"xcp_get_daq_list_mode_api_enable",
"xcp_start_stop_daq_list_api_enable",
"xcp_start_stop_synch_api_enable",
"xcp_get_daq_clock_api_enable",
"xcp_read_daq_api_enable",
"xcp_get_daq_processor_info_api_enable",
"xcp_get_daq_resolution_info_api_enable",
"xcp_get_daq_list_info_api_enable",
"xcp_get_daq_event_info_api_enable",
"xcp_free_daq_api_enable",
"xcp_alloc_daq_api_enable",
"xcp_alloc_odt_api_enable",
"xcp_alloc_odt_entry_api_enable",
"xcp_program_clear_api_enable",
"xcp_program_api_enable",
"xcp_program_max_api_enable",
"xcp_get_comm_mode_info_api_enable",
"resource_protection"
]
},
"protocol_layer": {
"description": "This container allows the user to specify protocol layer specific parameters. This is not part of the specification",
"type": "object",
"properties": {
"byte_order": {
"type": "string",
"enum": [
"LITTLE_ENDIAN",
"BIG_ENDIAN"
],
"default": "LITTLE_ENDIAN"
},
"address_granularity": {
"type": "string",
"enum": [
"BYTE",
"WORD",
"DWORD"
],
"default": "DWORD"
},
"master_block_mode": {
"description": "MASTER_BLOCK_MODE flag indicates whether the master block mode is available.",
"type": "boolean",
"default": true
},
"slave_block_mode": {
"type": "boolean",
"default": true
},
"interleaved_mode": {
"description": "INTERLEAVED_MODE flag indicates whether the interleaved mode is available. If interleaved mode is available, QUEUE_SIZE indicates the maximum number of consecutive command packets the master can send to the receipt queue of the slave.",
"type": "boolean",
"default": false
},
"max_bs": {
"description": "MAX_BS indicates the maximum allowed block size as the number of consecutive command packets (DOWNLOAD_NEXT or PROGRAM_NEXT) in a block sequence.",
"type": "integer",
"default": 255,
"minimum": 0,
"maximum": 255
},
"min_st": {
"description": "MIN_ST indicates the required minimum separation time between the packets of a block transfer from the master device to the slave device in units of 100 microseconds.",
"type": "integer",
"default": 255,
"minimum": 0,
"maximum": 255
},
"cto_queue_size": {
"description": "CTO_QUEUE_SIZE indicates the maximum number of consecutive command packets the master can send to the receipt queue of the slave.",
"type": "integer",
"default": 16,
"minimum": 0,
"maximum": 255
},
"event_queue_size": {
"description": "EVENT_QUEUE_SIZE indicates the maximum number of events stacked before dropping them, in case the slave is not able to transmit them to the master.",
"type": "integer",
"default": 16,
"minimum": 0,
"maximum": 255
},
"max_cto": {
"description": "MAX_CTO shows the maximum length of a CTO packet in bytes (see ECUC_Xcp_00004)\nNote: the AUTOSAR specification defines the upper limit to 255.",
"type": "integer",
"minimum": 8,
"maximum": 256,
"default": 8
},
"max_dto": {
"type": "integer",
"minimum": 8,
"maximum": 65535,
"default": 8
},
"checksum_type": {
"type": "string",
"enum": [
"XCP_ADD_11",
"XCP_ADD_12",
"XCP_ADD_14",
"XCP_ADD_22",
"XCP_ADD_24",
"XCP_ADD_44",
"XCP_CRC_16",
"XCP_CRC_16_CITT",
"XCP_CRC_32",
"XCP_USER_DEFINED"
],
"default": "XCP_CRC_32"
},
"user_defined_checksum_function": {
"OneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"Xcp_UserDefinedChecksumFunction"
]
}
],
"default": null
},
"user_cmd_function": {
"OneOf": [
{
"type": "null"
},
{
"type": "string",
"enum": [
"Xcp_UserCmdFunction"
]
}
],
"default": null
},
"trailing_value": {
"type": "integer",
"minimum": 0,
"maximum": 255,
"default": 0
},
"identification": {
"type": "string",
"default": "/path/to/database.a2l"
}
},
"required": [
"byte_order",
"address_granularity",
"master_block_mode",
"slave_block_mode",
"interleaved_mode",
"max_bs",
"min_st",
"cto_queue_size",
"event_queue_size",
"max_cto",
"max_dto",
"checksum_type",
"user_defined_checksum_function",
"user_cmd_function",
"trailing_value",
"identification"
]
}
},
"required": [
"communication",
"events",
"daqs",
"apis",
"protocol_layer"
],
"additionalProperties": false
},
"minItems": 1
}
},
"required": [
"configurations"
],
"definitions": {
"api_activation_information": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"default": true
},
"protected": {
"type": "boolean",
"default": false
}
},
"required": [
"enabled",
"protected"
]
}
}
}