drivers/scsi/ufs/ufshcd.h

   1 /* SPDX-License-Identifier: GPL-2.0-or-later */
   2 /*
   3  * Universal Flash Storage Host controller driver
   4  * Copyright (C) 2011-2013 Samsung India Software Operations
   5  * Copyright (c) 2013-2016, The Linux Foundation. All rights reserved.
   6  *
   7  * Authors:
   8  *      Santosh Yaraganavi <santosh.sy@samsung.com>
   9  *      Vinayak Holikatti <h.vinayak@samsung.com>
  10  */
  11
  12 #ifndef _UFSHCD_H
  13 #define _UFSHCD_H
  14
  15 #include <linux/module.h>
  16 #include <linux/kernel.h>
  17 #include <linux/init.h>
  18 #include <linux/interrupt.h>
  19 #include <linux/io.h>
  20 #include <linux/delay.h>
  21 #include <linux/slab.h>
  22 #include <linux/spinlock.h>
  23 #include <linux/rwsem.h>
  24 #include <linux/workqueue.h>
  25 #include <linux/errno.h>
  26 #include <linux/types.h>
  27 #include <linux/wait.h>
  28 #include <linux/bitops.h>
  29 #include <linux/pm_runtime.h>
  30 #include <linux/clk.h>
  31 #include <linux/completion.h>
  32 #include <linux/regulator/consumer.h>
  33 #include <linux/bitfield.h>
  34 #include <linux/devfreq.h>
  35 #include <linux/keyslot-manager.h>
  36 #include "unipro.h"
  37
  38 #include <asm/irq.h>
  39 #include <asm/byteorder.h>
  40 #include <scsi/scsi.h>
  41 #include <scsi/scsi_cmnd.h>
  42 #include <scsi/scsi_host.h>
  43 #include <scsi/scsi_tcq.h>
  44 #include <scsi/scsi_dbg.h>
  45 #include <scsi/scsi_eh.h>
  46
  47 #include "ufs.h"
  48 #include "ufs_quirks.h"
  49 #include "ufshci.h"
  50
  51 #define UFSHCD "ufshcd"
  52 #define UFSHCD_DRIVER_VERSION "0.2"
  53
  54 struct ufs_hba;
  55
  56 enum dev_cmd_type {
  57         DEV_CMD_TYPE_NOP                = 0x0,
  58         DEV_CMD_TYPE_QUERY              = 0x1,
  59 };
  60
  61 enum ufs_event_type {
  62         /* uic specific errors */
  63         UFS_EVT_PA_ERR = 0,
  64         UFS_EVT_DL_ERR,
  65         UFS_EVT_NL_ERR,
  66         UFS_EVT_TL_ERR,
  67         UFS_EVT_DME_ERR,
  68
  69         /* fatal errors */
  70         UFS_EVT_AUTO_HIBERN8_ERR,
  71         UFS_EVT_FATAL_ERR,
  72         UFS_EVT_LINK_STARTUP_FAIL,
  73         UFS_EVT_RESUME_ERR,
  74         UFS_EVT_SUSPEND_ERR,
  75         UFS_EVT_WL_SUSP_ERR,
  76         UFS_EVT_WL_RES_ERR,
  77
  78         /* abnormal events */
  79         UFS_EVT_DEV_RESET,
  80         UFS_EVT_HOST_RESET,
  81         UFS_EVT_ABORT,
  82
  83         UFS_EVT_CNT,
  84 };
  85
  86 /**
  87  * struct uic_command - UIC command structure
  88  * @command: UIC command
  89  * @argument1: UIC command argument 1
  90  * @argument2: UIC command argument 2
  91  * @argument3: UIC command argument 3
  92  * @cmd_active: Indicate if UIC command is outstanding
  93  * @done: UIC command completion
  94  */
  95 struct uic_command {
  96         u32 command;
  97         u32 argument1;
  98         u32 argument2;
  99         u32 argument3;
 100         int cmd_active;
 101         struct completion done;
 102 };
 103
 104 /* Used to differentiate the power management options */
 105 enum ufs_pm_op {
 106         UFS_RUNTIME_PM,
 107         UFS_SYSTEM_PM,
 108         UFS_SHUTDOWN_PM,
 109 };
 110
 111 /* Host <-> Device UniPro Link state */
 112 enum uic_link_state {
 113         UIC_LINK_OFF_STATE      = 0, /* Link powered down or disabled */
 114         UIC_LINK_ACTIVE_STATE   = 1, /* Link is in Fast/Slow/Sleep state */
 115         UIC_LINK_HIBERN8_STATE  = 2, /* Link is in Hibernate state */
 116         UIC_LINK_BROKEN_STATE   = 3, /* Link is in broken 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_is_link_broken(hba) ((hba)->uic_link_state == \
 125                                    UIC_LINK_BROKEN_STATE)
 126 #define ufshcd_set_link_off(hba) ((hba)->uic_link_state = UIC_LINK_OFF_STATE)
 127 #define ufshcd_set_link_active(hba) ((hba)->uic_link_state = \
 128                                     UIC_LINK_ACTIVE_STATE)
 129 #define ufshcd_set_link_hibern8(hba) ((hba)->uic_link_state = \
 130                                     UIC_LINK_HIBERN8_STATE)
 131 #define ufshcd_set_link_broken(hba) ((hba)->uic_link_state = \
 132                                     UIC_LINK_BROKEN_STATE)
 133
 134 #define ufshcd_set_ufs_dev_active(h) \
 135         ((h)->curr_dev_pwr_mode = UFS_ACTIVE_PWR_MODE)
 136 #define ufshcd_set_ufs_dev_sleep(h) \
 137         ((h)->curr_dev_pwr_mode = UFS_SLEEP_PWR_MODE)
 138 #define ufshcd_set_ufs_dev_poweroff(h) \
 139         ((h)->curr_dev_pwr_mode = UFS_POWERDOWN_PWR_MODE)
 140 #define ufshcd_set_ufs_dev_deepsleep(h) \
 141         ((h)->curr_dev_pwr_mode = UFS_DEEPSLEEP_PWR_MODE)
 142 #define ufshcd_is_ufs_dev_active(h) \
 143         ((h)->curr_dev_pwr_mode == UFS_ACTIVE_PWR_MODE)
 144 #define ufshcd_is_ufs_dev_sleep(h) \
 145         ((h)->curr_dev_pwr_mode == UFS_SLEEP_PWR_MODE)
 146 #define ufshcd_is_ufs_dev_poweroff(h) \
 147         ((h)->curr_dev_pwr_mode == UFS_POWERDOWN_PWR_MODE)
 148 #define ufshcd_is_ufs_dev_deepsleep(h) \
 149         ((h)->curr_dev_pwr_mode == UFS_DEEPSLEEP_PWR_MODE)
 150
 151 /*
 152  * UFS Power management levels.
 153  * Each level is in increasing order of power savings, except DeepSleep
 154  * which is lower than PowerDown with power on but not PowerDown with
 155  * power off.
 156  */
 157 enum ufs_pm_level {
 158         UFS_PM_LVL_0,
 159         UFS_PM_LVL_1,
 160         UFS_PM_LVL_2,
 161         UFS_PM_LVL_3,
 162         UFS_PM_LVL_4,
 163         UFS_PM_LVL_5,
 164         UFS_PM_LVL_6,
 165         UFS_PM_LVL_MAX
 166 };
 167
 168 struct ufs_pm_lvl_states {
 169         enum ufs_dev_pwr_mode dev_state;
 170         enum uic_link_state link_state;
 171 };
 172
 173 /**
 174  * struct ufshcd_lrb - local reference block
 175  * @utr_descriptor_ptr: UTRD address of the command
 176  * @ucd_req_ptr: UCD address of the command
 177  * @ucd_rsp_ptr: Response UPIU address for this command
 178  * @ucd_prdt_ptr: PRDT address of the command
 179  * @utrd_dma_addr: UTRD dma address for debug
 180  * @ucd_prdt_dma_addr: PRDT dma address for debug
 181  * @ucd_rsp_dma_addr: UPIU response dma address for debug
 182  * @ucd_req_dma_addr: UPIU request dma address for debug
 183  * @cmd: pointer to SCSI command
 184  * @sense_buffer: pointer to sense buffer address of the SCSI command
 185  * @sense_bufflen: Length of the sense buffer
 186  * @scsi_status: SCSI status of the command
 187  * @command_type: SCSI, UFS, Query.
 188  * @task_tag: Task tag of the command
 189  * @lun: LUN of the command
 190  * @intr_cmd: Interrupt command (doesn't participate in interrupt aggregation)
 191  * @issue_time_stamp: time stamp for debug purposes
 192  * @compl_time_stamp: time stamp for statistics
 193  * @crypto_key_slot: the key slot to use for inline crypto (-1 if none)
 194  * @data_unit_num: the data unit number for the first block for inline crypto
 195  * @req_abort_skip: skip request abort task flag
 196  */
 197 struct ufshcd_lrb {
 198         struct utp_transfer_req_desc *utr_descriptor_ptr;
 199         struct utp_upiu_req *ucd_req_ptr;
 200         struct utp_upiu_rsp *ucd_rsp_ptr;
 201         struct ufshcd_sg_entry *ucd_prdt_ptr;
 202
 203         dma_addr_t utrd_dma_addr;
 204         dma_addr_t ucd_req_dma_addr;
 205         dma_addr_t ucd_rsp_dma_addr;
 206         dma_addr_t ucd_prdt_dma_addr;
 207
 208         struct scsi_cmnd *cmd;
 209         u8 *sense_buffer;
 210         unsigned int sense_bufflen;
 211         int scsi_status;
 212
 213         int command_type;
 214         int task_tag;
 215         u8 lun; /* UPIU LUN id field is only 8-bit wide */
 216         bool intr_cmd;
 217         ktime_t issue_time_stamp;
 218         ktime_t compl_time_stamp;
 219 #ifdef CONFIG_SCSI_UFS_CRYPTO
 220         int crypto_key_slot;
 221         u64 data_unit_num;
 222 #endif
 223
 224         bool req_abort_skip;
 225 };
 226
 227 /**
 228  * struct ufs_query - holds relevant data structures for query request
 229  * @request: request upiu and function
 230  * @descriptor: buffer for sending/receiving descriptor
 231  * @response: response upiu and response
 232  */
 233 struct ufs_query {
 234         struct ufs_query_req request;
 235         u8 *descriptor;
 236         struct ufs_query_res response;
 237 };
 238
 239 /**
 240  * struct ufs_dev_cmd - all assosiated fields with device management commands
 241  * @type: device management command type - Query, NOP OUT
 242  * @lock: lock to allow one command at a time
 243  * @complete: internal commands completion
 244  */
 245 struct ufs_dev_cmd {
 246         enum dev_cmd_type type;
 247         struct mutex lock;
 248         struct completion *complete;
 249         struct ufs_query query;
 250 };
 251
 252 /**
 253  * struct ufs_clk_info - UFS clock related info
 254  * @list: list headed by hba->clk_list_head
 255  * @clk: clock node
 256  * @name: clock name
 257  * @max_freq: maximum frequency supported by the clock
 258  * @min_freq: min frequency that can be used for clock scaling
 259  * @curr_freq: indicates the current frequency that it is set to
 260  * @keep_link_active: indicates that the clk should not be disabled if
 261                       link is active
 262  * @enabled: variable to check against multiple enable/disable
 263  */
 264 struct ufs_clk_info {
 265         struct list_head list;
 266         struct clk *clk;
 267         const char *name;
 268         u32 max_freq;
 269         u32 min_freq;
 270         u32 curr_freq;
 271         bool keep_link_active;
 272         bool enabled;
 273 };
 274
 275 enum ufs_notify_change_status {
 276         PRE_CHANGE,
 277         POST_CHANGE,
 278 };
 279
 280 struct ufs_pa_layer_attr {
 281         u32 gear_rx;
 282         u32 gear_tx;
 283         u32 lane_rx;
 284         u32 lane_tx;
 285         u32 pwr_rx;
 286         u32 pwr_tx;
 287         u32 hs_rate;
 288 };
 289
 290 struct ufs_pwr_mode_info {
 291         bool is_valid;
 292         struct ufs_pa_layer_attr info;
 293 };
 294
 295 /**
 296  * struct ufs_hba_variant_ops - variant specific callbacks
 297  * @name: variant name
 298  * @init: called when the driver is initialized
 299  * @exit: called to cleanup everything done in init
 300  * @get_ufs_hci_version: called to get UFS HCI version
 301  * @clk_scale_notify: notifies that clks are scaled up/down
 302  * @setup_clocks: called before touching any of the controller registers
 303  * @hce_enable_notify: called before and after HCE enable bit is set to allow
 304  *                     variant specific Uni-Pro initialization.
 305  * @link_startup_notify: called before and after Link startup is carried out
 306  *                       to allow variant specific Uni-Pro initialization.
 307  * @pwr_change_notify: called before and after a power mode change
 308  *                      is carried out to allow vendor spesific capabilities
 309  *                      to be set.
 310  * @setup_xfer_req: called before any transfer request is issued
 311  *                  to set some things
 312  * @setup_task_mgmt: called before any task management request is issued
 313  *                  to set some things
 314  * @hibern8_notify: called around hibern8 enter/exit
 315  * @apply_dev_quirks: called to apply device specific quirks
 316  * @suspend: called during host controller PM callback
 317  * @resume: called during host controller PM callback
 318  * @dbg_register_dump: used to dump controller debug information
 319  * @phy_initialization: used to initialize phys
 320  * @device_reset: called to issue a reset pulse on the UFS device
 321  * @program_key: program or evict an inline encryption key
 322  * @event_notify: called to notify important events
 323  */
 324 struct ufs_hba_variant_ops {
 325         const char *name;
 326         int     (*init)(struct ufs_hba *);
 327         void    (*exit)(struct ufs_hba *);
 328         u32     (*get_ufs_hci_version)(struct ufs_hba *);
 329         int     (*clk_scale_notify)(struct ufs_hba *, bool,
 330                                     enum ufs_notify_change_status);
 331         int     (*setup_clocks)(struct ufs_hba *, bool,
 332                                 enum ufs_notify_change_status);
 333         int     (*hce_enable_notify)(struct ufs_hba *,
 334                                      enum ufs_notify_change_status);
 335         int     (*link_startup_notify)(struct ufs_hba *,
 336                                        enum ufs_notify_change_status);
 337         int     (*pwr_change_notify)(struct ufs_hba *,
 338                                         enum ufs_notify_change_status status,
 339                                         struct ufs_pa_layer_attr *,
 340                                         struct ufs_pa_layer_attr *);
 341         void    (*setup_xfer_req)(struct ufs_hba *, int, bool);
 342         void    (*setup_task_mgmt)(struct ufs_hba *, int, u8);
 343         void    (*hibern8_notify)(struct ufs_hba *, enum uic_cmd_dme,
 344                                         enum ufs_notify_change_status);
 345         int     (*apply_dev_quirks)(struct ufs_hba *hba);
 346         void    (*fixup_dev_quirks)(struct ufs_hba *hba);
 347         int     (*suspend)(struct ufs_hba *, enum ufs_pm_op);
 348         int     (*resume)(struct ufs_hba *, enum ufs_pm_op);
 349         void    (*dbg_register_dump)(struct ufs_hba *hba);
 350         int     (*phy_initialization)(struct ufs_hba *);
 351         int     (*device_reset)(struct ufs_hba *hba);
 352         void    (*config_scaling_param)(struct ufs_hba *hba,
 353                                         struct devfreq_dev_profile *profile,
 354                                         void *data);
 355         int     (*program_key)(struct ufs_hba *hba,
 356                                const union ufs_crypto_cfg_entry *cfg, int slot);
 357         void    (*event_notify)(struct ufs_hba *hba,
 358                                 enum ufs_event_type evt, void *data);
 359 };
 360
 361 /* clock gating state  */
 362 enum clk_gating_state {
 363         CLKS_OFF,
 364         CLKS_ON,
 365         REQ_CLKS_OFF,
 366         REQ_CLKS_ON,
 367 };
 368
 369 /**
 370  * struct ufs_clk_gating - UFS clock gating related info
 371  * @gate_work: worker to turn off clocks after some delay as specified in
 372  * delay_ms
 373  * @ungate_work: worker to turn on clocks that will be used in case of
 374  * interrupt context
 375  * @state: the current clocks state
 376  * @delay_ms: gating delay in ms
 377  * @is_suspended: clk gating is suspended when set to 1 which can be used
 378  * during suspend/resume
 379  * @delay_attr: sysfs attribute to control delay_attr
 380  * @enable_attr: sysfs attribute to enable/disable clock gating
 381  * @is_enabled: Indicates the current status of clock gating
 382  * @is_initialized: Indicates whether clock gating is initialized or not
 383  * @active_reqs: number of requests that are pending and should be waited for
 384  * completion before gating clocks.
 385  */
 386 struct ufs_clk_gating {
 387         struct delayed_work gate_work;
 388         struct work_struct ungate_work;
 389         enum clk_gating_state state;
 390         unsigned long delay_ms;
 391         bool is_suspended;
 392         struct device_attribute delay_attr;
 393         struct device_attribute enable_attr;
 394         bool is_enabled;
 395         bool is_initialized;
 396         int active_reqs;
 397         struct workqueue_struct *clk_gating_workq;
 398 };
 399
 400 struct ufs_saved_pwr_info {
 401         struct ufs_pa_layer_attr info;
 402         bool is_valid;
 403 };
 404
 405 /**
 406  * struct ufs_clk_scaling - UFS clock scaling related data
 407  * @active_reqs: number of requests that are pending. If this is zero when
 408  * devfreq ->target() function is called then schedule "suspend_work" to
 409  * suspend devfreq.
 410  * @tot_busy_t: Total busy time in current polling window
 411  * @window_start_t: Start time (in jiffies) of the current polling window
 412  * @busy_start_t: Start time of current busy period
 413  * @enable_attr: sysfs attribute to enable/disable clock scaling
 414  * @saved_pwr_info: UFS power mode may also be changed during scaling and this
 415  * one keeps track of previous power mode.
 416  * @workq: workqueue to schedule devfreq suspend/resume work
 417  * @suspend_work: worker to suspend devfreq
 418  * @resume_work: worker to resume devfreq
 419  * @min_gear: lowest HS gear to scale down to
 420  * @is_enabled: tracks if scaling is currently enabled or not, controlled by
 421                 clkscale_enable sysfs node
 422  * @is_allowed: tracks if scaling is currently allowed or not, used to block
 423                 clock scaling which is not invoked from devfreq governor
 424  * @is_initialized: Indicates whether clock scaling is initialized or not
 425  * @is_busy_started: tracks if busy period has started or not
 426  * @is_suspended: tracks if devfreq is suspended or not
 427  */
 428 struct ufs_clk_scaling {
 429         int active_reqs;
 430         unsigned long tot_busy_t;
 431         ktime_t window_start_t;
 432         ktime_t busy_start_t;
 433         struct device_attribute enable_attr;
 434         struct ufs_saved_pwr_info saved_pwr_info;
 435         struct workqueue_struct *workq;
 436         struct work_struct suspend_work;
 437         struct work_struct resume_work;
 438         u32 min_gear;
 439         bool is_enabled;
 440         bool is_allowed;
 441         bool is_initialized;
 442         bool is_busy_started;
 443         bool is_suspended;
 444 };
 445
 446 #define UFS_EVENT_HIST_LENGTH 8
 447 /**
 448  * struct ufs_event_hist - keeps history of errors
 449  * @pos: index to indicate cyclic buffer position
 450  * @reg: cyclic buffer for registers value
 451  * @tstamp: cyclic buffer for time stamp
 452  * @cnt: error counter
 453  */
 454 struct ufs_event_hist {
 455         int pos;
 456         u32 val[UFS_EVENT_HIST_LENGTH];
 457         ktime_t tstamp[UFS_EVENT_HIST_LENGTH];
 458         unsigned long long cnt;
 459 };
 460
 461 /**
 462  * struct ufs_stats - keeps usage/err statistics
 463  * @last_intr_status: record the last interrupt status.
 464  * @last_intr_ts: record the last interrupt timestamp.
 465  * @hibern8_exit_cnt: Counter to keep track of number of exits,
 466  *              reset this after link-startup.
 467  * @last_hibern8_exit_tstamp: Set time after the hibern8 exit.
 468  *              Clear after the first successful command completion.
 469  */
 470 struct ufs_stats {
 471         u32 last_intr_status;
 472         ktime_t last_intr_ts;
 473
 474         u32 hibern8_exit_cnt;
 475         ktime_t last_hibern8_exit_tstamp;
 476         struct ufs_event_hist event[UFS_EVT_CNT];
 477 };
 478
 479 enum ufshcd_quirks {
 480         /* Interrupt aggregation support is broken */
 481         UFSHCD_QUIRK_BROKEN_INTR_AGGR                   = 1 << 0,
 482
 483         /*
 484          * delay before each dme command is required as the unipro
 485          * layer has shown instabilities
 486          */
 487         UFSHCD_QUIRK_DELAY_BEFORE_DME_CMDS              = 1 << 1,
 488
 489         /*
 490          * If UFS host controller is having issue in processing LCC (Line
 491          * Control Command) coming from device then enable this quirk.
 492          * When this quirk is enabled, host controller driver should disable
 493          * the LCC transmission on UFS device (by clearing TX_LCC_ENABLE
 494          * attribute of device to 0).
 495          */
 496         UFSHCD_QUIRK_BROKEN_LCC                         = 1 << 2,
 497
 498         /*
 499          * The attribute PA_RXHSUNTERMCAP specifies whether or not the
 500          * inbound Link supports unterminated line in HS mode. Setting this
 501          * attribute to 1 fixes moving to HS gear.
 502          */
 503         UFSHCD_QUIRK_BROKEN_PA_RXHSUNTERMCAP            = 1 << 3,
 504
 505         /*
 506          * This quirk needs to be enabled if the host controller only allows
 507          * accessing the peer dme attributes in AUTO mode (FAST AUTO or
 508          * SLOW AUTO).
 509          */
 510         UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE          = 1 << 4,
 511
 512         /*
 513          * This quirk needs to be enabled if the host controller doesn't
 514          * advertise the correct version in UFS_VER register. If this quirk
 515          * is enabled, standard UFS host driver will call the vendor specific
 516          * ops (get_ufs_hci_version) to get the correct version.
 517          */
 518         UFSHCD_QUIRK_BROKEN_UFS_HCI_VERSION             = 1 << 5,
 519
 520         /*
 521          * Clear handling for transfer/task request list is just opposite.
 522          */
 523         UFSHCI_QUIRK_BROKEN_REQ_LIST_CLR                = 1 << 6,
 524
 525         /*
 526          * This quirk needs to be enabled if host controller doesn't allow
 527          * that the interrupt aggregation timer and counter are reset by s/w.
 528          */
 529         UFSHCI_QUIRK_SKIP_RESET_INTR_AGGR               = 1 << 7,
 530
 531         /*
 532          * This quirks needs to be enabled if host controller cannot be
 533          * enabled via HCE register.
 534          */
 535         UFSHCI_QUIRK_BROKEN_HCE                         = 1 << 8,
 536
 537         /*
 538          * This quirk needs to be enabled if the host controller regards
 539          * resolution of the values of PRDTO and PRDTL in UTRD as byte.
 540          */
 541         UFSHCD_QUIRK_PRDT_BYTE_GRAN                     = 1 << 9,
 542
 543         /*
 544          * This quirk needs to be enabled if the host controller reports
 545          * OCS FATAL ERROR with device error through sense data
 546          */
 547         UFSHCD_QUIRK_BROKEN_OCS_FATAL_ERROR             = 1 << 10,
 548
 549         /*
 550          * This quirk needs to be enabled if the host controller has
 551          * auto-hibernate capability but it doesn't work.
 552          */
 553         UFSHCD_QUIRK_BROKEN_AUTO_HIBERN8                = 1 << 11,
 554
 555         /*
 556          * This quirk needs to disable manual flush for write booster
 557          */
 558         UFSHCI_QUIRK_SKIP_MANUAL_WB_FLUSH_CTRL          = 1 << 12,
 559
 560         /*
 561          * This quirk needs to disable unipro timeout values
 562          * before power mode change
 563          */
 564         UFSHCD_QUIRK_SKIP_DEF_UNIPRO_TIMEOUT_SETTING = 1 << 13,
 565
 566         /*
 567          * This quirk allows only sg entries aligned with page size.
 568          */
 569         UFSHCD_QUIRK_ALIGN_SG_WITH_PAGE_SIZE            = 1 << 14,
 570 };
 571
 572 enum ufshcd_caps {
 573         /* Allow dynamic clk gating */
 574         UFSHCD_CAP_CLK_GATING                           = 1 << 0,
 575
 576         /* Allow hiberb8 with clk gating */
 577         UFSHCD_CAP_HIBERN8_WITH_CLK_GATING              = 1 << 1,
 578
 579         /* Allow dynamic clk scaling */
 580         UFSHCD_CAP_CLK_SCALING                          = 1 << 2,
 581
 582         /* Allow auto bkops to enabled during runtime suspend */
 583         UFSHCD_CAP_AUTO_BKOPS_SUSPEND                   = 1 << 3,
 584
 585         /*
 586          * This capability allows host controller driver to use the UFS HCI's
 587          * interrupt aggregation capability.
 588          * CAUTION: Enabling this might reduce overall UFS throughput.
 589          */
 590         UFSHCD_CAP_INTR_AGGR                            = 1 << 4,
 591
 592         /*
 593          * This capability allows the device auto-bkops to be always enabled
 594          * except during suspend (both runtime and suspend).
 595          * Enabling this capability means that device will always be allowed
 596          * to do background operation when it's active but it might degrade
 597          * the performance of ongoing read/write operations.
 598          */
 599         UFSHCD_CAP_KEEP_AUTO_BKOPS_ENABLED_EXCEPT_SUSPEND = 1 << 5,
 600
 601         /*
 602          * This capability allows host controller driver to automatically
 603          * enable runtime power management by itself instead of waiting
 604          * for userspace to control the power management.
 605          */
 606         UFSHCD_CAP_RPM_AUTOSUSPEND                      = 1 << 6,
 607
 608         /*
 609          * This capability allows the host controller driver to turn-on
 610          * WriteBooster, if the underlying device supports it and is
 611          * provisioned to be used. This would increase the write performance.
 612          */
 613         UFSHCD_CAP_WB_EN                                = 1 << 7,
 614
 615         /*
 616          * This capability allows the host controller driver to use the
 617          * inline crypto engine, if it is present
 618          */
 619         UFSHCD_CAP_CRYPTO                               = 1 << 8,
 620
 621         /*
 622          * This capability allows the controller regulators to be put into
 623          * lpm mode aggressively during clock gating.
 624          * This would increase power savings.
 625          */
 626         UFSHCD_CAP_AGGR_POWER_COLLAPSE                  = 1 << 9,
 627
 628         /*
 629          * This capability allows the host controller driver to use DeepSleep,
 630          * if it is supported by the UFS device. The host controller driver must
 631          * support device hardware reset via the hba->device_reset() callback,
 632          * in order to exit DeepSleep state.
 633          */
 634         UFSHCD_CAP_DEEPSLEEP                            = 1 << 10,
 635 };
 636
 637 struct ufs_hba_variant_params {
 638         struct devfreq_dev_profile devfreq_profile;
 639         struct devfreq_simple_ondemand_data ondemand_data;
 640         u16 hba_enable_delay_us;
 641         u32 wb_flush_threshold;
 642 };
 643
 644 #ifdef CONFIG_SCSI_UFS_HPB
 645 /**
 646  * struct ufshpb_dev_info - UFSHPB device related info
 647  * @num_lu: the number of user logical unit to check whether all lu finished
 648  *          initialization
 649  * @rgn_size: device reported HPB region size
 650  * @srgn_size: device reported HPB sub-region size
 651  * @slave_conf_cnt: counter to check all lu finished initialization
 652  * @hpb_disabled: flag to check if HPB is disabled
 653  * @max_hpb_single_cmd: device reported bMAX_DATA_SIZE_FOR_SINGLE_CMD value
 654  * @is_legacy: flag to check HPB 1.0
 655  * @control_mode: either host or device
 656  */
 657 struct ufshpb_dev_info {
 658         int num_lu;
 659         int rgn_size;
 660         int srgn_size;
 661         atomic_t slave_conf_cnt;
 662         bool hpb_disabled;
 663         u8 max_hpb_single_cmd;
 664         bool is_legacy;
 665         u8 control_mode;
 666 };
 667 #endif
 668
 669 struct ufs_hba_monitor {
 670         unsigned long chunk_size;
 671
 672         unsigned long nr_sec_rw[2];
 673         ktime_t total_busy[2];
 674
 675         unsigned long nr_req[2];
 676         /* latencies*/
 677         ktime_t lat_sum[2];
 678         ktime_t lat_max[2];
 679         ktime_t lat_min[2];
 680
 681         u32 nr_queued[2];
 682         ktime_t busy_start_ts[2];
 683
 684         ktime_t enabled_ts;
 685         bool enabled;
 686 };
 687
 688 /**
 689  * struct ufs_hba - per adapter private structure
 690  * @mmio_base: UFSHCI base register address
 691  * @ucdl_base_addr: UFS Command Descriptor base address
 692  * @utrdl_base_addr: UTP Transfer Request Descriptor base address
 693  * @utmrdl_base_addr: UTP Task Management Descriptor base address
 694  * @ucdl_dma_addr: UFS Command Descriptor DMA address
 695  * @utrdl_dma_addr: UTRDL DMA address
 696  * @utmrdl_dma_addr: UTMRDL DMA address
 697  * @host: Scsi_Host instance of the driver
 698  * @dev: device handle
 699  * @lrb: local reference block
 700  * @cmd_queue: Used to allocate command tags from hba->host->tag_set.
 701  * @outstanding_tasks: Bits representing outstanding task requests
 702  * @outstanding_reqs: Bits representing outstanding transfer requests
 703  * @capabilities: UFS Controller Capabilities
 704  * @nutrs: Transfer Request Queue depth supported by controller
 705  * @nutmrs: Task Management Queue depth supported by controller
 706  * @ufs_version: UFS Version to which controller complies
 707  * @vops: pointer to variant specific operations
 708  * @priv: pointer to variant specific private data
 709  * @irq: Irq number of the controller
 710  * @active_uic_cmd: handle of active UIC command
 711  * @uic_cmd_mutex: mutex for uic command
 712  * @tmf_tag_set: TMF tag set.
 713  * @tmf_queue: Used to allocate TMF tags.
 714  * @pwr_done: completion for power mode change
 715  * @ufshcd_state: UFSHCD states
 716  * @eh_flags: Error handling flags
 717  * @intr_mask: Interrupt Mask Bits
 718  * @ee_ctrl_mask: Exception event control mask
 719  * @is_powered: flag to check if HBA is powered
 720  * @shutting_down: flag to check if shutdown has been invoked
 721  * @host_sem: semaphore used to serialize concurrent contexts
 722  * @eh_wq: Workqueue that eh_work works on
 723  * @eh_work: Worker to handle UFS errors that require s/w attention
 724  * @eeh_work: Worker to handle exception events
 725  * @errors: HBA errors
 726  * @uic_error: UFS interconnect layer error status
 727  * @saved_err: sticky error mask
 728  * @saved_uic_err: sticky UIC error mask
 729  * @force_reset: flag to force eh_work perform a full reset
 730  * @force_pmc: flag to force a power mode change
 731  * @silence_err_logs: flag to silence error logs
 732  * @dev_cmd: ufs device management command information
 733  * @last_dme_cmd_tstamp: time stamp of the last completed DME command
 734  * @auto_bkops_enabled: to track whether bkops is enabled in device
 735  * @vreg_info: UFS device voltage regulator information
 736  * @clk_list_head: UFS host controller clocks list node head
 737  * @pwr_info: holds current power mode
 738  * @max_pwr_info: keeps the device max valid pwm
 739  * @desc_size: descriptor sizes reported by device
 740  * @urgent_bkops_lvl: keeps track of urgent bkops level for device
 741  * @is_urgent_bkops_lvl_checked: keeps track if the urgent bkops level for
 742  *  device is known or not.
 743  * @scsi_block_reqs_cnt: reference counting for scsi block requests
 744  * @crypto_capabilities: Content of crypto capabilities register (0x100)
 745  * @crypto_cap_array: Array of crypto capabilities
 746  * @crypto_cfg_register: Start of the crypto cfg array
 747  * @ksm: the keyslot manager tied to this hba
 748  */
 749 struct ufs_hba {
 750         void __iomem *mmio_base;
 751
 752         /* Virtual memory reference */
 753         struct utp_transfer_cmd_desc *ucdl_base_addr;
 754         struct utp_transfer_req_desc *utrdl_base_addr;
 755         struct utp_task_req_desc *utmrdl_base_addr;
 756
 757         /* DMA memory reference */
 758         dma_addr_t ucdl_dma_addr;
 759         dma_addr_t utrdl_dma_addr;
 760         dma_addr_t utmrdl_dma_addr;
 761
 762         struct Scsi_Host *host;
 763         struct device *dev;
 764         struct request_queue *cmd_queue;
 765         /*
 766          * This field is to keep a reference to "scsi_device" corresponding to
 767          * "UFS device" W-LU.
 768          */
 769         struct scsi_device *sdev_ufs_device;
 770         struct scsi_device *sdev_rpmb;
 771
 772         enum ufs_dev_pwr_mode curr_dev_pwr_mode;
 773         enum uic_link_state uic_link_state;
 774         /* Desired UFS power management level during runtime PM */
 775         enum ufs_pm_level rpm_lvl;
 776         /* Desired UFS power management level during system PM */
 777         enum ufs_pm_level spm_lvl;
 778         struct device_attribute rpm_lvl_attr;
 779         struct device_attribute spm_lvl_attr;
 780         int pm_op_in_progress;
 781
 782         /* Auto-Hibernate Idle Timer register value */
 783         u32 ahit;
 784
 785         struct ufshcd_lrb *lrb;
 786
 787         unsigned long outstanding_tasks;
 788         unsigned long outstanding_reqs;
 789
 790         u32 capabilities;
 791         int nutrs;
 792         int nutmrs;
 793         u32 ufs_version;
 794         const struct ufs_hba_variant_ops *vops;
 795         struct ufs_hba_variant_params *vps;
 796         void *priv;
 797         unsigned int irq;
 798         bool is_irq_enabled;
 799         enum ufs_ref_clk_freq dev_ref_clk_freq;
 800
 801         unsigned int quirks;    /* Deviations from standard UFSHCI spec. */
 802
 803         /* Device deviations from standard UFS device spec. */
 804         unsigned int dev_quirks;
 805
 806         struct blk_mq_tag_set tmf_tag_set;
 807         struct request_queue *tmf_queue;
 808
 809         struct uic_command *active_uic_cmd;
 810         struct mutex uic_cmd_mutex;
 811         struct completion *uic_async_done;
 812
 813         u32 ufshcd_state;
 814         u32 eh_flags;
 815         u32 intr_mask;
 816         u16 ee_ctrl_mask; /* Exception event mask */
 817         u16 ee_drv_mask;  /* Exception event mask for driver */
 818         u16 ee_usr_mask;  /* Exception event mask for user (via debugfs) */
 819         struct mutex ee_ctrl_mutex;
 820         bool is_powered;
 821         bool shutting_down;
 822         struct semaphore host_sem;
 823
 824         /* Work Queues */
 825         struct workqueue_struct *eh_wq;
 826         struct work_struct eh_work;
 827         struct work_struct eeh_work;
 828
 829         /* HBA Errors */
 830         u32 errors;
 831         u32 uic_error;
 832         u32 saved_err;
 833         u32 saved_uic_err;
 834         struct ufs_stats ufs_stats;
 835         bool force_reset;
 836         bool force_pmc;
 837         bool silence_err_logs;
 838
 839         /* Device management request data */
 840         struct ufs_dev_cmd dev_cmd;
 841         ktime_t last_dme_cmd_tstamp;
 842
 843         /* Keeps information of the UFS device connected to this host */
 844         struct ufs_dev_info dev_info;
 845         bool auto_bkops_enabled;
 846         struct ufs_vreg_info vreg_info;
 847         struct list_head clk_list_head;
 848
 849         bool wlun_dev_clr_ua;
 850         bool wlun_rpmb_clr_ua;
 851
 852         /* Number of requests aborts */
 853         int req_abort_count;
 854
 855         /* Number of lanes available (1 or 2) for Rx/Tx */
 856         u32 lanes_per_direction;
 857         struct ufs_pa_layer_attr pwr_info;
 858         struct ufs_pwr_mode_info max_pwr_info;
 859
 860         struct ufs_clk_gating clk_gating;
 861         /* Control to enable/disable host capabilities */
 862         u32 caps;
 863
 864         struct devfreq *devfreq;
 865         struct ufs_clk_scaling clk_scaling;
 866         bool is_sys_suspended;
 867
 868         enum bkops_status urgent_bkops_lvl;
 869         bool is_urgent_bkops_lvl_checked;
 870
 871         struct rw_semaphore clk_scaling_lock;
 872         unsigned char desc_size[QUERY_DESC_IDN_MAX];
 873         atomic_t scsi_block_reqs_cnt;
 874
 875         struct device           bsg_dev;
 876         struct request_queue    *bsg_queue;
 877         struct delayed_work rpm_dev_flush_recheck_work;
 878
 879 #ifdef CONFIG_SCSI_UFS_HPB
 880         struct ufshpb_dev_info ufshpb_dev;
 881 #endif
 882
 883         struct ufs_hba_monitor  monitor;
 884
 885 #ifdef CONFIG_SCSI_UFS_CRYPTO
 886         union ufs_crypto_capabilities crypto_capabilities;
 887         union ufs_crypto_cap_entry *crypto_cap_array;
 888         u32 crypto_cfg_register;
 889         struct blk_keyslot_manager ksm;
 890 #endif
 891 #ifdef CONFIG_DEBUG_FS
 892         struct dentry *debugfs_root;
 893         struct delayed_work debugfs_ee_work;
 894         u32 debugfs_ee_rate_limit_ms;
 895 #endif
 896         u32 luns_avail;
 897         bool complete_put;
 898         bool rpmb_complete_put;
 899 };
 900
 901 /* Returns true if clocks can be gated. Otherwise false */
 902 static inline bool ufshcd_is_clkgating_allowed(struct ufs_hba *hba)
 903 {
 904         return hba->caps & UFSHCD_CAP_CLK_GATING;
 905 }
 906 static inline bool ufshcd_can_hibern8_during_gating(struct ufs_hba *hba)
 907 {
 908         return hba->caps & UFSHCD_CAP_HIBERN8_WITH_CLK_GATING;
 909 }
 910 static inline int ufshcd_is_clkscaling_supported(struct ufs_hba *hba)
 911 {
 912         return hba->caps & UFSHCD_CAP_CLK_SCALING;
 913 }
 914 static inline bool ufshcd_can_autobkops_during_suspend(struct ufs_hba *hba)
 915 {
 916         return hba->caps & UFSHCD_CAP_AUTO_BKOPS_SUSPEND;
 917 }
 918 static inline bool ufshcd_is_rpm_autosuspend_allowed(struct ufs_hba *hba)
 919 {
 920         return hba->caps & UFSHCD_CAP_RPM_AUTOSUSPEND;
 921 }
 922
 923 static inline bool ufshcd_is_intr_aggr_allowed(struct ufs_hba *hba)
 924 {
 925         return (hba->caps & UFSHCD_CAP_INTR_AGGR) &&
 926                 !(hba->quirks & UFSHCD_QUIRK_BROKEN_INTR_AGGR);
 927 }
 928
 929 static inline bool ufshcd_can_aggressive_pc(struct ufs_hba *hba)
 930 {
 931         return !!(ufshcd_is_link_hibern8(hba) &&
 932                   (hba->caps & UFSHCD_CAP_AGGR_POWER_COLLAPSE));
 933 }
 934
 935 static inline bool ufshcd_is_auto_hibern8_supported(struct ufs_hba *hba)
 936 {
 937         return (hba->capabilities & MASK_AUTO_HIBERN8_SUPPORT) &&
 938                 !(hba->quirks & UFSHCD_QUIRK_BROKEN_AUTO_HIBERN8);
 939 }
 940
 941 static inline bool ufshcd_is_auto_hibern8_enabled(struct ufs_hba *hba)
 942 {
 943         return FIELD_GET(UFSHCI_AHIBERN8_TIMER_MASK, hba->ahit) ? true : false;
 944 }
 945
 946 static inline bool ufshcd_is_wb_allowed(struct ufs_hba *hba)
 947 {
 948         return hba->caps & UFSHCD_CAP_WB_EN;
 949 }
 950
 951 static inline bool ufshcd_is_user_access_allowed(struct ufs_hba *hba)
 952 {
 953         return !hba->shutting_down;
 954 }
 955
 956 #define ufshcd_writel(hba, val, reg)    \
 957         writel((val), (hba)->mmio_base + (reg))
 958 #define ufshcd_readl(hba, reg)  \
 959         readl((hba)->mmio_base + (reg))
 960
 961 /**
 962  * ufshcd_rmwl - read modify write into a register
 963  * @hba - per adapter instance
 964  * @mask - mask to apply on read value
 965  * @val - actual value to write
 966  * @reg - register address
 967  */
 968 static inline void ufshcd_rmwl(struct ufs_hba *hba, u32 mask, u32 val, u32 reg)
 969 {
 970         u32 tmp;
 971
 972         tmp = ufshcd_readl(hba, reg);
 973         tmp &= ~mask;
 974         tmp |= (val & mask);
 975         ufshcd_writel(hba, tmp, reg);
 976 }
 977
 978 int ufshcd_alloc_host(struct device *, struct ufs_hba **);
 979 void ufshcd_dealloc_host(struct ufs_hba *);
 980 int ufshcd_hba_enable(struct ufs_hba *hba);
 981 int ufshcd_init(struct ufs_hba *, void __iomem *, unsigned int);
 982 int ufshcd_link_recovery(struct ufs_hba *hba);
 983 int ufshcd_make_hba_operational(struct ufs_hba *hba);
 984 void ufshcd_remove(struct ufs_hba *);
 985 int ufshcd_uic_hibern8_exit(struct ufs_hba *hba);
 986 void ufshcd_delay_us(unsigned long us, unsigned long tolerance);
 987 int ufshcd_wait_for_register(struct ufs_hba *hba, u32 reg, u32 mask,
 988                                 u32 val, unsigned long interval_us,
 989                                 unsigned long timeout_ms);
 990 void ufshcd_parse_dev_ref_clk_freq(struct ufs_hba *hba, struct clk *refclk);
 991 void ufshcd_update_evt_hist(struct ufs_hba *hba, u32 id, u32 val);
 992 void ufshcd_hba_stop(struct ufs_hba *hba);
 993
 994 static inline void check_upiu_size(void)
 995 {
 996         BUILD_BUG_ON(ALIGNED_UPIU_SIZE <
 997                 GENERAL_UPIU_REQUEST_SIZE + QUERY_DESC_MAX_SIZE);
 998 }
 999
1000 /**
1001  * ufshcd_set_variant - set variant specific data to the hba
1002  * @hba - per adapter instance
1003  * @variant - pointer to variant specific data
1004  */
1005 static inline void ufshcd_set_variant(struct ufs_hba *hba, void *variant)
1006 {
1007         BUG_ON(!hba);
1008         hba->priv = variant;
1009 }
1010
1011 /**
1012  * ufshcd_get_variant - get variant specific data from the hba
1013  * @hba - per adapter instance
1014  */
1015 static inline void *ufshcd_get_variant(struct ufs_hba *hba)
1016 {
1017         BUG_ON(!hba);
1018         return hba->priv;
1019 }
1020 static inline bool ufshcd_keep_autobkops_enabled_except_suspend(
1021                                                         struct ufs_hba *hba)
1022 {
1023         return hba->caps & UFSHCD_CAP_KEEP_AUTO_BKOPS_ENABLED_EXCEPT_SUSPEND;
1024 }
1025
1026 static inline u8 ufshcd_wb_get_query_index(struct ufs_hba *hba)
1027 {
1028         if (hba->dev_info.wb_buffer_type == WB_BUF_MODE_LU_DEDICATED)
1029                 return hba->dev_info.wb_dedicated_lu;
1030         return 0;
1031 }
1032
1033 #ifdef CONFIG_PM
1034 extern int ufshcd_runtime_suspend(struct device *dev);
1035 extern int ufshcd_runtime_resume(struct device *dev);
1036 #endif
1037 #ifdef CONFIG_PM_SLEEP
1038 extern int ufshcd_system_suspend(struct device *dev);
1039 extern int ufshcd_system_resume(struct device *dev);
1040 #endif
1041 extern int ufshcd_shutdown(struct ufs_hba *hba);
1042 extern int ufshcd_dme_configure_adapt(struct ufs_hba *hba,
1043                                       int agreed_gear,
1044                                       int adapt_val);
1045 extern int ufshcd_dme_set_attr(struct ufs_hba *hba, u32 attr_sel,
1046                                u8 attr_set, u32 mib_val, u8 peer);
1047 extern int ufshcd_dme_get_attr(struct ufs_hba *hba, u32 attr_sel,
1048                                u32 *mib_val, u8 peer);
1049 extern int ufshcd_config_pwr_mode(struct ufs_hba *hba,
1050                         struct ufs_pa_layer_attr *desired_pwr_mode);
1051
1052 /* UIC command interfaces for DME primitives */
1053 #define DME_LOCAL       0
1054 #define DME_PEER        1
1055 #define ATTR_SET_NOR    0       /* NORMAL */
1056 #define ATTR_SET_ST     1       /* STATIC */
1057
1058 static inline int ufshcd_dme_set(struct ufs_hba *hba, u32 attr_sel,
1059                                  u32 mib_val)
1060 {
1061         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
1062                                    mib_val, DME_LOCAL);
1063 }
1064
1065 static inline int ufshcd_dme_st_set(struct ufs_hba *hba, u32 attr_sel,
1066                                     u32 mib_val)
1067 {
1068         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
1069                                    mib_val, DME_LOCAL);
1070 }
1071
1072 static inline int ufshcd_dme_peer_set(struct ufs_hba *hba, u32 attr_sel,
1073                                       u32 mib_val)
1074 {
1075         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
1076                                    mib_val, DME_PEER);
1077 }
1078
1079 static inline int ufshcd_dme_peer_st_set(struct ufs_hba *hba, u32 attr_sel,
1080                                          u32 mib_val)
1081 {
1082         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
1083                                    mib_val, DME_PEER);
1084 }
1085
1086 static inline int ufshcd_dme_get(struct ufs_hba *hba,
1087                                  u32 attr_sel, u32 *mib_val)
1088 {
1089         return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_LOCAL);
1090 }
1091
1092 static inline int ufshcd_dme_peer_get(struct ufs_hba *hba,
1093                                       u32 attr_sel, u32 *mib_val)
1094 {
1095         return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_PEER);
1096 }
1097
1098 static inline bool ufshcd_is_hs_mode(struct ufs_pa_layer_attr *pwr_info)
1099 {
1100         return (pwr_info->pwr_rx == FAST_MODE ||
1101                 pwr_info->pwr_rx == FASTAUTO_MODE) &&
1102                 (pwr_info->pwr_tx == FAST_MODE ||
1103                 pwr_info->pwr_tx == FASTAUTO_MODE);
1104 }
1105
1106 static inline int ufshcd_disable_host_tx_lcc(struct ufs_hba *hba)
1107 {
1108         return ufshcd_dme_set(hba, UIC_ARG_MIB(PA_LOCAL_TX_LCC_ENABLE), 0);
1109 }
1110
1111 /* Expose Query-Request API */
1112 int ufshcd_query_descriptor_retry(struct ufs_hba *hba,
1113                                   enum query_opcode opcode,
1114                                   enum desc_idn idn, u8 index,
1115                                   u8 selector,
1116                                   u8 *desc_buf, int *buf_len);
1117 int ufshcd_read_desc_param(struct ufs_hba *hba,
1118                            enum desc_idn desc_id,
1119                            int desc_index,
1120                            u8 param_offset,
1121                            u8 *param_read_buf,
1122                            u8 param_size);
1123 int ufshcd_query_attr_retry(struct ufs_hba *hba, enum query_opcode opcode,
1124                             enum attr_idn idn, u8 index, u8 selector,
1125                             u32 *attr_val);
1126 int ufshcd_query_attr(struct ufs_hba *hba, enum query_opcode opcode,
1127                       enum attr_idn idn, u8 index, u8 selector, u32 *attr_val);
1128 int ufshcd_query_flag(struct ufs_hba *hba, enum query_opcode opcode,
1129         enum flag_idn idn, u8 index, bool *flag_res);
1130
1131 void ufshcd_auto_hibern8_enable(struct ufs_hba *hba);
1132 void ufshcd_auto_hibern8_update(struct ufs_hba *hba, u32 ahit);
1133 void ufshcd_fixup_dev_quirks(struct ufs_hba *hba, struct ufs_dev_fix *fixups);
1134 #define SD_ASCII_STD true
1135 #define SD_RAW false
1136 int ufshcd_read_string_desc(struct ufs_hba *hba, u8 desc_index,
1137                             u8 **buf, bool ascii);
1138
1139 int ufshcd_hold(struct ufs_hba *hba, bool async);
1140 void ufshcd_release(struct ufs_hba *hba);
1141
1142 void ufshcd_map_desc_id_to_length(struct ufs_hba *hba, enum desc_idn desc_id,
1143                                   int *desc_length);
1144
1145 u32 ufshcd_get_local_unipro_ver(struct ufs_hba *hba);
1146
1147 int ufshcd_send_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd);
1148
1149 int ufshcd_exec_raw_upiu_cmd(struct ufs_hba *hba,
1150                              struct utp_upiu_req *req_upiu,
1151                              struct utp_upiu_req *rsp_upiu,
1152                              int msgcode,
1153                              u8 *desc_buff, int *buff_len,
1154                              enum query_opcode desc_op);
1155
1156 int ufshcd_wb_toggle(struct ufs_hba *hba, bool enable);
1157 int ufshcd_suspend_prepare(struct device *dev);
1158 void ufshcd_resume_complete(struct device *dev);
1159
1160 /* Wrapper functions for safely calling variant operations */
1161 static inline const char *ufshcd_get_var_name(struct ufs_hba *hba)
1162 {
1163         if (hba->vops)
1164                 return hba->vops->name;
1165         return "";
1166 }
1167
1168 static inline int ufshcd_vops_init(struct ufs_hba *hba)
1169 {
1170         if (hba->vops && hba->vops->init)
1171                 return hba->vops->init(hba);
1172
1173         return 0;
1174 }
1175
1176 static inline void ufshcd_vops_exit(struct ufs_hba *hba)
1177 {
1178         if (hba->vops && hba->vops->exit)
1179                 return hba->vops->exit(hba);
1180 }
1181
1182 static inline u32 ufshcd_vops_get_ufs_hci_version(struct ufs_hba *hba)
1183 {
1184         if (hba->vops && hba->vops->get_ufs_hci_version)
1185                 return hba->vops->get_ufs_hci_version(hba);
1186
1187         return ufshcd_readl(hba, REG_UFS_VERSION);
1188 }
1189
1190 static inline bool ufshcd_has_utrlcnr(struct ufs_hba *hba)
1191 {
1192         return (hba->ufs_version >= ufshci_version(3, 0));
1193 }
1194
1195 static inline int ufshcd_vops_clk_scale_notify(struct ufs_hba *hba,
1196                         bool up, enum ufs_notify_change_status status)
1197 {
1198         if (hba->vops && hba->vops->clk_scale_notify)
1199                 return hba->vops->clk_scale_notify(hba, up, status);
1200         return 0;
1201 }
1202
1203 static inline void ufshcd_vops_event_notify(struct ufs_hba *hba,
1204                                             enum ufs_event_type evt,
1205                                             void *data)
1206 {
1207         if (hba->vops && hba->vops->event_notify)
1208                 hba->vops->event_notify(hba, evt, data);
1209 }
1210
1211 static inline int ufshcd_vops_setup_clocks(struct ufs_hba *hba, bool on,
1212                                         enum ufs_notify_change_status status)
1213 {
1214         if (hba->vops && hba->vops->setup_clocks)
1215                 return hba->vops->setup_clocks(hba, on, status);
1216         return 0;
1217 }
1218
1219 static inline int ufshcd_vops_hce_enable_notify(struct ufs_hba *hba,
1220                                                 bool status)
1221 {
1222         if (hba->vops && hba->vops->hce_enable_notify)
1223                 return hba->vops->hce_enable_notify(hba, status);
1224
1225         return 0;
1226 }
1227 static inline int ufshcd_vops_link_startup_notify(struct ufs_hba *hba,
1228                                                 bool status)
1229 {
1230         if (hba->vops && hba->vops->link_startup_notify)
1231                 return hba->vops->link_startup_notify(hba, status);
1232
1233         return 0;
1234 }
1235
1236 static inline int ufshcd_vops_phy_initialization(struct ufs_hba *hba)
1237 {
1238         if (hba->vops && hba->vops->phy_initialization)
1239                 return hba->vops->phy_initialization(hba);
1240
1241         return 0;
1242 }
1243
1244 static inline int ufshcd_vops_pwr_change_notify(struct ufs_hba *hba,
1245                                   enum ufs_notify_change_status status,
1246                                   struct ufs_pa_layer_attr *dev_max_params,
1247                                   struct ufs_pa_layer_attr *dev_req_params)
1248 {
1249         if (hba->vops && hba->vops->pwr_change_notify)
1250                 return hba->vops->pwr_change_notify(hba, status,
1251                                         dev_max_params, dev_req_params);
1252
1253         return -ENOTSUPP;
1254 }
1255
1256 static inline void ufshcd_vops_setup_xfer_req(struct ufs_hba *hba, int tag,
1257                                         bool is_scsi_cmd)
1258 {
1259         if (hba->vops && hba->vops->setup_xfer_req) {
1260                 unsigned long flags;
1261
1262                 spin_lock_irqsave(hba->host->host_lock, flags);
1263                 hba->vops->setup_xfer_req(hba, tag, is_scsi_cmd);
1264                 spin_unlock_irqrestore(hba->host->host_lock, flags);
1265         }
1266 }
1267
1268 static inline void ufshcd_vops_setup_task_mgmt(struct ufs_hba *hba,
1269                                         int tag, u8 tm_function)
1270 {
1271         if (hba->vops && hba->vops->setup_task_mgmt)
1272                 return hba->vops->setup_task_mgmt(hba, tag, tm_function);
1273 }
1274
1275 static inline void ufshcd_vops_hibern8_notify(struct ufs_hba *hba,
1276                                         enum uic_cmd_dme cmd,
1277                                         enum ufs_notify_change_status status)
1278 {
1279         if (hba->vops && hba->vops->hibern8_notify)
1280                 return hba->vops->hibern8_notify(hba, cmd, status);
1281 }
1282
1283 static inline int ufshcd_vops_apply_dev_quirks(struct ufs_hba *hba)
1284 {
1285         if (hba->vops && hba->vops->apply_dev_quirks)
1286                 return hba->vops->apply_dev_quirks(hba);
1287         return 0;
1288 }
1289
1290 static inline void ufshcd_vops_fixup_dev_quirks(struct ufs_hba *hba)
1291 {
1292         if (hba->vops && hba->vops->fixup_dev_quirks)
1293                 hba->vops->fixup_dev_quirks(hba);
1294 }
1295
1296 static inline int ufshcd_vops_suspend(struct ufs_hba *hba, enum ufs_pm_op op)
1297 {
1298         if (hba->vops && hba->vops->suspend)
1299                 return hba->vops->suspend(hba, op);
1300
1301         return 0;
1302 }
1303
1304 static inline int ufshcd_vops_resume(struct ufs_hba *hba, enum ufs_pm_op op)
1305 {
1306         if (hba->vops && hba->vops->resume)
1307                 return hba->vops->resume(hba, op);
1308
1309         return 0;
1310 }
1311
1312 static inline void ufshcd_vops_dbg_register_dump(struct ufs_hba *hba)
1313 {
1314         if (hba->vops && hba->vops->dbg_register_dump)
1315                 hba->vops->dbg_register_dump(hba);
1316 }
1317
1318 static inline int ufshcd_vops_device_reset(struct ufs_hba *hba)
1319 {
1320         if (hba->vops && hba->vops->device_reset)
1321                 return hba->vops->device_reset(hba);
1322
1323         return -EOPNOTSUPP;
1324 }
1325
1326 static inline void ufshcd_vops_config_scaling_param(struct ufs_hba *hba,
1327                                                     struct devfreq_dev_profile
1328                                                     *profile, void *data)
1329 {
1330         if (hba->vops && hba->vops->config_scaling_param)
1331                 hba->vops->config_scaling_param(hba, profile, data);
1332 }
1333
1334 extern struct ufs_pm_lvl_states ufs_pm_lvl_states[];
1335
1336 /*
1337  * ufshcd_scsi_to_upiu_lun - maps scsi LUN to UPIU LUN
1338  * @scsi_lun: scsi LUN id
1339  *
1340  * Returns UPIU LUN id
1341  */
1342 static inline u8 ufshcd_scsi_to_upiu_lun(unsigned int scsi_lun)
1343 {
1344         if (scsi_is_wlun(scsi_lun))
1345                 return (scsi_lun & UFS_UPIU_MAX_UNIT_NUM_ID)
1346                         | UFS_UPIU_WLUN_ID;
1347         else
1348                 return scsi_lun & UFS_UPIU_MAX_UNIT_NUM_ID;
1349 }
1350
1351 int ufshcd_dump_regs(struct ufs_hba *hba, size_t offset, size_t len,
1352                      const char *prefix);
1353
1354 int __ufshcd_write_ee_control(struct ufs_hba *hba, u32 ee_ctrl_mask);
1355 int ufshcd_write_ee_control(struct ufs_hba *hba);
1356 int ufshcd_update_ee_control(struct ufs_hba *hba, u16 *mask, u16 *other_mask,
1357                              u16 set, u16 clr);
1358
1359 static inline int ufshcd_update_ee_drv_mask(struct ufs_hba *hba,
1360                                             u16 set, u16 clr)
1361 {
1362         return ufshcd_update_ee_control(hba, &hba->ee_drv_mask,
1363                                         &hba->ee_usr_mask, set, clr);
1364 }
1365
1366 static inline int ufshcd_update_ee_usr_mask(struct ufs_hba *hba,
1367                                             u16 set, u16 clr)
1368 {
1369         return ufshcd_update_ee_control(hba, &hba->ee_usr_mask,
1370                                         &hba->ee_drv_mask, set, clr);
1371 }
1372
1373 static inline int ufshcd_rpm_get_sync(struct ufs_hba *hba)
1374 {
1375         return pm_runtime_get_sync(&hba->sdev_ufs_device->sdev_gendev);
1376 }
1377
1378 static inline int ufshcd_rpm_put_sync(struct ufs_hba *hba)
1379 {
1380         return pm_runtime_put_sync(&hba->sdev_ufs_device->sdev_gendev);
1381 }
1382
1383 static inline int ufshcd_rpm_put(struct ufs_hba *hba)
1384 {
1385         return pm_runtime_put(&hba->sdev_ufs_device->sdev_gendev);
1386 }
1387
1388 static inline int ufshcd_rpmb_rpm_get_sync(struct ufs_hba *hba)
1389 {
1390         return pm_runtime_get_sync(&hba->sdev_rpmb->sdev_gendev);
1391 }
1392
1393 static inline int ufshcd_rpmb_rpm_put(struct ufs_hba *hba)
1394 {
1395         return pm_runtime_put(&hba->sdev_rpmb->sdev_gendev);
1396 }
1397
1398 #endif /* End of Header */