scsi: drop reason argument from ->change_queue_depth
[firefly-linux-kernel-4.4.55.git] / drivers / scsi / ufs / ufshcd.c
1 /*
2  * Universal Flash Storage Host controller driver Core
3  *
4  * This code is based on drivers/scsi/ufs/ufshcd.c
5  * Copyright (C) 2011-2013 Samsung India Software Operations
6  * Copyright (c) 2013-2014, The Linux Foundation. All rights reserved.
7  *
8  * Authors:
9  *      Santosh Yaraganavi <santosh.sy@samsung.com>
10  *      Vinayak Holikatti <h.vinayak@samsung.com>
11  *
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>
18  *
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.
23  *
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
34  * this program.
35  *
36  * The Linux Foundation chooses to take subject only to the GPLv2
37  * license terms, and distributes only under these terms.
38  */
39
40 #include <linux/async.h>
41 #include <linux/devfreq.h>
42
43 #include "ufshcd.h"
44 #include "unipro.h"
45
46 #define UFSHCD_ENABLE_INTRS     (UTP_TRANSFER_REQ_COMPL |\
47                                  UTP_TASK_REQ_COMPL |\
48                                  UFSHCD_ERROR_MASK)
49 /* UIC command timeout, unit: ms */
50 #define UIC_CMD_TIMEOUT 500
51
52 /* NOP OUT retries waiting for NOP IN response */
53 #define NOP_OUT_RETRIES    10
54 /* Timeout after 30 msecs if NOP OUT hangs without response */
55 #define NOP_OUT_TIMEOUT    30 /* msecs */
56
57 /* Query request retries */
58 #define QUERY_REQ_RETRIES 10
59 /* Query request timeout */
60 #define QUERY_REQ_TIMEOUT 30 /* msec */
61
62 /* Task management command timeout */
63 #define TM_CMD_TIMEOUT  100 /* msecs */
64
65 /* maximum number of link-startup retries */
66 #define DME_LINKSTARTUP_RETRIES 3
67
68 /* maximum number of reset retries before giving up */
69 #define MAX_HOST_RESET_RETRIES 5
70
71 /* Expose the flag value from utp_upiu_query.value */
72 #define MASK_QUERY_UPIU_FLAG_LOC 0xFF
73
74 /* Interrupt aggregation default timeout, unit: 40us */
75 #define INT_AGGR_DEF_TO 0x02
76
77 #define ufshcd_toggle_vreg(_dev, _vreg, _on)                            \
78         ({                                                              \
79                 int _ret;                                               \
80                 if (_on)                                                \
81                         _ret = ufshcd_enable_vreg(_dev, _vreg);         \
82                 else                                                    \
83                         _ret = ufshcd_disable_vreg(_dev, _vreg);        \
84                 _ret;                                                   \
85         })
86
87 static u32 ufs_query_desc_max_size[] = {
88         QUERY_DESC_DEVICE_MAX_SIZE,
89         QUERY_DESC_CONFIGURAION_MAX_SIZE,
90         QUERY_DESC_UNIT_MAX_SIZE,
91         QUERY_DESC_RFU_MAX_SIZE,
92         QUERY_DESC_INTERCONNECT_MAX_SIZE,
93         QUERY_DESC_STRING_MAX_SIZE,
94         QUERY_DESC_RFU_MAX_SIZE,
95         QUERY_DESC_GEOMETRY_MAZ_SIZE,
96         QUERY_DESC_POWER_MAX_SIZE,
97         QUERY_DESC_RFU_MAX_SIZE,
98 };
99
100 enum {
101         UFSHCD_MAX_CHANNEL      = 0,
102         UFSHCD_MAX_ID           = 1,
103         UFSHCD_CMD_PER_LUN      = 32,
104         UFSHCD_CAN_QUEUE        = 32,
105 };
106
107 /* UFSHCD states */
108 enum {
109         UFSHCD_STATE_RESET,
110         UFSHCD_STATE_ERROR,
111         UFSHCD_STATE_OPERATIONAL,
112 };
113
114 /* UFSHCD error handling flags */
115 enum {
116         UFSHCD_EH_IN_PROGRESS = (1 << 0),
117 };
118
119 /* UFSHCD UIC layer error flags */
120 enum {
121         UFSHCD_UIC_DL_PA_INIT_ERROR = (1 << 0), /* Data link layer error */
122         UFSHCD_UIC_NL_ERROR = (1 << 1), /* Network layer error */
123         UFSHCD_UIC_TL_ERROR = (1 << 2), /* Transport Layer error */
124         UFSHCD_UIC_DME_ERROR = (1 << 3), /* DME error */
125 };
126
127 /* Interrupt configuration options */
128 enum {
129         UFSHCD_INT_DISABLE,
130         UFSHCD_INT_ENABLE,
131         UFSHCD_INT_CLEAR,
132 };
133
134 #define ufshcd_set_eh_in_progress(h) \
135         (h->eh_flags |= UFSHCD_EH_IN_PROGRESS)
136 #define ufshcd_eh_in_progress(h) \
137         (h->eh_flags & UFSHCD_EH_IN_PROGRESS)
138 #define ufshcd_clear_eh_in_progress(h) \
139         (h->eh_flags &= ~UFSHCD_EH_IN_PROGRESS)
140
141 #define ufshcd_set_ufs_dev_active(h) \
142         ((h)->curr_dev_pwr_mode = UFS_ACTIVE_PWR_MODE)
143 #define ufshcd_set_ufs_dev_sleep(h) \
144         ((h)->curr_dev_pwr_mode = UFS_SLEEP_PWR_MODE)
145 #define ufshcd_set_ufs_dev_poweroff(h) \
146         ((h)->curr_dev_pwr_mode = UFS_POWERDOWN_PWR_MODE)
147 #define ufshcd_is_ufs_dev_active(h) \
148         ((h)->curr_dev_pwr_mode == UFS_ACTIVE_PWR_MODE)
149 #define ufshcd_is_ufs_dev_sleep(h) \
150         ((h)->curr_dev_pwr_mode == UFS_SLEEP_PWR_MODE)
151 #define ufshcd_is_ufs_dev_poweroff(h) \
152         ((h)->curr_dev_pwr_mode == UFS_POWERDOWN_PWR_MODE)
153
154 static struct ufs_pm_lvl_states ufs_pm_lvl_states[] = {
155         {UFS_ACTIVE_PWR_MODE, UIC_LINK_ACTIVE_STATE},
156         {UFS_ACTIVE_PWR_MODE, UIC_LINK_HIBERN8_STATE},
157         {UFS_SLEEP_PWR_MODE, UIC_LINK_ACTIVE_STATE},
158         {UFS_SLEEP_PWR_MODE, UIC_LINK_HIBERN8_STATE},
159         {UFS_POWERDOWN_PWR_MODE, UIC_LINK_HIBERN8_STATE},
160         {UFS_POWERDOWN_PWR_MODE, UIC_LINK_OFF_STATE},
161 };
162
163 static inline enum ufs_dev_pwr_mode
164 ufs_get_pm_lvl_to_dev_pwr_mode(enum ufs_pm_level lvl)
165 {
166         return ufs_pm_lvl_states[lvl].dev_state;
167 }
168
169 static inline enum uic_link_state
170 ufs_get_pm_lvl_to_link_pwr_state(enum ufs_pm_level lvl)
171 {
172         return ufs_pm_lvl_states[lvl].link_state;
173 }
174
175 static void ufshcd_tmc_handler(struct ufs_hba *hba);
176 static void ufshcd_async_scan(void *data, async_cookie_t cookie);
177 static int ufshcd_reset_and_restore(struct ufs_hba *hba);
178 static int ufshcd_clear_tm_cmd(struct ufs_hba *hba, int tag);
179 static void ufshcd_hba_exit(struct ufs_hba *hba);
180 static int ufshcd_probe_hba(struct ufs_hba *hba);
181 static int __ufshcd_setup_clocks(struct ufs_hba *hba, bool on,
182                                  bool skip_ref_clk);
183 static int ufshcd_setup_clocks(struct ufs_hba *hba, bool on);
184 static int ufshcd_uic_hibern8_exit(struct ufs_hba *hba);
185 static int ufshcd_uic_hibern8_enter(struct ufs_hba *hba);
186 static int ufshcd_host_reset_and_restore(struct ufs_hba *hba);
187 static irqreturn_t ufshcd_intr(int irq, void *__hba);
188 static int ufshcd_config_pwr_mode(struct ufs_hba *hba,
189                 struct ufs_pa_layer_attr *desired_pwr_mode);
190
191 static inline int ufshcd_enable_irq(struct ufs_hba *hba)
192 {
193         int ret = 0;
194
195         if (!hba->is_irq_enabled) {
196                 ret = request_irq(hba->irq, ufshcd_intr, IRQF_SHARED, UFSHCD,
197                                 hba);
198                 if (ret)
199                         dev_err(hba->dev, "%s: request_irq failed, ret=%d\n",
200                                 __func__, ret);
201                 hba->is_irq_enabled = true;
202         }
203
204         return ret;
205 }
206
207 static inline void ufshcd_disable_irq(struct ufs_hba *hba)
208 {
209         if (hba->is_irq_enabled) {
210                 free_irq(hba->irq, hba);
211                 hba->is_irq_enabled = false;
212         }
213 }
214
215 /*
216  * ufshcd_wait_for_register - wait for register value to change
217  * @hba - per-adapter interface
218  * @reg - mmio register offset
219  * @mask - mask to apply to read register value
220  * @val - wait condition
221  * @interval_us - polling interval in microsecs
222  * @timeout_ms - timeout in millisecs
223  *
224  * Returns -ETIMEDOUT on error, zero on success
225  */
226 static int ufshcd_wait_for_register(struct ufs_hba *hba, u32 reg, u32 mask,
227                 u32 val, unsigned long interval_us, unsigned long timeout_ms)
228 {
229         int err = 0;
230         unsigned long timeout = jiffies + msecs_to_jiffies(timeout_ms);
231
232         /* ignore bits that we don't intend to wait on */
233         val = val & mask;
234
235         while ((ufshcd_readl(hba, reg) & mask) != val) {
236                 /* wakeup within 50us of expiry */
237                 usleep_range(interval_us, interval_us + 50);
238
239                 if (time_after(jiffies, timeout)) {
240                         if ((ufshcd_readl(hba, reg) & mask) != val)
241                                 err = -ETIMEDOUT;
242                         break;
243                 }
244         }
245
246         return err;
247 }
248
249 /**
250  * ufshcd_get_intr_mask - Get the interrupt bit mask
251  * @hba - Pointer to adapter instance
252  *
253  * Returns interrupt bit mask per version
254  */
255 static inline u32 ufshcd_get_intr_mask(struct ufs_hba *hba)
256 {
257         if (hba->ufs_version == UFSHCI_VERSION_10)
258                 return INTERRUPT_MASK_ALL_VER_10;
259         else
260                 return INTERRUPT_MASK_ALL_VER_11;
261 }
262
263 /**
264  * ufshcd_get_ufs_version - Get the UFS version supported by the HBA
265  * @hba - Pointer to adapter instance
266  *
267  * Returns UFSHCI version supported by the controller
268  */
269 static inline u32 ufshcd_get_ufs_version(struct ufs_hba *hba)
270 {
271         return ufshcd_readl(hba, REG_UFS_VERSION);
272 }
273
274 /**
275  * ufshcd_is_device_present - Check if any device connected to
276  *                            the host controller
277  * @hba: pointer to adapter instance
278  *
279  * Returns 1 if device present, 0 if no device detected
280  */
281 static inline int ufshcd_is_device_present(struct ufs_hba *hba)
282 {
283         return (ufshcd_readl(hba, REG_CONTROLLER_STATUS) &
284                                                 DEVICE_PRESENT) ? 1 : 0;
285 }
286
287 /**
288  * ufshcd_get_tr_ocs - Get the UTRD Overall Command Status
289  * @lrb: pointer to local command reference block
290  *
291  * This function is used to get the OCS field from UTRD
292  * Returns the OCS field in the UTRD
293  */
294 static inline int ufshcd_get_tr_ocs(struct ufshcd_lrb *lrbp)
295 {
296         return le32_to_cpu(lrbp->utr_descriptor_ptr->header.dword_2) & MASK_OCS;
297 }
298
299 /**
300  * ufshcd_get_tmr_ocs - Get the UTMRD Overall Command Status
301  * @task_req_descp: pointer to utp_task_req_desc structure
302  *
303  * This function is used to get the OCS field from UTMRD
304  * Returns the OCS field in the UTMRD
305  */
306 static inline int
307 ufshcd_get_tmr_ocs(struct utp_task_req_desc *task_req_descp)
308 {
309         return le32_to_cpu(task_req_descp->header.dword_2) & MASK_OCS;
310 }
311
312 /**
313  * ufshcd_get_tm_free_slot - get a free slot for task management request
314  * @hba: per adapter instance
315  * @free_slot: pointer to variable with available slot value
316  *
317  * Get a free tag and lock it until ufshcd_put_tm_slot() is called.
318  * Returns 0 if free slot is not available, else return 1 with tag value
319  * in @free_slot.
320  */
321 static bool ufshcd_get_tm_free_slot(struct ufs_hba *hba, int *free_slot)
322 {
323         int tag;
324         bool ret = false;
325
326         if (!free_slot)
327                 goto out;
328
329         do {
330                 tag = find_first_zero_bit(&hba->tm_slots_in_use, hba->nutmrs);
331                 if (tag >= hba->nutmrs)
332                         goto out;
333         } while (test_and_set_bit_lock(tag, &hba->tm_slots_in_use));
334
335         *free_slot = tag;
336         ret = true;
337 out:
338         return ret;
339 }
340
341 static inline void ufshcd_put_tm_slot(struct ufs_hba *hba, int slot)
342 {
343         clear_bit_unlock(slot, &hba->tm_slots_in_use);
344 }
345
346 /**
347  * ufshcd_utrl_clear - Clear a bit in UTRLCLR register
348  * @hba: per adapter instance
349  * @pos: position of the bit to be cleared
350  */
351 static inline void ufshcd_utrl_clear(struct ufs_hba *hba, u32 pos)
352 {
353         ufshcd_writel(hba, ~(1 << pos), REG_UTP_TRANSFER_REQ_LIST_CLEAR);
354 }
355
356 /**
357  * ufshcd_get_lists_status - Check UCRDY, UTRLRDY and UTMRLRDY
358  * @reg: Register value of host controller status
359  *
360  * Returns integer, 0 on Success and positive value if failed
361  */
362 static inline int ufshcd_get_lists_status(u32 reg)
363 {
364         /*
365          * The mask 0xFF is for the following HCS register bits
366          * Bit          Description
367          *  0           Device Present
368          *  1           UTRLRDY
369          *  2           UTMRLRDY
370          *  3           UCRDY
371          *  4           HEI
372          *  5           DEI
373          * 6-7          reserved
374          */
375         return (((reg) & (0xFF)) >> 1) ^ (0x07);
376 }
377
378 /**
379  * ufshcd_get_uic_cmd_result - Get the UIC command result
380  * @hba: Pointer to adapter instance
381  *
382  * This function gets the result of UIC command completion
383  * Returns 0 on success, non zero value on error
384  */
385 static inline int ufshcd_get_uic_cmd_result(struct ufs_hba *hba)
386 {
387         return ufshcd_readl(hba, REG_UIC_COMMAND_ARG_2) &
388                MASK_UIC_COMMAND_RESULT;
389 }
390
391 /**
392  * ufshcd_get_dme_attr_val - Get the value of attribute returned by UIC command
393  * @hba: Pointer to adapter instance
394  *
395  * This function gets UIC command argument3
396  * Returns 0 on success, non zero value on error
397  */
398 static inline u32 ufshcd_get_dme_attr_val(struct ufs_hba *hba)
399 {
400         return ufshcd_readl(hba, REG_UIC_COMMAND_ARG_3);
401 }
402
403 /**
404  * ufshcd_get_req_rsp - returns the TR response transaction type
405  * @ucd_rsp_ptr: pointer to response UPIU
406  */
407 static inline int
408 ufshcd_get_req_rsp(struct utp_upiu_rsp *ucd_rsp_ptr)
409 {
410         return be32_to_cpu(ucd_rsp_ptr->header.dword_0) >> 24;
411 }
412
413 /**
414  * ufshcd_get_rsp_upiu_result - Get the result from response UPIU
415  * @ucd_rsp_ptr: pointer to response UPIU
416  *
417  * This function gets the response status and scsi_status from response UPIU
418  * Returns the response result code.
419  */
420 static inline int
421 ufshcd_get_rsp_upiu_result(struct utp_upiu_rsp *ucd_rsp_ptr)
422 {
423         return be32_to_cpu(ucd_rsp_ptr->header.dword_1) & MASK_RSP_UPIU_RESULT;
424 }
425
426 /*
427  * ufshcd_get_rsp_upiu_data_seg_len - Get the data segment length
428  *                              from response UPIU
429  * @ucd_rsp_ptr: pointer to response UPIU
430  *
431  * Return the data segment length.
432  */
433 static inline unsigned int
434 ufshcd_get_rsp_upiu_data_seg_len(struct utp_upiu_rsp *ucd_rsp_ptr)
435 {
436         return be32_to_cpu(ucd_rsp_ptr->header.dword_2) &
437                 MASK_RSP_UPIU_DATA_SEG_LEN;
438 }
439
440 /**
441  * ufshcd_is_exception_event - Check if the device raised an exception event
442  * @ucd_rsp_ptr: pointer to response UPIU
443  *
444  * The function checks if the device raised an exception event indicated in
445  * the Device Information field of response UPIU.
446  *
447  * Returns true if exception is raised, false otherwise.
448  */
449 static inline bool ufshcd_is_exception_event(struct utp_upiu_rsp *ucd_rsp_ptr)
450 {
451         return be32_to_cpu(ucd_rsp_ptr->header.dword_2) &
452                         MASK_RSP_EXCEPTION_EVENT ? true : false;
453 }
454
455 /**
456  * ufshcd_reset_intr_aggr - Reset interrupt aggregation values.
457  * @hba: per adapter instance
458  */
459 static inline void
460 ufshcd_reset_intr_aggr(struct ufs_hba *hba)
461 {
462         ufshcd_writel(hba, INT_AGGR_ENABLE |
463                       INT_AGGR_COUNTER_AND_TIMER_RESET,
464                       REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL);
465 }
466
467 /**
468  * ufshcd_config_intr_aggr - Configure interrupt aggregation values.
469  * @hba: per adapter instance
470  * @cnt: Interrupt aggregation counter threshold
471  * @tmout: Interrupt aggregation timeout value
472  */
473 static inline void
474 ufshcd_config_intr_aggr(struct ufs_hba *hba, u8 cnt, u8 tmout)
475 {
476         ufshcd_writel(hba, INT_AGGR_ENABLE | INT_AGGR_PARAM_WRITE |
477                       INT_AGGR_COUNTER_THLD_VAL(cnt) |
478                       INT_AGGR_TIMEOUT_VAL(tmout),
479                       REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL);
480 }
481
482 /**
483  * ufshcd_enable_run_stop_reg - Enable run-stop registers,
484  *                      When run-stop registers are set to 1, it indicates the
485  *                      host controller that it can process the requests
486  * @hba: per adapter instance
487  */
488 static void ufshcd_enable_run_stop_reg(struct ufs_hba *hba)
489 {
490         ufshcd_writel(hba, UTP_TASK_REQ_LIST_RUN_STOP_BIT,
491                       REG_UTP_TASK_REQ_LIST_RUN_STOP);
492         ufshcd_writel(hba, UTP_TRANSFER_REQ_LIST_RUN_STOP_BIT,
493                       REG_UTP_TRANSFER_REQ_LIST_RUN_STOP);
494 }
495
496 /**
497  * ufshcd_hba_start - Start controller initialization sequence
498  * @hba: per adapter instance
499  */
500 static inline void ufshcd_hba_start(struct ufs_hba *hba)
501 {
502         ufshcd_writel(hba, CONTROLLER_ENABLE, REG_CONTROLLER_ENABLE);
503 }
504
505 /**
506  * ufshcd_is_hba_active - Get controller state
507  * @hba: per adapter instance
508  *
509  * Returns zero if controller is active, 1 otherwise
510  */
511 static inline int ufshcd_is_hba_active(struct ufs_hba *hba)
512 {
513         return (ufshcd_readl(hba, REG_CONTROLLER_ENABLE) & 0x1) ? 0 : 1;
514 }
515
516 static void ufshcd_ungate_work(struct work_struct *work)
517 {
518         int ret;
519         unsigned long flags;
520         struct ufs_hba *hba = container_of(work, struct ufs_hba,
521                         clk_gating.ungate_work);
522
523         cancel_delayed_work_sync(&hba->clk_gating.gate_work);
524
525         spin_lock_irqsave(hba->host->host_lock, flags);
526         if (hba->clk_gating.state == CLKS_ON) {
527                 spin_unlock_irqrestore(hba->host->host_lock, flags);
528                 goto unblock_reqs;
529         }
530
531         spin_unlock_irqrestore(hba->host->host_lock, flags);
532         ufshcd_setup_clocks(hba, true);
533
534         /* Exit from hibern8 */
535         if (ufshcd_can_hibern8_during_gating(hba)) {
536                 /* Prevent gating in this path */
537                 hba->clk_gating.is_suspended = true;
538                 if (ufshcd_is_link_hibern8(hba)) {
539                         ret = ufshcd_uic_hibern8_exit(hba);
540                         if (ret)
541                                 dev_err(hba->dev, "%s: hibern8 exit failed %d\n",
542                                         __func__, ret);
543                         else
544                                 ufshcd_set_link_active(hba);
545                 }
546                 hba->clk_gating.is_suspended = false;
547         }
548 unblock_reqs:
549         if (ufshcd_is_clkscaling_enabled(hba))
550                 devfreq_resume_device(hba->devfreq);
551         scsi_unblock_requests(hba->host);
552 }
553
554 /**
555  * ufshcd_hold - Enable clocks that were gated earlier due to ufshcd_release.
556  * Also, exit from hibern8 mode and set the link as active.
557  * @hba: per adapter instance
558  * @async: This indicates whether caller should ungate clocks asynchronously.
559  */
560 int ufshcd_hold(struct ufs_hba *hba, bool async)
561 {
562         int rc = 0;
563         unsigned long flags;
564
565         if (!ufshcd_is_clkgating_allowed(hba))
566                 goto out;
567         spin_lock_irqsave(hba->host->host_lock, flags);
568         hba->clk_gating.active_reqs++;
569
570 start:
571         switch (hba->clk_gating.state) {
572         case CLKS_ON:
573                 break;
574         case REQ_CLKS_OFF:
575                 if (cancel_delayed_work(&hba->clk_gating.gate_work)) {
576                         hba->clk_gating.state = CLKS_ON;
577                         break;
578                 }
579                 /*
580                  * If we here, it means gating work is either done or
581                  * currently running. Hence, fall through to cancel gating
582                  * work and to enable clocks.
583                  */
584         case CLKS_OFF:
585                 scsi_block_requests(hba->host);
586                 hba->clk_gating.state = REQ_CLKS_ON;
587                 schedule_work(&hba->clk_gating.ungate_work);
588                 /*
589                  * fall through to check if we should wait for this
590                  * work to be done or not.
591                  */
592         case REQ_CLKS_ON:
593                 if (async) {
594                         rc = -EAGAIN;
595                         hba->clk_gating.active_reqs--;
596                         break;
597                 }
598
599                 spin_unlock_irqrestore(hba->host->host_lock, flags);
600                 flush_work(&hba->clk_gating.ungate_work);
601                 /* Make sure state is CLKS_ON before returning */
602                 spin_lock_irqsave(hba->host->host_lock, flags);
603                 goto start;
604         default:
605                 dev_err(hba->dev, "%s: clk gating is in invalid state %d\n",
606                                 __func__, hba->clk_gating.state);
607                 break;
608         }
609         spin_unlock_irqrestore(hba->host->host_lock, flags);
610 out:
611         return rc;
612 }
613
614 static void ufshcd_gate_work(struct work_struct *work)
615 {
616         struct ufs_hba *hba = container_of(work, struct ufs_hba,
617                         clk_gating.gate_work.work);
618         unsigned long flags;
619
620         spin_lock_irqsave(hba->host->host_lock, flags);
621         if (hba->clk_gating.is_suspended) {
622                 hba->clk_gating.state = CLKS_ON;
623                 goto rel_lock;
624         }
625
626         if (hba->clk_gating.active_reqs
627                 || hba->ufshcd_state != UFSHCD_STATE_OPERATIONAL
628                 || hba->lrb_in_use || hba->outstanding_tasks
629                 || hba->active_uic_cmd || hba->uic_async_done)
630                 goto rel_lock;
631
632         spin_unlock_irqrestore(hba->host->host_lock, flags);
633
634         /* put the link into hibern8 mode before turning off clocks */
635         if (ufshcd_can_hibern8_during_gating(hba)) {
636                 if (ufshcd_uic_hibern8_enter(hba)) {
637                         hba->clk_gating.state = CLKS_ON;
638                         goto out;
639                 }
640                 ufshcd_set_link_hibern8(hba);
641         }
642
643         if (ufshcd_is_clkscaling_enabled(hba)) {
644                 devfreq_suspend_device(hba->devfreq);
645                 hba->clk_scaling.window_start_t = 0;
646         }
647
648         if (!ufshcd_is_link_active(hba))
649                 ufshcd_setup_clocks(hba, false);
650         else
651                 /* If link is active, device ref_clk can't be switched off */
652                 __ufshcd_setup_clocks(hba, false, true);
653
654         /*
655          * In case you are here to cancel this work the gating state
656          * would be marked as REQ_CLKS_ON. In this case keep the state
657          * as REQ_CLKS_ON which would anyway imply that clocks are off
658          * and a request to turn them on is pending. By doing this way,
659          * we keep the state machine in tact and this would ultimately
660          * prevent from doing cancel work multiple times when there are
661          * new requests arriving before the current cancel work is done.
662          */
663         spin_lock_irqsave(hba->host->host_lock, flags);
664         if (hba->clk_gating.state == REQ_CLKS_OFF)
665                 hba->clk_gating.state = CLKS_OFF;
666
667 rel_lock:
668         spin_unlock_irqrestore(hba->host->host_lock, flags);
669 out:
670         return;
671 }
672
673 /* host lock must be held before calling this variant */
674 static void __ufshcd_release(struct ufs_hba *hba)
675 {
676         if (!ufshcd_is_clkgating_allowed(hba))
677                 return;
678
679         hba->clk_gating.active_reqs--;
680
681         if (hba->clk_gating.active_reqs || hba->clk_gating.is_suspended
682                 || hba->ufshcd_state != UFSHCD_STATE_OPERATIONAL
683                 || hba->lrb_in_use || hba->outstanding_tasks
684                 || hba->active_uic_cmd || hba->uic_async_done)
685                 return;
686
687         hba->clk_gating.state = REQ_CLKS_OFF;
688         schedule_delayed_work(&hba->clk_gating.gate_work,
689                         msecs_to_jiffies(hba->clk_gating.delay_ms));
690 }
691
692 void ufshcd_release(struct ufs_hba *hba)
693 {
694         unsigned long flags;
695
696         spin_lock_irqsave(hba->host->host_lock, flags);
697         __ufshcd_release(hba);
698         spin_unlock_irqrestore(hba->host->host_lock, flags);
699 }
700
701 static ssize_t ufshcd_clkgate_delay_show(struct device *dev,
702                 struct device_attribute *attr, char *buf)
703 {
704         struct ufs_hba *hba = dev_get_drvdata(dev);
705
706         return snprintf(buf, PAGE_SIZE, "%lu\n", hba->clk_gating.delay_ms);
707 }
708
709 static ssize_t ufshcd_clkgate_delay_store(struct device *dev,
710                 struct device_attribute *attr, const char *buf, size_t count)
711 {
712         struct ufs_hba *hba = dev_get_drvdata(dev);
713         unsigned long flags, value;
714
715         if (kstrtoul(buf, 0, &value))
716                 return -EINVAL;
717
718         spin_lock_irqsave(hba->host->host_lock, flags);
719         hba->clk_gating.delay_ms = value;
720         spin_unlock_irqrestore(hba->host->host_lock, flags);
721         return count;
722 }
723
724 static void ufshcd_init_clk_gating(struct ufs_hba *hba)
725 {
726         if (!ufshcd_is_clkgating_allowed(hba))
727                 return;
728
729         hba->clk_gating.delay_ms = 150;
730         INIT_DELAYED_WORK(&hba->clk_gating.gate_work, ufshcd_gate_work);
731         INIT_WORK(&hba->clk_gating.ungate_work, ufshcd_ungate_work);
732
733         hba->clk_gating.delay_attr.show = ufshcd_clkgate_delay_show;
734         hba->clk_gating.delay_attr.store = ufshcd_clkgate_delay_store;
735         sysfs_attr_init(&hba->clk_gating.delay_attr.attr);
736         hba->clk_gating.delay_attr.attr.name = "clkgate_delay_ms";
737         hba->clk_gating.delay_attr.attr.mode = S_IRUGO | S_IWUSR;
738         if (device_create_file(hba->dev, &hba->clk_gating.delay_attr))
739                 dev_err(hba->dev, "Failed to create sysfs for clkgate_delay\n");
740 }
741
742 static void ufshcd_exit_clk_gating(struct ufs_hba *hba)
743 {
744         if (!ufshcd_is_clkgating_allowed(hba))
745                 return;
746         device_remove_file(hba->dev, &hba->clk_gating.delay_attr);
747 }
748
749 /* Must be called with host lock acquired */
750 static void ufshcd_clk_scaling_start_busy(struct ufs_hba *hba)
751 {
752         if (!ufshcd_is_clkscaling_enabled(hba))
753                 return;
754
755         if (!hba->clk_scaling.is_busy_started) {
756                 hba->clk_scaling.busy_start_t = ktime_get();
757                 hba->clk_scaling.is_busy_started = true;
758         }
759 }
760
761 static void ufshcd_clk_scaling_update_busy(struct ufs_hba *hba)
762 {
763         struct ufs_clk_scaling *scaling = &hba->clk_scaling;
764
765         if (!ufshcd_is_clkscaling_enabled(hba))
766                 return;
767
768         if (!hba->outstanding_reqs && scaling->is_busy_started) {
769                 scaling->tot_busy_t += ktime_to_us(ktime_sub(ktime_get(),
770                                         scaling->busy_start_t));
771                 scaling->busy_start_t = ktime_set(0, 0);
772                 scaling->is_busy_started = false;
773         }
774 }
775 /**
776  * ufshcd_send_command - Send SCSI or device management commands
777  * @hba: per adapter instance
778  * @task_tag: Task tag of the command
779  */
780 static inline
781 void ufshcd_send_command(struct ufs_hba *hba, unsigned int task_tag)
782 {
783         ufshcd_clk_scaling_start_busy(hba);
784         __set_bit(task_tag, &hba->outstanding_reqs);
785         ufshcd_writel(hba, 1 << task_tag, REG_UTP_TRANSFER_REQ_DOOR_BELL);
786 }
787
788 /**
789  * ufshcd_copy_sense_data - Copy sense data in case of check condition
790  * @lrb - pointer to local reference block
791  */
792 static inline void ufshcd_copy_sense_data(struct ufshcd_lrb *lrbp)
793 {
794         int len;
795         if (lrbp->sense_buffer &&
796             ufshcd_get_rsp_upiu_data_seg_len(lrbp->ucd_rsp_ptr)) {
797                 len = be16_to_cpu(lrbp->ucd_rsp_ptr->sr.sense_data_len);
798                 memcpy(lrbp->sense_buffer,
799                         lrbp->ucd_rsp_ptr->sr.sense_data,
800                         min_t(int, len, SCSI_SENSE_BUFFERSIZE));
801         }
802 }
803
804 /**
805  * ufshcd_copy_query_response() - Copy the Query Response and the data
806  * descriptor
807  * @hba: per adapter instance
808  * @lrb - pointer to local reference block
809  */
810 static
811 int ufshcd_copy_query_response(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
812 {
813         struct ufs_query_res *query_res = &hba->dev_cmd.query.response;
814
815         memcpy(&query_res->upiu_res, &lrbp->ucd_rsp_ptr->qr, QUERY_OSF_SIZE);
816
817         /* Get the descriptor */
818         if (lrbp->ucd_rsp_ptr->qr.opcode == UPIU_QUERY_OPCODE_READ_DESC) {
819                 u8 *descp = (u8 *)lrbp->ucd_rsp_ptr +
820                                 GENERAL_UPIU_REQUEST_SIZE;
821                 u16 resp_len;
822                 u16 buf_len;
823
824                 /* data segment length */
825                 resp_len = be32_to_cpu(lrbp->ucd_rsp_ptr->header.dword_2) &
826                                                 MASK_QUERY_DATA_SEG_LEN;
827                 buf_len = be16_to_cpu(
828                                 hba->dev_cmd.query.request.upiu_req.length);
829                 if (likely(buf_len >= resp_len)) {
830                         memcpy(hba->dev_cmd.query.descriptor, descp, resp_len);
831                 } else {
832                         dev_warn(hba->dev,
833                                 "%s: Response size is bigger than buffer",
834                                 __func__);
835                         return -EINVAL;
836                 }
837         }
838
839         return 0;
840 }
841
842 /**
843  * ufshcd_hba_capabilities - Read controller capabilities
844  * @hba: per adapter instance
845  */
846 static inline void ufshcd_hba_capabilities(struct ufs_hba *hba)
847 {
848         hba->capabilities = ufshcd_readl(hba, REG_CONTROLLER_CAPABILITIES);
849
850         /* nutrs and nutmrs are 0 based values */
851         hba->nutrs = (hba->capabilities & MASK_TRANSFER_REQUESTS_SLOTS) + 1;
852         hba->nutmrs =
853         ((hba->capabilities & MASK_TASK_MANAGEMENT_REQUEST_SLOTS) >> 16) + 1;
854 }
855
856 /**
857  * ufshcd_ready_for_uic_cmd - Check if controller is ready
858  *                            to accept UIC commands
859  * @hba: per adapter instance
860  * Return true on success, else false
861  */
862 static inline bool ufshcd_ready_for_uic_cmd(struct ufs_hba *hba)
863 {
864         if (ufshcd_readl(hba, REG_CONTROLLER_STATUS) & UIC_COMMAND_READY)
865                 return true;
866         else
867                 return false;
868 }
869
870 /**
871  * ufshcd_get_upmcrs - Get the power mode change request status
872  * @hba: Pointer to adapter instance
873  *
874  * This function gets the UPMCRS field of HCS register
875  * Returns value of UPMCRS field
876  */
877 static inline u8 ufshcd_get_upmcrs(struct ufs_hba *hba)
878 {
879         return (ufshcd_readl(hba, REG_CONTROLLER_STATUS) >> 8) & 0x7;
880 }
881
882 /**
883  * ufshcd_dispatch_uic_cmd - Dispatch UIC commands to unipro layers
884  * @hba: per adapter instance
885  * @uic_cmd: UIC command
886  *
887  * Mutex must be held.
888  */
889 static inline void
890 ufshcd_dispatch_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd)
891 {
892         WARN_ON(hba->active_uic_cmd);
893
894         hba->active_uic_cmd = uic_cmd;
895
896         /* Write Args */
897         ufshcd_writel(hba, uic_cmd->argument1, REG_UIC_COMMAND_ARG_1);
898         ufshcd_writel(hba, uic_cmd->argument2, REG_UIC_COMMAND_ARG_2);
899         ufshcd_writel(hba, uic_cmd->argument3, REG_UIC_COMMAND_ARG_3);
900
901         /* Write UIC Cmd */
902         ufshcd_writel(hba, uic_cmd->command & COMMAND_OPCODE_MASK,
903                       REG_UIC_COMMAND);
904 }
905
906 /**
907  * ufshcd_wait_for_uic_cmd - Wait complectioin of UIC command
908  * @hba: per adapter instance
909  * @uic_command: UIC command
910  *
911  * Must be called with mutex held.
912  * Returns 0 only if success.
913  */
914 static int
915 ufshcd_wait_for_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd)
916 {
917         int ret;
918         unsigned long flags;
919
920         if (wait_for_completion_timeout(&uic_cmd->done,
921                                         msecs_to_jiffies(UIC_CMD_TIMEOUT)))
922                 ret = uic_cmd->argument2 & MASK_UIC_COMMAND_RESULT;
923         else
924                 ret = -ETIMEDOUT;
925
926         spin_lock_irqsave(hba->host->host_lock, flags);
927         hba->active_uic_cmd = NULL;
928         spin_unlock_irqrestore(hba->host->host_lock, flags);
929
930         return ret;
931 }
932
933 /**
934  * __ufshcd_send_uic_cmd - Send UIC commands and retrieve the result
935  * @hba: per adapter instance
936  * @uic_cmd: UIC command
937  *
938  * Identical to ufshcd_send_uic_cmd() expect mutex. Must be called
939  * with mutex held and host_lock locked.
940  * Returns 0 only if success.
941  */
942 static int
943 __ufshcd_send_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd)
944 {
945         if (!ufshcd_ready_for_uic_cmd(hba)) {
946                 dev_err(hba->dev,
947                         "Controller not ready to accept UIC commands\n");
948                 return -EIO;
949         }
950
951         init_completion(&uic_cmd->done);
952
953         ufshcd_dispatch_uic_cmd(hba, uic_cmd);
954
955         return 0;
956 }
957
958 /**
959  * ufshcd_send_uic_cmd - Send UIC commands and retrieve the result
960  * @hba: per adapter instance
961  * @uic_cmd: UIC command
962  *
963  * Returns 0 only if success.
964  */
965 static int
966 ufshcd_send_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd)
967 {
968         int ret;
969         unsigned long flags;
970
971         ufshcd_hold(hba, false);
972         mutex_lock(&hba->uic_cmd_mutex);
973         spin_lock_irqsave(hba->host->host_lock, flags);
974         ret = __ufshcd_send_uic_cmd(hba, uic_cmd);
975         spin_unlock_irqrestore(hba->host->host_lock, flags);
976         if (!ret)
977                 ret = ufshcd_wait_for_uic_cmd(hba, uic_cmd);
978
979         mutex_unlock(&hba->uic_cmd_mutex);
980
981         ufshcd_release(hba);
982         return ret;
983 }
984
985 /**
986  * ufshcd_map_sg - Map scatter-gather list to prdt
987  * @lrbp - pointer to local reference block
988  *
989  * Returns 0 in case of success, non-zero value in case of failure
990  */
991 static int ufshcd_map_sg(struct ufshcd_lrb *lrbp)
992 {
993         struct ufshcd_sg_entry *prd_table;
994         struct scatterlist *sg;
995         struct scsi_cmnd *cmd;
996         int sg_segments;
997         int i;
998
999         cmd = lrbp->cmd;
1000         sg_segments = scsi_dma_map(cmd);
1001         if (sg_segments < 0)
1002                 return sg_segments;
1003
1004         if (sg_segments) {
1005                 lrbp->utr_descriptor_ptr->prd_table_length =
1006                                         cpu_to_le16((u16) (sg_segments));
1007
1008                 prd_table = (struct ufshcd_sg_entry *)lrbp->ucd_prdt_ptr;
1009
1010                 scsi_for_each_sg(cmd, sg, sg_segments, i) {
1011                         prd_table[i].size  =
1012                                 cpu_to_le32(((u32) sg_dma_len(sg))-1);
1013                         prd_table[i].base_addr =
1014                                 cpu_to_le32(lower_32_bits(sg->dma_address));
1015                         prd_table[i].upper_addr =
1016                                 cpu_to_le32(upper_32_bits(sg->dma_address));
1017                 }
1018         } else {
1019                 lrbp->utr_descriptor_ptr->prd_table_length = 0;
1020         }
1021
1022         return 0;
1023 }
1024
1025 /**
1026  * ufshcd_enable_intr - enable interrupts
1027  * @hba: per adapter instance
1028  * @intrs: interrupt bits
1029  */
1030 static void ufshcd_enable_intr(struct ufs_hba *hba, u32 intrs)
1031 {
1032         u32 set = ufshcd_readl(hba, REG_INTERRUPT_ENABLE);
1033
1034         if (hba->ufs_version == UFSHCI_VERSION_10) {
1035                 u32 rw;
1036                 rw = set & INTERRUPT_MASK_RW_VER_10;
1037                 set = rw | ((set ^ intrs) & intrs);
1038         } else {
1039                 set |= intrs;
1040         }
1041
1042         ufshcd_writel(hba, set, REG_INTERRUPT_ENABLE);
1043 }
1044
1045 /**
1046  * ufshcd_disable_intr - disable interrupts
1047  * @hba: per adapter instance
1048  * @intrs: interrupt bits
1049  */
1050 static void ufshcd_disable_intr(struct ufs_hba *hba, u32 intrs)
1051 {
1052         u32 set = ufshcd_readl(hba, REG_INTERRUPT_ENABLE);
1053
1054         if (hba->ufs_version == UFSHCI_VERSION_10) {
1055                 u32 rw;
1056                 rw = (set & INTERRUPT_MASK_RW_VER_10) &
1057                         ~(intrs & INTERRUPT_MASK_RW_VER_10);
1058                 set = rw | ((set & intrs) & ~INTERRUPT_MASK_RW_VER_10);
1059
1060         } else {
1061                 set &= ~intrs;
1062         }
1063
1064         ufshcd_writel(hba, set, REG_INTERRUPT_ENABLE);
1065 }
1066
1067 /**
1068  * ufshcd_prepare_req_desc_hdr() - Fills the requests header
1069  * descriptor according to request
1070  * @lrbp: pointer to local reference block
1071  * @upiu_flags: flags required in the header
1072  * @cmd_dir: requests data direction
1073  */
1074 static void ufshcd_prepare_req_desc_hdr(struct ufshcd_lrb *lrbp,
1075                 u32 *upiu_flags, enum dma_data_direction cmd_dir)
1076 {
1077         struct utp_transfer_req_desc *req_desc = lrbp->utr_descriptor_ptr;
1078         u32 data_direction;
1079         u32 dword_0;
1080
1081         if (cmd_dir == DMA_FROM_DEVICE) {
1082                 data_direction = UTP_DEVICE_TO_HOST;
1083                 *upiu_flags = UPIU_CMD_FLAGS_READ;
1084         } else if (cmd_dir == DMA_TO_DEVICE) {
1085                 data_direction = UTP_HOST_TO_DEVICE;
1086                 *upiu_flags = UPIU_CMD_FLAGS_WRITE;
1087         } else {
1088                 data_direction = UTP_NO_DATA_TRANSFER;
1089                 *upiu_flags = UPIU_CMD_FLAGS_NONE;
1090         }
1091
1092         dword_0 = data_direction | (lrbp->command_type
1093                                 << UPIU_COMMAND_TYPE_OFFSET);
1094         if (lrbp->intr_cmd)
1095                 dword_0 |= UTP_REQ_DESC_INT_CMD;
1096
1097         /* Transfer request descriptor header fields */
1098         req_desc->header.dword_0 = cpu_to_le32(dword_0);
1099
1100         /*
1101          * assigning invalid value for command status. Controller
1102          * updates OCS on command completion, with the command
1103          * status
1104          */
1105         req_desc->header.dword_2 =
1106                 cpu_to_le32(OCS_INVALID_COMMAND_STATUS);
1107 }
1108
1109 /**
1110  * ufshcd_prepare_utp_scsi_cmd_upiu() - fills the utp_transfer_req_desc,
1111  * for scsi commands
1112  * @lrbp - local reference block pointer
1113  * @upiu_flags - flags
1114  */
1115 static
1116 void ufshcd_prepare_utp_scsi_cmd_upiu(struct ufshcd_lrb *lrbp, u32 upiu_flags)
1117 {
1118         struct utp_upiu_req *ucd_req_ptr = lrbp->ucd_req_ptr;
1119
1120         /* command descriptor fields */
1121         ucd_req_ptr->header.dword_0 = UPIU_HEADER_DWORD(
1122                                 UPIU_TRANSACTION_COMMAND, upiu_flags,
1123                                 lrbp->lun, lrbp->task_tag);
1124         ucd_req_ptr->header.dword_1 = UPIU_HEADER_DWORD(
1125                                 UPIU_COMMAND_SET_TYPE_SCSI, 0, 0, 0);
1126
1127         /* Total EHS length and Data segment length will be zero */
1128         ucd_req_ptr->header.dword_2 = 0;
1129
1130         ucd_req_ptr->sc.exp_data_transfer_len =
1131                 cpu_to_be32(lrbp->cmd->sdb.length);
1132
1133         memcpy(ucd_req_ptr->sc.cdb, lrbp->cmd->cmnd,
1134                 (min_t(unsigned short, lrbp->cmd->cmd_len, MAX_CDB_SIZE)));
1135 }
1136
1137 /**
1138  * ufshcd_prepare_utp_query_req_upiu() - fills the utp_transfer_req_desc,
1139  * for query requsts
1140  * @hba: UFS hba
1141  * @lrbp: local reference block pointer
1142  * @upiu_flags: flags
1143  */
1144 static void ufshcd_prepare_utp_query_req_upiu(struct ufs_hba *hba,
1145                                 struct ufshcd_lrb *lrbp, u32 upiu_flags)
1146 {
1147         struct utp_upiu_req *ucd_req_ptr = lrbp->ucd_req_ptr;
1148         struct ufs_query *query = &hba->dev_cmd.query;
1149         u16 len = be16_to_cpu(query->request.upiu_req.length);
1150         u8 *descp = (u8 *)lrbp->ucd_req_ptr + GENERAL_UPIU_REQUEST_SIZE;
1151
1152         /* Query request header */
1153         ucd_req_ptr->header.dword_0 = UPIU_HEADER_DWORD(
1154                         UPIU_TRANSACTION_QUERY_REQ, upiu_flags,
1155                         lrbp->lun, lrbp->task_tag);
1156         ucd_req_ptr->header.dword_1 = UPIU_HEADER_DWORD(
1157                         0, query->request.query_func, 0, 0);
1158
1159         /* Data segment length */
1160         ucd_req_ptr->header.dword_2 = UPIU_HEADER_DWORD(
1161                         0, 0, len >> 8, (u8)len);
1162
1163         /* Copy the Query Request buffer as is */
1164         memcpy(&ucd_req_ptr->qr, &query->request.upiu_req,
1165                         QUERY_OSF_SIZE);
1166
1167         /* Copy the Descriptor */
1168         if (query->request.upiu_req.opcode == UPIU_QUERY_OPCODE_WRITE_DESC)
1169                 memcpy(descp, query->descriptor, len);
1170
1171 }
1172
1173 static inline void ufshcd_prepare_utp_nop_upiu(struct ufshcd_lrb *lrbp)
1174 {
1175         struct utp_upiu_req *ucd_req_ptr = lrbp->ucd_req_ptr;
1176
1177         memset(ucd_req_ptr, 0, sizeof(struct utp_upiu_req));
1178
1179         /* command descriptor fields */
1180         ucd_req_ptr->header.dword_0 =
1181                 UPIU_HEADER_DWORD(
1182                         UPIU_TRANSACTION_NOP_OUT, 0, 0, lrbp->task_tag);
1183 }
1184
1185 /**
1186  * ufshcd_compose_upiu - form UFS Protocol Information Unit(UPIU)
1187  * @hba - per adapter instance
1188  * @lrb - pointer to local reference block
1189  */
1190 static int ufshcd_compose_upiu(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
1191 {
1192         u32 upiu_flags;
1193         int ret = 0;
1194
1195         switch (lrbp->command_type) {
1196         case UTP_CMD_TYPE_SCSI:
1197                 if (likely(lrbp->cmd)) {
1198                         ufshcd_prepare_req_desc_hdr(lrbp, &upiu_flags,
1199                                         lrbp->cmd->sc_data_direction);
1200                         ufshcd_prepare_utp_scsi_cmd_upiu(lrbp, upiu_flags);
1201                 } else {
1202                         ret = -EINVAL;
1203                 }
1204                 break;
1205         case UTP_CMD_TYPE_DEV_MANAGE:
1206                 ufshcd_prepare_req_desc_hdr(lrbp, &upiu_flags, DMA_NONE);
1207                 if (hba->dev_cmd.type == DEV_CMD_TYPE_QUERY)
1208                         ufshcd_prepare_utp_query_req_upiu(
1209                                         hba, lrbp, upiu_flags);
1210                 else if (hba->dev_cmd.type == DEV_CMD_TYPE_NOP)
1211                         ufshcd_prepare_utp_nop_upiu(lrbp);
1212                 else
1213                         ret = -EINVAL;
1214                 break;
1215         case UTP_CMD_TYPE_UFS:
1216                 /* For UFS native command implementation */
1217                 ret = -ENOTSUPP;
1218                 dev_err(hba->dev, "%s: UFS native command are not supported\n",
1219                         __func__);
1220                 break;
1221         default:
1222                 ret = -ENOTSUPP;
1223                 dev_err(hba->dev, "%s: unknown command type: 0x%x\n",
1224                                 __func__, lrbp->command_type);
1225                 break;
1226         } /* end of switch */
1227
1228         return ret;
1229 }
1230
1231 /*
1232  * ufshcd_scsi_to_upiu_lun - maps scsi LUN to UPIU LUN
1233  * @scsi_lun: scsi LUN id
1234  *
1235  * Returns UPIU LUN id
1236  */
1237 static inline u8 ufshcd_scsi_to_upiu_lun(unsigned int scsi_lun)
1238 {
1239         if (scsi_is_wlun(scsi_lun))
1240                 return (scsi_lun & UFS_UPIU_MAX_UNIT_NUM_ID)
1241                         | UFS_UPIU_WLUN_ID;
1242         else
1243                 return scsi_lun & UFS_UPIU_MAX_UNIT_NUM_ID;
1244 }
1245
1246 /**
1247  * ufshcd_upiu_wlun_to_scsi_wlun - maps UPIU W-LUN id to SCSI W-LUN ID
1248  * @scsi_lun: UPIU W-LUN id
1249  *
1250  * Returns SCSI W-LUN id
1251  */
1252 static inline u16 ufshcd_upiu_wlun_to_scsi_wlun(u8 upiu_wlun_id)
1253 {
1254         return (upiu_wlun_id & ~UFS_UPIU_WLUN_ID) | SCSI_W_LUN_BASE;
1255 }
1256
1257 /**
1258  * ufshcd_queuecommand - main entry point for SCSI requests
1259  * @cmd: command from SCSI Midlayer
1260  * @done: call back function
1261  *
1262  * Returns 0 for success, non-zero in case of failure
1263  */
1264 static int ufshcd_queuecommand(struct Scsi_Host *host, struct scsi_cmnd *cmd)
1265 {
1266         struct ufshcd_lrb *lrbp;
1267         struct ufs_hba *hba;
1268         unsigned long flags;
1269         int tag;
1270         int err = 0;
1271
1272         hba = shost_priv(host);
1273
1274         tag = cmd->request->tag;
1275
1276         spin_lock_irqsave(hba->host->host_lock, flags);
1277         switch (hba->ufshcd_state) {
1278         case UFSHCD_STATE_OPERATIONAL:
1279                 break;
1280         case UFSHCD_STATE_RESET:
1281                 err = SCSI_MLQUEUE_HOST_BUSY;
1282                 goto out_unlock;
1283         case UFSHCD_STATE_ERROR:
1284                 set_host_byte(cmd, DID_ERROR);
1285                 cmd->scsi_done(cmd);
1286                 goto out_unlock;
1287         default:
1288                 dev_WARN_ONCE(hba->dev, 1, "%s: invalid state %d\n",
1289                                 __func__, hba->ufshcd_state);
1290                 set_host_byte(cmd, DID_BAD_TARGET);
1291                 cmd->scsi_done(cmd);
1292                 goto out_unlock;
1293         }
1294         spin_unlock_irqrestore(hba->host->host_lock, flags);
1295
1296         /* acquire the tag to make sure device cmds don't use it */
1297         if (test_and_set_bit_lock(tag, &hba->lrb_in_use)) {
1298                 /*
1299                  * Dev manage command in progress, requeue the command.
1300                  * Requeuing the command helps in cases where the request *may*
1301                  * find different tag instead of waiting for dev manage command
1302                  * completion.
1303                  */
1304                 err = SCSI_MLQUEUE_HOST_BUSY;
1305                 goto out;
1306         }
1307
1308         err = ufshcd_hold(hba, true);
1309         if (err) {
1310                 err = SCSI_MLQUEUE_HOST_BUSY;
1311                 clear_bit_unlock(tag, &hba->lrb_in_use);
1312                 goto out;
1313         }
1314         WARN_ON(hba->clk_gating.state != CLKS_ON);
1315
1316         lrbp = &hba->lrb[tag];
1317
1318         WARN_ON(lrbp->cmd);
1319         lrbp->cmd = cmd;
1320         lrbp->sense_bufflen = SCSI_SENSE_BUFFERSIZE;
1321         lrbp->sense_buffer = cmd->sense_buffer;
1322         lrbp->task_tag = tag;
1323         lrbp->lun = ufshcd_scsi_to_upiu_lun(cmd->device->lun);
1324         lrbp->intr_cmd = false;
1325         lrbp->command_type = UTP_CMD_TYPE_SCSI;
1326
1327         /* form UPIU before issuing the command */
1328         ufshcd_compose_upiu(hba, lrbp);
1329         err = ufshcd_map_sg(lrbp);
1330         if (err) {
1331                 lrbp->cmd = NULL;
1332                 clear_bit_unlock(tag, &hba->lrb_in_use);
1333                 goto out;
1334         }
1335
1336         /* issue command to the controller */
1337         spin_lock_irqsave(hba->host->host_lock, flags);
1338         ufshcd_send_command(hba, tag);
1339 out_unlock:
1340         spin_unlock_irqrestore(hba->host->host_lock, flags);
1341 out:
1342         return err;
1343 }
1344
1345 static int ufshcd_compose_dev_cmd(struct ufs_hba *hba,
1346                 struct ufshcd_lrb *lrbp, enum dev_cmd_type cmd_type, int tag)
1347 {
1348         lrbp->cmd = NULL;
1349         lrbp->sense_bufflen = 0;
1350         lrbp->sense_buffer = NULL;
1351         lrbp->task_tag = tag;
1352         lrbp->lun = 0; /* device management cmd is not specific to any LUN */
1353         lrbp->command_type = UTP_CMD_TYPE_DEV_MANAGE;
1354         lrbp->intr_cmd = true; /* No interrupt aggregation */
1355         hba->dev_cmd.type = cmd_type;
1356
1357         return ufshcd_compose_upiu(hba, lrbp);
1358 }
1359
1360 static int
1361 ufshcd_clear_cmd(struct ufs_hba *hba, int tag)
1362 {
1363         int err = 0;
1364         unsigned long flags;
1365         u32 mask = 1 << tag;
1366
1367         /* clear outstanding transaction before retry */
1368         spin_lock_irqsave(hba->host->host_lock, flags);
1369         ufshcd_utrl_clear(hba, tag);
1370         spin_unlock_irqrestore(hba->host->host_lock, flags);
1371
1372         /*
1373          * wait for for h/w to clear corresponding bit in door-bell.
1374          * max. wait is 1 sec.
1375          */
1376         err = ufshcd_wait_for_register(hba,
1377                         REG_UTP_TRANSFER_REQ_DOOR_BELL,
1378                         mask, ~mask, 1000, 1000);
1379
1380         return err;
1381 }
1382
1383 static int
1384 ufshcd_check_query_response(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
1385 {
1386         struct ufs_query_res *query_res = &hba->dev_cmd.query.response;
1387
1388         /* Get the UPIU response */
1389         query_res->response = ufshcd_get_rsp_upiu_result(lrbp->ucd_rsp_ptr) >>
1390                                 UPIU_RSP_CODE_OFFSET;
1391         return query_res->response;
1392 }
1393
1394 /**
1395  * ufshcd_dev_cmd_completion() - handles device management command responses
1396  * @hba: per adapter instance
1397  * @lrbp: pointer to local reference block
1398  */
1399 static int
1400 ufshcd_dev_cmd_completion(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
1401 {
1402         int resp;
1403         int err = 0;
1404
1405         resp = ufshcd_get_req_rsp(lrbp->ucd_rsp_ptr);
1406
1407         switch (resp) {
1408         case UPIU_TRANSACTION_NOP_IN:
1409                 if (hba->dev_cmd.type != DEV_CMD_TYPE_NOP) {
1410                         err = -EINVAL;
1411                         dev_err(hba->dev, "%s: unexpected response %x\n",
1412                                         __func__, resp);
1413                 }
1414                 break;
1415         case UPIU_TRANSACTION_QUERY_RSP:
1416                 err = ufshcd_check_query_response(hba, lrbp);
1417                 if (!err)
1418                         err = ufshcd_copy_query_response(hba, lrbp);
1419                 break;
1420         case UPIU_TRANSACTION_REJECT_UPIU:
1421                 /* TODO: handle Reject UPIU Response */
1422                 err = -EPERM;
1423                 dev_err(hba->dev, "%s: Reject UPIU not fully implemented\n",
1424                                 __func__);
1425                 break;
1426         default:
1427                 err = -EINVAL;
1428                 dev_err(hba->dev, "%s: Invalid device management cmd response: %x\n",
1429                                 __func__, resp);
1430                 break;
1431         }
1432
1433         return err;
1434 }
1435
1436 static int ufshcd_wait_for_dev_cmd(struct ufs_hba *hba,
1437                 struct ufshcd_lrb *lrbp, int max_timeout)
1438 {
1439         int err = 0;
1440         unsigned long time_left;
1441         unsigned long flags;
1442
1443         time_left = wait_for_completion_timeout(hba->dev_cmd.complete,
1444                         msecs_to_jiffies(max_timeout));
1445
1446         spin_lock_irqsave(hba->host->host_lock, flags);
1447         hba->dev_cmd.complete = NULL;
1448         if (likely(time_left)) {
1449                 err = ufshcd_get_tr_ocs(lrbp);
1450                 if (!err)
1451                         err = ufshcd_dev_cmd_completion(hba, lrbp);
1452         }
1453         spin_unlock_irqrestore(hba->host->host_lock, flags);
1454
1455         if (!time_left) {
1456                 err = -ETIMEDOUT;
1457                 if (!ufshcd_clear_cmd(hba, lrbp->task_tag))
1458                         /* sucessfully cleared the command, retry if needed */
1459                         err = -EAGAIN;
1460         }
1461
1462         return err;
1463 }
1464
1465 /**
1466  * ufshcd_get_dev_cmd_tag - Get device management command tag
1467  * @hba: per-adapter instance
1468  * @tag: pointer to variable with available slot value
1469  *
1470  * Get a free slot and lock it until device management command
1471  * completes.
1472  *
1473  * Returns false if free slot is unavailable for locking, else
1474  * return true with tag value in @tag.
1475  */
1476 static bool ufshcd_get_dev_cmd_tag(struct ufs_hba *hba, int *tag_out)
1477 {
1478         int tag;
1479         bool ret = false;
1480         unsigned long tmp;
1481
1482         if (!tag_out)
1483                 goto out;
1484
1485         do {
1486                 tmp = ~hba->lrb_in_use;
1487                 tag = find_last_bit(&tmp, hba->nutrs);
1488                 if (tag >= hba->nutrs)
1489                         goto out;
1490         } while (test_and_set_bit_lock(tag, &hba->lrb_in_use));
1491
1492         *tag_out = tag;
1493         ret = true;
1494 out:
1495         return ret;
1496 }
1497
1498 static inline void ufshcd_put_dev_cmd_tag(struct ufs_hba *hba, int tag)
1499 {
1500         clear_bit_unlock(tag, &hba->lrb_in_use);
1501 }
1502
1503 /**
1504  * ufshcd_exec_dev_cmd - API for sending device management requests
1505  * @hba - UFS hba
1506  * @cmd_type - specifies the type (NOP, Query...)
1507  * @timeout - time in seconds
1508  *
1509  * NOTE: Since there is only one available tag for device management commands,
1510  * it is expected you hold the hba->dev_cmd.lock mutex.
1511  */
1512 static int ufshcd_exec_dev_cmd(struct ufs_hba *hba,
1513                 enum dev_cmd_type cmd_type, int timeout)
1514 {
1515         struct ufshcd_lrb *lrbp;
1516         int err;
1517         int tag;
1518         struct completion wait;
1519         unsigned long flags;
1520
1521         /*
1522          * Get free slot, sleep if slots are unavailable.
1523          * Even though we use wait_event() which sleeps indefinitely,
1524          * the maximum wait time is bounded by SCSI request timeout.
1525          */
1526         wait_event(hba->dev_cmd.tag_wq, ufshcd_get_dev_cmd_tag(hba, &tag));
1527
1528         init_completion(&wait);
1529         lrbp = &hba->lrb[tag];
1530         WARN_ON(lrbp->cmd);
1531         err = ufshcd_compose_dev_cmd(hba, lrbp, cmd_type, tag);
1532         if (unlikely(err))
1533                 goto out_put_tag;
1534
1535         hba->dev_cmd.complete = &wait;
1536
1537         spin_lock_irqsave(hba->host->host_lock, flags);
1538         ufshcd_send_command(hba, tag);
1539         spin_unlock_irqrestore(hba->host->host_lock, flags);
1540
1541         err = ufshcd_wait_for_dev_cmd(hba, lrbp, timeout);
1542
1543 out_put_tag:
1544         ufshcd_put_dev_cmd_tag(hba, tag);
1545         wake_up(&hba->dev_cmd.tag_wq);
1546         return err;
1547 }
1548
1549 /**
1550  * ufshcd_init_query() - init the query response and request parameters
1551  * @hba: per-adapter instance
1552  * @request: address of the request pointer to be initialized
1553  * @response: address of the response pointer to be initialized
1554  * @opcode: operation to perform
1555  * @idn: flag idn to access
1556  * @index: LU number to access
1557  * @selector: query/flag/descriptor further identification
1558  */
1559 static inline void ufshcd_init_query(struct ufs_hba *hba,
1560                 struct ufs_query_req **request, struct ufs_query_res **response,
1561                 enum query_opcode opcode, u8 idn, u8 index, u8 selector)
1562 {
1563         *request = &hba->dev_cmd.query.request;
1564         *response = &hba->dev_cmd.query.response;
1565         memset(*request, 0, sizeof(struct ufs_query_req));
1566         memset(*response, 0, sizeof(struct ufs_query_res));
1567         (*request)->upiu_req.opcode = opcode;
1568         (*request)->upiu_req.idn = idn;
1569         (*request)->upiu_req.index = index;
1570         (*request)->upiu_req.selector = selector;
1571 }
1572
1573 /**
1574  * ufshcd_query_flag() - API function for sending flag query requests
1575  * hba: per-adapter instance
1576  * query_opcode: flag query to perform
1577  * idn: flag idn to access
1578  * flag_res: the flag value after the query request completes
1579  *
1580  * Returns 0 for success, non-zero in case of failure
1581  */
1582 static int ufshcd_query_flag(struct ufs_hba *hba, enum query_opcode opcode,
1583                         enum flag_idn idn, bool *flag_res)
1584 {
1585         struct ufs_query_req *request = NULL;
1586         struct ufs_query_res *response = NULL;
1587         int err, index = 0, selector = 0;
1588
1589         BUG_ON(!hba);
1590
1591         ufshcd_hold(hba, false);
1592         mutex_lock(&hba->dev_cmd.lock);
1593         ufshcd_init_query(hba, &request, &response, opcode, idn, index,
1594                         selector);
1595
1596         switch (opcode) {
1597         case UPIU_QUERY_OPCODE_SET_FLAG:
1598         case UPIU_QUERY_OPCODE_CLEAR_FLAG:
1599         case UPIU_QUERY_OPCODE_TOGGLE_FLAG:
1600                 request->query_func = UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST;
1601                 break;
1602         case UPIU_QUERY_OPCODE_READ_FLAG:
1603                 request->query_func = UPIU_QUERY_FUNC_STANDARD_READ_REQUEST;
1604                 if (!flag_res) {
1605                         /* No dummy reads */
1606                         dev_err(hba->dev, "%s: Invalid argument for read request\n",
1607                                         __func__);
1608                         err = -EINVAL;
1609                         goto out_unlock;
1610                 }
1611                 break;
1612         default:
1613                 dev_err(hba->dev,
1614                         "%s: Expected query flag opcode but got = %d\n",
1615                         __func__, opcode);
1616                 err = -EINVAL;
1617                 goto out_unlock;
1618         }
1619
1620         err = ufshcd_exec_dev_cmd(hba, DEV_CMD_TYPE_QUERY, QUERY_REQ_TIMEOUT);
1621
1622         if (err) {
1623                 dev_err(hba->dev,
1624                         "%s: Sending flag query for idn %d failed, err = %d\n",
1625                         __func__, idn, err);
1626                 goto out_unlock;
1627         }
1628
1629         if (flag_res)
1630                 *flag_res = (be32_to_cpu(response->upiu_res.value) &
1631                                 MASK_QUERY_UPIU_FLAG_LOC) & 0x1;
1632
1633 out_unlock:
1634         mutex_unlock(&hba->dev_cmd.lock);
1635         ufshcd_release(hba);
1636         return err;
1637 }
1638
1639 /**
1640  * ufshcd_query_attr - API function for sending attribute requests
1641  * hba: per-adapter instance
1642  * opcode: attribute opcode
1643  * idn: attribute idn to access
1644  * index: index field
1645  * selector: selector field
1646  * attr_val: the attribute value after the query request completes
1647  *
1648  * Returns 0 for success, non-zero in case of failure
1649 */
1650 static int ufshcd_query_attr(struct ufs_hba *hba, enum query_opcode opcode,
1651                         enum attr_idn idn, u8 index, u8 selector, u32 *attr_val)
1652 {
1653         struct ufs_query_req *request = NULL;
1654         struct ufs_query_res *response = NULL;
1655         int err;
1656
1657         BUG_ON(!hba);
1658
1659         ufshcd_hold(hba, false);
1660         if (!attr_val) {
1661                 dev_err(hba->dev, "%s: attribute value required for opcode 0x%x\n",
1662                                 __func__, opcode);
1663                 err = -EINVAL;
1664                 goto out;
1665         }
1666
1667         mutex_lock(&hba->dev_cmd.lock);
1668         ufshcd_init_query(hba, &request, &response, opcode, idn, index,
1669                         selector);
1670
1671         switch (opcode) {
1672         case UPIU_QUERY_OPCODE_WRITE_ATTR:
1673                 request->query_func = UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST;
1674                 request->upiu_req.value = cpu_to_be32(*attr_val);
1675                 break;
1676         case UPIU_QUERY_OPCODE_READ_ATTR:
1677                 request->query_func = UPIU_QUERY_FUNC_STANDARD_READ_REQUEST;
1678                 break;
1679         default:
1680                 dev_err(hba->dev, "%s: Expected query attr opcode but got = 0x%.2x\n",
1681                                 __func__, opcode);
1682                 err = -EINVAL;
1683                 goto out_unlock;
1684         }
1685
1686         err = ufshcd_exec_dev_cmd(hba, DEV_CMD_TYPE_QUERY, QUERY_REQ_TIMEOUT);
1687
1688         if (err) {
1689                 dev_err(hba->dev, "%s: opcode 0x%.2x for idn %d failed, err = %d\n",
1690                                 __func__, opcode, idn, err);
1691                 goto out_unlock;
1692         }
1693
1694         *attr_val = be32_to_cpu(response->upiu_res.value);
1695
1696 out_unlock:
1697         mutex_unlock(&hba->dev_cmd.lock);
1698 out:
1699         ufshcd_release(hba);
1700         return err;
1701 }
1702
1703 /**
1704  * ufshcd_query_descriptor - API function for sending descriptor requests
1705  * hba: per-adapter instance
1706  * opcode: attribute opcode
1707  * idn: attribute idn to access
1708  * index: index field
1709  * selector: selector field
1710  * desc_buf: the buffer that contains the descriptor
1711  * buf_len: length parameter passed to the device
1712  *
1713  * Returns 0 for success, non-zero in case of failure.
1714  * The buf_len parameter will contain, on return, the length parameter
1715  * received on the response.
1716  */
1717 static int ufshcd_query_descriptor(struct ufs_hba *hba,
1718                         enum query_opcode opcode, enum desc_idn idn, u8 index,
1719                         u8 selector, u8 *desc_buf, int *buf_len)
1720 {
1721         struct ufs_query_req *request = NULL;
1722         struct ufs_query_res *response = NULL;
1723         int err;
1724
1725         BUG_ON(!hba);
1726
1727         ufshcd_hold(hba, false);
1728         if (!desc_buf) {
1729                 dev_err(hba->dev, "%s: descriptor buffer required for opcode 0x%x\n",
1730                                 __func__, opcode);
1731                 err = -EINVAL;
1732                 goto out;
1733         }
1734
1735         if (*buf_len <= QUERY_DESC_MIN_SIZE || *buf_len > QUERY_DESC_MAX_SIZE) {
1736                 dev_err(hba->dev, "%s: descriptor buffer size (%d) is out of range\n",
1737                                 __func__, *buf_len);
1738                 err = -EINVAL;
1739                 goto out;
1740         }
1741
1742         mutex_lock(&hba->dev_cmd.lock);
1743         ufshcd_init_query(hba, &request, &response, opcode, idn, index,
1744                         selector);
1745         hba->dev_cmd.query.descriptor = desc_buf;
1746         request->upiu_req.length = cpu_to_be16(*buf_len);
1747
1748         switch (opcode) {
1749         case UPIU_QUERY_OPCODE_WRITE_DESC:
1750                 request->query_func = UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST;
1751                 break;
1752         case UPIU_QUERY_OPCODE_READ_DESC:
1753                 request->query_func = UPIU_QUERY_FUNC_STANDARD_READ_REQUEST;
1754                 break;
1755         default:
1756                 dev_err(hba->dev,
1757                                 "%s: Expected query descriptor opcode but got = 0x%.2x\n",
1758                                 __func__, opcode);
1759                 err = -EINVAL;
1760                 goto out_unlock;
1761         }
1762
1763         err = ufshcd_exec_dev_cmd(hba, DEV_CMD_TYPE_QUERY, QUERY_REQ_TIMEOUT);
1764
1765         if (err) {
1766                 dev_err(hba->dev, "%s: opcode 0x%.2x for idn %d failed, err = %d\n",
1767                                 __func__, opcode, idn, err);
1768                 goto out_unlock;
1769         }
1770
1771         hba->dev_cmd.query.descriptor = NULL;
1772         *buf_len = be16_to_cpu(response->upiu_res.length);
1773
1774 out_unlock:
1775         mutex_unlock(&hba->dev_cmd.lock);
1776 out:
1777         ufshcd_release(hba);
1778         return err;
1779 }
1780
1781 /**
1782  * ufshcd_read_desc_param - read the specified descriptor parameter
1783  * @hba: Pointer to adapter instance
1784  * @desc_id: descriptor idn value
1785  * @desc_index: descriptor index
1786  * @param_offset: offset of the parameter to read
1787  * @param_read_buf: pointer to buffer where parameter would be read
1788  * @param_size: sizeof(param_read_buf)
1789  *
1790  * Return 0 in case of success, non-zero otherwise
1791  */
1792 static int ufshcd_read_desc_param(struct ufs_hba *hba,
1793                                   enum desc_idn desc_id,
1794                                   int desc_index,
1795                                   u32 param_offset,
1796                                   u8 *param_read_buf,
1797                                   u32 param_size)
1798 {
1799         int ret;
1800         u8 *desc_buf;
1801         u32 buff_len;
1802         bool is_kmalloc = true;
1803
1804         /* safety checks */
1805         if (desc_id >= QUERY_DESC_IDN_MAX)
1806                 return -EINVAL;
1807
1808         buff_len = ufs_query_desc_max_size[desc_id];
1809         if ((param_offset + param_size) > buff_len)
1810                 return -EINVAL;
1811
1812         if (!param_offset && (param_size == buff_len)) {
1813                 /* memory space already available to hold full descriptor */
1814                 desc_buf = param_read_buf;
1815                 is_kmalloc = false;
1816         } else {
1817                 /* allocate memory to hold full descriptor */
1818                 desc_buf = kmalloc(buff_len, GFP_KERNEL);
1819                 if (!desc_buf)
1820                         return -ENOMEM;
1821         }
1822
1823         ret = ufshcd_query_descriptor(hba, UPIU_QUERY_OPCODE_READ_DESC,
1824                                       desc_id, desc_index, 0, desc_buf,
1825                                       &buff_len);
1826
1827         if (ret || (buff_len < ufs_query_desc_max_size[desc_id]) ||
1828             (desc_buf[QUERY_DESC_LENGTH_OFFSET] !=
1829              ufs_query_desc_max_size[desc_id])
1830             || (desc_buf[QUERY_DESC_DESC_TYPE_OFFSET] != desc_id)) {
1831                 dev_err(hba->dev, "%s: Failed reading descriptor. desc_id %d param_offset %d buff_len %d ret %d",
1832                         __func__, desc_id, param_offset, buff_len, ret);
1833                 if (!ret)
1834                         ret = -EINVAL;
1835
1836                 goto out;
1837         }
1838
1839         if (is_kmalloc)
1840                 memcpy(param_read_buf, &desc_buf[param_offset], param_size);
1841 out:
1842         if (is_kmalloc)
1843                 kfree(desc_buf);
1844         return ret;
1845 }
1846
1847 static inline int ufshcd_read_desc(struct ufs_hba *hba,
1848                                    enum desc_idn desc_id,
1849                                    int desc_index,
1850                                    u8 *buf,
1851                                    u32 size)
1852 {
1853         return ufshcd_read_desc_param(hba, desc_id, desc_index, 0, buf, size);
1854 }
1855
1856 static inline int ufshcd_read_power_desc(struct ufs_hba *hba,
1857                                          u8 *buf,
1858                                          u32 size)
1859 {
1860         return ufshcd_read_desc(hba, QUERY_DESC_IDN_POWER, 0, buf, size);
1861 }
1862
1863 /**
1864  * ufshcd_read_unit_desc_param - read the specified unit descriptor parameter
1865  * @hba: Pointer to adapter instance
1866  * @lun: lun id
1867  * @param_offset: offset of the parameter to read
1868  * @param_read_buf: pointer to buffer where parameter would be read
1869  * @param_size: sizeof(param_read_buf)
1870  *
1871  * Return 0 in case of success, non-zero otherwise
1872  */
1873 static inline int ufshcd_read_unit_desc_param(struct ufs_hba *hba,
1874                                               int lun,
1875                                               enum unit_desc_param param_offset,
1876                                               u8 *param_read_buf,
1877                                               u32 param_size)
1878 {
1879         /*
1880          * Unit descriptors are only available for general purpose LUs (LUN id
1881          * from 0 to 7) and RPMB Well known LU.
1882          */
1883         if (lun != UFS_UPIU_RPMB_WLUN && (lun >= UFS_UPIU_MAX_GENERAL_LUN))
1884                 return -EOPNOTSUPP;
1885
1886         return ufshcd_read_desc_param(hba, QUERY_DESC_IDN_UNIT, lun,
1887                                       param_offset, param_read_buf, param_size);
1888 }
1889
1890 /**
1891  * ufshcd_memory_alloc - allocate memory for host memory space data structures
1892  * @hba: per adapter instance
1893  *
1894  * 1. Allocate DMA memory for Command Descriptor array
1895  *      Each command descriptor consist of Command UPIU, Response UPIU and PRDT
1896  * 2. Allocate DMA memory for UTP Transfer Request Descriptor List (UTRDL).
1897  * 3. Allocate DMA memory for UTP Task Management Request Descriptor List
1898  *      (UTMRDL)
1899  * 4. Allocate memory for local reference block(lrb).
1900  *
1901  * Returns 0 for success, non-zero in case of failure
1902  */
1903 static int ufshcd_memory_alloc(struct ufs_hba *hba)
1904 {
1905         size_t utmrdl_size, utrdl_size, ucdl_size;
1906
1907         /* Allocate memory for UTP command descriptors */
1908         ucdl_size = (sizeof(struct utp_transfer_cmd_desc) * hba->nutrs);
1909         hba->ucdl_base_addr = dmam_alloc_coherent(hba->dev,
1910                                                   ucdl_size,
1911                                                   &hba->ucdl_dma_addr,
1912                                                   GFP_KERNEL);
1913
1914         /*
1915          * UFSHCI requires UTP command descriptor to be 128 byte aligned.
1916          * make sure hba->ucdl_dma_addr is aligned to PAGE_SIZE
1917          * if hba->ucdl_dma_addr is aligned to PAGE_SIZE, then it will
1918          * be aligned to 128 bytes as well
1919          */
1920         if (!hba->ucdl_base_addr ||
1921             WARN_ON(hba->ucdl_dma_addr & (PAGE_SIZE - 1))) {
1922                 dev_err(hba->dev,
1923                         "Command Descriptor Memory allocation failed\n");
1924                 goto out;
1925         }
1926
1927         /*
1928          * Allocate memory for UTP Transfer descriptors
1929          * UFSHCI requires 1024 byte alignment of UTRD
1930          */
1931         utrdl_size = (sizeof(struct utp_transfer_req_desc) * hba->nutrs);
1932         hba->utrdl_base_addr = dmam_alloc_coherent(hba->dev,
1933                                                    utrdl_size,
1934                                                    &hba->utrdl_dma_addr,
1935                                                    GFP_KERNEL);
1936         if (!hba->utrdl_base_addr ||
1937             WARN_ON(hba->utrdl_dma_addr & (PAGE_SIZE - 1))) {
1938                 dev_err(hba->dev,
1939                         "Transfer Descriptor Memory allocation failed\n");
1940                 goto out;
1941         }
1942
1943         /*
1944          * Allocate memory for UTP Task Management descriptors
1945          * UFSHCI requires 1024 byte alignment of UTMRD
1946          */
1947         utmrdl_size = sizeof(struct utp_task_req_desc) * hba->nutmrs;
1948         hba->utmrdl_base_addr = dmam_alloc_coherent(hba->dev,
1949                                                     utmrdl_size,
1950                                                     &hba->utmrdl_dma_addr,
1951                                                     GFP_KERNEL);
1952         if (!hba->utmrdl_base_addr ||
1953             WARN_ON(hba->utmrdl_dma_addr & (PAGE_SIZE - 1))) {
1954                 dev_err(hba->dev,
1955                 "Task Management Descriptor Memory allocation failed\n");
1956                 goto out;
1957         }
1958
1959         /* Allocate memory for local reference block */
1960         hba->lrb = devm_kzalloc(hba->dev,
1961                                 hba->nutrs * sizeof(struct ufshcd_lrb),
1962                                 GFP_KERNEL);
1963         if (!hba->lrb) {
1964                 dev_err(hba->dev, "LRB Memory allocation failed\n");
1965                 goto out;
1966         }
1967         return 0;
1968 out:
1969         return -ENOMEM;
1970 }
1971
1972 /**
1973  * ufshcd_host_memory_configure - configure local reference block with
1974  *                              memory offsets
1975  * @hba: per adapter instance
1976  *
1977  * Configure Host memory space
1978  * 1. Update Corresponding UTRD.UCDBA and UTRD.UCDBAU with UCD DMA
1979  * address.
1980  * 2. Update each UTRD with Response UPIU offset, Response UPIU length
1981  * and PRDT offset.
1982  * 3. Save the corresponding addresses of UTRD, UCD.CMD, UCD.RSP and UCD.PRDT
1983  * into local reference block.
1984  */
1985 static void ufshcd_host_memory_configure(struct ufs_hba *hba)
1986 {
1987         struct utp_transfer_cmd_desc *cmd_descp;
1988         struct utp_transfer_req_desc *utrdlp;
1989         dma_addr_t cmd_desc_dma_addr;
1990         dma_addr_t cmd_desc_element_addr;
1991         u16 response_offset;
1992         u16 prdt_offset;
1993         int cmd_desc_size;
1994         int i;
1995
1996         utrdlp = hba->utrdl_base_addr;
1997         cmd_descp = hba->ucdl_base_addr;
1998
1999         response_offset =
2000                 offsetof(struct utp_transfer_cmd_desc, response_upiu);
2001         prdt_offset =
2002                 offsetof(struct utp_transfer_cmd_desc, prd_table);
2003
2004         cmd_desc_size = sizeof(struct utp_transfer_cmd_desc);
2005         cmd_desc_dma_addr = hba->ucdl_dma_addr;
2006
2007         for (i = 0; i < hba->nutrs; i++) {
2008                 /* Configure UTRD with command descriptor base address */
2009                 cmd_desc_element_addr =
2010                                 (cmd_desc_dma_addr + (cmd_desc_size * i));
2011                 utrdlp[i].command_desc_base_addr_lo =
2012                                 cpu_to_le32(lower_32_bits(cmd_desc_element_addr));
2013                 utrdlp[i].command_desc_base_addr_hi =
2014                                 cpu_to_le32(upper_32_bits(cmd_desc_element_addr));
2015
2016                 /* Response upiu and prdt offset should be in double words */
2017                 utrdlp[i].response_upiu_offset =
2018                                 cpu_to_le16((response_offset >> 2));
2019                 utrdlp[i].prd_table_offset =
2020                                 cpu_to_le16((prdt_offset >> 2));
2021                 utrdlp[i].response_upiu_length =
2022                                 cpu_to_le16(ALIGNED_UPIU_SIZE >> 2);
2023
2024                 hba->lrb[i].utr_descriptor_ptr = (utrdlp + i);
2025                 hba->lrb[i].ucd_req_ptr =
2026                         (struct utp_upiu_req *)(cmd_descp + i);
2027                 hba->lrb[i].ucd_rsp_ptr =
2028                         (struct utp_upiu_rsp *)cmd_descp[i].response_upiu;
2029                 hba->lrb[i].ucd_prdt_ptr =
2030                         (struct ufshcd_sg_entry *)cmd_descp[i].prd_table;
2031         }
2032 }
2033
2034 /**
2035  * ufshcd_dme_link_startup - Notify Unipro to perform link startup
2036  * @hba: per adapter instance
2037  *
2038  * UIC_CMD_DME_LINK_STARTUP command must be issued to Unipro layer,
2039  * in order to initialize the Unipro link startup procedure.
2040  * Once the Unipro links are up, the device connected to the controller
2041  * is detected.
2042  *
2043  * Returns 0 on success, non-zero value on failure
2044  */
2045 static int ufshcd_dme_link_startup(struct ufs_hba *hba)
2046 {
2047         struct uic_command uic_cmd = {0};
2048         int ret;
2049
2050         uic_cmd.command = UIC_CMD_DME_LINK_STARTUP;
2051
2052         ret = ufshcd_send_uic_cmd(hba, &uic_cmd);
2053         if (ret)
2054                 dev_err(hba->dev,
2055                         "dme-link-startup: error code %d\n", ret);
2056         return ret;
2057 }
2058
2059 /**
2060  * ufshcd_dme_set_attr - UIC command for DME_SET, DME_PEER_SET
2061  * @hba: per adapter instance
2062  * @attr_sel: uic command argument1
2063  * @attr_set: attribute set type as uic command argument2
2064  * @mib_val: setting value as uic command argument3
2065  * @peer: indicate whether peer or local
2066  *
2067  * Returns 0 on success, non-zero value on failure
2068  */
2069 int ufshcd_dme_set_attr(struct ufs_hba *hba, u32 attr_sel,
2070                         u8 attr_set, u32 mib_val, u8 peer)
2071 {
2072         struct uic_command uic_cmd = {0};
2073         static const char *const action[] = {
2074                 "dme-set",
2075                 "dme-peer-set"
2076         };
2077         const char *set = action[!!peer];
2078         int ret;
2079
2080         uic_cmd.command = peer ?
2081                 UIC_CMD_DME_PEER_SET : UIC_CMD_DME_SET;
2082         uic_cmd.argument1 = attr_sel;
2083         uic_cmd.argument2 = UIC_ARG_ATTR_TYPE(attr_set);
2084         uic_cmd.argument3 = mib_val;
2085
2086         ret = ufshcd_send_uic_cmd(hba, &uic_cmd);
2087         if (ret)
2088                 dev_err(hba->dev, "%s: attr-id 0x%x val 0x%x error code %d\n",
2089                         set, UIC_GET_ATTR_ID(attr_sel), mib_val, ret);
2090
2091         return ret;
2092 }
2093 EXPORT_SYMBOL_GPL(ufshcd_dme_set_attr);
2094
2095 /**
2096  * ufshcd_dme_get_attr - UIC command for DME_GET, DME_PEER_GET
2097  * @hba: per adapter instance
2098  * @attr_sel: uic command argument1
2099  * @mib_val: the value of the attribute as returned by the UIC command
2100  * @peer: indicate whether peer or local
2101  *
2102  * Returns 0 on success, non-zero value on failure
2103  */
2104 int ufshcd_dme_get_attr(struct ufs_hba *hba, u32 attr_sel,
2105                         u32 *mib_val, u8 peer)
2106 {
2107         struct uic_command uic_cmd = {0};
2108         static const char *const action[] = {
2109                 "dme-get",
2110                 "dme-peer-get"
2111         };
2112         const char *get = action[!!peer];
2113         int ret;
2114
2115         uic_cmd.command = peer ?
2116                 UIC_CMD_DME_PEER_GET : UIC_CMD_DME_GET;
2117         uic_cmd.argument1 = attr_sel;
2118
2119         ret = ufshcd_send_uic_cmd(hba, &uic_cmd);
2120         if (ret) {
2121                 dev_err(hba->dev, "%s: attr-id 0x%x error code %d\n",
2122                         get, UIC_GET_ATTR_ID(attr_sel), ret);
2123                 goto out;
2124         }
2125
2126         if (mib_val)
2127                 *mib_val = uic_cmd.argument3;
2128 out:
2129         return ret;
2130 }
2131 EXPORT_SYMBOL_GPL(ufshcd_dme_get_attr);
2132
2133 /**
2134  * ufshcd_uic_pwr_ctrl - executes UIC commands (which affects the link power
2135  * state) and waits for it to take effect.
2136  *
2137  * @hba: per adapter instance
2138  * @cmd: UIC command to execute
2139  *
2140  * DME operations like DME_SET(PA_PWRMODE), DME_HIBERNATE_ENTER &
2141  * DME_HIBERNATE_EXIT commands take some time to take its effect on both host
2142  * and device UniPro link and hence it's final completion would be indicated by
2143  * dedicated status bits in Interrupt Status register (UPMS, UHES, UHXS) in
2144  * addition to normal UIC command completion Status (UCCS). This function only
2145  * returns after the relevant status bits indicate the completion.
2146  *
2147  * Returns 0 on success, non-zero value on failure
2148  */
2149 static int ufshcd_uic_pwr_ctrl(struct ufs_hba *hba, struct uic_command *cmd)
2150 {
2151         struct completion uic_async_done;
2152         unsigned long flags;
2153         u8 status;
2154         int ret;
2155
2156         mutex_lock(&hba->uic_cmd_mutex);
2157         init_completion(&uic_async_done);
2158
2159         spin_lock_irqsave(hba->host->host_lock, flags);
2160         hba->uic_async_done = &uic_async_done;
2161         ret = __ufshcd_send_uic_cmd(hba, cmd);
2162         spin_unlock_irqrestore(hba->host->host_lock, flags);
2163         if (ret) {
2164                 dev_err(hba->dev,
2165                         "pwr ctrl cmd 0x%x with mode 0x%x uic error %d\n",
2166                         cmd->command, cmd->argument3, ret);
2167                 goto out;
2168         }
2169         ret = ufshcd_wait_for_uic_cmd(hba, cmd);
2170         if (ret) {
2171                 dev_err(hba->dev,
2172                         "pwr ctrl cmd 0x%x with mode 0x%x uic error %d\n",
2173                         cmd->command, cmd->argument3, ret);
2174                 goto out;
2175         }
2176
2177         if (!wait_for_completion_timeout(hba->uic_async_done,
2178                                          msecs_to_jiffies(UIC_CMD_TIMEOUT))) {
2179                 dev_err(hba->dev,
2180                         "pwr ctrl cmd 0x%x with mode 0x%x completion timeout\n",
2181                         cmd->command, cmd->argument3);
2182                 ret = -ETIMEDOUT;
2183                 goto out;
2184         }
2185
2186         status = ufshcd_get_upmcrs(hba);
2187         if (status != PWR_LOCAL) {
2188                 dev_err(hba->dev,
2189                         "pwr ctrl cmd 0x%0x failed, host umpcrs:0x%x\n",
2190                         cmd->command, status);
2191                 ret = (status != PWR_OK) ? status : -1;
2192         }
2193 out:
2194         spin_lock_irqsave(hba->host->host_lock, flags);
2195         hba->uic_async_done = NULL;
2196         spin_unlock_irqrestore(hba->host->host_lock, flags);
2197         mutex_unlock(&hba->uic_cmd_mutex);
2198
2199         return ret;
2200 }
2201
2202 /**
2203  * ufshcd_uic_change_pwr_mode - Perform the UIC power mode chage
2204  *                              using DME_SET primitives.
2205  * @hba: per adapter instance
2206  * @mode: powr mode value
2207  *
2208  * Returns 0 on success, non-zero value on failure
2209  */
2210 static int ufshcd_uic_change_pwr_mode(struct ufs_hba *hba, u8 mode)
2211 {
2212         struct uic_command uic_cmd = {0};
2213         int ret;
2214
2215         uic_cmd.command = UIC_CMD_DME_SET;
2216         uic_cmd.argument1 = UIC_ARG_MIB(PA_PWRMODE);
2217         uic_cmd.argument3 = mode;
2218         ufshcd_hold(hba, false);
2219         ret = ufshcd_uic_pwr_ctrl(hba, &uic_cmd);
2220         ufshcd_release(hba);
2221
2222         return ret;
2223 }
2224
2225 static int ufshcd_uic_hibern8_enter(struct ufs_hba *hba)
2226 {
2227         struct uic_command uic_cmd = {0};
2228
2229         uic_cmd.command = UIC_CMD_DME_HIBER_ENTER;
2230
2231         return ufshcd_uic_pwr_ctrl(hba, &uic_cmd);
2232 }
2233
2234 static int ufshcd_uic_hibern8_exit(struct ufs_hba *hba)
2235 {
2236         struct uic_command uic_cmd = {0};
2237         int ret;
2238
2239         uic_cmd.command = UIC_CMD_DME_HIBER_EXIT;
2240         ret = ufshcd_uic_pwr_ctrl(hba, &uic_cmd);
2241         if (ret) {
2242                 ufshcd_set_link_off(hba);
2243                 ret = ufshcd_host_reset_and_restore(hba);
2244         }
2245
2246         return ret;
2247 }
2248
2249 /**
2250  * ufshcd_get_max_pwr_mode - reads the max power mode negotiated with device
2251  * @hba: per-adapter instance
2252  */
2253 static int ufshcd_get_max_pwr_mode(struct ufs_hba *hba)
2254 {
2255         struct ufs_pa_layer_attr *pwr_info = &hba->max_pwr_info.info;
2256
2257         if (hba->max_pwr_info.is_valid)
2258                 return 0;
2259
2260         pwr_info->pwr_tx = FASTAUTO_MODE;
2261         pwr_info->pwr_rx = FASTAUTO_MODE;
2262         pwr_info->hs_rate = PA_HS_MODE_B;
2263
2264         /* Get the connected lane count */
2265         ufshcd_dme_get(hba, UIC_ARG_MIB(PA_CONNECTEDRXDATALANES),
2266                         &pwr_info->lane_rx);
2267         ufshcd_dme_get(hba, UIC_ARG_MIB(PA_CONNECTEDTXDATALANES),
2268                         &pwr_info->lane_tx);
2269
2270         if (!pwr_info->lane_rx || !pwr_info->lane_tx) {
2271                 dev_err(hba->dev, "%s: invalid connected lanes value. rx=%d, tx=%d\n",
2272                                 __func__,
2273                                 pwr_info->lane_rx,
2274                                 pwr_info->lane_tx);
2275                 return -EINVAL;
2276         }
2277
2278         /*
2279          * First, get the maximum gears of HS speed.
2280          * If a zero value, it means there is no HSGEAR capability.
2281          * Then, get the maximum gears of PWM speed.
2282          */
2283         ufshcd_dme_get(hba, UIC_ARG_MIB(PA_MAXRXHSGEAR), &pwr_info->gear_rx);
2284         if (!pwr_info->gear_rx) {
2285                 ufshcd_dme_get(hba, UIC_ARG_MIB(PA_MAXRXPWMGEAR),
2286                                 &pwr_info->gear_rx);
2287                 if (!pwr_info->gear_rx) {
2288                         dev_err(hba->dev, "%s: invalid max pwm rx gear read = %d\n",
2289                                 __func__, pwr_info->gear_rx);
2290                         return -EINVAL;
2291                 }
2292                 pwr_info->pwr_rx = SLOWAUTO_MODE;
2293         }
2294
2295         ufshcd_dme_peer_get(hba, UIC_ARG_MIB(PA_MAXRXHSGEAR),
2296                         &pwr_info->gear_tx);
2297         if (!pwr_info->gear_tx) {
2298                 ufshcd_dme_peer_get(hba, UIC_ARG_MIB(PA_MAXRXPWMGEAR),
2299                                 &pwr_info->gear_tx);
2300                 if (!pwr_info->gear_tx) {
2301                         dev_err(hba->dev, "%s: invalid max pwm tx gear read = %d\n",
2302                                 __func__, pwr_info->gear_tx);
2303                         return -EINVAL;
2304                 }
2305                 pwr_info->pwr_tx = SLOWAUTO_MODE;
2306         }
2307
2308         hba->max_pwr_info.is_valid = true;
2309         return 0;
2310 }
2311
2312 static int ufshcd_change_power_mode(struct ufs_hba *hba,
2313                              struct ufs_pa_layer_attr *pwr_mode)
2314 {
2315         int ret;
2316
2317         /* if already configured to the requested pwr_mode */
2318         if (pwr_mode->gear_rx == hba->pwr_info.gear_rx &&
2319             pwr_mode->gear_tx == hba->pwr_info.gear_tx &&
2320             pwr_mode->lane_rx == hba->pwr_info.lane_rx &&
2321             pwr_mode->lane_tx == hba->pwr_info.lane_tx &&
2322             pwr_mode->pwr_rx == hba->pwr_info.pwr_rx &&
2323             pwr_mode->pwr_tx == hba->pwr_info.pwr_tx &&
2324             pwr_mode->hs_rate == hba->pwr_info.hs_rate) {
2325                 dev_dbg(hba->dev, "%s: power already configured\n", __func__);
2326                 return 0;
2327         }
2328
2329         /*
2330          * Configure attributes for power mode change with below.
2331          * - PA_RXGEAR, PA_ACTIVERXDATALANES, PA_RXTERMINATION,
2332          * - PA_TXGEAR, PA_ACTIVETXDATALANES, PA_TXTERMINATION,
2333          * - PA_HSSERIES
2334          */
2335         ufshcd_dme_set(hba, UIC_ARG_MIB(PA_RXGEAR), pwr_mode->gear_rx);
2336         ufshcd_dme_set(hba, UIC_ARG_MIB(PA_ACTIVERXDATALANES),
2337                         pwr_mode->lane_rx);
2338         if (pwr_mode->pwr_rx == FASTAUTO_MODE ||
2339                         pwr_mode->pwr_rx == FAST_MODE)
2340                 ufshcd_dme_set(hba, UIC_ARG_MIB(PA_RXTERMINATION), TRUE);
2341         else
2342                 ufshcd_dme_set(hba, UIC_ARG_MIB(PA_RXTERMINATION), FALSE);
2343
2344         ufshcd_dme_set(hba, UIC_ARG_MIB(PA_TXGEAR), pwr_mode->gear_tx);
2345         ufshcd_dme_set(hba, UIC_ARG_MIB(PA_ACTIVETXDATALANES),
2346                         pwr_mode->lane_tx);
2347         if (pwr_mode->pwr_tx == FASTAUTO_MODE ||
2348                         pwr_mode->pwr_tx == FAST_MODE)
2349                 ufshcd_dme_set(hba, UIC_ARG_MIB(PA_TXTERMINATION), TRUE);
2350         else
2351                 ufshcd_dme_set(hba, UIC_ARG_MIB(PA_TXTERMINATION), FALSE);
2352
2353         if (pwr_mode->pwr_rx == FASTAUTO_MODE ||
2354             pwr_mode->pwr_tx == FASTAUTO_MODE ||
2355             pwr_mode->pwr_rx == FAST_MODE ||
2356             pwr_mode->pwr_tx == FAST_MODE)
2357                 ufshcd_dme_set(hba, UIC_ARG_MIB(PA_HSSERIES),
2358                                                 pwr_mode->hs_rate);
2359
2360         ret = ufshcd_uic_change_pwr_mode(hba, pwr_mode->pwr_rx << 4
2361                         | pwr_mode->pwr_tx);
2362
2363         if (ret) {
2364                 dev_err(hba->dev,
2365                         "%s: power mode change failed %d\n", __func__, ret);
2366         } else {
2367                 if (hba->vops && hba->vops->pwr_change_notify)
2368                         hba->vops->pwr_change_notify(hba,
2369                                 POST_CHANGE, NULL, pwr_mode);
2370
2371                 memcpy(&hba->pwr_info, pwr_mode,
2372                         sizeof(struct ufs_pa_layer_attr));
2373         }
2374
2375         return ret;
2376 }
2377
2378 /**
2379  * ufshcd_config_pwr_mode - configure a new power mode
2380  * @hba: per-adapter instance
2381  * @desired_pwr_mode: desired power configuration
2382  */
2383 static int ufshcd_config_pwr_mode(struct ufs_hba *hba,
2384                 struct ufs_pa_layer_attr *desired_pwr_mode)
2385 {
2386         struct ufs_pa_layer_attr final_params = { 0 };
2387         int ret;
2388
2389         if (hba->vops && hba->vops->pwr_change_notify)
2390                 hba->vops->pwr_change_notify(hba,
2391                      PRE_CHANGE, desired_pwr_mode, &final_params);
2392         else
2393                 memcpy(&final_params, desired_pwr_mode, sizeof(final_params));
2394
2395         ret = ufshcd_change_power_mode(hba, &final_params);
2396
2397         return ret;
2398 }
2399
2400 /**
2401  * ufshcd_complete_dev_init() - checks device readiness
2402  * hba: per-adapter instance
2403  *
2404  * Set fDeviceInit flag and poll until device toggles it.
2405  */
2406 static int ufshcd_complete_dev_init(struct ufs_hba *hba)
2407 {
2408         int i, retries, err = 0;
2409         bool flag_res = 1;
2410
2411         for (retries = QUERY_REQ_RETRIES; retries > 0; retries--) {
2412                 /* Set the fDeviceInit flag */
2413                 err = ufshcd_query_flag(hba, UPIU_QUERY_OPCODE_SET_FLAG,
2414                                         QUERY_FLAG_IDN_FDEVICEINIT, NULL);
2415                 if (!err || err == -ETIMEDOUT)
2416                         break;
2417                 dev_dbg(hba->dev, "%s: error %d retrying\n", __func__, err);
2418         }
2419         if (err) {
2420                 dev_err(hba->dev,
2421                         "%s setting fDeviceInit flag failed with error %d\n",
2422                         __func__, err);
2423                 goto out;
2424         }
2425
2426         /* poll for max. 100 iterations for fDeviceInit flag to clear */
2427         for (i = 0; i < 100 && !err && flag_res; i++) {
2428                 for (retries = QUERY_REQ_RETRIES; retries > 0; retries--) {
2429                         err = ufshcd_query_flag(hba,
2430                                         UPIU_QUERY_OPCODE_READ_FLAG,
2431                                         QUERY_FLAG_IDN_FDEVICEINIT, &flag_res);
2432                         if (!err || err == -ETIMEDOUT)
2433                                 break;
2434                         dev_dbg(hba->dev, "%s: error %d retrying\n", __func__,
2435                                         err);
2436                 }
2437         }
2438         if (err)
2439                 dev_err(hba->dev,
2440                         "%s reading fDeviceInit flag failed with error %d\n",
2441                         __func__, err);
2442         else if (flag_res)
2443                 dev_err(hba->dev,
2444                         "%s fDeviceInit was not cleared by the device\n",
2445                         __func__);
2446
2447 out:
2448         return err;
2449 }
2450
2451 /**
2452  * ufshcd_make_hba_operational - Make UFS controller operational
2453  * @hba: per adapter instance
2454  *
2455  * To bring UFS host controller to operational state,
2456  * 1. Enable required interrupts
2457  * 2. Configure interrupt aggregation
2458  * 3. Program UTRL and UTMRL base addres
2459  * 4. Configure run-stop-registers
2460  *
2461  * Returns 0 on success, non-zero value on failure
2462  */
2463 static int ufshcd_make_hba_operational(struct ufs_hba *hba)
2464 {
2465         int err = 0;
2466         u32 reg;
2467
2468         /* Enable required interrupts */
2469         ufshcd_enable_intr(hba, UFSHCD_ENABLE_INTRS);
2470
2471         /* Configure interrupt aggregation */
2472         ufshcd_config_intr_aggr(hba, hba->nutrs - 1, INT_AGGR_DEF_TO);
2473
2474         /* Configure UTRL and UTMRL base address registers */
2475         ufshcd_writel(hba, lower_32_bits(hba->utrdl_dma_addr),
2476                         REG_UTP_TRANSFER_REQ_LIST_BASE_L);
2477         ufshcd_writel(hba, upper_32_bits(hba->utrdl_dma_addr),
2478                         REG_UTP_TRANSFER_REQ_LIST_BASE_H);
2479         ufshcd_writel(hba, lower_32_bits(hba->utmrdl_dma_addr),
2480                         REG_UTP_TASK_REQ_LIST_BASE_L);
2481         ufshcd_writel(hba, upper_32_bits(hba->utmrdl_dma_addr),
2482                         REG_UTP_TASK_REQ_LIST_BASE_H);
2483
2484         /*
2485          * UCRDY, UTMRLDY and UTRLRDY bits must be 1
2486          * DEI, HEI bits must be 0
2487          */
2488         reg = ufshcd_readl(hba, REG_CONTROLLER_STATUS);
2489         if (!(ufshcd_get_lists_status(reg))) {
2490                 ufshcd_enable_run_stop_reg(hba);
2491         } else {
2492                 dev_err(hba->dev,
2493                         "Host controller not ready to process requests");
2494                 err = -EIO;
2495                 goto out;
2496         }
2497
2498 out:
2499         return err;
2500 }
2501
2502 /**
2503  * ufshcd_hba_enable - initialize the controller
2504  * @hba: per adapter instance
2505  *
2506  * The controller resets itself and controller firmware initialization
2507  * sequence kicks off. When controller is ready it will set
2508  * the Host Controller Enable bit to 1.
2509  *
2510  * Returns 0 on success, non-zero value on failure
2511  */
2512 static int ufshcd_hba_enable(struct ufs_hba *hba)
2513 {
2514         int retry;
2515
2516         /*
2517          * msleep of 1 and 5 used in this function might result in msleep(20),
2518          * but it was necessary to send the UFS FPGA to reset mode during
2519          * development and testing of this driver. msleep can be changed to
2520          * mdelay and retry count can be reduced based on the controller.
2521          */
2522         if (!ufshcd_is_hba_active(hba)) {
2523
2524                 /* change controller state to "reset state" */
2525                 ufshcd_hba_stop(hba);
2526
2527                 /*
2528                  * This delay is based on the testing done with UFS host
2529                  * controller FPGA. The delay can be changed based on the
2530                  * host controller used.
2531                  */
2532                 msleep(5);
2533         }
2534
2535         /* UniPro link is disabled at this point */
2536         ufshcd_set_link_off(hba);
2537
2538         if (hba->vops && hba->vops->hce_enable_notify)
2539                 hba->vops->hce_enable_notify(hba, PRE_CHANGE);
2540
2541         /* start controller initialization sequence */
2542         ufshcd_hba_start(hba);
2543
2544         /*
2545          * To initialize a UFS host controller HCE bit must be set to 1.
2546          * During initialization the HCE bit value changes from 1->0->1.
2547          * When the host controller completes initialization sequence
2548          * it sets the value of HCE bit to 1. The same HCE bit is read back
2549          * to check if the controller has completed initialization sequence.
2550          * So without this delay the value HCE = 1, set in the previous
2551          * instruction might be read back.
2552          * This delay can be changed based on the controller.
2553          */
2554         msleep(1);
2555
2556         /* wait for the host controller to complete initialization */
2557         retry = 10;
2558         while (ufshcd_is_hba_active(hba)) {
2559                 if (retry) {
2560                         retry--;
2561                 } else {
2562                         dev_err(hba->dev,
2563                                 "Controller enable failed\n");
2564                         return -EIO;
2565                 }
2566                 msleep(5);
2567         }
2568
2569         /* enable UIC related interrupts */
2570         ufshcd_enable_intr(hba, UFSHCD_UIC_MASK);
2571
2572         if (hba->vops && hba->vops->hce_enable_notify)
2573                 hba->vops->hce_enable_notify(hba, POST_CHANGE);
2574
2575         return 0;
2576 }
2577
2578 /**
2579  * ufshcd_link_startup - Initialize unipro link startup
2580  * @hba: per adapter instance
2581  *
2582  * Returns 0 for success, non-zero in case of failure
2583  */
2584 static int ufshcd_link_startup(struct ufs_hba *hba)
2585 {
2586         int ret;
2587         int retries = DME_LINKSTARTUP_RETRIES;
2588
2589         do {
2590                 if (hba->vops && hba->vops->link_startup_notify)
2591                         hba->vops->link_startup_notify(hba, PRE_CHANGE);
2592
2593                 ret = ufshcd_dme_link_startup(hba);
2594
2595                 /* check if device is detected by inter-connect layer */
2596                 if (!ret && !ufshcd_is_device_present(hba)) {
2597                         dev_err(hba->dev, "%s: Device not present\n", __func__);
2598                         ret = -ENXIO;
2599                         goto out;
2600                 }
2601
2602                 /*
2603                  * DME link lost indication is only received when link is up,
2604                  * but we can't be sure if the link is up until link startup
2605                  * succeeds. So reset the local Uni-Pro and try again.
2606                  */
2607                 if (ret && ufshcd_hba_enable(hba))
2608                         goto out;
2609         } while (ret && retries--);
2610
2611         if (ret)
2612                 /* failed to get the link up... retire */
2613                 goto out;
2614
2615         /* Include any host controller configuration via UIC commands */
2616         if (hba->vops && hba->vops->link_startup_notify) {
2617                 ret = hba->vops->link_startup_notify(hba, POST_CHANGE);
2618                 if (ret)
2619                         goto out;
2620         }
2621
2622         ret = ufshcd_make_hba_operational(hba);
2623 out:
2624         if (ret)
2625                 dev_err(hba->dev, "link startup failed %d\n", ret);
2626         return ret;
2627 }
2628
2629 /**
2630  * ufshcd_verify_dev_init() - Verify device initialization
2631  * @hba: per-adapter instance
2632  *
2633  * Send NOP OUT UPIU and wait for NOP IN response to check whether the
2634  * device Transport Protocol (UTP) layer is ready after a reset.
2635  * If the UTP layer at the device side is not initialized, it may
2636  * not respond with NOP IN UPIU within timeout of %NOP_OUT_TIMEOUT
2637  * and we retry sending NOP OUT for %NOP_OUT_RETRIES iterations.
2638  */
2639 static int ufshcd_verify_dev_init(struct ufs_hba *hba)
2640 {
2641         int err = 0;
2642         int retries;
2643
2644         ufshcd_hold(hba, false);
2645         mutex_lock(&hba->dev_cmd.lock);
2646         for (retries = NOP_OUT_RETRIES; retries > 0; retries--) {
2647                 err = ufshcd_exec_dev_cmd(hba, DEV_CMD_TYPE_NOP,
2648                                                NOP_OUT_TIMEOUT);
2649
2650                 if (!err || err == -ETIMEDOUT)
2651                         break;
2652
2653                 dev_dbg(hba->dev, "%s: error %d retrying\n", __func__, err);
2654         }
2655         mutex_unlock(&hba->dev_cmd.lock);
2656         ufshcd_release(hba);
2657
2658         if (err)
2659                 dev_err(hba->dev, "%s: NOP OUT failed %d\n", __func__, err);
2660         return err;
2661 }
2662
2663 /**
2664  * ufshcd_set_queue_depth - set lun queue depth
2665  * @sdev: pointer to SCSI device
2666  *
2667  * Read bLUQueueDepth value and activate scsi tagged command
2668  * queueing. For WLUN, queue depth is set to 1. For best-effort
2669  * cases (bLUQueueDepth = 0) the queue depth is set to a maximum
2670  * value that host can queue.
2671  */
2672 static void ufshcd_set_queue_depth(struct scsi_device *sdev)
2673 {
2674         int ret = 0;
2675         u8 lun_qdepth;
2676         struct ufs_hba *hba;
2677
2678         hba = shost_priv(sdev->host);
2679
2680         lun_qdepth = hba->nutrs;
2681         ret = ufshcd_read_unit_desc_param(hba,
2682                                           ufshcd_scsi_to_upiu_lun(sdev->lun),
2683                                           UNIT_DESC_PARAM_LU_Q_DEPTH,
2684                                           &lun_qdepth,
2685                                           sizeof(lun_qdepth));
2686
2687         /* Some WLUN doesn't support unit descriptor */
2688         if (ret == -EOPNOTSUPP)
2689                 lun_qdepth = 1;
2690         else if (!lun_qdepth)
2691                 /* eventually, we can figure out the real queue depth */
2692                 lun_qdepth = hba->nutrs;
2693         else
2694                 lun_qdepth = min_t(int, lun_qdepth, hba->nutrs);
2695
2696         dev_dbg(hba->dev, "%s: activate tcq with queue depth %d\n",
2697                         __func__, lun_qdepth);
2698         scsi_change_queue_depth(sdev, lun_qdepth);
2699 }
2700
2701 /*
2702  * ufshcd_get_lu_wp - returns the "b_lu_write_protect" from UNIT DESCRIPTOR
2703  * @hba: per-adapter instance
2704  * @lun: UFS device lun id
2705  * @b_lu_write_protect: pointer to buffer to hold the LU's write protect info
2706  *
2707  * Returns 0 in case of success and b_lu_write_protect status would be returned
2708  * @b_lu_write_protect parameter.
2709  * Returns -ENOTSUPP if reading b_lu_write_protect is not supported.
2710  * Returns -EINVAL in case of invalid parameters passed to this function.
2711  */
2712 static int ufshcd_get_lu_wp(struct ufs_hba *hba,
2713                             u8 lun,
2714                             u8 *b_lu_write_protect)
2715 {
2716         int ret;
2717
2718         if (!b_lu_write_protect)
2719                 ret = -EINVAL;
2720         /*
2721          * According to UFS device spec, RPMB LU can't be write
2722          * protected so skip reading bLUWriteProtect parameter for
2723          * it. For other W-LUs, UNIT DESCRIPTOR is not available.
2724          */
2725         else if (lun >= UFS_UPIU_MAX_GENERAL_LUN)
2726                 ret = -ENOTSUPP;
2727         else
2728                 ret = ufshcd_read_unit_desc_param(hba,
2729                                           lun,
2730                                           UNIT_DESC_PARAM_LU_WR_PROTECT,
2731                                           b_lu_write_protect,
2732                                           sizeof(*b_lu_write_protect));
2733         return ret;
2734 }
2735
2736 /**
2737  * ufshcd_get_lu_power_on_wp_status - get LU's power on write protect
2738  * status
2739  * @hba: per-adapter instance
2740  * @sdev: pointer to SCSI device
2741  *
2742  */
2743 static inline void ufshcd_get_lu_power_on_wp_status(struct ufs_hba *hba,
2744                                                     struct scsi_device *sdev)
2745 {
2746         if (hba->dev_info.f_power_on_wp_en &&
2747             !hba->dev_info.is_lu_power_on_wp) {
2748                 u8 b_lu_write_protect;
2749
2750                 if (!ufshcd_get_lu_wp(hba, ufshcd_scsi_to_upiu_lun(sdev->lun),
2751                                       &b_lu_write_protect) &&
2752                     (b_lu_write_protect == UFS_LU_POWER_ON_WP))
2753                         hba->dev_info.is_lu_power_on_wp = true;
2754         }
2755 }
2756
2757 /**
2758  * ufshcd_slave_alloc - handle initial SCSI device configurations
2759  * @sdev: pointer to SCSI device
2760  *
2761  * Returns success
2762  */
2763 static int ufshcd_slave_alloc(struct scsi_device *sdev)
2764 {
2765         struct ufs_hba *hba;
2766
2767         hba = shost_priv(sdev->host);
2768
2769         /* Mode sense(6) is not supported by UFS, so use Mode sense(10) */
2770         sdev->use_10_for_ms = 1;
2771
2772         /* allow SCSI layer to restart the device in case of errors */
2773         sdev->allow_restart = 1;
2774
2775         /* REPORT SUPPORTED OPERATION CODES is not supported */
2776         sdev->no_report_opcodes = 1;
2777
2778
2779         ufshcd_set_queue_depth(sdev);
2780
2781         ufshcd_get_lu_power_on_wp_status(hba, sdev);
2782
2783         return 0;
2784 }
2785
2786 /**
2787  * ufshcd_change_queue_depth - change queue depth
2788  * @sdev: pointer to SCSI device
2789  * @depth: required depth to set
2790  *
2791  * Change queue depth and make sure the max. limits are not crossed.
2792  */
2793 static int ufshcd_change_queue_depth(struct scsi_device *sdev, int depth)
2794 {
2795         struct ufs_hba *hba = shost_priv(sdev->host);
2796
2797         if (depth > hba->nutrs)
2798                 depth = hba->nutrs;
2799         return scsi_change_queue_depth(sdev, depth);
2800 }
2801
2802 /**
2803  * ufshcd_slave_configure - adjust SCSI device configurations
2804  * @sdev: pointer to SCSI device
2805  */
2806 static int ufshcd_slave_configure(struct scsi_device *sdev)
2807 {
2808         struct request_queue *q = sdev->request_queue;
2809
2810         blk_queue_update_dma_pad(q, PRDT_DATA_BYTE_COUNT_PAD - 1);
2811         blk_queue_max_segment_size(q, PRDT_DATA_BYTE_COUNT_MAX);
2812
2813         return 0;
2814 }
2815
2816 /**
2817  * ufshcd_slave_destroy - remove SCSI device configurations
2818  * @sdev: pointer to SCSI device
2819  */
2820 static void ufshcd_slave_destroy(struct scsi_device *sdev)
2821 {
2822         struct ufs_hba *hba;
2823
2824         hba = shost_priv(sdev->host);
2825         /* Drop the reference as it won't be needed anymore */
2826         if (ufshcd_scsi_to_upiu_lun(sdev->lun) == UFS_UPIU_UFS_DEVICE_WLUN)
2827                 hba->sdev_ufs_device = NULL;
2828 }
2829
2830 /**
2831  * ufshcd_task_req_compl - handle task management request completion
2832  * @hba: per adapter instance
2833  * @index: index of the completed request
2834  * @resp: task management service response
2835  *
2836  * Returns non-zero value on error, zero on success
2837  */
2838 static int ufshcd_task_req_compl(struct ufs_hba *hba, u32 index, u8 *resp)
2839 {
2840         struct utp_task_req_desc *task_req_descp;
2841         struct utp_upiu_task_rsp *task_rsp_upiup;
2842         unsigned long flags;
2843         int ocs_value;
2844         int task_result;
2845
2846         spin_lock_irqsave(hba->host->host_lock, flags);
2847
2848         /* Clear completed tasks from outstanding_tasks */
2849         __clear_bit(index, &hba->outstanding_tasks);
2850
2851         task_req_descp = hba->utmrdl_base_addr;
2852         ocs_value = ufshcd_get_tmr_ocs(&task_req_descp[index]);
2853
2854         if (ocs_value == OCS_SUCCESS) {
2855                 task_rsp_upiup = (struct utp_upiu_task_rsp *)
2856                                 task_req_descp[index].task_rsp_upiu;
2857                 task_result = be32_to_cpu(task_rsp_upiup->header.dword_1);
2858                 task_result = ((task_result & MASK_TASK_RESPONSE) >> 8);
2859                 if (resp)
2860                         *resp = (u8)task_result;
2861         } else {
2862                 dev_err(hba->dev, "%s: failed, ocs = 0x%x\n",
2863                                 __func__, ocs_value);
2864         }
2865         spin_unlock_irqrestore(hba->host->host_lock, flags);
2866
2867         return ocs_value;
2868 }
2869
2870 /**
2871  * ufshcd_scsi_cmd_status - Update SCSI command result based on SCSI status
2872  * @lrb: pointer to local reference block of completed command
2873  * @scsi_status: SCSI command status
2874  *
2875  * Returns value base on SCSI command status
2876  */
2877 static inline int
2878 ufshcd_scsi_cmd_status(struct ufshcd_lrb *lrbp, int scsi_status)
2879 {
2880         int result = 0;
2881
2882         switch (scsi_status) {
2883         case SAM_STAT_CHECK_CONDITION:
2884                 ufshcd_copy_sense_data(lrbp);
2885         case SAM_STAT_GOOD:
2886                 result |= DID_OK << 16 |
2887                           COMMAND_COMPLETE << 8 |
2888                           scsi_status;
2889                 break;
2890         case SAM_STAT_TASK_SET_FULL:
2891         case SAM_STAT_BUSY:
2892         case SAM_STAT_TASK_ABORTED:
2893                 ufshcd_copy_sense_data(lrbp);
2894                 result |= scsi_status;
2895                 break;
2896         default:
2897                 result |= DID_ERROR << 16;
2898                 break;
2899         } /* end of switch */
2900
2901         return result;
2902 }
2903
2904 /**
2905  * ufshcd_transfer_rsp_status - Get overall status of the response
2906  * @hba: per adapter instance
2907  * @lrb: pointer to local reference block of completed command
2908  *
2909  * Returns result of the command to notify SCSI midlayer
2910  */
2911 static inline int
2912 ufshcd_transfer_rsp_status(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
2913 {
2914         int result = 0;
2915         int scsi_status;
2916         int ocs;
2917
2918         /* overall command status of utrd */
2919         ocs = ufshcd_get_tr_ocs(lrbp);
2920
2921         switch (ocs) {
2922         case OCS_SUCCESS:
2923                 result = ufshcd_get_req_rsp(lrbp->ucd_rsp_ptr);
2924
2925                 switch (result) {
2926                 case UPIU_TRANSACTION_RESPONSE:
2927                         /*
2928                          * get the response UPIU result to extract
2929                          * the SCSI command status
2930                          */
2931                         result = ufshcd_get_rsp_upiu_result(lrbp->ucd_rsp_ptr);
2932
2933                         /*
2934                          * get the result based on SCSI status response
2935                          * to notify the SCSI midlayer of the command status
2936                          */
2937                         scsi_status = result & MASK_SCSI_STATUS;
2938                         result = ufshcd_scsi_cmd_status(lrbp, scsi_status);
2939
2940                         if (ufshcd_is_exception_event(lrbp->ucd_rsp_ptr))
2941                                 schedule_work(&hba->eeh_work);
2942                         break;
2943                 case UPIU_TRANSACTION_REJECT_UPIU:
2944                         /* TODO: handle Reject UPIU Response */
2945                         result = DID_ERROR << 16;
2946                         dev_err(hba->dev,
2947                                 "Reject UPIU not fully implemented\n");
2948                         break;
2949                 default:
2950                         result = DID_ERROR << 16;
2951                         dev_err(hba->dev,
2952                                 "Unexpected request response code = %x\n",
2953                                 result);
2954                         break;
2955                 }
2956                 break;
2957         case OCS_ABORTED:
2958                 result |= DID_ABORT << 16;
2959                 break;
2960         case OCS_INVALID_COMMAND_STATUS:
2961                 result |= DID_REQUEUE << 16;
2962                 break;
2963         case OCS_INVALID_CMD_TABLE_ATTR:
2964         case OCS_INVALID_PRDT_ATTR:
2965         case OCS_MISMATCH_DATA_BUF_SIZE:
2966         case OCS_MISMATCH_RESP_UPIU_SIZE:
2967         case OCS_PEER_COMM_FAILURE:
2968         case OCS_FATAL_ERROR:
2969         default:
2970                 result |= DID_ERROR << 16;
2971                 dev_err(hba->dev,
2972                 "OCS error from controller = %x\n", ocs);
2973                 break;
2974         } /* end of switch */
2975
2976         return result;
2977 }
2978
2979 /**
2980  * ufshcd_uic_cmd_compl - handle completion of uic command
2981  * @hba: per adapter instance
2982  * @intr_status: interrupt status generated by the controller
2983  */
2984 static void ufshcd_uic_cmd_compl(struct ufs_hba *hba, u32 intr_status)
2985 {
2986         if ((intr_status & UIC_COMMAND_COMPL) && hba->active_uic_cmd) {
2987                 hba->active_uic_cmd->argument2 |=
2988                         ufshcd_get_uic_cmd_result(hba);
2989                 hba->active_uic_cmd->argument3 =
2990                         ufshcd_get_dme_attr_val(hba);
2991                 complete(&hba->active_uic_cmd->done);
2992         }
2993
2994         if ((intr_status & UFSHCD_UIC_PWR_MASK) && hba->uic_async_done)
2995                 complete(hba->uic_async_done);
2996 }
2997
2998 /**
2999  * ufshcd_transfer_req_compl - handle SCSI and query command completion
3000  * @hba: per adapter instance
3001  */
3002 static void ufshcd_transfer_req_compl(struct ufs_hba *hba)
3003 {
3004         struct ufshcd_lrb *lrbp;
3005         struct scsi_cmnd *cmd;
3006         unsigned long completed_reqs;
3007         u32 tr_doorbell;
3008         int result;
3009         int index;
3010
3011         /* Resetting interrupt aggregation counters first and reading the
3012          * DOOR_BELL afterward allows us to handle all the completed requests.
3013          * In order to prevent other interrupts starvation the DB is read once
3014          * after reset. The down side of this solution is the possibility of
3015          * false interrupt if device completes another request after resetting
3016          * aggregation and before reading the DB.
3017          */
3018         ufshcd_reset_intr_aggr(hba);
3019
3020         tr_doorbell = ufshcd_readl(hba, REG_UTP_TRANSFER_REQ_DOOR_BELL);
3021         completed_reqs = tr_doorbell ^ hba->outstanding_reqs;
3022
3023         for_each_set_bit(index, &completed_reqs, hba->nutrs) {
3024                 lrbp = &hba->lrb[index];
3025                 cmd = lrbp->cmd;
3026                 if (cmd) {
3027                         result = ufshcd_transfer_rsp_status(hba, lrbp);
3028                         scsi_dma_unmap(cmd);
3029                         cmd->result = result;
3030                         /* Mark completed command as NULL in LRB */
3031                         lrbp->cmd = NULL;
3032                         clear_bit_unlock(index, &hba->lrb_in_use);
3033                         /* Do not touch lrbp after scsi done */
3034                         cmd->scsi_done(cmd);
3035                         __ufshcd_release(hba);
3036                 } else if (lrbp->command_type == UTP_CMD_TYPE_DEV_MANAGE) {
3037                         if (hba->dev_cmd.complete)
3038                                 complete(hba->dev_cmd.complete);
3039                 }
3040         }
3041
3042         /* clear corresponding bits of completed commands */
3043         hba->outstanding_reqs ^= completed_reqs;
3044
3045         ufshcd_clk_scaling_update_busy(hba);
3046
3047         /* we might have free'd some tags above */
3048         wake_up(&hba->dev_cmd.tag_wq);
3049 }
3050
3051 /**
3052  * ufshcd_disable_ee - disable exception event
3053  * @hba: per-adapter instance
3054  * @mask: exception event to disable
3055  *
3056  * Disables exception event in the device so that the EVENT_ALERT
3057  * bit is not set.
3058  *
3059  * Returns zero on success, non-zero error value on failure.
3060  */
3061 static int ufshcd_disable_ee(struct ufs_hba *hba, u16 mask)
3062 {
3063         int err = 0;
3064         u32 val;
3065
3066         if (!(hba->ee_ctrl_mask & mask))
3067                 goto out;
3068
3069         val = hba->ee_ctrl_mask & ~mask;
3070         val &= 0xFFFF; /* 2 bytes */
3071         err = ufshcd_query_attr(hba, UPIU_QUERY_OPCODE_WRITE_ATTR,
3072                         QUERY_ATTR_IDN_EE_CONTROL, 0, 0, &val);
3073         if (!err)
3074                 hba->ee_ctrl_mask &= ~mask;
3075 out:
3076         return err;
3077 }
3078
3079 /**
3080  * ufshcd_enable_ee - enable exception event
3081  * @hba: per-adapter instance
3082  * @mask: exception event to enable
3083  *
3084  * Enable corresponding exception event in the device to allow
3085  * device to alert host in critical scenarios.
3086  *
3087  * Returns zero on success, non-zero error value on failure.
3088  */
3089 static int ufshcd_enable_ee(struct ufs_hba *hba, u16 mask)
3090 {
3091         int err = 0;
3092         u32 val;
3093
3094         if (hba->ee_ctrl_mask & mask)
3095                 goto out;
3096
3097         val = hba->ee_ctrl_mask | mask;
3098         val &= 0xFFFF; /* 2 bytes */
3099         err = ufshcd_query_attr(hba, UPIU_QUERY_OPCODE_WRITE_ATTR,
3100                         QUERY_ATTR_IDN_EE_CONTROL, 0, 0, &val);
3101         if (!err)
3102                 hba->ee_ctrl_mask |= mask;
3103 out:
3104         return err;
3105 }
3106
3107 /**
3108  * ufshcd_enable_auto_bkops - Allow device managed BKOPS
3109  * @hba: per-adapter instance
3110  *
3111  * Allow device to manage background operations on its own. Enabling
3112  * this might lead to inconsistent latencies during normal data transfers
3113  * as the device is allowed to manage its own way of handling background
3114  * operations.
3115  *
3116  * Returns zero on success, non-zero on failure.
3117  */
3118 static int ufshcd_enable_auto_bkops(struct ufs_hba *hba)
3119 {
3120         int err = 0;
3121
3122         if (hba->auto_bkops_enabled)
3123                 goto out;
3124
3125         err = ufshcd_query_flag(hba, UPIU_QUERY_OPCODE_SET_FLAG,
3126                         QUERY_FLAG_IDN_BKOPS_EN, NULL);
3127         if (err) {
3128                 dev_err(hba->dev, "%s: failed to enable bkops %d\n",
3129                                 __func__, err);
3130                 goto out;
3131         }
3132
3133         hba->auto_bkops_enabled = true;
3134
3135         /* No need of URGENT_BKOPS exception from the device */
3136         err = ufshcd_disable_ee(hba, MASK_EE_URGENT_BKOPS);
3137         if (err)
3138                 dev_err(hba->dev, "%s: failed to disable exception event %d\n",
3139                                 __func__, err);
3140 out:
3141         return err;
3142 }
3143
3144 /**
3145  * ufshcd_disable_auto_bkops - block device in doing background operations
3146  * @hba: per-adapter instance
3147  *
3148  * Disabling background operations improves command response latency but
3149  * has drawback of device moving into critical state where the device is
3150  * not-operable. Make sure to call ufshcd_enable_auto_bkops() whenever the
3151  * host is idle so that BKOPS are managed effectively without any negative
3152  * impacts.
3153  *
3154  * Returns zero on success, non-zero on failure.
3155  */
3156 static int ufshcd_disable_auto_bkops(struct ufs_hba *hba)
3157 {
3158         int err = 0;
3159
3160         if (!hba->auto_bkops_enabled)
3161                 goto out;
3162
3163         /*
3164          * If host assisted BKOPs is to be enabled, make sure
3165          * urgent bkops exception is allowed.
3166          */
3167         err = ufshcd_enable_ee(hba, MASK_EE_URGENT_BKOPS);
3168         if (err) {
3169                 dev_err(hba->dev, "%s: failed to enable exception event %d\n",
3170                                 __func__, err);
3171                 goto out;
3172         }
3173
3174         err = ufshcd_query_flag(hba, UPIU_QUERY_OPCODE_CLEAR_FLAG,
3175                         QUERY_FLAG_IDN_BKOPS_EN, NULL);
3176         if (err) {
3177                 dev_err(hba->dev, "%s: failed to disable bkops %d\n",
3178                                 __func__, err);
3179                 ufshcd_disable_ee(hba, MASK_EE_URGENT_BKOPS);
3180                 goto out;
3181         }
3182
3183         hba->auto_bkops_enabled = false;
3184 out:
3185         return err;
3186 }
3187
3188 /**
3189  * ufshcd_force_reset_auto_bkops - force enable of auto bkops
3190  * @hba: per adapter instance
3191  *
3192  * After a device reset the device may toggle the BKOPS_EN flag
3193  * to default value. The s/w tracking variables should be updated
3194  * as well. Do this by forcing enable of auto bkops.
3195  */
3196 static void  ufshcd_force_reset_auto_bkops(struct ufs_hba *hba)
3197 {
3198         hba->auto_bkops_enabled = false;
3199         hba->ee_ctrl_mask |= MASK_EE_URGENT_BKOPS;
3200         ufshcd_enable_auto_bkops(hba);
3201 }
3202
3203 static inline int ufshcd_get_bkops_status(struct ufs_hba *hba, u32 *status)
3204 {
3205         return ufshcd_query_attr(hba, UPIU_QUERY_OPCODE_READ_ATTR,
3206                         QUERY_ATTR_IDN_BKOPS_STATUS, 0, 0, status);
3207 }
3208
3209 /**
3210  * ufshcd_bkops_ctrl - control the auto bkops based on current bkops status
3211  * @hba: per-adapter instance
3212  * @status: bkops_status value
3213  *
3214  * Read the bkops_status from the UFS device and Enable fBackgroundOpsEn
3215  * flag in the device to permit background operations if the device
3216  * bkops_status is greater than or equal to "status" argument passed to
3217  * this function, disable otherwise.
3218  *
3219  * Returns 0 for success, non-zero in case of failure.
3220  *
3221  * NOTE: Caller of this function can check the "hba->auto_bkops_enabled" flag
3222  * to know whether auto bkops is enabled or disabled after this function
3223  * returns control to it.
3224  */
3225 static int ufshcd_bkops_ctrl(struct ufs_hba *hba,
3226                              enum bkops_status status)
3227 {
3228         int err;
3229         u32 curr_status = 0;
3230
3231         err = ufshcd_get_bkops_status(hba, &curr_status);
3232         if (err) {
3233                 dev_err(hba->dev, "%s: failed to get BKOPS status %d\n",
3234                                 __func__, err);
3235                 goto out;
3236         } else if (curr_status > BKOPS_STATUS_MAX) {
3237                 dev_err(hba->dev, "%s: invalid BKOPS status %d\n",
3238                                 __func__, curr_status);
3239                 err = -EINVAL;
3240                 goto out;
3241         }
3242
3243         if (curr_status >= status)
3244                 err = ufshcd_enable_auto_bkops(hba);
3245         else
3246                 err = ufshcd_disable_auto_bkops(hba);
3247 out:
3248         return err;
3249 }
3250
3251 /**
3252  * ufshcd_urgent_bkops - handle urgent bkops exception event
3253  * @hba: per-adapter instance
3254  *
3255  * Enable fBackgroundOpsEn flag in the device to permit background
3256  * operations.
3257  *
3258  * If BKOPs is enabled, this function returns 0, 1 if the bkops in not enabled
3259  * and negative error value for any other failure.
3260  */
3261 static int ufshcd_urgent_bkops(struct ufs_hba *hba)
3262 {
3263         return ufshcd_bkops_ctrl(hba, BKOPS_STATUS_PERF_IMPACT);
3264 }
3265
3266 static inline int ufshcd_get_ee_status(struct ufs_hba *hba, u32 *status)
3267 {
3268         return ufshcd_query_attr(hba, UPIU_QUERY_OPCODE_READ_ATTR,
3269                         QUERY_ATTR_IDN_EE_STATUS, 0, 0, status);
3270 }
3271
3272 /**
3273  * ufshcd_exception_event_handler - handle exceptions raised by device
3274  * @work: pointer to work data
3275  *
3276  * Read bExceptionEventStatus attribute from the device and handle the
3277  * exception event accordingly.
3278  */
3279 static void ufshcd_exception_event_handler(struct work_struct *work)
3280 {
3281         struct ufs_hba *hba;
3282         int err;
3283         u32 status = 0;
3284         hba = container_of(work, struct ufs_hba, eeh_work);
3285
3286         pm_runtime_get_sync(hba->dev);
3287         err = ufshcd_get_ee_status(hba, &status);
3288         if (err) {
3289                 dev_err(hba->dev, "%s: failed to get exception status %d\n",
3290                                 __func__, err);
3291                 goto out;
3292         }
3293
3294         status &= hba->ee_ctrl_mask;
3295         if (status & MASK_EE_URGENT_BKOPS) {
3296                 err = ufshcd_urgent_bkops(hba);
3297                 if (err < 0)
3298                         dev_err(hba->dev, "%s: failed to handle urgent bkops %d\n",
3299                                         __func__, err);
3300         }
3301 out:
3302         pm_runtime_put_sync(hba->dev);
3303         return;
3304 }
3305
3306 /**
3307  * ufshcd_err_handler - handle UFS errors that require s/w attention
3308  * @work: pointer to work structure
3309  */
3310 static void ufshcd_err_handler(struct work_struct *work)
3311 {
3312         struct ufs_hba *hba;
3313         unsigned long flags;
3314         u32 err_xfer = 0;
3315         u32 err_tm = 0;
3316         int err = 0;
3317         int tag;
3318
3319         hba = container_of(work, struct ufs_hba, eh_work);
3320
3321         pm_runtime_get_sync(hba->dev);
3322         ufshcd_hold(hba, false);
3323
3324         spin_lock_irqsave(hba->host->host_lock, flags);
3325         if (hba->ufshcd_state == UFSHCD_STATE_RESET) {
3326                 spin_unlock_irqrestore(hba->host->host_lock, flags);
3327                 goto out;
3328         }
3329
3330         hba->ufshcd_state = UFSHCD_STATE_RESET;
3331         ufshcd_set_eh_in_progress(hba);
3332
3333         /* Complete requests that have door-bell cleared by h/w */
3334         ufshcd_transfer_req_compl(hba);
3335         ufshcd_tmc_handler(hba);
3336         spin_unlock_irqrestore(hba->host->host_lock, flags);
3337
3338         /* Clear pending transfer requests */
3339         for_each_set_bit(tag, &hba->outstanding_reqs, hba->nutrs)
3340                 if (ufshcd_clear_cmd(hba, tag))
3341                         err_xfer |= 1 << tag;
3342
3343         /* Clear pending task management requests */
3344         for_each_set_bit(tag, &hba->outstanding_tasks, hba->nutmrs)
3345                 if (ufshcd_clear_tm_cmd(hba, tag))
3346                         err_tm |= 1 << tag;
3347
3348         /* Complete the requests that are cleared by s/w */
3349         spin_lock_irqsave(hba->host->host_lock, flags);
3350         ufshcd_transfer_req_compl(hba);
3351         ufshcd_tmc_handler(hba);
3352         spin_unlock_irqrestore(hba->host->host_lock, flags);
3353
3354         /* Fatal errors need reset */
3355         if (err_xfer || err_tm || (hba->saved_err & INT_FATAL_ERRORS) ||
3356                         ((hba->saved_err & UIC_ERROR) &&
3357                          (hba->saved_uic_err & UFSHCD_UIC_DL_PA_INIT_ERROR))) {
3358                 err = ufshcd_reset_and_restore(hba);
3359                 if (err) {
3360                         dev_err(hba->dev, "%s: reset and restore failed\n",
3361                                         __func__);
3362                         hba->ufshcd_state = UFSHCD_STATE_ERROR;
3363                 }
3364                 /*
3365                  * Inform scsi mid-layer that we did reset and allow to handle
3366                  * Unit Attention properly.
3367                  */
3368                 scsi_report_bus_reset(hba->host, 0);
3369                 hba->saved_err = 0;
3370                 hba->saved_uic_err = 0;
3371         }
3372         ufshcd_clear_eh_in_progress(hba);
3373
3374 out:
3375         scsi_unblock_requests(hba->host);
3376         ufshcd_release(hba);
3377         pm_runtime_put_sync(hba->dev);
3378 }
3379
3380 /**
3381  * ufshcd_update_uic_error - check and set fatal UIC error flags.
3382  * @hba: per-adapter instance
3383  */
3384 static void ufshcd_update_uic_error(struct ufs_hba *hba)
3385 {
3386         u32 reg;
3387
3388         /* PA_INIT_ERROR is fatal and needs UIC reset */
3389         reg = ufshcd_readl(hba, REG_UIC_ERROR_CODE_DATA_LINK_LAYER);
3390         if (reg & UIC_DATA_LINK_LAYER_ERROR_PA_INIT)
3391                 hba->uic_error |= UFSHCD_UIC_DL_PA_INIT_ERROR;
3392
3393         /* UIC NL/TL/DME errors needs software retry */
3394         reg = ufshcd_readl(hba, REG_UIC_ERROR_CODE_NETWORK_LAYER);
3395         if (reg)
3396                 hba->uic_error |= UFSHCD_UIC_NL_ERROR;
3397
3398         reg = ufshcd_readl(hba, REG_UIC_ERROR_CODE_TRANSPORT_LAYER);
3399         if (reg)
3400                 hba->uic_error |= UFSHCD_UIC_TL_ERROR;
3401
3402         reg = ufshcd_readl(hba, REG_UIC_ERROR_CODE_DME);
3403         if (reg)
3404                 hba->uic_error |= UFSHCD_UIC_DME_ERROR;
3405
3406         dev_dbg(hba->dev, "%s: UIC error flags = 0x%08x\n",
3407                         __func__, hba->uic_error);
3408 }
3409
3410 /**
3411  * ufshcd_check_errors - Check for errors that need s/w attention
3412  * @hba: per-adapter instance
3413  */
3414 static void ufshcd_check_errors(struct ufs_hba *hba)
3415 {
3416         bool queue_eh_work = false;
3417
3418         if (hba->errors & INT_FATAL_ERRORS)
3419                 queue_eh_work = true;
3420
3421         if (hba->errors & UIC_ERROR) {
3422                 hba->uic_error = 0;
3423                 ufshcd_update_uic_error(hba);
3424                 if (hba->uic_error)
3425                         queue_eh_work = true;
3426         }
3427
3428         if (queue_eh_work) {
3429                 /* handle fatal errors only when link is functional */
3430                 if (hba->ufshcd_state == UFSHCD_STATE_OPERATIONAL) {
3431                         /* block commands from scsi mid-layer */
3432                         scsi_block_requests(hba->host);
3433
3434                         /* transfer error masks to sticky bits */
3435                         hba->saved_err |= hba->errors;
3436                         hba->saved_uic_err |= hba->uic_error;
3437
3438                         hba->ufshcd_state = UFSHCD_STATE_ERROR;
3439                         schedule_work(&hba->eh_work);
3440                 }
3441         }
3442         /*
3443          * if (!queue_eh_work) -
3444          * Other errors are either non-fatal where host recovers
3445          * itself without s/w intervention or errors that will be
3446          * handled by the SCSI core layer.
3447          */
3448 }
3449
3450 /**
3451  * ufshcd_tmc_handler - handle task management function completion
3452  * @hba: per adapter instance
3453  */
3454 static void ufshcd_tmc_handler(struct ufs_hba *hba)
3455 {
3456         u32 tm_doorbell;
3457
3458         tm_doorbell = ufshcd_readl(hba, REG_UTP_TASK_REQ_DOOR_BELL);
3459         hba->tm_condition = tm_doorbell ^ hba->outstanding_tasks;
3460         wake_up(&hba->tm_wq);
3461 }
3462
3463 /**
3464  * ufshcd_sl_intr - Interrupt service routine
3465  * @hba: per adapter instance
3466  * @intr_status: contains interrupts generated by the controller
3467  */
3468 static void ufshcd_sl_intr(struct ufs_hba *hba, u32 intr_status)
3469 {
3470         hba->errors = UFSHCD_ERROR_MASK & intr_status;
3471         if (hba->errors)
3472                 ufshcd_check_errors(hba);
3473
3474         if (intr_status & UFSHCD_UIC_MASK)
3475                 ufshcd_uic_cmd_compl(hba, intr_status);
3476
3477         if (intr_status & UTP_TASK_REQ_COMPL)
3478                 ufshcd_tmc_handler(hba);
3479
3480         if (intr_status & UTP_TRANSFER_REQ_COMPL)
3481                 ufshcd_transfer_req_compl(hba);
3482 }
3483
3484 /**
3485  * ufshcd_intr - Main interrupt service routine
3486  * @irq: irq number
3487  * @__hba: pointer to adapter instance
3488  *
3489  * Returns IRQ_HANDLED - If interrupt is valid
3490  *              IRQ_NONE - If invalid interrupt
3491  */
3492 static irqreturn_t ufshcd_intr(int irq, void *__hba)
3493 {
3494         u32 intr_status;
3495         irqreturn_t retval = IRQ_NONE;
3496         struct ufs_hba *hba = __hba;
3497
3498         spin_lock(hba->host->host_lock);
3499         intr_status = ufshcd_readl(hba, REG_INTERRUPT_STATUS);
3500
3501         if (intr_status) {
3502                 ufshcd_writel(hba, intr_status, REG_INTERRUPT_STATUS);
3503                 ufshcd_sl_intr(hba, intr_status);
3504                 retval = IRQ_HANDLED;
3505         }
3506         spin_unlock(hba->host->host_lock);
3507         return retval;
3508 }
3509
3510 static int ufshcd_clear_tm_cmd(struct ufs_hba *hba, int tag)
3511 {
3512         int err = 0;
3513         u32 mask = 1 << tag;
3514         unsigned long flags;
3515
3516         if (!test_bit(tag, &hba->outstanding_tasks))
3517                 goto out;
3518
3519         spin_lock_irqsave(hba->host->host_lock, flags);
3520         ufshcd_writel(hba, ~(1 << tag), REG_UTP_TASK_REQ_LIST_CLEAR);
3521         spin_unlock_irqrestore(hba->host->host_lock, flags);
3522
3523         /* poll for max. 1 sec to clear door bell register by h/w */
3524         err = ufshcd_wait_for_register(hba,
3525                         REG_UTP_TASK_REQ_DOOR_BELL,
3526                         mask, 0, 1000, 1000);
3527 out:
3528         return err;
3529 }
3530
3531 /**
3532  * ufshcd_issue_tm_cmd - issues task management commands to controller
3533  * @hba: per adapter instance
3534  * @lun_id: LUN ID to which TM command is sent
3535  * @task_id: task ID to which the TM command is applicable
3536  * @tm_function: task management function opcode
3537  * @tm_response: task management service response return value
3538  *
3539  * Returns non-zero value on error, zero on success.
3540  */
3541 static int ufshcd_issue_tm_cmd(struct ufs_hba *hba, int lun_id, int task_id,
3542                 u8 tm_function, u8 *tm_response)
3543 {
3544         struct utp_task_req_desc *task_req_descp;
3545         struct utp_upiu_task_req *task_req_upiup;
3546         struct Scsi_Host *host;
3547         unsigned long flags;
3548         int free_slot;
3549         int err;
3550         int task_tag;
3551
3552         host = hba->host;
3553
3554         /*
3555          * Get free slot, sleep if slots are unavailable.
3556          * Even though we use wait_event() which sleeps indefinitely,
3557          * the maximum wait time is bounded by %TM_CMD_TIMEOUT.
3558          */
3559         wait_event(hba->tm_tag_wq, ufshcd_get_tm_free_slot(hba, &free_slot));
3560         ufshcd_hold(hba, false);
3561
3562         spin_lock_irqsave(host->host_lock, flags);
3563         task_req_descp = hba->utmrdl_base_addr;
3564         task_req_descp += free_slot;
3565
3566         /* Configure task request descriptor */
3567         task_req_descp->header.dword_0 = cpu_to_le32(UTP_REQ_DESC_INT_CMD);
3568         task_req_descp->header.dword_2 =
3569                         cpu_to_le32(OCS_INVALID_COMMAND_STATUS);
3570
3571         /* Configure task request UPIU */
3572         task_req_upiup =
3573                 (struct utp_upiu_task_req *) task_req_descp->task_req_upiu;
3574         task_tag = hba->nutrs + free_slot;
3575         task_req_upiup->header.dword_0 =
3576                 UPIU_HEADER_DWORD(UPIU_TRANSACTION_TASK_REQ, 0,
3577                                               lun_id, task_tag);
3578         task_req_upiup->header.dword_1 =
3579                 UPIU_HEADER_DWORD(0, tm_function, 0, 0);
3580         /*
3581          * The host shall provide the same value for LUN field in the basic
3582          * header and for Input Parameter.
3583          */
3584         task_req_upiup->input_param1 = cpu_to_be32(lun_id);
3585         task_req_upiup->input_param2 = cpu_to_be32(task_id);
3586
3587         /* send command to the controller */
3588         __set_bit(free_slot, &hba->outstanding_tasks);
3589         ufshcd_writel(hba, 1 << free_slot, REG_UTP_TASK_REQ_DOOR_BELL);
3590
3591         spin_unlock_irqrestore(host->host_lock, flags);
3592
3593         /* wait until the task management command is completed */
3594         err = wait_event_timeout(hba->tm_wq,
3595                         test_bit(free_slot, &hba->tm_condition),
3596                         msecs_to_jiffies(TM_CMD_TIMEOUT));
3597         if (!err) {
3598                 dev_err(hba->dev, "%s: task management cmd 0x%.2x timed-out\n",
3599                                 __func__, tm_function);
3600                 if (ufshcd_clear_tm_cmd(hba, free_slot))
3601                         dev_WARN(hba->dev, "%s: unable clear tm cmd (slot %d) after timeout\n",
3602                                         __func__, free_slot);
3603                 err = -ETIMEDOUT;
3604         } else {
3605                 err = ufshcd_task_req_compl(hba, free_slot, tm_response);
3606         }
3607
3608         clear_bit(free_slot, &hba->tm_condition);
3609         ufshcd_put_tm_slot(hba, free_slot);
3610         wake_up(&hba->tm_tag_wq);
3611
3612         ufshcd_release(hba);
3613         return err;
3614 }
3615
3616 /**
3617  * ufshcd_eh_device_reset_handler - device reset handler registered to
3618  *                                    scsi layer.
3619  * @cmd: SCSI command pointer
3620  *
3621  * Returns SUCCESS/FAILED
3622  */
3623 static int ufshcd_eh_device_reset_handler(struct scsi_cmnd *cmd)
3624 {
3625         struct Scsi_Host *host;
3626         struct ufs_hba *hba;
3627         unsigned int tag;
3628         u32 pos;
3629         int err;
3630         u8 resp = 0xF;
3631         struct ufshcd_lrb *lrbp;
3632         unsigned long flags;
3633
3634         host = cmd->device->host;
3635         hba = shost_priv(host);
3636         tag = cmd->request->tag;
3637
3638         lrbp = &hba->lrb[tag];
3639         err = ufshcd_issue_tm_cmd(hba, lrbp->lun, 0, UFS_LOGICAL_RESET, &resp);
3640         if (err || resp != UPIU_TASK_MANAGEMENT_FUNC_COMPL) {
3641                 if (!err)
3642                         err = resp;
3643                 goto out;
3644         }
3645
3646         /* clear the commands that were pending for corresponding LUN */
3647         for_each_set_bit(pos, &hba->outstanding_reqs, hba->nutrs) {
3648                 if (hba->lrb[pos].lun == lrbp->lun) {
3649                         err = ufshcd_clear_cmd(hba, pos);
3650                         if (err)
3651                                 break;
3652                 }
3653         }
3654         spin_lock_irqsave(host->host_lock, flags);
3655         ufshcd_transfer_req_compl(hba);
3656         spin_unlock_irqrestore(host->host_lock, flags);
3657 out:
3658         if (!err) {
3659                 err = SUCCESS;
3660         } else {
3661                 dev_err(hba->dev, "%s: failed with err %d\n", __func__, err);
3662                 err = FAILED;
3663         }
3664         return err;
3665 }
3666
3667 /**
3668  * ufshcd_abort - abort a specific command
3669  * @cmd: SCSI command pointer
3670  *
3671  * Abort the pending command in device by sending UFS_ABORT_TASK task management
3672  * command, and in host controller by clearing the door-bell register. There can
3673  * be race between controller sending the command to the device while abort is
3674  * issued. To avoid that, first issue UFS_QUERY_TASK to check if the command is
3675  * really issued and then try to abort it.
3676  *
3677  * Returns SUCCESS/FAILED
3678  */
3679 static int ufshcd_abort(struct scsi_cmnd *cmd)
3680 {
3681         struct Scsi_Host *host;
3682         struct ufs_hba *hba;
3683         unsigned long flags;
3684         unsigned int tag;
3685         int err = 0;
3686         int poll_cnt;
3687         u8 resp = 0xF;
3688         struct ufshcd_lrb *lrbp;
3689         u32 reg;
3690
3691         host = cmd->device->host;
3692         hba = shost_priv(host);
3693         tag = cmd->request->tag;
3694
3695         ufshcd_hold(hba, false);
3696         /* If command is already aborted/completed, return SUCCESS */
3697         if (!(test_bit(tag, &hba->outstanding_reqs)))
3698                 goto out;
3699
3700         reg = ufshcd_readl(hba, REG_UTP_TRANSFER_REQ_DOOR_BELL);
3701         if (!(reg & (1 << tag))) {
3702                 dev_err(hba->dev,
3703                 "%s: cmd was completed, but without a notifying intr, tag = %d",
3704                 __func__, tag);
3705         }
3706
3707         lrbp = &hba->lrb[tag];
3708         for (poll_cnt = 100; poll_cnt; poll_cnt--) {
3709                 err = ufshcd_issue_tm_cmd(hba, lrbp->lun, lrbp->task_tag,
3710                                 UFS_QUERY_TASK, &resp);
3711                 if (!err && resp == UPIU_TASK_MANAGEMENT_FUNC_SUCCEEDED) {
3712                         /* cmd pending in the device */
3713                         break;
3714                 } else if (!err && resp == UPIU_TASK_MANAGEMENT_FUNC_COMPL) {
3715                         /*
3716                          * cmd not pending in the device, check if it is
3717                          * in transition.
3718                          */
3719                         reg = ufshcd_readl(hba, REG_UTP_TRANSFER_REQ_DOOR_BELL);
3720                         if (reg & (1 << tag)) {
3721                                 /* sleep for max. 200us to stabilize */
3722                                 usleep_range(100, 200);
3723                                 continue;
3724                         }
3725                         /* command completed already */
3726                         goto out;
3727                 } else {
3728                         if (!err)
3729                                 err = resp; /* service response error */
3730                         goto out;
3731                 }
3732         }
3733
3734         if (!poll_cnt) {
3735                 err = -EBUSY;
3736                 goto out;
3737         }
3738
3739         err = ufshcd_issue_tm_cmd(hba, lrbp->lun, lrbp->task_tag,
3740                         UFS_ABORT_TASK, &resp);
3741         if (err || resp != UPIU_TASK_MANAGEMENT_FUNC_COMPL) {
3742                 if (!err)
3743                         err = resp; /* service response error */
3744                 goto out;
3745         }
3746
3747         err = ufshcd_clear_cmd(hba, tag);
3748         if (err)
3749                 goto out;
3750
3751         scsi_dma_unmap(cmd);
3752
3753         spin_lock_irqsave(host->host_lock, flags);
3754         __clear_bit(tag, &hba->outstanding_reqs);
3755         hba->lrb[tag].cmd = NULL;
3756         spin_unlock_irqrestore(host->host_lock, flags);
3757
3758         clear_bit_unlock(tag, &hba->lrb_in_use);
3759         wake_up(&hba->dev_cmd.tag_wq);
3760
3761 out:
3762         if (!err) {
3763                 err = SUCCESS;
3764         } else {
3765                 dev_err(hba->dev, "%s: failed with err %d\n", __func__, err);
3766                 err = FAILED;
3767         }
3768
3769         /*
3770          * This ufshcd_release() corresponds to the original scsi cmd that got
3771          * aborted here (as we won't get any IRQ for it).
3772          */
3773         ufshcd_release(hba);
3774         return err;
3775 }
3776
3777 /**
3778  * ufshcd_host_reset_and_restore - reset and restore host controller
3779  * @hba: per-adapter instance
3780  *
3781  * Note that host controller reset may issue DME_RESET to
3782  * local and remote (device) Uni-Pro stack and the attributes
3783  * are reset to default state.
3784  *
3785  * Returns zero on success, non-zero on failure
3786  */
3787 static int ufshcd_host_reset_and_restore(struct ufs_hba *hba)
3788 {
3789         int err;
3790         unsigned long flags;
3791
3792         /* Reset the host controller */
3793         spin_lock_irqsave(hba->host->host_lock, flags);
3794         ufshcd_hba_stop(hba);
3795         spin_unlock_irqrestore(hba->host->host_lock, flags);
3796
3797         err = ufshcd_hba_enable(hba);
3798         if (err)
3799                 goto out;
3800
3801         /* Establish the link again and restore the device */
3802         err = ufshcd_probe_hba(hba);
3803
3804         if (!err && (hba->ufshcd_state != UFSHCD_STATE_OPERATIONAL))
3805                 err = -EIO;
3806 out:
3807         if (err)
3808                 dev_err(hba->dev, "%s: Host init failed %d\n", __func__, err);
3809
3810         return err;
3811 }
3812
3813 /**
3814  * ufshcd_reset_and_restore - reset and re-initialize host/device
3815  * @hba: per-adapter instance
3816  *
3817  * Reset and recover device, host and re-establish link. This
3818  * is helpful to recover the communication in fatal error conditions.
3819  *
3820  * Returns zero on success, non-zero on failure
3821  */
3822 static int ufshcd_reset_and_restore(struct ufs_hba *hba)
3823 {
3824         int err = 0;
3825         unsigned long flags;
3826         int retries = MAX_HOST_RESET_RETRIES;
3827
3828         do {
3829                 err = ufshcd_host_reset_and_restore(hba);
3830         } while (err && --retries);
3831
3832         /*
3833          * After reset the door-bell might be cleared, complete
3834          * outstanding requests in s/w here.
3835          */
3836         spin_lock_irqsave(hba->host->host_lock, flags);
3837         ufshcd_transfer_req_compl(hba);
3838         ufshcd_tmc_handler(hba);
3839         spin_unlock_irqrestore(hba->host->host_lock, flags);
3840
3841         return err;
3842 }
3843
3844 /**
3845  * ufshcd_eh_host_reset_handler - host reset handler registered to scsi layer
3846  * @cmd - SCSI command pointer
3847  *
3848  * Returns SUCCESS/FAILED
3849  */
3850 static int ufshcd_eh_host_reset_handler(struct scsi_cmnd *cmd)
3851 {
3852         int err;
3853         unsigned long flags;
3854         struct ufs_hba *hba;
3855
3856         hba = shost_priv(cmd->device->host);
3857
3858         ufshcd_hold(hba, false);
3859         /*
3860          * Check if there is any race with fatal error handling.
3861          * If so, wait for it to complete. Even though fatal error
3862          * handling does reset and restore in some cases, don't assume
3863          * anything out of it. We are just avoiding race here.
3864          */
3865         do {
3866                 spin_lock_irqsave(hba->host->host_lock, flags);
3867                 if (!(work_pending(&hba->eh_work) ||
3868                                 hba->ufshcd_state == UFSHCD_STATE_RESET))
3869                         break;
3870                 spin_unlock_irqrestore(hba->host->host_lock, flags);
3871                 dev_dbg(hba->dev, "%s: reset in progress\n", __func__);
3872                 flush_work(&hba->eh_work);
3873         } while (1);
3874
3875         hba->ufshcd_state = UFSHCD_STATE_RESET;
3876         ufshcd_set_eh_in_progress(hba);
3877         spin_unlock_irqrestore(hba->host->host_lock, flags);
3878
3879         err = ufshcd_reset_and_restore(hba);
3880
3881         spin_lock_irqsave(hba->host->host_lock, flags);
3882         if (!err) {
3883                 err = SUCCESS;
3884                 hba->ufshcd_state = UFSHCD_STATE_OPERATIONAL;
3885         } else {
3886                 err = FAILED;
3887                 hba->ufshcd_state = UFSHCD_STATE_ERROR;
3888         }
3889         ufshcd_clear_eh_in_progress(hba);
3890         spin_unlock_irqrestore(hba->host->host_lock, flags);
3891
3892         ufshcd_release(hba);
3893         return err;
3894 }
3895
3896 /**
3897  * ufshcd_get_max_icc_level - calculate the ICC level
3898  * @sup_curr_uA: max. current supported by the regulator
3899  * @start_scan: row at the desc table to start scan from
3900  * @buff: power descriptor buffer
3901  *
3902  * Returns calculated max ICC level for specific regulator
3903  */
3904 static u32 ufshcd_get_max_icc_level(int sup_curr_uA, u32 start_scan, char *buff)
3905 {
3906         int i;
3907         int curr_uA;
3908         u16 data;
3909         u16 unit;
3910
3911         for (i = start_scan; i >= 0; i--) {
3912                 data = be16_to_cpu(*((u16 *)(buff + 2*i)));
3913                 unit = (data & ATTR_ICC_LVL_UNIT_MASK) >>
3914                                                 ATTR_ICC_LVL_UNIT_OFFSET;
3915                 curr_uA = data & ATTR_ICC_LVL_VALUE_MASK;
3916                 switch (unit) {
3917                 case UFSHCD_NANO_AMP:
3918                         curr_uA = curr_uA / 1000;
3919                         break;
3920                 case UFSHCD_MILI_AMP:
3921                         curr_uA = curr_uA * 1000;
3922                         break;
3923                 case UFSHCD_AMP:
3924                         curr_uA = curr_uA * 1000 * 1000;
3925                         break;
3926                 case UFSHCD_MICRO_AMP:
3927                 default:
3928                         break;
3929                 }
3930                 if (sup_curr_uA >= curr_uA)
3931                         break;
3932         }
3933         if (i < 0) {
3934                 i = 0;
3935                 pr_err("%s: Couldn't find valid icc_level = %d", __func__, i);
3936         }
3937
3938         return (u32)i;
3939 }
3940
3941 /**
3942  * ufshcd_calc_icc_level - calculate the max ICC level
3943  * In case regulators are not initialized we'll return 0
3944  * @hba: per-adapter instance
3945  * @desc_buf: power descriptor buffer to extract ICC levels from.
3946  * @len: length of desc_buff
3947  *
3948  * Returns calculated ICC level
3949  */
3950 static u32 ufshcd_find_max_sup_active_icc_level(struct ufs_hba *hba,
3951                                                         u8 *desc_buf, int len)
3952 {
3953         u32 icc_level = 0;
3954
3955         if (!hba->vreg_info.vcc || !hba->vreg_info.vccq ||
3956                                                 !hba->vreg_info.vccq2) {
3957                 dev_err(hba->dev,
3958                         "%s: Regulator capability was not set, actvIccLevel=%d",
3959                                                         __func__, icc_level);
3960                 goto out;
3961         }
3962
3963         if (hba->vreg_info.vcc)
3964                 icc_level = ufshcd_get_max_icc_level(
3965                                 hba->vreg_info.vcc->max_uA,
3966                                 POWER_DESC_MAX_ACTV_ICC_LVLS - 1,
3967                                 &desc_buf[PWR_DESC_ACTIVE_LVLS_VCC_0]);
3968
3969         if (hba->vreg_info.vccq)
3970                 icc_level = ufshcd_get_max_icc_level(
3971                                 hba->vreg_info.vccq->max_uA,
3972                                 icc_level,
3973                                 &desc_buf[PWR_DESC_ACTIVE_LVLS_VCCQ_0]);
3974
3975         if (hba->vreg_info.vccq2)
3976                 icc_level = ufshcd_get_max_icc_level(
3977                                 hba->vreg_info.vccq2->max_uA,
3978                                 icc_level,
3979                                 &desc_buf[PWR_DESC_ACTIVE_LVLS_VCCQ2_0]);
3980 out:
3981         return icc_level;
3982 }
3983
3984 static void ufshcd_init_icc_levels(struct ufs_hba *hba)
3985 {
3986         int ret;
3987         int buff_len = QUERY_DESC_POWER_MAX_SIZE;
3988         u8 desc_buf[QUERY_DESC_POWER_MAX_SIZE];
3989
3990         ret = ufshcd_read_power_desc(hba, desc_buf, buff_len);
3991         if (ret) {
3992                 dev_err(hba->dev,
3993                         "%s: Failed reading power descriptor.len = %d ret = %d",
3994                         __func__, buff_len, ret);
3995                 return;
3996         }
3997
3998         hba->init_prefetch_data.icc_level =
3999                         ufshcd_find_max_sup_active_icc_level(hba,
4000                         desc_buf, buff_len);
4001         dev_dbg(hba->dev, "%s: setting icc_level 0x%x",
4002                         __func__, hba->init_prefetch_data.icc_level);
4003
4004         ret = ufshcd_query_attr(hba, UPIU_QUERY_OPCODE_WRITE_ATTR,
4005                         QUERY_ATTR_IDN_ACTIVE_ICC_LVL, 0, 0,
4006                         &hba->init_prefetch_data.icc_level);
4007
4008         if (ret)
4009                 dev_err(hba->dev,
4010                         "%s: Failed configuring bActiveICCLevel = %d ret = %d",
4011                         __func__, hba->init_prefetch_data.icc_level , ret);
4012
4013 }
4014
4015 /**
4016  * ufshcd_scsi_add_wlus - Adds required W-LUs
4017  * @hba: per-adapter instance
4018  *
4019  * UFS device specification requires the UFS devices to support 4 well known
4020  * logical units:
4021  *      "REPORT_LUNS" (address: 01h)
4022  *      "UFS Device" (address: 50h)
4023  *      "RPMB" (address: 44h)
4024  *      "BOOT" (address: 30h)
4025  * UFS device's power management needs to be controlled by "POWER CONDITION"
4026  * field of SSU (START STOP UNIT) command. But this "power condition" field
4027  * will take effect only when its sent to "UFS device" well known logical unit
4028  * hence we require the scsi_device instance to represent this logical unit in
4029  * order for the UFS host driver to send the SSU command for power management.
4030
4031  * We also require the scsi_device instance for "RPMB" (Replay Protected Memory
4032  * Block) LU so user space process can control this LU. User space may also
4033  * want to have access to BOOT LU.
4034
4035  * This function adds scsi device instances for each of all well known LUs
4036  * (except "REPORT LUNS" LU).
4037  *
4038  * Returns zero on success (all required W-LUs are added successfully),
4039  * non-zero error value on failure (if failed to add any of the required W-LU).
4040  */
4041 static int ufshcd_scsi_add_wlus(struct ufs_hba *hba)
4042 {
4043         int ret = 0;
4044
4045         hba->sdev_ufs_device = __scsi_add_device(hba->host, 0, 0,
4046                 ufshcd_upiu_wlun_to_scsi_wlun(UFS_UPIU_UFS_DEVICE_WLUN), NULL);
4047         if (IS_ERR(hba->sdev_ufs_device)) {
4048                 ret = PTR_ERR(hba->sdev_ufs_device);
4049                 hba->sdev_ufs_device = NULL;
4050                 goto out;
4051         }
4052
4053         hba->sdev_boot = __scsi_add_device(hba->host, 0, 0,
4054                 ufshcd_upiu_wlun_to_scsi_wlun(UFS_UPIU_BOOT_WLUN), NULL);
4055         if (IS_ERR(hba->sdev_boot)) {
4056                 ret = PTR_ERR(hba->sdev_boot);
4057                 hba->sdev_boot = NULL;
4058                 goto remove_sdev_ufs_device;
4059         }
4060
4061         hba->sdev_rpmb = __scsi_add_device(hba->host, 0, 0,
4062                 ufshcd_upiu_wlun_to_scsi_wlun(UFS_UPIU_RPMB_WLUN), NULL);
4063         if (IS_ERR(hba->sdev_rpmb)) {
4064                 ret = PTR_ERR(hba->sdev_rpmb);
4065                 hba->sdev_rpmb = NULL;
4066                 goto remove_sdev_boot;
4067         }
4068         goto out;
4069
4070 remove_sdev_boot:
4071         scsi_remove_device(hba->sdev_boot);
4072 remove_sdev_ufs_device:
4073         scsi_remove_device(hba->sdev_ufs_device);
4074 out:
4075         return ret;
4076 }
4077
4078 /**
4079  * ufshcd_scsi_remove_wlus - Removes the W-LUs which were added by
4080  *                           ufshcd_scsi_add_wlus()
4081  * @hba: per-adapter instance
4082  *
4083  */
4084 static void ufshcd_scsi_remove_wlus(struct ufs_hba *hba)
4085 {
4086         if (hba->sdev_ufs_device) {
4087                 scsi_remove_device(hba->sdev_ufs_device);
4088                 hba->sdev_ufs_device = NULL;
4089         }
4090
4091         if (hba->sdev_boot) {
4092                 scsi_remove_device(hba->sdev_boot);
4093                 hba->sdev_boot = NULL;
4094         }
4095
4096         if (hba->sdev_rpmb) {
4097                 scsi_remove_device(hba->sdev_rpmb);
4098                 hba->sdev_rpmb = NULL;
4099         }
4100 }
4101
4102 /**
4103  * ufshcd_probe_hba - probe hba to detect device and initialize
4104  * @hba: per-adapter instance
4105  *
4106  * Execute link-startup and verify device initialization
4107  */
4108 static int ufshcd_probe_hba(struct ufs_hba *hba)
4109 {
4110         int ret;
4111
4112         ret = ufshcd_link_startup(hba);
4113         if (ret)
4114                 goto out;
4115
4116         /* UniPro link is active now */
4117         ufshcd_set_link_active(hba);
4118
4119         ret = ufshcd_verify_dev_init(hba);
4120         if (ret)
4121                 goto out;
4122
4123         ret = ufshcd_complete_dev_init(hba);
4124         if (ret)
4125                 goto out;
4126
4127         /* UFS device is also active now */
4128         ufshcd_set_ufs_dev_active(hba);
4129         ufshcd_force_reset_auto_bkops(hba);
4130         hba->ufshcd_state = UFSHCD_STATE_OPERATIONAL;
4131         hba->wlun_dev_clr_ua = true;
4132
4133         if (ufshcd_get_max_pwr_mode(hba)) {
4134                 dev_err(hba->dev,
4135                         "%s: Failed getting max supported power mode\n",
4136                         __func__);
4137         } else {
4138                 ret = ufshcd_config_pwr_mode(hba, &hba->max_pwr_info.info);
4139                 if (ret)
4140                         dev_err(hba->dev, "%s: Failed setting power mode, err = %d\n",
4141                                         __func__, ret);
4142         }
4143
4144         /*
4145          * If we are in error handling context or in power management callbacks
4146          * context, no need to scan the host
4147          */
4148         if (!ufshcd_eh_in_progress(hba) && !hba->pm_op_in_progress) {
4149                 bool flag;
4150
4151                 /* clear any previous UFS device information */
4152                 memset(&hba->dev_info, 0, sizeof(hba->dev_info));
4153                 if (!ufshcd_query_flag(hba, UPIU_QUERY_OPCODE_READ_FLAG,
4154                                        QUERY_FLAG_IDN_PWR_ON_WPE, &flag))
4155                         hba->dev_info.f_power_on_wp_en = flag;
4156
4157                 if (!hba->is_init_prefetch)
4158                         ufshcd_init_icc_levels(hba);
4159
4160                 /* Add required well known logical units to scsi mid layer */
4161                 if (ufshcd_scsi_add_wlus(hba))
4162                         goto out;
4163
4164                 scsi_scan_host(hba->host);
4165                 pm_runtime_put_sync(hba->dev);
4166         }
4167
4168         if (!hba->is_init_prefetch)
4169                 hba->is_init_prefetch = true;
4170
4171         /* Resume devfreq after UFS device is detected */
4172         if (ufshcd_is_clkscaling_enabled(hba))
4173                 devfreq_resume_device(hba->devfreq);
4174
4175 out:
4176         /*
4177          * If we failed to initialize the device or the device is not
4178          * present, turn off the power/clocks etc.
4179          */
4180         if (ret && !ufshcd_eh_in_progress(hba) && !hba->pm_op_in_progress) {
4181                 pm_runtime_put_sync(hba->dev);
4182                 ufshcd_hba_exit(hba);
4183         }
4184
4185         return ret;
4186 }
4187
4188 /**
4189  * ufshcd_async_scan - asynchronous execution for probing hba
4190  * @data: data pointer to pass to this function
4191  * @cookie: cookie data
4192  */
4193 static void ufshcd_async_scan(void *data, async_cookie_t cookie)
4194 {
4195         struct ufs_hba *hba = (struct ufs_hba *)data;
4196
4197         ufshcd_probe_hba(hba);
4198 }
4199
4200 static struct scsi_host_template ufshcd_driver_template = {
4201         .module                 = THIS_MODULE,
4202         .name                   = UFSHCD,
4203         .proc_name              = UFSHCD,
4204         .queuecommand           = ufshcd_queuecommand,
4205         .slave_alloc            = ufshcd_slave_alloc,
4206         .slave_configure        = ufshcd_slave_configure,
4207         .slave_destroy          = ufshcd_slave_destroy,
4208         .change_queue_depth     = ufshcd_change_queue_depth,
4209         .eh_abort_handler       = ufshcd_abort,
4210         .eh_device_reset_handler = ufshcd_eh_device_reset_handler,
4211         .eh_host_reset_handler   = ufshcd_eh_host_reset_handler,
4212         .this_id                = -1,
4213         .sg_tablesize           = SG_ALL,
4214         .cmd_per_lun            = UFSHCD_CMD_PER_LUN,
4215         .can_queue              = UFSHCD_CAN_QUEUE,
4216         .max_host_blocked       = 1,
4217         .use_blk_tags           = 1,
4218         .track_queue_depth      = 1,
4219 };
4220
4221 static int ufshcd_config_vreg_load(struct device *dev, struct ufs_vreg *vreg,
4222                                    int ua)
4223 {
4224         int ret = 0;
4225         struct regulator *reg = vreg->reg;
4226         const char *name = vreg->name;
4227
4228         BUG_ON(!vreg);
4229
4230         ret = regulator_set_optimum_mode(reg, ua);
4231         if (ret >= 0) {
4232                 /*
4233                  * regulator_set_optimum_mode() returns new regulator
4234                  * mode upon success.
4235                  */
4236                 ret = 0;
4237         } else {
4238                 dev_err(dev, "%s: %s set optimum mode(ua=%d) failed, err=%d\n",
4239                                 __func__, name, ua, ret);
4240         }
4241
4242         return ret;
4243 }
4244
4245 static inline int ufshcd_config_vreg_lpm(struct ufs_hba *hba,
4246                                          struct ufs_vreg *vreg)
4247 {
4248         return ufshcd_config_vreg_load(hba->dev, vreg, UFS_VREG_LPM_LOAD_UA);
4249 }
4250
4251 static inline int ufshcd_config_vreg_hpm(struct ufs_hba *hba,
4252                                          struct ufs_vreg *vreg)
4253 {
4254         return ufshcd_config_vreg_load(hba->dev, vreg, vreg->max_uA);
4255 }
4256
4257 static int ufshcd_config_vreg(struct device *dev,
4258                 struct ufs_vreg *vreg, bool on)
4259 {
4260         int ret = 0;
4261         struct regulator *reg = vreg->reg;
4262         const char *name = vreg->name;
4263         int min_uV, uA_load;
4264
4265         BUG_ON(!vreg);
4266
4267         if (regulator_count_voltages(reg) > 0) {
4268                 min_uV = on ? vreg->min_uV : 0;
4269                 ret = regulator_set_voltage(reg, min_uV, vreg->max_uV);
4270                 if (ret) {
4271                         dev_err(dev, "%s: %s set voltage failed, err=%d\n",
4272                                         __func__, name, ret);
4273                         goto out;
4274                 }
4275
4276                 uA_load = on ? vreg->max_uA : 0;
4277                 ret = ufshcd_config_vreg_load(dev, vreg, uA_load);
4278                 if (ret)
4279                         goto out;
4280         }
4281 out:
4282         return ret;
4283 }
4284
4285 static int ufshcd_enable_vreg(struct device *dev, struct ufs_vreg *vreg)
4286 {
4287         int ret = 0;
4288
4289         if (!vreg || vreg->enabled)
4290                 goto out;
4291
4292         ret = ufshcd_config_vreg(dev, vreg, true);
4293         if (!ret)
4294                 ret = regulator_enable(vreg->reg);
4295
4296         if (!ret)
4297                 vreg->enabled = true;
4298         else
4299                 dev_err(dev, "%s: %s enable failed, err=%d\n",
4300                                 __func__, vreg->name, ret);
4301 out:
4302         return ret;
4303 }
4304
4305 static int ufshcd_disable_vreg(struct device *dev, struct ufs_vreg *vreg)
4306 {
4307         int ret = 0;
4308
4309         if (!vreg || !vreg->enabled)
4310                 goto out;
4311
4312         ret = regulator_disable(vreg->reg);
4313
4314         if (!ret) {
4315                 /* ignore errors on applying disable config */
4316                 ufshcd_config_vreg(dev, vreg, false);
4317                 vreg->enabled = false;
4318         } else {
4319                 dev_err(dev, "%s: %s disable failed, err=%d\n",
4320                                 __func__, vreg->name, ret);
4321         }
4322 out:
4323         return ret;
4324 }
4325
4326 static int ufshcd_setup_vreg(struct ufs_hba *hba, bool on)
4327 {
4328         int ret = 0;
4329         struct device *dev = hba->dev;
4330         struct ufs_vreg_info *info = &hba->vreg_info;
4331
4332         if (!info)
4333                 goto out;
4334
4335         ret = ufshcd_toggle_vreg(dev, info->vcc, on);
4336         if (ret)
4337                 goto out;
4338
4339         ret = ufshcd_toggle_vreg(dev, info->vccq, on);
4340         if (ret)
4341                 goto out;
4342
4343         ret = ufshcd_toggle_vreg(dev, info->vccq2, on);
4344         if (ret)
4345                 goto out;
4346
4347 out:
4348         if (ret) {
4349                 ufshcd_toggle_vreg(dev, info->vccq2, false);
4350                 ufshcd_toggle_vreg(dev, info->vccq, false);
4351                 ufshcd_toggle_vreg(dev, info->vcc, false);
4352         }
4353         return ret;
4354 }
4355
4356 static int ufshcd_setup_hba_vreg(struct ufs_hba *hba, bool on)
4357 {
4358         struct ufs_vreg_info *info = &hba->vreg_info;
4359
4360         if (info)
4361                 return ufshcd_toggle_vreg(hba->dev, info->vdd_hba, on);
4362
4363         return 0;
4364 }
4365
4366 static int ufshcd_get_vreg(struct device *dev, struct ufs_vreg *vreg)
4367 {
4368         int ret = 0;
4369
4370         if (!vreg)
4371                 goto out;
4372
4373         vreg->reg = devm_regulator_get(dev, vreg->name);
4374         if (IS_ERR(vreg->reg)) {
4375                 ret = PTR_ERR(vreg->reg);
4376                 dev_err(dev, "%s: %s get failed, err=%d\n",
4377                                 __func__, vreg->name, ret);
4378         }
4379 out:
4380         return ret;
4381 }
4382
4383 static int ufshcd_init_vreg(struct ufs_hba *hba)
4384 {
4385         int ret = 0;
4386         struct device *dev = hba->dev;
4387         struct ufs_vreg_info *info = &hba->vreg_info;
4388
4389         if (!info)
4390                 goto out;
4391
4392         ret = ufshcd_get_vreg(dev, info->vcc);
4393         if (ret)
4394                 goto out;
4395
4396         ret = ufshcd_get_vreg(dev, info->vccq);
4397         if (ret)
4398                 goto out;
4399
4400         ret = ufshcd_get_vreg(dev, info->vccq2);
4401 out:
4402         return ret;
4403 }
4404
4405 static int ufshcd_init_hba_vreg(struct ufs_hba *hba)
4406 {
4407         struct ufs_vreg_info *info = &hba->vreg_info;
4408
4409         if (info)
4410                 return ufshcd_get_vreg(hba->dev, info->vdd_hba);
4411
4412         return 0;
4413 }
4414
4415 static int __ufshcd_setup_clocks(struct ufs_hba *hba, bool on,
4416                                         bool skip_ref_clk)
4417 {
4418         int ret = 0;
4419         struct ufs_clk_info *clki;
4420         struct list_head *head = &hba->clk_list_head;
4421         unsigned long flags;
4422
4423         if (!head || list_empty(head))
4424                 goto out;
4425
4426         list_for_each_entry(clki, head, list) {
4427                 if (!IS_ERR_OR_NULL(clki->clk)) {
4428                         if (skip_ref_clk && !strcmp(clki->name, "ref_clk"))
4429                                 continue;
4430
4431                         if (on && !clki->enabled) {
4432                                 ret = clk_prepare_enable(clki->clk);
4433                                 if (ret) {
4434                                         dev_err(hba->dev, "%s: %s prepare enable failed, %d\n",
4435                                                 __func__, clki->name, ret);
4436                                         goto out;
4437                                 }
4438                         } else if (!on && clki->enabled) {
4439                                 clk_disable_unprepare(clki->clk);
4440                         }
4441                         clki->enabled = on;
4442                         dev_dbg(hba->dev, "%s: clk: %s %sabled\n", __func__,
4443                                         clki->name, on ? "en" : "dis");
4444                 }
4445         }
4446
4447         if (hba->vops && hba->vops->setup_clocks)
4448                 ret = hba->vops->setup_clocks(hba, on);
4449 out:
4450         if (ret) {
4451                 list_for_each_entry(clki, head, list) {
4452                         if (!IS_ERR_OR_NULL(clki->clk) && clki->enabled)
4453                                 clk_disable_unprepare(clki->clk);
4454                 }
4455         } else if (!ret && on) {
4456                 spin_lock_irqsave(hba->host->host_lock, flags);
4457                 hba->clk_gating.state = CLKS_ON;
4458                 spin_unlock_irqrestore(hba->host->host_lock, flags);
4459         }
4460         return ret;
4461 }
4462
4463 static int ufshcd_setup_clocks(struct ufs_hba *hba, bool on)
4464 {
4465         return  __ufshcd_setup_clocks(hba, on, false);
4466 }
4467
4468 static int ufshcd_init_clocks(struct ufs_hba *hba)
4469 {
4470         int ret = 0;
4471         struct ufs_clk_info *clki;
4472         struct device *dev = hba->dev;
4473         struct list_head *head = &hba->clk_list_head;
4474
4475         if (!head || list_empty(head))
4476                 goto out;
4477
4478         list_for_each_entry(clki, head, list) {
4479                 if (!clki->name)
4480                         continue;
4481
4482                 clki->clk = devm_clk_get(dev, clki->name);
4483                 if (IS_ERR(clki->clk)) {
4484                         ret = PTR_ERR(clki->clk);
4485                         dev_err(dev, "%s: %s clk get failed, %d\n",
4486                                         __func__, clki->name, ret);
4487                         goto out;
4488                 }
4489
4490                 if (clki->max_freq) {
4491                         ret = clk_set_rate(clki->clk, clki->max_freq);
4492                         if (ret) {
4493                                 dev_err(hba->dev, "%s: %s clk set rate(%dHz) failed, %d\n",
4494                                         __func__, clki->name,
4495                                         clki->max_freq, ret);
4496                                 goto out;
4497                         }
4498                         clki->curr_freq = clki->max_freq;
4499                 }
4500                 dev_dbg(dev, "%s: clk: %s, rate: %lu\n", __func__,
4501                                 clki->name, clk_get_rate(clki->clk));
4502         }
4503 out:
4504         return ret;
4505 }
4506
4507 static int ufshcd_variant_hba_init(struct ufs_hba *hba)
4508 {
4509         int err = 0;
4510
4511         if (!hba->vops)
4512                 goto out;
4513
4514         if (hba->vops->init) {
4515                 err = hba->vops->init(hba);
4516                 if (err)
4517                         goto out;
4518         }
4519
4520         if (hba->vops->setup_regulators) {
4521                 err = hba->vops->setup_regulators(hba, true);
4522                 if (err)
4523                         goto out_exit;
4524         }
4525
4526         goto out;
4527
4528 out_exit:
4529         if (hba->vops->exit)
4530                 hba->vops->exit(hba);
4531 out:
4532         if (err)
4533                 dev_err(hba->dev, "%s: variant %s init failed err %d\n",
4534                         __func__, hba->vops ? hba->vops->name : "", err);
4535         return err;
4536 }
4537
4538 static void ufshcd_variant_hba_exit(struct ufs_hba *hba)
4539 {
4540         if (!hba->vops)
4541                 return;
4542
4543         if (hba->vops->setup_clocks)
4544                 hba->vops->setup_clocks(hba, false);
4545
4546         if (hba->vops->setup_regulators)
4547                 hba->vops->setup_regulators(hba, false);
4548
4549         if (hba->vops->exit)
4550                 hba->vops->exit(hba);
4551 }
4552
4553 static int ufshcd_hba_init(struct ufs_hba *hba)
4554 {
4555         int err;
4556
4557         /*
4558          * Handle host controller power separately from the UFS device power
4559          * rails as it will help controlling the UFS host controller power
4560          * collapse easily which is different than UFS device power collapse.
4561          * Also, enable the host controller power before we go ahead with rest
4562          * of the initialization here.
4563          */
4564         err = ufshcd_init_hba_vreg(hba);
4565         if (err)
4566                 goto out;
4567
4568         err = ufshcd_setup_hba_vreg(hba, true);
4569         if (err)
4570                 goto out;
4571
4572         err = ufshcd_init_clocks(hba);
4573         if (err)
4574                 goto out_disable_hba_vreg;
4575
4576         err = ufshcd_setup_clocks(hba, true);
4577         if (err)
4578                 goto out_disable_hba_vreg;
4579
4580         err = ufshcd_init_vreg(hba);
4581         if (err)
4582                 goto out_disable_clks;
4583
4584         err = ufshcd_setup_vreg(hba, true);
4585         if (err)
4586                 goto out_disable_clks;
4587
4588         err = ufshcd_variant_hba_init(hba);
4589         if (err)
4590                 goto out_disable_vreg;
4591
4592         hba->is_powered = true;
4593         goto out;
4594
4595 out_disable_vreg:
4596         ufshcd_setup_vreg(hba, false);
4597 out_disable_clks:
4598         ufshcd_setup_clocks(hba, false);
4599 out_disable_hba_vreg:
4600         ufshcd_setup_hba_vreg(hba, false);
4601 out:
4602         return err;
4603 }
4604
4605 static void ufshcd_hba_exit(struct ufs_hba *hba)
4606 {
4607         if (hba->is_powered) {
4608                 ufshcd_variant_hba_exit(hba);
4609                 ufshcd_setup_vreg(hba, false);
4610                 ufshcd_setup_clocks(hba, false);
4611                 ufshcd_setup_hba_vreg(hba, false);
4612                 hba->is_powered = false;
4613         }
4614 }
4615
4616 static int
4617 ufshcd_send_request_sense(struct ufs_hba *hba, struct scsi_device *sdp)
4618 {
4619         unsigned char cmd[6] = {REQUEST_SENSE,
4620                                 0,
4621                                 0,
4622                                 0,
4623                                 SCSI_SENSE_BUFFERSIZE,
4624                                 0};
4625         char *buffer;
4626         int ret;
4627
4628         buffer = kzalloc(SCSI_SENSE_BUFFERSIZE, GFP_KERNEL);
4629         if (!buffer) {
4630                 ret = -ENOMEM;
4631                 goto out;
4632         }
4633
4634         ret = scsi_execute_req_flags(sdp, cmd, DMA_FROM_DEVICE, buffer,
4635                                 SCSI_SENSE_BUFFERSIZE, NULL,
4636                                 msecs_to_jiffies(1000), 3, NULL, REQ_PM);
4637         if (ret)
4638                 pr_err("%s: failed with err %d\n", __func__, ret);
4639
4640         kfree(buffer);
4641 out:
4642         return ret;
4643 }
4644
4645 /**
4646  * ufshcd_set_dev_pwr_mode - sends START STOP UNIT command to set device
4647  *                           power mode
4648  * @hba: per adapter instance
4649  * @pwr_mode: device power mode to set
4650  *
4651  * Returns 0 if requested power mode is set successfully
4652  * Returns non-zero if failed to set the requested power mode
4653  */
4654 static int ufshcd_set_dev_pwr_mode(struct ufs_hba *hba,
4655                                      enum ufs_dev_pwr_mode pwr_mode)
4656 {
4657         unsigned char cmd[6] = { START_STOP };
4658         struct scsi_sense_hdr sshdr;
4659         struct scsi_device *sdp = hba->sdev_ufs_device;
4660         int ret;
4661
4662         if (!sdp || !scsi_device_online(sdp))
4663                 return -ENODEV;
4664
4665         /*
4666          * If scsi commands fail, the scsi mid-layer schedules scsi error-
4667          * handling, which would wait for host to be resumed. Since we know
4668          * we are functional while we are here, skip host resume in error
4669          * handling context.
4670          */
4671         hba->host->eh_noresume = 1;
4672         if (hba->wlun_dev_clr_ua) {
4673                 ret = ufshcd_send_request_sense(hba, sdp);
4674                 if (ret)
4675                         goto out;
4676                 /* Unit attention condition is cleared now */
4677                 hba->wlun_dev_clr_ua = false;
4678         }
4679
4680         cmd[4] = pwr_mode << 4;
4681
4682         /*
4683          * Current function would be generally called from the power management
4684          * callbacks hence set the REQ_PM flag so that it doesn't resume the
4685          * already suspended childs.
4686          */
4687         ret = scsi_execute_req_flags(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
4688                                      START_STOP_TIMEOUT, 0, NULL, REQ_PM);
4689         if (ret) {
4690                 sdev_printk(KERN_WARNING, sdp,
4691                             "START_STOP failed for power mode: %d, result %x\n",
4692                             pwr_mode, ret);
4693                 if (driver_byte(ret) & DRIVER_SENSE) {
4694                         scsi_show_sense_hdr(sdp, NULL, &sshdr);
4695                         scsi_show_extd_sense(sdp, NULL, sshdr.asc, sshdr.ascq);
4696                 }
4697         }
4698
4699         if (!ret)
4700                 hba->curr_dev_pwr_mode = pwr_mode;
4701 out:
4702         hba->host->eh_noresume = 0;
4703         return ret;
4704 }
4705
4706 static int ufshcd_link_state_transition(struct ufs_hba *hba,
4707                                         enum uic_link_state req_link_state,
4708                                         int check_for_bkops)
4709 {
4710         int ret = 0;
4711
4712         if (req_link_state == hba->uic_link_state)
4713                 return 0;
4714
4715         if (req_link_state == UIC_LINK_HIBERN8_STATE) {
4716                 ret = ufshcd_uic_hibern8_enter(hba);
4717                 if (!ret)
4718                         ufshcd_set_link_hibern8(hba);
4719                 else
4720                         goto out;
4721         }
4722         /*
4723          * If autobkops is enabled, link can't be turned off because
4724          * turning off the link would also turn off the device.
4725          */
4726         else if ((req_link_state == UIC_LINK_OFF_STATE) &&
4727                    (!check_for_bkops || (check_for_bkops &&
4728                     !hba->auto_bkops_enabled))) {
4729                 /*
4730                  * Change controller state to "reset state" which
4731                  * should also put the link in off/reset state
4732                  */
4733                 ufshcd_hba_stop(hba);
4734                 /*
4735                  * TODO: Check if we need any delay to make sure that
4736                  * controller is reset
4737                  */
4738                 ufshcd_set_link_off(hba);
4739         }
4740
4741 out:
4742         return ret;
4743 }
4744
4745 static void ufshcd_vreg_set_lpm(struct ufs_hba *hba)
4746 {
4747         /*
4748          * If UFS device is either in UFS_Sleep turn off VCC rail to save some
4749          * power.
4750          *
4751          * If UFS device and link is in OFF state, all power supplies (VCC,
4752          * VCCQ, VCCQ2) can be turned off if power on write protect is not
4753          * required. If UFS link is inactive (Hibern8 or OFF state) and device
4754          * is in sleep state, put VCCQ & VCCQ2 rails in LPM mode.
4755          *
4756          * Ignore the error returned by ufshcd_toggle_vreg() as device is anyway
4757          * in low power state which would save some power.
4758          */
4759         if (ufshcd_is_ufs_dev_poweroff(hba) && ufshcd_is_link_off(hba) &&
4760             !hba->dev_info.is_lu_power_on_wp) {
4761                 ufshcd_setup_vreg(hba, false);
4762         } else if (!ufshcd_is_ufs_dev_active(hba)) {
4763                 ufshcd_toggle_vreg(hba->dev, hba->vreg_info.vcc, false);
4764                 if (!ufshcd_is_link_active(hba)) {
4765                         ufshcd_config_vreg_lpm(hba, hba->vreg_info.vccq);
4766                         ufshcd_config_vreg_lpm(hba, hba->vreg_info.vccq2);
4767                 }
4768         }
4769 }
4770
4771 static int ufshcd_vreg_set_hpm(struct ufs_hba *hba)
4772 {
4773         int ret = 0;
4774
4775         if (ufshcd_is_ufs_dev_poweroff(hba) && ufshcd_is_link_off(hba) &&
4776             !hba->dev_info.is_lu_power_on_wp) {
4777                 ret = ufshcd_setup_vreg(hba, true);
4778         } else if (!ufshcd_is_ufs_dev_active(hba)) {
4779                 ret = ufshcd_toggle_vreg(hba->dev, hba->vreg_info.vcc, true);
4780                 if (!ret && !ufshcd_is_link_active(hba)) {
4781                         ret = ufshcd_config_vreg_hpm(hba, hba->vreg_info.vccq);
4782                         if (ret)
4783                                 goto vcc_disable;
4784                         ret = ufshcd_config_vreg_hpm(hba, hba->vreg_info.vccq2);
4785                         if (ret)
4786                                 goto vccq_lpm;
4787                 }
4788         }
4789         goto out;
4790
4791 vccq_lpm:
4792         ufshcd_config_vreg_lpm(hba, hba->vreg_info.vccq);
4793 vcc_disable:
4794         ufshcd_toggle_vreg(hba->dev, hba->vreg_info.vcc, false);
4795 out:
4796         return ret;
4797 }
4798
4799 static void ufshcd_hba_vreg_set_lpm(struct ufs_hba *hba)
4800 {
4801         if (ufshcd_is_link_off(hba))
4802                 ufshcd_setup_hba_vreg(hba, false);
4803 }
4804
4805 static void ufshcd_hba_vreg_set_hpm(struct ufs_hba *hba)
4806 {
4807         if (ufshcd_is_link_off(hba))
4808                 ufshcd_setup_hba_vreg(hba, true);
4809 }
4810
4811 /**
4812  * ufshcd_suspend - helper function for suspend operations
4813  * @hba: per adapter instance
4814  * @pm_op: desired low power operation type
4815  *
4816  * This function will try to put the UFS device and link into low power
4817  * mode based on the "rpm_lvl" (Runtime PM level) or "spm_lvl"
4818  * (System PM level).
4819  *
4820  * If this function is called during shutdown, it will make sure that
4821  * both UFS device and UFS link is powered off.
4822  *
4823  * NOTE: UFS device & link must be active before we enter in this function.
4824  *
4825  * Returns 0 for success and non-zero for failure
4826  */
4827 static int ufshcd_suspend(struct ufs_hba *hba, enum ufs_pm_op pm_op)
4828 {
4829         int ret = 0;
4830         enum ufs_pm_level pm_lvl;
4831         enum ufs_dev_pwr_mode req_dev_pwr_mode;
4832         enum uic_link_state req_link_state;
4833
4834         hba->pm_op_in_progress = 1;
4835         if (!ufshcd_is_shutdown_pm(pm_op)) {
4836                 pm_lvl = ufshcd_is_runtime_pm(pm_op) ?
4837                          hba->rpm_lvl : hba->spm_lvl;
4838                 req_dev_pwr_mode = ufs_get_pm_lvl_to_dev_pwr_mode(pm_lvl);
4839                 req_link_state = ufs_get_pm_lvl_to_link_pwr_state(pm_lvl);
4840         } else {
4841                 req_dev_pwr_mode = UFS_POWERDOWN_PWR_MODE;
4842                 req_link_state = UIC_LINK_OFF_STATE;
4843         }
4844
4845         /*
4846          * If we can't transition into any of the low power modes
4847          * just gate the clocks.
4848          */
4849         ufshcd_hold(hba, false);
4850         hba->clk_gating.is_suspended = true;
4851
4852         if (req_dev_pwr_mode == UFS_ACTIVE_PWR_MODE &&
4853                         req_link_state == UIC_LINK_ACTIVE_STATE) {
4854                 goto disable_clks;
4855         }
4856
4857         if ((req_dev_pwr_mode == hba->curr_dev_pwr_mode) &&
4858             (req_link_state == hba->uic_link_state))
4859                 goto out;
4860
4861         /* UFS device & link must be active before we enter in this function */
4862         if (!ufshcd_is_ufs_dev_active(hba) || !ufshcd_is_link_active(hba)) {
4863                 ret = -EINVAL;
4864                 goto out;
4865         }
4866
4867         if (ufshcd_is_runtime_pm(pm_op)) {
4868                 if (ufshcd_can_autobkops_during_suspend(hba)) {
4869                         /*
4870                          * The device is idle with no requests in the queue,
4871                          * allow background operations if bkops status shows
4872                          * that performance might be impacted.
4873                          */
4874                         ret = ufshcd_urgent_bkops(hba);
4875                         if (ret)
4876                                 goto enable_gating;
4877                 } else {
4878                         /* make sure that auto bkops is disabled */
4879                         ufshcd_disable_auto_bkops(hba);
4880                 }
4881         }
4882
4883         if ((req_dev_pwr_mode != hba->curr_dev_pwr_mode) &&
4884              ((ufshcd_is_runtime_pm(pm_op) && !hba->auto_bkops_enabled) ||
4885                !ufshcd_is_runtime_pm(pm_op))) {
4886                 /* ensure that bkops is disabled */
4887                 ufshcd_disable_auto_bkops(hba);
4888                 ret = ufshcd_set_dev_pwr_mode(hba, req_dev_pwr_mode);
4889                 if (ret)
4890                         goto enable_gating;
4891         }
4892
4893         ret = ufshcd_link_state_transition(hba, req_link_state, 1);
4894         if (ret)
4895                 goto set_dev_active;
4896
4897         ufshcd_vreg_set_lpm(hba);
4898
4899 disable_clks:
4900         /*
4901          * The clock scaling needs access to controller registers. Hence, Wait
4902          * for pending clock scaling work to be done before clocks are
4903          * turned off.
4904          */
4905         if (ufshcd_is_clkscaling_enabled(hba)) {
4906                 devfreq_suspend_device(hba->devfreq);
4907                 hba->clk_scaling.window_start_t = 0;
4908         }
4909         /*
4910          * Call vendor specific suspend callback. As these callbacks may access
4911          * vendor specific host controller register space call them before the
4912          * host clocks are ON.
4913          */
4914         if (hba->vops && hba->vops->suspend) {
4915                 ret = hba->vops->suspend(hba, pm_op);
4916                 if (ret)
4917                         goto set_link_active;
4918         }
4919
4920         if (hba->vops && hba->vops->setup_clocks) {
4921                 ret = hba->vops->setup_clocks(hba, false);
4922                 if (ret)
4923                         goto vops_resume;
4924         }
4925
4926         if (!ufshcd_is_link_active(hba))
4927                 ufshcd_setup_clocks(hba, false);
4928         else
4929                 /* If link is active, device ref_clk can't be switched off */
4930                 __ufshcd_setup_clocks(hba, false, true);
4931
4932         hba->clk_gating.state = CLKS_OFF;
4933         /*
4934          * Disable the host irq as host controller as there won't be any
4935          * host controller trasanction expected till resume.
4936          */
4937         ufshcd_disable_irq(hba);
4938         /* Put the host controller in low power mode if possible */
4939         ufshcd_hba_vreg_set_lpm(hba);
4940         goto out;
4941
4942 vops_resume:
4943         if (hba->vops && hba->vops->resume)
4944                 hba->vops->resume(hba, pm_op);
4945 set_link_active:
4946         ufshcd_vreg_set_hpm(hba);
4947         if (ufshcd_is_link_hibern8(hba) && !ufshcd_uic_hibern8_exit(hba))
4948                 ufshcd_set_link_active(hba);
4949         else if (ufshcd_is_link_off(hba))
4950                 ufshcd_host_reset_and_restore(hba);
4951 set_dev_active:
4952         if (!ufshcd_set_dev_pwr_mode(hba, UFS_ACTIVE_PWR_MODE))
4953                 ufshcd_disable_auto_bkops(hba);
4954 enable_gating:
4955         hba->clk_gating.is_suspended = false;
4956         ufshcd_release(hba);
4957 out:
4958         hba->pm_op_in_progress = 0;
4959         return ret;
4960 }
4961
4962 /**
4963  * ufshcd_resume - helper function for resume operations
4964  * @hba: per adapter instance
4965  * @pm_op: runtime PM or system PM
4966  *
4967  * This function basically brings the UFS device, UniPro link and controller
4968  * to active state.
4969  *
4970  * Returns 0 for success and non-zero for failure
4971  */
4972 static int ufshcd_resume(struct ufs_hba *hba, enum ufs_pm_op pm_op)
4973 {
4974         int ret;
4975         enum uic_link_state old_link_state;
4976
4977         hba->pm_op_in_progress = 1;
4978         old_link_state = hba->uic_link_state;
4979
4980         ufshcd_hba_vreg_set_hpm(hba);
4981         /* Make sure clocks are enabled before accessing controller */
4982         ret = ufshcd_setup_clocks(hba, true);
4983         if (ret)
4984                 goto out;
4985
4986         /* enable the host irq as host controller would be active soon */
4987         ret = ufshcd_enable_irq(hba);
4988         if (ret)
4989                 goto disable_irq_and_vops_clks;
4990
4991         ret = ufshcd_vreg_set_hpm(hba);
4992         if (ret)
4993                 goto disable_irq_and_vops_clks;
4994
4995         /*
4996          * Call vendor specific resume callback. As these callbacks may access
4997          * vendor specific host controller register space call them when the
4998          * host clocks are ON.
4999          */
5000         if (hba->vops && hba->vops->resume) {
5001                 ret = hba->vops->resume(hba, pm_op);
5002                 if (ret)
5003                         goto disable_vreg;
5004         }
5005
5006         if (ufshcd_is_link_hibern8(hba)) {
5007                 ret = ufshcd_uic_hibern8_exit(hba);
5008                 if (!ret)
5009                         ufshcd_set_link_active(hba);
5010                 else
5011                         goto vendor_suspend;
5012         } else if (ufshcd_is_link_off(hba)) {
5013                 ret = ufshcd_host_reset_and_restore(hba);
5014                 /*
5015                  * ufshcd_host_reset_and_restore() should have already
5016                  * set the link state as active
5017                  */
5018                 if (ret || !ufshcd_is_link_active(hba))
5019                         goto vendor_suspend;
5020         }
5021
5022         if (!ufshcd_is_ufs_dev_active(hba)) {
5023                 ret = ufshcd_set_dev_pwr_mode(hba, UFS_ACTIVE_PWR_MODE);
5024                 if (ret)
5025                         goto set_old_link_state;
5026         }
5027
5028         /*
5029          * If BKOPs operations are urgently needed at this moment then
5030          * keep auto-bkops enabled or else disable it.
5031          */
5032         ufshcd_urgent_bkops(hba);
5033         hba->clk_gating.is_suspended = false;
5034
5035         if (ufshcd_is_clkscaling_enabled(hba))
5036                 devfreq_resume_device(hba->devfreq);
5037
5038         /* Schedule clock gating in case of no access to UFS device yet */
5039         ufshcd_release(hba);
5040         goto out;
5041
5042 set_old_link_state:
5043         ufshcd_link_state_transition(hba, old_link_state, 0);
5044 vendor_suspend:
5045         if (hba->vops && hba->vops->suspend)
5046                 hba->vops->suspend(hba, pm_op);
5047 disable_vreg:
5048         ufshcd_vreg_set_lpm(hba);
5049 disable_irq_and_vops_clks:
5050         ufshcd_disable_irq(hba);
5051         ufshcd_setup_clocks(hba, false);
5052 out:
5053         hba->pm_op_in_progress = 0;
5054         return ret;
5055 }
5056
5057 /**
5058  * ufshcd_system_suspend - system suspend routine
5059  * @hba: per adapter instance
5060  * @pm_op: runtime PM or system PM
5061  *
5062  * Check the description of ufshcd_suspend() function for more details.
5063  *
5064  * Returns 0 for success and non-zero for failure
5065  */
5066 int ufshcd_system_suspend(struct ufs_hba *hba)
5067 {
5068         int ret = 0;
5069
5070         if (!hba || !hba->is_powered)
5071                 goto out;
5072
5073         if (pm_runtime_suspended(hba->dev)) {
5074                 if (hba->rpm_lvl == hba->spm_lvl)
5075                         /*
5076                          * There is possibility that device may still be in
5077                          * active state during the runtime suspend.
5078                          */
5079                         if ((ufs_get_pm_lvl_to_dev_pwr_mode(hba->spm_lvl) ==
5080                             hba->curr_dev_pwr_mode) && !hba->auto_bkops_enabled)
5081                                 goto out;
5082
5083                 /*
5084                  * UFS device and/or UFS link low power states during runtime
5085                  * suspend seems to be different than what is expected during
5086                  * system suspend. Hence runtime resume the devic & link and
5087                  * let the system suspend low power states to take effect.
5088                  * TODO: If resume takes longer time, we might have optimize
5089                  * it in future by not resuming everything if possible.
5090                  */
5091                 ret = ufshcd_runtime_resume(hba);
5092                 if (ret)
5093                         goto out;
5094         }
5095
5096         ret = ufshcd_suspend(hba, UFS_SYSTEM_PM);
5097 out:
5098         if (!ret)
5099                 hba->is_sys_suspended = true;
5100         return ret;
5101 }
5102 EXPORT_SYMBOL(ufshcd_system_suspend);
5103
5104 /**
5105  * ufshcd_system_resume - system resume routine
5106  * @hba: per adapter instance
5107  *
5108  * Returns 0 for success and non-zero for failure
5109  */
5110
5111 int ufshcd_system_resume(struct ufs_hba *hba)
5112 {
5113         if (!hba || !hba->is_powered || pm_runtime_suspended(hba->dev))
5114                 /*
5115                  * Let the runtime resume take care of resuming
5116                  * if runtime suspended.
5117                  */
5118                 return 0;
5119
5120         return ufshcd_resume(hba, UFS_SYSTEM_PM);
5121 }
5122 EXPORT_SYMBOL(ufshcd_system_resume);
5123
5124 /**
5125  * ufshcd_runtime_suspend - runtime suspend routine
5126  * @hba: per adapter instance
5127  *
5128  * Check the description of ufshcd_suspend() function for more details.
5129  *
5130  * Returns 0 for success and non-zero for failure
5131  */
5132 int ufshcd_runtime_suspend(struct ufs_hba *hba)
5133 {
5134         if (!hba || !hba->is_powered)
5135                 return 0;
5136
5137         return ufshcd_suspend(hba, UFS_RUNTIME_PM);
5138 }
5139 EXPORT_SYMBOL(ufshcd_runtime_suspend);
5140
5141 /**
5142  * ufshcd_runtime_resume - runtime resume routine
5143  * @hba: per adapter instance
5144  *
5145  * This function basically brings the UFS device, UniPro link and controller
5146  * to active state. Following operations are done in this function:
5147  *
5148  * 1. Turn on all the controller related clocks
5149  * 2. Bring the UniPro link out of Hibernate state
5150  * 3. If UFS device is in sleep state, turn ON VCC rail and bring the UFS device
5151  *    to active state.
5152  * 4. If auto-bkops is enabled on the device, disable it.
5153  *
5154  * So following would be the possible power state after this function return
5155  * successfully:
5156  *      S1: UFS device in Active state with VCC rail ON
5157  *          UniPro link in Active state
5158  *          All the UFS/UniPro controller clocks are ON
5159  *
5160  * Returns 0 for success and non-zero for failure
5161  */
5162 int ufshcd_runtime_resume(struct ufs_hba *hba)
5163 {
5164         if (!hba || !hba->is_powered)
5165                 return 0;
5166         else
5167                 return ufshcd_resume(hba, UFS_RUNTIME_PM);
5168 }
5169 EXPORT_SYMBOL(ufshcd_runtime_resume);
5170
5171 int ufshcd_runtime_idle(struct ufs_hba *hba)
5172 {
5173         return 0;
5174 }
5175 EXPORT_SYMBOL(ufshcd_runtime_idle);
5176
5177 /**
5178  * ufshcd_shutdown - shutdown routine
5179  * @hba: per adapter instance
5180  *
5181  * This function would power off both UFS device and UFS link.
5182  *
5183  * Returns 0 always to allow force shutdown even in case of errors.
5184  */
5185 int ufshcd_shutdown(struct ufs_hba *hba)
5186 {
5187         int ret = 0;
5188
5189         if (ufshcd_is_ufs_dev_poweroff(hba) && ufshcd_is_link_off(hba))
5190                 goto out;
5191
5192         if (pm_runtime_suspended(hba->dev)) {
5193                 ret = ufshcd_runtime_resume(hba);
5194                 if (ret)
5195                         goto out;
5196         }
5197
5198         ret = ufshcd_suspend(hba, UFS_SHUTDOWN_PM);
5199 out:
5200         if (ret)
5201                 dev_err(hba->dev, "%s failed, err %d\n", __func__, ret);
5202         /* allow force shutdown even in case of errors */
5203         return 0;
5204 }
5205 EXPORT_SYMBOL(ufshcd_shutdown);
5206
5207 /**
5208  * ufshcd_remove - de-allocate SCSI host and host memory space
5209  *              data structure memory
5210  * @hba - per adapter instance
5211  */
5212 void ufshcd_remove(struct ufs_hba *hba)
5213 {
5214         scsi_remove_host(hba->host);
5215         ufshcd_scsi_remove_wlus(hba);
5216         /* disable interrupts */
5217         ufshcd_disable_intr(hba, hba->intr_mask);
5218         ufshcd_hba_stop(hba);
5219
5220         scsi_host_put(hba->host);
5221
5222         ufshcd_exit_clk_gating(hba);
5223         if (ufshcd_is_clkscaling_enabled(hba))
5224                 devfreq_remove_device(hba->devfreq);
5225         ufshcd_hba_exit(hba);
5226 }
5227 EXPORT_SYMBOL_GPL(ufshcd_remove);
5228
5229 /**
5230  * ufshcd_set_dma_mask - Set dma mask based on the controller
5231  *                       addressing capability
5232  * @hba: per adapter instance
5233  *
5234  * Returns 0 for success, non-zero for failure
5235  */
5236 static int ufshcd_set_dma_mask(struct ufs_hba *hba)
5237 {
5238         if (hba->capabilities & MASK_64_ADDRESSING_SUPPORT) {
5239                 if (!dma_set_mask_and_coherent(hba->dev, DMA_BIT_MASK(64)))
5240                         return 0;
5241         }
5242         return dma_set_mask_and_coherent(hba->dev, DMA_BIT_MASK(32));
5243 }
5244
5245 /**
5246  * ufshcd_alloc_host - allocate Host Bus Adapter (HBA)
5247  * @dev: pointer to device handle
5248  * @hba_handle: driver private handle
5249  * Returns 0 on success, non-zero value on failure
5250  */
5251 int ufshcd_alloc_host(struct device *dev, struct ufs_hba **hba_handle)
5252 {
5253         struct Scsi_Host *host;
5254         struct ufs_hba *hba;
5255         int err = 0;
5256
5257         if (!dev) {
5258                 dev_err(dev,
5259                 "Invalid memory reference for dev is NULL\n");
5260                 err = -ENODEV;
5261                 goto out_error;
5262         }
5263
5264         host = scsi_host_alloc(&ufshcd_driver_template,
5265                                 sizeof(struct ufs_hba));
5266         if (!host) {
5267                 dev_err(dev, "scsi_host_alloc failed\n");
5268                 err = -ENOMEM;
5269                 goto out_error;
5270         }
5271         hba = shost_priv(host);
5272         hba->host = host;
5273         hba->dev = dev;
5274         *hba_handle = hba;
5275
5276 out_error:
5277         return err;
5278 }
5279 EXPORT_SYMBOL(ufshcd_alloc_host);
5280
5281 static int ufshcd_scale_clks(struct ufs_hba *hba, bool scale_up)
5282 {
5283         int ret = 0;
5284         struct ufs_clk_info *clki;
5285         struct list_head *head = &hba->clk_list_head;
5286
5287         if (!head || list_empty(head))
5288                 goto out;
5289
5290         list_for_each_entry(clki, head, list) {
5291                 if (!IS_ERR_OR_NULL(clki->clk)) {
5292                         if (scale_up && clki->max_freq) {
5293                                 if (clki->curr_freq == clki->max_freq)
5294                                         continue;
5295                                 ret = clk_set_rate(clki->clk, clki->max_freq);
5296                                 if (ret) {
5297                                         dev_err(hba->dev, "%s: %s clk set rate(%dHz) failed, %d\n",
5298                                                 __func__, clki->name,
5299                                                 clki->max_freq, ret);
5300                                         break;
5301                                 }
5302                                 clki->curr_freq = clki->max_freq;
5303
5304                         } else if (!scale_up && clki->min_freq) {
5305                                 if (clki->curr_freq == clki->min_freq)
5306                                         continue;
5307                                 ret = clk_set_rate(clki->clk, clki->min_freq);
5308                                 if (ret) {
5309                                         dev_err(hba->dev, "%s: %s clk set rate(%dHz) failed, %d\n",
5310                                                 __func__, clki->name,
5311                                                 clki->min_freq, ret);
5312                                         break;
5313                                 }
5314                                 clki->curr_freq = clki->min_freq;
5315                         }
5316                 }
5317                 dev_dbg(hba->dev, "%s: clk: %s, rate: %lu\n", __func__,
5318                                 clki->name, clk_get_rate(clki->clk));
5319         }
5320         if (hba->vops->clk_scale_notify)
5321                 hba->vops->clk_scale_notify(hba);
5322 out:
5323         return ret;
5324 }
5325
5326 static int ufshcd_devfreq_target(struct device *dev,
5327                                 unsigned long *freq, u32 flags)
5328 {
5329         int err = 0;
5330         struct ufs_hba *hba = dev_get_drvdata(dev);
5331
5332         if (!ufshcd_is_clkscaling_enabled(hba))
5333                 return -EINVAL;
5334
5335         if (*freq == UINT_MAX)
5336                 err = ufshcd_scale_clks(hba, true);
5337         else if (*freq == 0)
5338                 err = ufshcd_scale_clks(hba, false);
5339
5340         return err;
5341 }
5342
5343 static int ufshcd_devfreq_get_dev_status(struct device *dev,
5344                 struct devfreq_dev_status *stat)
5345 {
5346         struct ufs_hba *hba = dev_get_drvdata(dev);
5347         struct ufs_clk_scaling *scaling = &hba->clk_scaling;
5348         unsigned long flags;
5349
5350         if (!ufshcd_is_clkscaling_enabled(hba))
5351                 return -EINVAL;
5352
5353         memset(stat, 0, sizeof(*stat));
5354
5355         spin_lock_irqsave(hba->host->host_lock, flags);
5356         if (!scaling->window_start_t)
5357                 goto start_window;
5358
5359         if (scaling->is_busy_started)
5360                 scaling->tot_busy_t += ktime_to_us(ktime_sub(ktime_get(),
5361                                         scaling->busy_start_t));
5362
5363         stat->total_time = jiffies_to_usecs((long)jiffies -
5364                                 (long)scaling->window_start_t);
5365         stat->busy_time = scaling->tot_busy_t;
5366 start_window:
5367         scaling->window_start_t = jiffies;
5368         scaling->tot_busy_t = 0;
5369
5370         if (hba->outstanding_reqs) {
5371                 scaling->busy_start_t = ktime_get();
5372                 scaling->is_busy_started = true;
5373         } else {
5374                 scaling->busy_start_t = ktime_set(0, 0);
5375                 scaling->is_busy_started = false;
5376         }
5377         spin_unlock_irqrestore(hba->host->host_lock, flags);
5378         return 0;
5379 }
5380
5381 static struct devfreq_dev_profile ufs_devfreq_profile = {
5382         .polling_ms     = 100,
5383         .target         = ufshcd_devfreq_target,
5384         .get_dev_status = ufshcd_devfreq_get_dev_status,
5385 };
5386
5387 /**
5388  * ufshcd_init - Driver initialization routine
5389  * @hba: per-adapter instance
5390  * @mmio_base: base register address
5391  * @irq: Interrupt line of device
5392  * Returns 0 on success, non-zero value on failure
5393  */
5394 int ufshcd_init(struct ufs_hba *hba, void __iomem *mmio_base, unsigned int irq)
5395 {
5396         int err;
5397         struct Scsi_Host *host = hba->host;
5398         struct device *dev = hba->dev;
5399
5400         if (!mmio_base) {
5401                 dev_err(hba->dev,
5402                 "Invalid memory reference for mmio_base is NULL\n");
5403                 err = -ENODEV;
5404                 goto out_error;
5405         }
5406
5407         hba->mmio_base = mmio_base;
5408         hba->irq = irq;
5409
5410         err = ufshcd_hba_init(hba);
5411         if (err)
5412                 goto out_error;
5413
5414         /* Read capabilities registers */
5415         ufshcd_hba_capabilities(hba);
5416
5417         /* Get UFS version supported by the controller */
5418         hba->ufs_version = ufshcd_get_ufs_version(hba);
5419
5420         /* Get Interrupt bit mask per version */
5421         hba->intr_mask = ufshcd_get_intr_mask(hba);
5422
5423         err = ufshcd_set_dma_mask(hba);
5424         if (err) {
5425                 dev_err(hba->dev, "set dma mask failed\n");
5426                 goto out_disable;
5427         }
5428
5429         /* Allocate memory for host memory space */
5430         err = ufshcd_memory_alloc(hba);
5431         if (err) {
5432                 dev_err(hba->dev, "Memory allocation failed\n");
5433                 goto out_disable;
5434         }
5435
5436         /* Configure LRB */
5437         ufshcd_host_memory_configure(hba);
5438
5439         host->can_queue = hba->nutrs;
5440         host->cmd_per_lun = hba->nutrs;
5441         host->max_id = UFSHCD_MAX_ID;
5442         host->max_lun = UFS_MAX_LUNS;
5443         host->max_channel = UFSHCD_MAX_CHANNEL;
5444         host->unique_id = host->host_no;
5445         host->max_cmd_len = MAX_CDB_SIZE;
5446
5447         hba->max_pwr_info.is_valid = false;
5448
5449         /* Initailize wait queue for task management */
5450         init_waitqueue_head(&hba->tm_wq);
5451         init_waitqueue_head(&hba->tm_tag_wq);
5452
5453         /* Initialize work queues */
5454         INIT_WORK(&hba->eh_work, ufshcd_err_handler);
5455         INIT_WORK(&hba->eeh_work, ufshcd_exception_event_handler);
5456
5457         /* Initialize UIC command mutex */
5458         mutex_init(&hba->uic_cmd_mutex);
5459
5460         /* Initialize mutex for device management commands */
5461         mutex_init(&hba->dev_cmd.lock);
5462
5463         /* Initialize device management tag acquire wait queue */
5464         init_waitqueue_head(&hba->dev_cmd.tag_wq);
5465
5466         ufshcd_init_clk_gating(hba);
5467         /* IRQ registration */
5468         err = devm_request_irq(dev, irq, ufshcd_intr, IRQF_SHARED, UFSHCD, hba);
5469         if (err) {
5470                 dev_err(hba->dev, "request irq failed\n");
5471                 goto exit_gating;
5472         } else {
5473                 hba->is_irq_enabled = true;
5474         }
5475
5476         /* Enable SCSI tag mapping */
5477         err = scsi_init_shared_tag_map(host, host->can_queue);
5478         if (err) {
5479                 dev_err(hba->dev, "init shared queue failed\n");
5480                 goto exit_gating;
5481         }
5482
5483         err = scsi_add_host(host, hba->dev);
5484         if (err) {
5485                 dev_err(hba->dev, "scsi_add_host failed\n");
5486                 goto exit_gating;
5487         }
5488
5489         /* Host controller enable */
5490         err = ufshcd_hba_enable(hba);
5491         if (err) {
5492                 dev_err(hba->dev, "Host controller enable failed\n");
5493                 goto out_remove_scsi_host;
5494         }
5495
5496         if (ufshcd_is_clkscaling_enabled(hba)) {
5497                 hba->devfreq = devfreq_add_device(dev, &ufs_devfreq_profile,
5498                                                    "simple_ondemand", NULL);
5499                 if (IS_ERR(hba->devfreq)) {
5500                         dev_err(hba->dev, "Unable to register with devfreq %ld\n",
5501                                         PTR_ERR(hba->devfreq));
5502                         goto out_remove_scsi_host;
5503                 }
5504                 /* Suspend devfreq until the UFS device is detected */
5505                 devfreq_suspend_device(hba->devfreq);
5506                 hba->clk_scaling.window_start_t = 0;
5507         }
5508
5509         /* Hold auto suspend until async scan completes */
5510         pm_runtime_get_sync(dev);
5511
5512         /*
5513          * The device-initialize-sequence hasn't been invoked yet.
5514          * Set the device to power-off state
5515          */
5516         ufshcd_set_ufs_dev_poweroff(hba);
5517
5518         async_schedule(ufshcd_async_scan, hba);
5519
5520         return 0;
5521
5522 out_remove_scsi_host:
5523         scsi_remove_host(hba->host);
5524 exit_gating:
5525         ufshcd_exit_clk_gating(hba);
5526 out_disable:
5527         hba->is_irq_enabled = false;
5528         scsi_host_put(host);
5529         ufshcd_hba_exit(hba);
5530 out_error:
5531         return err;
5532 }
5533 EXPORT_SYMBOL_GPL(ufshcd_init);
5534
5535 MODULE_AUTHOR("Santosh Yaragnavi <santosh.sy@samsung.com>");
5536 MODULE_AUTHOR("Vinayak Holikatti <h.vinayak@samsung.com>");
5537 MODULE_DESCRIPTION("Generic UFS host controller driver Core");
5538 MODULE_LICENSE("GPL");
5539 MODULE_VERSION(UFSHCD_DRIVER_VERSION);