summaryrefslogtreecommitdiff
path: root/documentation/vsomeipProtocol
blob: 2fc905ed04325dc1761ca907b7e90ddb8f5ef5d3 (plain)
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
vSomeIP command documentation
=============================

VSOMEIP_ASSIGN_CLIENT (0x00)

Command            00
Version            xx xx
Client             xx xx
Size               xx xx xx xx
Name               xx ... xx        ;#xx = Size


VSOMEIP_ASSIGN_CLIENT_ACK (0x01)

Command            01
Version            xx xx
Client             xx xx        
Size               02 00 00 00    
Assigned           xx xx


VSOMEIP_REGISTER_APPLICATION (0x02)

Command            02
Version            xx xx
Client             xx xx
Size               00 00 00 00


VSOMEIP_DEREGISTER_APPLICATION (0x03)

Command            03
Version            xx xx
Client             xx xx
Size               00 00 00 00


VSOMEIP_APPLICATION_LOST (0x04)

<unused>


VSOMEIP_ROUTING_INFO (0x05)

Command            05
Version            xx xx
Client             xx xx
Size               xx xx xx xx
Entries        
    SubCommand     xx        ; RIE_ADD_CLIENT (0x0) or RIE_DEL_CLIENT (0x1)
    Size           xx xx xx xx
    Client         xx xx
    [Address]      xx .. xx    ; Size - sizeof(Client) - sizeof(Port)
    [Port]         xx

    SubCommand     xx        ; RIE_ADD_SERVICE_INSTANCE (0x2) or RIE_DEL_SERVICE_INSTANCE (0x3)
    Size           xx xx xx xx    ; Command size
    Size           xx xx xx xx    ; Client info size
    Client         xx xx
    [Address]      xx .. xx    ; Client info size - sizeof(Client) - sizeof(Port)
    [Port]         xx
    Size           xx xx xx xx    ; Services size
        Service    xx xx
        Instance   xx xx
        Major      xx
        Minor      xx xx xx xx
            

VSOMEIP_REGISTERED_ACK (0x06)

Command            06
Version            xx xx
Client             xx xx
Size               00 00 00 00


VSOMEIP_PING (0x07)

Command            07
Version            xx xx
Client             00 00
Size               00 00 00 00


VSOMEIP_PONG (0x08)

Command            08
Version            xx xx
Client             xx xx
Size               00 00 00 00


VSOMEIP_OFFER_SERVICE (0x10)

Command            10
Version            xx xx
Client             xx xx
Size               09 00 00 00
Service            xx xx
Instance           xx xx
Major              xx
Minor              xx xx xx xx
            

VSOMEIP_STOP_OFFER_SERVICE (0x11)

Command            11
Version            xx xx
Client             xx xx
Size               09 00 00 00
Service            xx xx
Instance           xx xx
Major              xx
Minor              xx xx xx xx


VSOMEIP_SUBSCRIBE (0x12)

Command            12
Version            xx xx
Client             xx xx
Size               xx xx xx xx
Service            xx xx
Instance           xx xx
Eventgroup         xx xx
Major              xx
Event              xx xx
Pending ID         xx xx
Filter
    OnChange                xx
    OnChangeResetsInterval  xx
    Interval                xx xx xx xx xx xx xx xx
    Ignore (per entry)
        Key                 xx xx xx xx xx xx xx xx
        Value               xx


VSOMEIP_UNSUBSCRIBE (0x13)
VSOMEIP_EXPIRE (0x2A)

Command            13/2A
Version            xx xx
Client             xx xx
Size               0a 00 00 00
Service            xx xx
Instance           xx xx
Eventgroup         xx xx
Event              xx xx
Pending ID         xx xx


VSOMEIP_REQUEST_SERVICE (0x14)

Command            14
Version            xx xx
Client             xx xx
Size               xx xx xx xx
Entries
    Service        xx xx
    Instance       xx xx
    Major          xx
    Minor          xx xx xx xx

    
VSOMEIP_RELEASE_SERVICE (0x15)

Command            15
Version            xx xx
Client             xx xx
Size               04 00 00 00
Service            xx xx
Instance           xx xx


VSOMEIP_SUBSCRIBE_NACK (0x16)

Command            16
Version            xx xx
Client             xx xx
Size               0c 00 00 00
Service            xx xx
Instance           xx xx
Eventgroup         xx xx
Subscriber         xx xx
Event              xx xx
ID                 xx xx


VSOMEIP_SUBSCRIBE_ACK (0x17)

Command            17
Version            xx xx
Client             xx xx
Size               0c 00 00 00
Service            xx xx
Instance           xx xx
Eventgroup         xx xx
Subscriber         xx xx
Event              xx xx
ID                 xx xx


VSOMEIP_SEND (0x18)
VSOMEIP_NOTIFY (0x19)
VSOMEIP_NOTIFY_ONE (0x1A)

Command            18|19|1a
Version            xx xx
Client             xx xx
Size               xx xx xx xx
Instance           xx xx
Reliable           xx        ; UDP (00) or TCP (01)
Status             xx        ; CRC of E2E - protected messages
Destination        xx xx     ; Client ID of the receiver
Payload            xx ... xx


VSOMEIP_REGISTER_EVENT (0x1B)

Command            1b
Version            xx xx
Client             xx xx
Size               xx xx xx xx    ; 10 + #eventgroups * 2
Entries
    Service            xx xx
    Instance           xx xx
    Notifier           xx xx
    Type               xx    ; ET_EVENT (00), ET_SELECTIVE_EVENT(01) or ET_FIELD(02)
    Provided           xx    ; False (00) or True (01)
    Reliability        xx    ; UDP (00) or TCP (01)
    IsCyclic           xx
    Num Eventgroups    xx xx
    Entries
        Eventgroup     xx xx


VSOMEIP_UNREGISTER_EVENT (0x1C)

Command            1c
Version            xx xx
Client             xx xx
Size               07 00 00 00
Service            xx xx
Instance           xx xx
Notifier           xx xx
Provided           xx


VSOMEIP_ID_RESPONSE (0x1D)

<unused>


VSOMEIP_ID_REQUEST (0x1E)

<unused>


VSOMEIP_OFFERED_SERVICES_REQUEST (0x1F)

Command            1f
Version            xx xx
Client             xx xx
Size               01 00 00 00
OfferType          xx (00 = LOCAL, 01 = REMOTE, 02 = ALL)


VSOMEIP_OFFERED_SERVICES_RESPONSE (0x20)

Command            20
Version            xx xx
Client             xx xx
Size               xx xx xx xx 
OfferedServices
    Subcommand     xx    (00 = ADD CLIENT, 01 = ADD SERVICE INSTANCE, 02 = DELETE SERVICE INSTANCE, 03 = DELETE CLIENT)
    Size           xx xx xx xx
    ServiceInstances
        Service    xx xx
        Instance   xx xx
        Major      xx xx
        Minor      xx xx
        
        
VSOMEIP_UNSUBSCRIBE_ACK (0x21)

Command            21
Version            xx xx
Client             xx xx
Size               08 00 00 00
Service            xx xx
Instance           xx xx
Eventgroup         xx xx
Id                 xx xx            


VSOMEIP_RESEND_PROVIDED_EVENTS (0x22)

Command            22
Version            xx xx
Client             xx xx
Size               04 00 00 00
PendingOfferId     xx xx xx xx
    

VSOMEIP_UPDATE_SECURITY_POLICY (0x23)
VSOMEIP_UPDATE_SECURITY_POLICY_INT (0x29)

Command            23/29
Version            xx xx
Client             xx xx
Size               xx xx xx xx
UpdateId           xx xx xx xx
Policy             xx ... xx        
    
    
VSOMEIP_UPDATE_SECURITY_POLICY_RESPONSE (0x24)

Command            24
Version            xx xx
Client             xx xx
Size               04 00 00 00
UpdateId           xx xx xx xx


VSOMEIP_REMOVE_SECURITY_POLICY (0x25)

Command            25
Version            xx xx
Client             xx xx
Size               0c 00 00 00
UpdateId           xx xx xx xx
Uid                xx xx xx xx
Gid                xx xx xx xx


VSOMEIP_REMOVE_SECURITY_POLICY_RESPONSE    (0x26)

Command            26
Version            xx xx
Client             xx xx
Size               04 00 00 00
UpdateId           xx xx xx xx


VSOMEIP_UPDATE_SECURITY_CREDENTIALS (0x27)

Command            27
Version            xx xx
Client             xx xx
Size               xx xx xx xx
Credentials
    Uid            xx xx xx xx
    Gid            xx xx xx xx
    

VSOMEIP_DISTRIBUTE_SECURITY_POLICIES (0x28)

Command            28
Version            xx xx
Client             xx xx xx xx
Size               xx xx xx xx
PoliciesCount      xx xx xx xx
Policies
    Size           xx xx xx xx
    Data           xx ... xx


VSOMEIP_SUSPEND (0x30)

Command            30
Version            xx xx
Size               xx xx xx xx