scsi: ufs: unexport descritpor reading functions
[muen/linux.git] / drivers / scsi / ufs / ufshcd.h
1 /*
2  * Universal Flash Storage Host controller driver
3  *
4  * This code is based on drivers/scsi/ufs/ufshcd.h
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
37 #ifndef _UFSHCD_H
38 #define _UFSHCD_H
39
40 #include <linux/module.h>
41 #include <linux/kernel.h>
42 #include <linux/init.h>
43 #include <linux/interrupt.h>
44 #include <linux/io.h>
45 #include <linux/delay.h>
46 #include <linux/slab.h>
47 #include <linux/spinlock.h>
48 #include <linux/workqueue.h>
49 #include <linux/errno.h>
50 #include <linux/types.h>
51 #include <linux/wait.h>
52 #include <linux/bitops.h>
53 #include <linux/pm_runtime.h>
54 #include <linux/clk.h>
55 #include <linux/completion.h>
56 #include <linux/regulator/consumer.h>
57 #include "unipro.h"
58
59 #include <asm/irq.h>
60 #include <asm/byteorder.h>
61 #include <scsi/scsi.h>
62 #include <scsi/scsi_cmnd.h>
63 #include <scsi/scsi_host.h>
64 #include <scsi/scsi_tcq.h>
65 #include <scsi/scsi_dbg.h>
66 #include <scsi/scsi_eh.h>
67
68 #include "ufs.h"
69 #include "ufshci.h"
70
71 #define UFSHCD "ufshcd"
72 #define UFSHCD_DRIVER_VERSION "0.2"
73
74 struct ufs_hba;
75
76 enum dev_cmd_type {
77         DEV_CMD_TYPE_NOP                = 0x0,
78         DEV_CMD_TYPE_QUERY              = 0x1,
79 };
80
81 /**
82  * struct uic_command - UIC command structure
83  * @command: UIC command
84  * @argument1: UIC command argument 1
85  * @argument2: UIC command argument 2
86  * @argument3: UIC command argument 3
87  * @cmd_active: Indicate if UIC command is outstanding
88  * @result: UIC command result
89  * @done: UIC command completion
90  */
91 struct uic_command {
92         u32 command;
93         u32 argument1;
94         u32 argument2;
95         u32 argument3;
96         int cmd_active;
97         int result;
98         struct completion done;
99 };
100
101 /* Used to differentiate the power management options */
102 enum ufs_pm_op {
103         UFS_RUNTIME_PM,
104         UFS_SYSTEM_PM,
105         UFS_SHUTDOWN_PM,
106 };
107
108 #define ufshcd_is_runtime_pm(op) ((op) == UFS_RUNTIME_PM)
109 #define ufshcd_is_system_pm(op) ((op) == UFS_SYSTEM_PM)
110 #define ufshcd_is_shutdown_pm(op) ((op) == UFS_SHUTDOWN_PM)
111
112 /* Host <-> Device UniPro Link state */
113 enum uic_link_state {
114         UIC_LINK_OFF_STATE      = 0, /* Link powered down or disabled */
115         UIC_LINK_ACTIVE_STATE   = 1, /* Link is in Fast/Slow/Sleep state */
116         UIC_LINK_HIBERN8_STATE  = 2, /* Link is in Hibernate state */
117 };
118
119 #define ufshcd_is_link_off(hba) ((hba)->uic_link_state == UIC_LINK_OFF_STATE)
120 #define ufshcd_is_link_active(hba) ((hba)->uic_link_state == \
121                                     UIC_LINK_ACTIVE_STATE)
122 #define ufshcd_is_link_hibern8(hba) ((hba)->uic_link_state == \
123                                     UIC_LINK_HIBERN8_STATE)
124 #define ufshcd_set_link_off(hba) ((hba)->uic_link_state = UIC_LINK_OFF_STATE)
125 #define ufshcd_set_link_active(hba) ((hba)->uic_link_state = \
126                                     UIC_LINK_ACTIVE_STATE)
127 #define ufshcd_set_link_hibern8(hba) ((hba)->uic_link_state = \
128                                     UIC_LINK_HIBERN8_STATE)
129
130 /*
131  * UFS Power management levels.
132  * Each level is in increasing order of power savings.
133  */
134 enum ufs_pm_level {
135         UFS_PM_LVL_0, /* UFS_ACTIVE_PWR_MODE, UIC_LINK_ACTIVE_STATE */
136         UFS_PM_LVL_1, /* UFS_ACTIVE_PWR_MODE, UIC_LINK_HIBERN8_STATE */
137         UFS_PM_LVL_2, /* UFS_SLEEP_PWR_MODE, UIC_LINK_ACTIVE_STATE */
138         UFS_PM_LVL_3, /* UFS_SLEEP_PWR_MODE, UIC_LINK_HIBERN8_STATE */
139         UFS_PM_LVL_4, /* UFS_POWERDOWN_PWR_MODE, UIC_LINK_HIBERN8_STATE */
140         UFS_PM_LVL_5, /* UFS_POWERDOWN_PWR_MODE, UIC_LINK_OFF_STATE */
141         UFS_PM_LVL_MAX
142 };
143
144 struct ufs_pm_lvl_states {
145         enum ufs_dev_pwr_mode dev_state;
146         enum uic_link_state link_state;
147 };
148
149 /**
150  * struct ufshcd_lrb - local reference block
151  * @utr_descriptor_ptr: UTRD address of the command
152  * @ucd_req_ptr: UCD address of the command
153  * @ucd_rsp_ptr: Response UPIU address for this command
154  * @ucd_prdt_ptr: PRDT address of the command
155  * @utrd_dma_addr: UTRD dma address for debug
156  * @ucd_prdt_dma_addr: PRDT dma address for debug
157  * @ucd_rsp_dma_addr: UPIU response dma address for debug
158  * @ucd_req_dma_addr: UPIU request dma address for debug
159  * @cmd: pointer to SCSI command
160  * @sense_buffer: pointer to sense buffer address of the SCSI command
161  * @sense_bufflen: Length of the sense buffer
162  * @scsi_status: SCSI status of the command
163  * @command_type: SCSI, UFS, Query.
164  * @task_tag: Task tag of the command
165  * @lun: LUN of the command
166  * @intr_cmd: Interrupt command (doesn't participate in interrupt aggregation)
167  * @issue_time_stamp: time stamp for debug purposes
168  */
169 struct ufshcd_lrb {
170         struct utp_transfer_req_desc *utr_descriptor_ptr;
171         struct utp_upiu_req *ucd_req_ptr;
172         struct utp_upiu_rsp *ucd_rsp_ptr;
173         struct ufshcd_sg_entry *ucd_prdt_ptr;
174
175         dma_addr_t utrd_dma_addr;
176         dma_addr_t ucd_req_dma_addr;
177         dma_addr_t ucd_rsp_dma_addr;
178         dma_addr_t ucd_prdt_dma_addr;
179
180         struct scsi_cmnd *cmd;
181         u8 *sense_buffer;
182         unsigned int sense_bufflen;
183         int scsi_status;
184
185         int command_type;
186         int task_tag;
187         u8 lun; /* UPIU LUN id field is only 8-bit wide */
188         bool intr_cmd;
189         ktime_t issue_time_stamp;
190 };
191
192 /**
193  * struct ufs_query - holds relevant data structures for query request
194  * @request: request upiu and function
195  * @descriptor: buffer for sending/receiving descriptor
196  * @response: response upiu and response
197  */
198 struct ufs_query {
199         struct ufs_query_req request;
200         u8 *descriptor;
201         struct ufs_query_res response;
202 };
203
204 /**
205  * struct ufs_dev_cmd - all assosiated fields with device management commands
206  * @type: device management command type - Query, NOP OUT
207  * @lock: lock to allow one command at a time
208  * @complete: internal commands completion
209  * @tag_wq: wait queue until free command slot is available
210  */
211 struct ufs_dev_cmd {
212         enum dev_cmd_type type;
213         struct mutex lock;
214         struct completion *complete;
215         wait_queue_head_t tag_wq;
216         struct ufs_query query;
217 };
218
219 /**
220  * struct ufs_clk_info - UFS clock related info
221  * @list: list headed by hba->clk_list_head
222  * @clk: clock node
223  * @name: clock name
224  * @max_freq: maximum frequency supported by the clock
225  * @min_freq: min frequency that can be used for clock scaling
226  * @curr_freq: indicates the current frequency that it is set to
227  * @enabled: variable to check against multiple enable/disable
228  */
229 struct ufs_clk_info {
230         struct list_head list;
231         struct clk *clk;
232         const char *name;
233         u32 max_freq;
234         u32 min_freq;
235         u32 curr_freq;
236         bool enabled;
237 };
238
239 enum ufs_notify_change_status {
240         PRE_CHANGE,
241         POST_CHANGE,
242 };
243
244 struct ufs_pa_layer_attr {
245         u32 gear_rx;
246         u32 gear_tx;
247         u32 lane_rx;
248         u32 lane_tx;
249         u32 pwr_rx;
250         u32 pwr_tx;
251         u32 hs_rate;
252 };
253
254 struct ufs_pwr_mode_info {
255         bool is_valid;
256         struct ufs_pa_layer_attr info;
257 };
258
259 /**
260  * struct ufs_hba_variant_ops - variant specific callbacks
261  * @name: variant name
262  * @init: called when the driver is initialized
263  * @exit: called to cleanup everything done in init
264  * @get_ufs_hci_version: called to get UFS HCI version
265  * @clk_scale_notify: notifies that clks are scaled up/down
266  * @setup_clocks: called before touching any of the controller registers
267  * @setup_regulators: called before accessing the host controller
268  * @hce_enable_notify: called before and after HCE enable bit is set to allow
269  *                     variant specific Uni-Pro initialization.
270  * @link_startup_notify: called before and after Link startup is carried out
271  *                       to allow variant specific Uni-Pro initialization.
272  * @pwr_change_notify: called before and after a power mode change
273  *                      is carried out to allow vendor spesific capabilities
274  *                      to be set.
275  * @setup_xfer_req: called before any transfer request is issued
276  *                  to set some things
277  * @setup_task_mgmt: called before any task management request is issued
278  *                  to set some things
279  * @hibern8_notify: called around hibern8 enter/exit
280  * @apply_dev_quirks: called to apply device specific quirks
281  * @suspend: called during host controller PM callback
282  * @resume: called during host controller PM callback
283  * @dbg_register_dump: used to dump controller debug information
284  * @phy_initialization: used to initialize phys
285  */
286 struct ufs_hba_variant_ops {
287         const char *name;
288         int     (*init)(struct ufs_hba *);
289         void    (*exit)(struct ufs_hba *);
290         u32     (*get_ufs_hci_version)(struct ufs_hba *);
291         int     (*clk_scale_notify)(struct ufs_hba *, bool,
292                                     enum ufs_notify_change_status);
293         int     (*setup_clocks)(struct ufs_hba *, bool,
294                                 enum ufs_notify_change_status);
295         int     (*setup_regulators)(struct ufs_hba *, bool);
296         int     (*hce_enable_notify)(struct ufs_hba *,
297                                      enum ufs_notify_change_status);
298         int     (*link_startup_notify)(struct ufs_hba *,
299                                        enum ufs_notify_change_status);
300         int     (*pwr_change_notify)(struct ufs_hba *,
301                                         enum ufs_notify_change_status status,
302                                         struct ufs_pa_layer_attr *,
303                                         struct ufs_pa_layer_attr *);
304         void    (*setup_xfer_req)(struct ufs_hba *, int, bool);
305         void    (*setup_task_mgmt)(struct ufs_hba *, int, u8);
306         void    (*hibern8_notify)(struct ufs_hba *, enum uic_cmd_dme,
307                                         enum ufs_notify_change_status);
308         int     (*apply_dev_quirks)(struct ufs_hba *);
309         int     (*suspend)(struct ufs_hba *, enum ufs_pm_op);
310         int     (*resume)(struct ufs_hba *, enum ufs_pm_op);
311         void    (*dbg_register_dump)(struct ufs_hba *hba);
312         int     (*phy_initialization)(struct ufs_hba *);
313 };
314
315 /* clock gating state  */
316 enum clk_gating_state {
317         CLKS_OFF,
318         CLKS_ON,
319         REQ_CLKS_OFF,
320         REQ_CLKS_ON,
321 };
322
323 /**
324  * struct ufs_clk_gating - UFS clock gating related info
325  * @gate_work: worker to turn off clocks after some delay as specified in
326  * delay_ms
327  * @ungate_work: worker to turn on clocks that will be used in case of
328  * interrupt context
329  * @state: the current clocks state
330  * @delay_ms: gating delay in ms
331  * @is_suspended: clk gating is suspended when set to 1 which can be used
332  * during suspend/resume
333  * @delay_attr: sysfs attribute to control delay_attr
334  * @enable_attr: sysfs attribute to enable/disable clock gating
335  * @is_enabled: Indicates the current status of clock gating
336  * @active_reqs: number of requests that are pending and should be waited for
337  * completion before gating clocks.
338  */
339 struct ufs_clk_gating {
340         struct delayed_work gate_work;
341         struct work_struct ungate_work;
342         enum clk_gating_state state;
343         unsigned long delay_ms;
344         bool is_suspended;
345         struct device_attribute delay_attr;
346         struct device_attribute enable_attr;
347         bool is_enabled;
348         int active_reqs;
349 };
350
351 struct ufs_clk_scaling {
352         ktime_t  busy_start_t;
353         bool is_busy_started;
354         unsigned long  tot_busy_t;
355         unsigned long window_start_t;
356         struct device_attribute enable_attr;
357         bool is_allowed;
358 };
359
360 /**
361  * struct ufs_init_prefetch - contains data that is pre-fetched once during
362  * initialization
363  * @icc_level: icc level which was read during initialization
364  */
365 struct ufs_init_prefetch {
366         u32 icc_level;
367 };
368
369 #define UIC_ERR_REG_HIST_LENGTH 8
370 /**
371  * struct ufs_uic_err_reg_hist - keeps history of uic errors
372  * @pos: index to indicate cyclic buffer position
373  * @reg: cyclic buffer for registers value
374  * @tstamp: cyclic buffer for time stamp
375  */
376 struct ufs_uic_err_reg_hist {
377         int pos;
378         u32 reg[UIC_ERR_REG_HIST_LENGTH];
379         ktime_t tstamp[UIC_ERR_REG_HIST_LENGTH];
380 };
381
382 /**
383  * struct ufs_stats - keeps usage/err statistics
384  * @hibern8_exit_cnt: Counter to keep track of number of exits,
385  *              reset this after link-startup.
386  * @last_hibern8_exit_tstamp: Set time after the hibern8 exit.
387  *              Clear after the first successful command completion.
388  * @pa_err: tracks pa-uic errors
389  * @dl_err: tracks dl-uic errors
390  * @nl_err: tracks nl-uic errors
391  * @tl_err: tracks tl-uic errors
392  * @dme_err: tracks dme errors
393  */
394 struct ufs_stats {
395         u32 hibern8_exit_cnt;
396         ktime_t last_hibern8_exit_tstamp;
397         struct ufs_uic_err_reg_hist pa_err;
398         struct ufs_uic_err_reg_hist dl_err;
399         struct ufs_uic_err_reg_hist nl_err;
400         struct ufs_uic_err_reg_hist tl_err;
401         struct ufs_uic_err_reg_hist dme_err;
402 };
403
404 /**
405  * struct ufs_hba - per adapter private structure
406  * @mmio_base: UFSHCI base register address
407  * @ucdl_base_addr: UFS Command Descriptor base address
408  * @utrdl_base_addr: UTP Transfer Request Descriptor base address
409  * @utmrdl_base_addr: UTP Task Management Descriptor base address
410  * @ucdl_dma_addr: UFS Command Descriptor DMA address
411  * @utrdl_dma_addr: UTRDL DMA address
412  * @utmrdl_dma_addr: UTMRDL DMA address
413  * @host: Scsi_Host instance of the driver
414  * @dev: device handle
415  * @lrb: local reference block
416  * @lrb_in_use: lrb in use
417  * @outstanding_tasks: Bits representing outstanding task requests
418  * @outstanding_reqs: Bits representing outstanding transfer requests
419  * @capabilities: UFS Controller Capabilities
420  * @nutrs: Transfer Request Queue depth supported by controller
421  * @nutmrs: Task Management Queue depth supported by controller
422  * @ufs_version: UFS Version to which controller complies
423  * @vops: pointer to variant specific operations
424  * @priv: pointer to variant specific private data
425  * @irq: Irq number of the controller
426  * @active_uic_cmd: handle of active UIC command
427  * @uic_cmd_mutex: mutex for uic command
428  * @tm_wq: wait queue for task management
429  * @tm_tag_wq: wait queue for free task management slots
430  * @tm_slots_in_use: bit map of task management request slots in use
431  * @pwr_done: completion for power mode change
432  * @tm_condition: condition variable for task management
433  * @ufshcd_state: UFSHCD states
434  * @eh_flags: Error handling flags
435  * @intr_mask: Interrupt Mask Bits
436  * @ee_ctrl_mask: Exception event control mask
437  * @is_powered: flag to check if HBA is powered
438  * @is_init_prefetch: flag to check if data was pre-fetched in initialization
439  * @init_prefetch_data: data pre-fetched during initialization
440  * @eh_work: Worker to handle UFS errors that require s/w attention
441  * @eeh_work: Worker to handle exception events
442  * @errors: HBA errors
443  * @uic_error: UFS interconnect layer error status
444  * @saved_err: sticky error mask
445  * @saved_uic_err: sticky UIC error mask
446  * @dev_cmd: ufs device management command information
447  * @last_dme_cmd_tstamp: time stamp of the last completed DME command
448  * @auto_bkops_enabled: to track whether bkops is enabled in device
449  * @vreg_info: UFS device voltage regulator information
450  * @clk_list_head: UFS host controller clocks list node head
451  * @pwr_info: holds current power mode
452  * @max_pwr_info: keeps the device max valid pwm
453  * @urgent_bkops_lvl: keeps track of urgent bkops level for device
454  * @is_urgent_bkops_lvl_checked: keeps track if the urgent bkops level for
455  *  device is known or not.
456  */
457 struct ufs_hba {
458         void __iomem *mmio_base;
459
460         /* Virtual memory reference */
461         struct utp_transfer_cmd_desc *ucdl_base_addr;
462         struct utp_transfer_req_desc *utrdl_base_addr;
463         struct utp_task_req_desc *utmrdl_base_addr;
464
465         /* DMA memory reference */
466         dma_addr_t ucdl_dma_addr;
467         dma_addr_t utrdl_dma_addr;
468         dma_addr_t utmrdl_dma_addr;
469
470         struct Scsi_Host *host;
471         struct device *dev;
472         /*
473          * This field is to keep a reference to "scsi_device" corresponding to
474          * "UFS device" W-LU.
475          */
476         struct scsi_device *sdev_ufs_device;
477
478         enum ufs_dev_pwr_mode curr_dev_pwr_mode;
479         enum uic_link_state uic_link_state;
480         /* Desired UFS power management level during runtime PM */
481         enum ufs_pm_level rpm_lvl;
482         /* Desired UFS power management level during system PM */
483         enum ufs_pm_level spm_lvl;
484         struct device_attribute rpm_lvl_attr;
485         struct device_attribute spm_lvl_attr;
486         int pm_op_in_progress;
487
488         struct ufshcd_lrb *lrb;
489         unsigned long lrb_in_use;
490
491         unsigned long outstanding_tasks;
492         unsigned long outstanding_reqs;
493
494         u32 capabilities;
495         int nutrs;
496         int nutmrs;
497         u32 ufs_version;
498         struct ufs_hba_variant_ops *vops;
499         void *priv;
500         unsigned int irq;
501         bool is_irq_enabled;
502
503         /* Interrupt aggregation support is broken */
504         #define UFSHCD_QUIRK_BROKEN_INTR_AGGR                   UFS_BIT(0)
505
506         /*
507          * delay before each dme command is required as the unipro
508          * layer has shown instabilities
509          */
510         #define UFSHCD_QUIRK_DELAY_BEFORE_DME_CMDS              UFS_BIT(1)
511
512         /*
513          * If UFS host controller is having issue in processing LCC (Line
514          * Control Command) coming from device then enable this quirk.
515          * When this quirk is enabled, host controller driver should disable
516          * the LCC transmission on UFS device (by clearing TX_LCC_ENABLE
517          * attribute of device to 0).
518          */
519         #define UFSHCD_QUIRK_BROKEN_LCC                         UFS_BIT(2)
520
521         /*
522          * The attribute PA_RXHSUNTERMCAP specifies whether or not the
523          * inbound Link supports unterminated line in HS mode. Setting this
524          * attribute to 1 fixes moving to HS gear.
525          */
526         #define UFSHCD_QUIRK_BROKEN_PA_RXHSUNTERMCAP            UFS_BIT(3)
527
528         /*
529          * This quirk needs to be enabled if the host contoller only allows
530          * accessing the peer dme attributes in AUTO mode (FAST AUTO or
531          * SLOW AUTO).
532          */
533         #define UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE          UFS_BIT(4)
534
535         /*
536          * This quirk needs to be enabled if the host contoller doesn't
537          * advertise the correct version in UFS_VER register. If this quirk
538          * is enabled, standard UFS host driver will call the vendor specific
539          * ops (get_ufs_hci_version) to get the correct version.
540          */
541         #define UFSHCD_QUIRK_BROKEN_UFS_HCI_VERSION             UFS_BIT(5)
542
543         /*
544          * This quirk needs to be enabled if the host contoller regards
545          * resolution of the values of PRDTO and PRDTL in UTRD as byte.
546          */
547         #define UFSHCD_QUIRK_PRDT_BYTE_GRAN                     UFS_BIT(7)
548
549         unsigned int quirks;    /* Deviations from standard UFSHCI spec. */
550
551         /* Device deviations from standard UFS device spec. */
552         unsigned int dev_quirks;
553
554         wait_queue_head_t tm_wq;
555         wait_queue_head_t tm_tag_wq;
556         unsigned long tm_condition;
557         unsigned long tm_slots_in_use;
558
559         struct uic_command *active_uic_cmd;
560         struct mutex uic_cmd_mutex;
561         struct completion *uic_async_done;
562
563         u32 ufshcd_state;
564         u32 eh_flags;
565         u32 intr_mask;
566         u16 ee_ctrl_mask;
567         bool is_powered;
568         bool is_init_prefetch;
569         struct ufs_init_prefetch init_prefetch_data;
570
571         /* Work Queues */
572         struct work_struct eh_work;
573         struct work_struct eeh_work;
574
575         /* HBA Errors */
576         u32 errors;
577         u32 uic_error;
578         u32 saved_err;
579         u32 saved_uic_err;
580         struct ufs_stats ufs_stats;
581
582         /* Device management request data */
583         struct ufs_dev_cmd dev_cmd;
584         ktime_t last_dme_cmd_tstamp;
585
586         /* Keeps information of the UFS device connected to this host */
587         struct ufs_dev_info dev_info;
588         bool auto_bkops_enabled;
589         struct ufs_vreg_info vreg_info;
590         struct list_head clk_list_head;
591
592         bool wlun_dev_clr_ua;
593
594         /* Number of lanes available (1 or 2) for Rx/Tx */
595         u32 lanes_per_direction;
596         struct ufs_pa_layer_attr pwr_info;
597         struct ufs_pwr_mode_info max_pwr_info;
598
599         struct ufs_clk_gating clk_gating;
600         /* Control to enable/disable host capabilities */
601         u32 caps;
602         /* Allow dynamic clk gating */
603 #define UFSHCD_CAP_CLK_GATING   (1 << 0)
604         /* Allow hiberb8 with clk gating */
605 #define UFSHCD_CAP_HIBERN8_WITH_CLK_GATING (1 << 1)
606         /* Allow dynamic clk scaling */
607 #define UFSHCD_CAP_CLK_SCALING  (1 << 2)
608         /* Allow auto bkops to enabled during runtime suspend */
609 #define UFSHCD_CAP_AUTO_BKOPS_SUSPEND (1 << 3)
610         /*
611          * This capability allows host controller driver to use the UFS HCI's
612          * interrupt aggregation capability.
613          * CAUTION: Enabling this might reduce overall UFS throughput.
614          */
615 #define UFSHCD_CAP_INTR_AGGR (1 << 4)
616         /*
617          * This capability allows the device auto-bkops to be always enabled
618          * except during suspend (both runtime and suspend).
619          * Enabling this capability means that device will always be allowed
620          * to do background operation when it's active but it might degrade
621          * the performance of ongoing read/write operations.
622          */
623 #define UFSHCD_CAP_KEEP_AUTO_BKOPS_ENABLED_EXCEPT_SUSPEND (1 << 5)
624
625         struct devfreq *devfreq;
626         struct ufs_clk_scaling clk_scaling;
627         bool is_sys_suspended;
628
629         enum bkops_status urgent_bkops_lvl;
630         bool is_urgent_bkops_lvl_checked;
631 };
632
633 /* Returns true if clocks can be gated. Otherwise false */
634 static inline bool ufshcd_is_clkgating_allowed(struct ufs_hba *hba)
635 {
636         return hba->caps & UFSHCD_CAP_CLK_GATING;
637 }
638 static inline bool ufshcd_can_hibern8_during_gating(struct ufs_hba *hba)
639 {
640         return hba->caps & UFSHCD_CAP_HIBERN8_WITH_CLK_GATING;
641 }
642 static inline int ufshcd_is_clkscaling_supported(struct ufs_hba *hba)
643 {
644         return hba->caps & UFSHCD_CAP_CLK_SCALING;
645 }
646 static inline bool ufshcd_can_autobkops_during_suspend(struct ufs_hba *hba)
647 {
648         return hba->caps & UFSHCD_CAP_AUTO_BKOPS_SUSPEND;
649 }
650
651 static inline bool ufshcd_is_intr_aggr_allowed(struct ufs_hba *hba)
652 {
653 /* DWC UFS Core has the Interrupt aggregation feature but is not detectable*/
654 #ifndef CONFIG_SCSI_UFS_DWC
655         if ((hba->caps & UFSHCD_CAP_INTR_AGGR) &&
656             !(hba->quirks & UFSHCD_QUIRK_BROKEN_INTR_AGGR))
657                 return true;
658         else
659                 return false;
660 #else
661 return true;
662 #endif
663 }
664
665 #define ufshcd_writel(hba, val, reg)    \
666         writel((val), (hba)->mmio_base + (reg))
667 #define ufshcd_readl(hba, reg)  \
668         readl((hba)->mmio_base + (reg))
669
670 /**
671  * ufshcd_rmwl - read modify write into a register
672  * @hba - per adapter instance
673  * @mask - mask to apply on read value
674  * @val - actual value to write
675  * @reg - register address
676  */
677 static inline void ufshcd_rmwl(struct ufs_hba *hba, u32 mask, u32 val, u32 reg)
678 {
679         u32 tmp;
680
681         tmp = ufshcd_readl(hba, reg);
682         tmp &= ~mask;
683         tmp |= (val & mask);
684         ufshcd_writel(hba, tmp, reg);
685 }
686
687 int ufshcd_alloc_host(struct device *, struct ufs_hba **);
688 void ufshcd_dealloc_host(struct ufs_hba *);
689 int ufshcd_init(struct ufs_hba * , void __iomem * , unsigned int);
690 void ufshcd_remove(struct ufs_hba *);
691 int ufshcd_wait_for_register(struct ufs_hba *hba, u32 reg, u32 mask,
692                                 u32 val, unsigned long interval_us,
693                                 unsigned long timeout_ms, bool can_sleep);
694
695 static inline void check_upiu_size(void)
696 {
697         BUILD_BUG_ON(ALIGNED_UPIU_SIZE <
698                 GENERAL_UPIU_REQUEST_SIZE + QUERY_DESC_MAX_SIZE);
699 }
700
701 /**
702  * ufshcd_set_variant - set variant specific data to the hba
703  * @hba - per adapter instance
704  * @variant - pointer to variant specific data
705  */
706 static inline void ufshcd_set_variant(struct ufs_hba *hba, void *variant)
707 {
708         BUG_ON(!hba);
709         hba->priv = variant;
710 }
711
712 /**
713  * ufshcd_get_variant - get variant specific data from the hba
714  * @hba - per adapter instance
715  */
716 static inline void *ufshcd_get_variant(struct ufs_hba *hba)
717 {
718         BUG_ON(!hba);
719         return hba->priv;
720 }
721 static inline bool ufshcd_keep_autobkops_enabled_except_suspend(
722                                                         struct ufs_hba *hba)
723 {
724         return hba->caps & UFSHCD_CAP_KEEP_AUTO_BKOPS_ENABLED_EXCEPT_SUSPEND;
725 }
726
727 extern int ufshcd_runtime_suspend(struct ufs_hba *hba);
728 extern int ufshcd_runtime_resume(struct ufs_hba *hba);
729 extern int ufshcd_runtime_idle(struct ufs_hba *hba);
730 extern int ufshcd_system_suspend(struct ufs_hba *hba);
731 extern int ufshcd_system_resume(struct ufs_hba *hba);
732 extern int ufshcd_shutdown(struct ufs_hba *hba);
733 extern int ufshcd_dme_set_attr(struct ufs_hba *hba, u32 attr_sel,
734                                u8 attr_set, u32 mib_val, u8 peer);
735 extern int ufshcd_dme_get_attr(struct ufs_hba *hba, u32 attr_sel,
736                                u32 *mib_val, u8 peer);
737
738 /* UIC command interfaces for DME primitives */
739 #define DME_LOCAL       0
740 #define DME_PEER        1
741 #define ATTR_SET_NOR    0       /* NORMAL */
742 #define ATTR_SET_ST     1       /* STATIC */
743
744 static inline int ufshcd_dme_set(struct ufs_hba *hba, u32 attr_sel,
745                                  u32 mib_val)
746 {
747         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
748                                    mib_val, DME_LOCAL);
749 }
750
751 static inline int ufshcd_dme_st_set(struct ufs_hba *hba, u32 attr_sel,
752                                     u32 mib_val)
753 {
754         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
755                                    mib_val, DME_LOCAL);
756 }
757
758 static inline int ufshcd_dme_peer_set(struct ufs_hba *hba, u32 attr_sel,
759                                       u32 mib_val)
760 {
761         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
762                                    mib_val, DME_PEER);
763 }
764
765 static inline int ufshcd_dme_peer_st_set(struct ufs_hba *hba, u32 attr_sel,
766                                          u32 mib_val)
767 {
768         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
769                                    mib_val, DME_PEER);
770 }
771
772 static inline int ufshcd_dme_get(struct ufs_hba *hba,
773                                  u32 attr_sel, u32 *mib_val)
774 {
775         return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_LOCAL);
776 }
777
778 static inline int ufshcd_dme_peer_get(struct ufs_hba *hba,
779                                       u32 attr_sel, u32 *mib_val)
780 {
781         return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_PEER);
782 }
783
784 static inline bool ufshcd_is_hs_mode(struct ufs_pa_layer_attr *pwr_info)
785 {
786         return (pwr_info->pwr_rx == FAST_MODE ||
787                 pwr_info->pwr_rx == FASTAUTO_MODE) &&
788                 (pwr_info->pwr_tx == FAST_MODE ||
789                 pwr_info->pwr_tx == FASTAUTO_MODE);
790 }
791
792 /* Expose Query-Request API */
793 int ufshcd_query_flag(struct ufs_hba *hba, enum query_opcode opcode,
794         enum flag_idn idn, bool *flag_res);
795 int ufshcd_hold(struct ufs_hba *hba, bool async);
796 void ufshcd_release(struct ufs_hba *hba);
797 u32 ufshcd_get_local_unipro_ver(struct ufs_hba *hba);
798
799 /* Wrapper functions for safely calling variant operations */
800 static inline const char *ufshcd_get_var_name(struct ufs_hba *hba)
801 {
802         if (hba->vops)
803                 return hba->vops->name;
804         return "";
805 }
806
807 static inline int ufshcd_vops_init(struct ufs_hba *hba)
808 {
809         if (hba->vops && hba->vops->init)
810                 return hba->vops->init(hba);
811
812         return 0;
813 }
814
815 static inline void ufshcd_vops_exit(struct ufs_hba *hba)
816 {
817         if (hba->vops && hba->vops->exit)
818                 return hba->vops->exit(hba);
819 }
820
821 static inline u32 ufshcd_vops_get_ufs_hci_version(struct ufs_hba *hba)
822 {
823         if (hba->vops && hba->vops->get_ufs_hci_version)
824                 return hba->vops->get_ufs_hci_version(hba);
825
826         return ufshcd_readl(hba, REG_UFS_VERSION);
827 }
828
829 static inline int ufshcd_vops_clk_scale_notify(struct ufs_hba *hba,
830                         bool up, enum ufs_notify_change_status status)
831 {
832         if (hba->vops && hba->vops->clk_scale_notify)
833                 return hba->vops->clk_scale_notify(hba, up, status);
834         return 0;
835 }
836
837 static inline int ufshcd_vops_setup_clocks(struct ufs_hba *hba, bool on,
838                                         enum ufs_notify_change_status status)
839 {
840         if (hba->vops && hba->vops->setup_clocks)
841                 return hba->vops->setup_clocks(hba, on, status);
842         return 0;
843 }
844
845 static inline int ufshcd_vops_setup_regulators(struct ufs_hba *hba, bool status)
846 {
847         if (hba->vops && hba->vops->setup_regulators)
848                 return hba->vops->setup_regulators(hba, status);
849
850         return 0;
851 }
852
853 static inline int ufshcd_vops_hce_enable_notify(struct ufs_hba *hba,
854                                                 bool status)
855 {
856         if (hba->vops && hba->vops->hce_enable_notify)
857                 return hba->vops->hce_enable_notify(hba, status);
858
859         return 0;
860 }
861 static inline int ufshcd_vops_link_startup_notify(struct ufs_hba *hba,
862                                                 bool status)
863 {
864         if (hba->vops && hba->vops->link_startup_notify)
865                 return hba->vops->link_startup_notify(hba, status);
866
867         return 0;
868 }
869
870 static inline int ufshcd_vops_pwr_change_notify(struct ufs_hba *hba,
871                                   bool status,
872                                   struct ufs_pa_layer_attr *dev_max_params,
873                                   struct ufs_pa_layer_attr *dev_req_params)
874 {
875         if (hba->vops && hba->vops->pwr_change_notify)
876                 return hba->vops->pwr_change_notify(hba, status,
877                                         dev_max_params, dev_req_params);
878
879         return -ENOTSUPP;
880 }
881
882 static inline void ufshcd_vops_setup_xfer_req(struct ufs_hba *hba, int tag,
883                                         bool is_scsi_cmd)
884 {
885         if (hba->vops && hba->vops->setup_xfer_req)
886                 return hba->vops->setup_xfer_req(hba, tag, is_scsi_cmd);
887 }
888
889 static inline void ufshcd_vops_setup_task_mgmt(struct ufs_hba *hba,
890                                         int tag, u8 tm_function)
891 {
892         if (hba->vops && hba->vops->setup_task_mgmt)
893                 return hba->vops->setup_task_mgmt(hba, tag, tm_function);
894 }
895
896 static inline void ufshcd_vops_hibern8_notify(struct ufs_hba *hba,
897                                         enum uic_cmd_dme cmd,
898                                         enum ufs_notify_change_status status)
899 {
900         if (hba->vops && hba->vops->hibern8_notify)
901                 return hba->vops->hibern8_notify(hba, cmd, status);
902 }
903
904 static inline int ufshcd_vops_apply_dev_quirks(struct ufs_hba *hba)
905 {
906         if (hba->vops && hba->vops->apply_dev_quirks)
907                 return hba->vops->apply_dev_quirks(hba);
908         return 0;
909 }
910
911 static inline int ufshcd_vops_suspend(struct ufs_hba *hba, enum ufs_pm_op op)
912 {
913         if (hba->vops && hba->vops->suspend)
914                 return hba->vops->suspend(hba, op);
915
916         return 0;
917 }
918
919 static inline int ufshcd_vops_resume(struct ufs_hba *hba, enum ufs_pm_op op)
920 {
921         if (hba->vops && hba->vops->resume)
922                 return hba->vops->resume(hba, op);
923
924         return 0;
925 }
926
927 static inline void ufshcd_vops_dbg_register_dump(struct ufs_hba *hba)
928 {
929         if (hba->vops && hba->vops->dbg_register_dump)
930                 hba->vops->dbg_register_dump(hba);
931 }
932
933 #endif /* End of Header */