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 if (mei_cl_is_connected(cl
)) {
110 cl
->state
= MEI_FILE_DISCONNECTING
;
111 cl_dbg(dev
, cl
, "disconnecting\n");
112 rets
= mei_cl_disconnect(cl
);
114 mei_cl_flush_queues(cl
, file
);
115 cl_dbg(dev
, cl
, "removing\n");
119 file
->private_data
= NULL
;
123 mutex_unlock(&dev
->device_lock
);
129 * mei_read - the read function.
131 * @file: pointer to file structure
132 * @ubuf: pointer to user buffer
133 * @length: buffer length
134 * @offset: data offset in buffer
136 * Return: >=0 data length on success , <0 on error
138 static ssize_t
mei_read(struct file
*file
, char __user
*ubuf
,
139 size_t length
, loff_t
*offset
)
141 struct mei_cl
*cl
= file
->private_data
;
142 struct mei_device
*dev
;
143 struct mei_cl_cb
*cb
= NULL
;
148 if (WARN_ON(!cl
|| !cl
->dev
))
154 mutex_lock(&dev
->device_lock
);
155 if (dev
->dev_state
!= MEI_DEV_ENABLED
) {
165 if (cl
== &dev
->iamthif_cl
) {
166 rets
= mei_amthif_read(dev
, file
, ubuf
, length
, offset
);
170 cb
= mei_cl_read_cb(cl
, file
);
173 if (cb
->buf_idx
> *offset
)
175 /* offset is beyond buf_idx we have no more data return 0 */
176 if (cb
->buf_idx
> 0 && cb
->buf_idx
<= *offset
) {
180 /* Offset needs to be cleaned for contiguous reads*/
181 if (cb
->buf_idx
== 0 && *offset
> 0)
183 } else if (*offset
> 0) {
187 err
= mei_cl_read_start(cl
, length
, file
);
188 if (err
&& err
!= -EBUSY
) {
190 "mei start read failure with status = %d\n", err
);
195 if (list_empty(&cl
->rd_completed
) && !waitqueue_active(&cl
->rx_wait
)) {
196 if (file
->f_flags
& O_NONBLOCK
) {
201 mutex_unlock(&dev
->device_lock
);
203 if (wait_event_interruptible(cl
->rx_wait
,
204 (!list_empty(&cl
->rd_completed
)) ||
205 (!mei_cl_is_connected(cl
)))) {
207 if (signal_pending(current
))
212 mutex_lock(&dev
->device_lock
);
213 if (!mei_cl_is_connected(cl
)) {
219 cb
= mei_cl_read_cb(cl
, file
);
226 /* now copy the data to user space */
229 dev_dbg(dev
->dev
, "read operation failed %d\n", rets
);
233 dev_dbg(dev
->dev
, "buf.size = %d buf.idx= %ld\n",
234 cb
->buf
.size
, cb
->buf_idx
);
235 if (length
== 0 || ubuf
== NULL
|| *offset
> cb
->buf_idx
) {
240 /* length is being truncated to PAGE_SIZE,
241 * however buf_idx may point beyond that */
242 length
= min_t(size_t, length
, cb
->buf_idx
- *offset
);
244 if (copy_to_user(ubuf
, cb
->buf
.data
+ *offset
, length
)) {
245 dev_dbg(dev
->dev
, "failed to copy data to userland\n");
252 if ((unsigned long)*offset
< cb
->buf_idx
)
259 dev_dbg(dev
->dev
, "end mei read rets= %d\n", rets
);
260 mutex_unlock(&dev
->device_lock
);
264 * mei_write - the write function.
266 * @file: pointer to file structure
267 * @ubuf: pointer to user buffer
268 * @length: buffer length
269 * @offset: data offset in buffer
271 * Return: >=0 data length on success , <0 on error
273 static ssize_t
mei_write(struct file
*file
, const char __user
*ubuf
,
274 size_t length
, loff_t
*offset
)
276 struct mei_cl
*cl
= file
->private_data
;
277 struct mei_me_client
*me_cl
= NULL
;
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 me_cl
= mei_me_cl_by_uuid_id(dev
, &cl
->cl_uuid
, cl
->me_client_id
);
306 if (length
> me_cl
->props
.max_msg_length
) {
311 if (!mei_cl_is_connected(cl
)) {
312 cl_err(dev
, cl
, "is not connected");
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 mei_me_cl_put(me_cl
);
354 mutex_unlock(&dev
->device_lock
);
358 rets
= mei_cl_write(cl
, write_cb
, false);
360 mei_me_cl_put(me_cl
);
361 mutex_unlock(&dev
->device_lock
);
363 mei_io_cb_free(write_cb
);
368 * mei_ioctl_connect_client - the connect to fw client IOCTL function
370 * @file: private data of the file object
371 * @data: IOCTL connect data, input and output parameters
373 * Locking: called under "dev->device_lock" lock
375 * Return: 0 on success, <0 on failure.
377 static int mei_ioctl_connect_client(struct file
*file
,
378 struct mei_connect_client_data
*data
)
380 struct mei_device
*dev
;
381 struct mei_client
*client
;
382 struct mei_me_client
*me_cl
;
386 cl
= file
->private_data
;
389 if (dev
->dev_state
!= MEI_DEV_ENABLED
)
392 if (cl
->state
!= MEI_FILE_INITIALIZING
&&
393 cl
->state
!= MEI_FILE_DISCONNECTED
)
396 /* find ME client we're trying to connect to */
397 me_cl
= mei_me_cl_by_uuid(dev
, &data
->in_client_uuid
);
398 if (!me_cl
|| me_cl
->props
.fixed_address
) {
399 dev_dbg(dev
->dev
, "Cannot connect to FW Client UUID = %pUl\n",
400 &data
->in_client_uuid
);
404 cl
->me_client_id
= me_cl
->client_id
;
405 cl
->cl_uuid
= me_cl
->props
.protocol_name
;
407 dev_dbg(dev
->dev
, "Connect to FW Client ID = %d\n",
409 dev_dbg(dev
->dev
, "FW Client - Protocol Version = %d\n",
410 me_cl
->props
.protocol_version
);
411 dev_dbg(dev
->dev
, "FW Client - Max Msg Len = %d\n",
412 me_cl
->props
.max_msg_length
);
414 /* if we're connecting to amthif client then we will use the
415 * existing connection
417 if (uuid_le_cmp(data
->in_client_uuid
, mei_amthif_guid
) == 0) {
418 dev_dbg(dev
->dev
, "FW Client is amthi\n");
419 if (!mei_cl_is_connected(&dev
->iamthif_cl
)) {
427 dev
->iamthif_open_count
++;
428 file
->private_data
= &dev
->iamthif_cl
;
430 client
= &data
->out_client_properties
;
431 client
->max_msg_length
= me_cl
->props
.max_msg_length
;
432 client
->protocol_version
= me_cl
->props
.protocol_version
;
433 rets
= dev
->iamthif_cl
.status
;
438 /* prepare the output buffer */
439 client
= &data
->out_client_properties
;
440 client
->max_msg_length
= me_cl
->props
.max_msg_length
;
441 client
->protocol_version
= me_cl
->props
.protocol_version
;
442 dev_dbg(dev
->dev
, "Can connect?\n");
444 rets
= mei_cl_connect(cl
, file
);
447 mei_me_cl_put(me_cl
);
452 * mei_ioctl - the IOCTL function
454 * @file: pointer to file structure
455 * @cmd: ioctl command
456 * @data: pointer to mei message structure
458 * Return: 0 on success , <0 on error
460 static long mei_ioctl(struct file
*file
, unsigned int cmd
, unsigned long data
)
462 struct mei_device
*dev
;
463 struct mei_cl
*cl
= file
->private_data
;
464 struct mei_connect_client_data connect_data
;
468 if (WARN_ON(!cl
|| !cl
->dev
))
473 dev_dbg(dev
->dev
, "IOCTL cmd = 0x%x", cmd
);
475 mutex_lock(&dev
->device_lock
);
476 if (dev
->dev_state
!= MEI_DEV_ENABLED
) {
482 case IOCTL_MEI_CONNECT_CLIENT
:
483 dev_dbg(dev
->dev
, ": IOCTL_MEI_CONNECT_CLIENT.\n");
484 if (copy_from_user(&connect_data
, (char __user
*)data
,
485 sizeof(struct mei_connect_client_data
))) {
486 dev_dbg(dev
->dev
, "failed to copy data from userland\n");
491 rets
= mei_ioctl_connect_client(file
, &connect_data
);
495 /* if all is ok, copying the data back to user. */
496 if (copy_to_user((char __user
*)data
, &connect_data
,
497 sizeof(struct mei_connect_client_data
))) {
498 dev_dbg(dev
->dev
, "failed to copy data to userland\n");
506 dev_err(dev
->dev
, ": unsupported ioctl %d.\n", cmd
);
511 mutex_unlock(&dev
->device_lock
);
516 * mei_compat_ioctl - the compat IOCTL function
518 * @file: pointer to file structure
519 * @cmd: ioctl command
520 * @data: pointer to mei message structure
522 * Return: 0 on success , <0 on error
525 static long mei_compat_ioctl(struct file
*file
,
526 unsigned int cmd
, unsigned long data
)
528 return mei_ioctl(file
, cmd
, (unsigned long)compat_ptr(data
));
534 * mei_poll - the poll function
536 * @file: pointer to file structure
537 * @wait: pointer to poll_table structure
541 static unsigned int mei_poll(struct file
*file
, poll_table
*wait
)
543 unsigned long req_events
= poll_requested_events(wait
);
544 struct mei_cl
*cl
= file
->private_data
;
545 struct mei_device
*dev
;
546 unsigned int mask
= 0;
548 if (WARN_ON(!cl
|| !cl
->dev
))
553 mutex_lock(&dev
->device_lock
);
556 if (dev
->dev_state
!= MEI_DEV_ENABLED
||
557 !mei_cl_is_connected(cl
)) {
562 if (cl
== &dev
->iamthif_cl
) {
563 mask
= mei_amthif_poll(dev
, file
, wait
);
567 if (req_events
& (POLLIN
| POLLRDNORM
)) {
568 poll_wait(file
, &cl
->rx_wait
, wait
);
570 if (!list_empty(&cl
->rd_completed
))
571 mask
|= POLLIN
| POLLRDNORM
;
573 mei_cl_read_start(cl
, 0, file
);
577 mutex_unlock(&dev
->device_lock
);
582 * fw_status_show - mei device attribute show method
584 * @device: device pointer
585 * @attr: attribute pointer
586 * @buf: char out buffer
588 * Return: number of the bytes printed into buf or error
590 static ssize_t
fw_status_show(struct device
*device
,
591 struct device_attribute
*attr
, char *buf
)
593 struct mei_device
*dev
= dev_get_drvdata(device
);
594 struct mei_fw_status fw_status
;
598 mutex_lock(&dev
->device_lock
);
599 err
= mei_fw_status(dev
, &fw_status
);
600 mutex_unlock(&dev
->device_lock
);
602 dev_err(device
, "read fw_status error = %d\n", err
);
606 for (i
= 0; i
< fw_status
.count
; i
++)
607 cnt
+= scnprintf(buf
+ cnt
, PAGE_SIZE
- cnt
, "%08X\n",
608 fw_status
.status
[i
]);
611 static DEVICE_ATTR_RO(fw_status
);
613 static struct attribute
*mei_attrs
[] = {
614 &dev_attr_fw_status
.attr
,
617 ATTRIBUTE_GROUPS(mei
);
620 * file operations structure will be used for mei char device.
622 static const struct file_operations mei_fops
= {
623 .owner
= THIS_MODULE
,
625 .unlocked_ioctl
= mei_ioctl
,
627 .compat_ioctl
= mei_compat_ioctl
,
630 .release
= mei_release
,
636 static struct class *mei_class
;
637 static dev_t mei_devt
;
638 #define MEI_MAX_DEVS MINORMASK
639 static DEFINE_MUTEX(mei_minor_lock
);
640 static DEFINE_IDR(mei_idr
);
643 * mei_minor_get - obtain next free device minor number
645 * @dev: device pointer
647 * Return: allocated minor, or -ENOSPC if no free minor left
649 static int mei_minor_get(struct mei_device
*dev
)
653 mutex_lock(&mei_minor_lock
);
654 ret
= idr_alloc(&mei_idr
, dev
, 0, MEI_MAX_DEVS
, GFP_KERNEL
);
657 else if (ret
== -ENOSPC
)
658 dev_err(dev
->dev
, "too many mei devices\n");
660 mutex_unlock(&mei_minor_lock
);
665 * mei_minor_free - mark device minor number as free
667 * @dev: device pointer
669 static void mei_minor_free(struct mei_device
*dev
)
671 mutex_lock(&mei_minor_lock
);
672 idr_remove(&mei_idr
, dev
->minor
);
673 mutex_unlock(&mei_minor_lock
);
676 int mei_register(struct mei_device
*dev
, struct device
*parent
)
678 struct device
*clsdev
; /* class device */
681 ret
= mei_minor_get(dev
);
685 /* Fill in the data structures */
686 devno
= MKDEV(MAJOR(mei_devt
), dev
->minor
);
687 cdev_init(&dev
->cdev
, &mei_fops
);
688 dev
->cdev
.owner
= parent
->driver
->owner
;
691 ret
= cdev_add(&dev
->cdev
, devno
, 1);
693 dev_err(parent
, "unable to add device %d:%d\n",
694 MAJOR(mei_devt
), dev
->minor
);
698 clsdev
= device_create_with_groups(mei_class
, parent
, devno
,
700 "mei%d", dev
->minor
);
702 if (IS_ERR(clsdev
)) {
703 dev_err(parent
, "unable to create device %d:%d\n",
704 MAJOR(mei_devt
), dev
->minor
);
705 ret
= PTR_ERR(clsdev
);
709 ret
= mei_dbgfs_register(dev
, dev_name(clsdev
));
711 dev_err(clsdev
, "cannot register debugfs ret = %d\n", ret
);
718 device_destroy(mei_class
, devno
);
720 cdev_del(&dev
->cdev
);
725 EXPORT_SYMBOL_GPL(mei_register
);
727 void mei_deregister(struct mei_device
*dev
)
731 devno
= dev
->cdev
.dev
;
732 cdev_del(&dev
->cdev
);
734 mei_dbgfs_deregister(dev
);
736 device_destroy(mei_class
, devno
);
740 EXPORT_SYMBOL_GPL(mei_deregister
);
742 static int __init
mei_init(void)
746 mei_class
= class_create(THIS_MODULE
, "mei");
747 if (IS_ERR(mei_class
)) {
748 pr_err("couldn't create class\n");
749 ret
= PTR_ERR(mei_class
);
753 ret
= alloc_chrdev_region(&mei_devt
, 0, MEI_MAX_DEVS
, "mei");
755 pr_err("unable to allocate char dev region\n");
759 ret
= mei_cl_bus_init();
761 pr_err("unable to initialize bus\n");
768 unregister_chrdev_region(mei_devt
, MEI_MAX_DEVS
);
770 class_destroy(mei_class
);
775 static void __exit
mei_exit(void)
777 unregister_chrdev_region(mei_devt
, MEI_MAX_DEVS
);
778 class_destroy(mei_class
);
782 module_init(mei_init
);
783 module_exit(mei_exit
);
785 MODULE_AUTHOR("Intel Corporation");
786 MODULE_DESCRIPTION("Intel(R) Management Engine Interface");
787 MODULE_LICENSE("GPL v2");