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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
|
/* -*- c++ -*- */
/*
* Copyright 2003,2004,2006 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* GNU Radio is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 3, or (at your option)
* any later version.
*
* GNU Radio is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with GNU Radio; see the file COPYING. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street,
* Boston, MA 02110-1301, USA.
*/
/*
* Low level primitives for directly messing with USRP hardware.
*
* If you're trying to use the USRP, you'll probably want to take a look
* at the usrp_rx and usrp_tx classes. They hide a bunch of low level details
* and provide high performance streaming i/o.
*
* This interface is built on top of libusb, which allegedly works under
* Linux, *BSD and Mac OS/X. http://libusb.sourceforge.net
*/
#ifndef _USRP_PRIMS_H_
#define _USRP_PRIMS_H_
#include <usrp_slots.h>
#include <string>
static const int USRP_HASH_SIZE = 16;
enum usrp_load_status_t { ULS_ERROR = 0, ULS_OK, ULS_ALREADY_LOADED };
struct usb_dev_handle;
struct usb_device;
/*!
* \brief initialize libusb; probe busses and devices.
* Safe to call more than once.
*/
void usrp_one_time_init ();
/*
* force a rescan of the buses and devices
*/
void usrp_rescan ();
/*!
* \brief locate Nth (zero based) USRP device in system.
* Return pointer or 0 if not found.
*
* The following kinds of devices are considered USRPs:
*
* unconfigured USRP (no firwmare loaded)
* configured USRP (firmware loaded)
* unconfigured Cypress FX2 (only if fx2_ok_p is true)
*/
struct usb_device *usrp_find_device (int nth, bool fx2_ok_p = false);
bool usrp_usrp_p (struct usb_device *q); //< is this a USRP
bool usrp_usrp0_p (struct usb_device *q); //< is this a USRP Rev 0
bool usrp_usrp1_p (struct usb_device *q); //< is this a USRP Rev 1
bool usrp_usrp2_p (struct usb_device *q); //< is this a USRP Rev 2
int usrp_hw_rev (struct usb_device *q); //< return h/w rev code
bool usrp_fx2_p (struct usb_device *q); //< is this an unconfigured Cypress FX2
bool usrp_unconfigured_usrp_p (struct usb_device *q); //< some kind of unconfigured USRP
bool usrp_configured_usrp_p (struct usb_device *q); //< some kind of configured USRP
/*!
* \brief given a usb_device return an instance of the appropriate usb_dev_handle
*
* These routines claim the specified interface and select the
* correct alternate interface. (USB nomenclature is totally screwed!)
*
* If interface can't be opened, or is already claimed by some other
* process, 0 is returned.
*/
struct usb_dev_handle *usrp_open_cmd_interface (struct usb_device *dev);
struct usb_dev_handle *usrp_open_rx_interface (struct usb_device *dev);
struct usb_dev_handle *usrp_open_tx_interface (struct usb_device *dev);
/*!
* \brief close interface.
*/
bool usrp_close_interface (struct usb_dev_handle *udh);
/*!
* \brief load intel hex format file into USRP/Cypress FX2 (8051).
*
* The filename extension is typically *.ihx
*
* Note that loading firmware may cause the device to renumerate. I.e.,
* change its configuration, invalidating the current device handle.
*/
usrp_load_status_t
usrp_load_firmware (struct usb_dev_handle *udh, const char *filename, bool force);
/*!
* \brief load intel hex format file into USRP FX2 (8051).
*
* The filename extension is typically *.ihx
*
* Note that loading firmware may cause the device to renumerate. I.e.,
* change its configuration, invalidating the current device handle.
* If the result is ULS_OK, usrp_load_firmware_nth delays 1 second
* then rescans the busses and devices.
*/
usrp_load_status_t
usrp_load_firmware_nth (int nth, const char *filename, bool force);
/*!
* \brief load fpga configuration bitstream
*/
usrp_load_status_t
usrp_load_fpga (struct usb_dev_handle *udh, const char *filename, bool force);
/*!
* \brief load the regular firmware and fpga bitstream in the Nth USRP.
*
* This is the normal starting point...
*/
bool usrp_load_standard_bits (int nth, bool force,
const std::string fpga_filename = "",
const std::string firmware_filename = "");
/*!
* \brief copy the given \p hash into the USRP hash slot \p which.
* The usrp implements two hash slots, 0 and 1.
*/
bool usrp_set_hash (struct usb_dev_handle *udh, int which,
const unsigned char hash[USRP_HASH_SIZE]);
/*!
* \brief retrieve the \p hash from the USRP hash slot \p which.
* The usrp implements two hash slots, 0 and 1.
*/
bool usrp_get_hash (struct usb_dev_handle *udh, int which,
unsigned char hash[USRP_HASH_SIZE]);
bool usrp_write_fpga_reg (struct usb_dev_handle *udh, int reg, int value);
bool usrp_read_fpga_reg (struct usb_dev_handle *udh, int reg, int *value);
bool usrp_set_fpga_reset (struct usb_dev_handle *udh, bool on);
bool usrp_set_fpga_tx_enable (struct usb_dev_handle *udh, bool on);
bool usrp_set_fpga_rx_enable (struct usb_dev_handle *udh, bool on);
bool usrp_set_fpga_tx_reset (struct usb_dev_handle *udh, bool on);
bool usrp_set_fpga_rx_reset (struct usb_dev_handle *udh, bool on);
bool usrp_set_led (struct usb_dev_handle *udh, int which, bool on);
bool usrp_check_rx_overrun (struct usb_dev_handle *udh, bool *overrun_p);
bool usrp_check_tx_underrun (struct usb_dev_handle *udh, bool *underrun_p);
// i2c_read and i2c_write are limited to a maximum len of 64 bytes.
bool usrp_i2c_write (struct usb_dev_handle *udh, int i2c_addr,
const void *buf, int len);
bool usrp_i2c_read (struct usb_dev_handle *udh, int i2c_addr,
void *buf, int len);
// spi_read and spi_write are limited to a maximum of 64 bytes
// See usrp_spi_defs.h for more info
bool usrp_spi_write (struct usb_dev_handle *udh,
int optional_header, int enables, int format,
const void *buf, int len);
bool usrp_spi_read (struct usb_dev_handle *udh,
int optional_header, int enables, int format,
void *buf, int len);
bool usrp_9862_write (struct usb_dev_handle *udh,
int which_codec, // [0, 1]
int regno, // [0, 63]
int value); // [0, 255]
bool usrp_9862_read (struct usb_dev_handle *udh,
int which_codec, // [0, 1]
int regno, // [0, 63]
unsigned char *value); // [0, 255]
/*!
* \brief Write multiple 9862 regs at once.
*
* \p buf contains alternating register_number, register_value pairs.
* \p len must be even and is the length of buf in bytes.
*/
bool usrp_9862_write_many (struct usb_dev_handle *udh, int which_codec,
const unsigned char *buf, int len);
/*!
* \brief write specified regs to all 9862's in the system
*/
bool usrp_9862_write_many_all (struct usb_dev_handle *udh,
const unsigned char *buf, int len);
// Write 24LC024 / 24LC025 EEPROM on motherboard or daughterboard.
// Which EEPROM is determined by i2c_addr. See i2c_addr.h
bool usrp_eeprom_write (struct usb_dev_handle *udh, int i2c_addr,
int eeprom_offset, const void *buf, int len);
// Read 24LC024 / 24LC025 EEPROM on motherboard or daughterboard.
// Which EEPROM is determined by i2c_addr. See i2c_addr.h
bool usrp_eeprom_read (struct usb_dev_handle *udh, int i2c_addr,
int eeprom_offset, void *buf, int len);
// Slot specific i/o routines
/*!
* \brief write to the specified aux dac.
*
* \p slot: which Tx or Rx slot to write.
* N.B., SLOT_TX_A and SLOT_RX_A share the same AUX DAC's
* SLOT_TX_B and SLOT_RX_B share the same AUX DAC's
*
* \p which_dac: [0,3] RX slots must use only 0 and 1.
* TX slots must use only 2 and 3.
*
* AUX DAC 3 is really the 9862 sigma delta output.
*
* \p value to write to aux dac. All dacs take straight
* binary values. Although dacs 0, 1 and 2 are 8-bit and dac 3 is 12-bit,
* the interface is in terms of 12-bit values [0,4095]
*/
bool usrp_write_aux_dac (struct usb_dev_handle *uhd, int slot,
int which_dac, int value);
/*!
* \brief Read the specified aux adc
*
* \p slot: which Tx or Rx slot to read aux dac
* \p which_adc: [0,1] which of the two adcs to read
* \p *value: return value, 12-bit straight binary.
*/
bool usrp_read_aux_adc (struct usb_dev_handle *udh, int slot,
int which_adc, int *value);
/*!
* \brief usrp daughterboard id to name mapping
*/
const std::string usrp_dbid_to_string (int dbid);
enum usrp_dbeeprom_status_t { UDBE_OK, UDBE_BAD_SLOT, UDBE_NO_EEPROM, UDBE_INVALID_EEPROM };
struct usrp_dboard_eeprom {
unsigned short id; // d'board identifier code
unsigned short oe; // fpga output enables:
// If bit set, i/o pin is an output from FPGA.
short offset[2]; // ADC/DAC offset correction
};
/*!
* \brief Read and return parsed daughterboard eeprom
*/
usrp_dbeeprom_status_t
usrp_read_dboard_eeprom (struct usb_dev_handle *udh,
int slot_id, usrp_dboard_eeprom *eeprom);
/*!
* \brief write ADC/DAC offset calibration constants to d'board eeprom
*/
bool usrp_write_dboard_offsets (struct usb_dev_handle *udh, int slot_id,
short offset0, short offset1);
/*!
* \brief return a usrp's serial number.
*
* Note that this only works on a configured usrp.
* \returns non-zero length string iff successful.
*/
std::string usrp_serial_number(struct usb_dev_handle *udh);
#endif /* _USRP_PRIMS_H_ */
|
