Commit da978abf authored by Ille, Ondrej, Ing.'s avatar Ille, Ondrej, Ing.
Browse files

doc: Update interface documentation.

parent 348a10e8
......@@ -108,7 +108,7 @@ Generics\end_layout
\noindent
\align center
\begin_inset Tabular
<lyxtabular columns="4" rows="7" version="3">
<lyxtabular columns="4" rows="8" version="3">
<features islongtable="true" longtabularalignment="center">
<column alignment="center" valignment="top" width="4cm">
<column alignment="center" valignment="top" width="3.5cm">
......@@ -215,7 +215,7 @@ Reset polarity\end_layout
\begin_inset Text
\begin_layout Plain Layout
G_SSP_SHIFT_LENGTH\end_layout
G_SSP_DELAY_SAT_VAL\end_layout
\end_inset
</cell>
......@@ -231,7 +231,7 @@ natural\end_layout
\begin_inset Text
\begin_layout Plain Layout
130\end_layout
255\end_layout
\end_inset
</cell>
......@@ -316,6 +316,40 @@ Width (number of bits) in transceiver delay measurement counter\end_layout
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
G_SSP_POS_WIDTH\end_layout
\end_inset
</cell>
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
natural\end_layout
\end_inset
</cell>
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
8\end_layout
\end_inset
</cell>
<cell alignment="center" leftline="true" rightline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
Width of SSP position\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
G_USE_SSP_SATURATION\end_layout
......@@ -392,7 +426,7 @@ Ports\end_layout
\noindent
\align center
\begin_inset Tabular
<lyxtabular columns="4" rows="25" version="3">
<lyxtabular columns="4" rows="26" version="3">
<features islongtable="true" longtabularalignment="center">
<column alignment="center" valignment="top" width="4cm">
<column alignment="center" valignment="top" width="1.2cm">
......@@ -1019,6 +1053,40 @@ std_logic\end_layout
\begin_layout Plain Layout
Valid synchronisation edge appeared (Recessive to Dominant)\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
tq_edge\end_layout
\end_inset
</cell>
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
in\end_layout
\end_inset
</cell>
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
std_logic\end_layout
\end_inset
</cell>
<cell alignment="center" leftline="true" rightline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
Time quanta edge\end_layout
\end_inset
</cell>
</row>
......
......@@ -102,487 +102,416 @@ customHeadersFooters
\end_header
\begin_body
\begin_layout Description
Generics
\end_layout
Generics\end_layout
\begin_layout Standard
\noindent
\align center
\begin_inset Tabular
<lyxtabular version="3" rows="11" columns="4">
<features tabularvalignment="middle">
<lyxtabular columns="4" rows="11" version="3">
<features islongtable="true" longtabularalignment="center">
<column alignment="center" valignment="top" width="4cm">
<column alignment="center" valignment="top" width="3.5cm">
<column alignment="center" valignment="top" width="1.2cm">
<column alignment="center" valignment="top" width="7cm">
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
Name
\begin_inset ERT
Name\begin_inset ERT
status open
\begin_layout Plain Layout
\backslash
cellcolor{cyan}
\end_layout
\end_inset
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
Type
\begin_inset ERT
Type\begin_inset ERT
status open
\begin_layout Plain Layout
\backslash
cellcolor{cyan}
\end_layout
\end_inset
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
Default value
\begin_inset ERT
Default value\begin_inset ERT
status open
\begin_layout Plain Layout
\backslash
cellcolor{cyan}
\end_layout
\end_inset
\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
<cell alignment="center" leftline="true" rightline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
Description
\begin_inset ERT
Description\begin_inset ERT
status open
\begin_layout Plain Layout
\backslash
cellcolor{cyan}
\end_layout
\end_inset
\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
G_RESET_POLARITY
\end_layout
G_RESET_POLARITY\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
std_logic
\end_layout
std_logic\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
'0'
\end_layout
'0'\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
<cell alignment="center" leftline="true" rightline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
Reset polarity
\end_layout
Reset polarity\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
G_TSEG1_NBT_WIDTH
\end_layout
G_TSEG1_NBT_WIDTH\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
natural
\end_layout
natural\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
8
\end_layout
8\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
<cell alignment="center" leftline="true" rightline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
TSEG1 Width - Nominal Bit Time
\end_layout
TSEG1 Width - Nominal Bit Time\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
G_TSEG2_NBT_WIDTH
\end_layout
G_TSEG2_NBT_WIDTH\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
natural
\end_layout
natural\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
8
\end_layout
8\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
<cell alignment="center" leftline="true" rightline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
TSEG2 Width - Nominal Bit Time
\end_layout
TSEG2 Width - Nominal Bit Time\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
G_BRP_NBT_WIDTH
\end_layout
G_BRP_NBT_WIDTH\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
natural
\end_layout
natural\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
8
\end_layout
8\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
<cell alignment="center" leftline="true" rightline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
Baud rate prescaler Width - Nominal Bit Time
\end_layout
Baud rate prescaler Width - Nominal Bit Time\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
G_SJW_NBT_WIDTH
\end_layout
G_SJW_NBT_WIDTH\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
natural
\end_layout
natural\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
5
\end_layout
5\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
<cell alignment="center" leftline="true" rightline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
Synchronisation Jump width Width - Nominal Bit Time
\end_layout
Synchronisation Jump width Width - Nominal Bit Time\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
G_TSEG1_DBT_WIDTH
\end_layout
G_TSEG1_DBT_WIDTH\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
natural
\end_layout
natural\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
8
\end_layout
8\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
<cell alignment="center" leftline="true" rightline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
TSEG1 Width - Data Bit Time
\end_layout
TSEG1 Width - Data Bit Time\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
G_TSEG2_DBT_WIDTH
\end_layout
G_TSEG2_DBT_WIDTH\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
natural
\end_layout
natural\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
8
\end_layout
8\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
<cell alignment="center" leftline="true" rightline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
TSEG2 Width - Data Bit Time
\end_layout
TSEG2 Width - Data Bit Time\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
G_BRP_DBT_WIDTH
\end_layout
G_BRP_DBT_WIDTH\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
natural
\end_layout
natural\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
8
\end_layout
8\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
<cell alignment="center" leftline="true" rightline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
Baud rate prescaler width - Data Bit Time
\end_layout
Baud rate prescaler width - Data Bit Time\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
G_SJW_DBT_WIDTH
\end_layout
G_SJW_DBT_WIDTH\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
natural
\end_layout
natural\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" usebox="none">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
5
\end_layout
5\end_layout
\end_inset
</cell>
<cell alignment="center" valignment="top" topline="true" leftline="true" rightline="true" usebox="none">
<cell alignment="center" leftline="true" rightline="true" topline="true" usebox="none" valignment="top">