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