xref: /OK3568_Linux_fs/kernel/include/sound/i2c.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun #ifndef __SOUND_I2C_H
3*4882a593Smuzhiyun #define __SOUND_I2C_H
4*4882a593Smuzhiyun 
5*4882a593Smuzhiyun /*
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #define SND_I2C_DEVICE_ADDRTEN	(1<<0)	/* 10-bit I2C address */
9*4882a593Smuzhiyun 
10*4882a593Smuzhiyun struct snd_i2c_device {
11*4882a593Smuzhiyun 	struct list_head list;
12*4882a593Smuzhiyun 	struct snd_i2c_bus *bus;	/* I2C bus */
13*4882a593Smuzhiyun 	char name[32];		/* some useful device name */
14*4882a593Smuzhiyun 	unsigned short flags;	/* device flags */
15*4882a593Smuzhiyun 	unsigned short addr;	/* device address (might be 10-bit) */
16*4882a593Smuzhiyun 	unsigned long private_value;
17*4882a593Smuzhiyun 	void *private_data;
18*4882a593Smuzhiyun 	void (*private_free)(struct snd_i2c_device *device);
19*4882a593Smuzhiyun };
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun #define snd_i2c_device(n) list_entry(n, struct snd_i2c_device, list)
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun struct snd_i2c_bit_ops {
24*4882a593Smuzhiyun 	void (*start)(struct snd_i2c_bus *bus);	/* transfer start */
25*4882a593Smuzhiyun 	void (*stop)(struct snd_i2c_bus *bus);	/* transfer stop */
26*4882a593Smuzhiyun 	void (*direction)(struct snd_i2c_bus *bus, int clock, int data);  /* set line direction (0 = write, 1 = read) */
27*4882a593Smuzhiyun 	void (*setlines)(struct snd_i2c_bus *bus, int clock, int data);
28*4882a593Smuzhiyun 	int (*getclock)(struct snd_i2c_bus *bus);
29*4882a593Smuzhiyun 	int (*getdata)(struct snd_i2c_bus *bus, int ack);
30*4882a593Smuzhiyun };
31*4882a593Smuzhiyun 
32*4882a593Smuzhiyun struct snd_i2c_ops {
33*4882a593Smuzhiyun 	int (*sendbytes)(struct snd_i2c_device *device, unsigned char *bytes, int count);
34*4882a593Smuzhiyun 	int (*readbytes)(struct snd_i2c_device *device, unsigned char *bytes, int count);
35*4882a593Smuzhiyun 	int (*probeaddr)(struct snd_i2c_bus *bus, unsigned short addr);
36*4882a593Smuzhiyun };
37*4882a593Smuzhiyun 
38*4882a593Smuzhiyun struct snd_i2c_bus {
39*4882a593Smuzhiyun 	struct snd_card *card;	/* card which I2C belongs to */
40*4882a593Smuzhiyun 	char name[32];		/* some useful label */
41*4882a593Smuzhiyun 
42*4882a593Smuzhiyun 	struct mutex lock_mutex;
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun 	struct snd_i2c_bus *master;	/* master bus when SCK/SCL is shared */
45*4882a593Smuzhiyun 	struct list_head buses;	/* master: slave buses sharing SCK/SCL, slave: link list */
46*4882a593Smuzhiyun 
47*4882a593Smuzhiyun 	struct list_head devices; /* attached devices to this bus */
48*4882a593Smuzhiyun 
49*4882a593Smuzhiyun 	union {
50*4882a593Smuzhiyun 		struct snd_i2c_bit_ops *bit;
51*4882a593Smuzhiyun 		void *ops;
52*4882a593Smuzhiyun 	} hw_ops;		/* lowlevel operations */
53*4882a593Smuzhiyun 	const struct snd_i2c_ops *ops;	/* midlevel operations */
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun 	unsigned long private_value;
56*4882a593Smuzhiyun 	void *private_data;
57*4882a593Smuzhiyun 	void (*private_free)(struct snd_i2c_bus *bus);
58*4882a593Smuzhiyun };
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun #define snd_i2c_slave_bus(n) list_entry(n, struct snd_i2c_bus, buses)
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun int snd_i2c_bus_create(struct snd_card *card, const char *name,
63*4882a593Smuzhiyun 		       struct snd_i2c_bus *master, struct snd_i2c_bus **ri2c);
64*4882a593Smuzhiyun int snd_i2c_device_create(struct snd_i2c_bus *bus, const char *name,
65*4882a593Smuzhiyun 			  unsigned char addr, struct snd_i2c_device **rdevice);
66*4882a593Smuzhiyun int snd_i2c_device_free(struct snd_i2c_device *device);
67*4882a593Smuzhiyun 
snd_i2c_lock(struct snd_i2c_bus * bus)68*4882a593Smuzhiyun static inline void snd_i2c_lock(struct snd_i2c_bus *bus)
69*4882a593Smuzhiyun {
70*4882a593Smuzhiyun 	if (bus->master)
71*4882a593Smuzhiyun 		mutex_lock(&bus->master->lock_mutex);
72*4882a593Smuzhiyun 	else
73*4882a593Smuzhiyun 		mutex_lock(&bus->lock_mutex);
74*4882a593Smuzhiyun }
75*4882a593Smuzhiyun 
snd_i2c_unlock(struct snd_i2c_bus * bus)76*4882a593Smuzhiyun static inline void snd_i2c_unlock(struct snd_i2c_bus *bus)
77*4882a593Smuzhiyun {
78*4882a593Smuzhiyun 	if (bus->master)
79*4882a593Smuzhiyun 		mutex_unlock(&bus->master->lock_mutex);
80*4882a593Smuzhiyun 	else
81*4882a593Smuzhiyun 		mutex_unlock(&bus->lock_mutex);
82*4882a593Smuzhiyun }
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun int snd_i2c_sendbytes(struct snd_i2c_device *device, unsigned char *bytes, int count);
85*4882a593Smuzhiyun int snd_i2c_readbytes(struct snd_i2c_device *device, unsigned char *bytes, int count);
86*4882a593Smuzhiyun int snd_i2c_probeaddr(struct snd_i2c_bus *bus, unsigned short addr);
87*4882a593Smuzhiyun 
88*4882a593Smuzhiyun #endif /* __SOUND_I2C_H */
89