tdc/doc: update the documentation to latest timestamp change

The user will indicate the number of events she wants. However, the board
expects the double as both edges (rising and falling) are counted.

The library takes care of this issue.
Signed-off-by: Samuel Iglesias Gonsálvez's avatarSamuel Iglesias Gonsalvez <siglesias@igalia.com>
parent ff4067be
......@@ -121,9 +121,9 @@ Get FMC TDC DAC value. \\
Set time threshold (time between IRQ where the event number acquired are less than the timestamp
threshold). In seconds. \\
\textbf{int tdc\_get\_time\_threshold(struct tdc\_board *b, uint32\_t *thres);} \\
Get time threshold. \\
Get time threshold.\\
\textbf{int tdc\_set\_timestamp\_threshold(struct tdc\_board *b, uint32\_t thres);} \\
Set timestamp threshold. Remember that the number of events actually acquired are the half of the timestampt threshold, because The ACAM chip gives a timestamp for each edge of the input signal. \\
Set timestamp threshold.\\
\textbf{int tdc\_get\_timestamp\_threshold(struct tdc\_board *b, uint32\_t *thres);} \\
Get timestamp threshold.\\
\textbf{int tdc\_set\_channels\_term(struct tdc\_board *b, uint32\_t config);} \\
......
......@@ -231,10 +231,7 @@ extern int tdc_get_time_threshold(struct tdc_board *b, uint32_t *thres);
/**
* @brief Set timestamp threshold
*
* The timestamp threshold is the number of events (multiplied by two) we want
* per interrupt. It is the double of the expected number of events because ACAM
* chip thinks that each edge of the input signal is an event, but we are only
* interested on the rising edge one.
* The timestamp threshold is the number of events we want per interrupt.
*
* @param b - pointer to struct tdc_board
* @param thres - Timestamp threshold, in seconds.
......@@ -248,10 +245,7 @@ extern int tdc_set_timestamp_threshold(struct tdc_board *b, uint32_t thres);
/**
* @brief Get timestamp threshold
*
* The timestamp threshold is the number of events (multiplied by two) we want
* per interrupt. It is the double of the expected number of events because ACAM
* chip thinks that each edge of the input signal is an event, but we are only
* interested on the rising edge one.
* The timestamp threshold is the number of events we want per interrupt.
*
* @param b - pointer to struct tdc_board
* @param thres - Timestamp threshold, in seconds.
......
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