Release 4.14 drivers/spi/spi-bitbang.c

/*
 * polling/bitbanging SPI master controller driver utilities
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 */

#include <linux/spinlock.h>
#include <linux/workqueue.h>
#include <linux/interrupt.h>
#include <linux/module.h>
#include <linux/delay.h>
#include <linux/errno.h>
#include <linux/platform_device.h>
#include <linux/slab.h>

#include <linux/spi/spi.h>
#include <linux/spi/spi_bitbang.h>


#define SPI_BITBANG_CS_DELAY	100


/*----------------------------------------------------------------------*/

/*
 * FIRST PART (OPTIONAL):  word-at-a-time spi_transfer support.
 * Use this for GPIO or shift-register level hardware APIs.
 *
 * spi_bitbang_cs is in spi_device->controller_state, which is unavailable
 * to glue code.  These bitbang setup() and cleanup() routines are always
 * used, though maybe they're called from controller-aware code.
 *
 * chipselect() and friends may use spi_device->controller_data and
 * controller registers as appropriate.
 *
 *
 * NOTE:  SPI controller pins can often be used as GPIO pins instead,
 * which means you could use a bitbang driver either to get hardware
 * working quickly, or testing for differences that aren't speed related.
 */


struct spi_bitbang_cs {
	
unsigned	nsecs;	/* (clock cycle time)/2 */
	
u32		(*txrx_word)(struct spi_device *spi, unsigned nsecs,
					u32 word, u8 bits);
	
unsigned	(*txrx_bufs)(struct spi_device *,
					u32 (*txrx_word)(
						struct spi_device *spi,
						unsigned nsecs,
						u32 word, u8 bits),
					unsigned, struct spi_transfer *);
};



static unsigned bitbang_txrx_8(
	struct spi_device	*spi,
	u32			(*txrx_word)(struct spi_device *spi,
					unsigned nsecs,
					u32 word, u8 bits),
	unsigned		ns,
	struct spi_transfer	*t
) {
	unsigned		bits = t->bits_per_word;
	unsigned		count = t->len;
	const u8		*tx = t->tx_buf;
	u8			*rx = t->rx_buf;

	while (likely(count > 0)) {
		u8		word = 0;

		if (tx)
			word = *tx++;
		word = txrx_word(spi, ns, word, bits);
		if (rx)
			*rx++ = word;
		count -= 1;
	}
	return t->len - count;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
David Brownell
128
97.71%
1
50.00%
Anatolij Gustschin
3
2.29%
1
50.00%
Total
131
100.00%
2
100.00%



static unsigned bitbang_txrx_16(
	struct spi_device	*spi,
	u32			(*txrx_word)(struct spi_device *spi,
					unsigned nsecs,
					u32 word, u8 bits),
	unsigned		ns,
	struct spi_transfer	*t
) {
	unsigned		bits = t->bits_per_word;
	unsigned		count = t->len;
	const u16		*tx = t->tx_buf;
	u16			*rx = t->rx_buf;

	while (likely(count > 1)) {
		u16		word = 0;

		if (tx)
			word = *tx++;
		word = txrx_word(spi, ns, word, bits);
		if (rx)
			*rx++ = word;
		count -= 2;
	}
	return t->len - count;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
David Brownell
128
97.71%
1
50.00%
Anatolij Gustschin
3
2.29%
1
50.00%
Total
131
100.00%
2
100.00%



static unsigned bitbang_txrx_32(
	struct spi_device	*spi,
	u32			(*txrx_word)(struct spi_device *spi,
					unsigned nsecs,
					u32 word, u8 bits),
	unsigned		ns,
	struct spi_transfer	*t
) {
	unsigned		bits = t->bits_per_word;
	unsigned		count = t->len;
	const u32		*tx = t->tx_buf;
	u32			*rx = t->rx_buf;

	while (likely(count > 3)) {
		u32		word = 0;

		if (tx)
			word = *tx++;
		word = txrx_word(spi, ns, word, bits);
		if (rx)
			*rx++ = word;
		count -= 4;
	}
	return t->len - count;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
David Brownell
129
98.47%
1
50.00%
Anatolij Gustschin
2
1.53%
1
50.00%
Total
131
100.00%
2
100.00%



int spi_bitbang_setup_transfer(struct spi_device *spi, struct spi_transfer *t)
{
	struct spi_bitbang_cs	*cs = spi->controller_state;
	u8			bits_per_word;
	u32			hz;

	if (t) {
		bits_per_word = t->bits_per_word;
		hz = t->speed_hz;
	} else {
		bits_per_word = 0;
		hz = 0;
	}

	/* spi_transfer level calls that work per-word */
	if (!bits_per_word)
		bits_per_word = spi->bits_per_word;
	if (bits_per_word <= 8)
		cs->txrx_bufs = bitbang_txrx_8;
	else if (bits_per_word <= 16)
		cs->txrx_bufs = bitbang_txrx_16;
	else if (bits_per_word <= 32)
		cs->txrx_bufs = bitbang_txrx_32;
	else
		return -EINVAL;

	/* nsecs = (clock period)/2 */
	if (!hz)
		hz = spi->max_speed_hz;
	if (hz) {
		cs->nsecs = (1000000000/2) / hz;
		if (cs->nsecs > (MAX_UDELAY_MS * 1000 * 1000))
			return -EINVAL;
	}

	return 0;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
Imre Deak
154
93.33%
1
33.33%
David Brownell
10
6.06%
1
33.33%
Kumar Gala
1
0.61%
1
33.33%
Total
165
100.00%
3
100.00%


EXPORT_SYMBOL_GPL(spi_bitbang_setup_transfer);

/**
 * spi_bitbang_setup - default setup for per-word I/O loops
 */


int spi_bitbang_setup(struct spi_device *spi)
{
	struct spi_bitbang_cs	*cs = spi->controller_state;
	struct spi_bitbang	*bitbang;

	bitbang = spi_master_get_devdata(spi->master);

	if (!cs) {
		cs = kzalloc(sizeof(*cs), GFP_KERNEL);
		if (!cs)
			return -ENOMEM;
		spi->controller_state = cs;
	}

	/* per-word shift register access, in hardware or bitbanging */
	cs->txrx_word = bitbang->txrx_word[spi->mode & (SPI_CPOL|SPI_CPHA)];
	if (!cs->txrx_word)
		return -EINVAL;

	if (bitbang->setup_transfer) {
		int retval = bitbang->setup_transfer(spi, NULL);
		if (retval < 0)
			return retval;
	}

	dev_dbg(&spi->dev, "%s, %u nsec/bit\n", __func__, 2 * cs->nsecs);

	/* NOTE we _need_ to call chipselect() early, ideally with adapter
         * setup, unless the hardware defaults cooperate to avoid confusion
         * between normal (active low) and inverted chipselects.
         */

	/* deselect chip (low or high) */
	mutex_lock(&bitbang->lock);
	if (!bitbang->busy) {
		bitbang->chipselect(spi, BITBANG_CS_INACTIVE);
		ndelay(cs->nsecs);
	}
	mutex_unlock(&bitbang->lock);

	return 0;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
David Brownell
158
82.29%
3
27.27%
Pelle Nilsson
11
5.73%
1
9.09%
Imre Deak
9
4.69%
1
9.09%
Vitaly Wool
4
2.08%
1
9.09%
Jingoo Han
3
1.56%
1
9.09%
Hans-Peter Nilsson
3
1.56%
1
9.09%
Nicolas Boichat
2
1.04%
1
9.09%
Harvey Harrison
1
0.52%
1
9.09%
Christoph Lameter
1
0.52%
1
9.09%
Total
192
100.00%
11
100.00%


EXPORT_SYMBOL_GPL(spi_bitbang_setup);

/**
 * spi_bitbang_cleanup - default cleanup for per-word I/O loops
 */


void spi_bitbang_cleanup(struct spi_device *spi)
{
	kfree(spi->controller_state);
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
David Brownell
17
100.00%
1
100.00%
Total
17
100.00%
1
100.00%


EXPORT_SYMBOL_GPL(spi_bitbang_cleanup);



static int spi_bitbang_bufs(struct spi_device *spi, struct spi_transfer *t)
{
	struct spi_bitbang_cs	*cs = spi->controller_state;
	unsigned		nsecs = cs->nsecs;

	return cs->txrx_bufs(spi, cs->txrx_word, nsecs, t);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
David Brownell
48
100.00%
1
100.00%
Total
48
100.00%
1
100.00%

/*----------------------------------------------------------------------*/

/*
 * SECOND PART ... simple transfer queue runner.
 *
 * This costs a task context per controller, running the queue by
 * performing each transfer in sequence.  Smarter hardware can queue
 * several DMA transfers at once, and process several controller queues
 * in parallel; this driver doesn't match such hardware very well.
 *
 * Drivers can provide word-at-a-time i/o primitives, or provide
 * transfer-at-a-time ones to leverage dma or fifo hardware.
 */



static int spi_bitbang_prepare_hardware(struct spi_master *spi)
{
	struct spi_bitbang	*bitbang;

	bitbang = spi_master_get_devdata(spi);

	mutex_lock(&bitbang->lock);
	bitbang->busy = 1;
	mutex_unlock(&bitbang->lock);

	return 0;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Mark Brown
46
95.83%
1
50.00%
Nicolas Boichat
2
4.17%
1
50.00%
Total
48
100.00%
2
100.00%



static int spi_bitbang_transfer_one(struct spi_master *master,
				    struct spi_device *spi,
				    struct spi_transfer *transfer)
{
	struct spi_bitbang *bitbang = spi_master_get_devdata(master);
	int status = 0;

	if (bitbang->setup_transfer) {
		status = bitbang->setup_transfer(spi, transfer);
		if (status < 0)
			goto out;
	}

	if (transfer->len)
		status = bitbang->txrx_bufs(spi, transfer);

	if (status == transfer->len)
		status = 0;
	else if (status >= 0)
		status = -EREMOTEIO;

out:
	spi_finalize_current_transfer(master);

	return status;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
David Brownell
43
37.39%
1
8.33%
Heiner Kallweit
27
23.48%
1
8.33%
Mark Brown
14
12.17%
2
16.67%
Imre Deak
14
12.17%
1
8.33%
Pelle Nilsson
7
6.09%
1
8.33%
Sascha Hauer
2
1.74%
1
8.33%
Guennadi Liakhovetski
2
1.74%
1
8.33%
Jan Nikitenko
2
1.74%
1
8.33%
Fabio Estevam
2
1.74%
1
8.33%
Vitaly Wool
1
0.87%
1
8.33%
David Howells
1
0.87%
1
8.33%
Total
115
100.00%
12
100.00%



static int spi_bitbang_unprepare_hardware(struct spi_master *spi)
{
	struct spi_bitbang	*bitbang;

	bitbang = spi_master_get_devdata(spi);

	mutex_lock(&bitbang->lock);
	bitbang->busy = 0;
	mutex_unlock(&bitbang->lock);

	return 0;
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
David Brownell
39
81.25%
1
25.00%
Mark Brown
7
14.58%
2
50.00%
Nicolas Boichat
2
4.17%
1
25.00%
Total
48
100.00%
4
100.00%



static void spi_bitbang_set_cs(struct spi_device *spi, bool enable)
{
	struct spi_bitbang *bitbang = spi_master_get_devdata(spi->master);

	/* SPI core provides CS high / low, but bitbang driver
         * expects CS active
         * spi device driver takes care of handling SPI_CS_HIGH
         */
	enable = (!!(spi->mode & SPI_CS_HIGH) == enable);

	ndelay(SPI_BITBANG_CS_DELAY);
	bitbang->chipselect(spi, enable ? BITBANG_CS_ACTIVE :
			    BITBANG_CS_INACTIVE);
	ndelay(SPI_BITBANG_CS_DELAY);
}

Contributors
Person
Tokens
Prop
Commits
CommitProp
Heiner Kallweit
66
100.00%
1
100.00%
Total
66
100.00%
1
100.00%

/*----------------------------------------------------------------------*/

/**
 * spi_bitbang_start - start up a polled/bitbanging SPI master 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,
 * that's the default if the transfer routine is not initialized.  It should
 * also set up the bus number and number of chipselects.
 *
 * For i/o loops, provide callbacks either per-word (for bitbanging, or for
 * 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
 * routine isn't initialized.
 *
 * This routine registers the spi_master, which will process requests in a
 * dedicated task, keeping IRQs unblocked most of the time.  To stop
 * processing those requests, call spi_bitbang_stop().
 *
 * On success, this routine will take a reference to master. The caller is
 * responsible for calling spi_bitbang_stop() to decrement the reference and
 * spi_master_put() as counterpart of spi_alloc_master() to prevent a memory
 * leak.
 */


int spi_bitbang_start(struct spi_bitbang *bitbang)
{
	struct spi_master *master = bitbang->master;
	int ret;

	if (!master || !bitbang->chipselect)
		return -EINVAL;

	mutex_init(&bitbang->lock);

	if (!master->mode_bits)
		master->mode_bits = SPI_CPOL | SPI_CPHA | bitbang->flags;

	if (master->transfer || master->transfer_one_message)
		return -EINVAL;

	master->prepare_transfer_hardware = spi_bitbang_prepare_hardware;
	master->unprepare_transfer_hardware = spi_bitbang_unprepare_hardware;
	master->transfer_one = spi_bitbang_transfer_one;
	master->set_cs = spi_bitbang_set_cs;

	if (!bitbang->txrx_bufs) {
		bitbang->use_dma = 0;
		bitbang->txrx_bufs = spi_bitbang_bufs;
		if (!master->setup) {
			if (!bitbang->setup_transfer)
				bitbang->setup_transfer =
					 spi_bitbang_setup_transfer;
			master->setup = spi_bitbang_setup;
			master->cleanup = spi_bitbang_cleanup;
		}
	}

	/* driver may get busy before register() returns, especially
         * if someone registered boardinfo for devices
         */
	ret = spi_register_master(spi_master_get(master));
	if (ret)
		spi_master_put(master);

	return 0;
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
David Brownell
110
61.45%
2
22.22%
Mark Brown
21
11.73%
1
11.11%
Axel Lin
20
11.17%
1
11.11%
Guennadi Liakhovetski
9
5.03%
1
11.11%
Kumar Gala
8
4.47%
1
11.11%
Heiner Kallweit
7
3.91%
1
11.11%
Imre Deak
3
1.68%
1
11.11%
Nicolas Boichat
1
0.56%
1
11.11%
Total
179
100.00%
9
100.00%


EXPORT_SYMBOL_GPL(spi_bitbang_start);

/**
 * spi_bitbang_stop - stops the task providing spi communication
 */


void spi_bitbang_stop(struct spi_bitbang *bitbang)
{
	spi_unregister_master(bitbang->master);
}
Contributors
Person
Tokens
Prop
Commits
CommitProp
David Brownell
15
88.24%
1
33.33%
Axel Lin
1
5.88%
1
33.33%
Chris Lesiak
1
5.88%
1
33.33%
Total
17
100.00%
3
100.00%


EXPORT_SYMBOL_GPL(spi_bitbang_stop);

MODULE_LICENSE("GPL");

Overall Contributors
Person
Tokens
Prop
Commits
CommitProp
David Brownell
949
66.36%
5
15.62%
Imre Deak
180
12.59%
1
3.12%
Heiner Kallweit
104
7.27%
1
3.12%
Mark Brown
88
6.15%
3
9.38%
Axel Lin
22
1.54%
2
6.25%
Pelle Nilsson
18
1.26%
1
3.12%
Kumar Gala
14
0.98%
1
3.12%
Guennadi Liakhovetski
11
0.77%
2
6.25%
Anatolij Gustschin
8
0.56%
1
3.12%
Nicolas Boichat
7
0.49%
1
3.12%
Vitaly Wool
5
0.35%
1
3.12%
Jingoo Han
3
0.21%
1
3.12%
Hans-Peter Nilsson
3
0.21%
1
3.12%
Tejun Heo
3
0.21%
1
3.12%
Paul Gortmaker
3
0.21%
1
3.12%
Jan Nikitenko
2
0.14%
1
3.12%
Sascha Hauer
2
0.14%
1
3.12%
Fabio Estevam
2
0.14%
1
3.12%
Uwe Kleine-König
1
0.07%
1
3.12%
Harvey Harrison
1
0.07%
1
3.12%
Chris Lesiak
1
0.07%
1
3.12%
Jarkko Nikula
1
0.07%
1
3.12%
David Howells
1
0.07%
1
3.12%
Christoph Lameter
1
0.07%
1
3.12%
Total
1430
100.00%
32
100.00%
Directory: drivers/spi

Information contained on this website is for historical information purposes only and does not indicate or represent copyright ownership.