From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Ricardo Ribalda <ribalda@chromium.org>
Cc: Christoph Hellwig <hch@lst.de>,
Alan Stern <stern@rowland.harvard.edu>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Laurent Pinchart <laurent.pinchart@ideasonboard.com>,
Randy Dunlap <rdunlap@infradead.org>,
linux-usb@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2] USB: Improve usb_fill_* documentation
Date: Wed, 21 Dec 2022 09:44:07 +0700 [thread overview]
Message-ID: <Y6Jy90O38E25QgN6@debian.me> (raw)
In-Reply-To: <20221220-usb-dmadoc-v2-0-4dd4f198113e@chromium.org>
[-- Attachment #1: Type: text/plain, Size: 808 bytes --]
On Wed, Dec 21, 2022 at 12:13:08AM +0100, Ricardo Ribalda wrote:
> Make the developer aware of the requirements of transfer buffer.
>
> The buffer must be DMAble, if the developer uses an invalid buffer, data
> corruption might happen.
Better say:
```
Document the transfer buffer requirement. That is, the buffer must be
DMAble - otherwise data corruption might occur.
```
> - * @transfer_buffer: pointer to the transfer buffer
> + * @transfer_buffer: pointer to the transfer buffer. Must be suitable for DMA.
"... The buffer must be ..."
> - * @transfer_buffer: pointer to the transfer buffer
> + * @transfer_buffer: pointer to the transfer buffer. Must be suitable for DMA.
Same here.
The rest is LGTM, thanks.
--
An old man doll... just what I always wanted! - Clara
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]
next prev parent reply other threads:[~2022-12-21 2:44 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-12-20 23:13 Ricardo Ribalda
2022-12-20 23:15 ` Randy Dunlap
2022-12-21 2:44 ` Bagas Sanjaya [this message]
2022-12-21 2:47 ` Alan Stern
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=Y6Jy90O38E25QgN6@debian.me \
--to=bagasdotme@gmail.com \
--cc=gregkh@linuxfoundation.org \
--cc=hch@lst.de \
--cc=laurent.pinchart@ideasonboard.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=rdunlap@infradead.org \
--cc=ribalda@chromium.org \
--cc=stern@rowland.harvard.edu \
/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
all inboxes | Powered by JetHome®