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
, MEI_HOST_CLIENT_ID_ANY
);
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
) {
162 if (cl
== &dev
->iamthif_cl
) {
163 rets
= mei_amthif_read(dev
, file
, ubuf
, length
, offset
);
167 cb
= mei_cl_read_cb(cl
, file
);
170 if (cb
->buf_idx
> *offset
)
172 /* offset is beyond buf_idx we have no more data return 0 */
173 if (cb
->buf_idx
> 0 && cb
->buf_idx
<= *offset
) {
177 /* Offset needs to be cleaned for contiguous reads*/
178 if (cb
->buf_idx
== 0 && *offset
> 0)
180 } else if (*offset
> 0) {
184 err
= mei_cl_read_start(cl
, length
, file
);
185 if (err
&& err
!= -EBUSY
) {
186 cl_dbg(dev
, cl
, "mei start read failure status = %d\n", err
);
191 if (list_empty(&cl
->rd_completed
) && !waitqueue_active(&cl
->rx_wait
)) {
192 if (file
->f_flags
& O_NONBLOCK
) {
197 mutex_unlock(&dev
->device_lock
);
199 if (wait_event_interruptible(cl
->rx_wait
,
200 (!list_empty(&cl
->rd_completed
)) ||
201 (!mei_cl_is_connected(cl
)))) {
203 if (signal_pending(current
))
208 mutex_lock(&dev
->device_lock
);
209 if (!mei_cl_is_connected(cl
)) {
215 cb
= mei_cl_read_cb(cl
, file
);
217 if (mei_cl_is_fixed_address(cl
) && dev
->allow_fixed_address
) {
218 cb
= mei_cl_read_cb(cl
, NULL
);
227 /* now copy the data to user space */
230 cl_dbg(dev
, cl
, "read operation failed %d\n", rets
);
234 cl_dbg(dev
, cl
, "buf.size = %d buf.idx = %ld\n",
235 cb
->buf
.size
, cb
->buf_idx
);
236 if (length
== 0 || ubuf
== NULL
|| *offset
> cb
->buf_idx
) {
241 /* length is being truncated to PAGE_SIZE,
242 * however buf_idx may point beyond that */
243 length
= min_t(size_t, length
, cb
->buf_idx
- *offset
);
245 if (copy_to_user(ubuf
, cb
->buf
.data
+ *offset
, length
)) {
246 dev_dbg(dev
->dev
, "failed to copy data to userland\n");
253 if ((unsigned long)*offset
< cb
->buf_idx
)
260 cl_dbg(dev
, cl
, "end mei read rets = %d\n", rets
);
261 mutex_unlock(&dev
->device_lock
);
265 * mei_write - the write function.
267 * @file: pointer to file structure
268 * @ubuf: pointer to user buffer
269 * @length: buffer length
270 * @offset: data offset in buffer
272 * Return: >=0 data length on success , <0 on error
274 static ssize_t
mei_write(struct file
*file
, const char __user
*ubuf
,
275 size_t length
, loff_t
*offset
)
277 struct mei_cl
*cl
= file
->private_data
;
278 struct mei_cl_cb
*write_cb
= NULL
;
279 struct mei_device
*dev
;
280 unsigned long timeout
= 0;
283 if (WARN_ON(!cl
|| !cl
->dev
))
288 mutex_lock(&dev
->device_lock
);
290 if (dev
->dev_state
!= MEI_DEV_ENABLED
) {
295 if (!mei_cl_is_connected(cl
)) {
296 cl_err(dev
, cl
, "is not connected");
301 if (!mei_me_cl_is_active(cl
->me_cl
)) {
306 if (length
> mei_cl_mtu(cl
)) {
316 if (cl
== &dev
->iamthif_cl
) {
317 write_cb
= mei_amthif_find_read_list_entry(dev
, file
);
320 timeout
= write_cb
->read_time
+
321 mei_secs_to_jiffies(MEI_IAMTHIF_READ_TIMER
);
323 if (time_after(jiffies
, timeout
)) {
325 mei_io_cb_free(write_cb
);
332 write_cb
= mei_cl_alloc_cb(cl
, length
, MEI_FOP_WRITE
, file
);
338 rets
= copy_from_user(write_cb
->buf
.data
, ubuf
, length
);
340 dev_dbg(dev
->dev
, "failed to copy data from userland\n");
345 if (cl
== &dev
->iamthif_cl
) {
346 rets
= mei_amthif_write(cl
, write_cb
);
350 "amthif write failed with status = %d\n", rets
);
353 mutex_unlock(&dev
->device_lock
);
357 rets
= mei_cl_write(cl
, write_cb
, false);
359 mutex_unlock(&dev
->device_lock
);
361 mei_io_cb_free(write_cb
);
366 * mei_ioctl_connect_client - the connect to fw client IOCTL function
368 * @file: private data of the file object
369 * @data: IOCTL connect data, input and output parameters
371 * Locking: called under "dev->device_lock" lock
373 * Return: 0 on success, <0 on failure.
375 static int mei_ioctl_connect_client(struct file
*file
,
376 struct mei_connect_client_data
*data
)
378 struct mei_device
*dev
;
379 struct mei_client
*client
;
380 struct mei_me_client
*me_cl
;
384 cl
= file
->private_data
;
387 if (dev
->dev_state
!= MEI_DEV_ENABLED
)
390 if (cl
->state
!= MEI_FILE_INITIALIZING
&&
391 cl
->state
!= MEI_FILE_DISCONNECTED
)
394 /* find ME client we're trying to connect to */
395 me_cl
= mei_me_cl_by_uuid(dev
, &data
->in_client_uuid
);
397 (me_cl
->props
.fixed_address
&& !dev
->allow_fixed_address
)) {
398 dev_dbg(dev
->dev
, "Cannot connect to FW Client UUID = %pUl\n",
399 &data
->in_client_uuid
);
400 mei_me_cl_put(me_cl
);
404 dev_dbg(dev
->dev
, "Connect to FW Client ID = %d\n",
406 dev_dbg(dev
->dev
, "FW Client - Protocol Version = %d\n",
407 me_cl
->props
.protocol_version
);
408 dev_dbg(dev
->dev
, "FW Client - Max Msg Len = %d\n",
409 me_cl
->props
.max_msg_length
);
411 /* if we're connecting to amthif client then we will use the
412 * existing connection
414 if (uuid_le_cmp(data
->in_client_uuid
, mei_amthif_guid
) == 0) {
415 dev_dbg(dev
->dev
, "FW Client is amthi\n");
416 if (!mei_cl_is_connected(&dev
->iamthif_cl
)) {
424 dev
->iamthif_open_count
++;
425 file
->private_data
= &dev
->iamthif_cl
;
427 client
= &data
->out_client_properties
;
428 client
->max_msg_length
= me_cl
->props
.max_msg_length
;
429 client
->protocol_version
= me_cl
->props
.protocol_version
;
430 rets
= dev
->iamthif_cl
.status
;
435 /* prepare the output buffer */
436 client
= &data
->out_client_properties
;
437 client
->max_msg_length
= me_cl
->props
.max_msg_length
;
438 client
->protocol_version
= me_cl
->props
.protocol_version
;
439 dev_dbg(dev
->dev
, "Can connect?\n");
441 rets
= mei_cl_connect(cl
, me_cl
, file
);
444 mei_me_cl_put(me_cl
);
449 * mei_ioctl_client_notify_request -
450 * propagate event notification request to client
452 * @file: pointer to file structure
453 * @request: 0 - disable, 1 - enable
455 * Return: 0 on success , <0 on error
457 static int mei_ioctl_client_notify_request(struct file
*file
, u32 request
)
459 struct mei_cl
*cl
= file
->private_data
;
461 if (request
!= MEI_HBM_NOTIFICATION_START
&&
462 request
!= MEI_HBM_NOTIFICATION_STOP
)
465 return mei_cl_notify_request(cl
, file
, (u8
)request
);
469 * mei_ioctl_client_notify_get - wait for notification request
471 * @file: pointer to file structure
472 * @notify_get: 0 - disable, 1 - enable
474 * Return: 0 on success , <0 on error
476 static int mei_ioctl_client_notify_get(struct file
*file
, u32
*notify_get
)
478 struct mei_cl
*cl
= file
->private_data
;
480 bool block
= (file
->f_flags
& O_NONBLOCK
) == 0;
483 rets
= mei_cl_notify_get(cl
, block
, ¬ify_ev
);
487 *notify_get
= notify_ev
? 1 : 0;
492 * mei_ioctl - the IOCTL function
494 * @file: pointer to file structure
495 * @cmd: ioctl command
496 * @data: pointer to mei message structure
498 * Return: 0 on success , <0 on error
500 static long mei_ioctl(struct file
*file
, unsigned int cmd
, unsigned long data
)
502 struct mei_device
*dev
;
503 struct mei_cl
*cl
= file
->private_data
;
504 struct mei_connect_client_data connect_data
;
505 u32 notify_get
, notify_req
;
509 if (WARN_ON(!cl
|| !cl
->dev
))
514 dev_dbg(dev
->dev
, "IOCTL cmd = 0x%x", cmd
);
516 mutex_lock(&dev
->device_lock
);
517 if (dev
->dev_state
!= MEI_DEV_ENABLED
) {
523 case IOCTL_MEI_CONNECT_CLIENT
:
524 dev_dbg(dev
->dev
, ": IOCTL_MEI_CONNECT_CLIENT.\n");
525 if (copy_from_user(&connect_data
, (char __user
*)data
,
526 sizeof(struct mei_connect_client_data
))) {
527 dev_dbg(dev
->dev
, "failed to copy data from userland\n");
532 rets
= mei_ioctl_connect_client(file
, &connect_data
);
536 /* if all is ok, copying the data back to user. */
537 if (copy_to_user((char __user
*)data
, &connect_data
,
538 sizeof(struct mei_connect_client_data
))) {
539 dev_dbg(dev
->dev
, "failed to copy data to userland\n");
546 case IOCTL_MEI_NOTIFY_SET
:
547 dev_dbg(dev
->dev
, ": IOCTL_MEI_NOTIFY_SET.\n");
548 if (copy_from_user(¬ify_req
,
549 (char __user
*)data
, sizeof(notify_req
))) {
550 dev_dbg(dev
->dev
, "failed to copy data from userland\n");
554 rets
= mei_ioctl_client_notify_request(file
, notify_req
);
557 case IOCTL_MEI_NOTIFY_GET
:
558 dev_dbg(dev
->dev
, ": IOCTL_MEI_NOTIFY_GET.\n");
559 rets
= mei_ioctl_client_notify_get(file
, ¬ify_get
);
563 dev_dbg(dev
->dev
, "copy connect data to user\n");
564 if (copy_to_user((char __user
*)data
,
565 ¬ify_get
, sizeof(notify_get
))) {
566 dev_dbg(dev
->dev
, "failed to copy data to userland\n");
578 mutex_unlock(&dev
->device_lock
);
583 * mei_compat_ioctl - the compat IOCTL function
585 * @file: pointer to file structure
586 * @cmd: ioctl command
587 * @data: pointer to mei message structure
589 * Return: 0 on success , <0 on error
592 static long mei_compat_ioctl(struct file
*file
,
593 unsigned int cmd
, unsigned long data
)
595 return mei_ioctl(file
, cmd
, (unsigned long)compat_ptr(data
));
601 * mei_poll - the poll function
603 * @file: pointer to file structure
604 * @wait: pointer to poll_table structure
608 static unsigned int mei_poll(struct file
*file
, poll_table
*wait
)
610 unsigned long req_events
= poll_requested_events(wait
);
611 struct mei_cl
*cl
= file
->private_data
;
612 struct mei_device
*dev
;
613 unsigned int mask
= 0;
616 if (WARN_ON(!cl
|| !cl
->dev
))
621 mutex_lock(&dev
->device_lock
);
623 notify_en
= cl
->notify_en
&& (req_events
& POLLPRI
);
625 if (dev
->dev_state
!= MEI_DEV_ENABLED
||
626 !mei_cl_is_connected(cl
)) {
631 if (cl
== &dev
->iamthif_cl
) {
632 mask
= mei_amthif_poll(dev
, file
, wait
);
637 poll_wait(file
, &cl
->ev_wait
, wait
);
642 if (req_events
& (POLLIN
| POLLRDNORM
)) {
643 poll_wait(file
, &cl
->rx_wait
, wait
);
645 if (!list_empty(&cl
->rd_completed
))
646 mask
|= POLLIN
| POLLRDNORM
;
648 mei_cl_read_start(cl
, 0, file
);
652 mutex_unlock(&dev
->device_lock
);
657 * mei_fasync - asynchronous io support
659 * @fd: file descriptor
660 * @file: pointer to file structure
663 * Return: negative on error,
664 * 0 if it did no changes,
665 * and positive a process was added or deleted
667 static int mei_fasync(int fd
, struct file
*file
, int band
)
670 struct mei_cl
*cl
= file
->private_data
;
672 if (!mei_cl_is_connected(cl
))
675 return fasync_helper(fd
, file
, band
, &cl
->ev_async
);
679 * fw_status_show - mei device attribute show method
681 * @device: device pointer
682 * @attr: attribute pointer
683 * @buf: char out buffer
685 * Return: number of the bytes printed into buf or error
687 static ssize_t
fw_status_show(struct device
*device
,
688 struct device_attribute
*attr
, char *buf
)
690 struct mei_device
*dev
= dev_get_drvdata(device
);
691 struct mei_fw_status fw_status
;
695 mutex_lock(&dev
->device_lock
);
696 err
= mei_fw_status(dev
, &fw_status
);
697 mutex_unlock(&dev
->device_lock
);
699 dev_err(device
, "read fw_status error = %d\n", err
);
703 for (i
= 0; i
< fw_status
.count
; i
++)
704 cnt
+= scnprintf(buf
+ cnt
, PAGE_SIZE
- cnt
, "%08X\n",
705 fw_status
.status
[i
]);
708 static DEVICE_ATTR_RO(fw_status
);
710 static struct attribute
*mei_attrs
[] = {
711 &dev_attr_fw_status
.attr
,
714 ATTRIBUTE_GROUPS(mei
);
717 * file operations structure will be used for mei char device.
719 static const struct file_operations mei_fops
= {
720 .owner
= THIS_MODULE
,
722 .unlocked_ioctl
= mei_ioctl
,
724 .compat_ioctl
= mei_compat_ioctl
,
727 .release
= mei_release
,
730 .fasync
= mei_fasync
,
734 static struct class *mei_class
;
735 static dev_t mei_devt
;
736 #define MEI_MAX_DEVS MINORMASK
737 static DEFINE_MUTEX(mei_minor_lock
);
738 static DEFINE_IDR(mei_idr
);
741 * mei_minor_get - obtain next free device minor number
743 * @dev: device pointer
745 * Return: allocated minor, or -ENOSPC if no free minor left
747 static int mei_minor_get(struct mei_device
*dev
)
751 mutex_lock(&mei_minor_lock
);
752 ret
= idr_alloc(&mei_idr
, dev
, 0, MEI_MAX_DEVS
, GFP_KERNEL
);
755 else if (ret
== -ENOSPC
)
756 dev_err(dev
->dev
, "too many mei devices\n");
758 mutex_unlock(&mei_minor_lock
);
763 * mei_minor_free - mark device minor number as free
765 * @dev: device pointer
767 static void mei_minor_free(struct mei_device
*dev
)
769 mutex_lock(&mei_minor_lock
);
770 idr_remove(&mei_idr
, dev
->minor
);
771 mutex_unlock(&mei_minor_lock
);
774 int mei_register(struct mei_device
*dev
, struct device
*parent
)
776 struct device
*clsdev
; /* class device */
779 ret
= mei_minor_get(dev
);
783 /* Fill in the data structures */
784 devno
= MKDEV(MAJOR(mei_devt
), dev
->minor
);
785 cdev_init(&dev
->cdev
, &mei_fops
);
786 dev
->cdev
.owner
= parent
->driver
->owner
;
789 ret
= cdev_add(&dev
->cdev
, devno
, 1);
791 dev_err(parent
, "unable to add device %d:%d\n",
792 MAJOR(mei_devt
), dev
->minor
);
796 clsdev
= device_create_with_groups(mei_class
, parent
, devno
,
798 "mei%d", dev
->minor
);
800 if (IS_ERR(clsdev
)) {
801 dev_err(parent
, "unable to create device %d:%d\n",
802 MAJOR(mei_devt
), dev
->minor
);
803 ret
= PTR_ERR(clsdev
);
807 ret
= mei_dbgfs_register(dev
, dev_name(clsdev
));
809 dev_err(clsdev
, "cannot register debugfs ret = %d\n", ret
);
816 device_destroy(mei_class
, devno
);
818 cdev_del(&dev
->cdev
);
823 EXPORT_SYMBOL_GPL(mei_register
);
825 void mei_deregister(struct mei_device
*dev
)
829 devno
= dev
->cdev
.dev
;
830 cdev_del(&dev
->cdev
);
832 mei_dbgfs_deregister(dev
);
834 device_destroy(mei_class
, devno
);
838 EXPORT_SYMBOL_GPL(mei_deregister
);
840 static int __init
mei_init(void)
844 mei_class
= class_create(THIS_MODULE
, "mei");
845 if (IS_ERR(mei_class
)) {
846 pr_err("couldn't create class\n");
847 ret
= PTR_ERR(mei_class
);
851 ret
= alloc_chrdev_region(&mei_devt
, 0, MEI_MAX_DEVS
, "mei");
853 pr_err("unable to allocate char dev region\n");
857 ret
= mei_cl_bus_init();
859 pr_err("unable to initialize bus\n");
866 unregister_chrdev_region(mei_devt
, MEI_MAX_DEVS
);
868 class_destroy(mei_class
);
873 static void __exit
mei_exit(void)
875 unregister_chrdev_region(mei_devt
, MEI_MAX_DEVS
);
876 class_destroy(mei_class
);
880 module_init(mei_init
);
881 module_exit(mei_exit
);
883 MODULE_AUTHOR("Intel Corporation");
884 MODULE_DESCRIPTION("Intel(R) Management Engine Interface");
885 MODULE_LICENSE("GPL v2");