From: Michael Kelley <mhklinux@outlook.com>
To: Easwar Hariharan <eahariha@linux.microsoft.com>,
"haiyangz@microsoft.com" <haiyangz@microsoft.com>,
"wei.liu@kernel.org" <wei.liu@kernel.org>,
"decui@microsoft.com" <decui@microsoft.com>,
"kys@microsoft.com" <kys@microsoft.com>,
"corbet@lwn.net" <corbet@lwn.net>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
"linux-hyperv@vger.kernel.org" <linux-hyperv@vger.kernel.org>,
"linux-doc@vger.kernel.org" <linux-doc@vger.kernel.org>
Subject: RE: [PATCH 2/2] Documentation: hyperv: Improve synic and interrupt handling description
Date: Fri, 10 May 2024 18:21:00 +0000 [thread overview]
Message-ID: <SN6PR02MB415748967556A7BD7FD59738D4E72@SN6PR02MB4157.namprd02.prod.outlook.com> (raw)
In-Reply-To: <807443f4-2442-4925-becc-6eb20887acf6@linux.microsoft.com>
From: Easwar Hariharan <eahariha@linux.microsoft.com> Sent: Friday, May 10, 2024 10:55 AM
>
> On 5/7/2024 6:16 AM, mhkelley58@gmail.com wrote:
> > From: Michael Kelley <mhklinux@outlook.com>
> >
> > Current documentation does not describe how Linux handles the synthetic
> > interrupt controller (synic) that Hyper-V provides to guest VMs, nor how
> > VMBus or timer interrupts are handled. Add text describing the synic and
> > reorganize existing text to make this more clear.
> >
> > Signed-off-by: Michael Kelley <mhklinux@outlook.com>
> > ---
> > Documentation/virt/hyperv/clocks.rst | 21 +++++---
> > Documentation/virt/hyperv/vmbus.rst | 79 ++++++++++++++++++----------
> > 2 files changed, 66 insertions(+), 34 deletions(-)
> >
> > diff --git a/Documentation/virt/hyperv/clocks.rst b/Documentation/virt/hyperv/clocks.rst
> > index a56f4837d443..919bb92d6d9d 100644
> > --- a/Documentation/virt/hyperv/clocks.rst
> > +++ b/Documentation/virt/hyperv/clocks.rst
> > @@ -62,12 +62,21 @@ shared page with scale and offset values into user space. User
> > space code performs the same algorithm of reading the TSC and
> > applying the scale and offset to get the constant 10 MHz clock.
> >
> > -Linux clockevents are based on Hyper-V synthetic timer 0. While
> > -Hyper-V offers 4 synthetic timers for each CPU, Linux only uses
> > -timer 0. Interrupts from stimer0 are recorded on the "HVS" line in
> > -/proc/interrupts. Clockevents based on the virtualized PIT and
> > -local APIC timer also work, but the Hyper-V synthetic timer is
> > -preferred.
> > +Linux clockevents are based on Hyper-V synthetic timer 0 (stimer0).
> > +While Hyper-V offers 4 synthetic timers for each CPU, Linux only uses
> > +timer 0. In older versions of Hyper-V, an interrupt from stimer0
> > +results in a VMBus control message that is demultiplexed by
> > +vmbus_isr() as described in the VMBus documentation.
>
> Is VMBus documentation here referring to Documentation/virt/hyperv/vmbus.rst?
> If so, could you please add internal links with :ref:? See for example in
> Documentation/process/1.Intro.rst.
You are right. The reference is to vmbus.rst. I'll make it a link, though the
guidelines under "Cross-referencing" in "Using Sphinx for kernel documentation"
prefer just using the path to the documentation file with no special annotation
like :doc: or :ref:. So it would just be "Documentation/virt/hyperv/vmbus.rst".
I'll try this and make sure it comes out right.
Michael
> If referring to Microsoft documentation, please
> provide a permalink. Please do also look for other opportunities to cross-link within
> Documentation or to external resources.
>
> Thanks for the improvements!
>
> Easwar
next prev parent reply other threads:[~2024-05-10 18:21 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-07 13:16 [PATCH 1/2] Documentation: hyperv: Update spelling and fix typo mhkelley58
2024-05-07 13:16 ` [PATCH 2/2] Documentation: hyperv: Improve synic and interrupt handling description mhkelley58
2024-05-10 17:54 ` Easwar Hariharan
2024-05-10 18:21 ` Michael Kelley [this message]
2024-05-10 17:56 ` [PATCH 1/2] Documentation: hyperv: Update spelling and fix typo Easwar Hariharan
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=SN6PR02MB415748967556A7BD7FD59738D4E72@SN6PR02MB4157.namprd02.prod.outlook.com \
--to=mhklinux@outlook.com \
--cc=corbet@lwn.net \
--cc=decui@microsoft.com \
--cc=eahariha@linux.microsoft.com \
--cc=haiyangz@microsoft.com \
--cc=kys@microsoft.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hyperv@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=wei.liu@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).