linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Marek Behun <marek.behun@nic.cz>
To: Luka Kovacic <luka.kovacic@sartura.hr>
Cc: linux-kernel@vger.kernel.org, linux-hwmon@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org, linux-leds@vger.kernel.org,
	lee.jones@linaro.org, pavel@ucw.cz, dmurphy@ti.com,
	robh+dt@kernel.org, jdelvare@suse.com, linux@roeck-us.net,
	andrew@lunn.ch, jason@lakedaemon.net,
	gregory.clement@bootlin.com, luka.perkov@sartura.hr,
	robert.marko@sartura.hr
Subject: Re: [PATCH v2 5/7] Documentation/ABI: Add iei-wt61p803-puzzle driver sysfs interface documentation
Date: Sat, 26 Sep 2020 20:25:21 +0200	[thread overview]
Message-ID: <20200926202521.100d17f8@nic.cz> (raw)
In-Reply-To: <20200926135514.26189-6-luka.kovacic@sartura.hr>

On Sat, 26 Sep 2020 15:55:12 +0200
Luka Kovacic <luka.kovacic@sartura.hr> wrote:

> Add the iei-wt61p803-puzzle driver sysfs interface documentation to allow
> monitoring and control of the microcontroller from user space.
> 
> Signed-off-by: Luka Kovacic <luka.kovacic@sartura.hr>
> Cc: Luka Perkov <luka.perkov@sartura.hr>
> Cc: Robert Marko <robert.marko@sartura.hr>
> ---
>  .../stable/sysfs-driver-iei-wt61p803-puzzle   | 65 +++++++++++++++++++
>  1 file changed, 65 insertions(+)
>  create mode 100644 Documentation/ABI/stable/sysfs-driver-iei-wt61p803-puzzle
> 
> diff --git a/Documentation/ABI/stable/sysfs-driver-iei-wt61p803-puzzle b/Documentation/ABI/stable/sysfs-driver-iei-wt61p803-puzzle
> new file mode 100644
> index 000000000000..36fca70d66ef
> --- /dev/null
> +++ b/Documentation/ABI/stable/sysfs-driver-iei-wt61p803-puzzle

I think this should go to testing, not stable. It should go to stable
only after it is stable for some time.

> @@ -0,0 +1,65 @@
> +What:		/sys/bus/serial/devices/.../iei_wt61p803_puzzle_core/mac_address_*
> +Date:		September 2020
> +Contact:	Luka Kovacic <luka.kovacic@sartura.hr>
> +Description:	Read the internal iEi WT61P803 PUZZLE MCU MAC address values.
> +		These are factory assigned and can be changed.
> +
> +What:		/sys/bus/serial/devices/.../iei_wt61p803_puzzle_core/serial_number
> +Date:		September 2020
> +Contact:	Luka Kovacic <luka.kovacic@sartura.hr>
> +Description:	Read the internal iEi WT61P803 PUZZLE MCU serial number.
> +		This value is factory assigned and can be changed.
> +

Please use (RO) and (RW) prefixes before the Description, instead of
writing "This value is read only", i.e.:
  Description: (RO) Internal ... serial number.

JFI: Why can these values be changed? Shouldn't they be burned into OTP?

Marek

> +What:		/sys/bus/serial/devices/.../iei_wt61p803_puzzle_core/version
> +Date:		September 2020
> +Contact:	Luka Kovacic <luka.kovacic@sartura.hr>
> +Description:	Read the internal iEi WT61P803 PUZZLE MCU version.
> +		This value is read only.
> +
> +What:		/sys/bus/serial/devices/.../iei_wt61p803_puzzle_core/protocol_version
> +Date:		September 2020
> +Contact:	Luka Kovacic <luka.kovacic@sartura.hr>
> +Description:	Read the internal iEi WT61P803 PUZZLE MCU protocol version.
> +		This value is read only.
> +
> +What:		/sys/bus/serial/devices/.../iei_wt61p803_puzzle_core/power_loss_recovery
> +Date:		September 2020
> +Contact:	Luka Kovacic <luka.kovacic@sartura.hr>
> +Description:	Read the iEi WT61P803 PUZZLE MCU power loss recovery value.
> +		This value is read write.
> +		Value mapping: 0 - Always-On, 1 - Always-Off, 2 - Always-AC, 3 - Always-WA
> +
> +What:		/sys/bus/serial/devices/.../iei_wt61p803_puzzle_core/bootloader_mode
> +Date:		September 2020
> +Contact:	Luka Kovacic <luka.kovacic@sartura.hr>
> +Description:	Read whether the MCU is in bootloader mode.
> +		This value is read only.
> +
> +What:		/sys/bus/serial/devices/.../iei_wt61p803_puzzle_core/power_status
> +Date:		September 2020
> +Contact:	Luka Kovacic <luka.kovacic@sartura.hr>
> +Description:	Read the iEi WT61P803 PUZZLE MCU power status. Power status indicates
> +		the power on method.
> +		This value is read only.
> +		Value mapping (bitwise list):
> +		0x80 - Null
> +		0x40 - Firmware flag
> +		0x20 - Power loss detection flag (powered off)
> +		0x10 - Power loss detection flag (AC mode)
> +		0x08 - Button power on
> +		0x04 - WOL power on
> +		0x02 - RTC alarm power on
> +		0x01 - AC recover power on
> +
> +What:		/sys/bus/serial/devices/.../iei_wt61p803_puzzle_core/build_info
> +Date:		September 2020
> +Contact:	Luka Kovacic <luka.kovacic@sartura.hr>
> +Description:	Read the iEi WT61P803 PUZZLE MCU firmware build date.
> +		This value is read only.
> +		Format: yyyy/mm/dd hh:mm
> +
> +What:		/sys/bus/serial/devices/.../iei_wt61p803_puzzle_core/ac_recovery_status
> +Date:		September 2020
> +Contact:	Luka Kovacic <luka.kovacic@sartura.hr>
> +Description:	Read the iEi WT61P803 PUZZLE MCU AC recovery status.
> +		This value is read only.


  reply	other threads:[~2020-09-26 18:25 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-26 13:55 [PATCH v2 0/7] Add support for the iEi Puzzle-M801 board Luka Kovacic
2020-09-26 13:55 ` [PATCH v2 1/7] dt-bindings: Add iEi vendor prefix and iEi WT61P803 PUZZLE driver bindings Luka Kovacic
2020-09-26 17:56   ` Marek Behun
2020-09-26 13:55 ` [PATCH v2 2/7] drivers: mfd: Add a driver for iEi WT61P803 PUZZLE MCU Luka Kovacic
2020-09-26 19:16   ` [RFC PATCH] drivers: mfd: iei_wt61p803_puzzle_checksum() can be static kernel test robot
2020-09-26 19:28   ` [PATCH v2 2/7] drivers: mfd: Add a driver for iEi WT61P803 PUZZLE MCU Marek Behun
2020-09-27 16:09     ` Luka Kovacic
2020-09-26 13:55 ` [PATCH v2 3/7] drivers: hwmon: Add the iEi WT61P803 PUZZLE HWMON driver Luka Kovacic
2020-09-26 22:50   ` kernel test robot
2020-09-26 13:55 ` [PATCH v2 4/7] drivers: leds: Add the iEi WT61P803 PUZZLE LED driver Luka Kovacic
2020-09-26 18:09   ` Marek Behun
2020-09-27 15:44     ` Luka Kovacic
2020-09-26 13:55 ` [PATCH v2 5/7] Documentation/ABI: Add iei-wt61p803-puzzle driver sysfs interface documentation Luka Kovacic
2020-09-26 18:25   ` Marek Behun [this message]
2020-09-27 15:49     ` Luka Kovacic
2020-09-26 13:55 ` [PATCH v2 6/7] MAINTAINERS: Add an entry for the iEi WT61P803 PUZZLE driver Luka Kovacic
2020-09-26 13:55 ` [PATCH v2 7/7] arm64: dts: marvell: Add a device tree for the iEi Puzzle-M801 board Luka Kovacic
2020-09-26 15:05   ` Andrew Lunn
2020-09-26 17:50   ` Marek Behun
2020-09-27 15:01     ` Luka Kovacic

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=20200926202521.100d17f8@nic.cz \
    --to=marek.behun@nic.cz \
    --cc=andrew@lunn.ch \
    --cc=dmurphy@ti.com \
    --cc=gregory.clement@bootlin.com \
    --cc=jason@lakedaemon.net \
    --cc=jdelvare@suse.com \
    --cc=lee.jones@linaro.org \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-hwmon@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-leds@vger.kernel.org \
    --cc=linux@roeck-us.net \
    --cc=luka.kovacic@sartura.hr \
    --cc=luka.perkov@sartura.hr \
    --cc=pavel@ucw.cz \
    --cc=robert.marko@sartura.hr \
    --cc=robh+dt@kernel.org \
    /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;
as well as URLs for NNTP newsgroup(s).