Home | History | Annotate | Line # | Download | only in i2c
i2c_io.h revision 1.2.110.1 
      1 /*	$NetBSD: i2c_io.h,v 1.2.110.1 2012/05/23 10:07:55 yamt Exp $	*/
      2 
      3 /*
      4  * Copyright (c) 2003 Wasabi Systems, Inc.
      5  * All rights reserved.
      6  *
      7  * Written by Jason R. Thorpe for Wasabi Systems, Inc.
      8  *
      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.
     24  *
     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.
     36  */
     37 
     38 #ifndef _DEV_I2C_I2C_IO_H_
     39 #define	_DEV_I2C_I2C_IO_H_
     40 
     41 #include <sys/ioccom.h>
     42 
     43 /* I2C bus address. */
     44 typedef uint16_t i2c_addr_t;
     45 
     46 /* High-level I2C operations. */
     47 #define	I2C_OPMASK_STOP		1
     48 #define	I2C_OPMASK_WRITE	2
     49 #define	I2C_OPMASK_BLKMODE	4
     50 
     51 #define	I2C_OP_STOP_P(x)	(((int)(x) & I2C_OPMASK_STOP) != 0)
     52 #define	I2C_OP_WRITE_P(x)	(((int)(x) & I2C_OPMASK_WRITE) != 0)
     53 #define	I2C_OP_READ_P(x)	(!I2C_OP_WRITE_P(x))
     54 #define	I2C_OP_BLKMODE_P(x)	(((int)(x) & I2C_OPMASK_BLKMODE) != 0)
     55 
     56 typedef enum {
     57         I2C_OP_READ		= 0,
     58         I2C_OP_READ_WITH_STOP	= I2C_OPMASK_STOP,
     59         I2C_OP_WRITE		= I2C_OPMASK_WRITE,
     60         I2C_OP_WRITE_WITH_STOP	= I2C_OPMASK_WRITE   | I2C_OPMASK_STOP,
     61         I2C_OP_READ_BLOCK	= I2C_OPMASK_BLKMODE | I2C_OPMASK_STOP,
     62         I2C_OP_WRITE_BLOCK	= I2C_OPMASK_BLKMODE | I2C_OPMASK_WRITE |
     63 					I2C_OPMASK_STOP,
     64 } i2c_op_t;
     65 
     66 /*
     67  * This structure describes a single I2C control script fragment.
     68  *
     69  * Note that use of this scripted API allows for support of automated
     70  * SMBus controllers.  The following table maps SMBus operations to
     71  * script fragment configuration:
     72  *
     73  *	SMBus "write byte":		I2C_OP_WRITE_WITH_STOP
     74  *					cmdlen = 1
     75  *
     76  *	SMBus "read byte":		I2C_OP_READ_WITH_STOP
     77  *					cmdlen = 1
     78  *
     79  *	SMBus "receive byte":		I2C_OP_READ_WITH_STOP
     80  *					cmdlen = 0
     81  *
     82  * Note that while each of these 3 SMBus operations implies a STOP
     83  * (which an automated controller will likely perform automatically),
     84  * non-SMBus clients may continue to function even if they issue
     85  * I2C_OP_WRITE and I2C_OP_READ.
     86  */
     87 
     88 /*
     89  * I2C_IOCTL_EXEC:
     90  *
     91  *	User ioctl to execute an i2c operation.
     92  */
     93 typedef struct i2c_ioctl_exec {
     94 	i2c_op_t iie_op;		/* operation to perform */
     95 	i2c_addr_t iie_addr;		/* address of device */
     96 	const void *iie_cmd;		/* pointer to command */
     97 	size_t iie_cmdlen;		/* length of command */
     98 	void *iie_buf;			/* pointer to data buffer */
     99 	size_t iie_buflen;		/* length of data buffer */
    100 } i2c_ioctl_exec_t;
    101 #define	I2C_EXEC_MAX_CMDLEN	32
    102 #define	I2C_EXEC_MAX_BUFLEN	32
    103 
    104 #define	I2C_IOCTL_EXEC		 _IOW('I', 0, i2c_ioctl_exec_t)
    105 
    106 #endif /* _DEV_I2C_I2C_IO_H_ */
    107