[mirror_ubuntu-artful-kernel.git] / drivers / scsi / ufs / ufs.h

/*
 * Universal Flash Storage Host controller driver
 *
 * This code is based on drivers/scsi/ufs/ufs.h
 * Copyright (C) 2011-2013 Samsung India Software Operations
 *
 * Authors:
 *	Santosh Yaraganavi <santosh.sy@samsung.com>
 *	Vinayak Holikatti <h.vinayak@samsung.com>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * See the COPYING file in the top-level directory or visit
 * <http://www.gnu.org/licenses/gpl-2.0.html>
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * This program is provided "AS IS" and "WITH ALL FAULTS" and
 * without warranty of any kind. You are solely responsible for
 * determining the appropriateness of using and distributing
 * the program and assume all risks associated with your exercise
 * of rights with respect to the program, including but not limited
 * to infringement of third party rights, the risks and costs of
 * program errors, damage to or loss of data, programs or equipment,
 * and unavailability or interruption of operations. Under no
 * circumstances will the contributor of this Program be liable for
 * any damages of any kind arising from your use or distribution of
 * this program.
 */

#ifndef _UFS_H
#define _UFS_H

#include <linux/mutex.h>
#include <linux/types.h>

#define MAX_CDB_SIZE	16
#define GENERAL_UPIU_REQUEST_SIZE 32
#define QUERY_DESC_MAX_SIZE       256
#define QUERY_OSF_SIZE            (GENERAL_UPIU_REQUEST_SIZE - \
					(sizeof(struct utp_upiu_header)))

#define UPIU_HEADER_DWORD(byte3, byte2, byte1, byte0)\
			cpu_to_be32((byte3 << 24) | (byte2 << 16) |\
			 (byte1 << 8) | (byte0))

/*
 * UFS Protocol Information Unit related definitions
 */

/* Task management functions */
enum {
	UFS_ABORT_TASK		= 0x01,
	UFS_ABORT_TASK_SET	= 0x02,
	UFS_CLEAR_TASK_SET	= 0x04,
	UFS_LOGICAL_RESET	= 0x08,
	UFS_QUERY_TASK		= 0x80,
	UFS_QUERY_TASK_SET	= 0x81,
};

/* UTP UPIU Transaction Codes Initiator to Target */
enum {
	UPIU_TRANSACTION_NOP_OUT	= 0x00,
	UPIU_TRANSACTION_COMMAND	= 0x01,
	UPIU_TRANSACTION_DATA_OUT	= 0x02,
	UPIU_TRANSACTION_TASK_REQ	= 0x04,
	UPIU_TRANSACTION_QUERY_REQ	= 0x16,
};

/* UTP UPIU Transaction Codes Target to Initiator */
enum {
	UPIU_TRANSACTION_NOP_IN		= 0x20,
	UPIU_TRANSACTION_RESPONSE	= 0x21,
	UPIU_TRANSACTION_DATA_IN	= 0x22,
	UPIU_TRANSACTION_TASK_RSP	= 0x24,
	UPIU_TRANSACTION_READY_XFER	= 0x31,
	UPIU_TRANSACTION_QUERY_RSP	= 0x36,
	UPIU_TRANSACTION_REJECT_UPIU	= 0x3F,
};

/* UPIU Read/Write flags */
enum {
	UPIU_CMD_FLAGS_NONE	= 0x00,
	UPIU_CMD_FLAGS_WRITE	= 0x20,
	UPIU_CMD_FLAGS_READ	= 0x40,
};

/* UPIU Task Attributes */
enum {
	UPIU_TASK_ATTR_SIMPLE	= 0x00,
	UPIU_TASK_ATTR_ORDERED	= 0x01,
	UPIU_TASK_ATTR_HEADQ	= 0x02,
	UPIU_TASK_ATTR_ACA	= 0x03,
};

/* UPIU Query request function */
enum {
	UPIU_QUERY_FUNC_STANDARD_READ_REQUEST           = 0x01,
	UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST          = 0x81,
};

/* Flag idn for Query Requests*/
enum flag_idn {
	QUERY_FLAG_IDN_FDEVICEINIT      = 0x01,
	QUERY_FLAG_IDN_BKOPS_EN         = 0x04,
};

/* Attribute idn for Query requests */
enum attr_idn {
	QUERY_ATTR_IDN_BKOPS_STATUS	= 0x05,
	QUERY_ATTR_IDN_EE_CONTROL	= 0x0D,
	QUERY_ATTR_IDN_EE_STATUS	= 0x0E,
};

/* Exception event mask values */
enum {
	MASK_EE_STATUS		= 0xFFFF,
	MASK_EE_URGENT_BKOPS	= (1 << 2),
};

/* Background operation status */
enum {
	BKOPS_STATUS_NO_OP               = 0x0,
	BKOPS_STATUS_NON_CRITICAL        = 0x1,
	BKOPS_STATUS_PERF_IMPACT         = 0x2,
	BKOPS_STATUS_CRITICAL            = 0x3,
};

/* UTP QUERY Transaction Specific Fields OpCode */
enum query_opcode {
	UPIU_QUERY_OPCODE_NOP		= 0x0,
	UPIU_QUERY_OPCODE_READ_DESC	= 0x1,
	UPIU_QUERY_OPCODE_WRITE_DESC	= 0x2,
	UPIU_QUERY_OPCODE_READ_ATTR	= 0x3,
	UPIU_QUERY_OPCODE_WRITE_ATTR	= 0x4,
	UPIU_QUERY_OPCODE_READ_FLAG	= 0x5,
	UPIU_QUERY_OPCODE_SET_FLAG	= 0x6,
	UPIU_QUERY_OPCODE_CLEAR_FLAG	= 0x7,
	UPIU_QUERY_OPCODE_TOGGLE_FLAG	= 0x8,
};

/* Query response result code */
enum {
	QUERY_RESULT_SUCCESS                    = 0x00,
	QUERY_RESULT_NOT_READABLE               = 0xF6,
	QUERY_RESULT_NOT_WRITEABLE              = 0xF7,
	QUERY_RESULT_ALREADY_WRITTEN            = 0xF8,
	QUERY_RESULT_INVALID_LENGTH             = 0xF9,
	QUERY_RESULT_INVALID_VALUE              = 0xFA,
	QUERY_RESULT_INVALID_SELECTOR           = 0xFB,
	QUERY_RESULT_INVALID_INDEX              = 0xFC,
	QUERY_RESULT_INVALID_IDN                = 0xFD,
	QUERY_RESULT_INVALID_OPCODE             = 0xFE,
	QUERY_RESULT_GENERAL_FAILURE            = 0xFF,
};

/* UTP Transfer Request Command Type (CT) */
enum {
	UPIU_COMMAND_SET_TYPE_SCSI	= 0x0,
	UPIU_COMMAND_SET_TYPE_UFS	= 0x1,
	UPIU_COMMAND_SET_TYPE_QUERY	= 0x2,
};

/* UTP Transfer Request Command Offset */
#define UPIU_COMMAND_TYPE_OFFSET	28

/* Offset of the response code in the UPIU header */
#define UPIU_RSP_CODE_OFFSET		8

enum {
	MASK_SCSI_STATUS		= 0xFF,
	MASK_TASK_RESPONSE              = 0xFF00,
	MASK_RSP_UPIU_RESULT            = 0xFFFF,
	MASK_QUERY_DATA_SEG_LEN         = 0xFFFF,
	MASK_RSP_UPIU_DATA_SEG_LEN	= 0xFFFF,
	MASK_RSP_EXCEPTION_EVENT        = 0x10000,
};

/* Task management service response */
enum {
	UPIU_TASK_MANAGEMENT_FUNC_COMPL		= 0x00,
	UPIU_TASK_MANAGEMENT_FUNC_NOT_SUPPORTED = 0x04,
	UPIU_TASK_MANAGEMENT_FUNC_SUCCEEDED	= 0x08,
	UPIU_TASK_MANAGEMENT_FUNC_FAILED	= 0x05,
	UPIU_INCORRECT_LOGICAL_UNIT_NO		= 0x09,
};
/**
 * struct utp_upiu_header - UPIU header structure
 * @dword_0: UPIU header DW-0
 * @dword_1: UPIU header DW-1
 * @dword_2: UPIU header DW-2
 */
struct utp_upiu_header {
	u32 dword_0;
	u32 dword_1;
	u32 dword_2;
};

/**
 * struct utp_upiu_cmd - Command UPIU structure
 * @data_transfer_len: Data Transfer Length DW-3
 * @cdb: Command Descriptor Block CDB DW-4 to DW-7
 */
struct utp_upiu_cmd {
	u32 exp_data_transfer_len;
	u8 cdb[MAX_CDB_SIZE];
};

/**
 * struct utp_upiu_query - upiu request buffer structure for
 * query request.
 * @opcode: command to perform B-0
 * @idn: a value that indicates the particular type of data B-1
 * @index: Index to further identify data B-2
 * @selector: Index to further identify data B-3
 * @reserved_osf: spec reserved field B-4,5
 * @length: number of descriptor bytes to read/write B-6,7
 * @value: Attribute value to be written DW-5
 * @reserved: spec reserved DW-6,7
 */
struct utp_upiu_query {
	u8 opcode;
	u8 idn;
	u8 index;
	u8 selector;
	u16 reserved_osf;
	u16 length;
	u32 value;
	u32 reserved[2];
};

/**
 * struct utp_upiu_req - general upiu request structure
 * @header:UPIU header structure DW-0 to DW-2
 * @sc: fields structure for scsi command DW-3 to DW-7
 * @qr: fields structure for query request DW-3 to DW-7
 */
struct utp_upiu_req {
	struct utp_upiu_header header;
	union {
		struct utp_upiu_cmd sc;
		struct utp_upiu_query qr;
	};
};

/**
 * struct utp_cmd_rsp - Response UPIU structure
 * @residual_transfer_count: Residual transfer count DW-3
 * @reserved: Reserved double words DW-4 to DW-7
 * @sense_data_len: Sense data length DW-8 U16
 * @sense_data: Sense data field DW-8 to DW-12
 */
struct utp_cmd_rsp {
	u32 residual_transfer_count;
	u32 reserved[4];
	u16 sense_data_len;
	u8 sense_data[18];
};

/**
 * struct utp_upiu_rsp - general upiu response structure
 * @header: UPIU header structure DW-0 to DW-2
 * @sr: fields structure for scsi command DW-3 to DW-12
 * @qr: fields structure for query request DW-3 to DW-7
 */
struct utp_upiu_rsp {
	struct utp_upiu_header header;
	union {
		struct utp_cmd_rsp sr;
		struct utp_upiu_query qr;
	};
};

/**
 * struct utp_upiu_task_req - Task request UPIU structure
 * @header - UPIU header structure DW0 to DW-2
 * @input_param1: Input parameter 1 DW-3
 * @input_param2: Input parameter 2 DW-4
 * @input_param3: Input parameter 3 DW-5
 * @reserved: Reserved double words DW-6 to DW-7
 */
struct utp_upiu_task_req {
	struct utp_upiu_header header;
	u32 input_param1;
	u32 input_param2;
	u32 input_param3;
	u32 reserved[2];
};

/**
 * struct utp_upiu_task_rsp - Task Management Response UPIU structure
 * @header: UPIU header structure DW0-DW-2
 * @output_param1: Ouput parameter 1 DW3
 * @output_param2: Output parameter 2 DW4
 * @reserved: Reserved double words DW-5 to DW-7
 */
struct utp_upiu_task_rsp {
	struct utp_upiu_header header;
	u32 output_param1;
	u32 output_param2;
	u32 reserved[3];
};

/**
 * struct ufs_query_req - parameters for building a query request
 * @query_func: UPIU header query function
 * @upiu_req: the query request data
 */
struct ufs_query_req {
	u8 query_func;
	struct utp_upiu_query upiu_req;
};

/**
 * struct ufs_query_resp - UPIU QUERY
 * @response: device response code
 * @upiu_res: query response data
 */
struct ufs_query_res {
	u8 response;
	struct utp_upiu_query upiu_res;
};

#endif /* End of Header */
Commit	Line	Data
7a3e97b0 SY	1	/*
	2	* Universal Flash Storage Host controller driver
	3	*
	4	* This code is based on drivers/scsi/ufs/ufs.h
3b1d0580	5	* Copyright (C) 2011-2013 Samsung India Software Operations
7a3e97b0	6	*
3b1d0580 VH	7	* Authors:
	8	* Santosh Yaraganavi <santosh.sy@samsung.com>
	9	* Vinayak Holikatti <h.vinayak@samsung.com>
7a3e97b0 SY	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.
3b1d0580 VH	15	* See the COPYING file in the top-level directory or visit
3b1d0580 VH	16	* <http://www.gnu.org/licenses/gpl-2.0.html>
7a3e97b0 SY	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	*
3b1d0580 VH	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.
7a3e97b0 SY	34	*/
	35
	36	#ifndef _UFS_H
	37	#define _UFS_H
	38
5a0b0cb9 SRT	39	#include <linux/mutex.h>
	40	#include <linux/types.h>
	41
7a3e97b0	42	#define MAX_CDB_SIZE 16
68078d5c DR	43	#define GENERAL_UPIU_REQUEST_SIZE 32
	44	#define QUERY_DESC_MAX_SIZE 256
	45	#define QUERY_OSF_SIZE (GENERAL_UPIU_REQUEST_SIZE - \
	46	(sizeof(struct utp_upiu_header)))
7a3e97b0 SY	47
7a3e97b0 SY	48	#define UPIU_HEADER_DWORD(byte3, byte2, byte1, byte0)\
5a0b0cb9	49	cpu_to_be32((byte3 << 24) \| (byte2 << 16) \|\
7a3e97b0 SY	50	(byte1 << 8) \| (byte0))
	51
	52	/*
	53	* UFS Protocol Information Unit related definitions
	54	*/
	55
	56	/* Task management functions */
	57	enum {
	58	UFS_ABORT_TASK = 0x01,
	59	UFS_ABORT_TASK_SET = 0x02,
	60	UFS_CLEAR_TASK_SET = 0x04,
	61	UFS_LOGICAL_RESET = 0x08,
	62	UFS_QUERY_TASK = 0x80,
	63	UFS_QUERY_TASK_SET = 0x81,
	64	};
	65
	66	/* UTP UPIU Transaction Codes Initiator to Target */
	67	enum {
	68	UPIU_TRANSACTION_NOP_OUT = 0x00,
	69	UPIU_TRANSACTION_COMMAND = 0x01,
	70	UPIU_TRANSACTION_DATA_OUT = 0x02,
	71	UPIU_TRANSACTION_TASK_REQ = 0x04,
68078d5c	72	UPIU_TRANSACTION_QUERY_REQ = 0x16,
7a3e97b0 SY	73	};
	74
	75	/* UTP UPIU Transaction Codes Target to Initiator */
	76	enum {
	77	UPIU_TRANSACTION_NOP_IN = 0x20,
	78	UPIU_TRANSACTION_RESPONSE = 0x21,
	79	UPIU_TRANSACTION_DATA_IN = 0x22,
	80	UPIU_TRANSACTION_TASK_RSP = 0x24,
	81	UPIU_TRANSACTION_READY_XFER = 0x31,
	82	UPIU_TRANSACTION_QUERY_RSP = 0x36,
5a0b0cb9	83	UPIU_TRANSACTION_REJECT_UPIU = 0x3F,
7a3e97b0 SY	84	};
	85
	86	/* UPIU Read/Write flags */
	87	enum {
	88	UPIU_CMD_FLAGS_NONE = 0x00,
	89	UPIU_CMD_FLAGS_WRITE = 0x20,
	90	UPIU_CMD_FLAGS_READ = 0x40,
	91	};
	92
	93	/* UPIU Task Attributes */
	94	enum {
	95	UPIU_TASK_ATTR_SIMPLE = 0x00,
	96	UPIU_TASK_ATTR_ORDERED = 0x01,
	97	UPIU_TASK_ATTR_HEADQ = 0x02,
	98	UPIU_TASK_ATTR_ACA = 0x03,
	99	};
	100
68078d5c	101	/* UPIU Query request function */
7a3e97b0	102	enum {
68078d5c DR	103	UPIU_QUERY_FUNC_STANDARD_READ_REQUEST = 0x01,
	104	UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST = 0x81,
	105	};
	106
	107	/* Flag idn for Query Requests*/
	108	enum flag_idn {
	109	QUERY_FLAG_IDN_FDEVICEINIT = 0x01,
66ec6d59 SRT	110	QUERY_FLAG_IDN_BKOPS_EN = 0x04,
	111	};
	112
	113	/* Attribute idn for Query requests */
	114	enum attr_idn {
	115	QUERY_ATTR_IDN_BKOPS_STATUS = 0x05,
	116	QUERY_ATTR_IDN_EE_CONTROL = 0x0D,
	117	QUERY_ATTR_IDN_EE_STATUS = 0x0E,
	118	};
	119
	120	/* Exception event mask values */
	121	enum {
	122	MASK_EE_STATUS = 0xFFFF,
	123	MASK_EE_URGENT_BKOPS = (1 << 2),
	124	};
	125
	126	/* Background operation status */
	127	enum {
	128	BKOPS_STATUS_NO_OP = 0x0,
	129	BKOPS_STATUS_NON_CRITICAL = 0x1,
	130	BKOPS_STATUS_PERF_IMPACT = 0x2,
	131	BKOPS_STATUS_CRITICAL = 0x3,
68078d5c DR	132	};
	133
	134	/* UTP QUERY Transaction Specific Fields OpCode */
	135	enum query_opcode {
7a3e97b0 SY	136	UPIU_QUERY_OPCODE_NOP = 0x0,
	137	UPIU_QUERY_OPCODE_READ_DESC = 0x1,
	138	UPIU_QUERY_OPCODE_WRITE_DESC = 0x2,
	139	UPIU_QUERY_OPCODE_READ_ATTR = 0x3,
	140	UPIU_QUERY_OPCODE_WRITE_ATTR = 0x4,
	141	UPIU_QUERY_OPCODE_READ_FLAG = 0x5,
	142	UPIU_QUERY_OPCODE_SET_FLAG = 0x6,
	143	UPIU_QUERY_OPCODE_CLEAR_FLAG = 0x7,
	144	UPIU_QUERY_OPCODE_TOGGLE_FLAG = 0x8,
	145	};
	146
68078d5c DR	147	/* Query response result code */
	148	enum {
	149	QUERY_RESULT_SUCCESS = 0x00,
	150	QUERY_RESULT_NOT_READABLE = 0xF6,
	151	QUERY_RESULT_NOT_WRITEABLE = 0xF7,
	152	QUERY_RESULT_ALREADY_WRITTEN = 0xF8,
	153	QUERY_RESULT_INVALID_LENGTH = 0xF9,
	154	QUERY_RESULT_INVALID_VALUE = 0xFA,
	155	QUERY_RESULT_INVALID_SELECTOR = 0xFB,
	156	QUERY_RESULT_INVALID_INDEX = 0xFC,
	157	QUERY_RESULT_INVALID_IDN = 0xFD,
	158	QUERY_RESULT_INVALID_OPCODE = 0xFE,
	159	QUERY_RESULT_GENERAL_FAILURE = 0xFF,
	160	};
	161
7a3e97b0 SY	162	/* UTP Transfer Request Command Type (CT) */
	163	enum {
	164	UPIU_COMMAND_SET_TYPE_SCSI = 0x0,
	165	UPIU_COMMAND_SET_TYPE_UFS = 0x1,
	166	UPIU_COMMAND_SET_TYPE_QUERY = 0x2,
	167	};
	168
5a0b0cb9 SRT	169	/* UTP Transfer Request Command Offset */
	170	#define UPIU_COMMAND_TYPE_OFFSET 28
	171
	172	/* Offset of the response code in the UPIU header */
	173	#define UPIU_RSP_CODE_OFFSET 8
	174
7a3e97b0	175	enum {
68078d5c DR	176	MASK_SCSI_STATUS = 0xFF,
	177	MASK_TASK_RESPONSE = 0xFF00,
	178	MASK_RSP_UPIU_RESULT = 0xFFFF,
	179	MASK_QUERY_DATA_SEG_LEN = 0xFFFF,
1c2623c5	180	MASK_RSP_UPIU_DATA_SEG_LEN = 0xFFFF,
66ec6d59	181	MASK_RSP_EXCEPTION_EVENT = 0x10000,
7a3e97b0 SY	182	};
	183
	184	/* Task management service response */
	185	enum {
	186	UPIU_TASK_MANAGEMENT_FUNC_COMPL = 0x00,
	187	UPIU_TASK_MANAGEMENT_FUNC_NOT_SUPPORTED = 0x04,
	188	UPIU_TASK_MANAGEMENT_FUNC_SUCCEEDED = 0x08,
	189	UPIU_TASK_MANAGEMENT_FUNC_FAILED = 0x05,
	190	UPIU_INCORRECT_LOGICAL_UNIT_NO = 0x09,
	191	};
	192	/**
	193	* struct utp_upiu_header - UPIU header structure
	194	* @dword_0: UPIU header DW-0
	195	* @dword_1: UPIU header DW-1
	196	* @dword_2: UPIU header DW-2
	197	*/
	198	struct utp_upiu_header {
	199	u32 dword_0;
	200	u32 dword_1;
	201	u32 dword_2;
	202	};
	203
	204	/**
	205	* struct utp_upiu_cmd - Command UPIU structure
7a3e97b0 SY	206	* @data_transfer_len: Data Transfer Length DW-3
	207	* @cdb: Command Descriptor Block CDB DW-4 to DW-7
	208	*/
	209	struct utp_upiu_cmd {
7a3e97b0 SY	210	u32 exp_data_transfer_len;
	211	u8 cdb[MAX_CDB_SIZE];
	212	};
	213
68078d5c DR	214	/**
	215	* struct utp_upiu_query - upiu request buffer structure for
	216	* query request.
	217	* @opcode: command to perform B-0
	218	* @idn: a value that indicates the particular type of data B-1
	219	* @index: Index to further identify data B-2
	220	* @selector: Index to further identify data B-3
	221	* @reserved_osf: spec reserved field B-4,5
	222	* @length: number of descriptor bytes to read/write B-6,7
	223	* @value: Attribute value to be written DW-5
	224	* @reserved: spec reserved DW-6,7
	225	*/
	226	struct utp_upiu_query {
	227	u8 opcode;
	228	u8 idn;
	229	u8 index;
	230	u8 selector;
	231	u16 reserved_osf;
	232	u16 length;
	233	u32 value;
	234	u32 reserved[2];
	235	};
	236
7a3e97b0	237	/**
5a0b0cb9 SRT	238	* struct utp_upiu_req - general upiu request structure
	239	* @header:UPIU header structure DW-0 to DW-2
	240	* @sc: fields structure for scsi command DW-3 to DW-7
68078d5c	241	* @qr: fields structure for query request DW-3 to DW-7
5a0b0cb9 SRT	242	*/
	243	struct utp_upiu_req {
	244	struct utp_upiu_header header;
68078d5c DR	245	union {
	246	struct utp_upiu_cmd sc;
	247	struct utp_upiu_query qr;
	248	};
5a0b0cb9 SRT	249	};
	250
	251	/**
	252	* struct utp_cmd_rsp - Response UPIU structure
7a3e97b0 SY	253	* @residual_transfer_count: Residual transfer count DW-3
	254	* @reserved: Reserved double words DW-4 to DW-7
	255	* @sense_data_len: Sense data length DW-8 U16
	256	* @sense_data: Sense data field DW-8 to DW-12
	257	*/
5a0b0cb9	258	struct utp_cmd_rsp {
7a3e97b0 SY	259	u32 residual_transfer_count;
	260	u32 reserved[4];
	261	u16 sense_data_len;
	262	u8 sense_data[18];
	263	};
	264
5a0b0cb9 SRT	265	/**
	266	* struct utp_upiu_rsp - general upiu response structure
	267	* @header: UPIU header structure DW-0 to DW-2
	268	* @sr: fields structure for scsi command DW-3 to DW-12
68078d5c	269	* @qr: fields structure for query request DW-3 to DW-7
5a0b0cb9 SRT	270	*/
	271	struct utp_upiu_rsp {
	272	struct utp_upiu_header header;
68078d5c DR	273	union {
	274	struct utp_cmd_rsp sr;
	275	struct utp_upiu_query qr;
	276	};
5a0b0cb9 SRT	277	};
5a0b0cb9 SRT	278
7a3e97b0 SY	279	/**
	280	* struct utp_upiu_task_req - Task request UPIU structure
	281	* @header - UPIU header structure DW0 to DW-2
	282	* @input_param1: Input parameter 1 DW-3
	283	* @input_param2: Input parameter 2 DW-4
	284	* @input_param3: Input parameter 3 DW-5
	285	* @reserved: Reserved double words DW-6 to DW-7
	286	*/
	287	struct utp_upiu_task_req {
	288	struct utp_upiu_header header;
	289	u32 input_param1;
	290	u32 input_param2;
	291	u32 input_param3;
	292	u32 reserved[2];
	293	};
	294
	295	/**
	296	* struct utp_upiu_task_rsp - Task Management Response UPIU structure
	297	* @header: UPIU header structure DW0-DW-2
	298	* @output_param1: Ouput parameter 1 DW3
	299	* @output_param2: Output parameter 2 DW4
	300	* @reserved: Reserved double words DW-5 to DW-7
	301	*/
	302	struct utp_upiu_task_rsp {
	303	struct utp_upiu_header header;
	304	u32 output_param1;
	305	u32 output_param2;
	306	u32 reserved[3];
	307	};
	308
68078d5c DR	309	/**
	310	* struct ufs_query_req - parameters for building a query request
	311	* @query_func: UPIU header query function
	312	* @upiu_req: the query request data
	313	*/
	314	struct ufs_query_req {
	315	u8 query_func;
	316	struct utp_upiu_query upiu_req;
	317	};
	318
	319	/**
	320	* struct ufs_query_resp - UPIU QUERY
	321	* @response: device response code
	322	* @upiu_res: query response data
	323	*/
	324	struct ufs_query_res {
	325	u8 response;
	326	struct utp_upiu_query upiu_res;
	327	};
	328
7a3e97b0	329	#endif /* End of Header */