Re: [Xen-devel] [PATCH] xen/arm: io: add function swap_mmio_handler()

[Stefano Stabellini <sstabellini@kernel.org>]

On Mon, 24 Jun 2019, Stefano Stabellini wrote:
> On Thu, 13 Jun 2019, chenbaodong wrote:
> > > > But currently i don't understand xen well, only a few weeks experience.
> > > 
> > > We do have small task for newcomers that would improve Xen code base and
> > > also allow your to understand more some part of the code.
> > > 
> > > If you have a specific area of interest, I can see if I have some small
> > > tasks there.
> > 
> > I'm happy with this.
> > 
> > Interested in arm platform for embedded and automotive use case.
> > 
> > things like in this link:
> > https://xenproject.org/developers/teams/embedded-and-automotive/
> 
> Hi Baodong,
> 
> Would you be up for a documentation task? Don't worry if the English is
> not perfect, it can easily be adjusted on commit, as long as the content
> is correct.
> 
> We have recently started an effort to write better documentation for all
> external Xen interfaces. I wrote a list of these interfaces that need
> documenting:
> 
> https://lists.xenproject.org/archives/html/xen-devel/2019-06/msg01111.html
> 
> 
> For instance, we are currently missing a document describing in details
> the device tree exposed to a DomU. You can see the code that builds such
> a device tree in tools/libxl//libxl_arm.c, for normal guests, and in
> xen/arch/arm/domain_build.c for dom0 and dom0less guests. From within a
> guest, you can see the devicetree by accessing /proc/device-tree (if the
> guest is Linux).
> 
> If you are up for it, it would be great to get that written down
> clearly. You could add to docs/misc/arm/device-tree/guest.txt, which is
> only describing the xen hypervisor node, but nothing else. Probably it
> would be better to rename docs/misc/arm/device-tree/guest.txt to
> docs/misc/arm/device-tree/hypervisor.txt and create a new
> docs/misc/arm/device-tree/guest.txt document with the description of all
> nodes exposed to domUs. You could point to the full description of each
> node to the binding under Linux. For instance, the binding for the Arm
> arch timer is described here:
> https://lists.xenproject.org/archives/html/xen-devel/2019-06/msg01111.html
> 
> Does it make sense?

Let me add that if you prefer to document one of the other interfaces
listed above in my email, you are welcome to pick another one. For
example, we are also missing a doc about the DomU memory map, listing
all memory regions with addresses and sizes, both MMIO and normal
memory. For that, most of the information is:

xen/include/public/arch-arm.h

A well written in-code comment in arch-arm.h would be OK, or also a
document under docs/misc/arm.

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel