From: Shannon Booth Date: Thu, 12 Apr 2018 02:58:21 +0000 (+1200) Subject: staging: pi433: Fixed typos and grammar in documentation X-Git-Tag: v4.19~841^2~581 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=fb407e32ea305bb5b71007febbe28d6c9dda4cc5;p=platform%2Fkernel%2Flinux-rpi.git staging: pi433: Fixed typos and grammar in documentation Some typos and grammar issues were found in the documentation. These mistakes were fixed. Signed-off-by: Shannon Booth Signed-off-by: Greg Kroah-Hartman --- diff --git a/drivers/staging/pi433/Documentation/devicetree/pi433.txt b/drivers/staging/pi433/Documentation/devicetree/pi433.txt index 9ff217f..a810548 100644 --- a/drivers/staging/pi433/Documentation/devicetree/pi433.txt +++ b/drivers/staging/pi433/Documentation/devicetree/pi433.txt @@ -46,10 +46,10 @@ It consists of the three gpio pins and an spi interface (here chip select 0) For Raspbian users only ======================= -Since Raspbian supports device tree overlays, you may use and overlay, instead +Since Raspbian supports device tree overlays, you may use an overlay instead of editing your boards device tree. -For using the overlay, you need to compile the file pi433-overlay.dts you can -find aside to this documentation. +To use the overlay, you need to compile the file pi433-overlay.dts which can +be found alongside this documentation. The file needs to be compiled - either manually or by integration in your kernel source tree. For a manual compile, you may use a command line like the following: 'linux/scripts/dtc/dtc -@ -I dts -O dtb -o pi433.dtbo pi433-overlay.dts' diff --git a/drivers/staging/pi433/Documentation/pi433.txt b/drivers/staging/pi433/Documentation/pi433.txt index d0b7000..21cffdb 100644 --- a/drivers/staging/pi433/Documentation/pi433.txt +++ b/drivers/staging/pi433/Documentation/pi433.txt @@ -8,11 +8,11 @@ Introduction This driver is for controlling pi433, a radio module for the Raspberry Pi (www.pi433.de). It supports transmission and reception. It can be opened by multiple applications for transmission and reception. While transmit -jobs were queued and process automatically in the background, the first +jobs are queued and processed automatically in the background, the first application asking for reception will block out all other applications until something gets received terminates the read request. The driver supports on the fly reloading of the hardware fifo of the rf -chip, thus enabling for much longer telegrams then hardware fifo size. +chip, thus enabling for much longer telegrams than the hardware fifo size. Discription of driver operation =============================== @@ -46,10 +46,10 @@ configuration set is written to the rf module and it gets set into receiving mod Now the driver is waiting, that a predefined RSSI level (signal strength at the receiver) is reached. Until this hasn't happened, the reception can be interrupted by the transmission thread at any time to insert a transmission cycle. -As soon as the predefined RSSI level is meat, a receiving cycle starts. Similar +As soon as the predefined RSSI level is met, a receiving cycle starts. Similar as described for the transmission cycle the read out of the hardware fifo is done dynamically. Upon each hardware fifo threshold interrupt, a portion of data gets -read. So also for reception it is possible to receive more data then the hardware +read. So also for reception it is possible to receive more data than the hardware fifo can hold. @@ -225,7 +225,7 @@ rf params: isn't found, telegram will be internally discarded optionOff - sync detection is disabled. enable_length_byte - optionOn - First byte of payload will be used as length byte, + optionOn - First byte of payload will be used as a length byte, regardless of the amount of bytes that were requested by the read request. optionOff - Number of bytes to be read will be set according to