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

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

[Imran Khan]

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

Signed-off-by: Imran Khan <kimran@codeaurora.org>
---
 Documentation/ABI/stable/sysfs-driver-qcom_socinfo | 147 +++++++++++++++++++++
 1 file changed, 147 insertions(+)
 create mode 100644 Documentation/ABI/stable/sysfs-driver-qcom_socinfo

diff --git a/Documentation/ABI/stable/sysfs-driver-qcom_socinfo b/Documentation/ABI/stable/sysfs-driver-qcom_socinfo
new file mode 100644
index 0000000..f90c142
--- /dev/null
+++ b/Documentation/ABI/stable/sysfs-driver-qcom_socinfo
@@ -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.
-- 
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum,
a Linux Foundation Collaborative Project

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

[Bjorn Andersson]

On Tue 10 Jan 07:48 PST 2017, Imran Khan wrote:
> +
> +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.

[..]
> +
> +What:		/sys/devices/soc0/qcom_odm
> +Date:		January 2017
> +Description:
> +		This file shows the ODM using the SoC.

This should be dropped.

Regards,
Bjorn

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

[Stephen Boyd]

On 01/10, Imran Khan wrote:
> The socinfo ABI document describes the information provided
> by socinfo driver and the corresponding attributes to access
> that information.
> 
> Signed-off-by: Imran Khan <kimran@codeaurora.org>
> ---
>  Documentation/ABI/stable/sysfs-driver-qcom_socinfo | 147 +++++++++++++++++++++

Perhaps move it to testing instead of stable too?

>  1 file changed, 147 insertions(+)
>  create mode 100644 Documentation/ABI/stable/sysfs-driver-qcom_socinfo
> 
> diff --git a/Documentation/ABI/stable/sysfs-driver-qcom_socinfo b/Documentation/ABI/stable/sysfs-driver-qcom_socinfo
> new file mode 100644
> index 0000000..f90c142
> --- /dev/null
> +++ b/Documentation/ABI/stable/sysfs-driver-qcom_socinfo
> @@ -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, linux-arm-msm@vger.kernel.org perhaps?

> +
> +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.

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?

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

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

[Imran Khan]

On 2/18/2017 4:06 AM, Stephen Boyd wrote:
> On 01/10, Imran Khan wrote:
>> The socinfo ABI document describes the information provided
>> by socinfo driver and the corresponding attributes to access
>> that information.
>>
>> Signed-off-by: Imran Khan <kimran@codeaurora.org>
>> ---
>>  Documentation/ABI/stable/sysfs-driver-qcom_socinfo | 147 +++++++++++++++++++++
> 
> Perhaps move it to testing instead of stable too?
> 
Done.

>>  1 file changed, 147 insertions(+)
>>  create mode 100644 Documentation/ABI/stable/sysfs-driver-qcom_socinfo
>>
>> diff --git a/Documentation/ABI/stable/sysfs-driver-qcom_socinfo b/Documentation/ABI/stable/sysfs-driver-qcom_socinfo
>> new file mode 100644
>> index 0000000..f90c142
>> --- /dev/null
>> +++ b/Documentation/ABI/stable/sysfs-driver-qcom_socinfo
>> @@ -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, linux-arm-msm@vger.kernel.org perhaps?
> 

Done. Added linux-arm-msm@vger.kernel.org as contact.
>> +
>> +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>

>> +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?
> 
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


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