Merged r6329:6428 of features/inband-usb + distcheck fixes into trunk.
[debian/gnuradio] / gr-radar-mono / src / python / radar_mono.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 3, 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 #-----------------------------------------------------------------------
29 # FPGA Register Definitions
30 #-----------------------------------------------------------------------
31 FR_RADAR_MODE           = usrp.FR_USER_0    # Operational mode
32 bmFR_RADAR_MODE_RESET   = 1 << 0        # bit 0: active high reset
33 bmFR_RADAR_TXSIDE       = 1 << 1        # bit 1: use TX side A or B
34 #bmFR_RADAR_MODE_LP      = 1 << 2       # bit 2: enable digital loopback
35 #bmFR_RADAR_MODE_DR      = 1 << 3       # bit 3: enable on-board deramping
36 #bmFR_RADAR_MODE_MD      = 1 << 4       # bit 4: enable echo metadata
37 #bmFR_RADAR_MODE_CHIRPS  = 3 << 5       # bit 5,6: number of chirp center frequencies
38 bmFR_RADAR_DEBUG        = 1 << 7        # bit 7: enable debugging mode
39
40 FR_RADAR_TON    = usrp.FR_USER_1        # 16-bit transmitter on time in clocks
41 FR_RADAR_TSW    = usrp.FR_USER_2        # 16-bit transmitter switch time in clocks
42 FR_RADAR_TLOOK  = usrp.FR_USER_3        # 16-bit receiver look time in clocks
43 FR_RADAR_TIDLE  = usrp.FR_USER_4        # 32-bit inter-pulse idle time
44 FR_RADAR_AMPL   = usrp.FR_USER_5        # 16-bit pulse amplitude (2s complement) into CORDIC
45 FR_RADAR_FSTART = usrp.FR_USER_6        # 32-bit FTW for chirp start frequency
46 FR_RADAR_FINCR  = usrp.FR_USER_7        # 32-bit FTW increment per transmit clock
47
48 # These are for phase II development
49 #FR_RADAR_FREQ1N = usrp.FR_USER_8  # 24-bit N register for chirp #1
50 #FR_RADAR_FREQ1R = usrp.FR_USER_9  # 24-bit R register for chirp #1
51 #FR_RADAR_FREQ1C = usrp.FR_USER_10 # 24-bit C register for chirp #1
52 #FR_RADAR_FREQ2N = usrp.FR_USER_11 # 24-bit N register for chirp #2
53 #FR_RADAR_FREQ2R = usrp.FR_USER_12 # 24-bit R register for chirp #2
54 #FR_RADAR_FREQ2C = usrp.FR_USER_13 # 24-bit C register for chirp #2
55 #FR_RADAR_FREQ3N = usrp.FR_USER_14 # 24-bit N register for chirp #3
56 #FR_RADAR_FREQ3R = usrp.FR_USER_15 # 24-bit R register for chirp #3
57 #FR_RADAR_FREQ3C = usrp.FR_USER_16 # 24-bit C register for chirp #3
58 #FR_RADAR_FREQ4N = usrp.FR_USER_17 # 24-bit N register for chirp #4
59 #FR_RADAR_FREQ4R = usrp.FR_USER_18 # 24-bit R register for chirp #4
60 #FR_RADAR_FREQ4C = usrp.FR_USER_19 # 24-bit C register for chirp #4
61
62 #-----------------------------------------------------------------------
63 # Transmitter object.  Uses usrp_sink, but only for a handle to the
64 # FPGA registers.
65 #-----------------------------------------------------------------------
66 class radar_tx:
67     def __init__(self, subdev_spec=None, verbose=False, debug=False):
68         self._subdev_spec = subdev_spec
69         self._verbose = verbose
70         self._debug = debug
71         self._u = usrp.sink_s(fpga_filename='usrp_radar_mono.rbf')
72
73         if self._subdev_spec == None:
74             self._subdev_spec = usrp.pick_tx_subdevice(self._u)
75
76         self._subdev = usrp.selected_subdev(self._u, self._subdev_spec)
77         self._subdev.set_lo_offset(0.0)
78         self._ton_ticks = 0
79         self._tsw_ticks = 0
80         self._tlook_ticks = 0
81         self._tidle_ticks = 0
82         
83         if self._verbose:
84             print "Using", self._subdev.name(), "for radar transmitter."            
85             
86     def set_ton(self, ton):
87         self._ton_ticks = 2*(int(ton*64e6)/2)-1  # Even number, then subtract 1
88         if self._verbose:
89             print "Setting pulse on time to", ton, " sec ("+`self._ton_ticks+1`+" ticks)"
90         self._u._write_fpga_reg(FR_RADAR_TON, self._ton_ticks)
91
92     def set_tsw(self, tsw):
93         self._tsw_ticks = 2*(int(tsw*64e6)/2)-1  # Even number, then subtract 1
94         if self._verbose:
95             print "Setting pulse switching time to", tsw, " sec ("+`self._tsw_ticks+1`+" ticks)"
96         self._u._write_fpga_reg(FR_RADAR_TSW, self._tsw_ticks)
97
98     def set_tlook(self, tlook):
99         self._tlook_ticks = 2*(int(tlook*64e6)/2)-1  # Even number, then subtract 1
100         if self._verbose:
101             print "Setting receiver look time to", tlook, " sec ("+`self._tlook_ticks+1`+" ticks)"
102         self._u._write_fpga_reg(FR_RADAR_TLOOK, self._tlook_ticks)
103
104     def set_prf(self, prf):
105         period = 2*int(32e6/prf)
106         self._tidle_ticks = period-(self._ton_ticks+self._tsw_ticks+self._tlook_ticks+3)-1
107         if self._verbose:
108             print "Setting PRF to", prf, "Hz ("+`self._tidle_ticks+1`+" ticks idle time)"
109         self._u._write_fpga_reg(FR_RADAR_TIDLE, self._tidle_ticks)
110
111     def set_amplitude(self, ampl):
112         self._amplitude = int(ampl*9946/100.0) # CORDIC gain correction
113         self._u._write_fpga_reg(FR_RADAR_AMPL, self._amplitude)
114
115     def set_freq(self, center_freq, chirp_width):
116         self._center_freq = center_freq
117         self._chirp_width = chirp_width
118         self._fstart = -int((chirp_width/2)*(2**32)/32e6)
119         self._fincr = int((chirp_width/16e6)*(2**32)/(self._ton_ticks+1))
120                           
121         if self._verbose:
122             print "Setting transmitter center frequency to", n2s(center_freq)
123             print "Setting chirp width to", n2s(chirp_width), "Hz "+"("+hex(self._fstart)+", "+hex(self._fincr)+")"
124
125         result = self._u.tune(0, self._subdev, center_freq)
126         if result == False:
127             raise RuntimeError("Failed to set transmitter frequency.")
128         self._u._write_fpga_reg(FR_RADAR_FSTART, self._fstart)
129         self._u._write_fpga_reg(FR_RADAR_FINCR, self._fincr)
130
131     def start(self):
132         self._u.start()
133         self._subdev.set_enable(True)
134         
135     def stop(self):
136         self._subdev.set_enable(False)
137         self._u.stop()
138
139     def subdev_spec(self):
140         return self._subdev_spec
141     
142     def echo_length(self):
143         return self._tlook_ticks+1
144
145     def __del__(self):
146         del self._subdev # Avoid weak reference error
147         
148 #-----------------------------------------------------------------------
149 # Receiver object.  Uses usrp_source_c to receive echo records.
150 #-----------------------------------------------------------------------
151 class radar_rx:
152     def __init__(self, gain=None, subdev_spec=None, msgq=None, length=None,
153                  verbose=False, debug=False):
154         self._gain = gain
155         self._subdev_spec = subdev_spec
156         self._msgq = msgq
157         self._length = length
158         self._verbose = verbose
159         self._debug = debug
160         self._length_set = False
161                         
162         self._fg = gr.flow_graph()
163         self._u = usrp.source_c(fpga_filename='usrp_radar_mono.rbf')
164         if self._subdev_spec == None:
165             self._subdev_spec = usrp.pick_rx_subdevice(self._u)
166         self._u.set_mux(usrp.determine_rx_mux_value(self._u, self._subdev_spec))
167
168         if self._debug:
169             self._usrp_sink = gr.file_sink(gr.sizeof_gr_complex, "usrp.dat")
170             self._fg.connect(self._u, self._usrp_sink)
171         
172         self._subdev = usrp.selected_subdev(self._u, self._subdev_spec)
173         self.set_gain(gain)
174
175         if self._verbose:
176             print "Using", self._subdev.name(), "for radar receiver."
177             print "Setting receiver gain to", self._gain
178         
179     def set_echo_length(self, length):
180         # Only call once
181         if self._length_set is True:
182             raise RuntimeError("Can only set echo length once.")
183         self._length = length
184         self._vblen = gr.sizeof_gr_complex*self._length
185         self._s2v = gr.stream_to_vector(gr.sizeof_gr_complex, self._length)
186         self._sink = gr.message_sink(self._vblen, self._msgq, True)
187         self._fg.connect(self._u, self._s2v, self._sink)
188         self._length_set = True
189         if self._verbose:
190             print "Receiving echo vectors of length", self._length, \
191                   "(samples)", self._vblen, "(bytes)"
192
193     def tune(self, frequency):
194         if self._verbose:
195             print "Setting receiver frequency to", n2s(frequency)
196         result = self._u.tune(0, self._subdev, frequency)
197         if result == False:
198             raise RuntimeError("Failed to set receiver frequency.")
199
200     def set_gain(self, gain):
201         self._gain = gain
202         if self._gain == None:
203             # if no gain was specified, use the mid-point in dB
204             g = self._subdev.gain_range()
205             self._gain = float(g[0]+g[1])/2
206         self._subdev.set_gain(self._gain)
207
208     def start(self):
209         if self._verbose:
210             print "Starting receiver flow graph."
211         self._fg.start()
212
213     def wait(self):
214         if self._verbose:
215             print "Waiting for threads..."
216         self._fg.wait()
217
218     def stop(self):
219         if self._verbose:
220             print "Stopping receiver flow graph."
221         self._fg.stop()
222         self.wait()
223         if self._verbose:
224             print "Receiver flow graph stopped."
225
226 class radar:
227     def __init__(self, msgq=None, tx_subdev_spec=None, rx_subdev_spec=None,
228                  gain=None, verbose=False, debug=False):
229         self._msgq = msgq
230         self._verbose = verbose
231         self._debug = debug
232
233         self._mode = 0
234         self._trans = radar_tx(subdev_spec=tx_subdev_spec, verbose=self._verbose, debug=self._debug)
235         self._rcvr = radar_rx(gain=gain, msgq=self._msgq, subdev_spec=rx_subdev_spec, 
236                               verbose=self._verbose, debug=self._debug)
237         self.set_reset(True)
238         self.set_tx_board(self._trans.subdev_spec())
239         self.set_debug(self._debug)
240         
241     def _write_mode(self):
242         self._trans._u._write_fpga_reg(FR_RADAR_MODE, self._mode)
243
244     def set_reset(self, value):
245         if value:
246             self._mode |= bmFR_RADAR_MODE_RESET
247         else:
248             self._mode &= ~bmFR_RADAR_MODE_RESET
249         self._write_mode()
250
251     def set_tx_board(self, tx_subdev_spec):
252         if tx_subdev_spec[0] == 1:
253             self._mode |= bmFR_RADAR_TXSIDE
254         else:
255             self._mode &= ~bmFR_RADAR_TXSIDE
256         self._write_mode()
257         
258     def set_debug(self, value):
259         if value:
260             self._mode |= bmFR_RADAR_DEBUG
261         else:
262             self._mode &= ~bmFR_RADAR_DEBUG
263         self._write_mode()
264     
265     def set_ton(self, ton):
266         self._trans.set_ton(ton)
267         
268     def set_tsw(self, tsw):
269         self._trans.set_tsw(tsw)
270         
271     def set_tlook(self, tlook):
272         self._trans.set_tlook(tlook)
273         self._rcvr.set_echo_length(self._trans.echo_length())
274         
275     def set_prf(self, prf):
276         self._trans.set_prf(prf)
277
278     def set_amplitude(self, ampl):
279         self._trans.set_amplitude(ampl)
280
281     def set_freq(self, center_freq, chirp_width):
282         self._trans.set_freq(center_freq, chirp_width)
283         # set receiver center frequency
284         
285     def start(self):
286         self.set_reset(False)
287         self._trans.start()
288         self._rcvr.start()
289         
290     def stop(self):
291         self._trans.stop()
292         self._rcvr.stop()
293         self.set_reset(True)
294