1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
//
// Copyright 2010 Ettus Research LLC
//
#include <boost/tuple/tuple.hpp>
#include <usrp_uhd/wax.hpp>
#include <complex>
#include <vector>
#include <stdint.h>
#ifndef INCLUDED_USRP_UHD_PROPS_HPP
#define INCLUDED_USRP_UHD_PROPS_HPP
namespace usrp_uhd{
/*!
* A time_spec_t holds a seconds and ticks time value.
* The temporal width of a tick depends on the device's clock rate.
* The time_spec_t can be used when setting the time on devices
* and for controlling the start of streaming for applicable dsps.
*/
struct time_spec_t{
uint32_t secs;
uint32_t ticks;
/*!
* Create a time_spec_t that holds a wildcard time.
* This will have implementation-specific meaning.
*/
time_spec_t(void){
secs = ~0;
ticks = ~0;
}
/*!
* Create a time_spec_t from seconds and ticks.
* \param new_secs the new seconds
* \param new_ticks the new ticks (default = 0)
*/
time_spec_t(uint32_t new_secs, uint32_t new_ticks = 0){
secs = new_secs;
ticks = new_ticks;
}
};
//common typedefs for board properties
typedef float gain_t;
typedef double freq_t;
//scalar types
typedef int int_scalar_t;
typedef float real_scalar_t;
typedef std::complex<real_scalar_t> complex_scalar_t;
//vector types
typedef std::vector<int_scalar_t> int_vec_t;
typedef std::vector<real_scalar_t> real_vec_t;
typedef std::vector<complex_scalar_t> complex_vec_t;
//typedef for handling named properties
typedef std::vector<std::string> prop_names_t;
typedef boost::tuple<wax::type, std::string> named_prop_t;
/*!
* Utility function to separate a named property into its components.
* \param key a reference to the prop object
* \param name a reference to the name object
*/
inline named_prop_t extract_named_prop(const wax::type &key, const std::string &name = ""){
if (key.type() == typeid(named_prop_t)){
return wax::cast<named_prop_t>(key);
}
return named_prop_t(key, name);
}
/*!
* Possible device properties:
* In general, a device will have a single mboard.
* In certain mimo applications, multiple boards
* will be present in the interface for configuration.
*/
enum device_prop_t{
DEVICE_PROP_NAME, //ro, std::string
DEVICE_PROP_MBOARD, //ro, wax::obj
DEVICE_PROP_MBOARD_NAMES //ro, prop_names_t
};
/*!
* Possible device mboard properties:
* The general mboard properties are listed below.
* Custom properties can be identified with a string
* and discovered though the others property.
*/
enum mboard_prop_t{
MBOARD_PROP_NAME, //ro, std::string
MBOARD_PROP_OTHERS, //ro, prop_names_t
MBOARD_PROP_MTU, //ro, size_t
MBOARD_PROP_CLOCK_RATE, //ro, freq_t
MBOARD_PROP_RX_DSP, //ro, wax::obj
MBOARD_PROP_RX_DSP_NAMES, //ro, prop_names_t
MBOARD_PROP_TX_DSP, //ro, wax::obj
MBOARD_PROP_TX_DSP_NAMES, //ro, prop_names_t
MBOARD_PROP_RX_DBOARD, //ro, wax::obj
MBOARD_PROP_RX_DBOARD_NAMES, //ro, prop_names_t
MBOARD_PROP_TX_DBOARD, //ro, wax::obj
MBOARD_PROP_TX_DBOARD_NAMES, //ro, prop_names_t
MBOARD_PROP_PPS_SOURCE, //rw, std::string (sma, mimo)
MBOARD_PROP_PPS_SOURCE_NAMES, //ro, prop_names_t
MBOARD_PROP_PPS_POLARITY, //rw, int, +/- 1
MBOARD_PROP_REF_SOURCE, //rw, std::string (int, sma, mimo)
MBOARD_PROP_REF_SOURCE_NAMES, //ro, prop_names_t
MBOARD_PROP_TIME_NOW, //wo, time_spec_t
MBOARD_PROP_TIME_NEXT_PPS //wo, time_spec_t
};
/*!
* Possible device dsp properties:
* A dsp can have a wide range of possible properties.
* A ddc would have a properties "decim", "freq", "taps"...
* Other properties could be gains, complex scalars, enables...
* For this reason the only required properties of a dsp is a name
* and a property to get list of other possible properties.
*/
enum dsp_prop_t{
DSP_PROP_NAME, //ro, std::string
DSP_PROP_OTHERS //ro, prop_names_t
};
/*!
* Possible device dboard properties
*/
enum dboard_prop_t{
DBOARD_PROP_NAME, //ro, std::string
DBOARD_PROP_SUBDEV, //ro, wax::obj
DBOARD_PROP_SUBDEV_NAMES, //ro, prop_names_t
DBOARD_PROP_CODEC //ro, wax::obj
};
/*!
* Possible device codec properties:
* A codec is expected to have a rate and gain elements.
* Other properties can be discovered through the others prop.
*/
enum codec_prop_t{
CODEC_PROP_NAME, //ro, std::string
CODEC_PROP_OTHERS, //ro, prop_names_t
CODEC_PROP_GAIN, //rw, gain_t
CODEC_PROP_GAIN_MAX, //ro, gain_t
CODEC_PROP_GAIN_MIN, //ro, gain_t
CODEC_PROP_GAIN_STEP, //ro, gain_t
CODEC_PROP_GAIN_NAMES, //ro, prop_names_t
CODEC_PROP_CLOCK_RATE //ro, freq_t
};
/*!
* Possible device subdev properties
*/
enum subdev_prop_t{
SUBDEV_PROP_NAME, //ro, std::string
SUBDEV_PROP_OTHERS, //ro, prop_names_t
SUBDEV_PROP_GAIN, //rw, gain_t
SUBDEV_PROP_GAIN_MAX, //ro, gain_t
SUBDEV_PROP_GAIN_MIN, //ro, gain_t
SUBDEV_PROP_GAIN_STEP, //ro, gain_t
SUBDEV_PROP_GAIN_NAMES, //ro, prop_names_t
SUBDEV_PROP_FREQ, //rw, freq_t
SUBDEV_PROP_FREQ_MAX, //ro, freq_t
SUBDEV_PROP_FREQ_MIN, //ro, freq_t
SUBDEV_PROP_ANTENNA, //rw, std::string
SUBDEV_PROP_ANTENNA_NAMES, //ro, prop_names_t
SUBDEV_PROP_ENABLED, //rw, bool
SUBDEV_PROP_QUADRATURE, //ro, bool
SUBDEV_PROP_IQ_SWAPPED, //ro, bool
SUBDEV_PROP_SPECTRUM_INVERTED, //ro, bool
SUBDEV_PROP_IS_TX, //ro, bool
SUBDEV_PROP_RSSI, //ro, gain_t
SUBDEV_PROP_BANDWIDTH //rw, freq_t
};
} //namespace usrp_uhd
#endif /* INCLUDED_USRP_UHD_PROPS_HPP */
|
