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