Messages in this thread | | | Date | Wed, 21 Dec 2022 09:44:07 +0700 | From | Bagas Sanjaya <> | Subject | Re: [PATCH v2] USB: Improve usb_fill_* documentation |
| |
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 [unhandled content-type:application/pgp-signature] | |