^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 1) /* SPDX-License-Identifier: GPL-2.0-or-later */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 2) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 3) * Universal Flash Storage Host controller driver
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 4) * Copyright (C) 2011-2013 Samsung India Software Operations
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 5) *
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 6) * Authors:
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 7) * Santosh Yaraganavi <santosh.sy@samsung.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 8) * Vinayak Holikatti <h.vinayak@samsung.com>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 9) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 11) #ifndef _UFS_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 12) #define _UFS_H
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 13)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 14) #include <linux/mutex.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 15) #include <linux/types.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 16) #include <linux/android_kabi.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 17) #include <uapi/scsi/scsi_bsg_ufs.h>
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 18)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 19) #define GENERAL_UPIU_REQUEST_SIZE (sizeof(struct utp_upiu_req))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 20) #define QUERY_DESC_MAX_SIZE 255
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 21) #define QUERY_DESC_MIN_SIZE 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 22) #define QUERY_DESC_HDR_SIZE 2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 23) #define QUERY_OSF_SIZE (GENERAL_UPIU_REQUEST_SIZE - \
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 24) (sizeof(struct utp_upiu_header)))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 25) #define UFS_SENSE_SIZE 18
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 26)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 27) #define UPIU_HEADER_DWORD(byte3, byte2, byte1, byte0)\
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 28) cpu_to_be32((byte3 << 24) | (byte2 << 16) |\
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 29) (byte1 << 8) | (byte0))
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 30) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 31) * UFS device may have standard LUs and LUN id could be from 0x00 to
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 32) * 0x7F. Standard LUs use "Peripheral Device Addressing Format".
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 33) * UFS device may also have the Well Known LUs (also referred as W-LU)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 34) * which again could be from 0x00 to 0x7F. For W-LUs, device only use
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 35) * the "Extended Addressing Format" which means the W-LUNs would be
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 36) * from 0xc100 (SCSI_W_LUN_BASE) onwards.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 37) * This means max. LUN number reported from UFS device could be 0xC17F.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 38) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 39) #define UFS_UPIU_MAX_UNIT_NUM_ID 0x7F
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 40) #define UFS_MAX_LUNS (SCSI_W_LUN_BASE + UFS_UPIU_MAX_UNIT_NUM_ID)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 41) #define UFS_UPIU_WLUN_ID (1 << 7)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 42) #define UFS_RPMB_UNIT 0xC4
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 43)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 44) /* WriteBooster buffer is available only for the logical unit from 0 to 7 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 45) #define UFS_UPIU_MAX_WB_LUN_ID 8
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 46)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 47) /* Well known logical unit id in LUN field of UPIU */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 48) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 49) UFS_UPIU_REPORT_LUNS_WLUN = 0x81,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 50) UFS_UPIU_UFS_DEVICE_WLUN = 0xD0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 51) UFS_UPIU_BOOT_WLUN = 0xB0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 52) UFS_UPIU_RPMB_WLUN = 0xC4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 53) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 54)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 55) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 56) * UFS Protocol Information Unit related definitions
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 57) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 58)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 59) /* Task management functions */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 60) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 61) UFS_ABORT_TASK = 0x01,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 62) UFS_ABORT_TASK_SET = 0x02,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 63) UFS_CLEAR_TASK_SET = 0x04,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 64) UFS_LOGICAL_RESET = 0x08,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 65) UFS_QUERY_TASK = 0x80,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 66) UFS_QUERY_TASK_SET = 0x81,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 67) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 68)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 69) /* UTP UPIU Transaction Codes Initiator to Target */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 70) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 71) UPIU_TRANSACTION_NOP_OUT = 0x00,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 72) UPIU_TRANSACTION_COMMAND = 0x01,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 73) UPIU_TRANSACTION_DATA_OUT = 0x02,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 74) UPIU_TRANSACTION_TASK_REQ = 0x04,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 75) UPIU_TRANSACTION_QUERY_REQ = 0x16,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 76) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 77)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 78) /* UTP UPIU Transaction Codes Target to Initiator */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 79) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 80) UPIU_TRANSACTION_NOP_IN = 0x20,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 81) UPIU_TRANSACTION_RESPONSE = 0x21,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 82) UPIU_TRANSACTION_DATA_IN = 0x22,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 83) UPIU_TRANSACTION_TASK_RSP = 0x24,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 84) UPIU_TRANSACTION_READY_XFER = 0x31,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 85) UPIU_TRANSACTION_QUERY_RSP = 0x36,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 86) UPIU_TRANSACTION_REJECT_UPIU = 0x3F,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 87) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 88)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 89) /* UPIU Read/Write flags */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 90) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 91) UPIU_CMD_FLAGS_NONE = 0x00,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 92) UPIU_CMD_FLAGS_WRITE = 0x20,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 93) UPIU_CMD_FLAGS_READ = 0x40,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 94) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 95)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 96) /* UPIU Task Attributes */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 97) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 98) UPIU_TASK_ATTR_SIMPLE = 0x00,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 99) UPIU_TASK_ATTR_ORDERED = 0x01,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 100) UPIU_TASK_ATTR_HEADQ = 0x02,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 101) UPIU_TASK_ATTR_ACA = 0x03,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 102) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 103)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 104) /* UPIU Query request function */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 105) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 106) UPIU_QUERY_FUNC_STANDARD_READ_REQUEST = 0x01,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 107) UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST = 0x81,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 108) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 109)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 110) /* Flag idn for Query Requests*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 111) enum flag_idn {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 112) QUERY_FLAG_IDN_FDEVICEINIT = 0x01,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 113) QUERY_FLAG_IDN_PERMANENT_WPE = 0x02,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 114) QUERY_FLAG_IDN_PWR_ON_WPE = 0x03,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 115) QUERY_FLAG_IDN_BKOPS_EN = 0x04,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 116) QUERY_FLAG_IDN_LIFE_SPAN_MODE_ENABLE = 0x05,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 117) QUERY_FLAG_IDN_PURGE_ENABLE = 0x06,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 118) QUERY_FLAG_IDN_RESERVED2 = 0x07,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 119) QUERY_FLAG_IDN_FPHYRESOURCEREMOVAL = 0x08,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 120) QUERY_FLAG_IDN_BUSY_RTC = 0x09,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 121) QUERY_FLAG_IDN_RESERVED3 = 0x0A,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 122) QUERY_FLAG_IDN_PERMANENTLY_DISABLE_FW_UPDATE = 0x0B,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 123) QUERY_FLAG_IDN_WB_EN = 0x0E,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 124) QUERY_FLAG_IDN_WB_BUFF_FLUSH_EN = 0x0F,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 125) QUERY_FLAG_IDN_WB_BUFF_FLUSH_DURING_HIBERN8 = 0x10,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 126) QUERY_FLAG_IDN_HPB_RESET = 0x11,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 127) QUERY_FLAG_IDN_HPB_EN = 0x12,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 128) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 129)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 130) /* Attribute idn for Query requests */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 131) enum attr_idn {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 132) QUERY_ATTR_IDN_BOOT_LU_EN = 0x00,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 133) QUERY_ATTR_IDN_MAX_HPB_SINGLE_CMD = 0x01,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 134) QUERY_ATTR_IDN_POWER_MODE = 0x02,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 135) QUERY_ATTR_IDN_ACTIVE_ICC_LVL = 0x03,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 136) QUERY_ATTR_IDN_OOO_DATA_EN = 0x04,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 137) QUERY_ATTR_IDN_BKOPS_STATUS = 0x05,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 138) QUERY_ATTR_IDN_PURGE_STATUS = 0x06,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 139) QUERY_ATTR_IDN_MAX_DATA_IN = 0x07,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 140) QUERY_ATTR_IDN_MAX_DATA_OUT = 0x08,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 141) QUERY_ATTR_IDN_DYN_CAP_NEEDED = 0x09,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 142) QUERY_ATTR_IDN_REF_CLK_FREQ = 0x0A,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 143) QUERY_ATTR_IDN_CONF_DESC_LOCK = 0x0B,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 144) QUERY_ATTR_IDN_MAX_NUM_OF_RTT = 0x0C,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 145) QUERY_ATTR_IDN_EE_CONTROL = 0x0D,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 146) QUERY_ATTR_IDN_EE_STATUS = 0x0E,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 147) QUERY_ATTR_IDN_SECONDS_PASSED = 0x0F,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 148) QUERY_ATTR_IDN_CNTX_CONF = 0x10,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 149) QUERY_ATTR_IDN_CORR_PRG_BLK_NUM = 0x11,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 150) QUERY_ATTR_IDN_RESERVED2 = 0x12,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 151) QUERY_ATTR_IDN_RESERVED3 = 0x13,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 152) QUERY_ATTR_IDN_FFU_STATUS = 0x14,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 153) QUERY_ATTR_IDN_PSA_STATE = 0x15,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 154) QUERY_ATTR_IDN_PSA_DATA_SIZE = 0x16,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 155) QUERY_ATTR_IDN_REF_CLK_GATING_WAIT_TIME = 0x17,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 156) QUERY_ATTR_IDN_WB_FLUSH_STATUS = 0x1C,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 157) QUERY_ATTR_IDN_AVAIL_WB_BUFF_SIZE = 0x1D,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 158) QUERY_ATTR_IDN_WB_BUFF_LIFE_TIME_EST = 0x1E,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 159) QUERY_ATTR_IDN_CURR_WB_BUFF_SIZE = 0x1F,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 160) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 161)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 162) /* Descriptor idn for Query requests */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 163) enum desc_idn {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 164) QUERY_DESC_IDN_DEVICE = 0x0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 165) QUERY_DESC_IDN_CONFIGURATION = 0x1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 166) QUERY_DESC_IDN_UNIT = 0x2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 167) QUERY_DESC_IDN_RFU_0 = 0x3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 168) QUERY_DESC_IDN_INTERCONNECT = 0x4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 169) QUERY_DESC_IDN_STRING = 0x5,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 170) QUERY_DESC_IDN_RFU_1 = 0x6,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 171) QUERY_DESC_IDN_GEOMETRY = 0x7,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 172) QUERY_DESC_IDN_POWER = 0x8,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 173) QUERY_DESC_IDN_HEALTH = 0x9,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 174) QUERY_DESC_IDN_MAX,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 175) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 176)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 177) enum desc_header_offset {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 178) QUERY_DESC_LENGTH_OFFSET = 0x00,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 179) QUERY_DESC_DESC_TYPE_OFFSET = 0x01,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 180) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 181)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 182) /* Unit descriptor parameters offsets in bytes*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 183) enum unit_desc_param {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 184) UNIT_DESC_PARAM_LEN = 0x0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 185) UNIT_DESC_PARAM_TYPE = 0x1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 186) UNIT_DESC_PARAM_UNIT_INDEX = 0x2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 187) UNIT_DESC_PARAM_LU_ENABLE = 0x3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 188) UNIT_DESC_PARAM_BOOT_LUN_ID = 0x4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 189) UNIT_DESC_PARAM_LU_WR_PROTECT = 0x5,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 190) UNIT_DESC_PARAM_LU_Q_DEPTH = 0x6,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 191) UNIT_DESC_PARAM_PSA_SENSITIVE = 0x7,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 192) UNIT_DESC_PARAM_MEM_TYPE = 0x8,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 193) UNIT_DESC_PARAM_DATA_RELIABILITY = 0x9,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 194) UNIT_DESC_PARAM_LOGICAL_BLK_SIZE = 0xA,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 195) UNIT_DESC_PARAM_LOGICAL_BLK_COUNT = 0xB,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 196) UNIT_DESC_PARAM_ERASE_BLK_SIZE = 0x13,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 197) UNIT_DESC_PARAM_PROVISIONING_TYPE = 0x17,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 198) UNIT_DESC_PARAM_PHY_MEM_RSRC_CNT = 0x18,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 199) UNIT_DESC_PARAM_CTX_CAPABILITIES = 0x20,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 200) UNIT_DESC_PARAM_LARGE_UNIT_SIZE_M1 = 0x22,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 201) UNIT_DESC_PARAM_HPB_LU_MAX_ACTIVE_RGNS = 0x23,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 202) UNIT_DESC_PARAM_HPB_PIN_RGN_START_OFF = 0x25,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 203) UNIT_DESC_PARAM_HPB_NUM_PIN_RGNS = 0x27,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 204) UNIT_DESC_PARAM_WB_BUF_ALLOC_UNITS = 0x29,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 205) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 206)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 207) /* Device descriptor parameters offsets in bytes*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 208) enum device_desc_param {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 209) DEVICE_DESC_PARAM_LEN = 0x0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 210) DEVICE_DESC_PARAM_TYPE = 0x1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 211) DEVICE_DESC_PARAM_DEVICE_TYPE = 0x2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 212) DEVICE_DESC_PARAM_DEVICE_CLASS = 0x3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 213) DEVICE_DESC_PARAM_DEVICE_SUB_CLASS = 0x4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 214) DEVICE_DESC_PARAM_PRTCL = 0x5,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 215) DEVICE_DESC_PARAM_NUM_LU = 0x6,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 216) DEVICE_DESC_PARAM_NUM_WLU = 0x7,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 217) DEVICE_DESC_PARAM_BOOT_ENBL = 0x8,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 218) DEVICE_DESC_PARAM_DESC_ACCSS_ENBL = 0x9,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 219) DEVICE_DESC_PARAM_INIT_PWR_MODE = 0xA,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 220) DEVICE_DESC_PARAM_HIGH_PR_LUN = 0xB,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 221) DEVICE_DESC_PARAM_SEC_RMV_TYPE = 0xC,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 222) DEVICE_DESC_PARAM_SEC_LU = 0xD,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 223) DEVICE_DESC_PARAM_BKOP_TERM_LT = 0xE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 224) DEVICE_DESC_PARAM_ACTVE_ICC_LVL = 0xF,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 225) DEVICE_DESC_PARAM_SPEC_VER = 0x10,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 226) DEVICE_DESC_PARAM_MANF_DATE = 0x12,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 227) DEVICE_DESC_PARAM_MANF_NAME = 0x14,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 228) DEVICE_DESC_PARAM_PRDCT_NAME = 0x15,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 229) DEVICE_DESC_PARAM_SN = 0x16,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 230) DEVICE_DESC_PARAM_OEM_ID = 0x17,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 231) DEVICE_DESC_PARAM_MANF_ID = 0x18,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 232) DEVICE_DESC_PARAM_UD_OFFSET = 0x1A,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 233) DEVICE_DESC_PARAM_UD_LEN = 0x1B,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 234) DEVICE_DESC_PARAM_RTT_CAP = 0x1C,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 235) DEVICE_DESC_PARAM_FRQ_RTC = 0x1D,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 236) DEVICE_DESC_PARAM_UFS_FEAT = 0x1F,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 237) DEVICE_DESC_PARAM_FFU_TMT = 0x20,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 238) DEVICE_DESC_PARAM_Q_DPTH = 0x21,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 239) DEVICE_DESC_PARAM_DEV_VER = 0x22,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 240) DEVICE_DESC_PARAM_NUM_SEC_WPA = 0x24,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 241) DEVICE_DESC_PARAM_PSA_MAX_DATA = 0x25,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 242) DEVICE_DESC_PARAM_PSA_TMT = 0x29,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 243) DEVICE_DESC_PARAM_PRDCT_REV = 0x2A,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 244) DEVICE_DESC_PARAM_HPB_VER = 0x40,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 245) DEVICE_DESC_PARAM_HPB_CONTROL = 0x42,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 246) DEVICE_DESC_PARAM_EXT_UFS_FEATURE_SUP = 0x4F,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 247) DEVICE_DESC_PARAM_WB_PRESRV_USRSPC_EN = 0x53,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 248) DEVICE_DESC_PARAM_WB_TYPE = 0x54,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 249) DEVICE_DESC_PARAM_WB_SHARED_ALLOC_UNITS = 0x55,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 250) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 251)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 252) /* Interconnect descriptor parameters offsets in bytes*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 253) enum interconnect_desc_param {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 254) INTERCONNECT_DESC_PARAM_LEN = 0x0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 255) INTERCONNECT_DESC_PARAM_TYPE = 0x1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 256) INTERCONNECT_DESC_PARAM_UNIPRO_VER = 0x2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 257) INTERCONNECT_DESC_PARAM_MPHY_VER = 0x4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 258) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 259)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 260) /* Geometry descriptor parameters offsets in bytes*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 261) enum geometry_desc_param {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 262) GEOMETRY_DESC_PARAM_LEN = 0x0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 263) GEOMETRY_DESC_PARAM_TYPE = 0x1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 264) GEOMETRY_DESC_PARAM_DEV_CAP = 0x4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 265) GEOMETRY_DESC_PARAM_MAX_NUM_LUN = 0xC,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 266) GEOMETRY_DESC_PARAM_SEG_SIZE = 0xD,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 267) GEOMETRY_DESC_PARAM_ALLOC_UNIT_SIZE = 0x11,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 268) GEOMETRY_DESC_PARAM_MIN_BLK_SIZE = 0x12,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 269) GEOMETRY_DESC_PARAM_OPT_RD_BLK_SIZE = 0x13,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 270) GEOMETRY_DESC_PARAM_OPT_WR_BLK_SIZE = 0x14,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 271) GEOMETRY_DESC_PARAM_MAX_IN_BUF_SIZE = 0x15,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 272) GEOMETRY_DESC_PARAM_MAX_OUT_BUF_SIZE = 0x16,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 273) GEOMETRY_DESC_PARAM_RPMB_RW_SIZE = 0x17,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 274) GEOMETRY_DESC_PARAM_DYN_CAP_RSRC_PLC = 0x18,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 275) GEOMETRY_DESC_PARAM_DATA_ORDER = 0x19,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 276) GEOMETRY_DESC_PARAM_MAX_NUM_CTX = 0x1A,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 277) GEOMETRY_DESC_PARAM_TAG_UNIT_SIZE = 0x1B,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 278) GEOMETRY_DESC_PARAM_TAG_RSRC_SIZE = 0x1C,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 279) GEOMETRY_DESC_PARAM_SEC_RM_TYPES = 0x1D,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 280) GEOMETRY_DESC_PARAM_MEM_TYPES = 0x1E,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 281) GEOMETRY_DESC_PARAM_SCM_MAX_NUM_UNITS = 0x20,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 282) GEOMETRY_DESC_PARAM_SCM_CAP_ADJ_FCTR = 0x24,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 283) GEOMETRY_DESC_PARAM_NPM_MAX_NUM_UNITS = 0x26,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 284) GEOMETRY_DESC_PARAM_NPM_CAP_ADJ_FCTR = 0x2A,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 285) GEOMETRY_DESC_PARAM_ENM1_MAX_NUM_UNITS = 0x2C,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 286) GEOMETRY_DESC_PARAM_ENM1_CAP_ADJ_FCTR = 0x30,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 287) GEOMETRY_DESC_PARAM_ENM2_MAX_NUM_UNITS = 0x32,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 288) GEOMETRY_DESC_PARAM_ENM2_CAP_ADJ_FCTR = 0x36,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 289) GEOMETRY_DESC_PARAM_ENM3_MAX_NUM_UNITS = 0x38,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 290) GEOMETRY_DESC_PARAM_ENM3_CAP_ADJ_FCTR = 0x3C,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 291) GEOMETRY_DESC_PARAM_ENM4_MAX_NUM_UNITS = 0x3E,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 292) GEOMETRY_DESC_PARAM_ENM4_CAP_ADJ_FCTR = 0x42,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 293) GEOMETRY_DESC_PARAM_OPT_LOG_BLK_SIZE = 0x44,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 294) GEOMETRY_DESC_PARAM_HPB_REGION_SIZE = 0x48,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 295) GEOMETRY_DESC_PARAM_HPB_NUMBER_LU = 0x49,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 296) GEOMETRY_DESC_PARAM_HPB_SUBREGION_SIZE = 0x4A,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 297) GEOMETRY_DESC_PARAM_HPB_MAX_ACTIVE_REGS = 0x4B,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 298) GEOMETRY_DESC_PARAM_WB_MAX_ALLOC_UNITS = 0x4F,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 299) GEOMETRY_DESC_PARAM_WB_MAX_WB_LUNS = 0x53,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 300) GEOMETRY_DESC_PARAM_WB_BUFF_CAP_ADJ = 0x54,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 301) GEOMETRY_DESC_PARAM_WB_SUP_RED_TYPE = 0x55,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 302) GEOMETRY_DESC_PARAM_WB_SUP_WB_TYPE = 0x56,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 303) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 304)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 305) /* Health descriptor parameters offsets in bytes*/
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 306) enum health_desc_param {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 307) HEALTH_DESC_PARAM_LEN = 0x0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 308) HEALTH_DESC_PARAM_TYPE = 0x1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 309) HEALTH_DESC_PARAM_EOL_INFO = 0x2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 310) HEALTH_DESC_PARAM_LIFE_TIME_EST_A = 0x3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 311) HEALTH_DESC_PARAM_LIFE_TIME_EST_B = 0x4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 312) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 313)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 314) /* WriteBooster buffer mode */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 315) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 316) WB_BUF_MODE_LU_DEDICATED = 0x0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 317) WB_BUF_MODE_SHARED = 0x1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 318) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 319)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 320) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 321) * Logical Unit Write Protect
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 322) * 00h: LU not write protected
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 323) * 01h: LU write protected when fPowerOnWPEn =1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 324) * 02h: LU permanently write protected when fPermanentWPEn =1
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 325) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 326) enum ufs_lu_wp_type {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 327) UFS_LU_NO_WP = 0x00,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 328) UFS_LU_POWER_ON_WP = 0x01,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 329) UFS_LU_PERM_WP = 0x02,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 330) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 331)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 332) /* bActiveICCLevel parameter current units */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 333) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 334) UFSHCD_NANO_AMP = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 335) UFSHCD_MICRO_AMP = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 336) UFSHCD_MILI_AMP = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 337) UFSHCD_AMP = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 338) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 339)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 340) /* Possible values for dExtendedUFSFeaturesSupport */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 341) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 342) UFS_DEV_HPB_SUPPORT = BIT(7),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 343) UFS_DEV_WRITE_BOOSTER_SUP = BIT(8),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 344) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 345) #define UFS_DEV_HPB_SUPPORT_VERSION 0x310
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 346)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 347) #define POWER_DESC_MAX_SIZE 0x62
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 348) #define POWER_DESC_MAX_ACTV_ICC_LVLS 16
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 349)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 350) /* Attribute bActiveICCLevel parameter bit masks definitions */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 351) #define ATTR_ICC_LVL_UNIT_OFFSET 14
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 352) #define ATTR_ICC_LVL_UNIT_MASK (0x3 << ATTR_ICC_LVL_UNIT_OFFSET)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 353) #define ATTR_ICC_LVL_VALUE_MASK 0x3FF
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 354)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 355) /* Power descriptor parameters offsets in bytes */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 356) enum power_desc_param_offset {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 357) PWR_DESC_LEN = 0x0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 358) PWR_DESC_TYPE = 0x1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 359) PWR_DESC_ACTIVE_LVLS_VCC_0 = 0x2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 360) PWR_DESC_ACTIVE_LVLS_VCCQ_0 = 0x22,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 361) PWR_DESC_ACTIVE_LVLS_VCCQ2_0 = 0x42,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 362) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 363)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 364) /* Exception event mask values */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 365) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 366) MASK_EE_STATUS = 0xFFFF,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 367) MASK_EE_URGENT_BKOPS = (1 << 2),
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 368) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 369)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 370) /* Background operation status */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 371) enum bkops_status {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 372) BKOPS_STATUS_NO_OP = 0x0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 373) BKOPS_STATUS_NON_CRITICAL = 0x1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 374) BKOPS_STATUS_PERF_IMPACT = 0x2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 375) BKOPS_STATUS_CRITICAL = 0x3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 376) BKOPS_STATUS_MAX = BKOPS_STATUS_CRITICAL,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 377) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 378)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 379) /* UTP QUERY Transaction Specific Fields OpCode */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 380) enum query_opcode {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 381) UPIU_QUERY_OPCODE_NOP = 0x0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 382) UPIU_QUERY_OPCODE_READ_DESC = 0x1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 383) UPIU_QUERY_OPCODE_WRITE_DESC = 0x2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 384) UPIU_QUERY_OPCODE_READ_ATTR = 0x3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 385) UPIU_QUERY_OPCODE_WRITE_ATTR = 0x4,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 386) UPIU_QUERY_OPCODE_READ_FLAG = 0x5,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 387) UPIU_QUERY_OPCODE_SET_FLAG = 0x6,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 388) UPIU_QUERY_OPCODE_CLEAR_FLAG = 0x7,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 389) UPIU_QUERY_OPCODE_TOGGLE_FLAG = 0x8,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 390) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 391)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 392) /* bRefClkFreq attribute values */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 393) enum ufs_ref_clk_freq {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 394) REF_CLK_FREQ_19_2_MHZ = 0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 395) REF_CLK_FREQ_26_MHZ = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 396) REF_CLK_FREQ_38_4_MHZ = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 397) REF_CLK_FREQ_52_MHZ = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 398) REF_CLK_FREQ_INVAL = -1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 399) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 400)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 401) struct ufs_ref_clk {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 402) unsigned long freq_hz;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 403) enum ufs_ref_clk_freq val;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 404) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 405)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 406) /* Query response result code */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 407) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 408) QUERY_RESULT_SUCCESS = 0x00,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 409) QUERY_RESULT_NOT_READABLE = 0xF6,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 410) QUERY_RESULT_NOT_WRITEABLE = 0xF7,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 411) QUERY_RESULT_ALREADY_WRITTEN = 0xF8,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 412) QUERY_RESULT_INVALID_LENGTH = 0xF9,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 413) QUERY_RESULT_INVALID_VALUE = 0xFA,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 414) QUERY_RESULT_INVALID_SELECTOR = 0xFB,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 415) QUERY_RESULT_INVALID_INDEX = 0xFC,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 416) QUERY_RESULT_INVALID_IDN = 0xFD,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 417) QUERY_RESULT_INVALID_OPCODE = 0xFE,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 418) QUERY_RESULT_GENERAL_FAILURE = 0xFF,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 419) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 420)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 421) /* UTP Transfer Request Command Type (CT) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 422) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 423) UPIU_COMMAND_SET_TYPE_SCSI = 0x0,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 424) UPIU_COMMAND_SET_TYPE_UFS = 0x1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 425) UPIU_COMMAND_SET_TYPE_QUERY = 0x2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 426) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 427)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 428) /* UTP Transfer Request Command Offset */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 429) #define UPIU_COMMAND_TYPE_OFFSET 28
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 430)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 431) /* Offset of the response code in the UPIU header */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 432) #define UPIU_RSP_CODE_OFFSET 8
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 433)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 434) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 435) MASK_SCSI_STATUS = 0xFF,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 436) MASK_TASK_RESPONSE = 0xFF00,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 437) MASK_RSP_UPIU_RESULT = 0xFFFF,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 438) MASK_QUERY_DATA_SEG_LEN = 0xFFFF,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 439) MASK_RSP_UPIU_DATA_SEG_LEN = 0xFFFF,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 440) MASK_RSP_EXCEPTION_EVENT = 0x10000,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 441) MASK_TM_SERVICE_RESP = 0xFF,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 442) MASK_TM_FUNC = 0xFF,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 443) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 444)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 445) /* Task management service response */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 446) enum {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 447) UPIU_TASK_MANAGEMENT_FUNC_COMPL = 0x00,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 448) UPIU_TASK_MANAGEMENT_FUNC_NOT_SUPPORTED = 0x04,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 449) UPIU_TASK_MANAGEMENT_FUNC_SUCCEEDED = 0x08,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 450) UPIU_TASK_MANAGEMENT_FUNC_FAILED = 0x05,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 451) UPIU_INCORRECT_LOGICAL_UNIT_NO = 0x09,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 452) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 453)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 454) /* UFS device power modes */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 455) enum ufs_dev_pwr_mode {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 456) UFS_ACTIVE_PWR_MODE = 1,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 457) UFS_SLEEP_PWR_MODE = 2,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 458) UFS_POWERDOWN_PWR_MODE = 3,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 459) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 460)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 461) #define UFS_WB_BUF_REMAIN_PERCENT(val) ((val) / 10)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 462)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 463) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 464) * struct utp_cmd_rsp - Response UPIU structure
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 465) * @residual_transfer_count: Residual transfer count DW-3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 466) * @reserved: Reserved double words DW-4 to DW-7
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 467) * @sense_data_len: Sense data length DW-8 U16
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 468) * @sense_data: Sense data field DW-8 to DW-12
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 469) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 470) struct utp_cmd_rsp {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 471) __be32 residual_transfer_count;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 472) __be32 reserved[4];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 473) __be16 sense_data_len;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 474) u8 sense_data[UFS_SENSE_SIZE];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 475) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 476)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 477) struct ufshpb_active_field {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 478) __be16 active_rgn;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 479) __be16 active_srgn;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 480) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 481) #define HPB_ACT_FIELD_SIZE 4
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 482)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 483) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 484) * struct utp_hpb_rsp - Response UPIU structure
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 485) * @residual_transfer_count: Residual transfer count DW-3
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 486) * @reserved1: Reserved double words DW-4 to DW-7
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 487) * @sense_data_len: Sense data length DW-8 U16
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 488) * @desc_type: Descriptor type of sense data
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 489) * @additional_len: Additional length of sense data
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 490) * @hpb_op: HPB operation type
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 491) * @lun: LUN of response UPIU
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 492) * @active_rgn_cnt: Active region count
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 493) * @inactive_rgn_cnt: Inactive region count
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 494) * @hpb_active_field: Recommended to read HPB region and subregion
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 495) * @hpb_inactive_field: To be inactivated HPB region and subregion
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 496) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 497) struct utp_hpb_rsp {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 498) __be32 residual_transfer_count;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 499) __be32 reserved1[4];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 500) __be16 sense_data_len;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 501) u8 desc_type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 502) u8 additional_len;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 503) u8 hpb_op;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 504) u8 lun;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 505) u8 active_rgn_cnt;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 506) u8 inactive_rgn_cnt;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 507) struct ufshpb_active_field hpb_active_field[2];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 508) __be16 hpb_inactive_field[2];
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 509) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 510) #define UTP_HPB_RSP_SIZE 40
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 511)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 512) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 513) * struct utp_upiu_rsp - general upiu response structure
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 514) * @header: UPIU header structure DW-0 to DW-2
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 515) * @sr: fields structure for scsi command DW-3 to DW-12
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 516) * @qr: fields structure for query request DW-3 to DW-7
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 517) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 518) struct utp_upiu_rsp {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 519) struct utp_upiu_header header;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 520) union {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 521) struct utp_cmd_rsp sr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 522) struct utp_hpb_rsp hr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 523) struct utp_upiu_query qr;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 524) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 525) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 526)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 527) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 528) * struct ufs_query_req - parameters for building a query request
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 529) * @query_func: UPIU header query function
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 530) * @upiu_req: the query request data
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 531) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 532) struct ufs_query_req {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 533) u8 query_func;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 534) struct utp_upiu_query upiu_req;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 535) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 536)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 537) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 538) * struct ufs_query_resp - UPIU QUERY
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 539) * @response: device response code
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 540) * @upiu_res: query response data
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 541) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 542) struct ufs_query_res {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 543) u8 response;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 544) struct utp_upiu_query upiu_res;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 545) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 546)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 547) #define UFS_VREG_VCC_MIN_UV 2700000 /* uV */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 548) #define UFS_VREG_VCC_MAX_UV 3600000 /* uV */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 549) #define UFS_VREG_VCC_1P8_MIN_UV 1700000 /* uV */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 550) #define UFS_VREG_VCC_1P8_MAX_UV 1950000 /* uV */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 551) #define UFS_VREG_VCCQ_MIN_UV 1140000 /* uV */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 552) #define UFS_VREG_VCCQ_MAX_UV 1260000 /* uV */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 553) #define UFS_VREG_VCCQ2_MIN_UV 1700000 /* uV */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 554) #define UFS_VREG_VCCQ2_MAX_UV 1950000 /* uV */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 555)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 556) /*
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 557) * VCCQ & VCCQ2 current requirement when UFS device is in sleep state
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 558) * and link is in Hibern8 state.
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 559) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 560) #define UFS_VREG_LPM_LOAD_UA 1000 /* uA */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 561)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 562) struct ufs_vreg {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 563) struct regulator *reg;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 564) const char *name;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 565) bool always_on;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 566) bool enabled;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 567) int min_uV;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 568) int max_uV;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 569) int max_uA;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 570) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 571)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 572) struct ufs_vreg_info {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 573) struct ufs_vreg *vcc;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 574) struct ufs_vreg *vccq;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 575) struct ufs_vreg *vccq2;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 576) struct ufs_vreg *vdd_hba;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 577) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 578)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 579) struct ufs_dev_info {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 580) bool f_power_on_wp_en;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 581) /* Keeps information if any of the LU is power on write protected */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 582) bool is_lu_power_on_wp;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 583) /* Maximum number of general LU supported by the UFS device */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 584) u8 max_lu_supported;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 585) u8 wb_dedicated_lu;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 586) u16 wmanufacturerid;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 587) /*UFS device Product Name */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 588) u8 *model;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 589) u16 wspecversion;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 590) u32 clk_gating_wait_us;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 591) u32 d_ext_ufs_feature_sup;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 592) u8 b_wb_buffer_type;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 593) u32 d_wb_alloc_units;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 594) bool b_rpm_dev_flush_capable;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 595) u8 b_presrv_uspc_en;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 596) /* UFS HPB related flag */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 597) bool hpb_enabled;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 598) ANDROID_KABI_RESERVE(1);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 599) };
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 600)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 601) /**
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 602) * ufs_is_valid_unit_desc_lun - checks if the given LUN has a unit descriptor
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 603) * @dev_info: pointer of instance of struct ufs_dev_info
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 604) * @lun: LU number to check
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 605) * @return: true if the lun has a matching unit descriptor, false otherwise
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 606) */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 607) static inline bool ufs_is_valid_unit_desc_lun(struct ufs_dev_info *dev_info,
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 608) u8 lun, u8 param_offset)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 609) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 610) if (!dev_info || !dev_info->max_lu_supported) {
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 611) pr_err("Max General LU supported by UFS isn't initialized\n");
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 612) return false;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 613) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 614) /* WB is available only for the logical unit from 0 to 7 */
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 615) if (param_offset == UNIT_DESC_PARAM_WB_BUF_ALLOC_UNITS)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 616) return lun < UFS_UPIU_MAX_WB_LUN_ID;
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 617) return lun == UFS_UPIU_RPMB_WLUN || (lun < dev_info->max_lu_supported);
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 618) }
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 619)
^8f3ce5b39 (kx 2023-10-28 12:00:06 +0300 620) #endif /* End of Header */
Orange Pi5 kernel
Deprecated Linux kernel 5.10.110 for OrangePi 5/5B/5+ boards
3 Commits
0 Branches
0 Tags