Doc fixes.

[bertos.git] / drv / tc520.c

diff --git a/drv/tc520.c b/drv/tc520.c
index 16df61589ba873cd3ff2ff348548c0a73afbd613..615a94e08f3c88c818b26b75a394f9cc857493ad 100644 (file)
--- a/drv/tc520.c
+++ b/drv/tc520.c
@@ -1,6 +1,31 @@
 /**
  * \file
  * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * Copyright 2005 Develer S.r.l. (http://www.develer.com/)
  * -->
  *
@@ -19,7 +44,6 @@
 #include <hw_tc520.h>
 
 #include <cfg/macros.h>
-#include <cfg/cpu.h>
 #include <cfg/compiler.h>
 
 #include <drv/ser.h>
@@ -31,10 +55,14 @@ static Serial *spi_ser;
 
 /**
  * Start an AD conversion and return result.
+ *
  * To start a conversion first we must pull down CE pin.
  * The ADC starts a convertion and keeps the DV pin high until the end.
  * At this point, we can read the conversion value by SPI.
  * The convertion result is yield in 3 bytes.
+ *
+ * \verbatim
+ *
  * First byte:
  * bit | Value
  * ----|-------
@@ -51,8 +79,10 @@ static Serial *spi_ser;
  *  6  | data bit 0
  * 5:0 | '0'
  *
+ * \endverbatim
+ *
  * So, to get the result we must shift and recompose the bits.
- * \Note Ovverrange bit is handled as the 17th data bit.
+ * \note Overrange bit is handled as the 17th data bit.
  */
 tc520_data_t tc520_read(void)
 {