xref: /dragonfly/sys/dev/drm/include/linux/i2c.h (revision 5ca0a96d)
1 /*
2  * Copyright (c) 2013-2020 François Tigeot <ftigeot@wolfpond.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice unmodified, this list of conditions, and the following
10  *    disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26 
27 #ifndef _LINUX_I2C_H_
28 #define _LINUX_I2C_H_
29 
30 #include <linux/mod_devicetable.h>
31 #include <linux/device.h>	/* for struct device */
32 #include <linux/sched.h>	/* for completion */
33 #include <linux/mutex.h>
34 #include <linux/of.h>		/* for struct device_node */
35 #include <uapi/linux/i2c.h>
36 
37 #include <bus/iicbus/iic.h>
38 
39 #define I2C_M_RD	IIC_M_RD
40 #define I2C_M_NOSTART	IIC_M_NOSTART
41 
42 struct i2c_lock_operations;
43 
44 struct i2c_adapter {
45 	const struct i2c_algorithm *algo;
46 	void *algo_data;
47 
48 	int timeout;
49 	int retries;
50 	struct device dev;
51 	void *private_data;
52 
53 	char name[48];
54 
55 	const struct i2c_lock_operations *lock_ops;
56 };
57 
58 struct i2c_client {
59 	unsigned short flags;
60 	unsigned short addr;
61 	char name[I2C_NAME_SIZE];
62 	struct i2c_adapter *adapter;
63 };
64 
65 int __i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
66 int i2c_transfer(struct i2c_adapter *adap, struct i2c_msg *msgs, int num);
67 
68 struct i2c_algorithm {
69 	int (*master_xfer)(struct i2c_adapter *adap, struct i2c_msg *msgs,
70 			   int num);
71 
72 	u32 (*functionality) (struct i2c_adapter *);
73 };
74 
75 extern int i2c_add_adapter(struct i2c_adapter *);
76 extern void i2c_del_adapter(struct i2c_adapter *);
77 
78 static inline void
79 i2c_set_adapdata(struct i2c_adapter *dev, void *data)
80 {
81 	dev->private_data = data;
82 }
83 
84 static inline void *
85 i2c_get_adapdata(const struct i2c_adapter *dev)
86 {
87 	return dev->private_data;
88 }
89 
90 struct i2c_board_info {
91 	char		type[I2C_NAME_SIZE];
92 	unsigned short	addr;
93 };
94 
95 struct i2c_client *
96 i2c_new_device(struct i2c_adapter *adap, struct i2c_board_info const *info);
97 
98 #define I2C_LOCK_SEGMENT      BIT(1)
99 
100 struct i2c_lock_operations {
101 	void (*lock_bus)(struct i2c_adapter *, unsigned int flags);
102 	int (*trylock_bus)(struct i2c_adapter *, unsigned int flags);
103 	void (*unlock_bus)(struct i2c_adapter *, unsigned int flags);
104 };
105 
106 #endif	/* _LINUX_I2C_H_ */
107