xref: /freebsd/release/tools/arm.subr (revision d65c432aa693043a241e9061d040c4d2b3e86d96)
1#!/bin/sh
2#-
3# Copyright (c) 2015-2017 The FreeBSD Foundation
4# All rights reserved.
5#
6# Portions of this software were developed by Glen Barber
7# under sponsorship from the FreeBSD Foundation.
8#
9# Redistribution and use in source and binary forms, with or without
10# modification, are permitted provided that the following conditions
11# are met:
12# 1. Redistributions of source code must retain the above copyright
13#    notice, this list of conditions and the following disclaimer.
14# 2. Redistributions in binary form must reproduce the above copyright
15#    notice, this list of conditions and the following disclaimer in the
16#    documentation and/or other materials provided with the distribution.
17#
18# THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
19# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21# ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
22# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24# OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25# HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27# OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28# SUCH DAMAGE.
29#
30# Common subroutines used to build arm SD card images.
31#
32# $FreeBSD$
33#
34
35cleanup() {
36	if [ -c "${DESTDIR}/dev/null" ]; then
37		umount_loop ${DESTDIR}/dev 2>/dev/null
38	fi
39	umount_loop ${DESTDIR}
40	if [ ! -z "${mddev}" ]; then
41		mdconfig -d -u ${mddev}
42	fi
43
44	return 0
45}
46
47umount_loop() {
48	DIR=$1
49	i=0
50	sync
51	while ! umount ${DIR}; do
52		i=$(( $i + 1 ))
53		if [ $i -ge 10 ]; then
54			# This should never happen.  But, it has happened.
55			echo "Cannot umount(8) ${DIR}"
56			echo "Something has gone horribly wrong."
57			return 1
58		fi
59		sleep 1
60	done
61
62	return 0
63}
64
65arm_create_disk() {
66	# Create the target raw file and temporary work directory.
67	chroot ${CHROOTDIR} gpart create -s ${PART_SCHEME} ${mddev}
68	chroot ${CHROOTDIR} gpart add -t '!12' -a 512k -s ${FAT_SIZE} ${mddev}
69	chroot ${CHROOTDIR} gpart set -a active -i 1 ${mddev}
70	chroot ${CHROOTDIR} newfs_msdos -L msdosboot -F ${FAT_TYPE} /dev/${mddev}s1
71	chroot ${CHROOTDIR} gpart add -t freebsd ${mddev}
72	chroot ${CHROOTDIR} gpart create -s bsd ${mddev}s2
73	chroot ${CHROOTDIR} gpart add -t freebsd-ufs -a 64k /dev/${mddev}s2
74	chroot ${CHROOTDIR} newfs -U -L rootfs /dev/${mddev}s2a
75
76	return 0
77}
78
79arm_create_user() {
80	# Create a default user account 'freebsd' with the password 'freebsd',
81	# and set the default password for the 'root' user to 'root'.
82	chroot ${CHROOTDIR} /usr/sbin/pw -R ${DESTDIR} \
83		groupadd freebsd -g 1001
84	chroot ${CHROOTDIR} mkdir -p ${DESTDIR}/home/freebsd
85	chroot ${CHROOTDIR} /usr/sbin/pw -R ${DESTDIR} \
86		useradd freebsd \
87		-m -M 0755 -w yes -n freebsd -u 1001 -g 1001 -G 0 \
88		-c 'FreeBSD User' -d '/home/freebsd' -s '/bin/csh'
89	chroot ${CHROOTDIR} /usr/sbin/pw -R ${DESTDIR} \
90		usermod root -w yes
91
92	return 0
93}
94
95arm_setup_usb_otg() {
96	# Set up virtual serial port over USB OTG / device mode.
97	echo >> ${CHROOTDIR}/${DESTDIR}/etc/devd.conf
98	echo '# Required for USB OTG virtual serial port.' \
99		>> ${CHROOTDIR}/${DESTDIR}/etc/devd.conf
100	echo 'notify 100 {' \
101		>> ${CHROOTDIR}/${DESTDIR}/etc/devd.conf
102	echo '	match "system"		"DEVFS";' \
103		>> ${CHROOTDIR}/${DESTDIR}/etc/devd.conf
104	echo '	match "subsystem"	"CDEV";' \
105		>> ${CHROOTDIR}/${DESTDIR}/etc/devd.conf
106	echo '	match "type"		"CREATE";' \
107		>> ${CHROOTDIR}/${DESTDIR}/etc/devd.conf
108	echo '	match "cdev"		"ttyU[0-9]+";' \
109		>> ${CHROOTDIR}/${DESTDIR}/etc/devd.conf
110	echo '	action "/sbin/init q";' \
111		>> ${CHROOTDIR}/${DESTDIR}/etc/devd.conf
112	echo '};' \
113		>> ${CHROOTDIR}/${DESTDIR}/etc/devd.conf
114
115	echo '# USB OTG virtual serial port' \
116		>> ${CHROOTDIR}/${DESTDIR}/etc/ttys
117	echo 'ttyU0	"/usr/libexec/getty 3wire"	vt100	onifconsole  secure' \
118		>> ${CHROOTDIR}/${DESTDIR}/etc/ttys
119	echo 'ttyU1	"/usr/libexec/getty 3wire"	vt100	onifconsole  secure' \
120		>> ${CHROOTDIR}/${DESTDIR}/etc/ttys
121
122	echo '# Configure USB OTG; see usb_template(4).' \
123		>> ${CHROOTDIR}/${DESTDIR}/boot/loader.conf
124	echo 'hw.usb.template=3' \
125		>> ${CHROOTDIR}/${DESTDIR}/boot/loader.conf
126	echo 'umodem_load="YES"' \
127	     >> ${CHROOTDIR}/${DESTDIR}/boot/loader.conf
128}
129
130arm64_setup_multicons() {
131	if [ "${EMBEDDED_TARGET_ARCH}" != "aarch64" ]; then
132		return
133	fi
134
135	echo '# Multiple console (serial+efi gop) enabled.' \
136		>> ${CHROOTDIR}/${DESTDIR}/boot/loader.conf
137	echo 'boot_multicons="YES"' \
138	     >> ${CHROOTDIR}/${DESTDIR}/boot/loader.conf
139	echo 'boot_serial="YES"' \
140	     >> ${CHROOTDIR}/${DESTDIR}/boot/loader.conf
141}
142
143arm_setup_fdt_overlays() {
144	if [ -z "${FDT_OVERLAYS}" ]; then
145		return
146	fi
147
148	echo '# DTB OVERLAYS' \
149		>> ${CHROOTDIR}/${DESTDIR}/boot/loader.conf
150	echo "fdt_overlays=\"${FDT_OVERLAYS}\"" \
151	     >> ${CHROOTDIR}/${DESTDIR}/boot/loader.conf
152}
153
154arm_setup_minimal_loader() {
155	echo '# Disable the beastie menu and color' \
156		>> ${CHROOTDIR}/${DESTDIR}/boot/loader.conf
157	echo 'beastie_disable="YES"' \
158		>> ${CHROOTDIR}/${DESTDIR}/boot/loader.conf
159	echo 'loader_color="NO"' \
160		>> ${CHROOTDIR}/${DESTDIR}/boot/loader.conf
161}
162
163arm_install_base() {
164	chroot ${CHROOTDIR} mount /dev/${mddev}s2a ${DESTDIR}
165	eval chroot ${CHROOTDIR} make -C ${WORLDDIR} \
166		TARGET=${EMBEDDED_TARGET} \
167		TARGET_ARCH=${EMBEDDED_TARGET_ARCH} \
168		DESTDIR=${DESTDIR} KERNCONF=${KERNEL} \
169		${CONF_FILES} installworld installkernel distribution
170	chroot ${CHROOTDIR} mkdir -p ${DESTDIR}/boot/msdos
171
172	arm_create_user
173	arm_setup_usb_otg
174	arm64_setup_multicons
175	arm_setup_fdt_overlays
176	arm_setup_minimal_loader
177	arm_do_quirk
178
179	echo '# Custom /etc/fstab for FreeBSD embedded images' \
180		> ${CHROOTDIR}/${DESTDIR}/etc/fstab
181	echo "/dev/ufs/rootfs   /       ufs     rw      1       1" \
182		>> ${CHROOTDIR}/${DESTDIR}/etc/fstab
183	echo "/dev/msdosfs/MSDOSBOOT /boot/msdos msdosfs rw,noatime 0 0" \
184		>> ${CHROOTDIR}/${DESTDIR}/etc/fstab
185	echo "tmpfs /tmp tmpfs rw,mode=1777,size=50m 0 0" \
186		>> ${CHROOTDIR}/${DESTDIR}/etc/fstab
187
188	local hostname
189	hostname="$(echo ${KERNEL} | tr '[:upper:]' '[:lower:]')"
190	echo "hostname=\"${hostname}\"" > ${CHROOTDIR}/${DESTDIR}/etc/rc.conf
191	echo 'ifconfig_DEFAULT="DHCP"' >> ${CHROOTDIR}/${DESTDIR}/etc/rc.conf
192	echo 'sshd_enable="YES"' >> ${CHROOTDIR}/${DESTDIR}/etc/rc.conf
193	echo 'sendmail_enable="NONE"' >> ${CHROOTDIR}/${DESTDIR}/etc/rc.conf
194	echo 'sendmail_submit_enable="NO"' >> ${CHROOTDIR}/${DESTDIR}/etc/rc.conf
195	echo 'sendmail_outbound_enable="NO"' >> ${CHROOTDIR}/${DESTDIR}/etc/rc.conf
196	echo 'sendmail_msp_queue_enable="NO"' >> ${CHROOTDIR}/${DESTDIR}/etc/rc.conf
197	echo 'growfs_enable="YES"' >> ${CHROOTDIR}/${DESTDIR}/etc/rc.conf
198
199	sync
200	umount_loop ${CHROOTDIR}/${DESTDIR}
201
202	return 0
203}
204
205arm_install_boot() {
206	FATMOUNT="${DESTDIR%${KERNEL}}/fat"
207	UFSMOUNT="${DESTDIR%${KERNEL}}/ufs"
208	chroot ${CHROOTDIR} mkdir -p "${FATMOUNT}" "${UFSMOUNT}"
209	chroot ${CHROOTDIR} mount_msdosfs /dev/${mddev}s1 ${FATMOUNT}
210	chroot ${CHROOTDIR} mount /dev/${mddev}s2a ${UFSMOUNT}
211
212	if [ "${EMBEDDED_TARGET}" == "arm" ]; then
213	chroot ${CHROOTDIR} cp -p ${UFSMOUNT}/boot/ubldr.bin \
214		${FATMOUNT}/ubldr.bin
215	fi
216
217	BOOTFILES="$(chroot ${CHROOTDIR} \
218		env TARGET=${EMBEDDED_TARGET} TARGET_ARCH=${EMBEDDED_TARGET_ARCH} \
219		WITH_UNIFIED_OBJDIR=yes \
220		make -C ${WORLDDIR}/stand -V .OBJDIR)"
221	BOOTFILES="$(chroot ${CHROOTDIR} realpath ${BOOTFILES})"
222
223	chroot ${CHROOTDIR} mkdir -p ${FATMOUNT}/EFI/BOOT
224	chroot ${CHROOTDIR} cp -p ${BOOTFILES}/efi/loader_lua/loader_lua.efi \
225		${FATMOUNT}/EFI/BOOT/$(efi_boot_name ${EMBEDDED_TARGET})
226
227	chroot ${CHROOTDIR} cp -R ${UFSMOUNT}/boot/dtb ${FATMOUNT}
228
229	chroot ${CHROOTDIR} touch ${UFSMOUNT}/firstboot
230	sync
231	umount_loop ${CHROOTDIR}/${FATMOUNT}
232	umount_loop ${CHROOTDIR}/${UFSMOUNT}
233	chroot ${CHROOTDIR} rmdir ${FATMOUNT}
234	chroot ${CHROOTDIR} rmdir ${UFSMOUNT}
235}
236
237arm_install_uboot() {
238	# Override in the arm/KERNEL.conf file.
239
240	return 0
241}
242
243arm_do_quirk() {
244	# Override in the arm{,64}/BOARD.conf file.
245}
246