tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0-only */
2/*
3 * Copyright (c) 2014-2016, The Linux Foundation. All rights reserved.
4 */
5
6#ifndef _UFS_QUIRKS_H_
7#define _UFS_QUIRKS_H_
8
9/* return true if s1 is a prefix of s2 */
10#define STR_PRFX_EQUAL(s1, s2) !strncmp(s1, s2, strlen(s1))
11
12#define UFS_ANY_VENDOR 0xFFFF
13#define UFS_ANY_MODEL "ANY_MODEL"
14
15#define UFS_VENDOR_TOSHIBA 0x198
16#define UFS_VENDOR_SAMSUNG 0x1CE
17#define UFS_VENDOR_SKHYNIX 0x1AD
18#define UFS_VENDOR_WDC 0x145
19
20/**
21 * ufs_dev_fix - ufs device quirk info
22 * @card: ufs card details
23 * @quirk: device quirk
24 */
25struct ufs_dev_fix {
26 u16 wmanufacturerid;
27 u8 *model;
28 unsigned int quirk;
29};
30
31#define END_FIX { }
32
33/* add specific device quirk */
34#define UFS_FIX(_vendor, _model, _quirk) { \
35 .wmanufacturerid = (_vendor),\
36 .model = (_model), \
37 .quirk = (_quirk), \
38}
39
40/*
41 * Some vendor's UFS device sends back to back NACs for the DL data frames
42 * causing the host controller to raise the DFES error status. Sometimes
43 * such UFS devices send back to back NAC without waiting for new
44 * retransmitted DL frame from the host and in such cases it might be possible
45 * the Host UniPro goes into bad state without raising the DFES error
46 * interrupt. If this happens then all the pending commands would timeout
47 * only after respective SW command (which is generally too large).
48 *
49 * We can workaround such device behaviour like this:
50 * - As soon as SW sees the DL NAC error, it should schedule the error handler
51 * - Error handler would sleep for 50ms to see if there are any fatal errors
52 * raised by UFS controller.
53 * - If there are fatal errors then SW does normal error recovery.
54 * - If there are no fatal errors then SW sends the NOP command to device
55 * to check if link is alive.
56 * - If NOP command times out, SW does normal error recovery
57 * - If NOP command succeed, skip the error handling.
58 *
59 * If DL NAC error is seen multiple times with some vendor's UFS devices then
60 * enable this quirk to initiate quick error recovery and also silence related
61 * error logs to reduce spamming of kernel logs.
62 */
63#define UFS_DEVICE_QUIRK_RECOVERY_FROM_DL_NAC_ERRORS (1 << 2)
64
65/*
66 * Few Toshiba UFS device models advertise RX_MIN_ACTIVATETIME_CAPABILITY as
67 * 600us which may not be enough for reliable hibern8 exit hardware sequence
68 * from UFS device.
69 * To workaround this issue, host should set its PA_TACTIVATE time to 1ms even
70 * if device advertises RX_MIN_ACTIVATETIME_CAPABILITY less than 1ms.
71 */
72#define UFS_DEVICE_QUIRK_PA_TACTIVATE (1 << 4)
73
74/*
75 * It seems some UFS devices may keep drawing more than sleep current
76 * (atleast for 500us) from UFS rails (especially from VCCQ rail).
77 * To avoid this situation, add 2ms delay before putting these UFS
78 * rails in LPM mode.
79 */
80#define UFS_DEVICE_QUIRK_DELAY_BEFORE_LPM (1 << 6)
81
82/*
83 * Some UFS devices require host PA_TACTIVATE to be lower than device
84 * PA_TACTIVATE, enabling this quirk ensure this.
85 */
86#define UFS_DEVICE_QUIRK_HOST_PA_TACTIVATE (1 << 7)
87
88/*
89 * The max. value PA_SaveConfigTime is 250 (10us) but this is not enough for
90 * some vendors.
91 * Gear switch from PWM to HS may fail even with this max. PA_SaveConfigTime.
92 * Gear switch can be issued by host controller as an error recovery and any
93 * software delay will not help on this case so we need to increase
94 * PA_SaveConfigTime to >32us as per vendor recommendation.
95 */
96#define UFS_DEVICE_QUIRK_HOST_PA_SAVECONFIGTIME (1 << 8)
97
98/*
99 * Some UFS devices require VS_DebugSaveConfigTime is 0x10,
100 * enabling this quirk ensure this.
101 */
102#define UFS_DEVICE_QUIRK_HOST_VS_DEBUGSAVECONFIGTIME (1 << 9)
103
104/*
105 * Some pre-3.1 UFS devices can support extended features by upgrading
106 * the firmware. Enable this quirk to make UFS core driver probe and enable
107 * supported features on such devices.
108 */
109#define UFS_DEVICE_QUIRK_SUPPORT_EXTENDED_FEATURES (1 << 10)
110
111#endif /* UFS_QUIRKS_H_ */