Linux mainlining effort

The purpose of this page is to try and define sub-goals and milestones for the mainlining effort, containing goals and sub-goals with milestones for adding Allwinner support in the upstream mainline Linux Kernel.

It is very important to note that this is intended as a rough set of minimal goals - it is not meant to collide with the huge effort of rewriting major drivers!

=Overview= The idea is to submit the code needed to run the Linux kernel on Allwinner SoCs upstream, ie. to the official Linux kernel.

This can be achieved by following the concept outlined in the Your new ARM SoC Linux support check-list! article published by Thomas Petazzoni from Free Electrons.

Where relevant, I have attempted to include who is currently working on an item, mostly separate from any particular mainlining goal.

=Status=

The Mainline Kernel howto contains the currently used repositories for the mainlining process. The U-Boot repository and toolchain is described in the U-Boot howto.

The Mainline Kernel category  gives an overview of currently supported devices.

Merged into 3.8

 * Initial support for Allwinner SoCs (commit)
 * Timer (commit)
 * UART
 * Device Tree
 * Interrupt controller (commit)

Related merges: ,

Added board support: Cubieboard, A13-OLinuXino

Merged into 3.9

 * PINCTRL driver
 * GPIO-lib based driver

Related merges:

Added Board Support: Miniand_Hackberry

Merged into 3.10

 * LED support
 * Clock driver
 * Complete UART support

Related merges:, ,

Added Board Support: Pineriver_H24

Merged into 3.11

 * IRQ support for the PIO
 * I2C Driver
 * EMAC Driver
 * A10s support

Related merges:, , , , ,

Added board support: Olimex A10s-OLinuXino-Micro

Merged into 3.12

 * A31 support
 * Basic SoC + GPIO
 * Clock support
 * A20 support
 * Basic SoC + GPIO
 * Clock support
 * A10s clocks
 * Clock Source and Clock Event rework
 * Watchdog driver

Related merges:, , , , ,

Added board support: A31 EVB, A20-OLinuXino-Micro, Cubieboard2, Mele A1000

Merged into 3.13

 * SID Driver
 * I2C for A20
 * sunxi_defconfig
 * Bug fixes

Added board support: Cubietruck

Merged into 3.14

 * A31
 * Reset Controller Support
 * SMP
 * A20
 * SMP (via PSCI)
 * External clock outputs
 * High Speed Timers
 * RTC driver (A10/A20) (commit)
 * RTP (DT only)
 * GMAC support in stmmac driver
 * AP6210 WiFi (BCM43362) support in brcmfmac driver

Related merges:, , , ,

Added board support: Olimex A13-OLinuXino-Micro (commit)

Merged into 3.15

 * All SoCs
 * SPI
 * A10/A10s/A13/A20
 * OHCI
 * EHCI
 * A10/A20
 * AHCI
 * A20/A31
 * NMI controller
 * A20
 * GMAC
 * A31
 * I2C

Related merges:, , , , , ,

Added board support: LinkSprite_pcDuino, Inet 97f, A10-OLinuXino-LIME

Merged into 3.16

 * AXP20x regulator support


 * All
 * MMC support


 * A31
 * USB support
 * PRCM
 * SMBus Regmap
 * Special Pins Muxer
 * P2WI Controller


 * A10
 * Touchscreen controller
 * Touchscreen controller temperature sensor

Related Merges:

defconfig-for-3.16, drivers-for-3.16, dt-for-3.16, soc-for-3.16, usb-3.16-rc1, pinctrl-v3.16-1, clk-for-linus-3.16, clk-for-linus-3.16-part2, mmc-updates-for-3.16-rc1, mfd-for-linus-3.16, regulator-v3.16, input-for-linus

Added board support: Mele M9, R7

Merged into 3.17

 * A10/A20
 * IR driver


 * A31
 * PIO/R_PIO external interrupts
 * DMAengine
 * GMAC


 * A23
 * Timers, UARTs, initial bringup
 * Basic clocks
 * PIO/R_PIO drivers

Related merges: clk-for-linus-3.17, mfd-for-linus-3.17, pinctrl-v3.17-1, soc-for-3.17, dt-for-3.17, slave-dma for-linus, v4l_for_linus,

Added Board Support: Merrii Hummingbird A31, BA10, LinkSprite pcDuino V3, Ippo q8h

Merged into 3.18

 * A31/A23
 * RTC
 * Watchdog


 * A23
 * MMC
 * pinctrl
 * DMA
 * I2C

Added board support: Olimex A20-OLinuXino-Lime, Merrii Hummingbird A20, HSG H702

Merged for 3.19

 * A10 / A10s / A13 / A20 / A31 / A23
 * Simple Framebuffer
 * In order to use that, you'll need a recent mainline u-boot (2015.01+)
 * USB phy driver support for usb0


 * A10 / A20
 * NAND
 * Only works for SLC NAND for now
 * Some additional work is needed for MLC NANDs


 * A23
 * DMAengine driver (shared with A31)


 * A80
 * initial machine support
 * basic clocks and reset
 * pinctrl driver
 * extra UART, I2C, LEDS

Added board support: Mele M3, LeMaker Banana Pi, Merrii A80 Optimus Board, Olimex A20-OLinuXino-Lime2

Planned for 3.20

 * A20
 * PS/2 Controller


 * A31
 * IR receiver


 * A31s
 * bring-up sharing majority of drivers with A31
 * pinctrl driver


 * A80
 * MMC


 * All SoCs
 * LRADC Input driver
 * CPUFreq
 * PWM Driver


 * AXP209 power button input driver

Planned for 3.21

 * A80
 * USB support

Core Stuff

 * CPUFreq for sun[457]i (WiP: Chen-Yu Tsai (wens)) patch-v3
 * DMAengine driver for A10/A10s/A20 (sun4i/sun5i/sun7i) (WiP: Emilio Lopez (turl)) patch-v4
 * DMAengine driver handles slave DMA clients including SPI, EMAC, USB, I2S, HDMI audio, and NAND
 * Highest priority is to implement slave SG transfers (SPI driver as a proof of concept and test target), cyclic transfers (for audio clients)
 * These SoCs have two modes of operations: Normal and Dedicated. The dedicated mode looks a lot like how the A31 DMA controller works, though it only supports mem2dev transfers
 * A80 PRCM driver (WiP: Chen-Yu Tsai (wens)) RFC-patch

Major drivers

 * NAND Driver (WiP: Boris Brezillon (bbrezillon))
 * Randomizer to support MLC NANDs patch-rfc
 * Per-partition ECC to support boot0 reading/writing
 * A20 Audio Codec (WiP: Jon Smirl)
 * A31 Audio Codec driver (WiP: Maxime Ripard (mripard))
 * A31 PLL2 and module 1 clocks
 * Cyclic DMA transfers
 * ASoC driver
 * Much more complex and signficantly different from the other audio codecs IPs found in the other Allwinner SoCs (A23 included)

Minor drivers

 * AXP202/AXP209
 * DT bindings
 * PowerSupply/Battery driver (WiP: Bruno Prémont (bonbons)) RFC-patch
 * AXP221 driver (WiP: Boris Brezillon (bbrezillon)) patch-v4
 * PS/2 driver for A10/A20 (WiP: Vishnu Patekar) patch-v5
 * Security System (Crypto Engine) (WiP: Corentin Labbe (Montjoie)) patch-v5
 * Hardware Pseudo Random Number Generator
 * Checksumming (MD5, SHA1)
 * Crypto (AES, DES, 3DES)
 * V4L driver for G2D/Mixer is based on samsung g2d and fimc driver. Only initial work started.
 * RSB (Reduced Serial Bus) driver (WiP: Chen-Yu Tsai (wens))

Easy Tasks
Following drivers should be doable by someone with no or a small kernel development experience:
 * Keypad
 * One Wire / 1-Wire
 * Smart Card Reader
 * A23 Thermal Sensor Controller
 * CAN (Sun7i-CANbus.pdf )
 * Preliminary work has been done by Peter Chen
 * Restored code dump: . Please note that there has been some work being done in repositories forked from this repository.

Medium Tasks
Following drivers require some good knowledge of the kernel internals.
 * A31 GPADC
 * CSI (Camera Input)
 * CPUIdle
 * Suspend/Resume


 * Audio Related drivers
 * Those items are not related to each other, and can be implemented independently
 * A23 Audio Codec (A23 SDK has an ASoC driver for this)
 * I2S Digital Audio Interface
 * AC97 Audio Interface
 * A23 SDK has an ASoC driver for these already, which would be a good starting point


 * USB OTG Driver
 * This seems to be Mentor Graphics Inventra USB Controller (musb), that is already supported in mainline kernel, so it only needs a thin layer to adapt it to sunxi. As it's already supporting the PIO mode, so we could avoid relying on DMA to merge it. (Thanks to Arnd Bergmann for noticing)
 * Support for USB OTG phy0 is available since 3.19-rc1
 * OTG itself requires more work:
 * Mode detection is working, but the method for switching MUSB core and hardware from host-mode to peripheral and other way around is still unknown.

Difficult Tasks
These drivers require some good knowledge of the kernel internals, plus a good experience with such piece of hardware.
 * Display (KMS)
 * Video Engine (See VE_Planning)
 * Audio Engine (Only exists in A10)

Troublesome

 * Memory Stick
 * Has anybody actually got this hardware connected and a memory stick?
 * TV Decoder
 * Analog in, no driver, no datasheet
 * Transport Stream(DVB) in
 * IRC user woprr has started to work on this
 * PATA
 * Old tech, while still interesting for Compact Flash, possibly removed from A20, though A20 memory map still mentions it
 * GPS backend IP
 * Only A10, not much interesting, as all modern GPS receivers have MCU with UART output, no documentation

Unlikely
These are too far off the track third party drivers making it unlikely they will ever get accepted mainline.


 * Mali driver (will not happen unless libv gets a proper lima driver out)

Related but separate

 * Device-specific drivers

=References=

= See also =
 * Mainline Kernel Howto
 * Possible setups for hacking on mainline
 * Linux Kernel
 * Toolchain

=External Links=
 * kernel.org - Official website for the Linux Kernel
 * http://github.com/torvalds/linux - Linus Torvalds' GitHub account with the upstream Linux kernel
 * Linux Kernel documentation index
 * Linux Kernel man pages
 * Kernel Newbies Site - Excellent source of information for people new to kernel
 * Linus' kernel tree for 2.6
 * Kernel bugzilla - Regressions for each of recent versions
 * Linux-libre project - Maintains and distributes fully free kernel
 * LinGrok, Linux kernel source code cross-reference
 * Free Electrons LXR (Linux Cross Reference)
 * linux-arm-kernel - Mailing list archive

How to upstream

 * Your new ARM SoC Linux support check-list! by Thomas Petazzoni of Free Electrons
 * Linux Kernel Upstreaming How-To (CNXSoft - Embedded Software Development)
 * Matt Porter's YouTube video talk on “Upstreaming 101" (LCA14-111)
 * Matt Porter's presentation slides for “Upstreaming 101" (LCA14-111)
 * Matt Porter's YouTube video talk on “Upstreaming 201" (LCA14-112)
 * Matt Porter's presentation slides for “Upstreaming 201" (LCA14-112)
 * How to Write and Submit a Linux Kernel Patch (CNXSoft - Embedded Software Development)
 * YouTube Video- Write and Submit your first Linux kernel Patch
 * Greg Kroah-­Hartman Kernel Tutorial Write and Submit your first Linux Kernel Patch
 * Linaro resources page from LCA (Linaro Connect Asia) 2014