LXR linux/drivers/scsi/ufs/ufs

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