/* SPDX-License-Identifier: GPL-2.0-only */ /* * Copyright (c) 2014-2016, The Linux Foundation. All rights reserved. */ #ifndef _UFS_QUIRKS_H_ #define _UFS_QUIRKS_H_ /* return true if s1 is a prefix of s2 */ #define STR_PRFX_EQUAL(s1, s2) … #define UFS_ANY_VENDOR … #define UFS_ANY_MODEL … #define UFS_VENDOR_MICRON … #define UFS_VENDOR_SAMSUNG … #define UFS_VENDOR_SKHYNIX … #define UFS_VENDOR_TOSHIBA … #define UFS_VENDOR_WDC … /** * ufs_dev_quirk - ufs device quirk info * @card: ufs card details * @quirk: device quirk */ struct ufs_dev_quirk { … }; /* * Some vendor's UFS device sends back to back NACs for the DL data frames * causing the host controller to raise the DFES error status. Sometimes * such UFS devices send back to back NAC without waiting for new * retransmitted DL frame from the host and in such cases it might be possible * the Host UniPro goes into bad state without raising the DFES error * interrupt. If this happens then all the pending commands would timeout * only after respective SW command (which is generally too large). * * We can workaround such device behaviour like this: * - As soon as SW sees the DL NAC error, it should schedule the error handler * - Error handler would sleep for 50ms to see if there are any fatal errors * raised by UFS controller. * - If there are fatal errors then SW does normal error recovery. * - If there are no fatal errors then SW sends the NOP command to device * to check if link is alive. * - If NOP command times out, SW does normal error recovery * - If NOP command succeed, skip the error handling. * * If DL NAC error is seen multiple times with some vendor's UFS devices then * enable this quirk to initiate quick error recovery and also silence related * error logs to reduce spamming of kernel logs. */ #define UFS_DEVICE_QUIRK_RECOVERY_FROM_DL_NAC_ERRORS … /* * Few Toshiba UFS device models advertise RX_MIN_ACTIVATETIME_CAPABILITY as * 600us which may not be enough for reliable hibern8 exit hardware sequence * from UFS device. * To workaround this issue, host should set its PA_TACTIVATE time to 1ms even * if device advertises RX_MIN_ACTIVATETIME_CAPABILITY less than 1ms. */ #define UFS_DEVICE_QUIRK_PA_TACTIVATE … /* * It seems some UFS devices may keep drawing more than sleep current * (atleast for 500us) from UFS rails (especially from VCCQ rail). * To avoid this situation, add 2ms delay before putting these UFS * rails in LPM mode. */ #define UFS_DEVICE_QUIRK_DELAY_BEFORE_LPM … /* * Some UFS devices require host PA_TACTIVATE to be lower than device * PA_TACTIVATE, enabling this quirk ensure this. */ #define UFS_DEVICE_QUIRK_HOST_PA_TACTIVATE … /* * The max. value PA_SaveConfigTime is 250 (10us) but this is not enough for * some vendors. * Gear switch from PWM to HS may fail even with this max. PA_SaveConfigTime. * Gear switch can be issued by host controller as an error recovery and any * software delay will not help on this case so we need to increase * PA_SaveConfigTime to >32us as per vendor recommendation. */ #define UFS_DEVICE_QUIRK_HOST_PA_SAVECONFIGTIME … /* * Some UFS devices require VS_DebugSaveConfigTime is 0x10, * enabling this quirk ensure this. */ #define UFS_DEVICE_QUIRK_HOST_VS_DEBUGSAVECONFIGTIME … /* * Some pre-3.1 UFS devices can support extended features by upgrading * the firmware. Enable this quirk to make UFS core driver probe and enable * supported features on such devices. */ #define UFS_DEVICE_QUIRK_SUPPORT_EXTENDED_FEATURES … /* * Some UFS devices require delay after VCC power rail is turned-off. * Enable this quirk to introduce 5ms delays after VCC power-off during * suspend flow. */ #define UFS_DEVICE_QUIRK_DELAY_AFTER_LPM … #endif /* UFS_QUIRKS_H_ */
Codebase Browser
linux