add support for DWC UFS Controller

This patch has the goal to add support for DesignWare UFS Controller specific operations and to add specific platform and pci drivers.

Signed-off-by Joao Pinto <jpinto-HKixBCOQz3hWk0Htik3J/[email protected]>

---
Changes v6->v7 (Arnd Bergmann):
- Changed DT node name (to ufs only) and the memory address (to 0xd000000)
- Removed CONFIG_PM from the PCI glue driver (pm.h already does this)
- No other changes are necessary in ufshcd.c because of the link up notify function usage (it is simpler now)
- Removed the PHY mentioning since the Test Chip is not a real PHY for real world usage, since it is a test chip for prototyping with a very specific usage
- Added again the Test Chip 20-bit option
Changes v5->v6:
- Patch bad format fixed
Changes v4->v5 (Akinobu Mita):
- All functions used only locally in ufshcd-dwc are now declared as static
- ufshcd_dwc_configuration() was removed in ufshcd-dwc and a notify function (ufshcd_dwc_link_startup_notify) was created to deal with the DWC specific init routines
- 20-bit RMMI option was removed from Kconfig. Now if MPHY TC is selected and 40-bit is not then it assumes a 20-bit config
Changes v3->v4 (Arnd Bergmann and Mark Rutland):
- SCSI_UFS_DWC_HOOKS is now silent and selected by the SCSI_UFS_DWC_PLAT or SCSI_UFS_DWC_PCI
- Compatibility string has the ufs core version for info purposes since the driver is capable of getting the controller version from its registers
- Created ufs-dwc-pci glue driver with specific DWC data
- MPHY configuration remains in the ufshcd-dwc since it is unipro attribute writting only not following the a linux phy framework logic
Changes v2->v3 (Julian Calaby):
- Implement a common DWC code to be used by the platform and pci glue drivers
- Synopsys ID & Class added to the existing pci driver and specific DWC was also added to the pci driver
Changes v1->v2 (Akinobu Mita):
- Implement a platform driver that uses the existing UFS core driver
- Add DWC specific code to the existing UFS core driver

 Documentation/devicetree/bindings/ufs/ufs-dwc.txt |  17 +
 MAINTAINERS                                       |   6 +
 drivers/scsi/ufs/Kconfig                          |  51 ++
 drivers/scsi/ufs/Makefile                         |   3 +
 drivers/scsi/ufs/ufs-dwc-pci.c                    | 172 +++++
 drivers/scsi/ufs/ufs-dwc.c                        | 102 +++
 drivers/scsi/ufs/ufshcd-dwc.c                     | 739 ++++++++++++++++++++++
 drivers/scsi/ufs/ufshcd-dwc.h                     |  18 +
 drivers/scsi/ufs/ufshci-dwc.h                     |  42 ++
 drivers/scsi/ufs/unipro.h                         |  39 ++
 10 files changed, 1189 insertions(+)
 create mode 100644 Documentation/devicetree/bindings/ufs/ufs-dwc.txt
 create mode 100644 drivers/scsi/ufs/ufs-dwc-pci.c
 create mode 100644 drivers/scsi/ufs/ufs-dwc.c
 create mode 100644 drivers/scsi/ufs/ufshcd-dwc.c
 create mode 100644 drivers/scsi/ufs/ufshcd-dwc.h
 create mode 100644 drivers/scsi/ufs/ufshci-dwc.h

Documentation/devicetree/bindings/ufs/ufs-dwc.txt new file +0 -0

new file mode 100644
index 0000000..3cbfd77

Documentation/devicetree/bindings/ufs/ufs-dwc.txt line 8

Quoted 3 lines · Joao Pinto

Documentation/devicetree/bindings/ufs/ufs-dwc.txt new file +3 -0

+Required properties:
+- compatible        : compatible string ("snps,ufshcd-1.0", "snps,ufshcd-1.1"
+  or "snps,ufshcd-2.0")

History has taught us this needs to have a vendor specific compatible string as well. Don't necessarily have to define it now, but just state a vendor string is needed too.

Documentation/devicetree/bindings/ufs/ufs-dwc.txt line 17

Quoted 10 lines

+- reg               : <registers mapping>
+- interrupts        : <interrupt mapping for UFS host controller IRQ>

Documentation/devicetree/bindings/ufs/ufs-dwc.txt new file +7 -0

+
+Example:
+	ufs@0xd0000000 {
+		compatible = "snps,ufshcd-2.0";
+		reg = < 0xd0000000 0x10000 >;
+		interrupts = < 24 >;
+	};

Hi Rob,

Quoted 5 lines · Rob Herring

Quoted 3 lines · Joao Pinto

Documentation/devicetree/bindings/ufs/ufs-dwc.txt new file +3 -0

+Required properties:
+- compatible        : compatible string ("snps,ufshcd-1.0", "snps,ufshcd-1.1"
+  or "snps,ufshcd-2.0")

Quoted 3 lines

History has taught us this needs to have a vendor specific compatible string as well. Don't necessarily have to define it now, but just state a vendor string is needed too.

The compatibility string already as the "snps" which is the acronym for Synopsys which is the HW Controller vendor. Isn't this enough?

drivers/scsi/ufs/ufshcd-dwc.c new file +72 -0

+static int ufshcd_dwc_connection_setup(struct ufs_hba *hba)
+{
+       int ret = 0;
+
+       /* Local side Configuration */
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(T_CONNECTIONSTATE), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(N_DEVICEID), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(N_DEVICEID_VALID), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(T_PEERDEVICEID), 1);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(T_PEERCPORTID), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(T_TRAFFICCLASS), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(T_CPORTFLAGS), 0x6);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(T_CPORTMODE), 1);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(T_CONNECTIONSTATE), 1);
+       if (ret)
+               goto out;
+
+
+       /* Peer side Configuration */
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(T_CONNECTIONSTATE), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(N_DEVICEID), 1);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(N_DEVICEID_VALID), 1);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(T_PEERDEVICEID), 1);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(T_PEERCPORTID), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(T_TRAFFICCLASS), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(T_CPORTFLAGS), 0x6);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(T_CPORTMODE), 1);

drivers/scsi/ufs/unipro.h +0 -0

Hi Joao,

2016-02-11 21:13 GMT+09:00 Joao Pinto <Joao.Pinto-HKixBCOQz3hWk0Htik3J/[email protected]>:

Quoted 79 lines

drivers/scsi/ufs/ufshcd-dwc.c new file +79 -0

+static int ufshcd_dwc_connection_setup(struct ufs_hba *hba)
+{
+       int ret = 0;
+
+       /* Local side Configuration */
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(T_CONNECTIONSTATE), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(N_DEVICEID), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(N_DEVICEID_VALID), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(T_PEERDEVICEID), 1);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(T_PEERCPORTID), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(T_TRAFFICCLASS), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(T_CPORTFLAGS), 0x6);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(T_CPORTMODE), 1);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_set(hba, UIC_ARG_MIB(T_CONNECTIONSTATE), 1);
+       if (ret)
+               goto out;
+
+
+       /* Peer side Configuration */
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(T_CONNECTIONSTATE), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(N_DEVICEID), 1);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(N_DEVICEID_VALID), 1);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(T_PEERDEVICEID), 1);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(T_PEERCPORTID), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(T_TRAFFICCLASS), 0);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(T_CPORTFLAGS), 0x6);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(T_CPORTMODE), 1);
+       if (ret)
+               goto out;
+
+       ret = ufshcd_dme_peer_set(hba, UIC_ARG_MIB(T_CONNECTIONSTATE), 1);
+       if (ret)
+               goto out;
+

drivers/scsi/ufs/ufshcd-dwc.c line 147

Quoted 3 lines

drivers/scsi/ufs/ufshcd-dwc.c new file +3 -0

+out:
+       return ret;
+}

This looks a bit redundant. The most part of the functions in this file is doing ufshcd_dme_set() or ufshcd_dme_peer_set(), so should we introduce ufshcd_dme_set_attrs() like below? It will also increase readability.

struct ufshcd_dme_attr_val {
        u32 attr_sel;
        u32 mib_val;
        u8 peer;
};

int ufshcd_dme_set_attrs(struct ufs_hba *hba,
const struct ufshcd_dme_attr_val *v, int n)

{
        for (i = 0; i < n; i++) {
                int ret = ufshcd_dme_set_attr(hba, v[i].attr_sel, ...);

                if (ret)
                        return ret;
        }
        return 0;
}

static int ufshcd_dwc_connection_setup(struct ufs_hba *hba)

{
        const struct ufshcd_dme_attr setup_attrs[] = {
                { UIC_ARG_MIB(T_CONNECTIONSTATE), 0, DME_LOCAL },
                { UIC_ARG_MIB(T_DEVICEID), 0, DME_LOCAL },
                ...
        };

        return ufshcd_dme_set_attrs(hba, setup_attrs, ARRAY_SIZE(setup_attrs));
}

drivers/scsi/ufs/ufshcd-dwc.c line 676

Quoted 9 lines

drivers/scsi/ufs/ufshcd-dwc.c new file +9 -0

+static int ufshcd_dwc_setup_tc(struct ufs_hba *hba)
+{
+       int ret = 0;
+
+#ifdef CONFIG_SCSI_UFS_DWC_40BIT_RMMI
+       dev_info(hba->dev, "Configuring Test Chip 40-bit RMMI");
+       ret = ufshcd_dwc_setup_40bit_rmmi(hba);
+       if (ret) {
+               dev_err(hba->dev, "Configuration failed");

Please add \n in the end of message.
(and there are same issues in this file)

drivers/scsi/ufs/ufshci-dwc.h line 32

Quoted 7 lines

drivers/scsi/ufs/ufshci-dwc.h new file +7 -0

+
+/* Clock Divider Values: Hex equivalent of frequency in MHz */
+enum clk_div_values {
+       UFSHCD_CLK_DIV_62_5     = 0x3e,
+       UFSHCD_CLK_DIV_125      = 0x7d,
+       UFSHCD_CLK_DIV_200      = 0xc8,
+};

This is used as register value for DWC_UFS_REG_HCLKDIV. So should they have similar prefix (DWC_UFS_REG_HCLKDIV_*)?

Quoted 2 lines

drivers/scsi/ufs/unipro.h +0 -0

...

drivers/scsi/ufs/unipro.h line 150

Quoted 4 lines

drivers/scsi/ufs/unipro.h +4 -0

+/*Other attributes*/
+#define VS_MPHYCFGUPDT         0xD085
+#define VS_DEBUGOMC            0xD09E
+#define VS_POWERSTATE          0xD083

Are these vendor specific attributes? If so, please move them to ufshci-dwc.h.