Commit 7c672abc authored by Linus Torvalds's avatar Linus Torvalds
Browse files

Merge tag 'docs-5.4' of git://git.lwn.net/linux 

Pull documentation updates from Jonathan Corbet:
 "It's a somewhat calmer cycle for docs this time, as the churn of the
  mass RST conversion is happily mostly behind us.

   - A new document on reproducible builds.

   - We finally got around to zapping the documentation for hardware
     support that was removed in 2004; one doesn't want to rush these
     things.

   - The usual assortment of fixes, typo corrections, etc"

* tag 'docs-5.4' of git://git.lwn.net/linux: (67 commits)
  Documentation: kbuild: Add document about reproducible builds
  docs: printk-formats: Stop encouraging use of unnecessary %h[xudi] and %hh[xudi]
  Documentation: Add "earlycon=sbi" to the admin guide
  doc:lock: remove reference to clever use of read-write lock
  devices.txt: improve entry for comedi (char major 98)
  docs: mtd: Update spi nor reference driver
  doc: arm64: fix grammar dtb placed in no attributes region
  Documentation: sysrq: don't recommend 'S' 'U' before 'B'...
parents 19023141 fe013f8b

.mailmap

+14 −5
Original line number Diff line number Diff line
@@ -47,6 +47,8 @@ Boris Brezillon <bbrezillon@kernel.org> <b.brezillon.dev@gmail.com> 
Boris Brezillon <bbrezillon@kernel.org> <b.brezillon@overkiz.com>

Brian Avery <b.avery@hp.com>

Brian King <brking@us.ibm.com>

Chao Yu <chao@kernel.org> <chao2.yu@samsung.com>

Chao Yu <chao@kernel.org> <yuchao0@huawei.com>

Christoph Hellwig <hch@lst.de>

Christophe Ricard <christophe.ricard@gmail.com>

Corey Minyard <minyard@acm.org>
@@ -80,6 +82,8 @@ Frank Rowand <frowand.list@gmail.com> <frowand@mvista.com> 
Frank Rowand <frowand.list@gmail.com> <frank.rowand@am.sony.com>

Frank Rowand <frowand.list@gmail.com> <frank.rowand@sonymobile.com>

Frank Zago <fzago@systemfabricworks.com>

Gao Xiang <xiang@kernel.org> <gaoxiang25@huawei.com>

Gao Xiang <xiang@kernel.org> <hsiangkao@aol.com>

Greg Kroah-Hartman <greg@echidna.(none)>

Greg Kroah-Hartman <gregkh@suse.de>

Greg Kroah-Hartman <greg@kroah.com>
@@ -90,6 +94,9 @@ Henrik Kretzschmar <henne@nachtwindheim.de> 
Henrik Rydberg <rydberg@bitmath.org>

Herbert Xu <herbert@gondor.apana.org.au>

Jacob Shin <Jacob.Shin@amd.com>

Jaegeuk Kim <jaegeuk@kernel.org> <jaegeuk@google.com>

Jaegeuk Kim <jaegeuk@kernel.org> <jaegeuk@motorola.com>

Jaegeuk Kim <jaegeuk@kernel.org> <jaegeuk.kim@samsung.com>

James Bottomley <jejb@mulgrave.(none)>

James Bottomley <jejb@titanic.il.steeleye.com>

James E Wilson <wilson@specifix.com>
@@ -181,6 +188,11 @@ Nguyen Anh Quynh <aquynh@gmail.com> 
Nicolas Ferre <nicolas.ferre@microchip.com> <nicolas.ferre@atmel.com>

Nicolas Pitre <nico@fluxnic.net> <nicolas.pitre@linaro.org>

Nicolas Pitre <nico@fluxnic.net> <nico@linaro.org>

Oleksij Rempel <linux@rempel-privat.de> <bug-track@fisher-privat.net>

Oleksij Rempel <linux@rempel-privat.de> <external.Oleksij.Rempel@de.bosch.com>

Oleksij Rempel <linux@rempel-privat.de> <fixed-term.Oleksij.Rempel@de.bosch.com>

Oleksij Rempel <linux@rempel-privat.de> <o.rempel@pengutronix.de>

Oleksij Rempel <linux@rempel-privat.de> <ore@pengutronix.de>

Paolo 'Blaisorblade' Giarrusso <blaisorblade@yahoo.it>

Patrick Mochel <mochel@digitalimplant.org>

Paul Burton <paul.burton@mips.com> <paul.burton@imgtec.com>
@@ -191,11 +203,7 @@ Pratyush Anand <pratyush.anand@gmail.com> <pratyush.anand@st.com> 
Praveen BP <praveenbp@ti.com>

Punit Agrawal <punitagrawal@gmail.com> <punit.agrawal@arm.com>

Qais Yousef <qsyousef@gmail.com> <qais.yousef@imgtec.com>

Oleksij Rempel <linux@rempel-privat.de> <bug-track@fisher-privat.net>

Oleksij Rempel <linux@rempel-privat.de> <external.Oleksij.Rempel@de.bosch.com>

Oleksij Rempel <linux@rempel-privat.de> <fixed-term.Oleksij.Rempel@de.bosch.com>

Oleksij Rempel <linux@rempel-privat.de> <o.rempel@pengutronix.de>

Oleksij Rempel <linux@rempel-privat.de> <ore@pengutronix.de>

Quentin Perret <qperret@qperret.net> <quentin.perret@arm.com>

Rajesh Shah <rajesh.shah@intel.com>

Ralf Baechle <ralf@linux-mips.org>

Ralf Wildenhues <Ralf.Wildenhues@gmx.de>
@@ -230,6 +238,7 @@ Sumit Semwal <sumit.semwal@ti.com> 
Tejun Heo <htejun@gmail.com>

Thomas Graf <tgraf@suug.ch>

Thomas Pedersen <twp@codeaurora.org>

Todor Tomov <todor.too@gmail.com> <todor.tomov@linaro.org>

Tony Luck <tony.luck@intel.com>

TripleX Chung <xxx.phy@gmail.com> <zhongyu@18mail.cn>

TripleX Chung <xxx.phy@gmail.com> <triplex@zh-kernel.org>

Documentation/ABI/stable/sysfs-bus-w1

+1 −1
Original line number Diff line number Diff line
@@ -6,6 +6,6 @@ Description: Bus scanning interval, microseconds component. 
		control systems are attached/generate presence for as short as

		100 ms - hence the tens-to-hundreds milliseconds scan intervals

		are required.

		see Documentation/w1/w1.generic for detailed information.

		see Documentation/w1/w1-generic.rst for detailed information.

Users:		any user space application which wants to know bus scanning

		interval

Documentation/ABI/stable/sysfs-driver-w1_ds28e04

+2 −2
Original line number Diff line number Diff line
@@ -2,7 +2,7 @@ What: /sys/bus/w1/devices/.../pio 
Date:		May 2012

Contact:	Markus Franke <franm@hrz.tu-chemnitz.de>

Description:	read/write the contents of the two PIO's of the DS28E04-100

		see Documentation/w1/slaves/w1_ds28e04 for detailed information

		see Documentation/w1/slaves/w1_ds28e04.rst for detailed information

Users:		any user space application which wants to communicate with DS28E04-100
@@ -11,5 +11,5 @@ What: /sys/bus/w1/devices/.../eeprom 
Date:		May 2012

Contact:	Markus Franke <franm@hrz.tu-chemnitz.de>

Description:	read/write the contents of the EEPROM memory of the DS28E04-100

		see Documentation/w1/slaves/w1_ds28e04 for detailed information

		see Documentation/w1/slaves/w1_ds28e04.rst for detailed information

Users:		any user space application which wants to communicate with DS28E04-100

Documentation/ABI/stable/sysfs-driver-w1_ds28ea00

+1 −1
Original line number Diff line number Diff line
@@ -2,5 +2,5 @@ What: /sys/bus/w1/devices/.../w1_seq 
Date:		Apr 2015

Contact:	Matt Campbell <mattrcampbell@gmail.com>

Description:	Support for the DS28EA00 chain sequence function

		see Documentation/w1/slaves/w1_therm for detailed information

		see Documentation/w1/slaves/w1_therm.rst for detailed information

Users:		any user space application which wants to communicate with DS28EA00

Documentation/admin-guide/auxdisplay/cfag12864b.rst

0 → 100644
+98 −0
Original line number Diff line number Diff line 
===================================

cfag12864b LCD Driver Documentation

===================================



:License:		GPLv2

:Author & Maintainer:	Miguel Ojeda Sandonis

:Date:			2006-10-27







.. INDEX



	1. DRIVER INFORMATION

	2. DEVICE INFORMATION

	3. WIRING

	4. USERSPACE PROGRAMMING



1. Driver Information

---------------------



This driver supports a cfag12864b LCD.





2. Device Information

---------------------



:Manufacturer:	Crystalfontz

:Device Name:	Crystalfontz 12864b LCD Series

:Device Code:	cfag12864b

:Webpage:	http://www.crystalfontz.com

:Device Webpage: http://www.crystalfontz.com/products/12864b/

:Type:		LCD (Liquid Crystal Display)

:Width:		128

:Height:	64

:Colors:	2 (B/N)

:Controller:	ks0108

:Controllers:	2

:Pages:		8 each controller

:Addresses:	64 each page

:Data size:	1 byte each address

:Memory size:	2 * 8 * 64 * 1 = 1024 bytes = 1 Kbyte





3. Wiring

---------



The cfag12864b LCD Series don't have official wiring.



The common wiring is done to the parallel port as shown::



  Parallel Port                          cfag12864b



    Name Pin#                            Pin# Name



  Strobe ( 1)------------------------------(17) Enable

  Data 0 ( 2)------------------------------( 4) Data 0

  Data 1 ( 3)------------------------------( 5) Data 1

  Data 2 ( 4)------------------------------( 6) Data 2

  Data 3 ( 5)------------------------------( 7) Data 3

  Data 4 ( 6)------------------------------( 8) Data 4

  Data 5 ( 7)------------------------------( 9) Data 5

  Data 6 ( 8)------------------------------(10) Data 6

  Data 7 ( 9)------------------------------(11) Data 7

         (10)                      [+5v]---( 1) Vdd

         (11)                      [GND]---( 2) Ground

         (12)                      [+5v]---(14) Reset

         (13)                      [GND]---(15) Read / Write

    Line (14)------------------------------(13) Controller Select 1

         (15)

    Init (16)------------------------------(12) Controller Select 2

  Select (17)------------------------------(16) Data / Instruction

  Ground (18)---[GND]              [+5v]---(19) LED +

  Ground (19)---[GND]

  Ground (20)---[GND]              E    A             Values:

  Ground (21)---[GND]       [GND]---[P1]---(18) Vee    - R = Resistor = 22 ohm

  Ground (22)---[GND]                |                 - P1 = Preset = 10 Kohm

  Ground (23)---[GND]       ----   S ------( 3) V0     - P2 = Preset = 1 Kohm

  Ground (24)---[GND]       |  |

  Ground (25)---[GND] [GND]---[P2]---[R]---(20) LED -





4. Userspace Programming

------------------------



The cfag12864bfb describes a framebuffer device (/dev/fbX).



It has a size of 1024 bytes = 1 Kbyte.

Each bit represents one pixel. If the bit is high, the pixel will

turn on. If the pixel is low, the pixel will turn off.



You can use the framebuffer as a file: fopen, fwrite, fclose...

Although the LCD won't get updated until the next refresh time arrives.



Also, you can mmap the framebuffer: open & mmap, munmap & close...

which is the best option for most uses.



Check samples/auxdisplay/cfag12864b-example.c

for a real working userspace complete program with usage examples.