[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/machine.h>
#include <linux/gpio/driver.h>
#include <linux/gpio/consumer.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 *omap_twl_info;

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

	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;
}

/* Called from the registered devm action */
static void gpio_twl4030_power_off_action(void *data)
{
	struct gpio_desc *d = data;

	gpiod_unexport(d);
	gpiochip_free_own_desc(d);
}

static int gpio_twl4030_probe(struct platform_device *pdev)
{
	struct twl4030_gpio_platform_data *pdata;
	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);

	pdata = of_gpio_twl4030(&pdev->dev);
	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 = devm_gpiochip_add_data(&pdev->dev, &priv->gpio_chip, priv);
	if (ret < 0) {
		dev_err(&pdev->dev, "could not register gpiochip, %d\n", ret);
		priv->gpio_chip.ngpio = 0;
		return ret;
	}

	/*
	 * Special quirk for the OMAP3 to hog and export a WLAN power
	 * GPIO.
	 */
	if (IS_ENABLED(CONFIG_ARCH_OMAP3) &&
	    of_machine_is_compatible("compulab,omap3-sbc-t3730")) {
		struct gpio_desc *d;

		d = gpiochip_request_own_desc(&priv->gpio_chip,
						 2, "wlan pwr",
						 GPIO_ACTIVE_HIGH,
						 GPIOD_OUT_HIGH);
		if (IS_ERR(d))
			return dev_err_probe(&pdev->dev, PTR_ERR(d),
					     "unable to hog wlan pwr GPIO\n");

		gpiod_export(d, 0);

		ret = devm_add_action_or_reset(&pdev->dev, gpio_twl4030_power_off_action, d);
		if (ret)
			return dev_err_probe(&pdev->dev, ret,
					     "failed to install power off handler\n");

	}

	return 0;
}

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,
};

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