deac/osd-contiki
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

galileo: Add support for containerized build environment

Browse source 
This patch adds a Dockerfile for building a container configured as a
build environment for Intel Galileo boards.  This patch also provides
documentation for using the containerized build environment.  Finally, it
streamlines the instructions for booting Contiki on Galileo and includes
other documentation refinements.
This commit is contained in:
Michael LeMay 2016-07-31 15:14:13 -07:00 committed by Michael LeMay
parent dbb82f2439
commit e50b73c9b1
2 changed files with 88 additions and 27 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

107
platform/galileo/README.md
View file

@ -47,13 +47,59 @@ Standard APIs:
Optional support for protection domains is also implemented and is Optional support for protection domains is also implemented and is
described in cpu/x86/mm/README.md. described in cpu/x86/mm/README.md.
Building Preparation
-------- -----------
Prerequisites on all Ubuntu Linux systems include texinfo and uuid-dev. Prerequisites on all Ubuntu Linux systems include texinfo and uuid-dev.
Additional prerequisites on 64-bit Ubuntu Linux systems include Additional prerequisites on 64-bit Ubuntu Linux systems include
gcc-multilib and g++-multilib. gcc-multilib and g++-multilib.
Docker can optionally be used to prepare an Ubuntu-based, containerized build
environment. This has been tested with Docker installed on Microsoft Windows 10.
If not using a containerized environment, proceed to the "Building" section
below.
Using a Docker-based environment on Windows requires that the repository has
been checked out with Git configured to preserve UNIX-style line endings. This
can be accomplished by changing the 'core.autocrlf' setting prior to cloning
the repository [5]:
```
git config --global core.autocrlf input
```
Note that this is a global setting, so it may affect other Git operations.
The drive containing the repository needs to be shared with Docker containers
for the following steps to work [6]. Note that this is a global setting that
affects other containers that may be present on the host.
Open Microsoft PowerShell and navigate to the base directory of the repository.
Run the following command to create the build environment:
```
docker build -t contiki-galileo-build platform/galileo/bsp/docker
```
This creates a container named 'contiki-galileo-build' based on Ubuntu and
installs development tools in the container.
The build commands shown below can be run within the newly-created container. To
obtain a shell, run the following command in PowerShell from the base directory
of the repository.
```
docker run -t -i -v ${Pwd}:/contiki contiki-galileo-build
```
This command mounts the current directory and its subdirectories at the path
'/contiki' within the container. Changes to those files in the container are
visible to the host and vice versa. However, changes to the container
filesystem are not automatically persisted when the container is stopped.
The containerized build environment does not currently support building the Grub
bootloader nor debugging using the instructions in this document.
See the Docker Overview for more information about working with containers [7].
Building
--------
To build applications for this platform you should first build newlib (in To build applications for this platform you should first build newlib (in
case it wasn't already built). To build newlib you can run the following case it wasn't already built). To build newlib you can run the following
command: command:
@ -98,9 +144,11 @@ the IMRs.
Running Running
------- -------
In order to boot the Contiki image, you will need a multiboot-compliant You will need a multiboot-compliant bootloader to boot Contiki images in that
bootloader. In the bsp directory, we provide a helper script which builds the format. However, this is not needed for booting UEFI images.
Grub bootloader with multiboot support. To build the bootloader, just run the
In the bsp directory, we provide a helper script which builds the Grub
bootloader with multiboot support. To build the bootloader, just run the
following command: following command:
``` ```
$ platform/galileo/bsp/grub/build_grub.sh $ platform/galileo/bsp/grub/build_grub.sh
@ -112,8 +160,18 @@ detailed instructions.
### Prepare SDcard ### Prepare SDcard
The instructions in this section are for a native Linux development environment,
so equivalent operations should be substituted when using some other environment
(e.g. Windows Explorer can be used to perform equivalent operations when using
Docker on Windows as a development environment).
Mount the sdcard in directory /mnt/sdcard. Mount the sdcard in directory /mnt/sdcard.
Create UEFI boot directory:
```
$ mkdir -p /mnt/sdcard/efi/boot
```
#### Approach for Multiboot-compliant ELF Image #### Approach for Multiboot-compliant ELF Image
Copy Contiki binary image to sdcard Copy Contiki binary image to sdcard
@ -123,14 +181,14 @@ $ cp examples/hello-world/hello-world.galileo /mnt/sdcard
Copy grub binary to sdcard Copy grub binary to sdcard
``` ```
$ cp platform/galileo/bsp/grub/bin/grub.efi /mnt/sdcard $ cp platform/galileo/bsp/grub/bin/grub.efi /mnt/sdcard/efi/boot/bootia32.efi
``` ```
#### Approach for UEFI Image #### Approach for UEFI Image
Copy Contiki binary image to sdcard Copy Contiki binary image to sdcard:
``` ```
$ cp examples/hello-world/hello-world.galileo.efi /mnt/sdcard $ cp examples/hello-world/hello-world.galileo.efi /mnt/sdcard/efi/boot/bootia32.efi
``` ```
### Connect to the console output ### Connect to the console output
@ -150,38 +208,27 @@ Press [Enter] to directly boot.
Press [F7] to show boot menu options. Press [F7] to show boot menu options.
``` ```
Press <F7> and select the option "UEFI Internal Shell" within the menu. Waiting for the system to select the default boot device may be sufficient.
However, if this does not boot Contiki or Grub (depending on what is installed
as the UEFI boot image) then perform the following procedure after rebooting
and waiting for the boot message to appear: Press <F7> and select the option
"UEFI Misc Device" within the menu.
#### Boot Multiboot-compliant ELF Image No additional steps should be required to boot a Contiki UEFI image.
Once you have a shell, run the following commands to run grub application: Run the following additional commands to boot a multiboot-compliant image:
```
$ fs0:
$ grub.efi
```
You'll reach the grub shell. Now run the following commands to boot Contiki
image:
``` ```
$ multiboot /hello-world.galileo $ multiboot /hello-world.galileo
$ boot $ boot
``` ```
#### Boot UEFI Image
Once you have a shell, run the following commands to boot Contiki image:
```
$ fs0:
$ hello-world.galileo.efi
```
### Verify that Contiki is Running ### Verify that Contiki is Running
This should boot the Contiki image, resulting in the following messages being This should boot the Contiki image, resulting in the following messages being
sent to the serial console: sent to the serial console:
``` ```
Starting Contiki Starting Contiki
Hello World Hello, world
``` ```
Debugging Debugging
@ -224,3 +271,9 @@ References
[3] https://www.gnu.org/software/grub/manual/multiboot/multiboot.html [3] https://www.gnu.org/software/grub/manual/multiboot/multiboot.html
[4] http://www.uefi.org/ [4] http://www.uefi.org/
[5] https://www.git-scm.com/book/en/v2/Customizing-Git-Git-Configuration
[6] https://docs.docker.com/docker-for-windows/#/shared-drives
[7] https://docs.docker.com/engine/understanding-docker/

8
platform/galileo/bsp/docker/Dockerfile Normal file
View file

@ -0,0 +1,8 @@
FROM ubuntu:16.04
RUN apt-get update \
&& apt-get install -y \
gcc-multilib g++-multilib git make patch texinfo uuid-dev wget \
&& rm -rf /var/lib/apt/lists/*
WORKDIR /contiki
ENV TARGET galileo
CMD ["/bin/bash", "-l"]