tool/mbed/mbed-sdk/README.md

   1 mbed SDK
   2 ========
   3
   4 [![Build Status](https://travis-ci.org/mbedmicro/mbed.png)](https://travis-ci.org/mbedmicro/mbed/builds)
   5
   6 The mbed Software Development Kit (SDK) is a C/C++ microcontroller software platform relied upon by tens of thousands of
   7 developers to build projects fast.
   8
   9 The SDK is licensed under the permissive Apache 2.0 licence, so you can use it in both commercial and personal projects
  10 with confidence.
  11
  12 The mbed SDK has been designed to provide enough hardware abstraction to be intuitive and concise, yet powerful enough
  13 to build complex projects. It is built on the low-level ARM CMSIS APIs, allowing you to code down to the metal if needed.
  14 In addition to RTOS, USB and Networking libraries, a cookbook of hundreds of reusable peripheral and module libraries
  15 have been built on top of the SDK by the mbed Developer Community.
  16
  17 Documentation
  18 -------------
  19 * [Tools](http://developer.mbed.org/handbook/mbed-tools): how to setup and use the build system.
  20 * [mbed library internals](http://developer.mbed.org/handbook/mbed-library-internals)
  21 * [Adding a new target microcontroller](http://developer.mbed.org/handbook/mbed-SDK-porting)
  22
  23 Supported Microcontrollers and Boards
  24 -------------------------------------
  25 View all on the [mbed Platforms](https://developer.mbed.org/platforms/) page.
  26
  27 NXP:
  28 * [mbed LPC1768](http://developer.mbed.org/platforms/mbed-LPC1768/) (Cortex-M3)
  29 * [u-blox C027 LPC1768](http://developer.mbed.org/platforms/u-blox-C027/) (Cortex-M3)
  30 * [mbed LPC11U24](http://developer.mbed.org/platforms/mbed-LPC11U24/) (Cortex-M0)
  31 * [EA LPC11U35](http://developer.mbed.org/platforms/EA-LPC11U35/) (Cortex-M0)
  32 * mbed LPC2368 (ARM7TDMI-S)
  33 * LPC810 (Cortex-M0+)
  34 * [LPC812](http://developer.mbed.org/platforms/NXP-LPC800-MAX/) (Cortex-M0+)
  35 * [EA LPC4088](http://developer.mbed.org/platforms/EA-LPC4088/) (Cortex-M4F)
  36 * [EA LPC4088 DM](http://developer.mbed.org/platforms/EA-LPC4088-Display-Module/) (Cortex-M4F)
  37 * LPC4330 (Cortex-M4F + Cortex-M0)
  38 * [LPC1347](http://developer.mbed.org/platforms/DipCortex-M3/) (Cortex-M3)
  39 * [LPC1114](http://developer.mbed.org/platforms/LPC1114FN28/) (Cortex-M0)
  40 * LPC11C24 (Cortex-M0)
  41 * [LPC1549](https://developer.mbed.org/platforms/LPCXpresso1549/) (Cortex-M3)
  42 * [LPC800-MAX](https://developer.mbed.org/platforms/NXP-LPC800-MAX/) (Cortex-M0+)
  43 * [DipCortex-M0](https://developer.mbed.org/platforms/DipCortex-M0/) (Cortex-M0)
  44 * [DipCortex-M3](https://developer.mbed.org/platforms/DipCortex-M3/) (Cortex-M3)
  45 * [BlueBoard-LPC11U24](https://developer.mbed.org/platforms/BlueBoard-LPC11U24/) (Cortex-M0)
  46 * LPCCAPPUCCINO (Cortex-M0)
  47 * [Arch](https://developer.mbed.org/platforms/Seeeduino-Arch/) (Cortex-M0)
  48 * [Arch GPRS](https://developer.mbed.org/platforms/Seeed-Arch-GPRS/) (Cortex-M0)
  49 * [Arch Pro](https://developer.mbed.org/platforms/Seeeduino-Arch-Pro/) (Cortex-M3)
  50
  51 Freescale:
  52 * [FRDM-KL05Z](https://developer.mbed.org/platforms/FRDM-KL05Z/) (Cortex-M0+)
  53 * [FRDM-KL25Z](http://developer.mbed.org/platforms/KL25Z/) (Cortex-M0+)
  54 * FRDM-KL43Z (Cortex-M0+)
  55 * [FRDM-KL46Z](https://developer.mbed.org/platforms/FRDM-KL46Z/) (Cortex-M0+)
  56 * [FRDM-K20D50M](https://developer.mbed.org/platforms/FRDM-K20D50M/) (Cortex-M4)
  57 * [FRDM-K22F](https://developer.mbed.org/platforms/FRDM-K22F/) (Cortex-M4F)
  58 * [FRDM-K64F](https://developer.mbed.org/platforms/FRDM-K64F/) (Cortex-M4F)
  59
  60 STMicroelectronics:
  61 * [Nucleo-F030R8](https://developer.mbed.org/platforms/ST-Nucleo-F030R8/) (Cortex-M0)
  62 * [Nucleo-F072RB](https://developer.mbed.org/platforms/ST-Nucleo-F072RB/) (Cortex-M0)
  63 * [Nucleo-L053R8](https://developer.mbed.org/platforms/ST-Nucleo-L053R8/) (Cortex-M0+)
  64 * [Nucleo-F103RB](https://developer.mbed.org/platforms/ST-Nucleo-F103RB/) (Cortex-M3)
  65 * [Nucleo-L152RE](https://developer.mbed.org/platforms/ST-Nucleo-L152RE/) (Cortex-M3)
  66 * [Nucleo-F302R8](https://developer.mbed.org/platforms/ST-Nucleo-F302R8/) (Cortex-M4F)
  67 * [Nucleo-F334R8](https://developer.mbed.org/platforms/ST-Nucleo-F334R8/) (Cortex-M4F)
  68 * [Nucleo-F401RE](https://developer.mbed.org/platforms/ST-Nucleo-F401RE/) (Cortex-M4F)
  69 * [Nucleo-F411RE](https://developer.mbed.org/platforms/ST-Nucleo-F411RE/) (Cortex-M4F)
  70 * STM32F4XX (Cortex-M4F)
  71 * STM32F3XX (Cortex-M4F)
  72 * STM32F0-Discovery (Cortex-M0)
  73 * STM32VL-Discovery (Cortex-M3)
  74 * STM32F3-Discovery (Cortex-M4F)
  75 * STM32F4-Discovery (Cortex-M4F)
  76 * STM32F429-Discovery (Cortex-M4F)
  77 * STM32L0-Discovery (Cortex-M0+)
  78 * [Arch Max](https://developer.mbed.org/platforms/Seeed-Arch-Max/) (Cortex-M4F)
  79
  80
  81 Nordic:
  82 * [nRF51822-mKIT](https://developer.mbed.org/platforms/Nordic-nRF51822/) (Cortex-M0)
  83 * [Arch BLE](https://developer.mbed.org/platforms/Seeed-Arch-BLE/) (Cortex-M0)
  84
  85 Renesas:
  86 * [RZ-A1H](http://developer.mbed.org/platforms/Renesas-GR-PEACH/) (Cortex-A9)
  87
  88
  89 Supported Toolchains and IDEs
  90 -----------------------------
  91 * GCC ARM: [GNU Tools for ARM Embedded Processors](https://launchpad.net/gcc-arm-embedded/4.7/4.7-2012-q4-major)
  92 * ARMCC (standard library and MicroLib): [uVision](http://www.keil.com/uvision/)
  93 * IAR: [IAR Embedded Workbench](http://www.iar.com/en/Products/IAR-Embedded-Workbench/ARM/)
  94 * GCC code_red: [Red Suite](http://www.code-red-tech.com/)
  95 * GCC CodeSourcery: [Sourcery CodeBench](http://www.mentor.com/embedded-software/codesourcery)
  96 * GCC ARM: [Em::Blocks](http://www.emblocks.org/web/)
  97 * GCC ARM: [CooCox CoIDE](http://www.coocox.org/)
  98
  99 API Documentation
 100 -----------------
 101 * [RTOS API](http://developer.mbed.org/handbook/RTOS)
 102 * [TCP/IP Socket API](http://developer.mbed.org/handbook/Socket) (Transports: Ethernet, WiFi, 3G)
 103 * [USB Device API](http://developer.mbed.org/handbook/USBDevice)
 104 * [USB Host API](http://developer.mbed.org/handbook/USBHost)
 105 * [DSP API](http://developer.mbed.org/users/mbed_official/code/mbed-dsp/docs/tip/)
 106 * Flash File Systems: [SD](http://developer.mbed.org/handbook/SDFileSystem), [USB MSD](http://developer.mbed.org/handbook/USBHostMSD), [semihosted](http://developer.mbed.org/handbook/LocalFileSystem)
 107 * [Peripheral Drivers API](http://developer.mbed.org/handbook/Homepage)
 108
 109 Community
 110 ---------
 111 For discussing the development of the mbed SDK itself (Addition/support of microcontrollers/toolchains, build and test system, Hardware Abstraction Layer API, etc) please join our [mbed-devel mailing list](https://groups.google.com/forum/?fromgroups#!forum/mbed-devel).
 112
 113 For every topic regarding the use of the mbed SDK, rather than its development, please post on the [mbed.org forum](http://mbed.org/forum/), or the [mbed.org Q&A](http://mbed.org/questions/).
 114
 115 For reporting issues in the mbed libraries please open a ticket on the issue tracker of the relevant [mbed official library](http://mbed.org/users/mbed_official/code/).