xen/public: Document HYPERCALL_console_io()
authorJulien Grall <julien.grall@arm.com>
Fri, 1 Mar 2019 15:39:21 +0000 (15:39 +0000)
committerJulien Grall <julien.grall@arm.com>
Fri, 16 Aug 2019 21:44:31 +0000 (22:44 +0100)
commit61f82e8dfd1a37b432ee227caaae354c2abe02b5
tree4b7f831f20908f044a1924ed310831e7e50ec0e0
parentea601ec9995b56fc23130360269844e188441b45
xen/public: Document HYPERCALL_console_io()

Currently, OS developpers will have to look at Xen code in order to know
the parameters of an hypercall and how it is meant to work.

This is not a trivial task as you may need to have a deep understanding
of Xen internal.

This patch attempts to document the behavior of HYPERCALL_console_io() to
help OS developer.

Signed-off-by: Julien Grall <julien.grall@arm.com>
Acked-by: Jan Beulich <jbeulich@suse.com>
xen/include/public/xen.h