[linux-2.6-block.git] / drivers / gpio / gpio-74x164.c

/*
 *  74Hx164 - Generic serial-in/parallel-out 8-bits shift register GPIO driver
 *
 *  Copyright (C) 2010 Gabor Juhos <juhosg@openwrt.org>
 *  Copyright (C) 2010 Miguel Gaio <miguel.gaio@efixo.com>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2 as
 *  published by the Free Software Foundation.
 */

#include <linux/init.h>
#include <linux/mutex.h>
#include <linux/spi/spi.h>
#include <linux/gpio.h>
#include <linux/of_gpio.h>
#include <linux/slab.h>
#include <linux/module.h>

#define GEN_74X164_NUMBER_GPIOS	8

struct gen_74x164_chip {
	struct gpio_chip	gpio_chip;
	struct mutex		lock;
	u32			registers;
	/*
	 * Since the registers are chained, every byte sent will make
	 * the previous byte shift to the next register in the
	 * chain. Thus, the first byte sent will end up in the last
	 * register at the end of the transfer. So, to have a logical
	 * numbering, store the bytes in reverse order.
	 */
	u8			buffer[0];
};

static int __gen_74x164_write_config(struct gen_74x164_chip *chip)
{
	struct spi_transfer xfer = {
		.tx_buf = chip->buffer,
		.len = chip->registers,
	};

	return spi_sync_transfer(to_spi_device(chip->gpio_chip.parent),
				 &xfer, 1);
}

static int gen_74x164_get_value(struct gpio_chip *gc, unsigned offset)
{
	struct gen_74x164_chip *chip = gpiochip_get_data(gc);
	u8 bank = chip->registers - 1 - offset / 8;
	u8 pin = offset % 8;
	int ret;

	mutex_lock(&chip->lock);
	ret = (chip->buffer[bank] >> pin) & 0x1;
	mutex_unlock(&chip->lock);

	return ret;
}

static void gen_74x164_set_value(struct gpio_chip *gc,
		unsigned offset, int val)
{
	struct gen_74x164_chip *chip = gpiochip_get_data(gc);
	u8 bank = chip->registers - 1 - offset / 8;
	u8 pin = offset % 8;

	mutex_lock(&chip->lock);
	if (val)
		chip->buffer[bank] |= (1 << pin);
	else
		chip->buffer[bank] &= ~(1 << pin);

	__gen_74x164_write_config(chip);
	mutex_unlock(&chip->lock);
}

static void gen_74x164_set_multiple(struct gpio_chip *gc, unsigned long *mask,
				    unsigned long *bits)
{
	struct gen_74x164_chip *chip = gpiochip_get_data(gc);
	unsigned int i, idx, shift;
	u8 bank, bankmask;

	mutex_lock(&chip->lock);
	for (i = 0, bank = chip->registers - 1; i < chip->registers;
	     i++, bank--) {
		idx = i / sizeof(*mask);
		shift = i % sizeof(*mask) * BITS_PER_BYTE;
		bankmask = mask[idx] >> shift;
		if (!bankmask)
			continue;

		chip->buffer[bank] &= ~bankmask;
		chip->buffer[bank] |= bankmask & (bits[idx] >> shift);
	}
	__gen_74x164_write_config(chip);
	mutex_unlock(&chip->lock);
}

static int gen_74x164_direction_output(struct gpio_chip *gc,
		unsigned offset, int val)
{
	gen_74x164_set_value(gc, offset, val);
	return 0;
}

static int gen_74x164_probe(struct spi_device *spi)
{
	struct gen_74x164_chip *chip;
	u32 nregs;
	int ret;

	/*
	 * bits_per_word cannot be configured in platform data
	 */
	spi->bits_per_word = 8;

	ret = spi_setup(spi);
	if (ret < 0)
		return ret;

	if (of_property_read_u32(spi->dev.of_node, "registers-number",
				 &nregs)) {
		dev_err(&spi->dev,
			"Missing registers-number property in the DT.\n");
		return -EINVAL;
	}

	chip = devm_kzalloc(&spi->dev, sizeof(*chip) + nregs, GFP_KERNEL);
	if (!chip)
		return -ENOMEM;

	spi_set_drvdata(spi, chip);

	chip->gpio_chip.label = spi->modalias;
	chip->gpio_chip.direction_output = gen_74x164_direction_output;
	chip->gpio_chip.get = gen_74x164_get_value;
	chip->gpio_chip.set = gen_74x164_set_value;
	chip->gpio_chip.set_multiple = gen_74x164_set_multiple;
	chip->gpio_chip.base = -1;

	chip->registers = nregs;
	chip->gpio_chip.ngpio = GEN_74X164_NUMBER_GPIOS * chip->registers;

	chip->gpio_chip.can_sleep = true;
	chip->gpio_chip.parent = &spi->dev;
	chip->gpio_chip.owner = THIS_MODULE;

	mutex_init(&chip->lock);

	ret = __gen_74x164_write_config(chip);
	if (ret) {
		dev_err(&spi->dev, "Failed writing: %d\n", ret);
		goto exit_destroy;
	}

	ret = gpiochip_add_data(&chip->gpio_chip, chip);
	if (!ret)
		return 0;

exit_destroy:
	mutex_destroy(&chip->lock);

	return ret;
}

static int gen_74x164_remove(struct spi_device *spi)
{
	struct gen_74x164_chip *chip = spi_get_drvdata(spi);

	gpiochip_remove(&chip->gpio_chip);
	mutex_destroy(&chip->lock);

	return 0;
}

static const struct of_device_id gen_74x164_dt_ids[] = {
	{ .compatible = "fairchild,74hc595" },
	{ .compatible = "nxp,74lvc594" },
	{},
};
MODULE_DEVICE_TABLE(of, gen_74x164_dt_ids);

static struct spi_driver gen_74x164_driver = {
	.driver = {
		.name		= "74x164",
		.of_match_table	= gen_74x164_dt_ids,
	},
	.probe		= gen_74x164_probe,
	.remove		= gen_74x164_remove,
};
module_spi_driver(gen_74x164_driver);

MODULE_AUTHOR("Gabor Juhos <juhosg@openwrt.org>");
MODULE_AUTHOR("Miguel Gaio <miguel.gaio@efixo.com>");
MODULE_DESCRIPTION("GPIO expander driver for 74X164 8-bits shift register");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
ead6db08 MG	1	/*
	2	* 74Hx164 - Generic serial-in/parallel-out 8-bits shift register GPIO driver
	3	*
	4	* Copyright (C) 2010 Gabor Juhos <juhosg@openwrt.org>
	5	* Copyright (C) 2010 Miguel Gaio <miguel.gaio@efixo.com>
	6	*
	7	* This program is free software; you can redistribute it and/or modify
	8	* it under the terms of the GNU General Public License version 2 as
	9	* published by the Free Software Foundation.
	10	*/
	11
	12	#include <linux/init.h>
	13	#include <linux/mutex.h>
	14	#include <linux/spi/spi.h>
ead6db08	15	#include <linux/gpio.h>
20bc4d5d	16	#include <linux/of_gpio.h>
ead6db08	17	#include <linux/slab.h>
bb207ef1	18	#include <linux/module.h>
ead6db08	19
20bc4d5d MR	20	#define GEN_74X164_NUMBER_GPIOS 8
20bc4d5d MR	21
ead6db08	22	struct gen_74x164_chip {
ead6db08 MG	23	struct gpio_chip gpio_chip;
ead6db08 MG	24	struct mutex lock;
20bc4d5d	25	u32 registers;
902e7e60 GU	26	/*
	27	* Since the registers are chained, every byte sent will make
	28	* the previous byte shift to the next register in the
	29	* chain. Thus, the first byte sent will end up in the last
	30	* register at the end of the transfer. So, to have a logical
	31	* numbering, store the bytes in reverse order.
	32	*/
410f4574	33	u8 buffer[0];
ead6db08 MG	34	};
ead6db08 MG	35
ead6db08 MG	36	static int __gen_74x164_write_config(struct gen_74x164_chip *chip)
ead6db08 MG	37	{
902e7e60 GU	38	struct spi_transfer xfer = {
	39	.tx_buf = chip->buffer,
	40	.len = chip->registers,
	41	};
20bc4d5d	42
902e7e60 GU	43	return spi_sync_transfer(to_spi_device(chip->gpio_chip.parent),
902e7e60 GU	44	&xfer, 1);
ead6db08 MG	45	}
ead6db08 MG	46
ead6db08 MG	47	static int gen_74x164_get_value(struct gpio_chip *gc, unsigned offset)
ead6db08 MG	48	{
b2afc6f3	49	struct gen_74x164_chip *chip = gpiochip_get_data(gc);
902e7e60	50	u8 bank = chip->registers - 1 - offset / 8;
20bc4d5d	51	u8 pin = offset % 8;
ead6db08 MG	52	int ret;
	53
	54	mutex_lock(&chip->lock);
20bc4d5d	55	ret = (chip->buffer[bank] >> pin) & 0x1;
ead6db08 MG	56	mutex_unlock(&chip->lock);
	57
	58	return ret;
	59	}
	60
	61	static void gen_74x164_set_value(struct gpio_chip *gc,
	62	unsigned offset, int val)
	63	{
b2afc6f3	64	struct gen_74x164_chip *chip = gpiochip_get_data(gc);
902e7e60	65	u8 bank = chip->registers - 1 - offset / 8;
20bc4d5d	66	u8 pin = offset % 8;
ead6db08 MG	67
	68	mutex_lock(&chip->lock);
	69	if (val)
20bc4d5d	70	chip->buffer[bank] \|= (1 << pin);
ead6db08	71	else
20bc4d5d	72	chip->buffer[bank] &= ~(1 << pin);
ead6db08 MG	73
	74	__gen_74x164_write_config(chip);
	75	mutex_unlock(&chip->lock);
	76	}
	77
d46ab682 GU	78	static void gen_74x164_set_multiple(struct gpio_chip gc, unsigned long mask,
	79	unsigned long *bits)
	80	{
	81	struct gen_74x164_chip *chip = gpiochip_get_data(gc);
	82	unsigned int i, idx, shift;
	83	u8 bank, bankmask;
	84
	85	mutex_lock(&chip->lock);
	86	for (i = 0, bank = chip->registers - 1; i < chip->registers;
	87	i++, bank--) {
	88	idx = i / sizeof(*mask);
	89	shift = i % sizeof(mask) BITS_PER_BYTE;
	90	bankmask = mask[idx] >> shift;
	91	if (!bankmask)
	92	continue;
	93
	94	chip->buffer[bank] &= ~bankmask;
	95	chip->buffer[bank] \|= bankmask & (bits[idx] >> shift);
	96	}
	97	__gen_74x164_write_config(chip);
	98	mutex_unlock(&chip->lock);
	99	}
	100
a3cc68c3 HS	101	static int gen_74x164_direction_output(struct gpio_chip *gc,
	102	unsigned offset, int val)
	103	{
	104	gen_74x164_set_value(gc, offset, val);
	105	return 0;
	106	}
	107
3836309d	108	static int gen_74x164_probe(struct spi_device *spi)
ead6db08 MG	109	{
ead6db08 MG	110	struct gen_74x164_chip *chip;
410f4574	111	u32 nregs;
ead6db08 MG	112	int ret;
ead6db08 MG	113
ead6db08 MG	114	/*
	115	* bits_per_word cannot be configured in platform data
	116	*/
	117	spi->bits_per_word = 8;
	118
	119	ret = spi_setup(spi);
	120	if (ret < 0)
	121	return ret;
	122
410f4574 GU	123	if (of_property_read_u32(spi->dev.of_node, "registers-number",
	124	&nregs)) {
	125	dev_err(&spi->dev,
	126	"Missing registers-number property in the DT.\n");
	127	return -EINVAL;
	128	}
	129
	130	chip = devm_kzalloc(&spi->dev, sizeof(*chip) + nregs, GFP_KERNEL);
ead6db08 MG	131	if (!chip)
	132	return -ENOMEM;
	133
6c0cf42b	134	spi_set_drvdata(spi, chip);
ead6db08	135
a3cc68c3 HS	136	chip->gpio_chip.label = spi->modalias;
a3cc68c3 HS	137	chip->gpio_chip.direction_output = gen_74x164_direction_output;
ead6db08 MG	138	chip->gpio_chip.get = gen_74x164_get_value;
ead6db08 MG	139	chip->gpio_chip.set = gen_74x164_set_value;
d46ab682	140	chip->gpio_chip.set_multiple = gen_74x164_set_multiple;
61e73804	141	chip->gpio_chip.base = -1;
20bc4d5d	142
410f4574	143	chip->registers = nregs;
20bc4d5d	144	chip->gpio_chip.ngpio = GEN_74X164_NUMBER_GPIOS * chip->registers;
20bc4d5d	145
9fb1f39e	146	chip->gpio_chip.can_sleep = true;
58383c78	147	chip->gpio_chip.parent = &spi->dev;
ead6db08 MG	148	chip->gpio_chip.owner = THIS_MODULE;
ead6db08 MG	149
bcc0562c AS	150	mutex_init(&chip->lock);
bcc0562c AS	151
ead6db08 MG	152	ret = __gen_74x164_write_config(chip);
	153	if (ret) {
	154	dev_err(&spi->dev, "Failed writing: %d\n", ret);
	155	goto exit_destroy;
	156	}
	157
b2afc6f3	158	ret = gpiochip_add_data(&chip->gpio_chip, chip);
bcc0562c AS	159	if (!ret)
bcc0562c AS	160	return 0;
ead6db08 MG	161
ead6db08 MG	162	exit_destroy:
ead6db08	163	mutex_destroy(&chip->lock);
bcc0562c	164
ead6db08 MG	165	return ret;
	166	}
	167
206210ce	168	static int gen_74x164_remove(struct spi_device *spi)
ead6db08	169	{
bcc0562c	170	struct gen_74x164_chip *chip = spi_get_drvdata(spi);
ead6db08	171
9f5132ae	172	gpiochip_remove(&chip->gpio_chip);
9f5132ae	173	mutex_destroy(&chip->lock);
ead6db08	174
9f5132ae	175	return 0;
ead6db08 MG	176	}
ead6db08 MG	177
0a90a9fb MR	178	static const struct of_device_id gen_74x164_dt_ids[] = {
0a90a9fb MR	179	{ .compatible = "fairchild,74hc595" },
80018bd9	180	{ .compatible = "nxp,74lvc594" },
0a90a9fb MR	181	{},
	182	};
	183	MODULE_DEVICE_TABLE(of, gen_74x164_dt_ids);
	184
ead6db08 MG	185	static struct spi_driver gen_74x164_driver = {
ead6db08 MG	186	.driver = {
a3cc68c3	187	.name = "74x164",
187a53a5	188	.of_match_table = gen_74x164_dt_ids,
ead6db08 MG	189	},
ead6db08 MG	190	.probe = gen_74x164_probe,
8283c4ff	191	.remove = gen_74x164_remove,
ead6db08	192	};
ab3b8782	193	module_spi_driver(gen_74x164_driver);
ead6db08 MG	194
	195	MODULE_AUTHOR("Gabor Juhos <juhosg@openwrt.org>");
	196	MODULE_AUTHOR("Miguel Gaio <miguel.gaio@efixo.com>");
	197	MODULE_DESCRIPTION("GPIO expander driver for 74X164 8-bits shift register");
	198	MODULE_LICENSE("GPL v2");