Re: [PATCH v8 1/5] Documentation: add sbsa-gwdt driver documentation
From: Mark Rutland
Date: Tue Oct 27 2015 - 12:23:15 EST
On Wed, Oct 28, 2015 at 12:06:35AM +0800, fu.wei@xxxxxxxxxx wrote:
> From: Fu Wei <fu.wei@xxxxxxxxxx>
> The sbsa-gwdt.txt documentation in devicetree/bindings/watchdog is for
> introducing SBSA(Server Base System Architecture) Generic Watchdog
> device node info into FDT.
> Also add sbsa-gwdt introduction in watchdog-parameters.txt
> Acked-by: Arnd Bergmann <arnd@xxxxxxxx>
> Signed-off-by: Fu Wei <fu.wei@xxxxxxxxxx>
> .../devicetree/bindings/watchdog/sbsa-gwdt.txt | 46 ++++++++++++++++++++++
> Documentation/watchdog/watchdog-parameters.txt | 6 +++
> 2 files changed, 52 insertions(+)
> diff --git a/Documentation/devicetree/bindings/watchdog/sbsa-gwdt.txt b/Documentation/devicetree/bindings/watchdog/sbsa-gwdt.txt
> new file mode 100644
> index 0000000..ad8e99a
> --- /dev/null
> +++ b/Documentation/devicetree/bindings/watchdog/sbsa-gwdt.txt
> @@ -0,0 +1,46 @@
> +* SBSA (Server Base System Architecture) Generic Watchdog
> +The SBSA Generic Watchdog Timer is used to force a reset of the system
> +after two stages of timeout have elapsed. A detailed definition of the
> +watchdog timer can be found in the ARM document: ARM-DEN-0029 - Server
> +Base System Architecture (SBSA)
> +Required properties:
> +- compatible: Should at least contain "arm,sbsa-gwdt".
> +- reg: Each entry specifies the base physical 64-bit address of a register
> + frame and the 64-bit length of that frame; currently, two frames must be
Remove "64-bit" here. This depends on #address-cells and #size-cells, as
> + defined, in this order:
> + 1: Watchdog control frame
> + 2: Refresh frame.
> +- interrupts: At least one interrupt must be defined that will be used as
> + the WS0 interrupt. A WS1 interrupt definition can be provided, but is
> + optional. The interrupts must be defined in this order:
> + 1: WS0 interrupt
> + 2: WS1 interrupt
Why is WS1 optional?
> +Optional properties
> +- timeout-sec: To use a timeout value that is different from the driver
> + default values, use this property.
Either define a default value, or don't state anything about the
behaviour when this is not present.
> If used, at least one timeout value
> + (in seconds) must be provided. A second optional timeout value (in
> + seconds) may also be provided and will be used as the pre-timeout value,
> + if it is given.
> + There are two possible sources for driver default timeout values:
> + (1) the driver contains hard-coded default values, or
> + (2) module parameters can be given when the module is loaded
> + If timeout/pretimeout values are provided when the module loads, they
> + will take priority. Second priority will be the timeout-sec from DTB,
> + and third the hard-coded driver values.
The last two paragraphs should go. They describe Linux behaviour rather
than the binding.
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/