1 /* SPDX-License-Identifier: GPL-2.0-or-later */ 2 /* 3 * Universal Flash Storage Host controller driver 4 * Copyright (C) 2011-2013 Samsung India Software Operations 5 * 6 * Authors: 7 * Santosh Yaraganavi <santosh.sy@samsung.com> 8 * Vinayak Holikatti <h.vinayak@samsung.com> 9 */ 10 11 #ifndef _UFSHCI_H 12 #define _UFSHCI_H 13 14 #include <linux/types.h> 15 #include <ufs/ufs.h> 16 17 enum { 18 TASK_REQ_UPIU_SIZE_DWORDS = 8, 19 TASK_RSP_UPIU_SIZE_DWORDS = 8, 20 ALIGNED_UPIU_SIZE = 512, 21 }; 22 23 /* UFSHCI Registers */ 24 enum { 25 REG_CONTROLLER_CAPABILITIES = 0x00, 26 REG_MCQCAP = 0x04, 27 REG_UFS_VERSION = 0x08, 28 REG_EXT_CONTROLLER_CAPABILITIES = 0x0C, 29 REG_CONTROLLER_PID = 0x10, 30 REG_CONTROLLER_MID = 0x14, 31 REG_AUTO_HIBERNATE_IDLE_TIMER = 0x18, 32 REG_INTERRUPT_STATUS = 0x20, 33 REG_INTERRUPT_ENABLE = 0x24, 34 REG_CONTROLLER_STATUS = 0x30, 35 REG_CONTROLLER_ENABLE = 0x34, 36 REG_UIC_ERROR_CODE_PHY_ADAPTER_LAYER = 0x38, 37 REG_UIC_ERROR_CODE_DATA_LINK_LAYER = 0x3C, 38 REG_UIC_ERROR_CODE_NETWORK_LAYER = 0x40, 39 REG_UIC_ERROR_CODE_TRANSPORT_LAYER = 0x44, 40 REG_UIC_ERROR_CODE_DME = 0x48, 41 REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL = 0x4C, 42 REG_UTP_TRANSFER_REQ_LIST_BASE_L = 0x50, 43 REG_UTP_TRANSFER_REQ_LIST_BASE_H = 0x54, 44 REG_UTP_TRANSFER_REQ_DOOR_BELL = 0x58, 45 REG_UTP_TRANSFER_REQ_LIST_CLEAR = 0x5C, 46 REG_UTP_TRANSFER_REQ_LIST_RUN_STOP = 0x60, 47 REG_UTP_TASK_REQ_LIST_BASE_L = 0x70, 48 REG_UTP_TASK_REQ_LIST_BASE_H = 0x74, 49 REG_UTP_TASK_REQ_DOOR_BELL = 0x78, 50 REG_UTP_TASK_REQ_LIST_CLEAR = 0x7C, 51 REG_UTP_TASK_REQ_LIST_RUN_STOP = 0x80, 52 REG_UIC_COMMAND = 0x90, 53 REG_UIC_COMMAND_ARG_1 = 0x94, 54 REG_UIC_COMMAND_ARG_2 = 0x98, 55 REG_UIC_COMMAND_ARG_3 = 0x9C, 56 57 UFSHCI_REG_SPACE_SIZE = 0xA0, 58 59 REG_UFS_CCAP = 0x100, 60 REG_UFS_CRYPTOCAP = 0x104, 61 62 REG_UFS_MEM_CFG = 0x300, 63 REG_UFS_MCQ_CFG = 0x380, 64 REG_UFS_ESILBA = 0x384, 65 REG_UFS_ESIUBA = 0x388, 66 UFSHCI_CRYPTO_REG_SPACE_SIZE = 0x400, 67 }; 68 69 /* Controller capability masks */ 70 enum { 71 MASK_TRANSFER_REQUESTS_SLOTS_SDB = 0x0000001F, 72 MASK_TRANSFER_REQUESTS_SLOTS_MCQ = 0x000000FF, 73 MASK_NUMBER_OUTSTANDING_RTT = 0x0000FF00, 74 MASK_TASK_MANAGEMENT_REQUEST_SLOTS = 0x00070000, 75 MASK_EHSLUTRD_SUPPORTED = 0x00400000, 76 MASK_AUTO_HIBERN8_SUPPORT = 0x00800000, 77 MASK_64_ADDRESSING_SUPPORT = 0x01000000, 78 MASK_OUT_OF_ORDER_DATA_DELIVERY_SUPPORT = 0x02000000, 79 MASK_UIC_DME_TEST_MODE_SUPPORT = 0x04000000, 80 MASK_CRYPTO_SUPPORT = 0x10000000, 81 MASK_LSDB_SUPPORT = 0x20000000, 82 MASK_MCQ_SUPPORT = 0x40000000, 83 }; 84 85 enum { 86 REG_SQATTR = 0x0, 87 REG_SQLBA = 0x4, 88 REG_SQUBA = 0x8, 89 REG_SQDAO = 0xC, 90 REG_SQISAO = 0x10, 91 92 REG_CQATTR = 0x20, 93 REG_CQLBA = 0x24, 94 REG_CQUBA = 0x28, 95 REG_CQDAO = 0x2C, 96 REG_CQISAO = 0x30, 97 }; 98 99 enum { 100 REG_SQHP = 0x0, 101 REG_SQTP = 0x4, 102 REG_SQRTC = 0x8, 103 REG_SQCTI = 0xC, 104 REG_SQRTS = 0x10, 105 }; 106 107 enum { 108 REG_CQHP = 0x0, 109 REG_CQTP = 0x4, 110 }; 111 112 enum { 113 REG_CQIS = 0x0, 114 REG_CQIE = 0x4, 115 }; 116 117 enum { 118 SQ_START = 0x0, 119 SQ_STOP = 0x1, 120 SQ_ICU = 0x2, 121 }; 122 123 enum { 124 SQ_STS = 0x1, 125 SQ_CUS = 0x2, 126 }; 127 128 #define SQ_ICU_ERR_CODE_MASK GENMASK(7, 4) 129 #define UFS_MASK(mask, offset) ((mask) << (offset)) 130 131 /* UFS Version 08h */ 132 #define MINOR_VERSION_NUM_MASK UFS_MASK(0xFFFF, 0) 133 #define MAJOR_VERSION_NUM_MASK UFS_MASK(0xFFFF, 16) 134 135 #define UFSHCD_NUM_RESERVED 1 136 /* 137 * Controller UFSHCI version 138 * - 2.x and newer use the following scheme: 139 * major << 8 + minor << 4 140 * - 1.x has been converted to match this in 141 * ufshcd_get_ufs_version() 142 */ 143 static inline u32 ufshci_version(u32 major, u32 minor) 144 { 145 return (major << 8) + (minor << 4); 146 } 147 148 /* 149 * HCDDID - Host Controller Identification Descriptor 150 * - Device ID and Device Class 10h 151 */ 152 #define DEVICE_CLASS UFS_MASK(0xFFFF, 0) 153 #define DEVICE_ID UFS_MASK(0xFF, 24) 154 155 /* 156 * HCPMID - Host Controller Identification Descriptor 157 * - Product/Manufacturer ID 14h 158 */ 159 #define MANUFACTURE_ID_MASK UFS_MASK(0xFFFF, 0) 160 #define PRODUCT_ID_MASK UFS_MASK(0xFFFF, 16) 161 162 /* AHIT - Auto-Hibernate Idle Timer */ 163 #define UFSHCI_AHIBERN8_TIMER_MASK GENMASK(9, 0) 164 #define UFSHCI_AHIBERN8_SCALE_MASK GENMASK(12, 10) 165 #define UFSHCI_AHIBERN8_SCALE_FACTOR 10 166 #define UFSHCI_AHIBERN8_MAX (1023 * 100000) 167 168 /* 169 * IS - Interrupt Status - 20h 170 */ 171 #define UTP_TRANSFER_REQ_COMPL 0x1 172 #define UIC_DME_END_PT_RESET 0x2 173 #define UIC_ERROR 0x4 174 #define UIC_TEST_MODE 0x8 175 #define UIC_POWER_MODE 0x10 176 #define UIC_HIBERNATE_EXIT 0x20 177 #define UIC_HIBERNATE_ENTER 0x40 178 #define UIC_LINK_LOST 0x80 179 #define UIC_LINK_STARTUP 0x100 180 #define UTP_TASK_REQ_COMPL 0x200 181 #define UIC_COMMAND_COMPL 0x400 182 #define DEVICE_FATAL_ERROR 0x800 183 #define UTP_ERROR 0x1000 184 #define CONTROLLER_FATAL_ERROR 0x10000 185 #define SYSTEM_BUS_FATAL_ERROR 0x20000 186 #define CRYPTO_ENGINE_FATAL_ERROR 0x40000 187 #define MCQ_CQ_EVENT_STATUS 0x100000 188 189 #define UFSHCD_UIC_HIBERN8_MASK (UIC_HIBERNATE_ENTER |\ 190 UIC_HIBERNATE_EXIT) 191 192 #define UFSHCD_UIC_PWR_MASK (UFSHCD_UIC_HIBERN8_MASK |\ 193 UIC_POWER_MODE) 194 195 #define UFSHCD_UIC_MASK (UIC_COMMAND_COMPL | UFSHCD_UIC_PWR_MASK) 196 197 #define UFSHCD_ERROR_MASK (UIC_ERROR | INT_FATAL_ERRORS) 198 199 #define INT_FATAL_ERRORS (DEVICE_FATAL_ERROR |\ 200 CONTROLLER_FATAL_ERROR |\ 201 SYSTEM_BUS_FATAL_ERROR |\ 202 CRYPTO_ENGINE_FATAL_ERROR |\ 203 UIC_LINK_LOST |\ 204 UTP_ERROR) 205 206 /* HCS - Host Controller Status 30h */ 207 #define DEVICE_PRESENT 0x1 208 #define UTP_TRANSFER_REQ_LIST_READY 0x2 209 #define UTP_TASK_REQ_LIST_READY 0x4 210 #define UIC_COMMAND_READY 0x8 211 #define HOST_ERROR_INDICATOR 0x10 212 #define DEVICE_ERROR_INDICATOR 0x20 213 #define UIC_POWER_MODE_CHANGE_REQ_STATUS_MASK UFS_MASK(0x7, 8) 214 215 #define UFSHCD_STATUS_READY (UTP_TRANSFER_REQ_LIST_READY |\ 216 UTP_TASK_REQ_LIST_READY |\ 217 UIC_COMMAND_READY) 218 219 enum { 220 PWR_OK = 0x0, 221 PWR_LOCAL = 0x01, 222 PWR_REMOTE = 0x02, 223 PWR_BUSY = 0x03, 224 PWR_ERROR_CAP = 0x04, 225 PWR_FATAL_ERROR = 0x05, 226 }; 227 228 /* HCE - Host Controller Enable 34h */ 229 #define CONTROLLER_ENABLE 0x1 230 #define CONTROLLER_DISABLE 0x0 231 #define CRYPTO_GENERAL_ENABLE 0x2 232 233 /* UECPA - Host UIC Error Code PHY Adapter Layer 38h */ 234 #define UIC_PHY_ADAPTER_LAYER_ERROR 0x80000000 235 #define UIC_PHY_ADAPTER_LAYER_ERROR_CODE_MASK 0x1F 236 #define UIC_PHY_ADAPTER_LAYER_LANE_ERR_MASK 0xF 237 #define UIC_PHY_ADAPTER_LAYER_GENERIC_ERROR 0x10 238 239 /* UECDL - Host UIC Error Code Data Link Layer 3Ch */ 240 #define UIC_DATA_LINK_LAYER_ERROR 0x80000000 241 #define UIC_DATA_LINK_LAYER_ERROR_CODE_MASK 0xFFFF 242 #define UIC_DATA_LINK_LAYER_ERROR_TCX_REP_TIMER_EXP 0x2 243 #define UIC_DATA_LINK_LAYER_ERROR_AFCX_REQ_TIMER_EXP 0x4 244 #define UIC_DATA_LINK_LAYER_ERROR_FCX_PRO_TIMER_EXP 0x8 245 #define UIC_DATA_LINK_LAYER_ERROR_RX_BUF_OF 0x20 246 #define UIC_DATA_LINK_LAYER_ERROR_PA_INIT 0x2000 247 #define UIC_DATA_LINK_LAYER_ERROR_NAC_RECEIVED 0x0001 248 #define UIC_DATA_LINK_LAYER_ERROR_TCx_REPLAY_TIMEOUT 0x0002 249 250 /* UECN - Host UIC Error Code Network Layer 40h */ 251 #define UIC_NETWORK_LAYER_ERROR 0x80000000 252 #define UIC_NETWORK_LAYER_ERROR_CODE_MASK 0x7 253 #define UIC_NETWORK_UNSUPPORTED_HEADER_TYPE 0x1 254 #define UIC_NETWORK_BAD_DEVICEID_ENC 0x2 255 #define UIC_NETWORK_LHDR_TRAP_PACKET_DROPPING 0x4 256 257 /* UECT - Host UIC Error Code Transport Layer 44h */ 258 #define UIC_TRANSPORT_LAYER_ERROR 0x80000000 259 #define UIC_TRANSPORT_LAYER_ERROR_CODE_MASK 0x7F 260 #define UIC_TRANSPORT_UNSUPPORTED_HEADER_TYPE 0x1 261 #define UIC_TRANSPORT_UNKNOWN_CPORTID 0x2 262 #define UIC_TRANSPORT_NO_CONNECTION_RX 0x4 263 #define UIC_TRANSPORT_CONTROLLED_SEGMENT_DROPPING 0x8 264 #define UIC_TRANSPORT_BAD_TC 0x10 265 #define UIC_TRANSPORT_E2E_CREDIT_OVERFOW 0x20 266 #define UIC_TRANSPORT_SAFETY_VALUE_DROPPING 0x40 267 268 /* UECDME - Host UIC Error Code DME 48h */ 269 #define UIC_DME_ERROR 0x80000000 270 #define UIC_DME_ERROR_CODE_MASK 0x1 271 272 /* UTRIACR - Interrupt Aggregation control register - 0x4Ch */ 273 #define INT_AGGR_TIMEOUT_VAL_MASK 0xFF 274 #define INT_AGGR_COUNTER_THRESHOLD_MASK UFS_MASK(0x1F, 8) 275 #define INT_AGGR_COUNTER_AND_TIMER_RESET 0x10000 276 #define INT_AGGR_STATUS_BIT 0x100000 277 #define INT_AGGR_PARAM_WRITE 0x1000000 278 #define INT_AGGR_ENABLE 0x80000000 279 280 /* UTRLRSR - UTP Transfer Request Run-Stop Register 60h */ 281 #define UTP_TRANSFER_REQ_LIST_RUN_STOP_BIT 0x1 282 283 /* UTMRLRSR - UTP Task Management Request Run-Stop Register 80h */ 284 #define UTP_TASK_REQ_LIST_RUN_STOP_BIT 0x1 285 286 /* REG_UFS_MEM_CFG - Global Config Registers 300h */ 287 #define MCQ_MODE_SELECT BIT(0) 288 289 /* CQISy - CQ y Interrupt Status Register */ 290 #define UFSHCD_MCQ_CQIS_TAIL_ENT_PUSH_STS 0x1 291 292 /* UICCMD - UIC Command */ 293 #define COMMAND_OPCODE_MASK 0xFF 294 #define GEN_SELECTOR_INDEX_MASK 0xFFFF 295 296 #define MIB_ATTRIBUTE_MASK UFS_MASK(0xFFFF, 16) 297 #define RESET_LEVEL 0xFF 298 299 #define ATTR_SET_TYPE_MASK UFS_MASK(0xFF, 16) 300 #define CONFIG_RESULT_CODE_MASK 0xFF 301 #define GENERIC_ERROR_CODE_MASK 0xFF 302 303 /* GenSelectorIndex calculation macros for M-PHY attributes */ 304 #define UIC_ARG_MPHY_TX_GEN_SEL_INDEX(lane) (lane) 305 #define UIC_ARG_MPHY_RX_GEN_SEL_INDEX(lane) (PA_MAXDATALANES + (lane)) 306 307 #define UIC_ARG_MIB_SEL(attr, sel) ((((attr) & 0xFFFF) << 16) |\ 308 ((sel) & 0xFFFF)) 309 #define UIC_ARG_MIB(attr) UIC_ARG_MIB_SEL(attr, 0) 310 #define UIC_ARG_ATTR_TYPE(t) (((t) & 0xFF) << 16) 311 #define UIC_GET_ATTR_ID(v) (((v) >> 16) & 0xFFFF) 312 313 /* Link Status*/ 314 enum link_status { 315 UFSHCD_LINK_IS_DOWN = 1, 316 UFSHCD_LINK_IS_UP = 2, 317 }; 318 319 /* UIC Commands */ 320 enum uic_cmd_dme { 321 UIC_CMD_DME_GET = 0x01, 322 UIC_CMD_DME_SET = 0x02, 323 UIC_CMD_DME_PEER_GET = 0x03, 324 UIC_CMD_DME_PEER_SET = 0x04, 325 UIC_CMD_DME_POWERON = 0x10, 326 UIC_CMD_DME_POWEROFF = 0x11, 327 UIC_CMD_DME_ENABLE = 0x12, 328 UIC_CMD_DME_RESET = 0x14, 329 UIC_CMD_DME_END_PT_RST = 0x15, 330 UIC_CMD_DME_LINK_STARTUP = 0x16, 331 UIC_CMD_DME_HIBER_ENTER = 0x17, 332 UIC_CMD_DME_HIBER_EXIT = 0x18, 333 UIC_CMD_DME_TEST_MODE = 0x1A, 334 }; 335 336 /* UIC Config result code / Generic error code */ 337 enum { 338 UIC_CMD_RESULT_SUCCESS = 0x00, 339 UIC_CMD_RESULT_INVALID_ATTR = 0x01, 340 UIC_CMD_RESULT_FAILURE = 0x01, 341 UIC_CMD_RESULT_INVALID_ATTR_VALUE = 0x02, 342 UIC_CMD_RESULT_READ_ONLY_ATTR = 0x03, 343 UIC_CMD_RESULT_WRITE_ONLY_ATTR = 0x04, 344 UIC_CMD_RESULT_BAD_INDEX = 0x05, 345 UIC_CMD_RESULT_LOCKED_ATTR = 0x06, 346 UIC_CMD_RESULT_BAD_TEST_FEATURE_INDEX = 0x07, 347 UIC_CMD_RESULT_PEER_COMM_FAILURE = 0x08, 348 UIC_CMD_RESULT_BUSY = 0x09, 349 UIC_CMD_RESULT_DME_FAILURE = 0x0A, 350 }; 351 352 #define MASK_UIC_COMMAND_RESULT 0xFF 353 354 #define INT_AGGR_COUNTER_THLD_VAL(c) (((c) & 0x1F) << 8) 355 #define INT_AGGR_TIMEOUT_VAL(t) (((t) & 0xFF) << 0) 356 357 /* Interrupt disable masks */ 358 enum { 359 /* Interrupt disable mask for UFSHCI v1.1 */ 360 INTERRUPT_MASK_ALL_VER_11 = 0x31FFF, 361 362 /* Interrupt disable mask for UFSHCI v2.1 */ 363 INTERRUPT_MASK_ALL_VER_21 = 0x71FFF, 364 }; 365 366 /* CCAP - Crypto Capability 100h */ 367 union ufs_crypto_capabilities { 368 __le32 reg_val; 369 struct { 370 u8 num_crypto_cap; 371 u8 config_count; 372 u8 reserved; 373 u8 config_array_ptr; 374 }; 375 }; 376 377 enum ufs_crypto_key_size { 378 UFS_CRYPTO_KEY_SIZE_INVALID = 0x0, 379 UFS_CRYPTO_KEY_SIZE_128 = 0x1, 380 UFS_CRYPTO_KEY_SIZE_192 = 0x2, 381 UFS_CRYPTO_KEY_SIZE_256 = 0x3, 382 UFS_CRYPTO_KEY_SIZE_512 = 0x4, 383 }; 384 385 enum ufs_crypto_alg { 386 UFS_CRYPTO_ALG_AES_XTS = 0x0, 387 UFS_CRYPTO_ALG_BITLOCKER_AES_CBC = 0x1, 388 UFS_CRYPTO_ALG_AES_ECB = 0x2, 389 UFS_CRYPTO_ALG_ESSIV_AES_CBC = 0x3, 390 }; 391 392 /* x-CRYPTOCAP - Crypto Capability X */ 393 union ufs_crypto_cap_entry { 394 __le32 reg_val; 395 struct { 396 u8 algorithm_id; 397 u8 sdus_mask; /* Supported data unit size mask */ 398 u8 key_size; 399 u8 reserved; 400 }; 401 }; 402 403 #define UFS_CRYPTO_CONFIGURATION_ENABLE (1 << 7) 404 #define UFS_CRYPTO_KEY_MAX_SIZE 64 405 /* x-CRYPTOCFG - Crypto Configuration X */ 406 union ufs_crypto_cfg_entry { 407 __le32 reg_val[32]; 408 struct { 409 u8 crypto_key[UFS_CRYPTO_KEY_MAX_SIZE]; 410 u8 data_unit_size; 411 u8 crypto_cap_idx; 412 u8 reserved_1; 413 u8 config_enable; 414 u8 reserved_multi_host; 415 u8 reserved_2; 416 u8 vsb[2]; 417 u8 reserved_3[56]; 418 }; 419 }; 420 421 /* 422 * Request Descriptor Definitions 423 */ 424 425 /* To accommodate UFS2.0 required Command type */ 426 enum { 427 UTP_CMD_TYPE_UFS_STORAGE = 0x1, 428 }; 429 430 enum { 431 UTP_SCSI_COMMAND = 0x00000000, 432 UTP_NATIVE_UFS_COMMAND = 0x10000000, 433 UTP_DEVICE_MANAGEMENT_FUNCTION = 0x20000000, 434 }; 435 436 /* UTP Transfer Request Data Direction (DD) */ 437 enum utp_data_direction { 438 UTP_NO_DATA_TRANSFER = 0, 439 UTP_HOST_TO_DEVICE = 1, 440 UTP_DEVICE_TO_HOST = 2, 441 }; 442 443 /* Overall command status values */ 444 enum utp_ocs { 445 OCS_SUCCESS = 0x0, 446 OCS_INVALID_CMD_TABLE_ATTR = 0x1, 447 OCS_INVALID_PRDT_ATTR = 0x2, 448 OCS_MISMATCH_DATA_BUF_SIZE = 0x3, 449 OCS_MISMATCH_RESP_UPIU_SIZE = 0x4, 450 OCS_PEER_COMM_FAILURE = 0x5, 451 OCS_ABORTED = 0x6, 452 OCS_FATAL_ERROR = 0x7, 453 OCS_DEVICE_FATAL_ERROR = 0x8, 454 OCS_INVALID_CRYPTO_CONFIG = 0x9, 455 OCS_GENERAL_CRYPTO_ERROR = 0xA, 456 OCS_INVALID_COMMAND_STATUS = 0x0F, 457 }; 458 459 enum { 460 MASK_OCS = 0x0F, 461 }; 462 463 /* The maximum length of the data byte count field in the PRDT is 256KB */ 464 #define PRDT_DATA_BYTE_COUNT_MAX SZ_256K 465 /* The granularity of the data byte count field in the PRDT is 32-bit */ 466 #define PRDT_DATA_BYTE_COUNT_PAD 4 467 468 /** 469 * struct ufshcd_sg_entry - UFSHCI PRD Entry 470 * @addr: Physical address; DW-0 and DW-1. 471 * @reserved: Reserved for future use DW-2 472 * @size: size of physical segment DW-3 473 */ 474 struct ufshcd_sg_entry { 475 __le64 addr; 476 __le32 reserved; 477 __le32 size; 478 /* 479 * followed by variant-specific fields if 480 * CONFIG_SCSI_UFS_VARIABLE_SG_ENTRY_SIZE has been defined. 481 */ 482 }; 483 484 /** 485 * struct utp_transfer_cmd_desc - UTP Command Descriptor (UCD) 486 * @command_upiu: Command UPIU Frame address 487 * @response_upiu: Response UPIU Frame address 488 * @prd_table: Physical Region Descriptor: an array of SG_ALL struct 489 * ufshcd_sg_entry's. Variant-specific fields may be present after each. 490 */ 491 struct utp_transfer_cmd_desc { 492 u8 command_upiu[ALIGNED_UPIU_SIZE]; 493 u8 response_upiu[ALIGNED_UPIU_SIZE]; 494 u8 prd_table[]; 495 }; 496 497 /** 498 * struct request_desc_header - Descriptor Header common to both UTRD and UTMRD 499 */ 500 struct request_desc_header { 501 u8 cci; 502 u8 ehs_length; 503 #if defined(__BIG_ENDIAN) 504 u8 enable_crypto:1; 505 u8 reserved2:7; 506 507 u8 command_type:4; 508 u8 reserved1:1; 509 u8 data_direction:2; 510 u8 interrupt:1; 511 #elif defined(__LITTLE_ENDIAN) 512 u8 reserved2:7; 513 u8 enable_crypto:1; 514 515 u8 interrupt:1; 516 u8 data_direction:2; 517 u8 reserved1:1; 518 u8 command_type:4; 519 #else 520 #error 521 #endif 522 523 __le32 dunl; 524 u8 ocs; 525 u8 cds; 526 __le16 ldbc; 527 __le32 dunu; 528 }; 529 530 static_assert(sizeof(struct request_desc_header) == 16); 531 532 /** 533 * struct utp_transfer_req_desc - UTP Transfer Request Descriptor (UTRD) 534 * @header: UTRD header DW-0 to DW-3 535 * @command_desc_base_addr: UCD base address DW 4-5 536 * @response_upiu_length: response UPIU length DW-6 537 * @response_upiu_offset: response UPIU offset DW-6 538 * @prd_table_length: Physical region descriptor length DW-7 539 * @prd_table_offset: Physical region descriptor offset DW-7 540 */ 541 struct utp_transfer_req_desc { 542 543 /* DW 0-3 */ 544 struct request_desc_header header; 545 546 /* DW 4-5*/ 547 __le64 command_desc_base_addr; 548 549 /* DW 6 */ 550 __le16 response_upiu_length; 551 __le16 response_upiu_offset; 552 553 /* DW 7 */ 554 __le16 prd_table_length; 555 __le16 prd_table_offset; 556 }; 557 558 /* MCQ Completion Queue Entry */ 559 struct cq_entry { 560 /* DW 0-1 */ 561 __le64 command_desc_base_addr; 562 563 /* DW 2 */ 564 __le16 response_upiu_length; 565 __le16 response_upiu_offset; 566 567 /* DW 3 */ 568 __le16 prd_table_length; 569 __le16 prd_table_offset; 570 571 /* DW 4 */ 572 __le32 status; 573 574 /* DW 5-7 */ 575 __le32 reserved[3]; 576 }; 577 578 static_assert(sizeof(struct cq_entry) == 32); 579 580 /* 581 * UTMRD structure. 582 */ 583 struct utp_task_req_desc { 584 /* DW 0-3 */ 585 struct request_desc_header header; 586 587 /* DW 4-11 - Task request UPIU structure */ 588 struct { 589 struct utp_upiu_header req_header; 590 __be32 input_param1; 591 __be32 input_param2; 592 __be32 input_param3; 593 __be32 __reserved1[2]; 594 } upiu_req; 595 596 /* DW 12-19 - Task Management Response UPIU structure */ 597 struct { 598 struct utp_upiu_header rsp_header; 599 __be32 output_param1; 600 __be32 output_param2; 601 __be32 __reserved2[3]; 602 } upiu_rsp; 603 }; 604 605 #endif /* End of Header */ 606