2 * Driver for Meywa-Denki & KAYAC YUREX
4 * Copyright (C) 2010 Tomoki Sekiyama (tomoki.sekiyama@gmail.com)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation, version 2.
12 #include <linux/kernel.h>
13 #include <linux/errno.h>
14 #include <linux/slab.h>
15 #include <linux/module.h>
16 #include <linux/kref.h>
17 #include <linux/mutex.h>
18 #include <linux/uaccess.h>
19 #include <linux/usb.h>
20 #include <linux/hid.h>
22 #define DRIVER_AUTHOR "Tomoki Sekiyama"
23 #define DRIVER_DESC "Driver for Meywa-Denki & KAYAC YUREX"
25 #define YUREX_VENDOR_ID 0x0c45
26 #define YUREX_PRODUCT_ID 0x1010
29 #define CMD_ANIMATE 'A'
34 #define CMD_VERSION 'V'
36 #define CMD_PADDING 0xff
38 #define YUREX_BUF_SIZE 8
39 #define YUREX_WRITE_TIMEOUT (HZ*2)
41 /* table of devices that work with this driver */
42 static struct usb_device_id yurex_table[] = {
43 { USB_DEVICE(YUREX_VENDOR_ID, YUREX_PRODUCT_ID) },
44 { } /* Terminating entry */
46 MODULE_DEVICE_TABLE(usb, yurex_table);
48 #ifdef CONFIG_USB_DYNAMIC_MINORS
49 #define YUREX_MINOR_BASE 0
51 #define YUREX_MINOR_BASE 192
54 /* Structure to hold all of our device specific stuff */
56 struct usb_device *udev;
57 struct usb_interface *interface;
58 __u8 int_in_endpointAddr;
59 struct urb *urb; /* URB for interrupt in */
60 unsigned char *int_buffer; /* buffer for intterupt in */
61 struct urb *cntl_urb; /* URB for control msg */
62 struct usb_ctrlrequest *cntl_req; /* req for control msg */
63 unsigned char *cntl_buffer; /* buffer for control msg */
66 struct mutex io_mutex;
67 struct fasync_struct *async_queue;
68 wait_queue_head_t waitq;
71 __s64 bbu; /* BBU from device */
73 #define to_yurex_dev(d) container_of(d, struct usb_yurex, kref)
75 static struct usb_driver yurex_driver;
76 static const struct file_operations yurex_fops;
79 static void yurex_control_callback(struct urb *urb)
81 struct usb_yurex *dev = urb->context;
82 int status = urb->status;
85 dev_err(&urb->dev->dev, "%s - control failed: %d\n",
87 wake_up_interruptible(&dev->waitq);
90 /* on success, sender woken up by CMD_ACK int in, or timeout */
93 static void yurex_delete(struct kref *kref)
95 struct usb_yurex *dev = to_yurex_dev(kref);
97 dev_dbg(&dev->interface->dev, "%s\n", __func__);
99 usb_put_dev(dev->udev);
101 usb_kill_urb(dev->cntl_urb);
102 kfree(dev->cntl_req);
103 if (dev->cntl_buffer)
104 usb_free_coherent(dev->udev, YUREX_BUF_SIZE,
105 dev->cntl_buffer, dev->cntl_urb->transfer_dma);
106 usb_free_urb(dev->cntl_urb);
109 usb_kill_urb(dev->urb);
111 usb_free_coherent(dev->udev, YUREX_BUF_SIZE,
112 dev->int_buffer, dev->urb->transfer_dma);
113 usb_free_urb(dev->urb);
119 * usb class driver info in order to get a minor number from the usb core,
120 * and to have the device registered with the driver core
122 static struct usb_class_driver yurex_class = {
125 .minor_base = YUREX_MINOR_BASE,
128 static void yurex_interrupt(struct urb *urb)
130 struct usb_yurex *dev = urb->context;
131 unsigned char *buf = dev->int_buffer;
132 int status = urb->status;
140 dev_err(&dev->interface->dev,
141 "%s - overflow with length %d, actual length is %d\n",
142 __func__, YUREX_BUF_SIZE, dev->urb->actual_length);
147 /* The device is terminated, clean up */
150 dev_err(&dev->interface->dev,
151 "%s - unknown status received: %d\n", __func__, status);
155 /* handle received message */
159 if (buf[6] == CMD_EOF) {
160 spin_lock_irqsave(&dev->lock, flags);
162 for (i = 1; i < 6; i++) {
167 dev_dbg(&dev->interface->dev, "%s count: %lld\n",
169 spin_unlock_irqrestore(&dev->lock, flags);
171 kill_fasync(&dev->async_queue, SIGIO, POLL_IN);
174 dev_dbg(&dev->interface->dev,
175 "data format error - no EOF\n");
178 dev_dbg(&dev->interface->dev, "%s ack: %c\n",
180 wake_up_interruptible(&dev->waitq);
185 retval = usb_submit_urb(dev->urb, GFP_ATOMIC);
187 dev_err(&dev->interface->dev, "%s - usb_submit_urb failed: %d\n",
192 static int yurex_probe(struct usb_interface *interface, const struct usb_device_id *id)
194 struct usb_yurex *dev;
195 struct usb_host_interface *iface_desc;
196 struct usb_endpoint_descriptor *endpoint;
197 int retval = -ENOMEM;
201 /* allocate memory for our device state and initialize it */
202 dev = kzalloc(sizeof(*dev), GFP_KERNEL);
204 dev_err(&interface->dev, "Out of memory\n");
207 kref_init(&dev->kref);
208 mutex_init(&dev->io_mutex);
209 spin_lock_init(&dev->lock);
210 init_waitqueue_head(&dev->waitq);
212 dev->udev = usb_get_dev(interface_to_usbdev(interface));
213 dev->interface = interface;
215 /* set up the endpoint information */
216 iface_desc = interface->cur_altsetting;
217 for (i = 0; i < iface_desc->desc.bNumEndpoints; i++) {
218 endpoint = &iface_desc->endpoint[i].desc;
220 if (usb_endpoint_is_int_in(endpoint)) {
221 dev->int_in_endpointAddr = endpoint->bEndpointAddress;
225 if (!dev->int_in_endpointAddr) {
227 dev_err(&interface->dev, "Could not find endpoints\n");
232 /* allocate control URB */
233 dev->cntl_urb = usb_alloc_urb(0, GFP_KERNEL);
237 /* allocate buffer for control req */
238 dev->cntl_req = kmalloc(YUREX_BUF_SIZE, GFP_KERNEL);
239 if (!dev->cntl_req) {
240 dev_err(&interface->dev, "Could not allocate cntl_req\n");
244 /* allocate buffer for control msg */
245 dev->cntl_buffer = usb_alloc_coherent(dev->udev, YUREX_BUF_SIZE,
247 &dev->cntl_urb->transfer_dma);
248 if (!dev->cntl_buffer) {
249 dev_err(&interface->dev, "Could not allocate cntl_buffer\n");
253 /* configure control URB */
254 dev->cntl_req->bRequestType = USB_DIR_OUT | USB_TYPE_CLASS |
256 dev->cntl_req->bRequest = HID_REQ_SET_REPORT;
257 dev->cntl_req->wValue = cpu_to_le16((HID_OUTPUT_REPORT + 1) << 8);
258 dev->cntl_req->wIndex = cpu_to_le16(iface_desc->desc.bInterfaceNumber);
259 dev->cntl_req->wLength = cpu_to_le16(YUREX_BUF_SIZE);
261 usb_fill_control_urb(dev->cntl_urb, dev->udev,
262 usb_sndctrlpipe(dev->udev, 0),
263 (void *)dev->cntl_req, dev->cntl_buffer,
264 YUREX_BUF_SIZE, yurex_control_callback, dev);
265 dev->cntl_urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
268 /* allocate interrupt URB */
269 dev->urb = usb_alloc_urb(0, GFP_KERNEL);
273 /* allocate buffer for interrupt in */
274 dev->int_buffer = usb_alloc_coherent(dev->udev, YUREX_BUF_SIZE,
275 GFP_KERNEL, &dev->urb->transfer_dma);
276 if (!dev->int_buffer) {
277 dev_err(&interface->dev, "Could not allocate int_buffer\n");
281 /* configure interrupt URB */
282 usb_fill_int_urb(dev->urb, dev->udev,
283 usb_rcvintpipe(dev->udev, dev->int_in_endpointAddr),
284 dev->int_buffer, YUREX_BUF_SIZE, yurex_interrupt,
286 dev->urb->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
287 if (usb_submit_urb(dev->urb, GFP_KERNEL)) {
289 dev_err(&interface->dev, "Could not submitting URB\n");
293 /* save our data pointer in this interface device */
294 usb_set_intfdata(interface, dev);
297 /* we can register the device now, as it is ready */
298 retval = usb_register_dev(interface, &yurex_class);
300 dev_err(&interface->dev,
301 "Not able to get a minor for this device.\n");
302 usb_set_intfdata(interface, NULL);
306 dev_info(&interface->dev,
307 "USB YUREX device now attached to Yurex #%d\n",
314 /* this frees allocated memory */
315 kref_put(&dev->kref, yurex_delete);
319 static void yurex_disconnect(struct usb_interface *interface)
321 struct usb_yurex *dev;
322 int minor = interface->minor;
324 dev = usb_get_intfdata(interface);
325 usb_set_intfdata(interface, NULL);
327 /* give back our minor */
328 usb_deregister_dev(interface, &yurex_class);
330 /* prevent more I/O from starting */
331 mutex_lock(&dev->io_mutex);
332 dev->interface = NULL;
333 mutex_unlock(&dev->io_mutex);
336 kill_fasync(&dev->async_queue, SIGIO, POLL_IN);
337 wake_up_interruptible(&dev->waitq);
339 /* decrement our usage count */
340 kref_put(&dev->kref, yurex_delete);
342 dev_info(&interface->dev, "USB YUREX #%d now disconnected\n", minor);
345 static struct usb_driver yurex_driver = {
347 .probe = yurex_probe,
348 .disconnect = yurex_disconnect,
349 .id_table = yurex_table,
353 static int yurex_fasync(int fd, struct file *file, int on)
355 struct usb_yurex *dev;
357 dev = file->private_data;
358 return fasync_helper(fd, file, on, &dev->async_queue);
361 static int yurex_open(struct inode *inode, struct file *file)
363 struct usb_yurex *dev;
364 struct usb_interface *interface;
368 subminor = iminor(inode);
370 interface = usb_find_interface(&yurex_driver, subminor);
372 printk(KERN_ERR "%s - error, can't find device for minor %d",
378 dev = usb_get_intfdata(interface);
384 /* increment our usage count for the device */
385 kref_get(&dev->kref);
387 /* save our object in the file's private structure */
388 mutex_lock(&dev->io_mutex);
389 file->private_data = dev;
390 mutex_unlock(&dev->io_mutex);
396 static int yurex_release(struct inode *inode, struct file *file)
398 struct usb_yurex *dev;
400 dev = file->private_data;
404 /* decrement the count on our device */
405 kref_put(&dev->kref, yurex_delete);
409 static ssize_t yurex_read(struct file *file, char __user *buffer, size_t count,
412 struct usb_yurex *dev;
418 dev = file->private_data;
420 mutex_lock(&dev->io_mutex);
421 if (!dev->interface) { /* already disconnected */
426 spin_lock_irqsave(&dev->lock, flags);
427 bytes_read = snprintf(in_buffer, 20, "%lld\n", dev->bbu);
428 spin_unlock_irqrestore(&dev->lock, flags);
430 if (*ppos < bytes_read) {
431 if (copy_to_user(buffer, in_buffer + *ppos, bytes_read - *ppos))
434 retval = bytes_read - *ppos;
440 mutex_unlock(&dev->io_mutex);
444 static ssize_t yurex_write(struct file *file, const char __user *user_buffer,
445 size_t count, loff_t *ppos)
447 struct usb_yurex *dev;
448 int i, set = 0, retval = 0;
451 unsigned long long c, c2 = 0;
452 signed long timeout = 0;
455 count = min(sizeof(buffer), count);
456 dev = file->private_data;
458 /* verify that we actually have some data to write */
462 mutex_lock(&dev->io_mutex);
463 if (!dev->interface) { /* already disconnected */
464 mutex_unlock(&dev->io_mutex);
469 if (copy_from_user(buffer, user_buffer, count)) {
470 mutex_unlock(&dev->io_mutex);
474 memset(dev->cntl_buffer, CMD_PADDING, YUREX_BUF_SIZE);
479 dev->cntl_buffer[0] = buffer[0];
480 dev->cntl_buffer[1] = buffer[1];
481 dev->cntl_buffer[2] = CMD_EOF;
485 dev->cntl_buffer[0] = buffer[0];
486 dev->cntl_buffer[1] = 0x00;
487 dev->cntl_buffer[2] = CMD_EOF;
494 c = c2 = simple_strtoull(data, NULL, 0);
495 dev->cntl_buffer[0] = CMD_SET;
496 for (i = 1; i < 6; i++) {
497 dev->cntl_buffer[i] = (c>>32) & 0xff;
503 mutex_unlock(&dev->io_mutex);
507 /* send the data as the control msg */
508 prepare_to_wait(&dev->waitq, &wait, TASK_INTERRUPTIBLE);
509 dev_dbg(&dev->interface->dev, "%s - submit %c\n", __func__,
510 dev->cntl_buffer[0]);
511 retval = usb_submit_urb(dev->cntl_urb, GFP_KERNEL);
513 timeout = schedule_timeout(YUREX_WRITE_TIMEOUT);
514 finish_wait(&dev->waitq, &wait);
516 mutex_unlock(&dev->io_mutex);
519 dev_err(&dev->interface->dev,
520 "%s - failed to send bulk msg, error %d\n",
526 return timeout ? count : -EIO;
532 static const struct file_operations yurex_fops = {
533 .owner = THIS_MODULE,
535 .write = yurex_write,
537 .release = yurex_release,
538 .fasync = yurex_fasync,
539 .llseek = default_llseek,
542 module_usb_driver(yurex_driver);
544 MODULE_LICENSE("GPL");