2 * Universal Flash Storage Host controller driver Core
4 * This code is based on drivers/scsi/ufs/ufshcd.c
5 * Copyright (C) 2011-2013 Samsung India Software Operations
6 * Copyright (c) 2013-2014, The Linux Foundation. All rights reserved.
9 * Santosh Yaraganavi <santosh.sy@samsung.com>
10 * Vinayak Holikatti <h.vinayak@samsung.com>
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version 2
15 * of the License, or (at your option) any later version.
16 * See the COPYING file in the top-level directory or visit
17 * <http://www.gnu.org/licenses/gpl-2.0.html>
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * This program is provided "AS IS" and "WITH ALL FAULTS" and
25 * without warranty of any kind. You are solely responsible for
26 * determining the appropriateness of using and distributing
27 * the program and assume all risks associated with your exercise
28 * of rights with respect to the program, including but not limited
29 * to infringement of third party rights, the risks and costs of
30 * program errors, damage to or loss of data, programs or equipment,
31 * and unavailability or interruption of operations. Under no
32 * circumstances will the contributor of this Program be liable for
33 * any damages of any kind arising from your use or distribution of
36 * The Linux Foundation chooses to take subject only to the GPLv2
37 * license terms, and distributes only under these terms.
40 #include <linux/async.h>
41 #include <linux/devfreq.h>
46 #define UFSHCD_ENABLE_INTRS (UTP_TRANSFER_REQ_COMPL |\
49 /* UIC command timeout, unit: ms */
50 #define UIC_CMD_TIMEOUT 500
52 /* NOP OUT retries waiting for NOP IN response */
53 #define NOP_OUT_RETRIES 10
54 /* Timeout after 30 msecs if NOP OUT hangs without response */
55 #define NOP_OUT_TIMEOUT 30 /* msecs */
57 /* Query request retries */
58 #define QUERY_REQ_RETRIES 10
59 /* Query request timeout */
60 #define QUERY_REQ_TIMEOUT 30 /* msec */
62 /* Task management command timeout */
63 #define TM_CMD_TIMEOUT 100 /* msecs */
65 /* maximum number of link-startup retries */
66 #define DME_LINKSTARTUP_RETRIES 3
68 /* maximum number of reset retries before giving up */
69 #define MAX_HOST_RESET_RETRIES 5
71 /* Expose the flag value from utp_upiu_query.value */
72 #define MASK_QUERY_UPIU_FLAG_LOC 0xFF
74 /* Interrupt aggregation default timeout, unit: 40us */
75 #define INT_AGGR_DEF_TO 0x02
77 #define ufshcd_toggle_vreg(_dev, _vreg, _on) \
81 _ret = ufshcd_enable_vreg(_dev, _vreg); \
83 _ret = ufshcd_disable_vreg(_dev, _vreg); \
87 static u32 ufs_query_desc_max_size[] = {
88 QUERY_DESC_DEVICE_MAX_SIZE,
89 QUERY_DESC_CONFIGURAION_MAX_SIZE,
90 QUERY_DESC_UNIT_MAX_SIZE,
91 QUERY_DESC_RFU_MAX_SIZE,
92 QUERY_DESC_INTERCONNECT_MAX_SIZE,
93 QUERY_DESC_STRING_MAX_SIZE,
94 QUERY_DESC_RFU_MAX_SIZE,
95 QUERY_DESC_GEOMETRY_MAZ_SIZE,
96 QUERY_DESC_POWER_MAX_SIZE,
97 QUERY_DESC_RFU_MAX_SIZE,
101 UFSHCD_MAX_CHANNEL = 0,
103 UFSHCD_CMD_PER_LUN = 32,
104 UFSHCD_CAN_QUEUE = 32,
111 UFSHCD_STATE_OPERATIONAL,
114 /* UFSHCD error handling flags */
116 UFSHCD_EH_IN_PROGRESS = (1 << 0),
119 /* UFSHCD UIC layer error flags */
121 UFSHCD_UIC_DL_PA_INIT_ERROR = (1 << 0), /* Data link layer error */
122 UFSHCD_UIC_NL_ERROR = (1 << 1), /* Network layer error */
123 UFSHCD_UIC_TL_ERROR = (1 << 2), /* Transport Layer error */
124 UFSHCD_UIC_DME_ERROR = (1 << 3), /* DME error */
127 /* Interrupt configuration options */
134 #define ufshcd_set_eh_in_progress(h) \
135 (h->eh_flags |= UFSHCD_EH_IN_PROGRESS)
136 #define ufshcd_eh_in_progress(h) \
137 (h->eh_flags & UFSHCD_EH_IN_PROGRESS)
138 #define ufshcd_clear_eh_in_progress(h) \
139 (h->eh_flags &= ~UFSHCD_EH_IN_PROGRESS)
141 #define ufshcd_set_ufs_dev_active(h) \
142 ((h)->curr_dev_pwr_mode = UFS_ACTIVE_PWR_MODE)
143 #define ufshcd_set_ufs_dev_sleep(h) \
144 ((h)->curr_dev_pwr_mode = UFS_SLEEP_PWR_MODE)
145 #define ufshcd_set_ufs_dev_poweroff(h) \
146 ((h)->curr_dev_pwr_mode = UFS_POWERDOWN_PWR_MODE)
147 #define ufshcd_is_ufs_dev_active(h) \
148 ((h)->curr_dev_pwr_mode == UFS_ACTIVE_PWR_MODE)
149 #define ufshcd_is_ufs_dev_sleep(h) \
150 ((h)->curr_dev_pwr_mode == UFS_SLEEP_PWR_MODE)
151 #define ufshcd_is_ufs_dev_poweroff(h) \
152 ((h)->curr_dev_pwr_mode == UFS_POWERDOWN_PWR_MODE)
154 static struct ufs_pm_lvl_states ufs_pm_lvl_states[] = {
155 {UFS_ACTIVE_PWR_MODE, UIC_LINK_ACTIVE_STATE},
156 {UFS_ACTIVE_PWR_MODE, UIC_LINK_HIBERN8_STATE},
157 {UFS_SLEEP_PWR_MODE, UIC_LINK_ACTIVE_STATE},
158 {UFS_SLEEP_PWR_MODE, UIC_LINK_HIBERN8_STATE},
159 {UFS_POWERDOWN_PWR_MODE, UIC_LINK_HIBERN8_STATE},
160 {UFS_POWERDOWN_PWR_MODE, UIC_LINK_OFF_STATE},
163 static inline enum ufs_dev_pwr_mode
164 ufs_get_pm_lvl_to_dev_pwr_mode(enum ufs_pm_level lvl)
166 return ufs_pm_lvl_states[lvl].dev_state;
169 static inline enum uic_link_state
170 ufs_get_pm_lvl_to_link_pwr_state(enum ufs_pm_level lvl)
172 return ufs_pm_lvl_states[lvl].link_state;
175 static void ufshcd_tmc_handler(struct ufs_hba *hba);
176 static void ufshcd_async_scan(void *data, async_cookie_t cookie);
177 static int ufshcd_reset_and_restore(struct ufs_hba *hba);
178 static int ufshcd_clear_tm_cmd(struct ufs_hba *hba, int tag);
179 static void ufshcd_hba_exit(struct ufs_hba *hba);
180 static int ufshcd_probe_hba(struct ufs_hba *hba);
181 static int __ufshcd_setup_clocks(struct ufs_hba *hba, bool on,
183 static int ufshcd_setup_clocks(struct ufs_hba *hba, bool on);
184 static int ufshcd_uic_hibern8_exit(struct ufs_hba *hba);
185 static int ufshcd_uic_hibern8_enter(struct ufs_hba *hba);
186 static int ufshcd_host_reset_and_restore(struct ufs_hba *hba);
187 static irqreturn_t ufshcd_intr(int irq, void *__hba);
188 static int ufshcd_config_pwr_mode(struct ufs_hba *hba,
189 struct ufs_pa_layer_attr *desired_pwr_mode);
191 static inline int ufshcd_enable_irq(struct ufs_hba *hba)
195 if (!hba->is_irq_enabled) {
196 ret = request_irq(hba->irq, ufshcd_intr, IRQF_SHARED, UFSHCD,
199 dev_err(hba->dev, "%s: request_irq failed, ret=%d\n",
201 hba->is_irq_enabled = true;
207 static inline void ufshcd_disable_irq(struct ufs_hba *hba)
209 if (hba->is_irq_enabled) {
210 free_irq(hba->irq, hba);
211 hba->is_irq_enabled = false;
216 * ufshcd_wait_for_register - wait for register value to change
217 * @hba - per-adapter interface
218 * @reg - mmio register offset
219 * @mask - mask to apply to read register value
220 * @val - wait condition
221 * @interval_us - polling interval in microsecs
222 * @timeout_ms - timeout in millisecs
224 * Returns -ETIMEDOUT on error, zero on success
226 static int ufshcd_wait_for_register(struct ufs_hba *hba, u32 reg, u32 mask,
227 u32 val, unsigned long interval_us, unsigned long timeout_ms)
230 unsigned long timeout = jiffies + msecs_to_jiffies(timeout_ms);
232 /* ignore bits that we don't intend to wait on */
235 while ((ufshcd_readl(hba, reg) & mask) != val) {
236 /* wakeup within 50us of expiry */
237 usleep_range(interval_us, interval_us + 50);
239 if (time_after(jiffies, timeout)) {
240 if ((ufshcd_readl(hba, reg) & mask) != val)
250 * ufshcd_get_intr_mask - Get the interrupt bit mask
251 * @hba - Pointer to adapter instance
253 * Returns interrupt bit mask per version
255 static inline u32 ufshcd_get_intr_mask(struct ufs_hba *hba)
257 if (hba->ufs_version == UFSHCI_VERSION_10)
258 return INTERRUPT_MASK_ALL_VER_10;
260 return INTERRUPT_MASK_ALL_VER_11;
264 * ufshcd_get_ufs_version - Get the UFS version supported by the HBA
265 * @hba - Pointer to adapter instance
267 * Returns UFSHCI version supported by the controller
269 static inline u32 ufshcd_get_ufs_version(struct ufs_hba *hba)
271 return ufshcd_readl(hba, REG_UFS_VERSION);
275 * ufshcd_is_device_present - Check if any device connected to
276 * the host controller
277 * @hba: pointer to adapter instance
279 * Returns 1 if device present, 0 if no device detected
281 static inline int ufshcd_is_device_present(struct ufs_hba *hba)
283 return (ufshcd_readl(hba, REG_CONTROLLER_STATUS) &
284 DEVICE_PRESENT) ? 1 : 0;
288 * ufshcd_get_tr_ocs - Get the UTRD Overall Command Status
289 * @lrb: pointer to local command reference block
291 * This function is used to get the OCS field from UTRD
292 * Returns the OCS field in the UTRD
294 static inline int ufshcd_get_tr_ocs(struct ufshcd_lrb *lrbp)
296 return le32_to_cpu(lrbp->utr_descriptor_ptr->header.dword_2) & MASK_OCS;
300 * ufshcd_get_tmr_ocs - Get the UTMRD Overall Command Status
301 * @task_req_descp: pointer to utp_task_req_desc structure
303 * This function is used to get the OCS field from UTMRD
304 * Returns the OCS field in the UTMRD
307 ufshcd_get_tmr_ocs(struct utp_task_req_desc *task_req_descp)
309 return le32_to_cpu(task_req_descp->header.dword_2) & MASK_OCS;
313 * ufshcd_get_tm_free_slot - get a free slot for task management request
314 * @hba: per adapter instance
315 * @free_slot: pointer to variable with available slot value
317 * Get a free tag and lock it until ufshcd_put_tm_slot() is called.
318 * Returns 0 if free slot is not available, else return 1 with tag value
321 static bool ufshcd_get_tm_free_slot(struct ufs_hba *hba, int *free_slot)
330 tag = find_first_zero_bit(&hba->tm_slots_in_use, hba->nutmrs);
331 if (tag >= hba->nutmrs)
333 } while (test_and_set_bit_lock(tag, &hba->tm_slots_in_use));
341 static inline void ufshcd_put_tm_slot(struct ufs_hba *hba, int slot)
343 clear_bit_unlock(slot, &hba->tm_slots_in_use);
347 * ufshcd_utrl_clear - Clear a bit in UTRLCLR register
348 * @hba: per adapter instance
349 * @pos: position of the bit to be cleared
351 static inline void ufshcd_utrl_clear(struct ufs_hba *hba, u32 pos)
353 ufshcd_writel(hba, ~(1 << pos), REG_UTP_TRANSFER_REQ_LIST_CLEAR);
357 * ufshcd_get_lists_status - Check UCRDY, UTRLRDY and UTMRLRDY
358 * @reg: Register value of host controller status
360 * Returns integer, 0 on Success and positive value if failed
362 static inline int ufshcd_get_lists_status(u32 reg)
365 * The mask 0xFF is for the following HCS register bits
375 return (((reg) & (0xFF)) >> 1) ^ (0x07);
379 * ufshcd_get_uic_cmd_result - Get the UIC command result
380 * @hba: Pointer to adapter instance
382 * This function gets the result of UIC command completion
383 * Returns 0 on success, non zero value on error
385 static inline int ufshcd_get_uic_cmd_result(struct ufs_hba *hba)
387 return ufshcd_readl(hba, REG_UIC_COMMAND_ARG_2) &
388 MASK_UIC_COMMAND_RESULT;
392 * ufshcd_get_dme_attr_val - Get the value of attribute returned by UIC command
393 * @hba: Pointer to adapter instance
395 * This function gets UIC command argument3
396 * Returns 0 on success, non zero value on error
398 static inline u32 ufshcd_get_dme_attr_val(struct ufs_hba *hba)
400 return ufshcd_readl(hba, REG_UIC_COMMAND_ARG_3);
404 * ufshcd_get_req_rsp - returns the TR response transaction type
405 * @ucd_rsp_ptr: pointer to response UPIU
408 ufshcd_get_req_rsp(struct utp_upiu_rsp *ucd_rsp_ptr)
410 return be32_to_cpu(ucd_rsp_ptr->header.dword_0) >> 24;
414 * ufshcd_get_rsp_upiu_result - Get the result from response UPIU
415 * @ucd_rsp_ptr: pointer to response UPIU
417 * This function gets the response status and scsi_status from response UPIU
418 * Returns the response result code.
421 ufshcd_get_rsp_upiu_result(struct utp_upiu_rsp *ucd_rsp_ptr)
423 return be32_to_cpu(ucd_rsp_ptr->header.dword_1) & MASK_RSP_UPIU_RESULT;
427 * ufshcd_get_rsp_upiu_data_seg_len - Get the data segment length
429 * @ucd_rsp_ptr: pointer to response UPIU
431 * Return the data segment length.
433 static inline unsigned int
434 ufshcd_get_rsp_upiu_data_seg_len(struct utp_upiu_rsp *ucd_rsp_ptr)
436 return be32_to_cpu(ucd_rsp_ptr->header.dword_2) &
437 MASK_RSP_UPIU_DATA_SEG_LEN;
441 * ufshcd_is_exception_event - Check if the device raised an exception event
442 * @ucd_rsp_ptr: pointer to response UPIU
444 * The function checks if the device raised an exception event indicated in
445 * the Device Information field of response UPIU.
447 * Returns true if exception is raised, false otherwise.
449 static inline bool ufshcd_is_exception_event(struct utp_upiu_rsp *ucd_rsp_ptr)
451 return be32_to_cpu(ucd_rsp_ptr->header.dword_2) &
452 MASK_RSP_EXCEPTION_EVENT ? true : false;
456 * ufshcd_reset_intr_aggr - Reset interrupt aggregation values.
457 * @hba: per adapter instance
460 ufshcd_reset_intr_aggr(struct ufs_hba *hba)
462 ufshcd_writel(hba, INT_AGGR_ENABLE |
463 INT_AGGR_COUNTER_AND_TIMER_RESET,
464 REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL);
468 * ufshcd_config_intr_aggr - Configure interrupt aggregation values.
469 * @hba: per adapter instance
470 * @cnt: Interrupt aggregation counter threshold
471 * @tmout: Interrupt aggregation timeout value
474 ufshcd_config_intr_aggr(struct ufs_hba *hba, u8 cnt, u8 tmout)
476 ufshcd_writel(hba, INT_AGGR_ENABLE | INT_AGGR_PARAM_WRITE |
477 INT_AGGR_COUNTER_THLD_VAL(cnt) |
478 INT_AGGR_TIMEOUT_VAL(tmout),
479 REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL);
483 * ufshcd_enable_run_stop_reg - Enable run-stop registers,
484 * When run-stop registers are set to 1, it indicates the
485 * host controller that it can process the requests
486 * @hba: per adapter instance
488 static void ufshcd_enable_run_stop_reg(struct ufs_hba *hba)
490 ufshcd_writel(hba, UTP_TASK_REQ_LIST_RUN_STOP_BIT,
491 REG_UTP_TASK_REQ_LIST_RUN_STOP);
492 ufshcd_writel(hba, UTP_TRANSFER_REQ_LIST_RUN_STOP_BIT,
493 REG_UTP_TRANSFER_REQ_LIST_RUN_STOP);
497 * ufshcd_hba_start - Start controller initialization sequence
498 * @hba: per adapter instance
500 static inline void ufshcd_hba_start(struct ufs_hba *hba)
502 ufshcd_writel(hba, CONTROLLER_ENABLE, REG_CONTROLLER_ENABLE);
506 * ufshcd_is_hba_active - Get controller state
507 * @hba: per adapter instance
509 * Returns zero if controller is active, 1 otherwise
511 static inline int ufshcd_is_hba_active(struct ufs_hba *hba)
513 return (ufshcd_readl(hba, REG_CONTROLLER_ENABLE) & 0x1) ? 0 : 1;
516 static void ufshcd_ungate_work(struct work_struct *work)
520 struct ufs_hba *hba = container_of(work, struct ufs_hba,
521 clk_gating.ungate_work);
523 cancel_delayed_work_sync(&hba->clk_gating.gate_work);
525 spin_lock_irqsave(hba->host->host_lock, flags);
526 if (hba->clk_gating.state == CLKS_ON) {
527 spin_unlock_irqrestore(hba->host->host_lock, flags);
531 spin_unlock_irqrestore(hba->host->host_lock, flags);
532 ufshcd_setup_clocks(hba, true);
534 /* Exit from hibern8 */
535 if (ufshcd_can_hibern8_during_gating(hba)) {
536 /* Prevent gating in this path */
537 hba->clk_gating.is_suspended = true;
538 if (ufshcd_is_link_hibern8(hba)) {
539 ret = ufshcd_uic_hibern8_exit(hba);
541 dev_err(hba->dev, "%s: hibern8 exit failed %d\n",
544 ufshcd_set_link_active(hba);
546 hba->clk_gating.is_suspended = false;
549 if (ufshcd_is_clkscaling_enabled(hba))
550 devfreq_resume_device(hba->devfreq);
551 scsi_unblock_requests(hba->host);
555 * ufshcd_hold - Enable clocks that were gated earlier due to ufshcd_release.
556 * Also, exit from hibern8 mode and set the link as active.
557 * @hba: per adapter instance
558 * @async: This indicates whether caller should ungate clocks asynchronously.
560 int ufshcd_hold(struct ufs_hba *hba, bool async)
565 if (!ufshcd_is_clkgating_allowed(hba))
567 spin_lock_irqsave(hba->host->host_lock, flags);
568 hba->clk_gating.active_reqs++;
571 switch (hba->clk_gating.state) {
575 if (cancel_delayed_work(&hba->clk_gating.gate_work)) {
576 hba->clk_gating.state = CLKS_ON;
580 * If we here, it means gating work is either done or
581 * currently running. Hence, fall through to cancel gating
582 * work and to enable clocks.
585 scsi_block_requests(hba->host);
586 hba->clk_gating.state = REQ_CLKS_ON;
587 schedule_work(&hba->clk_gating.ungate_work);
589 * fall through to check if we should wait for this
590 * work to be done or not.
595 hba->clk_gating.active_reqs--;
599 spin_unlock_irqrestore(hba->host->host_lock, flags);
600 flush_work(&hba->clk_gating.ungate_work);
601 /* Make sure state is CLKS_ON before returning */
602 spin_lock_irqsave(hba->host->host_lock, flags);
605 dev_err(hba->dev, "%s: clk gating is in invalid state %d\n",
606 __func__, hba->clk_gating.state);
609 spin_unlock_irqrestore(hba->host->host_lock, flags);
614 static void ufshcd_gate_work(struct work_struct *work)
616 struct ufs_hba *hba = container_of(work, struct ufs_hba,
617 clk_gating.gate_work.work);
620 spin_lock_irqsave(hba->host->host_lock, flags);
621 if (hba->clk_gating.is_suspended) {
622 hba->clk_gating.state = CLKS_ON;
626 if (hba->clk_gating.active_reqs
627 || hba->ufshcd_state != UFSHCD_STATE_OPERATIONAL
628 || hba->lrb_in_use || hba->outstanding_tasks
629 || hba->active_uic_cmd || hba->uic_async_done)
632 spin_unlock_irqrestore(hba->host->host_lock, flags);
634 /* put the link into hibern8 mode before turning off clocks */
635 if (ufshcd_can_hibern8_during_gating(hba)) {
636 if (ufshcd_uic_hibern8_enter(hba)) {
637 hba->clk_gating.state = CLKS_ON;
640 ufshcd_set_link_hibern8(hba);
643 if (ufshcd_is_clkscaling_enabled(hba)) {
644 devfreq_suspend_device(hba->devfreq);
645 hba->clk_scaling.window_start_t = 0;
648 if (!ufshcd_is_link_active(hba))
649 ufshcd_setup_clocks(hba, false);
651 /* If link is active, device ref_clk can't be switched off */
652 __ufshcd_setup_clocks(hba, false, true);
655 * In case you are here to cancel this work the gating state
656 * would be marked as REQ_CLKS_ON. In this case keep the state
657 * as REQ_CLKS_ON which would anyway imply that clocks are off
658 * and a request to turn them on is pending. By doing this way,
659 * we keep the state machine in tact and this would ultimately
660 * prevent from doing cancel work multiple times when there are
661 * new requests arriving before the current cancel work is done.
663 spin_lock_irqsave(hba->host->host_lock, flags);
664 if (hba->clk_gating.state == REQ_CLKS_OFF)
665 hba->clk_gating.state = CLKS_OFF;
668 spin_unlock_irqrestore(hba->host->host_lock, flags);
673 /* host lock must be held before calling this variant */
674 static void __ufshcd_release(struct ufs_hba *hba)
676 if (!ufshcd_is_clkgating_allowed(hba))
679 hba->clk_gating.active_reqs--;
681 if (hba->clk_gating.active_reqs || hba->clk_gating.is_suspended
682 || hba->ufshcd_state != UFSHCD_STATE_OPERATIONAL
683 || hba->lrb_in_use || hba->outstanding_tasks
684 || hba->active_uic_cmd || hba->uic_async_done)
687 hba->clk_gating.state = REQ_CLKS_OFF;
688 schedule_delayed_work(&hba->clk_gating.gate_work,
689 msecs_to_jiffies(hba->clk_gating.delay_ms));
692 void ufshcd_release(struct ufs_hba *hba)
696 spin_lock_irqsave(hba->host->host_lock, flags);
697 __ufshcd_release(hba);
698 spin_unlock_irqrestore(hba->host->host_lock, flags);
701 static ssize_t ufshcd_clkgate_delay_show(struct device *dev,
702 struct device_attribute *attr, char *buf)
704 struct ufs_hba *hba = dev_get_drvdata(dev);
706 return snprintf(buf, PAGE_SIZE, "%lu\n", hba->clk_gating.delay_ms);
709 static ssize_t ufshcd_clkgate_delay_store(struct device *dev,
710 struct device_attribute *attr, const char *buf, size_t count)
712 struct ufs_hba *hba = dev_get_drvdata(dev);
713 unsigned long flags, value;
715 if (kstrtoul(buf, 0, &value))
718 spin_lock_irqsave(hba->host->host_lock, flags);
719 hba->clk_gating.delay_ms = value;
720 spin_unlock_irqrestore(hba->host->host_lock, flags);
724 static void ufshcd_init_clk_gating(struct ufs_hba *hba)
726 if (!ufshcd_is_clkgating_allowed(hba))
729 hba->clk_gating.delay_ms = 150;
730 INIT_DELAYED_WORK(&hba->clk_gating.gate_work, ufshcd_gate_work);
731 INIT_WORK(&hba->clk_gating.ungate_work, ufshcd_ungate_work);
733 hba->clk_gating.delay_attr.show = ufshcd_clkgate_delay_show;
734 hba->clk_gating.delay_attr.store = ufshcd_clkgate_delay_store;
735 sysfs_attr_init(&hba->clk_gating.delay_attr.attr);
736 hba->clk_gating.delay_attr.attr.name = "clkgate_delay_ms";
737 hba->clk_gating.delay_attr.attr.mode = S_IRUGO | S_IWUSR;
738 if (device_create_file(hba->dev, &hba->clk_gating.delay_attr))
739 dev_err(hba->dev, "Failed to create sysfs for clkgate_delay\n");
742 static void ufshcd_exit_clk_gating(struct ufs_hba *hba)
744 if (!ufshcd_is_clkgating_allowed(hba))
746 device_remove_file(hba->dev, &hba->clk_gating.delay_attr);
747 cancel_work_sync(&hba->clk_gating.ungate_work);
748 cancel_delayed_work_sync(&hba->clk_gating.gate_work);
751 /* Must be called with host lock acquired */
752 static void ufshcd_clk_scaling_start_busy(struct ufs_hba *hba)
754 if (!ufshcd_is_clkscaling_enabled(hba))
757 if (!hba->clk_scaling.is_busy_started) {
758 hba->clk_scaling.busy_start_t = ktime_get();
759 hba->clk_scaling.is_busy_started = true;
763 static void ufshcd_clk_scaling_update_busy(struct ufs_hba *hba)
765 struct ufs_clk_scaling *scaling = &hba->clk_scaling;
767 if (!ufshcd_is_clkscaling_enabled(hba))
770 if (!hba->outstanding_reqs && scaling->is_busy_started) {
771 scaling->tot_busy_t += ktime_to_us(ktime_sub(ktime_get(),
772 scaling->busy_start_t));
773 scaling->busy_start_t = ktime_set(0, 0);
774 scaling->is_busy_started = false;
778 * ufshcd_send_command - Send SCSI or device management commands
779 * @hba: per adapter instance
780 * @task_tag: Task tag of the command
783 void ufshcd_send_command(struct ufs_hba *hba, unsigned int task_tag)
785 ufshcd_clk_scaling_start_busy(hba);
786 __set_bit(task_tag, &hba->outstanding_reqs);
787 ufshcd_writel(hba, 1 << task_tag, REG_UTP_TRANSFER_REQ_DOOR_BELL);
791 * ufshcd_copy_sense_data - Copy sense data in case of check condition
792 * @lrb - pointer to local reference block
794 static inline void ufshcd_copy_sense_data(struct ufshcd_lrb *lrbp)
797 if (lrbp->sense_buffer &&
798 ufshcd_get_rsp_upiu_data_seg_len(lrbp->ucd_rsp_ptr)) {
799 len = be16_to_cpu(lrbp->ucd_rsp_ptr->sr.sense_data_len);
800 memcpy(lrbp->sense_buffer,
801 lrbp->ucd_rsp_ptr->sr.sense_data,
802 min_t(int, len, SCSI_SENSE_BUFFERSIZE));
807 * ufshcd_copy_query_response() - Copy the Query Response and the data
809 * @hba: per adapter instance
810 * @lrb - pointer to local reference block
813 int ufshcd_copy_query_response(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
815 struct ufs_query_res *query_res = &hba->dev_cmd.query.response;
817 memcpy(&query_res->upiu_res, &lrbp->ucd_rsp_ptr->qr, QUERY_OSF_SIZE);
819 /* Get the descriptor */
820 if (lrbp->ucd_rsp_ptr->qr.opcode == UPIU_QUERY_OPCODE_READ_DESC) {
821 u8 *descp = (u8 *)lrbp->ucd_rsp_ptr +
822 GENERAL_UPIU_REQUEST_SIZE;
826 /* data segment length */
827 resp_len = be32_to_cpu(lrbp->ucd_rsp_ptr->header.dword_2) &
828 MASK_QUERY_DATA_SEG_LEN;
829 buf_len = be16_to_cpu(
830 hba->dev_cmd.query.request.upiu_req.length);
831 if (likely(buf_len >= resp_len)) {
832 memcpy(hba->dev_cmd.query.descriptor, descp, resp_len);
835 "%s: Response size is bigger than buffer",
845 * ufshcd_hba_capabilities - Read controller capabilities
846 * @hba: per adapter instance
848 static inline void ufshcd_hba_capabilities(struct ufs_hba *hba)
850 hba->capabilities = ufshcd_readl(hba, REG_CONTROLLER_CAPABILITIES);
852 /* nutrs and nutmrs are 0 based values */
853 hba->nutrs = (hba->capabilities & MASK_TRANSFER_REQUESTS_SLOTS) + 1;
855 ((hba->capabilities & MASK_TASK_MANAGEMENT_REQUEST_SLOTS) >> 16) + 1;
859 * ufshcd_ready_for_uic_cmd - Check if controller is ready
860 * to accept UIC commands
861 * @hba: per adapter instance
862 * Return true on success, else false
864 static inline bool ufshcd_ready_for_uic_cmd(struct ufs_hba *hba)
866 if (ufshcd_readl(hba, REG_CONTROLLER_STATUS) & UIC_COMMAND_READY)
873 * ufshcd_get_upmcrs - Get the power mode change request status
874 * @hba: Pointer to adapter instance
876 * This function gets the UPMCRS field of HCS register
877 * Returns value of UPMCRS field
879 static inline u8 ufshcd_get_upmcrs(struct ufs_hba *hba)
881 return (ufshcd_readl(hba, REG_CONTROLLER_STATUS) >> 8) & 0x7;
885 * ufshcd_dispatch_uic_cmd - Dispatch UIC commands to unipro layers
886 * @hba: per adapter instance
887 * @uic_cmd: UIC command
889 * Mutex must be held.
892 ufshcd_dispatch_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd)
894 WARN_ON(hba->active_uic_cmd);
896 hba->active_uic_cmd = uic_cmd;
899 ufshcd_writel(hba, uic_cmd->argument1, REG_UIC_COMMAND_ARG_1);
900 ufshcd_writel(hba, uic_cmd->argument2, REG_UIC_COMMAND_ARG_2);
901 ufshcd_writel(hba, uic_cmd->argument3, REG_UIC_COMMAND_ARG_3);
904 ufshcd_writel(hba, uic_cmd->command & COMMAND_OPCODE_MASK,
909 * ufshcd_wait_for_uic_cmd - Wait complectioin of UIC command
910 * @hba: per adapter instance
911 * @uic_command: UIC command
913 * Must be called with mutex held.
914 * Returns 0 only if success.
917 ufshcd_wait_for_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd)
922 if (wait_for_completion_timeout(&uic_cmd->done,
923 msecs_to_jiffies(UIC_CMD_TIMEOUT)))
924 ret = uic_cmd->argument2 & MASK_UIC_COMMAND_RESULT;
928 spin_lock_irqsave(hba->host->host_lock, flags);
929 hba->active_uic_cmd = NULL;
930 spin_unlock_irqrestore(hba->host->host_lock, flags);
936 * __ufshcd_send_uic_cmd - Send UIC commands and retrieve the result
937 * @hba: per adapter instance
938 * @uic_cmd: UIC command
940 * Identical to ufshcd_send_uic_cmd() expect mutex. Must be called
941 * with mutex held and host_lock locked.
942 * Returns 0 only if success.
945 __ufshcd_send_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd)
947 if (!ufshcd_ready_for_uic_cmd(hba)) {
949 "Controller not ready to accept UIC commands\n");
953 init_completion(&uic_cmd->done);
955 ufshcd_dispatch_uic_cmd(hba, uic_cmd);
961 * ufshcd_send_uic_cmd - Send UIC commands and retrieve the result
962 * @hba: per adapter instance
963 * @uic_cmd: UIC command
965 * Returns 0 only if success.
968 ufshcd_send_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd)
973 ufshcd_hold(hba, false);
974 mutex_lock(&hba->uic_cmd_mutex);
975 spin_lock_irqsave(hba->host->host_lock, flags);
976 ret = __ufshcd_send_uic_cmd(hba, uic_cmd);
977 spin_unlock_irqrestore(hba->host->host_lock, flags);
979 ret = ufshcd_wait_for_uic_cmd(hba, uic_cmd);
981 mutex_unlock(&hba->uic_cmd_mutex);
988 * ufshcd_map_sg - Map scatter-gather list to prdt
989 * @lrbp - pointer to local reference block
991 * Returns 0 in case of success, non-zero value in case of failure
993 static int ufshcd_map_sg(struct ufshcd_lrb *lrbp)
995 struct ufshcd_sg_entry *prd_table;
996 struct scatterlist *sg;
997 struct scsi_cmnd *cmd;
1002 sg_segments = scsi_dma_map(cmd);
1003 if (sg_segments < 0)
1007 lrbp->utr_descriptor_ptr->prd_table_length =
1008 cpu_to_le16((u16) (sg_segments));
1010 prd_table = (struct ufshcd_sg_entry *)lrbp->ucd_prdt_ptr;
1012 scsi_for_each_sg(cmd, sg, sg_segments, i) {
1014 cpu_to_le32(((u32) sg_dma_len(sg))-1);
1015 prd_table[i].base_addr =
1016 cpu_to_le32(lower_32_bits(sg->dma_address));
1017 prd_table[i].upper_addr =
1018 cpu_to_le32(upper_32_bits(sg->dma_address));
1021 lrbp->utr_descriptor_ptr->prd_table_length = 0;
1028 * ufshcd_enable_intr - enable interrupts
1029 * @hba: per adapter instance
1030 * @intrs: interrupt bits
1032 static void ufshcd_enable_intr(struct ufs_hba *hba, u32 intrs)
1034 u32 set = ufshcd_readl(hba, REG_INTERRUPT_ENABLE);
1036 if (hba->ufs_version == UFSHCI_VERSION_10) {
1038 rw = set & INTERRUPT_MASK_RW_VER_10;
1039 set = rw | ((set ^ intrs) & intrs);
1044 ufshcd_writel(hba, set, REG_INTERRUPT_ENABLE);
1048 * ufshcd_disable_intr - disable interrupts
1049 * @hba: per adapter instance
1050 * @intrs: interrupt bits
1052 static void ufshcd_disable_intr(struct ufs_hba *hba, u32 intrs)
1054 u32 set = ufshcd_readl(hba, REG_INTERRUPT_ENABLE);
1056 if (hba->ufs_version == UFSHCI_VERSION_10) {
1058 rw = (set & INTERRUPT_MASK_RW_VER_10) &
1059 ~(intrs & INTERRUPT_MASK_RW_VER_10);
1060 set = rw | ((set & intrs) & ~INTERRUPT_MASK_RW_VER_10);
1066 ufshcd_writel(hba, set, REG_INTERRUPT_ENABLE);
1070 * ufshcd_prepare_req_desc_hdr() - Fills the requests header
1071 * descriptor according to request
1072 * @lrbp: pointer to local reference block
1073 * @upiu_flags: flags required in the header
1074 * @cmd_dir: requests data direction
1076 static void ufshcd_prepare_req_desc_hdr(struct ufshcd_lrb *lrbp,
1077 u32 *upiu_flags, enum dma_data_direction cmd_dir)
1079 struct utp_transfer_req_desc *req_desc = lrbp->utr_descriptor_ptr;
1083 if (cmd_dir == DMA_FROM_DEVICE) {
1084 data_direction = UTP_DEVICE_TO_HOST;
1085 *upiu_flags = UPIU_CMD_FLAGS_READ;
1086 } else if (cmd_dir == DMA_TO_DEVICE) {
1087 data_direction = UTP_HOST_TO_DEVICE;
1088 *upiu_flags = UPIU_CMD_FLAGS_WRITE;
1090 data_direction = UTP_NO_DATA_TRANSFER;
1091 *upiu_flags = UPIU_CMD_FLAGS_NONE;
1094 dword_0 = data_direction | (lrbp->command_type
1095 << UPIU_COMMAND_TYPE_OFFSET);
1097 dword_0 |= UTP_REQ_DESC_INT_CMD;
1099 /* Transfer request descriptor header fields */
1100 req_desc->header.dword_0 = cpu_to_le32(dword_0);
1103 * assigning invalid value for command status. Controller
1104 * updates OCS on command completion, with the command
1107 req_desc->header.dword_2 =
1108 cpu_to_le32(OCS_INVALID_COMMAND_STATUS);
1112 * ufshcd_prepare_utp_scsi_cmd_upiu() - fills the utp_transfer_req_desc,
1114 * @lrbp - local reference block pointer
1115 * @upiu_flags - flags
1118 void ufshcd_prepare_utp_scsi_cmd_upiu(struct ufshcd_lrb *lrbp, u32 upiu_flags)
1120 struct utp_upiu_req *ucd_req_ptr = lrbp->ucd_req_ptr;
1122 /* command descriptor fields */
1123 ucd_req_ptr->header.dword_0 = UPIU_HEADER_DWORD(
1124 UPIU_TRANSACTION_COMMAND, upiu_flags,
1125 lrbp->lun, lrbp->task_tag);
1126 ucd_req_ptr->header.dword_1 = UPIU_HEADER_DWORD(
1127 UPIU_COMMAND_SET_TYPE_SCSI, 0, 0, 0);
1129 /* Total EHS length and Data segment length will be zero */
1130 ucd_req_ptr->header.dword_2 = 0;
1132 ucd_req_ptr->sc.exp_data_transfer_len =
1133 cpu_to_be32(lrbp->cmd->sdb.length);
1135 memcpy(ucd_req_ptr->sc.cdb, lrbp->cmd->cmnd,
1136 (min_t(unsigned short, lrbp->cmd->cmd_len, MAX_CDB_SIZE)));
1140 * ufshcd_prepare_utp_query_req_upiu() - fills the utp_transfer_req_desc,
1143 * @lrbp: local reference block pointer
1144 * @upiu_flags: flags
1146 static void ufshcd_prepare_utp_query_req_upiu(struct ufs_hba *hba,
1147 struct ufshcd_lrb *lrbp, u32 upiu_flags)
1149 struct utp_upiu_req *ucd_req_ptr = lrbp->ucd_req_ptr;
1150 struct ufs_query *query = &hba->dev_cmd.query;
1151 u16 len = be16_to_cpu(query->request.upiu_req.length);
1152 u8 *descp = (u8 *)lrbp->ucd_req_ptr + GENERAL_UPIU_REQUEST_SIZE;
1154 /* Query request header */
1155 ucd_req_ptr->header.dword_0 = UPIU_HEADER_DWORD(
1156 UPIU_TRANSACTION_QUERY_REQ, upiu_flags,
1157 lrbp->lun, lrbp->task_tag);
1158 ucd_req_ptr->header.dword_1 = UPIU_HEADER_DWORD(
1159 0, query->request.query_func, 0, 0);
1161 /* Data segment length */
1162 ucd_req_ptr->header.dword_2 = UPIU_HEADER_DWORD(
1163 0, 0, len >> 8, (u8)len);
1165 /* Copy the Query Request buffer as is */
1166 memcpy(&ucd_req_ptr->qr, &query->request.upiu_req,
1169 /* Copy the Descriptor */
1170 if (query->request.upiu_req.opcode == UPIU_QUERY_OPCODE_WRITE_DESC)
1171 memcpy(descp, query->descriptor, len);
1175 static inline void ufshcd_prepare_utp_nop_upiu(struct ufshcd_lrb *lrbp)
1177 struct utp_upiu_req *ucd_req_ptr = lrbp->ucd_req_ptr;
1179 memset(ucd_req_ptr, 0, sizeof(struct utp_upiu_req));
1181 /* command descriptor fields */
1182 ucd_req_ptr->header.dword_0 =
1184 UPIU_TRANSACTION_NOP_OUT, 0, 0, lrbp->task_tag);
1188 * ufshcd_compose_upiu - form UFS Protocol Information Unit(UPIU)
1189 * @hba - per adapter instance
1190 * @lrb - pointer to local reference block
1192 static int ufshcd_compose_upiu(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
1197 switch (lrbp->command_type) {
1198 case UTP_CMD_TYPE_SCSI:
1199 if (likely(lrbp->cmd)) {
1200 ufshcd_prepare_req_desc_hdr(lrbp, &upiu_flags,
1201 lrbp->cmd->sc_data_direction);
1202 ufshcd_prepare_utp_scsi_cmd_upiu(lrbp, upiu_flags);
1207 case UTP_CMD_TYPE_DEV_MANAGE:
1208 ufshcd_prepare_req_desc_hdr(lrbp, &upiu_flags, DMA_NONE);
1209 if (hba->dev_cmd.type == DEV_CMD_TYPE_QUERY)
1210 ufshcd_prepare_utp_query_req_upiu(
1211 hba, lrbp, upiu_flags);
1212 else if (hba->dev_cmd.type == DEV_CMD_TYPE_NOP)
1213 ufshcd_prepare_utp_nop_upiu(lrbp);
1217 case UTP_CMD_TYPE_UFS:
1218 /* For UFS native command implementation */
1220 dev_err(hba->dev, "%s: UFS native command are not supported\n",
1225 dev_err(hba->dev, "%s: unknown command type: 0x%x\n",
1226 __func__, lrbp->command_type);
1228 } /* end of switch */
1234 * ufshcd_scsi_to_upiu_lun - maps scsi LUN to UPIU LUN
1235 * @scsi_lun: scsi LUN id
1237 * Returns UPIU LUN id
1239 static inline u8 ufshcd_scsi_to_upiu_lun(unsigned int scsi_lun)
1241 if (scsi_is_wlun(scsi_lun))
1242 return (scsi_lun & UFS_UPIU_MAX_UNIT_NUM_ID)
1245 return scsi_lun & UFS_UPIU_MAX_UNIT_NUM_ID;
1249 * ufshcd_upiu_wlun_to_scsi_wlun - maps UPIU W-LUN id to SCSI W-LUN ID
1250 * @scsi_lun: UPIU W-LUN id
1252 * Returns SCSI W-LUN id
1254 static inline u16 ufshcd_upiu_wlun_to_scsi_wlun(u8 upiu_wlun_id)
1256 return (upiu_wlun_id & ~UFS_UPIU_WLUN_ID) | SCSI_W_LUN_BASE;
1260 * ufshcd_queuecommand - main entry point for SCSI requests
1261 * @cmd: command from SCSI Midlayer
1262 * @done: call back function
1264 * Returns 0 for success, non-zero in case of failure
1266 static int ufshcd_queuecommand(struct Scsi_Host *host, struct scsi_cmnd *cmd)
1268 struct ufshcd_lrb *lrbp;
1269 struct ufs_hba *hba;
1270 unsigned long flags;
1274 hba = shost_priv(host);
1276 tag = cmd->request->tag;
1278 spin_lock_irqsave(hba->host->host_lock, flags);
1279 switch (hba->ufshcd_state) {
1280 case UFSHCD_STATE_OPERATIONAL:
1282 case UFSHCD_STATE_RESET:
1283 err = SCSI_MLQUEUE_HOST_BUSY;
1285 case UFSHCD_STATE_ERROR:
1286 set_host_byte(cmd, DID_ERROR);
1287 cmd->scsi_done(cmd);
1290 dev_WARN_ONCE(hba->dev, 1, "%s: invalid state %d\n",
1291 __func__, hba->ufshcd_state);
1292 set_host_byte(cmd, DID_BAD_TARGET);
1293 cmd->scsi_done(cmd);
1296 spin_unlock_irqrestore(hba->host->host_lock, flags);
1298 /* acquire the tag to make sure device cmds don't use it */
1299 if (test_and_set_bit_lock(tag, &hba->lrb_in_use)) {
1301 * Dev manage command in progress, requeue the command.
1302 * Requeuing the command helps in cases where the request *may*
1303 * find different tag instead of waiting for dev manage command
1306 err = SCSI_MLQUEUE_HOST_BUSY;
1310 err = ufshcd_hold(hba, true);
1312 err = SCSI_MLQUEUE_HOST_BUSY;
1313 clear_bit_unlock(tag, &hba->lrb_in_use);
1316 WARN_ON(hba->clk_gating.state != CLKS_ON);
1318 lrbp = &hba->lrb[tag];
1322 lrbp->sense_bufflen = SCSI_SENSE_BUFFERSIZE;
1323 lrbp->sense_buffer = cmd->sense_buffer;
1324 lrbp->task_tag = tag;
1325 lrbp->lun = ufshcd_scsi_to_upiu_lun(cmd->device->lun);
1326 lrbp->intr_cmd = false;
1327 lrbp->command_type = UTP_CMD_TYPE_SCSI;
1329 /* form UPIU before issuing the command */
1330 ufshcd_compose_upiu(hba, lrbp);
1331 err = ufshcd_map_sg(lrbp);
1334 clear_bit_unlock(tag, &hba->lrb_in_use);
1338 /* issue command to the controller */
1339 spin_lock_irqsave(hba->host->host_lock, flags);
1340 ufshcd_send_command(hba, tag);
1342 spin_unlock_irqrestore(hba->host->host_lock, flags);
1347 static int ufshcd_compose_dev_cmd(struct ufs_hba *hba,
1348 struct ufshcd_lrb *lrbp, enum dev_cmd_type cmd_type, int tag)
1351 lrbp->sense_bufflen = 0;
1352 lrbp->sense_buffer = NULL;
1353 lrbp->task_tag = tag;
1354 lrbp->lun = 0; /* device management cmd is not specific to any LUN */
1355 lrbp->command_type = UTP_CMD_TYPE_DEV_MANAGE;
1356 lrbp->intr_cmd = true; /* No interrupt aggregation */
1357 hba->dev_cmd.type = cmd_type;
1359 return ufshcd_compose_upiu(hba, lrbp);
1363 ufshcd_clear_cmd(struct ufs_hba *hba, int tag)
1366 unsigned long flags;
1367 u32 mask = 1 << tag;
1369 /* clear outstanding transaction before retry */
1370 spin_lock_irqsave(hba->host->host_lock, flags);
1371 ufshcd_utrl_clear(hba, tag);
1372 spin_unlock_irqrestore(hba->host->host_lock, flags);
1375 * wait for for h/w to clear corresponding bit in door-bell.
1376 * max. wait is 1 sec.
1378 err = ufshcd_wait_for_register(hba,
1379 REG_UTP_TRANSFER_REQ_DOOR_BELL,
1380 mask, ~mask, 1000, 1000);
1386 ufshcd_check_query_response(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
1388 struct ufs_query_res *query_res = &hba->dev_cmd.query.response;
1390 /* Get the UPIU response */
1391 query_res->response = ufshcd_get_rsp_upiu_result(lrbp->ucd_rsp_ptr) >>
1392 UPIU_RSP_CODE_OFFSET;
1393 return query_res->response;
1397 * ufshcd_dev_cmd_completion() - handles device management command responses
1398 * @hba: per adapter instance
1399 * @lrbp: pointer to local reference block
1402 ufshcd_dev_cmd_completion(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
1407 resp = ufshcd_get_req_rsp(lrbp->ucd_rsp_ptr);
1410 case UPIU_TRANSACTION_NOP_IN:
1411 if (hba->dev_cmd.type != DEV_CMD_TYPE_NOP) {
1413 dev_err(hba->dev, "%s: unexpected response %x\n",
1417 case UPIU_TRANSACTION_QUERY_RSP:
1418 err = ufshcd_check_query_response(hba, lrbp);
1420 err = ufshcd_copy_query_response(hba, lrbp);
1422 case UPIU_TRANSACTION_REJECT_UPIU:
1423 /* TODO: handle Reject UPIU Response */
1425 dev_err(hba->dev, "%s: Reject UPIU not fully implemented\n",
1430 dev_err(hba->dev, "%s: Invalid device management cmd response: %x\n",
1438 static int ufshcd_wait_for_dev_cmd(struct ufs_hba *hba,
1439 struct ufshcd_lrb *lrbp, int max_timeout)
1442 unsigned long time_left;
1443 unsigned long flags;
1445 time_left = wait_for_completion_timeout(hba->dev_cmd.complete,
1446 msecs_to_jiffies(max_timeout));
1448 spin_lock_irqsave(hba->host->host_lock, flags);
1449 hba->dev_cmd.complete = NULL;
1450 if (likely(time_left)) {
1451 err = ufshcd_get_tr_ocs(lrbp);
1453 err = ufshcd_dev_cmd_completion(hba, lrbp);
1455 spin_unlock_irqrestore(hba->host->host_lock, flags);
1459 if (!ufshcd_clear_cmd(hba, lrbp->task_tag))
1460 /* sucessfully cleared the command, retry if needed */
1468 * ufshcd_get_dev_cmd_tag - Get device management command tag
1469 * @hba: per-adapter instance
1470 * @tag: pointer to variable with available slot value
1472 * Get a free slot and lock it until device management command
1475 * Returns false if free slot is unavailable for locking, else
1476 * return true with tag value in @tag.
1478 static bool ufshcd_get_dev_cmd_tag(struct ufs_hba *hba, int *tag_out)
1488 tmp = ~hba->lrb_in_use;
1489 tag = find_last_bit(&tmp, hba->nutrs);
1490 if (tag >= hba->nutrs)
1492 } while (test_and_set_bit_lock(tag, &hba->lrb_in_use));
1500 static inline void ufshcd_put_dev_cmd_tag(struct ufs_hba *hba, int tag)
1502 clear_bit_unlock(tag, &hba->lrb_in_use);
1506 * ufshcd_exec_dev_cmd - API for sending device management requests
1508 * @cmd_type - specifies the type (NOP, Query...)
1509 * @timeout - time in seconds
1511 * NOTE: Since there is only one available tag for device management commands,
1512 * it is expected you hold the hba->dev_cmd.lock mutex.
1514 static int ufshcd_exec_dev_cmd(struct ufs_hba *hba,
1515 enum dev_cmd_type cmd_type, int timeout)
1517 struct ufshcd_lrb *lrbp;
1520 struct completion wait;
1521 unsigned long flags;
1524 * Get free slot, sleep if slots are unavailable.
1525 * Even though we use wait_event() which sleeps indefinitely,
1526 * the maximum wait time is bounded by SCSI request timeout.
1528 wait_event(hba->dev_cmd.tag_wq, ufshcd_get_dev_cmd_tag(hba, &tag));
1530 init_completion(&wait);
1531 lrbp = &hba->lrb[tag];
1533 err = ufshcd_compose_dev_cmd(hba, lrbp, cmd_type, tag);
1537 hba->dev_cmd.complete = &wait;
1539 spin_lock_irqsave(hba->host->host_lock, flags);
1540 ufshcd_send_command(hba, tag);
1541 spin_unlock_irqrestore(hba->host->host_lock, flags);
1543 err = ufshcd_wait_for_dev_cmd(hba, lrbp, timeout);
1546 ufshcd_put_dev_cmd_tag(hba, tag);
1547 wake_up(&hba->dev_cmd.tag_wq);
1552 * ufshcd_init_query() - init the query response and request parameters
1553 * @hba: per-adapter instance
1554 * @request: address of the request pointer to be initialized
1555 * @response: address of the response pointer to be initialized
1556 * @opcode: operation to perform
1557 * @idn: flag idn to access
1558 * @index: LU number to access
1559 * @selector: query/flag/descriptor further identification
1561 static inline void ufshcd_init_query(struct ufs_hba *hba,
1562 struct ufs_query_req **request, struct ufs_query_res **response,
1563 enum query_opcode opcode, u8 idn, u8 index, u8 selector)
1565 *request = &hba->dev_cmd.query.request;
1566 *response = &hba->dev_cmd.query.response;
1567 memset(*request, 0, sizeof(struct ufs_query_req));
1568 memset(*response, 0, sizeof(struct ufs_query_res));
1569 (*request)->upiu_req.opcode = opcode;
1570 (*request)->upiu_req.idn = idn;
1571 (*request)->upiu_req.index = index;
1572 (*request)->upiu_req.selector = selector;
1576 * ufshcd_query_flag() - API function for sending flag query requests
1577 * hba: per-adapter instance
1578 * query_opcode: flag query to perform
1579 * idn: flag idn to access
1580 * flag_res: the flag value after the query request completes
1582 * Returns 0 for success, non-zero in case of failure
1584 static int ufshcd_query_flag(struct ufs_hba *hba, enum query_opcode opcode,
1585 enum flag_idn idn, bool *flag_res)
1587 struct ufs_query_req *request = NULL;
1588 struct ufs_query_res *response = NULL;
1589 int err, index = 0, selector = 0;
1593 ufshcd_hold(hba, false);
1594 mutex_lock(&hba->dev_cmd.lock);
1595 ufshcd_init_query(hba, &request, &response, opcode, idn, index,
1599 case UPIU_QUERY_OPCODE_SET_FLAG:
1600 case UPIU_QUERY_OPCODE_CLEAR_FLAG:
1601 case UPIU_QUERY_OPCODE_TOGGLE_FLAG:
1602 request->query_func = UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST;
1604 case UPIU_QUERY_OPCODE_READ_FLAG:
1605 request->query_func = UPIU_QUERY_FUNC_STANDARD_READ_REQUEST;
1607 /* No dummy reads */
1608 dev_err(hba->dev, "%s: Invalid argument for read request\n",
1616 "%s: Expected query flag opcode but got = %d\n",
1622 err = ufshcd_exec_dev_cmd(hba, DEV_CMD_TYPE_QUERY, QUERY_REQ_TIMEOUT);
1626 "%s: Sending flag query for idn %d failed, err = %d\n",
1627 __func__, idn, err);
1632 *flag_res = (be32_to_cpu(response->upiu_res.value) &
1633 MASK_QUERY_UPIU_FLAG_LOC) & 0x1;
1636 mutex_unlock(&hba->dev_cmd.lock);
1637 ufshcd_release(hba);
1642 * ufshcd_query_attr - API function for sending attribute requests
1643 * hba: per-adapter instance
1644 * opcode: attribute opcode
1645 * idn: attribute idn to access
1646 * index: index field
1647 * selector: selector field
1648 * attr_val: the attribute value after the query request completes
1650 * Returns 0 for success, non-zero in case of failure
1652 static int ufshcd_query_attr(struct ufs_hba *hba, enum query_opcode opcode,
1653 enum attr_idn idn, u8 index, u8 selector, u32 *attr_val)
1655 struct ufs_query_req *request = NULL;
1656 struct ufs_query_res *response = NULL;
1661 ufshcd_hold(hba, false);
1663 dev_err(hba->dev, "%s: attribute value required for opcode 0x%x\n",
1669 mutex_lock(&hba->dev_cmd.lock);
1670 ufshcd_init_query(hba, &request, &response, opcode, idn, index,
1674 case UPIU_QUERY_OPCODE_WRITE_ATTR:
1675 request->query_func = UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST;
1676 request->upiu_req.value = cpu_to_be32(*attr_val);
1678 case UPIU_QUERY_OPCODE_READ_ATTR:
1679 request->query_func = UPIU_QUERY_FUNC_STANDARD_READ_REQUEST;
1682 dev_err(hba->dev, "%s: Expected query attr opcode but got = 0x%.2x\n",
1688 err = ufshcd_exec_dev_cmd(hba, DEV_CMD_TYPE_QUERY, QUERY_REQ_TIMEOUT);
1691 dev_err(hba->dev, "%s: opcode 0x%.2x for idn %d failed, err = %d\n",
1692 __func__, opcode, idn, err);
1696 *attr_val = be32_to_cpu(response->upiu_res.value);
1699 mutex_unlock(&hba->dev_cmd.lock);
1701 ufshcd_release(hba);
1706 * ufshcd_query_descriptor - API function for sending descriptor requests
1707 * hba: per-adapter instance
1708 * opcode: attribute opcode
1709 * idn: attribute idn to access
1710 * index: index field
1711 * selector: selector field
1712 * desc_buf: the buffer that contains the descriptor
1713 * buf_len: length parameter passed to the device
1715 * Returns 0 for success, non-zero in case of failure.
1716 * The buf_len parameter will contain, on return, the length parameter
1717 * received on the response.
1719 static int ufshcd_query_descriptor(struct ufs_hba *hba,
1720 enum query_opcode opcode, enum desc_idn idn, u8 index,
1721 u8 selector, u8 *desc_buf, int *buf_len)
1723 struct ufs_query_req *request = NULL;
1724 struct ufs_query_res *response = NULL;
1729 ufshcd_hold(hba, false);
1731 dev_err(hba->dev, "%s: descriptor buffer required for opcode 0x%x\n",
1737 if (*buf_len <= QUERY_DESC_MIN_SIZE || *buf_len > QUERY_DESC_MAX_SIZE) {
1738 dev_err(hba->dev, "%s: descriptor buffer size (%d) is out of range\n",
1739 __func__, *buf_len);
1744 mutex_lock(&hba->dev_cmd.lock);
1745 ufshcd_init_query(hba, &request, &response, opcode, idn, index,
1747 hba->dev_cmd.query.descriptor = desc_buf;
1748 request->upiu_req.length = cpu_to_be16(*buf_len);
1751 case UPIU_QUERY_OPCODE_WRITE_DESC:
1752 request->query_func = UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST;
1754 case UPIU_QUERY_OPCODE_READ_DESC:
1755 request->query_func = UPIU_QUERY_FUNC_STANDARD_READ_REQUEST;
1759 "%s: Expected query descriptor opcode but got = 0x%.2x\n",
1765 err = ufshcd_exec_dev_cmd(hba, DEV_CMD_TYPE_QUERY, QUERY_REQ_TIMEOUT);
1768 dev_err(hba->dev, "%s: opcode 0x%.2x for idn %d failed, err = %d\n",
1769 __func__, opcode, idn, err);
1773 hba->dev_cmd.query.descriptor = NULL;
1774 *buf_len = be16_to_cpu(response->upiu_res.length);
1777 mutex_unlock(&hba->dev_cmd.lock);
1779 ufshcd_release(hba);
1784 * ufshcd_read_desc_param - read the specified descriptor parameter
1785 * @hba: Pointer to adapter instance
1786 * @desc_id: descriptor idn value
1787 * @desc_index: descriptor index
1788 * @param_offset: offset of the parameter to read
1789 * @param_read_buf: pointer to buffer where parameter would be read
1790 * @param_size: sizeof(param_read_buf)
1792 * Return 0 in case of success, non-zero otherwise
1794 static int ufshcd_read_desc_param(struct ufs_hba *hba,
1795 enum desc_idn desc_id,
1804 bool is_kmalloc = true;
1807 if (desc_id >= QUERY_DESC_IDN_MAX)
1810 buff_len = ufs_query_desc_max_size[desc_id];
1811 if ((param_offset + param_size) > buff_len)
1814 if (!param_offset && (param_size == buff_len)) {
1815 /* memory space already available to hold full descriptor */
1816 desc_buf = param_read_buf;
1819 /* allocate memory to hold full descriptor */
1820 desc_buf = kmalloc(buff_len, GFP_KERNEL);
1825 ret = ufshcd_query_descriptor(hba, UPIU_QUERY_OPCODE_READ_DESC,
1826 desc_id, desc_index, 0, desc_buf,
1829 if (ret || (buff_len < ufs_query_desc_max_size[desc_id]) ||
1830 (desc_buf[QUERY_DESC_LENGTH_OFFSET] !=
1831 ufs_query_desc_max_size[desc_id])
1832 || (desc_buf[QUERY_DESC_DESC_TYPE_OFFSET] != desc_id)) {
1833 dev_err(hba->dev, "%s: Failed reading descriptor. desc_id %d param_offset %d buff_len %d ret %d",
1834 __func__, desc_id, param_offset, buff_len, ret);
1842 memcpy(param_read_buf, &desc_buf[param_offset], param_size);
1849 static inline int ufshcd_read_desc(struct ufs_hba *hba,
1850 enum desc_idn desc_id,
1855 return ufshcd_read_desc_param(hba, desc_id, desc_index, 0, buf, size);
1858 static inline int ufshcd_read_power_desc(struct ufs_hba *hba,
1862 return ufshcd_read_desc(hba, QUERY_DESC_IDN_POWER, 0, buf, size);
1866 * ufshcd_read_unit_desc_param - read the specified unit descriptor parameter
1867 * @hba: Pointer to adapter instance
1869 * @param_offset: offset of the parameter to read
1870 * @param_read_buf: pointer to buffer where parameter would be read
1871 * @param_size: sizeof(param_read_buf)
1873 * Return 0 in case of success, non-zero otherwise
1875 static inline int ufshcd_read_unit_desc_param(struct ufs_hba *hba,
1877 enum unit_desc_param param_offset,
1882 * Unit descriptors are only available for general purpose LUs (LUN id
1883 * from 0 to 7) and RPMB Well known LU.
1885 if (lun != UFS_UPIU_RPMB_WLUN && (lun >= UFS_UPIU_MAX_GENERAL_LUN))
1888 return ufshcd_read_desc_param(hba, QUERY_DESC_IDN_UNIT, lun,
1889 param_offset, param_read_buf, param_size);
1893 * ufshcd_memory_alloc - allocate memory for host memory space data structures
1894 * @hba: per adapter instance
1896 * 1. Allocate DMA memory for Command Descriptor array
1897 * Each command descriptor consist of Command UPIU, Response UPIU and PRDT
1898 * 2. Allocate DMA memory for UTP Transfer Request Descriptor List (UTRDL).
1899 * 3. Allocate DMA memory for UTP Task Management Request Descriptor List
1901 * 4. Allocate memory for local reference block(lrb).
1903 * Returns 0 for success, non-zero in case of failure
1905 static int ufshcd_memory_alloc(struct ufs_hba *hba)
1907 size_t utmrdl_size, utrdl_size, ucdl_size;
1909 /* Allocate memory for UTP command descriptors */
1910 ucdl_size = (sizeof(struct utp_transfer_cmd_desc) * hba->nutrs);
1911 hba->ucdl_base_addr = dmam_alloc_coherent(hba->dev,
1913 &hba->ucdl_dma_addr,
1917 * UFSHCI requires UTP command descriptor to be 128 byte aligned.
1918 * make sure hba->ucdl_dma_addr is aligned to PAGE_SIZE
1919 * if hba->ucdl_dma_addr is aligned to PAGE_SIZE, then it will
1920 * be aligned to 128 bytes as well
1922 if (!hba->ucdl_base_addr ||
1923 WARN_ON(hba->ucdl_dma_addr & (PAGE_SIZE - 1))) {
1925 "Command Descriptor Memory allocation failed\n");
1930 * Allocate memory for UTP Transfer descriptors
1931 * UFSHCI requires 1024 byte alignment of UTRD
1933 utrdl_size = (sizeof(struct utp_transfer_req_desc) * hba->nutrs);
1934 hba->utrdl_base_addr = dmam_alloc_coherent(hba->dev,
1936 &hba->utrdl_dma_addr,
1938 if (!hba->utrdl_base_addr ||
1939 WARN_ON(hba->utrdl_dma_addr & (PAGE_SIZE - 1))) {
1941 "Transfer Descriptor Memory allocation failed\n");
1946 * Allocate memory for UTP Task Management descriptors
1947 * UFSHCI requires 1024 byte alignment of UTMRD
1949 utmrdl_size = sizeof(struct utp_task_req_desc) * hba->nutmrs;
1950 hba->utmrdl_base_addr = dmam_alloc_coherent(hba->dev,
1952 &hba->utmrdl_dma_addr,
1954 if (!hba->utmrdl_base_addr ||
1955 WARN_ON(hba->utmrdl_dma_addr & (PAGE_SIZE - 1))) {
1957 "Task Management Descriptor Memory allocation failed\n");
1961 /* Allocate memory for local reference block */
1962 hba->lrb = devm_kzalloc(hba->dev,
1963 hba->nutrs * sizeof(struct ufshcd_lrb),
1966 dev_err(hba->dev, "LRB Memory allocation failed\n");
1975 * ufshcd_host_memory_configure - configure local reference block with
1977 * @hba: per adapter instance
1979 * Configure Host memory space
1980 * 1. Update Corresponding UTRD.UCDBA and UTRD.UCDBAU with UCD DMA
1982 * 2. Update each UTRD with Response UPIU offset, Response UPIU length
1984 * 3. Save the corresponding addresses of UTRD, UCD.CMD, UCD.RSP and UCD.PRDT
1985 * into local reference block.
1987 static void ufshcd_host_memory_configure(struct ufs_hba *hba)
1989 struct utp_transfer_cmd_desc *cmd_descp;
1990 struct utp_transfer_req_desc *utrdlp;
1991 dma_addr_t cmd_desc_dma_addr;
1992 dma_addr_t cmd_desc_element_addr;
1993 u16 response_offset;
1998 utrdlp = hba->utrdl_base_addr;
1999 cmd_descp = hba->ucdl_base_addr;
2002 offsetof(struct utp_transfer_cmd_desc, response_upiu);
2004 offsetof(struct utp_transfer_cmd_desc, prd_table);
2006 cmd_desc_size = sizeof(struct utp_transfer_cmd_desc);
2007 cmd_desc_dma_addr = hba->ucdl_dma_addr;
2009 for (i = 0; i < hba->nutrs; i++) {
2010 /* Configure UTRD with command descriptor base address */
2011 cmd_desc_element_addr =
2012 (cmd_desc_dma_addr + (cmd_desc_size * i));
2013 utrdlp[i].command_desc_base_addr_lo =
2014 cpu_to_le32(lower_32_bits(cmd_desc_element_addr));
2015 utrdlp[i].command_desc_base_addr_hi =
2016 cpu_to_le32(upper_32_bits(cmd_desc_element_addr));
2018 /* Response upiu and prdt offset should be in double words */
2019 utrdlp[i].response_upiu_offset =
2020 cpu_to_le16((response_offset >> 2));
2021 utrdlp[i].prd_table_offset =
2022 cpu_to_le16((prdt_offset >> 2));
2023 utrdlp[i].response_upiu_length =
2024 cpu_to_le16(ALIGNED_UPIU_SIZE >> 2);
2026 hba->lrb[i].utr_descriptor_ptr = (utrdlp + i);
2027 hba->lrb[i].ucd_req_ptr =
2028 (struct utp_upiu_req *)(cmd_descp + i);
2029 hba->lrb[i].ucd_rsp_ptr =
2030 (struct utp_upiu_rsp *)cmd_descp[i].response_upiu;
2031 hba->lrb[i].ucd_prdt_ptr =
2032 (struct ufshcd_sg_entry *)cmd_descp[i].prd_table;
2037 * ufshcd_dme_link_startup - Notify Unipro to perform link startup
2038 * @hba: per adapter instance
2040 * UIC_CMD_DME_LINK_STARTUP command must be issued to Unipro layer,
2041 * in order to initialize the Unipro link startup procedure.
2042 * Once the Unipro links are up, the device connected to the controller
2045 * Returns 0 on success, non-zero value on failure
2047 static int ufshcd_dme_link_startup(struct ufs_hba *hba)
2049 struct uic_command uic_cmd = {0};
2052 uic_cmd.command = UIC_CMD_DME_LINK_STARTUP;
2054 ret = ufshcd_send_uic_cmd(hba, &uic_cmd);
2057 "dme-link-startup: error code %d\n", ret);
2062 * ufshcd_dme_set_attr - UIC command for DME_SET, DME_PEER_SET
2063 * @hba: per adapter instance
2064 * @attr_sel: uic command argument1
2065 * @attr_set: attribute set type as uic command argument2
2066 * @mib_val: setting value as uic command argument3
2067 * @peer: indicate whether peer or local
2069 * Returns 0 on success, non-zero value on failure
2071 int ufshcd_dme_set_attr(struct ufs_hba *hba, u32 attr_sel,
2072 u8 attr_set, u32 mib_val, u8 peer)
2074 struct uic_command uic_cmd = {0};
2075 static const char *const action[] = {
2079 const char *set = action[!!peer];
2082 uic_cmd.command = peer ?
2083 UIC_CMD_DME_PEER_SET : UIC_CMD_DME_SET;
2084 uic_cmd.argument1 = attr_sel;
2085 uic_cmd.argument2 = UIC_ARG_ATTR_TYPE(attr_set);
2086 uic_cmd.argument3 = mib_val;
2088 ret = ufshcd_send_uic_cmd(hba, &uic_cmd);
2090 dev_err(hba->dev, "%s: attr-id 0x%x val 0x%x error code %d\n",
2091 set, UIC_GET_ATTR_ID(attr_sel), mib_val, ret);
2095 EXPORT_SYMBOL_GPL(ufshcd_dme_set_attr);
2098 * ufshcd_dme_get_attr - UIC command for DME_GET, DME_PEER_GET
2099 * @hba: per adapter instance
2100 * @attr_sel: uic command argument1
2101 * @mib_val: the value of the attribute as returned by the UIC command
2102 * @peer: indicate whether peer or local
2104 * Returns 0 on success, non-zero value on failure
2106 int ufshcd_dme_get_attr(struct ufs_hba *hba, u32 attr_sel,
2107 u32 *mib_val, u8 peer)
2109 struct uic_command uic_cmd = {0};
2110 static const char *const action[] = {
2114 const char *get = action[!!peer];
2117 uic_cmd.command = peer ?
2118 UIC_CMD_DME_PEER_GET : UIC_CMD_DME_GET;
2119 uic_cmd.argument1 = attr_sel;
2121 ret = ufshcd_send_uic_cmd(hba, &uic_cmd);
2123 dev_err(hba->dev, "%s: attr-id 0x%x error code %d\n",
2124 get, UIC_GET_ATTR_ID(attr_sel), ret);
2129 *mib_val = uic_cmd.argument3;
2133 EXPORT_SYMBOL_GPL(ufshcd_dme_get_attr);
2136 * ufshcd_uic_pwr_ctrl - executes UIC commands (which affects the link power
2137 * state) and waits for it to take effect.
2139 * @hba: per adapter instance
2140 * @cmd: UIC command to execute
2142 * DME operations like DME_SET(PA_PWRMODE), DME_HIBERNATE_ENTER &
2143 * DME_HIBERNATE_EXIT commands take some time to take its effect on both host
2144 * and device UniPro link and hence it's final completion would be indicated by
2145 * dedicated status bits in Interrupt Status register (UPMS, UHES, UHXS) in
2146 * addition to normal UIC command completion Status (UCCS). This function only
2147 * returns after the relevant status bits indicate the completion.
2149 * Returns 0 on success, non-zero value on failure
2151 static int ufshcd_uic_pwr_ctrl(struct ufs_hba *hba, struct uic_command *cmd)
2153 struct completion uic_async_done;
2154 unsigned long flags;
2158 mutex_lock(&hba->uic_cmd_mutex);
2159 init_completion(&uic_async_done);
2161 spin_lock_irqsave(hba->host->host_lock, flags);
2162 hba->uic_async_done = &uic_async_done;
2163 ret = __ufshcd_send_uic_cmd(hba, cmd);
2164 spin_unlock_irqrestore(hba->host->host_lock, flags);
2167 "pwr ctrl cmd 0x%x with mode 0x%x uic error %d\n",
2168 cmd->command, cmd->argument3, ret);
2171 ret = ufshcd_wait_for_uic_cmd(hba, cmd);
2174 "pwr ctrl cmd 0x%x with mode 0x%x uic error %d\n",
2175 cmd->command, cmd->argument3, ret);
2179 if (!wait_for_completion_timeout(hba->uic_async_done,
2180 msecs_to_jiffies(UIC_CMD_TIMEOUT))) {
2182 "pwr ctrl cmd 0x%x with mode 0x%x completion timeout\n",
2183 cmd->command, cmd->argument3);
2188 status = ufshcd_get_upmcrs(hba);
2189 if (status != PWR_LOCAL) {
2191 "pwr ctrl cmd 0x%0x failed, host umpcrs:0x%x\n",
2192 cmd->command, status);
2193 ret = (status != PWR_OK) ? status : -1;
2196 spin_lock_irqsave(hba->host->host_lock, flags);
2197 hba->uic_async_done = NULL;
2198 spin_unlock_irqrestore(hba->host->host_lock, flags);
2199 mutex_unlock(&hba->uic_cmd_mutex);
2205 * ufshcd_uic_change_pwr_mode - Perform the UIC power mode chage
2206 * using DME_SET primitives.
2207 * @hba: per adapter instance
2208 * @mode: powr mode value
2210 * Returns 0 on success, non-zero value on failure
2212 static int ufshcd_uic_change_pwr_mode(struct ufs_hba *hba, u8 mode)
2214 struct uic_command uic_cmd = {0};
2217 uic_cmd.command = UIC_CMD_DME_SET;
2218 uic_cmd.argument1 = UIC_ARG_MIB(PA_PWRMODE);
2219 uic_cmd.argument3 = mode;
2220 ufshcd_hold(hba, false);
2221 ret = ufshcd_uic_pwr_ctrl(hba, &uic_cmd);
2222 ufshcd_release(hba);
2227 static int ufshcd_uic_hibern8_enter(struct ufs_hba *hba)
2229 struct uic_command uic_cmd = {0};
2231 uic_cmd.command = UIC_CMD_DME_HIBER_ENTER;
2233 return ufshcd_uic_pwr_ctrl(hba, &uic_cmd);
2236 static int ufshcd_uic_hibern8_exit(struct ufs_hba *hba)
2238 struct uic_command uic_cmd = {0};
2241 uic_cmd.command = UIC_CMD_DME_HIBER_EXIT;
2242 ret = ufshcd_uic_pwr_ctrl(hba, &uic_cmd);
2244 ufshcd_set_link_off(hba);
2245 ret = ufshcd_host_reset_and_restore(hba);
2252 * ufshcd_init_pwr_info - setting the POR (power on reset)
2253 * values in hba power info
2254 * @hba: per-adapter instance
2256 static void ufshcd_init_pwr_info(struct ufs_hba *hba)
2258 hba->pwr_info.gear_rx = UFS_PWM_G1;
2259 hba->pwr_info.gear_tx = UFS_PWM_G1;
2260 hba->pwr_info.lane_rx = 1;
2261 hba->pwr_info.lane_tx = 1;
2262 hba->pwr_info.pwr_rx = SLOWAUTO_MODE;
2263 hba->pwr_info.pwr_tx = SLOWAUTO_MODE;
2264 hba->pwr_info.hs_rate = 0;
2268 * ufshcd_get_max_pwr_mode - reads the max power mode negotiated with device
2269 * @hba: per-adapter instance
2271 static int ufshcd_get_max_pwr_mode(struct ufs_hba *hba)
2273 struct ufs_pa_layer_attr *pwr_info = &hba->max_pwr_info.info;
2275 if (hba->max_pwr_info.is_valid)
2278 pwr_info->pwr_tx = FASTAUTO_MODE;
2279 pwr_info->pwr_rx = FASTAUTO_MODE;
2280 pwr_info->hs_rate = PA_HS_MODE_B;
2282 /* Get the connected lane count */
2283 ufshcd_dme_get(hba, UIC_ARG_MIB(PA_CONNECTEDRXDATALANES),
2284 &pwr_info->lane_rx);
2285 ufshcd_dme_get(hba, UIC_ARG_MIB(PA_CONNECTEDTXDATALANES),
2286 &pwr_info->lane_tx);
2288 if (!pwr_info->lane_rx || !pwr_info->lane_tx) {
2289 dev_err(hba->dev, "%s: invalid connected lanes value. rx=%d, tx=%d\n",
2297 * First, get the maximum gears of HS speed.
2298 * If a zero value, it means there is no HSGEAR capability.
2299 * Then, get the maximum gears of PWM speed.
2301 ufshcd_dme_get(hba, UIC_ARG_MIB(PA_MAXRXHSGEAR), &pwr_info->gear_rx);
2302 if (!pwr_info->gear_rx) {
2303 ufshcd_dme_get(hba, UIC_ARG_MIB(PA_MAXRXPWMGEAR),
2304 &pwr_info->gear_rx);
2305 if (!pwr_info->gear_rx) {
2306 dev_err(hba->dev, "%s: invalid max pwm rx gear read = %d\n",
2307 __func__, pwr_info->gear_rx);
2310 pwr_info->pwr_rx = SLOWAUTO_MODE;
2313 ufshcd_dme_peer_get(hba, UIC_ARG_MIB(PA_MAXRXHSGEAR),
2314 &pwr_info->gear_tx);
2315 if (!pwr_info->gear_tx) {
2316 ufshcd_dme_peer_get(hba, UIC_ARG_MIB(PA_MAXRXPWMGEAR),
2317 &pwr_info->gear_tx);
2318 if (!pwr_info->gear_tx) {
2319 dev_err(hba->dev, "%s: invalid max pwm tx gear read = %d\n",
2320 __func__, pwr_info->gear_tx);
2323 pwr_info->pwr_tx = SLOWAUTO_MODE;
2326 hba->max_pwr_info.is_valid = true;
2330 static int ufshcd_change_power_mode(struct ufs_hba *hba,
2331 struct ufs_pa_layer_attr *pwr_mode)
2335 /* if already configured to the requested pwr_mode */
2336 if (pwr_mode->gear_rx == hba->pwr_info.gear_rx &&
2337 pwr_mode->gear_tx == hba->pwr_info.gear_tx &&
2338 pwr_mode->lane_rx == hba->pwr_info.lane_rx &&
2339 pwr_mode->lane_tx == hba->pwr_info.lane_tx &&
2340 pwr_mode->pwr_rx == hba->pwr_info.pwr_rx &&
2341 pwr_mode->pwr_tx == hba->pwr_info.pwr_tx &&
2342 pwr_mode->hs_rate == hba->pwr_info.hs_rate) {
2343 dev_dbg(hba->dev, "%s: power already configured\n", __func__);
2348 * Configure attributes for power mode change with below.
2349 * - PA_RXGEAR, PA_ACTIVERXDATALANES, PA_RXTERMINATION,
2350 * - PA_TXGEAR, PA_ACTIVETXDATALANES, PA_TXTERMINATION,
2353 ufshcd_dme_set(hba, UIC_ARG_MIB(PA_RXGEAR), pwr_mode->gear_rx);
2354 ufshcd_dme_set(hba, UIC_ARG_MIB(PA_ACTIVERXDATALANES),
2356 if (pwr_mode->pwr_rx == FASTAUTO_MODE ||
2357 pwr_mode->pwr_rx == FAST_MODE)
2358 ufshcd_dme_set(hba, UIC_ARG_MIB(PA_RXTERMINATION), TRUE);
2360 ufshcd_dme_set(hba, UIC_ARG_MIB(PA_RXTERMINATION), FALSE);
2362 ufshcd_dme_set(hba, UIC_ARG_MIB(PA_TXGEAR), pwr_mode->gear_tx);
2363 ufshcd_dme_set(hba, UIC_ARG_MIB(PA_ACTIVETXDATALANES),
2365 if (pwr_mode->pwr_tx == FASTAUTO_MODE ||
2366 pwr_mode->pwr_tx == FAST_MODE)
2367 ufshcd_dme_set(hba, UIC_ARG_MIB(PA_TXTERMINATION), TRUE);
2369 ufshcd_dme_set(hba, UIC_ARG_MIB(PA_TXTERMINATION), FALSE);
2371 if (pwr_mode->pwr_rx == FASTAUTO_MODE ||
2372 pwr_mode->pwr_tx == FASTAUTO_MODE ||
2373 pwr_mode->pwr_rx == FAST_MODE ||
2374 pwr_mode->pwr_tx == FAST_MODE)
2375 ufshcd_dme_set(hba, UIC_ARG_MIB(PA_HSSERIES),
2378 ret = ufshcd_uic_change_pwr_mode(hba, pwr_mode->pwr_rx << 4
2379 | pwr_mode->pwr_tx);
2383 "%s: power mode change failed %d\n", __func__, ret);
2385 if (hba->vops && hba->vops->pwr_change_notify)
2386 hba->vops->pwr_change_notify(hba,
2387 POST_CHANGE, NULL, pwr_mode);
2389 memcpy(&hba->pwr_info, pwr_mode,
2390 sizeof(struct ufs_pa_layer_attr));
2397 * ufshcd_config_pwr_mode - configure a new power mode
2398 * @hba: per-adapter instance
2399 * @desired_pwr_mode: desired power configuration
2401 static int ufshcd_config_pwr_mode(struct ufs_hba *hba,
2402 struct ufs_pa_layer_attr *desired_pwr_mode)
2404 struct ufs_pa_layer_attr final_params = { 0 };
2407 if (hba->vops && hba->vops->pwr_change_notify)
2408 hba->vops->pwr_change_notify(hba,
2409 PRE_CHANGE, desired_pwr_mode, &final_params);
2411 memcpy(&final_params, desired_pwr_mode, sizeof(final_params));
2413 ret = ufshcd_change_power_mode(hba, &final_params);
2419 * ufshcd_complete_dev_init() - checks device readiness
2420 * hba: per-adapter instance
2422 * Set fDeviceInit flag and poll until device toggles it.
2424 static int ufshcd_complete_dev_init(struct ufs_hba *hba)
2426 int i, retries, err = 0;
2429 for (retries = QUERY_REQ_RETRIES; retries > 0; retries--) {
2430 /* Set the fDeviceInit flag */
2431 err = ufshcd_query_flag(hba, UPIU_QUERY_OPCODE_SET_FLAG,
2432 QUERY_FLAG_IDN_FDEVICEINIT, NULL);
2433 if (!err || err == -ETIMEDOUT)
2435 dev_dbg(hba->dev, "%s: error %d retrying\n", __func__, err);
2439 "%s setting fDeviceInit flag failed with error %d\n",
2444 /* poll for max. 100 iterations for fDeviceInit flag to clear */
2445 for (i = 0; i < 100 && !err && flag_res; i++) {
2446 for (retries = QUERY_REQ_RETRIES; retries > 0; retries--) {
2447 err = ufshcd_query_flag(hba,
2448 UPIU_QUERY_OPCODE_READ_FLAG,
2449 QUERY_FLAG_IDN_FDEVICEINIT, &flag_res);
2450 if (!err || err == -ETIMEDOUT)
2452 dev_dbg(hba->dev, "%s: error %d retrying\n", __func__,
2458 "%s reading fDeviceInit flag failed with error %d\n",
2462 "%s fDeviceInit was not cleared by the device\n",
2470 * ufshcd_make_hba_operational - Make UFS controller operational
2471 * @hba: per adapter instance
2473 * To bring UFS host controller to operational state,
2474 * 1. Enable required interrupts
2475 * 2. Configure interrupt aggregation
2476 * 3. Program UTRL and UTMRL base addres
2477 * 4. Configure run-stop-registers
2479 * Returns 0 on success, non-zero value on failure
2481 static int ufshcd_make_hba_operational(struct ufs_hba *hba)
2486 /* Enable required interrupts */
2487 ufshcd_enable_intr(hba, UFSHCD_ENABLE_INTRS);
2489 /* Configure interrupt aggregation */
2490 ufshcd_config_intr_aggr(hba, hba->nutrs - 1, INT_AGGR_DEF_TO);
2492 /* Configure UTRL and UTMRL base address registers */
2493 ufshcd_writel(hba, lower_32_bits(hba->utrdl_dma_addr),
2494 REG_UTP_TRANSFER_REQ_LIST_BASE_L);
2495 ufshcd_writel(hba, upper_32_bits(hba->utrdl_dma_addr),
2496 REG_UTP_TRANSFER_REQ_LIST_BASE_H);
2497 ufshcd_writel(hba, lower_32_bits(hba->utmrdl_dma_addr),
2498 REG_UTP_TASK_REQ_LIST_BASE_L);
2499 ufshcd_writel(hba, upper_32_bits(hba->utmrdl_dma_addr),
2500 REG_UTP_TASK_REQ_LIST_BASE_H);
2503 * UCRDY, UTMRLDY and UTRLRDY bits must be 1
2504 * DEI, HEI bits must be 0
2506 reg = ufshcd_readl(hba, REG_CONTROLLER_STATUS);
2507 if (!(ufshcd_get_lists_status(reg))) {
2508 ufshcd_enable_run_stop_reg(hba);
2511 "Host controller not ready to process requests");
2521 * ufshcd_hba_enable - initialize the controller
2522 * @hba: per adapter instance
2524 * The controller resets itself and controller firmware initialization
2525 * sequence kicks off. When controller is ready it will set
2526 * the Host Controller Enable bit to 1.
2528 * Returns 0 on success, non-zero value on failure
2530 static int ufshcd_hba_enable(struct ufs_hba *hba)
2535 * msleep of 1 and 5 used in this function might result in msleep(20),
2536 * but it was necessary to send the UFS FPGA to reset mode during
2537 * development and testing of this driver. msleep can be changed to
2538 * mdelay and retry count can be reduced based on the controller.
2540 if (!ufshcd_is_hba_active(hba)) {
2542 /* change controller state to "reset state" */
2543 ufshcd_hba_stop(hba);
2546 * This delay is based on the testing done with UFS host
2547 * controller FPGA. The delay can be changed based on the
2548 * host controller used.
2553 /* UniPro link is disabled at this point */
2554 ufshcd_set_link_off(hba);
2556 if (hba->vops && hba->vops->hce_enable_notify)
2557 hba->vops->hce_enable_notify(hba, PRE_CHANGE);
2559 /* start controller initialization sequence */
2560 ufshcd_hba_start(hba);
2563 * To initialize a UFS host controller HCE bit must be set to 1.
2564 * During initialization the HCE bit value changes from 1->0->1.
2565 * When the host controller completes initialization sequence
2566 * it sets the value of HCE bit to 1. The same HCE bit is read back
2567 * to check if the controller has completed initialization sequence.
2568 * So without this delay the value HCE = 1, set in the previous
2569 * instruction might be read back.
2570 * This delay can be changed based on the controller.
2574 /* wait for the host controller to complete initialization */
2576 while (ufshcd_is_hba_active(hba)) {
2581 "Controller enable failed\n");
2587 /* enable UIC related interrupts */
2588 ufshcd_enable_intr(hba, UFSHCD_UIC_MASK);
2590 if (hba->vops && hba->vops->hce_enable_notify)
2591 hba->vops->hce_enable_notify(hba, POST_CHANGE);
2597 * ufshcd_link_startup - Initialize unipro link startup
2598 * @hba: per adapter instance
2600 * Returns 0 for success, non-zero in case of failure
2602 static int ufshcd_link_startup(struct ufs_hba *hba)
2605 int retries = DME_LINKSTARTUP_RETRIES;
2608 if (hba->vops && hba->vops->link_startup_notify)
2609 hba->vops->link_startup_notify(hba, PRE_CHANGE);
2611 ret = ufshcd_dme_link_startup(hba);
2613 /* check if device is detected by inter-connect layer */
2614 if (!ret && !ufshcd_is_device_present(hba)) {
2615 dev_err(hba->dev, "%s: Device not present\n", __func__);
2621 * DME link lost indication is only received when link is up,
2622 * but we can't be sure if the link is up until link startup
2623 * succeeds. So reset the local Uni-Pro and try again.
2625 if (ret && ufshcd_hba_enable(hba))
2627 } while (ret && retries--);
2630 /* failed to get the link up... retire */
2633 /* Include any host controller configuration via UIC commands */
2634 if (hba->vops && hba->vops->link_startup_notify) {
2635 ret = hba->vops->link_startup_notify(hba, POST_CHANGE);
2640 ret = ufshcd_make_hba_operational(hba);
2643 dev_err(hba->dev, "link startup failed %d\n", ret);
2648 * ufshcd_verify_dev_init() - Verify device initialization
2649 * @hba: per-adapter instance
2651 * Send NOP OUT UPIU and wait for NOP IN response to check whether the
2652 * device Transport Protocol (UTP) layer is ready after a reset.
2653 * If the UTP layer at the device side is not initialized, it may
2654 * not respond with NOP IN UPIU within timeout of %NOP_OUT_TIMEOUT
2655 * and we retry sending NOP OUT for %NOP_OUT_RETRIES iterations.
2657 static int ufshcd_verify_dev_init(struct ufs_hba *hba)
2662 ufshcd_hold(hba, false);
2663 mutex_lock(&hba->dev_cmd.lock);
2664 for (retries = NOP_OUT_RETRIES; retries > 0; retries--) {
2665 err = ufshcd_exec_dev_cmd(hba, DEV_CMD_TYPE_NOP,
2668 if (!err || err == -ETIMEDOUT)
2671 dev_dbg(hba->dev, "%s: error %d retrying\n", __func__, err);
2673 mutex_unlock(&hba->dev_cmd.lock);
2674 ufshcd_release(hba);
2677 dev_err(hba->dev, "%s: NOP OUT failed %d\n", __func__, err);
2682 * ufshcd_set_queue_depth - set lun queue depth
2683 * @sdev: pointer to SCSI device
2685 * Read bLUQueueDepth value and activate scsi tagged command
2686 * queueing. For WLUN, queue depth is set to 1. For best-effort
2687 * cases (bLUQueueDepth = 0) the queue depth is set to a maximum
2688 * value that host can queue.
2690 static void ufshcd_set_queue_depth(struct scsi_device *sdev)
2694 struct ufs_hba *hba;
2696 hba = shost_priv(sdev->host);
2698 lun_qdepth = hba->nutrs;
2699 ret = ufshcd_read_unit_desc_param(hba,
2700 ufshcd_scsi_to_upiu_lun(sdev->lun),
2701 UNIT_DESC_PARAM_LU_Q_DEPTH,
2703 sizeof(lun_qdepth));
2705 /* Some WLUN doesn't support unit descriptor */
2706 if (ret == -EOPNOTSUPP)
2708 else if (!lun_qdepth)
2709 /* eventually, we can figure out the real queue depth */
2710 lun_qdepth = hba->nutrs;
2712 lun_qdepth = min_t(int, lun_qdepth, hba->nutrs);
2714 dev_dbg(hba->dev, "%s: activate tcq with queue depth %d\n",
2715 __func__, lun_qdepth);
2716 scsi_change_queue_depth(sdev, lun_qdepth);
2720 * ufshcd_get_lu_wp - returns the "b_lu_write_protect" from UNIT DESCRIPTOR
2721 * @hba: per-adapter instance
2722 * @lun: UFS device lun id
2723 * @b_lu_write_protect: pointer to buffer to hold the LU's write protect info
2725 * Returns 0 in case of success and b_lu_write_protect status would be returned
2726 * @b_lu_write_protect parameter.
2727 * Returns -ENOTSUPP if reading b_lu_write_protect is not supported.
2728 * Returns -EINVAL in case of invalid parameters passed to this function.
2730 static int ufshcd_get_lu_wp(struct ufs_hba *hba,
2732 u8 *b_lu_write_protect)
2736 if (!b_lu_write_protect)
2739 * According to UFS device spec, RPMB LU can't be write
2740 * protected so skip reading bLUWriteProtect parameter for
2741 * it. For other W-LUs, UNIT DESCRIPTOR is not available.
2743 else if (lun >= UFS_UPIU_MAX_GENERAL_LUN)
2746 ret = ufshcd_read_unit_desc_param(hba,
2748 UNIT_DESC_PARAM_LU_WR_PROTECT,
2750 sizeof(*b_lu_write_protect));
2755 * ufshcd_get_lu_power_on_wp_status - get LU's power on write protect
2757 * @hba: per-adapter instance
2758 * @sdev: pointer to SCSI device
2761 static inline void ufshcd_get_lu_power_on_wp_status(struct ufs_hba *hba,
2762 struct scsi_device *sdev)
2764 if (hba->dev_info.f_power_on_wp_en &&
2765 !hba->dev_info.is_lu_power_on_wp) {
2766 u8 b_lu_write_protect;
2768 if (!ufshcd_get_lu_wp(hba, ufshcd_scsi_to_upiu_lun(sdev->lun),
2769 &b_lu_write_protect) &&
2770 (b_lu_write_protect == UFS_LU_POWER_ON_WP))
2771 hba->dev_info.is_lu_power_on_wp = true;
2776 * ufshcd_slave_alloc - handle initial SCSI device configurations
2777 * @sdev: pointer to SCSI device
2781 static int ufshcd_slave_alloc(struct scsi_device *sdev)
2783 struct ufs_hba *hba;
2785 hba = shost_priv(sdev->host);
2787 /* Mode sense(6) is not supported by UFS, so use Mode sense(10) */
2788 sdev->use_10_for_ms = 1;
2790 /* allow SCSI layer to restart the device in case of errors */
2791 sdev->allow_restart = 1;
2793 /* REPORT SUPPORTED OPERATION CODES is not supported */
2794 sdev->no_report_opcodes = 1;
2797 ufshcd_set_queue_depth(sdev);
2799 ufshcd_get_lu_power_on_wp_status(hba, sdev);
2805 * ufshcd_change_queue_depth - change queue depth
2806 * @sdev: pointer to SCSI device
2807 * @depth: required depth to set
2809 * Change queue depth and make sure the max. limits are not crossed.
2811 static int ufshcd_change_queue_depth(struct scsi_device *sdev, int depth)
2813 struct ufs_hba *hba = shost_priv(sdev->host);
2815 if (depth > hba->nutrs)
2817 return scsi_change_queue_depth(sdev, depth);
2821 * ufshcd_slave_configure - adjust SCSI device configurations
2822 * @sdev: pointer to SCSI device
2824 static int ufshcd_slave_configure(struct scsi_device *sdev)
2826 struct request_queue *q = sdev->request_queue;
2828 blk_queue_update_dma_pad(q, PRDT_DATA_BYTE_COUNT_PAD - 1);
2829 blk_queue_max_segment_size(q, PRDT_DATA_BYTE_COUNT_MAX);
2835 * ufshcd_slave_destroy - remove SCSI device configurations
2836 * @sdev: pointer to SCSI device
2838 static void ufshcd_slave_destroy(struct scsi_device *sdev)
2840 struct ufs_hba *hba;
2842 hba = shost_priv(sdev->host);
2843 /* Drop the reference as it won't be needed anymore */
2844 if (ufshcd_scsi_to_upiu_lun(sdev->lun) == UFS_UPIU_UFS_DEVICE_WLUN) {
2845 unsigned long flags;
2847 spin_lock_irqsave(hba->host->host_lock, flags);
2848 hba->sdev_ufs_device = NULL;
2849 spin_unlock_irqrestore(hba->host->host_lock, flags);
2854 * ufshcd_task_req_compl - handle task management request completion
2855 * @hba: per adapter instance
2856 * @index: index of the completed request
2857 * @resp: task management service response
2859 * Returns non-zero value on error, zero on success
2861 static int ufshcd_task_req_compl(struct ufs_hba *hba, u32 index, u8 *resp)
2863 struct utp_task_req_desc *task_req_descp;
2864 struct utp_upiu_task_rsp *task_rsp_upiup;
2865 unsigned long flags;
2869 spin_lock_irqsave(hba->host->host_lock, flags);
2871 /* Clear completed tasks from outstanding_tasks */
2872 __clear_bit(index, &hba->outstanding_tasks);
2874 task_req_descp = hba->utmrdl_base_addr;
2875 ocs_value = ufshcd_get_tmr_ocs(&task_req_descp[index]);
2877 if (ocs_value == OCS_SUCCESS) {
2878 task_rsp_upiup = (struct utp_upiu_task_rsp *)
2879 task_req_descp[index].task_rsp_upiu;
2880 task_result = be32_to_cpu(task_rsp_upiup->header.dword_1);
2881 task_result = ((task_result & MASK_TASK_RESPONSE) >> 8);
2883 *resp = (u8)task_result;
2885 dev_err(hba->dev, "%s: failed, ocs = 0x%x\n",
2886 __func__, ocs_value);
2888 spin_unlock_irqrestore(hba->host->host_lock, flags);
2894 * ufshcd_scsi_cmd_status - Update SCSI command result based on SCSI status
2895 * @lrb: pointer to local reference block of completed command
2896 * @scsi_status: SCSI command status
2898 * Returns value base on SCSI command status
2901 ufshcd_scsi_cmd_status(struct ufshcd_lrb *lrbp, int scsi_status)
2905 switch (scsi_status) {
2906 case SAM_STAT_CHECK_CONDITION:
2907 ufshcd_copy_sense_data(lrbp);
2909 result |= DID_OK << 16 |
2910 COMMAND_COMPLETE << 8 |
2913 case SAM_STAT_TASK_SET_FULL:
2915 case SAM_STAT_TASK_ABORTED:
2916 ufshcd_copy_sense_data(lrbp);
2917 result |= scsi_status;
2920 result |= DID_ERROR << 16;
2922 } /* end of switch */
2928 * ufshcd_transfer_rsp_status - Get overall status of the response
2929 * @hba: per adapter instance
2930 * @lrb: pointer to local reference block of completed command
2932 * Returns result of the command to notify SCSI midlayer
2935 ufshcd_transfer_rsp_status(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
2941 /* overall command status of utrd */
2942 ocs = ufshcd_get_tr_ocs(lrbp);
2946 result = ufshcd_get_req_rsp(lrbp->ucd_rsp_ptr);
2949 case UPIU_TRANSACTION_RESPONSE:
2951 * get the response UPIU result to extract
2952 * the SCSI command status
2954 result = ufshcd_get_rsp_upiu_result(lrbp->ucd_rsp_ptr);
2957 * get the result based on SCSI status response
2958 * to notify the SCSI midlayer of the command status
2960 scsi_status = result & MASK_SCSI_STATUS;
2961 result = ufshcd_scsi_cmd_status(lrbp, scsi_status);
2963 if (ufshcd_is_exception_event(lrbp->ucd_rsp_ptr))
2964 schedule_work(&hba->eeh_work);
2966 case UPIU_TRANSACTION_REJECT_UPIU:
2967 /* TODO: handle Reject UPIU Response */
2968 result = DID_ERROR << 16;
2970 "Reject UPIU not fully implemented\n");
2973 result = DID_ERROR << 16;
2975 "Unexpected request response code = %x\n",
2981 result |= DID_ABORT << 16;
2983 case OCS_INVALID_COMMAND_STATUS:
2984 result |= DID_REQUEUE << 16;
2986 case OCS_INVALID_CMD_TABLE_ATTR:
2987 case OCS_INVALID_PRDT_ATTR:
2988 case OCS_MISMATCH_DATA_BUF_SIZE:
2989 case OCS_MISMATCH_RESP_UPIU_SIZE:
2990 case OCS_PEER_COMM_FAILURE:
2991 case OCS_FATAL_ERROR:
2993 result |= DID_ERROR << 16;
2995 "OCS error from controller = %x\n", ocs);
2997 } /* end of switch */
3003 * ufshcd_uic_cmd_compl - handle completion of uic command
3004 * @hba: per adapter instance
3005 * @intr_status: interrupt status generated by the controller
3007 static void ufshcd_uic_cmd_compl(struct ufs_hba *hba, u32 intr_status)
3009 if ((intr_status & UIC_COMMAND_COMPL) && hba->active_uic_cmd) {
3010 hba->active_uic_cmd->argument2 |=
3011 ufshcd_get_uic_cmd_result(hba);
3012 hba->active_uic_cmd->argument3 =
3013 ufshcd_get_dme_attr_val(hba);
3014 complete(&hba->active_uic_cmd->done);
3017 if ((intr_status & UFSHCD_UIC_PWR_MASK) && hba->uic_async_done)
3018 complete(hba->uic_async_done);
3022 * ufshcd_transfer_req_compl - handle SCSI and query command completion
3023 * @hba: per adapter instance
3025 static void ufshcd_transfer_req_compl(struct ufs_hba *hba)
3027 struct ufshcd_lrb *lrbp;
3028 struct scsi_cmnd *cmd;
3029 unsigned long completed_reqs;
3034 /* Resetting interrupt aggregation counters first and reading the
3035 * DOOR_BELL afterward allows us to handle all the completed requests.
3036 * In order to prevent other interrupts starvation the DB is read once
3037 * after reset. The down side of this solution is the possibility of
3038 * false interrupt if device completes another request after resetting
3039 * aggregation and before reading the DB.
3041 ufshcd_reset_intr_aggr(hba);
3043 tr_doorbell = ufshcd_readl(hba, REG_UTP_TRANSFER_REQ_DOOR_BELL);
3044 completed_reqs = tr_doorbell ^ hba->outstanding_reqs;
3046 for_each_set_bit(index, &completed_reqs, hba->nutrs) {
3047 lrbp = &hba->lrb[index];
3050 result = ufshcd_transfer_rsp_status(hba, lrbp);
3051 scsi_dma_unmap(cmd);
3052 cmd->result = result;
3053 /* Mark completed command as NULL in LRB */
3055 clear_bit_unlock(index, &hba->lrb_in_use);
3056 /* Do not touch lrbp after scsi done */
3057 cmd->scsi_done(cmd);
3058 __ufshcd_release(hba);
3059 } else if (lrbp->command_type == UTP_CMD_TYPE_DEV_MANAGE) {
3060 if (hba->dev_cmd.complete)
3061 complete(hba->dev_cmd.complete);
3065 /* clear corresponding bits of completed commands */
3066 hba->outstanding_reqs ^= completed_reqs;
3068 ufshcd_clk_scaling_update_busy(hba);
3070 /* we might have free'd some tags above */
3071 wake_up(&hba->dev_cmd.tag_wq);
3075 * ufshcd_disable_ee - disable exception event
3076 * @hba: per-adapter instance
3077 * @mask: exception event to disable
3079 * Disables exception event in the device so that the EVENT_ALERT
3082 * Returns zero on success, non-zero error value on failure.
3084 static int ufshcd_disable_ee(struct ufs_hba *hba, u16 mask)
3089 if (!(hba->ee_ctrl_mask & mask))
3092 val = hba->ee_ctrl_mask & ~mask;
3093 val &= 0xFFFF; /* 2 bytes */
3094 err = ufshcd_query_attr(hba, UPIU_QUERY_OPCODE_WRITE_ATTR,
3095 QUERY_ATTR_IDN_EE_CONTROL, 0, 0, &val);
3097 hba->ee_ctrl_mask &= ~mask;
3103 * ufshcd_enable_ee - enable exception event
3104 * @hba: per-adapter instance
3105 * @mask: exception event to enable
3107 * Enable corresponding exception event in the device to allow
3108 * device to alert host in critical scenarios.
3110 * Returns zero on success, non-zero error value on failure.
3112 static int ufshcd_enable_ee(struct ufs_hba *hba, u16 mask)
3117 if (hba->ee_ctrl_mask & mask)
3120 val = hba->ee_ctrl_mask | mask;
3121 val &= 0xFFFF; /* 2 bytes */
3122 err = ufshcd_query_attr(hba, UPIU_QUERY_OPCODE_WRITE_ATTR,
3123 QUERY_ATTR_IDN_EE_CONTROL, 0, 0, &val);
3125 hba->ee_ctrl_mask |= mask;
3131 * ufshcd_enable_auto_bkops - Allow device managed BKOPS
3132 * @hba: per-adapter instance
3134 * Allow device to manage background operations on its own. Enabling
3135 * this might lead to inconsistent latencies during normal data transfers
3136 * as the device is allowed to manage its own way of handling background
3139 * Returns zero on success, non-zero on failure.
3141 static int ufshcd_enable_auto_bkops(struct ufs_hba *hba)
3145 if (hba->auto_bkops_enabled)
3148 err = ufshcd_query_flag(hba, UPIU_QUERY_OPCODE_SET_FLAG,
3149 QUERY_FLAG_IDN_BKOPS_EN, NULL);
3151 dev_err(hba->dev, "%s: failed to enable bkops %d\n",
3156 hba->auto_bkops_enabled = true;
3158 /* No need of URGENT_BKOPS exception from the device */
3159 err = ufshcd_disable_ee(hba, MASK_EE_URGENT_BKOPS);
3161 dev_err(hba->dev, "%s: failed to disable exception event %d\n",
3168 * ufshcd_disable_auto_bkops - block device in doing background operations
3169 * @hba: per-adapter instance
3171 * Disabling background operations improves command response latency but
3172 * has drawback of device moving into critical state where the device is
3173 * not-operable. Make sure to call ufshcd_enable_auto_bkops() whenever the
3174 * host is idle so that BKOPS are managed effectively without any negative
3177 * Returns zero on success, non-zero on failure.
3179 static int ufshcd_disable_auto_bkops(struct ufs_hba *hba)
3183 if (!hba->auto_bkops_enabled)
3187 * If host assisted BKOPs is to be enabled, make sure
3188 * urgent bkops exception is allowed.
3190 err = ufshcd_enable_ee(hba, MASK_EE_URGENT_BKOPS);
3192 dev_err(hba->dev, "%s: failed to enable exception event %d\n",
3197 err = ufshcd_query_flag(hba, UPIU_QUERY_OPCODE_CLEAR_FLAG,
3198 QUERY_FLAG_IDN_BKOPS_EN, NULL);
3200 dev_err(hba->dev, "%s: failed to disable bkops %d\n",
3202 ufshcd_disable_ee(hba, MASK_EE_URGENT_BKOPS);
3206 hba->auto_bkops_enabled = false;
3212 * ufshcd_force_reset_auto_bkops - force enable of auto bkops
3213 * @hba: per adapter instance
3215 * After a device reset the device may toggle the BKOPS_EN flag
3216 * to default value. The s/w tracking variables should be updated
3217 * as well. Do this by forcing enable of auto bkops.
3219 static void ufshcd_force_reset_auto_bkops(struct ufs_hba *hba)
3221 hba->auto_bkops_enabled = false;
3222 hba->ee_ctrl_mask |= MASK_EE_URGENT_BKOPS;
3223 ufshcd_enable_auto_bkops(hba);
3226 static inline int ufshcd_get_bkops_status(struct ufs_hba *hba, u32 *status)
3228 return ufshcd_query_attr(hba, UPIU_QUERY_OPCODE_READ_ATTR,
3229 QUERY_ATTR_IDN_BKOPS_STATUS, 0, 0, status);
3233 * ufshcd_bkops_ctrl - control the auto bkops based on current bkops status
3234 * @hba: per-adapter instance
3235 * @status: bkops_status value
3237 * Read the bkops_status from the UFS device and Enable fBackgroundOpsEn
3238 * flag in the device to permit background operations if the device
3239 * bkops_status is greater than or equal to "status" argument passed to
3240 * this function, disable otherwise.
3242 * Returns 0 for success, non-zero in case of failure.
3244 * NOTE: Caller of this function can check the "hba->auto_bkops_enabled" flag
3245 * to know whether auto bkops is enabled or disabled after this function
3246 * returns control to it.
3248 static int ufshcd_bkops_ctrl(struct ufs_hba *hba,
3249 enum bkops_status status)
3252 u32 curr_status = 0;
3254 err = ufshcd_get_bkops_status(hba, &curr_status);
3256 dev_err(hba->dev, "%s: failed to get BKOPS status %d\n",
3259 } else if (curr_status > BKOPS_STATUS_MAX) {
3260 dev_err(hba->dev, "%s: invalid BKOPS status %d\n",
3261 __func__, curr_status);
3266 if (curr_status >= status)
3267 err = ufshcd_enable_auto_bkops(hba);
3269 err = ufshcd_disable_auto_bkops(hba);
3275 * ufshcd_urgent_bkops - handle urgent bkops exception event
3276 * @hba: per-adapter instance
3278 * Enable fBackgroundOpsEn flag in the device to permit background
3281 * If BKOPs is enabled, this function returns 0, 1 if the bkops in not enabled
3282 * and negative error value for any other failure.
3284 static int ufshcd_urgent_bkops(struct ufs_hba *hba)
3286 return ufshcd_bkops_ctrl(hba, BKOPS_STATUS_PERF_IMPACT);
3289 static inline int ufshcd_get_ee_status(struct ufs_hba *hba, u32 *status)
3291 return ufshcd_query_attr(hba, UPIU_QUERY_OPCODE_READ_ATTR,
3292 QUERY_ATTR_IDN_EE_STATUS, 0, 0, status);
3296 * ufshcd_exception_event_handler - handle exceptions raised by device
3297 * @work: pointer to work data
3299 * Read bExceptionEventStatus attribute from the device and handle the
3300 * exception event accordingly.
3302 static void ufshcd_exception_event_handler(struct work_struct *work)
3304 struct ufs_hba *hba;
3307 hba = container_of(work, struct ufs_hba, eeh_work);
3309 pm_runtime_get_sync(hba->dev);
3310 err = ufshcd_get_ee_status(hba, &status);
3312 dev_err(hba->dev, "%s: failed to get exception status %d\n",
3317 status &= hba->ee_ctrl_mask;
3318 if (status & MASK_EE_URGENT_BKOPS) {
3319 err = ufshcd_urgent_bkops(hba);
3321 dev_err(hba->dev, "%s: failed to handle urgent bkops %d\n",
3325 pm_runtime_put_sync(hba->dev);
3330 * ufshcd_err_handler - handle UFS errors that require s/w attention
3331 * @work: pointer to work structure
3333 static void ufshcd_err_handler(struct work_struct *work)
3335 struct ufs_hba *hba;
3336 unsigned long flags;
3342 hba = container_of(work, struct ufs_hba, eh_work);
3344 pm_runtime_get_sync(hba->dev);
3345 ufshcd_hold(hba, false);
3347 spin_lock_irqsave(hba->host->host_lock, flags);
3348 if (hba->ufshcd_state == UFSHCD_STATE_RESET) {
3349 spin_unlock_irqrestore(hba->host->host_lock, flags);
3353 hba->ufshcd_state = UFSHCD_STATE_RESET;
3354 ufshcd_set_eh_in_progress(hba);
3356 /* Complete requests that have door-bell cleared by h/w */
3357 ufshcd_transfer_req_compl(hba);
3358 ufshcd_tmc_handler(hba);
3359 spin_unlock_irqrestore(hba->host->host_lock, flags);
3361 /* Clear pending transfer requests */
3362 for_each_set_bit(tag, &hba->outstanding_reqs, hba->nutrs)
3363 if (ufshcd_clear_cmd(hba, tag))
3364 err_xfer |= 1 << tag;
3366 /* Clear pending task management requests */
3367 for_each_set_bit(tag, &hba->outstanding_tasks, hba->nutmrs)
3368 if (ufshcd_clear_tm_cmd(hba, tag))
3371 /* Complete the requests that are cleared by s/w */
3372 spin_lock_irqsave(hba->host->host_lock, flags);
3373 ufshcd_transfer_req_compl(hba);
3374 ufshcd_tmc_handler(hba);
3375 spin_unlock_irqrestore(hba->host->host_lock, flags);
3377 /* Fatal errors need reset */
3378 if (err_xfer || err_tm || (hba->saved_err & INT_FATAL_ERRORS) ||
3379 ((hba->saved_err & UIC_ERROR) &&
3380 (hba->saved_uic_err & UFSHCD_UIC_DL_PA_INIT_ERROR))) {
3381 err = ufshcd_reset_and_restore(hba);
3383 dev_err(hba->dev, "%s: reset and restore failed\n",
3385 hba->ufshcd_state = UFSHCD_STATE_ERROR;
3388 * Inform scsi mid-layer that we did reset and allow to handle
3389 * Unit Attention properly.
3391 scsi_report_bus_reset(hba->host, 0);
3393 hba->saved_uic_err = 0;
3395 ufshcd_clear_eh_in_progress(hba);
3398 scsi_unblock_requests(hba->host);
3399 ufshcd_release(hba);
3400 pm_runtime_put_sync(hba->dev);
3404 * ufshcd_update_uic_error - check and set fatal UIC error flags.
3405 * @hba: per-adapter instance
3407 static void ufshcd_update_uic_error(struct ufs_hba *hba)
3411 /* PA_INIT_ERROR is fatal and needs UIC reset */
3412 reg = ufshcd_readl(hba, REG_UIC_ERROR_CODE_DATA_LINK_LAYER);
3413 if (reg & UIC_DATA_LINK_LAYER_ERROR_PA_INIT)
3414 hba->uic_error |= UFSHCD_UIC_DL_PA_INIT_ERROR;
3416 /* UIC NL/TL/DME errors needs software retry */
3417 reg = ufshcd_readl(hba, REG_UIC_ERROR_CODE_NETWORK_LAYER);
3419 hba->uic_error |= UFSHCD_UIC_NL_ERROR;
3421 reg = ufshcd_readl(hba, REG_UIC_ERROR_CODE_TRANSPORT_LAYER);
3423 hba->uic_error |= UFSHCD_UIC_TL_ERROR;
3425 reg = ufshcd_readl(hba, REG_UIC_ERROR_CODE_DME);
3427 hba->uic_error |= UFSHCD_UIC_DME_ERROR;
3429 dev_dbg(hba->dev, "%s: UIC error flags = 0x%08x\n",
3430 __func__, hba->uic_error);
3434 * ufshcd_check_errors - Check for errors that need s/w attention
3435 * @hba: per-adapter instance
3437 static void ufshcd_check_errors(struct ufs_hba *hba)
3439 bool queue_eh_work = false;
3441 if (hba->errors & INT_FATAL_ERRORS)
3442 queue_eh_work = true;
3444 if (hba->errors & UIC_ERROR) {
3446 ufshcd_update_uic_error(hba);
3448 queue_eh_work = true;
3451 if (queue_eh_work) {
3452 /* handle fatal errors only when link is functional */
3453 if (hba->ufshcd_state == UFSHCD_STATE_OPERATIONAL) {
3454 /* block commands from scsi mid-layer */
3455 scsi_block_requests(hba->host);
3457 /* transfer error masks to sticky bits */
3458 hba->saved_err |= hba->errors;
3459 hba->saved_uic_err |= hba->uic_error;
3461 hba->ufshcd_state = UFSHCD_STATE_ERROR;
3462 schedule_work(&hba->eh_work);
3466 * if (!queue_eh_work) -
3467 * Other errors are either non-fatal where host recovers
3468 * itself without s/w intervention or errors that will be
3469 * handled by the SCSI core layer.
3474 * ufshcd_tmc_handler - handle task management function completion
3475 * @hba: per adapter instance
3477 static void ufshcd_tmc_handler(struct ufs_hba *hba)
3481 tm_doorbell = ufshcd_readl(hba, REG_UTP_TASK_REQ_DOOR_BELL);
3482 hba->tm_condition = tm_doorbell ^ hba->outstanding_tasks;
3483 wake_up(&hba->tm_wq);
3487 * ufshcd_sl_intr - Interrupt service routine
3488 * @hba: per adapter instance
3489 * @intr_status: contains interrupts generated by the controller
3491 static void ufshcd_sl_intr(struct ufs_hba *hba, u32 intr_status)
3493 hba->errors = UFSHCD_ERROR_MASK & intr_status;
3495 ufshcd_check_errors(hba);
3497 if (intr_status & UFSHCD_UIC_MASK)
3498 ufshcd_uic_cmd_compl(hba, intr_status);
3500 if (intr_status & UTP_TASK_REQ_COMPL)
3501 ufshcd_tmc_handler(hba);
3503 if (intr_status & UTP_TRANSFER_REQ_COMPL)
3504 ufshcd_transfer_req_compl(hba);
3508 * ufshcd_intr - Main interrupt service routine
3510 * @__hba: pointer to adapter instance
3512 * Returns IRQ_HANDLED - If interrupt is valid
3513 * IRQ_NONE - If invalid interrupt
3515 static irqreturn_t ufshcd_intr(int irq, void *__hba)
3518 irqreturn_t retval = IRQ_NONE;
3519 struct ufs_hba *hba = __hba;
3521 spin_lock(hba->host->host_lock);
3522 intr_status = ufshcd_readl(hba, REG_INTERRUPT_STATUS);
3525 ufshcd_writel(hba, intr_status, REG_INTERRUPT_STATUS);
3526 ufshcd_sl_intr(hba, intr_status);
3527 retval = IRQ_HANDLED;
3529 spin_unlock(hba->host->host_lock);
3533 static int ufshcd_clear_tm_cmd(struct ufs_hba *hba, int tag)
3536 u32 mask = 1 << tag;
3537 unsigned long flags;
3539 if (!test_bit(tag, &hba->outstanding_tasks))
3542 spin_lock_irqsave(hba->host->host_lock, flags);
3543 ufshcd_writel(hba, ~(1 << tag), REG_UTP_TASK_REQ_LIST_CLEAR);
3544 spin_unlock_irqrestore(hba->host->host_lock, flags);
3546 /* poll for max. 1 sec to clear door bell register by h/w */
3547 err = ufshcd_wait_for_register(hba,
3548 REG_UTP_TASK_REQ_DOOR_BELL,
3549 mask, 0, 1000, 1000);
3555 * ufshcd_issue_tm_cmd - issues task management commands to controller
3556 * @hba: per adapter instance
3557 * @lun_id: LUN ID to which TM command is sent
3558 * @task_id: task ID to which the TM command is applicable
3559 * @tm_function: task management function opcode
3560 * @tm_response: task management service response return value
3562 * Returns non-zero value on error, zero on success.
3564 static int ufshcd_issue_tm_cmd(struct ufs_hba *hba, int lun_id, int task_id,
3565 u8 tm_function, u8 *tm_response)
3567 struct utp_task_req_desc *task_req_descp;
3568 struct utp_upiu_task_req *task_req_upiup;
3569 struct Scsi_Host *host;
3570 unsigned long flags;
3578 * Get free slot, sleep if slots are unavailable.
3579 * Even though we use wait_event() which sleeps indefinitely,
3580 * the maximum wait time is bounded by %TM_CMD_TIMEOUT.
3582 wait_event(hba->tm_tag_wq, ufshcd_get_tm_free_slot(hba, &free_slot));
3583 ufshcd_hold(hba, false);
3585 spin_lock_irqsave(host->host_lock, flags);
3586 task_req_descp = hba->utmrdl_base_addr;
3587 task_req_descp += free_slot;
3589 /* Configure task request descriptor */
3590 task_req_descp->header.dword_0 = cpu_to_le32(UTP_REQ_DESC_INT_CMD);
3591 task_req_descp->header.dword_2 =
3592 cpu_to_le32(OCS_INVALID_COMMAND_STATUS);
3594 /* Configure task request UPIU */
3596 (struct utp_upiu_task_req *) task_req_descp->task_req_upiu;
3597 task_tag = hba->nutrs + free_slot;
3598 task_req_upiup->header.dword_0 =
3599 UPIU_HEADER_DWORD(UPIU_TRANSACTION_TASK_REQ, 0,
3601 task_req_upiup->header.dword_1 =
3602 UPIU_HEADER_DWORD(0, tm_function, 0, 0);
3604 * The host shall provide the same value for LUN field in the basic
3605 * header and for Input Parameter.
3607 task_req_upiup->input_param1 = cpu_to_be32(lun_id);
3608 task_req_upiup->input_param2 = cpu_to_be32(task_id);
3610 /* send command to the controller */
3611 __set_bit(free_slot, &hba->outstanding_tasks);
3612 ufshcd_writel(hba, 1 << free_slot, REG_UTP_TASK_REQ_DOOR_BELL);
3614 spin_unlock_irqrestore(host->host_lock, flags);
3616 /* wait until the task management command is completed */
3617 err = wait_event_timeout(hba->tm_wq,
3618 test_bit(free_slot, &hba->tm_condition),
3619 msecs_to_jiffies(TM_CMD_TIMEOUT));
3621 dev_err(hba->dev, "%s: task management cmd 0x%.2x timed-out\n",
3622 __func__, tm_function);
3623 if (ufshcd_clear_tm_cmd(hba, free_slot))
3624 dev_WARN(hba->dev, "%s: unable clear tm cmd (slot %d) after timeout\n",
3625 __func__, free_slot);
3628 err = ufshcd_task_req_compl(hba, free_slot, tm_response);
3631 clear_bit(free_slot, &hba->tm_condition);
3632 ufshcd_put_tm_slot(hba, free_slot);
3633 wake_up(&hba->tm_tag_wq);
3635 ufshcd_release(hba);
3640 * ufshcd_eh_device_reset_handler - device reset handler registered to
3642 * @cmd: SCSI command pointer
3644 * Returns SUCCESS/FAILED
3646 static int ufshcd_eh_device_reset_handler(struct scsi_cmnd *cmd)
3648 struct Scsi_Host *host;
3649 struct ufs_hba *hba;
3654 struct ufshcd_lrb *lrbp;
3655 unsigned long flags;
3657 host = cmd->device->host;
3658 hba = shost_priv(host);
3659 tag = cmd->request->tag;
3661 lrbp = &hba->lrb[tag];
3662 err = ufshcd_issue_tm_cmd(hba, lrbp->lun, 0, UFS_LOGICAL_RESET, &resp);
3663 if (err || resp != UPIU_TASK_MANAGEMENT_FUNC_COMPL) {
3669 /* clear the commands that were pending for corresponding LUN */
3670 for_each_set_bit(pos, &hba->outstanding_reqs, hba->nutrs) {
3671 if (hba->lrb[pos].lun == lrbp->lun) {
3672 err = ufshcd_clear_cmd(hba, pos);
3677 spin_lock_irqsave(host->host_lock, flags);
3678 ufshcd_transfer_req_compl(hba);
3679 spin_unlock_irqrestore(host->host_lock, flags);
3684 dev_err(hba->dev, "%s: failed with err %d\n", __func__, err);
3691 * ufshcd_abort - abort a specific command
3692 * @cmd: SCSI command pointer
3694 * Abort the pending command in device by sending UFS_ABORT_TASK task management
3695 * command, and in host controller by clearing the door-bell register. There can
3696 * be race between controller sending the command to the device while abort is
3697 * issued. To avoid that, first issue UFS_QUERY_TASK to check if the command is
3698 * really issued and then try to abort it.
3700 * Returns SUCCESS/FAILED
3702 static int ufshcd_abort(struct scsi_cmnd *cmd)
3704 struct Scsi_Host *host;
3705 struct ufs_hba *hba;
3706 unsigned long flags;
3711 struct ufshcd_lrb *lrbp;
3714 host = cmd->device->host;
3715 hba = shost_priv(host);
3716 tag = cmd->request->tag;
3718 ufshcd_hold(hba, false);
3719 /* If command is already aborted/completed, return SUCCESS */
3720 if (!(test_bit(tag, &hba->outstanding_reqs)))
3723 reg = ufshcd_readl(hba, REG_UTP_TRANSFER_REQ_DOOR_BELL);
3724 if (!(reg & (1 << tag))) {
3726 "%s: cmd was completed, but without a notifying intr, tag = %d",
3730 lrbp = &hba->lrb[tag];
3731 for (poll_cnt = 100; poll_cnt; poll_cnt--) {
3732 err = ufshcd_issue_tm_cmd(hba, lrbp->lun, lrbp->task_tag,
3733 UFS_QUERY_TASK, &resp);
3734 if (!err && resp == UPIU_TASK_MANAGEMENT_FUNC_SUCCEEDED) {
3735 /* cmd pending in the device */
3737 } else if (!err && resp == UPIU_TASK_MANAGEMENT_FUNC_COMPL) {
3739 * cmd not pending in the device, check if it is
3742 reg = ufshcd_readl(hba, REG_UTP_TRANSFER_REQ_DOOR_BELL);
3743 if (reg & (1 << tag)) {
3744 /* sleep for max. 200us to stabilize */
3745 usleep_range(100, 200);
3748 /* command completed already */
3752 err = resp; /* service response error */
3762 err = ufshcd_issue_tm_cmd(hba, lrbp->lun, lrbp->task_tag,
3763 UFS_ABORT_TASK, &resp);
3764 if (err || resp != UPIU_TASK_MANAGEMENT_FUNC_COMPL) {
3766 err = resp; /* service response error */
3770 err = ufshcd_clear_cmd(hba, tag);
3774 scsi_dma_unmap(cmd);
3776 spin_lock_irqsave(host->host_lock, flags);
3777 __clear_bit(tag, &hba->outstanding_reqs);
3778 hba->lrb[tag].cmd = NULL;
3779 spin_unlock_irqrestore(host->host_lock, flags);
3781 clear_bit_unlock(tag, &hba->lrb_in_use);
3782 wake_up(&hba->dev_cmd.tag_wq);
3788 dev_err(hba->dev, "%s: failed with err %d\n", __func__, err);
3793 * This ufshcd_release() corresponds to the original scsi cmd that got
3794 * aborted here (as we won't get any IRQ for it).
3796 ufshcd_release(hba);
3801 * ufshcd_host_reset_and_restore - reset and restore host controller
3802 * @hba: per-adapter instance
3804 * Note that host controller reset may issue DME_RESET to
3805 * local and remote (device) Uni-Pro stack and the attributes
3806 * are reset to default state.
3808 * Returns zero on success, non-zero on failure
3810 static int ufshcd_host_reset_and_restore(struct ufs_hba *hba)
3813 unsigned long flags;
3815 /* Reset the host controller */
3816 spin_lock_irqsave(hba->host->host_lock, flags);
3817 ufshcd_hba_stop(hba);
3818 spin_unlock_irqrestore(hba->host->host_lock, flags);
3820 err = ufshcd_hba_enable(hba);
3824 /* Establish the link again and restore the device */
3825 err = ufshcd_probe_hba(hba);
3827 if (!err && (hba->ufshcd_state != UFSHCD_STATE_OPERATIONAL))
3831 dev_err(hba->dev, "%s: Host init failed %d\n", __func__, err);
3837 * ufshcd_reset_and_restore - reset and re-initialize host/device
3838 * @hba: per-adapter instance
3840 * Reset and recover device, host and re-establish link. This
3841 * is helpful to recover the communication in fatal error conditions.
3843 * Returns zero on success, non-zero on failure
3845 static int ufshcd_reset_and_restore(struct ufs_hba *hba)
3848 unsigned long flags;
3849 int retries = MAX_HOST_RESET_RETRIES;
3852 err = ufshcd_host_reset_and_restore(hba);
3853 } while (err && --retries);
3856 * After reset the door-bell might be cleared, complete
3857 * outstanding requests in s/w here.
3859 spin_lock_irqsave(hba->host->host_lock, flags);
3860 ufshcd_transfer_req_compl(hba);
3861 ufshcd_tmc_handler(hba);
3862 spin_unlock_irqrestore(hba->host->host_lock, flags);
3868 * ufshcd_eh_host_reset_handler - host reset handler registered to scsi layer
3869 * @cmd - SCSI command pointer
3871 * Returns SUCCESS/FAILED
3873 static int ufshcd_eh_host_reset_handler(struct scsi_cmnd *cmd)
3876 unsigned long flags;
3877 struct ufs_hba *hba;
3879 hba = shost_priv(cmd->device->host);
3881 ufshcd_hold(hba, false);
3883 * Check if there is any race with fatal error handling.
3884 * If so, wait for it to complete. Even though fatal error
3885 * handling does reset and restore in some cases, don't assume
3886 * anything out of it. We are just avoiding race here.
3889 spin_lock_irqsave(hba->host->host_lock, flags);
3890 if (!(work_pending(&hba->eh_work) ||
3891 hba->ufshcd_state == UFSHCD_STATE_RESET))
3893 spin_unlock_irqrestore(hba->host->host_lock, flags);
3894 dev_dbg(hba->dev, "%s: reset in progress\n", __func__);
3895 flush_work(&hba->eh_work);
3898 hba->ufshcd_state = UFSHCD_STATE_RESET;
3899 ufshcd_set_eh_in_progress(hba);
3900 spin_unlock_irqrestore(hba->host->host_lock, flags);
3902 err = ufshcd_reset_and_restore(hba);
3904 spin_lock_irqsave(hba->host->host_lock, flags);
3907 hba->ufshcd_state = UFSHCD_STATE_OPERATIONAL;
3910 hba->ufshcd_state = UFSHCD_STATE_ERROR;
3912 ufshcd_clear_eh_in_progress(hba);
3913 spin_unlock_irqrestore(hba->host->host_lock, flags);
3915 ufshcd_release(hba);
3920 * ufshcd_get_max_icc_level - calculate the ICC level
3921 * @sup_curr_uA: max. current supported by the regulator
3922 * @start_scan: row at the desc table to start scan from
3923 * @buff: power descriptor buffer
3925 * Returns calculated max ICC level for specific regulator
3927 static u32 ufshcd_get_max_icc_level(int sup_curr_uA, u32 start_scan, char *buff)
3934 for (i = start_scan; i >= 0; i--) {
3935 data = be16_to_cpu(*((u16 *)(buff + 2*i)));
3936 unit = (data & ATTR_ICC_LVL_UNIT_MASK) >>
3937 ATTR_ICC_LVL_UNIT_OFFSET;
3938 curr_uA = data & ATTR_ICC_LVL_VALUE_MASK;
3940 case UFSHCD_NANO_AMP:
3941 curr_uA = curr_uA / 1000;
3943 case UFSHCD_MILI_AMP:
3944 curr_uA = curr_uA * 1000;
3947 curr_uA = curr_uA * 1000 * 1000;
3949 case UFSHCD_MICRO_AMP:
3953 if (sup_curr_uA >= curr_uA)
3958 pr_err("%s: Couldn't find valid icc_level = %d", __func__, i);
3965 * ufshcd_calc_icc_level - calculate the max ICC level
3966 * In case regulators are not initialized we'll return 0
3967 * @hba: per-adapter instance
3968 * @desc_buf: power descriptor buffer to extract ICC levels from.
3969 * @len: length of desc_buff
3971 * Returns calculated ICC level
3973 static u32 ufshcd_find_max_sup_active_icc_level(struct ufs_hba *hba,
3974 u8 *desc_buf, int len)
3978 if (!hba->vreg_info.vcc || !hba->vreg_info.vccq ||
3979 !hba->vreg_info.vccq2) {
3981 "%s: Regulator capability was not set, actvIccLevel=%d",
3982 __func__, icc_level);
3986 if (hba->vreg_info.vcc)
3987 icc_level = ufshcd_get_max_icc_level(
3988 hba->vreg_info.vcc->max_uA,
3989 POWER_DESC_MAX_ACTV_ICC_LVLS - 1,
3990 &desc_buf[PWR_DESC_ACTIVE_LVLS_VCC_0]);
3992 if (hba->vreg_info.vccq)
3993 icc_level = ufshcd_get_max_icc_level(
3994 hba->vreg_info.vccq->max_uA,
3996 &desc_buf[PWR_DESC_ACTIVE_LVLS_VCCQ_0]);
3998 if (hba->vreg_info.vccq2)
3999 icc_level = ufshcd_get_max_icc_level(
4000 hba->vreg_info.vccq2->max_uA,
4002 &desc_buf[PWR_DESC_ACTIVE_LVLS_VCCQ2_0]);
4007 static void ufshcd_init_icc_levels(struct ufs_hba *hba)
4010 int buff_len = QUERY_DESC_POWER_MAX_SIZE;
4011 u8 desc_buf[QUERY_DESC_POWER_MAX_SIZE];
4013 ret = ufshcd_read_power_desc(hba, desc_buf, buff_len);
4016 "%s: Failed reading power descriptor.len = %d ret = %d",
4017 __func__, buff_len, ret);
4021 hba->init_prefetch_data.icc_level =
4022 ufshcd_find_max_sup_active_icc_level(hba,
4023 desc_buf, buff_len);
4024 dev_dbg(hba->dev, "%s: setting icc_level 0x%x",
4025 __func__, hba->init_prefetch_data.icc_level);
4027 ret = ufshcd_query_attr(hba, UPIU_QUERY_OPCODE_WRITE_ATTR,
4028 QUERY_ATTR_IDN_ACTIVE_ICC_LVL, 0, 0,
4029 &hba->init_prefetch_data.icc_level);
4033 "%s: Failed configuring bActiveICCLevel = %d ret = %d",
4034 __func__, hba->init_prefetch_data.icc_level , ret);
4039 * ufshcd_scsi_add_wlus - Adds required W-LUs
4040 * @hba: per-adapter instance
4042 * UFS device specification requires the UFS devices to support 4 well known
4044 * "REPORT_LUNS" (address: 01h)
4045 * "UFS Device" (address: 50h)
4046 * "RPMB" (address: 44h)
4047 * "BOOT" (address: 30h)
4048 * UFS device's power management needs to be controlled by "POWER CONDITION"
4049 * field of SSU (START STOP UNIT) command. But this "power condition" field
4050 * will take effect only when its sent to "UFS device" well known logical unit
4051 * hence we require the scsi_device instance to represent this logical unit in
4052 * order for the UFS host driver to send the SSU command for power management.
4054 * We also require the scsi_device instance for "RPMB" (Replay Protected Memory
4055 * Block) LU so user space process can control this LU. User space may also
4056 * want to have access to BOOT LU.
4058 * This function adds scsi device instances for each of all well known LUs
4059 * (except "REPORT LUNS" LU).
4061 * Returns zero on success (all required W-LUs are added successfully),
4062 * non-zero error value on failure (if failed to add any of the required W-LU).
4064 static int ufshcd_scsi_add_wlus(struct ufs_hba *hba)
4067 struct scsi_device *sdev_rpmb;
4068 struct scsi_device *sdev_boot;
4070 hba->sdev_ufs_device = __scsi_add_device(hba->host, 0, 0,
4071 ufshcd_upiu_wlun_to_scsi_wlun(UFS_UPIU_UFS_DEVICE_WLUN), NULL);
4072 if (IS_ERR(hba->sdev_ufs_device)) {
4073 ret = PTR_ERR(hba->sdev_ufs_device);
4074 hba->sdev_ufs_device = NULL;
4077 scsi_device_put(hba->sdev_ufs_device);
4079 sdev_boot = __scsi_add_device(hba->host, 0, 0,
4080 ufshcd_upiu_wlun_to_scsi_wlun(UFS_UPIU_BOOT_WLUN), NULL);
4081 if (IS_ERR(sdev_boot)) {
4082 ret = PTR_ERR(sdev_boot);
4083 goto remove_sdev_ufs_device;
4085 scsi_device_put(sdev_boot);
4087 sdev_rpmb = __scsi_add_device(hba->host, 0, 0,
4088 ufshcd_upiu_wlun_to_scsi_wlun(UFS_UPIU_RPMB_WLUN), NULL);
4089 if (IS_ERR(sdev_rpmb)) {
4090 ret = PTR_ERR(sdev_rpmb);
4091 goto remove_sdev_boot;
4093 scsi_device_put(sdev_rpmb);
4097 scsi_remove_device(sdev_boot);
4098 remove_sdev_ufs_device:
4099 scsi_remove_device(hba->sdev_ufs_device);
4105 * ufshcd_probe_hba - probe hba to detect device and initialize
4106 * @hba: per-adapter instance
4108 * Execute link-startup and verify device initialization
4110 static int ufshcd_probe_hba(struct ufs_hba *hba)
4114 ret = ufshcd_link_startup(hba);
4118 ufshcd_init_pwr_info(hba);
4120 /* UniPro link is active now */
4121 ufshcd_set_link_active(hba);
4123 ret = ufshcd_verify_dev_init(hba);
4127 ret = ufshcd_complete_dev_init(hba);
4131 /* UFS device is also active now */
4132 ufshcd_set_ufs_dev_active(hba);
4133 ufshcd_force_reset_auto_bkops(hba);
4134 hba->ufshcd_state = UFSHCD_STATE_OPERATIONAL;
4135 hba->wlun_dev_clr_ua = true;
4137 if (ufshcd_get_max_pwr_mode(hba)) {
4139 "%s: Failed getting max supported power mode\n",
4142 ret = ufshcd_config_pwr_mode(hba, &hba->max_pwr_info.info);
4144 dev_err(hba->dev, "%s: Failed setting power mode, err = %d\n",
4149 * If we are in error handling context or in power management callbacks
4150 * context, no need to scan the host
4152 if (!ufshcd_eh_in_progress(hba) && !hba->pm_op_in_progress) {
4155 /* clear any previous UFS device information */
4156 memset(&hba->dev_info, 0, sizeof(hba->dev_info));
4157 if (!ufshcd_query_flag(hba, UPIU_QUERY_OPCODE_READ_FLAG,
4158 QUERY_FLAG_IDN_PWR_ON_WPE, &flag))
4159 hba->dev_info.f_power_on_wp_en = flag;
4161 if (!hba->is_init_prefetch)
4162 ufshcd_init_icc_levels(hba);
4164 /* Add required well known logical units to scsi mid layer */
4165 if (ufshcd_scsi_add_wlus(hba))
4168 scsi_scan_host(hba->host);
4169 pm_runtime_put_sync(hba->dev);
4172 if (!hba->is_init_prefetch)
4173 hba->is_init_prefetch = true;
4175 /* Resume devfreq after UFS device is detected */
4176 if (ufshcd_is_clkscaling_enabled(hba))
4177 devfreq_resume_device(hba->devfreq);
4181 * If we failed to initialize the device or the device is not
4182 * present, turn off the power/clocks etc.
4184 if (ret && !ufshcd_eh_in_progress(hba) && !hba->pm_op_in_progress) {
4185 pm_runtime_put_sync(hba->dev);
4186 ufshcd_hba_exit(hba);
4193 * ufshcd_async_scan - asynchronous execution for probing hba
4194 * @data: data pointer to pass to this function
4195 * @cookie: cookie data
4197 static void ufshcd_async_scan(void *data, async_cookie_t cookie)
4199 struct ufs_hba *hba = (struct ufs_hba *)data;
4201 ufshcd_probe_hba(hba);
4204 static struct scsi_host_template ufshcd_driver_template = {
4205 .module = THIS_MODULE,
4207 .proc_name = UFSHCD,
4208 .queuecommand = ufshcd_queuecommand,
4209 .slave_alloc = ufshcd_slave_alloc,
4210 .slave_configure = ufshcd_slave_configure,
4211 .slave_destroy = ufshcd_slave_destroy,
4212 .change_queue_depth = ufshcd_change_queue_depth,
4213 .eh_abort_handler = ufshcd_abort,
4214 .eh_device_reset_handler = ufshcd_eh_device_reset_handler,
4215 .eh_host_reset_handler = ufshcd_eh_host_reset_handler,
4217 .sg_tablesize = SG_ALL,
4218 .cmd_per_lun = UFSHCD_CMD_PER_LUN,
4219 .can_queue = UFSHCD_CAN_QUEUE,
4220 .max_host_blocked = 1,
4222 .track_queue_depth = 1,
4225 static int ufshcd_config_vreg_load(struct device *dev, struct ufs_vreg *vreg,
4229 struct regulator *reg = vreg->reg;
4230 const char *name = vreg->name;
4234 ret = regulator_set_optimum_mode(reg, ua);
4237 * regulator_set_optimum_mode() returns new regulator
4238 * mode upon success.
4242 dev_err(dev, "%s: %s set optimum mode(ua=%d) failed, err=%d\n",
4243 __func__, name, ua, ret);
4249 static inline int ufshcd_config_vreg_lpm(struct ufs_hba *hba,
4250 struct ufs_vreg *vreg)
4255 return ufshcd_config_vreg_load(hba->dev, vreg, UFS_VREG_LPM_LOAD_UA);
4258 static inline int ufshcd_config_vreg_hpm(struct ufs_hba *hba,
4259 struct ufs_vreg *vreg)
4264 return ufshcd_config_vreg_load(hba->dev, vreg, vreg->max_uA);
4267 static int ufshcd_config_vreg(struct device *dev,
4268 struct ufs_vreg *vreg, bool on)
4271 struct regulator *reg = vreg->reg;
4272 const char *name = vreg->name;
4273 int min_uV, uA_load;
4277 if (regulator_count_voltages(reg) > 0) {
4278 min_uV = on ? vreg->min_uV : 0;
4279 ret = regulator_set_voltage(reg, min_uV, vreg->max_uV);
4281 dev_err(dev, "%s: %s set voltage failed, err=%d\n",
4282 __func__, name, ret);
4286 uA_load = on ? vreg->max_uA : 0;
4287 ret = ufshcd_config_vreg_load(dev, vreg, uA_load);
4295 static int ufshcd_enable_vreg(struct device *dev, struct ufs_vreg *vreg)
4299 if (!vreg || vreg->enabled)
4302 ret = ufshcd_config_vreg(dev, vreg, true);
4304 ret = regulator_enable(vreg->reg);
4307 vreg->enabled = true;
4309 dev_err(dev, "%s: %s enable failed, err=%d\n",
4310 __func__, vreg->name, ret);
4315 static int ufshcd_disable_vreg(struct device *dev, struct ufs_vreg *vreg)
4319 if (!vreg || !vreg->enabled)
4322 ret = regulator_disable(vreg->reg);
4325 /* ignore errors on applying disable config */
4326 ufshcd_config_vreg(dev, vreg, false);
4327 vreg->enabled = false;
4329 dev_err(dev, "%s: %s disable failed, err=%d\n",
4330 __func__, vreg->name, ret);
4336 static int ufshcd_setup_vreg(struct ufs_hba *hba, bool on)
4339 struct device *dev = hba->dev;
4340 struct ufs_vreg_info *info = &hba->vreg_info;
4345 ret = ufshcd_toggle_vreg(dev, info->vcc, on);
4349 ret = ufshcd_toggle_vreg(dev, info->vccq, on);
4353 ret = ufshcd_toggle_vreg(dev, info->vccq2, on);
4359 ufshcd_toggle_vreg(dev, info->vccq2, false);
4360 ufshcd_toggle_vreg(dev, info->vccq, false);
4361 ufshcd_toggle_vreg(dev, info->vcc, false);
4366 static int ufshcd_setup_hba_vreg(struct ufs_hba *hba, bool on)
4368 struct ufs_vreg_info *info = &hba->vreg_info;
4371 return ufshcd_toggle_vreg(hba->dev, info->vdd_hba, on);
4376 static int ufshcd_get_vreg(struct device *dev, struct ufs_vreg *vreg)
4383 vreg->reg = devm_regulator_get(dev, vreg->name);
4384 if (IS_ERR(vreg->reg)) {
4385 ret = PTR_ERR(vreg->reg);
4386 dev_err(dev, "%s: %s get failed, err=%d\n",
4387 __func__, vreg->name, ret);
4393 static int ufshcd_init_vreg(struct ufs_hba *hba)
4396 struct device *dev = hba->dev;
4397 struct ufs_vreg_info *info = &hba->vreg_info;
4402 ret = ufshcd_get_vreg(dev, info->vcc);
4406 ret = ufshcd_get_vreg(dev, info->vccq);
4410 ret = ufshcd_get_vreg(dev, info->vccq2);
4415 static int ufshcd_init_hba_vreg(struct ufs_hba *hba)
4417 struct ufs_vreg_info *info = &hba->vreg_info;
4420 return ufshcd_get_vreg(hba->dev, info->vdd_hba);
4425 static int __ufshcd_setup_clocks(struct ufs_hba *hba, bool on,
4429 struct ufs_clk_info *clki;
4430 struct list_head *head = &hba->clk_list_head;
4431 unsigned long flags;
4433 if (!head || list_empty(head))
4436 list_for_each_entry(clki, head, list) {
4437 if (!IS_ERR_OR_NULL(clki->clk)) {
4438 if (skip_ref_clk && !strcmp(clki->name, "ref_clk"))
4441 if (on && !clki->enabled) {
4442 ret = clk_prepare_enable(clki->clk);
4444 dev_err(hba->dev, "%s: %s prepare enable failed, %d\n",
4445 __func__, clki->name, ret);
4448 } else if (!on && clki->enabled) {
4449 clk_disable_unprepare(clki->clk);
4452 dev_dbg(hba->dev, "%s: clk: %s %sabled\n", __func__,
4453 clki->name, on ? "en" : "dis");
4457 if (hba->vops && hba->vops->setup_clocks)
4458 ret = hba->vops->setup_clocks(hba, on);
4461 list_for_each_entry(clki, head, list) {
4462 if (!IS_ERR_OR_NULL(clki->clk) && clki->enabled)
4463 clk_disable_unprepare(clki->clk);
4466 spin_lock_irqsave(hba->host->host_lock, flags);
4467 hba->clk_gating.state = CLKS_ON;
4468 spin_unlock_irqrestore(hba->host->host_lock, flags);
4473 static int ufshcd_setup_clocks(struct ufs_hba *hba, bool on)
4475 return __ufshcd_setup_clocks(hba, on, false);
4478 static int ufshcd_init_clocks(struct ufs_hba *hba)
4481 struct ufs_clk_info *clki;
4482 struct device *dev = hba->dev;
4483 struct list_head *head = &hba->clk_list_head;
4485 if (!head || list_empty(head))
4488 list_for_each_entry(clki, head, list) {
4492 clki->clk = devm_clk_get(dev, clki->name);
4493 if (IS_ERR(clki->clk)) {
4494 ret = PTR_ERR(clki->clk);
4495 dev_err(dev, "%s: %s clk get failed, %d\n",
4496 __func__, clki->name, ret);
4500 if (clki->max_freq) {
4501 ret = clk_set_rate(clki->clk, clki->max_freq);
4503 dev_err(hba->dev, "%s: %s clk set rate(%dHz) failed, %d\n",
4504 __func__, clki->name,
4505 clki->max_freq, ret);
4508 clki->curr_freq = clki->max_freq;
4510 dev_dbg(dev, "%s: clk: %s, rate: %lu\n", __func__,
4511 clki->name, clk_get_rate(clki->clk));
4517 static int ufshcd_variant_hba_init(struct ufs_hba *hba)
4524 if (hba->vops->init) {
4525 err = hba->vops->init(hba);
4530 if (hba->vops->setup_regulators) {
4531 err = hba->vops->setup_regulators(hba, true);
4539 if (hba->vops->exit)
4540 hba->vops->exit(hba);
4543 dev_err(hba->dev, "%s: variant %s init failed err %d\n",
4544 __func__, hba->vops ? hba->vops->name : "", err);
4548 static void ufshcd_variant_hba_exit(struct ufs_hba *hba)
4553 if (hba->vops->setup_clocks)
4554 hba->vops->setup_clocks(hba, false);
4556 if (hba->vops->setup_regulators)
4557 hba->vops->setup_regulators(hba, false);
4559 if (hba->vops->exit)
4560 hba->vops->exit(hba);
4563 static int ufshcd_hba_init(struct ufs_hba *hba)
4568 * Handle host controller power separately from the UFS device power
4569 * rails as it will help controlling the UFS host controller power
4570 * collapse easily which is different than UFS device power collapse.
4571 * Also, enable the host controller power before we go ahead with rest
4572 * of the initialization here.
4574 err = ufshcd_init_hba_vreg(hba);
4578 err = ufshcd_setup_hba_vreg(hba, true);
4582 err = ufshcd_init_clocks(hba);
4584 goto out_disable_hba_vreg;
4586 err = ufshcd_setup_clocks(hba, true);
4588 goto out_disable_hba_vreg;
4590 err = ufshcd_init_vreg(hba);
4592 goto out_disable_clks;
4594 err = ufshcd_setup_vreg(hba, true);
4596 goto out_disable_clks;
4598 err = ufshcd_variant_hba_init(hba);
4600 goto out_disable_vreg;
4602 hba->is_powered = true;
4606 ufshcd_setup_vreg(hba, false);
4608 ufshcd_setup_clocks(hba, false);
4609 out_disable_hba_vreg:
4610 ufshcd_setup_hba_vreg(hba, false);
4615 static void ufshcd_hba_exit(struct ufs_hba *hba)
4617 if (hba->is_powered) {
4618 ufshcd_variant_hba_exit(hba);
4619 ufshcd_setup_vreg(hba, false);
4620 ufshcd_setup_clocks(hba, false);
4621 ufshcd_setup_hba_vreg(hba, false);
4622 hba->is_powered = false;
4627 ufshcd_send_request_sense(struct ufs_hba *hba, struct scsi_device *sdp)
4629 unsigned char cmd[6] = {REQUEST_SENSE,
4633 SCSI_SENSE_BUFFERSIZE,
4638 buffer = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_KERNEL);
4644 ret = scsi_execute_req_flags(sdp, cmd, DMA_FROM_DEVICE, buffer,
4645 SCSI_SENSE_BUFFERSIZE, NULL,
4646 msecs_to_jiffies(1000), 3, NULL, REQ_PM);
4648 pr_err("%s: failed with err %d\n", __func__, ret);
4656 * ufshcd_set_dev_pwr_mode - sends START STOP UNIT command to set device
4658 * @hba: per adapter instance
4659 * @pwr_mode: device power mode to set
4661 * Returns 0 if requested power mode is set successfully
4662 * Returns non-zero if failed to set the requested power mode
4664 static int ufshcd_set_dev_pwr_mode(struct ufs_hba *hba,
4665 enum ufs_dev_pwr_mode pwr_mode)
4667 unsigned char cmd[6] = { START_STOP };
4668 struct scsi_sense_hdr sshdr;
4669 struct scsi_device *sdp;
4670 unsigned long flags;
4673 spin_lock_irqsave(hba->host->host_lock, flags);
4674 sdp = hba->sdev_ufs_device;
4676 ret = scsi_device_get(sdp);
4677 if (!ret && !scsi_device_online(sdp)) {
4679 scsi_device_put(sdp);
4684 spin_unlock_irqrestore(hba->host->host_lock, flags);
4690 * If scsi commands fail, the scsi mid-layer schedules scsi error-
4691 * handling, which would wait for host to be resumed. Since we know
4692 * we are functional while we are here, skip host resume in error
4695 hba->host->eh_noresume = 1;
4696 if (hba->wlun_dev_clr_ua) {
4697 ret = ufshcd_send_request_sense(hba, sdp);
4700 /* Unit attention condition is cleared now */
4701 hba->wlun_dev_clr_ua = false;
4704 cmd[4] = pwr_mode << 4;
4707 * Current function would be generally called from the power management
4708 * callbacks hence set the REQ_PM flag so that it doesn't resume the
4709 * already suspended childs.
4711 ret = scsi_execute_req_flags(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
4712 START_STOP_TIMEOUT, 0, NULL, REQ_PM);
4714 sdev_printk(KERN_WARNING, sdp,
4715 "START_STOP failed for power mode: %d, result %x\n",
4717 if (driver_byte(ret) & DRIVER_SENSE) {
4718 scsi_show_sense_hdr(sdp, NULL, &sshdr);
4719 scsi_show_extd_sense(sdp, NULL, sshdr.asc, sshdr.ascq);
4724 hba->curr_dev_pwr_mode = pwr_mode;
4726 scsi_device_put(sdp);
4727 hba->host->eh_noresume = 0;
4731 static int ufshcd_link_state_transition(struct ufs_hba *hba,
4732 enum uic_link_state req_link_state,
4733 int check_for_bkops)
4737 if (req_link_state == hba->uic_link_state)
4740 if (req_link_state == UIC_LINK_HIBERN8_STATE) {
4741 ret = ufshcd_uic_hibern8_enter(hba);
4743 ufshcd_set_link_hibern8(hba);
4748 * If autobkops is enabled, link can't be turned off because
4749 * turning off the link would also turn off the device.
4751 else if ((req_link_state == UIC_LINK_OFF_STATE) &&
4752 (!check_for_bkops || (check_for_bkops &&
4753 !hba->auto_bkops_enabled))) {
4755 * Change controller state to "reset state" which
4756 * should also put the link in off/reset state
4758 ufshcd_hba_stop(hba);
4760 * TODO: Check if we need any delay to make sure that
4761 * controller is reset
4763 ufshcd_set_link_off(hba);
4770 static void ufshcd_vreg_set_lpm(struct ufs_hba *hba)
4773 * If UFS device is either in UFS_Sleep turn off VCC rail to save some
4776 * If UFS device and link is in OFF state, all power supplies (VCC,
4777 * VCCQ, VCCQ2) can be turned off if power on write protect is not
4778 * required. If UFS link is inactive (Hibern8 or OFF state) and device
4779 * is in sleep state, put VCCQ & VCCQ2 rails in LPM mode.
4781 * Ignore the error returned by ufshcd_toggle_vreg() as device is anyway
4782 * in low power state which would save some power.
4784 if (ufshcd_is_ufs_dev_poweroff(hba) && ufshcd_is_link_off(hba) &&
4785 !hba->dev_info.is_lu_power_on_wp) {
4786 ufshcd_setup_vreg(hba, false);
4787 } else if (!ufshcd_is_ufs_dev_active(hba)) {
4788 ufshcd_toggle_vreg(hba->dev, hba->vreg_info.vcc, false);
4789 if (!ufshcd_is_link_active(hba)) {
4790 ufshcd_config_vreg_lpm(hba, hba->vreg_info.vccq);
4791 ufshcd_config_vreg_lpm(hba, hba->vreg_info.vccq2);
4796 static int ufshcd_vreg_set_hpm(struct ufs_hba *hba)
4800 if (ufshcd_is_ufs_dev_poweroff(hba) && ufshcd_is_link_off(hba) &&
4801 !hba->dev_info.is_lu_power_on_wp) {
4802 ret = ufshcd_setup_vreg(hba, true);
4803 } else if (!ufshcd_is_ufs_dev_active(hba)) {
4804 ret = ufshcd_toggle_vreg(hba->dev, hba->vreg_info.vcc, true);
4805 if (!ret && !ufshcd_is_link_active(hba)) {
4806 ret = ufshcd_config_vreg_hpm(hba, hba->vreg_info.vccq);
4809 ret = ufshcd_config_vreg_hpm(hba, hba->vreg_info.vccq2);
4817 ufshcd_config_vreg_lpm(hba, hba->vreg_info.vccq);
4819 ufshcd_toggle_vreg(hba->dev, hba->vreg_info.vcc, false);
4824 static void ufshcd_hba_vreg_set_lpm(struct ufs_hba *hba)
4826 if (ufshcd_is_link_off(hba))
4827 ufshcd_setup_hba_vreg(hba, false);
4830 static void ufshcd_hba_vreg_set_hpm(struct ufs_hba *hba)
4832 if (ufshcd_is_link_off(hba))
4833 ufshcd_setup_hba_vreg(hba, true);
4837 * ufshcd_suspend - helper function for suspend operations
4838 * @hba: per adapter instance
4839 * @pm_op: desired low power operation type
4841 * This function will try to put the UFS device and link into low power
4842 * mode based on the "rpm_lvl" (Runtime PM level) or "spm_lvl"
4843 * (System PM level).
4845 * If this function is called during shutdown, it will make sure that
4846 * both UFS device and UFS link is powered off.
4848 * NOTE: UFS device & link must be active before we enter in this function.
4850 * Returns 0 for success and non-zero for failure
4852 static int ufshcd_suspend(struct ufs_hba *hba, enum ufs_pm_op pm_op)
4855 enum ufs_pm_level pm_lvl;
4856 enum ufs_dev_pwr_mode req_dev_pwr_mode;
4857 enum uic_link_state req_link_state;
4859 hba->pm_op_in_progress = 1;
4860 if (!ufshcd_is_shutdown_pm(pm_op)) {
4861 pm_lvl = ufshcd_is_runtime_pm(pm_op) ?
4862 hba->rpm_lvl : hba->spm_lvl;
4863 req_dev_pwr_mode = ufs_get_pm_lvl_to_dev_pwr_mode(pm_lvl);
4864 req_link_state = ufs_get_pm_lvl_to_link_pwr_state(pm_lvl);
4866 req_dev_pwr_mode = UFS_POWERDOWN_PWR_MODE;
4867 req_link_state = UIC_LINK_OFF_STATE;
4871 * If we can't transition into any of the low power modes
4872 * just gate the clocks.
4874 ufshcd_hold(hba, false);
4875 hba->clk_gating.is_suspended = true;
4877 if (req_dev_pwr_mode == UFS_ACTIVE_PWR_MODE &&
4878 req_link_state == UIC_LINK_ACTIVE_STATE) {
4882 if ((req_dev_pwr_mode == hba->curr_dev_pwr_mode) &&
4883 (req_link_state == hba->uic_link_state))
4886 /* UFS device & link must be active before we enter in this function */
4887 if (!ufshcd_is_ufs_dev_active(hba) || !ufshcd_is_link_active(hba)) {
4892 if (ufshcd_is_runtime_pm(pm_op)) {
4893 if (ufshcd_can_autobkops_during_suspend(hba)) {
4895 * The device is idle with no requests in the queue,
4896 * allow background operations if bkops status shows
4897 * that performance might be impacted.
4899 ret = ufshcd_urgent_bkops(hba);
4903 /* make sure that auto bkops is disabled */
4904 ufshcd_disable_auto_bkops(hba);
4908 if ((req_dev_pwr_mode != hba->curr_dev_pwr_mode) &&
4909 ((ufshcd_is_runtime_pm(pm_op) && !hba->auto_bkops_enabled) ||
4910 !ufshcd_is_runtime_pm(pm_op))) {
4911 /* ensure that bkops is disabled */
4912 ufshcd_disable_auto_bkops(hba);
4913 ret = ufshcd_set_dev_pwr_mode(hba, req_dev_pwr_mode);
4918 ret = ufshcd_link_state_transition(hba, req_link_state, 1);
4920 goto set_dev_active;
4922 ufshcd_vreg_set_lpm(hba);
4926 * The clock scaling needs access to controller registers. Hence, Wait
4927 * for pending clock scaling work to be done before clocks are
4930 if (ufshcd_is_clkscaling_enabled(hba)) {
4931 devfreq_suspend_device(hba->devfreq);
4932 hba->clk_scaling.window_start_t = 0;
4935 * Call vendor specific suspend callback. As these callbacks may access
4936 * vendor specific host controller register space call them before the
4937 * host clocks are ON.
4939 if (hba->vops && hba->vops->suspend) {
4940 ret = hba->vops->suspend(hba, pm_op);
4942 goto set_link_active;
4945 if (hba->vops && hba->vops->setup_clocks) {
4946 ret = hba->vops->setup_clocks(hba, false);
4951 if (!ufshcd_is_link_active(hba))
4952 ufshcd_setup_clocks(hba, false);
4954 /* If link is active, device ref_clk can't be switched off */
4955 __ufshcd_setup_clocks(hba, false, true);
4957 hba->clk_gating.state = CLKS_OFF;
4959 * Disable the host irq as host controller as there won't be any
4960 * host controller trasanction expected till resume.
4962 ufshcd_disable_irq(hba);
4963 /* Put the host controller in low power mode if possible */
4964 ufshcd_hba_vreg_set_lpm(hba);
4968 if (hba->vops && hba->vops->resume)
4969 hba->vops->resume(hba, pm_op);
4971 ufshcd_vreg_set_hpm(hba);
4972 if (ufshcd_is_link_hibern8(hba) && !ufshcd_uic_hibern8_exit(hba))
4973 ufshcd_set_link_active(hba);
4974 else if (ufshcd_is_link_off(hba))
4975 ufshcd_host_reset_and_restore(hba);
4977 if (!ufshcd_set_dev_pwr_mode(hba, UFS_ACTIVE_PWR_MODE))
4978 ufshcd_disable_auto_bkops(hba);
4980 hba->clk_gating.is_suspended = false;
4981 ufshcd_release(hba);
4983 hba->pm_op_in_progress = 0;
4988 * ufshcd_resume - helper function for resume operations
4989 * @hba: per adapter instance
4990 * @pm_op: runtime PM or system PM
4992 * This function basically brings the UFS device, UniPro link and controller
4995 * Returns 0 for success and non-zero for failure
4997 static int ufshcd_resume(struct ufs_hba *hba, enum ufs_pm_op pm_op)
5000 enum uic_link_state old_link_state;
5002 hba->pm_op_in_progress = 1;
5003 old_link_state = hba->uic_link_state;
5005 ufshcd_hba_vreg_set_hpm(hba);
5006 /* Make sure clocks are enabled before accessing controller */
5007 ret = ufshcd_setup_clocks(hba, true);
5011 /* enable the host irq as host controller would be active soon */
5012 ret = ufshcd_enable_irq(hba);
5014 goto disable_irq_and_vops_clks;
5016 ret = ufshcd_vreg_set_hpm(hba);
5018 goto disable_irq_and_vops_clks;
5021 * Call vendor specific resume callback. As these callbacks may access
5022 * vendor specific host controller register space call them when the
5023 * host clocks are ON.
5025 if (hba->vops && hba->vops->resume) {
5026 ret = hba->vops->resume(hba, pm_op);
5031 if (ufshcd_is_link_hibern8(hba)) {
5032 ret = ufshcd_uic_hibern8_exit(hba);
5034 ufshcd_set_link_active(hba);
5036 goto vendor_suspend;
5037 } else if (ufshcd_is_link_off(hba)) {
5038 ret = ufshcd_host_reset_and_restore(hba);
5040 * ufshcd_host_reset_and_restore() should have already
5041 * set the link state as active
5043 if (ret || !ufshcd_is_link_active(hba))
5044 goto vendor_suspend;
5047 if (!ufshcd_is_ufs_dev_active(hba)) {
5048 ret = ufshcd_set_dev_pwr_mode(hba, UFS_ACTIVE_PWR_MODE);
5050 goto set_old_link_state;
5054 * If BKOPs operations are urgently needed at this moment then
5055 * keep auto-bkops enabled or else disable it.
5057 ufshcd_urgent_bkops(hba);
5058 hba->clk_gating.is_suspended = false;
5060 if (ufshcd_is_clkscaling_enabled(hba))
5061 devfreq_resume_device(hba->devfreq);
5063 /* Schedule clock gating in case of no access to UFS device yet */
5064 ufshcd_release(hba);
5068 ufshcd_link_state_transition(hba, old_link_state, 0);
5070 if (hba->vops && hba->vops->suspend)
5071 hba->vops->suspend(hba, pm_op);
5073 ufshcd_vreg_set_lpm(hba);
5074 disable_irq_and_vops_clks:
5075 ufshcd_disable_irq(hba);
5076 ufshcd_setup_clocks(hba, false);
5078 hba->pm_op_in_progress = 0;
5083 * ufshcd_system_suspend - system suspend routine
5084 * @hba: per adapter instance
5085 * @pm_op: runtime PM or system PM
5087 * Check the description of ufshcd_suspend() function for more details.
5089 * Returns 0 for success and non-zero for failure
5091 int ufshcd_system_suspend(struct ufs_hba *hba)
5095 if (!hba || !hba->is_powered)
5098 if (pm_runtime_suspended(hba->dev)) {
5099 if (hba->rpm_lvl == hba->spm_lvl)
5101 * There is possibility that device may still be in
5102 * active state during the runtime suspend.
5104 if ((ufs_get_pm_lvl_to_dev_pwr_mode(hba->spm_lvl) ==
5105 hba->curr_dev_pwr_mode) && !hba->auto_bkops_enabled)
5109 * UFS device and/or UFS link low power states during runtime
5110 * suspend seems to be different than what is expected during
5111 * system suspend. Hence runtime resume the devic & link and
5112 * let the system suspend low power states to take effect.
5113 * TODO: If resume takes longer time, we might have optimize
5114 * it in future by not resuming everything if possible.
5116 ret = ufshcd_runtime_resume(hba);
5121 ret = ufshcd_suspend(hba, UFS_SYSTEM_PM);
5124 hba->is_sys_suspended = true;
5127 EXPORT_SYMBOL(ufshcd_system_suspend);
5130 * ufshcd_system_resume - system resume routine
5131 * @hba: per adapter instance
5133 * Returns 0 for success and non-zero for failure
5136 int ufshcd_system_resume(struct ufs_hba *hba)
5138 if (!hba || !hba->is_powered || pm_runtime_suspended(hba->dev))
5140 * Let the runtime resume take care of resuming
5141 * if runtime suspended.
5145 return ufshcd_resume(hba, UFS_SYSTEM_PM);
5147 EXPORT_SYMBOL(ufshcd_system_resume);
5150 * ufshcd_runtime_suspend - runtime suspend routine
5151 * @hba: per adapter instance
5153 * Check the description of ufshcd_suspend() function for more details.
5155 * Returns 0 for success and non-zero for failure
5157 int ufshcd_runtime_suspend(struct ufs_hba *hba)
5159 if (!hba || !hba->is_powered)
5162 return ufshcd_suspend(hba, UFS_RUNTIME_PM);
5164 EXPORT_SYMBOL(ufshcd_runtime_suspend);
5167 * ufshcd_runtime_resume - runtime resume routine
5168 * @hba: per adapter instance
5170 * This function basically brings the UFS device, UniPro link and controller
5171 * to active state. Following operations are done in this function:
5173 * 1. Turn on all the controller related clocks
5174 * 2. Bring the UniPro link out of Hibernate state
5175 * 3. If UFS device is in sleep state, turn ON VCC rail and bring the UFS device
5177 * 4. If auto-bkops is enabled on the device, disable it.
5179 * So following would be the possible power state after this function return
5181 * S1: UFS device in Active state with VCC rail ON
5182 * UniPro link in Active state
5183 * All the UFS/UniPro controller clocks are ON
5185 * Returns 0 for success and non-zero for failure
5187 int ufshcd_runtime_resume(struct ufs_hba *hba)
5189 if (!hba || !hba->is_powered)
5192 return ufshcd_resume(hba, UFS_RUNTIME_PM);
5194 EXPORT_SYMBOL(ufshcd_runtime_resume);
5196 int ufshcd_runtime_idle(struct ufs_hba *hba)
5200 EXPORT_SYMBOL(ufshcd_runtime_idle);
5203 * ufshcd_shutdown - shutdown routine
5204 * @hba: per adapter instance
5206 * This function would power off both UFS device and UFS link.
5208 * Returns 0 always to allow force shutdown even in case of errors.
5210 int ufshcd_shutdown(struct ufs_hba *hba)
5214 if (ufshcd_is_ufs_dev_poweroff(hba) && ufshcd_is_link_off(hba))
5217 if (pm_runtime_suspended(hba->dev)) {
5218 ret = ufshcd_runtime_resume(hba);
5223 ret = ufshcd_suspend(hba, UFS_SHUTDOWN_PM);
5226 dev_err(hba->dev, "%s failed, err %d\n", __func__, ret);
5227 /* allow force shutdown even in case of errors */
5230 EXPORT_SYMBOL(ufshcd_shutdown);
5233 * ufshcd_remove - de-allocate SCSI host and host memory space
5234 * data structure memory
5235 * @hba - per adapter instance
5237 void ufshcd_remove(struct ufs_hba *hba)
5239 scsi_remove_host(hba->host);
5240 /* disable interrupts */
5241 ufshcd_disable_intr(hba, hba->intr_mask);
5242 ufshcd_hba_stop(hba);
5244 scsi_host_put(hba->host);
5246 ufshcd_exit_clk_gating(hba);
5247 if (ufshcd_is_clkscaling_enabled(hba))
5248 devfreq_remove_device(hba->devfreq);
5249 ufshcd_hba_exit(hba);
5251 EXPORT_SYMBOL_GPL(ufshcd_remove);
5254 * ufshcd_set_dma_mask - Set dma mask based on the controller
5255 * addressing capability
5256 * @hba: per adapter instance
5258 * Returns 0 for success, non-zero for failure
5260 static int ufshcd_set_dma_mask(struct ufs_hba *hba)
5262 if (hba->capabilities & MASK_64_ADDRESSING_SUPPORT) {
5263 if (!dma_set_mask_and_coherent(hba->dev, DMA_BIT_MASK(64)))
5266 return dma_set_mask_and_coherent(hba->dev, DMA_BIT_MASK(32));
5270 * ufshcd_alloc_host - allocate Host Bus Adapter (HBA)
5271 * @dev: pointer to device handle
5272 * @hba_handle: driver private handle
5273 * Returns 0 on success, non-zero value on failure
5275 int ufshcd_alloc_host(struct device *dev, struct ufs_hba **hba_handle)
5277 struct Scsi_Host *host;
5278 struct ufs_hba *hba;
5283 "Invalid memory reference for dev is NULL\n");
5288 host = scsi_host_alloc(&ufshcd_driver_template,
5289 sizeof(struct ufs_hba));
5291 dev_err(dev, "scsi_host_alloc failed\n");
5295 hba = shost_priv(host);
5303 EXPORT_SYMBOL(ufshcd_alloc_host);
5305 static int ufshcd_scale_clks(struct ufs_hba *hba, bool scale_up)
5308 struct ufs_clk_info *clki;
5309 struct list_head *head = &hba->clk_list_head;
5311 if (!head || list_empty(head))
5314 list_for_each_entry(clki, head, list) {
5315 if (!IS_ERR_OR_NULL(clki->clk)) {
5316 if (scale_up && clki->max_freq) {
5317 if (clki->curr_freq == clki->max_freq)
5319 ret = clk_set_rate(clki->clk, clki->max_freq);
5321 dev_err(hba->dev, "%s: %s clk set rate(%dHz) failed, %d\n",
5322 __func__, clki->name,
5323 clki->max_freq, ret);
5326 clki->curr_freq = clki->max_freq;
5328 } else if (!scale_up && clki->min_freq) {
5329 if (clki->curr_freq == clki->min_freq)
5331 ret = clk_set_rate(clki->clk, clki->min_freq);
5333 dev_err(hba->dev, "%s: %s clk set rate(%dHz) failed, %d\n",
5334 __func__, clki->name,
5335 clki->min_freq, ret);
5338 clki->curr_freq = clki->min_freq;
5341 dev_dbg(hba->dev, "%s: clk: %s, rate: %lu\n", __func__,
5342 clki->name, clk_get_rate(clki->clk));
5344 if (hba->vops->clk_scale_notify)
5345 hba->vops->clk_scale_notify(hba);
5350 static int ufshcd_devfreq_target(struct device *dev,
5351 unsigned long *freq, u32 flags)
5354 struct ufs_hba *hba = dev_get_drvdata(dev);
5356 if (!ufshcd_is_clkscaling_enabled(hba))
5359 if (*freq == UINT_MAX)
5360 err = ufshcd_scale_clks(hba, true);
5361 else if (*freq == 0)
5362 err = ufshcd_scale_clks(hba, false);
5367 static int ufshcd_devfreq_get_dev_status(struct device *dev,
5368 struct devfreq_dev_status *stat)
5370 struct ufs_hba *hba = dev_get_drvdata(dev);
5371 struct ufs_clk_scaling *scaling = &hba->clk_scaling;
5372 unsigned long flags;
5374 if (!ufshcd_is_clkscaling_enabled(hba))
5377 memset(stat, 0, sizeof(*stat));
5379 spin_lock_irqsave(hba->host->host_lock, flags);
5380 if (!scaling->window_start_t)
5383 if (scaling->is_busy_started)
5384 scaling->tot_busy_t += ktime_to_us(ktime_sub(ktime_get(),
5385 scaling->busy_start_t));
5387 stat->total_time = jiffies_to_usecs((long)jiffies -
5388 (long)scaling->window_start_t);
5389 stat->busy_time = scaling->tot_busy_t;
5391 scaling->window_start_t = jiffies;
5392 scaling->tot_busy_t = 0;
5394 if (hba->outstanding_reqs) {
5395 scaling->busy_start_t = ktime_get();
5396 scaling->is_busy_started = true;
5398 scaling->busy_start_t = ktime_set(0, 0);
5399 scaling->is_busy_started = false;
5401 spin_unlock_irqrestore(hba->host->host_lock, flags);
5405 static struct devfreq_dev_profile ufs_devfreq_profile = {
5407 .target = ufshcd_devfreq_target,
5408 .get_dev_status = ufshcd_devfreq_get_dev_status,
5412 * ufshcd_init - Driver initialization routine
5413 * @hba: per-adapter instance
5414 * @mmio_base: base register address
5415 * @irq: Interrupt line of device
5416 * Returns 0 on success, non-zero value on failure
5418 int ufshcd_init(struct ufs_hba *hba, void __iomem *mmio_base, unsigned int irq)
5421 struct Scsi_Host *host = hba->host;
5422 struct device *dev = hba->dev;
5426 "Invalid memory reference for mmio_base is NULL\n");
5431 hba->mmio_base = mmio_base;
5434 err = ufshcd_hba_init(hba);
5438 /* Read capabilities registers */
5439 ufshcd_hba_capabilities(hba);
5441 /* Get UFS version supported by the controller */
5442 hba->ufs_version = ufshcd_get_ufs_version(hba);
5444 /* Get Interrupt bit mask per version */
5445 hba->intr_mask = ufshcd_get_intr_mask(hba);
5447 err = ufshcd_set_dma_mask(hba);
5449 dev_err(hba->dev, "set dma mask failed\n");
5453 /* Allocate memory for host memory space */
5454 err = ufshcd_memory_alloc(hba);
5456 dev_err(hba->dev, "Memory allocation failed\n");
5461 ufshcd_host_memory_configure(hba);
5463 host->can_queue = hba->nutrs;
5464 host->cmd_per_lun = hba->nutrs;
5465 host->max_id = UFSHCD_MAX_ID;
5466 host->max_lun = UFS_MAX_LUNS;
5467 host->max_channel = UFSHCD_MAX_CHANNEL;
5468 host->unique_id = host->host_no;
5469 host->max_cmd_len = MAX_CDB_SIZE;
5471 hba->max_pwr_info.is_valid = false;
5473 /* Initailize wait queue for task management */
5474 init_waitqueue_head(&hba->tm_wq);
5475 init_waitqueue_head(&hba->tm_tag_wq);
5477 /* Initialize work queues */
5478 INIT_WORK(&hba->eh_work, ufshcd_err_handler);
5479 INIT_WORK(&hba->eeh_work, ufshcd_exception_event_handler);
5481 /* Initialize UIC command mutex */
5482 mutex_init(&hba->uic_cmd_mutex);
5484 /* Initialize mutex for device management commands */
5485 mutex_init(&hba->dev_cmd.lock);
5487 /* Initialize device management tag acquire wait queue */
5488 init_waitqueue_head(&hba->dev_cmd.tag_wq);
5490 ufshcd_init_clk_gating(hba);
5491 /* IRQ registration */
5492 err = devm_request_irq(dev, irq, ufshcd_intr, IRQF_SHARED, UFSHCD, hba);
5494 dev_err(hba->dev, "request irq failed\n");
5497 hba->is_irq_enabled = true;
5500 /* Enable SCSI tag mapping */
5501 err = scsi_init_shared_tag_map(host, host->can_queue);
5503 dev_err(hba->dev, "init shared queue failed\n");
5507 err = scsi_add_host(host, hba->dev);
5509 dev_err(hba->dev, "scsi_add_host failed\n");
5513 /* Host controller enable */
5514 err = ufshcd_hba_enable(hba);
5516 dev_err(hba->dev, "Host controller enable failed\n");
5517 goto out_remove_scsi_host;
5520 if (ufshcd_is_clkscaling_enabled(hba)) {
5521 hba->devfreq = devfreq_add_device(dev, &ufs_devfreq_profile,
5522 "simple_ondemand", NULL);
5523 if (IS_ERR(hba->devfreq)) {
5524 dev_err(hba->dev, "Unable to register with devfreq %ld\n",
5525 PTR_ERR(hba->devfreq));
5526 goto out_remove_scsi_host;
5528 /* Suspend devfreq until the UFS device is detected */
5529 devfreq_suspend_device(hba->devfreq);
5530 hba->clk_scaling.window_start_t = 0;
5533 /* Hold auto suspend until async scan completes */
5534 pm_runtime_get_sync(dev);
5537 * The device-initialize-sequence hasn't been invoked yet.
5538 * Set the device to power-off state
5540 ufshcd_set_ufs_dev_poweroff(hba);
5542 async_schedule(ufshcd_async_scan, hba);
5546 out_remove_scsi_host:
5547 scsi_remove_host(hba->host);
5549 ufshcd_exit_clk_gating(hba);
5551 hba->is_irq_enabled = false;
5552 scsi_host_put(host);
5553 ufshcd_hba_exit(hba);
5557 EXPORT_SYMBOL_GPL(ufshcd_init);
5559 MODULE_AUTHOR("Santosh Yaragnavi <santosh.sy@samsung.com>");
5560 MODULE_AUTHOR("Vinayak Holikatti <h.vinayak@samsung.com>");
5561 MODULE_DESCRIPTION("Generic UFS host controller driver Core");
5562 MODULE_LICENSE("GPL");
5563 MODULE_VERSION(UFSHCD_DRIVER_VERSION);