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

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
                     44: 
1.57      gdt        45: # CPU types
                     46: 
                     47: Note that one can also use code for earlier models on later models.
                     48: 
1.59      gdt        49:  - Raspberry Pi 1 uses "earmv6hf".
                     50:  - Raspberry Pi 2 uses "earmv7hf".
                     51:  - Raspberry Pi 3 uses "earmv7hf".  (NetBSD does not yet have 64-bit support.)
1.57      gdt        52: 
1.7       wiki       53: # Installation
1.53      gdt        54: 
1.58      gdt        55: First, decide if you want to install a formal release (7.1), a stable
                     56: branch build (netbsd-7, netbsd-8), or current.  Note that 7.1 predates
                     57: Raspberry Pi 3 support.  For people who don't know how to choose among
                     58: those, netbsd-8 is probably best.
                     59: 
                     60: ## Getting bits to install
                     61: 
                     62: You can either build a release yourself with build.sh, or get one from the NetBSD FTP servers.
                     63: 
                     64: Both will provide rpi.img.gz and rpi_inst.img.gz.  Each is an image to
                     65: be written to a uSD card, and it has a FAT32 partition for booting and
                     66: an FFS partition for NetBSD.
                     67: 
                     68: ### Building yourself
                     69: 
                     70: Getting sources and building a release with build.sh is not special for evbarm.
                     71: Pick a CPU type alias and pass it to build.sh with -m.  Examples:
1.59      gdt        72:  - ./build.sh -m earmv6hf -u release
                     73:  - ./build.sh -m evbarm -a earmv6hf -u release
                     74:  - ./build.sh -m evbarm -a earmv7hf -u release
1.58      gdt        75: 
                     76: ### NetBSD FTP servers
                     77: 
                     78: NetBSD provides nightly builds on [nyftp.netbsd.org](http://nyftp.netbsd.org/pub/NetBSD-daily/).  These are equivalent to building yourself.
                     79: 
1.59      gdt        80:  - The 'evbarm-earmv6hf/binary/gzimg/' directory contains an rpi.img file that can be used as a single image for both boards.
                     81:  - The 'evbarm-earmv7hf/binary/gzimg/' directory contains an armv7.img file that is optimized for Raspberry Pi 2.
                     82:  - 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)    
                     83:  - 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/)
                     84:  - 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        85: 
                     86: ## Installing to uSD
1.10      wiki       87: 
1.61    ! gdt        88: Once you have rpi.img.gz, put it on a uSD card using gunzip and dd, for example:
1.14      wiki       89: 
1.60      gdt        90:  - gunzip rpi.img.gz
                     91:  - dd if=rpi.i7mg of=/dev/disk1
1.14      wiki       92: 
1.58      gdt        93: ### Serial Console
                     94: 
                     95: 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
                     96: edit cmdline.txt and remove '"console=fb"'.
1.14      wiki       97: 
1.60      gdt        98:  - 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       99: 
1.60      gdt       100:    In Kermit, the command is "set flow none".
1.41      wiki      101: 
1.60      gdt       102:    In minicom, run "minicom -s" and set hardware flow control to "no"
1.41      wiki      103: 
1.58      gdt       104: ### Installation with sshramdisk image
                    105: 
                    106: build.sh (and hence the FTP site) also creates an image 'rpi_inst.img.gz' specifically for installation without HDMI or a serial console.  To use this method, write that image to a uSD card as above, and then:
1.53      gdt       107: 
1.61    ! gdt       108:  - Ensure that you have a lan with a DHCP server.
        !           109:  - Connect an Ethernet cable from the RPI to the LAN.
1.19      wiki      110:  - After starting DHCP client, SSH login to with user "sysinst", and password "netbsd".
1.17      wiki      111:    - Be careful to note the ip address given during DHCP so you don't lose your connection
                    112:    - Also for after the sysinst is done and the system reboots
                    113:  - sysinst started!
1.16      wiki      114: 
1.55      gdt       115: ## Installation via ebijun's image
                    116: 
1.58      gdt       117: As an alternative to the standard installation images, Jun Ebihara
                    118: provides an install image for Raspberry Pi that includes packages.  It
                    119: is based on NetBSD-current and is built for earmv6hf, and thus will
                    120: work on Raspberry Pi 1, 2 and 3.  This image is typically updated
                    121: every few weeks.
1.55      gdt       122: 
1.56      gdt       123:  - [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       124: 
1.53      gdt       125: ## Updating the kernel
1.46      schmonz   126: 
1.42      wiki      127:  - Build a new kernel, e.g. using build.sh. It will tell you where the ELF version of the kernel is, e.g.
                    128: 
                    129:          ...
                    130:          Kernels built from RPI2:
                    131:           /Users/feyrer/work/NetBSD/cvs/src-current/obj.evbarm-Darwin-XXX/sys/arch/evbarm/compile/RPI2/netbsd
                    132:          ...
                    133: 
1.47      sevan     134:  - 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     135:  - 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      136:  - reboot
                    137: 
1.24      wiki      138: # Wireless Networking
1.53      gdt       139: 
                    140:   Note that the built-in WiFi in the RPI3 is not yet supported.
                    141: 
1.24      wiki      142:  - A Realtek 802.11n USB adaptor configures as urtwn(4).
1.25      wiki      143:    - Configure with wpa_supplicant in /etc/rc.conf -
1.24      wiki      144: 
                    145:            ifconfig_urtwn0=dhcp
                    146:            dhcpcd=YES
                    147:            dhcpcd_flags="-q -b"
                    148:            wpa_supplicant=YES
                    149:            wpa_supplicant_flags="-B -i urtwn0 -c /etc/wpa_supplicant.conf"
1.25      wiki      150:    - A sample wpa_supplicant.conf can be found at /usr/share/examples/wpa_supplicant/wpa_supplicant.conf
1.24      wiki      151: 
1.27      wiki      152: # GPU
                    153: 
                    154: ## Video playback
1.29      wiki      155: 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      156: 
                    157: ## OpenGL ES
                    158: 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.
                    159: 
1.28      wiki      160: ## Quake 3
1.27      wiki      161: 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:
                    162: 
                    163:  - pak0.pk3 from Quake 3 CD
1.31      snj       164:  - additional pak files from the [games/ioquake3-pk3](http://pkgsrc.se/games/ioquake3-pk3) package
1.27      wiki      165:  - read/write permissions on /dev/vchiq and /dev/wsmouse
                    166: 
1.31      snj       167: Place the pak0.pk3 file in the /usr/pkg/lib/ioquake3/baseq3 directory.
1.27      wiki      168: 
1.32      wiki      169: ## RetroArch / Libretro
                    170: 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:
                    171: 
                    172:  - Install [emulators/retroarch](http://pkgsrc.se/emulators/retroarch)
                    173:  - 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).
                    174:  - Plug in a USB HID compatible Gamepad, such as the Logitech F710 in "DirectInput" mode (set "D/X" switch to "D").
                    175:  - Create a config file for your gamepad using *retroarch-joyconfig*.
                    176: [[!template  id=programlisting text="""
1.35      wiki      177: $ retroarch-joyconfig -o gamepad.cfg
1.32      wiki      178: """]]
                    179:  - Launch the emulator from the command-line (no X required):
                    180: [[!template  id=programlisting text="""
                    181: $ retroarch --appendconfig gamepad.cfg -L /usr/pkg/lib/libretro/gambatte_libretro.so game.gbc
                    182: """]]
                    183: 
1.53      gdt       184: # Developer notes
1.50      gdt       185: 
1.53      gdt       186: These notes are for people working on improvements to RPI support in NetBSD.
1.50      gdt       187: 
1.53      gdt       188: ## Updating the firmware
1.50      gdt       189: 
1.53      gdt       190: You probably don't want to do this. Firmware updates can break things,
                    191: and the latest firmware that's been tested is already included in the
                    192: NetBSD build you installed.
1.50      gdt       193: 
1.53      gdt       194: If you're feeling adventurous (or are the port maintainer), here's what
                    195: to test whenever you try new firmware:
1.50      gdt       196: 
1.53      gdt       197: - Audio
                    198: - OMXPlayer (and [[!template id=man name="vchiq"]])
                    199: - Serial/framebuffer console
                    200: - CPU frequency scaling
1.50      gdt       201: 
1.53      gdt       202: That goes for all of `rpi[0123]`.
1.1       jakllsch  203: 
1.53      gdt       204: Upstream firmware releases are
                    205: [on GitHub](https://github.com/raspberrypi/firmware/releases).
                    206: Copy all files except `kernel*.img` into `/boot` and reboot.

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