1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-only
2*4882a593Smuzhiyun /* cypress_firmware.c is part of the DVB USB library.
3*4882a593Smuzhiyun *
4*4882a593Smuzhiyun * Copyright (C) 2004-6 Patrick Boettcher (patrick.boettcher@posteo.de)
5*4882a593Smuzhiyun * see dvb-usb-init.c for copyright information.
6*4882a593Smuzhiyun *
7*4882a593Smuzhiyun * This file contains functions for downloading the firmware to Cypress FX 1
8*4882a593Smuzhiyun * and 2 based devices.
9*4882a593Smuzhiyun *
10*4882a593Smuzhiyun */
11*4882a593Smuzhiyun
12*4882a593Smuzhiyun #include <linux/module.h>
13*4882a593Smuzhiyun #include <linux/slab.h>
14*4882a593Smuzhiyun #include <linux/usb.h>
15*4882a593Smuzhiyun #include <linux/firmware.h>
16*4882a593Smuzhiyun #include "cypress_firmware.h"
17*4882a593Smuzhiyun
18*4882a593Smuzhiyun struct usb_cypress_controller {
19*4882a593Smuzhiyun u8 id;
20*4882a593Smuzhiyun const char *name; /* name of the usb controller */
21*4882a593Smuzhiyun u16 cs_reg; /* needs to be restarted,
22*4882a593Smuzhiyun * when the firmware has been downloaded */
23*4882a593Smuzhiyun };
24*4882a593Smuzhiyun
25*4882a593Smuzhiyun static const struct usb_cypress_controller cypress[] = {
26*4882a593Smuzhiyun { .id = CYPRESS_AN2135, .name = "Cypress AN2135", .cs_reg = 0x7f92 },
27*4882a593Smuzhiyun { .id = CYPRESS_AN2235, .name = "Cypress AN2235", .cs_reg = 0x7f92 },
28*4882a593Smuzhiyun { .id = CYPRESS_FX2, .name = "Cypress FX2", .cs_reg = 0xe600 },
29*4882a593Smuzhiyun };
30*4882a593Smuzhiyun
31*4882a593Smuzhiyun /*
32*4882a593Smuzhiyun * load a firmware packet to the device
33*4882a593Smuzhiyun */
usb_cypress_writemem(struct usb_device * udev,u16 addr,u8 * data,u8 len)34*4882a593Smuzhiyun static int usb_cypress_writemem(struct usb_device *udev, u16 addr, u8 *data,
35*4882a593Smuzhiyun u8 len)
36*4882a593Smuzhiyun {
37*4882a593Smuzhiyun return usb_control_msg(udev, usb_sndctrlpipe(udev, 0),
38*4882a593Smuzhiyun 0xa0, USB_TYPE_VENDOR, addr, 0x00, data, len, 5000);
39*4882a593Smuzhiyun }
40*4882a593Smuzhiyun
cypress_get_hexline(const struct firmware * fw,struct hexline * hx,int * pos)41*4882a593Smuzhiyun static int cypress_get_hexline(const struct firmware *fw,
42*4882a593Smuzhiyun struct hexline *hx, int *pos)
43*4882a593Smuzhiyun {
44*4882a593Smuzhiyun u8 *b = (u8 *) &fw->data[*pos];
45*4882a593Smuzhiyun int data_offs = 4;
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun if (*pos >= fw->size)
48*4882a593Smuzhiyun return 0;
49*4882a593Smuzhiyun
50*4882a593Smuzhiyun memset(hx, 0, sizeof(struct hexline));
51*4882a593Smuzhiyun hx->len = b[0];
52*4882a593Smuzhiyun
53*4882a593Smuzhiyun if ((*pos + hx->len + 4) >= fw->size)
54*4882a593Smuzhiyun return -EINVAL;
55*4882a593Smuzhiyun
56*4882a593Smuzhiyun hx->addr = b[1] | (b[2] << 8);
57*4882a593Smuzhiyun hx->type = b[3];
58*4882a593Smuzhiyun
59*4882a593Smuzhiyun if (hx->type == 0x04) {
60*4882a593Smuzhiyun /* b[4] and b[5] are the Extended linear address record data
61*4882a593Smuzhiyun * field */
62*4882a593Smuzhiyun hx->addr |= (b[4] << 24) | (b[5] << 16);
63*4882a593Smuzhiyun }
64*4882a593Smuzhiyun
65*4882a593Smuzhiyun memcpy(hx->data, &b[data_offs], hx->len);
66*4882a593Smuzhiyun hx->chk = b[hx->len + data_offs];
67*4882a593Smuzhiyun *pos += hx->len + 5;
68*4882a593Smuzhiyun
69*4882a593Smuzhiyun return *pos;
70*4882a593Smuzhiyun }
71*4882a593Smuzhiyun
cypress_load_firmware(struct usb_device * udev,const struct firmware * fw,int type)72*4882a593Smuzhiyun int cypress_load_firmware(struct usb_device *udev,
73*4882a593Smuzhiyun const struct firmware *fw, int type)
74*4882a593Smuzhiyun {
75*4882a593Smuzhiyun struct hexline *hx;
76*4882a593Smuzhiyun int ret, pos = 0;
77*4882a593Smuzhiyun
78*4882a593Smuzhiyun hx = kmalloc(sizeof(*hx), GFP_KERNEL);
79*4882a593Smuzhiyun if (!hx)
80*4882a593Smuzhiyun return -ENOMEM;
81*4882a593Smuzhiyun
82*4882a593Smuzhiyun /* stop the CPU */
83*4882a593Smuzhiyun hx->data[0] = 1;
84*4882a593Smuzhiyun ret = usb_cypress_writemem(udev, cypress[type].cs_reg, hx->data, 1);
85*4882a593Smuzhiyun if (ret != 1) {
86*4882a593Smuzhiyun dev_err(&udev->dev, "%s: CPU stop failed=%d\n",
87*4882a593Smuzhiyun KBUILD_MODNAME, ret);
88*4882a593Smuzhiyun ret = -EIO;
89*4882a593Smuzhiyun goto err_kfree;
90*4882a593Smuzhiyun }
91*4882a593Smuzhiyun
92*4882a593Smuzhiyun /* write firmware to memory */
93*4882a593Smuzhiyun for (;;) {
94*4882a593Smuzhiyun ret = cypress_get_hexline(fw, hx, &pos);
95*4882a593Smuzhiyun if (ret < 0)
96*4882a593Smuzhiyun goto err_kfree;
97*4882a593Smuzhiyun else if (ret == 0)
98*4882a593Smuzhiyun break;
99*4882a593Smuzhiyun
100*4882a593Smuzhiyun ret = usb_cypress_writemem(udev, hx->addr, hx->data, hx->len);
101*4882a593Smuzhiyun if (ret < 0) {
102*4882a593Smuzhiyun goto err_kfree;
103*4882a593Smuzhiyun } else if (ret != hx->len) {
104*4882a593Smuzhiyun dev_err(&udev->dev,
105*4882a593Smuzhiyun "%s: error while transferring firmware (transferred size=%d, block size=%d)\n",
106*4882a593Smuzhiyun KBUILD_MODNAME, ret, hx->len);
107*4882a593Smuzhiyun ret = -EIO;
108*4882a593Smuzhiyun goto err_kfree;
109*4882a593Smuzhiyun }
110*4882a593Smuzhiyun }
111*4882a593Smuzhiyun
112*4882a593Smuzhiyun /* start the CPU */
113*4882a593Smuzhiyun hx->data[0] = 0;
114*4882a593Smuzhiyun ret = usb_cypress_writemem(udev, cypress[type].cs_reg, hx->data, 1);
115*4882a593Smuzhiyun if (ret != 1) {
116*4882a593Smuzhiyun dev_err(&udev->dev, "%s: CPU start failed=%d\n",
117*4882a593Smuzhiyun KBUILD_MODNAME, ret);
118*4882a593Smuzhiyun ret = -EIO;
119*4882a593Smuzhiyun goto err_kfree;
120*4882a593Smuzhiyun }
121*4882a593Smuzhiyun
122*4882a593Smuzhiyun ret = 0;
123*4882a593Smuzhiyun err_kfree:
124*4882a593Smuzhiyun kfree(hx);
125*4882a593Smuzhiyun return ret;
126*4882a593Smuzhiyun }
127*4882a593Smuzhiyun EXPORT_SYMBOL(cypress_load_firmware);
128*4882a593Smuzhiyun
129*4882a593Smuzhiyun MODULE_AUTHOR("Antti Palosaari <crope@iki.fi>");
130*4882a593Smuzhiyun MODULE_DESCRIPTION("Cypress firmware download");
131*4882a593Smuzhiyun MODULE_LICENSE("GPL");
132