blob: 894f6b37186f95ef4234c54ecd1c21c02372616e [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001# syslinux.bbclass
2# Copyright (C) 2004-2006, Advanced Micro Devices, Inc. All Rights Reserved
3# Released under the MIT license (see packages/COPYING)
4
5# Provide syslinux specific functions for building bootable images.
6
7# External variables
8# ${INITRD} - indicates a list of filesystem images to concatenate and use as an initrd (optional)
9# ${ROOTFS} - indicates a filesystem image to include as the root filesystem (optional)
10# ${AUTO_SYSLINUXMENU} - set this to 1 to enable creating an automatic menu
11# ${LABELS} - a list of targets for the automatic config
12# ${APPEND} - an override list of append strings for each label
13# ${SYSLINUX_OPTS} - additional options to add to the syslinux file ';' delimited
14# ${SYSLINUX_SPLASH} - A background for the vga boot menu if using the boot menu
15# ${SYSLINUX_DEFAULT_CONSOLE} - set to "console=ttyX" to change kernel boot default console
16# ${SYSLINUX_SERIAL} - Set an alternate serial port or turn off serial with empty string
17# ${SYSLINUX_SERIAL_TTY} - Set alternate console=tty... kernel boot argument
18# ${SYSLINUX_KERNEL_ARGS} - Add additional kernel arguments
19
20do_bootimg[depends] += "${MLPREFIX}syslinux:do_populate_sysroot \
21 syslinux-native:do_populate_sysroot"
22
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050023ISOLINUXDIR ?= "/isolinux"
Patrick Williamsc124f4f2015-09-15 14:41:29 -050024SYSLINUXDIR = "/"
25# The kernel has an internal default console, which you can override with
26# a console=...some_tty...
27SYSLINUX_DEFAULT_CONSOLE ?= ""
28SYSLINUX_SERIAL ?= "0 115200"
29SYSLINUX_SERIAL_TTY ?= "console=ttyS0,115200"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050030SYSLINUX_PROMPT ?= "0"
31SYSLINUX_TIMEOUT ?= "50"
32AUTO_SYSLINUXMENU ?= "1"
Patrick Williamsc0f7c042017-02-23 20:41:17 -060033SYSLINUX_ALLOWOPTIONS ?= "1"
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050034SYSLINUX_ROOT ?= "${ROOT}"
35SYSLINUX_CFG_VM ?= "${S}/syslinux_vm.cfg"
36SYSLINUX_CFG_LIVE ?= "${S}/syslinux_live.cfg"
37APPEND ?= ""
Patrick Williamsc124f4f2015-09-15 14:41:29 -050038
39# Need UUID utility code.
40inherit fs-uuid
41
42syslinux_populate() {
43 DEST=$1
44 BOOTDIR=$2
45 CFGNAME=$3
46
47 install -d ${DEST}${BOOTDIR}
48
49 # Install the config files
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050050 install -m 0644 ${SYSLINUX_CFG} ${DEST}${BOOTDIR}/${CFGNAME}
Patrick Williamsc124f4f2015-09-15 14:41:29 -050051 if [ "${AUTO_SYSLINUXMENU}" = 1 ] ; then
52 install -m 0644 ${STAGING_DATADIR}/syslinux/vesamenu.c32 ${DEST}${BOOTDIR}/vesamenu.c32
53 install -m 0444 ${STAGING_DATADIR}/syslinux/libcom32.c32 ${DEST}${BOOTDIR}/libcom32.c32
54 install -m 0444 ${STAGING_DATADIR}/syslinux/libutil.c32 ${DEST}${BOOTDIR}/libutil.c32
55 if [ "${SYSLINUX_SPLASH}" != "" ] ; then
56 install -m 0644 ${SYSLINUX_SPLASH} ${DEST}${BOOTDIR}/splash.lss
57 fi
58 fi
59}
60
61syslinux_iso_populate() {
62 iso_dir=$1
63 syslinux_populate $iso_dir ${ISOLINUXDIR} isolinux.cfg
64 install -m 0644 ${STAGING_DATADIR}/syslinux/isolinux.bin $iso_dir${ISOLINUXDIR}
65 install -m 0644 ${STAGING_DATADIR}/syslinux/ldlinux.c32 $iso_dir${ISOLINUXDIR}
66}
67
68syslinux_hddimg_populate() {
69 hdd_dir=$1
70 syslinux_populate $hdd_dir ${SYSLINUXDIR} syslinux.cfg
71 install -m 0444 ${STAGING_DATADIR}/syslinux/ldlinux.sys $hdd_dir${SYSLINUXDIR}/ldlinux.sys
72}
73
74syslinux_hddimg_install() {
Patrick Williamsc0f7c042017-02-23 20:41:17 -060075 syslinux ${IMGDEPLOYDIR}/${IMAGE_NAME}.hddimg
Patrick Williamsc124f4f2015-09-15 14:41:29 -050076}
77
Patrick Williamsc124f4f2015-09-15 14:41:29 -050078python build_syslinux_cfg () {
79 import copy
80 import sys
81
Brad Bishop6e60e8b2018-02-01 10:27:11 -050082 workdir = d.getVar('WORKDIR')
Patrick Williamsc124f4f2015-09-15 14:41:29 -050083 if not workdir:
84 bb.error("WORKDIR not defined, unable to package")
85 return
86
Brad Bishop6e60e8b2018-02-01 10:27:11 -050087 labels = d.getVar('LABELS')
Patrick Williamsc124f4f2015-09-15 14:41:29 -050088 if not labels:
89 bb.debug(1, "LABELS not defined, nothing to do")
90 return
91
92 if labels == []:
93 bb.debug(1, "No labels, nothing to do")
94 return
95
Brad Bishop6e60e8b2018-02-01 10:27:11 -050096 cfile = d.getVar('SYSLINUX_CFG')
Patrick Williamsc124f4f2015-09-15 14:41:29 -050097 if not cfile:
Patrick Williamsc0f7c042017-02-23 20:41:17 -060098 bb.fatal('Unable to read SYSLINUX_CFG')
Patrick Williamsc124f4f2015-09-15 14:41:29 -050099
100 try:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600101 cfgfile = open(cfile, 'w')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500102 except OSError:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600103 bb.fatal('Unable to open %s' % cfile)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500104
105 cfgfile.write('# Automatically created by OE\n')
106
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500107 opts = d.getVar('SYSLINUX_OPTS')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500108
109 if opts:
110 for opt in opts.split(';'):
111 cfgfile.write('%s\n' % opt)
112
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500113 allowoptions = d.getVar('SYSLINUX_ALLOWOPTIONS')
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600114 if allowoptions:
115 cfgfile.write('ALLOWOPTIONS %s\n' % allowoptions)
116 else:
117 cfgfile.write('ALLOWOPTIONS 1\n')
118
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500119 syslinux_default_console = d.getVar('SYSLINUX_DEFAULT_CONSOLE')
120 syslinux_serial_tty = d.getVar('SYSLINUX_SERIAL_TTY')
121 syslinux_serial = d.getVar('SYSLINUX_SERIAL')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500122 if syslinux_serial:
123 cfgfile.write('SERIAL %s\n' % syslinux_serial)
124
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500125 menu = (d.getVar('AUTO_SYSLINUXMENU') == "1")
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500126
127 if menu and syslinux_serial:
128 cfgfile.write('DEFAULT Graphics console %s\n' % (labels.split()[0]))
129 else:
130 cfgfile.write('DEFAULT %s\n' % (labels.split()[0]))
131
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500132 timeout = d.getVar('SYSLINUX_TIMEOUT')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500133
134 if timeout:
135 cfgfile.write('TIMEOUT %s\n' % timeout)
136 else:
137 cfgfile.write('TIMEOUT 50\n')
138
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500139 prompt = d.getVar('SYSLINUX_PROMPT')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500140 if prompt:
141 cfgfile.write('PROMPT %s\n' % prompt)
142 else:
143 cfgfile.write('PROMPT 1\n')
144
145 if menu:
146 cfgfile.write('ui vesamenu.c32\n')
147 cfgfile.write('menu title Select kernel options and boot kernel\n')
148 cfgfile.write('menu tabmsg Press [Tab] to edit, [Return] to select\n')
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500149 splash = d.getVar('SYSLINUX_SPLASH')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500150 if splash:
151 cfgfile.write('menu background splash.lss\n')
152
153 for label in labels.split():
154 localdata = bb.data.createCopy(d)
155
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500156 overrides = localdata.getVar('OVERRIDES')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500157 if not overrides:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600158 bb.fatal('OVERRIDES not defined')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500159
160 localdata.setVar('OVERRIDES', label + ':' + overrides)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500161
162 btypes = [ [ "", syslinux_default_console ] ]
163 if menu and syslinux_serial:
164 btypes = [ [ "Graphics console ", syslinux_default_console ],
165 [ "Serial console ", syslinux_serial_tty ] ]
166
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500167 root= d.getVar('SYSLINUX_ROOT')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500168 if not root:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600169 bb.fatal('SYSLINUX_ROOT not defined')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500170
Brad Bishop316dfdd2018-06-25 12:45:53 -0400171 kernel = localdata.getVar('KERNEL_IMAGETYPE')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500172 for btype in btypes:
Brad Bishop316dfdd2018-06-25 12:45:53 -0400173 cfgfile.write('LABEL %s%s\nKERNEL /%s\n' % (btype[0], label, kernel))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500174
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500175 exargs = d.getVar('SYSLINUX_KERNEL_ARGS')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500176 if exargs:
177 btype[1] += " " + exargs
178
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500179 append = localdata.getVar('APPEND')
180 initrd = localdata.getVar('INITRD')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500181
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500182 append = root + " " + append
183 cfgfile.write('APPEND ')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500184
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500185 if initrd:
186 cfgfile.write('initrd=/initrd ')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500187
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500188 cfgfile.write('LABEL=%s '% (label))
189 append = replace_rootfs_uuid(d, append)
190 cfgfile.write('%s %s\n' % (append, btype[1]))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500191
192 cfgfile.close()
193}
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600194build_syslinux_cfg[dirs] = "${S}"