^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) // SPDX-License-Identifier: GPL-2.0
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /* dvb-usb-firmware.c is part of the DVB USB library.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * Copyright (C) 2004-6 Patrick Boettcher (patrick.boettcher@posteo.de)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) * see dvb-usb-init.c for copyright information.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * This file contains functions for downloading the firmware to Cypress FX 1 and 2 based devices.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) * FIXME: This part does actually not belong to dvb-usb, but to the usb-subsystem.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #include "dvb-usb-common.h"
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13) #include <linux/usb.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) struct usb_cypress_controller {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) int id;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) const char *name; /* name of the usb controller */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18) u16 cpu_cs_register; /* needs to be restarted, when the firmware has been downloaded. */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) static struct usb_cypress_controller cypress[] = {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) { .id = DEVICE_SPECIFIC, .name = "Device specific", .cpu_cs_register = 0 },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) { .id = CYPRESS_AN2135, .name = "Cypress AN2135", .cpu_cs_register = 0x7f92 },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) { .id = CYPRESS_AN2235, .name = "Cypress AN2235", .cpu_cs_register = 0x7f92 },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) { .id = CYPRESS_FX2, .name = "Cypress FX2", .cpu_cs_register = 0xe600 },
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) * load a firmware packet to the device
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) static int usb_cypress_writemem(struct usb_device *udev,u16 addr,u8 *data, u8 len)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) return usb_control_msg(udev, usb_sndctrlpipe(udev,0),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) 0xa0, USB_TYPE_VENDOR, addr, 0x00, data, len, 5000);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) int usb_cypress_load_firmware(struct usb_device *udev, const struct firmware *fw, int type)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) struct hexline *hx;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) u8 *buf;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) int ret, pos = 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) u16 cpu_cs_register = cypress[type].cpu_cs_register;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) buf = kmalloc(sizeof(*hx), GFP_KERNEL);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) if (!buf)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46) return -ENOMEM;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) hx = (struct hexline *)buf;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) /* stop the CPU */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) buf[0] = 1;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) if (usb_cypress_writemem(udev, cpu_cs_register, buf, 1) != 1)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) err("could not stop the USB controller CPU.");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54) while ((ret = dvb_usb_get_hexline(fw, hx, &pos)) > 0) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) deb_fw("writing to address 0x%04x (buffer: 0x%02x %02x)\n", hx->addr, hx->len, hx->chk);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) ret = usb_cypress_writemem(udev, hx->addr, hx->data, hx->len);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58) if (ret != hx->len) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) err("error while transferring firmware (transferred size: %d, block size: %d)",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) ret, hx->len);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) ret = -EINVAL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) if (ret < 0) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) err("firmware download failed at %d with %d",pos,ret);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) kfree(buf);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) if (ret == 0) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) /* restart the CPU */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) buf[0] = 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) if (usb_cypress_writemem(udev, cpu_cs_register, buf, 1) != 1) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) err("could not restart the USB controller CPU.");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) ret = -EINVAL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) } else
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) ret = -EIO;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) kfree(buf);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) EXPORT_SYMBOL(usb_cypress_load_firmware);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) int dvb_usb_download_firmware(struct usb_device *udev,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88) const struct dvb_usb_device_properties *props)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) int ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) const struct firmware *fw = NULL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) if ((ret = request_firmware(&fw, props->firmware, &udev->dev)) != 0) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) err("did not find the firmware file '%s' (status %d). You can use <kernel_dir>/scripts/get_dvb_firmware to get the firmware",
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95) props->firmware,ret);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) info("downloading firmware from file '%s'",props->firmware);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) switch (props->usb_ctrl) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) case CYPRESS_AN2135:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103) case CYPRESS_AN2235:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) case CYPRESS_FX2:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) ret = usb_cypress_load_firmware(udev, fw, props->usb_ctrl);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) case DEVICE_SPECIFIC:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) if (props->download_firmware)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109) ret = props->download_firmware(udev,fw);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) else {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) err("BUG: driver didn't specified a download_firmware-callback, although it claims to have a DEVICE_SPECIFIC one.");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) ret = -EINVAL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) default:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) ret = -EINVAL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) break;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) release_firmware(fw);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) return ret;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) int dvb_usb_get_hexline(const struct firmware *fw, struct hexline *hx,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) int *pos)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) u8 *b = (u8 *) &fw->data[*pos];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) int data_offs = 4;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129) if (*pos >= fw->size)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) return 0;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) memset(hx,0,sizeof(struct hexline));
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) hx->len = b[0];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) if ((*pos + hx->len + 4) >= fw->size)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) return -EINVAL;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) hx->addr = b[1] | (b[2] << 8);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) hx->type = b[3];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) if (hx->type == 0x04) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) /* b[4] and b[5] are the Extended linear address record data field */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) hx->addr |= (b[4] << 24) | (b[5] << 16);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) /* hx->len -= 2;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) data_offs += 2; */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) memcpy(hx->data,&b[data_offs],hx->len);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) hx->chk = b[hx->len + data_offs];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) *pos += hx->len + 5;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) return *pos;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) EXPORT_SYMBOL(dvb_usb_get_hexline);