xref: /linux/drivers/auxdisplay/Kconfig (revision bf070bb0e6c62ba3075db0a666763ba52c677102)
1# SPDX-License-Identifier: GPL-2.0
2#
3# For a description of the syntax of this configuration file,
4# see Documentation/kbuild/kconfig-language.txt.
5#
6# Auxiliary display drivers configuration.
7#
8
9menuconfig AUXDISPLAY
10	bool "Auxiliary Display support"
11	---help---
12	  Say Y here to get to see options for auxiliary display drivers.
13	  This option alone does not add any kernel code.
14
15	  If you say N, all options in this submenu will be skipped and disabled.
16
17config CHARLCD
18	tristate "Character LCD core support" if COMPILE_TEST
19
20if AUXDISPLAY
21
22config HD44780
23	tristate "HD44780 Character LCD support"
24	depends on GPIOLIB || COMPILE_TEST
25	select CHARLCD
26	---help---
27	  Enable support for Character LCDs using a HD44780 controller.
28	  The LCD is accessible through the /dev/lcd char device (10, 156).
29	  This code can either be compiled as a module, or linked into the
30	  kernel and started at boot.
31	  If you don't understand what all this is about, say N.
32
33config KS0108
34	tristate "KS0108 LCD Controller"
35	depends on PARPORT_PC
36	default n
37	---help---
38	  If you have a LCD controlled by one or more KS0108
39	  controllers, say Y. You will need also another more specific
40	  driver for your LCD.
41
42	  Depends on Parallel Port support. If you say Y at
43	  parport, you will be able to compile this as a module (M)
44	  and built-in as well (Y).
45
46	  To compile this as a module, choose M here:
47	  the module will be called ks0108.
48
49	  If unsure, say N.
50
51config KS0108_PORT
52	hex "Parallel port where the LCD is connected"
53	depends on KS0108
54	default 0x378
55	---help---
56	  The address of the parallel port where the LCD is connected.
57
58	  The first  standard parallel port address is 0x378.
59	  The second standard parallel port address is 0x278.
60	  The third  standard parallel port address is 0x3BC.
61
62	  You can specify a different address if you need.
63
64	  If you don't know what I'm talking about, load the parport module,
65	  and execute "dmesg" or "cat /proc/ioports". You can see there how
66	  many parallel ports are present and which address each one has.
67
68	  Usually you only need to use 0x378.
69
70	  If you compile this as a module, you can still override this
71	  using the module parameters.
72
73config KS0108_DELAY
74	int "Delay between each control writing (microseconds)"
75	depends on KS0108
76	default "2"
77	---help---
78	  Amount of time the ks0108 should wait between each control write
79	  to the parallel port.
80
81	  If your LCD seems to miss random writings, increment this.
82
83	  If you don't know what I'm talking about, ignore it.
84
85	  If you compile this as a module, you can still override this
86	  value using the module parameters.
87
88config CFAG12864B
89	tristate "CFAG12864B LCD"
90	depends on X86
91	depends on FB
92	depends on KS0108
93	select FB_SYS_FILLRECT
94	select FB_SYS_COPYAREA
95	select FB_SYS_IMAGEBLIT
96	select FB_SYS_FOPS
97	default n
98	---help---
99	  If you have a Crystalfontz 128x64 2-color LCD, cfag12864b Series,
100	  say Y. You also need the ks0108 LCD Controller driver.
101
102	  For help about how to wire your LCD to the parallel port,
103	  check Documentation/auxdisplay/cfag12864b
104
105	  Depends on the x86 arch and the framebuffer support.
106
107	  The LCD framebuffer driver can be attached to a console.
108	  It will work fine. However, you can't attach it to the fbdev driver
109	  of the xorg server.
110
111	  To compile this as a module, choose M here:
112	  the modules will be called cfag12864b and cfag12864bfb.
113
114	  If unsure, say N.
115
116config CFAG12864B_RATE
117       int "Refresh rate (hertz)"
118	depends on CFAG12864B
119	default "20"
120	---help---
121	  Refresh rate of the LCD.
122
123	  As the LCD is not memory mapped, the driver has to make the work by
124	  software. This means you should be careful setting this value higher.
125	  If your CPUs are really slow or you feel the system is slowed down,
126	  decrease the value.
127
128	  Be careful modifying this value to a very high value:
129	  You can freeze the computer, or the LCD maybe can't draw as fast as you
130	  are requesting.
131
132	  If you don't know what I'm talking about, ignore it.
133
134	  If you compile this as a module, you can still override this
135	  value using the module parameters.
136
137config IMG_ASCII_LCD
138	tristate "Imagination Technologies ASCII LCD Display"
139	default y if MIPS_MALTA || MIPS_SEAD3
140	select SYSCON
141	help
142	  Enable this to support the simple ASCII LCD displays found on
143	  development boards such as the MIPS Boston, MIPS Malta & MIPS SEAD3
144	  from Imagination Technologies.
145
146config HT16K33
147	tristate "Holtek Ht16K33 LED controller with keyscan"
148	depends on FB && OF && I2C && INPUT
149	select FB_SYS_FOPS
150	select FB_SYS_FILLRECT
151	select FB_SYS_COPYAREA
152	select FB_SYS_IMAGEBLIT
153	select INPUT_MATRIXKMAP
154	select FB_BACKLIGHT
155	help
156	  Say yes here to add support for Holtek HT16K33, RAM mapping 16*8
157	  LED controller driver with keyscan.
158
159endif # AUXDISPLAY
160
161config ARM_CHARLCD
162	bool "ARM Ltd. Character LCD Driver"
163	depends on PLAT_VERSATILE
164	help
165	  This is a driver for the character LCD found on the ARM Ltd.
166	  Versatile and RealView Platform Baseboards. It doesn't do
167	  very much more than display the text "ARM Linux" on the first
168	  line and the Linux version on the second line, but that's
169	  still useful.
170
171config PANEL
172	tristate "Parallel port LCD/Keypad Panel support"
173	depends on PARPORT
174	select CHARLCD
175	---help---
176	  Say Y here if you have an HD44780 or KS-0074 LCD connected to your
177	  parallel port. This driver also features 4 and 6-key keypads. The LCD
178	  is accessible through the /dev/lcd char device (10, 156), and the
179	  keypad through /dev/keypad (10, 185). This code can either be
180	  compiled as a module, or linked into the kernel and started at boot.
181	  If you don't understand what all this is about, say N.
182
183if PANEL
184
185config PANEL_PARPORT
186	int "Default parallel port number (0=LPT1)"
187	range 0 255
188	default "0"
189	---help---
190	  This is the index of the parallel port the panel is connected to. One
191	  driver instance only supports one parallel port, so if your keypad
192	  and LCD are connected to two separate ports, you have to start two
193	  modules with different arguments. Numbering starts with '0' for LPT1,
194	  and so on.
195
196config PANEL_PROFILE
197	int "Default panel profile (0-5, 0=custom)"
198	range 0 5
199	default "5"
200	---help---
201	  To ease configuration, the driver supports different configuration
202	  profiles for past and recent wirings. These profiles can also be
203	  used to define an approximative configuration, completed by a few
204	  other options. Here are the profiles :
205
206	    0 = custom (see further)
207	    1 = 2x16 parallel LCD, old keypad
208	    2 = 2x16 serial LCD (KS-0074), new keypad
209	    3 = 2x16 parallel LCD (Hantronix), no keypad
210	    4 = 2x16 parallel LCD (Nexcom NSA1045) with Nexcom's keypad
211	    5 = 2x40 parallel LCD (old one), with old keypad
212
213	  Custom configurations allow you to define how your display is
214	  wired to the parallel port, and how it works. This is only intended
215	  for experts.
216
217config PANEL_KEYPAD
218	depends on PANEL_PROFILE="0"
219	int "Keypad type (0=none, 1=old 6 keys, 2=new 6 keys, 3=Nexcom 4 keys)"
220	range 0 3
221	default 0
222	---help---
223	  This enables and configures a keypad connected to the parallel port.
224	  The keys will be read from character device 10,185. Valid values are :
225
226	    0 : do not enable this driver
227	    1 : old 6 keys keypad
228	    2 : new 6 keys keypad, as used on the server at www.ant-computing.com
229	    3 : Nexcom NSA1045's 4 keys keypad
230
231	  New profiles can be described in the driver source. The driver also
232	  supports simultaneous keys pressed when the keypad supports them.
233
234config PANEL_LCD
235	depends on PANEL_PROFILE="0"
236	int "LCD type (0=none, 1=custom, 2=old //, 3=ks0074, 4=hantronix, 5=Nexcom)"
237	range 0 5
238	default 0
239	---help---
240	   This enables and configures an LCD connected to the parallel port.
241	   The driver includes an interpreter for escape codes starting with
242	   '\e[L' which are specific to the LCD, and a few ANSI codes. The
243	   driver will be registered as character device 10,156, usually
244	   under the name '/dev/lcd'. There are a total of 6 supported types :
245
246	     0 : do not enable the driver
247	     1 : custom configuration and wiring (see further)
248	     2 : 2x16 & 2x40 parallel LCD (old wiring)
249	     3 : 2x16 serial LCD (KS-0074 based)
250	     4 : 2x16 parallel LCD (Hantronix wiring)
251	     5 : 2x16 parallel LCD (Nexcom wiring)
252
253	   When type '1' is specified, other options will appear to configure
254	   more precise aspects (wiring, dimensions, protocol, ...). Please note
255	   that those values changed from the 2.4 driver for better consistency.
256
257config PANEL_LCD_HEIGHT
258	depends on PANEL_PROFILE="0" && PANEL_LCD="1"
259	int "Number of lines on the LCD (1-2)"
260	range 1 2
261	default 2
262	---help---
263	  This is the number of visible character lines on the LCD in custom profile.
264	  It can either be 1 or 2.
265
266config PANEL_LCD_WIDTH
267	depends on PANEL_PROFILE="0" && PANEL_LCD="1"
268	int "Number of characters per line on the LCD (1-40)"
269	range 1 40
270	default 40
271	---help---
272	  This is the number of characters per line on the LCD in custom profile.
273	  Common values are 16,20,24,40.
274
275config PANEL_LCD_BWIDTH
276	depends on PANEL_PROFILE="0" && PANEL_LCD="1"
277	int "Internal LCD line width (1-40, 40 by default)"
278	range 1 40
279	default 40
280	---help---
281	  Most LCDs use a standard controller which supports hardware lines of 40
282	  characters, although sometimes only 16, 20 or 24 of them are really wired
283	  to the terminal. This results in some non-visible but addressable characters,
284	  and is the case for most parallel LCDs. Other LCDs, and some serial ones,
285	  however, use the same line width internally as what is visible. The KS0074
286	  for example, uses 16 characters per line for 16 visible characters per line.
287
288	  This option lets you configure the value used by your LCD in 'custom' profile.
289	  If you don't know, put '40' here.
290
291config PANEL_LCD_HWIDTH
292	depends on PANEL_PROFILE="0" && PANEL_LCD="1"
293	int "Hardware LCD line width (1-64, 64 by default)"
294	range 1 64
295	default 64
296	---help---
297	  Most LCDs use a single address bit to differentiate line 0 and line 1. Since
298	  some of them need to be able to address 40 chars with the lower bits, they
299	  often use the immediately superior power of 2, which is 64, to address the
300	  next line.
301
302	  If you don't know what your LCD uses, in doubt let 16 here for a 2x16, and
303	  64 here for a 2x40.
304
305config PANEL_LCD_CHARSET
306	depends on PANEL_PROFILE="0" && PANEL_LCD="1"
307	int "LCD character set (0=normal, 1=KS0074)"
308	range 0 1
309	default 0
310	---help---
311	  Some controllers such as the KS0074 use a somewhat strange character set
312	  where many symbols are at unusual places. The driver knows how to map
313	  'standard' ASCII characters to the character sets used by these controllers.
314	  Valid values are :
315
316	     0 : normal (untranslated) character set
317	     1 : KS0074 character set
318
319	  If you don't know, use the normal one (0).
320
321config PANEL_LCD_PROTO
322	depends on PANEL_PROFILE="0" && PANEL_LCD="1"
323	int "LCD communication mode (0=parallel 8 bits, 1=serial)"
324	range 0 1
325	default 0
326	---help---
327	  This driver now supports any serial or parallel LCD wired to a parallel
328	  port. But before assigning signals, the driver needs to know if it will
329	  be driving a serial LCD or a parallel one. Serial LCDs only use 2 wires
330	  (SDA/SCL), while parallel ones use 2 or 3 wires for the control signals
331	  (E, RS, sometimes RW), and 4 or 8 for the data. Use 0 here for a 8 bits
332	  parallel LCD, and 1 for a serial LCD.
333
334config PANEL_LCD_PIN_E
335	depends on PANEL_PROFILE="0" && PANEL_LCD="1" && PANEL_LCD_PROTO="0"
336        int "Parallel port pin number & polarity connected to the LCD E signal (-17...17) "
337	range -17 17
338	default 14
339	---help---
340	  This describes the number of the parallel port pin to which the LCD 'E'
341	  signal has been connected. It can be :
342
343	          0 : no connection (eg: connected to ground)
344	      1..17 : directly connected to any of these pins on the DB25 plug
345	    -1..-17 : connected to the same pin through an inverter (eg: transistor).
346
347	  Default for the 'E' pin in custom profile is '14' (AUTOFEED).
348
349config PANEL_LCD_PIN_RS
350	depends on PANEL_PROFILE="0" && PANEL_LCD="1" && PANEL_LCD_PROTO="0"
351        int "Parallel port pin number & polarity connected to the LCD RS signal (-17...17) "
352	range -17 17
353	default 17
354	---help---
355	  This describes the number of the parallel port pin to which the LCD 'RS'
356	  signal has been connected. It can be :
357
358	          0 : no connection (eg: connected to ground)
359	      1..17 : directly connected to any of these pins on the DB25 plug
360	    -1..-17 : connected to the same pin through an inverter (eg: transistor).
361
362	  Default for the 'RS' pin in custom profile is '17' (SELECT IN).
363
364config PANEL_LCD_PIN_RW
365	depends on PANEL_PROFILE="0" && PANEL_LCD="1" && PANEL_LCD_PROTO="0"
366        int "Parallel port pin number & polarity connected to the LCD RW signal (-17...17) "
367	range -17 17
368	default 16
369	---help---
370	  This describes the number of the parallel port pin to which the LCD 'RW'
371	  signal has been connected. It can be :
372
373	          0 : no connection (eg: connected to ground)
374	      1..17 : directly connected to any of these pins on the DB25 plug
375	    -1..-17 : connected to the same pin through an inverter (eg: transistor).
376
377	  Default for the 'RW' pin in custom profile is '16' (INIT).
378
379config PANEL_LCD_PIN_SCL
380	depends on PANEL_PROFILE="0" && PANEL_LCD="1" && PANEL_LCD_PROTO!="0"
381        int "Parallel port pin number & polarity connected to the LCD SCL signal (-17...17) "
382	range -17 17
383	default 1
384	---help---
385	  This describes the number of the parallel port pin to which the serial
386	  LCD 'SCL' signal has been connected. It can be :
387
388	          0 : no connection (eg: connected to ground)
389	      1..17 : directly connected to any of these pins on the DB25 plug
390	    -1..-17 : connected to the same pin through an inverter (eg: transistor).
391
392	  Default for the 'SCL' pin in custom profile is '1' (STROBE).
393
394config PANEL_LCD_PIN_SDA
395	depends on PANEL_PROFILE="0" && PANEL_LCD="1" && PANEL_LCD_PROTO!="0"
396        int "Parallel port pin number & polarity connected to the LCD SDA signal (-17...17) "
397	range -17 17
398	default 2
399	---help---
400	  This describes the number of the parallel port pin to which the serial
401	  LCD 'SDA' signal has been connected. It can be :
402
403	          0 : no connection (eg: connected to ground)
404	      1..17 : directly connected to any of these pins on the DB25 plug
405	    -1..-17 : connected to the same pin through an inverter (eg: transistor).
406
407	  Default for the 'SDA' pin in custom profile is '2' (D0).
408
409config PANEL_LCD_PIN_BL
410	depends on PANEL_PROFILE="0" && PANEL_LCD="1"
411        int "Parallel port pin number & polarity connected to the LCD backlight signal (-17...17) "
412	range -17 17
413	default 0
414	---help---
415	  This describes the number of the parallel port pin to which the LCD 'BL' signal
416          has been connected. It can be :
417
418	          0 : no connection (eg: connected to ground)
419	      1..17 : directly connected to any of these pins on the DB25 plug
420	    -1..-17 : connected to the same pin through an inverter (eg: transistor).
421
422	  Default for the 'BL' pin in custom profile is '0' (uncontrolled).
423
424config PANEL_CHANGE_MESSAGE
425	bool "Change LCD initialization message ?"
426	default "n"
427	---help---
428	  This allows you to replace the boot message indicating the kernel version
429	  and the driver version with a custom message. This is useful on appliances
430	  where a simple 'Starting system' message can be enough to stop a customer
431	  from worrying.
432
433	  If you say 'Y' here, you'll be able to choose a message yourself. Otherwise,
434	  say 'N' and keep the default message with the version.
435
436config PANEL_BOOT_MESSAGE
437	depends on PANEL_CHANGE_MESSAGE="y"
438	string "New initialization message"
439	default ""
440	---help---
441	  This allows you to replace the boot message indicating the kernel version
442	  and the driver version with a custom message. This is useful on appliances
443	  where a simple 'Starting system' message can be enough to stop a customer
444	  from worrying.
445
446	  An empty message will only clear the display at driver init time. Any other
447	  printf()-formatted message is valid with newline and escape codes.
448
449endif # PANEL
450