Currently custom sensors properties are not decoded and it is up to
user space to interpret.
Some manufacturers already standardized the meaning of some custom sensors.
They can be presented as a proper IIO sensor. We can identify these sensors
based on manufacturer and serial number property in the report.
This change is identifying hinge sensor when the manufacturer is "INTEL".
This creates a platform device so that a sensor driver can be loaded to
process these sensors.
Signed-off-by: Ye Xiang <[email protected]>
---
drivers/hid/hid-sensor-custom.c | 169 ++++++++++++++++++++++++++++++++
include/linux/hid-sensor-ids.h | 39 ++++++++
2 files changed, 208 insertions(+)
diff --git a/drivers/hid/hid-sensor-custom.c b/drivers/hid/hid-sensor-custom.c
index 4d25577a8573..6ef8387405b3 100644
--- a/drivers/hid/hid-sensor-custom.c
+++ b/drivers/hid/hid-sensor-custom.c
@@ -4,6 +4,7 @@
* Copyright (c) 2015, Intel Corporation.
*/
+#include <linux/ctype.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/init.h>
@@ -21,6 +22,7 @@
#define HID_CUSTOM_TOTAL_ATTRS (HID_CUSTOM_MAX_CORE_ATTRS + 1)
#define HID_CUSTOM_FIFO_SIZE 4096
#define HID_CUSTOM_MAX_FEATURE_BYTES 64
+#define HID_SENSOR_USAGE_LENGTH (4 + 1)
struct hid_sensor_custom_field {
int report_id;
@@ -50,6 +52,8 @@ struct hid_sensor_custom {
struct kfifo data_fifo;
unsigned long misc_opened;
wait_queue_head_t wait;
+ struct platform_device *custom_pdev;
+ bool custom_pdev_exposed;
};
/* Header for each sample to user space via dev interface */
@@ -746,11 +750,158 @@ static void hid_sensor_custom_dev_if_remove(struct hid_sensor_custom
}
+/*
+ * use sensors luid which is defined in FW, such as ISH,
+ * to identify sensor.
+ */
+static char *known_sensor_luid[] = { "020B000000000000" };
+
+static int get_luid_table_index(unsigned char *usage_str)
+{
+ int i;
+
+ for (i = 0; i < ARRAY_SIZE(known_sensor_luid); i++) {
+ if (!strncmp(usage_str, known_sensor_luid[i],
+ strlen(known_sensor_luid[i])))
+ return i;
+ }
+
+ return -1;
+}
+
+static int get_known_custom_sensor_index(struct hid_sensor_hub_device *hsdev)
+{
+ struct hid_sensor_hub_attribute_info sensor_manufacturer = { 0 };
+ struct hid_sensor_hub_attribute_info sensor_luid_info = { 0 };
+ int report_size;
+ int ret;
+ u16 *w_buf;
+ int w_buf_len;
+ char *buf;
+ int buf_len;
+ int i;
+ int index;
+
+ w_buf_len = sizeof(u16) * HID_CUSTOM_MAX_FEATURE_BYTES;
+ buf_len = sizeof(char) * HID_CUSTOM_MAX_FEATURE_BYTES;
+ w_buf = kzalloc(w_buf_len, GFP_KERNEL);
+ if (!w_buf)
+ return -1;
+
+ buf = kzalloc(buf_len, GFP_KERNEL);
+ if (!buf) {
+ kfree(w_buf);
+ return -1;
+ }
+
+ /* get manufacturer info */
+ ret = sensor_hub_input_get_attribute_info(
+ hsdev, HID_FEATURE_REPORT, hsdev->usage,
+ HID_USAGE_SENSOR_PROP_MANUFACTURER, &sensor_manufacturer);
+ if (ret < 0)
+ goto err_out;
+
+ report_size =
+ sensor_hub_get_feature(hsdev, sensor_manufacturer.report_id,
+ sensor_manufacturer.index, w_buf_len,
+ w_buf);
+ if (report_size <= 0) {
+ hid_err(hsdev->hdev,
+ "Failed to get sensor manufacturer info %d\n",
+ report_size);
+ goto err_out;
+ }
+
+ /* convert from wide char to char */
+ for (i = 0; i < buf_len - 1 && w_buf[i]; i++)
+ buf[i] = (char)w_buf[i];
+
+ /* ensure it's ISH sensor */
+ if (strncmp(buf, "INTEL", strlen("INTEL")))
+ goto err_out;
+
+ memset(w_buf, 0, w_buf_len);
+ memset(buf, 0, buf_len);
+
+ /* get real usage id */
+ ret = sensor_hub_input_get_attribute_info(
+ hsdev, HID_FEATURE_REPORT, hsdev->usage,
+ HID_USAGE_SENSOR_PROP_SERIAL_NUM, &sensor_luid_info);
+ if (ret < 0)
+ goto err_out;
+
+ report_size = sensor_hub_get_feature(hsdev, sensor_luid_info.report_id,
+ sensor_luid_info.index, w_buf_len,
+ w_buf);
+ if (report_size <= 0) {
+ hid_err(hsdev->hdev, "Failed to get real usage info %d\n",
+ report_size);
+ goto err_out;
+ }
+
+ /* convert from wide char to char */
+ for (i = 0; i < buf_len - 1 && w_buf[i]; i++)
+ buf[i] = (char)w_buf[i];
+
+ if (strlen(buf) != strlen(known_sensor_luid[0]) + 5) {
+ hid_err(hsdev->hdev, " %ld != %ld\n", strlen(buf),
+ strlen(known_sensor_luid[0]));
+ goto err_out;
+ }
+
+ /* get table index with luid (not matching 'LUID: ' in luid) */
+ index = get_luid_table_index(&buf[5]);
+ kfree(w_buf);
+ kfree(buf);
+ return index;
+
+err_out:
+ kfree(w_buf);
+ kfree(buf);
+ return -1;
+}
+
+static struct platform_device *
+register_platform_device(struct platform_device *pdev,
+ struct hid_sensor_hub_device *hsdev, int index)
+{
+ char real_usage[HID_SENSOR_USAGE_LENGTH] = { 0 };
+ struct platform_device *custom_pdev;
+ const char *dev_name;
+ char *c;
+ int ret;
+
+ /* copy real usage id */
+ memcpy(real_usage, known_sensor_luid[index], 4);
+
+ /* usage id are all lowcase */
+ for (c = real_usage; *c != '\0'; c++)
+ *c = tolower(*c);
+
+ /* HID-SENSOR-INT-REAL_USAGE_ID */
+ dev_name = kasprintf(GFP_KERNEL, "HID-SENSOR-INT-%s", real_usage);
+ if (!dev_name)
+ return NULL;
+
+ custom_pdev = platform_device_register_data(pdev->dev.parent, dev_name,
+ PLATFORM_DEVID_NONE, hsdev,
+ sizeof(*hsdev));
+ kfree(dev_name);
+ ret = PTR_ERR_OR_ZERO(custom_pdev);
+ if (ret) {
+ dev_err(&pdev->dev, "platform_device_register_data failed ret:%d\n", ret);
+ return NULL;
+ }
+
+ return custom_pdev;
+}
+
static int hid_sensor_custom_probe(struct platform_device *pdev)
{
struct hid_sensor_custom *sensor_inst;
struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
int ret;
+ int index;
sensor_inst = devm_kzalloc(&pdev->dev, sizeof(*sensor_inst),
GFP_KERNEL);
@@ -764,6 +915,19 @@ static int hid_sensor_custom_probe(struct platform_device *pdev)
sensor_inst->pdev = pdev;
mutex_init(&sensor_inst->mutex);
platform_set_drvdata(pdev, sensor_inst);
+
+ index = get_known_custom_sensor_index(hsdev);
+ if (index >= 0) {
+ sensor_inst->custom_pdev =
+ register_platform_device(pdev, hsdev, index);
+ if (sensor_inst->custom_pdev) {
+ sensor_inst->custom_pdev_exposed = true;
+ return 0;
+ }
+
+ dev_err(&pdev->dev, "register_platform_device failed\n");
+ }
+
ret = sensor_hub_register_callback(hsdev, hsdev->usage,
&sensor_inst->callbacks);
if (ret < 0) {
@@ -802,6 +966,11 @@ static int hid_sensor_custom_remove(struct platform_device *pdev)
struct hid_sensor_custom *sensor_inst = platform_get_drvdata(pdev);
struct hid_sensor_hub_device *hsdev = pdev->dev.platform_data;
+ if (sensor_inst->custom_pdev_exposed) {
+ platform_device_unregister(sensor_inst->custom_pdev);
+ return 0;
+ }
+
hid_sensor_custom_dev_if_remove(sensor_inst);
hid_sensor_custom_remove_attributes(sensor_inst);
sysfs_remove_group(&sensor_inst->pdev->dev.kobj,
diff --git a/include/linux/hid-sensor-ids.h b/include/linux/hid-sensor-ids.h
index 530c09f3e64a..46db3056f04b 100644
--- a/include/linux/hid-sensor-ids.h
+++ b/include/linux/hid-sensor-ids.h
@@ -128,6 +128,10 @@
#define HID_USAGE_SENSOR_UNITS_DEGREES_PER_SECOND 0x15
/* Common selectors */
+#define HID_USAGE_SENSOR_PROP_DESC 0x200300
+#define HID_USAGE_SENSOR_PROP_FRIENDLY_NAME 0x200301
+#define HID_USAGE_SENSOR_PROP_SERIAL_NUM 0x200307
+#define HID_USAGE_SENSOR_PROP_MANUFACTURER 0x200305
#define HID_USAGE_SENSOR_PROP_REPORT_INTERVAL 0x20030E
#define HID_USAGE_SENSOR_PROP_SENSITIVITY_ABS 0x20030F
#define HID_USAGE_SENSOR_PROP_SENSITIVITY_RANGE_PCT 0x200310
@@ -159,4 +163,39 @@
#define HID_USAGE_SENSOR_PROP_REPORTING_STATE_NO_EVENTS_ENUM 0x200840
#define HID_USAGE_SENSOR_PROP_REPORTING_STATE_ALL_EVENTS_ENUM 0x200841
+/* Custom Sensor (2000e1) */
+#define HID_USAGE_SENSOR_HINGE 0x20020B
+#define HID_USAGE_SENSOR_DATA_FIELD_LOCATION 0x200400
+#define HID_USAGE_SENSOR_DATA_FIELE_TIME_SINCE_SYS_BOOT 0x20052B
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_USAGE 0x200541
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE 0x200543
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_1 0x200544
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_2 0x200545
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_3 0x200546
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_4 0x200547
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_5 0x200548
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_6 0x200549
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_7 0x20054A
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_8 0x20054B
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_9 0x20054C
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_10 0x20054D
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_11 0x20054E
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_12 0x20054F
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_13 0x200550
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_14 0x200551
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_15 0x200552
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_16 0x200553
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_17 0x200554
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_18 0x200555
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_19 0x200556
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_20 0x200557
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_21 0x200558
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_22 0x200559
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_23 0x20055A
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_24 0x20055B
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_25 0x20055C
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_26 0x20055D
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_27 0x20055E
+#define HID_USAGE_SENSOR_DATA_FIELD_CUSTOM_VALUE_28 0x20055F
+
#endif
--
2.17.1
Hi Ye,
Thank you for the patch! Perhaps something to improve:
[auto build test WARNING on iio/togreg]
[also build test WARNING on linus/master v5.10-rc4 next-20201118]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch]
url: https://github.com/0day-ci/linux/commits/Ye-Xiang/add-custom-hinge-sensor-support/20201119-110842
base: https://git.kernel.org/pub/scm/linux/kernel/git/jic23/iio.git togreg
config: c6x-randconfig-r003-20201119 (attached as .config)
compiler: c6x-elf-gcc (GCC) 9.3.0
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# https://github.com/0day-ci/linux/commit/1f33733d65038ade4af057df7e5c126485ecb7c6
git remote add linux-review https://github.com/0day-ci/linux
git fetch --no-tags linux-review Ye-Xiang/add-custom-hinge-sensor-support/20201119-110842
git checkout 1f33733d65038ade4af057df7e5c126485ecb7c6
# save the attached .config to linux build tree
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-9.3.0 make.cross ARCH=c6x
If you fix the issue, kindly add following tag as appropriate
Reported-by: kernel test robot <[email protected]>
All warnings (new ones prefixed by >>):
drivers/hid/hid-sensor-custom.c: In function 'store_value':
drivers/hid/hid-sensor-custom.c:401:7: warning: variable 'ret' set but not used [-Wunused-but-set-variable]
401 | int ret;
| ^~~
In file included from include/linux/device.h:15,
from include/linux/miscdevice.h:7,
from drivers/hid/hid-sensor-custom.c:11:
drivers/hid/hid-sensor-custom.c: In function 'get_known_custom_sensor_index':
>> drivers/hid/hid-sensor-custom.c:847:24: warning: format '%ld' expects argument of type 'long int', but argument 3 has type '__kernel_size_t' {aka 'unsigned int'} [-Wformat=]
847 | hid_err(hsdev->hdev, " %ld != %ld\n", strlen(buf),
| ^~~~~~~~~~~~~~~
include/linux/dev_printk.h:19:22: note: in definition of macro 'dev_fmt'
19 | #define dev_fmt(fmt) fmt
| ^~~
include/linux/hid.h:1180:2: note: in expansion of macro 'dev_err'
1180 | dev_err(&(hid)->dev, fmt, ##__VA_ARGS__)
| ^~~~~~~
drivers/hid/hid-sensor-custom.c:847:3: note: in expansion of macro 'hid_err'
847 | hid_err(hsdev->hdev, " %ld != %ld\n", strlen(buf),
| ^~~~~~~
drivers/hid/hid-sensor-custom.c:847:28: note: format string is defined here
847 | hid_err(hsdev->hdev, " %ld != %ld\n", strlen(buf),
| ~~^
| |
| long int
| %d
In file included from include/linux/device.h:15,
from include/linux/miscdevice.h:7,
from drivers/hid/hid-sensor-custom.c:11:
drivers/hid/hid-sensor-custom.c:847:24: warning: format '%ld' expects argument of type 'long int', but argument 4 has type '__kernel_size_t' {aka 'unsigned int'} [-Wformat=]
847 | hid_err(hsdev->hdev, " %ld != %ld\n", strlen(buf),
| ^~~~~~~~~~~~~~~
include/linux/dev_printk.h:19:22: note: in definition of macro 'dev_fmt'
19 | #define dev_fmt(fmt) fmt
| ^~~
include/linux/hid.h:1180:2: note: in expansion of macro 'dev_err'
1180 | dev_err(&(hid)->dev, fmt, ##__VA_ARGS__)
| ^~~~~~~
drivers/hid/hid-sensor-custom.c:847:3: note: in expansion of macro 'hid_err'
847 | hid_err(hsdev->hdev, " %ld != %ld\n", strlen(buf),
| ^~~~~~~
drivers/hid/hid-sensor-custom.c:847:35: note: format string is defined here
847 | hid_err(hsdev->hdev, " %ld != %ld\n", strlen(buf),
| ~~^
| |
| long int
| %d
vim +847 drivers/hid/hid-sensor-custom.c
771
772 static int get_known_custom_sensor_index(struct hid_sensor_hub_device *hsdev)
773 {
774 struct hid_sensor_hub_attribute_info sensor_manufacturer = { 0 };
775 struct hid_sensor_hub_attribute_info sensor_luid_info = { 0 };
776 int report_size;
777 int ret;
778 u16 *w_buf;
779 int w_buf_len;
780 char *buf;
781 int buf_len;
782 int i;
783 int index;
784
785 w_buf_len = sizeof(u16) * HID_CUSTOM_MAX_FEATURE_BYTES;
786 buf_len = sizeof(char) * HID_CUSTOM_MAX_FEATURE_BYTES;
787 w_buf = kzalloc(w_buf_len, GFP_KERNEL);
788 if (!w_buf)
789 return -1;
790
791 buf = kzalloc(buf_len, GFP_KERNEL);
792 if (!buf) {
793 kfree(w_buf);
794 return -1;
795 }
796
797 /* get manufacturer info */
798 ret = sensor_hub_input_get_attribute_info(
799 hsdev, HID_FEATURE_REPORT, hsdev->usage,
800 HID_USAGE_SENSOR_PROP_MANUFACTURER, &sensor_manufacturer);
801 if (ret < 0)
802 goto err_out;
803
804 report_size =
805 sensor_hub_get_feature(hsdev, sensor_manufacturer.report_id,
806 sensor_manufacturer.index, w_buf_len,
807 w_buf);
808 if (report_size <= 0) {
809 hid_err(hsdev->hdev,
810 "Failed to get sensor manufacturer info %d\n",
811 report_size);
812 goto err_out;
813 }
814
815 /* convert from wide char to char */
816 for (i = 0; i < buf_len - 1 && w_buf[i]; i++)
817 buf[i] = (char)w_buf[i];
818
819 /* ensure it's ISH sensor */
820 if (strncmp(buf, "INTEL", strlen("INTEL")))
821 goto err_out;
822
823 memset(w_buf, 0, w_buf_len);
824 memset(buf, 0, buf_len);
825
826 /* get real usage id */
827 ret = sensor_hub_input_get_attribute_info(
828 hsdev, HID_FEATURE_REPORT, hsdev->usage,
829 HID_USAGE_SENSOR_PROP_SERIAL_NUM, &sensor_luid_info);
830 if (ret < 0)
831 goto err_out;
832
833 report_size = sensor_hub_get_feature(hsdev, sensor_luid_info.report_id,
834 sensor_luid_info.index, w_buf_len,
835 w_buf);
836 if (report_size <= 0) {
837 hid_err(hsdev->hdev, "Failed to get real usage info %d\n",
838 report_size);
839 goto err_out;
840 }
841
842 /* convert from wide char to char */
843 for (i = 0; i < buf_len - 1 && w_buf[i]; i++)
844 buf[i] = (char)w_buf[i];
845
846 if (strlen(buf) != strlen(known_sensor_luid[0]) + 5) {
> 847 hid_err(hsdev->hdev, " %ld != %ld\n", strlen(buf),
848 strlen(known_sensor_luid[0]));
849 goto err_out;
850 }
851
852 /* get table index with luid (not matching 'LUID: ' in luid) */
853 index = get_luid_table_index(&buf[5]);
854 kfree(w_buf);
855 kfree(buf);
856 return index;
857
858 err_out:
859 kfree(w_buf);
860 kfree(buf);
861 return -1;
862 }
863
---
0-DAY CI Kernel Test Service, Intel Corporation
https://lists.01.org/hyperkitty/list/[email protected]