| adamdunkels | 1fb843b | 2003-09-04 20:00:58 +0000 | [diff] [blame] | 1 | /** |
| 2 | |
| adamdunkels | e937ded | 2003-10-01 07:53:57 +0000 | [diff] [blame] | 3 | \mainpage The Contiki Operating System |
| adamdunkels | 1fb843b | 2003-09-04 20:00:58 +0000 | [diff] [blame] | 4 | |
| adamdunkels | e937ded | 2003-10-01 07:53:57 +0000 | [diff] [blame] | 5 | \author Adam Dunkels <adam@dunkels.com> |
| adamdunkels | 1fb843b | 2003-09-04 20:00:58 +0000 | [diff] [blame] | 6 | |
| adamdunkels | d3e1522 | 2004-02-24 09:55:32 +0000 | [diff] [blame] | 7 | The Contiki operating system is a highly portable, minimalistic |
| 8 | operating system for a variety of constrained systems ranging from |
| 9 | modern 8-bit microcontrollers for embedded systems to old 8-bit |
| adamdunkels | 97cb424 | 2004-03-18 21:08:13 +0000 | [diff] [blame] | 10 | homecomputers. Contiki provides a simple event driven kernel with |
| 11 | optional preemptive multithreading, interprocess communication using |
| 12 | message passing signals, a dynamic process structure and support for |
| 13 | loading and unloading programs, native TCP/IP support using the uIP |
| 14 | TCP/IP stack, and a graphical subsystem with either direct graphic |
| 15 | support for directly connected terminals or networked virtual display |
| 16 | with VNC or Telnet. |
| adamdunkels | 1fb843b | 2003-09-04 20:00:58 +0000 | [diff] [blame] | 17 | |
| adamdunkels | e937ded | 2003-10-01 07:53:57 +0000 | [diff] [blame] | 18 | Contiki is written in the C programming language and is freely |
| 19 | available as open source under a BSD-style license. More information |
| 20 | about Contiki can be found at the Contiki home page: |
| adamdunkels | a59c9b5 | 2004-06-06 06:05:04 +0000 | [diff] [blame] | 21 | http://www.sics.se/~adam/contiki/ |
| adamdunkels | 1fb843b | 2003-09-04 20:00:58 +0000 | [diff] [blame] | 22 | |
| adamdunkels | 18eebb9 | 2005-02-07 07:49:49 +0000 | [diff] [blame] | 23 | \section contiki-mainpage-tcpip TCP/IP support |
| 24 | |
| 25 | Contiki includes the uIP TCP/IP stack (http://www.sics.se/~adam/uip/) |
| 26 | that provides Contiki with TCP/IP networking support. uIP provides the |
| 27 | protocols TCP, UDP, IP, and ARP. |
| 28 | |
| 29 | \sa \ref uip "The uIP TCP/IP stack documentation" |
| 30 | \sa \ref tcpip "The Contiki/uIP interface" |
| 31 | \sa \ref socket "Socket-like library" |
| 32 | |
| 33 | \section contiki-mainpage-threads Multi-threading and protothreads |
| 34 | |
| 35 | Contiki is based on an event-driven kernel but provides support for |
| 36 | both multi-threading and a lightweight stackless thread-like construct |
| 37 | called protothreads. |
| 38 | |
| 39 | \sa \ref ek "The Contiki event-driven kernel" |
| 40 | \sa \ref mt "Contiki multi-threading" |
| 41 | \sa \ref pt "Protothreads" |
| 42 | |
| 43 | \section contiki-mainpage-lib Libraries |
| 44 | |
| 45 | Contiki provides a set of convenience libraries for memory management |
| 46 | and linked list operations. |
| 47 | |
| 48 | \sa \ref timer "Timer library" |
| 49 | \sa \ref memb "Memory block management" |
| 50 | \sa \ref list "Linked list library" |
| 51 | |
| adamdunkels | 1fb843b | 2003-09-04 20:00:58 +0000 | [diff] [blame] | 52 | */ |