blob: e825f013e54e42ff171f1c93e776770fbfb3b1d1 [file] [log] [blame]
Oren Weilab841162011-05-15 13:43:41 +03001/*
2 *
3 * Intel Management Engine Interface (Intel MEI) Linux driver
Tomas Winkler733ba912012-02-09 19:25:53 +02004 * Copyright (c) 2003-2012, Intel Corporation.
Oren Weilab841162011-05-15 13:43:41 +03005 *
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.
9 *
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
13 * more details.
14 *
15 */
Oren Weilab841162011-05-15 13:43:41 +030016#include <linux/module.h>
17#include <linux/moduleparam.h>
18#include <linux/kernel.h>
19#include <linux/device.h>
Tomas Winkler1f180352014-09-29 16:31:46 +030020#include <linux/slab.h>
Oren Weilab841162011-05-15 13:43:41 +030021#include <linux/fs.h>
22#include <linux/errno.h>
23#include <linux/types.h>
24#include <linux/fcntl.h>
Oren Weilab841162011-05-15 13:43:41 +030025#include <linux/poll.h>
26#include <linux/init.h>
27#include <linux/ioctl.h>
28#include <linux/cdev.h>
Ingo Molnar174cd4b2017-02-02 19:15:33 +010029#include <linux/sched/signal.h>
Oren Weilab841162011-05-15 13:43:41 +030030#include <linux/uuid.h>
31#include <linux/compat.h>
32#include <linux/jiffies.h>
33#include <linux/interrupt.h>
34
Tomas Winkler4f3afe12012-05-09 16:38:59 +030035#include <linux/mei.h>
Tomas Winkler47a73802012-12-25 19:06:03 +020036
37#include "mei_dev.h"
Tomas Winkler90e0b5f2013-01-08 23:07:14 +020038#include "client.h"
Oren Weilab841162011-05-15 13:43:41 +030039
Oren Weilab841162011-05-15 13:43:41 +030040/**
Oren Weilab841162011-05-15 13:43:41 +030041 * mei_open - the open function
42 *
43 * @inode: pointer to inode structure
44 * @file: pointer to file structure
Alexander Usyskin83ce0742014-01-08 22:31:46 +020045 *
Alexander Usyskina8605ea2014-09-29 16:31:49 +030046 * Return: 0 on success, <0 on error
Oren Weilab841162011-05-15 13:43:41 +030047 */
48static int mei_open(struct inode *inode, struct file *file)
49{
Oren Weilab841162011-05-15 13:43:41 +030050 struct mei_device *dev;
Alexander Usyskinf3d8e872014-06-23 15:10:35 +030051 struct mei_cl *cl;
Tomas Winkler2703d4b2013-02-06 14:06:39 +020052
Tomas Winkler6f37aca2011-11-13 09:41:15 +020053 int err;
Oren Weilab841162011-05-15 13:43:41 +030054
Alexander Usyskinf3d8e872014-06-23 15:10:35 +030055 dev = container_of(inode->i_cdev, struct mei_device, cdev);
Oren Weil5b881e32011-11-13 09:41:14 +020056 if (!dev)
Tomas Winklere036cc52013-09-16 23:44:46 +030057 return -ENODEV;
Oren Weilab841162011-05-15 13:43:41 +030058
59 mutex_lock(&dev->device_lock);
Tomas Winklere036cc52013-09-16 23:44:46 +030060
Tomas Winklerb210d752012-08-07 00:03:56 +030061 if (dev->dev_state != MEI_DEV_ENABLED) {
Tomas Winkler2bf94cab2014-09-29 16:31:42 +030062 dev_dbg(dev->dev, "dev_state != MEI_ENABLED dev_state = %s\n",
Tomas Winklerb210d752012-08-07 00:03:56 +030063 mei_dev_state_str(dev->dev_state));
Tomas Winkler03b8d342015-02-10 10:39:44 +020064 err = -ENODEV;
Tomas Winklere036cc52013-09-16 23:44:46 +030065 goto err_unlock;
Tomas Winkler1b812942012-09-11 00:43:20 +030066 }
Oren Weilab841162011-05-15 13:43:41 +030067
Alexander Usyskin7851e002016-02-07 23:35:40 +020068 cl = mei_cl_alloc_linked(dev);
Tomas Winkler03b8d342015-02-10 10:39:44 +020069 if (IS_ERR(cl)) {
70 err = PTR_ERR(cl);
Tomas Winklere036cc52013-09-16 23:44:46 +030071 goto err_unlock;
Tomas Winkler03b8d342015-02-10 10:39:44 +020072 }
Oren Weilab841162011-05-15 13:43:41 +030073
Alexander Usyskin97d549b2016-06-16 17:58:57 +030074 cl->fp = file;
Oren Weilab841162011-05-15 13:43:41 +030075 file->private_data = cl;
Tomas Winklere036cc52013-09-16 23:44:46 +030076
Oren Weilab841162011-05-15 13:43:41 +030077 mutex_unlock(&dev->device_lock);
78
Oren Weil5b881e32011-11-13 09:41:14 +020079 return nonseekable_open(inode, file);
Oren Weilab841162011-05-15 13:43:41 +030080
Tomas Winklere036cc52013-09-16 23:44:46 +030081err_unlock:
Oren Weilab841162011-05-15 13:43:41 +030082 mutex_unlock(&dev->device_lock);
Oren Weilab841162011-05-15 13:43:41 +030083 return err;
84}
85
86/**
87 * mei_release - the release function
88 *
89 * @inode: pointer to inode structure
90 * @file: pointer to file structure
91 *
Alexander Usyskina8605ea2014-09-29 16:31:49 +030092 * Return: 0 on success, <0 on error
Oren Weilab841162011-05-15 13:43:41 +030093 */
94static int mei_release(struct inode *inode, struct file *file)
95{
96 struct mei_cl *cl = file->private_data;
Oren Weilab841162011-05-15 13:43:41 +030097 struct mei_device *dev;
Tomas Winkler3c666182015-05-04 09:43:52 +030098 int rets;
Oren Weilab841162011-05-15 13:43:41 +030099
100 if (WARN_ON(!cl || !cl->dev))
101 return -ENODEV;
102
103 dev = cl->dev;
104
105 mutex_lock(&dev->device_lock);
Alexander Usyskin394a77d2017-03-20 15:04:03 +0200106
Tomas Winkler3c666182015-05-04 09:43:52 +0300107 rets = mei_cl_disconnect(cl);
108
Tomas Winklera9bed612015-02-10 10:39:46 +0200109 mei_cl_flush_queues(cl, file);
Tomas Winkler46922182014-03-16 14:35:55 +0200110 cl_dbg(dev, cl, "removing\n");
Tomas Winklera562d5c2012-11-11 17:38:01 +0200111
Tomas Winkler90e0b5f2013-01-08 23:07:14 +0200112 mei_cl_unlink(cl);
Tomas Winklera562d5c2012-11-11 17:38:01 +0200113
Tomas Winklera562d5c2012-11-11 17:38:01 +0200114 file->private_data = NULL;
115
Tomas Winklera562d5c2012-11-11 17:38:01 +0200116 kfree(cl);
Alexander Usyskin394a77d2017-03-20 15:04:03 +0200117
Oren Weilab841162011-05-15 13:43:41 +0300118 mutex_unlock(&dev->device_lock);
119 return rets;
120}
121
122
123/**
124 * mei_read - the read function.
125 *
126 * @file: pointer to file structure
127 * @ubuf: pointer to user buffer
128 * @length: buffer length
129 * @offset: data offset in buffer
130 *
Alexander Usyskina8605ea2014-09-29 16:31:49 +0300131 * Return: >=0 data length on success , <0 on error
Oren Weilab841162011-05-15 13:43:41 +0300132 */
133static ssize_t mei_read(struct file *file, char __user *ubuf,
Tomas Winkler441ab502011-12-13 23:39:34 +0200134 size_t length, loff_t *offset)
Oren Weilab841162011-05-15 13:43:41 +0300135{
136 struct mei_cl *cl = file->private_data;
Oren Weilab841162011-05-15 13:43:41 +0300137 struct mei_device *dev;
Tomas Winklera9bed612015-02-10 10:39:46 +0200138 struct mei_cl_cb *cb = NULL;
Alexander Usyskinff1586a2016-07-26 01:06:06 +0300139 bool nonblock = !!(file->f_flags & O_NONBLOCK);
Oren Weilab841162011-05-15 13:43:41 +0300140 int rets;
Oren Weilab841162011-05-15 13:43:41 +0300141
142 if (WARN_ON(!cl || !cl->dev))
143 return -ENODEV;
144
145 dev = cl->dev;
146
Tomas Winklerdd5de1f2013-09-02 03:11:04 +0300147
Oren Weilab841162011-05-15 13:43:41 +0300148 mutex_lock(&dev->device_lock);
Tomas Winklerb210d752012-08-07 00:03:56 +0300149 if (dev->dev_state != MEI_DEV_ENABLED) {
Oren Weilab841162011-05-15 13:43:41 +0300150 rets = -ENODEV;
151 goto out;
152 }
153
Tomas Winklerdd5de1f2013-09-02 03:11:04 +0300154 if (length == 0) {
155 rets = 0;
156 goto out;
157 }
158
Alexander Usyskin8b2458f2016-01-07 14:46:37 +0200159 if (ubuf == NULL) {
160 rets = -EMSGSIZE;
161 goto out;
162 }
163
Tomas Winklera9bed612015-02-10 10:39:46 +0200164 cb = mei_cl_read_cb(cl, file);
Alexander Usyskin8b2458f2016-01-07 14:46:37 +0200165 if (cb)
166 goto copy_buffer;
167
168 if (*offset > 0)
Oren Weilab841162011-05-15 13:43:41 +0300169 *offset = 0;
Oren Weilab841162011-05-15 13:43:41 +0300170
Alexander Usyskinff1586a2016-07-26 01:06:06 +0300171 rets = mei_cl_read_start(cl, length, file);
172 if (rets && rets != -EBUSY) {
173 cl_dbg(dev, cl, "mei start read failure status = %d\n", rets);
Oren Weilab841162011-05-15 13:43:41 +0300174 goto out;
175 }
176
Alexander Usyskinff1586a2016-07-26 01:06:06 +0300177 if (nonblock) {
178 rets = -EAGAIN;
179 goto out;
180 }
Oren Weilab841162011-05-15 13:43:41 +0300181
Alexander Usyskincb97fbb2017-02-08 00:41:45 +0200182 mutex_unlock(&dev->device_lock);
183 if (wait_event_interruptible(cl->rx_wait,
184 !list_empty(&cl->rd_completed) ||
185 !mei_cl_is_connected(cl))) {
186 if (signal_pending(current))
187 return -EINTR;
188 return -ERESTARTSYS;
189 }
190 mutex_lock(&dev->device_lock);
191
192 if (!mei_cl_is_connected(cl)) {
193 rets = -ENODEV;
Alexander Usyskinff1586a2016-07-26 01:06:06 +0300194 goto out;
195 }
196
Alexander Usyskincb97fbb2017-02-08 00:41:45 +0200197 cb = mei_cl_read_cb(cl, file);
198 if (!cb) {
Alexander Usyskincb97fbb2017-02-08 00:41:45 +0200199 rets = 0;
200 goto out;
201 }
Tomas Winkler3d33ff22015-02-10 10:39:36 +0200202
Oren Weilab841162011-05-15 13:43:41 +0300203copy_buffer:
Tomas Winkler3d33ff22015-02-10 10:39:36 +0200204 /* now copy the data to user space */
205 if (cb->status) {
206 rets = cb->status;
Alexander Usyskin292f82c2015-05-04 09:44:00 +0300207 cl_dbg(dev, cl, "read operation failed %d\n", rets);
Tomas Winkler3d33ff22015-02-10 10:39:36 +0200208 goto free;
209 }
210
Alexander Usyskin35bf7692016-02-17 18:27:34 +0200211 cl_dbg(dev, cl, "buf.size = %zu buf.idx = %zu offset = %lld\n",
Alexander Usyskin8b2458f2016-01-07 14:46:37 +0200212 cb->buf.size, cb->buf_idx, *offset);
213 if (*offset >= cb->buf_idx) {
214 rets = 0;
Oren Weilab841162011-05-15 13:43:41 +0300215 goto free;
216 }
217
Tomas Winklerebb108ef2012-10-09 16:50:16 +0200218 /* length is being truncated to PAGE_SIZE,
219 * however buf_idx may point beyond that */
220 length = min_t(size_t, length, cb->buf_idx - *offset);
Oren Weilab841162011-05-15 13:43:41 +0300221
Tomas Winkler5db75142015-02-10 10:39:42 +0200222 if (copy_to_user(ubuf, cb->buf.data + *offset, length)) {
Tomas Winkler2bf94cab2014-09-29 16:31:42 +0300223 dev_dbg(dev->dev, "failed to copy data to userland\n");
Oren Weilab841162011-05-15 13:43:41 +0300224 rets = -EFAULT;
225 goto free;
226 }
227
228 rets = length;
229 *offset += length;
Tomas Winklerf862b6b2016-02-07 23:35:19 +0200230 /* not all data was read, keep the cb */
231 if (*offset < cb->buf_idx)
Oren Weilab841162011-05-15 13:43:41 +0300232 goto out;
233
234free:
Tomas Winkler601a1ef2012-10-09 16:50:20 +0200235 mei_io_cb_free(cb);
Alexander Usyskin8b2458f2016-01-07 14:46:37 +0200236 *offset = 0;
Tomas Winkler928fa662015-02-10 10:39:45 +0200237
Oren Weilab841162011-05-15 13:43:41 +0300238out:
Alexander Usyskin292f82c2015-05-04 09:44:00 +0300239 cl_dbg(dev, cl, "end mei read rets = %d\n", rets);
Oren Weilab841162011-05-15 13:43:41 +0300240 mutex_unlock(&dev->device_lock);
241 return rets;
242}
Tomas Winkler33d28c92012-10-09 16:50:17 +0200243/**
Oren Weilab841162011-05-15 13:43:41 +0300244 * mei_write - the write function.
245 *
246 * @file: pointer to file structure
247 * @ubuf: pointer to user buffer
248 * @length: buffer length
249 * @offset: data offset in buffer
250 *
Alexander Usyskina8605ea2014-09-29 16:31:49 +0300251 * Return: >=0 data length on success , <0 on error
Oren Weilab841162011-05-15 13:43:41 +0300252 */
253static ssize_t mei_write(struct file *file, const char __user *ubuf,
Tomas Winkler441ab502011-12-13 23:39:34 +0200254 size_t length, loff_t *offset)
Oren Weilab841162011-05-15 13:43:41 +0300255{
256 struct mei_cl *cl = file->private_data;
Alexander Usyskin6cbb0972016-02-10 23:57:26 +0200257 struct mei_cl_cb *cb;
Oren Weilab841162011-05-15 13:43:41 +0300258 struct mei_device *dev;
Oren Weilab841162011-05-15 13:43:41 +0300259 int rets;
Oren Weilab841162011-05-15 13:43:41 +0300260
261 if (WARN_ON(!cl || !cl->dev))
262 return -ENODEV;
263
264 dev = cl->dev;
265
266 mutex_lock(&dev->device_lock);
267
Tomas Winklerb210d752012-08-07 00:03:56 +0300268 if (dev->dev_state != MEI_DEV_ENABLED) {
Tomas Winkler75f0ee12012-10-09 16:50:18 +0200269 rets = -ENODEV;
Tomas Winkler4234a6d2013-04-08 21:56:37 +0300270 goto out;
Oren Weilab841162011-05-15 13:43:41 +0300271 }
272
Alexander Usyskind49ed642015-05-04 09:43:54 +0300273 if (!mei_cl_is_connected(cl)) {
274 cl_err(dev, cl, "is not connected");
275 rets = -ENODEV;
276 goto out;
277 }
278
279 if (!mei_me_cl_is_active(cl->me_cl)) {
Alexander Usyskin7ca96aa2014-02-19 17:35:49 +0200280 rets = -ENOTTY;
Tomas Winkler4234a6d2013-04-08 21:56:37 +0300281 goto out;
Tomas Winkler75f0ee12012-10-09 16:50:18 +0200282 }
Tomas Winklerdd5de1f2013-09-02 03:11:04 +0300283
Alexander Usyskind49ed642015-05-04 09:43:54 +0300284 if (length > mei_cl_mtu(cl)) {
285 rets = -EFBIG;
286 goto out;
287 }
288
Tomas Winklerdd5de1f2013-09-02 03:11:04 +0300289 if (length == 0) {
290 rets = 0;
291 goto out;
292 }
293
Tomas Winklera9bed612015-02-10 10:39:46 +0200294 *offset = 0;
Alexander Usyskin6cbb0972016-02-10 23:57:26 +0200295 cb = mei_cl_alloc_cb(cl, length, MEI_FOP_WRITE, file);
296 if (!cb) {
Tomas Winkler33d28c92012-10-09 16:50:17 +0200297 rets = -ENOMEM;
Tomas Winkler4234a6d2013-04-08 21:56:37 +0300298 goto out;
Oren Weilab841162011-05-15 13:43:41 +0300299 }
Oren Weilab841162011-05-15 13:43:41 +0300300
Alexander Usyskin6cbb0972016-02-10 23:57:26 +0200301 rets = copy_from_user(cb->buf.data, ubuf, length);
Alexander Usyskind8b29ef2013-09-02 03:11:02 +0300302 if (rets) {
Tomas Winkler2bf94cab2014-09-29 16:31:42 +0300303 dev_dbg(dev->dev, "failed to copy data from userland\n");
Alexander Usyskind8b29ef2013-09-02 03:11:02 +0300304 rets = -EFAULT;
Alexander Usyskin6cbb0972016-02-10 23:57:26 +0200305 mei_io_cb_free(cb);
Tomas Winkler4234a6d2013-04-08 21:56:37 +0300306 goto out;
Alexander Usyskind8b29ef2013-09-02 03:11:02 +0300307 }
Oren Weilab841162011-05-15 13:43:41 +0300308
Alexander Usyskine0cb6b22016-11-08 18:26:08 +0200309 rets = mei_cl_write(cl, cb);
Tomas Winklerb0d0cf72012-11-01 21:17:13 +0200310out:
Oren Weilab841162011-05-15 13:43:41 +0300311 mutex_unlock(&dev->device_lock);
Oren Weilab841162011-05-15 13:43:41 +0300312 return rets;
313}
314
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200315/**
316 * mei_ioctl_connect_client - the connect to fw client IOCTL function
317 *
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200318 * @file: private data of the file object
Alexander Usyskina8605ea2014-09-29 16:31:49 +0300319 * @data: IOCTL connect data, input and output parameters
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200320 *
321 * Locking: called under "dev->device_lock" lock
322 *
Alexander Usyskina8605ea2014-09-29 16:31:49 +0300323 * Return: 0 on success, <0 on failure.
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200324 */
325static int mei_ioctl_connect_client(struct file *file,
326 struct mei_connect_client_data *data)
327{
328 struct mei_device *dev;
329 struct mei_client *client;
Tomas Winklerd3208322014-08-24 12:08:55 +0300330 struct mei_me_client *me_cl;
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200331 struct mei_cl *cl;
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200332 int rets;
333
334 cl = file->private_data;
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200335 dev = cl->dev;
336
Tomas Winkler79563db2015-01-11 00:07:16 +0200337 if (dev->dev_state != MEI_DEV_ENABLED)
338 return -ENODEV;
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200339
340 if (cl->state != MEI_FILE_INITIALIZING &&
Tomas Winkler79563db2015-01-11 00:07:16 +0200341 cl->state != MEI_FILE_DISCONNECTED)
342 return -EBUSY;
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200343
344 /* find ME client we're trying to connect to */
Tomas Winklerd3208322014-08-24 12:08:55 +0300345 me_cl = mei_me_cl_by_uuid(dev, &data->in_client_uuid);
Alexander Usyskinf4e06242016-02-07 23:35:38 +0200346 if (!me_cl) {
Tomas Winkler2bf94cab2014-09-29 16:31:42 +0300347 dev_dbg(dev->dev, "Cannot connect to FW Client UUID = %pUl\n",
Alexander Usyskind49ed642015-05-04 09:43:54 +0300348 &data->in_client_uuid);
Alexander Usyskinf4e06242016-02-07 23:35:38 +0200349 rets = -ENOTTY;
350 goto end;
351 }
352
353 if (me_cl->props.fixed_address) {
354 bool forbidden = dev->override_fixed_address ?
355 !dev->allow_fixed_address : !dev->hbm_f_fa_supported;
356 if (forbidden) {
357 dev_dbg(dev->dev, "Connection forbidden to FW Client UUID = %pUl\n",
358 &data->in_client_uuid);
359 rets = -ENOTTY;
360 goto end;
361 }
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200362 }
363
Tomas Winkler2bf94cab2014-09-29 16:31:42 +0300364 dev_dbg(dev->dev, "Connect to FW Client ID = %d\n",
Alexander Usyskind49ed642015-05-04 09:43:54 +0300365 me_cl->client_id);
Tomas Winkler2bf94cab2014-09-29 16:31:42 +0300366 dev_dbg(dev->dev, "FW Client - Protocol Version = %d\n",
Tomas Winklerd3208322014-08-24 12:08:55 +0300367 me_cl->props.protocol_version);
Tomas Winkler2bf94cab2014-09-29 16:31:42 +0300368 dev_dbg(dev->dev, "FW Client - Max Msg Len = %d\n",
Tomas Winklerd3208322014-08-24 12:08:55 +0300369 me_cl->props.max_msg_length);
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200370
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200371 /* prepare the output buffer */
372 client = &data->out_client_properties;
Tomas Winklerd3208322014-08-24 12:08:55 +0300373 client->max_msg_length = me_cl->props.max_msg_length;
374 client->protocol_version = me_cl->props.protocol_version;
Tomas Winkler2bf94cab2014-09-29 16:31:42 +0300375 dev_dbg(dev->dev, "Can connect?\n");
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200376
Alexander Usyskind49ed642015-05-04 09:43:54 +0300377 rets = mei_cl_connect(cl, me_cl, file);
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200378
379end:
Tomas Winkler79563db2015-01-11 00:07:16 +0200380 mei_me_cl_put(me_cl);
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200381 return rets;
382}
383
Oren Weilab841162011-05-15 13:43:41 +0300384/**
Tomas Winkler3c7c8462015-07-26 09:54:20 +0300385 * mei_ioctl_client_notify_request -
386 * propagate event notification request to client
387 *
388 * @file: pointer to file structure
389 * @request: 0 - disable, 1 - enable
390 *
391 * Return: 0 on success , <0 on error
392 */
Tomas Winklerf23e2cc2016-02-07 23:35:23 +0200393static int mei_ioctl_client_notify_request(const struct file *file, u32 request)
Tomas Winkler3c7c8462015-07-26 09:54:20 +0300394{
395 struct mei_cl *cl = file->private_data;
396
Alexander Usyskin7326fff2016-01-17 12:25:01 +0200397 if (request != MEI_HBM_NOTIFICATION_START &&
398 request != MEI_HBM_NOTIFICATION_STOP)
399 return -EINVAL;
400
401 return mei_cl_notify_request(cl, file, (u8)request);
Tomas Winkler3c7c8462015-07-26 09:54:20 +0300402}
403
404/**
405 * mei_ioctl_client_notify_get - wait for notification request
406 *
407 * @file: pointer to file structure
408 * @notify_get: 0 - disable, 1 - enable
409 *
410 * Return: 0 on success , <0 on error
411 */
Tomas Winklerf23e2cc2016-02-07 23:35:23 +0200412static int mei_ioctl_client_notify_get(const struct file *file, u32 *notify_get)
Tomas Winkler3c7c8462015-07-26 09:54:20 +0300413{
414 struct mei_cl *cl = file->private_data;
415 bool notify_ev;
416 bool block = (file->f_flags & O_NONBLOCK) == 0;
417 int rets;
418
419 rets = mei_cl_notify_get(cl, block, &notify_ev);
420 if (rets)
421 return rets;
422
423 *notify_get = notify_ev ? 1 : 0;
424 return 0;
425}
426
427/**
Oren Weilab841162011-05-15 13:43:41 +0300428 * mei_ioctl - the IOCTL function
429 *
430 * @file: pointer to file structure
431 * @cmd: ioctl command
432 * @data: pointer to mei message structure
433 *
Alexander Usyskina8605ea2014-09-29 16:31:49 +0300434 * Return: 0 on success , <0 on error
Oren Weilab841162011-05-15 13:43:41 +0300435 */
436static long mei_ioctl(struct file *file, unsigned int cmd, unsigned long data)
437{
438 struct mei_device *dev;
439 struct mei_cl *cl = file->private_data;
Tomas Winkler154eb182014-08-21 14:29:23 +0300440 struct mei_connect_client_data connect_data;
Tomas Winkler3c7c8462015-07-26 09:54:20 +0300441 u32 notify_get, notify_req;
Oren Weilab841162011-05-15 13:43:41 +0300442 int rets;
443
Oren Weilab841162011-05-15 13:43:41 +0300444
445 if (WARN_ON(!cl || !cl->dev))
446 return -ENODEV;
447
448 dev = cl->dev;
449
Tomas Winkler2bf94cab2014-09-29 16:31:42 +0300450 dev_dbg(dev->dev, "IOCTL cmd = 0x%x", cmd);
Oren Weilab841162011-05-15 13:43:41 +0300451
452 mutex_lock(&dev->device_lock);
Tomas Winklerb210d752012-08-07 00:03:56 +0300453 if (dev->dev_state != MEI_DEV_ENABLED) {
Oren Weilab841162011-05-15 13:43:41 +0300454 rets = -ENODEV;
455 goto out;
456 }
457
Tomas Winkler4f046e72014-08-21 14:29:22 +0300458 switch (cmd) {
459 case IOCTL_MEI_CONNECT_CLIENT:
Tomas Winkler2bf94cab2014-09-29 16:31:42 +0300460 dev_dbg(dev->dev, ": IOCTL_MEI_CONNECT_CLIENT.\n");
Tomas Winkler154eb182014-08-21 14:29:23 +0300461 if (copy_from_user(&connect_data, (char __user *)data,
Oren Weilab841162011-05-15 13:43:41 +0300462 sizeof(struct mei_connect_client_data))) {
Tomas Winkler2bf94cab2014-09-29 16:31:42 +0300463 dev_dbg(dev->dev, "failed to copy data from userland\n");
Tomas Winkler4f046e72014-08-21 14:29:22 +0300464 rets = -EFAULT;
465 goto out;
466 }
Tomas Winkler9f81abda2013-01-08 23:07:15 +0200467
Tomas Winkler154eb182014-08-21 14:29:23 +0300468 rets = mei_ioctl_connect_client(file, &connect_data);
Tomas Winkler4f046e72014-08-21 14:29:22 +0300469 if (rets)
470 goto out;
Oren Weilab841162011-05-15 13:43:41 +0300471
Tomas Winkler4f046e72014-08-21 14:29:22 +0300472 /* if all is ok, copying the data back to user. */
Tomas Winkler154eb182014-08-21 14:29:23 +0300473 if (copy_to_user((char __user *)data, &connect_data,
Oren Weilab841162011-05-15 13:43:41 +0300474 sizeof(struct mei_connect_client_data))) {
Tomas Winkler2bf94cab2014-09-29 16:31:42 +0300475 dev_dbg(dev->dev, "failed to copy data to userland\n");
Tomas Winkler4f046e72014-08-21 14:29:22 +0300476 rets = -EFAULT;
477 goto out;
478 }
479
480 break;
Tomas Winkler154eb182014-08-21 14:29:23 +0300481
Tomas Winkler3c7c8462015-07-26 09:54:20 +0300482 case IOCTL_MEI_NOTIFY_SET:
483 dev_dbg(dev->dev, ": IOCTL_MEI_NOTIFY_SET.\n");
484 if (copy_from_user(&notify_req,
485 (char __user *)data, sizeof(notify_req))) {
486 dev_dbg(dev->dev, "failed to copy data from userland\n");
487 rets = -EFAULT;
488 goto out;
489 }
490 rets = mei_ioctl_client_notify_request(file, notify_req);
491 break;
492
493 case IOCTL_MEI_NOTIFY_GET:
494 dev_dbg(dev->dev, ": IOCTL_MEI_NOTIFY_GET.\n");
495 rets = mei_ioctl_client_notify_get(file, &notify_get);
496 if (rets)
497 goto out;
498
499 dev_dbg(dev->dev, "copy connect data to user\n");
500 if (copy_to_user((char __user *)data,
501 &notify_get, sizeof(notify_get))) {
502 dev_dbg(dev->dev, "failed to copy data to userland\n");
503 rets = -EFAULT;
504 goto out;
505
506 }
507 break;
508
Tomas Winkler4f046e72014-08-21 14:29:22 +0300509 default:
Tomas Winkler2bf94cab2014-09-29 16:31:42 +0300510 dev_err(dev->dev, ": unsupported ioctl %d.\n", cmd);
Tomas Winkler4f046e72014-08-21 14:29:22 +0300511 rets = -ENOIOCTLCMD;
Oren Weilab841162011-05-15 13:43:41 +0300512 }
513
514out:
Oren Weilab841162011-05-15 13:43:41 +0300515 mutex_unlock(&dev->device_lock);
516 return rets;
517}
518
519/**
520 * mei_compat_ioctl - the compat IOCTL function
521 *
522 * @file: pointer to file structure
523 * @cmd: ioctl command
524 * @data: pointer to mei message structure
525 *
Alexander Usyskina8605ea2014-09-29 16:31:49 +0300526 * Return: 0 on success , <0 on error
Oren Weilab841162011-05-15 13:43:41 +0300527 */
528#ifdef CONFIG_COMPAT
529static long mei_compat_ioctl(struct file *file,
Tomas Winkler441ab502011-12-13 23:39:34 +0200530 unsigned int cmd, unsigned long data)
Oren Weilab841162011-05-15 13:43:41 +0300531{
532 return mei_ioctl(file, cmd, (unsigned long)compat_ptr(data));
533}
534#endif
535
536
537/**
538 * mei_poll - the poll function
539 *
540 * @file: pointer to file structure
541 * @wait: pointer to poll_table structure
542 *
Alexander Usyskina8605ea2014-09-29 16:31:49 +0300543 * Return: poll mask
Oren Weilab841162011-05-15 13:43:41 +0300544 */
545static unsigned int mei_poll(struct file *file, poll_table *wait)
546{
Tomas Winkler1d9013f2015-03-27 00:27:57 +0200547 unsigned long req_events = poll_requested_events(wait);
Oren Weilab841162011-05-15 13:43:41 +0300548 struct mei_cl *cl = file->private_data;
549 struct mei_device *dev;
550 unsigned int mask = 0;
Tomas Winkler2c84c292015-07-26 09:54:21 +0300551 bool notify_en;
Oren Weilab841162011-05-15 13:43:41 +0300552
553 if (WARN_ON(!cl || !cl->dev))
Tomas Winklerb950ac12013-07-25 20:15:53 +0300554 return POLLERR;
Oren Weilab841162011-05-15 13:43:41 +0300555
556 dev = cl->dev;
557
558 mutex_lock(&dev->device_lock);
559
Tomas Winkler2c84c292015-07-26 09:54:21 +0300560 notify_en = cl->notify_en && (req_events & POLLPRI);
Tomas Winklerf3de9b62015-03-27 00:27:58 +0200561
562 if (dev->dev_state != MEI_DEV_ENABLED ||
563 !mei_cl_is_connected(cl)) {
Tomas Winklerb950ac12013-07-25 20:15:53 +0300564 mask = POLLERR;
Oren Weilab841162011-05-15 13:43:41 +0300565 goto out;
566 }
567
Tomas Winkler2c84c292015-07-26 09:54:21 +0300568 if (notify_en) {
569 poll_wait(file, &cl->ev_wait, wait);
570 if (cl->notify_ev)
571 mask |= POLLPRI;
572 }
573
Tomas Winkler1d9013f2015-03-27 00:27:57 +0200574 if (req_events & (POLLIN | POLLRDNORM)) {
575 poll_wait(file, &cl->rx_wait, wait);
576
577 if (!list_empty(&cl->rd_completed))
578 mask |= POLLIN | POLLRDNORM;
579 else
Tomas Winkler3030dc02016-07-26 01:06:05 +0300580 mei_cl_read_start(cl, mei_cl_mtu(cl), file);
Tomas Winkler1d9013f2015-03-27 00:27:57 +0200581 }
Oren Weilab841162011-05-15 13:43:41 +0300582
583out:
584 mutex_unlock(&dev->device_lock);
585 return mask;
586}
587
Tomas Winkler55c4e642014-11-19 17:01:39 +0200588/**
Alexander Usyskin58cde1a2017-03-20 15:04:06 +0200589 * mei_cl_is_write_queued - check if the client has pending writes.
590 *
591 * @cl: writing host client
592 *
593 * Return: true if client is writing, false otherwise.
594 */
595static bool mei_cl_is_write_queued(struct mei_cl *cl)
596{
597 struct mei_device *dev = cl->dev;
598 struct mei_cl_cb *cb;
599
600 list_for_each_entry(cb, &dev->write_list, list)
601 if (cb->cl == cl)
602 return true;
603 list_for_each_entry(cb, &dev->write_waiting_list, list)
604 if (cb->cl == cl)
605 return true;
606 return false;
607}
608
609/**
610 * mei_fsync - the fsync handler
611 *
612 * @fp: pointer to file structure
613 * @start: unused
614 * @end: unused
615 * @datasync: unused
616 *
617 * Return: 0 on success, -ENODEV if client is not connected
618 */
619static int mei_fsync(struct file *fp, loff_t start, loff_t end, int datasync)
620{
621 struct mei_cl *cl = fp->private_data;
622 struct mei_device *dev;
623 int rets;
624
625 if (WARN_ON(!cl || !cl->dev))
626 return -ENODEV;
627
628 dev = cl->dev;
629
630 mutex_lock(&dev->device_lock);
631
632 if (dev->dev_state != MEI_DEV_ENABLED || !mei_cl_is_connected(cl)) {
633 rets = -ENODEV;
634 goto out;
635 }
636
637 while (mei_cl_is_write_queued(cl)) {
638 mutex_unlock(&dev->device_lock);
639 rets = wait_event_interruptible(cl->tx_wait,
640 cl->writing_state == MEI_WRITE_COMPLETE ||
641 !mei_cl_is_connected(cl));
642 mutex_lock(&dev->device_lock);
643 if (rets) {
644 if (signal_pending(current))
645 rets = -EINTR;
646 goto out;
647 }
648 if (!mei_cl_is_connected(cl)) {
649 rets = -ENODEV;
650 goto out;
651 }
652 }
653 rets = 0;
654out:
655 mutex_unlock(&dev->device_lock);
656 return rets;
657}
658
659/**
Tomas Winkler237092b2015-07-26 09:54:22 +0300660 * mei_fasync - asynchronous io support
661 *
662 * @fd: file descriptor
663 * @file: pointer to file structure
664 * @band: band bitmap
665 *
Tomas Winklered6dc532016-01-07 14:46:38 +0200666 * Return: negative on error,
667 * 0 if it did no changes,
668 * and positive a process was added or deleted
Tomas Winkler237092b2015-07-26 09:54:22 +0300669 */
670static int mei_fasync(int fd, struct file *file, int band)
671{
672
673 struct mei_cl *cl = file->private_data;
674
675 if (!mei_cl_is_connected(cl))
Tomas Winklered6dc532016-01-07 14:46:38 +0200676 return -ENODEV;
Tomas Winkler237092b2015-07-26 09:54:22 +0300677
678 return fasync_helper(fd, file, band, &cl->ev_async);
679}
680
681/**
Alexander Usyskin88d1bec2016-10-30 01:42:18 +0200682 * fw_status_show - mei device fw_status attribute show method
Tomas Winkler55c4e642014-11-19 17:01:39 +0200683 *
684 * @device: device pointer
685 * @attr: attribute pointer
686 * @buf: char out buffer
687 *
688 * Return: number of the bytes printed into buf or error
689 */
690static ssize_t fw_status_show(struct device *device,
691 struct device_attribute *attr, char *buf)
692{
693 struct mei_device *dev = dev_get_drvdata(device);
694 struct mei_fw_status fw_status;
695 int err, i;
696 ssize_t cnt = 0;
697
698 mutex_lock(&dev->device_lock);
699 err = mei_fw_status(dev, &fw_status);
700 mutex_unlock(&dev->device_lock);
701 if (err) {
702 dev_err(device, "read fw_status error = %d\n", err);
703 return err;
704 }
705
706 for (i = 0; i < fw_status.count; i++)
707 cnt += scnprintf(buf + cnt, PAGE_SIZE - cnt, "%08X\n",
708 fw_status.status[i]);
709 return cnt;
710}
711static DEVICE_ATTR_RO(fw_status);
712
Alexander Usyskin88d1bec2016-10-30 01:42:18 +0200713/**
714 * hbm_ver_show - display HBM protocol version negotiated with FW
715 *
716 * @device: device pointer
717 * @attr: attribute pointer
718 * @buf: char out buffer
719 *
720 * Return: number of the bytes printed into buf or error
721 */
722static ssize_t hbm_ver_show(struct device *device,
723 struct device_attribute *attr, char *buf)
724{
725 struct mei_device *dev = dev_get_drvdata(device);
726 struct hbm_version ver;
727
728 mutex_lock(&dev->device_lock);
729 ver = dev->version;
730 mutex_unlock(&dev->device_lock);
731
732 return sprintf(buf, "%u.%u\n", ver.major_version, ver.minor_version);
733}
734static DEVICE_ATTR_RO(hbm_ver);
735
736/**
737 * hbm_ver_drv_show - display HBM protocol version advertised by driver
738 *
739 * @device: device pointer
740 * @attr: attribute pointer
741 * @buf: char out buffer
742 *
743 * Return: number of the bytes printed into buf or error
744 */
745static ssize_t hbm_ver_drv_show(struct device *device,
746 struct device_attribute *attr, char *buf)
747{
748 return sprintf(buf, "%u.%u\n", HBM_MAJOR_VERSION, HBM_MINOR_VERSION);
749}
750static DEVICE_ATTR_RO(hbm_ver_drv);
751
Tomas Winkler55c4e642014-11-19 17:01:39 +0200752static struct attribute *mei_attrs[] = {
753 &dev_attr_fw_status.attr,
Alexander Usyskin88d1bec2016-10-30 01:42:18 +0200754 &dev_attr_hbm_ver.attr,
755 &dev_attr_hbm_ver_drv.attr,
Tomas Winkler55c4e642014-11-19 17:01:39 +0200756 NULL
757};
758ATTRIBUTE_GROUPS(mei);
759
Oren Weil5b881e32011-11-13 09:41:14 +0200760/*
761 * file operations structure will be used for mei char device.
762 */
763static const struct file_operations mei_fops = {
764 .owner = THIS_MODULE,
765 .read = mei_read,
766 .unlocked_ioctl = mei_ioctl,
767#ifdef CONFIG_COMPAT
768 .compat_ioctl = mei_compat_ioctl,
769#endif
770 .open = mei_open,
771 .release = mei_release,
772 .write = mei_write,
773 .poll = mei_poll,
Alexander Usyskin58cde1a2017-03-20 15:04:06 +0200774 .fsync = mei_fsync,
Tomas Winkler237092b2015-07-26 09:54:22 +0300775 .fasync = mei_fasync,
Oren Weil5b881e32011-11-13 09:41:14 +0200776 .llseek = no_llseek
777};
778
Alexander Usyskinf3d8e872014-06-23 15:10:35 +0300779static struct class *mei_class;
780static dev_t mei_devt;
781#define MEI_MAX_DEVS MINORMASK
782static DEFINE_MUTEX(mei_minor_lock);
783static DEFINE_IDR(mei_idr);
784
785/**
786 * mei_minor_get - obtain next free device minor number
787 *
788 * @dev: device pointer
789 *
Alexander Usyskina8605ea2014-09-29 16:31:49 +0300790 * Return: allocated minor, or -ENOSPC if no free minor left
Oren Weil5b881e32011-11-13 09:41:14 +0200791 */
Alexander Usyskinf3d8e872014-06-23 15:10:35 +0300792static int mei_minor_get(struct mei_device *dev)
Tomas Winkler9a123f12012-08-06 15:23:55 +0300793{
Tomas Winkler30e53bb2013-04-05 22:10:34 +0300794 int ret;
Alexander Usyskinf3d8e872014-06-23 15:10:35 +0300795
796 mutex_lock(&mei_minor_lock);
797 ret = idr_alloc(&mei_idr, dev, 0, MEI_MAX_DEVS, GFP_KERNEL);
798 if (ret >= 0)
799 dev->minor = ret;
800 else if (ret == -ENOSPC)
Tomas Winkler2bf94cab2014-09-29 16:31:42 +0300801 dev_err(dev->dev, "too many mei devices\n");
Alexander Usyskinf3d8e872014-06-23 15:10:35 +0300802
803 mutex_unlock(&mei_minor_lock);
804 return ret;
805}
806
807/**
808 * mei_minor_free - mark device minor number as free
809 *
810 * @dev: device pointer
811 */
812static void mei_minor_free(struct mei_device *dev)
813{
814 mutex_lock(&mei_minor_lock);
815 idr_remove(&mei_idr, dev->minor);
816 mutex_unlock(&mei_minor_lock);
817}
818
819int mei_register(struct mei_device *dev, struct device *parent)
820{
821 struct device *clsdev; /* class device */
822 int ret, devno;
823
824 ret = mei_minor_get(dev);
825 if (ret < 0)
Tomas Winkler30e53bb2013-04-05 22:10:34 +0300826 return ret;
827
Alexander Usyskinf3d8e872014-06-23 15:10:35 +0300828 /* Fill in the data structures */
829 devno = MKDEV(MAJOR(mei_devt), dev->minor);
830 cdev_init(&dev->cdev, &mei_fops);
Tomas Winkler154322f2015-06-18 11:41:03 +0300831 dev->cdev.owner = parent->driver->owner;
Alexander Usyskinf3d8e872014-06-23 15:10:35 +0300832
833 /* Add the device */
834 ret = cdev_add(&dev->cdev, devno, 1);
835 if (ret) {
836 dev_err(parent, "unable to add device %d:%d\n",
837 MAJOR(mei_devt), dev->minor);
838 goto err_dev_add;
839 }
840
Tomas Winkler55c4e642014-11-19 17:01:39 +0200841 clsdev = device_create_with_groups(mei_class, parent, devno,
842 dev, mei_groups,
843 "mei%d", dev->minor);
Alexander Usyskinf3d8e872014-06-23 15:10:35 +0300844
845 if (IS_ERR(clsdev)) {
846 dev_err(parent, "unable to create device %d:%d\n",
847 MAJOR(mei_devt), dev->minor);
848 ret = PTR_ERR(clsdev);
849 goto err_dev_create;
850 }
851
852 ret = mei_dbgfs_register(dev, dev_name(clsdev));
853 if (ret) {
854 dev_err(clsdev, "cannot register debugfs ret = %d\n", ret);
855 goto err_dev_dbgfs;
856 }
Tomas Winkler30e53bb2013-04-05 22:10:34 +0300857
858 return 0;
Alexander Usyskinf3d8e872014-06-23 15:10:35 +0300859
860err_dev_dbgfs:
861 device_destroy(mei_class, devno);
862err_dev_create:
863 cdev_del(&dev->cdev);
864err_dev_add:
865 mei_minor_free(dev);
866 return ret;
Oren Weil5b881e32011-11-13 09:41:14 +0200867}
Tomas Winkler40e0b672013-03-27 16:58:30 +0200868EXPORT_SYMBOL_GPL(mei_register);
Oren Weil5b881e32011-11-13 09:41:14 +0200869
Tomas Winkler30e53bb2013-04-05 22:10:34 +0300870void mei_deregister(struct mei_device *dev)
Oren Weil5b881e32011-11-13 09:41:14 +0200871{
Alexander Usyskinf3d8e872014-06-23 15:10:35 +0300872 int devno;
873
874 devno = dev->cdev.dev;
875 cdev_del(&dev->cdev);
876
Tomas Winkler30e53bb2013-04-05 22:10:34 +0300877 mei_dbgfs_deregister(dev);
Alexander Usyskinf3d8e872014-06-23 15:10:35 +0300878
879 device_destroy(mei_class, devno);
880
881 mei_minor_free(dev);
Oren Weilab841162011-05-15 13:43:41 +0300882}
Tomas Winkler40e0b672013-03-27 16:58:30 +0200883EXPORT_SYMBOL_GPL(mei_deregister);
Oren Weilab841162011-05-15 13:43:41 +0300884
Samuel Ortizcf3baef2013-03-27 17:29:57 +0200885static int __init mei_init(void)
886{
Alexander Usyskinf3d8e872014-06-23 15:10:35 +0300887 int ret;
888
889 mei_class = class_create(THIS_MODULE, "mei");
890 if (IS_ERR(mei_class)) {
891 pr_err("couldn't create class\n");
892 ret = PTR_ERR(mei_class);
893 goto err;
894 }
895
896 ret = alloc_chrdev_region(&mei_devt, 0, MEI_MAX_DEVS, "mei");
897 if (ret < 0) {
898 pr_err("unable to allocate char dev region\n");
899 goto err_class;
900 }
901
902 ret = mei_cl_bus_init();
903 if (ret < 0) {
904 pr_err("unable to initialize bus\n");
905 goto err_chrdev;
906 }
907
908 return 0;
909
910err_chrdev:
911 unregister_chrdev_region(mei_devt, MEI_MAX_DEVS);
912err_class:
913 class_destroy(mei_class);
914err:
915 return ret;
Samuel Ortizcf3baef2013-03-27 17:29:57 +0200916}
917
918static void __exit mei_exit(void)
919{
Alexander Usyskinf3d8e872014-06-23 15:10:35 +0300920 unregister_chrdev_region(mei_devt, MEI_MAX_DEVS);
921 class_destroy(mei_class);
Samuel Ortizcf3baef2013-03-27 17:29:57 +0200922 mei_cl_bus_exit();
923}
924
925module_init(mei_init);
926module_exit(mei_exit);
927
Tomas Winkler40e0b672013-03-27 16:58:30 +0200928MODULE_AUTHOR("Intel Corporation");
929MODULE_DESCRIPTION("Intel(R) Management Engine Interface");
Tomas Winkler827eef52013-02-06 14:06:41 +0200930MODULE_LICENSE("GPL v2");
Oren Weilab841162011-05-15 13:43:41 +0300931