Skip to content

F
FMC ADC 100M 14b 4cha - Software
Commit a5b281f0 authored by Federico Vaga's avatar Federico Vaga
Browse files
Options

lib: add API documentation for trigger software 

Signed-off-by: Federico Vaga's avatarFederico Vaga <federico.vaga@cern.ch>
parent 6fff213e
Hide whitespace changes
Inline Side-by-side
Showing with 20 additions and 0 deletions
lib/fmcadc-lib.h
View file @ a5b281f0
...@@ -252,6 +252,13 @@ static inline int fmcadc_buffer_maximum_size_set(struct fmcadc_dev *dev, ...@@ -252,6 +252,13 @@ static inline int fmcadc_buffer_maximum_size_set(struct fmcadc_dev *dev,
return -1; return -1;
} }
/**
* Get the current software trigger enable status
* @param[in] dev adc device token
* @param[out] enable enable status
* @return 0 on success. -1 on error and errno is set appropriately
*/
static inline int fmcadc_trigger_sw_status(struct fmcadc_dev *dev, static inline int fmcadc_trigger_sw_status(struct fmcadc_dev *dev,
unsigned int *enable) unsigned int *enable)
{ {
...@@ -259,6 +266,13 @@ static inline int fmcadc_trigger_sw_status(struct fmcadc_dev *dev, ...@@ -259,6 +266,13 @@ static inline int fmcadc_trigger_sw_status(struct fmcadc_dev *dev,
NULL, (int *)enable); NULL, (int *)enable);
} }
/**
* Set the current software trigger enable status
* @param[in] dev adc device token
* @param[in] enable 0 disable, 1 enable
* @return 0 on success. -1 on error and errno is set appropriately
*/
static inline int fmcadc_trigger_sw_enable(struct fmcadc_dev *dev, static inline int fmcadc_trigger_sw_enable(struct fmcadc_dev *dev,
unsigned int enable) unsigned int enable)
{ {
...@@ -268,6 +282,12 @@ static inline int fmcadc_trigger_sw_enable(struct fmcadc_dev *dev, ...@@ -268,6 +282,12 @@ static inline int fmcadc_trigger_sw_enable(struct fmcadc_dev *dev,
NULL, &value); NULL, &value);
} }
/**
* Execute a software trigger
* @param[in] dev adc device token
* @return 0 on success. -1 on error and errno is set appropriately
*/
static inline int fmcadc_trigger_sw_fire(struct fmcadc_dev *dev) static inline int fmcadc_trigger_sw_fire(struct fmcadc_dev *dev)
{ {
int value = 1; int value = 1;
......
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