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-2016, 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>
42 #include <linux/nls.h>
45 #include "ufs_quirks.h"
48 #define UFSHCD_ENABLE_INTRS (UTP_TRANSFER_REQ_COMPL |\
51 /* UIC command timeout, unit: ms */
52 #define UIC_CMD_TIMEOUT 500
54 /* NOP OUT retries waiting for NOP IN response */
55 #define NOP_OUT_RETRIES 10
56 /* Timeout after 30 msecs if NOP OUT hangs without response */
57 #define NOP_OUT_TIMEOUT 30 /* msecs */
59 /* Query request retries */
60 #define QUERY_REQ_RETRIES 10
61 /* Query request timeout */
62 #define QUERY_REQ_TIMEOUT 30 /* msec */
64 * Query request timeout for fDeviceInit flag
65 * fDeviceInit query response time for some devices is too large that default
66 * QUERY_REQ_TIMEOUT may not be enough for such devices.
68 #define QUERY_FDEVICEINIT_REQ_TIMEOUT 600 /* msec */
70 /* Task management command timeout */
71 #define TM_CMD_TIMEOUT 100 /* msecs */
73 /* maximum number of retries for a general UIC command */
74 #define UFS_UIC_COMMAND_RETRIES 3
76 /* maximum number of link-startup retries */
77 #define DME_LINKSTARTUP_RETRIES 3
79 /* Maximum retries for Hibern8 enter */
80 #define UIC_HIBERN8_ENTER_RETRIES 3
82 /* maximum number of reset retries before giving up */
83 #define MAX_HOST_RESET_RETRIES 5
85 /* Expose the flag value from utp_upiu_query.value */
86 #define MASK_QUERY_UPIU_FLAG_LOC 0xFF
88 /* Interrupt aggregation default timeout, unit: 40us */
89 #define INT_AGGR_DEF_TO 0x02
91 #define ufshcd_toggle_vreg(_dev, _vreg, _on) \
95 _ret = ufshcd_enable_vreg(_dev, _vreg); \
97 _ret = ufshcd_disable_vreg(_dev, _vreg); \
101 static u32 ufs_query_desc_max_size
[] = {
102 QUERY_DESC_DEVICE_MAX_SIZE
,
103 QUERY_DESC_CONFIGURAION_MAX_SIZE
,
104 QUERY_DESC_UNIT_MAX_SIZE
,
105 QUERY_DESC_RFU_MAX_SIZE
,
106 QUERY_DESC_INTERCONNECT_MAX_SIZE
,
107 QUERY_DESC_STRING_MAX_SIZE
,
108 QUERY_DESC_RFU_MAX_SIZE
,
109 QUERY_DESC_GEOMETRY_MAX_SIZE
,
110 QUERY_DESC_POWER_MAX_SIZE
,
111 QUERY_DESC_RFU_MAX_SIZE
,
115 UFSHCD_MAX_CHANNEL
= 0,
117 UFSHCD_CMD_PER_LUN
= 32,
118 UFSHCD_CAN_QUEUE
= 32,
125 UFSHCD_STATE_OPERATIONAL
,
128 /* UFSHCD error handling flags */
130 UFSHCD_EH_IN_PROGRESS
= (1 << 0),
133 /* UFSHCD UIC layer error flags */
135 UFSHCD_UIC_DL_PA_INIT_ERROR
= (1 << 0), /* Data link layer error */
136 UFSHCD_UIC_DL_NAC_RECEIVED_ERROR
= (1 << 1), /* Data link layer error */
137 UFSHCD_UIC_DL_TCx_REPLAY_ERROR
= (1 << 2), /* Data link layer error */
138 UFSHCD_UIC_NL_ERROR
= (1 << 3), /* Network layer error */
139 UFSHCD_UIC_TL_ERROR
= (1 << 4), /* Transport Layer error */
140 UFSHCD_UIC_DME_ERROR
= (1 << 5), /* DME error */
143 /* Interrupt configuration options */
150 #define ufshcd_set_eh_in_progress(h) \
151 (h->eh_flags |= UFSHCD_EH_IN_PROGRESS)
152 #define ufshcd_eh_in_progress(h) \
153 (h->eh_flags & UFSHCD_EH_IN_PROGRESS)
154 #define ufshcd_clear_eh_in_progress(h) \
155 (h->eh_flags &= ~UFSHCD_EH_IN_PROGRESS)
157 #define ufshcd_set_ufs_dev_active(h) \
158 ((h)->curr_dev_pwr_mode = UFS_ACTIVE_PWR_MODE)
159 #define ufshcd_set_ufs_dev_sleep(h) \
160 ((h)->curr_dev_pwr_mode = UFS_SLEEP_PWR_MODE)
161 #define ufshcd_set_ufs_dev_poweroff(h) \
162 ((h)->curr_dev_pwr_mode = UFS_POWERDOWN_PWR_MODE)
163 #define ufshcd_is_ufs_dev_active(h) \
164 ((h)->curr_dev_pwr_mode == UFS_ACTIVE_PWR_MODE)
165 #define ufshcd_is_ufs_dev_sleep(h) \
166 ((h)->curr_dev_pwr_mode == UFS_SLEEP_PWR_MODE)
167 #define ufshcd_is_ufs_dev_poweroff(h) \
168 ((h)->curr_dev_pwr_mode == UFS_POWERDOWN_PWR_MODE)
170 static struct ufs_pm_lvl_states ufs_pm_lvl_states
[] = {
171 {UFS_ACTIVE_PWR_MODE
, UIC_LINK_ACTIVE_STATE
},
172 {UFS_ACTIVE_PWR_MODE
, UIC_LINK_HIBERN8_STATE
},
173 {UFS_SLEEP_PWR_MODE
, UIC_LINK_ACTIVE_STATE
},
174 {UFS_SLEEP_PWR_MODE
, UIC_LINK_HIBERN8_STATE
},
175 {UFS_POWERDOWN_PWR_MODE
, UIC_LINK_HIBERN8_STATE
},
176 {UFS_POWERDOWN_PWR_MODE
, UIC_LINK_OFF_STATE
},
179 static inline enum ufs_dev_pwr_mode
180 ufs_get_pm_lvl_to_dev_pwr_mode(enum ufs_pm_level lvl
)
182 return ufs_pm_lvl_states
[lvl
].dev_state
;
185 static inline enum uic_link_state
186 ufs_get_pm_lvl_to_link_pwr_state(enum ufs_pm_level lvl
)
188 return ufs_pm_lvl_states
[lvl
].link_state
;
191 static void ufshcd_tmc_handler(struct ufs_hba
*hba
);
192 static void ufshcd_async_scan(void *data
, async_cookie_t cookie
);
193 static int ufshcd_reset_and_restore(struct ufs_hba
*hba
);
194 static int ufshcd_clear_tm_cmd(struct ufs_hba
*hba
, int tag
);
195 static void ufshcd_hba_exit(struct ufs_hba
*hba
);
196 static int ufshcd_probe_hba(struct ufs_hba
*hba
);
197 static int __ufshcd_setup_clocks(struct ufs_hba
*hba
, bool on
,
199 static int ufshcd_setup_clocks(struct ufs_hba
*hba
, bool on
);
200 static int ufshcd_set_vccq_rail_unused(struct ufs_hba
*hba
, bool unused
);
201 static int ufshcd_uic_hibern8_exit(struct ufs_hba
*hba
);
202 static int ufshcd_uic_hibern8_enter(struct ufs_hba
*hba
);
203 static inline void ufshcd_add_delay_before_dme_cmd(struct ufs_hba
*hba
);
204 static int ufshcd_host_reset_and_restore(struct ufs_hba
*hba
);
205 static irqreturn_t
ufshcd_intr(int irq
, void *__hba
);
206 static int ufshcd_config_pwr_mode(struct ufs_hba
*hba
,
207 struct ufs_pa_layer_attr
*desired_pwr_mode
);
208 static int ufshcd_change_power_mode(struct ufs_hba
*hba
,
209 struct ufs_pa_layer_attr
*pwr_mode
);
210 static inline bool ufshcd_valid_tag(struct ufs_hba
*hba
, int tag
)
212 return tag
>= 0 && tag
< hba
->nutrs
;
215 static inline int ufshcd_enable_irq(struct ufs_hba
*hba
)
219 if (!hba
->is_irq_enabled
) {
220 ret
= request_irq(hba
->irq
, ufshcd_intr
, IRQF_SHARED
, UFSHCD
,
223 dev_err(hba
->dev
, "%s: request_irq failed, ret=%d\n",
225 hba
->is_irq_enabled
= true;
231 static inline void ufshcd_disable_irq(struct ufs_hba
*hba
)
233 if (hba
->is_irq_enabled
) {
234 free_irq(hba
->irq
, hba
);
235 hba
->is_irq_enabled
= false;
239 /* replace non-printable or non-ASCII characters with spaces */
240 static inline void ufshcd_remove_non_printable(char *val
)
245 if (*val
< 0x20 || *val
> 0x7e)
250 * ufshcd_wait_for_register - wait for register value to change
251 * @hba - per-adapter interface
252 * @reg - mmio register offset
253 * @mask - mask to apply to read register value
254 * @val - wait condition
255 * @interval_us - polling interval in microsecs
256 * @timeout_ms - timeout in millisecs
257 * @can_sleep - perform sleep or just spin
259 * Returns -ETIMEDOUT on error, zero on success
261 int ufshcd_wait_for_register(struct ufs_hba
*hba
, u32 reg
, u32 mask
,
262 u32 val
, unsigned long interval_us
,
263 unsigned long timeout_ms
, bool can_sleep
)
266 unsigned long timeout
= jiffies
+ msecs_to_jiffies(timeout_ms
);
268 /* ignore bits that we don't intend to wait on */
271 while ((ufshcd_readl(hba
, reg
) & mask
) != val
) {
273 usleep_range(interval_us
, interval_us
+ 50);
276 if (time_after(jiffies
, timeout
)) {
277 if ((ufshcd_readl(hba
, reg
) & mask
) != val
)
287 * ufshcd_get_intr_mask - Get the interrupt bit mask
288 * @hba - Pointer to adapter instance
290 * Returns interrupt bit mask per version
292 static inline u32
ufshcd_get_intr_mask(struct ufs_hba
*hba
)
294 if (hba
->ufs_version
== UFSHCI_VERSION_10
)
295 return INTERRUPT_MASK_ALL_VER_10
;
297 return INTERRUPT_MASK_ALL_VER_11
;
301 * ufshcd_get_ufs_version - Get the UFS version supported by the HBA
302 * @hba - Pointer to adapter instance
304 * Returns UFSHCI version supported by the controller
306 static inline u32
ufshcd_get_ufs_version(struct ufs_hba
*hba
)
308 if (hba
->quirks
& UFSHCD_QUIRK_BROKEN_UFS_HCI_VERSION
)
309 return ufshcd_vops_get_ufs_hci_version(hba
);
311 return ufshcd_readl(hba
, REG_UFS_VERSION
);
315 * ufshcd_is_device_present - Check if any device connected to
316 * the host controller
317 * @hba: pointer to adapter instance
319 * Returns 1 if device present, 0 if no device detected
321 static inline int ufshcd_is_device_present(struct ufs_hba
*hba
)
323 return (ufshcd_readl(hba
, REG_CONTROLLER_STATUS
) &
324 DEVICE_PRESENT
) ? 1 : 0;
328 * ufshcd_get_tr_ocs - Get the UTRD Overall Command Status
329 * @lrb: pointer to local command reference block
331 * This function is used to get the OCS field from UTRD
332 * Returns the OCS field in the UTRD
334 static inline int ufshcd_get_tr_ocs(struct ufshcd_lrb
*lrbp
)
336 return le32_to_cpu(lrbp
->utr_descriptor_ptr
->header
.dword_2
) & MASK_OCS
;
340 * ufshcd_get_tmr_ocs - Get the UTMRD Overall Command Status
341 * @task_req_descp: pointer to utp_task_req_desc structure
343 * This function is used to get the OCS field from UTMRD
344 * Returns the OCS field in the UTMRD
347 ufshcd_get_tmr_ocs(struct utp_task_req_desc
*task_req_descp
)
349 return le32_to_cpu(task_req_descp
->header
.dword_2
) & MASK_OCS
;
353 * ufshcd_get_tm_free_slot - get a free slot for task management request
354 * @hba: per adapter instance
355 * @free_slot: pointer to variable with available slot value
357 * Get a free tag and lock it until ufshcd_put_tm_slot() is called.
358 * Returns 0 if free slot is not available, else return 1 with tag value
361 static bool ufshcd_get_tm_free_slot(struct ufs_hba
*hba
, int *free_slot
)
370 tag
= find_first_zero_bit(&hba
->tm_slots_in_use
, hba
->nutmrs
);
371 if (tag
>= hba
->nutmrs
)
373 } while (test_and_set_bit_lock(tag
, &hba
->tm_slots_in_use
));
381 static inline void ufshcd_put_tm_slot(struct ufs_hba
*hba
, int slot
)
383 clear_bit_unlock(slot
, &hba
->tm_slots_in_use
);
387 * ufshcd_utrl_clear - Clear a bit in UTRLCLR register
388 * @hba: per adapter instance
389 * @pos: position of the bit to be cleared
391 static inline void ufshcd_utrl_clear(struct ufs_hba
*hba
, u32 pos
)
393 ufshcd_writel(hba
, ~(1 << pos
), REG_UTP_TRANSFER_REQ_LIST_CLEAR
);
397 * ufshcd_outstanding_req_clear - Clear a bit in outstanding request field
398 * @hba: per adapter instance
399 * @tag: position of the bit to be cleared
401 static inline void ufshcd_outstanding_req_clear(struct ufs_hba
*hba
, int tag
)
403 __clear_bit(tag
, &hba
->outstanding_reqs
);
407 * ufshcd_get_lists_status - Check UCRDY, UTRLRDY and UTMRLRDY
408 * @reg: Register value of host controller status
410 * Returns integer, 0 on Success and positive value if failed
412 static inline int ufshcd_get_lists_status(u32 reg
)
415 * The mask 0xFF is for the following HCS register bits
423 return ((reg
& 0xFF) >> 1) ^ 0x07;
427 * ufshcd_get_uic_cmd_result - Get the UIC command result
428 * @hba: Pointer to adapter instance
430 * This function gets the result of UIC command completion
431 * Returns 0 on success, non zero value on error
433 static inline int ufshcd_get_uic_cmd_result(struct ufs_hba
*hba
)
435 return ufshcd_readl(hba
, REG_UIC_COMMAND_ARG_2
) &
436 MASK_UIC_COMMAND_RESULT
;
440 * ufshcd_get_dme_attr_val - Get the value of attribute returned by UIC command
441 * @hba: Pointer to adapter instance
443 * This function gets UIC command argument3
444 * Returns 0 on success, non zero value on error
446 static inline u32
ufshcd_get_dme_attr_val(struct ufs_hba
*hba
)
448 return ufshcd_readl(hba
, REG_UIC_COMMAND_ARG_3
);
452 * ufshcd_get_req_rsp - returns the TR response transaction type
453 * @ucd_rsp_ptr: pointer to response UPIU
456 ufshcd_get_req_rsp(struct utp_upiu_rsp
*ucd_rsp_ptr
)
458 return be32_to_cpu(ucd_rsp_ptr
->header
.dword_0
) >> 24;
462 * ufshcd_get_rsp_upiu_result - Get the result from response UPIU
463 * @ucd_rsp_ptr: pointer to response UPIU
465 * This function gets the response status and scsi_status from response UPIU
466 * Returns the response result code.
469 ufshcd_get_rsp_upiu_result(struct utp_upiu_rsp
*ucd_rsp_ptr
)
471 return be32_to_cpu(ucd_rsp_ptr
->header
.dword_1
) & MASK_RSP_UPIU_RESULT
;
475 * ufshcd_get_rsp_upiu_data_seg_len - Get the data segment length
477 * @ucd_rsp_ptr: pointer to response UPIU
479 * Return the data segment length.
481 static inline unsigned int
482 ufshcd_get_rsp_upiu_data_seg_len(struct utp_upiu_rsp
*ucd_rsp_ptr
)
484 return be32_to_cpu(ucd_rsp_ptr
->header
.dword_2
) &
485 MASK_RSP_UPIU_DATA_SEG_LEN
;
489 * ufshcd_is_exception_event - Check if the device raised an exception event
490 * @ucd_rsp_ptr: pointer to response UPIU
492 * The function checks if the device raised an exception event indicated in
493 * the Device Information field of response UPIU.
495 * Returns true if exception is raised, false otherwise.
497 static inline bool ufshcd_is_exception_event(struct utp_upiu_rsp
*ucd_rsp_ptr
)
499 return be32_to_cpu(ucd_rsp_ptr
->header
.dword_2
) &
500 MASK_RSP_EXCEPTION_EVENT
? true : false;
504 * ufshcd_reset_intr_aggr - Reset interrupt aggregation values.
505 * @hba: per adapter instance
508 ufshcd_reset_intr_aggr(struct ufs_hba
*hba
)
510 ufshcd_writel(hba
, INT_AGGR_ENABLE
|
511 INT_AGGR_COUNTER_AND_TIMER_RESET
,
512 REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL
);
516 * ufshcd_config_intr_aggr - Configure interrupt aggregation values.
517 * @hba: per adapter instance
518 * @cnt: Interrupt aggregation counter threshold
519 * @tmout: Interrupt aggregation timeout value
522 ufshcd_config_intr_aggr(struct ufs_hba
*hba
, u8 cnt
, u8 tmout
)
524 ufshcd_writel(hba
, INT_AGGR_ENABLE
| INT_AGGR_PARAM_WRITE
|
525 INT_AGGR_COUNTER_THLD_VAL(cnt
) |
526 INT_AGGR_TIMEOUT_VAL(tmout
),
527 REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL
);
531 * ufshcd_disable_intr_aggr - Disables interrupt aggregation.
532 * @hba: per adapter instance
534 static inline void ufshcd_disable_intr_aggr(struct ufs_hba
*hba
)
536 ufshcd_writel(hba
, 0, REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL
);
540 * ufshcd_enable_run_stop_reg - Enable run-stop registers,
541 * When run-stop registers are set to 1, it indicates the
542 * host controller that it can process the requests
543 * @hba: per adapter instance
545 static void ufshcd_enable_run_stop_reg(struct ufs_hba
*hba
)
547 ufshcd_writel(hba
, UTP_TASK_REQ_LIST_RUN_STOP_BIT
,
548 REG_UTP_TASK_REQ_LIST_RUN_STOP
);
549 ufshcd_writel(hba
, UTP_TRANSFER_REQ_LIST_RUN_STOP_BIT
,
550 REG_UTP_TRANSFER_REQ_LIST_RUN_STOP
);
554 * ufshcd_hba_start - Start controller initialization sequence
555 * @hba: per adapter instance
557 static inline void ufshcd_hba_start(struct ufs_hba
*hba
)
559 ufshcd_writel(hba
, CONTROLLER_ENABLE
, REG_CONTROLLER_ENABLE
);
563 * ufshcd_is_hba_active - Get controller state
564 * @hba: per adapter instance
566 * Returns zero if controller is active, 1 otherwise
568 static inline int ufshcd_is_hba_active(struct ufs_hba
*hba
)
570 return (ufshcd_readl(hba
, REG_CONTROLLER_ENABLE
) & 0x1) ? 0 : 1;
573 u32
ufshcd_get_local_unipro_ver(struct ufs_hba
*hba
)
575 /* HCI version 1.0 and 1.1 supports UniPro 1.41 */
576 if ((hba
->ufs_version
== UFSHCI_VERSION_10
) ||
577 (hba
->ufs_version
== UFSHCI_VERSION_11
))
578 return UFS_UNIPRO_VER_1_41
;
580 return UFS_UNIPRO_VER_1_6
;
582 EXPORT_SYMBOL(ufshcd_get_local_unipro_ver
);
584 static bool ufshcd_is_unipro_pa_params_tuning_req(struct ufs_hba
*hba
)
587 * If both host and device support UniPro ver1.6 or later, PA layer
588 * parameters tuning happens during link startup itself.
590 * We can manually tune PA layer parameters if either host or device
591 * doesn't support UniPro ver 1.6 or later. But to keep manual tuning
592 * logic simple, we will only do manual tuning if local unipro version
593 * doesn't support ver1.6 or later.
595 if (ufshcd_get_local_unipro_ver(hba
) < UFS_UNIPRO_VER_1_6
)
601 static void ufshcd_ungate_work(struct work_struct
*work
)
605 struct ufs_hba
*hba
= container_of(work
, struct ufs_hba
,
606 clk_gating
.ungate_work
);
608 cancel_delayed_work_sync(&hba
->clk_gating
.gate_work
);
610 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
611 if (hba
->clk_gating
.state
== CLKS_ON
) {
612 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
616 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
617 ufshcd_setup_clocks(hba
, true);
619 /* Exit from hibern8 */
620 if (ufshcd_can_hibern8_during_gating(hba
)) {
621 /* Prevent gating in this path */
622 hba
->clk_gating
.is_suspended
= true;
623 if (ufshcd_is_link_hibern8(hba
)) {
624 ret
= ufshcd_uic_hibern8_exit(hba
);
626 dev_err(hba
->dev
, "%s: hibern8 exit failed %d\n",
629 ufshcd_set_link_active(hba
);
631 hba
->clk_gating
.is_suspended
= false;
634 if (ufshcd_is_clkscaling_enabled(hba
))
635 devfreq_resume_device(hba
->devfreq
);
636 scsi_unblock_requests(hba
->host
);
640 * ufshcd_hold - Enable clocks that were gated earlier due to ufshcd_release.
641 * Also, exit from hibern8 mode and set the link as active.
642 * @hba: per adapter instance
643 * @async: This indicates whether caller should ungate clocks asynchronously.
645 int ufshcd_hold(struct ufs_hba
*hba
, bool async
)
650 if (!ufshcd_is_clkgating_allowed(hba
))
652 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
653 hba
->clk_gating
.active_reqs
++;
655 if (ufshcd_eh_in_progress(hba
)) {
656 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
661 switch (hba
->clk_gating
.state
) {
665 if (cancel_delayed_work(&hba
->clk_gating
.gate_work
)) {
666 hba
->clk_gating
.state
= CLKS_ON
;
670 * If we here, it means gating work is either done or
671 * currently running. Hence, fall through to cancel gating
672 * work and to enable clocks.
675 scsi_block_requests(hba
->host
);
676 hba
->clk_gating
.state
= REQ_CLKS_ON
;
677 schedule_work(&hba
->clk_gating
.ungate_work
);
679 * fall through to check if we should wait for this
680 * work to be done or not.
685 hba
->clk_gating
.active_reqs
--;
689 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
690 flush_work(&hba
->clk_gating
.ungate_work
);
691 /* Make sure state is CLKS_ON before returning */
692 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
695 dev_err(hba
->dev
, "%s: clk gating is in invalid state %d\n",
696 __func__
, hba
->clk_gating
.state
);
699 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
703 EXPORT_SYMBOL_GPL(ufshcd_hold
);
705 static void ufshcd_gate_work(struct work_struct
*work
)
707 struct ufs_hba
*hba
= container_of(work
, struct ufs_hba
,
708 clk_gating
.gate_work
.work
);
711 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
712 if (hba
->clk_gating
.is_suspended
) {
713 hba
->clk_gating
.state
= CLKS_ON
;
717 if (hba
->clk_gating
.active_reqs
718 || hba
->ufshcd_state
!= UFSHCD_STATE_OPERATIONAL
719 || hba
->lrb_in_use
|| hba
->outstanding_tasks
720 || hba
->active_uic_cmd
|| hba
->uic_async_done
)
723 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
725 /* put the link into hibern8 mode before turning off clocks */
726 if (ufshcd_can_hibern8_during_gating(hba
)) {
727 if (ufshcd_uic_hibern8_enter(hba
)) {
728 hba
->clk_gating
.state
= CLKS_ON
;
731 ufshcd_set_link_hibern8(hba
);
734 if (ufshcd_is_clkscaling_enabled(hba
)) {
735 devfreq_suspend_device(hba
->devfreq
);
736 hba
->clk_scaling
.window_start_t
= 0;
739 if (!ufshcd_is_link_active(hba
))
740 ufshcd_setup_clocks(hba
, false);
742 /* If link is active, device ref_clk can't be switched off */
743 __ufshcd_setup_clocks(hba
, false, true);
746 * In case you are here to cancel this work the gating state
747 * would be marked as REQ_CLKS_ON. In this case keep the state
748 * as REQ_CLKS_ON which would anyway imply that clocks are off
749 * and a request to turn them on is pending. By doing this way,
750 * we keep the state machine in tact and this would ultimately
751 * prevent from doing cancel work multiple times when there are
752 * new requests arriving before the current cancel work is done.
754 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
755 if (hba
->clk_gating
.state
== REQ_CLKS_OFF
)
756 hba
->clk_gating
.state
= CLKS_OFF
;
759 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
764 /* host lock must be held before calling this variant */
765 static void __ufshcd_release(struct ufs_hba
*hba
)
767 if (!ufshcd_is_clkgating_allowed(hba
))
770 hba
->clk_gating
.active_reqs
--;
772 if (hba
->clk_gating
.active_reqs
|| hba
->clk_gating
.is_suspended
773 || hba
->ufshcd_state
!= UFSHCD_STATE_OPERATIONAL
774 || hba
->lrb_in_use
|| hba
->outstanding_tasks
775 || hba
->active_uic_cmd
|| hba
->uic_async_done
776 || ufshcd_eh_in_progress(hba
))
779 hba
->clk_gating
.state
= REQ_CLKS_OFF
;
780 schedule_delayed_work(&hba
->clk_gating
.gate_work
,
781 msecs_to_jiffies(hba
->clk_gating
.delay_ms
));
784 void ufshcd_release(struct ufs_hba
*hba
)
788 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
789 __ufshcd_release(hba
);
790 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
792 EXPORT_SYMBOL_GPL(ufshcd_release
);
794 static ssize_t
ufshcd_clkgate_delay_show(struct device
*dev
,
795 struct device_attribute
*attr
, char *buf
)
797 struct ufs_hba
*hba
= dev_get_drvdata(dev
);
799 return snprintf(buf
, PAGE_SIZE
, "%lu\n", hba
->clk_gating
.delay_ms
);
802 static ssize_t
ufshcd_clkgate_delay_store(struct device
*dev
,
803 struct device_attribute
*attr
, const char *buf
, size_t count
)
805 struct ufs_hba
*hba
= dev_get_drvdata(dev
);
806 unsigned long flags
, value
;
808 if (kstrtoul(buf
, 0, &value
))
811 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
812 hba
->clk_gating
.delay_ms
= value
;
813 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
817 static void ufshcd_init_clk_gating(struct ufs_hba
*hba
)
819 if (!ufshcd_is_clkgating_allowed(hba
))
822 hba
->clk_gating
.delay_ms
= 150;
823 INIT_DELAYED_WORK(&hba
->clk_gating
.gate_work
, ufshcd_gate_work
);
824 INIT_WORK(&hba
->clk_gating
.ungate_work
, ufshcd_ungate_work
);
826 hba
->clk_gating
.delay_attr
.show
= ufshcd_clkgate_delay_show
;
827 hba
->clk_gating
.delay_attr
.store
= ufshcd_clkgate_delay_store
;
828 sysfs_attr_init(&hba
->clk_gating
.delay_attr
.attr
);
829 hba
->clk_gating
.delay_attr
.attr
.name
= "clkgate_delay_ms";
830 hba
->clk_gating
.delay_attr
.attr
.mode
= S_IRUGO
| S_IWUSR
;
831 if (device_create_file(hba
->dev
, &hba
->clk_gating
.delay_attr
))
832 dev_err(hba
->dev
, "Failed to create sysfs for clkgate_delay\n");
835 static void ufshcd_exit_clk_gating(struct ufs_hba
*hba
)
837 if (!ufshcd_is_clkgating_allowed(hba
))
839 device_remove_file(hba
->dev
, &hba
->clk_gating
.delay_attr
);
840 cancel_work_sync(&hba
->clk_gating
.ungate_work
);
841 cancel_delayed_work_sync(&hba
->clk_gating
.gate_work
);
844 /* Must be called with host lock acquired */
845 static void ufshcd_clk_scaling_start_busy(struct ufs_hba
*hba
)
847 if (!ufshcd_is_clkscaling_enabled(hba
))
850 if (!hba
->clk_scaling
.is_busy_started
) {
851 hba
->clk_scaling
.busy_start_t
= ktime_get();
852 hba
->clk_scaling
.is_busy_started
= true;
856 static void ufshcd_clk_scaling_update_busy(struct ufs_hba
*hba
)
858 struct ufs_clk_scaling
*scaling
= &hba
->clk_scaling
;
860 if (!ufshcd_is_clkscaling_enabled(hba
))
863 if (!hba
->outstanding_reqs
&& scaling
->is_busy_started
) {
864 scaling
->tot_busy_t
+= ktime_to_us(ktime_sub(ktime_get(),
865 scaling
->busy_start_t
));
866 scaling
->busy_start_t
= ktime_set(0, 0);
867 scaling
->is_busy_started
= false;
871 * ufshcd_send_command - Send SCSI or device management commands
872 * @hba: per adapter instance
873 * @task_tag: Task tag of the command
876 void ufshcd_send_command(struct ufs_hba
*hba
, unsigned int task_tag
)
878 ufshcd_clk_scaling_start_busy(hba
);
879 __set_bit(task_tag
, &hba
->outstanding_reqs
);
880 ufshcd_writel(hba
, 1 << task_tag
, REG_UTP_TRANSFER_REQ_DOOR_BELL
);
884 * ufshcd_copy_sense_data - Copy sense data in case of check condition
885 * @lrb - pointer to local reference block
887 static inline void ufshcd_copy_sense_data(struct ufshcd_lrb
*lrbp
)
890 if (lrbp
->sense_buffer
&&
891 ufshcd_get_rsp_upiu_data_seg_len(lrbp
->ucd_rsp_ptr
)) {
892 len
= be16_to_cpu(lrbp
->ucd_rsp_ptr
->sr
.sense_data_len
);
893 memcpy(lrbp
->sense_buffer
,
894 lrbp
->ucd_rsp_ptr
->sr
.sense_data
,
895 min_t(int, len
, SCSI_SENSE_BUFFERSIZE
));
900 * ufshcd_copy_query_response() - Copy the Query Response and the data
902 * @hba: per adapter instance
903 * @lrb - pointer to local reference block
906 int ufshcd_copy_query_response(struct ufs_hba
*hba
, struct ufshcd_lrb
*lrbp
)
908 struct ufs_query_res
*query_res
= &hba
->dev_cmd
.query
.response
;
910 memcpy(&query_res
->upiu_res
, &lrbp
->ucd_rsp_ptr
->qr
, QUERY_OSF_SIZE
);
912 /* Get the descriptor */
913 if (lrbp
->ucd_rsp_ptr
->qr
.opcode
== UPIU_QUERY_OPCODE_READ_DESC
) {
914 u8
*descp
= (u8
*)lrbp
->ucd_rsp_ptr
+
915 GENERAL_UPIU_REQUEST_SIZE
;
919 /* data segment length */
920 resp_len
= be32_to_cpu(lrbp
->ucd_rsp_ptr
->header
.dword_2
) &
921 MASK_QUERY_DATA_SEG_LEN
;
922 buf_len
= be16_to_cpu(
923 hba
->dev_cmd
.query
.request
.upiu_req
.length
);
924 if (likely(buf_len
>= resp_len
)) {
925 memcpy(hba
->dev_cmd
.query
.descriptor
, descp
, resp_len
);
928 "%s: Response size is bigger than buffer",
938 * ufshcd_hba_capabilities - Read controller capabilities
939 * @hba: per adapter instance
941 static inline void ufshcd_hba_capabilities(struct ufs_hba
*hba
)
943 hba
->capabilities
= ufshcd_readl(hba
, REG_CONTROLLER_CAPABILITIES
);
945 /* nutrs and nutmrs are 0 based values */
946 hba
->nutrs
= (hba
->capabilities
& MASK_TRANSFER_REQUESTS_SLOTS
) + 1;
948 ((hba
->capabilities
& MASK_TASK_MANAGEMENT_REQUEST_SLOTS
) >> 16) + 1;
952 * ufshcd_ready_for_uic_cmd - Check if controller is ready
953 * to accept UIC commands
954 * @hba: per adapter instance
955 * Return true on success, else false
957 static inline bool ufshcd_ready_for_uic_cmd(struct ufs_hba
*hba
)
959 if (ufshcd_readl(hba
, REG_CONTROLLER_STATUS
) & UIC_COMMAND_READY
)
966 * ufshcd_get_upmcrs - Get the power mode change request status
967 * @hba: Pointer to adapter instance
969 * This function gets the UPMCRS field of HCS register
970 * Returns value of UPMCRS field
972 static inline u8
ufshcd_get_upmcrs(struct ufs_hba
*hba
)
974 return (ufshcd_readl(hba
, REG_CONTROLLER_STATUS
) >> 8) & 0x7;
978 * ufshcd_dispatch_uic_cmd - Dispatch UIC commands to unipro layers
979 * @hba: per adapter instance
980 * @uic_cmd: UIC command
982 * Mutex must be held.
985 ufshcd_dispatch_uic_cmd(struct ufs_hba
*hba
, struct uic_command
*uic_cmd
)
987 WARN_ON(hba
->active_uic_cmd
);
989 hba
->active_uic_cmd
= uic_cmd
;
992 ufshcd_writel(hba
, uic_cmd
->argument1
, REG_UIC_COMMAND_ARG_1
);
993 ufshcd_writel(hba
, uic_cmd
->argument2
, REG_UIC_COMMAND_ARG_2
);
994 ufshcd_writel(hba
, uic_cmd
->argument3
, REG_UIC_COMMAND_ARG_3
);
997 ufshcd_writel(hba
, uic_cmd
->command
& COMMAND_OPCODE_MASK
,
1002 * ufshcd_wait_for_uic_cmd - Wait complectioin of UIC command
1003 * @hba: per adapter instance
1004 * @uic_command: UIC command
1006 * Must be called with mutex held.
1007 * Returns 0 only if success.
1010 ufshcd_wait_for_uic_cmd(struct ufs_hba
*hba
, struct uic_command
*uic_cmd
)
1013 unsigned long flags
;
1015 if (wait_for_completion_timeout(&uic_cmd
->done
,
1016 msecs_to_jiffies(UIC_CMD_TIMEOUT
)))
1017 ret
= uic_cmd
->argument2
& MASK_UIC_COMMAND_RESULT
;
1021 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
1022 hba
->active_uic_cmd
= NULL
;
1023 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
1029 * __ufshcd_send_uic_cmd - Send UIC commands and retrieve the result
1030 * @hba: per adapter instance
1031 * @uic_cmd: UIC command
1032 * @completion: initialize the completion only if this is set to true
1034 * Identical to ufshcd_send_uic_cmd() expect mutex. Must be called
1035 * with mutex held and host_lock locked.
1036 * Returns 0 only if success.
1039 __ufshcd_send_uic_cmd(struct ufs_hba
*hba
, struct uic_command
*uic_cmd
,
1042 if (!ufshcd_ready_for_uic_cmd(hba
)) {
1044 "Controller not ready to accept UIC commands\n");
1049 init_completion(&uic_cmd
->done
);
1051 ufshcd_dispatch_uic_cmd(hba
, uic_cmd
);
1057 * ufshcd_send_uic_cmd - Send UIC commands and retrieve the result
1058 * @hba: per adapter instance
1059 * @uic_cmd: UIC command
1061 * Returns 0 only if success.
1064 ufshcd_send_uic_cmd(struct ufs_hba
*hba
, struct uic_command
*uic_cmd
)
1067 unsigned long flags
;
1069 ufshcd_hold(hba
, false);
1070 mutex_lock(&hba
->uic_cmd_mutex
);
1071 ufshcd_add_delay_before_dme_cmd(hba
);
1073 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
1074 ret
= __ufshcd_send_uic_cmd(hba
, uic_cmd
, true);
1075 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
1077 ret
= ufshcd_wait_for_uic_cmd(hba
, uic_cmd
);
1079 mutex_unlock(&hba
->uic_cmd_mutex
);
1081 ufshcd_release(hba
);
1086 * ufshcd_map_sg - Map scatter-gather list to prdt
1087 * @lrbp - pointer to local reference block
1089 * Returns 0 in case of success, non-zero value in case of failure
1091 static int ufshcd_map_sg(struct ufshcd_lrb
*lrbp
)
1093 struct ufshcd_sg_entry
*prd_table
;
1094 struct scatterlist
*sg
;
1095 struct scsi_cmnd
*cmd
;
1100 sg_segments
= scsi_dma_map(cmd
);
1101 if (sg_segments
< 0)
1105 lrbp
->utr_descriptor_ptr
->prd_table_length
=
1106 cpu_to_le16((u16
) (sg_segments
));
1108 prd_table
= (struct ufshcd_sg_entry
*)lrbp
->ucd_prdt_ptr
;
1110 scsi_for_each_sg(cmd
, sg
, sg_segments
, i
) {
1112 cpu_to_le32(((u32
) sg_dma_len(sg
))-1);
1113 prd_table
[i
].base_addr
=
1114 cpu_to_le32(lower_32_bits(sg
->dma_address
));
1115 prd_table
[i
].upper_addr
=
1116 cpu_to_le32(upper_32_bits(sg
->dma_address
));
1117 prd_table
[i
].reserved
= 0;
1120 lrbp
->utr_descriptor_ptr
->prd_table_length
= 0;
1127 * ufshcd_enable_intr - enable interrupts
1128 * @hba: per adapter instance
1129 * @intrs: interrupt bits
1131 static void ufshcd_enable_intr(struct ufs_hba
*hba
, u32 intrs
)
1133 u32 set
= ufshcd_readl(hba
, REG_INTERRUPT_ENABLE
);
1135 if (hba
->ufs_version
== UFSHCI_VERSION_10
) {
1137 rw
= set
& INTERRUPT_MASK_RW_VER_10
;
1138 set
= rw
| ((set
^ intrs
) & intrs
);
1143 ufshcd_writel(hba
, set
, REG_INTERRUPT_ENABLE
);
1147 * ufshcd_disable_intr - disable interrupts
1148 * @hba: per adapter instance
1149 * @intrs: interrupt bits
1151 static void ufshcd_disable_intr(struct ufs_hba
*hba
, u32 intrs
)
1153 u32 set
= ufshcd_readl(hba
, REG_INTERRUPT_ENABLE
);
1155 if (hba
->ufs_version
== UFSHCI_VERSION_10
) {
1157 rw
= (set
& INTERRUPT_MASK_RW_VER_10
) &
1158 ~(intrs
& INTERRUPT_MASK_RW_VER_10
);
1159 set
= rw
| ((set
& intrs
) & ~INTERRUPT_MASK_RW_VER_10
);
1165 ufshcd_writel(hba
, set
, REG_INTERRUPT_ENABLE
);
1169 * ufshcd_prepare_req_desc_hdr() - Fills the requests header
1170 * descriptor according to request
1171 * @lrbp: pointer to local reference block
1172 * @upiu_flags: flags required in the header
1173 * @cmd_dir: requests data direction
1175 static void ufshcd_prepare_req_desc_hdr(struct ufshcd_lrb
*lrbp
,
1176 u32
*upiu_flags
, enum dma_data_direction cmd_dir
)
1178 struct utp_transfer_req_desc
*req_desc
= lrbp
->utr_descriptor_ptr
;
1182 if (cmd_dir
== DMA_FROM_DEVICE
) {
1183 data_direction
= UTP_DEVICE_TO_HOST
;
1184 *upiu_flags
= UPIU_CMD_FLAGS_READ
;
1185 } else if (cmd_dir
== DMA_TO_DEVICE
) {
1186 data_direction
= UTP_HOST_TO_DEVICE
;
1187 *upiu_flags
= UPIU_CMD_FLAGS_WRITE
;
1189 data_direction
= UTP_NO_DATA_TRANSFER
;
1190 *upiu_flags
= UPIU_CMD_FLAGS_NONE
;
1193 dword_0
= data_direction
| (lrbp
->command_type
1194 << UPIU_COMMAND_TYPE_OFFSET
);
1196 dword_0
|= UTP_REQ_DESC_INT_CMD
;
1198 /* Transfer request descriptor header fields */
1199 req_desc
->header
.dword_0
= cpu_to_le32(dword_0
);
1200 /* dword_1 is reserved, hence it is set to 0 */
1201 req_desc
->header
.dword_1
= 0;
1203 * assigning invalid value for command status. Controller
1204 * updates OCS on command completion, with the command
1207 req_desc
->header
.dword_2
=
1208 cpu_to_le32(OCS_INVALID_COMMAND_STATUS
);
1209 /* dword_3 is reserved, hence it is set to 0 */
1210 req_desc
->header
.dword_3
= 0;
1212 req_desc
->prd_table_length
= 0;
1216 * ufshcd_prepare_utp_scsi_cmd_upiu() - fills the utp_transfer_req_desc,
1218 * @lrbp - local reference block pointer
1219 * @upiu_flags - flags
1222 void ufshcd_prepare_utp_scsi_cmd_upiu(struct ufshcd_lrb
*lrbp
, u32 upiu_flags
)
1224 struct utp_upiu_req
*ucd_req_ptr
= lrbp
->ucd_req_ptr
;
1225 unsigned short cdb_len
;
1227 /* command descriptor fields */
1228 ucd_req_ptr
->header
.dword_0
= UPIU_HEADER_DWORD(
1229 UPIU_TRANSACTION_COMMAND
, upiu_flags
,
1230 lrbp
->lun
, lrbp
->task_tag
);
1231 ucd_req_ptr
->header
.dword_1
= UPIU_HEADER_DWORD(
1232 UPIU_COMMAND_SET_TYPE_SCSI
, 0, 0, 0);
1234 /* Total EHS length and Data segment length will be zero */
1235 ucd_req_ptr
->header
.dword_2
= 0;
1237 ucd_req_ptr
->sc
.exp_data_transfer_len
=
1238 cpu_to_be32(lrbp
->cmd
->sdb
.length
);
1240 cdb_len
= min_t(unsigned short, lrbp
->cmd
->cmd_len
, MAX_CDB_SIZE
);
1241 memset(ucd_req_ptr
->sc
.cdb
, 0, MAX_CDB_SIZE
);
1242 memcpy(ucd_req_ptr
->sc
.cdb
, lrbp
->cmd
->cmnd
, cdb_len
);
1244 memset(lrbp
->ucd_rsp_ptr
, 0, sizeof(struct utp_upiu_rsp
));
1248 * ufshcd_prepare_utp_query_req_upiu() - fills the utp_transfer_req_desc,
1251 * @lrbp: local reference block pointer
1252 * @upiu_flags: flags
1254 static void ufshcd_prepare_utp_query_req_upiu(struct ufs_hba
*hba
,
1255 struct ufshcd_lrb
*lrbp
, u32 upiu_flags
)
1257 struct utp_upiu_req
*ucd_req_ptr
= lrbp
->ucd_req_ptr
;
1258 struct ufs_query
*query
= &hba
->dev_cmd
.query
;
1259 u16 len
= be16_to_cpu(query
->request
.upiu_req
.length
);
1260 u8
*descp
= (u8
*)lrbp
->ucd_req_ptr
+ GENERAL_UPIU_REQUEST_SIZE
;
1262 /* Query request header */
1263 ucd_req_ptr
->header
.dword_0
= UPIU_HEADER_DWORD(
1264 UPIU_TRANSACTION_QUERY_REQ
, upiu_flags
,
1265 lrbp
->lun
, lrbp
->task_tag
);
1266 ucd_req_ptr
->header
.dword_1
= UPIU_HEADER_DWORD(
1267 0, query
->request
.query_func
, 0, 0);
1269 /* Data segment length */
1270 ucd_req_ptr
->header
.dword_2
= UPIU_HEADER_DWORD(
1271 0, 0, len
>> 8, (u8
)len
);
1273 /* Copy the Query Request buffer as is */
1274 memcpy(&ucd_req_ptr
->qr
, &query
->request
.upiu_req
,
1277 /* Copy the Descriptor */
1278 if (query
->request
.upiu_req
.opcode
== UPIU_QUERY_OPCODE_WRITE_DESC
)
1279 memcpy(descp
, query
->descriptor
, len
);
1281 memset(lrbp
->ucd_rsp_ptr
, 0, sizeof(struct utp_upiu_rsp
));
1284 static inline void ufshcd_prepare_utp_nop_upiu(struct ufshcd_lrb
*lrbp
)
1286 struct utp_upiu_req
*ucd_req_ptr
= lrbp
->ucd_req_ptr
;
1288 memset(ucd_req_ptr
, 0, sizeof(struct utp_upiu_req
));
1290 /* command descriptor fields */
1291 ucd_req_ptr
->header
.dword_0
=
1293 UPIU_TRANSACTION_NOP_OUT
, 0, 0, lrbp
->task_tag
);
1294 /* clear rest of the fields of basic header */
1295 ucd_req_ptr
->header
.dword_1
= 0;
1296 ucd_req_ptr
->header
.dword_2
= 0;
1298 memset(lrbp
->ucd_rsp_ptr
, 0, sizeof(struct utp_upiu_rsp
));
1302 * ufshcd_comp_devman_upiu - UFS Protocol Information Unit(UPIU)
1303 * for Device Management Purposes
1304 * @hba - per adapter instance
1305 * @lrb - pointer to local reference block
1307 static int ufshcd_comp_devman_upiu(struct ufs_hba
*hba
, struct ufshcd_lrb
*lrbp
)
1312 if (hba
->ufs_version
== UFSHCI_VERSION_20
)
1313 lrbp
->command_type
= UTP_CMD_TYPE_UFS_STORAGE
;
1315 lrbp
->command_type
= UTP_CMD_TYPE_DEV_MANAGE
;
1317 ufshcd_prepare_req_desc_hdr(lrbp
, &upiu_flags
, DMA_NONE
);
1318 if (hba
->dev_cmd
.type
== DEV_CMD_TYPE_QUERY
)
1319 ufshcd_prepare_utp_query_req_upiu(hba
, lrbp
, upiu_flags
);
1320 else if (hba
->dev_cmd
.type
== DEV_CMD_TYPE_NOP
)
1321 ufshcd_prepare_utp_nop_upiu(lrbp
);
1329 * ufshcd_comp_scsi_upiu - UFS Protocol Information Unit(UPIU)
1331 * @hba - per adapter instance
1332 * @lrb - pointer to local reference block
1334 static int ufshcd_comp_scsi_upiu(struct ufs_hba
*hba
, struct ufshcd_lrb
*lrbp
)
1339 if (hba
->ufs_version
== UFSHCI_VERSION_20
)
1340 lrbp
->command_type
= UTP_CMD_TYPE_UFS_STORAGE
;
1342 lrbp
->command_type
= UTP_CMD_TYPE_SCSI
;
1344 if (likely(lrbp
->cmd
)) {
1345 ufshcd_prepare_req_desc_hdr(lrbp
, &upiu_flags
,
1346 lrbp
->cmd
->sc_data_direction
);
1347 ufshcd_prepare_utp_scsi_cmd_upiu(lrbp
, upiu_flags
);
1356 * ufshcd_scsi_to_upiu_lun - maps scsi LUN to UPIU LUN
1357 * @scsi_lun: scsi LUN id
1359 * Returns UPIU LUN id
1361 static inline u8
ufshcd_scsi_to_upiu_lun(unsigned int scsi_lun
)
1363 if (scsi_is_wlun(scsi_lun
))
1364 return (scsi_lun
& UFS_UPIU_MAX_UNIT_NUM_ID
)
1367 return scsi_lun
& UFS_UPIU_MAX_UNIT_NUM_ID
;
1371 * ufshcd_upiu_wlun_to_scsi_wlun - maps UPIU W-LUN id to SCSI W-LUN ID
1372 * @scsi_lun: UPIU W-LUN id
1374 * Returns SCSI W-LUN id
1376 static inline u16
ufshcd_upiu_wlun_to_scsi_wlun(u8 upiu_wlun_id
)
1378 return (upiu_wlun_id
& ~UFS_UPIU_WLUN_ID
) | SCSI_W_LUN_BASE
;
1382 * ufshcd_queuecommand - main entry point for SCSI requests
1383 * @cmd: command from SCSI Midlayer
1384 * @done: call back function
1386 * Returns 0 for success, non-zero in case of failure
1388 static int ufshcd_queuecommand(struct Scsi_Host
*host
, struct scsi_cmnd
*cmd
)
1390 struct ufshcd_lrb
*lrbp
;
1391 struct ufs_hba
*hba
;
1392 unsigned long flags
;
1396 hba
= shost_priv(host
);
1398 tag
= cmd
->request
->tag
;
1399 if (!ufshcd_valid_tag(hba
, tag
)) {
1401 "%s: invalid command tag %d: cmd=0x%p, cmd->request=0x%p",
1402 __func__
, tag
, cmd
, cmd
->request
);
1406 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
1407 switch (hba
->ufshcd_state
) {
1408 case UFSHCD_STATE_OPERATIONAL
:
1410 case UFSHCD_STATE_RESET
:
1411 err
= SCSI_MLQUEUE_HOST_BUSY
;
1413 case UFSHCD_STATE_ERROR
:
1414 set_host_byte(cmd
, DID_ERROR
);
1415 cmd
->scsi_done(cmd
);
1418 dev_WARN_ONCE(hba
->dev
, 1, "%s: invalid state %d\n",
1419 __func__
, hba
->ufshcd_state
);
1420 set_host_byte(cmd
, DID_BAD_TARGET
);
1421 cmd
->scsi_done(cmd
);
1425 /* if error handling is in progress, don't issue commands */
1426 if (ufshcd_eh_in_progress(hba
)) {
1427 set_host_byte(cmd
, DID_ERROR
);
1428 cmd
->scsi_done(cmd
);
1431 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
1433 /* acquire the tag to make sure device cmds don't use it */
1434 if (test_and_set_bit_lock(tag
, &hba
->lrb_in_use
)) {
1436 * Dev manage command in progress, requeue the command.
1437 * Requeuing the command helps in cases where the request *may*
1438 * find different tag instead of waiting for dev manage command
1441 err
= SCSI_MLQUEUE_HOST_BUSY
;
1445 err
= ufshcd_hold(hba
, true);
1447 err
= SCSI_MLQUEUE_HOST_BUSY
;
1448 clear_bit_unlock(tag
, &hba
->lrb_in_use
);
1451 WARN_ON(hba
->clk_gating
.state
!= CLKS_ON
);
1453 lrbp
= &hba
->lrb
[tag
];
1457 lrbp
->sense_bufflen
= SCSI_SENSE_BUFFERSIZE
;
1458 lrbp
->sense_buffer
= cmd
->sense_buffer
;
1459 lrbp
->task_tag
= tag
;
1460 lrbp
->lun
= ufshcd_scsi_to_upiu_lun(cmd
->device
->lun
);
1461 lrbp
->intr_cmd
= !ufshcd_is_intr_aggr_allowed(hba
) ? true : false;
1463 ufshcd_comp_scsi_upiu(hba
, lrbp
);
1465 err
= ufshcd_map_sg(lrbp
);
1468 clear_bit_unlock(tag
, &hba
->lrb_in_use
);
1472 /* issue command to the controller */
1473 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
1474 ufshcd_send_command(hba
, tag
);
1476 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
1481 static int ufshcd_compose_dev_cmd(struct ufs_hba
*hba
,
1482 struct ufshcd_lrb
*lrbp
, enum dev_cmd_type cmd_type
, int tag
)
1485 lrbp
->sense_bufflen
= 0;
1486 lrbp
->sense_buffer
= NULL
;
1487 lrbp
->task_tag
= tag
;
1488 lrbp
->lun
= 0; /* device management cmd is not specific to any LUN */
1489 lrbp
->intr_cmd
= true; /* No interrupt aggregation */
1490 hba
->dev_cmd
.type
= cmd_type
;
1492 return ufshcd_comp_devman_upiu(hba
, lrbp
);
1496 ufshcd_clear_cmd(struct ufs_hba
*hba
, int tag
)
1499 unsigned long flags
;
1500 u32 mask
= 1 << tag
;
1502 /* clear outstanding transaction before retry */
1503 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
1504 ufshcd_utrl_clear(hba
, tag
);
1505 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
1508 * wait for for h/w to clear corresponding bit in door-bell.
1509 * max. wait is 1 sec.
1511 err
= ufshcd_wait_for_register(hba
,
1512 REG_UTP_TRANSFER_REQ_DOOR_BELL
,
1513 mask
, ~mask
, 1000, 1000, true);
1519 ufshcd_check_query_response(struct ufs_hba
*hba
, struct ufshcd_lrb
*lrbp
)
1521 struct ufs_query_res
*query_res
= &hba
->dev_cmd
.query
.response
;
1523 /* Get the UPIU response */
1524 query_res
->response
= ufshcd_get_rsp_upiu_result(lrbp
->ucd_rsp_ptr
) >>
1525 UPIU_RSP_CODE_OFFSET
;
1526 return query_res
->response
;
1530 * ufshcd_dev_cmd_completion() - handles device management command responses
1531 * @hba: per adapter instance
1532 * @lrbp: pointer to local reference block
1535 ufshcd_dev_cmd_completion(struct ufs_hba
*hba
, struct ufshcd_lrb
*lrbp
)
1540 resp
= ufshcd_get_req_rsp(lrbp
->ucd_rsp_ptr
);
1543 case UPIU_TRANSACTION_NOP_IN
:
1544 if (hba
->dev_cmd
.type
!= DEV_CMD_TYPE_NOP
) {
1546 dev_err(hba
->dev
, "%s: unexpected response %x\n",
1550 case UPIU_TRANSACTION_QUERY_RSP
:
1551 err
= ufshcd_check_query_response(hba
, lrbp
);
1553 err
= ufshcd_copy_query_response(hba
, lrbp
);
1555 case UPIU_TRANSACTION_REJECT_UPIU
:
1556 /* TODO: handle Reject UPIU Response */
1558 dev_err(hba
->dev
, "%s: Reject UPIU not fully implemented\n",
1563 dev_err(hba
->dev
, "%s: Invalid device management cmd response: %x\n",
1571 static int ufshcd_wait_for_dev_cmd(struct ufs_hba
*hba
,
1572 struct ufshcd_lrb
*lrbp
, int max_timeout
)
1575 unsigned long time_left
;
1576 unsigned long flags
;
1578 time_left
= wait_for_completion_timeout(hba
->dev_cmd
.complete
,
1579 msecs_to_jiffies(max_timeout
));
1581 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
1582 hba
->dev_cmd
.complete
= NULL
;
1583 if (likely(time_left
)) {
1584 err
= ufshcd_get_tr_ocs(lrbp
);
1586 err
= ufshcd_dev_cmd_completion(hba
, lrbp
);
1588 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
1592 dev_dbg(hba
->dev
, "%s: dev_cmd request timedout, tag %d\n",
1593 __func__
, lrbp
->task_tag
);
1594 if (!ufshcd_clear_cmd(hba
, lrbp
->task_tag
))
1595 /* successfully cleared the command, retry if needed */
1598 * in case of an error, after clearing the doorbell,
1599 * we also need to clear the outstanding_request
1602 ufshcd_outstanding_req_clear(hba
, lrbp
->task_tag
);
1609 * ufshcd_get_dev_cmd_tag - Get device management command tag
1610 * @hba: per-adapter instance
1611 * @tag: pointer to variable with available slot value
1613 * Get a free slot and lock it until device management command
1616 * Returns false if free slot is unavailable for locking, else
1617 * return true with tag value in @tag.
1619 static bool ufshcd_get_dev_cmd_tag(struct ufs_hba
*hba
, int *tag_out
)
1629 tmp
= ~hba
->lrb_in_use
;
1630 tag
= find_last_bit(&tmp
, hba
->nutrs
);
1631 if (tag
>= hba
->nutrs
)
1633 } while (test_and_set_bit_lock(tag
, &hba
->lrb_in_use
));
1641 static inline void ufshcd_put_dev_cmd_tag(struct ufs_hba
*hba
, int tag
)
1643 clear_bit_unlock(tag
, &hba
->lrb_in_use
);
1647 * ufshcd_exec_dev_cmd - API for sending device management requests
1649 * @cmd_type - specifies the type (NOP, Query...)
1650 * @timeout - time in seconds
1652 * NOTE: Since there is only one available tag for device management commands,
1653 * it is expected you hold the hba->dev_cmd.lock mutex.
1655 static int ufshcd_exec_dev_cmd(struct ufs_hba
*hba
,
1656 enum dev_cmd_type cmd_type
, int timeout
)
1658 struct ufshcd_lrb
*lrbp
;
1661 struct completion wait
;
1662 unsigned long flags
;
1665 * Get free slot, sleep if slots are unavailable.
1666 * Even though we use wait_event() which sleeps indefinitely,
1667 * the maximum wait time is bounded by SCSI request timeout.
1669 wait_event(hba
->dev_cmd
.tag_wq
, ufshcd_get_dev_cmd_tag(hba
, &tag
));
1671 init_completion(&wait
);
1672 lrbp
= &hba
->lrb
[tag
];
1674 err
= ufshcd_compose_dev_cmd(hba
, lrbp
, cmd_type
, tag
);
1678 hba
->dev_cmd
.complete
= &wait
;
1680 /* Make sure descriptors are ready before ringing the doorbell */
1682 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
1683 ufshcd_send_command(hba
, tag
);
1684 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
1686 err
= ufshcd_wait_for_dev_cmd(hba
, lrbp
, timeout
);
1689 ufshcd_put_dev_cmd_tag(hba
, tag
);
1690 wake_up(&hba
->dev_cmd
.tag_wq
);
1695 * ufshcd_init_query() - init the query response and request parameters
1696 * @hba: per-adapter instance
1697 * @request: address of the request pointer to be initialized
1698 * @response: address of the response pointer to be initialized
1699 * @opcode: operation to perform
1700 * @idn: flag idn to access
1701 * @index: LU number to access
1702 * @selector: query/flag/descriptor further identification
1704 static inline void ufshcd_init_query(struct ufs_hba
*hba
,
1705 struct ufs_query_req
**request
, struct ufs_query_res
**response
,
1706 enum query_opcode opcode
, u8 idn
, u8 index
, u8 selector
)
1708 *request
= &hba
->dev_cmd
.query
.request
;
1709 *response
= &hba
->dev_cmd
.query
.response
;
1710 memset(*request
, 0, sizeof(struct ufs_query_req
));
1711 memset(*response
, 0, sizeof(struct ufs_query_res
));
1712 (*request
)->upiu_req
.opcode
= opcode
;
1713 (*request
)->upiu_req
.idn
= idn
;
1714 (*request
)->upiu_req
.index
= index
;
1715 (*request
)->upiu_req
.selector
= selector
;
1718 static int ufshcd_query_flag_retry(struct ufs_hba
*hba
,
1719 enum query_opcode opcode
, enum flag_idn idn
, bool *flag_res
)
1724 for (retries
= 0; retries
< QUERY_REQ_RETRIES
; retries
++) {
1725 ret
= ufshcd_query_flag(hba
, opcode
, idn
, flag_res
);
1728 "%s: failed with error %d, retries %d\n",
1729 __func__
, ret
, retries
);
1736 "%s: query attribute, opcode %d, idn %d, failed with error %d after %d retires\n",
1737 __func__
, opcode
, idn
, ret
, retries
);
1742 * ufshcd_query_flag() - API function for sending flag query requests
1743 * hba: per-adapter instance
1744 * query_opcode: flag query to perform
1745 * idn: flag idn to access
1746 * flag_res: the flag value after the query request completes
1748 * Returns 0 for success, non-zero in case of failure
1750 int ufshcd_query_flag(struct ufs_hba
*hba
, enum query_opcode opcode
,
1751 enum flag_idn idn
, bool *flag_res
)
1753 struct ufs_query_req
*request
= NULL
;
1754 struct ufs_query_res
*response
= NULL
;
1755 int err
, index
= 0, selector
= 0;
1756 int timeout
= QUERY_REQ_TIMEOUT
;
1760 ufshcd_hold(hba
, false);
1761 mutex_lock(&hba
->dev_cmd
.lock
);
1762 ufshcd_init_query(hba
, &request
, &response
, opcode
, idn
, index
,
1766 case UPIU_QUERY_OPCODE_SET_FLAG
:
1767 case UPIU_QUERY_OPCODE_CLEAR_FLAG
:
1768 case UPIU_QUERY_OPCODE_TOGGLE_FLAG
:
1769 request
->query_func
= UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST
;
1771 case UPIU_QUERY_OPCODE_READ_FLAG
:
1772 request
->query_func
= UPIU_QUERY_FUNC_STANDARD_READ_REQUEST
;
1774 /* No dummy reads */
1775 dev_err(hba
->dev
, "%s: Invalid argument for read request\n",
1783 "%s: Expected query flag opcode but got = %d\n",
1789 if (idn
== QUERY_FLAG_IDN_FDEVICEINIT
)
1790 timeout
= QUERY_FDEVICEINIT_REQ_TIMEOUT
;
1792 err
= ufshcd_exec_dev_cmd(hba
, DEV_CMD_TYPE_QUERY
, timeout
);
1796 "%s: Sending flag query for idn %d failed, err = %d\n",
1797 __func__
, idn
, err
);
1802 *flag_res
= (be32_to_cpu(response
->upiu_res
.value
) &
1803 MASK_QUERY_UPIU_FLAG_LOC
) & 0x1;
1806 mutex_unlock(&hba
->dev_cmd
.lock
);
1807 ufshcd_release(hba
);
1812 * ufshcd_query_attr - API function for sending attribute requests
1813 * hba: per-adapter instance
1814 * opcode: attribute opcode
1815 * idn: attribute idn to access
1816 * index: index field
1817 * selector: selector field
1818 * attr_val: the attribute value after the query request completes
1820 * Returns 0 for success, non-zero in case of failure
1822 static int ufshcd_query_attr(struct ufs_hba
*hba
, enum query_opcode opcode
,
1823 enum attr_idn idn
, u8 index
, u8 selector
, u32
*attr_val
)
1825 struct ufs_query_req
*request
= NULL
;
1826 struct ufs_query_res
*response
= NULL
;
1831 ufshcd_hold(hba
, false);
1833 dev_err(hba
->dev
, "%s: attribute value required for opcode 0x%x\n",
1839 mutex_lock(&hba
->dev_cmd
.lock
);
1840 ufshcd_init_query(hba
, &request
, &response
, opcode
, idn
, index
,
1844 case UPIU_QUERY_OPCODE_WRITE_ATTR
:
1845 request
->query_func
= UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST
;
1846 request
->upiu_req
.value
= cpu_to_be32(*attr_val
);
1848 case UPIU_QUERY_OPCODE_READ_ATTR
:
1849 request
->query_func
= UPIU_QUERY_FUNC_STANDARD_READ_REQUEST
;
1852 dev_err(hba
->dev
, "%s: Expected query attr opcode but got = 0x%.2x\n",
1858 err
= ufshcd_exec_dev_cmd(hba
, DEV_CMD_TYPE_QUERY
, QUERY_REQ_TIMEOUT
);
1861 dev_err(hba
->dev
, "%s: opcode 0x%.2x for idn %d failed, err = %d\n",
1862 __func__
, opcode
, idn
, err
);
1866 *attr_val
= be32_to_cpu(response
->upiu_res
.value
);
1869 mutex_unlock(&hba
->dev_cmd
.lock
);
1871 ufshcd_release(hba
);
1876 * ufshcd_query_attr_retry() - API function for sending query
1877 * attribute with retries
1878 * @hba: per-adapter instance
1879 * @opcode: attribute opcode
1880 * @idn: attribute idn to access
1881 * @index: index field
1882 * @selector: selector field
1883 * @attr_val: the attribute value after the query request
1886 * Returns 0 for success, non-zero in case of failure
1888 static int ufshcd_query_attr_retry(struct ufs_hba
*hba
,
1889 enum query_opcode opcode
, enum attr_idn idn
, u8 index
, u8 selector
,
1895 for (retries
= QUERY_REQ_RETRIES
; retries
> 0; retries
--) {
1896 ret
= ufshcd_query_attr(hba
, opcode
, idn
, index
,
1897 selector
, attr_val
);
1899 dev_dbg(hba
->dev
, "%s: failed with error %d, retries %d\n",
1900 __func__
, ret
, retries
);
1907 "%s: query attribute, idn %d, failed with error %d after %d retires\n",
1908 __func__
, idn
, ret
, QUERY_REQ_RETRIES
);
1912 static int __ufshcd_query_descriptor(struct ufs_hba
*hba
,
1913 enum query_opcode opcode
, enum desc_idn idn
, u8 index
,
1914 u8 selector
, u8
*desc_buf
, int *buf_len
)
1916 struct ufs_query_req
*request
= NULL
;
1917 struct ufs_query_res
*response
= NULL
;
1922 ufshcd_hold(hba
, false);
1924 dev_err(hba
->dev
, "%s: descriptor buffer required for opcode 0x%x\n",
1930 if (*buf_len
<= QUERY_DESC_MIN_SIZE
|| *buf_len
> QUERY_DESC_MAX_SIZE
) {
1931 dev_err(hba
->dev
, "%s: descriptor buffer size (%d) is out of range\n",
1932 __func__
, *buf_len
);
1937 mutex_lock(&hba
->dev_cmd
.lock
);
1938 ufshcd_init_query(hba
, &request
, &response
, opcode
, idn
, index
,
1940 hba
->dev_cmd
.query
.descriptor
= desc_buf
;
1941 request
->upiu_req
.length
= cpu_to_be16(*buf_len
);
1944 case UPIU_QUERY_OPCODE_WRITE_DESC
:
1945 request
->query_func
= UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST
;
1947 case UPIU_QUERY_OPCODE_READ_DESC
:
1948 request
->query_func
= UPIU_QUERY_FUNC_STANDARD_READ_REQUEST
;
1952 "%s: Expected query descriptor opcode but got = 0x%.2x\n",
1958 err
= ufshcd_exec_dev_cmd(hba
, DEV_CMD_TYPE_QUERY
, QUERY_REQ_TIMEOUT
);
1961 dev_err(hba
->dev
, "%s: opcode 0x%.2x for idn %d failed, err = %d\n",
1962 __func__
, opcode
, idn
, err
);
1966 hba
->dev_cmd
.query
.descriptor
= NULL
;
1967 *buf_len
= be16_to_cpu(response
->upiu_res
.length
);
1970 mutex_unlock(&hba
->dev_cmd
.lock
);
1972 ufshcd_release(hba
);
1977 * ufshcd_query_descriptor_retry - API function for sending descriptor
1979 * hba: per-adapter instance
1980 * opcode: attribute opcode
1981 * idn: attribute idn to access
1982 * index: index field
1983 * selector: selector field
1984 * desc_buf: the buffer that contains the descriptor
1985 * buf_len: length parameter passed to the device
1987 * Returns 0 for success, non-zero in case of failure.
1988 * The buf_len parameter will contain, on return, the length parameter
1989 * received on the response.
1991 int ufshcd_query_descriptor_retry(struct ufs_hba
*hba
,
1992 enum query_opcode opcode
, enum desc_idn idn
, u8 index
,
1993 u8 selector
, u8
*desc_buf
, int *buf_len
)
1998 for (retries
= QUERY_REQ_RETRIES
; retries
> 0; retries
--) {
1999 err
= __ufshcd_query_descriptor(hba
, opcode
, idn
, index
,
2000 selector
, desc_buf
, buf_len
);
2001 if (!err
|| err
== -EINVAL
)
2007 EXPORT_SYMBOL(ufshcd_query_descriptor_retry
);
2010 * ufshcd_read_desc_param - read the specified descriptor parameter
2011 * @hba: Pointer to adapter instance
2012 * @desc_id: descriptor idn value
2013 * @desc_index: descriptor index
2014 * @param_offset: offset of the parameter to read
2015 * @param_read_buf: pointer to buffer where parameter would be read
2016 * @param_size: sizeof(param_read_buf)
2018 * Return 0 in case of success, non-zero otherwise
2020 static int ufshcd_read_desc_param(struct ufs_hba
*hba
,
2021 enum desc_idn desc_id
,
2030 bool is_kmalloc
= true;
2033 if (desc_id
>= QUERY_DESC_IDN_MAX
)
2036 buff_len
= ufs_query_desc_max_size
[desc_id
];
2037 if ((param_offset
+ param_size
) > buff_len
)
2040 if (!param_offset
&& (param_size
== buff_len
)) {
2041 /* memory space already available to hold full descriptor */
2042 desc_buf
= param_read_buf
;
2045 /* allocate memory to hold full descriptor */
2046 desc_buf
= kmalloc(buff_len
, GFP_KERNEL
);
2051 ret
= ufshcd_query_descriptor_retry(hba
, UPIU_QUERY_OPCODE_READ_DESC
,
2052 desc_id
, desc_index
, 0, desc_buf
,
2055 if (ret
|| (buff_len
< ufs_query_desc_max_size
[desc_id
]) ||
2056 (desc_buf
[QUERY_DESC_LENGTH_OFFSET
] !=
2057 ufs_query_desc_max_size
[desc_id
])
2058 || (desc_buf
[QUERY_DESC_DESC_TYPE_OFFSET
] != desc_id
)) {
2059 dev_err(hba
->dev
, "%s: Failed reading descriptor. desc_id %d param_offset %d buff_len %d ret %d",
2060 __func__
, desc_id
, param_offset
, buff_len
, ret
);
2068 memcpy(param_read_buf
, &desc_buf
[param_offset
], param_size
);
2075 static inline int ufshcd_read_desc(struct ufs_hba
*hba
,
2076 enum desc_idn desc_id
,
2081 return ufshcd_read_desc_param(hba
, desc_id
, desc_index
, 0, buf
, size
);
2084 static inline int ufshcd_read_power_desc(struct ufs_hba
*hba
,
2088 return ufshcd_read_desc(hba
, QUERY_DESC_IDN_POWER
, 0, buf
, size
);
2091 int ufshcd_read_device_desc(struct ufs_hba
*hba
, u8
*buf
, u32 size
)
2093 return ufshcd_read_desc(hba
, QUERY_DESC_IDN_DEVICE
, 0, buf
, size
);
2095 EXPORT_SYMBOL(ufshcd_read_device_desc
);
2098 * ufshcd_read_string_desc - read string descriptor
2099 * @hba: pointer to adapter instance
2100 * @desc_index: descriptor index
2101 * @buf: pointer to buffer where descriptor would be read
2102 * @size: size of buf
2103 * @ascii: if true convert from unicode to ascii characters
2105 * Return 0 in case of success, non-zero otherwise
2107 int ufshcd_read_string_desc(struct ufs_hba
*hba
, int desc_index
, u8
*buf
,
2108 u32 size
, bool ascii
)
2112 err
= ufshcd_read_desc(hba
,
2113 QUERY_DESC_IDN_STRING
, desc_index
, buf
, size
);
2116 dev_err(hba
->dev
, "%s: reading String Desc failed after %d retries. err = %d\n",
2117 __func__
, QUERY_REQ_RETRIES
, err
);
2128 /* remove header and divide by 2 to move from UTF16 to UTF8 */
2129 ascii_len
= (desc_len
- QUERY_DESC_HDR_SIZE
) / 2 + 1;
2130 if (size
< ascii_len
+ QUERY_DESC_HDR_SIZE
) {
2131 dev_err(hba
->dev
, "%s: buffer allocated size is too small\n",
2137 buff_ascii
= kmalloc(ascii_len
, GFP_KERNEL
);
2144 * the descriptor contains string in UTF16 format
2145 * we need to convert to utf-8 so it can be displayed
2147 utf16s_to_utf8s((wchar_t *)&buf
[QUERY_DESC_HDR_SIZE
],
2148 desc_len
- QUERY_DESC_HDR_SIZE
,
2149 UTF16_BIG_ENDIAN
, buff_ascii
, ascii_len
);
2151 /* replace non-printable or non-ASCII characters with spaces */
2152 for (i
= 0; i
< ascii_len
; i
++)
2153 ufshcd_remove_non_printable(&buff_ascii
[i
]);
2155 memset(buf
+ QUERY_DESC_HDR_SIZE
, 0,
2156 size
- QUERY_DESC_HDR_SIZE
);
2157 memcpy(buf
+ QUERY_DESC_HDR_SIZE
, buff_ascii
, ascii_len
);
2158 buf
[QUERY_DESC_LENGTH_OFFSET
] = ascii_len
+ QUERY_DESC_HDR_SIZE
;
2165 EXPORT_SYMBOL(ufshcd_read_string_desc
);
2168 * ufshcd_read_unit_desc_param - read the specified unit descriptor parameter
2169 * @hba: Pointer to adapter instance
2171 * @param_offset: offset of the parameter to read
2172 * @param_read_buf: pointer to buffer where parameter would be read
2173 * @param_size: sizeof(param_read_buf)
2175 * Return 0 in case of success, non-zero otherwise
2177 static inline int ufshcd_read_unit_desc_param(struct ufs_hba
*hba
,
2179 enum unit_desc_param param_offset
,
2184 * Unit descriptors are only available for general purpose LUs (LUN id
2185 * from 0 to 7) and RPMB Well known LU.
2187 if (lun
!= UFS_UPIU_RPMB_WLUN
&& (lun
>= UFS_UPIU_MAX_GENERAL_LUN
))
2190 return ufshcd_read_desc_param(hba
, QUERY_DESC_IDN_UNIT
, lun
,
2191 param_offset
, param_read_buf
, param_size
);
2195 * ufshcd_memory_alloc - allocate memory for host memory space data structures
2196 * @hba: per adapter instance
2198 * 1. Allocate DMA memory for Command Descriptor array
2199 * Each command descriptor consist of Command UPIU, Response UPIU and PRDT
2200 * 2. Allocate DMA memory for UTP Transfer Request Descriptor List (UTRDL).
2201 * 3. Allocate DMA memory for UTP Task Management Request Descriptor List
2203 * 4. Allocate memory for local reference block(lrb).
2205 * Returns 0 for success, non-zero in case of failure
2207 static int ufshcd_memory_alloc(struct ufs_hba
*hba
)
2209 size_t utmrdl_size
, utrdl_size
, ucdl_size
;
2211 /* Allocate memory for UTP command descriptors */
2212 ucdl_size
= (sizeof(struct utp_transfer_cmd_desc
) * hba
->nutrs
);
2213 hba
->ucdl_base_addr
= dmam_alloc_coherent(hba
->dev
,
2215 &hba
->ucdl_dma_addr
,
2219 * UFSHCI requires UTP command descriptor to be 128 byte aligned.
2220 * make sure hba->ucdl_dma_addr is aligned to PAGE_SIZE
2221 * if hba->ucdl_dma_addr is aligned to PAGE_SIZE, then it will
2222 * be aligned to 128 bytes as well
2224 if (!hba
->ucdl_base_addr
||
2225 WARN_ON(hba
->ucdl_dma_addr
& (PAGE_SIZE
- 1))) {
2227 "Command Descriptor Memory allocation failed\n");
2232 * Allocate memory for UTP Transfer descriptors
2233 * UFSHCI requires 1024 byte alignment of UTRD
2235 utrdl_size
= (sizeof(struct utp_transfer_req_desc
) * hba
->nutrs
);
2236 hba
->utrdl_base_addr
= dmam_alloc_coherent(hba
->dev
,
2238 &hba
->utrdl_dma_addr
,
2240 if (!hba
->utrdl_base_addr
||
2241 WARN_ON(hba
->utrdl_dma_addr
& (PAGE_SIZE
- 1))) {
2243 "Transfer Descriptor Memory allocation failed\n");
2248 * Allocate memory for UTP Task Management descriptors
2249 * UFSHCI requires 1024 byte alignment of UTMRD
2251 utmrdl_size
= sizeof(struct utp_task_req_desc
) * hba
->nutmrs
;
2252 hba
->utmrdl_base_addr
= dmam_alloc_coherent(hba
->dev
,
2254 &hba
->utmrdl_dma_addr
,
2256 if (!hba
->utmrdl_base_addr
||
2257 WARN_ON(hba
->utmrdl_dma_addr
& (PAGE_SIZE
- 1))) {
2259 "Task Management Descriptor Memory allocation failed\n");
2263 /* Allocate memory for local reference block */
2264 hba
->lrb
= devm_kzalloc(hba
->dev
,
2265 hba
->nutrs
* sizeof(struct ufshcd_lrb
),
2268 dev_err(hba
->dev
, "LRB Memory allocation failed\n");
2277 * ufshcd_host_memory_configure - configure local reference block with
2279 * @hba: per adapter instance
2281 * Configure Host memory space
2282 * 1. Update Corresponding UTRD.UCDBA and UTRD.UCDBAU with UCD DMA
2284 * 2. Update each UTRD with Response UPIU offset, Response UPIU length
2286 * 3. Save the corresponding addresses of UTRD, UCD.CMD, UCD.RSP and UCD.PRDT
2287 * into local reference block.
2289 static void ufshcd_host_memory_configure(struct ufs_hba
*hba
)
2291 struct utp_transfer_cmd_desc
*cmd_descp
;
2292 struct utp_transfer_req_desc
*utrdlp
;
2293 dma_addr_t cmd_desc_dma_addr
;
2294 dma_addr_t cmd_desc_element_addr
;
2295 u16 response_offset
;
2300 utrdlp
= hba
->utrdl_base_addr
;
2301 cmd_descp
= hba
->ucdl_base_addr
;
2304 offsetof(struct utp_transfer_cmd_desc
, response_upiu
);
2306 offsetof(struct utp_transfer_cmd_desc
, prd_table
);
2308 cmd_desc_size
= sizeof(struct utp_transfer_cmd_desc
);
2309 cmd_desc_dma_addr
= hba
->ucdl_dma_addr
;
2311 for (i
= 0; i
< hba
->nutrs
; i
++) {
2312 /* Configure UTRD with command descriptor base address */
2313 cmd_desc_element_addr
=
2314 (cmd_desc_dma_addr
+ (cmd_desc_size
* i
));
2315 utrdlp
[i
].command_desc_base_addr_lo
=
2316 cpu_to_le32(lower_32_bits(cmd_desc_element_addr
));
2317 utrdlp
[i
].command_desc_base_addr_hi
=
2318 cpu_to_le32(upper_32_bits(cmd_desc_element_addr
));
2320 /* Response upiu and prdt offset should be in double words */
2321 utrdlp
[i
].response_upiu_offset
=
2322 cpu_to_le16((response_offset
>> 2));
2323 utrdlp
[i
].prd_table_offset
=
2324 cpu_to_le16((prdt_offset
>> 2));
2325 utrdlp
[i
].response_upiu_length
=
2326 cpu_to_le16(ALIGNED_UPIU_SIZE
>> 2);
2328 hba
->lrb
[i
].utr_descriptor_ptr
= (utrdlp
+ i
);
2329 hba
->lrb
[i
].ucd_req_ptr
=
2330 (struct utp_upiu_req
*)(cmd_descp
+ i
);
2331 hba
->lrb
[i
].ucd_rsp_ptr
=
2332 (struct utp_upiu_rsp
*)cmd_descp
[i
].response_upiu
;
2333 hba
->lrb
[i
].ucd_prdt_ptr
=
2334 (struct ufshcd_sg_entry
*)cmd_descp
[i
].prd_table
;
2339 * ufshcd_dme_link_startup - Notify Unipro to perform link startup
2340 * @hba: per adapter instance
2342 * UIC_CMD_DME_LINK_STARTUP command must be issued to Unipro layer,
2343 * in order to initialize the Unipro link startup procedure.
2344 * Once the Unipro links are up, the device connected to the controller
2347 * Returns 0 on success, non-zero value on failure
2349 static int ufshcd_dme_link_startup(struct ufs_hba
*hba
)
2351 struct uic_command uic_cmd
= {0};
2354 uic_cmd
.command
= UIC_CMD_DME_LINK_STARTUP
;
2356 ret
= ufshcd_send_uic_cmd(hba
, &uic_cmd
);
2359 "dme-link-startup: error code %d\n", ret
);
2363 static inline void ufshcd_add_delay_before_dme_cmd(struct ufs_hba
*hba
)
2365 #define MIN_DELAY_BEFORE_DME_CMDS_US 1000
2366 unsigned long min_sleep_time_us
;
2368 if (!(hba
->quirks
& UFSHCD_QUIRK_DELAY_BEFORE_DME_CMDS
))
2372 * last_dme_cmd_tstamp will be 0 only for 1st call to
2375 if (unlikely(!ktime_to_us(hba
->last_dme_cmd_tstamp
))) {
2376 min_sleep_time_us
= MIN_DELAY_BEFORE_DME_CMDS_US
;
2378 unsigned long delta
=
2379 (unsigned long) ktime_to_us(
2380 ktime_sub(ktime_get(),
2381 hba
->last_dme_cmd_tstamp
));
2383 if (delta
< MIN_DELAY_BEFORE_DME_CMDS_US
)
2385 MIN_DELAY_BEFORE_DME_CMDS_US
- delta
;
2387 return; /* no more delay required */
2390 /* allow sleep for extra 50us if needed */
2391 usleep_range(min_sleep_time_us
, min_sleep_time_us
+ 50);
2395 * ufshcd_dme_set_attr - UIC command for DME_SET, DME_PEER_SET
2396 * @hba: per adapter instance
2397 * @attr_sel: uic command argument1
2398 * @attr_set: attribute set type as uic command argument2
2399 * @mib_val: setting value as uic command argument3
2400 * @peer: indicate whether peer or local
2402 * Returns 0 on success, non-zero value on failure
2404 int ufshcd_dme_set_attr(struct ufs_hba
*hba
, u32 attr_sel
,
2405 u8 attr_set
, u32 mib_val
, u8 peer
)
2407 struct uic_command uic_cmd
= {0};
2408 static const char *const action
[] = {
2412 const char *set
= action
[!!peer
];
2414 int retries
= UFS_UIC_COMMAND_RETRIES
;
2416 uic_cmd
.command
= peer
?
2417 UIC_CMD_DME_PEER_SET
: UIC_CMD_DME_SET
;
2418 uic_cmd
.argument1
= attr_sel
;
2419 uic_cmd
.argument2
= UIC_ARG_ATTR_TYPE(attr_set
);
2420 uic_cmd
.argument3
= mib_val
;
2423 /* for peer attributes we retry upon failure */
2424 ret
= ufshcd_send_uic_cmd(hba
, &uic_cmd
);
2426 dev_dbg(hba
->dev
, "%s: attr-id 0x%x val 0x%x error code %d\n",
2427 set
, UIC_GET_ATTR_ID(attr_sel
), mib_val
, ret
);
2428 } while (ret
&& peer
&& --retries
);
2431 dev_err(hba
->dev
, "%s: attr-id 0x%x val 0x%x failed %d retries\n",
2432 set
, UIC_GET_ATTR_ID(attr_sel
), mib_val
,
2437 EXPORT_SYMBOL_GPL(ufshcd_dme_set_attr
);
2440 * ufshcd_dme_get_attr - UIC command for DME_GET, DME_PEER_GET
2441 * @hba: per adapter instance
2442 * @attr_sel: uic command argument1
2443 * @mib_val: the value of the attribute as returned by the UIC command
2444 * @peer: indicate whether peer or local
2446 * Returns 0 on success, non-zero value on failure
2448 int ufshcd_dme_get_attr(struct ufs_hba
*hba
, u32 attr_sel
,
2449 u32
*mib_val
, u8 peer
)
2451 struct uic_command uic_cmd
= {0};
2452 static const char *const action
[] = {
2456 const char *get
= action
[!!peer
];
2458 int retries
= UFS_UIC_COMMAND_RETRIES
;
2459 struct ufs_pa_layer_attr orig_pwr_info
;
2460 struct ufs_pa_layer_attr temp_pwr_info
;
2461 bool pwr_mode_change
= false;
2463 if (peer
&& (hba
->quirks
& UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE
)) {
2464 orig_pwr_info
= hba
->pwr_info
;
2465 temp_pwr_info
= orig_pwr_info
;
2467 if (orig_pwr_info
.pwr_tx
== FAST_MODE
||
2468 orig_pwr_info
.pwr_rx
== FAST_MODE
) {
2469 temp_pwr_info
.pwr_tx
= FASTAUTO_MODE
;
2470 temp_pwr_info
.pwr_rx
= FASTAUTO_MODE
;
2471 pwr_mode_change
= true;
2472 } else if (orig_pwr_info
.pwr_tx
== SLOW_MODE
||
2473 orig_pwr_info
.pwr_rx
== SLOW_MODE
) {
2474 temp_pwr_info
.pwr_tx
= SLOWAUTO_MODE
;
2475 temp_pwr_info
.pwr_rx
= SLOWAUTO_MODE
;
2476 pwr_mode_change
= true;
2478 if (pwr_mode_change
) {
2479 ret
= ufshcd_change_power_mode(hba
, &temp_pwr_info
);
2485 uic_cmd
.command
= peer
?
2486 UIC_CMD_DME_PEER_GET
: UIC_CMD_DME_GET
;
2487 uic_cmd
.argument1
= attr_sel
;
2490 /* for peer attributes we retry upon failure */
2491 ret
= ufshcd_send_uic_cmd(hba
, &uic_cmd
);
2493 dev_dbg(hba
->dev
, "%s: attr-id 0x%x error code %d\n",
2494 get
, UIC_GET_ATTR_ID(attr_sel
), ret
);
2495 } while (ret
&& peer
&& --retries
);
2498 dev_err(hba
->dev
, "%s: attr-id 0x%x failed %d retries\n",
2499 get
, UIC_GET_ATTR_ID(attr_sel
), retries
);
2501 if (mib_val
&& !ret
)
2502 *mib_val
= uic_cmd
.argument3
;
2504 if (peer
&& (hba
->quirks
& UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE
)
2506 ufshcd_change_power_mode(hba
, &orig_pwr_info
);
2510 EXPORT_SYMBOL_GPL(ufshcd_dme_get_attr
);
2513 * ufshcd_uic_pwr_ctrl - executes UIC commands (which affects the link power
2514 * state) and waits for it to take effect.
2516 * @hba: per adapter instance
2517 * @cmd: UIC command to execute
2519 * DME operations like DME_SET(PA_PWRMODE), DME_HIBERNATE_ENTER &
2520 * DME_HIBERNATE_EXIT commands take some time to take its effect on both host
2521 * and device UniPro link and hence it's final completion would be indicated by
2522 * dedicated status bits in Interrupt Status register (UPMS, UHES, UHXS) in
2523 * addition to normal UIC command completion Status (UCCS). This function only
2524 * returns after the relevant status bits indicate the completion.
2526 * Returns 0 on success, non-zero value on failure
2528 static int ufshcd_uic_pwr_ctrl(struct ufs_hba
*hba
, struct uic_command
*cmd
)
2530 struct completion uic_async_done
;
2531 unsigned long flags
;
2534 bool reenable_intr
= false;
2536 mutex_lock(&hba
->uic_cmd_mutex
);
2537 init_completion(&uic_async_done
);
2538 ufshcd_add_delay_before_dme_cmd(hba
);
2540 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
2541 hba
->uic_async_done
= &uic_async_done
;
2542 if (ufshcd_readl(hba
, REG_INTERRUPT_ENABLE
) & UIC_COMMAND_COMPL
) {
2543 ufshcd_disable_intr(hba
, UIC_COMMAND_COMPL
);
2545 * Make sure UIC command completion interrupt is disabled before
2546 * issuing UIC command.
2549 reenable_intr
= true;
2551 ret
= __ufshcd_send_uic_cmd(hba
, cmd
, false);
2552 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
2555 "pwr ctrl cmd 0x%x with mode 0x%x uic error %d\n",
2556 cmd
->command
, cmd
->argument3
, ret
);
2560 if (!wait_for_completion_timeout(hba
->uic_async_done
,
2561 msecs_to_jiffies(UIC_CMD_TIMEOUT
))) {
2563 "pwr ctrl cmd 0x%x with mode 0x%x completion timeout\n",
2564 cmd
->command
, cmd
->argument3
);
2569 status
= ufshcd_get_upmcrs(hba
);
2570 if (status
!= PWR_LOCAL
) {
2572 "pwr ctrl cmd 0x%0x failed, host umpcrs:0x%x\n",
2573 cmd
->command
, status
);
2574 ret
= (status
!= PWR_OK
) ? status
: -1;
2577 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
2578 hba
->active_uic_cmd
= NULL
;
2579 hba
->uic_async_done
= NULL
;
2581 ufshcd_enable_intr(hba
, UIC_COMMAND_COMPL
);
2582 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
2583 mutex_unlock(&hba
->uic_cmd_mutex
);
2589 * ufshcd_uic_change_pwr_mode - Perform the UIC power mode chage
2590 * using DME_SET primitives.
2591 * @hba: per adapter instance
2592 * @mode: powr mode value
2594 * Returns 0 on success, non-zero value on failure
2596 static int ufshcd_uic_change_pwr_mode(struct ufs_hba
*hba
, u8 mode
)
2598 struct uic_command uic_cmd
= {0};
2601 if (hba
->quirks
& UFSHCD_QUIRK_BROKEN_PA_RXHSUNTERMCAP
) {
2602 ret
= ufshcd_dme_set(hba
,
2603 UIC_ARG_MIB_SEL(PA_RXHSUNTERMCAP
, 0), 1);
2605 dev_err(hba
->dev
, "%s: failed to enable PA_RXHSUNTERMCAP ret %d\n",
2611 uic_cmd
.command
= UIC_CMD_DME_SET
;
2612 uic_cmd
.argument1
= UIC_ARG_MIB(PA_PWRMODE
);
2613 uic_cmd
.argument3
= mode
;
2614 ufshcd_hold(hba
, false);
2615 ret
= ufshcd_uic_pwr_ctrl(hba
, &uic_cmd
);
2616 ufshcd_release(hba
);
2622 static int ufshcd_link_recovery(struct ufs_hba
*hba
)
2625 unsigned long flags
;
2627 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
2628 hba
->ufshcd_state
= UFSHCD_STATE_RESET
;
2629 ufshcd_set_eh_in_progress(hba
);
2630 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
2632 ret
= ufshcd_host_reset_and_restore(hba
);
2634 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
2636 hba
->ufshcd_state
= UFSHCD_STATE_ERROR
;
2637 ufshcd_clear_eh_in_progress(hba
);
2638 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
2641 dev_err(hba
->dev
, "%s: link recovery failed, err %d",
2647 static int __ufshcd_uic_hibern8_enter(struct ufs_hba
*hba
)
2650 struct uic_command uic_cmd
= {0};
2652 uic_cmd
.command
= UIC_CMD_DME_HIBER_ENTER
;
2653 ret
= ufshcd_uic_pwr_ctrl(hba
, &uic_cmd
);
2656 dev_err(hba
->dev
, "%s: hibern8 enter failed. ret = %d\n",
2660 * If link recovery fails then return error so that caller
2661 * don't retry the hibern8 enter again.
2663 if (ufshcd_link_recovery(hba
))
2670 static int ufshcd_uic_hibern8_enter(struct ufs_hba
*hba
)
2672 int ret
= 0, retries
;
2674 for (retries
= UIC_HIBERN8_ENTER_RETRIES
; retries
> 0; retries
--) {
2675 ret
= __ufshcd_uic_hibern8_enter(hba
);
2676 if (!ret
|| ret
== -ENOLINK
)
2683 static int ufshcd_uic_hibern8_exit(struct ufs_hba
*hba
)
2685 struct uic_command uic_cmd
= {0};
2688 uic_cmd
.command
= UIC_CMD_DME_HIBER_EXIT
;
2689 ret
= ufshcd_uic_pwr_ctrl(hba
, &uic_cmd
);
2691 dev_err(hba
->dev
, "%s: hibern8 exit failed. ret = %d\n",
2693 ret
= ufshcd_link_recovery(hba
);
2700 * ufshcd_init_pwr_info - setting the POR (power on reset)
2701 * values in hba power info
2702 * @hba: per-adapter instance
2704 static void ufshcd_init_pwr_info(struct ufs_hba
*hba
)
2706 hba
->pwr_info
.gear_rx
= UFS_PWM_G1
;
2707 hba
->pwr_info
.gear_tx
= UFS_PWM_G1
;
2708 hba
->pwr_info
.lane_rx
= 1;
2709 hba
->pwr_info
.lane_tx
= 1;
2710 hba
->pwr_info
.pwr_rx
= SLOWAUTO_MODE
;
2711 hba
->pwr_info
.pwr_tx
= SLOWAUTO_MODE
;
2712 hba
->pwr_info
.hs_rate
= 0;
2716 * ufshcd_get_max_pwr_mode - reads the max power mode negotiated with device
2717 * @hba: per-adapter instance
2719 static int ufshcd_get_max_pwr_mode(struct ufs_hba
*hba
)
2721 struct ufs_pa_layer_attr
*pwr_info
= &hba
->max_pwr_info
.info
;
2723 if (hba
->max_pwr_info
.is_valid
)
2726 pwr_info
->pwr_tx
= FASTAUTO_MODE
;
2727 pwr_info
->pwr_rx
= FASTAUTO_MODE
;
2728 pwr_info
->hs_rate
= PA_HS_MODE_B
;
2730 /* Get the connected lane count */
2731 ufshcd_dme_get(hba
, UIC_ARG_MIB(PA_CONNECTEDRXDATALANES
),
2732 &pwr_info
->lane_rx
);
2733 ufshcd_dme_get(hba
, UIC_ARG_MIB(PA_CONNECTEDTXDATALANES
),
2734 &pwr_info
->lane_tx
);
2736 if (!pwr_info
->lane_rx
|| !pwr_info
->lane_tx
) {
2737 dev_err(hba
->dev
, "%s: invalid connected lanes value. rx=%d, tx=%d\n",
2745 * First, get the maximum gears of HS speed.
2746 * If a zero value, it means there is no HSGEAR capability.
2747 * Then, get the maximum gears of PWM speed.
2749 ufshcd_dme_get(hba
, UIC_ARG_MIB(PA_MAXRXHSGEAR
), &pwr_info
->gear_rx
);
2750 if (!pwr_info
->gear_rx
) {
2751 ufshcd_dme_get(hba
, UIC_ARG_MIB(PA_MAXRXPWMGEAR
),
2752 &pwr_info
->gear_rx
);
2753 if (!pwr_info
->gear_rx
) {
2754 dev_err(hba
->dev
, "%s: invalid max pwm rx gear read = %d\n",
2755 __func__
, pwr_info
->gear_rx
);
2758 pwr_info
->pwr_rx
= SLOWAUTO_MODE
;
2761 ufshcd_dme_peer_get(hba
, UIC_ARG_MIB(PA_MAXRXHSGEAR
),
2762 &pwr_info
->gear_tx
);
2763 if (!pwr_info
->gear_tx
) {
2764 ufshcd_dme_peer_get(hba
, UIC_ARG_MIB(PA_MAXRXPWMGEAR
),
2765 &pwr_info
->gear_tx
);
2766 if (!pwr_info
->gear_tx
) {
2767 dev_err(hba
->dev
, "%s: invalid max pwm tx gear read = %d\n",
2768 __func__
, pwr_info
->gear_tx
);
2771 pwr_info
->pwr_tx
= SLOWAUTO_MODE
;
2774 hba
->max_pwr_info
.is_valid
= true;
2778 static int ufshcd_change_power_mode(struct ufs_hba
*hba
,
2779 struct ufs_pa_layer_attr
*pwr_mode
)
2783 /* if already configured to the requested pwr_mode */
2784 if (pwr_mode
->gear_rx
== hba
->pwr_info
.gear_rx
&&
2785 pwr_mode
->gear_tx
== hba
->pwr_info
.gear_tx
&&
2786 pwr_mode
->lane_rx
== hba
->pwr_info
.lane_rx
&&
2787 pwr_mode
->lane_tx
== hba
->pwr_info
.lane_tx
&&
2788 pwr_mode
->pwr_rx
== hba
->pwr_info
.pwr_rx
&&
2789 pwr_mode
->pwr_tx
== hba
->pwr_info
.pwr_tx
&&
2790 pwr_mode
->hs_rate
== hba
->pwr_info
.hs_rate
) {
2791 dev_dbg(hba
->dev
, "%s: power already configured\n", __func__
);
2796 * Configure attributes for power mode change with below.
2797 * - PA_RXGEAR, PA_ACTIVERXDATALANES, PA_RXTERMINATION,
2798 * - PA_TXGEAR, PA_ACTIVETXDATALANES, PA_TXTERMINATION,
2801 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_RXGEAR
), pwr_mode
->gear_rx
);
2802 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_ACTIVERXDATALANES
),
2804 if (pwr_mode
->pwr_rx
== FASTAUTO_MODE
||
2805 pwr_mode
->pwr_rx
== FAST_MODE
)
2806 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_RXTERMINATION
), TRUE
);
2808 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_RXTERMINATION
), FALSE
);
2810 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_TXGEAR
), pwr_mode
->gear_tx
);
2811 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_ACTIVETXDATALANES
),
2813 if (pwr_mode
->pwr_tx
== FASTAUTO_MODE
||
2814 pwr_mode
->pwr_tx
== FAST_MODE
)
2815 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_TXTERMINATION
), TRUE
);
2817 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_TXTERMINATION
), FALSE
);
2819 if (pwr_mode
->pwr_rx
== FASTAUTO_MODE
||
2820 pwr_mode
->pwr_tx
== FASTAUTO_MODE
||
2821 pwr_mode
->pwr_rx
== FAST_MODE
||
2822 pwr_mode
->pwr_tx
== FAST_MODE
)
2823 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_HSSERIES
),
2826 ret
= ufshcd_uic_change_pwr_mode(hba
, pwr_mode
->pwr_rx
<< 4
2827 | pwr_mode
->pwr_tx
);
2831 "%s: power mode change failed %d\n", __func__
, ret
);
2833 ufshcd_vops_pwr_change_notify(hba
, POST_CHANGE
, NULL
,
2836 memcpy(&hba
->pwr_info
, pwr_mode
,
2837 sizeof(struct ufs_pa_layer_attr
));
2844 * ufshcd_config_pwr_mode - configure a new power mode
2845 * @hba: per-adapter instance
2846 * @desired_pwr_mode: desired power configuration
2848 static int ufshcd_config_pwr_mode(struct ufs_hba
*hba
,
2849 struct ufs_pa_layer_attr
*desired_pwr_mode
)
2851 struct ufs_pa_layer_attr final_params
= { 0 };
2854 ret
= ufshcd_vops_pwr_change_notify(hba
, PRE_CHANGE
,
2855 desired_pwr_mode
, &final_params
);
2858 memcpy(&final_params
, desired_pwr_mode
, sizeof(final_params
));
2860 ret
= ufshcd_change_power_mode(hba
, &final_params
);
2866 * ufshcd_complete_dev_init() - checks device readiness
2867 * hba: per-adapter instance
2869 * Set fDeviceInit flag and poll until device toggles it.
2871 static int ufshcd_complete_dev_init(struct ufs_hba
*hba
)
2877 err
= ufshcd_query_flag_retry(hba
, UPIU_QUERY_OPCODE_SET_FLAG
,
2878 QUERY_FLAG_IDN_FDEVICEINIT
, NULL
);
2881 "%s setting fDeviceInit flag failed with error %d\n",
2886 /* poll for max. 1000 iterations for fDeviceInit flag to clear */
2887 for (i
= 0; i
< 1000 && !err
&& flag_res
; i
++)
2888 err
= ufshcd_query_flag_retry(hba
, UPIU_QUERY_OPCODE_READ_FLAG
,
2889 QUERY_FLAG_IDN_FDEVICEINIT
, &flag_res
);
2893 "%s reading fDeviceInit flag failed with error %d\n",
2897 "%s fDeviceInit was not cleared by the device\n",
2905 * ufshcd_make_hba_operational - Make UFS controller operational
2906 * @hba: per adapter instance
2908 * To bring UFS host controller to operational state,
2909 * 1. Enable required interrupts
2910 * 2. Configure interrupt aggregation
2911 * 3. Program UTRL and UTMRL base address
2912 * 4. Configure run-stop-registers
2914 * Returns 0 on success, non-zero value on failure
2916 static int ufshcd_make_hba_operational(struct ufs_hba
*hba
)
2921 /* Enable required interrupts */
2922 ufshcd_enable_intr(hba
, UFSHCD_ENABLE_INTRS
);
2924 /* Configure interrupt aggregation */
2925 if (ufshcd_is_intr_aggr_allowed(hba
))
2926 ufshcd_config_intr_aggr(hba
, hba
->nutrs
- 1, INT_AGGR_DEF_TO
);
2928 ufshcd_disable_intr_aggr(hba
);
2930 /* Configure UTRL and UTMRL base address registers */
2931 ufshcd_writel(hba
, lower_32_bits(hba
->utrdl_dma_addr
),
2932 REG_UTP_TRANSFER_REQ_LIST_BASE_L
);
2933 ufshcd_writel(hba
, upper_32_bits(hba
->utrdl_dma_addr
),
2934 REG_UTP_TRANSFER_REQ_LIST_BASE_H
);
2935 ufshcd_writel(hba
, lower_32_bits(hba
->utmrdl_dma_addr
),
2936 REG_UTP_TASK_REQ_LIST_BASE_L
);
2937 ufshcd_writel(hba
, upper_32_bits(hba
->utmrdl_dma_addr
),
2938 REG_UTP_TASK_REQ_LIST_BASE_H
);
2941 * Make sure base address and interrupt setup are updated before
2942 * enabling the run/stop registers below.
2947 * UCRDY, UTMRLDY and UTRLRDY bits must be 1
2949 reg
= ufshcd_readl(hba
, REG_CONTROLLER_STATUS
);
2950 if (!(ufshcd_get_lists_status(reg
))) {
2951 ufshcd_enable_run_stop_reg(hba
);
2954 "Host controller not ready to process requests");
2964 * ufshcd_hba_stop - Send controller to reset state
2965 * @hba: per adapter instance
2966 * @can_sleep: perform sleep or just spin
2968 static inline void ufshcd_hba_stop(struct ufs_hba
*hba
, bool can_sleep
)
2972 ufshcd_writel(hba
, CONTROLLER_DISABLE
, REG_CONTROLLER_ENABLE
);
2973 err
= ufshcd_wait_for_register(hba
, REG_CONTROLLER_ENABLE
,
2974 CONTROLLER_ENABLE
, CONTROLLER_DISABLE
,
2977 dev_err(hba
->dev
, "%s: Controller disable failed\n", __func__
);
2981 * ufshcd_hba_enable - initialize the controller
2982 * @hba: per adapter instance
2984 * The controller resets itself and controller firmware initialization
2985 * sequence kicks off. When controller is ready it will set
2986 * the Host Controller Enable bit to 1.
2988 * Returns 0 on success, non-zero value on failure
2990 static int ufshcd_hba_enable(struct ufs_hba
*hba
)
2995 * msleep of 1 and 5 used in this function might result in msleep(20),
2996 * but it was necessary to send the UFS FPGA to reset mode during
2997 * development and testing of this driver. msleep can be changed to
2998 * mdelay and retry count can be reduced based on the controller.
3000 if (!ufshcd_is_hba_active(hba
))
3001 /* change controller state to "reset state" */
3002 ufshcd_hba_stop(hba
, true);
3004 /* UniPro link is disabled at this point */
3005 ufshcd_set_link_off(hba
);
3007 ufshcd_vops_hce_enable_notify(hba
, PRE_CHANGE
);
3009 /* start controller initialization sequence */
3010 ufshcd_hba_start(hba
);
3013 * To initialize a UFS host controller HCE bit must be set to 1.
3014 * During initialization the HCE bit value changes from 1->0->1.
3015 * When the host controller completes initialization sequence
3016 * it sets the value of HCE bit to 1. The same HCE bit is read back
3017 * to check if the controller has completed initialization sequence.
3018 * So without this delay the value HCE = 1, set in the previous
3019 * instruction might be read back.
3020 * This delay can be changed based on the controller.
3024 /* wait for the host controller to complete initialization */
3026 while (ufshcd_is_hba_active(hba
)) {
3031 "Controller enable failed\n");
3037 /* enable UIC related interrupts */
3038 ufshcd_enable_intr(hba
, UFSHCD_UIC_MASK
);
3040 ufshcd_vops_hce_enable_notify(hba
, POST_CHANGE
);
3045 static int ufshcd_disable_tx_lcc(struct ufs_hba
*hba
, bool peer
)
3047 int tx_lanes
, i
, err
= 0;
3050 ufshcd_dme_get(hba
, UIC_ARG_MIB(PA_CONNECTEDTXDATALANES
),
3053 ufshcd_dme_peer_get(hba
, UIC_ARG_MIB(PA_CONNECTEDTXDATALANES
),
3055 for (i
= 0; i
< tx_lanes
; i
++) {
3057 err
= ufshcd_dme_set(hba
,
3058 UIC_ARG_MIB_SEL(TX_LCC_ENABLE
,
3059 UIC_ARG_MPHY_TX_GEN_SEL_INDEX(i
)),
3062 err
= ufshcd_dme_peer_set(hba
,
3063 UIC_ARG_MIB_SEL(TX_LCC_ENABLE
,
3064 UIC_ARG_MPHY_TX_GEN_SEL_INDEX(i
)),
3067 dev_err(hba
->dev
, "%s: TX LCC Disable failed, peer = %d, lane = %d, err = %d",
3068 __func__
, peer
, i
, err
);
3076 static inline int ufshcd_disable_device_tx_lcc(struct ufs_hba
*hba
)
3078 return ufshcd_disable_tx_lcc(hba
, true);
3082 * ufshcd_link_startup - Initialize unipro link startup
3083 * @hba: per adapter instance
3085 * Returns 0 for success, non-zero in case of failure
3087 static int ufshcd_link_startup(struct ufs_hba
*hba
)
3090 int retries
= DME_LINKSTARTUP_RETRIES
;
3093 ufshcd_vops_link_startup_notify(hba
, PRE_CHANGE
);
3095 ret
= ufshcd_dme_link_startup(hba
);
3097 /* check if device is detected by inter-connect layer */
3098 if (!ret
&& !ufshcd_is_device_present(hba
)) {
3099 dev_err(hba
->dev
, "%s: Device not present\n", __func__
);
3105 * DME link lost indication is only received when link is up,
3106 * but we can't be sure if the link is up until link startup
3107 * succeeds. So reset the local Uni-Pro and try again.
3109 if (ret
&& ufshcd_hba_enable(hba
))
3111 } while (ret
&& retries
--);
3114 /* failed to get the link up... retire */
3117 if (hba
->quirks
& UFSHCD_QUIRK_BROKEN_LCC
) {
3118 ret
= ufshcd_disable_device_tx_lcc(hba
);
3123 /* Include any host controller configuration via UIC commands */
3124 ret
= ufshcd_vops_link_startup_notify(hba
, POST_CHANGE
);
3128 ret
= ufshcd_make_hba_operational(hba
);
3131 dev_err(hba
->dev
, "link startup failed %d\n", ret
);
3136 * ufshcd_verify_dev_init() - Verify device initialization
3137 * @hba: per-adapter instance
3139 * Send NOP OUT UPIU and wait for NOP IN response to check whether the
3140 * device Transport Protocol (UTP) layer is ready after a reset.
3141 * If the UTP layer at the device side is not initialized, it may
3142 * not respond with NOP IN UPIU within timeout of %NOP_OUT_TIMEOUT
3143 * and we retry sending NOP OUT for %NOP_OUT_RETRIES iterations.
3145 static int ufshcd_verify_dev_init(struct ufs_hba
*hba
)
3150 ufshcd_hold(hba
, false);
3151 mutex_lock(&hba
->dev_cmd
.lock
);
3152 for (retries
= NOP_OUT_RETRIES
; retries
> 0; retries
--) {
3153 err
= ufshcd_exec_dev_cmd(hba
, DEV_CMD_TYPE_NOP
,
3156 if (!err
|| err
== -ETIMEDOUT
)
3159 dev_dbg(hba
->dev
, "%s: error %d retrying\n", __func__
, err
);
3161 mutex_unlock(&hba
->dev_cmd
.lock
);
3162 ufshcd_release(hba
);
3165 dev_err(hba
->dev
, "%s: NOP OUT failed %d\n", __func__
, err
);
3170 * ufshcd_set_queue_depth - set lun queue depth
3171 * @sdev: pointer to SCSI device
3173 * Read bLUQueueDepth value and activate scsi tagged command
3174 * queueing. For WLUN, queue depth is set to 1. For best-effort
3175 * cases (bLUQueueDepth = 0) the queue depth is set to a maximum
3176 * value that host can queue.
3178 static void ufshcd_set_queue_depth(struct scsi_device
*sdev
)
3182 struct ufs_hba
*hba
;
3184 hba
= shost_priv(sdev
->host
);
3186 lun_qdepth
= hba
->nutrs
;
3187 ret
= ufshcd_read_unit_desc_param(hba
,
3188 ufshcd_scsi_to_upiu_lun(sdev
->lun
),
3189 UNIT_DESC_PARAM_LU_Q_DEPTH
,
3191 sizeof(lun_qdepth
));
3193 /* Some WLUN doesn't support unit descriptor */
3194 if (ret
== -EOPNOTSUPP
)
3196 else if (!lun_qdepth
)
3197 /* eventually, we can figure out the real queue depth */
3198 lun_qdepth
= hba
->nutrs
;
3200 lun_qdepth
= min_t(int, lun_qdepth
, hba
->nutrs
);
3202 dev_dbg(hba
->dev
, "%s: activate tcq with queue depth %d\n",
3203 __func__
, lun_qdepth
);
3204 scsi_change_queue_depth(sdev
, lun_qdepth
);
3208 * ufshcd_get_lu_wp - returns the "b_lu_write_protect" from UNIT DESCRIPTOR
3209 * @hba: per-adapter instance
3210 * @lun: UFS device lun id
3211 * @b_lu_write_protect: pointer to buffer to hold the LU's write protect info
3213 * Returns 0 in case of success and b_lu_write_protect status would be returned
3214 * @b_lu_write_protect parameter.
3215 * Returns -ENOTSUPP if reading b_lu_write_protect is not supported.
3216 * Returns -EINVAL in case of invalid parameters passed to this function.
3218 static int ufshcd_get_lu_wp(struct ufs_hba
*hba
,
3220 u8
*b_lu_write_protect
)
3224 if (!b_lu_write_protect
)
3227 * According to UFS device spec, RPMB LU can't be write
3228 * protected so skip reading bLUWriteProtect parameter for
3229 * it. For other W-LUs, UNIT DESCRIPTOR is not available.
3231 else if (lun
>= UFS_UPIU_MAX_GENERAL_LUN
)
3234 ret
= ufshcd_read_unit_desc_param(hba
,
3236 UNIT_DESC_PARAM_LU_WR_PROTECT
,
3238 sizeof(*b_lu_write_protect
));
3243 * ufshcd_get_lu_power_on_wp_status - get LU's power on write protect
3245 * @hba: per-adapter instance
3246 * @sdev: pointer to SCSI device
3249 static inline void ufshcd_get_lu_power_on_wp_status(struct ufs_hba
*hba
,
3250 struct scsi_device
*sdev
)
3252 if (hba
->dev_info
.f_power_on_wp_en
&&
3253 !hba
->dev_info
.is_lu_power_on_wp
) {
3254 u8 b_lu_write_protect
;
3256 if (!ufshcd_get_lu_wp(hba
, ufshcd_scsi_to_upiu_lun(sdev
->lun
),
3257 &b_lu_write_protect
) &&
3258 (b_lu_write_protect
== UFS_LU_POWER_ON_WP
))
3259 hba
->dev_info
.is_lu_power_on_wp
= true;
3264 * ufshcd_slave_alloc - handle initial SCSI device configurations
3265 * @sdev: pointer to SCSI device
3269 static int ufshcd_slave_alloc(struct scsi_device
*sdev
)
3271 struct ufs_hba
*hba
;
3273 hba
= shost_priv(sdev
->host
);
3275 /* Mode sense(6) is not supported by UFS, so use Mode sense(10) */
3276 sdev
->use_10_for_ms
= 1;
3278 /* allow SCSI layer to restart the device in case of errors */
3279 sdev
->allow_restart
= 1;
3281 /* REPORT SUPPORTED OPERATION CODES is not supported */
3282 sdev
->no_report_opcodes
= 1;
3285 ufshcd_set_queue_depth(sdev
);
3287 ufshcd_get_lu_power_on_wp_status(hba
, sdev
);
3293 * ufshcd_change_queue_depth - change queue depth
3294 * @sdev: pointer to SCSI device
3295 * @depth: required depth to set
3297 * Change queue depth and make sure the max. limits are not crossed.
3299 static int ufshcd_change_queue_depth(struct scsi_device
*sdev
, int depth
)
3301 struct ufs_hba
*hba
= shost_priv(sdev
->host
);
3303 if (depth
> hba
->nutrs
)
3305 return scsi_change_queue_depth(sdev
, depth
);
3309 * ufshcd_slave_configure - adjust SCSI device configurations
3310 * @sdev: pointer to SCSI device
3312 static int ufshcd_slave_configure(struct scsi_device
*sdev
)
3314 struct request_queue
*q
= sdev
->request_queue
;
3316 blk_queue_update_dma_pad(q
, PRDT_DATA_BYTE_COUNT_PAD
- 1);
3317 blk_queue_max_segment_size(q
, PRDT_DATA_BYTE_COUNT_MAX
);
3323 * ufshcd_slave_destroy - remove SCSI device configurations
3324 * @sdev: pointer to SCSI device
3326 static void ufshcd_slave_destroy(struct scsi_device
*sdev
)
3328 struct ufs_hba
*hba
;
3330 hba
= shost_priv(sdev
->host
);
3331 /* Drop the reference as it won't be needed anymore */
3332 if (ufshcd_scsi_to_upiu_lun(sdev
->lun
) == UFS_UPIU_UFS_DEVICE_WLUN
) {
3333 unsigned long flags
;
3335 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
3336 hba
->sdev_ufs_device
= NULL
;
3337 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
3342 * ufshcd_task_req_compl - handle task management request completion
3343 * @hba: per adapter instance
3344 * @index: index of the completed request
3345 * @resp: task management service response
3347 * Returns non-zero value on error, zero on success
3349 static int ufshcd_task_req_compl(struct ufs_hba
*hba
, u32 index
, u8
*resp
)
3351 struct utp_task_req_desc
*task_req_descp
;
3352 struct utp_upiu_task_rsp
*task_rsp_upiup
;
3353 unsigned long flags
;
3357 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
3359 /* Clear completed tasks from outstanding_tasks */
3360 __clear_bit(index
, &hba
->outstanding_tasks
);
3362 task_req_descp
= hba
->utmrdl_base_addr
;
3363 ocs_value
= ufshcd_get_tmr_ocs(&task_req_descp
[index
]);
3365 if (ocs_value
== OCS_SUCCESS
) {
3366 task_rsp_upiup
= (struct utp_upiu_task_rsp
*)
3367 task_req_descp
[index
].task_rsp_upiu
;
3368 task_result
= be32_to_cpu(task_rsp_upiup
->header
.dword_1
);
3369 task_result
= ((task_result
& MASK_TASK_RESPONSE
) >> 8);
3371 *resp
= (u8
)task_result
;
3373 dev_err(hba
->dev
, "%s: failed, ocs = 0x%x\n",
3374 __func__
, ocs_value
);
3376 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
3382 * ufshcd_scsi_cmd_status - Update SCSI command result based on SCSI status
3383 * @lrb: pointer to local reference block of completed command
3384 * @scsi_status: SCSI command status
3386 * Returns value base on SCSI command status
3389 ufshcd_scsi_cmd_status(struct ufshcd_lrb
*lrbp
, int scsi_status
)
3393 switch (scsi_status
) {
3394 case SAM_STAT_CHECK_CONDITION
:
3395 ufshcd_copy_sense_data(lrbp
);
3397 result
|= DID_OK
<< 16 |
3398 COMMAND_COMPLETE
<< 8 |
3401 case SAM_STAT_TASK_SET_FULL
:
3403 case SAM_STAT_TASK_ABORTED
:
3404 ufshcd_copy_sense_data(lrbp
);
3405 result
|= scsi_status
;
3408 result
|= DID_ERROR
<< 16;
3410 } /* end of switch */
3416 * ufshcd_transfer_rsp_status - Get overall status of the response
3417 * @hba: per adapter instance
3418 * @lrb: pointer to local reference block of completed command
3420 * Returns result of the command to notify SCSI midlayer
3423 ufshcd_transfer_rsp_status(struct ufs_hba
*hba
, struct ufshcd_lrb
*lrbp
)
3429 /* overall command status of utrd */
3430 ocs
= ufshcd_get_tr_ocs(lrbp
);
3434 result
= ufshcd_get_req_rsp(lrbp
->ucd_rsp_ptr
);
3437 case UPIU_TRANSACTION_RESPONSE
:
3439 * get the response UPIU result to extract
3440 * the SCSI command status
3442 result
= ufshcd_get_rsp_upiu_result(lrbp
->ucd_rsp_ptr
);
3445 * get the result based on SCSI status response
3446 * to notify the SCSI midlayer of the command status
3448 scsi_status
= result
& MASK_SCSI_STATUS
;
3449 result
= ufshcd_scsi_cmd_status(lrbp
, scsi_status
);
3452 * Currently we are only supporting BKOPs exception
3453 * events hence we can ignore BKOPs exception event
3454 * during power management callbacks. BKOPs exception
3455 * event is not expected to be raised in runtime suspend
3456 * callback as it allows the urgent bkops.
3457 * During system suspend, we are anyway forcefully
3458 * disabling the bkops and if urgent bkops is needed
3459 * it will be enabled on system resume. Long term
3460 * solution could be to abort the system suspend if
3461 * UFS device needs urgent BKOPs.
3463 if (!hba
->pm_op_in_progress
&&
3464 ufshcd_is_exception_event(lrbp
->ucd_rsp_ptr
))
3465 schedule_work(&hba
->eeh_work
);
3467 case UPIU_TRANSACTION_REJECT_UPIU
:
3468 /* TODO: handle Reject UPIU Response */
3469 result
= DID_ERROR
<< 16;
3471 "Reject UPIU not fully implemented\n");
3474 result
= DID_ERROR
<< 16;
3476 "Unexpected request response code = %x\n",
3482 result
|= DID_ABORT
<< 16;
3484 case OCS_INVALID_COMMAND_STATUS
:
3485 result
|= DID_REQUEUE
<< 16;
3487 case OCS_INVALID_CMD_TABLE_ATTR
:
3488 case OCS_INVALID_PRDT_ATTR
:
3489 case OCS_MISMATCH_DATA_BUF_SIZE
:
3490 case OCS_MISMATCH_RESP_UPIU_SIZE
:
3491 case OCS_PEER_COMM_FAILURE
:
3492 case OCS_FATAL_ERROR
:
3494 result
|= DID_ERROR
<< 16;
3496 "OCS error from controller = %x\n", ocs
);
3498 } /* end of switch */
3504 * ufshcd_uic_cmd_compl - handle completion of uic command
3505 * @hba: per adapter instance
3506 * @intr_status: interrupt status generated by the controller
3508 static void ufshcd_uic_cmd_compl(struct ufs_hba
*hba
, u32 intr_status
)
3510 if ((intr_status
& UIC_COMMAND_COMPL
) && hba
->active_uic_cmd
) {
3511 hba
->active_uic_cmd
->argument2
|=
3512 ufshcd_get_uic_cmd_result(hba
);
3513 hba
->active_uic_cmd
->argument3
=
3514 ufshcd_get_dme_attr_val(hba
);
3515 complete(&hba
->active_uic_cmd
->done
);
3518 if ((intr_status
& UFSHCD_UIC_PWR_MASK
) && hba
->uic_async_done
)
3519 complete(hba
->uic_async_done
);
3523 * __ufshcd_transfer_req_compl - handle SCSI and query command completion
3524 * @hba: per adapter instance
3525 * @completed_reqs: requests to complete
3527 static void __ufshcd_transfer_req_compl(struct ufs_hba
*hba
,
3528 unsigned long completed_reqs
)
3530 struct ufshcd_lrb
*lrbp
;
3531 struct scsi_cmnd
*cmd
;
3535 for_each_set_bit(index
, &completed_reqs
, hba
->nutrs
) {
3536 lrbp
= &hba
->lrb
[index
];
3539 result
= ufshcd_transfer_rsp_status(hba
, lrbp
);
3540 scsi_dma_unmap(cmd
);
3541 cmd
->result
= result
;
3542 /* Mark completed command as NULL in LRB */
3544 clear_bit_unlock(index
, &hba
->lrb_in_use
);
3545 /* Do not touch lrbp after scsi done */
3546 cmd
->scsi_done(cmd
);
3547 __ufshcd_release(hba
);
3548 } else if (lrbp
->command_type
== UTP_CMD_TYPE_DEV_MANAGE
||
3549 lrbp
->command_type
== UTP_CMD_TYPE_UFS_STORAGE
) {
3550 if (hba
->dev_cmd
.complete
)
3551 complete(hba
->dev_cmd
.complete
);
3555 /* clear corresponding bits of completed commands */
3556 hba
->outstanding_reqs
^= completed_reqs
;
3558 ufshcd_clk_scaling_update_busy(hba
);
3560 /* we might have free'd some tags above */
3561 wake_up(&hba
->dev_cmd
.tag_wq
);
3565 * ufshcd_transfer_req_compl - handle SCSI and query command completion
3566 * @hba: per adapter instance
3568 static void ufshcd_transfer_req_compl(struct ufs_hba
*hba
)
3570 unsigned long completed_reqs
;
3573 /* Resetting interrupt aggregation counters first and reading the
3574 * DOOR_BELL afterward allows us to handle all the completed requests.
3575 * In order to prevent other interrupts starvation the DB is read once
3576 * after reset. The down side of this solution is the possibility of
3577 * false interrupt if device completes another request after resetting
3578 * aggregation and before reading the DB.
3580 if (ufshcd_is_intr_aggr_allowed(hba
))
3581 ufshcd_reset_intr_aggr(hba
);
3583 tr_doorbell
= ufshcd_readl(hba
, REG_UTP_TRANSFER_REQ_DOOR_BELL
);
3584 completed_reqs
= tr_doorbell
^ hba
->outstanding_reqs
;
3586 __ufshcd_transfer_req_compl(hba
, completed_reqs
);
3590 * ufshcd_disable_ee - disable exception event
3591 * @hba: per-adapter instance
3592 * @mask: exception event to disable
3594 * Disables exception event in the device so that the EVENT_ALERT
3597 * Returns zero on success, non-zero error value on failure.
3599 static int ufshcd_disable_ee(struct ufs_hba
*hba
, u16 mask
)
3604 if (!(hba
->ee_ctrl_mask
& mask
))
3607 val
= hba
->ee_ctrl_mask
& ~mask
;
3608 val
&= 0xFFFF; /* 2 bytes */
3609 err
= ufshcd_query_attr_retry(hba
, UPIU_QUERY_OPCODE_WRITE_ATTR
,
3610 QUERY_ATTR_IDN_EE_CONTROL
, 0, 0, &val
);
3612 hba
->ee_ctrl_mask
&= ~mask
;
3618 * ufshcd_enable_ee - enable exception event
3619 * @hba: per-adapter instance
3620 * @mask: exception event to enable
3622 * Enable corresponding exception event in the device to allow
3623 * device to alert host in critical scenarios.
3625 * Returns zero on success, non-zero error value on failure.
3627 static int ufshcd_enable_ee(struct ufs_hba
*hba
, u16 mask
)
3632 if (hba
->ee_ctrl_mask
& mask
)
3635 val
= hba
->ee_ctrl_mask
| mask
;
3636 val
&= 0xFFFF; /* 2 bytes */
3637 err
= ufshcd_query_attr_retry(hba
, UPIU_QUERY_OPCODE_WRITE_ATTR
,
3638 QUERY_ATTR_IDN_EE_CONTROL
, 0, 0, &val
);
3640 hba
->ee_ctrl_mask
|= mask
;
3646 * ufshcd_enable_auto_bkops - Allow device managed BKOPS
3647 * @hba: per-adapter instance
3649 * Allow device to manage background operations on its own. Enabling
3650 * this might lead to inconsistent latencies during normal data transfers
3651 * as the device is allowed to manage its own way of handling background
3654 * Returns zero on success, non-zero on failure.
3656 static int ufshcd_enable_auto_bkops(struct ufs_hba
*hba
)
3660 if (hba
->auto_bkops_enabled
)
3663 err
= ufshcd_query_flag_retry(hba
, UPIU_QUERY_OPCODE_SET_FLAG
,
3664 QUERY_FLAG_IDN_BKOPS_EN
, NULL
);
3666 dev_err(hba
->dev
, "%s: failed to enable bkops %d\n",
3671 hba
->auto_bkops_enabled
= true;
3673 /* No need of URGENT_BKOPS exception from the device */
3674 err
= ufshcd_disable_ee(hba
, MASK_EE_URGENT_BKOPS
);
3676 dev_err(hba
->dev
, "%s: failed to disable exception event %d\n",
3683 * ufshcd_disable_auto_bkops - block device in doing background operations
3684 * @hba: per-adapter instance
3686 * Disabling background operations improves command response latency but
3687 * has drawback of device moving into critical state where the device is
3688 * not-operable. Make sure to call ufshcd_enable_auto_bkops() whenever the
3689 * host is idle so that BKOPS are managed effectively without any negative
3692 * Returns zero on success, non-zero on failure.
3694 static int ufshcd_disable_auto_bkops(struct ufs_hba
*hba
)
3698 if (!hba
->auto_bkops_enabled
)
3702 * If host assisted BKOPs is to be enabled, make sure
3703 * urgent bkops exception is allowed.
3705 err
= ufshcd_enable_ee(hba
, MASK_EE_URGENT_BKOPS
);
3707 dev_err(hba
->dev
, "%s: failed to enable exception event %d\n",
3712 err
= ufshcd_query_flag_retry(hba
, UPIU_QUERY_OPCODE_CLEAR_FLAG
,
3713 QUERY_FLAG_IDN_BKOPS_EN
, NULL
);
3715 dev_err(hba
->dev
, "%s: failed to disable bkops %d\n",
3717 ufshcd_disable_ee(hba
, MASK_EE_URGENT_BKOPS
);
3721 hba
->auto_bkops_enabled
= false;
3727 * ufshcd_force_reset_auto_bkops - force enable of auto bkops
3728 * @hba: per adapter instance
3730 * After a device reset the device may toggle the BKOPS_EN flag
3731 * to default value. The s/w tracking variables should be updated
3732 * as well. Do this by forcing enable of auto bkops.
3734 static void ufshcd_force_reset_auto_bkops(struct ufs_hba
*hba
)
3736 hba
->auto_bkops_enabled
= false;
3737 hba
->ee_ctrl_mask
|= MASK_EE_URGENT_BKOPS
;
3738 ufshcd_enable_auto_bkops(hba
);
3741 static inline int ufshcd_get_bkops_status(struct ufs_hba
*hba
, u32
*status
)
3743 return ufshcd_query_attr_retry(hba
, UPIU_QUERY_OPCODE_READ_ATTR
,
3744 QUERY_ATTR_IDN_BKOPS_STATUS
, 0, 0, status
);
3748 * ufshcd_bkops_ctrl - control the auto bkops based on current bkops status
3749 * @hba: per-adapter instance
3750 * @status: bkops_status value
3752 * Read the bkops_status from the UFS device and Enable fBackgroundOpsEn
3753 * flag in the device to permit background operations if the device
3754 * bkops_status is greater than or equal to "status" argument passed to
3755 * this function, disable otherwise.
3757 * Returns 0 for success, non-zero in case of failure.
3759 * NOTE: Caller of this function can check the "hba->auto_bkops_enabled" flag
3760 * to know whether auto bkops is enabled or disabled after this function
3761 * returns control to it.
3763 static int ufshcd_bkops_ctrl(struct ufs_hba
*hba
,
3764 enum bkops_status status
)
3767 u32 curr_status
= 0;
3769 err
= ufshcd_get_bkops_status(hba
, &curr_status
);
3771 dev_err(hba
->dev
, "%s: failed to get BKOPS status %d\n",
3774 } else if (curr_status
> BKOPS_STATUS_MAX
) {
3775 dev_err(hba
->dev
, "%s: invalid BKOPS status %d\n",
3776 __func__
, curr_status
);
3781 if (curr_status
>= status
)
3782 err
= ufshcd_enable_auto_bkops(hba
);
3784 err
= ufshcd_disable_auto_bkops(hba
);
3790 * ufshcd_urgent_bkops - handle urgent bkops exception event
3791 * @hba: per-adapter instance
3793 * Enable fBackgroundOpsEn flag in the device to permit background
3796 * If BKOPs is enabled, this function returns 0, 1 if the bkops in not enabled
3797 * and negative error value for any other failure.
3799 static int ufshcd_urgent_bkops(struct ufs_hba
*hba
)
3801 return ufshcd_bkops_ctrl(hba
, hba
->urgent_bkops_lvl
);
3804 static inline int ufshcd_get_ee_status(struct ufs_hba
*hba
, u32
*status
)
3806 return ufshcd_query_attr_retry(hba
, UPIU_QUERY_OPCODE_READ_ATTR
,
3807 QUERY_ATTR_IDN_EE_STATUS
, 0, 0, status
);
3810 static void ufshcd_bkops_exception_event_handler(struct ufs_hba
*hba
)
3813 u32 curr_status
= 0;
3815 if (hba
->is_urgent_bkops_lvl_checked
)
3816 goto enable_auto_bkops
;
3818 err
= ufshcd_get_bkops_status(hba
, &curr_status
);
3820 dev_err(hba
->dev
, "%s: failed to get BKOPS status %d\n",
3826 * We are seeing that some devices are raising the urgent bkops
3827 * exception events even when BKOPS status doesn't indicate performace
3828 * impacted or critical. Handle these device by determining their urgent
3829 * bkops status at runtime.
3831 if (curr_status
< BKOPS_STATUS_PERF_IMPACT
) {
3832 dev_err(hba
->dev
, "%s: device raised urgent BKOPS exception for bkops status %d\n",
3833 __func__
, curr_status
);
3834 /* update the current status as the urgent bkops level */
3835 hba
->urgent_bkops_lvl
= curr_status
;
3836 hba
->is_urgent_bkops_lvl_checked
= true;
3840 err
= ufshcd_enable_auto_bkops(hba
);
3843 dev_err(hba
->dev
, "%s: failed to handle urgent bkops %d\n",
3848 * ufshcd_exception_event_handler - handle exceptions raised by device
3849 * @work: pointer to work data
3851 * Read bExceptionEventStatus attribute from the device and handle the
3852 * exception event accordingly.
3854 static void ufshcd_exception_event_handler(struct work_struct
*work
)
3856 struct ufs_hba
*hba
;
3859 hba
= container_of(work
, struct ufs_hba
, eeh_work
);
3861 pm_runtime_get_sync(hba
->dev
);
3862 err
= ufshcd_get_ee_status(hba
, &status
);
3864 dev_err(hba
->dev
, "%s: failed to get exception status %d\n",
3869 status
&= hba
->ee_ctrl_mask
;
3871 if (status
& MASK_EE_URGENT_BKOPS
)
3872 ufshcd_bkops_exception_event_handler(hba
);
3875 pm_runtime_put_sync(hba
->dev
);
3879 /* Complete requests that have door-bell cleared */
3880 static void ufshcd_complete_requests(struct ufs_hba
*hba
)
3882 ufshcd_transfer_req_compl(hba
);
3883 ufshcd_tmc_handler(hba
);
3887 * ufshcd_quirk_dl_nac_errors - This function checks if error handling is
3888 * to recover from the DL NAC errors or not.
3889 * @hba: per-adapter instance
3891 * Returns true if error handling is required, false otherwise
3893 static bool ufshcd_quirk_dl_nac_errors(struct ufs_hba
*hba
)
3895 unsigned long flags
;
3896 bool err_handling
= true;
3898 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
3900 * UFS_DEVICE_QUIRK_RECOVERY_FROM_DL_NAC_ERRORS only workaround the
3901 * device fatal error and/or DL NAC & REPLAY timeout errors.
3903 if (hba
->saved_err
& (CONTROLLER_FATAL_ERROR
| SYSTEM_BUS_FATAL_ERROR
))
3906 if ((hba
->saved_err
& DEVICE_FATAL_ERROR
) ||
3907 ((hba
->saved_err
& UIC_ERROR
) &&
3908 (hba
->saved_uic_err
& UFSHCD_UIC_DL_TCx_REPLAY_ERROR
)))
3911 if ((hba
->saved_err
& UIC_ERROR
) &&
3912 (hba
->saved_uic_err
& UFSHCD_UIC_DL_NAC_RECEIVED_ERROR
)) {
3915 * wait for 50ms to see if we can get any other errors or not.
3917 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
3919 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
3922 * now check if we have got any other severe errors other than
3925 if ((hba
->saved_err
& INT_FATAL_ERRORS
) ||
3926 ((hba
->saved_err
& UIC_ERROR
) &&
3927 (hba
->saved_uic_err
& ~UFSHCD_UIC_DL_NAC_RECEIVED_ERROR
)))
3931 * As DL NAC is the only error received so far, send out NOP
3932 * command to confirm if link is still active or not.
3933 * - If we don't get any response then do error recovery.
3934 * - If we get response then clear the DL NAC error bit.
3937 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
3938 err
= ufshcd_verify_dev_init(hba
);
3939 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
3944 /* Link seems to be alive hence ignore the DL NAC errors */
3945 if (hba
->saved_uic_err
== UFSHCD_UIC_DL_NAC_RECEIVED_ERROR
)
3946 hba
->saved_err
&= ~UIC_ERROR
;
3947 /* clear NAC error */
3948 hba
->saved_uic_err
&= ~UFSHCD_UIC_DL_NAC_RECEIVED_ERROR
;
3949 if (!hba
->saved_uic_err
) {
3950 err_handling
= false;
3955 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
3956 return err_handling
;
3960 * ufshcd_err_handler - handle UFS errors that require s/w attention
3961 * @work: pointer to work structure
3963 static void ufshcd_err_handler(struct work_struct
*work
)
3965 struct ufs_hba
*hba
;
3966 unsigned long flags
;
3971 bool needs_reset
= false;
3973 hba
= container_of(work
, struct ufs_hba
, eh_work
);
3975 pm_runtime_get_sync(hba
->dev
);
3976 ufshcd_hold(hba
, false);
3978 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
3979 if (hba
->ufshcd_state
== UFSHCD_STATE_RESET
)
3982 hba
->ufshcd_state
= UFSHCD_STATE_RESET
;
3983 ufshcd_set_eh_in_progress(hba
);
3985 /* Complete requests that have door-bell cleared by h/w */
3986 ufshcd_complete_requests(hba
);
3988 if (hba
->dev_quirks
& UFS_DEVICE_QUIRK_RECOVERY_FROM_DL_NAC_ERRORS
) {
3991 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
3992 /* release the lock as ufshcd_quirk_dl_nac_errors() may sleep */
3993 ret
= ufshcd_quirk_dl_nac_errors(hba
);
3994 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
3996 goto skip_err_handling
;
3998 if ((hba
->saved_err
& INT_FATAL_ERRORS
) ||
3999 ((hba
->saved_err
& UIC_ERROR
) &&
4000 (hba
->saved_uic_err
& (UFSHCD_UIC_DL_PA_INIT_ERROR
|
4001 UFSHCD_UIC_DL_NAC_RECEIVED_ERROR
|
4002 UFSHCD_UIC_DL_TCx_REPLAY_ERROR
))))
4006 * if host reset is required then skip clearing the pending
4007 * transfers forcefully because they will automatically get
4008 * cleared after link startup.
4011 goto skip_pending_xfer_clear
;
4013 /* release lock as clear command might sleep */
4014 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4015 /* Clear pending transfer requests */
4016 for_each_set_bit(tag
, &hba
->outstanding_reqs
, hba
->nutrs
) {
4017 if (ufshcd_clear_cmd(hba
, tag
)) {
4019 goto lock_skip_pending_xfer_clear
;
4023 /* Clear pending task management requests */
4024 for_each_set_bit(tag
, &hba
->outstanding_tasks
, hba
->nutmrs
) {
4025 if (ufshcd_clear_tm_cmd(hba
, tag
)) {
4027 goto lock_skip_pending_xfer_clear
;
4031 lock_skip_pending_xfer_clear
:
4032 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
4034 /* Complete the requests that are cleared by s/w */
4035 ufshcd_complete_requests(hba
);
4037 if (err_xfer
|| err_tm
)
4040 skip_pending_xfer_clear
:
4041 /* Fatal errors need reset */
4043 unsigned long max_doorbells
= (1UL << hba
->nutrs
) - 1;
4046 * ufshcd_reset_and_restore() does the link reinitialization
4047 * which will need atleast one empty doorbell slot to send the
4048 * device management commands (NOP and query commands).
4049 * If there is no slot empty at this moment then free up last
4052 if (hba
->outstanding_reqs
== max_doorbells
)
4053 __ufshcd_transfer_req_compl(hba
,
4054 (1UL << (hba
->nutrs
- 1)));
4056 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4057 err
= ufshcd_reset_and_restore(hba
);
4058 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
4060 dev_err(hba
->dev
, "%s: reset and restore failed\n",
4062 hba
->ufshcd_state
= UFSHCD_STATE_ERROR
;
4065 * Inform scsi mid-layer that we did reset and allow to handle
4066 * Unit Attention properly.
4068 scsi_report_bus_reset(hba
->host
, 0);
4070 hba
->saved_uic_err
= 0;
4075 hba
->ufshcd_state
= UFSHCD_STATE_OPERATIONAL
;
4076 if (hba
->saved_err
|| hba
->saved_uic_err
)
4077 dev_err_ratelimited(hba
->dev
, "%s: exit: saved_err 0x%x saved_uic_err 0x%x",
4078 __func__
, hba
->saved_err
, hba
->saved_uic_err
);
4081 ufshcd_clear_eh_in_progress(hba
);
4084 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4085 scsi_unblock_requests(hba
->host
);
4086 ufshcd_release(hba
);
4087 pm_runtime_put_sync(hba
->dev
);
4091 * ufshcd_update_uic_error - check and set fatal UIC error flags.
4092 * @hba: per-adapter instance
4094 static void ufshcd_update_uic_error(struct ufs_hba
*hba
)
4098 /* PA_INIT_ERROR is fatal and needs UIC reset */
4099 reg
= ufshcd_readl(hba
, REG_UIC_ERROR_CODE_DATA_LINK_LAYER
);
4100 if (reg
& UIC_DATA_LINK_LAYER_ERROR_PA_INIT
)
4101 hba
->uic_error
|= UFSHCD_UIC_DL_PA_INIT_ERROR
;
4102 else if (hba
->dev_quirks
&
4103 UFS_DEVICE_QUIRK_RECOVERY_FROM_DL_NAC_ERRORS
) {
4104 if (reg
& UIC_DATA_LINK_LAYER_ERROR_NAC_RECEIVED
)
4106 UFSHCD_UIC_DL_NAC_RECEIVED_ERROR
;
4107 else if (reg
& UIC_DATA_LINK_LAYER_ERROR_TCx_REPLAY_TIMEOUT
)
4108 hba
->uic_error
|= UFSHCD_UIC_DL_TCx_REPLAY_ERROR
;
4111 /* UIC NL/TL/DME errors needs software retry */
4112 reg
= ufshcd_readl(hba
, REG_UIC_ERROR_CODE_NETWORK_LAYER
);
4114 hba
->uic_error
|= UFSHCD_UIC_NL_ERROR
;
4116 reg
= ufshcd_readl(hba
, REG_UIC_ERROR_CODE_TRANSPORT_LAYER
);
4118 hba
->uic_error
|= UFSHCD_UIC_TL_ERROR
;
4120 reg
= ufshcd_readl(hba
, REG_UIC_ERROR_CODE_DME
);
4122 hba
->uic_error
|= UFSHCD_UIC_DME_ERROR
;
4124 dev_dbg(hba
->dev
, "%s: UIC error flags = 0x%08x\n",
4125 __func__
, hba
->uic_error
);
4129 * ufshcd_check_errors - Check for errors that need s/w attention
4130 * @hba: per-adapter instance
4132 static void ufshcd_check_errors(struct ufs_hba
*hba
)
4134 bool queue_eh_work
= false;
4136 if (hba
->errors
& INT_FATAL_ERRORS
)
4137 queue_eh_work
= true;
4139 if (hba
->errors
& UIC_ERROR
) {
4141 ufshcd_update_uic_error(hba
);
4143 queue_eh_work
= true;
4146 if (queue_eh_work
) {
4148 * update the transfer error masks to sticky bits, let's do this
4149 * irrespective of current ufshcd_state.
4151 hba
->saved_err
|= hba
->errors
;
4152 hba
->saved_uic_err
|= hba
->uic_error
;
4154 /* handle fatal errors only when link is functional */
4155 if (hba
->ufshcd_state
== UFSHCD_STATE_OPERATIONAL
) {
4156 /* block commands from scsi mid-layer */
4157 scsi_block_requests(hba
->host
);
4159 hba
->ufshcd_state
= UFSHCD_STATE_ERROR
;
4160 schedule_work(&hba
->eh_work
);
4164 * if (!queue_eh_work) -
4165 * Other errors are either non-fatal where host recovers
4166 * itself without s/w intervention or errors that will be
4167 * handled by the SCSI core layer.
4172 * ufshcd_tmc_handler - handle task management function completion
4173 * @hba: per adapter instance
4175 static void ufshcd_tmc_handler(struct ufs_hba
*hba
)
4179 tm_doorbell
= ufshcd_readl(hba
, REG_UTP_TASK_REQ_DOOR_BELL
);
4180 hba
->tm_condition
= tm_doorbell
^ hba
->outstanding_tasks
;
4181 wake_up(&hba
->tm_wq
);
4185 * ufshcd_sl_intr - Interrupt service routine
4186 * @hba: per adapter instance
4187 * @intr_status: contains interrupts generated by the controller
4189 static void ufshcd_sl_intr(struct ufs_hba
*hba
, u32 intr_status
)
4191 hba
->errors
= UFSHCD_ERROR_MASK
& intr_status
;
4193 ufshcd_check_errors(hba
);
4195 if (intr_status
& UFSHCD_UIC_MASK
)
4196 ufshcd_uic_cmd_compl(hba
, intr_status
);
4198 if (intr_status
& UTP_TASK_REQ_COMPL
)
4199 ufshcd_tmc_handler(hba
);
4201 if (intr_status
& UTP_TRANSFER_REQ_COMPL
)
4202 ufshcd_transfer_req_compl(hba
);
4206 * ufshcd_intr - Main interrupt service routine
4208 * @__hba: pointer to adapter instance
4210 * Returns IRQ_HANDLED - If interrupt is valid
4211 * IRQ_NONE - If invalid interrupt
4213 static irqreturn_t
ufshcd_intr(int irq
, void *__hba
)
4215 u32 intr_status
, enabled_intr_status
;
4216 irqreturn_t retval
= IRQ_NONE
;
4217 struct ufs_hba
*hba
= __hba
;
4219 spin_lock(hba
->host
->host_lock
);
4220 intr_status
= ufshcd_readl(hba
, REG_INTERRUPT_STATUS
);
4221 enabled_intr_status
=
4222 intr_status
& ufshcd_readl(hba
, REG_INTERRUPT_ENABLE
);
4225 ufshcd_writel(hba
, intr_status
, REG_INTERRUPT_STATUS
);
4227 if (enabled_intr_status
) {
4228 ufshcd_sl_intr(hba
, enabled_intr_status
);
4229 retval
= IRQ_HANDLED
;
4231 spin_unlock(hba
->host
->host_lock
);
4235 static int ufshcd_clear_tm_cmd(struct ufs_hba
*hba
, int tag
)
4238 u32 mask
= 1 << tag
;
4239 unsigned long flags
;
4241 if (!test_bit(tag
, &hba
->outstanding_tasks
))
4244 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
4245 ufshcd_writel(hba
, ~(1 << tag
), REG_UTP_TASK_REQ_LIST_CLEAR
);
4246 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4248 /* poll for max. 1 sec to clear door bell register by h/w */
4249 err
= ufshcd_wait_for_register(hba
,
4250 REG_UTP_TASK_REQ_DOOR_BELL
,
4251 mask
, 0, 1000, 1000, true);
4257 * ufshcd_issue_tm_cmd - issues task management commands to controller
4258 * @hba: per adapter instance
4259 * @lun_id: LUN ID to which TM command is sent
4260 * @task_id: task ID to which the TM command is applicable
4261 * @tm_function: task management function opcode
4262 * @tm_response: task management service response return value
4264 * Returns non-zero value on error, zero on success.
4266 static int ufshcd_issue_tm_cmd(struct ufs_hba
*hba
, int lun_id
, int task_id
,
4267 u8 tm_function
, u8
*tm_response
)
4269 struct utp_task_req_desc
*task_req_descp
;
4270 struct utp_upiu_task_req
*task_req_upiup
;
4271 struct Scsi_Host
*host
;
4272 unsigned long flags
;
4280 * Get free slot, sleep if slots are unavailable.
4281 * Even though we use wait_event() which sleeps indefinitely,
4282 * the maximum wait time is bounded by %TM_CMD_TIMEOUT.
4284 wait_event(hba
->tm_tag_wq
, ufshcd_get_tm_free_slot(hba
, &free_slot
));
4285 ufshcd_hold(hba
, false);
4287 spin_lock_irqsave(host
->host_lock
, flags
);
4288 task_req_descp
= hba
->utmrdl_base_addr
;
4289 task_req_descp
+= free_slot
;
4291 /* Configure task request descriptor */
4292 task_req_descp
->header
.dword_0
= cpu_to_le32(UTP_REQ_DESC_INT_CMD
);
4293 task_req_descp
->header
.dword_2
=
4294 cpu_to_le32(OCS_INVALID_COMMAND_STATUS
);
4296 /* Configure task request UPIU */
4298 (struct utp_upiu_task_req
*) task_req_descp
->task_req_upiu
;
4299 task_tag
= hba
->nutrs
+ free_slot
;
4300 task_req_upiup
->header
.dword_0
=
4301 UPIU_HEADER_DWORD(UPIU_TRANSACTION_TASK_REQ
, 0,
4303 task_req_upiup
->header
.dword_1
=
4304 UPIU_HEADER_DWORD(0, tm_function
, 0, 0);
4306 * The host shall provide the same value for LUN field in the basic
4307 * header and for Input Parameter.
4309 task_req_upiup
->input_param1
= cpu_to_be32(lun_id
);
4310 task_req_upiup
->input_param2
= cpu_to_be32(task_id
);
4312 /* send command to the controller */
4313 __set_bit(free_slot
, &hba
->outstanding_tasks
);
4315 /* Make sure descriptors are ready before ringing the task doorbell */
4318 ufshcd_writel(hba
, 1 << free_slot
, REG_UTP_TASK_REQ_DOOR_BELL
);
4320 spin_unlock_irqrestore(host
->host_lock
, flags
);
4322 /* wait until the task management command is completed */
4323 err
= wait_event_timeout(hba
->tm_wq
,
4324 test_bit(free_slot
, &hba
->tm_condition
),
4325 msecs_to_jiffies(TM_CMD_TIMEOUT
));
4327 dev_err(hba
->dev
, "%s: task management cmd 0x%.2x timed-out\n",
4328 __func__
, tm_function
);
4329 if (ufshcd_clear_tm_cmd(hba
, free_slot
))
4330 dev_WARN(hba
->dev
, "%s: unable clear tm cmd (slot %d) after timeout\n",
4331 __func__
, free_slot
);
4334 err
= ufshcd_task_req_compl(hba
, free_slot
, tm_response
);
4337 clear_bit(free_slot
, &hba
->tm_condition
);
4338 ufshcd_put_tm_slot(hba
, free_slot
);
4339 wake_up(&hba
->tm_tag_wq
);
4341 ufshcd_release(hba
);
4346 * ufshcd_eh_device_reset_handler - device reset handler registered to
4348 * @cmd: SCSI command pointer
4350 * Returns SUCCESS/FAILED
4352 static int ufshcd_eh_device_reset_handler(struct scsi_cmnd
*cmd
)
4354 struct Scsi_Host
*host
;
4355 struct ufs_hba
*hba
;
4360 struct ufshcd_lrb
*lrbp
;
4361 unsigned long flags
;
4363 host
= cmd
->device
->host
;
4364 hba
= shost_priv(host
);
4365 tag
= cmd
->request
->tag
;
4367 lrbp
= &hba
->lrb
[tag
];
4368 err
= ufshcd_issue_tm_cmd(hba
, lrbp
->lun
, 0, UFS_LOGICAL_RESET
, &resp
);
4369 if (err
|| resp
!= UPIU_TASK_MANAGEMENT_FUNC_COMPL
) {
4375 /* clear the commands that were pending for corresponding LUN */
4376 for_each_set_bit(pos
, &hba
->outstanding_reqs
, hba
->nutrs
) {
4377 if (hba
->lrb
[pos
].lun
== lrbp
->lun
) {
4378 err
= ufshcd_clear_cmd(hba
, pos
);
4383 spin_lock_irqsave(host
->host_lock
, flags
);
4384 ufshcd_transfer_req_compl(hba
);
4385 spin_unlock_irqrestore(host
->host_lock
, flags
);
4390 dev_err(hba
->dev
, "%s: failed with err %d\n", __func__
, err
);
4397 * ufshcd_abort - abort a specific command
4398 * @cmd: SCSI command pointer
4400 * Abort the pending command in device by sending UFS_ABORT_TASK task management
4401 * command, and in host controller by clearing the door-bell register. There can
4402 * be race between controller sending the command to the device while abort is
4403 * issued. To avoid that, first issue UFS_QUERY_TASK to check if the command is
4404 * really issued and then try to abort it.
4406 * Returns SUCCESS/FAILED
4408 static int ufshcd_abort(struct scsi_cmnd
*cmd
)
4410 struct Scsi_Host
*host
;
4411 struct ufs_hba
*hba
;
4412 unsigned long flags
;
4417 struct ufshcd_lrb
*lrbp
;
4420 host
= cmd
->device
->host
;
4421 hba
= shost_priv(host
);
4422 tag
= cmd
->request
->tag
;
4423 if (!ufshcd_valid_tag(hba
, tag
)) {
4425 "%s: invalid command tag %d: cmd=0x%p, cmd->request=0x%p",
4426 __func__
, tag
, cmd
, cmd
->request
);
4430 ufshcd_hold(hba
, false);
4431 reg
= ufshcd_readl(hba
, REG_UTP_TRANSFER_REQ_DOOR_BELL
);
4432 /* If command is already aborted/completed, return SUCCESS */
4433 if (!(test_bit(tag
, &hba
->outstanding_reqs
))) {
4435 "%s: cmd at tag %d already completed, outstanding=0x%lx, doorbell=0x%x\n",
4436 __func__
, tag
, hba
->outstanding_reqs
, reg
);
4440 if (!(reg
& (1 << tag
))) {
4442 "%s: cmd was completed, but without a notifying intr, tag = %d",
4446 lrbp
= &hba
->lrb
[tag
];
4447 for (poll_cnt
= 100; poll_cnt
; poll_cnt
--) {
4448 err
= ufshcd_issue_tm_cmd(hba
, lrbp
->lun
, lrbp
->task_tag
,
4449 UFS_QUERY_TASK
, &resp
);
4450 if (!err
&& resp
== UPIU_TASK_MANAGEMENT_FUNC_SUCCEEDED
) {
4451 /* cmd pending in the device */
4453 } else if (!err
&& resp
== UPIU_TASK_MANAGEMENT_FUNC_COMPL
) {
4455 * cmd not pending in the device, check if it is
4458 reg
= ufshcd_readl(hba
, REG_UTP_TRANSFER_REQ_DOOR_BELL
);
4459 if (reg
& (1 << tag
)) {
4460 /* sleep for max. 200us to stabilize */
4461 usleep_range(100, 200);
4464 /* command completed already */
4468 err
= resp
; /* service response error */
4478 err
= ufshcd_issue_tm_cmd(hba
, lrbp
->lun
, lrbp
->task_tag
,
4479 UFS_ABORT_TASK
, &resp
);
4480 if (err
|| resp
!= UPIU_TASK_MANAGEMENT_FUNC_COMPL
) {
4482 err
= resp
; /* service response error */
4486 err
= ufshcd_clear_cmd(hba
, tag
);
4490 scsi_dma_unmap(cmd
);
4492 spin_lock_irqsave(host
->host_lock
, flags
);
4493 ufshcd_outstanding_req_clear(hba
, tag
);
4494 hba
->lrb
[tag
].cmd
= NULL
;
4495 spin_unlock_irqrestore(host
->host_lock
, flags
);
4497 clear_bit_unlock(tag
, &hba
->lrb_in_use
);
4498 wake_up(&hba
->dev_cmd
.tag_wq
);
4504 dev_err(hba
->dev
, "%s: failed with err %d\n", __func__
, err
);
4509 * This ufshcd_release() corresponds to the original scsi cmd that got
4510 * aborted here (as we won't get any IRQ for it).
4512 ufshcd_release(hba
);
4517 * ufshcd_host_reset_and_restore - reset and restore host controller
4518 * @hba: per-adapter instance
4520 * Note that host controller reset may issue DME_RESET to
4521 * local and remote (device) Uni-Pro stack and the attributes
4522 * are reset to default state.
4524 * Returns zero on success, non-zero on failure
4526 static int ufshcd_host_reset_and_restore(struct ufs_hba
*hba
)
4529 unsigned long flags
;
4531 /* Reset the host controller */
4532 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
4533 ufshcd_hba_stop(hba
, false);
4534 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4536 err
= ufshcd_hba_enable(hba
);
4540 /* Establish the link again and restore the device */
4541 err
= ufshcd_probe_hba(hba
);
4543 if (!err
&& (hba
->ufshcd_state
!= UFSHCD_STATE_OPERATIONAL
))
4547 dev_err(hba
->dev
, "%s: Host init failed %d\n", __func__
, err
);
4553 * ufshcd_reset_and_restore - reset and re-initialize host/device
4554 * @hba: per-adapter instance
4556 * Reset and recover device, host and re-establish link. This
4557 * is helpful to recover the communication in fatal error conditions.
4559 * Returns zero on success, non-zero on failure
4561 static int ufshcd_reset_and_restore(struct ufs_hba
*hba
)
4564 unsigned long flags
;
4565 int retries
= MAX_HOST_RESET_RETRIES
;
4568 err
= ufshcd_host_reset_and_restore(hba
);
4569 } while (err
&& --retries
);
4572 * After reset the door-bell might be cleared, complete
4573 * outstanding requests in s/w here.
4575 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
4576 ufshcd_transfer_req_compl(hba
);
4577 ufshcd_tmc_handler(hba
);
4578 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4584 * ufshcd_eh_host_reset_handler - host reset handler registered to scsi layer
4585 * @cmd - SCSI command pointer
4587 * Returns SUCCESS/FAILED
4589 static int ufshcd_eh_host_reset_handler(struct scsi_cmnd
*cmd
)
4592 unsigned long flags
;
4593 struct ufs_hba
*hba
;
4595 hba
= shost_priv(cmd
->device
->host
);
4597 ufshcd_hold(hba
, false);
4599 * Check if there is any race with fatal error handling.
4600 * If so, wait for it to complete. Even though fatal error
4601 * handling does reset and restore in some cases, don't assume
4602 * anything out of it. We are just avoiding race here.
4605 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
4606 if (!(work_pending(&hba
->eh_work
) ||
4607 hba
->ufshcd_state
== UFSHCD_STATE_RESET
))
4609 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4610 dev_dbg(hba
->dev
, "%s: reset in progress\n", __func__
);
4611 flush_work(&hba
->eh_work
);
4614 hba
->ufshcd_state
= UFSHCD_STATE_RESET
;
4615 ufshcd_set_eh_in_progress(hba
);
4616 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4618 err
= ufshcd_reset_and_restore(hba
);
4620 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
4623 hba
->ufshcd_state
= UFSHCD_STATE_OPERATIONAL
;
4626 hba
->ufshcd_state
= UFSHCD_STATE_ERROR
;
4628 ufshcd_clear_eh_in_progress(hba
);
4629 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4631 ufshcd_release(hba
);
4636 * ufshcd_get_max_icc_level - calculate the ICC level
4637 * @sup_curr_uA: max. current supported by the regulator
4638 * @start_scan: row at the desc table to start scan from
4639 * @buff: power descriptor buffer
4641 * Returns calculated max ICC level for specific regulator
4643 static u32
ufshcd_get_max_icc_level(int sup_curr_uA
, u32 start_scan
, char *buff
)
4650 for (i
= start_scan
; i
>= 0; i
--) {
4651 data
= be16_to_cpu(*((u16
*)(buff
+ 2*i
)));
4652 unit
= (data
& ATTR_ICC_LVL_UNIT_MASK
) >>
4653 ATTR_ICC_LVL_UNIT_OFFSET
;
4654 curr_uA
= data
& ATTR_ICC_LVL_VALUE_MASK
;
4656 case UFSHCD_NANO_AMP
:
4657 curr_uA
= curr_uA
/ 1000;
4659 case UFSHCD_MILI_AMP
:
4660 curr_uA
= curr_uA
* 1000;
4663 curr_uA
= curr_uA
* 1000 * 1000;
4665 case UFSHCD_MICRO_AMP
:
4669 if (sup_curr_uA
>= curr_uA
)
4674 pr_err("%s: Couldn't find valid icc_level = %d", __func__
, i
);
4681 * ufshcd_calc_icc_level - calculate the max ICC level
4682 * In case regulators are not initialized we'll return 0
4683 * @hba: per-adapter instance
4684 * @desc_buf: power descriptor buffer to extract ICC levels from.
4685 * @len: length of desc_buff
4687 * Returns calculated ICC level
4689 static u32
ufshcd_find_max_sup_active_icc_level(struct ufs_hba
*hba
,
4690 u8
*desc_buf
, int len
)
4694 if (!hba
->vreg_info
.vcc
|| !hba
->vreg_info
.vccq
||
4695 !hba
->vreg_info
.vccq2
) {
4697 "%s: Regulator capability was not set, actvIccLevel=%d",
4698 __func__
, icc_level
);
4702 if (hba
->vreg_info
.vcc
)
4703 icc_level
= ufshcd_get_max_icc_level(
4704 hba
->vreg_info
.vcc
->max_uA
,
4705 POWER_DESC_MAX_ACTV_ICC_LVLS
- 1,
4706 &desc_buf
[PWR_DESC_ACTIVE_LVLS_VCC_0
]);
4708 if (hba
->vreg_info
.vccq
)
4709 icc_level
= ufshcd_get_max_icc_level(
4710 hba
->vreg_info
.vccq
->max_uA
,
4712 &desc_buf
[PWR_DESC_ACTIVE_LVLS_VCCQ_0
]);
4714 if (hba
->vreg_info
.vccq2
)
4715 icc_level
= ufshcd_get_max_icc_level(
4716 hba
->vreg_info
.vccq2
->max_uA
,
4718 &desc_buf
[PWR_DESC_ACTIVE_LVLS_VCCQ2_0
]);
4723 static void ufshcd_init_icc_levels(struct ufs_hba
*hba
)
4726 int buff_len
= QUERY_DESC_POWER_MAX_SIZE
;
4727 u8 desc_buf
[QUERY_DESC_POWER_MAX_SIZE
];
4729 ret
= ufshcd_read_power_desc(hba
, desc_buf
, buff_len
);
4732 "%s: Failed reading power descriptor.len = %d ret = %d",
4733 __func__
, buff_len
, ret
);
4737 hba
->init_prefetch_data
.icc_level
=
4738 ufshcd_find_max_sup_active_icc_level(hba
,
4739 desc_buf
, buff_len
);
4740 dev_dbg(hba
->dev
, "%s: setting icc_level 0x%x",
4741 __func__
, hba
->init_prefetch_data
.icc_level
);
4743 ret
= ufshcd_query_attr_retry(hba
, UPIU_QUERY_OPCODE_WRITE_ATTR
,
4744 QUERY_ATTR_IDN_ACTIVE_ICC_LVL
, 0, 0,
4745 &hba
->init_prefetch_data
.icc_level
);
4749 "%s: Failed configuring bActiveICCLevel = %d ret = %d",
4750 __func__
, hba
->init_prefetch_data
.icc_level
, ret
);
4755 * ufshcd_scsi_add_wlus - Adds required W-LUs
4756 * @hba: per-adapter instance
4758 * UFS device specification requires the UFS devices to support 4 well known
4760 * "REPORT_LUNS" (address: 01h)
4761 * "UFS Device" (address: 50h)
4762 * "RPMB" (address: 44h)
4763 * "BOOT" (address: 30h)
4764 * UFS device's power management needs to be controlled by "POWER CONDITION"
4765 * field of SSU (START STOP UNIT) command. But this "power condition" field
4766 * will take effect only when its sent to "UFS device" well known logical unit
4767 * hence we require the scsi_device instance to represent this logical unit in
4768 * order for the UFS host driver to send the SSU command for power management.
4770 * We also require the scsi_device instance for "RPMB" (Replay Protected Memory
4771 * Block) LU so user space process can control this LU. User space may also
4772 * want to have access to BOOT LU.
4774 * This function adds scsi device instances for each of all well known LUs
4775 * (except "REPORT LUNS" LU).
4777 * Returns zero on success (all required W-LUs are added successfully),
4778 * non-zero error value on failure (if failed to add any of the required W-LU).
4780 static int ufshcd_scsi_add_wlus(struct ufs_hba
*hba
)
4783 struct scsi_device
*sdev_rpmb
;
4784 struct scsi_device
*sdev_boot
;
4786 hba
->sdev_ufs_device
= __scsi_add_device(hba
->host
, 0, 0,
4787 ufshcd_upiu_wlun_to_scsi_wlun(UFS_UPIU_UFS_DEVICE_WLUN
), NULL
);
4788 if (IS_ERR(hba
->sdev_ufs_device
)) {
4789 ret
= PTR_ERR(hba
->sdev_ufs_device
);
4790 hba
->sdev_ufs_device
= NULL
;
4793 scsi_device_put(hba
->sdev_ufs_device
);
4795 sdev_boot
= __scsi_add_device(hba
->host
, 0, 0,
4796 ufshcd_upiu_wlun_to_scsi_wlun(UFS_UPIU_BOOT_WLUN
), NULL
);
4797 if (IS_ERR(sdev_boot
)) {
4798 ret
= PTR_ERR(sdev_boot
);
4799 goto remove_sdev_ufs_device
;
4801 scsi_device_put(sdev_boot
);
4803 sdev_rpmb
= __scsi_add_device(hba
->host
, 0, 0,
4804 ufshcd_upiu_wlun_to_scsi_wlun(UFS_UPIU_RPMB_WLUN
), NULL
);
4805 if (IS_ERR(sdev_rpmb
)) {
4806 ret
= PTR_ERR(sdev_rpmb
);
4807 goto remove_sdev_boot
;
4809 scsi_device_put(sdev_rpmb
);
4813 scsi_remove_device(sdev_boot
);
4814 remove_sdev_ufs_device
:
4815 scsi_remove_device(hba
->sdev_ufs_device
);
4820 static int ufs_get_device_info(struct ufs_hba
*hba
,
4821 struct ufs_device_info
*card_data
)
4825 u8 str_desc_buf
[QUERY_DESC_STRING_MAX_SIZE
+ 1] = {0};
4826 u8 desc_buf
[QUERY_DESC_DEVICE_MAX_SIZE
];
4828 err
= ufshcd_read_device_desc(hba
, desc_buf
,
4829 QUERY_DESC_DEVICE_MAX_SIZE
);
4831 dev_err(hba
->dev
, "%s: Failed reading Device Desc. err = %d\n",
4837 * getting vendor (manufacturerID) and Bank Index in big endian
4840 card_data
->wmanufacturerid
= desc_buf
[DEVICE_DESC_PARAM_MANF_ID
] << 8 |
4841 desc_buf
[DEVICE_DESC_PARAM_MANF_ID
+ 1];
4843 model_index
= desc_buf
[DEVICE_DESC_PARAM_PRDCT_NAME
];
4845 err
= ufshcd_read_string_desc(hba
, model_index
, str_desc_buf
,
4846 QUERY_DESC_STRING_MAX_SIZE
, ASCII_STD
);
4848 dev_err(hba
->dev
, "%s: Failed reading Product Name. err = %d\n",
4853 str_desc_buf
[QUERY_DESC_STRING_MAX_SIZE
] = '\0';
4854 strlcpy(card_data
->model
, (str_desc_buf
+ QUERY_DESC_HDR_SIZE
),
4855 min_t(u8
, str_desc_buf
[QUERY_DESC_LENGTH_OFFSET
],
4858 /* Null terminate the model string */
4859 card_data
->model
[MAX_MODEL_LEN
] = '\0';
4865 void ufs_advertise_fixup_device(struct ufs_hba
*hba
)
4868 struct ufs_dev_fix
*f
;
4869 struct ufs_device_info card_data
;
4871 card_data
.wmanufacturerid
= 0;
4873 err
= ufs_get_device_info(hba
, &card_data
);
4875 dev_err(hba
->dev
, "%s: Failed getting device info. err = %d\n",
4880 for (f
= ufs_fixups
; f
->quirk
; f
++) {
4881 if (((f
->card
.wmanufacturerid
== card_data
.wmanufacturerid
) ||
4882 (f
->card
.wmanufacturerid
== UFS_ANY_VENDOR
)) &&
4883 (STR_PRFX_EQUAL(f
->card
.model
, card_data
.model
) ||
4884 !strcmp(f
->card
.model
, UFS_ANY_MODEL
)))
4885 hba
->dev_quirks
|= f
->quirk
;
4890 * ufshcd_tune_pa_tactivate - Tunes PA_TActivate of local UniPro
4891 * @hba: per-adapter instance
4893 * PA_TActivate parameter can be tuned manually if UniPro version is less than
4894 * 1.61. PA_TActivate needs to be greater than or equal to peerM-PHY's
4895 * RX_MIN_ACTIVATETIME_CAPABILITY attribute. This optimal value can help reduce
4896 * the hibern8 exit latency.
4898 * Returns zero on success, non-zero error value on failure.
4900 static int ufshcd_tune_pa_tactivate(struct ufs_hba
*hba
)
4903 u32 peer_rx_min_activatetime
= 0, tuned_pa_tactivate
;
4905 ret
= ufshcd_dme_peer_get(hba
,
4907 RX_MIN_ACTIVATETIME_CAPABILITY
,
4908 UIC_ARG_MPHY_RX_GEN_SEL_INDEX(0)),
4909 &peer_rx_min_activatetime
);
4913 /* make sure proper unit conversion is applied */
4914 tuned_pa_tactivate
=
4915 ((peer_rx_min_activatetime
* RX_MIN_ACTIVATETIME_UNIT_US
)
4916 / PA_TACTIVATE_TIME_UNIT_US
);
4917 ret
= ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_TACTIVATE
),
4918 tuned_pa_tactivate
);
4925 * ufshcd_tune_pa_hibern8time - Tunes PA_Hibern8Time of local UniPro
4926 * @hba: per-adapter instance
4928 * PA_Hibern8Time parameter can be tuned manually if UniPro version is less than
4929 * 1.61. PA_Hibern8Time needs to be maximum of local M-PHY's
4930 * TX_HIBERN8TIME_CAPABILITY & peer M-PHY's RX_HIBERN8TIME_CAPABILITY.
4931 * This optimal value can help reduce the hibern8 exit latency.
4933 * Returns zero on success, non-zero error value on failure.
4935 static int ufshcd_tune_pa_hibern8time(struct ufs_hba
*hba
)
4938 u32 local_tx_hibern8_time_cap
= 0, peer_rx_hibern8_time_cap
= 0;
4939 u32 max_hibern8_time
, tuned_pa_hibern8time
;
4941 ret
= ufshcd_dme_get(hba
,
4942 UIC_ARG_MIB_SEL(TX_HIBERN8TIME_CAPABILITY
,
4943 UIC_ARG_MPHY_TX_GEN_SEL_INDEX(0)),
4944 &local_tx_hibern8_time_cap
);
4948 ret
= ufshcd_dme_peer_get(hba
,
4949 UIC_ARG_MIB_SEL(RX_HIBERN8TIME_CAPABILITY
,
4950 UIC_ARG_MPHY_RX_GEN_SEL_INDEX(0)),
4951 &peer_rx_hibern8_time_cap
);
4955 max_hibern8_time
= max(local_tx_hibern8_time_cap
,
4956 peer_rx_hibern8_time_cap
);
4957 /* make sure proper unit conversion is applied */
4958 tuned_pa_hibern8time
= ((max_hibern8_time
* HIBERN8TIME_UNIT_US
)
4959 / PA_HIBERN8_TIME_UNIT_US
);
4960 ret
= ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_HIBERN8TIME
),
4961 tuned_pa_hibern8time
);
4966 static void ufshcd_tune_unipro_params(struct ufs_hba
*hba
)
4968 if (ufshcd_is_unipro_pa_params_tuning_req(hba
)) {
4969 ufshcd_tune_pa_tactivate(hba
);
4970 ufshcd_tune_pa_hibern8time(hba
);
4973 if (hba
->dev_quirks
& UFS_DEVICE_QUIRK_PA_TACTIVATE
)
4974 /* set 1ms timeout for PA_TACTIVATE */
4975 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_TACTIVATE
), 10);
4979 * ufshcd_probe_hba - probe hba to detect device and initialize
4980 * @hba: per-adapter instance
4982 * Execute link-startup and verify device initialization
4984 static int ufshcd_probe_hba(struct ufs_hba
*hba
)
4988 ret
= ufshcd_link_startup(hba
);
4992 ufshcd_init_pwr_info(hba
);
4994 /* set the default level for urgent bkops */
4995 hba
->urgent_bkops_lvl
= BKOPS_STATUS_PERF_IMPACT
;
4996 hba
->is_urgent_bkops_lvl_checked
= false;
4998 /* UniPro link is active now */
4999 ufshcd_set_link_active(hba
);
5001 ret
= ufshcd_verify_dev_init(hba
);
5005 ret
= ufshcd_complete_dev_init(hba
);
5009 ufs_advertise_fixup_device(hba
);
5010 ufshcd_tune_unipro_params(hba
);
5012 ret
= ufshcd_set_vccq_rail_unused(hba
,
5013 (hba
->dev_quirks
& UFS_DEVICE_NO_VCCQ
) ? true : false);
5017 /* UFS device is also active now */
5018 ufshcd_set_ufs_dev_active(hba
);
5019 ufshcd_force_reset_auto_bkops(hba
);
5020 hba
->wlun_dev_clr_ua
= true;
5022 if (ufshcd_get_max_pwr_mode(hba
)) {
5024 "%s: Failed getting max supported power mode\n",
5027 ret
= ufshcd_config_pwr_mode(hba
, &hba
->max_pwr_info
.info
);
5029 dev_err(hba
->dev
, "%s: Failed setting power mode, err = %d\n",
5033 /* set the state as operational after switching to desired gear */
5034 hba
->ufshcd_state
= UFSHCD_STATE_OPERATIONAL
;
5036 * If we are in error handling context or in power management callbacks
5037 * context, no need to scan the host
5039 if (!ufshcd_eh_in_progress(hba
) && !hba
->pm_op_in_progress
) {
5042 /* clear any previous UFS device information */
5043 memset(&hba
->dev_info
, 0, sizeof(hba
->dev_info
));
5044 if (!ufshcd_query_flag_retry(hba
, UPIU_QUERY_OPCODE_READ_FLAG
,
5045 QUERY_FLAG_IDN_PWR_ON_WPE
, &flag
))
5046 hba
->dev_info
.f_power_on_wp_en
= flag
;
5048 if (!hba
->is_init_prefetch
)
5049 ufshcd_init_icc_levels(hba
);
5051 /* Add required well known logical units to scsi mid layer */
5052 if (ufshcd_scsi_add_wlus(hba
))
5055 scsi_scan_host(hba
->host
);
5056 pm_runtime_put_sync(hba
->dev
);
5059 if (!hba
->is_init_prefetch
)
5060 hba
->is_init_prefetch
= true;
5062 /* Resume devfreq after UFS device is detected */
5063 if (ufshcd_is_clkscaling_enabled(hba
))
5064 devfreq_resume_device(hba
->devfreq
);
5068 * If we failed to initialize the device or the device is not
5069 * present, turn off the power/clocks etc.
5071 if (ret
&& !ufshcd_eh_in_progress(hba
) && !hba
->pm_op_in_progress
) {
5072 pm_runtime_put_sync(hba
->dev
);
5073 ufshcd_hba_exit(hba
);
5080 * ufshcd_async_scan - asynchronous execution for probing hba
5081 * @data: data pointer to pass to this function
5082 * @cookie: cookie data
5084 static void ufshcd_async_scan(void *data
, async_cookie_t cookie
)
5086 struct ufs_hba
*hba
= (struct ufs_hba
*)data
;
5088 ufshcd_probe_hba(hba
);
5091 static enum blk_eh_timer_return
ufshcd_eh_timed_out(struct scsi_cmnd
*scmd
)
5093 unsigned long flags
;
5094 struct Scsi_Host
*host
;
5095 struct ufs_hba
*hba
;
5099 if (!scmd
|| !scmd
->device
|| !scmd
->device
->host
)
5100 return BLK_EH_NOT_HANDLED
;
5102 host
= scmd
->device
->host
;
5103 hba
= shost_priv(host
);
5105 return BLK_EH_NOT_HANDLED
;
5107 spin_lock_irqsave(host
->host_lock
, flags
);
5109 for_each_set_bit(index
, &hba
->outstanding_reqs
, hba
->nutrs
) {
5110 if (hba
->lrb
[index
].cmd
== scmd
) {
5116 spin_unlock_irqrestore(host
->host_lock
, flags
);
5119 * Bypass SCSI error handling and reset the block layer timer if this
5120 * SCSI command was not actually dispatched to UFS driver, otherwise
5121 * let SCSI layer handle the error as usual.
5123 return found
? BLK_EH_NOT_HANDLED
: BLK_EH_RESET_TIMER
;
5126 static struct scsi_host_template ufshcd_driver_template
= {
5127 .module
= THIS_MODULE
,
5129 .proc_name
= UFSHCD
,
5130 .queuecommand
= ufshcd_queuecommand
,
5131 .slave_alloc
= ufshcd_slave_alloc
,
5132 .slave_configure
= ufshcd_slave_configure
,
5133 .slave_destroy
= ufshcd_slave_destroy
,
5134 .change_queue_depth
= ufshcd_change_queue_depth
,
5135 .eh_abort_handler
= ufshcd_abort
,
5136 .eh_device_reset_handler
= ufshcd_eh_device_reset_handler
,
5137 .eh_host_reset_handler
= ufshcd_eh_host_reset_handler
,
5138 .eh_timed_out
= ufshcd_eh_timed_out
,
5140 .sg_tablesize
= SG_ALL
,
5141 .cmd_per_lun
= UFSHCD_CMD_PER_LUN
,
5142 .can_queue
= UFSHCD_CAN_QUEUE
,
5143 .max_host_blocked
= 1,
5144 .track_queue_depth
= 1,
5147 static int ufshcd_config_vreg_load(struct device
*dev
, struct ufs_vreg
*vreg
,
5155 ret
= regulator_set_load(vreg
->reg
, ua
);
5157 dev_err(dev
, "%s: %s set load (ua=%d) failed, err=%d\n",
5158 __func__
, vreg
->name
, ua
, ret
);
5164 static inline int ufshcd_config_vreg_lpm(struct ufs_hba
*hba
,
5165 struct ufs_vreg
*vreg
)
5169 else if (vreg
->unused
)
5172 return ufshcd_config_vreg_load(hba
->dev
, vreg
,
5173 UFS_VREG_LPM_LOAD_UA
);
5176 static inline int ufshcd_config_vreg_hpm(struct ufs_hba
*hba
,
5177 struct ufs_vreg
*vreg
)
5181 else if (vreg
->unused
)
5184 return ufshcd_config_vreg_load(hba
->dev
, vreg
, vreg
->max_uA
);
5187 static int ufshcd_config_vreg(struct device
*dev
,
5188 struct ufs_vreg
*vreg
, bool on
)
5191 struct regulator
*reg
= vreg
->reg
;
5192 const char *name
= vreg
->name
;
5193 int min_uV
, uA_load
;
5197 if (regulator_count_voltages(reg
) > 0) {
5198 min_uV
= on
? vreg
->min_uV
: 0;
5199 ret
= regulator_set_voltage(reg
, min_uV
, vreg
->max_uV
);
5201 dev_err(dev
, "%s: %s set voltage failed, err=%d\n",
5202 __func__
, name
, ret
);
5206 uA_load
= on
? vreg
->max_uA
: 0;
5207 ret
= ufshcd_config_vreg_load(dev
, vreg
, uA_load
);
5215 static int ufshcd_enable_vreg(struct device
*dev
, struct ufs_vreg
*vreg
)
5221 else if (vreg
->enabled
|| vreg
->unused
)
5224 ret
= ufshcd_config_vreg(dev
, vreg
, true);
5226 ret
= regulator_enable(vreg
->reg
);
5229 vreg
->enabled
= true;
5231 dev_err(dev
, "%s: %s enable failed, err=%d\n",
5232 __func__
, vreg
->name
, ret
);
5237 static int ufshcd_disable_vreg(struct device
*dev
, struct ufs_vreg
*vreg
)
5243 else if (!vreg
->enabled
|| vreg
->unused
)
5246 ret
= regulator_disable(vreg
->reg
);
5249 /* ignore errors on applying disable config */
5250 ufshcd_config_vreg(dev
, vreg
, false);
5251 vreg
->enabled
= false;
5253 dev_err(dev
, "%s: %s disable failed, err=%d\n",
5254 __func__
, vreg
->name
, ret
);
5260 static int ufshcd_setup_vreg(struct ufs_hba
*hba
, bool on
)
5263 struct device
*dev
= hba
->dev
;
5264 struct ufs_vreg_info
*info
= &hba
->vreg_info
;
5269 ret
= ufshcd_toggle_vreg(dev
, info
->vcc
, on
);
5273 ret
= ufshcd_toggle_vreg(dev
, info
->vccq
, on
);
5277 ret
= ufshcd_toggle_vreg(dev
, info
->vccq2
, on
);
5283 ufshcd_toggle_vreg(dev
, info
->vccq2
, false);
5284 ufshcd_toggle_vreg(dev
, info
->vccq
, false);
5285 ufshcd_toggle_vreg(dev
, info
->vcc
, false);
5290 static int ufshcd_setup_hba_vreg(struct ufs_hba
*hba
, bool on
)
5292 struct ufs_vreg_info
*info
= &hba
->vreg_info
;
5295 return ufshcd_toggle_vreg(hba
->dev
, info
->vdd_hba
, on
);
5300 static int ufshcd_get_vreg(struct device
*dev
, struct ufs_vreg
*vreg
)
5307 vreg
->reg
= devm_regulator_get(dev
, vreg
->name
);
5308 if (IS_ERR(vreg
->reg
)) {
5309 ret
= PTR_ERR(vreg
->reg
);
5310 dev_err(dev
, "%s: %s get failed, err=%d\n",
5311 __func__
, vreg
->name
, ret
);
5317 static int ufshcd_init_vreg(struct ufs_hba
*hba
)
5320 struct device
*dev
= hba
->dev
;
5321 struct ufs_vreg_info
*info
= &hba
->vreg_info
;
5326 ret
= ufshcd_get_vreg(dev
, info
->vcc
);
5330 ret
= ufshcd_get_vreg(dev
, info
->vccq
);
5334 ret
= ufshcd_get_vreg(dev
, info
->vccq2
);
5339 static int ufshcd_init_hba_vreg(struct ufs_hba
*hba
)
5341 struct ufs_vreg_info
*info
= &hba
->vreg_info
;
5344 return ufshcd_get_vreg(hba
->dev
, info
->vdd_hba
);
5349 static int ufshcd_set_vccq_rail_unused(struct ufs_hba
*hba
, bool unused
)
5352 struct ufs_vreg_info
*info
= &hba
->vreg_info
;
5356 else if (!info
->vccq
)
5360 /* shut off the rail here */
5361 ret
= ufshcd_toggle_vreg(hba
->dev
, info
->vccq
, false);
5363 * Mark this rail as no longer used, so it doesn't get enabled
5367 info
->vccq
->unused
= true;
5370 * rail should have been already enabled hence just make sure
5371 * that unused flag is cleared.
5373 info
->vccq
->unused
= false;
5379 static int __ufshcd_setup_clocks(struct ufs_hba
*hba
, bool on
,
5383 struct ufs_clk_info
*clki
;
5384 struct list_head
*head
= &hba
->clk_list_head
;
5385 unsigned long flags
;
5387 if (!head
|| list_empty(head
))
5390 list_for_each_entry(clki
, head
, list
) {
5391 if (!IS_ERR_OR_NULL(clki
->clk
)) {
5392 if (skip_ref_clk
&& !strcmp(clki
->name
, "ref_clk"))
5395 if (on
&& !clki
->enabled
) {
5396 ret
= clk_prepare_enable(clki
->clk
);
5398 dev_err(hba
->dev
, "%s: %s prepare enable failed, %d\n",
5399 __func__
, clki
->name
, ret
);
5402 } else if (!on
&& clki
->enabled
) {
5403 clk_disable_unprepare(clki
->clk
);
5406 dev_dbg(hba
->dev
, "%s: clk: %s %sabled\n", __func__
,
5407 clki
->name
, on
? "en" : "dis");
5411 ret
= ufshcd_vops_setup_clocks(hba
, on
);
5414 list_for_each_entry(clki
, head
, list
) {
5415 if (!IS_ERR_OR_NULL(clki
->clk
) && clki
->enabled
)
5416 clk_disable_unprepare(clki
->clk
);
5419 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
5420 hba
->clk_gating
.state
= CLKS_ON
;
5421 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
5426 static int ufshcd_setup_clocks(struct ufs_hba
*hba
, bool on
)
5428 return __ufshcd_setup_clocks(hba
, on
, false);
5431 static int ufshcd_init_clocks(struct ufs_hba
*hba
)
5434 struct ufs_clk_info
*clki
;
5435 struct device
*dev
= hba
->dev
;
5436 struct list_head
*head
= &hba
->clk_list_head
;
5438 if (!head
|| list_empty(head
))
5441 list_for_each_entry(clki
, head
, list
) {
5445 clki
->clk
= devm_clk_get(dev
, clki
->name
);
5446 if (IS_ERR(clki
->clk
)) {
5447 ret
= PTR_ERR(clki
->clk
);
5448 dev_err(dev
, "%s: %s clk get failed, %d\n",
5449 __func__
, clki
->name
, ret
);
5453 if (clki
->max_freq
) {
5454 ret
= clk_set_rate(clki
->clk
, clki
->max_freq
);
5456 dev_err(hba
->dev
, "%s: %s clk set rate(%dHz) failed, %d\n",
5457 __func__
, clki
->name
,
5458 clki
->max_freq
, ret
);
5461 clki
->curr_freq
= clki
->max_freq
;
5463 dev_dbg(dev
, "%s: clk: %s, rate: %lu\n", __func__
,
5464 clki
->name
, clk_get_rate(clki
->clk
));
5470 static int ufshcd_variant_hba_init(struct ufs_hba
*hba
)
5477 err
= ufshcd_vops_init(hba
);
5481 err
= ufshcd_vops_setup_regulators(hba
, true);
5488 ufshcd_vops_exit(hba
);
5491 dev_err(hba
->dev
, "%s: variant %s init failed err %d\n",
5492 __func__
, ufshcd_get_var_name(hba
), err
);
5496 static void ufshcd_variant_hba_exit(struct ufs_hba
*hba
)
5501 ufshcd_vops_setup_clocks(hba
, false);
5503 ufshcd_vops_setup_regulators(hba
, false);
5505 ufshcd_vops_exit(hba
);
5508 static int ufshcd_hba_init(struct ufs_hba
*hba
)
5513 * Handle host controller power separately from the UFS device power
5514 * rails as it will help controlling the UFS host controller power
5515 * collapse easily which is different than UFS device power collapse.
5516 * Also, enable the host controller power before we go ahead with rest
5517 * of the initialization here.
5519 err
= ufshcd_init_hba_vreg(hba
);
5523 err
= ufshcd_setup_hba_vreg(hba
, true);
5527 err
= ufshcd_init_clocks(hba
);
5529 goto out_disable_hba_vreg
;
5531 err
= ufshcd_setup_clocks(hba
, true);
5533 goto out_disable_hba_vreg
;
5535 err
= ufshcd_init_vreg(hba
);
5537 goto out_disable_clks
;
5539 err
= ufshcd_setup_vreg(hba
, true);
5541 goto out_disable_clks
;
5543 err
= ufshcd_variant_hba_init(hba
);
5545 goto out_disable_vreg
;
5547 hba
->is_powered
= true;
5551 ufshcd_setup_vreg(hba
, false);
5553 ufshcd_setup_clocks(hba
, false);
5554 out_disable_hba_vreg
:
5555 ufshcd_setup_hba_vreg(hba
, false);
5560 static void ufshcd_hba_exit(struct ufs_hba
*hba
)
5562 if (hba
->is_powered
) {
5563 ufshcd_variant_hba_exit(hba
);
5564 ufshcd_setup_vreg(hba
, false);
5565 ufshcd_setup_clocks(hba
, false);
5566 ufshcd_setup_hba_vreg(hba
, false);
5567 hba
->is_powered
= false;
5572 ufshcd_send_request_sense(struct ufs_hba
*hba
, struct scsi_device
*sdp
)
5574 unsigned char cmd
[6] = {REQUEST_SENSE
,
5578 SCSI_SENSE_BUFFERSIZE
,
5583 buffer
= kzalloc(SCSI_SENSE_BUFFERSIZE
, GFP_KERNEL
);
5589 ret
= scsi_execute_req_flags(sdp
, cmd
, DMA_FROM_DEVICE
, buffer
,
5590 SCSI_SENSE_BUFFERSIZE
, NULL
,
5591 msecs_to_jiffies(1000), 3, NULL
, REQ_PM
);
5593 pr_err("%s: failed with err %d\n", __func__
, ret
);
5601 * ufshcd_set_dev_pwr_mode - sends START STOP UNIT command to set device
5603 * @hba: per adapter instance
5604 * @pwr_mode: device power mode to set
5606 * Returns 0 if requested power mode is set successfully
5607 * Returns non-zero if failed to set the requested power mode
5609 static int ufshcd_set_dev_pwr_mode(struct ufs_hba
*hba
,
5610 enum ufs_dev_pwr_mode pwr_mode
)
5612 unsigned char cmd
[6] = { START_STOP
};
5613 struct scsi_sense_hdr sshdr
;
5614 struct scsi_device
*sdp
;
5615 unsigned long flags
;
5618 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
5619 sdp
= hba
->sdev_ufs_device
;
5621 ret
= scsi_device_get(sdp
);
5622 if (!ret
&& !scsi_device_online(sdp
)) {
5624 scsi_device_put(sdp
);
5629 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
5635 * If scsi commands fail, the scsi mid-layer schedules scsi error-
5636 * handling, which would wait for host to be resumed. Since we know
5637 * we are functional while we are here, skip host resume in error
5640 hba
->host
->eh_noresume
= 1;
5641 if (hba
->wlun_dev_clr_ua
) {
5642 ret
= ufshcd_send_request_sense(hba
, sdp
);
5645 /* Unit attention condition is cleared now */
5646 hba
->wlun_dev_clr_ua
= false;
5649 cmd
[4] = pwr_mode
<< 4;
5652 * Current function would be generally called from the power management
5653 * callbacks hence set the REQ_PM flag so that it doesn't resume the
5654 * already suspended childs.
5656 ret
= scsi_execute_req_flags(sdp
, cmd
, DMA_NONE
, NULL
, 0, &sshdr
,
5657 START_STOP_TIMEOUT
, 0, NULL
, REQ_PM
);
5659 sdev_printk(KERN_WARNING
, sdp
,
5660 "START_STOP failed for power mode: %d, result %x\n",
5662 if (driver_byte(ret
) & DRIVER_SENSE
)
5663 scsi_print_sense_hdr(sdp
, NULL
, &sshdr
);
5667 hba
->curr_dev_pwr_mode
= pwr_mode
;
5669 scsi_device_put(sdp
);
5670 hba
->host
->eh_noresume
= 0;
5674 static int ufshcd_link_state_transition(struct ufs_hba
*hba
,
5675 enum uic_link_state req_link_state
,
5676 int check_for_bkops
)
5680 if (req_link_state
== hba
->uic_link_state
)
5683 if (req_link_state
== UIC_LINK_HIBERN8_STATE
) {
5684 ret
= ufshcd_uic_hibern8_enter(hba
);
5686 ufshcd_set_link_hibern8(hba
);
5691 * If autobkops is enabled, link can't be turned off because
5692 * turning off the link would also turn off the device.
5694 else if ((req_link_state
== UIC_LINK_OFF_STATE
) &&
5695 (!check_for_bkops
|| (check_for_bkops
&&
5696 !hba
->auto_bkops_enabled
))) {
5698 * Let's make sure that link is in low power mode, we are doing
5699 * this currently by putting the link in Hibern8. Otherway to
5700 * put the link in low power mode is to send the DME end point
5701 * to device and then send the DME reset command to local
5702 * unipro. But putting the link in hibern8 is much faster.
5704 ret
= ufshcd_uic_hibern8_enter(hba
);
5708 * Change controller state to "reset state" which
5709 * should also put the link in off/reset state
5711 ufshcd_hba_stop(hba
, true);
5713 * TODO: Check if we need any delay to make sure that
5714 * controller is reset
5716 ufshcd_set_link_off(hba
);
5723 static void ufshcd_vreg_set_lpm(struct ufs_hba
*hba
)
5726 * It seems some UFS devices may keep drawing more than sleep current
5727 * (atleast for 500us) from UFS rails (especially from VCCQ rail).
5728 * To avoid this situation, add 2ms delay before putting these UFS
5729 * rails in LPM mode.
5731 if (!ufshcd_is_link_active(hba
) &&
5732 hba
->dev_quirks
& UFS_DEVICE_QUIRK_DELAY_BEFORE_LPM
)
5733 usleep_range(2000, 2100);
5736 * If UFS device is either in UFS_Sleep turn off VCC rail to save some
5739 * If UFS device and link is in OFF state, all power supplies (VCC,
5740 * VCCQ, VCCQ2) can be turned off if power on write protect is not
5741 * required. If UFS link is inactive (Hibern8 or OFF state) and device
5742 * is in sleep state, put VCCQ & VCCQ2 rails in LPM mode.
5744 * Ignore the error returned by ufshcd_toggle_vreg() as device is anyway
5745 * in low power state which would save some power.
5747 if (ufshcd_is_ufs_dev_poweroff(hba
) && ufshcd_is_link_off(hba
) &&
5748 !hba
->dev_info
.is_lu_power_on_wp
) {
5749 ufshcd_setup_vreg(hba
, false);
5750 } else if (!ufshcd_is_ufs_dev_active(hba
)) {
5751 ufshcd_toggle_vreg(hba
->dev
, hba
->vreg_info
.vcc
, false);
5752 if (!ufshcd_is_link_active(hba
)) {
5753 ufshcd_config_vreg_lpm(hba
, hba
->vreg_info
.vccq
);
5754 ufshcd_config_vreg_lpm(hba
, hba
->vreg_info
.vccq2
);
5759 static int ufshcd_vreg_set_hpm(struct ufs_hba
*hba
)
5763 if (ufshcd_is_ufs_dev_poweroff(hba
) && ufshcd_is_link_off(hba
) &&
5764 !hba
->dev_info
.is_lu_power_on_wp
) {
5765 ret
= ufshcd_setup_vreg(hba
, true);
5766 } else if (!ufshcd_is_ufs_dev_active(hba
)) {
5767 ret
= ufshcd_toggle_vreg(hba
->dev
, hba
->vreg_info
.vcc
, true);
5768 if (!ret
&& !ufshcd_is_link_active(hba
)) {
5769 ret
= ufshcd_config_vreg_hpm(hba
, hba
->vreg_info
.vccq
);
5772 ret
= ufshcd_config_vreg_hpm(hba
, hba
->vreg_info
.vccq2
);
5780 ufshcd_config_vreg_lpm(hba
, hba
->vreg_info
.vccq
);
5782 ufshcd_toggle_vreg(hba
->dev
, hba
->vreg_info
.vcc
, false);
5787 static void ufshcd_hba_vreg_set_lpm(struct ufs_hba
*hba
)
5789 if (ufshcd_is_link_off(hba
))
5790 ufshcd_setup_hba_vreg(hba
, false);
5793 static void ufshcd_hba_vreg_set_hpm(struct ufs_hba
*hba
)
5795 if (ufshcd_is_link_off(hba
))
5796 ufshcd_setup_hba_vreg(hba
, true);
5800 * ufshcd_suspend - helper function for suspend operations
5801 * @hba: per adapter instance
5802 * @pm_op: desired low power operation type
5804 * This function will try to put the UFS device and link into low power
5805 * mode based on the "rpm_lvl" (Runtime PM level) or "spm_lvl"
5806 * (System PM level).
5808 * If this function is called during shutdown, it will make sure that
5809 * both UFS device and UFS link is powered off.
5811 * NOTE: UFS device & link must be active before we enter in this function.
5813 * Returns 0 for success and non-zero for failure
5815 static int ufshcd_suspend(struct ufs_hba
*hba
, enum ufs_pm_op pm_op
)
5818 enum ufs_pm_level pm_lvl
;
5819 enum ufs_dev_pwr_mode req_dev_pwr_mode
;
5820 enum uic_link_state req_link_state
;
5822 hba
->pm_op_in_progress
= 1;
5823 if (!ufshcd_is_shutdown_pm(pm_op
)) {
5824 pm_lvl
= ufshcd_is_runtime_pm(pm_op
) ?
5825 hba
->rpm_lvl
: hba
->spm_lvl
;
5826 req_dev_pwr_mode
= ufs_get_pm_lvl_to_dev_pwr_mode(pm_lvl
);
5827 req_link_state
= ufs_get_pm_lvl_to_link_pwr_state(pm_lvl
);
5829 req_dev_pwr_mode
= UFS_POWERDOWN_PWR_MODE
;
5830 req_link_state
= UIC_LINK_OFF_STATE
;
5834 * If we can't transition into any of the low power modes
5835 * just gate the clocks.
5837 ufshcd_hold(hba
, false);
5838 hba
->clk_gating
.is_suspended
= true;
5840 if (req_dev_pwr_mode
== UFS_ACTIVE_PWR_MODE
&&
5841 req_link_state
== UIC_LINK_ACTIVE_STATE
) {
5845 if ((req_dev_pwr_mode
== hba
->curr_dev_pwr_mode
) &&
5846 (req_link_state
== hba
->uic_link_state
))
5849 /* UFS device & link must be active before we enter in this function */
5850 if (!ufshcd_is_ufs_dev_active(hba
) || !ufshcd_is_link_active(hba
)) {
5855 if (ufshcd_is_runtime_pm(pm_op
)) {
5856 if (ufshcd_can_autobkops_during_suspend(hba
)) {
5858 * The device is idle with no requests in the queue,
5859 * allow background operations if bkops status shows
5860 * that performance might be impacted.
5862 ret
= ufshcd_urgent_bkops(hba
);
5866 /* make sure that auto bkops is disabled */
5867 ufshcd_disable_auto_bkops(hba
);
5871 if ((req_dev_pwr_mode
!= hba
->curr_dev_pwr_mode
) &&
5872 ((ufshcd_is_runtime_pm(pm_op
) && !hba
->auto_bkops_enabled
) ||
5873 !ufshcd_is_runtime_pm(pm_op
))) {
5874 /* ensure that bkops is disabled */
5875 ufshcd_disable_auto_bkops(hba
);
5876 ret
= ufshcd_set_dev_pwr_mode(hba
, req_dev_pwr_mode
);
5881 ret
= ufshcd_link_state_transition(hba
, req_link_state
, 1);
5883 goto set_dev_active
;
5885 ufshcd_vreg_set_lpm(hba
);
5889 * The clock scaling needs access to controller registers. Hence, Wait
5890 * for pending clock scaling work to be done before clocks are
5893 if (ufshcd_is_clkscaling_enabled(hba
)) {
5894 devfreq_suspend_device(hba
->devfreq
);
5895 hba
->clk_scaling
.window_start_t
= 0;
5898 * Call vendor specific suspend callback. As these callbacks may access
5899 * vendor specific host controller register space call them before the
5900 * host clocks are ON.
5902 ret
= ufshcd_vops_suspend(hba
, pm_op
);
5904 goto set_link_active
;
5906 ret
= ufshcd_vops_setup_clocks(hba
, false);
5910 if (!ufshcd_is_link_active(hba
))
5911 ufshcd_setup_clocks(hba
, false);
5913 /* If link is active, device ref_clk can't be switched off */
5914 __ufshcd_setup_clocks(hba
, false, true);
5916 hba
->clk_gating
.state
= CLKS_OFF
;
5918 * Disable the host irq as host controller as there won't be any
5919 * host controller transaction expected till resume.
5921 ufshcd_disable_irq(hba
);
5922 /* Put the host controller in low power mode if possible */
5923 ufshcd_hba_vreg_set_lpm(hba
);
5927 ufshcd_vops_resume(hba
, pm_op
);
5929 ufshcd_vreg_set_hpm(hba
);
5930 if (ufshcd_is_link_hibern8(hba
) && !ufshcd_uic_hibern8_exit(hba
))
5931 ufshcd_set_link_active(hba
);
5932 else if (ufshcd_is_link_off(hba
))
5933 ufshcd_host_reset_and_restore(hba
);
5935 if (!ufshcd_set_dev_pwr_mode(hba
, UFS_ACTIVE_PWR_MODE
))
5936 ufshcd_disable_auto_bkops(hba
);
5938 hba
->clk_gating
.is_suspended
= false;
5939 ufshcd_release(hba
);
5941 hba
->pm_op_in_progress
= 0;
5946 * ufshcd_resume - helper function for resume operations
5947 * @hba: per adapter instance
5948 * @pm_op: runtime PM or system PM
5950 * This function basically brings the UFS device, UniPro link and controller
5953 * Returns 0 for success and non-zero for failure
5955 static int ufshcd_resume(struct ufs_hba
*hba
, enum ufs_pm_op pm_op
)
5958 enum uic_link_state old_link_state
;
5960 hba
->pm_op_in_progress
= 1;
5961 old_link_state
= hba
->uic_link_state
;
5963 ufshcd_hba_vreg_set_hpm(hba
);
5964 /* Make sure clocks are enabled before accessing controller */
5965 ret
= ufshcd_setup_clocks(hba
, true);
5969 /* enable the host irq as host controller would be active soon */
5970 ret
= ufshcd_enable_irq(hba
);
5972 goto disable_irq_and_vops_clks
;
5974 ret
= ufshcd_vreg_set_hpm(hba
);
5976 goto disable_irq_and_vops_clks
;
5979 * Call vendor specific resume callback. As these callbacks may access
5980 * vendor specific host controller register space call them when the
5981 * host clocks are ON.
5983 ret
= ufshcd_vops_resume(hba
, pm_op
);
5987 if (ufshcd_is_link_hibern8(hba
)) {
5988 ret
= ufshcd_uic_hibern8_exit(hba
);
5990 ufshcd_set_link_active(hba
);
5992 goto vendor_suspend
;
5993 } else if (ufshcd_is_link_off(hba
)) {
5994 ret
= ufshcd_host_reset_and_restore(hba
);
5996 * ufshcd_host_reset_and_restore() should have already
5997 * set the link state as active
5999 if (ret
|| !ufshcd_is_link_active(hba
))
6000 goto vendor_suspend
;
6003 if (!ufshcd_is_ufs_dev_active(hba
)) {
6004 ret
= ufshcd_set_dev_pwr_mode(hba
, UFS_ACTIVE_PWR_MODE
);
6006 goto set_old_link_state
;
6010 * If BKOPs operations are urgently needed at this moment then
6011 * keep auto-bkops enabled or else disable it.
6013 ufshcd_urgent_bkops(hba
);
6014 hba
->clk_gating
.is_suspended
= false;
6016 if (ufshcd_is_clkscaling_enabled(hba
))
6017 devfreq_resume_device(hba
->devfreq
);
6019 /* Schedule clock gating in case of no access to UFS device yet */
6020 ufshcd_release(hba
);
6024 ufshcd_link_state_transition(hba
, old_link_state
, 0);
6026 ufshcd_vops_suspend(hba
, pm_op
);
6028 ufshcd_vreg_set_lpm(hba
);
6029 disable_irq_and_vops_clks
:
6030 ufshcd_disable_irq(hba
);
6031 ufshcd_setup_clocks(hba
, false);
6033 hba
->pm_op_in_progress
= 0;
6038 * ufshcd_system_suspend - system suspend routine
6039 * @hba: per adapter instance
6040 * @pm_op: runtime PM or system PM
6042 * Check the description of ufshcd_suspend() function for more details.
6044 * Returns 0 for success and non-zero for failure
6046 int ufshcd_system_suspend(struct ufs_hba
*hba
)
6050 if (!hba
|| !hba
->is_powered
)
6053 if (pm_runtime_suspended(hba
->dev
)) {
6054 if (hba
->rpm_lvl
== hba
->spm_lvl
)
6056 * There is possibility that device may still be in
6057 * active state during the runtime suspend.
6059 if ((ufs_get_pm_lvl_to_dev_pwr_mode(hba
->spm_lvl
) ==
6060 hba
->curr_dev_pwr_mode
) && !hba
->auto_bkops_enabled
)
6064 * UFS device and/or UFS link low power states during runtime
6065 * suspend seems to be different than what is expected during
6066 * system suspend. Hence runtime resume the devic & link and
6067 * let the system suspend low power states to take effect.
6068 * TODO: If resume takes longer time, we might have optimize
6069 * it in future by not resuming everything if possible.
6071 ret
= ufshcd_runtime_resume(hba
);
6076 ret
= ufshcd_suspend(hba
, UFS_SYSTEM_PM
);
6079 hba
->is_sys_suspended
= true;
6082 EXPORT_SYMBOL(ufshcd_system_suspend
);
6085 * ufshcd_system_resume - system resume routine
6086 * @hba: per adapter instance
6088 * Returns 0 for success and non-zero for failure
6091 int ufshcd_system_resume(struct ufs_hba
*hba
)
6093 if (!hba
|| !hba
->is_powered
|| pm_runtime_suspended(hba
->dev
))
6095 * Let the runtime resume take care of resuming
6096 * if runtime suspended.
6100 return ufshcd_resume(hba
, UFS_SYSTEM_PM
);
6102 EXPORT_SYMBOL(ufshcd_system_resume
);
6105 * ufshcd_runtime_suspend - runtime suspend routine
6106 * @hba: per adapter instance
6108 * Check the description of ufshcd_suspend() function for more details.
6110 * Returns 0 for success and non-zero for failure
6112 int ufshcd_runtime_suspend(struct ufs_hba
*hba
)
6114 if (!hba
|| !hba
->is_powered
)
6117 return ufshcd_suspend(hba
, UFS_RUNTIME_PM
);
6119 EXPORT_SYMBOL(ufshcd_runtime_suspend
);
6122 * ufshcd_runtime_resume - runtime resume routine
6123 * @hba: per adapter instance
6125 * This function basically brings the UFS device, UniPro link and controller
6126 * to active state. Following operations are done in this function:
6128 * 1. Turn on all the controller related clocks
6129 * 2. Bring the UniPro link out of Hibernate state
6130 * 3. If UFS device is in sleep state, turn ON VCC rail and bring the UFS device
6132 * 4. If auto-bkops is enabled on the device, disable it.
6134 * So following would be the possible power state after this function return
6136 * S1: UFS device in Active state with VCC rail ON
6137 * UniPro link in Active state
6138 * All the UFS/UniPro controller clocks are ON
6140 * Returns 0 for success and non-zero for failure
6142 int ufshcd_runtime_resume(struct ufs_hba
*hba
)
6144 if (!hba
|| !hba
->is_powered
)
6147 return ufshcd_resume(hba
, UFS_RUNTIME_PM
);
6149 EXPORT_SYMBOL(ufshcd_runtime_resume
);
6151 int ufshcd_runtime_idle(struct ufs_hba
*hba
)
6155 EXPORT_SYMBOL(ufshcd_runtime_idle
);
6158 * ufshcd_shutdown - shutdown routine
6159 * @hba: per adapter instance
6161 * This function would power off both UFS device and UFS link.
6163 * Returns 0 always to allow force shutdown even in case of errors.
6165 int ufshcd_shutdown(struct ufs_hba
*hba
)
6169 if (ufshcd_is_ufs_dev_poweroff(hba
) && ufshcd_is_link_off(hba
))
6172 if (pm_runtime_suspended(hba
->dev
)) {
6173 ret
= ufshcd_runtime_resume(hba
);
6178 ret
= ufshcd_suspend(hba
, UFS_SHUTDOWN_PM
);
6181 dev_err(hba
->dev
, "%s failed, err %d\n", __func__
, ret
);
6182 /* allow force shutdown even in case of errors */
6185 EXPORT_SYMBOL(ufshcd_shutdown
);
6188 * ufshcd_remove - de-allocate SCSI host and host memory space
6189 * data structure memory
6190 * @hba - per adapter instance
6192 void ufshcd_remove(struct ufs_hba
*hba
)
6194 scsi_remove_host(hba
->host
);
6195 /* disable interrupts */
6196 ufshcd_disable_intr(hba
, hba
->intr_mask
);
6197 ufshcd_hba_stop(hba
, true);
6199 scsi_host_put(hba
->host
);
6201 ufshcd_exit_clk_gating(hba
);
6202 if (ufshcd_is_clkscaling_enabled(hba
))
6203 devfreq_remove_device(hba
->devfreq
);
6204 ufshcd_hba_exit(hba
);
6206 EXPORT_SYMBOL_GPL(ufshcd_remove
);
6209 * ufshcd_dealloc_host - deallocate Host Bus Adapter (HBA)
6210 * @hba: pointer to Host Bus Adapter (HBA)
6212 void ufshcd_dealloc_host(struct ufs_hba
*hba
)
6214 scsi_host_put(hba
->host
);
6216 EXPORT_SYMBOL_GPL(ufshcd_dealloc_host
);
6219 * ufshcd_set_dma_mask - Set dma mask based on the controller
6220 * addressing capability
6221 * @hba: per adapter instance
6223 * Returns 0 for success, non-zero for failure
6225 static int ufshcd_set_dma_mask(struct ufs_hba
*hba
)
6227 if (hba
->capabilities
& MASK_64_ADDRESSING_SUPPORT
) {
6228 if (!dma_set_mask_and_coherent(hba
->dev
, DMA_BIT_MASK(64)))
6231 return dma_set_mask_and_coherent(hba
->dev
, DMA_BIT_MASK(32));
6235 * ufshcd_alloc_host - allocate Host Bus Adapter (HBA)
6236 * @dev: pointer to device handle
6237 * @hba_handle: driver private handle
6238 * Returns 0 on success, non-zero value on failure
6240 int ufshcd_alloc_host(struct device
*dev
, struct ufs_hba
**hba_handle
)
6242 struct Scsi_Host
*host
;
6243 struct ufs_hba
*hba
;
6248 "Invalid memory reference for dev is NULL\n");
6253 host
= scsi_host_alloc(&ufshcd_driver_template
,
6254 sizeof(struct ufs_hba
));
6256 dev_err(dev
, "scsi_host_alloc failed\n");
6260 hba
= shost_priv(host
);
6268 EXPORT_SYMBOL(ufshcd_alloc_host
);
6270 static int ufshcd_scale_clks(struct ufs_hba
*hba
, bool scale_up
)
6273 struct ufs_clk_info
*clki
;
6274 struct list_head
*head
= &hba
->clk_list_head
;
6276 if (!head
|| list_empty(head
))
6279 ret
= ufshcd_vops_clk_scale_notify(hba
, scale_up
, PRE_CHANGE
);
6283 list_for_each_entry(clki
, head
, list
) {
6284 if (!IS_ERR_OR_NULL(clki
->clk
)) {
6285 if (scale_up
&& clki
->max_freq
) {
6286 if (clki
->curr_freq
== clki
->max_freq
)
6288 ret
= clk_set_rate(clki
->clk
, clki
->max_freq
);
6290 dev_err(hba
->dev
, "%s: %s clk set rate(%dHz) failed, %d\n",
6291 __func__
, clki
->name
,
6292 clki
->max_freq
, ret
);
6295 clki
->curr_freq
= clki
->max_freq
;
6297 } else if (!scale_up
&& clki
->min_freq
) {
6298 if (clki
->curr_freq
== clki
->min_freq
)
6300 ret
= clk_set_rate(clki
->clk
, clki
->min_freq
);
6302 dev_err(hba
->dev
, "%s: %s clk set rate(%dHz) failed, %d\n",
6303 __func__
, clki
->name
,
6304 clki
->min_freq
, ret
);
6307 clki
->curr_freq
= clki
->min_freq
;
6310 dev_dbg(hba
->dev
, "%s: clk: %s, rate: %lu\n", __func__
,
6311 clki
->name
, clk_get_rate(clki
->clk
));
6314 ret
= ufshcd_vops_clk_scale_notify(hba
, scale_up
, POST_CHANGE
);
6320 static int ufshcd_devfreq_target(struct device
*dev
,
6321 unsigned long *freq
, u32 flags
)
6324 struct ufs_hba
*hba
= dev_get_drvdata(dev
);
6326 if (!ufshcd_is_clkscaling_enabled(hba
))
6329 if (*freq
== UINT_MAX
)
6330 err
= ufshcd_scale_clks(hba
, true);
6331 else if (*freq
== 0)
6332 err
= ufshcd_scale_clks(hba
, false);
6337 static int ufshcd_devfreq_get_dev_status(struct device
*dev
,
6338 struct devfreq_dev_status
*stat
)
6340 struct ufs_hba
*hba
= dev_get_drvdata(dev
);
6341 struct ufs_clk_scaling
*scaling
= &hba
->clk_scaling
;
6342 unsigned long flags
;
6344 if (!ufshcd_is_clkscaling_enabled(hba
))
6347 memset(stat
, 0, sizeof(*stat
));
6349 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
6350 if (!scaling
->window_start_t
)
6353 if (scaling
->is_busy_started
)
6354 scaling
->tot_busy_t
+= ktime_to_us(ktime_sub(ktime_get(),
6355 scaling
->busy_start_t
));
6357 stat
->total_time
= jiffies_to_usecs((long)jiffies
-
6358 (long)scaling
->window_start_t
);
6359 stat
->busy_time
= scaling
->tot_busy_t
;
6361 scaling
->window_start_t
= jiffies
;
6362 scaling
->tot_busy_t
= 0;
6364 if (hba
->outstanding_reqs
) {
6365 scaling
->busy_start_t
= ktime_get();
6366 scaling
->is_busy_started
= true;
6368 scaling
->busy_start_t
= ktime_set(0, 0);
6369 scaling
->is_busy_started
= false;
6371 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
6375 static struct devfreq_dev_profile ufs_devfreq_profile
= {
6377 .target
= ufshcd_devfreq_target
,
6378 .get_dev_status
= ufshcd_devfreq_get_dev_status
,
6382 * ufshcd_init - Driver initialization routine
6383 * @hba: per-adapter instance
6384 * @mmio_base: base register address
6385 * @irq: Interrupt line of device
6386 * Returns 0 on success, non-zero value on failure
6388 int ufshcd_init(struct ufs_hba
*hba
, void __iomem
*mmio_base
, unsigned int irq
)
6391 struct Scsi_Host
*host
= hba
->host
;
6392 struct device
*dev
= hba
->dev
;
6396 "Invalid memory reference for mmio_base is NULL\n");
6401 hba
->mmio_base
= mmio_base
;
6404 err
= ufshcd_hba_init(hba
);
6408 /* Read capabilities registers */
6409 ufshcd_hba_capabilities(hba
);
6411 /* Get UFS version supported by the controller */
6412 hba
->ufs_version
= ufshcd_get_ufs_version(hba
);
6414 /* Get Interrupt bit mask per version */
6415 hba
->intr_mask
= ufshcd_get_intr_mask(hba
);
6417 err
= ufshcd_set_dma_mask(hba
);
6419 dev_err(hba
->dev
, "set dma mask failed\n");
6423 /* Allocate memory for host memory space */
6424 err
= ufshcd_memory_alloc(hba
);
6426 dev_err(hba
->dev
, "Memory allocation failed\n");
6431 ufshcd_host_memory_configure(hba
);
6433 host
->can_queue
= hba
->nutrs
;
6434 host
->cmd_per_lun
= hba
->nutrs
;
6435 host
->max_id
= UFSHCD_MAX_ID
;
6436 host
->max_lun
= UFS_MAX_LUNS
;
6437 host
->max_channel
= UFSHCD_MAX_CHANNEL
;
6438 host
->unique_id
= host
->host_no
;
6439 host
->max_cmd_len
= MAX_CDB_SIZE
;
6441 hba
->max_pwr_info
.is_valid
= false;
6443 /* Initailize wait queue for task management */
6444 init_waitqueue_head(&hba
->tm_wq
);
6445 init_waitqueue_head(&hba
->tm_tag_wq
);
6447 /* Initialize work queues */
6448 INIT_WORK(&hba
->eh_work
, ufshcd_err_handler
);
6449 INIT_WORK(&hba
->eeh_work
, ufshcd_exception_event_handler
);
6451 /* Initialize UIC command mutex */
6452 mutex_init(&hba
->uic_cmd_mutex
);
6454 /* Initialize mutex for device management commands */
6455 mutex_init(&hba
->dev_cmd
.lock
);
6457 /* Initialize device management tag acquire wait queue */
6458 init_waitqueue_head(&hba
->dev_cmd
.tag_wq
);
6460 ufshcd_init_clk_gating(hba
);
6463 * In order to avoid any spurious interrupt immediately after
6464 * registering UFS controller interrupt handler, clear any pending UFS
6465 * interrupt status and disable all the UFS interrupts.
6467 ufshcd_writel(hba
, ufshcd_readl(hba
, REG_INTERRUPT_STATUS
),
6468 REG_INTERRUPT_STATUS
);
6469 ufshcd_writel(hba
, 0, REG_INTERRUPT_ENABLE
);
6471 * Make sure that UFS interrupts are disabled and any pending interrupt
6472 * status is cleared before registering UFS interrupt handler.
6476 /* IRQ registration */
6477 err
= devm_request_irq(dev
, irq
, ufshcd_intr
, IRQF_SHARED
, UFSHCD
, hba
);
6479 dev_err(hba
->dev
, "request irq failed\n");
6482 hba
->is_irq_enabled
= true;
6485 err
= scsi_add_host(host
, hba
->dev
);
6487 dev_err(hba
->dev
, "scsi_add_host failed\n");
6491 /* Host controller enable */
6492 err
= ufshcd_hba_enable(hba
);
6494 dev_err(hba
->dev
, "Host controller enable failed\n");
6495 goto out_remove_scsi_host
;
6498 if (ufshcd_is_clkscaling_enabled(hba
)) {
6499 hba
->devfreq
= devfreq_add_device(dev
, &ufs_devfreq_profile
,
6500 "simple_ondemand", NULL
);
6501 if (IS_ERR(hba
->devfreq
)) {
6502 dev_err(hba
->dev
, "Unable to register with devfreq %ld\n",
6503 PTR_ERR(hba
->devfreq
));
6504 goto out_remove_scsi_host
;
6506 /* Suspend devfreq until the UFS device is detected */
6507 devfreq_suspend_device(hba
->devfreq
);
6508 hba
->clk_scaling
.window_start_t
= 0;
6511 /* Hold auto suspend until async scan completes */
6512 pm_runtime_get_sync(dev
);
6515 * The device-initialize-sequence hasn't been invoked yet.
6516 * Set the device to power-off state
6518 ufshcd_set_ufs_dev_poweroff(hba
);
6520 async_schedule(ufshcd_async_scan
, hba
);
6524 out_remove_scsi_host
:
6525 scsi_remove_host(hba
->host
);
6527 ufshcd_exit_clk_gating(hba
);
6529 hba
->is_irq_enabled
= false;
6530 scsi_host_put(host
);
6531 ufshcd_hba_exit(hba
);
6535 EXPORT_SYMBOL_GPL(ufshcd_init
);
6537 MODULE_AUTHOR("Santosh Yaragnavi <santosh.sy@samsung.com>");
6538 MODULE_AUTHOR("Vinayak Holikatti <h.vinayak@samsung.com>");
6539 MODULE_DESCRIPTION("Generic UFS host controller driver Core");
6540 MODULE_LICENSE("GPL");
6541 MODULE_VERSION(UFSHCD_DRIVER_VERSION
);