drivers/scsi/ufs/ufs_quirks.h

   1 /*
   2  * Copyright (c) 2014-2016, The Linux Foundation. All rights reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 and
   6  * only version 2 as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  */
  14
  15 #ifndef _UFS_QUIRKS_H_
  16 #define _UFS_QUIRKS_H_
  17
  18 /* return true if s1 is a prefix of s2 */
  19 #define STR_PRFX_EQUAL(s1, s2) !strncmp(s1, s2, strlen(s1))
  20
  21 #define UFS_ANY_VENDOR 0xFFFF
  22 #define UFS_ANY_MODEL  "ANY_MODEL"
  23
  24 #define MAX_MODEL_LEN 16
  25
  26 #define UFS_VENDOR_TOSHIBA     0x198
  27 #define UFS_VENDOR_SAMSUNG     0x1CE
  28
  29 /**
  30  * ufs_device_info - ufs device details
  31  * @wmanufacturerid: card details
  32  * @model: card model
  33  */
  34 struct ufs_device_info {
  35         u16 wmanufacturerid;
  36         char model[MAX_MODEL_LEN + 1];
  37 };
  38
  39 /**
  40  * ufs_dev_fix - ufs device quirk info
  41  * @card: ufs card details
  42  * @quirk: device quirk
  43  */
  44 struct ufs_dev_fix {
  45         struct ufs_device_info card;
  46         unsigned int quirk;
  47 };
  48
  49 #define END_FIX { { 0 }, 0 }
  50
  51 /* add specific device quirk */
  52 #define UFS_FIX(_vendor, _model, _quirk) \
  53                 {                                         \
  54                         .card.wmanufacturerid = (_vendor),\
  55                         .card.model = (_model),           \
  56                         .quirk = (_quirk),                \
  57                 }
  58
  59 /*
  60  * If UFS device is having issue in processing LCC (Line Control
  61  * Command) coming from UFS host controller then enable this quirk.
  62  * When this quirk is enabled, host controller driver should disable
  63  * the LCC transmission on UFS host controller (by clearing
  64  * TX_LCC_ENABLE attribute of host to 0).
  65  */
  66 #define UFS_DEVICE_QUIRK_BROKEN_LCC (1 << 0)
  67
  68 /*
  69  * Some UFS devices don't need VCCQ rail for device operations. Enabling this
  70  * quirk for such devices will make sure that VCCQ rail is not voted.
  71  */
  72 #define UFS_DEVICE_NO_VCCQ (1 << 1)
  73
  74 /*
  75  * Some vendor's UFS device sends back to back NACs for the DL data frames
  76  * causing the host controller to raise the DFES error status. Sometimes
  77  * such UFS devices send back to back NAC without waiting for new
  78  * retransmitted DL frame from the host and in such cases it might be possible
  79  * the Host UniPro goes into bad state without raising the DFES error
  80  * interrupt. If this happens then all the pending commands would timeout
  81  * only after respective SW command (which is generally too large).
  82  *
  83  * We can workaround such device behaviour like this:
  84  * - As soon as SW sees the DL NAC error, it should schedule the error handler
  85  * - Error handler would sleep for 50ms to see if there are any fatal errors
  86  *   raised by UFS controller.
  87  *    - If there are fatal errors then SW does normal error recovery.
  88  *    - If there are no fatal errors then SW sends the NOP command to device
  89  *      to check if link is alive.
  90  *        - If NOP command times out, SW does normal error recovery
  91  *        - If NOP command succeed, skip the error handling.
  92  *
  93  * If DL NAC error is seen multiple times with some vendor's UFS devices then
  94  * enable this quirk to initiate quick error recovery and also silence related
  95  * error logs to reduce spamming of kernel logs.
  96  */
  97 #define UFS_DEVICE_QUIRK_RECOVERY_FROM_DL_NAC_ERRORS (1 << 2)
  98
  99 /*
 100  * Some UFS devices may not work properly after resume if the link was kept
 101  * in off state during suspend. Enabling this quirk will not allow the
 102  * link to be kept in off state during suspend.
 103  */
 104 #define UFS_DEVICE_QUIRK_NO_LINK_OFF    (1 << 3)
 105
 106 /*
 107  * Few Toshiba UFS device models advertise RX_MIN_ACTIVATETIME_CAPABILITY as
 108  * 600us which may not be enough for reliable hibern8 exit hardware sequence
 109  * from UFS device.
 110  * To workaround this issue, host should set its PA_TACTIVATE time to 1ms even
 111  * if device advertises RX_MIN_ACTIVATETIME_CAPABILITY less than 1ms.
 112  */
 113 #define UFS_DEVICE_QUIRK_PA_TACTIVATE   (1 << 4)
 114
 115 /*
 116  * Some UFS memory devices may have really low read/write throughput in
 117  * FAST AUTO mode, enable this quirk to make sure that FAST AUTO mode is
 118  * never enabled for such devices.
 119  */
 120 #define UFS_DEVICE_NO_FASTAUTO          (1 << 5)
 121
 122 /*
 123  * It seems some UFS devices may keep drawing more than sleep current
 124  * (atleast for 500us) from UFS rails (especially from VCCQ rail).
 125  * To avoid this situation, add 2ms delay before putting these UFS
 126  * rails in LPM mode.
 127  */
 128 #define UFS_DEVICE_QUIRK_DELAY_BEFORE_LPM       (1 << 6)
 129
 130 struct ufs_hba;
 131 void ufs_advertise_fixup_device(struct ufs_hba *hba);
 132
 133 static struct ufs_dev_fix ufs_fixups[] = {
 134         /* UFS cards deviations table */
 135         UFS_FIX(UFS_VENDOR_SAMSUNG, UFS_ANY_MODEL,
 136                 UFS_DEVICE_QUIRK_DELAY_BEFORE_LPM),
 137         UFS_FIX(UFS_VENDOR_SAMSUNG, UFS_ANY_MODEL, UFS_DEVICE_NO_VCCQ),
 138         UFS_FIX(UFS_VENDOR_SAMSUNG, UFS_ANY_MODEL,
 139                 UFS_DEVICE_QUIRK_RECOVERY_FROM_DL_NAC_ERRORS),
 140         UFS_FIX(UFS_VENDOR_SAMSUNG, UFS_ANY_MODEL,
 141                 UFS_DEVICE_NO_FASTAUTO),
 142         UFS_FIX(UFS_VENDOR_TOSHIBA, UFS_ANY_MODEL,
 143                 UFS_DEVICE_QUIRK_DELAY_BEFORE_LPM),
 144         UFS_FIX(UFS_VENDOR_TOSHIBA, "THGLF2G9C8KBADG",
 145                 UFS_DEVICE_QUIRK_PA_TACTIVATE),
 146         UFS_FIX(UFS_VENDOR_TOSHIBA, "THGLF2G9D8KBADG",
 147                 UFS_DEVICE_QUIRK_PA_TACTIVATE),
 148
 149         END_FIX
 150 };
 151 #endif /* UFS_QUIRKS_H_ */