Blame view

Project/os/various/various.dox 3.14 KB
Imanol-Mikel Barba Sabariego authored
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
/*
    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
                 2011,2012 Giovanni Di Sirio.

    This file is part of ChibiOS/RT.

    ChibiOS/RT is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    ChibiOS/RT is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

                                      ---

    A special exception to the GPL can be applied should you wish to distribute
    a combined work that includes ChibiOS/RT, without being obliged to provide
    the source code for any proprietary components. See the file exception.txt
    for full details of how and when the exception can be applied.
*/

/**
 * @defgroup various Various
 *
 * @brief   Utilities Library.
 * @details This is a collection of useful library code that is not part of
 *          the base kernel services.
 * <h2>Notes</h2>
 * The library code does not follow the same naming convention of the
 * system APIs in order to make very clear that it is not "core" code.<br>
 * The main difference is that library code is not formally  tested in the
 * test suite but through usage in the various demo applications.
 */

/**
 * @defgroup cpp_library C++ Wrapper
 *
 * @brief   C++ wrapper module.
 * @details This module allows to use the ChibiOS/RT functionalities
 *          from C++ as classes and objects rather the traditional "C" APIs.
 *
 * @ingroup various
 */

/**
 * @defgroup memory_streams Memory Streams
 *
 * @brief   Memory Streams.
 * @details This module allows to use a memory area (RAM or ROM) using a
 *          @ref data_streams interface.
 *
 * @ingroup various
 */

/**
 * @defgroup event_timer Periodic Events Timer
 *
 * @brief   Periodic Event Timer.
 * @details This timer generates an event at regular intervals. The
 *          listening threads can use the event to perform time related
 *          activities. Multiple threads can listen to the same timer.
 *
 * @ingroup various
 */

/**
 * @defgroup SHELL Command Shell
 *
 * @brief   Small extendible command line shell.
 * @details This module implements a generic extendible command line interface.
 *          The CLI just requires an I/O channel (@p BaseChannel), more
 *          commands can be added to the shell using the configuration
 *          structure.
 *
 * @ingroup various
 */

/**
 * @defgroup lis302dl Interface module for LIS302DL MEMS.
 *
 * @brief   Interface module for LIS302DL MEMS.
 * @details This module implements a generic interface for the LIS302DL
 *          STMicroelectronics MEMS device. The communication is performed
 *          through a standard SPI driver.
 *
 * @ingroup various
 */