blob: 18e79337dcfd788e757c3dbe594058ad72d2474a [file] [log] [blame]
Mauro Carvalho Chehab8e7fbec2016-09-21 14:44:59 -03001Linux Braille Console
2=====================
Samuel Thibaultf7511d52008-04-30 00:54:51 -07003
4To get early boot messages on a braille device (before userspace screen
5readers can start), you first need to compile the support for the usual serial
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -02006console (see :ref:`Documentation/admin-guide/serial-console.rst <serial_console>`), and
Mauro Carvalho Chehab8e7fbec2016-09-21 14:44:59 -03007for braille device
8(in :menuselection:`Device Drivers --> Accessibility support --> Console on braille device`).
Samuel Thibaultf7511d52008-04-30 00:54:51 -07009
Mauro Carvalho Chehab8e7fbec2016-09-21 14:44:59 -030010Then you need to specify a ``console=brl``, option on the kernel command line, the
11format is::
Samuel Thibaultf7511d52008-04-30 00:54:51 -070012
13 console=brl,serial_options...
14
Mauro Carvalho Chehab8e7fbec2016-09-21 14:44:59 -030015where ``serial_options...`` are the same as described in
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -020016:ref:`Documentation/admin-guide/serial-console.rst <serial_console>`.
Samuel Thibaultf7511d52008-04-30 00:54:51 -070017
Mauro Carvalho Chehab8e7fbec2016-09-21 14:44:59 -030018So for instance you can use ``console=brl,ttyS0`` if the braille device is connected to the first serial port, and ``console=brl,ttyS0,115200`` to
19override the baud rate to 115200, etc.
Samuel Thibaultf7511d52008-04-30 00:54:51 -070020
21By default, the braille device will just show the last kernel message (console
22mode). To review previous messages, press the Insert key to switch to the VT
23review mode. In review mode, the arrow keys permit to browse in the VT content,
Mauro Carvalho Chehab8e7fbec2016-09-21 14:44:59 -030024:kbd:`PAGE-UP`/:kbd:`PAGE-DOWN` keys go at the top/bottom of the screen, and
25the :kbd:`HOME` key goes back
Samuel Thibaultf7511d52008-04-30 00:54:51 -070026to the cursor, hence providing very basic screen reviewing facility.
27
Mauro Carvalho Chehab8e7fbec2016-09-21 14:44:59 -030028Sound feedback can be obtained by adding the ``braille_console.sound=1`` kernel
Samuel Thibaultf7511d52008-04-30 00:54:51 -070029parameter.
30
31For simplicity, only one braille console can be enabled, other uses of
Mauro Carvalho Chehab8e7fbec2016-09-21 14:44:59 -030032``console=brl,...`` will be discarded. Also note that it does not interfere with
33the console selection mechanism described in
Mauro Carvalho Chehab8c27ceff32016-10-18 10:12:27 -020034:ref:`Documentation/admin-guide/serial-console.rst <serial_console>`.
Samuel Thibaultf7511d52008-04-30 00:54:51 -070035
36For now, only the VisioBraille device is supported.
37
38Samuel Thibault <samuel.thibault@ens-lyon.org>