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 only need for WRITE_DESC */
1270 if (query
->request
.upiu_req
.opcode
== UPIU_QUERY_OPCODE_WRITE_DESC
)
1271 ucd_req_ptr
->header
.dword_2
=
1272 UPIU_HEADER_DWORD(0, 0, (len
>> 8), (u8
)len
);
1274 ucd_req_ptr
->header
.dword_2
= 0;
1276 /* Copy the Query Request buffer as is */
1277 memcpy(&ucd_req_ptr
->qr
, &query
->request
.upiu_req
,
1280 /* Copy the Descriptor */
1281 if (query
->request
.upiu_req
.opcode
== UPIU_QUERY_OPCODE_WRITE_DESC
)
1282 memcpy(descp
, query
->descriptor
, len
);
1284 memset(lrbp
->ucd_rsp_ptr
, 0, sizeof(struct utp_upiu_rsp
));
1287 static inline void ufshcd_prepare_utp_nop_upiu(struct ufshcd_lrb
*lrbp
)
1289 struct utp_upiu_req
*ucd_req_ptr
= lrbp
->ucd_req_ptr
;
1291 memset(ucd_req_ptr
, 0, sizeof(struct utp_upiu_req
));
1293 /* command descriptor fields */
1294 ucd_req_ptr
->header
.dword_0
=
1296 UPIU_TRANSACTION_NOP_OUT
, 0, 0, lrbp
->task_tag
);
1297 /* clear rest of the fields of basic header */
1298 ucd_req_ptr
->header
.dword_1
= 0;
1299 ucd_req_ptr
->header
.dword_2
= 0;
1301 memset(lrbp
->ucd_rsp_ptr
, 0, sizeof(struct utp_upiu_rsp
));
1305 * ufshcd_comp_devman_upiu - UFS Protocol Information Unit(UPIU)
1306 * for Device Management Purposes
1307 * @hba - per adapter instance
1308 * @lrb - pointer to local reference block
1310 static int ufshcd_comp_devman_upiu(struct ufs_hba
*hba
, struct ufshcd_lrb
*lrbp
)
1315 if (hba
->ufs_version
== UFSHCI_VERSION_20
)
1316 lrbp
->command_type
= UTP_CMD_TYPE_UFS_STORAGE
;
1318 lrbp
->command_type
= UTP_CMD_TYPE_DEV_MANAGE
;
1320 ufshcd_prepare_req_desc_hdr(lrbp
, &upiu_flags
, DMA_NONE
);
1321 if (hba
->dev_cmd
.type
== DEV_CMD_TYPE_QUERY
)
1322 ufshcd_prepare_utp_query_req_upiu(hba
, lrbp
, upiu_flags
);
1323 else if (hba
->dev_cmd
.type
== DEV_CMD_TYPE_NOP
)
1324 ufshcd_prepare_utp_nop_upiu(lrbp
);
1332 * ufshcd_comp_scsi_upiu - UFS Protocol Information Unit(UPIU)
1334 * @hba - per adapter instance
1335 * @lrb - pointer to local reference block
1337 static int ufshcd_comp_scsi_upiu(struct ufs_hba
*hba
, struct ufshcd_lrb
*lrbp
)
1342 if (hba
->ufs_version
== UFSHCI_VERSION_20
)
1343 lrbp
->command_type
= UTP_CMD_TYPE_UFS_STORAGE
;
1345 lrbp
->command_type
= UTP_CMD_TYPE_SCSI
;
1347 if (likely(lrbp
->cmd
)) {
1348 ufshcd_prepare_req_desc_hdr(lrbp
, &upiu_flags
,
1349 lrbp
->cmd
->sc_data_direction
);
1350 ufshcd_prepare_utp_scsi_cmd_upiu(lrbp
, upiu_flags
);
1359 * ufshcd_scsi_to_upiu_lun - maps scsi LUN to UPIU LUN
1360 * @scsi_lun: scsi LUN id
1362 * Returns UPIU LUN id
1364 static inline u8
ufshcd_scsi_to_upiu_lun(unsigned int scsi_lun
)
1366 if (scsi_is_wlun(scsi_lun
))
1367 return (scsi_lun
& UFS_UPIU_MAX_UNIT_NUM_ID
)
1370 return scsi_lun
& UFS_UPIU_MAX_UNIT_NUM_ID
;
1374 * ufshcd_upiu_wlun_to_scsi_wlun - maps UPIU W-LUN id to SCSI W-LUN ID
1375 * @scsi_lun: UPIU W-LUN id
1377 * Returns SCSI W-LUN id
1379 static inline u16
ufshcd_upiu_wlun_to_scsi_wlun(u8 upiu_wlun_id
)
1381 return (upiu_wlun_id
& ~UFS_UPIU_WLUN_ID
) | SCSI_W_LUN_BASE
;
1385 * ufshcd_queuecommand - main entry point for SCSI requests
1386 * @cmd: command from SCSI Midlayer
1387 * @done: call back function
1389 * Returns 0 for success, non-zero in case of failure
1391 static int ufshcd_queuecommand(struct Scsi_Host
*host
, struct scsi_cmnd
*cmd
)
1393 struct ufshcd_lrb
*lrbp
;
1394 struct ufs_hba
*hba
;
1395 unsigned long flags
;
1399 hba
= shost_priv(host
);
1401 tag
= cmd
->request
->tag
;
1402 if (!ufshcd_valid_tag(hba
, tag
)) {
1404 "%s: invalid command tag %d: cmd=0x%p, cmd->request=0x%p",
1405 __func__
, tag
, cmd
, cmd
->request
);
1409 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
1410 switch (hba
->ufshcd_state
) {
1411 case UFSHCD_STATE_OPERATIONAL
:
1413 case UFSHCD_STATE_RESET
:
1414 err
= SCSI_MLQUEUE_HOST_BUSY
;
1416 case UFSHCD_STATE_ERROR
:
1417 set_host_byte(cmd
, DID_ERROR
);
1418 cmd
->scsi_done(cmd
);
1421 dev_WARN_ONCE(hba
->dev
, 1, "%s: invalid state %d\n",
1422 __func__
, hba
->ufshcd_state
);
1423 set_host_byte(cmd
, DID_BAD_TARGET
);
1424 cmd
->scsi_done(cmd
);
1428 /* if error handling is in progress, don't issue commands */
1429 if (ufshcd_eh_in_progress(hba
)) {
1430 set_host_byte(cmd
, DID_ERROR
);
1431 cmd
->scsi_done(cmd
);
1434 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
1436 /* acquire the tag to make sure device cmds don't use it */
1437 if (test_and_set_bit_lock(tag
, &hba
->lrb_in_use
)) {
1439 * Dev manage command in progress, requeue the command.
1440 * Requeuing the command helps in cases where the request *may*
1441 * find different tag instead of waiting for dev manage command
1444 err
= SCSI_MLQUEUE_HOST_BUSY
;
1448 err
= ufshcd_hold(hba
, true);
1450 err
= SCSI_MLQUEUE_HOST_BUSY
;
1451 clear_bit_unlock(tag
, &hba
->lrb_in_use
);
1454 WARN_ON(hba
->clk_gating
.state
!= CLKS_ON
);
1456 lrbp
= &hba
->lrb
[tag
];
1460 lrbp
->sense_bufflen
= SCSI_SENSE_BUFFERSIZE
;
1461 lrbp
->sense_buffer
= cmd
->sense_buffer
;
1462 lrbp
->task_tag
= tag
;
1463 lrbp
->lun
= ufshcd_scsi_to_upiu_lun(cmd
->device
->lun
);
1464 lrbp
->intr_cmd
= !ufshcd_is_intr_aggr_allowed(hba
) ? true : false;
1466 ufshcd_comp_scsi_upiu(hba
, lrbp
);
1468 err
= ufshcd_map_sg(lrbp
);
1471 clear_bit_unlock(tag
, &hba
->lrb_in_use
);
1475 /* issue command to the controller */
1476 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
1477 ufshcd_send_command(hba
, tag
);
1479 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
1484 static int ufshcd_compose_dev_cmd(struct ufs_hba
*hba
,
1485 struct ufshcd_lrb
*lrbp
, enum dev_cmd_type cmd_type
, int tag
)
1488 lrbp
->sense_bufflen
= 0;
1489 lrbp
->sense_buffer
= NULL
;
1490 lrbp
->task_tag
= tag
;
1491 lrbp
->lun
= 0; /* device management cmd is not specific to any LUN */
1492 lrbp
->intr_cmd
= true; /* No interrupt aggregation */
1493 hba
->dev_cmd
.type
= cmd_type
;
1495 return ufshcd_comp_devman_upiu(hba
, lrbp
);
1499 ufshcd_clear_cmd(struct ufs_hba
*hba
, int tag
)
1502 unsigned long flags
;
1503 u32 mask
= 1 << tag
;
1505 /* clear outstanding transaction before retry */
1506 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
1507 ufshcd_utrl_clear(hba
, tag
);
1508 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
1511 * wait for for h/w to clear corresponding bit in door-bell.
1512 * max. wait is 1 sec.
1514 err
= ufshcd_wait_for_register(hba
,
1515 REG_UTP_TRANSFER_REQ_DOOR_BELL
,
1516 mask
, ~mask
, 1000, 1000, true);
1522 ufshcd_check_query_response(struct ufs_hba
*hba
, struct ufshcd_lrb
*lrbp
)
1524 struct ufs_query_res
*query_res
= &hba
->dev_cmd
.query
.response
;
1526 /* Get the UPIU response */
1527 query_res
->response
= ufshcd_get_rsp_upiu_result(lrbp
->ucd_rsp_ptr
) >>
1528 UPIU_RSP_CODE_OFFSET
;
1529 return query_res
->response
;
1533 * ufshcd_dev_cmd_completion() - handles device management command responses
1534 * @hba: per adapter instance
1535 * @lrbp: pointer to local reference block
1538 ufshcd_dev_cmd_completion(struct ufs_hba
*hba
, struct ufshcd_lrb
*lrbp
)
1543 resp
= ufshcd_get_req_rsp(lrbp
->ucd_rsp_ptr
);
1546 case UPIU_TRANSACTION_NOP_IN
:
1547 if (hba
->dev_cmd
.type
!= DEV_CMD_TYPE_NOP
) {
1549 dev_err(hba
->dev
, "%s: unexpected response %x\n",
1553 case UPIU_TRANSACTION_QUERY_RSP
:
1554 err
= ufshcd_check_query_response(hba
, lrbp
);
1556 err
= ufshcd_copy_query_response(hba
, lrbp
);
1558 case UPIU_TRANSACTION_REJECT_UPIU
:
1559 /* TODO: handle Reject UPIU Response */
1561 dev_err(hba
->dev
, "%s: Reject UPIU not fully implemented\n",
1566 dev_err(hba
->dev
, "%s: Invalid device management cmd response: %x\n",
1574 static int ufshcd_wait_for_dev_cmd(struct ufs_hba
*hba
,
1575 struct ufshcd_lrb
*lrbp
, int max_timeout
)
1578 unsigned long time_left
;
1579 unsigned long flags
;
1581 time_left
= wait_for_completion_timeout(hba
->dev_cmd
.complete
,
1582 msecs_to_jiffies(max_timeout
));
1584 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
1585 hba
->dev_cmd
.complete
= NULL
;
1586 if (likely(time_left
)) {
1587 err
= ufshcd_get_tr_ocs(lrbp
);
1589 err
= ufshcd_dev_cmd_completion(hba
, lrbp
);
1591 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
1595 dev_dbg(hba
->dev
, "%s: dev_cmd request timedout, tag %d\n",
1596 __func__
, lrbp
->task_tag
);
1597 if (!ufshcd_clear_cmd(hba
, lrbp
->task_tag
))
1598 /* successfully cleared the command, retry if needed */
1601 * in case of an error, after clearing the doorbell,
1602 * we also need to clear the outstanding_request
1605 ufshcd_outstanding_req_clear(hba
, lrbp
->task_tag
);
1612 * ufshcd_get_dev_cmd_tag - Get device management command tag
1613 * @hba: per-adapter instance
1614 * @tag: pointer to variable with available slot value
1616 * Get a free slot and lock it until device management command
1619 * Returns false if free slot is unavailable for locking, else
1620 * return true with tag value in @tag.
1622 static bool ufshcd_get_dev_cmd_tag(struct ufs_hba
*hba
, int *tag_out
)
1632 tmp
= ~hba
->lrb_in_use
;
1633 tag
= find_last_bit(&tmp
, hba
->nutrs
);
1634 if (tag
>= hba
->nutrs
)
1636 } while (test_and_set_bit_lock(tag
, &hba
->lrb_in_use
));
1644 static inline void ufshcd_put_dev_cmd_tag(struct ufs_hba
*hba
, int tag
)
1646 clear_bit_unlock(tag
, &hba
->lrb_in_use
);
1650 * ufshcd_exec_dev_cmd - API for sending device management requests
1652 * @cmd_type - specifies the type (NOP, Query...)
1653 * @timeout - time in seconds
1655 * NOTE: Since there is only one available tag for device management commands,
1656 * it is expected you hold the hba->dev_cmd.lock mutex.
1658 static int ufshcd_exec_dev_cmd(struct ufs_hba
*hba
,
1659 enum dev_cmd_type cmd_type
, int timeout
)
1661 struct ufshcd_lrb
*lrbp
;
1664 struct completion wait
;
1665 unsigned long flags
;
1668 * Get free slot, sleep if slots are unavailable.
1669 * Even though we use wait_event() which sleeps indefinitely,
1670 * the maximum wait time is bounded by SCSI request timeout.
1672 wait_event(hba
->dev_cmd
.tag_wq
, ufshcd_get_dev_cmd_tag(hba
, &tag
));
1674 init_completion(&wait
);
1675 lrbp
= &hba
->lrb
[tag
];
1677 err
= ufshcd_compose_dev_cmd(hba
, lrbp
, cmd_type
, tag
);
1681 hba
->dev_cmd
.complete
= &wait
;
1683 /* Make sure descriptors are ready before ringing the doorbell */
1685 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
1686 ufshcd_send_command(hba
, tag
);
1687 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
1689 err
= ufshcd_wait_for_dev_cmd(hba
, lrbp
, timeout
);
1692 ufshcd_put_dev_cmd_tag(hba
, tag
);
1693 wake_up(&hba
->dev_cmd
.tag_wq
);
1698 * ufshcd_init_query() - init the query response and request parameters
1699 * @hba: per-adapter instance
1700 * @request: address of the request pointer to be initialized
1701 * @response: address of the response pointer to be initialized
1702 * @opcode: operation to perform
1703 * @idn: flag idn to access
1704 * @index: LU number to access
1705 * @selector: query/flag/descriptor further identification
1707 static inline void ufshcd_init_query(struct ufs_hba
*hba
,
1708 struct ufs_query_req
**request
, struct ufs_query_res
**response
,
1709 enum query_opcode opcode
, u8 idn
, u8 index
, u8 selector
)
1711 *request
= &hba
->dev_cmd
.query
.request
;
1712 *response
= &hba
->dev_cmd
.query
.response
;
1713 memset(*request
, 0, sizeof(struct ufs_query_req
));
1714 memset(*response
, 0, sizeof(struct ufs_query_res
));
1715 (*request
)->upiu_req
.opcode
= opcode
;
1716 (*request
)->upiu_req
.idn
= idn
;
1717 (*request
)->upiu_req
.index
= index
;
1718 (*request
)->upiu_req
.selector
= selector
;
1721 static int ufshcd_query_flag_retry(struct ufs_hba
*hba
,
1722 enum query_opcode opcode
, enum flag_idn idn
, bool *flag_res
)
1727 for (retries
= 0; retries
< QUERY_REQ_RETRIES
; retries
++) {
1728 ret
= ufshcd_query_flag(hba
, opcode
, idn
, flag_res
);
1731 "%s: failed with error %d, retries %d\n",
1732 __func__
, ret
, retries
);
1739 "%s: query attribute, opcode %d, idn %d, failed with error %d after %d retires\n",
1740 __func__
, opcode
, idn
, ret
, retries
);
1745 * ufshcd_query_flag() - API function for sending flag query requests
1746 * hba: per-adapter instance
1747 * query_opcode: flag query to perform
1748 * idn: flag idn to access
1749 * flag_res: the flag value after the query request completes
1751 * Returns 0 for success, non-zero in case of failure
1753 int ufshcd_query_flag(struct ufs_hba
*hba
, enum query_opcode opcode
,
1754 enum flag_idn idn
, bool *flag_res
)
1756 struct ufs_query_req
*request
= NULL
;
1757 struct ufs_query_res
*response
= NULL
;
1758 int err
, index
= 0, selector
= 0;
1759 int timeout
= QUERY_REQ_TIMEOUT
;
1763 ufshcd_hold(hba
, false);
1764 mutex_lock(&hba
->dev_cmd
.lock
);
1765 ufshcd_init_query(hba
, &request
, &response
, opcode
, idn
, index
,
1769 case UPIU_QUERY_OPCODE_SET_FLAG
:
1770 case UPIU_QUERY_OPCODE_CLEAR_FLAG
:
1771 case UPIU_QUERY_OPCODE_TOGGLE_FLAG
:
1772 request
->query_func
= UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST
;
1774 case UPIU_QUERY_OPCODE_READ_FLAG
:
1775 request
->query_func
= UPIU_QUERY_FUNC_STANDARD_READ_REQUEST
;
1777 /* No dummy reads */
1778 dev_err(hba
->dev
, "%s: Invalid argument for read request\n",
1786 "%s: Expected query flag opcode but got = %d\n",
1792 if (idn
== QUERY_FLAG_IDN_FDEVICEINIT
)
1793 timeout
= QUERY_FDEVICEINIT_REQ_TIMEOUT
;
1795 err
= ufshcd_exec_dev_cmd(hba
, DEV_CMD_TYPE_QUERY
, timeout
);
1799 "%s: Sending flag query for idn %d failed, err = %d\n",
1800 __func__
, idn
, err
);
1805 *flag_res
= (be32_to_cpu(response
->upiu_res
.value
) &
1806 MASK_QUERY_UPIU_FLAG_LOC
) & 0x1;
1809 mutex_unlock(&hba
->dev_cmd
.lock
);
1810 ufshcd_release(hba
);
1815 * ufshcd_query_attr - API function for sending attribute requests
1816 * hba: per-adapter instance
1817 * opcode: attribute opcode
1818 * idn: attribute idn to access
1819 * index: index field
1820 * selector: selector field
1821 * attr_val: the attribute value after the query request completes
1823 * Returns 0 for success, non-zero in case of failure
1825 static int ufshcd_query_attr(struct ufs_hba
*hba
, enum query_opcode opcode
,
1826 enum attr_idn idn
, u8 index
, u8 selector
, u32
*attr_val
)
1828 struct ufs_query_req
*request
= NULL
;
1829 struct ufs_query_res
*response
= NULL
;
1834 ufshcd_hold(hba
, false);
1836 dev_err(hba
->dev
, "%s: attribute value required for opcode 0x%x\n",
1842 mutex_lock(&hba
->dev_cmd
.lock
);
1843 ufshcd_init_query(hba
, &request
, &response
, opcode
, idn
, index
,
1847 case UPIU_QUERY_OPCODE_WRITE_ATTR
:
1848 request
->query_func
= UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST
;
1849 request
->upiu_req
.value
= cpu_to_be32(*attr_val
);
1851 case UPIU_QUERY_OPCODE_READ_ATTR
:
1852 request
->query_func
= UPIU_QUERY_FUNC_STANDARD_READ_REQUEST
;
1855 dev_err(hba
->dev
, "%s: Expected query attr opcode but got = 0x%.2x\n",
1861 err
= ufshcd_exec_dev_cmd(hba
, DEV_CMD_TYPE_QUERY
, QUERY_REQ_TIMEOUT
);
1864 dev_err(hba
->dev
, "%s: opcode 0x%.2x for idn %d failed, err = %d\n",
1865 __func__
, opcode
, idn
, err
);
1869 *attr_val
= be32_to_cpu(response
->upiu_res
.value
);
1872 mutex_unlock(&hba
->dev_cmd
.lock
);
1874 ufshcd_release(hba
);
1879 * ufshcd_query_attr_retry() - API function for sending query
1880 * attribute with retries
1881 * @hba: per-adapter instance
1882 * @opcode: attribute opcode
1883 * @idn: attribute idn to access
1884 * @index: index field
1885 * @selector: selector field
1886 * @attr_val: the attribute value after the query request
1889 * Returns 0 for success, non-zero in case of failure
1891 static int ufshcd_query_attr_retry(struct ufs_hba
*hba
,
1892 enum query_opcode opcode
, enum attr_idn idn
, u8 index
, u8 selector
,
1898 for (retries
= QUERY_REQ_RETRIES
; retries
> 0; retries
--) {
1899 ret
= ufshcd_query_attr(hba
, opcode
, idn
, index
,
1900 selector
, attr_val
);
1902 dev_dbg(hba
->dev
, "%s: failed with error %d, retries %d\n",
1903 __func__
, ret
, retries
);
1910 "%s: query attribute, idn %d, failed with error %d after %d retires\n",
1911 __func__
, idn
, ret
, QUERY_REQ_RETRIES
);
1915 static int __ufshcd_query_descriptor(struct ufs_hba
*hba
,
1916 enum query_opcode opcode
, enum desc_idn idn
, u8 index
,
1917 u8 selector
, u8
*desc_buf
, int *buf_len
)
1919 struct ufs_query_req
*request
= NULL
;
1920 struct ufs_query_res
*response
= NULL
;
1925 ufshcd_hold(hba
, false);
1927 dev_err(hba
->dev
, "%s: descriptor buffer required for opcode 0x%x\n",
1933 if (*buf_len
<= QUERY_DESC_MIN_SIZE
|| *buf_len
> QUERY_DESC_MAX_SIZE
) {
1934 dev_err(hba
->dev
, "%s: descriptor buffer size (%d) is out of range\n",
1935 __func__
, *buf_len
);
1940 mutex_lock(&hba
->dev_cmd
.lock
);
1941 ufshcd_init_query(hba
, &request
, &response
, opcode
, idn
, index
,
1943 hba
->dev_cmd
.query
.descriptor
= desc_buf
;
1944 request
->upiu_req
.length
= cpu_to_be16(*buf_len
);
1947 case UPIU_QUERY_OPCODE_WRITE_DESC
:
1948 request
->query_func
= UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST
;
1950 case UPIU_QUERY_OPCODE_READ_DESC
:
1951 request
->query_func
= UPIU_QUERY_FUNC_STANDARD_READ_REQUEST
;
1955 "%s: Expected query descriptor opcode but got = 0x%.2x\n",
1961 err
= ufshcd_exec_dev_cmd(hba
, DEV_CMD_TYPE_QUERY
, QUERY_REQ_TIMEOUT
);
1964 dev_err(hba
->dev
, "%s: opcode 0x%.2x for idn %d failed, err = %d\n",
1965 __func__
, opcode
, idn
, err
);
1969 hba
->dev_cmd
.query
.descriptor
= NULL
;
1970 *buf_len
= be16_to_cpu(response
->upiu_res
.length
);
1973 mutex_unlock(&hba
->dev_cmd
.lock
);
1975 ufshcd_release(hba
);
1980 * ufshcd_query_descriptor_retry - API function for sending descriptor
1982 * hba: per-adapter instance
1983 * opcode: attribute opcode
1984 * idn: attribute idn to access
1985 * index: index field
1986 * selector: selector field
1987 * desc_buf: the buffer that contains the descriptor
1988 * buf_len: length parameter passed to the device
1990 * Returns 0 for success, non-zero in case of failure.
1991 * The buf_len parameter will contain, on return, the length parameter
1992 * received on the response.
1994 int ufshcd_query_descriptor_retry(struct ufs_hba
*hba
,
1995 enum query_opcode opcode
, enum desc_idn idn
, u8 index
,
1996 u8 selector
, u8
*desc_buf
, int *buf_len
)
2001 for (retries
= QUERY_REQ_RETRIES
; retries
> 0; retries
--) {
2002 err
= __ufshcd_query_descriptor(hba
, opcode
, idn
, index
,
2003 selector
, desc_buf
, buf_len
);
2004 if (!err
|| err
== -EINVAL
)
2010 EXPORT_SYMBOL(ufshcd_query_descriptor_retry
);
2013 * ufshcd_read_desc_param - read the specified descriptor parameter
2014 * @hba: Pointer to adapter instance
2015 * @desc_id: descriptor idn value
2016 * @desc_index: descriptor index
2017 * @param_offset: offset of the parameter to read
2018 * @param_read_buf: pointer to buffer where parameter would be read
2019 * @param_size: sizeof(param_read_buf)
2021 * Return 0 in case of success, non-zero otherwise
2023 static int ufshcd_read_desc_param(struct ufs_hba
*hba
,
2024 enum desc_idn desc_id
,
2033 bool is_kmalloc
= true;
2036 if (desc_id
>= QUERY_DESC_IDN_MAX
)
2039 buff_len
= ufs_query_desc_max_size
[desc_id
];
2040 if ((param_offset
+ param_size
) > buff_len
)
2043 if (!param_offset
&& (param_size
== buff_len
)) {
2044 /* memory space already available to hold full descriptor */
2045 desc_buf
= param_read_buf
;
2048 /* allocate memory to hold full descriptor */
2049 desc_buf
= kmalloc(buff_len
, GFP_KERNEL
);
2054 ret
= ufshcd_query_descriptor_retry(hba
, UPIU_QUERY_OPCODE_READ_DESC
,
2055 desc_id
, desc_index
, 0, desc_buf
,
2058 if (ret
|| (buff_len
< ufs_query_desc_max_size
[desc_id
]) ||
2059 (desc_buf
[QUERY_DESC_LENGTH_OFFSET
] !=
2060 ufs_query_desc_max_size
[desc_id
])
2061 || (desc_buf
[QUERY_DESC_DESC_TYPE_OFFSET
] != desc_id
)) {
2062 dev_err(hba
->dev
, "%s: Failed reading descriptor. desc_id %d param_offset %d buff_len %d ret %d",
2063 __func__
, desc_id
, param_offset
, buff_len
, ret
);
2071 memcpy(param_read_buf
, &desc_buf
[param_offset
], param_size
);
2078 static inline int ufshcd_read_desc(struct ufs_hba
*hba
,
2079 enum desc_idn desc_id
,
2084 return ufshcd_read_desc_param(hba
, desc_id
, desc_index
, 0, buf
, size
);
2087 static inline int ufshcd_read_power_desc(struct ufs_hba
*hba
,
2091 return ufshcd_read_desc(hba
, QUERY_DESC_IDN_POWER
, 0, buf
, size
);
2094 int ufshcd_read_device_desc(struct ufs_hba
*hba
, u8
*buf
, u32 size
)
2096 return ufshcd_read_desc(hba
, QUERY_DESC_IDN_DEVICE
, 0, buf
, size
);
2098 EXPORT_SYMBOL(ufshcd_read_device_desc
);
2101 * ufshcd_read_string_desc - read string descriptor
2102 * @hba: pointer to adapter instance
2103 * @desc_index: descriptor index
2104 * @buf: pointer to buffer where descriptor would be read
2105 * @size: size of buf
2106 * @ascii: if true convert from unicode to ascii characters
2108 * Return 0 in case of success, non-zero otherwise
2110 int ufshcd_read_string_desc(struct ufs_hba
*hba
, int desc_index
, u8
*buf
,
2111 u32 size
, bool ascii
)
2115 err
= ufshcd_read_desc(hba
,
2116 QUERY_DESC_IDN_STRING
, desc_index
, buf
, size
);
2119 dev_err(hba
->dev
, "%s: reading String Desc failed after %d retries. err = %d\n",
2120 __func__
, QUERY_REQ_RETRIES
, err
);
2131 /* remove header and divide by 2 to move from UTF16 to UTF8 */
2132 ascii_len
= (desc_len
- QUERY_DESC_HDR_SIZE
) / 2 + 1;
2133 if (size
< ascii_len
+ QUERY_DESC_HDR_SIZE
) {
2134 dev_err(hba
->dev
, "%s: buffer allocated size is too small\n",
2140 buff_ascii
= kmalloc(ascii_len
, GFP_KERNEL
);
2147 * the descriptor contains string in UTF16 format
2148 * we need to convert to utf-8 so it can be displayed
2150 utf16s_to_utf8s((wchar_t *)&buf
[QUERY_DESC_HDR_SIZE
],
2151 desc_len
- QUERY_DESC_HDR_SIZE
,
2152 UTF16_BIG_ENDIAN
, buff_ascii
, ascii_len
);
2154 /* replace non-printable or non-ASCII characters with spaces */
2155 for (i
= 0; i
< ascii_len
; i
++)
2156 ufshcd_remove_non_printable(&buff_ascii
[i
]);
2158 memset(buf
+ QUERY_DESC_HDR_SIZE
, 0,
2159 size
- QUERY_DESC_HDR_SIZE
);
2160 memcpy(buf
+ QUERY_DESC_HDR_SIZE
, buff_ascii
, ascii_len
);
2161 buf
[QUERY_DESC_LENGTH_OFFSET
] = ascii_len
+ QUERY_DESC_HDR_SIZE
;
2167 EXPORT_SYMBOL(ufshcd_read_string_desc
);
2170 * ufshcd_read_unit_desc_param - read the specified unit descriptor parameter
2171 * @hba: Pointer to adapter instance
2173 * @param_offset: offset of the parameter to read
2174 * @param_read_buf: pointer to buffer where parameter would be read
2175 * @param_size: sizeof(param_read_buf)
2177 * Return 0 in case of success, non-zero otherwise
2179 static inline int ufshcd_read_unit_desc_param(struct ufs_hba
*hba
,
2181 enum unit_desc_param param_offset
,
2186 * Unit descriptors are only available for general purpose LUs (LUN id
2187 * from 0 to 7) and RPMB Well known LU.
2189 if (lun
!= UFS_UPIU_RPMB_WLUN
&& (lun
>= UFS_UPIU_MAX_GENERAL_LUN
))
2192 return ufshcd_read_desc_param(hba
, QUERY_DESC_IDN_UNIT
, lun
,
2193 param_offset
, param_read_buf
, param_size
);
2197 * ufshcd_memory_alloc - allocate memory for host memory space data structures
2198 * @hba: per adapter instance
2200 * 1. Allocate DMA memory for Command Descriptor array
2201 * Each command descriptor consist of Command UPIU, Response UPIU and PRDT
2202 * 2. Allocate DMA memory for UTP Transfer Request Descriptor List (UTRDL).
2203 * 3. Allocate DMA memory for UTP Task Management Request Descriptor List
2205 * 4. Allocate memory for local reference block(lrb).
2207 * Returns 0 for success, non-zero in case of failure
2209 static int ufshcd_memory_alloc(struct ufs_hba
*hba
)
2211 size_t utmrdl_size
, utrdl_size
, ucdl_size
;
2213 /* Allocate memory for UTP command descriptors */
2214 ucdl_size
= (sizeof(struct utp_transfer_cmd_desc
) * hba
->nutrs
);
2215 hba
->ucdl_base_addr
= dmam_alloc_coherent(hba
->dev
,
2217 &hba
->ucdl_dma_addr
,
2221 * UFSHCI requires UTP command descriptor to be 128 byte aligned.
2222 * make sure hba->ucdl_dma_addr is aligned to PAGE_SIZE
2223 * if hba->ucdl_dma_addr is aligned to PAGE_SIZE, then it will
2224 * be aligned to 128 bytes as well
2226 if (!hba
->ucdl_base_addr
||
2227 WARN_ON(hba
->ucdl_dma_addr
& (PAGE_SIZE
- 1))) {
2229 "Command Descriptor Memory allocation failed\n");
2234 * Allocate memory for UTP Transfer descriptors
2235 * UFSHCI requires 1024 byte alignment of UTRD
2237 utrdl_size
= (sizeof(struct utp_transfer_req_desc
) * hba
->nutrs
);
2238 hba
->utrdl_base_addr
= dmam_alloc_coherent(hba
->dev
,
2240 &hba
->utrdl_dma_addr
,
2242 if (!hba
->utrdl_base_addr
||
2243 WARN_ON(hba
->utrdl_dma_addr
& (PAGE_SIZE
- 1))) {
2245 "Transfer Descriptor Memory allocation failed\n");
2250 * Allocate memory for UTP Task Management descriptors
2251 * UFSHCI requires 1024 byte alignment of UTMRD
2253 utmrdl_size
= sizeof(struct utp_task_req_desc
) * hba
->nutmrs
;
2254 hba
->utmrdl_base_addr
= dmam_alloc_coherent(hba
->dev
,
2256 &hba
->utmrdl_dma_addr
,
2258 if (!hba
->utmrdl_base_addr
||
2259 WARN_ON(hba
->utmrdl_dma_addr
& (PAGE_SIZE
- 1))) {
2261 "Task Management Descriptor Memory allocation failed\n");
2265 /* Allocate memory for local reference block */
2266 hba
->lrb
= devm_kzalloc(hba
->dev
,
2267 hba
->nutrs
* sizeof(struct ufshcd_lrb
),
2270 dev_err(hba
->dev
, "LRB Memory allocation failed\n");
2279 * ufshcd_host_memory_configure - configure local reference block with
2281 * @hba: per adapter instance
2283 * Configure Host memory space
2284 * 1. Update Corresponding UTRD.UCDBA and UTRD.UCDBAU with UCD DMA
2286 * 2. Update each UTRD with Response UPIU offset, Response UPIU length
2288 * 3. Save the corresponding addresses of UTRD, UCD.CMD, UCD.RSP and UCD.PRDT
2289 * into local reference block.
2291 static void ufshcd_host_memory_configure(struct ufs_hba
*hba
)
2293 struct utp_transfer_cmd_desc
*cmd_descp
;
2294 struct utp_transfer_req_desc
*utrdlp
;
2295 dma_addr_t cmd_desc_dma_addr
;
2296 dma_addr_t cmd_desc_element_addr
;
2297 u16 response_offset
;
2302 utrdlp
= hba
->utrdl_base_addr
;
2303 cmd_descp
= hba
->ucdl_base_addr
;
2306 offsetof(struct utp_transfer_cmd_desc
, response_upiu
);
2308 offsetof(struct utp_transfer_cmd_desc
, prd_table
);
2310 cmd_desc_size
= sizeof(struct utp_transfer_cmd_desc
);
2311 cmd_desc_dma_addr
= hba
->ucdl_dma_addr
;
2313 for (i
= 0; i
< hba
->nutrs
; i
++) {
2314 /* Configure UTRD with command descriptor base address */
2315 cmd_desc_element_addr
=
2316 (cmd_desc_dma_addr
+ (cmd_desc_size
* i
));
2317 utrdlp
[i
].command_desc_base_addr_lo
=
2318 cpu_to_le32(lower_32_bits(cmd_desc_element_addr
));
2319 utrdlp
[i
].command_desc_base_addr_hi
=
2320 cpu_to_le32(upper_32_bits(cmd_desc_element_addr
));
2322 /* Response upiu and prdt offset should be in double words */
2323 utrdlp
[i
].response_upiu_offset
=
2324 cpu_to_le16((response_offset
>> 2));
2325 utrdlp
[i
].prd_table_offset
=
2326 cpu_to_le16((prdt_offset
>> 2));
2327 utrdlp
[i
].response_upiu_length
=
2328 cpu_to_le16(ALIGNED_UPIU_SIZE
>> 2);
2330 hba
->lrb
[i
].utr_descriptor_ptr
= (utrdlp
+ i
);
2331 hba
->lrb
[i
].ucd_req_ptr
=
2332 (struct utp_upiu_req
*)(cmd_descp
+ i
);
2333 hba
->lrb
[i
].ucd_rsp_ptr
=
2334 (struct utp_upiu_rsp
*)cmd_descp
[i
].response_upiu
;
2335 hba
->lrb
[i
].ucd_prdt_ptr
=
2336 (struct ufshcd_sg_entry
*)cmd_descp
[i
].prd_table
;
2341 * ufshcd_dme_link_startup - Notify Unipro to perform link startup
2342 * @hba: per adapter instance
2344 * UIC_CMD_DME_LINK_STARTUP command must be issued to Unipro layer,
2345 * in order to initialize the Unipro link startup procedure.
2346 * Once the Unipro links are up, the device connected to the controller
2349 * Returns 0 on success, non-zero value on failure
2351 static int ufshcd_dme_link_startup(struct ufs_hba
*hba
)
2353 struct uic_command uic_cmd
= {0};
2356 uic_cmd
.command
= UIC_CMD_DME_LINK_STARTUP
;
2358 ret
= ufshcd_send_uic_cmd(hba
, &uic_cmd
);
2361 "dme-link-startup: error code %d\n", ret
);
2365 static inline void ufshcd_add_delay_before_dme_cmd(struct ufs_hba
*hba
)
2367 #define MIN_DELAY_BEFORE_DME_CMDS_US 1000
2368 unsigned long min_sleep_time_us
;
2370 if (!(hba
->quirks
& UFSHCD_QUIRK_DELAY_BEFORE_DME_CMDS
))
2374 * last_dme_cmd_tstamp will be 0 only for 1st call to
2377 if (unlikely(!ktime_to_us(hba
->last_dme_cmd_tstamp
))) {
2378 min_sleep_time_us
= MIN_DELAY_BEFORE_DME_CMDS_US
;
2380 unsigned long delta
=
2381 (unsigned long) ktime_to_us(
2382 ktime_sub(ktime_get(),
2383 hba
->last_dme_cmd_tstamp
));
2385 if (delta
< MIN_DELAY_BEFORE_DME_CMDS_US
)
2387 MIN_DELAY_BEFORE_DME_CMDS_US
- delta
;
2389 return; /* no more delay required */
2392 /* allow sleep for extra 50us if needed */
2393 usleep_range(min_sleep_time_us
, min_sleep_time_us
+ 50);
2397 * ufshcd_dme_set_attr - UIC command for DME_SET, DME_PEER_SET
2398 * @hba: per adapter instance
2399 * @attr_sel: uic command argument1
2400 * @attr_set: attribute set type as uic command argument2
2401 * @mib_val: setting value as uic command argument3
2402 * @peer: indicate whether peer or local
2404 * Returns 0 on success, non-zero value on failure
2406 int ufshcd_dme_set_attr(struct ufs_hba
*hba
, u32 attr_sel
,
2407 u8 attr_set
, u32 mib_val
, u8 peer
)
2409 struct uic_command uic_cmd
= {0};
2410 static const char *const action
[] = {
2414 const char *set
= action
[!!peer
];
2416 int retries
= UFS_UIC_COMMAND_RETRIES
;
2418 uic_cmd
.command
= peer
?
2419 UIC_CMD_DME_PEER_SET
: UIC_CMD_DME_SET
;
2420 uic_cmd
.argument1
= attr_sel
;
2421 uic_cmd
.argument2
= UIC_ARG_ATTR_TYPE(attr_set
);
2422 uic_cmd
.argument3
= mib_val
;
2425 /* for peer attributes we retry upon failure */
2426 ret
= ufshcd_send_uic_cmd(hba
, &uic_cmd
);
2428 dev_dbg(hba
->dev
, "%s: attr-id 0x%x val 0x%x error code %d\n",
2429 set
, UIC_GET_ATTR_ID(attr_sel
), mib_val
, ret
);
2430 } while (ret
&& peer
&& --retries
);
2433 dev_err(hba
->dev
, "%s: attr-id 0x%x val 0x%x failed %d retries\n",
2434 set
, UIC_GET_ATTR_ID(attr_sel
), mib_val
,
2439 EXPORT_SYMBOL_GPL(ufshcd_dme_set_attr
);
2442 * ufshcd_dme_get_attr - UIC command for DME_GET, DME_PEER_GET
2443 * @hba: per adapter instance
2444 * @attr_sel: uic command argument1
2445 * @mib_val: the value of the attribute as returned by the UIC command
2446 * @peer: indicate whether peer or local
2448 * Returns 0 on success, non-zero value on failure
2450 int ufshcd_dme_get_attr(struct ufs_hba
*hba
, u32 attr_sel
,
2451 u32
*mib_val
, u8 peer
)
2453 struct uic_command uic_cmd
= {0};
2454 static const char *const action
[] = {
2458 const char *get
= action
[!!peer
];
2460 int retries
= UFS_UIC_COMMAND_RETRIES
;
2461 struct ufs_pa_layer_attr orig_pwr_info
;
2462 struct ufs_pa_layer_attr temp_pwr_info
;
2463 bool pwr_mode_change
= false;
2465 if (peer
&& (hba
->quirks
& UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE
)) {
2466 orig_pwr_info
= hba
->pwr_info
;
2467 temp_pwr_info
= orig_pwr_info
;
2469 if (orig_pwr_info
.pwr_tx
== FAST_MODE
||
2470 orig_pwr_info
.pwr_rx
== FAST_MODE
) {
2471 temp_pwr_info
.pwr_tx
= FASTAUTO_MODE
;
2472 temp_pwr_info
.pwr_rx
= FASTAUTO_MODE
;
2473 pwr_mode_change
= true;
2474 } else if (orig_pwr_info
.pwr_tx
== SLOW_MODE
||
2475 orig_pwr_info
.pwr_rx
== SLOW_MODE
) {
2476 temp_pwr_info
.pwr_tx
= SLOWAUTO_MODE
;
2477 temp_pwr_info
.pwr_rx
= SLOWAUTO_MODE
;
2478 pwr_mode_change
= true;
2480 if (pwr_mode_change
) {
2481 ret
= ufshcd_change_power_mode(hba
, &temp_pwr_info
);
2487 uic_cmd
.command
= peer
?
2488 UIC_CMD_DME_PEER_GET
: UIC_CMD_DME_GET
;
2489 uic_cmd
.argument1
= attr_sel
;
2492 /* for peer attributes we retry upon failure */
2493 ret
= ufshcd_send_uic_cmd(hba
, &uic_cmd
);
2495 dev_dbg(hba
->dev
, "%s: attr-id 0x%x error code %d\n",
2496 get
, UIC_GET_ATTR_ID(attr_sel
), ret
);
2497 } while (ret
&& peer
&& --retries
);
2500 dev_err(hba
->dev
, "%s: attr-id 0x%x failed %d retries\n",
2501 get
, UIC_GET_ATTR_ID(attr_sel
), retries
);
2503 if (mib_val
&& !ret
)
2504 *mib_val
= uic_cmd
.argument3
;
2506 if (peer
&& (hba
->quirks
& UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE
)
2508 ufshcd_change_power_mode(hba
, &orig_pwr_info
);
2512 EXPORT_SYMBOL_GPL(ufshcd_dme_get_attr
);
2515 * ufshcd_uic_pwr_ctrl - executes UIC commands (which affects the link power
2516 * state) and waits for it to take effect.
2518 * @hba: per adapter instance
2519 * @cmd: UIC command to execute
2521 * DME operations like DME_SET(PA_PWRMODE), DME_HIBERNATE_ENTER &
2522 * DME_HIBERNATE_EXIT commands take some time to take its effect on both host
2523 * and device UniPro link and hence it's final completion would be indicated by
2524 * dedicated status bits in Interrupt Status register (UPMS, UHES, UHXS) in
2525 * addition to normal UIC command completion Status (UCCS). This function only
2526 * returns after the relevant status bits indicate the completion.
2528 * Returns 0 on success, non-zero value on failure
2530 static int ufshcd_uic_pwr_ctrl(struct ufs_hba
*hba
, struct uic_command
*cmd
)
2532 struct completion uic_async_done
;
2533 unsigned long flags
;
2536 bool reenable_intr
= false;
2538 mutex_lock(&hba
->uic_cmd_mutex
);
2539 init_completion(&uic_async_done
);
2540 ufshcd_add_delay_before_dme_cmd(hba
);
2542 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
2543 hba
->uic_async_done
= &uic_async_done
;
2544 if (ufshcd_readl(hba
, REG_INTERRUPT_ENABLE
) & UIC_COMMAND_COMPL
) {
2545 ufshcd_disable_intr(hba
, UIC_COMMAND_COMPL
);
2547 * Make sure UIC command completion interrupt is disabled before
2548 * issuing UIC command.
2551 reenable_intr
= true;
2553 ret
= __ufshcd_send_uic_cmd(hba
, cmd
, false);
2554 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
2557 "pwr ctrl cmd 0x%x with mode 0x%x uic error %d\n",
2558 cmd
->command
, cmd
->argument3
, ret
);
2562 if (!wait_for_completion_timeout(hba
->uic_async_done
,
2563 msecs_to_jiffies(UIC_CMD_TIMEOUT
))) {
2565 "pwr ctrl cmd 0x%x with mode 0x%x completion timeout\n",
2566 cmd
->command
, cmd
->argument3
);
2571 status
= ufshcd_get_upmcrs(hba
);
2572 if (status
!= PWR_LOCAL
) {
2574 "pwr ctrl cmd 0x%0x failed, host upmcrs:0x%x\n",
2575 cmd
->command
, status
);
2576 ret
= (status
!= PWR_OK
) ? status
: -1;
2579 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
2580 hba
->active_uic_cmd
= NULL
;
2581 hba
->uic_async_done
= NULL
;
2583 ufshcd_enable_intr(hba
, UIC_COMMAND_COMPL
);
2584 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
2585 mutex_unlock(&hba
->uic_cmd_mutex
);
2591 * ufshcd_uic_change_pwr_mode - Perform the UIC power mode chage
2592 * using DME_SET primitives.
2593 * @hba: per adapter instance
2594 * @mode: powr mode value
2596 * Returns 0 on success, non-zero value on failure
2598 static int ufshcd_uic_change_pwr_mode(struct ufs_hba
*hba
, u8 mode
)
2600 struct uic_command uic_cmd
= {0};
2603 if (hba
->quirks
& UFSHCD_QUIRK_BROKEN_PA_RXHSUNTERMCAP
) {
2604 ret
= ufshcd_dme_set(hba
,
2605 UIC_ARG_MIB_SEL(PA_RXHSUNTERMCAP
, 0), 1);
2607 dev_err(hba
->dev
, "%s: failed to enable PA_RXHSUNTERMCAP ret %d\n",
2613 uic_cmd
.command
= UIC_CMD_DME_SET
;
2614 uic_cmd
.argument1
= UIC_ARG_MIB(PA_PWRMODE
);
2615 uic_cmd
.argument3
= mode
;
2616 ufshcd_hold(hba
, false);
2617 ret
= ufshcd_uic_pwr_ctrl(hba
, &uic_cmd
);
2618 ufshcd_release(hba
);
2624 static int ufshcd_link_recovery(struct ufs_hba
*hba
)
2627 unsigned long flags
;
2629 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
2630 hba
->ufshcd_state
= UFSHCD_STATE_RESET
;
2631 ufshcd_set_eh_in_progress(hba
);
2632 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
2634 ret
= ufshcd_host_reset_and_restore(hba
);
2636 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
2638 hba
->ufshcd_state
= UFSHCD_STATE_ERROR
;
2639 ufshcd_clear_eh_in_progress(hba
);
2640 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
2643 dev_err(hba
->dev
, "%s: link recovery failed, err %d",
2649 static int __ufshcd_uic_hibern8_enter(struct ufs_hba
*hba
)
2652 struct uic_command uic_cmd
= {0};
2654 uic_cmd
.command
= UIC_CMD_DME_HIBER_ENTER
;
2655 ret
= ufshcd_uic_pwr_ctrl(hba
, &uic_cmd
);
2658 dev_err(hba
->dev
, "%s: hibern8 enter failed. ret = %d\n",
2662 * If link recovery fails then return error so that caller
2663 * don't retry the hibern8 enter again.
2665 if (ufshcd_link_recovery(hba
))
2672 static int ufshcd_uic_hibern8_enter(struct ufs_hba
*hba
)
2674 int ret
= 0, retries
;
2676 for (retries
= UIC_HIBERN8_ENTER_RETRIES
; retries
> 0; retries
--) {
2677 ret
= __ufshcd_uic_hibern8_enter(hba
);
2678 if (!ret
|| ret
== -ENOLINK
)
2685 static int ufshcd_uic_hibern8_exit(struct ufs_hba
*hba
)
2687 struct uic_command uic_cmd
= {0};
2690 uic_cmd
.command
= UIC_CMD_DME_HIBER_EXIT
;
2691 ret
= ufshcd_uic_pwr_ctrl(hba
, &uic_cmd
);
2693 dev_err(hba
->dev
, "%s: hibern8 exit failed. ret = %d\n",
2695 ret
= ufshcd_link_recovery(hba
);
2702 * ufshcd_init_pwr_info - setting the POR (power on reset)
2703 * values in hba power info
2704 * @hba: per-adapter instance
2706 static void ufshcd_init_pwr_info(struct ufs_hba
*hba
)
2708 hba
->pwr_info
.gear_rx
= UFS_PWM_G1
;
2709 hba
->pwr_info
.gear_tx
= UFS_PWM_G1
;
2710 hba
->pwr_info
.lane_rx
= 1;
2711 hba
->pwr_info
.lane_tx
= 1;
2712 hba
->pwr_info
.pwr_rx
= SLOWAUTO_MODE
;
2713 hba
->pwr_info
.pwr_tx
= SLOWAUTO_MODE
;
2714 hba
->pwr_info
.hs_rate
= 0;
2718 * ufshcd_get_max_pwr_mode - reads the max power mode negotiated with device
2719 * @hba: per-adapter instance
2721 static int ufshcd_get_max_pwr_mode(struct ufs_hba
*hba
)
2723 struct ufs_pa_layer_attr
*pwr_info
= &hba
->max_pwr_info
.info
;
2725 if (hba
->max_pwr_info
.is_valid
)
2728 pwr_info
->pwr_tx
= FASTAUTO_MODE
;
2729 pwr_info
->pwr_rx
= FASTAUTO_MODE
;
2730 pwr_info
->hs_rate
= PA_HS_MODE_B
;
2732 /* Get the connected lane count */
2733 ufshcd_dme_get(hba
, UIC_ARG_MIB(PA_CONNECTEDRXDATALANES
),
2734 &pwr_info
->lane_rx
);
2735 ufshcd_dme_get(hba
, UIC_ARG_MIB(PA_CONNECTEDTXDATALANES
),
2736 &pwr_info
->lane_tx
);
2738 if (!pwr_info
->lane_rx
|| !pwr_info
->lane_tx
) {
2739 dev_err(hba
->dev
, "%s: invalid connected lanes value. rx=%d, tx=%d\n",
2747 * First, get the maximum gears of HS speed.
2748 * If a zero value, it means there is no HSGEAR capability.
2749 * Then, get the maximum gears of PWM speed.
2751 ufshcd_dme_get(hba
, UIC_ARG_MIB(PA_MAXRXHSGEAR
), &pwr_info
->gear_rx
);
2752 if (!pwr_info
->gear_rx
) {
2753 ufshcd_dme_get(hba
, UIC_ARG_MIB(PA_MAXRXPWMGEAR
),
2754 &pwr_info
->gear_rx
);
2755 if (!pwr_info
->gear_rx
) {
2756 dev_err(hba
->dev
, "%s: invalid max pwm rx gear read = %d\n",
2757 __func__
, pwr_info
->gear_rx
);
2760 pwr_info
->pwr_rx
= SLOWAUTO_MODE
;
2763 ufshcd_dme_peer_get(hba
, UIC_ARG_MIB(PA_MAXRXHSGEAR
),
2764 &pwr_info
->gear_tx
);
2765 if (!pwr_info
->gear_tx
) {
2766 ufshcd_dme_peer_get(hba
, UIC_ARG_MIB(PA_MAXRXPWMGEAR
),
2767 &pwr_info
->gear_tx
);
2768 if (!pwr_info
->gear_tx
) {
2769 dev_err(hba
->dev
, "%s: invalid max pwm tx gear read = %d\n",
2770 __func__
, pwr_info
->gear_tx
);
2773 pwr_info
->pwr_tx
= SLOWAUTO_MODE
;
2776 hba
->max_pwr_info
.is_valid
= true;
2780 static int ufshcd_change_power_mode(struct ufs_hba
*hba
,
2781 struct ufs_pa_layer_attr
*pwr_mode
)
2785 /* if already configured to the requested pwr_mode */
2786 if (pwr_mode
->gear_rx
== hba
->pwr_info
.gear_rx
&&
2787 pwr_mode
->gear_tx
== hba
->pwr_info
.gear_tx
&&
2788 pwr_mode
->lane_rx
== hba
->pwr_info
.lane_rx
&&
2789 pwr_mode
->lane_tx
== hba
->pwr_info
.lane_tx
&&
2790 pwr_mode
->pwr_rx
== hba
->pwr_info
.pwr_rx
&&
2791 pwr_mode
->pwr_tx
== hba
->pwr_info
.pwr_tx
&&
2792 pwr_mode
->hs_rate
== hba
->pwr_info
.hs_rate
) {
2793 dev_dbg(hba
->dev
, "%s: power already configured\n", __func__
);
2798 * Configure attributes for power mode change with below.
2799 * - PA_RXGEAR, PA_ACTIVERXDATALANES, PA_RXTERMINATION,
2800 * - PA_TXGEAR, PA_ACTIVETXDATALANES, PA_TXTERMINATION,
2803 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_RXGEAR
), pwr_mode
->gear_rx
);
2804 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_ACTIVERXDATALANES
),
2806 if (pwr_mode
->pwr_rx
== FASTAUTO_MODE
||
2807 pwr_mode
->pwr_rx
== FAST_MODE
)
2808 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_RXTERMINATION
), TRUE
);
2810 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_RXTERMINATION
), FALSE
);
2812 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_TXGEAR
), pwr_mode
->gear_tx
);
2813 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_ACTIVETXDATALANES
),
2815 if (pwr_mode
->pwr_tx
== FASTAUTO_MODE
||
2816 pwr_mode
->pwr_tx
== FAST_MODE
)
2817 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_TXTERMINATION
), TRUE
);
2819 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_TXTERMINATION
), FALSE
);
2821 if (pwr_mode
->pwr_rx
== FASTAUTO_MODE
||
2822 pwr_mode
->pwr_tx
== FASTAUTO_MODE
||
2823 pwr_mode
->pwr_rx
== FAST_MODE
||
2824 pwr_mode
->pwr_tx
== FAST_MODE
)
2825 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_HSSERIES
),
2828 ret
= ufshcd_uic_change_pwr_mode(hba
, pwr_mode
->pwr_rx
<< 4
2829 | pwr_mode
->pwr_tx
);
2833 "%s: power mode change failed %d\n", __func__
, ret
);
2835 ufshcd_vops_pwr_change_notify(hba
, POST_CHANGE
, NULL
,
2838 memcpy(&hba
->pwr_info
, pwr_mode
,
2839 sizeof(struct ufs_pa_layer_attr
));
2846 * ufshcd_config_pwr_mode - configure a new power mode
2847 * @hba: per-adapter instance
2848 * @desired_pwr_mode: desired power configuration
2850 static int ufshcd_config_pwr_mode(struct ufs_hba
*hba
,
2851 struct ufs_pa_layer_attr
*desired_pwr_mode
)
2853 struct ufs_pa_layer_attr final_params
= { 0 };
2856 ret
= ufshcd_vops_pwr_change_notify(hba
, PRE_CHANGE
,
2857 desired_pwr_mode
, &final_params
);
2860 memcpy(&final_params
, desired_pwr_mode
, sizeof(final_params
));
2862 ret
= ufshcd_change_power_mode(hba
, &final_params
);
2868 * ufshcd_complete_dev_init() - checks device readiness
2869 * hba: per-adapter instance
2871 * Set fDeviceInit flag and poll until device toggles it.
2873 static int ufshcd_complete_dev_init(struct ufs_hba
*hba
)
2879 err
= ufshcd_query_flag_retry(hba
, UPIU_QUERY_OPCODE_SET_FLAG
,
2880 QUERY_FLAG_IDN_FDEVICEINIT
, NULL
);
2883 "%s setting fDeviceInit flag failed with error %d\n",
2888 /* poll for max. 1000 iterations for fDeviceInit flag to clear */
2889 for (i
= 0; i
< 1000 && !err
&& flag_res
; i
++)
2890 err
= ufshcd_query_flag_retry(hba
, UPIU_QUERY_OPCODE_READ_FLAG
,
2891 QUERY_FLAG_IDN_FDEVICEINIT
, &flag_res
);
2895 "%s reading fDeviceInit flag failed with error %d\n",
2899 "%s fDeviceInit was not cleared by the device\n",
2907 * ufshcd_make_hba_operational - Make UFS controller operational
2908 * @hba: per adapter instance
2910 * To bring UFS host controller to operational state,
2911 * 1. Enable required interrupts
2912 * 2. Configure interrupt aggregation
2913 * 3. Program UTRL and UTMRL base address
2914 * 4. Configure run-stop-registers
2916 * Returns 0 on success, non-zero value on failure
2918 static int ufshcd_make_hba_operational(struct ufs_hba
*hba
)
2923 /* Enable required interrupts */
2924 ufshcd_enable_intr(hba
, UFSHCD_ENABLE_INTRS
);
2926 /* Configure interrupt aggregation */
2927 if (ufshcd_is_intr_aggr_allowed(hba
))
2928 ufshcd_config_intr_aggr(hba
, hba
->nutrs
- 1, INT_AGGR_DEF_TO
);
2930 ufshcd_disable_intr_aggr(hba
);
2932 /* Configure UTRL and UTMRL base address registers */
2933 ufshcd_writel(hba
, lower_32_bits(hba
->utrdl_dma_addr
),
2934 REG_UTP_TRANSFER_REQ_LIST_BASE_L
);
2935 ufshcd_writel(hba
, upper_32_bits(hba
->utrdl_dma_addr
),
2936 REG_UTP_TRANSFER_REQ_LIST_BASE_H
);
2937 ufshcd_writel(hba
, lower_32_bits(hba
->utmrdl_dma_addr
),
2938 REG_UTP_TASK_REQ_LIST_BASE_L
);
2939 ufshcd_writel(hba
, upper_32_bits(hba
->utmrdl_dma_addr
),
2940 REG_UTP_TASK_REQ_LIST_BASE_H
);
2943 * Make sure base address and interrupt setup are updated before
2944 * enabling the run/stop registers below.
2949 * UCRDY, UTMRLDY and UTRLRDY bits must be 1
2951 reg
= ufshcd_readl(hba
, REG_CONTROLLER_STATUS
);
2952 if (!(ufshcd_get_lists_status(reg
))) {
2953 ufshcd_enable_run_stop_reg(hba
);
2956 "Host controller not ready to process requests");
2966 * ufshcd_hba_stop - Send controller to reset state
2967 * @hba: per adapter instance
2968 * @can_sleep: perform sleep or just spin
2970 static inline void ufshcd_hba_stop(struct ufs_hba
*hba
, bool can_sleep
)
2974 ufshcd_writel(hba
, CONTROLLER_DISABLE
, REG_CONTROLLER_ENABLE
);
2975 err
= ufshcd_wait_for_register(hba
, REG_CONTROLLER_ENABLE
,
2976 CONTROLLER_ENABLE
, CONTROLLER_DISABLE
,
2979 dev_err(hba
->dev
, "%s: Controller disable failed\n", __func__
);
2983 * ufshcd_hba_enable - initialize the controller
2984 * @hba: per adapter instance
2986 * The controller resets itself and controller firmware initialization
2987 * sequence kicks off. When controller is ready it will set
2988 * the Host Controller Enable bit to 1.
2990 * Returns 0 on success, non-zero value on failure
2992 static int ufshcd_hba_enable(struct ufs_hba
*hba
)
2997 * msleep of 1 and 5 used in this function might result in msleep(20),
2998 * but it was necessary to send the UFS FPGA to reset mode during
2999 * development and testing of this driver. msleep can be changed to
3000 * mdelay and retry count can be reduced based on the controller.
3002 if (!ufshcd_is_hba_active(hba
))
3003 /* change controller state to "reset state" */
3004 ufshcd_hba_stop(hba
, true);
3006 /* UniPro link is disabled at this point */
3007 ufshcd_set_link_off(hba
);
3009 ufshcd_vops_hce_enable_notify(hba
, PRE_CHANGE
);
3011 /* start controller initialization sequence */
3012 ufshcd_hba_start(hba
);
3015 * To initialize a UFS host controller HCE bit must be set to 1.
3016 * During initialization the HCE bit value changes from 1->0->1.
3017 * When the host controller completes initialization sequence
3018 * it sets the value of HCE bit to 1. The same HCE bit is read back
3019 * to check if the controller has completed initialization sequence.
3020 * So without this delay the value HCE = 1, set in the previous
3021 * instruction might be read back.
3022 * This delay can be changed based on the controller.
3026 /* wait for the host controller to complete initialization */
3028 while (ufshcd_is_hba_active(hba
)) {
3033 "Controller enable failed\n");
3039 /* enable UIC related interrupts */
3040 ufshcd_enable_intr(hba
, UFSHCD_UIC_MASK
);
3042 ufshcd_vops_hce_enable_notify(hba
, POST_CHANGE
);
3047 static int ufshcd_disable_tx_lcc(struct ufs_hba
*hba
, bool peer
)
3049 int tx_lanes
, i
, err
= 0;
3052 ufshcd_dme_get(hba
, UIC_ARG_MIB(PA_CONNECTEDTXDATALANES
),
3055 ufshcd_dme_peer_get(hba
, UIC_ARG_MIB(PA_CONNECTEDTXDATALANES
),
3057 for (i
= 0; i
< tx_lanes
; i
++) {
3059 err
= ufshcd_dme_set(hba
,
3060 UIC_ARG_MIB_SEL(TX_LCC_ENABLE
,
3061 UIC_ARG_MPHY_TX_GEN_SEL_INDEX(i
)),
3064 err
= ufshcd_dme_peer_set(hba
,
3065 UIC_ARG_MIB_SEL(TX_LCC_ENABLE
,
3066 UIC_ARG_MPHY_TX_GEN_SEL_INDEX(i
)),
3069 dev_err(hba
->dev
, "%s: TX LCC Disable failed, peer = %d, lane = %d, err = %d",
3070 __func__
, peer
, i
, err
);
3078 static inline int ufshcd_disable_device_tx_lcc(struct ufs_hba
*hba
)
3080 return ufshcd_disable_tx_lcc(hba
, true);
3084 * ufshcd_link_startup - Initialize unipro link startup
3085 * @hba: per adapter instance
3087 * Returns 0 for success, non-zero in case of failure
3089 static int ufshcd_link_startup(struct ufs_hba
*hba
)
3092 int retries
= DME_LINKSTARTUP_RETRIES
;
3095 ufshcd_vops_link_startup_notify(hba
, PRE_CHANGE
);
3097 ret
= ufshcd_dme_link_startup(hba
);
3099 /* check if device is detected by inter-connect layer */
3100 if (!ret
&& !ufshcd_is_device_present(hba
)) {
3101 dev_err(hba
->dev
, "%s: Device not present\n", __func__
);
3107 * DME link lost indication is only received when link is up,
3108 * but we can't be sure if the link is up until link startup
3109 * succeeds. So reset the local Uni-Pro and try again.
3111 if (ret
&& ufshcd_hba_enable(hba
))
3113 } while (ret
&& retries
--);
3116 /* failed to get the link up... retire */
3119 if (hba
->quirks
& UFSHCD_QUIRK_BROKEN_LCC
) {
3120 ret
= ufshcd_disable_device_tx_lcc(hba
);
3125 /* Include any host controller configuration via UIC commands */
3126 ret
= ufshcd_vops_link_startup_notify(hba
, POST_CHANGE
);
3130 ret
= ufshcd_make_hba_operational(hba
);
3133 dev_err(hba
->dev
, "link startup failed %d\n", ret
);
3138 * ufshcd_verify_dev_init() - Verify device initialization
3139 * @hba: per-adapter instance
3141 * Send NOP OUT UPIU and wait for NOP IN response to check whether the
3142 * device Transport Protocol (UTP) layer is ready after a reset.
3143 * If the UTP layer at the device side is not initialized, it may
3144 * not respond with NOP IN UPIU within timeout of %NOP_OUT_TIMEOUT
3145 * and we retry sending NOP OUT for %NOP_OUT_RETRIES iterations.
3147 static int ufshcd_verify_dev_init(struct ufs_hba
*hba
)
3152 ufshcd_hold(hba
, false);
3153 mutex_lock(&hba
->dev_cmd
.lock
);
3154 for (retries
= NOP_OUT_RETRIES
; retries
> 0; retries
--) {
3155 err
= ufshcd_exec_dev_cmd(hba
, DEV_CMD_TYPE_NOP
,
3158 if (!err
|| err
== -ETIMEDOUT
)
3161 dev_dbg(hba
->dev
, "%s: error %d retrying\n", __func__
, err
);
3163 mutex_unlock(&hba
->dev_cmd
.lock
);
3164 ufshcd_release(hba
);
3167 dev_err(hba
->dev
, "%s: NOP OUT failed %d\n", __func__
, err
);
3172 * ufshcd_set_queue_depth - set lun queue depth
3173 * @sdev: pointer to SCSI device
3175 * Read bLUQueueDepth value and activate scsi tagged command
3176 * queueing. For WLUN, queue depth is set to 1. For best-effort
3177 * cases (bLUQueueDepth = 0) the queue depth is set to a maximum
3178 * value that host can queue.
3180 static void ufshcd_set_queue_depth(struct scsi_device
*sdev
)
3184 struct ufs_hba
*hba
;
3186 hba
= shost_priv(sdev
->host
);
3188 lun_qdepth
= hba
->nutrs
;
3189 ret
= ufshcd_read_unit_desc_param(hba
,
3190 ufshcd_scsi_to_upiu_lun(sdev
->lun
),
3191 UNIT_DESC_PARAM_LU_Q_DEPTH
,
3193 sizeof(lun_qdepth
));
3195 /* Some WLUN doesn't support unit descriptor */
3196 if (ret
== -EOPNOTSUPP
)
3198 else if (!lun_qdepth
)
3199 /* eventually, we can figure out the real queue depth */
3200 lun_qdepth
= hba
->nutrs
;
3202 lun_qdepth
= min_t(int, lun_qdepth
, hba
->nutrs
);
3204 dev_dbg(hba
->dev
, "%s: activate tcq with queue depth %d\n",
3205 __func__
, lun_qdepth
);
3206 scsi_change_queue_depth(sdev
, lun_qdepth
);
3210 * ufshcd_get_lu_wp - returns the "b_lu_write_protect" from UNIT DESCRIPTOR
3211 * @hba: per-adapter instance
3212 * @lun: UFS device lun id
3213 * @b_lu_write_protect: pointer to buffer to hold the LU's write protect info
3215 * Returns 0 in case of success and b_lu_write_protect status would be returned
3216 * @b_lu_write_protect parameter.
3217 * Returns -ENOTSUPP if reading b_lu_write_protect is not supported.
3218 * Returns -EINVAL in case of invalid parameters passed to this function.
3220 static int ufshcd_get_lu_wp(struct ufs_hba
*hba
,
3222 u8
*b_lu_write_protect
)
3226 if (!b_lu_write_protect
)
3229 * According to UFS device spec, RPMB LU can't be write
3230 * protected so skip reading bLUWriteProtect parameter for
3231 * it. For other W-LUs, UNIT DESCRIPTOR is not available.
3233 else if (lun
>= UFS_UPIU_MAX_GENERAL_LUN
)
3236 ret
= ufshcd_read_unit_desc_param(hba
,
3238 UNIT_DESC_PARAM_LU_WR_PROTECT
,
3240 sizeof(*b_lu_write_protect
));
3245 * ufshcd_get_lu_power_on_wp_status - get LU's power on write protect
3247 * @hba: per-adapter instance
3248 * @sdev: pointer to SCSI device
3251 static inline void ufshcd_get_lu_power_on_wp_status(struct ufs_hba
*hba
,
3252 struct scsi_device
*sdev
)
3254 if (hba
->dev_info
.f_power_on_wp_en
&&
3255 !hba
->dev_info
.is_lu_power_on_wp
) {
3256 u8 b_lu_write_protect
;
3258 if (!ufshcd_get_lu_wp(hba
, ufshcd_scsi_to_upiu_lun(sdev
->lun
),
3259 &b_lu_write_protect
) &&
3260 (b_lu_write_protect
== UFS_LU_POWER_ON_WP
))
3261 hba
->dev_info
.is_lu_power_on_wp
= true;
3266 * ufshcd_slave_alloc - handle initial SCSI device configurations
3267 * @sdev: pointer to SCSI device
3271 static int ufshcd_slave_alloc(struct scsi_device
*sdev
)
3273 struct ufs_hba
*hba
;
3275 hba
= shost_priv(sdev
->host
);
3277 /* Mode sense(6) is not supported by UFS, so use Mode sense(10) */
3278 sdev
->use_10_for_ms
= 1;
3280 /* allow SCSI layer to restart the device in case of errors */
3281 sdev
->allow_restart
= 1;
3283 /* REPORT SUPPORTED OPERATION CODES is not supported */
3284 sdev
->no_report_opcodes
= 1;
3287 ufshcd_set_queue_depth(sdev
);
3289 ufshcd_get_lu_power_on_wp_status(hba
, sdev
);
3295 * ufshcd_change_queue_depth - change queue depth
3296 * @sdev: pointer to SCSI device
3297 * @depth: required depth to set
3299 * Change queue depth and make sure the max. limits are not crossed.
3301 static int ufshcd_change_queue_depth(struct scsi_device
*sdev
, int depth
)
3303 struct ufs_hba
*hba
= shost_priv(sdev
->host
);
3305 if (depth
> hba
->nutrs
)
3307 return scsi_change_queue_depth(sdev
, depth
);
3311 * ufshcd_slave_configure - adjust SCSI device configurations
3312 * @sdev: pointer to SCSI device
3314 static int ufshcd_slave_configure(struct scsi_device
*sdev
)
3316 struct request_queue
*q
= sdev
->request_queue
;
3318 blk_queue_update_dma_pad(q
, PRDT_DATA_BYTE_COUNT_PAD
- 1);
3319 blk_queue_max_segment_size(q
, PRDT_DATA_BYTE_COUNT_MAX
);
3325 * ufshcd_slave_destroy - remove SCSI device configurations
3326 * @sdev: pointer to SCSI device
3328 static void ufshcd_slave_destroy(struct scsi_device
*sdev
)
3330 struct ufs_hba
*hba
;
3332 hba
= shost_priv(sdev
->host
);
3333 /* Drop the reference as it won't be needed anymore */
3334 if (ufshcd_scsi_to_upiu_lun(sdev
->lun
) == UFS_UPIU_UFS_DEVICE_WLUN
) {
3335 unsigned long flags
;
3337 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
3338 hba
->sdev_ufs_device
= NULL
;
3339 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
3344 * ufshcd_task_req_compl - handle task management request completion
3345 * @hba: per adapter instance
3346 * @index: index of the completed request
3347 * @resp: task management service response
3349 * Returns non-zero value on error, zero on success
3351 static int ufshcd_task_req_compl(struct ufs_hba
*hba
, u32 index
, u8
*resp
)
3353 struct utp_task_req_desc
*task_req_descp
;
3354 struct utp_upiu_task_rsp
*task_rsp_upiup
;
3355 unsigned long flags
;
3359 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
3361 /* Clear completed tasks from outstanding_tasks */
3362 __clear_bit(index
, &hba
->outstanding_tasks
);
3364 task_req_descp
= hba
->utmrdl_base_addr
;
3365 ocs_value
= ufshcd_get_tmr_ocs(&task_req_descp
[index
]);
3367 if (ocs_value
== OCS_SUCCESS
) {
3368 task_rsp_upiup
= (struct utp_upiu_task_rsp
*)
3369 task_req_descp
[index
].task_rsp_upiu
;
3370 task_result
= be32_to_cpu(task_rsp_upiup
->output_param1
);
3371 task_result
= task_result
& MASK_TM_SERVICE_RESP
;
3373 *resp
= (u8
)task_result
;
3375 dev_err(hba
->dev
, "%s: failed, ocs = 0x%x\n",
3376 __func__
, ocs_value
);
3378 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
3384 * ufshcd_scsi_cmd_status - Update SCSI command result based on SCSI status
3385 * @lrb: pointer to local reference block of completed command
3386 * @scsi_status: SCSI command status
3388 * Returns value base on SCSI command status
3391 ufshcd_scsi_cmd_status(struct ufshcd_lrb
*lrbp
, int scsi_status
)
3395 switch (scsi_status
) {
3396 case SAM_STAT_CHECK_CONDITION
:
3397 ufshcd_copy_sense_data(lrbp
);
3399 result
|= DID_OK
<< 16 |
3400 COMMAND_COMPLETE
<< 8 |
3403 case SAM_STAT_TASK_SET_FULL
:
3405 case SAM_STAT_TASK_ABORTED
:
3406 ufshcd_copy_sense_data(lrbp
);
3407 result
|= scsi_status
;
3410 result
|= DID_ERROR
<< 16;
3412 } /* end of switch */
3418 * ufshcd_transfer_rsp_status - Get overall status of the response
3419 * @hba: per adapter instance
3420 * @lrb: pointer to local reference block of completed command
3422 * Returns result of the command to notify SCSI midlayer
3425 ufshcd_transfer_rsp_status(struct ufs_hba
*hba
, struct ufshcd_lrb
*lrbp
)
3431 /* overall command status of utrd */
3432 ocs
= ufshcd_get_tr_ocs(lrbp
);
3436 result
= ufshcd_get_req_rsp(lrbp
->ucd_rsp_ptr
);
3439 case UPIU_TRANSACTION_RESPONSE
:
3441 * get the response UPIU result to extract
3442 * the SCSI command status
3444 result
= ufshcd_get_rsp_upiu_result(lrbp
->ucd_rsp_ptr
);
3447 * get the result based on SCSI status response
3448 * to notify the SCSI midlayer of the command status
3450 scsi_status
= result
& MASK_SCSI_STATUS
;
3451 result
= ufshcd_scsi_cmd_status(lrbp
, scsi_status
);
3454 * Currently we are only supporting BKOPs exception
3455 * events hence we can ignore BKOPs exception event
3456 * during power management callbacks. BKOPs exception
3457 * event is not expected to be raised in runtime suspend
3458 * callback as it allows the urgent bkops.
3459 * During system suspend, we are anyway forcefully
3460 * disabling the bkops and if urgent bkops is needed
3461 * it will be enabled on system resume. Long term
3462 * solution could be to abort the system suspend if
3463 * UFS device needs urgent BKOPs.
3465 if (!hba
->pm_op_in_progress
&&
3466 ufshcd_is_exception_event(lrbp
->ucd_rsp_ptr
))
3467 schedule_work(&hba
->eeh_work
);
3469 case UPIU_TRANSACTION_REJECT_UPIU
:
3470 /* TODO: handle Reject UPIU Response */
3471 result
= DID_ERROR
<< 16;
3473 "Reject UPIU not fully implemented\n");
3476 result
= DID_ERROR
<< 16;
3478 "Unexpected request response code = %x\n",
3484 result
|= DID_ABORT
<< 16;
3486 case OCS_INVALID_COMMAND_STATUS
:
3487 result
|= DID_REQUEUE
<< 16;
3489 case OCS_INVALID_CMD_TABLE_ATTR
:
3490 case OCS_INVALID_PRDT_ATTR
:
3491 case OCS_MISMATCH_DATA_BUF_SIZE
:
3492 case OCS_MISMATCH_RESP_UPIU_SIZE
:
3493 case OCS_PEER_COMM_FAILURE
:
3494 case OCS_FATAL_ERROR
:
3496 result
|= DID_ERROR
<< 16;
3498 "OCS error from controller = %x\n", ocs
);
3500 } /* end of switch */
3506 * ufshcd_uic_cmd_compl - handle completion of uic command
3507 * @hba: per adapter instance
3508 * @intr_status: interrupt status generated by the controller
3510 static void ufshcd_uic_cmd_compl(struct ufs_hba
*hba
, u32 intr_status
)
3512 if ((intr_status
& UIC_COMMAND_COMPL
) && hba
->active_uic_cmd
) {
3513 hba
->active_uic_cmd
->argument2
|=
3514 ufshcd_get_uic_cmd_result(hba
);
3515 hba
->active_uic_cmd
->argument3
=
3516 ufshcd_get_dme_attr_val(hba
);
3517 complete(&hba
->active_uic_cmd
->done
);
3520 if ((intr_status
& UFSHCD_UIC_PWR_MASK
) && hba
->uic_async_done
)
3521 complete(hba
->uic_async_done
);
3525 * __ufshcd_transfer_req_compl - handle SCSI and query command completion
3526 * @hba: per adapter instance
3527 * @completed_reqs: requests to complete
3529 static void __ufshcd_transfer_req_compl(struct ufs_hba
*hba
,
3530 unsigned long completed_reqs
)
3532 struct ufshcd_lrb
*lrbp
;
3533 struct scsi_cmnd
*cmd
;
3537 for_each_set_bit(index
, &completed_reqs
, hba
->nutrs
) {
3538 lrbp
= &hba
->lrb
[index
];
3541 result
= ufshcd_transfer_rsp_status(hba
, lrbp
);
3542 scsi_dma_unmap(cmd
);
3543 cmd
->result
= result
;
3544 /* Mark completed command as NULL in LRB */
3546 clear_bit_unlock(index
, &hba
->lrb_in_use
);
3547 /* Do not touch lrbp after scsi done */
3548 cmd
->scsi_done(cmd
);
3549 __ufshcd_release(hba
);
3550 } else if (lrbp
->command_type
== UTP_CMD_TYPE_DEV_MANAGE
||
3551 lrbp
->command_type
== UTP_CMD_TYPE_UFS_STORAGE
) {
3552 if (hba
->dev_cmd
.complete
)
3553 complete(hba
->dev_cmd
.complete
);
3557 /* clear corresponding bits of completed commands */
3558 hba
->outstanding_reqs
^= completed_reqs
;
3560 ufshcd_clk_scaling_update_busy(hba
);
3562 /* we might have free'd some tags above */
3563 wake_up(&hba
->dev_cmd
.tag_wq
);
3567 * ufshcd_transfer_req_compl - handle SCSI and query command completion
3568 * @hba: per adapter instance
3570 static void ufshcd_transfer_req_compl(struct ufs_hba
*hba
)
3572 unsigned long completed_reqs
;
3575 /* Resetting interrupt aggregation counters first and reading the
3576 * DOOR_BELL afterward allows us to handle all the completed requests.
3577 * In order to prevent other interrupts starvation the DB is read once
3578 * after reset. The down side of this solution is the possibility of
3579 * false interrupt if device completes another request after resetting
3580 * aggregation and before reading the DB.
3582 if (ufshcd_is_intr_aggr_allowed(hba
))
3583 ufshcd_reset_intr_aggr(hba
);
3585 tr_doorbell
= ufshcd_readl(hba
, REG_UTP_TRANSFER_REQ_DOOR_BELL
);
3586 completed_reqs
= tr_doorbell
^ hba
->outstanding_reqs
;
3588 __ufshcd_transfer_req_compl(hba
, completed_reqs
);
3592 * ufshcd_disable_ee - disable exception event
3593 * @hba: per-adapter instance
3594 * @mask: exception event to disable
3596 * Disables exception event in the device so that the EVENT_ALERT
3599 * Returns zero on success, non-zero error value on failure.
3601 static int ufshcd_disable_ee(struct ufs_hba
*hba
, u16 mask
)
3606 if (!(hba
->ee_ctrl_mask
& mask
))
3609 val
= hba
->ee_ctrl_mask
& ~mask
;
3610 val
&= 0xFFFF; /* 2 bytes */
3611 err
= ufshcd_query_attr_retry(hba
, UPIU_QUERY_OPCODE_WRITE_ATTR
,
3612 QUERY_ATTR_IDN_EE_CONTROL
, 0, 0, &val
);
3614 hba
->ee_ctrl_mask
&= ~mask
;
3620 * ufshcd_enable_ee - enable exception event
3621 * @hba: per-adapter instance
3622 * @mask: exception event to enable
3624 * Enable corresponding exception event in the device to allow
3625 * device to alert host in critical scenarios.
3627 * Returns zero on success, non-zero error value on failure.
3629 static int ufshcd_enable_ee(struct ufs_hba
*hba
, u16 mask
)
3634 if (hba
->ee_ctrl_mask
& mask
)
3637 val
= hba
->ee_ctrl_mask
| mask
;
3638 val
&= 0xFFFF; /* 2 bytes */
3639 err
= ufshcd_query_attr_retry(hba
, UPIU_QUERY_OPCODE_WRITE_ATTR
,
3640 QUERY_ATTR_IDN_EE_CONTROL
, 0, 0, &val
);
3642 hba
->ee_ctrl_mask
|= mask
;
3648 * ufshcd_enable_auto_bkops - Allow device managed BKOPS
3649 * @hba: per-adapter instance
3651 * Allow device to manage background operations on its own. Enabling
3652 * this might lead to inconsistent latencies during normal data transfers
3653 * as the device is allowed to manage its own way of handling background
3656 * Returns zero on success, non-zero on failure.
3658 static int ufshcd_enable_auto_bkops(struct ufs_hba
*hba
)
3662 if (hba
->auto_bkops_enabled
)
3665 err
= ufshcd_query_flag_retry(hba
, UPIU_QUERY_OPCODE_SET_FLAG
,
3666 QUERY_FLAG_IDN_BKOPS_EN
, NULL
);
3668 dev_err(hba
->dev
, "%s: failed to enable bkops %d\n",
3673 hba
->auto_bkops_enabled
= true;
3675 /* No need of URGENT_BKOPS exception from the device */
3676 err
= ufshcd_disable_ee(hba
, MASK_EE_URGENT_BKOPS
);
3678 dev_err(hba
->dev
, "%s: failed to disable exception event %d\n",
3685 * ufshcd_disable_auto_bkops - block device in doing background operations
3686 * @hba: per-adapter instance
3688 * Disabling background operations improves command response latency but
3689 * has drawback of device moving into critical state where the device is
3690 * not-operable. Make sure to call ufshcd_enable_auto_bkops() whenever the
3691 * host is idle so that BKOPS are managed effectively without any negative
3694 * Returns zero on success, non-zero on failure.
3696 static int ufshcd_disable_auto_bkops(struct ufs_hba
*hba
)
3700 if (!hba
->auto_bkops_enabled
)
3704 * If host assisted BKOPs is to be enabled, make sure
3705 * urgent bkops exception is allowed.
3707 err
= ufshcd_enable_ee(hba
, MASK_EE_URGENT_BKOPS
);
3709 dev_err(hba
->dev
, "%s: failed to enable exception event %d\n",
3714 err
= ufshcd_query_flag_retry(hba
, UPIU_QUERY_OPCODE_CLEAR_FLAG
,
3715 QUERY_FLAG_IDN_BKOPS_EN
, NULL
);
3717 dev_err(hba
->dev
, "%s: failed to disable bkops %d\n",
3719 ufshcd_disable_ee(hba
, MASK_EE_URGENT_BKOPS
);
3723 hba
->auto_bkops_enabled
= false;
3729 * ufshcd_force_reset_auto_bkops - force enable of auto bkops
3730 * @hba: per adapter instance
3732 * After a device reset the device may toggle the BKOPS_EN flag
3733 * to default value. The s/w tracking variables should be updated
3734 * as well. Do this by forcing enable of auto bkops.
3736 static void ufshcd_force_reset_auto_bkops(struct ufs_hba
*hba
)
3738 hba
->auto_bkops_enabled
= false;
3739 hba
->ee_ctrl_mask
|= MASK_EE_URGENT_BKOPS
;
3740 ufshcd_enable_auto_bkops(hba
);
3743 static inline int ufshcd_get_bkops_status(struct ufs_hba
*hba
, u32
*status
)
3745 return ufshcd_query_attr_retry(hba
, UPIU_QUERY_OPCODE_READ_ATTR
,
3746 QUERY_ATTR_IDN_BKOPS_STATUS
, 0, 0, status
);
3750 * ufshcd_bkops_ctrl - control the auto bkops based on current bkops status
3751 * @hba: per-adapter instance
3752 * @status: bkops_status value
3754 * Read the bkops_status from the UFS device and Enable fBackgroundOpsEn
3755 * flag in the device to permit background operations if the device
3756 * bkops_status is greater than or equal to "status" argument passed to
3757 * this function, disable otherwise.
3759 * Returns 0 for success, non-zero in case of failure.
3761 * NOTE: Caller of this function can check the "hba->auto_bkops_enabled" flag
3762 * to know whether auto bkops is enabled or disabled after this function
3763 * returns control to it.
3765 static int ufshcd_bkops_ctrl(struct ufs_hba
*hba
,
3766 enum bkops_status status
)
3769 u32 curr_status
= 0;
3771 err
= ufshcd_get_bkops_status(hba
, &curr_status
);
3773 dev_err(hba
->dev
, "%s: failed to get BKOPS status %d\n",
3776 } else if (curr_status
> BKOPS_STATUS_MAX
) {
3777 dev_err(hba
->dev
, "%s: invalid BKOPS status %d\n",
3778 __func__
, curr_status
);
3783 if (curr_status
>= status
)
3784 err
= ufshcd_enable_auto_bkops(hba
);
3786 err
= ufshcd_disable_auto_bkops(hba
);
3792 * ufshcd_urgent_bkops - handle urgent bkops exception event
3793 * @hba: per-adapter instance
3795 * Enable fBackgroundOpsEn flag in the device to permit background
3798 * If BKOPs is enabled, this function returns 0, 1 if the bkops in not enabled
3799 * and negative error value for any other failure.
3801 static int ufshcd_urgent_bkops(struct ufs_hba
*hba
)
3803 return ufshcd_bkops_ctrl(hba
, hba
->urgent_bkops_lvl
);
3806 static inline int ufshcd_get_ee_status(struct ufs_hba
*hba
, u32
*status
)
3808 return ufshcd_query_attr_retry(hba
, UPIU_QUERY_OPCODE_READ_ATTR
,
3809 QUERY_ATTR_IDN_EE_STATUS
, 0, 0, status
);
3812 static void ufshcd_bkops_exception_event_handler(struct ufs_hba
*hba
)
3815 u32 curr_status
= 0;
3817 if (hba
->is_urgent_bkops_lvl_checked
)
3818 goto enable_auto_bkops
;
3820 err
= ufshcd_get_bkops_status(hba
, &curr_status
);
3822 dev_err(hba
->dev
, "%s: failed to get BKOPS status %d\n",
3828 * We are seeing that some devices are raising the urgent bkops
3829 * exception events even when BKOPS status doesn't indicate performace
3830 * impacted or critical. Handle these device by determining their urgent
3831 * bkops status at runtime.
3833 if (curr_status
< BKOPS_STATUS_PERF_IMPACT
) {
3834 dev_err(hba
->dev
, "%s: device raised urgent BKOPS exception for bkops status %d\n",
3835 __func__
, curr_status
);
3836 /* update the current status as the urgent bkops level */
3837 hba
->urgent_bkops_lvl
= curr_status
;
3838 hba
->is_urgent_bkops_lvl_checked
= true;
3842 err
= ufshcd_enable_auto_bkops(hba
);
3845 dev_err(hba
->dev
, "%s: failed to handle urgent bkops %d\n",
3850 * ufshcd_exception_event_handler - handle exceptions raised by device
3851 * @work: pointer to work data
3853 * Read bExceptionEventStatus attribute from the device and handle the
3854 * exception event accordingly.
3856 static void ufshcd_exception_event_handler(struct work_struct
*work
)
3858 struct ufs_hba
*hba
;
3861 hba
= container_of(work
, struct ufs_hba
, eeh_work
);
3863 pm_runtime_get_sync(hba
->dev
);
3864 err
= ufshcd_get_ee_status(hba
, &status
);
3866 dev_err(hba
->dev
, "%s: failed to get exception status %d\n",
3871 status
&= hba
->ee_ctrl_mask
;
3873 if (status
& MASK_EE_URGENT_BKOPS
)
3874 ufshcd_bkops_exception_event_handler(hba
);
3877 pm_runtime_put_sync(hba
->dev
);
3881 /* Complete requests that have door-bell cleared */
3882 static void ufshcd_complete_requests(struct ufs_hba
*hba
)
3884 ufshcd_transfer_req_compl(hba
);
3885 ufshcd_tmc_handler(hba
);
3889 * ufshcd_quirk_dl_nac_errors - This function checks if error handling is
3890 * to recover from the DL NAC errors or not.
3891 * @hba: per-adapter instance
3893 * Returns true if error handling is required, false otherwise
3895 static bool ufshcd_quirk_dl_nac_errors(struct ufs_hba
*hba
)
3897 unsigned long flags
;
3898 bool err_handling
= true;
3900 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
3902 * UFS_DEVICE_QUIRK_RECOVERY_FROM_DL_NAC_ERRORS only workaround the
3903 * device fatal error and/or DL NAC & REPLAY timeout errors.
3905 if (hba
->saved_err
& (CONTROLLER_FATAL_ERROR
| SYSTEM_BUS_FATAL_ERROR
))
3908 if ((hba
->saved_err
& DEVICE_FATAL_ERROR
) ||
3909 ((hba
->saved_err
& UIC_ERROR
) &&
3910 (hba
->saved_uic_err
& UFSHCD_UIC_DL_TCx_REPLAY_ERROR
)))
3913 if ((hba
->saved_err
& UIC_ERROR
) &&
3914 (hba
->saved_uic_err
& UFSHCD_UIC_DL_NAC_RECEIVED_ERROR
)) {
3917 * wait for 50ms to see if we can get any other errors or not.
3919 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
3921 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
3924 * now check if we have got any other severe errors other than
3927 if ((hba
->saved_err
& INT_FATAL_ERRORS
) ||
3928 ((hba
->saved_err
& UIC_ERROR
) &&
3929 (hba
->saved_uic_err
& ~UFSHCD_UIC_DL_NAC_RECEIVED_ERROR
)))
3933 * As DL NAC is the only error received so far, send out NOP
3934 * command to confirm if link is still active or not.
3935 * - If we don't get any response then do error recovery.
3936 * - If we get response then clear the DL NAC error bit.
3939 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
3940 err
= ufshcd_verify_dev_init(hba
);
3941 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
3946 /* Link seems to be alive hence ignore the DL NAC errors */
3947 if (hba
->saved_uic_err
== UFSHCD_UIC_DL_NAC_RECEIVED_ERROR
)
3948 hba
->saved_err
&= ~UIC_ERROR
;
3949 /* clear NAC error */
3950 hba
->saved_uic_err
&= ~UFSHCD_UIC_DL_NAC_RECEIVED_ERROR
;
3951 if (!hba
->saved_uic_err
) {
3952 err_handling
= false;
3957 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
3958 return err_handling
;
3962 * ufshcd_err_handler - handle UFS errors that require s/w attention
3963 * @work: pointer to work structure
3965 static void ufshcd_err_handler(struct work_struct
*work
)
3967 struct ufs_hba
*hba
;
3968 unsigned long flags
;
3973 bool needs_reset
= false;
3975 hba
= container_of(work
, struct ufs_hba
, eh_work
);
3977 pm_runtime_get_sync(hba
->dev
);
3978 ufshcd_hold(hba
, false);
3980 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
3981 if (hba
->ufshcd_state
== UFSHCD_STATE_RESET
)
3984 hba
->ufshcd_state
= UFSHCD_STATE_RESET
;
3985 ufshcd_set_eh_in_progress(hba
);
3987 /* Complete requests that have door-bell cleared by h/w */
3988 ufshcd_complete_requests(hba
);
3990 if (hba
->dev_quirks
& UFS_DEVICE_QUIRK_RECOVERY_FROM_DL_NAC_ERRORS
) {
3993 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
3994 /* release the lock as ufshcd_quirk_dl_nac_errors() may sleep */
3995 ret
= ufshcd_quirk_dl_nac_errors(hba
);
3996 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
3998 goto skip_err_handling
;
4000 if ((hba
->saved_err
& INT_FATAL_ERRORS
) ||
4001 ((hba
->saved_err
& UIC_ERROR
) &&
4002 (hba
->saved_uic_err
& (UFSHCD_UIC_DL_PA_INIT_ERROR
|
4003 UFSHCD_UIC_DL_NAC_RECEIVED_ERROR
|
4004 UFSHCD_UIC_DL_TCx_REPLAY_ERROR
))))
4008 * if host reset is required then skip clearing the pending
4009 * transfers forcefully because they will automatically get
4010 * cleared after link startup.
4013 goto skip_pending_xfer_clear
;
4015 /* release lock as clear command might sleep */
4016 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4017 /* Clear pending transfer requests */
4018 for_each_set_bit(tag
, &hba
->outstanding_reqs
, hba
->nutrs
) {
4019 if (ufshcd_clear_cmd(hba
, tag
)) {
4021 goto lock_skip_pending_xfer_clear
;
4025 /* Clear pending task management requests */
4026 for_each_set_bit(tag
, &hba
->outstanding_tasks
, hba
->nutmrs
) {
4027 if (ufshcd_clear_tm_cmd(hba
, tag
)) {
4029 goto lock_skip_pending_xfer_clear
;
4033 lock_skip_pending_xfer_clear
:
4034 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
4036 /* Complete the requests that are cleared by s/w */
4037 ufshcd_complete_requests(hba
);
4039 if (err_xfer
|| err_tm
)
4042 skip_pending_xfer_clear
:
4043 /* Fatal errors need reset */
4045 unsigned long max_doorbells
= (1UL << hba
->nutrs
) - 1;
4048 * ufshcd_reset_and_restore() does the link reinitialization
4049 * which will need atleast one empty doorbell slot to send the
4050 * device management commands (NOP and query commands).
4051 * If there is no slot empty at this moment then free up last
4054 if (hba
->outstanding_reqs
== max_doorbells
)
4055 __ufshcd_transfer_req_compl(hba
,
4056 (1UL << (hba
->nutrs
- 1)));
4058 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4059 err
= ufshcd_reset_and_restore(hba
);
4060 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
4062 dev_err(hba
->dev
, "%s: reset and restore failed\n",
4064 hba
->ufshcd_state
= UFSHCD_STATE_ERROR
;
4067 * Inform scsi mid-layer that we did reset and allow to handle
4068 * Unit Attention properly.
4070 scsi_report_bus_reset(hba
->host
, 0);
4072 hba
->saved_uic_err
= 0;
4077 hba
->ufshcd_state
= UFSHCD_STATE_OPERATIONAL
;
4078 if (hba
->saved_err
|| hba
->saved_uic_err
)
4079 dev_err_ratelimited(hba
->dev
, "%s: exit: saved_err 0x%x saved_uic_err 0x%x",
4080 __func__
, hba
->saved_err
, hba
->saved_uic_err
);
4083 ufshcd_clear_eh_in_progress(hba
);
4086 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4087 scsi_unblock_requests(hba
->host
);
4088 ufshcd_release(hba
);
4089 pm_runtime_put_sync(hba
->dev
);
4093 * ufshcd_update_uic_error - check and set fatal UIC error flags.
4094 * @hba: per-adapter instance
4096 static void ufshcd_update_uic_error(struct ufs_hba
*hba
)
4100 /* PA_INIT_ERROR is fatal and needs UIC reset */
4101 reg
= ufshcd_readl(hba
, REG_UIC_ERROR_CODE_DATA_LINK_LAYER
);
4102 if (reg
& UIC_DATA_LINK_LAYER_ERROR_PA_INIT
)
4103 hba
->uic_error
|= UFSHCD_UIC_DL_PA_INIT_ERROR
;
4104 else if (hba
->dev_quirks
&
4105 UFS_DEVICE_QUIRK_RECOVERY_FROM_DL_NAC_ERRORS
) {
4106 if (reg
& UIC_DATA_LINK_LAYER_ERROR_NAC_RECEIVED
)
4108 UFSHCD_UIC_DL_NAC_RECEIVED_ERROR
;
4109 else if (reg
& UIC_DATA_LINK_LAYER_ERROR_TCx_REPLAY_TIMEOUT
)
4110 hba
->uic_error
|= UFSHCD_UIC_DL_TCx_REPLAY_ERROR
;
4113 /* UIC NL/TL/DME errors needs software retry */
4114 reg
= ufshcd_readl(hba
, REG_UIC_ERROR_CODE_NETWORK_LAYER
);
4116 hba
->uic_error
|= UFSHCD_UIC_NL_ERROR
;
4118 reg
= ufshcd_readl(hba
, REG_UIC_ERROR_CODE_TRANSPORT_LAYER
);
4120 hba
->uic_error
|= UFSHCD_UIC_TL_ERROR
;
4122 reg
= ufshcd_readl(hba
, REG_UIC_ERROR_CODE_DME
);
4124 hba
->uic_error
|= UFSHCD_UIC_DME_ERROR
;
4126 dev_dbg(hba
->dev
, "%s: UIC error flags = 0x%08x\n",
4127 __func__
, hba
->uic_error
);
4131 * ufshcd_check_errors - Check for errors that need s/w attention
4132 * @hba: per-adapter instance
4134 static void ufshcd_check_errors(struct ufs_hba
*hba
)
4136 bool queue_eh_work
= false;
4138 if (hba
->errors
& INT_FATAL_ERRORS
)
4139 queue_eh_work
= true;
4141 if (hba
->errors
& UIC_ERROR
) {
4143 ufshcd_update_uic_error(hba
);
4145 queue_eh_work
= true;
4148 if (queue_eh_work
) {
4150 * update the transfer error masks to sticky bits, let's do this
4151 * irrespective of current ufshcd_state.
4153 hba
->saved_err
|= hba
->errors
;
4154 hba
->saved_uic_err
|= hba
->uic_error
;
4156 /* handle fatal errors only when link is functional */
4157 if (hba
->ufshcd_state
== UFSHCD_STATE_OPERATIONAL
) {
4158 /* block commands from scsi mid-layer */
4159 scsi_block_requests(hba
->host
);
4161 hba
->ufshcd_state
= UFSHCD_STATE_ERROR
;
4162 schedule_work(&hba
->eh_work
);
4166 * if (!queue_eh_work) -
4167 * Other errors are either non-fatal where host recovers
4168 * itself without s/w intervention or errors that will be
4169 * handled by the SCSI core layer.
4174 * ufshcd_tmc_handler - handle task management function completion
4175 * @hba: per adapter instance
4177 static void ufshcd_tmc_handler(struct ufs_hba
*hba
)
4181 tm_doorbell
= ufshcd_readl(hba
, REG_UTP_TASK_REQ_DOOR_BELL
);
4182 hba
->tm_condition
= tm_doorbell
^ hba
->outstanding_tasks
;
4183 wake_up(&hba
->tm_wq
);
4187 * ufshcd_sl_intr - Interrupt service routine
4188 * @hba: per adapter instance
4189 * @intr_status: contains interrupts generated by the controller
4191 static void ufshcd_sl_intr(struct ufs_hba
*hba
, u32 intr_status
)
4193 hba
->errors
= UFSHCD_ERROR_MASK
& intr_status
;
4195 ufshcd_check_errors(hba
);
4197 if (intr_status
& UFSHCD_UIC_MASK
)
4198 ufshcd_uic_cmd_compl(hba
, intr_status
);
4200 if (intr_status
& UTP_TASK_REQ_COMPL
)
4201 ufshcd_tmc_handler(hba
);
4203 if (intr_status
& UTP_TRANSFER_REQ_COMPL
)
4204 ufshcd_transfer_req_compl(hba
);
4208 * ufshcd_intr - Main interrupt service routine
4210 * @__hba: pointer to adapter instance
4212 * Returns IRQ_HANDLED - If interrupt is valid
4213 * IRQ_NONE - If invalid interrupt
4215 static irqreturn_t
ufshcd_intr(int irq
, void *__hba
)
4217 u32 intr_status
, enabled_intr_status
;
4218 irqreturn_t retval
= IRQ_NONE
;
4219 struct ufs_hba
*hba
= __hba
;
4221 spin_lock(hba
->host
->host_lock
);
4222 intr_status
= ufshcd_readl(hba
, REG_INTERRUPT_STATUS
);
4223 enabled_intr_status
=
4224 intr_status
& ufshcd_readl(hba
, REG_INTERRUPT_ENABLE
);
4227 ufshcd_writel(hba
, intr_status
, REG_INTERRUPT_STATUS
);
4229 if (enabled_intr_status
) {
4230 ufshcd_sl_intr(hba
, enabled_intr_status
);
4231 retval
= IRQ_HANDLED
;
4233 spin_unlock(hba
->host
->host_lock
);
4237 static int ufshcd_clear_tm_cmd(struct ufs_hba
*hba
, int tag
)
4240 u32 mask
= 1 << tag
;
4241 unsigned long flags
;
4243 if (!test_bit(tag
, &hba
->outstanding_tasks
))
4246 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
4247 ufshcd_writel(hba
, ~(1 << tag
), REG_UTP_TASK_REQ_LIST_CLEAR
);
4248 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4250 /* poll for max. 1 sec to clear door bell register by h/w */
4251 err
= ufshcd_wait_for_register(hba
,
4252 REG_UTP_TASK_REQ_DOOR_BELL
,
4253 mask
, 0, 1000, 1000, true);
4259 * ufshcd_issue_tm_cmd - issues task management commands to controller
4260 * @hba: per adapter instance
4261 * @lun_id: LUN ID to which TM command is sent
4262 * @task_id: task ID to which the TM command is applicable
4263 * @tm_function: task management function opcode
4264 * @tm_response: task management service response return value
4266 * Returns non-zero value on error, zero on success.
4268 static int ufshcd_issue_tm_cmd(struct ufs_hba
*hba
, int lun_id
, int task_id
,
4269 u8 tm_function
, u8
*tm_response
)
4271 struct utp_task_req_desc
*task_req_descp
;
4272 struct utp_upiu_task_req
*task_req_upiup
;
4273 struct Scsi_Host
*host
;
4274 unsigned long flags
;
4282 * Get free slot, sleep if slots are unavailable.
4283 * Even though we use wait_event() which sleeps indefinitely,
4284 * the maximum wait time is bounded by %TM_CMD_TIMEOUT.
4286 wait_event(hba
->tm_tag_wq
, ufshcd_get_tm_free_slot(hba
, &free_slot
));
4287 ufshcd_hold(hba
, false);
4289 spin_lock_irqsave(host
->host_lock
, flags
);
4290 task_req_descp
= hba
->utmrdl_base_addr
;
4291 task_req_descp
+= free_slot
;
4293 /* Configure task request descriptor */
4294 task_req_descp
->header
.dword_0
= cpu_to_le32(UTP_REQ_DESC_INT_CMD
);
4295 task_req_descp
->header
.dword_2
=
4296 cpu_to_le32(OCS_INVALID_COMMAND_STATUS
);
4298 /* Configure task request UPIU */
4300 (struct utp_upiu_task_req
*) task_req_descp
->task_req_upiu
;
4301 task_tag
= hba
->nutrs
+ free_slot
;
4302 task_req_upiup
->header
.dword_0
=
4303 UPIU_HEADER_DWORD(UPIU_TRANSACTION_TASK_REQ
, 0,
4305 task_req_upiup
->header
.dword_1
=
4306 UPIU_HEADER_DWORD(0, tm_function
, 0, 0);
4308 * The host shall provide the same value for LUN field in the basic
4309 * header and for Input Parameter.
4311 task_req_upiup
->input_param1
= cpu_to_be32(lun_id
);
4312 task_req_upiup
->input_param2
= cpu_to_be32(task_id
);
4314 /* send command to the controller */
4315 __set_bit(free_slot
, &hba
->outstanding_tasks
);
4317 /* Make sure descriptors are ready before ringing the task doorbell */
4320 ufshcd_writel(hba
, 1 << free_slot
, REG_UTP_TASK_REQ_DOOR_BELL
);
4322 spin_unlock_irqrestore(host
->host_lock
, flags
);
4324 /* wait until the task management command is completed */
4325 err
= wait_event_timeout(hba
->tm_wq
,
4326 test_bit(free_slot
, &hba
->tm_condition
),
4327 msecs_to_jiffies(TM_CMD_TIMEOUT
));
4329 dev_err(hba
->dev
, "%s: task management cmd 0x%.2x timed-out\n",
4330 __func__
, tm_function
);
4331 if (ufshcd_clear_tm_cmd(hba
, free_slot
))
4332 dev_WARN(hba
->dev
, "%s: unable clear tm cmd (slot %d) after timeout\n",
4333 __func__
, free_slot
);
4336 err
= ufshcd_task_req_compl(hba
, free_slot
, tm_response
);
4339 clear_bit(free_slot
, &hba
->tm_condition
);
4340 ufshcd_put_tm_slot(hba
, free_slot
);
4341 wake_up(&hba
->tm_tag_wq
);
4343 ufshcd_release(hba
);
4348 * ufshcd_eh_device_reset_handler - device reset handler registered to
4350 * @cmd: SCSI command pointer
4352 * Returns SUCCESS/FAILED
4354 static int ufshcd_eh_device_reset_handler(struct scsi_cmnd
*cmd
)
4356 struct Scsi_Host
*host
;
4357 struct ufs_hba
*hba
;
4362 struct ufshcd_lrb
*lrbp
;
4363 unsigned long flags
;
4365 host
= cmd
->device
->host
;
4366 hba
= shost_priv(host
);
4367 tag
= cmd
->request
->tag
;
4369 lrbp
= &hba
->lrb
[tag
];
4370 err
= ufshcd_issue_tm_cmd(hba
, lrbp
->lun
, 0, UFS_LOGICAL_RESET
, &resp
);
4371 if (err
|| resp
!= UPIU_TASK_MANAGEMENT_FUNC_COMPL
) {
4377 /* clear the commands that were pending for corresponding LUN */
4378 for_each_set_bit(pos
, &hba
->outstanding_reqs
, hba
->nutrs
) {
4379 if (hba
->lrb
[pos
].lun
== lrbp
->lun
) {
4380 err
= ufshcd_clear_cmd(hba
, pos
);
4385 spin_lock_irqsave(host
->host_lock
, flags
);
4386 ufshcd_transfer_req_compl(hba
);
4387 spin_unlock_irqrestore(host
->host_lock
, flags
);
4392 dev_err(hba
->dev
, "%s: failed with err %d\n", __func__
, err
);
4399 * ufshcd_abort - abort a specific command
4400 * @cmd: SCSI command pointer
4402 * Abort the pending command in device by sending UFS_ABORT_TASK task management
4403 * command, and in host controller by clearing the door-bell register. There can
4404 * be race between controller sending the command to the device while abort is
4405 * issued. To avoid that, first issue UFS_QUERY_TASK to check if the command is
4406 * really issued and then try to abort it.
4408 * Returns SUCCESS/FAILED
4410 static int ufshcd_abort(struct scsi_cmnd
*cmd
)
4412 struct Scsi_Host
*host
;
4413 struct ufs_hba
*hba
;
4414 unsigned long flags
;
4419 struct ufshcd_lrb
*lrbp
;
4422 host
= cmd
->device
->host
;
4423 hba
= shost_priv(host
);
4424 tag
= cmd
->request
->tag
;
4425 if (!ufshcd_valid_tag(hba
, tag
)) {
4427 "%s: invalid command tag %d: cmd=0x%p, cmd->request=0x%p",
4428 __func__
, tag
, cmd
, cmd
->request
);
4432 ufshcd_hold(hba
, false);
4433 reg
= ufshcd_readl(hba
, REG_UTP_TRANSFER_REQ_DOOR_BELL
);
4434 /* If command is already aborted/completed, return SUCCESS */
4435 if (!(test_bit(tag
, &hba
->outstanding_reqs
))) {
4437 "%s: cmd at tag %d already completed, outstanding=0x%lx, doorbell=0x%x\n",
4438 __func__
, tag
, hba
->outstanding_reqs
, reg
);
4442 if (!(reg
& (1 << tag
))) {
4444 "%s: cmd was completed, but without a notifying intr, tag = %d",
4448 lrbp
= &hba
->lrb
[tag
];
4449 for (poll_cnt
= 100; poll_cnt
; poll_cnt
--) {
4450 err
= ufshcd_issue_tm_cmd(hba
, lrbp
->lun
, lrbp
->task_tag
,
4451 UFS_QUERY_TASK
, &resp
);
4452 if (!err
&& resp
== UPIU_TASK_MANAGEMENT_FUNC_SUCCEEDED
) {
4453 /* cmd pending in the device */
4455 } else if (!err
&& resp
== UPIU_TASK_MANAGEMENT_FUNC_COMPL
) {
4457 * cmd not pending in the device, check if it is
4460 reg
= ufshcd_readl(hba
, REG_UTP_TRANSFER_REQ_DOOR_BELL
);
4461 if (reg
& (1 << tag
)) {
4462 /* sleep for max. 200us to stabilize */
4463 usleep_range(100, 200);
4466 /* command completed already */
4470 err
= resp
; /* service response error */
4480 err
= ufshcd_issue_tm_cmd(hba
, lrbp
->lun
, lrbp
->task_tag
,
4481 UFS_ABORT_TASK
, &resp
);
4482 if (err
|| resp
!= UPIU_TASK_MANAGEMENT_FUNC_COMPL
) {
4484 err
= resp
; /* service response error */
4488 err
= ufshcd_clear_cmd(hba
, tag
);
4492 scsi_dma_unmap(cmd
);
4494 spin_lock_irqsave(host
->host_lock
, flags
);
4495 ufshcd_outstanding_req_clear(hba
, tag
);
4496 hba
->lrb
[tag
].cmd
= NULL
;
4497 spin_unlock_irqrestore(host
->host_lock
, flags
);
4499 clear_bit_unlock(tag
, &hba
->lrb_in_use
);
4500 wake_up(&hba
->dev_cmd
.tag_wq
);
4506 dev_err(hba
->dev
, "%s: failed with err %d\n", __func__
, err
);
4511 * This ufshcd_release() corresponds to the original scsi cmd that got
4512 * aborted here (as we won't get any IRQ for it).
4514 ufshcd_release(hba
);
4519 * ufshcd_host_reset_and_restore - reset and restore host controller
4520 * @hba: per-adapter instance
4522 * Note that host controller reset may issue DME_RESET to
4523 * local and remote (device) Uni-Pro stack and the attributes
4524 * are reset to default state.
4526 * Returns zero on success, non-zero on failure
4528 static int ufshcd_host_reset_and_restore(struct ufs_hba
*hba
)
4531 unsigned long flags
;
4533 /* Reset the host controller */
4534 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
4535 ufshcd_hba_stop(hba
, false);
4536 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4538 err
= ufshcd_hba_enable(hba
);
4542 /* Establish the link again and restore the device */
4543 err
= ufshcd_probe_hba(hba
);
4545 if (!err
&& (hba
->ufshcd_state
!= UFSHCD_STATE_OPERATIONAL
))
4549 dev_err(hba
->dev
, "%s: Host init failed %d\n", __func__
, err
);
4555 * ufshcd_reset_and_restore - reset and re-initialize host/device
4556 * @hba: per-adapter instance
4558 * Reset and recover device, host and re-establish link. This
4559 * is helpful to recover the communication in fatal error conditions.
4561 * Returns zero on success, non-zero on failure
4563 static int ufshcd_reset_and_restore(struct ufs_hba
*hba
)
4566 unsigned long flags
;
4567 int retries
= MAX_HOST_RESET_RETRIES
;
4570 err
= ufshcd_host_reset_and_restore(hba
);
4571 } while (err
&& --retries
);
4574 * After reset the door-bell might be cleared, complete
4575 * outstanding requests in s/w here.
4577 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
4578 ufshcd_transfer_req_compl(hba
);
4579 ufshcd_tmc_handler(hba
);
4580 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4586 * ufshcd_eh_host_reset_handler - host reset handler registered to scsi layer
4587 * @cmd - SCSI command pointer
4589 * Returns SUCCESS/FAILED
4591 static int ufshcd_eh_host_reset_handler(struct scsi_cmnd
*cmd
)
4594 unsigned long flags
;
4595 struct ufs_hba
*hba
;
4597 hba
= shost_priv(cmd
->device
->host
);
4599 ufshcd_hold(hba
, false);
4601 * Check if there is any race with fatal error handling.
4602 * If so, wait for it to complete. Even though fatal error
4603 * handling does reset and restore in some cases, don't assume
4604 * anything out of it. We are just avoiding race here.
4607 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
4608 if (!(work_pending(&hba
->eh_work
) ||
4609 hba
->ufshcd_state
== UFSHCD_STATE_RESET
))
4611 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4612 dev_dbg(hba
->dev
, "%s: reset in progress\n", __func__
);
4613 flush_work(&hba
->eh_work
);
4616 hba
->ufshcd_state
= UFSHCD_STATE_RESET
;
4617 ufshcd_set_eh_in_progress(hba
);
4618 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4620 err
= ufshcd_reset_and_restore(hba
);
4622 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
4625 hba
->ufshcd_state
= UFSHCD_STATE_OPERATIONAL
;
4628 hba
->ufshcd_state
= UFSHCD_STATE_ERROR
;
4630 ufshcd_clear_eh_in_progress(hba
);
4631 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
4633 ufshcd_release(hba
);
4638 * ufshcd_get_max_icc_level - calculate the ICC level
4639 * @sup_curr_uA: max. current supported by the regulator
4640 * @start_scan: row at the desc table to start scan from
4641 * @buff: power descriptor buffer
4643 * Returns calculated max ICC level for specific regulator
4645 static u32
ufshcd_get_max_icc_level(int sup_curr_uA
, u32 start_scan
, char *buff
)
4652 for (i
= start_scan
; i
>= 0; i
--) {
4653 data
= be16_to_cpu(*((u16
*)(buff
+ 2*i
)));
4654 unit
= (data
& ATTR_ICC_LVL_UNIT_MASK
) >>
4655 ATTR_ICC_LVL_UNIT_OFFSET
;
4656 curr_uA
= data
& ATTR_ICC_LVL_VALUE_MASK
;
4658 case UFSHCD_NANO_AMP
:
4659 curr_uA
= curr_uA
/ 1000;
4661 case UFSHCD_MILI_AMP
:
4662 curr_uA
= curr_uA
* 1000;
4665 curr_uA
= curr_uA
* 1000 * 1000;
4667 case UFSHCD_MICRO_AMP
:
4671 if (sup_curr_uA
>= curr_uA
)
4676 pr_err("%s: Couldn't find valid icc_level = %d", __func__
, i
);
4683 * ufshcd_calc_icc_level - calculate the max ICC level
4684 * In case regulators are not initialized we'll return 0
4685 * @hba: per-adapter instance
4686 * @desc_buf: power descriptor buffer to extract ICC levels from.
4687 * @len: length of desc_buff
4689 * Returns calculated ICC level
4691 static u32
ufshcd_find_max_sup_active_icc_level(struct ufs_hba
*hba
,
4692 u8
*desc_buf
, int len
)
4696 if (!hba
->vreg_info
.vcc
|| !hba
->vreg_info
.vccq
||
4697 !hba
->vreg_info
.vccq2
) {
4699 "%s: Regulator capability was not set, actvIccLevel=%d",
4700 __func__
, icc_level
);
4704 if (hba
->vreg_info
.vcc
)
4705 icc_level
= ufshcd_get_max_icc_level(
4706 hba
->vreg_info
.vcc
->max_uA
,
4707 POWER_DESC_MAX_ACTV_ICC_LVLS
- 1,
4708 &desc_buf
[PWR_DESC_ACTIVE_LVLS_VCC_0
]);
4710 if (hba
->vreg_info
.vccq
)
4711 icc_level
= ufshcd_get_max_icc_level(
4712 hba
->vreg_info
.vccq
->max_uA
,
4714 &desc_buf
[PWR_DESC_ACTIVE_LVLS_VCCQ_0
]);
4716 if (hba
->vreg_info
.vccq2
)
4717 icc_level
= ufshcd_get_max_icc_level(
4718 hba
->vreg_info
.vccq2
->max_uA
,
4720 &desc_buf
[PWR_DESC_ACTIVE_LVLS_VCCQ2_0
]);
4725 static void ufshcd_init_icc_levels(struct ufs_hba
*hba
)
4728 int buff_len
= QUERY_DESC_POWER_MAX_SIZE
;
4729 u8 desc_buf
[QUERY_DESC_POWER_MAX_SIZE
];
4731 ret
= ufshcd_read_power_desc(hba
, desc_buf
, buff_len
);
4734 "%s: Failed reading power descriptor.len = %d ret = %d",
4735 __func__
, buff_len
, ret
);
4739 hba
->init_prefetch_data
.icc_level
=
4740 ufshcd_find_max_sup_active_icc_level(hba
,
4741 desc_buf
, buff_len
);
4742 dev_dbg(hba
->dev
, "%s: setting icc_level 0x%x",
4743 __func__
, hba
->init_prefetch_data
.icc_level
);
4745 ret
= ufshcd_query_attr_retry(hba
, UPIU_QUERY_OPCODE_WRITE_ATTR
,
4746 QUERY_ATTR_IDN_ACTIVE_ICC_LVL
, 0, 0,
4747 &hba
->init_prefetch_data
.icc_level
);
4751 "%s: Failed configuring bActiveICCLevel = %d ret = %d",
4752 __func__
, hba
->init_prefetch_data
.icc_level
, ret
);
4757 * ufshcd_scsi_add_wlus - Adds required W-LUs
4758 * @hba: per-adapter instance
4760 * UFS device specification requires the UFS devices to support 4 well known
4762 * "REPORT_LUNS" (address: 01h)
4763 * "UFS Device" (address: 50h)
4764 * "RPMB" (address: 44h)
4765 * "BOOT" (address: 30h)
4766 * UFS device's power management needs to be controlled by "POWER CONDITION"
4767 * field of SSU (START STOP UNIT) command. But this "power condition" field
4768 * will take effect only when its sent to "UFS device" well known logical unit
4769 * hence we require the scsi_device instance to represent this logical unit in
4770 * order for the UFS host driver to send the SSU command for power management.
4772 * We also require the scsi_device instance for "RPMB" (Replay Protected Memory
4773 * Block) LU so user space process can control this LU. User space may also
4774 * want to have access to BOOT LU.
4776 * This function adds scsi device instances for each of all well known LUs
4777 * (except "REPORT LUNS" LU).
4779 * Returns zero on success (all required W-LUs are added successfully),
4780 * non-zero error value on failure (if failed to add any of the required W-LU).
4782 static int ufshcd_scsi_add_wlus(struct ufs_hba
*hba
)
4785 struct scsi_device
*sdev_rpmb
;
4786 struct scsi_device
*sdev_boot
;
4788 hba
->sdev_ufs_device
= __scsi_add_device(hba
->host
, 0, 0,
4789 ufshcd_upiu_wlun_to_scsi_wlun(UFS_UPIU_UFS_DEVICE_WLUN
), NULL
);
4790 if (IS_ERR(hba
->sdev_ufs_device
)) {
4791 ret
= PTR_ERR(hba
->sdev_ufs_device
);
4792 hba
->sdev_ufs_device
= NULL
;
4795 scsi_device_put(hba
->sdev_ufs_device
);
4797 sdev_boot
= __scsi_add_device(hba
->host
, 0, 0,
4798 ufshcd_upiu_wlun_to_scsi_wlun(UFS_UPIU_BOOT_WLUN
), NULL
);
4799 if (IS_ERR(sdev_boot
)) {
4800 ret
= PTR_ERR(sdev_boot
);
4801 goto remove_sdev_ufs_device
;
4803 scsi_device_put(sdev_boot
);
4805 sdev_rpmb
= __scsi_add_device(hba
->host
, 0, 0,
4806 ufshcd_upiu_wlun_to_scsi_wlun(UFS_UPIU_RPMB_WLUN
), NULL
);
4807 if (IS_ERR(sdev_rpmb
)) {
4808 ret
= PTR_ERR(sdev_rpmb
);
4809 goto remove_sdev_boot
;
4811 scsi_device_put(sdev_rpmb
);
4815 scsi_remove_device(sdev_boot
);
4816 remove_sdev_ufs_device
:
4817 scsi_remove_device(hba
->sdev_ufs_device
);
4822 static int ufs_get_device_info(struct ufs_hba
*hba
,
4823 struct ufs_device_info
*card_data
)
4827 u8 str_desc_buf
[QUERY_DESC_STRING_MAX_SIZE
+ 1] = {0};
4828 u8 desc_buf
[QUERY_DESC_DEVICE_MAX_SIZE
];
4830 err
= ufshcd_read_device_desc(hba
, desc_buf
,
4831 QUERY_DESC_DEVICE_MAX_SIZE
);
4833 dev_err(hba
->dev
, "%s: Failed reading Device Desc. err = %d\n",
4839 * getting vendor (manufacturerID) and Bank Index in big endian
4842 card_data
->wmanufacturerid
= desc_buf
[DEVICE_DESC_PARAM_MANF_ID
] << 8 |
4843 desc_buf
[DEVICE_DESC_PARAM_MANF_ID
+ 1];
4845 model_index
= desc_buf
[DEVICE_DESC_PARAM_PRDCT_NAME
];
4847 err
= ufshcd_read_string_desc(hba
, model_index
, str_desc_buf
,
4848 QUERY_DESC_STRING_MAX_SIZE
, ASCII_STD
);
4850 dev_err(hba
->dev
, "%s: Failed reading Product Name. err = %d\n",
4855 str_desc_buf
[QUERY_DESC_STRING_MAX_SIZE
] = '\0';
4856 strlcpy(card_data
->model
, (str_desc_buf
+ QUERY_DESC_HDR_SIZE
),
4857 min_t(u8
, str_desc_buf
[QUERY_DESC_LENGTH_OFFSET
],
4860 /* Null terminate the model string */
4861 card_data
->model
[MAX_MODEL_LEN
] = '\0';
4867 void ufs_advertise_fixup_device(struct ufs_hba
*hba
)
4870 struct ufs_dev_fix
*f
;
4871 struct ufs_device_info card_data
;
4873 card_data
.wmanufacturerid
= 0;
4875 err
= ufs_get_device_info(hba
, &card_data
);
4877 dev_err(hba
->dev
, "%s: Failed getting device info. err = %d\n",
4882 for (f
= ufs_fixups
; f
->quirk
; f
++) {
4883 if (((f
->card
.wmanufacturerid
== card_data
.wmanufacturerid
) ||
4884 (f
->card
.wmanufacturerid
== UFS_ANY_VENDOR
)) &&
4885 (STR_PRFX_EQUAL(f
->card
.model
, card_data
.model
) ||
4886 !strcmp(f
->card
.model
, UFS_ANY_MODEL
)))
4887 hba
->dev_quirks
|= f
->quirk
;
4892 * ufshcd_tune_pa_tactivate - Tunes PA_TActivate of local UniPro
4893 * @hba: per-adapter instance
4895 * PA_TActivate parameter can be tuned manually if UniPro version is less than
4896 * 1.61. PA_TActivate needs to be greater than or equal to peerM-PHY's
4897 * RX_MIN_ACTIVATETIME_CAPABILITY attribute. This optimal value can help reduce
4898 * the hibern8 exit latency.
4900 * Returns zero on success, non-zero error value on failure.
4902 static int ufshcd_tune_pa_tactivate(struct ufs_hba
*hba
)
4905 u32 peer_rx_min_activatetime
= 0, tuned_pa_tactivate
;
4907 ret
= ufshcd_dme_peer_get(hba
,
4909 RX_MIN_ACTIVATETIME_CAPABILITY
,
4910 UIC_ARG_MPHY_RX_GEN_SEL_INDEX(0)),
4911 &peer_rx_min_activatetime
);
4915 /* make sure proper unit conversion is applied */
4916 tuned_pa_tactivate
=
4917 ((peer_rx_min_activatetime
* RX_MIN_ACTIVATETIME_UNIT_US
)
4918 / PA_TACTIVATE_TIME_UNIT_US
);
4919 ret
= ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_TACTIVATE
),
4920 tuned_pa_tactivate
);
4927 * ufshcd_tune_pa_hibern8time - Tunes PA_Hibern8Time of local UniPro
4928 * @hba: per-adapter instance
4930 * PA_Hibern8Time parameter can be tuned manually if UniPro version is less than
4931 * 1.61. PA_Hibern8Time needs to be maximum of local M-PHY's
4932 * TX_HIBERN8TIME_CAPABILITY & peer M-PHY's RX_HIBERN8TIME_CAPABILITY.
4933 * This optimal value can help reduce the hibern8 exit latency.
4935 * Returns zero on success, non-zero error value on failure.
4937 static int ufshcd_tune_pa_hibern8time(struct ufs_hba
*hba
)
4940 u32 local_tx_hibern8_time_cap
= 0, peer_rx_hibern8_time_cap
= 0;
4941 u32 max_hibern8_time
, tuned_pa_hibern8time
;
4943 ret
= ufshcd_dme_get(hba
,
4944 UIC_ARG_MIB_SEL(TX_HIBERN8TIME_CAPABILITY
,
4945 UIC_ARG_MPHY_TX_GEN_SEL_INDEX(0)),
4946 &local_tx_hibern8_time_cap
);
4950 ret
= ufshcd_dme_peer_get(hba
,
4951 UIC_ARG_MIB_SEL(RX_HIBERN8TIME_CAPABILITY
,
4952 UIC_ARG_MPHY_RX_GEN_SEL_INDEX(0)),
4953 &peer_rx_hibern8_time_cap
);
4957 max_hibern8_time
= max(local_tx_hibern8_time_cap
,
4958 peer_rx_hibern8_time_cap
);
4959 /* make sure proper unit conversion is applied */
4960 tuned_pa_hibern8time
= ((max_hibern8_time
* HIBERN8TIME_UNIT_US
)
4961 / PA_HIBERN8_TIME_UNIT_US
);
4962 ret
= ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_HIBERN8TIME
),
4963 tuned_pa_hibern8time
);
4968 static void ufshcd_tune_unipro_params(struct ufs_hba
*hba
)
4970 if (ufshcd_is_unipro_pa_params_tuning_req(hba
)) {
4971 ufshcd_tune_pa_tactivate(hba
);
4972 ufshcd_tune_pa_hibern8time(hba
);
4975 if (hba
->dev_quirks
& UFS_DEVICE_QUIRK_PA_TACTIVATE
)
4976 /* set 1ms timeout for PA_TACTIVATE */
4977 ufshcd_dme_set(hba
, UIC_ARG_MIB(PA_TACTIVATE
), 10);
4981 * ufshcd_probe_hba - probe hba to detect device and initialize
4982 * @hba: per-adapter instance
4984 * Execute link-startup and verify device initialization
4986 static int ufshcd_probe_hba(struct ufs_hba
*hba
)
4990 ret
= ufshcd_link_startup(hba
);
4994 ufshcd_init_pwr_info(hba
);
4996 /* set the default level for urgent bkops */
4997 hba
->urgent_bkops_lvl
= BKOPS_STATUS_PERF_IMPACT
;
4998 hba
->is_urgent_bkops_lvl_checked
= false;
5000 /* UniPro link is active now */
5001 ufshcd_set_link_active(hba
);
5003 ret
= ufshcd_verify_dev_init(hba
);
5007 ret
= ufshcd_complete_dev_init(hba
);
5011 ufs_advertise_fixup_device(hba
);
5012 ufshcd_tune_unipro_params(hba
);
5014 ret
= ufshcd_set_vccq_rail_unused(hba
,
5015 (hba
->dev_quirks
& UFS_DEVICE_NO_VCCQ
) ? true : false);
5019 /* UFS device is also active now */
5020 ufshcd_set_ufs_dev_active(hba
);
5021 ufshcd_force_reset_auto_bkops(hba
);
5022 hba
->wlun_dev_clr_ua
= true;
5024 if (ufshcd_get_max_pwr_mode(hba
)) {
5026 "%s: Failed getting max supported power mode\n",
5029 ret
= ufshcd_config_pwr_mode(hba
, &hba
->max_pwr_info
.info
);
5031 dev_err(hba
->dev
, "%s: Failed setting power mode, err = %d\n",
5035 /* set the state as operational after switching to desired gear */
5036 hba
->ufshcd_state
= UFSHCD_STATE_OPERATIONAL
;
5038 * If we are in error handling context or in power management callbacks
5039 * context, no need to scan the host
5041 if (!ufshcd_eh_in_progress(hba
) && !hba
->pm_op_in_progress
) {
5044 /* clear any previous UFS device information */
5045 memset(&hba
->dev_info
, 0, sizeof(hba
->dev_info
));
5046 if (!ufshcd_query_flag_retry(hba
, UPIU_QUERY_OPCODE_READ_FLAG
,
5047 QUERY_FLAG_IDN_PWR_ON_WPE
, &flag
))
5048 hba
->dev_info
.f_power_on_wp_en
= flag
;
5050 if (!hba
->is_init_prefetch
)
5051 ufshcd_init_icc_levels(hba
);
5053 /* Add required well known logical units to scsi mid layer */
5054 if (ufshcd_scsi_add_wlus(hba
))
5057 scsi_scan_host(hba
->host
);
5058 pm_runtime_put_sync(hba
->dev
);
5061 if (!hba
->is_init_prefetch
)
5062 hba
->is_init_prefetch
= true;
5064 /* Resume devfreq after UFS device is detected */
5065 if (ufshcd_is_clkscaling_enabled(hba
))
5066 devfreq_resume_device(hba
->devfreq
);
5070 * If we failed to initialize the device or the device is not
5071 * present, turn off the power/clocks etc.
5073 if (ret
&& !ufshcd_eh_in_progress(hba
) && !hba
->pm_op_in_progress
) {
5074 pm_runtime_put_sync(hba
->dev
);
5075 ufshcd_hba_exit(hba
);
5082 * ufshcd_async_scan - asynchronous execution for probing hba
5083 * @data: data pointer to pass to this function
5084 * @cookie: cookie data
5086 static void ufshcd_async_scan(void *data
, async_cookie_t cookie
)
5088 struct ufs_hba
*hba
= (struct ufs_hba
*)data
;
5090 ufshcd_probe_hba(hba
);
5093 static enum blk_eh_timer_return
ufshcd_eh_timed_out(struct scsi_cmnd
*scmd
)
5095 unsigned long flags
;
5096 struct Scsi_Host
*host
;
5097 struct ufs_hba
*hba
;
5101 if (!scmd
|| !scmd
->device
|| !scmd
->device
->host
)
5102 return BLK_EH_NOT_HANDLED
;
5104 host
= scmd
->device
->host
;
5105 hba
= shost_priv(host
);
5107 return BLK_EH_NOT_HANDLED
;
5109 spin_lock_irqsave(host
->host_lock
, flags
);
5111 for_each_set_bit(index
, &hba
->outstanding_reqs
, hba
->nutrs
) {
5112 if (hba
->lrb
[index
].cmd
== scmd
) {
5118 spin_unlock_irqrestore(host
->host_lock
, flags
);
5121 * Bypass SCSI error handling and reset the block layer timer if this
5122 * SCSI command was not actually dispatched to UFS driver, otherwise
5123 * let SCSI layer handle the error as usual.
5125 return found
? BLK_EH_NOT_HANDLED
: BLK_EH_RESET_TIMER
;
5128 static struct scsi_host_template ufshcd_driver_template
= {
5129 .module
= THIS_MODULE
,
5131 .proc_name
= UFSHCD
,
5132 .queuecommand
= ufshcd_queuecommand
,
5133 .slave_alloc
= ufshcd_slave_alloc
,
5134 .slave_configure
= ufshcd_slave_configure
,
5135 .slave_destroy
= ufshcd_slave_destroy
,
5136 .change_queue_depth
= ufshcd_change_queue_depth
,
5137 .eh_abort_handler
= ufshcd_abort
,
5138 .eh_device_reset_handler
= ufshcd_eh_device_reset_handler
,
5139 .eh_host_reset_handler
= ufshcd_eh_host_reset_handler
,
5140 .eh_timed_out
= ufshcd_eh_timed_out
,
5142 .sg_tablesize
= SG_ALL
,
5143 .cmd_per_lun
= UFSHCD_CMD_PER_LUN
,
5144 .can_queue
= UFSHCD_CAN_QUEUE
,
5145 .max_host_blocked
= 1,
5146 .track_queue_depth
= 1,
5149 static int ufshcd_config_vreg_load(struct device
*dev
, struct ufs_vreg
*vreg
,
5157 ret
= regulator_set_load(vreg
->reg
, ua
);
5159 dev_err(dev
, "%s: %s set load (ua=%d) failed, err=%d\n",
5160 __func__
, vreg
->name
, ua
, ret
);
5166 static inline int ufshcd_config_vreg_lpm(struct ufs_hba
*hba
,
5167 struct ufs_vreg
*vreg
)
5171 else if (vreg
->unused
)
5174 return ufshcd_config_vreg_load(hba
->dev
, vreg
,
5175 UFS_VREG_LPM_LOAD_UA
);
5178 static inline int ufshcd_config_vreg_hpm(struct ufs_hba
*hba
,
5179 struct ufs_vreg
*vreg
)
5183 else if (vreg
->unused
)
5186 return ufshcd_config_vreg_load(hba
->dev
, vreg
, vreg
->max_uA
);
5189 static int ufshcd_config_vreg(struct device
*dev
,
5190 struct ufs_vreg
*vreg
, bool on
)
5193 struct regulator
*reg
= vreg
->reg
;
5194 const char *name
= vreg
->name
;
5195 int min_uV
, uA_load
;
5199 if (regulator_count_voltages(reg
) > 0) {
5200 min_uV
= on
? vreg
->min_uV
: 0;
5201 ret
= regulator_set_voltage(reg
, min_uV
, vreg
->max_uV
);
5203 dev_err(dev
, "%s: %s set voltage failed, err=%d\n",
5204 __func__
, name
, ret
);
5208 uA_load
= on
? vreg
->max_uA
: 0;
5209 ret
= ufshcd_config_vreg_load(dev
, vreg
, uA_load
);
5217 static int ufshcd_enable_vreg(struct device
*dev
, struct ufs_vreg
*vreg
)
5223 else if (vreg
->enabled
|| vreg
->unused
)
5226 ret
= ufshcd_config_vreg(dev
, vreg
, true);
5228 ret
= regulator_enable(vreg
->reg
);
5231 vreg
->enabled
= true;
5233 dev_err(dev
, "%s: %s enable failed, err=%d\n",
5234 __func__
, vreg
->name
, ret
);
5239 static int ufshcd_disable_vreg(struct device
*dev
, struct ufs_vreg
*vreg
)
5245 else if (!vreg
->enabled
|| vreg
->unused
)
5248 ret
= regulator_disable(vreg
->reg
);
5251 /* ignore errors on applying disable config */
5252 ufshcd_config_vreg(dev
, vreg
, false);
5253 vreg
->enabled
= false;
5255 dev_err(dev
, "%s: %s disable failed, err=%d\n",
5256 __func__
, vreg
->name
, ret
);
5262 static int ufshcd_setup_vreg(struct ufs_hba
*hba
, bool on
)
5265 struct device
*dev
= hba
->dev
;
5266 struct ufs_vreg_info
*info
= &hba
->vreg_info
;
5271 ret
= ufshcd_toggle_vreg(dev
, info
->vcc
, on
);
5275 ret
= ufshcd_toggle_vreg(dev
, info
->vccq
, on
);
5279 ret
= ufshcd_toggle_vreg(dev
, info
->vccq2
, on
);
5285 ufshcd_toggle_vreg(dev
, info
->vccq2
, false);
5286 ufshcd_toggle_vreg(dev
, info
->vccq
, false);
5287 ufshcd_toggle_vreg(dev
, info
->vcc
, false);
5292 static int ufshcd_setup_hba_vreg(struct ufs_hba
*hba
, bool on
)
5294 struct ufs_vreg_info
*info
= &hba
->vreg_info
;
5297 return ufshcd_toggle_vreg(hba
->dev
, info
->vdd_hba
, on
);
5302 static int ufshcd_get_vreg(struct device
*dev
, struct ufs_vreg
*vreg
)
5309 vreg
->reg
= devm_regulator_get(dev
, vreg
->name
);
5310 if (IS_ERR(vreg
->reg
)) {
5311 ret
= PTR_ERR(vreg
->reg
);
5312 dev_err(dev
, "%s: %s get failed, err=%d\n",
5313 __func__
, vreg
->name
, ret
);
5319 static int ufshcd_init_vreg(struct ufs_hba
*hba
)
5322 struct device
*dev
= hba
->dev
;
5323 struct ufs_vreg_info
*info
= &hba
->vreg_info
;
5328 ret
= ufshcd_get_vreg(dev
, info
->vcc
);
5332 ret
= ufshcd_get_vreg(dev
, info
->vccq
);
5336 ret
= ufshcd_get_vreg(dev
, info
->vccq2
);
5341 static int ufshcd_init_hba_vreg(struct ufs_hba
*hba
)
5343 struct ufs_vreg_info
*info
= &hba
->vreg_info
;
5346 return ufshcd_get_vreg(hba
->dev
, info
->vdd_hba
);
5351 static int ufshcd_set_vccq_rail_unused(struct ufs_hba
*hba
, bool unused
)
5354 struct ufs_vreg_info
*info
= &hba
->vreg_info
;
5358 else if (!info
->vccq
)
5362 /* shut off the rail here */
5363 ret
= ufshcd_toggle_vreg(hba
->dev
, info
->vccq
, false);
5365 * Mark this rail as no longer used, so it doesn't get enabled
5369 info
->vccq
->unused
= true;
5372 * rail should have been already enabled hence just make sure
5373 * that unused flag is cleared.
5375 info
->vccq
->unused
= false;
5381 static int __ufshcd_setup_clocks(struct ufs_hba
*hba
, bool on
,
5385 struct ufs_clk_info
*clki
;
5386 struct list_head
*head
= &hba
->clk_list_head
;
5387 unsigned long flags
;
5389 if (!head
|| list_empty(head
))
5392 list_for_each_entry(clki
, head
, list
) {
5393 if (!IS_ERR_OR_NULL(clki
->clk
)) {
5394 if (skip_ref_clk
&& !strcmp(clki
->name
, "ref_clk"))
5397 if (on
&& !clki
->enabled
) {
5398 ret
= clk_prepare_enable(clki
->clk
);
5400 dev_err(hba
->dev
, "%s: %s prepare enable failed, %d\n",
5401 __func__
, clki
->name
, ret
);
5404 } else if (!on
&& clki
->enabled
) {
5405 clk_disable_unprepare(clki
->clk
);
5408 dev_dbg(hba
->dev
, "%s: clk: %s %sabled\n", __func__
,
5409 clki
->name
, on
? "en" : "dis");
5413 ret
= ufshcd_vops_setup_clocks(hba
, on
);
5416 list_for_each_entry(clki
, head
, list
) {
5417 if (!IS_ERR_OR_NULL(clki
->clk
) && clki
->enabled
)
5418 clk_disable_unprepare(clki
->clk
);
5421 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
5422 hba
->clk_gating
.state
= CLKS_ON
;
5423 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
5428 static int ufshcd_setup_clocks(struct ufs_hba
*hba
, bool on
)
5430 return __ufshcd_setup_clocks(hba
, on
, false);
5433 static int ufshcd_init_clocks(struct ufs_hba
*hba
)
5436 struct ufs_clk_info
*clki
;
5437 struct device
*dev
= hba
->dev
;
5438 struct list_head
*head
= &hba
->clk_list_head
;
5440 if (!head
|| list_empty(head
))
5443 list_for_each_entry(clki
, head
, list
) {
5447 clki
->clk
= devm_clk_get(dev
, clki
->name
);
5448 if (IS_ERR(clki
->clk
)) {
5449 ret
= PTR_ERR(clki
->clk
);
5450 dev_err(dev
, "%s: %s clk get failed, %d\n",
5451 __func__
, clki
->name
, ret
);
5455 if (clki
->max_freq
) {
5456 ret
= clk_set_rate(clki
->clk
, clki
->max_freq
);
5458 dev_err(hba
->dev
, "%s: %s clk set rate(%dHz) failed, %d\n",
5459 __func__
, clki
->name
,
5460 clki
->max_freq
, ret
);
5463 clki
->curr_freq
= clki
->max_freq
;
5465 dev_dbg(dev
, "%s: clk: %s, rate: %lu\n", __func__
,
5466 clki
->name
, clk_get_rate(clki
->clk
));
5472 static int ufshcd_variant_hba_init(struct ufs_hba
*hba
)
5479 err
= ufshcd_vops_init(hba
);
5483 err
= ufshcd_vops_setup_regulators(hba
, true);
5490 ufshcd_vops_exit(hba
);
5493 dev_err(hba
->dev
, "%s: variant %s init failed err %d\n",
5494 __func__
, ufshcd_get_var_name(hba
), err
);
5498 static void ufshcd_variant_hba_exit(struct ufs_hba
*hba
)
5503 ufshcd_vops_setup_clocks(hba
, false);
5505 ufshcd_vops_setup_regulators(hba
, false);
5507 ufshcd_vops_exit(hba
);
5510 static int ufshcd_hba_init(struct ufs_hba
*hba
)
5515 * Handle host controller power separately from the UFS device power
5516 * rails as it will help controlling the UFS host controller power
5517 * collapse easily which is different than UFS device power collapse.
5518 * Also, enable the host controller power before we go ahead with rest
5519 * of the initialization here.
5521 err
= ufshcd_init_hba_vreg(hba
);
5525 err
= ufshcd_setup_hba_vreg(hba
, true);
5529 err
= ufshcd_init_clocks(hba
);
5531 goto out_disable_hba_vreg
;
5533 err
= ufshcd_setup_clocks(hba
, true);
5535 goto out_disable_hba_vreg
;
5537 err
= ufshcd_init_vreg(hba
);
5539 goto out_disable_clks
;
5541 err
= ufshcd_setup_vreg(hba
, true);
5543 goto out_disable_clks
;
5545 err
= ufshcd_variant_hba_init(hba
);
5547 goto out_disable_vreg
;
5549 hba
->is_powered
= true;
5553 ufshcd_setup_vreg(hba
, false);
5555 ufshcd_setup_clocks(hba
, false);
5556 out_disable_hba_vreg
:
5557 ufshcd_setup_hba_vreg(hba
, false);
5562 static void ufshcd_hba_exit(struct ufs_hba
*hba
)
5564 if (hba
->is_powered
) {
5565 ufshcd_variant_hba_exit(hba
);
5566 ufshcd_setup_vreg(hba
, false);
5567 ufshcd_setup_clocks(hba
, false);
5568 ufshcd_setup_hba_vreg(hba
, false);
5569 hba
->is_powered
= false;
5574 ufshcd_send_request_sense(struct ufs_hba
*hba
, struct scsi_device
*sdp
)
5576 unsigned char cmd
[6] = {REQUEST_SENSE
,
5580 SCSI_SENSE_BUFFERSIZE
,
5585 buffer
= kzalloc(SCSI_SENSE_BUFFERSIZE
, GFP_KERNEL
);
5591 ret
= scsi_execute_req_flags(sdp
, cmd
, DMA_FROM_DEVICE
, buffer
,
5592 SCSI_SENSE_BUFFERSIZE
, NULL
,
5593 msecs_to_jiffies(1000), 3, NULL
, REQ_PM
);
5595 pr_err("%s: failed with err %d\n", __func__
, ret
);
5603 * ufshcd_set_dev_pwr_mode - sends START STOP UNIT command to set device
5605 * @hba: per adapter instance
5606 * @pwr_mode: device power mode to set
5608 * Returns 0 if requested power mode is set successfully
5609 * Returns non-zero if failed to set the requested power mode
5611 static int ufshcd_set_dev_pwr_mode(struct ufs_hba
*hba
,
5612 enum ufs_dev_pwr_mode pwr_mode
)
5614 unsigned char cmd
[6] = { START_STOP
};
5615 struct scsi_sense_hdr sshdr
;
5616 struct scsi_device
*sdp
;
5617 unsigned long flags
;
5620 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
5621 sdp
= hba
->sdev_ufs_device
;
5623 ret
= scsi_device_get(sdp
);
5624 if (!ret
&& !scsi_device_online(sdp
)) {
5626 scsi_device_put(sdp
);
5631 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
5637 * If scsi commands fail, the scsi mid-layer schedules scsi error-
5638 * handling, which would wait for host to be resumed. Since we know
5639 * we are functional while we are here, skip host resume in error
5642 hba
->host
->eh_noresume
= 1;
5643 if (hba
->wlun_dev_clr_ua
) {
5644 ret
= ufshcd_send_request_sense(hba
, sdp
);
5647 /* Unit attention condition is cleared now */
5648 hba
->wlun_dev_clr_ua
= false;
5651 cmd
[4] = pwr_mode
<< 4;
5654 * Current function would be generally called from the power management
5655 * callbacks hence set the REQ_PM flag so that it doesn't resume the
5656 * already suspended childs.
5658 ret
= scsi_execute_req_flags(sdp
, cmd
, DMA_NONE
, NULL
, 0, &sshdr
,
5659 START_STOP_TIMEOUT
, 0, NULL
, REQ_PM
);
5661 sdev_printk(KERN_WARNING
, sdp
,
5662 "START_STOP failed for power mode: %d, result %x\n",
5664 if (driver_byte(ret
) & DRIVER_SENSE
)
5665 scsi_print_sense_hdr(sdp
, NULL
, &sshdr
);
5669 hba
->curr_dev_pwr_mode
= pwr_mode
;
5671 scsi_device_put(sdp
);
5672 hba
->host
->eh_noresume
= 0;
5676 static int ufshcd_link_state_transition(struct ufs_hba
*hba
,
5677 enum uic_link_state req_link_state
,
5678 int check_for_bkops
)
5682 if (req_link_state
== hba
->uic_link_state
)
5685 if (req_link_state
== UIC_LINK_HIBERN8_STATE
) {
5686 ret
= ufshcd_uic_hibern8_enter(hba
);
5688 ufshcd_set_link_hibern8(hba
);
5693 * If autobkops is enabled, link can't be turned off because
5694 * turning off the link would also turn off the device.
5696 else if ((req_link_state
== UIC_LINK_OFF_STATE
) &&
5697 (!check_for_bkops
|| (check_for_bkops
&&
5698 !hba
->auto_bkops_enabled
))) {
5700 * Let's make sure that link is in low power mode, we are doing
5701 * this currently by putting the link in Hibern8. Otherway to
5702 * put the link in low power mode is to send the DME end point
5703 * to device and then send the DME reset command to local
5704 * unipro. But putting the link in hibern8 is much faster.
5706 ret
= ufshcd_uic_hibern8_enter(hba
);
5710 * Change controller state to "reset state" which
5711 * should also put the link in off/reset state
5713 ufshcd_hba_stop(hba
, true);
5715 * TODO: Check if we need any delay to make sure that
5716 * controller is reset
5718 ufshcd_set_link_off(hba
);
5725 static void ufshcd_vreg_set_lpm(struct ufs_hba
*hba
)
5728 * It seems some UFS devices may keep drawing more than sleep current
5729 * (atleast for 500us) from UFS rails (especially from VCCQ rail).
5730 * To avoid this situation, add 2ms delay before putting these UFS
5731 * rails in LPM mode.
5733 if (!ufshcd_is_link_active(hba
) &&
5734 hba
->dev_quirks
& UFS_DEVICE_QUIRK_DELAY_BEFORE_LPM
)
5735 usleep_range(2000, 2100);
5738 * If UFS device is either in UFS_Sleep turn off VCC rail to save some
5741 * If UFS device and link is in OFF state, all power supplies (VCC,
5742 * VCCQ, VCCQ2) can be turned off if power on write protect is not
5743 * required. If UFS link is inactive (Hibern8 or OFF state) and device
5744 * is in sleep state, put VCCQ & VCCQ2 rails in LPM mode.
5746 * Ignore the error returned by ufshcd_toggle_vreg() as device is anyway
5747 * in low power state which would save some power.
5749 if (ufshcd_is_ufs_dev_poweroff(hba
) && ufshcd_is_link_off(hba
) &&
5750 !hba
->dev_info
.is_lu_power_on_wp
) {
5751 ufshcd_setup_vreg(hba
, false);
5752 } else if (!ufshcd_is_ufs_dev_active(hba
)) {
5753 ufshcd_toggle_vreg(hba
->dev
, hba
->vreg_info
.vcc
, false);
5754 if (!ufshcd_is_link_active(hba
)) {
5755 ufshcd_config_vreg_lpm(hba
, hba
->vreg_info
.vccq
);
5756 ufshcd_config_vreg_lpm(hba
, hba
->vreg_info
.vccq2
);
5761 static int ufshcd_vreg_set_hpm(struct ufs_hba
*hba
)
5765 if (ufshcd_is_ufs_dev_poweroff(hba
) && ufshcd_is_link_off(hba
) &&
5766 !hba
->dev_info
.is_lu_power_on_wp
) {
5767 ret
= ufshcd_setup_vreg(hba
, true);
5768 } else if (!ufshcd_is_ufs_dev_active(hba
)) {
5769 ret
= ufshcd_toggle_vreg(hba
->dev
, hba
->vreg_info
.vcc
, true);
5770 if (!ret
&& !ufshcd_is_link_active(hba
)) {
5771 ret
= ufshcd_config_vreg_hpm(hba
, hba
->vreg_info
.vccq
);
5774 ret
= ufshcd_config_vreg_hpm(hba
, hba
->vreg_info
.vccq2
);
5782 ufshcd_config_vreg_lpm(hba
, hba
->vreg_info
.vccq
);
5784 ufshcd_toggle_vreg(hba
->dev
, hba
->vreg_info
.vcc
, false);
5789 static void ufshcd_hba_vreg_set_lpm(struct ufs_hba
*hba
)
5791 if (ufshcd_is_link_off(hba
))
5792 ufshcd_setup_hba_vreg(hba
, false);
5795 static void ufshcd_hba_vreg_set_hpm(struct ufs_hba
*hba
)
5797 if (ufshcd_is_link_off(hba
))
5798 ufshcd_setup_hba_vreg(hba
, true);
5802 * ufshcd_suspend - helper function for suspend operations
5803 * @hba: per adapter instance
5804 * @pm_op: desired low power operation type
5806 * This function will try to put the UFS device and link into low power
5807 * mode based on the "rpm_lvl" (Runtime PM level) or "spm_lvl"
5808 * (System PM level).
5810 * If this function is called during shutdown, it will make sure that
5811 * both UFS device and UFS link is powered off.
5813 * NOTE: UFS device & link must be active before we enter in this function.
5815 * Returns 0 for success and non-zero for failure
5817 static int ufshcd_suspend(struct ufs_hba
*hba
, enum ufs_pm_op pm_op
)
5820 enum ufs_pm_level pm_lvl
;
5821 enum ufs_dev_pwr_mode req_dev_pwr_mode
;
5822 enum uic_link_state req_link_state
;
5824 hba
->pm_op_in_progress
= 1;
5825 if (!ufshcd_is_shutdown_pm(pm_op
)) {
5826 pm_lvl
= ufshcd_is_runtime_pm(pm_op
) ?
5827 hba
->rpm_lvl
: hba
->spm_lvl
;
5828 req_dev_pwr_mode
= ufs_get_pm_lvl_to_dev_pwr_mode(pm_lvl
);
5829 req_link_state
= ufs_get_pm_lvl_to_link_pwr_state(pm_lvl
);
5831 req_dev_pwr_mode
= UFS_POWERDOWN_PWR_MODE
;
5832 req_link_state
= UIC_LINK_OFF_STATE
;
5836 * If we can't transition into any of the low power modes
5837 * just gate the clocks.
5839 ufshcd_hold(hba
, false);
5840 hba
->clk_gating
.is_suspended
= true;
5842 if (req_dev_pwr_mode
== UFS_ACTIVE_PWR_MODE
&&
5843 req_link_state
== UIC_LINK_ACTIVE_STATE
) {
5847 if ((req_dev_pwr_mode
== hba
->curr_dev_pwr_mode
) &&
5848 (req_link_state
== hba
->uic_link_state
))
5851 /* UFS device & link must be active before we enter in this function */
5852 if (!ufshcd_is_ufs_dev_active(hba
) || !ufshcd_is_link_active(hba
)) {
5857 if (ufshcd_is_runtime_pm(pm_op
)) {
5858 if (ufshcd_can_autobkops_during_suspend(hba
)) {
5860 * The device is idle with no requests in the queue,
5861 * allow background operations if bkops status shows
5862 * that performance might be impacted.
5864 ret
= ufshcd_urgent_bkops(hba
);
5868 /* make sure that auto bkops is disabled */
5869 ufshcd_disable_auto_bkops(hba
);
5873 if ((req_dev_pwr_mode
!= hba
->curr_dev_pwr_mode
) &&
5874 ((ufshcd_is_runtime_pm(pm_op
) && !hba
->auto_bkops_enabled
) ||
5875 !ufshcd_is_runtime_pm(pm_op
))) {
5876 /* ensure that bkops is disabled */
5877 ufshcd_disable_auto_bkops(hba
);
5878 ret
= ufshcd_set_dev_pwr_mode(hba
, req_dev_pwr_mode
);
5883 ret
= ufshcd_link_state_transition(hba
, req_link_state
, 1);
5885 goto set_dev_active
;
5887 ufshcd_vreg_set_lpm(hba
);
5891 * The clock scaling needs access to controller registers. Hence, Wait
5892 * for pending clock scaling work to be done before clocks are
5895 if (ufshcd_is_clkscaling_enabled(hba
)) {
5896 devfreq_suspend_device(hba
->devfreq
);
5897 hba
->clk_scaling
.window_start_t
= 0;
5900 * Call vendor specific suspend callback. As these callbacks may access
5901 * vendor specific host controller register space call them before the
5902 * host clocks are ON.
5904 ret
= ufshcd_vops_suspend(hba
, pm_op
);
5906 goto set_link_active
;
5908 ret
= ufshcd_vops_setup_clocks(hba
, false);
5912 if (!ufshcd_is_link_active(hba
))
5913 ufshcd_setup_clocks(hba
, false);
5915 /* If link is active, device ref_clk can't be switched off */
5916 __ufshcd_setup_clocks(hba
, false, true);
5918 hba
->clk_gating
.state
= CLKS_OFF
;
5920 * Disable the host irq as host controller as there won't be any
5921 * host controller transaction expected till resume.
5923 ufshcd_disable_irq(hba
);
5924 /* Put the host controller in low power mode if possible */
5925 ufshcd_hba_vreg_set_lpm(hba
);
5929 ufshcd_vops_resume(hba
, pm_op
);
5931 ufshcd_vreg_set_hpm(hba
);
5932 if (ufshcd_is_link_hibern8(hba
) && !ufshcd_uic_hibern8_exit(hba
))
5933 ufshcd_set_link_active(hba
);
5934 else if (ufshcd_is_link_off(hba
))
5935 ufshcd_host_reset_and_restore(hba
);
5937 if (!ufshcd_set_dev_pwr_mode(hba
, UFS_ACTIVE_PWR_MODE
))
5938 ufshcd_disable_auto_bkops(hba
);
5940 hba
->clk_gating
.is_suspended
= false;
5941 ufshcd_release(hba
);
5943 hba
->pm_op_in_progress
= 0;
5948 * ufshcd_resume - helper function for resume operations
5949 * @hba: per adapter instance
5950 * @pm_op: runtime PM or system PM
5952 * This function basically brings the UFS device, UniPro link and controller
5955 * Returns 0 for success and non-zero for failure
5957 static int ufshcd_resume(struct ufs_hba
*hba
, enum ufs_pm_op pm_op
)
5960 enum uic_link_state old_link_state
;
5962 hba
->pm_op_in_progress
= 1;
5963 old_link_state
= hba
->uic_link_state
;
5965 ufshcd_hba_vreg_set_hpm(hba
);
5966 /* Make sure clocks are enabled before accessing controller */
5967 ret
= ufshcd_setup_clocks(hba
, true);
5971 /* enable the host irq as host controller would be active soon */
5972 ret
= ufshcd_enable_irq(hba
);
5974 goto disable_irq_and_vops_clks
;
5976 ret
= ufshcd_vreg_set_hpm(hba
);
5978 goto disable_irq_and_vops_clks
;
5981 * Call vendor specific resume callback. As these callbacks may access
5982 * vendor specific host controller register space call them when the
5983 * host clocks are ON.
5985 ret
= ufshcd_vops_resume(hba
, pm_op
);
5989 if (ufshcd_is_link_hibern8(hba
)) {
5990 ret
= ufshcd_uic_hibern8_exit(hba
);
5992 ufshcd_set_link_active(hba
);
5994 goto vendor_suspend
;
5995 } else if (ufshcd_is_link_off(hba
)) {
5996 ret
= ufshcd_host_reset_and_restore(hba
);
5998 * ufshcd_host_reset_and_restore() should have already
5999 * set the link state as active
6001 if (ret
|| !ufshcd_is_link_active(hba
))
6002 goto vendor_suspend
;
6005 if (!ufshcd_is_ufs_dev_active(hba
)) {
6006 ret
= ufshcd_set_dev_pwr_mode(hba
, UFS_ACTIVE_PWR_MODE
);
6008 goto set_old_link_state
;
6012 * If BKOPs operations are urgently needed at this moment then
6013 * keep auto-bkops enabled or else disable it.
6015 ufshcd_urgent_bkops(hba
);
6016 hba
->clk_gating
.is_suspended
= false;
6018 if (ufshcd_is_clkscaling_enabled(hba
))
6019 devfreq_resume_device(hba
->devfreq
);
6021 /* Schedule clock gating in case of no access to UFS device yet */
6022 ufshcd_release(hba
);
6026 ufshcd_link_state_transition(hba
, old_link_state
, 0);
6028 ufshcd_vops_suspend(hba
, pm_op
);
6030 ufshcd_vreg_set_lpm(hba
);
6031 disable_irq_and_vops_clks
:
6032 ufshcd_disable_irq(hba
);
6033 ufshcd_setup_clocks(hba
, false);
6035 hba
->pm_op_in_progress
= 0;
6040 * ufshcd_system_suspend - system suspend routine
6041 * @hba: per adapter instance
6042 * @pm_op: runtime PM or system PM
6044 * Check the description of ufshcd_suspend() function for more details.
6046 * Returns 0 for success and non-zero for failure
6048 int ufshcd_system_suspend(struct ufs_hba
*hba
)
6052 if (!hba
|| !hba
->is_powered
)
6055 if (pm_runtime_suspended(hba
->dev
)) {
6056 if (hba
->rpm_lvl
== hba
->spm_lvl
)
6058 * There is possibility that device may still be in
6059 * active state during the runtime suspend.
6061 if ((ufs_get_pm_lvl_to_dev_pwr_mode(hba
->spm_lvl
) ==
6062 hba
->curr_dev_pwr_mode
) && !hba
->auto_bkops_enabled
)
6066 * UFS device and/or UFS link low power states during runtime
6067 * suspend seems to be different than what is expected during
6068 * system suspend. Hence runtime resume the devic & link and
6069 * let the system suspend low power states to take effect.
6070 * TODO: If resume takes longer time, we might have optimize
6071 * it in future by not resuming everything if possible.
6073 ret
= ufshcd_runtime_resume(hba
);
6078 ret
= ufshcd_suspend(hba
, UFS_SYSTEM_PM
);
6081 hba
->is_sys_suspended
= true;
6084 EXPORT_SYMBOL(ufshcd_system_suspend
);
6087 * ufshcd_system_resume - system resume routine
6088 * @hba: per adapter instance
6090 * Returns 0 for success and non-zero for failure
6093 int ufshcd_system_resume(struct ufs_hba
*hba
)
6095 if (!hba
|| !hba
->is_powered
|| pm_runtime_suspended(hba
->dev
))
6097 * Let the runtime resume take care of resuming
6098 * if runtime suspended.
6102 return ufshcd_resume(hba
, UFS_SYSTEM_PM
);
6104 EXPORT_SYMBOL(ufshcd_system_resume
);
6107 * ufshcd_runtime_suspend - runtime suspend routine
6108 * @hba: per adapter instance
6110 * Check the description of ufshcd_suspend() function for more details.
6112 * Returns 0 for success and non-zero for failure
6114 int ufshcd_runtime_suspend(struct ufs_hba
*hba
)
6116 if (!hba
|| !hba
->is_powered
)
6119 return ufshcd_suspend(hba
, UFS_RUNTIME_PM
);
6121 EXPORT_SYMBOL(ufshcd_runtime_suspend
);
6124 * ufshcd_runtime_resume - runtime resume routine
6125 * @hba: per adapter instance
6127 * This function basically brings the UFS device, UniPro link and controller
6128 * to active state. Following operations are done in this function:
6130 * 1. Turn on all the controller related clocks
6131 * 2. Bring the UniPro link out of Hibernate state
6132 * 3. If UFS device is in sleep state, turn ON VCC rail and bring the UFS device
6134 * 4. If auto-bkops is enabled on the device, disable it.
6136 * So following would be the possible power state after this function return
6138 * S1: UFS device in Active state with VCC rail ON
6139 * UniPro link in Active state
6140 * All the UFS/UniPro controller clocks are ON
6142 * Returns 0 for success and non-zero for failure
6144 int ufshcd_runtime_resume(struct ufs_hba
*hba
)
6146 if (!hba
|| !hba
->is_powered
)
6149 return ufshcd_resume(hba
, UFS_RUNTIME_PM
);
6151 EXPORT_SYMBOL(ufshcd_runtime_resume
);
6153 int ufshcd_runtime_idle(struct ufs_hba
*hba
)
6157 EXPORT_SYMBOL(ufshcd_runtime_idle
);
6160 * ufshcd_shutdown - shutdown routine
6161 * @hba: per adapter instance
6163 * This function would power off both UFS device and UFS link.
6165 * Returns 0 always to allow force shutdown even in case of errors.
6167 int ufshcd_shutdown(struct ufs_hba
*hba
)
6171 if (ufshcd_is_ufs_dev_poweroff(hba
) && ufshcd_is_link_off(hba
))
6174 if (pm_runtime_suspended(hba
->dev
)) {
6175 ret
= ufshcd_runtime_resume(hba
);
6180 ret
= ufshcd_suspend(hba
, UFS_SHUTDOWN_PM
);
6183 dev_err(hba
->dev
, "%s failed, err %d\n", __func__
, ret
);
6184 /* allow force shutdown even in case of errors */
6187 EXPORT_SYMBOL(ufshcd_shutdown
);
6190 * ufshcd_remove - de-allocate SCSI host and host memory space
6191 * data structure memory
6192 * @hba - per adapter instance
6194 void ufshcd_remove(struct ufs_hba
*hba
)
6196 scsi_remove_host(hba
->host
);
6197 /* disable interrupts */
6198 ufshcd_disable_intr(hba
, hba
->intr_mask
);
6199 ufshcd_hba_stop(hba
, true);
6201 scsi_host_put(hba
->host
);
6203 ufshcd_exit_clk_gating(hba
);
6204 if (ufshcd_is_clkscaling_enabled(hba
))
6205 devfreq_remove_device(hba
->devfreq
);
6206 ufshcd_hba_exit(hba
);
6208 EXPORT_SYMBOL_GPL(ufshcd_remove
);
6211 * ufshcd_dealloc_host - deallocate Host Bus Adapter (HBA)
6212 * @hba: pointer to Host Bus Adapter (HBA)
6214 void ufshcd_dealloc_host(struct ufs_hba
*hba
)
6216 scsi_host_put(hba
->host
);
6218 EXPORT_SYMBOL_GPL(ufshcd_dealloc_host
);
6221 * ufshcd_set_dma_mask - Set dma mask based on the controller
6222 * addressing capability
6223 * @hba: per adapter instance
6225 * Returns 0 for success, non-zero for failure
6227 static int ufshcd_set_dma_mask(struct ufs_hba
*hba
)
6229 if (hba
->capabilities
& MASK_64_ADDRESSING_SUPPORT
) {
6230 if (!dma_set_mask_and_coherent(hba
->dev
, DMA_BIT_MASK(64)))
6233 return dma_set_mask_and_coherent(hba
->dev
, DMA_BIT_MASK(32));
6237 * ufshcd_alloc_host - allocate Host Bus Adapter (HBA)
6238 * @dev: pointer to device handle
6239 * @hba_handle: driver private handle
6240 * Returns 0 on success, non-zero value on failure
6242 int ufshcd_alloc_host(struct device
*dev
, struct ufs_hba
**hba_handle
)
6244 struct Scsi_Host
*host
;
6245 struct ufs_hba
*hba
;
6250 "Invalid memory reference for dev is NULL\n");
6255 host
= scsi_host_alloc(&ufshcd_driver_template
,
6256 sizeof(struct ufs_hba
));
6258 dev_err(dev
, "scsi_host_alloc failed\n");
6262 hba
= shost_priv(host
);
6270 EXPORT_SYMBOL(ufshcd_alloc_host
);
6272 static int ufshcd_scale_clks(struct ufs_hba
*hba
, bool scale_up
)
6275 struct ufs_clk_info
*clki
;
6276 struct list_head
*head
= &hba
->clk_list_head
;
6278 if (!head
|| list_empty(head
))
6281 ret
= ufshcd_vops_clk_scale_notify(hba
, scale_up
, PRE_CHANGE
);
6285 list_for_each_entry(clki
, head
, list
) {
6286 if (!IS_ERR_OR_NULL(clki
->clk
)) {
6287 if (scale_up
&& clki
->max_freq
) {
6288 if (clki
->curr_freq
== clki
->max_freq
)
6290 ret
= clk_set_rate(clki
->clk
, clki
->max_freq
);
6292 dev_err(hba
->dev
, "%s: %s clk set rate(%dHz) failed, %d\n",
6293 __func__
, clki
->name
,
6294 clki
->max_freq
, ret
);
6297 clki
->curr_freq
= clki
->max_freq
;
6299 } else if (!scale_up
&& clki
->min_freq
) {
6300 if (clki
->curr_freq
== clki
->min_freq
)
6302 ret
= clk_set_rate(clki
->clk
, clki
->min_freq
);
6304 dev_err(hba
->dev
, "%s: %s clk set rate(%dHz) failed, %d\n",
6305 __func__
, clki
->name
,
6306 clki
->min_freq
, ret
);
6309 clki
->curr_freq
= clki
->min_freq
;
6312 dev_dbg(hba
->dev
, "%s: clk: %s, rate: %lu\n", __func__
,
6313 clki
->name
, clk_get_rate(clki
->clk
));
6316 ret
= ufshcd_vops_clk_scale_notify(hba
, scale_up
, POST_CHANGE
);
6322 static int ufshcd_devfreq_target(struct device
*dev
,
6323 unsigned long *freq
, u32 flags
)
6326 struct ufs_hba
*hba
= dev_get_drvdata(dev
);
6328 if (!ufshcd_is_clkscaling_enabled(hba
))
6331 if (*freq
== UINT_MAX
)
6332 err
= ufshcd_scale_clks(hba
, true);
6333 else if (*freq
== 0)
6334 err
= ufshcd_scale_clks(hba
, false);
6339 static int ufshcd_devfreq_get_dev_status(struct device
*dev
,
6340 struct devfreq_dev_status
*stat
)
6342 struct ufs_hba
*hba
= dev_get_drvdata(dev
);
6343 struct ufs_clk_scaling
*scaling
= &hba
->clk_scaling
;
6344 unsigned long flags
;
6346 if (!ufshcd_is_clkscaling_enabled(hba
))
6349 memset(stat
, 0, sizeof(*stat
));
6351 spin_lock_irqsave(hba
->host
->host_lock
, flags
);
6352 if (!scaling
->window_start_t
)
6355 if (scaling
->is_busy_started
)
6356 scaling
->tot_busy_t
+= ktime_to_us(ktime_sub(ktime_get(),
6357 scaling
->busy_start_t
));
6359 stat
->total_time
= jiffies_to_usecs((long)jiffies
-
6360 (long)scaling
->window_start_t
);
6361 stat
->busy_time
= scaling
->tot_busy_t
;
6363 scaling
->window_start_t
= jiffies
;
6364 scaling
->tot_busy_t
= 0;
6366 if (hba
->outstanding_reqs
) {
6367 scaling
->busy_start_t
= ktime_get();
6368 scaling
->is_busy_started
= true;
6370 scaling
->busy_start_t
= ktime_set(0, 0);
6371 scaling
->is_busy_started
= false;
6373 spin_unlock_irqrestore(hba
->host
->host_lock
, flags
);
6377 static struct devfreq_dev_profile ufs_devfreq_profile
= {
6379 .target
= ufshcd_devfreq_target
,
6380 .get_dev_status
= ufshcd_devfreq_get_dev_status
,
6384 * ufshcd_init - Driver initialization routine
6385 * @hba: per-adapter instance
6386 * @mmio_base: base register address
6387 * @irq: Interrupt line of device
6388 * Returns 0 on success, non-zero value on failure
6390 int ufshcd_init(struct ufs_hba
*hba
, void __iomem
*mmio_base
, unsigned int irq
)
6393 struct Scsi_Host
*host
= hba
->host
;
6394 struct device
*dev
= hba
->dev
;
6398 "Invalid memory reference for mmio_base is NULL\n");
6403 hba
->mmio_base
= mmio_base
;
6406 err
= ufshcd_hba_init(hba
);
6410 /* Read capabilities registers */
6411 ufshcd_hba_capabilities(hba
);
6413 /* Get UFS version supported by the controller */
6414 hba
->ufs_version
= ufshcd_get_ufs_version(hba
);
6416 /* Get Interrupt bit mask per version */
6417 hba
->intr_mask
= ufshcd_get_intr_mask(hba
);
6419 err
= ufshcd_set_dma_mask(hba
);
6421 dev_err(hba
->dev
, "set dma mask failed\n");
6425 /* Allocate memory for host memory space */
6426 err
= ufshcd_memory_alloc(hba
);
6428 dev_err(hba
->dev
, "Memory allocation failed\n");
6433 ufshcd_host_memory_configure(hba
);
6435 host
->can_queue
= hba
->nutrs
;
6436 host
->cmd_per_lun
= hba
->nutrs
;
6437 host
->max_id
= UFSHCD_MAX_ID
;
6438 host
->max_lun
= UFS_MAX_LUNS
;
6439 host
->max_channel
= UFSHCD_MAX_CHANNEL
;
6440 host
->unique_id
= host
->host_no
;
6441 host
->max_cmd_len
= MAX_CDB_SIZE
;
6443 hba
->max_pwr_info
.is_valid
= false;
6445 /* Initailize wait queue for task management */
6446 init_waitqueue_head(&hba
->tm_wq
);
6447 init_waitqueue_head(&hba
->tm_tag_wq
);
6449 /* Initialize work queues */
6450 INIT_WORK(&hba
->eh_work
, ufshcd_err_handler
);
6451 INIT_WORK(&hba
->eeh_work
, ufshcd_exception_event_handler
);
6453 /* Initialize UIC command mutex */
6454 mutex_init(&hba
->uic_cmd_mutex
);
6456 /* Initialize mutex for device management commands */
6457 mutex_init(&hba
->dev_cmd
.lock
);
6459 /* Initialize device management tag acquire wait queue */
6460 init_waitqueue_head(&hba
->dev_cmd
.tag_wq
);
6462 ufshcd_init_clk_gating(hba
);
6465 * In order to avoid any spurious interrupt immediately after
6466 * registering UFS controller interrupt handler, clear any pending UFS
6467 * interrupt status and disable all the UFS interrupts.
6469 ufshcd_writel(hba
, ufshcd_readl(hba
, REG_INTERRUPT_STATUS
),
6470 REG_INTERRUPT_STATUS
);
6471 ufshcd_writel(hba
, 0, REG_INTERRUPT_ENABLE
);
6473 * Make sure that UFS interrupts are disabled and any pending interrupt
6474 * status is cleared before registering UFS interrupt handler.
6478 /* IRQ registration */
6479 err
= devm_request_irq(dev
, irq
, ufshcd_intr
, IRQF_SHARED
, UFSHCD
, hba
);
6481 dev_err(hba
->dev
, "request irq failed\n");
6484 hba
->is_irq_enabled
= true;
6487 err
= scsi_add_host(host
, hba
->dev
);
6489 dev_err(hba
->dev
, "scsi_add_host failed\n");
6493 /* Host controller enable */
6494 err
= ufshcd_hba_enable(hba
);
6496 dev_err(hba
->dev
, "Host controller enable failed\n");
6497 goto out_remove_scsi_host
;
6500 if (ufshcd_is_clkscaling_enabled(hba
)) {
6501 hba
->devfreq
= devfreq_add_device(dev
, &ufs_devfreq_profile
,
6502 "simple_ondemand", NULL
);
6503 if (IS_ERR(hba
->devfreq
)) {
6504 dev_err(hba
->dev
, "Unable to register with devfreq %ld\n",
6505 PTR_ERR(hba
->devfreq
));
6506 err
= PTR_ERR(hba
->devfreq
);
6507 goto out_remove_scsi_host
;
6509 /* Suspend devfreq until the UFS device is detected */
6510 devfreq_suspend_device(hba
->devfreq
);
6511 hba
->clk_scaling
.window_start_t
= 0;
6514 /* Hold auto suspend until async scan completes */
6515 pm_runtime_get_sync(dev
);
6518 * The device-initialize-sequence hasn't been invoked yet.
6519 * Set the device to power-off state
6521 ufshcd_set_ufs_dev_poweroff(hba
);
6523 async_schedule(ufshcd_async_scan
, hba
);
6527 out_remove_scsi_host
:
6528 scsi_remove_host(hba
->host
);
6530 ufshcd_exit_clk_gating(hba
);
6532 hba
->is_irq_enabled
= false;
6533 scsi_host_put(host
);
6534 ufshcd_hba_exit(hba
);
6538 EXPORT_SYMBOL_GPL(ufshcd_init
);
6540 MODULE_AUTHOR("Santosh Yaragnavi <santosh.sy@samsung.com>");
6541 MODULE_AUTHOR("Vinayak Holikatti <h.vinayak@samsung.com>");
6542 MODULE_DESCRIPTION("Generic UFS host controller driver Core");
6543 MODULE_LICENSE("GPL");
6544 MODULE_VERSION(UFSHCD_DRIVER_VERSION
);