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