d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Clarify the expected usage of I2C 7-bit slave addresses on ioctl(2)

Browse Source 
interface.

While here add the cross reference to iic(4) on iicbus(4).

CR:		D210
Suggested by:	jmg
MFC after:	1 week
This commit is contained in:
loos 2014-06-24 19:42:37 +00:00
parent 3211f93c4b
commit 928160360e
2 changed files with 18 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
share/man/man4/iic.4
View File

@ -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.

3
share/man/man4/iicbus.4
View File

@ -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