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_OSF_SIZE            (GENERAL_UPIU_REQUEST_SIZE - \
  47                                         (sizeof(struct utp_upiu_header)))
  48 #define RESPONSE_UPIU_SENSE_DATA_LENGTH 18
  49
  50 #define UPIU_HEADER_DWORD(byte3, byte2, byte1, byte0)\
  51                         cpu_to_be32((byte3 << 24) | (byte2 << 16) |\
  52                          (byte1 << 8) | (byte0))
  53 /*
  54  * UFS device may have standard LUs and LUN id could be from 0x00 to
  55  * 0x7F. Standard LUs use "Peripheral Device Addressing Format".
  56  * UFS device may also have the Well Known LUs (also referred as W-LU)
  57  * which again could be from 0x00 to 0x7F. For W-LUs, device only use
  58  * the "Extended Addressing Format" which means the W-LUNs would be
  59  * from 0xc100 (SCSI_W_LUN_BASE) onwards.
  60  * This means max. LUN number reported from UFS device could be 0xC17F.
  61  */
  62 #define UFS_UPIU_MAX_UNIT_NUM_ID        0x7F
  63 #define UFS_MAX_LUNS            (SCSI_W_LUN_BASE + UFS_UPIU_MAX_UNIT_NUM_ID)
  64 #define UFS_UPIU_WLUN_ID        (1 << 7)
  65 #define UFS_UPIU_MAX_GENERAL_LUN        8
  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_PWR_ON_WPE       = 0x03,
 134         QUERY_FLAG_IDN_BKOPS_EN         = 0x04,
 135 };
 136
 137 /* Attribute idn for Query requests */
 138 enum attr_idn {
 139         QUERY_ATTR_IDN_ACTIVE_ICC_LVL   = 0x03,
 140         QUERY_ATTR_IDN_BKOPS_STATUS     = 0x05,
 141         QUERY_ATTR_IDN_EE_CONTROL       = 0x0D,
 142         QUERY_ATTR_IDN_EE_STATUS        = 0x0E,
 143 };
 144
 145 /* Descriptor idn for Query requests */
 146 enum desc_idn {
 147         QUERY_DESC_IDN_DEVICE           = 0x0,
 148         QUERY_DESC_IDN_CONFIGURAION     = 0x1,
 149         QUERY_DESC_IDN_UNIT             = 0x2,
 150         QUERY_DESC_IDN_RFU_0            = 0x3,
 151         QUERY_DESC_IDN_INTERCONNECT     = 0x4,
 152         QUERY_DESC_IDN_STRING           = 0x5,
 153         QUERY_DESC_IDN_RFU_1            = 0x6,
 154         QUERY_DESC_IDN_GEOMETRY         = 0x7,
 155         QUERY_DESC_IDN_POWER            = 0x8,
 156         QUERY_DESC_IDN_MAX,
 157 };
 158
 159 enum desc_header_offset {
 160         QUERY_DESC_LENGTH_OFFSET        = 0x00,
 161         QUERY_DESC_DESC_TYPE_OFFSET     = 0x01,
 162 };
 163
 164 enum ufs_desc_max_size {
 165         QUERY_DESC_DEVICE_MAX_SIZE              = 0x1F,
 166         QUERY_DESC_CONFIGURAION_MAX_SIZE        = 0x90,
 167         QUERY_DESC_UNIT_MAX_SIZE                = 0x23,
 168         QUERY_DESC_INTERCONNECT_MAX_SIZE        = 0x06,
 169         /*
 170          * Max. 126 UNICODE characters (2 bytes per character) plus 2 bytes
 171          * of descriptor header.
 172          */
 173         QUERY_DESC_STRING_MAX_SIZE              = 0xFE,
 174         QUERY_DESC_GEOMETRY_MAZ_SIZE            = 0x44,
 175         QUERY_DESC_POWER_MAX_SIZE               = 0x62,
 176         QUERY_DESC_RFU_MAX_SIZE                 = 0x00,
 177 };
 178
 179 /* Unit descriptor parameters offsets in bytes*/
 180 enum unit_desc_param {
 181         UNIT_DESC_PARAM_LEN                     = 0x0,
 182         UNIT_DESC_PARAM_TYPE                    = 0x1,
 183         UNIT_DESC_PARAM_UNIT_INDEX              = 0x2,
 184         UNIT_DESC_PARAM_LU_ENABLE               = 0x3,
 185         UNIT_DESC_PARAM_BOOT_LUN_ID             = 0x4,
 186         UNIT_DESC_PARAM_LU_WR_PROTECT           = 0x5,
 187         UNIT_DESC_PARAM_LU_Q_DEPTH              = 0x6,
 188         UNIT_DESC_PARAM_MEM_TYPE                = 0x8,
 189         UNIT_DESC_PARAM_DATA_RELIABILITY        = 0x9,
 190         UNIT_DESC_PARAM_LOGICAL_BLK_SIZE        = 0xA,
 191         UNIT_DESC_PARAM_LOGICAL_BLK_COUNT       = 0xB,
 192         UNIT_DESC_PARAM_ERASE_BLK_SIZE          = 0x13,
 193         UNIT_DESC_PARAM_PROVISIONING_TYPE       = 0x17,
 194         UNIT_DESC_PARAM_PHY_MEM_RSRC_CNT        = 0x18,
 195         UNIT_DESC_PARAM_CTX_CAPABILITIES        = 0x20,
 196         UNIT_DESC_PARAM_LARGE_UNIT_SIZE_M1      = 0x22,
 197 };
 198
 199 /*
 200  * Logical Unit Write Protect
 201  * 00h: LU not write protected
 202  * 01h: LU write protected when fPowerOnWPEn =1
 203  * 02h: LU permanently write protected when fPermanentWPEn =1
 204  */
 205 enum ufs_lu_wp_type {
 206         UFS_LU_NO_WP            = 0x00,
 207         UFS_LU_POWER_ON_WP      = 0x01,
 208         UFS_LU_PERM_WP          = 0x02,
 209 };
 210
 211 /* bActiveICCLevel parameter current units */
 212 enum {
 213         UFSHCD_NANO_AMP         = 0,
 214         UFSHCD_MICRO_AMP        = 1,
 215         UFSHCD_MILI_AMP         = 2,
 216         UFSHCD_AMP              = 3,
 217 };
 218
 219 #define POWER_DESC_MAX_SIZE                     0x62
 220 #define POWER_DESC_MAX_ACTV_ICC_LVLS            16
 221
 222 /* Attribute  bActiveICCLevel parameter bit masks definitions */
 223 #define ATTR_ICC_LVL_UNIT_OFFSET        14
 224 #define ATTR_ICC_LVL_UNIT_MASK          (0x3 << ATTR_ICC_LVL_UNIT_OFFSET)
 225 #define ATTR_ICC_LVL_VALUE_MASK         0x3FF
 226
 227 /* Power descriptor parameters offsets in bytes */
 228 enum power_desc_param_offset {
 229         PWR_DESC_LEN                    = 0x0,
 230         PWR_DESC_TYPE                   = 0x1,
 231         PWR_DESC_ACTIVE_LVLS_VCC_0      = 0x2,
 232         PWR_DESC_ACTIVE_LVLS_VCCQ_0     = 0x22,
 233         PWR_DESC_ACTIVE_LVLS_VCCQ2_0    = 0x42,
 234 };
 235
 236 /* Exception event mask values */
 237 enum {
 238         MASK_EE_STATUS          = 0xFFFF,
 239         MASK_EE_URGENT_BKOPS    = (1 << 2),
 240 };
 241
 242 /* Background operation status */
 243 enum bkops_status {
 244         BKOPS_STATUS_NO_OP               = 0x0,
 245         BKOPS_STATUS_NON_CRITICAL        = 0x1,
 246         BKOPS_STATUS_PERF_IMPACT         = 0x2,
 247         BKOPS_STATUS_CRITICAL            = 0x3,
 248         BKOPS_STATUS_MAX                 = BKOPS_STATUS_CRITICAL,
 249 };
 250
 251 /* UTP QUERY Transaction Specific Fields OpCode */
 252 enum query_opcode {
 253         UPIU_QUERY_OPCODE_NOP           = 0x0,
 254         UPIU_QUERY_OPCODE_READ_DESC     = 0x1,
 255         UPIU_QUERY_OPCODE_WRITE_DESC    = 0x2,
 256         UPIU_QUERY_OPCODE_READ_ATTR     = 0x3,
 257         UPIU_QUERY_OPCODE_WRITE_ATTR    = 0x4,
 258         UPIU_QUERY_OPCODE_READ_FLAG     = 0x5,
 259         UPIU_QUERY_OPCODE_SET_FLAG      = 0x6,
 260         UPIU_QUERY_OPCODE_CLEAR_FLAG    = 0x7,
 261         UPIU_QUERY_OPCODE_TOGGLE_FLAG   = 0x8,
 262 };
 263
 264 /* Query response result code */
 265 enum {
 266         QUERY_RESULT_SUCCESS                    = 0x00,
 267         QUERY_RESULT_NOT_READABLE               = 0xF6,
 268         QUERY_RESULT_NOT_WRITEABLE              = 0xF7,
 269         QUERY_RESULT_ALREADY_WRITTEN            = 0xF8,
 270         QUERY_RESULT_INVALID_LENGTH             = 0xF9,
 271         QUERY_RESULT_INVALID_VALUE              = 0xFA,
 272         QUERY_RESULT_INVALID_SELECTOR           = 0xFB,
 273         QUERY_RESULT_INVALID_INDEX              = 0xFC,
 274         QUERY_RESULT_INVALID_IDN                = 0xFD,
 275         QUERY_RESULT_INVALID_OPCODE             = 0xFE,
 276         QUERY_RESULT_GENERAL_FAILURE            = 0xFF,
 277 };
 278
 279 /* UTP Transfer Request Command Type (CT) */
 280 enum {
 281         UPIU_COMMAND_SET_TYPE_SCSI      = 0x0,
 282         UPIU_COMMAND_SET_TYPE_UFS       = 0x1,
 283         UPIU_COMMAND_SET_TYPE_QUERY     = 0x2,
 284 };
 285
 286 /* UTP Transfer Request Command Offset */
 287 #define UPIU_COMMAND_TYPE_OFFSET        28
 288
 289 /* Offset of the response code in the UPIU header */
 290 #define UPIU_RSP_CODE_OFFSET            8
 291
 292 enum {
 293         MASK_SCSI_STATUS                = 0xFF,
 294         MASK_TASK_RESPONSE              = 0xFF00,
 295         MASK_RSP_UPIU_RESULT            = 0xFFFF,
 296         MASK_QUERY_DATA_SEG_LEN         = 0xFFFF,
 297         MASK_RSP_UPIU_DATA_SEG_LEN      = 0xFFFF,
 298         MASK_RSP_EXCEPTION_EVENT        = 0x10000,
 299 };
 300
 301 /* Task management service response */
 302 enum {
 303         UPIU_TASK_MANAGEMENT_FUNC_COMPL         = 0x00,
 304         UPIU_TASK_MANAGEMENT_FUNC_NOT_SUPPORTED = 0x04,
 305         UPIU_TASK_MANAGEMENT_FUNC_SUCCEEDED     = 0x08,
 306         UPIU_TASK_MANAGEMENT_FUNC_FAILED        = 0x05,
 307         UPIU_INCORRECT_LOGICAL_UNIT_NO          = 0x09,
 308 };
 309
 310 /* UFS device power modes */
 311 enum ufs_dev_pwr_mode {
 312         UFS_ACTIVE_PWR_MODE     = 1,
 313         UFS_SLEEP_PWR_MODE      = 2,
 314         UFS_POWERDOWN_PWR_MODE  = 3,
 315 };
 316
 317 /**
 318  * struct utp_upiu_header - UPIU header structure
 319  * @dword_0: UPIU header DW-0
 320  * @dword_1: UPIU header DW-1
 321  * @dword_2: UPIU header DW-2
 322  */
 323 struct utp_upiu_header {
 324         __be32 dword_0;
 325         __be32 dword_1;
 326         __be32 dword_2;
 327 };
 328
 329 /**
 330  * struct utp_upiu_cmd - Command UPIU structure
 331  * @data_transfer_len: Data Transfer Length DW-3
 332  * @cdb: Command Descriptor Block CDB DW-4 to DW-7
 333  */
 334 struct utp_upiu_cmd {
 335         __be32 exp_data_transfer_len;
 336         u8 cdb[MAX_CDB_SIZE];
 337 };
 338
 339 /**
 340  * struct utp_upiu_query - upiu request buffer structure for
 341  * query request.
 342  * @opcode: command to perform B-0
 343  * @idn: a value that indicates the particular type of data B-1
 344  * @index: Index to further identify data B-2
 345  * @selector: Index to further identify data B-3
 346  * @reserved_osf: spec reserved field B-4,5
 347  * @length: number of descriptor bytes to read/write B-6,7
 348  * @value: Attribute value to be written DW-5
 349  * @reserved: spec reserved DW-6,7
 350  */
 351 struct utp_upiu_query {
 352         u8 opcode;
 353         u8 idn;
 354         u8 index;
 355         u8 selector;
 356         __be16 reserved_osf;
 357         __be16 length;
 358         __be32 value;
 359         __be32 reserved[2];
 360 };
 361
 362 /**
 363  * struct utp_upiu_req - general upiu request structure
 364  * @header:UPIU header structure DW-0 to DW-2
 365  * @sc: fields structure for scsi command DW-3 to DW-7
 366  * @qr: fields structure for query request DW-3 to DW-7
 367  */
 368 struct utp_upiu_req {
 369         struct utp_upiu_header header;
 370         union {
 371                 struct utp_upiu_cmd sc;
 372                 struct utp_upiu_query qr;
 373         };
 374 };
 375
 376 /**
 377  * struct utp_cmd_rsp - Response UPIU structure
 378  * @residual_transfer_count: Residual transfer count DW-3
 379  * @reserved: Reserved double words DW-4 to DW-7
 380  * @sense_data_len: Sense data length DW-8 U16
 381  * @sense_data: Sense data field DW-8 to DW-12
 382  */
 383 struct utp_cmd_rsp {
 384         __be32 residual_transfer_count;
 385         __be32 reserved[4];
 386         __be16 sense_data_len;
 387         u8 sense_data[RESPONSE_UPIU_SENSE_DATA_LENGTH];
 388 };
 389
 390 /**
 391  * struct utp_upiu_rsp - general upiu response structure
 392  * @header: UPIU header structure DW-0 to DW-2
 393  * @sr: fields structure for scsi command DW-3 to DW-12
 394  * @qr: fields structure for query request DW-3 to DW-7
 395  */
 396 struct utp_upiu_rsp {
 397         struct utp_upiu_header header;
 398         union {
 399                 struct utp_cmd_rsp sr;
 400                 struct utp_upiu_query qr;
 401         };
 402 };
 403
 404 /**
 405  * struct utp_upiu_task_req - Task request UPIU structure
 406  * @header - UPIU header structure DW0 to DW-2
 407  * @input_param1: Input parameter 1 DW-3
 408  * @input_param2: Input parameter 2 DW-4
 409  * @input_param3: Input parameter 3 DW-5
 410  * @reserved: Reserved double words DW-6 to DW-7
 411  */
 412 struct utp_upiu_task_req {
 413         struct utp_upiu_header header;
 414         __be32 input_param1;
 415         __be32 input_param2;
 416         __be32 input_param3;
 417         __be32 reserved[2];
 418 };
 419
 420 /**
 421  * struct utp_upiu_task_rsp - Task Management Response UPIU structure
 422  * @header: UPIU header structure DW0-DW-2
 423  * @output_param1: Ouput parameter 1 DW3
 424  * @output_param2: Output parameter 2 DW4
 425  * @reserved: Reserved double words DW-5 to DW-7
 426  */
 427 struct utp_upiu_task_rsp {
 428         struct utp_upiu_header header;
 429         __be32 output_param1;
 430         __be32 output_param2;
 431         __be32 reserved[3];
 432 };
 433
 434 /**
 435  * struct ufs_query_req - parameters for building a query request
 436  * @query_func: UPIU header query function
 437  * @upiu_req: the query request data
 438  */
 439 struct ufs_query_req {
 440         u8 query_func;
 441         struct utp_upiu_query upiu_req;
 442 };
 443
 444 /**
 445  * struct ufs_query_resp - UPIU QUERY
 446  * @response: device response code
 447  * @upiu_res: query response data
 448  */
 449 struct ufs_query_res {
 450         u8 response;
 451         struct utp_upiu_query upiu_res;
 452 };
 453
 454 #define UFS_VREG_VCC_MIN_UV        2700000 /* uV */
 455 #define UFS_VREG_VCC_MAX_UV        3600000 /* uV */
 456 #define UFS_VREG_VCC_1P8_MIN_UV    1700000 /* uV */
 457 #define UFS_VREG_VCC_1P8_MAX_UV    1950000 /* uV */
 458 #define UFS_VREG_VCCQ_MIN_UV       1100000 /* uV */
 459 #define UFS_VREG_VCCQ_MAX_UV       1300000 /* uV */
 460 #define UFS_VREG_VCCQ2_MIN_UV      1650000 /* uV */
 461 #define UFS_VREG_VCCQ2_MAX_UV      1950000 /* uV */
 462
 463 /*
 464  * VCCQ & VCCQ2 current requirement when UFS device is in sleep state
 465  * and link is in Hibern8 state.
 466  */
 467 #define UFS_VREG_LPM_LOAD_UA    1000 /* uA */
 468
 469 struct ufs_vreg {
 470         struct regulator *reg;
 471         const char *name;
 472         bool enabled;
 473         int min_uV;
 474         int max_uV;
 475         int min_uA;
 476         int max_uA;
 477 };
 478
 479 struct ufs_vreg_info {
 480         struct ufs_vreg *vcc;
 481         struct ufs_vreg *vccq;
 482         struct ufs_vreg *vccq2;
 483         struct ufs_vreg *vdd_hba;
 484 };
 485
 486 struct ufs_dev_info {
 487         bool f_power_on_wp_en;
 488         /* Keeps information if any of the LU is power on write protected */
 489         bool is_lu_power_on_wp;
 490 };
 491
 492 #endif /* End of Header */