summaryrefslogtreecommitdiffstats
path: root/share
diff options
context:
space:
mode:
authorloos <loos@FreeBSD.org>2014-06-24 19:42:37 +0000
committerloos <loos@FreeBSD.org>2014-06-24 19:42:37 +0000
commit928160360e0bd1ccb898a0e9be8fcc5328e89141 (patch)
treed98c2a23a9455835308c42c51da0a5a1a3a3a321 /share
parent3211f93c4b301897d0f2122478b58783614c36d8 (diff)
downloadFreeBSD-src-928160360e0bd1ccb898a0e9be8fcc5328e89141.zip
FreeBSD-src-928160360e0bd1ccb898a0e9be8fcc5328e89141.tar.gz
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 MFC after: 1 week
Diffstat (limited to 'share')
-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 a8de998..4bbc846 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
@@ -105,6 +105,7 @@ Some I2C interfaces are available:
.El
.Sh SEE ALSO
.Xr bktr 4 ,
+.Xr iic 4 ,
.Xr iicbb 4 ,
.Xr lpbb 4 ,
.Xr pcf 4
OpenPOWER on IntegriCloud