Device-LabJack

 view release on metacpan or  search on metacpan

linux-labjack/driver/linux-2.6/labjack.c  view on Meta::CPAN

MODULE_PARM_DESC(debug, "Debug enabled or not");

static size_t read_buffer_size = 480;
MODULE_PARM(read_buffer_size, "i");
MODULE_PARM_DESC(read_buffer_size, "Read buffer size");

static size_t write_buffer_size = 480;
MODULE_PARM(write_buffer_size, "i");
MODULE_PARM_DESC(write_buffer_size, "Write buffer size");

static int packet_timeout = 0;
MODULE_PARM(packet_timeout, "i");
MODULE_PARM_DESC(packet_timeout, "Packet timeout in ms");

static int read_timeout = 1000;
MODULE_PARM(read_timeout, "i");
MODULE_PARM_DESC(read_timeout, "Read timeout in ms");

static int interrupt_in_interval = 0;
MODULE_PARM(interrupt_in_interval, "i");
MODULE_PARM_DESC(interrupt_in_interval, "Interrupt in interval in ms");

static int interrupt_out_interval = 0;
MODULE_PARM(interrupt_out_interval, "i");
MODULE_PARM_DESC(interrupt_out_interval, "Interrupt out interval in ms");


#define LABJACK_USB_VENDOR_ID	0x0cd5
#define LABJACK_USB_PRODUCT_ID	0x0001


static struct usb_device_id labjack_table [] = {
	{ USB_DEVICE(LABJACK_USB_VENDOR_ID, LABJACK_USB_PRODUCT_ID) },
	{ }
};

MODULE_DEVICE_TABLE (usb, labjack_table);


/* :TODO: Get a minor range for your devices from the usb maintainer */
#define LABJACK_USB_MINOR_BASE	0xf0

struct labjack_usb {
	struct semaphore	sem;		/* locks this structure */
	struct usb_device* 	udev;		/* save off the usb device pointer */
	unsigned char		minor;		/* the starting minor number for this device */

	int			open_count;	/* number of times this port has been opened */

	char*			read_buffer;
        size_t                  read_buffer_length; /* this much came in */
        size_t                  read_packet_length; /* this much will be returned on read */
        spinlock_t              read_buffer_lock;
        int                     packet_timeout_jiffies;
        unsigned long           read_last_arrival;

	wait_queue_head_t	read_wait;
	wait_queue_head_t	write_wait;

	char*			interrupt_in_buffer;
	struct usb_endpoint_descriptor* interrupt_in_endpoint;
	struct urb*		interrupt_in_urb;
        int                     interrupt_in_interval;
        int                     interrupt_in_running;
        int                     interrupt_in_done;

	char*			interrupt_out_buffer;
	struct usb_endpoint_descriptor* interrupt_out_endpoint;
	struct urb*		interrupt_out_urb;
	int                     interrupt_out_interval;
        int                     interrupt_out_busy;

};

static ssize_t labjack_read(struct file *file, char *buffer, size_t count, loff_t *ppos);
static ssize_t labjack_read_feature(struct file *file, char *buffer, size_t count, loff_t *ppos);
static ssize_t labjack_write(struct file *file, const char *buffer, size_t count, loff_t *ppos);
static int labjack_ioctl(struct inode *inode, struct file *file, unsigned int cmd, unsigned long arg);
static inline void labjack_delete(struct labjack_usb *dev);
static int labjack_open(struct inode *inode, struct file *file);
static int labjack_release(struct inode *inode, struct file *file);
static unsigned int labjack_poll(struct file *file, poll_table *wait);
static loff_t labjack_llseek(struct file *file, loff_t off, int whence);

static void labjack_abort_transfers (struct labjack_usb *dev);
static void labjack_check_for_read_packet (struct labjack_usb *dev);
static void labjack_interrupt_in_callback (struct urb *urb,  struct pt_regs *regs);
static void labjack_interrupt_out_callback (struct urb *urb,  struct pt_regs *regs);
static int  labjack_probe (struct usb_interface *interface, const struct usb_device_id *id);
static void labjack_disconnect    (struct usb_interface *interface);

static DECLARE_MUTEX (disconnect_sem);

static struct file_operations labjack_fops = {
	owner:		THIS_MODULE,
	read:		labjack_read,
	write:		labjack_write,
	ioctl:		labjack_ioctl,
	open:		labjack_open,
	release:	labjack_release, 
        poll:           labjack_poll,
        llseek:         labjack_llseek,
};

static struct usb_class_driver labjack_class = {
        name:	        "usb/labjack%d",
        fops:     	&labjack_fops,
        mode:           S_IFCHR | S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IROTH,
        minor_base:     LABJACK_USB_MINOR_BASE,
};

static struct usb_driver labjack_driver = {
        owner:          THIS_MODULE,
	name:		"labjack",
	probe:		labjack_probe,
	disconnect:	labjack_disconnect,
	id_table:	labjack_table,
};


static inline void usb_labjack_debug_data (int level, const char *function, int size, const unsigned char *data)
{
	int i;

	if (debug < level)
		return; 
	
        printk (KERN_DEBUG __FILE__": %s - length = %d, data = ", function, size);

linux-labjack/driver/linux-2.6/labjack.c  view on Meta::CPAN

		usb_free_urb (dev->interrupt_in_urb);
        }
	if (dev->interrupt_out_urb != NULL) {
		usb_free_urb (dev->interrupt_out_urb);
        }

        kfree (dev->read_buffer);
        kfree (dev->interrupt_in_buffer);
        kfree (dev->interrupt_out_buffer);
        kfree (dev);
    
	dbg(2, "%s : leave", __FUNCTION__);
}


static int labjack_open (struct inode *inode, struct file *file)
{
	struct labjack_usb *dev = NULL;
	int subminor;
	int retval = 0;
	struct usb_interface *interface;
    
	dbg(2,"%s : enter", __FUNCTION__);

        subminor = iminor(inode);

        down(&disconnect_sem);
 
        interface = usb_find_interface(&labjack_driver, subminor);

        if (!interface) {
                err ("%s - error, can't find device for minor %d", __FUNCTION__, subminor);
                retval = -ENODEV;
                goto unlock_disconnect_exit;
        }

        dev = usb_get_intfdata(interface);

        if (!dev) {
                retval = -ENODEV;
                goto unlock_disconnect_exit;
        }
    
        if (down_interruptible (&dev->sem)) {
                retval = -ERESTARTSYS;
                goto unlock_disconnect_exit;
        }
 
        if (dev->open_count) {
                retval = -EBUSY;
                goto unlock_exit;
        }
    
        dev->open_count = 1;

        dev->read_buffer_length = 0;

	dev->read_packet_length = 0;
	usb_fill_int_urb (dev->interrupt_in_urb,
		dev->udev,
		usb_rcvintpipe(dev->udev, dev->interrupt_in_endpoint->bEndpointAddress),
		dev->interrupt_in_buffer,
		dev->interrupt_in_endpoint->wMaxPacketSize,
		labjack_interrupt_in_callback,
		dev,
		dev->interrupt_in_interval);

		dev->interrupt_in_running = 1;
		dev->interrupt_in_done = 0;
		mb();
    
	retval = usb_submit_urb (dev->interrupt_in_urb, GFP_KERNEL);
	if (retval) {
		err("Couldn't submit interrupt_in_urb %d", retval);
		dev->interrupt_in_running = 0;
		dev->open_count = 0;
		goto unlock_exit;
	}

	file->private_data = dev;
 
unlock_exit:
	up (&dev->sem);
	
unlock_disconnect_exit:
	up (&disconnect_sem);

        dbg(2,"%s : leave, return value %d ", __FUNCTION__, retval);

        return retval;
}


static int labjack_release (struct inode *inode, struct file *file)
{
	struct labjack_usb *dev;
	int retval = 0;

	dbg(2," %s : enter", __FUNCTION__);

	dev = (struct labjack_usb *)file->private_data;

	if (dev == NULL) {
                dbg(1," %s : object is NULL", __FUNCTION__);
                retval = -ENODEV;
                goto exit;
	}

	if (down_interruptible (&dev->sem)) {
                retval = -ERESTARTSYS;
		goto exit;
	}

	if (dev->open_count != 1) {
		dbg(1, "%s: device not opened exactly once", __FUNCTION__);
		retval = -ENODEV;
		goto unlock_exit;
	}
	
	if (dev->udev == NULL) {
		up (&dev->sem); 
		labjack_delete (dev);
		goto exit;

linux-labjack/driver/linux-2.6/labjack.c  view on Meta::CPAN

	if (copy_to_user (buffer, dev->read_buffer, count)) {
		retval = -EFAULT;
		goto unlock_exit;
	}
	
	goto unlock_exit;
	
unlock_exit:
	up (&dev->sem);
	dbg(2," %s : leave, return value %d", __FUNCTION__, retval);
	return retval;
}	


static ssize_t labjack_write (struct file *file, const char *buffer, size_t count, loff_t *ppos)
{
	struct labjack_usb *dev;
	size_t bytes_to_write;
	int retval = 0;

	dbg(2," %s : enter, count = %Zd", __FUNCTION__, count);

	dev = (struct labjack_usb *)file->private_data;

	if (down_interruptible (&dev->sem)) {
                retval = -ERESTARTSYS;
                goto exit;
        }

	if (dev->udev == NULL) {
		retval = -ENODEV;
		err("No device or device unplugged %d", retval);
		goto unlock_exit;
	}

	if (count == 0) {
        dbg(1," %s : write request of 0 bytes", __FUNCTION__);
		goto unlock_exit;
	}
	
	while (dev->interrupt_out_busy) {
                if (file->f_flags & O_NONBLOCK) {
                        retval = -EAGAIN;
                        goto unlock_exit;
                }
                retval = wait_event_interruptible (dev->write_wait, !dev->interrupt_out_busy);
                if (retval) {
                        goto unlock_exit;
                }
        }
    
	bytes_to_write = min(count, write_buffer_size);
        dbg(4, "%s: count = %Zd, bytes_to_write = %Zd", __FUNCTION__, count, bytes_to_write);

        if (copy_from_user (dev->interrupt_out_buffer, buffer, bytes_to_write)) {
                retval = -EFAULT;
                goto unlock_exit;
        }

        usb_fill_int_urb(dev->interrupt_out_urb, dev->udev,
            usb_sndintpipe(dev->udev, dev->interrupt_out_endpoint->bEndpointAddress),
            dev->interrupt_out_buffer,
            bytes_to_write,
            labjack_interrupt_out_callback,
            dev,
            dev->interrupt_out_interval);

        dev->interrupt_out_busy = 1;
        wmb();
 
        retval = usb_submit_urb (dev->interrupt_out_urb, GFP_KERNEL);
        if (retval) {
                dev->interrupt_out_busy = 0;
                err("Couldn't submit interrupt_out_urb %d", retval);
                goto unlock_exit;
	}
	retval = bytes_to_write;

unlock_exit:
	up (&dev->sem);

exit:
	dbg(2," %s : leave, return value %d", __FUNCTION__, retval);
	return retval;
}


static int labjack_ioctl (struct inode *inode, struct file *file, unsigned int cmd, unsigned long arg)
{
	struct labjack_usb *dev;
        int retval =  -ENOTTY;  /* default: we don't understand ioctl */

	dev = (struct labjack_usb *)file->private_data;

	down (&dev->sem);

	if (dev->udev == NULL) {
		retval = -ENODEV;
                goto unlock_exit;
	}
        
	switch (cmd) {
		/* :TODO: add ioctl commands as needed */
    }
	
unlock_exit:
	up (&dev->sem);

	dbg(2," %s : leave, return value %d", __func__, retval);

	return retval;
}


static void labjack_interrupt_in_callback (struct urb *urb, struct pt_regs *regs)
{
	struct labjack_usb *dev = (struct labjack_usb *)urb->context;
	int retval;
	
	dbg(4," %s : enter, status %d", __FUNCTION__, urb->status);

linux-labjack/driver/linux-2.6/labjack.c  view on Meta::CPAN


        if (urb->actual_length > 0) {
		spin_lock (&dev->read_buffer_lock);
                if (dev->read_buffer_length + urb->actual_length < read_buffer_size) {
                        memcpy (dev->read_buffer + dev->read_buffer_length,
                            dev->interrupt_in_buffer,
                            urb->actual_length);
                        dev->read_buffer_length += urb->actual_length;
                        dev->read_last_arrival = jiffies;
                        dbg(3, "%s: received %d bytes", __FUNCTION__, urb->actual_length);
                } 
                else 
                {
			printk(KERN_WARNING "%s: read_buffer overflow, %d bytes dropped", __FUNCTION__, urb->actual_length);
                }
                spin_unlock (&dev->read_buffer_lock);
        }

 resubmit:
	if (dev->interrupt_in_running && dev->udev) {
                retval = usb_submit_urb (dev->interrupt_in_urb, GFP_ATOMIC);
        if (retval) {
	        err("%s: usb_submit_urb failed (%d)", __FUNCTION__, retval);
        }
    }

 exit:
        dev->interrupt_in_done = 1;
        wake_up_interruptible (&dev->read_wait);
        usb_labjack_debug_data(5, __FUNCTION__, urb->actual_length, urb->transfer_buffer);
        dbg(4, "%s: leave, status %d", __FUNCTION__, urb->status);
}


static void labjack_interrupt_out_callback (struct urb *urb, struct pt_regs *regs)
{
	struct labjack_usb *dev = (struct labjack_usb *)urb->context;

	dbg(4," %s : enter, status %d", __FUNCTION__, urb->status);
	usb_labjack_debug_data(5,__FUNCTION__, urb->actual_length, urb->transfer_buffer);

	if (urb->status && !(urb->status == -ENOENT ||
	    urb->status == -ECONNRESET ||
        urb->status == -ESHUTDOWN)) {
            dbg(1, "%s - nonzero write bulk status received: %d",
	        __FUNCTION__, urb->status);
        }
	dev->interrupt_out_busy = 0;
   	wake_up_interruptible(&dev->write_wait);

	usb_labjack_debug_data(5,__FUNCTION__, urb->actual_length, urb->transfer_buffer);
	dbg(4," %s : leave, status %d", __FUNCTION__, urb->status);
}


static int labjack_probe (struct usb_interface *interface, const struct usb_device_id *id)
{
	struct usb_device *udev = interface_to_usbdev(interface);
	struct labjack_usb *dev = NULL;
	struct usb_host_interface *iface_desc;
        struct usb_endpoint_descriptor* endpoint;
	int i;
        int retval = -ENOMEM;

	dbg(2," %s : enter", __FUNCTION__);

        if (udev == NULL) {
		info ("udev is NULL.");
        }
	
	if ((udev->descriptor.idVendor != LABJACK_USB_VENDOR_ID) ||
	    (udev->descriptor.idProduct != LABJACK_USB_PRODUCT_ID)) {
		goto exit;
	}
	dev = kmalloc (sizeof(struct labjack_usb), GFP_KERNEL);
	
	if (dev == NULL) {
		err ("Out of memory");
		goto exit;
	}
	
	init_MUTEX (&dev->sem);
	
	dev->udev = udev;
        dev->open_count = 0;

        dev->read_buffer = NULL;
        dev->read_buffer_length = 0;
        dev->read_packet_length = 0;
        spin_lock_init (&dev->read_buffer_lock);
        dev->packet_timeout_jiffies = packet_timeout * HZ / 1000;
        dev->read_last_arrival = jiffies;

        init_waitqueue_head (&dev->read_wait);
        init_waitqueue_head (&dev->write_wait);

        dev->interrupt_in_buffer = NULL;
        dev->interrupt_in_endpoint = NULL;
        dev->interrupt_in_urb = NULL;
        dev->interrupt_in_running = 0;
        dev->interrupt_in_done = 0;

        dev->interrupt_out_buffer = NULL;
        dev->interrupt_out_endpoint = NULL;
        dev->interrupt_out_urb = NULL;
        dev->interrupt_out_busy = 0;

        iface_desc = &interface->altsetting[0];
    
	for (i = 0; i < iface_desc->desc.bNumEndpoints; ++i) {
		endpoint = &iface_desc->endpoint[i].desc;

		if (((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_IN) &&
		    ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)) {
                        dev->interrupt_in_endpoint = endpoint;
		}
		
		if (((endpoint->bEndpointAddress & USB_ENDPOINT_DIR_MASK) == USB_DIR_OUT) &&
		    ((endpoint->bmAttributes & USB_ENDPOINT_XFERTYPE_MASK) == USB_ENDPOINT_XFER_INT)) {
                        dev->interrupt_out_endpoint = endpoint;
		}
	}        
	
        if(dev->interrupt_in_endpoint == NULL) {
                err("interrupt in endpoint not found");
                goto error;
        }
        if (dev->interrupt_out_endpoint == NULL) {
                err("interrupt out endpoint not found");
                goto error;  
        }

        dev->read_buffer = kmalloc (read_buffer_size, GFP_KERNEL);
        if (!dev->read_buffer) {
                err("Couldn't allocate read_buffer");
                goto error;
        }
        dev->interrupt_in_buffer = kmalloc (dev->interrupt_in_endpoint->wMaxPacketSize, GFP_KERNEL);
        if (!dev->interrupt_in_buffer) {
                err("Couldn't allocate interrupt_in_buffer");
                goto error;
        }
        dev->interrupt_in_urb = usb_alloc_urb(0, GFP_KERNEL);
        if (!dev->interrupt_in_urb) {
                err("Couldn't allocate interrupt_in_urb");
    	        goto error;    
        }
	dev->interrupt_out_buffer = kmalloc (write_buffer_size, GFP_KERNEL);
        if (!dev->interrupt_out_buffer) {
       	        err("Couldn't allocate interrupt_out_buffer");
                goto error;
        }
        dev->interrupt_out_urb = usb_alloc_urb(0, GFP_KERNEL);
        if (!dev->interrupt_out_urb) {
    	        err("Couldn't allocate interrupt_out_urb");
    	        goto error;
   	}                
	dev->interrupt_in_interval = interrupt_in_interval ? interrupt_in_interval : dev->interrupt_in_endpoint->bInterval;
	dev->interrupt_out_interval = interrupt_out_interval ? interrupt_out_interval : dev->interrupt_out_endpoint->bInterval;
   	
   	usb_set_intfdata (interface, dev);

	retval = usb_register_dev (interface, &labjack_class);
	
	if (retval) {
		err ("Not able to get a minor for this device.");
		usb_set_intfdata (interface, NULL);
		goto error;
	}

	dev->minor = interface->minor;
	info ("LabJack USB #%d now attached to major %d minor %d", (dev->minor - LABJACK_USB_MINOR_BASE), USB_MAJOR, dev->minor);

 exit:
	dbg(2," %s : leave, return value 0x%.8lx (dev)", __FUNCTION__, (long) dev);

	return retval;

 error:
	labjack_delete(dev);
	return retval;
}


static void labjack_disconnect (struct usb_interface *interface)
{
	struct labjack_usb *dev;
	int minor;

	dbg(2," %s : enter", __FUNCTION__);

	down (&disconnect_sem);

	dev = usb_get_intfdata (interface);
	usb_set_intfdata (interface, NULL);
	
	down (&dev->sem);

	minor = dev->minor;

	usb_deregister_dev (interface, &labjack_class);
	
	if (!dev->open_count) {
		up (&dev->sem);
		labjack_delete (dev);
	} else {
		dev->udev = NULL;
		up (&dev->sem);
	}

	up(&disconnect_sem);
	
	info("Labjack USB #%d now disconnected", minor - LABJACK_USB_MINOR_BASE);

	dbg(2," %s : leave", __FUNCTION__);
}


static int __init usb_labjack_init(void)



( run in 0.501 second using v1.01-cache-2.11-cpan-39bf76dae61 )