drivers/scsi/ufs/ufshcd.h

   1 /*
   2  * Universal Flash Storage Host controller driver
   3  *
   4  * This code is based on drivers/scsi/ufs/ufshcd.h
   5  * Copyright (C) 2011-2013 Samsung India Software Operations
   6  * Copyright (c) 2013-2016, The Linux Foundation. All rights reserved.
   7  *
   8  * Authors:
   9  *      Santosh Yaraganavi <santosh.sy@samsung.com>
  10  *      Vinayak Holikatti <h.vinayak@samsung.com>
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  * See the COPYING file in the top-level directory or visit
  17  * <http://www.gnu.org/licenses/gpl-2.0.html>
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * This program is provided "AS IS" and "WITH ALL FAULTS" and
  25  * without warranty of any kind. You are solely responsible for
  26  * determining the appropriateness of using and distributing
  27  * the program and assume all risks associated with your exercise
  28  * of rights with respect to the program, including but not limited
  29  * to infringement of third party rights, the risks and costs of
  30  * program errors, damage to or loss of data, programs or equipment,
  31  * and unavailability or interruption of operations. Under no
  32  * circumstances will the contributor of this Program be liable for
  33  * any damages of any kind arising from your use or distribution of
  34  * this program.
  35  */
  36
  37 #ifndef _UFSHCD_H
  38 #define _UFSHCD_H
  39
  40 #include <linux/module.h>
  41 #include <linux/kernel.h>
  42 #include <linux/init.h>
  43 #include <linux/interrupt.h>
  44 #include <linux/io.h>
  45 #include <linux/delay.h>
  46 #include <linux/slab.h>
  47 #include <linux/spinlock.h>
  48 #include <linux/rwsem.h>
  49 #include <linux/workqueue.h>
  50 #include <linux/errno.h>
  51 #include <linux/types.h>
  52 #include <linux/wait.h>
  53 #include <linux/bitops.h>
  54 #include <linux/pm_runtime.h>
  55 #include <linux/clk.h>
  56 #include <linux/completion.h>
  57 #include <linux/regulator/consumer.h>
  58 #include "unipro.h"
  59
  60 #include <asm/irq.h>
  61 #include <asm/byteorder.h>
  62 #include <scsi/scsi.h>
  63 #include <scsi/scsi_cmnd.h>
  64 #include <scsi/scsi_host.h>
  65 #include <scsi/scsi_tcq.h>
  66 #include <scsi/scsi_dbg.h>
  67 #include <scsi/scsi_eh.h>
  68
  69 #include "ufs.h"
  70 #include "ufshci.h"
  71
  72 #define UFSHCD "ufshcd"
  73 #define UFSHCD_DRIVER_VERSION "0.2"
  74
  75 struct ufs_hba;
  76
  77 enum dev_cmd_type {
  78         DEV_CMD_TYPE_NOP                = 0x0,
  79         DEV_CMD_TYPE_QUERY              = 0x1,
  80 };
  81
  82 /**
  83  * struct uic_command - UIC command structure
  84  * @command: UIC command
  85  * @argument1: UIC command argument 1
  86  * @argument2: UIC command argument 2
  87  * @argument3: UIC command argument 3
  88  * @cmd_active: Indicate if UIC command is outstanding
  89  * @result: UIC command result
  90  * @done: UIC command completion
  91  */
  92 struct uic_command {
  93         u32 command;
  94         u32 argument1;
  95         u32 argument2;
  96         u32 argument3;
  97         int cmd_active;
  98         int result;
  99         struct completion done;
 100 };
 101
 102 /* Used to differentiate the power management options */
 103 enum ufs_pm_op {
 104         UFS_RUNTIME_PM,
 105         UFS_SYSTEM_PM,
 106         UFS_SHUTDOWN_PM,
 107 };
 108
 109 #define ufshcd_is_runtime_pm(op) ((op) == UFS_RUNTIME_PM)
 110 #define ufshcd_is_system_pm(op) ((op) == UFS_SYSTEM_PM)
 111 #define ufshcd_is_shutdown_pm(op) ((op) == UFS_SHUTDOWN_PM)
 112
 113 /* Host <-> Device UniPro Link state */
 114 enum uic_link_state {
 115         UIC_LINK_OFF_STATE      = 0, /* Link powered down or disabled */
 116         UIC_LINK_ACTIVE_STATE   = 1, /* Link is in Fast/Slow/Sleep state */
 117         UIC_LINK_HIBERN8_STATE  = 2, /* Link is in Hibernate state */
 118 };
 119
 120 #define ufshcd_is_link_off(hba) ((hba)->uic_link_state == UIC_LINK_OFF_STATE)
 121 #define ufshcd_is_link_active(hba) ((hba)->uic_link_state == \
 122                                     UIC_LINK_ACTIVE_STATE)
 123 #define ufshcd_is_link_hibern8(hba) ((hba)->uic_link_state == \
 124                                     UIC_LINK_HIBERN8_STATE)
 125 #define ufshcd_set_link_off(hba) ((hba)->uic_link_state = UIC_LINK_OFF_STATE)
 126 #define ufshcd_set_link_active(hba) ((hba)->uic_link_state = \
 127                                     UIC_LINK_ACTIVE_STATE)
 128 #define ufshcd_set_link_hibern8(hba) ((hba)->uic_link_state = \
 129                                     UIC_LINK_HIBERN8_STATE)
 130
 131 /*
 132  * UFS Power management levels.
 133  * Each level is in increasing order of power savings.
 134  */
 135 enum ufs_pm_level {
 136         UFS_PM_LVL_0, /* UFS_ACTIVE_PWR_MODE, UIC_LINK_ACTIVE_STATE */
 137         UFS_PM_LVL_1, /* UFS_ACTIVE_PWR_MODE, UIC_LINK_HIBERN8_STATE */
 138         UFS_PM_LVL_2, /* UFS_SLEEP_PWR_MODE, UIC_LINK_ACTIVE_STATE */
 139         UFS_PM_LVL_3, /* UFS_SLEEP_PWR_MODE, UIC_LINK_HIBERN8_STATE */
 140         UFS_PM_LVL_4, /* UFS_POWERDOWN_PWR_MODE, UIC_LINK_HIBERN8_STATE */
 141         UFS_PM_LVL_5, /* UFS_POWERDOWN_PWR_MODE, UIC_LINK_OFF_STATE */
 142         UFS_PM_LVL_MAX
 143 };
 144
 145 struct ufs_pm_lvl_states {
 146         enum ufs_dev_pwr_mode dev_state;
 147         enum uic_link_state link_state;
 148 };
 149
 150 /**
 151  * struct ufshcd_lrb - local reference block
 152  * @utr_descriptor_ptr: UTRD address of the command
 153  * @ucd_req_ptr: UCD address of the command
 154  * @ucd_rsp_ptr: Response UPIU address for this command
 155  * @ucd_prdt_ptr: PRDT address of the command
 156  * @utrd_dma_addr: UTRD dma address for debug
 157  * @ucd_prdt_dma_addr: PRDT dma address for debug
 158  * @ucd_rsp_dma_addr: UPIU response dma address for debug
 159  * @ucd_req_dma_addr: UPIU request dma address for debug
 160  * @cmd: pointer to SCSI command
 161  * @sense_buffer: pointer to sense buffer address of the SCSI command
 162  * @sense_bufflen: Length of the sense buffer
 163  * @scsi_status: SCSI status of the command
 164  * @command_type: SCSI, UFS, Query.
 165  * @task_tag: Task tag of the command
 166  * @lun: LUN of the command
 167  * @intr_cmd: Interrupt command (doesn't participate in interrupt aggregation)
 168  * @issue_time_stamp: time stamp for debug purposes
 169  * @compl_time_stamp: time stamp for statistics
 170  * @req_abort_skip: skip request abort task flag
 171  */
 172 struct ufshcd_lrb {
 173         struct utp_transfer_req_desc *utr_descriptor_ptr;
 174         struct utp_upiu_req *ucd_req_ptr;
 175         struct utp_upiu_rsp *ucd_rsp_ptr;
 176         struct ufshcd_sg_entry *ucd_prdt_ptr;
 177
 178         dma_addr_t utrd_dma_addr;
 179         dma_addr_t ucd_req_dma_addr;
 180         dma_addr_t ucd_rsp_dma_addr;
 181         dma_addr_t ucd_prdt_dma_addr;
 182
 183         struct scsi_cmnd *cmd;
 184         u8 *sense_buffer;
 185         unsigned int sense_bufflen;
 186         int scsi_status;
 187
 188         int command_type;
 189         int task_tag;
 190         u8 lun; /* UPIU LUN id field is only 8-bit wide */
 191         bool intr_cmd;
 192         ktime_t issue_time_stamp;
 193         ktime_t compl_time_stamp;
 194
 195         bool req_abort_skip;
 196 };
 197
 198 /**
 199  * struct ufs_query - holds relevant data structures for query request
 200  * @request: request upiu and function
 201  * @descriptor: buffer for sending/receiving descriptor
 202  * @response: response upiu and response
 203  */
 204 struct ufs_query {
 205         struct ufs_query_req request;
 206         u8 *descriptor;
 207         struct ufs_query_res response;
 208 };
 209
 210 /**
 211  * struct ufs_dev_cmd - all assosiated fields with device management commands
 212  * @type: device management command type - Query, NOP OUT
 213  * @lock: lock to allow one command at a time
 214  * @complete: internal commands completion
 215  */
 216 struct ufs_dev_cmd {
 217         enum dev_cmd_type type;
 218         struct mutex lock;
 219         struct completion *complete;
 220         struct ufs_query query;
 221 };
 222
 223 struct ufs_desc_size {
 224         int dev_desc;
 225         int pwr_desc;
 226         int geom_desc;
 227         int interc_desc;
 228         int unit_desc;
 229         int conf_desc;
 230         int hlth_desc;
 231 };
 232
 233 /**
 234  * struct ufs_clk_info - UFS clock related info
 235  * @list: list headed by hba->clk_list_head
 236  * @clk: clock node
 237  * @name: clock name
 238  * @max_freq: maximum frequency supported by the clock
 239  * @min_freq: min frequency that can be used for clock scaling
 240  * @curr_freq: indicates the current frequency that it is set to
 241  * @enabled: variable to check against multiple enable/disable
 242  */
 243 struct ufs_clk_info {
 244         struct list_head list;
 245         struct clk *clk;
 246         const char *name;
 247         u32 max_freq;
 248         u32 min_freq;
 249         u32 curr_freq;
 250         bool enabled;
 251 };
 252
 253 enum ufs_notify_change_status {
 254         PRE_CHANGE,
 255         POST_CHANGE,
 256 };
 257
 258 struct ufs_pa_layer_attr {
 259         u32 gear_rx;
 260         u32 gear_tx;
 261         u32 lane_rx;
 262         u32 lane_tx;
 263         u32 pwr_rx;
 264         u32 pwr_tx;
 265         u32 hs_rate;
 266 };
 267
 268 struct ufs_pwr_mode_info {
 269         bool is_valid;
 270         struct ufs_pa_layer_attr info;
 271 };
 272
 273 /**
 274  * struct ufs_hba_variant_ops - variant specific callbacks
 275  * @name: variant name
 276  * @init: called when the driver is initialized
 277  * @exit: called to cleanup everything done in init
 278  * @get_ufs_hci_version: called to get UFS HCI version
 279  * @clk_scale_notify: notifies that clks are scaled up/down
 280  * @setup_clocks: called before touching any of the controller registers
 281  * @setup_regulators: called before accessing the host controller
 282  * @hce_enable_notify: called before and after HCE enable bit is set to allow
 283  *                     variant specific Uni-Pro initialization.
 284  * @link_startup_notify: called before and after Link startup is carried out
 285  *                       to allow variant specific Uni-Pro initialization.
 286  * @pwr_change_notify: called before and after a power mode change
 287  *                      is carried out to allow vendor spesific capabilities
 288  *                      to be set.
 289  * @setup_xfer_req: called before any transfer request is issued
 290  *                  to set some things
 291  * @setup_task_mgmt: called before any task management request is issued
 292  *                  to set some things
 293  * @hibern8_notify: called around hibern8 enter/exit
 294  * @apply_dev_quirks: called to apply device specific quirks
 295  * @suspend: called during host controller PM callback
 296  * @resume: called during host controller PM callback
 297  * @dbg_register_dump: used to dump controller debug information
 298  * @phy_initialization: used to initialize phys
 299  * @device_reset: called to issue a reset pulse on the UFS device
 300  */
 301 struct ufs_hba_variant_ops {
 302         const char *name;
 303         int     (*init)(struct ufs_hba *);
 304         void    (*exit)(struct ufs_hba *);
 305         u32     (*get_ufs_hci_version)(struct ufs_hba *);
 306         int     (*clk_scale_notify)(struct ufs_hba *, bool,
 307                                     enum ufs_notify_change_status);
 308         int     (*setup_clocks)(struct ufs_hba *, bool,
 309                                 enum ufs_notify_change_status);
 310         int     (*setup_regulators)(struct ufs_hba *, bool);
 311         int     (*hce_enable_notify)(struct ufs_hba *,
 312                                      enum ufs_notify_change_status);
 313         int     (*link_startup_notify)(struct ufs_hba *,
 314                                        enum ufs_notify_change_status);
 315         int     (*pwr_change_notify)(struct ufs_hba *,
 316                                         enum ufs_notify_change_status status,
 317                                         struct ufs_pa_layer_attr *,
 318                                         struct ufs_pa_layer_attr *);
 319         void    (*setup_xfer_req)(struct ufs_hba *, int, bool);
 320         void    (*setup_task_mgmt)(struct ufs_hba *, int, u8);
 321         void    (*hibern8_notify)(struct ufs_hba *, enum uic_cmd_dme,
 322                                         enum ufs_notify_change_status);
 323         int     (*apply_dev_quirks)(struct ufs_hba *hba);
 324         int     (*suspend)(struct ufs_hba *, enum ufs_pm_op);
 325         int     (*resume)(struct ufs_hba *, enum ufs_pm_op);
 326         void    (*dbg_register_dump)(struct ufs_hba *hba);
 327         int     (*phy_initialization)(struct ufs_hba *);
 328         void    (*device_reset)(struct ufs_hba *hba);
 329 };
 330
 331 /* clock gating state  */
 332 enum clk_gating_state {
 333         CLKS_OFF,
 334         CLKS_ON,
 335         REQ_CLKS_OFF,
 336         REQ_CLKS_ON,
 337 };
 338
 339 /**
 340  * struct ufs_clk_gating - UFS clock gating related info
 341  * @gate_work: worker to turn off clocks after some delay as specified in
 342  * delay_ms
 343  * @ungate_work: worker to turn on clocks that will be used in case of
 344  * interrupt context
 345  * @state: the current clocks state
 346  * @delay_ms: gating delay in ms
 347  * @is_suspended: clk gating is suspended when set to 1 which can be used
 348  * during suspend/resume
 349  * @delay_attr: sysfs attribute to control delay_attr
 350  * @enable_attr: sysfs attribute to enable/disable clock gating
 351  * @is_enabled: Indicates the current status of clock gating
 352  * @active_reqs: number of requests that are pending and should be waited for
 353  * completion before gating clocks.
 354  */
 355 struct ufs_clk_gating {
 356         struct delayed_work gate_work;
 357         struct work_struct ungate_work;
 358         enum clk_gating_state state;
 359         unsigned long delay_ms;
 360         bool is_suspended;
 361         struct device_attribute delay_attr;
 362         struct device_attribute enable_attr;
 363         bool is_enabled;
 364         int active_reqs;
 365         struct workqueue_struct *clk_gating_workq;
 366 };
 367
 368 struct ufs_saved_pwr_info {
 369         struct ufs_pa_layer_attr info;
 370         bool is_valid;
 371 };
 372
 373 /**
 374  * struct ufs_clk_scaling - UFS clock scaling related data
 375  * @active_reqs: number of requests that are pending. If this is zero when
 376  * devfreq ->target() function is called then schedule "suspend_work" to
 377  * suspend devfreq.
 378  * @tot_busy_t: Total busy time in current polling window
 379  * @window_start_t: Start time (in jiffies) of the current polling window
 380  * @busy_start_t: Start time of current busy period
 381  * @enable_attr: sysfs attribute to enable/disable clock scaling
 382  * @saved_pwr_info: UFS power mode may also be changed during scaling and this
 383  * one keeps track of previous power mode.
 384  * @workq: workqueue to schedule devfreq suspend/resume work
 385  * @suspend_work: worker to suspend devfreq
 386  * @resume_work: worker to resume devfreq
 387  * @is_allowed: tracks if scaling is currently allowed or not
 388  * @is_busy_started: tracks if busy period has started or not
 389  * @is_suspended: tracks if devfreq is suspended or not
 390  */
 391 struct ufs_clk_scaling {
 392         int active_reqs;
 393         unsigned long tot_busy_t;
 394         unsigned long window_start_t;
 395         ktime_t busy_start_t;
 396         struct device_attribute enable_attr;
 397         struct ufs_saved_pwr_info saved_pwr_info;
 398         struct workqueue_struct *workq;
 399         struct work_struct suspend_work;
 400         struct work_struct resume_work;
 401         bool is_allowed;
 402         bool is_busy_started;
 403         bool is_suspended;
 404 };
 405
 406 /**
 407  * struct ufs_init_prefetch - contains data that is pre-fetched once during
 408  * initialization
 409  * @icc_level: icc level which was read during initialization
 410  */
 411 struct ufs_init_prefetch {
 412         u32 icc_level;
 413 };
 414
 415 #define UFS_ERR_REG_HIST_LENGTH 8
 416 /**
 417  * struct ufs_err_reg_hist - keeps history of errors
 418  * @pos: index to indicate cyclic buffer position
 419  * @reg: cyclic buffer for registers value
 420  * @tstamp: cyclic buffer for time stamp
 421  */
 422 struct ufs_err_reg_hist {
 423         int pos;
 424         u32 reg[UFS_ERR_REG_HIST_LENGTH];
 425         ktime_t tstamp[UFS_ERR_REG_HIST_LENGTH];
 426 };
 427
 428 /**
 429  * struct ufs_stats - keeps usage/err statistics
 430  * @hibern8_exit_cnt: Counter to keep track of number of exits,
 431  *              reset this after link-startup.
 432  * @last_hibern8_exit_tstamp: Set time after the hibern8 exit.
 433  *              Clear after the first successful command completion.
 434  * @pa_err: tracks pa-uic errors
 435  * @dl_err: tracks dl-uic errors
 436  * @nl_err: tracks nl-uic errors
 437  * @tl_err: tracks tl-uic errors
 438  * @dme_err: tracks dme errors
 439  * @auto_hibern8_err: tracks auto-hibernate errors
 440  * @fatal_err: tracks fatal errors
 441  * @linkup_err: tracks link-startup errors
 442  * @resume_err: tracks resume errors
 443  * @suspend_err: tracks suspend errors
 444  * @dev_reset: tracks device reset events
 445  * @host_reset: tracks host reset events
 446  * @tsk_abort: tracks task abort events
 447  */
 448 struct ufs_stats {
 449         u32 hibern8_exit_cnt;
 450         ktime_t last_hibern8_exit_tstamp;
 451
 452         /* uic specific errors */
 453         struct ufs_err_reg_hist pa_err;
 454         struct ufs_err_reg_hist dl_err;
 455         struct ufs_err_reg_hist nl_err;
 456         struct ufs_err_reg_hist tl_err;
 457         struct ufs_err_reg_hist dme_err;
 458
 459         /* fatal errors */
 460         struct ufs_err_reg_hist auto_hibern8_err;
 461         struct ufs_err_reg_hist fatal_err;
 462         struct ufs_err_reg_hist link_startup_err;
 463         struct ufs_err_reg_hist resume_err;
 464         struct ufs_err_reg_hist suspend_err;
 465
 466         /* abnormal events */
 467         struct ufs_err_reg_hist dev_reset;
 468         struct ufs_err_reg_hist host_reset;
 469         struct ufs_err_reg_hist task_abort;
 470 };
 471
 472 /**
 473  * struct ufs_hba - per adapter private structure
 474  * @mmio_base: UFSHCI base register address
 475  * @ucdl_base_addr: UFS Command Descriptor base address
 476  * @utrdl_base_addr: UTP Transfer Request Descriptor base address
 477  * @utmrdl_base_addr: UTP Task Management Descriptor base address
 478  * @ucdl_dma_addr: UFS Command Descriptor DMA address
 479  * @utrdl_dma_addr: UTRDL DMA address
 480  * @utmrdl_dma_addr: UTMRDL DMA address
 481  * @host: Scsi_Host instance of the driver
 482  * @dev: device handle
 483  * @lrb: local reference block
 484  * @cmd_queue: Used to allocate command tags from hba->host->tag_set.
 485  * @outstanding_tasks: Bits representing outstanding task requests
 486  * @outstanding_reqs: Bits representing outstanding transfer requests
 487  * @capabilities: UFS Controller Capabilities
 488  * @nutrs: Transfer Request Queue depth supported by controller
 489  * @nutmrs: Task Management Queue depth supported by controller
 490  * @ufs_version: UFS Version to which controller complies
 491  * @vops: pointer to variant specific operations
 492  * @priv: pointer to variant specific private data
 493  * @irq: Irq number of the controller
 494  * @active_uic_cmd: handle of active UIC command
 495  * @uic_cmd_mutex: mutex for uic command
 496  * @tmf_tag_set: TMF tag set.
 497  * @tmf_queue: Used to allocate TMF tags.
 498  * @pwr_done: completion for power mode change
 499  * @ufshcd_state: UFSHCD states
 500  * @eh_flags: Error handling flags
 501  * @intr_mask: Interrupt Mask Bits
 502  * @ee_ctrl_mask: Exception event control mask
 503  * @is_powered: flag to check if HBA is powered
 504  * @init_prefetch_data: data pre-fetched during initialization
 505  * @eh_work: Worker to handle UFS errors that require s/w attention
 506  * @eeh_work: Worker to handle exception events
 507  * @errors: HBA errors
 508  * @uic_error: UFS interconnect layer error status
 509  * @saved_err: sticky error mask
 510  * @saved_uic_err: sticky UIC error mask
 511  * @silence_err_logs: flag to silence error logs
 512  * @dev_cmd: ufs device management command information
 513  * @last_dme_cmd_tstamp: time stamp of the last completed DME command
 514  * @auto_bkops_enabled: to track whether bkops is enabled in device
 515  * @vreg_info: UFS device voltage regulator information
 516  * @clk_list_head: UFS host controller clocks list node head
 517  * @pwr_info: holds current power mode
 518  * @max_pwr_info: keeps the device max valid pwm
 519  * @desc_size: descriptor sizes reported by device
 520  * @urgent_bkops_lvl: keeps track of urgent bkops level for device
 521  * @is_urgent_bkops_lvl_checked: keeps track if the urgent bkops level for
 522  *  device is known or not.
 523  * @scsi_block_reqs_cnt: reference counting for scsi block requests
 524  */
 525 struct ufs_hba {
 526         void __iomem *mmio_base;
 527
 528         /* Virtual memory reference */
 529         struct utp_transfer_cmd_desc *ucdl_base_addr;
 530         struct utp_transfer_req_desc *utrdl_base_addr;
 531         struct utp_task_req_desc *utmrdl_base_addr;
 532
 533         /* DMA memory reference */
 534         dma_addr_t ucdl_dma_addr;
 535         dma_addr_t utrdl_dma_addr;
 536         dma_addr_t utmrdl_dma_addr;
 537
 538         struct Scsi_Host *host;
 539         struct device *dev;
 540         struct request_queue *cmd_queue;
 541         /*
 542          * This field is to keep a reference to "scsi_device" corresponding to
 543          * "UFS device" W-LU.
 544          */
 545         struct scsi_device *sdev_ufs_device;
 546
 547         enum ufs_dev_pwr_mode curr_dev_pwr_mode;
 548         enum uic_link_state uic_link_state;
 549         /* Desired UFS power management level during runtime PM */
 550         enum ufs_pm_level rpm_lvl;
 551         /* Desired UFS power management level during system PM */
 552         enum ufs_pm_level spm_lvl;
 553         struct device_attribute rpm_lvl_attr;
 554         struct device_attribute spm_lvl_attr;
 555         int pm_op_in_progress;
 556
 557         /* Auto-Hibernate Idle Timer register value */
 558         u32 ahit;
 559
 560         struct ufshcd_lrb *lrb;
 561
 562         unsigned long outstanding_tasks;
 563         unsigned long outstanding_reqs;
 564
 565         u32 capabilities;
 566         int nutrs;
 567         int nutmrs;
 568         u32 ufs_version;
 569         const struct ufs_hba_variant_ops *vops;
 570         void *priv;
 571         unsigned int irq;
 572         bool is_irq_enabled;
 573         enum ufs_ref_clk_freq dev_ref_clk_freq;
 574
 575         /* Interrupt aggregation support is broken */
 576         #define UFSHCD_QUIRK_BROKEN_INTR_AGGR                   0x1
 577
 578         /*
 579          * delay before each dme command is required as the unipro
 580          * layer has shown instabilities
 581          */
 582         #define UFSHCD_QUIRK_DELAY_BEFORE_DME_CMDS              0x2
 583
 584         /*
 585          * If UFS host controller is having issue in processing LCC (Line
 586          * Control Command) coming from device then enable this quirk.
 587          * When this quirk is enabled, host controller driver should disable
 588          * the LCC transmission on UFS device (by clearing TX_LCC_ENABLE
 589          * attribute of device to 0).
 590          */
 591         #define UFSHCD_QUIRK_BROKEN_LCC                         0x4
 592
 593         /*
 594          * The attribute PA_RXHSUNTERMCAP specifies whether or not the
 595          * inbound Link supports unterminated line in HS mode. Setting this
 596          * attribute to 1 fixes moving to HS gear.
 597          */
 598         #define UFSHCD_QUIRK_BROKEN_PA_RXHSUNTERMCAP            0x8
 599
 600         /*
 601          * This quirk needs to be enabled if the host contoller only allows
 602          * accessing the peer dme attributes in AUTO mode (FAST AUTO or
 603          * SLOW AUTO).
 604          */
 605         #define UFSHCD_QUIRK_DME_PEER_ACCESS_AUTO_MODE          0x10
 606
 607         /*
 608          * This quirk needs to be enabled if the host contoller doesn't
 609          * advertise the correct version in UFS_VER register. If this quirk
 610          * is enabled, standard UFS host driver will call the vendor specific
 611          * ops (get_ufs_hci_version) to get the correct version.
 612          */
 613         #define UFSHCD_QUIRK_BROKEN_UFS_HCI_VERSION             0x20
 614
 615         /*
 616          * This quirk needs to be enabled if the host contoller regards
 617          * resolution of the values of PRDTO and PRDTL in UTRD as byte.
 618          */
 619         #define UFSHCD_QUIRK_PRDT_BYTE_GRAN                     0x80
 620
 621         /*
 622          * Clear handling for transfer/task request list is just opposite.
 623          */
 624         #define UFSHCI_QUIRK_BROKEN_REQ_LIST_CLR                0x100
 625
 626         /*
 627          * This quirk needs to be enabled if host controller doesn't allow
 628          * that the interrupt aggregation timer and counter are reset by s/w.
 629          */
 630         #define UFSHCI_QUIRK_SKIP_RESET_INTR_AGGR               0x200
 631
 632         /*
 633          * This quirks needs to be enabled if host controller cannot be
 634          * enabled via HCE register.
 635          */
 636         #define UFSHCI_QUIRK_BROKEN_HCE                         0x400
 637         unsigned int quirks;    /* Deviations from standard UFSHCI spec. */
 638
 639         /* Device deviations from standard UFS device spec. */
 640         unsigned int dev_quirks;
 641
 642         struct blk_mq_tag_set tmf_tag_set;
 643         struct request_queue *tmf_queue;
 644
 645         struct uic_command *active_uic_cmd;
 646         struct mutex uic_cmd_mutex;
 647         struct completion *uic_async_done;
 648
 649         u32 ufshcd_state;
 650         u32 eh_flags;
 651         u32 intr_mask;
 652         u16 ee_ctrl_mask;
 653         bool is_powered;
 654         struct ufs_init_prefetch init_prefetch_data;
 655
 656         /* Work Queues */
 657         struct work_struct eh_work;
 658         struct work_struct eeh_work;
 659
 660         /* HBA Errors */
 661         u32 errors;
 662         u32 uic_error;
 663         u32 saved_err;
 664         u32 saved_uic_err;
 665         struct ufs_stats ufs_stats;
 666         bool silence_err_logs;
 667
 668         /* Device management request data */
 669         struct ufs_dev_cmd dev_cmd;
 670         ktime_t last_dme_cmd_tstamp;
 671
 672         /* Keeps information of the UFS device connected to this host */
 673         struct ufs_dev_info dev_info;
 674         bool auto_bkops_enabled;
 675         struct ufs_vreg_info vreg_info;
 676         struct list_head clk_list_head;
 677
 678         bool wlun_dev_clr_ua;
 679
 680         /* Number of requests aborts */
 681         int req_abort_count;
 682
 683         /* Number of lanes available (1 or 2) for Rx/Tx */
 684         u32 lanes_per_direction;
 685         struct ufs_pa_layer_attr pwr_info;
 686         struct ufs_pwr_mode_info max_pwr_info;
 687
 688         struct ufs_clk_gating clk_gating;
 689         /* Control to enable/disable host capabilities */
 690         u32 caps;
 691         /* Allow dynamic clk gating */
 692 #define UFSHCD_CAP_CLK_GATING   (1 << 0)
 693         /* Allow hiberb8 with clk gating */
 694 #define UFSHCD_CAP_HIBERN8_WITH_CLK_GATING (1 << 1)
 695         /* Allow dynamic clk scaling */
 696 #define UFSHCD_CAP_CLK_SCALING  (1 << 2)
 697         /* Allow auto bkops to enabled during runtime suspend */
 698 #define UFSHCD_CAP_AUTO_BKOPS_SUSPEND (1 << 3)
 699         /*
 700          * This capability allows host controller driver to use the UFS HCI's
 701          * interrupt aggregation capability.
 702          * CAUTION: Enabling this might reduce overall UFS throughput.
 703          */
 704 #define UFSHCD_CAP_INTR_AGGR (1 << 4)
 705         /*
 706          * This capability allows the device auto-bkops to be always enabled
 707          * except during suspend (both runtime and suspend).
 708          * Enabling this capability means that device will always be allowed
 709          * to do background operation when it's active but it might degrade
 710          * the performance of ongoing read/write operations.
 711          */
 712 #define UFSHCD_CAP_KEEP_AUTO_BKOPS_ENABLED_EXCEPT_SUSPEND (1 << 5)
 713         /*
 714          * This capability allows host controller driver to automatically
 715          * enable runtime power management by itself instead of waiting
 716          * for userspace to control the power management.
 717          */
 718 #define UFSHCD_CAP_RPM_AUTOSUSPEND (1 << 6)
 719
 720         struct devfreq *devfreq;
 721         struct ufs_clk_scaling clk_scaling;
 722         bool is_sys_suspended;
 723
 724         enum bkops_status urgent_bkops_lvl;
 725         bool is_urgent_bkops_lvl_checked;
 726
 727         struct rw_semaphore clk_scaling_lock;
 728         struct ufs_desc_size desc_size;
 729         atomic_t scsi_block_reqs_cnt;
 730
 731         struct device           bsg_dev;
 732         struct request_queue    *bsg_queue;
 733 };
 734
 735 /* Returns true if clocks can be gated. Otherwise false */
 736 static inline bool ufshcd_is_clkgating_allowed(struct ufs_hba *hba)
 737 {
 738         return hba->caps & UFSHCD_CAP_CLK_GATING;
 739 }
 740 static inline bool ufshcd_can_hibern8_during_gating(struct ufs_hba *hba)
 741 {
 742         return hba->caps & UFSHCD_CAP_HIBERN8_WITH_CLK_GATING;
 743 }
 744 static inline int ufshcd_is_clkscaling_supported(struct ufs_hba *hba)
 745 {
 746         return hba->caps & UFSHCD_CAP_CLK_SCALING;
 747 }
 748 static inline bool ufshcd_can_autobkops_during_suspend(struct ufs_hba *hba)
 749 {
 750         return hba->caps & UFSHCD_CAP_AUTO_BKOPS_SUSPEND;
 751 }
 752 static inline bool ufshcd_is_rpm_autosuspend_allowed(struct ufs_hba *hba)
 753 {
 754         return hba->caps & UFSHCD_CAP_RPM_AUTOSUSPEND;
 755 }
 756
 757 static inline bool ufshcd_is_intr_aggr_allowed(struct ufs_hba *hba)
 758 {
 759 /* DWC UFS Core has the Interrupt aggregation feature but is not detectable*/
 760 #ifndef CONFIG_SCSI_UFS_DWC
 761         if ((hba->caps & UFSHCD_CAP_INTR_AGGR) &&
 762             !(hba->quirks & UFSHCD_QUIRK_BROKEN_INTR_AGGR))
 763                 return true;
 764         else
 765                 return false;
 766 #else
 767 return true;
 768 #endif
 769 }
 770
 771 static inline bool ufshcd_is_auto_hibern8_supported(struct ufs_hba *hba)
 772 {
 773         return (hba->capabilities & MASK_AUTO_HIBERN8_SUPPORT);
 774 }
 775
 776 #define ufshcd_writel(hba, val, reg)    \
 777         writel((val), (hba)->mmio_base + (reg))
 778 #define ufshcd_readl(hba, reg)  \
 779         readl((hba)->mmio_base + (reg))
 780
 781 /**
 782  * ufshcd_rmwl - read modify write into a register
 783  * @hba - per adapter instance
 784  * @mask - mask to apply on read value
 785  * @val - actual value to write
 786  * @reg - register address
 787  */
 788 static inline void ufshcd_rmwl(struct ufs_hba *hba, u32 mask, u32 val, u32 reg)
 789 {
 790         u32 tmp;
 791
 792         tmp = ufshcd_readl(hba, reg);
 793         tmp &= ~mask;
 794         tmp |= (val & mask);
 795         ufshcd_writel(hba, tmp, reg);
 796 }
 797
 798 int ufshcd_alloc_host(struct device *, struct ufs_hba **);
 799 void ufshcd_dealloc_host(struct ufs_hba *);
 800 int ufshcd_hba_enable(struct ufs_hba *hba);
 801 int ufshcd_init(struct ufs_hba * , void __iomem * , unsigned int);
 802 int ufshcd_make_hba_operational(struct ufs_hba *hba);
 803 void ufshcd_remove(struct ufs_hba *);
 804 int ufshcd_uic_hibern8_exit(struct ufs_hba *hba);
 805 int ufshcd_wait_for_register(struct ufs_hba *hba, u32 reg, u32 mask,
 806                                 u32 val, unsigned long interval_us,
 807                                 unsigned long timeout_ms, bool can_sleep);
 808 void ufshcd_parse_dev_ref_clk_freq(struct ufs_hba *hba, struct clk *refclk);
 809 void ufshcd_update_reg_hist(struct ufs_err_reg_hist *reg_hist,
 810                             u32 reg);
 811
 812 static inline void check_upiu_size(void)
 813 {
 814         BUILD_BUG_ON(ALIGNED_UPIU_SIZE <
 815                 GENERAL_UPIU_REQUEST_SIZE + QUERY_DESC_MAX_SIZE);
 816 }
 817
 818 /**
 819  * ufshcd_set_variant - set variant specific data to the hba
 820  * @hba - per adapter instance
 821  * @variant - pointer to variant specific data
 822  */
 823 static inline void ufshcd_set_variant(struct ufs_hba *hba, void *variant)
 824 {
 825         BUG_ON(!hba);
 826         hba->priv = variant;
 827 }
 828
 829 /**
 830  * ufshcd_get_variant - get variant specific data from the hba
 831  * @hba - per adapter instance
 832  */
 833 static inline void *ufshcd_get_variant(struct ufs_hba *hba)
 834 {
 835         BUG_ON(!hba);
 836         return hba->priv;
 837 }
 838 static inline bool ufshcd_keep_autobkops_enabled_except_suspend(
 839                                                         struct ufs_hba *hba)
 840 {
 841         return hba->caps & UFSHCD_CAP_KEEP_AUTO_BKOPS_ENABLED_EXCEPT_SUSPEND;
 842 }
 843
 844 extern int ufshcd_runtime_suspend(struct ufs_hba *hba);
 845 extern int ufshcd_runtime_resume(struct ufs_hba *hba);
 846 extern int ufshcd_runtime_idle(struct ufs_hba *hba);
 847 extern int ufshcd_system_suspend(struct ufs_hba *hba);
 848 extern int ufshcd_system_resume(struct ufs_hba *hba);
 849 extern int ufshcd_shutdown(struct ufs_hba *hba);
 850 extern int ufshcd_dme_set_attr(struct ufs_hba *hba, u32 attr_sel,
 851                                u8 attr_set, u32 mib_val, u8 peer);
 852 extern int ufshcd_dme_get_attr(struct ufs_hba *hba, u32 attr_sel,
 853                                u32 *mib_val, u8 peer);
 854 extern int ufshcd_config_pwr_mode(struct ufs_hba *hba,
 855                         struct ufs_pa_layer_attr *desired_pwr_mode);
 856
 857 /* UIC command interfaces for DME primitives */
 858 #define DME_LOCAL       0
 859 #define DME_PEER        1
 860 #define ATTR_SET_NOR    0       /* NORMAL */
 861 #define ATTR_SET_ST     1       /* STATIC */
 862
 863 static inline int ufshcd_dme_set(struct ufs_hba *hba, u32 attr_sel,
 864                                  u32 mib_val)
 865 {
 866         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
 867                                    mib_val, DME_LOCAL);
 868 }
 869
 870 static inline int ufshcd_dme_st_set(struct ufs_hba *hba, u32 attr_sel,
 871                                     u32 mib_val)
 872 {
 873         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
 874                                    mib_val, DME_LOCAL);
 875 }
 876
 877 static inline int ufshcd_dme_peer_set(struct ufs_hba *hba, u32 attr_sel,
 878                                       u32 mib_val)
 879 {
 880         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_NOR,
 881                                    mib_val, DME_PEER);
 882 }
 883
 884 static inline int ufshcd_dme_peer_st_set(struct ufs_hba *hba, u32 attr_sel,
 885                                          u32 mib_val)
 886 {
 887         return ufshcd_dme_set_attr(hba, attr_sel, ATTR_SET_ST,
 888                                    mib_val, DME_PEER);
 889 }
 890
 891 static inline int ufshcd_dme_get(struct ufs_hba *hba,
 892                                  u32 attr_sel, u32 *mib_val)
 893 {
 894         return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_LOCAL);
 895 }
 896
 897 static inline int ufshcd_dme_peer_get(struct ufs_hba *hba,
 898                                       u32 attr_sel, u32 *mib_val)
 899 {
 900         return ufshcd_dme_get_attr(hba, attr_sel, mib_val, DME_PEER);
 901 }
 902
 903 static inline bool ufshcd_is_hs_mode(struct ufs_pa_layer_attr *pwr_info)
 904 {
 905         return (pwr_info->pwr_rx == FAST_MODE ||
 906                 pwr_info->pwr_rx == FASTAUTO_MODE) &&
 907                 (pwr_info->pwr_tx == FAST_MODE ||
 908                 pwr_info->pwr_tx == FASTAUTO_MODE);
 909 }
 910
 911 /* Expose Query-Request API */
 912 int ufshcd_query_descriptor_retry(struct ufs_hba *hba,
 913                                   enum query_opcode opcode,
 914                                   enum desc_idn idn, u8 index,
 915                                   u8 selector,
 916                                   u8 *desc_buf, int *buf_len);
 917 int ufshcd_read_desc_param(struct ufs_hba *hba,
 918                            enum desc_idn desc_id,
 919                            int desc_index,
 920                            u8 param_offset,
 921                            u8 *param_read_buf,
 922                            u8 param_size);
 923 int ufshcd_query_attr(struct ufs_hba *hba, enum query_opcode opcode,
 924                       enum attr_idn idn, u8 index, u8 selector, u32 *attr_val);
 925 int ufshcd_query_flag(struct ufs_hba *hba, enum query_opcode opcode,
 926         enum flag_idn idn, bool *flag_res);
 927
 928 void ufshcd_auto_hibern8_enable(struct ufs_hba *hba);
 929 void ufshcd_auto_hibern8_update(struct ufs_hba *hba, u32 ahit);
 930
 931 #define SD_ASCII_STD true
 932 #define SD_RAW false
 933 int ufshcd_read_string_desc(struct ufs_hba *hba, u8 desc_index,
 934                             u8 **buf, bool ascii);
 935
 936 int ufshcd_hold(struct ufs_hba *hba, bool async);
 937 void ufshcd_release(struct ufs_hba *hba);
 938
 939 int ufshcd_map_desc_id_to_length(struct ufs_hba *hba, enum desc_idn desc_id,
 940         int *desc_length);
 941
 942 u32 ufshcd_get_local_unipro_ver(struct ufs_hba *hba);
 943
 944 int ufshcd_send_uic_cmd(struct ufs_hba *hba, struct uic_command *uic_cmd);
 945
 946 int ufshcd_exec_raw_upiu_cmd(struct ufs_hba *hba,
 947                              struct utp_upiu_req *req_upiu,
 948                              struct utp_upiu_req *rsp_upiu,
 949                              int msgcode,
 950                              u8 *desc_buff, int *buff_len,
 951                              enum query_opcode desc_op);
 952
 953 /* Wrapper functions for safely calling variant operations */
 954 static inline const char *ufshcd_get_var_name(struct ufs_hba *hba)
 955 {
 956         if (hba->vops)
 957                 return hba->vops->name;
 958         return "";
 959 }
 960
 961 static inline int ufshcd_vops_init(struct ufs_hba *hba)
 962 {
 963         if (hba->vops && hba->vops->init)
 964                 return hba->vops->init(hba);
 965
 966         return 0;
 967 }
 968
 969 static inline void ufshcd_vops_exit(struct ufs_hba *hba)
 970 {
 971         if (hba->vops && hba->vops->exit)
 972                 return hba->vops->exit(hba);
 973 }
 974
 975 static inline u32 ufshcd_vops_get_ufs_hci_version(struct ufs_hba *hba)
 976 {
 977         if (hba->vops && hba->vops->get_ufs_hci_version)
 978                 return hba->vops->get_ufs_hci_version(hba);
 979
 980         return ufshcd_readl(hba, REG_UFS_VERSION);
 981 }
 982
 983 static inline int ufshcd_vops_clk_scale_notify(struct ufs_hba *hba,
 984                         bool up, enum ufs_notify_change_status status)
 985 {
 986         if (hba->vops && hba->vops->clk_scale_notify)
 987                 return hba->vops->clk_scale_notify(hba, up, status);
 988         return 0;
 989 }
 990
 991 static inline int ufshcd_vops_setup_clocks(struct ufs_hba *hba, bool on,
 992                                         enum ufs_notify_change_status status)
 993 {
 994         if (hba->vops && hba->vops->setup_clocks)
 995                 return hba->vops->setup_clocks(hba, on, status);
 996         return 0;
 997 }
 998
 999 static inline int ufshcd_vops_setup_regulators(struct ufs_hba *hba, bool status)
1000 {
1001         if (hba->vops && hba->vops->setup_regulators)
1002                 return hba->vops->setup_regulators(hba, status);
1003
1004         return 0;
1005 }
1006
1007 static inline int ufshcd_vops_hce_enable_notify(struct ufs_hba *hba,
1008                                                 bool status)
1009 {
1010         if (hba->vops && hba->vops->hce_enable_notify)
1011                 return hba->vops->hce_enable_notify(hba, status);
1012
1013         return 0;
1014 }
1015 static inline int ufshcd_vops_link_startup_notify(struct ufs_hba *hba,
1016                                                 bool status)
1017 {
1018         if (hba->vops && hba->vops->link_startup_notify)
1019                 return hba->vops->link_startup_notify(hba, status);
1020
1021         return 0;
1022 }
1023
1024 static inline int ufshcd_vops_pwr_change_notify(struct ufs_hba *hba,
1025                                   bool status,
1026                                   struct ufs_pa_layer_attr *dev_max_params,
1027                                   struct ufs_pa_layer_attr *dev_req_params)
1028 {
1029         if (hba->vops && hba->vops->pwr_change_notify)
1030                 return hba->vops->pwr_change_notify(hba, status,
1031                                         dev_max_params, dev_req_params);
1032
1033         return -ENOTSUPP;
1034 }
1035
1036 static inline void ufshcd_vops_setup_xfer_req(struct ufs_hba *hba, int tag,
1037                                         bool is_scsi_cmd)
1038 {
1039         if (hba->vops && hba->vops->setup_xfer_req)
1040                 return hba->vops->setup_xfer_req(hba, tag, is_scsi_cmd);
1041 }
1042
1043 static inline void ufshcd_vops_setup_task_mgmt(struct ufs_hba *hba,
1044                                         int tag, u8 tm_function)
1045 {
1046         if (hba->vops && hba->vops->setup_task_mgmt)
1047                 return hba->vops->setup_task_mgmt(hba, tag, tm_function);
1048 }
1049
1050 static inline void ufshcd_vops_hibern8_notify(struct ufs_hba *hba,
1051                                         enum uic_cmd_dme cmd,
1052                                         enum ufs_notify_change_status status)
1053 {
1054         if (hba->vops && hba->vops->hibern8_notify)
1055                 return hba->vops->hibern8_notify(hba, cmd, status);
1056 }
1057
1058 static inline int ufshcd_vops_apply_dev_quirks(struct ufs_hba *hba)
1059 {
1060         if (hba->vops && hba->vops->apply_dev_quirks)
1061                 return hba->vops->apply_dev_quirks(hba);
1062         return 0;
1063 }
1064
1065 static inline int ufshcd_vops_suspend(struct ufs_hba *hba, enum ufs_pm_op op)
1066 {
1067         if (hba->vops && hba->vops->suspend)
1068                 return hba->vops->suspend(hba, op);
1069
1070         return 0;
1071 }
1072
1073 static inline int ufshcd_vops_resume(struct ufs_hba *hba, enum ufs_pm_op op)
1074 {
1075         if (hba->vops && hba->vops->resume)
1076                 return hba->vops->resume(hba, op);
1077
1078         return 0;
1079 }
1080
1081 static inline void ufshcd_vops_dbg_register_dump(struct ufs_hba *hba)
1082 {
1083         if (hba->vops && hba->vops->dbg_register_dump)
1084                 hba->vops->dbg_register_dump(hba);
1085 }
1086
1087 static inline void ufshcd_vops_device_reset(struct ufs_hba *hba)
1088 {
1089         if (hba->vops && hba->vops->device_reset) {
1090                 hba->vops->device_reset(hba);
1091                 ufshcd_update_reg_hist(&hba->ufs_stats.dev_reset, 0);
1092         }
1093 }
1094
1095 extern struct ufs_pm_lvl_states ufs_pm_lvl_states[];
1096
1097 /*
1098  * ufshcd_scsi_to_upiu_lun - maps scsi LUN to UPIU LUN
1099  * @scsi_lun: scsi LUN id
1100  *
1101  * Returns UPIU LUN id
1102  */
1103 static inline u8 ufshcd_scsi_to_upiu_lun(unsigned int scsi_lun)
1104 {
1105         if (scsi_is_wlun(scsi_lun))
1106                 return (scsi_lun & UFS_UPIU_MAX_UNIT_NUM_ID)
1107                         | UFS_UPIU_WLUN_ID;
1108         else
1109                 return scsi_lun & UFS_UPIU_MAX_UNIT_NUM_ID;
1110 }
1111
1112 int ufshcd_dump_regs(struct ufs_hba *hba, size_t offset, size_t len,
1113                      const char *prefix);
1114
1115 #endif /* End of Header */