3 * Intel Management Engine Interface (Intel MEI) Linux driver
4 * Copyright (c) 2013-2014, 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>
18 #include <linux/jiffies.h>
19 #include <linux/delay.h>
20 #include <linux/kthread.h>
21 #include <linux/irqreturn.h>
23 #include <linux/mei.h>
31 * mei_txe_reg_read - Reads 32bit data from the device
33 * @base_addr: registers base address
34 * @offset: register offset
37 static inline u32 mei_txe_reg_read(void __iomem *base_addr,
40 return ioread32(base_addr + offset);
44 * mei_txe_reg_write - Writes 32bit data to the device
46 * @base_addr: registers base address
47 * @offset: register offset
48 * @value: the value to write
50 static inline void mei_txe_reg_write(void __iomem *base_addr,
51 unsigned long offset, u32 value)
53 iowrite32(value, base_addr + offset);
57 * mei_txe_sec_reg_read_silent - Reads 32bit data from the SeC BAR
59 * @dev: the device structure
60 * @offset: register offset
62 * Doesn't check for aliveness while Reads 32bit data from the SeC BAR
64 static inline u32 mei_txe_sec_reg_read_silent(struct mei_txe_hw *hw,
67 return mei_txe_reg_read(hw->mem_addr[SEC_BAR], offset);
71 * mei_txe_sec_reg_read - Reads 32bit data from the SeC BAR
73 * @dev: the device structure
74 * @offset: register offset
76 * Reads 32bit data from the SeC BAR and shout loud if aliveness is not set
78 static inline u32 mei_txe_sec_reg_read(struct mei_txe_hw *hw,
81 WARN(!hw->aliveness, "sec read: aliveness not asserted\n");
82 return mei_txe_sec_reg_read_silent(hw, offset);
85 * mei_txe_sec_reg_write_silent - Writes 32bit data to the SeC BAR
86 * doesn't check for aliveness
88 * @dev: the device structure
89 * @offset: register offset
90 * @value: value to write
92 * Doesn't check for aliveness while writes 32bit data from to the SeC BAR
94 static inline void mei_txe_sec_reg_write_silent(struct mei_txe_hw *hw,
95 unsigned long offset, u32 value)
97 mei_txe_reg_write(hw->mem_addr[SEC_BAR], offset, value);
101 * mei_txe_sec_reg_write - Writes 32bit data to the SeC BAR
103 * @dev: the device structure
104 * @offset: register offset
105 * @value: value to write
107 * Writes 32bit data from the SeC BAR and shout loud if aliveness is not set
109 static inline void mei_txe_sec_reg_write(struct mei_txe_hw *hw,
110 unsigned long offset, u32 value)
112 WARN(!hw->aliveness, "sec write: aliveness not asserted\n");
113 mei_txe_sec_reg_write_silent(hw, offset, value);
116 * mei_txe_br_reg_read - Reads 32bit data from the Bridge BAR
118 * @hw: the device structure
119 * @offset: offset from which to read the data
122 static inline u32 mei_txe_br_reg_read(struct mei_txe_hw *hw,
123 unsigned long offset)
125 return mei_txe_reg_read(hw->mem_addr[BRIDGE_BAR], offset);
129 * mei_txe_br_reg_write - Writes 32bit data to the Bridge BAR
131 * @hw: the device structure
132 * @offset: offset from which to write the data
133 * @value: the byte to write
135 static inline void mei_txe_br_reg_write(struct mei_txe_hw *hw,
136 unsigned long offset, u32 value)
138 mei_txe_reg_write(hw->mem_addr[BRIDGE_BAR], offset, value);
142 * mei_txe_aliveness_set - request for aliveness change
144 * @dev: the device structure
145 * @req: requested aliveness value
147 * Request for aliveness change and returns true if the change is
148 * really needed and false if aliveness is already
149 * in the requested state
150 * Requires device lock to be held
152 static bool mei_txe_aliveness_set(struct mei_device *dev, u32 req)
155 struct mei_txe_hw *hw = to_txe_hw(dev);
156 bool do_req = hw->aliveness != req;
158 dev_dbg(dev->dev, "Aliveness current=%d request=%d\n",
161 dev->pg_event = MEI_PG_EVENT_WAIT;
162 mei_txe_br_reg_write(hw, SICR_HOST_ALIVENESS_REQ_REG, req);
169 * mei_txe_aliveness_req_get - get aliveness requested register value
171 * @dev: the device structure
173 * Extract HICR_HOST_ALIVENESS_RESP_ACK bit from
174 * from HICR_HOST_ALIVENESS_REQ register value
176 static u32 mei_txe_aliveness_req_get(struct mei_device *dev)
178 struct mei_txe_hw *hw = to_txe_hw(dev);
181 reg = mei_txe_br_reg_read(hw, SICR_HOST_ALIVENESS_REQ_REG);
182 return reg & SICR_HOST_ALIVENESS_REQ_REQUESTED;
186 * mei_txe_aliveness_get - get aliveness response register value
187 * @dev: the device structure
189 * Extract HICR_HOST_ALIVENESS_RESP_ACK bit
190 * from HICR_HOST_ALIVENESS_RESP register value
192 static u32 mei_txe_aliveness_get(struct mei_device *dev)
194 struct mei_txe_hw *hw = to_txe_hw(dev);
197 reg = mei_txe_br_reg_read(hw, HICR_HOST_ALIVENESS_RESP_REG);
198 return reg & HICR_HOST_ALIVENESS_RESP_ACK;
202 * mei_txe_aliveness_poll - waits for aliveness to settle
204 * @dev: the device structure
205 * @expected: expected aliveness value
207 * Polls for HICR_HOST_ALIVENESS_RESP.ALIVENESS_RESP to be set
208 * returns > 0 if the expected value was received, -ETIME otherwise
210 static int mei_txe_aliveness_poll(struct mei_device *dev, u32 expected)
212 struct mei_txe_hw *hw = to_txe_hw(dev);
216 hw->aliveness = mei_txe_aliveness_get(dev);
217 if (hw->aliveness == expected) {
218 dev->pg_event = MEI_PG_EVENT_IDLE;
220 "aliveness settled after %d msecs\n", t);
223 mutex_unlock(&dev->device_lock);
224 msleep(MSEC_PER_SEC / 5);
225 mutex_lock(&dev->device_lock);
226 t += MSEC_PER_SEC / 5;
227 } while (t < SEC_ALIVENESS_WAIT_TIMEOUT);
229 dev->pg_event = MEI_PG_EVENT_IDLE;
230 dev_err(dev->dev, "aliveness timed out\n");
235 * mei_txe_aliveness_wait - waits for aliveness to settle
237 * @dev: the device structure
238 * @expected: expected aliveness value
240 * Waits for HICR_HOST_ALIVENESS_RESP.ALIVENESS_RESP to be set
241 * returns returns 0 on success and < 0 otherwise
243 static int mei_txe_aliveness_wait(struct mei_device *dev, u32 expected)
245 struct mei_txe_hw *hw = to_txe_hw(dev);
246 const unsigned long timeout =
247 msecs_to_jiffies(SEC_ALIVENESS_WAIT_TIMEOUT);
251 hw->aliveness = mei_txe_aliveness_get(dev);
252 if (hw->aliveness == expected)
255 mutex_unlock(&dev->device_lock);
256 err = wait_event_timeout(hw->wait_aliveness_resp,
257 dev->pg_event == MEI_PG_EVENT_RECEIVED, timeout);
258 mutex_lock(&dev->device_lock);
260 hw->aliveness = mei_txe_aliveness_get(dev);
261 ret = hw->aliveness == expected ? 0 : -ETIME;
264 dev_warn(dev->dev, "aliveness timed out = %ld aliveness = %d event = %d\n",
265 err, hw->aliveness, dev->pg_event);
267 dev_dbg(dev->dev, "aliveness settled after = %d msec aliveness = %d event = %d\n",
268 jiffies_to_msecs(timeout - err),
269 hw->aliveness, dev->pg_event);
271 dev->pg_event = MEI_PG_EVENT_IDLE;
276 * mei_txe_aliveness_set_sync - sets an wait for aliveness to complete
278 * @dev: the device structure
280 * returns returns 0 on success and < 0 otherwise
282 int mei_txe_aliveness_set_sync(struct mei_device *dev, u32 req)
284 if (mei_txe_aliveness_set(dev, req))
285 return mei_txe_aliveness_wait(dev, req);
290 * mei_txe_pg_is_enabled - detect if PG is supported by HW
292 * @dev: the device structure
294 * returns: true is pg supported, false otherwise
296 static bool mei_txe_pg_is_enabled(struct mei_device *dev)
302 * mei_txe_pg_state - translate aliveness register value
303 * to the mei power gating state
305 * @dev: the device structure
307 * returns: MEI_PG_OFF if aliveness is on and MEI_PG_ON otherwise
309 static inline enum mei_pg_state mei_txe_pg_state(struct mei_device *dev)
311 struct mei_txe_hw *hw = to_txe_hw(dev);
313 return hw->aliveness ? MEI_PG_OFF : MEI_PG_ON;
317 * mei_txe_input_ready_interrupt_enable - sets the Input Ready Interrupt
319 * @dev: the device structure
321 static void mei_txe_input_ready_interrupt_enable(struct mei_device *dev)
323 struct mei_txe_hw *hw = to_txe_hw(dev);
325 /* Enable the SEC_IPC_HOST_INT_MASK_IN_RDY interrupt */
326 hintmsk = mei_txe_sec_reg_read(hw, SEC_IPC_HOST_INT_MASK_REG);
327 hintmsk |= SEC_IPC_HOST_INT_MASK_IN_RDY;
328 mei_txe_sec_reg_write(hw, SEC_IPC_HOST_INT_MASK_REG, hintmsk);
332 * mei_txe_input_doorbell_set
333 * - Sets bit 0 in SEC_IPC_INPUT_DOORBELL.IPC_INPUT_DOORBELL.
334 * @dev: the device structure
336 static void mei_txe_input_doorbell_set(struct mei_txe_hw *hw)
338 /* Clear the interrupt cause */
339 clear_bit(TXE_INTR_IN_READY_BIT, &hw->intr_cause);
340 mei_txe_sec_reg_write(hw, SEC_IPC_INPUT_DOORBELL_REG, 1);
344 * mei_txe_output_ready_set - Sets the SICR_SEC_IPC_OUTPUT_STATUS bit to 1
346 * @dev: the device structure
348 static void mei_txe_output_ready_set(struct mei_txe_hw *hw)
350 mei_txe_br_reg_write(hw,
351 SICR_SEC_IPC_OUTPUT_STATUS_REG,
352 SEC_IPC_OUTPUT_STATUS_RDY);
356 * mei_txe_is_input_ready - check if TXE is ready for receiving data
358 * @dev: the device structure
360 static bool mei_txe_is_input_ready(struct mei_device *dev)
362 struct mei_txe_hw *hw = to_txe_hw(dev);
365 status = mei_txe_sec_reg_read(hw, SEC_IPC_INPUT_STATUS_REG);
366 return !!(SEC_IPC_INPUT_STATUS_RDY & status);
370 * mei_txe_intr_clear - clear all interrupts
372 * @dev: the device structure
374 static inline void mei_txe_intr_clear(struct mei_device *dev)
376 struct mei_txe_hw *hw = to_txe_hw(dev);
378 mei_txe_sec_reg_write_silent(hw, SEC_IPC_HOST_INT_STATUS_REG,
379 SEC_IPC_HOST_INT_STATUS_PENDING);
380 mei_txe_br_reg_write(hw, HISR_REG, HISR_INT_STS_MSK);
381 mei_txe_br_reg_write(hw, HHISR_REG, IPC_HHIER_MSK);
385 * mei_txe_intr_disable - disable all interrupts
387 * @dev: the device structure
389 static void mei_txe_intr_disable(struct mei_device *dev)
391 struct mei_txe_hw *hw = to_txe_hw(dev);
393 mei_txe_br_reg_write(hw, HHIER_REG, 0);
394 mei_txe_br_reg_write(hw, HIER_REG, 0);
397 * mei_txe_intr_disable - enable all interrupts
399 * @dev: the device structure
401 static void mei_txe_intr_enable(struct mei_device *dev)
403 struct mei_txe_hw *hw = to_txe_hw(dev);
405 mei_txe_br_reg_write(hw, HHIER_REG, IPC_HHIER_MSK);
406 mei_txe_br_reg_write(hw, HIER_REG, HIER_INT_EN_MSK);
410 * mei_txe_pending_interrupts - check if there are pending interrupts
411 * only Aliveness, Input ready, and output doorbell are of relevance
413 * @dev: the device structure
415 * Checks if there are pending interrupts
416 * only Aliveness, Readiness, Input ready, and Output doorbell are relevant
418 static bool mei_txe_pending_interrupts(struct mei_device *dev)
421 struct mei_txe_hw *hw = to_txe_hw(dev);
422 bool ret = (hw->intr_cause & (TXE_INTR_READINESS |
429 "Pending Interrupts InReady=%01d Readiness=%01d, Aliveness=%01d, OutDoor=%01d\n",
430 !!(hw->intr_cause & TXE_INTR_IN_READY),
431 !!(hw->intr_cause & TXE_INTR_READINESS),
432 !!(hw->intr_cause & TXE_INTR_ALIVENESS),
433 !!(hw->intr_cause & TXE_INTR_OUT_DB));
439 * mei_txe_input_payload_write - write a dword to the host buffer
442 * @dev: the device structure
443 * @idx: index in the host buffer
446 static void mei_txe_input_payload_write(struct mei_device *dev,
447 unsigned long idx, u32 value)
449 struct mei_txe_hw *hw = to_txe_hw(dev);
451 mei_txe_sec_reg_write(hw, SEC_IPC_INPUT_PAYLOAD_REG +
452 (idx * sizeof(u32)), value);
456 * mei_txe_out_data_read - read dword from the device buffer
459 * @dev: the device structure
460 * @idx: index in the device buffer
462 * returns register value at index
464 static u32 mei_txe_out_data_read(const struct mei_device *dev,
467 struct mei_txe_hw *hw = to_txe_hw(dev);
469 return mei_txe_br_reg_read(hw,
470 BRIDGE_IPC_OUTPUT_PAYLOAD_REG + (idx * sizeof(u32)));
476 * mei_txe_readiness_set_host_rdy
478 * @dev: the device structure
480 static void mei_txe_readiness_set_host_rdy(struct mei_device *dev)
482 struct mei_txe_hw *hw = to_txe_hw(dev);
484 mei_txe_br_reg_write(hw,
485 SICR_HOST_IPC_READINESS_REQ_REG,
486 SICR_HOST_IPC_READINESS_HOST_RDY);
490 * mei_txe_readiness_clear
492 * @dev: the device structure
494 static void mei_txe_readiness_clear(struct mei_device *dev)
496 struct mei_txe_hw *hw = to_txe_hw(dev);
498 mei_txe_br_reg_write(hw, SICR_HOST_IPC_READINESS_REQ_REG,
499 SICR_HOST_IPC_READINESS_RDY_CLR);
502 * mei_txe_readiness_get - Reads and returns
503 * the HICR_SEC_IPC_READINESS register value
505 * @dev: the device structure
507 static u32 mei_txe_readiness_get(struct mei_device *dev)
509 struct mei_txe_hw *hw = to_txe_hw(dev);
511 return mei_txe_br_reg_read(hw, HICR_SEC_IPC_READINESS_REG);
516 * mei_txe_readiness_is_sec_rdy - check readiness
517 * for HICR_SEC_IPC_READINESS_SEC_RDY
519 * @readiness - cached readiness state
521 static inline bool mei_txe_readiness_is_sec_rdy(u32 readiness)
523 return !!(readiness & HICR_SEC_IPC_READINESS_SEC_RDY);
527 * mei_txe_hw_is_ready - check if the hw is ready
529 * @dev: the device structure
531 static bool mei_txe_hw_is_ready(struct mei_device *dev)
533 u32 readiness = mei_txe_readiness_get(dev);
535 return mei_txe_readiness_is_sec_rdy(readiness);
539 * mei_txe_host_is_ready - check if the host is ready
541 * @dev: the device structure
543 static inline bool mei_txe_host_is_ready(struct mei_device *dev)
545 struct mei_txe_hw *hw = to_txe_hw(dev);
546 u32 reg = mei_txe_br_reg_read(hw, HICR_SEC_IPC_READINESS_REG);
548 return !!(reg & HICR_SEC_IPC_READINESS_HOST_RDY);
552 * mei_txe_readiness_wait - wait till readiness settles
554 * @dev: the device structure
556 * returns 0 on success and -ETIME on timeout
558 static int mei_txe_readiness_wait(struct mei_device *dev)
560 if (mei_txe_hw_is_ready(dev))
563 mutex_unlock(&dev->device_lock);
564 wait_event_timeout(dev->wait_hw_ready, dev->recvd_hw_ready,
565 msecs_to_jiffies(SEC_RESET_WAIT_TIMEOUT));
566 mutex_lock(&dev->device_lock);
567 if (!dev->recvd_hw_ready) {
568 dev_err(dev->dev, "wait for readiness failed\n");
572 dev->recvd_hw_ready = false;
578 * mei_txe_fw_status - read fw status register from pci config space
581 * @fw_status: fw status register values
583 static int mei_txe_fw_status(struct mei_device *dev,
584 struct mei_fw_status *fw_status)
586 const struct mei_fw_status *fw_src = &dev->cfg->fw_status;
587 struct pci_dev *pdev = to_pci_dev(dev->dev);
594 fw_status->count = fw_src->count;
595 for (i = 0; i < fw_src->count && i < MEI_FW_STATUS_MAX; i++) {
596 ret = pci_read_config_dword(pdev,
597 fw_src->status[i], &fw_status->status[i]);
606 * mei_txe_hw_config - configure hardware at the start of the devices
608 * @dev: the device structure
610 * Configure hardware at the start of the device should be done only
611 * once at the device probe time
613 static void mei_txe_hw_config(struct mei_device *dev)
616 struct mei_txe_hw *hw = to_txe_hw(dev);
618 /* Doesn't change in runtime */
619 dev->hbuf_depth = PAYLOAD_SIZE / 4;
621 hw->aliveness = mei_txe_aliveness_get(dev);
622 hw->readiness = mei_txe_readiness_get(dev);
624 dev_dbg(dev->dev, "aliveness_resp = 0x%08x, readiness = 0x%08x.\n",
625 hw->aliveness, hw->readiness);
630 * mei_txe_write - writes a message to device.
632 * @dev: the device structure
633 * @header: header of message
634 * @buf: message buffer will be written
635 * returns 1 if success, 0 - otherwise.
638 static int mei_txe_write(struct mei_device *dev,
639 struct mei_msg_hdr *header, unsigned char *buf)
641 struct mei_txe_hw *hw = to_txe_hw(dev);
643 unsigned long length;
644 int slots = dev->hbuf_depth;
645 u32 *reg_buf = (u32 *)buf;
649 if (WARN_ON(!header || !buf))
652 length = header->length;
654 dev_dbg(dev->dev, MEI_HDR_FMT, MEI_HDR_PRM(header));
656 dw_cnt = mei_data2slots(length);
660 if (WARN(!hw->aliveness, "txe write: aliveness not asserted\n"))
663 /* Enable Input Ready Interrupt. */
664 mei_txe_input_ready_interrupt_enable(dev);
666 if (!mei_txe_is_input_ready(dev)) {
667 struct mei_fw_status fw_status;
669 mei_fw_status(dev, &fw_status);
670 dev_err(dev->dev, "Input is not ready " FW_STS_FMT "\n",
671 FW_STS_PRM(fw_status));
675 mei_txe_input_payload_write(dev, 0, *((u32 *)header));
677 for (i = 0; i < length / 4; i++)
678 mei_txe_input_payload_write(dev, i + 1, reg_buf[i]);
684 memcpy(®, &buf[length - rem], rem);
685 mei_txe_input_payload_write(dev, i + 1, reg);
688 /* after each write the whole buffer is consumed */
691 /* Set Input-Doorbell */
692 mei_txe_input_doorbell_set(hw);
698 * mei_txe_hbuf_max_len - mimics the me hbuf circular buffer
700 * @dev: the device structure
702 * returns the PAYLOAD_SIZE - 4
704 static size_t mei_txe_hbuf_max_len(const struct mei_device *dev)
706 return PAYLOAD_SIZE - sizeof(struct mei_msg_hdr);
710 * mei_txe_hbuf_empty_slots - mimics the me hbuf circular buffer
712 * @dev: the device structure
714 * returns always hbuf_depth
716 static int mei_txe_hbuf_empty_slots(struct mei_device *dev)
718 struct mei_txe_hw *hw = to_txe_hw(dev);
724 * mei_txe_count_full_read_slots - mimics the me device circular buffer
726 * @dev: the device structure
728 * returns always buffer size in dwords count
730 static int mei_txe_count_full_read_slots(struct mei_device *dev)
732 /* read buffers has static size */
733 return PAYLOAD_SIZE / 4;
737 * mei_txe_read_hdr - read message header which is always in 4 first bytes
739 * @dev: the device structure
741 * returns mei message header
744 static u32 mei_txe_read_hdr(const struct mei_device *dev)
746 return mei_txe_out_data_read(dev, 0);
749 * mei_txe_read - reads a message from the txe device.
751 * @dev: the device structure
752 * @buf: message buffer will be written
753 * @len: message size will be read
755 * returns -EINVAL on error wrong argument and 0 on success
757 static int mei_txe_read(struct mei_device *dev,
758 unsigned char *buf, unsigned long len)
761 struct mei_txe_hw *hw = to_txe_hw(dev);
766 if (WARN_ON(!buf || !len))
769 reg_buf = (u32 *)buf;
772 dev_dbg(dev->dev, "buffer-length = %lu buf[0]0x%08X\n",
773 len, mei_txe_out_data_read(dev, 0));
775 for (i = 0; i < len / 4; i++) {
776 /* skip header: index starts from 1 */
777 reg = mei_txe_out_data_read(dev, i + 1);
778 dev_dbg(dev->dev, "buf[%d] = 0x%08X\n", i, reg);
783 reg = mei_txe_out_data_read(dev, i + 1);
784 memcpy(reg_buf, ®, rem);
787 mei_txe_output_ready_set(hw);
792 * mei_txe_hw_reset - resets host and fw.
794 * @dev: the device structure
795 * @intr_enable: if interrupt should be enabled after reset.
797 * returns 0 on success and < 0 in case of error
799 static int mei_txe_hw_reset(struct mei_device *dev, bool intr_enable)
801 struct mei_txe_hw *hw = to_txe_hw(dev);
805 * read input doorbell to ensure consistency between Bridge and SeC
806 * return value might be garbage return
808 (void)mei_txe_sec_reg_read_silent(hw, SEC_IPC_INPUT_DOORBELL_REG);
810 aliveness_req = mei_txe_aliveness_req_get(dev);
811 hw->aliveness = mei_txe_aliveness_get(dev);
813 /* Disable interrupts in this stage we will poll */
814 mei_txe_intr_disable(dev);
817 * If Aliveness Request and Aliveness Response are not equal then
818 * wait for them to be equal
819 * Since we might have interrupts disabled - poll for it
821 if (aliveness_req != hw->aliveness)
822 if (mei_txe_aliveness_poll(dev, aliveness_req) < 0) {
823 dev_err(dev->dev, "wait for aliveness settle failed ... bailing out\n");
828 * If Aliveness Request and Aliveness Response are set then clear them
831 mei_txe_aliveness_set(dev, 0);
832 if (mei_txe_aliveness_poll(dev, 0) < 0) {
833 dev_err(dev->dev, "wait for aliveness failed ... bailing out\n");
839 * Set rediness RDY_CLR bit
841 mei_txe_readiness_clear(dev);
847 * mei_txe_hw_start - start the hardware after reset
849 * @dev: the device structure
851 * returns 0 on success and < 0 in case of error
853 static int mei_txe_hw_start(struct mei_device *dev)
855 struct mei_txe_hw *hw = to_txe_hw(dev);
860 /* bring back interrupts */
861 mei_txe_intr_enable(dev);
863 ret = mei_txe_readiness_wait(dev);
865 dev_err(dev->dev, "wating for readiness failed\n");
870 * If HISR.INT2_STS interrupt status bit is set then clear it.
872 hisr = mei_txe_br_reg_read(hw, HISR_REG);
873 if (hisr & HISR_INT_2_STS)
874 mei_txe_br_reg_write(hw, HISR_REG, HISR_INT_2_STS);
876 /* Clear the interrupt cause of OutputDoorbell */
877 clear_bit(TXE_INTR_OUT_DB_BIT, &hw->intr_cause);
879 ret = mei_txe_aliveness_set_sync(dev, 1);
881 dev_err(dev->dev, "wait for aliveness failed ... bailing out\n");
885 /* enable input ready interrupts:
886 * SEC_IPC_HOST_INT_MASK.IPC_INPUT_READY_INT_MASK
888 mei_txe_input_ready_interrupt_enable(dev);
891 /* Set the SICR_SEC_IPC_OUTPUT_STATUS.IPC_OUTPUT_READY bit */
892 mei_txe_output_ready_set(hw);
894 /* Set bit SICR_HOST_IPC_READINESS.HOST_RDY
896 mei_txe_readiness_set_host_rdy(dev);
902 * mei_txe_check_and_ack_intrs - translate multi BAR interrupt into
903 * single bit mask and acknowledge the interrupts
905 * @dev: the device structure
906 * @do_ack: acknowledge interrupts
908 static bool mei_txe_check_and_ack_intrs(struct mei_device *dev, bool do_ack)
910 struct mei_txe_hw *hw = to_txe_hw(dev);
917 /* read interrupt registers */
918 hhisr = mei_txe_br_reg_read(hw, HHISR_REG);
919 generated = (hhisr & IPC_HHIER_MSK);
923 hisr = mei_txe_br_reg_read(hw, HISR_REG);
925 aliveness = mei_txe_aliveness_get(dev);
926 if (hhisr & IPC_HHIER_SEC && aliveness)
927 ipc_isr = mei_txe_sec_reg_read_silent(hw,
928 SEC_IPC_HOST_INT_STATUS_REG);
932 generated = generated ||
933 (hisr & HISR_INT_STS_MSK) ||
934 (ipc_isr & SEC_IPC_HOST_INT_STATUS_PENDING);
936 if (generated && do_ack) {
937 /* Save the interrupt causes */
938 hw->intr_cause |= hisr & HISR_INT_STS_MSK;
939 if (ipc_isr & SEC_IPC_HOST_INT_STATUS_IN_RDY)
940 hw->intr_cause |= TXE_INTR_IN_READY;
943 mei_txe_intr_disable(dev);
944 /* Clear the interrupts in hierarchy:
945 * IPC and Bridge, than the High Level */
946 mei_txe_sec_reg_write_silent(hw,
947 SEC_IPC_HOST_INT_STATUS_REG, ipc_isr);
948 mei_txe_br_reg_write(hw, HISR_REG, hisr);
949 mei_txe_br_reg_write(hw, HHISR_REG, hhisr);
957 * mei_txe_irq_quick_handler - The ISR of the MEI device
959 * @irq: The irq number
960 * @dev_id: pointer to the device structure
962 * returns irqreturn_t
964 irqreturn_t mei_txe_irq_quick_handler(int irq, void *dev_id)
966 struct mei_device *dev = dev_id;
968 if (mei_txe_check_and_ack_intrs(dev, true))
969 return IRQ_WAKE_THREAD;
975 * mei_txe_irq_thread_handler - txe interrupt thread
977 * @irq: The irq number
978 * @dev_id: pointer to the device structure
980 * returns irqreturn_t
983 irqreturn_t mei_txe_irq_thread_handler(int irq, void *dev_id)
985 struct mei_device *dev = (struct mei_device *) dev_id;
986 struct mei_txe_hw *hw = to_txe_hw(dev);
987 struct mei_cl_cb complete_list;
991 dev_dbg(dev->dev, "irq thread: Interrupt Registers HHISR|HISR|SEC=%02X|%04X|%02X\n",
992 mei_txe_br_reg_read(hw, HHISR_REG),
993 mei_txe_br_reg_read(hw, HISR_REG),
994 mei_txe_sec_reg_read_silent(hw, SEC_IPC_HOST_INT_STATUS_REG));
997 /* initialize our complete list */
998 mutex_lock(&dev->device_lock);
999 mei_io_list_init(&complete_list);
1001 if (pci_dev_msi_enabled(dev->pdev))
1002 mei_txe_check_and_ack_intrs(dev, true);
1004 /* show irq events */
1005 mei_txe_pending_interrupts(dev);
1007 hw->aliveness = mei_txe_aliveness_get(dev);
1008 hw->readiness = mei_txe_readiness_get(dev);
1011 * Detection of TXE driver going through reset
1012 * or TXE driver resetting the HECI interface.
1014 if (test_and_clear_bit(TXE_INTR_READINESS_BIT, &hw->intr_cause)) {
1015 dev_dbg(dev->dev, "Readiness Interrupt was received...\n");
1017 /* Check if SeC is going through reset */
1018 if (mei_txe_readiness_is_sec_rdy(hw->readiness)) {
1019 dev_dbg(dev->dev, "we need to start the dev.\n");
1020 dev->recvd_hw_ready = true;
1022 dev->recvd_hw_ready = false;
1023 if (dev->dev_state != MEI_DEV_RESETTING) {
1025 dev_warn(dev->dev, "FW not ready: resetting.\n");
1026 schedule_work(&dev->reset_work);
1031 wake_up(&dev->wait_hw_ready);
1034 /************************************************************/
1035 /* Check interrupt cause:
1036 * Aliveness: Detection of SeC acknowledge of host request that
1037 * it remain alive or host cancellation of that request.
1040 if (test_and_clear_bit(TXE_INTR_ALIVENESS_BIT, &hw->intr_cause)) {
1041 /* Clear the interrupt cause */
1043 "Aliveness Interrupt: Status: %d\n", hw->aliveness);
1044 dev->pg_event = MEI_PG_EVENT_RECEIVED;
1045 if (waitqueue_active(&hw->wait_aliveness_resp))
1046 wake_up(&hw->wait_aliveness_resp);
1051 * Detection of SeC having sent output to host
1053 slots = mei_count_full_read_slots(dev);
1054 if (test_and_clear_bit(TXE_INTR_OUT_DB_BIT, &hw->intr_cause)) {
1056 rets = mei_irq_read_handler(dev, &complete_list, &slots);
1057 if (rets && dev->dev_state != MEI_DEV_RESETTING) {
1059 "mei_irq_read_handler ret = %d.\n", rets);
1061 schedule_work(&dev->reset_work);
1065 /* Input Ready: Detection if host can write to SeC */
1066 if (test_and_clear_bit(TXE_INTR_IN_READY_BIT, &hw->intr_cause)) {
1067 dev->hbuf_is_ready = true;
1068 hw->slots = dev->hbuf_depth;
1071 if (hw->aliveness && dev->hbuf_is_ready) {
1072 /* get the real register value */
1073 dev->hbuf_is_ready = mei_hbuf_is_ready(dev);
1074 rets = mei_irq_write_handler(dev, &complete_list);
1075 if (rets && rets != -EMSGSIZE)
1076 dev_err(dev->dev, "mei_irq_write_handler ret = %d.\n",
1078 dev->hbuf_is_ready = mei_hbuf_is_ready(dev);
1081 mei_irq_compl_handler(dev, &complete_list);
1084 dev_dbg(dev->dev, "interrupt thread end ret = %d\n", rets);
1086 mutex_unlock(&dev->device_lock);
1088 mei_enable_interrupts(dev);
1092 static const struct mei_hw_ops mei_txe_hw_ops = {
1094 .host_is_ready = mei_txe_host_is_ready,
1096 .fw_status = mei_txe_fw_status,
1097 .pg_state = mei_txe_pg_state,
1099 .hw_is_ready = mei_txe_hw_is_ready,
1100 .hw_reset = mei_txe_hw_reset,
1101 .hw_config = mei_txe_hw_config,
1102 .hw_start = mei_txe_hw_start,
1104 .pg_is_enabled = mei_txe_pg_is_enabled,
1106 .intr_clear = mei_txe_intr_clear,
1107 .intr_enable = mei_txe_intr_enable,
1108 .intr_disable = mei_txe_intr_disable,
1110 .hbuf_free_slots = mei_txe_hbuf_empty_slots,
1111 .hbuf_is_ready = mei_txe_is_input_ready,
1112 .hbuf_max_len = mei_txe_hbuf_max_len,
1114 .write = mei_txe_write,
1116 .rdbuf_full_slots = mei_txe_count_full_read_slots,
1117 .read_hdr = mei_txe_read_hdr,
1119 .read = mei_txe_read,
1123 #define MEI_CFG_TXE_FW_STS \
1124 .fw_status.count = 2, \
1125 .fw_status.status[0] = PCI_CFG_TXE_FW_STS0, \
1126 .fw_status.status[1] = PCI_CFG_TXE_FW_STS1
1128 const struct mei_cfg mei_txe_cfg = {
1134 * mei_txe_dev_init - allocates and initializes txe hardware specific structure
1136 * @pdev - pci device
1137 * @cfg - per device generation config
1139 * returns struct mei_device * on success or NULL;
1142 struct mei_device *mei_txe_dev_init(struct pci_dev *pdev,
1143 const struct mei_cfg *cfg)
1145 struct mei_device *dev;
1146 struct mei_txe_hw *hw;
1148 dev = kzalloc(sizeof(struct mei_device) +
1149 sizeof(struct mei_txe_hw), GFP_KERNEL);
1153 mei_device_init(dev, &pdev->dev, &mei_txe_hw_ops);
1155 hw = to_txe_hw(dev);
1157 init_waitqueue_head(&hw->wait_aliveness_resp);
1165 * mei_txe_setup_satt2 - SATT2 configuration for DMA support.
1167 * @dev: the device structure
1168 * @addr: physical address start of the range
1169 * @range: physical range size
1171 int mei_txe_setup_satt2(struct mei_device *dev, phys_addr_t addr, u32 range)
1173 struct mei_txe_hw *hw = to_txe_hw(dev);
1175 u32 lo32 = lower_32_bits(addr);
1176 u32 hi32 = upper_32_bits(addr);
1179 /* SATT is limited to 36 Bits */
1183 /* SATT has to be 16Byte aligned */
1187 /* SATT range has to be 4Bytes aligned */
1191 /* SATT is limited to 32 MB range*/
1192 if (range > SATT_RANGE_MAX)
1195 ctrl = SATT2_CTRL_VALID_MSK;
1196 ctrl |= hi32 << SATT2_CTRL_BR_BASE_ADDR_REG_SHIFT;
1198 mei_txe_br_reg_write(hw, SATT2_SAP_SIZE_REG, range);
1199 mei_txe_br_reg_write(hw, SATT2_BRG_BA_LSB_REG, lo32);
1200 mei_txe_br_reg_write(hw, SATT2_CTRL_REG, ctrl);
1201 dev_dbg(dev->dev, "SATT2: SAP_SIZE_OFFSET=0x%08X, BRG_BA_LSB_OFFSET=0x%08X, CTRL_OFFSET=0x%08X\n",