Skip to contentSkip to conversation

Documentation/ABI: Add ABI information for QCOM socinfo driver

PATCH Superseded Imran Khan 3 participants 4 messages Jan 10, 2017 – Feb 20, 2017 Arm Qualcomm mailing list

v8 of 10 Superseded Latest is v10 →

lore
Share & tools
lore

Imran Khan

author
#0 lore raw

PATCH v8 2/2 Documentation/ABI: Add ABI information for QCOM socinfo driver

The socinfo ABI document describes the information provided by socinfo driver and the corresponding attributes to access that information.

---
 Documentation/ABI/stable/sysfs-driver-qcom_socinfo | 147 +++++++++++++++++++++
 1 file changed, 147 insertions(+)
 create mode 100644 Documentation/ABI/stable/sysfs-driver-qcom_socinfo
Documentation/ABI/stable/sysfs-driver-qcom_socinfo new file +147 -0
new file mode 100644
index 0000000..f90c142
@@ -0,0 +1,147 @@
+What:		/sys/devices/soc0/accessory_chip
+Date:		January 2017
+Description:
+		This file shows the id of the accessory chip.
+
+What:		/sys/devices/soc0/adsp_image_crm
+What:		/sys/devices/soc0/adsp_image_variant
+What:		/sys/devices/soc0/adsp_image_version
+Date:		January 2017
+Description:
+		These files respectively show the crm version, variant and
+		version of the ADSP image.
+
+What:		/sys/devices/soc0/apps_image_crm
+What:		/sys/devices/soc0/apps_image_variant
+What:		/sys/devices/soc0/apps_image_version
+Date:		January 2017
+Description:
+		These files respectively show the crm version, variant and
+		version of the APPS(Linux kernel, rootfs) image.
+
+What:		/sys/devices/soc0/boot_image_crm
+What:		/sys/devices/soc0/boot_image_variant
+What:		/sys/devices/soc0/boot_image_version
+Date:		January 2017
+Description:
+		These files respectively show the crm version, variant and
+		version of the Boot(bootloader) image.
+
+What:		/sys/devices/soc0/build_id
+Date:		January 2017
+Description:
+		This file shows the unique id of current build being used on
+		the system.
+
+What:		/sys/devices/soc0/cnss_image_crm
+What:		/sys/devices/soc0/cnss_image_variant
+What:		/sys/devices/soc0/cnss_image_version
+Date:		January 2017
+Description:
+		These files respectively show the crm version, variant and
+		version of the CNSS image.
+
+What:		/sys/devices/soc0/family
+Date:		January 2017
+Description:
+		This file shows the family(e.g Snapdragon) of the SoC.
+
+What:		/sys/devices/soc0/foundry_id
+Date:		January 2017
+Description:
+		This file shows the id of the foundry, where soc was
+		manufactured.
+
+What:		/sys/devices/soc0/hw_platform
+Date:		January 2017
+Description:
+		This file shows the type of hardware platform
+		(e.g MTP, QRD etc) where SoC is being used.
+
+What:		/sys/devices/soc0/machine
+Date:		January 2017
+Description:
+		This file shows the machine name as given in the DT.
+
+What:		/sys/devices/soc0/mpss_image_crm
+What:		/sys/devices/soc0/mpss_image_variant
+What:		/sys/devices/soc0/mpss_image_version
+Date:		January 2017
+Description:
+		These files respectively show the crm version, variant and
+		version of the MPSS image.
+
+What:		/sys/devices/soc0/platform_subtype
+Date:		January 2017
+Description:
+		This file shows the sub-type of hardware platform
+		(SKUAA, SKUF etc.) where SoC is being used.
+
+What:		/sys/devices/soc0/platform_version
+Date:		January 2017
+Description:
+		This file show the version of the hardware platform.
+
+What:		/sys/devices/soc0/pmic_die_revision
+Date:		January 2017
+Description:
+		This file shows revision of PMIC die.
+
+What:		/sys/devices/soc0/pmic_model
+Date:		January 2017
+Description:
+		This file shows name of PMIC model.
+
+What:		/sys/devices/soc0/qcom_odm
+Date:		January 2017
+Description:
+		This file shows the ODM using the SoC.
+
+What:		/sys/devices/soc0/raw_version
+Date:		January 2017
+Description:
+		This file shows raw version of the SoC.
+
+What:		/sys/devices/soc0/revision
+Date:		January 2017
+Description:
+		This file shows revision of the SoC.
+
+What:		/sys/devices/soc0/rpm_image_crm
+What:		/sys/devices/soc0/rpm_image_variant
+What:		/sys/devices/soc0/rpm_image_version
+Date:		January 2017
+Description:
+		These files respectively show the crm version, variant and
+		version of the RPM image.
+
+What:		/sys/devices/soc0/serial_number
+Date:		January 2017
+Description:
+		This file shows serial number of the SoC.
+
+What:		/sys/devices/soc0/soc_id
+Date:		January 2017
+Description:
+		This file shows the unique numeric id of a Qualcomm SoC.
+
+What:		/sys/devices/soc0/tz_image_crm
+What:		/sys/devices/soc0/tz_image_variant
+What:		/sys/devices/soc0/tz_image_version
+Date:		January 2017
+Description:
+		These files respectively show the crm version, variant and
+		version of the TZ image.
+
+What:		/sys/devices/soc0/vendor
+Date:		January 2017
+Description:
+		This file shows the vendor of the SoC.
+
+What:		/sys/devices/soc0/video_image_crm
+What:		/sys/devices/soc0/video_image_variant
+What:		/sys/devices/soc0/video_image_version
+Date:		January 2017
+Description:
+		These files respectively show the crm version, variant and
+		version of the video image.
Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project
#1 lore raw

Documentation/ABI/stable/sysfs-driver-qcom_socinfo line 64

Quoted 5 lines · Imran Khan
Documentation/ABI/stable/sysfs-driver-qcom_socinfo new file +5 -0
+
+What:		/sys/devices/soc0/machine
+Date:		January 2017
+Description:
+		This file shows the machine name as given in the DT.

This description needs to be updated.

[..]

Documentation/ABI/stable/sysfs-driver-qcom_socinfo line 98

Quoted 5 lines
Documentation/ABI/stable/sysfs-driver-qcom_socinfo new file +5 -0
+
+What:		/sys/devices/soc0/qcom_odm
+Date:		January 2017
+Description:
+		This file shows the ODM using the SoC.

This should be dropped.

Regards,
Bjorn

#2 lore raw
In reply to Imran Khan
Quoted 7 lines · Imran Khan

The socinfo ABI document describes the information provided by socinfo driver and the corresponding attributes to access that information.

---
 Documentation/ABI/stable/sysfs-driver-qcom_socinfo | 147 +++++++++++++++++++++

Perhaps move it to testing instead of stable too?

Documentation/ABI/stable/sysfs-driver-qcom_socinfo line 4

Quoted 13 lines
 1 file changed, 147 insertions(+)
 create mode 100644 Documentation/ABI/stable/sysfs-driver-qcom_socinfo
Documentation/ABI/stable/sysfs-driver-qcom_socinfo new file +4 -0
new file mode 100644
index 0000000..f90c142
@@ -0,0 +1,147 @@
+What:		/sys/devices/soc0/accessory_chip
+Date:		January 2017
+Description:
+		This file shows the id of the accessory chip.

Please add a contact, [email protected] perhaps?

Quoted 79 lines
Documentation/ABI/stable/sysfs-driver-qcom_socinfo new file +79 -0
+
+What:		/sys/devices/soc0/adsp_image_crm
+What:		/sys/devices/soc0/adsp_image_variant
+What:		/sys/devices/soc0/adsp_image_version
+Date:		January 2017
+Description:
+		These files respectively show the crm version, variant and
+		version of the ADSP image.
+
+What:		/sys/devices/soc0/apps_image_crm
+What:		/sys/devices/soc0/apps_image_variant
+What:		/sys/devices/soc0/apps_image_version
+Date:		January 2017
+Description:
+		These files respectively show the crm version, variant and
+		version of the APPS(Linux kernel, rootfs) image.
+
+What:		/sys/devices/soc0/boot_image_crm
+What:		/sys/devices/soc0/boot_image_variant
+What:		/sys/devices/soc0/boot_image_version
+Date:		January 2017
+Description:
+		These files respectively show the crm version, variant and
+		version of the Boot(bootloader) image.
+
+What:		/sys/devices/soc0/build_id
+Date:		January 2017
+Description:
+		This file shows the unique id of current build being used on
+		the system.
+
+What:		/sys/devices/soc0/cnss_image_crm
+What:		/sys/devices/soc0/cnss_image_variant
+What:		/sys/devices/soc0/cnss_image_version
+Date:		January 2017
+Description:
+		These files respectively show the crm version, variant and
+		version of the CNSS image.
+
+What:		/sys/devices/soc0/family
+Date:		January 2017
+Description:
+		This file shows the family(e.g Snapdragon) of the SoC.
+
+What:		/sys/devices/soc0/foundry_id
+Date:		January 2017
+Description:
+		This file shows the id of the foundry, where soc was
+		manufactured.
+
+What:		/sys/devices/soc0/hw_platform
+Date:		January 2017
+Description:
+		This file shows the type of hardware platform
+		(e.g MTP, QRD etc) where SoC is being used.
+
+What:		/sys/devices/soc0/machine
+Date:		January 2017
+Description:
+		This file shows the machine name as given in the DT.
+
+What:		/sys/devices/soc0/mpss_image_crm
+What:		/sys/devices/soc0/mpss_image_variant
+What:		/sys/devices/soc0/mpss_image_version
+Date:		January 2017
+Description:
+		These files respectively show the crm version, variant and
+		version of the MPSS image.
+
+What:		/sys/devices/soc0/platform_subtype
+Date:		January 2017
+Description:
+		This file shows the sub-type of hardware platform
+		(SKUAA, SKUF etc.) where SoC is being used.
+
+What:		/sys/devices/soc0/platform_version
+Date:		January 2017
+Description:
+		This file show the version of the hardware platform.

Documentation/ABI/stable/sysfs-driver-qcom_socinfo line 93

Quoted 10 lines
Documentation/ABI/stable/sysfs-driver-qcom_socinfo new file +10 -0
+
+What:		/sys/devices/soc0/pmic_die_revision
+Date:		January 2017
+Description:
+		This file shows revision of PMIC die.
+
+What:		/sys/devices/soc0/pmic_model
+Date:		January 2017
+Description:
+		This file shows name of PMIC model.

This doesn't seem very future proof when there's more than on pmic, and really pmic isn't part of the SoC so it's sort of odd to have that here in the first place. Any chance we can drop this for now?

Signature · 2 lines
Qualcomm Innovation Center, Inc. is a member of Code Aurora Forum,
a Linux Foundation Collaborative Project
author
#3 lore raw
Quoted 11 lines · Stephen Boyd
Quoted 7 lines · Imran Khan

The socinfo ABI document describes the information provided by socinfo driver and the corresponding attributes to access that information.

---
 Documentation/ABI/stable/sysfs-driver-qcom_socinfo | 147 +++++++++++++++++++++

Perhaps move it to testing instead of stable too?

Done.

Quoted 16 lines

Documentation/ABI/stable/sysfs-driver-qcom_socinfo line 4

Quoted 13 lines
 1 file changed, 147 insertions(+)
 create mode 100644 Documentation/ABI/stable/sysfs-driver-qcom_socinfo
Documentation/ABI/stable/sysfs-driver-qcom_socinfo new file +4 -0
new file mode 100644
index 0000000..f90c142
@@ -0,0 +1,147 @@
+What:		/sys/devices/soc0/accessory_chip
+Date:		January 2017
+Description:
+		This file shows the id of the accessory chip.

Please add a contact, [email protected] perhaps?

Done. Added [email protected] as contact.

Quoted 6 lines
Quoted 6 lines
Documentation/ABI/stable/sysfs-driver-qcom_socinfo new file +6 -0
+
+What:		/sys/devices/soc0/adsp_image_crm
+What:		/sys/devices/soc0/adsp_image_variant
+What:		/sys/devices/soc0/adsp_image_version
+Date:		January 2017
+Description:

<snip>

Quoted 6 lines
Quoted 6 lines
Documentation/ABI/stable/sysfs-driver-qcom_socinfo new file +6 -0
+What:		/sys/devices/soc0/pmic_die_revision
+Date:		January 2017
+Description:
+		This file shows revision of PMIC die.
+
+What:		/sys/devices/soc0/pmic_model
Quoted 9 lines

Documentation/ABI/stable/sysfs-driver-qcom_socinfo line 93

Quoted 3 lines
Documentation/ABI/stable/sysfs-driver-qcom_socinfo new file +3 -0
+Date:		January 2017
+Description:
+		This file shows name of PMIC model.

This doesn't seem very future proof when there's more than on pmic, and really pmic isn't part of the SoC so it's sort of odd to have that here in the first place. Any chance we can drop this for now?

True. It needs some changes when there are more than one PMICs. But right now I intend to show information about one PMIC and later on add to that. For example right now we create sysfs attributes only after finding out that those attributes are supported in socinfo version currently available. We can use the same approach for socinfo versions that provide information about multiple PMICs. Accordingly I will change this document too.
Though PMIC is not part of SoC, but as this information is available as a part of the same SMEM item, I wanted to make this information available to user space.
Please let me know if it sounds okay with you?

Thanks and Regards,
Imran

Signature · 1 line
QUALCOMM INDIA, on behalf of Qualcomm Innovation Center, Inc. is a\nmember of the Code Aurora Forum, hosted by The Linux Foundation