Unverified Commit 8ee46db1 authored by Andy Shevchenko's avatar Andy Shevchenko Committed by Mark Brown
Browse files

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: default avatarAndy Shevchenko <andriy.shevchenko@linux.intel.com>
Link: https://lore.kernel.org/r/20240502171518.2792895-1-andriy.shevchenko@linux.intel.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 645094b4

drivers/spi/Kconfig

+2 −2
Original line number Diff line number Diff line
@@ -226,11 +226,11 @@ config SPI_BCMBCA_HSSPI 
	  explicitly.



config SPI_BITBANG

	tristate "Utilities for Bitbanging SPI masters"

	tristate "Utilities for Bitbanging SPI host controllers"

	help

	  With a few GPIO pins, your system can bitbang the SPI protocol.

	  Select this to get SPI support through I/O pins (GPIO, parallel

	  port, etc).  Or, some systems' SPI master controller drivers use

	  port, etc).  Or, some systems' SPI host controller drivers use

	  this code to manage the per-word or per-transfer accesses to the

	  hardware shift registers.

drivers/spi/spi-bitbang.c

+9 −9
Original line number Diff line number Diff line 
// SPDX-License-Identifier: GPL-2.0-or-later

/*

 * polling/bitbanging SPI master controller driver utilities

 * Polling/bitbanging SPI host controller controller driver utilities

 */



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



/**

 * spi_bitbang_start - start up a polled/bitbanging SPI master driver

 * spi_bitbang_start - start up a polled/bitbanging SPI host controller driver

 * @bitbang: driver handle

 *

 * Caller should have zero-initialized all parts of the structure, and then

 * provided callbacks for chip selection and I/O loops.  If the master has

 * a transfer method, its final step should call spi_bitbang_transfer; or,

 * provided callbacks for chip selection and I/O loops.  If the host controller has

 * a transfer method, its final step should call spi_bitbang_transfer(); or,

 * that's the default if the transfer routine is not initialized.  It should

 * also set up the bus number and number of chipselects.

 *
@@ -407,9 +407,9 @@ EXPORT_SYMBOL_GPL(spi_bitbang_init); 
 * hardware that basically exposes a shift register) or per-spi_transfer

 * (which takes better advantage of hardware like fifos or DMA engines).

 *

 * Drivers using per-word I/O loops should use (or call) spi_bitbang_setup,

 * spi_bitbang_cleanup and spi_bitbang_setup_transfer to handle those spi

 * master methods.  Those methods are the defaults if the bitbang->txrx_bufs

 * Drivers using per-word I/O loops should use (or call) spi_bitbang_setup(),

 * spi_bitbang_cleanup() and spi_bitbang_setup_transfer() to handle those SPI

 * host controller methods.  Those methods are the defaults if the bitbang->txrx_bufs

 * routine isn't initialized.

 *

 * This routine registers the spi_controller, which will process requests in a
@@ -418,7 +418,7 @@ EXPORT_SYMBOL_GPL(spi_bitbang_init); 
 *

 * On success, this routine will take a reference to the controller. The caller

 * is responsible for calling spi_bitbang_stop() to decrement the reference and

 * spi_controller_put() as counterpart of spi_alloc_master() to prevent a memory

 * spi_controller_put() as counterpart of spi_alloc_host() to prevent a memory

 * leak.

 */

int spi_bitbang_start(struct spi_bitbang *bitbang)
@@ -451,4 +451,4 @@ void spi_bitbang_stop(struct spi_bitbang *bitbang) 
EXPORT_SYMBOL_GPL(spi_bitbang_stop);



MODULE_LICENSE("GPL");

MODULE_DESCRIPTION("Utilities for Bitbanging SPI host controllers");