xref: /openbsd/sys/dev/i2c/i2c_bitbang.h (revision 3a4cbe1a)
1 /*	$OpenBSD: i2c_bitbang.h,v 1.3 2006/01/13 23:56:46 grange Exp $	*/
2 /*	$NetBSD: i2c_bitbang.h,v 1.1 2003/09/30 00:35:31 thorpej Exp $	*/
3 
4 /*
5  * Copyright (c) 2003 Wasabi Systems, Inc.
6  * All rights reserved.
7  *
8  * Written by Jason R. Thorpe for Wasabi Systems, Inc.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *      This product includes software developed for the NetBSD Project by
21  *      Wasabi Systems, Inc.
22  * 4. The name of Wasabi Systems, Inc. may not be used to endorse
23  *    or promote products derived from this software without specific prior
24  *    written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY WASABI SYSTEMS, INC. ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL WASABI SYSTEMS, INC
30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
36  * POSSIBILITY OF SUCH DAMAGE.
37  */
38 
39 #ifndef _DEV_I2C_I2C_BITBANG_H_
40 #define	_DEV_I2C_I2C_BITBANG_H_
41 
42 #define	I2C_BIT_SDA		0	/* SDA signal */
43 #define	I2C_BIT_SCL		1	/* SCL signal */
44 #define	I2C_BIT_OUTPUT		2	/* controller: SDA is output */
45 #define	I2C_BIT_INPUT		3	/* controller: SDA is input */
46 #define	I2C_NBITS		4
47 
48 struct i2c_bitbang_ops {
49 	void		(*ibo_set_bits)(void *, uint32_t);
50 	void		(*ibo_set_dir)(void *, uint32_t);
51 	uint32_t	(*ibo_read_bits)(void *);
52 	uint32_t	ibo_bits[I2C_NBITS];
53 };
54 
55 typedef const struct i2c_bitbang_ops *i2c_bitbang_ops_t;
56 
57 int	i2c_bitbang_send_start(void *, int, i2c_bitbang_ops_t);
58 int	i2c_bitbang_send_stop(void *, int, i2c_bitbang_ops_t);
59 int	i2c_bitbang_initiate_xfer(void *, i2c_addr_t, int, i2c_bitbang_ops_t);
60 int	i2c_bitbang_read_byte(void *, uint8_t *, int, i2c_bitbang_ops_t);
61 int	i2c_bitbang_write_byte(void *, uint8_t, int, i2c_bitbang_ops_t);
62 
63 #endif /* _DEV_I2C_I2C_BITBANG_H_ */
64