Skip to contentSkip to conversation

iio: cros_ec_sensors: add cros_ec_activity driver

PATCH Superseded Gwendal Grignou 3 participants 3 messages May 21, 2025 – May 23, 2025

Subsystems (2)

v2 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 iio: cros_ec_sensors: add cros_ec_activity driver

ChromeOS EC can report activity information derived from the accelerometer:
- Reports on-body/off-body as a proximity event.
- Reports significant motion as an activity event.

This new sensor is a virtual sensor, included only when the EC firmware is compiled with the appropriate module.

---
Changes in v2:
- fix usage of cros_ec_motion_send_host_cmd
- use dev instead of &pdev->dev
- fix documentation errors.

 drivers/iio/common/cros_ec_sensors/Kconfig    |   9 +
 drivers/iio/common/cros_ec_sensors/Makefile   |   1 +
 .../common/cros_ec_sensors/cros_ec_activity.c | 325 ++++++++++++++++++
 .../cros_ec_sensors/cros_ec_sensors_core.c    |  10 +
 .../linux/iio/common/cros_ec_sensors_core.h   |   1 +
 .../linux/platform_data/cros_ec_commands.h    |  36 +-
 6 files changed, 376 insertions(+), 6 deletions(-)
 create mode 100644 drivers/iio/common/cros_ec_sensors/cros_ec_activity.c
drivers/iio/common/cros_ec_sensors/Kconfig +9 -0
index fefad9572790..394e319c9c97 100644
@@ -30,3 +30,12 @@ config IIO_CROS_EC_SENSORS_LID_ANGLE
 	  convertible devices.
 	  This module is loaded when the EC can calculate the angle between the base
 	  and the lid.
+
+config IIO_CROS_EC_ACTIVITY
+	tristate "ChromeOS EC Activity Sensors"
+	depends on IIO_CROS_EC_SENSORS_CORE
+	help
+	  Module to handle activity events presented by the ChromeOS EC sensor hub.
+	  Activities can be a proximity detector (on body/off body detection)
+	  or a significant motion detector.
+	  Creates an IIO device to manage all activities.
drivers/iio/common/cros_ec_sensors/Makefile +1 -0
index e0a33ab66d21..a7849c52f3c8 100644
@@ -3,6 +3,7 @@
 # Makefile for sensors seen through the ChromeOS EC sensor hub.
 #
 
+obj-$(CONFIG_IIO_CROS_EC_ACTIVITY) += cros_ec_activity.o
 obj-$(CONFIG_IIO_CROS_EC_SENSORS_CORE) += cros_ec_sensors_core.o
 obj-$(CONFIG_IIO_CROS_EC_SENSORS) += cros_ec_sensors.o
 obj-$(CONFIG_IIO_CROS_EC_SENSORS_LID_ANGLE) += cros_ec_lid_angle.o
drivers/iio/common/cros_ec_sensors/cros_ec_activity.c new file +325 -0

325 lines not on this page · raw message

drivers/iio/common/cros_ec_sensors/cros_ec_sensors_core.c +10 -0
index 64bada1e8678..1bd07ca3abfe 100644
@@ -489,6 +489,16 @@ const struct iio_chan_spec_ext_info cros_ec_sensors_ext_info[] = {
 };
 EXPORT_SYMBOL_GPL(cros_ec_sensors_ext_info);
 
+const struct iio_chan_spec_ext_info cros_ec_sensors_limited_info[] = {
+	{
+		.name = "id",
+		.shared = IIO_SHARED_BY_ALL,
+		.read = cros_ec_sensors_id
+	},
+	{ },
+};
+EXPORT_SYMBOL_GPL(cros_ec_sensors_limited_info);
+
 /**
  * cros_ec_sensors_idx_to_reg - convert index into offset in shared memory
  * @st:		pointer to state information for device
include/linux/iio/common/cros_ec_sensors_core.h +1 -0
index e72167b96d27..bb966abcde53 100644
@@ -126,5 +126,6 @@ extern const struct dev_pm_ops cros_ec_sensors_pm_ops;
 
 /* List of extended channel specification for all sensors. */
 extern const struct iio_chan_spec_ext_info cros_ec_sensors_ext_info[];
+extern const struct iio_chan_spec_ext_info cros_ec_sensors_limited_info[];
 
 #endif  /* __CROS_EC_SENSORS_CORE_H */
include/linux/platform_data/cros_ec_commands.h +30 -6
index ecf290a0c98f..0f6d53e7cb97 100644
@@ -2388,6 +2388,12 @@ enum motionsense_command {
 	 */
 	MOTIONSENSE_CMD_SENSOR_SCALE = 18,
 
+	/*
+	 * Activity management
+	 * Retrieve current status of given activity.
+	 */
+	MOTIONSENSE_CMD_GET_ACTIVITY = 20,
+
 	/* Number of motionsense sub-commands. */
 	MOTIONSENSE_NUM_CMDS
 };
@@ -2447,6 +2453,11 @@ enum motionsensor_orientation {
 	MOTIONSENSE_ORIENTATION_UNKNOWN = 4,
 };
 
+struct ec_response_activity_data {
+	uint8_t activity; /* motionsensor_activity */
+	uint8_t state;
+} __ec_todo_packed;
+
 struct ec_response_motion_sensor_data {
 	/* Flags for each sensor. */
 	uint8_t flags;
@@ -2454,15 +2465,14 @@ struct ec_response_motion_sensor_data {
 	uint8_t sensor_num;
 	/* Each sensor is up to 3-axis. */
 	union {
-		int16_t             data[3];
+		int16_t                                  data[3];
 		struct __ec_todo_packed {
-			uint16_t    reserved;
-			uint32_t    timestamp;
+			uint16_t                         reserved;
+			uint32_t                         timestamp;
 		};
 		struct __ec_todo_unpacked {
-			uint8_t     activity; /* motionsensor_activity */
-			uint8_t     state;
-			int16_t     add_info[2];
+			struct ec_response_activity_data activity_data;
+			int16_t                          add_info[2];
 		};
 	};
 } __ec_todo_packed;
@@ -2494,6 +2504,7 @@ enum motionsensor_activity {
 	MOTIONSENSE_ACTIVITY_SIG_MOTION = 1,
 	MOTIONSENSE_ACTIVITY_DOUBLE_TAP = 2,
 	MOTIONSENSE_ACTIVITY_ORIENTATION = 3,
+	MOTIONSENSE_ACTIVITY_BODY_DETECTION = 4,
 };
 
 struct ec_motion_sense_activity {
@@ -2671,6 +2682,7 @@ struct ec_params_motion_sense {
 			uint32_t max_data_vector;
 		} fifo_read;
 
+		/* Used for MOTIONSENSE_CMD_SET_ACTIVITY */
 		struct ec_motion_sense_activity set_activity;
 
 		/* Used for MOTIONSENSE_CMD_LID_ANGLE */
@@ -2716,6 +2728,14 @@ struct ec_params_motion_sense {
 			 */
 			int16_t hys_degree;
 		} tablet_mode_threshold;
+
+		/*
+		 * Used for MOTIONSENSE_CMD_GET_ACTIVITY.
+		 */
+		struct __ec_todo_unpacked {
+			uint8_t sensor_num;
+			uint8_t activity;  /* enum motionsensor_activity */
+		} get_activity;
 	};
 } __ec_todo_packed;
 
@@ -2833,6 +2853,10 @@ struct ec_response_motion_sense {
 			uint16_t hys_degree;
 		} tablet_mode_threshold;
 
+		/* USED for MOTIONSENSE_CMD_GET_ACTIVITY. */
+		struct __ec_todo_unpacked {
+			uint8_t     state;
+		} get_activity;
 	};
 } __ec_todo_packed;
 
Signature · 1 line
2.49.0.1151.ga128411c76-goog
#1 lore raw

drivers/iio/common/cros_ec_sensors/cros_ec_activity.c line 3

Quoted 4 lines · Gwendal Grignou
drivers/iio/common/cros_ec_sensors/cros_ec_activity.c +2 -0
[...]
+/*
+ * cros_ec_sensors_activity - Driver for activities/gesture recognition.

s/sensors//.

Quoted 16 lines
drivers/iio/common/cros_ec_sensors/cros_ec_activity.c +15 -0
+static int cros_ec_write_event_config(struct iio_dev *indio_dev,
[...]
+	switch (chan->type) {
+	case IIO_PROXIMITY:
+		st->core.param.set_activity.activity =
+			MOTIONSENSE_ACTIVITY_BODY_DETECTION;
+		break;
+	case IIO_ACTIVITY:
+		if (chan->channel2 == IIO_MOD_STILL) {
+			st->core.param.set_activity.activity =
+				MOTIONSENSE_ACTIVITY_SIG_MOTION;
+		} else {
+			dev_warn(&indio_dev->dev, "Unknown activity: %d\n",
+				 chan->channel2);
+		}
+		break;

drivers/iio/common/cros_ec_sensors/cros_ec_activity.c line 156

Quoted 10 lines
drivers/iio/common/cros_ec_sensors/cros_ec_activity.c +10 -0
+	default:
+		dev_warn(&indio_dev->dev, "Unknown channel type: %d\n",
+			 chan->type);
+	}
+	st->core.param.set_activity.enable = state;
+
+	ret = cros_ec_motion_send_host_cmd(&st->core, 0);
+
+	mutex_unlock(&st->core.cmd_lock);
+	return ret;

If either activity or channel type is unknown, does it still need to send the host command for writing the config?

drivers/iio/common/cros_ec_sensors/cros_ec_activity.c line 248

Quoted 12 lines
drivers/iio/common/cros_ec_sensors/cros_ec_activity.c +11 -0
+static int cros_ec_sensors_probe(struct platform_device *pdev)
[...]
+	/*
+	 * List all available activities
+	 */
+	st->core.param.cmd = MOTIONSENSE_CMD_LIST_ACTIVITIES;
+	ret = cros_ec_motion_send_host_cmd(&st->core, 0);
+	if (ret)
+		return ret;
+	activities = st->core.resp->list_activities.enabled |
+		     st->core.resp->list_activities.disabled;
+	nb_activities = hweight_long(activities) + 1;

See review comments for v1 too. Moving the line just right before the following devm_kcalloc() for st->channels makes more sense.

Quoted 4 lines
drivers/iio/common/cros_ec_sensors/cros_ec_activity.c +4 -0
+
+	if (!activities)
+		return -ENODEV;
+

drivers/iio/common/cros_ec_sensors/cros_ec_activity.c line 262

Quoted 10 lines
drivers/iio/common/cros_ec_sensors/cros_ec_activity.c +10 -0
+	/* Allocate a channel per activity and one for timestamp */
+	st->channels = devm_kcalloc(dev, nb_activities,
+				    sizeof(*st->channels), GFP_KERNEL);
+	if (!st->channels)
+		return -ENOMEM;
+
+	channel = &st->channels[0];
+	index = 0;
+	for_each_set_bit(i, &activities, BITS_PER_LONG) {
+		channel->scan_index = index++;

This doesn't look correct. It generates some unused index if the activity is unknown.

Moving the statement to the end of loop? See review comments for v1 too.

#2 lore raw
Quoted 8 lines · Tzung-Bi Shih

drivers/iio/common/cros_ec_sensors/cros_ec_activity.c line 3

Quoted 4 lines · Gwendal Grignou
drivers/iio/common/cros_ec_sensors/cros_ec_activity.c +2 -0
[...]
+/*
+ * cros_ec_sensors_activity - Driver for activities/gesture recognition.

s/sensors//.

Done.

Quoted 23 lines
Quoted 23 lines
drivers/iio/common/cros_ec_sensors/cros_ec_activity.c +20 -0
+static int cros_ec_write_event_config(struct iio_dev *indio_dev,
[...]
+     switch (chan->type) {
+     case IIO_PROXIMITY:
+             st->core.param.set_activity.activity =
+                     MOTIONSENSE_ACTIVITY_BODY_DETECTION;
+             break;
+     case IIO_ACTIVITY:
+             if (chan->channel2 == IIO_MOD_STILL) {
+                     st->core.param.set_activity.activity =
+                             MOTIONSENSE_ACTIVITY_SIG_MOTION;
+             } else {
+                     dev_warn(&indio_dev->dev, "Unknown activity: %d\n",
+                              chan->channel2);
+             }
+             break;
+     default:
+             dev_warn(&indio_dev->dev, "Unknown channel type: %d\n",
+                      chan->type);
+     }
+     st->core.param.set_activity.enable = state;
Quoted 8 lines

drivers/iio/common/cros_ec_sensors/cros_ec_activity.c line 117

Quoted 5 lines
drivers/iio/common/cros_ec_sensors/cros_ec_activity.c +5 -0
+
+     ret = cros_ec_motion_send_host_cmd(&st->core, 0);
+
+     mutex_unlock(&st->core.cmd_lock);
+     return ret;

If either activity or channel type is unknown, does it still need to send the host command for writing the config?

Fixed: argument checking now done in one place.

Quoted 15 lines
Quoted 4 lines
drivers/iio/common/cros_ec_sensors/cros_ec_activity.c +1 -0
+static int cros_ec_sensors_probe(struct platform_device *pdev)
[...]

drivers/iio/common/cros_ec_sensors/cros_ec_activity.c line 248

Quoted 10 lines
drivers/iio/common/cros_ec_sensors/cros_ec_activity.c +10 -0
+     /*
+      * List all available activities
+      */
+     st->core.param.cmd = MOTIONSENSE_CMD_LIST_ACTIVITIES;
+     ret = cros_ec_motion_send_host_cmd(&st->core, 0);
+     if (ret)
+             return ret;
+     activities = st->core.resp->list_activities.enabled |
+                  st->core.resp->list_activities.disabled;
+     nb_activities = hweight_long(activities) + 1;
Quoted 2 lines

See review comments for v1 too. Moving the line just right before the following devm_kcalloc() for st->channels makes more sense.

Done.

Quoted 19 lines
Quoted 5 lines
drivers/iio/common/cros_ec_sensors/cros_ec_activity.c +4 -0
+
+     if (!activities)
+             return -ENODEV;
+

drivers/iio/common/cros_ec_sensors/cros_ec_activity.c line 262

Quoted 10 lines
drivers/iio/common/cros_ec_sensors/cros_ec_activity.c +10 -0
+     /* Allocate a channel per activity and one for timestamp */
+     st->channels = devm_kcalloc(dev, nb_activities,
+                                 sizeof(*st->channels), GFP_KERNEL);
+     if (!st->channels)
+             return -ENOMEM;
+
+     channel = &st->channels[0];
+     index = 0;
+     for_each_set_bit(i, &activities, BITS_PER_LONG) {
+             channel->scan_index = index++;

This doesn't look correct. It generates some unused index if the activity is unknown.

Quoted 1 line

Moving the statement to the end of loop? See review comments for v1 too.

I now understand the v1 comments. Fixed.