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