From 1e37116022bd1d672eb32f45c7b2d9d495391159 Mon Sep 17 00:00:00 2001 From: Timothy Rule Date: Tue, 7 Sep 2021 12:15:47 +0200 Subject: [PATCH] Doc updates for mimetypes and other metadata. --- README.md | 5 ++- doc/network_model_flexray.md | 31 ---------------- doc/{network_model_can.md => register/can.md} | 37 ++++++++++--------- .../ethernet.md} | 16 ++++---- doc/register/flexray.md | 32 ++++++++++++++++ 5 files changed, 63 insertions(+), 58 deletions(-) delete mode 100644 doc/network_model_flexray.md rename doc/{network_model_can.md => register/can.md} (78%) rename doc/{network_model_ethernet.md => register/ethernet.md} (61%) create mode 100644 doc/register/flexray.md diff --git a/README.md b/README.md index 848f4dc..18f9957 100644 --- a/README.md +++ b/README.md @@ -11,12 +11,15 @@ ## Introduction This is a collection of schemas in the Google FlatBuffers IDL for describing automotive network communications within a virtualized simulation environment. - Currently buffer representations of CAN, FlexRay, Ethernet and Encoded Signals at the level of a Communication Matrix definition are provided. + +Currently buffer representations of CAN, FlexRay, Ethernet and Encoded Signals at the level of a Communication Matrix definition are provided. + ## Project structure ``` L- docs Documentation L- schemas Schemas of the Standard +L- docker Supporting build environments ``` diff --git a/doc/network_model_flexray.md b/doc/network_model_flexray.md deleted file mode 100644 index 0f77c20..0000000 --- a/doc/network_model_flexray.md +++ /dev/null @@ -1,31 +0,0 @@ - - - -## Network Model FlexRay - -Model | Network Model FlexRay -:---|:--- -  | [Schema File](../schemas/network_model_flexray.fbs) -MIME Type | application/x-open-simulation-interface-network-model; type=FlexRay; -Data Stream | 4 byte Message Length followed by FlatBuffers Message. Repeating. -FlatBuffers File Identifier | NMFR -Abbreviations | NM FlexRay, NMFR - - -### Modeled BUS Features - -#### Static/Dynamic Parts - - -#### Slot Chasing (Events) - - -#### FlexRay Startup - - -#### L2 Status diff --git a/doc/network_model_can.md b/doc/register/can.md similarity index 78% rename from doc/network_model_can.md rename to doc/register/can.md index 207aea4..fb4bd6b 100644 --- a/doc/network_model_can.md +++ b/doc/register/can.md @@ -6,25 +6,26 @@ --> -## Network Model CAN +# Automotive Bus Register Interface CAN -Model | Network Model CAN +## Overview + +Schema | Register Interface CAN :---|:--- -  | [Schema File](../schemas/network_model_can.fbs) -MIME Type | application/x-open-simulation-interface-network-model; type=CAN; +  | [Schema File](../../schemas/register/can.fbs) +MIME Type | application/x-automotive-bus; interface=register; type=CAN; Data Stream | 4 byte Message Length followed by FlatBuffers Message. Repeating. -FlatBuffers File Identifier | NMCA -Abbreviations | NM CAN, NMC, NMCA +FlatBuffers File Identifier | RICA -### Modeled BUS Features +## Modeled BUS Features -#### Tx/Rx FIFO(Buffer) Operation +### Tx/Rx FIFO(Buffer) Operation The size and configuration of FIFO/Buffer is set when connecting to a Virtual BUS. Typically this is a limited resource and FIFO/Buffers are assigned to one of the Tx/Rx functions. -##### TX FIFO with Priority +#### TX FIFO with Priority * TX Queue with maximum size. * Messages are sent according to Message ID. @@ -36,7 +37,7 @@ The size and configuration of FIFO/Buffer is set when connecting to a Virtual BU - number of unused FIFO/Buffers -##### TX FIFO +#### TX FIFO * TX Queue with maximum size. * Messages are sent in order of enqueue (i.e. circular buffer). @@ -50,7 +51,7 @@ The size and configuration of FIFO/Buffer is set when connecting to a Virtual BU - number of unused FIFO/Buffers -##### RX FIFO +#### RX FIFO * RX Queue with maximum size. * Queue is cleared when ECU requests BUS Pull. ECU must handle all messages. @@ -63,22 +64,22 @@ The size and configuration of FIFO/Buffer is set when connecting to a Virtual BU -#### TEC +### TEC -#### REC +### REC -#### Active Error Frame +### Active Error Frame -#### Passive Error Frame +### Passive Error Frame -#### Overload +### Overload -#### Frame Request +### Frame Request -#### L2 Status +### L2 Status diff --git a/doc/network_model_ethernet.md b/doc/register/ethernet.md similarity index 61% rename from doc/network_model_ethernet.md rename to doc/register/ethernet.md index 2a45cb1..5be779f 100644 --- a/doc/network_model_ethernet.md +++ b/doc/register/ethernet.md @@ -5,21 +5,21 @@ SPDX-License-Identifier: Apache-2.0 --> +# Automotive Bus Register Interface Ethernet -## Network Model Ethernet +## Overview -Model | Network Model Ethernet +Schema | Register Interface Ethernet :---|:--- -  | [Schema File](../schemas/network_model_ethernet.fbs) -MIME Type | application/x-open-simulation-interface-network-model; type=Ethernet; +  | [Schema File](../../schemas/register/ethernet.fbs) +MIME Type | application/x-automotive-bus; interface=register; type=Ethernet; Data Stream | 4 byte Message Length followed by FlatBuffers Message. Repeating. -FlatBuffers File Identifier | NMEN -Abbreviations | NM Ethernet, NMEN +FlatBuffers File Identifier | RIEN -### Modeled BUS Features +## Modeled BUS Features -#### Ethernet Frame +### Ethernet Frame Ethernet Frame | 68 - 1522 bytes --|-- diff --git a/doc/register/flexray.md b/doc/register/flexray.md new file mode 100644 index 0000000..71ba5b1 --- /dev/null +++ b/doc/register/flexray.md @@ -0,0 +1,32 @@ + + + +# Automotive Bus Register Interface FlexRay + +## Overview + +Schema | Register Interface FlexRay +:---|:--- +  | [Schema File](../../schemas/register/flexray.fbs) +MIME Type | application/x-automotive-bus; interface=register; type=FlexRay; +Data Stream | 4 byte Message Length followed by FlatBuffers Message. Repeating. +FlatBuffers File Identifier | RIFR + + +## Modeled BUS Features + +### Static/Dynamic Parts + + +### Slot Chasing (Events) + + +### FlexRay Startup + + +### L2 Status