Skip to content

W
wr2rf-vme
Commit 6dfd66c7 authored by Tristan Gingold's avatar Tristan Gingold
Browse files
Options

libwr2rf: add comments in the API

parent 583063ad
Hide whitespace changes
Inline Side-by-side
Showing with 11 additions and 4 deletions
software/libwr2rf/libwr2rf/api.h
View file @ 6dfd66c7
......@@ -178,6 +178,8 @@ int libwr2rf_vtu_softstart (struct libwr2rf_dev *dev, unsigned id);
int libwr2rf_vtu_output_ff_delay(struct libwr2rf_dev *dev, unsigned id,
unsigned val);
/* Program the pad delay for VTU ID.
HC is 0/1 in RF period / 2, ODELAY is 0..31 in ~78ps steps. */
int libwr2rf_vtu_output_pad_delay(struct libwr2rf_dev *dev, unsigned id,
unsigned hc, unsigned odelay);
......@@ -201,7 +203,8 @@ int libwr2rf_vtu_program_pulse (struct libwr2rf_dev *dev, unsigned id,
int libwr2rf_vtu_program_infinite (struct libwr2rf_dev *dev, unsigned id,
uint64_t b, unsigned ht);
/* Program high frequency division (factor DIV) after B clock cycles. */
/* Program high frequency division (factor DIV) after B clock cycles.
DIV is 2 .. 16. */
int libwr2rf_vtu_program_highfreq (struct libwr2rf_dev *dev, unsigned id,
uint64_t b, unsigned div);
......@@ -214,7 +217,10 @@ int libwr2rf_vtu_program_window (struct libwr2rf_dev *dev, unsigned id,
int libwr2rf_vtu_program_invalidate (struct libwr2rf_dev *dev, unsigned id);
/* Specify the delay between the NCO reset (from WR) and the sync input of
trig 1. CDELAY unit is 16ns, FDELAY unit is 1ns. */
trig ID.
CDELAY in 0..127 in 16ns steps,
FDELAY in 0..15ns,
ODELAY in 0..31 in ~78ps steps. */
int libwr2rf_vtu_nco_reset_delay (struct libwr2rf_dev *dev, unsigned id,
unsigned cdelay, unsigned fdelay,
unsigned odelay);
......@@ -223,7 +229,8 @@ int libwr2rf_vtu_nco_reset_delay (struct libwr2rf_dev *dev, unsigned id,
This is a debug function. */
int libwr2rf_vtu_dump (struct libwr2rf_dev *dev, unsigned id);
/* Specify the ioupdate fine delay and ODELAY values */
/* Specify the ioupdate fine delay and ODELAY values.
FDELAY is 0..15ns, ODELAY is 0..31 in step of ~78ps. */
int libwr2rf_ioupdate_delay (struct libwr2rf_dev *dev, unsigned fdelay, unsigned odelay);
/* Set WR streamer fixed latency: the delay between the sent time and the apply
......
software/libwr2rf/wr2rf.c
View file @ 6dfd66c7
......@@ -3502,7 +3502,7 @@ api_dds_ioupdate_delay (struct libwr2rf_dev *dev, int argc, char **argv)
return;
usage:
printf ("usage: %s fdelay odelay\n", argv[0]);
printf (" fdelay in 0..15; odelay in 0..31\n");
}
......
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