Diff for /wikisrc/ports/evbarm/raspberry_pi.mdwn between versions 1.47 and 1.91

version 1.47, 2017/03/30 15:53:47 version 1.91, 2018/11/06 13:59:57
Line 2 Line 2
   
 This page attempts to document and coordinate efforts towards NetBSD/evbarm on [Raspberry Pi](http://www.raspberrypi.org). All board variants are supported.  This page attempts to document and coordinate efforts towards NetBSD/evbarm on [Raspberry Pi](http://www.raspberrypi.org). All board variants are supported.
   
 Initial, limited, Raspberry Pi support was introduced in NetBSD 6.0. NetBSD 7.0 adds complete support for the board, along with introducing support for the quad-core Raspberry Pi 2 board.  Initial, limited, Raspberry Pi support was introduced in NetBSD 6.0. NetBSD 7.0 adds complete support for the board, along with introducing support for the quad-core Raspberry Pi 2 board.  Raspberry Pi 3 support was added for NetBSD 8, and backported to NetBSD 7 in July of 2017.  (This page assumes those using NetBSD 7 are using 7.2, or the netbsd-7 branch after mid 2018.)
   
 [[images/raspberrypi.jpg]]  [[images/raspberrypi.jpg]]
   
Line 10  Initial, limited, Raspberry Pi support w Line 10  Initial, limited, Raspberry Pi support w
   
 <small>([Raspberry Pi image](http://www.flickr.com/photos/42325803@N07/8118758647/) by Christopher Lee used under CC-By-2.0 license)</small>  <small>([Raspberry Pi image](http://www.flickr.com/photos/42325803@N07/8118758647/) by Christopher Lee used under CC-By-2.0 license)</small>
   
   # What works (and what doesn't yet)
   
   ## NetBSD 7 and NetBSD 8
   
    - RaspberryPi 1, 2, 3 (except Pi 3 builtin WiFi and bluetooth)
    - multiple processors on 2/3
    - boots normally to multiuser, with FAT32 boot partition on uSD
    - root filesystem can be uSD or USB-attached mass storage
    - serial or graphics console (with EDID query / parsing)
    - X11 via HDMI
    - GPU (VCHIQ) - 3D and video decode. man page missing.
    - USB host controller - dwctwo(4) and most devices work
    - USB Ethernet - usmsc(4)
    - DMA controller driver and sdhc(4) support
    - RNG
    - Audio: works. man page missing.
    - GPIO
    - I²C: works, could use enhancements, man page
    - SPI: could use enhancements, man page
   
   ## NetBSD current
   
    - Raspberry Pi 3 builtin bluetooth
    - Raspberry Pi 3 new SD host controller driver
   
   ## What needs work
   
    - USB (host); isochronous transfers.
    - Raspberry Pi 3 builtin WiFi
   
   # CPU types
   
    - Raspberry Pi 1 uses "earmv6hf".
    - Raspberry Pi 0 uses "\todo".
    - Raspberry Pi 2 uses "earmv7hf".
    - Raspberry Pi 3 uses "earmv7hf".
    - Raspberry Pi 0W uses "\todo".
   
   Note that one can run earmv6hf code on the 2 and 3.  See also
   [[NetBSD/aarch64|aarch64]] for running the Pi 2/3 in 64-bit mode.
   
 # Installation  # Installation
  - The automatic nightly builds  on [nyftp.netbsd.org](http://nyftp.netbsd.org/pub/NetBSD-daily/) provide image files that can be used for installation. The Raspberry Pi and Pi 2 ports will be part of the NetBSD 7 release.  
     - The 'evbarm-earmv6hf/binary/gzimg/' directory contains an rpi.img file that can be used as a single image for both boards.  
     - The 'evbarm-earmv7hf/binary/gzimg/' directory, as of August 6th 2015, contains an armv7.img file that is optimized for Raspberry Pi 2.  
     - The stable build directory will be under netbsd-7/YYYYMMDDHHMMZ/ (for example, http://nyftp.netbsd.org/pub/NetBSD-daily/netbsd-7/201412161700Z/evbarm-earmv6hf/binary/gzimg/)  
     - The HEAD/current directory build will be under HEAD/YYYYMMDDHHMMZ/ (for example, http://nyftp.netbsd.org/pub/NetBSD-daily/netbsd-7/201508062150Z/evbarm-earmv7hf/binary/gzimg/)  
   - You can build your own version of these images using (for example) './build.sh -m evbarm -a earmv6hf -u release', or './build.sh -m evbarm -a earmv7hf -u release'  
    - <i>gunzip and dd</i> this img to your sd card. For example,  
   
            dd if=rpi.img of=/dev/disk1  ## SD card structure
   
  - Using a serial console  The Raspberry Pi looks for firmware and kernel.img on the first FAT32 MBR partition of the uSD card.  A separate kernel (kernel7.img) is used on RPI2 and RPI3.
    - By default the rpi.img is set to use the HDMI output; to change to using a serial console first mount rpi.img (it's a FAT filesystem)  The NetBSD kernel will then find NetBSD MBR partition and within that the root disklabel partition, and use that FFS partition as the root filesystem.
   
            edit cmdline.txt and remove '"console=fb"'  A 2 GB card is the smallest workable size, and the installation image will fit.  After the first boot, the system resizes the NetBSD root partition to fill the card.  Note that swap is after /boot and before /, and not contained in the NetBSD fdisk partition.  However, if you don't try to change the partition structure, this should not cause you any trouble.
   
    - Most (all?) USB-to-TTL serial adapters only connect Tx, Rx and ground, and do not connect any flow control lines. An effect of missing flow control is that you see console output, but cannot type anything. If so, adjust your serial console application's flow control settings to "none".  Note that SD cards generally have limited write tolerance, so you may wish to disable atime updates via the noatime option, as is done by the default installation.
   
       In Kermit, the command is "set flow none".  ## Choosing a version
   
       In minicom, run "minicom -s" and set hardware flow control to "no"  First, decide if you want to install a formal release (7.2 or 8.0), a stable branch build (netbsd-7, netbsd-8), or NetBSD-current.  For people who don't know how to choose among those, 8.0 or netbsd-8 is probably best.
   
  - Growing the root file-system (**not required with NetBSD -current after 2015-04-07, or by NetBSD 7 after 2015-08-06**)  See also "ebijun's image", below, which is NetBSD-current and includes packages.
    - During the partitioning process, do not delete or format the  
      first MSDOS (FAT) partition, as the Raspberry pi firmware is  
      hard coded to boot on the SDCAD / 1st MSDOS partition / Firmware  
      updates and boot loader.  
    - Copy /boot/cmdline.txt to /boot/cmdline.txt.orig  
    - Edit /boot/cmdline.txt and add the '-s' flag to the end of the first line of text to boot into single-user mode.  
    - For the next steps, the root filesystem mustn't be mounted rw. So reboot, and at the prompt to enter the pathname of shell,  
      press return for the default (/bin/sh).  
    - At the # prompt, type  
   
         "disklabel -i ld0" and press return.  ## Getting bits to install
   
    - At the partition> prompt type "A" and press return.  You can either build a release yourself with build.sh, or get one from the NetBSD FTP servers.
   
            Adjust disklabel sector from 4194304 to 62333952 [n]?  Both will provide rpi.img.gz and rpi_inst.img.gz.  Each is an image to be written to a uSD card, and has a FAT32 partition for booting.  In rpi.img.gz, there is also an FFS partition for NetBSD.
            Type "y" and press return.  
   
    - partition> prompt type "a" and press return.  ### Building yourself
   
            Filesystem type prompt, press return to use the current value (4.2BSD).  Getting sources and building a release with build.sh is not special for evbarm.  However, the evbarm port has a very large number of CPU types, compared to i386 and amd64 which have one.  The standard approach is to use -m to define MACHINE and -a to define MACHINE_ARCH.  build.sh supports aliases that can be passed as a MACHINE value, but denote both MACHINE and a MACHINE_ARCH.   The third line uses an alias and is equal to the second in effect, for RPI2/3.
            Start offset prompt, press return to use the current value.  
            Partition size prompt, type "$" and press return to grow the  
            partition to use all available free space.  
   
    - partition> prompt type "W" to save the changes to the disklabel.   - ./build.sh -m evbarm -a earmv6hf -u release
    - ./build.sh -m evbarm -a earmv7hf -u release
    - ./build.sh -m earmv7hf-el -u release
   
            Confirm this choice by typing "y" at the Label disk prompt.  Consider setting RELEASEMACHINEDIR if you wish to build multiple MACHINE_ARCH values on the same system; see build.sh.
            Type "Q" and press return to quit disklabel.  
   
    - At the # prompt (shell), type  ### NetBSD autobuild HTTPS/FTP servers
   
            fsck -fy /dev/rld0a  NetBSD provides nightly builds on [nyftp.netbsd.org](https://nyftp.netbsd.org/pub/NetBSD-daily/).  These are equivalent to building yourself.  The next directory level is the branch being built (netbsd-7, netbsd-8, HEAD, and more), plus optionally things like compiler type.  It is followed by date/time, e.g. "HEAD/201811051650Z"; once a build is complete the symlink "latest" is adjusted to point to it.  The next level is "${MACHINE}-${MACHINE_ARCH}", e.g. "evbarm-earmv7hf", and multiple combinations are provided.
            resize_ffs -y /dev/rld0a  
   
    - This may take a few minutes, be patient!   - The 'evbarm-earmv6hf/binary/gzimg/' directory contains an rpi.img file that will run on any of the RPI boards.
    - The 'evbarm-earmv7hf/binary/gzimg/' directory contains an armv7.img file that uses the armv7 instruction set, and thus can run only on the Raspberry Pi 2/3, but is also faster than rpi.img.
   
            fsck -fy /dev/rld0a  An example URL, arguably the standard approach for beginners, is https://nyftp.netbsd.org/pub/NetBSD-daily/netbsd-8/latest/evbarm-earmv7hf/binary/gzimg/
            mount_msdos /dev/ld0e /boot  
            mv /boot/cmdline.txt.orig /boot/cmdline.txt  
            reboot  
   
     - When the system comes back up, the root file-system will have been expanded to  ## Preparing a uSD card
            fill the SD card.  
   
 # Installation with sshramdisk image  Once you have rpi.img.gz (or rpi_inst), put it on a uSD card using gunzip and dd, for example:
  - You may use the  rpi_inst.img.gz file created by an evbarm build.  
  - Connect Ethernet Cable to RPI.  
  - After starting DHCP client, SSH login to with user "sysinst", and password "netbsd".  
    - Be careful to note the ip address given during DHCP so you don't lose your connection  
    - Also for after the sysinst is done and the system reboots  
  - sysinst started!  
   
 # Updating the firmware   - gunzip rpi.img.gz
    - dd if=rpi.img of=/dev/disk1
   
 You probably don't want to do this. Firmware updates can break things,  ## Console approaches
 and the latest firmware that's been tested is already included in the  
 NetBSD build you installed.  
   
 If you're feeling adventurous (or are the port maintainer), here's what  The standard approach is to use a USB keyboard and an HDMI monitor for installation.
 to test whenever you try new firmware:  
   
 - Audio  ### Serial Console
 - OMXPlayer (and [[!template id=man name="vchiq"]])  
 - Serial/framebuffer console  
 - CPU frequency scaling  
   
 That goes for all of `rpi[0123]`.  By default the rpi.img is set to use the HDMI output.  If you wish to use a serial console, mount the FAT32 partition on another system and edit cmdline.txt and remove '"console=fb"'.
   
 Upstream firmware releases are   - Most (all?) USB-to-TTL serial adapters have wires for Tx, Rx and ground, and not RTS/CTS or other flow control lines.   Thus, your terminal program (or terminal) must be configured to not require flow control; a symptom of misconfiguration is that you see console output, but cannot type anything.  If so, adjust your serial console application's flow control settings to "none".
 [on GitHub](https://github.com/raspberrypi/firmware/releases).  
 Copy all files except `kernel*.img` into `/boot` and reboot.     - In Kermit, the command is "set flow none".
      - In minicom, run "minicom -s" and set hardware flow control to "no".
   
   ### Enabling ssh for installation without any console
   
   If you want to enable ssh with the standard image, so that you can log in over the net without either a serial or HDMI console, you can edit the configuration of a uSD card before booting.   On another computer, mount the ffs partition, place /root/.ssh/authorized_keys, uncomment PermitRootLogin in /etc/ssh/sshd_config, and comment out the rc_configure=NO in /etc/rc.conf.  Besides having to find the IP address (e.g. from DHCP server logs), you will have to wait for the partition resizing and reboot.
   
   ### Installation with sshramdisk image
   
   build.sh (and hence the FTP site) also creates an image 'rpi_inst.img.gz' specifically for installation without HDMI or a serial console, when built for earmv6hf.  Note that this image is much smaller and that you will need to fetch the sets over the network.  To use this method, write that image to a uSD card as above, and then:
   
    - Connect an Ethernet cable from the RPI to a LAN with a DHCP server, and another host you can use for ssh.
    - Power on the RPI, and wait.  Watch the logs on the DHCP server, and find the IP address assigned to the RPI.
    - Use ssh to login to the address you found with user "sysinst", and password "netbsd".
    - When installing, ensure that you enable DHCP and ssh, so that you can log in again after the system is installed.
   
   \todo Verify that the above is accurate and sufficient.
   
   ## Installation via ebijun's image
   
   As an alternative to the standard installation images, Jun Ebihara
   provides an install image for Raspberry Pi that includes packages.  It
   is based on NetBSD-current and is built for earmv6hf, and thus will
   work on Raspberry Pi 1, 2 and 3.  This image is typically updated
   every few weeks.
   
    - [https://github.com/ebijun/NetBSD/blob/master/RPI/RPIimage/Image/README](https://github.com/ebijun/NetBSD/blob/master/RPI/RPIimage/Image/README)
   
   ## Links
   
   The following pages have been published by NetBSD community members.  (Note that some of them are old.)
   
    - https://www.cambus.net/netbsd-on-the-raspberry-pi/
   
   # Maintaining a system
   
   ## vcgencmd
   
   The program vcgencmd, referenced in the boot section,  can be found in pkgsrc/misc/raspberrypi-userland.
   
   ## Updating the kernel
   
 # Updating the kernel  
  - Build a new kernel, e.g. using build.sh. It will tell you where the ELF version of the kernel is, e.g.   - Build a new kernel, e.g. using build.sh. It will tell you where the ELF version of the kernel is, e.g.
   
          ...           ...
Line 113  Copy all files except `kernel*.img` into Line 159  Copy all files except `kernel*.img` into
           /Users/feyrer/work/NetBSD/cvs/src-current/obj.evbarm-Darwin-XXX/sys/arch/evbarm/compile/RPI2/netbsd            /Users/feyrer/work/NetBSD/cvs/src-current/obj.evbarm-Darwin-XXX/sys/arch/evbarm/compile/RPI2/netbsd
          ...           ...
   
  - Besides the "netbsd" kernel in ELF format, there is also a "netbsd.bin" kernel that is in a format that the Raspberry can boot.   - Besides the "netbsd" kernel in ELF format, there is also a "netbsd.img" (for current) or "netbsd.bin" (for 7 and 8) kernel that is in a format that the Raspberry can boot.
  - Depending on your hardware version, copy this either to /boot/kernel.img (old/V1 hardware) or to /boot/kernel7.img (new/V2 hardware)   - Depending on your hardware version, copy this either to /boot/kernel.img (First generation Pi, Pi Zero hardware) or to /boot/kernel7.img (Pi 2, Pi 3 hardware)
  - reboot   - reboot
   
   ## Updating the firmware
   
   A section below describes the process of updating NetBSD's copy of the firmware from upstream, with testing, by NetBSD developers.  This section is about updating a system's firmware from the firmware in a version of NetBSD.
   
   \todo Explain where the firmware is in the source tree, and if it is in the installed system image (such as /usr/mdec).  Explain how to update a system (presumably /boot) from either an installed system's new firmware files, or the source tree.  Explain any particular cautions.
   
   ## Booting
   
   The device boots by finding a file "bootcode.bin".   The primary location is a FAT32 partition on the uSD card, and an additional location is on a USB drive.  See the [upstream documentation on booting](https://www.raspberrypi.org/documentation/hardware/raspberrypi/bootmodes/) and read all the subpages.
   
   The standard approach is to use a uSD card, with a fdisk partition table containing a FAT32 partition marked active, and a NetBSD partition.  The NetBSD partition will then contain a disklabel, pointing to an FFS partition (a), a swap paritiion (b) and the FAT32 boot partition mounted as /boot (e).  The file /boot/cmdline.txt has a line to set the root partition.
   
   One wrinkle in the standard approach is that the disk layout is "boot swap /", but the NetBSD fdisk partition starts at the location of /.   The / partition can hold a disklabel, while swap cannot.   It is normal to have swap after / (and thus within the fdisk partition), but the arrangement used permits growing / on first boot, for the typical case where a larger uSD is used, compared to the minimum image size.
   
   An alternate approach is to have the boot FAT32 partition as above, but to have the entire system including root on an external disk.  This is configured by changing root=ld0a to root=sd0a or root=dk0 (depending on disklabel/GPT).  Besides greater space, part of the point is to avoid writing to the uSD card.
   
   A third approach, workable on the Pi 3 only, is to configure USB host booting (already enableed on the 3+; see the upstream documentation) and have the boot partition also on the external device.  In this case the external device must have an MBR because the hardware's first-stage boot does not have GPT support. In theory the [procedure to program USB host boot mode](https://www.raspberrypi.org/documentation/hardware/raspberrypi/bootmodes/msd.md) will function on a NetBSD system because the programming is done by bootcode.bin.
   \todo Confirm that putting program_usb_boot_mode=1 in config.txt and booting works to program the OTP bit.  Confirm that one can then boot NetBSD from external USB.
   
   \todo Explain USB enumeration and how to ensure that the correct boot and root devices are found if one has e.g. a small SSD for the system and a big disk.
   
 # Wireless Networking  # Wireless Networking
   
   Note that the built-in WiFi in the RPI3 is not yet supported.   USB WiFi interfaces (that work on NetBSD in general) should all work.
   
  - A Realtek 802.11n USB adaptor configures as urtwn(4).   - A Realtek 802.11n USB adaptor configures as urtwn(4).
    - Configure with wpa_supplicant in /etc/rc.conf -     - Configure with wpa_supplicant in /etc/rc.conf -
   
Line 160  $ retroarch-joyconfig -o gamepad.cfg Line 230  $ retroarch-joyconfig -o gamepad.cfg
 $ retroarch --appendconfig gamepad.cfg -L /usr/pkg/lib/libretro/gambatte_libretro.so game.gbc  $ retroarch --appendconfig gamepad.cfg -L /usr/pkg/lib/libretro/gambatte_libretro.so game.gbc
 """]]  """]]
   
 # What works (NetBSD 7.0+)  # Developer notes
  - multi-user boot with root on SD card  
  - serial or graphics console (with EDID query / parsing)  These notes are for people working on improvements to RPI support in NetBSD.
  - DMA controller driver and sdhc(4) support  
  - Audio: works. man page missing.  ## Updating the firmware version in the NetBSD sources
  - I²C: works, could use enhancements, man page  
  - GPIO  (Note that trying new firmware may result in a non-bootable system, so
  - RNG  be prepared to recover the bootable media with another system.)
  - SPI: could use enhancements, man page  
  - GPU (VCHIQ) - 3D and video decode. man page missing.  Upstream firmware releases are
  - USB (host) - dwctwo(4)  [on GitHub](https://github.com/raspberrypi/firmware/releases).
  - USB Ethernet - usmsc(4)  Copy all files except `kernel*.img` into `/boot` and reboot.
  - X windows.  
  - RaspberryPi 2 SMP  New firmware should pass all of the following tests before being committed to NetBSD.
   
   - Audio
   - OMXPlayer (and [[!template id=man name="vchiq"]])
   - Serial/framebuffer console
   - CPU frequency scaling
   
   Tests shoudl be run on all of `rpi[0123]`.
   
 # What needs work  
  - USB (host); isochronous transfers.  

Removed from v.1.47  
changed lines
  Added in v.1.91


CVSweb for NetBSD wikisrc <wikimaster@NetBSD.org> software: FreeBSD-CVSweb