[v2] firmware: vpd: Add an interface to read VPD value
diff mbox series

Message ID 20191008101144.39342-1-cychiang@chromium.org
State New
Headers show
Series
  • [v2] firmware: vpd: Add an interface to read VPD value
Related show

Commit Message

Cheng-yi Chiang Oct. 8, 2019, 10:11 a.m. UTC
Add an interface for other driver to query VPD value.
This will be used for ASoC machine driver to query calibration
data stored in VPD for smart amplifier speaker resistor
calibration.

The example usage in ASoC machine driver is like:

#define DSM_CALIB_KEY "dsm_calib"
static int load_calibration_data(struct cml_card_private *ctx) {
    char *data = NULL;
    int ret;
    u32 value_len;

    /* Read calibration data from VPD. */
    ret = vpd_attribute_read(1, DSM_CALIB_KEY,
                            (u8 **)&data, &value_len);

    /* Parsing of this string...*/
}


Signed-off-by: Cheng-Yi Chiang <cychiang@chromium.org>
---
Change from v1 to v2:
- Use kmemdup to copy data.
- Set value_len according to bin_attr.size.
- Check return value of kmemdup.
- Rename the function to vpd_attribute_read.
- Add docstrings for the function.
- Returns -ENOENT when the key is not found.
- Use EXPORT_SYMBOL_GPL.

Note:

The user of this API is in ASoC machine driver cml_rt1011_rt5682.
It is pending on the initial machine driver change

https://patchwork.kernel.org/patch/11161145/

and the codec driver change to provide API to do calibration.

https://patchwork.kernel.org/patch/11179237/

The draft patch of machine driver change which uses this API is at

https://chromium-review.googlesource.com/c/chromiumos/third_party/kernel/+/1838091



 drivers/firmware/google/vpd.c              | 31 ++++++++++++++++++++++
 include/linux/firmware/google/google_vpd.h | 18 +++++++++++++
 2 files changed, 49 insertions(+)
 create mode 100644 include/linux/firmware/google/google_vpd.h

Comments

Greg KH Oct. 8, 2019, 12:06 p.m. UTC | #1
On Tue, Oct 08, 2019 at 06:11:44PM +0800, Cheng-Yi Chiang wrote:
> Add an interface for other driver to query VPD value.
> This will be used for ASoC machine driver to query calibration
> data stored in VPD for smart amplifier speaker resistor
> calibration.
> 
> The example usage in ASoC machine driver is like:
> 
> #define DSM_CALIB_KEY "dsm_calib"
> static int load_calibration_data(struct cml_card_private *ctx) {
>     char *data = NULL;
>     int ret;
>     u32 value_len;
> 
>     /* Read calibration data from VPD. */
>     ret = vpd_attribute_read(1, DSM_CALIB_KEY,
>                             (u8 **)&data, &value_len);
> 
>     /* Parsing of this string...*/
> }
> 
> 
> Signed-off-by: Cheng-Yi Chiang <cychiang@chromium.org>
> ---

I can't take this patch without a real user of this function in the
kernel tree at the same time.  Please submit it as part of a patch
series with that change as well.

thanks,

greg k-h
Cheng-yi Chiang Oct. 8, 2019, 12:10 p.m. UTC | #2
On Tue, Oct 8, 2019 at 8:06 PM Greg Kroah-Hartman
<gregkh@linuxfoundation.org> wrote:
>
> On Tue, Oct 08, 2019 at 06:11:44PM +0800, Cheng-Yi Chiang wrote:
> > Add an interface for other driver to query VPD value.
> > This will be used for ASoC machine driver to query calibration
> > data stored in VPD for smart amplifier speaker resistor
> > calibration.
> >
> > The example usage in ASoC machine driver is like:
> >
> > #define DSM_CALIB_KEY "dsm_calib"
> > static int load_calibration_data(struct cml_card_private *ctx) {
> >     char *data = NULL;
> >     int ret;
> >     u32 value_len;
> >
> >     /* Read calibration data from VPD. */
> >     ret = vpd_attribute_read(1, DSM_CALIB_KEY,
> >                             (u8 **)&data, &value_len);
> >
> >     /* Parsing of this string...*/
> > }
> >
> >
> > Signed-off-by: Cheng-Yi Chiang <cychiang@chromium.org>
> > ---
>
> I can't take this patch without a real user of this function in the
> kernel tree at the same time.  Please submit it as part of a patch
> series with that change as well.
>

Hi Greg,
I see.
There is an ongoing discussion with Mark in

https://patchwork.kernel.org/patch/11179237/

I will resend this after machine driver is merged, and after codec
driver change get sorted out there.
Thanks!

> thanks,
>
> greg k-h

Patch
diff mbox series

diff --git a/drivers/firmware/google/vpd.c b/drivers/firmware/google/vpd.c
index db0812263d46..c2be0e756402 100644
--- a/drivers/firmware/google/vpd.c
+++ b/drivers/firmware/google/vpd.c
@@ -65,6 +65,37 @@  static ssize_t vpd_attrib_read(struct file *filp, struct kobject *kobp,
 				       info->bin_attr.size);
 }
 
+/**
+ *	vpd_attribute_read - Read VPD value for a key.
+ *	@ro: True for RO section. False for RW section.
+ *	@key: A string for key.
+ *	@value: Where to write the VPD value on success. The caller
+ *	        must free the memory.
+ *	@value_len: The length of value in bytes.
+ *
+ *	Returns 0 on success, -ENOENT when the key is not found, and
+ *	-ENOMEM when failed to allocate memory for value.
+ */
+int vpd_attribute_read(bool ro, const char *key,
+		       u8 **value, u32 *value_len)
+{
+	struct vpd_attrib_info *info;
+	struct vpd_section *sec = ro ? &ro_vpd : &rw_vpd;
+
+	list_for_each_entry(info, &sec->attribs, list) {
+		if (strcmp(info->key, key) == 0) {
+			*value = kmemdup(info->value, info->bin_attr.size,
+					 GFP_KERNEL);
+			if (!*value)
+				return -ENOMEM;
+			*value_len = info->bin_attr.size;
+			return 0;
+		}
+	}
+	return -ENOENT;
+}
+EXPORT_SYMBOL_GPL(vpd_attribute_read);
+
 /*
  * vpd_section_check_key_name()
  *
diff --git a/include/linux/firmware/google/google_vpd.h b/include/linux/firmware/google/google_vpd.h
new file mode 100644
index 000000000000..4364eaa4e1e3
--- /dev/null
+++ b/include/linux/firmware/google/google_vpd.h
@@ -0,0 +1,18 @@ 
+/* SPDX-License-Identifier: GPL-2.0 */
+/*
+ * Google VPD interface.
+ *
+ * Copyright 2019 Google Inc.
+ */
+
+/* Interface for reading VPD value on Chrome platform. */
+
+#ifndef __GOOGLE_VPD_H
+#define __GOOGLE_VPD_H
+
+#include <linux/types.h>
+
+int vpd_attribute_read(bool ro, const char *key,
+		       u8 **value, u32 *value_len);
+
+#endif  /* __GOOGLE_VPD_H */