CTC++ Coverage Report - Execution Profile    #708/1532

Files Summary | Functions Summary | Execution Profile | Index | No Index
First | Previous | Next | Last

File: drivers/usb/misc/legousbtower.c
Instrumentation mode: function-decision-multicondition
TER: 0 % ( 0/431)

Start/	End/
True	False	-	Line	Source
			1	/*
			2	* LEGO USB Tower driver
			3	*
			4	* Copyright (C) 2003 David Glance <davidgsf@sourceforge.net>
			5	*               2001-2004 Juergen Stuber <starblue@users.sourceforge.net>
			6	*
			7	*   This program is free software; you can redistribute it and/or
			8	*   modify it under the terms of the GNU General Public License as
			9	*   published by the Free Software Foundation; either version 2 of
			10	*   the License, or (at your option) any later version.
			11	*
			12	* derived from USB Skeleton driver - 0.5
			13	* Copyright (C) 2001 Greg Kroah-Hartman (greg@kroah.com)
			14	*
			15	* History:
			16	*
			17	* 2001-10-13 - 0.1 js
			18	*   - first version
			19	* 2001-11-03 - 0.2 js
			20	*   - simplified buffering, one-shot URBs for writing
			21	* 2001-11-10 - 0.3 js
			22	*   - removed IOCTL (setting power/mode is more complicated, postponed)
			23	* 2001-11-28 - 0.4 js
			24	*   - added vendor commands for mode of operation and power level in open
			25	* 2001-12-04 - 0.5 js
			26	*   - set IR mode by default (by oversight 0.4 set VLL mode)
			27	* 2002-01-11 - 0.5? pcchan
			28	*   - make read buffer reusable and work around bytes_to_write issue between
			29	*     uhci and legusbtower
			30	* 2002-09-23 - 0.52 david (david@csse.uwa.edu.au)
			31	*   - imported into lejos project
			32	*   - changed wake_up to wake_up_interruptible
			33	*   - changed to use lego0 rather than tower0
			34	*   - changed dbg() to use __func__ rather than deprecated __FUNCTION__
			35	* 2003-01-12 - 0.53 david (david@csse.uwa.edu.au)
			36	*   - changed read and write to write everything or
			37	*     timeout (from a patch by Chris Riesen and Brett Thaeler driver)
			38	*   - added ioctl functionality to set timeouts
			39	* 2003-07-18 - 0.54 davidgsf (david@csse.uwa.edu.au)
			40	*   - initial import into LegoUSB project
			41	*   - merge of existing LegoUSB.c driver
			42	* 2003-07-18 - 0.56 davidgsf (david@csse.uwa.edu.au)
			43	*   - port to 2.6 style driver
			44	* 2004-02-29 - 0.6 Juergen Stuber <starblue@users.sourceforge.net>
			45	*   - fix locking
			46	*   - unlink read URBs which are no longer needed
			47	*   - allow increased buffer size, eliminates need for timeout on write
			48	*   - have read URB running continuously
			49	*   - added poll
			50	*   - forbid seeking
			51	*   - added nonblocking I/O
			52	*   - changed back __func__ to __FUNCTION__
			53	*   - read and log tower firmware version
			54	*   - reset tower on probe, avoids failure of first write
			55	* 2004-03-09 - 0.7 Juergen Stuber <starblue@users.sourceforge.net>
			56	*   - timeout read now only after inactivity, shorten default accordingly
			57	* 2004-03-11 - 0.8 Juergen Stuber <starblue@users.sourceforge.net>
			58	*   - log major, minor instead of possibly confusing device filename
			59	*   - whitespace cleanup
			60	* 2004-03-12 - 0.9 Juergen Stuber <starblue@users.sourceforge.net>
			61	*   - normalize whitespace in debug messages
			62	*   - take care about endianness in control message responses
			63	* 2004-03-13 - 0.91 Juergen Stuber <starblue@users.sourceforge.net>
			64	*   - make default intervals longer to accommodate current EHCI driver
			65	* 2004-03-19 - 0.92 Juergen Stuber <starblue@users.sourceforge.net>
			66	*   - replaced atomic_t by memory barriers
			67	* 2004-04-21 - 0.93 Juergen Stuber <starblue@users.sourceforge.net>
			68	*   - wait for completion of write urb in release (needed for remotecontrol)
			69	*   - corrected poll for write direction (missing negation)
			70	* 2004-04-22 - 0.94 Juergen Stuber <starblue@users.sourceforge.net>
			71	*   - make device locking interruptible
			72	* 2004-04-30 - 0.95 Juergen Stuber <starblue@users.sourceforge.net>
			73	*   - check for valid udev on resubmitting and unlinking urbs
			74	* 2004-08-03 - 0.96 Juergen Stuber <starblue@users.sourceforge.net>
			75	*   - move reset into open to clean out spurious data
			76	*/
			77
			78	#include <linux/config.h>
			79	#include <linux/kernel.h>
			80	#include <linux/errno.h>
			81	#include <linux/init.h>
			82	#include <linux/slab.h>
			83	#include <linux/module.h>
			84	#include <linux/smp_lock.h>
			85	#include <linux/completion.h>
			86	#include <asm/uaccess.h>
			87	#include <linux/usb.h>
			88	#include <linux/poll.h>
			89
			90
			91	#ifdef CONFIG_USB_DEBUG
			92	static int debug = 4;
			93	#else
			94	static int debug = 0;
			95	#endif
			96
			97	/* Use our own dbg macro */
			98	#undef dbg
			99	#define dbg(lvl, format, arg...) do { if (debug >= lvl) printk(KERN_DEBUG  __FILE__ ": " format "\n", ## arg); } while (0)
			100
			101
			102	/* Version Information */
			103	#define DRIVER_VERSION "v0.96"
			104	#define DRIVER_AUTHOR "Juergen Stuber <starblue@sourceforge.net>"
			105	#define DRIVER_DESC "LEGO USB Tower Driver"
			106
			107	/* Module parameters */
0	0	-	108	module_param(debug, int, S_IRUGO | S_IWUSR);
0		-	108	return ( & ( debug ) )
			109	MODULE_PARM_DESC(debug, "Debug enabled or not");
			110
			111	/* The defaults are chosen to work with the latest versions of leJOS and NQC.
			112	*/
			113
			114	/* Some legacy software likes to receive packets in one piece.
			115	* In this case read_buffer_size should exceed the maximal packet length
			116	* (417 for datalog uploads), and packet_timeout should be set.
			117	*/
			118	static int read_buffer_size = 480;
0	0	-	119	module_param(read_buffer_size, int, 0);
0		-	119	return ( & ( read_buffer_size ) )
			120	MODULE_PARM_DESC(read_buffer_size, "Read buffer size");
			121
			122	/* Some legacy software likes to send packets in one piece.
			123	* In this case write_buffer_size should exceed the maximal packet length
			124	* (417 for firmware and program downloads).
			125	* A problem with long writes is that the following read may time out
			126	* if the software is not prepared to wait long enough.
			127	*/
			128	static int write_buffer_size = 480;
0	0	-	129	module_param(write_buffer_size, int, 0);
0		-	129	return ( & ( write_buffer_size ) )
			130	MODULE_PARM_DESC(write_buffer_size, "Write buffer size");
			131
			132	/* Some legacy software expects reads to contain whole LASM packets.
			133	* To achieve this, characters which arrive before a packet timeout
			134	* occurs will be returned in a single read operation.
			135	* A problem with long reads is that the software may time out
			136	* if it is not prepared to wait long enough.
			137	* The packet timeout should be greater than the time between the
			138	* reception of subsequent characters, which should arrive about
			139	* every 5ms for the standard 2400 baud.
			140	* Set it to 0 to disable.
			141	*/
			142	static int packet_timeout = 50;
0	0	-	143	module_param(packet_timeout, int, 0);
0		-	143	return ( & ( packet_timeout ) )
			144	MODULE_PARM_DESC(packet_timeout, "Packet timeout in ms");
			145
			146	/* Some legacy software expects blocking reads to time out.
			147	* Timeout occurs after the specified time of read and write inactivity.
			148	* Set it to 0 to disable.
			149	*/
			150	static int read_timeout = 200;
0	0	-	151	module_param(read_timeout, int, 0);
0		-	151	return ( & ( read_timeout ) )
			152	MODULE_PARM_DESC(read_timeout, "Read timeout in ms");
			153
			154	/* As of kernel version 2.6.4 ehci-hcd uses an
			155	* "only one interrupt transfer per frame" shortcut
			156	* to simplify the scheduling of periodic transfers.
			157	* This conflicts with our standard 1ms intervals for in and out URBs.
			158	* We use default intervals of 2ms for in and 8ms for out transfers,
			159	* which is fast enough for 2400 baud and allows a small additional load.
			160	* Increase the interval to allow more devices that do interrupt transfers,
			161	* or set to 0 to use the standard interval from the endpoint descriptors.
			162	*/
			163	static int interrupt_in_interval = 2;
0	0	-	164	module_param(interrupt_in_interval, int, 0);
0		-	164	return ( & ( interrupt_in_interval ) )
			165	MODULE_PARM_DESC(interrupt_in_interval, "Interrupt in interval in ms");
			166
			167	static int interrupt_out_interval = 8;
0	0	-	168	module_param(interrupt_out_interval, int, 0);
0		-	168	return ( & ( interrupt_out_interval ) )
			169	MODULE_PARM_DESC(interrupt_out_interval, "Interrupt out interval in ms");
			170
			171	/* Define these values to match your device */
			172	#define LEGO_USB_TOWER_VENDOR_ID   0x0694
			173	#define LEGO_USB_TOWER_PRODUCT_ID   0x0001
			174
			175	/* Vendor requests */
			176	#define LEGO_USB_TOWER_REQUEST_RESET      0x04
			177	#define LEGO_USB_TOWER_REQUEST_GET_VERSION   0xFD
			178
			179	struct tower_reset_reply {
			180	__le16 size;      /* little-endian */
			181	__u8 err_code;
			182	__u8 spare;
			183	} __attribute__ ((packed));
			184
			185	struct tower_get_version_reply {
			186	__le16 size;      /* little-endian */
			187	__u8 err_code;
			188	__u8 spare;
			189	__u8 major;
			190	__u8 minor;
			191	__le16 build_no;      /* little-endian */
			192	} __attribute__ ((packed));
			193
			194
			195	/* table of devices that work with this driver */
			196	static struct usb_device_id tower_table [] = {
			197	{ USB_DEVICE(LEGO_USB_TOWER_VENDOR_ID, LEGO_USB_TOWER_PRODUCT_ID) },
			198	{ }               /* Terminating entry */
			199	};
			200
			201	MODULE_DEVICE_TABLE (usb, tower_table);
			202
			203	#define LEGO_USB_TOWER_MINOR_BASE   160
			204
			205
			206	/* Structure to hold all of our device specific stuff */
			207	struct lego_usb_tower {
			208	struct semaphore   sem;      /* locks this structure */
			209	struct usb_device*   udev;      /* save off the usb device pointer */
			210	unsigned char      minor;      /* the starting minor number for this device */
			211
			212	int         open_count;   /* number of times this port has been opened */
			213
			214	char*         read_buffer;
			215	size_t         read_buffer_length; /* this much came in */
			216	size_t         read_packet_length; /* this much will be returned on read */
			217	spinlock_t      read_buffer_lock;
			218	int         packet_timeout_jiffies;
			219	unsigned long      read_last_arrival;
			220
			221	wait_queue_head_t   read_wait;
			222	wait_queue_head_t   write_wait;
			223
			224	char*         interrupt_in_buffer;
			225	struct usb_endpoint_descriptor* interrupt_in_endpoint;
			226	struct urb*      interrupt_in_urb;
			227	int         interrupt_in_interval;
			228	int         interrupt_in_running;
			229	int         interrupt_in_done;
			230
			231	char*         interrupt_out_buffer;
			232	struct usb_endpoint_descriptor* interrupt_out_endpoint;
			233	struct urb*      interrupt_out_urb;
			234	int         interrupt_out_interval;
			235	int         interrupt_out_busy;
			236
			237	};
			238
			239
			240	/* local function prototypes */
			241	static ssize_t tower_read   (struct file *file, char __user *buffer, size_t count, loff_t *ppos);
			242	static ssize_t tower_write   (struct file *file, const char __user *buffer, size_t count, loff_t *ppos);
			243	static inline void tower_delete (struct lego_usb_tower *dev);
			244	static int tower_open      (struct inode *inode, struct file *file);
			245	static int tower_release   (struct inode *inode, struct file *file);
			246	static unsigned int tower_poll   (struct file *file, poll_table *wait);
			247	static loff_t tower_llseek   (struct file *file, loff_t off, int whence);
			248
			249	static void tower_abort_transfers (struct lego_usb_tower *dev);
			250	static void tower_check_for_read_packet (struct lego_usb_tower *dev);
			251	static void tower_interrupt_in_callback (struct urb *urb, struct pt_regs *regs);
			252	static void tower_interrupt_out_callback (struct urb *urb, struct pt_regs *regs);
			253
			254	static int  tower_probe   (struct usb_interface *interface, const struct usb_device_id *id);
			255	static void tower_disconnect   (struct usb_interface *interface);
			256
			257
			258	/* prevent races between open() and disconnect */
			259	static DECLARE_MUTEX (disconnect_sem);
			260
			261	/* file operations needed when we register this driver */
			262	static struct file_operations tower_fops = {
			263	.owner =   THIS_MODULE,
			264	.read  =   tower_read,
			265	.write =   tower_write,
			266	.open =      tower_open,
			267	.release =   tower_release,
			268	.poll =      tower_poll,
			269	.llseek =   tower_llseek,
			270	};
			271
			272	/*
			273	* usb class driver info in order to get a minor number from the usb core,
			274	* and to have the device registered with the driver core
			275	*/
			276	static struct usb_class_driver tower_class = {
			277	.name =      "legousbtower%d",
			278	.fops =      &tower_fops,
			279	.minor_base =   LEGO_USB_TOWER_MINOR_BASE,
			280	};
			281
			282
			283	/* usb specific object needed to register this driver with the usb subsystem */
			284	static struct usb_driver tower_driver = {
			285	.name =      "legousbtower",
			286	.probe =   tower_probe,
			287	.disconnect =   tower_disconnect,
			288	.id_table =   tower_table,
			289	};
			290
			291
			292	/**
			293	*   lego_usb_tower_debug_data
			294	*/
0	0	-	295	static inline void lego_usb_tower_debug_data (int level, const char *function, int size, const unsigned char *data)
			296	{
			297	int i;
			298
0	0	-	299	if (debug < level)
0		-	300	return;
			301
			302	printk (KERN_DEBUG __FILE__": %s - length = %d, data = ", function, size);
0	0	-	303	for (i = 0; i < size; ++i) {
			304	printk ("%.2x ", data[i]);
			305	}
			306	printk ("\n");
			307	}
			308
			309
			310	/**
			311	*   tower_delete
			312	*/
0	0	-	313	static inline void tower_delete (struct lego_usb_tower *dev)
			314	{
			315	dbg(2, "%s: enter", __FUNCTION__);
0	0	-	315	if (debug >= 2)
0	0	-	315	do-while (0)
			316
			317	tower_abort_transfers (dev);
			318
			319	/* free data structures */
0	0	-	320	if (dev->interrupt_in_urb != NULL) {
			321	usb_free_urb (dev->interrupt_in_urb);
			322	}
0	0	-	323	if (dev->interrupt_out_urb != NULL) {
			324	usb_free_urb (dev->interrupt_out_urb);
			325	}
			326	kfree (dev->read_buffer);
			327	kfree (dev->interrupt_in_buffer);
			328	kfree (dev->interrupt_out_buffer);
			329	kfree (dev);
			330
			331	dbg(2, "%s: leave", __FUNCTION__);
0	0	-	331	if (debug >= 2)
0	0	-	331	do-while (0)
			332	}
			333
			334
			335	/**
			336	*   tower_open
			337	*/
0	0	-	338	static int tower_open (struct inode *inode, struct file *file)
			339	{
			340	struct lego_usb_tower *dev = NULL;
			341	int subminor;
			342	int retval = 0;
			343	struct usb_interface *interface;
			344	struct tower_reset_reply reset_reply;
			345	int result;
			346
			347	dbg(2, "%s: enter", __FUNCTION__);
0	0	-	347	if (debug >= 2)
0	0	-	347	do-while (0)
			348
			349	nonseekable_open(inode, file);
			350	subminor = iminor(inode);
			351
			352	down (&disconnect_sem);
			353
			354	interface = usb_find_interface (&tower_driver, subminor);
			355
0	0	-	356	if (!interface) {
			357	err ("%s - error, can't find device for minor %d",
			358	__FUNCTION__, subminor);
			359	retval = -ENODEV;
0		-	360	goto unlock_disconnect_exit;
			361	}
			362
			363	dev = usb_get_intfdata(interface);
			364
0	0	-	365	if (!dev) {
			366	retval = -ENODEV;
0		-	367	goto unlock_disconnect_exit;
			368	}
			369
			370	/* lock this device */
0	0	-	371	if (down_interruptible (&dev->sem)) {
			372	retval = -ERESTARTSYS;
0		-	373	goto unlock_disconnect_exit;
			374	}
			375
			376	/* allow opening only once */
0	0	-	377	if (dev->open_count) {
			378	retval = -EBUSY;
0		-	379	goto unlock_exit;
			380	}
			381	dev->open_count = 1;
			382
			383	/* reset the tower */
			384	result = usb_control_msg (dev->udev,
			385	usb_rcvctrlpipe(dev->udev, 0),
			386	LEGO_USB_TOWER_REQUEST_RESET,
			387	USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
			388	0,
			389	0,
			390	&reset_reply,
			391	sizeof(reset_reply),
			392	1000);
0	0	-	393	if (result < 0) {
			394	err("LEGO USB Tower reset control request failed");
			395	retval = result;
0		-	396	goto unlock_exit;
			397	}
			398
			399	/* initialize in direction */
			400	dev->read_buffer_length = 0;
			401	dev->read_packet_length = 0;
			402	usb_fill_int_urb (dev->interrupt_in_urb,
			403	dev->udev,
			404	usb_rcvintpipe(dev->udev, dev->interrupt_in_endpoint->bEndpointAddress),
			405	dev->interrupt_in_buffer,
			406	le16_to_cpu(dev->interrupt_in_endpoint->wMaxPacketSize),
			407	tower_interrupt_in_callback,
			408	dev,
			409	dev->interrupt_in_interval);
			410
			411	dev->interrupt_in_running = 1;
			412	dev->interrupt_in_done = 0;
			413	mb();
			414
			415	retval = usb_submit_urb (dev->interrupt_in_urb, GFP_KERNEL);
0	0	-	416	if (retval) {
			417	err("Couldn't submit interrupt_in_urb %d", retval);
			418	dev->interrupt_in_running = 0;
			419	dev->open_count = 0;
0		-	420	goto unlock_exit;
			421	}
			422
			423	/* save device in the file's private structure */
			424	file->private_data = dev;
			425
			426	unlock_exit:
			427	up (&dev->sem);
			428
			429	unlock_disconnect_exit:
			430	up (&disconnect_sem);
			431
			432	dbg(2, "%s: leave, return value %d ", __FUNCTION__, retval);
0	0	-	432	if (debug >= 2)
0	0	-	432	do-while (0)
			433
0		-	434	return retval;
			435	}
			436
			437	/**
			438	*   tower_release
			439	*/
0	0	-	440	static int tower_release (struct inode *inode, struct file *file)
			441	{
			442	struct lego_usb_tower *dev;
			443	int retval = 0;
			444
			445	dbg(2, "%s: enter", __FUNCTION__);
0	0	-	445	if (debug >= 2)
0	0	-	445	do-while (0)
			446
			447	dev = (struct lego_usb_tower *)file->private_data;
			448
0	0	-	449	if (dev == NULL) {
			450	dbg(1, "%s: object is NULL", __FUNCTION__);
0	0	-	450	if (debug >= 1)
0	0	-	450	do-while (0)
			451	retval = -ENODEV;
0		-	452	goto exit;
			453	}
			454
0	0	-	455	if (down_interruptible (&dev->sem)) {
			456	retval = -ERESTARTSYS;
0		-	457	goto exit;
			458	}
			459
0	0	-	460	if (dev->open_count != 1) {
			461	dbg(1, "%s: device not opened exactly once", __FUNCTION__);
0	0	-	461	if (debug >= 1)
0	0	-	461	do-while (0)
			462	retval = -ENODEV;
0		-	463	goto unlock_exit;
			464	}
0	0	-	465	if (dev->udev == NULL) {
			466	/* the device was unplugged before the file was released */
			467	up (&dev->sem);   /* unlock here as tower_delete frees dev */
			468	tower_delete (dev);
0		-	469	goto exit;
			470	}
			471
			472	/* wait until write transfer is finished */
0	0	-	473	if (dev->interrupt_out_busy) {
			474	wait_event_interruptible_timeout (dev->write_wait, !dev->interrupt_out_busy, 2 * HZ);
			475	}
			476	tower_abort_transfers (dev);
			477	dev->open_count = 0;
			478
			479	unlock_exit:
			480	up (&dev->sem);
			481
			482	exit:
			483	dbg(2, "%s: leave, return value %d", __FUNCTION__, retval);
0	0	-	483	if (debug >= 2)
0	0	-	483	do-while (0)
0		-	484	return retval;
			485	}
			486
			487
			488	/**
			489	*   tower_abort_transfers
			490	*      aborts transfers and frees associated data structures
			491	*/
0	0	-	492	static void tower_abort_transfers (struct lego_usb_tower *dev)
			493	{
			494	dbg(2, "%s: enter", __FUNCTION__);
0	0	-	494	if (debug >= 2)
0	0	-	494	do-while (0)
			495
0	0	-	496	if (dev == NULL) {
			497	dbg(1, "%s: dev is null", __FUNCTION__);
0	0	-	497	if (debug >= 1)
0	0	-	497	do-while (0)
0		-	498	goto exit;
			499	}
			500
			501	/* shutdown transfer */
0	0	-	502	if (dev->interrupt_in_running) {
			503	dev->interrupt_in_running = 0;
			504	mb();
0	0	-	505	if (dev->interrupt_in_urb != NULL && dev->udev) {
0		-	505	T && T
	0	-	505	T && F
	0	-	505	F && _
			506	usb_kill_urb (dev->interrupt_in_urb);
			507	}
			508	}
0	0	-	509	if (dev->interrupt_out_busy) {
0	0	-	510	if (dev->interrupt_out_urb != NULL && dev->udev) {
0		-	510	T && T
	0	-	510	T && F
	0	-	510	F && _
			511	usb_kill_urb (dev->interrupt_out_urb);
			512	}
			513	}
			514
			515	exit:
			516	dbg(2, "%s: leave", __FUNCTION__);
0	0	-	516	if (debug >= 2)
0	0	-	516	do-while (0)
			517	}
			518
			519
			520	/**
			521	*   tower_check_for_read_packet
			&nbs