xref: /freebsd/sys/dev/iicbus/iic.h (revision 783d3ff6d7fae619db8a7990b8a6387de0c677b5)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 1998 Nicolas Souchu
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  *
28  */
29 #ifndef __IIC_H
30 #define __IIC_H
31 
32 #include <sys/ioccom.h>
33 
34 /* Designed to be compatible with linux's struct i2c_msg */
35 struct iic_msg
36 {
37 	uint16_t	slave;
38 	uint16_t	flags;
39 #define	IIC_M_WR	0	/* Fake flag for write */
40 #define	IIC_M_RD	0x0001	/* read vs write */
41 #define	IIC_M_NOSTOP	0x0002	/* do not send a I2C stop after message */
42 #define	IIC_M_NOSTART	0x0004	/* do not send a I2C start before message */
43 	uint16_t	len;	/* msg length */
44 	uint8_t *	buf;
45 };
46 
47 struct iiccmd {
48 	u_char slave;
49 	int count;
50 	int last;
51 	char *buf;
52 };
53 
54 struct iic_rdwr_data {
55 	struct iic_msg *msgs;
56 	uint32_t nmsgs;
57 };
58 
59 #define IIC_RDRW_MAX_MSGS	42
60 
61 #define I2CSTART	_IOW('i', 1, struct iiccmd)	/* start condition */
62 #define I2CSTOP		_IO('i', 2)			/* stop condition */
63 #define I2CRSTCARD	_IOW('i', 3, struct iiccmd)	/* reset the card */
64 #define I2CWRITE	_IOW('i', 4, struct iiccmd)	/* send data */
65 #define I2CREAD		_IOW('i', 5, struct iiccmd)	/* receive data */
66 #define I2CRDWR		_IOW('i', 6, struct iic_rdwr_data)	/* General read/write interface */
67 #define I2CRPTSTART	_IOW('i', 7, struct iiccmd)	/* repeated start */
68 #define I2CSADDR	_IOW('i', 8, uint8_t)		/* set slave address for future I/O */
69 
70 #endif
71