mei: me: fix hw ready reset flow
[opensuse:kernel.git] / drivers / misc / mei / hw-me.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/pci.h>
18
19 #include <linux/kthread.h>
20 #include <linux/interrupt.h>
21
22 #include "mei_dev.h"
23 #include "hbm.h"
24
25 #include "hw-me.h"
26 #include "hw-me-regs.h"
27
28 /**
29  * mei_me_reg_read - Reads 32bit data from the mei device
30  *
31  * @dev: the device structure
32  * @offset: offset from which to read the data
33  *
34  * returns register value (u32)
35  */
36 static inline u32 mei_me_reg_read(const struct mei_me_hw *hw,
37                                unsigned long offset)
38 {
39         return ioread32(hw->mem_addr + offset);
40 }
41
42
43 /**
44  * mei_me_reg_write - Writes 32bit data to the mei device
45  *
46  * @dev: the device structure
47  * @offset: offset from which to write the data
48  * @value: register value to write (u32)
49  */
50 static inline void mei_me_reg_write(const struct mei_me_hw *hw,
51                                  unsigned long offset, u32 value)
52 {
53         iowrite32(value, hw->mem_addr + offset);
54 }
55
56 /**
57  * mei_me_mecbrw_read - Reads 32bit data from ME circular buffer
58  *  read window register
59  *
60  * @dev: the device structure
61  *
62  * returns ME_CB_RW register value (u32)
63  */
64 static u32 mei_me_mecbrw_read(const struct mei_device *dev)
65 {
66         return mei_me_reg_read(to_me_hw(dev), ME_CB_RW);
67 }
68 /**
69  * mei_me_mecsr_read - Reads 32bit data from the ME CSR
70  *
71  * @dev: the device structure
72  *
73  * returns ME_CSR_HA register value (u32)
74  */
75 static inline u32 mei_me_mecsr_read(const struct mei_me_hw *hw)
76 {
77         return mei_me_reg_read(hw, ME_CSR_HA);
78 }
79
80 /**
81  * mei_hcsr_read - Reads 32bit data from the host CSR
82  *
83  * @dev: the device structure
84  *
85  * returns H_CSR register value (u32)
86  */
87 static inline u32 mei_hcsr_read(const struct mei_me_hw *hw)
88 {
89         return mei_me_reg_read(hw, H_CSR);
90 }
91
92 /**
93  * mei_hcsr_set - writes H_CSR register to the mei device,
94  * and ignores the H_IS bit for it is write-one-to-zero.
95  *
96  * @dev: the device structure
97  */
98 static inline void mei_hcsr_set(struct mei_me_hw *hw, u32 hcsr)
99 {
100         hcsr &= ~H_IS;
101         mei_me_reg_write(hw, H_CSR, hcsr);
102 }
103
104
105 /**
106  * mei_me_hw_config - configure hw dependent settings
107  *
108  * @dev: mei device
109  */
110 static void mei_me_hw_config(struct mei_device *dev)
111 {
112         u32 hcsr = mei_hcsr_read(to_me_hw(dev));
113         /* Doesn't change in runtime */
114         dev->hbuf_depth = (hcsr & H_CBD) >> 24;
115 }
116 /**
117  * mei_clear_interrupts - clear and stop interrupts
118  *
119  * @dev: the device structure
120  */
121 static void mei_me_intr_clear(struct mei_device *dev)
122 {
123         struct mei_me_hw *hw = to_me_hw(dev);
124         u32 hcsr = mei_hcsr_read(hw);
125         if ((hcsr & H_IS) == H_IS)
126                 mei_me_reg_write(hw, H_CSR, hcsr);
127 }
128 /**
129  * mei_me_intr_enable - enables mei device interrupts
130  *
131  * @dev: the device structure
132  */
133 static void mei_me_intr_enable(struct mei_device *dev)
134 {
135         struct mei_me_hw *hw = to_me_hw(dev);
136         u32 hcsr = mei_hcsr_read(hw);
137         hcsr |= H_IE;
138         mei_hcsr_set(hw, hcsr);
139 }
140
141 /**
142  * mei_disable_interrupts - disables mei device interrupts
143  *
144  * @dev: the device structure
145  */
146 static void mei_me_intr_disable(struct mei_device *dev)
147 {
148         struct mei_me_hw *hw = to_me_hw(dev);
149         u32 hcsr = mei_hcsr_read(hw);
150         hcsr  &= ~H_IE;
151         mei_hcsr_set(hw, hcsr);
152 }
153
154 /**
155  * mei_me_hw_reset_release - release device from the reset
156  *
157  * @dev: the device structure
158  */
159 static void mei_me_hw_reset_release(struct mei_device *dev)
160 {
161         struct mei_me_hw *hw = to_me_hw(dev);
162         u32 hcsr = mei_hcsr_read(hw);
163
164         hcsr |= H_IG;
165         hcsr &= ~H_RST;
166         mei_hcsr_set(hw, hcsr);
167
168         /* complete this write before we set host ready on another CPU */
169         mmiowb();
170 }
171 /**
172  * mei_me_hw_reset - resets fw via mei csr register.
173  *
174  * @dev: the device structure
175  * @intr_enable: if interrupt should be enabled after reset.
176  */
177 static int mei_me_hw_reset(struct mei_device *dev, bool intr_enable)
178 {
179         struct mei_me_hw *hw = to_me_hw(dev);
180         u32 hcsr = mei_hcsr_read(hw);
181
182         hcsr |= H_RST | H_IG | H_IS;
183
184         if (intr_enable)
185                 hcsr |= H_IE;
186         else
187                 hcsr &= ~H_IE;
188
189         mei_me_reg_write(hw, H_CSR, hcsr);
190
191         if (intr_enable == false)
192                 mei_me_hw_reset_release(dev);
193
194         return 0;
195 }
196
197 /**
198  * mei_me_host_set_ready - enable device
199  *
200  * @dev - mei device
201  * returns bool
202  */
203
204 static void mei_me_host_set_ready(struct mei_device *dev)
205 {
206         struct mei_me_hw *hw = to_me_hw(dev);
207         hw->host_hw_state = mei_hcsr_read(hw);
208         hw->host_hw_state |= H_IE | H_IG | H_RDY;
209         mei_hcsr_set(hw, hw->host_hw_state);
210 }
211 /**
212  * mei_me_host_is_ready - check whether the host has turned ready
213  *
214  * @dev - mei device
215  * returns bool
216  */
217 static bool mei_me_host_is_ready(struct mei_device *dev)
218 {
219         struct mei_me_hw *hw = to_me_hw(dev);
220         hw->host_hw_state = mei_hcsr_read(hw);
221         return (hw->host_hw_state & H_RDY) == H_RDY;
222 }
223
224 /**
225  * mei_me_hw_is_ready - check whether the me(hw) has turned ready
226  *
227  * @dev - mei device
228  * returns bool
229  */
230 static bool mei_me_hw_is_ready(struct mei_device *dev)
231 {
232         struct mei_me_hw *hw = to_me_hw(dev);
233         hw->me_hw_state = mei_me_mecsr_read(hw);
234         return (hw->me_hw_state & ME_RDY_HRA) == ME_RDY_HRA;
235 }
236
237 static int mei_me_hw_ready_wait(struct mei_device *dev)
238 {
239         int err;
240         if (mei_me_hw_is_ready(dev))
241                 return 0;
242
243         dev->recvd_hw_ready = false;
244         mutex_unlock(&dev->device_lock);
245         err = wait_event_interruptible_timeout(dev->wait_hw_ready,
246                         dev->recvd_hw_ready,
247                         mei_secs_to_jiffies(MEI_HW_READY_TIMEOUT));
248         mutex_lock(&dev->device_lock);
249         if (!err && !dev->recvd_hw_ready) {
250                 if (!err)
251                         err = -ETIME;
252                 dev_err(&dev->pdev->dev,
253                         "wait hw ready failed. status = %d\n", err);
254                 return err;
255         }
256
257         dev->recvd_hw_ready = false;
258         return 0;
259 }
260
261 static int mei_me_hw_start(struct mei_device *dev)
262 {
263         int ret = mei_me_hw_ready_wait(dev);
264         if (ret)
265                 return ret;
266         dev_dbg(&dev->pdev->dev, "hw is ready\n");
267
268         mei_me_host_set_ready(dev);
269         return ret;
270 }
271
272
273 /**
274  * mei_hbuf_filled_slots - gets number of device filled buffer slots
275  *
276  * @dev: the device structure
277  *
278  * returns number of filled slots
279  */
280 static unsigned char mei_hbuf_filled_slots(struct mei_device *dev)
281 {
282         struct mei_me_hw *hw = to_me_hw(dev);
283         char read_ptr, write_ptr;
284
285         hw->host_hw_state = mei_hcsr_read(hw);
286
287         read_ptr = (char) ((hw->host_hw_state & H_CBRP) >> 8);
288         write_ptr = (char) ((hw->host_hw_state & H_CBWP) >> 16);
289
290         return (unsigned char) (write_ptr - read_ptr);
291 }
292
293 /**
294  * mei_me_hbuf_is_empty - checks if host buffer is empty.
295  *
296  * @dev: the device structure
297  *
298  * returns true if empty, false - otherwise.
299  */
300 static bool mei_me_hbuf_is_empty(struct mei_device *dev)
301 {
302         return mei_hbuf_filled_slots(dev) == 0;
303 }
304
305 /**
306  * mei_me_hbuf_empty_slots - counts write empty slots.
307  *
308  * @dev: the device structure
309  *
310  * returns -EOVERFLOW if overflow, otherwise empty slots count
311  */
312 static int mei_me_hbuf_empty_slots(struct mei_device *dev)
313 {
314         unsigned char filled_slots, empty_slots;
315
316         filled_slots = mei_hbuf_filled_slots(dev);
317         empty_slots = dev->hbuf_depth - filled_slots;
318
319         /* check for overflow */
320         if (filled_slots > dev->hbuf_depth)
321                 return -EOVERFLOW;
322
323         return empty_slots;
324 }
325
326 static size_t mei_me_hbuf_max_len(const struct mei_device *dev)
327 {
328         return dev->hbuf_depth * sizeof(u32) - sizeof(struct mei_msg_hdr);
329 }
330
331
332 /**
333  * mei_me_write_message - writes a message to mei device.
334  *
335  * @dev: the device structure
336  * @header: mei HECI header of message
337  * @buf: message payload will be written
338  *
339  * This function returns -EIO if write has failed
340  */
341 static int mei_me_write_message(struct mei_device *dev,
342                         struct mei_msg_hdr *header,
343                         unsigned char *buf)
344 {
345         struct mei_me_hw *hw = to_me_hw(dev);
346         unsigned long rem;
347         unsigned long length = header->length;
348         u32 *reg_buf = (u32 *)buf;
349         u32 hcsr;
350         u32 dw_cnt;
351         int i;
352         int empty_slots;
353
354         dev_dbg(&dev->pdev->dev, MEI_HDR_FMT, MEI_HDR_PRM(header));
355
356         empty_slots = mei_hbuf_empty_slots(dev);
357         dev_dbg(&dev->pdev->dev, "empty slots = %hu.\n", empty_slots);
358
359         dw_cnt = mei_data2slots(length);
360         if (empty_slots < 0 || dw_cnt > empty_slots)
361                 return -EMSGSIZE;
362
363         mei_me_reg_write(hw, H_CB_WW, *((u32 *) header));
364
365         for (i = 0; i < length / 4; i++)
366                 mei_me_reg_write(hw, H_CB_WW, reg_buf[i]);
367
368         rem = length & 0x3;
369         if (rem > 0) {
370                 u32 reg = 0;
371                 memcpy(&reg, &buf[length - rem], rem);
372                 mei_me_reg_write(hw, H_CB_WW, reg);
373         }
374
375         hcsr = mei_hcsr_read(hw) | H_IG;
376         mei_hcsr_set(hw, hcsr);
377         if (!mei_me_hw_is_ready(dev))
378                 return -EIO;
379
380         return 0;
381 }
382
383 /**
384  * mei_me_count_full_read_slots - counts read full slots.
385  *
386  * @dev: the device structure
387  *
388  * returns -EOVERFLOW if overflow, otherwise filled slots count
389  */
390 static int mei_me_count_full_read_slots(struct mei_device *dev)
391 {
392         struct mei_me_hw *hw = to_me_hw(dev);
393         char read_ptr, write_ptr;
394         unsigned char buffer_depth, filled_slots;
395
396         hw->me_hw_state = mei_me_mecsr_read(hw);
397         buffer_depth = (unsigned char)((hw->me_hw_state & ME_CBD_HRA) >> 24);
398         read_ptr = (char) ((hw->me_hw_state & ME_CBRP_HRA) >> 8);
399         write_ptr = (char) ((hw->me_hw_state & ME_CBWP_HRA) >> 16);
400         filled_slots = (unsigned char) (write_ptr - read_ptr);
401
402         /* check for overflow */
403         if (filled_slots > buffer_depth)
404                 return -EOVERFLOW;
405
406         dev_dbg(&dev->pdev->dev, "filled_slots =%08x\n", filled_slots);
407         return (int)filled_slots;
408 }
409
410 /**
411  * mei_me_read_slots - reads a message from mei device.
412  *
413  * @dev: the device structure
414  * @buffer: message buffer will be written
415  * @buffer_length: message size will be read
416  */
417 static int mei_me_read_slots(struct mei_device *dev, unsigned char *buffer,
418                     unsigned long buffer_length)
419 {
420         struct mei_me_hw *hw = to_me_hw(dev);
421         u32 *reg_buf = (u32 *)buffer;
422         u32 hcsr;
423
424         for (; buffer_length >= sizeof(u32); buffer_length -= sizeof(u32))
425                 *reg_buf++ = mei_me_mecbrw_read(dev);
426
427         if (buffer_length > 0) {
428                 u32 reg = mei_me_mecbrw_read(dev);
429                 memcpy(reg_buf, &reg, buffer_length);
430         }
431
432         hcsr = mei_hcsr_read(hw) | H_IG;
433         mei_hcsr_set(hw, hcsr);
434         return 0;
435 }
436
437 /**
438  * mei_me_irq_quick_handler - The ISR of the MEI device
439  *
440  * @irq: The irq number
441  * @dev_id: pointer to the device structure
442  *
443  * returns irqreturn_t
444  */
445
446 irqreturn_t mei_me_irq_quick_handler(int irq, void *dev_id)
447 {
448         struct mei_device *dev = (struct mei_device *) dev_id;
449         struct mei_me_hw *hw = to_me_hw(dev);
450         u32 csr_reg = mei_hcsr_read(hw);
451
452         if ((csr_reg & H_IS) != H_IS)
453                 return IRQ_NONE;
454
455         /* clear H_IS bit in H_CSR */
456         mei_me_reg_write(hw, H_CSR, csr_reg);
457
458         return IRQ_WAKE_THREAD;
459 }
460
461 /**
462  * mei_me_irq_thread_handler - function called after ISR to handle the interrupt
463  * processing.
464  *
465  * @irq: The irq number
466  * @dev_id: pointer to the device structure
467  *
468  * returns irqreturn_t
469  *
470  */
471 irqreturn_t mei_me_irq_thread_handler(int irq, void *dev_id)
472 {
473         struct mei_device *dev = (struct mei_device *) dev_id;
474         struct mei_cl_cb complete_list;
475         s32 slots;
476         int rets = 0;
477
478         dev_dbg(&dev->pdev->dev, "function called after ISR to handle the interrupt processing.\n");
479         /* initialize our complete list */
480         mutex_lock(&dev->device_lock);
481         mei_io_list_init(&complete_list);
482
483         /* Ack the interrupt here
484          * In case of MSI we don't go through the quick handler */
485         if (pci_dev_msi_enabled(dev->pdev))
486                 mei_clear_interrupts(dev);
487
488         /* check if ME wants a reset */
489         if (!mei_hw_is_ready(dev) && dev->dev_state != MEI_DEV_RESETTING) {
490                 dev_warn(&dev->pdev->dev, "FW not ready: resetting.\n");
491                 schedule_work(&dev->reset_work);
492                 goto end;
493         }
494
495         /*  check if we need to start the dev */
496         if (!mei_host_is_ready(dev)) {
497                 if (mei_hw_is_ready(dev)) {
498                         mei_me_hw_reset_release(dev);
499                         dev_dbg(&dev->pdev->dev, "we need to start the dev.\n");
500
501                         dev->recvd_hw_ready = true;
502                         wake_up_interruptible(&dev->wait_hw_ready);
503                 } else {
504                         dev_dbg(&dev->pdev->dev, "Spurious Interrupt\n");
505                 }
506                 goto end;
507         }
508         /* check slots available for reading */
509         slots = mei_count_full_read_slots(dev);
510         while (slots > 0) {
511                 dev_dbg(&dev->pdev->dev, "slots to read = %08x\n", slots);
512                 rets = mei_irq_read_handler(dev, &complete_list, &slots);
513                 /* There is a race between ME write and interrupt delivery:
514                  * Not all data is always available immediately after the
515                  * interrupt, so try to read again on the next interrupt.
516                  */
517                 if (rets == -ENODATA)
518                         break;
519
520                 if (rets && dev->dev_state != MEI_DEV_RESETTING) {
521                         dev_err(&dev->pdev->dev, "mei_irq_read_handler ret = %d.\n",
522                                                 rets);
523                         schedule_work(&dev->reset_work);
524                         goto end;
525                 }
526         }
527
528         dev->hbuf_is_ready = mei_hbuf_is_ready(dev);
529
530         rets = mei_irq_write_handler(dev, &complete_list);
531
532         dev->hbuf_is_ready = mei_hbuf_is_ready(dev);
533
534         mei_irq_compl_handler(dev, &complete_list);
535
536 end:
537         dev_dbg(&dev->pdev->dev, "interrupt thread end ret = %d\n", rets);
538         mutex_unlock(&dev->device_lock);
539         return IRQ_HANDLED;
540 }
541 static const struct mei_hw_ops mei_me_hw_ops = {
542
543         .host_is_ready = mei_me_host_is_ready,
544
545         .hw_is_ready = mei_me_hw_is_ready,
546         .hw_reset = mei_me_hw_reset,
547         .hw_config = mei_me_hw_config,
548         .hw_start = mei_me_hw_start,
549
550         .intr_clear = mei_me_intr_clear,
551         .intr_enable = mei_me_intr_enable,
552         .intr_disable = mei_me_intr_disable,
553
554         .hbuf_free_slots = mei_me_hbuf_empty_slots,
555         .hbuf_is_ready = mei_me_hbuf_is_empty,
556         .hbuf_max_len = mei_me_hbuf_max_len,
557
558         .write = mei_me_write_message,
559
560         .rdbuf_full_slots = mei_me_count_full_read_slots,
561         .read_hdr = mei_me_mecbrw_read,
562         .read = mei_me_read_slots
563 };
564
565 /**
566  * mei_me_dev_init - allocates and initializes the mei device structure
567  *
568  * @pdev: The pci device structure
569  *
570  * returns The mei_device_device pointer on success, NULL on failure.
571  */
572 struct mei_device *mei_me_dev_init(struct pci_dev *pdev)
573 {
574         struct mei_device *dev;
575
576         dev = kzalloc(sizeof(struct mei_device) +
577                          sizeof(struct mei_me_hw), GFP_KERNEL);
578         if (!dev)
579                 return NULL;
580
581         mei_device_init(dev);
582
583         dev->ops = &mei_me_hw_ops;
584
585         dev->pdev = pdev;
586         return dev;
587 }
588