usr.sbin/i2c/i2c.8

   1 .\"
   2 .\" Copyright (C) 2008-2009 Semihalf, Michal Hajduk and Bartlomiej Sieka
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd May 22, 2019
  29 .Dt I2C 8
  30 .Os
  31 .Sh NAME
  32 .Nm i2c
  33 .Nd test I2C bus and slave devices
  34 .Sh SYNOPSIS
  35 .Nm
  36 .Cm -a Ar address
  37 .Op Fl f Ar device
  38 .Op Fl d Ar r|w
  39 .Op Fl w Ar 0|8|16
  40 .Op Fl o Ar offset
  41 .Op Fl c Ar count
  42 .Op Fl m Ar tr|ss|rs|no
  43 .Op Fl b
  44 .Op Fl v
  45 .Nm
  46 .Cm -s
  47 .Op Fl f Ar device
  48 .Op Fl n Ar skip_addr
  49 .Op Fl v
  50 .Nm
  51 .Cm -r
  52 .Op Fl f Ar device
  53 .Op Fl v
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 utility can be used to perform raw data transfers (read or write) with devices
  58 on the I2C bus. It can also scan the bus for available devices and reset the
  59 I2C controller.
  60 .Pp
  61 The options are as follows:
  62 .Bl -tag -width ".Fl d Ar direction"
  63 .It Fl a Ar address
  64 7-bit address on the I2C device to operate on (hex).
  65 .It Fl b
  66 binary mode - when performing a read operation, the data read from the device
  67 is output in binary format on stdout; when doing a write, the binary data to
  68 be written to the device is read from stdin.
  69 .It Fl c Ar count
  70 number of bytes to transfer (dec).
  71 .It Fl d Ar r|w
  72 transfer direction: r - read, w - write.
  73 .It Fl f Ar device
  74 I2C bus to use (default is /dev/iic0).
  75 .It Fl m Ar tr|ss|rs|no
  76 addressing mode, i.e., I2C bus operations performed after the offset for the
  77 transfer has been written to the device and before the actual read/write
  78 operation.
  79 .Bl -tag -compact -offset indent
  80 .It Va tr
  81 complete-transfer
  82 .It Va ss
  83 stop then start
  84 .It Va rs
  85 repeated start
  86 .It Va no
  87 none
  88 .El
  89 Some I2C bus hardware does not provide control over the individual start,
  90 repeat-start, and stop operations.
  91 Such hardware can only perform a complete transfer of the offset and the
  92 data as a single operation.
  93 The
  94 .Va tr
  95 mode creates control structures describing the transfer and submits them
  96 to the driver as a single complete transaction.
  97 This mode works on all types of I2C hardware.
  98 .It Fl n Ar skip_addr
  99 skip address - address(es) to be skipped during bus scan.
 100 There are two ways to specify addresses to ignore: by range 'a..b' or
 101 using selected addresses 'a:b:c'. This option is available only when "-s" is
 102 used.
 103 .It Fl o Ar offset
 104 offset within the device for data transfer (hex).
 105 The default is zero.
 106 Use
 107 .Dq -w 0
 108 to disable writing of the offset to the slave.
 109 .It Fl r
 110 reset the controller.
 111 .It Fl s
 112 scan the bus for devices.
 113 .It Fl v
 114 be verbose.
 115 .It Fl w Ar 0|8|16
 116 device addressing width (in bits).
 117 This is used to determine how to pass
 118 .Ar offset
 119 specified with
 120 .Fl o
 121 to the slave.
 122 Zero means that the offset is ignored and not passed to the slave at all.
 123 .El
 124 .Sh WARNINGS
 125 Great care must be taken when manipulating slave I2C devices with the
 126 .Nm
 127 utility. Often times important configuration data for the system is kept in
 128 non-volatile but write enabled memories located on the I2C bus, for example
 129 Ethernet hardware addresses, RAM module parameters (SPD), processor reset
 130 configuration word etc.
 131 .Pp
 132 It is very easy to render the whole system unusable when such configuration
 133 data is deleted or altered, so use the
 134 .Dq -d w
 135 (write) command only if you know exactly what you are doing.
 136 .Pp
 137 Also avoid ungraceful interrupting of an ongoing transaction on the I2C bus,
 138 as it can lead to potentially dangerous effects. Consider the following
 139 scenario: when the host CPU is reset (for whatever reason) in the middle of a
 140 started I2C transaction, the I2C slave device could be left in write mode
 141 waiting for data or offset to arrive. When the CPU reinitializes itself and
 142 talks to this I2C slave device again, the commands and other control info it
 143 sends are treated by the slave device as data or offset it was waiting for,
 144 and there's great potential for corruption if such a write is performed.
 145 .Sh EXAMPLES
 146 .Bl -bullet
 147 .It
 148 Scan the default bus (/dev/iic0) for devices:
 149 .Pp
 150 i2c -s
 151 .It
 152 Scan the default bus (/dev/iic0) for devices and skip addresses 0x56 and
 153 0x45.
 154 .Pp
 155 i2c -s -n 0x56:0x45
 156 .It
 157 Scan the default bus (/dev/iic0) for devices and skip address range
 158 0x34 to 0x56.
 159 .Pp
 160 i2c -s -n 0x34..0x56
 161 .It
 162 Read 8 bytes of data from device at address 0x56 (e.g., an EEPROM):
 163 .Pp
 164 i2c -a 0x56 -d r -c 8
 165 .It
 166 Write 16 bytes of data from file data.bin to device 0x56 at offset 0x10:
 167 .Pp
 168 i2c -a 0x56 -d w -c 16 -o 0x10 -b < data.bin
 169 .It
 170 Copy 4 bytes between two EEPROMs (0x56 on /dev/iic1 to 0x57 on /dev/iic0):
 171 .Pp
 172 i2c -a 0x56 -f /dev/iic1 -d r -c 0x4 -b | i2c -a 0x57 -f /dev/iic0 -d w -c 4 -b
 173 .It
 174 Reset the controller:
 175 .Pp
 176 i2c -f /dev/iic1 -r
 177 .El
 178 .Sh SEE ALSO
 179 .Xr iic 4 ,
 180 .Xr iicbus 4
 181 .Sh HISTORY
 182 The
 183 .Nm
 184 utility appeared in
 185 .Fx 8.0 .
 186 .Sh AUTHORS
 187 .An -nosplit
 188 The
 189 .Nm
 190 utility and this manual page were written by
 191 .An Bartlomiej Sieka Aq Mt tur@semihalf.com
 192 and
 193 .An Michal Hajduk Aq Mt mih@semihalf.com .