diff --git a/boards/LICENSE b/boards/LICENSE deleted file mode 100644 index f99be76ab3d5..000000000000 --- a/boards/LICENSE +++ /dev/null @@ -1,454 +0,0 @@ - GNU LESSER GENERAL PUBLIC LICENSE - Version 2.1, February 1999 - - Copyright (C) 1991, 1999 Free Software Foundation, Inc. - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -Licenses are intended to guarantee your freedom to share and change -free software--to make sure the software is free for all its users. - - This license, the Lesser General Public License, applies to some -specially designated software packages--typically libraries--of the -Free Software Foundation and other authors who decide to use it. You -can use it too, but we suggest you first think carefully about whether -this license or the ordinary General Public License is the better -strategy to use in any particular case, based on the explanations below. - - When we speak of free software, we are referring to freedom of use, -not price. Our General Public Licenses are designed to make sure that -you have the freedom to distribute copies of free software (and charge -for this service if you wish); that you receive source code or can get -it if you want it; that you can change the software and use pieces of -it in new free programs; and that you are informed that you can do -these things. - - To protect your rights, we need to make restrictions that forbid -distributors to deny you these rights or to ask you to surrender these -rights. These restrictions translate to certain responsibilities for -you if you distribute copies of the library or if you modify it. - - For example, if you distribute copies of the library, whether gratis -or for a fee, you must give the recipients all the rights that we gave -you. You must make sure that they, too, receive or can get the source -code. If you link other code with the library, you must provide -complete object files to the recipients, so that they can relink them -with the library after making changes to the library and recompiling -it. And you must show them these terms so they know their rights. - - We protect your rights with a two-step method: (1) we copyright the -library, and (2) we offer you this license, which gives you legal -permission to copy, distribute and/or modify the library. - - To protect each distributor, we want to make it very clear that -there is no warranty for the free library. Also, if the library is -modified by someone else and passed on, the recipients should know -that what they have is not the original version, so that the original -author's reputation will not be affected by problems that might be -introduced by others. - - Finally, software patents pose a constant threat to the existence of -any free program. We wish to make sure that a company cannot -effectively restrict the users of a free program by obtaining a -restrictive license from a patent holder. Therefore, we insist that -any patent license obtained for a version of the library must be -consistent with the full freedom of use specified in this license. - - Most GNU software, including some libraries, is covered by the -ordinary GNU General Public License. This license, the GNU Lesser -General Public License, applies to certain designated libraries, and -is quite different from the ordinary General Public License. We use -this license for certain libraries in order to permit linking those -libraries into non-free programs. - - When a program is linked with a library, whether statically or using -a shared library, the combination of the two is legally speaking a -combined work, a derivative of the original library. The ordinary -General Public License therefore permits such linking only if the -entire combination fits its criteria of freedom. The Lesser General -Public License permits more lax criteria for linking other code with -the library. - - We call this license the "Lesser" General Public License because it -does Less to protect the user's freedom than the ordinary General -Public License. It also provides other free software developers Less -of an advantage over competing non-free programs. These disadvantages -are the reason we use the ordinary General Public License for many -libraries. However, the Lesser license provides advantages in certain -special circumstances. - - For example, on rare occasions, there may be a special need to -encourage the widest possible use of a certain library, so that it becomes -a de-facto standard. To achieve this, non-free programs must be -allowed to use the library. A more frequent case is that a free -library does the same job as widely used non-free libraries. In this -case, there is little to gain by limiting the free library to free -software only, so we use the Lesser General Public License. - - In other cases, permission to use a particular library in non-free -programs enables a greater number of people to use a large body of -free software. For example, permission to use the GNU C Library in -non-free programs enables many more people to use the whole GNU -operating system, as well as its variant, the GNU/Linux operating -system. - - Although the Lesser General Public License is Less protective of the -users' freedom, it does ensure that the user of a program that is -linked with the Library has the freedom and the wherewithal to run -that program using a modified version of the Library. - - The precise terms and conditions for copying, distribution and -modification follow. Pay close attention to the difference between a -"work based on the library" and a "work that uses the library". The -former contains code derived from the library, whereas the latter must -be combined with the library in order to run. - - GNU LESSER GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License Agreement applies to any software library or other -program which contains a notice placed by the copyright holder or -other authorized party saying it may be distributed under the terms of -this Lesser General Public License (also called "this License"). -Each licensee is addressed as "you". - - A "library" means a collection of software functions and/or data -prepared so as to be conveniently linked with application programs -(which use some of those functions and data) to form executables. - - The "Library", below, refers to any such software library or work -which has been distributed under these terms. A "work based on the -Library" means either the Library or any derivative work under -copyright law: that is to say, a work containing the Library or a -portion of it, either verbatim or with modifications and/or translated -straightforwardly into another language. (Hereinafter, translation is -included without limitation in the term "modification".) - - "Source code" for a work means the preferred form of the work for -making modifications to it. For a library, complete source code means -all the source code for all modules it contains, plus any associated -interface definition files, plus the scripts used to control compilation -and installation of the library. - - Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running a program using the Library is not restricted, and output from -such a program is covered only if its contents constitute a work based -on the Library (independent of the use of the Library in a tool for -writing it). Whether that is true depends on what the Library does -and what the program that uses the Library does. - - 1. You may copy and distribute verbatim copies of the Library's -complete source code as you receive it, in any medium, provided that -you conspicuously and appropriately publish on each copy an -appropriate copyright notice and disclaimer of warranty; keep intact -all the notices that refer to this License and to the absence of any -warranty; and distribute a copy of this License along with the -Library. - - You may charge a fee for the physical act of transferring a copy, -and you may at your option offer warranty protection in exchange for a -fee. - - 2. You may modify your copy or copies of the Library or any portion -of it, thus forming a work based on the Library, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) The modified work must itself be a software library. - - b) You must cause the files modified to carry prominent notices - stating that you changed the files and the date of any change. - - c) You must cause the whole of the work to be licensed at no - charge to all third parties under the terms of this License. - - d) If a facility in the modified Library refers to a function or a - table of data to be supplied by an application program that uses - the facility, other than as an argument passed when the facility - is invoked, then you must make a good faith effort to ensure that, - in the event an application does not supply such function or - table, the facility still operates, and performs whatever part of - its purpose remains meaningful. - - (For example, a function in a library to compute square roots has - a purpose that is entirely well-defined independent of the - application. Therefore, Subsection 2d requires that any - application-supplied function or table used by this function must - be optional: if the application does not supply it, the square - root function must still compute square roots.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Library, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Library, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote -it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Library. - -In addition, mere aggregation of another work not based on the Library -with the Library (or with a work based on the Library) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may opt to apply the terms of the ordinary GNU General Public -License instead of this License to a given copy of the Library. To do -this, you must alter all the notices that refer to this License, so -that they refer to the ordinary GNU General Public License, version 2, -instead of to this License. (If a newer version than version 2 of the -ordinary GNU General Public License has appeared, then you can specify -that version instead if you wish.) Do not make any other change in -these notices. - - Once this change is made in a given copy, it is irreversible for -that copy, so the ordinary GNU General Public License applies to all -subsequent copies and derivative works made from that copy. - - This option is useful when you wish to copy part of the code of -the Library into a program that is not a library. - - 4. You may copy and distribute the Library (or a portion or -derivative of it, under Section 2) in object code or executable form -under the terms of Sections 1 and 2 above provided that you accompany -it with the complete corresponding machine-readable source code, which -must be distributed under the terms of Sections 1 and 2 above on a -medium customarily used for software interchange. - - If distribution of object code is made by offering access to copy -from a designated place, then offering equivalent access to copy the -source code from the same place satisfies the requirement to -distribute the source code, even though third parties are not -compelled to copy the source along with the object code. - - 5. A program that contains no derivative of any portion of the -Library, but is designed to work with the Library by being compiled or -linked with it, is called a "work that uses the Library". Such a -work, in isolation, is not a derivative work of the Library, and -therefore falls outside the scope of this License. - - However, linking a "work that uses the Library" with the Library -creates an executable that is a derivative of the Library (because it -contains portions of the Library), rather than a "work that uses the -library". The executable is therefore covered by this License. -Section 6 states terms for distribution of such executables. - - When a "work that uses the Library" uses material from a header file -that is part of the Library, the object code for the work may be a -derivative work of the Library even though the source code is not. -Whether this is true is especially significant if the work can be -linked without the Library, or if the work is itself a library. The -threshold for this to be true is not precisely defined by law. - - If such an object file uses only numerical parameters, data -structure layouts and accessors, and small macros and small inline -functions (ten lines or less in length), then the use of the object -file is unrestricted, regardless of whether it is legally a derivative -work. (Executables containing this object code plus portions of the -Library will still fall under Section 6.) - - Otherwise, if the work is a derivative of the Library, you may -distribute the object code for the work under the terms of Section 6. -Any executables containing that work also fall under Section 6, -whether or not they are linked directly with the Library itself. - - 6. As an exception to the Sections above, you may also combine or -link a "work that uses the Library" with the Library to produce a -work containing portions of the Library, and distribute that work -under terms of your choice, provided that the terms permit -modification of the work for the customer's own use and reverse -engineering for debugging such modifications. - - You must give prominent notice with each copy of the work that the -Library is used in it and that the Library and its use are covered by -this License. You must supply a copy of this License. If the work -during execution displays copyright notices, you must include the -copyright notice for the Library among them, as well as a reference -directing the user to the copy of this License. Also, you must do one -of these things: - - a) Accompany the work with the complete corresponding - machine-readable source code for the Library including whatever - changes were used in the work (which must be distributed under - Sections 1 and 2 above); and, if the work is an executable linked - with the Library, with the complete machine-readable "work that - uses the Library", as object code and/or source code, so that the - user can modify the Library and then relink to produce a modified - executable containing the modified Library. (It is understood - that the user who changes the contents of definitions files in the - Library will not necessarily be able to recompile the application - to use the modified definitions.) - - b) Use a suitable shared library mechanism for linking with the - Library. A suitable mechanism is one that (1) uses at run time a - copy of the library already present on the user's computer system, - rather than copying library functions into the executable, and (2) - will operate properly with a modified version of the library, if - the user installs one, as long as the modified version is - interface-compatible with the version that the work was made with. - - c) Accompany the work with a written offer, valid for at - least three years, to give the same user the materials - specified in Subsection 6a, above, for a charge no more - than the cost of performing this distribution. - - d) If distribution of the work is made by offering access to copy - from a designated place, offer equivalent access to copy the above - specified materials from the same place. - - e) Verify that the user has already received a copy of these - materials or that you have already sent this user a copy. - - For an executable, the required form of the "work that uses the -Library" must include any data and utility programs needed for -reproducing the executable from it. However, as a special exception, -the materials to be distributed need not include anything that is -normally distributed (in either source or binary form) with the major -components (compiler, kernel, and so on) of the operating system on -which the executable runs, unless that component itself accompanies -the executable. - - It may happen that this requirement contradicts the license -restrictions of other proprietary libraries that do not normally -accompany the operating system. Such a contradiction means you cannot -use both them and the Library together in an executable that you -distribute. - - 7. You may place library facilities that are a work based on the -Library side-by-side in a single library together with other library -facilities not covered by this License, and distribute such a combined -library, provided that the separate distribution of the work based on -the Library and of the other library facilities is otherwise -permitted, and provided that you do these two things: - - a) Accompany the combined library with a copy of the same work - based on the Library, uncombined with any other library - facilities. This must be distributed under the terms of the - Sections above. - - b) Give prominent notice with the combined library of the fact - that part of it is a work based on the Library, and explaining - where to find the accompanying uncombined form of the same work. - - 8. You may not copy, modify, sublicense, link with, or distribute -the Library except as expressly provided under this License. Any -attempt otherwise to copy, modify, sublicense, link with, or -distribute the Library is void, and will automatically terminate your -rights under this License. However, parties who have received copies, -or rights, from you under this License will not have their licenses -terminated so long as such parties remain in full compliance. - - 9. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Library or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Library (or any work based on the -Library), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Library or works based on it. - - 10. Each time you redistribute the Library (or any work based on the -Library), the recipient automatically receives a license from the -original licensor to copy, distribute, link with or modify the Library -subject to these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties with -this License. - - 11. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Library at all. For example, if a patent -license would not permit royalty-free redistribution of the Library by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Library. - -If any portion of this section is held invalid or unenforceable under any -particular circumstance, the balance of the section is intended to apply, -and the section as a whole is intended to apply in other circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 12. If the distribution and/or use of the Library is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Library under this License may add -an explicit geographical distribution limitation excluding those countries, -so that distribution is permitted only in or among countries not thus -excluded. In such case, this License incorporates the limitation as if -written in the body of this License. - - 13. The Free Software Foundation may publish revised and/or new -versions of the Lesser General Public License from time to time. -Such new versions will be similar in spirit to the present version, -but may differ in detail to address new problems or concerns. - -Each version is given a distinguishing version number. If the Library -specifies a version number of this License which applies to it and -"any later version", you have the option of following the terms and -conditions either of that version or of any later version published by -the Free Software Foundation. If the Library does not specify a -license version number, you may choose any version ever published by -the Free Software Foundation. - - 14. If you wish to incorporate parts of the Library into other free -programs whose distribution conditions are incompatible with these, -write to the author to ask for permission. For software which is -copyrighted by the Free Software Foundation, write to the Free -Software Foundation; we sometimes make exceptions for this. Our -decision will be guided by the two goals of preserving the free status -of all derivatives of our free software and of promoting the sharing -and reuse of software generally. - - NO WARRANTY - - 15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO -WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW. -EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR -OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY -KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE -LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME -THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN -WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY -AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU -FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR -CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE -LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING -RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A -FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH -DAMAGES. - - END OF TERMS AND CONDITIONS diff --git a/boards/README.md b/boards/README.md index cda1a563ead9..b19474b039e2 100644 --- a/boards/README.md +++ b/boards/README.md @@ -1,6 +1,3 @@ Platform configurations for RIOT-OS ==================================== -This repository contains existing configuration and initialization files for platforms supported by RIOT-OS. - -RIOT's kernel, system libraries, and drivers can be found here: -https://github.com/RIOT-OS/RIOT +This directory contains existing configuration and initialization files for platforms supported by RIOT-OS. diff --git a/doc/doxygen/src/mainpage.txt b/doc/doxygen/src/mainpage.txt index c48b2771c7bf..c9fc250ef57b 100644 --- a/doc/doxygen/src/mainpage.txt +++ b/doc/doxygen/src/mainpage.txt @@ -1,37 +1,165 @@ /*! \mainpage RIOT Documentation * - * RIOT is an operating system for the Internet of Things based on a microkernel architecture. + * \section overview Overview * - * \section first_sec First steps - * - * \subsection getting_sec Getting RIOT - * - * You can obtain the latest RIOT code from our [Github](https://github.com/) account. There are three repositories: - * - [RIOT](https://github.com/RIOT-OS/RIOT)\n - * This contains the kernel, support for different CPUs, device drivers, and system libraries.\n - * It also provides you with additional tools like a terminal program and scripts to setup a toolchain.\n - * This is the only repository you need to develop applications with RIOT. - * - [boards](https://github.com/RIOT-OS/boards) - * This repository contains configuration files and hardware initialization code for various supported hardware platforms.\n - * You need this code only if you want to use RIOT on one of these boards: - * -# [MSB-A2](http://www.mi.fu-berlin.de/inf/groups/ag-tech/projects/Z_Finished_Projects/ScatterWeb/modules/mod_MSB-A2.html) - * -# PTTU - * -# [MSB-430(H)](http://www.mi.fu-berlin.de/inf/groups/ag-tech/projects/Z_Finished_Projects/ScatterWeb/modules/mod_MSB-430H.html) - * -# [EZ430-Chronos](http://processors.wiki.ti.com/index.php/EZ430-Chronos)\n - * You will also need this code to run RIOT as a program on your development system. - * - [projects](https://github.com/RIOT-OS/projects)\n - * Contains some exemplary applications.\n - * - * \subsection compile_sec Compiling RIOT - * - * Depending on the hardware you want to use, you need to first install a corresponding toolchain. Instructions for the installation of the toolchain for an ARM7 based plaform in Ubuntu or Debian can be found at our [Wiki](https://github.com/RIOT-OS/boards/wiki/For-MSB-A2).\n - * Once you have set up the toolchain, you can create your own project. Apart from the C file(s) containing your source code you need a Makefile. A template Makefile is available in the `dist` folder of the [RIOT repository](https://github.com/RIOT-OS/RIOT).\n - * Within your project's Makefile, you can define the target hardware as well as the modules you want to use.\n - * Unless specified otherwise, make will create an elf-file as well as an Intel hex file in the `bin` folder of your project directory. - * - * \subsection native_sec Native RIOT - Run RIOT on your PC! - * - * As a special platform, you will find a CPU and board called `native` in the repository. This target allows you to run RIOT as a process on Linux on most supported hardware platforms. Just set CPU and BOARD to `native` in your project's Makefile, call `make`, and execute the resulting elf-file. + * RIOT is an operating system designed for the particular requirements of Internet + * of Things (IoT) scenarios. This requirements comprise a low memory footprint, + * high energy efficiency, real-time capabilities, a modular and configurable + * communication stack, and support for a wide range of low-power devices. RIOT + * provides a microkernel, utilities like cryptographic libraries, data structures + * (bloom filters, hash tables, priority queues), or a shell, different network + * stacks, and support for various microcontrollers, radio drivers, sensors, and + * configurations for entire platforms, e.g. TelosB or STM32 Discovery Boards. + * + * The microkernel itself comprises thread management, a priority-based scheduler, + * a powerful API for inter-process communication (IPC), a system timer, and + * mutexes. + * + * In order to build an application or library with RIOT, you need first to + * download the source code ([Getting the source + * code](https://github.com/RIOT-OS/RIOT/wiki/Introduction#getting-the-source-code)). This contains - besides the + * before mentioned features - also some example applications (located in the + * `examples` subdirectory) and a sample Makefile you may use for your own + * project. This Makefile template shows you how to compile and link your project + * against RIOT ([Compiling RIOT](https://github.com/RIOT-OS/RIOT/wiki/Introduction#compiling-riot)). + * + * If you want to use RIOT directly with your embedded platform, you need to + * install the corresponding toolchain for the deployed microcontroller ([ARM + * based platforms](https://github.com/RIOT-OS/RIOT/wiki/Introduction#platforms-based-on-arm), [TI MSP430 based + * platforms](https://github.com/RIOT-OS/RIOT/wiki/Introduction#platforms-based-on-ti-msp430)). + * + * ###Native RIOT - Run RIOT on your PC! + * + * As a special platform, you will find a CPU and board called `native` in the + * repository. This target allows you to run RIOT as a process on Linux on most + * supported hardware platforms. Just set CPU and BOARD to `native` in your + * project's Makefile, call `make`, and execute the resulting elf-file. Further + * documentation about the native port can be found in `cpu/native/README`. + * + * \subsection structure Structure + * + * The RIOT repository contains the following ten subdirectories: + * * boards + * * core + * * cpu + * * dist + * * doc + * * drivers + * * examples + * * pkg + * * sys + * * tests + * + * The `boards` directory provides the configurations and initialization code for + * supported IoT platforms. In `core` you can find the kernel, while `cpu` + * comprises microcontroller specific implementations like startup and exception + * handling code. The folder `dist` contains a template for an application's Makefile + * and external utilities like the terminal program `pyterm` or a script to build + * your own toolchain for ARM microcontrollers. Not very surprisingly you will find + * the (doxygen) documentation in `doc` and peripheral driver code in `drivers`. + * The `examples` folder provides some exemplary applications, `pkg` includes + * Makefiles to integrate external libraries into RIOT, and `sys` system libraries + * as well as the implementation of the network stacks which are located in + * `sys/net`. Finally, the subdirectory `tests` contains test applications, + * including also a few expect scripts to automatically validate some of them. + * + * \section features Special features + * + * ####The build system + * + * RIOT uses GNU make as build system. The simplest way to compile and link a + * project (application or library) with RIOT, is to set up a Makefile providing + * at least the following variables: + * * PROJECT + * * BOARD + * * RIOTBASE + * + * and an instruction to include the `Makefile.include`, located in RIOT's root + * folder. `PROJECT` should contain the (unique) name of your project, `BOARD` + * specifies the platform the project should be built for by default, and + * `RIOTBASE` specifies the path to your copy of the RIOT repository (note, that + * you may want to use `$(CURDIR)` here, to give a relative path). You can use Make's + * `?=` operator in order to allow overwriting variables from the command line. For + * example, you can easily specify the target platform, using the sample Makefile, + * by invoking make like this: + * + * ``` + * make BOARD=telosb + * ``` + * + * Besides typical targets like `clean`, `all`, or `doc`, RIOT provides the special + * targets `flash` and `term` to invoke the configured flashing and terminal tools + * for the specified platform. These targets use the variable `PORT` for the serial + * communication to the device. Neither this variable nor the targets `flash` and + * `term` are mandatory for the native port. + * + * Some RIOT folders contain special Makefiles like `Makefile.base`, + * `Makefile.include` or `Makefile.dep`. The first one can be included into other + * Makefiles to define some standard targets. The files called `Makefile.include` + * are used in `boards` and `cpu` to append target specific information to + * variables like `INCLUDES`, setting the include paths. `Makefile.dep` serves to + * define dependencies. + * + * ####Including modules + * + * By default a RIOT project comprises only the projects' code itself, the kernel, + * and platform specific code. In order to use additional modules, such as a + * particular device driver or a system library, you have to append the modules' + * names to the USEMODULE variable. For example, to build a project using the SHT11 + * temperature sensor and 6LoWPAN network stack, your Makefile needs to contain + * these lines: + * ``` + * USEMODULE += sht11 + * USEMODULE += sixlowpan + * ``` + * To contribute a new module to RIOT, your module's Makefile needs to set the + * variable `MODULE` to a unique name. If the module depends on other modules, this + * information needs to be added to RIOT's `Makefile.dep`. + * + * ####The main function + * + * After the board is initialized, RIOT starts two threads: the idle thread and the + * main thread. The idle thread has the lowest priority and will run, whenever no + * other thread is ready to run. It will automatically use the lowest possible + * power mode for the device. The main thread - configured with a default priority + * that is right in the middle between the lowest and the highest available + * priority - is the first thread that runs and calls the main function. This + * function needs to be defined by the project. + * + * ####The IPC + * + * Like any microkernel system, RIOT has an IPC API that enables data exchange + * between modules or a single module and the kernel. This API is documented in + * the [doxygen documentation](http://riot-os.org/api/). The IPC can be used in + * several ways, such as synchronous or asynchronous, blocking or non-blocking, + * with or without a message queue. In the default case, a thread does not have a + * message queue. Hence, messages sent in a non-blocking manner are lost, when the + * target thread is not in receive mode. A thread may set up a message queue using + * the [corresponding function](http://riot-os.org/api/group__kernel__msg.html), + * but has to provide the memory for this queue itself. + * + * ####Auto-init + * + * Most modules require initialization before they can be used. In some cases the + * initialization function does not require a parameter. For these modules you + * might use the auto-init feature by adding a line like + * ``` + * USEMODULE += auto_init + * ``` + * to your Makefile. Auto-init calls all module initialization functions with a + * `void` parameter just before the main thread gets executed. + * + * ####The transceiver module + * + * The transceiver module is an abstraction layer and multiplexer between the + * network stack and the radio driver. It runs in a single thread with the PID + * `transceiver_pid`. It provides an IPC interface that enables to configure and + * use available radio drivers, e.g. setting the radio channel or sending a packet. + * A thread may also register at the transceiver module, in order to get notified + * whenever a packet for a particular radio transceiver is received. The + * notification message contains a pointer to the packet struct. After processing + * the packet, the registered thread needs to decrease this struct's member + * `processing` which acts as a semaphore for the packet's memory buffer. * * \section info_sec Community * diff --git a/doc/getting_started.html b/doc/getting_started.html deleted file mode 100644 index 792c06a810fa..000000000000 --- a/doc/getting_started.html +++ /dev/null @@ -1,148 +0,0 @@ - - - - Start the RIOT - - - - -

Start the RIOT - Getting started with RIOT

- -
-
    -
  1. Requirements
    2. -
  2. Get the source code
    3. -
  3. Setup the toolchain
    4. -
  4. Setup a flashing tool
    5. -
  5. Hello World!
    6. -
  6. Write your first applicatoin
    7. -
-
- -

Requirements

- -

You may not to install additional packages for particular toolchains or flashing tools. For the MSB-A2 check the requirements in the Github Wiki.

-

Get the source code

-

You can obtain RIOT either by cloning the git repositories or download the latest tarballs.

- -

Using the git repository

-

In order to obtain RIOT from the official GitHub repositories, please perform the following commands:

-

The kernel

-
-git clone git://github.com/RIOT-OS/RIOT.git
-
-

The platform configurations

-
-git clone git://github.com/RIOT-OS/boards.git
-
-or -
-git clone git://github.com/RIOT-OS/thirdparty_boards.git
-git clone git://github.com/RIOT-OS/thirdparty_cpu.git
-
- -

Optional (recommended): Examplary projects

-
-git clone git://github.com/RIOT-OS/projects.git
-git submodule init
-git submodule update
-
- -

Download the tarballs

- - -

Setup the toolchain

-

You can either build RIOT for one of the supported hardware platforms (check -our website) or try the native port. As a special platform, -you will find a CPU and board called native in the repository. This -target allows you to run RIOT as a process on Linux on most supported hardware -platforms. Just set CPU and BOARD to native in your -project's Makefile, call make, and execute the resulting elf-file.

-

For ARM

-

The recommended toolchain for RIOT on ARM is an older version (2008q3) of CodeBench (formerly CodeSourcery) from Mentor Graphics. It can be obtained here.

-

Linux

-

Direct links for Linux are

-

http://www.codesourcery.com/.../arm-2008q3-66-arm-none-eabi.bin (with installer)

-

or

-

http://www.codesourcery.com/.../arm-2008q3-66-arm-none-eabi-i686-pc-linux-gnu.tar.bz2.

-

Please note that you will have to add the directory with executables (arm-none-eabi-gcc, arm-none-eabi-as etc.) to your PATH variable in both cases. -On a typical shell like bash or zsh this can be done using export, e.g.

-
-export PATH=${PATH}:/path/to/arm-none-eabi-gcc
-
-

Windows

-

The direct link for the Windows version is

-

http://www.codesourcery.com/.../arm-2008q3-66-arm-none-eabi.exe.

-

Mac OS X

-

There is a tutorial to install the CodeSourcery toolchain on Mac OS X: https://gist.github.com/errordeveloper/1854389.

-

Build the toolchain from sources

-

There is also the possibility to build the toolchain from the sources, allowing for newer versions of GCC, binutils, and Newlib. A script to build a toolchain for the MSB-A2 is available in the RIOT git repository at
-dist/tools/toolchains/build_gnuarm.sh.

-

For MSP430

-

Download and install GCC toolchain for MSP430 according to the information provided on the website.

-

For the native port

-

In order to build RIOT for the native port, you just need the GNU -Compiler Collection.

-

There is a README that explains how to use natives network controller.

- -

Setup a flashing tool

-

For MSB-A2

- -

For MSB-430H

-

Download and install MSPDebug according to the information provided on the website. You can also use MSPDebug for debugging.

-

For redbee-econotag

-

Folow the instructions for Getting Started with MC1322x. - - -

First test: Hello World!

- If you have obtained a copy of the projects repository, you can build the -famous Hello World application for RIOT. - - -

Write your first application

-

To write your own RIOT application, you just need a Makefile and C file(s) -containing your source code. A template Makefile is available in the dist -folder of the RIOT repository.

-

One of the C files has to provide a main function according to this -prototype:

-
-int main(void);
-
-

Within your project's Makefile, you can define the modules you want to use.

-

Unless specified otherwise, make will create an -elf-file as well as an Intel hex file in the bin folder of your project -directory. - -