SDR (Software Defined Radio) » OsmoSDR

/*

 * Copyright (C) 2012 by Dimitri Stolnikov <horiz0n@gmx.net>

 * Copyright (C) 2012 by Steve Markgraf <steve@steve-m.de>

 *

 * This program 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 2 of the License, or

 * (at your option) any later version.

 *

 * This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

 */

#include <errno.h>

#include <signal.h>

#include <string.h>

#include <stdio.h>

#include <stdlib.h>

#include <math.h>

#ifndef _WIN32

#include <unistd.h>

#define min(a, b) (((a) < (b)) ? (a) : (b))

#endif

//cross platform usleep()

#ifdef _MSC_VER

#include <windows.h>

#define usleep(t) Sleep((t)/1000)

#else

#include <unistd.h>

#endif

#include <libusb.h>

/*

 * All libusb callback functions should be marked with the LIBUSB_CALL macro

 * to ensure that they are compiled with the same calling convention as libusb.

 *

 * If the macro isn't available in older libusb versions, we simply define it.

 */

#ifndef LIBUSB_CALL

#define LIBUSB_CALL

#endif

#include "osmosdr.h"

typedef struct osmosdr_tuner {

	/* tuner interface */

	int (*init)(void *);

	int (*exit)(void *);

	int (*set_freq)(void *, uint32_t freq /* Hz */);

	int (*set_bw)(void *, int bw /* Hz */);

	int (*set_gain)(void *, int gain /* dB */);

	int (*set_gain_mode)(void *, int manual);

} osmosdr_tuner_t;

enum osmosdr_async_status {

	OSMOSDR_INACTIVE = 0,

	OSMOSDR_CANCELING,

	OSMOSDR_RUNNING

};

struct osmosdr_dev {

	libusb_context *ctx;

	struct libusb_device_handle *devh;

	uint32_t xfer_buf_num;

	uint32_t xfer_buf_len;

	struct libusb_transfer **xfer;

	unsigned char **xfer_buf;

	osmosdr_read_async_cb_t cb;

	void *cb_ctx;

	enum osmosdr_async_status async_status;

	/* adc context */

	uint32_t rate; /* Hz */

	uint32_t adc_clock; /* Hz */

	/* tuner context */

	osmosdr_tuner_t *tuner;

	uint32_t freq; /* Hz */

	int gain; /* dB */

};

typedef struct osmosdr_dongle {

	uint16_t vid;

	uint16_t pid;

	const char *name;

} osmosdr_dongle_t;

static osmosdr_dongle_t known_devices[] = {

	{ 0x16c0, 0x0763, "sysmocom OsmoSDR" },

	/* here come future modifications of the OsmoSDR */

};

#define DEFAULT_BUF_NUMBER	32

#define DEFAULT_BUF_LENGTH	(16 * 32 * 512)

#define DEF_ADC_FREQ	4000000

#define CTRL_IN		(LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_IN)

#define CTRL_OUT	(LIBUSB_REQUEST_TYPE_VENDOR | LIBUSB_ENDPOINT_OUT)

#define FUNC(group, function) ((group << 8) | function)

#define CTRL_TIMEOUT	300

#define BULK_TIMEOUT	0

int e4k_init(void *dev) {

	osmosdr_dev_t* devt = (osmosdr_dev_t*)dev;

	int res;

	res = libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

				      FUNC(3, 0), 0,

				      NULL, 0, CTRL_TIMEOUT);

	return res; /* 0 is success since we do not send any buffers out */

}

int e4k_exit(void *dev) { return 0; }

int e4k_set_freq(void *dev, uint32_t freq) {

	osmosdr_dev_t* devt = (osmosdr_dev_t*)dev;

	uint8_t buffer[4];

	int res;

	buffer[0] = (uint8_t)(freq >> 24);

	buffer[1] = (uint8_t)(freq >> 16);

	buffer[2] = (uint8_t)(freq >> 8);

	buffer[3] = (uint8_t)(freq >> 0);

	res = libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

				      FUNC(3, 5), 0,

				      buffer, sizeof(buffer), CTRL_TIMEOUT);

	if (res == sizeof(buffer)) {

		res = libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

					      FUNC(3, 9), 0,

					      NULL, 0, CTRL_TIMEOUT);

	}

	return res;

}

int e4k_set_bw(void *dev, int bw) { return 0; }

int e4k_set_lna_gain(void *dev, int32_t gain) {

	osmosdr_dev_t* devt = (osmosdr_dev_t*)dev;

	uint8_t buffer[4];

	int res;

	buffer[0] = (uint8_t)(gain >> 24);

	buffer[1] = (uint8_t)(gain >> 16);

	buffer[2] = (uint8_t)(gain >> 8);

	buffer[3] = (uint8_t)(gain >> 0);

	res = libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

				      FUNC(3, 0x0b), 0,

				      buffer, sizeof(buffer), CTRL_TIMEOUT);

	if (res == sizeof(buffer))

		res = 0;

	return res;

}

int e4k_mixer_gain_set(void *dev, int8_t gain) {

	osmosdr_dev_t* devt = (osmosdr_dev_t*)dev;

	uint8_t buffer[1];

	int res;

	buffer[0] = gain;

	res = libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

				      FUNC(3, 0x03), 0,

				      buffer, sizeof(buffer), CTRL_TIMEOUT);

	if (res == sizeof(buffer))

		res = 0;

	return res;

}

int e4k_set_enh_gain(void *dev, int32_t gain) {

	osmosdr_dev_t* devt = (osmosdr_dev_t*)dev;

	uint8_t buffer[4];

	int res;

	buffer[0] = (uint8_t)(gain >> 24);

	buffer[1] = (uint8_t)(gain >> 16);

	buffer[2] = (uint8_t)(gain >> 8);

	buffer[3] = (uint8_t)(gain >> 0);

	res = libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

				      FUNC(3, 0x0d), 0,

				      buffer, sizeof(buffer), CTRL_TIMEOUT);

	if (res == sizeof(buffer))

		res = 0;

	return res;

}

int e4k_set_gain(void *dev, int gain) {

	int8_t mixgain = (gain > 340) ? 12 : 4;

#if 0

	int enhgain = (gain - 420);

#endif

	if(e4k_set_lna_gain(dev, min(300, gain - mixgain * 10)))

		return -1;

	if(e4k_mixer_gain_set(dev, mixgain))

		return -1;

#if 0 /* enhanced mixer gain seems to have no effect */

	if(enhgain >= 0)

		if(e4k_set_enh_gain(dev, enhgain))

			return -1;

#endif

	return 0;

}

int e4k_set_gain_mode(void *dev, int manual) {

	osmosdr_dev_t* devt = (osmosdr_dev_t*)dev;

	uint8_t buffer[1];

	int res;

	buffer[0] = (uint8_t)manual;

	res = libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

				      FUNC(3, 0x0c), 0,

				      buffer, sizeof(buffer), CTRL_TIMEOUT);

	if (res == sizeof(buffer))

		res = 0;

	return res;

}

static osmosdr_tuner_t tuner = {

	e4k_init, e4k_exit,

	e4k_set_freq,

	e4k_set_bw, e4k_set_gain, e4k_set_gain_mode

};

int osmosdr_get_usb_strings(osmosdr_dev_t *dev, char *manufact, char *product,

			    char *serial)

{

	struct libusb_device_descriptor dd;

	libusb_device *device = NULL;

	const int buf_max = 256;

	int r = 0;

	if (!dev || !dev->devh)

		return -1;

	device = libusb_get_device(dev->devh);

	r = libusb_get_device_descriptor(device, &dd);

	if (r < 0)

		return -1;

	if (manufact) {

		memset(manufact, 0, buf_max);

		libusb_get_string_descriptor_ascii(dev->devh, dd.iManufacturer,

						   (unsigned char *)manufact,

						   buf_max);

	}

	if (product) {

		memset(product, 0, buf_max);

		libusb_get_string_descriptor_ascii(dev->devh, dd.iProduct,

						   (unsigned char *)product,

						   buf_max);

	}

	if (serial) {

		memset(serial, 0, buf_max);

		libusb_get_string_descriptor_ascii(dev->devh, dd.iSerialNumber,

						   (unsigned char *)serial,

						   buf_max);

	}

	return 0;

}

int osmosdr_set_center_freq(osmosdr_dev_t *dev, uint32_t freq)

{

	int r = -2;

	if (!dev || !dev->tuner)

		return -1;

	if (dev->tuner->set_freq)

		r = dev->tuner->set_freq(dev, freq);

	if (!r)

		dev->freq = freq;

	else

		dev->freq = 0;

	return r;

}

uint32_t osmosdr_get_center_freq(osmosdr_dev_t *dev)

{

	if (!dev || !dev->tuner)

		return 0;

	return dev->freq;

}

int osmosdr_get_tuner_gains(osmosdr_dev_t *dev, int *gains)

{

	/* all gain values are expressed in tenths of a dB */

	const int e4k_gains[] = { -10, 15, 40, 65, 90, 115, 140, 165, 190, 215,

				  240, 290, 340, 420 };

	int len = sizeof(e4k_gains);

	if (!dev)

		return -1;

	if (!gains) { /* no buffer provided, just return the count */

		return len / sizeof(int);

	} else {

		if (len)

			memcpy(gains, e4k_gains, len);

		return len / sizeof(int);

	}

}

int osmosdr_set_tuner_gain(osmosdr_dev_t *dev, int gain)

{

	int r = -2;

	if (!dev || !dev->tuner)

		return -1;

	if (dev->tuner->set_gain)

		r = dev->tuner->set_gain((void *)dev, gain);

	if (!r)

		dev->gain = gain;

	else

		dev->gain = 0;

	return r;

}

int osmosdr_get_tuner_gain(osmosdr_dev_t *dev)

{

	if (!dev || !dev->tuner)

		return 0;

	return dev->gain;

}

int osmosdr_set_tuner_gain_mode(osmosdr_dev_t *dev, int mode)

{

	int r = -2;

	if (!dev || !dev->tuner)

		return -1;

	if (dev->tuner->set_gain_mode)

		r = dev->tuner->set_gain_mode((void *)dev, mode);

	return r;

}

int osmosdr_set_tuner_lna_gain(osmosdr_dev_t *dev, int gain)

{

	osmosdr_dev_t* devt = (osmosdr_dev_t*)dev;

	uint8_t buffer[4];

	buffer[0] = (gain >> 24);

	buffer[1] = (gain >> 16);

	buffer[2] = (gain >> 8);

	buffer[3] = (gain >> 0);

	return libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

				       FUNC(3, 0x0b), 0,

				       buffer, sizeof(buffer), CTRL_TIMEOUT);

}

int osmosdr_set_tuner_mixer_gain(osmosdr_dev_t *dev, int gain)

{

	osmosdr_dev_t* devt = (osmosdr_dev_t*)dev;

	uint8_t buffer[1];

	buffer[0] = gain / 10;

	return libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

				       FUNC(3, 0x03), 0,

				       buffer, sizeof(buffer), CTRL_TIMEOUT);

}

int osmosdr_set_tuner_mixer_enh(osmosdr_dev_t *dev, int enh)

{

	osmosdr_dev_t* devt = (osmosdr_dev_t*)dev;

	uint8_t buffer[4];

	buffer[0] = (enh >> 24);

	buffer[1] = (enh >> 16);

	buffer[2] = (enh >> 8);

	buffer[3] = (enh >> 0);

	return libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

				       FUNC(3, 0x0d), 0,

				       buffer, sizeof(buffer), CTRL_TIMEOUT);

}

int osmosdr_set_tuner_if_gain(osmosdr_dev_t *dev, int stage, int gain)

{

	osmosdr_dev_t* devt = (osmosdr_dev_t*)dev;

	uint8_t buffer[5];

	buffer[0] = stage;

	gain /= 10;

	buffer[1] = (gain >> 24);

	buffer[2] = (gain >> 16);

	buffer[3] = (gain >> 8);

	buffer[4] = (gain >> 0);

	return libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

				       FUNC(3, 0x02), 0,

				       buffer, sizeof(buffer), CTRL_TIMEOUT);

}

/* two raised to the power of n */

#define TWO_POW(n)		(1ULL<<(n))

uint32_t osmosdr_get_sample_rates(osmosdr_dev_t *dev, uint32_t *rates)

{

	int n;

	if (!dev)

		return -1;

	if (!rates) { /* no buffer provided, just return the count */

		return 5;

	} else {

		for (n = 6; n > 1; n--) /* 64 to 4 */

			*(rates++) = dev->adc_clock / TWO_POW(n);

		return 5;

	}

	return 0;

}

int osmosdr_set_sample_rate(osmosdr_dev_t *dev, uint32_t samp_rate)

{

	int n, decim = 3;

	int r = 0;

	unsigned int req_decim = 0;

	if (!dev)

		return -1;

	/* TODO: implement arbitrary rates by steering the master clock */

	req_decim = dev->adc_clock / samp_rate;

	for (n = 2; n <= 6; n++) { /* 4 to 64 */

		if (TWO_POW(n) == req_decim) {

			decim = n;

			break;

		}

	}

	samp_rate = dev->adc_clock / TWO_POW(decim);

	r = osmosdr_set_fpga_decimation(dev, decim);

	if (r >= 0) {

		if (dev->tuner && dev->tuner->set_bw)

			dev->tuner->set_bw(dev, samp_rate);

		dev->rate = samp_rate;

	} else {

		dev->rate = 0;

	}

	return r;

}

uint32_t osmosdr_get_sample_rate(osmosdr_dev_t *dev)

{

	if (!dev)

		return 0;

	return dev->rate;

}

int osmosdr_set_fpga_reg(osmosdr_dev_t *dev, uint8_t reg, uint32_t value)

{

	osmosdr_dev_t* devt = (osmosdr_dev_t*)dev;

	uint8_t buffer[5];

	buffer[0] = reg;

	buffer[1] = (uint8_t)(value >> 24);

	buffer[2] = (uint8_t)(value >> 16);

	buffer[3] = (uint8_t)(value >> 8);

	buffer[4] = (uint8_t)(value >> 0);

	return libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

				       FUNC(1, 0x01), 0,

				       buffer, sizeof(buffer), CTRL_TIMEOUT);

}

int osmosdr_set_fpga_decimation(osmosdr_dev_t *dev, int dec)

{

	osmosdr_dev_t* devt = (osmosdr_dev_t*)dev;

	uint8_t buffer[1];

	if((dec < 0) || (dec > 6))

		return -1;

	buffer[0] = dec;

	return libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

				       FUNC(1, 0x02), 0,

				       buffer, sizeof(buffer), CTRL_TIMEOUT);

}

int osmosdr_set_fpga_iq_swap(osmosdr_dev_t *dev, int sw)

{

	osmosdr_dev_t* devt = (osmosdr_dev_t*)dev;

	uint8_t buffer[1];

	if((sw < 0) || (sw > 1))

		return -1;

	buffer[0] = sw;

	return libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

				       FUNC(1, 0x03), 0,

				       buffer, sizeof(buffer), CTRL_TIMEOUT);

}

int osmosdr_set_fpga_iq_gain(osmosdr_dev_t *dev, uint16_t igain, uint16_t qgain)

{

	osmosdr_dev_t* devt = (osmosdr_dev_t*)dev;

	uint8_t buffer[4];

	buffer[0] = (uint8_t)(igain >> 8);

	buffer[1] = (uint8_t)(igain >> 0);

	buffer[2] = (uint8_t)(qgain >> 8);

	buffer[3] = (uint8_t)(qgain >> 0);

	return libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

				       FUNC(1, 0x04), 0,

				       buffer, sizeof(buffer), CTRL_TIMEOUT);

}

int osmosdr_set_fpga_iq_ofs(osmosdr_dev_t *dev, int16_t iofs, int16_t qofs)

{

	osmosdr_dev_t* devt = (osmosdr_dev_t*)dev;

	uint8_t buffer[4];

	buffer[0] = (uint8_t)(iofs >> 8);

	buffer[1] = (uint8_t)(iofs >> 0);

	buffer[2] = (uint8_t)(qofs >> 8);

	buffer[3] = (uint8_t)(qofs >> 0);

	return libusb_control_transfer(devt->devh, CTRL_OUT, 0x07,

				       FUNC(1, 0x05), 0,

				       buffer, sizeof(buffer), CTRL_TIMEOUT);

}

static osmosdr_dongle_t *find_known_device(uint16_t vid, uint16_t pid)

{

	unsigned int i;

	osmosdr_dongle_t *device = NULL;

	for (i = 0; i < sizeof(known_devices)/sizeof(osmosdr_dongle_t); i++ ) {

		if (known_devices[i].vid == vid && known_devices[i].pid == pid) {

			device = &known_devices[i];

			break;

		}

	}

	return device;

}

uint32_t osmosdr_get_device_count(void)

{

	int i;

	libusb_context *ctx;

	libusb_device **list;

	struct libusb_device_descriptor dd;

	uint32_t device_count = 0;

	ssize_t cnt;

	libusb_init(&ctx);

	cnt = libusb_get_device_list(ctx, &list);

	for (i = 0; i < cnt; i++) {

		libusb_get_device_descriptor(list[i], &dd);

		if (find_known_device(dd.idVendor, dd.idProduct))

			device_count++;

	}

	libusb_free_device_list(list, 1);

	libusb_exit(ctx);

	return device_count;

}

const char *osmosdr_get_device_name(uint32_t index)

{

	int i;

	libusb_context *ctx;

	libusb_device **list;

	struct libusb_device_descriptor dd;

	osmosdr_dongle_t *device = NULL;

	uint32_t device_count = 0;

	ssize_t cnt;

	libusb_init(&ctx);

	cnt = libusb_get_device_list(ctx, &list);

	for (i = 0; i < cnt; i++) {

		libusb_get_device_descriptor(list[i], &dd);

		device = find_known_device(dd.idVendor, dd.idProduct);

		if (device) {

			device_count++;

			if (index == device_count - 1)

				break;

			device = NULL;

		}

	}

	libusb_free_device_list(list, 1);

	libusb_exit(ctx);

	if (device)

		return device->name;

	else

		return "";

}

int osmosdr_get_device_usb_strings(uint32_t index, char *manufact,

				   char *product, char *serial)

{

	int r = -2;

	int i;

	libusb_context *ctx;

	libusb_device **list;

	struct libusb_device_descriptor dd;

	osmosdr_dev_t devt;

	uint32_t device_count = 0;

	ssize_t cnt;

	libusb_init(&ctx);

	cnt = libusb_get_device_list(ctx, &list);

	for (i = 0; i < cnt; i++) {

		libusb_get_device_descriptor(list[i], &dd);

		if (find_known_device(dd.idVendor, dd.idProduct))

			device_count++;

		if (index == device_count - 1) {

			r = libusb_open(list[i], &devt.devh);

			if (!r) {

				r = osmosdr_get_usb_strings(&devt,

							    manufact,

							    product,

							    serial);

				libusb_close(devt.devh);

			}

			break;

		}

	}

	libusb_free_device_list(list, 1);

	libusb_exit(ctx);

	return r;

}

int osmosdr_open(osmosdr_dev_t **out_dev, uint32_t index)

{

	int r;

	int i;

	libusb_device **list;

	osmosdr_dev_t *dev = NULL;

	libusb_device *device = NULL;

	uint32_t device_count = 0;

	struct libusb_device_descriptor dd;

	ssize_t cnt;

	dev = malloc(sizeof(osmosdr_dev_t));

	if (NULL == dev)

		return -ENOMEM;

	memset(dev, 0, sizeof(osmosdr_dev_t));

	libusb_init(&dev->ctx);

	cnt = libusb_get_device_list(dev->ctx, &list);

	for (i = 0; i < cnt; i++) {

		device = list[i];

		libusb_get_device_descriptor(list[i], &dd);

		if (find_known_device(dd.idVendor, dd.idProduct))

			device_count++;

		if (index == device_count - 1)

			break;

		device = NULL;

	}

	if (!device) {

		r = -1;

		goto err;

	}

	r = libusb_open(device, &dev->devh);

	if (r < 0) {

		libusb_free_device_list(list, 1);

		fprintf(stderr, "usb_open error %d\n", r);

		goto err;

	}

	libusb_free_device_list(list, 1);

	r = libusb_claim_interface(dev->devh, 0);

	if (r < 0) {

		fprintf(stderr, "usb_claim_interface error %d\n", r);

		goto err;

	}

	dev->adc_clock = DEF_ADC_FREQ;

	dev->tuner = &tuner; /* so far we have only one tuner */

	if (dev->tuner->init) {

		r = dev->tuner->init(dev);

	}

	*out_dev = dev;

	return 0;

err:

	if (dev) {

		if (dev->ctx)

			libusb_exit(dev->ctx);

		free(dev);

	}

	return r;

}

int osmosdr_close(osmosdr_dev_t *dev)

{

	if (!dev)

		return -1;

	/* block until all async operations have been completed (if any) */

	while (OSMOSDR_INACTIVE != dev->async_status)

		usleep(10);

	libusb_release_interface(dev->devh, 0);

	libusb_close(dev->devh);

	libusb_exit(dev->ctx);

	free(dev);

	return 0;

}

int osmosdr_reset_buffer(osmosdr_dev_t *dev)

{

	if (!dev)

		return -1;

	/* TODO: implement */

	return 0;

}

int osmosdr_read_sync(osmosdr_dev_t *dev, void *buf, int len, int *n_read)

{

	if (!dev)

		return -1;

	return libusb_bulk_transfer(dev->devh, 0x86, buf, len, n_read, BULK_TIMEOUT);

}

static void LIBUSB_CALL _libusb_callback(struct libusb_transfer *xfer)

{

	osmosdr_dev_t *dev = (osmosdr_dev_t *)xfer->user_data;

	if (LIBUSB_TRANSFER_COMPLETED == xfer->status) {

		if (dev->cb)

			dev->cb(xfer->buffer, xfer->actual_length, dev->cb_ctx);

		libusb_submit_transfer(xfer); /* resubmit transfer */

	} else if (LIBUSB_TRANSFER_CANCELLED == xfer->status) {

		/* nothing to do */

	} else {

		/*fprintf(stderr, "transfer status: %d\n", xfer->status);*/

	}

}

static int _osmosdr_alloc_async_buffers(osmosdr_dev_t *dev)

{

	unsigned int i;

	if (!dev)

		return -1;

	if (!dev->xfer) {

		dev->xfer = malloc(dev->xfer_buf_num *

				   sizeof(struct libusb_transfer *));

		for(i = 0; i < dev->xfer_buf_num; ++i)

			dev->xfer[i] = libusb_alloc_transfer(0);

	}

	if (!dev->xfer_buf) {

		dev->xfer_buf = malloc(dev->xfer_buf_num *

					   sizeof(unsigned char *));