xref: /openbmc/linux/include/linux/i2c-algo-pca.h (revision 0a355aeb)
1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
21da177e4SLinus Torvalds #ifndef _LINUX_I2C_ALGO_PCA_H
31da177e4SLinus Torvalds #define _LINUX_I2C_ALGO_PCA_H
41da177e4SLinus Torvalds 
5eff9ec95SMarco Aurelio da Costa /* Chips known to the pca algo */
6eff9ec95SMarco Aurelio da Costa #define I2C_PCA_CHIP_9564	0x00
7eff9ec95SMarco Aurelio da Costa #define I2C_PCA_CHIP_9665	0x01
8eff9ec95SMarco Aurelio da Costa 
9eff9ec95SMarco Aurelio da Costa /* Internal period for PCA9665 oscilator */
10eff9ec95SMarco Aurelio da Costa #define I2C_PCA_OSC_PER		3 /* e10-8s */
11eff9ec95SMarco Aurelio da Costa 
12eff9ec95SMarco Aurelio da Costa /* Clock speeds for the bus for PCA9564*/
13c01b0831SWolfram Sang #define I2C_PCA_CON_330kHz	0x00
14c01b0831SWolfram Sang #define I2C_PCA_CON_288kHz	0x01
15c01b0831SWolfram Sang #define I2C_PCA_CON_217kHz	0x02
16c01b0831SWolfram Sang #define I2C_PCA_CON_146kHz	0x03
17c01b0831SWolfram Sang #define I2C_PCA_CON_88kHz	0x04
18c01b0831SWolfram Sang #define I2C_PCA_CON_59kHz	0x05
19c01b0831SWolfram Sang #define I2C_PCA_CON_44kHz	0x06
20c01b0831SWolfram Sang #define I2C_PCA_CON_36kHz	0x07
21c01b0831SWolfram Sang 
22c01b0831SWolfram Sang /* PCA9564 registers */
23c01b0831SWolfram Sang #define I2C_PCA_STA		0x00 /* STATUS  Read Only  */
24c01b0831SWolfram Sang #define I2C_PCA_TO		0x00 /* TIMEOUT Write Only */
25c01b0831SWolfram Sang #define I2C_PCA_DAT		0x01 /* DATA    Read/Write */
26c01b0831SWolfram Sang #define I2C_PCA_ADR		0x02 /* OWN ADR Read/Write */
27c01b0831SWolfram Sang #define I2C_PCA_CON		0x03 /* CONTROL Read/Write */
28c01b0831SWolfram Sang 
29eff9ec95SMarco Aurelio da Costa /* PCA9665 registers */
30eff9ec95SMarco Aurelio da Costa #define I2C_PCA_INDPTR          0x00 /* INDIRECT Pointer Write Only */
31eff9ec95SMarco Aurelio da Costa #define I2C_PCA_IND             0x02 /* INDIRECT Read/Write */
32eff9ec95SMarco Aurelio da Costa 
33eff9ec95SMarco Aurelio da Costa /* PCA9665 indirect registers */
34eff9ec95SMarco Aurelio da Costa #define I2C_PCA_ICOUNT          0x00 /* Byte Count for buffered mode */
35eff9ec95SMarco Aurelio da Costa #define I2C_PCA_IADR            0x01 /* OWN ADR */
36eff9ec95SMarco Aurelio da Costa #define I2C_PCA_ISCLL           0x02 /* SCL LOW period */
37eff9ec95SMarco Aurelio da Costa #define I2C_PCA_ISCLH           0x03 /* SCL HIGH period */
38eff9ec95SMarco Aurelio da Costa #define I2C_PCA_ITO             0x04 /* TIMEOUT */
39eff9ec95SMarco Aurelio da Costa #define I2C_PCA_IPRESET         0x05 /* Parallel bus reset */
40eff9ec95SMarco Aurelio da Costa #define I2C_PCA_IMODE           0x06 /* I2C Bus mode */
41eff9ec95SMarco Aurelio da Costa 
42eff9ec95SMarco Aurelio da Costa /* PCA9665 I2C bus mode */
43eff9ec95SMarco Aurelio da Costa #define I2C_PCA_MODE_STD        0x00 /* Standard mode */
44eff9ec95SMarco Aurelio da Costa #define I2C_PCA_MODE_FAST       0x01 /* Fast mode */
45eff9ec95SMarco Aurelio da Costa #define I2C_PCA_MODE_FASTP      0x02 /* Fast Plus mode */
46eff9ec95SMarco Aurelio da Costa #define I2C_PCA_MODE_TURBO      0x03 /* Turbo mode */
47eff9ec95SMarco Aurelio da Costa 
48eff9ec95SMarco Aurelio da Costa 
49c01b0831SWolfram Sang #define I2C_PCA_CON_AA		0x80 /* Assert Acknowledge */
50c01b0831SWolfram Sang #define I2C_PCA_CON_ENSIO	0x40 /* Enable */
51c01b0831SWolfram Sang #define I2C_PCA_CON_STA		0x20 /* Start */
52c01b0831SWolfram Sang #define I2C_PCA_CON_STO		0x10 /* Stop */
53c01b0831SWolfram Sang #define I2C_PCA_CON_SI		0x08 /* Serial Interrupt */
54c01b0831SWolfram Sang #define I2C_PCA_CON_CR		0x07 /* Clock Rate (MASK) */
55c01b0831SWolfram Sang 
56*0a355aebSEvan Nimmo /**
57*0a355aebSEvan Nimmo  * struct pca_i2c_bus_settings - The configured PCA i2c bus settings
58*0a355aebSEvan Nimmo  * @mode: Configured i2c bus mode
59*0a355aebSEvan Nimmo  * @tlow: Configured SCL LOW period
60*0a355aebSEvan Nimmo  * @thi: Configured SCL HIGH period
61*0a355aebSEvan Nimmo  * @clock_freq: The configured clock frequency
62*0a355aebSEvan Nimmo  */
63*0a355aebSEvan Nimmo struct pca_i2c_bus_settings {
64*0a355aebSEvan Nimmo 	int mode;
65*0a355aebSEvan Nimmo 	int tlow;
66*0a355aebSEvan Nimmo 	int thi;
67*0a355aebSEvan Nimmo 	int clock_freq;
68*0a355aebSEvan Nimmo };
69*0a355aebSEvan Nimmo 
701da177e4SLinus Torvalds struct i2c_algo_pca_data {
71c01b0831SWolfram Sang 	void 				*data;	/* private low level data */
72c01b0831SWolfram Sang 	void (*write_byte)		(void *data, int reg, int val);
73c01b0831SWolfram Sang 	int  (*read_byte)		(void *data, int reg);
74c01b0831SWolfram Sang 	int  (*wait_for_completion)	(void *data);
75c01b0831SWolfram Sang 	void (*reset_chip)		(void *data);
76eff9ec95SMarco Aurelio da Costa 	/* For PCA9564, use one of the predefined frequencies:
77eff9ec95SMarco Aurelio da Costa 	 * 330000, 288000, 217000, 146000, 88000, 59000, 44000, 36000
78eff9ec95SMarco Aurelio da Costa 	 * For PCA9665, use the frequency you want here. */
79c01b0831SWolfram Sang 	unsigned int			i2c_clock;
80a76e7c68SThomas Kavanagh 	unsigned int			chip;
81*0a355aebSEvan Nimmo 	struct pca_i2c_bus_settings		bus_settings;
821da177e4SLinus Torvalds };
831da177e4SLinus Torvalds 
841da177e4SLinus Torvalds int i2c_pca_add_bus(struct i2c_adapter *);
85c01b0831SWolfram Sang int i2c_pca_add_numbered_bus(struct i2c_adapter *);
861da177e4SLinus Torvalds 
871da177e4SLinus Torvalds #endif /* _LINUX_I2C_ALGO_PCA_H */
88