-/*
- * This document is automatically processed by Doxygen (http://www.doxygen.org/).
- * Don't remove special formatting tags.
- */
-/*!
+/*!
+<!--
+
+This document is automatically processed by Doxygen (http://www.doxygen.org/).
+Don't remove special formatting tags.
+This section won't be processed unless enabled.
+
+Doxygen supports a LaTeX-like syntax to write documentation; use that syntax to make changes to this file.
+You can find a reference here: http://www.stack.nl/~dimitri/doxygen/manual.html, inside the section 'Special commands'.
+
+For tables, use ONLY the html formatting tags that you can find in the previous page in the section 'HTML commands'. This way
+we'll always be able to generate valid documentation for every language supported by Doxygen.
+
+Remember to use Doxygen tags sparingly inside source code.
+-->
+
+
+
+
+
+
+
\page dev_status BeRTOS Development Status
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.
<tr> <td> TWI</td> <td>beta</td> </tr>
<tr> <td> ADC</td> <td>beta</td> </tr>
<tr> <td> PWM</td> <td>beta</td> </tr>
+ <tr> <td> \link i2s_at91.h I2S \endlink digital audio bus </td> <td>stable</td> </tr>
</table>
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>.
Current driver list:
<table>
<tr> <td> <b> Driver </b> </td> <td> <b> Status </b> </td> </tr>
-<tr> <td> \link adc.h ADC API \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link buzzer.h Buzzer \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link dataflash.h Atmel Dataflash \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link eeprom.h I2C EEPROM \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link flash25.h AT25Fxxx Atmel flash memories \endlink</td> <td>beta</td> </tr>
+<tr> <td> \link adc.h ADC API \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link buzzer.h Buzzer \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link dataflash.h Atmel Dataflash \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link eeprom.h I2C EEPROM \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link flash25.h AT25Fxxx Atmel flash memories \endlink</td> <td>beta</td> </tr>
<tr> <td> \link ft245rl.h FT245RL USB to parallel converter \endlink</td> <td>beta</td> </tr>
-<tr> <td> \link kbd.h Keyboard \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link i2c.h I2C \endlink with bitbang support</td> <td>stable</td> </tr>
-<tr> <td> Displaytech 32122A Graphic LCD</td> <td>stable</td> </tr>
-<tr> <td> \link dc_motor.h DC Motor with PID \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link lcd_text.h Alphanumeric LCD \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link mcp41.h MPC41 digital potentiometer \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link ntc.h NTC \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link phase.h TRIAC phase partialization \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link pwm.h PWM API \endlink</td> <td>beta</td> </tr>
-<tr> <td> \link pcf8574.h PCF85974 I2C port expander \endlink</td> <td>beta</td> </tr>
-<tr> <td> \link ser.h Serial API \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link spi_bitbang.h Bitbanged SPI \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link tc520.h TC520 ADC \endlink</td> <td>obsolete</td> </tr>
-<tr> <td> \link thermo.h Thermostat \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link timer.h System timer API \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link stepper.h Stepper motor with ramps \endlink</td> <td>stable</td> </tr>
-<tr> <td> Watchdog</td> <td>beta</td> </tr>
+<tr> <td> \link kbd.h Keyboard \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link i2c.h I2C \endlink with bitbang support</td> <td>stable</td> </tr>
+<tr> <td> Displaytech 32122A Graphic LCD</td> <td>stable</td> </tr>
+<tr> <td> \link dc_motor.h DC Motor with PID \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link lcd_text.h Alphanumeric LCD \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link mcp41.h MPC41 digital potentiometer \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link ntc.h NTC \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link phase.h TRIAC phase partialization \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link pwm.h PWM API \endlink</td> <td>beta</td> </tr>
+<tr> <td> \link pcf8574.h PCF85974 I2C port expander \endlink</td> <td>beta</td> </tr>
+<tr> <td> \link sd.h Secure Digital card API \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link ser.h Serial API \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link spi_bitbang.h Bitbanged SPI \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link tas5706a.h TAS5706A \endlink digital audio DSP</td> <td>stable</td> </tr>
+<tr> <td> \link tc520.h TC520 ADC \endlink</td> <td>obsolete</td> </tr>
+<tr> <td> \link thermo.h Thermostat \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link timer.h System timer API \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link stepper.h Stepper motor with ramps \endlink</td> <td>stable</td> </tr>
+<tr> <td> Watchdog</td> <td>beta</td> </tr>
</table>
To get up to date informations look at the <A href="http://dev.bertos.org/browser/trunk/bertos/drv">drivers source code</A>.
BeRTOS comes in help with a set of optimized portable algorithms:
<table>
<tr> <td> <b> Algorithm </b> </td> <td> <b> Status </b> </td> </tr>
-<tr> <td> \link crc.c CRC16 \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link crc.h CRC16 \endlink</td> <td>stable</td> </tr>
<tr> <td> \link md2.c MD2 \endlink</td> <td>beta</td> </tr>
<tr> <td> \link randpool.c Cryptographically secure Random Pool \endlink</td> <td>beta</td> </tr>
<tr> <td> \link rotating_hash.h Rotating hash checksum \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link tea.c TEA (Tiny Encryption Algorithm) \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link ramp.c Stepper motor ramp generator \endlink</td> <td>beta</td> </tr>
-<tr> <td> \link pid_control.c PID Controller \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link tea.h TEA (Tiny Encryption Algorithm) \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link ramp.h Stepper motor ramp generator \endlink</td> <td>beta</td> </tr>
+<tr> <td> \link pid_control.h PID Controller \endlink</td> <td>stable</td> </tr>
<tr> <td> \link rle.c RLE (Run lenght en/decondig) \endlink</td> <td>stable</td> </tr>
</table>
<tr> <td> \link bitmap.c Bitmaps manipulation \endlink</td> <td>stable</td> </tr>
<tr> <td> \link line.c Lines drawing \endlink</td> <td>stable</td> </tr>
<tr> <td> \link line.c Rectangles drawing \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link win.c Simple windowing system \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link win.h Simple windowing system \endlink</td> <td>stable</td> </tr>
<tr> <td> Proportional and fixed size fonts</td> <td>stable</td> </tr>
-<tr> <td> \link text.c Text rendering \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link charts.c Simple Charts \endlink</td> <td>stable</td> </tr>
-<tr> <td> \link menu.c Menus \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link text.h Text rendering \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link charts.h Simple Charts \endlink</td> <td>stable</td> </tr>
+<tr> <td> \link menu.h Menus \endlink</td> <td>stable</td> </tr>
</table>
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.
\section fs File system
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.
-\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.
+\link battfs.h 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.
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).
File system development takes place in the <A href="http://dev.bertos.org/browser/trunk/bertos/fs">fs directory</A>.