On 27 February 2016 at 23:14, Peter Crosthwaite <crosthwaitepe...@gmail.com> wrote: > On Tue, Jan 19, 2016 at 9:53 AM, Peter Maydell <peter.mayd...@linaro.org> > wrote: >> Can we have a doc comment so we have something that defines what >> values data_swab accepts? (it's not just a bool). >> > > This is difficult to capture without writing to whole documentation > for load_elf. So here goes:
Thanks; a couple of typos below, but otherwise looks good. > /** load_elf: > * @filename: Path of ELF file > * @translate_fn: optional function to translate load addresses > * @translate_opaque: opaque data passed to @translate_fn > * @pentry: Populated with program entry point. Ignored if NULL. > * @lowaddr: Populated with lowest loaded address. Ignored if NULL. > * @highaddr: Populated with highest loaded address. Ignored if NULL. > * @bigendian: Expected ELF endianness. 0 for LE otherwise BE > * @elf_machine: Expected ELF machine type > * @clear_lsb: Set to mask off LSB of addresses (Some arch's use this Can we just write out "architectures" here? > for non-address data) > * @data_swab: Set to order of byte swapping for data. 0 for no swap, 1 > * for swapping bytes within halfwords, 2 for bytes within > * words and 3 for within doublewords. > * > * Load an ELF file's contents to the emulated systems address space. "system's" > * Clients may optionally specify a callback to perform address > * translations. @pentry, @lowaddr and @highaddr are optional pointers > * which will be populated with various load information. @bigendian and > * @elf_machine give the expected endianness and machine for the ELF the > * load will fail it the target ELF does not match. Some architectures "if" > * have some arch-specific behaviours that come into effect when their "architecture" > * particular values for @elf_machine are set. > */ thanks -- PMM
