Add hotjoin entry in sys file system allow user enable/disable hotjoin
feature.
Add (*enable(disable)_hotjoin)() to i3c_master_controller_ops.
Add api i3c_master_enable(disable)_hotjoin();
Signed-off-by: Frank Li <Frank.Li@nxp.com>
---
drivers/i3c/master.c | 84 ++++++++++++++++++++++++++++++++++++++
include/linux/i3c/master.h | 5 +++
2 files changed, 89 insertions(+)
diff --git a/drivers/i3c/master.c b/drivers/i3c/master.c
index 08aeb69a78003..ed5e27cd20811 100644
--- a/drivers/i3c/master.c
+++ b/drivers/i3c/master.c
@@ -526,6 +526,89 @@ static ssize_t i2c_scl_frequency_show(struct device *dev,
}
static DEVICE_ATTR_RO(i2c_scl_frequency);
+static int i3c_set_hotjoin(struct i3c_master_controller *master, bool enable)
+{
+ int ret;
+
+ if (!master ||
+ !master->ops ||
+ !master->ops->enable_hotjoin ||
+ !master->ops->disable_hotjoin
+ )
+ return -EINVAL;
+
+ i3c_bus_normaluse_lock(&master->bus);
+
+ if (enable)
+ ret = master->ops->enable_hotjoin(master);
+ else
+ ret = master->ops->disable_hotjoin(master);
+
+ master->hotjoin = enable;
+
+ i3c_bus_normaluse_unlock(&master->bus);
+
+ return ret;
+}
+
+static ssize_t hotjoin_store(struct device *dev, struct device_attribute *attr,
+ const char *buf, size_t count)
+{
+ struct i3c_bus *i3cbus = dev_to_i3cbus(dev);
+ int ret;
+ long res;
+
+ if (!i3cbus->cur_master)
+ return -EINVAL;
+
+ if (kstrtol(buf, 10, &res))
+ return -EINVAL;
+
+ ret = i3c_set_hotjoin(i3cbus->cur_master->common.master, !!res);
+ if (ret)
+ return ret;
+
+ return count;
+}
+
+/*
+ * i3c_master_enable_hotjoin - Enable hotjoin
+ * @master: I3C master object
+ *
+ * Return: a 0 in case of success, an negative error code otherwise.
+ */
+int i3c_master_enable_hotjoin(struct i3c_master_controller *master)
+{
+ return i3c_set_hotjoin(master, true);
+}
+EXPORT_SYMBOL_GPL(i3c_master_enable_hotjoin);
+
+/*
+ * i3c_master_disable_hotjoin - Disable hotjoin
+ * @master: I3C master object
+ *
+ * Return: a 0 in case of success, an negative error code otherwise.
+ */
+int i3c_master_disable_hotjoin(struct i3c_master_controller *master)
+{
+ return i3c_set_hotjoin(master, false);
+}
+EXPORT_SYMBOL_GPL(i3c_master_disable_hotjoin);
+
+static ssize_t hotjoin_show(struct device *dev, struct device_attribute *da, char *buf)
+{
+ struct i3c_bus *i3cbus = dev_to_i3cbus(dev);
+ ssize_t ret;
+
+ i3c_bus_normaluse_lock(i3cbus);
+ ret = sysfs_emit(buf, "%d\n", i3cbus->cur_master->common.master->hotjoin);
+ i3c_bus_normaluse_unlock(i3cbus);
+
+ return ret;
+}
+
+static DEVICE_ATTR_RW(hotjoin);
+
static struct attribute *i3c_masterdev_attrs[] = {
&dev_attr_mode.attr,
&dev_attr_current_master.attr,
@@ -536,6 +619,7 @@ static struct attribute *i3c_masterdev_attrs[] = {
&dev_attr_pid.attr,
&dev_attr_dynamic_address.attr,
&dev_attr_hdrcap.attr,
+ &dev_attr_hotjoin.attr,
NULL,
};
ATTRIBUTE_GROUPS(i3c_masterdev);
diff --git a/include/linux/i3c/master.h b/include/linux/i3c/master.h
index 0b52da4f23467..65b8965968af2 100644
--- a/include/linux/i3c/master.h
+++ b/include/linux/i3c/master.h
@@ -452,6 +452,8 @@ struct i3c_master_controller_ops {
int (*disable_ibi)(struct i3c_dev_desc *dev);
void (*recycle_ibi_slot)(struct i3c_dev_desc *dev,
struct i3c_ibi_slot *slot);
+ int (*enable_hotjoin)(struct i3c_master_controller *master);
+ int (*disable_hotjoin)(struct i3c_master_controller *master);
};
/**
@@ -487,6 +489,7 @@ struct i3c_master_controller {
const struct i3c_master_controller_ops *ops;
unsigned int secondary : 1;
unsigned int init_done : 1;
+ unsigned int hotjoin: 1;
struct {
struct list_head i3c;
struct list_head i2c;
@@ -543,6 +546,8 @@ int i3c_master_register(struct i3c_master_controller *master,
const struct i3c_master_controller_ops *ops,
bool secondary);
void i3c_master_unregister(struct i3c_master_controller *master);
+int i3c_master_enable_hotjoin(struct i3c_master_controller *master);
+int i3c_master_disable_hotjoin(struct i3c_master_controller *master);
/**
* i3c_dev_get_master_data() - get master private data attached to an I3C
--
2.34.1On 10/18/2023 10:59 PM, Frank Li wrote:
> Add hotjoin entry in sys file system allow user enable/disable hotjoin
> feature.
>
> Add (*enable(disable)_hotjoin)() to i3c_master_controller_ops.
> Add api i3c_master_enable(disable)_hotjoin();
What is the use case for having HJ enable knob in sysfs available for
user space other than for debug stuff? In other words, does user space
really need to enable/disable HJ in runtime for other reason but debug?
If it is only for debug maybe it could be move to debugFS?
I think that maybe HJ enable knob shall be available in DT so you could
control the default state for this feature also at compilation phase?
> Signed-off-by: Frank Li <Frank.Li@nxp.com>
> ---
> drivers/i3c/master.c | 84 ++++++++++++++++++++++++++++++++++++++
> include/linux/i3c/master.h | 5 +++
> 2 files changed, 89 insertions(+)
>
> diff --git a/drivers/i3c/master.c b/drivers/i3c/master.c
> index 08aeb69a78003..ed5e27cd20811 100644
> --- a/drivers/i3c/master.c
> +++ b/drivers/i3c/master.c
> @@ -526,6 +526,89 @@ static ssize_t i2c_scl_frequency_show(struct device *dev,
> }
> static DEVICE_ATTR_RO(i2c_scl_frequency);
>
> +static int i3c_set_hotjoin(struct i3c_master_controller *master, bool enable)
> +{
> + int ret;
> +
> + if (!master ||
> + !master->ops ||
> + !master->ops->enable_hotjoin ||
> + !master->ops->disable_hotjoin
> + )
> + return -EINVAL;
> +
> + i3c_bus_normaluse_lock(&master->bus);
> +
> + if (enable)
> + ret = master->ops->enable_hotjoin(master);
> + else
> + ret = master->ops->disable_hotjoin(master);
> +
> + master->hotjoin = enable;
> +
> + i3c_bus_normaluse_unlock(&master->bus);
> +
> + return ret;
> +}
> +
> +static ssize_t hotjoin_store(struct device *dev, struct device_attribute *attr,
> + const char *buf, size_t count)
> +{
> + struct i3c_bus *i3cbus = dev_to_i3cbus(dev);
> + int ret;
> + long res;
> +
> + if (!i3cbus->cur_master)
> + return -EINVAL;
> +
> + if (kstrtol(buf, 10, &res))
> + return -EINVAL;
> +
> + ret = i3c_set_hotjoin(i3cbus->cur_master->common.master, !!res);
> + if (ret)
> + return ret;
> +
> + return count;
> +}
> +
> +/*
> + * i3c_master_enable_hotjoin - Enable hotjoin
> + * @master: I3C master object
> + *
> + * Return: a 0 in case of success, an negative error code otherwise.
> + */
> +int i3c_master_enable_hotjoin(struct i3c_master_controller *master)
> +{
> + return i3c_set_hotjoin(master, true);
> +}
> +EXPORT_SYMBOL_GPL(i3c_master_enable_hotjoin);
> +
> +/*
> + * i3c_master_disable_hotjoin - Disable hotjoin
> + * @master: I3C master object
> + *
> + * Return: a 0 in case of success, an negative error code otherwise.
> + */
> +int i3c_master_disable_hotjoin(struct i3c_master_controller *master)
> +{
> + return i3c_set_hotjoin(master, false);
> +}
> +EXPORT_SYMBOL_GPL(i3c_master_disable_hotjoin);
> +
> +static ssize_t hotjoin_show(struct device *dev, struct device_attribute *da, char *buf)
> +{
> + struct i3c_bus *i3cbus = dev_to_i3cbus(dev);
> + ssize_t ret;
> +
> + i3c_bus_normaluse_lock(i3cbus);
> + ret = sysfs_emit(buf, "%d\n", i3cbus->cur_master->common.master->hotjoin);
> + i3c_bus_normaluse_unlock(i3cbus);
> +
> + return ret;
> +}
> +
> +static DEVICE_ATTR_RW(hotjoin);
> +
> static struct attribute *i3c_masterdev_attrs[] = {
> &dev_attr_mode.attr,
> &dev_attr_current_master.attr,
> @@ -536,6 +619,7 @@ static struct attribute *i3c_masterdev_attrs[] = {
> &dev_attr_pid.attr,
> &dev_attr_dynamic_address.attr,
> &dev_attr_hdrcap.attr,
> + &dev_attr_hotjoin.attr,
> NULL,
> };
> ATTRIBUTE_GROUPS(i3c_masterdev);
> diff --git a/include/linux/i3c/master.h b/include/linux/i3c/master.h
> index 0b52da4f23467..65b8965968af2 100644
> --- a/include/linux/i3c/master.h
> +++ b/include/linux/i3c/master.h
> @@ -452,6 +452,8 @@ struct i3c_master_controller_ops {
> int (*disable_ibi)(struct i3c_dev_desc *dev);
> void (*recycle_ibi_slot)(struct i3c_dev_desc *dev,
> struct i3c_ibi_slot *slot);
> + int (*enable_hotjoin)(struct i3c_master_controller *master);
> + int (*disable_hotjoin)(struct i3c_master_controller *master);
> };
>
> /**
> @@ -487,6 +489,7 @@ struct i3c_master_controller {
> const struct i3c_master_controller_ops *ops;
> unsigned int secondary : 1;
> unsigned int init_done : 1;
> + unsigned int hotjoin: 1;
> struct {
> struct list_head i3c;
> struct list_head i2c;
> @@ -543,6 +546,8 @@ int i3c_master_register(struct i3c_master_controller *master,
> const struct i3c_master_controller_ops *ops,
> bool secondary);
> void i3c_master_unregister(struct i3c_master_controller *master);
> +int i3c_master_enable_hotjoin(struct i3c_master_controller *master);
> +int i3c_master_disable_hotjoin(struct i3c_master_controller *master);
>
> /**
> * i3c_dev_get_master_data() - get master private data attached to an I3C
Hi Lukwinski, zbigniew.lukwinski@linux.intel.com wrote on Fri, 20 Oct 2023 10:55:27 +0200: > On 10/18/2023 10:59 PM, Frank Li wrote: > > Add hotjoin entry in sys file system allow user enable/disable hotjoin > > feature. > > > > Add (*enable(disable)_hotjoin)() to i3c_master_controller_ops. > > Add api i3c_master_enable(disable)_hotjoin(); > > What is the use case for having HJ enable knob in sysfs available for user space other than for debug stuff? In other words, does user space really need to enable/disable HJ in runtime for other reason but debug? If it is only for debug maybe it could be move to debugFS? I don't think hotjoin should be considered as a debug feature. The problem here is the power consumption which is higher if you enable this feature (you need to keep everything clocked and ready to handle an IBI) whereas if your design is "fixed" (more like an I2C bus) you may save power by disabling this feature. A module parameter does not fit here because it's a per-bus configuration. Thanks, Miquèl
On Fri, Oct 20, 2023 at 03:45:28PM +0200, Miquel Raynal wrote: > Hi Lukwinski, > > zbigniew.lukwinski@linux.intel.com wrote on Fri, 20 Oct 2023 10:55:27 > +0200: > > > On 10/18/2023 10:59 PM, Frank Li wrote: > > > Add hotjoin entry in sys file system allow user enable/disable hotjoin > > > feature. > > > > > > Add (*enable(disable)_hotjoin)() to i3c_master_controller_ops. > > > Add api i3c_master_enable(disable)_hotjoin(); > > > > What is the use case for having HJ enable knob in sysfs available for user space other than for debug stuff? In other words, does user space really need to enable/disable HJ in runtime for other reason but debug? If it is only for debug maybe it could be move to debugFS? > > I don't think hotjoin should be considered as a debug feature. The > problem here is the power consumption which is higher if you enable > this feature (you need to keep everything clocked and ready to handle > an IBI) whereas if your design is "fixed" (more like an I2C bus) you > may save power by disabling this feature. > > A module parameter does not fit here because it's a per-bus > configuration. I agree. sys entry is more flexiable. and let controller choose better power saving policy for difference user case. Frank > > Thanks, > Miquèl
Hi Frank, Frank.li@nxp.com wrote on Fri, 20 Oct 2023 10:20:57 -0400: > On Fri, Oct 20, 2023 at 03:45:28PM +0200, Miquel Raynal wrote: > > Hi Lukwinski, > > > > zbigniew.lukwinski@linux.intel.com wrote on Fri, 20 Oct 2023 10:55:27 > > +0200: > > > > > On 10/18/2023 10:59 PM, Frank Li wrote: > > > > Add hotjoin entry in sys file system allow user enable/disable hotjoin > > > > feature. > > > > > > > > Add (*enable(disable)_hotjoin)() to i3c_master_controller_ops. > > > > Add api i3c_master_enable(disable)_hotjoin(); > > > > > > What is the use case for having HJ enable knob in sysfs available for user space other than for debug stuff? In other words, does user space really need to enable/disable HJ in runtime for other reason but debug? If it is only for debug maybe it could be move to debugFS? > > > > I don't think hotjoin should be considered as a debug feature. The > > problem here is the power consumption which is higher if you enable > > this feature (you need to keep everything clocked and ready to handle > > an IBI) whereas if your design is "fixed" (more like an I2C bus) you > > may save power by disabling this feature. > > > > A module parameter does not fit here because it's a per-bus > > configuration. > > I agree. sys entry is more flexiable. and let controller choose better > power saving policy for difference user case. Maybe it's not the first time this case is faced, would you mind including power management maintainers in this discussion? Perhaps they might have pointers or even have the solution already. Thanks, Miquèl
On Fri, Oct 20, 2023 at 04:33:48PM +0200, Miquel Raynal wrote: > Hi Frank, > > Frank.li@nxp.com wrote on Fri, 20 Oct 2023 10:20:57 -0400: > > > On Fri, Oct 20, 2023 at 03:45:28PM +0200, Miquel Raynal wrote: > > > Hi Lukwinski, > > > > > > zbigniew.lukwinski@linux.intel.com wrote on Fri, 20 Oct 2023 10:55:27 > > > +0200: > > > > > > > On 10/18/2023 10:59 PM, Frank Li wrote: > > > > > Add hotjoin entry in sys file system allow user enable/disable hotjoin > > > > > feature. > > > > > > > > > > Add (*enable(disable)_hotjoin)() to i3c_master_controller_ops. > > > > > Add api i3c_master_enable(disable)_hotjoin(); > > > > > > > > What is the use case for having HJ enable knob in sysfs available for user space other than for debug stuff? In other words, does user space really need to enable/disable HJ in runtime for other reason but debug? If it is only for debug maybe it could be move to debugFS? > > > > > > I don't think hotjoin should be considered as a debug feature. The > > > problem here is the power consumption which is higher if you enable > > > this feature (you need to keep everything clocked and ready to handle > > > an IBI) whereas if your design is "fixed" (more like an I2C bus) you > > > may save power by disabling this feature. > > > > > > A module parameter does not fit here because it's a per-bus > > > configuration. > > > > I agree. sys entry is more flexiable. and let controller choose better > > power saving policy for difference user case. > > Maybe it's not the first time this case is faced, would you mind > including power management maintainers in this discussion? Perhaps they > might have pointers or even have the solution already. @Ulf and pm experts. I3C have a features, which call hotjoin. Some controller need enable clock and some power domain if support hotjoin. there are two kinds user case. case1: All devices attached into I3C bus, not hotjoin happen. So controller can use runtime_pm frame to make clock and power domain on only when transferring data. case2: some devices can dynamitc join when system running. Some clocks or power domain need be kept to make hotjoin event detect logic work. In one system, two cases may exist at same time. I3C bus1 for case1, I3C bus2 for case 2. I add sys entry in I3C bus driver to let user can turn on/off this feature for specific controller. My question: any exited solution can handle these in current power mnanagement system. Frank > > Thanks, > Miquèl
© 2016 - 2025 Red Hat, Inc.