-
If you have difficulties with USB serial communication: -
1. Make sure you have installed the driver if you are working on Windows - [Windows Serial Configuration](/Going_Further/Serial_Conf). -
2. Learn how to use the [Serial](/Going_Further/Serial/) port. -
3. Read up on using [Terminals](/Going_Further/Terminals/) programs. -
**If you have any problems, or think this tutorial could be improved, please tell us in the [forum](http://developer.mbed.org/forum)** - \ No newline at end of file diff --git a/docs/Development/Write_Publish.md b/docs/Development/Write_Publish.md deleted file mode 100644 index d841ac2505..0000000000 --- a/docs/Development/Write_Publish.md +++ /dev/null @@ -1,270 +0,0 @@ -#Writing and Publishing Code - -This page discusses the steps in writing and publishing an mbed library. It covers: - -* What is a library -* How to code a library -* How to publish a library - -##What is a Library? - -A library is a collection of code, usually focused on enabling a specific component, peripheral or functionality. - -The main point of a library is to package something useful up so you and others don't need to keep re-inventing the wheel when you want to use some device or functionality. You can think of it as a building block for a program. Importantly, it is not a program in itself. i.e. it doesn't have a ``main()`` function, but will be a useful and reusable component in a program. - -For reference, here are some existing examples: - -* [Servo Library](http://developer.mbed.org/users/simon/code/Servo/) is a library for controlling a R/C servo, containing Servo.h and Servo.cpp files - -* [Servo Hello World](http://developer.mbed.org/users/simon/code/Servo_HelloWorld/) is a program that uses this library to control a servo, containing main.cpp and the Servo library - -You'll see the Servo library is a reusable component including the API documentation to make it easy to use, and the Servo Hello World pulls in this library, only having to worry about what it is going to do with the servo. - -##How to code a library - -A good library has a clear purpose, nice clean interface, and doesn't include the code doing other things - that is what the user's program is for. - -Most libraries actually start as some code that turns out to be useful, is then [re-factored](http://en.wikipedia.org/wiki/Code_refactoring) in to a useful class or set of functions that can be reused in multiple places in a program, and then finally separated out so any program can include and use it. Lets work through an example to see how this might work... - -###Step 1 - Refactoring - -To start with, here is some code I might have ended up with after some programming: - -``main.cpp``: -```c - - #include "mbed.h" - - DigitalOut pin(LED2); - - int main() { - // do something... - - // flash 5 times - for(int i=0; i<10; i++) { - pin = !pin; - wait(0.2); - } - - // do something else - - // flash 2 times - for(int i=0; i<4; i++) { - pin = !pin; - wait(0.2); - } - - // do another thing - - } - -``` - -The program might do what I want, but it is obvious that some of the code is doing very similar things, perhaps as the result of copy-paste of bits I found useful. In this case, it is good practice to re-factor the code so we create a function that can do the flashing for us; define the code in one place, use it in many places. - -So our code might become: - -``main.cpp``: -```c - - #include "mbed.h" - - DigitalOut pin(LED2); - - void flash(int n) { - for(int i=0; i
| Shortcut | Description |
|---|---|
| Hold Ctrl | Interactive mode |
| Shift-Home | Go to beginning of line and select from current position |
| Shift-End | Go to end of line and select from current position |
| Ctrl-Home | Go to beginning of file |
| Ctrl-End | Go to end of file |
| Ctrl-Shift-Home | Go to beginning of file and select from current position |
| Ctrl-Shift-End | Go to end of file and select from current position |
| Shift-PageUp | Scroll a page up and select from current position |
| Shift-PageDown | Scroll a page down and select from current position |
| Shift-Any Arrow | Extend/Reduce text selection |
| Ctrl-Left Arrow | Go to the beginning of previous word |
| Ctrl-Right Arrow | Go to the beginning of next word |
| Ctrl-Up Arrow | Scroll up 1 row |
| Ctrl-Down Arrow | Scroll down 1 row |
-###Ctrl-key sequences - -
| Shortcut | Description |
|---|---|
| Ctrl-A | Select All |
| Ctrl-B | Compile Only (no download prompt) |
| Ctrl-Shift-B | Compile All & Download (clean build) |
| Ctrl-C | Copy(with text selection only) |
| Ctrl-Shift-C | Commit |
| Ctrl-D | Compile & Download |
| Ctrl-Shift-D | Duplicate line |
| Ctrl-E | Erase line (current line) |
| Ctrl-F | Find & Replace |
| Ctrl-Alt-F | Find in Files |
| Ctrl-Shift-F | Format code (text selection or current file) |
| Ctrl-H | Find & Replace |
| Ctrl-K | Find & Replace |
| Ctrl-L | To lower case (with text selection only) |
| Ctrl-R | Revisions History (of current file, single file mode) |
| Ctrl-S | Save (current file) |
| Ctrl-Alt-S | Save As |
| Ctrl-Shift-S | Save All |
| Ctrl-U | To upper case (with text selection only) |
| Ctrl-V | Paste(with text selection only) |
| Ctrl-W | Close (current file, doesn't work on Chrome) |
| Ctrl-Shift-W | Close All (doesn't work on Chrome) |
| Ctrl-X | Cut(with text selection only) |
| Ctrl-Y | Redo |
| Ctrl-Z | Undo |
| Ctrl-/ | Toggle line comment (using slashes) |
| Ctrl-Shift-/ | Toggle block comment (using /* ... */ markup) |
-###Misc - -
| Shortcut | Description |
|---|---|
| Tab | Increase indent of text selection |
| Shift-Tab | Decrease indent of text selection |
| ESC | Close Find or toggle Fullscreen |
| Ins | Toggle Insert Mode |
| Ctrl-Ins | Copy (with text selection only) |
| Shift-Ins | Paste (with text selection only) |
| Shift-Del | Cut (with text selection only) |
| F8 | Compile Only (no download prompt) |
| F9 | Compile & Download |
| F10 | Compile All & Download (clean build) |
-##Touch device shortcuts - -###Editor - -
| Shortcut | Description |
|---|---|
| Single Tap | Move the cursor |
| Double Tap | Text selection on the tapped word (opens context menu) |
| Triple Tap | Text selection on the tapped row (opens context menu) |
| Tap Hold | Context menu |
| Touch-Drag | Text selection until the touch is released (opens context menu) |
-###Compiler IDE - -
| Shortcut | Description |
|---|---|
| Single Tap | Equivalent to single mouse click |
| Double Tap | Equivalent to double mouse click |
| Tap Hold | Equivalent to right click (context menu) |
| Touch-Drag | Equivalent to mouse dragging |
-
\ No newline at end of file diff --git a/docs/Getting_Started/Images/Adding_Platform.png b/docs/Getting_Started/Images/Adding_Platform.png deleted file mode 100644 index e821899215..0000000000 Binary files a/docs/Getting_Started/Images/Adding_Platform.png and /dev/null differ diff --git a/docs/Getting_Started/Images/Blinky/OpeningBlinky.png b/docs/Getting_Started/Images/Blinky/OpeningBlinky.png deleted file mode 100644 index a343b9180d..0000000000 Binary files a/docs/Getting_Started/Images/Blinky/OpeningBlinky.png and /dev/null differ diff --git a/docs/Getting_Started/Images/Blinky/RGB_LEDs.png b/docs/Getting_Started/Images/Blinky/RGB_LEDs.png deleted file mode 100644 index 58808c9843..0000000000 Binary files a/docs/Getting_Started/Images/Blinky/RGB_LEDs.png and /dev/null differ diff --git a/docs/Getting_Started/Images/Board.png b/docs/Getting_Started/Images/Board.png deleted file mode 100644 index 2e139e1588..0000000000 Binary files a/docs/Getting_Started/Images/Board.png and /dev/null differ diff --git a/docs/Getting_Started/Images/Compiler/Compiler1.png b/docs/Getting_Started/Images/Compiler/Compiler1.png deleted file mode 100644 index 145bd232fa..0000000000 Binary files a/docs/Getting_Started/Images/Compiler/Compiler1.png and /dev/null differ diff --git a/docs/Getting_Started/Images/Compiler/Compiler2.png b/docs/Getting_Started/Images/Compiler/Compiler2.png deleted file mode 100644 index 37337dbfa1..0000000000 Binary files a/docs/Getting_Started/Images/Compiler/Compiler2.png and /dev/null differ diff --git a/docs/Getting_Started/Images/Compiler/Compiler3.png b/docs/Getting_Started/Images/Compiler/Compiler3.png deleted file mode 100644 index d9e4d2bc03..0000000000 Binary files a/docs/Getting_Started/Images/Compiler/Compiler3.png and /dev/null differ diff --git a/docs/Getting_Started/Images/Compiler/Compiler4.png b/docs/Getting_Started/Images/Compiler/Compiler4.png deleted file mode 100644 index 307269e41c..0000000000 Binary files a/docs/Getting_Started/Images/Compiler/Compiler4.png and /dev/null differ diff --git a/docs/Getting_Started/Images/Compiler/Compiler5.png b/docs/Getting_Started/Images/Compiler/Compiler5.png deleted file mode 100644 index 58732d1556..0000000000 Binary files a/docs/Getting_Started/Images/Compiler/Compiler5.png and /dev/null differ diff --git a/docs/Getting_Started/Images/Compiler/Compiler6.png b/docs/Getting_Started/Images/Compiler/Compiler6.png deleted file mode 100644 index 15631488dc..0000000000 Binary files a/docs/Getting_Started/Images/Compiler/Compiler6.png and /dev/null differ diff --git a/docs/Getting_Started/Images/Compiler/Compiler7.png b/docs/Getting_Started/Images/Compiler/Compiler7.png deleted file mode 100644 index f6b7fba61e..0000000000 Binary files a/docs/Getting_Started/Images/Compiler/Compiler7.png and /dev/null differ diff --git a/docs/Getting_Started/Images/Compiler/Compiler8.png b/docs/Getting_Started/Images/Compiler/Compiler8.png deleted file mode 100644 index 50da5b2767..0000000000 Binary files a/docs/Getting_Started/Images/Compiler/Compiler8.png and /dev/null differ diff --git a/docs/Getting_Started/Images/Components.png b/docs/Getting_Started/Images/Components.png deleted file mode 100644 index c90990dbc2..0000000000 Binary files a/docs/Getting_Started/Images/Components.png and /dev/null differ diff --git a/docs/Getting_Started/Images/DeviceOnMac.png b/docs/Getting_Started/Images/DeviceOnMac.png deleted file mode 100644 index 3339376429..0000000000 Binary files a/docs/Getting_Started/Images/DeviceOnMac.png and /dev/null differ diff --git a/docs/Getting_Started/Images/IDE_Empty.png b/docs/Getting_Started/Images/IDE_Empty.png deleted file mode 100644 index f5a5c6b656..0000000000 Binary files a/docs/Getting_Started/Images/IDE_Empty.png and /dev/null differ diff --git a/docs/Getting_Started/Images/IDE_Select_Platform.png b/docs/Getting_Started/Images/IDE_Select_Platform.png deleted file mode 100644 index 6ab37f81e0..0000000000 Binary files a/docs/Getting_Started/Images/IDE_Select_Platform.png and /dev/null differ diff --git a/docs/Getting_Started/Images/compile.png b/docs/Getting_Started/Images/compile.png deleted file mode 100644 index 464a5cd912..0000000000 Binary files a/docs/Getting_Started/Images/compile.png and /dev/null differ diff --git a/docs/Getting_Started/Images/fullmbedprocess.png b/docs/Getting_Started/Images/fullmbedprocess.png deleted file mode 100644 index dce5ec07f2..0000000000 Binary files a/docs/Getting_Started/Images/fullmbedprocess.png and /dev/null differ diff --git a/docs/Getting_Started/Images/mbed_Interface.webp b/docs/Getting_Started/Images/mbed_Interface.webp deleted file mode 100644 index ce9d0065e0..0000000000 Binary files a/docs/Getting_Started/Images/mbed_Interface.webp and /dev/null differ diff --git a/docs/Getting_Started/Intro.md b/docs/Getting_Started/Intro.md deleted file mode 100644 index ad298c30d3..0000000000 --- a/docs/Getting_Started/Intro.md +++ /dev/null @@ -1,24 +0,0 @@ -#Working with mbed - -This section will lead you through the process of creating a prototype on an mbed board: - -
-
-
-
-
-The standard process is to get a board (and maybe a few extending components), write a bit of code and import it to the board. Simple.
-
-
-We'll look at the extended process, which includes creating a user and registering a platform. We'll also review our online compiler and show you how to build your first program:
-
-2. [User and platform registration](/Getting_Started/User_Plat_Reg/).
-
-1. [Boards and components](/Introduction/Plat_Comp_Intro/).
-
-3. [Working with the mbed compiler](/Getting_Started/Using_IDE/) and [some shortcuts](/Getting_Started/IDE_Shortcuts/).
-
-4. [Your first program](/Getting_Started/First_Pro/).
-
-5. Where to [get help](/Getting_Started/Questions/).
-
-The program you'll create in this section is called `Blinky`. If you've already set up your IDE and have a board, you can skip ahead to the [Blinky example](/Getting_Started/First_Pro/).
\ No newline at end of file
diff --git a/docs/Getting_Started/Questions.md b/docs/Getting_Started/Questions.md
deleted file mode 100644
index ea59096ca2..0000000000
--- a/docs/Getting_Started/Questions.md
+++ /dev/null
@@ -1,90 +0,0 @@
-#Getting Help
-
-##Where to find answers to questions
-
-You can get answers to most common questions by searching the mbed website.
-
-Places you may find answers to your questions:
-
- * The Handbook - What you're reading now. The 'official' source for information, created and maintained by the mbed team
- * [The Cookbook](http://developer.mbed.org/cookbook/Homepage) - The place for user contributed documentation
- * [The Notebooks](http://developer.mbed.org/notebooks/) - The place for user contributed notes and how-to's which may be useful
- * [The Questions Page](http://developer.mbed.org/questions/) - The place to ask questions. See [below](#questions ) for more info
- * [The Forum](http://developer.mbed.org/forum/) - The place to discuss topics of interest
- * If you'd like to speak to the mbed team - just email us at -A good way to get help with a piece of code that's not working for you is to *Publish* the program. To do this, right click the program in the Compiler and choose Publish. Include the URL returned in your post. -
-This way users can very easily check over your complete program and therefore help you better. - - -##How to report problems or suggestions related to mbed - -You are very welcome to post in the [Bugs and Suggestions forum](http://developer.mbed.org/forum/bugs-suggestions). - -Finally, if you have an urgent problem or wish to discuss something privately, please email
-
diff --git a/docs/Going_Further/Docu.md b/docs/Going_Further/Docu.md
deleted file mode 100644
index af2dd29324..0000000000
--- a/docs/Going_Further/Docu.md
+++ /dev/null
@@ -1,312 +0,0 @@
-#API Documentation
-
-##What is API documentation?
-
-API documentation is a quick and concise reference containing what you need to know to use a library or work with a program. It details functions, classes, return types, and more.
-
-In mbed, API documentation for programs and libraries is fully supported both within the Compiler and in the code listings on the public site.
-
-##Browsing API documentation from within the mbed Compiler
-
-
-
-
-
-Each documentation group contains only the documented definitions for that group as follows:
-
-* Classes - documented classes and methods
-
-* Structs - documented struct and union data types
-
-* Files - documented functions, variables, enums, defines, also references to struct and unions, but no namespaces and classes
-
-* Groups - defined by the author, grouped documentation elements like files, namespaces, classes, functions, variables, enums, typedefs, defines and other groups for quick reference - e.g. [mbed library Device Peripheral Registers](http://developer.mbed.org/users/mbed_official/code/mbed/).
-
-
-**Note:** Classes, methods, functions, etc which exist in the source code but aren't documented won't appear in the documentation.
-
-
-The documentation preview contains references presented as standard links (default in blue) that point to sub-sections of the document or point to other documents, and which once activated would open inside the mbed Compiler.
-
-
-
-
-
-Clicking one of the "Definition at line of file source.c" links would open the definition source file in the Editor (see below). The definition source file can also be opened with "Go to definition" option in the context menu from the navigation tree.
-
-
-
-
-
-Another notable feature of the API documentation in the mbed Compiler is the ability to create new files from documentation examples, making it easier to try them. The mbed Compiler would prompt for file name and may suggest main.cpp as name if it doesn't exist in the program root.
-
-
-**Warning:** The documentation groups and individual documents **do not exist in your workspace**. They are meta navigation items that reflect the API documentation as present in the library home page, and as such they cannot be moved, deleted, renamed, etc.
-
-
-##How to add documentation to your own programs and libraries
-
-The documentation is created out of comment blocks in your code, usually located above declarations and definitions. Let's take the following example:
-
-```c
-
- class HelloWorld {
- public:
- HelloWorld();
- printIt(uint32_t delay = 0);
- };
-```
-
-**First** important thing about documenting a code is to give hint to the documentation system that a comment is intended for documenting, that it's not an ordinary comment. To do that a comment block should start with ``/**`` or ``/*!`` sequences (as opposed to ``/*``), and that comment block should be just above the definition:
-
-```c
-
- /** My HelloWorld class.
- * Used for printing "Hello World" on USB serial.
- */
- class HelloWorld {
- public:
- /** Create HelloWorld instance */
- HelloWorld();
-
- /** Print the text */
- printIt(uint32_t delay = 0);
- };
-```
-
-It's also possible to use single line comments starting with ``///`` or ``//!``.
-
-```c
-
- //! My HelloWorld class. Used for printing "Hello World" on USB serial.
- class HelloWorld {
- public:
- /// Create HelloWorld instance
- HelloWorld();
-
- /// Print the text
- printIt(uint32_t delay = 0);
- };
-```
-
-It requires almost no effort to translate scattered comments in code into well formatted documentation descriptions!
-
-**Second** important thing about the documentation process is the documentation markup to describe parameters and return values, but also to notes, groups, code examples and more.
-Doxygen accepts reserved words prefixed with ``\`` or ``@``, where some of the commonly used are:
-
-* @param Import library
- - - - Public Member Functions -- |
- |
| - - | -
-
- Servo
-
- (PinName pin)
- - Create a servo object connected to the specified PwmOut pin. - - - - |
-
| - void - | -
-
- write
-
- (float percent)
- - Set the servo position, normalised to it's full range. - - - - |
-
| - float - | -
-
- read
-
- - Read the servo motors current position. - - - - |
-
| - void - | -
-
- position
-
- (float degrees)
- - Set the servo position. - - - - |
-
| - void - | -
-
- calibrate
-
- (float range=0.0005, float degrees=45.0)
- - Allows calibration of the range and angles for a particular servo. - - - - |
-
| - - Servo - - & - | -
-
- operator=
-
- (float percent)
- - Shorthand for the write and read functions. - - - - |
-
-Whilst we support exporting your project and the libraries to an alternate toolchain, we cannot guarantee the same consistency as using the mbed Online Compiler. We will do our best to maintain the exported libraries, project file and makefiles, but please understand we can not cover all cases, combinations or provide support for use of these alternate tools themselves! - - - - - - - - - -_______ - - -##uVision - - - -[uVision](http://www.keil.com/uvision|) is one of the external offline toolchains supported by the mbed platform. - -To export your mbed program for use in uVision, right-click the program in your program workspace. From the dialog, you can select the "Export To" as "Keil uVision4", and the target microcontroller you wish to export for. - -When you choose export, a zip file containing all the files you need for uVision will be generated. Unzip it and open the uVision project file ("project.uvproj"): - -After building the project, the binary file (".bin"), ready to be flashed on the mbed, will be generated in the "build" directory. - - - - - - - - -________ - - -##Eclipse IDE - - -[Eclipse](https://eclipse.org/) is a widely-used, open source IDE that supports multiple languages. It is used by many offline toolchains, including [LPCXpresso](http://www.lpcware.com/lpcxpresso) and [Kinetis Design Studio](http://www.freescale.com/webapp/sps/site/prod_summary.jsp?code=KDS_IDE). The setup process for each IDE will vary depending on the distribution; however, the user interface between these distributions will not change much, so these instructions should be easy to apply to all Eclipse-based IDEs. - - - - - -To export your mbed program for use in an Eclipse-based IDE, right-click the program in your program workspace. From the dialog, you can select your desired toolchain for the "Export Toolchain" field. Also, be sure to select the correct target platform under the "Export Target" field. - -When you choose export, a zip file containing all the files you need will be generated. Unzip it anywhere and open your Eclipse-based IDE. - - -**NOTE:** All of the following screenshots will be using a plain Eclipse IDE installation with no embedded development plugins installed. This was done to keep these instructions as general as possible. Your IDE's user interface will most likely not match the -following screenshots exactly, but it should be very similar. - - - - - - -Click File > Import… - - - - - -In the dialog that pops up, under “General”, select “Existing Projects into Workspace” and click Next. - - - - - -Next to the “Select root directory” field, click Browse. In the dialog that pops up, navigate to where you unzipped the downloaded program and select the folder. Hit “OK”. - - - - - -In the “Projects” area, you should see the project name listed. Ensure the checkbox next to it is checked. Hit “Finish”. - -Now your project should appear in the "Project Explorer" on the left side of the IDE. - -After the build, your binary will be generated in the "Release", or "Debug" directory, depending on the selected configuration. - -______ - - -##Make - - - -> "[GNU Make](http://www.gnu.org/software/make/) is a tool which controls the generation of executables and other non-source files of a program from the program's source files." -> ->(Taken verbatim from the GNU Make website). - -Make itself does not compile source code. It relies on a compiler like [GCC ARM Embedded](https://launchpad.net/gcc-arm-embedded) or [Code Sourcery (Sourcery CodeBench)](http://www.mentor.com/embedded-software/sourcery-tools/sourcery-codebench/overview/). Sourcery CodeBench is a paid tool and can be purchased on the [Mentor](http://www.mentor.com/) website. GCC ARM Embedded can be installed for free using instructions found [here](http://gnuarmeclipse.livius.net/blog/toolchain-install/). - - - -**Warning:** The current Makefile requires that your compiler is added to your PATH variable. This contradicts the instruction given on the installation website because those instructions are intended for Eclipse, not Make. - - - - - - -To export your mbed program for use in Make, right-click the program in your program workspace. From the dialog, you can select your desired compiler under the "Export Toolchain" field. Also, be sure to select the correct target platform under the "Export Target" field. - -When you choose export, a zip file containing all the files you need for Make will be generated. Unzip it and you are ready to launch make: - -```c - - $ cd /my/program/directory/ - $ ls - main.cpp Makefile mbed mbed.lib - - $ make - arm-none-eabi-g++ -c -Os -fno-common -fmessage-length=0 -Wall -fno-exceptions -mcpu=cortex-m3 -mthumb -ffunction-sections -fdata-sections -DTARGET_LPC1768 - DTOOLCHAIN_GCC_CS -DNDEBUG -std=gnu++98 -I./mbed -I./mbed/LPC1768 -I./mbed/LPC1768/GCC_CS -o main.o main.cpp - arm-none-eabi-gcc -mcpu=cortex-m3 -mthumb -Wl,--gc-sections -Tmbed/LPC1768/GCC_CS/LPC1768.ld -L./mbed -L./mbed/LPC1768 -L./mbed/LPC1768/GCC_CS -o my_program.elf main.o mbed/LPC1768/GCC_CS/startup_LPC17xx.o mbed/LPC1768/GCC_CS/sys.o mbed/LPC1768/GCC_CS/cmsis_nvic.o mbed/LPC1768/GCC_CS/c ore_cm3.o mbed/LPC1768/GCC_CS/system_LPC17xx.o -lmbed -lcapi -lstdc++ -lsupc++ -lm -lc -lgcc -lmbed -lcapi -lstdc++ -lsupc++ -lm -lc -lgcc - arm-none-eabi-objcopy -O binary my_program.elf my_program.bin - - $ ls - main.cpp main.o Makefile mbed mbed.lib my_program.bin my_program.elf -``` - -The binary file ``.bin`` is ready to be flashed on the mbed. - -_______ - - -##IAR - - - -The [IAR Embedded Workbench](http://www.iar.com/en/Products/IAR-Embedded-Workbench/) is one of the external offline toolchains supported by the mbed platform. - - -**Warning:** The support for the IAR toolchain has been added very recently (Jan 2013), if you are trying to export an old project make sure to update the mbed library to the latest build first. - - -To export your mbed program for use in the IAR Embedded Workbench, right-click the program in your program workspace. From the dialog, you can select the "Export To" as "IAR Systems", and the target microcontroller you wish to export for (currently, only the LPC1768 is supported): - - - - - -When you choose export, a zip file containing all the files you need for the IAR Embedded Workbench will be generated. Unzip it and open the IAR Embedded Workbench workspace file ``.eww``. - -After building the project, the binary file ``.bin``, ready to be flashed on the mbed, will be generated in the "Debug\Exe" directory: - - - - \ No newline at end of file diff --git a/docs/Going_Further/Intro.md b/docs/Going_Further/Intro.md deleted file mode 100644 index 9c3a37eefa..0000000000 --- a/docs/Going_Further/Intro.md +++ /dev/null @@ -1 +0,0 @@ -#Intro \ No newline at end of file diff --git a/docs/Going_Further/Lib_Internals.md b/docs/Going_Further/Lib_Internals.md deleted file mode 100644 index 06272a32d4..0000000000 --- a/docs/Going_Further/Lib_Internals.md +++ /dev/null @@ -1,439 +0,0 @@ -#mbed Library Internals - -This document describes the internals of the mbed library. It should be helpful for: -* Porting the mbed library to a new microcontroller -* Adding a driver for a new peripheral -* Providing support for a new toolchain - -This document assumes that you are familiar with the C Programming Language, but it does not assume a deep knowledge of microcontrollers. - -##Design Overview - -The mbed library provides abstractions for the microcontroller (MCU) hardware (in particular drivers for the MCU peripherals) and it is divided in the following software layers and APIs: - - - - - -To port the mbed library to a new microcontroller you will have to provide the two software layers marked as "MCU dependent" in the above diagram. - -To present the role of each of these layers in a peripheral driver, we will show how the driver for the General Purpose Input/Output (GPIO) for the LPC1768 is structured, from the bottom up. For each layer we will also provide an implementation of the same simple example application: the toggling of an LED ("blinky"). - -###mbed library sources in the online IDE - - -If you need to edit the mbed library, you can delete the binary build of the mbed library from your project and [import its sources](http://developer.mbed.org/users/mbed_official/code/mbed-src/). - - -###Directory Structure - -In the image below you can see the directory structure of the sources constituting the mbed library as they are published on the official [mbed github repository](https://github.com/mbedmicro/mbed). - -Three target independent directories: - -* ``mbed/api``: The headers defining the actual mbed library API - -* ``mbed/common``: mbed common sources - -* ``mbed/hal``: The HAL API to be implemented by every target - -Two target dependent directories: - -* ``mbed/targets/hal``: The HAL implementations - -* ``mbed/targets/cmsis``: CMSIS-CORE sources - - - - - -##MCU Registers - -###Peripherals - -If you come from a software background and you want to understand the behaviour of a microcontroller peripheral using a software analogy, you can think of a peripheral like a software thread being executed by a separate core. You have only one communication channel with this thread: a shared area of memory. Each single addressable byte of this area of memory, used to communicate with the hardware, is called: register. You communicate with the peripherals writing and reading these registers. - -###LPC17xx GPIO - -Silicon Vendors, like NXP, provide detailed user manuals describing the registers of each peripheral. - -This is a page from the [|LPC17xx user manual](http://www.nxp.com/documents/user_manual/UM10360.pdf describing the registers of the GPIO peripheral: - - - - - -###Blinky example poking registers - -Let's see how to blink an LED on our LPC1768 mbed simply poking these registers: - - - - - - - - - -```c - - #include "mbed.h" - - // Reuse initialization code from the mbed library - DigitalOut led1(LED1); // P1_18 - - int main() { - unsigned int mask_pin18 = 1 << 18; - - volatile unsigned int *port1_set = (unsigned int *)0x2009C038; - volatile unsigned int *port1_clr = (unsigned int *)0x2009C03C; - - while (true) { - *port1_set |= mask_pin18; - wait(0.5); - - *port1_clr |= mask_pin18; - wait(0.5); - } - } -``` - - -##CMSIS-CORE - -The [CMSIS-CORE](http://www.arm.com/products/processors/cortex-m/cortex-microcontroller-software-interface-standard.php) headers provide you a suitable data structure to access these low level registers: - -```c - - typedef struct { - __IO uint32_t FIODIR; - uint32_t RESERVED0[3]; - __IO uint32_t FIOMASK; - __IO uint32_t FIOPIN; - __IO uint32_t FIOSET; - __O uint32_t FIOCLR; - } LPC_GPIO_TypeDef; - - #define LPC_GPIO_BASE (0x2009C000UL) - - #define LPC_GPIO0 ((LPC_GPIO_TypeDef *) (LPC_GPIO_BASE + 0x00000)) - #define LPC_GPIO1 ((LPC_GPIO_TypeDef *) (LPC_GPIO_BASE + 0x00020)) - #define LPC_GPIO2 ((LPC_GPIO_TypeDef *) (LPC_GPIO_BASE + 0x00040)) - #define LPC_GPIO3 ((LPC_GPIO_TypeDef *) (LPC_GPIO_BASE + 0x00060)) - #define LPC_GPIO4 ((LPC_GPIO_TypeDef *) (LPC_GPIO_BASE + 0x00080)) -``` - -As you can see the ``LPC_GPIO_TypeDef`` structure is a one to one map of its related GPIO port 32 bytes registers: - -```c - - FIODIR : 4 bytes - RESERVED0: 12 bytes - FIOMASK : 4 bytes - FIOPIN : 4 bytes - FIOSET : 4 bytes - FIOCLR : 4 bytes - tot : 32 bytes = 0x20 bytes -``` - -For example, in the GPIO documentation you can read that the address of the FIOPIN register of port 1 is: ``0x2009C034``. - -We can point the content of that location using the ``LPC_GPIO_TypeDef`` like that: - -```c - - #include "mbed.h" - - int main() { - printf("LPC_GPIO1->FIOSET: %p\n", &LPC_GPIO1->FIOSET); - } -``` - -The above program will print: - -```c - - LPC_GPIO1->FIOSET: 2009c038 -``` - -###Blinky example using CMSIS-CORE - -Let's see how to blink an LED on our LPC1768 mbed using the CMSIS-CORE API: - -```c - - #include "mbed.h" - - // Reuse initialization code from the mbed library - DigitalOut led1(LED1); // P1_18 - - int main() { - unsigned int mask_pin18 = 1 << 18; - - while (true) { - LPC_GPIO1->FIOSET |= mask_pin18; - wait(0.5); - - LPC_GPIO1->FIOCLR |= mask_pin18; - wait(0.5); - } - } - -``` - -###mbed additions to CMSIS-CORE - -The mbed library provides certain additions to the CMSIS-CORE layer: - -* startup file for each of the [Supported Toolchains](/Going_Further/Export/) - -* linker file and support functions to define the [Memory Map](/Going_Further/Mem_Mo/) - -* functions to set and get Interrupt Service Routines (ISR) addresses from the [Nested Vectored Interrupt Controller (NVIC)](http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.dui0552a/BABEDCBC.html) and to program [Vector Table Offset Register (VTOR)](http://infocenter.arm.com/help/index.jsp?topic=/com.arm.doc.dui0552a/Ciheijba.html). - -##mbed HAL API - -###Target independent API - -The target independent HAL API is our foundation for the mbed target independent library. This is the GPIO HAL API: - -```c - - typedef struct gpio_s gpio_t; - - void gpio_init (gpio_t *obj, PinName pin, PinDirection direction); - - void gpio_mode (gpio_t *obj, PinMode mode); - void gpio_dir (gpio_t *obj, PinDirection direction); - - void gpio_write(gpio_t *obj, int value); - int gpio_read (gpio_t *obj); -``` - - -**Warning:** The HAL API is an internal interface used to help porting the mbed library to a new target and it is subject to change. If you want to "future proof" your application avoid using this API and use the mbed API instead. - - -###Target dependent implementation - -The implementation of the mbed HAL API should encapsulate all the required target dependent code. - -There are multiple ways to implement such API, with different trade-offs. In our implementation for the LPC family of processors (LPC2368, LPC1768, LPC11U24) we decided to keep all the differences among these processors in the GPIO object initialization keeping all the GPIO "methods" small, fast and target independent. Additionally, for speed optimization, we allow the GPIO functions to be completely inlined by the compiler. - -In this document, to have a clear presentation of the code, we are removing the preprocessor directives for target conditional code and we are grouping together function definitions from multiple sources (``.c`` and ``.h``): - -```c - - struct gpio_s { - PinName pin; - uint32_t mask; - - __IO uint32_t *reg_dir; - __IO uint32_t *reg_set; - __IO uint32_t *reg_clr; - __I uint32_t *reg_in; - }; - - void gpio_init(gpio_t *obj, PinName pin, PinDirection direction) { - if(pin == NC) return; - - obj->pin = pin; - obj->mask = gpio_set(pin); - - LPC_GPIO_TypeDef *port_reg = (LPC_GPIO_TypeDef *) ((int)pin & ~0x1F); - - obj->reg_set = &port_reg->FIOSET; - obj->reg_clr = &port_reg->FIOCLR; - obj->reg_in = &port_reg->FIOPIN; - obj->reg_dir = &port_reg->FIODIR; - - gpio_dir(obj, direction); - switch (direction) { - case PIN_OUTPUT: pin_mode(pin, PullNone); break; - case PIN_INPUT : pin_mode(pin, PullDown); break; - } - } - - void gpio_mode(gpio_t *obj, PinMode mode) - pin_mode(obj->pin, mode); - } - - void gpio_dir(gpio_t *obj, PinDirection direction) { - switch (direction) { - case PIN_INPUT : *obj->reg_dir &= ~obj->mask; break; - case PIN_OUTPUT: *obj->reg_dir |= obj->mask; break; - } - } - - void gpio_write(gpio_t *obj, int value) { - if (value) - *obj->reg_set = obj->mask; - else - *obj->reg_clr = obj->mask; - } - - int gpio_read(gpio_t *obj) { - return ((*obj->reg_in & obj->mask) ? 1 : 0); - } -``` - -###mbed internal conventions - -As a practical convention, the ``PinName`` enum definition for each target contains information for both the ``port`` and the ``pin number``. How this information is stored can be target dependent. - -For example, in the LPC1768 a ``PinName`` entry is the ``port address`` plus the ``pin number`` stored in the rightmost 5 bits. To extract the port address from an LPC1768 ``PinName`` we simply have to create a mask ignoring the rightmost 5 bits: - -```c - - LPC_GPIO_TypeDef *port_reg = (LPC_GPIO_TypeDef *) ((int)pin & ~0x1F); -``` - -##mbed API - -The mbed API is providing the actual friendly, object oriented API to the final user. This is the API used by the majority of the programs developed on the mbed platform. - -We also define basic operators to provide intuitive casting to primitive types and assignments: - - -```c - - class DigitalInOut { - - public: - DigitalInOut(PinName pin) { - gpio_init(&gpio, pin, PIN_INPUT); - } - - void write(int value) { - gpio_write(&gpio, value); - } - - int read() { - return gpio_read(&gpio); - } - - void output() { - gpio_dir(&gpio, PIN_OUTPUT); - } - - void input() { - gpio_dir(&gpio, PIN_INPUT); - } - - void mode(PinMode pull) { - gpio_mode(&gpio, pull); - } - - DigitalInOut& operator= (int value) { - write(value); - return *this; - } - - DigitalInOut& operator= (DigitalInOut& rhs) { - write(rhs.read()); - return *this; - } - - operator int() { - return read(); - } - - protected: - gpio_t gpio; - }; -``` - -###Blinky example using the mbed API - -This is the final, microcontroller independent, GPIO abstraction provided by the mbed library: - -```c - - #include "mbed.h" - - DigitalOut led1(LED1); - - int main() { - while (true) { - led1 = 1; - wait(0.5); - - led1 = 0; - wait(0.5); - } - } -``` - -##C library retargeting - -The C standard library stdio module provides many functions for file input and output. - -The C standard library implementations provided by the various toolchains give the possibility to customise how these input/output are named and redirected. This customization is often called "C library retargeting". - -The mbed library defines this C library retargeting in this file: ``mbed/src/common/stdio.cpp``. - -This is an excerpt of the retargeting of (stdout, stdin and stderr) to an UART: - -```c - - #if DEVICE_SERIAL - extern int stdio_uart_inited; - extern serial_t stdio_uart; - #endif - - static void init_serial() { - #if DEVICE_SERIAL - if (stdio_uart_inited) return; - serial_init(&stdio_uart, STDIO_UART_TX, STDIO_UART_RX); - serial_format(&stdio_uart, 8, ParityNone, 1); - serial_baud(&stdio_uart, 9600); - #endif - } - - extern "C" FILEHANDLE PREFIX(_open)(const char* name, int openmode) { - /* Use the posix convention that stdin,out,err are filehandles 0,1,2. - */ - if (std::strcmp(name, __stdin_name) == 0) { - init_serial(); - return 0; - } else if (std::strcmp(name, __stdout_name) == 0) { - init_serial(); - return 1; - } else if (std::strcmp(name,__stderr_name) == 0) { - init_serial(); - return 2; - } - [...] - - #if defined(__ICCARM__) - extern "C" size_t __write (int fh, const unsigned char *buffer, size_t length) { - #else - extern "C" int PREFIX(_write)(FILEHANDLE fh, const unsigned char *buffer, unsigned int length, int mode) { - #endif - int n; // n is the number of bytes written - if (fh < 3) { - #if DEVICE_SERIAL - if (!stdio_uart_inited) init_serial(); - for (unsigned int i = 0; i < length; i++) { - serial_putc(&stdio_uart, buffer[i]); - } - #endif - n = length; - } else { - [...] - - #if defined(__ICCARM__) - extern "C" size_t __read (int fh, unsigned char *buffer, size_t length) { - #else - extern "C" int PREFIX(_read)(FILEHANDLE fh, unsigned char *buffer, unsigned int length, int mode) { - #endif - int n; // n is the number of bytes read - if (fh < 3) { - // only read a character at a time from stdin - #if DEVICE_SERIAL - *buffer = serial_getc(&stdio_uart); - #endif - n = 1; - } else { - [...] -``` diff --git a/docs/Going_Further/Mem_Mo.md b/docs/Going_Further/Mem_Mo.md deleted file mode 100644 index f3ebc63150..0000000000 --- a/docs/Going_Further/Mem_Mo.md +++ /dev/null @@ -1,111 +0,0 @@ -#The mbed Memory Model - - -This is a basic overview of the memory model used by mbed. - -##Microcontroller Memory - -A single-chip microcontroller contains two types of memory: - -[FLASH](http://en.wikipedia.org/wiki/Flash_memory) - This is the [non-volatile](http://en.wikipedia.org/wiki/Non-volatile_memory) memory that primarily stores the program's instructions, and also any "constant" data values. In general, you only read from this memory, and it is only written when you download new code to the mbed. - -[RAM](http://en.wikipedia.org/wiki/Static_random_access_memory) - This is the [volatile](http://en.wikipedia.org/wiki/Volatile_memory) memory that is the working data space for storing all variables whilst the program is running. In C, this is static variables, the heap, and the stack. - -RAM is therefore much more scarce and valuable than FLASH, so it is worth understanding a little about the memory model to help make best use of the memory. - -[EEPROM](http://en.wikipedia.org/wiki/EEPROM) - Some microcontrollers have special non-volatile memory that can be erased and written byte for byte rather than in blocks or sectors. This memory is typically used by the application to store special data or configuration. This memory requires special access by a peripheral and is not directly addressable. - -##C Memory Model - -The C runtime memory model can be divided in to three types; global/static memory, the heap, and the stack. These all share the RAM available on the microcontroller. - -###Global/static memory - -Global and static memory are values that are allocated for the entire lifetime of the program. For example: - -```c - - int x = 5; - int main() {} -``` - -Here, "x" would be allocated a dedicated slot in RAM, that is never used by anything else. In this case it is initialised to 5, and it's value might be changed throughout the lifetime of the program. - -If for some reason you have data that is fixed (such as a lookup table), you'd be much better off making sure the compiler can allocate it in FLASH to save valuable RAM space. In the previous example, we could use the C keyword "const" to tell the compiler the variable will never be changed: - -```c - - const int x = 5; - int main() {} -``` - -###The Stack - -The [Stack](http://en.wikipedia.org/wiki/Stack_(data_structure)) is used to store types of variables that have a fixed lifetime based on how C programs run. It is a section of RAM that grows and shrinks as the program runs. When you call a function, its parameters and any variables you have defined in that function (which are not static) are stored on the stack. - -```c - - void foo() { - int x; - } - int main() {} -``` - -In this example, "x" will only exist for the duration of the call to foo(). As you start calling functions from within other functions, your stack grows downwards. As you return back up the call tree, your stack decreases in size. - -###The Heap - -The heap is used for [dynamic memory allocation](http://en.wikipedia.org/wiki/Dynamic_memory_allocation). When you create a new instance of an object using 'new', or if you allocate a block of memory using malloc and friends, you use memory in the heap. - -```c - - int *p; - int main() { - p = new int; - } -``` - -If there is a piece of unused memory in the heap which is big enough for what you need, then that is used. If there is not, then the heap grows upwards to fit the new instance/memory block. When you use delete or free, the memory it was using inside the heap is deallocated, ready for use again. However, unless the memory you released was at the very end of the heap, the heap does not shrink. - -##Memory Sections - -The information in your program is made up of several sorts based on the memory model: - -* Executable code -* Constants and other read-only data -* Initialised global/static variables -* Uninitialised global/static variables -* Local variables -* Dynamically created data - -Each of these groups get allocated to a region of the memory space called a section. - -The executable code, constants and other read-only data get put in a section called "RO" (for read-only), which is stored in the FLASH memory of the device. Initialised static and global variables go into a section called "RW" (read-write), and the uninitialised ones in to one called "ZI" (Zero Initialise). I'll come on to the local and dynamic data in a bit, but these along with RW and ZI need to live in RAM. - -On reset, the RAM is an undefined state and those initialised variables have to be setup for your program to work correctly. This setup is actually part of your program binary, as the compiler automatically inserts some housework code before main() as part of setting up the C environment which copies from FLASH to RAM what these variables should be initialised to; this becomes the runtime RW section. One of the other things it does is to zero fill the next section of RAM, which is where the ZI section lives. - - - - - -###Heap and Stack - -The last two sorts of information are the local variables which will exist on the stack, and the dynamically created data which will exist in the heap. - -The sizes of these two regions vary during program execution, and only have fixed starting points. We use the single memory space shared stack/heap model which allows flexibility in the size of each, limited only by our available RAM. What this means is that the heap starts at the first address after the end of ZI, growing up into higher memory addresses, and the stack starts at the last memory address of RAM, and grows downwards into lower memory addresses: - - - - - -###Collisions - -Obviously, looking at this, it is possible to for your heap and stack to collide, which is never going to end well! If that happens, you have hit the limit of your RAM, and need to find out ways to help ensure your program uses less memory. - -To try and help you prevent detect when this would happen, the routines that allocate memory on the heap (new, malloc and friends) tell you when you don't have enough memory. Instead of passing you a pointer to the newly allocated block, they pass you the value NULL. - -If your stack and your heap do collide, despite your best efforts, then the results will be unpredictable. You may get data corruption, or you may get a hard fault. You can write a hard fault handler and/or implement a watchdog to recover from some of these faults, but you basically have to restart the system! - - -Also see the [RTOS Memory Model](/Going_Further/RTOS_Mem/). - \ No newline at end of file diff --git a/docs/Going_Further/RTOS_Mem.md b/docs/Going_Further/RTOS_Mem.md deleted file mode 100644 index c50c6d3f24..0000000000 --- a/docs/Going_Further/RTOS_Mem.md +++ /dev/null @@ -1,24 +0,0 @@ -#RTOS Memory Model - -This is a basic overview of the memory model used by the mbed RTOS. - -##Threads - -Each thread of execution in the RTOS has its separate stack. - -When you use the RTOS, before explicitly initializing any additional thread, you will have 4 separate stacks: - -* The stack of the ``Main Thread`` (executing the ``main`` function). -* The ``Idle Thread`` executed each time all the other threads are waiting for external, or scheduled events. This is particularly useful to implement energy saving strategies. (ie ``sleep``). -* The ``Timer Thread`` that executes all the time scheduled tasks (periodic and non periodic). -* The stack of ``OS Scheduler`` itself (also used by the ISRs). - - - - - - - -Also see the [the mbed Memory Model](/Going_Further/Mem_Mo/). - - diff --git a/docs/Going_Further/SDK_Porting.md b/docs/Going_Further/SDK_Porting.md deleted file mode 100644 index c27f422da6..0000000000 --- a/docs/Going_Further/SDK_Porting.md +++ /dev/null @@ -1,300 +0,0 @@ -#mbed SDK Porting - -The porting of the mbed SDK to a new target is divided in four steps: - -* Add the new target to the build system -* Add a CMSIS module for the given target -* Implement the mbed HAL API for the given target -* Validate the new target with the test suite - -The source code of the mbed SDK (tools + libraries) is available in [this repository](https://github.com/mbedmicro/mbed). - -Before starting the mbed SDK porting, you might want to familiarize with the [mbed library internals](Going_Further/Lib_Internals/) first. - -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). - -##Coding style - -mbed SDK coding style is described in detail in mbed SDK team's wiki page, please visit for further details [mbed SDK coding style](/Going_Further/Coding_Style/). - -##Build System - -You can get an introduction about the mbed SDK command line tools, from a user perspective, reading the [mbed-tools handbook page](/Going_Further/Tools/). - -Adding a new target to the build system is as easy as adding a new ``Target`` class to this python module: [workspace_tools/targets.py](https://github.com/mbedmicro/mbed/blob/master/workspace_tools/targets.py). - -For example, this is the Target class for the LPC1768: - -```python - - class LPC1768(Target): - def __init__(self): - Target.__init__(self) - - self.core = "Cortex-M3" - - self.extra_labels = ['LPC176X'] - - self.supported_toolchains = ["ARM", "GCC_ARM", "GCC_CS", "GCC_CR", "IAR"] -``` - -An instance of this new ``Target`` class has to be added to the ``TARGETS`` list: - -```python - - TARGETS = [ - LPC2368(), - LPC1768(), - LPC11U24(), - KL25Z(), - LPC812(), - LPC4088(), - LPC4330(), - ] -``` - -The target and toolchain specified for a given build define a set of ``TARGET_`` and ``TOOLCHAIN_`` "labels". For example: - -``` - - Targets: - * LPC1768 : ['TARGET_LPC1768', 'TARGET_M3', 'TARGET_LPC176X'] - * LPC11U24: ['TARGET_LPC11U24', 'TARGET_M0', 'TARGET_LPC11UXX'] - * KL25Z : ['TARGET_KL25Z', 'TARGET_M0P'] - - Toolchains: - * ARM : ['TOOLCHAIN_ARM_STD', 'TOOLCHAIN_ARM'] - * uARM : ['TOOLCHAIN_ARM_MICRO', 'TOOLCHAIN_ARM'] - * GCC_ARM: ['TOOLCHAIN_GCC_ARM', 'TOOLCHAIN_GCC'] - * IAR : ['TOOLCHAIN_IAR'] -``` - -When the build system scans for resources to be compiled, it filters out all the ``TARGET_`` and ``TOOLCHAIN_`` directories that are not in the set of "labels" defined by the current build. - - -**IDE:** You can develop the code for adding support for a new target in you favourite IDE. As a starting point, you can export the following program to one of the supported [offline toolchains](Going_Further/Export/): [Hello World using the mbed library sources](http://developer.mbed.org/users/mbed_official/code/mbed-src-program/). - - -##CMSIS Module - -Each target has its standalone CMSIS directory under its vendor directory, for example: - -* [libraries/mbed/targets/cmsis/Freescale/TARGET_KL25Z](https://github.com/mbedmicro/mbed/blob/master/libraries/mbed/targets/cmsis/Freescale/TARGET_KL25Z). -* [libraries/mbed/targets/cmsis/NXP/TARGET_LPC176X](https://github.com/mbedmicro/mbed/blob/master/libraries/mbed/targets/cmsis/NXP/TARGET_LPC176X). - -###CMSIS Sources - -There are three sources for a "cmsis" module used by an mbed target. - -The ARM CMSIS-CORE module is providing the files that are specific to the Cortex-M cores: - -* ``core_cmFunc.h`` -* ``core_cmInstr.h`` -* ``cortex_cm0.h`` / ``cortex_cm0plus.h`` / ``core_cm3.h`` / ``cortex_cm4.h`` - -The Silicon Vendor is providing the files for the startup, system initialization, the structures and addressed of the peripherals registers, for a given DEVICE: - -* ``startup_DEVICE.s`` -* ``system_DEVICE.c`` -* ``system_DEVICE.h`` -* ``DEVICE.h`` - -The mbed SDK has to provide additional files to dynamically set the vector table and to configure the [memory model](/Going_Further/Mem_Mo/) for the given C standard library: - -* ``cmsis_nvic.c`` -* ``cmsis_nvic.h`` -* ``sys.cpp`` -* ``TARGET.sct`` -* ``cmsis.h`` - - -**Info: CMSIS sources** -Usually, silicon vendors provide source packages containing both the CMSIS-CORE and the CMSIS device specific files. - - -##mbed HAL - -Each target does have a standalone directory containing the implementation of the mbed HAL API, for example: - -* [libraries/mbed/targets/hal/Freescale/TARGET_KL25Z](https://github.com/mbedmicro/mbed/blob/master/libraries/mbed/targets/hal/Freescale/TARGET_KL25Z). -* [libraries/mbed/targets/hal/NXP/TARGET_LPC176X](https://github.com/mbedmicro/mbed/blob/master/libraries/mbed/targets/hal/NXP/TARGET_LPC176X). - -Probably the most important file, at the beginning of a port to a new target, is [device.h](https://github.com/mbedmicro/mbed/blob/master/libraries/mbed/targets/hal/NXP/TARGET_LPC176X/device.h). - -``device.h`` contains all the defines that enable/disable the inclusion of a certain set of peripherals in the mbed library. - -When you start a port for a new target, setting all these defines to ``0`` will quickly allow you to compile the whole mbed library and start running tests. - -Currently, the bare minimum you should implement to start running the first tests is: - -* [GPIO API](https://github.com/mbedmicro/mbed/blob/master/libraries/mbed/hal/gpio_api.h) -* [us ticker API](https://github.com/mbedmicro/mbed/blob/master/libraries/mbed/hal/us_ticker_api.h): - * ``void us_ticker_init(void);`` - * ``uint32_t us_ticker_read(void)`` - -Having this initial block in place will allow you to run simple programs like the mbed ``hello world``: - - -```c - - #include "mbed.h" - - DigitalOut myled(LED1); - - int main() { - while(1) { - myled = 1; - wait(0.2); - myled = 0; - wait(0.2); - } - } -``` - -This is the full list of the mbed drivers API that could be potentially implemented for a target: - -* [analogin_api.h](https://github.com/mbedmicro/mbed/tree/master/libraries/mbed/hal/analogin_api.h) -* [analogout_api.h](https://github.com/mbedmicro/mbed/tree/master/libraries/mbed/hal/analogout_api.h) -* [can_api.h](https://github.com/mbedmicro/mbed/tree/master/libraries/mbed/hal/can_api.h) -* [ethernet_api.h](https://github.com/mbedmicro/mbed/tree/master/libraries/mbed/hal/ethernet_api.h) -* [gpio_api.h](https://github.com/mbedmicro/mbed/tree/master/libraries/mbed/hal/gpio_api.h) -* [gpio_irq_api.h](https://github.com/mbedmicro/mbed/tree/master/libraries/mbed/hal/gpio_irq_api.h) -* [|i2c_api.h](https://github.com/mbedmicro/mbed/tree/master/libraries/mbed/hal/i2c_api.h) -* [pinmap.h](https://github.com/mbedmicro/mbed/tree/master/libraries/mbed/hal/pinmap.h) -* [port_api.h](https://github.com/mbedmicro/mbed/tree/master/libraries/mbed/hal/port_api.h) -* [pwmout_api.h](https://github.com/mbedmicro/mbed/tree/master/libraries/mbed/hal/pwmout_api.h) -* [rtc_api.h](https://github.com/mbedmicro/mbed/tree/master/libraries/mbed/hal/rtc_api.h) -* [serial_api.h](https://github.com/mbedmicro/mbed/tree/master/libraries/mbed/hal/serial_api.h) -* [sleep_api.h](https://github.com/mbedmicro/mbed/tree/master/libraries/mbed/hal/sleep_api.h) -* [spi_api.h](https://github.com/mbedmicro/mbed/tree/master/libraries/mbed/hal/spi_api.h) -* [us_ticker_api.h](https://github.com/mbedmicro/mbed/tree/master/libraries/mbed/hal/us_ticker_api.h) - -##Testing - -The mbed SDK provides a test system to validate the addition of your new target. - -You may want to familiarize with the command line interface and structure of the test system reading the [mbed-tools handbook page](/Going_Further/Tools/#test-system). - -The description of the tests aimed at validating the mbed SDK are prefixed with the string ``MBED:``. - - -**Warning:** You will need to edit the source code of many of the tests adding, under conditional compilation, the pinout of your new target board. - - - -**Warning:** Not all the tests are yet automated presenting a clear ``{success}` or ``{failure}`` result string. Some of the tests still require additional instrumentation like a logic analyser and human intervention to verify the output. - - -###Smoke Test - -``[ 0] MBED: Basic`` is the first [smoke test](http://en.wikipedia.org/wiki/Smoke_testing#Software_development) that represents the basis to execute all the other tests in the mbed SDK suite. - -```c - - #include "test_env.h" - - int main() { - notify_completion(true); - } -``` - -This is an example command line test run: - -``` - - mbed> python workspace_tools\make.py -m LPC1768 -t ARM -s COM41 -d E:\ -p 0 - - >>> BUILD PROJECT: BASIC (LPC1768, ARM) - Compile: main.cpp - Compile: test_env.cpp - Link: basic - Elf2Bin: basic - Image: C:/Users/emimon01/mbed/build\test\LPC1768\ARM\MBED_A1\basic.bin - {success} - {end} -``` - -###C/C++ environment initialization - -* ``MBED: Heap & Stack`` - setting of the single area memory model with heap and stack collision detection. -* ``MBED: C++`` - initialization of static C++ objects - -##Digital I/O and IRQ - -For this set of tests you will need to connect together a pair of pins: - -* ``MBED: DigitalInOut`` - Setting digital I/O functionality, direction and value. -* ``MBED: InterruptIn`` - Triggering and handling of GPIO IRQs - -###Timing functionalities - -For this set of functionalities it is preferable to use a logic analyser to verify the correctness of the time intervals. Ideally the following tests should be repeated changing the time periods across a wide time interval (from micro-seconds, to seconds): - -* ``MBED: Time us`` - simple us_ticker init/read functionality -* ``MBED: Ticker 2`` - correct triggering of timing events - -###PWM - -For this set of functionalities it is preferable to use a logic analyser to verify the correctness of the time intervals. Ideally the following tests should be repeated changing the time periods across a wide time interval (from micro-seconds, to seconds): - -* ``MBED: PWM`` - PWM - -###I2C - -The I2C tests require the wiring of additional peripherals: - -* ``MBED: I2C TMP102`` - [TMP102 Temperature Sensor](http://developer.mbed.org/cookbook/TMP102-Temperature-Sensor) -* ``MBED: I2C MMA7660`` - [MMA7660 Accelerometer](http://developer.mbed.org/cookbook/MMA7660-Accelerometer) -* ``MBED: I2C SRF08`` - [SRF08 Ultrasonic Ranger](http://developer.mbed.org/cookbook/SRF08-Ultrasonic-Ranger) - -###SPI - -The SPI tests require the wiring of additional peripherals: - -* ``MBED: SPI ADXL345`` - See [ADXL345 Accelerometer](http://developer.mbed.org/cookbook/ADXL345-Accelerometer) -* ``MBED: SD File System`` - See [SDFileSystem](http://developer.mbed.org/handbook/SDFileSystem) - -###UART - -The basic UART functionalities are used to communicate the results of all the other test, but the following tests are stressing some of the other UART APIs: - -* ``MBED: Serial Echo at 115200`` - change baud rate to 115200 and test transmission -* ``MBED: Serial Interrupt`` and ``MBED: Serial Interrupt 2`` - serial tx/rx interrupt handlers - -###ADC/DAC - -This test relies on a connection among one ADC pin and one DAQ pin on the same target: - -* ``MBED: Analog`` - -###Port - -Testing the Port API requires connecting at least a couple of pins from a port to a couple of pins in another port: - -* ``MBED: PortInOut`` - -### RTC - -* ``MBED: RTC`` - -###Sleep - -* ``MBED: Sleep`` -* ``MBED: Sleep Timeout`` - -###Semihosting - -The following tests are used to verify the semihosting functionalities that may be provided by the "mbed interface" - -* ``MBED: semihost file system`` - Local file system -* ``MBED: Semihost`` - mbed unique ID -* ``MBED: SW Reset`` - request to the interface chip a complete reset - -##Contributing - -To contribute your new target to the official mbed SDK: - -* Open a [pull request](https://help.github.com/articles/using-pull-requests) to the [official mbed SDK repository](https://github.com/mbedmicro/mbed), containing: - * all the changes to the C/C++ libraries and the Python tools. - * information about the reference target board -* logged in with your mbed.org account, sign our [Apache Contribution Agreement](http://developer.mbed.org/contributor_agreement/) and [send us a Private Message](http://developer.mbed.org/users/emilmont/) with the URL of the pull request. \ No newline at end of file diff --git a/docs/Going_Further/Serial.md b/docs/Going_Further/Serial.md deleted file mode 100644 index 18af2d7b6c..0000000000 --- a/docs/Going_Further/Serial.md +++ /dev/null @@ -1,284 +0,0 @@ -#The Serial Protocol - -Serial is a generic protocol used by computers and electronic modules to send and receive control information and data. The Serial link has two unidirection channels, one for sending and one for receiving. The link is asynchronous, and so both ends of the serial link must be configured to use the same settings. - -One of the Serial connections goes via the mbed USB port, allowing you to easily communicate with your host PC. - -##Hello World! - - -[Import the program](http://developer.mbed.org/users/mbed_official/code/Serial_HelloWorld_Mbed/docs/879aa9d0247b/main_8cpp_source.html) - - -##API summary - -
Import library
- - - - Public Member Functions -- |
- |
| - - | -
-
- Serial
-
- (PinName tx, PinName rx, const char *name=NULL)
- Create a - - Serial - - port, connected to the specified transmit and receive pins. - - - - |
-
| - void - | -
-
- baud
-
- (int baudrate)
- - Set the baud rate of the serial port. - - - - |
-
| - void - | -
-
- format
- - Set the transmission format used by the serial port. - - - - |
-
| - int - | -
-
- readable
-
- ()
- - Determine if there is a character available to read. - - - - |
-
| - int - | -
-
- writeable
-
- ()
- - Determine if there is space available to write a character. - - - - |
-
| - void - | -
-
- attach
-
- (void(*fptr)(void), IrqType type=RxIrq)
- -Attach a function to call whenever a serial interrupt is generated. - - - - |
-
| - void - | -
-
- attach
-
- (T *tptr, void(T::*mptr)(void), IrqType type=RxIrq)
- - Attach a member function to call whenever a serial interrupt is generated. - - - - |
-
| - void - | -
-
- send_break
-
- ()
- - Generate a break condition on the serial line. - - - - |
-
| - void - | -
-
- set_flow_control
-
- (Flow type, PinName flow1=NC, PinName flow2=NC)
- - Set the flow control type on the serial port. - - - - |
-
-Note that on a windows machine, you will need to install a USB Serial driver, see: [Windows serial configuration](/Going_Further/Serial_Conf/). - - -Serial channels have a number of configurable parameters: - -* *Baud Rate* - There are a number of standard baud rates ranging from a few hundred bits per seconds, to megabits per second. The default setting for a Serial connection on the mbed Microcontroller is 9600 baud. - -* *Data length* - Data transferred can be either 7 or 8 bits long. The default setting for a Serial connection on the mbed Microcontroller is 8 bits. - -* *Parity* - An optional parity bit can be added. The parity bit will be automatically set to make the number of 1's in the data either odd or even. Parity settings are Odd, Even or None. The default setting for a Serial connection on the mbed microcontroller is for the parity to be set to None. - -* *Stop Bits* - After data and parity bits have been transmitted, 1 or 2 stop bit is inserted to "frame" the data. The default setting for a Serial connection on the mbed microcontroller is for one stop bit to be added. - -The default settings for the mbed microcontroller are described as //9600 8N1//, and this is common notation for Serial port settings. - -##See Also - - * [Communication with a PC](/Development/PC_Com/) - -##Reference - - * [Serial Port on Wikipedia](http://en.wikipedia.org/wiki/Serial_port) - -##Examples - -``Write a message to a device at a 19200 baud`` - -```c - - #include "mbed.h" - - Serial device(p9, p10); // tx, rx - - int main() { - device.baud(19200); - device.printf("Hello World\n"); - } -``` - -``Provide a serial pass-through between the PC and an external UART`` - -```c - - #include "mbed.h" - - Serial pc(USBTX, USBRX); // tx, rx - Serial device(p9, p10); // tx, rx - - int main() { - while(1) { - if(pc.readable()) { - device.putc(pc.getc()); - } - if(device.readable()) { - pc.putc(device.getc()); - } - } - } -``` - -``Attach to RX Interrupt`` - -```c - - #include "mbed.h" - - DigitalOut led1(LED1); - DigitalOut led2(LED2); - - Serial pc(USBTX, USBRX); - - void callback() { - // Note: you need to actually read from the serial to clear the RX interrupt - printf("%c\n", pc.getc()); - led2 = !led2; - } - - int main() { - pc.attach(&callback); - - while (1) { - led1 = !led1; - wait(0.5); - } - } -``` - - -See [full attach API](http://mbed.org/projects/libraries/api/mbed/trunk/Serial#Serial.attach) - \ No newline at end of file diff --git a/docs/Going_Further/Serial_Conf.md b/docs/Going_Further/Serial_Conf.md deleted file mode 100644 index cbf0284f42..0000000000 --- a/docs/Going_Further/Serial_Conf.md +++ /dev/null @@ -1,35 +0,0 @@ -#Windows Serial Configuration - -The mbed serial port works by default on Mac and Linux, but Windows needs a driver. These instructions explain how to setup the mbed Microcontroller to use the USB serial port on Windows. - -##Download the mbed Windows serial port driver - -[Download the installer](http://developer.mbed.org/media/downloads/drivers/mbedWinSerial_16466.exe) to your PC, e.g. your desktop. - -##Run the installer - -With your ``mbed plugged in``, and *no explorer drive windows open*, run the installer: - -It will take some time (especially on Vista), and pop up a few 'unsigned driver' warnings, but after a while you should have a Serial port. - -###Where Next - -* [Serial PC](/Development/PC_Com/) - Communication with a PC -* [Terminals](/Going_Further/Terminals/) - Guide to using terminal applications - - -***Troubleshooting*** -
-
-**If you have multiple mbed microcontrollers, but the serial port only appears for one of them:** Make sure you run the installer for every mbed; windows loads the driver based on the serial number, so it needs to be run for each mbed you use. -
-**If the installer fails because "No mbed Microcontrollers were found":** Check your mbed Microcontroller is plugged in. -
-**If the installer reports the message "mbedWinSerial_nnnnn.exe is not a valid Win32 application":** -
* It is likely you are using Internet Explorer to download the installer file, which sometimes seems to only download part of the installer application for an unknown reason. -
* To solve this, download the installer with a different browser (Firefox, Chrome), and try again; this should solve the issue. -
-**If the Installer appears to hang:** Check if windows has popped-up a "unsigned driver/permission" window; these often get hidden behind other windows with nothing to indicate so in the taskbar! Windows may be waiting for you to click "OK"! -
-**If you have any problems, or think this tutorial could be improved, please tell us in the [Forum](http://developer.mbed.org/forum).** - \ No newline at end of file diff --git a/docs/Going_Further/Terminals.md b/docs/Going_Further/Terminals.md deleted file mode 100644 index 76372437f9..0000000000 --- a/docs/Going_Further/Terminals.md +++ /dev/null @@ -1,62 +0,0 @@ -#Terminal Applications - -Terminal applications run on your host PC, and provide a window for your mbed Microcontroller to print to, and a means for you to type characters back to your mbed Microcontroller. - -**Serial configuration:** The standard setup for the USB Serial Port is 9600 baud, 8 bits, 1 stop bit, no parity (aka 9600-8-N-1) - - -##Windows users - -###Install a Terminal Application - -Download and install a Terminal application. - -In this example we recommend the latest version of [Teraterm](http://sourceforge.jp/projects/ttssh2/files). - -Other terminal applications are available: - -* [Putty](http://www.chiark.greenend.org.uk/~sgtatham/putty/) -* [Terminal by Bray](http://sites.google.com/site/braypp/terminal) - -Some Windows PCs come with ''Hyperterminal'' installed; you can use this too, but we have found Tera Term is just a bit more friendly to use. - -###Configure the Connection - -Open and Setup Teraterm - -* File -> New Connection (or just press Alt+N) -* Select the ''Serial'' radio button and choose the ''mbed Serial Port'' from the drop down menu. -* Click ''OK'' - -Setup New-line format (to print out new line characters correctly) - -* Setup -> Terminal... -* Under "New-line", set Receive to "LF" - -Your terminal program is now configured and connected. - -To change the baud rate, go to Setup -> Serial Port... - -##Mac/Linux Users - -###Install a Terminal Application - -If you do not already have it, install [GNU Screen](http://en.wikipedia.org/wiki/GNU_Screen). - -###Setup the Connection - -* Connect using screen by typing the command ``screen /dev/
-You can check the connection is working by typing keys in the terminal application; nothing useful will happen, but the Status light on the mbed Microcontroller should flicker as the characters are received. -
-**If you have any problems, or think this tutorial could be improved, please tell us in the [Forum](http://developer.mbed.org/forum)** - - - - - diff --git a/docs/Going_Further/Tools.md b/docs/Going_Further/Tools.md deleted file mode 100644 index 6e9f9b8182..0000000000 --- a/docs/Going_Further/Tools.md +++ /dev/null @@ -1,228 +0,0 @@ -#mbed Tools - -The tools used to develop the mbed libraries are released under the permissive open source license Apache Version 2.0 in the following online code repositories: - -* [GitHub/mbed](https://github.com/mbedmicro/mbed) - -The tools, stored in the ``workspace_tools`` directory, are written in Python (platform independent: tested on Windows and Linux). - -##Settings configuration - -The mbed tools are providing sensible defaults for all the required settings in the file: - -* ``workspace_tools/settings.py`` - -You can configure your settings changing the value of any of the settings variables in the file: - -* ``workspace_tools/private_settings.py`` - -We configured our version control systems (ie: git) to ignore this file. - -For example, if you want to change the path to your [GNU Tools for ARM Embedded Processors](https://launchpad.net/gcc-arm-embedded/4.7/4.7-2012-q4-major) to a path like ``c:/arm_gcc/bin``, you simply need to have a ``private_settings.py`` containing the following line: - -```python - - GCC_ARM_PATH = "c:/arm_gcc/bin" -``` - - -**Warning: Windows path in a Python string** -
-In a Python string ``\`` is used as an escape character to specify special characters (``\n``, ``\t``, etc). If you want to add a ``\`` in a Python string, you need to write ``{{{\\}}}``. Otherwise, as path separator you can use the forward slash: ``/`` (see above example). - - -##Build System - -The mbed build system is composed of two scripts: - -* One to build the libraries: ``workspace_tools/build.py`` -* One to build and run the test projects: ``workspace_tools/make.py`` - -Both share a subset of options to specify the target microcontroller and the toolchain: - -```python - - -m MCU -t TOOLCHAIN -``` - -The available target ``MCU``s are: - -* ``LPC1768`` -* ``LPC11U24`` -* ``LPC2368`` -* ``LPC812`` -* ``KL25Z`` - -The available ``TOOLCHAIN``s are: - -* ``ARM``: ARMCC toolchain with the standard C library -* ``uARM``: ARMCC toolchain with the micro C library -* ``GCC_ARM``: GCC toolchain from ARM -* ``GCC_CS``: GCC toolchain from CodeSourcery -* ``GCC_CR``: GCC toolchain from CodeRed -* ``IAR``: IAR toolchain - -###build.py - -If a target and a toolchain are not specified, the build script will build the mbed library for all the available targets and toolchains. - -If, for example, you want to build the mbed library for the LPC1768 mbed using the ARM GCC toolchain: - -```python - - > python workspace_tools\build.py -m LPC1768 -t GCC_ARM -``` - -This is an example output: - -```python - - >>> BUILD LIBRARY CMSIS (LPC1768, GCC_ARM) - Copy: LPC1768.ld - Assemble: startup_LPC17xx.s - Compile: cmsis_nvic.c - Compile: core_cm3.c - [...] - Compile: TimerEvent.cpp - Library: libmbed.a - - Completed in: (6.31)s - - Build successes: - * GCC_ARM::LPC1768 -``` - -The following options are used to request the build of additional libraries: - -* ``-r``: build the RTOS library -* ``-e``: build the Ethernet library -* ``-u``: build the USB device library -* ``-d``: build the DSP library - -##Test System - -###make.py - -Make is used to build and run one of the test projects defined in the following python file: ``workspace_tools/tests.py`` - -Each test project is specified by a simple python dictionary of the type: - - -```python - - TESTS = [ - # Automated MBED tests - { - "id": "MBED_A1", "description": "MBED: Basic", - "source_dir": join(TEST_DIR, "mbed", "basic"), - "dependencies": [MBED_LIBRARIES, TEST_MBED_LIB], - "automated": True, - }, - { - "id": "MBED_A2", "description": "MBED: semihost file system", - "source_dir": join(TEST_DIR, "mbed", "file"), - "dependencies": [MBED_LIBRARIES, TEST_MBED_LIB], - "automated": True, - "mcu": ["LPC1768", "LPC2368", "LPC11U24"] - }, -``` - -All these project specifications are contained in the ``TEST`` list. If you launch the "make" script without any option, the script will print a list of all the available tests with their correspondent number: - -```python - - > python workspace_tools\make.py - - [ 0] MBED: Basic - [ 1] MBED: semihost file system - [ 2] MBED: C++ STL - [ 3] MBED: I2C TMP102 - [ 4] MBED: DigitalIn DigitalOut - [ 5] MBED: DigitalInOut - [ 6] MBED: InterruptIn - [ 7] MBED: Analog - [ 8] MBED: Serial Echo at 115200 - [ 9] MBED: PortOut PortIn - [10] MBED: PortInOut - [11] MBED: SD File System - [12] MBED: I2C MMA7660 - [...] -``` - -On top of building a test project, the "make" script can actually program and reset a target mbed and display all the output printed on the target serial port: - -* ``-d``: specifies the target mbed disk (ie: ``E:\`` on Windows, or ``/media/mbed`` on Linux) -* ``-s``: specifies the target serial port (ie: ``COM4`` on Windows, or ``/dev/ttyACM0`` on Linux) - -For example, to build the "Basic" test project (number: ``0``) for a ``LPC1768`` mbed using the ``ARM GCC`` toolchain, flashing the resulting binary on the disk ``E:\`` and interfacing to the serial port ``COM4``: - -```python - - > python workspace_tools\make.py -m LPC1768 -t GCC_ARM -d E:\ -s COM41 -p 0 -``` - - -**Warning: Python Serial Port Extension** -
-To drive the serial port with ``make.py`` you will need to install the [pyserial package](https://pypi.python.org/pypi/pyserial) - - -This is an example output: - - -```python - - >>> BUILD PROJECT: BASIC (LPC1768, GCC_ARM) - Compile: main.cpp - Compile: test_env.cpp - Link: basic - Elf2Bin: basic - Image: C:\Users\emimon01\mbed\build\test\LPC1768\GCC_ARM\MBED_A1\basic.bin - {success} - {end} -``` - -All the text appearing after the "Image:" path is actually printed through the serial port by the program running on the mbed. - -If you specify a serial port with the ``-s`` option, immediately after the copy of the project binary on the mbed, the "make" script enters in a loop reading the specified serial port. To interrupt the loop simply send a keyboard interrupt (ie: ``CTRL+c``). - -####Adding a test - -Adding a new test project is as easy as: - -* Add the sources of your project in a new directory under the ``libraries/tests`` tree. -* Add a dictionary entry to the ``workspace_tools/tests.py`` ``TEST`` list. - -These are the mandatory keys of a test project dictionary: - -* ``id``: A unique ID string to identify the test (used only internally by the automated test system) -* ``description``: A human friendly description of the test displayed on the command line "help" message -* ``source_dir``: The directory containing the sources of your test project. As good practice write the path joining it with the root ``TEST_DIR`` directory. - -These are the optional keys of a test project dictionary: - -* ``dependencies``: A list of directory paths containing the sources of the libraries this project is depending on. (default: None) -* ``automated``: Boolean specifying if the test project can communicate automatically the result of the test without the supervision of a human using specific strings. (default: False). -* ``duration``: The maximum time taken by an automated test to complete. If the test takes longer than that to complete, it is reported as a failure. (default: (10)s) -* ``mcu``: a list of types of mbed that can run the program. (default: every mbed). -* ``peripherals``: a list of peripherals needed to run the test. (default: None). -* ``host_test``: Specific host test to be launched to verify the success of the test. (defualt: 'host_test' simply checking the special strings in curly braces ``{success}`` or ``{failure}``). -* ``extra_files``: A list of file to be copied on the mbed (for example data files to be read by the mbed program during execution). - -The "automated" test projects use specific strings in curly braces to communicate to the host the result of automated tests: - -* ``{success}`` and ``{failure}`` are used to communicate the result of a single check. -* ``{end}`` is used to communicate the end of the test. - -##Export System - -To test exporter scripts run the project.py with options for the MCU and the target compiler. This provides a handy way of checking your export scripts and testing new chips you are creating. This is the same script the online compiler will use to export projects for users to download. - -``example_Keil_uVision_project_for_FRDM-K64F_with_test_0`` - -```python - - $ python project.py -m K64F -i uvision -p 0 -``` - -The script will tell you where the zip file of your project is exported to. \ No newline at end of file diff --git a/docs/Going_Further/mbed_rtos.md b/docs/Going_Further/mbed_rtos.md deleted file mode 100644 index 122cd31fc6..0000000000 --- a/docs/Going_Further/mbed_rtos.md +++ /dev/null @@ -1,167 +0,0 @@ -*** Editing: https://docs.google.com/document/d/10v8n0elbDH9gonE-x_T5EnTmk4vUrUDCuv4Jw7bRR-M/edit *** - -# mbed-rtos - -*** Not sure which link should go here... this one doesn't seem right *** - -[](https://developer.mbed.org/users/mbed_official/code/mbed-rtos/docs/4c105b8d7cae/rtos_8h_source.html) - -## Thread - -The ``Thread`` class allows defining, creating, and controlling thread functions in the system. The function ``main`` is a special thread function that is started at system initialization and has the initial priority ``osPriorityNormal``. - -[](https://developer.mbed.org/users/mbed_official/code/rtos_basic/file/tip/main.cpp) - -**Note:** The ``main`` function is already the first thread scheduled by the rtos. - -[](https://developer.mbed.org/users/mbed_official/code/mbed-rtos/docs/tip/classrtos_1_1Thread.html) - - - - -A ``Thread`` can be in the following states: - -* **RUNNING**: The thread that is currently running is in the RUNNING state. Only one thread at a time can be in this state. -* **READY**: Threads which are ready to run are in the READY state. Once the RUNNING thread has terminated or is WAITING the next READY thread with the highest priority becomes the RUNNING thread. -* **WAITING**: Threads that are waiting for an event to occur are in the WAITING state. -* **INACTIVE**: Threads that are not created or terminated are in the INACTIVE state. These threads typically consume no system resources. - - - -## Mutex - -A ``Mutex`` is used to synchronize the execution of threads, for example to protect the access to a shared resource. - - **Warning:** ISR -The ``Mutex`` methods cannot be called from interrupt service routines (ISR). - - - -[](https://developer.mbed.org/users/mbed_official/code/rtos_mutex/file/tip/main.cpp) - -**Note:** C standard library mutexes -The ARM C standard library has already mutexes in place to protect the access to stdio, therefore on the M3 mbed the above example is not necessary. On the contrary, ARM microlib (used on the M0 mbed) does not provide default stdio mutexes making the above example a necessity. -**Warning:** stdio (printf, putc, getc, etc), malloc & new in ISR -Because of the mutexes in the ARM C standard library you cannot use stdio (``printf``, ``putc``, ``getc``, etc), ``malloc`` and ``new`` in ISR! - -[](https://developer.mbed.org/users/mbed_official/code/mbed-rtos/docs/tip/classrtos_1_1Mutex.html) - -## Semaphore - -A ``Semaphore`` is particularly useful to manage thread access to a pool of shared resources of a certain type. - - - -[](https://developer.mbed.org/users/mbed_official/code/rtos_semaphore/file/tip/main.cpp) - -[](https://developer.mbed.org/users/mbed_official/code/mbed-rtos/docs/tip/classrtos_1_1Semaphore.html) - -## Signals - -Each ``Thread`` can be notified and wait for signals: - -[](https://developer.mbed.org/users/mbed_official/code/rtos_signals/file/tip/main.cpp) - -## Queue - -A ``Queue`` allows you to queue pointers to data from producers threads to consumers threads: - - - -``` -Queue queue; - -message_t *message; - -queue.put(message); - -osEvent evt = queue.get(); -if (evt.status == osEventMessage) { - message_t *message = (message_t*)evt.value.p; -``` - -[](https://developer.mbed.org/users/mbed_official/code/rtos_queue/file/tip/main.cpp) - -[](https://developer.mbed.org/users/mbed_official/code/mbed-rtos/docs/tip/classrtos_1_1Queue.html) - -## MemoryPool - -The MemoryPool class is used to define and manage fixed-size memory pools: - -``` -MemoryPool mpool; - -message_t *message = mpool.alloc(); - -mpool.free(message); -``` - -[](https://developer.mbed.org/users/mbed_official/code/rtos_queue/file/tip/main.cpp) - -[](https://developer.mbed.org/users/mbed_official/code/mbed-rtos/docs/tip/classrtos_1_1MemoryPool.html) - -## Mail - -A ``Mail`` works like a queue with the added benefit of providing a memory pool for allocating messages (not only pointers). - - - -[](https://developer.mbed.org/users/mbed_official/code/rtos_mail/file/tip/main.cpp) - -[](https://developer.mbed.org/users/mbed_official/code/mbed-rtos/docs/tip/classrtos_1_1Mail.html) - -## RTOS Timer - -The ``RtosTimer`` class allows creating and and controlling of timer functions in the system. A timer function is called when a time period expires whereby both one-shot and periodic timers are possible. A timer can be started, restarted, or stopped. Timers are handled in the thread ``osTimerThread``. Callback functions run under control of this thread and may use CMSIS-RTOS API calls. - - - -[](https://developer.mbed.org/users/mbed_official/code/rtos_timer/file/tip/main.cpp) - -[](https://developer.mbed.org/users/mbed_official/code/mbed-rtos/docs/tip/classrtos_1_1RtosTimer.html) - -## Interrupt Service Routines - -The same RTOS API can be used in ISR. The only two warnings are: - -* ``Mutex`` can not be used. -* Wait in ISR is not allowed: all the timeouts in method parameters have to be set to 0 (no wait). - -[](https://developer.mbed.org/users/mbed_official/code/rtos_isr/file/tip/main.cpp) - -## Default Timeouts - -The mbed rtos API has made the choice of defaulting to ``0`` timeout (no wait) for the producer methods, and ``osWaitForever`` (infinitive wait) for the consumer methods. - -A typical scenario for a producer could be a peripheral triggering an interrupt to notify an event: in the corresponding interrupt service routine you cannot wait (this would deadlock the entire system). On the other side, the consumer could be a background thread waiting for events: in this case the desired default behaviour is not using CPU cycles until this event is produced, hence the osWaitForever. - -**Warning**: No wait in ISR When calling an rtos object method in an ISR all the timeout parameters have to be set to 0 (no wait): waiting in ISR is not allowed. - -## Status and Error Codes - -The Status and Error Codes section lists all the return values that the CMSIS-RTOS functions will return: - -* ``osOK``: function completed; no event occurred. -* ``osEventSignal``: function completed; signal event occurred. -* ``osEventMessage``: function completed; message event occurred. -* ``osEventMail``: function completed; mail event occurred. -* ``osEventTimeout``: function completed; timeout occurred. -* ``osErrorParameter``: parameter error: a mandatory parameter was missing or specified an incorrect object. -* ``osErrorResource``: resource not available: a specified resource was not available. -* ``osErrorTimeoutResource``: resource not available within given time: a specified resource was not available within the timeout period. -* ``osErrorISR``: not allowed in ISR context: the function cannot be called from interrupt service routines. -* ``osErrorISRRecursive``: function called multiple times from ISR with same object. -* ``osErrorPriority``: system cannot determine priority or thread has illegal priority. -* ``osErrorNoMemory``: system is out of memory: it was impossible to allocate or reserve memory for the operation. -* ``osErrorValue``: value of a parameter is out of range. -* ``osErrorOS``: unspecified RTOS error: run-time error but no other error message fits. - -## osEvent - -The ``osEvent`` data structure is returned by ``get`` methods of ``Queue`` and ``Mail`` objects. This data structure contains both an error code and a pointer to the actual data: - -[](https://developer.mbed.org/users/mbed_official/code/rtx/docs/tip/structosEvent.html) - -## Implementation - -The mbed RTOS is based on the [CMSIS RTOS](CMSIS-RTOS). ** MISSING LINK ** diff --git a/docs/Images/API_Docs/APIDOCS1.png b/docs/Images/API_Docs/APIDOCS1.png deleted file mode 100644 index 3db2bbfea9..0000000000 Binary files a/docs/Images/API_Docs/APIDOCS1.png and /dev/null differ diff --git a/docs/Images/API_Docs/APIDOCS2.png b/docs/Images/API_Docs/APIDOCS2.png deleted file mode 100644 index 9bdc0a1a8a..0000000000 Binary files a/docs/Images/API_Docs/APIDOCS2.png and /dev/null differ diff --git a/docs/Images/API_Docs/APIDOCS3.png b/docs/Images/API_Docs/APIDOCS3.png deleted file mode 100644 index c92aa75f72..0000000000 Binary files a/docs/Images/API_Docs/APIDOCS3.png and /dev/null differ diff --git a/docs/Images/API_Docs/APIDOCS4.png b/docs/Images/API_Docs/APIDOCS4.png deleted file mode 100644 index 14cd452b3e..0000000000 Binary files a/docs/Images/API_Docs/APIDOCS4.png and /dev/null differ diff --git a/docs/Images/API_Docs/APIDOCS5.png b/docs/Images/API_Docs/APIDOCS5.png deleted file mode 100644 index 9df7e08811..0000000000 Binary files a/docs/Images/API_Docs/APIDOCS5.png and /dev/null differ diff --git a/docs/Images/CMSIS/CMSIS1.png b/docs/Images/CMSIS/CMSIS1.png deleted file mode 100644 index 551a92ecd3..0000000000 Binary files a/docs/Images/CMSIS/CMSIS1.png and /dev/null differ diff --git a/docs/Images/CMSIS/CMSIS2.png b/docs/Images/CMSIS/CMSIS2.png deleted file mode 100644 index b8da66fa52..0000000000 Binary files a/docs/Images/CMSIS/CMSIS2.png and /dev/null differ diff --git a/docs/Images/CMSIS/CMSIS3.png b/docs/Images/CMSIS/CMSIS3.png deleted file mode 100644 index bb247a5cae..0000000000 Binary files a/docs/Images/CMSIS/CMSIS3.png and /dev/null differ diff --git a/docs/Images/CMSIS/CMSIS4.png b/docs/Images/CMSIS/CMSIS4.png deleted file mode 100644 index c5c647824b..0000000000 Binary files a/docs/Images/CMSIS/CMSIS4.png and /dev/null differ diff --git a/docs/Images/CMSIS/CMSIS5.webp b/docs/Images/CMSIS/CMSIS5.webp deleted file mode 100644 index 3af982dc2d..0000000000 Binary files a/docs/Images/CMSIS/CMSIS5.webp and /dev/null differ diff --git a/docs/Images/CMSIS/CMSIS6.png b/docs/Images/CMSIS/CMSIS6.png deleted file mode 100644 index 41ff8d051a..0000000000 Binary files a/docs/Images/CMSIS/CMSIS6.png and /dev/null differ diff --git a/docs/Images/Compiler/Compiler1.png b/docs/Images/Compiler/Compiler1.png deleted file mode 100644 index 48e3d0692d..0000000000 Binary files a/docs/Images/Compiler/Compiler1.png and /dev/null differ diff --git a/docs/Images/Compiler/Compiler2.png b/docs/Images/Compiler/Compiler2.png deleted file mode 100644 index 974240b628..0000000000 Binary files a/docs/Images/Compiler/Compiler2.png and /dev/null differ diff --git a/docs/Images/Debug/FRDM_KL25Z.gif b/docs/Images/Debug/FRDM_KL25Z.gif deleted file mode 100644 index 0f8c23d415..0000000000 Binary files a/docs/Images/Debug/FRDM_KL25Z.gif and /dev/null differ diff --git a/docs/Images/Debug/LPC11U24.gif b/docs/Images/Debug/LPC11U24.gif deleted file mode 100644 index d4e829619b..0000000000 Binary files a/docs/Images/Debug/LPC11U24.gif and /dev/null differ diff --git a/docs/Images/Debug/LPC1768.gif b/docs/Images/Debug/LPC1768.gif deleted file mode 100644 index cf0458a9a0..0000000000 Binary files a/docs/Images/Debug/LPC1768.gif and /dev/null differ diff --git a/docs/Images/Exporting/Eclipse1.png b/docs/Images/Exporting/Eclipse1.png deleted file mode 100644 index 1c9a3fb32b..0000000000 Binary files a/docs/Images/Exporting/Eclipse1.png and /dev/null differ diff --git a/docs/Images/Exporting/Eclipse2.png b/docs/Images/Exporting/Eclipse2.png deleted file mode 100644 index 6f4b8df1ee..0000000000 Binary files a/docs/Images/Exporting/Eclipse2.png and /dev/null differ diff --git a/docs/Images/Exporting/Eclipse3.png b/docs/Images/Exporting/Eclipse3.png deleted file mode 100644 index 2b97e2f931..0000000000 Binary files a/docs/Images/Exporting/Eclipse3.png and /dev/null differ diff --git a/docs/Images/Exporting/Eclipse4.png b/docs/Images/Exporting/Eclipse4.png deleted file mode 100644 index 9490a1e9e4..0000000000 Binary files a/docs/Images/Exporting/Eclipse4.png and /dev/null differ diff --git a/docs/Images/Exporting/Eclipse5.png b/docs/Images/Exporting/Eclipse5.png deleted file mode 100644 index f33fa554ab..0000000000 Binary files a/docs/Images/Exporting/Eclipse5.png and /dev/null differ diff --git a/docs/Images/Exporting/Export1.png b/docs/Images/Exporting/Export1.png deleted file mode 100644 index dc205ae06e..0000000000 Binary files a/docs/Images/Exporting/Export1.png and /dev/null differ diff --git a/docs/Images/Exporting/Export2.png b/docs/Images/Exporting/Export2.png deleted file mode 100644 index 50da5b2767..0000000000 Binary files a/docs/Images/Exporting/Export2.png and /dev/null differ diff --git a/docs/Images/Exporting/IAR1.png b/docs/Images/Exporting/IAR1.png deleted file mode 100644 index f4f3d9c6b0..0000000000 Binary files a/docs/Images/Exporting/IAR1.png and /dev/null differ diff --git a/docs/Images/Exporting/IAR2.png b/docs/Images/Exporting/IAR2.png deleted file mode 100644 index 41b389072c..0000000000 Binary files a/docs/Images/Exporting/IAR2.png and /dev/null differ diff --git a/docs/Images/Exporting/Make1.png b/docs/Images/Exporting/Make1.png deleted file mode 100644 index 1c9a3fb32b..0000000000 Binary files a/docs/Images/Exporting/Make1.png and /dev/null differ diff --git a/docs/Images/Exporting/uVision1.png b/docs/Images/Exporting/uVision1.png deleted file mode 100644 index b383043f29..0000000000 Binary files a/docs/Images/Exporting/uVision1.png and /dev/null differ diff --git a/docs/Images/Exporting/uVision2.png b/docs/Images/Exporting/uVision2.png deleted file mode 100644 index 61fc26cafc..0000000000 Binary files a/docs/Images/Exporting/uVision2.png and /dev/null differ diff --git a/docs/Images/Lib_Intern/Blinky1.png b/docs/Images/Lib_Intern/Blinky1.png deleted file mode 100644 index 68728fa03d..0000000000 Binary files a/docs/Images/Lib_Intern/Blinky1.png and /dev/null differ diff --git a/docs/Images/Lib_Intern/Blinky2.png b/docs/Images/Lib_Intern/Blinky2.png deleted file mode 100644 index 78d17bb0c8..0000000000 Binary files a/docs/Images/Lib_Intern/Blinky2.png and /dev/null differ diff --git a/docs/Images/Lib_Intern/Direct.png b/docs/Images/Lib_Intern/Direct.png deleted file mode 100644 index 9c2889cb30..0000000000 Binary files a/docs/Images/Lib_Intern/Direct.png and /dev/null differ diff --git a/docs/Images/Lib_Intern/GPIO_R.png b/docs/Images/Lib_Intern/GPIO_R.png deleted file mode 100644 index c93846febc..0000000000 Binary files a/docs/Images/Lib_Intern/GPIO_R.png and /dev/null differ diff --git a/docs/Images/Lib_Intern/Layers.png b/docs/Images/Lib_Intern/Layers.png deleted file mode 100644 index fa392db3c0..0000000000 Binary files a/docs/Images/Lib_Intern/Layers.png and /dev/null differ diff --git a/docs/Images/Memory/Heap_Stack.png b/docs/Images/Memory/Heap_Stack.png deleted file mode 100644 index b10b09d6f3..0000000000 Binary files a/docs/Images/Memory/Heap_Stack.png and /dev/null differ diff --git a/docs/Images/Memory/Memory_Sections.png b/docs/Images/Memory/Memory_Sections.png deleted file mode 100644 index 189431779c..0000000000 Binary files a/docs/Images/Memory/Memory_Sections.png and /dev/null differ diff --git a/docs/Images/Memory/RTOS.png b/docs/Images/Memory/RTOS.png deleted file mode 100644 index 5db4d2f000..0000000000 Binary files a/docs/Images/Memory/RTOS.png and /dev/null differ diff --git a/docs/Images/Publish/Publish1.png b/docs/Images/Publish/Publish1.png deleted file mode 100644 index d48c3c316e..0000000000 Binary files a/docs/Images/Publish/Publish1.png and /dev/null differ diff --git a/docs/Images/Publish/Publish2.png b/docs/Images/Publish/Publish2.png deleted file mode 100644 index e3a97a1372..0000000000 Binary files a/docs/Images/Publish/Publish2.png and /dev/null differ diff --git a/docs/Images/Publish/Publish3.png b/docs/Images/Publish/Publish3.png deleted file mode 100644 index 4db7824229..0000000000 Binary files a/docs/Images/Publish/Publish3.png and /dev/null differ diff --git a/docs/Images/Publish/Publish4.png b/docs/Images/Publish/Publish4.png deleted file mode 100644 index 08423ca1b2..0000000000 Binary files a/docs/Images/Publish/Publish4.png and /dev/null differ diff --git a/docs/Images/Publish/Publish5.png b/docs/Images/Publish/Publish5.png deleted file mode 100644 index e3a97a1372..0000000000 Binary files a/docs/Images/Publish/Publish5.png and /dev/null differ diff --git a/docs/Images/Serial_Pinout.png b/docs/Images/Serial_Pinout.png deleted file mode 100644 index 50f784191f..0000000000 Binary files a/docs/Images/Serial_Pinout.png and /dev/null differ diff --git a/docs/Images/Thread/Mutex.png b/docs/Images/Thread/Mutex.png deleted file mode 100644 index 020da3d19b..0000000000 Binary files a/docs/Images/Thread/Mutex.png and /dev/null differ diff --git a/docs/Images/Thread/Semaphore.png b/docs/Images/Thread/Semaphore.png deleted file mode 100644 index f1939c01b9..0000000000 Binary files a/docs/Images/Thread/Semaphore.png and /dev/null differ diff --git a/docs/Images/Thread/mail_queue.png b/docs/Images/Thread/mail_queue.png deleted file mode 100644 index 42af6cd831..0000000000 Binary files a/docs/Images/Thread/mail_queue.png and /dev/null differ diff --git a/docs/Images/Thread/queue.png b/docs/Images/Thread/queue.png deleted file mode 100644 index 3ff42fca44..0000000000 Binary files a/docs/Images/Thread/queue.png and /dev/null differ diff --git a/docs/Images/Thread/rtos_timer.png b/docs/Images/Thread/rtos_timer.png deleted file mode 100644 index 3b849d11f4..0000000000 Binary files a/docs/Images/Thread/rtos_timer.png and /dev/null differ diff --git a/docs/Images/Thread/thread_priority.png b/docs/Images/Thread/thread_priority.png deleted file mode 100644 index ad51d35ee0..0000000000 Binary files a/docs/Images/Thread/thread_priority.png and /dev/null differ diff --git a/docs/Images/Thread/thread_status.png b/docs/Images/Thread/thread_status.png deleted file mode 100644 index 45a05645ba..0000000000 Binary files a/docs/Images/Thread/thread_status.png and /dev/null differ diff --git a/docs/Introduction/API_Libs.md b/docs/Introduction/API_Libs.md deleted file mode 100644 index dacc58b77e..0000000000 --- a/docs/Introduction/API_Libs.md +++ /dev/null @@ -1,19 +0,0 @@ -#High-level Peripheral APIs - -The mbed SDK gives you an API-driven approach to microcontroller coding. - -We've done all the hard work of implementing drivers for the different [mbed platforms](http://developer.mbed.org/platforms/) so you won't have to. It is liberating to fire up an interface, knowing it'll just work! - -You can code using meaningful abstract objects and API calls, so you don't need to learn the microcontroller hardware details to get going. There is even a **Hello World!** example for every peripheral, just to get you started. - -Take a look at some of these interfaces to get a feel of how it works: [digital out](http://developer.mbed.org/handbook/DigitalOut), [analog in](http://developer.mbed.org/handbook/AnalogIn), [SPI](http://developer.mbed.org/handbook/SPI), [USB mouse](http://developer.mbed.org/handbook/USBMouse), [Timer](http://developer.mbed.org/handbook/Timer) or [CAN](http://developer.mbed.org/handbook/CAN). - -If needed, you can bypass the APIs and talk directly to the microcontroller hardware using the low-level [Cortex Microcontroller Software Interface Standard (CMSIS) APIs](/CMSIS/CMSIS/). Ideal when just one aspect needs specific low-level control. - - -For all the mbed C/C++ SDK APIs, see the [API breakdown](/Development/API_Libs_Breakdown/)
- -[link to how to write a library or to API_Documentation (which is a mpage I'm not sure we have)] - - - diff --git a/docs/Introduction/Code_Base.md b/docs/Introduction/Code_Base.md deleted file mode 100644 index 78d858b4c7..0000000000 --- a/docs/Introduction/Code_Base.md +++ /dev/null @@ -1,10 +0,0 @@ -mbed OS code base - -The mbed OS code base is at: - -https://github.com/ARMmbed/mbed-os - -https://github.com/mbedmicro/mbed - - -[These will probably become a single one when we go live] diff --git a/docs/Introduction/HDK.md b/docs/Introduction/HDK.md deleted file mode 100644 index 90364baee0..0000000000 --- a/docs/Introduction/HDK.md +++ /dev/null @@ -1,62 +0,0 @@ -#mbed HDK - -The mbed Hardware Development Kit (HDK) provides full microcontroller sub-system design files and firmware for building development boards and custom products that benefit from the native support of the mbed SDK and free mbed Online Compiler and mbed Developer Platform. - -The mbed HDK specifies all support components and circuits including the CMSIS-DAP Interface design that provides simple USB drag-n-drop programming and CMSIS-DAP debug interface for the target microcontroller. - -Development boards that are already based on the mbed HDK are the quickest way to get started with the mbed platform. We manufacture official mbed Microcontroller modules that are specifically optimised for flexible rapid prototyping, and are available from distributors worldwide. Our partners are now also creating mbed-enabled hardware such as ultra low-cost ARM evaluation boards in the popular Arduino form-factor. - - -**Creating your own mbed-enabled platforms**
-Are you are a hardware company that would like to create an mbed-enabled platform of your own that is supported within the mbed platforms database and tools? If so, then please email us at
-[The mbed compiler](/Introduction/IDE_API/) -
-[The mbed interface](/Introduction/mbed_Interface/) - diff --git a/docs/Introduction/IDE_API.md b/docs/Introduction/IDE_API.md deleted file mode 100644 index 77236e2db8..0000000000 --- a/docs/Introduction/IDE_API.md +++ /dev/null @@ -1,153 +0,0 @@ -#The mbed Compiler - -**Instant access to your lightweight C/C++ microcontroller development environment** - - - - - -The mbed Compiler provides a lightweight online C/C++ IDE that is pre-configured to let you quickly write programs, compile and download them to run on your mbed Microcontroller. In fact, you don't have to install or set up anything to get running with mbed. Because it is a web app, you can log in from anywhere and carry on where you left off, and you are free to work on Windows, Mac, iOS, Android, Linux, or all of them. - -Watch a demonstration: - - -
-
-
-**It is online and lightweight, but it is also powerful.**
-
-The compiler uses the professional ARMCC compiler engine, so it produces efficient code that can be used free-of-charge, even in commercial applications. The IDE includes [workspace version control](/Going_Further/Comp_Ver_Cont/), code formatting and [auto-generation](/Going_Further/Docu/) of documentation for published libraries. The mbed tools are focused on prototyping and are designed for fast experimentation, and complement other professional production-level tools; you can even export directly to [other toolchains](/Going_Further/Export/) if you choose, as you progress to productise your design.
-
-You can [publish projects](/Development/Write_Publish/) directly from your Compiler workspace to the mbed.org website to [share code](http://developer.mbed.org/code/) with others, and pull existing libraries in to your workspace to get a head start.
-
-##Feature Highlights
-
-###Online Compiler IDE
-
-Every mbed user account gets their own private Compiler workspace which contains their programs. This is private to you, and available wherever you login to mbed.
-
-The IDE includes a full code editor including syntax highlighting, standard editor keyboard shortcuts, undo/redo, cut/copy/paste, tabs, block/line comment, and even a code auto-formater. This is where you work on your personal workspace, with multiple files, folders, programs, including a drag and drop folder interface:
-
-
-
-
-
-The editor also includes features like find and searching across multiple files and filetypes; for example, searching across your whole program. When you search, the results will appear as a list in the compiler output window where you can jump to any of them with a click:
-
-
-
-
-
-
-
-
-###Integrated Version Control
-
-You can use the built-in version control features to let you version, branch and merge code, with a nice representation of the state of your project history:
-
-
-
-
-
-The approach should be familiar to those of you with experience of distributed version control models (as used by mercurial/git); each program has its own local repository, so you can commit and perform actions on it within your own workspace (such as updating, branching and showing changes).
-
-The main things you can do include:
-
-* Commit a version of your project, and view the revision history
-
-* View changes a version made, and compare changes between versions
-
-* Update or revert to a different version
-
-* Branch and merge
-
-
-See also [Version Control](/Going_Further/Comp_Ver_Cont/).
-
-
-###Importing Libraries or Example Programs
-
-The Import Wizard allows you to import programs and libraries published by mbed users. This is useful for importing code that has been packaged as a reusable library component (e.g. a class for a peripheral), so you can quickly pull in the building blocks for your project.
-
-
-
-
-
-
-See also [Importing code](/Getting_Started/Using_IDE/).
-
-
-###Compilation
-
-To perform the actual compilation the mbed Compiler uses the industry standard [ARM RVDS 4.1](http://www.arm.com/products/tools/software-tools/rvds/arm-compiler.php) compiler engine, in the default configuration, to give excellent code size and performance. There are no limitations on code size (apart from the limits of the device itself!), and the generated code can be used freely for commercial and non-commercial use.
-
-When you compile a program, you'll get a display of the memory usage. This shows the size of program code and any constant (const) variables that will end up in FLASH, and size of data variables that end up in main RAM.
-
-
-
-
-
-Note, this doesn't include the runtime allocated variables (i.e. the heap and stack), which live in any remaining RAM.
-
-
-See also the mbed [Memory Model](/Going_Further/Mem_Mo/).
-
-
-###Export to Offline Toolchains
-
-The [mbed C/C++ SDK](/Introduction/SDK/) used with the mbed Online Compiler is also compatible with a number of other popular ARM microcontroller toolchains, so we've also built in the ability to export directly to these toolchains! For example, if you'd like to migrate to a different toolchain as your project develops past prototype, you can choose to export an mbed project by right-clicking on it:
-
-
-
-
-
-
-See also the [SDK](/Introduction/SDK/) and [Exporting to offline toolchains](/Going_Further/Export).
-
-
-##Feature Overview
-
-Code IDE
-
-* All the core features you expect from a code editor including syntax highlighting, standard [editor keyboard shortcuts](/Getting_Started/IDE_Shortcuts/), copy/paste, etc.
-
-* Personal workspace with multiple files, folders, programs, including drag and drop folder interface.
-
-* Code auto-formatter, print-friendly code preview.
-
-Compile Engine
-
-* Pre-configured compile engine that "just works", delivering .bin binary file to save to mbed microcontroller.
-
-* Switch between different mbed targets with a drop-down selector.
-
-* Output of compile-time messages, including click to go to error and error message wiki.
-
-* Build information including graphical display of code size and RAM usage.
-
-Built-in Version Control and Collaboration tools
-
-* [Built-in version control](/Going_Further/Comp_Ver_Cont/) (DVCS).
-
-* Publish, fork, push and pull code in [collaboration-enabled environment](/Community/Collab/).
-
-* View graphs, diffs, change sets.
-
-Importing and Exporting
-
-* Import programs from online catalogue of [published programs](http://developer.mbed.org/code/).
-
-* Publish your code directly from the mbed Compiler to the mbed Developer Website.
-
-* Import from and export to local source files and zip archives.
-
-* [Export directly](/Going_Further/Export) to other popular ARM toolchains.
-
-Accessibility
-
-* Access the mbed Compiler on all major browsers, on all modern operating systems.
-
-* Develop and prototype right on your [tablet device](http://developer.mbed.org/handbook/Guide-to-mbed-Compiler-on-tablet-device) (Android, iOS) with the integrated [touch support](http://developer.mbed.org/blog/entry/compiler-touch-support/).
-
-* Backward compatible up to Internet Explorer 6.
\ No newline at end of file
diff --git a/docs/Introduction/Plat_Comp_Intro.md b/docs/Introduction/Plat_Comp_Intro.md
deleted file mode 100644
index a38e1022e2..0000000000
--- a/docs/Introduction/Plat_Comp_Intro.md
+++ /dev/null
@@ -1,30 +0,0 @@
-##Overview
-
-mbed provides a way of prototyping hardware-based projects and products by giving you the hardware (ARM-processors on a board, and external components) and the ability to write software to control it (using the mbed API and IDE).
-
-##Platforms and Components
-
-All mbed programs are written for one or more [platforms](http://developer.mbed.org/platforms/): a board with an ARM microcontroller and various capabilities such as receiving and processing input, generating output and storing small bits of information.
-
-You need to select a platform that matches what you're trying to achieve, as they all have different capabilities. But platforms don't have to be used on their own - you can add external [components](http://developer.mbed.org/components/) to enhance functionality.
-
-##Platform Programming
-
-Platform programming is done in C++; it relies on APIs that abstract the hardware, protocols and component support.
-
-
-**Tip:** for more information about the software development kit, see our [SDK section](/Introduction/SDK/).
-
-
-All platforms run a `.hex` file generated by either our [online compiler](https://developer.mbed.org/compiler/) or an offline tool of your choosing.
-
-##Platform Interoperability
-
-To help you experiment and prototype, we've moved the interoperability of platforms behind the scenes. You write one program, and the IDE can then compile it to fit as many different platforms as you require, without any manual recoding.
-
-
-
-
-
-The IDE lets you select a target platform at any stage in the process
-
-
diff --git a/docs/Introduction/Rapid_Prototyping.md b/docs/Introduction/Rapid_Prototyping.md
deleted file mode 100644
index da5665867a..0000000000
--- a/docs/Introduction/Rapid_Prototyping.md
+++ /dev/null
@@ -1,116 +0,0 @@
-#Rapid Prototyping With mbed
-
-If you have a [board](http://developer.mbed.org/platforms/) and a [user on the mbed compiler](https://developer.mbed.org/account/signup/), you can build your first prototype.
-
-You can reuse a wealth of open source code and technical know-how from the official Handbook, community Cookbook and Components database as the foundation of your products.
-
-You can also contribute back fixes, libraries and support for other developers to help everyone get things done even faster.
-
-##Assemble components
-
-The Components database contains community contributions for hundreds of popular components and peripherals. These include specifications, wiring diagrams, reusable libraries and “Hello World” examples on how to use each peripheral.
-
-When you are deciding which components to use, browsing the components database can help narrow down to devices people have found success with and that are already supported.
-
-There are also various existing domain-specific baseboards that pre-integrate useful components to help you prototype your software before designing the hardware.
-
-
-See our [components page](http://developer.mbed.org/components/), [cookbook](http://developer.mbed.org/cookbook/Homepage) and [baseboards list](http://developer.mbed.org/cookbook/Homepage#baseboards).
-
-
-##Import libraries and get coding
-
-Jump start your code by importing libraries and examples for components. Simply click “import” on any library or example you find around the site, and it can be imported in to your private compiler workspace.
-
-After you’ve got your libraries, it’s time to get coding. The compiler includes full C/C++ error reporting, with each linked to a wiki page with help to you squish coding bugs faster.
-
-You can use the built-in version control to keep track of working version of your code, and even publish your program to the community in a couple of clicks; this is excellent if you want help, as it makes it very easy for others to reproduce your problems quickly.
-
-
-See our explanation on how to [import](/Getting_Started/Using_IDE/) or [publish](Development/Write_Publish/).
-
-
-##Build on existing middleware
-
-While lots of libraries are maintained by mbed users, we directly maintain certain important core libraries.
-
-The mbed SDK is at the core of all programs and libraries on mbed, providing the high level object oriented library for the onboard interfaces and features of microcontrollers.
-
-The mbed Networking stack provides a full Berkeley sockets layer TCP/IP implementation based on LwIP, and supports various transports such as Ethernet, WiFi and 3G Modems.
-
-Other middleware includes libraries like Bluetooth Smart, HTTP, CoAP and other connectivity protocols essential for building connected products.
-
-
-See our page on working [with the mbed community](Community/Intro/).
-
-
-##Collaborate with other developers
-
-Take some time to explore the tools we provide to help you collaborate with other developers. It can enable you to work on a your own projects and to help improve a public library.
-
-If you fix a bug in a library you can contribute the fix back. Coding new libraries is simple, and you can add API documentation using the built-in Doxygen engine and publish it to the community for others to use in their projects.
-
-We use Mercurial on the backend to support distributed version control; forking, pulling, merging and pushing all happen neatly from within the mbed Compiler. You can also grant developers access to your own repositories, so you can create a virtual team.
-
-
-See our pages on working [with the mbed community](Community/Intro/) or [writing a library](Development/Write_Publish/).
-
-
-##Going to production
-
-
-
-
-
-When your prototype proves a success, the mbed platform can also help support you as you develop it into a product.
-
-The HDK is free for use in custom commercial designs, and the compiler can export to other professional toolchains if needed.
-
-Choosing the mbed platform means you are in the company of tens of thousands of developers who know the tools and have the expertise to help you on the path to production.
-
-###Manufacturing your own hardware
-
-The mbed platform is designed to make it very fast to build and iterate prototypes, so you build the right product.
-
-Once you have your final prototype you’ll likely want to build your own custom hardware. Both the mbed SDK and HDK are free for commercial use, so you can move to the production phase of your project with confidence.
-
-Going to production can be daunting if you haven’t done it before. The prototype to production guide in the cookbook, board schematic / layout files in the HDK and the expertise in the mbed community can help with understanding the process of taking your prototype through to a manufacturable product.
-
-
-See our page on the [mbed HDK](/Introduction/HDK/).
-
-
-###Exporting to other professional tools
-
-As you progress to production, you may want to perform rigorous optimisation and testing of your software, or hand-off to a contractor or engineer familiar with different tools.
-
-The mbed Compiler is capable of exporting your projects to other professional toolchains. This export process packages up your code with any library dependencies and generates the tool specific project files to make the transition simple.
-
-Combined with the CMSIS-DAP support built-in to the USB Onboard Interface, it is easy to move your project to full professional debugger tools without changing your hardware.
-
-
-See our page on [exporting to other toolchains](/Going_Further/Export/).
-
-
-###Support and Contracting
-
-Once you have built a proof-of-concept that proves your product idea, it is worth considering how best to get it to production; finishing the last 10% is often 90% of the work.
-
-You are lucky enough to be among thousands of highly skilled developers, all who know the platform you are working with, and each with expertise in different areas that could complement your own; reach out to them!
-
-Whether you are looking for hardware or PCB design, low-level software, device drivers or even with your application, there are developers with the right skills and experience to help you with your project, and mbed.org is a great place to find them.
-
-If you are a developer looking for contracting work, your profile and work history are a great way to advertise your skills and help you win challenging and interesting work.
-
-###Finished products
-
-The mbed platform is being used in companies across the world to develop new generations of products. Most companies that we enable are quietly working away on their designs, getting help from and contributing to the community to do amazing things.
-
-We're always interested to hear your case studies so we can share details of products you have been creating, and help inform and inspire other developers that are earlier on in their journey to a finished product.
-
-If you or your company have an advanced prototype or product success you’d be happy to share, please let us know! We love to cross post to our blog and social media to help get the word out. Also consider adding your product to our showcase at [hackster.io/mbed](http://www.hackster.io/mbed/).
-
-###Prototype to hardware
-
-If you want to read about moving from prototyping to hardware, see [here](http://developer.mbed.org/users/chris/notebook/prototype-to-hardware/).
\ No newline at end of file
diff --git a/docs/Introduction/SDK.md b/docs/Introduction/SDK.md
deleted file mode 100644
index cf3ce99ddb..0000000000
--- a/docs/Introduction/SDK.md
+++ /dev/null
@@ -1,72 +0,0 @@
-#The mbed SDK
-
-The mbed Software Development Kit (SDK) is a C/C++ microcontroller software platform relied upon by tens of thousands of developers to build projects fast. We've worried about creating and testing startup code, C runtime, libraries and peripheral APIs, so you can worry about coding the smarts of your next product.
-
-The SDK is licensed under the permissive Apache 2.0 licence, so you can use it in both commercial and personal projects with confidence.
-
-The mbed SDK has been designed to provide enough hardware abstraction to be intuitive and concise, yet powerful enough to build complex projects. It is built on the low-level ARM CMSIS APIs, allowing you to code down to the metal if needed. In addition to RTOS, USB and Networking libraries, a cookbook of hundreds of reusable peripheral and module libraries have been built on top of the SDK by the mbed Developer Community.
-
-##Hello World!
-
-Startup code, check. C Library integration, check. Peripheral libraries, check. We've worked hard to help you get to the point:
-
-
-[Import the code](http://developer.mbed.org/teams/mbed/code/mbed_blinky/)
-
-
-```c
-
- #include "mbed.h"
-
- DigitalOut myled(LED1);
-
- int main() {
- while(1) {
- myled = 1;
- wait(0.2);
- myled = 0;
- wait(0.2);
- }
- }
-```
-
-
-##Support for Multiple Targets
-
-The abstraction provided by the mbed SDK APIs enables libraries and example code to be reused by any microcontroller target that the mbed SDK targets.
-
-
-
-
-
-##Support for Multiple Toolchains
-
-Our goal with the mbed Compiler and mbed SDK is to enable a consistent and stable fully integrated development platform that just works. This helps provide a consistent context for development, code sharing, and questions and answers with other developers that helps you be more productive, especially when prototyping.
-
-However, the mbed C/C++ SDK used with the mbed Online Compiler is also compatible with a number of other popular ARM microcontroller toolchains!
-
-If you'd like to use the [mbed platforms](http://developer.mbed.org/platforms/) or mbed C/C++ SDK with an alternate tool, or simply migrate to one as your project develops past prototype, you can choose to export an mbed project to the toolchain of your choice by right-clicking on them in the IDE.
-
-
-You can read more about this on the [Exporting to offline toolchains](/Going_Further/Export/) handbook page.
-
-
-##Open Source
-
-
-
-
-
-The mbed SDK is licensed under the permissive Apache 2.0 open source licence.
-
-We wanted to make sure the license we chose made it possible to use the SDK in both commercial and personal projects with confidence, including no obligations to open source your own code if you didn't want to. Whilst we encourage sharing of code and experience to be reusable by others, we certainly don't want to enforce it, and a permissive license provides that freedom for our users to keep the options open.
-
-If you are interested in delving in the depth of the mbed SDK implementation you can take a look at the documentation of the [mbed library internals](/Going_Further/Lib_Internals/).
-
-and you can use the mbed library sources, instead of one of its builds:
-[Import the code](http://developer.mbed.org/users/mbed_official/code/mbed-src/)
-
-If you are interested in [porting the mbed SDK](/Going_Further/SDK_Porting/) to a new target we provide the sources of all the official mbed libraries, tests and [tools (build and test system)](/Going_Further/Tools/) in [this github repository](https://github.com/mbedmicro/mbed).
-
-##See also
-Check out the rest of the mbed platform, and [explore](http://mbed.org/explore/) what it can do for you!
\ No newline at end of file
diff --git a/docs/Introduction/mbed_Interface.md b/docs/Introduction/mbed_Interface.md
deleted file mode 100644
index c3f2d6a51c..0000000000
--- a/docs/Introduction/mbed_Interface.md
+++ /dev/null
@@ -1,46 +0,0 @@
-#The mbed Interface
-
-Since the beginning of mbed, there has been a certain amount of interest and speculation around the "magic interface chip" on the underside of the mbed microcontroller.
-
-There has been some information published surrounding this part, which is now collated on this page.
-
-The full schematics of the mbed Microcontroller, including the mbed interface are now available in the handbook.
-
-##Connectivity
-
-The best representation of the connectivity of the mbed interface was in Simon's official unoffical diagram:
-
-
-
-
-
-The headlines are that it:
-
-- Provides a USB connection to the host computer, which exposes a Mass Storage (flash disk) and a USB Serial Port
-
-- Connects with the Serial Flash device, which implements the USB flash disk file storage
-
-- Has a JTAG connection to the target, so that it can program the target flash. Semihosting of the USB flash drive (LocalFileSystem) is implemented over this JTAG connection
-
-- A physical UART connection exists between the target and the interface which is relayed over interface USB Serial port
-
-##Operation
-
-There are a few facts and rules about how the interface interacts with the host computer and the target, the most significant ones are:
-
-- The USB Drive is really a flash drive that can store multiple binary files. On power up/reset, the interface will always program the newest file into the target, unless the newest binary has already been programmed.
-
-- When there is no binary file on the USB flash disk, the target is held in reset
-
-- The reset button on the mbed Microcontroller doesn't directly resets the target. Instead it requests that the interface resets the target, checking first to see if there is a newer binary on the USB flash disk to be programmed.
-
-- If a file is opened by the target using LocalFileSystem, the USB flash disk will disappear from the host computer until the file is closed, as the filesystem can not appear in two places at once.
-
-- Should the USB flash drive fail to appear when you plug in your mbed, it might be because your current program is using the local file system. Press and hold the reset button to keep the target in reset, and the flash drive will appear.
-
-
-See also:
--[How mbed Works](/Introduction/How_mbed_Works/) - - diff --git a/docs/Targets/Intro.md b/docs/Targets/Intro.md deleted file mode 100644 index 158f006b03..0000000000 --- a/docs/Targets/Intro.md +++ /dev/null @@ -1 +0,0 @@ -# Working with targets \ No newline at end of file diff --git a/docs/advanced/DAP.md b/docs/advanced/DAP.md new file mode 100644 index 0000000000..d100870fff --- /dev/null +++ b/docs/advanced/DAP.md @@ -0,0 +1 @@ +# CMSIS-DAP and DAPLink \ No newline at end of file diff --git a/docs/advanced/config_system.md b/docs/advanced/config_system.md new file mode 100644 index 0000000000..3133d587af --- /dev/null +++ b/docs/advanced/config_system.md @@ -0,0 +1 @@ +# The mbed Configuration System \ No newline at end of file diff --git a/docs/advanced/debugging.md b/docs/advanced/debugging.md new file mode 100644 index 0000000000..77630915e1 --- /dev/null +++ b/docs/advanced/debugging.md @@ -0,0 +1 @@ +# Debugging applications \ No newline at end of file diff --git a/docs/advanced/targets.md b/docs/advanced/targets.md new file mode 100644 index 0000000000..fe03c85550 --- /dev/null +++ b/docs/advanced/targets.md @@ -0,0 +1 @@ +# Using target configuration with your applications \ No newline at end of file diff --git a/docs/advanced/versions.md b/docs/advanced/versions.md new file mode 100644 index 0000000000..27f303ff05 --- /dev/null +++ b/docs/advanced/versions.md @@ -0,0 +1 @@ +# Version control \ No newline at end of file diff --git a/docs/advanced/writing_apps.md b/docs/advanced/writing_apps.md new file mode 100644 index 0000000000..941eac14d3 --- /dev/null +++ b/docs/advanced/writing_apps.md @@ -0,0 +1 @@ +# Writing applications on top of mbed OS 4.0 \ No newline at end of file diff --git a/docs/advanced/writing_libs.md b/docs/advanced/writing_libs.md new file mode 100644 index 0000000000..595cc57f2e --- /dev/null +++ b/docs/advanced/writing_libs.md @@ -0,0 +1 @@ +# Writing libraries for mbed OS \ No newline at end of file diff --git a/docs/build_tools/cli.md b/docs/build_tools/cli.md new file mode 100644 index 0000000000..8d2610b93e --- /dev/null +++ b/docs/build_tools/cli.md @@ -0,0 +1 @@ +# mbed CLI \ No newline at end of file diff --git a/docs/build_tools/ide.md b/docs/build_tools/ide.md new file mode 100644 index 0000000000..3acc66b443 --- /dev/null +++ b/docs/build_tools/ide.md @@ -0,0 +1 @@ +# mbed IDE \ No newline at end of file diff --git a/docs/build_tools/offline.md b/docs/build_tools/offline.md new file mode 100644 index 0000000000..65bd5a2393 --- /dev/null +++ b/docs/build_tools/offline.md @@ -0,0 +1,5 @@ +# Offline build tools + +## Keil + +## Third party integrations \ No newline at end of file diff --git a/docs/build_tools/options.md b/docs/build_tools/options.md new file mode 100644 index 0000000000..bd5a7c36a5 --- /dev/null +++ b/docs/build_tools/options.md @@ -0,0 +1,9 @@ +# Build tool options + +## mbed Studio + +## mbed IDE + +## mbed CLI + +## Offline build tools \ No newline at end of file diff --git a/docs/build_tools/studio.md b/docs/build_tools/studio.md new file mode 100644 index 0000000000..4317a77406 --- /dev/null +++ b/docs/build_tools/studio.md @@ -0,0 +1 @@ +# mbed Studio \ No newline at end of file diff --git a/docs/coding/Contributing.md b/docs/coding/Contributing.md deleted file mode 100644 index e93f3206e8..0000000000 --- a/docs/coding/Contributing.md +++ /dev/null @@ -1 +0,0 @@ -# Contribution guide diff --git a/docs/coding/code_style.md b/docs/coding/code_style.md deleted file mode 100644 index c87a35b1b6..0000000000 --- a/docs/coding/code_style.md +++ /dev/null @@ -1 +0,0 @@ -# Code style guide diff --git a/docs/getting_started/first_program.md b/docs/getting_started/first_program.md new file mode 100644 index 0000000000..57cb37d6cf --- /dev/null +++ b/docs/getting_started/first_program.md @@ -0,0 +1,32 @@ +# Your first application + +We have an example application called [Blinky](https://github.com/ARMmbed/mbed-blinky-morpheus) that you can use to familiarize yourself with mbed OS and the build tools. + +You can try any of these tools: + +* [mbed Studio](#blinky-on-mbed-studio) +* [mbed Online Compiler](#blinky-on-mbed-online-compiler) +* [mbed CLI](#blinky-on-mbed-cli) +* [Third party integration](#blinky-on-third-party-tools) + +## Blinky on mbed Studio + +Before you begin: + +1. If you don't already have one, please get an [mbed account](). + +[TODO: Do I need any other account to work with C9?] + +## Blinky on mbed Online Compiler + +Before you begin: + +1. If you don't already have one, please get an [mbed account](). + +## Blinky on mbed CLI + +Before you begin: + +1. If you don't already have one, please get an [mbed account](). + +## Blinky on third party tools diff --git a/docs/getting_started/what_need.md b/docs/getting_started/what_need.md new file mode 100644 index 0000000000..fef8da3ad2 --- /dev/null +++ b/docs/getting_started/what_need.md @@ -0,0 +1,8 @@ +# What you need + +## User account + +## Hardware + +## Window serial driver + diff --git a/docs/index.md b/docs/index.md index 531e666bc8..d4a26976b9 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1 +1,26 @@ -# mbed handbook \ No newline at end of file +# Introduction to mbed OS 5.0 + +mbed OS lets you write applications that run on embedded devices. + +Your application code - written in C++ - uses the *application programing interfaces* (APIs) presented by mbed OS to receive information from the hardware and send instructions to it. This means you don't need to understand how the hardware works to be able to control it. + +## Where to start + +The easiest way to work with mbed OS is using one of our tools. We've set up an example that you can try with each tool. + +Our online IDEs let you write and build applications for multiple devices. You can choose between our in-house [mbed Online Compiler]() and [mbed Studio](), which is based on the Cloud9 IDE. + +You can also use [mbed CLI](), our command line tool. This requires having a toolchain installed on your machine. + +## How to continue + +When you've tried our example and picked your work environment, it's time to learn how mbed OS enables the features your application needs. + +We've organized our APIs by feature, and have an introduction, a "hello world" sample and an API reference for each: + +* [Hardware inputs and outputs](): +* [Digital interfaces and USB](): +* [Networking and communication](): +* [Device and networking security](): +* [Task management](): +* [Memory and file system](): diff --git a/docs/porting/background.md b/docs/porting/background.md new file mode 100644 index 0000000000..735f0aa67b --- /dev/null +++ b/docs/porting/background.md @@ -0,0 +1 @@ +# Porting to mbed OS 4.0 \ No newline at end of file diff --git a/docs/porting/other_ports.md b/docs/porting/other_ports.md new file mode 100644 index 0000000000..cea8fc388a --- /dev/null +++ b/docs/porting/other_ports.md @@ -0,0 +1,3 @@ +# Porting to mbed OS 4.0 + +should this link to thread safety, or should thread safety be part of this guide? diff --git a/docs/porting/porting_process.md b/docs/porting/porting_process.md new file mode 100644 index 0000000000..735f0aa67b --- /dev/null +++ b/docs/porting/porting_process.md @@ -0,0 +1 @@ +# Porting to mbed OS 4.0 \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 0451144bed..6560bb7ced 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,9 +1,73 @@ -site_name: mbed Handbook +site_name: mbed OS 5.0 docs_dir: docs pages: -- ['index.md','Introduction to the mbed handbook'] -- ['Introduction/Code_Base.md','Introduction','mbed OS code base'] -- ['Build_Tools/Intro.md', 'Build Tools' ,'Introduction to the build tools'] -- ['Build_Tools/mbed_CLI/mbed_CLI.md', 'Build Tools' ,'mbed CLI'] +- ['index.md','Introduction to mbed OS 5.0'] +- ['getting_started/what_need.md', 'Getting started', 'What you need'] +- ['getting_started/first_program.md', 'Getting started', 'First application'] +- ['APIs/intro.md', 'Getting started', 'Writing applications with the mbed OS APIs'] +- ['APIs/io/inputs_outputs.md', 'Input and output APIs', 'Handling inputs and outputs'] +- ['APIs/io/AnalogIn.md', 'Input and output APIs', 'AnalogIn'] +- ['APIs/io/AnalogOut.md', 'Input and output APIs', 'AnalogOut'] +- ['APIs/io/DigitalIn.md', 'Input and output APIs', 'DigitalIn'] +- ['APIs/io/DigitalOut.md', 'Input and output APIs', 'DigitalOut'] +- ['APIs/io/DigitalInOut.md', 'Input and output APIs', 'DigitalInOut'] +- ['APIs/io/BusIn.md', 'Input and output APIs', 'BusIn'] +- ['APIs/io/BusOut.md', 'Input and output APIs', 'BusOut'] +- ['APIs/io/BusInOut.md', 'Input and output APIs', 'BusInOut'] +- ['APIs/io/PortIn.md', 'Input and output APIs', 'PortIn'] +- ['APIs/io/PortOut.md', 'Input and output APIs', 'PortOut'] +- ['APIs/io/PortInOut.md', 'Input and output APIs', 'PortInOut'] +- ['APIs/io/PwmOut.md', 'Input and output APIs', 'PwmOut'] +- ['APIs/io/InterruptIn.md', 'Input and output APIs', 'InterruptIn'] +- ['APIs/interfaces/interfaces.md', 'Interface APIs', 'Interface options'] +- ['APIs/interfaces/digital/Serial.md', 'Interface APIs', 'Serial'] +- ['APIs/interfaces/digital/SPI.md', 'Interface APIs', 'SPI'] +- ['APIs/interfaces/digital/SPISlave.md', 'Interface APIs', 'SPISlave'] +- ['APIs/interfaces/digital/I2C.md', 'Interface APIs', 'I2C'] +- ['APIs/interfaces/digital/I2CSlave.md', 'Interface APIs', 'I2CSlave'] +- ['APIs/interfaces/digital/CAN.md', 'Interface APIs', 'CAN'] +- ['APIs/interfaces/USBDevice/USBMouse.md', 'Interface APIs', 'USBMouse'] +- ['APIs/interfaces/USBDevice/USBKeyboard.md', 'Interface APIs', 'USBKeyboard'] +- ['APIs/interfaces/USBDevice/USBMouseKeyboard.md', 'Interface APIs', 'USBMouseKeyboard'] +- ['APIs/interfaces/USBDevice/USBHID.md', 'Interface APIs', 'USBHID'] +- ['APIs/interfaces/USBDevice/USBMIDI.md', 'Interface APIs', 'USBMIDI'] +- ['APIs/interfaces/USBDevice/USBSerial.md', 'Interface APIs', 'USBSerial'] +- ['APIs/interfaces/USBDevice/USBAudio.md', 'Interface APIs', 'USBAudio'] +- ['APIs/interfaces/USBDevice/USBMSD.md', 'Interface APIs', 'USBMSD'] +- ['APIs/interfaces/USBHost/USBHostMouse.md', 'Interface APIs', 'USBHostMouse'] +- ['APIs/interfaces/USBHost/USBHostKeyboard.md', 'Interface APIs', 'USBHostKeyboard'] +- ['APIs/interfaces/USBHost/USBHostMSD.md', 'Interface APIs', 'USBHostMSD'] +- ['APIs/interfaces/USBHost/USBHostSerial.md', 'Interface APIs', 'USBHostSerial'] +- ['APIs/interfaces/USBHost/USBHostHub.md', 'Interface APIs', 'USBHostHub'] +- ['APIs/communication/communication.md', 'Communication APIs', 'Communication options'] +- ['APIs/communication/network_stack.md', 'Communication APIs', 'Network stack'] +- ['APIs/communication/ble.md', 'Communication APIs', 'BLE'] +- ['APIs/communication/ethernet.md', 'Communication APIs', 'Ethernet'] +- ['APIs/communication/wifi.md', 'Communication APIs', 'WiFi'] +- ['APIs/communication/radio.md', 'Communication APIs', 'Radio'] +- ['APIs/security/security.md', 'Security APIs', 'Securing devices and connections'] +- ['APIs/security/uvisor.md', 'Security APIs', 'mbed uVisor'] +- ['APIs/security/tls.md', 'Security APIs', 'mbed TLS'] +- ['APIs/tasks/tasks.md', 'Task management APIs', 'Managing tasks'] +- ['APIs/tasks/timers.md', 'Task management APIs', 'Timers'] +- ['APIs/tasks/rtos.md', 'Task management APIs', 'RTOS'] +- ['APIs/memory_files/memory_files.md', 'Memory and file system APIs', 'Managing the memory and file system'] +- ['APIs/memory_files/memory.md', 'Memory and file system APIs', 'Memory'] +- ['APIs/memory_files/file_system.md', 'Memory and file system APIs', 'File system'] +- ['build_tools/options.md', 'Build tools', 'Build tool options'] +- ['build_tools/studio.md', 'Build tools', 'mbed Studio'] +- ['build_tools/ide.md', 'Build tools', 'mbed IDE'] +- ['build_tools/cli.md', 'Build tools', 'mbed CLI'] +- ['build_tools/offline.md', 'Build tools', 'Offline build tools'] +- ['advanced/writing_apps.md', 'Advanced tutorials', 'Writing applications'] +- ['advanced/versions.md', 'Advanced tutorials', 'Version control'] +- ['advanced/debugging.md', 'Advanced tutorials', 'Debugging'] +- ['advanced/DAP.md', 'Advanced tutorials', 'CMSIS-DAP and DAPLink'] +- ['advanced/targets.md', 'Advanced tutorials', 'Targets'] +- ['advanced/config_system.md', 'Advanced tutorials', 'Configuration system'] +- ['advanced/writing_libs.md', 'Advanced tutorials', 'Writing libraries'] +- ['porting/background.md', 'Porting to mbed OS 5.0', 'Porting overview'] +- ['porting/porting_process.md', 'Porting to mbed OS 5.0', 'Porting process'] +- ['porting/other_ports.md', 'Porting to mbed OS 5.0', 'Porting to other components']