3 * Intel Management Engine Interface (Intel MEI) Linux driver
4 * Copyright (c) 2003-2012, Intel Corporation.
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.
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
17 #include <linux/pci.h>
19 #include <linux/kthread.h>
20 #include <linux/interrupt.h>
29 * mei_reg_read - Reads 32bit data from the mei device
31 * @dev: the device structure
32 * @offset: offset from which to read the data
34 * returns register value (u32)
36 static inline u32 mei_reg_read(const struct mei_me_hw *hw,
39 return ioread32(hw->mem_addr + offset);
44 * mei_reg_write - Writes 32bit data to the mei device
46 * @dev: the device structure
47 * @offset: offset from which to write the data
48 * @value: register value to write (u32)
50 static inline void mei_reg_write(const struct mei_me_hw *hw,
51 unsigned long offset, u32 value)
53 iowrite32(value, hw->mem_addr + offset);
57 * mei_mecbrw_read - Reads 32bit data from ME circular buffer
58 * read window register
60 * @dev: the device structure
62 * returns ME_CB_RW register value (u32)
64 static u32 mei_me_mecbrw_read(const struct mei_device *dev)
66 return mei_reg_read(to_me_hw(dev), ME_CB_RW);
69 * mei_mecsr_read - Reads 32bit data from the ME CSR
71 * @dev: the device structure
73 * returns ME_CSR_HA register value (u32)
75 static inline u32 mei_mecsr_read(const struct mei_me_hw *hw)
77 return mei_reg_read(hw, ME_CSR_HA);
81 * mei_hcsr_read - Reads 32bit data from the host CSR
83 * @dev: the device structure
85 * returns H_CSR register value (u32)
87 static inline u32 mei_hcsr_read(const struct mei_me_hw *hw)
89 return mei_reg_read(hw, H_CSR);
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.
96 * @dev: the device structure
98 static inline void mei_hcsr_set(struct mei_me_hw *hw, u32 hcsr)
101 mei_reg_write(hw, H_CSR, hcsr);
106 * me_hw_config - configure hw dependent settings
110 static void mei_me_hw_config(struct mei_device *dev)
112 u32 hcsr = mei_hcsr_read(to_me_hw(dev));
113 /* Doesn't change in runtime */
114 dev->hbuf_depth = (hcsr & H_CBD) >> 24;
117 * mei_clear_interrupts - clear and stop interrupts
119 * @dev: the device structure
121 static void mei_me_intr_clear(struct mei_device *dev)
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_reg_write(hw, H_CSR, hcsr);
129 * mei_me_intr_enable - enables mei device interrupts
131 * @dev: the device structure
133 static void mei_me_intr_enable(struct mei_device *dev)
135 struct mei_me_hw *hw = to_me_hw(dev);
136 u32 hcsr = mei_hcsr_read(hw);
138 mei_hcsr_set(hw, hcsr);
142 * mei_disable_interrupts - disables mei device interrupts
144 * @dev: the device structure
146 static void mei_me_intr_disable(struct mei_device *dev)
148 struct mei_me_hw *hw = to_me_hw(dev);
149 u32 hcsr = mei_hcsr_read(hw);
151 mei_hcsr_set(hw, hcsr);
155 * mei_me_hw_reset - resets fw via mei csr register.
157 * @dev: the device structure
158 * @interrupts_enabled: if interrupt should be enabled after reset.
160 static void mei_me_hw_reset(struct mei_device *dev, bool intr_enable)
162 struct mei_me_hw *hw = to_me_hw(dev);
163 u32 hcsr = mei_hcsr_read(hw);
165 dev_dbg(&dev->pdev->dev, "before reset HCSR = 0x%08x.\n", hcsr);
167 hcsr |= (H_RST | H_IG);
174 mei_hcsr_set(hw, hcsr);
176 hcsr = mei_hcsr_read(hw) | H_IG;
179 mei_hcsr_set(hw, hcsr);
181 hcsr = mei_hcsr_read(hw);
183 dev_dbg(&dev->pdev->dev, "current HCSR = 0x%08x.\n", hcsr);
187 * mei_me_host_set_ready - enable device
193 static void mei_me_host_set_ready(struct mei_device *dev)
195 struct mei_me_hw *hw = to_me_hw(dev);
196 hw->host_hw_state |= H_IE | H_IG | H_RDY;
197 mei_hcsr_set(hw, hw->host_hw_state);
200 * mei_me_host_is_ready - check whether the host has turned ready
205 static bool mei_me_host_is_ready(struct mei_device *dev)
207 struct mei_me_hw *hw = to_me_hw(dev);
208 hw->host_hw_state = mei_hcsr_read(hw);
209 return (hw->host_hw_state & H_RDY) == H_RDY;
213 * mei_me_hw_is_ready - check whether the me(hw) has turned ready
218 static bool mei_me_hw_is_ready(struct mei_device *dev)
220 struct mei_me_hw *hw = to_me_hw(dev);
221 hw->me_hw_state = mei_mecsr_read(hw);
222 return (hw->me_hw_state & ME_RDY_HRA) == ME_RDY_HRA;
226 * mei_hbuf_filled_slots - gets number of device filled buffer slots
228 * @dev: the device structure
230 * returns number of filled slots
232 static unsigned char mei_hbuf_filled_slots(struct mei_device *dev)
234 struct mei_me_hw *hw = to_me_hw(dev);
235 char read_ptr, write_ptr;
237 hw->host_hw_state = mei_hcsr_read(hw);
239 read_ptr = (char) ((hw->host_hw_state & H_CBRP) >> 8);
240 write_ptr = (char) ((hw->host_hw_state & H_CBWP) >> 16);
242 return (unsigned char) (write_ptr - read_ptr);
246 * mei_hbuf_is_empty - checks if host buffer is empty.
248 * @dev: the device structure
250 * returns true if empty, false - otherwise.
252 static bool mei_me_hbuf_is_empty(struct mei_device *dev)
254 return mei_hbuf_filled_slots(dev) == 0;
258 * mei_me_hbuf_empty_slots - counts write empty slots.
260 * @dev: the device structure
262 * returns -1(ESLOTS_OVERFLOW) if overflow, otherwise empty slots count
264 static int mei_me_hbuf_empty_slots(struct mei_device *dev)
266 unsigned char filled_slots, empty_slots;
268 filled_slots = mei_hbuf_filled_slots(dev);
269 empty_slots = dev->hbuf_depth - filled_slots;
271 /* check for overflow */
272 if (filled_slots > dev->hbuf_depth)
278 static size_t mei_me_hbuf_max_len(const struct mei_device *dev)
280 return dev->hbuf_depth * sizeof(u32) - sizeof(struct mei_msg_hdr);
285 * mei_write_message - writes a message to mei device.
287 * @dev: the device structure
288 * @header: mei HECI header of message
289 * @buf: message payload will be written
291 * This function returns -EIO if write has failed
293 static int mei_me_write_message(struct mei_device *dev,
294 struct mei_msg_hdr *header,
297 struct mei_me_hw *hw = to_me_hw(dev);
298 unsigned long rem, dw_cnt;
299 unsigned long length = header->length;
300 u32 *reg_buf = (u32 *)buf;
305 dev_dbg(&dev->pdev->dev, MEI_HDR_FMT, MEI_HDR_PRM(header));
307 empty_slots = mei_hbuf_empty_slots(dev);
308 dev_dbg(&dev->pdev->dev, "empty slots = %hu.\n", empty_slots);
310 dw_cnt = mei_data2slots(length);
311 if (empty_slots < 0 || dw_cnt > empty_slots)
314 mei_reg_write(hw, H_CB_WW, *((u32 *) header));
316 for (i = 0; i < length / 4; i++)
317 mei_reg_write(hw, H_CB_WW, reg_buf[i]);
322 memcpy(®, &buf[length - rem], rem);
323 mei_reg_write(hw, H_CB_WW, reg);
326 hcsr = mei_hcsr_read(hw) | H_IG;
327 mei_hcsr_set(hw, hcsr);
328 if (!mei_me_hw_is_ready(dev))
335 * mei_me_count_full_read_slots - counts read full slots.
337 * @dev: the device structure
339 * returns -1(ESLOTS_OVERFLOW) if overflow, otherwise filled slots count
341 static int mei_me_count_full_read_slots(struct mei_device *dev)
343 struct mei_me_hw *hw = to_me_hw(dev);
344 char read_ptr, write_ptr;
345 unsigned char buffer_depth, filled_slots;
347 hw->me_hw_state = mei_mecsr_read(hw);
348 buffer_depth = (unsigned char)((hw->me_hw_state & ME_CBD_HRA) >> 24);
349 read_ptr = (char) ((hw->me_hw_state & ME_CBRP_HRA) >> 8);
350 write_ptr = (char) ((hw->me_hw_state & ME_CBWP_HRA) >> 16);
351 filled_slots = (unsigned char) (write_ptr - read_ptr);
353 /* check for overflow */
354 if (filled_slots > buffer_depth)
357 dev_dbg(&dev->pdev->dev, "filled_slots =%08x\n", filled_slots);
358 return (int)filled_slots;
362 * mei_me_read_slots - reads a message from mei device.
364 * @dev: the device structure
365 * @buffer: message buffer will be written
366 * @buffer_length: message size will be read
368 static int mei_me_read_slots(struct mei_device *dev, unsigned char *buffer,
369 unsigned long buffer_length)
371 struct mei_me_hw *hw = to_me_hw(dev);
372 u32 *reg_buf = (u32 *)buffer;
375 for (; buffer_length >= sizeof(u32); buffer_length -= sizeof(u32))
376 *reg_buf++ = mei_me_mecbrw_read(dev);
378 if (buffer_length > 0) {
379 u32 reg = mei_me_mecbrw_read(dev);
380 memcpy(reg_buf, ®, buffer_length);
383 hcsr = mei_hcsr_read(hw) | H_IG;
384 mei_hcsr_set(hw, hcsr);
389 * mei_me_irq_quick_handler - The ISR of the MEI device
391 * @irq: The irq number
392 * @dev_id: pointer to the device structure
394 * returns irqreturn_t
397 irqreturn_t mei_me_irq_quick_handler(int irq, void *dev_id)
399 struct mei_device *dev = (struct mei_device *) dev_id;
400 struct mei_me_hw *hw = to_me_hw(dev);
401 u32 csr_reg = mei_hcsr_read(hw);
403 if ((csr_reg & H_IS) != H_IS)
406 /* clear H_IS bit in H_CSR */
407 mei_reg_write(hw, H_CSR, csr_reg);
409 return IRQ_WAKE_THREAD;
413 * mei_me_irq_thread_handler - function called after ISR to handle the interrupt
416 * @irq: The irq number
417 * @dev_id: pointer to the device structure
419 * returns irqreturn_t
422 irqreturn_t mei_me_irq_thread_handler(int irq, void *dev_id)
424 struct mei_device *dev = (struct mei_device *) dev_id;
425 struct mei_cl_cb complete_list;
426 struct mei_cl_cb *cb_pos = NULL, *cb_next = NULL;
430 bool bus_message_received;
433 dev_dbg(&dev->pdev->dev, "function called after ISR to handle the interrupt processing.\n");
434 /* initialize our complete list */
435 mutex_lock(&dev->device_lock);
436 mei_io_list_init(&complete_list);
438 /* Ack the interrupt here
439 * In case of MSI we don't go through the quick handler */
440 if (pci_dev_msi_enabled(dev->pdev))
441 mei_clear_interrupts(dev);
443 /* check if ME wants a reset */
444 if (!mei_hw_is_ready(dev) &&
445 dev->dev_state != MEI_DEV_RESETING &&
446 dev->dev_state != MEI_DEV_INITIALIZING) {
447 dev_dbg(&dev->pdev->dev, "FW not ready.\n");
449 mutex_unlock(&dev->device_lock);
453 /* check if we need to start the dev */
454 if (!mei_host_is_ready(dev)) {
455 if (mei_hw_is_ready(dev)) {
456 dev_dbg(&dev->pdev->dev, "we need to start the dev.\n");
458 mei_host_set_ready(dev);
460 dev_dbg(&dev->pdev->dev, "link is established start sending messages.\n");
461 /* link is established * start sending messages. */
463 dev->dev_state = MEI_DEV_INIT_CLIENTS;
465 mei_hbm_start_req(dev);
466 mutex_unlock(&dev->device_lock);
469 dev_dbg(&dev->pdev->dev, "FW not ready.\n");
470 mutex_unlock(&dev->device_lock);
474 /* check slots available for reading */
475 slots = mei_count_full_read_slots(dev);
477 /* we have urgent data to send so break the read */
478 if (dev->wr_ext_msg.hdr.length)
480 dev_dbg(&dev->pdev->dev, "slots =%08x\n", slots);
481 dev_dbg(&dev->pdev->dev, "call mei_irq_read_handler.\n");
482 rets = mei_irq_read_handler(dev, &complete_list, &slots);
486 rets = mei_irq_write_handler(dev, &complete_list);
488 dev_dbg(&dev->pdev->dev, "end of bottom half function.\n");
489 dev->hbuf_is_ready = mei_hbuf_is_ready(dev);
491 bus_message_received = false;
492 if (dev->recvd_msg && waitqueue_active(&dev->wait_recvd_msg)) {
493 dev_dbg(&dev->pdev->dev, "received waiting bus message\n");
494 bus_message_received = true;
496 mutex_unlock(&dev->device_lock);
497 if (bus_message_received) {
498 dev_dbg(&dev->pdev->dev, "wake up dev->wait_recvd_msg\n");
499 wake_up_interruptible(&dev->wait_recvd_msg);
500 bus_message_received = false;
502 if (list_empty(&complete_list.list))
506 list_for_each_entry_safe(cb_pos, cb_next, &complete_list.list, list) {
508 list_del(&cb_pos->list);
510 if (cl != &dev->iamthif_cl) {
511 dev_dbg(&dev->pdev->dev, "completing call back.\n");
512 mei_irq_complete_handler(cl, cb_pos);
514 } else if (cl == &dev->iamthif_cl) {
515 mei_amthif_complete(dev, cb_pos);
521 static const struct mei_hw_ops mei_me_hw_ops = {
523 .host_set_ready = mei_me_host_set_ready,
524 .host_is_ready = mei_me_host_is_ready,
526 .hw_is_ready = mei_me_hw_is_ready,
527 .hw_reset = mei_me_hw_reset,
528 .hw_config = mei_me_hw_config,
530 .intr_clear = mei_me_intr_clear,
531 .intr_enable = mei_me_intr_enable,
532 .intr_disable = mei_me_intr_disable,
534 .hbuf_free_slots = mei_me_hbuf_empty_slots,
535 .hbuf_is_ready = mei_me_hbuf_is_empty,
536 .hbuf_max_len = mei_me_hbuf_max_len,
538 .write = mei_me_write_message,
540 .rdbuf_full_slots = mei_me_count_full_read_slots,
541 .read_hdr = mei_me_mecbrw_read,
542 .read = mei_me_read_slots
546 * init_mei_device - allocates and initializes the mei device structure
548 * @pdev: The pci device structure
550 * returns The mei_device_device pointer on success, NULL on failure.
552 struct mei_device *mei_me_dev_init(struct pci_dev *pdev)
554 struct mei_device *dev;
556 dev = kzalloc(sizeof(struct mei_device) +
557 sizeof(struct mei_me_hw), GFP_KERNEL);
561 mei_device_init(dev);
563 INIT_LIST_HEAD(&dev->wd_cl.link);
564 INIT_LIST_HEAD(&dev->iamthif_cl.link);
565 mei_io_list_init(&dev->amthif_cmd_list);
566 mei_io_list_init(&dev->amthif_rd_complete_list);
568 INIT_DELAYED_WORK(&dev->timer_work, mei_timer);
569 INIT_WORK(&dev->init_work, mei_host_client_init);
571 dev->ops = &mei_me_hw_ops;