3 * Intel Management Engine Interface (Intel MEI) Linux driver
4 * Copyright (c) 2003-2012, Intel Corporation.
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms and conditions of the GNU General Public License,
8 * version 2, as published by the Free Software Foundation.
10 * This program is distributed in the hope it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
16 #include <linux/module.h>
17 #include <linux/moduleparam.h>
18 #include <linux/kernel.h>
19 #include <linux/device.h>
20 #include <linux/slab.h>
22 #include <linux/errno.h>
23 #include <linux/types.h>
24 #include <linux/fcntl.h>
25 #include <linux/poll.h>
26 #include <linux/init.h>
27 #include <linux/ioctl.h>
28 #include <linux/cdev.h>
29 #include <linux/sched.h>
30 #include <linux/uuid.h>
31 #include <linux/compat.h>
32 #include <linux/jiffies.h>
33 #include <linux/interrupt.h>
35 #include <linux/mei.h>
41 * mei_open - the open function
43 * @inode: pointer to inode structure
44 * @file: pointer to file structure
46 * Return: 0 on success, <0 on error
48 static int mei_open(struct inode *inode, struct file *file)
50 struct mei_device *dev;
55 dev = container_of(inode->i_cdev, struct mei_device, cdev);
59 mutex_lock(&dev->device_lock);
61 if (dev->dev_state != MEI_DEV_ENABLED) {
62 dev_dbg(dev->dev, "dev_state != MEI_ENABLED dev_state = %s\n",
63 mei_dev_state_str(dev->dev_state));
68 cl = mei_cl_alloc_linked(dev);
74 file->private_data = cl;
76 mutex_unlock(&dev->device_lock);
78 return nonseekable_open(inode, file);
81 mutex_unlock(&dev->device_lock);
86 * mei_release - the release function
88 * @inode: pointer to inode structure
89 * @file: pointer to file structure
91 * Return: 0 on success, <0 on error
93 static int mei_release(struct inode *inode, struct file *file)
95 struct mei_cl *cl = file->private_data;
96 struct mei_device *dev;
99 if (WARN_ON(!cl || !cl->dev))
104 mutex_lock(&dev->device_lock);
105 if (cl == &dev->iamthif_cl) {
106 rets = mei_amthif_release(dev, file);
109 rets = mei_cl_disconnect(cl);
111 mei_cl_flush_queues(cl, file);
112 cl_dbg(dev, cl, "removing\n");
116 file->private_data = NULL;
120 mutex_unlock(&dev->device_lock);
126 * mei_read - the read function.
128 * @file: pointer to file structure
129 * @ubuf: pointer to user buffer
130 * @length: buffer length
131 * @offset: data offset in buffer
133 * Return: >=0 data length on success , <0 on error
135 static ssize_t mei_read(struct file *file, char __user *ubuf,
136 size_t length, loff_t *offset)
138 struct mei_cl *cl = file->private_data;
139 struct mei_device *dev;
140 struct mei_cl_cb *cb = NULL;
145 if (WARN_ON(!cl || !cl->dev))
151 mutex_lock(&dev->device_lock);
152 if (dev->dev_state != MEI_DEV_ENABLED) {
167 if (cl == &dev->iamthif_cl) {
168 rets = mei_amthif_read(dev, file, ubuf, length, offset);
172 cb = mei_cl_read_cb(cl, file);
179 err = mei_cl_read_start(cl, length, file);
180 if (err && err != -EBUSY) {
181 cl_dbg(dev, cl, "mei start read failure status = %d\n", err);
186 if (list_empty(&cl->rd_completed) && !waitqueue_active(&cl->rx_wait)) {
187 if (file->f_flags & O_NONBLOCK) {
192 mutex_unlock(&dev->device_lock);
194 if (wait_event_interruptible(cl->rx_wait,
195 (!list_empty(&cl->rd_completed)) ||
196 (!mei_cl_is_connected(cl)))) {
198 if (signal_pending(current))
203 mutex_lock(&dev->device_lock);
204 if (!mei_cl_is_connected(cl)) {
210 cb = mei_cl_read_cb(cl, file);
217 /* now copy the data to user space */
220 cl_dbg(dev, cl, "read operation failed %d\n", rets);
224 cl_dbg(dev, cl, "buf.size = %zu buf.idx = %zu offset = %lld\n",
225 cb->buf.size, cb->buf_idx, *offset);
226 if (*offset >= cb->buf_idx) {
231 /* length is being truncated to PAGE_SIZE,
232 * however buf_idx may point beyond that */
233 length = min_t(size_t, length, cb->buf_idx - *offset);
235 if (copy_to_user(ubuf, cb->buf.data + *offset, length)) {
236 dev_dbg(dev->dev, "failed to copy data to userland\n");
243 /* not all data was read, keep the cb */
244 if (*offset < cb->buf_idx)
252 cl_dbg(dev, cl, "end mei read rets = %d\n", rets);
253 mutex_unlock(&dev->device_lock);
257 * mei_write - the write function.
259 * @file: pointer to file structure
260 * @ubuf: pointer to user buffer
261 * @length: buffer length
262 * @offset: data offset in buffer
264 * Return: >=0 data length on success , <0 on error
266 static ssize_t mei_write(struct file *file, const char __user *ubuf,
267 size_t length, loff_t *offset)
269 struct mei_cl *cl = file->private_data;
270 struct mei_cl_cb *cb;
271 struct mei_device *dev;
274 if (WARN_ON(!cl || !cl->dev))
279 mutex_lock(&dev->device_lock);
281 if (dev->dev_state != MEI_DEV_ENABLED) {
286 if (!mei_cl_is_connected(cl)) {
287 cl_err(dev, cl, "is not connected");
292 if (!mei_me_cl_is_active(cl->me_cl)) {
297 if (length > mei_cl_mtu(cl)) {
308 cb = mei_cl_alloc_cb(cl, length, MEI_FOP_WRITE, file);
314 rets = copy_from_user(cb->buf.data, ubuf, length);
316 dev_dbg(dev->dev, "failed to copy data from userland\n");
322 if (cl == &dev->iamthif_cl) {
323 rets = mei_amthif_write(cl, cb);
329 rets = mei_cl_write(cl, cb, false);
331 mutex_unlock(&dev->device_lock);
336 * mei_ioctl_connect_client - the connect to fw client IOCTL function
338 * @file: private data of the file object
339 * @data: IOCTL connect data, input and output parameters
341 * Locking: called under "dev->device_lock" lock
343 * Return: 0 on success, <0 on failure.
345 static int mei_ioctl_connect_client(struct file *file,
346 struct mei_connect_client_data *data)
348 struct mei_device *dev;
349 struct mei_client *client;
350 struct mei_me_client *me_cl;
354 cl = file->private_data;
357 if (dev->dev_state != MEI_DEV_ENABLED)
360 if (cl->state != MEI_FILE_INITIALIZING &&
361 cl->state != MEI_FILE_DISCONNECTED)
364 /* find ME client we're trying to connect to */
365 me_cl = mei_me_cl_by_uuid(dev, &data->in_client_uuid);
367 dev_dbg(dev->dev, "Cannot connect to FW Client UUID = %pUl\n",
368 &data->in_client_uuid);
373 if (me_cl->props.fixed_address) {
374 bool forbidden = dev->override_fixed_address ?
375 !dev->allow_fixed_address : !dev->hbm_f_fa_supported;
377 dev_dbg(dev->dev, "Connection forbidden to FW Client UUID = %pUl\n",
378 &data->in_client_uuid);
384 dev_dbg(dev->dev, "Connect to FW Client ID = %d\n",
386 dev_dbg(dev->dev, "FW Client - Protocol Version = %d\n",
387 me_cl->props.protocol_version);
388 dev_dbg(dev->dev, "FW Client - Max Msg Len = %d\n",
389 me_cl->props.max_msg_length);
391 /* if we're connecting to amthif client then we will use the
392 * existing connection
394 if (uuid_le_cmp(data->in_client_uuid, mei_amthif_guid) == 0) {
395 dev_dbg(dev->dev, "FW Client is amthi\n");
396 if (!mei_cl_is_connected(&dev->iamthif_cl)) {
404 dev->iamthif_open_count++;
405 file->private_data = &dev->iamthif_cl;
407 client = &data->out_client_properties;
408 client->max_msg_length = me_cl->props.max_msg_length;
409 client->protocol_version = me_cl->props.protocol_version;
410 rets = dev->iamthif_cl.status;
415 /* prepare the output buffer */
416 client = &data->out_client_properties;
417 client->max_msg_length = me_cl->props.max_msg_length;
418 client->protocol_version = me_cl->props.protocol_version;
419 dev_dbg(dev->dev, "Can connect?\n");
421 rets = mei_cl_connect(cl, me_cl, file);
424 mei_me_cl_put(me_cl);
429 * mei_ioctl_client_notify_request -
430 * propagate event notification request to client
432 * @file: pointer to file structure
433 * @request: 0 - disable, 1 - enable
435 * Return: 0 on success , <0 on error
437 static int mei_ioctl_client_notify_request(const struct file *file, u32 request)
439 struct mei_cl *cl = file->private_data;
441 if (request != MEI_HBM_NOTIFICATION_START &&
442 request != MEI_HBM_NOTIFICATION_STOP)
445 return mei_cl_notify_request(cl, file, (u8)request);
449 * mei_ioctl_client_notify_get - wait for notification request
451 * @file: pointer to file structure
452 * @notify_get: 0 - disable, 1 - enable
454 * Return: 0 on success , <0 on error
456 static int mei_ioctl_client_notify_get(const struct file *file, u32 *notify_get)
458 struct mei_cl *cl = file->private_data;
460 bool block = (file->f_flags & O_NONBLOCK) == 0;
463 rets = mei_cl_notify_get(cl, block, ¬ify_ev);
467 *notify_get = notify_ev ? 1 : 0;
472 * mei_ioctl - the IOCTL function
474 * @file: pointer to file structure
475 * @cmd: ioctl command
476 * @data: pointer to mei message structure
478 * Return: 0 on success , <0 on error
480 static long mei_ioctl(struct file *file, unsigned int cmd, unsigned long data)
482 struct mei_device *dev;
483 struct mei_cl *cl = file->private_data;
484 struct mei_connect_client_data connect_data;
485 u32 notify_get, notify_req;
489 if (WARN_ON(!cl || !cl->dev))
494 dev_dbg(dev->dev, "IOCTL cmd = 0x%x", cmd);
496 mutex_lock(&dev->device_lock);
497 if (dev->dev_state != MEI_DEV_ENABLED) {
503 case IOCTL_MEI_CONNECT_CLIENT:
504 dev_dbg(dev->dev, ": IOCTL_MEI_CONNECT_CLIENT.\n");
505 if (copy_from_user(&connect_data, (char __user *)data,
506 sizeof(struct mei_connect_client_data))) {
507 dev_dbg(dev->dev, "failed to copy data from userland\n");
512 rets = mei_ioctl_connect_client(file, &connect_data);
516 /* if all is ok, copying the data back to user. */
517 if (copy_to_user((char __user *)data, &connect_data,
518 sizeof(struct mei_connect_client_data))) {
519 dev_dbg(dev->dev, "failed to copy data to userland\n");
526 case IOCTL_MEI_NOTIFY_SET:
527 dev_dbg(dev->dev, ": IOCTL_MEI_NOTIFY_SET.\n");
528 if (copy_from_user(¬ify_req,
529 (char __user *)data, sizeof(notify_req))) {
530 dev_dbg(dev->dev, "failed to copy data from userland\n");
534 rets = mei_ioctl_client_notify_request(file, notify_req);
537 case IOCTL_MEI_NOTIFY_GET:
538 dev_dbg(dev->dev, ": IOCTL_MEI_NOTIFY_GET.\n");
539 rets = mei_ioctl_client_notify_get(file, ¬ify_get);
543 dev_dbg(dev->dev, "copy connect data to user\n");
544 if (copy_to_user((char __user *)data,
545 ¬ify_get, sizeof(notify_get))) {
546 dev_dbg(dev->dev, "failed to copy data to userland\n");
554 dev_err(dev->dev, ": unsupported ioctl %d.\n", cmd);
559 mutex_unlock(&dev->device_lock);
564 * mei_compat_ioctl - the compat IOCTL function
566 * @file: pointer to file structure
567 * @cmd: ioctl command
568 * @data: pointer to mei message structure
570 * Return: 0 on success , <0 on error
573 static long mei_compat_ioctl(struct file *file,
574 unsigned int cmd, unsigned long data)
576 return mei_ioctl(file, cmd, (unsigned long)compat_ptr(data));
582 * mei_poll - the poll function
584 * @file: pointer to file structure
585 * @wait: pointer to poll_table structure
589 static unsigned int mei_poll(struct file *file, poll_table *wait)
591 unsigned long req_events = poll_requested_events(wait);
592 struct mei_cl *cl = file->private_data;
593 struct mei_device *dev;
594 unsigned int mask = 0;
597 if (WARN_ON(!cl || !cl->dev))
602 mutex_lock(&dev->device_lock);
604 notify_en = cl->notify_en && (req_events & POLLPRI);
606 if (dev->dev_state != MEI_DEV_ENABLED ||
607 !mei_cl_is_connected(cl)) {
612 if (cl == &dev->iamthif_cl) {
613 mask = mei_amthif_poll(dev, file, wait);
618 poll_wait(file, &cl->ev_wait, wait);
623 if (req_events & (POLLIN | POLLRDNORM)) {
624 poll_wait(file, &cl->rx_wait, wait);
626 if (!list_empty(&cl->rd_completed))
627 mask |= POLLIN | POLLRDNORM;
629 mei_cl_read_start(cl, 0, file);
633 mutex_unlock(&dev->device_lock);
638 * mei_fasync - asynchronous io support
640 * @fd: file descriptor
641 * @file: pointer to file structure
644 * Return: negative on error,
645 * 0 if it did no changes,
646 * and positive a process was added or deleted
648 static int mei_fasync(int fd, struct file *file, int band)
651 struct mei_cl *cl = file->private_data;
653 if (!mei_cl_is_connected(cl))
656 return fasync_helper(fd, file, band, &cl->ev_async);
660 * fw_status_show - mei device attribute show method
662 * @device: device pointer
663 * @attr: attribute pointer
664 * @buf: char out buffer
666 * Return: number of the bytes printed into buf or error
668 static ssize_t fw_status_show(struct device *device,
669 struct device_attribute *attr, char *buf)
671 struct mei_device *dev = dev_get_drvdata(device);
672 struct mei_fw_status fw_status;
676 mutex_lock(&dev->device_lock);
677 err = mei_fw_status(dev, &fw_status);
678 mutex_unlock(&dev->device_lock);
680 dev_err(device, "read fw_status error = %d\n", err);
684 for (i = 0; i < fw_status.count; i++)
685 cnt += scnprintf(buf + cnt, PAGE_SIZE - cnt, "%08X\n",
686 fw_status.status[i]);
689 static DEVICE_ATTR_RO(fw_status);
691 static struct attribute *mei_attrs[] = {
692 &dev_attr_fw_status.attr,
695 ATTRIBUTE_GROUPS(mei);
698 * file operations structure will be used for mei char device.
700 static const struct file_operations mei_fops = {
701 .owner = THIS_MODULE,
703 .unlocked_ioctl = mei_ioctl,
705 .compat_ioctl = mei_compat_ioctl,
708 .release = mei_release,
711 .fasync = mei_fasync,
715 static struct class *mei_class;
716 static dev_t mei_devt;
717 #define MEI_MAX_DEVS MINORMASK
718 static DEFINE_MUTEX(mei_minor_lock);
719 static DEFINE_IDR(mei_idr);
722 * mei_minor_get - obtain next free device minor number
724 * @dev: device pointer
726 * Return: allocated minor, or -ENOSPC if no free minor left
728 static int mei_minor_get(struct mei_device *dev)
732 mutex_lock(&mei_minor_lock);
733 ret = idr_alloc(&mei_idr, dev, 0, MEI_MAX_DEVS, GFP_KERNEL);
736 else if (ret == -ENOSPC)
737 dev_err(dev->dev, "too many mei devices\n");
739 mutex_unlock(&mei_minor_lock);
744 * mei_minor_free - mark device minor number as free
746 * @dev: device pointer
748 static void mei_minor_free(struct mei_device *dev)
750 mutex_lock(&mei_minor_lock);
751 idr_remove(&mei_idr, dev->minor);
752 mutex_unlock(&mei_minor_lock);
755 int mei_register(struct mei_device *dev, struct device *parent)
757 struct device *clsdev; /* class device */
760 ret = mei_minor_get(dev);
764 /* Fill in the data structures */
765 devno = MKDEV(MAJOR(mei_devt), dev->minor);
766 cdev_init(&dev->cdev, &mei_fops);
767 dev->cdev.owner = parent->driver->owner;
770 ret = cdev_add(&dev->cdev, devno, 1);
772 dev_err(parent, "unable to add device %d:%d\n",
773 MAJOR(mei_devt), dev->minor);
777 clsdev = device_create_with_groups(mei_class, parent, devno,
779 "mei%d", dev->minor);
781 if (IS_ERR(clsdev)) {
782 dev_err(parent, "unable to create device %d:%d\n",
783 MAJOR(mei_devt), dev->minor);
784 ret = PTR_ERR(clsdev);
788 ret = mei_dbgfs_register(dev, dev_name(clsdev));
790 dev_err(clsdev, "cannot register debugfs ret = %d\n", ret);
797 device_destroy(mei_class, devno);
799 cdev_del(&dev->cdev);
804 EXPORT_SYMBOL_GPL(mei_register);
806 void mei_deregister(struct mei_device *dev)
810 devno = dev->cdev.dev;
811 cdev_del(&dev->cdev);
813 mei_dbgfs_deregister(dev);
815 device_destroy(mei_class, devno);
819 EXPORT_SYMBOL_GPL(mei_deregister);
821 static int __init mei_init(void)
825 mei_class = class_create(THIS_MODULE, "mei");
826 if (IS_ERR(mei_class)) {
827 pr_err("couldn't create class\n");
828 ret = PTR_ERR(mei_class);
832 ret = alloc_chrdev_region(&mei_devt, 0, MEI_MAX_DEVS, "mei");
834 pr_err("unable to allocate char dev region\n");
838 ret = mei_cl_bus_init();
840 pr_err("unable to initialize bus\n");
847 unregister_chrdev_region(mei_devt, MEI_MAX_DEVS);
849 class_destroy(mei_class);
854 static void __exit mei_exit(void)
856 unregister_chrdev_region(mei_devt, MEI_MAX_DEVS);
857 class_destroy(mei_class);
861 module_init(mei_init);
862 module_exit(mei_exit);
864 MODULE_AUTHOR("Intel Corporation");
865 MODULE_DESCRIPTION("Intel(R) Management Engine Interface");
866 MODULE_LICENSE("GPL v2");