STATUS

   1 /*
   2  * This document is automatically processed by Doxygen (http://www.doxygen.org/).
   3  * Don't remove special formatting tags.
   4  */
   5 /*!
   6 \page dev_status BeRTOS Development Status
   7
   8 If you are looking for the list of BeRTOS ports or a detailed overview of all modules completeness and stability this is the right place.
   9
  10 BeRTOS is quite stable (it is used in production environments) but it is also a very large project, so all of its parts may not be at the same level.
  11
  12 Table of contents:
  13
  14  \li \ref kernel
  15  \li \ref compilers
  16  \li \ref core_drivers
  17  \li \ref internal_peripherals
  18  \li \ref independant_drivers
  19  \li \ref emulator
  20  \li \ref algorithms
  21  \li \ref graphics
  22  \li \ref networking
  23  \li \ref fs
  24  \li \ref data_structures
  25  \li \ref mware
  26
  27 \section kernel Kernel
  28 BeRTOS features a cooperative kernel with synchronization primitives.
  29
  30 Embedded systems are mostly I/O bound systems. In these systems the microprocessor/microcontroller spends the most part of its computing power doing... absolutely nothing :-)
  31
  32 Since the system simply waits for external events to happen we decided to implement a strong and robust cooperative kernel with very low memory footprint and high modularity. This allows the kernel to be used on a variety of different CPUs, even the smaller ones.
  33 Currently the kernel code is very stable.
  34
  35 <b> Kernel features </b>:
  36   \li \link coop.c Cooperative \endlink round-robin scheduling.
  37   \li \link monitor.h Stack process monitor \endlink, useful to prevent stack overflows.
  38   \li \link msg.h Inter-process messaging system \endlink (with very low overhead).
  39   \li \link sem.h Binary semaphores \endlink.
  40   \li \link signal.c Signals \endlink.
  41
  42 We have plans to add, as soon as possible, a <b> preemptive scheduler </b>, browse <A href="http://dev.bertos.org/browser/trunk/bertos/kern">kernel source code</A> to see the latest additions.
  43
  44 The kernel has a port layer (a single assembly function) that needs to be reimplemented each time a new CPU is added.
  45 Here is a list of currently available CPU family ports:
  46
  47 <table>
  48 <tr> <td> <b> CPU Family </b> </td> <td> <b> Port status </b> </td></tr>
  49 <tr> <td>  ARM </td> <td> stable </td></tr>
  50 <tr> <td>  <A href="http://www.atmel.com/avr">Atmel AVR</A> </td>  <td> stable </td> </tr>
  51 <tr> <td>  <A href="http://www.freescale.com/webapp/sps/site/taxonomy.jsp?nodeId=01624686366292">Freescale DSP56800</A> </td>  <td> unmantained </td> </tr>
  52 <tr> <td>  Intel i196 </td>  <td> unmantained </td> </tr>
  53 <tr> <td>  PowerPC          </td>  <td> \ref emulator only </td> </tr>
  54 <tr> <td>  Intel/AMD x86    </td>  <td> \ref emulator only </td> </tr>
  55 <tr> <td>  Intel/AMD x86-64 </td>  <td> \ref emulator only </td> </tr>
  56 </table>
  57
  58 \section compilers Compilers
  59 BeRTOS was born as a collection of reusable code snippets.
  60 In this perspective it was of primary importance that the code was reusable and well portable.
  61
  62 So, although BeRTOS is primarily intended to be used with open source tools such as <A href="http://gcc.gnu.org">GCC</A>, it supports other compilers too. It is possible to develop with BeRTOS on Linux, Windows and Mac.
  63
  64 For every port we have indicated the current compiler used and were to find a suitable development suite:
  65 <table>
  66 <tr> <td> <b> CPU Family </b> </td> <td> <b> Compiler </b> </td> <td> <b> Linux/Mac Toolchain </b> </td> <td> <b> Windows Toolchain </b> </td> </tr>
  67 <tr> <td> ARM</td>  <td>GCC</td>  <td><A href="http://www.codesourcery.com/sgpp/lite/arm/portal/release642">Sourcery G++ toolchain</A> (open source)</td>  <td> <A href="http://dev.bertos.org/wiki/DownloadPage">BeRTOS ARM IDE (open source)</A> </td> </tr>
  68 <tr> <td> ARM</td>  <td>IAR (unmantained)</td>  <td>none</td>  <td>http://www.iar.com (proprietary)</td> </tr>
  69 <tr> <td> AVR</td>  <td>GCC</td>  <td><A href="http://www.develer.com/oss/AvrToolchain">AVR Toolchain installer</A> (open source)</td> <td> <A href="http://dev.bertos.org/wiki/DownloadPage">BeRTOS AVR IDE (open source)</A> </td> </tr>
  70 <tr> <td> DSP56800</td>  <td>CodeWarrior (unmantained)</td>  <td>none</td>  <td><A href="http://www.freescale.com/webapp/sps/site/homepage.jsp?nodeId=012726">CodeWarrior</A> (proprietary)</td> </tr>
  71 <tr> <td> i196</td>  <td>fillme</td>  <td>fillme</td>  <td>fillme</td> </tr>
  72 <tr> <td> PowerPC </td>  <td> GCC  </td>  <td> use your system GCC </td>  <td> none </td> </tr>
  73 <tr> <td> x86</td>  <td>GCC</td>  <td>use your system GCC</td>  <td>http://www.mingw.org/ (open source)</td> </tr>
  74 <tr> <td> x86</td>  <td>MSVC (unmantained)</td>  <td>none</td>  <td><A href="http://www.microsoft.com/express/">Visual Studio</A> (proprietary)</td> </tr>
  75 <tr> <td> x86-64  </td>  <td> GCC  </td>  <td> use your system GCC </td>  <td> none </td> </tr>
  76 </table>
  77
  78
  79 \section core_drivers Core Drivers
  80 BeRTOS is not only a kernel, it aims to supply full operating system services.
  81 To achieve this we need at least some core drivers for every CPU port.
  82
  83 These drivers are: <b> system timer </b>, <b> debug system </b> and <b> serial comm driver </b>.
  84
  85 Here is the list of CPU whose internal core drivers are supported:
  86 <table>
  87 <tr> <td> <b> Family </b> </td> <td> <b> CPU </b> </td> <td> <b> Core driver status </b> </td> </tr>
  88 <tr> <td> ARM</td>  <td>AT91SAM7S256</td>  <td>stable</td> </tr>
  89 <tr> <td> ARM</td>  <td>AT91SAM7X128</td>  <td>stable</td> </tr>
  90 <tr> <td> ARM</td>  <td>AT91SAM7X256</td>  <td>stable</td> </tr>
  91 <tr> <td> AVR</td>  <td>ATMega8</td>  <td>stable</td> </tr>
  92 <tr> <td> AVR</td>  <td>ATMega32</td>  <td>stable</td> </tr>
  93 <tr> <td> AVR</td>  <td>ATMega64</td>  <td>stable</td> </tr>
  94 <tr> <td> AVR</td>  <td>ATMega103</td>  <td>stable</td> </tr>
  95 <tr> <td> AVR</td>  <td>ATMega128</td>  <td>stable</td> </tr>
  96 <tr> <td> AVR</td>  <td>ATMega168</td>  <td>stable</td> </tr>
  97 <tr> <td> AVR</td>  <td>ATMega1281</td>  <td>stable</td> </tr>
  98 <tr> <td> DSP56800</td>  <td>all</td>  <td>unmantained</td> </tr>
  99 <tr> <td> i196</td>  <td>all</td>  <td>unmantained</td> </tr>
 100 <tr> <td> PowerPC </td>  <td> all </td>  <td> see \ref emulator </td> </tr>
 101 <tr> <td> x86     </td>  <td> all </td>  <td> see \ref emulator </td> </tr>
 102 <tr> <td> x86-64  </td>  <td> all </td>  <td> see \ref emulator </td> </tr>
 103 </table>
 104
 105 Adding CPU support for an already present CPU family is quite simple since hardware manufacturers share peripherals design between the same CPU cores.
 106
 107 \section internal_peripherals MCU Internal peripheral drivers
 108 Since BeRTOS aims to supply full operating system services, for every CPU port we try to implement as much drivers as possible. This section covers the current development status for MCU Internal peripheral drivers.
 109
 110  \li <b> MCU family: Atmel AVR </b>
 111
 112 <table>
 113    <tr> <td> <b> Driver </b> </td> <td> <b> Status </b> </td> </tr>
 114    <tr> <td> \link adc_avr.c ADC \endlink</td>  <td>stable</td> </tr>
 115    <tr> <td> \link flash_avr.c Internal Flash \endlink</td>  <td>stable</td> </tr>
 116    <tr> <td> UART</td>  <td>stable</td> </tr>
 117    <tr> <td> SPI</td>  <td>stable</td> </tr>
 118    <tr> <td> Timer</td>  <td>stable</td> </tr>
 119    <tr> <td> \link i2c_avr.c TWI \endlink</td>  <td>stable</td> </tr>
 120 </table>
 121
 122    To get up to date informations look at the <A href="http://dev.bertos.org/browser/trunk/bertos/cpu/avr/drv">AVR drivers source code</A>.
 123
 124  \li <b> MCU family: Atmel AT91 ARM </b>
 125
 126 <table>
 127    <tr> <td> <b> Driver </b> </td> <td> <b> Status </b> </td> </tr>
 128    <tr> <td> UART</td>  <td>stable</td> </tr>
 129    <tr> <td> SPI</td>  <td>stable</td> </tr>
 130    <tr> <td> Timers</td>  <td>stable</td> </tr>
 131    <tr> <td> TWI</td>  <td>beta</td> </tr>
 132    <tr> <td> ADC</td>  <td>beta</td> </tr>
 133    <tr> <td> PWM</td>  <td>beta</td> </tr>
 134 </table>
 135
 136    To get up to date informations look at the <A href="http://dev.bertos.org/browser/trunk/bertos/cpu/arm/drv">ARM drivers source code</A>.
 137
 138  \li <b> MCU family: Freescale DSP56800 </b>
 139
 140    Only core drivers are supported.
 141
 142  \li <b> MCU family: Intel i196 </b>
 143
 144    Only core drivers are supported.
 145
 146  \li <b> MCU family: PowerPC </b>
 147
 148    See \ref emulator.
 149
 150  \li <b> MCU family: x86 </b>
 151
 152    See \ref emulator.
 153
 154  \li <b> MCU family: x86-64 </b>
 155
 156    See \ref emulator.
 157
 158 \section independant_drivers Generic CPU independent drivers
 159 BeRTOS supplies a full set of CPU independent generic hardware drivers. To achieve this all drivers are structured to have an hardware abstraction layer (HAL) that isolate CPU specific code and makes porting to new CPU easy.
 160 Current driver list:
 161 <table>
 162 <tr> <td> <b> Driver </b> </td> <td> <b> Status </b> </td> </tr>
 163 <tr> <td> \link adc.h ADC API \endlink</td>  <td>stable</td> </tr>
 164 <tr> <td> \link buzzer.h Buzzer \endlink</td>  <td>stable</td> </tr>
 165 <tr> <td> \link dataflash.h Atmel Dataflash \endlink</td>  <td>stable</td> </tr>
 166 <tr> <td> \link eeprom.h I2C EEPROM \endlink</td>  <td>stable</td> </tr>
 167 <tr> <td> \link flash25.h AT25Fxxx Atmel flash memories \endlink</td>  <td>beta</td> </tr>
 168 <tr> <td> \link ft245rl.h FT245RL USB to parallel converter \endlink</td>  <td>beta</td> </tr>
 169 <tr> <td> \link kbd.h Keyboard \endlink</td>  <td>stable</td> </tr>
 170 <tr> <td> \link i2c.h I2C \endlink with bitbang support</td>  <td>stable</td> </tr>
 171 <tr> <td> Displaytech 32122A Graphic LCD</td>  <td>stable</td> </tr>
 172 <tr> <td> \link dc_motor.h DC Motor with PID \endlink</td>  <td>stable</td> </tr>
 173 <tr> <td> \link lcd_text.h Alphanumeric LCD \endlink</td>  <td>stable</td> </tr>
 174 <tr> <td> \link mcp41.h MPC41 digital potentiometer \endlink</td>  <td>stable</td> </tr>
 175 <tr> <td> \link ntc.h NTC \endlink</td>  <td>stable</td> </tr>
 176 <tr> <td> \link phase.h TRIAC phase partialization \endlink</td>  <td>stable</td> </tr>
 177 <tr> <td> \link pwm.h PWM API \endlink</td>  <td>beta</td> </tr>
 178 <tr> <td> \link pcf8574.h PCF85974 I2C port expander \endlink</td>  <td>beta</td> </tr>
 179 <tr> <td> \link ser.h Serial API \endlink</td>  <td>stable</td> </tr>
 180 <tr> <td> \link spi_bitbang.h Bitbanged SPI \endlink</td>  <td>stable</td> </tr>
 181 <tr> <td> \link tc520.h TC520 ADC \endlink</td>  <td>obsolete</td> </tr>
 182 <tr> <td> \link thermo.h Thermostat \endlink</td>  <td>stable</td> </tr>
 183 <tr> <td> \link timer.h System timer API \endlink</td>  <td>stable</td> </tr>
 184 <tr> <td> \link stepper.h Stepper motor with ramps \endlink</td>  <td>stable</td> </tr>
 185 <tr> <td> Watchdog</td>  <td>beta</td> </tr>
 186 </table>
 187
 188 To get up to date informations look at the <A href="http://dev.bertos.org/browser/trunk/bertos/drv">drivers source code</A>.
 189
 190 \section emulator Emulator
 191 BeRTOS features can be emulated under a Unix system, check DemoApp.
 192
 193 The emulator uses Qt to display emulated I/O devices in a window.  It supports task
 194 scheduling and a number of other embedded peripherals.
 195
 196 <table>
 197 <tr> <td> <b> Emulator </b>      </td>  <td> <b> Status </b> </td> </tr>
 198 <tr> <td>  timer                 </td>  <td> stable       </td> </tr>
 199 <tr> <td>  scheduler             </td>  <td> stable       </td> </tr>
 200 <tr> <td>  keyboard              </td>  <td> stable       </td> </tr>
 201 <tr> <td>  graphical LCD display </td>  <td> stable       </td> </tr>
 202
 203 <tr> <td>  text LCD display      </td>  <td> unmaintained </td> </tr>
 204 <tr> <td>  buzzer                </td>  <td> unmaintained </td> </tr>
 205 <tr> <td>  serial port           </td>  <td> unmaintained </td> </tr>
 206 <tr> <td>  flash                 </td>  <td> unmaintained </td> </tr>
 207 <tr> <td>  debug console         </td>  <td> stable       </td> </tr>
 208 <tr> <td>  file read/write       </td>  <td> stable       </td> </tr>
 209 </table>
 210
 211 \section algorithms Algorithms
 212 In embedded programming sometimes you have to cope with protocols, security systems and things like that.
 213 BeRTOS comes in help with a set of optimized portable algorithms:
 214 <table>
 215 <tr> <td> <b> Algorithm </b> </td> <td> <b> Status </b> </td> </tr>
 216 <tr> <td> \link crc.c CRC16 \endlink</td>  <td>stable</td> </tr>
 217 <tr> <td> \link md2.c MD2 \endlink</td>  <td>beta</td> </tr>
 218 <tr> <td> \link randpool.c Cryptographically secure Random Pool \endlink</td>  <td>beta</td> </tr>
 219 <tr> <td> \link rotating_hash.h Rotating hash checksum \endlink</td>  <td>stable</td> </tr>
 220 <tr> <td> \link tea.c TEA (Tiny Encryption Algorithm) \endlink</td>  <td>stable</td> </tr>
 221 <tr> <td> \link ramp.c Stepper motor ramp generator \endlink</td>  <td>beta</td> </tr>
 222 <tr> <td> \link pid_control.c PID Controller \endlink</td>  <td>stable</td> </tr>
 223 <tr> <td> \link rle.c RLE (Run lenght en/decondig) \endlink</td>  <td>stable</td> </tr>
 224 </table>
 225
 226 To get up to date informations look at the <A href="http://dev.bertos.org/browser/trunk/bertos/algo">algorithms source code</A>.
 227
 228 \section graphics Graphic subsystem
 229 BeRTOS also features a complete graphic subsystem, suitable for generating compact yet powerful GUI.
 230 This system is composed of several modules ranging from simple graphic primitives to complex menu management functions.
 231
 232 <table>
 233 <tr> <td> <b> Module </b> </td> <td> <b> Status </b> </td> </tr>
 234 <tr> <td> \link bitmap.c Bitmaps manipulation \endlink</td>  <td>stable</td> </tr>
 235 <tr> <td> \link line.c Lines drawing \endlink</td>  <td>stable</td> </tr>
 236 <tr> <td> \link line.c Rectangles drawing \endlink</td>  <td>stable</td> </tr>
 237 <tr> <td> \link win.c Simple windowing system \endlink</td>  <td>stable</td> </tr>
 238 <tr> <td> Proportional and fixed size fonts</td>  <td>stable</td> </tr>
 239 <tr> <td> \link text.c Text rendering \endlink</td>  <td>stable</td> </tr>
 240 <tr> <td> \link charts.c Simple Charts \endlink</td>  <td>stable</td> </tr>
 241 <tr> <td> \link menu.c Menus \endlink</td>  <td>stable</td> </tr>
 242 </table>
 243
 244 To get up to date informations look at <A href="http://dev.bertos.org/browser/trunk/bertos/">the source code</A> in the directories \b gfx, \b gui or \b fonts.
 245
 246 \section networking Network protocols
 247 Since BeRTOS can also be used in very tiny systems, some simple communication protocols has been developed.
 248
 249 This is the current status:
 250 <table>
 251 <tr> <td> <b> Protocol </b> </td> <td> <b> Status </b> </td> </tr>
 252 <tr> <td> \link pocketbus.c PocketBus \endlink</td>  <td>stable</td> </tr>
 253 <tr> <td> \link keytag.c Keytag (for 125KHz transponders) \endlink</td>  <td>stable</td> </tr>
 254 <tr> <td> \link xmodem.c XModem protocol \endlink</td>  <td>stable</td> </tr>
 255 </table>
 256
 257 For more information take a look at <A href="http://dev.bertos.org/browser/trunk/bertos/net/">network directory</A>.
 258
 259
 260 \section fs File system
 261 The latest SVN version of BeRTOS supports \link fat.h FAT \endlink filesystems using the <A href="http://elm-chan.org/fsw/ff/00index_e.html">FatFs</A>  library. The module is highly configurable, for example it can be compiled in read-only mode for some space saving.
 262
 263 \link battfs.c BattFs\endlink, a file system specifically planned for embedded platforms, is in the beta stage. The goal is to have a filesystem suitable for little flash and eeprom memories (like dataflash), reliable, robust and capable of wear-levelling the memory pages to increase its life.
 264 Currently you can create files, append data to them but file deletion is still not supported. Wear-levelling is achieved by rotating a page every time it is written. Plans are to add even transactions (a whole write can be performed atomically).
 265
 266 File system development takes place in the <A href="http://dev.bertos.org/browser/trunk/bertos/fs">fs directory</A>.
 267
 268 \section data_structures Data Structures
 269 BeRTOS supplies common data structures, implemented and optimized for low memory footprint and speed.
 270
 271 <table>
 272 <tr> <td> <b> Module </b></td> <td> <b> Status </b></td></tr>
 273 <tr> <td> \link fifobuf.h FIFO \endlink</td>  <td>stable</td> </tr>
 274 <tr> <td> \link hashtable.h Hash table \endlink</td>  <td>stable</td> </tr>
 275 <tr> <td> \link heap.h Embedded-optimized dynamic memory allocator \endlink</td>  <td>stable</td> </tr>
 276 <tr> <td> \link list.h Lists \endlink</td>  <td>stable</td> </tr>
 277 </table>
 278
 279 \section mware Middleware
 280 This section covers all BeRTOS modules that provide general purpose utility functions. Most of them should be moved to \ref algorithms directory.
 281
 282 In the meanwhile, here is the list:
 283 <table>
 284 <tr> <td> <b> Module </b> </td> <td> <b> Status </b> </td></tr>
 285 <tr> <td> \link cpu/byteorder.h Integers to/from host byte-order conversion \endlink</td>  <td>stable</td> </tr>
 286 <tr> <td> \link event.h Events \endlink</td>  <td>stable</td> </tr>
 287 <tr> <td> \link except.h C++ like exception handling in C \endlink</td>  <td>stable</td> </tr>
 288 <tr> <td> \link formatwr.c Embedded-optimized printf \endlink</td>  <td>stable</td> </tr>
 289 <tr> <td> \link readline.h Command shell with history \endlink</td>  <td>stable</td> </tr>
 290 <tr> <td> \link ini_reader.h Ini file reader \endlink</td>  <td>stable</td> </tr>
 291 </table>
 292
 293 As usual, check <A href="http://dev.bertos.org/browser/trunk/bertos/mware">source code</A> for detailed reference.
 294 */