Documentation improvements.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@807 35acf78f-673a-0410-8e92-d51de3d6d3f4
This commit is contained in:
gdisirio
parent
51cd594746
commit
1d222307d4
|
|
@ -576,7 +576,6 @@ WARN_LOGFILE =
|
|||
INPUT = ../src/include \
|
||||
../src/templates \
|
||||
../src \
|
||||
../docs/ch.txt \
|
||||
../docs/src \
|
||||
../src/lib \
|
||||
../ports/ARM7 \
|
||||
|
|
@ -692,7 +691,7 @@ EXAMPLE_RECURSIVE = NO
|
|||
# directories that contain image that are included in the documentation (see
|
||||
# the \image command).
|
||||
|
||||
IMAGE_PATH = ./img
|
||||
IMAGE_PATH = ./rsc
|
||||
|
||||
# The INPUT_FILTER tag can be used to specify a program that doxygen should
|
||||
# invoke to filter for each input file. Doxygen will invoke the filter program
|
||||
|
|
@ -822,13 +821,13 @@ HTML_FILE_EXTENSION = .html
|
|||
# each generated HTML page. If it is left blank doxygen will generate a
|
||||
# standard header.
|
||||
|
||||
HTML_HEADER =
|
||||
HTML_HEADER = ./rsc/header.html
|
||||
|
||||
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
|
||||
# each generated HTML page. If it is left blank doxygen will generate a
|
||||
# standard footer.
|
||||
|
||||
HTML_FOOTER =
|
||||
HTML_FOOTER = ./rsc/footer.html
|
||||
|
||||
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
|
||||
# style sheet that is used by each HTML page. It can be used to
|
||||
|
|
@ -837,7 +836,7 @@ HTML_FOOTER =
|
|||
# the style sheet file to the HTML output directory, so don't put your own
|
||||
# stylesheet in the HTML output directory as well, or it will be erased!
|
||||
|
||||
HTML_STYLESHEET =
|
||||
HTML_STYLESHEET = ./rsc/custom.css
|
||||
|
||||
# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
|
||||
# files or namespaces will be aligned in HTML using tables. If set to
|
||||
|
|
|
|||
407
docs/ch.txt
407
docs/ch.txt
|
|
@ -1,407 +0,0 @@
|
|||
/*
|
||||
ChibiOS/RT - Copyright (C) 2006-2007 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/>.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @mainpage ChibiOS/RT
|
||||
* @author Giovanni Di Sirio (gdisirio@users.sourceforge.net).
|
||||
*
|
||||
* <h2>Chibi ?</h2>
|
||||
* I didn't want a serious name for this project. It is the Japanese word for
|
||||
* small as in small child. So ChibiOS/RT
|
||||
* @htmlonly (<span class="t_nihongo_kanji" xml:lang="ja" lang="ja">ちび</span>OS/RT) @endhtmlonly
|
||||
* means small Real Time Operating System.
|
||||
* Source <a href="http://en.wikipedia.org/wiki/Chibi" target="_blank">Wikipedia</a>.
|
||||
*
|
||||
* <h2>Features</h2>
|
||||
* - Free software, GPL3 licensed. Stable releases include a exception clause
|
||||
* to the GPL.
|
||||
* - Designed for realtime applications.
|
||||
* - Easily portable.
|
||||
* - Preemptive scheduling.
|
||||
* - 128 priority levels. Multiple threads at the same priority level allowed.
|
||||
* - Round robin scheduling for threads at the same priority level.
|
||||
* - Offers threads, virtual timers, semaphores, mutexes, condvars,
|
||||
* event flags, messages, I/O queues.
|
||||
* - No static setup at compile time, there is no need to configure a maximum
|
||||
* number of all the above objects.
|
||||
* - PC simulator target included, the development can be done on the PC
|
||||
* using MinGW.<br>
|
||||
* Timers, I/O channels and other HW resources are simulated in a
|
||||
* Win32 process and the application code does not need to be aware of it.
|
||||
* MinGW demo available.
|
||||
* - No *need* for a memory allocator, all the kernel structures are static
|
||||
* and declaratively allocated.
|
||||
* - Optional, thread safe, Heap Allocator subsystem.
|
||||
* - Optional, thread safe, Memory Pools Allocator subsystem.
|
||||
* - Blocking and non blocking I/O channels with timeout and events generation
|
||||
* capability.
|
||||
* - Minimal system requirements: about 8KiB ROM with all options enabled and
|
||||
* speed optimizations on. The size can shrink under 2KiB by disabling the
|
||||
* the unused subsystems and optimizing for size.
|
||||
* - Almost totally written in C with little ASM code required for ports.
|
||||
* .
|
||||
* <h2>Related pages</h2>
|
||||
* - @subpage lic_faq
|
||||
* - @subpage goals
|
||||
* - @subpage concepts
|
||||
* - @subpage articles
|
||||
* .
|
||||
*/
|
||||
|
||||
/**
|
||||
* @defgroup Ports Ports
|
||||
* @{
|
||||
* This section describes the technical details for the various supported
|
||||
* ChibiOS/RT ports.
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Kernel Kernel
|
||||
* @{
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Config Configuration
|
||||
* @{
|
||||
* In @p chconf.h are defined the required subsystems for your application.
|
||||
* @ingroup Kernel
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Core Generic Port Code Templates
|
||||
* @{
|
||||
* Non portable code templates.
|
||||
* @ingroup Kernel
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Types Types
|
||||
* @{
|
||||
* System types and macros.
|
||||
* @ingroup Kernel
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup System System Management
|
||||
* @{
|
||||
* Initialization, Locks, Interrupt Handling, Power Management, Abnormal
|
||||
* Termination.
|
||||
* @ingroup Kernel
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Inline Inline
|
||||
* @{
|
||||
* System inline-able code.
|
||||
* @ingroup Kernel
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Debug Debug
|
||||
* @{
|
||||
* Debug APIs and procedures.
|
||||
* @ingroup Kernel
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Scheduler Scheduler
|
||||
* @{
|
||||
* ChibiOS/RT scheduler.
|
||||
* @ingroup Kernel
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup ThreadLists Thread Lists and Queues
|
||||
* @{
|
||||
* ChibiOS/RT thread lists and queues utilities.
|
||||
* @ingroup Kernel
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Threads Threads
|
||||
* @{
|
||||
* Threads creation and termination APIs.
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Time Time and Virtual Timers
|
||||
* @{
|
||||
* Time and Virtual Timers related APIs.
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Heap Heap
|
||||
* @{
|
||||
* Heap Allocator related APIs.
|
||||
* <h2>Operation mode</h2>
|
||||
* The heap allocator implements a first-fit strategy and its APIs are
|
||||
* functionally equivalent to the usual @p malloc() and @p free(). The main
|
||||
* difference is that the heap APIs are thread safe.<br>
|
||||
* By enabling the @p CH_USE_MALLOC_HEAP option the heap manager will use the
|
||||
* runtime-provided @p malloc() and @p free() as backend for the heap APIs
|
||||
* instead of the system provided allocator.<br>
|
||||
* In order to use the heap APIs the @p CH_USE_HEAP option must be specified
|
||||
* in @p chconf.h.
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup MemoryPools Memory Pools
|
||||
* @{
|
||||
* Memory Pools related APIs.
|
||||
* <h2>Operation mode</h2>
|
||||
* The Memory Pools APIs allow to allocate/free fixed size objects in
|
||||
* <b>constant time</b> and reliably without memory fragmentation problems.<br>
|
||||
* In order to use the Time APIs the @p CH_USE_MEMPOOLS option must be
|
||||
* specified in @p chconf.h.
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Semaphores Semaphores
|
||||
* @{
|
||||
* Semaphores and threads synchronization.
|
||||
* <h2>Operation mode</h2>
|
||||
* A semaphore is a threads synchronization object, some operations
|
||||
* are defined on semaphores:
|
||||
* - <b>Signal</b>: The semaphore counter is increased and if the result
|
||||
* is non-positive then a waiting thread is removed from the semaphore
|
||||
* queue and made ready for execution.
|
||||
* - <b>Wait</b>: The semaphore counter is decreased and if the result
|
||||
* becomes negative the thread is queued in the semaphore and suspended.
|
||||
* - <b>Reset</b>: The semaphore counter is reset to a non-negative value
|
||||
* and all the threads in the queue are released.
|
||||
* .
|
||||
* Semaphores can be used as guards for mutual exclusion code zones (note that
|
||||
* mutexes are recommended for this kind of use) but also have other uses,
|
||||
* queues guards and counters as example.<br>
|
||||
* Semaphores usually use FIFO queues but it is possible to make them
|
||||
* order threads by priority by specifying CH_USE_SEMAPHORES_PRIORITY in
|
||||
* @p chconf.h.<br>
|
||||
* In order to use the Semaphores APIs the @p CH_USE_SEMAPHORES
|
||||
* option must be specified in @p chconf.h.<br><br>
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Mutexes Mutexes
|
||||
* @{
|
||||
* Mutexes and threads synchronization.
|
||||
* <h2>Operation mode</h2>
|
||||
* A mutex is a threads synchronization object, some operations are defined
|
||||
* on mutexes:
|
||||
* - <b>Lock</b>: The mutex is checked, if the mutex is not owned by some
|
||||
* other thread then it is locked else the current thread is queued on the
|
||||
* mutex in a list ordered by priority.
|
||||
* - <b>Unlock</b>: The mutex is released by the owner and the highest
|
||||
* priority thread waiting in the queue, if any, is resumed and made owner
|
||||
* of the mutex.
|
||||
* .
|
||||
* In order to use the Event APIs the @p CH_USE_MUTEXES option must be
|
||||
* specified in @p chconf.h.<br>
|
||||
*
|
||||
* <h2>Constraints</h2>
|
||||
* In ChibiOS/RT the Unlock operations are always performed in Lock-reverse
|
||||
* order. The Unlock API does not even have a parameter, the mutex to unlock
|
||||
* is taken from an internal stack of owned mutexes.
|
||||
* This both improves the performance and is required by the priority
|
||||
* inheritance mechanism.
|
||||
*
|
||||
* <h2>The priority inversion problem</h2>
|
||||
* The mutexes in ChibiOS/RT implements the <b>full</b> priority
|
||||
* inheritance mechanism in order handle the priority inversion problem.<br>
|
||||
* When a thread is queued on a mutex, any thread, directly or indirectly,
|
||||
* holding the mutex gains the same priority of the waiting thread (if their
|
||||
* priority was not already equal or higher). The mechanism works with any
|
||||
* number of nested mutexes and any number of involved threads. The algorithm
|
||||
* complexity (worst case) is N with N equal to the number of nested mutexes.
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup CondVars Condition Variables
|
||||
* @{
|
||||
* Condition Variables and threads synchronization.
|
||||
* <h2>Operation mode</h2>
|
||||
* The condition variable is a synchronization object meant to be used inside
|
||||
* a zone protected by a @p Mutex. Mutexes and CondVars together can implement
|
||||
* a Monitor construct.<br>
|
||||
* In order to use the Condition Variables APIs the @p CH_USE_CONDVARS
|
||||
* option must be specified in @p chconf.h.<br><br>
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Events Events
|
||||
* @{
|
||||
* Event Sources and Event Listeners.
|
||||
* <h2>Operation mode</h2>
|
||||
* An Event Source is a special object that can be signaled by a thread or
|
||||
* an interrupt service routine. Signaling an Event Source has the effect
|
||||
* that all the threads registered on the Event Source will receive
|
||||
* and serve the event.<br>
|
||||
* An unlimited number of Event Sources can exists in a system and each
|
||||
* thread can listen on an unlimited number of them.<br>
|
||||
* Note that the events can be asynchronously generated but are synchronously
|
||||
* served, a thread can serve event by calling a @p chEvtWaitXXX()
|
||||
* API. If an event is generated while a listening thread is not ready to
|
||||
* serve it then the event becomes "pending" and will be served as soon the
|
||||
* thread invokes a @p chEvtWaitXXX().<br>
|
||||
* In order to use the Event APIs the @p CH_USE_EVENTS option must be
|
||||
* specified in @p chconf.h.
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Messages Synchronous Messages
|
||||
* @{
|
||||
* Synchronous inter-thread messages.
|
||||
* <h2>Operation Mode</h2>
|
||||
* Synchronoud messages are an easy to use and fast IPC mechanism, threads
|
||||
* can both serve messages and send messages to other threads, the mechanism
|
||||
* allows data to be carried in both directions. Data is not copied between
|
||||
* the client and server threads but just a pointer passed so the exchange
|
||||
* is very time efficient.<br>
|
||||
* Messages are usually processed in FIFO order but it is possible to process
|
||||
* them in priority order by specifying CH_USE_MESSAGES_PRIORITY
|
||||
* in @p chconf.h.<br>
|
||||
* Threads do not need to allocate space for message queues, the mechanism
|
||||
* just requires two extra pointers in the @p Thread structure (the message
|
||||
* queue header).<br>
|
||||
* In order to use the Messages APIs the @p CH_USE_MESSAGES option must be
|
||||
* specified in @p chconf.h.
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Mailboxes Mailboxes
|
||||
* @{
|
||||
* Asynchronous messages.
|
||||
* <h2>Operation mode</h2>
|
||||
* A mailbox is an asynchronous communication mechanism.<br>
|
||||
* The following operations are possible on a mailbox:
|
||||
* - <b>Post</b>: Posts a message on the mailbox in FIFO order.
|
||||
* - <b>Post Ahead</b>: Posts a message on the mailbox with high priority.
|
||||
* - <b>Fetch</b>: A message is fetched from the mailbox and removed from
|
||||
* the queue.
|
||||
* - <b>Reset</b>: The mailbox is emptied and all the stored messages lost.
|
||||
* .
|
||||
* A message is a variable of type msg_t that is guaranteed to have the
|
||||
* same size of and be compatible with pointers (an explicit cast is needed).
|
||||
* If larger messages need to be exchanged then a pointer to a structure can
|
||||
* be posted in the mailbox but the posting side has no predefined way to
|
||||
* know when the message has been processed. A possible approach is to
|
||||
* allocate memory (from a memory pool as example) from the posting side and
|
||||
* free it on the fetching side. Another approach is to set a "done" flag into
|
||||
* the structure pointed by the message.
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup IOQueues I/O Queues
|
||||
* @{
|
||||
* ChibiOS/RT supports several kinds of queues. The queues are mostly used
|
||||
* in serial-like device drivers. The device drivers are usually designed to
|
||||
* have a lower side (lower driver, it is usually an interrupt service
|
||||
* routine) and an upper side (upper driver, accessed by the application
|
||||
* threads).<br>
|
||||
* There are several kind of queues:<br>
|
||||
* - <b>Input queue</b>, unidirectional queue where the writer is the
|
||||
* lower side and the reader is the upper side.
|
||||
* - <b>Output queue</b>, unidirectional queue where the writer is the
|
||||
* upper side and the reader is the lower side.
|
||||
* - <b>Half duplex queue</b>, bidirectional queue where the buffer is shared
|
||||
* between a receive and a transmit queues. This means that concurrent
|
||||
* buffered input and output operations are not possible, this is perfectly
|
||||
* acceptable for a lot of applications however, as example an RS485 driver.
|
||||
* - <b>Full duplex queue</b>, bidirectional queue where read and write
|
||||
* operations can happen at the same time. Full duplex queues
|
||||
* are implemented by pairing an input queue and an output queue together.
|
||||
* .
|
||||
* In order to use the I/O queues the @p CH_USE_QUEUES option must
|
||||
* be specified in @p chconf.h.<br>
|
||||
* In order to use the half duplex queues the @p CH_USE_QUEUES_HALFDUPLEX
|
||||
* option must be specified in @p chconf.h.
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup Serial Serial Drivers
|
||||
* @{
|
||||
* This module implements a generic full duplex serial driver and a generic
|
||||
* half duplex serial driver. It uses the I/O Queues for communication between
|
||||
* the upper and the lower driver and events to notify the application about
|
||||
* incoming data, outcoming data and other I/O events.
|
||||
* The module also contains functions that make the implementation of the
|
||||
* interrupt service routines much easier.<br>
|
||||
* In order to use the serial full duplex driver the
|
||||
* @p CH_USE_SERIAL_FULLDUPLEX option must be specified in @p chconf.h.<br>
|
||||
* In order to use the serial half duplex driver the
|
||||
* @p CH_USE_SERIAL_HALFDUPLEX option must be specified in @p chconf.h.
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup utilities_library Utilities Library
|
||||
* @{
|
||||
* @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 CPlusPlusLibrary C++ Wrapper
|
||||
* @{
|
||||
* C++ wrapper module. This module allows to use the ChibiOS/RT functionalities
|
||||
* from C++ as classes and objects rather the traditional "C" APIs.
|
||||
*
|
||||
* @ingroup utilities_library
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @defgroup event_timer Events Generator Timer
|
||||
* @{
|
||||
* @brief Event Generator 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 utilities_library
|
||||
*/
|
||||
/** @} */
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 7.5 KiB |
|
|
@ -0,0 +1,441 @@
|
|||
body, table, div, p, dl {
|
||||
font-family: Lucida Grande, Verdana, Geneva, Arial, sans-serif;
|
||||
font-size: 12px;
|
||||
}
|
||||
|
||||
/* @group Heading Levels */
|
||||
|
||||
h1 {
|
||||
text-align: center;
|
||||
font-size: 150%;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 120%;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 100%;
|
||||
}
|
||||
|
||||
/* @end */
|
||||
|
||||
caption {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.qindex, div.navpath, div.navtab{
|
||||
background-color: #e8eef2;
|
||||
border: 1px solid #84b0c7;
|
||||
text-align: center;
|
||||
margin: 2px;
|
||||
padding: 2px;
|
||||
}
|
||||
|
||||
div.qindex, div.navpath {
|
||||
width: 100%;
|
||||
line-height: 140%;
|
||||
}
|
||||
|
||||
div.navtab {
|
||||
margin-right: 15px;
|
||||
}
|
||||
|
||||
/* @group Link Styling */
|
||||
|
||||
a {
|
||||
color: #153788;
|
||||
font-weight: normal;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.contents a:visited {
|
||||
color: #1b77c5;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
a.qindex {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
a.qindexHL {
|
||||
font-weight: bold;
|
||||
background-color: #6666cc;
|
||||
color: #ffffff;
|
||||
border: 1px double #9295C2;
|
||||
}
|
||||
|
||||
a.el {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
a.elRef {
|
||||
}
|
||||
|
||||
a.code {
|
||||
}
|
||||
|
||||
a.codeRef {
|
||||
}
|
||||
|
||||
/* @end */
|
||||
|
||||
dl.el {
|
||||
margin-left: -1cm;
|
||||
}
|
||||
|
||||
.fragment {
|
||||
font-family: monospace, fixed;
|
||||
font-size: 105%;
|
||||
}
|
||||
|
||||
pre.fragment {
|
||||
border: 1px solid #CCCCCC;
|
||||
background-color: #f5f5f5;
|
||||
padding: 4px 6px;
|
||||
margin: 4px 8px 4px 2px;
|
||||
}
|
||||
|
||||
div.ah {
|
||||
background-color: black;
|
||||
font-weight: bold;
|
||||
color: #ffffff;
|
||||
margin-bottom: 3px;
|
||||
margin-top: 3px
|
||||
}
|
||||
|
||||
div.groupHeader {
|
||||
margin-left: 16px;
|
||||
margin-top: 12px;
|
||||
margin-bottom: 6px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.groupText {
|
||||
margin-left: 16px;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
body {
|
||||
background: white;
|
||||
color: black;
|
||||
margin-right: 20px;
|
||||
margin-left: 20px;
|
||||
}
|
||||
|
||||
td.indexkey {
|
||||
background-color: #e8eef2;
|
||||
font-weight: bold;
|
||||
border: 1px solid #CCCCCC;
|
||||
margin: 2px 0px 2px 0;
|
||||
padding: 2px 10px;
|
||||
}
|
||||
|
||||
td.indexvalue {
|
||||
background-color: #e8eef2;
|
||||
border: 1px solid #CCCCCC;
|
||||
padding: 2px 10px;
|
||||
margin: 2px 0px;
|
||||
}
|
||||
|
||||
tr.memlist {
|
||||
background-color: #f0f0f0;
|
||||
}
|
||||
|
||||
p.formulaDsp {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
img.formulaDsp {
|
||||
|
||||
}
|
||||
|
||||
img.formulaInl {
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
/* @group Code Colorization */
|
||||
|
||||
span.keyword {
|
||||
color: #008000
|
||||
}
|
||||
|
||||
span.keywordtype {
|
||||
color: #604020
|
||||
}
|
||||
|
||||
span.keywordflow {
|
||||
color: #e08000
|
||||
}
|
||||
|
||||
span.comment {
|
||||
color: #800000
|
||||
}
|
||||
|
||||
span.preprocessor {
|
||||
color: #806020
|
||||
}
|
||||
|
||||
span.stringliteral {
|
||||
color: #002080
|
||||
}
|
||||
|
||||
span.charliteral {
|
||||
color: #008080
|
||||
}
|
||||
|
||||
span.vhdldigit {
|
||||
color: #ff00ff
|
||||
}
|
||||
|
||||
span.vhdlchar {
|
||||
color: #000000
|
||||
}
|
||||
|
||||
span.vhdlkeyword {
|
||||
color: #700070
|
||||
}
|
||||
|
||||
span.vhdllogic {
|
||||
color: #ff0000
|
||||
}
|
||||
|
||||
/* @end */
|
||||
|
||||
.search {
|
||||
color: #003399;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
form.search {
|
||||
margin-bottom: 0px;
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
input.search {
|
||||
font-size: 75%;
|
||||
color: #000080;
|
||||
font-weight: normal;
|
||||
background-color: #e8eef2;
|
||||
}
|
||||
|
||||
td.tiny {
|
||||
font-size: 75%;
|
||||
}
|
||||
|
||||
.dirtab {
|
||||
padding: 4px;
|
||||
border-collapse: collapse;
|
||||
border: 1px solid #84b0c7;
|
||||
}
|
||||
|
||||
th.dirtab {
|
||||
background: #e8eef2;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
hr {
|
||||
height: 0;
|
||||
border: none;
|
||||
border-top: 1px solid #666;
|
||||
}
|
||||
|
||||
/* @group Member Descriptions */
|
||||
|
||||
.mdescLeft, .mdescRight,
|
||||
.memItemLeft, .memItemRight,
|
||||
.memTemplItemLeft, .memTemplItemRight, .memTemplParams {
|
||||
background-color: #FAFAFA;
|
||||
border: none;
|
||||
margin: 4px;
|
||||
padding: 1px 0 0 8px;
|
||||
}
|
||||
|
||||
.mdescLeft, .mdescRight {
|
||||
padding: 0px 8px 4px 8px;
|
||||
color: #555;
|
||||
}
|
||||
|
||||
.memItemLeft, .memItemRight, .memTemplParams {
|
||||
border-top: 1px solid #ccc;
|
||||
}
|
||||
|
||||
.memTemplParams {
|
||||
color: #606060;
|
||||
}
|
||||
|
||||
/* @end */
|
||||
|
||||
/* @group Member Details */
|
||||
|
||||
/* Styles for detailed member documentation */
|
||||
|
||||
.memtemplate {
|
||||
font-size: 80%;
|
||||
color: #606060;
|
||||
font-weight: normal;
|
||||
margin-left: 3px;
|
||||
}
|
||||
|
||||
.memnav {
|
||||
background-color: #e8eef2;
|
||||
border: 1px solid #84b0c7;
|
||||
text-align: center;
|
||||
margin: 2px;
|
||||
margin-right: 15px;
|
||||
padding: 2px;
|
||||
}
|
||||
|
||||
.memitem {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.memname {
|
||||
white-space: nowrap;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.memproto, .memdoc {
|
||||
border: 1px solid #84b0c7;
|
||||
}
|
||||
|
||||
.memproto {
|
||||
padding: 0;
|
||||
background-color: #d5e1e8;
|
||||
font-weight: bold;
|
||||
-webkit-border-top-left-radius: 8px;
|
||||
-webkit-border-top-right-radius: 8px;
|
||||
-moz-border-radius-topleft: 8px;
|
||||
-moz-border-radius-topright: 8px;
|
||||
}
|
||||
|
||||
.memdoc {
|
||||
padding: 2px 5px;
|
||||
background-color: #eef3f5;
|
||||
border-top-width: 0;
|
||||
-webkit-border-bottom-left-radius: 8px;
|
||||
-webkit-border-bottom-right-radius: 8px;
|
||||
-moz-border-radius-bottomleft: 8px;
|
||||
-moz-border-radius-bottomright: 8px;
|
||||
}
|
||||
|
||||
.memdoc p, .memdoc dl, .memdoc ul {
|
||||
margin: 6px 0;
|
||||
}
|
||||
|
||||
.paramkey {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
.paramtype {
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.paramname {
|
||||
color: #602020;
|
||||
white-space: nowrap;
|
||||
}
|
||||
.paramname em {
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* @end */
|
||||
|
||||
/* @group Directory (tree) */
|
||||
|
||||
/* for the tree view */
|
||||
|
||||
.ftvtree {
|
||||
font-family: sans-serif;
|
||||
margin: 0.5em;
|
||||
}
|
||||
|
||||
/* these are for tree view when used as main index */
|
||||
|
||||
.directory {
|
||||
font-size: 9pt;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.directory h3 {
|
||||
margin: 0px;
|
||||
margin-top: 1em;
|
||||
font-size: 11pt;
|
||||
}
|
||||
|
||||
/*
|
||||
The following two styles can be used to replace the root node title
|
||||
with an image of your choice. Simply uncomment the next two styles,
|
||||
specify the name of your image and be sure to set 'height' to the
|
||||
proper pixel height of your image.
|
||||
*/
|
||||
|
||||
/*
|
||||
.directory h3.swap {
|
||||
height: 61px;
|
||||
background-repeat: no-repeat;
|
||||
background-image: url("yourimage.gif");
|
||||
}
|
||||
.directory h3.swap span {
|
||||
display: none;
|
||||
}
|
||||
*/
|
||||
|
||||
.directory > h3 {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
.directory p {
|
||||
margin: 0px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.directory div {
|
||||
display: none;
|
||||
margin: 0px;
|
||||
}
|
||||
|
||||
.directory img {
|
||||
vertical-align: -30%;
|
||||
}
|
||||
|
||||
/* these are for tree view when not used as main index */
|
||||
|
||||
.directory-alt {
|
||||
font-size: 100%;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.directory-alt h3 {
|
||||
margin: 0px;
|
||||
margin-top: 1em;
|
||||
font-size: 11pt;
|
||||
}
|
||||
|
||||
.directory-alt > h3 {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
.directory-alt p {
|
||||
margin: 0px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
|
||||
.directory-alt div {
|
||||
display: none;
|
||||
margin: 0px;
|
||||
}
|
||||
|
||||
.directory-alt img {
|
||||
vertical-align: -30%;
|
||||
}
|
||||
|
||||
/* @end */
|
||||
|
||||
address {
|
||||
font-style: normal;
|
||||
color: #333;
|
||||
}
|
||||
|
|
@ -0,0 +1,4 @@
|
|||
<hr size="1"><address style="text-align: right;"><small>
|
||||
Generated on $datetime for $projectname by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> $doxygenversion</small></address>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -0,0 +1,17 @@
|
|||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
||||
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
||||
<title>$title</title>
|
||||
<link href="custom.css" rel="stylesheet" type="text/css">
|
||||
<link href="tabs.css" rel="stylesheet" type="text/css">
|
||||
</head><body>
|
||||
<table style="text-align: center; width: 100%;" border="0"
|
||||
cellpadding="2" cellspacing="2">
|
||||
<tbody>
|
||||
<tr>
|
||||
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
|
||||
<td><big>ChibiOS/RT</big><br><br>Architecture - Reference Manual - Guides</td>
|
||||
<td style="width: 80px;"></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<hr size="1">
|
||||
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 9.5 KiB After Width: | Height: | Size: 9.5 KiB |
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
|
|
@ -0,0 +1,102 @@
|
|||
/* tabs styles, based on http://www.alistapart.com/articles/slidingdoors */
|
||||
|
||||
DIV.tabs
|
||||
{
|
||||
float : left;
|
||||
width : 100%;
|
||||
background : url("tab_b.gif") repeat-x bottom;
|
||||
margin-bottom : 4px;
|
||||
}
|
||||
|
||||
DIV.tabs UL
|
||||
{
|
||||
margin : 0px;
|
||||
padding-left : 10px;
|
||||
list-style : none;
|
||||
}
|
||||
|
||||
DIV.tabs LI, DIV.tabs FORM
|
||||
{
|
||||
display : inline;
|
||||
margin : 0px;
|
||||
padding : 0px;
|
||||
}
|
||||
|
||||
DIV.tabs FORM
|
||||
{
|
||||
float : right;
|
||||
}
|
||||
|
||||
DIV.tabs A
|
||||
{
|
||||
float : left;
|
||||
background : url("tab_r.gif") no-repeat right top;
|
||||
border-bottom : 1px solid #84B0C7;
|
||||
font-size : 8px;
|
||||
font-weight : bold;
|
||||
text-decoration : none;
|
||||
}
|
||||
|
||||
DIV.tabs A:hover
|
||||
{
|
||||
background-position: 100% -150px;
|
||||
}
|
||||
|
||||
DIV.tabs A:link, DIV.tabs A:visited,
|
||||
DIV.tabs A:active, DIV.tabs A:hover
|
||||
{
|
||||
color: #1A419D;
|
||||
}
|
||||
|
||||
DIV.tabs SPAN
|
||||
{
|
||||
float : left;
|
||||
display : block;
|
||||
background : url("tab_l.gif") no-repeat left top;
|
||||
padding : 5px 9px;
|
||||
white-space : nowrap;
|
||||
}
|
||||
|
||||
DIV.tabs INPUT
|
||||
{
|
||||
float : right;
|
||||
display : inline;
|
||||
font-size : 1em;
|
||||
}
|
||||
|
||||
DIV.tabs TD
|
||||
{
|
||||
font-size : 8px;
|
||||
font-weight : bold;
|
||||
text-decoration : none;
|
||||
}
|
||||
|
||||
|
||||
|
||||
/* Commented Backslash Hack hides rule from IE5-Mac \*/
|
||||
DIV.tabs SPAN {float : none;}
|
||||
/* End IE5-Mac hack */
|
||||
|
||||
DIV.tabs A:hover SPAN
|
||||
{
|
||||
background-position: 0% -150px;
|
||||
}
|
||||
|
||||
DIV.tabs LI.current A
|
||||
{
|
||||
background-position: 100% -150px;
|
||||
border-width : 0px;
|
||||
}
|
||||
|
||||
DIV.tabs LI.current SPAN
|
||||
{
|
||||
background-position: 0% -150px;
|
||||
padding-bottom : 6px;
|
||||
}
|
||||
|
||||
DIV.navpath
|
||||
{
|
||||
background : none;
|
||||
border : none;
|
||||
border-bottom : 1px solid #84B0C7;
|
||||
}
|
||||
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 20 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
4
todo.txt
4
todo.txt
|
|
@ -41,9 +41,11 @@ X Abstract I/O channels rather than just serial ports.
|
|||
- Think about making threads return void.
|
||||
|
||||
Ideas for 2.x.x:
|
||||
- High resolution timers and tickless kernel.
|
||||
- Reference counter for threads, concept of detached threads, threads
|
||||
management.
|
||||
- Think to the high resolution timers and tickless kernel.
|
||||
|
||||
Ideas for 3.x.x:
|
||||
- Multicore support.
|
||||
|
||||
Side projects:
|
||||
|
|
|
|||
Loading…
Reference in New Issue