iio: documentation: Document proximity/accel sensor label use
v2 cover iio: documentation: Document proximity/accel sensor label use
Hi Jonathan,
AFAICT the v2 of this series is ready for merging, but I'm not seeing it here:
https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git/log/?h=testing
Hence this resend.
Regards,
Hans
Hans de Goede (2):
iio: documentation: Document proximity sensor label use
iio: documentation: Document accelerometer label use
Documentation/ABI/testing/sysfs-bus-iio | 46 +++++++++++++++++++++++++ 1 file changed, 46 insertions(+)
Signature · 1 line
2.30.2
PATCH RESEND v2 1/2 iio: documentation: Document proximity sensor label use
Add an entry to Documentation/ABI/testing/sysfs-bus-iio for the new device label sysfs-attribute support.
And document the standardized labels which may be used with proximity sensors to hint userspace about the intended use of the sensor.
Using labels to differentiate between the multiple proximity sensors which a modern laptop/tablet may have was discussed in this thread:
https://lore.kernel.org/linux-iio/[email protected]/
As mentioned there the "proximity-wifi*" labels are already being used in this manner on some chromebooks, see e.g.:arch/arm64/boot/dts/qcom/sc7180-trogdor.dtsi arch/arm64/boot/dts/qcom/sc7180-trogdor-lte-sku.dtsi
And the "proximity-palmrest" and "proximity-lap" labels are intended to be used with the lap and palmrest sensors found in recent Lenovo ThinkPad models.
---
Changes in v2:
- Drop the too generic:
What: /sys/bus/iio/devices/iio:deviceX/in_*_label
What: /sys/bus/iio/devices/iio:deviceX/out_*_label
lines from the newly added documentation, if/when we start using channel-labels with proximity sensors then those should get a separate in_proximityX_label documentation.
--- Documentation/ABI/testing/sysfs-bus-iio | 39 +++++++++++++++++++++++++ 1 file changed, 39 insertions(+)
Documentation/ABI/testing/sysfs-bus-iio +39 -0
@@ -33,6 +33,45 @@ Description: Description of the physical chip / device for device X. Typically a part number. +What: /sys/bus/iio/devices/iio:deviceX/label +KernelVersion: 5.8 +Contact: [email protected] +Description: + Optional symbolic label for a device. + This is useful for userspace to be able to better identify an + individual device. + + The contents of the label are free-form, but there are some + standardized uses: + + For proximity sensors which give the proximity (of a person) to + a certain wlan or wwan antenna the following standardized labels + are used: + + * "proximity-wifi" + * "proximity-lte" + * "proximity-wifi-lte" + * "proximity-wifi-left" + * "proximity-wifi-right" + + These are used to indicate to userspace that these proximity + sensors may be used to tune transmit power to ensure that + Specific Absorption Rate (SAR) limits are honored. + The "-left" and "-right" labels are for devices with multiple + antennas. + + In some laptops/tablets the standardized proximity sensor labels + instead indicate proximity to a specific part of the device: + + * "proximity-palmrest" indicates proximity to the keyboard's palmrest + * "proximity-palmrest-left" indicates proximity to the left part of the palmrest + * "proximity-palmrest-right" indicates proximity to the right part of the palmrest + * "proximity-lap" indicates the device is being used on someone's lap + + Note "proximity-lap" is special in that its value may be + calculated by firmware from other sensor readings, rather then + being a raw sensor reading. + What: /sys/bus/iio/devices/iio:deviceX/current_timestamp_clock KernelVersion: 4.5 Contact: [email protected]
Signature · 1 line
2.30.2
Re: [PATCH v2 resend 1/2] iio: documentation: Document proximity sensor label use
Hey,
Quoted 63 lines · Hans de Goede
Add an entry to
Documentation/ABI/testing/sysfs-bus-iiofor the new device label sysfs-attribute support.And document the standardized labels which may be used with proximity sensors to hint userspace about the intended use of the sensor.
Using labels to differentiate between the multiple proximity sensors which a modern laptop/tablet may have was discussed in this thread:
https://lore.kernel.org/linux-iio/[email protected]/As mentioned there the "proximity-wifi*" labels are already being used
in this manner on some chromebooks, see e.g.:arch/arm64/boot/dts/qcom/sc7180-trogdor.dtsiarch/arm64/boot/dts/qcom/sc7180-trogdor-lte-sku.dtsiAnd the "proximity-palmrest" and "proximity-lap" labels are intended to be used with the lap and palmrest sensors found in recent Lenovo ThinkPad models.
Cc Dmitry Torokhov <[email protected]>Cc Mark Pearson <[email protected]>Cc Bastien Nocera <[email protected]>Signed-off-by Hans de Goede <[email protected]>---
Changes in v2:
- Drop the too generic:
What: /sys/bus/iio/devices/iio:deviceX/in_*_label What: /sys/bus/iio/devices/iio:deviceX/out_*_label lines from the newly added documentation, if/when we start using channel-labels with proximity sensors then those should get a separatein_proximityX_labeldocumentation.
---
Documentation/ABI/testing/sysfs-bus-iio | 39
+++++++++++++++++++++++++1 file changed, 39 insertions(+)Documentation/ABI/testing/sysfs-bus-iio +0
-0@@ -33,6 +33,45 @@ Description:Description of the physical chip / device for device X.
Typically a part number.Documentation/ABI/testing/sysfs-bus-iio +6
-0+What: /sys/bus/iio/devices/iio:deviceX/label +KernelVersion: 5.8 +Contact: [email protected] +Description: + Optional symbolic label for a device. + This is useful for userspace to be able to betteridentify an
+ individual device.
+
+ The contents of the label are free-form, but there are some
+ standardized uses:
+
+ For proximity sensors which give the proximity (of a person) to
+ a certain wlan or wwan antenna the following
Quoted 8 lines
standardized labels
+ are used:
+
+ * "proximity-wifi"
+ * "proximity-lte"
+ * "proximity-wifi-lte"
+ * "proximity-wifi-left"
+ * "proximity-wifi-right"
Could we avoid having "lte" in the label names? Do we have a way to communicate that some of those labels are deprecated and should be avoided?
I would use "wwan" instead of "lte" here, and just mention "proximity- wifi-lte" as a synonym for "proximity-wifi-wwan".
Quoted 21 lines
+
+ These are used to indicate to userspace that these proximity
+ sensors may be used to tune transmit power to ensure that
+ Specific Absorption Rate (SAR) limits are honored. + The "-left" and "-right" labels are for devices with multiple
+ antennas.
+
+ In some laptops/tablets the standardized proximity sensor labels
+ instead indicate proximity to a specific part of the device:
+
+ * "proximity-palmrest" indicates proximity to the keyboard's palmrest
+ * "proximity-palmrest-left" indicates proximity to the left part of the palmrest
+ * "proximity-palmrest-right" indicates proximity to the right part of the palmrest
Quoted 8 lines
+ * "proximity-lap" indicates the device is being used on someone's lap
+
+ Note "proximity-lap" is special in that its value may be
+ calculated by firmware from other sensor readings, rather then
+ being a raw sensor reading.
I don't think that this is needed. I would expect that this sensor would have a "0" minimum and "1" maximum value, which makes it clear that the sensor value is synthesised.
Maybe this special case should be mentioned (if that's needed), rather than pointing out that this particular sensor might be special (they could all be, depending on how the system is implemented after all).
Did you think about where you wanted the sensor's threshold to be exported? Still in udev/hwdb?
Cheers
Quoted 5 lines
+
What: /sys/bus/iio/devices/iio:deviceX/current_timestamp_cl ock
KernelVersion: 4.5
Contact: [email protected]
Re: [PATCH v2 resend 1/2] iio: documentation: Document proximity sensor label use
Hi,
Quoted 79 lines · Bastien Nocera
Hey,
Quoted 63 lines · Hans de Goede
Add an entry to
Documentation/ABI/testing/sysfs-bus-iiofor the new device label sysfs-attribute support.And document the standardized labels which may be used with proximity sensors to hint userspace about the intended use of the sensor.
Using labels to differentiate between the multiple proximity sensors which a modern laptop/tablet may have was discussed in this thread:
https://lore.kernel.org/linux-iio/[email protected]/As mentioned there the "proximity-wifi*" labels are already being used
in this manner on some chromebooks, see e.g.:arch/arm64/boot/dts/qcom/sc7180-trogdor.dtsiarch/arm64/boot/dts/qcom/sc7180-trogdor-lte-sku.dtsiAnd the "proximity-palmrest" and "proximity-lap" labels are intended to be used with the lap and palmrest sensors found in recent Lenovo ThinkPad models.
Cc Dmitry Torokhov <[email protected]>Cc Mark Pearson <[email protected]>Cc Bastien Nocera <[email protected]>Signed-off-by Hans de Goede <[email protected]>---
Changes in v2:
- Drop the too generic:
What: /sys/bus/iio/devices/iio:deviceX/in_*_label What: /sys/bus/iio/devices/iio:deviceX/out_*_label lines from the newly added documentation, if/when we start using channel-labels with proximity sensors then those should get a separatein_proximityX_labeldocumentation.
---
Documentation/ABI/testing/sysfs-bus-iio | 39
+++++++++++++++++++++++++1 file changed, 39 insertions(+)Documentation/ABI/testing/sysfs-bus-iio +0
-0@@ -33,6 +33,45 @@ Description:Description of the physical chip / device for device X.
Typically a part number.Documentation/ABI/testing/sysfs-bus-iio +6
-0+What: /sys/bus/iio/devices/iio:deviceX/label +KernelVersion: 5.8 +Contact: [email protected] +Description: + Optional symbolic label for a device. + This is useful for userspace to be able to betteridentify an
+ individual device.
+
+ The contents of the label are free-form, but there are some
+ standardized uses:
+
+ For proximity sensors which give the proximity (of a person) to
+ a certain wlan or wwan antenna the followingQuoted 8 lines
standardized labels
+ are used:
+
+ * "proximity-wifi"
+ * "proximity-lte"
+ * "proximity-wifi-lte"
+ * "proximity-wifi-left"
+ * "proximity-wifi-right"Could we avoid having "lte" in the label names? Do we have a way to communicate that some of those labels are deprecated and should be avoided?
Quoted 2 lines
I would use "wwan" instead of "lte" here, and just mention "proximity- wifi-lte" as a synonym for "proximity-wifi-wwan".
the "lte" postfix is currently in use on ChromeOS, which is why I chose it here. I'm fine with adding some text that new drivers should use -wwan, although I wonder how this will work with separate mmwave and normal 5g antennas as such keeping lte for both 4g + regular 5g might actually be better and then the separate mmwave antennas can use a -mmwave postfix.
Dmitry IIRC you brought up the use of these labels in a previous discussion. Do you have anything to add here ? Is ChromeOS already doing anything wrt SAR for mmwave antennas?
Quoted 26 lines
Quoted 26 lines
+
+ These are used to indicate to userspace that these proximity
+ sensors may be used to tune transmit power to ensure that
+ Specific Absorption Rate (SAR) limits are honored. + The "-left" and "-right" labels are for devices with multiple
+ antennas.
+
+ In some laptops/tablets the standardized proximity sensor labels
+ instead indicate proximity to a specific part of the device:
+
+ * "proximity-palmrest" indicates proximity to the keyboard's palmrest
+ * "proximity-palmrest-left" indicates proximity to the left part of the palmrest
+ * "proximity-palmrest-right" indicates proximity to the right part of the palmrest
+ * "proximity-lap" indicates the device is being used on someone's lap
+
+ Note "proximity-lap" is special in that its value may
Quoted 8 lines
Quoted 4 lines
be
+ calculated by firmware from other sensor readings, rather then
+ being a raw sensor reading.I don't think that this is needed. I would expect that this sensor would have a "0" minimum and "1" maximum value, which makes it clear that the sensor value is synthesised.
IIO typically exports real sensor readings, not these kind of synthesized values so IMHO it is good to mention this in the docs.
Quoted 6 lines
Maybe this special case should be mentioned (if that's needed), rather than pointing out that this particular sensor might be special (they could all be, depending on how the system is implemented after all).
Did you think about where you wanted the sensor's threshold to be exported? Still in udev/hwdb?
AFAIK the plan was for the driver to export this as a IIO sysfs attribute, Documentation/ABI/testing/sysfs-bus-iio already has:
What: /sys/.../events/in_proximity0_thresh_falling_value What: /sys/.../events/in_proximity0_thresh_rising_value
Those are intended for the trigger interface, but IIRC I think the plan was to also use these on a device without trigger support to advertise the recommended threshold to be used by userspace.
Jonathan ?
Regards,
Hans
Quoted 10 lines
Cheers
Quoted 5 lines
+
What: /sys/bus/iio/devices/iio:deviceX/current_timestamp_cl ock
KernelVersion: 4.5
Contact: [email protected]
Re: [PATCH v2 resend 1/2] iio: documentation: Document proximity sensor label use
Quoted 94 lines · Hans de Goede
Hi,
Quoted 87 lines · Bastien Nocera
Hey,
Quoted 71 lines · Hans de Goede
Add an entry to
Documentation/ABI/testing/sysfs-bus-iiofor the new device label sysfs-attribute support.And document the standardized labels which may be used with proximity
sensors to hint userspace about the intended use of the sensor.Using labels to differentiate between the multiple proximity sensors
which a modern laptop/tablet may have was discussed in this thread:
https://lore.kernel.org/linux-iio/[email protected]/As mentioned there the "proximity-wifi*" labels are already being used
in this manner on some chromebooks, see e.g.:arch/arm64/boot/dts/qcom/sc7180-trogdor.dtsiarch/arm64/boot/dts/qcom/sc7180-trogdor-lte-sku.dtsiAnd the "proximity-palmrest" and "proximity-lap" labels are intended
to be used with the lap and palmrest sensors found in recent Lenovo
ThinkPad models.Cc Dmitry Torokhov <[email protected]>Cc Mark Pearson <[email protected]>Cc Bastien Nocera <[email protected]>Signed-off-by Hans de Goede <[email protected]>---
Changes in v2:
- Drop the too generic:
What: /sys/bus/iio/devices/iio:deviceX/in_*_label What: /sys/bus/iio/devices/iio:deviceX/out_*_label lines from the newly added documentation, if/when we start using channel-labels with proximity sensors then those should get a separatein_proximityX_labeldocumentation.
---
Documentation/ABI/testing/sysfs-bus-iio | 39
+++++++++++++++++++++++++1 file changed, 39 insertions(+)Documentation/ABI/testing/sysfs-bus-iio +0
-0@@ -33,6 +33,45 @@ Description:Description of the physical chip / device for device
X.
Typically a part number.Documentation/ABI/testing/sysfs-bus-iio +6
-0+What: /sys/bus/iio/devices/iio:deviceX/label +KernelVersion: 5.8 +Contact: [email protected] +Description: + Optional symbolic label for a device. + This is useful for userspace to be able to betteridentify an
+ individual device.
+
+ The contents of the label are free-form, but there
are some
+ standardized uses:
+
+ For proximity sensors which give the proximity (of a
person) to
+ a certain wlan or wwan antenna the followingQuoted 8 lines
standardized labels
+ are used:
+
+ * "proximity-wifi"
+ * "proximity-lte"
+ * "proximity-wifi-lte"
+ * "proximity-wifi-left"
+ * "proximity-wifi-right"Could we avoid having "lte" in the label names? Do we have a way to communicate that some of those labels are deprecated and should be avoided?
Quoted 3 lines
I would use "wwan" instead of "lte" here, and just mention "proximity-
wifi-lte" as a synonym for "proximity-wifi-wwan".
Quoted 6 lines
the "lte" postfix is currently in use on ChromeOS, which is why I chose it here. I'm fine with adding some text that new drivers should use -wwan, although I wonder how this will work with separate mmwave and normal 5g antennas as such keeping lte for both 4g + regular 5g might actually be better and then the separate mmwave antennas can use a -mmwave postfix.
LTE isn't 4G or 5G, so it's already a misnomer. I also doubt that any end-user cares what actual technology is being used in the antennas, I just wanted to avoid us having to add another name to the list when folks realise that LTE support is long gone from their devices.
Quoted 99 lines
Dmitry IIRC you brought up the use of these labels in a previous discussion. Do you have anything to add here ? Is ChromeOS already doing anything wrt SAR for mmwave antennas?
Quoted 38 lines
Quoted 38 lines
+
+ These are used to indicate to userspace that these
proximity
+ sensors may be used to tune transmit power to ensure
that
+ Specific Absorption Rate (SAR) limits are honored.
+ The "-left" and "-right" labels are for devices with
multiple
+ antennas.
+
+ In some laptops/tablets the standardized proximity
sensor labels
+ instead indicate proximity to a specific part of the
device:
+
+ * "proximity-palmrest" indicates proximity to the keyboard's palmrest
+ * "proximity-palmrest-left" indicates proximity to
the left part of the palmrest
+ * "proximity-palmrest-right" indicates proximity to
the right part of the palmrest
+ * "proximity-lap" indicates the device is being used
on someone's lap
+
+ Note "proximity-lap" is special in that its value may
be
+ calculated by firmware from other sensorQuoted 8 lines
Quoted 3 lines
readings,
rather then
+ being a raw sensor reading.I don't think that this is needed. I would expect that this sensor would have a "0" minimum and "1" maximum value, which makes it clear
that the sensor value is synthesised.IIO typically exports real sensor readings, not these kind of synthesized values so IMHO it is good to mention this in the docs.
Quoted 9 lines
Maybe this special case should be mentioned (if that's needed), rather
than pointing out that this particular sensor might be special (they
could all be, depending on how the system is implemented after all).Did you think about where you wanted the sensor's threshold to be exported? Still in udev/hwdb?
AFAIK the plan was for the driver to export this as a IIO sysfs attribute,
Documentation/ABI/testing/sysfs-bus-iioalready has:What:
/sys/.../events/in_proximity0_thresh_falling_valueWhat:/sys/.../events/in_proximity0_thresh_rising_valueThose are intended for the trigger interface, but IIRC I think the plan was to also use these on a device without trigger support to advertise the recommended threshold to be used by userspace.
Jonathan ?
Regards,
Hans
Quoted 11 lines
Cheers
Quoted 6 lines
+
What: /sys/bus/iio/devices/iio:deviceX/current_timestamp_cl
ock
KernelVersion: 4.5
Contact: [email protected]
Jonathan Cameron
maintainerRe: [PATCH v2 resend 1/2] iio: documentation: Document proximity sensor label use
In reply to Hans de GoedeQuoted 131 lines · On Fri, 16 Apr 2021 13:13:57 +0200 Hans de Goede <[email protected]> wrote:
Hi,
Quoted 79 lines · Bastien Nocera
Hey,
Quoted 63 lines · Hans de Goede
Add an entry to
Documentation/ABI/testing/sysfs-bus-iiofor the new device label sysfs-attribute support.And document the standardized labels which may be used with proximity sensors to hint userspace about the intended use of the sensor.
Using labels to differentiate between the multiple proximity sensors which a modern laptop/tablet may have was discussed in this thread:
https://lore.kernel.org/linux-iio/[email protected]/As mentioned there the "proximity-wifi*" labels are already being used
in this manner on some chromebooks, see e.g.:arch/arm64/boot/dts/qcom/sc7180-trogdor.dtsiarch/arm64/boot/dts/qcom/sc7180-trogdor-lte-sku.dtsiAnd the "proximity-palmrest" and "proximity-lap" labels are intended to be used with the lap and palmrest sensors found in recent Lenovo ThinkPad models.
Cc Dmitry Torokhov <[email protected]>Cc Mark Pearson <[email protected]>Cc Bastien Nocera <[email protected]>Signed-off-by Hans de Goede <[email protected]>---
Changes in v2:
- Drop the too generic:
What: /sys/bus/iio/devices/iio:deviceX/in_*_label What: /sys/bus/iio/devices/iio:deviceX/out_*_label lines from the newly added documentation, if/when we start using channel-labels with proximity sensors then those should get a separatein_proximityX_labeldocumentation.
---
Documentation/ABI/testing/sysfs-bus-iio | 39
+++++++++++++++++++++++++1 file changed, 39 insertions(+)Documentation/ABI/testing/sysfs-bus-iio +0
-0@@ -33,6 +33,45 @@ Description:Description of the physical chip / device for device X.
Typically a part number.Documentation/ABI/testing/sysfs-bus-iio +6
-0+What: /sys/bus/iio/devices/iio:deviceX/label +KernelVersion: 5.8 +Contact: [email protected] +Description: + Optional symbolic label for a device. + This is useful for userspace to be able to betteridentify an
+ individual device.
+
+ The contents of the label are free-form, but there are some
+ standardized uses:
+
+ For proximity sensors which give the proximity (of a person) to
+ a certain wlan or wwan antenna the followingQuoted 8 lines
standardized labels
+ are used:
+
+ * "proximity-wifi"
+ * "proximity-lte"
+ * "proximity-wifi-lte"
+ * "proximity-wifi-left"
+ * "proximity-wifi-right"Could we avoid having "lte" in the label names? Do we have a way to communicate that some of those labels are deprecated and should be avoided?
Quoted 2 lines
I would use "wwan" instead of "lte" here, and just mention "proximity- wifi-lte" as a synonym for "proximity-wifi-wwan".
the "lte" postfix is currently in use on ChromeOS, which is why I chose it here. I'm fine with adding some text that new drivers should use -wwan, although I wonder how this will work with separate mmwave and normal 5g antennas as such keeping lte for both 4g + regular 5g might actually be better and then the separate mmwave antennas can use a -mmwave postfix.
Dmitry IIRC you brought up the use of these labels in a previous discussion. Do you have anything to add here ? Is ChromeOS already doing anything wrt SAR for mmwave antennas?
Quoted 26 lines
Quoted 26 lines
+
+ These are used to indicate to userspace that these proximity
+ sensors may be used to tune transmit power to ensure that
+ Specific Absorption Rate (SAR) limits are honored. + The "-left" and "-right" labels are for devices with multiple
+ antennas.
+
+ In some laptops/tablets the standardized proximity sensor labels
+ instead indicate proximity to a specific part of the device:
+
+ * "proximity-palmrest" indicates proximity to the keyboard's palmrest
+ * "proximity-palmrest-left" indicates proximity to the left part of the palmrest
+ * "proximity-palmrest-right" indicates proximity to the right part of the palmrest
+ * "proximity-lap" indicates the device is being used on someone's lap
+
+ Note "proximity-lap" is special in that its value mayQuoted 8 lines
Quoted 4 lines
be
+ calculated by firmware from other sensor readings, rather then
+ being a raw sensor reading.I don't think that this is needed. I would expect that this sensor would have a "0" minimum and "1" maximum value, which makes it clear that the sensor value is synthesised.
Quoted 2 lines
IIO typically exports real sensor readings, not these kind of synthesized values so IMHO it is good to mention this in the docs.
We do similar synthesized values in a few similar places. The assumption is there is a _scale that would map these to 'real world units'. We might not know what it is however. So I'm not against adding them here.
Real readings of course preferred if they are available. We can provide _available attributes for raw readings that let userspace know it only has range 0..1 with a step size of 1.
Quoted 8 lines
Quoted 7 lines
Maybe this special case should be mentioned (if that's needed), rather than pointing out that this particular sensor might be special (they could all be, depending on how the system is implemented after all).
Did you think about where you wanted the sensor's threshold to be exported? Still in udev/hwdb?
Quoted 8 lines
AFAIK the plan was for the driver to export this as a IIO sysfs attribute,
Documentation/ABI/testing/sysfs-bus-iioalready has:What: /sys/.../events/in_proximity0_thresh_falling_value What: /sys/.../events/in_proximity0_thresh_rising_valueThose are intended for the trigger interface, but IIRC I think the
Event rather than trigger interface, but I get what you mean.
Quoted 2 lines
plan was to also use these on a device without trigger support to advertise the recommended threshold to be used by userspace.
That is rather nasty as any standard userspace will map those to actually generating iio events.
So if I follow correctly this is meta data that might of use to userspace and we want some way to expose that?
If so I think I'd rather see new ABI to expose that.
We might have some spec or testing defined notion of 'near' alongside an actual threshold detector that can be controlled to be more paranoid for example and hence need the above interface.
No idea on naming for a new ABI though :) Could be something like in_proximity0_raw_hintnear though I'm sure others will have better ideas perhaps related to what this threshold is called in relevant specs etc.
Quoted 2 lines
Jonathan ?
I'll be honest I've lost track of where we were going with this so it's more than possible I'll disagree with earlier me, let alone everyone else :)
Quoted 21 lines
Regards,
Hans
Quoted 10 lines
Cheers
Quoted 5 lines
+
What: /sys/bus/iio/devices/iio:deviceX/current_timestamp_cl ock
KernelVersion: 4.5
Contact: [email protected]
PATCH RESEND v2 2/2 iio: documentation: Document accelerometer label use
In reply to Hans de GoedeSome 2-in-1 laptops / convertibles with 360° (yoga-style) hinges, have 2 accelerometers, 1 in their base and 1 in their display.
In many cases the kernel can detect the location of each accelerometer based on e.g. information from the ACPI tables.
It is important for userspace to know the location of the 2 accelerometers. Rather then adding a new sysfs-attribute for this we can relay this information to userspace by using standardized label strings for this. This mirrors how this is done for proximity sensors.
This commit documents 2 new standardized label strings for this purpose:
"accel-base"
"accel-display"
Note the "base" and "display" suffixes were chosen to match the values used for the systemd/udev hwdb.d/60-sensor.hwdb file's ACCEL_LOCATION property.
--- Documentation/ABI/testing/sysfs-bus-iio | 7 +++++++ 1 file changed, 7 insertions(+)
Documentation/ABI/testing/sysfs-bus-iio +7 -0
@@ -72,6 +72,13 @@ Description: calculated by firmware from other sensor readings, rather then being a raw sensor reading. + For accelerometers used in 2-in-1s with 360° (yoga-style) hinges, + which have an accelerometer in both their base and their display, + the following standardized labels are used: + + * "accel-base" + * "accel-display" + What: /sys/bus/iio/devices/iio:deviceX/current_timestamp_clock KernelVersion: 4.5 Contact: [email protected]
Signature · 1 line
2.30.2
Jonathan Cameron
maintainerQuoted 4 lines · On Mon, 5 Apr 2021 22:42:22 +0200 Hans de Goede <[email protected]> wrote:
Hi Jonathan,
AFAICT the v2 of this series is ready for merging, but I'm not seeing it here:
https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git/log/?h=testing
It's there. Was part of a pull request earlier this cycle I think and so may be somewhat buried in the history.
Quoted 16 lines
Hence this resend.
Regards,
Hans
Hans de Goede (2):
iio: documentation: Document proximity sensor label use
iio: documentation: Document accelerometer label useDocumentation/ABI/testing/sysfs-bus-iio | 46 +++++++++++++++++++++++++ 1 file changed, 46 insertions(+)
Hi,
Quoted 5 lines · Jonathan Cameron
Quoted 2 lines · On Mon, 5 Apr 2021 22:42:22 +0200 Hans de Goede <[email protected]> wrote:
Hi Jonathan,
Quoted 7 lines
Quoted 2 lines
AFAICT the v2 of this series is ready for merging, but I'm not seeing it here:
https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git/log/?h=testingIt's there. Was part of a pull request earlier this cycle I think and so may be somewhat buried in the history.
Good to know that it is already there.
I already was a bit surprised I couldn't find it, because I remembered you explicitly saying that you were going to merge it. I guess I should have searched a little bit harder before the resend, sorry about the noise.
Regards,
Hans