123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741 |
- /*
- * User-space I/O driver support for HID subsystem
- * Copyright (c) 2012 David Herrmann
- */
- /*
- * This program is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License as published by the Free
- * Software Foundation; either version 2 of the License, or (at your option)
- * any later version.
- */
- #include <linux/atomic.h>
- #include <linux/device.h>
- #include <linux/fs.h>
- #include <linux/hid.h>
- #include <linux/input.h>
- #include <linux/miscdevice.h>
- #include <linux/module.h>
- #include <linux/mutex.h>
- #include <linux/poll.h>
- #include <linux/sched.h>
- #include <linux/spinlock.h>
- #include <linux/uhid.h>
- #include <linux/wait.h>
- #include <linux/fb.h>
- #define UHID_NAME "uhid"
- #define UHID_BUFSIZE 32
- static DEFINE_MUTEX(uhid_open_mutex);
- struct uhid_device {
- struct mutex devlock;
- bool running;
- __u8 *rd_data;
- uint rd_size;
- struct hid_device *hid;
- struct uhid_event input_buf;
- wait_queue_head_t waitq;
- spinlock_t qlock;
- __u8 head;
- __u8 tail;
- struct uhid_event *outq[UHID_BUFSIZE];
- /* blocking GET_REPORT support; state changes protected by qlock */
- struct mutex report_lock;
- wait_queue_head_t report_wait;
- bool report_running;
- u32 report_id;
- struct uhid_event report_buf;
- struct work_struct worker;
- };
- static struct miscdevice uhid_misc;
- bool lcd_is_on = true;
- static void uhid_device_add_worker(struct work_struct *work)
- {
- struct uhid_device *uhid = container_of(work, struct uhid_device, worker);
- int ret;
- ret = hid_add_device(uhid->hid);
- if (ret) {
- hid_err(uhid->hid, "Cannot register HID device: error %d\n", ret);
- hid_destroy_device(uhid->hid);
- uhid->hid = NULL;
- uhid->running = false;
- }
- }
- static void uhid_queue(struct uhid_device *uhid, struct uhid_event *ev)
- {
- __u8 newhead;
- newhead = (uhid->head + 1) % UHID_BUFSIZE;
- if (newhead != uhid->tail) {
- uhid->outq[uhid->head] = ev;
- uhid->head = newhead;
- wake_up_interruptible(&uhid->waitq);
- } else {
- hid_warn(uhid->hid, "Output queue is full\n");
- kfree(ev);
- }
- }
- static int uhid_queue_event(struct uhid_device *uhid, __u32 event)
- {
- unsigned long flags;
- struct uhid_event *ev;
- ev = kzalloc(sizeof(*ev), GFP_KERNEL);
- if (!ev)
- return -ENOMEM;
- ev->type = event;
- spin_lock_irqsave(&uhid->qlock, flags);
- uhid_queue(uhid, ev);
- spin_unlock_irqrestore(&uhid->qlock, flags);
- return 0;
- }
- static int uhid_hid_start(struct hid_device *hid)
- {
- struct uhid_device *uhid = hid->driver_data;
- return uhid_queue_event(uhid, UHID_START);
- }
- static void uhid_hid_stop(struct hid_device *hid)
- {
- struct uhid_device *uhid = hid->driver_data;
- hid->claimed = 0;
- uhid_queue_event(uhid, UHID_STOP);
- }
- static int uhid_hid_open(struct hid_device *hid)
- {
- struct uhid_device *uhid = hid->driver_data;
- int retval = 0;
- mutex_lock(&uhid_open_mutex);
- if (!hid->open++) {
- retval = uhid_queue_event(uhid, UHID_OPEN);
- if (retval)
- hid->open--;
- }
- mutex_unlock(&uhid_open_mutex);
- return retval;
- }
- static void uhid_hid_close(struct hid_device *hid)
- {
- struct uhid_device *uhid = hid->driver_data;
- mutex_lock(&uhid_open_mutex);
- if (!--hid->open)
- uhid_queue_event(uhid, UHID_CLOSE);
- mutex_unlock(&uhid_open_mutex);
- }
- static int uhid_hid_input(struct input_dev *input, unsigned int type,
- unsigned int code, int value)
- {
- struct hid_device *hid = input_get_drvdata(input);
- struct uhid_device *uhid = hid->driver_data;
- unsigned long flags;
- struct uhid_event *ev;
- struct hid_field *field;
- struct hid_report *report;
- int offset;
- ev = kzalloc(sizeof(*ev), GFP_ATOMIC);
- if (!ev)
- return -ENOMEM;
- switch (type) {
- case EV_LED:
- if(!lcd_is_on){
- dbg_hid("uhid_hid_input lcd is off, don't report LED event\n");
- kfree(ev);
- return -1;
- }
- offset = hidinput_find_field(hid, type, code, &field);
- if (offset == -1) {
- hid_warn(input, "event field not found\n");
- kfree(ev);
- return -1;
- }
- hid_set_field(field, offset, value);
- report = field->report;
- ev->type = UHID_OUTPUT;
- ev->u.output.rtype = UHID_OUTPUT_REPORT;
- hid_output_report(report, ev->u.output.data);
- ev->u.output.size = ((report->size - 1) >> 3) + 1 +
- (report->id > 0);
- break;
- default:
- ev->type = UHID_OUTPUT_EV;
- ev->u.output_ev.type = type;
- ev->u.output_ev.code = code;
- ev->u.output_ev.value = value;
- }
- spin_lock_irqsave(&uhid->qlock, flags);
- uhid_queue(uhid, ev);
- spin_unlock_irqrestore(&uhid->qlock, flags);
- return 0;
- }
- static int fb_state_change(struct notifier_block *nb,
- unsigned long val, void *data)
- {
- struct fb_event *evdata = data;
- unsigned int blank;
- dbg_hid("fb_state_change");
- if (val != FB_EVENT_BLANK)
- return 0;
- blank = *(int *)evdata->data;
- switch (blank) {
- case FB_BLANK_POWERDOWN:
- lcd_is_on = false;
- break;
- case FB_BLANK_UNBLANK:
- lcd_is_on = true;
- break;
- default:
- break;
- }
- return NOTIFY_OK;
- }
- static struct notifier_block fb_block = {
- .notifier_call = fb_state_change,
- };
- static int uhid_hid_parse(struct hid_device *hid)
- {
- struct uhid_device *uhid = hid->driver_data;
- return hid_parse_report(hid, uhid->rd_data, uhid->rd_size);
- }
- static int uhid_hid_get_raw(struct hid_device *hid, unsigned char rnum,
- __u8 *buf, size_t count, unsigned char rtype)
- {
- struct uhid_device *uhid = hid->driver_data;
- __u8 report_type;
- struct uhid_event *ev;
- unsigned long flags;
- int ret;
- size_t uninitialized_var(len);
- struct uhid_feature_answer_req *req;
- if (!uhid->running)
- return -EIO;
- switch (rtype) {
- case HID_FEATURE_REPORT:
- report_type = UHID_FEATURE_REPORT;
- break;
- case HID_OUTPUT_REPORT:
- report_type = UHID_OUTPUT_REPORT;
- break;
- case HID_INPUT_REPORT:
- report_type = UHID_INPUT_REPORT;
- break;
- default:
- return -EINVAL;
- }
- ret = mutex_lock_interruptible(&uhid->report_lock);
- if (ret)
- return ret;
- ev = kzalloc(sizeof(*ev), GFP_KERNEL);
- if (!ev) {
- ret = -ENOMEM;
- goto unlock;
- }
- spin_lock_irqsave(&uhid->qlock, flags);
- ev->type = UHID_FEATURE;
- ev->u.feature.id = ++uhid->report_id;
- ev->u.feature.rnum = rnum;
- ev->u.feature.rtype = report_type;
- uhid->report_running = true;
- uhid_queue(uhid, ev);
- spin_unlock_irqrestore(&uhid->qlock, flags);
- ret = wait_event_interruptible_timeout(uhid->report_wait,
- !uhid->report_running || !uhid->running,
- 5 * HZ);
- if (!ret || !uhid->running) {
- ret = -EIO;
- } else if (ret < 0) {
- ret = -ERESTARTSYS;
- } else {
- spin_lock_irqsave(&uhid->qlock, flags);
- req = &uhid->report_buf.u.feature_answer;
- if (req->err) {
- ret = -EIO;
- } else {
- ret = 0;
- len = min(count,
- min_t(size_t, req->size, UHID_DATA_MAX));
- memcpy(buf, req->data, len);
- }
- spin_unlock_irqrestore(&uhid->qlock, flags);
- }
- uhid->report_running = false;
- unlock:
- mutex_unlock(&uhid->report_lock);
- return ret ? ret : len;
- }
- static int uhid_hid_output_raw(struct hid_device *hid, __u8 *buf, size_t count,
- unsigned char report_type)
- {
- struct uhid_device *uhid = hid->driver_data;
- __u8 rtype;
- unsigned long flags;
- struct uhid_event *ev;
- switch (report_type) {
- case HID_FEATURE_REPORT:
- rtype = UHID_FEATURE_REPORT;
- break;
- case HID_OUTPUT_REPORT:
- rtype = UHID_OUTPUT_REPORT;
- break;
- default:
- return -EINVAL;
- }
- if (count < 1 || count > UHID_DATA_MAX)
- return -EINVAL;
- ev = kzalloc(sizeof(*ev), GFP_KERNEL);
- if (!ev)
- return -ENOMEM;
- ev->type = UHID_OUTPUT;
- ev->u.output.size = count;
- ev->u.output.rtype = rtype;
- memcpy(ev->u.output.data, buf, count);
- spin_lock_irqsave(&uhid->qlock, flags);
- uhid_queue(uhid, ev);
- spin_unlock_irqrestore(&uhid->qlock, flags);
- return count;
- }
- static struct hid_ll_driver uhid_hid_driver = {
- .start = uhid_hid_start,
- .stop = uhid_hid_stop,
- .open = uhid_hid_open,
- .close = uhid_hid_close,
- .hidinput_input_event = uhid_hid_input,
- .parse = uhid_hid_parse,
- };
- static int uhid_dev_create(struct uhid_device *uhid,
- const struct uhid_event *ev)
- {
- struct hid_device *hid;
- int ret;
- if (uhid->running)
- return -EALREADY;
- uhid->rd_size = ev->u.create.rd_size;
- if (uhid->rd_size <= 0 || uhid->rd_size > HID_MAX_DESCRIPTOR_SIZE)
- return -EINVAL;
- uhid->rd_data = kmalloc(uhid->rd_size, GFP_KERNEL);
- if (!uhid->rd_data)
- return -ENOMEM;
- if (copy_from_user(uhid->rd_data, ev->u.create.rd_data,
- uhid->rd_size)) {
- ret = -EFAULT;
- goto err_free;
- }
- hid = hid_allocate_device();
- if (IS_ERR(hid)) {
- ret = PTR_ERR(hid);
- goto err_free;
- }
- strncpy(hid->name, ev->u.create.name, 127);
- hid->name[127] = 0;
- strncpy(hid->phys, ev->u.create.phys, 63);
- hid->phys[63] = 0;
- strncpy(hid->uniq, ev->u.create.uniq, 63);
- hid->uniq[63] = 0;
- hid->ll_driver = &uhid_hid_driver;
- hid->hid_get_raw_report = uhid_hid_get_raw;
- hid->hid_output_raw_report = uhid_hid_output_raw;
- hid->bus = ev->u.create.bus;
- hid->vendor = ev->u.create.vendor;
- hid->product = ev->u.create.product;
- hid->version = ev->u.create.version;
- hid->country = ev->u.create.country;
- hid->driver_data = uhid;
- hid->dev.parent = uhid_misc.this_device;
- uhid->hid = hid;
- uhid->running = true;
- ret = hid_add_device(hid);
- if (ret) {
- hid_err(hid, "Cannot register HID device\n");
- goto err_hid;
- }
- return 0;
- err_hid:
- hid_destroy_device(hid);
- uhid->hid = NULL;
- uhid->running = false;
- err_free:
- kfree(uhid->rd_data);
- return ret;
- }
- static int uhid_dev_create2(struct uhid_device *uhid,
- const struct uhid_event *ev)
- {
- struct hid_device *hid;
- size_t rd_size, len;
- void *rd_data;
- int ret;
- if (uhid->running)
- return -EALREADY;
- rd_size = ev->u.create2.rd_size;
- if (rd_size <= 0 || rd_size > HID_MAX_DESCRIPTOR_SIZE)
- return -EINVAL;
- rd_data = kmemdup(ev->u.create2.rd_data, rd_size, GFP_KERNEL);
- if (!rd_data)
- return -ENOMEM;
- uhid->rd_size = rd_size;
- uhid->rd_data = rd_data;
- hid = hid_allocate_device();
- if (IS_ERR(hid)) {
- ret = PTR_ERR(hid);
- goto err_free;
- }
- len = min(sizeof(hid->name), sizeof(ev->u.create2.name)) - 1;
- strncpy(hid->name, ev->u.create2.name, len);
- len = min(sizeof(hid->phys), sizeof(ev->u.create2.phys)) - 1;
- strncpy(hid->phys, ev->u.create2.phys, len);
- len = min(sizeof(hid->uniq), sizeof(ev->u.create2.uniq)) - 1;
- strncpy(hid->uniq, ev->u.create2.uniq, len);
- hid->ll_driver = &uhid_hid_driver;
- hid->bus = ev->u.create2.bus;
- hid->vendor = ev->u.create2.vendor;
- hid->product = ev->u.create2.product;
- hid->version = ev->u.create2.version;
- hid->country = ev->u.create2.country;
- hid->driver_data = uhid;
- hid->dev.parent = uhid_misc.this_device;
- uhid->hid = hid;
- uhid->running = true;
- /* Adding of a HID device is done through a worker, to allow HID drivers
- * which use feature requests during .probe to work, without they would
- * be blocked on devlock, which is held by uhid_char_write.
- */
- schedule_work(&uhid->worker);
- return 0;
- err_free:
- kfree(uhid->rd_data);
- uhid->rd_data = NULL;
- uhid->rd_size = 0;
- return ret;
- }
- static int uhid_dev_destroy(struct uhid_device *uhid)
- {
- if (!uhid->running)
- return -EINVAL;
- uhid->running = false;
- wake_up_interruptible(&uhid->report_wait);
- cancel_work_sync(&uhid->worker);
- hid_destroy_device(uhid->hid);
- kfree(uhid->rd_data);
- return 0;
- }
- static int uhid_dev_input(struct uhid_device *uhid, struct uhid_event *ev)
- {
- if (!uhid->running)
- return -EINVAL;
- hid_input_report(uhid->hid, HID_INPUT_REPORT, ev->u.input.data,
- min_t(size_t, ev->u.input.size, UHID_DATA_MAX), 0);
- return 0;
- }
- static int uhid_dev_input2(struct uhid_device *uhid, struct uhid_event *ev)
- {
- if (!uhid->running)
- return -EINVAL;
- hid_input_report(uhid->hid, HID_INPUT_REPORT, ev->u.input2.data,
- min_t(size_t, ev->u.input2.size, UHID_DATA_MAX), 0);
- return 0;
- }
- static int uhid_dev_feature_answer(struct uhid_device *uhid,
- struct uhid_event *ev)
- {
- unsigned long flags;
- if (!uhid->running)
- return -EINVAL;
- spin_lock_irqsave(&uhid->qlock, flags);
- /* id for old report; drop it silently */
- if (uhid->report_id != ev->u.feature_answer.id)
- goto unlock;
- if (!uhid->report_running)
- goto unlock;
- memcpy(&uhid->report_buf, ev, sizeof(*ev));
- uhid->report_running = false;
- wake_up_interruptible(&uhid->report_wait);
- unlock:
- spin_unlock_irqrestore(&uhid->qlock, flags);
- return 0;
- }
- static int uhid_char_open(struct inode *inode, struct file *file)
- {
- struct uhid_device *uhid;
- uhid = kzalloc(sizeof(*uhid), GFP_KERNEL);
- if (!uhid)
- return -ENOMEM;
- mutex_init(&uhid->devlock);
- mutex_init(&uhid->report_lock);
- spin_lock_init(&uhid->qlock);
- init_waitqueue_head(&uhid->waitq);
- init_waitqueue_head(&uhid->report_wait);
- uhid->running = false;
- INIT_WORK(&uhid->worker, uhid_device_add_worker);
- file->private_data = uhid;
- nonseekable_open(inode, file);
- return 0;
- }
- static int uhid_char_release(struct inode *inode, struct file *file)
- {
- struct uhid_device *uhid = file->private_data;
- unsigned int i;
- uhid_dev_destroy(uhid);
- for (i = 0; i < UHID_BUFSIZE; ++i)
- kfree(uhid->outq[i]);
- kfree(uhid);
- return 0;
- }
- static ssize_t uhid_char_read(struct file *file, char __user *buffer,
- size_t count, loff_t *ppos)
- {
- struct uhid_device *uhid = file->private_data;
- int ret;
- unsigned long flags;
- size_t len;
- /* they need at least the "type" member of uhid_event */
- if (count < sizeof(__u32))
- return -EINVAL;
- try_again:
- if (file->f_flags & O_NONBLOCK) {
- if (uhid->head == uhid->tail)
- return -EAGAIN;
- } else {
- ret = wait_event_interruptible(uhid->waitq,
- uhid->head != uhid->tail);
- if (ret)
- return ret;
- }
- ret = mutex_lock_interruptible(&uhid->devlock);
- if (ret)
- return ret;
- if (uhid->head == uhid->tail) {
- mutex_unlock(&uhid->devlock);
- goto try_again;
- } else {
- len = min(count, sizeof(**uhid->outq));
- if (copy_to_user(buffer, uhid->outq[uhid->tail], len)) {
- ret = -EFAULT;
- } else {
- kfree(uhid->outq[uhid->tail]);
- uhid->outq[uhid->tail] = NULL;
- spin_lock_irqsave(&uhid->qlock, flags);
- uhid->tail = (uhid->tail + 1) % UHID_BUFSIZE;
- spin_unlock_irqrestore(&uhid->qlock, flags);
- }
- }
- mutex_unlock(&uhid->devlock);
- return ret ? ret : len;
- }
- static ssize_t uhid_char_write(struct file *file, const char __user *buffer,
- size_t count, loff_t *ppos)
- {
- struct uhid_device *uhid = file->private_data;
- int ret;
- size_t len;
- /* we need at least the "type" member of uhid_event */
- if (count < sizeof(__u32))
- return -EINVAL;
- ret = mutex_lock_interruptible(&uhid->devlock);
- if (ret)
- return ret;
- memset(&uhid->input_buf, 0, sizeof(uhid->input_buf));
- len = min(count, sizeof(uhid->input_buf));
- if (copy_from_user(&uhid->input_buf, buffer, len)) {
- ret = -EFAULT;
- goto unlock;
- }
- switch (uhid->input_buf.type) {
- case UHID_CREATE:
- ret = uhid_dev_create(uhid, &uhid->input_buf);
- break;
- case UHID_CREATE2:
- ret = uhid_dev_create2(uhid, &uhid->input_buf);
- break;
- case UHID_DESTROY:
- ret = uhid_dev_destroy(uhid);
- break;
- case UHID_INPUT:
- ret = uhid_dev_input(uhid, &uhid->input_buf);
- break;
- case UHID_INPUT2:
- ret = uhid_dev_input2(uhid, &uhid->input_buf);
- break;
- case UHID_FEATURE_ANSWER:
- ret = uhid_dev_feature_answer(uhid, &uhid->input_buf);
- break;
- default:
- ret = -EOPNOTSUPP;
- }
- unlock:
- mutex_unlock(&uhid->devlock);
- /* return "count" not "len" to not confuse the caller */
- return ret ? ret : count;
- }
- static unsigned int uhid_char_poll(struct file *file, poll_table *wait)
- {
- struct uhid_device *uhid = file->private_data;
- unsigned int mask = POLLOUT | POLLWRNORM; /* uhid is always writable */
- poll_wait(file, &uhid->waitq, wait);
- if (uhid->head != uhid->tail)
- mask |= POLLIN | POLLRDNORM;
- return mask;
- }
- static const struct file_operations uhid_fops = {
- .owner = THIS_MODULE,
- .open = uhid_char_open,
- .release = uhid_char_release,
- .read = uhid_char_read,
- .write = uhid_char_write,
- .poll = uhid_char_poll,
- .llseek = no_llseek,
- };
- static struct miscdevice uhid_misc = {
- .fops = &uhid_fops,
- .minor = MISC_DYNAMIC_MINOR,
- .name = UHID_NAME,
- };
- static int __init uhid_init(void)
- {
- fb_register_client(&fb_block);
- return misc_register(&uhid_misc);
- }
- static void __exit uhid_exit(void)
- {
- fb_unregister_client(&fb_block);
- misc_deregister(&uhid_misc);
- }
- module_init(uhid_init);
- module_exit(uhid_exit);
- MODULE_LICENSE("GPL");
- MODULE_AUTHOR("David Herrmann <dh.herrmann@gmail.com>");
- MODULE_DESCRIPTION("User-space I/O driver support for HID subsystem");
|