Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
F
FMC DIO 5ch TTL a
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
6
Issues
6
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
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
FMC DIO 5ch TTL a
Commits
deafc3b9
Commit
deafc3b9
authored
Jul 15, 2020
by
Maciej Lipinski
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Small corrections to the documentation
parent
947a5c7c
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
25 additions
and
25 deletions
+25
-25
fmc-dio.in
doc/fmc-dio.in
+25
-25
No files found.
doc/fmc-dio.in
View file @
deafc3b9
...
...
@@ -69,7 +69,7 @@ This is the manual for the fmc-dio device driver.
@node Compiling the Drivers
@chapter Compiling the Drivers
The kernel modules that are part of this package live in the @i
{
kernel
}
The kernel modules that are part of this package live in the @i
{
sw/
kernel
}
subdirectory. To compile them, you need to
set the following variables in your environment:
...
...
@@ -132,8 +132,8 @@ totally configurable pulses. It also recovers timestamps of external and generat
pulses.
@c ==========================================================================
@node
fmc-dio Initialization
@section
fmc-dio Initialization
@node
Initialization of fmc-dio
@section
Initialization of fmc-dio
There is no need to explicitly initialize the FMC-DIO driver.
...
...
@@ -141,7 +141,7 @@ There is no need to explicitly initialize the FMC-DIO driver.
@node Interrupts in fmc-dio.ko
@section Interrupts in fmc-dio.ko
There is only
an
interrupt to control the number of pulses that has been generated.
There is only
one
interrupt to control the number of pulses that has been generated.
@c ==========================================================================
@node Code Layout
...
...
@@ -156,16 +156,16 @@ spread over several directories:
@table @file
@item fmc-bus/
@item
sw/
fmc-bus/
FMC-BUS kernel driver support (see specific doc inside)
@item kernel/
@item
sw/
kernel/
This directory contains the low level functions to configure each
physical channel and the interrupt management.
@item tools/
@item
sw/
tools/
This directory hosts the userspace tools that uses the low level
functions.
...
...
@@ -177,33 +177,33 @@ register definitions. This is the role of each of them:
@table @file
@item kernel/fmc-dio.c
@item kernel/fmc-dio.h
@item
sw/
kernel/fmc-dio.c
@item
sw/
kernel/fmc-dio.h
Code and headers of the driver initialization. It also detects
the version of the FPGA binary to able coherent memory accesses
through all the code.
@item kernel/fmc-dio-gpio.c
@item
sw/
kernel/fmc-dio-gpio.c
DIO GPIO support skeleton to be developed.
@item kernel/fmc-dio-internal.c
@item
sw/
kernel/fmc-dio-internal.c
Code that excecutes the requested operations through the IOCTL.
It also implements the interrupt management.
@item kernel/fmc-dio-mdev.c
@item
sw/
kernel/fmc-dio-mdev.c
This code created the device and connects the IOCTL.
@item kernel/hw/ppsg-regs.h
@item kernel/hw/wr-dio-regs.c
@item kernel/hw/wr-dio-regs.h
@item kernel/hw/wr-dio-regs
_
v1.c
@item kernel/hw/wr-dio-regs
_
v1.h
@item kernel/hw/wr-dio-regs
_
v2.c
@item kernel/hw/wr-dio-regs
_
v2.h
@item
sw/
kernel/hw/ppsg-regs.h
@item
sw/
kernel/hw/wr-dio-regs.c
@item
sw/
kernel/hw/wr-dio-regs.h
@item
sw/
kernel/hw/wr-dio-regs
_
v1.c
@item
sw/
kernel/hw/wr-dio-regs
_
v1.h
@item
sw/
kernel/hw/wr-dio-regs
_
v2.c
@item
sw/
kernel/hw/wr-dio-regs
_
v2.h
Code and headers with the register map of the fmc-dio. It also
implements some functions to get the offset of each register.
...
...
@@ -330,7 +330,7 @@ fast, so calling it several times is acceptable).
@node FMC-DIO Command Tool
@section FMC-DIO Command Tool
In the @file
{
tools/
}
subdirectory of this project, you find the
In the @file
{
sw/
tools/
}
subdirectory of this project, you find the
@file
{
wr-dio-cmd
}
program, which is a command-line interface to the
@i
{
ioctl
}
command that acts on the @i
{
simple-DIO
}
mezzanine card. Other
@code
{
wr-dio-
}
tools are provided (and described below) but this is
...
...
@@ -408,7 +408,7 @@ The current version of the tool supports the following commands:
visual inspection. @code
{
period
}
, if specified, requests for
a pulse train, with the specified time period between raising edges;
@code
{
count
}
is the number of instances to run (-1 means forever,
0 means ``stop generating pulses'').
0 means ``stop
ongoing
generating pulses'').
@item irq <when> [<period> <count>]
...
...
@@ -420,9 +420,9 @@ The current version of the tool supports the following commands:
(@code
{
+<seconds>.<fraction
}
). In the last case, the current second
is added to @code
{
<seconds>
}
while the fraction is used unchanged.
The @code
{
+
}
form is useful for simple checks with visual inspection.
@code
{
period
}
, if specified, requests for a
pulse
train, with the
@code
{
period
}
, if specified, requests for a
interrupt
train, with the
specified time period between rising edges; @code
{
count
}
is the number
of instances to run (-1 means forever, 0 means ``stop generating pulses'').
of instances to run (-1 means forever, 0 means ``stop
ongoing
generating pulses'').
@item mode <channel> <mode> [<channel> <mode> ...]
@itemx mode <m0><m1><m2><m3><m4>
...
...
@@ -520,7 +520,7 @@ Example uses of the tool follow:
# Generate interrupt now
wr
-
dio
-
cmd
/
dev
/
fmc
-
dio
-
1
:
0
irq now
# Generate
100
interrupts every
10
ms
at the next second
# Generate
a train of
100
interrupts every
10
ms starting
at the next second
wr
-
dio
-
cmd
/
dev
/
fmc
-
dio
-
1
:
0
irq
+
1
.
01
100
@end example
...
...
@@ -569,7 +569,7 @@ file.
The program is meant as a source code example, more than a real PPS
signal. If you need a real WR
-
driven pulse
-
per
-
second, you should
use the channel
0
wich is "hard
-
wired" to the PTP core and can be configured by
use the channel
0
w
h
ich is "hard
-
wired" to the PTP core and can be configured by
executing: ``@t
{
wr
-
dio
-
cmd mode
0
p
}
''.
The program just fires a
1
ms
-
long @i
{
pps
}
pulse on one of the output
...
...
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