scsi: ufs: set the device reference clock setting
A message that is not in the archive (sent off-list or not yet received): [email protected]
PATCH v14 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-pltfrm.c | 2 + drivers/scsi/ufs/ufshcd.c | 87 ++++++++++++++++++++++++++++++++++++++++ drivers/scsi/ufs/ufshcd.h | 2 + 4 files changed, 105 insertions(+)
drivers/scsi/ufs/ufs.h +14 -0
@@ -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-pltfrm.c +2 -0
@@ -343,6 +343,8 @@ int ufshcd_pltfrm_init(struct platform_device *pdev,pm_runtime_set_active (&pdev->dev);pm_runtime_enable (&pdev->dev); +ufshcd_parse_dev_ref_clk_freq (hba); +ufshcd_init_lanes_per_dir (hba); err =ufshcd_init (hba, mmio_base, irq);
drivers/scsi/ufs/ufshcd.c +87 -0
105 lines not on this page · raw message
drivers/scsi/ufs/ufshcd.h +2 -0
@@ -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
Quoted 7 lines
drivers/scsi/ufs/ufshcd.c +6
-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 },
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6314
Quoted 10 lines
drivers/scsi/ufs/ufshcd.c +10
-0+}; + +static inline enum ufs_ref_clk_freq +ufs_get_bref_clk_from_hz (u32 freq) +{ +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 ;
Is the if clause really needed?
you will return REF_CLK_FREQ_INVAL anyway
Quoted 1 line
+ i++;
You might overrun here if freq is not what you've expected
Quoted 4 lines
drivers/scsi/ufs/ufshcd.c +4
-0+ } + +return ufs_ref_clk_freqs[i].val; +}
Quoted 10 lines · Avri Altman
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_from_hz (u32 freq)
Quoted 8 lines
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6314
Quoted 6 lines
drivers/scsi/ufs/ufshcd.c +6
-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 ;Is the if clause really needed?
you will returnREF_CLK_FREQ_INVALanyway
Yes. the if condition makes sure to return REF_CLK_FREQ_INVAL if freq is not what we expect.
Quoted 3 lines
Quoted 2 lines
+ i++;
You might overrun here if freq is not what you've expected
Above if condition "if (!ufs_ref_clk_freqs[i].freq_hz)" prevents such overrun
as we will reach end of ufs_ref_clk_freqs[] (i.e upto 0, REF_CLK_FREQ_INVAL) when there is no match and thus we will return REF_CLK_FREQ_INVAL.
Quoted 4 lines
Quoted 4 lines
drivers/scsi/ufs/ufshcd.c +4
-0+ } + +return ufs_ref_clk_freqs[i].val; +}
Hi,
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6307
Quoted 9 lines · Sayali Lokhande
drivers/scsi/ufs/ufshcd.c +9
-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
Please don't specify inline. Let the compiler decide whether inline is better.
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6318
Quoted 11 lines
drivers/scsi/ufs/ufshcd.c +11
-0+ufs_get_bref_clk_from_hz(u32 freq) +{ +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;
I think you'll have less confusion if you write the above as this (untested):
for (i = 0; ufs_ref_clk_freqs[i].freq_hz; i++) {
if (ufs_ref_clk_freqs[i].freq_hz == freq)
return ufs_ref_clk_freqs[i].val; }
return REF_CLK_FREQ_INVAL;
Now it looks like a normal iteration till a normal stop condition (NULL term array).
Quoted 1 line
+void
ufshcd_parse_dev_ref_clk_freq(struct ufs_hba *hba)
Shouldn't this return an error code so that if there's a problem it can return back to the caller? Right now you print error messages but ufshcd_pltfrm_init() will plow merrily along after.
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6326
Quoted 5 lines
drivers/scsi/ufs/ufshcd.c +5
-0+{ +struct device *dev = hba->dev; +struct device_node *np = dev->of_node; +struct clk *refclk =NULL ; +u32 freq =0 ;
"freq" should be "unsigned long" to match clk_get_rate(), not u32. Similarly all the places you pass it to and store it in should be "unsigned long" too. Save "u32" for values which are being programmed into 32-bit hardware registers.
Review
Quoted 2 lines
(quoted diff) +2
-0+ if (!np) + return;
You don't need to check for (!np). If you do clk_get() and there's no np you'll get get an error back. Handle it there.
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6333
Quoted 4 lines
drivers/scsi/ufs/ufshcd.c +4
-0+ + refclk =of_clk_get_by_name (np,"ref_clk" ); +if (!refclk) +return ;
I can't quickly tell. Are you intending "ref_clk" to be optional or required? You check against "NULL" and return with no error message, so I'm kinda assuming it's optional. ...but:
1. of_clk_get_by_name() doesn't return NULL when the clock wasn't specified. It returns "-ENOENT". That means that (right now) anyone who doesn't specify a "ref_clk" will get a crash when you try calling clk_get_rate() on the error-code-clk.
2. It seems like it would be good to add a comment that "dev_ref_clk_freq" was already initted to "REF_CLK_FREQ_INVAL in ufshcd_alloc_host() to make it obvious how people are working that didn't specify "ref_clk".
One note is that regardless of whether "ref_clk" is optional or required, something about "ref_clk" should be mentioned in "Documentation/devicetree/bindings/ufs/ufshcd-pltfrm.txt" so people know that's an important clock name.
Yet another note here is that I'm confused why you'd want to use of_clk_get_by_name(). Why not use clk_get()? You've already got the "dev" node and clk_get() should be preferred since not everyone uses device tree.
OK, one last note is that clk_get() could return -EPROBE_DEFER. In such a case you need to basically cancel your whole probe and propagate the -EPROBE_DEFER. Make sure you think about that when you're coding things up.
OK, I lied about the previous one being the last note. Why don't you just add a bit of code in the ufshcd_init_clocks() loop. If you notice that the clock name is "ref_clk" (similar to how __ufshcd_setup_clocks() checks) then you can grab the frequency. Then you can avoid dealing with all my comments above about of_clk_get_by_name() and errors and -EPROBE_DEFER...
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6343
Quoted 9 lines
drivers/scsi/ufs/ufshcd.c +9
-0+ freq =clk_get_rate (refclk); + + hba->dev_ref_clk_freq = +ufs_get_bref_clk_from_hz (freq); + +if (hba->dev_ref_clk_freq ==REF_CLK_FREQ_INVAL ) +dev_err (hba->dev, +"%s: invalid ref_clk setting = %d\n" , + __func__, freq);
nit: including "__func__" in dev_xxx() calls is discouraged. The "dev_xxx" calls already print the device name and the string within a given device driver should be unique enough so __func__ just adds crap to the logs. If you really feel that __func__ adds something for you, try posting up a patch to make all "dev_err" functions include __func__. ...but I think you'd probably be rejected.
Also (more important): You're missing a clk_put(). Thus you're leaking a reference to "ref_clk".
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6349
Quoted 6 lines
drivers/scsi/ufs/ufshcd.c +6
-0+} + +static int ufshcd_set_dev_ref_clk (struct ufs_hba *hba) +{ +int err, ref_clk =-1 ; +u32 freq = hba->dev_ref_clk_freq;
Ugh, this is ugly. hba->dev_ref_clk_freq could be -1 but you're jamming it into a u32 here. That doesn't seem so ideal. Are you sure -1 was the best choice for REF_CLK_FREQ_INVAL?
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6352
Quoted 3 lines
drivers/scsi/ufs/ufshcd.c +3
-0+ + err =ufshcd_query_attr_retry (hba,UPIU_QUERY_OPCODE_READ_ATTR , +QUERY_ATTR_IDN_REF_CLK_FREQ ,0 ,0 , &ref_clk);
It's not so wonderful to be passing a pointer to an "int" to a function expecting a pointer to a "u32". Change "ref_clk" to "u32".
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6356
Quoted 4 lines
drivers/scsi/ufs/ufshcd.c +4
-0+ +if (err) { +dev_err (hba->dev,"%s: failed reading bRefClkFreq. err = %d\n" , + __func__, err);
Again, no __func__.
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6360
Quoted 4 lines
drivers/scsi/ufs/ufshcd.c +4
-0+ goto out; + } + +if (ref_clk == hba->dev_ref_clk_freq)
nit: you already cached "hba->dev_ref_clk_freq in "freq". Use it.
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6368
Quoted 8 lines
drivers/scsi/ufs/ufshcd.c +8
-0+ 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" , + __func__, ufs_ref_clk_freqs[freq].freq_hz);
Again, no __func__.
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6373
Quoted 5 lines
drivers/scsi/ufs/ufshcd.c +5
-0+ goto out; + } + +dev_dbg (hba->dev,"%s: bRefClkFreq setting to %u Hz succeeded\n" , + __func__, ufs_ref_clk_freqs[freq].freq_hz);
Again, no __func__.
Hi
Quoted 13 lines · Doug Anderson
Hi,
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6307
Quoted 9 lines · Sayali Lokhande
drivers/scsi/ufs/ufshcd.c +9
-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_freqPlease don't specify inline. Let the compiler decide whether inline is better.
Done
Quoted 19 lines
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6318
Quoted 12 lines
drivers/scsi/ufs/ufshcd.c +11
-0+ufs_get_bref_clk_from_hz(u32 freq) +{ +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;I think you'll have less confusion if you write the above as this (untested):
for (i = 0; ufs_ref_clk_freqs[i].freq_hz; i++) { if (ufs_ref_clk_freqs[i].freq_hz == freq) return ufs_ref_clk_freqs[i].val; }
Quoted 5 lines
return
REF_CLK_FREQ_INVAL;Now it looks like a normal iteration till a normal stop condition (NULL term array).
Will update.
Quoted 4 lines
Quoted 1 line
+void
ufshcd_parse_dev_ref_clk_freq(struct ufs_hba *hba)Shouldn't this return an error code so that if there's a problem it can return back to the caller? Right now you print error messages but
ufshcd_pltfrm_init()will plow merrily along after.
We need not return error if no specific device ref clk was found via DT parsing. Device reference clock will be already set(bRefClkFreq MDV : 26MHz). So no need to fail if we find invalid/no ref clk passed.
Quoted 11 lines
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6326
Quoted 6 lines
drivers/scsi/ufs/ufshcd.c +5
-0+{ +struct device *dev = hba->dev; +struct device_node *np = dev->of_node; +struct clk *refclk =NULL ; +u32 freq =0 ;"freq" should be "unsigned long" to match
clk_get_rate(), not u32. Similarly all the places you pass it to and store it in should be "unsigned long" too. Save "u32" for values which are being programmed into 32-bit hardware registers.
Will update.
Quoted 5 lines
Review
Quoted 2 lines
(quoted diff) +2
-0+ if (!np) + return;You don't need to check for (!np). If you do
clk_get()and there's no np you'll get get an error back. Handle it there.
Will update.
Quoted 7 lines
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6333
Quoted 4 lines
drivers/scsi/ufs/ufshcd.c +4
-0+ + refclk =of_clk_get_by_name (np,"ref_clk" ); +if (!refclk) +return ;I can't quickly tell. Are you intending "
ref_clk" to be optional or required? You check against "NULL" and return with no error message, so I'm kinda assuming it's optional. ...but:
Explicit setting of device reference clock is not mandatory. It will be already set (MDV: 26Hz).
We first read the current ref clk setting in device and if host is passing different (but valid) ref clk freq then we go ahead and update it, otherwise we just return.
Quoted 9 lines
1.
of_clk_get_by_name()doesn't return NULL when the clock wasn't specified. It returns "-ENOENT". That means that (right now) anyone who doesn't specify a "ref_clk" will get a crash when you try callingclk_get_rate()on the error-code-clk.2. It seems like it would be good to add a comment that "
dev_ref_clk_freq" was already initted to "REF_CLK_FREQ_INVALinufshcd_alloc_host()to make it obvious how people are working that didn't specify "ref_clk".
Will add comment to clarify that dev_ref_clk_freq is default set as REF_CLK_FREQ_INVA.
Quoted 6 lines
One note is that regardless of whether "
ref_clk" is optional or required, something about "ref_clk" should be mentioned in "Documentation/devicetree/bindings/ufs/ufshcd-pltfrm.txt" so people know that's an important clock name.
Will check and add required documentation.
Quoted 4 lines
Yet another note here is that I'm confused why you'd want to use
of_clk_get_by_name(). Why not useclk_get()? You've already got the "dev" node andclk_get()should be preferred since not everyone uses device tree.
Will update.
Quoted 7 lines
OK, one last note is that
clk_get()could return -EPROBE_DEFER. In such a case you need to basically cancel your whole probe and propagate the -EPROBE_DEFER. Make sure you think about that when you're coding things up.
Quoted 7 lines
OK, I lied about the previous one being the last note. Why don't you just add a bit of code in the
ufshcd_init_clocks()loop. If you notice that the clock name is "ref_clk" (similar to how__ufshcd_setup_clocks()checks) then you can grab the frequency. Then you can avoid dealing with all my comments above aboutof_clk_get_by_name()and errors and -EPROBE_DEFER...
Will consider above suggestion and update.
May be I can just call ufshcd_parse_dev_ref_clk_freq (hba, ref_clk) from ufshcd_init_clocks() loop and pass ref_clk to it.
Quoted 7 lines
Quoted 7 lines
drivers/scsi/ufs/ufshcd.c +7
-0+ freq =clk_get_rate (refclk); + + hba->dev_ref_clk_freq = +ufs_get_bref_clk_from_hz (freq); + +if (hba->dev_ref_clk_freq ==REF_CLK_FREQ_INVAL ) + dev_err(hba->dev,
Quoted 8 lines
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6343
Quoted 2 lines
drivers/scsi/ufs/ufshcd.c +2
-0+"%s: invalid ref_clk setting = %d\n" , + __func__, freq);nit: including "
__func__" indev_xxx()calls is discouraged. The "dev_xxx" calls already print the device name and the string within a given device driver should be unique enough so__func__just adds crap to the logs. If you really feel that__func__adds something for you, try posting up a patch to make all "dev_err" functions include__func__. ...but I think you'd probably be rejected.
will remove __func__ .
Quoted 5 lines
Also (more important): You're missing a
clk_put(). Thus you're leaking a reference to "ref_clk".
Quoted 9 lines
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6349
Quoted 6 lines
drivers/scsi/ufs/ufshcd.c +6
-0+} + +static int ufshcd_set_dev_ref_clk (struct ufs_hba *hba) +{ +int err, ref_clk =-1 ; +u32 freq = hba->dev_ref_clk_freq;Ugh, this is ugly.
hba->dev_ref_clk_freqcould be -1 but you're jamming it into a u32 here. That doesn't seem so ideal. Are you sure -1 was the best choice forREF_CLK_FREQ_INVAL?
ufshcd_set_dev_ref_clk() is only called if (dev_ref_clk_freq != REF_CLK_FREQ_INVAL). So we only set freq if we get a valid parsed ref clk freq (0/1/2/3h).
Quoted 6 lines
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6352
Quoted 4 lines
drivers/scsi/ufs/ufshcd.c +3
-0+ + err =ufshcd_query_attr_retry (hba,UPIU_QUERY_OPCODE_READ_ATTR , +QUERY_ATTR_IDN_REF_CLK_FREQ ,0 ,0 , &ref_clk);It's not so wonderful to be passing a pointer to an "int" to a function expecting a pointer to a "u32". Change "
ref_clk" to "u32".
done
Quoted 7 lines
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6356
Quoted 5 lines
drivers/scsi/ufs/ufshcd.c +4
-0+ +if (err) { +dev_err (hba->dev,"%s: failed reading bRefClkFreq. err = %d\n" , + __func__, err);Again, no
__func__.
Will remove __func__
Quoted 5 lines
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6360
Quoted 4 lines
drivers/scsi/ufs/ufshcd.c +4
-0+ goto out; + } + +if (ref_clk == hba->dev_ref_clk_freq)nit: you already cached "
hba->dev_ref_clk_freqin "freq". Use it.
Will update
Quoted 11 lines
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6368
Quoted 9 lines
drivers/scsi/ufs/ufshcd.c +8
-0+ 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" , + __func__, ufs_ref_clk_freqs[freq].freq_hz);Again, no
__func__.
Will remove __func__
Quoted 6 lines
drivers/scsi/ufs/ufshcd.c static void ufshcd_def_desc_sizes(struct ufs_hba *hba) · line 6373
Quoted 5 lines
drivers/scsi/ufs/ufshcd.c +5
-0+ goto out; + } + +dev_dbg (hba->dev,"%s: bRefClkFreq setting to %u Hz succeeded\n" , + __func__, ufs_ref_clk_freqs[freq].freq_hz);Again, no
__func__.
Will remove __func__
PATCH v14 2/2 scsi: ufs: Add configfs support for UFS provisioning
In reply to a message not in the archiveThis 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 and CONFIG_SCSI_UFS_PROVISION needs to be enabled for using this feature.
Usage:
1) To read current configuration descriptor with index X (where index X can be 0/1/2/3) :
cat /config/<device_name>/ufs_config_desc_X
2) To write configuration descriptor with index X :
echo <config_desc_buf> > /config/<device_name>/ufs_config_desc_X
--- Documentation/ABI/testing/configfs-driver-ufs | 12 ++ drivers/scsi/ufs/Kconfig | 10 ++ drivers/scsi/ufs/Makefile | 1 + drivers/scsi/ufs/ufs-configfs.c | 237 ++++++++++++++++++++++++++ drivers/scsi/ufs/ufshcd.c | 3 +- drivers/scsi/ufs/ufshcd.h | 18 ++ 6 files changed, 280 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 +12 -0
@@ -0,0 +1,12 @@ +What: /config/*/ufs_config_desc_X +Date: Jun 2018 +KernelVersion: 4.20 +Description: + This file shows bytes of the current ufs configuration descriptor + with index X (where X = 0/1/2/3) 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 and format of each configuration descriptor parameter. + Parameters of Configuration descriptor buffer for respective index + needs to be passed as bytes in space separated format.
drivers/scsi/ufs/Kconfig +10 -0
@@ -100,3 +100,13 @@ config SCSI_UFS_QCOM Select this if you have UFS controller on QCOM chipset. If unsure, say N. + +config SCSI_UFS_PROVISION + bool "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
@@ -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_SCSI_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 +237 -0
237 lines not on this page · raw message
drivers/scsi/ufs/ufshcd.c +2 -1
@@ -7708,6 +7708,7 @@ int ufshcd_shutdown(struct ufs_hba *hba)void ufshcd_remove (struct ufs_hba *hba) {ufs_sysfs_remove_nodes (hba->dev); +ufshcd_configfs_exit (hba);scsi_remove_host (hba->host);/* disable interrupts */ ufshcd_disable_intr (hba, hba->intr_mask);
@@ -7962,7 +7963,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
@@ -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_SCSI_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_SCSI_UFS_PROVISION +static inline void ufshcd_configfs_init (struct ufs_hba *hba,const char *name) +{ +} + +static inline void ufshcd_configfs_exit (struct ufs_hba *hba) +{ +} +#else +void ufshcd_configfs_init (struct ufs_hba *hba,const char *name); +void ufshcd_configfs_exit (struct ufs_hba *hba); +#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
Re: [PATCH V14 2/2] scsi: ufs: Add configfs support for UFS provisioning
Quoted 4 lines
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_SCSI_UFS_PROVISION) += ufs-configfs.o
Isn't ufs-configfs should be part of ufshcd-core? like ufs-sysfs ?
drivers/scsi/ufs/ufs-configfs.c line 22
Quoted 3 lines
drivers/scsi/ufs/ufs-configfs.c new file +3
-0+static ssize_t ufs_config_desc_show (struct config_item *item,char *buf, +u8 index) +{
The read part already exist in ufs-sysfs.
drivers/scsi/ufs/ufs-configfs.c line 89
Quoted 10 lines
drivers/scsi/ufs/ufs-configfs.c new file +8
-0+ssize_t ufshcd_desc_configfs_store (struct config_item *item,const char *buf, +size_t count,u8 index) +{ + +/* +* First read the current configuration descriptor +* and then update with user provided parameters +*/
if originally only lun0 was configured, and you want to configure a new set of luns - luns 8 to 15 (config index 0x1) - won't the read fail in that case?
Thanks,
Avri
Re: [PATCH V14 2/2] scsi: ufs: Add configfs support for UFS provisioning
Quoted 5 lines · Avri Altman
Quoted 4 lines
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_SCSI_UFS_PROVISION) += ufs-configfs.o
Isn't ufs-configfs should be part of ufshcd-core? like ufs-sysfs ?
Agree. Will update.
Quoted 6 lines
drivers/scsi/ufs/ufs-configfs.c line 22
Quoted 5 lines
drivers/scsi/ufs/ufs-configfs.c new file +3
-0+static ssize_t ufs_config_desc_show (struct config_item *item,char *buf, +u8 index) +{The read part already exist in ufs-sysfs.
User can just read the existing desc here and update the required fields as per need and write updated buffer to same configfs path. I think its better to have both r/w functionality here.
Quoted 5 lines
Quoted 4 lines
drivers/scsi/ufs/ufs-configfs.c new file +3
-0+ssize_t ufshcd_desc_configfs_store (struct config_item *item,const char *buf, +size_t count,u8 index) +{
Quoted 7 lines
drivers/scsi/ufs/ufs-configfs.c line 89
Quoted 5 lines
drivers/scsi/ufs/ufs-configfs.c new file +5
-0+ +/* +* First read the current configuration descriptor +* and then update with user provided parameters +*/ if originally only lun0 was configured, and you want to configure a new set of luns - luns 8 to 15 (config index
0x1) - won't the read fail in that case?
Let me try it out on my setup internally and update once I test this scenario
Quoted 3 lines
Thanks,
Avri
Re: [PATCH V14 2/2] scsi: ufs: Add configfs support for UFS provisioning
In reply to Sayali LokhandeQuoted 24 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_FSandCONFIG_SCSI_UFS_PROVISIONneeds to be enabled for using this feature.Usage:
1) To read current configuration descriptor with index X (where index X can be 0/1/2/3) :
cat /config/<device_name>/ufs_config_desc_X2) To write configuration descriptor with index X :
echo <config_desc_buf> > /config/<device_name>/ufs_config_desc_XSigned-off-by Sayali Lokhande <[email protected]>
Quoted 11 lines
--- Documentation/ABI/testing/configfs-driver-ufs | 12 ++ drivers/scsi/ufs/Kconfig | 10 ++ drivers/scsi/ufs/Makefile | 1 + drivers/scsi/ufs/ufs-configfs.c | 237 ++++++++++++++++++++++++++ drivers/scsi/ufs/ufshcd.c | 3 +- drivers/scsi/ufs/ufshcd.h | 18 ++ 6 files changed, 280 insertions(+), 1 deletion(-) create mode 100644 Documentation/ABI/testing/configfs-driver-ufs create mode 100644 drivers/scsi/ufs/ufs-configfs.c
Re: [PATCH V14 2/2] scsi: ufs: Add configfs support for UFS provisioning
In reply to Sayali LokhandeQuoted 76 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_FSandCONFIG_SCSI_UFS_PROVISIONneeds to be enabled for using this feature.Usage:
1) To read current configuration descriptor with index X (where index X can be 0/1/2/3) :
cat /config/<device_name>/ufs_config_desc_X2) To write configuration descriptor with index X :
echo <config_desc_buf> > /config/<device_name>/ufs_config_desc_XSigned-off-by Sayali Lokhande <[email protected]>--- Documentation/ABI/testing/configfs-driver-ufs | 12 ++ drivers/scsi/ufs/Kconfig | 10 ++ drivers/scsi/ufs/Makefile | 1 + drivers/scsi/ufs/ufs-configfs.c | 237 ++++++++++++++++++++++++++ drivers/scsi/ufs/ufshcd.c | 3 +- drivers/scsi/ufs/ufshcd.h | 18 ++ 6 files changed, 280 insertions(+), 1 deletion(-) create mode 100644 Documentation/ABI/testing/configfs-driver-ufs create mode 100644 drivers/scsi/ufs/ufs-configfs.cDocumentation/ABI/testing/configfs-driver-ufs new file +12
-0@@ -0,0 +1,12 @@ +What: /config/*/ufs_config_desc_X +Date: Jun 2018 +KernelVersion: 4.20 +Description: + This file shows bytes of the current ufs configuration descriptor + with index X (where X = 0/1/2/3) 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 and format of each configuration descriptor parameter. + Parameters of Configuration descriptor buffer for respective index + needs to be passed as bytes in space separated format.drivers/scsi/ufs/Kconfig +10
-0@@ -100,3 +100,13 @@ config SCSI_UFS_QCOM Select this if you have UFS controller on QCOM chipset. If unsure, say N. + +config SCSI_UFS_PROVISION + bool "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 +0
-0
drivers/scsi/ufs/Makefile obj-$(CONFIG_SCSI_UFS_DWC_TC_PLATFORM) += tc-dwc-g210-pltfrm.o ufshcd-dwc.o tc-d · line 8
Quoted 4 lines
drivers/scsi/ufs/Makefile +1
-0@@ -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_SCSI_UFS_PROVISION) += ufs-configfs.o
Hi Sayali,
Can you try both of your patches with "make allmodconfig". There seem to be a few issues compiling in that configuration. Also, as it stands this file is either not compiled in, or baked into the kernel, where it really should go into the driver. Check out the patch below for how Guenter patched things up in our tree:
https://chromium-review.googlesource.com/c/chromiumos/third_party/kernel/+/1255524
Re: [PATCH V14 2/2] scsi: ufs: Add configfs support for UFS provisioning
Hi Evan,
Quoted 87 lines · Evan Green
Quoted 75 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_FSandCONFIG_SCSI_UFS_PROVISIONneeds to be enabled for using this feature.Usage:
1) To read current configuration descriptor with index X(where index X can be 0/1/2/3) : cat /config/<device_name>/ufs_config_desc_X2) To write configuration descriptor with index X :
echo <config_desc_buf> > /config/<device_name>/ufs_config_desc_XSigned-off-by Sayali Lokhande <[email protected]>--- Documentation/ABI/testing/configfs-driver-ufs | 12 ++ drivers/scsi/ufs/Kconfig | 10 ++ drivers/scsi/ufs/Makefile | 1 + drivers/scsi/ufs/ufs-configfs.c | 237 ++++++++++++++++++++++++++ drivers/scsi/ufs/ufshcd.c | 3 +- drivers/scsi/ufs/ufshcd.h | 18 ++ 6 files changed, 280 insertions(+), 1 deletion(-)create mode 100644
Documentation/ABI/testing/configfs-driver-ufscreate mode 100644drivers/scsi/ufs/ufs-configfs.cDocumentation/ABI/testing/configfs-driver-ufs new file +12
-0@@ -0,0 +1,12 @@ +What: /config/*/ufs_config_desc_X +Date: Jun 2018 +KernelVersion: 4.20 +Description: + This file shows bytes of the current ufs configuration descriptor + with index X (where X = 0/1/2/3) 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 and format of each configuration descriptor parameter. + Parameters of Configuration descriptor buffer for respective index + needs to be passed as bytes in space separated format.drivers/scsi/ufs/Kconfig +10
-0@@ -100,3 +100,13 @@ config SCSI_UFS_QCOM Select this if you have UFS controller on QCOM chipset. If unsure, say N. + +config SCSI_UFS_PROVISION + bool "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 +0
-0drivers/scsi/ufs/Makefile obj-$(CONFIG_SCSI_UFS_DWC_TC_PLATFORM) += tc-dwc-g210-pltfrm.o ufshcd-dwc.o tc-d · line 8
Quoted 4 lines
drivers/scsi/ufs/Makefile +1
-0@@ -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_SCSI_UFS_PROVISION) += ufs-configfs.oHi Sayali,
Can you try both of your patches with "make allmodconfig". There seem to be a few issues compiling in that configuration. Also, as it stands this file is either not compiled in, or baked into the kernel, where it really should go into the driver. Check out the patch below for how Guenter patched things up in our tree:
Quoted 1 line
shttps://chromium-review.googlesource.com/c/chromiumos/third_party/kernel/+/1255524
[Sayali] : the change pointed by you above looks good to me and will update it in my patch as well. ufs-configfs should be part of ufshcd-core. I tried using "make allmodconfig".(basically updating like below for test) + include change pointed above and it works fine. +CONFIG_CONFIGFS_FS=y
+CONFIG_SCSI_UFSHCD=m
+CONFIG_SCSI_UFSHCD_PLATFORM=m
+CONFIG_SCSI_UFS_PROVISION=y