ARM mbed OS

Welcome to ARM mbed OS, a new operating system for ARM microcontrollers, designed for the Internet of Things.

mbed OS is comprised of a number of software components, combined together and built using yotta. This means code lives in a number of repositories. This repository serves as an entry point for mbed OS, and as a central location for documentation, and for filing bugs which span multiple components.

Note that this is a beta release -- this means that the software is still maturing, and many things will change. In particular, module names, repo URLs, APIs, header file names, configuration parameters and any other details can and will change. We'll try to mitigate the imposition that these changes have on your code where possible, but please expect backwards-incompatible changes.

The code for mbed OS can be found in these repos:

• Core OS modules
  • core-util -- core data structures and primitives for the OS.
  • minar -- MINAR, the mbed OS event scheduler.
    • minar-platform -- platform-specific adaptation for MINAR.
      • minar-platform-mbed -- generic MINAR platform adaptation using the mbed HAL.
  • ualloc -- memory allocation for mbed OS.
    • dlmalloc -- Doug Lea's legendary memory allocator.
  • uvisor -- the mbed OS uVisor, a supervisory kernel for security on mbed OS.
    • uvisor-lib -- APIs for interacting with the uVisor and incorporating it into your system.
  • compiler-polyfill -- common compiler intrinsics and attributes made portable across toolchains.
• Hardware Abstraction & Drivers
  • cmsis-core -- CMSIS-Core, ARM's official low level hardware abstraction for Cortex-M.
    • cmsis-core-freescale -- generic implementation of CMSIS-Core for Freescale devices.
      • cmsis-core-k64f -- specific implementation for the Freescale K64F MCU family.
    • cmsis-core-nordic -- generic implementation of CMSIS-Core for Nordic Semi devices.
      • cmsis-core-nrf51822 -- specific implementation for the Nordic nRF51 family.
    • cmsis-core-st -- generic implementation of CMSIS-Core for ST devices.
      • cmsis-core-stm32f4 -- generic implementation of CMSIS-Core for the STM32F4 family.
        • cmsis-core-stm32f429xi -- specific implementation of CMSIS-Core for the STM32F429.
  • mbed-drivers -- abstract drivers for common hardware peripherals and communications interfaces (SPI, I2C etc). Provides a higher level interface than the mbed HAL; these are the APIs that applications should use.
  • mbed-hal -- the mbed Hardware Abstraction Layer (HAL).
    • mbed-hal-freescale -- implementation of the mbed HAL for Freescale devices.
      • mbed-hal-ksdk-mcu -- implementation for Freescale MCUs using Freescale KSDK.
      • mbed-hal-k64f -- implementation for the K64F.
        • mbed-hal-frdm-k64f -- specific implementation for the Frdm-K64F development board.
    • mbed-hal-nordic -- implementation for Nordic Semi devices.
      • mbed-hal-nrf51822-mcu -- implementation for the nRF51822 wireless MCU.
        • mbed-hal-mkit -- implementation for the Nordic nRF51822-mKIT development board.
    • mbed-hal-st -- implementation for ST devices
      • mbed-hal-st-stm32f4 -- implementation for the STM32F4 family.
        • mbed-hal-st-stm32cubef4 -- implementation for ST MCUs using the STM32CubeF4 library.
          • mbed-hal-st-stm32f429zi -- implementation for the STM32F429.
  • atmel-rf-driver -- PHY driver for the Atmel AT86RF2xx series of 802.15.4 radios, for mesh networking in mbed OS.
• Networking & Connectivity
  • sal -- mbed OS's socket abstraction layer (SAL). This enables the various ARM and partner networking stacks to have a common interface.
    • sal-iface-eth -- support for Ethernet interfaces.
    • sal-iface-6lowpan -- support for 6LoWPAN network interfaces.
    • sal-stack-lwip -- the third party LwIP (lightweight IP) networking stack. Currently this only supports IPv4 over ethernet or WiFi, and will be replaced by a new IPv4/v6 unified stack in the future.
      • sal-driver-lwip-k64f-eth -- driver for the Freescale K64F ethernet interface in LwIP.
    • sal-stack-nanostack -- ARM's NanoStack 6LoWPAN/mesh networking stack.
      • sal-stack-nanostack-eventloop -- event loop integration for NanoStack.
  • sockets -- high level portable socket layer (sitting on top of the SAL).
  • ble -- APIs for using Bluetooth Low Energy.
    • ble-nrf51822 -- implementation of the BLE APIs for Nordic nRF51822.
  • mbed-mesh-api -- APIs for initialising and using the mesh network.
  • mbedtls -- mbed TLS, the SSL/TLS stack (including cryptographic and certification handling functionality).
• mbed Client -- means for connecting to and managing mbed OS devices with mbed Device Server or mbed Device Connector. This includes the OMA LWM2M client, CoAP protocol implementations, and related functionality.
  • mbed-client-c -- core library in C.
  • mbed-client -- C++ API (use this one rather than the C one, as it's much easier to use correctly).
  • mbed-client-mbed-os -- mbed OS specific implementation for mbed Client.
  • mbed-client-mbedtls -- mbed TLS specific implementation for mbed Client.
• Tools & Utilities
  • yotta -- component management, configuration and build. Start here, as you need to get familiar with this tool to use mbed OS!
  • helloyotta -- example project for yotta.
  • greentea -- regression testing tool.
  • htrun -- test runner for host-supervised tests.
  • mbed-ls -- utility for detecting and listing mbed Enabled development boards attached to the development host.
  • cpputest -- unit testing framework for C++.

The following modules define the yotta targets we support building mbed OS for. Currently we only support the following boards:

1. Freescale FRDM-K64F board -- a powerful and flexible development board based around the Freescale K64F Kinetis MK64FN1M0VLL12 MCU. It has a high performance ARM® Cortex™-M4 Core (with Floating point unit and DSP extensions), clocked at up to 120MHz, paired with 256KB RAM, 1MB FLASH and a wide array of peripherals. This is currently the best supported development board for mbed OS; networking (ethernet, and mesh with a 802.15.4 radio shield), cryptographic acceleration, and other features are supported already in this beta release. You can use either ARM's C/C++ compiler, or the open source GCC compiler.

• target-frdm-k64f-armcc
• target-frdm-k64f-gcc

1. ST STM32F429I Discovery board -- based on the STM32F429ZIT6 microcontroller with 2 MB of Flash memory, 256 KB of RAM, and a Cortex-M4 (with FPU and DSP) that can be clocked up to 180 MHz. Currently this board and MCU is not as well supported as the K64F, especially if you want to use uVisor or networking.

• target-st-stm32f429i-disco
• NOTE: we don't yet support armcc for this target.

1. Nordic nRF51-DK board -- based around the Nordic nRF51822 Bluetooth Smart/Low Energy device, this has a Cortex-M0 core, with 256 kB of flash and 16-32 kB of RAM. Due to much of the RAM being reserved for Nordic's "SoftDevice" BLE stack, only a small amount of RAM is available for mbed OS and your application, thus this board is best for simpler applications such as BLE peripherals.

• target-nrf51dk-gcc
• target-nrf51dk-armcc

Finally, there are a number of yotta targets that provide shared functionality:

• target-mbed-armcc
• target-mbed-gcc

We also have a number of examples to help you get started:

• mbed-client-examples
• mbed-example-network
• example-asynch-i2c
• example-asynch-serial
• example-asynch-spi
• mbed-client-example-6lowpan
• uvisor-helloworld
• ble-examples