rk_i2c: Add manpage for this driver

This commit is contained in:
Emmanuel Vadot 2018-06-14 07:59:47 +00:00
parent 3ea947d615
commit 19668eb2bf
2 changed files with 66 additions and 0 deletions

View File

@ -446,6 +446,7 @@ MAN= aac.4 \
rights.4 \
${_rk_gpio.4} \
${_rk_grf.4} \
${_rk_i2c.4} \
${_rk_pinctrl.4} \
rl.4 \
rndtest.4 \
@ -765,6 +766,7 @@ MLINKS+=xl.4 if_xl.4
_armv8crypto.4= armv8crypto.4
_rk_gpio.4= rk_gpio.4
_rk_grf.4= rk_grf.4
_rk_i2c.4= rk_i2c.4
_rk_pinctrl.4= rk_pinctrl.4
.endif

64
share/man/man4/rk_i2c.4 Normal file
View File

@ -0,0 +1,64 @@
.\"-
.\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD
.\"
.\" Copyright (c) 2018 Emmanuel Vadot <manu@freebsd.org>
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd June 14, 2018
.Dt RK_I2C 4
.Os
.Sh NAME
.Nm rk_i2c
.Nd driver for the i2c controller on RockChip SoCs
.Sh SYNOPSIS
.Cd "options SOC_ROCKCHIP_RK3328"
.Sh DESCRIPTION
The
.Nm
device driver provides support for the i2c controller device present
on RockChip SoC.
.Sh HARDWARE
The current version of the
.Nm
driver supports the i2c controller with one of the following
compatible strings :
.Pp
.Bl -bullet -compact
.It
rockchip,rk3328-i2c
.El
.Sh SEE ALSO
.Xr iic 4 ,
.Xr iicbus 4 ,
.Sh HISTORY
The
.Nm
device driver first appeared in
.Fx 12.0 .
.Sh AUTHORS
The
.Nm
device driver and manpage was written by
.An Emmanuel Vadot Aq Mt manu@freebsd.org .