summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authorloos <loos@FreeBSD.org>2014-08-20 19:37:05 +0000
committerloos <loos@FreeBSD.org>2014-08-20 19:37:05 +0000
commite4ebeceadb6a37e1ccf33800c4312cceabca6b57 (patch)
treee6d1dad9e555738abec006db57843693485d6beb /share/man
parent5efc9173fa69c32dee331f42b6cd63d4b6da7125 (diff)
downloadFreeBSD-src-e4ebeceadb6a37e1ccf33800c4312cceabca6b57.zip
FreeBSD-src-e4ebeceadb6a37e1ccf33800c4312cceabca6b57.tar.gz
MFC r267021:
FreeBSD, historically, has always used 8-bit addresses for i2c devices (7-bit device address << 1), always leaving the room for the read/write bit. This commit convert ti_i2c and revert r259127 on bcm2835_bsc to make them compatible with 8-bit addresses. Previous to this commit an i2c device would have different addresses depending on the controller it was attached to (by example, when compared to any iicbb(4) based i2c controller), which was a pretty annoying behavior. Also, update the PMIC i2c address on beaglebone* DTS files to match the new address scheme. Now the userland utilities need to do the correct slave address shifting (but it is going to work with any i2c controller on the system). Discussed with: ian MFC r267834: Clarify the expected usage of I2C 7-bit slave addresses on ioctl(2) interface. While here add the cross reference to iic(4) on iicbus(4). CR: D210 Suggested by: jmg
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man4/iic.419
-rw-r--r--share/man/man4/iicbus.43
2 files changed, 18 insertions, 4 deletions
diff --git a/share/man/man4/iic.4 b/share/man/man4/iic.4
index 9f410a3..d82f574 100644
--- a/share/man/man4/iic.4
+++ b/share/man/man4/iic.4
@@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd September 6, 2006
+.Dd June 24, 2014
.Dt IIC 4
.Os
.Sh NAME
@@ -51,12 +51,20 @@ following ioctls:
Sends the start condition to the slave specified by the
.Va slave
element to the bus.
+The
+.Va slave
+element consists of a 7-bit address and a read/write bit
+(i.e., 7-bit address << 1 | r/w).
+If the read/write bit is set a read operation is initiated, if the read/write
+bit is cleared a write operation is initiated.
All other elements are ignored.
.It Dv I2CRPTSTART
.Pq Vt "struct iiccmd"
Sends the repeated start condition to the slave specified by the
.Va slave
element to the bus.
+The slave address should be specified as in
+.Dv I2CSTART .
All other elements are ignored.
.It Dv I2CSTOP
No argument is passed.
@@ -115,10 +123,15 @@ is set in
Otherwise the transfer is a write transfer.
The
.Va slave
-element specifies the 7-bit address for the transfer.
+element specifies the 7-bit address with the read/write bit for the transfer.
+The read/write bit will be handled by the iicbus stack based on the specified
+transfer operation.
The
.Va len
-element is the length of the data.
+element is the number of
+.Pq Vt "struct iic_msg"
+messages encoded on
+.Pq Vt "struct iic_rdwr_data" .
The
.Va buf
element is a buffer for that data.
diff --git a/share/man/man4/iicbus.4 b/share/man/man4/iicbus.4
index f9e5c58..e755a42 100644
--- a/share/man/man4/iicbus.4
+++ b/share/man/man4/iicbus.4
@@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd August 6, 1998
+.Dd June 24, 2014
.Dt IICBUS 4
.Os
.Sh NAME
@@ -104,6 +104,7 @@ Some I2C interfaces are available:
.It Sy bktr Ta "Brooktree848 video chipset, hardware and software master-only interface"
.El
.Sh SEE ALSO
+.Xr iic 4 ,
.Xr iicbb 4 ,
.Xr lpbb 4 ,
.Xr pcf 4
OpenPOWER on IntegriCloud