]> git.karo-electronics.de Git - karo-tx-linux.git/blob - drivers/misc/mei/client.c
mei: fix flow control for single buffer clients
[karo-tx-linux.git] / drivers / misc / mei / client.c
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.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 struct mei_cl_cb *mei_io_cb_init(struct mei_cl *cl, enum mei_cb_file_ops type,
362                                  struct file *fp)
363 {
364         struct mei_cl_cb *cb;
365
366         cb = kzalloc(sizeof(struct mei_cl_cb), GFP_KERNEL);
367         if (!cb)
368                 return NULL;
369
370         INIT_LIST_HEAD(&cb->list);
371         cb->file_object = fp;
372         cb->cl = cl;
373         cb->buf_idx = 0;
374         cb->fop_type = type;
375         return cb;
376 }
377
378 /**
379  * __mei_io_list_flush - removes and frees cbs belonging to cl.
380  *
381  * @list:  an instance of our list structure
382  * @cl:    host client, can be NULL for flushing the whole list
383  * @free:  whether to free the cbs
384  */
385 static void __mei_io_list_flush(struct mei_cl_cb *list,
386                                 struct mei_cl *cl, bool free)
387 {
388         struct mei_cl_cb *cb, *next;
389
390         /* enable removing everything if no cl is specified */
391         list_for_each_entry_safe(cb, next, &list->list, list) {
392                 if (!cl || mei_cl_cmp_id(cl, cb->cl)) {
393                         list_del_init(&cb->list);
394                         if (free)
395                                 mei_io_cb_free(cb);
396                 }
397         }
398 }
399
400 /**
401  * mei_io_list_flush - removes list entry belonging to cl.
402  *
403  * @list:  An instance of our list structure
404  * @cl: host client
405  */
406 void mei_io_list_flush(struct mei_cl_cb *list, struct mei_cl *cl)
407 {
408         __mei_io_list_flush(list, cl, false);
409 }
410
411 /**
412  * mei_io_list_free - removes cb belonging to cl and free them
413  *
414  * @list:  An instance of our list structure
415  * @cl: host client
416  */
417 static inline void mei_io_list_free(struct mei_cl_cb *list, struct mei_cl *cl)
418 {
419         __mei_io_list_flush(list, cl, true);
420 }
421
422 /**
423  * mei_io_cb_alloc_buf - allocate callback buffer
424  *
425  * @cb: io callback structure
426  * @length: size of the buffer
427  *
428  * Return: 0 on success
429  *         -EINVAL if cb is NULL
430  *         -ENOMEM if allocation failed
431  */
432 int mei_io_cb_alloc_buf(struct mei_cl_cb *cb, size_t length)
433 {
434         if (!cb)
435                 return -EINVAL;
436
437         if (length == 0)
438                 return 0;
439
440         cb->buf.data = kmalloc(length, GFP_KERNEL);
441         if (!cb->buf.data)
442                 return -ENOMEM;
443         cb->buf.size = length;
444         return 0;
445 }
446
447 /**
448  * mei_cl_alloc_cb - a convenient wrapper for allocating read cb
449  *
450  * @cl: host client
451  * @length: size of the buffer
452  * @type: operation type
453  * @fp: associated file pointer (might be NULL)
454  *
455  * Return: cb on success and NULL on failure
456  */
457 struct mei_cl_cb *mei_cl_alloc_cb(struct mei_cl *cl, size_t length,
458                                   enum mei_cb_file_ops type, struct file *fp)
459 {
460         struct mei_cl_cb *cb;
461
462         cb = mei_io_cb_init(cl, type, fp);
463         if (!cb)
464                 return NULL;
465
466         if (mei_io_cb_alloc_buf(cb, length)) {
467                 mei_io_cb_free(cb);
468                 return NULL;
469         }
470
471         return cb;
472 }
473
474 /**
475  * mei_cl_read_cb - find this cl's callback in the read list
476  *     for a specific file
477  *
478  * @cl: host client
479  * @fp: file pointer (matching cb file object), may be NULL
480  *
481  * Return: cb on success, NULL if cb is not found
482  */
483 struct mei_cl_cb *mei_cl_read_cb(const struct mei_cl *cl, const struct file *fp)
484 {
485         struct mei_cl_cb *cb;
486
487         list_for_each_entry(cb, &cl->rd_completed, list)
488                 if (!fp || fp == cb->file_object)
489                         return cb;
490
491         return NULL;
492 }
493
494 /**
495  * mei_cl_read_cb_flush - free client's read pending and completed cbs
496  *   for a specific file
497  *
498  * @cl: host client
499  * @fp: file pointer (matching cb file object), may be NULL
500  */
501 void mei_cl_read_cb_flush(const struct mei_cl *cl, const struct file *fp)
502 {
503         struct mei_cl_cb *cb, *next;
504
505         list_for_each_entry_safe(cb, next, &cl->rd_completed, list)
506                 if (!fp || fp == cb->file_object)
507                         mei_io_cb_free(cb);
508
509
510         list_for_each_entry_safe(cb, next, &cl->rd_pending, list)
511                 if (!fp || fp == cb->file_object)
512                         mei_io_cb_free(cb);
513 }
514
515 /**
516  * mei_cl_flush_queues - flushes queue lists belonging to cl.
517  *
518  * @cl: host client
519  * @fp: file pointer (matching cb file object), may be NULL
520  *
521  * Return: 0 on success, -EINVAL if cl or cl->dev is NULL.
522  */
523 int mei_cl_flush_queues(struct mei_cl *cl, const struct file *fp)
524 {
525         struct mei_device *dev;
526
527         if (WARN_ON(!cl || !cl->dev))
528                 return -EINVAL;
529
530         dev = cl->dev;
531
532         cl_dbg(dev, cl, "remove list entry belonging to cl\n");
533         mei_io_list_free(&cl->dev->write_list, cl);
534         mei_io_list_free(&cl->dev->write_waiting_list, cl);
535         mei_io_list_flush(&cl->dev->ctrl_wr_list, cl);
536         mei_io_list_flush(&cl->dev->ctrl_rd_list, cl);
537         mei_io_list_flush(&cl->dev->amthif_cmd_list, cl);
538         mei_io_list_flush(&cl->dev->amthif_rd_complete_list, cl);
539
540         mei_cl_read_cb_flush(cl, fp);
541
542         return 0;
543 }
544
545
546 /**
547  * mei_cl_init - initializes cl.
548  *
549  * @cl: host client to be initialized
550  * @dev: mei device
551  */
552 void mei_cl_init(struct mei_cl *cl, struct mei_device *dev)
553 {
554         memset(cl, 0, sizeof(struct mei_cl));
555         init_waitqueue_head(&cl->wait);
556         init_waitqueue_head(&cl->rx_wait);
557         init_waitqueue_head(&cl->tx_wait);
558         INIT_LIST_HEAD(&cl->rd_completed);
559         INIT_LIST_HEAD(&cl->rd_pending);
560         INIT_LIST_HEAD(&cl->link);
561         INIT_LIST_HEAD(&cl->device_link);
562         cl->writing_state = MEI_IDLE;
563         cl->state = MEI_FILE_INITIALIZING;
564         cl->dev = dev;
565 }
566
567 /**
568  * mei_cl_allocate - allocates cl  structure and sets it up.
569  *
570  * @dev: mei device
571  * Return:  The allocated file or NULL on failure
572  */
573 struct mei_cl *mei_cl_allocate(struct mei_device *dev)
574 {
575         struct mei_cl *cl;
576
577         cl = kmalloc(sizeof(struct mei_cl), GFP_KERNEL);
578         if (!cl)
579                 return NULL;
580
581         mei_cl_init(cl, dev);
582
583         return cl;
584 }
585
586 /**
587  * mei_cl_link - allocate host id in the host map
588  *
589  * @cl: host client
590  * @id: fixed host id or MEI_HOST_CLIENT_ID_ANY (-1) for generic one
591  *
592  * Return: 0 on success
593  *      -EINVAL on incorrect values
594  *      -EMFILE if open count exceeded.
595  */
596 int mei_cl_link(struct mei_cl *cl, int id)
597 {
598         struct mei_device *dev;
599         long open_handle_count;
600
601         if (WARN_ON(!cl || !cl->dev))
602                 return -EINVAL;
603
604         dev = cl->dev;
605
606         /* If Id is not assigned get one*/
607         if (id == MEI_HOST_CLIENT_ID_ANY)
608                 id = find_first_zero_bit(dev->host_clients_map,
609                                         MEI_CLIENTS_MAX);
610
611         if (id >= MEI_CLIENTS_MAX) {
612                 dev_err(dev->dev, "id exceeded %d", MEI_CLIENTS_MAX);
613                 return -EMFILE;
614         }
615
616         open_handle_count = dev->open_handle_count + dev->iamthif_open_count;
617         if (open_handle_count >= MEI_MAX_OPEN_HANDLE_COUNT) {
618                 dev_err(dev->dev, "open_handle_count exceeded %d",
619                         MEI_MAX_OPEN_HANDLE_COUNT);
620                 return -EMFILE;
621         }
622
623         dev->open_handle_count++;
624
625         cl->host_client_id = id;
626         list_add_tail(&cl->link, &dev->file_list);
627
628         set_bit(id, dev->host_clients_map);
629
630         cl->state = MEI_FILE_INITIALIZING;
631
632         cl_dbg(dev, cl, "link cl\n");
633         return 0;
634 }
635
636 /**
637  * mei_cl_unlink - remove host client from the list
638  *
639  * @cl: host client
640  *
641  * Return: always 0
642  */
643 int mei_cl_unlink(struct mei_cl *cl)
644 {
645         struct mei_device *dev;
646
647         /* don't shout on error exit path */
648         if (!cl)
649                 return 0;
650
651         /* wd and amthif might not be initialized */
652         if (!cl->dev)
653                 return 0;
654
655         dev = cl->dev;
656
657         cl_dbg(dev, cl, "unlink client");
658
659         if (dev->open_handle_count > 0)
660                 dev->open_handle_count--;
661
662         /* never clear the 0 bit */
663         if (cl->host_client_id)
664                 clear_bit(cl->host_client_id, dev->host_clients_map);
665
666         list_del_init(&cl->link);
667
668         cl->state = MEI_FILE_INITIALIZING;
669
670         return 0;
671 }
672
673
674 void mei_host_client_init(struct work_struct *work)
675 {
676         struct mei_device *dev =
677                 container_of(work, struct mei_device, init_work);
678         struct mei_me_client *me_cl;
679
680         mutex_lock(&dev->device_lock);
681
682
683         me_cl = mei_me_cl_by_uuid(dev, &mei_amthif_guid);
684         if (me_cl)
685                 mei_amthif_host_init(dev, me_cl);
686         mei_me_cl_put(me_cl);
687
688         me_cl = mei_me_cl_by_uuid(dev, &mei_wd_guid);
689         if (me_cl)
690                 mei_wd_host_init(dev, me_cl);
691         mei_me_cl_put(me_cl);
692
693         me_cl = mei_me_cl_by_uuid(dev, &mei_nfc_guid);
694         if (me_cl)
695                 mei_nfc_host_init(dev, me_cl);
696         mei_me_cl_put(me_cl);
697
698
699         dev->dev_state = MEI_DEV_ENABLED;
700         dev->reset_count = 0;
701         mutex_unlock(&dev->device_lock);
702
703         pm_runtime_mark_last_busy(dev->dev);
704         dev_dbg(dev->dev, "rpm: autosuspend\n");
705         pm_runtime_autosuspend(dev->dev);
706 }
707
708 /**
709  * mei_hbuf_acquire - try to acquire host buffer
710  *
711  * @dev: the device structure
712  * Return: true if host buffer was acquired
713  */
714 bool mei_hbuf_acquire(struct mei_device *dev)
715 {
716         if (mei_pg_state(dev) == MEI_PG_ON ||
717             dev->pg_event == MEI_PG_EVENT_WAIT) {
718                 dev_dbg(dev->dev, "device is in pg\n");
719                 return false;
720         }
721
722         if (!dev->hbuf_is_ready) {
723                 dev_dbg(dev->dev, "hbuf is not ready\n");
724                 return false;
725         }
726
727         dev->hbuf_is_ready = false;
728
729         return true;
730 }
731
732 /**
733  * mei_cl_set_disconnected - set disconnected state and clear
734  *   associated states and resources
735  *
736  * @cl: host client
737  */
738 void mei_cl_set_disconnected(struct mei_cl *cl)
739 {
740         struct mei_device *dev = cl->dev;
741
742         if (cl->state == MEI_FILE_DISCONNECTED ||
743             cl->state == MEI_FILE_INITIALIZING)
744                 return;
745
746         cl->state = MEI_FILE_DISCONNECTED;
747         mei_io_list_flush(&dev->ctrl_rd_list, cl);
748         mei_io_list_flush(&dev->ctrl_wr_list, cl);
749         cl->mei_flow_ctrl_creds = 0;
750         cl->timer_count = 0;
751
752         if (!cl->me_cl)
753                 return;
754
755         if (!WARN_ON(cl->me_cl->connect_count == 0))
756                 cl->me_cl->connect_count--;
757
758         if (cl->me_cl->connect_count == 0)
759                 cl->me_cl->mei_flow_ctrl_creds = 0;
760
761         mei_me_cl_put(cl->me_cl);
762         cl->me_cl = NULL;
763 }
764
765 static int mei_cl_set_connecting(struct mei_cl *cl, struct mei_me_client *me_cl)
766 {
767         cl->me_cl = mei_me_cl_get(me_cl);
768         if (!cl->me_cl)
769                 return -ENOENT;
770
771         cl->state = MEI_FILE_CONNECTING;
772         cl->me_cl->connect_count++;
773
774         return 0;
775 }
776
777 /*
778  * mei_cl_send_disconnect - send disconnect request
779  *
780  * @cl: host client
781  * @cb: callback block
782  *
783  * Return: 0, OK; otherwise, error.
784  */
785 static int mei_cl_send_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb)
786 {
787         struct mei_device *dev;
788         int ret;
789
790         dev = cl->dev;
791
792         ret = mei_hbm_cl_disconnect_req(dev, cl);
793         cl->status = ret;
794         if (ret) {
795                 cl->state = MEI_FILE_DISCONNECT_REPLY;
796                 return ret;
797         }
798
799         list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
800         cl->timer_count = MEI_CONNECT_TIMEOUT;
801
802         return 0;
803 }
804
805 /**
806  * mei_cl_irq_disconnect - processes close related operation from
807  *      interrupt thread context - send disconnect request
808  *
809  * @cl: client
810  * @cb: callback block.
811  * @cmpl_list: complete list.
812  *
813  * Return: 0, OK; otherwise, error.
814  */
815 int mei_cl_irq_disconnect(struct mei_cl *cl, struct mei_cl_cb *cb,
816                             struct mei_cl_cb *cmpl_list)
817 {
818         struct mei_device *dev = cl->dev;
819         u32 msg_slots;
820         int slots;
821         int ret;
822
823         msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
824         slots = mei_hbuf_empty_slots(dev);
825
826         if (slots < msg_slots)
827                 return -EMSGSIZE;
828
829         ret = mei_cl_send_disconnect(cl, cb);
830         if (ret)
831                 list_move_tail(&cb->list, &cmpl_list->list);
832
833         return ret;
834 }
835
836
837
838 /**
839  * mei_cl_disconnect - disconnect host client from the me one
840  *
841  * @cl: host client
842  *
843  * Locking: called under "dev->device_lock" lock
844  *
845  * Return: 0 on success, <0 on failure.
846  */
847 int mei_cl_disconnect(struct mei_cl *cl)
848 {
849         struct mei_device *dev;
850         struct mei_cl_cb *cb;
851         int rets;
852
853         if (WARN_ON(!cl || !cl->dev))
854                 return -ENODEV;
855
856         dev = cl->dev;
857
858         cl_dbg(dev, cl, "disconnecting");
859
860         if (!mei_cl_is_connected(cl))
861                 return 0;
862
863         rets = pm_runtime_get(dev->dev);
864         if (rets < 0 && rets != -EINPROGRESS) {
865                 pm_runtime_put_noidle(dev->dev);
866                 cl_err(dev, cl, "rpm: get failed %d\n", rets);
867                 return rets;
868         }
869
870         cl->state = MEI_FILE_DISCONNECTING;
871
872         cb = mei_io_cb_init(cl, MEI_FOP_DISCONNECT, NULL);
873         rets = cb ? 0 : -ENOMEM;
874         if (rets)
875                 goto out;
876
877         cl_dbg(dev, cl, "add disconnect cb to control write list\n");
878         list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
879
880         if (mei_hbuf_acquire(dev)) {
881                 rets = mei_cl_send_disconnect(cl, cb);
882                 if (rets) {
883                         cl_err(dev, cl, "failed to disconnect.\n");
884                         goto out;
885                 }
886         }
887
888         mutex_unlock(&dev->device_lock);
889         wait_event_timeout(cl->wait, cl->state == MEI_FILE_DISCONNECT_REPLY,
890                            mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
891         mutex_lock(&dev->device_lock);
892
893         rets = cl->status;
894         if (cl->state != MEI_FILE_DISCONNECT_REPLY) {
895                 cl_dbg(dev, cl, "timeout on disconnect from FW client.\n");
896                 rets = -ETIME;
897         }
898
899 out:
900         /* we disconnect also on error */
901         mei_cl_set_disconnected(cl);
902         if (!rets)
903                 cl_dbg(dev, cl, "successfully disconnected from FW client.\n");
904
905         cl_dbg(dev, cl, "rpm: autosuspend\n");
906         pm_runtime_mark_last_busy(dev->dev);
907         pm_runtime_put_autosuspend(dev->dev);
908
909         mei_io_cb_free(cb);
910         return rets;
911 }
912
913
914 /**
915  * mei_cl_is_other_connecting - checks if other
916  *    client with the same me client id is connecting
917  *
918  * @cl: private data of the file object
919  *
920  * Return: true if other client is connected, false - otherwise.
921  */
922 static bool mei_cl_is_other_connecting(struct mei_cl *cl)
923 {
924         struct mei_device *dev;
925         struct mei_cl_cb *cb;
926
927         dev = cl->dev;
928
929         list_for_each_entry(cb, &dev->ctrl_rd_list.list, list) {
930                 if (cb->fop_type == MEI_FOP_CONNECT &&
931                     mei_cl_me_id(cl) == mei_cl_me_id(cb->cl))
932                         return true;
933         }
934
935         return false;
936 }
937
938 /**
939  * mei_cl_send_connect - send connect request
940  *
941  * @cl: host client
942  * @cb: callback block
943  *
944  * Return: 0, OK; otherwise, error.
945  */
946 static int mei_cl_send_connect(struct mei_cl *cl, struct mei_cl_cb *cb)
947 {
948         struct mei_device *dev;
949         int ret;
950
951         dev = cl->dev;
952
953         ret = mei_hbm_cl_connect_req(dev, cl);
954         cl->status = ret;
955         if (ret) {
956                 cl->state = MEI_FILE_DISCONNECT_REPLY;
957                 return ret;
958         }
959
960         list_move_tail(&cb->list, &dev->ctrl_rd_list.list);
961         cl->timer_count = MEI_CONNECT_TIMEOUT;
962         return 0;
963 }
964
965 /**
966  * mei_cl_irq_connect - send connect request in irq_thread context
967  *
968  * @cl: host client
969  * @cb: callback block
970  * @cmpl_list: complete list
971  *
972  * Return: 0, OK; otherwise, error.
973  */
974 int mei_cl_irq_connect(struct mei_cl *cl, struct mei_cl_cb *cb,
975                               struct mei_cl_cb *cmpl_list)
976 {
977         struct mei_device *dev = cl->dev;
978         u32 msg_slots;
979         int slots;
980         int rets;
981
982         msg_slots = mei_data2slots(sizeof(struct hbm_client_connect_request));
983         slots = mei_hbuf_empty_slots(dev);
984
985         if (mei_cl_is_other_connecting(cl))
986                 return 0;
987
988         if (slots < msg_slots)
989                 return -EMSGSIZE;
990
991         rets = mei_cl_send_connect(cl, cb);
992         if (rets)
993                 list_move_tail(&cb->list, &cmpl_list->list);
994
995         return rets;
996 }
997
998 /**
999  * mei_cl_connect - connect host client to the me one
1000  *
1001  * @cl: host client
1002  * @me_cl: me client
1003  * @file: pointer to file structure
1004  *
1005  * Locking: called under "dev->device_lock" lock
1006  *
1007  * Return: 0 on success, <0 on failure.
1008  */
1009 int mei_cl_connect(struct mei_cl *cl, struct mei_me_client *me_cl,
1010                    struct file *file)
1011 {
1012         struct mei_device *dev;
1013         struct mei_cl_cb *cb;
1014         int rets;
1015
1016         if (WARN_ON(!cl || !cl->dev))
1017                 return -ENODEV;
1018
1019         dev = cl->dev;
1020
1021         rets = pm_runtime_get(dev->dev);
1022         if (rets < 0 && rets != -EINPROGRESS) {
1023                 pm_runtime_put_noidle(dev->dev);
1024                 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1025                 return rets;
1026         }
1027
1028         cb = mei_io_cb_init(cl, MEI_FOP_CONNECT, file);
1029         rets = cb ? 0 : -ENOMEM;
1030         if (rets)
1031                 goto out;
1032
1033         rets = mei_cl_set_connecting(cl, me_cl);
1034         if (rets)
1035                 goto out;
1036         list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1037
1038         /* run hbuf acquire last so we don't have to undo */
1039         if (!mei_cl_is_other_connecting(cl) && mei_hbuf_acquire(dev)) {
1040                 rets = mei_cl_send_connect(cl, cb);
1041                 if (rets)
1042                         goto out;
1043         }
1044
1045         mutex_unlock(&dev->device_lock);
1046         wait_event_timeout(cl->wait,
1047                         (cl->state == MEI_FILE_CONNECTED ||
1048                          cl->state == MEI_FILE_DISCONNECT_REPLY),
1049                         mei_secs_to_jiffies(MEI_CL_CONNECT_TIMEOUT));
1050         mutex_lock(&dev->device_lock);
1051
1052         if (!mei_cl_is_connected(cl)) {
1053                 /* timeout or something went really wrong */
1054                 if (!cl->status)
1055                         cl->status = -EFAULT;
1056         }
1057
1058         rets = cl->status;
1059 out:
1060         cl_dbg(dev, cl, "rpm: autosuspend\n");
1061         pm_runtime_mark_last_busy(dev->dev);
1062         pm_runtime_put_autosuspend(dev->dev);
1063
1064         mei_io_cb_free(cb);
1065
1066         if (!mei_cl_is_connected(cl))
1067                 mei_cl_set_disconnected(cl);
1068
1069         return rets;
1070 }
1071
1072 /**
1073  * mei_cl_alloc_linked - allocate and link host client
1074  *
1075  * @dev: the device structure
1076  * @id: fixed host id or MEI_HOST_CLIENT_ID_ANY (-1) for generic one
1077  *
1078  * Return: cl on success ERR_PTR on failure
1079  */
1080 struct mei_cl *mei_cl_alloc_linked(struct mei_device *dev, int id)
1081 {
1082         struct mei_cl *cl;
1083         int ret;
1084
1085         cl = mei_cl_allocate(dev);
1086         if (!cl) {
1087                 ret = -ENOMEM;
1088                 goto err;
1089         }
1090
1091         ret = mei_cl_link(cl, id);
1092         if (ret)
1093                 goto err;
1094
1095         return cl;
1096 err:
1097         kfree(cl);
1098         return ERR_PTR(ret);
1099 }
1100
1101
1102
1103 /**
1104  * mei_cl_flow_ctrl_creds - checks flow_control credits for cl.
1105  *
1106  * @cl: private data of the file object
1107  *
1108  * Return: 1 if mei_flow_ctrl_creds >0, 0 - otherwise.
1109  */
1110 int mei_cl_flow_ctrl_creds(struct mei_cl *cl)
1111 {
1112         if (WARN_ON(!cl || !cl->me_cl))
1113                 return -EINVAL;
1114
1115         if (cl->mei_flow_ctrl_creds > 0)
1116                 return 1;
1117
1118         if (mei_cl_is_single_recv_buf(cl)) {
1119                 if (cl->me_cl->mei_flow_ctrl_creds > 0)
1120                         return 1;
1121         }
1122         return 0;
1123 }
1124
1125 /**
1126  * mei_cl_flow_ctrl_reduce - reduces flow_control.
1127  *
1128  * @cl: private data of the file object
1129  *
1130  * Return:
1131  *      0 on success
1132  *      -EINVAL when ctrl credits are <= 0
1133  */
1134 int mei_cl_flow_ctrl_reduce(struct mei_cl *cl)
1135 {
1136         if (WARN_ON(!cl || !cl->me_cl))
1137                 return -EINVAL;
1138
1139         if (mei_cl_is_single_recv_buf(cl)) {
1140                 if (WARN_ON(cl->me_cl->mei_flow_ctrl_creds <= 0))
1141                         return -EINVAL;
1142                 cl->me_cl->mei_flow_ctrl_creds--;
1143         } else {
1144                 if (WARN_ON(cl->mei_flow_ctrl_creds <= 0))
1145                         return -EINVAL;
1146                 cl->mei_flow_ctrl_creds--;
1147         }
1148         return 0;
1149 }
1150
1151 /**
1152  * mei_cl_read_start - the start read client message function.
1153  *
1154  * @cl: host client
1155  * @length: number of bytes to read
1156  * @fp: pointer to file structure
1157  *
1158  * Return: 0 on success, <0 on failure.
1159  */
1160 int mei_cl_read_start(struct mei_cl *cl, size_t length, struct file *fp)
1161 {
1162         struct mei_device *dev;
1163         struct mei_cl_cb *cb;
1164         int rets;
1165
1166         if (WARN_ON(!cl || !cl->dev))
1167                 return -ENODEV;
1168
1169         dev = cl->dev;
1170
1171         if (!mei_cl_is_connected(cl))
1172                 return -ENODEV;
1173
1174         /* HW currently supports only one pending read */
1175         if (!list_empty(&cl->rd_pending))
1176                 return -EBUSY;
1177
1178         if (!mei_me_cl_is_active(cl->me_cl)) {
1179                 cl_err(dev, cl, "no such me client\n");
1180                 return  -ENOTTY;
1181         }
1182         /* always allocate at least client max message */
1183         length = max_t(size_t, length, mei_cl_mtu(cl));
1184
1185         rets = pm_runtime_get(dev->dev);
1186         if (rets < 0 && rets != -EINPROGRESS) {
1187                 pm_runtime_put_noidle(dev->dev);
1188                 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1189                 return rets;
1190         }
1191
1192         cb = mei_cl_alloc_cb(cl, length, MEI_FOP_READ, fp);
1193         rets = cb ? 0 : -ENOMEM;
1194         if (rets)
1195                 goto out;
1196
1197         if (mei_hbuf_acquire(dev)) {
1198                 rets = mei_hbm_cl_flow_control_req(dev, cl);
1199                 if (rets < 0)
1200                         goto out;
1201
1202                 list_add_tail(&cb->list, &cl->rd_pending);
1203         } else {
1204                 list_add_tail(&cb->list, &dev->ctrl_wr_list.list);
1205         }
1206
1207 out:
1208         cl_dbg(dev, cl, "rpm: autosuspend\n");
1209         pm_runtime_mark_last_busy(dev->dev);
1210         pm_runtime_put_autosuspend(dev->dev);
1211
1212         if (rets)
1213                 mei_io_cb_free(cb);
1214
1215         return rets;
1216 }
1217
1218 /**
1219  * mei_cl_irq_write - write a message to device
1220  *      from the interrupt thread context
1221  *
1222  * @cl: client
1223  * @cb: callback block.
1224  * @cmpl_list: complete list.
1225  *
1226  * Return: 0, OK; otherwise error.
1227  */
1228 int mei_cl_irq_write(struct mei_cl *cl, struct mei_cl_cb *cb,
1229                      struct mei_cl_cb *cmpl_list)
1230 {
1231         struct mei_device *dev;
1232         struct mei_msg_data *buf;
1233         struct mei_msg_hdr mei_hdr;
1234         size_t len;
1235         u32 msg_slots;
1236         int slots;
1237         int rets;
1238
1239         if (WARN_ON(!cl || !cl->dev))
1240                 return -ENODEV;
1241
1242         dev = cl->dev;
1243
1244         buf = &cb->buf;
1245
1246         rets = mei_cl_flow_ctrl_creds(cl);
1247         if (rets < 0)
1248                 return rets;
1249
1250         if (rets == 0) {
1251                 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1252                 return 0;
1253         }
1254
1255         slots = mei_hbuf_empty_slots(dev);
1256         len = buf->size - cb->buf_idx;
1257         msg_slots = mei_data2slots(len);
1258
1259         mei_hdr.host_addr = cl->host_client_id;
1260         mei_hdr.me_addr = mei_cl_me_id(cl);
1261         mei_hdr.reserved = 0;
1262         mei_hdr.internal = cb->internal;
1263
1264         if (slots >= msg_slots) {
1265                 mei_hdr.length = len;
1266                 mei_hdr.msg_complete = 1;
1267         /* Split the message only if we can write the whole host buffer */
1268         } else if (slots == dev->hbuf_depth) {
1269                 msg_slots = slots;
1270                 len = (slots * sizeof(u32)) - sizeof(struct mei_msg_hdr);
1271                 mei_hdr.length = len;
1272                 mei_hdr.msg_complete = 0;
1273         } else {
1274                 /* wait for next time the host buffer is empty */
1275                 return 0;
1276         }
1277
1278         cl_dbg(dev, cl, "buf: size = %d idx = %lu\n",
1279                         cb->buf.size, cb->buf_idx);
1280
1281         rets = mei_write_message(dev, &mei_hdr, buf->data + cb->buf_idx);
1282         if (rets) {
1283                 cl->status = rets;
1284                 list_move_tail(&cb->list, &cmpl_list->list);
1285                 return rets;
1286         }
1287
1288         cl->status = 0;
1289         cl->writing_state = MEI_WRITING;
1290         cb->buf_idx += mei_hdr.length;
1291         cb->completed = mei_hdr.msg_complete == 1;
1292
1293         if (mei_hdr.msg_complete) {
1294                 if (mei_cl_flow_ctrl_reduce(cl))
1295                         return -EIO;
1296                 list_move_tail(&cb->list, &dev->write_waiting_list.list);
1297         }
1298
1299         return 0;
1300 }
1301
1302 /**
1303  * mei_cl_write - submit a write cb to mei device
1304  *      assumes device_lock is locked
1305  *
1306  * @cl: host client
1307  * @cb: write callback with filled data
1308  * @blocking: block until completed
1309  *
1310  * Return: number of bytes sent on success, <0 on failure.
1311  */
1312 int mei_cl_write(struct mei_cl *cl, struct mei_cl_cb *cb, bool blocking)
1313 {
1314         struct mei_device *dev;
1315         struct mei_msg_data *buf;
1316         struct mei_msg_hdr mei_hdr;
1317         int rets;
1318
1319
1320         if (WARN_ON(!cl || !cl->dev))
1321                 return -ENODEV;
1322
1323         if (WARN_ON(!cb))
1324                 return -EINVAL;
1325
1326         dev = cl->dev;
1327
1328
1329         buf = &cb->buf;
1330
1331         cl_dbg(dev, cl, "size=%d\n", buf->size);
1332
1333         rets = pm_runtime_get(dev->dev);
1334         if (rets < 0 && rets != -EINPROGRESS) {
1335                 pm_runtime_put_noidle(dev->dev);
1336                 cl_err(dev, cl, "rpm: get failed %d\n", rets);
1337                 return rets;
1338         }
1339
1340         cb->buf_idx = 0;
1341         cl->writing_state = MEI_IDLE;
1342
1343         mei_hdr.host_addr = cl->host_client_id;
1344         mei_hdr.me_addr = mei_cl_me_id(cl);
1345         mei_hdr.reserved = 0;
1346         mei_hdr.msg_complete = 0;
1347         mei_hdr.internal = cb->internal;
1348
1349         rets = mei_cl_flow_ctrl_creds(cl);
1350         if (rets < 0)
1351                 goto err;
1352
1353         if (rets == 0) {
1354                 cl_dbg(dev, cl, "No flow control credentials: not sending.\n");
1355                 rets = buf->size;
1356                 goto out;
1357         }
1358         if (!mei_hbuf_acquire(dev)) {
1359                 cl_dbg(dev, cl, "Cannot acquire the host buffer: not sending.\n");
1360                 rets = buf->size;
1361                 goto out;
1362         }
1363
1364         /* Check for a maximum length */
1365         if (buf->size > mei_hbuf_max_len(dev)) {
1366                 mei_hdr.length = mei_hbuf_max_len(dev);
1367                 mei_hdr.msg_complete = 0;
1368         } else {
1369                 mei_hdr.length = buf->size;
1370                 mei_hdr.msg_complete = 1;
1371         }
1372
1373         rets = mei_write_message(dev, &mei_hdr, buf->data);
1374         if (rets)
1375                 goto err;
1376
1377         cl->writing_state = MEI_WRITING;
1378         cb->buf_idx = mei_hdr.length;
1379         cb->completed = mei_hdr.msg_complete == 1;
1380
1381 out:
1382         if (mei_hdr.msg_complete) {
1383                 rets = mei_cl_flow_ctrl_reduce(cl);
1384                 if (rets < 0)
1385                         goto err;
1386
1387                 list_add_tail(&cb->list, &dev->write_waiting_list.list);
1388         } else {
1389                 list_add_tail(&cb->list, &dev->write_list.list);
1390         }
1391
1392
1393         if (blocking && cl->writing_state != MEI_WRITE_COMPLETE) {
1394
1395                 mutex_unlock(&dev->device_lock);
1396                 rets = wait_event_interruptible(cl->tx_wait,
1397                                 cl->writing_state == MEI_WRITE_COMPLETE);
1398                 mutex_lock(&dev->device_lock);
1399                 /* wait_event_interruptible returns -ERESTARTSYS */
1400                 if (rets) {
1401                         if (signal_pending(current))
1402                                 rets = -EINTR;
1403                         goto err;
1404                 }
1405         }
1406
1407         rets = buf->size;
1408 err:
1409         cl_dbg(dev, cl, "rpm: autosuspend\n");
1410         pm_runtime_mark_last_busy(dev->dev);
1411         pm_runtime_put_autosuspend(dev->dev);
1412
1413         return rets;
1414 }
1415
1416
1417 /**
1418  * mei_cl_complete - processes completed operation for a client
1419  *
1420  * @cl: private data of the file object.
1421  * @cb: callback block.
1422  */
1423 void mei_cl_complete(struct mei_cl *cl, struct mei_cl_cb *cb)
1424 {
1425         switch (cb->fop_type) {
1426         case MEI_FOP_WRITE:
1427                 mei_io_cb_free(cb);
1428                 cl->writing_state = MEI_WRITE_COMPLETE;
1429                 if (waitqueue_active(&cl->tx_wait))
1430                         wake_up_interruptible(&cl->tx_wait);
1431                 break;
1432
1433         case MEI_FOP_READ:
1434                 list_add_tail(&cb->list, &cl->rd_completed);
1435                 if (waitqueue_active(&cl->rx_wait))
1436                         wake_up_interruptible_all(&cl->rx_wait);
1437                 else
1438                         mei_cl_bus_rx_event(cl);
1439                 break;
1440
1441         case MEI_FOP_CONNECT:
1442         case MEI_FOP_DISCONNECT:
1443                 if (waitqueue_active(&cl->wait))
1444                         wake_up(&cl->wait);
1445
1446                 break;
1447         default:
1448                 BUG_ON(0);
1449         }
1450 }
1451
1452
1453 /**
1454  * mei_cl_all_disconnect - disconnect forcefully all connected clients
1455  *
1456  * @dev: mei device
1457  */
1458 void mei_cl_all_disconnect(struct mei_device *dev)
1459 {
1460         struct mei_cl *cl;
1461
1462         list_for_each_entry(cl, &dev->file_list, link)
1463                 mei_cl_set_disconnected(cl);
1464 }
1465
1466
1467 /**
1468  * mei_cl_all_wakeup  - wake up all readers and writers they can be interrupted
1469  *
1470  * @dev: mei device
1471  */
1472 void mei_cl_all_wakeup(struct mei_device *dev)
1473 {
1474         struct mei_cl *cl;
1475
1476         list_for_each_entry(cl, &dev->file_list, link) {
1477                 if (waitqueue_active(&cl->rx_wait)) {
1478                         cl_dbg(dev, cl, "Waking up reading client!\n");
1479                         wake_up_interruptible(&cl->rx_wait);
1480                 }
1481                 if (waitqueue_active(&cl->tx_wait)) {
1482                         cl_dbg(dev, cl, "Waking up writing client!\n");
1483                         wake_up_interruptible(&cl->tx_wait);
1484                 }
1485         }
1486 }
1487
1488 /**
1489  * mei_cl_all_write_clear - clear all pending writes
1490  *
1491  * @dev: mei device
1492  */
1493 void mei_cl_all_write_clear(struct mei_device *dev)
1494 {
1495         mei_io_list_free(&dev->write_list, NULL);
1496         mei_io_list_free(&dev->write_waiting_list, NULL);
1497 }
1498
1499