##// END OF EJS Templates
Merge pull request #182 from BrainStone/swap...
drtyhlpr -
r583:e8ebe4a99dc7 Fusion testing
parent child
Show More
@@ -0,0 +1,5
1 # Restart dphys-swapfile service if it exists
2 logger -t "rc.firstboot" "Restarting dphys-swapfile"
3
4 systemctl enable dphys-swapfile
5 systemctl restart dphys-swapfile
@@ -1,544 +1,547
1 1 # rpi23-gen-image
2 2 ## Introduction
3 3 `rpi23-gen-image.sh` is an advanced Debian Linux bootstrapping shell script for generating Debian OS images for all Raspberry Pi computers. The script at this time supports the bootstrapping of the Debian (armhf/armel) releases `stretch` and `buster`. Raspberry Pi 0/1/2/3 images are generated for 32-bit mode only. Raspberry Pi 3 supports 64-bit images that can be generated using custom configuration parameters (```templates/rpi3-stretch-arm64-4.14.y```).
4 4
5 5 ## Build dependencies
6 6 The following list of Debian packages must be installed on the build system because they are essentially required for the bootstrapping process. The script will check if all required packages are installed and missing packages will be installed automatically if confirmed by the user.
7 7
8 8 ```debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus sudo```
9 9
10 10 It is recommended to configure the `rpi23-gen-image.sh` script to build and install the latest Raspberry Pi Linux kernel. For the Raspberry 3 this is mandatory. Kernel compilation and linking will be performed on the build system using an ARM (armhf/armel) cross-compiler toolchain.
11 11
12 12 The script has been tested using the default `crossbuild-essential-armhf` and `crossbuild-essential-armel` toolchain meta packages on Debian Linux `stretch` build systems. Please check the [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains) for further information.
13 13
14 14 ## Command-line parameters
15 15 The script accepts certain command-line parameters to enable or disable specific OS features, services and configuration settings. These parameters are passed to the `rpi23-gen-image.sh` script via (simple) shell-variables. Unlike environment shell-variables (simple) shell-variables are defined at the beginning of the command-line call of the `rpi23-gen-image.sh` script.
16 16
17 17 ##### Command-line examples:
18 18 ```shell
19 19 ENABLE_UBOOT=true ./rpi23-gen-image.sh
20 20 ENABLE_CONSOLE=false ENABLE_IPV6=false ./rpi23-gen-image.sh
21 21 ENABLE_WM=xfce4 ENABLE_FBTURBO=true ENABLE_MINBASE=true ./rpi23-gen-image.sh
22 22 ENABLE_HARDNET=true ENABLE_IPTABLES=true /rpi23-gen-image.sh
23 23 APT_SERVER=ftp.de.debian.org APT_PROXY="http://127.0.0.1:3142/" ./rpi23-gen-image.sh
24 24 ENABLE_MINBASE=true ./rpi23-gen-image.sh
25 25 BUILD_KERNEL=true ENABLE_MINBASE=true ENABLE_IPV6=false ./rpi23-gen-image.sh
26 26 BUILD_KERNEL=true KERNELSRC_DIR=/tmp/linux ./rpi23-gen-image.sh
27 27 ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
28 28 ENABLE_CRYPTFS=true CRYPTFS_PASSWORD=changeme EXPANDROOT=false ENABLE_MINBASE=true ENABLE_REDUCE=true ENABLE_MINGPU=true BUILD_KERNEL=true ./rpi23-gen-image.sh
29 29 RELEASE=stretch BUILD_KERNEL=true ./rpi23-gen-image.sh
30 30 RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
31 31 RELEASE=stretch RPI_MODEL=3 ENABLE_WIRELESS=true ENABLE_MINBASE=true BUILD_KERNEL=true ./rpi23-gen-image.sh
32 32 ```
33 33
34 34 ## Configuration template files
35 35 To avoid long lists of command-line parameters and to help to store the favourite parameter configurations the `rpi23-gen-image.sh` script supports so called configuration template files (`CONFIG_TEMPLATE`=template). These are simple text files located in the `./templates` directory that contain the list of configuration parameters that will be used. New configuration template files can be added to the `./templates` directory.
36 36
37 37 ##### Command-line examples:
38 38 ```shell
39 39 CONFIG_TEMPLATE=rpi3stretch ./rpi23-gen-image.sh
40 40 CONFIG_TEMPLATE=rpi2stretch ./rpi23-gen-image.sh
41 41 ```
42 42
43 43 ## Supported parameters and settings
44 44 #### APT settings:
45 45 ##### `APT_SERVER`="ftp.debian.org"
46 46 Set Debian packages server address. Choose a server from the list of Debian worldwide [mirror sites](https://www.debian.org/mirror/list). Using a nearby server will probably speed-up all required downloads within the bootstrapping process.
47 47
48 48 ##### `APT_PROXY`=""
49 49 Set Proxy server address. Using a local Proxy-Cache like `apt-cacher-ng` will speed-up the bootstrapping process because all required Debian packages will only be downloaded from the Debian mirror site once. If `apt-cacher-ng` is running on default `http://127.0.0.1:3142` it is autodetected and you don't need to set this.
50 50
51 51 ##### `KEEP_APT_PROXY`=false
52 52 Keep the APT_PROXY settings used in the bootsrapping process in the generated image.
53 53
54 54 ##### `APT_INCLUDES`=""
55 55 A comma-separated list of additional packages to be installed by debootstrap during bootstrapping.
56 56
57 57 ##### `APT_INCLUDES_LATE`=""
58 58 A comma-separated list of additional packages to be installed by apt after bootstrapping and after APT sources are set up. This is useful for packages with pre-depends, which debootstrap do not handle well.
59 59
60 60 ---
61 61
62 62 #### General system settings:
63 63 ##### `SET_ARCH`=32
64 64 Set Architecture to default 32bit. If you want to compile 64-bit (RPI3 or RPI3+) set it to `64`. This option will set every needed cross-compiler or board specific option for a successful build.
65 65
66 66 ##### `RPI_MODEL`=2
67 67 Specify the target Raspberry Pi hardware model. The script at this time supports the following Raspberry Pi models:
68 68 - `0` = Raspberry Pi 0 and Raspberry Pi 0 W
69 69 - `1` = Raspberry Pi 1 model A and B
70 70 - `1P` = Raspberry Pi 1 model B+ and A+
71 71 - `2` = Raspberry Pi 2 model B
72 72 - `3` = Raspberry Pi 3 model B
73 73 - `3P` = Raspberry Pi 3 model B+
74 74
75 75 ##### `RELEASE`="buster"
76 76 Set the desired Debian release name. The script at this time supports the bootstrapping of the Debian releases `stretch` and `buster`.
77 77
78 78 ##### `RELEASE_ARCH`="armhf"
79 79 Set the desired Debian release architecture.
80 80
81 81 ##### `HOSTNAME`="rpi$RPI_MODEL-$RELEASE"
82 82 Set system hostname. It's recommended that the hostname is unique in the corresponding subnet.
83 83
84 84 ##### `PASSWORD`="raspberry"
85 85 Set system `root` password. It's **STRONGLY** recommended that you choose a custom password.
86 86
87 87 ##### `USER_PASSWORD`="raspberry"
88 88 Set password for the created non-root user `USER_NAME`=pi. Ignored if `ENABLE_USER`=false. It's **STRONGLY** recommended that you choose a custom password.
89 89
90 90 ##### `DEFLOCAL`="en_US.UTF-8"
91 91 Set default system locale. This setting can also be changed inside the running OS using the `dpkg-reconfigure locales` command. Please note that on using this parameter the script will automatically install the required packages `locales`, `keyboard-configuration` and `console-setup`.
92 92
93 93 ##### `TIMEZONE`="Europe/Berlin"
94 94 Set default system timezone. All available timezones can be found in the `/usr/share/zoneinfo/` directory. This setting can also be changed inside the running OS using the `dpkg-reconfigure tzdata` command.
95 95
96 96 ##### `EXPANDROOT`=true
97 97 Expand the root partition and filesystem automatically on first boot.
98 98
99 ##### `ENABLE_DPHYSSWAP`=true
100 Enable swap. The size of the swapfile is chosen relative to the size of the root partition. It'll use the `dphys-swapfile` package for that.
101
99 102 ##### `ENABLE_QEMU`=false
100 103 Generate kernel (`vexpress_defconfig`), file system image (`qcow2`) and DTB files that can be used for QEMU full system emulation (`vexpress-A15`). The output files are stored in the `$(pwd)/images/qemu` directory. You can find more information about running the generated image in the QEMU section of this readme file.
101 104
102 105 ---
103 106
104 107 #### Keyboard settings:
105 108 These options are used to configure keyboard layout in `/etc/default/keyboard` for console and Xorg. These settings can also be changed inside the running OS using the `dpkg-reconfigure keyboard-configuration` command.
106 109
107 110 ##### `XKB_MODEL`=""
108 111 Set the name of the model of your keyboard type.
109 112
110 113 ##### `XKB_LAYOUT`=""
111 114 Set the supported keyboard layout(s).
112 115
113 116 ##### `XKB_VARIANT`=""
114 117 Set the supported variant(s) of the keyboard layout(s).
115 118
116 119 ##### `XKB_OPTIONS`=""
117 120 Set extra xkb configuration options.
118 121
119 122 ---
120 123
121 124 #### Networking settings (DHCP):
122 125 This parameter is used to set up networking auto-configuration in `/etc/systemd/network/eth.network`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.`
123 126
124 127 ##### `ENABLE_DHCP`=true
125 128 Set the system to use DHCP. This requires an DHCP server.
126 129
127 130 ---
128 131
129 132 #### Networking settings (static):
130 133 These parameters are used to set up a static networking configuration in `/etc/systemd/network/eth.network`. The following static networking parameters are only supported if `ENABLE_DHCP` was set to `false`. The default location of network configuration files in the Debian `stretch` release was changed to `/lib/systemd/network`.
131 134
132 135 ##### `NET_ADDRESS`=""
133 136 Set a static IPv4 or IPv6 address and its prefix, separated by "/", eg. "192.169.0.3/24".
134 137
135 138 ##### `NET_GATEWAY`=""
136 139 Set the IP address for the default gateway.
137 140
138 141 ##### `NET_DNS_1`=""
139 142 Set the IP address for the first DNS server.
140 143
141 144 ##### `NET_DNS_2`=""
142 145 Set the IP address for the second DNS server.
143 146
144 147 ##### `NET_DNS_DOMAINS`=""
145 148 Set the default DNS search domains to use for non fully qualified hostnames.
146 149
147 150 ##### `NET_NTP_1`=""
148 151 Set the IP address for the first NTP server.
149 152
150 153 ##### `NET_NTP_2`=""
151 154 Set the IP address for the second NTP server.
152 155
153 156 ---
154 157
155 158 #### Basic system features:
156 159 ##### `ENABLE_CONSOLE`=true
157 160 Enable serial console interface. Recommended if no monitor or keyboard is connected to the RPi2/3. In case of problems fe. if the network (auto) configuration failed - the serial console can be used to access the system. On RPI `0` `3` `3P` the CPU speed is locked at lowest speed.
158 161
159 162 ##### `ENABLE_PRINTK`=false
160 163 Enables printing kernel messages to konsole. printk is `3 4 1 3` as in raspbian.
161 164
162 165 ##### `ENABLE_BLUETOOTH`=false
163 166 Enable onboard Bluetooth interface on the RPi0/3/3P. See: [Configuring the GPIO serial port on Raspbian jessie and stretch](https://spellfoundry.com/2016/05/29/configuring-gpio-serial-port-raspbian-jessie-including-pi-3/).
164 167
165 168 ##### `ENABLE_MINIUART_OVERLAY`=false
166 169 Enable Bluetooth to use this. Adds overlay to swap UART0 with UART1. Enabling (slower) Bluetooth and full speed serial console. - RPI `0` `3` `3P` have a fast `hardware UART0` (ttyAMA0) and a `mini UART1` (ttyS0)! RPI `1` `1P` `2` only have a `hardware UART0`. `UART0` is considered better, because is faster and more stable than `mini UART1`. By default the Bluetooth modem is mapped to the `hardware UART0` and `mini UART` is used for console. The `mini UART` is a problem for the serial console, because its baudrate depends on the CPU frequency, which is changing on runtime. Resulting in a volatile baudrate and thus in an unusable serial console.
167 170
168 171 ##### `ENABLE_TURBO`=false
169 172 Enable Turbo mode. This setting locks cpu at the highest frequency. As setting ENABLE_CONSOLE=true locks RPI to lowest CPU speed, this is can be used additionally to lock cpu hat max speed. Need a good power supply and probably cooling for the Raspberry PI.
170 173
171 174 ##### `ENABLE_I2C`=false
172 175 Enable I2C interface on the RPi 0/1/2/3. Please check the [RPi 0/1/2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
173 176
174 177 ##### `ENABLE_SPI`=false
175 178 Enable SPI interface on the RPi 0/1/2/3. Please check the [RPi 0/1/2/3 pinout diagrams](https://elinux.org/RPi_Low-level_peripherals) to connect the right GPIO pins.
176 179
177 180 ##### `ENABLE_IPV6`=true
178 181 Enable IPv6 support. The network interface configuration is managed via systemd-networkd.
179 182
180 183 ##### `ENABLE_SSHD`=true
181 184 Install and enable OpenSSH service. The default configuration of the service doesn't allow `root` to login. Please use the user `pi` instead and `su -` or `sudo` to execute commands as root.
182 185
183 186 ##### `ENABLE_NONFREE`=false
184 187 Allow the installation of non-free Debian packages that do not comply with the DFSG. This is required to install closed-source firmware binary blobs.
185 188
186 189 ##### `ENABLE_WIRELESS`=false
187 190 Download and install the [closed-source firmware binary blob](https://github.com/RPi-Distro/firmware-nonfree/raw/master/brcm) that is required to run the internal wireless interface of the Raspberry Pi model `3`. This parameter is ignored if the specified `RPI_MODEL` is not `3`.
188 191
189 192 ##### `ENABLE_RSYSLOG`=true
190 193 If set to false, disable and uninstall rsyslog (so logs will be available only in journal files)
191 194
192 195 ##### `ENABLE_SOUND`=true
193 196 Enable sound hardware and install Advanced Linux Sound Architecture.
194 197
195 198 ##### `ENABLE_HWRANDOM`=true
196 199 Enable Hardware Random Number Generator. Strong random numbers are important for most network-based communications that use encryption. It's recommended to be enabled.
197 200
198 201 ##### `ENABLE_MINGPU`=false
199 202 Minimize the amount of shared memory reserved for the GPU. It doesn't seem to be possible to fully disable the GPU.
200 203
201 204 ##### `ENABLE_DBUS`=true
202 205 Install and enable D-Bus message bus. Please note that systemd should work without D-bus but it's recommended to be enabled.
203 206
204 207 ##### `ENABLE_XORG`=false
205 208 Install Xorg open-source X Window System.
206 209
207 210 ##### `ENABLE_WM`=""
208 211 Install a user-defined window manager for the X Window System. To make sure all X related package dependencies are getting installed `ENABLE_XORG` will automatically get enabled if `ENABLE_WM` is used. The `rpi23-gen-image.sh` script has been tested with the following list of window managers: `blackbox`, `openbox`, `fluxbox`, `jwm`, `dwm`, `xfce4`, `awesome`.
209 212
210 213 ##### `ENABLE_SYSVINIT`=false
211 214 Support for halt,init,poweroff,reboot,runlevel,shutdown,telinit commands
212 215
213 216 ---
214 217
215 218 #### Advanced system features:
216 219 ##### `ENABLE_SYSTEMDSWAP`=false
217 220 Enables [Systemd-swap service](https://github.com/Nefelim4ag/systemd-swap). Usefull if `KERNEL_ZSWAP` is enabled.
218 221
219 222 ##### `ENABLE_MINBASE`=false
220 223 Use debootstrap script variant `minbase` which only includes essential packages and apt. This will reduce the disk usage by about 65 MB.
221 224
222 225 ##### `ENABLE_REDUCE`=false
223 226 Reduce the disk space usage by deleting packages and files. See `REDUCE_*` parameters for detailed information.
224 227
225 228 ##### `ENABLE_UBOOT`=false
226 229 Replace the default RPi 0/1/2/3 second stage bootloader (bootcode.bin) with [U-Boot bootloader](https://git.denx.de/?p=u-boot.git;a=summary). U-Boot can boot images via the network using the BOOTP/TFTP protocol.
227 230
228 231 ##### `UBOOTSRC_DIR`=""
229 232 Path to a directory (`u-boot`) of [U-Boot bootloader sources](https://git.denx.de/?p=u-boot.git;a=summary) that will be copied, configured, build and installed inside the chroot.
230 233
231 234 ##### `ENABLE_FBTURBO`=false
232 235 Install and enable the [hardware accelerated Xorg video driver](https://github.com/ssvb/xf86-video-fbturbo) `fbturbo`. Please note that this driver is currently limited to hardware accelerated window moving and scrolling.
233 236
234 237 ##### `FBTURBOSRC_DIR`=""
235 238 Path to a directory (`xf86-video-fbturbo`) of [hardware accelerated Xorg video driver sources](https://github.com/ssvb/xf86-video-fbturbo) that will be copied, configured, build and installed inside the chroot.
236 239
237 240 ##### `ENABLE_VIDEOCORE`=false
238 241 Install and enable the [ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) `vcgencmd`. Please note that this driver is currently limited to hardware accelerated window moving and scrolling.
239 242
240 243 ##### `VIDEOCORESRC_DIR`=""
241 244 Path to a directory (`userland`) of [ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) that will be copied, configured, build and installed inside the chroot.
242 245
243 246 ##### `ENABLE_NEXMON`=false
244 247 Install and enable the [Source code for a C-based firmware patching framework for Broadcom/Cypress WiFi chips that enables you to write your own firmware patches, for example, to enable monitor mode with radiotap headers and frame injection](https://github.com/seemoo-lab/nexmon.git).
245 248
246 249 ##### `NEXMONSRC_DIR`=""
247 250 Path to a directory (`nexmon`) of [Source code for ARM side libraries for interfacing to Raspberry Pi GPU](https://github.com/raspberrypi/userland) that will be copied, configured, build and installed inside the chroot.
248 251
249 252 ##### `ENABLE_IPTABLES`=false
250 253 Enable iptables IPv4/IPv6 firewall. Simplified ruleset: Allow all outgoing connections. Block all incoming connections except to OpenSSH service.
251 254
252 255 ##### `ENABLE_USER`=true
253 256 Create non-root user with password `USER_PASSWORD`=raspberry. Unless overridden with `USER_NAME`=user, the username will be `pi`.
254 257
255 258 ##### `USER_NAME`=pi
256 259 Non-root user to create. Ignored if `ENABLE_USER`=false
257 260
258 261 ##### `ENABLE_ROOT`=false
259 262 Set root user password so root login will be enabled
260 263
261 264 ##### `ENABLE_HARDNET`=false
262 265 Enable IPv4/IPv6 network stack hardening settings.
263 266
264 267 ##### `ENABLE_SPLITFS`=false
265 268 Enable having root partition on an USB drive by creating two image files: one for the `/boot/firmware` mount point, and another for `/`.
266 269
267 270 ##### `CHROOT_SCRIPTS`=""
268 271 Path to a directory with scripts that should be run in the chroot before the image is finally built. Every executable file in this directory is run in lexicographical order.
269 272
270 273 ##### `ENABLE_INITRAMFS`=false
271 274 Create an initramfs that that will be loaded during the Linux startup process. `ENABLE_INITRAMFS` will automatically get enabled if `ENABLE_CRYPTFS`=true. This parameter will be ignored if `BUILD_KERNEL`=false.
272 275
273 276 ##### `ENABLE_IFNAMES`=true
274 277 Enable automatic assignment of predictable, stable network interface names for all local Ethernet, WLAN interfaces. This might create complex and long interface names.
275 278
276 279 ##### `ENABLE_SPLASH`=true
277 280 Enable default Raspberry Pi boot up rainbow splash screen.
278 281
279 282 ##### `ENABLE_LOGO`=true
280 283 Enable default Raspberry Pi console logo (image of four raspberries in the top left corner).
281 284
282 285 ##### `ENABLE_SILENT_BOOT`=false
283 286 Set the verbosity of console messages shown during boot up to a strict minimum.
284 287
285 288 ##### `DISABLE_UNDERVOLT_WARNINGS`=
286 289 Disable RPi2/3 under-voltage warnings and overlays. Setting the parameter to `1` will disable the warning overlay. Setting it to `2` will additionally allow RPi2/3 turbo mode when low-voltage is present.
287 290
288 291 ---
289 292
290 293 #### SSH settings:
291 294 ##### `SSH_ENABLE_ROOT`=false
292 295 Enable password-based root login via SSH. This may be a security risk with the default password set, use only in trusted environments. `ENABLE_ROOT` must be set to `true`.
293 296
294 297 ##### `SSH_DISABLE_PASSWORD_AUTH`=false
295 298 Disable password-based SSH authentication. Only public key based SSH (v2) authentication will be supported.
296 299
297 300 ##### `SSH_LIMIT_USERS`=false
298 301 Limit the users that are allowed to login via SSH. Only allow user `USER_NAME`=pi and root if `SSH_ENABLE_ROOT`=true to login. This parameter will be ignored if `dropbear` SSH is used (`REDUCE_SSHD`=true).
299 302
300 303 ##### `SSH_ROOT_PUB_KEY`=""
301 304 Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `root`. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported. `ENABLE_ROOT` **and** `SSH_ENABLE_ROOT` must be set to `true`.
302 305
303 306 ##### `SSH_USER_PUB_KEY`=""
304 307 Add SSH (v2) public key(s) from specified file to `authorized_keys` file to enable public key based SSH (v2) authentication of user `USER_NAME`=pi. The specified file can also contain multiple SSH (v2) public keys. SSH protocol version 1 is not supported.
305 308
306 309 ---
307 310
308 311 #### Kernel compilation:
309 312 ##### `BUILD_KERNEL`=true
310 313 Build and install the latest RPi 0/1/2/3 Linux kernel. Currently only the default RPi 0/1/2/3 kernel configuration is used.
311 314
312 315 ##### `CROSS_COMPILE`="arm-linux-gnueabihf-"
313 316 This sets the cross-compile environment for the compiler.
314 317
315 318 ##### `KERNEL_ARCH`="arm"
316 319 This sets the kernel architecture for the compiler.
317 320
318 321 ##### `KERNEL_IMAGE`="kernel7.img"
319 322 Name of the image file in the boot partition. If not set, `KERNEL_IMAGE` will be set to "kernel8.img" automatically if building for arm64.
320 323
321 324 ##### `KERNEL_BRANCH`=""
322 325 Name of the requested branch from the GIT location for the RPi Kernel. Default is using the current default branch from the GIT site.
323 326
324 327 ##### `QEMU_BINARY`="/usr/bin/qemu-arm-static"
325 328 Sets the QEMU enviornment for the Debian archive. If not set, `QEMU_BINARY` will be set to "/usr/bin/qemu-aarch64-static" automatically if building for arm64.
326 329
327 330 ##### `KERNEL_DEFCONFIG`="bcm2709_defconfig"
328 331 Sets the default config for kernel compiling. If not set, `KERNEL_DEFCONFIG` will be set to "bcmrpi3\_defconfig" automatically if building for arm64.
329 332
330 333 ##### `KERNEL_REDUCE`=false
331 334 Reduce the size of the generated kernel by removing unwanted devices, network and filesystem drivers (experimental).
332 335
333 336 ##### `KERNEL_THREADS`=1
334 337 Number of parallel kernel building threads. If the parameter is left untouched the script will automatically determine the number of CPU cores to set the number of parallel threads to speed the kernel compilation.
335 338
336 339 ##### `KERNEL_HEADERS`=true
337 340 Install kernel headers with the built kernel.
338 341
339 342 ##### `KERNEL_MENUCONFIG`=false
340 343 Start `make menuconfig` interactive menu-driven kernel configuration. The script will continue after `make menuconfig` was terminated.
341 344
342 345 ##### `KERNEL_OLDDEFCONFIG`=false
343 346 Run `make olddefconfig` to automatically set all new kernel configuration options to their recommended default values.
344 347
345 348 ##### `KERNEL_CCACHE`=false
346 349 Compile the kernel using ccache. This speeds up kernel recompilation by caching previous compilations and detecting when the same compilation is being done again.
347 350
348 351 ##### `KERNEL_REMOVESRC`=true
349 352 Remove all kernel sources from the generated OS image after it was built and installed.
350 353
351 354 ##### `KERNELSRC_DIR`=""
352 355 Path to a directory (`linux`) of [RaspberryPi Linux kernel sources](https://github.com/raspberrypi/linux) that will be copied, configured, build and installed inside the chroot.
353 356
354 357 ##### `KERNELSRC_CLEAN`=false
355 358 Clean the existing kernel sources directory `KERNELSRC_DIR` (using `make mrproper`) after it was copied to the chroot and before the compilation of the kernel has started. This parameter will be ignored if no `KERNELSRC_DIR` was specified or if `KERNELSRC_PREBUILT`=true.
356 359
357 360 ##### `KERNELSRC_CONFIG`=true
358 361 Run `make bcm2709_defconfig` (and optional `make menuconfig`) to configure the kernel sources before building. This parameter is automatically set to `true` if no existing kernel sources directory was specified using `KERNELSRC_DIR`. This parameter is ignored if `KERNELSRC_PREBUILT`=true.
359 362
360 363 ##### `KERNELSRC_USRCONFIG`=""
361 364 Copy own config file to kernel `.config`. If `KERNEL_MENUCONFIG`=true then running after copy.
362 365
363 366 ##### `KERNELSRC_PREBUILT`=false
364 367 With this parameter set to true the script expects the existing kernel sources directory to be already successfully cross-compiled. The parameters `KERNELSRC_CLEAN`, `KERNELSRC_CONFIG`, `KERNELSRC_USRCONFIG` and `KERNEL_MENUCONFIG` are ignored and no kernel compilation tasks are performed.
365 368
366 369 ##### `RPI_FIRMWARE_DIR`=""
367 370 The directory (`firmware`) containing a local copy of the firmware from the [RaspberryPi firmware project](https://github.com/raspberrypi/firmware). Default is to download the latest firmware directly from the project.
368 371
369 372 ##### `KERNEL_DEFAULT_GOV`="ONDEMAND"
370 373 Set the default cpu governor at kernel compilation. Supported values are: PERFORMANCE POWERSAVE USERSPACE ONDEMAND CONSERVATIVE SCHEDUTIL
371 374
372 375 ##### `KERNEL_NF`=false
373 376 Enable Netfilter modules as kernel modules
374 377
375 378 ##### `KERNEL_VIRT`=false
376 379 Enable Kernel KVM support (/dev/kvm)
377 380
378 381 ##### `KERNEL_ZSWAP`=false
379 382 Enable Kernel Zswap support. Best use on high RAM load and mediocre CPU load usecases
380 383
381 384 ##### `KERNEL_BPF`=true
382 385 Allow attaching eBPF programs to a cgroup using the bpf syscall (CONFIG_BPF_SYSCALL CONFIG_CGROUP_BPF) [systemd compilations about it - File /lib/systemd/system/systemd-journald.server:36 configures an IP firewall (IPAddressDeny=all), but the local system does not support BPF/cgroup based firewalls]
383 386
384 387 ##### `KERNEL_SECURITY`=false
385 388 Enables Apparmor, integrity subsystem, auditing
386 389 ---
387 390
388 391 #### Reduce disk usage:
389 392 The following list of parameters is ignored if `ENABLE_REDUCE`=false.
390 393
391 394 ##### `REDUCE_APT`=true
392 395 Configure APT to use compressed package repository lists and no package caching files.
393 396
394 397 ##### `REDUCE_DOC`=true
395 398 Remove all doc files (harsh). Configure APT to not include doc files on future `apt-get` package installations.
396 399
397 400 ##### `REDUCE_MAN`=true
398 401 Remove all man pages and info files (harsh). Configure APT to not include man pages on future `apt-get` package installations.
399 402
400 403 ##### `REDUCE_VIM`=false
401 404 Replace `vim-tiny` package by `levee` a tiny vim clone.
402 405
403 406 ##### `REDUCE_BASH`=false
404 407 Remove `bash` package and switch to `dash` shell (experimental).
405 408
406 409 ##### `REDUCE_HWDB`=true
407 410 Remove PCI related hwdb files (experimental).
408 411
409 412 ##### `REDUCE_SSHD`=true
410 413 Replace `openssh-server` with `dropbear`.
411 414
412 415 ##### `REDUCE_LOCALE`=true
413 416 Remove all `locale` translation files.
414 417
415 418 ---
416 419
417 420 #### Encrypted root partition:
418 421 ##### `ENABLE_CRYPTFS`=false
419 422 Enable full system encryption with dm-crypt. Setup a fully LUKS encrypted root partition (aes-xts-plain64:sha512) and generate required initramfs. The /boot directory will not be encrypted. This parameter will be ignored if `BUILD_KERNEL`=false. `ENABLE_CRYPTFS` is experimental. SSH-to-initramfs is currently not supported but will be soon - feel free to help.
420 423
421 424 ##### `CRYPTFS_PASSWORD`=""
422 425 Set password of the encrypted root partition. This parameter is mandatory if `ENABLE_CRYPTFS`=true.
423 426
424 427 ##### `CRYPTFS_MAPPING`="secure"
425 428 Set name of dm-crypt managed device-mapper mapping.
426 429
427 430 ##### `CRYPTFS_CIPHER`="aes-xts-plain64:sha512"
428 431 Set cipher specification string. `aes-xts*` ciphers are strongly recommended.
429 432
430 433 ##### `CRYPTFS_XTSKEYSIZE`=512
431 434 Sets key size in bits. The argument has to be a multiple of 8.
432 435
433 436 ##### `CRYPTFS_DROPBEAR`=false
434 437 Enable Dropbear Initramfs support
435 438
436 439 ##### `CRYPTFS_DROPBEAR_PUBKEY`=""
437 440 Provide path to dropbear Public RSA-OpenSSH Key
438 441
439 442 ---
440 443
441 444 #### Build settings:
442 445 ##### `BASEDIR`=$(pwd)/images/${RELEASE}
443 446 Set a path to a working directory used by the script to generate an image.
444 447
445 448 ##### `IMAGE_NAME`=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}
446 449 Set a filename for the output file(s). Note: the script will create $IMAGE_NAME.img if `ENABLE_SPLITFS`=false or $IMAGE_NAME-frmw.img and $IMAGE_NAME-root.img if `ENABLE_SPLITFS`=true. Note 2: If the KERNEL_BRANCH is not set, the word "CURRENT" is used.
447 450
448 451 ## Understanding the script
449 452 The functions of this script that are required for the different stages of the bootstrapping are split up into single files located inside the `bootstrap.d` directory. During the bootstrapping every script in this directory gets executed in lexicographical order:
450 453
451 454 | Script | Description |
452 455 | --- | --- |
453 456 | `10-bootstrap.sh` | Debootstrap basic system |
454 457 | `11-apt.sh` | Setup APT repositories |
455 458 | `12-locale.sh` | Setup Locales and keyboard settings |
456 459 | `13-kernel.sh` | Build and install RPi 0/1/2/3 Kernel |
457 460 | `14-fstab.sh` | Setup fstab and initramfs |
458 461 | `15-rpi-config.sh` | Setup RPi 0/1/2/3 config and cmdline |
459 462 | `20-networking.sh` | Setup Networking |
460 463 | `21-firewall.sh` | Setup Firewall |
461 464 | `30-security.sh` | Setup Users and Security settings |
462 465 | `31-logging.sh` | Setup Logging |
463 466 | `32-sshd.sh` | Setup SSH and public keys |
464 467 | `41-uboot.sh` | Build and Setup U-Boot |
465 468 | `42-fbturbo.sh` | Build and Setup fbturbo Xorg driver |
466 469 | `43-videocore.sh` | Build and Setup videocore libraries |
467 470 | `50-firstboot.sh` | First boot actions |
468 471 | `99-reduce.sh` | Reduce the disk space usage |
469 472
470 473 All the required configuration files that will be copied to the generated OS image are located inside the `files` directory. It is not recommended to modify these configuration files manually.
471 474
472 475 | Directory | Description |
473 476 | --- | --- |
474 477 | `apt` | APT management configuration files |
475 478 | `boot` | Boot and RPi 0/1/2/3 configuration files |
476 479 | `dpkg` | Package Manager configuration |
477 480 | `etc` | Configuration files and rc scripts |
478 481 | `firstboot` | Scripts that get executed on first boot |
479 482 | `initramfs` | Initramfs scripts |
480 483 | `iptables` | Firewall configuration files |
481 484 | `locales` | Locales configuration |
482 485 | `modules` | Kernel Modules configuration |
483 486 | `mount` | Fstab configuration |
484 487 | `network` | Networking configuration files |
485 488 | `sysctl.d` | Swapping and Network Hardening configuration |
486 489 | `xorg` | fbturbo Xorg driver configuration |
487 490
488 491 ## Custom packages and scripts
489 492 Debian custom packages, i.e. those not in the debian repositories, can be installed by placing them in the `packages` directory. They are installed immediately after packages from the repositories are installed. Any dependencies listed in the custom packages will be downloaded automatically from the repositories. Do not list these custom packages in `APT_INCLUDES`.
490 493
491 494 Scripts in the custom.d directory will be executed after all other installation is complete but before the image is created.
492 495
493 496 ## Logging of the bootstrapping process
494 497 All information related to the bootstrapping process and the commands executed by the `rpi23-gen-image.sh` script can easily be saved into a logfile. The common shell command `script` can be used for this purpose:
495 498
496 499 ```shell
497 500 script -c 'APT_SERVER=ftp.de.debian.org ./rpi23-gen-image.sh' ./build.log
498 501 ```
499 502
500 503 ## Flashing the image file
501 504 After the image file was successfully created by the `rpi23-gen-image.sh` script it can be copied to the microSD card that will be used by the RPi 0/1/2/3 computer. This can be performed by using the tools `bmaptool` or `dd`. Using `bmaptool` will probably speed-up the copy process because `bmaptool` copies more wisely than `dd`.
502 505
503 506 ##### Flashing examples:
504 507 ```shell
505 508 bmaptool copy ./images/buster/2017-01-23-rpi3-buster.img /dev/mmcblk0
506 509 dd bs=4M if=./images/buster/2017-01-23-rpi3-buster.img of=/dev/mmcblk0
507 510 ```
508 511 If you have set `ENABLE_SPLITFS`, copy the `-frmw` image on the microSD card, then the `-root` one on the USB drive:
509 512 ```shell
510 513 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-frmw.img /dev/mmcblk0
511 514 bmaptool copy ./images/buster/2017-01-23-rpi3-buster-root.img /dev/sdc
512 515 ```
513 516
514 517 ## QEMU emulation
515 518 Start QEMU full system emulation:
516 519 ```shell
517 520 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=tty1"
518 521 ```
519 522
520 523 Start QEMU full system emulation and output to console:
521 524 ```shell
522 525 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
523 526 ```
524 527
525 528 Start QEMU full system emulation with SMP and output to console:
526 529 ```shell
527 530 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -smp cpus=2,maxcpus=2 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -append "root=/dev/mmcblk0p2 rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
528 531 ```
529 532
530 533 Start QEMU full system emulation with cryptfs, initramfs and output to console:
531 534 ```shell
532 535 qemu-system-arm -m 2048M -M vexpress-a15 -cpu cortex-a15 -kernel kernel7.img -no-reboot -dtb vexpress-v2p-ca15_a7.dtb -sd ${IMAGE_NAME}.qcow2 -initrd "initramfs-${KERNEL_VERSION}" -append "root=/dev/mapper/secure cryptdevice=/dev/mmcblk0p2:secure rw rootfstype=ext4 console=ttyAMA0,115200 init=/bin/systemd" -serial stdio
533 536 ```
534 537
535 538 ## External links and references
536 539 * [Debian worldwide mirror sites](https://www.debian.org/mirror/list)
537 540 * [Debian Raspberry Pi 2 Wiki](https://wiki.debian.org/RaspberryPi2)
538 541 * [Debian CrossToolchains Wiki](https://wiki.debian.org/CrossToolchains)
539 542 * [Official Raspberry Pi Firmware on github](https://github.com/raspberrypi/firmware)
540 543 * [Official Raspberry Pi Kernel on github](https://github.com/raspberrypi/linux)
541 544 * [U-BOOT git repository](https://git.denx.de/?p=u-boot.git;a=summary)
542 545 * [Xorg DDX driver fbturbo](https://github.com/ssvb/xf86-video-fbturbo)
543 546 * [RPi3 Wireless interface firmware](https://github.com/RPi-Distro/firmware-nonfree/tree/master/brcm80211/brcm)
544 547 * [Collabora RPi2 Kernel precompiled](https://repositories.collabora.co.uk/debian/)
@@ -1,295 +1,300
1 1 #
2 2 # Setup RPi2/3 config and cmdline
3 3 #
4 4
5 5 # Load utility functions
6 6 . ./functions.sh
7 7
8 8 if [ -n "$RPI_FIRMWARE_DIR" ] && [ -d "$RPI_FIRMWARE_DIR" ] ; then
9 9 # Install boot binaries from local directory
10 10 cp "${RPI_FIRMWARE_DIR}"/boot/bootcode.bin "${BOOT_DIR}"/bootcode.bin
11 11 cp "${RPI_FIRMWARE_DIR}"/boot/fixup.dat "${BOOT_DIR}"/fixup.dat
12 12 cp "${RPI_FIRMWARE_DIR}"/boot/fixup_cd.dat "${BOOT_DIR}"/fixup_cd.dat
13 13 cp "${RPI_FIRMWARE_DIR}"/boot/fixup_x.dat "${BOOT_DIR}"/fixup_x.dat
14 14 cp "${RPI_FIRMWARE_DIR}"/boot/start.elf "${BOOT_DIR}"/start.elf
15 15 cp "${RPI_FIRMWARE_DIR}"/boot/start_cd.elf "${BOOT_DIR}"/start_cd.elf
16 16 cp "${RPI_FIRMWARE_DIR}"/boot/start_x.elf "${BOOT_DIR}"/start_x.elf
17 17 else
18 18 # Create temporary directory for boot binaries
19 19 temp_dir=$(as_nobody mktemp -d)
20 20
21 21 # Install latest boot binaries from raspberry/firmware github
22 22 as_nobody wget -q -O "${temp_dir}/bootcode.bin" "${FIRMWARE_URL}/bootcode.bin"
23 23 as_nobody wget -q -O "${temp_dir}/fixup.dat" "${FIRMWARE_URL}/fixup.dat"
24 24 as_nobody wget -q -O "${temp_dir}/fixup_cd.dat" "${FIRMWARE_URL}/fixup_cd.dat"
25 25 as_nobody wget -q -O "${temp_dir}/fixup_x.dat" "${FIRMWARE_URL}/fixup_x.dat"
26 26 as_nobody wget -q -O "${temp_dir}/start.elf" "${FIRMWARE_URL}/start.elf"
27 27 as_nobody wget -q -O "${temp_dir}/start_cd.elf" "${FIRMWARE_URL}/start_cd.elf"
28 28 as_nobody wget -q -O "${temp_dir}/start_x.elf" "${FIRMWARE_URL}/start_x.elf"
29 29
30 30 # Move downloaded boot binaries
31 31 mv "${temp_dir}/"* "${BOOT_DIR}/"
32 32
33 33 # Remove temporary directory for boot binaries
34 34 rm -fr "${temp_dir}"
35 35
36 36 # Set permissions of the boot binaries
37 37 chown -R root:root "${BOOT_DIR}"
38 38 chmod -R 600 "${BOOT_DIR}"
39 39 fi
40 40
41 41 # Setup firmware boot cmdline
42 42 if [ "$ENABLE_USBBOOT" = true ] ; then
43 43 CMDLINE="dwc_otg.lpm_enable=0 root=/dev/sda2 rootfstype=ext4 rootflags=commit=100,data=writeback elevator=deadline console=tty1 rootwait init=/bin/systemd"
44 44 else
45 45 if [ "$ENABLE_SPLITFS" = true ] ; then
46 46 CMDLINE="dwc_otg.lpm_enable=0 root=/dev/sda1 rootfstype=ext4 rootflags=commit=100,data=writeback elevator=deadline console=tty1 rootwait init=/bin/systemd"
47 47 else
48 48 CMDLINE="dwc_otg.lpm_enable=0 root=/dev/mmcblk0p2 rootfstype=ext4 rootflags=commit=100,data=writeback elevator=deadline console=tty1 rootwait init=/bin/systemd"
49 49 fi
50 50 fi
51 51
52 52 # Add encrypted root partition to cmdline.txt
53 53 if [ "$ENABLE_CRYPTFS" = true ] ; then
54 54 if [ "$ENABLE_SPLITFS" = true ] ; then
55 55 CMDLINE=$(echo "${CMDLINE}" | sed "s/sda1/mapper\/${CRYPTFS_MAPPING} cryptdevice=\/dev\/sda1:${CRYPTFS_MAPPING}/")
56 56 else
57 57 if [ "$ENABLE_USBBOOT" = true ] ; then
58 58 CMDLINE=$(echo "${CMDLINE}" | sed "s/sda2/mapper\/${CRYPTFS_MAPPING} cryptdevice=\/dev\/sda2:${CRYPTFS_MAPPING}/")
59 59 else
60 60 CMDLINE=$(echo "${CMDLINE}" | sed "s/mmcblk0p2/mapper\/${CRYPTFS_MAPPING} cryptdevice=\/dev\/mmcblk0p2:${CRYPTFS_MAPPING}/")
61 61 fi
62 62 fi
63 63 fi
64 64
65 65 # Enable Kernel messages on standard output
66 66 if [ "$ENABLE_PRINTK" = true ] ; then
67 67 install_readonly files/sysctl.d/83-rpi-printk.conf "${ETC_DIR}/sysctl.d/83-rpi-printk.conf"
68 68 fi
69 69
70 70 # Enable Kernel messages on standard output
71 71 if [ "$KERNEL_SECURITY" = true ] ; then
72 72 install_readonly files/sysctl.d/84-rpi-ASLR.conf "${ETC_DIR}/sysctl.d/84-rpi-ASLR.conf"
73 73 fi
74 74
75 75 # Install udev rule for serial alias - serial0 = console serial1=bluetooth
76 76 install_readonly files/etc/99-com.rules "${LIB_DIR}/udev/rules.d/99-com.rules"
77 77
78 78 # Remove IPv6 networking support
79 79 if [ "$ENABLE_IPV6" = false ] ; then
80 80 CMDLINE="${CMDLINE} ipv6.disable=1"
81 81 fi
82 82
83 83 # Automatically assign predictable network interface names
84 84 if [ "$ENABLE_IFNAMES" = false ] ; then
85 85 CMDLINE="${CMDLINE} net.ifnames=0"
86 86 else
87 87 CMDLINE="${CMDLINE} net.ifnames=1"
88 88 fi
89 89
90 90 # Disable Raspberry Pi console logo
91 91 if [ "$ENABLE_LOGO" = false ] ; then
92 92 CMDLINE="${CMDLINE} logo.nologo"
93 93 fi
94 94
95 95 # Strictly limit verbosity of boot up console messages
96 96 if [ "$ENABLE_SILENT_BOOT" = true ] ; then
97 97 CMDLINE="${CMDLINE} quiet loglevel=0 rd.systemd.show_status=auto rd.udev.log_priority=0"
98 98 fi
99 99
100 100 # Install firmware config
101 101 install_readonly files/boot/config.txt "${BOOT_DIR}/config.txt"
102 102
103 103 # Disable Raspberry Pi console logo
104 104 if [ "$ENABLE_SLASH" = false ] ; then
105 105 echo "disable_splash=1" >> "${BOOT_DIR}/config.txt"
106 106 fi
107 107
108 108 # Locks CPU frequency at maximum
109 109 if [ "$ENABLE_TURBO" = true ] ; then
110 110 echo "force_turbo=1" >> "${BOOT_DIR}/config.txt"
111 111 # helps to avoid sdcard corruption when force_turbo is enabled.
112 112 echo "boot_delay=1" >> "${BOOT_DIR}/config.txt"
113 113 fi
114 114
115 115 if [ "$RPI_MODEL" = 0 ] || [ "$RPI_MODEL" = 3 ] || [ "$RPI_MODEL" = 3P ] ; then
116 116
117 117 # Bluetooth enabled
118 118 if [ "$ENABLE_BLUETOOTH" = true ] ; then
119 119 # Create temporary directory for Bluetooth sources
120 120 temp_dir=$(as_nobody mktemp -d)
121 121
122 122 # Fetch Bluetooth sources
123 123 as_nobody git -C "${temp_dir}" clone "${BLUETOOTH_URL}"
124 124
125 125 # Copy downloaded sources
126 126 mv "${temp_dir}/pi-bluetooth" "${R}/tmp/"
127 127
128 128 # Bluetooth firmware from arch aur https://aur.archlinux.org/packages/pi-bluetooth/
129 129 as_nobody wget -q -O "${R}/tmp/pi-bluetooth/LICENCE.broadcom_bcm43xx" https://aur.archlinux.org/cgit/aur.git/plain/LICENCE.broadcom_bcm43xx?h=pi-bluetooth
130 130 as_nobody wget -q -O "${R}/tmp/pi-bluetooth/BCM43430A1.hcd" https://aur.archlinux.org/cgit/aur.git/plain/BCM43430A1.hcd?h=pi-bluetooth
131 131
132 132 # Set permissions
133 133 chown -R root:root "${R}/tmp/pi-bluetooth"
134 134
135 135 # Install tools
136 136 install_readonly "${R}/tmp/pi-bluetooth/usr/bin/btuart" "${R}/usr/bin/btuart"
137 137 install_readonly "${R}/tmp/pi-bluetooth/usr/bin/bthelper" "${R}/usr/bin/bthelper"
138 138
139 139 # make scripts executable
140 140 chmod +x "${R}/usr/bin/bthelper"
141 141 chmod +x "${R}/usr/bin/btuart"
142 142
143 143 # Install bluetooth udev rule
144 144 install_readonly "${R}/tmp/pi-bluetooth/lib/udev/rules.d/90-pi-bluetooth.rules" "${LIB_DIR}/udev/rules.d/90-pi-bluetooth.rules"
145 145
146 146 # Install Firmware Flash file and apropiate licence
147 147 mkdir -p "$BLUETOOTH_FIRMWARE_DIR"
148 148 install_readonly "${R}/tmp/pi-bluetooth/LICENCE.broadcom_bcm43xx" "${BLUETOOTH_FIRMWARE_DIR}/LICENCE.broadcom_bcm43xx"
149 149 install_readonly "${R}/tmp/pi-bluetooth/BCM43430A1.hcd" "${BLUETOOTH_FIRMWARE_DIR}/LICENCE.broadcom_bcm43xx"
150 150 install_readonly "${R}/tmp/pi-bluetooth/debian/pi-bluetooth.bthelper@.service" "${ETC_DIR}/systemd/system/pi-bluetooth.bthelper@.service"
151 151 install_readonly "${R}/tmp/pi-bluetooth/debian/pi-bluetooth.hciuart.service" "${ETC_DIR}/systemd/system/pi-bluetooth.hciuart.service"
152 152
153 153 # Remove temporary directories
154 154 rm -fr "${temp_dir}"
155 155 rm -fr "${R}"/tmp/pi-bluetooth
156 156
157 157 # Switch Pi3 Bluetooth function to use the mini-UART (ttyS0) and restore UART0/ttyAMA0 over GPIOs 14 & 15. Slow Bluetooth and slow cpu. Use /dev/ttyS0 instead of /dev/ttyAMA0
158 158 if [ "$ENABLE_MINIUART_OVERLAY" = true ] ; then
159 159 # set overlay to swap ttyAMA0 and ttyS0
160 160 echo "dtoverlay=pi3-miniuart-bt" >> "${BOOT_DIR}/config.txt"
161 161
162 162 if [ "$ENABLE_TURBO" = false ] ; then
163 163 echo "core_freq=250" >> "${BOOT_DIR}/config.txt"
164 164 fi
165 165
166 166 fi
167 167
168 168 # Activate services
169 169 chroot_exec systemctl enable pi-bluetooth.hciuart.service
170 170
171 171 else # if ENABLE_BLUETOOTH = false
172 172 # set overlay to disable bluetooth
173 173 echo "dtoverlay=pi3-disable-bt" >> "${BOOT_DIR}/config.txt"
174 174 fi # ENABLE_BLUETOOTH end
175 175 fi
176 176
177 177 # may need sudo systemctl disable hciuart
178 178 if [ "$ENABLE_CONSOLE" = true ] ; then
179 179 echo "enable_uart=1" >> "${BOOT_DIR}/config.txt"
180 180 # add string to cmdline
181 181 CMDLINE="${CMDLINE} console=serial0,115200"
182 182
183 183 if [ "$RPI_MODEL" = 3 ] || [ "$RPI_MODEL" = 3P ]|| [ "$RPI_MODEL" = 0 ]; then
184 184 # if force_turbo didn't lock cpu at high speed, lock it at low speed (XOR logic) or miniuart will be broken
185 185 if [ "$ENABLE_TURBO" = false ] ; then
186 186 echo "core_freq=250" >> "${BOOT_DIR}/config.txt"
187 187 fi
188 188 fi
189 189
190 190 # Enable serial console systemd style
191 191 chroot_exec systemctl enable serial-getty@serial0.service
192 192 else
193 193 echo "enable_uart=0" >> "${BOOT_DIR}/config.txt"
194 194 fi
195 195
196 # Disable dphys-swapfile service. Will get enabled on first boot
197 if [ "$ENABLE_DPHYSSWAP" = true ] ; then
198 chroot_exec systemctl disable dphys-swapfile
199 fi
200
196 201 if [ "$ENABLE_SYSTEMDSWAP" = true ] ; then
197 202 # Create temporary directory for systemd-swap sources
198 203 temp_dir=$(as_nobody mktemp -d)
199 204
200 205 # Fetch systemd-swap sources
201 206 as_nobody git -C "${temp_dir}" clone "${SYSTEMDSWAP_URL}"
202 207
203 208 # Copy downloaded systemd-swap sources
204 209 mv "${temp_dir}/systemd-swap" "${R}/tmp/"
205 210
206 211 # Change into downloaded src dir
207 212 cd "${R}/tmp/systemd-swap" || exit
208 213
209 214 # Build package
210 215 bash ./package.sh debian
211 216
212 217 # Change back into script root dir
213 218 cd "${WORKDIR}" || exit
214 219
215 220 # Set permissions of the systemd-swap sources
216 221 chown -R root:root "${R}/tmp/systemd-swap"
217 222
218 223 # Install package - IMPROVE AND MAKE IT POSSIBLE WITHOUT VERSION NR.
219 224 chroot_exec dpkg -i /tmp/systemd-swap/systemd-swap_4.0.1_any.deb
220 225
221 226 # Enable service
222 227 chroot_exec systemctl enable systemd-swap
223 228
224 229 # Remove temporary directory for systemd-swap sources
225 230 rm -fr "${temp_dir}"
226 231 else
227 232 # Enable ZSWAP in cmdline if systemd-swap is not used
228 233 if [ "$KERNEL_ZSWAP" = true ] ; then
229 234 CMDLINE="${CMDLINE} zswap.enabled=1 zswap.max_pool_percent=25 zswap.compressor=lz4"
230 235 fi
231 236 fi
232 237 if [ "$KERNEL_SECURITY" = true ] ; then
233 238 CMDLINE="${CMDLINE} apparmor=1 security=apparmor"
234 239 fi
235 240
236 241 # Install firmware boot cmdline
237 242 echo "${CMDLINE}" > "${BOOT_DIR}/cmdline.txt"
238 243
239 244 # Setup minimal GPU memory allocation size: 16MB (no X)
240 245 if [ "$ENABLE_MINGPU" = true ] ; then
241 246 echo "gpu_mem=16" >> "${BOOT_DIR}/config.txt"
242 247 fi
243 248
244 249 # Setup boot with initramfs
245 250 if [ "$ENABLE_INITRAMFS" = true ] ; then
246 251 echo "initramfs initramfs-${KERNEL_VERSION} followkernel" >> "${BOOT_DIR}/config.txt"
247 252 fi
248 253
249 254 # Create firmware configuration and cmdline symlinks
250 255 ln -sf firmware/config.txt "${R}/boot/config.txt"
251 256 ln -sf firmware/cmdline.txt "${R}/boot/cmdline.txt"
252 257
253 258 # Install and setup kernel modules to load at boot
254 259 mkdir -p "${LIB_DIR}/modules-load.d/"
255 260 install_readonly files/modules/rpi2.conf "${LIB_DIR}/modules-load.d/rpi2.conf"
256 261
257 262 # Load hardware random module at boot
258 263 if [ "$ENABLE_HWRANDOM" = true ] && [ "$BUILD_KERNEL" = false ] ; then
259 264 sed -i "s/^# bcm2708_rng/bcm2708_rng/" "${LIB_DIR}/modules-load.d/rpi2.conf"
260 265 fi
261 266
262 267 # Load sound module at boot
263 268 if [ "$ENABLE_SOUND" = true ] ; then
264 269 sed -i "s/^# snd_bcm2835/snd_bcm2835/" "${LIB_DIR}/modules-load.d/rpi2.conf"
265 270 else
266 271 echo "dtparam=audio=off" >> "${BOOT_DIR}/config.txt"
267 272 fi
268 273
269 274 # Enable I2C interface
270 275 if [ "$ENABLE_I2C" = true ] ; then
271 276 echo "dtparam=i2c_arm=on" >> "${BOOT_DIR}/config.txt"
272 277 sed -i "s/^# i2c-bcm2708/i2c-bcm2708/" "${LIB_DIR}/modules-load.d/rpi2.conf"
273 278 sed -i "s/^# i2c-dev/i2c-dev/" "${LIB_DIR}/modules-load.d/rpi2.conf"
274 279 fi
275 280
276 281 # Enable SPI interface
277 282 if [ "$ENABLE_SPI" = true ] ; then
278 283 echo "dtparam=spi=on" >> "${BOOT_DIR}/config.txt"
279 284 echo "spi-bcm2708" >> "${LIB_DIR}/modules-load.d/rpi2.conf"
280 285 if [ "$RPI_MODEL" = 3 ] || [ "$RPI_MODEL" = 3P ]; then
281 286 sed -i "s/spi-bcm2708/spi-bcm2835/" "${LIB_DIR}/modules-load.d/rpi2.conf"
282 287 fi
283 288 fi
284 289
285 290 # Disable RPi2/3 under-voltage warnings
286 291 if [ -n "$DISABLE_UNDERVOLT_WARNINGS" ] ; then
287 292 echo "avoid_warnings=${DISABLE_UNDERVOLT_WARNINGS}" >> "${BOOT_DIR}/config.txt"
288 293 fi
289 294
290 295 # Install kernel modules blacklist
291 296 mkdir -p "${ETC_DIR}/modprobe.d/"
292 297 install_readonly files/modules/raspi-blacklist.conf "${ETC_DIR}/modprobe.d/raspi-blacklist.conf"
293 298
294 299 # Install sysctl.d configuration files
295 300 install_readonly files/sysctl.d/81-rpi-vm.conf "${ETC_DIR}/sysctl.d/81-rpi-vm.conf"
@@ -1,49 +1,54
1 1 #
2 2 # First boot actions
3 3 #
4 4
5 5 # Load utility functions
6 6 . ./functions.sh
7 7
8 8 # Prepare rc.firstboot script
9 9 cat files/firstboot/10-begin.sh > "${ETC_DIR}/rc.firstboot"
10 10
11 # Ensure openssh server host keys are regenerated on first boot
12 if [ "$ENABLE_SSHD" = true ] ; then
13 cat files/firstboot/21-generate-ssh-keys.sh >> "${ETC_DIR}/rc.firstboot"
14 fi
15
16 11 # Prepare filesystem auto expand
17 12 if [ "$EXPANDROOT" = true ] ; then
18 13 if [ "$ENABLE_CRYPTFS" = false ] ; then
19 cat files/firstboot/22-expandroot.sh >> "${ETC_DIR}/rc.firstboot"
14 cat files/firstboot/20-expandroot.sh >> "${ETC_DIR}/rc.firstboot"
20 15 else
21 16 # Regenerate initramfs to remove encrypted root partition auto expand
22 cat files/firstboot/23-regenerate-initramfs.sh >> "${ETC_DIR}/rc.firstboot"
17 cat files/firstboot/21-regenerate-initramfs.sh >> "${ETC_DIR}/rc.firstboot"
18 fi
19
20 # Restart dphys-swapfile so the size of the swap file is relative to the resized root partition
21 if [ "$ENABLE_DPHYSSWAP" = true ] ; then
22 cat files/firstboot/23-restart-dphys-swapfile.sh >> "${ETC_DIR}/rc.firstboot"
23 fi
23 24 fi
25
26 # Ensure openssh server host keys are regenerated on first boot
27 if [ "$ENABLE_SSHD" = true ] ; then
28 cat files/firstboot/30-generate-ssh-keys.sh >> "${ETC_DIR}/rc.firstboot"
24 29 fi
25 30
26 31 # Ensure that dbus machine-id exists
27 cat files/firstboot/24-generate-machineid.sh >> "${ETC_DIR}/rc.firstboot"
32 cat files/firstboot/40-generate-machineid.sh >> "${ETC_DIR}/rc.firstboot"
28 33
29 34 # Create /etc/resolv.conf symlink
30 cat files/firstboot/25-create-resolv-symlink.sh >> "${ETC_DIR}/rc.firstboot"
35 cat files/firstboot/41-create-resolv-symlink.sh >> "${ETC_DIR}/rc.firstboot"
31 36
32 37 # Configure automatic network interface names
33 38 if [ "$ENABLE_IFNAMES" = true ] ; then
34 cat files/firstboot/26-config-ifnames.sh >> "${ETC_DIR}/rc.firstboot"
39 cat files/firstboot/42-config-ifnames.sh >> "${ETC_DIR}/rc.firstboot"
35 40 fi
36 41
37 42 # Finalize rc.firstboot script
38 43 cat files/firstboot/99-finish.sh >> "${ETC_DIR}/rc.firstboot"
39 44 chmod +x "${ETC_DIR}/rc.firstboot"
40 45
41 46 # Install default rc.local if it does not exist
42 47 if [ ! -f "${ETC_DIR}/rc.local" ] ; then
43 48 install_exec files/etc/rc.local "${ETC_DIR}/rc.local"
44 49 fi
45 50
46 51 # Add rc.firstboot script to rc.local
47 52 sed -i '/exit 0/d' "${ETC_DIR}/rc.local"
48 53 echo /etc/rc.firstboot >> "${ETC_DIR}/rc.local"
49 54 echo exit 0 >> "${ETC_DIR}/rc.local"
@@ -1,76 +1,68
1 1 logger -t "rc.firstboot" "Expanding root partition"
2 2
3 3 # Detect root partition device
4 4 ROOT_PART=$(mount | sed -n 's|^/dev/\(.*\) on / .*|\1|p')
5 5 if [ -z "$ROOT_PART" ] ; then
6 6 log_warning_msg "unable to detect root partition device"
7 7 return 1
8 8 fi
9 9
10 10 # Extract root device name
11 11 case "${ROOT_PART}" in
12 12 mmcblk0*) ROOT_DEV=mmcblk0 ;;
13 13 sda*) ROOT_DEV=sda ;;
14 14 esac
15 15
16 16 # Check detected root partition name
17 17 PART_NUM=$(echo ${ROOT_PART} | grep -o '[1-9][0-9]*$')
18 18 if [ "$PART_NUM" = "$ROOT_PART" ] ; then
19 19 logger -t "rc.firstboot" "$ROOT_PART is not an SD card. Don't know how to expand"
20 20 return 0
21 21 fi
22 22
23 23 # NOTE: the NOOBS partition layout confuses parted. For now, let's only
24 24 # agree to work with a sufficiently simple partition layout
25 25 if [ "$PART_NUM" -gt 2 ] ; then
26 26 logger -t "rc.firstboot" "Your partition layout is not currently supported by this tool."
27 27 return 0
28 28 fi
29 29
30 30 # Check if last partition number
31 31 LAST_PART_NUM=$(parted /dev/${ROOT_DEV} -ms unit s p | tail -n 1 | cut -f 1 -d:)
32 32 if [ $LAST_PART_NUM -ne $PART_NUM ]; then
33 33 logger -t "rc.firstboot" "$ROOT_PART is not the last partition. Don't know how to expand"
34 34 return 0
35 35 fi
36 36
37 37 # Get the starting offset of the root partition
38 38 PART_START=$(parted /dev/${ROOT_DEV} -ms unit s p | grep "^${PART_NUM}" | cut -f 2 -d: | sed 's/[^0-9]//g')
39 39 if [ -z "$PART_START" ] ; then
40 40 logger -t "rc.firstboot" "${ROOT_DEV} unable to get starting sector of the partition"
41 41 return 1
42 42 fi
43 43
44 44 # Get the possible last sector for the root partition
45 45 PART_LAST=$(fdisk -l /dev/${ROOT_DEV} | grep '^Disk.*sectors' | awk '{ print $7 - 1 }')
46 46 if [ -z "$PART_LAST" ] ; then
47 47 logger -t "rc.firstboot" "${ROOT_DEV} unable to get last sector of the partition"
48 48 return 1
49 49 fi
50 50
51 51 ### Since rc.local is run with "sh -e", let's add "|| true" to prevent premature exit
52 52 fdisk /dev/${ROOT_DEV} <<EOF2 || true
53 53 p
54 54 d
55 55 $PART_NUM
56 56 n
57 57 p
58 58 $PART_NUM
59 59 $PART_START
60 60 $PART_LAST
61 61 p
62 62 w
63 63 EOF2
64 64
65 65 # Reload the partition table, resize root filesystem then remove resizing code from this file
66 66 partprobe &&
67 67 resize2fs /dev/${ROOT_PART} &&
68 68 logger -t "rc.firstboot" "Root partition successfully resized."
69
70 # Restart dphys-swapfile service if it exists
71 if systemctl list-units | grep -q dphys-swapfile ; then
72 if systemctl is-enabled dphys-swapfile ; then
73 logger -t "rc.firstboot" "Restarting dphys-swapfile"
74 systemctl restart dphys-swapfile
75 fi
76 fi
1 NO CONTENT: file renamed from files/firstboot/23-regenerate-initramfs.sh to files/firstboot/21-regenerate-initramfs.sh
1 NO CONTENT: file renamed from files/firstboot/21-generate-ssh-keys.sh to files/firstboot/30-generate-ssh-keys.sh
1 NO CONTENT: file renamed from files/firstboot/24-generate-machineid.sh to files/firstboot/40-generate-machineid.sh
1 NO CONTENT: file renamed from files/firstboot/25-create-resolv-symlink.sh to files/firstboot/41-create-resolv-symlink.sh
1 NO CONTENT: file renamed from files/firstboot/26-config-ifnames.sh to files/firstboot/42-config-ifnames.sh
@@ -1,863 +1,869
1 1 #!/bin/sh
2 2 ########################################################################
3 3 # rpi23-gen-image.sh 2015-2017
4 4 #
5 5 # Advanced Debian "stretch" and "buster" bootstrap script for Raspberry Pi
6 6 #
7 7 # This program is free software; you can redistribute it and/or
8 8 # modify it under the terms of the GNU General Public License
9 9 # as published by the Free Software Foundation; either version 2
10 10 # of the License, or (at your option) any later version.
11 11 #
12 12 # Copyright (C) 2015 Jan Wagner <mail@jwagner.eu>
13 13 #
14 14 # Big thanks for patches and enhancements by 20+ github contributors!
15 15 ########################################################################
16 16
17 17 # Are we running as root?
18 18 if [ "$(id -u)" -ne "0" ] ; then
19 19 echo "error: this script must be executed with root privileges!"
20 20 exit 1
21 21 fi
22 22
23 23 # Check if ./functions.sh script exists
24 24 if [ ! -r "./functions.sh" ] ; then
25 25 echo "error: './functions.sh' required script not found!"
26 26 exit 1
27 27 fi
28 28
29 29 # Load utility functions
30 30 . ./functions.sh
31 31
32 32 # Load parameters from configuration template file
33 33 if [ -n "$CONFIG_TEMPLATE" ] ; then
34 34 use_template
35 35 fi
36 36
37 37 # Introduce settings
38 38 set -e
39 39 echo -n -e "\n#\n# RPi 0/1/2/3 Bootstrap Settings\n#\n"
40 40 set -x
41 41
42 42 # Raspberry Pi model configuration
43 43 RPI_MODEL=${RPI_MODEL:=2}
44 44
45 45 # Debian release
46 46 RELEASE=${RELEASE:=buster}
47 47
48 48 # Kernel Branch
49 49 KERNEL_BRANCH=${KERNEL_BRANCH:=""}
50 50
51 51 # URLs
52 52 KERNEL_URL=${KERNEL_URL:=https://github.com/raspberrypi/linux}
53 53 FIRMWARE_URL=${FIRMWARE_URL:=https://github.com/raspberrypi/firmware/raw/master/boot}
54 54 WLAN_FIRMWARE_URL=${WLAN_FIRMWARE_URL:=https://github.com/RPi-Distro/firmware-nonfree/raw/master/brcm}
55 55 COLLABORA_URL=${COLLABORA_URL:=https://repositories.collabora.co.uk/debian}
56 56 FBTURBO_URL=${FBTURBO_URL:=https://github.com/ssvb/xf86-video-fbturbo.git}
57 57 UBOOT_URL=${UBOOT_URL:=https://git.denx.de/u-boot.git}
58 58 VIDEOCORE_URL=${VIDEOCORE_URL:=https://github.com/raspberrypi/userland}
59 59 BLUETOOTH_URL=${BLUETOOTH_URL:=https://github.com/RPi-Distro/pi-bluetooth.git}
60 60 NEXMON_URL=${NEXMON_URL:=https://github.com/seemoo-lab/nexmon.git}
61 61 SYSTEMDSWAP_URL=${SYSTEMDSWAP_URL:=https://github.com/Nefelim4ag/systemd-swap.git}
62 62
63 63 # Kernel deb packages for 32bit kernel
64 64 RPI_32_KERNEL_URL=${RPI_32_KERNEL_URL:=https://github.com/hypriot/rpi-kernel/releases/download/v4.14.34/raspberrypi-kernel_20180422-141901_armhf.deb}
65 65 RPI_32_KERNELHEADER_URL=${RPI_32_KERNELHEADER_URL:=https://github.com/hypriot/rpi-kernel/releases/download/v4.14.34/raspberrypi-kernel-headers_20180422-141901_armhf.deb}
66 66 # Kernel has KVM and zswap enabled - use if KERNEL_* parameters and precompiled kernel are used
67 67 RPI3_64_BIS_KERNEL_URL=${RPI3_64_BIS_KERNEL_URL:=https://github.com/sakaki-/bcmrpi3-kernel-bis/releases/download/4.14.80.20181113/bcmrpi3-kernel-bis-4.14.80.20181113.tar.xz}
68 68 # Default precompiled 64bit kernel
69 69 RPI3_64_DEF_KERNEL_URL=${RPI3_64_DEF_KERNEL_URL:=https://github.com/sakaki-/bcmrpi3-kernel/releases/download/4.14.80.20181113/bcmrpi3-kernel-4.14.80.20181113.tar.xz}
70 70 # Generic
71 71 RPI3_64_KERNEL_URL=${RPI3_64_KERNEL_URL:=$RPI3_64_DEF_KERNEL_URL}
72 72 # Kali kernel src - used if ENABLE_NEXMON=true (they patch the wlan kernel modul)
73 73 KALI_KERNEL_URL=${KALI_KERNEL_URL:=https://github.com/Re4son/re4son-raspberrypi-linux.git}
74 74
75 75 # Build directories
76 76 WORKDIR=$(pwd)
77 77 BASEDIR=${BASEDIR:=${WORKDIR}/images/${RELEASE}}
78 78 BUILDDIR="${BASEDIR}/build"
79 79
80 80 # Chroot directories
81 81 R="${BUILDDIR}/chroot"
82 82 ETC_DIR="${R}/etc"
83 83 LIB_DIR="${R}/lib"
84 84 BOOT_DIR="${R}/boot/firmware"
85 85 KERNEL_DIR="${R}/usr/src/linux"
86 86 WLAN_FIRMWARE_DIR="${LIB_DIR}/firmware/brcm"
87 87 BLUETOOTH_FIRMWARE_DIR="${ETC_DIR}/firmware/bt"
88 88
89 89 # Firmware directory: Blank if download from github
90 90 RPI_FIRMWARE_DIR=${RPI_FIRMWARE_DIR:=""}
91 91
92 92 # General settings
93 93 SET_ARCH=${SET_ARCH:=32}
94 94 HOSTNAME=${HOSTNAME:=rpi${RPI_MODEL}-${RELEASE}}
95 95 PASSWORD=${PASSWORD:=raspberry}
96 96 USER_PASSWORD=${USER_PASSWORD:=raspberry}
97 97 DEFLOCAL=${DEFLOCAL:="en_US.UTF-8"}
98 98 TIMEZONE=${TIMEZONE:="Europe/Berlin"}
99 99 EXPANDROOT=${EXPANDROOT:=true}
100 ENABLE_DPHYSSWAP=${ENABLE_DPHYSSWAP:=true}
100 101
101 102 # Keyboard settings
102 103 XKB_MODEL=${XKB_MODEL:=""}
103 104 XKB_LAYOUT=${XKB_LAYOUT:=""}
104 105 XKB_VARIANT=${XKB_VARIANT:=""}
105 106 XKB_OPTIONS=${XKB_OPTIONS:=""}
106 107
107 108 # Network settings (DHCP)
108 109 ENABLE_DHCP=${ENABLE_DHCP:=true}
109 110
110 111 # Network settings (static)
111 112 NET_ADDRESS=${NET_ADDRESS:=""}
112 113 NET_GATEWAY=${NET_GATEWAY:=""}
113 114 NET_DNS_1=${NET_DNS_1:=""}
114 115 NET_DNS_2=${NET_DNS_2:=""}
115 116 NET_DNS_DOMAINS=${NET_DNS_DOMAINS:=""}
116 117 NET_NTP_1=${NET_NTP_1:=""}
117 118 NET_NTP_2=${NET_NTP_2:=""}
118 119
119 120 # APT settings
120 121 APT_PROXY=${APT_PROXY:=""}
121 122 APT_SERVER=${APT_SERVER:="ftp.debian.org"}
122 123 KEEP_APT_PROXY=${KEEP_APT_PROXY:=false}
123 124
124 125 # Feature settings
125 126 ENABLE_PRINTK=${ENABLE_PRINTK:=false}
126 127 ENABLE_BLUETOOTH=${ENABLE_BLUETOOTH:=false}
127 128 ENABLE_MINIUART_OVERLAY=${ENABLE_MINIUART_OVERLAY:=false}
128 129 ENABLE_CONSOLE=${ENABLE_CONSOLE:=true}
129 130 ENABLE_I2C=${ENABLE_I2C:=false}
130 131 ENABLE_SPI=${ENABLE_SPI:=false}
131 132 ENABLE_IPV6=${ENABLE_IPV6:=true}
132 133 ENABLE_SSHD=${ENABLE_SSHD:=true}
133 134 ENABLE_NONFREE=${ENABLE_NONFREE:=false}
134 135 ENABLE_WIRELESS=${ENABLE_WIRELESS:=false}
135 136 ENABLE_SOUND=${ENABLE_SOUND:=true}
136 137 ENABLE_DBUS=${ENABLE_DBUS:=true}
137 138 ENABLE_HWRANDOM=${ENABLE_HWRANDOM:=true}
138 139 ENABLE_MINGPU=${ENABLE_MINGPU:=false}
139 140 ENABLE_XORG=${ENABLE_XORG:=false}
140 141 ENABLE_WM=${ENABLE_WM:=""}
141 142 ENABLE_RSYSLOG=${ENABLE_RSYSLOG:=true}
142 143 ENABLE_USER=${ENABLE_USER:=true}
143 144 USER_NAME=${USER_NAME:="pi"}
144 145 ENABLE_ROOT=${ENABLE_ROOT:=false}
145 146 ENABLE_QEMU=${ENABLE_QEMU:=false}
146 147 ENABLE_SYSVINIT=${ENABLE_SYSVINIT:=false}
147 148
148 149 # SSH settings
149 150 SSH_ENABLE_ROOT=${SSH_ENABLE_ROOT:=false}
150 151 SSH_DISABLE_PASSWORD_AUTH=${SSH_DISABLE_PASSWORD_AUTH:=false}
151 152 SSH_LIMIT_USERS=${SSH_LIMIT_USERS:=false}
152 153 SSH_ROOT_PUB_KEY=${SSH_ROOT_PUB_KEY:=""}
153 154 SSH_USER_PUB_KEY=${SSH_USER_PUB_KEY:=""}
154 155
155 156 # Advanced settings
156 157 ENABLE_SYSTEMDSWAP=${ENABLE_SYSTEMDSWAP:=false}
157 158 ENABLE_MINBASE=${ENABLE_MINBASE:=false}
158 159 ENABLE_REDUCE=${ENABLE_REDUCE:=false}
159 160 ENABLE_UBOOT=${ENABLE_UBOOT:=false}
160 161 UBOOTSRC_DIR=${UBOOTSRC_DIR:=""}
161 162 ENABLE_USBBOOT=${ENABLE_USBBOOT=false}
162 163 ENABLE_FBTURBO=${ENABLE_FBTURBO:=false}
163 164 ENABLE_VIDEOCORE=${ENABLE_VIDEOCORE:=false}
164 165 ENABLE_NEXMON=${ENABLE_NEXMON:=false}
165 166 VIDEOCORESRC_DIR=${VIDEOCORESRC_DIR:=""}
166 167 FBTURBOSRC_DIR=${FBTURBOSRC_DIR:=""}
167 168 NEXMONSRC_DIR=${NEXMONSRC_DIR:=""}
168 169 ENABLE_HARDNET=${ENABLE_HARDNET:=false}
169 170 ENABLE_IPTABLES=${ENABLE_IPTABLES:=false}
170 171 ENABLE_SPLITFS=${ENABLE_SPLITFS:=false}
171 172 ENABLE_INITRAMFS=${ENABLE_INITRAMFS:=false}
172 173 ENABLE_IFNAMES=${ENABLE_IFNAMES:=true}
173 174 ENABLE_SPLASH=${ENABLE_SPLASH:=true}
174 175 ENABLE_LOGO=${ENABLE_LOGO:=true}
175 176 ENABLE_SILENT_BOOT=${ENABLE_SILENT_BOOT=false}
176 177 DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS:=}
177 178
178 179 # Kernel compilation settings
179 180 BUILD_KERNEL=${BUILD_KERNEL:=true}
180 181 KERNEL_REDUCE=${KERNEL_REDUCE:=false}
181 182 KERNEL_THREADS=${KERNEL_THREADS:=1}
182 183 KERNEL_HEADERS=${KERNEL_HEADERS:=true}
183 184 KERNEL_MENUCONFIG=${KERNEL_MENUCONFIG:=false}
184 185 KERNEL_REMOVESRC=${KERNEL_REMOVESRC:=true}
185 186 KERNEL_OLDDEFCONFIG=${KERNEL_OLDDEFCONFIG:=false}
186 187 KERNEL_CCACHE=${KERNEL_CCACHE:=false}
187 188 KERNEL_ZSWAP=${KERNEL_ZSWAP:=false}
188 189 KERNEL_VIRT=${KERNEL_VIRT:=false}
189 190 KERNEL_BPF=${KERNEL_BPF:=false}
190 191 KERNEL_DEFAULT_GOV=${KERNEL_DEFAULT_GOV:=powersave}
191 192 KERNEL_SECURITY=${KERNEL_SECURITY:=false}
192 193 KERNEL_NF=${KERNEL_NF:=false}
193 194
194 195 # Kernel compilation from source directory settings
195 196 KERNELSRC_DIR=${KERNELSRC_DIR:=""}
196 197 KERNELSRC_CLEAN=${KERNELSRC_CLEAN:=false}
197 198 KERNELSRC_CONFIG=${KERNELSRC_CONFIG:=true}
198 199 KERNELSRC_PREBUILT=${KERNELSRC_PREBUILT:=false}
199 200
200 201 # Reduce disk usage settings
201 202 REDUCE_APT=${REDUCE_APT:=true}
202 203 REDUCE_DOC=${REDUCE_DOC:=true}
203 204 REDUCE_MAN=${REDUCE_MAN:=true}
204 205 REDUCE_VIM=${REDUCE_VIM:=false}
205 206 REDUCE_BASH=${REDUCE_BASH:=false}
206 207 REDUCE_HWDB=${REDUCE_HWDB:=true}
207 208 REDUCE_SSHD=${REDUCE_SSHD:=true}
208 209 REDUCE_LOCALE=${REDUCE_LOCALE:=true}
209 210
210 211 # Encrypted filesystem settings
211 212 ENABLE_CRYPTFS=${ENABLE_CRYPTFS:=false}
212 213 CRYPTFS_PASSWORD=${CRYPTFS_PASSWORD:=""}
213 214 CRYPTFS_MAPPING=${CRYPTFS_MAPPING:="secure"}
214 215 CRYPTFS_CIPHER=${CRYPTFS_CIPHER:="aes-xts-plain64:sha512"}
215 216 CRYPTFS_XTSKEYSIZE=${CRYPTFS_XTSKEYSIZE:=512}
216 217 #Dropbear-initramfs supports unlocking encrypted filesystem via SSH on bootup
217 218 CRYPTFS_DROPBEAR=${CRYPTFS_DROPBEAR:=false}
218 219 #Provide your own Dropbear Public RSA-OpenSSH Key otherwise it will be generated
219 220 CRYPTFS_DROPBEAR_PUBKEY=${CRYPTFS_DROPBEAR_PUBKEY:=""}
220 221
221 222 # Chroot scripts directory
222 223 CHROOT_SCRIPTS=${CHROOT_SCRIPTS:=""}
223 224
224 225 # Packages required in the chroot build environment
225 226 APT_INCLUDES=${APT_INCLUDES:=""}
226 227 APT_INCLUDES="${APT_INCLUDES},apt-transport-https,apt-utils,ca-certificates,debian-archive-keyring,dialog,sudo,systemd,sysvinit-utils,locales,keyboard-configuration,console-setup,libnss-systemd"
227 228
228 229 # Packages to exclude from chroot build environment
229 230 APT_EXCLUDES=${APT_EXCLUDES:=""}
230 231
231 232 # Packages required for bootstrapping
232 233 REQUIRED_PACKAGES="debootstrap debian-archive-keyring qemu-user-static binfmt-support dosfstools rsync bmap-tools whois git bc psmisc dbus sudo"
233 234 MISSING_PACKAGES=""
234 235
235 236 # Packages installed for c/c++ build environment in chroot (keep empty)
236 237 COMPILER_PACKAGES=""
237 238
238 239 # Check if apt-cacher-ng has port 3142 open and set APT_PROXY
239 240 APT_CACHER_RUNNING=$(lsof -i :3142 | cut -d ' ' -f3 | uniq | sed '/^\s*$/d')
240 241 if [ "${APT_CACHER_RUNNING}" = "apt-cacher-ng" ] ; then
241 242 APT_PROXY=http://127.0.0.1:3142/
242 243 fi
243 244
244 245 # Setup architecture specific settings
245 246 if [ -n "$SET_ARCH" ] ; then
246 247 # 64-bit configuration
247 248 if [ "$SET_ARCH" = 64 ] ; then
248 249 # General 64-bit depended settings
249 250 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-aarch64-static}
250 251 KERNEL_ARCH=${KERNEL_ARCH:=arm64}
251 252 KERNEL_BIN_IMAGE=${KERNEL_BIN_IMAGE:="Image"}
252 253
253 254 # Raspberry Pi model specific settings
254 255 if [ "$RPI_MODEL" = 3 ] || [ "$RPI_MODEL" = 3P ] ; then
255 256 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-arm64"
256 257 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcmrpi3_defconfig}
257 258 RELEASE_ARCH=${RELEASE_ARCH:=arm64}
258 259 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel8.img}
259 260 CROSS_COMPILE=${CROSS_COMPILE:=aarch64-linux-gnu-}
260 261 else
261 262 echo "error: Only Raspberry PI 3 and 3B+ support 64-bit"
262 263 exit 1
263 264 fi
264 265 fi
265 266
266 267 # 32-bit configuration
267 268 if [ "$SET_ARCH" = 32 ] ; then
268 269 # General 32-bit dependend settings
269 270 QEMU_BINARY=${QEMU_BINARY:=/usr/bin/qemu-arm-static}
270 271 KERNEL_ARCH=${KERNEL_ARCH:=arm}
271 272 KERNEL_BIN_IMAGE=${KERNEL_BIN_IMAGE:="zImage"}
272 273
273 274 # Raspberry Pi model specific settings
274 275 if [ "$RPI_MODEL" = 0 ] || [ "$RPI_MODEL" = 1 ] || [ "$RPI_MODEL" = 1P ] ; then
275 276 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-armel"
276 277 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcmrpi_defconfig}
277 278 RELEASE_ARCH=${RELEASE_ARCH:=armel}
278 279 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel.img}
279 280 CROSS_COMPILE=${CROSS_COMPILE:=arm-linux-gnueabi-}
280 281 fi
281 282
282 283 # Raspberry Pi model specific settings
283 284 if [ "$RPI_MODEL" = 2 ] || [ "$RPI_MODEL" = 3 ] || [ "$RPI_MODEL" = 3P ] ; then
284 285 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} crossbuild-essential-armhf"
285 286 KERNEL_DEFCONFIG=${KERNEL_DEFCONFIG:=bcm2709_defconfig}
286 287 RELEASE_ARCH=${RELEASE_ARCH:=armhf}
287 288 KERNEL_IMAGE=${KERNEL_IMAGE:=kernel7.img}
288 289 CROSS_COMPILE=${CROSS_COMPILE:=arm-linux-gnueabihf-}
289 290 fi
290 291 fi
291 292 # SET_ARCH not set
292 293 else
293 294 echo "error: Please set '32' or '64' as value for SET_ARCH"
294 295 exit 1
295 296 fi
296 297 # Device specific configuration and U-Boot configuration
297 298 case "$RPI_MODEL" in
298 299 0)
299 300 DTB_FILE=${DTB_FILE:=bcm2708-rpi-0-w.dtb}
300 301 UBOOT_CONFIG=${UBOOT_CONFIG:=rpi_defconfig}
301 302 ;;
302 303 1)
303 304 DTB_FILE=${DTB_FILE:=bcm2708-rpi-b.dtb}
304 305 UBOOT_CONFIG=${UBOOT_CONFIG:=rpi_defconfig}
305 306 ;;
306 307 1P)
307 308 DTB_FILE=${DTB_FILE:=bcm2708-rpi-b-plus.dtb}
308 309 UBOOT_CONFIG=${UBOOT_CONFIG:=rpi_defconfig}
309 310 ;;
310 311 2)
311 312 DTB_FILE=${DTB_FILE:=bcm2709-rpi-2-b.dtb}
312 313 UBOOT_CONFIG=${UBOOT_CONFIG:=rpi_2_defconfig}
313 314 ;;
314 315 3)
315 316 DTB_FILE=${DTB_FILE:=bcm2710-rpi-3-b.dtb}
316 317 UBOOT_CONFIG=${UBOOT_CONFIG:=rpi_3_defconfig}
317 318 ;;
318 319 3P)
319 320 DTB_FILE=${DTB_FILE:=bcm2710-rpi-3-b.dtb}
320 321 UBOOT_CONFIG=${UBOOT_CONFIG:=rpi_3_defconfig}
321 322 ;;
322 323 *)
323 324 echo "error: Raspberry Pi model $RPI_MODEL is not supported!"
324 325 exit 1
325 326 ;;
326 327 esac
327 328
328 329 # Raspberry PI 0,3,3P with Bluetooth and Wifi onboard
329 330 if [ "$RPI_MODEL" = 0 ] || [ "$RPI_MODEL" = 3 ] || [ "$RPI_MODEL" = 3P ] ; then
330 331 # Include bluetooth packages on supported boards
331 332 if [ "$ENABLE_BLUETOOTH" = true ] ; then
332 333 APT_INCLUDES="${APT_INCLUDES},bluetooth,bluez"
333 334 fi
334 335 if [ "$ENABLE_WIRELESS" = true ] ; then
335 336 APT_INCLUDES="${APT_INCLUDES},wireless-tools,crda,wireless-regdb"
336 337 fi
337 338 else # Raspberry PI 1,1P,2 without Wifi and bluetooth onboard
338 339 # Check if the internal wireless interface is not supported by the RPi model
339 340 if [ "$ENABLE_WIRELESS" = true ] || [ "$ENABLE_BLUETOOTH" = true ]; then
340 341 echo "error: The selected Raspberry Pi model has no integrated interface for wireless or bluetooth"
341 342 exit 1
342 343 fi
343 344 fi
344 345
345 346 if [ "$BUILD_KERNEL" = false ] && [ "$ENABLE_NEXMON" = true ]; then
346 347 echo "error: You have to compile kernel sources, if you want to enable nexmon"
347 348 exit 1
348 349 fi
349 350
350 351 # Prepare date string for default image file name
351 352 DATE="$(date +%Y-%m-%d)"
352 353 if [ -z "$KERNEL_BRANCH" ] ; then
353 354 IMAGE_NAME=${IMAGE_NAME:=${BASEDIR}/${DATE}-${KERNEL_ARCH}-CURRENT-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}}
354 355 else
355 356 IMAGE_NAME=${IMAGE_NAME:=${BASEDIR}/${DATE}-${KERNEL_ARCH}-${KERNEL_BRANCH}-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}}
356 357 fi
357 358
358 359 # Check if DISABLE_UNDERVOLT_WARNINGS parameter value is supported
359 360 if [ -n "$DISABLE_UNDERVOLT_WARNINGS" ] ; then
360 361 if [ "$DISABLE_UNDERVOLT_WARNINGS" != 1 ] && [ "$DISABLE_UNDERVOLT_WARNINGS" != 2 ] ; then
361 362 echo "error: DISABLE_UNDERVOLT_WARNINGS=${DISABLE_UNDERVOLT_WARNINGS} is not supported"
362 363 exit 1
363 364 fi
364 365 fi
365 366
366 367 # Add cmake to compile videocore sources
367 368 if [ "$ENABLE_VIDEOCORE" = true ] ; then
368 369 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} cmake"
369 370 fi
370 371
371 372 # Add deps for nexmon
372 373 if [ "$ENABLE_NEXMON" = true ] ; then
373 374 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} libgmp3-dev gawk qpdf bison flex make autoconf automake build-essential libtool"
374 375 fi
375 376
376 377 # Add libncurses5 to enable kernel menuconfig
377 378 if [ "$KERNEL_MENUCONFIG" = true ] ; then
378 379 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} libncurses-dev"
379 380 fi
380 381
381 382 # Add ccache compiler cache for (faster) kernel cross (re)compilation
382 383 if [ "$KERNEL_CCACHE" = true ] ; then
383 384 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} ccache"
384 385 fi
385 386
386 387 # Add cryptsetup package to enable filesystem encryption
387 388 if [ "$ENABLE_CRYPTFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
388 389 REQUIRED_PACKAGES="${REQUIRED_PACKAGES} cryptsetup"
389 390 APT_INCLUDES="${APT_INCLUDES},cryptsetup,busybox,console-setup"
390 391
391 392 # If cryptfs,dropbear and initramfs are enabled include dropbear-initramfs package
392 393 if [ "$CRYPTFS_DROPBEAR" = true ] && [ "$ENABLE_INITRAMFS" = true ]; then
393 394 APT_INCLUDES="${APT_INCLUDES},dropbear-initramfs"
394 395 fi
395 396
396 397 if [ -z "$CRYPTFS_PASSWORD" ] ; then
397 398 echo "error: no password defined (CRYPTFS_PASSWORD)!"
398 399 exit 1
399 400 fi
400 401 ENABLE_INITRAMFS=true
401 402 fi
402 403
403 404 # Add initramfs generation tools
404 405 if [ "$ENABLE_INITRAMFS" = true ] && [ "$BUILD_KERNEL" = true ] ; then
405 406 APT_INCLUDES="${APT_INCLUDES},initramfs-tools"
406 407 fi
407 408
408 409 # Add device-tree-compiler required for building the U-Boot bootloader
409 410 if [ "$ENABLE_UBOOT" = true ] ; then
410 411 APT_INCLUDES="${APT_INCLUDES},device-tree-compiler,bison,flex,bc"
411 412 fi
412 413
413 414 if [ "$ENABLE_USBBOOT" = true ] ; then
414 415 if [ "$RPI_MODEL" = 0 ] || [ "$RPI_MODEL" = 1P ] || [ "$RPI_MODEL" = 1 ] || [ "$RPI_MODEL" = 2 ]; then
415 416 echo "error: Booting from USB alone is only supported by Raspberry Pi 3 and 3P"
416 417 exit 1
417 418 fi
418 419 fi
419 420
420 421 # Check if root SSH (v2) public key file exists
421 422 if [ -n "$SSH_ROOT_PUB_KEY" ] ; then
422 423 if [ ! -f "$SSH_ROOT_PUB_KEY" ] ; then
423 424 echo "error: '$SSH_ROOT_PUB_KEY' specified SSH public key file not found (SSH_ROOT_PUB_KEY)!"
424 425 exit 1
425 426 fi
426 427 fi
427 428
428 429 # Check if $USER_NAME SSH (v2) public key file exists
429 430 if [ -n "$SSH_USER_PUB_KEY" ] ; then
430 431 if [ ! -f "$SSH_USER_PUB_KEY" ] ; then
431 432 echo "error: '$SSH_USER_PUB_KEY' specified SSH public key file not found (SSH_USER_PUB_KEY)!"
432 433 exit 1
433 434 fi
434 435 fi
435 436
436 437 if [ "$ENABLE_NEXMON" = true ] && [ -n "$KERNEL_BRANCH" ] ; then
437 438 echo "error: Please unset KERNEL_BRANCH if using ENABLE_NEXMON"
438 439 exit 1
439 440 fi
440 441
441 442 # Check if all required packages are installed on the build system
442 443 for package in $REQUIRED_PACKAGES ; do
443 444 if [ "$(dpkg-query -W -f='${Status}' "$package")" != "install ok installed" ] ; then
444 445 MISSING_PACKAGES="${MISSING_PACKAGES} $package"
445 446 fi
446 447 done
447 448
448 449 # If there are missing packages ask confirmation for install, or exit
449 450 if [ -n "$MISSING_PACKAGES" ] ; then
450 451 echo "the following packages needed by this script are not installed:"
451 452 echo "$MISSING_PACKAGES"
452 453
453 454 printf "\ndo you want to install the missing packages right now? [y/n] "
454 455 read -r confirm
455 456 [ "$confirm" != "y" ] && exit 1
456 457
457 458 # Make sure all missing required packages are installed
458 459 apt-get -qq -y install `echo "${MISSING_PACKAGES}" | sed "s/ //"`
459 460 fi
460 461
461 462 # Check if ./bootstrap.d directory exists
462 463 if [ ! -d "./bootstrap.d/" ] ; then
463 464 echo "error: './bootstrap.d' required directory not found!"
464 465 exit 1
465 466 fi
466 467
467 468 # Check if ./files directory exists
468 469 if [ ! -d "./files/" ] ; then
469 470 echo "error: './files' required directory not found!"
470 471 exit 1
471 472 fi
472 473
473 474 # Check if specified KERNELSRC_DIR directory exists
474 475 if [ -n "$KERNELSRC_DIR" ] && [ ! -d "$KERNELSRC_DIR" ] ; then
475 476 echo "error: '${KERNELSRC_DIR}' specified directory not found (KERNELSRC_DIR)!"
476 477 exit 1
477 478 fi
478 479
479 480 # Check if specified UBOOTSRC_DIR directory exists
480 481 if [ -n "$UBOOTSRC_DIR" ] && [ ! -d "$UBOOTSRC_DIR" ] ; then
481 482 echo "error: '${UBOOTSRC_DIR}' specified directory not found (UBOOTSRC_DIR)!"
482 483 exit 1
483 484 fi
484 485
485 486 # Check if specified VIDEOCORESRC_DIR directory exists
486 487 if [ -n "$VIDEOCORESRC_DIR" ] && [ ! -d "$VIDEOCORESRC_DIR" ] ; then
487 488 echo "error: '${VIDEOCORESRC_DIR}' specified directory not found (VIDEOCORESRC_DIR)!"
488 489 exit 1
489 490 fi
490 491
491 492 # Check if specified FBTURBOSRC_DIR directory exists
492 493 if [ -n "$FBTURBOSRC_DIR" ] && [ ! -d "$FBTURBOSRC_DIR" ] ; then
493 494 echo "error: '${FBTURBOSRC_DIR}' specified directory not found (FBTURBOSRC_DIR)!"
494 495 exit 1
495 496 fi
496 497
497 498 # Check if specified NEXMONSRC_DIR directory exists
498 499 if [ -n "$NEXMONSRC_DIR" ] && [ ! -d "$NEXMONSRC_DIR" ] ; then
499 500 echo "error: '${NEXMONSRC_DIR}' specified directory not found (NEXMONSRC_DIR)!"
500 501 exit 1
501 502 fi
502 503
503 504 # Check if specified CHROOT_SCRIPTS directory exists
504 505 if [ -n "$CHROOT_SCRIPTS" ] && [ ! -d "$CHROOT_SCRIPTS" ] ; then
505 506 echo "error: ${CHROOT_SCRIPTS} specified directory not found (CHROOT_SCRIPTS)!"
506 507 exit 1
507 508 fi
508 509
509 510 # Check if specified device mapping already exists (will be used by cryptsetup)
510 511 if [ -r "/dev/mapping/${CRYPTFS_MAPPING}" ] ; then
511 512 echo "error: mapping /dev/mapping/${CRYPTFS_MAPPING} already exists, not proceeding"
512 513 exit 1
513 514 fi
514 515
515 516 # Don't clobber an old build
516 517 if [ -e "$BUILDDIR" ] ; then
517 518 echo "error: directory ${BUILDDIR} already exists, not proceeding"
518 519 exit 1
519 520 fi
520 521
521 522 # Setup chroot directory
522 523 mkdir -p "${R}"
523 524
524 525 # Check if build directory has enough of free disk space >512MB
525 526 if [ "$(df --output=avail "${BUILDDIR}" | sed "1d")" -le "524288" ] ; then
526 527 echo "error: ${BUILDDIR} not enough space left to generate the output image!"
527 528 exit 1
528 529 fi
529 530
530 531 set -x
531 532
532 533 # Call "cleanup" function on various signals and errors
533 534 trap cleanup 0 1 2 3 6
534 535
535 536 # Add required packages for the minbase installation
536 537 if [ "$ENABLE_MINBASE" = true ] ; then
537 538 APT_INCLUDES="${APT_INCLUDES},vim-tiny,netbase,net-tools,ifupdown"
538 539 fi
539 540
540 541 # Add parted package, required to get partprobe utility
541 542 if [ "$EXPANDROOT" = true ] ; then
542 543 APT_INCLUDES="${APT_INCLUDES},parted"
543 544 fi
544 545
546 # Add dphys-swapfile package, required to enable swap
547 if [ "$ENABLE_DPHYSSWAP" = true ] ; then
548 APT_INCLUDES="${APT_INCLUDES},dphys-swapfile"
549 fi
550
545 551 # Add dbus package, recommended if using systemd
546 552 if [ "$ENABLE_DBUS" = true ] ; then
547 553 APT_INCLUDES="${APT_INCLUDES},dbus"
548 554 fi
549 555
550 556 # Add iptables IPv4/IPv6 package
551 557 if [ "$ENABLE_IPTABLES" = true ] ; then
552 558 APT_INCLUDES="${APT_INCLUDES},iptables,iptables-persistent"
553 559 fi
554 560 # Add apparmor for KERNEL_SECURITY
555 561 if [ "$KERNEL_SECURITY" = true ] ; then
556 562 APT_INCLUDES="${APT_INCLUDES},apparmor,apparmor-utils,apparmor-profiles,apparmor-profiles-extra,libapparmor-perl"
557 563 fi
558 564
559 565 # Add openssh server package
560 566 if [ "$ENABLE_SSHD" = true ] ; then
561 567 APT_INCLUDES="${APT_INCLUDES},openssh-server"
562 568 fi
563 569
564 570 # Add alsa-utils package
565 571 if [ "$ENABLE_SOUND" = true ] ; then
566 572 APT_INCLUDES="${APT_INCLUDES},alsa-utils"
567 573 fi
568 574
569 575 # Add rng-tools package
570 576 if [ "$ENABLE_HWRANDOM" = true ] ; then
571 577 APT_INCLUDES="${APT_INCLUDES},rng-tools"
572 578 fi
573 579
574 580 # Add fbturbo video driver
575 581 if [ "$ENABLE_FBTURBO" = true ] ; then
576 582 # Enable xorg package dependencies
577 583 ENABLE_XORG=true
578 584 fi
579 585
580 586 # Add user defined window manager package
581 587 if [ -n "$ENABLE_WM" ] ; then
582 588 APT_INCLUDES="${APT_INCLUDES},${ENABLE_WM}"
583 589
584 590 # Enable xorg package dependencies
585 591 ENABLE_XORG=true
586 592 fi
587 593
588 594 # Add xorg package
589 595 if [ "$ENABLE_XORG" = true ] ; then
590 596 APT_INCLUDES="${APT_INCLUDES},xorg,dbus-x11"
591 597 fi
592 598
593 599 # Replace selected packages with smaller clones
594 600 if [ "$ENABLE_REDUCE" = true ] ; then
595 601 # Add levee package instead of vim-tiny
596 602 if [ "$REDUCE_VIM" = true ] ; then
597 603 APT_INCLUDES="$(echo ${APT_INCLUDES} | sed "s/vim-tiny/levee/")"
598 604 fi
599 605
600 606 # Add dropbear package instead of openssh-server
601 607 if [ "$REDUCE_SSHD" = true ] ; then
602 608 APT_INCLUDES="$(echo "${APT_INCLUDES}" | sed "s/openssh-server/dropbear/")"
603 609 fi
604 610 fi
605 611
606 612 # Configure systemd-sysv exclude to make halt/reboot/shutdown scripts available
607 613 if [ "$ENABLE_SYSVINIT" = false ] ; then
608 614 APT_EXCLUDES="--exclude=${APT_EXCLUDES},init,systemd-sysv"
609 615 fi
610 616
611 617 # Configure kernel sources if no KERNELSRC_DIR
612 618 if [ "$BUILD_KERNEL" = true ] && [ -z "$KERNELSRC_DIR" ] ; then
613 619 KERNELSRC_CONFIG=true
614 620 fi
615 621
616 622 # Configure reduced kernel
617 623 if [ "$KERNEL_REDUCE" = true ] ; then
618 624 KERNELSRC_CONFIG=false
619 625 fi
620 626
621 627 # Configure qemu compatible kernel
622 628 if [ "$ENABLE_QEMU" = true ] ; then
623 629 DTB_FILE=vexpress-v2p-ca15_a7.dtb
624 630 UBOOT_CONFIG=vexpress_ca15_tc2_defconfig
625 631 KERNEL_DEFCONFIG="vexpress_defconfig"
626 632 if [ "$KERNEL_MENUCONFIG" = false ] ; then
627 633 KERNEL_OLDDEFCONFIG=true
628 634 fi
629 635 fi
630 636
631 637 # Execute bootstrap scripts
632 638 for SCRIPT in bootstrap.d/*.sh; do
633 639 head -n 3 "$SCRIPT"
634 640 . "$SCRIPT"
635 641 done
636 642
637 643 ## Execute custom bootstrap scripts
638 644 if [ -d "custom.d" ] ; then
639 645 for SCRIPT in custom.d/*.sh; do
640 646 . "$SCRIPT"
641 647 done
642 648 fi
643 649
644 650 # Execute custom scripts inside the chroot
645 651 if [ -n "$CHROOT_SCRIPTS" ] && [ -d "$CHROOT_SCRIPTS" ] ; then
646 652 cp -r "${CHROOT_SCRIPTS}" "${R}/chroot_scripts"
647 653 chroot_exec /bin/bash -x <<'EOF'
648 654 for SCRIPT in /chroot_scripts/* ; do
649 655 if [ -f $SCRIPT -a -x $SCRIPT ] ; then
650 656 $SCRIPT
651 657 fi
652 658 done
653 659 EOF
654 660 rm -rf "${R}/chroot_scripts"
655 661 fi
656 662
657 663 # Remove c/c++ build environment from the chroot
658 664 chroot_remove_cc
659 665
660 666 # Generate required machine-id
661 667 MACHINE_ID=$(dbus-uuidgen)
662 668 echo -n "${MACHINE_ID}" > "${R}/var/lib/dbus/machine-id"
663 669 echo -n "${MACHINE_ID}" > "${ETC_DIR}/machine-id"
664 670
665 671 # APT Cleanup
666 672 chroot_exec apt-get -y clean
667 673 chroot_exec apt-get -y autoclean
668 674 chroot_exec apt-get -y autoremove
669 675
670 676 # Unmount mounted filesystems
671 677 umount -l "${R}/proc"
672 678 umount -l "${R}/sys"
673 679
674 680 # Clean up directories
675 681 rm -rf "${R}/run/*"
676 682 rm -rf "${R}/tmp/*"
677 683
678 684 # Clean up APT proxy settings
679 685 if [ "$KEEP_APT_PROXY" = false ] ; then
680 686 rm -f "${ETC_DIR}/apt/apt.conf.d/10proxy"
681 687 fi
682 688
683 689 # Clean up files
684 690 rm -f "${ETC_DIR}/ssh/ssh_host_*"
685 691 rm -f "${ETC_DIR}/dropbear/dropbear_*"
686 692 rm -f "${ETC_DIR}/apt/sources.list.save"
687 693 rm -f "${ETC_DIR}/resolvconf/resolv.conf.d/original"
688 694 rm -f "${ETC_DIR}/*-"
689 695 rm -f "${ETC_DIR}/resolv.conf"
690 696 rm -f "${R}/root/.bash_history"
691 697 rm -f "${R}/var/lib/urandom/random-seed"
692 698 rm -f "${R}/initrd.img"
693 699 rm -f "${R}/vmlinuz"
694 700 rm -f "${R}${QEMU_BINARY}"
695 701
696 702 if [ "$ENABLE_QEMU" = true ] ; then
697 703 # Setup QEMU directory
698 704 mkdir "${BASEDIR}/qemu"
699 705
700 706 # Copy kernel image to QEMU directory
701 707 install_readonly "${BOOT_DIR}/${KERNEL_IMAGE}" "${BASEDIR}/qemu/${KERNEL_IMAGE}"
702 708
703 709 # Copy kernel config to QEMU directory
704 710 install_readonly "${R}/boot/config-${KERNEL_VERSION}" "${BASEDIR}/qemu/config-${KERNEL_VERSION}"
705 711
706 712 # Copy kernel dtbs to QEMU directory
707 713 for dtb in "${BOOT_DIR}/"*.dtb ; do
708 714 if [ -f "${dtb}" ] ; then
709 715 install_readonly "${dtb}" "${BASEDIR}/qemu/"
710 716 fi
711 717 done
712 718
713 719 # Copy kernel overlays to QEMU directory
714 720 if [ -d "${BOOT_DIR}/overlays" ] ; then
715 721 # Setup overlays dtbs directory
716 722 mkdir "${BASEDIR}/qemu/overlays"
717 723
718 724 for dtb in "${BOOT_DIR}/overlays/"*.dtbo ; do
719 725 if [ -f "${dtb}" ] ; then
720 726 install_readonly "${dtb}" "${BASEDIR}/qemu/overlays/"
721 727 fi
722 728 done
723 729 fi
724 730
725 731 # Copy u-boot files to QEMU directory
726 732 if [ "$ENABLE_UBOOT" = true ] ; then
727 733 if [ -f "${BOOT_DIR}/u-boot.bin" ] ; then
728 734 install_readonly "${BOOT_DIR}/u-boot.bin" "${BASEDIR}/qemu/u-boot.bin"
729 735 fi
730 736 if [ -f "${BOOT_DIR}/uboot.mkimage" ] ; then
731 737 install_readonly "${BOOT_DIR}/uboot.mkimage" "${BASEDIR}/qemu/uboot.mkimage"
732 738 fi
733 739 if [ -f "${BOOT_DIR}/boot.scr" ] ; then
734 740 install_readonly "${BOOT_DIR}/boot.scr" "${BASEDIR}/qemu/boot.scr"
735 741 fi
736 742 fi
737 743
738 744 # Copy initramfs to QEMU directory
739 745 if [ -f "${BOOT_DIR}/initramfs-${KERNEL_VERSION}" ] ; then
740 746 install_readonly "${BOOT_DIR}/initramfs-${KERNEL_VERSION}" "${BASEDIR}/qemu/initramfs-${KERNEL_VERSION}"
741 747 fi
742 748 fi
743 749
744 750 # Calculate size of the chroot directory in KB
745 751 CHROOT_SIZE=$(expr "$(du -s "${R}" | awk '{ print $1 }')")
746 752
747 753 # Calculate the amount of needed 512 Byte sectors
748 754 TABLE_SECTORS=$(expr 1 \* 1024 \* 1024 \/ 512)
749 755 FRMW_SECTORS=$(expr 64 \* 1024 \* 1024 \/ 512)
750 756 ROOT_OFFSET=$(expr "${TABLE_SECTORS}" + "${FRMW_SECTORS}")
751 757
752 758 # The root partition is EXT4
753 759 # This means more space than the actual used space of the chroot is used.
754 760 # As overhead for journaling and reserved blocks 35% are added.
755 761 ROOT_SECTORS=$(expr "$(expr "${CHROOT_SIZE}" + "${CHROOT_SIZE}" \/ 100 \* 35)" \* 1024 \/ 512)
756 762
757 763 # Calculate required image size in 512 Byte sectors
758 764 IMAGE_SECTORS=$(expr "${TABLE_SECTORS}" + "${FRMW_SECTORS}" + "${ROOT_SECTORS}")
759 765
760 766 # Prepare image file
761 767 if [ "$ENABLE_SPLITFS" = true ] ; then
762 768 dd if=/dev/zero of="$IMAGE_NAME-frmw.img" bs=512 count="${TABLE_SECTORS}"
763 769 dd if=/dev/zero of="$IMAGE_NAME-frmw.img" bs=512 count=0 seek="${FRMW_SECTORS}"
764 770 dd if=/dev/zero of="$IMAGE_NAME-root.img" bs=512 count="${TABLE_SECTORS}"
765 771 dd if=/dev/zero of="$IMAGE_NAME-root.img" bs=512 count=0 seek="${ROOT_SECTORS}"
766 772
767 773 # Write firmware/boot partition tables
768 774 sfdisk -q -L -uS -f "$IMAGE_NAME-frmw.img" 2> /dev/null <<EOM
769 775 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
770 776 EOM
771 777
772 778 # Write root partition table
773 779 sfdisk -q -L -uS -f "$IMAGE_NAME-root.img" 2> /dev/null <<EOM
774 780 ${TABLE_SECTORS},${ROOT_SECTORS},83
775 781 EOM
776 782
777 783 # Setup temporary loop devices
778 784 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show "$IMAGE_NAME"-frmw.img)"
779 785 ROOT_LOOP="$(losetup -o 1M -f --show "$IMAGE_NAME"-root.img)"
780 786 else # ENABLE_SPLITFS=false
781 787 dd if=/dev/zero of="$IMAGE_NAME.img" bs=512 count="${TABLE_SECTORS}"
782 788 dd if=/dev/zero of="$IMAGE_NAME.img" bs=512 count=0 seek="${IMAGE_SECTORS}"
783 789
784 790 # Write partition table
785 791 sfdisk -q -L -uS -f "$IMAGE_NAME.img" 2> /dev/null <<EOM
786 792 ${TABLE_SECTORS},${FRMW_SECTORS},c,*
787 793 ${ROOT_OFFSET},${ROOT_SECTORS},83
788 794 EOM
789 795
790 796 # Setup temporary loop devices
791 797 FRMW_LOOP="$(losetup -o 1M --sizelimit 64M -f --show "$IMAGE_NAME".img)"
792 798 ROOT_LOOP="$(losetup -o 65M -f --show "$IMAGE_NAME".img)"
793 799 fi
794 800
795 801 if [ "$ENABLE_CRYPTFS" = true ] ; then
796 802 # Create dummy ext4 fs
797 803 mkfs.ext4 "$ROOT_LOOP"
798 804
799 805 # Setup password keyfile
800 806 touch .password
801 807 chmod 600 .password
802 808 echo -n ${CRYPTFS_PASSWORD} > .password
803 809
804 810 # Initialize encrypted partition
805 811 echo "YES" | cryptsetup luksFormat "${ROOT_LOOP}" -c "${CRYPTFS_CIPHER}" -s "${CRYPTFS_XTSKEYSIZE}" .password
806 812
807 813 # Open encrypted partition and setup mapping
808 814 cryptsetup luksOpen "${ROOT_LOOP}" -d .password "${CRYPTFS_MAPPING}"
809 815
810 816 # Secure delete password keyfile
811 817 shred -zu .password
812 818
813 819 # Update temporary loop device
814 820 ROOT_LOOP="/dev/mapper/${CRYPTFS_MAPPING}"
815 821
816 822 # Wipe encrypted partition (encryption cipher is used for randomness)
817 823 dd if=/dev/zero of="${ROOT_LOOP}" bs=512 count="$(blockdev --getsz "${ROOT_LOOP}")"
818 824 fi
819 825
820 826 # Build filesystems
821 827 mkfs.vfat "$FRMW_LOOP"
822 828 mkfs.ext4 "$ROOT_LOOP"
823 829
824 830 # Mount the temporary loop devices
825 831 mkdir -p "$BUILDDIR/mount"
826 832 mount "$ROOT_LOOP" "$BUILDDIR/mount"
827 833
828 834 mkdir -p "$BUILDDIR/mount/boot/firmware"
829 835 mount "$FRMW_LOOP" "$BUILDDIR/mount/boot/firmware"
830 836
831 837 # Copy all files from the chroot to the loop device mount point directory
832 838 rsync -a "${R}/" "$BUILDDIR/mount/"
833 839
834 840 # Unmount all temporary loop devices and mount points
835 841 cleanup
836 842
837 843 # Create block map file(s) of image(s)
838 844 if [ "$ENABLE_SPLITFS" = true ] ; then
839 845 # Create block map files for "bmaptool"
840 846 bmaptool create -o "$IMAGE_NAME-frmw.bmap" "$IMAGE_NAME-frmw.img"
841 847 bmaptool create -o "$IMAGE_NAME-root.bmap" "$IMAGE_NAME-root.img"
842 848
843 849 # Image was successfully created
844 850 echo "$IMAGE_NAME-frmw.img ($(expr \( "${TABLE_SECTORS}" + "${FRMW_SECTORS}" \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
845 851 echo "$IMAGE_NAME-root.img ($(expr \( "${TABLE_SECTORS}" + "${ROOT_SECTORS}" \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
846 852 else
847 853 # Create block map file for "bmaptool"
848 854 bmaptool create -o "$IMAGE_NAME.bmap" "$IMAGE_NAME.img"
849 855
850 856 # Image was successfully created
851 857 echo "$IMAGE_NAME.img ($(expr \( "${TABLE_SECTORS}" + "${FRMW_SECTORS}" + "${ROOT_SECTORS}" \) \* 512 \/ 1024 \/ 1024)M)" ": successfully created"
852 858
853 859 # Create qemu qcow2 image
854 860 if [ "$ENABLE_QEMU" = true ] ; then
855 861 QEMU_IMAGE=${QEMU_IMAGE:=${BASEDIR}/qemu/${DATE}-${KERNEL_ARCH}-CURRENT-rpi${RPI_MODEL}-${RELEASE}-${RELEASE_ARCH}}
856 862 QEMU_SIZE=16G
857 863
858 864 qemu-img convert -f raw -O qcow2 "$IMAGE_NAME".img "$QEMU_IMAGE".qcow2
859 865 qemu-img resize "$QEMU_IMAGE".qcow2 $QEMU_SIZE
860 866
861 867 echo "$QEMU_IMAGE.qcow2 ($QEMU_SIZE)" ": successfully created"
862 868 fi
863 869 fi
General Comments 0
Vous devez vous connecter pour laisser un commentaire. Se connecter maintenant