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