Skip to contentSkip to conversation

scsi: ufs: set the device reference clock setting

PATCH Superseded Sayali Lokhande 2 participants 6 messages Aug 21, 2018 – Aug 24, 2018 1 message not in the archive SCSI

v9 of 15 Superseded Latest is v15 →

lore
Share & tools
lore

A message that is not in the archive (sent off-list or not yet received): [email protected]

#1 lore raw

PATCH v9 1/2 scsi: ufs: set the device reference clock setting

From: Subhash Jadavani <[email protected]>

UFS host supplies the reference clock to UFS device and UFS device specification allows host to provide one of the 4 frequencies (19.2 MHz, 26 MHz, 38.4 MHz, 52 MHz) for reference clock. Host should set the device reference clock frequency setting in the device based on what frequency it is supplying to UFS device.

---
 drivers/scsi/ufs/ufs.h    | 14 ++++++++
 drivers/scsi/ufs/ufshcd.c | 92 +++++++++++++++++++++++++++++++++++++++++++++++
 drivers/scsi/ufs/ufshcd.h |  2 ++
 3 files changed, 108 insertions(+)
drivers/scsi/ufs/ufs.h +14 -0
index 14e5bf7..a2e76b1 100644
@@ -378,6 +378,20 @@ enum query_opcode {
 	UPIU_QUERY_OPCODE_TOGGLE_FLAG	= 0x8,
 };
 
+/* bRefClkFreq attribute values */
+enum ufs_ref_clk_freq {
+	REF_CLK_FREQ_19_2_MHZ	= 0,
+	REF_CLK_FREQ_26_MHZ	= 1,
+	REF_CLK_FREQ_38_4_MHZ	= 2,
+	REF_CLK_FREQ_52_MHZ	= 3,
+	REF_CLK_FREQ_INVAL	= -1,
+};
+
+struct ufs_ref_clk {
+	u32 freq_hz;
+	enum ufs_ref_clk_freq val;
+};
+
 /* Query response result code */
 enum {
 	QUERY_RESULT_SUCCESS                    = 0x00,
drivers/scsi/ufs/ufshcd.c +92 -0

110 lines not on this page · raw message

drivers/scsi/ufs/ufshcd.h +2 -0
index 8110dcd..45013b6 100644
@@ -548,6 +548,7 @@ struct ufs_hba {
 	void *priv;
 	unsigned int irq;
 	bool is_irq_enabled;
+	enum ufs_ref_clk_freq dev_ref_clk_freq;
 
 	/* Interrupt aggregation support is broken */
 	#define UFSHCD_QUIRK_BROKEN_INTR_AGGR			0x1
@@ -746,6 +747,7 @@ static inline void ufshcd_rmwl(struct ufs_hba *hba, u32 mask, u32 val, u32 reg)
 int ufshcd_wait_for_register(struct ufs_hba *hba, u32 reg, u32 mask,
 				u32 val, unsigned long interval_us,
 				unsigned long timeout_ms, bool can_sleep);
+void ufshcd_parse_dev_ref_clk_freq(struct ufs_hba *hba);
 
 static inline void check_upiu_size(void)
 {
Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project
#2 lore raw
Quoted 51 lines · Sayali Lokhande

From: Subhash Jadavani <[email protected]>

UFS host supplies the reference clock to UFS device and UFS device specification allows host to provide one of the 4 frequencies (19.2 MHz, 26 MHz, 38.4 MHz, 52 MHz) for reference clock. Host should set the device reference clock frequency setting in the device based on what frequency it is supplying to UFS device.

---
 drivers/scsi/ufs/ufs.h    | 14 ++++++++
 drivers/scsi/ufs/ufshcd.c | 92 +++++++++++++++++++++++++++++++++++++++++++++++
 drivers/scsi/ufs/ufshcd.h |  2 ++
 3 files changed, 108 insertions(+)
drivers/scsi/ufs/ufs.h +14 -0
index 14e5bf7..a2e76b1 100644
@@ -378,6 +378,20 @@ enum query_opcode {
        UPIU_QUERY_OPCODE_TOGGLE_FLAG   = 0x8,
 };
 
+/* bRefClkFreq attribute values */
+enum ufs_ref_clk_freq {
+       REF_CLK_FREQ_19_2_MHZ   = 0,
+       REF_CLK_FREQ_26_MHZ     = 1,
+       REF_CLK_FREQ_38_4_MHZ   = 2,
+       REF_CLK_FREQ_52_MHZ     = 3,
+       REF_CLK_FREQ_INVAL      = -1,
+};
+
+struct ufs_ref_clk {
+       u32 freq_hz;
+       enum ufs_ref_clk_freq val;
+};
+
 /* Query response result code */
 enum {
        QUERY_RESULT_SUCCESS                    = 0x00,
drivers/scsi/ufs/ufshcd.c +0 -0
index c5b1bf1..e946844 100644
@@ -6296,6 +6296,91 @@ static void ufshcd_def_desc_sizes(struct ufs_hba *hba)
        hba->desc_size.hlth_desc = QUERY_DESC_HEALTH_DEF_SIZE;
 }
 

drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6308

Quoted 10 lines
drivers/scsi/ufs/ufshcd.c +10 -0
+static struct ufs_ref_clk ufs_ref_clk_freqs[] = {
+       {19200000, REF_CLK_FREQ_19_2_MHZ},
+       {26000000, REF_CLK_FREQ_26_MHZ},
+       {38400000, REF_CLK_FREQ_38_4_MHZ},
+       {52000000, REF_CLK_FREQ_52_MHZ},
+       {0, REF_CLK_FREQ_INVAL},
+};
+
+static inline enum ufs_ref_clk_freq
+ufs_get_bref_clk_for_ref_clk_freq_hz(u32 freq)

This name is a little hairy. Maybe ufs_get_bref_clk_from_hz, or ufs_hz_to_bref_clk?

Quoted 20 lines
drivers/scsi/ufs/ufshcd.c +20 -0
+{
+       int i = 0;
+
+       while (ufs_ref_clk_freqs[i].freq_hz != freq) {
+               if (!ufs_ref_clk_freqs[i].freq_hz)
+                       return REF_CLK_FREQ_INVAL;
+               i++;
+       }
+
+       return ufs_ref_clk_freqs[i].val;
+}
+
+void ufshcd_parse_dev_ref_clk_freq(struct ufs_hba *hba)
+{
+       struct device *dev = hba->dev;
+       struct device_node *np = dev->of_node;
+       struct clk *refclk = NULL;
+       u32 freq = 0;
+
+       if (!np)

drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6338

Quoted 10 lines
drivers/scsi/ufs/ufshcd.c +10 -0
+               return;
+
+       hba->dev_ref_clk_freq = REF_CLK_FREQ_INVAL;
+
+       refclk = of_clk_get_by_name(np, "ref_clk");
+       if (!refclk)
+               return;
+
+       freq = clk_get_rate(refclk);
+       if (freq > REF_CLK_FREQ_52_MHZ) {

freq is in Hertz, but the enum value will be something like 3. I think you should just call your function below, and then check the return value of it for the error case you're trying to do here.

drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6351

Quoted 13 lines
drivers/scsi/ufs/ufshcd.c +13 -0
+               dev_err(hba->dev,
+               "%s: invalid ref_clk setting = %d\n",
+               __func__, freq);
+               return;
+       }
+
+       hba->dev_ref_clk_freq =
+               ufs_get_bref_clk_for_ref_clk_freq_hz(freq);
+}
+
+static int ufshcd_set_dev_ref_clk(struct ufs_hba *hba)
+{
+       int err = 0;

You don't need to initialize this since you immediately assign it below.

drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6353

Quoted 2 lines
drivers/scsi/ufs/ufshcd.c +2 -0
+       int ref_clk = -1;
+       u32 freq = (u32)hba->dev_ref_clk_freq;

Is the cast necessary?

Quoted 15 lines
drivers/scsi/ufs/ufshcd.c +15 -0
+
+       err = ufshcd_query_attr_retry(hba, UPIU_QUERY_OPCODE_READ_ATTR,
+                       QUERY_ATTR_IDN_REF_CLK_FREQ, 0, 0, &ref_clk);
+
+       if (err) {
+               dev_err(hba->dev, "%s: failed reading bRefClkFreq. err = %d\n",
+                        __func__, err);
+               goto out;
+       }
+
+       if (ref_clk == hba->dev_ref_clk_freq)
+               goto out; /* nothing to update */
+
+       err = ufshcd_query_attr_retry(hba, UPIU_QUERY_OPCODE_WRITE_ATTR,
+                       QUERY_ATTR_IDN_REF_CLK_FREQ, 0, 0, &freq);

drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6378

Quoted 10 lines
drivers/scsi/ufs/ufshcd.c +10 -0
+
+       if (err)
+               dev_err(hba->dev, "%s: bRefClkFreq setting to %u Hz failed\n",
+               __func__, ufs_ref_clk_freqs[freq].freq_hz);
+       /*
+        * It is good to print this out here to debug any later failures
+        * related to gear switch.
+        */
+       dev_dbg(hba->dev, "%s: bRefClkFreq setting to %u Hz succeeded\n",
+               __func__, ufs_ref_clk_freqs[freq].freq_hz);

In the error case you print out both the failed message and the success message?

Quoted 22 lines
drivers/scsi/ufs/ufshcd.c +11 -0
+
+out:
+       return err;
+}
+
 /**
  * ufshcd_probe_hba - probe hba to detect device and initialize
  * @hba: per-adapter instance
@@ -6361,6 +6446,12 @@ static int ufshcd_probe_hba(struct ufs_hba *hba)
                        "%s: Failed getting max supported power mode\n",
                        __func__);
        } else {
+               /*
+                * Set the right value to bRefClkFreq before attempting to
+                * switch to HS gears.
+                */
+               if (hba->dev_ref_clk_freq != REF_CLK_FREQ_INVAL)
+                       ufshcd_set_dev_ref_clk(hba);
                ret = ufshcd_config_pwr_mode(hba, &hba->max_pwr_info.info);
                if (ret) {
                        dev_err(hba->dev, "%s: Failed setting power mode, err = %d\n",

drivers/scsi/ufs/ufshcd.c int ufshcd_alloc_host(struct device *dev, struct ufs_hba **hba_handle) · line 7787

Quoted 4 lines
drivers/scsi/ufs/ufshcd.c +1 -0
@@ -7693,6 +7784,7 @@ int ufshcd_alloc_host(struct device *dev, struct ufs_hba **hba_handle)
 
        INIT_LIST_HEAD(&hba->clk_list_head);
 
+       ufshcd_parse_dev_ref_clk_freq(hba);

I get an uncomfortable feeling about calling this function from alloc_host, given that everybody else calls their parse functions from ufshcd_pltfrm_init. I wonder if you should just initialize the new member here in alloc_host to the invalid value, and then move the call to the parse function where you had it before in ufshcd_pltfrm_init. That way you don't have the problems in the previous series with leaving the value uninitialized, but you're also not calling of_ functions from alloc_host, which seems like an abuse of alloc_host.

-Evan

#3 lore raw
Quoted 51 lines · Evan Green
Quoted 50 lines · Sayali Lokhande

From: Subhash Jadavani <[email protected]>

UFS host supplies the reference clock to UFS device and UFS device specification allows host to provide one of the 4 frequencies (19.2 MHz, 26 MHz, 38.4 MHz, 52 MHz) for reference clock. Host should set the device reference clock frequency setting in the device based on what frequency it is supplying to UFS device.

---
  drivers/scsi/ufs/ufs.h    | 14 ++++++++
  drivers/scsi/ufs/ufshcd.c | 92 +++++++++++++++++++++++++++++++++++++++++++++++
  drivers/scsi/ufs/ufshcd.h |  2 ++
  3 files changed, 108 insertions(+)
drivers/scsi/ufs/ufs.h +14 -0
index 14e5bf7..a2e76b1 100644
@@ -378,6 +378,20 @@ enum query_opcode {
         UPIU_QUERY_OPCODE_TOGGLE_FLAG   = 0x8,
  };
 
+/* bRefClkFreq attribute values */
+enum ufs_ref_clk_freq {
+       REF_CLK_FREQ_19_2_MHZ   = 0,
+       REF_CLK_FREQ_26_MHZ     = 1,
+       REF_CLK_FREQ_38_4_MHZ   = 2,
+       REF_CLK_FREQ_52_MHZ     = 3,
+       REF_CLK_FREQ_INVAL      = -1,
+};
+
+struct ufs_ref_clk {
+       u32 freq_hz;
+       enum ufs_ref_clk_freq val;
+};
+
  /* Query response result code */
  enum {
         QUERY_RESULT_SUCCESS                    = 0x00,
drivers/scsi/ufs/ufshcd.c +0 -0
index c5b1bf1..e946844 100644
@@ -6296,6 +6296,91 @@ static void ufshcd_def_desc_sizes(struct ufs_hba *hba)
         hba->desc_size.hlth_desc = QUERY_DESC_HEALTH_DEF_SIZE;
  }
 
Quoted 12 lines

drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6308

Quoted 10 lines
drivers/scsi/ufs/ufshcd.c +10 -0
+static struct ufs_ref_clk ufs_ref_clk_freqs[] = {
+       {19200000, REF_CLK_FREQ_19_2_MHZ},
+       {26000000, REF_CLK_FREQ_26_MHZ},
+       {38400000, REF_CLK_FREQ_38_4_MHZ},
+       {52000000, REF_CLK_FREQ_52_MHZ},
+       {0, REF_CLK_FREQ_INVAL},
+};
+
+static inline enum ufs_ref_clk_freq
+ufs_get_bref_clk_for_ref_clk_freq_hz(u32 freq)

This name is a little hairy. Maybe ufs_get_bref_clk_from_hz, or ufs_hz_to_bref_clk?

Done.  ufs_get_bref_clk_from_hz() sounds good. Will update.

Quoted 25 lines
Quoted 25 lines
drivers/scsi/ufs/ufshcd.c +25 -0
+{
+       int i = 0;
+
+       while (ufs_ref_clk_freqs[i].freq_hz != freq) {
+               if (!ufs_ref_clk_freqs[i].freq_hz)
+                       return REF_CLK_FREQ_INVAL;
+               i++;
+       }
+
+       return ufs_ref_clk_freqs[i].val;
+}
+
+void ufshcd_parse_dev_ref_clk_freq(struct ufs_hba *hba)
+{
+       struct device *dev = hba->dev;
+       struct device_node *np = dev->of_node;
+       struct clk *refclk = NULL;
+       u32 freq = 0;
+
+       if (!np)
+               return;
+
+       hba->dev_ref_clk_freq = REF_CLK_FREQ_INVAL;
+
+       refclk = of_clk_get_by_name(np, "ref_clk");
Quoted 8 lines

drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6338

Quoted 5 lines
drivers/scsi/ufs/ufshcd.c +5 -0
+       if (!refclk)
+               return;
+
+       freq = clk_get_rate(refclk);
+       if (freq > REF_CLK_FREQ_52_MHZ) {

freq is in Hertz, but the enum value will be something like 3. I think you should just call your function below, and then check the return value of it for the error case you're trying to do here.

Agree. I should be checking hba->dev_ref_clk_freq instead of freq (which is in hz). Will update.

Quoted 6 lines
Quoted 6 lines
drivers/scsi/ufs/ufshcd.c +6 -0
+               dev_err(hba->dev,
+               "%s: invalid ref_clk setting = %d\n",
+               __func__, freq);
+               return;
+       }
+
Quoted 8 lines

drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6351

Quoted 7 lines
drivers/scsi/ufs/ufshcd.c +7 -0
+       hba->dev_ref_clk_freq =
+               ufs_get_bref_clk_for_ref_clk_freq_hz(freq);
+}
+
+static int ufshcd_set_dev_ref_clk(struct ufs_hba *hba)
+{
+       int err = 0;

You don't need to initialize this since you immediately assign it below.

Done.

Quoted 3 lines

drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6353

Quoted 2 lines
drivers/scsi/ufs/ufshcd.c +2 -0
+       int ref_clk = -1;
+       u32 freq = (u32)hba->dev_ref_clk_freq;

Is the cast necessary?

Not necessary. Will be removed.

Quoted 18 lines
Quoted 18 lines
drivers/scsi/ufs/ufshcd.c +18 -0
+
+       err = ufshcd_query_attr_retry(hba, UPIU_QUERY_OPCODE_READ_ATTR,
+                       QUERY_ATTR_IDN_REF_CLK_FREQ, 0, 0, &ref_clk);
+
+       if (err) {
+               dev_err(hba->dev, "%s: failed reading bRefClkFreq. err = %d\n",
+                        __func__, err);
+               goto out;
+       }
+
+       if (ref_clk == hba->dev_ref_clk_freq)
+               goto out; /* nothing to update */
+
+       err = ufshcd_query_attr_retry(hba, UPIU_QUERY_OPCODE_WRITE_ATTR,
+                       QUERY_ATTR_IDN_REF_CLK_FREQ, 0, 0, &freq);
+
+       if (err)
+               dev_err(hba->dev, "%s: bRefClkFreq setting to %u Hz failed\n",
Quoted 8 lines

drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6378

Quoted 7 lines
drivers/scsi/ufs/ufshcd.c +7 -0
+               __func__, ufs_ref_clk_freqs[freq].freq_hz);
+       /*
+        * It is good to print this out here to debug any later failures
+        * related to gear switch.
+        */
+       dev_dbg(hba->dev, "%s: bRefClkFreq setting to %u Hz succeeded\n",
+               __func__, ufs_ref_clk_freqs[freq].freq_hz);

In the error case you print out both the failed message and the success message?

Agree. Will add goto out; in error case above.

Quoted 25 lines
Quoted 25 lines
drivers/scsi/ufs/ufshcd.c +11 -0
+
+out:
+       return err;
+}
+
  /**
   * ufshcd_probe_hba - probe hba to detect device and initialize
   * @hba: per-adapter instance
@@ -6361,6 +6446,12 @@ static int ufshcd_probe_hba(struct ufs_hba *hba)
                         "%s: Failed getting max supported power mode\n",
                         __func__);
         } else {
+               /*
+                * Set the right value to bRefClkFreq before attempting to
+                * switch to HS gears.
+                */
+               if (hba->dev_ref_clk_freq != REF_CLK_FREQ_INVAL)
+                       ufshcd_set_dev_ref_clk(hba);
                 ret = ufshcd_config_pwr_mode(hba, &hba->max_pwr_info.info);
                 if (ret) {
                         dev_err(hba->dev, "%s: Failed setting power mode, err = %d\n",
@@ -7693,6 +7784,7 @@ int ufshcd_alloc_host(struct device *dev, struct ufs_hba **hba_handle)
 
         INIT_LIST_HEAD(&hba->clk_list_head);
 
Quoted 9 lines

drivers/scsi/ufs/ufshcd.c int ufshcd_alloc_host(struct device *dev, struct ufs_hba **hba_handle) · line 7787

Quoted 1 line
drivers/scsi/ufs/ufshcd.c +1 -0
+       ufshcd_parse_dev_ref_clk_freq(hba);

I get an uncomfortable feeling about calling this function from alloc_host, given that everybody else calls their parse functions from ufshcd_pltfrm_init. I wonder if you should just initialize the new member here in alloc_host to the invalid value, and then move the call to the parse function where you had it before in ufshcd_pltfrm_init. That way you don't have the problems in the previous series with leaving the value uninitialized, but you're also not calling of_ functions from alloc_host, which seems like an abuse of alloc_host.

Agree. Will only initialize the ref_clk in alloc_host() and move the actual parse() call in pltfrm_init as before.

Quoted 1 line

-Evan

#4 lore raw

PATCH v9 2/2 scsi: ufs: Add configfs support for UFS provisioning

In reply to a message not in the archive

This patch adds configfs support to provision UFS device at runtime. This feature can be primarily useful in factory or assembly line as some devices may be required to be configured multiple times during initial system development phase. Configuration Descriptors can be written multiple times until bConfigDescrLock attribute is zero.

Configuration descriptor buffer consists of Device and Unit descriptor configurable parameters which are parsed from vendor specific provisioning file and then passed via configfs node at runtime to provision ufs device.
CONFIG_CONFIGFS_FS needs to be enabled for using this feature.

Usage:
1) To read current configuration descriptor :
cat /config/XXXX.ufshc/ufs_provision
2) To provision ufs device:
echo <config_desc_buf> > /config/XXXX.ufshc/ufs_provision

---
 Documentation/ABI/testing/configfs-driver-ufs |  18 +++
 drivers/scsi/ufs/Kconfig                      |  10 ++
 drivers/scsi/ufs/Makefile                     |   1 +
 drivers/scsi/ufs/ufs-configfs.c               | 157 ++++++++++++++++++++++++++
 drivers/scsi/ufs/ufshcd.c                     |   3 +-
 drivers/scsi/ufs/ufshcd.h                     |  18 +++
 6 files changed, 206 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/ABI/testing/configfs-driver-ufs
 create mode 100644 drivers/scsi/ufs/ufs-configfs.c
Documentation/ABI/testing/configfs-driver-ufs new file +18 -0
new file mode 100644
index 0000000..eeee499c
@@ -0,0 +1,18 @@
+What:		/config/ufshcd/ufs_provision
+Date:		Jun 2018
+KernelVersion:	4.14
+Description:
+		This file shows the current ufs configuration descriptor set in device.
+		This can be used to provision ufs device if bConfigDescrLock is 0.
+		For more details, refer 14.1.6.3 Configuration Descriptor and
+		Table 14-12 - Unit Descriptor configurable parameters from specs for
+		description of each configuration descriptor parameter.
+		Configuration descriptor buffer needs to be passed in space separated
+		format specificied as below:
+		echo <bLength> <bDescriptorIDN> <bConfDescContinue> <bBootEnable>
+		<bDescrAccessEn> <bInitPowerMode> <bHighPriorityLUN>
+		<bSecureRemovalType> <bInitActiveICCLevel> <wPeriodicRTCUpdate>
+		<0Bh:0Fh_ReservedAs_0> <bLUEnable> <bBootLunID> <bLUWriteProtect>
+		<bMemoryType> <dNumAllocUnits> <bDataReliability> <bLogicalBlockSize>
+		<bProvisioningType> <wContextCapabilities> <0Dh:0Fh_ReservedAs_0>
+		> /config/XXXX.ufshc/ufs_provision
drivers/scsi/ufs/Kconfig +10 -0
index e27b4d4..a9a0a58 100644
@@ -100,3 +100,13 @@ config SCSI_UFS_QCOM
 
 	  Select this if you have UFS controller on QCOM chipset.
 	  If unsure, say N.
+
+config UFS_PROVISION
+	tristate "Runtime UFS Provisioning support"
+	depends on SCSI_UFSHCD && CONFIGFS_FS
+	help
+	  This enables runtime UFS provisioning support. This can be used
+	  primarily during assembly line as some devices may be required to
+	  be configured multiple times during initial development phase.
+
+	  If unsure, say N.
drivers/scsi/ufs/Makefile +1 -0
index 918f579..00110ea 100644
@@ -5,5 +5,6 @@ obj-$(CONFIG_SCSI_UFS_DWC_TC_PLATFORM) += tc-dwc-g210-pltfrm.o ufshcd-dwc.o tc-d
 obj-$(CONFIG_SCSI_UFS_QCOM) += ufs-qcom.o
 obj-$(CONFIG_SCSI_UFSHCD) += ufshcd-core.o
 ufshcd-core-objs := ufshcd.o ufs-sysfs.o
+obj-$(CONFIG_UFS_PROVISION) += ufs-configfs.o
 obj-$(CONFIG_SCSI_UFSHCD_PCI) += ufshcd-pci.o
 obj-$(CONFIG_SCSI_UFSHCD_PLATFORM) += ufshcd-pltfrm.o
drivers/scsi/ufs/ufs-configfs.c new file +157 -0

157 lines not on this page · raw message

drivers/scsi/ufs/ufshcd.c +2 -1
index e946844..11b28bf 100644
@@ -7713,6 +7713,7 @@ int ufshcd_shutdown(struct ufs_hba *hba)
 void ufshcd_remove(struct ufs_hba *hba)
 {
 	ufs_sysfs_remove_nodes(hba->dev);
+	ufshcd_configfs_exit();
 	scsi_remove_host(hba->host);
 	/* disable interrupts */
 	ufshcd_disable_intr(hba, hba->intr_mask);
@@ -7967,7 +7968,7 @@ int ufshcd_init(struct ufs_hba *hba, void __iomem *mmio_base, unsigned int irq)
 
 	async_schedule(ufshcd_async_scan, hba);
 	ufs_sysfs_add_nodes(hba->dev);
-
+	ufshcd_configfs_init(hba, dev_name(hba->dev));
 	return 0;
 
 out_remove_scsi_host:
drivers/scsi/ufs/ufshcd.h +18 -0
index 45013b6..c5956b2 100644
@@ -37,6 +37,7 @@
 #ifndef _UFSHCD_H
 #define _UFSHCD_H
 
+#include <linux/configfs.h>
 #include <linux/module.h>
 #include <linux/kernel.h>
 #include <linux/init.h>
@@ -515,6 +516,9 @@ struct ufs_hba {
 
 	struct Scsi_Host *host;
 	struct device *dev;
+#ifdef CONFIG_UFS_PROVISION
+	struct configfs_subsystem subsys;
+#endif
 	/*
 	 * This field is to keep a reference to "scsi_device" corresponding to
 	 * "UFS device" W-LU.
@@ -868,6 +872,20 @@ int ufshcd_read_string_desc(struct ufs_hba *hba, int desc_index,
 int ufshcd_hold(struct ufs_hba *hba, bool async);
 void ufshcd_release(struct ufs_hba *hba);
 
+/* Expose UFS configfs API's */
+#ifndef CONFIG_UFS_PROVISION
+static inline int ufshcd_configfs_init(struct ufs_hba *hba, const char *name)
+{
+	return 0;
+}
+static inline void ufshcd_configfs_exit(void)
+{
+}
+#else
+int ufshcd_configfs_init(struct ufs_hba *hba, const char *name);
+void ufshcd_configfs_exit(void);
+#endif
+
 int ufshcd_map_desc_id_to_length(struct ufs_hba *hba, enum desc_idn desc_id,
 	int *desc_length);
 
Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project
#5 lore raw

Re: [PATCH V9 2/2] scsi: ufs: Add configfs support for UFS provisioning

Quoted 104 lines · Sayali Lokhande

This patch adds configfs support to provision UFS device at runtime. This feature can be primarily useful in factory or assembly line as some devices may be required to be configured multiple times during initial system development phase. Configuration Descriptors can be written multiple times until bConfigDescrLock attribute is zero.

Configuration descriptor buffer consists of Device and Unit descriptor configurable parameters which are parsed from vendor specific provisioning file and then passed via configfs node at runtime to provision ufs device.
CONFIG_CONFIGFS_FS needs to be enabled for using this feature.

Usage:
1) To read current configuration descriptor :
cat /config/XXXX.ufshc/ufs_provision
2) To provision ufs device:
echo <config_desc_buf> > /config/XXXX.ufshc/ufs_provision

---
 Documentation/ABI/testing/configfs-driver-ufs |  18 +++
 drivers/scsi/ufs/Kconfig                      |  10 ++
 drivers/scsi/ufs/Makefile                     |   1 +
 drivers/scsi/ufs/ufs-configfs.c               | 157 ++++++++++++++++++++++++++
 drivers/scsi/ufs/ufshcd.c                     |   3 +-
 drivers/scsi/ufs/ufshcd.h                     |  18 +++
 6 files changed, 206 insertions(+), 1 deletion(-)
 create mode 100644 Documentation/ABI/testing/configfs-driver-ufs
 create mode 100644 drivers/scsi/ufs/ufs-configfs.c
Documentation/ABI/testing/configfs-driver-ufs new file +18 -0
new file mode 100644
index 0000000..eeee499c
@@ -0,0 +1,18 @@
+What:          /config/ufshcd/ufs_provision
+Date:          Jun 2018
+KernelVersion: 4.14
+Description:
+               This file shows the current ufs configuration descriptor set in device.
+               This can be used to provision ufs device if bConfigDescrLock is 0.
+               For more details, refer 14.1.6.3 Configuration Descriptor and
+               Table 14-12 - Unit Descriptor configurable parameters from specs for
+               description of each configuration descriptor parameter.
+               Configuration descriptor buffer needs to be passed in space separated
+               format specificied as below:
+               echo <bLength> <bDescriptorIDN> <bConfDescContinue> <bBootEnable>
+               <bDescrAccessEn> <bInitPowerMode> <bHighPriorityLUN>
+               <bSecureRemovalType> <bInitActiveICCLevel> <wPeriodicRTCUpdate>
+               <0Bh:0Fh_ReservedAs_0> <bLUEnable> <bBootLunID> <bLUWriteProtect>
+               <bMemoryType> <dNumAllocUnits> <bDataReliability> <bLogicalBlockSize>
+               <bProvisioningType> <wContextCapabilities> <0Dh:0Fh_ReservedAs_0>
+               > /config/XXXX.ufshc/ufs_provision
drivers/scsi/ufs/Kconfig +10 -0
index e27b4d4..a9a0a58 100644
@@ -100,3 +100,13 @@ config SCSI_UFS_QCOM
 
          Select this if you have UFS controller on QCOM chipset.
          If unsure, say N.
+
+config UFS_PROVISION
+       tristate "Runtime UFS Provisioning support"
+       depends on SCSI_UFSHCD && CONFIGFS_FS
+       help
+         This enables runtime UFS provisioning support. This can be used
+         primarily during assembly line as some devices may be required to
+         be configured multiple times during initial development phase.
+
+         If unsure, say N.
drivers/scsi/ufs/Makefile +1 -0
index 918f579..00110ea 100644
@@ -5,5 +5,6 @@ obj-$(CONFIG_SCSI_UFS_DWC_TC_PLATFORM) += tc-dwc-g210-pltfrm.o ufshcd-dwc.o tc-d
 obj-$(CONFIG_SCSI_UFS_QCOM) += ufs-qcom.o
 obj-$(CONFIG_SCSI_UFSHCD) += ufshcd-core.o
 ufshcd-core-objs := ufshcd.o ufs-sysfs.o
+obj-$(CONFIG_UFS_PROVISION) += ufs-configfs.o
 obj-$(CONFIG_SCSI_UFSHCD_PCI) += ufshcd-pci.o
 obj-$(CONFIG_SCSI_UFSHCD_PLATFORM) += ufshcd-pltfrm.o
drivers/scsi/ufs/ufs-configfs.c new file +13 -0
new file mode 100644
index 0000000..09607e5
@@ -0,0 +1,157 @@
+// SPDX-License-Identifier: GPL-2.0+
+// Copyright (c) 2018, Linux Foundation.
+
+#include <linux/configfs.h>
+#include <linux/err.h>
+#include <linux/string.h>
+
+#include "ufs.h"
+#include "ufshcd.h"
+
+static inline struct ufs_hba *config_item_to_hba(struct config_item *item)
+{
+       struct config_group *group = to_config_group(item);

drivers/scsi/ufs/ufs-configfs.c line 23

Quoted 10 lines
drivers/scsi/ufs/ufs-configfs.c new file +10 -0
+       struct configfs_subsystem *subsys = to_configfs_subsystem(group);
+       struct ufs_hba *hba = container_of(subsys, struct ufs_hba, subsys);
+
+       return subsys ? hba : NULL;
+}
+
+static ssize_t ufs_provision_show(struct config_item *item, char *buf)
+{
+       u8 desc_buf[QUERY_DESC_CONFIGURATION_DEF_SIZE] = {0};
+       int buff_len = QUERY_DESC_CONFIGURATION_DEF_SIZE;

This is a nit, but buff_len is really desc_buf_len. It's confusing because you also do have a buffer named buf, which this variable is not the length of.

Quoted 13 lines
drivers/scsi/ufs/ufs-configfs.c new file +13 -0
+       int i, ret, curr_len = 0;
+       struct ufs_hba *hba = config_item_to_hba(item);
+
+       ret = ufshcd_query_descriptor_retry(hba, UPIU_QUERY_OPCODE_READ_DESC,
+               QUERY_DESC_IDN_CONFIGURATION, 0, 0, desc_buf, &buff_len);
+
+       if (ret)
+               return ret;
+
+       for (i = 0; i < buff_len; i++)
+               curr_len += snprintf((buf + curr_len), (PAGE_SIZE - curr_len),
+                               "0x%x ", desc_buf[i]);
+

drivers/scsi/ufs/ufs-configfs.c line 46

Quoted 10 lines
drivers/scsi/ufs/ufs-configfs.c new file +10 -0
+       return curr_len;
+}
+
+ssize_t ufshcd_desc_configfs_store(struct ufs_hba *hba,
+               const char *buf, size_t count)
+{
+       char *strbuf;
+       char *strbuf_copy;
+       u8 desc_buf[QUERY_DESC_CONFIGURATION_DEF_SIZE] = {0};
+       int buff_len = QUERY_DESC_CONFIGURATION_DEF_SIZE;

Same thing here, I suppose.

Quoted 19 lines
drivers/scsi/ufs/ufs-configfs.c new file +19 -0
+       char *token;
+       int i, ret, value;
+       u32 config_desc_lock = 0;
+
+       /* reserve one byte for null termination */
+       strbuf = kmalloc(count + 1, GFP_KERNEL);
+       if (!strbuf)
+               return -ENOMEM;
+
+       strbuf_copy = strbuf;
+       strlcpy(strbuf, buf, count + 1);
+
+       /* Just return if bConfigDescrLock is already set */
+       ret = ufshcd_query_attr(hba, UPIU_QUERY_OPCODE_READ_ATTR,
+               QUERY_ATTR_IDN_CONF_DESC_LOCK, 0, 0, &config_desc_lock);
+       if (ret)
+               goto out;
+
+       if (config_desc_lock) {

drivers/scsi/ufs/ufs-configfs.c line 75

Quoted 10 lines
drivers/scsi/ufs/ufs-configfs.c new file +10 -0
+               dev_err(hba->dev, "%s: bConfigDescrLock already set to %u, cannot re-provision device!\n",
+               __func__, config_desc_lock);
+               ret = -EINVAL;
+               goto out;
+       }
+
+       for (i = 0; i < QUERY_DESC_CONFIGURATION_DEF_SIZE; i++) {
+               token = strsep(&strbuf, " ");
+               if (!token && i)
+                       break;

What happens if you pass an empty buffer (eg !token && !i)? I just tried it. kstrtoint seems to fail gracefully, and I get the print below. Fine.

Quoted 8 lines
drivers/scsi/ufs/ufs-configfs.c new file +8 -0
+
+               ret = kstrtoint(token, 0, &value);
+               if (ret) {
+                       dev_err(hba->dev, "%s: kstrtoint failed %d %s\n",
+                               __func__, ret, token);
+                       ret = -EINVAL;
+                       goto out;
+               }

drivers/scsi/ufs/ufs-configfs.c line 93

Quoted 10 lines
drivers/scsi/ufs/ufs-configfs.c new file +10 -0
+               desc_buf[i] = (u8)value;
+       }
+
+       /* Write configuration descriptor to provision ufs */
+       ret = ufshcd_query_descriptor_retry(hba, UPIU_QUERY_OPCODE_WRITE_DESC,
+               QUERY_DESC_IDN_CONFIGURATION, 0, 0, desc_buf, &buff_len);
+
+       if (!ret)
+               dev_err(hba->dev, "%s: UFS Provisioning done, reboot now!\n",
+               __func__);

I wonder if this should maybe just be an info or debug message. It's really not an error, it's a celebration!

Quoted 77 lines
drivers/scsi/ufs/ufs-configfs.c new file +64 -0
+
+out:
+       kfree(strbuf_copy);
+       if (ret)
+               return ret;
+       return count;
+}
+
+static ssize_t ufs_provision_store(struct config_item *item,
+               const char *buf, size_t count)
+{
+       struct ufs_hba *hba = config_item_to_hba(item);
+
+       return ufshcd_desc_configfs_store(hba, buf, count);
+}
+
+static struct configfs_attribute ufshcd_attr_provision = {
+       .ca_name        = "ufs_provision",
+       .ca_mode        = 0644,
+       .ca_owner       = THIS_MODULE,
+       .show           = ufs_provision_show,
+       .store          = ufs_provision_store,
+};
+
+static struct configfs_attribute *ufshcd_attrs[] = {
+       &ufshcd_attr_provision,
+       NULL,
+};
+
+static struct config_item_type ufscfg_type = {
+       .ct_attrs       = ufshcd_attrs,
+       .ct_owner       = THIS_MODULE,
+};
+
+static struct configfs_subsystem ufscfg_subsys = {
+       .su_group = {
+               .cg_item = {
+                       .ci_type = &ufscfg_type,
+               },
+       },
+};
+
+int ufshcd_configfs_init(struct ufs_hba *hba, const char *name)
+{
+       int ret;
+       struct configfs_subsystem *subsys = &hba->subsys;
+
+       strncpy(ufscfg_subsys.su_group.cg_item.ci_namebuf, name, strlen(name));
+       subsys->su_group = ufscfg_subsys.su_group;
+       config_group_init(&subsys->su_group);
+       mutex_init(&subsys->su_mutex);
+       ret = configfs_register_subsystem(subsys);
+       if (ret)
+               pr_err("Error %d while registering subsystem %s\n",
+                      ret,
+                      subsys->su_group.cg_item.ci_namebuf);
+
+       return ret;
+}
+
+void ufshcd_configfs_exit(void)
+{
+       configfs_unregister_subsystem(&ufscfg_subsys);
+}
drivers/scsi/ufs/ufshcd.c +1 -0
index e946844..11b28bf 100644
@@ -7713,6 +7713,7 @@ int ufshcd_shutdown(struct ufs_hba *hba)
 void ufshcd_remove(struct ufs_hba *hba)
 {
        ufs_sysfs_remove_nodes(hba->dev);
+       ufshcd_configfs_exit();
        scsi_remove_host(hba->host);
        /* disable interrupts */
        ufshcd_disable_intr(hba, hba->intr_mask);

drivers/scsi/ufs/ufshcd.c int ufshcd_init(struct ufs_hba *hba, void __iomem *mmio_base, unsigned int irq) · line 7971

Quoted 5 lines
drivers/scsi/ufs/ufshcd.c +1 -1
@@ -7967,7 +7968,7 @@ int ufshcd_init(struct ufs_hba *hba, void __iomem *mmio_base, unsigned int irq)
 
        async_schedule(ufshcd_async_scan, hba);
        ufs_sysfs_add_nodes(hba->dev);
-
+       ufshcd_configfs_init(hba, dev_name(hba->dev));

You init function has a return int, but you never check it. Either remove the return type if you consider configfs initialization errors non-fatal, or check the error here.

Quoted 50 lines
drivers/scsi/ufs/ufshcd.c +0 -0
        return 0;
 
 out_remove_scsi_host:
drivers/scsi/ufs/ufshcd.h +18 -1
index 45013b6..c5956b2 100644
@@ -37,6 +37,7 @@
 #ifndef _UFSHCD_H
 #define _UFSHCD_H
 
+#include <linux/configfs.h>
 #include <linux/module.h>
 #include <linux/kernel.h>
 #include <linux/init.h>
@@ -515,6 +516,9 @@ struct ufs_hba {
 
        struct Scsi_Host *host;
        struct device *dev;
+#ifdef CONFIG_UFS_PROVISION
+       struct configfs_subsystem subsys;
+#endif
        /*
         * This field is to keep a reference to "scsi_device" corresponding to
         * "UFS device" W-LU.
@@ -868,6 +872,20 @@ int ufshcd_read_string_desc(struct ufs_hba *hba, int desc_index,
 int ufshcd_hold(struct ufs_hba *hba, bool async);
 void ufshcd_release(struct ufs_hba *hba);
 
+/* Expose UFS configfs API's */
+#ifndef CONFIG_UFS_PROVISION
+static inline int ufshcd_configfs_init(struct ufs_hba *hba, const char *name)
+{
+       return 0;
+}
+static inline void ufshcd_configfs_exit(void)
+{
+}
+#else
+int ufshcd_configfs_init(struct ufs_hba *hba, const char *name);
+void ufshcd_configfs_exit(void);
+#endif
+
 int ufshcd_map_desc_id_to_length(struct ufs_hba *hba, enum desc_idn desc_id,
        int *desc_length);
 
--

The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project

#6 lore raw

Re: [PATCH V9 2/2] scsi: ufs: Add configfs support for UFS provisioning

Quoted 109 lines · Evan Green
Quoted 108 lines · Sayali Lokhande

This patch adds configfs support to provision UFS device at runtime. This feature can be primarily useful in factory or assembly line as some devices may be required to be configured multiple times during initial system development phase. Configuration Descriptors can be written multiple times until bConfigDescrLock attribute is zero.

Configuration descriptor buffer consists of Device and Unit descriptor configurable parameters which are parsed from vendor specific provisioning file and then passed via configfs node at runtime to provision ufs device.
CONFIG_CONFIGFS_FS needs to be enabled for using this feature.

Usage:
1) To read current configuration descriptor :
cat /config/XXXX.ufshc/ufs_provision
2) To provision ufs device:
echo <config_desc_buf> > /config/XXXX.ufshc/ufs_provision

---
  Documentation/ABI/testing/configfs-driver-ufs |  18 +++
  drivers/scsi/ufs/Kconfig                      |  10 ++
  drivers/scsi/ufs/Makefile                     |   1 +
  drivers/scsi/ufs/ufs-configfs.c               | 157 ++++++++++++++++++++++++++
  drivers/scsi/ufs/ufshcd.c                     |   3 +-
  drivers/scsi/ufs/ufshcd.h                     |  18 +++
  6 files changed, 206 insertions(+), 1 deletion(-)

create mode 100644 Documentation/ABI/testing/configfs-driver-ufs create mode 100644 drivers/scsi/ufs/ufs-configfs.c

Documentation/ABI/testing/configfs-driver-ufs new file +18 -0
new file mode 100644
index 0000000..eeee499c
@@ -0,0 +1,18 @@
+What:          /config/ufshcd/ufs_provision
+Date:          Jun 2018
+KernelVersion: 4.14
+Description:
+               This file shows the current ufs configuration descriptor set in device.
+               This can be used to provision ufs device if bConfigDescrLock is 0.
+               For more details, refer 14.1.6.3 Configuration Descriptor and
+               Table 14-12 - Unit Descriptor configurable parameters from specs for
+               description of each configuration descriptor parameter.
+               Configuration descriptor buffer needs to be passed in space separated
+               format specificied as below:
+               echo <bLength> <bDescriptorIDN> <bConfDescContinue> <bBootEnable>
+               <bDescrAccessEn> <bInitPowerMode> <bHighPriorityLUN>
+               <bSecureRemovalType> <bInitActiveICCLevel> <wPeriodicRTCUpdate>
+               <0Bh:0Fh_ReservedAs_0> <bLUEnable> <bBootLunID> <bLUWriteProtect>
+               <bMemoryType> <dNumAllocUnits> <bDataReliability> <bLogicalBlockSize>
+               <bProvisioningType> <wContextCapabilities> <0Dh:0Fh_ReservedAs_0>
+               > /config/XXXX.ufshc/ufs_provision
drivers/scsi/ufs/Kconfig +10 -0
index e27b4d4..a9a0a58 100644
@@ -100,3 +100,13 @@ config SCSI_UFS_QCOM
 
           Select this if you have UFS controller on QCOM chipset.
           If unsure, say N.
+
+config UFS_PROVISION
+       tristate "Runtime UFS Provisioning support"
+       depends on SCSI_UFSHCD && CONFIGFS_FS
+       help
+         This enables runtime UFS provisioning support. This can be used
+         primarily during assembly line as some devices may be required to
+         be configured multiple times during initial development phase.
+
+         If unsure, say N.
drivers/scsi/ufs/Makefile +1 -0
index 918f579..00110ea 100644
@@ -5,5 +5,6 @@ obj-$(CONFIG_SCSI_UFS_DWC_TC_PLATFORM) += tc-dwc-g210-pltfrm.o ufshcd-dwc.o tc-d
  obj-$(CONFIG_SCSI_UFS_QCOM) += ufs-qcom.o
  obj-$(CONFIG_SCSI_UFSHCD) += ufshcd-core.o
  ufshcd-core-objs := ufshcd.o ufs-sysfs.o
+obj-$(CONFIG_UFS_PROVISION) += ufs-configfs.o
  obj-$(CONFIG_SCSI_UFSHCD_PCI) += ufshcd-pci.o
  obj-$(CONFIG_SCSI_UFSHCD_PLATFORM) += ufshcd-pltfrm.o
drivers/scsi/ufs/ufs-configfs.c new file +18 -0
new file mode 100644
index 0000000..09607e5
@@ -0,0 +1,157 @@
+// SPDX-License-Identifier: GPL-2.0+
+// Copyright (c) 2018, Linux Foundation.
+
+#include <linux/configfs.h>
+#include <linux/err.h>
+#include <linux/string.h>
+
+#include "ufs.h"
+#include "ufshcd.h"
+
+static inline struct ufs_hba *config_item_to_hba(struct config_item *item)
+{
+       struct config_group *group = to_config_group(item);
+       struct configfs_subsystem *subsys = to_configfs_subsystem(group);
+       struct ufs_hba *hba = container_of(subsys, struct ufs_hba, subsys);
+
+       return subsys ? hba : NULL;
+}
Quoted 8 lines

drivers/scsi/ufs/ufs-configfs.c line 23

Quoted 5 lines
drivers/scsi/ufs/ufs-configfs.c new file +5 -0
+
+static ssize_t ufs_provision_show(struct config_item *item, char *buf)
+{
+       u8 desc_buf[QUERY_DESC_CONFIGURATION_DEF_SIZE] = {0};
+       int buff_len = QUERY_DESC_CONFIGURATION_DEF_SIZE;

This is a nit, but buff_len is really desc_buf_len. It's confusing because you also do have a buffer named buf, which this variable is not the length of.

Agree. Will rename it to desc_buf_len to avoid confusion.

Quoted 16 lines
Quoted 16 lines
drivers/scsi/ufs/ufs-configfs.c new file +16 -0
+       int i, ret, curr_len = 0;
+       struct ufs_hba *hba = config_item_to_hba(item);
+
+       ret = ufshcd_query_descriptor_retry(hba, UPIU_QUERY_OPCODE_READ_DESC,
+               QUERY_DESC_IDN_CONFIGURATION, 0, 0, desc_buf, &buff_len);
+
+       if (ret)
+               return ret;
+
+       for (i = 0; i < buff_len; i++)
+               curr_len += snprintf((buf + curr_len), (PAGE_SIZE - curr_len),
+                               "0x%x ", desc_buf[i]);
+
+       return curr_len;
+}
+
Quoted 8 lines

drivers/scsi/ufs/ufs-configfs.c line 46

Quoted 7 lines
drivers/scsi/ufs/ufs-configfs.c new file +7 -0
+ssize_t ufshcd_desc_configfs_store(struct ufs_hba *hba,
+               const char *buf, size_t count)
+{
+       char *strbuf;
+       char *strbuf_copy;
+       u8 desc_buf[QUERY_DESC_CONFIGURATION_DEF_SIZE] = {0};
+       int buff_len = QUERY_DESC_CONFIGURATION_DEF_SIZE;

Same thing here, I suppose.

Done.

Quoted 24 lines
Quoted 24 lines
drivers/scsi/ufs/ufs-configfs.c new file +24 -0
+       char *token;
+       int i, ret, value;
+       u32 config_desc_lock = 0;
+
+       /* reserve one byte for null termination */
+       strbuf = kmalloc(count + 1, GFP_KERNEL);
+       if (!strbuf)
+               return -ENOMEM;
+
+       strbuf_copy = strbuf;
+       strlcpy(strbuf, buf, count + 1);
+
+       /* Just return if bConfigDescrLock is already set */
+       ret = ufshcd_query_attr(hba, UPIU_QUERY_OPCODE_READ_ATTR,
+               QUERY_ATTR_IDN_CONF_DESC_LOCK, 0, 0, &config_desc_lock);
+       if (ret)
+               goto out;
+
+       if (config_desc_lock) {
+               dev_err(hba->dev, "%s: bConfigDescrLock already set to %u, cannot re-provision device!\n",
+               __func__, config_desc_lock);
+               ret = -EINVAL;
+               goto out;
+       }
Quoted 8 lines

drivers/scsi/ufs/ufs-configfs.c line 75

Quoted 5 lines
drivers/scsi/ufs/ufs-configfs.c new file +5 -0
+
+       for (i = 0; i < QUERY_DESC_CONFIGURATION_DEF_SIZE; i++) {
+               token = strsep(&strbuf, " ");
+               if (!token && i)
+                       break;

What happens if you pass an empty buffer (eg !token && !i)? I just tried it. kstrtoint seems to fail gracefully, and I get the print below. Fine.

Ok . it looks Fine.

Quoted 12 lines
Quoted 12 lines
drivers/scsi/ufs/ufs-configfs.c new file +12 -0
+
+               ret = kstrtoint(token, 0, &value);
+               if (ret) {
+                       dev_err(hba->dev, "%s: kstrtoint failed %d %s\n",
+                               __func__, ret, token);
+                       ret = -EINVAL;
+                       goto out;
+               }
+               desc_buf[i] = (u8)value;
+       }
+
+       /* Write configuration descriptor to provision ufs */
Quoted 8 lines

drivers/scsi/ufs/ufs-configfs.c line 93

Quoted 6 lines
drivers/scsi/ufs/ufs-configfs.c new file +6 -0
+       ret = ufshcd_query_descriptor_retry(hba, UPIU_QUERY_OPCODE_WRITE_DESC,
+               QUERY_DESC_IDN_CONFIGURATION, 0, 0, desc_buf, &buff_len);
+
+       if (!ret)
+               dev_err(hba->dev, "%s: UFS Provisioning done, reboot now!\n",
+               __func__);

I wonder if this should maybe just be an info or debug message. It's really not an error, it's a celebration!

Agree.  :)

Quoted 78 lines
Quoted 78 lines
drivers/scsi/ufs/ufs-configfs.c new file +64 -0
+
+out:
+       kfree(strbuf_copy);
+       if (ret)
+               return ret;
+       return count;
+}
+
+static ssize_t ufs_provision_store(struct config_item *item,
+               const char *buf, size_t count)
+{
+       struct ufs_hba *hba = config_item_to_hba(item);
+
+       return ufshcd_desc_configfs_store(hba, buf, count);
+}
+
+static struct configfs_attribute ufshcd_attr_provision = {
+       .ca_name        = "ufs_provision",
+       .ca_mode        = 0644,
+       .ca_owner       = THIS_MODULE,
+       .show           = ufs_provision_show,
+       .store          = ufs_provision_store,
+};
+
+static struct configfs_attribute *ufshcd_attrs[] = {
+       &ufshcd_attr_provision,
+       NULL,
+};
+
+static struct config_item_type ufscfg_type = {
+       .ct_attrs       = ufshcd_attrs,
+       .ct_owner       = THIS_MODULE,
+};
+
+static struct configfs_subsystem ufscfg_subsys = {
+       .su_group = {
+               .cg_item = {
+                       .ci_type = &ufscfg_type,
+               },
+       },
+};
+
+int ufshcd_configfs_init(struct ufs_hba *hba, const char *name)
+{
+       int ret;
+       struct configfs_subsystem *subsys = &hba->subsys;
+
+       strncpy(ufscfg_subsys.su_group.cg_item.ci_namebuf, name, strlen(name));
+       subsys->su_group = ufscfg_subsys.su_group;
+       config_group_init(&subsys->su_group);
+       mutex_init(&subsys->su_mutex);
+       ret = configfs_register_subsystem(subsys);
+       if (ret)
+               pr_err("Error %d while registering subsystem %s\n",
+                      ret,
+                      subsys->su_group.cg_item.ci_namebuf);
+
+       return ret;
+}
+
+void ufshcd_configfs_exit(void)
+{
+       configfs_unregister_subsystem(&ufscfg_subsys);
+}
drivers/scsi/ufs/ufshcd.c +1 -0
index e946844..11b28bf 100644
@@ -7713,6 +7713,7 @@ int ufshcd_shutdown(struct ufs_hba *hba)
  void ufshcd_remove(struct ufs_hba *hba)
  {
         ufs_sysfs_remove_nodes(hba->dev);
+       ufshcd_configfs_exit();
         scsi_remove_host(hba->host);
         /* disable interrupts */
         ufshcd_disable_intr(hba, hba->intr_mask);
@@ -7967,7 +7968,7 @@ int ufshcd_init(struct ufs_hba *hba, void __iomem *mmio_base, unsigned int irq)
 
Quoted 7 lines

drivers/scsi/ufs/ufshcd.c int ufshcd_init(struct ufs_hba *hba, void __iomem *mmio_base, unsigned int irq) · line 7971

Quoted 4 lines
drivers/scsi/ufs/ufshcd.c +1 -1
         async_schedule(ufshcd_async_scan, hba);
         ufs_sysfs_add_nodes(hba->dev);
-
+       ufshcd_configfs_init(hba, dev_name(hba->dev));

You init function has a return int, but you never check it. Either remove the return type if you consider configfs initialization errors non-fatal, or check the error here.

Agree. It should be void type.

Quoted 50 lines
Quoted 50 lines
drivers/scsi/ufs/ufshcd.c +0 -0
         return 0;
 
  out_remove_scsi_host:
drivers/scsi/ufs/ufshcd.h +18 -1
index 45013b6..c5956b2 100644
@@ -37,6 +37,7 @@
  #ifndef _UFSHCD_H
  #define _UFSHCD_H
 
+#include <linux/configfs.h>
  #include <linux/module.h>
  #include <linux/kernel.h>
  #include <linux/init.h>
@@ -515,6 +516,9 @@ struct ufs_hba {
 
         struct Scsi_Host *host;
         struct device *dev;
+#ifdef CONFIG_UFS_PROVISION
+       struct configfs_subsystem subsys;
+#endif
         /*
          * This field is to keep a reference to "scsi_device" corresponding to
          * "UFS device" W-LU.
@@ -868,6 +872,20 @@ int ufshcd_read_string_desc(struct ufs_hba *hba, int desc_index,
  int ufshcd_hold(struct ufs_hba *hba, bool async);
  void ufshcd_release(struct ufs_hba *hba);
 
+/* Expose UFS configfs API's */
+#ifndef CONFIG_UFS_PROVISION
+static inline int ufshcd_configfs_init(struct ufs_hba *hba, const char *name)
+{
+       return 0;
+}
+static inline void ufshcd_configfs_exit(void)
+{
+}
+#else
+int ufshcd_configfs_init(struct ufs_hba *hba, const char *name);
+void ufshcd_configfs_exit(void);
+#endif
+
  int ufshcd_map_desc_id_to_length(struct ufs_hba *hba, enum desc_idn desc_id,
         int *desc_length);
 
--

The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum, a Linux Foundation Collaborative Project