README.bertos

   1 /*!
   2
   3 \if DEVELOPER_NOTE_ON
   4
   5 This document is automatically processed by Doxygen (http://www.doxygen.org/).
   6 Don't remove special formatting tags.
   7 This section won't be processed unless enabled.
   8
   9 See STATUS for further information and tips about Doxygen tags.
  10 \endif
  11
  12
  13
  14 \mainpage
  15
  16 \section overview Overview
  17
  18 BeRTOS is a real-time operating system designed for building applications
  19 for embedded systems, like reference boards, test boards, or custom boards.
  20
  21 It has a modular structure: its components can be used in very different
  22 environments, from 8-bit processor to Linux and Win32 hosted application
  23 (for debug purpose), using a wide range of compilers.
  24
  25 \section history History and Motivation
  26
  27 BeRTOS was born as a collection of useful, highly optimized and fine-tuned
  28 libraries for embedded systems.  Each library had its own scope and could be
  29 used singularly in a project, though they were also meant to cooperate to
  30 build the whole underlying software layer commonly called "operating system".
  31
  32 We have grown it following our guidelines: simplicity and beauty.
  33 These guidelines made it possible to evolve it in a full-featured real
  34 time operating system, with more modularity than many other embedded OSes,
  35 without giving up reliability and performace.
  36
  37 To achieve the highest possible reusability, most BeRTOS components are
  38 designed for fine-grained modularity and minimal external dependencies.
  39 Most non-essential features can be configured out for application with small
  40 memory footprint requirements.
  41
  42 \section features Features
  43
  44   - multitasking kernel with IPC, semaphores, priority levels;
  45   - a comprehensive set of generic drivers for a wide range of devices,
  46     which can be easily customized to the actual hardware: timer, serial,
  47     adc, ntc, pwm, stepper motors, dc motors, lcd, keyboards, buzzer, eeprom;
  48   - full graphic subsystem for simple displays, with font support, bitmaps,
  49     clipping, text formatting, interactive menus;
  50   - simple console with command parser;
  51   - readline-like support for command history;
  52   - entropy generator and random numbers generator optimized for embedded
  53     systems;
  54   - checksumming and hashing functions (CRC, MD2);
  55   - full hash-table implementation with double-hashing collision resolution;
  56   - XMODEM protocol implementation;
  57   - RLE compression algorithm;
  58
  59 \section structure Directory Structure
  60
  61 The modules are sorted in subdirectories by their category:
  62
  63   - app/            : demo applications;
  64   - bertos/algo/    : algorithms;
  65   - bertos/cfg/     : configuration stuff;
  66   - bertos/drv/     : hardware drivers;
  67   - bertos/dt/      : experimental object oriented gui toolkit;
  68   - bertos/emul/    : Qt-based emulator framework for embedded applications;
  69   - bertos/fonts/   : fonts;
  70   - bertos/fs/      : file system related stuff;
  71   - bertos/gfx/     : general purpose graphics routines;
  72   - bertos/gui/     : widgets for simple displays;
  73   - bertos/hw/      : hardware-specific declarations;
  74   - bertos/icons/   : conversion tool from image TXT format to LCD bitmap;
  75   - bertos/kern/    : multitasking kernel;
  76   - bertos/mware/   : algorithms, other standalone code;
  77   - bertos/struct/  : containers and other data structures;
  78   - bertos/os/      : OS-abstraction layers for hosted environments;
  79   - doc/            : documentation;
  80
  81 The top-level directory contains a few support headers that are meant to be
  82 usable by any C/C++ embedded or hosted application.
  83
  84 See the \ref dev_status page for information about the various drivers.
  85
  86 \section license License
  87
  88 BeRTOS is provided under the term of the GNU General Public License
  89 (see LICENSE.GPL) with following exception:
  90
  91 \verbatim
  92
  93 As a special exception, you may use this file as part of a free software
  94 library without restriction.  Specifically, if other files instantiate
  95 templates or use macros or inline functions from this file, or you compile
  96 this file and link it with other files to produce an executable, this
  97 file does not by itself cause the resulting executable to be covered by
  98 the GNU General Public License.  This exception does not however
  99 invalidate any other reasons why the executable file might be covered by
 100 the GNU General Public License.
 101
 102 \endverbatim
 103
 104 */