From: "Dey, Megha" <megha.dey@linux.intel.com>
To: Jason Gunthorpe <jgg@ziepe.ca>
Cc: Dave Jiang <dave.jiang@intel.com>,
vkoul@kernel.org, maz@kernel.org, bhelgaas@google.com,
rafael@kernel.org, gregkh@linuxfoundation.org,
tglx@linutronix.de, hpa@zytor.com, alex.williamson@redhat.com,
jacob.jun.pan@intel.com, ashok.raj@intel.com, yi.l.liu@intel.com,
baolu.lu@intel.com, kevin.tian@intel.com,
sanjay.k.kumar@intel.com, tony.luck@intel.com,
jing.lin@intel.com, dan.j.williams@intel.com,
kwankhede@nvidia.com, eric.auger@redhat.com, parav@mellanox.com,
dmaengine@vger.kernel.org, linux-kernel@vger.kernel.org,
x86@kernel.org, linux-pci@vger.kernel.org, kvm@vger.kernel.org
Subject: Re: [PATCH RFC 07/15] Documentation: Interrupt Message store
Date: Sun, 3 May 2020 15:41:55 -0700 [thread overview]
Message-ID: <e8788adb-6993-2885-d91b-1541fbff02f4@linux.intel.com> (raw)
In-Reply-To: <20200503222855.GT26002@ziepe.ca>
On 5/3/2020 3:28 PM, Jason Gunthorpe wrote:
> On Fri, May 01, 2020 at 03:32:22PM -0700, Dey, Megha wrote:
>> Hi Jason,
>>
>> On 4/23/2020 1:04 PM, Jason Gunthorpe wrote:
>>> On Tue, Apr 21, 2020 at 04:34:30PM -0700, Dave Jiang wrote:
>>>
>>>> diff --git a/Documentation/ims-howto.rst b/Documentation/ims-howto.rst
>>>> new file mode 100644
>>>> index 000000000000..a18de152b393
>>>> +++ b/Documentation/ims-howto.rst
>>>> @@ -0,0 +1,210 @@
>>>> +.. SPDX-License-Identifier: GPL-2.0
>>>> +.. include:: <isonum.txt>
>>>> +
>>>> +==========================
>>>> +The IMS Driver Guide HOWTO
>>>> +==========================
>>>> +
>>>> +:Authors: Megha Dey
>>>> +
>>>> +:Copyright: 2020 Intel Corporation
>>>> +
>>>> +About this guide
>>>> +================
>>>> +
>>>> +This guide describes the basics of Interrupt Message Store (IMS), the
>>>> +need to introduce a new interrupt mechanism, implementation details of
>>>> +IMS in the kernel, driver changes required to support IMS and the general
>>>> +misconceptions and FAQs associated with IMS.
>>>
>>> I'm not sure why we need to call this IMS in kernel documentat? I know
>>> Intel is using this term, but this document is really only talking
>>> about extending the existing platform_msi stuff, which looks pretty
>>> good actually.
>>
>> hmmm, so maybe we call it something else or just say dynamic platform-msi?
>>
>>>
>>> A lot of this is good for the cover letter..
>>
>> Well, I got a lot of comments internally and externally about how the cover
>> page needs to have just the basics and all the ugly details can go in the
>> Documentation. So well, I am confused here.
>
> Documentation should be documentation for users and developers.
>
> Justification and rational for why functionality should be merged
> belong in the commit message and cover letter, IMHO.
>
> Here too much time is spent belabouring IMS's rational and not enough
> is spent explaining how a driver should consume it or how a platform
> should provide it.
>
> And since most of this tightly related to platform-msi it might make
> sense to start by documenting platform msi then adding a diff on that
> to explain what change is being made to accommodate IMS.
>
> Most likely few people are very familiar with platform-msi in the
> first place..
Ok makes sense, will rework this in the next version..
>
> Jason
>
next prev parent reply other threads:[~2020-05-03 22:42 UTC|newest]
Thread overview: 89+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-04-21 23:33 [PATCH RFC 00/15] Add VFIO mediated device support and IMS support for the idxd driver Dave Jiang
2020-04-21 23:33 ` [PATCH RFC 01/15] drivers/base: Introduce platform_msi_ops Dave Jiang
2020-04-26 7:01 ` Greg KH
2020-04-27 21:38 ` Dave Jiang
2020-04-28 7:34 ` Greg KH
2020-04-21 23:33 ` [PATCH RFC 02/15] drivers/base: Introduce a new platform-msi list Dave Jiang
2020-04-25 21:13 ` Thomas Gleixner
2020-05-04 0:08 ` Dey, Megha
2020-04-21 23:34 ` [PATCH RFC 03/15] drivers/base: Allocate/free platform-msi interrupts by group Dave Jiang
2020-04-25 21:23 ` Thomas Gleixner
2020-05-04 0:08 ` Dey, Megha
2020-04-21 23:34 ` [PATCH RFC 04/15] drivers/base: Add support for a new IMS irq domain Dave Jiang
2020-04-23 20:11 ` Jason Gunthorpe
2020-05-01 22:30 ` Dey, Megha
2020-05-03 22:25 ` Jason Gunthorpe
2020-05-03 22:40 ` Dey, Megha
2020-05-03 22:46 ` Jason Gunthorpe
2020-05-04 0:25 ` Dey, Megha
2020-05-04 12:14 ` Jason Gunthorpe
2020-05-06 10:27 ` Tian, Kevin
2020-04-25 21:38 ` Thomas Gleixner
2020-05-04 0:11 ` Dey, Megha
2020-04-21 23:34 ` [PATCH RFC 05/15] ims-msi: Add mask/unmask routines Dave Jiang
2020-04-25 21:49 ` Thomas Gleixner
2020-05-04 0:16 ` Dey, Megha
2020-04-21 23:34 ` [PATCH RFC 06/15] ims-msi: Enable IMS interrupts Dave Jiang
2020-04-25 22:13 ` Thomas Gleixner
2020-05-04 0:17 ` Dey, Megha
2020-04-21 23:34 ` [PATCH RFC 07/15] Documentation: Interrupt Message store Dave Jiang
2020-04-23 20:04 ` Jason Gunthorpe
2020-05-01 22:32 ` Dey, Megha
2020-05-03 22:28 ` Jason Gunthorpe
2020-05-03 22:41 ` Dey, Megha [this message]
2020-04-21 23:34 ` [PATCH RFC 08/15] vfio/mdev: Add a member for iommu domain in mdev_device Dave Jiang
2020-04-21 23:34 ` [PATCH RFC 09/15] vfio/type1: Save domain when attach domain to mdev Dave Jiang
2020-04-21 23:34 ` [PATCH RFC 10/15] dmaengine: idxd: add config support for readonly devices Dave Jiang
2020-04-21 23:34 ` [PATCH RFC 11/15] dmaengine: idxd: add IMS support in base driver Dave Jiang
2020-04-21 23:35 ` [PATCH RFC 12/15] dmaengine: idxd: add device support functions in prep for mdev Dave Jiang
2020-04-21 23:35 ` [PATCH RFC 13/15] dmaengine: idxd: add support for VFIO mediated device Dave Jiang
2020-04-21 23:35 ` [PATCH RFC 14/15] dmaengine: idxd: add error notification from host driver to " Dave Jiang
2020-04-21 23:35 ` [PATCH RFC 15/15] dmaengine: idxd: add ABI documentation for mediated device support Dave Jiang
2020-04-21 23:54 ` [PATCH RFC 00/15] Add VFIO mediated device support and IMS support for the idxd driver Jason Gunthorpe
2020-04-22 0:53 ` Tian, Kevin
2020-04-22 11:50 ` Jason Gunthorpe
2020-04-22 21:14 ` Raj, Ashok
2020-04-23 19:12 ` Jason Gunthorpe
2020-04-24 3:27 ` Tian, Kevin
2020-04-24 12:44 ` Jason Gunthorpe
2020-04-24 16:25 ` Tian, Kevin
2020-04-24 18:12 ` Jason Gunthorpe
2020-04-26 5:18 ` Tian, Kevin
2020-04-26 19:13 ` Jason Gunthorpe
2020-04-27 3:43 ` Alex Williamson
2020-04-27 11:58 ` Jason Gunthorpe
2020-04-27 13:19 ` Alex Williamson
2020-04-27 13:22 ` Jason Gunthorpe
2020-04-27 14:18 ` Alex Williamson
2020-04-27 14:25 ` Jason Gunthorpe
2020-04-27 15:41 ` Alex Williamson
2020-04-27 16:16 ` Jason Gunthorpe
2020-04-27 16:25 ` Dave Jiang
2020-04-27 21:56 ` Jason Gunthorpe
2020-04-29 9:42 ` Tian, Kevin
2020-05-08 20:47 ` Raj, Ashok
2020-05-08 23:16 ` Jason Gunthorpe
2020-05-08 23:52 ` Dave Jiang
2020-05-09 0:09 ` Raj, Ashok
2020-05-09 12:21 ` Jason Gunthorpe
2020-05-13 2:29 ` Jason Wang
2020-05-13 8:30 ` Tian, Kevin
2020-05-13 12:40 ` Jason Gunthorpe
2020-04-27 12:13 ` Tian, Kevin
2020-04-27 12:55 ` Jason Gunthorpe
2020-04-22 21:24 ` Dan Williams
2020-04-23 19:17 ` Dan Williams
2020-04-23 19:49 ` Jason Gunthorpe
2020-05-01 22:31 ` Dey, Megha
2020-05-03 22:21 ` Jason Gunthorpe
2020-05-03 22:32 ` Dey, Megha
2020-04-23 19:18 ` Jason Gunthorpe
2020-05-01 22:31 ` Dey, Megha
2020-05-03 22:22 ` Jason Gunthorpe
2020-05-03 22:31 ` Dey, Megha
2020-05-03 22:36 ` Jason Gunthorpe
2020-05-04 0:20 ` Dey, Megha
2020-04-22 23:04 ` Dey, Megha
2020-04-23 19:44 ` Jason Gunthorpe
2020-05-01 22:32 ` Dey, Megha
2020-04-24 6:31 ` Jason Wang
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=e8788adb-6993-2885-d91b-1541fbff02f4@linux.intel.com \
--to=megha.dey@linux.intel.com \
--cc=alex.williamson@redhat.com \
--cc=ashok.raj@intel.com \
--cc=baolu.lu@intel.com \
--cc=bhelgaas@google.com \
--cc=dan.j.williams@intel.com \
--cc=dave.jiang@intel.com \
--cc=dmaengine@vger.kernel.org \
--cc=eric.auger@redhat.com \
--cc=gregkh@linuxfoundation.org \
--cc=hpa@zytor.com \
--cc=jacob.jun.pan@intel.com \
--cc=jgg@ziepe.ca \
--cc=jing.lin@intel.com \
--cc=kevin.tian@intel.com \
--cc=kvm@vger.kernel.org \
--cc=kwankhede@nvidia.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pci@vger.kernel.org \
--cc=maz@kernel.org \
--cc=parav@mellanox.com \
--cc=rafael@kernel.org \
--cc=sanjay.k.kumar@intel.com \
--cc=tglx@linutronix.de \
--cc=tony.luck@intel.com \
--cc=vkoul@kernel.org \
--cc=x86@kernel.org \
--cc=yi.l.liu@intel.com \
/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 NNTP newsgroup(s).