lkml.org 
[lkml]   [2014]   [Jan]   [14]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH] spi: Clarify (a)synchronous transfer_one()
On Tue, Jan 14, 2014 at 12:34:56PM +0100, Geert Uytterhoeven wrote:

> + * @transfer_one: transfer a single spi_transfer.
> + * Synchronous transfer methods must return 0 on success.
> + * Asynchronous transfer methods must return a strict-positive
> + * value on successful submission, and must call
> + * spi_finalize_current_transfer() when the driver is finished
> + * so the subsystem can issue the next transfer

This is hard to understand, I'd not expect people not comfortable with
English to readily follow what it means. Things like "strict-positive"
aren't common outside of mathematics and I myself had to think what an
asynchronous transfer_one() meant. Something along the lines of "return
0 if the trasfer is finished or a positive number if the transfer is in
progress and finalize will be called later" would be more readily
comprehensible. If you're concerned about positive just specify 1.
[unhandled content-type:application/pgp-signature]
\
 
 \ /
  Last update: 2014-01-14 17:01    [W:0.030 / U:0.568 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site