Skip to content
Projects
Groups
Snippets
Help
Loading...
Sign in
Toggle navigation
F
FMC TDC 1ns 5cha - Software
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
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 TDC 1ns 5cha - Software
Commits
e76e997d
Commit
e76e997d
authored
Apr 27, 2015
by
Federico Vaga
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
doc: improve doxygen documentation
Signed-off-by:
Federico Vaga
<
federico.vaga@cern.ch
>
parent
b6374de1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
21 additions
and
7 deletions
+21
-7
fmctdc-lib.h
lib/fmctdc-lib.h
+21
-7
No files found.
lib/fmctdc-lib.h
View file @
e76e997d
...
...
@@ -15,28 +15,41 @@
#include <stdint.h>
/**
* Enumeration for all TDC channels
*/
enum
fmctdc_channel
{
FMCTDC_CH_1
=
0
,
FMCTDC_CH_2
,
FMCTDC_CH_3
,
FMCTDC_CH_4
,
FMCTDC_CH_5
,
FMCTDC_CH_LAST
=
4
,
FMCTDC_CH_LAST
=
FMCTDC_CH_5
,
FMCTDC_NUM_CHANNELS
=
5
};
/**
* Enumeration of all buffer modes
*/
enum
fmctdc_buffer_mode
{
FMCTDC_BUFFER_FIFO
=
0
,
FMCTDC_BUFFER_CIRC
,
FMCTDC_BUFFER_FIFO
=
0
,
/**< FIFO policy: when buffer is full, new
time-stamps will be dropped */
FMCTDC_BUFFER_CIRC
,
/**< circular buffer policy: when the buffer is
full, old time-stamps will be overwritten by
new ones */
};
/**
* Enumeration for all possible status of a channel
*/
enum
fmctdc_channel_status
{
FMCTDC_STATUS_DISABLE
=
0
,
FMCTDC_STATUS_ENABLE
,
FMCTDC_STATUS_DISABLE
=
0
,
/**< The cannel is disable */
FMCTDC_STATUS_ENABLE
,
/**< the channel is enable */
};
/**
* Opaque data type used as token
* Opaque data type used as token
. Do not try to access.
*/
struct
fmctdc_board
;
...
...
@@ -56,7 +69,8 @@ struct fmctdc_time {
4095 = 7.999 ns. */
uint32_t
seq_id
;
/**< channel sequence number*/
uint32_t
gseq_id
;
/**< board sequence number */
uint32_t
ref_gseq_id
;
/**< board sequence number of the reference */
uint32_t
ref_gseq_id
;
/**< board sequence number of the reference
channel time-stamp */
};
...
...
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