summaryrefslogtreecommitdiff
path: root/documentation/vsomeipProtocol
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/vsomeipProtocol')
-rw-r--r--documentation/vsomeipProtocol372
1 files changed, 372 insertions, 0 deletions
diff --git a/documentation/vsomeipProtocol b/documentation/vsomeipProtocol
new file mode 100644
index 0000000..2fc905e
--- /dev/null
+++ b/documentation/vsomeipProtocol
@@ -0,0 +1,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 \ No newline at end of file