spi: Correct set_cs() documentation
authorGeert Uytterhoeven <geert+renesas@linux-m68k.org>
Tue, 21 Jan 2014 15:10:07 +0000 (16:10 +0100)
committerMark Brown <broonie@linaro.org>
Tue, 21 Jan 2014 18:11:49 +0000 (18:11 +0000)
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>
Signed-off-by: Mark Brown <broonie@linaro.org>
include/linux/spi/spi.h

index e766e0e2fe581af98026c95a3bad52e8806b9974..9f5242df9311e5cf12f3d182a4102d647a98fa4b 100644 (file)
@@ -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