blob: 6badff64756f4976201a4beca7da209e4e2d9551 [file] [log] [blame]
Mauro Carvalho Chehabab42b812019-06-12 14:52:45 -03001==============
Justin P. Mattocka8557dc2010-04-06 14:34:45 -07002What is efifb?
Mauro Carvalho Chehabab42b812019-06-12 14:52:45 -03003==============
Edgar Hucekb64ef8a2006-08-13 23:24:16 -07004
Arvind Sankarfffb6802020-03-19 22:00:25 -04005This is a generic EFI platform driver for systems with UEFI firmware. The
6system must be booted via the EFI stub for this to be usable. efifb supports
7both firmware with Graphics Output Protocol (GOP) displays as well as older
8systems with only Universal Graphics Adapter (UGA) displays.
Edgar Hucekb64ef8a2006-08-13 23:24:16 -07009
10Supported Hardware
11==================
12
Mauro Carvalho Chehabab42b812019-06-12 14:52:45 -030013- iMac 17"/20"
14- Macbook
15- Macbook Pro 15"/17"
16- MacMini
Arvind Sankarfffb6802020-03-19 22:00:25 -040017- ARM/ARM64/X86 systems with UEFI firmware
Edgar Hucekb64ef8a2006-08-13 23:24:16 -070018
19How to use it?
20==============
21
Arvind Sankarfffb6802020-03-19 22:00:25 -040022For UGA displays, efifb does not have any kind of autodetection of your
23machine.
24
Mauro Carvalho Chehabab42b812019-06-12 14:52:45 -030025You have to add the following kernel parameters in your elilo.conf::
26
Edgar Hucekb64ef8a2006-08-13 23:24:16 -070027 Macbook :
Justin P. Mattocka8557dc2010-04-06 14:34:45 -070028 video=efifb:macbook
Edgar Hucekb64ef8a2006-08-13 23:24:16 -070029 MacMini :
Justin P. Mattocka8557dc2010-04-06 14:34:45 -070030 video=efifb:mini
Edgar Hucekb64ef8a2006-08-13 23:24:16 -070031 Macbook Pro 15", iMac 17" :
Justin P. Mattocka8557dc2010-04-06 14:34:45 -070032 video=efifb:i17
Edgar Hucekb64ef8a2006-08-13 23:24:16 -070033 Macbook Pro 17", iMac 20" :
Justin P. Mattocka8557dc2010-04-06 14:34:45 -070034 video=efifb:i20
Edgar Hucekb64ef8a2006-08-13 23:24:16 -070035
Arvind Sankarfffb6802020-03-19 22:00:25 -040036For GOP displays, efifb can autodetect the display's resolution and framebuffer
37address, so these should work out of the box without any special parameters.
38
Dave Airliedd0c41f2017-07-31 18:45:41 +020039Accepted options:
40
Mauro Carvalho Chehabab42b812019-06-12 14:52:45 -030041======= ===========================================================
Dave Airliedd0c41f2017-07-31 18:45:41 +020042nowc Don't map the framebuffer write combined. This can be used
43 to workaround side-effects and slowdowns on other CPU cores
44 when large amounts of console data are written.
Mauro Carvalho Chehabab42b812019-06-12 14:52:45 -030045======= ===========================================================
Dave Airliedd0c41f2017-07-31 18:45:41 +020046
Arvind Sankarfffb6802020-03-19 22:00:25 -040047Options for GOP displays:
48
49mode=n
50 The EFI stub will set the mode of the display to mode number n if
51 possible.
52
Arvind Sankar9a1663b2020-03-19 22:00:27 -040053<xres>x<yres>[-(rgb|bgr|<bpp>)]
Arvind Sankard9ff0322020-03-19 22:00:26 -040054 The EFI stub will search for a display mode that matches the specified
Arvind Sankar9a1663b2020-03-19 22:00:27 -040055 horizontal and vertical resolution, and optionally bit depth, and set
56 the mode of the display to it if one is found. The bit depth can either
57 "rgb" or "bgr" to match specifically those pixel formats, or a number
58 for a mode with matching bits per pixel.
Arvind Sankard9ff0322020-03-19 22:00:26 -040059
Arvind Sankar45d97a72020-03-28 12:06:01 -040060auto
61 The EFI stub will choose the mode with the highest resolution (product
62 of horizontal and vertical resolution). If there are multiple modes
63 with the highest resolution, it will choose one with the highest color
64 depth.
65
Arvind Sankar14c574f2020-05-18 15:07:11 -040066list
67 The EFI stub will list out all the display modes that are available. A
68 specific mode can then be chosen using one of the above options for the
69 next boot.
70
Edgar Hucekb64ef8a2006-08-13 23:24:16 -070071Edgar Hucek <gimli@dark-green.com>