Annotation of wikisrc/ports/evbarm/raspberry_pi.mdwn, revision 1.65

1.1       jakllsch    1: [[!meta title="NetBSD/evbarm on Raspberry Pi"]]
                      2: 
1.39      wiki        3: This page attempts to document and coordinate efforts towards NetBSD/evbarm on [Raspberry Pi](http://www.raspberrypi.org). All board variants are supported.
                      4: 
1.50      gdt         5: 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.
1.39      wiki        6: 
1.3       wiki        7: [[images/raspberrypi.jpg]]
                      8: 
1.26      wiki        9: [[!toc levels=2]]
                     10: 
1.14      wiki       11: <small>([Raspberry Pi image](http://www.flickr.com/photos/42325803@N07/8118758647/) by Christopher Lee used under CC-By-2.0 license)</small>
1.3       wiki       12: 
1.54      gdt        13: # What works (and what doesn't yet)
1.53      gdt        14: 
                     15: ## NetBSD 7 before July, 2017
                     16: 
                     17:  - RaspberryPi 1, and 2 (including SMP)
                     18:  - multi-user boot with root on SD card
                     19:  - serial or graphics console (with EDID query / parsing)
                     20:  - DMA controller driver and sdhc(4) support
                     21:  - Audio: works. man page missing.
                     22:  - I²C: works, could use enhancements, man page
                     23:  - GPIO
                     24:  - RNG
                     25:  - SPI: could use enhancements, man page
                     26:  - GPU (VCHIQ) - 3D and video decode. man page missing.
                     27:  - USB (host) - dwctwo(4)
                     28:  - USB Ethernet - usmsc(4)
                     29:  - X windows.
                     30: 
                     31: ## NetBSD 7 after July, 2017 and NetBSD 8
                     32: 
                     33:  - Raspberry Pi 3 (excluding WiFi and bluetooth)
                     34: 
                     35: ## NetBSD current
                     36: 
                     37:  - Raspberry Pi 3 bluetooth
                     38:  - Raspberry Pi 3 new SD host controller driver
                     39: 
1.54      gdt        40: ## What needs work
1.53      gdt        41: 
                     42:  - USB (host); isochronous transfers.
                     43:  - WiFi
1.64      gdt        44:  - Raspberry Pi 3 in 64-bit mode.  (Note that this will be provided by the evbarm64 port, rather than evbarm.)
1.53      gdt        45: 
1.57      gdt        46: # CPU types
                     47: 
                     48: Note that one can also use code for earlier models on later models.
                     49: 
1.59      gdt        50:  - Raspberry Pi 1 uses "earmv6hf".
                     51:  - Raspberry Pi 2 uses "earmv7hf".
1.64      gdt        52:  - Raspberry Pi 3 uses "earmv7hf".
1.57      gdt        53: 
1.7       wiki       54: # Installation
1.53      gdt        55: 
1.62      gdt        56: ## SD card structure
                     57: 
1.65    ! gdt        58: The Raspberry Pi looks for firmware and kernel.img on the first FAT32 partition of the uSD card.  A separate kernel (kernel7.img) is used on RPI2 and RPI3.
1.62      gdt        59: 
1.65    ! gdt        60: The NetBSD kernel will then use the FFS partition as the root filesystem.
        !            61: 
        !            62: A 2 GB card is the smallest workable size.  The NetBSD filesystem will be expanded to fit.
1.63      gdt        63: 
1.62      gdt        64: ## Choosing a version
                     65: 
1.65    ! gdt        66: First, decide if you want to install a formal release (7.1), a stable branch build (netbsd-7, netbsd-8), or NetBSD-current.  Note that 7.1 predates Raspberry Pi 3 support.  For people who don't know how to choose among those, netbsd-8 is probably best.
        !            67: 
        !            68: See also "ebijun's image", below, which is NetBSD-current and includes packages.
1.58      gdt        69: 
                     70: ## Getting bits to install
                     71: 
                     72: You can either build a release yourself with build.sh, or get one from the NetBSD FTP servers.
                     73: 
1.65    ! gdt        74: 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.
1.58      gdt        75: 
                     76: ### Building yourself
                     77: 
1.65    ! gdt        78: Getting sources and building a release with build.sh is not special for evbarm.  Pick a CPU type alias and pass it to build.sh with -m.  Examples (the first two are equivalent):
1.59      gdt        79:  - ./build.sh -m earmv6hf -u release
                     80:  - ./build.sh -m evbarm -a earmv6hf -u release
                     81:  - ./build.sh -m evbarm -a earmv7hf -u release
1.58      gdt        82: 
                     83: ### NetBSD FTP servers
                     84: 
                     85: NetBSD provides nightly builds on [nyftp.netbsd.org](http://nyftp.netbsd.org/pub/NetBSD-daily/).  These are equivalent to building yourself.
                     86: 
1.59      gdt        87:  - The 'evbarm-earmv6hf/binary/gzimg/' directory contains an rpi.img file that can be used as a single image for both boards.
                     88:  - The 'evbarm-earmv7hf/binary/gzimg/' directory contains an armv7.img file that is optimized for Raspberry Pi 2.
                     89:  - The stable build directory will be under netbsd-7/YYYYMMDDHHMMZ/ (for example, http://nyftp.netbsd.org/pub/NetBSD-daily/netbsd-7/201710201440Z/evbarm-earmv6hf/binary/gzimg)    
                     90:  - The not-yet-released stable build directory will be under netbsd-8/YYYYMMDDHHMMZ/ (for example, http://nyftp.netbsd.org/pub/NetBSD-daily/netbsd-8/201710211010Z/evbarm-earmv6hf/binary/gzimg/)
                     91:  - The HEAD/current directory build will be under HEAD/YYYYMMDDHHMMZ/ (for example, http://nyftp.netbsd.org/pub/NetBSD-daily/HEAD/201710202210Z/evbarm-earmv7hf/binary/gzimg/)
1.58      gdt        92: 
1.65    ! gdt        93: ## Preparing a uSD card
1.10      wiki       94: 
1.65    ! gdt        95: Once you have rpi.img.gz (or rpi_inst), put it on a uSD card using gunzip and dd, for example:
1.14      wiki       96: 
1.60      gdt        97:  - gunzip rpi.img.gz
                     98:  - dd if=rpi.i7mg of=/dev/disk1
1.14      wiki       99: 
1.58      gdt       100: ### Serial Console
                    101: 
                    102: By default the rpi.img is set to use the HDMI output.  If you wish to use a serial console, first mount the FAT32 partition and then
                    103: edit cmdline.txt and remove '"console=fb"'.
1.14      wiki      104: 
1.60      gdt       105:  - 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".
1.41      wiki      106: 
1.60      gdt       107:    In Kermit, the command is "set flow none".
1.41      wiki      108: 
1.60      gdt       109:    In minicom, run "minicom -s" and set hardware flow control to "no"
1.41      wiki      110: 
1.65    ! gdt       111: ### Enabling ssh
        !           112: 
        !           113: 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, 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, you will have to wait for the partition resizing and reboot.
        !           114: 
1.58      gdt       115: ### Installation with sshramdisk image
                    116: 
1.65    ! gdt       117: build.sh (and hence the FTP site) also creates an image 'rpi_inst.img.gz' specifically for installation without HDMI or a serial console.  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:
1.53      gdt       118: 
1.61      gdt       119:  - Ensure that you have a lan with a DHCP server.
                    120:  - Connect an Ethernet cable from the RPI to the LAN.
1.19      wiki      121:  - After starting DHCP client, SSH login to with user "sysinst", and password "netbsd".
1.17      wiki      122:    - Be careful to note the ip address given during DHCP so you don't lose your connection
                    123:    - Also for after the sysinst is done and the system reboots
                    124:  - sysinst started!
1.16      wiki      125: 
1.55      gdt       126: ## Installation via ebijun's image
                    127: 
1.58      gdt       128: As an alternative to the standard installation images, Jun Ebihara
                    129: provides an install image for Raspberry Pi that includes packages.  It
                    130: is based on NetBSD-current and is built for earmv6hf, and thus will
                    131: work on Raspberry Pi 1, 2 and 3.  This image is typically updated
                    132: every few weeks.
1.55      gdt       133: 
1.56      gdt       134:  - [https://github.com/ebijun/NetBSD/blob/master/RPI/RPIimage/Image/README](https://github.com/ebijun/NetBSD/blob/master/RPI/RPIimage/Image/README)
1.55      gdt       135: 
1.53      gdt       136: ## Updating the kernel
1.46      schmonz   137: 
1.42      wiki      138:  - Build a new kernel, e.g. using build.sh. It will tell you where the ELF version of the kernel is, e.g.
                    139: 
                    140:          ...
                    141:          Kernels built from RPI2:
                    142:           /Users/feyrer/work/NetBSD/cvs/src-current/obj.evbarm-Darwin-XXX/sys/arch/evbarm/compile/RPI2/netbsd
                    143:          ...
                    144: 
1.47      sevan     145:  - Besides the "netbsd" kernel in ELF format, there is also a "netbsd.bin" kernel that is in a format that the Raspberry can boot.
1.48      sevan     146:  - 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)
1.42      wiki      147:  - reboot
                    148: 
1.24      wiki      149: # Wireless Networking
1.53      gdt       150: 
                    151:   Note that the built-in WiFi in the RPI3 is not yet supported.
                    152: 
1.24      wiki      153:  - A Realtek 802.11n USB adaptor configures as urtwn(4).
1.25      wiki      154:    - Configure with wpa_supplicant in /etc/rc.conf -
1.24      wiki      155: 
                    156:            ifconfig_urtwn0=dhcp
                    157:            dhcpcd=YES
                    158:            dhcpcd_flags="-q -b"
                    159:            wpa_supplicant=YES
                    160:            wpa_supplicant_flags="-B -i urtwn0 -c /etc/wpa_supplicant.conf"
1.25      wiki      161:    - A sample wpa_supplicant.conf can be found at /usr/share/examples/wpa_supplicant/wpa_supplicant.conf
1.24      wiki      162: 
1.27      wiki      163: # GPU
                    164: 
                    165: ## Video playback
1.29      wiki      166: Accelerated video playback is supported in NetBSD 7 with the [OMXPlayer](http://pkgsrc.se/multimedia/omxplayer) application and through GStreamer with the [omx](http://pkgsrc.se/multimedia/gst-plugins1-omx) plugin.
1.27      wiki      167: 
                    168: ## OpenGL ES
                    169: Accelerated OpenGL ES is supported in NetBSD 7. The GL ES client libraries are included with the [misc/raspberrypi-userland](http://pkgsrc.se/misc/raspberrypi-userland) package.
                    170: 
1.28      wiki      171: ## Quake 3
1.27      wiki      172: A Raspberry Pi optimized build of *ioquake3* is available in the [games/ioquake3-raspberrypi](http://pkgsrc.se/games/ioquake3-raspberrypi) package. To use it, the following additional resources are required:
                    173: 
                    174:  - pak0.pk3 from Quake 3 CD
1.31      snj       175:  - additional pak files from the [games/ioquake3-pk3](http://pkgsrc.se/games/ioquake3-pk3) package
1.27      wiki      176:  - read/write permissions on /dev/vchiq and /dev/wsmouse
                    177: 
1.31      snj       178: Place the pak0.pk3 file in the /usr/pkg/lib/ioquake3/baseq3 directory.
1.27      wiki      179: 
1.32      wiki      180: ## RetroArch / Libretro
                    181: Using [emulators/retroarch](http://pkgsrc.se/emulators/retroarch) it is possible to run many emulators at full speed the Raspberry Pi. Emulator cores for various gaming consoles are available in the [emulators/libretro-*](http://pkgsrc.se/search.php?so=libretro-) packages. To begin using retroarch:
                    182: 
                    183:  - Install [emulators/retroarch](http://pkgsrc.se/emulators/retroarch)
                    184:  - Install the libretro core for the system you would like to emulate (lets take [emulators/libretro-gambatte](http://pkgsrc.se/emulators/libretro-gambatte), a GameBoy Color emulator, as an example).
                    185:  - Plug in a USB HID compatible Gamepad, such as the Logitech F710 in "DirectInput" mode (set "D/X" switch to "D").
                    186:  - Create a config file for your gamepad using *retroarch-joyconfig*.
                    187: [[!template  id=programlisting text="""
1.35      wiki      188: $ retroarch-joyconfig -o gamepad.cfg
1.32      wiki      189: """]]
                    190:  - Launch the emulator from the command-line (no X required):
                    191: [[!template  id=programlisting text="""
                    192: $ retroarch --appendconfig gamepad.cfg -L /usr/pkg/lib/libretro/gambatte_libretro.so game.gbc
                    193: """]]
                    194: 
1.53      gdt       195: # Developer notes
1.50      gdt       196: 
1.53      gdt       197: These notes are for people working on improvements to RPI support in NetBSD.
1.50      gdt       198: 
1.53      gdt       199: ## Updating the firmware
1.50      gdt       200: 
1.53      gdt       201: You probably don't want to do this. Firmware updates can break things,
                    202: and the latest firmware that's been tested is already included in the
                    203: NetBSD build you installed.
1.50      gdt       204: 
1.53      gdt       205: If you're feeling adventurous (or are the port maintainer), here's what
                    206: to test whenever you try new firmware:
1.50      gdt       207: 
1.53      gdt       208: - Audio
                    209: - OMXPlayer (and [[!template id=man name="vchiq"]])
                    210: - Serial/framebuffer console
                    211: - CPU frequency scaling
1.50      gdt       212: 
1.53      gdt       213: That goes for all of `rpi[0123]`.
1.1       jakllsch  214: 
1.53      gdt       215: Upstream firmware releases are
                    216: [on GitHub](https://github.com/raspberrypi/firmware/releases).
                    217: Copy all files except `kernel*.img` into `/boot` and reboot.

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