File:  [NetBSD Developer Wiki] / wikisrc / ports / evbarm / raspberry_pi.mdwn
Revision 1.64: download - view: text, annotated - select for diffs
Sun Oct 22 16:25:18 2017 UTC (3 years, 11 months ago) by gdt
Branches: MAIN
CVS tags: HEAD
Explain 64-bit RPI3 support future location

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

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