Date: Wed, 18 Nov 2015 15:54:49 -0500
From: "Gabriel L. Somlo" <somlo@cmu.edu>
To: =?iso-8859-1?Q?Fran=E7ois?= Revol <revol@free.fr>
Cc: Rob Herring <robh@kernel.org>, Paolo Bonzini <pbonzini@redhat.com>,
        Mark Rutland <mark.rutland@arm.com>,
        Peter Maydell <peter.maydell@linaro.org>, mst@redhat.com,
        stefanha@gmail.com, QEMU Developers <qemu-devel@nongnu.org>,
        Eric Anholt <eric@anholt.net>, kraxel@redhat.com,
        "linux-api@vger.kernel.org" <linux-api@vger.kernel.org>,
        Andy Gross <agross@codeaurora.org>, Pawel Moll <pawel.moll@arm.com>,
        kernelnewbies@kernelnewbies.org,
        =?utf-8?B?UmFmYcWCIE1pxYJlY2tp?= <zajec5@gmail.com>,
        Russell King <rmk+kernel@arm.linux.org.uk>,
        Laszlo Ersek <lersek@redhat.com>,
        "devicetree@vger.kernel.org" <devicetree@vger.kernel.org>,
        Arnd Bergmann <arnd@arndb.de>,
        Ian Campbell <ijc+devicetree@hellion.org.uk>,
        jordan.l.justen@intel.com, Kumar Gala <galak@codeaurora.org>,
        Leif Lindholm <leif.lindholm@linaro.org>,
        "matt.fleming@intel.com" <matt.fleming@intel.com>,
        Ard Biesheuvel <ard.biesheuvel@linaro.org>,
        Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        Andy Lutomirski <luto@amacapital.net>,
        Hanjun Guo <hanjun.guo@linaro.org>,
        Sudeep Holla <sudeep.holla@arm.com>
Subject: Re: Re: [Qemu-devel] [PATCH v4 4/4] devicetree: update documentation
 for fw_cfg ARM bindings
Message-ID: <20151118205448.GD2109@HEDWIG.INI.CMU.EDU>
References: <1447470235-13643-1-git-send-email-somlo@cmu.edu>
 <1447470235-13643-5-git-send-email-somlo@cmu.edu>
 <20151115020754.GA21323@rob-hp-laptop>
 <564995FA.40308@redhat.com>
 <CAL_JsqKEi9BozyLQ9sKM3VL-hSSRntDyET859N1qTTMT4jkDOw@mail.gmail.com>
 <564C7758.6010103@free.fr>
MIME-Version: 1.0
Content-Type: text/plain; charset=iso-8859-1
Content-Disposition: inline
Content-Transfer-Encoding: 8bit
In-Reply-To: <564C7758.6010103@free.fr>
User-Agent: Mutt/1.5.24 (2015-08-30)
Sender: linux-kernel-owner@vger.kernel.org
Content-Length: 2505
Lines: 56

On Wed, Nov 18, 2015 at 02:04:24PM +0100, Fran?ois Revol wrote:
> On 17/11/2015 23:14, Rob Herring wrote:
> > On Mon, Nov 16, 2015 at 2:38 AM, Paolo Bonzini <pbonzini@redhat.com> wrote:
> >>
> >>
> >> On 15/11/2015 03:07, Rob Herring wrote:
> >>> We generally don't want DT docs to depend on other kernel documentation.
> >>
> >> DT docs do not contain a copy of the data sheets, either.  There is no
> >> reason to say how to use the device (and even then, only doing so
> >> partially) in the DT docs.
> > 
> > The difference is datasheets apply to all OS's, kernel documentation
> > does not. In theory at least this could be used for other OS's, right?
> 
> Would be nice indeed, as it's part of their intended purpose.
> 
> For now we have to shoehorn things into linux-only stuff (like initrd)
> because well, nobody cares enough about NetBSD to compile U-Boot with
> its internal API, so let alone adding custom Haiku code.
> 
> And of course, for things linux doesn't care about (like framebuffer
> description) then we're stuck trying to guess where it's at and writing
> drivers for our bootloader.
> 
> So if at least people were considering they aren't the only users of
> this, that'd make life better for everyone.
> 
> > Perhaps QEMU is the right place to thoroughly describe this and DT and
> > sysfs docs can refer to it.
> 
> The brilliant idea of FDT was that we could have a canonical source and
> blob for it where people could send patches, but of course Linux and BSD
> freaks disagreed, so you now find Linux-flavoured DTs for rPi and other
> things, as well as BSD versions.
> 
> Please, at least get the binding documentation for this unique and
> usable for everyone!

That would be 'docs/specs/fw_cfg.txt' in the QEMU source tree. I will
avoid cut'n'pasting anything from there into either the proposed
Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg (leaving only the
sysfs specific bits in there), and also remove any redundant bits from
Documentation/devicetree/bindings/arm/fw-cfg.txt.

I'm inclined to add (in v5) a mention of 'qemu:docs/specs/fw_cfg.txt'
to both the proposed fw_cfg sysfs doc file, and to the existing fw_cfg
arm/dt node doc file, unless I get strong objections against doing so... :)

Thanks,
--Gabriel
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/