[net-next-2.6.git] / drivers / spi / spi_gpio.c

/*
 * spi_gpio.c - SPI master driver using generic bitbanged GPIO
 *
 * Copyright (C) 2006,2008 David Brownell
 *
 * 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.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */
#include <linux/kernel.h>
#include <linux/init.h>
#include <linux/platform_device.h>
#include <linux/gpio.h>

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


/*
 * This bitbanging SPI master driver should help make systems usable
 * when a native hardware SPI engine is not available, perhaps because
 * its driver isn't yet working or because the I/O pins it requires
 * are used for other purposes.
 *
 * platform_device->driver_data ... points to spi_gpio
 *
 * spi->controller_state ... reserved for bitbang framework code
 * spi->controller_data ... holds chipselect GPIO
 *
 * spi->master->dev.driver_data ... points to spi_gpio->bitbang
 */

struct spi_gpio {
	struct spi_bitbang		bitbang;
	struct spi_gpio_platform_data	pdata;
	struct platform_device		*pdev;
};

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

/*
 * Because the overhead of going through four GPIO procedure calls
 * per transferred bit can make performance a problem, this code
 * is set up so that you can use it in either of two ways:
 *
 *   - The slow generic way:  set up platform_data to hold the GPIO
 *     numbers used for MISO/MOSI/SCK, and issue procedure calls for
 *     each of them.  This driver can handle several such busses.
 *
 *   - The quicker inlined way:  only helps with platform GPIO code
 *     that inlines operations for constant GPIOs.  This can give
 *     you tight (fast!) inner loops, but each such bus needs a
 *     new driver.  You'll define a new C file, with Makefile and
 *     Kconfig support; the C code can be a total of six lines:
 *
 *		#define DRIVER_NAME	"myboard_spi2"
 *		#define	SPI_MISO_GPIO	119
 *		#define	SPI_MOSI_GPIO	120
 *		#define	SPI_SCK_GPIO	121
 *		#define	SPI_N_CHIPSEL	4
 *		#include "spi_gpio.c"
 */

#ifndef DRIVER_NAME
#define DRIVER_NAME	"spi_gpio"

#define GENERIC_BITBANG	/* vs tight inlines */

/* all functions referencing these symbols must define pdata */
#define SPI_MISO_GPIO	((pdata)->miso)
#define SPI_MOSI_GPIO	((pdata)->mosi)
#define SPI_SCK_GPIO	((pdata)->sck)

#define SPI_N_CHIPSEL	((pdata)->num_chipselect)

#endif

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

static inline const struct spi_gpio_platform_data * __pure
spi_to_pdata(const struct spi_device *spi)
{
	const struct spi_bitbang	*bang;
	const struct spi_gpio		*spi_gpio;

	bang = spi_master_get_devdata(spi->master);
	spi_gpio = container_of(bang, struct spi_gpio, bitbang);
	return &spi_gpio->pdata;
}

/* this is #defined to avoid unused-variable warnings when inlining */
#define pdata		spi_to_pdata(spi)

static inline void setsck(const struct spi_device *spi, int is_on)
{
	gpio_set_value(SPI_SCK_GPIO, is_on);
}

static inline void setmosi(const struct spi_device *spi, int is_on)
{
	gpio_set_value(SPI_MOSI_GPIO, is_on);
}

static inline int getmiso(const struct spi_device *spi)
{
	return !!gpio_get_value(SPI_MISO_GPIO);
}

#undef pdata

/*
 * NOTE:  this clocks "as fast as we can".  It "should" be a function of the
 * requested device clock.  Software overhead means we usually have trouble
 * reaching even one Mbit/sec (except when we can inline bitops), so for now
 * we'll just assume we never need additional per-bit slowdowns.
 */
#define spidelay(nsecs)	do {} while (0)

#include "spi_bitbang_txrx.h"

/*
 * These functions can leverage inline expansion of GPIO calls to shrink
 * costs for a txrx bit, often by factors of around ten (by instruction
 * count).  That is particularly visible for larger word sizes, but helps
 * even with default 8-bit words.
 *
 * REVISIT overheads calling these functions for each word also have
 * significant performance costs.  Having txrx_bufs() calls that inline
 * the txrx_word() logic would help performance, e.g. on larger blocks
 * used with flash storage or MMC/SD.  There should also be ways to make
 * GCC be less stupid about reloading registers inside the I/O loops,
 * even without inlined GPIO calls; __attribute__((hot)) on GCC 4.3?
 */

static u32 spi_gpio_txrx_word_mode0(struct spi_device *spi,
		unsigned nsecs, u32 word, u8 bits)
{
	return bitbang_txrx_be_cpha0(spi, nsecs, 0, 0, word, bits);
}

static u32 spi_gpio_txrx_word_mode1(struct spi_device *spi,
		unsigned nsecs, u32 word, u8 bits)
{
	return bitbang_txrx_be_cpha1(spi, nsecs, 0, 0, word, bits);
}

static u32 spi_gpio_txrx_word_mode2(struct spi_device *spi,
		unsigned nsecs, u32 word, u8 bits)
{
	return bitbang_txrx_be_cpha0(spi, nsecs, 1, 0, word, bits);
}

static u32 spi_gpio_txrx_word_mode3(struct spi_device *spi,
		unsigned nsecs, u32 word, u8 bits)
{
	return bitbang_txrx_be_cpha1(spi, nsecs, 1, 0, word, bits);
}

/*
 * These functions do not call setmosi or getmiso if respective flag
 * (SPI_MASTER_NO_RX or SPI_MASTER_NO_TX) is set, so they are safe to
 * call when such pin is not present or defined in the controller.
 * A separate set of callbacks is defined to get highest possible
 * speed in the generic case (when both MISO and MOSI lines are
 * available), as optimiser will remove the checks when argument is
 * constant.
 */

static u32 spi_gpio_spec_txrx_word_mode0(struct spi_device *spi,
		unsigned nsecs, u32 word, u8 bits)
{
	unsigned flags = spi->master->flags;
	return bitbang_txrx_be_cpha0(spi, nsecs, 0, flags, word, bits);
}

static u32 spi_gpio_spec_txrx_word_mode1(struct spi_device *spi,
		unsigned nsecs, u32 word, u8 bits)
{
	unsigned flags = spi->master->flags;
	return bitbang_txrx_be_cpha1(spi, nsecs, 0, flags, word, bits);
}

static u32 spi_gpio_spec_txrx_word_mode2(struct spi_device *spi,
		unsigned nsecs, u32 word, u8 bits)
{
	unsigned flags = spi->master->flags;
	return bitbang_txrx_be_cpha0(spi, nsecs, 1, flags, word, bits);
}

static u32 spi_gpio_spec_txrx_word_mode3(struct spi_device *spi,
		unsigned nsecs, u32 word, u8 bits)
{
	unsigned flags = spi->master->flags;
	return bitbang_txrx_be_cpha1(spi, nsecs, 1, flags, word, bits);
}

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

static void spi_gpio_chipselect(struct spi_device *spi, int is_active)
{
	unsigned long cs = (unsigned long) spi->controller_data;

	/* set initial clock polarity */
	if (is_active)
		setsck(spi, spi->mode & SPI_CPOL);

	if (cs != SPI_GPIO_NO_CHIPSELECT) {
		/* SPI is normally active-low */
		gpio_set_value(cs, (spi->mode & SPI_CS_HIGH) ? is_active : !is_active);
	}
}

static int spi_gpio_setup(struct spi_device *spi)
{
	unsigned long	cs = (unsigned long) spi->controller_data;
	int		status = 0;

	if (spi->bits_per_word > 32)
		return -EINVAL;

	if (!spi->controller_state) {
		if (cs != SPI_GPIO_NO_CHIPSELECT) {
			status = gpio_request(cs, dev_name(&spi->dev));
			if (status)
				return status;
			status = gpio_direction_output(cs, spi->mode & SPI_CS_HIGH);
		}
	}
	if (!status)
		status = spi_bitbang_setup(spi);
	if (status) {
		if (!spi->controller_state && cs != SPI_GPIO_NO_CHIPSELECT)
			gpio_free(cs);
	}
	return status;
}

static void spi_gpio_cleanup(struct spi_device *spi)
{
	unsigned long	cs = (unsigned long) spi->controller_data;

	if (cs != SPI_GPIO_NO_CHIPSELECT)
		gpio_free(cs);
	spi_bitbang_cleanup(spi);
}

static int __init spi_gpio_alloc(unsigned pin, const char *label, bool is_in)
{
	int value;

	value = gpio_request(pin, label);
	if (value == 0) {
		if (is_in)
			value = gpio_direction_input(pin);
		else
			value = gpio_direction_output(pin, 0);
	}
	return value;
}

static int __init
spi_gpio_request(struct spi_gpio_platform_data *pdata, const char *label,
	u16 *res_flags)
{
	int value;

	/* NOTE:  SPI_*_GPIO symbols may reference "pdata" */

	if (SPI_MOSI_GPIO != SPI_GPIO_NO_MOSI) {
		value = spi_gpio_alloc(SPI_MOSI_GPIO, label, false);
		if (value)
			goto done;
	} else {
		/* HW configuration without MOSI pin */
		*res_flags |= SPI_MASTER_NO_TX;
	}

	if (SPI_MISO_GPIO != SPI_GPIO_NO_MISO) {
		value = spi_gpio_alloc(SPI_MISO_GPIO, label, true);
		if (value)
			goto free_mosi;
	} else {
		/* HW configuration without MISO pin */
		*res_flags |= SPI_MASTER_NO_RX;
	}

	value = spi_gpio_alloc(SPI_SCK_GPIO, label, false);
	if (value)
		goto free_miso;

	goto done;

free_miso:
	if (SPI_MISO_GPIO != SPI_GPIO_NO_MISO)
		gpio_free(SPI_MISO_GPIO);
free_mosi:
	if (SPI_MOSI_GPIO != SPI_GPIO_NO_MOSI)
		gpio_free(SPI_MOSI_GPIO);
done:
	return value;
}

static int __init spi_gpio_probe(struct platform_device *pdev)
{
	int				status;
	struct spi_master		*master;
	struct spi_gpio			*spi_gpio;
	struct spi_gpio_platform_data	*pdata;
	u16 master_flags = 0;

	pdata = pdev->dev.platform_data;
#ifdef GENERIC_BITBANG
	if (!pdata || !pdata->num_chipselect)
		return -ENODEV;
#endif

	status = spi_gpio_request(pdata, dev_name(&pdev->dev), &master_flags);
	if (status < 0)
		return status;

	master = spi_alloc_master(&pdev->dev, sizeof *spi_gpio);
	if (!master) {
		status = -ENOMEM;
		goto gpio_free;
	}
	spi_gpio = spi_master_get_devdata(master);
	platform_set_drvdata(pdev, spi_gpio);

	spi_gpio->pdev = pdev;
	if (pdata)
		spi_gpio->pdata = *pdata;

	master->flags = master_flags;
	master->bus_num = pdev->id;
	master->num_chipselect = SPI_N_CHIPSEL;
	master->setup = spi_gpio_setup;
	master->cleanup = spi_gpio_cleanup;

	spi_gpio->bitbang.master = spi_master_get(master);
	spi_gpio->bitbang.chipselect = spi_gpio_chipselect;

	if ((master_flags & (SPI_MASTER_NO_TX | SPI_MASTER_NO_RX)) == 0) {
		spi_gpio->bitbang.txrx_word[SPI_MODE_0] = spi_gpio_txrx_word_mode0;
		spi_gpio->bitbang.txrx_word[SPI_MODE_1] = spi_gpio_txrx_word_mode1;
		spi_gpio->bitbang.txrx_word[SPI_MODE_2] = spi_gpio_txrx_word_mode2;
		spi_gpio->bitbang.txrx_word[SPI_MODE_3] = spi_gpio_txrx_word_mode3;
	} else {
		spi_gpio->bitbang.txrx_word[SPI_MODE_0] = spi_gpio_spec_txrx_word_mode0;
		spi_gpio->bitbang.txrx_word[SPI_MODE_1] = spi_gpio_spec_txrx_word_mode1;
		spi_gpio->bitbang.txrx_word[SPI_MODE_2] = spi_gpio_spec_txrx_word_mode2;
		spi_gpio->bitbang.txrx_word[SPI_MODE_3] = spi_gpio_spec_txrx_word_mode3;
	}
	spi_gpio->bitbang.setup_transfer = spi_bitbang_setup_transfer;
	spi_gpio->bitbang.flags = SPI_CS_HIGH;

	status = spi_bitbang_start(&spi_gpio->bitbang);
	if (status < 0) {
		spi_master_put(spi_gpio->bitbang.master);
gpio_free:
		if (SPI_MISO_GPIO != SPI_GPIO_NO_MISO)
			gpio_free(SPI_MISO_GPIO);
		if (SPI_MOSI_GPIO != SPI_GPIO_NO_MOSI)
			gpio_free(SPI_MOSI_GPIO);
		gpio_free(SPI_SCK_GPIO);
		spi_master_put(master);
	}

	return status;
}

static int __exit spi_gpio_remove(struct platform_device *pdev)
{
	struct spi_gpio			*spi_gpio;
	struct spi_gpio_platform_data	*pdata;
	int				status;

	spi_gpio = platform_get_drvdata(pdev);
	pdata = pdev->dev.platform_data;

	/* stop() unregisters child devices too */
	status = spi_bitbang_stop(&spi_gpio->bitbang);
	spi_master_put(spi_gpio->bitbang.master);

	platform_set_drvdata(pdev, NULL);

	if (SPI_MISO_GPIO != SPI_GPIO_NO_MISO)
		gpio_free(SPI_MISO_GPIO);
	if (SPI_MOSI_GPIO != SPI_GPIO_NO_MOSI)
		gpio_free(SPI_MOSI_GPIO);
	gpio_free(SPI_SCK_GPIO);

	return status;
}

MODULE_ALIAS("platform:" DRIVER_NAME);

static struct platform_driver spi_gpio_driver = {
	.driver.name	= DRIVER_NAME,
	.driver.owner	= THIS_MODULE,
	.remove		= __exit_p(spi_gpio_remove),
};

static int __init spi_gpio_init(void)
{
	return platform_driver_probe(&spi_gpio_driver, spi_gpio_probe);
}
module_init(spi_gpio_init);

static void __exit spi_gpio_exit(void)
{
	platform_driver_unregister(&spi_gpio_driver);
}
module_exit(spi_gpio_exit);


MODULE_DESCRIPTION("SPI master driver using generic bitbanged GPIO ");
MODULE_AUTHOR("David Brownell");
MODULE_LICENSE("GPL");
Commit	Line	Data
d29389de DB	1	/*
	2	* spi_gpio.c - SPI master driver using generic bitbanged GPIO
	3	*
	4	* Copyright (C) 2006,2008 David Brownell
	5	*
	6	* This program is free software; you can redistribute it and/or modify
	7	* it under the terms of the GNU General Public License as published by
	8	* the Free Software Foundation; either version 2 of the License, or
	9	* (at your option) any later version.
	10	*
	11	* This program is distributed in the hope that it will be useful,
	12	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	13	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	14	* GNU General Public License for more details.
	15	*
	16	* You should have received a copy of the GNU General Public License
	17	* along with this program; if not, write to the Free Software
	18	* Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
	19	*/
	20	#include <linux/kernel.h>
	21	#include <linux/init.h>
	22	#include <linux/platform_device.h>
	23	#include <linux/gpio.h>
	24
	25	#include <linux/spi/spi.h>
	26	#include <linux/spi/spi_bitbang.h>
	27	#include <linux/spi/spi_gpio.h>
	28
	29
	30	/*
	31	* This bitbanging SPI master driver should help make systems usable
	32	* when a native hardware SPI engine is not available, perhaps because
	33	* its driver isn't yet working or because the I/O pins it requires
	34	* are used for other purposes.
	35	*
	36	* platform_device->driver_data ... points to spi_gpio
	37	*
	38	* spi->controller_state ... reserved for bitbang framework code
	39	* spi->controller_data ... holds chipselect GPIO
	40	*
	41	* spi->master->dev.driver_data ... points to spi_gpio->bitbang
	42	*/
	43
	44	struct spi_gpio {
	45	struct spi_bitbang bitbang;
	46	struct spi_gpio_platform_data pdata;
	47	struct platform_device *pdev;
	48	};
	49
	50	/----------------------------------------------------------------------/
	51
	52	/*
	53	* Because the overhead of going through four GPIO procedure calls
	54	* per transferred bit can make performance a problem, this code
	55	* is set up so that you can use it in either of two ways:
	56	*
	57	* - The slow generic way: set up platform_data to hold the GPIO
	58	* numbers used for MISO/MOSI/SCK, and issue procedure calls for
	59	* each of them. This driver can handle several such busses.
	60	*
	61	* - The quicker inlined way: only helps with platform GPIO code
	62	* that inlines operations for constant GPIOs. This can give
	63	* you tight (fast!) inner loops, but each such bus needs a
	64	* new driver. You'll define a new C file, with Makefile and
65	* Kconfig support; the C code can be a total of six lines:
66	*
67	* #define DRIVER_NAME "myboard_spi2"
68	* #define SPI_MISO_GPIO 119
69	* #define SPI_MOSI_GPIO 120
70	* #define SPI_SCK_GPIO 121
71	* #define SPI_N_CHIPSEL 4
72	* #include "spi_gpio.c"
73	*/
74
75	#ifndef DRIVER_NAME
76	#define DRIVER_NAME "spi_gpio"
77
78	#define GENERIC_BITBANG /* vs tight inlines */
79
80	/* all functions referencing these symbols must define pdata */
81	#define SPI_MISO_GPIO ((pdata)->miso)
82	#define SPI_MOSI_GPIO ((pdata)->mosi)
83	#define SPI_SCK_GPIO ((pdata)->sck)
84
85	#define SPI_N_CHIPSEL ((pdata)->num_chipselect)
86
87	#endif
88
89	/----------------------------------------------------------------------/
90
91	static inline const struct spi_gpio_platform_data * __pure
92	spi_to_pdata(const struct spi_device *spi)
93	{
94	const struct spi_bitbang *bang;
95	const struct spi_gpio *spi_gpio;
96
97	bang = spi_master_get_devdata(spi->master);
98	spi_gpio = container_of(bang, struct spi_gpio, bitbang);
99	return &spi_gpio->pdata;
100	}
101
102	/* this is #defined to avoid unused-variable warnings when inlining */
103	#define pdata spi_to_pdata(spi)
104
105	static inline void setsck(const struct spi_device *spi, int is_on)
106	{
107	gpio_set_value(SPI_SCK_GPIO, is_on);
108	}
109
110	static inline void setmosi(const struct spi_device *spi, int is_on)
111	{
112	gpio_set_value(SPI_MOSI_GPIO, is_on);
113	}
114
115	static inline int getmiso(const struct spi_device *spi)
116	{
be50344e	117	return !!gpio_get_value(SPI_MISO_GPIO);
d29389de DB	118	}
	119
	120	#undef pdata
	121
	122	/*
	123	* NOTE: this clocks "as fast as we can". It "should" be a function of the
	124	* requested device clock. Software overhead means we usually have trouble
	125	* reaching even one Mbit/sec (except when we can inline bitops), so for now
	126	* we'll just assume we never need additional per-bit slowdowns.
	127	*/
	128	#define spidelay(nsecs) do {} while (0)
	129
41c4221c	130	#include "spi_bitbang_txrx.h"
d29389de DB	131
	132	/*
	133	* These functions can leverage inline expansion of GPIO calls to shrink
	134	* costs for a txrx bit, often by factors of around ten (by instruction
	135	* count). That is particularly visible for larger word sizes, but helps
	136	* even with default 8-bit words.
	137	*
	138	* REVISIT overheads calling these functions for each word also have
	139	* significant performance costs. Having txrx_bufs() calls that inline
	140	* the txrx_word() logic would help performance, e.g. on larger blocks
	141	* used with flash storage or MMC/SD. There should also be ways to make
	142	* GCC be less stupid about reloading registers inside the I/O loops,
	143	* even without inlined GPIO calls; __attribute__((hot)) on GCC 4.3?
	144	*/
	145
	146	static u32 spi_gpio_txrx_word_mode0(struct spi_device *spi,
	147	unsigned nsecs, u32 word, u8 bits)
	148	{
04bb2a03	149	return bitbang_txrx_be_cpha0(spi, nsecs, 0, 0, word, bits);
d29389de DB	150	}
	151
	152	static u32 spi_gpio_txrx_word_mode1(struct spi_device *spi,
	153	unsigned nsecs, u32 word, u8 bits)
	154	{
04bb2a03	155	return bitbang_txrx_be_cpha1(spi, nsecs, 0, 0, word, bits);
d29389de DB	156	}
	157
	158	static u32 spi_gpio_txrx_word_mode2(struct spi_device *spi,
	159	unsigned nsecs, u32 word, u8 bits)
	160	{
04bb2a03	161	return bitbang_txrx_be_cpha0(spi, nsecs, 1, 0, word, bits);
d29389de DB	162	}
	163
	164	static u32 spi_gpio_txrx_word_mode3(struct spi_device *spi,
	165	unsigned nsecs, u32 word, u8 bits)
	166	{
04bb2a03	167	return bitbang_txrx_be_cpha1(spi, nsecs, 1, 0, word, bits);
d29389de DB	168	}
d29389de DB	169
3c8e1a84 MS	170	/*
	171	* These functions do not call setmosi or getmiso if respective flag
	172	* (SPI_MASTER_NO_RX or SPI_MASTER_NO_TX) is set, so they are safe to
	173	* call when such pin is not present or defined in the controller.
	174	* A separate set of callbacks is defined to get highest possible
	175	* speed in the generic case (when both MISO and MOSI lines are
	176	* available), as optimiser will remove the checks when argument is
	177	* constant.
	178	*/
	179
	180	static u32 spi_gpio_spec_txrx_word_mode0(struct spi_device *spi,
	181	unsigned nsecs, u32 word, u8 bits)
	182	{
	183	unsigned flags = spi->master->flags;
	184	return bitbang_txrx_be_cpha0(spi, nsecs, 0, flags, word, bits);
	185	}
	186
	187	static u32 spi_gpio_spec_txrx_word_mode1(struct spi_device *spi,
	188	unsigned nsecs, u32 word, u8 bits)
	189	{
	190	unsigned flags = spi->master->flags;
	191	return bitbang_txrx_be_cpha1(spi, nsecs, 0, flags, word, bits);
	192	}
	193
	194	static u32 spi_gpio_spec_txrx_word_mode2(struct spi_device *spi,
	195	unsigned nsecs, u32 word, u8 bits)
	196	{
	197	unsigned flags = spi->master->flags;
	198	return bitbang_txrx_be_cpha0(spi, nsecs, 1, flags, word, bits);
	199	}
	200
	201	static u32 spi_gpio_spec_txrx_word_mode3(struct spi_device *spi,
	202	unsigned nsecs, u32 word, u8 bits)
	203	{
	204	unsigned flags = spi->master->flags;
	205	return bitbang_txrx_be_cpha1(spi, nsecs, 1, flags, word, bits);
	206	}
	207
d29389de DB	208	/----------------------------------------------------------------------/
	209
	210	static void spi_gpio_chipselect(struct spi_device *spi, int is_active)
	211	{
	212	unsigned long cs = (unsigned long) spi->controller_data;
	213
	214	/* set initial clock polarity */
	215	if (is_active)
	216	setsck(spi, spi->mode & SPI_CPOL);
	217
bfb9bcdb MB	218	if (cs != SPI_GPIO_NO_CHIPSELECT) {
	219	/* SPI is normally active-low */
	220	gpio_set_value(cs, (spi->mode & SPI_CS_HIGH) ? is_active : !is_active);
	221	}
d29389de DB	222	}
	223
	224	static int spi_gpio_setup(struct spi_device *spi)
	225	{
	226	unsigned long cs = (unsigned long) spi->controller_data;
	227	int status = 0;
	228
	229	if (spi->bits_per_word > 32)
	230	return -EINVAL;
	231
	232	if (!spi->controller_state) {
bfb9bcdb MB	233	if (cs != SPI_GPIO_NO_CHIPSELECT) {
	234	status = gpio_request(cs, dev_name(&spi->dev));
	235	if (status)
	236	return status;
	237	status = gpio_direction_output(cs, spi->mode & SPI_CS_HIGH);
	238	}
d29389de DB	239	}
	240	if (!status)
	241	status = spi_bitbang_setup(spi);
	242	if (status) {
bfb9bcdb	243	if (!spi->controller_state && cs != SPI_GPIO_NO_CHIPSELECT)
d29389de DB	244	gpio_free(cs);
	245	}
	246	return status;
	247	}
	248
	249	static void spi_gpio_cleanup(struct spi_device *spi)
	250	{
	251	unsigned long cs = (unsigned long) spi->controller_data;
	252
bfb9bcdb MB	253	if (cs != SPI_GPIO_NO_CHIPSELECT)
bfb9bcdb MB	254	gpio_free(cs);
d29389de DB	255	spi_bitbang_cleanup(spi);
	256	}
	257
	258	static int __init spi_gpio_alloc(unsigned pin, const char *label, bool is_in)
	259	{
	260	int value;
	261
	262	value = gpio_request(pin, label);
	263	if (value == 0) {
	264	if (is_in)
	265	value = gpio_direction_input(pin);
	266	else
	267	value = gpio_direction_output(pin, 0);
	268	}
	269	return value;
	270	}
	271
	272	static int __init
3c8e1a84 MS	273	spi_gpio_request(struct spi_gpio_platform_data pdata, const char label,
3c8e1a84 MS	274	u16 *res_flags)
d29389de DB	275	{
	276	int value;
	277
	278	/* NOTE: SPI__GPIO symbols may reference "pdata" /
	279
3c8e1a84 MS	280	if (SPI_MOSI_GPIO != SPI_GPIO_NO_MOSI) {
	281	value = spi_gpio_alloc(SPI_MOSI_GPIO, label, false);
	282	if (value)
	283	goto done;
	284	} else {
	285	/* HW configuration without MOSI pin */
	286	*res_flags \|= SPI_MASTER_NO_TX;
	287	}
d29389de	288
3c8e1a84 MS	289	if (SPI_MISO_GPIO != SPI_GPIO_NO_MISO) {
	290	value = spi_gpio_alloc(SPI_MISO_GPIO, label, true);
	291	if (value)
	292	goto free_mosi;
	293	} else {
	294	/* HW configuration without MISO pin */
	295	*res_flags \|= SPI_MASTER_NO_RX;
	296	}
d29389de DB	297
	298	value = spi_gpio_alloc(SPI_SCK_GPIO, label, false);
	299	if (value)
	300	goto free_miso;
	301
	302	goto done;
	303
	304	free_miso:
3c8e1a84 MS	305	if (SPI_MISO_GPIO != SPI_GPIO_NO_MISO)
3c8e1a84 MS	306	gpio_free(SPI_MISO_GPIO);
d29389de	307	free_mosi:
3c8e1a84 MS	308	if (SPI_MOSI_GPIO != SPI_GPIO_NO_MOSI)
3c8e1a84 MS	309	gpio_free(SPI_MOSI_GPIO);
d29389de DB	310	done:
	311	return value;
	312	}
	313
	314	static int __init spi_gpio_probe(struct platform_device *pdev)
	315	{
	316	int status;
	317	struct spi_master *master;
	318	struct spi_gpio *spi_gpio;
	319	struct spi_gpio_platform_data *pdata;
3c8e1a84	320	u16 master_flags = 0;
d29389de DB	321
	322	pdata = pdev->dev.platform_data;
	323	#ifdef GENERIC_BITBANG
	324	if (!pdata \|\| !pdata->num_chipselect)
	325	return -ENODEV;
	326	#endif
	327
3c8e1a84	328	status = spi_gpio_request(pdata, dev_name(&pdev->dev), &master_flags);
d29389de DB	329	if (status < 0)
	330	return status;
	331
	332	master = spi_alloc_master(&pdev->dev, sizeof *spi_gpio);
	333	if (!master) {
	334	status = -ENOMEM;
	335	goto gpio_free;
	336	}
	337	spi_gpio = spi_master_get_devdata(master);
	338	platform_set_drvdata(pdev, spi_gpio);
	339
	340	spi_gpio->pdev = pdev;
	341	if (pdata)
	342	spi_gpio->pdata = *pdata;
	343
3c8e1a84	344	master->flags = master_flags;
d29389de DB	345	master->bus_num = pdev->id;
	346	master->num_chipselect = SPI_N_CHIPSEL;
	347	master->setup = spi_gpio_setup;
	348	master->cleanup = spi_gpio_cleanup;
	349
	350	spi_gpio->bitbang.master = spi_master_get(master);
	351	spi_gpio->bitbang.chipselect = spi_gpio_chipselect;
3c8e1a84	352
23699f98	353	if ((master_flags & (SPI_MASTER_NO_TX \| SPI_MASTER_NO_RX)) == 0) {
3c8e1a84 MS	354	spi_gpio->bitbang.txrx_word[SPI_MODE_0] = spi_gpio_txrx_word_mode0;
	355	spi_gpio->bitbang.txrx_word[SPI_MODE_1] = spi_gpio_txrx_word_mode1;
	356	spi_gpio->bitbang.txrx_word[SPI_MODE_2] = spi_gpio_txrx_word_mode2;
	357	spi_gpio->bitbang.txrx_word[SPI_MODE_3] = spi_gpio_txrx_word_mode3;
	358	} else {
	359	spi_gpio->bitbang.txrx_word[SPI_MODE_0] = spi_gpio_spec_txrx_word_mode0;
	360	spi_gpio->bitbang.txrx_word[SPI_MODE_1] = spi_gpio_spec_txrx_word_mode1;
	361	spi_gpio->bitbang.txrx_word[SPI_MODE_2] = spi_gpio_spec_txrx_word_mode2;
	362	spi_gpio->bitbang.txrx_word[SPI_MODE_3] = spi_gpio_spec_txrx_word_mode3;
	363	}
d29389de DB	364	spi_gpio->bitbang.setup_transfer = spi_bitbang_setup_transfer;
	365	spi_gpio->bitbang.flags = SPI_CS_HIGH;
	366
	367	status = spi_bitbang_start(&spi_gpio->bitbang);
	368	if (status < 0) {
	369	spi_master_put(spi_gpio->bitbang.master);
	370	gpio_free:
3c8e1a84 MS	371	if (SPI_MISO_GPIO != SPI_GPIO_NO_MISO)
	372	gpio_free(SPI_MISO_GPIO);
	373	if (SPI_MOSI_GPIO != SPI_GPIO_NO_MOSI)
	374	gpio_free(SPI_MOSI_GPIO);
d29389de DB	375	gpio_free(SPI_SCK_GPIO);
	376	spi_master_put(master);
	377	}
	378
	379	return status;
	380	}
	381
	382	static int __exit spi_gpio_remove(struct platform_device *pdev)
	383	{
	384	struct spi_gpio *spi_gpio;
	385	struct spi_gpio_platform_data *pdata;
	386	int status;
	387
	388	spi_gpio = platform_get_drvdata(pdev);
	389	pdata = pdev->dev.platform_data;
	390
	391	/* stop() unregisters child devices too */
	392	status = spi_bitbang_stop(&spi_gpio->bitbang);
	393	spi_master_put(spi_gpio->bitbang.master);
	394
	395	platform_set_drvdata(pdev, NULL);
	396
3c8e1a84 MS	397	if (SPI_MISO_GPIO != SPI_GPIO_NO_MISO)
	398	gpio_free(SPI_MISO_GPIO);
	399	if (SPI_MOSI_GPIO != SPI_GPIO_NO_MOSI)
	400	gpio_free(SPI_MOSI_GPIO);
d29389de DB	401	gpio_free(SPI_SCK_GPIO);
	402
	403	return status;
	404	}
	405
	406	MODULE_ALIAS("platform:" DRIVER_NAME);
	407
	408	static struct platform_driver spi_gpio_driver = {
	409	.driver.name = DRIVER_NAME,
	410	.driver.owner = THIS_MODULE,
	411	.remove = __exit_p(spi_gpio_remove),
	412	};
	413
	414	static int __init spi_gpio_init(void)
	415	{
	416	return platform_driver_probe(&spi_gpio_driver, spi_gpio_probe);
	417	}
	418	module_init(spi_gpio_init);
	419
	420	static void __exit spi_gpio_exit(void)
	421	{
	422	platform_driver_unregister(&spi_gpio_driver);
	423	}
	424	module_exit(spi_gpio_exit);
	425
	426
	427	MODULE_DESCRIPTION("SPI master driver using generic bitbanged GPIO ");
	428	MODULE_AUTHOR("David Brownell");
	429	MODULE_LICENSE("GPL");