diff mbox

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

Message ID 1abe062855111800754477d1340635b5a69d5635.1390552232.git.baruch@tkos.co.il (mailing list archive)
State Changes Requested
Headers show

Commit Message

Baruch Siach Jan. 24, 2014, 8:36 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, 8:47 a.m. UTC | #1
On Fri, Jan 24, 2014 at 9:36 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, the generic subsystem does
> +       not call your transfer_one callback.

You still forgot the updates I made in
http://lkml.indiana.edu/hypermail/linux/kernel/1401.2/02465.html

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:49 a.m. UTC | #2
Hi Geert,

On Fri, Jan 24, 2014 at 09:47:10AM +0100, Geert Uytterhoeven wrote:
> On Fri, Jan 24, 2014 at 9:36 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, the generic subsystem does
> > +       not call your transfer_one callback.
> 
> You still forgot the updates I made in
> http://lkml.indiana.edu/hypermail/linux/kernel/1401.2/02465.html

AFAICS, your patch touches spi.h, not spi-summary. Am I missing something 
here?

baruch
Geert Uytterhoeven Jan. 24, 2014, 8:57 a.m. UTC | #3
On Fri, Jan 24, 2014 at 9:49 AM, Baruch Siach <baruch@tkos.co.il> wrote:
>> > +    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, the generic subsystem does
>> > +       not call your transfer_one callback.
>>
>> You still forgot the updates I made in
>> http://lkml.indiana.edu/hypermail/linux/kernel/1401.2/02465.html
>
> AFAICS, your patch touches spi.h, not spi-summary. Am I missing something
> here?

I think the description in spi-summary should be updated to match the
changes to spi.h.

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, 9:08 a.m. UTC | #4
Hi Geert,

On Fri, Jan 24, 2014 at 09:57:38AM +0100, Geert Uytterhoeven wrote:
> On Fri, Jan 24, 2014 at 9:49 AM, Baruch Siach <baruch@tkos.co.il> wrote:
> >> > +    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, the generic subsystem does
> >> > +       not call your transfer_one callback.
> >>
> >> You still forgot the updates I made in
> >> http://lkml.indiana.edu/hypermail/linux/kernel/1401.2/02465.html
> >
> > AFAICS, your patch touches spi.h, not spi-summary. Am I missing something
> > here?
> 
> I think the description in spi-summary should be updated to match the
> changes to spi.h.

OK. Will do.

baruch
diff mbox

Patch

diff --git a/Documentation/spi/spi-summary b/Documentation/spi/spi-summary
index f21edb983413..735acbf1ce0c 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, the generic subsystem does
+	not call your transfer_one callback.
+
     DEPRECATED METHODS
 
     master->transfer(struct spi_device *spi, struct spi_message *message)