This documentation is a high level overview to explain the basics
of Linux running as a guest on Hyper-V. The intent is to document
the forest, not the trees. The Hyper-V Top Level Functional Spec
provides conceptual material and API details for the core Hyper-V
hypervisor, and this documentation provides additional info on
how that functionality is applied to Linux. Also, there's no
public documentation on VMbus or the VMbus synthetic devices, so
this documentation helps fill that gap at a conceptual level. This
documentation is not API-level documentation, which can be seen
in the code and associated comments.

More topics will be added in future patches, including:

* Miscellaneous synthetic devices like KVP, timesync, VSS, etc.
* Virtual PCI support
* Isolated/Confidential VMs

If you think I'm missing a topic that fits into the overall
approach as described, feel free to suggest text, or let me
know and I can add it to my list.

Michael Kelley (3):
  Documentation: hyperv: Add overview of Hyper-V enlightenments
  Documentation: hyperv: Add overview of VMbus
  Documentation: hyperv: Add overview of clocks and timers

 Documentation/virt/hyperv/clocks.rst   |  73 ++++++++
 Documentation/virt/hyperv/index.rst    |  12 ++
 Documentation/virt/hyperv/overview.rst | 207 ++++++++++++++++++++++
 Documentation/virt/hyperv/vmbus.rst    | 303 +++++++++++++++++++++++++++++++++
 Documentation/virt/index.rst           |   1 +
 MAINTAINERS                            |   1 +
 6 files changed, 597 insertions(+)
 create mode 100644 Documentation/virt/hyperv/clocks.rst
 create mode 100644 Documentation/virt/hyperv/index.rst
 create mode 100644 Documentation/virt/hyperv/overview.rst
 create mode 100644 Documentation/virt/hyperv/vmbus.rst

-- 
1.8.3.1

On Tue, Jul 05, 2022 at 08:43:39AM -0700, Michael Kelley wrote:
> This documentation is a high level overview to explain the basics
> of Linux running as a guest on Hyper-V. The intent is to document
> the forest, not the trees. The Hyper-V Top Level Functional Spec
> provides conceptual material and API details for the core Hyper-V
> hypervisor, and this documentation provides additional info on
> how that functionality is applied to Linux. Also, there's no
> public documentation on VMbus or the VMbus synthetic devices, so
> this documentation helps fill that gap at a conceptual level. This
> documentation is not API-level documentation, which can be seen
> in the code and associated comments.
> 
> More topics will be added in future patches, including:
> 
> * Miscellaneous synthetic devices like KVP, timesync, VSS, etc.

There is an UIO driver for Hyper-V. I think that falls under this
category. Not sure if that's on your radar to cover?

Thanks,
Wei.

From: Wei Liu <wei.liu@kernel.org> Sent: Wednesday, July 6, 2022 11:12 AM
> 
> On Tue, Jul 05, 2022 at 08:43:39AM -0700, Michael Kelley wrote:
> > This documentation is a high level overview to explain the basics
> > of Linux running as a guest on Hyper-V. The intent is to document
> > the forest, not the trees. The Hyper-V Top Level Functional Spec
> > provides conceptual material and API details for the core Hyper-V
> > hypervisor, and this documentation provides additional info on
> > how that functionality is applied to Linux. Also, there's no
> > public documentation on VMbus or the VMbus synthetic devices, so
> > this documentation helps fill that gap at a conceptual level. This
> > documentation is not API-level documentation, which can be seen
> > in the code and associated comments.
> >
> > More topics will be added in future patches, including:
> >
> > * Miscellaneous synthetic devices like KVP, timesync, VSS, etc.
> 
> There is an UIO driver for Hyper-V. I think that falls under this
> category. Not sure if that's on your radar to cover?
> 

Good point.  I'll add it to my list. :-)

Michael