mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Armin Wolf <W_Armin@gmx.de>
To: Antheas Kapenekakis <lkml@antheas.dev>
Cc: platform-driver-x86@vger.kernel.org,
	linux-kernel@vger.kernel.org, linux-hwmon@vger.kernel.org,
	"Hans de Goede" <hansg@kernel.org>,
	"Ilpo Järvinen" <ilpo.jarvinen@linux.intel.com>,
	"Derek John Clark" <derekjohn.clark@gmail.com>,
	"Joaquín Ignacio Aramendía" <samsagax@gmail.com>,
	"Jean Delvare" <jdelvare@suse.com>,
	"Guenter Roeck" <linux@roeck-us.net>
Subject: Re: [PATCH v3 4/6] platform/x86: ayaneo-ec: Add controller power and modules attributes
Date: Tue, 4 Nov 2025 21:03:32 +0100	[thread overview]
Message-ID: <e0b29b59-b37d-4c44-ab97-9527b0f959b1@gmx.de> (raw)
In-Reply-To: <CAGwozwFRF11dH02SRRNCyiYW7dNuoYoGWfPdEWPoim2r-KoZ0g@mail.gmail.com>

Am 02.11.25 um 19:46 schrieb Antheas Kapenekakis:

> On Sun, 2 Nov 2025 at 19:30, Armin Wolf <W_Armin@gmx.de> wrote:
>> Am 31.10.25 um 17:36 schrieb Antheas Kapenekakis:
>>
>>> The Ayaneo 3 features hot-swappable controller modules. The ejection
>>> and management is done through HID. However, after ejecting the modules,
>>> the controller needs to be power cycled via the EC to re-initialize.
>>>
>>> For this, the EC provides a variable that holds whether the left or
>>> right modules are connected, and a power control register to turn
>>> the controller on or off. After ejecting the modules, the controller
>>> should be turned off. Then, after both modules are reinserted,
>>> the controller may be powered on again to re-initialize.
>>>
>>> This patch introduces two new sysfs attributes:
>>>    - `controller_modules`: a read-only attribute that indicates whether
>>>      the left and right modules are connected (none, left, right, both).
>>>    - `controller_power`: a read-write attribute that allows the user
>>>      to turn the controller on or off (with '1'/'0').
>>>
>>> Therefore, after ejection is complete, userspace can power off the
>>> controller, then wait until both modules have been reinserted
>>> (`controller_modules` will return 'both') to turn on the controller.
>>>
>>> Reviewed-by: Armin Wolf <W_Armin@gmx.de>
>>> Signed-off-by: Antheas Kapenekakis <lkml@antheas.dev>
>>> ---
>>>    .../ABI/testing/sysfs-platform-ayaneo-ec      |  19 ++++
>>>    MAINTAINERS                                   |   1 +
>>>    drivers/platform/x86/ayaneo-ec.c              | 106 ++++++++++++++++++
>>>    3 files changed, 126 insertions(+)
>>>    create mode 100644 Documentation/ABI/testing/sysfs-platform-ayaneo-ec
>>>
>>> diff --git a/Documentation/ABI/testing/sysfs-platform-ayaneo-ec b/Documentation/ABI/testing/sysfs-platform-ayaneo-ec
>>> new file mode 100644
>>> index 000000000000..3c9c3580c685
>>> --- /dev/null
>>> +++ b/Documentation/ABI/testing/sysfs-platform-ayaneo-ec
>>> @@ -0,0 +1,19 @@
>>> +What:                /sys/devices/platform/ayaneo-ec/controller_power
>>> +Date:                Oct 2025
>> I think you need to update those dates.
>>
>>> +KernelVersion:       6.19
>>> +Contact:     "Antheas Kapenekakis" <lkml@antheas.dev>
>>> +Description:
>>> +             Current controller power state. Allows turning on and off
>>> +             the controller power (e.g. for power savings). Write 1 to
>>> +             turn on, 0 to turn off. File is readable and writable.
>>> +
>>> +What:                /sys/devices/platform/ayaneo-ec/controller_modules
>>> +Date:                Oct 2025
>>> +KernelVersion:       6.19
>>> +Contact:     "Antheas Kapenekakis"  <lkml@antheas.dev>
>>> +Description:
>>> +             Shows which controller modules are currently connected to
>>> +             the device. Possible values are "left", "right" and "both".
>>> +             File is read-only. The Windows software for this device
>>> +             will only set controller power to 1 if both module sides
>>> +             are connected (i.e. this file returns "both").
>>> diff --git a/MAINTAINERS b/MAINTAINERS
>>> index da9498d8cc89..b4d62ea9a926 100644
>>> --- a/MAINTAINERS
>>> +++ b/MAINTAINERS
>>> @@ -4191,6 +4191,7 @@ AYANEO PLATFORM EC DRIVER
>>>    M:  Antheas Kapenekakis <lkml@antheas.dev>
>>>    L:  platform-driver-x86@vger.kernel.org
>>>    S:  Maintained
>>> +F:   Documentation/ABI/testing/sysfs-platform-ayaneo
>>>    F:  drivers/platform/x86/ayaneo-ec.c
>>>
>>>    AZ6007 DVB DRIVER
>>> diff --git a/drivers/platform/x86/ayaneo-ec.c b/drivers/platform/x86/ayaneo-ec.c
>>> index 697bb053a7d6..0652c044ad76 100644
>>> --- a/drivers/platform/x86/ayaneo-ec.c
>>> +++ b/drivers/platform/x86/ayaneo-ec.c
>>> @@ -8,6 +8,7 @@
>>>     */
>>>
>>>    #include <linux/acpi.h>
>>> +#include <linux/bits.h>
>>>    #include <linux/dmi.h>
>>>    #include <linux/err.h>
>>>    #include <linux/hwmon.h>
>>> @@ -16,6 +17,7 @@
>>>    #include <linux/module.h>
>>>    #include <linux/platform_device.h>
>>>    #include <linux/power_supply.h>
>>> +#include <linux/sysfs.h>
>>>    #include <acpi/battery.h>
>>>
>>>    #define AYANEO_PWM_ENABLE_REG        0x4A
>>> @@ -32,9 +34,17 @@
>>>    #define AYANEO_CHARGE_VAL_AUTO              0xaa
>>>    #define AYANEO_CHARGE_VAL_INHIBIT   0x55
>>>
>>> +#define AYANEO_POWER_REG     0x2d
>>> +#define AYANEO_POWER_OFF     0xfe
>>> +#define AYANEO_POWER_ON              0xff
>>> +#define AYANEO_MODULE_REG    0x2f
>>> +#define AYANEO_MODULE_LEFT   BIT(0)
>>> +#define AYANEO_MODULE_RIGHT  BIT(1)
>> Using GENMASK() would make sense here.
> Only a single bit is being used though? GENMASK is used for a contiguous series?

I was thinking of using GENMASK() for both bits:

#define AYANEO_MODULE_MASK	GENMASK(1, 0)

You can then retrieve both bits using FIELD_GET() and simply use a switch statement
together with an enum in controller_modules_show().

Thanks,
Armin Wolf

>> With those issues being fixed:
>> Reviewed-by: Armin Wolf <W_Armin@gmx.de>
>>
>>> +
>>>    struct ayaneo_ec_quirk {
>>>        bool has_fan_control;
>>>        bool has_charge_control;
>>> +     bool has_magic_modules;
>>>    };
>>>
>>>    struct ayaneo_ec_platform_data {
>>> @@ -46,6 +56,7 @@ struct ayaneo_ec_platform_data {
>>>    static const struct ayaneo_ec_quirk quirk_ayaneo3 = {
>>>        .has_fan_control = true,
>>>        .has_charge_control = true,
>>> +     .has_magic_modules = true,
>>>    };
>>>
>>>    static const struct dmi_system_id dmi_table[] = {
>>> @@ -266,6 +277,100 @@ static int ayaneo_remove_battery(struct power_supply *battery,
>>>        return 0;
>>>    }
>>>
>>> +static ssize_t controller_power_store(struct device *dev,
>>> +                                   struct device_attribute *attr,
>>> +                                   const char *buf,
>>> +                                   size_t count)
>>> +{
>>> +     bool value;
>>> +     int ret;
>>> +
>>> +     ret = kstrtobool(buf, &value);
>>> +     if (ret)
>>> +             return ret;
>>> +
>>> +     ret = ec_write(AYANEO_POWER_REG, value ? AYANEO_POWER_ON : AYANEO_POWER_OFF);
>>> +     if (ret)
>>> +             return ret;
>>> +
>>> +     return count;
>>> +}
>>> +
>>> +static ssize_t controller_power_show(struct device *dev,
>>> +                                  struct device_attribute *attr,
>>> +                                  char *buf)
>>> +{
>>> +     int ret;
>>> +     u8 val;
>>> +
>>> +     ret = ec_read(AYANEO_POWER_REG, &val);
>>> +     if (ret)
>>> +             return ret;
>>> +
>>> +     return sysfs_emit(buf, "%d\n", val == AYANEO_POWER_ON);
>>> +}
>>> +
>>> +static DEVICE_ATTR_RW(controller_power);
>>> +
>>> +static ssize_t controller_modules_show(struct device *dev,
>>> +                                    struct device_attribute *attr, char *buf)
>>> +{
>>> +     char *out;
>>> +     int ret;
>>> +     u8 val;
>>> +
>>> +     ret = ec_read(AYANEO_MODULE_REG, &val);
>>> +     if (ret)
>>> +             return ret;
>>> +
>>> +     switch (~val & (AYANEO_MODULE_LEFT | AYANEO_MODULE_RIGHT)) {
>>> +     case AYANEO_MODULE_LEFT | AYANEO_MODULE_RIGHT:
>>> +             out = "both";
>>> +             break;
>>> +     case AYANEO_MODULE_LEFT:
>>> +             out = "left";
>>> +             break;
>>> +     case AYANEO_MODULE_RIGHT:
>>> +             out = "right";
>>> +             break;
>>> +     default:
>>> +             out = "none";
>>> +             break;
>>> +     }
>>> +
>>> +     return sysfs_emit(buf, "%s\n", out);
>>> +}
>>> +
>>> +static DEVICE_ATTR_RO(controller_modules);
>>> +
>>> +static struct attribute *aya_mm_attrs[] = {
>>> +     &dev_attr_controller_power.attr,
>>> +     &dev_attr_controller_modules.attr,
>>> +     NULL
>>> +};
>>> +
>>> +static umode_t aya_mm_is_visible(struct kobject *kobj,
>>> +                              struct attribute *attr, int n)
>>> +{
>>> +     struct device *dev = kobj_to_dev(kobj);
>>> +     struct platform_device *pdev = to_platform_device(dev);
>>> +     struct ayaneo_ec_platform_data *data = platform_get_drvdata(pdev);
>>> +
>>> +     if (data->quirks->has_magic_modules)
>>> +             return attr->mode;
>>> +     return 0;
>>> +}
>>> +
>>> +static const struct attribute_group aya_mm_attribute_group = {
>>> +     .is_visible = aya_mm_is_visible,
>>> +     .attrs = aya_mm_attrs,
>>> +};
>>> +
>>> +static const struct attribute_group *ayaneo_ec_groups[] = {
>>> +     &aya_mm_attribute_group,
>>> +     NULL
>>> +};
>>> +
>>>    static int ayaneo_ec_probe(struct platform_device *pdev)
>>>    {
>>>        const struct dmi_system_id *dmi_entry;
>>> @@ -307,6 +412,7 @@ static int ayaneo_ec_probe(struct platform_device *pdev)
>>>    static struct platform_driver ayaneo_platform_driver = {
>>>        .driver = {
>>>                .name = "ayaneo-ec",
>>> +             .dev_groups = ayaneo_ec_groups,
>>>        },
>>>        .probe = ayaneo_ec_probe,
>>>    };

  reply	other threads:[~2025-11-04 20:03 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-10-31 16:36 [PATCH v3 0/6] platform/x86: ayaneo-ec: Add Ayaneo Embedded Controller platform driver Antheas Kapenekakis
2025-10-31 16:36 ` [PATCH v3 1/6] " Antheas Kapenekakis
2025-11-02 18:21   ` Armin Wolf
2025-11-02 18:35     ` Armin Wolf
2025-11-02 18:37     ` Antheas Kapenekakis
2025-11-04 19:58       ` Armin Wolf
2025-10-31 16:36 ` [PATCH v3 2/6] platform/x86: ayaneo-ec: Add hwmon support Antheas Kapenekakis
2025-11-02 18:22   ` Armin Wolf
2025-10-31 16:36 ` [PATCH v3 3/6] platform/x86: ayaneo-ec: Add charge control support Antheas Kapenekakis
2025-11-02 18:26   ` Armin Wolf
     [not found]     ` <CAGwozwHfaeOnMmLbAK03gzG2JCsZ=TDAv3EMyDoBZRtG=ix5ng@mail.gmail.com>
2025-11-04 20:00       ` Armin Wolf
2025-10-31 16:36 ` [PATCH v3 4/6] platform/x86: ayaneo-ec: Add controller power and modules attributes Antheas Kapenekakis
2025-11-02 18:30   ` Armin Wolf
2025-11-02 18:46     ` Antheas Kapenekakis
2025-11-04 20:03       ` Armin Wolf [this message]
2025-11-05 12:33         ` Antheas Kapenekakis
2025-11-05 13:24           ` Ilpo Järvinen
2025-11-05 13:38             ` Antheas Kapenekakis
2025-11-05 22:20             ` Armin Wolf
2025-10-31 16:36 ` [PATCH v3 5/6] platform/x86: ayaneo-ec: Move Ayaneo devices from oxpec to ayaneo-ec Antheas Kapenekakis
2025-10-31 16:36 ` [PATCH v3 6/6] platform/x86: ayaneo-ec: Add suspend hook Antheas Kapenekakis
2025-11-02 18:35   ` Armin Wolf
2025-11-02 18:58     ` Antheas Kapenekakis
2025-11-10 12:11       ` Ilpo Järvinen
2025-11-03 16:51   ` Mario Limonciello (AMD) (kernel.org)
2025-11-03 21:20     ` Antheas Kapenekakis
2025-11-03 21:33       ` Mario Limonciello (AMD) (kernel.org)
2025-11-03 22:09         ` Antheas Kapenekakis
2025-10-31 16:38 ` [PATCH v3 0/6] platform/x86: ayaneo-ec: Add Ayaneo Embedded Controller platform driver Antheas Kapenekakis
2025-10-31 16:39   ` Antheas Kapenekakis

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=e0b29b59-b37d-4c44-ab97-9527b0f959b1@gmx.de \
    --to=w_armin@gmx.de \
    --cc=derekjohn.clark@gmail.com \
    --cc=hansg@kernel.org \
    --cc=ilpo.jarvinen@linux.intel.com \
    --cc=jdelvare@suse.com \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=lkml@antheas.dev \
    --cc=platform-driver-x86@vger.kernel.org \
    --cc=samsagax@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®