mirror of
https://github.com/torvalds/linux.git
synced 2024-12-03 01:21:28 +00:00
0c60eb0cc3
If the user sets use_mcq_mode to 0, the host will try to activate the LSDB mode unconditionally even when the LSDBS of device HCI cap is 1. This makes commands time out and causes device probing to fail. To prevent that problem, check the LSDBS cap when MCQ is not supported. Signed-off-by: Kyoungrul Kim <k831.kim@samsung.com> Link: https://lore.kernel.org/r/20240709232520epcms2p8ebdb5c4fccc30a6221390566589bf122@epcms2p8 Reviewed-by: Bart Van Assche <bvanassche@acm.org> Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
608 lines
15 KiB
C
608 lines
15 KiB
C
/* SPDX-License-Identifier: GPL-2.0-or-later */
|
|
/*
|
|
* Universal Flash Storage Host controller driver
|
|
* Copyright (C) 2011-2013 Samsung India Software Operations
|
|
*
|
|
* Authors:
|
|
* Santosh Yaraganavi <santosh.sy@samsung.com>
|
|
* Vinayak Holikatti <h.vinayak@samsung.com>
|
|
*/
|
|
|
|
#ifndef _UFSHCI_H
|
|
#define _UFSHCI_H
|
|
|
|
#include <linux/types.h>
|
|
#include <ufs/ufs.h>
|
|
|
|
enum {
|
|
TASK_REQ_UPIU_SIZE_DWORDS = 8,
|
|
TASK_RSP_UPIU_SIZE_DWORDS = 8,
|
|
ALIGNED_UPIU_SIZE = 512,
|
|
};
|
|
|
|
/* UFSHCI Registers */
|
|
enum {
|
|
REG_CONTROLLER_CAPABILITIES = 0x00,
|
|
REG_MCQCAP = 0x04,
|
|
REG_UFS_VERSION = 0x08,
|
|
REG_CONTROLLER_DEV_ID = 0x10,
|
|
REG_CONTROLLER_PROD_ID = 0x14,
|
|
REG_AUTO_HIBERNATE_IDLE_TIMER = 0x18,
|
|
REG_INTERRUPT_STATUS = 0x20,
|
|
REG_INTERRUPT_ENABLE = 0x24,
|
|
REG_CONTROLLER_STATUS = 0x30,
|
|
REG_CONTROLLER_ENABLE = 0x34,
|
|
REG_UIC_ERROR_CODE_PHY_ADAPTER_LAYER = 0x38,
|
|
REG_UIC_ERROR_CODE_DATA_LINK_LAYER = 0x3C,
|
|
REG_UIC_ERROR_CODE_NETWORK_LAYER = 0x40,
|
|
REG_UIC_ERROR_CODE_TRANSPORT_LAYER = 0x44,
|
|
REG_UIC_ERROR_CODE_DME = 0x48,
|
|
REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL = 0x4C,
|
|
REG_UTP_TRANSFER_REQ_LIST_BASE_L = 0x50,
|
|
REG_UTP_TRANSFER_REQ_LIST_BASE_H = 0x54,
|
|
REG_UTP_TRANSFER_REQ_DOOR_BELL = 0x58,
|
|
REG_UTP_TRANSFER_REQ_LIST_CLEAR = 0x5C,
|
|
REG_UTP_TRANSFER_REQ_LIST_RUN_STOP = 0x60,
|
|
REG_UTP_TASK_REQ_LIST_BASE_L = 0x70,
|
|
REG_UTP_TASK_REQ_LIST_BASE_H = 0x74,
|
|
REG_UTP_TASK_REQ_DOOR_BELL = 0x78,
|
|
REG_UTP_TASK_REQ_LIST_CLEAR = 0x7C,
|
|
REG_UTP_TASK_REQ_LIST_RUN_STOP = 0x80,
|
|
REG_UIC_COMMAND = 0x90,
|
|
REG_UIC_COMMAND_ARG_1 = 0x94,
|
|
REG_UIC_COMMAND_ARG_2 = 0x98,
|
|
REG_UIC_COMMAND_ARG_3 = 0x9C,
|
|
|
|
UFSHCI_REG_SPACE_SIZE = 0xA0,
|
|
|
|
REG_UFS_CCAP = 0x100,
|
|
REG_UFS_CRYPTOCAP = 0x104,
|
|
|
|
REG_UFS_MEM_CFG = 0x300,
|
|
REG_UFS_MCQ_CFG = 0x380,
|
|
REG_UFS_ESILBA = 0x384,
|
|
REG_UFS_ESIUBA = 0x388,
|
|
UFSHCI_CRYPTO_REG_SPACE_SIZE = 0x400,
|
|
};
|
|
|
|
/* Controller capability masks */
|
|
enum {
|
|
MASK_TRANSFER_REQUESTS_SLOTS_SDB = 0x0000001F,
|
|
MASK_TRANSFER_REQUESTS_SLOTS_MCQ = 0x000000FF,
|
|
MASK_NUMBER_OUTSTANDING_RTT = 0x0000FF00,
|
|
MASK_TASK_MANAGEMENT_REQUEST_SLOTS = 0x00070000,
|
|
MASK_EHSLUTRD_SUPPORTED = 0x00400000,
|
|
MASK_AUTO_HIBERN8_SUPPORT = 0x00800000,
|
|
MASK_64_ADDRESSING_SUPPORT = 0x01000000,
|
|
MASK_OUT_OF_ORDER_DATA_DELIVERY_SUPPORT = 0x02000000,
|
|
MASK_UIC_DME_TEST_MODE_SUPPORT = 0x04000000,
|
|
MASK_CRYPTO_SUPPORT = 0x10000000,
|
|
MASK_LSDB_SUPPORT = 0x20000000,
|
|
MASK_MCQ_SUPPORT = 0x40000000,
|
|
};
|
|
|
|
/* MCQ capability mask */
|
|
enum {
|
|
MASK_EXT_IID_SUPPORT = 0x00000400,
|
|
};
|
|
|
|
enum {
|
|
REG_SQATTR = 0x0,
|
|
REG_SQLBA = 0x4,
|
|
REG_SQUBA = 0x8,
|
|
REG_SQDAO = 0xC,
|
|
REG_SQISAO = 0x10,
|
|
|
|
REG_CQATTR = 0x20,
|
|
REG_CQLBA = 0x24,
|
|
REG_CQUBA = 0x28,
|
|
REG_CQDAO = 0x2C,
|
|
REG_CQISAO = 0x30,
|
|
};
|
|
|
|
enum {
|
|
REG_SQHP = 0x0,
|
|
REG_SQTP = 0x4,
|
|
REG_SQRTC = 0x8,
|
|
REG_SQCTI = 0xC,
|
|
REG_SQRTS = 0x10,
|
|
};
|
|
|
|
enum {
|
|
REG_CQHP = 0x0,
|
|
REG_CQTP = 0x4,
|
|
};
|
|
|
|
enum {
|
|
REG_CQIS = 0x0,
|
|
REG_CQIE = 0x4,
|
|
};
|
|
|
|
enum {
|
|
SQ_START = 0x0,
|
|
SQ_STOP = 0x1,
|
|
SQ_ICU = 0x2,
|
|
};
|
|
|
|
enum {
|
|
SQ_STS = 0x1,
|
|
SQ_CUS = 0x2,
|
|
};
|
|
|
|
#define SQ_ICU_ERR_CODE_MASK GENMASK(7, 4)
|
|
#define UFS_MASK(mask, offset) ((mask) << (offset))
|
|
|
|
/* UFS Version 08h */
|
|
#define MINOR_VERSION_NUM_MASK UFS_MASK(0xFFFF, 0)
|
|
#define MAJOR_VERSION_NUM_MASK UFS_MASK(0xFFFF, 16)
|
|
|
|
#define UFSHCD_NUM_RESERVED 1
|
|
/*
|
|
* Controller UFSHCI version
|
|
* - 2.x and newer use the following scheme:
|
|
* major << 8 + minor << 4
|
|
* - 1.x has been converted to match this in
|
|
* ufshcd_get_ufs_version()
|
|
*/
|
|
static inline u32 ufshci_version(u32 major, u32 minor)
|
|
{
|
|
return (major << 8) + (minor << 4);
|
|
}
|
|
|
|
/*
|
|
* HCDDID - Host Controller Identification Descriptor
|
|
* - Device ID and Device Class 10h
|
|
*/
|
|
#define DEVICE_CLASS UFS_MASK(0xFFFF, 0)
|
|
#define DEVICE_ID UFS_MASK(0xFF, 24)
|
|
|
|
/*
|
|
* HCPMID - Host Controller Identification Descriptor
|
|
* - Product/Manufacturer ID 14h
|
|
*/
|
|
#define MANUFACTURE_ID_MASK UFS_MASK(0xFFFF, 0)
|
|
#define PRODUCT_ID_MASK UFS_MASK(0xFFFF, 16)
|
|
|
|
/* AHIT - Auto-Hibernate Idle Timer */
|
|
#define UFSHCI_AHIBERN8_TIMER_MASK GENMASK(9, 0)
|
|
#define UFSHCI_AHIBERN8_SCALE_MASK GENMASK(12, 10)
|
|
#define UFSHCI_AHIBERN8_SCALE_FACTOR 10
|
|
#define UFSHCI_AHIBERN8_MAX (1023 * 100000)
|
|
|
|
/*
|
|
* IS - Interrupt Status - 20h
|
|
*/
|
|
#define UTP_TRANSFER_REQ_COMPL 0x1
|
|
#define UIC_DME_END_PT_RESET 0x2
|
|
#define UIC_ERROR 0x4
|
|
#define UIC_TEST_MODE 0x8
|
|
#define UIC_POWER_MODE 0x10
|
|
#define UIC_HIBERNATE_EXIT 0x20
|
|
#define UIC_HIBERNATE_ENTER 0x40
|
|
#define UIC_LINK_LOST 0x80
|
|
#define UIC_LINK_STARTUP 0x100
|
|
#define UTP_TASK_REQ_COMPL 0x200
|
|
#define UIC_COMMAND_COMPL 0x400
|
|
#define DEVICE_FATAL_ERROR 0x800
|
|
#define CONTROLLER_FATAL_ERROR 0x10000
|
|
#define SYSTEM_BUS_FATAL_ERROR 0x20000
|
|
#define CRYPTO_ENGINE_FATAL_ERROR 0x40000
|
|
#define MCQ_CQ_EVENT_STATUS 0x100000
|
|
|
|
#define UFSHCD_UIC_HIBERN8_MASK (UIC_HIBERNATE_ENTER |\
|
|
UIC_HIBERNATE_EXIT)
|
|
|
|
#define UFSHCD_UIC_PWR_MASK (UFSHCD_UIC_HIBERN8_MASK |\
|
|
UIC_POWER_MODE)
|
|
|
|
#define UFSHCD_UIC_MASK (UIC_COMMAND_COMPL | UFSHCD_UIC_PWR_MASK)
|
|
|
|
#define UFSHCD_ERROR_MASK (UIC_ERROR | INT_FATAL_ERRORS)
|
|
|
|
#define INT_FATAL_ERRORS (DEVICE_FATAL_ERROR |\
|
|
CONTROLLER_FATAL_ERROR |\
|
|
SYSTEM_BUS_FATAL_ERROR |\
|
|
CRYPTO_ENGINE_FATAL_ERROR |\
|
|
UIC_LINK_LOST)
|
|
|
|
/* HCS - Host Controller Status 30h */
|
|
#define DEVICE_PRESENT 0x1
|
|
#define UTP_TRANSFER_REQ_LIST_READY 0x2
|
|
#define UTP_TASK_REQ_LIST_READY 0x4
|
|
#define UIC_COMMAND_READY 0x8
|
|
#define HOST_ERROR_INDICATOR 0x10
|
|
#define DEVICE_ERROR_INDICATOR 0x20
|
|
#define UIC_POWER_MODE_CHANGE_REQ_STATUS_MASK UFS_MASK(0x7, 8)
|
|
|
|
#define UFSHCD_STATUS_READY (UTP_TRANSFER_REQ_LIST_READY |\
|
|
UTP_TASK_REQ_LIST_READY |\
|
|
UIC_COMMAND_READY)
|
|
|
|
enum {
|
|
PWR_OK = 0x0,
|
|
PWR_LOCAL = 0x01,
|
|
PWR_REMOTE = 0x02,
|
|
PWR_BUSY = 0x03,
|
|
PWR_ERROR_CAP = 0x04,
|
|
PWR_FATAL_ERROR = 0x05,
|
|
};
|
|
|
|
/* HCE - Host Controller Enable 34h */
|
|
#define CONTROLLER_ENABLE 0x1
|
|
#define CONTROLLER_DISABLE 0x0
|
|
#define CRYPTO_GENERAL_ENABLE 0x2
|
|
|
|
/* UECPA - Host UIC Error Code PHY Adapter Layer 38h */
|
|
#define UIC_PHY_ADAPTER_LAYER_ERROR 0x80000000
|
|
#define UIC_PHY_ADAPTER_LAYER_ERROR_CODE_MASK 0x1F
|
|
#define UIC_PHY_ADAPTER_LAYER_LANE_ERR_MASK 0xF
|
|
#define UIC_PHY_ADAPTER_LAYER_GENERIC_ERROR 0x10
|
|
|
|
/* UECDL - Host UIC Error Code Data Link Layer 3Ch */
|
|
#define UIC_DATA_LINK_LAYER_ERROR 0x80000000
|
|
#define UIC_DATA_LINK_LAYER_ERROR_CODE_MASK 0xFFFF
|
|
#define UIC_DATA_LINK_LAYER_ERROR_TCX_REP_TIMER_EXP 0x2
|
|
#define UIC_DATA_LINK_LAYER_ERROR_AFCX_REQ_TIMER_EXP 0x4
|
|
#define UIC_DATA_LINK_LAYER_ERROR_FCX_PRO_TIMER_EXP 0x8
|
|
#define UIC_DATA_LINK_LAYER_ERROR_RX_BUF_OF 0x20
|
|
#define UIC_DATA_LINK_LAYER_ERROR_PA_INIT 0x2000
|
|
#define UIC_DATA_LINK_LAYER_ERROR_NAC_RECEIVED 0x0001
|
|
#define UIC_DATA_LINK_LAYER_ERROR_TCx_REPLAY_TIMEOUT 0x0002
|
|
|
|
/* UECN - Host UIC Error Code Network Layer 40h */
|
|
#define UIC_NETWORK_LAYER_ERROR 0x80000000
|
|
#define UIC_NETWORK_LAYER_ERROR_CODE_MASK 0x7
|
|
#define UIC_NETWORK_UNSUPPORTED_HEADER_TYPE 0x1
|
|
#define UIC_NETWORK_BAD_DEVICEID_ENC 0x2
|
|
#define UIC_NETWORK_LHDR_TRAP_PACKET_DROPPING 0x4
|
|
|
|
/* UECT - Host UIC Error Code Transport Layer 44h */
|
|
#define UIC_TRANSPORT_LAYER_ERROR 0x80000000
|
|
#define UIC_TRANSPORT_LAYER_ERROR_CODE_MASK 0x7F
|
|
#define UIC_TRANSPORT_UNSUPPORTED_HEADER_TYPE 0x1
|
|
#define UIC_TRANSPORT_UNKNOWN_CPORTID 0x2
|
|
#define UIC_TRANSPORT_NO_CONNECTION_RX 0x4
|
|
#define UIC_TRANSPORT_CONTROLLED_SEGMENT_DROPPING 0x8
|
|
#define UIC_TRANSPORT_BAD_TC 0x10
|
|
#define UIC_TRANSPORT_E2E_CREDIT_OVERFOW 0x20
|
|
#define UIC_TRANSPORT_SAFETY_VALUE_DROPPING 0x40
|
|
|
|
/* UECDME - Host UIC Error Code DME 48h */
|
|
#define UIC_DME_ERROR 0x80000000
|
|
#define UIC_DME_ERROR_CODE_MASK 0x1
|
|
|
|
/* UTRIACR - Interrupt Aggregation control register - 0x4Ch */
|
|
#define INT_AGGR_TIMEOUT_VAL_MASK 0xFF
|
|
#define INT_AGGR_COUNTER_THRESHOLD_MASK UFS_MASK(0x1F, 8)
|
|
#define INT_AGGR_COUNTER_AND_TIMER_RESET 0x10000
|
|
#define INT_AGGR_STATUS_BIT 0x100000
|
|
#define INT_AGGR_PARAM_WRITE 0x1000000
|
|
#define INT_AGGR_ENABLE 0x80000000
|
|
|
|
/* UTRLRSR - UTP Transfer Request Run-Stop Register 60h */
|
|
#define UTP_TRANSFER_REQ_LIST_RUN_STOP_BIT 0x1
|
|
|
|
/* UTMRLRSR - UTP Task Management Request Run-Stop Register 80h */
|
|
#define UTP_TASK_REQ_LIST_RUN_STOP_BIT 0x1
|
|
|
|
/* REG_UFS_MEM_CFG - Global Config Registers 300h */
|
|
#define MCQ_MODE_SELECT BIT(0)
|
|
|
|
/* CQISy - CQ y Interrupt Status Register */
|
|
#define UFSHCD_MCQ_CQIS_TAIL_ENT_PUSH_STS 0x1
|
|
|
|
/* UICCMD - UIC Command */
|
|
#define COMMAND_OPCODE_MASK 0xFF
|
|
#define GEN_SELECTOR_INDEX_MASK 0xFFFF
|
|
|
|
#define MIB_ATTRIBUTE_MASK UFS_MASK(0xFFFF, 16)
|
|
#define RESET_LEVEL 0xFF
|
|
|
|
#define ATTR_SET_TYPE_MASK UFS_MASK(0xFF, 16)
|
|
#define CONFIG_RESULT_CODE_MASK 0xFF
|
|
#define GENERIC_ERROR_CODE_MASK 0xFF
|
|
|
|
/* GenSelectorIndex calculation macros for M-PHY attributes */
|
|
#define UIC_ARG_MPHY_TX_GEN_SEL_INDEX(lane) (lane)
|
|
#define UIC_ARG_MPHY_RX_GEN_SEL_INDEX(lane) (PA_MAXDATALANES + (lane))
|
|
|
|
#define UIC_ARG_MIB_SEL(attr, sel) ((((attr) & 0xFFFF) << 16) |\
|
|
((sel) & 0xFFFF))
|
|
#define UIC_ARG_MIB(attr) UIC_ARG_MIB_SEL(attr, 0)
|
|
#define UIC_ARG_ATTR_TYPE(t) (((t) & 0xFF) << 16)
|
|
#define UIC_GET_ATTR_ID(v) (((v) >> 16) & 0xFFFF)
|
|
|
|
/* Link Status*/
|
|
enum link_status {
|
|
UFSHCD_LINK_IS_DOWN = 1,
|
|
UFSHCD_LINK_IS_UP = 2,
|
|
};
|
|
|
|
/* UIC Commands */
|
|
enum uic_cmd_dme {
|
|
UIC_CMD_DME_GET = 0x01,
|
|
UIC_CMD_DME_SET = 0x02,
|
|
UIC_CMD_DME_PEER_GET = 0x03,
|
|
UIC_CMD_DME_PEER_SET = 0x04,
|
|
UIC_CMD_DME_POWERON = 0x10,
|
|
UIC_CMD_DME_POWEROFF = 0x11,
|
|
UIC_CMD_DME_ENABLE = 0x12,
|
|
UIC_CMD_DME_RESET = 0x14,
|
|
UIC_CMD_DME_END_PT_RST = 0x15,
|
|
UIC_CMD_DME_LINK_STARTUP = 0x16,
|
|
UIC_CMD_DME_HIBER_ENTER = 0x17,
|
|
UIC_CMD_DME_HIBER_EXIT = 0x18,
|
|
UIC_CMD_DME_TEST_MODE = 0x1A,
|
|
};
|
|
|
|
/* UIC Config result code / Generic error code */
|
|
enum {
|
|
UIC_CMD_RESULT_SUCCESS = 0x00,
|
|
UIC_CMD_RESULT_INVALID_ATTR = 0x01,
|
|
UIC_CMD_RESULT_FAILURE = 0x01,
|
|
UIC_CMD_RESULT_INVALID_ATTR_VALUE = 0x02,
|
|
UIC_CMD_RESULT_READ_ONLY_ATTR = 0x03,
|
|
UIC_CMD_RESULT_WRITE_ONLY_ATTR = 0x04,
|
|
UIC_CMD_RESULT_BAD_INDEX = 0x05,
|
|
UIC_CMD_RESULT_LOCKED_ATTR = 0x06,
|
|
UIC_CMD_RESULT_BAD_TEST_FEATURE_INDEX = 0x07,
|
|
UIC_CMD_RESULT_PEER_COMM_FAILURE = 0x08,
|
|
UIC_CMD_RESULT_BUSY = 0x09,
|
|
UIC_CMD_RESULT_DME_FAILURE = 0x0A,
|
|
};
|
|
|
|
#define MASK_UIC_COMMAND_RESULT 0xFF
|
|
|
|
#define INT_AGGR_COUNTER_THLD_VAL(c) (((c) & 0x1F) << 8)
|
|
#define INT_AGGR_TIMEOUT_VAL(t) (((t) & 0xFF) << 0)
|
|
|
|
/* Interrupt disable masks */
|
|
enum {
|
|
/* Interrupt disable mask for UFSHCI v1.1 */
|
|
INTERRUPT_MASK_ALL_VER_11 = 0x31FFF,
|
|
|
|
/* Interrupt disable mask for UFSHCI v2.1 */
|
|
INTERRUPT_MASK_ALL_VER_21 = 0x71FFF,
|
|
};
|
|
|
|
/* CCAP - Crypto Capability 100h */
|
|
union ufs_crypto_capabilities {
|
|
__le32 reg_val;
|
|
struct {
|
|
u8 num_crypto_cap;
|
|
u8 config_count;
|
|
u8 reserved;
|
|
u8 config_array_ptr;
|
|
};
|
|
};
|
|
|
|
enum ufs_crypto_key_size {
|
|
UFS_CRYPTO_KEY_SIZE_INVALID = 0x0,
|
|
UFS_CRYPTO_KEY_SIZE_128 = 0x1,
|
|
UFS_CRYPTO_KEY_SIZE_192 = 0x2,
|
|
UFS_CRYPTO_KEY_SIZE_256 = 0x3,
|
|
UFS_CRYPTO_KEY_SIZE_512 = 0x4,
|
|
};
|
|
|
|
enum ufs_crypto_alg {
|
|
UFS_CRYPTO_ALG_AES_XTS = 0x0,
|
|
UFS_CRYPTO_ALG_BITLOCKER_AES_CBC = 0x1,
|
|
UFS_CRYPTO_ALG_AES_ECB = 0x2,
|
|
UFS_CRYPTO_ALG_ESSIV_AES_CBC = 0x3,
|
|
};
|
|
|
|
/* x-CRYPTOCAP - Crypto Capability X */
|
|
union ufs_crypto_cap_entry {
|
|
__le32 reg_val;
|
|
struct {
|
|
u8 algorithm_id;
|
|
u8 sdus_mask; /* Supported data unit size mask */
|
|
u8 key_size;
|
|
u8 reserved;
|
|
};
|
|
};
|
|
|
|
#define UFS_CRYPTO_CONFIGURATION_ENABLE (1 << 7)
|
|
#define UFS_CRYPTO_KEY_MAX_SIZE 64
|
|
/* x-CRYPTOCFG - Crypto Configuration X */
|
|
union ufs_crypto_cfg_entry {
|
|
__le32 reg_val[32];
|
|
struct {
|
|
u8 crypto_key[UFS_CRYPTO_KEY_MAX_SIZE];
|
|
u8 data_unit_size;
|
|
u8 crypto_cap_idx;
|
|
u8 reserved_1;
|
|
u8 config_enable;
|
|
u8 reserved_multi_host;
|
|
u8 reserved_2;
|
|
u8 vsb[2];
|
|
u8 reserved_3[56];
|
|
};
|
|
};
|
|
|
|
/*
|
|
* Request Descriptor Definitions
|
|
*/
|
|
|
|
/* To accommodate UFS2.0 required Command type */
|
|
enum {
|
|
UTP_CMD_TYPE_UFS_STORAGE = 0x1,
|
|
};
|
|
|
|
enum {
|
|
UTP_SCSI_COMMAND = 0x00000000,
|
|
UTP_NATIVE_UFS_COMMAND = 0x10000000,
|
|
UTP_DEVICE_MANAGEMENT_FUNCTION = 0x20000000,
|
|
};
|
|
|
|
/* UTP Transfer Request Data Direction (DD) */
|
|
enum utp_data_direction {
|
|
UTP_NO_DATA_TRANSFER = 0,
|
|
UTP_HOST_TO_DEVICE = 1,
|
|
UTP_DEVICE_TO_HOST = 2,
|
|
};
|
|
|
|
/* Overall command status values */
|
|
enum utp_ocs {
|
|
OCS_SUCCESS = 0x0,
|
|
OCS_INVALID_CMD_TABLE_ATTR = 0x1,
|
|
OCS_INVALID_PRDT_ATTR = 0x2,
|
|
OCS_MISMATCH_DATA_BUF_SIZE = 0x3,
|
|
OCS_MISMATCH_RESP_UPIU_SIZE = 0x4,
|
|
OCS_PEER_COMM_FAILURE = 0x5,
|
|
OCS_ABORTED = 0x6,
|
|
OCS_FATAL_ERROR = 0x7,
|
|
OCS_DEVICE_FATAL_ERROR = 0x8,
|
|
OCS_INVALID_CRYPTO_CONFIG = 0x9,
|
|
OCS_GENERAL_CRYPTO_ERROR = 0xA,
|
|
OCS_INVALID_COMMAND_STATUS = 0x0F,
|
|
};
|
|
|
|
enum {
|
|
MASK_OCS = 0x0F,
|
|
};
|
|
|
|
/* The maximum length of the data byte count field in the PRDT is 256KB */
|
|
#define PRDT_DATA_BYTE_COUNT_MAX SZ_256K
|
|
/* The granularity of the data byte count field in the PRDT is 32-bit */
|
|
#define PRDT_DATA_BYTE_COUNT_PAD 4
|
|
|
|
/**
|
|
* struct ufshcd_sg_entry - UFSHCI PRD Entry
|
|
* @addr: Physical address; DW-0 and DW-1.
|
|
* @reserved: Reserved for future use DW-2
|
|
* @size: size of physical segment DW-3
|
|
*/
|
|
struct ufshcd_sg_entry {
|
|
__le64 addr;
|
|
__le32 reserved;
|
|
__le32 size;
|
|
/*
|
|
* followed by variant-specific fields if
|
|
* CONFIG_SCSI_UFS_VARIABLE_SG_ENTRY_SIZE has been defined.
|
|
*/
|
|
};
|
|
|
|
/**
|
|
* struct utp_transfer_cmd_desc - UTP Command Descriptor (UCD)
|
|
* @command_upiu: Command UPIU Frame address
|
|
* @response_upiu: Response UPIU Frame address
|
|
* @prd_table: Physical Region Descriptor: an array of SG_ALL struct
|
|
* ufshcd_sg_entry's. Variant-specific fields may be present after each.
|
|
*/
|
|
struct utp_transfer_cmd_desc {
|
|
u8 command_upiu[ALIGNED_UPIU_SIZE];
|
|
u8 response_upiu[ALIGNED_UPIU_SIZE];
|
|
u8 prd_table[];
|
|
};
|
|
|
|
/**
|
|
* struct request_desc_header - Descriptor Header common to both UTRD and UTMRD
|
|
*/
|
|
struct request_desc_header {
|
|
u8 cci;
|
|
u8 ehs_length;
|
|
#if defined(__BIG_ENDIAN)
|
|
u8 enable_crypto:1;
|
|
u8 reserved2:7;
|
|
|
|
u8 command_type:4;
|
|
u8 reserved1:1;
|
|
u8 data_direction:2;
|
|
u8 interrupt:1;
|
|
#elif defined(__LITTLE_ENDIAN)
|
|
u8 reserved2:7;
|
|
u8 enable_crypto:1;
|
|
|
|
u8 interrupt:1;
|
|
u8 data_direction:2;
|
|
u8 reserved1:1;
|
|
u8 command_type:4;
|
|
#else
|
|
#error
|
|
#endif
|
|
|
|
__le32 dunl;
|
|
u8 ocs;
|
|
u8 cds;
|
|
__le16 ldbc;
|
|
__le32 dunu;
|
|
};
|
|
|
|
static_assert(sizeof(struct request_desc_header) == 16);
|
|
|
|
/**
|
|
* struct utp_transfer_req_desc - UTP Transfer Request Descriptor (UTRD)
|
|
* @header: UTRD header DW-0 to DW-3
|
|
* @command_desc_base_addr: UCD base address DW 4-5
|
|
* @response_upiu_length: response UPIU length DW-6
|
|
* @response_upiu_offset: response UPIU offset DW-6
|
|
* @prd_table_length: Physical region descriptor length DW-7
|
|
* @prd_table_offset: Physical region descriptor offset DW-7
|
|
*/
|
|
struct utp_transfer_req_desc {
|
|
|
|
/* DW 0-3 */
|
|
struct request_desc_header header;
|
|
|
|
/* DW 4-5*/
|
|
__le64 command_desc_base_addr;
|
|
|
|
/* DW 6 */
|
|
__le16 response_upiu_length;
|
|
__le16 response_upiu_offset;
|
|
|
|
/* DW 7 */
|
|
__le16 prd_table_length;
|
|
__le16 prd_table_offset;
|
|
};
|
|
|
|
/* MCQ Completion Queue Entry */
|
|
struct cq_entry {
|
|
/* DW 0-1 */
|
|
__le64 command_desc_base_addr;
|
|
|
|
/* DW 2 */
|
|
__le16 response_upiu_length;
|
|
__le16 response_upiu_offset;
|
|
|
|
/* DW 3 */
|
|
__le16 prd_table_length;
|
|
__le16 prd_table_offset;
|
|
|
|
/* DW 4 */
|
|
__le32 status;
|
|
|
|
/* DW 5-7 */
|
|
__le32 reserved[3];
|
|
};
|
|
|
|
static_assert(sizeof(struct cq_entry) == 32);
|
|
|
|
/*
|
|
* UTMRD structure.
|
|
*/
|
|
struct utp_task_req_desc {
|
|
/* DW 0-3 */
|
|
struct request_desc_header header;
|
|
|
|
/* DW 4-11 - Task request UPIU structure */
|
|
struct {
|
|
struct utp_upiu_header req_header;
|
|
__be32 input_param1;
|
|
__be32 input_param2;
|
|
__be32 input_param3;
|
|
__be32 __reserved1[2];
|
|
} upiu_req;
|
|
|
|
/* DW 12-19 - Task Management Response UPIU structure */
|
|
struct {
|
|
struct utp_upiu_header rsp_header;
|
|
__be32 output_param1;
|
|
__be32 output_param2;
|
|
__be32 __reserved2[3];
|
|
} upiu_rsp;
|
|
};
|
|
|
|
#endif /* End of Header */
|