doc/README.bertos

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