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