diff mbox

[2/3] Doc: spi: document the transfer_one spi_master callback

Message ID 8b6ee8b5a08cd9fa9a94d16d2621e28b4f087098.1390544495.git.baruch@tkos.co.il (mailing list archive)
State Changes Requested
Headers show

Commit Message

Baruch Siach Jan. 24, 2014, 6:28 a.m. UTC
Signed-off-by: Baruch Siach <baruch@tkos.co.il>
---
 Documentation/spi/spi-summary | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Geert Uytterhoeven Jan. 24, 2014, 7:49 a.m. UTC | #1
On Fri, Jan 24, 2014 at 7:28 AM, Baruch Siach <baruch@tkos.co.il> wrote:
> +++ b/Documentation/spi/spi-summary
> @@ -545,6 +545,16 @@ SPI MASTER METHODS
>         spi_finalize_current_message() so the subsystem can issue the next
>         transfer. This may sleep.
>
> +    master->transfer_one(struct spi_master *master, struct spi_device *spi,
> +                        struct spi_transfer *transfer)
> +       The subsystem calls the driver to transfer a single transfer while
> +       queuing transfers that arrive in the meantime. When the driver is
> +       finished with this message, it must call
> +       spi_finalize_current_transfer() so the subsystem can issue the next
> +       transfer. This may sleep. Note: transfer_one and transfer_one_message
> +       are mutually exclusive; when both are set, transfer_one takes
> +       precedence.
> +

Can you please take into account
http://lkml.indiana.edu/hypermail/linux/kernel/1401.2/02465.html?

Thanks!

Gr{oetje,eeting}s,

                        Geert

--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds
--
To unsubscribe from this list: send the line "unsubscribe linux-spi" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Baruch Siach Jan. 24, 2014, 8:02 a.m. UTC | #2
Hi Geert,

On Fri, Jan 24, 2014 at 08:49:02AM +0100, Geert Uytterhoeven wrote:
> On Fri, Jan 24, 2014 at 7:28 AM, Baruch Siach <baruch@tkos.co.il> wrote:
> > +++ b/Documentation/spi/spi-summary
> > @@ -545,6 +545,16 @@ SPI MASTER METHODS
> >         spi_finalize_current_message() so the subsystem can issue the next
> >         transfer. This may sleep.
> >
> > +    master->transfer_one(struct spi_master *master, struct spi_device *spi,
> > +                        struct spi_transfer *transfer)
> > +       The subsystem calls the driver to transfer a single transfer while
> > +       queuing transfers that arrive in the meantime. When the driver is
> > +       finished with this message, it must call
> > +       spi_finalize_current_transfer() so the subsystem can issue the next
> > +       transfer. This may sleep. Note: transfer_one and transfer_one_message
> > +       are mutually exclusive; when both are set, transfer_one takes
> > +       precedence.
> > +
> 
> Can you please take into account
> http://lkml.indiana.edu/hypermail/linux/kernel/1401.2/02465.html?

Thanks for reviewing. I'll rebase on Mark's fix/core branch.

baruch
Gerhard Sittig Jan. 24, 2014, 1:45 p.m. UTC | #3
On Fri, Jan 24, 2014 at 08:28 +0200, Baruch Siach wrote:
> 
> --- a/Documentation/spi/spi-summary
> +++ b/Documentation/spi/spi-summary
> @@ -545,6 +545,16 @@ SPI MASTER METHODS
>  	spi_finalize_current_message() so the subsystem can issue the next
>  	transfer. This may sleep.
>  
> +    master->transfer_one(struct spi_master *master, struct spi_device *spi,
> +			 struct spi_transfer *transfer)
> +	The subsystem calls the driver to transfer a single transfer while
> +	queuing transfers that arrive in the meantime. When the driver is
> +	finished with this message, it must call
                           ^^^^^^^ transfer?
> +	spi_finalize_current_transfer() so the subsystem can issue the next
> +	transfer. This may sleep. Note: transfer_one and transfer_one_message
> +	are mutually exclusive; when both are set, transfer_one takes
> +	precedence.
> +
>      DEPRECATED METHODS


virtually yours
Gerhard Sittig
Baruch Siach Jan. 25, 2014, 6:52 p.m. UTC | #4
Hi Gerhard,

On Fri, Jan 24, 2014 at 02:45:17PM +0100, Gerhard Sittig wrote:
> On Fri, Jan 24, 2014 at 08:28 +0200, Baruch Siach wrote:
> > 
> > --- a/Documentation/spi/spi-summary
> > +++ b/Documentation/spi/spi-summary
> > @@ -545,6 +545,16 @@ SPI MASTER METHODS
> >  	spi_finalize_current_message() so the subsystem can issue the next
> >  	transfer. This may sleep.
> >  
> > +    master->transfer_one(struct spi_master *master, struct spi_device *spi,
> > +			 struct spi_transfer *transfer)
> > +	The subsystem calls the driver to transfer a single transfer while
> > +	queuing transfers that arrive in the meantime. When the driver is
> > +	finished with this message, it must call
>                            ^^^^^^^ transfer?

Right. Will fix.

Thanks,
baruch

> > +	spi_finalize_current_transfer() so the subsystem can issue the next
> > +	transfer. This may sleep. Note: transfer_one and transfer_one_message
> > +	are mutually exclusive; when both are set, transfer_one takes
> > +	precedence.
> > +
> >      DEPRECATED METHODS
diff mbox

Patch

diff --git a/Documentation/spi/spi-summary b/Documentation/spi/spi-summary
index f21edb983413..6bd55b9473ca 100644
--- a/Documentation/spi/spi-summary
+++ b/Documentation/spi/spi-summary
@@ -545,6 +545,16 @@  SPI MASTER METHODS
 	spi_finalize_current_message() so the subsystem can issue the next
 	transfer. This may sleep.
 
+    master->transfer_one(struct spi_master *master, struct spi_device *spi,
+			 struct spi_transfer *transfer)
+	The subsystem calls the driver to transfer a single transfer while
+	queuing transfers that arrive in the meantime. When the driver is
+	finished with this message, it must call
+	spi_finalize_current_transfer() so the subsystem can issue the next
+	transfer. This may sleep. Note: transfer_one and transfer_one_message
+	are mutually exclusive; when both are set, transfer_one takes
+	precedence.
+
     DEPRECATED METHODS
 
     master->transfer(struct spi_device *spi, struct spi_message *message)