PIC24 Support Libraries
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
esos_dox.h
1 /*
2  * "Copyright (c) 2008 Robert B. Reese, Bryan A. Jones, J. W. Bruce ("AUTHORS")"
3  * All rights reserved.
4  * (R. Reese, reese_AT_ece.msstate.edu, Mississippi State University)
5  * (B. A. Jones, bjones_AT_ece.msstate.edu, Mississippi State University)
6  * (J. W. Bruce, jwbruce_AT_ece.msstate.edu, Mississippi State University)
7  *
8  * Permission to use, copy, modify, and distribute this software and its
9  * documentation for any purpose, without fee, and without written agreement is
10  * hereby granted, provided that the above copyright notice, the following
11  * two paragraphs and the authors appear in all copies of this software.
12  *
13  * IN NO EVENT SHALL THE "AUTHORS" BE LIABLE TO ANY PARTY FOR
14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
15  * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE "AUTHORS"
16  * HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
17  *
18  * THE "AUTHORS" SPECIFICALLY DISCLAIMS ANY WARRANTIES,
19  * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
20  * AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
21  * ON AN "AS IS" BASIS, AND THE "AUTHORS" HAS NO OBLIGATION TO
22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS."
23  *
24  * Please maintain this header in its entirety when copying/modifying
25  * these files.
26  *
27  *
28  */
29 
30 // Documentation placed on the ESOS page. This file only
31 // include comments for Doxygen; it does not contain any
32 // code.
33 /**
34  * \page ESOS ESOS, the Embedded Systems Operating System
35  * A portable, cooperative multitasking OS with tasks based on a very lightweight threading
36  * system.
37  *
38  * \section ESOSCoreFiles Core files
39  * Files which compose ESOS consist of:
40  * - esos.c - contains the main ESOS scheduling loop
41  * - esos.h - top-level ESOS header file
42  * - esos_task.h - header file for defining ESOS tasks
43  * - esos_comm.h - header file for defining ESOS communications services
44  * - esos_comm.c - contains ESOS communications services library
45  * - esos_irq.h - header file for defining ESOS interrupt services
46  * - esos_irq.c - contains ESOS communications services library
47  * - esos_pic24_tick.c - implements ESOS system tick for Microchip PIC24 Family implementation of ESOS
48  * - esos_pic24_irq.h - implements ESOS interrupt services for Microchip PIC24 Family implementation of ESOS (header file)
49  * - esos_pic24_irq.c - implements ESOS interrupt services for Microchip PIC24 Family implementation of ESOS (library code)
50  * - esos_pic24_rs232.h - implements ESOS asychronous serial communications services for Microchip PIC24 Family implementation of ESOS (header file)
51  * - esos_pic24_rs232.c - implements ESOS asychronous serial communications services for Microchip PIC24 Family implementation of ESOS (library code)
52  * - esos_pic24_i2c.h - implements ESOS two-signal synchronous serial communications services for Microchip PIC24 Family implementation of ESOS (header file)
53  * - esos_pic24_i2c.c - implements ESOS two-signal synchronous serial communications services for Microchip PIC24 Family implementation of ESOS (library code)
54  * - esos_pic24_spi.h - implements ESOS three-signal synchronous serial communications services for Microchip PIC24 Family implementation of ESOS (header file)
55  * - esos_pic24_spi.c - implements ESOS three-signal synchronous serial communications services for Microchip PIC24 Family implementation of ESOS (library code)
56  * \section ESOSExampleFiles Example files
57  * Example files which demonstrate ESOS operation include:
58  * - esos_skel.c - A skeleton application which blinks the
59  * heartbeat LED using ESOS, providing a starting point for
60  * creating new ESOS applications.
61  */