xref: /openbmc/linux/drivers/misc/mei/client.c (revision 174cd4b1)
1 /*
2  *
3  * Intel Management Engine Interface (Intel MEI) Linux driver
4  * Copyright (c) 2003-2012, Intel Corporation.
5  *
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  */
16 
17 #include <linux/sched/signal.h>
18 #include <linux/wait.h>
19 #include <linux/delay.h>
20 #include <linux/slab.h>
21 #include <linux/pm_runtime.h>
22 
23 #include <linux/mei.h>
24 
25 #include "mei_dev.h"
26 #include "hbm.h"
27 #include "client.h"
28 
29 /**
30  * mei_me_cl_init - initialize me client
31  *
32  * @me_cl: me client
33  */
34 void mei_me_cl_init(struct mei_me_client *me_cl)
35 {
36 	INIT_LIST_HEAD(&me_cl->list);
37 	kref_init(&me_cl->refcnt);
38 }
39 
40 /**
41  * mei_me_cl_get - increases me client refcount
42  *
43  * @me_cl: me client
44  *
45  * Locking: called under "dev->device_lock" lock
46  *
47  * Return: me client or NULL
48  */
49 struct mei_me_client *mei_me_cl_get(struct mei_me_client *me_cl)
50 {
51 	if (me_cl && kref_get_unless_zero(&me_cl->refcnt))
52 		return me_cl;
53 
54 	return NULL;
55 }
56 
57 /**
58  * mei_me_cl_release - free me client
59  *
60  * Locking: called under "dev->device_lock" lock
61  *
62  * @ref: me_client refcount
63  */
64 static void mei_me_cl_release(struct kref *ref)
65 {
66 	struct mei_me_client *me_cl =
67 		container_of(ref, struct mei_me_client, refcnt);
68 
69 	kfree(me_cl);
70 }
71 
72 /**
73  * mei_me_cl_put - decrease me client refcount and free client if necessary
74  *
75  * Locking: called under "dev->device_lock" lock
76  *
77  * @me_cl: me client
78  */
79 void mei_me_cl_put(struct mei_me_client *me_cl)
80 {
81 	if (me_cl)
82 		kref_put(&me_cl->refcnt, mei_me_cl_release);
83 }
84 
85 /**
86  * __mei_me_cl_del  - delete me client from the list and decrease
87  *     reference counter
88  *
89  * @dev: mei device
90  * @me_cl: me client
91  *
92  * Locking: dev->me_clients_rwsem
93  */
94 static void __mei_me_cl_del(struct mei_device *dev, struct mei_me_client *me_cl)
95 {
96 	if (!me_cl)
97 		return;
98 
99 	list_del_init(&me_cl->list);
100 	mei_me_cl_put(me_cl);
101 }
102 
103 /**
104  * mei_me_cl_del - delete me client from the list and decrease
105  *     reference counter
106  *
107  * @dev: mei device
108  * @me_cl: me client
109  */
110 void mei_me_cl_del(struct mei_device *dev, struct mei_me_client *me_cl)
111 {
112 	down_write(&dev->me_clients_rwsem);
113 	__mei_me_cl_del(dev, me_cl);
114 	up_write(&dev->me_clients_rwsem);
115 }
116 
117 /**
118  * mei_me_cl_add - add me client to the list
119  *
120  * @dev: mei device
121  * @me_cl: me client
122  */
123 void mei_me_cl_add(struct mei_device *dev, struct mei_me_client *me_cl)
124 {
125 	down_write(&dev->me_clients_rwsem);
126 	list_add(&me_cl->list, &dev->me_clients);
127 	up_write(&dev->me_clients_rwsem);
128 }
129 
130 /**
131  * __mei_me_cl_by_uuid - locate me client by uuid
132  *	increases ref count
133  *
134  * @dev: mei device
135  * @uuid: me client uuid
136  *
137  * Return: me client or NULL if not found
138  *
139  * Locking: dev->me_clients_rwsem
140  */
141 static struct mei_me_client *__mei_me_cl_by_uuid(struct mei_device *dev,
142 					const uuid_le *uuid)
143 {
144 	struct mei_me_client *me_cl;
145 	const uuid_le *pn;
146 
147 	WARN_ON(!rwsem_is_locked(&dev->me_clients_rwsem));
148 
149 	list_for_each_entry(me_cl, &dev->me_clients, list) {
150 		pn = &me_cl->props.protocol_name;
151 		if (uuid_le_cmp(*uuid, *pn) == 0)
152 			return mei_me_cl_get(me_cl);
153 	}
154 
155 	return NULL;
156 }
157 
158 /**
159  * mei_me_cl_by_uuid - locate me client by uuid
160  *	increases ref count
161  *
162  * @dev: mei device
163  * @uuid: me client uuid
164  *
165  * Return: me client or NULL if not found
166  *
167  * Locking: dev->me_clients_rwsem
168  */
169 struct mei_me_client *mei_me_cl_by_uuid(struct mei_device *dev,
170 					const uuid_le *uuid)
171 {
172 	struct mei_me_client *me_cl;
173 
174 	down_read(&dev->me_clients_rwsem);
175 	me_cl = __mei_me_cl_by_uuid(dev, uuid);
176 	up_read(&dev->me_clients_rwsem);
177 
178 	return me_cl;
179 }
180 
181 /**
182  * mei_me_cl_by_id - locate me client by client id
183  *	increases ref count
184  *
185  * @dev: the device structure
186  * @client_id: me client id
187  *
188  * Return: me client or NULL if not found
189  *
190  * Locking: dev->me_clients_rwsem
191  */
192 struct mei_me_client *mei_me_cl_by_id(struct mei_device *dev, u8 client_id)
193 {
194 
195 	struct mei_me_client *__me_cl, *me_cl = NULL;
196 
197 	down_read(&dev->me_clients_rwsem);
198 	list_for_each_entry(__me_cl, &dev->me_clients, list) {
199 		if (__me_cl->client_id == client_id) {
200 			me_cl = mei_me_cl_get(__me_cl);
201 			break;
202 		}
203 	}
204 	up_read(&dev->me_clients_rwsem);
205 
206 	return me_cl;
207 }
208 
209 /**
210  * __mei_me_cl_by_uuid_id - locate me client by client id and uuid
211  *	increases ref count
212  *
213  * @dev: the device structure
214  * @uuid: me client uuid
215  * @client_id: me client id
216  *
217  * Return: me client or null if not found
218  *
219  * Locking: dev->me_clients_rwsem
220  */
221 static struct mei_me_client *__mei_me_cl_by_uuid_id(struct mei_device *dev,
222 					   const uuid_le *uuid, u8 client_id)
223 {
224 	struct mei_me_client *me_cl;
225 	const uuid_le *pn;
226 
227 	WARN_ON(!rwsem_is_locked(&dev->me_clients_rwsem));
228 
229 	list_for_each_entry(me_cl, &dev->me_clients, list) {
230 		pn = &me_cl->props.protocol_name;
231 		if (uuid_le_cmp(*uuid, *pn) == 0 &&
232 		    me_cl->client_id == client_id)
233 			return mei_me_cl_get(me_cl);
234 	}
235 
236 	return NULL;
237 }
238 
239 
240 /**
241  * mei_me_cl_by_uuid_id - locate me client by client id and uuid
242  *	increases ref count
243  *
244  * @dev: the device structure
245  * @uuid: me client uuid
246  * @client_id: me client id
247  *
248  * Return: me client or null if not found
249  */
250 struct mei_me_client *mei_me_cl_by_uuid_id(struct mei_device *dev,
251 					   const uuid_le *uuid, u8 client_id)
252 {
253 	struct mei_me_client *me_cl;
254 
255 	down_read(&dev->me_clients_rwsem);
256 	me_cl = __mei_me_cl_by_uuid_id(dev, uuid, client_id);
257 	up_read(&dev->me_clients_rwsem);
258 
259 	return me_cl;
260 }
261 
262 /**
263  * mei_me_cl_rm_by_uuid - remove all me clients matching uuid
264  *
265  * @dev: the device structure
266  * @uuid: me client uuid
267  *
268  * Locking: called under "dev->device_lock" lock
269  */
270 void mei_me_cl_rm_by_uuid(struct mei_device *dev, const uuid_le *uuid)
271 {
272 	struct mei_me_client *me_cl;
273 
274 	dev_dbg(dev->dev, "remove %pUl\n", uuid);
275 
276 	down_write(&dev->me_clients_rwsem);
277 	me_cl = __mei_me_cl_by_uuid(dev, uuid);
278 	__mei_me_cl_del(dev, me_cl);
279 	up_write(&dev->me_clients_rwsem);
280 }
281 
282 /**
283  * mei_me_cl_rm_by_uuid_id - remove all me clients matching client id
284  *
285  * @dev: the device structure
286  * @uuid: me client uuid
287  * @id: me client id
288  *
289  * Locking: called under "dev->device_lock" lock
290  */
291 void mei_me_cl_rm_by_uuid_id(struct mei_device *dev, const uuid_le *uuid, u8 id)
292 {
293 	struct mei_me_client *me_cl;
294 
295 	dev_dbg(dev->dev, "remove %pUl %d\n", uuid, id);
296 
297 	down_write(&dev->me_clients_rwsem);
298 	me_cl = __mei_me_cl_by_uuid_id(dev, uuid, id);
299 	__mei_me_cl_del(dev, me_cl);
300 	up_write(&dev->me_clients_rwsem);
301 }
302 
303 /**
304  * mei_me_cl_rm_all - remove all me clients
305  *
306  * @dev: the device structure
307  *
308  * Locking: called under "dev->device_lock" lock
309  */
310 void mei_me_cl_rm_all(struct mei_device *dev)
311 {
312 	struct mei_me_client *me_cl, *next;
313 
314 	down_write(&dev->me_clients_rwsem);
315 	list_for_each_entry_safe(me_cl, next, &dev->me_clients, list)
316 		__mei_me_cl_del(dev, me_cl);
317 	up_write(&dev->me_clients_rwsem);
318 }
319 
320 /**
321  * mei_cl_cmp_id - tells if the clients are the same
322  *
323  * @cl1: host client 1
324  * @cl2: host client 2
325  *
326  * Return: true  - if the clients has same host and me ids
327  *         false - otherwise
328  */
329 static inline bool mei_cl_cmp_id(const struct mei_cl *cl1,
330 				const struct mei_cl *cl2)
331 {
332 	return cl1 && cl2 &&
333 		(cl1->host_client_id == cl2->host_client_id) &&
334 		(mei_cl_me_id(cl1) == mei_cl_me_id(cl2));
335 }
336 
337 /**
338  * mei_io_cb_free - free mei_cb_private related memory
339  *
340  * @cb: mei callback struct
341  */
342 void mei_io_cb_free(struct mei_cl_cb *cb)
343 {
344 	if (cb == NULL)
345 		return;
346 
347 	list_del(&cb->list);
348 	kfree(cb->buf.data);
349 	kfree(cb);
350 }
351 
352 /**
353  * mei_io_cb_init - allocate and initialize io callback
354  *
355  * @cl: mei client
356  * @type: operation type
357  * @fp: pointer to file structure
358  *
359  * Return: mei_cl_cb pointer or NULL;
360  */
361 static struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl,
362 					enum mei_cb_file_ops type,
363 					const struct file *fp)
364 {
365 	struct mei_cl_cb *cb;
366 
367 	cb = kzalloc(sizeof(struct mei_cl_cb), GFP_KERNEL);
368 	if (!cb)
369 		return NULL;
370 
371 	INIT_LIST_HEAD(&cb->list);
372 	cb->fp = fp;
373 	cb->cl = cl;
374 	cb->buf_idx = 0;
375 	cb->fop_type = type;
376 	return cb;
377 }
378 
379 /**
380  * __mei_io_list_flush_cl - removes and frees cbs belonging to cl.
381  *
382  * @head:  an instance of our list structure
383  * @cl:    host client, can be NULL for flushing the whole list
384  * @free:  whether to free the cbs
385  */
386 static void __mei_io_list_flush_cl(struct list_head *head,
387 				   const struct mei_cl *cl, bool free)
388 {
389 	struct mei_cl_cb *cb, *next;
390 
391 	/* enable removing everything if no cl is specified */
392 	list_for_each_entry_safe(cb, next, head, list) {
393 		if (!cl || mei_cl_cmp_id(cl, cb->cl)) {
394 			list_del_init(&cb->list);
395 			if (free)
396 				mei_io_cb_free(cb);
397 		}
398 	}
399 }
400 
401 /**
402  * mei_io_list_flush_cl - removes list entry belonging to cl.
403  *
404  * @head: An instance of our list structure
405  * @cl: host client
406  */
407 static inline void mei_io_list_flush_cl(struct list_head *head,
408 					const struct mei_cl *cl)
409 {
410 	__mei_io_list_flush_cl(head, cl, false);
411 }
412 
413 /**
414  * mei_io_list_free_cl - removes cb belonging to cl and free them
415  *
416  * @head: An instance of our list structure
417  * @cl: host client
418  */
419 static inline void mei_io_list_free_cl(struct list_head *head,
420 				       const struct mei_cl *cl)
421 {
422 	__mei_io_list_flush_cl(head, cl, true);
423 }
424 
425 /**
426  * mei_io_list_free_fp - free cb from a list that matches file pointer
427  *
428  * @head: io list
429  * @fp: file pointer (matching cb file object), may be NULL
430  */
431 void mei_io_list_free_fp(struct list_head *head, const struct file *fp)
432 {
433 	struct mei_cl_cb *cb, *next;
434 
435 	list_for_each_entry_safe(cb, next, head, list)
436 		if (!fp || fp == cb->fp)
437 			mei_io_cb_free(cb);
438 }
439 
440 /**
441  * mei_cl_alloc_cb - a convenient wrapper for allocating read cb
442  *
443  * @cl: host client
444  * @length: size of the buffer
445  * @fop_type: operation type
446  * @fp: associated file pointer (might be NULL)
447  *
448  * Return: cb on success and NULL on failure
449  */
450 struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length,
451 				  enum mei_cb_file_ops fop_type,
452 				  const struct file *fp)
453 {
454 	struct mei_cl_cb *cb;
455 
456 	cb = mei_io_cb_init(cl, fop_type, fp);
457 	if (!cb)
458 		return NULL;
459 
460 	if (length == 0)
461 		return cb;
462 
463 	cb->buf.data = kmalloc(length, GFP_KERNEL);
464 	if (!cb->buf.data) {
465 		mei_io_cb_free(cb);
466 		return NULL;
467 	}
468 	cb->buf.size = length;
469 
470 	return cb;
471 }
472 
473 /**
474  * mei_cl_enqueue_ctrl_wr_cb - a convenient wrapper for allocating
475  *     and enqueuing of the control commands cb
476  *
477  * @cl: host client
478  * @length: size of the buffer
479  * @fop_type: operation type
480  * @fp: associated file pointer (might be NULL)
481  *
482  * Return: cb on success and NULL on failure
483  * Locking: called under "dev->device_lock" lock
484  */
485 struct mei_cl_cb *mei_cl_enqueue_ctrl_wr_cb(struct mei_cl *cl, size_t length,
486 					    enum mei_cb_file_ops fop_type,
487 					    const struct file *fp)
488 {
489 	struct mei_cl_cb *cb;
490 
491 	/* for RX always allocate at least client's mtu */
492 	if (length)
493 		length = max_t(size_t, length, mei_cl_mtu(cl));
494 
495 	cb = mei_cl_alloc_cb(cl, length, fop_type, fp);
496 	if (!cb)
497 		return NULL;
498 
499 	list_add_tail(&cb->list, &cl->dev->ctrl_wr_list);
500 	return cb;
501 }
502 
503 /**
504  * mei_cl_read_cb - find this cl's callback in the read list
505  *     for a specific file
506  *
507  * @cl: host client
508  * @fp: file pointer (matching cb file object), may be NULL
509  *
510  * Return: cb on success, NULL if cb is not found
511  */
512 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl, const struct file *fp)
513 {
514 	struct mei_cl_cb *cb;
515 
516 	list_for_each_entry(cb, &cl->rd_completed, list)
517 		if (!fp || fp == cb->fp)
518 			return cb;
519 
520 	return NULL;
521 }
522 
523 /**
524  * mei_cl_flush_queues - flushes queue lists belonging to cl.
525  *
526  * @cl: host client
527  * @fp: file pointer (matching cb file object), may be NULL
528  *
529  * Return: 0 on success, -EINVAL if cl or cl->dev is NULL.
530  */
531 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp)
532 {
533 	struct mei_device *dev;
534 
535 	if (WARN_ON(!cl || !cl->dev))
536 		return -EINVAL;
537 
538 	dev = cl->dev;
539 
540 	cl_dbg(dev, cl, "remove list entry belonging to cl\n");
541 	mei_io_list_free_cl(&cl->dev->write_list, cl);
542 	mei_io_list_free_cl(&cl->dev->write_waiting_list, cl);
543 	mei_io_list_flush_cl(&cl->dev->ctrl_wr_list, cl);
544 	mei_io_list_flush_cl(&cl->dev->ctrl_rd_list, cl);
545 	mei_io_list_free_fp(&cl->rd_pending, fp);
546 	mei_io_list_free_fp(&cl->rd_completed, fp);
547 
548 	return 0;
549 }
550 
551 /**
552  * mei_cl_init - initializes cl.
553  *
554  * @cl: host client to be initialized
555  * @dev: mei device
556  */
557 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev)
558 {
559 	memset(cl, 0, sizeof(struct mei_cl));
560 	init_waitqueue_head(&cl->wait);
561 	init_waitqueue_head(&cl->rx_wait);
562 	init_waitqueue_head(&cl->tx_wait);
563 	init_waitqueue_head(&cl->ev_wait);
564 	INIT_LIST_HEAD(&cl->rd_completed);
565 	INIT_LIST_HEAD(&cl->rd_pending);
566 	INIT_LIST_HEAD(&cl->link);
567 	cl->writing_state = MEI_IDLE;
568 	cl->state = MEI_FILE_UNINITIALIZED;
569 	cl->dev = dev;
570 }
571 
572 /**
573  * mei_cl_allocate - allocates cl  structure and sets it up.
574  *
575  * @dev: mei device
576  * Return:  The allocated file or NULL on failure
577  */
578 struct mei_cl *mei_cl_allocate(struct mei_device *dev)
579 {
580 	struct mei_cl *cl;
581 
582 	cl = kmalloc(sizeof(struct mei_cl), GFP_KERNEL);
583 	if (!cl)
584 		return NULL;
585 
586 	mei_cl_init(cl, dev);
587 
588 	return cl;
589 }
590 
591 /**
592  * mei_cl_link - allocate host id in the host map
593  *
594  * @cl: host client
595  *
596  * Return: 0 on success
597  *	-EINVAL on incorrect values
598  *	-EMFILE if open count exceeded.
599  */
600 int mei_cl_link(struct mei_cl *cl)
601 {
602 	struct mei_device *dev;
603 	long open_handle_count;
604 	int id;
605 
606 	if (WARN_ON(!cl || !cl->dev))
607 		return -EINVAL;
608 
609 	dev = cl->dev;
610 
611 	id = find_first_zero_bit(dev->host_clients_map, MEI_CLIENTS_MAX);
612 	if (id >= MEI_CLIENTS_MAX) {
613 		dev_err(dev->dev, "id exceeded %d", MEI_CLIENTS_MAX);
614 		return -EMFILE;
615 	}
616 
617 	open_handle_count = dev->open_handle_count + dev->iamthif_open_count;
618 	if (open_handle_count >= MEI_MAX_OPEN_HANDLE_COUNT) {
619 		dev_err(dev->dev, "open_handle_count exceeded %d",
620 			MEI_MAX_OPEN_HANDLE_COUNT);
621 		return -EMFILE;
622 	}
623 
624 	dev->open_handle_count++;
625 
626 	cl->host_client_id = id;
627 	list_add_tail(&cl->link, &dev->file_list);
628 
629 	set_bit(id, dev->host_clients_map);
630 
631 	cl->state = MEI_FILE_INITIALIZING;
632 
633 	cl_dbg(dev, cl, "link cl\n");
634 	return 0;
635 }
636 
637 /**
638  * mei_cl_unlink - remove host client from the list
639  *
640  * @cl: host client
641  *
642  * Return: always 0
643  */
644 int mei_cl_unlink(struct mei_cl *cl)
645 {
646 	struct mei_device *dev;
647 
648 	/* don't shout on error exit path */
649 	if (!cl)
650 		return 0;
651 
652 	/* amthif might not be initialized */
653 	if (!cl->dev)
654 		return 0;
655 
656 	dev = cl->dev;
657 
658 	cl_dbg(dev, cl, "unlink client");
659 
660 	if (dev->open_handle_count > 0)
661 		dev->open_handle_count--;
662 
663 	/* never clear the 0 bit */
664 	if (cl->host_client_id)
665 		clear_bit(cl->host_client_id, dev->host_clients_map);
666 
667 	list_del_init(&cl->link);
668 
669 	cl->state = MEI_FILE_UNINITIALIZED;
670 	cl->writing_state = MEI_IDLE;
671 
672 	WARN_ON(!list_empty(&cl->rd_completed) ||
673 		!list_empty(&cl->rd_pending) ||
674 		!list_empty(&cl->link));
675 
676 	return 0;
677 }
678 
679 void mei_host_client_init(struct mei_device *dev)
680 {
681 	dev->dev_state = MEI_DEV_ENABLED;
682 	dev->reset_count = 0;
683 
684 	schedule_work(&dev->bus_rescan_work);
685 
686 	pm_runtime_mark_last_busy(dev->dev);
687 	dev_dbg(dev->dev, "rpm: autosuspend\n");
688 	pm_request_autosuspend(dev->dev);
689 }
690 
691 /**
692  * mei_hbuf_acquire - try to acquire host buffer
693  *
694  * @dev: the device structure
695  * Return: true if host buffer was acquired
696  */
697 bool mei_hbuf_acquire(struct mei_device *dev)
698 {
699 	if (mei_pg_state(dev) == MEI_PG_ON ||
700 	    mei_pg_in_transition(dev)) {
701 		dev_dbg(dev->dev, "device is in pg\n");
702 		return false;
703 	}
704 
705 	if (!dev->hbuf_is_ready) {
706 		dev_dbg(dev->dev, "hbuf is not ready\n");
707 		return false;
708 	}
709 
710 	dev->hbuf_is_ready = false;
711 
712 	return true;
713 }
714 
715 /**
716  * mei_cl_wake_all - wake up readers, writers and event waiters so
717  *                 they can be interrupted
718  *
719  * @cl: host client
720  */
721 static void mei_cl_wake_all(struct mei_cl *cl)
722 {
723 	struct mei_device *dev = cl->dev;
724 
725 	/* synchronized under device mutex */
726 	if (waitqueue_active(&cl->rx_wait)) {
727 		cl_dbg(dev, cl, "Waking up reading client!\n");
728 		wake_up_interruptible(&cl->rx_wait);
729 	}
730 	/* synchronized under device mutex */
731 	if (waitqueue_active(&cl->tx_wait)) {
732 		cl_dbg(dev, cl, "Waking up writing client!\n");
733 		wake_up_interruptible(&cl->tx_wait);
734 	}
735 	/* synchronized under device mutex */
736 	if (waitqueue_active(&cl->ev_wait)) {
737 		cl_dbg(dev, cl, "Waking up waiting for event clients!\n");
738 		wake_up_interruptible(&cl->ev_wait);
739 	}
740 	/* synchronized under device mutex */
741 	if (waitqueue_active(&cl->wait)) {
742 		cl_dbg(dev, cl, "Waking up ctrl write clients!\n");
743 		wake_up(&cl->wait);
744 	}
745 }
746 
747 /**
748  * mei_cl_set_disconnected - set disconnected state and clear
749  *   associated states and resources
750  *
751  * @cl: host client
752  */
753 static void mei_cl_set_disconnected(struct mei_cl *cl)
754 {
755 	struct mei_device *dev = cl->dev;
756 
757 	if (cl->state == MEI_FILE_DISCONNECTED ||
758 	    cl->state <= MEI_FILE_INITIALIZING)
759 		return;
760 
761 	cl->state = MEI_FILE_DISCONNECTED;
762 	mei_io_list_free_cl(&dev->write_list, cl);
763 	mei_io_list_free_cl(&dev->write_waiting_list, cl);
764 	mei_io_list_flush_cl(&dev->ctrl_rd_list, cl);
765 	mei_io_list_flush_cl(&dev->ctrl_wr_list, cl);
766 	mei_io_list_free_cl(&dev->amthif_cmd_list, cl);
767 	mei_cl_wake_all(cl);
768 	cl->rx_flow_ctrl_creds = 0;
769 	cl->tx_flow_ctrl_creds = 0;
770 	cl->timer_count = 0;
771 
772 	mei_cl_bus_module_put(cl);
773 
774 	if (!cl->me_cl)
775 		return;
776 
777 	if (!WARN_ON(cl->me_cl->connect_count == 0))
778 		cl->me_cl->connect_count--;
779 
780 	if (cl->me_cl->connect_count == 0)
781 		cl->me_cl->tx_flow_ctrl_creds = 0;
782 
783 	mei_me_cl_put(cl->me_cl);
784 	cl->me_cl = NULL;
785 }
786 
787 static int mei_cl_set_connecting(struct mei_cl *cl, struct mei_me_client *me_cl)
788 {
789 	if (!mei_me_cl_get(me_cl))
790 		return -ENOENT;
791 
792 	/* only one connection is allowed for fixed address clients */
793 	if (me_cl->props.fixed_address) {
794 		if (me_cl->connect_count) {
795 			mei_me_cl_put(me_cl);
796 			return -EBUSY;
797 		}
798 	}
799 
800 	cl->me_cl = me_cl;
801 	cl->state = MEI_FILE_CONNECTING;
802 	cl->me_cl->connect_count++;
803 
804 	return 0;
805 }
806 
807 /*
808  * mei_cl_send_disconnect - send disconnect request
809  *
810  * @cl: host client
811  * @cb: callback block
812  *
813  * Return: 0, OK; otherwise, error.
814  */
815 static int mei_cl_send_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb)
816 {
817 	struct mei_device *dev;
818 	int ret;
819 
820 	dev = cl->dev;
821 
822 	ret = mei_hbm_cl_disconnect_req(dev, cl);
823 	cl->status = ret;
824 	if (ret) {
825 		cl->state = MEI_FILE_DISCONNECT_REPLY;
826 		return ret;
827 	}
828 
829 	list_move_tail(&cb->list, &dev->ctrl_rd_list);
830 	cl->timer_count = MEI_CONNECT_TIMEOUT;
831 	mei_schedule_stall_timer(dev);
832 
833 	return 0;
834 }
835 
836 /**
837  * mei_cl_irq_disconnect - processes close related operation from
838  *	interrupt thread context - send disconnect request
839  *
840  * @cl: client
841  * @cb: callback block.
842  * @cmpl_list: complete list.
843  *
844  * Return: 0, OK; otherwise, error.
845  */
846 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
847 			  struct list_head *cmpl_list)
848 {
849 	struct mei_device *dev = cl->dev;
850 	u32 msg_slots;
851 	int slots;
852 	int ret;
853 
854 	msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
855 	slots = mei_hbuf_empty_slots(dev);
856 
857 	if (slots < msg_slots)
858 		return -EMSGSIZE;
859 
860 	ret = mei_cl_send_disconnect(cl, cb);
861 	if (ret)
862 		list_move_tail(&cb->list, cmpl_list);
863 
864 	return ret;
865 }
866 
867 /**
868  * __mei_cl_disconnect - disconnect host client from the me one
869  *     internal function runtime pm has to be already acquired
870  *
871  * @cl: host client
872  *
873  * Return: 0 on success, <0 on failure.
874  */
875 static int __mei_cl_disconnect(struct mei_cl *cl)
876 {
877 	struct mei_device *dev;
878 	struct mei_cl_cb *cb;
879 	int rets;
880 
881 	dev = cl->dev;
882 
883 	cl->state = MEI_FILE_DISCONNECTING;
884 
885 	cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_DISCONNECT, NULL);
886 	if (!cb) {
887 		rets = -ENOMEM;
888 		goto out;
889 	}
890 
891 	if (mei_hbuf_acquire(dev)) {
892 		rets = mei_cl_send_disconnect(cl, cb);
893 		if (rets) {
894 			cl_err(dev, cl, "failed to disconnect.\n");
895 			goto out;
896 		}
897 	}
898 
899 	mutex_unlock(&dev->device_lock);
900 	wait_event_timeout(cl->wait,
901 			   cl->state == MEI_FILE_DISCONNECT_REPLY ||
902 			   cl->state == MEI_FILE_DISCONNECTED,
903 			   mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
904 	mutex_lock(&dev->device_lock);
905 
906 	rets = cl->status;
907 	if (cl->state != MEI_FILE_DISCONNECT_REPLY &&
908 	    cl->state != MEI_FILE_DISCONNECTED) {
909 		cl_dbg(dev, cl, "timeout on disconnect from FW client.\n");
910 		rets = -ETIME;
911 	}
912 
913 out:
914 	/* we disconnect also on error */
915 	mei_cl_set_disconnected(cl);
916 	if (!rets)
917 		cl_dbg(dev, cl, "successfully disconnected from FW client.\n");
918 
919 	mei_io_cb_free(cb);
920 	return rets;
921 }
922 
923 /**
924  * mei_cl_disconnect - disconnect host client from the me one
925  *
926  * @cl: host client
927  *
928  * Locking: called under "dev->device_lock" lock
929  *
930  * Return: 0 on success, <0 on failure.
931  */
932 int mei_cl_disconnect(struct mei_cl *cl)
933 {
934 	struct mei_device *dev;
935 	int rets;
936 
937 	if (WARN_ON(!cl || !cl->dev))
938 		return -ENODEV;
939 
940 	dev = cl->dev;
941 
942 	cl_dbg(dev, cl, "disconnecting");
943 
944 	if (!mei_cl_is_connected(cl))
945 		return 0;
946 
947 	if (mei_cl_is_fixed_address(cl)) {
948 		mei_cl_set_disconnected(cl);
949 		return 0;
950 	}
951 
952 	rets = pm_runtime_get(dev->dev);
953 	if (rets < 0 && rets != -EINPROGRESS) {
954 		pm_runtime_put_noidle(dev->dev);
955 		cl_err(dev, cl, "rpm: get failed %d\n", rets);
956 		return rets;
957 	}
958 
959 	rets = __mei_cl_disconnect(cl);
960 
961 	cl_dbg(dev, cl, "rpm: autosuspend\n");
962 	pm_runtime_mark_last_busy(dev->dev);
963 	pm_runtime_put_autosuspend(dev->dev);
964 
965 	return rets;
966 }
967 
968 
969 /**
970  * mei_cl_is_other_connecting - checks if other
971  *    client with the same me client id is connecting
972  *
973  * @cl: private data of the file object
974  *
975  * Return: true if other client is connected, false - otherwise.
976  */
977 static bool mei_cl_is_other_connecting(struct mei_cl *cl)
978 {
979 	struct mei_device *dev;
980 	struct mei_cl_cb *cb;
981 
982 	dev = cl->dev;
983 
984 	list_for_each_entry(cb, &dev->ctrl_rd_list, list) {
985 		if (cb->fop_type == MEI_FOP_CONNECT &&
986 		    mei_cl_me_id(cl) == mei_cl_me_id(cb->cl))
987 			return true;
988 	}
989 
990 	return false;
991 }
992 
993 /**
994  * mei_cl_send_connect - send connect request
995  *
996  * @cl: host client
997  * @cb: callback block
998  *
999  * Return: 0, OK; otherwise, error.
1000  */
1001 static int mei_cl_send_connect(struct mei_cl *cl, struct mei_cl_cb *cb)
1002 {
1003 	struct mei_device *dev;
1004 	int ret;
1005 
1006 	dev = cl->dev;
1007 
1008 	ret = mei_hbm_cl_connect_req(dev, cl);
1009 	cl->status = ret;
1010 	if (ret) {
1011 		cl->state = MEI_FILE_DISCONNECT_REPLY;
1012 		return ret;
1013 	}
1014 
1015 	list_move_tail(&cb->list, &dev->ctrl_rd_list);
1016 	cl->timer_count = MEI_CONNECT_TIMEOUT;
1017 	mei_schedule_stall_timer(dev);
1018 	return 0;
1019 }
1020 
1021 /**
1022  * mei_cl_irq_connect - send connect request in irq_thread context
1023  *
1024  * @cl: host client
1025  * @cb: callback block
1026  * @cmpl_list: complete list
1027  *
1028  * Return: 0, OK; otherwise, error.
1029  */
1030 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
1031 		       struct list_head *cmpl_list)
1032 {
1033 	struct mei_device *dev = cl->dev;
1034 	u32 msg_slots;
1035 	int slots;
1036 	int rets;
1037 
1038 	msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1039 	slots = mei_hbuf_empty_slots(dev);
1040 
1041 	if (mei_cl_is_other_connecting(cl))
1042 		return 0;
1043 
1044 	if (slots < msg_slots)
1045 		return -EMSGSIZE;
1046 
1047 	rets = mei_cl_send_connect(cl, cb);
1048 	if (rets)
1049 		list_move_tail(&cb->list, cmpl_list);
1050 
1051 	return rets;
1052 }
1053 
1054 /**
1055  * mei_cl_connect - connect host client to the me one
1056  *
1057  * @cl: host client
1058  * @me_cl: me client
1059  * @fp: pointer to file structure
1060  *
1061  * Locking: called under "dev->device_lock" lock
1062  *
1063  * Return: 0 on success, <0 on failure.
1064  */
1065 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
1066 		   const struct file *fp)
1067 {
1068 	struct mei_device *dev;
1069 	struct mei_cl_cb *cb;
1070 	int rets;
1071 
1072 	if (WARN_ON(!cl || !cl->dev || !me_cl))
1073 		return -ENODEV;
1074 
1075 	dev = cl->dev;
1076 
1077 	if (!mei_cl_bus_module_get(cl))
1078 		return -ENODEV;
1079 
1080 	rets = mei_cl_set_connecting(cl, me_cl);
1081 	if (rets)
1082 		goto nortpm;
1083 
1084 	if (mei_cl_is_fixed_address(cl)) {
1085 		cl->state = MEI_FILE_CONNECTED;
1086 		rets = 0;
1087 		goto nortpm;
1088 	}
1089 
1090 	rets = pm_runtime_get(dev->dev);
1091 	if (rets < 0 && rets != -EINPROGRESS) {
1092 		pm_runtime_put_noidle(dev->dev);
1093 		cl_err(dev, cl, "rpm: get failed %d\n", rets);
1094 		goto nortpm;
1095 	}
1096 
1097 	cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, MEI_FOP_CONNECT, fp);
1098 	if (!cb) {
1099 		rets = -ENOMEM;
1100 		goto out;
1101 	}
1102 
1103 	/* run hbuf acquire last so we don't have to undo */
1104 	if (!mei_cl_is_other_connecting(cl) && mei_hbuf_acquire(dev)) {
1105 		rets = mei_cl_send_connect(cl, cb);
1106 		if (rets)
1107 			goto out;
1108 	}
1109 
1110 	mutex_unlock(&dev->device_lock);
1111 	wait_event_timeout(cl->wait,
1112 			(cl->state == MEI_FILE_CONNECTED ||
1113 			 cl->state == MEI_FILE_DISCONNECTED ||
1114 			 cl->state == MEI_FILE_DISCONNECT_REQUIRED ||
1115 			 cl->state == MEI_FILE_DISCONNECT_REPLY),
1116 			mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1117 	mutex_lock(&dev->device_lock);
1118 
1119 	if (!mei_cl_is_connected(cl)) {
1120 		if (cl->state == MEI_FILE_DISCONNECT_REQUIRED) {
1121 			mei_io_list_flush_cl(&dev->ctrl_rd_list, cl);
1122 			mei_io_list_flush_cl(&dev->ctrl_wr_list, cl);
1123 			 /* ignore disconnect return valuue;
1124 			  * in case of failure reset will be invoked
1125 			  */
1126 			__mei_cl_disconnect(cl);
1127 			rets = -EFAULT;
1128 			goto out;
1129 		}
1130 
1131 		/* timeout or something went really wrong */
1132 		if (!cl->status)
1133 			cl->status = -EFAULT;
1134 	}
1135 
1136 	rets = cl->status;
1137 out:
1138 	cl_dbg(dev, cl, "rpm: autosuspend\n");
1139 	pm_runtime_mark_last_busy(dev->dev);
1140 	pm_runtime_put_autosuspend(dev->dev);
1141 
1142 	mei_io_cb_free(cb);
1143 
1144 nortpm:
1145 	if (!mei_cl_is_connected(cl))
1146 		mei_cl_set_disconnected(cl);
1147 
1148 	return rets;
1149 }
1150 
1151 /**
1152  * mei_cl_alloc_linked - allocate and link host client
1153  *
1154  * @dev: the device structure
1155  *
1156  * Return: cl on success ERR_PTR on failure
1157  */
1158 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev)
1159 {
1160 	struct mei_cl *cl;
1161 	int ret;
1162 
1163 	cl = mei_cl_allocate(dev);
1164 	if (!cl) {
1165 		ret = -ENOMEM;
1166 		goto err;
1167 	}
1168 
1169 	ret = mei_cl_link(cl);
1170 	if (ret)
1171 		goto err;
1172 
1173 	return cl;
1174 err:
1175 	kfree(cl);
1176 	return ERR_PTR(ret);
1177 }
1178 
1179 /**
1180  * mei_cl_tx_flow_ctrl_creds - checks flow_control credits for cl.
1181  *
1182  * @cl: host client
1183  *
1184  * Return: 1 if tx_flow_ctrl_creds >0, 0 - otherwise.
1185  */
1186 static int mei_cl_tx_flow_ctrl_creds(struct mei_cl *cl)
1187 {
1188 	if (WARN_ON(!cl || !cl->me_cl))
1189 		return -EINVAL;
1190 
1191 	if (cl->tx_flow_ctrl_creds > 0)
1192 		return 1;
1193 
1194 	if (mei_cl_is_fixed_address(cl))
1195 		return 1;
1196 
1197 	if (mei_cl_is_single_recv_buf(cl)) {
1198 		if (cl->me_cl->tx_flow_ctrl_creds > 0)
1199 			return 1;
1200 	}
1201 	return 0;
1202 }
1203 
1204 /**
1205  * mei_cl_tx_flow_ctrl_creds_reduce - reduces transmit flow control credits
1206  *   for a client
1207  *
1208  * @cl: host client
1209  *
1210  * Return:
1211  *	0 on success
1212  *	-EINVAL when ctrl credits are <= 0
1213  */
1214 static int mei_cl_tx_flow_ctrl_creds_reduce(struct mei_cl *cl)
1215 {
1216 	if (WARN_ON(!cl || !cl->me_cl))
1217 		return -EINVAL;
1218 
1219 	if (mei_cl_is_fixed_address(cl))
1220 		return 0;
1221 
1222 	if (mei_cl_is_single_recv_buf(cl)) {
1223 		if (WARN_ON(cl->me_cl->tx_flow_ctrl_creds <= 0))
1224 			return -EINVAL;
1225 		cl->me_cl->tx_flow_ctrl_creds--;
1226 	} else {
1227 		if (WARN_ON(cl->tx_flow_ctrl_creds <= 0))
1228 			return -EINVAL;
1229 		cl->tx_flow_ctrl_creds--;
1230 	}
1231 	return 0;
1232 }
1233 
1234 /**
1235  *  mei_cl_notify_fop2req - convert fop to proper request
1236  *
1237  * @fop: client notification start response command
1238  *
1239  * Return:  MEI_HBM_NOTIFICATION_START/STOP
1240  */
1241 u8 mei_cl_notify_fop2req(enum mei_cb_file_ops fop)
1242 {
1243 	if (fop == MEI_FOP_NOTIFY_START)
1244 		return MEI_HBM_NOTIFICATION_START;
1245 	else
1246 		return MEI_HBM_NOTIFICATION_STOP;
1247 }
1248 
1249 /**
1250  *  mei_cl_notify_req2fop - convert notification request top file operation type
1251  *
1252  * @req: hbm notification request type
1253  *
1254  * Return:  MEI_FOP_NOTIFY_START/STOP
1255  */
1256 enum mei_cb_file_ops mei_cl_notify_req2fop(u8 req)
1257 {
1258 	if (req == MEI_HBM_NOTIFICATION_START)
1259 		return MEI_FOP_NOTIFY_START;
1260 	else
1261 		return MEI_FOP_NOTIFY_STOP;
1262 }
1263 
1264 /**
1265  * mei_cl_irq_notify - send notification request in irq_thread context
1266  *
1267  * @cl: client
1268  * @cb: callback block.
1269  * @cmpl_list: complete list.
1270  *
1271  * Return: 0 on such and error otherwise.
1272  */
1273 int mei_cl_irq_notify(struct mei_cl *cl, struct mei_cl_cb *cb,
1274 		      struct list_head *cmpl_list)
1275 {
1276 	struct mei_device *dev = cl->dev;
1277 	u32 msg_slots;
1278 	int slots;
1279 	int ret;
1280 	bool request;
1281 
1282 	msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
1283 	slots = mei_hbuf_empty_slots(dev);
1284 
1285 	if (slots < msg_slots)
1286 		return -EMSGSIZE;
1287 
1288 	request = mei_cl_notify_fop2req(cb->fop_type);
1289 	ret = mei_hbm_cl_notify_req(dev, cl, request);
1290 	if (ret) {
1291 		cl->status = ret;
1292 		list_move_tail(&cb->list, cmpl_list);
1293 		return ret;
1294 	}
1295 
1296 	list_move_tail(&cb->list, &dev->ctrl_rd_list);
1297 	return 0;
1298 }
1299 
1300 /**
1301  * mei_cl_notify_request - send notification stop/start request
1302  *
1303  * @cl: host client
1304  * @fp: associate request with file
1305  * @request: 1 for start or 0 for stop
1306  *
1307  * Locking: called under "dev->device_lock" lock
1308  *
1309  * Return: 0 on such and error otherwise.
1310  */
1311 int mei_cl_notify_request(struct mei_cl *cl,
1312 			  const struct file *fp, u8 request)
1313 {
1314 	struct mei_device *dev;
1315 	struct mei_cl_cb *cb;
1316 	enum mei_cb_file_ops fop_type;
1317 	int rets;
1318 
1319 	if (WARN_ON(!cl || !cl->dev))
1320 		return -ENODEV;
1321 
1322 	dev = cl->dev;
1323 
1324 	if (!dev->hbm_f_ev_supported) {
1325 		cl_dbg(dev, cl, "notifications not supported\n");
1326 		return -EOPNOTSUPP;
1327 	}
1328 
1329 	if (!mei_cl_is_connected(cl))
1330 		return -ENODEV;
1331 
1332 	rets = pm_runtime_get(dev->dev);
1333 	if (rets < 0 && rets != -EINPROGRESS) {
1334 		pm_runtime_put_noidle(dev->dev);
1335 		cl_err(dev, cl, "rpm: get failed %d\n", rets);
1336 		return rets;
1337 	}
1338 
1339 	fop_type = mei_cl_notify_req2fop(request);
1340 	cb = mei_cl_enqueue_ctrl_wr_cb(cl, 0, fop_type, fp);
1341 	if (!cb) {
1342 		rets = -ENOMEM;
1343 		goto out;
1344 	}
1345 
1346 	if (mei_hbuf_acquire(dev)) {
1347 		if (mei_hbm_cl_notify_req(dev, cl, request)) {
1348 			rets = -ENODEV;
1349 			goto out;
1350 		}
1351 		list_move_tail(&cb->list, &dev->ctrl_rd_list);
1352 	}
1353 
1354 	mutex_unlock(&dev->device_lock);
1355 	wait_event_timeout(cl->wait,
1356 			   cl->notify_en == request || !mei_cl_is_connected(cl),
1357 			   mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1358 	mutex_lock(&dev->device_lock);
1359 
1360 	if (cl->notify_en != request && !cl->status)
1361 		cl->status = -EFAULT;
1362 
1363 	rets = cl->status;
1364 
1365 out:
1366 	cl_dbg(dev, cl, "rpm: autosuspend\n");
1367 	pm_runtime_mark_last_busy(dev->dev);
1368 	pm_runtime_put_autosuspend(dev->dev);
1369 
1370 	mei_io_cb_free(cb);
1371 	return rets;
1372 }
1373 
1374 /**
1375  * mei_cl_notify - raise notification
1376  *
1377  * @cl: host client
1378  *
1379  * Locking: called under "dev->device_lock" lock
1380  */
1381 void mei_cl_notify(struct mei_cl *cl)
1382 {
1383 	struct mei_device *dev;
1384 
1385 	if (!cl || !cl->dev)
1386 		return;
1387 
1388 	dev = cl->dev;
1389 
1390 	if (!cl->notify_en)
1391 		return;
1392 
1393 	cl_dbg(dev, cl, "notify event");
1394 	cl->notify_ev = true;
1395 	if (!mei_cl_bus_notify_event(cl))
1396 		wake_up_interruptible(&cl->ev_wait);
1397 
1398 	if (cl->ev_async)
1399 		kill_fasync(&cl->ev_async, SIGIO, POLL_PRI);
1400 
1401 }
1402 
1403 /**
1404  * mei_cl_notify_get - get or wait for notification event
1405  *
1406  * @cl: host client
1407  * @block: this request is blocking
1408  * @notify_ev: true if notification event was received
1409  *
1410  * Locking: called under "dev->device_lock" lock
1411  *
1412  * Return: 0 on such and error otherwise.
1413  */
1414 int mei_cl_notify_get(struct mei_cl *cl, bool block, bool *notify_ev)
1415 {
1416 	struct mei_device *dev;
1417 	int rets;
1418 
1419 	*notify_ev = false;
1420 
1421 	if (WARN_ON(!cl || !cl->dev))
1422 		return -ENODEV;
1423 
1424 	dev = cl->dev;
1425 
1426 	if (!dev->hbm_f_ev_supported) {
1427 		cl_dbg(dev, cl, "notifications not supported\n");
1428 		return -EOPNOTSUPP;
1429 	}
1430 
1431 	if (!mei_cl_is_connected(cl))
1432 		return -ENODEV;
1433 
1434 	if (cl->notify_ev)
1435 		goto out;
1436 
1437 	if (!block)
1438 		return -EAGAIN;
1439 
1440 	mutex_unlock(&dev->device_lock);
1441 	rets = wait_event_interruptible(cl->ev_wait, cl->notify_ev);
1442 	mutex_lock(&dev->device_lock);
1443 
1444 	if (rets < 0)
1445 		return rets;
1446 
1447 out:
1448 	*notify_ev = cl->notify_ev;
1449 	cl->notify_ev = false;
1450 	return 0;
1451 }
1452 
1453 /**
1454  * mei_cl_read_start - the start read client message function.
1455  *
1456  * @cl: host client
1457  * @length: number of bytes to read
1458  * @fp: pointer to file structure
1459  *
1460  * Return: 0 on success, <0 on failure.
1461  */
1462 int mei_cl_read_start(struct mei_cl *cl, size_t length, const struct file *fp)
1463 {
1464 	struct mei_device *dev;
1465 	struct mei_cl_cb *cb;
1466 	int rets;
1467 
1468 	if (WARN_ON(!cl || !cl->dev))
1469 		return -ENODEV;
1470 
1471 	dev = cl->dev;
1472 
1473 	if (!mei_cl_is_connected(cl))
1474 		return -ENODEV;
1475 
1476 	if (!mei_me_cl_is_active(cl->me_cl)) {
1477 		cl_err(dev, cl, "no such me client\n");
1478 		return  -ENOTTY;
1479 	}
1480 
1481 	if (mei_cl_is_fixed_address(cl) || cl == &dev->iamthif_cl)
1482 		return 0;
1483 
1484 	/* HW currently supports only one pending read */
1485 	if (cl->rx_flow_ctrl_creds)
1486 		return -EBUSY;
1487 
1488 	cb = mei_cl_enqueue_ctrl_wr_cb(cl, length, MEI_FOP_READ, fp);
1489 	if (!cb)
1490 		return -ENOMEM;
1491 
1492 	rets = pm_runtime_get(dev->dev);
1493 	if (rets < 0 && rets != -EINPROGRESS) {
1494 		pm_runtime_put_noidle(dev->dev);
1495 		cl_err(dev, cl, "rpm: get failed %d\n", rets);
1496 		goto nortpm;
1497 	}
1498 
1499 	rets = 0;
1500 	if (mei_hbuf_acquire(dev)) {
1501 		rets = mei_hbm_cl_flow_control_req(dev, cl);
1502 		if (rets < 0)
1503 			goto out;
1504 
1505 		list_move_tail(&cb->list, &cl->rd_pending);
1506 	}
1507 	cl->rx_flow_ctrl_creds++;
1508 
1509 out:
1510 	cl_dbg(dev, cl, "rpm: autosuspend\n");
1511 	pm_runtime_mark_last_busy(dev->dev);
1512 	pm_runtime_put_autosuspend(dev->dev);
1513 nortpm:
1514 	if (rets)
1515 		mei_io_cb_free(cb);
1516 
1517 	return rets;
1518 }
1519 
1520 /**
1521  * mei_cl_irq_write - write a message to device
1522  *	from the interrupt thread context
1523  *
1524  * @cl: client
1525  * @cb: callback block.
1526  * @cmpl_list: complete list.
1527  *
1528  * Return: 0, OK; otherwise error.
1529  */
1530 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
1531 		     struct list_head *cmpl_list)
1532 {
1533 	struct mei_device *dev;
1534 	struct mei_msg_data *buf;
1535 	struct mei_msg_hdr mei_hdr;
1536 	size_t len;
1537 	u32 msg_slots;
1538 	int slots;
1539 	int rets;
1540 	bool first_chunk;
1541 
1542 	if (WARN_ON(!cl || !cl->dev))
1543 		return -ENODEV;
1544 
1545 	dev = cl->dev;
1546 
1547 	buf = &cb->buf;
1548 
1549 	first_chunk = cb->buf_idx == 0;
1550 
1551 	rets = first_chunk ? mei_cl_tx_flow_ctrl_creds(cl) : 1;
1552 	if (rets < 0)
1553 		goto err;
1554 
1555 	if (rets == 0) {
1556 		cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1557 		return 0;
1558 	}
1559 
1560 	slots = mei_hbuf_empty_slots(dev);
1561 	len = buf->size - cb->buf_idx;
1562 	msg_slots = mei_data2slots(len);
1563 
1564 	mei_hdr.host_addr = mei_cl_host_addr(cl);
1565 	mei_hdr.me_addr = mei_cl_me_id(cl);
1566 	mei_hdr.reserved = 0;
1567 	mei_hdr.internal = cb->internal;
1568 
1569 	if (slots >= msg_slots) {
1570 		mei_hdr.length = len;
1571 		mei_hdr.msg_complete = 1;
1572 	/* Split the message only if we can write the whole host buffer */
1573 	} else if (slots == dev->hbuf_depth) {
1574 		msg_slots = slots;
1575 		len = (slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
1576 		mei_hdr.length = len;
1577 		mei_hdr.msg_complete = 0;
1578 	} else {
1579 		/* wait for next time the host buffer is empty */
1580 		return 0;
1581 	}
1582 
1583 	cl_dbg(dev, cl, "buf: size = %zu idx = %zu\n",
1584 			cb->buf.size, cb->buf_idx);
1585 
1586 	rets = mei_write_message(dev, &mei_hdr, buf->data + cb->buf_idx);
1587 	if (rets)
1588 		goto err;
1589 
1590 	cl->status = 0;
1591 	cl->writing_state = MEI_WRITING;
1592 	cb->buf_idx += mei_hdr.length;
1593 	cb->completed = mei_hdr.msg_complete == 1;
1594 
1595 	if (first_chunk) {
1596 		if (mei_cl_tx_flow_ctrl_creds_reduce(cl)) {
1597 			rets = -EIO;
1598 			goto err;
1599 		}
1600 	}
1601 
1602 	if (mei_hdr.msg_complete)
1603 		list_move_tail(&cb->list, &dev->write_waiting_list);
1604 
1605 	return 0;
1606 
1607 err:
1608 	cl->status = rets;
1609 	list_move_tail(&cb->list, cmpl_list);
1610 	return rets;
1611 }
1612 
1613 /**
1614  * mei_cl_write - submit a write cb to mei device
1615  *	assumes device_lock is locked
1616  *
1617  * @cl: host client
1618  * @cb: write callback with filled data
1619  *
1620  * Return: number of bytes sent on success, <0 on failure.
1621  */
1622 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb)
1623 {
1624 	struct mei_device *dev;
1625 	struct mei_msg_data *buf;
1626 	struct mei_msg_hdr mei_hdr;
1627 	int size;
1628 	int rets;
1629 	bool blocking;
1630 
1631 	if (WARN_ON(!cl || !cl->dev))
1632 		return -ENODEV;
1633 
1634 	if (WARN_ON(!cb))
1635 		return -EINVAL;
1636 
1637 	dev = cl->dev;
1638 
1639 	buf = &cb->buf;
1640 	size = buf->size;
1641 	blocking = cb->blocking;
1642 
1643 	cl_dbg(dev, cl, "size=%d\n", size);
1644 
1645 	rets = pm_runtime_get(dev->dev);
1646 	if (rets < 0 && rets != -EINPROGRESS) {
1647 		pm_runtime_put_noidle(dev->dev);
1648 		cl_err(dev, cl, "rpm: get failed %d\n", rets);
1649 		goto free;
1650 	}
1651 
1652 	cb->buf_idx = 0;
1653 	cl->writing_state = MEI_IDLE;
1654 
1655 	mei_hdr.host_addr = mei_cl_host_addr(cl);
1656 	mei_hdr.me_addr = mei_cl_me_id(cl);
1657 	mei_hdr.reserved = 0;
1658 	mei_hdr.msg_complete = 0;
1659 	mei_hdr.internal = cb->internal;
1660 
1661 	rets = mei_cl_tx_flow_ctrl_creds(cl);
1662 	if (rets < 0)
1663 		goto err;
1664 
1665 	if (rets == 0) {
1666 		cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1667 		rets = size;
1668 		goto out;
1669 	}
1670 	if (!mei_hbuf_acquire(dev)) {
1671 		cl_dbg(dev, cl, "Cannot acquire the host buffer: not sending.\n");
1672 		rets = size;
1673 		goto out;
1674 	}
1675 
1676 	/* Check for a maximum length */
1677 	if (size > mei_hbuf_max_len(dev)) {
1678 		mei_hdr.length = mei_hbuf_max_len(dev);
1679 		mei_hdr.msg_complete = 0;
1680 	} else {
1681 		mei_hdr.length = size;
1682 		mei_hdr.msg_complete = 1;
1683 	}
1684 
1685 	rets = mei_write_message(dev, &mei_hdr, buf->data);
1686 	if (rets)
1687 		goto err;
1688 
1689 	rets = mei_cl_tx_flow_ctrl_creds_reduce(cl);
1690 	if (rets)
1691 		goto err;
1692 
1693 	cl->writing_state = MEI_WRITING;
1694 	cb->buf_idx = mei_hdr.length;
1695 	cb->completed = mei_hdr.msg_complete == 1;
1696 
1697 out:
1698 	if (mei_hdr.msg_complete)
1699 		list_add_tail(&cb->list, &dev->write_waiting_list);
1700 	else
1701 		list_add_tail(&cb->list, &dev->write_list);
1702 
1703 	cb = NULL;
1704 	if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
1705 
1706 		mutex_unlock(&dev->device_lock);
1707 		rets = wait_event_interruptible(cl->tx_wait,
1708 				cl->writing_state == MEI_WRITE_COMPLETE ||
1709 				(!mei_cl_is_connected(cl)));
1710 		mutex_lock(&dev->device_lock);
1711 		/* wait_event_interruptible returns -ERESTARTSYS */
1712 		if (rets) {
1713 			if (signal_pending(current))
1714 				rets = -EINTR;
1715 			goto err;
1716 		}
1717 		if (cl->writing_state != MEI_WRITE_COMPLETE) {
1718 			rets = -EFAULT;
1719 			goto err;
1720 		}
1721 	}
1722 
1723 	rets = size;
1724 err:
1725 	cl_dbg(dev, cl, "rpm: autosuspend\n");
1726 	pm_runtime_mark_last_busy(dev->dev);
1727 	pm_runtime_put_autosuspend(dev->dev);
1728 free:
1729 	mei_io_cb_free(cb);
1730 
1731 	return rets;
1732 }
1733 
1734 
1735 /**
1736  * mei_cl_complete - processes completed operation for a client
1737  *
1738  * @cl: private data of the file object.
1739  * @cb: callback block.
1740  */
1741 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
1742 {
1743 	struct mei_device *dev = cl->dev;
1744 
1745 	switch (cb->fop_type) {
1746 	case MEI_FOP_WRITE:
1747 		mei_io_cb_free(cb);
1748 		cl->writing_state = MEI_WRITE_COMPLETE;
1749 		if (waitqueue_active(&cl->tx_wait)) {
1750 			wake_up_interruptible(&cl->tx_wait);
1751 		} else {
1752 			pm_runtime_mark_last_busy(dev->dev);
1753 			pm_request_autosuspend(dev->dev);
1754 		}
1755 		break;
1756 
1757 	case MEI_FOP_READ:
1758 		list_add_tail(&cb->list, &cl->rd_completed);
1759 		if (!mei_cl_is_fixed_address(cl) &&
1760 		    !WARN_ON(!cl->rx_flow_ctrl_creds))
1761 			cl->rx_flow_ctrl_creds--;
1762 		if (!mei_cl_bus_rx_event(cl))
1763 			wake_up_interruptible(&cl->rx_wait);
1764 		break;
1765 
1766 	case MEI_FOP_CONNECT:
1767 	case MEI_FOP_DISCONNECT:
1768 	case MEI_FOP_NOTIFY_STOP:
1769 	case MEI_FOP_NOTIFY_START:
1770 		if (waitqueue_active(&cl->wait))
1771 			wake_up(&cl->wait);
1772 
1773 		break;
1774 	case MEI_FOP_DISCONNECT_RSP:
1775 		mei_io_cb_free(cb);
1776 		mei_cl_set_disconnected(cl);
1777 		break;
1778 	default:
1779 		BUG_ON(0);
1780 	}
1781 }
1782 
1783 
1784 /**
1785  * mei_cl_all_disconnect - disconnect forcefully all connected clients
1786  *
1787  * @dev: mei device
1788  */
1789 void mei_cl_all_disconnect(struct mei_device *dev)
1790 {
1791 	struct mei_cl *cl;
1792 
1793 	list_for_each_entry(cl, &dev->file_list, link)
1794 		mei_cl_set_disconnected(cl);
1795 }
1796