[PATCH] Documentation/Intel-IOMMU.txt: Modify definition of DRHD

[PATCH] Documentation/Intel-IOMMU.txt: Modify definition of DRHD

[Nan Xiao]

Hi all,

According to "Intel Virtualization Technology for Directed I/O" specification,
DRHD stands for "DMA Remapping Hardware Unit Definition" , not "DMA
Engine Reporting Structure".

Signed-off-by: Nan Xiao <nan@chinadtrace.org>
---
 Documentation/Intel-IOMMU.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/Intel-IOMMU.txt b/Documentation/Intel-IOMMU.txt
index cf9431d..7b57fc0 100644
--- a/Documentation/Intel-IOMMU.txt
+++ b/Documentation/Intel-IOMMU.txt
@@ -10,7 +10,7 @@ This guide gives a quick cheat sheet for some basic
understanding.
 Some Keywords

 DMAR - DMA remapping
-DRHD - DMA Engine Reporting Structure
+DRHD - DMA Remapping Hardware Unit Definition
 RMRR - Reserved memory Region Reporting Structure
 ZLR  - Zero length reads from PCI devices
 IOVA - IO Virtual address.
-- 
2.4.3

Best Regards
Nan Xiao

[PATCH] Documentation/Intel-IOMMU.txt: Modify definition of DRHD

[Xiao, Nan (Nan@HPS Performance, Beijing)]

Hi David & Joerg,

According to "Intel Virtualization Technology for Directed I/O" specification,
DRHD stands for "DMA Remapping Hardware Unit Definition" , not "DMA Engine Reporting Structure".

Signed-off-by: Nan Xiao <nan.xiao-VXdhtT5mjnY@public.gmane.org>
---
 Documentation/Intel-IOMMU.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/Intel-IOMMU.txt b/Documentation/Intel-IOMMU.txt
index cf9431d..7b57fc0 100644
--- a/Documentation/Intel-IOMMU.txt
+++ b/Documentation/Intel-IOMMU.txt
@@ -10,7 +10,7 @@ This guide gives a quick cheat sheet for some basic understanding.
 Some Keywords
 
 DMAR - DMA remapping
-DRHD - DMA Engine Reporting Structure
+DRHD - DMA Remapping Hardware Unit Definition
 RMRR - Reserved memory Region Reporting Structure
 ZLR  - Zero length reads from PCI devices
 IOVA - IO Virtual address.
-- 
2.4.3


Best Regards
Nan Xiao

Re: [PATCH] Documentation/Intel-IOMMU.txt: Modify definition of DRHD

[Jonathan Corbet]

On Thu, 20 Aug 2015 18:17:10 +0800
Nan Xiao <xiaonan830818@gmail.com> wrote:

> According to "Intel Virtualization Technology for Directed I/O" specification,
> DRHD stands for "DMA Remapping Hardware Unit Definition" , not "DMA
> Engine Reporting Structure".

Applied to the docs tree, thanks.

Note that this patch was line-wrapped by your mail client and required
manual fixing; please configure your client to not do that
(Documentation/email-clients.txt can be helpful) before sending any
further patches.

jon

Re: [PATCH] Documentation/Intel-IOMMU.txt: Modify definition of DRHD

[Nan Xiao]

Hi Jonathan,

Got it, thanks very much!
Best Regards
Nan Xiao


On Tue, Aug 25, 2015 at 1:41 AM, Jonathan Corbet <corbet@lwn.net> wrote:
> On Thu, 20 Aug 2015 18:17:10 +0800
> Nan Xiao <xiaonan830818@gmail.com> wrote:
>
>> According to "Intel Virtualization Technology for Directed I/O" specification,
>> DRHD stands for "DMA Remapping Hardware Unit Definition" , not "DMA
>> Engine Reporting Structure".
>
> Applied to the docs tree, thanks.
>
> Note that this patch was line-wrapped by your mail client and required
> manual fixing; please configure your client to not do that
> (Documentation/email-clients.txt can be helpful) before sending any
> further patches.
>
> jon

Re: [PATCH] Documentation/Intel-IOMMU.txt: Modify definition of DRHD

[joro-zLv9SwRftAIdnm+yROfE0A]

Hi Nan,

I applied this patch with some formatting fixes, thanks. Details below:

From: "Xiao, Nan (Nan@HPS Performance, Beijing)" <nan.xiao-VXdhtT5mjnY@public.gmane.org>

git-am made this author-line out of your patch: "(Nan@HPS <(Nan@HPS>"

Which doesn't even look like a valid email address. I fixed it, but
please include a From: line in your future patches like this:

From: Xiao, Nan <nan.xiao-VXdhtT5mjnY@public.gmane.org>

This will guarantee that your patches will be accounted correctly.

Next is the patch subject. For iommu patches please use a prefix like
this: <arch>/<iommu>

In case of Intel VT-d this would look like "iommu/vt-d:", and my updated
subject line looks like:

Subject: x86/vt-d: Fix documentation of DRHD

On Mon, Aug 24, 2015 at 06:22:42AM +0000, Xiao, Nan (Nan@HPS Performance, Beijing) wrote:
> According to "Intel Virtualization Technology for Directed I/O" specification,
> DRHD stands for "DMA Remapping Hardware Unit Definition" , not "DMA Engine Reporting Structure".

These lines are too long. Please try to limit the line-length in patches
to 60 characters for iommu patches.


Thanks,

	Joerg

RE: [PATCH] Documentation/Intel-IOMMU.txt: Modify definition of DRHD

[Xiao, Nan (Nan@HPservers-Core-OE-PSC)]

Hi Joerg,

Firstly, thanks very much for your detailed comments!

I first send this patch to linux-kernel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org only (the result of get_maintainer.pl ), but after about 3
days, there is no any responses. I thought no one would notice this bug, so I resend the patch to you. But this
morning, Jonathan confirmed he has merged the patch (https://lkml.org/lkml/2015/8/24/637) , so I think maybe 
there is no need for you to merge it again.

I am very sorry for not updating the information immediately! Thanks for your understanding!

Best Regards
Nan Xiao

-----Original Message-----
From: joro-zLv9SwRftAIdnm+yROfE0A@public.gmane.org [mailto:joro-zLv9SwRftAIdnm+yROfE0A@public.gmane.org] 
Sent: Tuesday, August 25, 2015 4:52 PM
To: Xiao, Nan (Nan@HPservers-Core-OE-PSC)
Cc: dwmw2-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org; iommu-cunTk1MwBs9QetFLy7KEm3xJsTq8ys+cHZ5vskTnxNA@public.gmane.org
Subject: Re: [PATCH] Documentation/Intel-IOMMU.txt: Modify definition of DRHD

Hi Nan,

I applied this patch with some formatting fixes, thanks. Details below:

From: "Xiao, Nan (Nan@HPS Performance, Beijing)" <nan.xiao-VXdhtT5mjnY@public.gmane.org>

git-am made this author-line out of your patch: "(Nan@HPS <(Nan@HPS>"

Which doesn't even look like a valid email address. I fixed it, but please include a From: line in your future patches like this:

From: Xiao, Nan <nan.xiao-VXdhtT5mjnY@public.gmane.org>

This will guarantee that your patches will be accounted correctly.

Next is the patch subject. For iommu patches please use a prefix like
this: <arch>/<iommu>

In case of Intel VT-d this would look like "iommu/vt-d:", and my updated subject line looks like:

Subject: x86/vt-d: Fix documentation of DRHD

On Mon, Aug 24, 2015 at 06:22:42AM +0000, Xiao, Nan (Nan@HPS Performance, Beijing) wrote:
> According to "Intel Virtualization Technology for Directed I/O" 
> specification, DRHD stands for "DMA Remapping Hardware Unit Definition" , not "DMA Engine Reporting Structure".

These lines are too long. Please try to limit the line-length in patches to 60 characters for iommu patches.


Thanks,

	Joerg