7a6157125ec048299c6a36b703f0d83a1b237ef3
[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
65     def tune(self, frequency):
66         if self._verbose:
67             print "Setting transmitter frequency to", n2s(frequency)
68         result = self._u.tune(0, self._subdev, frequency)
69         if result == False:
70             raise RuntimeError("Failed to set transmitter frequency.")
71
72     def set_amplitude(self, ampl):
73         self._amplitude = ampl
74         if self._debug:
75             print "Writing amplitude register with:", hex(self._mode)
76         self._u._write_fpga_reg(FR_AMPL, self._amplitude)
77
78 class sounder_rx:
79     def __init__(self,subdev_spec=None,gain=None,length=1,alpha=1.0,msgq=None,loopback=False,verbose=False,debug=False):
80         self._subdev_spec = subdev_spec
81         self._gain = gain
82         self._length = length
83         self._alpha = alpha
84         self._msgq = msgq
85         self._loopback = loopback
86         self._verbose = verbose
87         self._debug = debug
88                 
89         self._fg = gr.flow_graph()
90         self._u = usrp.source_c(fpga_filename='usrp_sounder.rbf')
91         if not self._loopback:
92             if self._subdev_spec == None:
93                 self._subdev_spec = pick_subdevice(self._u)
94             self._u.set_mux(usrp.determine_rx_mux_value(self._u, self._subdev_spec))
95             self._subdev = usrp.selected_subdev(self._u, self._subdev_spec)
96             if self._verbose:
97                 print "Using", self._subdev.name(), "for sounder receiver."
98
99         self.set_gain(self._gain)
100         self._vblen = gr.sizeof_gr_complex*self._length
101         if self._debug:
102             print "Generating impulse vectors of length", self._length, "byte length", self._vblen
103             
104         self._s2v = gr.stream_to_vector(gr.sizeof_gr_complex, self._length)
105         if self._verbose:
106             print "Using smoothing alpha of", self._alpha
107         self._lpf = gr.single_pole_iir_filter_cc(self._alpha, self._length)
108         self._sink = gr.message_sink(self._vblen, self._msgq, True)
109         self._fg.connect(self._u, self._s2v, self._lpf, self._sink)
110
111     def tune(self, frequency):
112         if self._verbose:
113             print "Setting receiver frequency to", n2s(frequency)
114         result = self._u.tune(0, self._subdev, frequency)
115         if result == False:
116             raise RuntimeError("Failed to set receiver frequency.")
117
118     def set_gain(self, gain):
119         self._gain = gain
120         if self._loopback:
121             return
122             
123         if self._gain is None:
124             # if no gain was specified, use the mid-point in dB
125             g = self._subdev.gain_range()
126             self._gain = float(g[0]+g[1])/2
127         if self._verbose:
128             print "Setting receiver gain to", gain
129         self._subdev.set_gain(self._gain)
130
131     def start(self):
132         if self._debug:
133             print "Starting receiver flow graph."
134         self._fg.start()
135
136     def wait(self):
137         if self._debug:
138             print "Waiting for threads..."
139         self._fg.wait()
140
141     def stop(self):
142         if self._debug:
143             print "Stopping receiver flow graph."
144         self._fg.stop()
145         self.wait()
146         if self._debug:
147             print "Receiver flow graph stopped."
148
149
150 class sounder:
151     def __init__(self,transmit=False,receive=False,loopback=False,rx_subdev_spec=None,ampl=0x1FFF,
152                  frequency=0.0,rx_gain=None,degree=12,length=1,alpha=1.0,msgq=None,verbose=False,debug=False):
153         self._transmit = transmit
154         self._receive = receive
155         self._loopback = loopback
156         self._rx_subdev_spec = rx_subdev_spec
157         self._frequency = frequency
158         self._amplitude = ampl
159         self._rx_gain = rx_gain
160         self._degree = degree
161         self._length = length
162         self._alpha = alpha
163         self._msgq = msgq
164         self._verbose = verbose
165         self._debug = debug
166         self._mode = 0
167         self._u = None
168         self._trans = None
169         self._rcvr = None
170         self._transmitting = False
171         self._receiving = False
172                 
173         if self._transmit:
174             self._trans = sounder_tx(loopback=self._loopback,ampl=self._amplitude,
175                                      verbose=self._verbose)
176             self._u = self._trans._u
177             
178         if self._receive:
179             self._rcvr = sounder_rx(subdev_spec=self._rx_subdev_spec,length=self._length,
180                                     gain=self._rx_gain,alpha=self._alpha,msgq=self._msgq,
181                                     loopback=self._loopback,verbose=self._verbose, 
182                                     debug=self._debug)
183             self._u = self._rcvr._u # either receiver or transmitter object will do
184         
185         self.set_reset(True)
186         if self._loopback == False:
187             self.tune(self._frequency)
188         self.set_degree(self._degree)
189         self.set_loopback(self._loopback)       
190         self.set_reset(False)
191                 
192     def tune(self, frequency):
193         self._frequency = frequency
194         if self._rcvr:
195             self._rcvr.tune(frequency)
196         if self._trans:
197             self._trans.tune(frequency)
198
199     def set_degree(self, degree):
200         if self._verbose:
201             print "Setting PN code degree to", degree
202         self._u._write_fpga_reg(FR_DEGREE, degree);
203             
204     def _write_mode(self):
205         if self._debug:
206             print "Writing mode register with:", hex(self._mode)
207         self._u._write_fpga_reg(FR_MODE, self._mode)
208
209     def enable_tx(self, value):
210         if value:
211             if self._verbose:
212                 print "Enabling transmitter."
213             self._mode |= bmFR_MODE_TX
214             self._transmitting = True
215         else:
216             if self._verbose:
217                 print "Disabling transmitter."
218             self._mode &= ~bmFR_MODE_TX
219         self._write_mode()
220                     
221     def enable_rx(self, value):
222         if value:
223             self._mode |= bmFR_MODE_RX
224             self._write_mode()
225             self._rcvr.start()
226             self._receiving = True
227         else:
228             self._rcvr.stop()
229             self._mode &= ~bmFR_MODE_RX
230             self._write_mode()
231             self._receiving = False
232                 
233     def set_loopback(self, value):
234         if value:
235             if self._verbose:
236                 print "Enabling digital loopback."
237             self._mode |= bmFR_MODE_LP
238         else:
239             if self._verbose:
240                 print "Disabling digital loopback."
241             self._mode &= ~bmFR_MODE_LP
242         self._write_mode()
243
244     def set_reset(self, value):
245         if value:
246             if self._debug:
247                 print "Asserting reset."
248             self._mode |= bmFR_MODE_RESET
249         else:
250             if self._debug:
251                 print "De-asserting reset."
252             self._mode &= ~bmFR_MODE_RESET
253         self._write_mode()
254
255     def start(self):
256         if self._transmit:
257             self.enable_tx(True)
258         if self._receive:
259             self.enable_rx(True)
260
261     def __del__(self):
262         if self._transmitting:
263             self.enable_tx(False)
264             
265         if self._receiving:
266             self.enable_rx(False)
267