summaryrefslogtreecommitdiff
path: root/gr-shd/include
diff options
context:
space:
mode:
Diffstat (limited to 'gr-shd/include')
-rw-r--r--gr-shd/include/.gitignore2
-rw-r--r--gr-shd/include/CMakeLists.txt8
-rw-r--r--gr-shd/include/Makefile.am27
-rw-r--r--gr-shd/include/gr_shd_api.h8
-rw-r--r--gr-shd/include/gr_shd_smini_sink.h52
-rw-r--r--gr-shd/include/gr_shd_smini_source.h66
6 files changed, 67 insertions, 96 deletions
diff --git a/gr-shd/include/.gitignore b/gr-shd/include/.gitignore
deleted file mode 100644
index b336cc7ce..000000000
--- a/gr-shd/include/.gitignore
+++ /dev/null
@@ -1,2 +0,0 @@
-/Makefile
-/Makefile.in
diff --git a/gr-shd/include/CMakeLists.txt b/gr-shd/include/CMakeLists.txt
index c4db1fd22..34349841c 100644
--- a/gr-shd/include/CMakeLists.txt
+++ b/gr-shd/include/CMakeLists.txt
@@ -1,17 +1,17 @@
# Copyright 2011 Free Software Foundation, Inc.
-#
+#
# This file is part of GNU Radio
-#
+#
# GNU Radio is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3, or (at your option)
# any later version.
-#
+#
# GNU Radio is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
-#
+#
# You should have received a copy of the GNU General Public License
# along with GNU Radio; see the file COPYING. If not, write to
# the Free Software Foundation, Inc., 51 Franklin Street,
diff --git a/gr-shd/include/Makefile.am b/gr-shd/include/Makefile.am
deleted file mode 100644
index 2cb1597df..000000000
--- a/gr-shd/include/Makefile.am
+++ /dev/null
@@ -1,27 +0,0 @@
-#
-# Copyright 2011 Free Software Foundation, Inc.
-#
-# This file is part of GNU Radio
-#
-# GNU Radio is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 3, or (at your option)
-# any later version.
-#
-# GNU Radio is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with GNU Radio; see the file COPYING. If not, write to
-# the Free Software Foundation, Inc., 51 Franklin Street,
-# Boston, MA 02110-1301, USA.
-#
-
-include $(top_srcdir)/Makefile.common
-
-grinclude_HEADERS = \
- gr_shd_api.h \
- gr_shd_smini_source.h \
- gr_shd_smini_sink.h \ No newline at end of file
diff --git a/gr-shd/include/gr_shd_api.h b/gr-shd/include/gr_shd_api.h
index e6773c3f3..13b755cbd 100644
--- a/gr-shd/include/gr_shd_api.h
+++ b/gr-shd/include/gr_shd_api.h
@@ -1,18 +1,18 @@
/*
* Copyright 2011 Free Software Foundation, Inc.
- *
+ *
* This file is part of GNU Radio
- *
+ *
* GNU Radio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
- *
+ *
* GNU Radio is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
- *
+ *
* You should have received a copy of the GNU General Public License
* along with GNU Radio; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
diff --git a/gr-shd/include/gr_shd_smini_sink.h b/gr-shd/include/gr_shd_smini_sink.h
index 938958687..b807e5c87 100644
--- a/gr-shd/include/gr_shd_smini_sink.h
+++ b/gr-shd/include/gr_shd_smini_sink.h
@@ -1,18 +1,18 @@
/*
* Copyright 2011 Free Software Foundation, Inc.
- *
+ *
* This file is part of GNU Radio
- *
+ *
* GNU Radio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
- *
+ *
* GNU Radio is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
- *
+ *
* You should have received a copy of the GNU General Public License
* along with GNU Radio; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
@@ -34,30 +34,30 @@ GR_SHD_API boost::shared_ptr<shd_smini_sink> shd_make_smini_sink(
size_t num_channels
);
-class GR_SHD_API shd_smini_sink : virtual public gr_sync_block
+class GR_SHD_API shd_smini_sink : virtual public gr_sync_block
{
public:
-
+
/*!
* Set the subdevice specification.
* \param spec the subdev spec markup string
* \param mboard the motherboard index 0 to M-1
*/
virtual void set_subdev_spec(const std::string &spec, size_t mboard = 0) = 0;
-
+
/*!
* Set the sample rate for the smini device.
* \param rate a new rate in Sps
*/
virtual void set_samp_rate(double rate) = 0;
-
+
/*!
* Get the sample rate for the smini device.
* This is the actual sample rate and may differ from the rate set.
* \return the actual rate in Sps
*/
virtual double get_samp_rate(void) = 0;
-
+
/*!
* Tune the smini device to the desired center frequency.
* \param tune_request the tune request instructions
@@ -86,14 +86,14 @@ class GR_SHD_API shd_smini_sink : virtual public gr_sync_block
* \return the frequency in Hz
*/
virtual double get_center_freq(size_t chan = 0) = 0;
-
+
/*!
* Get the tunable frequency range.
* \param chan the channel index 0 to N-1
* \return the frequency range in Hz
*/
virtual shd::freq_range_t get_freq_range(size_t chan = 0) = 0;
-
+
/*!
* Set the gain for the dboard.
* \param gain the gain in dB
@@ -116,7 +116,7 @@ class GR_SHD_API shd_smini_sink : virtual public gr_sync_block
* \return the actual gain in dB
*/
virtual double get_gain(size_t chan = 0) = 0;
-
+
/*!
* Get the actual dboard gain setting of named stage.
* \param name the name of the gain stage
@@ -132,7 +132,7 @@ class GR_SHD_API shd_smini_sink : virtual public gr_sync_block
* \return the actual gain in dB
*/
virtual std::vector<std::string> get_gain_names(size_t chan = 0) = 0;
-
+
/*!
* Get the settable gain range.
* \param chan the channel index 0 to N-1
@@ -148,7 +148,7 @@ class GR_SHD_API shd_smini_sink : virtual public gr_sync_block
*/
virtual shd::gain_range_t get_gain_range(const std::string &name,
size_t chan = 0) = 0;
-
+
/*!
* Set the antenna to use.
* \param ant the antenna string
@@ -156,21 +156,21 @@ class GR_SHD_API shd_smini_sink : virtual public gr_sync_block
*/
virtual void set_antenna(const std::string &ant,
size_t chan = 0) = 0;
-
+
/*!
* Get the antenna in use.
* \param chan the channel index 0 to N-1
* \return the antenna string
*/
virtual std::string get_antenna(size_t chan = 0) = 0;
-
+
/*!
* Get a list of possible antennas.
* \param chan the channel index 0 to N-1
* \return a vector of antenna strings
*/
virtual std::vector<std::string> get_antennas(size_t chan = 0) = 0;
-
+
/*!
* Set the subdevice bandpass filter.
* \param chan the channel index 0 to N-1
@@ -186,14 +186,14 @@ class GR_SHD_API shd_smini_sink : virtual public gr_sync_block
*/
virtual shd::sensor_value_t get_dboard_sensor(const std::string &name,
size_t chan = 0) = 0;
-
+
/*!
* Get a list of possible daughterboard sensor names.
* \param chan the channel index 0 to N-1
* \return a vector of sensor names
*/
virtual std::vector<std::string> get_dboard_sensor_names(size_t chan = 0) = 0;
-
+
/*!
* Get a motherboard sensor value.
* \param name the name of the sensor
@@ -224,28 +224,28 @@ class GR_SHD_API shd_smini_sink : virtual public gr_sync_block
* \return the clock rate in Hz
*/
virtual double get_clock_rate(size_t mboard = 0) = 0;
-
+
/*!
* Set the master clock rate.
* \param rate the new rate in Hz
* \param mboard the motherboard index 0 to M-1
*/
virtual void set_clock_rate(double rate, size_t mboard = 0) = 0;
-
+
/*!
* Get the current time registers.
* \param mboard the motherboard index 0 to M-1
* \return the current smini time
*/
virtual shd::time_spec_t get_time_now(size_t mboard = 0) = 0;
-
+
/*!
* Get the time when the last pps pulse occured.
* \param mboard the motherboard index 0 to M-1
* \return the current smini time
*/
virtual shd::time_spec_t get_time_last_pps(size_t mboard = 0) = 0;
-
+
/*!
* Sets the time registers immediately.
* \param time_spec the new time
@@ -259,19 +259,19 @@ class GR_SHD_API shd_smini_sink : virtual public gr_sync_block
* \param time_spec the new time
*/
virtual void set_time_next_pps(const shd::time_spec_t &time_spec) = 0;
-
+
/*!
* Sync the time registers with an unknown pps edge.
* \param time_spec the new time
*/
virtual void set_time_unknown_pps(const shd::time_spec_t &time_spec) = 0;
-
+
/*!
* Get access to the underlying shd dboard iface object.
* \return the dboard_iface object
*/
virtual shd::xmini::dboard_iface::sptr get_dboard_iface(size_t chan = 0) = 0;
-
+
/*!
* Get access to the underlying shd device object.
* \return the multi smini device object
diff --git a/gr-shd/include/gr_shd_smini_source.h b/gr-shd/include/gr_shd_smini_source.h
index 3e3dbf427..11c8563fe 100644
--- a/gr-shd/include/gr_shd_smini_source.h
+++ b/gr-shd/include/gr_shd_smini_source.h
@@ -1,18 +1,18 @@
/*
* Copyright 2011 Free Software Foundation, Inc.
- *
+ *
* This file is part of GNU Radio
- *
+ *
* GNU Radio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
- *
+ *
* GNU Radio is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
- *
+ *
* You should have received a copy of the GNU General Public License
* along with GNU Radio; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
@@ -37,7 +37,7 @@ GR_SHD_API boost::shared_ptr<shd_smini_source> shd_make_smini_source(
class GR_SHD_API shd_smini_source : virtual public gr_sync_block
{
public:
-
+
/*!
* Set the subdevice specification.
* \param spec the subdev spec markup string
@@ -45,7 +45,7 @@ class GR_SHD_API shd_smini_source : virtual public gr_sync_block
*/
virtual void set_subdev_spec(const std::string &spec,
size_t mboard = 0) = 0;
-
+
/*!
* Set the sample rate for the smini device.
* \param rate a new rate in Sps
@@ -58,7 +58,7 @@ class GR_SHD_API shd_smini_source : virtual public gr_sync_block
* \return the actual rate in Sps
*/
virtual double get_samp_rate(void) = 0;
-
+
/*!
* Tune the smini device to the desired center frequency.
* \param tune_request the tune request instructions
@@ -69,7 +69,7 @@ class GR_SHD_API shd_smini_source : virtual public gr_sync_block
const shd::tune_request_t tune_request,
size_t chan = 0
) = 0;
-
+
/*!
* Tune the smini device to the desired center frequency.
* This is a wrapper around set center freq so that in this case,
@@ -81,28 +81,28 @@ class GR_SHD_API shd_smini_source : virtual public gr_sync_block
shd::tune_result_t set_center_freq(double freq, size_t chan = 0){
return set_center_freq(shd::tune_request_t(freq), chan);
}
-
+
/*!
* Get the center frequency.
* \param chan the channel index 0 to N-1
* \return the frequency in Hz
*/
virtual double get_center_freq(size_t chan = 0) = 0;
-
+
/*!
* Get the tunable frequency range.
* \param chan the channel index 0 to N-1
* \return the frequency range in Hz
*/
virtual shd::freq_range_t get_freq_range(size_t chan = 0) = 0;
-
+
/*!
* Set the gain for the dboard.
* \param gain the gain in dB
* \param chan the channel index 0 to N-1
*/
virtual void set_gain(double gain, size_t chan = 0) = 0;
-
+
/*!
* Set the named gain on the dboard.
* \param gain the gain in dB
@@ -111,14 +111,14 @@ class GR_SHD_API shd_smini_source : virtual public gr_sync_block
*/
virtual void set_gain(double gain, const std::string &name,
size_t chan = 0) = 0;
-
+
/*!
* Get the actual dboard gain setting.
* \param chan the channel index 0 to N-1
* \return the actual gain in dB
*/
virtual double get_gain(size_t chan = 0) = 0;
-
+
/*!
* Get the actual dboard gain setting of named stage.
* \param name the name of the gain stage
@@ -127,21 +127,21 @@ class GR_SHD_API shd_smini_source : virtual public gr_sync_block
*/
virtual double get_gain(const std::string &name,
size_t chan = 0) = 0;
-
+
/*!
* Get the actual dboard gain setting of named stage.
* \param chan the channel index 0 to N-1
* \return the actual gain in dB
*/
virtual std::vector<std::string> get_gain_names(size_t chan = 0) = 0;
-
+
/*!
* Get the settable gain range.
* \param chan the channel index 0 to N-1
* \return the gain range in dB
*/
virtual shd::gain_range_t get_gain_range(size_t chan = 0) = 0;
-
+
/*!
* Get the settable gain range.
* \param name the name of the gain stage
@@ -150,7 +150,7 @@ class GR_SHD_API shd_smini_source : virtual public gr_sync_block
*/
virtual shd::gain_range_t get_gain_range(const std::string &name,
size_t chan = 0) = 0;
-
+
/*!
* Set the antenna to use.
* \param ant the antenna string
@@ -158,21 +158,21 @@ class GR_SHD_API shd_smini_source : virtual public gr_sync_block
*/
virtual void set_antenna(const std::string &ant,
size_t chan = 0) = 0;
-
+
/*!
* Get the antenna in use.
* \param chan the channel index 0 to N-1
* \return the antenna string
*/
virtual std::string get_antenna(size_t chan = 0) = 0;
-
+
/*!
* Get a list of possible antennas.
* \param chan the channel index 0 to N-1
* \return a vector of antenna strings
*/
virtual std::vector<std::string> get_antennas(size_t chan = 0) = 0;
-
+
/*!
* Set the subdevice bandpass filter.
* \param bandwidth the filter bandwidth in Hz
@@ -180,7 +180,7 @@ class GR_SHD_API shd_smini_source : virtual public gr_sync_block
*/
virtual void set_bandwidth(double bandwidth,
size_t chan = 0) = 0;
-
+
/*!
* Get a daughterboard sensor value.
* \param name the name of the sensor
@@ -189,14 +189,14 @@ class GR_SHD_API shd_smini_source : virtual public gr_sync_block
*/
virtual shd::sensor_value_t get_dboard_sensor(const std::string &name,
size_t chan = 0) = 0;
-
+
/*!
* Get a list of possible daughterboard sensor names.
* \param chan the channel index 0 to N-1
* \return a vector of sensor names
*/
virtual std::vector<std::string> get_dboard_sensor_names(size_t chan = 0) = 0;
-
+
/*!
* Get a motherboard sensor value.
* \param name the name of the sensor
@@ -205,14 +205,14 @@ class GR_SHD_API shd_smini_source : virtual public gr_sync_block
*/
virtual shd::sensor_value_t get_mboard_sensor(const std::string &name,
size_t mboard = 0) = 0;
-
+
/*!
* Get a list of possible motherboard sensor names.
* \param mboard the motherboard index 0 to M-1
* \return a vector of sensor names
*/
virtual std::vector<std::string> get_mboard_sensor_names(size_t mboard = 0) = 0;
-
+
/*!
* Set the clock configuration.
* \param clock_config the new configuration
@@ -220,14 +220,14 @@ class GR_SHD_API shd_smini_source : virtual public gr_sync_block
*/
virtual void set_clock_config(const shd::clock_config_t &clock_config,
size_t mboard = 0) = 0;
-
+
/*!
* Get the master clock rate.
* \param mboard the motherboard index 0 to M-1
* \return the clock rate in Hz
*/
virtual double get_clock_rate(size_t mboard = 0) = 0;
-
+
/*!
* Set the master clock rate.
* \param rate the new rate in Hz
@@ -242,14 +242,14 @@ class GR_SHD_API shd_smini_source : virtual public gr_sync_block
* \return the current smini time
*/
virtual shd::time_spec_t get_time_now(size_t mboard = 0) = 0;
-
+
/*!
* Get the time when the last pps pulse occured.
* \param mboard the motherboard index 0 to M-1
* \return the current smini time
*/
virtual shd::time_spec_t get_time_last_pps(size_t mboard = 0) = 0;
-
+
/*!
* Sets the time registers immediately.
* \param time_spec the new time
@@ -263,19 +263,19 @@ class GR_SHD_API shd_smini_source : virtual public gr_sync_block
* \param time_spec the new time
*/
virtual void set_time_next_pps(const shd::time_spec_t &time_spec) = 0;
-
+
/*!
* Sync the time registers with an unknown pps edge.
* \param time_spec the new time
*/
virtual void set_time_unknown_pps(const shd::time_spec_t &time_spec) = 0;
-
+
/*!
* Get access to the underlying shd dboard iface object.
* \return the dboard_iface object
*/
virtual shd::xmini::dboard_iface::sptr get_dboard_iface(size_t chan = 0) = 0;
-
+
/*!
* Get access to the underlying shd device object.
* \return the multi smini device object