1/*
2 * This file is part of linux driver the digital TV devices equipped with B2C2 FlexcopII(b)/III
3 *
4 * flexcop-usb.c - covers the USB part.
5 *
6 * see flexcop.c for copyright information.
7 */
8
9#define FC_LOG_PREFIX "flexcop_usb"
10#include "flexcop-usb.h"
11#include "flexcop-common.h"
12
13/* Version information */
14#define DRIVER_VERSION "0.1"
15#define DRIVER_NAME "Technisat/B2C2 FlexCop II/IIb/III Digital TV USB Driver"
16#define DRIVER_AUTHOR "Patrick Boettcher <patrick.boettcher@desy.de>"
17
18/* debug */
19#ifdef CONFIG_DVB_B2C2_FLEXCOP_DEBUG
20#define dprintk(level,args...) \
21	    do { if ((debug & level)) { printk(args); } } while (0)
22#define debug_dump(b,l,method) {\
23	int i; \
24	for (i = 0; i < l; i++) method("%02x ", b[i]); \
25	method("\n");\
26}
27
28#define DEBSTATUS ""
29#else
30#define dprintk(level,args...)
31#define debug_dump(b,l,method)
32#define DEBSTATUS " (debugging is not enabled)"
33#endif
34
35static int debug;
36module_param(debug, int, 0644);
37MODULE_PARM_DESC(debug, "set debugging level (1=info,ts=2,ctrl=4,i2c=8,v8mem=16 (or-able))." DEBSTATUS);
38#undef DEBSTATUS
39
40#define deb_info(args...) dprintk(0x01,args)
41#define deb_ts(args...)   dprintk(0x02,args)
42#define deb_ctrl(args...) dprintk(0x04,args)
43#define deb_i2c(args...)  dprintk(0x08,args)
44#define deb_v8(args...)   dprintk(0x10,args)
45
46/* JLP 111700: we will include the 1 bit gap between the upper and lower 3 bits
47 * in the IBI address, to make the V8 code simpler.
48 * PCI ADDRESS FORMAT: 0x71C -> 0000 0111 0001 1100 (these are the six bits used)
49 *                  in general: 0000 0HHH 000L LL00
50 * IBI ADDRESS FORMAT:                    RHHH BLLL
51 *
52 * where R is the read(1)/write(0) bit, B is the busy bit
53 * and HHH and LLL are the two sets of three bits from the PCI address.
54 */
55#define B2C2_FLEX_PCIOFFSET_TO_INTERNALADDR(usPCI) (u8) (((usPCI >> 2) & 0x07) + ((usPCI >> 4) & 0x70))
56#define B2C2_FLEX_INTERNALADDR_TO_PCIOFFSET(ucAddr) (u16) (((ucAddr & 0x07) << 2) + ((ucAddr & 0x70) << 4))
57
58/*
59 * DKT 020228
60 * - forget about this VENDOR_BUFFER_SIZE, read and write register
61 *   deal with DWORD or 4 bytes, that should be should from now on
62 * - from now on, we don't support anything older than firm 1.00
63 *   I eliminated the write register as a 2 trip of writing hi word and lo word
64 *   and force this to write only 4 bytes at a time.
65 *   NOTE: this should work with all the firmware from 1.00 and newer
66 */
67static int flexcop_usb_readwrite_dw(struct flexcop_device *fc, u16 wRegOffsPCI, u32 *val, u8 read)
68{
69	struct flexcop_usb *fc_usb = fc->bus_specific;
70	u8 request = read ? B2C2_USB_READ_REG : B2C2_USB_WRITE_REG;
71	u8 request_type = (read ? USB_DIR_IN : USB_DIR_OUT) | USB_TYPE_VENDOR;
72	u8 wAddress = B2C2_FLEX_PCIOFFSET_TO_INTERNALADDR(wRegOffsPCI) | (read ? 0x80 : 0);
73
74	int len = usb_control_msg(fc_usb->udev,
75			read ? B2C2_USB_CTRL_PIPE_IN : B2C2_USB_CTRL_PIPE_OUT,
76			request,
77			request_type,  /* 0xc0 read or 0x40 write*/
78			wAddress,
79			0,
80			val,
81			sizeof(u32),
82			B2C2_WAIT_FOR_OPERATION_RDW * HZ);
83
84	if (len != sizeof(u32)) {
85		err("error while %s dword from %d (%d).",read ? "reading" : "writing",
86			wAddress,wRegOffsPCI);
87		return -EIO;
88	}
89	return 0;
90}
91
92/*
93 * DKT 010817 - add support for V8 memory read/write and flash update
94 */
95static int flexcop_usb_v8_memory_req(struct flexcop_usb *fc_usb,
96		flexcop_usb_request_t req, u8 page, u16 wAddress,
97		u8 *pbBuffer,u32 buflen)
98{
99//	u8 dwRequestType;
100	u8 request_type = USB_TYPE_VENDOR;
101	u16 wIndex;
102	int nWaitTime,pipe,len;
103
104	wIndex = page << 8;
105
106	switch (req) {
107		case B2C2_USB_READ_V8_MEM:
108			nWaitTime = B2C2_WAIT_FOR_OPERATION_V8READ;
109			request_type |= USB_DIR_IN;
110//			dwRequestType = (u8) RTYPE_READ_V8_MEMORY;
111			pipe = B2C2_USB_CTRL_PIPE_IN;
112		break;
113		case B2C2_USB_WRITE_V8_MEM:
114			wIndex |= pbBuffer[0];
115			request_type |= USB_DIR_OUT;
116			nWaitTime = B2C2_WAIT_FOR_OPERATION_V8WRITE;
117//			dwRequestType = (u8) RTYPE_WRITE_V8_MEMORY;
118			pipe = B2C2_USB_CTRL_PIPE_OUT;
119		break;
120		case B2C2_USB_FLASH_BLOCK:
121			request_type |= USB_DIR_OUT;
122			nWaitTime = B2C2_WAIT_FOR_OPERATION_V8FLASH;
123//			dwRequestType = (u8) RTYPE_WRITE_V8_FLASH;
124			pipe = B2C2_USB_CTRL_PIPE_OUT;
125		break;
126		default:
127			deb_info("unsupported request for v8_mem_req %x.\n",req);
128		return -EINVAL;
129	}
130	deb_v8("v8mem: %02x %02x %04x %04x, len: %d\n",request_type,req,
131			wAddress,wIndex,buflen);
132
133	len = usb_control_msg(fc_usb->udev,pipe,
134			req,
135			request_type,
136			wAddress,
137			wIndex,
138			pbBuffer,
139			buflen,
140			nWaitTime * HZ);
141
142	debug_dump(pbBuffer,len,deb_v8);
143
144	return len == buflen ? 0 : -EIO;
145}
146
147#define bytes_left_to_read_on_page(paddr,buflen) \
148			((V8_MEMORY_PAGE_SIZE - (paddr & V8_MEMORY_PAGE_MASK)) > buflen \
149			? buflen : (V8_MEMORY_PAGE_SIZE - (paddr & V8_MEMORY_PAGE_MASK)))
150
151static int flexcop_usb_memory_req(struct flexcop_usb *fc_usb,flexcop_usb_request_t req,
152		flexcop_usb_mem_page_t page_start, u32 addr, int extended, u8 *buf, u32 len)
153{
154	int i,ret = 0;
155	u16 wMax;
156	u32 pagechunk = 0;
157
158	switch(req) {
159		case B2C2_USB_READ_V8_MEM:  wMax = USB_MEM_READ_MAX; break;
160		case B2C2_USB_WRITE_V8_MEM:	wMax = USB_MEM_WRITE_MAX; break;
161		case B2C2_USB_FLASH_BLOCK:  wMax = USB_FLASH_MAX; break;
162		default:
163			return -EINVAL;
164		break;
165	}
166	for (i = 0; i < len;) {
167		pagechunk = wMax < bytes_left_to_read_on_page(addr,len) ? wMax : bytes_left_to_read_on_page(addr,len);
168		deb_info("%x\n",(addr & V8_MEMORY_PAGE_MASK) | (V8_MEMORY_EXTENDED*extended));
169		if ((ret = flexcop_usb_v8_memory_req(fc_usb,req,
170				page_start + (addr / V8_MEMORY_PAGE_SIZE), /* actual page */
171				(addr & V8_MEMORY_PAGE_MASK) | (V8_MEMORY_EXTENDED*extended),
172				&buf[i],pagechunk)) < 0)
173			return ret;
174
175		addr += pagechunk;
176		len -= pagechunk;
177	}
178	return 0;
179}
180
181static int flexcop_usb_get_mac_addr(struct flexcop_device *fc, int extended)
182{
183	return flexcop_usb_memory_req(fc->bus_specific,B2C2_USB_READ_V8_MEM,
184			V8_MEMORY_PAGE_FLASH,0x1f010,1,fc->dvb_adapter.proposed_mac,6);
185}
186
187
188/* usb i2c stuff */
189static int flexcop_usb_i2c_req(struct flexcop_usb *fc_usb,
190		flexcop_usb_request_t req, flexcop_usb_i2c_function_t func,
191		flexcop_i2c_port_t port, u8 chipaddr, u8 addr, u8 *buf, u8 buflen)
192{
193	u16 wValue, wIndex;
194	int nWaitTime,pipe,len;
195//	u8 dwRequestType;
196	u8 request_type = USB_TYPE_VENDOR;
197
198	switch (func) {
199		case USB_FUNC_I2C_WRITE:
200		case USB_FUNC_I2C_MULTIWRITE:
201		case USB_FUNC_I2C_REPEATWRITE:
202		/* DKT 020208 - add this to support special case of DiSEqC */
203		case USB_FUNC_I2C_CHECKWRITE:
204			pipe = B2C2_USB_CTRL_PIPE_OUT;
205			nWaitTime = 2;
206//			dwRequestType = (u8) RTYPE_GENERIC;
207			request_type |= USB_DIR_OUT;
208		break;
209		case USB_FUNC_I2C_READ:
210		case USB_FUNC_I2C_REPEATREAD:
211			pipe = B2C2_USB_CTRL_PIPE_IN;
212			nWaitTime = 2;
213//			dwRequestType = (u8) RTYPE_GENERIC;
214			request_type |= USB_DIR_IN;
215		break;
216		default:
217			deb_info("unsupported function for i2c_req %x\n",func);
218			return -EINVAL;
219	}
220	wValue = (func << 8 ) | (port << 4);
221	wIndex = (chipaddr << 8 ) | addr;
222
223	deb_i2c("i2c %2d: %02x %02x %02x %02x %02x %02x\n",func,request_type,req,
224		wValue & 0xff, wValue >> 8, wIndex & 0xff, wIndex >> 8);
225
226	len = usb_control_msg(fc_usb->udev,pipe,
227			req,
228			request_type,
229			wValue,
230			wIndex,
231			buf,
232			buflen,
233			nWaitTime * HZ);
234
235	return len == buflen ? 0 : -EREMOTEIO;
236}
237
238/* actual bus specific access functions, make sure prototype are/will be equal to pci */
239static flexcop_ibi_value flexcop_usb_read_ibi_reg(struct flexcop_device *fc, flexcop_ibi_register reg)
240{
241	flexcop_ibi_value val;
242	val.raw = 0;
243	flexcop_usb_readwrite_dw(fc,reg, &val.raw, 1);
244	return val;
245}
246
247static int flexcop_usb_write_ibi_reg(struct flexcop_device *fc, flexcop_ibi_register reg, flexcop_ibi_value val)
248{
249	return flexcop_usb_readwrite_dw(fc,reg, &val.raw, 0);
250}
251
252static int flexcop_usb_i2c_request(struct flexcop_device *fc, flexcop_access_op_t op,
253		flexcop_i2c_port_t port, u8 chipaddr, u8 addr, u8 *buf, u16 len)
254{
255	if (op == FC_READ)
256		return flexcop_usb_i2c_req(fc->bus_specific,B2C2_USB_I2C_REQUEST,USB_FUNC_I2C_READ,port,chipaddr,addr,buf,len);
257	else
258		return flexcop_usb_i2c_req(fc->bus_specific,B2C2_USB_I2C_REQUEST,USB_FUNC_I2C_WRITE,port,chipaddr,addr,buf,len);
259}
260
261static void flexcop_usb_process_frame(struct flexcop_usb *fc_usb, u8 *buffer, int buffer_length)
262{
263	u8 *b;
264	int l;
265
266	deb_ts("tmp_buffer_length=%d, buffer_length=%d\n", fc_usb->tmp_buffer_length, buffer_length);
267
268	if (fc_usb->tmp_buffer_length > 0) {
269		memcpy(fc_usb->tmp_buffer+fc_usb->tmp_buffer_length, buffer, buffer_length);
270		fc_usb->tmp_buffer_length += buffer_length;
271		b = fc_usb->tmp_buffer;
272		l = fc_usb->tmp_buffer_length;
273	} else {
274		b=buffer;
275		l=buffer_length;
276	}
277
278	while (l >= 190) {
279		if (*b == 0xff)
280			switch (*(b+1) & 0x03) {
281				case 0x01: /* media packet */
282					if ( *(b+2) == 0x47 )
283						flexcop_pass_dmx_packets(fc_usb->fc_dev, b+2, 1);
284					else
285						deb_ts("not ts packet %02x %02x %02x %02x \n", *(b+2), *(b+3), *(b+4), *(b+5) );
286
287					b += 190;
288					l -= 190;
289				break;
290				default:
291					deb_ts("wrong packet type\n");
292					l = 0;
293				break;
294			}
295		else {
296			deb_ts("wrong header\n");
297			l = 0;
298		}
299	}
300
301	if (l>0)
302		memcpy(fc_usb->tmp_buffer, b, l);
303	fc_usb->tmp_buffer_length = l;
304}
305
306static void flexcop_usb_urb_complete(struct urb *urb)
307{
308	struct flexcop_usb *fc_usb = urb->context;
309	int i;
310
311	if (urb->actual_length > 0)
312		deb_ts("urb completed, bufsize: %d actlen; %d\n",urb->transfer_buffer_length, urb->actual_length);
313
314	for (i = 0; i < urb->number_of_packets; i++) {
315		if (urb->iso_frame_desc[i].status < 0) {
316			err("iso frame descriptor %d has an error: %d\n",i,urb->iso_frame_desc[i].status);
317		} else
318			if (urb->iso_frame_desc[i].actual_length > 0) {
319				deb_ts("passed %d bytes to the demux\n",urb->iso_frame_desc[i].actual_length);
320
321				flexcop_usb_process_frame(fc_usb,
322					urb->transfer_buffer + urb->iso_frame_desc[i].offset,
323					urb->iso_frame_desc[i].actual_length);
324		}
325		urb->iso_frame_desc[i].status = 0;
326		urb->iso_frame_desc[i].actual_length = 0;
327	}
328
329	usb_submit_urb(urb,GFP_ATOMIC);
330}
331
332static int flexcop_usb_stream_control(struct flexcop_device *fc, int onoff)
333{
334	/* submit/kill iso packets */
335	return 0;
336}
337
338static void flexcop_usb_transfer_exit(struct flexcop_usb *fc_usb)
339{
340	int i;
341	for (i = 0; i < B2C2_USB_NUM_ISO_URB; i++)
342		if (fc_usb->iso_urb[i] != NULL) {
343			deb_ts("unlinking/killing urb no. %d\n",i);
344			usb_kill_urb(fc_usb->iso_urb[i]);
345			usb_free_urb(fc_usb->iso_urb[i]);
346		}
347
348	if (fc_usb->iso_buffer != NULL)
349		pci_free_consistent(NULL,fc_usb->buffer_size, fc_usb->iso_buffer, fc_usb->dma_addr);
350}
351
352static int flexcop_usb_transfer_init(struct flexcop_usb *fc_usb)
353{
354	u16 frame_size = fc_usb->uintf->cur_altsetting->endpoint[0].desc.wMaxPacketSize;
355	int bufsize = B2C2_USB_NUM_ISO_URB * B2C2_USB_FRAMES_PER_ISO * frame_size,i,j,ret;
356	int buffer_offset = 0;
357
358	deb_ts("creating %d iso-urbs with %d frames each of %d bytes size = %d.\n",
359			B2C2_USB_NUM_ISO_URB, B2C2_USB_FRAMES_PER_ISO, frame_size,bufsize);
360
361	fc_usb->iso_buffer = pci_alloc_consistent(NULL,bufsize,&fc_usb->dma_addr);
362	if (fc_usb->iso_buffer == NULL)
363		return -ENOMEM;
364	memset(fc_usb->iso_buffer, 0, bufsize);
365	fc_usb->buffer_size = bufsize;
366
367	/* creating iso urbs */
368	for (i = 0; i < B2C2_USB_NUM_ISO_URB; i++)
369		if (!(fc_usb->iso_urb[i] = usb_alloc_urb(B2C2_USB_FRAMES_PER_ISO,GFP_ATOMIC))) {
370			ret = -ENOMEM;
371			goto urb_error;
372		}
373	/* initialising and submitting iso urbs */
374	for (i = 0; i < B2C2_USB_NUM_ISO_URB; i++) {
375		int frame_offset = 0;
376		struct urb *urb = fc_usb->iso_urb[i];
377		deb_ts("initializing and submitting urb no. %d (buf_offset: %d).\n",i,buffer_offset);
378
379		urb->dev = fc_usb->udev;
380		urb->context = fc_usb;
381		urb->complete = flexcop_usb_urb_complete;
382		urb->pipe = B2C2_USB_DATA_PIPE;
383		urb->transfer_flags = URB_ISO_ASAP;
384		urb->interval = 1;
385		urb->number_of_packets = B2C2_USB_FRAMES_PER_ISO;
386		urb->transfer_buffer_length = frame_size * B2C2_USB_FRAMES_PER_ISO;
387		urb->transfer_buffer = fc_usb->iso_buffer + buffer_offset;
388
389		buffer_offset += frame_size * B2C2_USB_FRAMES_PER_ISO;
390		for (j = 0; j < B2C2_USB_FRAMES_PER_ISO; j++) {
391			deb_ts("urb no: %d, frame: %d, frame_offset: %d\n",i,j,frame_offset);
392			urb->iso_frame_desc[j].offset = frame_offset;
393			urb->iso_frame_desc[j].length = frame_size;
394			frame_offset += frame_size;
395		}
396
397		if ((ret = usb_submit_urb(fc_usb->iso_urb[i],GFP_ATOMIC))) {
398			err("submitting urb %d failed with %d.",i,ret);
399			goto urb_error;
400		}
401		deb_ts("submitted urb no. %d.\n",i);
402	}
403
404/* SRAM */
405
406	flexcop_sram_set_dest(fc_usb->fc_dev,FC_SRAM_DEST_MEDIA | FC_SRAM_DEST_NET |
407			FC_SRAM_DEST_CAO | FC_SRAM_DEST_CAI, FC_SRAM_DEST_TARGET_WAN_USB);
408	flexcop_wan_set_speed(fc_usb->fc_dev,FC_WAN_SPEED_8MBITS);
409	flexcop_sram_ctrl(fc_usb->fc_dev,1,1,1);
410
411	return 0;
412
413urb_error:
414	flexcop_usb_transfer_exit(fc_usb);
415	return ret;
416}
417
418static int flexcop_usb_init(struct flexcop_usb *fc_usb)
419{
420	/* use the alternate setting with the larges buffer */
421	usb_set_interface(fc_usb->udev,0,1);
422	switch (fc_usb->udev->speed) {
423		case USB_SPEED_LOW:
424			err("cannot handle USB speed because it is to sLOW.");
425			return -ENODEV;
426			break;
427		case USB_SPEED_FULL:
428			info("running at FULL speed.");
429			break;
430		case USB_SPEED_HIGH:
431			info("running at HIGH speed.");
432			break;
433		case USB_SPEED_UNKNOWN: /* fall through */
434		default:
435			err("cannot handle USB speed because it is unkown.");
436			return -ENODEV;
437	}
438	usb_set_intfdata(fc_usb->uintf, fc_usb);
439	return 0;
440}
441
442static void flexcop_usb_exit(struct flexcop_usb *fc_usb)
443{
444	usb_set_intfdata(fc_usb->uintf, NULL);
445}
446
447static int flexcop_usb_probe(struct usb_interface *intf,
448		const struct usb_device_id *id)
449{
450	struct usb_device *udev = interface_to_usbdev(intf);
451	struct flexcop_usb *fc_usb = NULL;
452	struct flexcop_device *fc = NULL;
453	int ret;
454
455	if ((fc = flexcop_device_kmalloc(sizeof(struct flexcop_usb))) == NULL) {
456		err("out of memory\n");
457		return -ENOMEM;
458	}
459
460/* general flexcop init */
461	fc_usb = fc->bus_specific;
462	fc_usb->fc_dev = fc;
463
464	fc->read_ibi_reg  = flexcop_usb_read_ibi_reg;
465	fc->write_ibi_reg = flexcop_usb_write_ibi_reg;
466	fc->i2c_request = flexcop_usb_i2c_request;
467	fc->get_mac_addr = flexcop_usb_get_mac_addr;
468
469	fc->stream_control = flexcop_usb_stream_control;
470
471	fc->pid_filtering = 1;
472	fc->bus_type = FC_USB;
473
474	fc->dev = &udev->dev;
475	fc->owner = THIS_MODULE;
476
477/* bus specific part */
478	fc_usb->udev = udev;
479	fc_usb->uintf = intf;
480	if ((ret = flexcop_usb_init(fc_usb)) != 0)
481		goto err_kfree;
482
483/* init flexcop */
484	if ((ret = flexcop_device_initialize(fc)) != 0)
485		goto err_usb_exit;
486
487/* xfer init */
488	if ((ret = flexcop_usb_transfer_init(fc_usb)) != 0)
489		goto err_fc_exit;
490
491	info("%s successfully initialized and connected.",DRIVER_NAME);
492	return 0;
493
494err_fc_exit:
495	flexcop_device_exit(fc);
496err_usb_exit:
497	flexcop_usb_exit(fc_usb);
498err_kfree:
499	flexcop_device_kfree(fc);
500	return ret;
501}
502
503static void flexcop_usb_disconnect(struct usb_interface *intf)
504{
505	struct flexcop_usb *fc_usb = usb_get_intfdata(intf);
506	flexcop_usb_transfer_exit(fc_usb);
507	flexcop_device_exit(fc_usb->fc_dev);
508	flexcop_usb_exit(fc_usb);
509	flexcop_device_kfree(fc_usb->fc_dev);
510	info("%s successfully deinitialized and disconnected.",DRIVER_NAME);
511}
512
513static struct usb_device_id flexcop_usb_table [] = {
514	    { USB_DEVICE(0x0af7, 0x0101) },
515	    { }
516};
517MODULE_DEVICE_TABLE (usb, flexcop_usb_table);
518
519/* usb specific object needed to register this driver with the usb subsystem */
520static struct usb_driver flexcop_usb_driver = {
521	.name		= "b2c2_flexcop_usb",
522	.probe		= flexcop_usb_probe,
523	.disconnect = flexcop_usb_disconnect,
524	.id_table	= flexcop_usb_table,
525};
526
527/* module stuff */
528static int __init flexcop_usb_module_init(void)
529{
530	int result;
531	if ((result = usb_register(&flexcop_usb_driver))) {
532		err("usb_register failed. (%d)",result);
533		return result;
534	}
535
536	return 0;
537}
538
539static void __exit flexcop_usb_module_exit(void)
540{
541	/* deregister this driver from the USB subsystem */
542	usb_deregister(&flexcop_usb_driver);
543}
544
545module_init(flexcop_usb_module_init);
546module_exit(flexcop_usb_module_exit);
547
548MODULE_AUTHOR(DRIVER_AUTHOR);
549MODULE_DESCRIPTION(DRIVER_NAME);
550MODULE_LICENSE("GPL");
551