[net-next-2.6.git] / include / linux / i2c / sx150x.h

/*
 * Driver for the Semtech SX150x I2C GPIO Expanders
 *
 * Copyright (c) 2010, Code Aurora Forum. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 and
 * only version 2 as published by the Free Software Foundation.
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */
#ifndef __LINUX_I2C_SX150X_H
#define __LINUX_I2C_SX150X_H

/**
 * struct sx150x_platform_data - config data for SX150x driver
 * @gpio_base: The index number of the first GPIO assigned to this
 *             GPIO expander.  The expander will create a block of
 *             consecutively numbered gpios beginning at the given base,
 *             with the size of the block depending on the model of the
 *             expander chip.
 * @oscio_is_gpo: If set to true, the driver will configure OSCIO as a GPO
 *                instead of as an oscillator, increasing the size of the
 *                GP(I)O pool created by this expander by one.  The
 *                output-only GPO pin will be added at the end of the block.
 * @io_pullup_ena: A bit-mask which enables or disables the pull-up resistor
 *                 for each IO line in the expander.  Setting the bit at
 *                 position n will enable the pull-up for the IO at
 *                 the corresponding offset.  For chips with fewer than
 *                 16 IO pins, high-end bits are ignored.
 * @io_pulldn_ena: A bit-mask which enables-or disables the pull-down
 *                 resistor for each IO line in the expander. Setting the
 *                 bit at position n will enable the pull-down for the IO at
 *                 the corresponding offset.  For chips with fewer than
 *                 16 IO pins, high-end bits are ignored.
 * @io_open_drain_ena: A bit-mask which enables-or disables open-drain
 *                     operation for each IO line in the expander. Setting the
 *                     bit at position n enables open-drain operation for
 *                     the IO at the corresponding offset.  Clearing the bit
 *                     enables regular push-pull operation for that IO.
 *                     For chips with fewer than 16 IO pins, high-end bits
 *                     are ignored.
 * @io_polarity: A bit-mask which enables polarity inversion for each IO line
 *               in the expander.  Setting the bit at position n inverts
 *               the polarity of that IO line, while clearing it results
 *               in normal polarity. For chips with fewer than 16 IO pins,
 *               high-end bits are ignored.
 * @irq_summary: The 'summary IRQ' line to which the GPIO expander's INT line
 *               is connected, via which it reports interrupt events
 *               across all GPIO lines.  This must be a real,
 *               pre-existing IRQ line.
 *               Setting this value < 0 disables the irq_chip functionality
 *               of the driver.
 * @irq_base: The first 'virtual IRQ' line at which our block of GPIO-based
 *            IRQ lines will appear.  Similarly to gpio_base, the expander
 *            will create a block of irqs beginning at this number.
 *            This value is ignored if irq_summary is < 0.
 * @reset_during_probe: If set to true, the driver will trigger a full
 *                      reset of the chip at the beginning of the probe
 *                      in order to place it in a known state.
 */
struct sx150x_platform_data {
	unsigned gpio_base;
	bool     oscio_is_gpo;
	u16      io_pullup_ena;
	u16      io_pulldn_ena;
	u16      io_open_drain_ena;
	u16      io_polarity;
	int      irq_summary;
	unsigned irq_base;
	bool     reset_during_probe;
};

#endif /* __LINUX_I2C_SX150X_H */
Commit	Line	Data
c34f16b7 GB	1	/*
	2	* Driver for the Semtech SX150x I2C GPIO Expanders
	3	*
	4	* Copyright (c) 2010, Code Aurora Forum. All rights reserved.
	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 version 2 and
	8	* only version 2 as published by the Free Software Foundation.
	9	*
	10	* This program is distributed in the hope that it will be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	* GNU General Public License for more details.
	14	*
	15	* You should have received a copy of the GNU General Public License
	16	* along with this program; if not, write to the Free Software
	17	* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
	18	* 02110-1301, USA.
	19	*/
	20	#ifndef __LINUX_I2C_SX150X_H
	21	#define __LINUX_I2C_SX150X_H
	22
	23	/**
	24	* struct sx150x_platform_data - config data for SX150x driver
	25	* @gpio_base: The index number of the first GPIO assigned to this
	26	* GPIO expander. The expander will create a block of
	27	* consecutively numbered gpios beginning at the given base,
	28	* with the size of the block depending on the model of the
	29	* expander chip.
	30	* @oscio_is_gpo: If set to true, the driver will configure OSCIO as a GPO
	31	* instead of as an oscillator, increasing the size of the
	32	* GP(I)O pool created by this expander by one. The
	33	* output-only GPO pin will be added at the end of the block.
	34	* @io_pullup_ena: A bit-mask which enables or disables the pull-up resistor
	35	* for each IO line in the expander. Setting the bit at
	36	* position n will enable the pull-up for the IO at
	37	* the corresponding offset. For chips with fewer than
	38	* 16 IO pins, high-end bits are ignored.
	39	* @io_pulldn_ena: A bit-mask which enables-or disables the pull-down
	40	* resistor for each IO line in the expander. Setting the
	41	* bit at position n will enable the pull-down for the IO at
	42	* the corresponding offset. For chips with fewer than
	43	* 16 IO pins, high-end bits are ignored.
	44	* @io_open_drain_ena: A bit-mask which enables-or disables open-drain
	45	* operation for each IO line in the expander. Setting the
	46	* bit at position n enables open-drain operation for
	47	* the IO at the corresponding offset. Clearing the bit
	48	* enables regular push-pull operation for that IO.
	49	* For chips with fewer than 16 IO pins, high-end bits
	50	* are ignored.
	51	* @io_polarity: A bit-mask which enables polarity inversion for each IO line
	52	* in the expander. Setting the bit at position n inverts
	53	* the polarity of that IO line, while clearing it results
	54	* in normal polarity. For chips with fewer than 16 IO pins,
	55	* high-end bits are ignored.
	56	* @irq_summary: The 'summary IRQ' line to which the GPIO expander's INT line
	57	* is connected, via which it reports interrupt events
	58	* across all GPIO lines. This must be a real,
	59	* pre-existing IRQ line.
	60	* Setting this value < 0 disables the irq_chip functionality
	61	* of the driver.
	62	* @irq_base: The first 'virtual IRQ' line at which our block of GPIO-based
	63	* IRQ lines will appear. Similarly to gpio_base, the expander
	64	* will create a block of irqs beginning at this number.
65	* This value is ignored if irq_summary is < 0.
5affb607 GB	66	* @reset_during_probe: If set to true, the driver will trigger a full
	67	* reset of the chip at the beginning of the probe
	68	* in order to place it in a known state.
c34f16b7 GB	69	*/
	70	struct sx150x_platform_data {
	71	unsigned gpio_base;
	72	bool oscio_is_gpo;
	73	u16 io_pullup_ena;
	74	u16 io_pulldn_ena;
	75	u16 io_open_drain_ena;
	76	u16 io_polarity;
	77	int irq_summary;
	78	unsigned irq_base;
5affb607	79	bool reset_during_probe;
c34f16b7 GB	80	};
	81
	82	#endif /* __LINUX_I2C_SX150X_H */