scsi: ufs: Remove unused device quirks
[sfrench/cifs-2.6.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-2016, 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 #include <linux/nls.h>
43 #include <linux/of.h>
44 #include <linux/bitfield.h>
45 #include "ufshcd.h"
46 #include "ufs_quirks.h"
47 #include "unipro.h"
48 #include "ufs-sysfs.h"
49 #include "ufs_bsg.h"
50
51 #define CREATE_TRACE_POINTS
52 #include <trace/events/ufs.h>
53
54 #define UFSHCD_ENABLE_INTRS     (UTP_TRANSFER_REQ_COMPL |\
55                                  UTP_TASK_REQ_COMPL |\
56                                  UFSHCD_ERROR_MASK)
57 /* UIC command timeout, unit: ms */
58 #define UIC_CMD_TIMEOUT 500
59
60 /* NOP OUT retries waiting for NOP IN response */
61 #define NOP_OUT_RETRIES    10
62 /* Timeout after 30 msecs if NOP OUT hangs without response */
63 #define NOP_OUT_TIMEOUT    30 /* msecs */
64
65 /* Query request retries */
66 #define QUERY_REQ_RETRIES 3
67 /* Query request timeout */
68 #define QUERY_REQ_TIMEOUT 1500 /* 1.5 seconds */
69
70 /* Task management command timeout */
71 #define TM_CMD_TIMEOUT  100 /* msecs */
72
73 /* maximum number of retries for a general UIC command  */
74 #define UFS_UIC_COMMAND_RETRIES 3
75
76 /* maximum number of link-startup retries */
77 #define DME_LINKSTARTUP_RETRIES 3
78
79 /* Maximum retries for Hibern8 enter */
80 #define UIC_HIBERN8_ENTER_RETRIES 3
81
82 /* maximum number of reset retries before giving up */
83 #define MAX_HOST_RESET_RETRIES 5
84
85 /* Expose the flag value from utp_upiu_query.value */
86 #define MASK_QUERY_UPIU_FLAG_LOC 0xFF
87
88 /* Interrupt aggregation default timeout, unit: 40us */
89 #define INT_AGGR_DEF_TO 0x02
90
91 #define ufshcd_toggle_vreg(_dev, _vreg, _on)                            \
92         ({                                                              \
93                 int _ret;                                               \
94                 if (_on)                                                \
95                         _ret = ufshcd_enable_vreg(_dev, _vreg);         \
96                 else                                                    \
97                         _ret = ufshcd_disable_vreg(_dev, _vreg);        \
98                 _ret;                                                   \
99         })
100
101 #define ufshcd_hex_dump(prefix_str, buf, len) do {                       \
102         size_t __len = (len);                                            \
103         print_hex_dump(KERN_ERR, prefix_str,                             \
104                        __len > 4 ? DUMP_PREFIX_OFFSET : DUMP_PREFIX_NONE,\
105                        16, 4, buf, __len, false);                        \
106 } while (0)
107
108 int ufshcd_dump_regs(struct ufs_hba *hba, size_t offset, size_t len,
109                      const char *prefix)
110 {
111         u8 *regs;
112
113         regs = kzalloc(len, GFP_KERNEL);
114         if (!regs)
115                 return -ENOMEM;
116
117         memcpy_fromio(regs, hba->mmio_base + offset, len);
118         ufshcd_hex_dump(prefix, regs, len);
119         kfree(regs);
120
121         return 0;
122 }
123 EXPORT_SYMBOL_GPL(ufshcd_dump_regs);
124
125 enum {
126         UFSHCD_MAX_CHANNEL      = 0,
127         UFSHCD_MAX_ID           = 1,
128         UFSHCD_CMD_PER_LUN      = 32,
129         UFSHCD_CAN_QUEUE        = 32,
130 };
131
132 /* UFSHCD states */
133 enum {
134         UFSHCD_STATE_RESET,
135         UFSHCD_STATE_ERROR,
136         UFSHCD_STATE_OPERATIONAL,
137         UFSHCD_STATE_EH_SCHEDULED,
138 };
139
140 /* UFSHCD error handling flags */
141 enum {
142         UFSHCD_EH_IN_PROGRESS = (1 << 0),
143 };
144
145 /* UFSHCD UIC layer error flags */
146 enum {
147         UFSHCD_UIC_DL_PA_INIT_ERROR = (1 << 0), /* Data link layer error */
148         UFSHCD_UIC_DL_NAC_RECEIVED_ERROR = (1 << 1), /* Data link layer error */
149         UFSHCD_UIC_DL_TCx_REPLAY_ERROR = (1 << 2), /* Data link layer error */
150         UFSHCD_UIC_NL_ERROR = (1 << 3), /* Network layer error */
151         UFSHCD_UIC_TL_ERROR = (1 << 4), /* Transport Layer error */
152         UFSHCD_UIC_DME_ERROR = (1 << 5), /* DME error */
153 };
154
155 #define ufshcd_set_eh_in_progress(h) \
156         ((h)->eh_flags |= UFSHCD_EH_IN_PROGRESS)
157 #define ufshcd_eh_in_progress(h) \
158         ((h)->eh_flags & UFSHCD_EH_IN_PROGRESS)
159 #define ufshcd_clear_eh_in_progress(h) \
160         ((h)->eh_flags &= ~UFSHCD_EH_IN_PROGRESS)
161
162 #define ufshcd_set_ufs_dev_active(h) \
163         ((h)->curr_dev_pwr_mode = UFS_ACTIVE_PWR_MODE)
164 #define ufshcd_set_ufs_dev_sleep(h) \
165         ((h)->curr_dev_pwr_mode = UFS_SLEEP_PWR_MODE)
166 #define ufshcd_set_ufs_dev_poweroff(h) \
167         ((h)->curr_dev_pwr_mode = UFS_POWERDOWN_PWR_MODE)
168 #define ufshcd_is_ufs_dev_active(h) \
169         ((h)->curr_dev_pwr_mode == UFS_ACTIVE_PWR_MODE)
170 #define ufshcd_is_ufs_dev_sleep(h) \
171         ((h)->curr_dev_pwr_mode == UFS_SLEEP_PWR_MODE)
172 #define ufshcd_is_ufs_dev_poweroff(h) \
173         ((h)->curr_dev_pwr_mode == UFS_POWERDOWN_PWR_MODE)
174
175 struct ufs_pm_lvl_states ufs_pm_lvl_states[] = {
176         {UFS_ACTIVE_PWR_MODE, UIC_LINK_ACTIVE_STATE},
177         {UFS_ACTIVE_PWR_MODE, UIC_LINK_HIBERN8_STATE},
178         {UFS_SLEEP_PWR_MODE, UIC_LINK_ACTIVE_STATE},
179         {UFS_SLEEP_PWR_MODE, UIC_LINK_HIBERN8_STATE},
180         {UFS_POWERDOWN_PWR_MODE, UIC_LINK_HIBERN8_STATE},
181         {UFS_POWERDOWN_PWR_MODE, UIC_LINK_OFF_STATE},
182 };
183
184 static inline enum ufs_dev_pwr_mode
185 ufs_get_pm_lvl_to_dev_pwr_mode(enum ufs_pm_level lvl)
186 {
187         return ufs_pm_lvl_states[lvl].dev_state;
188 }
189
190 static inline enum uic_link_state
191 ufs_get_pm_lvl_to_link_pwr_state(enum ufs_pm_level lvl)
192 {
193         return ufs_pm_lvl_states[lvl].link_state;
194 }
195
196 static inline enum ufs_pm_level
197 ufs_get_desired_pm_lvl_for_dev_link_state(enum ufs_dev_pwr_mode dev_state,
198                                         enum uic_link_state link_state)
199 {
200         enum ufs_pm_level lvl;
201
202         for (lvl = UFS_PM_LVL_0; lvl < UFS_PM_LVL_MAX; lvl++) {
203                 if ((ufs_pm_lvl_states[lvl].dev_state == dev_state) &&
204                         (ufs_pm_lvl_states[lvl].link_state == link_state))
205                         return lvl;
206         }
207
208         /* if no match found, return the level 0 */
209         return UFS_PM_LVL_0;
210 }
211
212 static struct ufs_dev_fix ufs_fixups[] = {
213         /* UFS cards deviations table */
214         UFS_FIX(UFS_VENDOR_SAMSUNG, UFS_ANY_MODEL,
215                 UFS_DEVICE_QUIRK_DELAY_BEFORE_LPM),
216         UFS_FIX(UFS_VENDOR_SAMSUNG, UFS_ANY_MODEL,
217                 UFS_DEVICE_QUIRK_RECOVERY_FROM_DL_NAC_ERRORS),
218         UFS_FIX(UFS_VENDOR_SAMSUNG, UFS_ANY_MODEL,
219                 UFS_DEVICE_QUIRK_HOST_PA_TACTIVATE),
220         UFS_FIX(UFS_VENDOR_TOSHIBA, UFS_ANY_MODEL,
221                 UFS_DEVICE_QUIRK_DELAY_BEFORE_LPM),
222         UFS_FIX(UFS_VENDOR_TOSHIBA, "THGLF2G9C8KBADG",
223                 UFS_DEVICE_QUIRK_PA_TACTIVATE),
224         UFS_FIX(UFS_VENDOR_TOSHIBA, "THGLF2G9D8KBADG",
225                 UFS_DEVICE_QUIRK_PA_TACTIVATE),
226         UFS_FIX(UFS_VENDOR_SKHYNIX, UFS_ANY_MODEL,
227                 UFS_DEVICE_QUIRK_HOST_PA_SAVECONFIGTIME),
228         UFS_FIX(UFS_VENDOR_SKHYNIX, "hB8aL1" /*H28U62301AMR*/,
229                 UFS_DEVICE_QUIRK_HOST_VS_DEBUGSAVECONFIGTIME),
230
231         END_FIX
232 };
233
234 static void ufshcd_tmc_handler(struct ufs_hba *hba);
235 static void ufshcd_async_scan(void *data, async_cookie_t cookie);
236 static int ufshcd_reset_and_restore(struct ufs_hba *hba);
237 static int ufshcd_eh_host_reset_handler(struct scsi_cmnd *cmd);
238 static int ufshcd_clear_tm_cmd(struct ufs_hba *hba, int tag);
239 static void ufshcd_hba_exit(struct ufs_hba *hba);
240 static int ufshcd_probe_hba(struct ufs_hba *hba);
241 static int __ufshcd_setup_clocks(struct ufs_hba *hba, bool on,
242                                  bool skip_ref_clk);
243 static int ufshcd_setup_clocks(struct ufs_hba *hba, bool on);
244 static int ufshcd_uic_hibern8_exit(struct ufs_hba *hba);
245 static int ufshcd_uic_hibern8_enter(struct ufs_hba *hba);
246 static inline void ufshcd_add_delay_before_dme_cmd(struct ufs_hba *hba);
247 static int ufshcd_host_reset_and_restore(struct ufs_hba *hba);
248 static void ufshcd_resume_clkscaling(struct ufs_hba *hba);
249 static void ufshcd_suspend_clkscaling(struct ufs_hba *hba);
250 static void __ufshcd_suspend_clkscaling(struct ufs_hba *hba);
251 static int ufshcd_scale_clks(struct ufs_hba *hba, bool scale_up);
252 static irqreturn_t ufshcd_intr(int irq, void *__hba);
253 static int ufshcd_change_power_mode(struct ufs_hba *hba,
254                              struct ufs_pa_layer_attr *pwr_mode);
255 static inline bool ufshcd_valid_tag(struct ufs_hba *hba, int tag)
256 {
257         return tag >= 0 && tag < hba->nutrs;
258 }
259
260 static inline int ufshcd_enable_irq(struct ufs_hba *hba)
261 {
262         int ret = 0;
263
264         if (!hba->is_irq_enabled) {
265                 ret = request_irq(hba->irq, ufshcd_intr, IRQF_SHARED, UFSHCD,
266                                 hba);
267                 if (ret)
268                         dev_err(hba->dev, "%s: request_irq failed, ret=%d\n",
269                                 __func__, ret);
270                 hba->is_irq_enabled = true;
271         }
272
273         return ret;
274 }
275
276 static inline void ufshcd_disable_irq(struct ufs_hba *hba)
277 {
278         if (hba->is_irq_enabled) {
279                 free_irq(hba->irq, hba);
280                 hba->is_irq_enabled = false;
281         }
282 }
283
284 static void ufshcd_scsi_unblock_requests(struct ufs_hba *hba)
285 {
286         if (atomic_dec_and_test(&hba->scsi_block_reqs_cnt))
287                 scsi_unblock_requests(hba->host);
288 }
289
290 static void ufshcd_scsi_block_requests(struct ufs_hba *hba)
291 {
292         if (atomic_inc_return(&hba->scsi_block_reqs_cnt) == 1)
293                 scsi_block_requests(hba->host);
294 }
295
296 /* replace non-printable or non-ASCII characters with spaces */
297 static inline void ufshcd_remove_non_printable(char *val)
298 {
299         if (!val)
300                 return;
301
302         if (*val < 0x20 || *val > 0x7e)
303                 *val = ' ';
304 }
305
306 static void ufshcd_add_cmd_upiu_trace(struct ufs_hba *hba, unsigned int tag,
307                 const char *str)
308 {
309         struct utp_upiu_req *rq = hba->lrb[tag].ucd_req_ptr;
310
311         trace_ufshcd_upiu(dev_name(hba->dev), str, &rq->header, &rq->sc.cdb);
312 }
313
314 static void ufshcd_add_query_upiu_trace(struct ufs_hba *hba, unsigned int tag,
315                 const char *str)
316 {
317         struct utp_upiu_req *rq = hba->lrb[tag].ucd_req_ptr;
318
319         trace_ufshcd_upiu(dev_name(hba->dev), str, &rq->header, &rq->qr);
320 }
321
322 static void ufshcd_add_tm_upiu_trace(struct ufs_hba *hba, unsigned int tag,
323                 const char *str)
324 {
325         int off = (int)tag - hba->nutrs;
326         struct utp_task_req_desc *descp = &hba->utmrdl_base_addr[off];
327
328         trace_ufshcd_upiu(dev_name(hba->dev), str, &descp->req_header,
329                         &descp->input_param1);
330 }
331
332 static void ufshcd_add_command_trace(struct ufs_hba *hba,
333                 unsigned int tag, const char *str)
334 {
335         sector_t lba = -1;
336         u8 opcode = 0;
337         u32 intr, doorbell;
338         struct ufshcd_lrb *lrbp = &hba->lrb[tag];
339         int transfer_len = -1;
340
341         if (!trace_ufshcd_command_enabled()) {
342                 /* trace UPIU W/O tracing command */
343                 if (lrbp->cmd)
344                         ufshcd_add_cmd_upiu_trace(hba, tag, str);
345                 return;
346         }
347
348         if (lrbp->cmd) { /* data phase exists */
349                 /* trace UPIU also */
350                 ufshcd_add_cmd_upiu_trace(hba, tag, str);
351                 opcode = (u8)(*lrbp->cmd->cmnd);
352                 if ((opcode == READ_10) || (opcode == WRITE_10)) {
353                         /*
354                          * Currently we only fully trace read(10) and write(10)
355                          * commands
356                          */
357                         if (lrbp->cmd->request && lrbp->cmd->request->bio)
358                                 lba =
359                                   lrbp->cmd->request->bio->bi_iter.bi_sector;
360                         transfer_len = be32_to_cpu(
361                                 lrbp->ucd_req_ptr->sc.exp_data_transfer_len);
362                 }
363         }
364
365         intr = ufshcd_readl(hba, REG_INTERRUPT_STATUS);
366         doorbell = ufshcd_readl(hba, REG_UTP_TRANSFER_REQ_DOOR_BELL);
367         trace_ufshcd_command(dev_name(hba->dev), str, tag,
368                                 doorbell, transfer_len, intr, lba, opcode);
369 }
370
371 static void ufshcd_print_clk_freqs(struct ufs_hba *hba)
372 {
373         struct ufs_clk_info *clki;
374         struct list_head *head = &hba->clk_list_head;
375
376         if (list_empty(head))
377                 return;
378
379         list_for_each_entry(clki, head, list) {
380                 if (!IS_ERR_OR_NULL(clki->clk) && clki->min_freq &&
381                                 clki->max_freq)
382                         dev_err(hba->dev, "clk: %s, rate: %u\n",
383                                         clki->name, clki->curr_freq);
384         }
385 }
386
387 static void ufshcd_print_uic_err_hist(struct ufs_hba *hba,
388                 struct ufs_uic_err_reg_hist *err_hist, char *err_name)
389 {
390         int i;
391         bool found = false;
392
393         for (i = 0; i < UIC_ERR_REG_HIST_LENGTH; i++) {
394                 int p = (i + err_hist->pos) % UIC_ERR_REG_HIST_LENGTH;
395
396                 if (err_hist->reg[p] == 0)
397                         continue;
398                 dev_err(hba->dev, "%s[%d] = 0x%x at %lld us\n", err_name, i,
399                         err_hist->reg[p], ktime_to_us(err_hist->tstamp[p]));
400                 found = true;
401         }
402
403         if (!found)
404                 dev_err(hba->dev, "No record of %s uic errors\n", err_name);
405 }
406
407 static void ufshcd_print_host_regs(struct ufs_hba *hba)
408 {
409         ufshcd_dump_regs(hba, 0, UFSHCI_REG_SPACE_SIZE, "host_regs: ");
410         dev_err(hba->dev, "hba->ufs_version = 0x%x, hba->capabilities = 0x%x\n",
411                 hba->ufs_version, hba->capabilities);
412         dev_err(hba->dev,
413                 "hba->outstanding_reqs = 0x%x, hba->outstanding_tasks = 0x%x\n",
414                 (u32)hba->outstanding_reqs, (u32)hba->outstanding_tasks);
415         dev_err(hba->dev,
416                 "last_hibern8_exit_tstamp at %lld us, hibern8_exit_cnt = %d\n",
417                 ktime_to_us(hba->ufs_stats.last_hibern8_exit_tstamp),
418                 hba->ufs_stats.hibern8_exit_cnt);
419
420         ufshcd_print_uic_err_hist(hba, &hba->ufs_stats.pa_err, "pa_err");
421         ufshcd_print_uic_err_hist(hba, &hba->ufs_stats.dl_err, "dl_err");
422         ufshcd_print_uic_err_hist(hba, &hba->ufs_stats.nl_err, "nl_err");
423         ufshcd_print_uic_err_hist(hba, &hba->ufs_stats.tl_err, "tl_err");
424         ufshcd_print_uic_err_hist(hba, &hba->ufs_stats.dme_err, "dme_err");
425
426         ufshcd_print_clk_freqs(hba);
427
428         if (hba->vops && hba->vops->dbg_register_dump)
429                 hba->vops->dbg_register_dump(hba);
430 }
431
432 static
433 void ufshcd_print_trs(struct ufs_hba *hba, unsigned long bitmap, bool pr_prdt)
434 {
435         struct ufshcd_lrb *lrbp;
436         int prdt_length;
437         int tag;
438
439         for_each_set_bit(tag, &bitmap, hba->nutrs) {
440                 lrbp = &hba->lrb[tag];
441
442                 dev_err(hba->dev, "UPIU[%d] - issue time %lld us\n",
443                                 tag, ktime_to_us(lrbp->issue_time_stamp));
444                 dev_err(hba->dev, "UPIU[%d] - complete time %lld us\n",
445                                 tag, ktime_to_us(lrbp->compl_time_stamp));
446                 dev_err(hba->dev,
447                         "UPIU[%d] - Transfer Request Descriptor phys@0x%llx\n",
448                         tag, (u64)lrbp->utrd_dma_addr);
449
450                 ufshcd_hex_dump("UPIU TRD: ", lrbp->utr_descriptor_ptr,
451                                 sizeof(struct utp_transfer_req_desc));
452                 dev_err(hba->dev, "UPIU[%d] - Request UPIU phys@0x%llx\n", tag,
453                         (u64)lrbp->ucd_req_dma_addr);
454                 ufshcd_hex_dump("UPIU REQ: ", lrbp->ucd_req_ptr,
455                                 sizeof(struct utp_upiu_req));
456                 dev_err(hba->dev, "UPIU[%d] - Response UPIU phys@0x%llx\n", tag,
457                         (u64)lrbp->ucd_rsp_dma_addr);
458                 ufshcd_hex_dump("UPIU RSP: ", lrbp->ucd_rsp_ptr,
459                                 sizeof(struct utp_upiu_rsp));
460
461                 prdt_length = le16_to_cpu(
462                         lrbp->utr_descriptor_ptr->prd_table_length);
463                 dev_err(hba->dev,
464                         "UPIU[%d] - PRDT - %d entries  phys@0x%llx\n",
465                         tag, prdt_length,
466                         (u64)lrbp->ucd_prdt_dma_addr);
467
468                 if (pr_prdt)
469                         ufshcd_hex_dump("UPIU PRDT: ", lrbp->ucd_prdt_ptr,
470                                 sizeof(struct ufshcd_sg_entry) * prdt_length);
471         }
472 }
473
474 static void ufshcd_print_tmrs(struct ufs_hba *hba, unsigned long bitmap)
475 {
476         int tag;
477
478         for_each_set_bit(tag, &bitmap, hba->nutmrs) {
479                 struct utp_task_req_desc *tmrdp = &hba->utmrdl_base_addr[tag];
480
481                 dev_err(hba->dev, "TM[%d] - Task Management Header\n", tag);
482                 ufshcd_hex_dump("", tmrdp, sizeof(*tmrdp));
483         }
484 }
485
486 static void ufshcd_print_host_state(struct ufs_hba *hba)
487 {
488         dev_err(hba->dev, "UFS Host state=%d\n", hba->ufshcd_state);
489         dev_err(hba->dev, "lrb in use=0x%lx, outstanding reqs=0x%lx tasks=0x%lx\n",
490                 hba->lrb_in_use, hba->outstanding_reqs, hba->outstanding_tasks);
491         dev_err(hba->dev, "saved_err=0x%x, saved_uic_err=0x%x\n",
492                 hba->saved_err, hba->saved_uic_err);
493         dev_err(hba->dev, "Device power mode=%d, UIC link state=%d\n",
494                 hba->curr_dev_pwr_mode, hba->uic_link_state);
495         dev_err(hba->dev, "PM in progress=%d, sys. suspended=%d\n",
496                 hba->pm_op_in_progress, hba->is_sys_suspended);
497         dev_err(hba->dev, "Auto BKOPS=%d, Host self-block=%d\n",
498                 hba->auto_bkops_enabled, hba->host->host_self_blocked);
499         dev_err(hba->dev, "Clk gate=%d\n", hba->clk_gating.state);
500         dev_err(hba->dev, "error handling flags=0x%x, req. abort count=%d\n",
501                 hba->eh_flags, hba->req_abort_count);
502         dev_err(hba->dev, "Host capabilities=0x%x, caps=0x%x\n",
503                 hba->capabilities, hba->caps);
504         dev_err(hba->dev, "quirks=0x%x, dev. quirks=0x%x\n", hba->quirks,
505                 hba->dev_quirks);
506 }
507
508 /**
509  * ufshcd_print_pwr_info - print power params as saved in hba
510  * power info
511  * @hba: per-adapter instance
512  */
513 static void ufshcd_print_pwr_info(struct ufs_hba *hba)
514 {
515         static const char * const names[] = {
516                 "INVALID MODE",
517                 "FAST MODE",
518                 "SLOW_MODE",
519                 "INVALID MODE",
520                 "FASTAUTO_MODE",
521                 "SLOWAUTO_MODE",
522                 "INVALID MODE",
523         };
524
525         dev_err(hba->dev, "%s:[RX, TX]: gear=[%d, %d], lane[%d, %d], pwr[%s, %s], rate = %d\n",
526                  __func__,
527                  hba->pwr_info.gear_rx, hba->pwr_info.gear_tx,
528                  hba->pwr_info.lane_rx, hba->pwr_info.lane_tx,
529                  names[hba->pwr_info.pwr_rx],
530                  names[hba->pwr_info.pwr_tx],
531                  hba->pwr_info.hs_rate);
532 }
533
534 /*
535  * ufshcd_wait_for_register - wait for register value to change
536  * @hba - per-adapter interface
537  * @reg - mmio register offset
538  * @mask - mask to apply to read register value
539  * @val - wait condition
540  * @interval_us - polling interval in microsecs
541  * @timeout_ms - timeout in millisecs
542  * @can_sleep - perform sleep or just spin
543  *
544  * Returns -ETIMEDOUT on error, zero on success
545  */
546 int ufshcd_wait_for_register(struct ufs_hba *hba, u32 reg, u32 mask,
547                                 u32 val, unsigned long interval_us,
548                                 unsigned long timeout_ms, bool can_sleep)
549 {
550         int err = 0;
551         unsigned long timeout = jiffies + msecs_to_jiffies(timeout_ms);
552
553         /* ignore bits that we don't intend to wait on */
554         val = val & mask;
555
556         while ((ufshcd_readl(hba, reg) & mask) != val) {
557                 if (can_sleep)
558                         usleep_range(interval_us, interval_us + 50);
559                 else
560                         udelay(interval_us);
561                 if (time_after(jiffies, timeout)) {
562                         if ((ufshcd_readl(hba, reg) & mask) != val)
563                                 err = -ETIMEDOUT;
564                         break;
565                 }
566         }
567
568         return err;
569 }
570
571 /**
572  * ufshcd_get_intr_mask - Get the interrupt bit mask
573  * @hba: Pointer to adapter instance
574  *
575  * Returns interrupt bit mask per version
576  */
577 static inline u32 ufshcd_get_intr_mask(struct ufs_hba *hba)
578 {
579         u32 intr_mask = 0;
580
581         switch (hba->ufs_version) {
582         case UFSHCI_VERSION_10:
583                 intr_mask = INTERRUPT_MASK_ALL_VER_10;
584                 break;
585         case UFSHCI_VERSION_11:
586         case UFSHCI_VERSION_20:
587                 intr_mask = INTERRUPT_MASK_ALL_VER_11;
588                 break;
589         case UFSHCI_VERSION_21:
590         default:
591                 intr_mask = INTERRUPT_MASK_ALL_VER_21;
592                 break;
593         }
594
595         return intr_mask;
596 }
597
598 /**
599  * ufshcd_get_ufs_version - Get the UFS version supported by the HBA
600  * @hba: Pointer to adapter instance
601  *
602  * Returns UFSHCI version supported by the controller
603  */
604 static inline u32 ufshcd_get_ufs_version(struct ufs_hba *hba)
605 {
606         if (hba->quirks & UFSHCD_QUIRK_BROKEN_UFS_HCI_VERSION)
607                 return ufshcd_vops_get_ufs_hci_version(hba);
608
609         return ufshcd_readl(hba, REG_UFS_VERSION);
610 }
611
612 /**
613  * ufshcd_is_device_present - Check if any device connected to
614  *                            the host controller
615  * @hba: pointer to adapter instance
616  *
617  * Returns true if device present, false if no device detected
618  */
619 static inline bool ufshcd_is_device_present(struct ufs_hba *hba)
620 {
621         return (ufshcd_readl(hba, REG_CONTROLLER_STATUS) &
622                                                 DEVICE_PRESENT) ? true : false;
623 }
624
625 /**
626  * ufshcd_get_tr_ocs - Get the UTRD Overall Command Status
627  * @lrbp: pointer to local command reference block
628  *
629  * This function is used to get the OCS field from UTRD
630  * Returns the OCS field in the UTRD
631  */
632 static inline int ufshcd_get_tr_ocs(struct ufshcd_lrb *lrbp)
633 {
634         return le32_to_cpu(lrbp->utr_descriptor_ptr->header.dword_2) & MASK_OCS;
635 }
636
637 /**
638  * ufshcd_get_tm_free_slot - get a free slot for task management request
639  * @hba: per adapter instance
640  * @free_slot: pointer to variable with available slot value
641  *
642  * Get a free tag and lock it until ufshcd_put_tm_slot() is called.
643  * Returns 0 if free slot is not available, else return 1 with tag value
644  * in @free_slot.
645  */
646 static bool ufshcd_get_tm_free_slot(struct ufs_hba *hba, int *free_slot)
647 {
648         int tag;
649         bool ret = false;
650
651         if (!free_slot)
652                 goto out;
653
654         do {
655                 tag = find_first_zero_bit(&hba->tm_slots_in_use, hba->nutmrs);
656                 if (tag >= hba->nutmrs)
657                         goto out;
658         } while (test_and_set_bit_lock(tag, &hba->tm_slots_in_use));
659
660         *free_slot = tag;
661         ret = true;
662 out:
663         return ret;
664 }
665
666 static inline void ufshcd_put_tm_slot(struct ufs_hba *hba, int slot)
667 {
668         clear_bit_unlock(slot, &hba->tm_slots_in_use);
669 }
670
671 /**
672  * ufshcd_utrl_clear - Clear a bit in UTRLCLR register
673  * @hba: per adapter instance
674  * @pos: position of the bit to be cleared
675  */
676 static inline void ufshcd_utrl_clear(struct ufs_hba *hba, u32 pos)
677 {
678         if (hba->quirks & UFSHCI_QUIRK_BROKEN_REQ_LIST_CLR)
679                 ufshcd_writel(hba, (1 << pos), REG_UTP_TRANSFER_REQ_LIST_CLEAR);
680         else
681                 ufshcd_writel(hba, ~(1 << pos),
682                                 REG_UTP_TRANSFER_REQ_LIST_CLEAR);
683 }
684
685 /**
686  * ufshcd_utmrl_clear - Clear a bit in UTRMLCLR register
687  * @hba: per adapter instance
688  * @pos: position of the bit to be cleared
689  */
690 static inline void ufshcd_utmrl_clear(struct ufs_hba *hba, u32 pos)
691 {
692         if (hba->quirks & UFSHCI_QUIRK_BROKEN_REQ_LIST_CLR)
693                 ufshcd_writel(hba, (1 << pos), REG_UTP_TASK_REQ_LIST_CLEAR);
694         else
695                 ufshcd_writel(hba, ~(1 << pos), REG_UTP_TASK_REQ_LIST_CLEAR);
696 }
697
698 /**
699  * ufshcd_outstanding_req_clear - Clear a bit in outstanding request field
700  * @hba: per adapter instance
701  * @tag: position of the bit to be cleared
702  */
703 static inline void ufshcd_outstanding_req_clear(struct ufs_hba *hba, int tag)
704 {
705         __clear_bit(tag, &hba->outstanding_reqs);
706 }
707
708 /**
709  * ufshcd_get_lists_status - Check UCRDY, UTRLRDY and UTMRLRDY
710  * @reg: Register value of host controller status
711  *
712  * Returns integer, 0 on Success and positive value if failed
713  */
714 static inline int ufshcd_get_lists_status(u32 reg)
715 {
716         return !((reg & UFSHCD_STATUS_READY) == UFSHCD_STATUS_READY);
717 }
718
719 /**
720  * ufshcd_get_uic_cmd_result - Get the UIC command result
721  * @hba: Pointer to adapter instance
722  *
723  * This function gets the result of UIC command completion
724  * Returns 0 on success, non zero value on error
725  */
726 static inline int ufshcd_get_uic_cmd_result(struct ufs_hba *hba)
727 {
728         return ufshcd_readl(hba, REG_UIC_COMMAND_ARG_2) &
729                MASK_UIC_COMMAND_RESULT;
730 }
731
732 /**
733  * ufshcd_get_dme_attr_val - Get the value of attribute returned by UIC command
734  * @hba: Pointer to adapter instance
735  *
736  * This function gets UIC command argument3
737  * Returns 0 on success, non zero value on error
738  */
739 static inline u32 ufshcd_get_dme_attr_val(struct ufs_hba *hba)
740 {
741         return ufshcd_readl(hba, REG_UIC_COMMAND_ARG_3);
742 }
743
744 /**
745  * ufshcd_get_req_rsp - returns the TR response transaction type
746  * @ucd_rsp_ptr: pointer to response UPIU
747  */
748 static inline int
749 ufshcd_get_req_rsp(struct utp_upiu_rsp *ucd_rsp_ptr)
750 {
751         return be32_to_cpu(ucd_rsp_ptr->header.dword_0) >> 24;
752 }
753
754 /**
755  * ufshcd_get_rsp_upiu_result - Get the result from response UPIU
756  * @ucd_rsp_ptr: pointer to response UPIU
757  *
758  * This function gets the response status and scsi_status from response UPIU
759  * Returns the response result code.
760  */
761 static inline int
762 ufshcd_get_rsp_upiu_result(struct utp_upiu_rsp *ucd_rsp_ptr)
763 {
764         return be32_to_cpu(ucd_rsp_ptr->header.dword_1) & MASK_RSP_UPIU_RESULT;
765 }
766
767 /*
768  * ufshcd_get_rsp_upiu_data_seg_len - Get the data segment length
769  *                              from response UPIU
770  * @ucd_rsp_ptr: pointer to response UPIU
771  *
772  * Return the data segment length.
773  */
774 static inline unsigned int
775 ufshcd_get_rsp_upiu_data_seg_len(struct utp_upiu_rsp *ucd_rsp_ptr)
776 {
777         return be32_to_cpu(ucd_rsp_ptr->header.dword_2) &
778                 MASK_RSP_UPIU_DATA_SEG_LEN;
779 }
780
781 /**
782  * ufshcd_is_exception_event - Check if the device raised an exception event
783  * @ucd_rsp_ptr: pointer to response UPIU
784  *
785  * The function checks if the device raised an exception event indicated in
786  * the Device Information field of response UPIU.
787  *
788  * Returns true if exception is raised, false otherwise.
789  */
790 static inline bool ufshcd_is_exception_event(struct utp_upiu_rsp *ucd_rsp_ptr)
791 {
792         return be32_to_cpu(ucd_rsp_ptr->header.dword_2) &
793                         MASK_RSP_EXCEPTION_EVENT ? true : false;
794 }
795
796 /**
797  * ufshcd_reset_intr_aggr - Reset interrupt aggregation values.
798  * @hba: per adapter instance
799  */
800 static inline void
801 ufshcd_reset_intr_aggr(struct ufs_hba *hba)
802 {
803         ufshcd_writel(hba, INT_AGGR_ENABLE |
804                       INT_AGGR_COUNTER_AND_TIMER_RESET,
805                       REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL);
806 }
807
808 /**
809  * ufshcd_config_intr_aggr - Configure interrupt aggregation values.
810  * @hba: per adapter instance
811  * @cnt: Interrupt aggregation counter threshold
812  * @tmout: Interrupt aggregation timeout value
813  */
814 static inline void
815 ufshcd_config_intr_aggr(struct ufs_hba *hba, u8 cnt, u8 tmout)
816 {
817         ufshcd_writel(hba, INT_AGGR_ENABLE | INT_AGGR_PARAM_WRITE |
818                       INT_AGGR_COUNTER_THLD_VAL(cnt) |
819                       INT_AGGR_TIMEOUT_VAL(tmout),
820                       REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL);
821 }
822
823 /**
824  * ufshcd_disable_intr_aggr - Disables interrupt aggregation.
825  * @hba: per adapter instance
826  */
827 static inline void ufshcd_disable_intr_aggr(struct ufs_hba *hba)
828 {
829         ufshcd_writel(hba, 0, REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL);
830 }
831
832 /**
833  * ufshcd_enable_run_stop_reg - Enable run-stop registers,
834  *                      When run-stop registers are set to 1, it indicates the
835  *                      host controller that it can process the requests
836  * @hba: per adapter instance
837  */
838 static void ufshcd_enable_run_stop_reg(struct ufs_hba *hba)
839 {
840         ufshcd_writel(hba, UTP_TASK_REQ_LIST_RUN_STOP_BIT,
841                       REG_UTP_TASK_REQ_LIST_RUN_STOP);
842         ufshcd_writel(hba, UTP_TRANSFER_REQ_LIST_RUN_STOP_BIT,
843                       REG_UTP_TRANSFER_REQ_LIST_RUN_STOP);
844 }
845
846 /**
847  * ufshcd_hba_start - Start controller initialization sequence
848  * @hba: per adapter instance
849  */
850 static inline void ufshcd_hba_start(struct ufs_hba *hba)
851 {
852         ufshcd_writel(hba, CONTROLLER_ENABLE, REG_CONTROLLER_ENABLE);
853 }
854
855 /**
856  * ufshcd_is_hba_active - Get controller state
857  * @hba: per adapter instance
858  *
859  * Returns false if controller is active, true otherwise
860  */
861 static inline bool ufshcd_is_hba_active(struct ufs_hba *hba)
862 {
863         return (ufshcd_readl(hba, REG_CONTROLLER_ENABLE) & CONTROLLER_ENABLE)
864                 ? false : true;
865 }
866
867 u32 ufshcd_get_local_unipro_ver(struct ufs_hba *hba)
868 {
869         /* HCI version 1.0 and 1.1 supports UniPro 1.41 */
870         if ((hba->ufs_version == UFSHCI_VERSION_10) ||
871             (hba->ufs_version == UFSHCI_VERSION_11))
872                 return UFS_UNIPRO_VER_1_41;
873         else
874                 return UFS_UNIPRO_VER_1_6;
875 }
876 EXPORT_SYMBOL(ufshcd_get_local_unipro_ver);
877
878 static bool ufshcd_is_unipro_pa_params_tuning_req(struct ufs_hba *hba)
879 {
880         /*
881          * If both host and device support UniPro ver1.6 or later, PA layer
882          * parameters tuning happens during link startup itself.
883          *
884          * We can manually tune PA layer parameters if either host or device
885          * doesn't support UniPro ver 1.6 or later. But to keep manual tuning
886          * logic simple, we will only do manual tuning if local unipro version
887          * doesn't support ver1.6 or later.
888          */
889         if (ufshcd_get_local_unipro_ver(hba) < UFS_UNIPRO_VER_1_6)
890                 return true;
891         else
892                 return false;
893 }
894
895 static int ufshcd_scale_clks(struct ufs_hba *hba, bool scale_up)
896 {
897         int ret = 0;
898         struct ufs_clk_info *clki;
899         struct list_head *head = &hba->clk_list_head;
900         ktime_t start = ktime_get();
901         bool clk_state_changed = false;
902
903         if (list_empty(head))
904                 goto out;
905
906         ret = ufshcd_vops_clk_scale_notify(hba, scale_up, PRE_CHANGE);
907         if (ret)
908                 return ret;
909
910         list_for_each_entry(clki, head, list) {
911                 if (!IS_ERR_OR_NULL(clki->clk)) {
912                         if (scale_up && clki->max_freq) {
913                                 if (clki->curr_freq == clki->max_freq)
914                                         continue;
915
916                                 clk_state_changed = true;
917                                 ret = clk_set_rate(clki->clk, clki->max_freq);
918                                 if (ret) {
919                                         dev_err(hba->dev, "%s: %s clk set rate(%dHz) failed, %d\n",
920                                                 __func__, clki->name,
921                                                 clki->max_freq, ret);
922                                         break;
923                                 }
924                                 trace_ufshcd_clk_scaling(dev_name(hba->dev),
925                                                 "scaled up", clki->name,
926                                                 clki->curr_freq,
927                                                 clki->max_freq);
928
929                                 clki->curr_freq = clki->max_freq;
930
931                         } else if (!scale_up && clki->min_freq) {
932                                 if (clki->curr_freq == clki->min_freq)
933                                         continue;
934
935                                 clk_state_changed = true;
936                                 ret = clk_set_rate(clki->clk, clki->min_freq);
937                                 if (ret) {
938                                         dev_err(hba->dev, "%s: %s clk set rate(%dHz) failed, %d\n",
939                                                 __func__, clki->name,
940                                                 clki->min_freq, ret);
941                                         break;
942                                 }
943                                 trace_ufshcd_clk_scaling(dev_name(hba->dev),
944                                                 "scaled down", clki->name,
945                                                 clki->curr_freq,
946                                                 clki->min_freq);
947                                 clki->curr_freq = clki->min_freq;
948                         }
949                 }
950                 dev_dbg(hba->dev, "%s: clk: %s, rate: %lu\n", __func__,
951                                 clki->name, clk_get_rate(clki->clk));
952         }
953
954         ret = ufshcd_vops_clk_scale_notify(hba, scale_up, POST_CHANGE);
955
956 out:
957         if (clk_state_changed)
958                 trace_ufshcd_profile_clk_scaling(dev_name(hba->dev),
959                         (scale_up ? "up" : "down"),
960                         ktime_to_us(ktime_sub(ktime_get(), start)), ret);
961         return ret;
962 }
963
964 /**
965  * ufshcd_is_devfreq_scaling_required - check if scaling is required or not
966  * @hba: per adapter instance
967  * @scale_up: True if scaling up and false if scaling down
968  *
969  * Returns true if scaling is required, false otherwise.
970  */
971 static bool ufshcd_is_devfreq_scaling_required(struct ufs_hba *hba,
972                                                bool scale_up)
973 {
974         struct ufs_clk_info *clki;
975         struct list_head *head = &hba->clk_list_head;
976
977         if (list_empty(head))
978                 return false;
979
980         list_for_each_entry(clki, head, list) {
981                 if (!IS_ERR_OR_NULL(clki->clk)) {
982                         if (scale_up && clki->max_freq) {
983                                 if (clki->curr_freq == clki->max_freq)
984                                         continue;
985                                 return true;
986                         } else if (!scale_up && clki->min_freq) {
987                                 if (clki->curr_freq == clki->min_freq)
988                                         continue;
989                                 return true;
990                         }
991                 }
992         }
993
994         return false;
995 }
996
997 static int ufshcd_wait_for_doorbell_clr(struct ufs_hba *hba,
998                                         u64 wait_timeout_us)
999 {
1000         unsigned long flags;
1001         int ret = 0;
1002         u32 tm_doorbell;
1003         u32 tr_doorbell;
1004         bool timeout = false, do_last_check = false;
1005         ktime_t start;
1006
1007         ufshcd_hold(hba, false);
1008         spin_lock_irqsave(hba->host->host_lock, flags);
1009         /*
1010          * Wait for all the outstanding tasks/transfer requests.
1011          * Verify by checking the doorbell registers are clear.
1012          */
1013         start = ktime_get();
1014         do {
1015                 if (hba->ufshcd_state != UFSHCD_STATE_OPERATIONAL) {
1016                         ret = -EBUSY;
1017                         goto out;
1018                 }
1019
1020                 tm_doorbell = ufshcd_readl(hba, REG_UTP_TASK_REQ_DOOR_BELL);
1021                 tr_doorbell = ufshcd_readl(hba, REG_UTP_TRANSFER_REQ_DOOR_BELL);
1022                 if (!tm_doorbell && !tr_doorbell) {
1023                         timeout = false;
1024                         break;
1025                 } else if (do_last_check) {
1026                         break;
1027                 }
1028
1029                 spin_unlock_irqrestore(hba->host->host_lock, flags);
1030                 schedule();
1031                 if (ktime_to_us(ktime_sub(ktime_get(), start)) >
1032                     wait_timeout_us) {
1033                         timeout = true;
1034                         /*
1035                          * We might have scheduled out for long time so make
1036                          * sure to check if doorbells are cleared by this time
1037                          * or not.
1038                          */
1039                         do_last_check = true;
1040                 }
1041                 spin_lock_irqsave(hba->host->host_lock, flags);
1042         } while (tm_doorbell || tr_doorbell);
1043
1044         if (timeout) {
1045                 dev_err(hba->dev,
1046                         "%s: timedout waiting for doorbell to clear (tm=0x%x, tr=0x%x)\n",
1047                         __func__, tm_doorbell, tr_doorbell);
1048                 ret = -EBUSY;
1049         }
1050 out:
1051         spin_unlock_irqrestore(hba->host->host_lock, flags);
1052         ufshcd_release(hba);
1053         return ret;
1054 }
1055
1056 /**
1057  * ufshcd_scale_gear - scale up/down UFS gear
1058  * @hba: per adapter instance
1059  * @scale_up: True for scaling up gear and false for scaling down
1060  *
1061  * Returns 0 for success,
1062  * Returns -EBUSY if scaling can't happen at this time
1063  * Returns non-zero for any other errors
1064  */
1065 static int ufshcd_scale_gear(struct ufs_hba *hba, bool scale_up)
1066 {
1067         #define UFS_MIN_GEAR_TO_SCALE_DOWN      UFS_HS_G1
1068         int ret = 0;
1069         struct ufs_pa_layer_attr new_pwr_info;
1070
1071         if (scale_up) {
1072                 memcpy(&new_pwr_info, &hba->clk_scaling.saved_pwr_info.info,
1073                        sizeof(struct ufs_pa_layer_attr));
1074         } else {
1075                 memcpy(&new_pwr_info, &hba->pwr_info,
1076                        sizeof(struct ufs_pa_layer_attr));
1077
1078                 if (hba->pwr_info.gear_tx > UFS_MIN_GEAR_TO_SCALE_DOWN
1079                     || hba->pwr_info.gear_rx > UFS_MIN_GEAR_TO_SCALE_DOWN) {
1080                         /* save the current power mode */
1081                         memcpy(&hba->clk_scaling.saved_pwr_info.info,
1082                                 &hba->pwr_info,
1083                                 sizeof(struct ufs_pa_layer_attr));
1084
1085                         /* scale down gear */
1086                         new_pwr_info.gear_tx = UFS_MIN_GEAR_TO_SCALE_DOWN;
1087                         new_pwr_info.gear_rx = UFS_MIN_GEAR_TO_SCALE_DOWN;
1088                 }
1089         }
1090
1091         /* check if the power mode needs to be changed or not? */
1092         ret = ufshcd_change_power_mode(hba, &new_pwr_info);
1093
1094         if (ret)
1095                 dev_err(hba->dev, "%s: failed err %d, old gear: (tx %d rx %d), new gear: (tx %d rx %d)",
1096                         __func__, ret,
1097                         hba->pwr_info.gear_tx, hba->pwr_info.gear_rx,
1098                         new_pwr_info.gear_tx, new_pwr_info.gear_rx);
1099
1100         return ret;
1101 }
1102
1103 static int ufshcd_clock_scaling_prepare(struct ufs_hba *hba)
1104 {
1105         #define DOORBELL_CLR_TOUT_US            (1000 * 1000) /* 1 sec */
1106         int ret = 0;
1107         /*
1108          * make sure that there are no outstanding requests when
1109          * clock scaling is in progress
1110          */
1111         ufshcd_scsi_block_requests(hba);
1112         down_write(&hba->clk_scaling_lock);
1113         if (ufshcd_wait_for_doorbell_clr(hba, DOORBELL_CLR_TOUT_US)) {
1114                 ret = -EBUSY;
1115                 up_write(&hba->clk_scaling_lock);
1116                 ufshcd_scsi_unblock_requests(hba);
1117         }
1118
1119         return ret;
1120 }
1121
1122 static void ufshcd_clock_scaling_unprepare(struct ufs_hba *hba)
1123 {
1124         up_write(&hba->clk_scaling_lock);
1125         ufshcd_scsi_unblock_requests(hba);
1126 }
1127
1128 /**
1129  * ufshcd_devfreq_scale - scale up/down UFS clocks and gear
1130  * @hba: per adapter instance
1131  * @scale_up: True for scaling up and false for scalin down
1132  *
1133  * Returns 0 for success,
1134  * Returns -EBUSY if scaling can't happen at this time
1135  * Returns non-zero for any other errors
1136  */
1137 static int ufshcd_devfreq_scale(struct ufs_hba *hba, bool scale_up)
1138 {
1139         int ret = 0;
1140
1141         /* let's not get into low power until clock scaling is completed */
1142         ufshcd_hold(hba, false);
1143
1144         ret = ufshcd_clock_scaling_prepare(hba);
1145         if (ret)
1146                 return ret;
1147
1148         /* scale down the gear before scaling down clocks */
1149         if (!scale_up) {
1150                 ret = ufshcd_scale_gear(hba, false);
1151                 if (ret)
1152                         goto out;
1153         }
1154
1155         ret = ufshcd_scale_clks(hba, scale_up);
1156         if (ret) {
1157                 if (!scale_up)
1158                         ufshcd_scale_gear(hba, true);
1159                 goto out;
1160         }
1161
1162         /* scale up the gear after scaling up clocks */
1163         if (scale_up) {
1164                 ret = ufshcd_scale_gear(hba, true);
1165                 if (ret) {
1166                         ufshcd_scale_clks(hba, false);
1167                         goto out;
1168                 }
1169         }
1170
1171         ret = ufshcd_vops_clk_scale_notify(hba, scale_up, POST_CHANGE);
1172
1173 out:
1174         ufshcd_clock_scaling_unprepare(hba);
1175         ufshcd_release(hba);
1176         return ret;
1177 }
1178
1179 static void ufshcd_clk_scaling_suspend_work(struct work_struct *work)
1180 {
1181         struct ufs_hba *hba = container_of(work, struct ufs_hba,
1182                                            clk_scaling.suspend_work);
1183         unsigned long irq_flags;
1184
1185         spin_lock_irqsave(hba->host->host_lock, irq_flags);
1186         if (hba->clk_scaling.active_reqs || hba->clk_scaling.is_suspended) {
1187                 spin_unlock_irqrestore(hba->host->host_lock, irq_flags);
1188                 return;
1189         }
1190         hba->clk_scaling.is_suspended = true;
1191         spin_unlock_irqrestore(hba->host->host_lock, irq_flags);
1192
1193         __ufshcd_suspend_clkscaling(hba);
1194 }
1195
1196 static void ufshcd_clk_scaling_resume_work(struct work_struct *work)
1197 {
1198         struct ufs_hba *hba = container_of(work, struct ufs_hba,
1199                                            clk_scaling.resume_work);
1200         unsigned long irq_flags;
1201
1202         spin_lock_irqsave(hba->host->host_lock, irq_flags);
1203         if (!hba->clk_scaling.is_suspended) {
1204                 spin_unlock_irqrestore(hba->host->host_lock, irq_flags);
1205                 return;
1206         }
1207         hba->clk_scaling.is_suspended = false;
1208         spin_unlock_irqrestore(hba->host->host_lock, irq_flags);
1209
1210         devfreq_resume_device(hba->devfreq);
1211 }
1212
1213 static int ufshcd_devfreq_target(struct device *dev,
1214                                 unsigned long *freq, u32 flags)
1215 {
1216         int ret = 0;
1217         struct ufs_hba *hba = dev_get_drvdata(dev);
1218         ktime_t start;
1219         bool scale_up, sched_clk_scaling_suspend_work = false;
1220         struct list_head *clk_list = &hba->clk_list_head;
1221         struct ufs_clk_info *clki;
1222         unsigned long irq_flags;
1223
1224         if (!ufshcd_is_clkscaling_supported(hba))
1225                 return -EINVAL;
1226
1227         spin_lock_irqsave(hba->host->host_lock, irq_flags);
1228         if (ufshcd_eh_in_progress(hba)) {
1229                 spin_unlock_irqrestore(hba->host->host_lock, irq_flags);
1230                 return 0;
1231         }
1232
1233         if (!hba->clk_scaling.active_reqs)
1234                 sched_clk_scaling_suspend_work = true;
1235
1236         if (list_empty(clk_list)) {
1237                 spin_unlock_irqrestore(hba->host->host_lock, irq_flags);
1238                 goto out;
1239         }
1240
1241         clki = list_first_entry(&hba->clk_list_head, struct ufs_clk_info, list);
1242         scale_up = (*freq == clki->max_freq) ? true : false;
1243         if (!ufshcd_is_devfreq_scaling_required(hba, scale_up)) {
1244                 spin_unlock_irqrestore(hba->host->host_lock, irq_flags);
1245                 ret = 0;
1246                 goto out; /* no state change required */
1247         }
1248         spin_unlock_irqrestore(hba->host->host_lock, irq_flags);
1249
1250         start = ktime_get();
1251         ret = ufshcd_devfreq_scale(hba, scale_up);
1252
1253         trace_ufshcd_profile_clk_scaling(dev_name(hba->dev),
1254                 (scale_up ? "up" : "down"),
1255                 ktime_to_us(ktime_sub(ktime_get(), start)), ret);
1256
1257 out:
1258         if (sched_clk_scaling_suspend_work)
1259                 queue_work(hba->clk_scaling.workq,
1260                            &hba->clk_scaling.suspend_work);
1261
1262         return ret;
1263 }
1264
1265
1266 static int ufshcd_devfreq_get_dev_status(struct device *dev,
1267                 struct devfreq_dev_status *stat)
1268 {
1269         struct ufs_hba *hba = dev_get_drvdata(dev);
1270         struct ufs_clk_scaling *scaling = &hba->clk_scaling;
1271         unsigned long flags;
1272
1273         if (!ufshcd_is_clkscaling_supported(hba))
1274                 return -EINVAL;
1275
1276         memset(stat, 0, sizeof(*stat));
1277
1278         spin_lock_irqsave(hba->host->host_lock, flags);
1279         if (!scaling->window_start_t)
1280                 goto start_window;
1281
1282         if (scaling->is_busy_started)
1283                 scaling->tot_busy_t += ktime_to_us(ktime_sub(ktime_get(),
1284                                         scaling->busy_start_t));
1285
1286         stat->total_time = jiffies_to_usecs((long)jiffies -
1287                                 (long)scaling->window_start_t);
1288         stat->busy_time = scaling->tot_busy_t;
1289 start_window:
1290         scaling->window_start_t = jiffies;
1291         scaling->tot_busy_t = 0;
1292
1293         if (hba->outstanding_reqs) {
1294                 scaling->busy_start_t = ktime_get();
1295                 scaling->is_busy_started = true;
1296         } else {
1297                 scaling->busy_start_t = 0;
1298                 scaling->is_busy_started = false;
1299         }
1300         spin_unlock_irqrestore(hba->host->host_lock, flags);
1301         return 0;
1302 }
1303
1304 static struct devfreq_dev_profile ufs_devfreq_profile = {
1305         .polling_ms     = 100,
1306         .target         = ufshcd_devfreq_target,
1307         .get_dev_status = ufshcd_devfreq_get_dev_status,
1308 };
1309
1310 static int ufshcd_devfreq_init(struct ufs_hba *hba)
1311 {
1312         struct list_head *clk_list = &hba->clk_list_head;
1313         struct ufs_clk_info *clki;
1314         struct devfreq *devfreq;
1315         int ret;
1316
1317         /* Skip devfreq if we don't have any clocks in the list */
1318         if (list_empty(clk_list))
1319                 return 0;
1320
1321         clki = list_first_entry(clk_list, struct ufs_clk_info, list);
1322         dev_pm_opp_add(hba->dev, clki->min_freq, 0);
1323         dev_pm_opp_add(hba->dev, clki->max_freq, 0);
1324
1325         devfreq = devfreq_add_device(hba->dev,
1326                         &ufs_devfreq_profile,
1327                         DEVFREQ_GOV_SIMPLE_ONDEMAND,
1328                         NULL);
1329         if (IS_ERR(devfreq)) {
1330                 ret = PTR_ERR(devfreq);
1331                 dev_err(hba->dev, "Unable to register with devfreq %d\n", ret);
1332
1333                 dev_pm_opp_remove(hba->dev, clki->min_freq);
1334                 dev_pm_opp_remove(hba->dev, clki->max_freq);
1335                 return ret;
1336         }
1337
1338         hba->devfreq = devfreq;
1339
1340         return 0;
1341 }
1342
1343 static void ufshcd_devfreq_remove(struct ufs_hba *hba)
1344 {
1345         struct list_head *clk_list = &hba->clk_list_head;
1346         struct ufs_clk_info *clki;
1347
1348         if (!hba->devfreq)
1349                 return;
1350
1351         devfreq_remove_device(hba->devfreq);
1352         hba->devfreq = NULL;
1353
1354         clki = list_first_entry(clk_list, struct ufs_clk_info, list);
1355         dev_pm_opp_remove(hba->dev, clki->min_freq);
1356         dev_pm_opp_remove(hba->dev, clki->max_freq);
1357 }
1358
1359 static void __ufshcd_suspend_clkscaling(struct ufs_hba *hba)
1360 {
1361         unsigned long flags;
1362
1363         devfreq_suspend_device(hba->devfreq);
1364         spin_lock_irqsave(hba->host->host_lock, flags);
1365         hba->clk_scaling.window_start_t = 0;
1366         spin_unlock_irqrestore(hba->host->host_lock, flags);
1367 }
1368
1369 static void ufshcd_suspend_clkscaling(struct ufs_hba *hba)
1370 {
1371         unsigned long flags;
1372         bool suspend = false;
1373
1374         if (!ufshcd_is_clkscaling_supported(hba))
1375                 return;
1376
1377         spin_lock_irqsave(hba->host->host_lock, flags);
1378         if (!hba->clk_scaling.is_suspended) {
1379                 suspend = true;
1380                 hba->clk_scaling.is_suspended = true;
1381         }
1382         spin_unlock_irqrestore(hba->host->host_lock, flags);
1383
1384         if (suspend)
1385                 __ufshcd_suspend_clkscaling(hba);
1386 }
1387
1388 static void ufshcd_resume_clkscaling(struct ufs_hba *hba)
1389 {
1390         unsigned long flags;
1391         bool resume = false;
1392
1393         if (!ufshcd_is_clkscaling_supported(hba))
1394                 return;
1395
1396         spin_lock_irqsave(hba->host->host_lock, flags);
1397         if (hba->clk_scaling.is_suspended) {
1398                 resume = true;
1399                 hba->clk_scaling.is_suspended = false;
1400         }
1401         spin_unlock_irqrestore(hba->host->host_lock, flags);
1402
1403         if (resume)
1404                 devfreq_resume_device(hba->devfreq);
1405 }
1406
1407 static ssize_t ufshcd_clkscale_enable_show(struct device *dev,
1408                 struct device_attribute *attr, char *buf)
1409 {
1410         struct ufs_hba *hba = dev_get_drvdata(dev);
1411
1412         return snprintf(buf, PAGE_SIZE, "%d\n", hba->clk_scaling.is_allowed);
1413 }
1414
1415 static ssize_t ufshcd_clkscale_enable_store(struct device *dev,
1416                 struct device_attribute *attr, const char *buf, size_t count)
1417 {
1418         struct ufs_hba *hba = dev_get_drvdata(dev);
1419         u32 value;
1420         int err;
1421
1422         if (kstrtou32(buf, 0, &value))
1423                 return -EINVAL;
1424
1425         value = !!value;
1426         if (value == hba->clk_scaling.is_allowed)
1427                 goto out;
1428
1429         pm_runtime_get_sync(hba->dev);
1430         ufshcd_hold(hba, false);
1431
1432         cancel_work_sync(&hba->clk_scaling.suspend_work);
1433         cancel_work_sync(&hba->clk_scaling.resume_work);
1434
1435         hba->clk_scaling.is_allowed = value;
1436
1437         if (value) {
1438                 ufshcd_resume_clkscaling(hba);
1439         } else {
1440                 ufshcd_suspend_clkscaling(hba);
1441                 err = ufshcd_devfreq_scale(hba, true);
1442                 if (err)
1443                         dev_err(hba->dev, "%s: failed to scale clocks up %d\n",
1444                                         __func__, err);
1445         }
1446
1447         ufshcd_release(hba);
1448         pm_runtime_put_sync(hba->dev);
1449 out:
1450         return count;
1451 }
1452
1453 static void ufshcd_clkscaling_init_sysfs(struct ufs_hba *hba)
1454 {
1455         hba->clk_scaling.enable_attr.show = ufshcd_clkscale_enable_show;
1456         hba->clk_scaling.enable_attr.store = ufshcd_clkscale_enable_store;
1457         sysfs_attr_init(&hba->clk_scaling.enable_attr.attr);
1458         hba->clk_scaling.enable_attr.attr.name = "clkscale_enable";
1459         hba->clk_scaling.enable_attr.attr.mode = 0644;
1460         if (device_create_file(hba->dev, &hba->clk_scaling.enable_attr))
1461                 dev_err(hba->dev, "Failed to create sysfs for clkscale_enable\n");
1462 }
1463
1464 static void ufshcd_ungate_work(struct work_struct *work)
1465 {
1466         int ret;
1467         unsigned long flags;
1468         struct ufs_hba *hba = container_of(work, struct ufs_hba,
1469                         clk_gating.ungate_work);
1470
1471         cancel_delayed_work_sync(&hba->clk_gating.gate_work);
1472
1473         spin_lock_irqsave(hba->host->host_lock, flags);
1474         if (hba->clk_gating.state == CLKS_ON) {
1475                 spin_unlock_irqrestore(hba->host->host_lock, flags);
1476                 goto unblock_reqs;
1477         }
1478
1479         spin_unlock_irqrestore(hba->host->host_lock, flags);
1480         ufshcd_setup_clocks(hba, true);
1481
1482         /* Exit from hibern8 */
1483         if (ufshcd_can_hibern8_during_gating(hba)) {
1484                 /* Prevent gating in this path */
1485                 hba->clk_gating.is_suspended = true;
1486                 if (ufshcd_is_link_hibern8(hba)) {
1487                         ret = ufshcd_uic_hibern8_exit(hba);
1488                         if (ret)
1489                                 dev_err(hba->dev, "%s: hibern8 exit failed %d\n",
1490                                         __func__, ret);
1491                         else
1492                                 ufshcd_set_link_active(hba);
1493                 }
1494                 hba->clk_gating.is_suspended = false;
1495         }
1496 unblock_reqs:
1497         ufshcd_scsi_unblock_requests(hba);
1498 }
1499
1500 /**
1501  * ufshcd_hold - Enable clocks that were gated earlier due to ufshcd_release.
1502  * Also, exit from hibern8 mode and set the link as active.
1503  * @hba: per adapter instance
1504  * @async: This indicates whether caller should ungate clocks asynchronously.
1505  */
1506 int ufshcd_hold(struct ufs_hba *hba, bool async)
1507 {
1508         int rc = 0;
1509         unsigned long flags;
1510
1511         if (!ufshcd_is_clkgating_allowed(hba))
1512                 goto out;
1513         spin_lock_irqsave(hba->host->host_lock, flags);
1514         hba->clk_gating.active_reqs++;
1515
1516         if (ufshcd_eh_in_progress(hba)) {
1517                 spin_unlock_irqrestore(hba->host->host_lock, flags);
1518                 return 0;
1519         }
1520
1521 start:
1522         switch (hba->clk_gating.state) {
1523         case CLKS_ON:
1524                 /*
1525                  * Wait for the ungate work to complete if in progress.
1526                  * Though the clocks may be in ON state, the link could
1527                  * still be in hibner8 state if hibern8 is allowed
1528                  * during clock gating.
1529                  * Make sure we exit hibern8 state also in addition to
1530                  * clocks being ON.
1531                  */
1532                 if (ufshcd_can_hibern8_during_gating(hba) &&
1533                     ufshcd_is_link_hibern8(hba)) {
1534                         spin_unlock_irqrestore(hba->host->host_lock, flags);
1535                         flush_work(&hba->clk_gating.ungate_work);
1536                         spin_lock_irqsave(hba->host->host_lock, flags);
1537                         goto start;
1538                 }
1539                 break;
1540         case REQ_CLKS_OFF:
1541                 if (cancel_delayed_work(&hba->clk_gating.gate_work)) {
1542                         hba->clk_gating.state = CLKS_ON;
1543                         trace_ufshcd_clk_gating(dev_name(hba->dev),
1544                                                 hba->clk_gating.state);
1545                         break;
1546                 }
1547                 /*
1548                  * If we are here, it means gating work is either done or
1549                  * currently running. Hence, fall through to cancel gating
1550                  * work and to enable clocks.
1551                  */
1552                 /* fallthrough */
1553         case CLKS_OFF:
1554                 ufshcd_scsi_block_requests(hba);
1555                 hba->clk_gating.state = REQ_CLKS_ON;
1556                 trace_ufshcd_clk_gating(dev_name(hba->dev),
1557                                         hba->clk_gating.state);
1558                 queue_work(hba->clk_gating.clk_gating_workq,
1559                            &hba->clk_gating.ungate_work);
1560                 /*
1561                  * fall through to check if we should wait for this
1562                  * work to be done or not.
1563                  */
1564                 /* fallthrough */
1565         case REQ_CLKS_ON:
1566                 if (async) {
1567                         rc = -EAGAIN;
1568                         hba->clk_gating.active_reqs--;
1569                         break;
1570                 }
1571
1572                 spin_unlock_irqrestore(hba->host->host_lock, flags);
1573                 flush_work(&hba->clk_gating.ungate_work);
1574                 /* Make sure state is CLKS_ON before returning */
1575                 spin_lock_irqsave(hba->host->host_lock, flags);
1576                 goto start;
1577         default:
1578                 dev_err(hba->dev, "%s: clk gating is in invalid state %d\n",
1579                                 __func__, hba->clk_gating.state);
1580                 break;
1581         }
1582         spin_unlock_irqrestore(hba->host->host_lock, flags);
1583 out:
1584         return rc;
1585 }
1586 EXPORT_SYMBOL_GPL(ufshcd_hold);
1587
1588 static void ufshcd_gate_work(struct work_struct *work)
1589 {
1590         struct ufs_hba *hba = container_of(work, struct ufs_hba,
1591                         clk_gating.gate_work.work);
1592         unsigned long flags;
1593
1594         spin_lock_irqsave(hba->host->host_lock, flags);
1595         /*
1596          * In case you are here to cancel this work the gating state
1597          * would be marked as REQ_CLKS_ON. In this case save time by
1598          * skipping the gating work and exit after changing the clock
1599          * state to CLKS_ON.
1600          */
1601         if (hba->clk_gating.is_suspended ||
1602                 (hba->clk_gating.state == REQ_CLKS_ON)) {
1603                 hba->clk_gating.state = CLKS_ON;
1604                 trace_ufshcd_clk_gating(dev_name(hba->dev),
1605                                         hba->clk_gating.state);
1606                 goto rel_lock;
1607         }
1608
1609         if (hba->clk_gating.active_reqs
1610                 || hba->ufshcd_state != UFSHCD_STATE_OPERATIONAL
1611                 || hba->lrb_in_use || hba->outstanding_tasks
1612                 || hba->active_uic_cmd || hba->uic_async_done)
1613                 goto rel_lock;
1614
1615         spin_unlock_irqrestore(hba->host->host_lock, flags);
1616
1617         /* put the link into hibern8 mode before turning off clocks */
1618         if (ufshcd_can_hibern8_during_gating(hba)) {
1619                 if (ufshcd_uic_hibern8_enter(hba)) {
1620                         hba->clk_gating.state = CLKS_ON;
1621                         trace_ufshcd_clk_gating(dev_name(hba->dev),
1622                                                 hba->clk_gating.state);
1623                         goto out;
1624                 }
1625                 ufshcd_set_link_hibern8(hba);
1626         }
1627
1628         if (!ufshcd_is_link_active(hba))
1629                 ufshcd_setup_clocks(hba, false);
1630         else
1631                 /* If link is active, device ref_clk can't be switched off */
1632                 __ufshcd_setup_clocks(hba, false, true);
1633
1634         /*
1635          * In case you are here to cancel this work the gating state
1636          * would be marked as REQ_CLKS_ON. In this case keep the state
1637          * as REQ_CLKS_ON which would anyway imply that clocks are off
1638          * and a request to turn them on is pending. By doing this way,
1639          * we keep the state machine in tact and this would ultimately
1640          * prevent from doing cancel work multiple times when there are
1641          * new requests arriving before the current cancel work is done.
1642          */
1643         spin_lock_irqsave(hba->host->host_lock, flags);
1644         if (hba->clk_gating.state == REQ_CLKS_OFF) {
1645                 hba->clk_gating.state = CLKS_OFF;
1646                 trace_ufshcd_clk_gating(dev_name(hba->dev),
1647                                         hba->clk_gating.state);
1648         }
1649 rel_lock:
1650         spin_unlock_irqrestore(hba->host->host_lock, flags);
1651 out:
1652         return;
1653 }
1654
1655 /* host lock must be held before calling this variant */
1656 static void __ufshcd_release(struct ufs_hba *hba)
1657 {
1658         if (!ufshcd_is_clkgating_allowed(hba))
1659                 return;
1660
1661         hba->clk_gating.active_reqs--;
1662
1663         if (hba->clk_gating.active_reqs || hba->clk_gating.is_suspended
1664                 || hba->ufshcd_state != UFSHCD_STATE_OPERATIONAL
1665                 || hba->lrb_in_use || hba->outstanding_tasks
1666                 || hba->active_uic_cmd || hba->uic_async_done
1667                 || ufshcd_eh_in_progress(hba))
1668                 return;
1669
1670         hba->clk_gating.state = REQ_CLKS_OFF;
1671         trace_ufshcd_clk_gating(dev_name(hba->dev), hba->clk_gating.state);
1672         queue_delayed_work(hba->clk_gating.clk_gating_workq,
1673                            &hba->clk_gating.gate_work,
1674                            msecs_to_jiffies(hba->clk_gating.delay_ms));
1675 }
1676
1677 void ufshcd_release(struct ufs_hba *hba)
1678 {
1679         unsigned long flags;
1680
1681         spin_lock_irqsave(hba->host->host_lock, flags);
1682         __ufshcd_release(hba);
1683         spin_unlock_irqrestore(hba->host->host_lock, flags);
1684 }
1685 EXPORT_SYMBOL_GPL(ufshcd_release);
1686
1687 static ssize_t ufshcd_clkgate_delay_show(struct device *dev,
1688                 struct device_attribute *attr, char *buf)
1689 {
1690         struct ufs_hba *hba = dev_get_drvdata(dev);
1691
1692         return snprintf(buf, PAGE_SIZE, "%lu\n", hba->clk_gating.delay_ms);
1693 }
1694
1695 static ssize_t ufshcd_clkgate_delay_store(struct device *dev,
1696                 struct device_attribute *attr, const char *buf, size_t count)
1697 {
1698         struct ufs_hba *hba = dev_get_drvdata(dev);
1699         unsigned long flags, value;
1700
1701         if (kstrtoul(buf, 0, &value))
1702                 return -EINVAL;
1703
1704         spin_lock_irqsave(hba->host->host_lock, flags);
1705         hba->clk_gating.delay_ms = value;
1706         spin_unlock_irqrestore(hba->host->host_lock, flags);
1707         return count;
1708 }
1709
1710 static ssize_t ufshcd_clkgate_enable_show(struct device *dev,
1711                 struct device_attribute *attr, char *buf)
1712 {
1713         struct ufs_hba *hba = dev_get_drvdata(dev);
1714
1715         return snprintf(buf, PAGE_SIZE, "%d\n", hba->clk_gating.is_enabled);
1716 }
1717
1718 static ssize_t ufshcd_clkgate_enable_store(struct device *dev,
1719                 struct device_attribute *attr, const char *buf, size_t count)
1720 {
1721         struct ufs_hba *hba = dev_get_drvdata(dev);
1722         unsigned long flags;
1723         u32 value;
1724
1725         if (kstrtou32(buf, 0, &value))
1726                 return -EINVAL;
1727
1728         value = !!value;
1729         if (value == hba->clk_gating.is_enabled)
1730                 goto out;
1731
1732         if (value) {
1733                 ufshcd_release(hba);
1734         } else {
1735                 spin_lock_irqsave(hba->host->host_lock, flags);
1736                 hba->clk_gating.active_reqs++;
1737                 spin_unlock_irqrestore(hba->host->host_lock, flags);
1738         }
1739
1740         hba->clk_gating.is_enabled = value;
1741 out:
1742         return count;
1743 }
1744
1745 static void ufshcd_init_clk_scaling(struct ufs_hba *hba)
1746 {
1747         char wq_name[sizeof("ufs_clkscaling_00")];
1748
1749         if (!ufshcd_is_clkscaling_supported(hba))
1750                 return;
1751
1752         INIT_WORK(&hba->clk_scaling.suspend_work,
1753                   ufshcd_clk_scaling_suspend_work);
1754         INIT_WORK(&hba->clk_scaling.resume_work,
1755                   ufshcd_clk_scaling_resume_work);
1756
1757         snprintf(wq_name, sizeof(wq_name), "ufs_clkscaling_%d",
1758                  hba->host->host_no);
1759         hba->clk_scaling.workq = create_singlethread_workqueue(wq_name);
1760
1761         ufshcd_clkscaling_init_sysfs(hba);
1762 }
1763
1764 static void ufshcd_exit_clk_scaling(struct ufs_hba *hba)
1765 {
1766         if (!ufshcd_is_clkscaling_supported(hba))
1767                 return;
1768
1769         destroy_workqueue(hba->clk_scaling.workq);
1770         ufshcd_devfreq_remove(hba);
1771 }
1772
1773 static void ufshcd_init_clk_gating(struct ufs_hba *hba)
1774 {
1775         char wq_name[sizeof("ufs_clk_gating_00")];
1776
1777         if (!ufshcd_is_clkgating_allowed(hba))
1778                 return;
1779
1780         hba->clk_gating.delay_ms = 150;
1781         INIT_DELAYED_WORK(&hba->clk_gating.gate_work, ufshcd_gate_work);
1782         INIT_WORK(&hba->clk_gating.ungate_work, ufshcd_ungate_work);
1783
1784         snprintf(wq_name, ARRAY_SIZE(wq_name), "ufs_clk_gating_%d",
1785                  hba->host->host_no);
1786         hba->clk_gating.clk_gating_workq = alloc_ordered_workqueue(wq_name,
1787                                                            WQ_MEM_RECLAIM);
1788
1789         hba->clk_gating.is_enabled = true;
1790
1791         hba->clk_gating.delay_attr.show = ufshcd_clkgate_delay_show;
1792         hba->clk_gating.delay_attr.store = ufshcd_clkgate_delay_store;
1793         sysfs_attr_init(&hba->clk_gating.delay_attr.attr);
1794         hba->clk_gating.delay_attr.attr.name = "clkgate_delay_ms";
1795         hba->clk_gating.delay_attr.attr.mode = 0644;
1796         if (device_create_file(hba->dev, &hba->clk_gating.delay_attr))
1797                 dev_err(hba->dev, "Failed to create sysfs for clkgate_delay\n");
1798
1799         hba->clk_gating.enable_attr.show = ufshcd_clkgate_enable_show;
1800         hba->clk_gating.enable_attr.store = ufshcd_clkgate_enable_store;
1801         sysfs_attr_init(&hba->clk_gating.enable_attr.attr);
1802         hba->clk_gating.enable_attr.attr.name = "clkgate_enable";
1803         hba->clk_gating.enable_attr.attr.mode = 0644;
1804         if (device_create_file(hba->dev, &hba->clk_gating.enable_attr))
1805                 dev_err(hba->dev, "Failed to create sysfs for clkgate_enable\n");
1806 }
1807
1808 static void ufshcd_exit_clk_gating(struct ufs_hba *hba)
1809 {
1810         if (!ufshcd_is_clkgating_allowed(hba))
1811                 return;
1812         device_remove_file(hba->dev, &hba->clk_gating.delay_attr);
1813         device_remove_file(hba->dev, &hba->clk_gating.enable_attr);
1814         cancel_work_sync(&hba->clk_gating.ungate_work);
1815         cancel_delayed_work_sync(&hba->clk_gating.gate_work);
1816         destroy_workqueue(hba->clk_gating.clk_gating_workq);
1817 }
1818
1819 /* Must be called with host lock acquired */
1820 static void ufshcd_clk_scaling_start_busy(struct ufs_hba *hba)
1821 {
1822         bool queue_resume_work = false;
1823
1824         if (!ufshcd_is_clkscaling_supported(hba))
1825                 return;
1826
1827         if (!hba->clk_scaling.active_reqs++)
1828                 queue_resume_work = true;
1829
1830         if (!hba->clk_scaling.is_allowed || hba->pm_op_in_progress)
1831                 return;
1832
1833         if (queue_resume_work)
1834                 queue_work(hba->clk_scaling.workq,
1835                            &hba->clk_scaling.resume_work);
1836
1837         if (!hba->clk_scaling.window_start_t) {
1838                 hba->clk_scaling.window_start_t = jiffies;
1839                 hba->clk_scaling.tot_busy_t = 0;
1840                 hba->clk_scaling.is_busy_started = false;
1841         }
1842
1843         if (!hba->clk_scaling.is_busy_started) {
1844                 hba->clk_scaling.busy_start_t = ktime_get();
1845                 hba->clk_scaling.is_busy_started = true;
1846         }
1847 }
1848
1849 static void ufshcd_clk_scaling_update_busy(struct ufs_hba *hba)
1850 {
1851         struct ufs_clk_scaling *scaling = &hba->clk_scaling;
1852
1853         if (!ufshcd_is_clkscaling_supported(hba))
1854                 return;
1855
1856         if (!hba->outstanding_reqs && scaling->is_busy_started) {
1857                 scaling->tot_busy_t += ktime_to_us(ktime_sub(ktime_get(),
1858                                         scaling->busy_start_t));
1859                 scaling->busy_start_t = 0;
1860                 scaling->is_busy_started = false;
1861         }
1862 }
1863 /**
1864  * ufshcd_send_command - Send SCSI or device management commands
1865  * @hba: per adapter instance
1866  * @task_tag: Task tag of the command
1867  */
1868 static inline
1869 void ufshcd_send_command(struct ufs_hba *hba, unsigned int task_tag)
1870 {
1871         hba->lrb[task_tag].issue_time_stamp = ktime_get();
1872         hba->lrb[task_tag].compl_time_stamp = ktime_set(0, 0);
1873         ufshcd_clk_scaling_start_busy(hba);
1874         __set_bit(task_tag, &hba->outstanding_reqs);
1875         ufshcd_writel(hba, 1 << task_tag, REG_UTP_TRANSFER_REQ_DOOR_BELL);
1876         /* Make sure that doorbell is committed immediately */
1877         wmb();
1878         ufshcd_add_command_trace(hba, task_tag, "send");
1879 }
1880
1881 /**
1882  * ufshcd_copy_sense_data - Copy sense data in case of check condition
1883  * @lrbp: pointer to local reference block
1884  */
1885 static inline void ufshcd_copy_sense_data(struct ufshcd_lrb *lrbp)
1886 {
1887         int len;
1888         if (lrbp->sense_buffer &&
1889             ufshcd_get_rsp_upiu_data_seg_len(lrbp->ucd_rsp_ptr)) {
1890                 int len_to_copy;
1891
1892                 len = be16_to_cpu(lrbp->ucd_rsp_ptr->sr.sense_data_len);
1893                 len_to_copy = min_t(int, UFS_SENSE_SIZE, len);
1894
1895                 memcpy(lrbp->sense_buffer, lrbp->ucd_rsp_ptr->sr.sense_data,
1896                        len_to_copy);
1897         }
1898 }
1899
1900 /**
1901  * ufshcd_copy_query_response() - Copy the Query Response and the data
1902  * descriptor
1903  * @hba: per adapter instance
1904  * @lrbp: pointer to local reference block
1905  */
1906 static
1907 int ufshcd_copy_query_response(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
1908 {
1909         struct ufs_query_res *query_res = &hba->dev_cmd.query.response;
1910
1911         memcpy(&query_res->upiu_res, &lrbp->ucd_rsp_ptr->qr, QUERY_OSF_SIZE);
1912
1913         /* Get the descriptor */
1914         if (lrbp->ucd_rsp_ptr->qr.opcode == UPIU_QUERY_OPCODE_READ_DESC) {
1915                 u8 *descp = (u8 *)lrbp->ucd_rsp_ptr +
1916                                 GENERAL_UPIU_REQUEST_SIZE;
1917                 u16 resp_len;
1918                 u16 buf_len;
1919
1920                 /* data segment length */
1921                 resp_len = be32_to_cpu(lrbp->ucd_rsp_ptr->header.dword_2) &
1922                                                 MASK_QUERY_DATA_SEG_LEN;
1923                 buf_len = be16_to_cpu(
1924                                 hba->dev_cmd.query.request.upiu_req.length);
1925                 if (likely(buf_len >= resp_len)) {
1926                         memcpy(hba->dev_cmd.query.descriptor, descp, resp_len);
1927                 } else {
1928                         dev_warn(hba->dev,
1929                                 "%s: Response size is bigger than buffer",
1930                                 __func__);
1931                         return -EINVAL;
1932                 }
1933         }
1934
1935         return 0;
1936 }
1937
1938 /**
1939  * ufshcd_hba_capabilities - Read controller capabilities
1940  * @hba: per adapter instance
1941  */
1942 static inline void ufshcd_hba_capabilities(struct ufs_hba *hba)
1943 {
1944         hba->capabilities = ufshcd_readl(hba, REG_CONTROLLER_CAPABILITIES);
1945
1946         /* nutrs and nutmrs are 0 based values */
1947         hba->nutrs = (hba->capabilities & MASK_TRANSFER_REQUESTS_SLOTS) + 1;
1948         hba->nutmrs =
1949         ((hba->capabilities & MASK_TASK_MANAGEMENT_REQUEST_SLOTS) >> 16) + 1;
1950 }
1951
1952 /**
1953  * ufshcd_ready_for_uic_cmd - Check if controller is ready
1954  *                            to accept UIC commands
1955  * @hba: per adapter instance
1956  * Return true on success, else false
1957  */
1958 static inline bool ufshcd_ready_for_uic_cmd(struct ufs_hba *hba)
1959 {
1960         if (ufshcd_readl(hba, REG_CONTROLLER_STATUS) & UIC_COMMAND_READY)
1961                 return true;
1962         else
1963                 return false;
1964 }
1965
1966 /**
1967  * ufshcd_get_upmcrs - Get the power mode change request status
1968  * @hba: Pointer to adapter instance
1969  *
1970  * This function gets the UPMCRS field of HCS register
1971  * Returns value of UPMCRS field
1972  */
1973 static inline u8 ufshcd_get_upmcrs(struct ufs_hba *hba)
1974 {
1975         return (ufshcd_readl(hba, REG_CONTROLLER_STATUS) >> 8) & 0x7;
1976 }
1977
1978 /**
1979  * ufshcd_dispatch_uic_cmd - Dispatch UIC commands to unipro layers
1980  * @hba: per adapter instance
1981  * @uic_cmd: UIC command
1982  *
1983  * Mutex must be held.
1984  */
1985 static inline void
1986 ufshcd_dispatch_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd)
1987 {
1988         WARN_ON(hba->active_uic_cmd);
1989
1990         hba->active_uic_cmd = uic_cmd;
1991
1992         /* Write Args */
1993         ufshcd_writel(hba, uic_cmd->argument1, REG_UIC_COMMAND_ARG_1);
1994         ufshcd_writel(hba, uic_cmd->argument2, REG_UIC_COMMAND_ARG_2);
1995         ufshcd_writel(hba, uic_cmd->argument3, REG_UIC_COMMAND_ARG_3);
1996
1997         /* Write UIC Cmd */
1998         ufshcd_writel(hba, uic_cmd->command & COMMAND_OPCODE_MASK,
1999                       REG_UIC_COMMAND);
2000 }
2001
2002 /**
2003  * ufshcd_wait_for_uic_cmd - Wait complectioin of UIC command
2004  * @hba: per adapter instance
2005  * @uic_cmd: UIC command
2006  *
2007  * Must be called with mutex held.
2008  * Returns 0 only if success.
2009  */
2010 static int
2011 ufshcd_wait_for_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd)
2012 {
2013         int ret;
2014         unsigned long flags;
2015
2016         if (wait_for_completion_timeout(&uic_cmd->done,
2017                                         msecs_to_jiffies(UIC_CMD_TIMEOUT)))
2018                 ret = uic_cmd->argument2 & MASK_UIC_COMMAND_RESULT;
2019         else
2020                 ret = -ETIMEDOUT;
2021
2022         spin_lock_irqsave(hba->host->host_lock, flags);
2023         hba->active_uic_cmd = NULL;
2024         spin_unlock_irqrestore(hba->host->host_lock, flags);
2025
2026         return ret;
2027 }
2028
2029 /**
2030  * __ufshcd_send_uic_cmd - Send UIC commands and retrieve the result
2031  * @hba: per adapter instance
2032  * @uic_cmd: UIC command
2033  * @completion: initialize the completion only if this is set to true
2034  *
2035  * Identical to ufshcd_send_uic_cmd() expect mutex. Must be called
2036  * with mutex held and host_lock locked.
2037  * Returns 0 only if success.
2038  */
2039 static int
2040 __ufshcd_send_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd,
2041                       bool completion)
2042 {
2043         if (!ufshcd_ready_for_uic_cmd(hba)) {
2044                 dev_err(hba->dev,
2045                         "Controller not ready to accept UIC commands\n");
2046                 return -EIO;
2047         }
2048
2049         if (completion)
2050                 init_completion(&uic_cmd->done);
2051
2052         ufshcd_dispatch_uic_cmd(hba, uic_cmd);
2053
2054         return 0;
2055 }
2056
2057 /**
2058  * ufshcd_send_uic_cmd - Send UIC commands and retrieve the result
2059  * @hba: per adapter instance
2060  * @uic_cmd: UIC command
2061  *
2062  * Returns 0 only if success.
2063  */
2064 int ufshcd_send_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd)
2065 {
2066         int ret;
2067         unsigned long flags;
2068
2069         ufshcd_hold(hba, false);
2070         mutex_lock(&hba->uic_cmd_mutex);
2071         ufshcd_add_delay_before_dme_cmd(hba);
2072
2073         spin_lock_irqsave(hba->host->host_lock, flags);
2074         ret = __ufshcd_send_uic_cmd(hba, uic_cmd, true);
2075         spin_unlock_irqrestore(hba->host->host_lock, flags);
2076         if (!ret)
2077                 ret = ufshcd_wait_for_uic_cmd(hba, uic_cmd);
2078
2079         mutex_unlock(&hba->uic_cmd_mutex);
2080
2081         ufshcd_release(hba);
2082         return ret;
2083 }
2084
2085 /**
2086  * ufshcd_map_sg - Map scatter-gather list to prdt
2087  * @hba: per adapter instance
2088  * @lrbp: pointer to local reference block
2089  *
2090  * Returns 0 in case of success, non-zero value in case of failure
2091  */
2092 static int ufshcd_map_sg(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
2093 {
2094         struct ufshcd_sg_entry *prd_table;
2095         struct scatterlist *sg;
2096         struct scsi_cmnd *cmd;
2097         int sg_segments;
2098         int i;
2099
2100         cmd = lrbp->cmd;
2101         sg_segments = scsi_dma_map(cmd);
2102         if (sg_segments < 0)
2103                 return sg_segments;
2104
2105         if (sg_segments) {
2106                 if (hba->quirks & UFSHCD_QUIRK_PRDT_BYTE_GRAN)
2107                         lrbp->utr_descriptor_ptr->prd_table_length =
2108                                 cpu_to_le16((u16)(sg_segments *
2109                                         sizeof(struct ufshcd_sg_entry)));
2110                 else
2111                         lrbp->utr_descriptor_ptr->prd_table_length =
2112                                 cpu_to_le16((u16) (sg_segments));
2113
2114                 prd_table = (struct ufshcd_sg_entry *)lrbp->ucd_prdt_ptr;
2115
2116                 scsi_for_each_sg(cmd, sg, sg_segments, i) {
2117                         prd_table[i].size  =
2118                                 cpu_to_le32(((u32) sg_dma_len(sg))-1);
2119                         prd_table[i].base_addr =
2120                                 cpu_to_le32(lower_32_bits(sg->dma_address));
2121                         prd_table[i].upper_addr =
2122                                 cpu_to_le32(upper_32_bits(sg->dma_address));
2123                         prd_table[i].reserved = 0;
2124                 }
2125         } else {
2126                 lrbp->utr_descriptor_ptr->prd_table_length = 0;
2127         }
2128
2129         return 0;
2130 }
2131
2132 /**
2133  * ufshcd_enable_intr - enable interrupts
2134  * @hba: per adapter instance
2135  * @intrs: interrupt bits
2136  */
2137 static void ufshcd_enable_intr(struct ufs_hba *hba, u32 intrs)
2138 {
2139         u32 set = ufshcd_readl(hba, REG_INTERRUPT_ENABLE);
2140
2141         if (hba->ufs_version == UFSHCI_VERSION_10) {
2142                 u32 rw;
2143                 rw = set & INTERRUPT_MASK_RW_VER_10;
2144                 set = rw | ((set ^ intrs) & intrs);
2145         } else {
2146                 set |= intrs;
2147         }
2148
2149         ufshcd_writel(hba, set, REG_INTERRUPT_ENABLE);
2150 }
2151
2152 /**
2153  * ufshcd_disable_intr - disable interrupts
2154  * @hba: per adapter instance
2155  * @intrs: interrupt bits
2156  */
2157 static void ufshcd_disable_intr(struct ufs_hba *hba, u32 intrs)
2158 {
2159         u32 set = ufshcd_readl(hba, REG_INTERRUPT_ENABLE);
2160
2161         if (hba->ufs_version == UFSHCI_VERSION_10) {
2162                 u32 rw;
2163                 rw = (set & INTERRUPT_MASK_RW_VER_10) &
2164                         ~(intrs & INTERRUPT_MASK_RW_VER_10);
2165                 set = rw | ((set & intrs) & ~INTERRUPT_MASK_RW_VER_10);
2166
2167         } else {
2168                 set &= ~intrs;
2169         }
2170
2171         ufshcd_writel(hba, set, REG_INTERRUPT_ENABLE);
2172 }
2173
2174 /**
2175  * ufshcd_prepare_req_desc_hdr() - Fills the requests header
2176  * descriptor according to request
2177  * @lrbp: pointer to local reference block
2178  * @upiu_flags: flags required in the header
2179  * @cmd_dir: requests data direction
2180  */
2181 static void ufshcd_prepare_req_desc_hdr(struct ufshcd_lrb *lrbp,
2182                         u32 *upiu_flags, enum dma_data_direction cmd_dir)
2183 {
2184         struct utp_transfer_req_desc *req_desc = lrbp->utr_descriptor_ptr;
2185         u32 data_direction;
2186         u32 dword_0;
2187
2188         if (cmd_dir == DMA_FROM_DEVICE) {
2189                 data_direction = UTP_DEVICE_TO_HOST;
2190                 *upiu_flags = UPIU_CMD_FLAGS_READ;
2191         } else if (cmd_dir == DMA_TO_DEVICE) {
2192                 data_direction = UTP_HOST_TO_DEVICE;
2193                 *upiu_flags = UPIU_CMD_FLAGS_WRITE;
2194         } else {
2195                 data_direction = UTP_NO_DATA_TRANSFER;
2196                 *upiu_flags = UPIU_CMD_FLAGS_NONE;
2197         }
2198
2199         dword_0 = data_direction | (lrbp->command_type
2200                                 << UPIU_COMMAND_TYPE_OFFSET);
2201         if (lrbp->intr_cmd)
2202                 dword_0 |= UTP_REQ_DESC_INT_CMD;
2203
2204         /* Transfer request descriptor header fields */
2205         req_desc->header.dword_0 = cpu_to_le32(dword_0);
2206         /* dword_1 is reserved, hence it is set to 0 */
2207         req_desc->header.dword_1 = 0;
2208         /*
2209          * assigning invalid value for command status. Controller
2210          * updates OCS on command completion, with the command
2211          * status
2212          */
2213         req_desc->header.dword_2 =
2214                 cpu_to_le32(OCS_INVALID_COMMAND_STATUS);
2215         /* dword_3 is reserved, hence it is set to 0 */
2216         req_desc->header.dword_3 = 0;
2217
2218         req_desc->prd_table_length = 0;
2219 }
2220
2221 /**
2222  * ufshcd_prepare_utp_scsi_cmd_upiu() - fills the utp_transfer_req_desc,
2223  * for scsi commands
2224  * @lrbp: local reference block pointer
2225  * @upiu_flags: flags
2226  */
2227 static
2228 void ufshcd_prepare_utp_scsi_cmd_upiu(struct ufshcd_lrb *lrbp, u32 upiu_flags)
2229 {
2230         struct utp_upiu_req *ucd_req_ptr = lrbp->ucd_req_ptr;
2231         unsigned short cdb_len;
2232
2233         /* command descriptor fields */
2234         ucd_req_ptr->header.dword_0 = UPIU_HEADER_DWORD(
2235                                 UPIU_TRANSACTION_COMMAND, upiu_flags,
2236                                 lrbp->lun, lrbp->task_tag);
2237         ucd_req_ptr->header.dword_1 = UPIU_HEADER_DWORD(
2238                                 UPIU_COMMAND_SET_TYPE_SCSI, 0, 0, 0);
2239
2240         /* Total EHS length and Data segment length will be zero */
2241         ucd_req_ptr->header.dword_2 = 0;
2242
2243         ucd_req_ptr->sc.exp_data_transfer_len =
2244                 cpu_to_be32(lrbp->cmd->sdb.length);
2245
2246         cdb_len = min_t(unsigned short, lrbp->cmd->cmd_len, UFS_CDB_SIZE);
2247         memset(ucd_req_ptr->sc.cdb, 0, UFS_CDB_SIZE);
2248         memcpy(ucd_req_ptr->sc.cdb, lrbp->cmd->cmnd, cdb_len);
2249
2250         memset(lrbp->ucd_rsp_ptr, 0, sizeof(struct utp_upiu_rsp));
2251 }
2252
2253 /**
2254  * ufshcd_prepare_utp_query_req_upiu() - fills the utp_transfer_req_desc,
2255  * for query requsts
2256  * @hba: UFS hba
2257  * @lrbp: local reference block pointer
2258  * @upiu_flags: flags
2259  */
2260 static void ufshcd_prepare_utp_query_req_upiu(struct ufs_hba *hba,
2261                                 struct ufshcd_lrb *lrbp, u32 upiu_flags)
2262 {
2263         struct utp_upiu_req *ucd_req_ptr = lrbp->ucd_req_ptr;
2264         struct ufs_query *query = &hba->dev_cmd.query;
2265         u16 len = be16_to_cpu(query->request.upiu_req.length);
2266
2267         /* Query request header */
2268         ucd_req_ptr->header.dword_0 = UPIU_HEADER_DWORD(
2269                         UPIU_TRANSACTION_QUERY_REQ, upiu_flags,
2270                         lrbp->lun, lrbp->task_tag);
2271         ucd_req_ptr->header.dword_1 = UPIU_HEADER_DWORD(
2272                         0, query->request.query_func, 0, 0);
2273
2274         /* Data segment length only need for WRITE_DESC */
2275         if (query->request.upiu_req.opcode == UPIU_QUERY_OPCODE_WRITE_DESC)
2276                 ucd_req_ptr->header.dword_2 =
2277                         UPIU_HEADER_DWORD(0, 0, (len >> 8), (u8)len);
2278         else
2279                 ucd_req_ptr->header.dword_2 = 0;
2280
2281         /* Copy the Query Request buffer as is */
2282         memcpy(&ucd_req_ptr->qr, &query->request.upiu_req,
2283                         QUERY_OSF_SIZE);
2284
2285         /* Copy the Descriptor */
2286         if (query->request.upiu_req.opcode == UPIU_QUERY_OPCODE_WRITE_DESC)
2287                 memcpy(ucd_req_ptr + 1, query->descriptor, len);
2288
2289         memset(lrbp->ucd_rsp_ptr, 0, sizeof(struct utp_upiu_rsp));
2290 }
2291
2292 static inline void ufshcd_prepare_utp_nop_upiu(struct ufshcd_lrb *lrbp)
2293 {
2294         struct utp_upiu_req *ucd_req_ptr = lrbp->ucd_req_ptr;
2295
2296         memset(ucd_req_ptr, 0, sizeof(struct utp_upiu_req));
2297
2298         /* command descriptor fields */
2299         ucd_req_ptr->header.dword_0 =
2300                 UPIU_HEADER_DWORD(
2301                         UPIU_TRANSACTION_NOP_OUT, 0, 0, lrbp->task_tag);
2302         /* clear rest of the fields of basic header */
2303         ucd_req_ptr->header.dword_1 = 0;
2304         ucd_req_ptr->header.dword_2 = 0;
2305
2306         memset(lrbp->ucd_rsp_ptr, 0, sizeof(struct utp_upiu_rsp));
2307 }
2308
2309 /**
2310  * ufshcd_comp_devman_upiu - UFS Protocol Information Unit(UPIU)
2311  *                           for Device Management Purposes
2312  * @hba: per adapter instance
2313  * @lrbp: pointer to local reference block
2314  */
2315 static int ufshcd_comp_devman_upiu(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
2316 {
2317         u32 upiu_flags;
2318         int ret = 0;
2319
2320         if ((hba->ufs_version == UFSHCI_VERSION_10) ||
2321             (hba->ufs_version == UFSHCI_VERSION_11))
2322                 lrbp->command_type = UTP_CMD_TYPE_DEV_MANAGE;
2323         else
2324                 lrbp->command_type = UTP_CMD_TYPE_UFS_STORAGE;
2325
2326         ufshcd_prepare_req_desc_hdr(lrbp, &upiu_flags, DMA_NONE);
2327         if (hba->dev_cmd.type == DEV_CMD_TYPE_QUERY)
2328                 ufshcd_prepare_utp_query_req_upiu(hba, lrbp, upiu_flags);
2329         else if (hba->dev_cmd.type == DEV_CMD_TYPE_NOP)
2330                 ufshcd_prepare_utp_nop_upiu(lrbp);
2331         else
2332                 ret = -EINVAL;
2333
2334         return ret;
2335 }
2336
2337 /**
2338  * ufshcd_comp_scsi_upiu - UFS Protocol Information Unit(UPIU)
2339  *                         for SCSI Purposes
2340  * @hba: per adapter instance
2341  * @lrbp: pointer to local reference block
2342  */
2343 static int ufshcd_comp_scsi_upiu(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
2344 {
2345         u32 upiu_flags;
2346         int ret = 0;
2347
2348         if ((hba->ufs_version == UFSHCI_VERSION_10) ||
2349             (hba->ufs_version == UFSHCI_VERSION_11))
2350                 lrbp->command_type = UTP_CMD_TYPE_SCSI;
2351         else
2352                 lrbp->command_type = UTP_CMD_TYPE_UFS_STORAGE;
2353
2354         if (likely(lrbp->cmd)) {
2355                 ufshcd_prepare_req_desc_hdr(lrbp, &upiu_flags,
2356                                                 lrbp->cmd->sc_data_direction);
2357                 ufshcd_prepare_utp_scsi_cmd_upiu(lrbp, upiu_flags);
2358         } else {
2359                 ret = -EINVAL;
2360         }
2361
2362         return ret;
2363 }
2364
2365 /**
2366  * ufshcd_upiu_wlun_to_scsi_wlun - maps UPIU W-LUN id to SCSI W-LUN ID
2367  * @upiu_wlun_id: UPIU W-LUN id
2368  *
2369  * Returns SCSI W-LUN id
2370  */
2371 static inline u16 ufshcd_upiu_wlun_to_scsi_wlun(u8 upiu_wlun_id)
2372 {
2373         return (upiu_wlun_id & ~UFS_UPIU_WLUN_ID) | SCSI_W_LUN_BASE;
2374 }
2375
2376 /**
2377  * ufshcd_queuecommand - main entry point for SCSI requests
2378  * @host: SCSI host pointer
2379  * @cmd: command from SCSI Midlayer
2380  *
2381  * Returns 0 for success, non-zero in case of failure
2382  */
2383 static int ufshcd_queuecommand(struct Scsi_Host *host, struct scsi_cmnd *cmd)
2384 {
2385         struct ufshcd_lrb *lrbp;
2386         struct ufs_hba *hba;
2387         unsigned long flags;
2388         int tag;
2389         int err = 0;
2390
2391         hba = shost_priv(host);
2392
2393         tag = cmd->request->tag;
2394         if (!ufshcd_valid_tag(hba, tag)) {
2395                 dev_err(hba->dev,
2396                         "%s: invalid command tag %d: cmd=0x%p, cmd->request=0x%p",
2397                         __func__, tag, cmd, cmd->request);
2398                 BUG();
2399         }
2400
2401         if (!down_read_trylock(&hba->clk_scaling_lock))
2402                 return SCSI_MLQUEUE_HOST_BUSY;
2403
2404         spin_lock_irqsave(hba->host->host_lock, flags);
2405         switch (hba->ufshcd_state) {
2406         case UFSHCD_STATE_OPERATIONAL:
2407                 break;
2408         case UFSHCD_STATE_EH_SCHEDULED:
2409         case UFSHCD_STATE_RESET:
2410                 err = SCSI_MLQUEUE_HOST_BUSY;
2411                 goto out_unlock;
2412         case UFSHCD_STATE_ERROR:
2413                 set_host_byte(cmd, DID_ERROR);
2414                 cmd->scsi_done(cmd);
2415                 goto out_unlock;
2416         default:
2417                 dev_WARN_ONCE(hba->dev, 1, "%s: invalid state %d\n",
2418                                 __func__, hba->ufshcd_state);
2419                 set_host_byte(cmd, DID_BAD_TARGET);
2420                 cmd->scsi_done(cmd);
2421                 goto out_unlock;
2422         }
2423
2424         /* if error handling is in progress, don't issue commands */
2425         if (ufshcd_eh_in_progress(hba)) {
2426                 set_host_byte(cmd, DID_ERROR);
2427                 cmd->scsi_done(cmd);
2428                 goto out_unlock;
2429         }
2430         spin_unlock_irqrestore(hba->host->host_lock, flags);
2431
2432         hba->req_abort_count = 0;
2433
2434         /* acquire the tag to make sure device cmds don't use it */
2435         if (test_and_set_bit_lock(tag, &hba->lrb_in_use)) {
2436                 /*
2437                  * Dev manage command in progress, requeue the command.
2438                  * Requeuing the command helps in cases where the request *may*
2439                  * find different tag instead of waiting for dev manage command
2440                  * completion.
2441                  */
2442                 err = SCSI_MLQUEUE_HOST_BUSY;
2443                 goto out;
2444         }
2445
2446         err = ufshcd_hold(hba, true);
2447         if (err) {
2448                 err = SCSI_MLQUEUE_HOST_BUSY;
2449                 clear_bit_unlock(tag, &hba->lrb_in_use);
2450                 goto out;
2451         }
2452         WARN_ON(hba->clk_gating.state != CLKS_ON);
2453
2454         lrbp = &hba->lrb[tag];
2455
2456         WARN_ON(lrbp->cmd);
2457         lrbp->cmd = cmd;
2458         lrbp->sense_bufflen = UFS_SENSE_SIZE;
2459         lrbp->sense_buffer = cmd->sense_buffer;
2460         lrbp->task_tag = tag;
2461         lrbp->lun = ufshcd_scsi_to_upiu_lun(cmd->device->lun);
2462         lrbp->intr_cmd = !ufshcd_is_intr_aggr_allowed(hba) ? true : false;
2463         lrbp->req_abort_skip = false;
2464
2465         ufshcd_comp_scsi_upiu(hba, lrbp);
2466
2467         err = ufshcd_map_sg(hba, lrbp);
2468         if (err) {
2469                 lrbp->cmd = NULL;
2470                 clear_bit_unlock(tag, &hba->lrb_in_use);
2471                 goto out;
2472         }
2473         /* Make sure descriptors are ready before ringing the doorbell */
2474         wmb();
2475
2476         /* issue command to the controller */
2477         spin_lock_irqsave(hba->host->host_lock, flags);
2478         ufshcd_vops_setup_xfer_req(hba, tag, (lrbp->cmd ? true : false));
2479         ufshcd_send_command(hba, tag);
2480 out_unlock:
2481         spin_unlock_irqrestore(hba->host->host_lock, flags);
2482 out:
2483         up_read(&hba->clk_scaling_lock);
2484         return err;
2485 }
2486
2487 static int ufshcd_compose_dev_cmd(struct ufs_hba *hba,
2488                 struct ufshcd_lrb *lrbp, enum dev_cmd_type cmd_type, int tag)
2489 {
2490         lrbp->cmd = NULL;
2491         lrbp->sense_bufflen = 0;
2492         lrbp->sense_buffer = NULL;
2493         lrbp->task_tag = tag;
2494         lrbp->lun = 0; /* device management cmd is not specific to any LUN */
2495         lrbp->intr_cmd = true; /* No interrupt aggregation */
2496         hba->dev_cmd.type = cmd_type;
2497
2498         return ufshcd_comp_devman_upiu(hba, lrbp);
2499 }
2500
2501 static int
2502 ufshcd_clear_cmd(struct ufs_hba *hba, int tag)
2503 {
2504         int err = 0;
2505         unsigned long flags;
2506         u32 mask = 1 << tag;
2507
2508         /* clear outstanding transaction before retry */
2509         spin_lock_irqsave(hba->host->host_lock, flags);
2510         ufshcd_utrl_clear(hba, tag);
2511         spin_unlock_irqrestore(hba->host->host_lock, flags);
2512
2513         /*
2514          * wait for for h/w to clear corresponding bit in door-bell.
2515          * max. wait is 1 sec.
2516          */
2517         err = ufshcd_wait_for_register(hba,
2518                         REG_UTP_TRANSFER_REQ_DOOR_BELL,
2519                         mask, ~mask, 1000, 1000, true);
2520
2521         return err;
2522 }
2523
2524 static int
2525 ufshcd_check_query_response(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
2526 {
2527         struct ufs_query_res *query_res = &hba->dev_cmd.query.response;
2528
2529         /* Get the UPIU response */
2530         query_res->response = ufshcd_get_rsp_upiu_result(lrbp->ucd_rsp_ptr) >>
2531                                 UPIU_RSP_CODE_OFFSET;
2532         return query_res->response;
2533 }
2534
2535 /**
2536  * ufshcd_dev_cmd_completion() - handles device management command responses
2537  * @hba: per adapter instance
2538  * @lrbp: pointer to local reference block
2539  */
2540 static int
2541 ufshcd_dev_cmd_completion(struct ufs_hba *hba, struct ufshcd_lrb *lrbp)
2542 {
2543         int resp;
2544         int err = 0;
2545
2546         hba->ufs_stats.last_hibern8_exit_tstamp = ktime_set(0, 0);
2547         resp = ufshcd_get_req_rsp(lrbp->ucd_rsp_ptr);
2548
2549         switch (resp) {
2550         case UPIU_TRANSACTION_NOP_IN:
2551                 if (hba->dev_cmd.type != DEV_CMD_TYPE_NOP) {
2552                         err = -EINVAL;
2553                         dev_err(hba->dev, "%s: unexpected response %x\n",
2554                                         __func__, resp);
2555                 }
2556                 break;
2557         case UPIU_TRANSACTION_QUERY_RSP:
2558                 err = ufshcd_check_query_response(hba, lrbp);
2559                 if (!err)
2560                         err = ufshcd_copy_query_response(hba, lrbp);
2561                 break;
2562         case UPIU_TRANSACTION_REJECT_UPIU:
2563                 /* TODO: handle Reject UPIU Response */
2564                 err = -EPERM;
2565                 dev_err(hba->dev, "%s: Reject UPIU not fully implemented\n",
2566                                 __func__);
2567                 break;
2568         default:
2569                 err = -EINVAL;
2570                 dev_err(hba->dev, "%s: Invalid device management cmd response: %x\n",
2571                                 __func__, resp);
2572                 break;
2573         }
2574
2575         return err;
2576 }
2577
2578 static int ufshcd_wait_for_dev_cmd(struct ufs_hba *hba,
2579                 struct ufshcd_lrb *lrbp, int max_timeout)
2580 {
2581         int err = 0;
2582         unsigned long time_left;
2583         unsigned long flags;
2584
2585         time_left = wait_for_completion_timeout(hba->dev_cmd.complete,
2586                         msecs_to_jiffies(max_timeout));
2587
2588         /* Make sure descriptors are ready before ringing the doorbell */
2589         wmb();
2590         spin_lock_irqsave(hba->host->host_lock, flags);
2591         hba->dev_cmd.complete = NULL;
2592         if (likely(time_left)) {
2593                 err = ufshcd_get_tr_ocs(lrbp);
2594                 if (!err)
2595                         err = ufshcd_dev_cmd_completion(hba, lrbp);
2596         }
2597         spin_unlock_irqrestore(hba->host->host_lock, flags);
2598
2599         if (!time_left) {
2600                 err = -ETIMEDOUT;
2601                 dev_dbg(hba->dev, "%s: dev_cmd request timedout, tag %d\n",
2602                         __func__, lrbp->task_tag);
2603                 if (!ufshcd_clear_cmd(hba, lrbp->task_tag))
2604                         /* successfully cleared the command, retry if needed */
2605                         err = -EAGAIN;
2606                 /*
2607                  * in case of an error, after clearing the doorbell,
2608                  * we also need to clear the outstanding_request
2609                  * field in hba
2610                  */
2611                 ufshcd_outstanding_req_clear(hba, lrbp->task_tag);
2612         }
2613
2614         return err;
2615 }
2616
2617 /**
2618  * ufshcd_get_dev_cmd_tag - Get device management command tag
2619  * @hba: per-adapter instance
2620  * @tag_out: pointer to variable with available slot value
2621  *
2622  * Get a free slot and lock it until device management command
2623  * completes.
2624  *
2625  * Returns false if free slot is unavailable for locking, else
2626  * return true with tag value in @tag.
2627  */
2628 static bool ufshcd_get_dev_cmd_tag(struct ufs_hba *hba, int *tag_out)
2629 {
2630         int tag;
2631         bool ret = false;
2632         unsigned long tmp;
2633
2634         if (!tag_out)
2635                 goto out;
2636
2637         do {
2638                 tmp = ~hba->lrb_in_use;
2639                 tag = find_last_bit(&tmp, hba->nutrs);
2640                 if (tag >= hba->nutrs)
2641                         goto out;
2642         } while (test_and_set_bit_lock(tag, &hba->lrb_in_use));
2643
2644         *tag_out = tag;
2645         ret = true;
2646 out:
2647         return ret;
2648 }
2649
2650 static inline void ufshcd_put_dev_cmd_tag(struct ufs_hba *hba, int tag)
2651 {
2652         clear_bit_unlock(tag, &hba->lrb_in_use);
2653 }
2654
2655 /**
2656  * ufshcd_exec_dev_cmd - API for sending device management requests
2657  * @hba: UFS hba
2658  * @cmd_type: specifies the type (NOP, Query...)
2659  * @timeout: time in seconds
2660  *
2661  * NOTE: Since there is only one available tag for device management commands,
2662  * it is expected you hold the hba->dev_cmd.lock mutex.
2663  */
2664 static int ufshcd_exec_dev_cmd(struct ufs_hba *hba,
2665                 enum dev_cmd_type cmd_type, int timeout)
2666 {
2667         struct ufshcd_lrb *lrbp;
2668         int err;
2669         int tag;
2670         struct completion wait;
2671         unsigned long flags;
2672
2673         down_read(&hba->clk_scaling_lock);
2674
2675         /*
2676          * Get free slot, sleep if slots are unavailable.
2677          * Even though we use wait_event() which sleeps indefinitely,
2678          * the maximum wait time is bounded by SCSI request timeout.
2679          */
2680         wait_event(hba->dev_cmd.tag_wq, ufshcd_get_dev_cmd_tag(hba, &tag));
2681
2682         init_completion(&wait);
2683         lrbp = &hba->lrb[tag];
2684         WARN_ON(lrbp->cmd);
2685         err = ufshcd_compose_dev_cmd(hba, lrbp, cmd_type, tag);
2686         if (unlikely(err))
2687                 goto out_put_tag;
2688
2689         hba->dev_cmd.complete = &wait;
2690
2691         ufshcd_add_query_upiu_trace(hba, tag, "query_send");
2692         /* Make sure descriptors are ready before ringing the doorbell */
2693         wmb();
2694         spin_lock_irqsave(hba->host->host_lock, flags);
2695         ufshcd_vops_setup_xfer_req(hba, tag, (lrbp->cmd ? true : false));
2696         ufshcd_send_command(hba, tag);
2697         spin_unlock_irqrestore(hba->host->host_lock, flags);
2698
2699         err = ufshcd_wait_for_dev_cmd(hba, lrbp, timeout);
2700
2701         ufshcd_add_query_upiu_trace(hba, tag,
2702                         err ? "query_complete_err" : "query_complete");
2703
2704 out_put_tag:
2705         ufshcd_put_dev_cmd_tag(hba, tag);
2706         wake_up(&hba->dev_cmd.tag_wq);
2707         up_read(&hba->clk_scaling_lock);
2708         return err;
2709 }
2710
2711 /**
2712  * ufshcd_init_query() - init the query response and request parameters
2713  * @hba: per-adapter instance
2714  * @request: address of the request pointer to be initialized
2715  * @response: address of the response pointer to be initialized
2716  * @opcode: operation to perform
2717  * @idn: flag idn to access
2718  * @index: LU number to access
2719  * @selector: query/flag/descriptor further identification
2720  */
2721 static inline void ufshcd_init_query(struct ufs_hba *hba,
2722                 struct ufs_query_req **request, struct ufs_query_res **response,
2723                 enum query_opcode opcode, u8 idn, u8 index, u8 selector)
2724 {
2725         *request = &hba->dev_cmd.query.request;
2726         *response = &hba->dev_cmd.query.response;
2727         memset(*request, 0, sizeof(struct ufs_query_req));
2728         memset(*response, 0, sizeof(struct ufs_query_res));
2729         (*request)->upiu_req.opcode = opcode;
2730         (*request)->upiu_req.idn = idn;
2731         (*request)->upiu_req.index = index;
2732         (*request)->upiu_req.selector = selector;
2733 }
2734
2735 static int ufshcd_query_flag_retry(struct ufs_hba *hba,
2736         enum query_opcode opcode, enum flag_idn idn, bool *flag_res)
2737 {
2738         int ret;
2739         int retries;
2740
2741         for (retries = 0; retries < QUERY_REQ_RETRIES; retries++) {
2742                 ret = ufshcd_query_flag(hba, opcode, idn, flag_res);
2743                 if (ret)
2744                         dev_dbg(hba->dev,
2745                                 "%s: failed with error %d, retries %d\n",
2746                                 __func__, ret, retries);
2747                 else
2748                         break;
2749         }
2750
2751         if (ret)
2752                 dev_err(hba->dev,
2753                         "%s: query attribute, opcode %d, idn %d, failed with error %d after %d retires\n",
2754                         __func__, opcode, idn, ret, retries);
2755         return ret;
2756 }
2757
2758 /**
2759  * ufshcd_query_flag() - API function for sending flag query requests
2760  * @hba: per-adapter instance
2761  * @opcode: flag query to perform
2762  * @idn: flag idn to access
2763  * @flag_res: the flag value after the query request completes
2764  *
2765  * Returns 0 for success, non-zero in case of failure
2766  */
2767 int ufshcd_query_flag(struct ufs_hba *hba, enum query_opcode opcode,
2768                         enum flag_idn idn, bool *flag_res)
2769 {
2770         struct ufs_query_req *request = NULL;
2771         struct ufs_query_res *response = NULL;
2772         int err, index = 0, selector = 0;
2773         int timeout = QUERY_REQ_TIMEOUT;
2774
2775         BUG_ON(!hba);
2776
2777         ufshcd_hold(hba, false);
2778         mutex_lock(&hba->dev_cmd.lock);
2779         ufshcd_init_query(hba, &request, &response, opcode, idn, index,
2780                         selector);
2781
2782         switch (opcode) {
2783         case UPIU_QUERY_OPCODE_SET_FLAG:
2784         case UPIU_QUERY_OPCODE_CLEAR_FLAG:
2785         case UPIU_QUERY_OPCODE_TOGGLE_FLAG:
2786                 request->query_func = UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST;
2787                 break;
2788         case UPIU_QUERY_OPCODE_READ_FLAG:
2789                 request->query_func = UPIU_QUERY_FUNC_STANDARD_READ_REQUEST;
2790                 if (!flag_res) {
2791                         /* No dummy reads */
2792                         dev_err(hba->dev, "%s: Invalid argument for read request\n",
2793                                         __func__);
2794                         err = -EINVAL;
2795                         goto out_unlock;
2796                 }
2797                 break;
2798         default:
2799                 dev_err(hba->dev,
2800                         "%s: Expected query flag opcode but got = %d\n",
2801                         __func__, opcode);
2802                 err = -EINVAL;
2803                 goto out_unlock;
2804         }
2805
2806         err = ufshcd_exec_dev_cmd(hba, DEV_CMD_TYPE_QUERY, timeout);
2807
2808         if (err) {
2809                 dev_err(hba->dev,
2810                         "%s: Sending flag query for idn %d failed, err = %d\n",
2811                         __func__, idn, err);
2812                 goto out_unlock;
2813         }
2814
2815         if (flag_res)
2816                 *flag_res = (be32_to_cpu(response->upiu_res.value) &
2817                                 MASK_QUERY_UPIU_FLAG_LOC) & 0x1;
2818
2819 out_unlock:
2820         mutex_unlock(&hba->dev_cmd.lock);
2821         ufshcd_release(hba);
2822         return err;
2823 }
2824
2825 /**
2826  * ufshcd_query_attr - API function for sending attribute requests
2827  * @hba: per-adapter instance
2828  * @opcode: attribute opcode
2829  * @idn: attribute idn to access
2830  * @index: index field
2831  * @selector: selector field
2832  * @attr_val: the attribute value after the query request completes
2833  *
2834  * Returns 0 for success, non-zero in case of failure
2835 */
2836 int ufshcd_query_attr(struct ufs_hba *hba, enum query_opcode opcode,
2837                       enum attr_idn idn, u8 index, u8 selector, u32 *attr_val)
2838 {
2839         struct ufs_query_req *request = NULL;
2840         struct ufs_query_res *response = NULL;
2841         int err;
2842
2843         BUG_ON(!hba);
2844
2845         ufshcd_hold(hba, false);
2846         if (!attr_val) {
2847                 dev_err(hba->dev, "%s: attribute value required for opcode 0x%x\n",
2848                                 __func__, opcode);
2849                 err = -EINVAL;
2850                 goto out;
2851         }
2852
2853         mutex_lock(&hba->dev_cmd.lock);
2854         ufshcd_init_query(hba, &request, &response, opcode, idn, index,
2855                         selector);
2856
2857         switch (opcode) {
2858         case UPIU_QUERY_OPCODE_WRITE_ATTR:
2859                 request->query_func = UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST;
2860                 request->upiu_req.value = cpu_to_be32(*attr_val);
2861                 break;
2862         case UPIU_QUERY_OPCODE_READ_ATTR:
2863                 request->query_func = UPIU_QUERY_FUNC_STANDARD_READ_REQUEST;
2864                 break;
2865         default:
2866                 dev_err(hba->dev, "%s: Expected query attr opcode but got = 0x%.2x\n",
2867                                 __func__, opcode);
2868                 err = -EINVAL;
2869                 goto out_unlock;
2870         }
2871
2872         err = ufshcd_exec_dev_cmd(hba, DEV_CMD_TYPE_QUERY, QUERY_REQ_TIMEOUT);
2873
2874         if (err) {
2875                 dev_err(hba->dev, "%s: opcode 0x%.2x for idn %d failed, index %d, err = %d\n",
2876                                 __func__, opcode, idn, index, err);
2877                 goto out_unlock;
2878         }
2879
2880         *attr_val = be32_to_cpu(response->upiu_res.value);
2881
2882 out_unlock:
2883         mutex_unlock(&hba->dev_cmd.lock);
2884 out:
2885         ufshcd_release(hba);
2886         return err;
2887 }
2888
2889 /**
2890  * ufshcd_query_attr_retry() - API function for sending query
2891  * attribute with retries
2892  * @hba: per-adapter instance
2893  * @opcode: attribute opcode
2894  * @idn: attribute idn to access
2895  * @index: index field
2896  * @selector: selector field
2897  * @attr_val: the attribute value after the query request
2898  * completes
2899  *
2900  * Returns 0 for success, non-zero in case of failure
2901 */
2902 static int ufshcd_query_attr_retry(struct ufs_hba *hba,
2903         enum query_opcode opcode, enum attr_idn idn, u8 index, u8 selector,
2904         u32 *attr_val)
2905 {
2906         int ret = 0;
2907         u32 retries;
2908
2909          for (retries = QUERY_REQ_RETRIES; retries > 0; retries--) {
2910                 ret = ufshcd_query_attr(hba, opcode, idn, index,
2911                                                 selector, attr_val);
2912                 if (ret)
2913                         dev_dbg(hba->dev, "%s: failed with error %d, retries %d\n",
2914                                 __func__, ret, retries);
2915                 else
2916                         break;
2917         }
2918
2919         if (ret)
2920                 dev_err(hba->dev,
2921                         "%s: query attribute, idn %d, failed with error %d after %d retires\n",
2922                         __func__, idn, ret, QUERY_REQ_RETRIES);
2923         return ret;
2924 }
2925
2926 static int __ufshcd_query_descriptor(struct ufs_hba *hba,
2927                         enum query_opcode opcode, enum desc_idn idn, u8 index,
2928                         u8 selector, u8 *desc_buf, int *buf_len)
2929 {
2930         struct ufs_query_req *request = NULL;
2931         struct ufs_query_res *response = NULL;
2932         int err;
2933
2934         BUG_ON(!hba);
2935
2936         ufshcd_hold(hba, false);
2937         if (!desc_buf) {
2938                 dev_err(hba->dev, "%s: descriptor buffer required for opcode 0x%x\n",
2939                                 __func__, opcode);
2940                 err = -EINVAL;
2941                 goto out;
2942         }
2943
2944         if (*buf_len < QUERY_DESC_MIN_SIZE || *buf_len > QUERY_DESC_MAX_SIZE) {
2945                 dev_err(hba->dev, "%s: descriptor buffer size (%d) is out of range\n",
2946                                 __func__, *buf_len);
2947                 err = -EINVAL;
2948                 goto out;
2949         }
2950
2951         mutex_lock(&hba->dev_cmd.lock);
2952         ufshcd_init_query(hba, &request, &response, opcode, idn, index,
2953                         selector);
2954         hba->dev_cmd.query.descriptor = desc_buf;
2955         request->upiu_req.length = cpu_to_be16(*buf_len);
2956
2957         switch (opcode) {
2958         case UPIU_QUERY_OPCODE_WRITE_DESC:
2959                 request->query_func = UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST;
2960                 break;
2961         case UPIU_QUERY_OPCODE_READ_DESC:
2962                 request->query_func = UPIU_QUERY_FUNC_STANDARD_READ_REQUEST;
2963                 break;
2964         default:
2965                 dev_err(hba->dev,
2966                                 "%s: Expected query descriptor opcode but got = 0x%.2x\n",
2967                                 __func__, opcode);
2968                 err = -EINVAL;
2969                 goto out_unlock;
2970         }
2971
2972         err = ufshcd_exec_dev_cmd(hba, DEV_CMD_TYPE_QUERY, QUERY_REQ_TIMEOUT);
2973
2974         if (err) {
2975                 dev_err(hba->dev, "%s: opcode 0x%.2x for idn %d failed, index %d, err = %d\n",
2976                                 __func__, opcode, idn, index, err);
2977                 goto out_unlock;
2978         }
2979
2980         hba->dev_cmd.query.descriptor = NULL;
2981         *buf_len = be16_to_cpu(response->upiu_res.length);
2982
2983 out_unlock:
2984         mutex_unlock(&hba->dev_cmd.lock);
2985 out:
2986         ufshcd_release(hba);
2987         return err;
2988 }
2989
2990 /**
2991  * ufshcd_query_descriptor_retry - API function for sending descriptor requests
2992  * @hba: per-adapter instance
2993  * @opcode: attribute opcode
2994  * @idn: attribute idn to access
2995  * @index: index field
2996  * @selector: selector field
2997  * @desc_buf: the buffer that contains the descriptor
2998  * @buf_len: length parameter passed to the device
2999  *
3000  * Returns 0 for success, non-zero in case of failure.
3001  * The buf_len parameter will contain, on return, the length parameter
3002  * received on the response.
3003  */
3004 int ufshcd_query_descriptor_retry(struct ufs_hba *hba,
3005                                   enum query_opcode opcode,
3006                                   enum desc_idn idn, u8 index,
3007                                   u8 selector,
3008                                   u8 *desc_buf, int *buf_len)
3009 {
3010         int err;
3011         int retries;
3012
3013         for (retries = QUERY_REQ_RETRIES; retries > 0; retries--) {
3014                 err = __ufshcd_query_descriptor(hba, opcode, idn, index,
3015                                                 selector, desc_buf, buf_len);
3016                 if (!err || err == -EINVAL)
3017                         break;
3018         }
3019
3020         return err;
3021 }
3022
3023 /**
3024  * ufshcd_read_desc_length - read the specified descriptor length from header
3025  * @hba: Pointer to adapter instance
3026  * @desc_id: descriptor idn value
3027  * @desc_index: descriptor index
3028  * @desc_length: pointer to variable to read the length of descriptor
3029  *
3030  * Return 0 in case of success, non-zero otherwise
3031  */
3032 static int ufshcd_read_desc_length(struct ufs_hba *hba,
3033         enum desc_idn desc_id,
3034         int desc_index,
3035         int *desc_length)
3036 {
3037         int ret;
3038         u8 header[QUERY_DESC_HDR_SIZE];
3039         int header_len = QUERY_DESC_HDR_SIZE;
3040
3041         if (desc_id >= QUERY_DESC_IDN_MAX)
3042                 return -EINVAL;
3043
3044         ret = ufshcd_query_descriptor_retry(hba, UPIU_QUERY_OPCODE_READ_DESC,
3045                                         desc_id, desc_index, 0, header,
3046                                         &header_len);
3047
3048         if (ret) {
3049                 dev_err(hba->dev, "%s: Failed to get descriptor header id %d",
3050                         __func__, desc_id);
3051                 return ret;
3052         } else if (desc_id != header[QUERY_DESC_DESC_TYPE_OFFSET]) {
3053                 dev_warn(hba->dev, "%s: descriptor header id %d and desc_id %d mismatch",
3054                         __func__, header[QUERY_DESC_DESC_TYPE_OFFSET],
3055                         desc_id);
3056                 ret = -EINVAL;
3057         }
3058
3059         *desc_length = header[QUERY_DESC_LENGTH_OFFSET];
3060         return ret;
3061
3062 }
3063
3064 /**
3065  * ufshcd_map_desc_id_to_length - map descriptor IDN to its length
3066  * @hba: Pointer to adapter instance
3067  * @desc_id: descriptor idn value
3068  * @desc_len: mapped desc length (out)
3069  *
3070  * Return 0 in case of success, non-zero otherwise
3071  */
3072 int ufshcd_map_desc_id_to_length(struct ufs_hba *hba,
3073         enum desc_idn desc_id, int *desc_len)
3074 {
3075         switch (desc_id) {
3076         case QUERY_DESC_IDN_DEVICE:
3077                 *desc_len = hba->desc_size.dev_desc;
3078                 break;
3079         case QUERY_DESC_IDN_POWER:
3080                 *desc_len = hba->desc_size.pwr_desc;
3081                 break;
3082         case QUERY_DESC_IDN_GEOMETRY:
3083                 *desc_len = hba->desc_size.geom_desc;
3084                 break;
3085         case QUERY_DESC_IDN_CONFIGURATION:
3086                 *desc_len = hba->desc_size.conf_desc;
3087                 break;
3088         case QUERY_DESC_IDN_UNIT:
3089                 *desc_len = hba->desc_size.unit_desc;
3090                 break;
3091         case QUERY_DESC_IDN_INTERCONNECT:
3092                 *desc_len = hba->desc_size.interc_desc;
3093                 break;
3094         case QUERY_DESC_IDN_STRING:
3095                 *desc_len = QUERY_DESC_MAX_SIZE;
3096                 break;
3097         case QUERY_DESC_IDN_HEALTH:
3098                 *desc_len = hba->desc_size.hlth_desc;
3099                 break;
3100         case QUERY_DESC_IDN_RFU_0:
3101         case QUERY_DESC_IDN_RFU_1:
3102                 *desc_len = 0;
3103                 break;
3104         default:
3105                 *desc_len = 0;
3106                 return -EINVAL;
3107         }
3108         return 0;
3109 }
3110 EXPORT_SYMBOL(ufshcd_map_desc_id_to_length);
3111
3112 /**
3113  * ufshcd_read_desc_param - read the specified descriptor parameter
3114  * @hba: Pointer to adapter instance
3115  * @desc_id: descriptor idn value
3116  * @desc_index: descriptor index
3117  * @param_offset: offset of the parameter to read
3118  * @param_read_buf: pointer to buffer where parameter would be read
3119  * @param_size: sizeof(param_read_buf)
3120  *
3121  * Return 0 in case of success, non-zero otherwise
3122  */
3123 int ufshcd_read_desc_param(struct ufs_hba *hba,
3124                            enum desc_idn desc_id,
3125                            int desc_index,
3126                            u8 param_offset,
3127                            u8 *param_read_buf,
3128                            u8 param_size)
3129 {
3130         int ret;
3131         u8 *desc_buf;
3132         int buff_len;
3133         bool is_kmalloc = true;
3134
3135         /* Safety check */
3136         if (desc_id >= QUERY_DESC_IDN_MAX || !param_size)
3137                 return -EINVAL;
3138
3139         /* Get the max length of descriptor from structure filled up at probe
3140          * time.
3141          */
3142         ret = ufshcd_map_desc_id_to_length(hba, desc_id, &buff_len);
3143
3144         /* Sanity checks */
3145         if (ret || !buff_len) {
3146                 dev_err(hba->dev, "%s: Failed to get full descriptor length",
3147                         __func__);
3148                 return ret;
3149         }
3150
3151         /* Check whether we need temp memory */
3152         if (param_offset != 0 || param_size < buff_len) {
3153                 desc_buf = kmalloc(buff_len, GFP_KERNEL);
3154                 if (!desc_buf)
3155                         return -ENOMEM;
3156         } else {
3157                 desc_buf = param_read_buf;
3158                 is_kmalloc = false;
3159         }
3160
3161         /* Request for full descriptor */
3162         ret = ufshcd_query_descriptor_retry(hba, UPIU_QUERY_OPCODE_READ_DESC,
3163                                         desc_id, desc_index, 0,
3164                                         desc_buf, &buff_len);
3165
3166         if (ret) {
3167                 dev_err(hba->dev, "%s: Failed reading descriptor. desc_id %d, desc_index %d, param_offset %d, ret %d",
3168                         __func__, desc_id, desc_index, param_offset, ret);
3169                 goto out;
3170         }
3171
3172         /* Sanity check */
3173         if (desc_buf[QUERY_DESC_DESC_TYPE_OFFSET] != desc_id) {
3174                 dev_err(hba->dev, "%s: invalid desc_id %d in descriptor header",
3175                         __func__, desc_buf[QUERY_DESC_DESC_TYPE_OFFSET]);
3176                 ret = -EINVAL;
3177                 goto out;
3178         }
3179
3180         /* Check wherher we will not copy more data, than available */
3181         if (is_kmalloc && param_size > buff_len)
3182                 param_size = buff_len;
3183
3184         if (is_kmalloc)
3185                 memcpy(param_read_buf, &desc_buf[param_offset], param_size);
3186 out:
3187         if (is_kmalloc)
3188                 kfree(desc_buf);
3189         return ret;
3190 }
3191
3192 static inline int ufshcd_read_desc(struct ufs_hba *hba,
3193                                    enum desc_idn desc_id,
3194                                    int desc_index,
3195                                    u8 *buf,
3196                                    u32 size)
3197 {
3198         return ufshcd_read_desc_param(hba, desc_id, desc_index, 0, buf, size);
3199 }
3200
3201 static inline int ufshcd_read_power_desc(struct ufs_hba *hba,
3202                                          u8 *buf,
3203                                          u32 size)
3204 {
3205         return ufshcd_read_desc(hba, QUERY_DESC_IDN_POWER, 0, buf, size);
3206 }
3207
3208 static int ufshcd_read_device_desc(struct ufs_hba *hba, u8 *buf, u32 size)
3209 {
3210         return ufshcd_read_desc(hba, QUERY_DESC_IDN_DEVICE, 0, buf, size);
3211 }
3212
3213 /**
3214  * ufshcd_read_string_desc - read string descriptor
3215  * @hba: pointer to adapter instance
3216  * @desc_index: descriptor index
3217  * @buf: pointer to buffer where descriptor would be read
3218  * @size: size of buf
3219  * @ascii: if true convert from unicode to ascii characters
3220  *
3221  * Return 0 in case of success, non-zero otherwise
3222  */
3223 int ufshcd_read_string_desc(struct ufs_hba *hba, int desc_index,
3224                             u8 *buf, u32 size, bool ascii)
3225 {
3226         int err = 0;
3227
3228         err = ufshcd_read_desc(hba,
3229                                 QUERY_DESC_IDN_STRING, desc_index, buf, size);
3230
3231         if (err) {
3232                 dev_err(hba->dev, "%s: reading String Desc failed after %d retries. err = %d\n",
3233                         __func__, QUERY_REQ_RETRIES, err);
3234                 goto out;
3235         }
3236
3237         if (ascii) {
3238                 int desc_len;
3239                 int ascii_len;
3240                 int i;
3241                 char *buff_ascii;
3242
3243                 desc_len = buf[0];
3244                 /* remove header and divide by 2 to move from UTF16 to UTF8 */
3245                 ascii_len = (desc_len - QUERY_DESC_HDR_SIZE) / 2 + 1;
3246                 if (size < ascii_len + QUERY_DESC_HDR_SIZE) {
3247                         dev_err(hba->dev, "%s: buffer allocated size is too small\n",
3248                                         __func__);
3249                         err = -ENOMEM;
3250                         goto out;
3251                 }
3252
3253                 buff_ascii = kmalloc(ascii_len, GFP_KERNEL);
3254                 if (!buff_ascii) {
3255                         err = -ENOMEM;
3256                         goto out;
3257                 }
3258
3259                 /*
3260                  * the descriptor contains string in UTF16 format
3261                  * we need to convert to utf-8 so it can be displayed
3262                  */
3263                 utf16s_to_utf8s((wchar_t *)&buf[QUERY_DESC_HDR_SIZE],
3264                                 desc_len - QUERY_DESC_HDR_SIZE,
3265                                 UTF16_BIG_ENDIAN, buff_ascii, ascii_len);
3266
3267                 /* replace non-printable or non-ASCII characters with spaces */
3268                 for (i = 0; i < ascii_len; i++)
3269                         ufshcd_remove_non_printable(&buff_ascii[i]);
3270
3271                 memset(buf + QUERY_DESC_HDR_SIZE, 0,
3272                                 size - QUERY_DESC_HDR_SIZE);
3273                 memcpy(buf + QUERY_DESC_HDR_SIZE, buff_ascii, ascii_len);
3274                 buf[QUERY_DESC_LENGTH_OFFSET] = ascii_len + QUERY_DESC_HDR_SIZE;
32