BeagleBoard/GSoC/Ideas-2016

=Welcome!= BeagleBoard.org hopes to be accepted as a mentoring organization in the Google Summer of Code for 2015! Below, we've collected project ideas for the GSoC-2015.

Background
BeagleBoard.org is a volunteer organization that seeks to advance the state of open-source software on open-source hardware platforms capable of running high-level languages and operating systems (primarily Linux) in embedded environments. Born from taking mobile phone processors and putting them on low-cost boards to build affordable desktop computers, BeagleBoard.org has evolved to focus on the needs of the "maker" community with greater focus on the I/O needed for controlling motors and reading sensors to build things like robots, 3d printers, flying drones, in-car computer systems and much more. Past BeagleBoard.org GSoC projects included creating an interpreter for tiny CPUs, adding SPI and sensor support to Python, an HTML and git based tutorial sharing environment, porting autopilot software to Linux, an open source 100MHz 14-channel logic analyzer, using Android tablets as Linux displays, putting ADC support in Linux under the IIO framework, using Android phones as a network boot source, Running Arduino code on Linux, Robot Operating System support within the Yocto Project build system, Minix I2C support, an RPC framework for heterogeneous processor communication, a transparent USB packet sniffer, ARM optimizations for XBMC, ARM optimizations for FFTs, make-shift pulse-width-modulation and RPC optimizations for OpenCV. BeagleBoard.org has benefited from sponsorship from Texas Instruments, CircuitCo, Digi-Key, element14 and others, but avoids any dependence on that sponsorship for sustaining the effort. The project has evolved over the past few years with over 500,000 boards in circulation with developers worldwide and strong roots in the Linaro, Yocto Project, Angstrom Distribution, Debian and Linux communities---and support for running most major Linux distributions including Ubuntu, Android, Fedora, ArchLinux, Gentoo, Buildroot and many more.

BeagleBoard was inspiration for Raspberry Pi and is available for about $50 through over 30 distributors world-wide (and is even available at Microcenter and Radio Shack in the USA), but is more than a throw-away computer. It is an instance of true open hardware, exposing users to the broader world of electronics, demystifying computers and fostering an environment of clones that have changed the industry for good.

Students will be expected to demonstrate an understanding of cross-compiling before being accepted, but support for demonstration is available through the IRC channel that typically has approximately 150 online chatters logged on at any time, most with sufficient experience to explain the process.

' Every accepted student will be sent a BeagleBone Black before the first week of coding for testing their project. '

Additional hardware will be provided depending on need and value.

For more information, check out http://beagleboard.org and http://beagleboard.org/brief.

Students looking for ideas
Student proposals can encompass projects inspired from the following list of ideas or can include personal project ideas. Previous Google Summer of Code projects show that the key to success is being passionate about your project, so propose something that is extremely interesting to you, even if it is not on this list. We will be glad to help students develop ideas into projects via the BeagleBoard GSoC IRC or the BeagleBoard-GSoC mailing list. There are many potential project ideas and we will match students to projects based on their interests and help scope the proposals to something that can be completed in the Summer of Code timeframe.

There are more than 500 existing projects listed at http://beagleboard.org/project. If you are interested in any of the projects listed on the BeagleBoard.org projects page, contact the project members to see if there are any aspects of their projects that can be enhanced to create a GSoC project. There are also several ideas on the ECE497 class project idea list. You can also check out last year's idea page.

Mentors wondering where to help
Please start by registering your ideas for student projects below by following the template provided with the existing ideas. Furthermore, scroll down to the bottom and give everyone a bit of information about your expertise and availability by adding yourself to the table. Jason will make final approvals for mentor assignments based on if we first get accepted as a mentoring organization and best matching mentor skill sets with student project ideas deemed valuable to the community.

You will also need to register on Melange and request to be a mentor for BeagleBoard.org.

General requirements
All projects have the following basic requirements:
 * 1) Once accepted, the project must be registered on http://beagleboard.org/project.
 * 2) All newly generated materials must be released under an open source license.
 * 3) Individual students shall retain copyright on their works.
 * 4) Source code generated during the project must be released on github.com (to be cloned to github.com/beagleboard on successful completion).
 * 5) The registration on http://beagleboard.org/project must include an RSS feed with project announcements and updates at every milestone.  Sources for the RSS feed should be blogger.com, wordpress.com, or some other established blog-hosting service with known reliability.
 * 6) To help you to break your project down into manageable chunks and also to help the project's mentors to better support your efforts, weekly project status reports should be e-mailed to the project's mentors and the organization administrator (Jason Kridner). Each status report should outline:
 * 7) what was accomplished that week,
 * 8) any issues that prevented that week's goals from being completed and
 * 9) your goals for the next week.
 * 10) Students will provide two recorded audio/video presentations uploaded to youtube or vimeo (screencasts are appropriate), one near the beginning of the project summarizing their project goals and another in the wrap-up phase to summarize their accomplishments.  Examples can be found on http://beagleboard.org/gsoc.
 * 11) Students will demonstrate their ability to cross-compile and utilize version control software by creating a "Hello World" application and generating a pull request to https://github.com/jadonk/gsoc-application/tree/master/ExampleEntryJasonKridner.  For assistance, please visit http://beagleboard.org/chat or utilize the beagleboard-gsoc Google Group.  The "Hello World" application must print your name and the date out in an ARM Linux environment.  Freely available emulators may be used to test your application or you can ask anyone on the chat or mailing list to help you test.
 * 12) All projects will produce reusable software components and will not be "what–I-built-over-my-summer-vacation" projects. Including a hardware component is welcome, but the project *deliverable* will be software that may be utilized by a wide audience of the BeagleBoard.org community.

=Ideas=

Linux kernel support for embedded devices and interfaces
Improving the state of the Linux kernel, especially with regards to embedded devices and interfaces. Includes improved ARM/OMAP/Sitara platform support, simplifying the development of add-on hardware for embedded systems and exchanging hardware connectivity information with userspace.

BeagleRT: Real-Time Linux with the BeagleBone Black
Assessment of the real-time limitations and capabilities with the BeagleBone Black.


 * vanilla kernel
 * vanilla with PREEMPT option
 * PREEMPT_RT patches
 * Xenomai patches
 * PRUSS

Goal: Many applications require a certain degree of real-time response. This project will analyze, test and compare the different approaches for providing Real-Time responses with the BeagleBone Black development board. Hardware Skills: PRU, PPM, PWM, PRUSS Software Skills: C, C++, Python, Assembly Possible Mentors: Víctor Mayoral Vilches, Siddharth Bharat Purohit Workload: 1 student full time. GitHub: https://github.com/BeagleRT/BeagleRT References: https://www.osadl.org/fileadmin/dam/rtlws/12/Brown.pdf

Upstreaming Beagleboard.org Kernel Patches
The BeagleBone currently relies on a number of out-of-tree kernel patches in order to boot. These patches are maintained by Koen Kooi (CircuitCo) and come from many sources, including TI employees and various mailing lists. Getting more of these patches upstream would make it easier to boot a BeagleBone and also make use of a BeagleBone easier for users and kernel developers who need to track upstream kernel changes, or who otherwise need to be closer to the bleeding edge of Linux kernel development. The current patch set is maintained at github and contains scripts to easily patch an upstream kernel. The scripts in this repository are used to build the BeagleBoard.org kernels which ship with the Angstrom SD card images.

Goal: Push as many patches as possible to Linus's mainline kernel tree via the appropriate staging kernels for the subsystems involved. Existing Project: The Mainline Linux Kernel, patches needing to be pushed Hardware Skills: Able to read schematics, understand basic digital logic and monitor logic-level digital signals. Software Skills: Able to write software in C, create patches to the Linux kernel and perform cross-compilation and testing. Possible mentors: Matt Porter, Matt Ranostay, Koen Kooi, Alan Ott

IIO debugging tools
Quick background: IIO is the new way of doing sensors but being a newer interface, it lacks tools for debugging. This project is to produce sometools to debug drivers. There are several ways this project can happen: 1. We can implement userland tools that read IIO data similar to the evtest tool. 2. We can implement a event handler for the IIO driver. This way existing tools and code can be used. There was references from another mailing list (probally LKML) talking about this.

Goal: Userspace application similar to evtest that captures debug events and instrumented IIO driver code to produce those events. Existing Project: patched kernel with IIO driver Hardware Skills: None. Software Skills:C coding (1), (2) requires kernel coding Possible mentors: Hunyue Yau

MMC and DMA Linux performance
Improving performance of MMC driver by understanding issues, improving MMC, DMA drivers and eliminating bottlenecks.

Goal: Both MMC and DMA are critical to high performance of I/O intensive workloads on a Beagleboard/ARM platform, even fast system boot up depends on it.

A good amount of performance improvement is possible just by identifying what's going on in hot paths and how things can be done more simply, without breaking anything else. Also improvements are possible using innovative techniques such as intelligent buffer allocation and reducing overhead where possible in dependent components such as DMA. Cutting the fat in hot paths is definitely a start.

Existing Project: Upstream Kernel Hardware Skills: Yes Software Skills: C, Possible use of JTAG, ftrace, perf etc. Possible mentors: Joel Fernandes

Enhance ADC driver for BeagleBone and BeagleBone Black
Improve the onboard ADC to support more features provided by the hardware. The hardware supports things like periodic sampling and averaging along with the ability to schedule the different channels and allow them to be configured differently.

Goal: The Beagleboard.org community lacks a common unified way of accessing the different features available on the ADC. Some of these hacks such as attempts at periodic sampling squaders hardware resources on the BeagleBone when in reality the ADC block can do it directly. The goal is to create a drive with a plan to upstream that will expose these additional features. It should try to coordinate with the current driver maintainer. The coordination and upstreaming parts needs to be weighed and considered due to the limited GSoC time frame.

Existing Project: Hardware Skills: Yes Software Skills: C Possible mentors: Hunyue Yau (others welcome to volunteer)

ARM processor support in open source operating systems and libraries
Optimizations to applications and libraries like XBMC to make them run better on resource constrained environments or to take advantage of more specialized processing elements.

Library of Arduino-compatible functions for StarterWare
This would be an implementation of Arduino utilizing the BeagleBone Black and the StarterWare O/S independent library for accessing the hardware. Without having to access the hardware through an operating system, developers will be able to fine-tune the system to achieve optimal resource management of the CPU, peripherals and memory. The project would also include basic documentation and generation of code samples for various functionality of the library, such as SPI,Serial,Ethernet for starters. This would make the project thorough and ready for use by various developers in the community. Goal: Utilize the Energia fork of Arduino to push support for BeagleBone and BeagleBone Black Existing Project: Energia, StarterWare Hardware Skills: Yes Software Skills: C/C++ Possible mentors: Jason Kridner (others can be referred if there are interested students)

Heterogeneous co-processor support in open source operating systems and libraries
Enabling usage of DSPs, PRUs, FPGAs, Cortex-M3s, Arduinos, MSP430 launchpads and other attached processing platforms.

PRU Bridge
The aim of the project is to create a multi channel userspace Linux to PRU bridge (driver). Developers should be able to send and receive data seamlessly from the ARM or PRU. On the Linux side each channel will be represented by a file, and writing to a channel is a simple file write operation. Similarly if the client program on Linux want to read, it will read the file corresponding to the channel. On the PRU side, there will be a event loop listening to any events on any channels. If there is valid data on any channel, the corresponding callback is called.

Currently the widely used libprussdrv supports exporting of 'interrupts' via sysfs, but no clean way of data transfer. The PRU-bridge will be a remote proc based sysfs driver. Channels here are generic, will enable export of data and interrupts to userspace. [Each channel could carry it's own semantic meaning, completely upto the developer].

Internally the kernel driver will maintain a shared memory circular buffer for each channel, and read or write on a sysfs file will result in an "upcall-downcall" action (a method in which the kernel and PRU interact). Different channels could be specialized for different requirements (i.e. one channel could be fine tuned for block transfers, another for a stream interface).

This project will also require the student to develop a Node.js/Python based API to communicate with the PRU. Another interesting add on would be if the driver supported dynamic pin-muxing when prompted by the PRU. (i.e. can the PRU tell the kernel to enable h/w PWM on particular pins (instead of GPIO)?) Having a standardized driver like this will eliminate the need for writing separate drivers as in the case of applications like pruspeak.

Goal: Develop a driver to enable a robust communication channels b/w Linux userspace and PRU. Existing project: small writeup available at pru_serial_doc and high level python API RPC example Hardware skills: Knowledge of Linux system programming, basic understanding of Device Driver, PRU architecture. Software skills: Good knowledge of C, working knowledge of Python/Node.js Possible mentors: Deepak Karki, Alexander Hiam

PRUSS Support for the newer kernels
Until now, libprussdrv has been the first point of contact for a prospective user of the Programmable Real-Time Units present on the BeagleBone Black. However in GSoC 2014 the two projects targeting the PRUs - BeagleLogic and BotSpeak worked on the remoteproc framework of the Linux kernel for the PRUs which was found to give better results.

However, not everyone should need to hack the kernel and the drivers for buiding their projects and as such a proper lightweight message passing framework and firmware loading infrastructure would increase the utility of the PRUs that are on board the BeagleBone (Black).

Possible design goals of the new framework:


 * Upstreaming The idea is to have support for the PRU in the mainline kernel and not in another "vendor" kernel. Thus the entire framework has to be written keeping the Kernel coding guidelines so that the patch will be ready for submission to the LKML soon by the end of the coding period.


 * Simple and easy-to-use API Need to generate examples, documentation and keep the API as simple and straightforward as possible. There is no point in having yet another PRU framework if no one is using it.


 * Language-Agnostic Whether one swears by C, uses Python or is a JavaScript programmer, everyone can use the same basic API and objects to leverage the processing capabilities of the PRU. Alexander Hiam posts a sample gist which could be used as a starting point.


 * Lightweight The PRU is optimized for low latency memory access and I/O operations, be it toggling a GPIO, generating stepping pulses or controlling large streams of WS2812B LED strip modules or sampling GPIOs at regular intervals into RAM. Larger messages increase this overhead.


 * Support for interrupts to userspace The ability to get a callback from the PRUs to userspace or kernel space (according to need of the application). A kernel module may be able to "attach" and "detach" itself from the main pru-remoteproc driver to extend its functionality if so needed.


 * Memory Management The ability to allocate shared buffers of arbitrary size shared between the PRU and the kernel if required.

The list as such is not exhaustive and prospective students / developers are encouraged to participate and edit this section with possible suggestions to make the PRUSS programming more productive and accessible to everyone.

Goal: Create a new mainline kernel-friendly infrastructure that leverages functionality of the PRU Existing project: BeagleLogic, PRUSpeak, Hardware skills: Understanding of basic embedded systems. Software skills: Able to write software in C, understand existing patches with PRU support, PRU Assembly. create patches to the Linux kernel and perform cross-compilation Possible mentors: Kumar Abhishek

PRU upstreaming
Remove HWMOD dependency requirement for PRU along with adding device tree bindings so it can be upstreamed into Linus's tree.

Goal: Push patches to Linux mainline providing support for the AM335x PRU Existing project: https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/ Hardware skills: Able to read schematics, understand basic digital logic and monitor logic-level digital signals Software skills: Able to write software in C, understand existing patches with PRU support, create patches to the Linux kernel and perform cross-compilation Possible mentors: Start with Jason Kridner and Matt Porter, but we'll get some others involved

PRU firmware loader
Allow "firmware" which are really binary PRU applications to be loaded directly on PRU cores and executed using the request_firmware functionality of the Linux Kernel. This should also be Cape Manager to load PRU cape specific applications.

Ideal workflow:


 * Cape detected that uses the PRU
 * Setup pinmux
 * Find the respective firmware file for PRU core (or both cores) /lib/firmware/cape_A020_pru0.bin
 * Load onto PRU and begin execution.

Goal: Push patches to Linux mainline providing support to loading firmware on PRU cores and executing Existing project: https://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/ Hardware skills: Able to read schematics, understand basic digital logic and monitor logic-level digital signals Software skills: Able to write software in C, create patches to the Linux kernel and perform cross-compilation Possible mentors: Matt Ranostay, Matt Porter

Program PRU using high-level scripting languages
Based on Chris Roger's BotSpeak work to provide a virtual machine for typical Arduino functions that can be accessed from LabView, build a virtual machine to enable PRU programming from Bonescript. The virtual machine is a simple interpreter that loops over the commands to perform such as delay, pinMode, analogRead, analogWrite, digitalRead and digitalWrite functions.

A basic design is elaborated upon at http://github.com/jadonk/pruduino

Goal: Implement a BotSpeak interpreter that off-loads hard real-time tasks from Bonescript onto the PRU and include that in the BoneScript project Existing projects: PRUDUINO, http://github.com/beagleboard/am335x_pru_package, http://github.com/jadonk/bonescript, Chris' language definition Hardware skills: Able to read schematics, understand basic digital logic and monitor logic-level digital signals Software skills: Able to write software in JavaScript and assembly Possible mentors: Chris Rogers, Jason Kridner

Linux userspace support of embedded devices and interfaces in high-level languages
Improving the Bonescript JavaScript library, the PyBBIO Python library, Userspace Arduino, web-based interface libraries, examples or alternatives in other languages.

Implementing and testing core libraries in Userspace Arduino
Implementing and testing core libraries in Userspace Arduino, especially SPI, I2C, Wire, Serial, Servo, Stepper

This would primarily target the Arduino Tre.

Improving initial experience for novice developers
Improving the methods for communicating how to build projects, improving the out-of-box experience for novices and consolidating support for simplified home manufacturing (CNC, 3D printers, laser cutters, pick-and-place machines, etc.), drones/bots (ROS, IMU, video streaming, etc.) or other common tasks.

node-webkit based cross-platform getting-started app
Newbies often have a difficult time following directions that could be replaced by an application. The steps to download and install an application is something that even newbies can typically manage. This avoid issues like having bad browsers or not having typical development tools like 'ssh'. This is a common problem across all embedded Linux platforms and node-webkit provides a good solution for making it cross-platform.

Features:
 * Provide instructions for getting up-and-running with the board based (incorporate the Getting Started Guide)
 * Automatically discover boards on the LAN using mDNS and predetermined IP addresses
 * Act as a browser to interact with the board, including performing SSH and SCP
 * Discover the latest SD card images from multiple distributions
 * Bootload the board with a USB-mass-storage-class application
 * Program SD cards through the board or a USB adapter
 * Program on-board eMMC

Goal: Provide a downloadable application for Linux, Windows and Mac that enables unexperienced users to get going enough to start learning about using Linux and the embedded I/O. Existing Project: Incomplete node webkit app for the BeagleBone Getting Started guide Hardware Skills: N/A Software Skills: Able to write software in JavaScript and work with node.js modules Possible mentors: Jason Kridner

BoneScript web pages with live-running examples and documentation
The BoneScript JavaScript library enables hardware control from web pages using socket.io for remote procedure calls. This provides an excellent environment for teaching how to wire-up sensors and controls and rapidly prototype user interfaces. Numerous examples exist on the web, but consolidation and testing are required to make them usable by novices. Examples include interfacing with potentiometers, light sensors, temperature sensors, motors and LED arrays then visualizing/controlling with Twitter, Facebook, jQuery, Spacebrew and dweet,io.

Goal: About 25 web pages with executable script that demonstrate how to connect up sensor and actuator hardware integrated into the bone101 repository and shared on http://beagleboard.org/Support/BoneScript Existing Projects: 5 easy tricks presentation, http://beagleboard.org/Support/BoneScript, https://github.com/jadonk/bone101, BMP085 Bonescript example, ECE497 examples, JSFiddle on GIST example Hardware Skills: Basic knowledge of digital circuits. Software Skills: JavaScript and some familiarity with Linux Possible mentors: Jason Kridner

Using BeagleBone PRUs to control CNC and 3D printer stepper motor Drivers
This project is to write code for the PRU (realtime processors on the AM335x used in the Beagle Bone) so that it can generate multiple step and direction outputs based on a queue of commands in real time. This needs to be done in real time so the acceleration and coordination of multiple stepper motors can be controlled and coordinated. A step/dir signal is commonly used in a lot of stepper motor drivers. While it is possible to generate stepper phase information from the PRU, it is also undesireable from a testing stand point. An example of a reason for doing this is controlling the X/Y directions of the head of a 3D printer so that it can generate precise curves. While similar code has been done, it is not done in a real time fashion so it is difficult to add coordination between motors and/or maintain a known acceleration.

The result of this code should be something interfaceable to a control system like the non realtime portions of the Linux CNC project (formerly the EMC project). But as a demo, this same code should also demonstrate a node.js functionality such as a "G-code" interpreter. This node.js portion can be considered a second project due to the different skill sets required and ideally this project would be split between two GSoC students. One project would be working mostly on PRU assembly with integration into the Linux kernel. The other project would be working mostly on userspace JavaScript in node.js and C++ code for anything needing optimization or low-level kernel access. Mentors would heavily assist on defining the right interfaces between the two programming environments.

Goal: create code to use the AM335x PRUs to generate multiple step and direction outputs for reprap and CNC applications Existing projects: Pru Documentation, UIO Driver documentation Hardware skills: Able to read schematics, understand basic digital logic and monitor logic-level digital signals Software skills: Assembly and C coding. Node.js for g-code interpretation Possible mentors:Jason Kridner, Hunyue Yau, Laine Walker-Avina

Cross platform USB boot
Boot (and flash) your BeagleBone (Black) from a Windows, Mac or Linux computer without using a microSD card.

Extend last year's GSoC project to boot from an Android device to support Windows, Mac and Linux hosts.

Goal: Download a Linux image from the web and boot a BeagleBone using it over USB Existing Project: https://github.com/ungureanuvladvictor/BeagleDroid, https://github.com/ungureanuvladvictor/BBBlfs Hardware Skills: Some knowledge of USB Software Skills: C and familiarity with Mac, Linux and Windows Possible mentors: Vladimir Pantelic, Jason Kridner, Vlad Ungureanu

Android under Angstrom
Some people want to play Angry Birds or run other Android apps on their BeagleBoard/BeagleBone. Of course, you could use the Rowboat Android project as-is, but then you'd have to give up all of their typical Linux/X11 applications available in Angstrom. This project would use an Android-enabled kernel and a combination of both Angstrom and Android file systems. The input and display methods required for Android would need to be adjusted to run in on a virtual terminal and chroot/chvt would be used to invoke the various user space windows.

This has essentially been done once as part of Always Innovating's Super-Jumbo demo running Ubuntu, Angstrom, ChromeOS and Android simultaneously. The fundamental challenge is getting it reproducible and integrated into the OpenEmbedded build system for Angstrom and then starting to minimize the wasted file space by sharing libraries. Eventually, even making Android applications run in a window is desired.

Goal: Run Android applications under Angstrom and toggle back-and-forth using CTRL-ALT-Fn key presses. Existing projects: http://arowboat.org, http://www.angstrom-distribution.org Hardware skills: Minimal Software skills: Able to write software in C and Java, experience with X11 and Android Possible mentors: Hunyue Yau, Vladimir Pantelic

Automated testing for BeagleBone and BeagleBone Black
Produce code samples and test harness for use of I/O on BeagleBone to be placed in the neutral elinux.org BeagleBone community pages.

Goal: The Beagleboard.org community has lacked a canonical source of high quality documentation on how to use peripherals found on AM335x. Peripheral use to be documented will include UARTs, I2C, SPI, PWM, ADC, USB Host/Gadget as well as advanced topics such as software development and optimization for the M3 and PRU coprocessors. Existing Project: elinux.org BeagleBone Community Page Hardware Skills: Yes Software Skills: C Possible mentors: Hunyue Yau, Matt Porter and Jason Kridner

Previous ideas

 * BeagleBoard/GSoC/Ideas-2014
 * BeagleBoard/GSoC/Ideas-2013
 * BeagleBoard/GSoC/Ideas-2012

=Mentors= Previous mentors