aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorSteve Markgraf <steve@steve-m.de>2014-01-05 22:51:44 +0100
committerSteve Markgraf <steve@steve-m.de>2014-01-05 22:51:44 +0100
commit003bd51167d9680e9721c7296323fdffe4be5a09 (patch)
treea8e6fdab9185f73b08420f152630d03a1fcce6b1 /include
parentd683b128f918778f666349fa511fb9be54b78598 (diff)
lib: check for validity of sample rates
Thanks to Joris van Rantwijk for finding what seems to be a hardware limitation/bug (bit 28 of the rsamp register being forced to the value of bit 27). Signed-off-by: Steve Markgraf <steve@steve-m.de>
Diffstat (limited to 'include')
-rw-r--r--include/rtl-sdr.h12
1 files changed, 11 insertions, 1 deletions
diff --git a/include/rtl-sdr.h b/include/rtl-sdr.h
index ca89b77..a07fc60 100644
--- a/include/rtl-sdr.h
+++ b/include/rtl-sdr.h
@@ -243,7 +243,17 @@ RTLSDR_API int rtlsdr_set_tuner_if_gain(rtlsdr_dev_t *dev, int stage, int gain);
*/
RTLSDR_API int rtlsdr_set_tuner_gain_mode(rtlsdr_dev_t *dev, int manual);
-/* this will select the baseband filters according to the requested sample rate */
+/*!
+ * Set the sample rate for the device, also selects the baseband filters
+ * according to the requested sample rate for tuners where this is possible.
+ *
+ * \param dev the device handle given by rtlsdr_open()
+ * \param samp_rate the sample rate to be set, possible values are:
+ * 225001 - 300000 Hz
+ * 900001 - 3200000 Hz
+ * sample loss is to be expected for rates > 2400000
+ * \return 0 on success, -EINVAL on invalid rate
+ */
RTLSDR_API int rtlsdr_set_sample_rate(rtlsdr_dev_t *dev, uint32_t rate);
/*!