docs: admin-guide: add auxdisplay files to it after conversion to ReST

+98

Documentation/admin-guide/auxdisplay/cfag12864b.rst

··· 1 + =================================== 2 + cfag12864b LCD Driver Documentation 3 + =================================== 4 + 5 + :License: GPLv2 6 + :Author & Maintainer: Miguel Ojeda Sandonis 7 + :Date: 2006-10-27 8 + 9 + 10 + 11 + .. INDEX 12 + 13 + 1. DRIVER INFORMATION 14 + 2. DEVICE INFORMATION 15 + 3. WIRING 16 + 4. USERSPACE PROGRAMMING 17 + 18 + 1. Driver Information 19 + --------------------- 20 + 21 + This driver supports a cfag12864b LCD. 22 + 23 + 24 + 2. Device Information 25 + --------------------- 26 + 27 + :Manufacturer: Crystalfontz 28 + :Device Name: Crystalfontz 12864b LCD Series 29 + :Device Code: cfag12864b 30 + :Webpage: http://www.crystalfontz.com 31 + :Device Webpage: http://www.crystalfontz.com/products/12864b/ 32 + :Type: LCD (Liquid Crystal Display) 33 + :Width: 128 34 + :Height: 64 35 + :Colors: 2 (B/N) 36 + :Controller: ks0108 37 + :Controllers: 2 38 + :Pages: 8 each controller 39 + :Addresses: 64 each page 40 + :Data size: 1 byte each address 41 + :Memory size: 2 * 8 * 64 * 1 = 1024 bytes = 1 Kbyte 42 + 43 + 44 + 3. Wiring 45 + --------- 46 + 47 + The cfag12864b LCD Series don't have official wiring. 48 + 49 + The common wiring is done to the parallel port as shown:: 50 + 51 + Parallel Port cfag12864b 52 + 53 + Name Pin# Pin# Name 54 + 55 + Strobe ( 1)------------------------------(17) Enable 56 + Data 0 ( 2)------------------------------( 4) Data 0 57 + Data 1 ( 3)------------------------------( 5) Data 1 58 + Data 2 ( 4)------------------------------( 6) Data 2 59 + Data 3 ( 5)------------------------------( 7) Data 3 60 + Data 4 ( 6)------------------------------( 8) Data 4 61 + Data 5 ( 7)------------------------------( 9) Data 5 62 + Data 6 ( 8)------------------------------(10) Data 6 63 + Data 7 ( 9)------------------------------(11) Data 7 64 + (10) [+5v]---( 1) Vdd 65 + (11) [GND]---( 2) Ground 66 + (12) [+5v]---(14) Reset 67 + (13) [GND]---(15) Read / Write 68 + Line (14)------------------------------(13) Controller Select 1 69 + (15) 70 + Init (16)------------------------------(12) Controller Select 2 71 + Select (17)------------------------------(16) Data / Instruction 72 + Ground (18)---[GND] [+5v]---(19) LED + 73 + Ground (19)---[GND] 74 + Ground (20)---[GND] E A Values: 75 + Ground (21)---[GND] [GND]---[P1]---(18) Vee - R = Resistor = 22 ohm 76 + Ground (22)---[GND] | - P1 = Preset = 10 Kohm 77 + Ground (23)---[GND] ---- S ------( 3) V0 - P2 = Preset = 1 Kohm 78 + Ground (24)---[GND] | | 79 + Ground (25)---[GND] [GND]---[P2]---[R]---(20) LED - 80 + 81 + 82 + 4. Userspace Programming 83 + ------------------------ 84 + 85 + The cfag12864bfb describes a framebuffer device (/dev/fbX). 86 + 87 + It has a size of 1024 bytes = 1 Kbyte. 88 + Each bit represents one pixel. If the bit is high, the pixel will 89 + turn on. If the pixel is low, the pixel will turn off. 90 + 91 + You can use the framebuffer as a file: fopen, fwrite, fclose... 92 + Although the LCD won't get updated until the next refresh time arrives. 93 + 94 + Also, you can mmap the framebuffer: open & mmap, munmap & close... 95 + which is the best option for most uses. 96 + 97 + Check samples/auxdisplay/cfag12864b-example.c 98 + for a real working userspace complete program with usage examples.

+16

Documentation/admin-guide/auxdisplay/index.rst

··· 1 + ========================= 2 + Auxiliary Display Support 3 + ========================= 4 + 5 + .. toctree:: 6 + :maxdepth: 1 7 + 8 + ks0108.rst 9 + cfag12864b.rst 10 + 11 + .. only:: subproject and html 12 + 13 + Indices 14 + ======= 15 + 16 + * :ref:`genindex`

+50

Documentation/admin-guide/auxdisplay/ks0108.rst

··· 1 + ========================================== 2 + ks0108 LCD Controller Driver Documentation 3 + ========================================== 4 + 5 + :License: GPLv2 6 + :Author & Maintainer: Miguel Ojeda Sandonis 7 + :Date: 2006-10-27 8 + 9 + 10 + 11 + .. INDEX 12 + 13 + 1. DRIVER INFORMATION 14 + 2. DEVICE INFORMATION 15 + 3. WIRING 16 + 17 + 18 + 1. Driver Information 19 + --------------------- 20 + 21 + This driver supports the ks0108 LCD controller. 22 + 23 + 24 + 2. Device Information 25 + --------------------- 26 + 27 + :Manufacturer: Samsung 28 + :Device Name: KS0108 LCD Controller 29 + :Device Code: ks0108 30 + :Webpage: - 31 + :Device Webpage: - 32 + :Type: LCD Controller (Liquid Crystal Display Controller) 33 + :Width: 64 34 + :Height: 64 35 + :Colors: 2 (B/N) 36 + :Pages: 8 37 + :Addresses: 64 each page 38 + :Data size: 1 byte each address 39 + :Memory size: 8 * 64 * 1 = 512 bytes 40 + 41 + 42 + 3. Wiring 43 + --------- 44 + 45 + The driver supports data parallel port wiring. 46 + 47 + If you aren't building LCD related hardware, you should check 48 + your LCD specific wiring information in the same folder. 49 + 50 + For example, check Documentation/admin-guide/auxdisplay/cfag12864b.rst

+1

Documentation/admin-guide/index.rst

··· 100 100 iostats 101 101 kernel-per-CPU-kthreads 102 102 laptops/index 103 + auxdisplay/index 103 104 lcd-panel-cgram 104 105 ldm 105 106 lockup-watchdogs

-105

Documentation/auxdisplay/cfag12864b

··· 1 - =================================== 2 - cfag12864b LCD Driver Documentation 3 - =================================== 4 - 5 - License: GPLv2 6 - Author & Maintainer: Miguel Ojeda Sandonis 7 - Date: 2006-10-27 8 - 9 - 10 - 11 - -------- 12 - 0. INDEX 13 - -------- 14 - 15 - 1. DRIVER INFORMATION 16 - 2. DEVICE INFORMATION 17 - 3. WIRING 18 - 4. USERSPACE PROGRAMMING 19 - 20 - 21 - --------------------- 22 - 1. DRIVER INFORMATION 23 - --------------------- 24 - 25 - This driver supports a cfag12864b LCD. 26 - 27 - 28 - --------------------- 29 - 2. DEVICE INFORMATION 30 - --------------------- 31 - 32 - Manufacturer: Crystalfontz 33 - Device Name: Crystalfontz 12864b LCD Series 34 - Device Code: cfag12864b 35 - Webpage: http://www.crystalfontz.com 36 - Device Webpage: http://www.crystalfontz.com/products/12864b/ 37 - Type: LCD (Liquid Crystal Display) 38 - Width: 128 39 - Height: 64 40 - Colors: 2 (B/N) 41 - Controller: ks0108 42 - Controllers: 2 43 - Pages: 8 each controller 44 - Addresses: 64 each page 45 - Data size: 1 byte each address 46 - Memory size: 2 * 8 * 64 * 1 = 1024 bytes = 1 Kbyte 47 - 48 - 49 - --------- 50 - 3. WIRING 51 - --------- 52 - 53 - The cfag12864b LCD Series don't have official wiring. 54 - 55 - The common wiring is done to the parallel port as shown: 56 - 57 - Parallel Port cfag12864b 58 - 59 - Name Pin# Pin# Name 60 - 61 - Strobe ( 1)------------------------------(17) Enable 62 - Data 0 ( 2)------------------------------( 4) Data 0 63 - Data 1 ( 3)------------------------------( 5) Data 1 64 - Data 2 ( 4)------------------------------( 6) Data 2 65 - Data 3 ( 5)------------------------------( 7) Data 3 66 - Data 4 ( 6)------------------------------( 8) Data 4 67 - Data 5 ( 7)------------------------------( 9) Data 5 68 - Data 6 ( 8)------------------------------(10) Data 6 69 - Data 7 ( 9)------------------------------(11) Data 7 70 - (10) [+5v]---( 1) Vdd 71 - (11) [GND]---( 2) Ground 72 - (12) [+5v]---(14) Reset 73 - (13) [GND]---(15) Read / Write 74 - Line (14)------------------------------(13) Controller Select 1 75 - (15) 76 - Init (16)------------------------------(12) Controller Select 2 77 - Select (17)------------------------------(16) Data / Instruction 78 - Ground (18)---[GND] [+5v]---(19) LED + 79 - Ground (19)---[GND] 80 - Ground (20)---[GND] E A Values: 81 - Ground (21)---[GND] [GND]---[P1]---(18) Vee - R = Resistor = 22 ohm 82 - Ground (22)---[GND] | - P1 = Preset = 10 Kohm 83 - Ground (23)---[GND] ---- S ------( 3) V0 - P2 = Preset = 1 Kohm 84 - Ground (24)---[GND] | | 85 - Ground (25)---[GND] [GND]---[P2]---[R]---(20) LED - 86 - 87 - 88 - ------------------------ 89 - 4. USERSPACE PROGRAMMING 90 - ------------------------ 91 - 92 - The cfag12864bfb describes a framebuffer device (/dev/fbX). 93 - 94 - It has a size of 1024 bytes = 1 Kbyte. 95 - Each bit represents one pixel. If the bit is high, the pixel will 96 - turn on. If the pixel is low, the pixel will turn off. 97 - 98 - You can use the framebuffer as a file: fopen, fwrite, fclose... 99 - Although the LCD won't get updated until the next refresh time arrives. 100 - 101 - Also, you can mmap the framebuffer: open & mmap, munmap & close... 102 - which is the best option for most uses. 103 - 104 - Check samples/auxdisplay/cfag12864b-example.c 105 - for a real working userspace complete program with usage examples.

-55

Documentation/auxdisplay/ks0108

··· 1 - ========================================== 2 - ks0108 LCD Controller Driver Documentation 3 - ========================================== 4 - 5 - License: GPLv2 6 - Author & Maintainer: Miguel Ojeda Sandonis 7 - Date: 2006-10-27 8 - 9 - 10 - 11 - -------- 12 - 0. INDEX 13 - -------- 14 - 15 - 1. DRIVER INFORMATION 16 - 2. DEVICE INFORMATION 17 - 3. WIRING 18 - 19 - 20 - --------------------- 21 - 1. DRIVER INFORMATION 22 - --------------------- 23 - 24 - This driver supports the ks0108 LCD controller. 25 - 26 - 27 - --------------------- 28 - 2. DEVICE INFORMATION 29 - --------------------- 30 - 31 - Manufacturer: Samsung 32 - Device Name: KS0108 LCD Controller 33 - Device Code: ks0108 34 - Webpage: - 35 - Device Webpage: - 36 - Type: LCD Controller (Liquid Crystal Display Controller) 37 - Width: 64 38 - Height: 64 39 - Colors: 2 (B/N) 40 - Pages: 8 41 - Addresses: 64 each page 42 - Data size: 1 byte each address 43 - Memory size: 8 * 64 * 1 = 512 bytes 44 - 45 - 46 - --------- 47 - 3. WIRING 48 - --------- 49 - 50 - The driver supports data parallel port wiring. 51 - 52 - If you aren't building LCD related hardware, you should check 53 - your LCD specific wiring information in the same folder. 54 - 55 - For example, check Documentation/auxdisplay/cfag12864b.

+1 -1

MAINTAINERS

··· 9001 9001 KS0108 LCD CONTROLLER DRIVER 9002 9002 M: Miguel Ojeda Sandonis <miguel.ojeda.sandonis@gmail.com> 9003 9003 S: Maintained 9004 - F: Documentation/auxdisplay/ks0108 9004 + F: Documentation/admin-guide/auxdisplay/ks0108.rst 9005 9005 F: drivers/auxdisplay/ks0108.c 9006 9006 F: include/linux/ks0108.h 9007 9007

+1 -1

drivers/auxdisplay/Kconfig

··· 97 97 say Y. You also need the ks0108 LCD Controller driver. 98 98 99 99 For help about how to wire your LCD to the parallel port, 100 - check Documentation/auxdisplay/cfag12864b 100 + check Documentation/admin-guide/auxdisplay/cfag12864b.rst 101 101 102 102 Depends on the x86 arch and the framebuffer support. 103 103