1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2018-2020, The Linux Foundation. All rights reserved.
7 #include <linux/delay.h>
8 #include <linux/device.h>
9 #include <linux/dma-direction.h>
10 #include <linux/dma-mapping.h>
11 #include <linux/interrupt.h>
12 #include <linux/list.h>
13 #include <linux/mhi.h>
14 #include <linux/module.h>
15 #include <linux/slab.h>
16 #include <linux/wait.h>
20 * Not all MHI state transitions are synchronous. Transitions like Linkdown,
21 * SYS_ERR, and shutdown can happen anytime asynchronously. This function will
22 * transition to a new state only if we're allowed to.
24 * Priority increases as we go down. For instance, from any state in L0, the
25 * transition can be made to states in L1, L2 and L3. A notable exception to
26 * this rule is state DISABLE. From DISABLE state we can only transition to
27 * POR state. Also, while in L2 state, user cannot jump back to previous
31 * L0: DISABLE <--> POR
33 * POR -> M0 -> M2 --> M0
35 * FW_DL_ERR <--> FW_DL_ERR
38 * M0 -> M3_ENTER -> M3 -> M3_EXIT --> M0
39 * L1: SYS_ERR_DETECT -> SYS_ERR_PROCESS --> POR
40 * L2: SHUTDOWN_PROCESS -> DISABLE
41 * L3: LD_ERR_FATAL_DETECT <--> LD_ERR_FATAL_DETECT
42 * LD_ERR_FATAL_DETECT -> SHUTDOWN_PROCESS
44 static struct mhi_pm_transitions const dev_state_transitions[] = {
52 MHI_PM_POR | MHI_PM_DISABLE | MHI_PM_M0 |
53 MHI_PM_SYS_ERR_DETECT | MHI_PM_SHUTDOWN_PROCESS |
54 MHI_PM_LD_ERR_FATAL_DETECT | MHI_PM_FW_DL_ERR
58 MHI_PM_M0 | MHI_PM_M2 | MHI_PM_M3_ENTER |
59 MHI_PM_SYS_ERR_DETECT | MHI_PM_SHUTDOWN_PROCESS |
60 MHI_PM_LD_ERR_FATAL_DETECT | MHI_PM_FW_DL_ERR
64 MHI_PM_M0 | MHI_PM_SYS_ERR_DETECT | MHI_PM_SHUTDOWN_PROCESS |
65 MHI_PM_LD_ERR_FATAL_DETECT
69 MHI_PM_M3 | MHI_PM_SYS_ERR_DETECT | MHI_PM_SHUTDOWN_PROCESS |
70 MHI_PM_LD_ERR_FATAL_DETECT
74 MHI_PM_M3_EXIT | MHI_PM_SYS_ERR_DETECT |
75 MHI_PM_SHUTDOWN_PROCESS | MHI_PM_LD_ERR_FATAL_DETECT
79 MHI_PM_M0 | MHI_PM_SYS_ERR_DETECT | MHI_PM_SHUTDOWN_PROCESS |
80 MHI_PM_LD_ERR_FATAL_DETECT
84 MHI_PM_FW_DL_ERR | MHI_PM_SYS_ERR_DETECT |
85 MHI_PM_SHUTDOWN_PROCESS | MHI_PM_LD_ERR_FATAL_DETECT
89 MHI_PM_SYS_ERR_DETECT,
90 MHI_PM_SYS_ERR_PROCESS | MHI_PM_SHUTDOWN_PROCESS |
91 MHI_PM_LD_ERR_FATAL_DETECT
94 MHI_PM_SYS_ERR_PROCESS,
95 MHI_PM_POR | MHI_PM_SHUTDOWN_PROCESS |
96 MHI_PM_LD_ERR_FATAL_DETECT
100 MHI_PM_SHUTDOWN_PROCESS,
101 MHI_PM_DISABLE | MHI_PM_LD_ERR_FATAL_DETECT
105 MHI_PM_LD_ERR_FATAL_DETECT,
106 MHI_PM_LD_ERR_FATAL_DETECT | MHI_PM_SHUTDOWN_PROCESS
110 enum mhi_pm_state __must_check mhi_tryset_pm_state(struct mhi_controller *mhi_cntrl,
111 enum mhi_pm_state state)
113 unsigned long cur_state = mhi_cntrl->pm_state;
114 int index = find_last_bit(&cur_state, 32);
116 if (unlikely(index >= ARRAY_SIZE(dev_state_transitions)))
119 if (unlikely(dev_state_transitions[index].from_state != cur_state))
122 if (unlikely(!(dev_state_transitions[index].to_states & state)))
125 mhi_cntrl->pm_state = state;
126 return mhi_cntrl->pm_state;
129 void mhi_set_mhi_state(struct mhi_controller *mhi_cntrl, enum mhi_state state)
131 if (state == MHI_STATE_RESET) {
132 mhi_write_reg_field(mhi_cntrl, mhi_cntrl->regs, MHICTRL,
133 MHICTRL_RESET_MASK, MHICTRL_RESET_SHIFT, 1);
135 mhi_write_reg_field(mhi_cntrl, mhi_cntrl->regs, MHICTRL,
136 MHICTRL_MHISTATE_MASK,
137 MHICTRL_MHISTATE_SHIFT, state);
141 /* NOP for backward compatibility, host allowed to ring DB in M2 state */
142 static void mhi_toggle_dev_wake_nop(struct mhi_controller *mhi_cntrl)
146 static void mhi_toggle_dev_wake(struct mhi_controller *mhi_cntrl)
148 mhi_cntrl->wake_get(mhi_cntrl, false);
149 mhi_cntrl->wake_put(mhi_cntrl, true);
152 /* Handle device ready state transition */
153 int mhi_ready_state_transition(struct mhi_controller *mhi_cntrl)
155 void __iomem *base = mhi_cntrl->regs;
156 struct mhi_event *mhi_event;
157 enum mhi_pm_state cur_state;
158 struct device *dev = &mhi_cntrl->mhi_dev->dev;
159 u32 reset = 1, ready = 0;
162 /* Wait for RESET to be cleared and READY bit to be set by the device */
163 wait_event_timeout(mhi_cntrl->state_event,
164 MHI_PM_IN_FATAL_STATE(mhi_cntrl->pm_state) ||
165 mhi_read_reg_field(mhi_cntrl, base, MHICTRL,
167 MHICTRL_RESET_SHIFT, &reset) ||
168 mhi_read_reg_field(mhi_cntrl, base, MHISTATUS,
169 MHISTATUS_READY_MASK,
170 MHISTATUS_READY_SHIFT, &ready) ||
172 msecs_to_jiffies(mhi_cntrl->timeout_ms));
174 /* Check if device entered error state */
175 if (MHI_PM_IN_FATAL_STATE(mhi_cntrl->pm_state)) {
176 dev_err(dev, "Device link is not accessible\n");
180 /* Timeout if device did not transition to ready state */
181 if (reset || !ready) {
182 dev_err(dev, "Device Ready timeout\n");
186 dev_dbg(dev, "Device in READY State\n");
187 write_lock_irq(&mhi_cntrl->pm_lock);
188 cur_state = mhi_tryset_pm_state(mhi_cntrl, MHI_PM_POR);
189 mhi_cntrl->dev_state = MHI_STATE_READY;
190 write_unlock_irq(&mhi_cntrl->pm_lock);
192 if (cur_state != MHI_PM_POR) {
193 dev_err(dev, "Error moving to state %s from %s\n",
194 to_mhi_pm_state_str(MHI_PM_POR),
195 to_mhi_pm_state_str(cur_state));
199 read_lock_bh(&mhi_cntrl->pm_lock);
200 if (!MHI_REG_ACCESS_VALID(mhi_cntrl->pm_state)) {
201 dev_err(dev, "Device registers not accessible\n");
205 /* Configure MMIO registers */
206 ret = mhi_init_mmio(mhi_cntrl);
208 dev_err(dev, "Error configuring MMIO registers\n");
212 /* Add elements to all SW event rings */
213 mhi_event = mhi_cntrl->mhi_event;
214 for (i = 0; i < mhi_cntrl->total_ev_rings; i++, mhi_event++) {
215 struct mhi_ring *ring = &mhi_event->ring;
217 /* Skip if this is an offload or HW event */
218 if (mhi_event->offload_ev || mhi_event->hw_ring)
221 ring->wp = ring->base + ring->len - ring->el_size;
222 *ring->ctxt_wp = ring->iommu_base + ring->len - ring->el_size;
223 /* Update all cores */
226 /* Ring the event ring db */
227 spin_lock_irq(&mhi_event->lock);
228 mhi_ring_er_db(mhi_event);
229 spin_unlock_irq(&mhi_event->lock);
232 /* Set MHI to M0 state */
233 mhi_set_mhi_state(mhi_cntrl, MHI_STATE_M0);
234 read_unlock_bh(&mhi_cntrl->pm_lock);
239 read_unlock_bh(&mhi_cntrl->pm_lock);
244 int mhi_pm_m0_transition(struct mhi_controller *mhi_cntrl)
246 enum mhi_pm_state cur_state;
247 struct mhi_chan *mhi_chan;
248 struct device *dev = &mhi_cntrl->mhi_dev->dev;
251 write_lock_irq(&mhi_cntrl->pm_lock);
252 mhi_cntrl->dev_state = MHI_STATE_M0;
253 cur_state = mhi_tryset_pm_state(mhi_cntrl, MHI_PM_M0);
254 write_unlock_irq(&mhi_cntrl->pm_lock);
255 if (unlikely(cur_state != MHI_PM_M0)) {
256 dev_err(dev, "Unable to transition to M0 state\n");
261 /* Wake up the device */
262 read_lock_bh(&mhi_cntrl->pm_lock);
263 mhi_cntrl->wake_get(mhi_cntrl, true);
265 /* Ring all event rings and CMD ring only if we're in mission mode */
266 if (MHI_IN_MISSION_MODE(mhi_cntrl->ee)) {
267 struct mhi_event *mhi_event = mhi_cntrl->mhi_event;
268 struct mhi_cmd *mhi_cmd =
269 &mhi_cntrl->mhi_cmd[PRIMARY_CMD_RING];
271 for (i = 0; i < mhi_cntrl->total_ev_rings; i++, mhi_event++) {
272 if (mhi_event->offload_ev)
275 spin_lock_irq(&mhi_event->lock);
276 mhi_ring_er_db(mhi_event);
277 spin_unlock_irq(&mhi_event->lock);
280 /* Only ring primary cmd ring if ring is not empty */
281 spin_lock_irq(&mhi_cmd->lock);
282 if (mhi_cmd->ring.rp != mhi_cmd->ring.wp)
283 mhi_ring_cmd_db(mhi_cntrl, mhi_cmd);
284 spin_unlock_irq(&mhi_cmd->lock);
287 /* Ring channel DB registers */
288 mhi_chan = mhi_cntrl->mhi_chan;
289 for (i = 0; i < mhi_cntrl->max_chan; i++, mhi_chan++) {
290 struct mhi_ring *tre_ring = &mhi_chan->tre_ring;
292 if (mhi_chan->db_cfg.reset_req) {
293 write_lock_irq(&mhi_chan->lock);
294 mhi_chan->db_cfg.db_mode = true;
295 write_unlock_irq(&mhi_chan->lock);
298 read_lock_irq(&mhi_chan->lock);
300 /* Only ring DB if ring is not empty */
301 if (tre_ring->base && tre_ring->wp != tre_ring->rp)
302 mhi_ring_chan_db(mhi_cntrl, mhi_chan);
303 read_unlock_irq(&mhi_chan->lock);
306 mhi_cntrl->wake_put(mhi_cntrl, false);
307 read_unlock_bh(&mhi_cntrl->pm_lock);
308 wake_up_all(&mhi_cntrl->state_event);
314 * After receiving the MHI state change event from the device indicating the
315 * transition to M1 state, the host can transition the device to M2 state
316 * for keeping it in low power state.
318 void mhi_pm_m1_transition(struct mhi_controller *mhi_cntrl)
320 enum mhi_pm_state state;
321 struct device *dev = &mhi_cntrl->mhi_dev->dev;
323 write_lock_irq(&mhi_cntrl->pm_lock);
324 state = mhi_tryset_pm_state(mhi_cntrl, MHI_PM_M2);
325 if (state == MHI_PM_M2) {
326 mhi_set_mhi_state(mhi_cntrl, MHI_STATE_M2);
327 mhi_cntrl->dev_state = MHI_STATE_M2;
329 write_unlock_irq(&mhi_cntrl->pm_lock);
332 wake_up_all(&mhi_cntrl->state_event);
334 /* If there are any pending resources, exit M2 immediately */
335 if (unlikely(atomic_read(&mhi_cntrl->pending_pkts) ||
336 atomic_read(&mhi_cntrl->dev_wake))) {
338 "Exiting M2, pending_pkts: %d dev_wake: %d\n",
339 atomic_read(&mhi_cntrl->pending_pkts),
340 atomic_read(&mhi_cntrl->dev_wake));
341 read_lock_bh(&mhi_cntrl->pm_lock);
342 mhi_cntrl->wake_get(mhi_cntrl, true);
343 mhi_cntrl->wake_put(mhi_cntrl, true);
344 read_unlock_bh(&mhi_cntrl->pm_lock);
346 mhi_cntrl->status_cb(mhi_cntrl, MHI_CB_IDLE);
349 write_unlock_irq(&mhi_cntrl->pm_lock);
353 /* MHI M3 completion handler */
354 int mhi_pm_m3_transition(struct mhi_controller *mhi_cntrl)
356 enum mhi_pm_state state;
357 struct device *dev = &mhi_cntrl->mhi_dev->dev;
359 write_lock_irq(&mhi_cntrl->pm_lock);
360 mhi_cntrl->dev_state = MHI_STATE_M3;
361 state = mhi_tryset_pm_state(mhi_cntrl, MHI_PM_M3);
362 write_unlock_irq(&mhi_cntrl->pm_lock);
363 if (state != MHI_PM_M3) {
364 dev_err(dev, "Unable to transition to M3 state\n");
369 wake_up_all(&mhi_cntrl->state_event);
374 /* Handle device Mission Mode transition */
375 static int mhi_pm_mission_mode_transition(struct mhi_controller *mhi_cntrl)
377 struct mhi_event *mhi_event;
378 struct device *dev = &mhi_cntrl->mhi_dev->dev;
379 enum mhi_ee_type current_ee = mhi_cntrl->ee;
382 dev_dbg(dev, "Processing Mission Mode transition\n");
384 write_lock_irq(&mhi_cntrl->pm_lock);
385 if (MHI_REG_ACCESS_VALID(mhi_cntrl->pm_state))
386 mhi_cntrl->ee = mhi_get_exec_env(mhi_cntrl);
387 write_unlock_irq(&mhi_cntrl->pm_lock);
389 if (!MHI_IN_MISSION_MODE(mhi_cntrl->ee))
392 wake_up_all(&mhi_cntrl->state_event);
394 device_for_each_child(&mhi_cntrl->mhi_dev->dev, ¤t_ee,
396 mhi_cntrl->status_cb(mhi_cntrl, MHI_CB_EE_MISSION_MODE);
398 /* Force MHI to be in M0 state before continuing */
399 ret = __mhi_device_get_sync(mhi_cntrl);
403 read_lock_bh(&mhi_cntrl->pm_lock);
405 if (MHI_PM_IN_ERROR_STATE(mhi_cntrl->pm_state)) {
407 goto error_mission_mode;
410 /* Add elements to all HW event rings */
411 mhi_event = mhi_cntrl->mhi_event;
412 for (i = 0; i < mhi_cntrl->total_ev_rings; i++, mhi_event++) {
413 struct mhi_ring *ring = &mhi_event->ring;
415 if (mhi_event->offload_ev || !mhi_event->hw_ring)
418 ring->wp = ring->base + ring->len - ring->el_size;
419 *ring->ctxt_wp = ring->iommu_base + ring->len - ring->el_size;
420 /* Update to all cores */
423 spin_lock_irq(&mhi_event->lock);
424 if (MHI_DB_ACCESS_VALID(mhi_cntrl))
425 mhi_ring_er_db(mhi_event);
426 spin_unlock_irq(&mhi_event->lock);
429 read_unlock_bh(&mhi_cntrl->pm_lock);
432 * The MHI devices are only created when the client device switches its
433 * Execution Environment (EE) to either SBL or AMSS states
435 mhi_create_devices(mhi_cntrl);
437 read_lock_bh(&mhi_cntrl->pm_lock);
440 mhi_cntrl->wake_put(mhi_cntrl, false);
441 read_unlock_bh(&mhi_cntrl->pm_lock);
446 /* Handle SYS_ERR and Shutdown transitions */
447 static void mhi_pm_disable_transition(struct mhi_controller *mhi_cntrl,
448 enum mhi_pm_state transition_state)
450 enum mhi_pm_state cur_state, prev_state;
451 struct mhi_event *mhi_event;
452 struct mhi_cmd_ctxt *cmd_ctxt;
453 struct mhi_cmd *mhi_cmd;
454 struct mhi_event_ctxt *er_ctxt;
455 struct device *dev = &mhi_cntrl->mhi_dev->dev;
458 dev_dbg(dev, "Transitioning from PM state: %s to: %s\n",
459 to_mhi_pm_state_str(mhi_cntrl->pm_state),
460 to_mhi_pm_state_str(transition_state));
462 /* We must notify MHI control driver so it can clean up first */
463 if (transition_state == MHI_PM_SYS_ERR_PROCESS)
464 mhi_cntrl->status_cb(mhi_cntrl, MHI_CB_SYS_ERROR);
466 mutex_lock(&mhi_cntrl->pm_mutex);
467 write_lock_irq(&mhi_cntrl->pm_lock);
468 prev_state = mhi_cntrl->pm_state;
469 cur_state = mhi_tryset_pm_state(mhi_cntrl, transition_state);
470 if (cur_state == transition_state) {
471 mhi_cntrl->ee = MHI_EE_DISABLE_TRANSITION;
472 mhi_cntrl->dev_state = MHI_STATE_RESET;
474 write_unlock_irq(&mhi_cntrl->pm_lock);
476 /* Wake up threads waiting for state transition */
477 wake_up_all(&mhi_cntrl->state_event);
479 if (cur_state != transition_state) {
480 dev_err(dev, "Failed to transition to state: %s from: %s\n",
481 to_mhi_pm_state_str(transition_state),
482 to_mhi_pm_state_str(cur_state));
483 mutex_unlock(&mhi_cntrl->pm_mutex);
487 /* Trigger MHI RESET so that the device will not access host memory */
488 if (MHI_REG_ACCESS_VALID(prev_state)) {
490 unsigned long timeout = msecs_to_jiffies(mhi_cntrl->timeout_ms);
492 dev_dbg(dev, "Triggering MHI Reset in device\n");
493 mhi_set_mhi_state(mhi_cntrl, MHI_STATE_RESET);
495 /* Wait for the reset bit to be cleared by the device */
496 ret = wait_event_timeout(mhi_cntrl->state_event,
497 mhi_read_reg_field(mhi_cntrl,
504 if ((!ret || in_reset) && cur_state == MHI_PM_SYS_ERR_PROCESS) {
505 dev_err(dev, "Device failed to exit MHI Reset state\n");
506 mutex_unlock(&mhi_cntrl->pm_mutex);
511 * Device will clear BHI_INTVEC as a part of RESET processing,
512 * hence re-program it
514 mhi_write_reg(mhi_cntrl, mhi_cntrl->bhi, BHI_INTVEC, 0);
518 "Waiting for all pending event ring processing to complete\n");
519 mhi_event = mhi_cntrl->mhi_event;
520 for (i = 0; i < mhi_cntrl->total_ev_rings; i++, mhi_event++) {
521 if (mhi_event->offload_ev)
523 tasklet_kill(&mhi_event->task);
526 /* Release lock and wait for all pending threads to complete */
527 mutex_unlock(&mhi_cntrl->pm_mutex);
528 dev_dbg(dev, "Waiting for all pending threads to complete\n");
529 wake_up_all(&mhi_cntrl->state_event);
531 dev_dbg(dev, "Reset all active channels and remove MHI devices\n");
532 device_for_each_child(mhi_cntrl->cntrl_dev, NULL, mhi_destroy_device);
534 mutex_lock(&mhi_cntrl->pm_mutex);
536 WARN_ON(atomic_read(&mhi_cntrl->dev_wake));
537 WARN_ON(atomic_read(&mhi_cntrl->pending_pkts));
539 /* Reset the ev rings and cmd rings */
540 dev_dbg(dev, "Resetting EV CTXT and CMD CTXT\n");
541 mhi_cmd = mhi_cntrl->mhi_cmd;
542 cmd_ctxt = mhi_cntrl->mhi_ctxt->cmd_ctxt;
543 for (i = 0; i < NR_OF_CMD_RINGS; i++, mhi_cmd++, cmd_ctxt++) {
544 struct mhi_ring *ring = &mhi_cmd->ring;
546 ring->rp = ring->base;
547 ring->wp = ring->base;
548 cmd_ctxt->rp = cmd_ctxt->rbase;
549 cmd_ctxt->wp = cmd_ctxt->rbase;
552 mhi_event = mhi_cntrl->mhi_event;
553 er_ctxt = mhi_cntrl->mhi_ctxt->er_ctxt;
554 for (i = 0; i < mhi_cntrl->total_ev_rings; i++, er_ctxt++,
556 struct mhi_ring *ring = &mhi_event->ring;
558 /* Skip offload events */
559 if (mhi_event->offload_ev)
562 ring->rp = ring->base;
563 ring->wp = ring->base;
564 er_ctxt->rp = er_ctxt->rbase;
565 er_ctxt->wp = er_ctxt->rbase;
568 if (cur_state == MHI_PM_SYS_ERR_PROCESS) {
569 mhi_ready_state_transition(mhi_cntrl);
571 /* Move to disable state */
572 write_lock_irq(&mhi_cntrl->pm_lock);
573 cur_state = mhi_tryset_pm_state(mhi_cntrl, MHI_PM_DISABLE);
574 write_unlock_irq(&mhi_cntrl->pm_lock);
575 if (unlikely(cur_state != MHI_PM_DISABLE))
576 dev_err(dev, "Error moving from PM state: %s to: %s\n",
577 to_mhi_pm_state_str(cur_state),
578 to_mhi_pm_state_str(MHI_PM_DISABLE));
581 dev_dbg(dev, "Exiting with PM state: %s, MHI state: %s\n",
582 to_mhi_pm_state_str(mhi_cntrl->pm_state),
583 TO_MHI_STATE_STR(mhi_cntrl->dev_state));
585 mutex_unlock(&mhi_cntrl->pm_mutex);
588 /* Queue a new work item and schedule work */
589 int mhi_queue_state_transition(struct mhi_controller *mhi_cntrl,
590 enum dev_st_transition state)
592 struct state_transition *item = kmalloc(sizeof(*item), GFP_ATOMIC);
599 spin_lock_irqsave(&mhi_cntrl->transition_lock, flags);
600 list_add_tail(&item->node, &mhi_cntrl->transition_list);
601 spin_unlock_irqrestore(&mhi_cntrl->transition_lock, flags);
603 schedule_work(&mhi_cntrl->st_worker);
609 void mhi_pm_sys_err_handler(struct mhi_controller *mhi_cntrl)
611 struct device *dev = &mhi_cntrl->mhi_dev->dev;
613 /* skip if controller supports RDDM */
614 if (mhi_cntrl->rddm_image) {
615 dev_dbg(dev, "Controller supports RDDM, skip SYS_ERROR\n");
619 mhi_queue_state_transition(mhi_cntrl, DEV_ST_TRANSITION_SYS_ERR);
622 /* Device State Transition worker */
623 void mhi_pm_st_worker(struct work_struct *work)
625 struct state_transition *itr, *tmp;
627 struct mhi_controller *mhi_cntrl = container_of(work,
628 struct mhi_controller,
630 struct device *dev = &mhi_cntrl->mhi_dev->dev;
632 spin_lock_irq(&mhi_cntrl->transition_lock);
633 list_splice_tail_init(&mhi_cntrl->transition_list, &head);
634 spin_unlock_irq(&mhi_cntrl->transition_lock);
636 list_for_each_entry_safe(itr, tmp, &head, node) {
637 list_del(&itr->node);
638 dev_dbg(dev, "Handling state transition: %s\n",
639 TO_DEV_STATE_TRANS_STR(itr->state));
641 switch (itr->state) {
642 case DEV_ST_TRANSITION_PBL:
643 write_lock_irq(&mhi_cntrl->pm_lock);
644 if (MHI_REG_ACCESS_VALID(mhi_cntrl->pm_state))
645 mhi_cntrl->ee = mhi_get_exec_env(mhi_cntrl);
646 write_unlock_irq(&mhi_cntrl->pm_lock);
647 if (MHI_IN_PBL(mhi_cntrl->ee))
648 mhi_fw_load_handler(mhi_cntrl);
650 case DEV_ST_TRANSITION_SBL:
651 write_lock_irq(&mhi_cntrl->pm_lock);
652 mhi_cntrl->ee = MHI_EE_SBL;
653 write_unlock_irq(&mhi_cntrl->pm_lock);
655 * The MHI devices are only created when the client
656 * device switches its Execution Environment (EE) to
657 * either SBL or AMSS states
659 mhi_create_devices(mhi_cntrl);
661 case DEV_ST_TRANSITION_MISSION_MODE:
662 mhi_pm_mission_mode_transition(mhi_cntrl);
664 case DEV_ST_TRANSITION_READY:
665 mhi_ready_state_transition(mhi_cntrl);
667 case DEV_ST_TRANSITION_SYS_ERR:
668 mhi_pm_disable_transition
669 (mhi_cntrl, MHI_PM_SYS_ERR_PROCESS);
671 case DEV_ST_TRANSITION_DISABLE:
672 mhi_pm_disable_transition
673 (mhi_cntrl, MHI_PM_SHUTDOWN_PROCESS);
682 int mhi_pm_suspend(struct mhi_controller *mhi_cntrl)
684 struct mhi_chan *itr, *tmp;
685 struct device *dev = &mhi_cntrl->mhi_dev->dev;
686 enum mhi_pm_state new_state;
689 if (mhi_cntrl->pm_state == MHI_PM_DISABLE)
692 if (MHI_PM_IN_ERROR_STATE(mhi_cntrl->pm_state))
695 /* Return busy if there are any pending resources */
696 if (atomic_read(&mhi_cntrl->dev_wake) ||
697 atomic_read(&mhi_cntrl->pending_pkts))
700 /* Take MHI out of M2 state */
701 read_lock_bh(&mhi_cntrl->pm_lock);
702 mhi_cntrl->wake_get(mhi_cntrl, false);
703 read_unlock_bh(&mhi_cntrl->pm_lock);
705 ret = wait_event_timeout(mhi_cntrl->state_event,
706 mhi_cntrl->dev_state == MHI_STATE_M0 ||
707 mhi_cntrl->dev_state == MHI_STATE_M1 ||
708 MHI_PM_IN_ERROR_STATE(mhi_cntrl->pm_state),
709 msecs_to_jiffies(mhi_cntrl->timeout_ms));
711 read_lock_bh(&mhi_cntrl->pm_lock);
712 mhi_cntrl->wake_put(mhi_cntrl, false);
713 read_unlock_bh(&mhi_cntrl->pm_lock);
715 if (!ret || MHI_PM_IN_ERROR_STATE(mhi_cntrl->pm_state)) {
717 "Could not enter M0/M1 state");
721 write_lock_irq(&mhi_cntrl->pm_lock);
723 if (atomic_read(&mhi_cntrl->dev_wake) ||
724 atomic_read(&mhi_cntrl->pending_pkts)) {
725 write_unlock_irq(&mhi_cntrl->pm_lock);
729 dev_info(dev, "Allowing M3 transition\n");
730 new_state = mhi_tryset_pm_state(mhi_cntrl, MHI_PM_M3_ENTER);
731 if (new_state != MHI_PM_M3_ENTER) {
732 write_unlock_irq(&mhi_cntrl->pm_lock);
734 "Error setting to PM state: %s from: %s\n",
735 to_mhi_pm_state_str(MHI_PM_M3_ENTER),
736 to_mhi_pm_state_str(mhi_cntrl->pm_state));
740 /* Set MHI to M3 and wait for completion */
741 mhi_set_mhi_state(mhi_cntrl, MHI_STATE_M3);
742 write_unlock_irq(&mhi_cntrl->pm_lock);
743 dev_info(dev, "Wait for M3 completion\n");
745 ret = wait_event_timeout(mhi_cntrl->state_event,
746 mhi_cntrl->dev_state == MHI_STATE_M3 ||
747 MHI_PM_IN_ERROR_STATE(mhi_cntrl->pm_state),
748 msecs_to_jiffies(mhi_cntrl->timeout_ms));
750 if (!ret || MHI_PM_IN_ERROR_STATE(mhi_cntrl->pm_state)) {
752 "Did not enter M3 state, MHI state: %s, PM state: %s\n",
753 TO_MHI_STATE_STR(mhi_cntrl->dev_state),
754 to_mhi_pm_state_str(mhi_cntrl->pm_state));
758 /* Notify clients about entering LPM */
759 list_for_each_entry_safe(itr, tmp, &mhi_cntrl->lpm_chans, node) {
760 mutex_lock(&itr->mutex);
762 mhi_notify(itr->mhi_dev, MHI_CB_LPM_ENTER);
763 mutex_unlock(&itr->mutex);
768 EXPORT_SYMBOL_GPL(mhi_pm_suspend);
770 int mhi_pm_resume(struct mhi_controller *mhi_cntrl)
772 struct mhi_chan *itr, *tmp;
773 struct device *dev = &mhi_cntrl->mhi_dev->dev;
774 enum mhi_pm_state cur_state;
777 dev_info(dev, "Entered with PM state: %s, MHI state: %s\n",
778 to_mhi_pm_state_str(mhi_cntrl->pm_state),
779 TO_MHI_STATE_STR(mhi_cntrl->dev_state));
781 if (mhi_cntrl->pm_state == MHI_PM_DISABLE)
784 if (MHI_PM_IN_ERROR_STATE(mhi_cntrl->pm_state))
787 /* Notify clients about exiting LPM */
788 list_for_each_entry_safe(itr, tmp, &mhi_cntrl->lpm_chans, node) {
789 mutex_lock(&itr->mutex);
791 mhi_notify(itr->mhi_dev, MHI_CB_LPM_EXIT);
792 mutex_unlock(&itr->mutex);
795 write_lock_irq(&mhi_cntrl->pm_lock);
796 cur_state = mhi_tryset_pm_state(mhi_cntrl, MHI_PM_M3_EXIT);
797 if (cur_state != MHI_PM_M3_EXIT) {
798 write_unlock_irq(&mhi_cntrl->pm_lock);
800 "Error setting to PM state: %s from: %s\n",
801 to_mhi_pm_state_str(MHI_PM_M3_EXIT),
802 to_mhi_pm_state_str(mhi_cntrl->pm_state));
806 /* Set MHI to M0 and wait for completion */
807 mhi_set_mhi_state(mhi_cntrl, MHI_STATE_M0);
808 write_unlock_irq(&mhi_cntrl->pm_lock);
810 ret = wait_event_timeout(mhi_cntrl->state_event,
811 mhi_cntrl->dev_state == MHI_STATE_M0 ||
812 mhi_cntrl->dev_state == MHI_STATE_M2 ||
813 MHI_PM_IN_ERROR_STATE(mhi_cntrl->pm_state),
814 msecs_to_jiffies(mhi_cntrl->timeout_ms));
816 if (!ret || MHI_PM_IN_ERROR_STATE(mhi_cntrl->pm_state)) {
818 "Did not enter M0 state, MHI state: %s, PM state: %s\n",
819 TO_MHI_STATE_STR(mhi_cntrl->dev_state),
820 to_mhi_pm_state_str(mhi_cntrl->pm_state));
826 EXPORT_SYMBOL_GPL(mhi_pm_resume);
828 int __mhi_device_get_sync(struct mhi_controller *mhi_cntrl)
832 /* Wake up the device */
833 read_lock_bh(&mhi_cntrl->pm_lock);
834 mhi_cntrl->wake_get(mhi_cntrl, true);
835 if (MHI_PM_IN_SUSPEND_STATE(mhi_cntrl->pm_state))
836 mhi_trigger_resume(mhi_cntrl);
837 read_unlock_bh(&mhi_cntrl->pm_lock);
839 ret = wait_event_timeout(mhi_cntrl->state_event,
840 mhi_cntrl->pm_state == MHI_PM_M0 ||
841 MHI_PM_IN_ERROR_STATE(mhi_cntrl->pm_state),
842 msecs_to_jiffies(mhi_cntrl->timeout_ms));
844 if (!ret || MHI_PM_IN_ERROR_STATE(mhi_cntrl->pm_state)) {
845 read_lock_bh(&mhi_cntrl->pm_lock);
846 mhi_cntrl->wake_put(mhi_cntrl, false);
847 read_unlock_bh(&mhi_cntrl->pm_lock);
854 /* Assert device wake db */
855 static void mhi_assert_dev_wake(struct mhi_controller *mhi_cntrl, bool force)
860 * If force flag is set, then increment the wake count value and
863 if (unlikely(force)) {
864 spin_lock_irqsave(&mhi_cntrl->wlock, flags);
865 atomic_inc(&mhi_cntrl->dev_wake);
866 if (MHI_WAKE_DB_FORCE_SET_VALID(mhi_cntrl->pm_state) &&
867 !mhi_cntrl->wake_set) {
868 mhi_write_db(mhi_cntrl, mhi_cntrl->wake_db, 1);
869 mhi_cntrl->wake_set = true;
871 spin_unlock_irqrestore(&mhi_cntrl->wlock, flags);
874 * If resources are already requested, then just increment
875 * the wake count value and return
877 if (likely(atomic_add_unless(&mhi_cntrl->dev_wake, 1, 0)))
880 spin_lock_irqsave(&mhi_cntrl->wlock, flags);
881 if ((atomic_inc_return(&mhi_cntrl->dev_wake) == 1) &&
882 MHI_WAKE_DB_SET_VALID(mhi_cntrl->pm_state) &&
883 !mhi_cntrl->wake_set) {
884 mhi_write_db(mhi_cntrl, mhi_cntrl->wake_db, 1);
885 mhi_cntrl->wake_set = true;
887 spin_unlock_irqrestore(&mhi_cntrl->wlock, flags);
891 /* De-assert device wake db */
892 static void mhi_deassert_dev_wake(struct mhi_controller *mhi_cntrl,
898 * Only continue if there is a single resource, else just decrement
901 if (likely(atomic_add_unless(&mhi_cntrl->dev_wake, -1, 1)))
904 spin_lock_irqsave(&mhi_cntrl->wlock, flags);
905 if ((atomic_dec_return(&mhi_cntrl->dev_wake) == 0) &&
906 MHI_WAKE_DB_CLEAR_VALID(mhi_cntrl->pm_state) && !override &&
907 mhi_cntrl->wake_set) {
908 mhi_write_db(mhi_cntrl, mhi_cntrl->wake_db, 0);
909 mhi_cntrl->wake_set = false;
911 spin_unlock_irqrestore(&mhi_cntrl->wlock, flags);
914 int mhi_async_power_up(struct mhi_controller *mhi_cntrl)
916 enum mhi_state state;
917 enum mhi_ee_type current_ee;
918 enum dev_st_transition next_state;
919 struct device *dev = &mhi_cntrl->mhi_dev->dev;
923 dev_info(dev, "Requested to power ON\n");
925 if (mhi_cntrl->nr_irqs < 1)
928 /* Supply default wake routines if not provided by controller driver */
929 if (!mhi_cntrl->wake_get || !mhi_cntrl->wake_put ||
930 !mhi_cntrl->wake_toggle) {
931 mhi_cntrl->wake_get = mhi_assert_dev_wake;
932 mhi_cntrl->wake_put = mhi_deassert_dev_wake;
933 mhi_cntrl->wake_toggle = (mhi_cntrl->db_access & MHI_PM_M2) ?
934 mhi_toggle_dev_wake_nop : mhi_toggle_dev_wake;
937 mutex_lock(&mhi_cntrl->pm_mutex);
938 mhi_cntrl->pm_state = MHI_PM_DISABLE;
940 if (!mhi_cntrl->pre_init) {
941 /* Setup device context */
942 ret = mhi_init_dev_ctxt(mhi_cntrl);
947 ret = mhi_init_irq_setup(mhi_cntrl);
949 goto error_setup_irq;
951 /* Setup BHI offset & INTVEC */
952 write_lock_irq(&mhi_cntrl->pm_lock);
953 ret = mhi_read_reg(mhi_cntrl, mhi_cntrl->regs, BHIOFF, &val);
955 write_unlock_irq(&mhi_cntrl->pm_lock);
956 goto error_bhi_offset;
959 mhi_cntrl->bhi = mhi_cntrl->regs + val;
961 /* Setup BHIE offset */
962 if (mhi_cntrl->fbc_download) {
963 ret = mhi_read_reg(mhi_cntrl, mhi_cntrl->regs, BHIEOFF, &val);
965 write_unlock_irq(&mhi_cntrl->pm_lock);
966 dev_err(dev, "Error reading BHIE offset\n");
967 goto error_bhi_offset;
970 mhi_cntrl->bhie = mhi_cntrl->regs + val;
973 mhi_write_reg(mhi_cntrl, mhi_cntrl->bhi, BHI_INTVEC, 0);
974 mhi_cntrl->pm_state = MHI_PM_POR;
975 mhi_cntrl->ee = MHI_EE_MAX;
976 current_ee = mhi_get_exec_env(mhi_cntrl);
977 write_unlock_irq(&mhi_cntrl->pm_lock);
979 /* Confirm that the device is in valid exec env */
980 if (!MHI_IN_PBL(current_ee) && current_ee != MHI_EE_AMSS) {
981 dev_err(dev, "Not a valid EE for power on\n");
983 goto error_bhi_offset;
986 state = mhi_get_mhi_state(mhi_cntrl);
987 if (state == MHI_STATE_SYS_ERR) {
988 mhi_set_mhi_state(mhi_cntrl, MHI_STATE_RESET);
989 ret = wait_event_timeout(mhi_cntrl->state_event,
990 MHI_PM_IN_FATAL_STATE(mhi_cntrl->pm_state) ||
991 mhi_read_reg_field(mhi_cntrl,
998 msecs_to_jiffies(mhi_cntrl->timeout_ms));
1001 dev_info(dev, "Failed to reset MHI due to syserr state\n");
1002 goto error_bhi_offset;
1006 * device cleares INTVEC as part of RESET processing,
1009 mhi_write_reg(mhi_cntrl, mhi_cntrl->bhi, BHI_INTVEC, 0);
1012 /* Transition to next state */
1013 next_state = MHI_IN_PBL(current_ee) ?
1014 DEV_ST_TRANSITION_PBL : DEV_ST_TRANSITION_READY;
1016 mhi_queue_state_transition(mhi_cntrl, next_state);
1018 mutex_unlock(&mhi_cntrl->pm_mutex);
1020 dev_info(dev, "Power on setup success\n");
1025 mhi_deinit_free_irq(mhi_cntrl);
1028 if (!mhi_cntrl->pre_init)
1029 mhi_deinit_dev_ctxt(mhi_cntrl);
1032 mutex_unlock(&mhi_cntrl->pm_mutex);
1036 EXPORT_SYMBOL_GPL(mhi_async_power_up);
1038 void mhi_power_down(struct mhi_controller *mhi_cntrl, bool graceful)
1040 enum mhi_pm_state cur_state;
1041 struct device *dev = &mhi_cntrl->mhi_dev->dev;
1043 /* If it's not a graceful shutdown, force MHI to linkdown state */
1045 mutex_lock(&mhi_cntrl->pm_mutex);
1046 write_lock_irq(&mhi_cntrl->pm_lock);
1047 cur_state = mhi_tryset_pm_state(mhi_cntrl,
1048 MHI_PM_LD_ERR_FATAL_DETECT);
1049 write_unlock_irq(&mhi_cntrl->pm_lock);
1050 mutex_unlock(&mhi_cntrl->pm_mutex);
1051 if (cur_state != MHI_PM_LD_ERR_FATAL_DETECT)
1052 dev_dbg(dev, "Failed to move to state: %s from: %s\n",
1053 to_mhi_pm_state_str(MHI_PM_LD_ERR_FATAL_DETECT),
1054 to_mhi_pm_state_str(mhi_cntrl->pm_state));
1057 mhi_queue_state_transition(mhi_cntrl, DEV_ST_TRANSITION_DISABLE);
1059 /* Wait for shutdown to complete */
1060 flush_work(&mhi_cntrl->st_worker);
1062 mhi_deinit_free_irq(mhi_cntrl);
1064 if (!mhi_cntrl->pre_init) {
1065 /* Free all allocated resources */
1066 if (mhi_cntrl->fbc_image) {
1067 mhi_free_bhie_table(mhi_cntrl, mhi_cntrl->fbc_image);
1068 mhi_cntrl->fbc_image = NULL;
1070 mhi_deinit_dev_ctxt(mhi_cntrl);
1073 EXPORT_SYMBOL_GPL(mhi_power_down);
1075 int mhi_sync_power_up(struct mhi_controller *mhi_cntrl)
1077 int ret = mhi_async_power_up(mhi_cntrl);
1082 wait_event_timeout(mhi_cntrl->state_event,
1083 MHI_IN_MISSION_MODE(mhi_cntrl->ee) ||
1084 MHI_PM_IN_ERROR_STATE(mhi_cntrl->pm_state),
1085 msecs_to_jiffies(mhi_cntrl->timeout_ms));
1087 ret = (MHI_IN_MISSION_MODE(mhi_cntrl->ee)) ? 0 : -ETIMEDOUT;
1089 mhi_power_down(mhi_cntrl, false);
1093 EXPORT_SYMBOL(mhi_sync_power_up);
1095 int mhi_force_rddm_mode(struct mhi_controller *mhi_cntrl)
1097 struct device *dev = &mhi_cntrl->mhi_dev->dev;
1100 /* Check if device is already in RDDM */
1101 if (mhi_cntrl->ee == MHI_EE_RDDM)
1104 dev_dbg(dev, "Triggering SYS_ERR to force RDDM state\n");
1105 mhi_set_mhi_state(mhi_cntrl, MHI_STATE_SYS_ERR);
1107 /* Wait for RDDM event */
1108 ret = wait_event_timeout(mhi_cntrl->state_event,
1109 mhi_cntrl->ee == MHI_EE_RDDM,
1110 msecs_to_jiffies(mhi_cntrl->timeout_ms));
1111 ret = ret ? 0 : -EIO;
1115 EXPORT_SYMBOL_GPL(mhi_force_rddm_mode);
1117 void mhi_device_get(struct mhi_device *mhi_dev)
1119 struct mhi_controller *mhi_cntrl = mhi_dev->mhi_cntrl;
1121 mhi_dev->dev_wake++;
1122 read_lock_bh(&mhi_cntrl->pm_lock);
1123 if (MHI_PM_IN_SUSPEND_STATE(mhi_cntrl->pm_state))
1124 mhi_trigger_resume(mhi_cntrl);
1126 mhi_cntrl->wake_get(mhi_cntrl, true);
1127 read_unlock_bh(&mhi_cntrl->pm_lock);
1129 EXPORT_SYMBOL_GPL(mhi_device_get);
1131 int mhi_device_get_sync(struct mhi_device *mhi_dev)
1133 struct mhi_controller *mhi_cntrl = mhi_dev->mhi_cntrl;
1136 ret = __mhi_device_get_sync(mhi_cntrl);
1138 mhi_dev->dev_wake++;
1142 EXPORT_SYMBOL_GPL(mhi_device_get_sync);
1144 void mhi_device_put(struct mhi_device *mhi_dev)
1146 struct mhi_controller *mhi_cntrl = mhi_dev->mhi_cntrl;
1148 mhi_dev->dev_wake--;
1149 read_lock_bh(&mhi_cntrl->pm_lock);
1150 if (MHI_PM_IN_SUSPEND_STATE(mhi_cntrl->pm_state))
1151 mhi_trigger_resume(mhi_cntrl);
1153 mhi_cntrl->wake_put(mhi_cntrl, false);
1154 read_unlock_bh(&mhi_cntrl->pm_lock);
1156 EXPORT_SYMBOL_GPL(mhi_device_put);