From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:40693) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aaWsk-0003tD-V2 for qemu-devel@nongnu.org; Mon, 29 Feb 2016 18:05:40 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1aaWsj-00020t-LF for qemu-devel@nongnu.org; Mon, 29 Feb 2016 18:05:38 -0500 Received: from mail-oi0-x243.google.com ([2607:f8b0:4003:c06::243]:36504) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1aaWsj-00020Z-B5 for qemu-devel@nongnu.org; Mon, 29 Feb 2016 18:05:37 -0500 Received: by mail-oi0-x243.google.com with SMTP id k81so2371247oia.3 for ; Mon, 29 Feb 2016 15:05:37 -0800 (PST) MIME-Version: 1.0 Sender: alistair23@gmail.com In-Reply-To: References: <114f6c40eefdd9784a91c01d62565eabbc2b77e0.1455913505.git.alistair.francis@xilinx.com> From: Alistair Francis Date: Mon, 29 Feb 2016 15:05:07 -0800 Message-ID: Content-Type: text/plain; charset=UTF-8 Subject: Re: [Qemu-devel] [PATCH v3 2/2] docs: Add a generic loader explanation document List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: Peter Maydell Cc: Markus Armbruster , QEMU Developers , Peter Crosthwaite , Christopher Covington , Paolo Bonzini , Alistair Francis , =?UTF-8?Q?Andreas_F=C3=A4rber?= On Fri, Feb 26, 2016 at 7:59 AM, Peter Maydell wrote: > On 19 February 2016 at 20:40, Alistair Francis > wrote: >> Signed-off-by: Alistair Francis >> --- >> >> docs/generic-loader.txt | 21 +++++++++++++++++++++ >> 1 file changed, 21 insertions(+) >> create mode 100644 docs/generic-loader.txt >> >> diff --git a/docs/generic-loader.txt b/docs/generic-loader.txt >> new file mode 100644 >> index 0000000..69e262d >> --- /dev/null >> +++ b/docs/generic-loader.txt >> @@ -0,0 +1,21 @@ >> +Copyright (c) 2016 Xilinx Inc. >> + >> +This work is licensed under the terms of the GNU GPL, version 2 or later. See >> +the COPYING file in the top-level directory. >> + >> + >> +This loader allows the user to load multiple images or values into QEMU at startup. > > This is a bit confusing, because it's not entirely clear what > "this" is referring to. Something with a heading and then a > paragraph starting "The 'loader' device allows ..." might be > better. > >> + >> +Loading Memory Values >> +--------------------------- >> +Memory values can be loaded like this: >> + -device loader,addr=0xfd1a0104,data=0x8000000e,data-len=4 > > What values are permitted for data-len ? What endianness is > the data stored as? What address space is the data written to? > Is 'cpu=N' valid here as it is for the image loader syntax below? > >> + >> +Loading Images >> +--------------------------- >> +Images can be loaded like this: >> + -device loader,file=./images/boot.elf,cpu=0 >> + >> +The limiation for arch is based off settting the ELF_ARCH macro. > > I don't understand this sentence (also it has two typos in it :-)) > > >> + >> +At the moment only the ARM arhitectures are supported > > "architectures". Why is there an architecture limitation? Missing > full stop. > > Straightforward documentation of all possible options, followed > by examples, is probably a better way to structure this than > trying to describe it only by example. Agreed! I am re-writing it, it is now much more comprehensive. Thanks, Alistair > > thanks > -- PMM >