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 #include <uapi/scsi/scsi_bsg_ufs.h>
  42
  43 #define GENERAL_UPIU_REQUEST_SIZE (sizeof(struct utp_upiu_req))
  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 UFS_SENSE_SIZE  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
  67 /* Well known logical unit id in LUN field of UPIU */
  68 enum {
  69         UFS_UPIU_REPORT_LUNS_WLUN       = 0x81,
  70         UFS_UPIU_UFS_DEVICE_WLUN        = 0xD0,
  71         UFS_UPIU_BOOT_WLUN              = 0xB0,
  72         UFS_UPIU_RPMB_WLUN              = 0xC4,
  73 };
  74
  75 /*
  76  * UFS Protocol Information Unit related definitions
  77  */
  78
  79 /* Task management functions */
  80 enum {
  81         UFS_ABORT_TASK          = 0x01,
  82         UFS_ABORT_TASK_SET      = 0x02,
  83         UFS_CLEAR_TASK_SET      = 0x04,
  84         UFS_LOGICAL_RESET       = 0x08,
  85         UFS_QUERY_TASK          = 0x80,
  86         UFS_QUERY_TASK_SET      = 0x81,
  87 };
  88
  89 /* UTP UPIU Transaction Codes Initiator to Target */
  90 enum {
  91         UPIU_TRANSACTION_NOP_OUT        = 0x00,
  92         UPIU_TRANSACTION_COMMAND        = 0x01,
  93         UPIU_TRANSACTION_DATA_OUT       = 0x02,
  94         UPIU_TRANSACTION_TASK_REQ       = 0x04,
  95         UPIU_TRANSACTION_QUERY_REQ      = 0x16,
  96 };
  97
  98 /* UTP UPIU Transaction Codes Target to Initiator */
  99 enum {
 100         UPIU_TRANSACTION_NOP_IN         = 0x20,
 101         UPIU_TRANSACTION_RESPONSE       = 0x21,
 102         UPIU_TRANSACTION_DATA_IN        = 0x22,
 103         UPIU_TRANSACTION_TASK_RSP       = 0x24,
 104         UPIU_TRANSACTION_READY_XFER     = 0x31,
 105         UPIU_TRANSACTION_QUERY_RSP      = 0x36,
 106         UPIU_TRANSACTION_REJECT_UPIU    = 0x3F,
 107 };
 108
 109 /* UPIU Read/Write flags */
 110 enum {
 111         UPIU_CMD_FLAGS_NONE     = 0x00,
 112         UPIU_CMD_FLAGS_WRITE    = 0x20,
 113         UPIU_CMD_FLAGS_READ     = 0x40,
 114 };
 115
 116 /* UPIU Task Attributes */
 117 enum {
 118         UPIU_TASK_ATTR_SIMPLE   = 0x00,
 119         UPIU_TASK_ATTR_ORDERED  = 0x01,
 120         UPIU_TASK_ATTR_HEADQ    = 0x02,
 121         UPIU_TASK_ATTR_ACA      = 0x03,
 122 };
 123
 124 /* UPIU Query request function */
 125 enum {
 126         UPIU_QUERY_FUNC_STANDARD_READ_REQUEST           = 0x01,
 127         UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST          = 0x81,
 128 };
 129
 130 /* Flag idn for Query Requests*/
 131 enum flag_idn {
 132         QUERY_FLAG_IDN_FDEVICEINIT                      = 0x01,
 133         QUERY_FLAG_IDN_PERMANENT_WPE                    = 0x02,
 134         QUERY_FLAG_IDN_PWR_ON_WPE                       = 0x03,
 135         QUERY_FLAG_IDN_BKOPS_EN                         = 0x04,
 136         QUERY_FLAG_IDN_LIFE_SPAN_MODE_ENABLE            = 0x05,
 137         QUERY_FLAG_IDN_PURGE_ENABLE                     = 0x06,
 138         QUERY_FLAG_IDN_RESERVED2                        = 0x07,
 139         QUERY_FLAG_IDN_FPHYRESOURCEREMOVAL              = 0x08,
 140         QUERY_FLAG_IDN_BUSY_RTC                         = 0x09,
 141         QUERY_FLAG_IDN_RESERVED3                        = 0x0A,
 142         QUERY_FLAG_IDN_PERMANENTLY_DISABLE_FW_UPDATE    = 0x0B,
 143 };
 144
 145 /* Attribute idn for Query requests */
 146 enum attr_idn {
 147         QUERY_ATTR_IDN_BOOT_LU_EN               = 0x00,
 148         QUERY_ATTR_IDN_RESERVED                 = 0x01,
 149         QUERY_ATTR_IDN_POWER_MODE               = 0x02,
 150         QUERY_ATTR_IDN_ACTIVE_ICC_LVL           = 0x03,
 151         QUERY_ATTR_IDN_OOO_DATA_EN              = 0x04,
 152         QUERY_ATTR_IDN_BKOPS_STATUS             = 0x05,
 153         QUERY_ATTR_IDN_PURGE_STATUS             = 0x06,
 154         QUERY_ATTR_IDN_MAX_DATA_IN              = 0x07,
 155         QUERY_ATTR_IDN_MAX_DATA_OUT             = 0x08,
 156         QUERY_ATTR_IDN_DYN_CAP_NEEDED           = 0x09,
 157         QUERY_ATTR_IDN_REF_CLK_FREQ             = 0x0A,
 158         QUERY_ATTR_IDN_CONF_DESC_LOCK           = 0x0B,
 159         QUERY_ATTR_IDN_MAX_NUM_OF_RTT           = 0x0C,
 160         QUERY_ATTR_IDN_EE_CONTROL               = 0x0D,
 161         QUERY_ATTR_IDN_EE_STATUS                = 0x0E,
 162         QUERY_ATTR_IDN_SECONDS_PASSED           = 0x0F,
 163         QUERY_ATTR_IDN_CNTX_CONF                = 0x10,
 164         QUERY_ATTR_IDN_CORR_PRG_BLK_NUM         = 0x11,
 165         QUERY_ATTR_IDN_RESERVED2                = 0x12,
 166         QUERY_ATTR_IDN_RESERVED3                = 0x13,
 167         QUERY_ATTR_IDN_FFU_STATUS               = 0x14,
 168         QUERY_ATTR_IDN_PSA_STATE                = 0x15,
 169         QUERY_ATTR_IDN_PSA_DATA_SIZE            = 0x16,
 170 };
 171
 172 /* Descriptor idn for Query requests */
 173 enum desc_idn {
 174         QUERY_DESC_IDN_DEVICE           = 0x0,
 175         QUERY_DESC_IDN_CONFIGURATION    = 0x1,
 176         QUERY_DESC_IDN_UNIT             = 0x2,
 177         QUERY_DESC_IDN_RFU_0            = 0x3,
 178         QUERY_DESC_IDN_INTERCONNECT     = 0x4,
 179         QUERY_DESC_IDN_STRING           = 0x5,
 180         QUERY_DESC_IDN_RFU_1            = 0x6,
 181         QUERY_DESC_IDN_GEOMETRY         = 0x7,
 182         QUERY_DESC_IDN_POWER            = 0x8,
 183         QUERY_DESC_IDN_HEALTH           = 0x9,
 184         QUERY_DESC_IDN_MAX,
 185 };
 186
 187 enum desc_header_offset {
 188         QUERY_DESC_LENGTH_OFFSET        = 0x00,
 189         QUERY_DESC_DESC_TYPE_OFFSET     = 0x01,
 190 };
 191
 192 enum ufs_desc_def_size {
 193         QUERY_DESC_DEVICE_DEF_SIZE              = 0x40,
 194         QUERY_DESC_CONFIGURATION_DEF_SIZE       = 0x90,
 195         QUERY_DESC_UNIT_DEF_SIZE                = 0x23,
 196         QUERY_DESC_INTERCONNECT_DEF_SIZE        = 0x06,
 197         QUERY_DESC_GEOMETRY_DEF_SIZE            = 0x48,
 198         QUERY_DESC_POWER_DEF_SIZE               = 0x62,
 199         QUERY_DESC_HEALTH_DEF_SIZE              = 0x25,
 200 };
 201
 202 /* Unit descriptor parameters offsets in bytes*/
 203 enum unit_desc_param {
 204         UNIT_DESC_PARAM_LEN                     = 0x0,
 205         UNIT_DESC_PARAM_TYPE                    = 0x1,
 206         UNIT_DESC_PARAM_UNIT_INDEX              = 0x2,
 207         UNIT_DESC_PARAM_LU_ENABLE               = 0x3,
 208         UNIT_DESC_PARAM_BOOT_LUN_ID             = 0x4,
 209         UNIT_DESC_PARAM_LU_WR_PROTECT           = 0x5,
 210         UNIT_DESC_PARAM_LU_Q_DEPTH              = 0x6,
 211         UNIT_DESC_PARAM_PSA_SENSITIVE           = 0x7,
 212         UNIT_DESC_PARAM_MEM_TYPE                = 0x8,
 213         UNIT_DESC_PARAM_DATA_RELIABILITY        = 0x9,
 214         UNIT_DESC_PARAM_LOGICAL_BLK_SIZE        = 0xA,
 215         UNIT_DESC_PARAM_LOGICAL_BLK_COUNT       = 0xB,
 216         UNIT_DESC_PARAM_ERASE_BLK_SIZE          = 0x13,
 217         UNIT_DESC_PARAM_PROVISIONING_TYPE       = 0x17,
 218         UNIT_DESC_PARAM_PHY_MEM_RSRC_CNT        = 0x18,
 219         UNIT_DESC_PARAM_CTX_CAPABILITIES        = 0x20,
 220         UNIT_DESC_PARAM_LARGE_UNIT_SIZE_M1      = 0x22,
 221 };
 222
 223 /* Device descriptor parameters offsets in bytes*/
 224 enum device_desc_param {
 225         DEVICE_DESC_PARAM_LEN                   = 0x0,
 226         DEVICE_DESC_PARAM_TYPE                  = 0x1,
 227         DEVICE_DESC_PARAM_DEVICE_TYPE           = 0x2,
 228         DEVICE_DESC_PARAM_DEVICE_CLASS          = 0x3,
 229         DEVICE_DESC_PARAM_DEVICE_SUB_CLASS      = 0x4,
 230         DEVICE_DESC_PARAM_PRTCL                 = 0x5,
 231         DEVICE_DESC_PARAM_NUM_LU                = 0x6,
 232         DEVICE_DESC_PARAM_NUM_WLU               = 0x7,
 233         DEVICE_DESC_PARAM_BOOT_ENBL             = 0x8,
 234         DEVICE_DESC_PARAM_DESC_ACCSS_ENBL       = 0x9,
 235         DEVICE_DESC_PARAM_INIT_PWR_MODE         = 0xA,
 236         DEVICE_DESC_PARAM_HIGH_PR_LUN           = 0xB,
 237         DEVICE_DESC_PARAM_SEC_RMV_TYPE          = 0xC,
 238         DEVICE_DESC_PARAM_SEC_LU                = 0xD,
 239         DEVICE_DESC_PARAM_BKOP_TERM_LT          = 0xE,
 240         DEVICE_DESC_PARAM_ACTVE_ICC_LVL         = 0xF,
 241         DEVICE_DESC_PARAM_SPEC_VER              = 0x10,
 242         DEVICE_DESC_PARAM_MANF_DATE             = 0x12,
 243         DEVICE_DESC_PARAM_MANF_NAME             = 0x14,
 244         DEVICE_DESC_PARAM_PRDCT_NAME            = 0x15,
 245         DEVICE_DESC_PARAM_SN                    = 0x16,
 246         DEVICE_DESC_PARAM_OEM_ID                = 0x17,
 247         DEVICE_DESC_PARAM_MANF_ID               = 0x18,
 248         DEVICE_DESC_PARAM_UD_OFFSET             = 0x1A,
 249         DEVICE_DESC_PARAM_UD_LEN                = 0x1B,
 250         DEVICE_DESC_PARAM_RTT_CAP               = 0x1C,
 251         DEVICE_DESC_PARAM_FRQ_RTC               = 0x1D,
 252         DEVICE_DESC_PARAM_UFS_FEAT              = 0x1F,
 253         DEVICE_DESC_PARAM_FFU_TMT               = 0x20,
 254         DEVICE_DESC_PARAM_Q_DPTH                = 0x21,
 255         DEVICE_DESC_PARAM_DEV_VER               = 0x22,
 256         DEVICE_DESC_PARAM_NUM_SEC_WPA           = 0x24,
 257         DEVICE_DESC_PARAM_PSA_MAX_DATA          = 0x25,
 258         DEVICE_DESC_PARAM_PSA_TMT               = 0x29,
 259         DEVICE_DESC_PARAM_PRDCT_REV             = 0x2A,
 260 };
 261
 262 /* Interconnect descriptor parameters offsets in bytes*/
 263 enum interconnect_desc_param {
 264         INTERCONNECT_DESC_PARAM_LEN             = 0x0,
 265         INTERCONNECT_DESC_PARAM_TYPE            = 0x1,
 266         INTERCONNECT_DESC_PARAM_UNIPRO_VER      = 0x2,
 267         INTERCONNECT_DESC_PARAM_MPHY_VER        = 0x4,
 268 };
 269
 270 /* Geometry descriptor parameters offsets in bytes*/
 271 enum geometry_desc_param {
 272         GEOMETRY_DESC_PARAM_LEN                 = 0x0,
 273         GEOMETRY_DESC_PARAM_TYPE                = 0x1,
 274         GEOMETRY_DESC_PARAM_DEV_CAP             = 0x4,
 275         GEOMETRY_DESC_PARAM_MAX_NUM_LUN         = 0xC,
 276         GEOMETRY_DESC_PARAM_SEG_SIZE            = 0xD,
 277         GEOMETRY_DESC_PARAM_ALLOC_UNIT_SIZE     = 0x11,
 278         GEOMETRY_DESC_PARAM_MIN_BLK_SIZE        = 0x12,
 279         GEOMETRY_DESC_PARAM_OPT_RD_BLK_SIZE     = 0x13,
 280         GEOMETRY_DESC_PARAM_OPT_WR_BLK_SIZE     = 0x14,
 281         GEOMETRY_DESC_PARAM_MAX_IN_BUF_SIZE     = 0x15,
 282         GEOMETRY_DESC_PARAM_MAX_OUT_BUF_SIZE    = 0x16,
 283         GEOMETRY_DESC_PARAM_RPMB_RW_SIZE        = 0x17,
 284         GEOMETRY_DESC_PARAM_DYN_CAP_RSRC_PLC    = 0x18,
 285         GEOMETRY_DESC_PARAM_DATA_ORDER          = 0x19,
 286         GEOMETRY_DESC_PARAM_MAX_NUM_CTX         = 0x1A,
 287         GEOMETRY_DESC_PARAM_TAG_UNIT_SIZE       = 0x1B,
 288         GEOMETRY_DESC_PARAM_TAG_RSRC_SIZE       = 0x1C,
 289         GEOMETRY_DESC_PARAM_SEC_RM_TYPES        = 0x1D,
 290         GEOMETRY_DESC_PARAM_MEM_TYPES           = 0x1E,
 291         GEOMETRY_DESC_PARAM_SCM_MAX_NUM_UNITS   = 0x20,
 292         GEOMETRY_DESC_PARAM_SCM_CAP_ADJ_FCTR    = 0x24,
 293         GEOMETRY_DESC_PARAM_NPM_MAX_NUM_UNITS   = 0x26,
 294         GEOMETRY_DESC_PARAM_NPM_CAP_ADJ_FCTR    = 0x2A,
 295         GEOMETRY_DESC_PARAM_ENM1_MAX_NUM_UNITS  = 0x2C,
 296         GEOMETRY_DESC_PARAM_ENM1_CAP_ADJ_FCTR   = 0x30,
 297         GEOMETRY_DESC_PARAM_ENM2_MAX_NUM_UNITS  = 0x32,
 298         GEOMETRY_DESC_PARAM_ENM2_CAP_ADJ_FCTR   = 0x36,
 299         GEOMETRY_DESC_PARAM_ENM3_MAX_NUM_UNITS  = 0x38,
 300         GEOMETRY_DESC_PARAM_ENM3_CAP_ADJ_FCTR   = 0x3C,
 301         GEOMETRY_DESC_PARAM_ENM4_MAX_NUM_UNITS  = 0x3E,
 302         GEOMETRY_DESC_PARAM_ENM4_CAP_ADJ_FCTR   = 0x42,
 303         GEOMETRY_DESC_PARAM_OPT_LOG_BLK_SIZE    = 0x44,
 304 };
 305
 306 /* Health descriptor parameters offsets in bytes*/
 307 enum health_desc_param {
 308         HEALTH_DESC_PARAM_LEN                   = 0x0,
 309         HEALTH_DESC_PARAM_TYPE                  = 0x1,
 310         HEALTH_DESC_PARAM_EOL_INFO              = 0x2,
 311         HEALTH_DESC_PARAM_LIFE_TIME_EST_A       = 0x3,
 312         HEALTH_DESC_PARAM_LIFE_TIME_EST_B       = 0x4,
 313 };
 314
 315 /*
 316  * Logical Unit Write Protect
 317  * 00h: LU not write protected
 318  * 01h: LU write protected when fPowerOnWPEn =1
 319  * 02h: LU permanently write protected when fPermanentWPEn =1
 320  */
 321 enum ufs_lu_wp_type {
 322         UFS_LU_NO_WP            = 0x00,
 323         UFS_LU_POWER_ON_WP      = 0x01,
 324         UFS_LU_PERM_WP          = 0x02,
 325 };
 326
 327 /* bActiveICCLevel parameter current units */
 328 enum {
 329         UFSHCD_NANO_AMP         = 0,
 330         UFSHCD_MICRO_AMP        = 1,
 331         UFSHCD_MILI_AMP         = 2,
 332         UFSHCD_AMP              = 3,
 333 };
 334
 335 #define POWER_DESC_MAX_SIZE                     0x62
 336 #define POWER_DESC_MAX_ACTV_ICC_LVLS            16
 337
 338 /* Attribute  bActiveICCLevel parameter bit masks definitions */
 339 #define ATTR_ICC_LVL_UNIT_OFFSET        14
 340 #define ATTR_ICC_LVL_UNIT_MASK          (0x3 << ATTR_ICC_LVL_UNIT_OFFSET)
 341 #define ATTR_ICC_LVL_VALUE_MASK         0x3FF
 342
 343 /* Power descriptor parameters offsets in bytes */
 344 enum power_desc_param_offset {
 345         PWR_DESC_LEN                    = 0x0,
 346         PWR_DESC_TYPE                   = 0x1,
 347         PWR_DESC_ACTIVE_LVLS_VCC_0      = 0x2,
 348         PWR_DESC_ACTIVE_LVLS_VCCQ_0     = 0x22,
 349         PWR_DESC_ACTIVE_LVLS_VCCQ2_0    = 0x42,
 350 };
 351
 352 /* Exception event mask values */
 353 enum {
 354         MASK_EE_STATUS          = 0xFFFF,
 355         MASK_EE_URGENT_BKOPS    = (1 << 2),
 356 };
 357
 358 /* Background operation status */
 359 enum bkops_status {
 360         BKOPS_STATUS_NO_OP               = 0x0,
 361         BKOPS_STATUS_NON_CRITICAL        = 0x1,
 362         BKOPS_STATUS_PERF_IMPACT         = 0x2,
 363         BKOPS_STATUS_CRITICAL            = 0x3,
 364         BKOPS_STATUS_MAX                 = BKOPS_STATUS_CRITICAL,
 365 };
 366
 367 /* UTP QUERY Transaction Specific Fields OpCode */
 368 enum query_opcode {
 369         UPIU_QUERY_OPCODE_NOP           = 0x0,
 370         UPIU_QUERY_OPCODE_READ_DESC     = 0x1,
 371         UPIU_QUERY_OPCODE_WRITE_DESC    = 0x2,
 372         UPIU_QUERY_OPCODE_READ_ATTR     = 0x3,
 373         UPIU_QUERY_OPCODE_WRITE_ATTR    = 0x4,
 374         UPIU_QUERY_OPCODE_READ_FLAG     = 0x5,
 375         UPIU_QUERY_OPCODE_SET_FLAG      = 0x6,
 376         UPIU_QUERY_OPCODE_CLEAR_FLAG    = 0x7,
 377         UPIU_QUERY_OPCODE_TOGGLE_FLAG   = 0x8,
 378 };
 379
 380 /* bRefClkFreq attribute values */
 381 enum ufs_ref_clk_freq {
 382         REF_CLK_FREQ_19_2_MHZ   = 0,
 383         REF_CLK_FREQ_26_MHZ     = 1,
 384         REF_CLK_FREQ_38_4_MHZ   = 2,
 385         REF_CLK_FREQ_52_MHZ     = 3,
 386         REF_CLK_FREQ_INVAL      = -1,
 387 };
 388
 389 struct ufs_ref_clk {
 390         unsigned long freq_hz;
 391         enum ufs_ref_clk_freq val;
 392 };
 393
 394 /* Query response result code */
 395 enum {
 396         QUERY_RESULT_SUCCESS                    = 0x00,
 397         QUERY_RESULT_NOT_READABLE               = 0xF6,
 398         QUERY_RESULT_NOT_WRITEABLE              = 0xF7,
 399         QUERY_RESULT_ALREADY_WRITTEN            = 0xF8,
 400         QUERY_RESULT_INVALID_LENGTH             = 0xF9,
 401         QUERY_RESULT_INVALID_VALUE              = 0xFA,
 402         QUERY_RESULT_INVALID_SELECTOR           = 0xFB,
 403         QUERY_RESULT_INVALID_INDEX              = 0xFC,
 404         QUERY_RESULT_INVALID_IDN                = 0xFD,
 405         QUERY_RESULT_INVALID_OPCODE             = 0xFE,
 406         QUERY_RESULT_GENERAL_FAILURE            = 0xFF,
 407 };
 408
 409 /* UTP Transfer Request Command Type (CT) */
 410 enum {
 411         UPIU_COMMAND_SET_TYPE_SCSI      = 0x0,
 412         UPIU_COMMAND_SET_TYPE_UFS       = 0x1,
 413         UPIU_COMMAND_SET_TYPE_QUERY     = 0x2,
 414 };
 415
 416 /* UTP Transfer Request Command Offset */
 417 #define UPIU_COMMAND_TYPE_OFFSET        28
 418
 419 /* Offset of the response code in the UPIU header */
 420 #define UPIU_RSP_CODE_OFFSET            8
 421
 422 enum {
 423         MASK_SCSI_STATUS                = 0xFF,
 424         MASK_TASK_RESPONSE              = 0xFF00,
 425         MASK_RSP_UPIU_RESULT            = 0xFFFF,
 426         MASK_QUERY_DATA_SEG_LEN         = 0xFFFF,
 427         MASK_RSP_UPIU_DATA_SEG_LEN      = 0xFFFF,
 428         MASK_RSP_EXCEPTION_EVENT        = 0x10000,
 429         MASK_TM_SERVICE_RESP            = 0xFF,
 430         MASK_TM_FUNC                    = 0xFF,
 431 };
 432
 433 /* Task management service response */
 434 enum {
 435         UPIU_TASK_MANAGEMENT_FUNC_COMPL         = 0x00,
 436         UPIU_TASK_MANAGEMENT_FUNC_NOT_SUPPORTED = 0x04,
 437         UPIU_TASK_MANAGEMENT_FUNC_SUCCEEDED     = 0x08,
 438         UPIU_TASK_MANAGEMENT_FUNC_FAILED        = 0x05,
 439         UPIU_INCORRECT_LOGICAL_UNIT_NO          = 0x09,
 440 };
 441
 442 /* UFS device power modes */
 443 enum ufs_dev_pwr_mode {
 444         UFS_ACTIVE_PWR_MODE     = 1,
 445         UFS_SLEEP_PWR_MODE      = 2,
 446         UFS_POWERDOWN_PWR_MODE  = 3,
 447 };
 448
 449 /**
 450  * struct utp_cmd_rsp - Response UPIU structure
 451  * @residual_transfer_count: Residual transfer count DW-3
 452  * @reserved: Reserved double words DW-4 to DW-7
 453  * @sense_data_len: Sense data length DW-8 U16
 454  * @sense_data: Sense data field DW-8 to DW-12
 455  */
 456 struct utp_cmd_rsp {
 457         __be32 residual_transfer_count;
 458         __be32 reserved[4];
 459         __be16 sense_data_len;
 460         u8 sense_data[UFS_SENSE_SIZE];
 461 };
 462
 463 /**
 464  * struct utp_upiu_rsp - general upiu response structure
 465  * @header: UPIU header structure DW-0 to DW-2
 466  * @sr: fields structure for scsi command DW-3 to DW-12
 467  * @qr: fields structure for query request DW-3 to DW-7
 468  */
 469 struct utp_upiu_rsp {
 470         struct utp_upiu_header header;
 471         union {
 472                 struct utp_cmd_rsp sr;
 473                 struct utp_upiu_query qr;
 474         };
 475 };
 476
 477 /**
 478  * struct ufs_query_req - parameters for building a query request
 479  * @query_func: UPIU header query function
 480  * @upiu_req: the query request data
 481  */
 482 struct ufs_query_req {
 483         u8 query_func;
 484         struct utp_upiu_query upiu_req;
 485 };
 486
 487 /**
 488  * struct ufs_query_resp - UPIU QUERY
 489  * @response: device response code
 490  * @upiu_res: query response data
 491  */
 492 struct ufs_query_res {
 493         u8 response;
 494         struct utp_upiu_query upiu_res;
 495 };
 496
 497 #define UFS_VREG_VCC_MIN_UV        2700000 /* uV */
 498 #define UFS_VREG_VCC_MAX_UV        3600000 /* uV */
 499 #define UFS_VREG_VCC_1P8_MIN_UV    1700000 /* uV */
 500 #define UFS_VREG_VCC_1P8_MAX_UV    1950000 /* uV */
 501 #define UFS_VREG_VCCQ_MIN_UV       1140000 /* uV */
 502 #define UFS_VREG_VCCQ_MAX_UV       1260000 /* uV */
 503 #define UFS_VREG_VCCQ2_MIN_UV      1700000 /* uV */
 504 #define UFS_VREG_VCCQ2_MAX_UV      1950000 /* uV */
 505
 506 /*
 507  * VCCQ & VCCQ2 current requirement when UFS device is in sleep state
 508  * and link is in Hibern8 state.
 509  */
 510 #define UFS_VREG_LPM_LOAD_UA    1000 /* uA */
 511
 512 struct ufs_vreg {
 513         struct regulator *reg;
 514         const char *name;
 515         bool enabled;
 516         int min_uV;
 517         int max_uV;
 518         int max_uA;
 519 };
 520
 521 struct ufs_vreg_info {
 522         struct ufs_vreg *vcc;
 523         struct ufs_vreg *vccq;
 524         struct ufs_vreg *vccq2;
 525         struct ufs_vreg *vdd_hba;
 526 };
 527
 528 struct ufs_dev_info {
 529         bool f_power_on_wp_en;
 530         /* Keeps information if any of the LU is power on write protected */
 531         bool is_lu_power_on_wp;
 532         /* Maximum number of general LU supported by the UFS device */
 533         u8 max_lu_supported;
 534         u16 wmanufacturerid;
 535         /*UFS device Product Name */
 536         u8 *model;
 537 };
 538
 539 /**
 540  * ufs_is_valid_unit_desc_lun - checks if the given LUN has a unit descriptor
 541  * @dev_info: pointer of instance of struct ufs_dev_info
 542  * @lun: LU number to check
 543  * @return: true if the lun has a matching unit descriptor, false otherwise
 544  */
 545 static inline bool ufs_is_valid_unit_desc_lun(struct ufs_dev_info *dev_info,
 546                 u8 lun)
 547 {
 548         if (!dev_info || !dev_info->max_lu_supported) {
 549                 pr_err("Max General LU supported by UFS isn't initilized\n");
 550                 return false;
 551         }
 552
 553         return lun == UFS_UPIU_RPMB_WLUN || (lun < dev_info->max_lu_supported);
 554 }
 555
 556 #endif /* End of Header */