Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.18 as permitted sender) client-ip=23.128.96.18;
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: quoted-printable
In-Reply-To: <CA+cxXhmV_RxLupD18aOxLwaGGKSxihTY8ZZvQKzdd-dsYYf5dQ@mail.gmail.com>
References: <20210107154200.v4.1.I025fb861cd5fa0ef5286b7dce514728e9df7ae74@changeid> <20210107154200.v4.2.Ibe7d7d53c5b4fe72c60de90111ff763b53f38dbb@changeid> <161041827643.3661239.17919996906733477213@swboyd.mtv.corp.google.com> <CA+cxXhm45emyg-9j99U=UWY8QuhzWifh+VvsFBaTOTWs81tvUQ@mail.gmail.com> <161052058590.3661239.5654596152411573148@swboyd.mtv.corp.google.com> <CA+cxXhmZd0eeLjUwcTevZRNovbZWXNKQH5qOX_YFCKowxHNVfQ@mail.gmail.com> <161057967168.3661239.10329365279391431594@swboyd.mtv.corp.google.com> <CA+cxXhmV_RxLupD18aOxLwaGGKSxihTY8ZZvQKzdd-dsYYf5dQ@mail.gmail.com>
Subject: Re: [PATCH v4 2/2] Input: cros-ec-keyb - Expose function row physical map to userspace
From:   Stephen Boyd <swboyd@chromium.org>
Cc:     LKML <linux-kernel@vger.kernel.org>,
        Dmitry Torokhov <dmitry.torokhov@gmail.com>,
        Douglas Anderson <dianders@chromium.org>,
        Benson Leung <bleung@chromium.org>,
        Enric Balletbo i Serra <enric.balletbo@collabora.com>,
        Guenter Roeck <groeck@chromium.org>,
        Lee Jones <lee.jones@linaro.org>, linux-input@vger.kernel.org
To:     Philip Chen <philipchen@chromium.org>
Date:   Wed, 13 Jan 2021 17:39:51 -0800
Message-ID: <161058839125.3661239.15252566946929589144@swboyd.mtv.corp.google.com>
User-Agent: alot/0.9.1
Precedence: bulk

Quoting Philip Chen (2021-01-13 17:29:05)
> On Wed, Jan 13, 2021 at 3:14 PM Stephen Boyd <swboyd@chromium.org> wrote:
> >
> > Quoting Philip Chen (2021-01-13 14:47:18)
> > > On Tue, Jan 12, 2021 at 10:49 PM Stephen Boyd <swboyd@chromium.org> w=
rote:
> > > >
> > > > Quoting Philip Chen (2021-01-12 15:55:28)
> > > > > On Mon, Jan 11, 2021 at 6:24 PM Stephen Boyd <swboyd@chromium.org=
> wrote:
> > > > > >
> > > > > > Is it documented in Documentation/ABI/?
> > > > > Not yet.
> > > > > Is it proper to add the documentation to `testing/sysfs-driver-in=
put-keyboard`?
> > > >
> > > > Somewhere in testing is fine. I'm not sure if it is a generic propr=
ty
> > > > for all keyboards though? What's the path in sysfs?
> > > I wouldn't say it's generic.
> > > It is available in the keyboard device node only when the board has a
> > > custom top-row keyboard design.
> > > The path in sysfs is something like:
> > > /sys/class/input/input0/device/function_row_physmap, where input0 is
> > > cros_ec.
> >
> > I see that atkbd already has this so at least it would be common to some
> > sort of keyboard device. I'm not sure where to document it though. I see
> > that atkbd has a handful of undocumented sysfs attributes so adding all
> > of those may lead to a common path. At the least it sounds OK to have a
> > sysfs-driver-input-keyboard file if input folks are OK with it.
> Since there are other undocumented sysfs attributes for input/keyboard
> anyway, we should probably leave the documentation to another patch?
> For now, let's move to patch v5, where I've addressed all of the
> comments so far.

Please document this one that's being introduced. We should document all
the sysfs attributes but we don't always do a good job at it.