share/man/man4/gpioiic.4

   1 .\" Copyright (c) 2013, Luiz Otavio O Souza <loos@FreeBSD.org>
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd December 1, 2019
  28 .Dt GPIOIIC 4
  29 .Os
  30 .Sh NAME
  31 .Nm gpioiic
  32 .Nd GPIO I2C bit-banging device driver
  33 .Sh SYNOPSIS
  34 To compile this driver into the kernel,
  35 place the following lines in your
  36 kernel configuration file:
  37 .Bd -ragged -offset indent
  38 .Cd "device gpio"
  39 .Cd "device gpioiic"
  40 .Cd "device iicbb"
  41 .Cd "device iicbus"
  42 .Ed
  43 .Pp
  44 Alternatively, to load the driver as a
  45 module at boot time, place the following line in
  46 .Xr loader.conf 5 :
  47 .Bd -literal -offset indent
  48 gpioiic_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver provides an IIC bit-banging interface using two GPIO pins for the
  54 SCL and SDA lines on the bus.
  55 .Pp
  56 .Nm
  57 simulates an open collector kind of output when managing the pins on the
  58 bus, even on systems which don't directly support configuring gpio pins
  59 in that mode.
  60 The pins are never driven to the logical value of '1'.
  61 They are driven to '0' or switched to input mode (Hi-Z/tri-state), and
  62 an external pullup resistor pulls the line to the 1 state unless some
  63 other device on the bus is driving it to 0.
  64 .Sh HINTS CONFIGURATION
  65 On a
  66 .Xr device.hints 5
  67 based system, such as MIPS, these values are configurable for
  68 .Nm :
  69 .Bl -tag -width ".Va hint.gpioiic.%d.atXXX"
  70 .It Va hint.gpioiic.%d.at
  71 The
  72 .Nm gpiobus
  73 you are attaching to.
  74 Normally just gpiobus0 on systems with a single bank of gpio pins.
  75 .It Va hint.gpioiic.%d.pins
  76 This is a bitmask of the pins on the
  77 .Nm gpiobus
  78 that are to be used for SCLOCK and SDATA from the GPIO IIC
  79 bit-banging bus.
  80 To configure pin 0 and 7, use the bitmask of
  81 0b10000001 and convert it to a hexadecimal value of 0x0081.
  82 Please note that this mask should only ever have two bits set
  83 (any other bits - i.e., pins - will be ignored).
  84 Because
  85 .Nm
  86 must be a child of the gpiobus, both gpio pins must be part of that bus.
  87 .It Va hint.gpioiic.%d.scl
  88 Indicates which bit in the
  89 .Va hint.gpioiic.%d.pins
  90 should be used as the SCLOCK
  91 source.
  92 Optional, defaults to 0.
  93 .It Va hint.gpioiic.%d.sda
  94 Indicates which bit in the
  95 .Va hint.gpioiic.%d.pins
  96 should be used as the SDATA
  97 source.
  98 Optional, defaults to 1.
  99 .El
 100 .Sh FDT CONFIGURATION
 101 On an
 102 .Xr FDT 4
 103 based system, such as ARM, the DTS node for
 104 .Nm gpioiic
 105 conforms to the standard bindings document i2c/i2c-gpio.yaml.
 106 The device node typically appears at the root of the device tree.
 107 The following is an example of a
 108 .Nm
 109 node with one slave device
 110 on the IIC bus:
 111 .Bd -literal
 112 / {
 113         gpioiic0 {
 114                 compatible = "i2c-gpio";
 115                 pinctrl-names = "default";
 116                 pinctrl-0 = <&pinctrl_gpioiic0>;
 117                 scl-gpios = <&gpio1  5 GPIO_ACTIVE_HIGH>;
 118                 sda-gpios = <&gpio7 11 GPIO_ACTIVE_HIGH>;
 119                 status = "okay";
 120
 121                 /* One slave device on the i2c bus. */
 122                 rtc@51 {
 123                         compatible="nxp,pcf2127";
 124                         reg = <0x51>;
 125                         status = "okay";
 126                 };
 127         };
 128 };
 129 .Ed
 130 .Pp
 131 Where:
 132 .Bl -tag -width ".Va compatible"
 133 .It Va compatible
 134 Should be set to "i2c-gpio".
 135 The deprecated string "gpioiic" is also accepted for backwards compatibility.
 136 .It Va scl-gpios Va sda-gpios
 137 These properties indicate which GPIO pins should be used for clock
 138 and data on the GPIO IIC bit-banging bus.
 139 There is no requirement that the two pins belong to the same gpio controller.
 140 .It Va pinctrl-names pinctrl-0
 141 These properties may be required to configure the chosen pins as gpio
 142 pins, unless the pins default to that state on your system.
 143 .El
 144 .Sh SEE ALSO
 145 .Xr fdt 4 ,
 146 .Xr gpio 4 ,
 147 .Xr iic 4 ,
 148 .Xr iicbb 4 ,
 149 .Xr iicbus 4
 150 .Sh HISTORY
 151 The
 152 .Nm
 153 manual page first appeared in
 154 .Fx 10.1 .
 155 .Sh AUTHORS
 156 This
 157 manual page was written by
 158 .An Luiz Otavio O Souza .