1 /* 2 * Universal Flash Storage Host controller driver 3 * 4 * This code is based on drivers/scsi/ufs/ufshci.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 _UFSHCI_H 37 #define _UFSHCI_H 38 39 enum { 40 TASK_REQ_UPIU_SIZE_DWORDS = 8, 41 TASK_RSP_UPIU_SIZE_DWORDS = 8, 42 ALIGNED_UPIU_SIZE = 512, 43 }; 44 45 /* UFSHCI Registers */ 46 enum { 47 REG_CONTROLLER_CAPABILITIES = 0x00, 48 REG_UFS_VERSION = 0x08, 49 REG_CONTROLLER_DEV_ID = 0x10, 50 REG_CONTROLLER_PROD_ID = 0x14, 51 REG_INTERRUPT_STATUS = 0x20, 52 REG_INTERRUPT_ENABLE = 0x24, 53 REG_CONTROLLER_STATUS = 0x30, 54 REG_CONTROLLER_ENABLE = 0x34, 55 REG_UIC_ERROR_CODE_PHY_ADAPTER_LAYER = 0x38, 56 REG_UIC_ERROR_CODE_DATA_LINK_LAYER = 0x3C, 57 REG_UIC_ERROR_CODE_NETWORK_LAYER = 0x40, 58 REG_UIC_ERROR_CODE_TRANSPORT_LAYER = 0x44, 59 REG_UIC_ERROR_CODE_DME = 0x48, 60 REG_UTP_TRANSFER_REQ_INT_AGG_CONTROL = 0x4C, 61 REG_UTP_TRANSFER_REQ_LIST_BASE_L = 0x50, 62 REG_UTP_TRANSFER_REQ_LIST_BASE_H = 0x54, 63 REG_UTP_TRANSFER_REQ_DOOR_BELL = 0x58, 64 REG_UTP_TRANSFER_REQ_LIST_CLEAR = 0x5C, 65 REG_UTP_TRANSFER_REQ_LIST_RUN_STOP = 0x60, 66 REG_UTP_TASK_REQ_LIST_BASE_L = 0x70, 67 REG_UTP_TASK_REQ_LIST_BASE_H = 0x74, 68 REG_UTP_TASK_REQ_DOOR_BELL = 0x78, 69 REG_UTP_TASK_REQ_LIST_CLEAR = 0x7C, 70 REG_UTP_TASK_REQ_LIST_RUN_STOP = 0x80, 71 REG_UIC_COMMAND = 0x90, 72 REG_UIC_COMMAND_ARG_1 = 0x94, 73 REG_UIC_COMMAND_ARG_2 = 0x98, 74 REG_UIC_COMMAND_ARG_3 = 0x9C, 75 }; 76 77 /* Controller capability masks */ 78 enum { 79 MASK_TRANSFER_REQUESTS_SLOTS = 0x0000001F, 80 MASK_TASK_MANAGEMENT_REQUEST_SLOTS = 0x00070000, 81 MASK_64_ADDRESSING_SUPPORT = 0x01000000, 82 MASK_OUT_OF_ORDER_DATA_DELIVERY_SUPPORT = 0x02000000, 83 MASK_UIC_DME_TEST_MODE_SUPPORT = 0x04000000, 84 }; 85 86 /* UFS Version 08h */ 87 #define MINOR_VERSION_NUM_MASK UFS_MASK(0xFFFF, 0) 88 #define MAJOR_VERSION_NUM_MASK UFS_MASK(0xFFFF, 16) 89 90 /* Controller UFSHCI version */ 91 enum { 92 UFSHCI_VERSION_10 = 0x00010000, /* 1.0 */ 93 UFSHCI_VERSION_11 = 0x00010100, /* 1.1 */ 94 UFSHCI_VERSION_20 = 0x00000200, /* 2.0 */ 95 }; 96 97 /* 98 * HCDDID - Host Controller Identification Descriptor 99 * - Device ID and Device Class 10h 100 */ 101 #define DEVICE_CLASS UFS_MASK(0xFFFF, 0) 102 #define DEVICE_ID UFS_MASK(0xFF, 24) 103 104 /* 105 * HCPMID - Host Controller Identification Descriptor 106 * - Product/Manufacturer ID 14h 107 */ 108 #define MANUFACTURE_ID_MASK UFS_MASK(0xFFFF, 0) 109 #define PRODUCT_ID_MASK UFS_MASK(0xFFFF, 16) 110 111 #define UFS_BIT(x) (1L << (x)) 112 113 #define UTP_TRANSFER_REQ_COMPL UFS_BIT(0) 114 #define UIC_DME_END_PT_RESET UFS_BIT(1) 115 #define UIC_ERROR UFS_BIT(2) 116 #define UIC_TEST_MODE UFS_BIT(3) 117 #define UIC_POWER_MODE UFS_BIT(4) 118 #define UIC_HIBERNATE_EXIT UFS_BIT(5) 119 #define UIC_HIBERNATE_ENTER UFS_BIT(6) 120 #define UIC_LINK_LOST UFS_BIT(7) 121 #define UIC_LINK_STARTUP UFS_BIT(8) 122 #define UTP_TASK_REQ_COMPL UFS_BIT(9) 123 #define UIC_COMMAND_COMPL UFS_BIT(10) 124 #define DEVICE_FATAL_ERROR UFS_BIT(11) 125 #define CONTROLLER_FATAL_ERROR UFS_BIT(16) 126 #define SYSTEM_BUS_FATAL_ERROR UFS_BIT(17) 127 128 #define UFSHCD_UIC_PWR_MASK (UIC_HIBERNATE_ENTER |\ 129 UIC_HIBERNATE_EXIT |\ 130 UIC_POWER_MODE) 131 132 #define UFSHCD_UIC_MASK (UIC_COMMAND_COMPL | UFSHCD_UIC_PWR_MASK) 133 134 #define UFSHCD_ERROR_MASK (UIC_ERROR |\ 135 DEVICE_FATAL_ERROR |\ 136 CONTROLLER_FATAL_ERROR |\ 137 SYSTEM_BUS_FATAL_ERROR) 138 139 #define INT_FATAL_ERRORS (DEVICE_FATAL_ERROR |\ 140 CONTROLLER_FATAL_ERROR |\ 141 SYSTEM_BUS_FATAL_ERROR) 142 143 /* HCS - Host Controller Status 30h */ 144 #define DEVICE_PRESENT UFS_BIT(0) 145 #define UTP_TRANSFER_REQ_LIST_READY UFS_BIT(1) 146 #define UTP_TASK_REQ_LIST_READY UFS_BIT(2) 147 #define UIC_COMMAND_READY UFS_BIT(3) 148 #define HOST_ERROR_INDICATOR UFS_BIT(4) 149 #define DEVICE_ERROR_INDICATOR UFS_BIT(5) 150 #define UIC_POWER_MODE_CHANGE_REQ_STATUS_MASK UFS_MASK(0x7, 8) 151 152 enum { 153 PWR_OK = 0x0, 154 PWR_LOCAL = 0x01, 155 PWR_REMOTE = 0x02, 156 PWR_BUSY = 0x03, 157 PWR_ERROR_CAP = 0x04, 158 PWR_FATAL_ERROR = 0x05, 159 }; 160 161 /* HCE - Host Controller Enable 34h */ 162 #define CONTROLLER_ENABLE UFS_BIT(0) 163 #define CONTROLLER_DISABLE 0x0 164 165 /* UECPA - Host UIC Error Code PHY Adapter Layer 38h */ 166 #define UIC_PHY_ADAPTER_LAYER_ERROR UFS_BIT(31) 167 #define UIC_PHY_ADAPTER_LAYER_ERROR_CODE_MASK 0x1F 168 169 /* UECDL - Host UIC Error Code Data Link Layer 3Ch */ 170 #define UIC_DATA_LINK_LAYER_ERROR UFS_BIT(31) 171 #define UIC_DATA_LINK_LAYER_ERROR_CODE_MASK 0x7FFF 172 #define UIC_DATA_LINK_LAYER_ERROR_PA_INIT 0x2000 173 174 /* UECN - Host UIC Error Code Network Layer 40h */ 175 #define UIC_NETWORK_LAYER_ERROR UFS_BIT(31) 176 #define UIC_NETWORK_LAYER_ERROR_CODE_MASK 0x7 177 178 /* UECT - Host UIC Error Code Transport Layer 44h */ 179 #define UIC_TRANSPORT_LAYER_ERROR UFS_BIT(31) 180 #define UIC_TRANSPORT_LAYER_ERROR_CODE_MASK 0x7F 181 182 /* UECDME - Host UIC Error Code DME 48h */ 183 #define UIC_DME_ERROR UFS_BIT(31) 184 #define UIC_DME_ERROR_CODE_MASK 0x1 185 186 #define INT_AGGR_TIMEOUT_VAL_MASK 0xFF 187 #define INT_AGGR_COUNTER_THRESHOLD_MASK UFS_MASK(0x1F, 8) 188 #define INT_AGGR_COUNTER_AND_TIMER_RESET UFS_BIT(16) 189 #define INT_AGGR_STATUS_BIT UFS_BIT(20) 190 #define INT_AGGR_PARAM_WRITE UFS_BIT(24) 191 #define INT_AGGR_ENABLE UFS_BIT(31) 192 193 /* UTRLRSR - UTP Transfer Request Run-Stop Register 60h */ 194 #define UTP_TRANSFER_REQ_LIST_RUN_STOP_BIT UFS_BIT(0) 195 196 /* UTMRLRSR - UTP Task Management Request Run-Stop Register 80h */ 197 #define UTP_TASK_REQ_LIST_RUN_STOP_BIT UFS_BIT(0) 198 199 /* UICCMD - UIC Command */ 200 #define COMMAND_OPCODE_MASK 0xFF 201 #define GEN_SELECTOR_INDEX_MASK 0xFFFF 202 203 #define MIB_ATTRIBUTE_MASK UFS_MASK(0xFFFF, 16) 204 #define RESET_LEVEL 0xFF 205 206 #define ATTR_SET_TYPE_MASK UFS_MASK(0xFF, 16) 207 #define CONFIG_RESULT_CODE_MASK 0xFF 208 #define GENERIC_ERROR_CODE_MASK 0xFF 209 210 /* GenSelectorIndex calculation macros for M-PHY attributes */ 211 #define UIC_ARG_MPHY_TX_GEN_SEL_INDEX(lane) (lane) 212 213 #define UIC_ARG_MIB_SEL(attr, sel) ((((attr) & 0xFFFF) << 16) |\ 214 ((sel) & 0xFFFF)) 215 #define UIC_ARG_MIB(attr) UIC_ARG_MIB_SEL(attr, 0) 216 #define UIC_ARG_ATTR_TYPE(t) (((t) & 0xFF) << 16) 217 #define UIC_GET_ATTR_ID(v) (((v) >> 16) & 0xFFFF) 218 219 /* UIC Commands */ 220 enum uic_cmd_dme { 221 UIC_CMD_DME_GET = 0x01, 222 UIC_CMD_DME_SET = 0x02, 223 UIC_CMD_DME_PEER_GET = 0x03, 224 UIC_CMD_DME_PEER_SET = 0x04, 225 UIC_CMD_DME_POWERON = 0x10, 226 UIC_CMD_DME_POWEROFF = 0x11, 227 UIC_CMD_DME_ENABLE = 0x12, 228 UIC_CMD_DME_RESET = 0x14, 229 UIC_CMD_DME_END_PT_RST = 0x15, 230 UIC_CMD_DME_LINK_STARTUP = 0x16, 231 UIC_CMD_DME_HIBER_ENTER = 0x17, 232 UIC_CMD_DME_HIBER_EXIT = 0x18, 233 UIC_CMD_DME_TEST_MODE = 0x1A, 234 }; 235 236 /* UIC Config result code / Generic error code */ 237 enum { 238 UIC_CMD_RESULT_SUCCESS = 0x00, 239 UIC_CMD_RESULT_INVALID_ATTR = 0x01, 240 UIC_CMD_RESULT_FAILURE = 0x01, 241 UIC_CMD_RESULT_INVALID_ATTR_VALUE = 0x02, 242 UIC_CMD_RESULT_READ_ONLY_ATTR = 0x03, 243 UIC_CMD_RESULT_WRITE_ONLY_ATTR = 0x04, 244 UIC_CMD_RESULT_BAD_INDEX = 0x05, 245 UIC_CMD_RESULT_LOCKED_ATTR = 0x06, 246 UIC_CMD_RESULT_BAD_TEST_FEATURE_INDEX = 0x07, 247 UIC_CMD_RESULT_PEER_COMM_FAILURE = 0x08, 248 UIC_CMD_RESULT_BUSY = 0x09, 249 UIC_CMD_RESULT_DME_FAILURE = 0x0A, 250 }; 251 252 #define MASK_UIC_COMMAND_RESULT 0xFF 253 254 #define INT_AGGR_COUNTER_THLD_VAL(c) (((c) & 0x1F) << 8) 255 #define INT_AGGR_TIMEOUT_VAL(t) (((t) & 0xFF) << 0) 256 257 /* Interrupt disable masks */ 258 enum { 259 /* Interrupt disable mask for UFSHCI v1.0 */ 260 INTERRUPT_MASK_ALL_VER_10 = 0x30FFF, 261 INTERRUPT_MASK_RW_VER_10 = 0x30000, 262 263 /* Interrupt disable mask for UFSHCI v1.1 */ 264 INTERRUPT_MASK_ALL_VER_11 = 0x31FFF, 265 }; 266 267 /* 268 * Request Descriptor Definitions 269 */ 270 271 /* Transfer request command type */ 272 enum { 273 UTP_CMD_TYPE_SCSI = 0x0, 274 UTP_CMD_TYPE_UFS = 0x1, 275 UTP_CMD_TYPE_DEV_MANAGE = 0x2, 276 }; 277 278 enum { 279 UTP_SCSI_COMMAND = 0x00000000, 280 UTP_NATIVE_UFS_COMMAND = 0x10000000, 281 UTP_DEVICE_MANAGEMENT_FUNCTION = 0x20000000, 282 UTP_REQ_DESC_INT_CMD = 0x01000000, 283 }; 284 285 /* UTP Transfer Request Data Direction (DD) */ 286 enum { 287 UTP_NO_DATA_TRANSFER = 0x00000000, 288 UTP_HOST_TO_DEVICE = 0x02000000, 289 UTP_DEVICE_TO_HOST = 0x04000000, 290 }; 291 292 /* Overall command status values */ 293 enum { 294 OCS_SUCCESS = 0x0, 295 OCS_INVALID_CMD_TABLE_ATTR = 0x1, 296 OCS_INVALID_PRDT_ATTR = 0x2, 297 OCS_MISMATCH_DATA_BUF_SIZE = 0x3, 298 OCS_MISMATCH_RESP_UPIU_SIZE = 0x4, 299 OCS_PEER_COMM_FAILURE = 0x5, 300 OCS_ABORTED = 0x6, 301 OCS_FATAL_ERROR = 0x7, 302 OCS_INVALID_COMMAND_STATUS = 0x0F, 303 MASK_OCS = 0x0F, 304 }; 305 306 /* The maximum length of the data byte count field in the PRDT is 256KB */ 307 #define PRDT_DATA_BYTE_COUNT_MAX (256 * 1024) 308 /* The granularity of the data byte count field in the PRDT is 32-bit */ 309 #define PRDT_DATA_BYTE_COUNT_PAD 4 310 311 /** 312 * struct ufshcd_sg_entry - UFSHCI PRD Entry 313 * @base_addr: Lower 32bit physical address DW-0 314 * @upper_addr: Upper 32bit physical address DW-1 315 * @reserved: Reserved for future use DW-2 316 * @size: size of physical segment DW-3 317 */ 318 struct ufshcd_sg_entry { 319 __le32 base_addr; 320 __le32 upper_addr; 321 __le32 reserved; 322 __le32 size; 323 }; 324 325 /** 326 * struct utp_transfer_cmd_desc - UFS Command Descriptor structure 327 * @command_upiu: Command UPIU Frame address 328 * @response_upiu: Response UPIU Frame address 329 * @prd_table: Physical Region Descriptor 330 */ 331 struct utp_transfer_cmd_desc { 332 u8 command_upiu[ALIGNED_UPIU_SIZE]; 333 u8 response_upiu[ALIGNED_UPIU_SIZE]; 334 struct ufshcd_sg_entry prd_table[SG_ALL]; 335 }; 336 337 /** 338 * struct request_desc_header - Descriptor Header common to both UTRD and UTMRD 339 * @dword0: Descriptor Header DW0 340 * @dword1: Descriptor Header DW1 341 * @dword2: Descriptor Header DW2 342 * @dword3: Descriptor Header DW3 343 */ 344 struct request_desc_header { 345 __le32 dword_0; 346 __le32 dword_1; 347 __le32 dword_2; 348 __le32 dword_3; 349 }; 350 351 /** 352 * struct utp_transfer_req_desc - UTRD structure 353 * @header: UTRD header DW-0 to DW-3 354 * @command_desc_base_addr_lo: UCD base address low DW-4 355 * @command_desc_base_addr_hi: UCD base address high DW-5 356 * @response_upiu_length: response UPIU length DW-6 357 * @response_upiu_offset: response UPIU offset DW-6 358 * @prd_table_length: Physical region descriptor length DW-7 359 * @prd_table_offset: Physical region descriptor offset DW-7 360 */ 361 struct utp_transfer_req_desc { 362 363 /* DW 0-3 */ 364 struct request_desc_header header; 365 366 /* DW 4-5*/ 367 __le32 command_desc_base_addr_lo; 368 __le32 command_desc_base_addr_hi; 369 370 /* DW 6 */ 371 __le16 response_upiu_length; 372 __le16 response_upiu_offset; 373 374 /* DW 7 */ 375 __le16 prd_table_length; 376 __le16 prd_table_offset; 377 }; 378 379 /** 380 * struct utp_task_req_desc - UTMRD structure 381 * @header: UTMRD header DW-0 to DW-3 382 * @task_req_upiu: Pointer to task request UPIU DW-4 to DW-11 383 * @task_rsp_upiu: Pointer to task response UPIU DW12 to DW-19 384 */ 385 struct utp_task_req_desc { 386 387 /* DW 0-3 */ 388 struct request_desc_header header; 389 390 /* DW 4-11 */ 391 __le32 task_req_upiu[TASK_REQ_UPIU_SIZE_DWORDS]; 392 393 /* DW 12-19 */ 394 __le32 task_rsp_upiu[TASK_RSP_UPIU_SIZE_DWORDS]; 395 }; 396 397 #endif /* End of Header */ 398