Fix for working with RFX boards.
[debian/gnuradio] / gr-sounder / src / python / sounder.py
1 #!/usr/bin/env python
2 #
3 # Copyright 2007 Free Software Foundation, Inc.
4
5 # This file is part of GNU Radio
6
7 # GNU Radio is free software; you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 2, or (at your option)
10 # any later version.
11
12 # GNU Radio is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 # GNU General Public License for more details.
16
17 # You should have received a copy of the GNU General Public License
18 # along with GNU Radio; see the file COPYING.  If not, write to
19 # the Free Software Foundation, Inc., 51 Franklin Street,
20 # Boston, MA 02110-1301, USA.
21
22
23 from gnuradio import gr, usrp
24 from gnuradio import eng_notation
25
26 n2s = eng_notation.num_to_str
27
28 FR_MODE = usrp.FR_USER_0
29 bmFR_MODE_RESET = 1 << 0        # bit 0: active high reset
30 bmFR_MODE_TX    = 1 << 1        # bit 1: enable transmitter
31 bmFR_MODE_RX    = 1 << 2        # bit 2: enable receiver
32 bmFR_MODE_LP    = 1 << 3        # bit 3: enable digital loopback
33
34 FR_DEGREE = usrp.FR_USER_1
35 FR_AMPL = usrp.FR_USER_2
36
37 def pick_subdevice(u):
38     """
39     The user didn't specify a subdevice on the command line.
40     If there's a daughterboard on A, select A.
41     If there's a daughterboard on B, select B.
42     Otherwise, select A.
43     """
44     if u.db[0][0].dbid() >= 0:       # dbid is < 0 if there's no d'board or a problem
45         return (0, 0)
46     if u.db[1][0].dbid() >= 0:
47         return (1, 0)
48     return (0, 0)
49
50 class sounder_tx:
51     def __init__(self, loopback=False,ampl=4096,verbose=False,debug=False):
52         self._loopback=loopback
53         self._amplitude = ampl
54         self._verbose = verbose
55         self._debug = debug
56         self._u = usrp.sink_s(fpga_filename='usrp_sounder.rbf')
57         if not self._loopback:
58             self._subdev_spec = usrp.pick_tx_subdevice(self._u)
59             self._subdev = usrp.selected_subdev(self._u, self._subdev_spec)
60             if self._verbose:
61                 print "Using", self._subdev.name(), "for sounder transmitter."            
62         self.set_amplitude(ampl)
63         self._u.start()
64         self._subdev.set_enable(True)
65         if hasattr(self._subdev, 'set_lo_offset'):
66             self._subdev.set_lo_offset(0)
67             
68     def tune(self, frequency):
69         if self._verbose:
70             print "Setting transmitter frequency to", n2s(frequency)
71         result = self._u.tune(0, self._subdev, frequency)
72         if result == False:
73             raise RuntimeError("Failed to set transmitter frequency.")
74
75     def set_amplitude(self, ampl):
76         self._amplitude = ampl
77         if self._debug:
78             print "Writing amplitude register with:", hex(self._mode)
79         self._u._write_fpga_reg(FR_AMPL, self._amplitude)
80
81 class sounder_rx:
82     def __init__(self,subdev_spec=None,gain=None,length=1,alpha=1.0,msgq=None,loopback=False,verbose=False,debug=False):
83         self._subdev_spec = subdev_spec
84         self._gain = gain
85         self._length = length
86         self._alpha = alpha
87         self._msgq = msgq
88         self._loopback = loopback
89         self._verbose = verbose
90         self._debug = debug
91                 
92         self._fg = gr.flow_graph()
93         self._u = usrp.source_c(fpga_filename='usrp_sounder.rbf')
94         if not self._loopback:
95             if self._subdev_spec == None:
96                 self._subdev_spec = pick_subdevice(self._u)
97             self._u.set_mux(usrp.determine_rx_mux_value(self._u, self._subdev_spec))
98             self._subdev = usrp.selected_subdev(self._u, self._subdev_spec)
99             if self._verbose:
100                 print "Using", self._subdev.name(), "for sounder receiver."
101
102         self.set_gain(self._gain)
103         self._vblen = gr.sizeof_gr_complex*self._length
104         if self._debug:
105             print "Generating impulse vectors of length", self._length, "byte length", self._vblen
106             
107         self._s2v = gr.stream_to_vector(gr.sizeof_gr_complex, self._length)
108         if self._verbose:
109             print "Using smoothing alpha of", self._alpha
110         self._lpf = gr.single_pole_iir_filter_cc(self._alpha, self._length)
111         self._sink = gr.message_sink(self._vblen, self._msgq, True)
112         self._fg.connect(self._u, self._s2v, self._lpf, self._sink)
113
114     def tune(self, frequency):
115         if self._verbose:
116             print "Setting receiver frequency to", n2s(frequency)
117         result = self._u.tune(0, self._subdev, frequency)
118         if result == False:
119             raise RuntimeError("Failed to set receiver frequency.")
120
121     def set_gain(self, gain):
122         self._gain = gain
123         if self._loopback:
124             return
125             
126         if self._gain is None:
127             # if no gain was specified, use the mid-point in dB
128             g = self._subdev.gain_range()
129             self._gain = float(g[0]+g[1])/2
130         if self._verbose:
131             print "Setting receiver gain to", gain
132         self._subdev.set_gain(self._gain)
133
134     def start(self):
135         if self._debug:
136             print "Starting receiver flow graph."
137         self._fg.start()
138
139     def wait(self):
140         if self._debug:
141             print "Waiting for threads..."
142         self._fg.wait()
143
144     def stop(self):
145         if self._debug:
146             print "Stopping receiver flow graph."
147         self._fg.stop()
148         self.wait()
149         if self._debug:
150             print "Receiver flow graph stopped."
151
152
153 class sounder:
154     def __init__(self,transmit=False,receive=False,loopback=False,rx_subdev_spec=None,ampl=0x1FFF,
155                  frequency=0.0,rx_gain=None,degree=12,length=1,alpha=1.0,msgq=None,verbose=False,debug=False):
156         self._transmit = transmit
157         self._receive = receive
158         self._loopback = loopback
159         self._rx_subdev_spec = rx_subdev_spec
160         self._frequency = frequency
161         self._amplitude = ampl
162         self._rx_gain = rx_gain
163         self._degree = degree
164         self._length = length
165         self._alpha = alpha
166         self._msgq = msgq
167         self._verbose = verbose
168         self._debug = debug
169         self._mode = 0
170         self._u = None
171         self._trans = None
172         self._rcvr = None
173         self._transmitting = False
174         self._receiving = False
175                 
176         if self._transmit:
177             self._trans = sounder_tx(loopback=self._loopback,ampl=self._amplitude,
178                                      verbose=self._verbose)
179             self._u = self._trans._u
180             
181         if self._receive:
182             self._rcvr = sounder_rx(subdev_spec=self._rx_subdev_spec,length=self._length,
183                                     gain=self._rx_gain,alpha=self._alpha,msgq=self._msgq,
184                                     loopback=self._loopback,verbose=self._verbose, 
185                                     debug=self._debug)
186             self._u = self._rcvr._u # either receiver or transmitter object will do
187         
188         self.set_reset(True)
189         if self._loopback == False:
190             self.tune(self._frequency)
191         self.set_degree(self._degree)
192         self.set_loopback(self._loopback)       
193         self.set_reset(False)
194                 
195     def tune(self, frequency):
196         self._frequency = frequency
197         if self._rcvr:
198             self._rcvr.tune(frequency)
199         if self._trans:
200             self._trans.tune(frequency)
201
202     def set_degree(self, degree):
203         if self._verbose:
204             print "Setting PN code degree to", degree
205         self._u._write_fpga_reg(FR_DEGREE, degree);
206             
207     def _write_mode(self):
208         if self._debug:
209             print "Writing mode register with:", hex(self._mode)
210         self._u._write_fpga_reg(FR_MODE, self._mode)
211
212     def enable_tx(self, value):
213         if value:
214             if self._verbose:
215                 print "Enabling transmitter."
216             self._mode |= bmFR_MODE_TX
217             self._transmitting = True
218         else:
219             if self._verbose:
220                 print "Disabling transmitter."
221             self._mode &= ~bmFR_MODE_TX
222         self._write_mode()
223                     
224     def enable_rx(self, value):
225         if value:
226             self._mode |= bmFR_MODE_RX
227             self._write_mode()
228             self._rcvr.start()
229             self._receiving = True
230         else:
231             self._rcvr.stop()
232             self._mode &= ~bmFR_MODE_RX
233             self._write_mode()
234             self._receiving = False
235                 
236     def set_loopback(self, value):
237         if value:
238             if self._verbose:
239                 print "Enabling digital loopback."
240             self._mode |= bmFR_MODE_LP
241         else:
242             if self._verbose:
243                 print "Disabling digital loopback."
244             self._mode &= ~bmFR_MODE_LP
245         self._write_mode()
246
247     def set_reset(self, value):
248         if value:
249             if self._debug:
250                 print "Asserting reset."
251             self._mode |= bmFR_MODE_RESET
252         else:
253             if self._debug:
254                 print "De-asserting reset."
255             self._mode &= ~bmFR_MODE_RESET
256         self._write_mode()
257
258     def start(self):
259         if self._transmit:
260             self.enable_tx(True)
261         if self._receive:
262             self.enable_rx(True)
263
264     def __del__(self):
265         if self._transmitting:
266             self.enable_tx(False)
267             
268         if self._receiving:
269             self.enable_rx(False)
270