drivers/scsi/ufs/ufs.h

   1 /*
   2  * Universal Flash Storage Host controller driver
   3  *
   4  * This code is based on drivers/scsi/ufs/ufs.h
   5  * Copyright (C) 2011-2013 Samsung India Software Operations
   6  *
   7  * Authors:
   8  *      Santosh Yaraganavi <santosh.sy@samsung.com>
   9  *      Vinayak Holikatti <h.vinayak@samsung.com>
  10  *
  11  * This program is free software; you can redistribute it and/or
  12  * modify it under the terms of the GNU General Public License
  13  * as published by the Free Software Foundation; either version 2
  14  * of the License, or (at your option) any later version.
  15  * See the COPYING file in the top-level directory or visit
  16  * <http://www.gnu.org/licenses/gpl-2.0.html>
  17  *
  18  * This program is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU General Public License for more details.
  22  *
  23  * This program is provided "AS IS" and "WITH ALL FAULTS" and
  24  * without warranty of any kind. You are solely responsible for
  25  * determining the appropriateness of using and distributing
  26  * the program and assume all risks associated with your exercise
  27  * of rights with respect to the program, including but not limited
  28  * to infringement of third party rights, the risks and costs of
  29  * program errors, damage to or loss of data, programs or equipment,
  30  * and unavailability or interruption of operations. Under no
  31  * circumstances will the contributor of this Program be liable for
  32  * any damages of any kind arising from your use or distribution of
  33  * this program.
  34  */
  35
  36 #ifndef _UFS_H
  37 #define _UFS_H
  38
  39 #include <linux/mutex.h>
  40 #include <linux/types.h>
  41
  42 #define MAX_CDB_SIZE    16
  43 #define GENERAL_UPIU_REQUEST_SIZE 32
  44 #define QUERY_DESC_MAX_SIZE       255
  45 #define QUERY_DESC_MIN_SIZE       2
  46 #define QUERY_DESC_HDR_SIZE       2
  47 #define QUERY_OSF_SIZE            (GENERAL_UPIU_REQUEST_SIZE - \
  48                                         (sizeof(struct utp_upiu_header)))
  49 #define RESPONSE_UPIU_SENSE_DATA_LENGTH 18
  50
  51 #define UPIU_HEADER_DWORD(byte3, byte2, byte1, byte0)\
  52                         cpu_to_be32((byte3 << 24) | (byte2 << 16) |\
  53                          (byte1 << 8) | (byte0))
  54 /*
  55  * UFS device may have standard LUs and LUN id could be from 0x00 to
  56  * 0x7F. Standard LUs use "Peripheral Device Addressing Format".
  57  * UFS device may also have the Well Known LUs (also referred as W-LU)
  58  * which again could be from 0x00 to 0x7F. For W-LUs, device only use
  59  * the "Extended Addressing Format" which means the W-LUNs would be
  60  * from 0xc100 (SCSI_W_LUN_BASE) onwards.
  61  * This means max. LUN number reported from UFS device could be 0xC17F.
  62  */
  63 #define UFS_UPIU_MAX_UNIT_NUM_ID        0x7F
  64 #define UFS_MAX_LUNS            (SCSI_W_LUN_BASE + UFS_UPIU_MAX_UNIT_NUM_ID)
  65 #define UFS_UPIU_WLUN_ID        (1 << 7)
  66 #define UFS_UPIU_MAX_GENERAL_LUN        8
  67
  68 /* Well known logical unit id in LUN field of UPIU */
  69 enum {
  70         UFS_UPIU_REPORT_LUNS_WLUN       = 0x81,
  71         UFS_UPIU_UFS_DEVICE_WLUN        = 0xD0,
  72         UFS_UPIU_BOOT_WLUN              = 0xB0,
  73         UFS_UPIU_RPMB_WLUN              = 0xC4,
  74 };
  75
  76 /*
  77  * UFS Protocol Information Unit related definitions
  78  */
  79
  80 /* Task management functions */
  81 enum {
  82         UFS_ABORT_TASK          = 0x01,
  83         UFS_ABORT_TASK_SET      = 0x02,
  84         UFS_CLEAR_TASK_SET      = 0x04,
  85         UFS_LOGICAL_RESET       = 0x08,
  86         UFS_QUERY_TASK          = 0x80,
  87         UFS_QUERY_TASK_SET      = 0x81,
  88 };
  89
  90 /* UTP UPIU Transaction Codes Initiator to Target */
  91 enum {
  92         UPIU_TRANSACTION_NOP_OUT        = 0x00,
  93         UPIU_TRANSACTION_COMMAND        = 0x01,
  94         UPIU_TRANSACTION_DATA_OUT       = 0x02,
  95         UPIU_TRANSACTION_TASK_REQ       = 0x04,
  96         UPIU_TRANSACTION_QUERY_REQ      = 0x16,
  97 };
  98
  99 /* UTP UPIU Transaction Codes Target to Initiator */
 100 enum {
 101         UPIU_TRANSACTION_NOP_IN         = 0x20,
 102         UPIU_TRANSACTION_RESPONSE       = 0x21,
 103         UPIU_TRANSACTION_DATA_IN        = 0x22,
 104         UPIU_TRANSACTION_TASK_RSP       = 0x24,
 105         UPIU_TRANSACTION_READY_XFER     = 0x31,
 106         UPIU_TRANSACTION_QUERY_RSP      = 0x36,
 107         UPIU_TRANSACTION_REJECT_UPIU    = 0x3F,
 108 };
 109
 110 /* UPIU Read/Write flags */
 111 enum {
 112         UPIU_CMD_FLAGS_NONE     = 0x00,
 113         UPIU_CMD_FLAGS_WRITE    = 0x20,
 114         UPIU_CMD_FLAGS_READ     = 0x40,
 115 };
 116
 117 /* UPIU Task Attributes */
 118 enum {
 119         UPIU_TASK_ATTR_SIMPLE   = 0x00,
 120         UPIU_TASK_ATTR_ORDERED  = 0x01,
 121         UPIU_TASK_ATTR_HEADQ    = 0x02,
 122         UPIU_TASK_ATTR_ACA      = 0x03,
 123 };
 124
 125 /* UPIU Query request function */
 126 enum {
 127         UPIU_QUERY_FUNC_STANDARD_READ_REQUEST           = 0x01,
 128         UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST          = 0x81,
 129 };
 130
 131 /* Flag idn for Query Requests*/
 132 enum flag_idn {
 133         QUERY_FLAG_IDN_FDEVICEINIT      = 0x01,
 134         QUERY_FLAG_IDN_PWR_ON_WPE       = 0x03,
 135         QUERY_FLAG_IDN_BKOPS_EN         = 0x04,
 136 };
 137
 138 /* Attribute idn for Query requests */
 139 enum attr_idn {
 140         QUERY_ATTR_IDN_ACTIVE_ICC_LVL   = 0x03,
 141         QUERY_ATTR_IDN_BKOPS_STATUS     = 0x05,
 142         QUERY_ATTR_IDN_EE_CONTROL       = 0x0D,
 143         QUERY_ATTR_IDN_EE_STATUS        = 0x0E,
 144 };
 145
 146 /* Descriptor idn for Query requests */
 147 enum desc_idn {
 148         QUERY_DESC_IDN_DEVICE           = 0x0,
 149         QUERY_DESC_IDN_CONFIGURAION     = 0x1,
 150         QUERY_DESC_IDN_UNIT             = 0x2,
 151         QUERY_DESC_IDN_RFU_0            = 0x3,
 152         QUERY_DESC_IDN_INTERCONNECT     = 0x4,
 153         QUERY_DESC_IDN_STRING           = 0x5,
 154         QUERY_DESC_IDN_RFU_1            = 0x6,
 155         QUERY_DESC_IDN_GEOMETRY         = 0x7,
 156         QUERY_DESC_IDN_POWER            = 0x8,
 157         QUERY_DESC_IDN_MAX,
 158 };
 159
 160 enum desc_header_offset {
 161         QUERY_DESC_LENGTH_OFFSET        = 0x00,
 162         QUERY_DESC_DESC_TYPE_OFFSET     = 0x01,
 163 };
 164
 165 enum ufs_desc_max_size {
 166         QUERY_DESC_DEVICE_MAX_SIZE              = 0x40,
 167         QUERY_DESC_CONFIGURAION_MAX_SIZE        = 0x90,
 168         QUERY_DESC_UNIT_MAX_SIZE                = 0x23,
 169         QUERY_DESC_INTERCONNECT_MAX_SIZE        = 0x06,
 170         /*
 171          * Max. 126 UNICODE characters (2 bytes per character) plus 2 bytes
 172          * of descriptor header.
 173          */
 174         QUERY_DESC_STRING_MAX_SIZE              = 0xFE,
 175         QUERY_DESC_GEOMETRY_MAX_SIZE            = 0x44,
 176         QUERY_DESC_POWER_MAX_SIZE               = 0x62,
 177         QUERY_DESC_RFU_MAX_SIZE                 = 0x00,
 178 };
 179
 180 /* Unit descriptor parameters offsets in bytes*/
 181 enum unit_desc_param {
 182         UNIT_DESC_PARAM_LEN                     = 0x0,
 183         UNIT_DESC_PARAM_TYPE                    = 0x1,
 184         UNIT_DESC_PARAM_UNIT_INDEX              = 0x2,
 185         UNIT_DESC_PARAM_LU_ENABLE               = 0x3,
 186         UNIT_DESC_PARAM_BOOT_LUN_ID             = 0x4,
 187         UNIT_DESC_PARAM_LU_WR_PROTECT           = 0x5,
 188         UNIT_DESC_PARAM_LU_Q_DEPTH              = 0x6,
 189         UNIT_DESC_PARAM_MEM_TYPE                = 0x8,
 190         UNIT_DESC_PARAM_DATA_RELIABILITY        = 0x9,
 191         UNIT_DESC_PARAM_LOGICAL_BLK_SIZE        = 0xA,
 192         UNIT_DESC_PARAM_LOGICAL_BLK_COUNT       = 0xB,
 193         UNIT_DESC_PARAM_ERASE_BLK_SIZE          = 0x13,
 194         UNIT_DESC_PARAM_PROVISIONING_TYPE       = 0x17,
 195         UNIT_DESC_PARAM_PHY_MEM_RSRC_CNT        = 0x18,
 196         UNIT_DESC_PARAM_CTX_CAPABILITIES        = 0x20,
 197         UNIT_DESC_PARAM_LARGE_UNIT_SIZE_M1      = 0x22,
 198 };
 199
 200 /* Device descriptor parameters offsets in bytes*/
 201 enum device_desc_param {
 202         DEVICE_DESC_PARAM_LEN                   = 0x0,
 203         DEVICE_DESC_PARAM_TYPE                  = 0x1,
 204         DEVICE_DESC_PARAM_DEVICE_TYPE           = 0x2,
 205         DEVICE_DESC_PARAM_DEVICE_CLASS          = 0x3,
 206         DEVICE_DESC_PARAM_DEVICE_SUB_CLASS      = 0x4,
 207         DEVICE_DESC_PARAM_PRTCL                 = 0x5,
 208         DEVICE_DESC_PARAM_NUM_LU                = 0x6,
 209         DEVICE_DESC_PARAM_NUM_WLU               = 0x7,
 210         DEVICE_DESC_PARAM_BOOT_ENBL             = 0x8,
 211         DEVICE_DESC_PARAM_DESC_ACCSS_ENBL       = 0x9,
 212         DEVICE_DESC_PARAM_INIT_PWR_MODE         = 0xA,
 213         DEVICE_DESC_PARAM_HIGH_PR_LUN           = 0xB,
 214         DEVICE_DESC_PARAM_SEC_RMV_TYPE          = 0xC,
 215         DEVICE_DESC_PARAM_SEC_LU                = 0xD,
 216         DEVICE_DESC_PARAM_BKOP_TERM_LT          = 0xE,
 217         DEVICE_DESC_PARAM_ACTVE_ICC_LVL         = 0xF,
 218         DEVICE_DESC_PARAM_SPEC_VER              = 0x10,
 219         DEVICE_DESC_PARAM_MANF_DATE             = 0x12,
 220         DEVICE_DESC_PARAM_MANF_NAME             = 0x14,
 221         DEVICE_DESC_PARAM_PRDCT_NAME            = 0x15,
 222         DEVICE_DESC_PARAM_SN                    = 0x16,
 223         DEVICE_DESC_PARAM_OEM_ID                = 0x17,
 224         DEVICE_DESC_PARAM_MANF_ID               = 0x18,
 225         DEVICE_DESC_PARAM_UD_OFFSET             = 0x1A,
 226         DEVICE_DESC_PARAM_UD_LEN                = 0x1B,
 227         DEVICE_DESC_PARAM_RTT_CAP               = 0x1C,
 228         DEVICE_DESC_PARAM_FRQ_RTC               = 0x1D,
 229 };
 230
 231 /*
 232  * Logical Unit Write Protect
 233  * 00h: LU not write protected
 234  * 01h: LU write protected when fPowerOnWPEn =1
 235  * 02h: LU permanently write protected when fPermanentWPEn =1
 236  */
 237 enum ufs_lu_wp_type {
 238         UFS_LU_NO_WP            = 0x00,
 239         UFS_LU_POWER_ON_WP      = 0x01,
 240         UFS_LU_PERM_WP          = 0x02,
 241 };
 242
 243 /* bActiveICCLevel parameter current units */
 244 enum {
 245         UFSHCD_NANO_AMP         = 0,
 246         UFSHCD_MICRO_AMP        = 1,
 247         UFSHCD_MILI_AMP         = 2,
 248         UFSHCD_AMP              = 3,
 249 };
 250
 251 #define POWER_DESC_MAX_SIZE                     0x62
 252 #define POWER_DESC_MAX_ACTV_ICC_LVLS            16
 253
 254 /* Attribute  bActiveICCLevel parameter bit masks definitions */
 255 #define ATTR_ICC_LVL_UNIT_OFFSET        14
 256 #define ATTR_ICC_LVL_UNIT_MASK          (0x3 << ATTR_ICC_LVL_UNIT_OFFSET)
 257 #define ATTR_ICC_LVL_VALUE_MASK         0x3FF
 258
 259 /* Power descriptor parameters offsets in bytes */
 260 enum power_desc_param_offset {
 261         PWR_DESC_LEN                    = 0x0,
 262         PWR_DESC_TYPE                   = 0x1,
 263         PWR_DESC_ACTIVE_LVLS_VCC_0      = 0x2,
 264         PWR_DESC_ACTIVE_LVLS_VCCQ_0     = 0x22,
 265         PWR_DESC_ACTIVE_LVLS_VCCQ2_0    = 0x42,
 266 };
 267
 268 /* Exception event mask values */
 269 enum {
 270         MASK_EE_STATUS          = 0xFFFF,
 271         MASK_EE_URGENT_BKOPS    = (1 << 2),
 272 };
 273
 274 /* Background operation status */
 275 enum bkops_status {
 276         BKOPS_STATUS_NO_OP               = 0x0,
 277         BKOPS_STATUS_NON_CRITICAL        = 0x1,
 278         BKOPS_STATUS_PERF_IMPACT         = 0x2,
 279         BKOPS_STATUS_CRITICAL            = 0x3,
 280         BKOPS_STATUS_MAX                 = BKOPS_STATUS_CRITICAL,
 281 };
 282
 283 /* UTP QUERY Transaction Specific Fields OpCode */
 284 enum query_opcode {
 285         UPIU_QUERY_OPCODE_NOP           = 0x0,
 286         UPIU_QUERY_OPCODE_READ_DESC     = 0x1,
 287         UPIU_QUERY_OPCODE_WRITE_DESC    = 0x2,
 288         UPIU_QUERY_OPCODE_READ_ATTR     = 0x3,
 289         UPIU_QUERY_OPCODE_WRITE_ATTR    = 0x4,
 290         UPIU_QUERY_OPCODE_READ_FLAG     = 0x5,
 291         UPIU_QUERY_OPCODE_SET_FLAG      = 0x6,
 292         UPIU_QUERY_OPCODE_CLEAR_FLAG    = 0x7,
 293         UPIU_QUERY_OPCODE_TOGGLE_FLAG   = 0x8,
 294 };
 295
 296 /* Query response result code */
 297 enum {
 298         QUERY_RESULT_SUCCESS                    = 0x00,
 299         QUERY_RESULT_NOT_READABLE               = 0xF6,
 300         QUERY_RESULT_NOT_WRITEABLE              = 0xF7,
 301         QUERY_RESULT_ALREADY_WRITTEN            = 0xF8,
 302         QUERY_RESULT_INVALID_LENGTH             = 0xF9,
 303         QUERY_RESULT_INVALID_VALUE              = 0xFA,
 304         QUERY_RESULT_INVALID_SELECTOR           = 0xFB,
 305         QUERY_RESULT_INVALID_INDEX              = 0xFC,
 306         QUERY_RESULT_INVALID_IDN                = 0xFD,
 307         QUERY_RESULT_INVALID_OPCODE             = 0xFE,
 308         QUERY_RESULT_GENERAL_FAILURE            = 0xFF,
 309 };
 310
 311 /* UTP Transfer Request Command Type (CT) */
 312 enum {
 313         UPIU_COMMAND_SET_TYPE_SCSI      = 0x0,
 314         UPIU_COMMAND_SET_TYPE_UFS       = 0x1,
 315         UPIU_COMMAND_SET_TYPE_QUERY     = 0x2,
 316 };
 317
 318 /* UTP Transfer Request Command Offset */
 319 #define UPIU_COMMAND_TYPE_OFFSET        28
 320
 321 /* Offset of the response code in the UPIU header */
 322 #define UPIU_RSP_CODE_OFFSET            8
 323
 324 enum {
 325         MASK_SCSI_STATUS                = 0xFF,
 326         MASK_TASK_RESPONSE              = 0xFF00,
 327         MASK_RSP_UPIU_RESULT            = 0xFFFF,
 328         MASK_QUERY_DATA_SEG_LEN         = 0xFFFF,
 329         MASK_RSP_UPIU_DATA_SEG_LEN      = 0xFFFF,
 330         MASK_RSP_EXCEPTION_EVENT        = 0x10000,
 331         MASK_TM_SERVICE_RESP            = 0xFF,
 332 };
 333
 334 /* Task management service response */
 335 enum {
 336         UPIU_TASK_MANAGEMENT_FUNC_COMPL         = 0x00,
 337         UPIU_TASK_MANAGEMENT_FUNC_NOT_SUPPORTED = 0x04,
 338         UPIU_TASK_MANAGEMENT_FUNC_SUCCEEDED     = 0x08,
 339         UPIU_TASK_MANAGEMENT_FUNC_FAILED        = 0x05,
 340         UPIU_INCORRECT_LOGICAL_UNIT_NO          = 0x09,
 341 };
 342
 343 /* UFS device power modes */
 344 enum ufs_dev_pwr_mode {
 345         UFS_ACTIVE_PWR_MODE     = 1,
 346         UFS_SLEEP_PWR_MODE      = 2,
 347         UFS_POWERDOWN_PWR_MODE  = 3,
 348 };
 349
 350 /**
 351  * struct utp_upiu_header - UPIU header structure
 352  * @dword_0: UPIU header DW-0
 353  * @dword_1: UPIU header DW-1
 354  * @dword_2: UPIU header DW-2
 355  */
 356 struct utp_upiu_header {
 357         __be32 dword_0;
 358         __be32 dword_1;
 359         __be32 dword_2;
 360 };
 361
 362 /**
 363  * struct utp_upiu_cmd - Command UPIU structure
 364  * @data_transfer_len: Data Transfer Length DW-3
 365  * @cdb: Command Descriptor Block CDB DW-4 to DW-7
 366  */
 367 struct utp_upiu_cmd {
 368         __be32 exp_data_transfer_len;
 369         u8 cdb[MAX_CDB_SIZE];
 370 };
 371
 372 /**
 373  * struct utp_upiu_query - upiu request buffer structure for
 374  * query request.
 375  * @opcode: command to perform B-0
 376  * @idn: a value that indicates the particular type of data B-1
 377  * @index: Index to further identify data B-2
 378  * @selector: Index to further identify data B-3
 379  * @reserved_osf: spec reserved field B-4,5
 380  * @length: number of descriptor bytes to read/write B-6,7
 381  * @value: Attribute value to be written DW-5
 382  * @reserved: spec reserved DW-6,7
 383  */
 384 struct utp_upiu_query {
 385         u8 opcode;
 386         u8 idn;
 387         u8 index;
 388         u8 selector;
 389         __be16 reserved_osf;
 390         __be16 length;
 391         __be32 value;
 392         __be32 reserved[2];
 393 };
 394
 395 /**
 396  * struct utp_upiu_req - general upiu request structure
 397  * @header:UPIU header structure DW-0 to DW-2
 398  * @sc: fields structure for scsi command DW-3 to DW-7
 399  * @qr: fields structure for query request DW-3 to DW-7
 400  */
 401 struct utp_upiu_req {
 402         struct utp_upiu_header header;
 403         union {
 404                 struct utp_upiu_cmd sc;
 405                 struct utp_upiu_query qr;
 406         };
 407 };
 408
 409 /**
 410  * struct utp_cmd_rsp - Response UPIU structure
 411  * @residual_transfer_count: Residual transfer count DW-3
 412  * @reserved: Reserved double words DW-4 to DW-7
 413  * @sense_data_len: Sense data length DW-8 U16
 414  * @sense_data: Sense data field DW-8 to DW-12
 415  */
 416 struct utp_cmd_rsp {
 417         __be32 residual_transfer_count;
 418         __be32 reserved[4];
 419         __be16 sense_data_len;
 420         u8 sense_data[RESPONSE_UPIU_SENSE_DATA_LENGTH];
 421 };
 422
 423 /**
 424  * struct utp_upiu_rsp - general upiu response structure
 425  * @header: UPIU header structure DW-0 to DW-2
 426  * @sr: fields structure for scsi command DW-3 to DW-12
 427  * @qr: fields structure for query request DW-3 to DW-7
 428  */
 429 struct utp_upiu_rsp {
 430         struct utp_upiu_header header;
 431         union {
 432                 struct utp_cmd_rsp sr;
 433                 struct utp_upiu_query qr;
 434         };
 435 };
 436
 437 /**
 438  * struct utp_upiu_task_req - Task request UPIU structure
 439  * @header - UPIU header structure DW0 to DW-2
 440  * @input_param1: Input parameter 1 DW-3
 441  * @input_param2: Input parameter 2 DW-4
 442  * @input_param3: Input parameter 3 DW-5
 443  * @reserved: Reserved double words DW-6 to DW-7
 444  */
 445 struct utp_upiu_task_req {
 446         struct utp_upiu_header header;
 447         __be32 input_param1;
 448         __be32 input_param2;
 449         __be32 input_param3;
 450         __be32 reserved[2];
 451 };
 452
 453 /**
 454  * struct utp_upiu_task_rsp - Task Management Response UPIU structure
 455  * @header: UPIU header structure DW0-DW-2
 456  * @output_param1: Ouput parameter 1 DW3
 457  * @output_param2: Output parameter 2 DW4
 458  * @reserved: Reserved double words DW-5 to DW-7
 459  */
 460 struct utp_upiu_task_rsp {
 461         struct utp_upiu_header header;
 462         __be32 output_param1;
 463         __be32 output_param2;
 464         __be32 reserved[3];
 465 };
 466
 467 /**
 468  * struct ufs_query_req - parameters for building a query request
 469  * @query_func: UPIU header query function
 470  * @upiu_req: the query request data
 471  */
 472 struct ufs_query_req {
 473         u8 query_func;
 474         struct utp_upiu_query upiu_req;
 475 };
 476
 477 /**
 478  * struct ufs_query_resp - UPIU QUERY
 479  * @response: device response code
 480  * @upiu_res: query response data
 481  */
 482 struct ufs_query_res {
 483         u8 response;
 484         struct utp_upiu_query upiu_res;
 485 };
 486
 487 #define UFS_VREG_VCC_MIN_UV        2700000 /* uV */
 488 #define UFS_VREG_VCC_MAX_UV        3600000 /* uV */
 489 #define UFS_VREG_VCC_1P8_MIN_UV    1700000 /* uV */
 490 #define UFS_VREG_VCC_1P8_MAX_UV    1950000 /* uV */
 491 #define UFS_VREG_VCCQ_MIN_UV       1100000 /* uV */
 492 #define UFS_VREG_VCCQ_MAX_UV       1300000 /* uV */
 493 #define UFS_VREG_VCCQ2_MIN_UV      1650000 /* uV */
 494 #define UFS_VREG_VCCQ2_MAX_UV      1950000 /* uV */
 495
 496 /*
 497  * VCCQ & VCCQ2 current requirement when UFS device is in sleep state
 498  * and link is in Hibern8 state.
 499  */
 500 #define UFS_VREG_LPM_LOAD_UA    1000 /* uA */
 501
 502 struct ufs_vreg {
 503         struct regulator *reg;
 504         const char *name;
 505         bool enabled;
 506         bool unused;
 507         int min_uV;
 508         int max_uV;
 509         int min_uA;
 510         int max_uA;
 511 };
 512
 513 struct ufs_vreg_info {
 514         struct ufs_vreg *vcc;
 515         struct ufs_vreg *vccq;
 516         struct ufs_vreg *vccq2;
 517         struct ufs_vreg *vdd_hba;
 518 };
 519
 520 struct ufs_dev_info {
 521         bool f_power_on_wp_en;
 522         /* Keeps information if any of the LU is power on write protected */
 523         bool is_lu_power_on_wp;
 524 };
 525
 526 #endif /* End of Header */