Doc updates for mimetypes and other metadata.

boschglobal · Sep 7, 2021 · 1e37116 · 1e37116
1 parent de02ffe
commit 1e37116
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 58 deletions.
diff --git 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
diff --git a/doc/network_model_can.md → doc/register/can.md b/doc/network_model_can.md → 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  
 :---|:---
-&ensp; | [Schema File](../schemas/network_model_can.fbs)
-MIME Type  | application/x-open-simulation-interface-network-model; type=CAN;
+&ensp; | [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 → doc/register/ethernet.md b/doc/network_model_ethernet.md → 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  
 :---|:---
-&ensp; | [Schema File](../schemas/network_model_ethernet.fbs)
-MIME Type  | application/x-open-simulation-interface-network-model; type=Ethernet;
+&ensp; | [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
@@ -0,0 +1,32 @@
+<!---
+  Copyright (c) 2021 for information on the respective copyright owner
+  see the NOTICE file and/or the repository https://github.com/boschglobal/automotive-bus-schema
+
+  SPDX-License-Identifier: Apache-2.0
+-->
+
+
+# Automotive Bus Register Interface FlexRay
+
+## Overview
+
+Schema  | Register Interface FlexRay  
+:---|:---
+&ensp; | [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