xref: /onnv-gate/usr/src/uts/sun4u/sys/i2c/clients/i2c_client.h (revision 0:68f95e015346)
1*0Sstevel@tonic-gate /*
2*0Sstevel@tonic-gate  * CDDL HEADER START
3*0Sstevel@tonic-gate  *
4*0Sstevel@tonic-gate  * The contents of this file are subject to the terms of the
5*0Sstevel@tonic-gate  * Common Development and Distribution License, Version 1.0 only
6*0Sstevel@tonic-gate  * (the "License").  You may not use this file except in compliance
7*0Sstevel@tonic-gate  * with the License.
8*0Sstevel@tonic-gate  *
9*0Sstevel@tonic-gate  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10*0Sstevel@tonic-gate  * or http://www.opensolaris.org/os/licensing.
11*0Sstevel@tonic-gate  * See the License for the specific language governing permissions
12*0Sstevel@tonic-gate  * and limitations under the License.
13*0Sstevel@tonic-gate  *
14*0Sstevel@tonic-gate  * When distributing Covered Code, include this CDDL HEADER in each
15*0Sstevel@tonic-gate  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16*0Sstevel@tonic-gate  * If applicable, add the following below this CDDL HEADER, with the
17*0Sstevel@tonic-gate  * fields enclosed by brackets "[]" replaced with your own identifying
18*0Sstevel@tonic-gate  * information: Portions Copyright [yyyy] [name of copyright owner]
19*0Sstevel@tonic-gate  *
20*0Sstevel@tonic-gate  * CDDL HEADER END
21*0Sstevel@tonic-gate  */
22*0Sstevel@tonic-gate /*
23*0Sstevel@tonic-gate  * Copyright 1999-2002 Sun Microsystems, Inc.  All rights reserved.
24*0Sstevel@tonic-gate  * Use is subject to license terms.
25*0Sstevel@tonic-gate  */
26*0Sstevel@tonic-gate 
27*0Sstevel@tonic-gate #ifndef	_I2C_CLIENT_H
28*0Sstevel@tonic-gate #define	_I2C_CLIENT_H
29*0Sstevel@tonic-gate 
30*0Sstevel@tonic-gate #pragma ident	"%Z%%M%	%I%	%E% SMI"
31*0Sstevel@tonic-gate 
32*0Sstevel@tonic-gate #ifdef	__cplusplus
33*0Sstevel@tonic-gate extern "C" {
34*0Sstevel@tonic-gate #endif
35*0Sstevel@tonic-gate 
36*0Sstevel@tonic-gate /*
37*0Sstevel@tonic-gate  * Common IOCTL definitions for client drivers.
38*0Sstevel@tonic-gate  */
39*0Sstevel@tonic-gate 
40*0Sstevel@tonic-gate #define	I2C_BASE_IOCTL	('M' << 8)
41*0Sstevel@tonic-gate 
42*0Sstevel@tonic-gate #define	I2C_GET_PORT		(I2C_BASE_IOCTL | 0)
43*0Sstevel@tonic-gate #define	I2C_SET_PORT		(I2C_BASE_IOCTL | 1)
44*0Sstevel@tonic-gate #define	I2C_GET_BIT		(I2C_BASE_IOCTL | 2)
45*0Sstevel@tonic-gate #define	I2C_SET_BIT		(I2C_BASE_IOCTL | 3)
46*0Sstevel@tonic-gate #define	I2C_GET_REG		(I2C_BASE_IOCTL | 4)
47*0Sstevel@tonic-gate #define	I2C_SET_REG		(I2C_BASE_IOCTL | 5)
48*0Sstevel@tonic-gate #define	I2C_GET_TEMPERATURE	(I2C_BASE_IOCTL | 7)
49*0Sstevel@tonic-gate #define	I2C_GET_FAN_SPEED	(I2C_BASE_IOCTL | 8)
50*0Sstevel@tonic-gate #define	I2C_SET_FAN_SPEED	(I2C_BASE_IOCTL | 9)
51*0Sstevel@tonic-gate #define	I2C_SET_OUTPUT		(I2C_BASE_IOCTL | 10)
52*0Sstevel@tonic-gate #define	I2C_GET_OUTPUT		(I2C_BASE_IOCTL | 11)
53*0Sstevel@tonic-gate #define	I2C_GET_INPUT		(I2C_BASE_IOCTL | 12)
54*0Sstevel@tonic-gate #define	I2C_SET_MODE		(I2C_BASE_IOCTL | 13)
55*0Sstevel@tonic-gate #define	I2C_GET_MODE		(I2C_BASE_IOCTL | 14)
56*0Sstevel@tonic-gate 
57*0Sstevel@tonic-gate /*
58*0Sstevel@tonic-gate  * A private IOCTL definition to be used by clients. The first 128 ioctls
59*0Sstevel@tonic-gate  * derived by OR'ing with I2C_BASE_IOCTL are common. The next 128
60*0Sstevel@tonic-gate  * ioctls derived by OR'ing with I2C_PVT_BASE_IOCTL are client private.
61*0Sstevel@tonic-gate  */
62*0Sstevel@tonic-gate 
63*0Sstevel@tonic-gate #define	I2C_PVT_BASE_IOCTL	(I2C_BASE_IOCTL + 128)
64*0Sstevel@tonic-gate 
65*0Sstevel@tonic-gate /*
66*0Sstevel@tonic-gate  * ARGS for I2C_*_MODE
67*0Sstevel@tonic-gate  */
68*0Sstevel@tonic-gate #define	I2C_NORMAL	0
69*0Sstevel@tonic-gate #define	I2C_DEBUG	1
70*0Sstevel@tonic-gate 
71*0Sstevel@tonic-gate /*
72*0Sstevel@tonic-gate  * ARGS for i2c_bit_t direction
73*0Sstevel@tonic-gate  */
74*0Sstevel@tonic-gate 
75*0Sstevel@tonic-gate #define	DIR_NO_CHANGE	0
76*0Sstevel@tonic-gate #define	DIR_OUTPUT	1
77*0Sstevel@tonic-gate #define	DIR_INPUT	2
78*0Sstevel@tonic-gate 
79*0Sstevel@tonic-gate 
80*0Sstevel@tonic-gate #define	INST_TO_MINOR(x) (x << 4)
81*0Sstevel@tonic-gate #define	MINOR_TO_INST(x) ((x & 0xFFFFFFF0) >> 4)
82*0Sstevel@tonic-gate #define	PORT_TO_MINOR(x)  (x)
83*0Sstevel@tonic-gate #define	MINOR_TO_PORT(x)  (0x0F & x)
84*0Sstevel@tonic-gate 
85*0Sstevel@tonic-gate #define	I2C_PORT(x)		(0x00 + x)
86*0Sstevel@tonic-gate 
87*0Sstevel@tonic-gate typedef struct i2c_port {
88*0Sstevel@tonic-gate 	uint8_t		value;
89*0Sstevel@tonic-gate 	uint8_t		direction;
90*0Sstevel@tonic-gate 	uint8_t		dir_mask;
91*0Sstevel@tonic-gate } i2c_port_t;
92*0Sstevel@tonic-gate 
93*0Sstevel@tonic-gate typedef struct i2c_bit {
94*0Sstevel@tonic-gate 	uchar_t		bit_num;
95*0Sstevel@tonic-gate 	boolean_t	bit_value;
96*0Sstevel@tonic-gate 	uint8_t		direction;
97*0Sstevel@tonic-gate } i2c_bit_t;
98*0Sstevel@tonic-gate 
99*0Sstevel@tonic-gate typedef struct i2c_reg {
100*0Sstevel@tonic-gate 	uint8_t		reg_num;
101*0Sstevel@tonic-gate 	int32_t		reg_value;
102*0Sstevel@tonic-gate } i2c_reg_t;
103*0Sstevel@tonic-gate 
104*0Sstevel@tonic-gate #if defined(_KERNEL)
105*0Sstevel@tonic-gate 
106*0Sstevel@tonic-gate #include <sys/i2c/misc/i2c_svc.h>
107*0Sstevel@tonic-gate 
108*0Sstevel@tonic-gate #endif /* _KERNEL */
109*0Sstevel@tonic-gate 
110*0Sstevel@tonic-gate #ifdef	__cplusplus
111*0Sstevel@tonic-gate }
112*0Sstevel@tonic-gate #endif
113*0Sstevel@tonic-gate 
114*0Sstevel@tonic-gate #endif /* _I2C_CLIENT_H */
115