Blame usx2yloader/usx2yloader.c

Packit Service b98cfc
/*
Packit Service b98cfc
 * FPGA loader for Tascam US-X2Y
Packit Service b98cfc
 *
Packit Service b98cfc
 * Copyright (c) 2003 by Karsten Wiese <annabellesgarden@yahoo.de>
Packit Service b98cfc
 *
Packit Service b98cfc
 *   This program is free software; you can redistribute it and/or modify
Packit Service b98cfc
 *   it under the terms of the GNU General Public License as published by
Packit Service b98cfc
 *   the Free Software Foundation; either version 2 of the License, or
Packit Service b98cfc
 *   (at your option) any later version.
Packit Service b98cfc
 *
Packit Service b98cfc
 *   This program is distributed in the hope that it will be useful,
Packit Service b98cfc
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit Service b98cfc
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Packit Service b98cfc
 *   GNU General Public License for more details.
Packit Service b98cfc
 *
Packit Service b98cfc
 *   You should have received a copy of the GNU General Public License
Packit Service b98cfc
 *   along with this program; if not, write to the Free Software
Packit Service b98cfc
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
Packit Service b98cfc
 */
Packit Service b98cfc
Packit Service b98cfc
#include <stdio.h>
Packit Service b98cfc
#include <stdlib.h>
Packit Service b98cfc
#include <string.h>
Packit Service b98cfc
#include <ctype.h>
Packit Service b98cfc
#include <getopt.h>
Packit Service b98cfc
#include <errno.h>
Packit Service b98cfc
#include <sys/types.h>
Packit Service b98cfc
#include <sys/stat.h>
Packit Service b98cfc
#include <assert.h>
Packit Service b98cfc
#include <unistd.h>
Packit Service b98cfc
#include <fcntl.h>
Packit Service b98cfc
#include <sys/ioctl.h>
Packit Service b98cfc
#include <stdarg.h>
Packit Service b98cfc
#include <alsa/asoundlib.h>
Packit Service b98cfc
Packit Service b98cfc
Packit Service b98cfc
#define PROGNAME		"usx2yloader"
Packit Service b98cfc
#define SND_USX2Y_LOADER_ID	"USX2Y Loader"
Packit Service b98cfc
Packit Service b98cfc
/* max. number of cards (shouldn't be in the public header?) */
Packit Service b98cfc
#define SND_CARDS	8
Packit Service b98cfc
Packit Service b98cfc
Packit Service b98cfc
static int verbose = 0;
Packit Service b98cfc
Packit Service b98cfc
static void usage(void)
Packit Service b98cfc
{
Packit Service b98cfc
	printf("FPGA loader for Tascam US-X2Y\n");
Packit Service b98cfc
	printf("version %s\n", VERSION);
Packit Service b98cfc
	printf("usage: usx2yloader [-c card] [-D device] [-u usb-device]\n");
Packit Service b98cfc
}
Packit Service b98cfc
Packit Service b98cfc
static void error(const char *fmt, ...)
Packit Service b98cfc
{
Packit Service b98cfc
	if (verbose) {
Packit Service b98cfc
		va_list ap;
Packit Service b98cfc
		va_start(ap, fmt);
Packit Service b98cfc
		fprintf(stderr, "%s: ", PROGNAME);
Packit Service b98cfc
		vfprintf(stderr, fmt, ap);
Packit Service b98cfc
		va_end(ap);
Packit Service b98cfc
	}
Packit Service b98cfc
}
Packit Service b98cfc
Packit Service b98cfc
Packit Service b98cfc
/*
Packit Service b98cfc
 * read a xilinx bitstream file.
Packit Service b98cfc
 * NOTE: This interprets somehow differently from the vxloaders read_xilinx_image()!
Packit Service b98cfc
 * I took this from rbtload.c of the project usb-midi-fw.sf.net.
Packit Service b98cfc
 */
Packit Service b98cfc
static int read_xilinx_image(snd_hwdep_dsp_image_t *img, const char *fname)
Packit Service b98cfc
{
Packit Service b98cfc
	FILE *fp;
Packit Service b98cfc
	char buf[256];
Packit Service b98cfc
	int data = 0, c = 0, idx = 0, length = 0;
Packit Service b98cfc
	char *p;
Packit Service b98cfc
	char *imgbuf = 0;
Packit Service b98cfc
Packit Service b98cfc
	if ((fp = fopen(fname, "r")) == NULL) {
Packit Service b98cfc
		fprintf(stderr, PROGNAME ": cannot open %s\n", fname);
Packit Service b98cfc
		return -EINVAL;
Packit Service b98cfc
	}
Packit Service b98cfc
	snd_hwdep_dsp_image_set_name(img, fname);
Packit Service b98cfc
Packit Service b98cfc
	while (fgets(buf, sizeof(buf), fp)) {
Packit Service b98cfc
		if (strncmp(buf, "Bits:", 5) == 0) {
Packit Service b98cfc
			for (p = buf + 5; *p && isspace(*p); p++);
Packit Service b98cfc
			if (!*p) {
Packit Service b98cfc
				fprintf(stderr,
Packit Service b98cfc
					PROGNAME
Packit Service b98cfc
					": corrupted file %s in Bits line\n",
Packit Service b98cfc
					fname);
Packit Service b98cfc
				fclose(fp);
Packit Service b98cfc
				return -EINVAL;
Packit Service b98cfc
			}
Packit Service b98cfc
			length = atoi(p);
Packit Service b98cfc
			length /= 8;
Packit Service b98cfc
			if (length <= 0) {
Packit Service b98cfc
				fprintf(stderr,
Packit Service b98cfc
					PROGNAME
Packit Service b98cfc
					": corrupted file %s, detected length = %d\n",
Packit Service b98cfc
					fname, length);
Packit Service b98cfc
				fclose(fp);
Packit Service b98cfc
				return -EINVAL;
Packit Service b98cfc
			}
Packit Service b98cfc
			imgbuf = malloc(length);
Packit Service b98cfc
			if (!imgbuf) {
Packit Service b98cfc
				fprintf(stderr,
Packit Service b98cfc
					PROGNAME
Packit Service b98cfc
					": cannot alloc %d bytes\n",
Packit Service b98cfc
					length);
Packit Service b98cfc
				fclose(fp);
Packit Service b98cfc
				return -ENOMEM;
Packit Service b98cfc
			}
Packit Service b98cfc
			continue;
Packit Service b98cfc
		}
Packit Service b98cfc
		if ((buf[0] != '0') && (buf[0] != '1')) {
Packit Service b98cfc
			//printf("line %d skipped\n", line);
Packit Service b98cfc
			continue;
Packit Service b98cfc
		}
Packit Service b98cfc
		if (length <= 0) {
Packit Service b98cfc
			fprintf(stderr,
Packit Service b98cfc
				PROGNAME
Packit Service b98cfc
				": corrupted file %s, starting without Bits line\n",
Packit Service b98cfc
				fname);
Packit Service b98cfc
			fclose(fp);
Packit Service b98cfc
			return -EINVAL;
Packit Service b98cfc
		}
Packit Service b98cfc
		//printf("\n idx=%d", idx);
Packit Service b98cfc
		for (p = buf; *p == '0' || *p == '1'; p++) {
Packit Service b98cfc
			data |= (*p - '0') << c;
Packit Service b98cfc
			c++;
Packit Service b98cfc
			if (c >= 8) {
Packit Service b98cfc
				//printf(" %02X", data);
Packit Service b98cfc
				imgbuf[idx++] = data;
Packit Service b98cfc
				data = c = 0;
Packit Service b98cfc
				if (idx > length)
Packit Service b98cfc
					break;
Packit Service b98cfc
			}
Packit Service b98cfc
		}
Packit Service b98cfc
	}
Packit Service b98cfc
	if (idx != length || 0 == imgbuf) {
Packit Service b98cfc
		fprintf(stderr, PROGNAME ": length doesn't match: %d != %d\n", idx, length);
Packit Service b98cfc
		fclose(fp);
Packit Service b98cfc
		return -EINVAL;
Packit Service b98cfc
	}
Packit Service b98cfc
	if (c)
Packit Service b98cfc
		imgbuf[idx++] = data;
Packit Service b98cfc
	snd_hwdep_dsp_image_set_length(img, length);
Packit Service b98cfc
	snd_hwdep_dsp_image_set_image(img, imgbuf);
Packit Service b98cfc
	fclose(fp);
Packit Service b98cfc
	return 0;
Packit Service b98cfc
}
Packit Service b98cfc
Packit Service b98cfc
Packit Service b98cfc
/*
Packit Service b98cfc
 * read a binary image file
Packit Service b98cfc
 */
Packit Service b98cfc
static int read_boot_image(snd_hwdep_dsp_image_t *img, const char *fname)
Packit Service b98cfc
{
Packit Service b98cfc
	struct stat st;
Packit Service b98cfc
	int fd, length;
Packit Service b98cfc
	unsigned char *imgbuf;
Packit Service b98cfc
Packit Service b98cfc
	snd_hwdep_dsp_image_set_name(img, fname);
Packit Service b98cfc
	if (stat(fname, &st) < 0) {
Packit Service b98cfc
		error("cannot call stat %s\n", fname);
Packit Service b98cfc
		return -ENODEV;
Packit Service b98cfc
	}
Packit Service b98cfc
	length = st.st_size;
Packit Service b98cfc
	if (length == 0) {
Packit Service b98cfc
		error("zero file size %s\n", fname);
Packit Service b98cfc
		return -EINVAL;
Packit Service b98cfc
	}
Packit Service b98cfc
Packit Service b98cfc
	imgbuf = malloc(st.st_size);
Packit Service b98cfc
	if (! imgbuf) {
Packit Service b98cfc
		error("cannot malloc %d bytes\n", length);
Packit Service b98cfc
		return -ENOMEM;
Packit Service b98cfc
	}
Packit Service b98cfc
	snd_hwdep_dsp_image_set_length(img, length);
Packit Service b98cfc
	snd_hwdep_dsp_image_set_image(img, imgbuf);
Packit Service b98cfc
Packit Service b98cfc
	fd = open(fname, O_RDONLY);
Packit Service b98cfc
	if (fd < 0) {
Packit Service b98cfc
		error("cannot open %s\n", fname);
Packit Service b98cfc
		return -ENODEV;
Packit Service b98cfc
	}
Packit Service b98cfc
	if (read(fd, imgbuf, length) != length) {
Packit Service b98cfc
		error("cannot read %d bytes from %s\n", length, fname);
Packit Service b98cfc
		close(fd);
Packit Service b98cfc
		return -EINVAL;
Packit Service b98cfc
	}
Packit Service b98cfc
Packit Service b98cfc
	close(fd);
Packit Service b98cfc
	return 0;
Packit Service b98cfc
}
Packit Service b98cfc
Packit Service b98cfc
Packit Service b98cfc
/*
Packit Service b98cfc
 * parse the index file and get the file to read from the key
Packit Service b98cfc
 */
Packit Service b98cfc
Packit Service b98cfc
#define MAX_PATH	128
Packit Service b98cfc
Packit Service b98cfc
static int get_file_name(const char *key, unsigned int idx, char *fname)
Packit Service b98cfc
{
Packit Service b98cfc
	FILE *fp;
Packit Service b98cfc
	char buf[128];
Packit Service b98cfc
	char temp[32], *p;
Packit Service b98cfc
	int len;
Packit Service b98cfc
Packit Service b98cfc
	snprintf(buf, sizeof(buf), "%s/%s.conf", DATAPATH, key);
Packit Service b98cfc
	if ((fp = fopen(buf, "r")) == NULL) {
Packit Service b98cfc
		error("cannot open the index file %s\n", buf);
Packit Service b98cfc
		return -ENODEV;
Packit Service b98cfc
	}
Packit Service b98cfc
Packit Service b98cfc
	sprintf(temp, "dsp%d", idx);
Packit Service b98cfc
	len = strlen(temp);
Packit Service b98cfc
Packit Service b98cfc
	while (fgets(buf, sizeof(buf), fp)) {
Packit Service b98cfc
		if (strncmp(buf, temp, len))
Packit Service b98cfc
			continue;
Packit Service b98cfc
Packit Service b98cfc
		for (p = buf + len; *p && isspace(*p); p++)
Packit Service b98cfc
			;
Packit Service b98cfc
		if (*p == '/') {
Packit Service b98cfc
			strncpy(fname, p, MAX_PATH);
Packit Service b98cfc
		} else {
Packit Service b98cfc
			snprintf(fname, MAX_PATH, "%s/%s", DATAPATH, p);
Packit Service b98cfc
		}
Packit Service b98cfc
		fname[MAX_PATH-1] = 0;
Packit Service b98cfc
		/* chop the last linefeed */
Packit Service b98cfc
		for (p = fname; *p && *p != '\n'; p++)
Packit Service b98cfc
			;
Packit Service b98cfc
		*p = 0;
Packit Service b98cfc
		fclose(fp);
Packit Service b98cfc
		return 0;
Packit Service b98cfc
	}
Packit Service b98cfc
	fclose(fp);
Packit Service b98cfc
	error("cannot find the file entry for %s\n", temp);
Packit Service b98cfc
	return -ENODEV;
Packit Service b98cfc
}
Packit Service b98cfc
Packit Service b98cfc
Packit Service b98cfc
/*
Packit Service b98cfc
 * read and transfer the firmware binary
Packit Service b98cfc
 */
Packit Service b98cfc
static int load_firmware(snd_hwdep_t *hw, const char *id, unsigned int idx)
Packit Service b98cfc
{
Packit Service b98cfc
	int			err, prepad;
Packit Service b98cfc
	char			fname[MAX_PATH];
Packit Service b98cfc
	snd_hwdep_dsp_image_t*	dsp;
Packit Service b98cfc
Packit Service b98cfc
	if ((prepad = get_file_name(id, idx, fname)) < 0)
Packit Service b98cfc
		return -EINVAL;
Packit Service b98cfc
Packit Service b98cfc
	snd_hwdep_dsp_image_alloca(&dsp;;
Packit Service b98cfc
	snd_hwdep_dsp_image_set_index(dsp, idx);
Packit Service b98cfc
	if (strcmp(fname + strlen(fname) - 4, ".rbt"))
Packit Service b98cfc
		err = read_boot_image(dsp, fname);
Packit Service b98cfc
	else
Packit Service b98cfc
		err = read_xilinx_image(dsp, fname);
Packit Service b98cfc
	if (err < 0)
Packit Service b98cfc
		return err;
Packit Service b98cfc
Packit Service b98cfc
	err = snd_hwdep_dsp_load(hw, dsp);
Packit Service b98cfc
	if (err < 0)
Packit Service b98cfc
		error("error in loading %s\n", fname);
Packit Service b98cfc
	return err;
Packit Service b98cfc
}
Packit Service b98cfc
Packit Service b98cfc
Packit Service b98cfc
/*
Packit Service b98cfc
 * check the name id of the given hwdep handle
Packit Service b98cfc
 */
Packit Service b98cfc
static int check_hwinfo(snd_hwdep_t *hw, const char *id, const char* usb_dev_name)
Packit Service b98cfc
{
Packit Service b98cfc
	snd_hwdep_info_t *info;
Packit Service b98cfc
	int err;
Packit Service b98cfc
Packit Service b98cfc
	snd_hwdep_info_alloca(&info;;
Packit Service b98cfc
	if ((err = snd_hwdep_info(hw, info)) < 0)
Packit Service b98cfc
		return err;
Packit Service b98cfc
	if (strcmp(snd_hwdep_info_get_id(info), id))
Packit Service b98cfc
		return -ENODEV;
Packit Service b98cfc
	if (usb_dev_name) 
Packit Service b98cfc
		if (strcmp(snd_hwdep_info_get_name(info), usb_dev_name))
Packit Service b98cfc
			return -ENODEV;
Packit Service b98cfc
Packit Service b98cfc
	return 0; /* ok */
Packit Service b98cfc
}
Packit Service b98cfc
Packit Service b98cfc
/*
Packit Service b98cfc
 * load the firmware binaries
Packit Service b98cfc
 */
Packit Service b98cfc
static int usx2y_boot(const char *devname)
Packit Service b98cfc
{
Packit Service b98cfc
	snd_hwdep_t *hw;
Packit Service b98cfc
	const char *id;
Packit Service b98cfc
	int err;
Packit Service b98cfc
	unsigned int idx, dsps, loaded;
Packit Service b98cfc
	snd_hwdep_dsp_status_t *stat;
Packit Service b98cfc
Packit Service b98cfc
	if ((err = snd_hwdep_open(&hw, devname, O_RDWR)) < 0) {
Packit Service b98cfc
		error("cannot open hwdep %s\n", devname);
Packit Service b98cfc
		return err;
Packit Service b98cfc
	}
Packit Service b98cfc
Packit Service b98cfc
	if (check_hwinfo(hw, SND_USX2Y_LOADER_ID, NULL) < 0) {
Packit Service b98cfc
		error("invalid hwdep %s\n", devname);
Packit Service b98cfc
		snd_hwdep_close(hw);
Packit Service b98cfc
		return -ENODEV;
Packit Service b98cfc
	}
Packit Service b98cfc
Packit Service b98cfc
	snd_hwdep_dsp_status_alloca(&stat;;
Packit Service b98cfc
	/* get the current status */
Packit Service b98cfc
	if ((err = snd_hwdep_dsp_status(hw, stat)) < 0) {
Packit Service b98cfc
		error("cannot get version for %s\n", devname);
Packit Service b98cfc
		snd_hwdep_close(hw);
Packit Service b98cfc
		return err;
Packit Service b98cfc
	}
Packit Service b98cfc
Packit Service b98cfc
	if (snd_hwdep_dsp_status_get_chip_ready(stat))
Packit Service b98cfc
		return 0; /* already loaded */
Packit Service b98cfc
Packit Service b98cfc
	id = snd_hwdep_dsp_status_get_id(stat);
Packit Service b98cfc
Packit Service b98cfc
	dsps = snd_hwdep_dsp_status_get_num_dsps(stat);
Packit Service b98cfc
	loaded = snd_hwdep_dsp_status_get_dsp_loaded(stat);
Packit Service b98cfc
Packit Service b98cfc
	for (idx = 0; idx < dsps; idx++) {
Packit Service b98cfc
		if (loaded & (1 << idx))
Packit Service b98cfc
			continue;
Packit Service b98cfc
		if ((err = load_firmware(hw, id, idx)) < 0) {
Packit Service b98cfc
			snd_hwdep_close(hw);
Packit Service b98cfc
			return err;
Packit Service b98cfc
		}
Packit Service b98cfc
	}
Packit Service b98cfc
Packit Service b98cfc
Packit Service b98cfc
	snd_hwdep_close(hw);
Packit Service b98cfc
	return 0;
Packit Service b98cfc
}
Packit Service b98cfc
Packit Service b98cfc
Packit Service b98cfc
int main(int argc, char **argv)
Packit Service b98cfc
{
Packit Service b98cfc
	int c;
Packit Service b98cfc
	int card = -1;
Packit Service b98cfc
	char	*device_name = NULL,
Packit Service b98cfc
		*usb_device_name = getenv("DEVICE");
Packit Service b98cfc
	char name[64];
Packit Service b98cfc
Packit Service b98cfc
	while ((c = getopt(argc, argv, "c:D:u:")) != -1) {
Packit Service b98cfc
		switch (c) {
Packit Service b98cfc
		case 'c':
Packit Service b98cfc
			card = atoi(optarg);
Packit Service b98cfc
			break;
Packit Service b98cfc
		case 'D':
Packit Service b98cfc
			device_name = optarg;
Packit Service b98cfc
			break;
Packit Service b98cfc
		case 'u':
Packit Service b98cfc
			usb_device_name = optarg;
Packit Service b98cfc
			break;
Packit Service b98cfc
		default:
Packit Service b98cfc
			usage();
Packit Service b98cfc
			return 1;
Packit Service b98cfc
		}
Packit Service b98cfc
	}
Packit Service b98cfc
Packit Service b98cfc
	if (usb_device_name) {
Packit Service b98cfc
		snd_hwdep_t *hw = NULL;
Packit Service b98cfc
		for (c = 0; c < SND_CARDS; c++) {
Packit Service b98cfc
			sprintf(name, "hw:%d", c);
Packit Service b98cfc
			if ((0 <= snd_hwdep_open(&hw, name, O_RDWR))
Packit Service b98cfc
			    && (0 <= check_hwinfo(hw, SND_USX2Y_LOADER_ID, usb_device_name))
Packit Service b98cfc
			    && (0 <= snd_hwdep_close(hw))){
Packit Service b98cfc
				card = c;
Packit Service b98cfc
				break;
Packit Service b98cfc
			}
Packit Service b98cfc
		}
Packit Service b98cfc
	}
Packit Service b98cfc
	if (device_name) {
Packit Service b98cfc
		verbose = 1;
Packit Service b98cfc
		return usx2y_boot(device_name) != 0;
Packit Service b98cfc
	}
Packit Service b98cfc
	if (card >= 0) {
Packit Service b98cfc
		sprintf(name, "hw:%d", card);
Packit Service b98cfc
		verbose = 1;
Packit Service b98cfc
		return usx2y_boot(name) != 0;
Packit Service b98cfc
	}
Packit Service b98cfc
Packit Service b98cfc
	/* probe the all cards */
Packit Service b98cfc
	for (c = 0; c < SND_CARDS; c++) {
Packit Service b98cfc
		sprintf(name, "hw:%d", c);
Packit Service b98cfc
		if (! usx2y_boot(name))
Packit Service b98cfc
			card = c;
Packit Service b98cfc
	}
Packit Service b98cfc
	if (card < 0) {
Packit Service b98cfc
		fprintf(stderr, PROGNAME ": no US-X2Y-compatible cards found\n");
Packit Service b98cfc
		return 1;
Packit Service b98cfc
	}
Packit Service b98cfc
	return 0;
Packit Service b98cfc
}