Commit ab043320 authored by Ille, Ondrej, Ing.'s avatar Ille, Ondrej, Ing.

Merge branch '295-documentation-clean-up' into 'master'

Resolve "Documentation clean-up"

Closes #295

See merge request !254
parents 6c7aa753 c12b8a40
Pipeline #11047 passed with stage
in 16 seconds
......@@ -60,6 +60,7 @@ build_doc:
artifacts:
paths:
- doc/core/Progdokum.pdf
- doc/core/ctu_can_fd_architecture.pdf
build_linux_driver:
stage: build
......
......@@ -1606,7 +1606,7 @@ BRS\end_layout
\begin_inset Text
\begin_layout Plain Layout
TBF\end_layout
Reserved\end_layout
\end_inset
</cell>
......@@ -1687,7 +1687,7 @@ X\end_layout
\begin_inset Text
\begin_layout Plain Layout
X\end_layout
-\end_layout
\end_inset
</cell>
......@@ -2019,15 +2019,15 @@ X\end_layout
\end_layout
\begin_layout Description
DLC Data Length Code as defined in CAN FD Specification.
DLC Data Length Code.
\end_layout
\begin_layout Description
RTR Remote Transmission Request flag. Has meaning only for CAN frames. CAN FD does not have RTR frames.\begin_inset Newline newline\end_inset
RTR Logic 1 indicates Remote frame. Has meaning only for CAN frames. CAN FD does not have RTR frames.\begin_inset Newline newline\end_inset
0b0 - NO_RTR_FRAME - CAN frame is not RTR frame.\begin_inset Newline newline\end_inset
0b1 - RTR_FRAME - CAN frame is RTR frame.
\end_layout
\begin_layout Description
IDE Extended Identifier Type. Distinguishes between Base and Extended Identifiers.\begin_inset Newline newline\end_inset
IDE Extended Identifier Type. Logic 1 indicates CAN frame with both Base identifier and Identifier extension. Logic 0 indicates CAN frame with only Base identifier.\begin_inset Newline newline\end_inset
0b0 - BASE - Frame Identifier is Basic (11 bits)\begin_inset Newline newline\end_inset
0b1 - EXTENDED - Frame Identifier is Extended (11 + 18 bits)
\end_layout
......@@ -2037,22 +2037,17 @@ FDF Flexible Data-rate Format. Distinguishes between CAN 2.0 and CAN FD Frames.\
0b1 - FD_CAN - Frame is CAN FD frame.
\end_layout
\begin_layout Description
TBF Time Base Format. Shall be always set to 1.\begin_inset Newline newline\end_inset
0b0 - NOT_TIME_BASED - TIMESTAMP_L and TIMESTAMP_H does not contain valid timestamp for transmission or reception.\begin_inset Newline newline\end_inset
0b1 - TIME_BASED - TIMESTAMP_L and TIMESTAMP_H contain valid timestamp for transmission or reception.
\end_layout
\begin_layout Description
BRS Bit Rate Shift. In case of CAN FD frames indicates whether Bit-rate is shifted during for Data field of CAN FD frame. This bit has no meaning for CAN Frames.\begin_inset Newline newline\end_inset
BRS Bit Rate Shift. In case of CAN FD frames indicates whether bit rate is shifted CAN FD frame. This bit has no meaning for CAN frames.\begin_inset Newline newline\end_inset
0b0 - BR_NO_SHIFT - Bit rate should not be shifted if frame is CAN FD frame.\begin_inset Newline newline\end_inset
0b1 - BR_SHIFT - Bit rate should be shifted if frame is CAN FD frame.
\end_layout
\begin_layout Description
ESI_RSV Error State Indicator bit for received CAN FD frames. Bit has no meaning for CAN frames nor for transmitted CAN FD frames (in TXT Buffer).\begin_inset Newline newline\end_inset
ESI_RSV Error State Indicator bit for received CAN FD frames. Bit has no meaning for CAN frames nor for transmitted CAN FD frames (in TXT buffer).\begin_inset Newline newline\end_inset
0b0 - ESI_ERR_ACTIVE - Transmitted of received CAN FD frame is error active.\begin_inset Newline newline\end_inset
0b1 - ESI_ERR_PASIVE - Transmitted of received CAN FD frame is error passive.
\end_layout
\begin_layout Description
RWCNT Size of CAN frame in RX Buffer without FRAME_FORMAT WORD.(E.g RTR frame RWCNT=3, 64 Byte FD frame RWCNT=19). In TXT Buffer this field has no meaning.
RWCNT Size of CAN frame in RX buffer without FRAME_FORMAT WORD. (E.g RTR frame RWCNT=3, 64 Byte FD frame RWCNT=19). In TXT buffer this field has no meaning.
\end_layout
\begin_layout Standard
\begin_inset VSpace bigskip
......
all: Progdokum.pdf
all: Progdokum.pdf ctu_can_fd_architecture.pdf
Progdokum.pdf: version.tex
#lyx --export-to pdf Progdokum.pdf Progdokum.lyx
......@@ -10,6 +10,16 @@ Progdokum.pdf: version.tex
xelatex Progdokum
xelatex Progdokum
ctu_can_fd_architecture.pdf: version.tex
lyx --export-to latex ctu_can_fd_architecture.tex ctu_can_fd_architecture.lyx
sed -rie '/\{inputenc\}/d' ctu_can_fd_architecture.tex
iconv -f latin2 -t utf8 <ctu_can_fd_architecture.tex >ctu_can_fd_architecture.tex-1 && mv ctu_can_fd_architecture.tex-1 ctu_can_fd_architecture.tex
xelatex ctu_can_fd_architecture
# run again to generate PDF outline and references
xelatex ctu_can_fd_architecture
xelatex ctu_can_fd_architecture
version.tex: FORCE
desc=$$(git describe --always); \
date="$$(git show -s --format=%cd --date=format:%Y-%m-%d)"; \
......
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
......@@ -102,7 +102,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">
......@@ -341,12 +341,46 @@ Insert Filter C\end_layout
</cell>
</row>
<row>
<cell alignment="center" bottomline="true" leftline="true" topline="true" usebox="none" valignment="top">
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
sup_range\end_layout
\end_inset
</cell>
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
boolean\end_layout
\end_inset
</cell>
<cell alignment="center" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
true\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
Insert Range Filter\end_layout
\end_inset
</cell>
</row>
<row>
<cell alignment="center" bottomline="true" leftline="true" topline="true" usebox="none" valignment="top">
\begin_inset Text
\begin_layout Plain Layout
sup_traffic_ctrs\end_layout
\end_inset
</cell>
<cell alignment="center" bottomline="true" leftline="true" topline="true" usebox="none" valignment="top">
......@@ -369,7 +403,7 @@ true\end_layout
\begin_inset Text
\begin_layout Plain Layout
Insert Range Filter\end_layout
Insert Traffic counters\end_layout
\end_inset
</cell>
......
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
......@@ -5285,7 +5285,7 @@ Clear the Shift register for secondary sampling point.\end_layout
\begin_inset Text
\begin_layout Plain Layout
trv_delay_calib\end_layout
tran_delay_meas\end_layout
\end_inset
</cell>
......@@ -5309,7 +5309,7 @@ std_logic\end_layout
\begin_inset Text
\begin_layout Plain Layout
Enable measurement of Transciever delay\end_layout
Enable measurement of Transmitter delay\end_layout
\end_inset
</cell>
......
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
{signal: [
{name: 'clk_sys', wave: 'p..........', period:2,
node: '.....................'},
{name: 'scs', wave: '0.1...............0...',
node: '......................'},
{name: 'swr', wave: '0.....................',
node: '......................'},
{name: 'srd', wave: '0.1...............0...',
node: '......................'},
{name: 'sbe', wave: '.x3.4.5.3.4.5.3.4.x...', data: ['1111','1111','1111', '1111','1111','1111','1111','1111','1111','1111','1111','1111','1111','1111','1111','1111'],
node: '......................'},
{name: 'address', wave: 'x.3.4.5.3.4.5.3.4.x...', data: [['tspan', {class:'h6'}, 'RX_DATA'],
['tspan', {class:'h6'}, 'RX_DATA'],
['tspan', {class:'h6'}, 'RX_DATA'],
['tspan', {class:'h6'}, 'RX_DATA'],
['tspan', {class:'h6'}, 'RX_DATA'],
['tspan', {class:'h6'}, 'RX_DATA'],
['tspan', {class:'h6'}, 'RX_DATA'],
['tspan', {class:'h6'}, 'RX_DATA'],],
node: '......................'},
{name: 'data_out', wave: '...x3.4.5.3.4.5.3.4.x.', data: [['tspan', {class:'h6'}, 'Data Word 1'],
['tspan', {class:'h6'}, 'Data Word 2'],
['tspan', {class:'h6'}, 'Data Word 3'],
['tspan', {class:'h6'}, 'Data Word 4'],
['tspan', {class:'h6'}, 'Data Word 5'],
['tspan', {class:'h6'}, 'Data Word 6'],
['tspan', {class:'h6'}, 'Data Word 7'],
['tspan', {class:'h6'}, 'Data Word 8']],
node: '......................'},
],
edge:[''],
}
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment