From mboxrd@z Thu Jan 1 00:00:00 1970 From: "Gabriel L. Somlo" Subject: Re: [Qemu-devel] [PATCH v4 4/4] devicetree: update documentation for fw_cfg ARM bindings Date: Tue, 17 Nov 2015 21:17:27 -0500 Message-ID: <20151118021727.GA14351@GLSMBP.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> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Return-path: Content-Disposition: inline In-Reply-To: Sender: linux-api-owner-u79uwXL29TY76Z2rM5mHXA@public.gmane.org To: Rob Herring Cc: Paolo Bonzini , Greg Kroah-Hartman , Pawel Moll , Mark Rutland , Ian Campbell , Kumar Gala , Arnd Bergmann , Laszlo Ersek , Ralf Baechle , Russell King , Eric Anholt , Hanjun Guo , =?utf-8?B?UmFmYcWCIE1pxYJlY2tp?= , Sudeep Holla , Andy Gross , "linux-api-u79uwXL29TY76Z2rM5mHXA@public.gmane.org" , "linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org" , "devicetree-u79uwXL29TY76Z2rM5mHXA@public.gmane.org" , Peter Maydell , "matt.fleming-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org" , mst-H+wXaHxf7aLQT0dZR+AlfA@public.gmane.org, jordan.l.just List-Id: linux-api@vger.kernel.org On Tue, Nov 17, 2015 at 04:14:42PM -0600, Rob Herring wrote: > On Mon, Nov 16, 2015 at 2:38 AM, Paolo Bonzini 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? > > Perhaps QEMU is the right place to thoroughly describe this and DT and > sysfs docs can refer to it. So, leave only ARM/DT specifc details in Documentation/devicetree/bindings/arm/fw-cfg.txt, and rework the fw_cfg sysfs patch (1/4) to only document sysfs specific details in Documentation/ABI/testing/sysfs-firmware-qemu_fw_cfg ? The fw_cfg "datasheet" does exist in QEMU already, so there is something to point at from either/both of the above. Thanks, --Gabriel