Commit | Line | Data |
---|---|---|
9fff0425 | 1 | // SPDX-License-Identifier: GPL-2.0 |
ab841160 | 2 | /* |
1e55b609 | 3 | * Copyright (c) 2003-2018, Intel Corporation. All rights reserved. |
ab841160 | 4 | * Intel Management Engine Interface (Intel MEI) Linux driver |
ab841160 | 5 | */ |
9fff0425 | 6 | |
ab841160 OW |
7 | #include <linux/module.h> |
8 | #include <linux/moduleparam.h> | |
9 | #include <linux/kernel.h> | |
10 | #include <linux/device.h> | |
1f180359 | 11 | #include <linux/slab.h> |
ab841160 OW |
12 | #include <linux/fs.h> |
13 | #include <linux/errno.h> | |
14 | #include <linux/types.h> | |
15 | #include <linux/fcntl.h> | |
ab841160 OW |
16 | #include <linux/poll.h> |
17 | #include <linux/init.h> | |
18 | #include <linux/ioctl.h> | |
19 | #include <linux/cdev.h> | |
174cd4b1 | 20 | #include <linux/sched/signal.h> |
ab841160 OW |
21 | #include <linux/uuid.h> |
22 | #include <linux/compat.h> | |
23 | #include <linux/jiffies.h> | |
24 | #include <linux/interrupt.h> | |
25 | ||
4f3afe1d | 26 | #include <linux/mei.h> |
47a73801 TW |
27 | |
28 | #include "mei_dev.h" | |
90e0b5f1 | 29 | #include "client.h" |
ab841160 | 30 | |
43b8a7ed AU |
31 | static struct class *mei_class; |
32 | static dev_t mei_devt; | |
33 | #define MEI_MAX_DEVS MINORMASK | |
34 | static DEFINE_MUTEX(mei_minor_lock); | |
35 | static DEFINE_IDR(mei_idr); | |
36 | ||
ab841160 OW |
37 | /** |
38 | * mei_open - the open function | |
39 | * | |
40 | * @inode: pointer to inode structure | |
41 | * @file: pointer to file structure | |
83ce0741 | 42 | * |
a8605ea2 | 43 | * Return: 0 on success, <0 on error |
ab841160 OW |
44 | */ |
45 | static int mei_open(struct inode *inode, struct file *file) | |
46 | { | |
ab841160 | 47 | struct mei_device *dev; |
f3d8e878 | 48 | struct mei_cl *cl; |
2703d4b2 | 49 | |
6f37aca8 | 50 | int err; |
ab841160 | 51 | |
f3d8e878 | 52 | dev = container_of(inode->i_cdev, struct mei_device, cdev); |
5b881e3c | 53 | if (!dev) |
e036cc57 | 54 | return -ENODEV; |
ab841160 OW |
55 | |
56 | mutex_lock(&dev->device_lock); | |
e036cc57 | 57 | |
b210d750 | 58 | if (dev->dev_state != MEI_DEV_ENABLED) { |
2bf94cab | 59 | dev_dbg(dev->dev, "dev_state != MEI_ENABLED dev_state = %s\n", |
b210d750 | 60 | mei_dev_state_str(dev->dev_state)); |
03b8d341 | 61 | err = -ENODEV; |
e036cc57 | 62 | goto err_unlock; |
1b812947 | 63 | } |
ab841160 | 64 | |
7851e008 | 65 | cl = mei_cl_alloc_linked(dev); |
03b8d341 TW |
66 | if (IS_ERR(cl)) { |
67 | err = PTR_ERR(cl); | |
e036cc57 | 68 | goto err_unlock; |
03b8d341 | 69 | } |
ab841160 | 70 | |
97d549b4 | 71 | cl->fp = file; |
ab841160 | 72 | file->private_data = cl; |
e036cc57 | 73 | |
ab841160 OW |
74 | mutex_unlock(&dev->device_lock); |
75 | ||
5b881e3c | 76 | return nonseekable_open(inode, file); |
ab841160 | 77 | |
e036cc57 | 78 | err_unlock: |
ab841160 | 79 | mutex_unlock(&dev->device_lock); |
ab841160 OW |
80 | return err; |
81 | } | |
82 | ||
83 | /** | |
84 | * mei_release - the release function | |
85 | * | |
86 | * @inode: pointer to inode structure | |
87 | * @file: pointer to file structure | |
88 | * | |
a8605ea2 | 89 | * Return: 0 on success, <0 on error |
ab841160 OW |
90 | */ |
91 | static int mei_release(struct inode *inode, struct file *file) | |
92 | { | |
93 | struct mei_cl *cl = file->private_data; | |
ab841160 | 94 | struct mei_device *dev; |
3c666182 | 95 | int rets; |
ab841160 OW |
96 | |
97 | if (WARN_ON(!cl || !cl->dev)) | |
98 | return -ENODEV; | |
99 | ||
100 | dev = cl->dev; | |
101 | ||
102 | mutex_lock(&dev->device_lock); | |
394a77d0 | 103 | |
3c666182 TW |
104 | rets = mei_cl_disconnect(cl); |
105 | ||
a9bed610 | 106 | mei_cl_flush_queues(cl, file); |
46922186 | 107 | cl_dbg(dev, cl, "removing\n"); |
a562d5c2 | 108 | |
90e0b5f1 | 109 | mei_cl_unlink(cl); |
a562d5c2 | 110 | |
a562d5c2 | 111 | file->private_data = NULL; |
ab841160 | 112 | |
a562d5c2 | 113 | kfree(cl); |
394a77d0 | 114 | |
ab841160 OW |
115 | mutex_unlock(&dev->device_lock); |
116 | return rets; | |
117 | } | |
118 | ||
119 | ||
120 | /** | |
121 | * mei_read - the read function. | |
122 | * | |
123 | * @file: pointer to file structure | |
124 | * @ubuf: pointer to user buffer | |
125 | * @length: buffer length | |
126 | * @offset: data offset in buffer | |
127 | * | |
a8605ea2 | 128 | * Return: >=0 data length on success , <0 on error |
ab841160 OW |
129 | */ |
130 | static ssize_t mei_read(struct file *file, char __user *ubuf, | |
441ab50f | 131 | size_t length, loff_t *offset) |
ab841160 OW |
132 | { |
133 | struct mei_cl *cl = file->private_data; | |
ab841160 | 134 | struct mei_device *dev; |
a9bed610 | 135 | struct mei_cl_cb *cb = NULL; |
ff1586a7 | 136 | bool nonblock = !!(file->f_flags & O_NONBLOCK); |
5151e2b5 | 137 | ssize_t rets; |
ab841160 OW |
138 | |
139 | if (WARN_ON(!cl || !cl->dev)) | |
140 | return -ENODEV; | |
141 | ||
142 | dev = cl->dev; | |
143 | ||
dd5de1f1 | 144 | |
ab841160 | 145 | mutex_lock(&dev->device_lock); |
b210d750 | 146 | if (dev->dev_state != MEI_DEV_ENABLED) { |
ab841160 OW |
147 | rets = -ENODEV; |
148 | goto out; | |
149 | } | |
150 | ||
dd5de1f1 TW |
151 | if (length == 0) { |
152 | rets = 0; | |
153 | goto out; | |
154 | } | |
155 | ||
8b2458f4 AU |
156 | if (ubuf == NULL) { |
157 | rets = -EMSGSIZE; | |
158 | goto out; | |
159 | } | |
160 | ||
a9bed610 | 161 | cb = mei_cl_read_cb(cl, file); |
8b2458f4 AU |
162 | if (cb) |
163 | goto copy_buffer; | |
164 | ||
165 | if (*offset > 0) | |
ab841160 | 166 | *offset = 0; |
ab841160 | 167 | |
ff1586a7 AU |
168 | rets = mei_cl_read_start(cl, length, file); |
169 | if (rets && rets != -EBUSY) { | |
5151e2b5 | 170 | cl_dbg(dev, cl, "mei start read failure status = %zd\n", rets); |
ab841160 OW |
171 | goto out; |
172 | } | |
173 | ||
ff1586a7 AU |
174 | if (nonblock) { |
175 | rets = -EAGAIN; | |
176 | goto out; | |
177 | } | |
178 | ||
cb97fbbc AU |
179 | mutex_unlock(&dev->device_lock); |
180 | if (wait_event_interruptible(cl->rx_wait, | |
181 | !list_empty(&cl->rd_completed) || | |
182 | !mei_cl_is_connected(cl))) { | |
183 | if (signal_pending(current)) | |
184 | return -EINTR; | |
185 | return -ERESTARTSYS; | |
186 | } | |
187 | mutex_lock(&dev->device_lock); | |
e2b31644 | 188 | |
cb97fbbc AU |
189 | if (!mei_cl_is_connected(cl)) { |
190 | rets = -ENODEV; | |
191 | goto out; | |
192 | } | |
ab841160 | 193 | |
cb97fbbc AU |
194 | cb = mei_cl_read_cb(cl, file); |
195 | if (!cb) { | |
cb97fbbc AU |
196 | rets = 0; |
197 | goto out; | |
198 | } | |
3d33ff24 | 199 | |
ab841160 | 200 | copy_buffer: |
3d33ff24 TW |
201 | /* now copy the data to user space */ |
202 | if (cb->status) { | |
203 | rets = cb->status; | |
5151e2b5 | 204 | cl_dbg(dev, cl, "read operation failed %zd\n", rets); |
3d33ff24 TW |
205 | goto free; |
206 | } | |
207 | ||
35bf7692 | 208 | cl_dbg(dev, cl, "buf.size = %zu buf.idx = %zu offset = %lld\n", |
8b2458f4 AU |
209 | cb->buf.size, cb->buf_idx, *offset); |
210 | if (*offset >= cb->buf_idx) { | |
211 | rets = 0; | |
ab841160 OW |
212 | goto free; |
213 | } | |
214 | ||
ebb108ef TW |
215 | /* length is being truncated to PAGE_SIZE, |
216 | * however buf_idx may point beyond that */ | |
217 | length = min_t(size_t, length, cb->buf_idx - *offset); | |
ab841160 | 218 | |
5db7514d | 219 | if (copy_to_user(ubuf, cb->buf.data + *offset, length)) { |
2bf94cab | 220 | dev_dbg(dev->dev, "failed to copy data to userland\n"); |
ab841160 OW |
221 | rets = -EFAULT; |
222 | goto free; | |
223 | } | |
224 | ||
225 | rets = length; | |
226 | *offset += length; | |
f862b6b2 TW |
227 | /* not all data was read, keep the cb */ |
228 | if (*offset < cb->buf_idx) | |
ab841160 OW |
229 | goto out; |
230 | ||
231 | free: | |
601a1efa | 232 | mei_io_cb_free(cb); |
8b2458f4 | 233 | *offset = 0; |
928fa666 | 234 | |
ab841160 | 235 | out: |
5151e2b5 | 236 | cl_dbg(dev, cl, "end mei read rets = %zd\n", rets); |
ab841160 OW |
237 | mutex_unlock(&dev->device_lock); |
238 | return rets; | |
239 | } | |
ab841160 OW |
240 | /** |
241 | * mei_write - the write function. | |
242 | * | |
243 | * @file: pointer to file structure | |
244 | * @ubuf: pointer to user buffer | |
245 | * @length: buffer length | |
246 | * @offset: data offset in buffer | |
247 | * | |
a8605ea2 | 248 | * Return: >=0 data length on success , <0 on error |
ab841160 OW |
249 | */ |
250 | static ssize_t mei_write(struct file *file, const char __user *ubuf, | |
441ab50f | 251 | size_t length, loff_t *offset) |
ab841160 OW |
252 | { |
253 | struct mei_cl *cl = file->private_data; | |
6cbb097f | 254 | struct mei_cl_cb *cb; |
ab841160 | 255 | struct mei_device *dev; |
5151e2b5 | 256 | ssize_t rets; |
ab841160 OW |
257 | |
258 | if (WARN_ON(!cl || !cl->dev)) | |
259 | return -ENODEV; | |
260 | ||
261 | dev = cl->dev; | |
262 | ||
263 | mutex_lock(&dev->device_lock); | |
264 | ||
b210d750 | 265 | if (dev->dev_state != MEI_DEV_ENABLED) { |
75f0ee15 | 266 | rets = -ENODEV; |
4234a6de | 267 | goto out; |
ab841160 OW |
268 | } |
269 | ||
d49ed64a AU |
270 | if (!mei_cl_is_connected(cl)) { |
271 | cl_err(dev, cl, "is not connected"); | |
272 | rets = -ENODEV; | |
4234a6de | 273 | goto out; |
75f0ee15 | 274 | } |
dd5de1f1 | 275 | |
d49ed64a AU |
276 | if (!mei_me_cl_is_active(cl->me_cl)) { |
277 | rets = -ENOTTY; | |
dd5de1f1 TW |
278 | goto out; |
279 | } | |
280 | ||
d49ed64a | 281 | if (length > mei_cl_mtu(cl)) { |
dd5de1f1 | 282 | rets = -EFBIG; |
4234a6de | 283 | goto out; |
75f0ee15 TW |
284 | } |
285 | ||
d49ed64a AU |
286 | if (length == 0) { |
287 | rets = 0; | |
4234a6de | 288 | goto out; |
75f0ee15 | 289 | } |
d49ed64a | 290 | |
af336cab AU |
291 | while (cl->tx_cb_queued >= dev->tx_queue_limit) { |
292 | if (file->f_flags & O_NONBLOCK) { | |
293 | rets = -EAGAIN; | |
294 | goto out; | |
295 | } | |
296 | mutex_unlock(&dev->device_lock); | |
297 | rets = wait_event_interruptible(cl->tx_wait, | |
298 | cl->writing_state == MEI_WRITE_COMPLETE || | |
299 | (!mei_cl_is_connected(cl))); | |
300 | mutex_lock(&dev->device_lock); | |
301 | if (rets) { | |
302 | if (signal_pending(current)) | |
303 | rets = -EINTR; | |
304 | goto out; | |
305 | } | |
306 | if (!mei_cl_is_connected(cl)) { | |
307 | rets = -ENODEV; | |
308 | goto out; | |
309 | } | |
310 | } | |
311 | ||
6cbb097f AU |
312 | cb = mei_cl_alloc_cb(cl, length, MEI_FOP_WRITE, file); |
313 | if (!cb) { | |
33d28c92 | 314 | rets = -ENOMEM; |
4234a6de | 315 | goto out; |
ab841160 | 316 | } |
ab841160 | 317 | |
6cbb097f | 318 | rets = copy_from_user(cb->buf.data, ubuf, length); |
d8b29efa | 319 | if (rets) { |
2bf94cab | 320 | dev_dbg(dev->dev, "failed to copy data from userland\n"); |
d8b29efa | 321 | rets = -EFAULT; |
6cbb097f | 322 | mei_io_cb_free(cb); |
4234a6de | 323 | goto out; |
d8b29efa | 324 | } |
ab841160 | 325 | |
e0cb6b2f | 326 | rets = mei_cl_write(cl, cb); |
b0d0cf77 | 327 | out: |
ab841160 | 328 | mutex_unlock(&dev->device_lock); |
ab841160 OW |
329 | return rets; |
330 | } | |
331 | ||
9f81abda TW |
332 | /** |
333 | * mei_ioctl_connect_client - the connect to fw client IOCTL function | |
334 | * | |
9f81abda | 335 | * @file: private data of the file object |
a8605ea2 | 336 | * @data: IOCTL connect data, input and output parameters |
9f81abda TW |
337 | * |
338 | * Locking: called under "dev->device_lock" lock | |
339 | * | |
a8605ea2 | 340 | * Return: 0 on success, <0 on failure. |
9f81abda TW |
341 | */ |
342 | static int mei_ioctl_connect_client(struct file *file, | |
343 | struct mei_connect_client_data *data) | |
344 | { | |
345 | struct mei_device *dev; | |
346 | struct mei_client *client; | |
d320832f | 347 | struct mei_me_client *me_cl; |
9f81abda | 348 | struct mei_cl *cl; |
9f81abda TW |
349 | int rets; |
350 | ||
351 | cl = file->private_data; | |
9f81abda TW |
352 | dev = cl->dev; |
353 | ||
79563db9 TW |
354 | if (dev->dev_state != MEI_DEV_ENABLED) |
355 | return -ENODEV; | |
9f81abda TW |
356 | |
357 | if (cl->state != MEI_FILE_INITIALIZING && | |
79563db9 TW |
358 | cl->state != MEI_FILE_DISCONNECTED) |
359 | return -EBUSY; | |
9f81abda TW |
360 | |
361 | /* find ME client we're trying to connect to */ | |
d320832f | 362 | me_cl = mei_me_cl_by_uuid(dev, &data->in_client_uuid); |
f4e06246 | 363 | if (!me_cl) { |
2bf94cab | 364 | dev_dbg(dev->dev, "Cannot connect to FW Client UUID = %pUl\n", |
d49ed64a | 365 | &data->in_client_uuid); |
f4e06246 AU |
366 | rets = -ENOTTY; |
367 | goto end; | |
368 | } | |
369 | ||
370 | if (me_cl->props.fixed_address) { | |
371 | bool forbidden = dev->override_fixed_address ? | |
372 | !dev->allow_fixed_address : !dev->hbm_f_fa_supported; | |
373 | if (forbidden) { | |
374 | dev_dbg(dev->dev, "Connection forbidden to FW Client UUID = %pUl\n", | |
375 | &data->in_client_uuid); | |
376 | rets = -ENOTTY; | |
377 | goto end; | |
378 | } | |
9f81abda TW |
379 | } |
380 | ||
2bf94cab | 381 | dev_dbg(dev->dev, "Connect to FW Client ID = %d\n", |
d49ed64a | 382 | me_cl->client_id); |
2bf94cab | 383 | dev_dbg(dev->dev, "FW Client - Protocol Version = %d\n", |
d320832f | 384 | me_cl->props.protocol_version); |
2bf94cab | 385 | dev_dbg(dev->dev, "FW Client - Max Msg Len = %d\n", |
d320832f | 386 | me_cl->props.max_msg_length); |
9f81abda | 387 | |
9f81abda TW |
388 | /* prepare the output buffer */ |
389 | client = &data->out_client_properties; | |
d320832f TW |
390 | client->max_msg_length = me_cl->props.max_msg_length; |
391 | client->protocol_version = me_cl->props.protocol_version; | |
2bf94cab | 392 | dev_dbg(dev->dev, "Can connect?\n"); |
9f81abda | 393 | |
d49ed64a | 394 | rets = mei_cl_connect(cl, me_cl, file); |
9f81abda TW |
395 | |
396 | end: | |
79563db9 | 397 | mei_me_cl_put(me_cl); |
9f81abda TW |
398 | return rets; |
399 | } | |
400 | ||
3c7c8468 TW |
401 | /** |
402 | * mei_ioctl_client_notify_request - | |
403 | * propagate event notification request to client | |
404 | * | |
405 | * @file: pointer to file structure | |
406 | * @request: 0 - disable, 1 - enable | |
407 | * | |
408 | * Return: 0 on success , <0 on error | |
409 | */ | |
f23e2cc4 | 410 | static int mei_ioctl_client_notify_request(const struct file *file, u32 request) |
3c7c8468 TW |
411 | { |
412 | struct mei_cl *cl = file->private_data; | |
413 | ||
7326fffb AU |
414 | if (request != MEI_HBM_NOTIFICATION_START && |
415 | request != MEI_HBM_NOTIFICATION_STOP) | |
416 | return -EINVAL; | |
417 | ||
418 | return mei_cl_notify_request(cl, file, (u8)request); | |
3c7c8468 TW |
419 | } |
420 | ||
421 | /** | |
422 | * mei_ioctl_client_notify_get - wait for notification request | |
423 | * | |
424 | * @file: pointer to file structure | |
425 | * @notify_get: 0 - disable, 1 - enable | |
426 | * | |
427 | * Return: 0 on success , <0 on error | |
428 | */ | |
f23e2cc4 | 429 | static int mei_ioctl_client_notify_get(const struct file *file, u32 *notify_get) |
3c7c8468 TW |
430 | { |
431 | struct mei_cl *cl = file->private_data; | |
432 | bool notify_ev; | |
433 | bool block = (file->f_flags & O_NONBLOCK) == 0; | |
434 | int rets; | |
435 | ||
436 | rets = mei_cl_notify_get(cl, block, ¬ify_ev); | |
437 | if (rets) | |
438 | return rets; | |
439 | ||
440 | *notify_get = notify_ev ? 1 : 0; | |
441 | return 0; | |
442 | } | |
443 | ||
ab841160 OW |
444 | /** |
445 | * mei_ioctl - the IOCTL function | |
446 | * | |
447 | * @file: pointer to file structure | |
448 | * @cmd: ioctl command | |
449 | * @data: pointer to mei message structure | |
450 | * | |
a8605ea2 | 451 | * Return: 0 on success , <0 on error |
ab841160 OW |
452 | */ |
453 | static long mei_ioctl(struct file *file, unsigned int cmd, unsigned long data) | |
454 | { | |
455 | struct mei_device *dev; | |
456 | struct mei_cl *cl = file->private_data; | |
154eb18f | 457 | struct mei_connect_client_data connect_data; |
3c7c8468 | 458 | u32 notify_get, notify_req; |
ab841160 OW |
459 | int rets; |
460 | ||
ab841160 OW |
461 | |
462 | if (WARN_ON(!cl || !cl->dev)) | |
463 | return -ENODEV; | |
464 | ||
465 | dev = cl->dev; | |
466 | ||
2bf94cab | 467 | dev_dbg(dev->dev, "IOCTL cmd = 0x%x", cmd); |
ab841160 OW |
468 | |
469 | mutex_lock(&dev->device_lock); | |
b210d750 | 470 | if (dev->dev_state != MEI_DEV_ENABLED) { |
ab841160 OW |
471 | rets = -ENODEV; |
472 | goto out; | |
473 | } | |
474 | ||
4f046e7b TW |
475 | switch (cmd) { |
476 | case IOCTL_MEI_CONNECT_CLIENT: | |
2bf94cab | 477 | dev_dbg(dev->dev, ": IOCTL_MEI_CONNECT_CLIENT.\n"); |
154eb18f | 478 | if (copy_from_user(&connect_data, (char __user *)data, |
4f046e7b | 479 | sizeof(struct mei_connect_client_data))) { |
2bf94cab | 480 | dev_dbg(dev->dev, "failed to copy data from userland\n"); |
4f046e7b TW |
481 | rets = -EFAULT; |
482 | goto out; | |
483 | } | |
ab841160 | 484 | |
154eb18f | 485 | rets = mei_ioctl_connect_client(file, &connect_data); |
4f046e7b TW |
486 | if (rets) |
487 | goto out; | |
ab841160 | 488 | |
4f046e7b | 489 | /* if all is ok, copying the data back to user. */ |
154eb18f | 490 | if (copy_to_user((char __user *)data, &connect_data, |
ab841160 | 491 | sizeof(struct mei_connect_client_data))) { |
2bf94cab | 492 | dev_dbg(dev->dev, "failed to copy data to userland\n"); |
4f046e7b TW |
493 | rets = -EFAULT; |
494 | goto out; | |
495 | } | |
496 | ||
497 | break; | |
154eb18f | 498 | |
3c7c8468 TW |
499 | case IOCTL_MEI_NOTIFY_SET: |
500 | dev_dbg(dev->dev, ": IOCTL_MEI_NOTIFY_SET.\n"); | |
501 | if (copy_from_user(¬ify_req, | |
502 | (char __user *)data, sizeof(notify_req))) { | |
503 | dev_dbg(dev->dev, "failed to copy data from userland\n"); | |
504 | rets = -EFAULT; | |
505 | goto out; | |
506 | } | |
507 | rets = mei_ioctl_client_notify_request(file, notify_req); | |
508 | break; | |
509 | ||
510 | case IOCTL_MEI_NOTIFY_GET: | |
511 | dev_dbg(dev->dev, ": IOCTL_MEI_NOTIFY_GET.\n"); | |
512 | rets = mei_ioctl_client_notify_get(file, ¬ify_get); | |
513 | if (rets) | |
514 | goto out; | |
515 | ||
516 | dev_dbg(dev->dev, "copy connect data to user\n"); | |
517 | if (copy_to_user((char __user *)data, | |
518 | ¬ify_get, sizeof(notify_get))) { | |
519 | dev_dbg(dev->dev, "failed to copy data to userland\n"); | |
520 | rets = -EFAULT; | |
521 | goto out; | |
522 | ||
523 | } | |
524 | break; | |
525 | ||
4f046e7b | 526 | default: |
4f046e7b | 527 | rets = -ENOIOCTLCMD; |
ab841160 OW |
528 | } |
529 | ||
530 | out: | |
ab841160 OW |
531 | mutex_unlock(&dev->device_lock); |
532 | return rets; | |
533 | } | |
534 | ||
535 | /** | |
536 | * mei_compat_ioctl - the compat IOCTL function | |
537 | * | |
538 | * @file: pointer to file structure | |
539 | * @cmd: ioctl command | |
540 | * @data: pointer to mei message structure | |
541 | * | |
a8605ea2 | 542 | * Return: 0 on success , <0 on error |
ab841160 OW |
543 | */ |
544 | #ifdef CONFIG_COMPAT | |
545 | static long mei_compat_ioctl(struct file *file, | |
441ab50f | 546 | unsigned int cmd, unsigned long data) |
ab841160 OW |
547 | { |
548 | return mei_ioctl(file, cmd, (unsigned long)compat_ptr(data)); | |
549 | } | |
550 | #endif | |
551 | ||
552 | ||
553 | /** | |
554 | * mei_poll - the poll function | |
555 | * | |
556 | * @file: pointer to file structure | |
557 | * @wait: pointer to poll_table structure | |
558 | * | |
a8605ea2 | 559 | * Return: poll mask |
ab841160 | 560 | */ |
afc9a42b | 561 | static __poll_t mei_poll(struct file *file, poll_table *wait) |
ab841160 | 562 | { |
01699437 | 563 | __poll_t req_events = poll_requested_events(wait); |
ab841160 OW |
564 | struct mei_cl *cl = file->private_data; |
565 | struct mei_device *dev; | |
afc9a42b | 566 | __poll_t mask = 0; |
2c84c297 | 567 | bool notify_en; |
ab841160 OW |
568 | |
569 | if (WARN_ON(!cl || !cl->dev)) | |
a9a08845 | 570 | return EPOLLERR; |
ab841160 OW |
571 | |
572 | dev = cl->dev; | |
573 | ||
574 | mutex_lock(&dev->device_lock); | |
575 | ||
a9a08845 | 576 | notify_en = cl->notify_en && (req_events & EPOLLPRI); |
f3de9b63 TW |
577 | |
578 | if (dev->dev_state != MEI_DEV_ENABLED || | |
579 | !mei_cl_is_connected(cl)) { | |
a9a08845 | 580 | mask = EPOLLERR; |
ab841160 OW |
581 | goto out; |
582 | } | |
583 | ||
2c84c297 TW |
584 | if (notify_en) { |
585 | poll_wait(file, &cl->ev_wait, wait); | |
586 | if (cl->notify_ev) | |
a9a08845 | 587 | mask |= EPOLLPRI; |
2c84c297 | 588 | } |
9fa0be8b | 589 | |
a9a08845 | 590 | if (req_events & (EPOLLIN | EPOLLRDNORM)) { |
1d9013f0 TW |
591 | poll_wait(file, &cl->rx_wait, wait); |
592 | ||
593 | if (!list_empty(&cl->rd_completed)) | |
a9a08845 | 594 | mask |= EPOLLIN | EPOLLRDNORM; |
1d9013f0 | 595 | else |
3030dc05 | 596 | mei_cl_read_start(cl, mei_cl_mtu(cl), file); |
1d9013f0 | 597 | } |
ab841160 | 598 | |
03b2cbb6 | 599 | if (req_events & (EPOLLOUT | EPOLLWRNORM)) { |
af336cab AU |
600 | poll_wait(file, &cl->tx_wait, wait); |
601 | if (cl->tx_cb_queued < dev->tx_queue_limit) | |
03b2cbb6 | 602 | mask |= EPOLLOUT | EPOLLWRNORM; |
af336cab AU |
603 | } |
604 | ||
ab841160 OW |
605 | out: |
606 | mutex_unlock(&dev->device_lock); | |
607 | return mask; | |
608 | } | |
609 | ||
58cde1a6 AU |
610 | /** |
611 | * mei_cl_is_write_queued - check if the client has pending writes. | |
612 | * | |
613 | * @cl: writing host client | |
614 | * | |
615 | * Return: true if client is writing, false otherwise. | |
616 | */ | |
617 | static bool mei_cl_is_write_queued(struct mei_cl *cl) | |
618 | { | |
619 | struct mei_device *dev = cl->dev; | |
620 | struct mei_cl_cb *cb; | |
621 | ||
622 | list_for_each_entry(cb, &dev->write_list, list) | |
623 | if (cb->cl == cl) | |
624 | return true; | |
625 | list_for_each_entry(cb, &dev->write_waiting_list, list) | |
626 | if (cb->cl == cl) | |
627 | return true; | |
628 | return false; | |
629 | } | |
630 | ||
631 | /** | |
632 | * mei_fsync - the fsync handler | |
633 | * | |
634 | * @fp: pointer to file structure | |
635 | * @start: unused | |
636 | * @end: unused | |
637 | * @datasync: unused | |
638 | * | |
639 | * Return: 0 on success, -ENODEV if client is not connected | |
640 | */ | |
641 | static int mei_fsync(struct file *fp, loff_t start, loff_t end, int datasync) | |
642 | { | |
643 | struct mei_cl *cl = fp->private_data; | |
644 | struct mei_device *dev; | |
645 | int rets; | |
646 | ||
647 | if (WARN_ON(!cl || !cl->dev)) | |
648 | return -ENODEV; | |
649 | ||
650 | dev = cl->dev; | |
651 | ||
652 | mutex_lock(&dev->device_lock); | |
653 | ||
654 | if (dev->dev_state != MEI_DEV_ENABLED || !mei_cl_is_connected(cl)) { | |
655 | rets = -ENODEV; | |
656 | goto out; | |
657 | } | |
658 | ||
659 | while (mei_cl_is_write_queued(cl)) { | |
660 | mutex_unlock(&dev->device_lock); | |
661 | rets = wait_event_interruptible(cl->tx_wait, | |
662 | cl->writing_state == MEI_WRITE_COMPLETE || | |
663 | !mei_cl_is_connected(cl)); | |
664 | mutex_lock(&dev->device_lock); | |
665 | if (rets) { | |
666 | if (signal_pending(current)) | |
667 | rets = -EINTR; | |
668 | goto out; | |
669 | } | |
670 | if (!mei_cl_is_connected(cl)) { | |
671 | rets = -ENODEV; | |
672 | goto out; | |
673 | } | |
674 | } | |
675 | rets = 0; | |
676 | out: | |
677 | mutex_unlock(&dev->device_lock); | |
678 | return rets; | |
679 | } | |
680 | ||
237092bf TW |
681 | /** |
682 | * mei_fasync - asynchronous io support | |
683 | * | |
684 | * @fd: file descriptor | |
685 | * @file: pointer to file structure | |
686 | * @band: band bitmap | |
687 | * | |
ed6dc538 TW |
688 | * Return: negative on error, |
689 | * 0 if it did no changes, | |
690 | * and positive a process was added or deleted | |
237092bf TW |
691 | */ |
692 | static int mei_fasync(int fd, struct file *file, int band) | |
693 | { | |
694 | ||
695 | struct mei_cl *cl = file->private_data; | |
696 | ||
697 | if (!mei_cl_is_connected(cl)) | |
ed6dc538 | 698 | return -ENODEV; |
237092bf TW |
699 | |
700 | return fasync_helper(fd, file, band, &cl->ev_async); | |
701 | } | |
702 | ||
55c4e640 | 703 | /** |
88d1bece | 704 | * fw_status_show - mei device fw_status attribute show method |
55c4e640 TW |
705 | * |
706 | * @device: device pointer | |
707 | * @attr: attribute pointer | |
708 | * @buf: char out buffer | |
709 | * | |
710 | * Return: number of the bytes printed into buf or error | |
711 | */ | |
712 | static ssize_t fw_status_show(struct device *device, | |
713 | struct device_attribute *attr, char *buf) | |
714 | { | |
715 | struct mei_device *dev = dev_get_drvdata(device); | |
716 | struct mei_fw_status fw_status; | |
717 | int err, i; | |
718 | ssize_t cnt = 0; | |
719 | ||
720 | mutex_lock(&dev->device_lock); | |
721 | err = mei_fw_status(dev, &fw_status); | |
722 | mutex_unlock(&dev->device_lock); | |
723 | if (err) { | |
724 | dev_err(device, "read fw_status error = %d\n", err); | |
725 | return err; | |
726 | } | |
727 | ||
728 | for (i = 0; i < fw_status.count; i++) | |
729 | cnt += scnprintf(buf + cnt, PAGE_SIZE - cnt, "%08X\n", | |
730 | fw_status.status[i]); | |
731 | return cnt; | |
732 | } | |
733 | static DEVICE_ATTR_RO(fw_status); | |
734 | ||
88d1bece AU |
735 | /** |
736 | * hbm_ver_show - display HBM protocol version negotiated with FW | |
737 | * | |
738 | * @device: device pointer | |
739 | * @attr: attribute pointer | |
740 | * @buf: char out buffer | |
741 | * | |
742 | * Return: number of the bytes printed into buf or error | |
743 | */ | |
744 | static ssize_t hbm_ver_show(struct device *device, | |
745 | struct device_attribute *attr, char *buf) | |
746 | { | |
747 | struct mei_device *dev = dev_get_drvdata(device); | |
748 | struct hbm_version ver; | |
749 | ||
750 | mutex_lock(&dev->device_lock); | |
751 | ver = dev->version; | |
752 | mutex_unlock(&dev->device_lock); | |
753 | ||
754 | return sprintf(buf, "%u.%u\n", ver.major_version, ver.minor_version); | |
755 | } | |
756 | static DEVICE_ATTR_RO(hbm_ver); | |
757 | ||
758 | /** | |
759 | * hbm_ver_drv_show - display HBM protocol version advertised by driver | |
760 | * | |
761 | * @device: device pointer | |
762 | * @attr: attribute pointer | |
763 | * @buf: char out buffer | |
764 | * | |
765 | * Return: number of the bytes printed into buf or error | |
766 | */ | |
767 | static ssize_t hbm_ver_drv_show(struct device *device, | |
768 | struct device_attribute *attr, char *buf) | |
769 | { | |
770 | return sprintf(buf, "%u.%u\n", HBM_MAJOR_VERSION, HBM_MINOR_VERSION); | |
771 | } | |
772 | static DEVICE_ATTR_RO(hbm_ver_drv); | |
773 | ||
af336cab AU |
774 | static ssize_t tx_queue_limit_show(struct device *device, |
775 | struct device_attribute *attr, char *buf) | |
776 | { | |
777 | struct mei_device *dev = dev_get_drvdata(device); | |
778 | u8 size = 0; | |
779 | ||
780 | mutex_lock(&dev->device_lock); | |
781 | size = dev->tx_queue_limit; | |
782 | mutex_unlock(&dev->device_lock); | |
783 | ||
784 | return snprintf(buf, PAGE_SIZE, "%u\n", size); | |
785 | } | |
786 | ||
787 | static ssize_t tx_queue_limit_store(struct device *device, | |
788 | struct device_attribute *attr, | |
789 | const char *buf, size_t count) | |
790 | { | |
791 | struct mei_device *dev = dev_get_drvdata(device); | |
792 | u8 limit; | |
793 | unsigned int inp; | |
794 | int err; | |
795 | ||
796 | err = kstrtouint(buf, 10, &inp); | |
797 | if (err) | |
798 | return err; | |
799 | if (inp > MEI_TX_QUEUE_LIMIT_MAX || inp < MEI_TX_QUEUE_LIMIT_MIN) | |
800 | return -EINVAL; | |
801 | limit = inp; | |
802 | ||
803 | mutex_lock(&dev->device_lock); | |
804 | dev->tx_queue_limit = limit; | |
805 | mutex_unlock(&dev->device_lock); | |
806 | ||
807 | return count; | |
808 | } | |
809 | static DEVICE_ATTR_RW(tx_queue_limit); | |
810 | ||
3cfaeb33 AU |
811 | /** |
812 | * fw_ver_show - display ME FW version | |
813 | * | |
814 | * @device: device pointer | |
815 | * @attr: attribute pointer | |
816 | * @buf: char out buffer | |
817 | * | |
818 | * Return: number of the bytes printed into buf or error | |
819 | */ | |
820 | static ssize_t fw_ver_show(struct device *device, | |
821 | struct device_attribute *attr, char *buf) | |
822 | { | |
823 | struct mei_device *dev = dev_get_drvdata(device); | |
824 | struct mei_fw_version *ver; | |
825 | ssize_t cnt = 0; | |
826 | int i; | |
827 | ||
828 | ver = dev->fw_ver; | |
829 | ||
830 | for (i = 0; i < MEI_MAX_FW_VER_BLOCKS; i++) | |
831 | cnt += scnprintf(buf + cnt, PAGE_SIZE - cnt, "%u:%u.%u.%u.%u\n", | |
832 | ver[i].platform, ver[i].major, ver[i].minor, | |
833 | ver[i].hotfix, ver[i].buildno); | |
834 | return cnt; | |
835 | } | |
836 | static DEVICE_ATTR_RO(fw_ver); | |
837 | ||
43b8a7ed AU |
838 | /** |
839 | * dev_state_show - display device state | |
840 | * | |
841 | * @device: device pointer | |
842 | * @attr: attribute pointer | |
843 | * @buf: char out buffer | |
844 | * | |
845 | * Return: number of the bytes printed into buf or error | |
846 | */ | |
847 | static ssize_t dev_state_show(struct device *device, | |
848 | struct device_attribute *attr, char *buf) | |
849 | { | |
850 | struct mei_device *dev = dev_get_drvdata(device); | |
851 | enum mei_dev_state dev_state; | |
852 | ||
853 | mutex_lock(&dev->device_lock); | |
854 | dev_state = dev->dev_state; | |
855 | mutex_unlock(&dev->device_lock); | |
856 | ||
857 | return sprintf(buf, "%s", mei_dev_state_str(dev_state)); | |
858 | } | |
859 | static DEVICE_ATTR_RO(dev_state); | |
860 | ||
861 | static int match_devt(struct device *dev, const void *data) | |
862 | { | |
863 | const dev_t *devt = data; | |
864 | ||
865 | return dev->devt == *devt; | |
866 | } | |
867 | ||
868 | /** | |
869 | * dev_set_devstate: set to new device state and notify sysfs file. | |
870 | * | |
871 | * @dev: mei_device | |
872 | * @state: new device state | |
873 | */ | |
874 | void mei_set_devstate(struct mei_device *dev, enum mei_dev_state state) | |
875 | { | |
876 | struct device *clsdev; | |
877 | ||
878 | if (dev->dev_state == state) | |
879 | return; | |
880 | ||
881 | dev->dev_state = state; | |
882 | ||
883 | clsdev = class_find_device(mei_class, NULL, &dev->cdev.dev, match_devt); | |
884 | if (clsdev) { | |
885 | sysfs_notify(&clsdev->kobj, NULL, "dev_state"); | |
886 | put_device(clsdev); | |
887 | } | |
888 | } | |
889 | ||
55c4e640 TW |
890 | static struct attribute *mei_attrs[] = { |
891 | &dev_attr_fw_status.attr, | |
88d1bece AU |
892 | &dev_attr_hbm_ver.attr, |
893 | &dev_attr_hbm_ver_drv.attr, | |
af336cab | 894 | &dev_attr_tx_queue_limit.attr, |
3cfaeb33 | 895 | &dev_attr_fw_ver.attr, |
43b8a7ed | 896 | &dev_attr_dev_state.attr, |
55c4e640 TW |
897 | NULL |
898 | }; | |
899 | ATTRIBUTE_GROUPS(mei); | |
900 | ||
5b881e3c OW |
901 | /* |
902 | * file operations structure will be used for mei char device. | |
903 | */ | |
904 | static const struct file_operations mei_fops = { | |
905 | .owner = THIS_MODULE, | |
906 | .read = mei_read, | |
907 | .unlocked_ioctl = mei_ioctl, | |
908 | #ifdef CONFIG_COMPAT | |
909 | .compat_ioctl = mei_compat_ioctl, | |
910 | #endif | |
911 | .open = mei_open, | |
912 | .release = mei_release, | |
913 | .write = mei_write, | |
914 | .poll = mei_poll, | |
58cde1a6 | 915 | .fsync = mei_fsync, |
237092bf | 916 | .fasync = mei_fasync, |
5b881e3c OW |
917 | .llseek = no_llseek |
918 | }; | |
919 | ||
f3d8e878 AU |
920 | /** |
921 | * mei_minor_get - obtain next free device minor number | |
922 | * | |
923 | * @dev: device pointer | |
924 | * | |
a8605ea2 | 925 | * Return: allocated minor, or -ENOSPC if no free minor left |
5b881e3c | 926 | */ |
f3d8e878 AU |
927 | static int mei_minor_get(struct mei_device *dev) |
928 | { | |
929 | int ret; | |
930 | ||
931 | mutex_lock(&mei_minor_lock); | |
932 | ret = idr_alloc(&mei_idr, dev, 0, MEI_MAX_DEVS, GFP_KERNEL); | |
933 | if (ret >= 0) | |
934 | dev->minor = ret; | |
935 | else if (ret == -ENOSPC) | |
2bf94cab | 936 | dev_err(dev->dev, "too many mei devices\n"); |
5b881e3c | 937 | |
f3d8e878 AU |
938 | mutex_unlock(&mei_minor_lock); |
939 | return ret; | |
940 | } | |
30e53bb8 | 941 | |
f3d8e878 AU |
942 | /** |
943 | * mei_minor_free - mark device minor number as free | |
944 | * | |
945 | * @dev: device pointer | |
946 | */ | |
947 | static void mei_minor_free(struct mei_device *dev) | |
9a123f19 | 948 | { |
f3d8e878 AU |
949 | mutex_lock(&mei_minor_lock); |
950 | idr_remove(&mei_idr, dev->minor); | |
951 | mutex_unlock(&mei_minor_lock); | |
952 | } | |
953 | ||
954 | int mei_register(struct mei_device *dev, struct device *parent) | |
955 | { | |
956 | struct device *clsdev; /* class device */ | |
957 | int ret, devno; | |
958 | ||
959 | ret = mei_minor_get(dev); | |
960 | if (ret < 0) | |
30e53bb8 TW |
961 | return ret; |
962 | ||
f3d8e878 AU |
963 | /* Fill in the data structures */ |
964 | devno = MKDEV(MAJOR(mei_devt), dev->minor); | |
965 | cdev_init(&dev->cdev, &mei_fops); | |
154322f4 | 966 | dev->cdev.owner = parent->driver->owner; |
f3d8e878 AU |
967 | |
968 | /* Add the device */ | |
969 | ret = cdev_add(&dev->cdev, devno, 1); | |
970 | if (ret) { | |
971 | dev_err(parent, "unable to add device %d:%d\n", | |
972 | MAJOR(mei_devt), dev->minor); | |
973 | goto err_dev_add; | |
974 | } | |
975 | ||
55c4e640 TW |
976 | clsdev = device_create_with_groups(mei_class, parent, devno, |
977 | dev, mei_groups, | |
978 | "mei%d", dev->minor); | |
f3d8e878 AU |
979 | |
980 | if (IS_ERR(clsdev)) { | |
981 | dev_err(parent, "unable to create device %d:%d\n", | |
982 | MAJOR(mei_devt), dev->minor); | |
983 | ret = PTR_ERR(clsdev); | |
984 | goto err_dev_create; | |
985 | } | |
986 | ||
987 | ret = mei_dbgfs_register(dev, dev_name(clsdev)); | |
988 | if (ret) { | |
989 | dev_err(clsdev, "cannot register debugfs ret = %d\n", ret); | |
990 | goto err_dev_dbgfs; | |
991 | } | |
30e53bb8 TW |
992 | |
993 | return 0; | |
f3d8e878 AU |
994 | |
995 | err_dev_dbgfs: | |
996 | device_destroy(mei_class, devno); | |
997 | err_dev_create: | |
998 | cdev_del(&dev->cdev); | |
999 | err_dev_add: | |
1000 | mei_minor_free(dev); | |
1001 | return ret; | |
5b881e3c | 1002 | } |
40e0b67b | 1003 | EXPORT_SYMBOL_GPL(mei_register); |
5b881e3c | 1004 | |
30e53bb8 | 1005 | void mei_deregister(struct mei_device *dev) |
5b881e3c | 1006 | { |
f3d8e878 AU |
1007 | int devno; |
1008 | ||
1009 | devno = dev->cdev.dev; | |
1010 | cdev_del(&dev->cdev); | |
1011 | ||
30e53bb8 | 1012 | mei_dbgfs_deregister(dev); |
f3d8e878 AU |
1013 | |
1014 | device_destroy(mei_class, devno); | |
1015 | ||
1016 | mei_minor_free(dev); | |
5b881e3c | 1017 | } |
40e0b67b | 1018 | EXPORT_SYMBOL_GPL(mei_deregister); |
ab841160 | 1019 | |
cf3baefb SO |
1020 | static int __init mei_init(void) |
1021 | { | |
f3d8e878 AU |
1022 | int ret; |
1023 | ||
1024 | mei_class = class_create(THIS_MODULE, "mei"); | |
1025 | if (IS_ERR(mei_class)) { | |
1026 | pr_err("couldn't create class\n"); | |
1027 | ret = PTR_ERR(mei_class); | |
1028 | goto err; | |
1029 | } | |
1030 | ||
1031 | ret = alloc_chrdev_region(&mei_devt, 0, MEI_MAX_DEVS, "mei"); | |
1032 | if (ret < 0) { | |
1033 | pr_err("unable to allocate char dev region\n"); | |
1034 | goto err_class; | |
1035 | } | |
1036 | ||
1037 | ret = mei_cl_bus_init(); | |
1038 | if (ret < 0) { | |
1039 | pr_err("unable to initialize bus\n"); | |
1040 | goto err_chrdev; | |
1041 | } | |
1042 | ||
1043 | return 0; | |
1044 | ||
1045 | err_chrdev: | |
1046 | unregister_chrdev_region(mei_devt, MEI_MAX_DEVS); | |
1047 | err_class: | |
1048 | class_destroy(mei_class); | |
1049 | err: | |
1050 | return ret; | |
cf3baefb SO |
1051 | } |
1052 | ||
1053 | static void __exit mei_exit(void) | |
1054 | { | |
f3d8e878 AU |
1055 | unregister_chrdev_region(mei_devt, MEI_MAX_DEVS); |
1056 | class_destroy(mei_class); | |
cf3baefb SO |
1057 | mei_cl_bus_exit(); |
1058 | } | |
1059 | ||
1060 | module_init(mei_init); | |
1061 | module_exit(mei_exit); | |
1062 | ||
40e0b67b TW |
1063 | MODULE_AUTHOR("Intel Corporation"); |
1064 | MODULE_DESCRIPTION("Intel(R) Management Engine Interface"); | |
827eef51 | 1065 | MODULE_LICENSE("GPL v2"); |
ab841160 | 1066 |