[media] dvb_usb_v2: Cypress firmware download module

Firmware handling routines for various Cypress chips.
Cypress AN2135
Cypress AN2235
Cypress FX2

These were split out from general DVB USB module by
Patrick Boettcher. I did only small changes.
Signed-off-by: Antti Palosaari <crope@iki.fi>
Signed-off-by: Mauro Carvalho Chehab <mchehab@redhat.com>

drivers/media/dvb/dvb-usb/Kconfig

@@ -28,6 +28,10 @@ config DVB_USB_V2
 
 	  Say Y if you own a USB DVB device.
 
+config DVB_USB_FIRMWARE
+	tristate "Firmware helper routines"
+	depends on DVB_USB
+
 config DVB_USB_DEBUG
 	bool "Enable extended debug support for all DVB-USB devices"
 	depends on DVB_USB

drivers/media/dvb/dvb-usb/Makefile

@@ -4,6 +4,8 @@ obj-$(CONFIG_DVB_USB) += dvb-usb.o
 dvb_usbv2-objs = dvb_usb_init.o dvb_usb_urb.o dvb_usb_dvb.o dvb_usb_remote.o usb_urb.o
 obj-$(CONFIG_DVB_USB_V2) += dvb_usbv2.o
 
+obj-$(CONFIG_DVB_USB_FIRMWARE) += dvb_usb_firmware.o
+
 dvb-usb-vp7045-objs = vp7045.o vp7045-fe.o
 obj-$(CONFIG_DVB_USB_VP7045) += dvb-usb-vp7045.o
 

drivers/media/dvb/dvb-usb/dvb_usb_firmware.c

+/* dvb_usb_firmware.c is part of the DVB USB library.
+ *
+ * Copyright (C) 2004-6 Patrick Boettcher (patrick.boettcher@desy.de)
+ * see dvb-usb-init.c for copyright information.
+ *
+ * This file contains functions for downloading the firmware to Cypress FX 1
+ * and 2 based devices.
+ *
+ */
+
+#include "dvb_usb.h"
+#include "dvb_usb_firmware.h"
+
+struct usb_cypress_controller {
+	u8 id;
+	const char *name;	/* name of the usb controller */
+	u16 cs_reg;		/* needs to be restarted,
+				 * when the firmware has been downloaded */
+};
+
+static const struct usb_cypress_controller cypress[] = {
+	{ .id = CYPRESS_AN2135, .name = "Cypress AN2135", .cs_reg = 0x7f92 },
+	{ .id = CYPRESS_AN2235, .name = "Cypress AN2235", .cs_reg = 0x7f92 },
+	{ .id = CYPRESS_FX2,    .name = "Cypress FX2",    .cs_reg = 0xe600 },
+};
+
+/*
+ * load a firmware packet to the device
+ */
+static int usb_cypress_writemem(struct usb_device *udev, u16 addr, u8 *data,
+		u8 len)
+{
+	return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
+			0xa0, USB_TYPE_VENDOR, addr, 0x00, data, len, 5000);
+}
+
+int usbv2_cypress_load_firmware(struct usb_device *udev,
+		const struct firmware *fw, int type)
+{
+	struct hexline hx;
+	u8 reset;
+	int ret, pos = 0;
+
+	/* stop the CPU */
+	reset = 1;
+	ret = usb_cypress_writemem(udev, cypress[type].cs_reg, &reset, 1);
+	if (ret != 1)
+		pr_err("%s: could not stop the USB controller CPU",
+				KBUILD_MODNAME);
+
+	while ((ret = dvb_usbv2_get_hexline(fw, &hx, &pos)) > 0) {
+		pr_debug("%s: writing to address %04x (buffer: %02x %02x)\n",
+				__func__, hx.addr, hx.len, hx.chk);
+
+		ret = usb_cypress_writemem(udev, hx.addr, hx.data, hx.len);
+		if (ret != hx.len) {
+			pr_err("%s: error while transferring firmware " \
+					"(transferred size=%d, block size=%d)",
+					KBUILD_MODNAME, ret, hx.len);
+			ret = -EINVAL;
+			break;
+		}
+	}
+	if (ret < 0) {
+		pr_err("%s: firmware download failed at %d with %d",
+				KBUILD_MODNAME, pos, ret);
+		return ret;
+	}
+
+	if (ret == 0) {
+		/* restart the CPU */
+		reset = 0;
+		if (ret || usb_cypress_writemem(
+				udev, cypress[type].cs_reg, &reset, 1) != 1) {
+			pr_err("%s: could not restart the USB controller CPU",
+					KBUILD_MODNAME);
+			ret = -EINVAL;
+		}
+	} else
+		ret = -EIO;
+
+	return ret;
+}
+EXPORT_SYMBOL(usbv2_cypress_load_firmware);
+
+int dvb_usbv2_get_hexline(const struct firmware *fw, struct hexline *hx,
+		int *pos)
+{
+	u8 *b = (u8 *) &fw->data[*pos];
+	int data_offs = 4;
+
+	if (*pos >= fw->size)
+		return 0;
+
+	memset(hx, 0, sizeof(struct hexline));
+
+	hx->len = b[0];
+
+	if ((*pos + hx->len + 4) >= fw->size)
+		return -EINVAL;
+
+	hx->addr = b[1] | (b[2] << 8);
+	hx->type = b[3];
+
+	if (hx->type == 0x04) {
+		/* b[4] and b[5] are the Extended linear address record data
+		 * field */
+		hx->addr |= (b[4] << 24) | (b[5] << 16);
+		/*
+		hx->len -= 2;
+		data_offs += 2;
+		*/
+	}
+	memcpy(hx->data, &b[data_offs], hx->len);
+	hx->chk = b[hx->len + data_offs];
+
+	*pos += hx->len + 5;
+
+	return *pos;
+}
+EXPORT_SYMBOL(dvb_usbv2_get_hexline);
+
+MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
+MODULE_DESCRIPTION("Cypress firmware download");
+MODULE_LICENSE("GPL");

drivers/media/dvb/dvb-usb/dvb_usb_firmware.h

+/* dvb_usb_firmware.c is part of the DVB USB library.
+ *
+ * Copyright (C) 2004-6 Patrick Boettcher (patrick.boettcher@desy.de)
+ * see dvb-usb-init.c for copyright information.
+ *
+ * This file contains functions for downloading the firmware to Cypress FX 1
+ * and 2 based devices.
+ *
+ */
+
+#ifndef DVB_USB_FIRMWARE_H
+#define DVB_USB_FIRMWARE_H
+
+#define CYPRESS_AN2135  0
+#define CYPRESS_AN2235  1
+#define CYPRESS_FX2     2
+
+/* commonly used firmware download types and function */
+struct hexline {
+	u8 len;
+	u32 addr;
+	u8 type;
+	u8 data[255];
+	u8 chk;
+};
+extern int usbv2_cypress_load_firmware(struct usb_device *,
+		const struct firmware *, int);
+extern int dvb_usbv2_get_hexline(const struct firmware *,
+		struct hexline *, int *);
+
+#endif