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/blk-crypto-profile.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 *hba, int tag,
 342                                   bool is_scsi_cmd);
 343         void    (*setup_task_mgmt)(struct ufs_hba *, int, u8);
 344         void    (*hibern8_notify)(struct ufs_hba *, enum uic_cmd_dme,
 345                                         enum ufs_notify_change_status);
 346         int     (*apply_dev_quirks)(struct ufs_hba *hba);
 347         void    (*fixup_dev_quirks)(struct ufs_hba *hba);
 348         int     (*suspend)(struct ufs_hba *, enum ufs_pm_op,
 349                                         enum ufs_notify_change_status);
 350         int     (*resume)(struct ufs_hba *, enum ufs_pm_op);
 351         void    (*dbg_register_dump)(struct ufs_hba *hba);
 352         int     (*phy_initialization)(struct ufs_hba *);
 353         int     (*device_reset)(struct ufs_hba *hba);
 354         void    (*config_scaling_param)(struct ufs_hba *hba,
 355                                         struct devfreq_dev_profile *profile,
 356                                         void *data);
 357         int     (*program_key)(struct ufs_hba *hba,
 358                                const union ufs_crypto_cfg_entry *cfg, int slot);
 359         void    (*event_notify)(struct ufs_hba *hba,
 360                                 enum ufs_event_type evt, void *data);
 361 };
 362
 363 /* clock gating state  */
 364 enum clk_gating_state {
 365         CLKS_OFF,
 366         CLKS_ON,
 367         REQ_CLKS_OFF,
 368         REQ_CLKS_ON,
 369 };
 370
 371 /**
 372  * struct ufs_clk_gating - UFS clock gating related info
 373  * @gate_work: worker to turn off clocks after some delay as specified in
 374  * delay_ms
 375  * @ungate_work: worker to turn on clocks that will be used in case of
 376  * interrupt context
 377  * @state: the current clocks state
 378  * @delay_ms: gating delay in ms
 379  * @is_suspended: clk gating is suspended when set to 1 which can be used
 380  * during suspend/resume
 381  * @delay_attr: sysfs attribute to control delay_attr
 382  * @enable_attr: sysfs attribute to enable/disable clock gating
 383  * @is_enabled: Indicates the current status of clock gating
 384  * @is_initialized: Indicates whether clock gating is initialized or not
 385  * @active_reqs: number of requests that are pending and should be waited for
 386  * completion before gating clocks.
 387  */
 388 struct ufs_clk_gating {
 389         struct delayed_work gate_work;
 390         struct work_struct ungate_work;
 391         enum clk_gating_state state;
 392         unsigned long delay_ms;
 393         bool is_suspended;
 394         struct device_attribute delay_attr;
 395         struct device_attribute enable_attr;
 396         bool is_enabled;
 397         bool is_initialized;
 398         int active_reqs;
 399         struct workqueue_struct *clk_gating_workq;
 400 };
 401
 402 struct ufs_saved_pwr_info {
 403         struct ufs_pa_layer_attr info;
 404         bool is_valid;
 405 };
 406
 407 /**
 408  * struct ufs_clk_scaling - UFS clock scaling related data
 409  * @active_reqs: number of requests that are pending. If this is zero when
 410  * devfreq ->target() function is called then schedule "suspend_work" to
 411  * suspend devfreq.
 412  * @tot_busy_t: Total busy time in current polling window
 413  * @window_start_t: Start time (in jiffies) of the current polling window
 414  * @busy_start_t: Start time of current busy period
 415  * @enable_attr: sysfs attribute to enable/disable clock scaling
 416  * @saved_pwr_info: UFS power mode may also be changed during scaling and this
 417  * one keeps track of previous power mode.
 418  * @workq: workqueue to schedule devfreq suspend/resume work
 419  * @suspend_work: worker to suspend devfreq
 420  * @resume_work: worker to resume devfreq
 421  * @min_gear: lowest HS gear to scale down to
 422  * @is_enabled: tracks if scaling is currently enabled or not, controlled by
 423                 clkscale_enable sysfs node
 424  * @is_allowed: tracks if scaling is currently allowed or not, used to block
 425                 clock scaling which is not invoked from devfreq governor
 426  * @is_initialized: Indicates whether clock scaling is initialized or not
 427  * @is_busy_started: tracks if busy period has started or not
 428  * @is_suspended: tracks if devfreq is suspended or not
 429  */
 430 struct ufs_clk_scaling {
 431         int active_reqs;
 432         unsigned long tot_busy_t;
 433         ktime_t window_start_t;
 434         ktime_t busy_start_t;
 435         struct device_attribute enable_attr;
 436         struct ufs_saved_pwr_info saved_pwr_info;
 437         struct workqueue_struct *workq;
 438         struct work_struct suspend_work;
 439         struct work_struct resume_work;
 440         u32 min_gear;
 441         bool is_enabled;
 442         bool is_allowed;
 443         bool is_initialized;
 444         bool is_busy_started;
 445         bool is_suspended;
 446 };
 447
 448 #define UFS_EVENT_HIST_LENGTH 8
 449 /**
 450  * struct ufs_event_hist - keeps history of errors
 451  * @pos: index to indicate cyclic buffer position
 452  * @reg: cyclic buffer for registers value
 453  * @tstamp: cyclic buffer for time stamp
 454  * @cnt: error counter
 455  */
 456 struct ufs_event_hist {
 457         int pos;
 458         u32 val[UFS_EVENT_HIST_LENGTH];
 459         ktime_t tstamp[UFS_EVENT_HIST_LENGTH];
 460         unsigned long long cnt;
 461 };
 462
 463 /**
 464  * struct ufs_stats - keeps usage/err statistics
 465  * @last_intr_status: record the last interrupt status.
 466  * @last_intr_ts: record the last interrupt timestamp.
 467  * @hibern8_exit_cnt: Counter to keep track of number of exits,
 468  *              reset this after link-startup.
 469  * @last_hibern8_exit_tstamp: Set time after the hibern8 exit.
 470  *              Clear after the first successful command completion.
 471  */
 472 struct ufs_stats {
 473         u32 last_intr_status;
 474         ktime_t last_intr_ts;
 475
 476         u32 hibern8_exit_cnt;
 477         ktime_t last_hibern8_exit_tstamp;
 478         struct ufs_event_hist event[UFS_EVT_CNT];
 479 };
 480
 481 /**
 482  * enum ufshcd_state - UFS host controller state
 483  * @UFSHCD_STATE_RESET: Link is not operational. Postpone SCSI command
 484  *      processing.
 485  * @UFSHCD_STATE_OPERATIONAL: The host controller is operational and can process
 486  *      SCSI commands.
 487  * @UFSHCD_STATE_EH_SCHEDULED_NON_FATAL: The error handler has been scheduled.
 488  *      SCSI commands may be submitted to the controller.
 489  * @UFSHCD_STATE_EH_SCHEDULED_FATAL: The error handler has been scheduled. Fail
 490  *      newly submitted SCSI commands with error code DID_BAD_TARGET.
 491  * @UFSHCD_STATE_ERROR: An unrecoverable error occurred, e.g. link recovery
 492  *      failed. Fail all SCSI commands with error code DID_ERROR.
 493  */
 494 enum ufshcd_state {
 495         UFSHCD_STATE_RESET,
 496         UFSHCD_STATE_OPERATIONAL,
 497         UFSHCD_STATE_EH_SCHEDULED_NON_FATAL,
 498         UFSHCD_STATE_EH_SCHEDULED_FATAL,
 499         UFSHCD_STATE_ERROR,
 500 };
 501
 502 enum ufshcd_quirks {
 503         /* Interrupt aggregation support is broken */
 504         UFSHCD_QUIRK_BROKEN_INTR_AGGR                   = 1 << 0,
 505
 506         /*
 507          * delay before each dme command is required as the unipro
 508          * layer has shown instabilities
 509          */
 510         UFSHCD_QUIRK_DELAY_BEFORE_DME_CMDS              = 1 << 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         UFSHCD_QUIRK_BROKEN_LCC                         = 1 << 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         UFSHCD_QUIRK_BROKEN_PA_RXHSUNTERMCAP            = 1 << 3,
 527
 528         /*
 529          * This quirk needs to be enabled if the host controller only allows
 530          * accessing the peer dme attributes in AUTO mode (FAST AUTO or
 531          * SLOW AUTO).
 532          */
 533         UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE          = 1 << 4,
 534
 535         /*
 536          * This quirk needs to be enabled if the host controller 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         UFSHCD_QUIRK_BROKEN_UFS_HCI_VERSION             = 1 << 5,
 542
 543         /*
 544          * Clear handling for transfer/task request list is just opposite.
 545          */
 546         UFSHCI_QUIRK_BROKEN_REQ_LIST_CLR                = 1 << 6,
 547
 548         /*
 549          * This quirk needs to be enabled if host controller doesn't allow
 550          * that the interrupt aggregation timer and counter are reset by s/w.
 551          */
 552         UFSHCI_QUIRK_SKIP_RESET_INTR_AGGR               = 1 << 7,
 553
 554         /*
 555          * This quirks needs to be enabled if host controller cannot be
 556          * enabled via HCE register.
 557          */
 558         UFSHCI_QUIRK_BROKEN_HCE                         = 1 << 8,
 559
 560         /*
 561          * This quirk needs to be enabled if the host controller regards
 562          * resolution of the values of PRDTO and PRDTL in UTRD as byte.
 563          */
 564         UFSHCD_QUIRK_PRDT_BYTE_GRAN                     = 1 << 9,
 565
 566         /*
 567          * This quirk needs to be enabled if the host controller reports
 568          * OCS FATAL ERROR with device error through sense data
 569          */
 570         UFSHCD_QUIRK_BROKEN_OCS_FATAL_ERROR             = 1 << 10,
 571
 572         /*
 573          * This quirk needs to be enabled if the host controller has
 574          * auto-hibernate capability but it doesn't work.
 575          */
 576         UFSHCD_QUIRK_BROKEN_AUTO_HIBERN8                = 1 << 11,
 577
 578         /*
 579          * This quirk needs to disable manual flush for write booster
 580          */
 581         UFSHCI_QUIRK_SKIP_MANUAL_WB_FLUSH_CTRL          = 1 << 12,
 582
 583         /*
 584          * This quirk needs to disable unipro timeout values
 585          * before power mode change
 586          */
 587         UFSHCD_QUIRK_SKIP_DEF_UNIPRO_TIMEOUT_SETTING = 1 << 13,
 588
 589         /*
 590          * This quirk allows only sg entries aligned with page size.
 591          */
 592         UFSHCD_QUIRK_ALIGN_SG_WITH_PAGE_SIZE            = 1 << 14,
 593
 594         /*
 595          * This quirk needs to be enabled if the host controller does not
 596          * support UIC command
 597          */
 598         UFSHCD_QUIRK_BROKEN_UIC_CMD                     = 1 << 15,
 599
 600         /*
 601          * This quirk needs to be enabled if the host controller cannot
 602          * support physical host configuration.
 603          */
 604         UFSHCD_QUIRK_SKIP_PH_CONFIGURATION              = 1 << 16,
 605 };
 606
 607 enum ufshcd_caps {
 608         /* Allow dynamic clk gating */
 609         UFSHCD_CAP_CLK_GATING                           = 1 << 0,
 610
 611         /* Allow hiberb8 with clk gating */
 612         UFSHCD_CAP_HIBERN8_WITH_CLK_GATING              = 1 << 1,
 613
 614         /* Allow dynamic clk scaling */
 615         UFSHCD_CAP_CLK_SCALING                          = 1 << 2,
 616
 617         /* Allow auto bkops to enabled during runtime suspend */
 618         UFSHCD_CAP_AUTO_BKOPS_SUSPEND                   = 1 << 3,
 619
 620         /*
 621          * This capability allows host controller driver to use the UFS HCI's
 622          * interrupt aggregation capability.
 623          * CAUTION: Enabling this might reduce overall UFS throughput.
 624          */
 625         UFSHCD_CAP_INTR_AGGR                            = 1 << 4,
 626
 627         /*
 628          * This capability allows the device auto-bkops to be always enabled
 629          * except during suspend (both runtime and suspend).
 630          * Enabling this capability means that device will always be allowed
 631          * to do background operation when it's active but it might degrade
 632          * the performance of ongoing read/write operations.
 633          */
 634         UFSHCD_CAP_KEEP_AUTO_BKOPS_ENABLED_EXCEPT_SUSPEND = 1 << 5,
 635
 636         /*
 637          * This capability allows host controller driver to automatically
 638          * enable runtime power management by itself instead of waiting
 639          * for userspace to control the power management.
 640          */
 641         UFSHCD_CAP_RPM_AUTOSUSPEND                      = 1 << 6,
 642
 643         /*
 644          * This capability allows the host controller driver to turn-on
 645          * WriteBooster, if the underlying device supports it and is
 646          * provisioned to be used. This would increase the write performance.
 647          */
 648         UFSHCD_CAP_WB_EN                                = 1 << 7,
 649
 650         /*
 651          * This capability allows the host controller driver to use the
 652          * inline crypto engine, if it is present
 653          */
 654         UFSHCD_CAP_CRYPTO                               = 1 << 8,
 655
 656         /*
 657          * This capability allows the controller regulators to be put into
 658          * lpm mode aggressively during clock gating.
 659          * This would increase power savings.
 660          */
 661         UFSHCD_CAP_AGGR_POWER_COLLAPSE                  = 1 << 9,
 662
 663         /*
 664          * This capability allows the host controller driver to use DeepSleep,
 665          * if it is supported by the UFS device. The host controller driver must
 666          * support device hardware reset via the hba->device_reset() callback,
 667          * in order to exit DeepSleep state.
 668          */
 669         UFSHCD_CAP_DEEPSLEEP                            = 1 << 10,
 670
 671         /*
 672          * This capability allows the host controller driver to use temperature
 673          * notification if it is supported by the UFS device.
 674          */
 675         UFSHCD_CAP_TEMP_NOTIF                           = 1 << 11,
 676 };
 677
 678 struct ufs_hba_variant_params {
 679         struct devfreq_dev_profile devfreq_profile;
 680         struct devfreq_simple_ondemand_data ondemand_data;
 681         u16 hba_enable_delay_us;
 682         u32 wb_flush_threshold;
 683 };
 684
 685 #ifdef CONFIG_SCSI_UFS_HPB
 686 /**
 687  * struct ufshpb_dev_info - UFSHPB device related info
 688  * @num_lu: the number of user logical unit to check whether all lu finished
 689  *          initialization
 690  * @rgn_size: device reported HPB region size
 691  * @srgn_size: device reported HPB sub-region size
 692  * @slave_conf_cnt: counter to check all lu finished initialization
 693  * @hpb_disabled: flag to check if HPB is disabled
 694  * @max_hpb_single_cmd: device reported bMAX_DATA_SIZE_FOR_SINGLE_CMD value
 695  * @is_legacy: flag to check HPB 1.0
 696  * @control_mode: either host or device
 697  */
 698 struct ufshpb_dev_info {
 699         int num_lu;
 700         int rgn_size;
 701         int srgn_size;
 702         atomic_t slave_conf_cnt;
 703         bool hpb_disabled;
 704         u8 max_hpb_single_cmd;
 705         bool is_legacy;
 706         u8 control_mode;
 707 };
 708 #endif
 709
 710 struct ufs_hba_monitor {
 711         unsigned long chunk_size;
 712
 713         unsigned long nr_sec_rw[2];
 714         ktime_t total_busy[2];
 715
 716         unsigned long nr_req[2];
 717         /* latencies*/
 718         ktime_t lat_sum[2];
 719         ktime_t lat_max[2];
 720         ktime_t lat_min[2];
 721
 722         u32 nr_queued[2];
 723         ktime_t busy_start_ts[2];
 724
 725         ktime_t enabled_ts;
 726         bool enabled;
 727 };
 728
 729 /**
 730  * struct ufs_hba - per adapter private structure
 731  * @mmio_base: UFSHCI base register address
 732  * @ucdl_base_addr: UFS Command Descriptor base address
 733  * @utrdl_base_addr: UTP Transfer Request Descriptor base address
 734  * @utmrdl_base_addr: UTP Task Management Descriptor base address
 735  * @ucdl_dma_addr: UFS Command Descriptor DMA address
 736  * @utrdl_dma_addr: UTRDL DMA address
 737  * @utmrdl_dma_addr: UTMRDL DMA address
 738  * @host: Scsi_Host instance of the driver
 739  * @dev: device handle
 740  * @lrb: local reference block
 741  * @outstanding_tasks: Bits representing outstanding task requests
 742  * @outstanding_lock: Protects @outstanding_reqs.
 743  * @outstanding_reqs: Bits representing outstanding transfer requests
 744  * @capabilities: UFS Controller Capabilities
 745  * @nutrs: Transfer Request Queue depth supported by controller
 746  * @nutmrs: Task Management Queue depth supported by controller
 747  * @reserved_slot: Used to submit device commands. Protected by @dev_cmd.lock.
 748  * @ufs_version: UFS Version to which controller complies
 749  * @vops: pointer to variant specific operations
 750  * @priv: pointer to variant specific private data
 751  * @irq: Irq number of the controller
 752  * @active_uic_cmd: handle of active UIC command
 753  * @uic_cmd_mutex: mutex for UIC command
 754  * @tmf_tag_set: TMF tag set.
 755  * @tmf_queue: Used to allocate TMF tags.
 756  * @pwr_done: completion for power mode change
 757  * @ufshcd_state: UFSHCD state
 758  * @eh_flags: Error handling flags
 759  * @intr_mask: Interrupt Mask Bits
 760  * @ee_ctrl_mask: Exception event control mask
 761  * @is_powered: flag to check if HBA is powered
 762  * @shutting_down: flag to check if shutdown has been invoked
 763  * @host_sem: semaphore used to serialize concurrent contexts
 764  * @eh_wq: Workqueue that eh_work works on
 765  * @eh_work: Worker to handle UFS errors that require s/w attention
 766  * @eeh_work: Worker to handle exception events
 767  * @errors: HBA errors
 768  * @uic_error: UFS interconnect layer error status
 769  * @saved_err: sticky error mask
 770  * @saved_uic_err: sticky UIC error mask
 771  * @force_reset: flag to force eh_work perform a full reset
 772  * @force_pmc: flag to force a power mode change
 773  * @silence_err_logs: flag to silence error logs
 774  * @dev_cmd: ufs device management command information
 775  * @last_dme_cmd_tstamp: time stamp of the last completed DME command
 776  * @auto_bkops_enabled: to track whether bkops is enabled in device
 777  * @vreg_info: UFS device voltage regulator information
 778  * @clk_list_head: UFS host controller clocks list node head
 779  * @pwr_info: holds current power mode
 780  * @max_pwr_info: keeps the device max valid pwm
 781  * @clk_scaling_lock: used to serialize device commands and clock scaling
 782  * @desc_size: descriptor sizes reported by device
 783  * @urgent_bkops_lvl: keeps track of urgent bkops level for device
 784  * @is_urgent_bkops_lvl_checked: keeps track if the urgent bkops level for
 785  *  device is known or not.
 786  * @scsi_block_reqs_cnt: reference counting for scsi block requests
 787  * @crypto_capabilities: Content of crypto capabilities register (0x100)
 788  * @crypto_cap_array: Array of crypto capabilities
 789  * @crypto_cfg_register: Start of the crypto cfg array
 790  * @crypto_profile: the crypto profile of this hba (if applicable)
 791  */
 792 struct ufs_hba {
 793         void __iomem *mmio_base;
 794
 795         /* Virtual memory reference */
 796         struct utp_transfer_cmd_desc *ucdl_base_addr;
 797         struct utp_transfer_req_desc *utrdl_base_addr;
 798         struct utp_task_req_desc *utmrdl_base_addr;
 799
 800         /* DMA memory reference */
 801         dma_addr_t ucdl_dma_addr;
 802         dma_addr_t utrdl_dma_addr;
 803         dma_addr_t utmrdl_dma_addr;
 804
 805         struct Scsi_Host *host;
 806         struct device *dev;
 807         /*
 808          * This field is to keep a reference to "scsi_device" corresponding to
 809          * "UFS device" W-LU.
 810          */
 811         struct scsi_device *sdev_ufs_device;
 812
 813 #ifdef CONFIG_SCSI_UFS_HWMON
 814         struct device *hwmon_device;
 815 #endif
 816
 817         enum ufs_dev_pwr_mode curr_dev_pwr_mode;
 818         enum uic_link_state uic_link_state;
 819         /* Desired UFS power management level during runtime PM */
 820         enum ufs_pm_level rpm_lvl;
 821         /* Desired UFS power management level during system PM */
 822         enum ufs_pm_level spm_lvl;
 823         int pm_op_in_progress;
 824
 825         /* Auto-Hibernate Idle Timer register value */
 826         u32 ahit;
 827
 828         struct ufshcd_lrb *lrb;
 829
 830         unsigned long outstanding_tasks;
 831         spinlock_t outstanding_lock;
 832         unsigned long outstanding_reqs;
 833
 834         u32 capabilities;
 835         int nutrs;
 836         int nutmrs;
 837         u32 reserved_slot;
 838         u32 ufs_version;
 839         const struct ufs_hba_variant_ops *vops;
 840         struct ufs_hba_variant_params *vps;
 841         void *priv;
 842         unsigned int irq;
 843         bool is_irq_enabled;
 844         enum ufs_ref_clk_freq dev_ref_clk_freq;
 845
 846         unsigned int quirks;    /* Deviations from standard UFSHCI spec. */
 847
 848         /* Device deviations from standard UFS device spec. */
 849         unsigned int dev_quirks;
 850
 851         struct blk_mq_tag_set tmf_tag_set;
 852         struct request_queue *tmf_queue;
 853         struct request **tmf_rqs;
 854
 855         struct uic_command *active_uic_cmd;
 856         struct mutex uic_cmd_mutex;
 857         struct completion *uic_async_done;
 858
 859         enum ufshcd_state ufshcd_state;
 860         u32 eh_flags;
 861         u32 intr_mask;
 862         u16 ee_ctrl_mask; /* Exception event mask */
 863         u16 ee_drv_mask;  /* Exception event mask for driver */
 864         u16 ee_usr_mask;  /* Exception event mask for user (via debugfs) */
 865         struct mutex ee_ctrl_mutex;
 866         bool is_powered;
 867         bool shutting_down;
 868         struct semaphore host_sem;
 869
 870         /* Work Queues */
 871         struct workqueue_struct *eh_wq;
 872         struct work_struct eh_work;
 873         struct work_struct eeh_work;
 874
 875         /* HBA Errors */
 876         u32 errors;
 877         u32 uic_error;
 878         u32 saved_err;
 879         u32 saved_uic_err;
 880         struct ufs_stats ufs_stats;
 881         bool force_reset;
 882         bool force_pmc;
 883         bool silence_err_logs;
 884
 885         /* Device management request data */
 886         struct ufs_dev_cmd dev_cmd;
 887         ktime_t last_dme_cmd_tstamp;
 888         int nop_out_timeout;
 889
 890         /* Keeps information of the UFS device connected to this host */
 891         struct ufs_dev_info dev_info;
 892         bool auto_bkops_enabled;
 893         struct ufs_vreg_info vreg_info;
 894         struct list_head clk_list_head;
 895
 896         /* Number of requests aborts */
 897         int req_abort_count;
 898
 899         /* Number of lanes available (1 or 2) for Rx/Tx */
 900         u32 lanes_per_direction;
 901         struct ufs_pa_layer_attr pwr_info;
 902         struct ufs_pwr_mode_info max_pwr_info;
 903
 904         struct ufs_clk_gating clk_gating;
 905         /* Control to enable/disable host capabilities */
 906         u32 caps;
 907
 908         struct devfreq *devfreq;
 909         struct ufs_clk_scaling clk_scaling;
 910         bool is_sys_suspended;
 911
 912         enum bkops_status urgent_bkops_lvl;
 913         bool is_urgent_bkops_lvl_checked;
 914
 915         struct rw_semaphore clk_scaling_lock;
 916         unsigned char desc_size[QUERY_DESC_IDN_MAX];
 917         atomic_t scsi_block_reqs_cnt;
 918
 919         struct device           bsg_dev;
 920         struct request_queue    *bsg_queue;
 921         struct delayed_work rpm_dev_flush_recheck_work;
 922
 923 #ifdef CONFIG_SCSI_UFS_HPB
 924         struct ufshpb_dev_info ufshpb_dev;
 925 #endif
 926
 927         struct ufs_hba_monitor  monitor;
 928
 929 #ifdef CONFIG_SCSI_UFS_CRYPTO
 930         union ufs_crypto_capabilities crypto_capabilities;
 931         union ufs_crypto_cap_entry *crypto_cap_array;
 932         u32 crypto_cfg_register;
 933         struct blk_crypto_profile crypto_profile;
 934 #endif
 935 #ifdef CONFIG_DEBUG_FS
 936         struct dentry *debugfs_root;
 937         struct delayed_work debugfs_ee_work;
 938         u32 debugfs_ee_rate_limit_ms;
 939 #endif
 940         u32 luns_avail;
 941         bool complete_put;
 942 };
 943
 944 /* Returns true if clocks can be gated. Otherwise false */
 945 static inline bool ufshcd_is_clkgating_allowed(struct ufs_hba *hba)
 946 {
 947         return hba->caps & UFSHCD_CAP_CLK_GATING;
 948 }
 949 static inline bool ufshcd_can_hibern8_during_gating(struct ufs_hba *hba)
 950 {
 951         return hba->caps & UFSHCD_CAP_HIBERN8_WITH_CLK_GATING;
 952 }
 953 static inline int ufshcd_is_clkscaling_supported(struct ufs_hba *hba)
 954 {
 955         return hba->caps & UFSHCD_CAP_CLK_SCALING;
 956 }
 957 static inline bool ufshcd_can_autobkops_during_suspend(struct ufs_hba *hba)
 958 {
 959         return hba->caps & UFSHCD_CAP_AUTO_BKOPS_SUSPEND;
 960 }
 961 static inline bool ufshcd_is_rpm_autosuspend_allowed(struct ufs_hba *hba)
 962 {
 963         return hba->caps & UFSHCD_CAP_RPM_AUTOSUSPEND;
 964 }
 965
 966 static inline bool ufshcd_is_intr_aggr_allowed(struct ufs_hba *hba)
 967 {
 968         return (hba->caps & UFSHCD_CAP_INTR_AGGR) &&
 969                 !(hba->quirks & UFSHCD_QUIRK_BROKEN_INTR_AGGR);
 970 }
 971
 972 static inline bool ufshcd_can_aggressive_pc(struct ufs_hba *hba)
 973 {
 974         return !!(ufshcd_is_link_hibern8(hba) &&
 975                   (hba->caps & UFSHCD_CAP_AGGR_POWER_COLLAPSE));
 976 }
 977
 978 static inline bool ufshcd_is_auto_hibern8_supported(struct ufs_hba *hba)
 979 {
 980         return (hba->capabilities & MASK_AUTO_HIBERN8_SUPPORT) &&
 981                 !(hba->quirks & UFSHCD_QUIRK_BROKEN_AUTO_HIBERN8);
 982 }
 983
 984 static inline bool ufshcd_is_auto_hibern8_enabled(struct ufs_hba *hba)
 985 {
 986         return FIELD_GET(UFSHCI_AHIBERN8_TIMER_MASK, hba->ahit) ? true : false;
 987 }
 988
 989 static inline bool ufshcd_is_wb_allowed(struct ufs_hba *hba)
 990 {
 991         return hba->caps & UFSHCD_CAP_WB_EN;
 992 }
 993
 994 static inline bool ufshcd_is_user_access_allowed(struct ufs_hba *hba)
 995 {
 996         return !hba->shutting_down;
 997 }
 998
 999 #define ufshcd_writel(hba, val, reg)    \
1000         writel((val), (hba)->mmio_base + (reg))
1001 #define ufshcd_readl(hba, reg)  \
1002         readl((hba)->mmio_base + (reg))
1003
1004 /**
1005  * ufshcd_rmwl - read modify write into a register
1006  * @hba - per adapter instance
1007  * @mask - mask to apply on read value
1008  * @val - actual value to write
1009  * @reg - register address
1010  */
1011 static inline void ufshcd_rmwl(struct ufs_hba *hba, u32 mask, u32 val, u32 reg)
1012 {
1013         u32 tmp;
1014
1015         tmp = ufshcd_readl(hba, reg);
1016         tmp &= ~mask;
1017         tmp |= (val & mask);
1018         ufshcd_writel(hba, tmp, reg);
1019 }
1020
1021 int ufshcd_alloc_host(struct device *, struct ufs_hba **);
1022 void ufshcd_dealloc_host(struct ufs_hba *);
1023 int ufshcd_hba_enable(struct ufs_hba *hba);
1024 int ufshcd_init(struct ufs_hba *, void __iomem *, unsigned int);
1025 int ufshcd_link_recovery(struct ufs_hba *hba);
1026 int ufshcd_make_hba_operational(struct ufs_hba *hba);
1027 void ufshcd_remove(struct ufs_hba *);
1028 int ufshcd_uic_hibern8_enter(struct ufs_hba *hba);
1029 int ufshcd_uic_hibern8_exit(struct ufs_hba *hba);
1030 void ufshcd_delay_us(unsigned long us, unsigned long tolerance);
1031 int ufshcd_wait_for_register(struct ufs_hba *hba, u32 reg, u32 mask,
1032                                 u32 val, unsigned long interval_us,
1033                                 unsigned long timeout_ms);
1034 void ufshcd_parse_dev_ref_clk_freq(struct ufs_hba *hba, struct clk *refclk);
1035 void ufshcd_update_evt_hist(struct ufs_hba *hba, u32 id, u32 val);
1036 void ufshcd_hba_stop(struct ufs_hba *hba);
1037 void ufshcd_schedule_eh_work(struct ufs_hba *hba);
1038
1039 static inline void check_upiu_size(void)
1040 {
1041         BUILD_BUG_ON(ALIGNED_UPIU_SIZE <
1042                 GENERAL_UPIU_REQUEST_SIZE + QUERY_DESC_MAX_SIZE);
1043 }
1044
1045 /**
1046  * ufshcd_set_variant - set variant specific data to the hba
1047  * @hba - per adapter instance
1048  * @variant - pointer to variant specific data
1049  */
1050 static inline void ufshcd_set_variant(struct ufs_hba *hba, void *variant)
1051 {
1052         BUG_ON(!hba);
1053         hba->priv = variant;
1054 }
1055
1056 /**
1057  * ufshcd_get_variant - get variant specific data from the hba
1058  * @hba - per adapter instance
1059  */
1060 static inline void *ufshcd_get_variant(struct ufs_hba *hba)
1061 {
1062         BUG_ON(!hba);
1063         return hba->priv;
1064 }
1065 static inline bool ufshcd_keep_autobkops_enabled_except_suspend(
1066                                                         struct ufs_hba *hba)
1067 {
1068         return hba->caps & UFSHCD_CAP_KEEP_AUTO_BKOPS_ENABLED_EXCEPT_SUSPEND;
1069 }
1070
1071 static inline u8 ufshcd_wb_get_query_index(struct ufs_hba *hba)
1072 {
1073         if (hba->dev_info.wb_buffer_type == WB_BUF_MODE_LU_DEDICATED)
1074                 return hba->dev_info.wb_dedicated_lu;
1075         return 0;
1076 }
1077
1078 #ifdef CONFIG_SCSI_UFS_HWMON
1079 void ufs_hwmon_probe(struct ufs_hba *hba, u8 mask);
1080 void ufs_hwmon_remove(struct ufs_hba *hba);
1081 void ufs_hwmon_notify_event(struct ufs_hba *hba, u8 ee_mask);
1082 #else
1083 static inline void ufs_hwmon_probe(struct ufs_hba *hba, u8 mask) {}
1084 static inline void ufs_hwmon_remove(struct ufs_hba *hba) {}
1085 static inline void ufs_hwmon_notify_event(struct ufs_hba *hba, u8 ee_mask) {}
1086 #endif
1087
1088 #ifdef CONFIG_PM
1089 extern int ufshcd_runtime_suspend(struct device *dev);
1090 extern int ufshcd_runtime_resume(struct device *dev);
1091 #endif
1092 #ifdef CONFIG_PM_SLEEP
1093 extern int ufshcd_system_suspend(struct device *dev);
1094 extern int ufshcd_system_resume(struct device *dev);
1095 #endif
1096 extern int ufshcd_shutdown(struct ufs_hba *hba);
1097 extern int ufshcd_dme_configure_adapt(struct ufs_hba *hba,
1098                                       int agreed_gear,
1099                                       int adapt_val);
1100 extern int ufshcd_dme_set_attr(struct ufs_hba *hba, u32 attr_sel,
1101                                u8 attr_set, u32 mib_val, u8 peer);
1102 extern int ufshcd_dme_get_attr(struct ufs_hba *hba, u32 attr_sel,
1103                                u32 *mib_val, u8 peer);
1104 extern int ufshcd_config_pwr_mode(struct ufs_hba *hba,
1105                         struct ufs_pa_layer_attr *desired_pwr_mode);
1106
1107 /* UIC command interfaces for DME primitives */
1108 #define DME_LOCAL       0
1109 #define DME_PEER        1
1110 #define ATTR_SET_NOR    0       /* NORMAL */
1111 #define ATTR_SET_ST     1       /* STATIC */
1112
1113 static inline int ufshcd_dme_set(struct ufs_hba *hba, u32 attr_sel,
1114                                  u32 mib_val)
1115 {
1116         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
1117                                    mib_val, DME_LOCAL);
1118 }
1119
1120 static inline int ufshcd_dme_st_set(struct ufs_hba *hba, u32 attr_sel,
1121                                     u32 mib_val)
1122 {
1123         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
1124                                    mib_val, DME_LOCAL);
1125 }
1126
1127 static inline int ufshcd_dme_peer_set(struct ufs_hba *hba, u32 attr_sel,
1128                                       u32 mib_val)
1129 {
1130         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
1131                                    mib_val, DME_PEER);
1132 }
1133
1134 static inline int ufshcd_dme_peer_st_set(struct ufs_hba *hba, u32 attr_sel,
1135                                          u32 mib_val)
1136 {
1137         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
1138                                    mib_val, DME_PEER);
1139 }
1140
1141 static inline int ufshcd_dme_get(struct ufs_hba *hba,
1142                                  u32 attr_sel, u32 *mib_val)
1143 {
1144         return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_LOCAL);
1145 }
1146
1147 static inline int ufshcd_dme_peer_get(struct ufs_hba *hba,
1148                                       u32 attr_sel, u32 *mib_val)
1149 {
1150         return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_PEER);
1151 }
1152
1153 static inline bool ufshcd_is_hs_mode(struct ufs_pa_layer_attr *pwr_info)
1154 {
1155         return (pwr_info->pwr_rx == FAST_MODE ||
1156                 pwr_info->pwr_rx == FASTAUTO_MODE) &&
1157                 (pwr_info->pwr_tx == FAST_MODE ||
1158                 pwr_info->pwr_tx == FASTAUTO_MODE);
1159 }
1160
1161 static inline int ufshcd_disable_host_tx_lcc(struct ufs_hba *hba)
1162 {
1163         return ufshcd_dme_set(hba, UIC_ARG_MIB(PA_LOCAL_TX_LCC_ENABLE), 0);
1164 }
1165
1166 /* Expose Query-Request API */
1167 int ufshcd_query_descriptor_retry(struct ufs_hba *hba,
1168                                   enum query_opcode opcode,
1169                                   enum desc_idn idn, u8 index,
1170                                   u8 selector,
1171                                   u8 *desc_buf, int *buf_len);
1172 int ufshcd_read_desc_param(struct ufs_hba *hba,
1173                            enum desc_idn desc_id,
1174                            int desc_index,
1175                            u8 param_offset,
1176                            u8 *param_read_buf,
1177                            u8 param_size);
1178 int ufshcd_query_attr_retry(struct ufs_hba *hba, enum query_opcode opcode,
1179                             enum attr_idn idn, u8 index, u8 selector,
1180                             u32 *attr_val);
1181 int ufshcd_query_attr(struct ufs_hba *hba, enum query_opcode opcode,
1182                       enum attr_idn idn, u8 index, u8 selector, u32 *attr_val);
1183 int ufshcd_query_flag(struct ufs_hba *hba, enum query_opcode opcode,
1184         enum flag_idn idn, u8 index, bool *flag_res);
1185
1186 void ufshcd_auto_hibern8_enable(struct ufs_hba *hba);
1187 void ufshcd_auto_hibern8_update(struct ufs_hba *hba, u32 ahit);
1188 void ufshcd_fixup_dev_quirks(struct ufs_hba *hba, struct ufs_dev_fix *fixups);
1189 #define SD_ASCII_STD true
1190 #define SD_RAW false
1191 int ufshcd_read_string_desc(struct ufs_hba *hba, u8 desc_index,
1192                             u8 **buf, bool ascii);
1193
1194 int ufshcd_hold(struct ufs_hba *hba, bool async);
1195 void ufshcd_release(struct ufs_hba *hba);
1196
1197 void ufshcd_map_desc_id_to_length(struct ufs_hba *hba, enum desc_idn desc_id,
1198                                   int *desc_length);
1199
1200 u32 ufshcd_get_local_unipro_ver(struct ufs_hba *hba);
1201
1202 int ufshcd_send_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd);
1203
1204 int ufshcd_exec_raw_upiu_cmd(struct ufs_hba *hba,
1205                              struct utp_upiu_req *req_upiu,
1206                              struct utp_upiu_req *rsp_upiu,
1207                              int msgcode,
1208                              u8 *desc_buff, int *buff_len,
1209                              enum query_opcode desc_op);
1210
1211 int ufshcd_wb_toggle(struct ufs_hba *hba, bool enable);
1212 int ufshcd_suspend_prepare(struct device *dev);
1213 int __ufshcd_suspend_prepare(struct device *dev, bool rpm_ok_for_spm);
1214 void ufshcd_resume_complete(struct device *dev);
1215
1216 /* Wrapper functions for safely calling variant operations */
1217 static inline const char *ufshcd_get_var_name(struct ufs_hba *hba)
1218 {
1219         if (hba->vops)
1220                 return hba->vops->name;
1221         return "";
1222 }
1223
1224 static inline int ufshcd_vops_init(struct ufs_hba *hba)
1225 {
1226         if (hba->vops && hba->vops->init)
1227                 return hba->vops->init(hba);
1228
1229         return 0;
1230 }
1231
1232 static inline void ufshcd_vops_exit(struct ufs_hba *hba)
1233 {
1234         if (hba->vops && hba->vops->exit)
1235                 return hba->vops->exit(hba);
1236 }
1237
1238 static inline u32 ufshcd_vops_get_ufs_hci_version(struct ufs_hba *hba)
1239 {
1240         if (hba->vops && hba->vops->get_ufs_hci_version)
1241                 return hba->vops->get_ufs_hci_version(hba);
1242
1243         return ufshcd_readl(hba, REG_UFS_VERSION);
1244 }
1245
1246 static inline int ufshcd_vops_clk_scale_notify(struct ufs_hba *hba,
1247                         bool up, enum ufs_notify_change_status status)
1248 {
1249         if (hba->vops && hba->vops->clk_scale_notify)
1250                 return hba->vops->clk_scale_notify(hba, up, status);
1251         return 0;
1252 }
1253
1254 static inline void ufshcd_vops_event_notify(struct ufs_hba *hba,
1255                                             enum ufs_event_type evt,
1256                                             void *data)
1257 {
1258         if (hba->vops && hba->vops->event_notify)
1259                 hba->vops->event_notify(hba, evt, data);
1260 }
1261
1262 static inline int ufshcd_vops_setup_clocks(struct ufs_hba *hba, bool on,
1263                                         enum ufs_notify_change_status status)
1264 {
1265         if (hba->vops && hba->vops->setup_clocks)
1266                 return hba->vops->setup_clocks(hba, on, status);
1267         return 0;
1268 }
1269
1270 static inline int ufshcd_vops_hce_enable_notify(struct ufs_hba *hba,
1271                                                 bool status)
1272 {
1273         if (hba->vops && hba->vops->hce_enable_notify)
1274                 return hba->vops->hce_enable_notify(hba, status);
1275
1276         return 0;
1277 }
1278 static inline int ufshcd_vops_link_startup_notify(struct ufs_hba *hba,
1279                                                 bool status)
1280 {
1281         if (hba->vops && hba->vops->link_startup_notify)
1282                 return hba->vops->link_startup_notify(hba, status);
1283
1284         return 0;
1285 }
1286
1287 static inline int ufshcd_vops_phy_initialization(struct ufs_hba *hba)
1288 {
1289         if (hba->vops && hba->vops->phy_initialization)
1290                 return hba->vops->phy_initialization(hba);
1291
1292         return 0;
1293 }
1294
1295 static inline int ufshcd_vops_pwr_change_notify(struct ufs_hba *hba,
1296                                   enum ufs_notify_change_status status,
1297                                   struct ufs_pa_layer_attr *dev_max_params,
1298                                   struct ufs_pa_layer_attr *dev_req_params)
1299 {
1300         if (hba->vops && hba->vops->pwr_change_notify)
1301                 return hba->vops->pwr_change_notify(hba, status,
1302                                         dev_max_params, dev_req_params);
1303
1304         return -ENOTSUPP;
1305 }
1306
1307 static inline void ufshcd_vops_setup_task_mgmt(struct ufs_hba *hba,
1308                                         int tag, u8 tm_function)
1309 {
1310         if (hba->vops && hba->vops->setup_task_mgmt)
1311                 return hba->vops->setup_task_mgmt(hba, tag, tm_function);
1312 }
1313
1314 static inline void ufshcd_vops_hibern8_notify(struct ufs_hba *hba,
1315                                         enum uic_cmd_dme cmd,
1316                                         enum ufs_notify_change_status status)
1317 {
1318         if (hba->vops && hba->vops->hibern8_notify)
1319                 return hba->vops->hibern8_notify(hba, cmd, status);
1320 }
1321
1322 static inline int ufshcd_vops_apply_dev_quirks(struct ufs_hba *hba)
1323 {
1324         if (hba->vops && hba->vops->apply_dev_quirks)
1325                 return hba->vops->apply_dev_quirks(hba);
1326         return 0;
1327 }
1328
1329 static inline void ufshcd_vops_fixup_dev_quirks(struct ufs_hba *hba)
1330 {
1331         if (hba->vops && hba->vops->fixup_dev_quirks)
1332                 hba->vops->fixup_dev_quirks(hba);
1333 }
1334
1335 static inline int ufshcd_vops_suspend(struct ufs_hba *hba, enum ufs_pm_op op,
1336                                 enum ufs_notify_change_status status)
1337 {
1338         if (hba->vops && hba->vops->suspend)
1339                 return hba->vops->suspend(hba, op, status);
1340
1341         return 0;
1342 }
1343
1344 static inline int ufshcd_vops_resume(struct ufs_hba *hba, enum ufs_pm_op op)
1345 {
1346         if (hba->vops && hba->vops->resume)
1347                 return hba->vops->resume(hba, op);
1348
1349         return 0;
1350 }
1351
1352 static inline void ufshcd_vops_dbg_register_dump(struct ufs_hba *hba)
1353 {
1354         if (hba->vops && hba->vops->dbg_register_dump)
1355                 hba->vops->dbg_register_dump(hba);
1356 }
1357
1358 static inline int ufshcd_vops_device_reset(struct ufs_hba *hba)
1359 {
1360         if (hba->vops && hba->vops->device_reset)
1361                 return hba->vops->device_reset(hba);
1362
1363         return -EOPNOTSUPP;
1364 }
1365
1366 static inline void ufshcd_vops_config_scaling_param(struct ufs_hba *hba,
1367                                                     struct devfreq_dev_profile
1368                                                     *profile, void *data)
1369 {
1370         if (hba->vops && hba->vops->config_scaling_param)
1371                 hba->vops->config_scaling_param(hba, profile, data);
1372 }
1373
1374 extern struct ufs_pm_lvl_states ufs_pm_lvl_states[];
1375
1376 /*
1377  * ufshcd_scsi_to_upiu_lun - maps scsi LUN to UPIU LUN
1378  * @scsi_lun: scsi LUN id
1379  *
1380  * Returns UPIU LUN id
1381  */
1382 static inline u8 ufshcd_scsi_to_upiu_lun(unsigned int scsi_lun)
1383 {
1384         if (scsi_is_wlun(scsi_lun))
1385                 return (scsi_lun & UFS_UPIU_MAX_UNIT_NUM_ID)
1386                         | UFS_UPIU_WLUN_ID;
1387         else
1388                 return scsi_lun & UFS_UPIU_MAX_UNIT_NUM_ID;
1389 }
1390
1391 int ufshcd_dump_regs(struct ufs_hba *hba, size_t offset, size_t len,
1392                      const char *prefix);
1393
1394 int __ufshcd_write_ee_control(struct ufs_hba *hba, u32 ee_ctrl_mask);
1395 int ufshcd_write_ee_control(struct ufs_hba *hba);
1396 int ufshcd_update_ee_control(struct ufs_hba *hba, u16 *mask, u16 *other_mask,
1397                              u16 set, u16 clr);
1398
1399 static inline int ufshcd_update_ee_drv_mask(struct ufs_hba *hba,
1400                                             u16 set, u16 clr)
1401 {
1402         return ufshcd_update_ee_control(hba, &hba->ee_drv_mask,
1403                                         &hba->ee_usr_mask, set, clr);
1404 }
1405
1406 static inline int ufshcd_update_ee_usr_mask(struct ufs_hba *hba,
1407                                             u16 set, u16 clr)
1408 {
1409         return ufshcd_update_ee_control(hba, &hba->ee_usr_mask,
1410                                         &hba->ee_drv_mask, set, clr);
1411 }
1412
1413 static inline int ufshcd_rpm_get_sync(struct ufs_hba *hba)
1414 {
1415         return pm_runtime_get_sync(&hba->sdev_ufs_device->sdev_gendev);
1416 }
1417
1418 static inline int ufshcd_rpm_put_sync(struct ufs_hba *hba)
1419 {
1420         return pm_runtime_put_sync(&hba->sdev_ufs_device->sdev_gendev);
1421 }
1422
1423 static inline void ufshcd_rpm_get_noresume(struct ufs_hba *hba)
1424 {
1425         pm_runtime_get_noresume(&hba->sdev_ufs_device->sdev_gendev);
1426 }
1427
1428 static inline int ufshcd_rpm_resume(struct ufs_hba *hba)
1429 {
1430         return pm_runtime_resume(&hba->sdev_ufs_device->sdev_gendev);
1431 }
1432
1433 static inline int ufshcd_rpm_put(struct ufs_hba *hba)
1434 {
1435         return pm_runtime_put(&hba->sdev_ufs_device->sdev_gendev);
1436 }
1437
1438 #endif /* End of Header */