diff options
author | brueffer <brueffer@FreeBSD.org> | 2014-02-20 16:35:48 +0000 |
---|---|---|
committer | brueffer <brueffer@FreeBSD.org> | 2014-02-20 16:35:48 +0000 |
commit | 13f3fcac7a2c8d3b115fd0aa82be6b0eb5a4c956 (patch) | |
tree | fdb0cf23beda29030a259b5dbbb79b183b38608c /share/man | |
parent | 90bde37d521e7062d2afbeab21d6632fa01d4a98 (diff) | |
download | FreeBSD-src-13f3fcac7a2c8d3b115fd0aa82be6b0eb5a4c956.zip FreeBSD-src-13f3fcac7a2c8d3b115fd0aa82be6b0eb5a4c956.tar.gz |
Spelling, grammar and mdoc cleanup.
Diffstat (limited to 'share/man')
-rw-r--r-- | share/man/man4/gpioiic.4 | 33 | ||||
-rw-r--r-- | share/man/man4/gpioled.4 | 43 |
2 files changed, 46 insertions, 30 deletions
diff --git a/share/man/man4/gpioiic.4 b/share/man/man4/gpioiic.4 index e3f9814..2075096 100644 --- a/share/man/man4/gpioiic.4 +++ b/share/man/man4/gpioiic.4 @@ -31,43 +31,53 @@ .Nm gpioiic .Nd GPIO I2C bit-banging device driver .Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent .Cd "device gpio" .Cd "device gpioiic" .Cd "device iic" .Cd "device iicbb" .Cd "device iicbus" +.Ed .Sh DESCRIPTION The -.Em gpioiic +.Nm driver provides an IIC bit-banging interface using two GPIO pins for the SCL and SDA on the -.Em gpiobus . +.Nm gpiobus . .Nm -implements an open colector kind of output, as recommended by the standard, +implements an open collector kind of output, as recommended by the standard, when driving the pins on the -.Em gpiobus , +.Nm gpiobus , i.e, they are never switched to the logical value of '1', or they are '0' or simply open (Hi-Z/tri-state). So the pullup resistors are required so .Nm can work. .Pp -On a hint based system, like -.Li MIPS , these values are configureable for the -.Nm gpioiic : +On a +.Xr device.hints 5 +based system, like +.Li MIPS , +these values are configurable for the +.Nm : .Bl -tag -width ".Va hint.gpioiic.%d.atXXX" .It Va hint.gpioiic.%d.at -The gpiobus you are attaching to. +The +.Nm gpiobus +you are attaching to. Normally just gpiobus0. .It Va hint.gpioiic.%d.pins This is a bitmask of the pins on the -.Em gpiobus +.Nm gpiobus that are to be used for SCLOCK and SDATA from the GPIO IIC bit-banging bus. To configure pin 0 and 7, use the bitmask of 0b10000001 and convert it to a hexadecimal value of 0x0081. Please note that this mask should only ever have two bits set -(any others bits - i.e., pins - will be ignored). +(any other bits - i.e., pins - will be ignored). .It Va hint.gpioiic.%d.scl Indicates which bit in the .Va hint.gpioiic.%d.pins @@ -85,7 +95,8 @@ Optional, defaults to 1. On a .Xr FDT 4 based system, like -.Li ARM , the dts part for a +.Li ARM , +the DTS part for a .Nm gpioiic device usually looks like: .Bd -literal diff --git a/share/man/man4/gpioled.4 b/share/man/man4/gpioled.4 index 74c28e6..4f428f6 100644 --- a/share/man/man4/gpioled.4 +++ b/share/man/man4/gpioled.4 @@ -29,30 +29,34 @@ .Os .Sh NAME .Nm gpioled -.Nd GPIO led generic device driver +.Nd GPIO LED generic device driver .Sh SYNOPSIS +To compile this driver into the kernel, +place the following lines in your +kernel configuration file: +.Bd -ragged -offset indent .Cd "device gpio" .Cd "device gpioled" -.Pp -This driver attaches a -.Xr led 4 -device to a GPIO pin. +.Ed .Sh DESCRIPTION The -.Em gpioled -driver provides a glue to attach a +.Nm +driver provides glue to attach a .Xr led 4 compatible device to a GPIO pin. -Each led on the system has a +Each LED in the system has a .Pa name -which is used to export a device in +which is used to export a device as .Pa /dev/led/<name> . The GPIO pin can then be controlled by writing to this device as described -on +in .Xr led 4 . .Pp -On a hint based system, like -.Li MIPS , these values are configureable for +On a +.Xr device.hints 5 +based system, like +.Li MIPS , +these values are configurable for .Nm : .Bl -tag -width ".Va hint.gpioiic.%d.atXXX" .It Va hint.gpioled.%d.at @@ -66,13 +70,14 @@ to create for .It Va hint.gpioled.%d.pins Which pin on the GPIO interface to map to this instance. Please note that this mask should only ever have one bit set -(any others bits - i.e., pins - will be ignored). +(any other bits - i.e., pins - will be ignored). .El .Pp On a .Xr FDT 4 based system, like -.Li ARM , the dts part for a +.Li ARM , +the DTS part for a .Nm gpioled device usually looks like: .Bd -literal @@ -95,7 +100,7 @@ gpio: gpio { }; .Ed .Pp -And optionally, you can choose combine all the leds under a single +Optionally, you can choose to combine all the LEDs under a single .Dq gpio-leds compatible node: .Bd -literal @@ -119,7 +124,7 @@ simplebus0 { }; .Ed .Pp -Both methods are equally supported and it is possible to have the leds +Both methods are equally supported and it is possible to have the LEDs defined with any sort of mix between the methods. The only restriction is that a GPIO pin cannot be mapped by two different (gpio)leds. @@ -131,15 +136,15 @@ property, please consult .Pp The property .Va name -is the arbitrary name of device in +is the arbitrary name of the device in .Pa /dev/led/ to create for .Xr led 4 . .Sh SEE ALSO .Xr fdt 4 , .Xr gpio 4 , -.Xr led 4 , -.Xr gpioiic 4 +.Xr gpioiic 4 , +.Xr led 4 .Sh HISTORY The .Nm |