Skip to content

Commit 8ee46db

Browse files
andy-shevbroonie
authored andcommitted
spi: bitbang: Add missing MODULE_DESCRIPTION()
The modpost script is not happy WARNING: modpost: missing MODULE_DESCRIPTION() in drivers/spi/spi-bitbang.o because there is a missing module description. Add it to the module. While at it, update the terminology in Kconfig section to be in align with added description along with the code comments. Signed-off-by: Andy Shevchenko <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Mark Brown <[email protected]>
1 parent 645094b commit 8ee46db

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

drivers/spi/Kconfig

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -226,11 +226,11 @@ config SPI_BCMBCA_HSSPI
226226
explicitly.
227227

228228
config SPI_BITBANG
229-
tristate "Utilities for Bitbanging SPI masters"
229+
tristate "Utilities for Bitbanging SPI host controllers"
230230
help
231231
With a few GPIO pins, your system can bitbang the SPI protocol.
232232
Select this to get SPI support through I/O pins (GPIO, parallel
233-
port, etc). Or, some systems' SPI master controller drivers use
233+
port, etc). Or, some systems' SPI host controller drivers use
234234
this code to manage the per-word or per-transfer accesses to the
235235
hardware shift registers.
236236

drivers/spi/spi-bitbang.c

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// SPDX-License-Identifier: GPL-2.0-or-later
22
/*
3-
* polling/bitbanging SPI master controller driver utilities
3+
* Polling/bitbanging SPI host controller controller driver utilities
44
*/
55

66
#include <linux/spinlock.h>
@@ -394,22 +394,22 @@ int spi_bitbang_init(struct spi_bitbang *bitbang)
394394
EXPORT_SYMBOL_GPL(spi_bitbang_init);
395395

396396
/**
397-
* spi_bitbang_start - start up a polled/bitbanging SPI master driver
397+
* spi_bitbang_start - start up a polled/bitbanging SPI host controller driver
398398
* @bitbang: driver handle
399399
*
400400
* Caller should have zero-initialized all parts of the structure, and then
401-
* provided callbacks for chip selection and I/O loops. If the master has
402-
* a transfer method, its final step should call spi_bitbang_transfer; or,
401+
* provided callbacks for chip selection and I/O loops. If the host controller has
402+
* a transfer method, its final step should call spi_bitbang_transfer(); or,
403403
* that's the default if the transfer routine is not initialized. It should
404404
* also set up the bus number and number of chipselects.
405405
*
406406
* For i/o loops, provide callbacks either per-word (for bitbanging, or for
407407
* hardware that basically exposes a shift register) or per-spi_transfer
408408
* (which takes better advantage of hardware like fifos or DMA engines).
409409
*
410-
* Drivers using per-word I/O loops should use (or call) spi_bitbang_setup,
411-
* spi_bitbang_cleanup and spi_bitbang_setup_transfer to handle those spi
412-
* master methods. Those methods are the defaults if the bitbang->txrx_bufs
410+
* Drivers using per-word I/O loops should use (or call) spi_bitbang_setup(),
411+
* spi_bitbang_cleanup() and spi_bitbang_setup_transfer() to handle those SPI
412+
* host controller methods. Those methods are the defaults if the bitbang->txrx_bufs
413413
* routine isn't initialized.
414414
*
415415
* This routine registers the spi_controller, which will process requests in a
@@ -418,7 +418,7 @@ EXPORT_SYMBOL_GPL(spi_bitbang_init);
418418
*
419419
* On success, this routine will take a reference to the controller. The caller
420420
* is responsible for calling spi_bitbang_stop() to decrement the reference and
421-
* spi_controller_put() as counterpart of spi_alloc_master() to prevent a memory
421+
* spi_controller_put() as counterpart of spi_alloc_host() to prevent a memory
422422
* leak.
423423
*/
424424
int spi_bitbang_start(struct spi_bitbang *bitbang)
@@ -451,4 +451,4 @@ void spi_bitbang_stop(struct spi_bitbang *bitbang)
451451
EXPORT_SYMBOL_GPL(spi_bitbang_stop);
452452

453453
MODULE_LICENSE("GPL");
454-
454+
MODULE_DESCRIPTION("Utilities for Bitbanging SPI host controllers");

0 commit comments

Comments
 (0)