[linux-block.git] / drivers / gpio / gpio-twl4030.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * Access to GPIOs on TWL4030/TPS659x0 chips
 *
 * Copyright (C) 2006-2007 Texas Instruments, Inc.
 * Copyright (C) 2006 MontaVista Software, Inc.
 *
 * Code re-arranged and cleaned up by:
 *	Syed Mohammed Khasim <x0khasim@ti.com>
 *
 * Initial Code:
 *	Andy Lowe / Nishanth Menon
 */

#include <linux/module.h>
#include <linux/init.h>
#include <linux/interrupt.h>
#include <linux/kthread.h>
#include <linux/irq.h>
#include <linux/gpio/driver.h>
#include <linux/platform_device.h>
#include <linux/of.h>
#include <linux/irqdomain.h>

#include <linux/mfd/twl.h>

/*
 * The GPIO "subchip" supports 18 GPIOs which can be configured as
 * inputs or outputs, with pullups or pulldowns on each pin.  Each
 * GPIO can trigger interrupts on either or both edges.
 *
 * GPIO interrupts can be fed to either of two IRQ lines; this is
 * intended to support multiple hosts.
 *
 * There are also two LED pins used sometimes as output-only GPIOs.
 */

/* genirq interfaces are not available to modules */
#ifdef MODULE
#define is_module()	true
#else
#define is_module()	false
#endif

/* GPIO_CTRL Fields */
#define MASK_GPIO_CTRL_GPIO0CD1		BIT(0)
#define MASK_GPIO_CTRL_GPIO1CD2		BIT(1)
#define MASK_GPIO_CTRL_GPIO_ON		BIT(2)

/* Mask for GPIO registers when aggregated into a 32-bit integer */
#define GPIO_32_MASK			0x0003ffff

struct gpio_twl4030_priv {
	struct gpio_chip gpio_chip;
	struct mutex mutex;
	int irq_base;

	/* Bitfields for state caching */
	unsigned int usage_count;
	unsigned int direction;
	unsigned int out_state;
};

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

/*
 * To configure TWL4030 GPIO module registers
 */
static inline int gpio_twl4030_write(u8 address, u8 data)
{
	return twl_i2c_write_u8(TWL4030_MODULE_GPIO, data, address);
}

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

/*
 * LED register offsets from TWL_MODULE_LED base
 * PWMs A and B are dedicated to LEDs A and B, respectively.
 */

#define TWL4030_LED_LEDEN_REG	0x00
#define TWL4030_PWMAON_REG	0x01
#define TWL4030_PWMAOFF_REG	0x02
#define TWL4030_PWMBON_REG	0x03
#define TWL4030_PWMBOFF_REG	0x04

/* LEDEN bits */
#define LEDEN_LEDAON		BIT(0)
#define LEDEN_LEDBON		BIT(1)
#define LEDEN_LEDAEXT		BIT(2)
#define LEDEN_LEDBEXT		BIT(3)
#define LEDEN_LEDAPWM		BIT(4)
#define LEDEN_LEDBPWM		BIT(5)
#define LEDEN_PWM_LENGTHA	BIT(6)
#define LEDEN_PWM_LENGTHB	BIT(7)

#define PWMxON_LENGTH		BIT(7)

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

/*
 * To read a TWL4030 GPIO module register
 */
static inline int gpio_twl4030_read(u8 address)
{
	u8 data;
	int ret = 0;

	ret = twl_i2c_read_u8(TWL4030_MODULE_GPIO, &data, address);
	return (ret < 0) ? ret : data;
}

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

static u8 cached_leden;

/* The LED lines are open drain outputs ... a FET pulls to GND, so an
 * external pullup is needed.  We could also expose the integrated PWM
 * as a LED brightness control; we initialize it as "always on".
 */
static void twl4030_led_set_value(int led, int value)
{
	u8 mask = LEDEN_LEDAON | LEDEN_LEDAPWM;

	if (led)
		mask <<= 1;

	if (value)
		cached_leden &= ~mask;
	else
		cached_leden |= mask;

	WARN_ON_ONCE(twl_i2c_write_u8(TWL4030_MODULE_LED, cached_leden,
				      TWL4030_LED_LEDEN_REG));
}

static int twl4030_set_gpio_direction(int gpio, int is_input)
{
	u8 d_bnk = gpio >> 3;
	u8 d_msk = BIT(gpio & 0x7);
	u8 reg = 0;
	u8 base = REG_GPIODATADIR1 + d_bnk;
	int ret = 0;

	ret = gpio_twl4030_read(base);
	if (ret >= 0) {
		if (is_input)
			reg = ret & ~d_msk;
		else
			reg = ret | d_msk;

		ret = gpio_twl4030_write(base, reg);
	}
	return ret;
}

static int twl4030_get_gpio_direction(int gpio)
{
	u8 d_bnk = gpio >> 3;
	u8 d_msk = BIT(gpio & 0x7);
	u8 base = REG_GPIODATADIR1 + d_bnk;
	int ret = 0;

	ret = gpio_twl4030_read(base);
	if (ret < 0)
		return ret;

	if (ret & d_msk)
		return GPIO_LINE_DIRECTION_OUT;

	return GPIO_LINE_DIRECTION_IN;
}

static int twl4030_set_gpio_dataout(int gpio, int enable)
{
	u8 d_bnk = gpio >> 3;
	u8 d_msk = BIT(gpio & 0x7);
	u8 base = 0;

	if (enable)
		base = REG_SETGPIODATAOUT1 + d_bnk;
	else
		base = REG_CLEARGPIODATAOUT1 + d_bnk;

	return gpio_twl4030_write(base, d_msk);
}

static int twl4030_get_gpio_datain(int gpio)
{
	u8 d_bnk = gpio >> 3;
	u8 d_off = gpio & 0x7;
	u8 base = 0;
	int ret = 0;

	base = REG_GPIODATAIN1 + d_bnk;
	ret = gpio_twl4030_read(base);
	if (ret > 0)
		ret = (ret >> d_off) & 0x1;

	return ret;
}

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

static int twl_request(struct gpio_chip *chip, unsigned offset)
{
	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
	int status = 0;

	mutex_lock(&priv->mutex);

	/* Support the two LED outputs as output-only GPIOs. */
	if (offset >= TWL4030_GPIO_MAX) {
		u8	ledclr_mask = LEDEN_LEDAON | LEDEN_LEDAEXT
				| LEDEN_LEDAPWM | LEDEN_PWM_LENGTHA;
		u8	reg = TWL4030_PWMAON_REG;

		offset -= TWL4030_GPIO_MAX;
		if (offset) {
			ledclr_mask <<= 1;
			reg = TWL4030_PWMBON_REG;
		}

		/* initialize PWM to always-drive */
		/* Configure PWM OFF register first */
		status = twl_i2c_write_u8(TWL4030_MODULE_LED, 0x7f, reg + 1);
		if (status < 0)
			goto done;

		/* Followed by PWM ON register */
		status = twl_i2c_write_u8(TWL4030_MODULE_LED, 0x7f, reg);
		if (status < 0)
			goto done;

		/* init LED to not-driven (high) */
		status = twl_i2c_read_u8(TWL4030_MODULE_LED, &cached_leden,
					 TWL4030_LED_LEDEN_REG);
		if (status < 0)
			goto done;
		cached_leden &= ~ledclr_mask;
		status = twl_i2c_write_u8(TWL4030_MODULE_LED, cached_leden,
					  TWL4030_LED_LEDEN_REG);
		if (status < 0)
			goto done;

		status = 0;
		goto done;
	}

	/* on first use, turn GPIO module "on" */
	if (!priv->usage_count) {
		struct twl4030_gpio_platform_data *pdata;
		u8 value = MASK_GPIO_CTRL_GPIO_ON;

		/* optionally have the first two GPIOs switch vMMC1
		 * and vMMC2 power supplies based on card presence.
		 */
		pdata = dev_get_platdata(chip->parent);
		if (pdata)
			value |= pdata->mmc_cd & 0x03;

		status = gpio_twl4030_write(REG_GPIO_CTRL, value);
	}

done:
	if (!status)
		priv->usage_count |= BIT(offset);

	mutex_unlock(&priv->mutex);
	return status;
}

static void twl_free(struct gpio_chip *chip, unsigned offset)
{
	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);

	mutex_lock(&priv->mutex);
	if (offset >= TWL4030_GPIO_MAX) {
		twl4030_led_set_value(offset - TWL4030_GPIO_MAX, 1);
		goto out;
	}

	priv->usage_count &= ~BIT(offset);

	/* on last use, switch off GPIO module */
	if (!priv->usage_count)
		gpio_twl4030_write(REG_GPIO_CTRL, 0x0);

out:
	mutex_unlock(&priv->mutex);
}

static int twl_direction_in(struct gpio_chip *chip, unsigned offset)
{
	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
	int ret;

	mutex_lock(&priv->mutex);
	if (offset < TWL4030_GPIO_MAX)
		ret = twl4030_set_gpio_direction(offset, 1);
	else
		ret = -EINVAL;	/* LED outputs can't be set as input */

	if (!ret)
		priv->direction &= ~BIT(offset);

	mutex_unlock(&priv->mutex);

	return ret;
}

static int twl_get(struct gpio_chip *chip, unsigned offset)
{
	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
	int ret;
	int status = 0;

	mutex_lock(&priv->mutex);
	if (!(priv->usage_count & BIT(offset))) {
		ret = -EPERM;
		goto out;
	}

	if (priv->direction & BIT(offset))
		status = priv->out_state & BIT(offset);
	else
		status = twl4030_get_gpio_datain(offset);

	ret = (status < 0) ? status : !!status;
out:
	mutex_unlock(&priv->mutex);
	return ret;
}

static void twl_set(struct gpio_chip *chip, unsigned offset, int value)
{
	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);

	mutex_lock(&priv->mutex);
	if (offset < TWL4030_GPIO_MAX)
		twl4030_set_gpio_dataout(offset, value);
	else
		twl4030_led_set_value(offset - TWL4030_GPIO_MAX, value);

	if (value)
		priv->out_state |= BIT(offset);
	else
		priv->out_state &= ~BIT(offset);

	mutex_unlock(&priv->mutex);
}

static int twl_direction_out(struct gpio_chip *chip, unsigned offset, int value)
{
	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
	int ret = 0;

	mutex_lock(&priv->mutex);
	if (offset < TWL4030_GPIO_MAX) {
		ret = twl4030_set_gpio_direction(offset, 0);
		if (ret) {
			mutex_unlock(&priv->mutex);
			return ret;
		}
	}

	/*
	 *  LED gpios i.e. offset >= TWL4030_GPIO_MAX are always output
	 */

	priv->direction |= BIT(offset);
	mutex_unlock(&priv->mutex);

	twl_set(chip, offset, value);

	return ret;
}

static int twl_get_direction(struct gpio_chip *chip, unsigned offset)
{
	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
	/*
	 * Default GPIO_LINE_DIRECTION_OUT
	 * LED GPIOs >= TWL4030_GPIO_MAX are always output
	 */
	int ret = GPIO_LINE_DIRECTION_OUT;

	mutex_lock(&priv->mutex);
	if (offset < TWL4030_GPIO_MAX) {
		ret = twl4030_get_gpio_direction(offset);
		if (ret) {
			mutex_unlock(&priv->mutex);
			return ret;
		}
	}
	mutex_unlock(&priv->mutex);

	return ret;
}

static int twl_to_irq(struct gpio_chip *chip, unsigned offset)
{
	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);

	return (priv->irq_base && (offset < TWL4030_GPIO_MAX))
		? (priv->irq_base + offset)
		: -EINVAL;
}

static const struct gpio_chip template_chip = {
	.label			= "twl4030",
	.owner			= THIS_MODULE,
	.request		= twl_request,
	.free			= twl_free,
	.direction_input	= twl_direction_in,
	.direction_output	= twl_direction_out,
	.get_direction		= twl_get_direction,
	.get			= twl_get,
	.set			= twl_set,
	.to_irq			= twl_to_irq,
	.can_sleep		= true,
};

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

static int gpio_twl4030_pulls(u32 ups, u32 downs)
{
	u8		message[5];
	unsigned	i, gpio_bit;

	/* For most pins, a pulldown was enabled by default.
	 * We should have data that's specific to this board.
	 */
	for (gpio_bit = 1, i = 0; i < 5; i++) {
		u8		bit_mask;
		unsigned	j;

		for (bit_mask = 0, j = 0; j < 8; j += 2, gpio_bit <<= 1) {
			if (ups & gpio_bit)
				bit_mask |= 1 << (j + 1);
			else if (downs & gpio_bit)
				bit_mask |= 1 << (j + 0);
		}
		message[i] = bit_mask;
	}

	return twl_i2c_write(TWL4030_MODULE_GPIO, message,
				REG_GPIOPUPDCTR1, 5);
}

static int gpio_twl4030_debounce(u32 debounce, u8 mmc_cd)
{
	u8		message[3];

	/* 30 msec of debouncing is always used for MMC card detect,
	 * and is optional for everything else.
	 */
	message[0] = (debounce & 0xff) | (mmc_cd & 0x03);
	debounce >>= 8;
	message[1] = (debounce & 0xff);
	debounce >>= 8;
	message[2] = (debounce & 0x03);

	return twl_i2c_write(TWL4030_MODULE_GPIO, message,
				REG_GPIO_DEBEN1, 3);
}

static struct twl4030_gpio_platform_data *of_gpio_twl4030(struct device *dev,
				struct twl4030_gpio_platform_data *pdata)
{
	struct twl4030_gpio_platform_data *omap_twl_info;

	omap_twl_info = devm_kzalloc(dev, sizeof(*omap_twl_info), GFP_KERNEL);
	if (!omap_twl_info)
		return NULL;

	if (pdata)
		*omap_twl_info = *pdata;

	omap_twl_info->use_leds = of_property_read_bool(dev->of_node,
			"ti,use-leds");

	of_property_read_u32(dev->of_node, "ti,debounce",
			     &omap_twl_info->debounce);
	of_property_read_u32(dev->of_node, "ti,mmc-cd",
			     (u32 *)&omap_twl_info->mmc_cd);
	of_property_read_u32(dev->of_node, "ti,pullups",
			     &omap_twl_info->pullups);
	of_property_read_u32(dev->of_node, "ti,pulldowns",
			     &omap_twl_info->pulldowns);

	return omap_twl_info;
}

/* Cannot use as gpio_twl4030_probe() calls us */
static int gpio_twl4030_remove(struct platform_device *pdev)
{
	struct gpio_twl4030_priv *priv = platform_get_drvdata(pdev);

	gpiochip_remove(&priv->gpio_chip);

	/* REVISIT no support yet for deregistering all the IRQs */
	WARN_ON(!is_module());
	return 0;
}

static int gpio_twl4030_probe(struct platform_device *pdev)
{
	struct twl4030_gpio_platform_data *pdata = dev_get_platdata(&pdev->dev);
	struct device_node *node = pdev->dev.of_node;
	struct gpio_twl4030_priv *priv;
	int ret, irq_base;

	priv = devm_kzalloc(&pdev->dev, sizeof(struct gpio_twl4030_priv),
			    GFP_KERNEL);
	if (!priv)
		return -ENOMEM;

	/* maybe setup IRQs */
	if (is_module()) {
		dev_err(&pdev->dev, "can't dispatch IRQs from modules\n");
		goto no_irqs;
	}

	irq_base = devm_irq_alloc_descs(&pdev->dev, -1,
					0, TWL4030_GPIO_MAX, 0);
	if (irq_base < 0) {
		dev_err(&pdev->dev, "Failed to alloc irq_descs\n");
		return irq_base;
	}

	irq_domain_add_legacy(node, TWL4030_GPIO_MAX, irq_base, 0,
			      &irq_domain_simple_ops, NULL);

	ret = twl4030_sih_setup(&pdev->dev, TWL4030_MODULE_GPIO, irq_base);
	if (ret < 0)
		return ret;

	priv->irq_base = irq_base;

no_irqs:
	priv->gpio_chip = template_chip;
	priv->gpio_chip.base = -1;
	priv->gpio_chip.ngpio = TWL4030_GPIO_MAX;
	priv->gpio_chip.parent = &pdev->dev;

	mutex_init(&priv->mutex);

	if (node)
		pdata = of_gpio_twl4030(&pdev->dev, pdata);

	if (pdata == NULL) {
		dev_err(&pdev->dev, "Platform data is missing\n");
		return -ENXIO;
	}

	/*
	 * NOTE:  boards may waste power if they don't set pullups
	 * and pulldowns correctly ... default for non-ULPI pins is
	 * pulldown, and some other pins may have external pullups
	 * or pulldowns.  Careful!
	 */
	ret = gpio_twl4030_pulls(pdata->pullups, pdata->pulldowns);
	if (ret)
		dev_dbg(&pdev->dev, "pullups %.05x %.05x --> %d\n",
			pdata->pullups, pdata->pulldowns, ret);

	ret = gpio_twl4030_debounce(pdata->debounce, pdata->mmc_cd);
	if (ret)
		dev_dbg(&pdev->dev, "debounce %.03x %.01x --> %d\n",
			pdata->debounce, pdata->mmc_cd, ret);

	/*
	 * NOTE: we assume VIBRA_CTL.VIBRA_EN, in MODULE_AUDIO_VOICE,
	 * is (still) clear if use_leds is set.
	 */
	if (pdata->use_leds)
		priv->gpio_chip.ngpio += 2;

	ret = gpiochip_add_data(&priv->gpio_chip, priv);
	if (ret < 0) {
		dev_err(&pdev->dev, "could not register gpiochip, %d\n", ret);
		priv->gpio_chip.ngpio = 0;
		gpio_twl4030_remove(pdev);
		goto out;
	}

	platform_set_drvdata(pdev, priv);

	if (pdata->setup) {
		int status;

		status = pdata->setup(&pdev->dev, priv->gpio_chip.base,
				      TWL4030_GPIO_MAX);
		if (status)
			dev_dbg(&pdev->dev, "setup --> %d\n", status);
	}

out:
	return ret;
}

static const struct of_device_id twl_gpio_match[] = {
	{ .compatible = "ti,twl4030-gpio", },
	{ },
};
MODULE_DEVICE_TABLE(of, twl_gpio_match);

/* Note:  this hardware lives inside an I2C-based multi-function device. */
MODULE_ALIAS("platform:twl4030_gpio");

static struct platform_driver gpio_twl4030_driver = {
	.driver = {
		.name	= "twl4030_gpio",
		.of_match_table = twl_gpio_match,
	},
	.probe		= gpio_twl4030_probe,
	.remove		= gpio_twl4030_remove,
};

static int __init gpio_twl4030_init(void)
{
	return platform_driver_register(&gpio_twl4030_driver);
}
subsys_initcall(gpio_twl4030_init);

static void __exit gpio_twl4030_exit(void)
{
	platform_driver_unregister(&gpio_twl4030_driver);
}
module_exit(gpio_twl4030_exit);

MODULE_AUTHOR("Texas Instruments, Inc.");
MODULE_DESCRIPTION("GPIO interface for TWL4030");
MODULE_LICENSE("GPL");
Commit	Line	Data
ecb07684	1	// SPDX-License-Identifier: GPL-2.0+
e9d35947	2	/*
c103de24	3	* Access to GPIOs on TWL4030/TPS659x0 chips
e9d35947 DB	4	*
	5	* Copyright (C) 2006-2007 Texas Instruments, Inc.
	6	* Copyright (C) 2006 MontaVista Software, Inc.
	7	*
	8	* Code re-arranged and cleaned up by:
	9	* Syed Mohammed Khasim <x0khasim@ti.com>
	10	*
	11	* Initial Code:
	12	* Andy Lowe / Nishanth Menon
e9d35947 DB	13	*/
	14
	15	#include <linux/module.h>
	16	#include <linux/init.h>
	17	#include <linux/interrupt.h>
	18	#include <linux/kthread.h>
	19	#include <linux/irq.h>
ba21d55f	20	#include <linux/gpio/driver.h>
e9d35947	21	#include <linux/platform_device.h>
b8589e2a BC	22	#include <linux/of.h>
b8589e2a BC	23	#include <linux/irqdomain.h>
e9d35947	24
a2054256	25	#include <linux/mfd/twl.h>
e9d35947	26
e9d35947 DB	27	/*
	28	* The GPIO "subchip" supports 18 GPIOs which can be configured as
	29	* inputs or outputs, with pullups or pulldowns on each pin. Each
	30	* GPIO can trigger interrupts on either or both edges.
	31	*
	32	* GPIO interrupts can be fed to either of two IRQ lines; this is
	33	* intended to support multiple hosts.
	34	*
	35	* There are also two LED pins used sometimes as output-only GPIOs.
	36	*/
	37
e9d35947 DB	38	/* genirq interfaces are not available to modules */
	39	#ifdef MODULE
	40	#define is_module() true
	41	#else
	42	#define is_module() false
	43	#endif
	44
	45	/* GPIO_CTRL Fields */
	46	#define MASK_GPIO_CTRL_GPIO0CD1 BIT(0)
	47	#define MASK_GPIO_CTRL_GPIO1CD2 BIT(1)
	48	#define MASK_GPIO_CTRL_GPIO_ON BIT(2)
	49
	50	/* Mask for GPIO registers when aggregated into a 32-bit integer */
	51	#define GPIO_32_MASK 0x0003ffff
	52
72c7901e PU	53	struct gpio_twl4030_priv {
72c7901e PU	54	struct gpio_chip gpio_chip;
c111feab	55	struct mutex mutex;
72c7901e PU	56	int irq_base;
72c7901e PU	57
c111feab	58	/* Bitfields for state caching */
72c7901e	59	unsigned int usage_count;
c111feab PU	60	unsigned int direction;
c111feab PU	61	unsigned int out_state;
72c7901e	62	};
e9d35947 DB	63
	64	/----------------------------------------------------------------------/
	65
	66	/*
	67	* To configure TWL4030 GPIO module registers
	68	*/
	69	static inline int gpio_twl4030_write(u8 address, u8 data)
	70	{
fc7b92fc	71	return twl_i2c_write_u8(TWL4030_MODULE_GPIO, data, address);
e9d35947 DB	72	}
	73
	74	/----------------------------------------------------------------------/
	75
	76	/*
9859eb99	77	* LED register offsets from TWL_MODULE_LED base
e9d35947 DB	78	* PWMs A and B are dedicated to LEDs A and B, respectively.
	79	*/
	80
9859eb99 PU	81	#define TWL4030_LED_LEDEN_REG 0x00
	82	#define TWL4030_PWMAON_REG 0x01
	83	#define TWL4030_PWMAOFF_REG 0x02
	84	#define TWL4030_PWMBON_REG 0x03
	85	#define TWL4030_PWMBOFF_REG 0x04
e9d35947 DB	86
	87	/* LEDEN bits */
	88	#define LEDEN_LEDAON BIT(0)
	89	#define LEDEN_LEDBON BIT(1)
	90	#define LEDEN_LEDAEXT BIT(2)
	91	#define LEDEN_LEDBEXT BIT(3)
	92	#define LEDEN_LEDAPWM BIT(4)
	93	#define LEDEN_LEDBPWM BIT(5)
	94	#define LEDEN_PWM_LENGTHA BIT(6)
	95	#define LEDEN_PWM_LENGTHB BIT(7)
	96
e9d35947 DB	97	#define PWMxON_LENGTH BIT(7)
	98
	99	/----------------------------------------------------------------------/
	100
	101	/*
	102	* To read a TWL4030 GPIO module register
	103	*/
	104	static inline int gpio_twl4030_read(u8 address)
	105	{
	106	u8 data;
	107	int ret = 0;
	108
fc7b92fc	109	ret = twl_i2c_read_u8(TWL4030_MODULE_GPIO, &data, address);
e9d35947 DB	110	return (ret < 0) ? ret : data;
	111	}
	112
	113	/----------------------------------------------------------------------/
	114
c111feab	115	static u8 cached_leden;
e9d35947 DB	116
	117	/* The LED lines are open drain outputs ... a FET pulls to GND, so an
	118	* external pullup is needed. We could also expose the integrated PWM
	119	* as a LED brightness control; we initialize it as "always on".
	120	*/
	121	static void twl4030_led_set_value(int led, int value)
	122	{
	123	u8 mask = LEDEN_LEDAON \| LEDEN_LEDAPWM;
e9d35947 DB	124
	125	if (led)
	126	mask <<= 1;
	127
e9d35947 DB	128	if (value)
	129	cached_leden &= ~mask;
	130	else
	131	cached_leden \|= mask;
fd0f885b AS	132
	133	WARN_ON_ONCE(twl_i2c_write_u8(TWL4030_MODULE_LED, cached_leden,
	134	TWL4030_LED_LEDEN_REG));
e9d35947 DB	135	}
	136
	137	static int twl4030_set_gpio_direction(int gpio, int is_input)
	138	{
	139	u8 d_bnk = gpio >> 3;
	140	u8 d_msk = BIT(gpio & 0x7);
	141	u8 reg = 0;
	142	u8 base = REG_GPIODATADIR1 + d_bnk;
	143	int ret = 0;
	144
e9d35947 DB	145	ret = gpio_twl4030_read(base);
	146	if (ret >= 0) {
	147	if (is_input)
	148	reg = ret & ~d_msk;
	149	else
	150	reg = ret \| d_msk;
	151
	152	ret = gpio_twl4030_write(base, reg);
	153	}
e9d35947 DB	154	return ret;
	155	}
	156
ab8c1e82 LW	157	static int twl4030_get_gpio_direction(int gpio)
	158	{
	159	u8 d_bnk = gpio >> 3;
	160	u8 d_msk = BIT(gpio & 0x7);
	161	u8 base = REG_GPIODATADIR1 + d_bnk;
	162	int ret = 0;
	163
	164	ret = gpio_twl4030_read(base);
	165	if (ret < 0)
	166	return ret;
	167
e42615ec MV	168	if (ret & d_msk)
e42615ec MV	169	return GPIO_LINE_DIRECTION_OUT;
ab8c1e82	170
e42615ec	171	return GPIO_LINE_DIRECTION_IN;
ab8c1e82 LW	172	}
ab8c1e82 LW	173
e9d35947 DB	174	static int twl4030_set_gpio_dataout(int gpio, int enable)
	175	{
	176	u8 d_bnk = gpio >> 3;
	177	u8 d_msk = BIT(gpio & 0x7);
	178	u8 base = 0;
	179
	180	if (enable)
	181	base = REG_SETGPIODATAOUT1 + d_bnk;
	182	else
	183	base = REG_CLEARGPIODATAOUT1 + d_bnk;
	184
	185	return gpio_twl4030_write(base, d_msk);
	186	}
	187
	188	static int twl4030_get_gpio_datain(int gpio)
	189	{
	190	u8 d_bnk = gpio >> 3;
	191	u8 d_off = gpio & 0x7;
	192	u8 base = 0;
	193	int ret = 0;
	194
e9d35947 DB	195	base = REG_GPIODATAIN1 + d_bnk;
	196	ret = gpio_twl4030_read(base);
	197	if (ret > 0)
	198	ret = (ret >> d_off) & 0x1;
	199
	200	return ret;
	201	}
	202
e9d35947 DB	203	/----------------------------------------------------------------------/
	204
	205	static int twl_request(struct gpio_chip *chip, unsigned offset)
	206	{
231a8680	207	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
e9d35947 DB	208	int status = 0;
e9d35947 DB	209
c111feab	210	mutex_lock(&priv->mutex);
e9d35947 DB	211
	212	/* Support the two LED outputs as output-only GPIOs. */
	213	if (offset >= TWL4030_GPIO_MAX) {
	214	u8 ledclr_mask = LEDEN_LEDAON \| LEDEN_LEDAEXT
	215	\| LEDEN_LEDAPWM \| LEDEN_PWM_LENGTHA;
9859eb99	216	u8 reg = TWL4030_PWMAON_REG;
e9d35947 DB	217
	218	offset -= TWL4030_GPIO_MAX;
	219	if (offset) {
	220	ledclr_mask <<= 1;
9859eb99	221	reg = TWL4030_PWMBON_REG;
e9d35947 DB	222	}
	223
	224	/* initialize PWM to always-drive */
9859eb99 PU	225	/* Configure PWM OFF register first */
9859eb99 PU	226	status = twl_i2c_write_u8(TWL4030_MODULE_LED, 0x7f, reg + 1);
e9d35947 DB	227	if (status < 0)
e9d35947 DB	228	goto done;
9859eb99 PU	229
	230	/* Followed by PWM ON register */
	231	status = twl_i2c_write_u8(TWL4030_MODULE_LED, 0x7f, reg);
e9d35947 DB	232	if (status < 0)
	233	goto done;
	234
	235	/* init LED to not-driven (high) */
9859eb99 PU	236	status = twl_i2c_read_u8(TWL4030_MODULE_LED, &cached_leden,
9859eb99 PU	237	TWL4030_LED_LEDEN_REG);
e9d35947 DB	238	if (status < 0)
	239	goto done;
	240	cached_leden &= ~ledclr_mask;
9859eb99 PU	241	status = twl_i2c_write_u8(TWL4030_MODULE_LED, cached_leden,
9859eb99 PU	242	TWL4030_LED_LEDEN_REG);
e9d35947 DB	243	if (status < 0)
	244	goto done;
	245
	246	status = 0;
	247	goto done;
	248	}
	249
	250	/* on first use, turn GPIO module "on" */
72c7901e	251	if (!priv->usage_count) {
e9d35947 DB	252	struct twl4030_gpio_platform_data *pdata;
	253	u8 value = MASK_GPIO_CTRL_GPIO_ON;
	254
	255	/* optionally have the first two GPIOs switch vMMC1
	256	* and vMMC2 power supplies based on card presence.
	257	*/
58383c78	258	pdata = dev_get_platdata(chip->parent);
b8589e2a BC	259	if (pdata)
b8589e2a BC	260	value \|= pdata->mmc_cd & 0x03;
e9d35947 DB	261
	262	status = gpio_twl4030_write(REG_GPIO_CTRL, value);
	263	}
	264
72c7901e	265	done:
e9d35947	266	if (!status)
72c7901e	267	priv->usage_count \|= BIT(offset);
e9d35947	268
c111feab	269	mutex_unlock(&priv->mutex);
e9d35947 DB	270	return status;
	271	}
	272
	273	static void twl_free(struct gpio_chip *chip, unsigned offset)
	274	{
231a8680	275	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
72c7901e	276
c111feab	277	mutex_lock(&priv->mutex);
e9d35947 DB	278	if (offset >= TWL4030_GPIO_MAX) {
e9d35947 DB	279	twl4030_led_set_value(offset - TWL4030_GPIO_MAX, 1);
c111feab	280	goto out;
e9d35947 DB	281	}
e9d35947 DB	282
72c7901e	283	priv->usage_count &= ~BIT(offset);
e9d35947 DB	284
e9d35947 DB	285	/* on last use, switch off GPIO module */
72c7901e	286	if (!priv->usage_count)
e9d35947 DB	287	gpio_twl4030_write(REG_GPIO_CTRL, 0x0);
e9d35947 DB	288
c111feab PU	289	out:
c111feab PU	290	mutex_unlock(&priv->mutex);
e9d35947 DB	291	}
	292
	293	static int twl_direction_in(struct gpio_chip *chip, unsigned offset)
	294	{
231a8680	295	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
c111feab PU	296	int ret;
	297
	298	mutex_lock(&priv->mutex);
	299	if (offset < TWL4030_GPIO_MAX)
	300	ret = twl4030_set_gpio_direction(offset, 1);
	301	else
f5837ec1	302	ret = -EINVAL; /* LED outputs can't be set as input */
c111feab PU	303
	304	if (!ret)
	305	priv->direction &= ~BIT(offset);
	306
	307	mutex_unlock(&priv->mutex);
	308
	309	return ret;
e9d35947 DB	310	}
	311
	312	static int twl_get(struct gpio_chip *chip, unsigned offset)
	313	{
231a8680	314	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
c111feab	315	int ret;
e9d35947 DB	316	int status = 0;
e9d35947 DB	317
c111feab PU	318	mutex_lock(&priv->mutex);
	319	if (!(priv->usage_count & BIT(offset))) {
	320	ret = -EPERM;
	321	goto out;
	322	}
72c7901e	323
c111feab PU	324	if (priv->direction & BIT(offset))
c111feab PU	325	status = priv->out_state & BIT(offset);
e9d35947	326	else
c111feab	327	status = twl4030_get_gpio_datain(offset);
72c7901e	328
9e8014fc	329	ret = (status < 0) ? status : !!status;
c111feab PU	330	out:
	331	mutex_unlock(&priv->mutex);
	332	return ret;
e9d35947 DB	333	}
e9d35947 DB	334
c111feab	335	static void twl_set(struct gpio_chip *chip, unsigned offset, int value)
e9d35947	336	{
231a8680	337	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
c111feab PU	338
	339	mutex_lock(&priv->mutex);
	340	if (offset < TWL4030_GPIO_MAX)
e9d35947	341	twl4030_set_gpio_dataout(offset, value);
c111feab	342	else
e9d35947	343	twl4030_led_set_value(offset - TWL4030_GPIO_MAX, value);
c111feab PU	344
	345	if (value)
	346	priv->out_state \|= BIT(offset);
	347	else
	348	priv->out_state &= ~BIT(offset);
	349
	350	mutex_unlock(&priv->mutex);
e9d35947 DB	351	}
e9d35947 DB	352
c111feab	353	static int twl_direction_out(struct gpio_chip *chip, unsigned offset, int value)
e9d35947	354	{
231a8680	355	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
f5837ec1	356	int ret = 0;
c111feab PU	357
c111feab PU	358	mutex_lock(&priv->mutex);
f5837ec1	359	if (offset < TWL4030_GPIO_MAX) {
0b2aa8be	360	ret = twl4030_set_gpio_direction(offset, 0);
f5837ec1 RQ	361	if (ret) {
	362	mutex_unlock(&priv->mutex);
	363	return ret;
	364	}
	365	}
	366
	367	/*
	368	* LED gpios i.e. offset >= TWL4030_GPIO_MAX are always output
	369	*/
c111feab PU	370
	371	priv->direction \|= BIT(offset);
	372	mutex_unlock(&priv->mutex);
	373
	374	twl_set(chip, offset, value);
	375
0b2aa8be	376	return ret;
e9d35947 DB	377	}
e9d35947 DB	378
ab8c1e82 LW	379	static int twl_get_direction(struct gpio_chip *chip, unsigned offset)
	380	{
	381	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
	382	/*
e42615ec	383	* Default GPIO_LINE_DIRECTION_OUT
ab8c1e82 LW	384	* LED GPIOs >= TWL4030_GPIO_MAX are always output
ab8c1e82 LW	385	*/
e42615ec	386	int ret = GPIO_LINE_DIRECTION_OUT;
ab8c1e82 LW	387
	388	mutex_lock(&priv->mutex);
	389	if (offset < TWL4030_GPIO_MAX) {
	390	ret = twl4030_get_gpio_direction(offset);
	391	if (ret) {
	392	mutex_unlock(&priv->mutex);
	393	return ret;
	394	}
	395	}
	396	mutex_unlock(&priv->mutex);
	397
	398	return ret;
	399	}
	400
e9d35947 DB	401	static int twl_to_irq(struct gpio_chip *chip, unsigned offset)
e9d35947 DB	402	{
231a8680	403	struct gpio_twl4030_priv *priv = gpiochip_get_data(chip);
72c7901e PU	404
	405	return (priv->irq_base && (offset < TWL4030_GPIO_MAX))
	406	? (priv->irq_base + offset)
e9d35947 DB	407	: -EINVAL;
	408	}
	409
e35b5ab0	410	static const struct gpio_chip template_chip = {
e9d35947 DB	411	.label = "twl4030",
	412	.owner = THIS_MODULE,
	413	.request = twl_request,
	414	.free = twl_free,
	415	.direction_input = twl_direction_in,
e9d35947	416	.direction_output = twl_direction_out,
ab8c1e82 LW	417	.get_direction = twl_get_direction,
ab8c1e82 LW	418	.get = twl_get,
e9d35947 DB	419	.set = twl_set,
e9d35947 DB	420	.to_irq = twl_to_irq,
9fb1f39e	421	.can_sleep = true,
e9d35947 DB	422	};
	423
	424	/----------------------------------------------------------------------/
	425
3836309d	426	static int gpio_twl4030_pulls(u32 ups, u32 downs)
e9d35947	427	{
14591d88	428	u8 message[5];
e9d35947 DB	429	unsigned i, gpio_bit;
	430
	431	/* For most pins, a pulldown was enabled by default.
	432	* We should have data that's specific to this board.
	433	*/
14591d88	434	for (gpio_bit = 1, i = 0; i < 5; i++) {
e9d35947 DB	435	u8 bit_mask;
	436	unsigned j;
	437
	438	for (bit_mask = 0, j = 0; j < 8; j += 2, gpio_bit <<= 1) {
	439	if (ups & gpio_bit)
	440	bit_mask \|= 1 << (j + 1);
	441	else if (downs & gpio_bit)
	442	bit_mask \|= 1 << (j + 0);
	443	}
	444	message[i] = bit_mask;
	445	}
	446
fc7b92fc	447	return twl_i2c_write(TWL4030_MODULE_GPIO, message,
e9d35947 DB	448	REG_GPIOPUPDCTR1, 5);
	449	}
	450
3836309d	451	static int gpio_twl4030_debounce(u32 debounce, u8 mmc_cd)
cabb3fc4	452	{
14591d88	453	u8 message[3];
cabb3fc4 DB	454
	455	/* 30 msec of debouncing is always used for MMC card detect,
	456	* and is optional for everything else.
	457	*/
14591d88	458	message[0] = (debounce & 0xff) \| (mmc_cd & 0x03);
cabb3fc4	459	debounce >>= 8;
14591d88	460	message[1] = (debounce & 0xff);
cabb3fc4	461	debounce >>= 8;
14591d88	462	message[2] = (debounce & 0x03);
cabb3fc4	463
fc7b92fc	464	return twl_i2c_write(TWL4030_MODULE_GPIO, message,
cabb3fc4 DB	465	REG_GPIO_DEBEN1, 3);
	466	}
	467
fd3a5d5b TL	468	static struct twl4030_gpio_platform_data of_gpio_twl4030(struct device dev,
fd3a5d5b TL	469	struct twl4030_gpio_platform_data *pdata)
f74ce8fb FV	470	{
	471	struct twl4030_gpio_platform_data *omap_twl_info;
	472
	473	omap_twl_info = devm_kzalloc(dev, sizeof(*omap_twl_info), GFP_KERNEL);
	474	if (!omap_twl_info)
	475	return NULL;
	476
fd3a5d5b TL	477	if (pdata)
	478	omap_twl_info = pdata;
	479
f74ce8fb FV	480	omap_twl_info->use_leds = of_property_read_bool(dev->of_node,
	481	"ti,use-leds");
	482
	483	of_property_read_u32(dev->of_node, "ti,debounce",
	484	&omap_twl_info->debounce);
	485	of_property_read_u32(dev->of_node, "ti,mmc-cd",
	486	(u32 *)&omap_twl_info->mmc_cd);
	487	of_property_read_u32(dev->of_node, "ti,pullups",
	488	&omap_twl_info->pullups);
	489	of_property_read_u32(dev->of_node, "ti,pulldowns",
	490	&omap_twl_info->pulldowns);
	491
	492	return omap_twl_info;
	493	}
	494
97147911 UKK	495	/* Cannot use as gpio_twl4030_probe() calls us */
	496	static int gpio_twl4030_remove(struct platform_device *pdev)
	497	{
	498	struct gpio_twl4030_priv *priv = platform_get_drvdata(pdev);
	499
	500	gpiochip_remove(&priv->gpio_chip);
	501
	502	/* REVISIT no support yet for deregistering all the IRQs */
	503	WARN_ON(!is_module());
	504	return 0;
	505	}
	506
3836309d	507	static int gpio_twl4030_probe(struct platform_device *pdev)
e9d35947	508	{
e56aee18	509	struct twl4030_gpio_platform_data *pdata = dev_get_platdata(&pdev->dev);
b8589e2a	510	struct device_node *node = pdev->dev.of_node;
72c7901e	511	struct gpio_twl4030_priv *priv;
2d9dd99b	512	int ret, irq_base;
e9d35947	513
72c7901e PU	514	priv = devm_kzalloc(&pdev->dev, sizeof(struct gpio_twl4030_priv),
	515	GFP_KERNEL);
	516	if (!priv)
	517	return -ENOMEM;
	518
e9d35947	519	/* maybe setup IRQs */
2d9dd99b BC	520	if (is_module()) {
	521	dev_err(&pdev->dev, "can't dispatch IRQs from modules\n");
	522	goto no_irqs;
	523	}
	524
9bc81137 BG	525	irq_base = devm_irq_alloc_descs(&pdev->dev, -1,
9bc81137 BG	526	0, TWL4030_GPIO_MAX, 0);
2d9dd99b BC	527	if (irq_base < 0) {
	528	dev_err(&pdev->dev, "Failed to alloc irq_descs\n");
	529	return irq_base;
e9d35947 DB	530	}
e9d35947 DB	531
b8589e2a BC	532	irq_domain_add_legacy(node, TWL4030_GPIO_MAX, irq_base, 0,
	533	&irq_domain_simple_ops, NULL);
	534
2d9dd99b BC	535	ret = twl4030_sih_setup(&pdev->dev, TWL4030_MODULE_GPIO, irq_base);
	536	if (ret < 0)
	537	return ret;
	538
72c7901e	539	priv->irq_base = irq_base;
2d9dd99b	540
e9d35947	541	no_irqs:
72c7901e PU	542	priv->gpio_chip = template_chip;
	543	priv->gpio_chip.base = -1;
	544	priv->gpio_chip.ngpio = TWL4030_GPIO_MAX;
58383c78	545	priv->gpio_chip.parent = &pdev->dev;
e9d35947	546
c111feab PU	547	mutex_init(&priv->mutex);
c111feab PU	548
f74ce8fb	549	if (node)
fd3a5d5b	550	pdata = of_gpio_twl4030(&pdev->dev, pdata);
b8589e2a	551
f74ce8fb FV	552	if (pdata == NULL) {
	553	dev_err(&pdev->dev, "Platform data is missing\n");
	554	return -ENXIO;
b8589e2a	555	}
e9d35947	556
f74ce8fb FV	557	/*
	558	* NOTE: boards may waste power if they don't set pullups
	559	* and pulldowns correctly ... default for non-ULPI pins is
	560	* pulldown, and some other pins may have external pullups
	561	* or pulldowns. Careful!
	562	*/
	563	ret = gpio_twl4030_pulls(pdata->pullups, pdata->pulldowns);
	564	if (ret)
	565	dev_dbg(&pdev->dev, "pullups %.05x %.05x --> %d\n",
	566	pdata->pullups, pdata->pulldowns, ret);
	567
	568	ret = gpio_twl4030_debounce(pdata->debounce, pdata->mmc_cd);
	569	if (ret)
	570	dev_dbg(&pdev->dev, "debounce %.03x %.01x --> %d\n",
	571	pdata->debounce, pdata->mmc_cd, ret);
	572
	573	/*
	574	* NOTE: we assume VIBRA_CTL.VIBRA_EN, in MODULE_AUDIO_VOICE,
	575	* is (still) clear if use_leds is set.
	576	*/
	577	if (pdata->use_leds)
72c7901e	578	priv->gpio_chip.ngpio += 2;
f74ce8fb	579
231a8680	580	ret = gpiochip_add_data(&priv->gpio_chip, priv);
e9d35947	581	if (ret < 0) {
2d9dd99b	582	dev_err(&pdev->dev, "could not register gpiochip, %d\n", ret);
72c7901e	583	priv->gpio_chip.ngpio = 0;
e9d35947	584	gpio_twl4030_remove(pdev);
a940d9a1 TL	585	goto out;
	586	}
	587
72c7901e	588	platform_set_drvdata(pdev, priv);
a940d9a1	589
fe5e23d3	590	if (pdata->setup) {
e9d35947 DB	591	int status;
e9d35947 DB	592
72c7901e PU	593	status = pdata->setup(&pdev->dev, priv->gpio_chip.base,
72c7901e PU	594	TWL4030_GPIO_MAX);
e9d35947 DB	595	if (status)
	596	dev_dbg(&pdev->dev, "setup --> %d\n", status);
	597	}
	598
a940d9a1	599	out:
e9d35947 DB	600	return ret;
	601	}
	602
b8589e2a BC	603	static const struct of_device_id twl_gpio_match[] = {
	604	{ .compatible = "ti,twl4030-gpio", },
	605	{ },
	606	};
	607	MODULE_DEVICE_TABLE(of, twl_gpio_match);
	608
e9d35947 DB	609	/* Note: this hardware lives inside an I2C-based multi-function device. */
	610	MODULE_ALIAS("platform:twl4030_gpio");
	611
	612	static struct platform_driver gpio_twl4030_driver = {
b8589e2a BC	613	.driver = {
b8589e2a BC	614	.name = "twl4030_gpio",
e5560af4	615	.of_match_table = twl_gpio_match,
b8589e2a	616	},
e9d35947	617	.probe = gpio_twl4030_probe,
46c529cf	618	.remove = gpio_twl4030_remove,
e9d35947 DB	619	};
	620
	621	static int __init gpio_twl4030_init(void)
	622	{
	623	return platform_driver_register(&gpio_twl4030_driver);
	624	}
	625	subsys_initcall(gpio_twl4030_init);
	626
	627	static void __exit gpio_twl4030_exit(void)
	628	{
	629	platform_driver_unregister(&gpio_twl4030_driver);
	630	}
	631	module_exit(gpio_twl4030_exit);
	632
	633	MODULE_AUTHOR("Texas Instruments, Inc.");
	634	MODULE_DESCRIPTION("GPIO interface for TWL4030");
	635	MODULE_LICENSE("GPL");