drivers/ufs/ufs.h

1 /* SPDX-License-Identifier: GPL-2.0+ */
21 /* UFS device power modes */
24 	UFS_SLEEP_PWR_MODE	= 2,
120 /* The granularity of the data byte count field in the PRDT is 32-bit */
125 #define QUERY_DESC_MIN_SIZE       2
126 #define QUERY_DESC_HDR_SIZE       2
127 #define QUERY_OSF_SIZE            (GENERAL_UPIU_REQUEST_SIZE - \
134  * UFS Protocol Information Unit related definitions
307  * struct utp_transfer_cmd_desc - UFS Command Descriptor structure
319  * struct request_desc_header - Descriptor Header common to both UTRD and UTMRD
333  * struct utp_transfer_req_desc - UTRD structure
334  * @header: UTRD header DW-0 to DW-3
335  * @command_desc_base_addr_lo: UCD base address low DW-4
336  * @command_desc_base_addr_hi: UCD base address high DW-5
337  * @response_upiu_length: response UPIU length DW-6
338  * @response_upiu_offset: response UPIU offset DW-6
339  * @prd_table_length: Physical region descriptor length DW-7
340  * @prd_table_offset: Physical region descriptor offset DW-7
343 	/* DW 0-3 */
346 	/* DW 4-5*/
360  * struct utp_upiu_header - UPIU header structure
361  * @dword_0: UPIU header DW-0
362  * @dword_1: UPIU header DW-1
363  * @dword_2: UPIU header DW-2
372  * struct utp_upiu_query - upiu request buffer structure for
374  * @opcode: command to perform B-0
375  * @idn: a value that indicates the particular type of data B-1
376  * @index: Index to further identify data B-2
377  * @selector: Index to further identify data B-3
378  * @reserved_osf: spec reserved field B-4,5
379  * @length: number of descriptor bytes to read/write B-6,7
380  * @value: Attribute value to be written DW-5
381  * @reserved: spec reserved DW-6,7
391 	__be32 reserved[2];
395  * struct utp_upiu_cmd - Command UPIU structure
396  * @data_transfer_len: Data Transfer Length DW-3
397  * @cdb: Command Descriptor Block CDB DW-4 to DW-7
408 	/* DW 0-3 */
411 	/* DW 4-11 - Task request UPIU structure */
416 	__be32			__reserved1[2];
418 	/* DW 12-19 - Task Management Response UPIU structure */
426  * struct utp_upiu_req - general upiu request structure
427  * @header:UPIU header structure DW-0 to DW-2
428  * @sc: fields structure for scsi command DW-3 to DW-7
429  * @qr: fields structure for query request DW-3 to DW-7
443  * struct utp_cmd_rsp - Response UPIU structure
444  * @residual_transfer_count: Residual transfer count DW-3
445  * @reserved: Reserved double words DW-4 to DW-7
446  * @sense_data_len: Sense data length DW-8 U16
447  * @sense_data: Sense data field DW-8 to DW-12
457  * struct utp_upiu_rsp - general upiu response structure
458  * @header: UPIU header structure DW-0 to DW-2
459  * @sr: fields structure for scsi command DW-3 to DW-12
460  * @qr: fields structure for query request DW-3 to DW-7
472  * ufs_dev_desc - ufs device details from the device descriptor
534  * struct uic_command - UIC command structure
537  * @argument2: UIC command argument 2
552 /* GenSelectorIndex calculation macros for M-PHY attributes */
565 	UFSHCD_LINK_IS_UP	= 2,
609 /* Host <-> Device UniPro Link state */
613 	UIC_LINK_HIBERN8_STATE	= 2, /* Link is in Hibernate state */
654  * struct ufs_query_req - parameters for building a query request
664  * struct ufs_query_resp - UPIU QUERY
674  * struct ufs_query - holds relevant data structures for query request
686  * struct ufs_dev_cmd - all assosiated fields with device management commands
687  * @type: device management command type - Query, NOP OUT
714  * If UFS host controller is having issue in processing LCC (Line
717  * the LCC transmission on UFS device (by clearing TX_LCC_ENABLE
742 	if (hba->ops && hba->ops->init)  in ufshcd_ops_init()
743 		return hba->ops->init(hba);  in ufshcd_ops_init()
751 	if (hba->ops && hba->ops->hce_enable_notify)  in ufshcd_ops_hce_enable_notify()
752 		return hba->ops->hce_enable_notify(hba, status);  in ufshcd_ops_hce_enable_notify()
760 	if (hba->ops && hba->ops->link_startup_notify)  in ufshcd_ops_link_startup_notify()
761 		return hba->ops->link_startup_notify(hba, status);  in ufshcd_ops_link_startup_notify()
871 /* HCS - Host Controller Status 30h */
893 /* UICCMD - UIC Command */
905 	writel((val), (hba)->mmio_base + (reg))
907 	readl((hba)->mmio_base + (reg))
909 /* UTRLRSR - UTP Transfer Request Run-Stop Register 60h */
912 /* UTMRLRSR - UTP Task Management Request Run-Stop Register 80h */