From: Geert Uytterhoeven <geert@linux-m68k.org>
To: Mark Brown <broonie@kernel.org>
Cc: linux-spi@vger.kernel.org, linux-kernel@vger.kernel.org,
Geert Uytterhoeven <geert+renesas@linux-m68k.org>
Subject: [PATCH v2 3/5] spi: Correct set_cs() documentation
Date: Tue, 21 Jan 2014 16:10:07 +0100 [thread overview]
Message-ID: <1390317009-8292-3-git-send-email-geert@linux-m68k.org> (raw)
In-Reply-To: <1390317009-8292-1-git-send-email-geert@linux-m68k.org>
From: Geert Uytterhoeven <geert+renesas@linux-m68k.org>
The documentation for spi_master.set_cs() says:
assert or deassert chip select, true to assert
i.e. its "enable" parameter uses assertion-level logic.
This does not match the implementation of spi_set_cs(), which calls
spi_master.set_cs() with the wanted logic level of the chip select line,
which depends on the polarity of the chip select signal.
Correct the documentation to match the implementation.
Signed-off-by: Geert Uytterhoeven <geert+renesas@linux-m68k.org>
---
v2: Changed documentation instead of implementation
include/linux/spi/spi.h | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/include/linux/spi/spi.h b/include/linux/spi/spi.h
index ba69940a6515..a1d4ca290862 100644
--- a/include/linux/spi/spi.h
+++ b/include/linux/spi/spi.h
@@ -277,7 +277,7 @@ static inline void spi_unregister_driver(struct spi_driver *sdrv)
* @unprepare_transfer_hardware: there are currently no more messages on the
* queue so the subsystem notifies the driver that it may relax the
* hardware by issuing this call
- * @set_cs: assert or deassert chip select, true to assert. May be called
+ * @set_cs: set the logic level of the chip select line. May be called
* from interrupt context.
* @prepare_message: set up the controller to transfer a single message,
* for example doing DMA mapping. Called from threaded
--
1.7.9.5
next prev parent reply other threads:[~2014-01-21 15:10 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-01-21 15:10 [PATCH 1/5] spi: Spelling s/finised/finished/ Geert Uytterhoeven
[not found] ` <1390317009-8292-1-git-send-email-geert-Td1EMuHUCqxL1ZNQvxDV9g@public.gmane.org>
2014-01-21 15:10 ` [PATCH v2 2/5] spi: Clarify transfer_one() w.r.t. spi_finalize_current_transfer() Geert Uytterhoeven
[not found] ` <1390317009-8292-2-git-send-email-geert-Td1EMuHUCqxL1ZNQvxDV9g@public.gmane.org>
2014-01-21 18:12 ` Mark Brown
2014-01-21 15:10 ` [PATCH 5/5] spi: rspi: Document support for Renesas QSPI in Kconfig Geert Uytterhoeven
[not found] ` <1390317009-8292-5-git-send-email-geert-Td1EMuHUCqxL1ZNQvxDV9g@public.gmane.org>
2014-01-21 18:23 ` Mark Brown
2014-01-21 18:12 ` [PATCH 1/5] spi: Spelling s/finised/finished/ Mark Brown
2014-01-21 15:10 ` Geert Uytterhoeven [this message]
[not found] ` <1390317009-8292-3-git-send-email-geert-Td1EMuHUCqxL1ZNQvxDV9g@public.gmane.org>
2014-01-21 18:13 ` [PATCH v2 3/5] spi: Correct set_cs() documentation Mark Brown
2014-01-21 15:10 ` [PATCH 4/5] spi: Check that Quad/Dual is half duplex Geert Uytterhoeven
[not found] ` <1390317009-8292-4-git-send-email-geert-Td1EMuHUCqxL1ZNQvxDV9g@public.gmane.org>
2014-01-21 18:21 ` Mark Brown
2014-01-21 20:06 ` Geert Uytterhoeven
[not found] ` <CAMuHMdWW1EsHe0u0o8XZuG4AzPKRqKL7ET5Ac2NkbeLRfW_foQ-JsoAwUIsXosN+BqQ9rBEUg@public.gmane.org>
2014-01-22 19:19 ` Gerhard Sittig
[not found] ` <20140122191947.GQ20094-kDjWylLy9wD0K7fsECOQyeGNnDKD8DIp@public.gmane.org>
2014-01-22 20:26 ` Geert Uytterhoeven
2014-01-22 14:27 ` Geert Uytterhoeven
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=1390317009-8292-3-git-send-email-geert@linux-m68k.org \
--to=geert@linux-m68k.org \
--cc=broonie@kernel.org \
--cc=geert+renesas@linux-m68k.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-spi@vger.kernel.org \
/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;
as well as URLs for NNTP newsgroup(s).