i2c_io.h 3.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. /* $OpenBSD: i2c_io.h,v 1.1 2004/05/23 17:33:43 grange Exp $ */
  2. /* $NetBSD: i2c_io.h,v 1.1 2003/09/30 00:35:31 thorpej Exp $ */
  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. #ifndef _DEV_I2C_I2C_IO_H_
  38. #define _DEV_I2C_I2C_IO_H_
  39. #include <sys/ioccom.h>
  40. /* I2C bus address. */
  41. typedef uint16_t i2c_addr_t;
  42. /* High-level I2C operations. */
  43. typedef enum {
  44. I2C_OP_READ = 0,
  45. I2C_OP_READ_WITH_STOP = 1,
  46. I2C_OP_WRITE = 2,
  47. I2C_OP_WRITE_WITH_STOP = 3,
  48. } i2c_op_t;
  49. #define I2C_OP_READ_P(x) (((int)(x) & 2) == 0)
  50. #define I2C_OP_WRITE_P(x) (! I2C_OP_READ_P(x))
  51. #define I2C_OP_STOP_P(x) (((int)(x) & 1) != 0)
  52. /*
  53. * This structure describes a single I2C control script fragment.
  54. *
  55. * Note that use of this scripted API allows for support of automated
  56. * SMBus controllers. The following table maps SMBus operations to
  57. * script fragment configuration:
  58. *
  59. * SMBus "write byte": I2C_OP_WRITE_WITH_STOP
  60. * cmdlen = 1
  61. *
  62. * SMBus "read byte": I2C_OP_READ_WITH_STOP
  63. * cmdlen = 1
  64. *
  65. * SMBus "receive byte": I2C_OP_READ_WITH_STOP
  66. * cmdlen = 0
  67. *
  68. * Note that while each of these 3 SMBus operations implies a STOP
  69. * (which an automated controller will likely perform automatically),
  70. * non-SMBus clients may continue to function even if they issue
  71. * I2C_OP_WRITE and I2C_OP_READ.
  72. */
  73. #ifdef notyet
  74. /*
  75. * I2C_IOCTL_EXEC:
  76. *
  77. * User ioctl to execute an i2c operation.
  78. */
  79. typedef struct i2c_ioctl_exec {
  80. i2c_op_t iie_op; /* operation to perform */
  81. i2c_addr_t iie_addr; /* address of device */
  82. const void *iie_cmd; /* pointer to command */
  83. size_t iie_cmdlen; /* length of command */
  84. void *iie_buf; /* pointer to data buffer */
  85. size_t iie_buflen; /* length of data buffer */
  86. } i2c_ioctl_exec_t;
  87. #define I2C_EXEC_MAX_CMDLEN 32
  88. #define I2C_EXEC_MAX_BUFLEN 32
  89. #define I2C_IOCTL_EXEC _IOW('I', 0, i2c_ioctl_exec_t)
  90. #endif
  91. #endif /* _DEV_I2C_I2C_IO_H_ */