Linux-libre 4.9.135-gnu
[librecmc/linux-libre.git] / drivers / scsi / ufs / ufs.h
1 /*
2  * Universal Flash Storage Host controller driver
3  *
4  * This code is based on drivers/scsi/ufs/ufs.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 _UFS_H
37 #define _UFS_H
38
39 #include <linux/mutex.h>
40 #include <linux/types.h>
41
42 #define MAX_CDB_SIZE    16
43 #define GENERAL_UPIU_REQUEST_SIZE 32
44 #define QUERY_DESC_MAX_SIZE       255
45 #define QUERY_DESC_MIN_SIZE       2
46 #define QUERY_DESC_HDR_SIZE       2
47 #define QUERY_OSF_SIZE            (GENERAL_UPIU_REQUEST_SIZE - \
48                                         (sizeof(struct utp_upiu_header)))
49
50 #define UPIU_HEADER_DWORD(byte3, byte2, byte1, byte0)\
51                         cpu_to_be32((byte3 << 24) | (byte2 << 16) |\
52                          (byte1 << 8) | (byte0))
53 /*
54  * UFS device may have standard LUs and LUN id could be from 0x00 to
55  * 0x7F. Standard LUs use "Peripheral Device Addressing Format".
56  * UFS device may also have the Well Known LUs (also referred as W-LU)
57  * which again could be from 0x00 to 0x7F. For W-LUs, device only use
58  * the "Extended Addressing Format" which means the W-LUNs would be
59  * from 0xc100 (SCSI_W_LUN_BASE) onwards.
60  * This means max. LUN number reported from UFS device could be 0xC17F.
61  */
62 #define UFS_UPIU_MAX_UNIT_NUM_ID        0x7F
63 #define UFS_MAX_LUNS            (SCSI_W_LUN_BASE + UFS_UPIU_MAX_UNIT_NUM_ID)
64 #define UFS_UPIU_WLUN_ID        (1 << 7)
65 #define UFS_UPIU_MAX_GENERAL_LUN        8
66
67 /* Well known logical unit id in LUN field of UPIU */
68 enum {
69         UFS_UPIU_REPORT_LUNS_WLUN       = 0x81,
70         UFS_UPIU_UFS_DEVICE_WLUN        = 0xD0,
71         UFS_UPIU_BOOT_WLUN              = 0xB0,
72         UFS_UPIU_RPMB_WLUN              = 0xC4,
73 };
74
75 /*
76  * UFS Protocol Information Unit related definitions
77  */
78
79 /* Task management functions */
80 enum {
81         UFS_ABORT_TASK          = 0x01,
82         UFS_ABORT_TASK_SET      = 0x02,
83         UFS_CLEAR_TASK_SET      = 0x04,
84         UFS_LOGICAL_RESET       = 0x08,
85         UFS_QUERY_TASK          = 0x80,
86         UFS_QUERY_TASK_SET      = 0x81,
87 };
88
89 /* UTP UPIU Transaction Codes Initiator to Target */
90 enum {
91         UPIU_TRANSACTION_NOP_OUT        = 0x00,
92         UPIU_TRANSACTION_COMMAND        = 0x01,
93         UPIU_TRANSACTION_DATA_OUT       = 0x02,
94         UPIU_TRANSACTION_TASK_REQ       = 0x04,
95         UPIU_TRANSACTION_QUERY_REQ      = 0x16,
96 };
97
98 /* UTP UPIU Transaction Codes Target to Initiator */
99 enum {
100         UPIU_TRANSACTION_NOP_IN         = 0x20,
101         UPIU_TRANSACTION_RESPONSE       = 0x21,
102         UPIU_TRANSACTION_DATA_IN        = 0x22,
103         UPIU_TRANSACTION_TASK_RSP       = 0x24,
104         UPIU_TRANSACTION_READY_XFER     = 0x31,
105         UPIU_TRANSACTION_QUERY_RSP      = 0x36,
106         UPIU_TRANSACTION_REJECT_UPIU    = 0x3F,
107 };
108
109 /* UPIU Read/Write flags */
110 enum {
111         UPIU_CMD_FLAGS_NONE     = 0x00,
112         UPIU_CMD_FLAGS_WRITE    = 0x20,
113         UPIU_CMD_FLAGS_READ     = 0x40,
114 };
115
116 /* UPIU Task Attributes */
117 enum {
118         UPIU_TASK_ATTR_SIMPLE   = 0x00,
119         UPIU_TASK_ATTR_ORDERED  = 0x01,
120         UPIU_TASK_ATTR_HEADQ    = 0x02,
121         UPIU_TASK_ATTR_ACA      = 0x03,
122 };
123
124 /* UPIU Query request function */
125 enum {
126         UPIU_QUERY_FUNC_STANDARD_READ_REQUEST           = 0x01,
127         UPIU_QUERY_FUNC_STANDARD_WRITE_REQUEST          = 0x81,
128 };
129
130 /* Flag idn for Query Requests*/
131 enum flag_idn {
132         QUERY_FLAG_IDN_FDEVICEINIT      = 0x01,
133         QUERY_FLAG_IDN_PWR_ON_WPE       = 0x03,
134         QUERY_FLAG_IDN_BKOPS_EN         = 0x04,
135 };
136
137 /* Attribute idn for Query requests */
138 enum attr_idn {
139         QUERY_ATTR_IDN_ACTIVE_ICC_LVL   = 0x03,
140         QUERY_ATTR_IDN_BKOPS_STATUS     = 0x05,
141         QUERY_ATTR_IDN_EE_CONTROL       = 0x0D,
142         QUERY_ATTR_IDN_EE_STATUS        = 0x0E,
143 };
144
145 /* Descriptor idn for Query requests */
146 enum desc_idn {
147         QUERY_DESC_IDN_DEVICE           = 0x0,
148         QUERY_DESC_IDN_CONFIGURATION    = 0x1,
149         QUERY_DESC_IDN_UNIT             = 0x2,
150         QUERY_DESC_IDN_RFU_0            = 0x3,
151         QUERY_DESC_IDN_INTERCONNECT     = 0x4,
152         QUERY_DESC_IDN_STRING           = 0x5,
153         QUERY_DESC_IDN_RFU_1            = 0x6,
154         QUERY_DESC_IDN_GEOMETRY         = 0x7,
155         QUERY_DESC_IDN_POWER            = 0x8,
156         QUERY_DESC_IDN_MAX,
157 };
158
159 enum desc_header_offset {
160         QUERY_DESC_LENGTH_OFFSET        = 0x00,
161         QUERY_DESC_DESC_TYPE_OFFSET     = 0x01,
162 };
163
164 enum ufs_desc_def_size {
165         QUERY_DESC_DEVICE_DEF_SIZE              = 0x40,
166         QUERY_DESC_CONFIGURATION_DEF_SIZE       = 0x90,
167         QUERY_DESC_UNIT_DEF_SIZE                = 0x23,
168         QUERY_DESC_INTERCONNECT_DEF_SIZE        = 0x06,
169         QUERY_DESC_GEOMETRY_DEF_SIZE            = 0x44,
170         QUERY_DESC_POWER_DEF_SIZE               = 0x62,
171 };
172
173 /* Unit descriptor parameters offsets in bytes*/
174 enum unit_desc_param {
175         UNIT_DESC_PARAM_LEN                     = 0x0,
176         UNIT_DESC_PARAM_TYPE                    = 0x1,
177         UNIT_DESC_PARAM_UNIT_INDEX              = 0x2,
178         UNIT_DESC_PARAM_LU_ENABLE               = 0x3,
179         UNIT_DESC_PARAM_BOOT_LUN_ID             = 0x4,
180         UNIT_DESC_PARAM_LU_WR_PROTECT           = 0x5,
181         UNIT_DESC_PARAM_LU_Q_DEPTH              = 0x6,
182         UNIT_DESC_PARAM_MEM_TYPE                = 0x8,
183         UNIT_DESC_PARAM_DATA_RELIABILITY        = 0x9,
184         UNIT_DESC_PARAM_LOGICAL_BLK_SIZE        = 0xA,
185         UNIT_DESC_PARAM_LOGICAL_BLK_COUNT       = 0xB,
186         UNIT_DESC_PARAM_ERASE_BLK_SIZE          = 0x13,
187         UNIT_DESC_PARAM_PROVISIONING_TYPE       = 0x17,
188         UNIT_DESC_PARAM_PHY_MEM_RSRC_CNT        = 0x18,
189         UNIT_DESC_PARAM_CTX_CAPABILITIES        = 0x20,
190         UNIT_DESC_PARAM_LARGE_UNIT_SIZE_M1      = 0x22,
191 };
192
193 /* Device descriptor parameters offsets in bytes*/
194 enum device_desc_param {
195         DEVICE_DESC_PARAM_LEN                   = 0x0,
196         DEVICE_DESC_PARAM_TYPE                  = 0x1,
197         DEVICE_DESC_PARAM_DEVICE_TYPE           = 0x2,
198         DEVICE_DESC_PARAM_DEVICE_CLASS          = 0x3,
199         DEVICE_DESC_PARAM_DEVICE_SUB_CLASS      = 0x4,
200         DEVICE_DESC_PARAM_PRTCL                 = 0x5,
201         DEVICE_DESC_PARAM_NUM_LU                = 0x6,
202         DEVICE_DESC_PARAM_NUM_WLU               = 0x7,
203         DEVICE_DESC_PARAM_BOOT_ENBL             = 0x8,
204         DEVICE_DESC_PARAM_DESC_ACCSS_ENBL       = 0x9,
205         DEVICE_DESC_PARAM_INIT_PWR_MODE         = 0xA,
206         DEVICE_DESC_PARAM_HIGH_PR_LUN           = 0xB,
207         DEVICE_DESC_PARAM_SEC_RMV_TYPE          = 0xC,
208         DEVICE_DESC_PARAM_SEC_LU                = 0xD,
209         DEVICE_DESC_PARAM_BKOP_TERM_LT          = 0xE,
210         DEVICE_DESC_PARAM_ACTVE_ICC_LVL         = 0xF,
211         DEVICE_DESC_PARAM_SPEC_VER              = 0x10,
212         DEVICE_DESC_PARAM_MANF_DATE             = 0x12,
213         DEVICE_DESC_PARAM_MANF_NAME             = 0x14,
214         DEVICE_DESC_PARAM_PRDCT_NAME            = 0x15,
215         DEVICE_DESC_PARAM_SN                    = 0x16,
216         DEVICE_DESC_PARAM_OEM_ID                = 0x17,
217         DEVICE_DESC_PARAM_MANF_ID               = 0x18,
218         DEVICE_DESC_PARAM_UD_OFFSET             = 0x1A,
219         DEVICE_DESC_PARAM_UD_LEN                = 0x1B,
220         DEVICE_DESC_PARAM_RTT_CAP               = 0x1C,
221         DEVICE_DESC_PARAM_FRQ_RTC               = 0x1D,
222 };
223
224 /*
225  * Logical Unit Write Protect
226  * 00h: LU not write protected
227  * 01h: LU write protected when fPowerOnWPEn =1
228  * 02h: LU permanently write protected when fPermanentWPEn =1
229  */
230 enum ufs_lu_wp_type {
231         UFS_LU_NO_WP            = 0x00,
232         UFS_LU_POWER_ON_WP      = 0x01,
233         UFS_LU_PERM_WP          = 0x02,
234 };
235
236 /* bActiveICCLevel parameter current units */
237 enum {
238         UFSHCD_NANO_AMP         = 0,
239         UFSHCD_MICRO_AMP        = 1,
240         UFSHCD_MILI_AMP         = 2,
241         UFSHCD_AMP              = 3,
242 };
243
244 #define POWER_DESC_MAX_SIZE                     0x62
245 #define POWER_DESC_MAX_ACTV_ICC_LVLS            16
246
247 /* Attribute  bActiveICCLevel parameter bit masks definitions */
248 #define ATTR_ICC_LVL_UNIT_OFFSET        14
249 #define ATTR_ICC_LVL_UNIT_MASK          (0x3 << ATTR_ICC_LVL_UNIT_OFFSET)
250 #define ATTR_ICC_LVL_VALUE_MASK         0x3FF
251
252 /* Power descriptor parameters offsets in bytes */
253 enum power_desc_param_offset {
254         PWR_DESC_LEN                    = 0x0,
255         PWR_DESC_TYPE                   = 0x1,
256         PWR_DESC_ACTIVE_LVLS_VCC_0      = 0x2,
257         PWR_DESC_ACTIVE_LVLS_VCCQ_0     = 0x22,
258         PWR_DESC_ACTIVE_LVLS_VCCQ2_0    = 0x42,
259 };
260
261 /* Exception event mask values */
262 enum {
263         MASK_EE_STATUS          = 0xFFFF,
264         MASK_EE_URGENT_BKOPS    = (1 << 2),
265 };
266
267 /* Background operation status */
268 enum bkops_status {
269         BKOPS_STATUS_NO_OP               = 0x0,
270         BKOPS_STATUS_NON_CRITICAL        = 0x1,
271         BKOPS_STATUS_PERF_IMPACT         = 0x2,
272         BKOPS_STATUS_CRITICAL            = 0x3,
273         BKOPS_STATUS_MAX                 = BKOPS_STATUS_CRITICAL,
274 };
275
276 /* UTP QUERY Transaction Specific Fields OpCode */
277 enum query_opcode {
278         UPIU_QUERY_OPCODE_NOP           = 0x0,
279         UPIU_QUERY_OPCODE_READ_DESC     = 0x1,
280         UPIU_QUERY_OPCODE_WRITE_DESC    = 0x2,
281         UPIU_QUERY_OPCODE_READ_ATTR     = 0x3,
282         UPIU_QUERY_OPCODE_WRITE_ATTR    = 0x4,
283         UPIU_QUERY_OPCODE_READ_FLAG     = 0x5,
284         UPIU_QUERY_OPCODE_SET_FLAG      = 0x6,
285         UPIU_QUERY_OPCODE_CLEAR_FLAG    = 0x7,
286         UPIU_QUERY_OPCODE_TOGGLE_FLAG   = 0x8,
287 };
288
289 /* Query response result code */
290 enum {
291         QUERY_RESULT_SUCCESS                    = 0x00,
292         QUERY_RESULT_NOT_READABLE               = 0xF6,
293         QUERY_RESULT_NOT_WRITEABLE              = 0xF7,
294         QUERY_RESULT_ALREADY_WRITTEN            = 0xF8,
295         QUERY_RESULT_INVALID_LENGTH             = 0xF9,
296         QUERY_RESULT_INVALID_VALUE              = 0xFA,
297         QUERY_RESULT_INVALID_SELECTOR           = 0xFB,
298         QUERY_RESULT_INVALID_INDEX              = 0xFC,
299         QUERY_RESULT_INVALID_IDN                = 0xFD,
300         QUERY_RESULT_INVALID_OPCODE             = 0xFE,
301         QUERY_RESULT_GENERAL_FAILURE            = 0xFF,
302 };
303
304 /* UTP Transfer Request Command Type (CT) */
305 enum {
306         UPIU_COMMAND_SET_TYPE_SCSI      = 0x0,
307         UPIU_COMMAND_SET_TYPE_UFS       = 0x1,
308         UPIU_COMMAND_SET_TYPE_QUERY     = 0x2,
309 };
310
311 /* UTP Transfer Request Command Offset */
312 #define UPIU_COMMAND_TYPE_OFFSET        28
313
314 /* Offset of the response code in the UPIU header */
315 #define UPIU_RSP_CODE_OFFSET            8
316
317 enum {
318         MASK_SCSI_STATUS                = 0xFF,
319         MASK_TASK_RESPONSE              = 0xFF00,
320         MASK_RSP_UPIU_RESULT            = 0xFFFF,
321         MASK_QUERY_DATA_SEG_LEN         = 0xFFFF,
322         MASK_RSP_UPIU_DATA_SEG_LEN      = 0xFFFF,
323         MASK_RSP_EXCEPTION_EVENT        = 0x10000,
324         MASK_TM_SERVICE_RESP            = 0xFF,
325 };
326
327 /* Task management service response */
328 enum {
329         UPIU_TASK_MANAGEMENT_FUNC_COMPL         = 0x00,
330         UPIU_TASK_MANAGEMENT_FUNC_NOT_SUPPORTED = 0x04,
331         UPIU_TASK_MANAGEMENT_FUNC_SUCCEEDED     = 0x08,
332         UPIU_TASK_MANAGEMENT_FUNC_FAILED        = 0x05,
333         UPIU_INCORRECT_LOGICAL_UNIT_NO          = 0x09,
334 };
335
336 /* UFS device power modes */
337 enum ufs_dev_pwr_mode {
338         UFS_ACTIVE_PWR_MODE     = 1,
339         UFS_SLEEP_PWR_MODE      = 2,
340         UFS_POWERDOWN_PWR_MODE  = 3,
341 };
342
343 /**
344  * struct utp_upiu_header - UPIU header structure
345  * @dword_0: UPIU header DW-0
346  * @dword_1: UPIU header DW-1
347  * @dword_2: UPIU header DW-2
348  */
349 struct utp_upiu_header {
350         __be32 dword_0;
351         __be32 dword_1;
352         __be32 dword_2;
353 };
354
355 /**
356  * struct utp_upiu_cmd - Command UPIU structure
357  * @data_transfer_len: Data Transfer Length DW-3
358  * @cdb: Command Descriptor Block CDB DW-4 to DW-7
359  */
360 struct utp_upiu_cmd {
361         __be32 exp_data_transfer_len;
362         u8 cdb[MAX_CDB_SIZE];
363 };
364
365 /**
366  * struct utp_upiu_query - upiu request buffer structure for
367  * query request.
368  * @opcode: command to perform B-0
369  * @idn: a value that indicates the particular type of data B-1
370  * @index: Index to further identify data B-2
371  * @selector: Index to further identify data B-3
372  * @reserved_osf: spec reserved field B-4,5
373  * @length: number of descriptor bytes to read/write B-6,7
374  * @value: Attribute value to be written DW-5
375  * @reserved: spec reserved DW-6,7
376  */
377 struct utp_upiu_query {
378         u8 opcode;
379         u8 idn;
380         u8 index;
381         u8 selector;
382         __be16 reserved_osf;
383         __be16 length;
384         __be32 value;
385         __be32 reserved[2];
386 };
387
388 /**
389  * struct utp_upiu_req - general upiu request structure
390  * @header:UPIU header structure DW-0 to DW-2
391  * @sc: fields structure for scsi command DW-3 to DW-7
392  * @qr: fields structure for query request DW-3 to DW-7
393  */
394 struct utp_upiu_req {
395         struct utp_upiu_header header;
396         union {
397                 struct utp_upiu_cmd sc;
398                 struct utp_upiu_query qr;
399         };
400 };
401
402 /**
403  * struct utp_cmd_rsp - Response UPIU structure
404  * @residual_transfer_count: Residual transfer count DW-3
405  * @reserved: Reserved double words DW-4 to DW-7
406  * @sense_data_len: Sense data length DW-8 U16
407  * @sense_data: Sense data field DW-8 to DW-12
408  */
409 struct utp_cmd_rsp {
410         __be32 residual_transfer_count;
411         __be32 reserved[4];
412         __be16 sense_data_len;
413         u8 sense_data[18];
414 };
415
416 /**
417  * struct utp_upiu_rsp - general upiu response structure
418  * @header: UPIU header structure DW-0 to DW-2
419  * @sr: fields structure for scsi command DW-3 to DW-12
420  * @qr: fields structure for query request DW-3 to DW-7
421  */
422 struct utp_upiu_rsp {
423         struct utp_upiu_header header;
424         union {
425                 struct utp_cmd_rsp sr;
426                 struct utp_upiu_query qr;
427         };
428 };
429
430 /**
431  * struct utp_upiu_task_req - Task request UPIU structure
432  * @header - UPIU header structure DW0 to DW-2
433  * @input_param1: Input parameter 1 DW-3
434  * @input_param2: Input parameter 2 DW-4
435  * @input_param3: Input parameter 3 DW-5
436  * @reserved: Reserved double words DW-6 to DW-7
437  */
438 struct utp_upiu_task_req {
439         struct utp_upiu_header header;
440         __be32 input_param1;
441         __be32 input_param2;
442         __be32 input_param3;
443         __be32 reserved[2];
444 };
445
446 /**
447  * struct utp_upiu_task_rsp - Task Management Response UPIU structure
448  * @header: UPIU header structure DW0-DW-2
449  * @output_param1: Ouput parameter 1 DW3
450  * @output_param2: Output parameter 2 DW4
451  * @reserved: Reserved double words DW-5 to DW-7
452  */
453 struct utp_upiu_task_rsp {
454         struct utp_upiu_header header;
455         __be32 output_param1;
456         __be32 output_param2;
457         __be32 reserved[3];
458 };
459
460 /**
461  * struct ufs_query_req - parameters for building a query request
462  * @query_func: UPIU header query function
463  * @upiu_req: the query request data
464  */
465 struct ufs_query_req {
466         u8 query_func;
467         struct utp_upiu_query upiu_req;
468 };
469
470 /**
471  * struct ufs_query_resp - UPIU QUERY
472  * @response: device response code
473  * @upiu_res: query response data
474  */
475 struct ufs_query_res {
476         u8 response;
477         struct utp_upiu_query upiu_res;
478 };
479
480 #define UFS_VREG_VCC_MIN_UV        2700000 /* uV */
481 #define UFS_VREG_VCC_MAX_UV        3600000 /* uV */
482 #define UFS_VREG_VCC_1P8_MIN_UV    1700000 /* uV */
483 #define UFS_VREG_VCC_1P8_MAX_UV    1950000 /* uV */
484 #define UFS_VREG_VCCQ_MIN_UV       1100000 /* uV */
485 #define UFS_VREG_VCCQ_MAX_UV       1300000 /* uV */
486 #define UFS_VREG_VCCQ2_MIN_UV      1650000 /* uV */
487 #define UFS_VREG_VCCQ2_MAX_UV      1950000 /* uV */
488
489 /*
490  * VCCQ & VCCQ2 current requirement when UFS device is in sleep state
491  * and link is in Hibern8 state.
492  */
493 #define UFS_VREG_LPM_LOAD_UA    1000 /* uA */
494
495 struct ufs_vreg {
496         struct regulator *reg;
497         const char *name;
498         bool enabled;
499         bool unused;
500         int min_uV;
501         int max_uV;
502         int min_uA;
503         int max_uA;
504 };
505
506 struct ufs_vreg_info {
507         struct ufs_vreg *vcc;
508         struct ufs_vreg *vccq;
509         struct ufs_vreg *vccq2;
510         struct ufs_vreg *vdd_hba;
511 };
512
513 struct ufs_dev_info {
514         bool f_power_on_wp_en;
515         /* Keeps information if any of the LU is power on write protected */
516         bool is_lu_power_on_wp;
517 };
518
519 #define MAX_MODEL_LEN 16
520 /**
521  * ufs_dev_desc - ufs device details from the device descriptor
522  *
523  * @wmanufacturerid: card details
524  * @model: card model
525  */
526 struct ufs_dev_desc {
527         u16 wmanufacturerid;
528         char model[MAX_MODEL_LEN + 1];
529 };
530
531 #endif /* End of Header */