Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
S
Software for White Rabbit PTP Core
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
32
Issues
32
List
Board
Labels
Milestones
Merge Requests
4
Merge Requests
4
CI / CD
CI / CD
Pipelines
Schedules
Wiki
Wiki
image/svg+xml
Discourse
Discourse
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Projects
Software for White Rabbit PTP Core
Commits
84ffd7f7
Commit
84ffd7f7
authored
Mar 02, 2017
by
Adam Wujek
💬
Committed by
Grzegorz Daniluk
Mar 02, 2017
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
doc: small fixes over the document
Signed-off-by:
Adam Wujek
<
adam.wujek@cern.ch
>
parent
9ed670ec
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
19 additions
and
13 deletions
+19
-13
wrpc.tex
doc/wrpc.tex
+19
-13
No files found.
doc/wrpc.tex
View file @
84ffd7f7
...
@@ -1018,7 +1018,7 @@ The macro \texttt{OID\_FIELD\_VAR} takes the following arguments:
...
@@ -1018,7 +1018,7 @@ The macro \texttt{OID\_FIELD\_VAR} takes the following arguments:
\item
\texttt
{
\&
example
\_
i32var,
\&
example
\_
string
}
-- addresses to the data in
\item
\texttt
{
\&
example
\_
i32var,
\&
example
\_
string
}
-- addresses to the data in
memory
memory
\end{itemize*}
\end{itemize*}
In case the address of variable
s
is not known at boot, it is possible to define
In case the address of variable is not known at boot, it is possible to define
a pointer to the variable which will be initialized (e.g. in the
\texttt
{
snmp
\_
init
}
a pointer to the variable which will be initialized (e.g. in the
\texttt
{
snmp
\_
init
}
the function) at the boot time. In that case function
\texttt
{
get
\_
pp
}
(
\texttt
{
set
\_
pp
}
) has
the function) at the boot time. In that case function
\texttt
{
get
\_
pp
}
(
\texttt
{
set
\_
pp
}
) has
to be used instead of
\texttt
{
get
\_
p
}
(
\texttt
{
set
\_
p
}
). For variables that are a part of
to be used instead of
\texttt
{
get
\_
p
}
(
\texttt
{
set
\_
p
}
). For variables that are a part of
...
@@ -1222,7 +1222,7 @@ sending every 100ms use ``\texttt{ltest 0 100}'', to stop sending use
...
@@ -1222,7 +1222,7 @@ sending every 100ms use ``\texttt{ltest 0 100}'', to stop sending use
\texttt
{
ltest
0
}
.
\texttt
{
ltest
0
}
.
In the sender node, a reminder is sent to the console very
10
s
In the sender node, a reminder is sent to the console very
10
s
reporting the node is currently sendin
\textit
{
ltest
}
frames. All
reporting the node is currently sendin
g
\textit
{
ltest
}
frames. All
non
-
sending nodes report every minute to
\textit
{
syslog
}
. The
non
-
sending nodes report every minute to
\textit
{
syslog
}
. The
report message includes the number of samples received as well
report message includes the number of samples received as well
as the minimum, average and maximum latency, in nanoseconds.
as the minimum, average and maximum latency, in nanoseconds.
...
@@ -1242,11 +1242,11 @@ it may be useful to look at the current values or critical variables
...
@@ -1242,11 +1242,11 @@ it may be useful to look at the current values or critical variables
within
\textit
{
wrpc
-
sw
}
/
\textit
{
ppsi
}
.
within
\textit
{
wrpc
-
sw
}
/
\textit
{
ppsi
}
.
To this aim, you can pass a memory image of
\textit
{
wrpc
}
to
\texttt
{
tools
/
wrpc
-
dump
}
.
To this aim, you can pass a memory image of
\textit
{
wrpc
}
to
\texttt
{
tools
/
wrpc
-
dump
}
.
The tools will print information for softpll, ppsi data structures
The tools will print information for softpll, ppsi data structures
,
and ptp data sets
.
ptp data sets and version information
.
For example, for a
\textit
{
spec
}
device, you can use the resource file in
For example, for a
\textit
{
spec
}
device, you can use the resource file in
\textit
{
syfs
}
to look at a live system, or copy the file for off
-
line
\textit
{
sy
s
fs
}
to look at a live system, or copy the file for off
-
line
analysis. The following command line show both uses:
analysis. The following command line show both uses:
\begin
{
lstlisting
}
\begin
{
lstlisting
}
...
@@ -1261,7 +1261,8 @@ analysis. The following command line show both uses:
...
@@ -1261,7 +1261,8 @@ analysis. The following command line show both uses:
The
\textit
{
mapper
}
tool used above, and part of
\textit
{
wrpc
-
sw
}
, reads a file
The
\textit
{
mapper
}
tool used above, and part of
\textit
{
wrpc
-
sw
}
, reads a file
using
\textit
{
mmap
()
}
. The kernel doesn't allow plain
\textit
{
read
()
}
from a
using
\textit
{
mmap
()
}
. The kernel doesn't allow plain
\textit
{
read
()
}
from a
resource file.
resource file. If you encounter problem using
\texttt
{
wrpc
\_
dump
}
directly,
please use
\texttt
{
mapper
}
then
\texttt
{
wrpc
\_
dump
}
.
\textbf
{
Note:
}
Data read by
\texttt
{
mapper
}
may look like has wrong endianness comparing
\textbf
{
Note:
}
Data read by
\texttt
{
mapper
}
may look like has wrong endianness comparing
to the file used for programming lm
32
by
\texttt
{
spec
-
cl
}
, but
\texttt
{
spec
-
cl
}
is the
to the file used for programming lm
32
by
\texttt
{
spec
-
cl
}
, but
\texttt
{
spec
-
cl
}
is the
...
@@ -1377,6 +1378,11 @@ udp-based network services, in addition to \textit{ptp}:
...
@@ -1377,6 +1378,11 @@ udp-based network services, in addition to \textit{ptp}:
If
\texttt
{
CONFIG
\_
SYSLOG
}
is set, the node is a syslog client.
If
\texttt
{
CONFIG
\_
SYSLOG
}
is set, the node is a syslog client.
See section
\ref
{
Syslog
}
for details.
\\
See section
\ref
{
Syslog
}
for details.
\\
&
\\
\textit
{
snmp
}
&
If
\texttt
{
CONFIG
\_
SNMP
}
is set, the node is a snmp agent.
See section
\ref
{
Diagnostics via SNMP
}
for details.
\\
\end
{
longtable
}
\end
{
longtable
}
...
@@ -1395,28 +1401,28 @@ processing and get back to the ``standard'' packet-filter rules.
...
@@ -1395,28 +1401,28 @@ processing and get back to the ``standard'' packet-filter rules.
\begin
{
longtable
}{
p
{
6
.
5
cm
}
p
{
9
cm
}
}
\begin
{
longtable
}{
p
{
6
.
5
cm
}
p
{
9
cm
}
}
\
textit
{
CONFIG
\_
VLAN
}
&
\
small
{
\textit
{
CONFIG
\_
VLAN
}
}
&
This is the top
-
level choice. It can be enabled or disabled.
This is the top
-
level choice. It can be enabled or disabled.
If disabled, the following values default to
0
and the
If disabled, the following values default to
0
and the
packet filter will discard all tagged frames.
\\
packet filter will discard all tagged frames.
\\
&
\\
&
\\
\
textit
{
CONFIG
\_
VLAN
\_
NR
}
&
\
small
{
\textit
{
CONFIG
\_
VLAN
\_
NR
}
}
&
The default
\textit
{
vlan
}
number for the CPU. All network traffic
The default
\textit
{
vlan
}
number for the CPU. All network traffic
directed to
(
and originating from
)
the
\textit
{
lm
32
}
processor will
directed to
(
and originating from
)
the
\textit
{
lm
32
}
processor will
belong to this
\textit
{
vlan
}
. The
value can be changed at run time
belong to this
\textit
{
vlan
}
. The
~
value can be changed at run time
using the
\texttt
{
vlan
}
shell command.
\\
using the
\texttt
{
vlan
}
shell command.
\\
&
\\
&
\\
\
textit
{
CONFIG
\_
VLAN
\_
1
\_
FOR
\_
CLASS
7
}
&
\\
\
small
{
\textit
{
CONFIG
\_
VLAN
\_
1
\_
FOR
\_
CLASS
7
}
}
&
\\
\
textit
{
CONFIG
\_
VLAN
\_
2
\_
FOR
\_
CLASS
7
}
&
\
small
{
\textit
{
CONFIG
\_
VLAN
\_
2
\_
FOR
\_
CLASS
7
}
}
&
The packet
-
filter rules are setup to deliver frames belonging
The packet
-
filter rules are setup to deliver frames belonging
to two specific
\textit
{
vlans
}
to class
7
, usually
\textit
{
etherbone
}
.
to two specific
\textit
{
vlans
}
to class
7
, usually
\textit
{
etherbone
}
.
To deliver one
\textit
{
vlan
}
only, set the two options to the same
To deliver one
\textit
{
vlan
}
only, set the two options to the same
number.
\\
number.
\\
&
\\
&
\\
\
textit
{
CONFIG
\_
VLAN
\_
FOR
\_
CLASS
6
}
&
\
small
{
\textit
{
CONFIG
\_
VLAN
\_
FOR
\_
CLASS
6
}
}
&
The packet
-
filter rules are setup to deliver frames belonging
The packet
-
filter rules are setup to deliver frames belonging
to one specific
\textit
{
vlan
}
to class
6
, usually routed to the
to one specific
\textit
{
vlan
}
to class
6
, usually routed to the
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment