[mirror_ubuntu-bionic-kernel.git] / include / linux / i2c-algo-pca.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _LINUX_I2C_ALGO_PCA_H
#define _LINUX_I2C_ALGO_PCA_H

/* Chips known to the pca algo */
#define I2C_PCA_CHIP_9564	0x00
#define I2C_PCA_CHIP_9665	0x01

/* Internal period for PCA9665 oscilator */
#define I2C_PCA_OSC_PER		3 /* e10-8s */

/* Clock speeds for the bus for PCA9564*/
#define I2C_PCA_CON_330kHz	0x00
#define I2C_PCA_CON_288kHz	0x01
#define I2C_PCA_CON_217kHz	0x02
#define I2C_PCA_CON_146kHz	0x03
#define I2C_PCA_CON_88kHz	0x04
#define I2C_PCA_CON_59kHz	0x05
#define I2C_PCA_CON_44kHz	0x06
#define I2C_PCA_CON_36kHz	0x07

/* PCA9564 registers */
#define I2C_PCA_STA		0x00 /* STATUS  Read Only  */
#define I2C_PCA_TO		0x00 /* TIMEOUT Write Only */
#define I2C_PCA_DAT		0x01 /* DATA    Read/Write */
#define I2C_PCA_ADR		0x02 /* OWN ADR Read/Write */
#define I2C_PCA_CON		0x03 /* CONTROL Read/Write */

/* PCA9665 registers */
#define I2C_PCA_INDPTR          0x00 /* INDIRECT Pointer Write Only */
#define I2C_PCA_IND             0x02 /* INDIRECT Read/Write */

/* PCA9665 indirect registers */
#define I2C_PCA_ICOUNT          0x00 /* Byte Count for buffered mode */
#define I2C_PCA_IADR            0x01 /* OWN ADR */
#define I2C_PCA_ISCLL           0x02 /* SCL LOW period */
#define I2C_PCA_ISCLH           0x03 /* SCL HIGH period */
#define I2C_PCA_ITO             0x04 /* TIMEOUT */
#define I2C_PCA_IPRESET         0x05 /* Parallel bus reset */
#define I2C_PCA_IMODE           0x06 /* I2C Bus mode */

/* PCA9665 I2C bus mode */
#define I2C_PCA_MODE_STD        0x00 /* Standard mode */
#define I2C_PCA_MODE_FAST       0x01 /* Fast mode */
#define I2C_PCA_MODE_FASTP      0x02 /* Fast Plus mode */
#define I2C_PCA_MODE_TURBO      0x03 /* Turbo mode */


#define I2C_PCA_CON_AA		0x80 /* Assert Acknowledge */
#define I2C_PCA_CON_ENSIO	0x40 /* Enable */
#define I2C_PCA_CON_STA		0x20 /* Start */
#define I2C_PCA_CON_STO		0x10 /* Stop */
#define I2C_PCA_CON_SI		0x08 /* Serial Interrupt */
#define I2C_PCA_CON_CR		0x07 /* Clock Rate (MASK) */

struct i2c_algo_pca_data {
	void 				*data;	/* private low level data */
	void (*write_byte)		(void *data, int reg, int val);
	int  (*read_byte)		(void *data, int reg);
	int  (*wait_for_completion)	(void *data);
	void (*reset_chip)		(void *data);
	/* For PCA9564, use one of the predefined frequencies:
	 * 330000, 288000, 217000, 146000, 88000, 59000, 44000, 36000
	 * For PCA9665, use the frequency you want here. */
	unsigned int			i2c_clock;
	unsigned int			chip;
};

int i2c_pca_add_bus(struct i2c_adapter *);
int i2c_pca_add_numbered_bus(struct i2c_adapter *);

#endif /* _LINUX_I2C_ALGO_PCA_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef _LINUX_I2C_ALGO_PCA_H
	3	#define _LINUX_I2C_ALGO_PCA_H
	4
eff9ec95 MAC	5	/* Chips known to the pca algo */
	6	#define I2C_PCA_CHIP_9564 0x00
	7	#define I2C_PCA_CHIP_9665 0x01
	8
	9	/* Internal period for PCA9665 oscilator */
	10	#define I2C_PCA_OSC_PER 3 /* e10-8s */
	11
	12	/* Clock speeds for the bus for PCA9564*/
c01b0831 WS	13	#define I2C_PCA_CON_330kHz 0x00
	14	#define I2C_PCA_CON_288kHz 0x01
	15	#define I2C_PCA_CON_217kHz 0x02
	16	#define I2C_PCA_CON_146kHz 0x03
	17	#define I2C_PCA_CON_88kHz 0x04
	18	#define I2C_PCA_CON_59kHz 0x05
	19	#define I2C_PCA_CON_44kHz 0x06
	20	#define I2C_PCA_CON_36kHz 0x07
	21
	22	/* PCA9564 registers */
	23	#define I2C_PCA_STA 0x00 /* STATUS Read Only */
	24	#define I2C_PCA_TO 0x00 /* TIMEOUT Write Only */
	25	#define I2C_PCA_DAT 0x01 /* DATA Read/Write */
	26	#define I2C_PCA_ADR 0x02 /* OWN ADR Read/Write */
	27	#define I2C_PCA_CON 0x03 /* CONTROL Read/Write */
	28
eff9ec95 MAC	29	/* PCA9665 registers */
	30	#define I2C_PCA_INDPTR 0x00 /* INDIRECT Pointer Write Only */
	31	#define I2C_PCA_IND 0x02 /* INDIRECT Read/Write */
	32
	33	/* PCA9665 indirect registers */
	34	#define I2C_PCA_ICOUNT 0x00 /* Byte Count for buffered mode */
	35	#define I2C_PCA_IADR 0x01 /* OWN ADR */
	36	#define I2C_PCA_ISCLL 0x02 /* SCL LOW period */
	37	#define I2C_PCA_ISCLH 0x03 /* SCL HIGH period */
	38	#define I2C_PCA_ITO 0x04 /* TIMEOUT */
	39	#define I2C_PCA_IPRESET 0x05 /* Parallel bus reset */
	40	#define I2C_PCA_IMODE 0x06 /* I2C Bus mode */
	41
	42	/* PCA9665 I2C bus mode */
	43	#define I2C_PCA_MODE_STD 0x00 /* Standard mode */
	44	#define I2C_PCA_MODE_FAST 0x01 /* Fast mode */
	45	#define I2C_PCA_MODE_FASTP 0x02 /* Fast Plus mode */
	46	#define I2C_PCA_MODE_TURBO 0x03 /* Turbo mode */
	47
	48
c01b0831 WS	49	#define I2C_PCA_CON_AA 0x80 /* Assert Acknowledge */
	50	#define I2C_PCA_CON_ENSIO 0x40 /* Enable */
	51	#define I2C_PCA_CON_STA 0x20 /* Start */
	52	#define I2C_PCA_CON_STO 0x10 /* Stop */
	53	#define I2C_PCA_CON_SI 0x08 /* Serial Interrupt */
	54	#define I2C_PCA_CON_CR 0x07 /* Clock Rate (MASK) */
	55
1da177e4	56	struct i2c_algo_pca_data {
c01b0831 WS	57	void data; / private low level data */
	58	void (write_byte) (void data, int reg, int val);
	59	int (read_byte) (void data, int reg);
	60	int (wait_for_completion) (void data);
	61	void (reset_chip) (void data);
eff9ec95 MAC	62	/* For PCA9564, use one of the predefined frequencies:
	63	* 330000, 288000, 217000, 146000, 88000, 59000, 44000, 36000
	64	* For PCA9665, use the frequency you want here. */
c01b0831	65	unsigned int i2c_clock;
a76e7c68	66	unsigned int chip;
1da177e4 LT	67	};
1da177e4 LT	68
1da177e4	69	int i2c_pca_add_bus(struct i2c_adapter *);
c01b0831	70	int i2c_pca_add_numbered_bus(struct i2c_adapter *);
1da177e4 LT	71
1da177e4 LT	72	#endif /* _LINUX_I2C_ALGO_PCA_H */