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