From 1d222307d4b60222ac1f3e619549ecd672a1e710 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Mon, 2 Mar 2009 15:42:19 +0000 Subject: [PATCH] Documentation improvements. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@807 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- docs/Doxyfile | 9 +- docs/ch.txt | 407 ----------------------------- docs/html/logo_small.png | Bin 0 -> 7697 bytes docs/rsc/custom.css | 441 ++++++++++++++++++++++++++++++++ docs/rsc/footer.html | 4 + docs/rsc/header.html | 17 ++ docs/{img => rsc}/logo.png | Bin docs/{img => rsc}/readylist.png | Bin docs/{img => rsc}/readylist.svg | 0 docs/rsc/tabs.css | 102 ++++++++ docs/{img => rsc}/workspace.png | Bin docs/{img => rsc}/workspace.svg | 0 todo.txt | 4 +- 13 files changed, 571 insertions(+), 413 deletions(-) delete mode 100644 docs/ch.txt create mode 100644 docs/html/logo_small.png create mode 100644 docs/rsc/custom.css create mode 100644 docs/rsc/footer.html create mode 100644 docs/rsc/header.html rename docs/{img => rsc}/logo.png (100%) rename docs/{img => rsc}/readylist.png (100%) rename docs/{img => rsc}/readylist.svg (100%) create mode 100644 docs/rsc/tabs.css rename docs/{img => rsc}/workspace.png (100%) rename docs/{img => rsc}/workspace.svg (100%) diff --git a/docs/Doxyfile b/docs/Doxyfile index 71904c177..81066b6c9 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -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 diff --git a/docs/ch.txt b/docs/ch.txt deleted file mode 100644 index 58a96870d..000000000 --- a/docs/ch.txt +++ /dev/null @@ -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 . -*/ - -/** - * @mainpage ChibiOS/RT - * @author Giovanni Di Sirio (gdisirio@users.sourceforge.net). - * - *

Chibi ?

- * 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 (ちびOS/RT) @endhtmlonly - * means small Real Time Operating System. - * Source Wikipedia. - * - *

Features

- * - 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.
- * 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. - * . - *

Related pages

- * - @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. - *

Operation mode

- * 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.
- * 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.
- * 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. - *

Operation mode

- * The Memory Pools APIs allow to allocate/free fixed size objects in - * constant time and reliably without memory fragmentation problems.
- * 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. - *

Operation mode

- * A semaphore is a threads synchronization object, some operations - * are defined on semaphores: - * - Signal: 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. - * - Wait: The semaphore counter is decreased and if the result - * becomes negative the thread is queued in the semaphore and suspended. - * - Reset: 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.
- * 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.
- * In order to use the Semaphores APIs the @p CH_USE_SEMAPHORES - * option must be specified in @p chconf.h.

- */ -/** @} */ - -/** - * @defgroup Mutexes Mutexes - * @{ - * Mutexes and threads synchronization. - *

Operation mode

- * A mutex is a threads synchronization object, some operations are defined - * on mutexes: - * - Lock: 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. - * - Unlock: 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.
- * - *

Constraints

- * 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. - * - *

The priority inversion problem

- * The mutexes in ChibiOS/RT implements the full priority - * inheritance mechanism in order handle the priority inversion problem.
- * 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. - *

Operation mode

- * 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.
- * In order to use the Condition Variables APIs the @p CH_USE_CONDVARS - * option must be specified in @p chconf.h.

- */ -/** @} */ - -/** - * @defgroup Events Events - * @{ - * Event Sources and Event Listeners. - *

Operation mode

- * 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.
- * An unlimited number of Event Sources can exists in a system and each - * thread can listen on an unlimited number of them.
- * 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().
- * 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. - *

Operation Mode

- * 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.
- * 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.
- * 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).
- * 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. - *

Operation mode

- * A mailbox is an asynchronous communication mechanism.
- * The following operations are possible on a mailbox: - * - Post: Posts a message on the mailbox in FIFO order. - * - Post Ahead: Posts a message on the mailbox with high priority. - * - Fetch: A message is fetched from the mailbox and removed from - * the queue. - * - Reset: 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).
- * There are several kind of queues:
- * - Input queue, unidirectional queue where the writer is the - * lower side and the reader is the upper side. - * - Output queue, unidirectional queue where the writer is the - * upper side and the reader is the lower side. - * - Half duplex queue, 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. - * - Full duplex queue, 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.
- * 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.
- * In order to use the serial full duplex driver the - * @p CH_USE_SERIAL_FULLDUPLEX option must be specified in @p chconf.h.
- * 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. - *

Notes

- * 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.
- * 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 - */ -/** @} */ - diff --git a/docs/html/logo_small.png b/docs/html/logo_small.png new file mode 100644 index 0000000000000000000000000000000000000000..c53451bbac96dd9568ca295eb43478cdb1c9aeec GIT binary patch literal 7697 zcmV+s9`50ZP)00004XF*Lt006O% z3;baP00009a7bBm0017r0017r0mErjQvd)Rvq?ljRA}DKdU>>5MYZ?dRdt4*Zr^#z zJP#xgAp}Ag0|6c}goyBnpvVj=JVXfiiGupT=`qMtKSdA(UIav$5dsOsBp3(@Arl$N zO>*a6uAN$;=GQnwGA5rl-()-Wiw2oa+A*>6rl! z(h&??APmg&|3E1mN=-yW%-oml-MV4RmK~dz`HnkogYlro!u4M}k4Y0Tks&7jdn269 z7!w4(ANYRY8#3Yd`+sI;GFtn-9|XQJW>A2Ed;Z}upq@cB{Ojd&{7PfTksAJpm zVCOW(pg<`OeEC0cAtI7eE?@TQnh*av;ljke9l32AH&1JtvZZscsX=hScnAO#uykpkoIdVzqenDV)hFki z^e;_AM@lIXz!(DnLWqOa`gZ_?W(SZf-d%|?F>y$9N7pu&y<4xp>DUV&DUym3hLCFfsu*1w!RY0NYlP=xqLA_R#D5yL;EdU`Iu_2PGS zE-e64fv;b1?H^xyYS+&6Pj34`cTe{#A3kU&RZaKNOJ06Ussn}&-B&5q)02AaiC;bY z*T*)ccdA-;D=}ibRAwU39vP3&1rOFTC*lLl55HQn4|WNIQXBE(FQ}5Nz@cF0ujRGk6Ro2$0zT z`5+WHH9|$vlmQh&S)})9-D)bqy8GYnz4DrG7_CtpHsrz~LI42pAHTYD%$etNcg;N)_8zs3 zngWx8Qr-g~V~7YKhFs!O7y0|BypMF6P@q#I>?9&Vsh3Ezuo;mI>S!IrCR?T9`r2<_ z|J`qYOCT~psG~zJxB!4!2U4n)>z19g@bsp!b}`Vo4=Ltie5#TOLO@eyQEPcwA0uUS-~ofLq8 z4oC@1AQT#(b)IDuRRn?A1i%599BU22mVNIAUp(WC#~ypub>qx*I6J5iSL@b&(ORgU zYB&3_-gFH2FFck1Qtrh3?@5u<^4%dU;?JixCPqjE00Yt$s6aZ99OBpsBW$0dUJxmXYVFiP zVu<5bD7QhxhpNO#)kbegJW zS|(uQflxr2S%V-jE(AMG!fG5_HM}3Q!kA1soA>&AxLh>}>yq(uphc9x0BN9r{S4_M z8_l}FLR;DO{*srLoHA>UHd;x=zz3=+A_4$J@B?jI)iJy8gw zi4DsL#+p@-BR@+hk%=jQ;trFXZc&jlTeX!Gz>ETcnYBo_n>k~TS@P<;%mRS-*P_VG zfWVrcU-|Ow-@CF6x<}8f@|+SXD0WhQuLc0+V!4+|BkwSeJ^1we`4@ZwgAh32QbI^( zoP$1yfUq5vk4 z5s)!(8^urV{ZX!%ACP{(3ke~jgQZ^>AK$zEZfko|MNP@>lhxWzN_5cDqE@+vsk+9E z#4RsJrVIce94xgNS6cCEyLWW}2-@SIz(E205|@kY=4GR!^85PAg`#CyVch`;N-6-9 zQX!(&x+>Xl&woCA*%|-#(UL5sM83o50^11@stK5=TD`yN{U;uI7yt~>U~3`v2Q`Oi zj4{n4hTU`9LtI`m|v6e4J?fBd6+zdZBYw$){+ zWVw%o1+ih$sS$3aV8^Hi`0ei=_Pnx^a!}o3e>7m2i=>psn6u{2edd8zj>=9?uQpqj zW-~jrF0eol4tTv(Xd@H=fI*J)J9IEo?Vxmix2Nim%1j=x0SLhLq$;3Q!gAmfn|mJo zQMp`HO1=BuJ7;|5gvno;bi=J*GXXI$GYcVw5X|tvub()1_zB&cy~I!@B48(kQzhIw zp&Ssku(@;7+V?*Q6#kld1LM0aH!W< zSJmHI_{!N={`Btq4Hr?(PnAIkPVnJd%cV{r~Aug38gaYESB4;K{j6frAvl1 z)mSy^s_EZY^Uj)C)2GjyJ}aozRU_=$iL#HUE{Jh-n!5e>cY%j? zCD=){9dK&>N1uK0mLjwp$*d@NO^p)+!zIe53N=AEZ`%;o%0QSKIAR{0npkfG0P#-M1 z@iwyk6D~Sh3sIA(YiZr>XYtXOAKp+}8023+*2Fwq2Sw{C9T*VZ_8BDBJi$KMF^ zNm%L#6k6*Ojy`4KaSQiu_Del%#n6hQU4d>yMud3oq166-726Y|J@&>(-3` z0DPDjIN(SE3+c>?^{bsKpgfBJfw|mgjK|VOus}M91pokLi-OkEkDHqA%005_cg5KS zHQsC)zjWy3oS0&vBb6ham?bS~IZ`>&R-$sKor-n6x#{itk&%Katy;eHpgcIRu#O)) zSz<&+SUM;a0ssM(Txi+7tB@}!Wf74&tpAWvQoZokrwZjvG;Wz3p@S$e$U`_IYY+~4 zDT*jTlI#Q!d3!(F8Lft{Ri?6%sw<=Yy+yBRN-YrN00MBMk{uzGk${E_Nv1sX_j?$H zte+ncpJA|p6b?XyO_`ZMI*1Y=U<+aEzLvK3w(;Y~GxK2qgj4Lw?#)y}1xtvL6+;z4 z=>Tg01}lof!cxlAWRf*Cv`eRUr*>}oukA-&-k58lJ;m;{$TbBGqw7axr5|gIrS@jh zTlSn#SKDc+&HXLOWL-2?!H#U6-1z$1WjbVY-u@n{G^-Lb=`LJkH$`&mDa_4Plx<9op90H99QD-S>r0x|#v>{N?rlVroX z$ht&UOn6b z5P%8TaA+PPN*IXPZfK~(TL1+BjF~h!>Q?%B0t6~Dm$=YwjL&Y3Lw3H8z2!pZd-J(|j_8t5`QVz%uYLNF#mCM#zAKX|=u&HM zXDksJH+rCyI1m7cVZE#a0{~7^2n&S;LWr`aF-_ygHjWQ5e=G(L=4cHWOIaY%M^o$o zMJ%Hj7!Gn=>M^kxOIe7hY^yF=Rqg}hGifFt5Yg+TAWuv{20#J@pmQW#aH@n!Ytdym ztCRUyB97Z|?+Z&FFIYLDJ-g^f9k*%BxV#nXD~kH65m95eZQnZMxFZh^-~DR=Tb2bt ztKNClmf&Z#@j#at0Kf-X83_~p#{lsD%??CdvErp~e)sC7Z@i*VExO_k*MK1rGX2tp zz~fR6=@KJ?lN2bx%d!)bHpqxADyt+_7-8vsg^X=M5qo+Hoq^7CI?biB(Lr}Av#-4~ zlj(oyrRPVFA39{{kg#Ss*aBh0mF`b(Xj!j(D5W$rvjG5r06sTu>i$f1&^mws+8CwO zYp*|d-o*>NYVpvY9{Swy;ms2!MRO{VqCx`fD3Z^1g^&)Y2wE|zV#2Nzkp_0-vJf#j zFg!^n-xF3fW_o?axU+qGv8}sB!iQ}gHN&gA`uhq*2CVM(zHOV{ee75FeOmnkE`)$( zP=@SUpn$0RR;Eu^3=xDI@?q_~@_11Q9W0Kpyx=eu@hn?8cQ-A=}-& zQmBh;${bXoB|v*jnq6|LDiXfJJOP6vg*BwM{`J2syYpK&PM$Dc8>2qX^MoU8onK$Q zqAv~&5v#wi9F!S+5$}UjFFIKW8R$Ssb%=!w4JOfoI7F+gsv)*j!Km1d3k$)-F+N72 z$9|R!fKuqz3%6FVW)|o*Nd|LX!ECK+2CY4Bnm)GPm8}M>LRK~x0(UkxYI?JH|Ai9+fFc_wEi?376 z%+Vn-Hd5J9AuLc;C=@a<7+?*`MOn>IVWb7dV-7$UxYSF2AC+=CmWQ#!#`UN3+cs~> z=TfCy&&nmQwC~;W+G~IA?CJk|N&xvMSf3OUNE(?u@7r-dhEQH1S}-%qSjxl&4H!VN4y+qM)+Dx=rWrk_ob zgCc7JD)PAcX--AMhIiMdcJIX?yKeQHTX(N<8=TeeynDx@ZvlWYW^nO=!98DQ0C@bF z-*lROr$SM{N)__Mh^=7v8JAxg_3?QvwF$$f~&_hHT0#5nbts5fLElT zK%j-zx|BDmZbJnY8q+ zO+IJrSrz$;w%vXGEnX>0FSYI69vQ>AWX81w#|+lP zidR?GT9q?Sm=*4|F%tlqz(^&ZdhW^Jzx7b{1gD%b5J0vka64mvc<`yZ`i5|);{dt) z>9Z0{gi;{kmA72}@Tx~fAL$mh`FRSi3^Yl&PG7!VdGByMA%mrC&E% zivwHe2!n1nctjw44}u^F0%pE`(KXf#7;%+THAks2aL&A0Z98`EZdp5X=J1N+VAM4( zjDYjMIFFeNL7vDkb0L#XcXyH2*=%-j!tlZ{|L&pt8>YvS^Kj^eR`Uh2d7+g!9_=A; z_UDg(@x?zCiUrNZ1(%!|n*$@SaO&rZnlmiX45!VXyy3k!w{71P82=N;5e~8Y7lI?r z#u&>{*W9u2$rVplH%0pPmHZB12OJ3zgBcrThNg@f|HuPR9dX1oZFESQ4-iTRrI!OW zB9o=8weKulaQ*!9$dU>KBRf)%#J)WNwesgiOc~zP_{;}y)J#xJ9F(}&LWzt}H8Ly6 zE13HhegB3VzGsXHp8|)V77xb2#0*l<4YyzQ^yWuv8Y=pF^Qe&}7CQA&?h!xw!B6+> zY3s{ot12okI`7N2XPTzNZ|~+(4ksNhOllEAP5LR-F@@@ zE5Ee5Dw(C2F829kFyew!ssHfUuOD0bVj(V|i>v?_UV0@N5<-ZNFRKT(GXQMc3WDIY zc?)h{|GyqudapbV(8wt0Qp)&5u?9s+ENuyduW~*5%7qtQ_qA*0EtoGGz(U#67fd?- zSSg&)0*7A6!Ur+~BKTBB#31nFmB~xzTtZtplC;qQ4#>E;V#~HCR=rqzk~ML5EH(l* zwtN7G8y~B4KuX~U-fiFg;kEO=&FdKZ*%>OTkFiEftVq;I9q8JIWUfu$b>pJnKKO^t z>o#>|vP_uU&I`|;_w8@q2@Hk|0ED#mp_}^9+_rRyNLh9%pINc$&G&jb?6m@Y@bgrY zsfc^fIXqj_><+D{*==%1Oq~1)Cp`F_n1I8500a<9Spaax>8Jnh@n5v}bv0JGxtJa` zymm@`Y0|1c` zLhjhM`GU*lZY}Le*jA!Hmb3G{DgEuszH#ZlF1&8hwR>Va(Sz9|&i%zbzqf7YzzGm0 z1PnKnLdF{rnM}S^=3*Te)&=``cc%7i)0cKC5MWuFy^+>Z)aRkc#IbRVv@A zsTX83#w%6Fw&2@eyk*$%VVk#X5JV#J*O5T5v!areIF4NVBDDctLNQt$rrE8XVaHlbMDUQj!3nw;$RAF zd@80nvz45Bz@Z>rQFx!8|LLRWo_DD+`m>lhA;gnUEH=aYk2!MGs%5)lRqn>U+kK}z z`pCrYZMnq{{^`aGzIW0or!rGm6b<&%QpzWv{PnfBd`%0qE%GB!G@u-4N-7-(&uGp= zX$KVhgNDl5^G}~MFN`wje4hT z?f7xE(fZhiwmr-a0PsIRY+=u~{I*gGb^3O_)V=GY?bGX< zj4|O}UFauaemHsNS(kq0vJEZUoigug-`P>I@<|TYle*;J+Zp6;fiyw8a{Sx zePh!=hSdXP+s>`;N`~yNz%T1)qsr}qpWSxL)mPtk$IotEziCybqv!lHFP%Gg0fa^M zXB^yP=4`hAmTz5s)M=xCc-QsJdgam;V~?*p;p&E}=`d&EOeRBzKc+XZ{A$zP*1CHA z%Gcli^V0WUUApGgp5A>2ulj!A2RhJ3GxNT-y_elMziNhbr@)+xj=k#2e|1KKJ08CO z>Pp2zN9(?@N(g5-EPzjnLKK$1uf6)>O^d#K-@P|?X4;uKJdXHjie| zMjsG&|5c!aAPBV9;d#Yyl1w^1`;ucX{QA^s|5hW9fM4Ht_l9+UYa9#ldC+*2_4w}| z2-iVo);bu(|931v#%Qe#867^!m_dCHUVnxK1}G+Dv<`y(FJnyj+u$Fy*3A6otFO%Z z{Dd3tKV{mr)i4H@zV(-EZ+6t__9@?~Z@e69CPg=G_#nh^@N++dnF}`>gb)G;7yuNA zL}ZAJF@S&P*y_Lxh(ZV{l@d}(rKA!%YT>Nevrjqu zukWk`89AqEW}TIA9keYG-aI%nz-O)lhgntmAo+Md3;cgOLPhlDdb)dhP>Z3>P4Rd# z2!dO0yM9B@-~6EX)w3_X{L0=jsw)rpj5u^r+T~Xh*MKtLxzO3 zK1D+Q69D)G1_%!j;J|^z@U$E=2yqCH{bvDiI7lG|I4Gh%f#JUaR4j%)hHl>500000 LNkvXXu0mjfy>y+q literal 0 HcmV?d00001 diff --git a/docs/rsc/custom.css b/docs/rsc/custom.css new file mode 100644 index 000000000..32a1f4dc3 --- /dev/null +++ b/docs/rsc/custom.css @@ -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; +} diff --git a/docs/rsc/footer.html b/docs/rsc/footer.html new file mode 100644 index 000000000..08db8f4ed --- /dev/null +++ b/docs/rsc/footer.html @@ -0,0 +1,4 @@ +
+Generated on $datetime for $projectname by doxygen $doxygenversion
+ + diff --git a/docs/rsc/header.html b/docs/rsc/header.html new file mode 100644 index 000000000..540648e31 --- /dev/null +++ b/docs/rsc/header.html @@ -0,0 +1,17 @@ + + +$title + + + + + + + + + + + +
ChibiOS/RT LogoChibiOS/RT

Architecture - Reference Manual - Guides
+
\ No newline at end of file diff --git a/docs/img/logo.png b/docs/rsc/logo.png similarity index 100% rename from docs/img/logo.png rename to docs/rsc/logo.png diff --git a/docs/img/readylist.png b/docs/rsc/readylist.png similarity index 100% rename from docs/img/readylist.png rename to docs/rsc/readylist.png diff --git a/docs/img/readylist.svg b/docs/rsc/readylist.svg similarity index 100% rename from docs/img/readylist.svg rename to docs/rsc/readylist.svg diff --git a/docs/rsc/tabs.css b/docs/rsc/tabs.css new file mode 100644 index 000000000..16b1be0d7 --- /dev/null +++ b/docs/rsc/tabs.css @@ -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; +} diff --git a/docs/img/workspace.png b/docs/rsc/workspace.png similarity index 100% rename from docs/img/workspace.png rename to docs/rsc/workspace.png diff --git a/docs/img/workspace.svg b/docs/rsc/workspace.svg similarity index 100% rename from docs/img/workspace.svg rename to docs/rsc/workspace.svg diff --git a/todo.txt b/todo.txt index 42de67a75..25933aebd 100644 --- a/todo.txt +++ b/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: