git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@7553 35acf78f-673a-0410-8e92-d51de3d6d3f4

2014-12-02 09:28:04 +00:00 · 2014-12-02 09:28:04 +00:00 · bad3f755e1
parent ea6e4f54b0
commit bad3f755e1
9 changed files with 3643 additions and 0 deletions
--- a/doc/hal/Doxyfile_chm
+++ b/doc/hal/Doxyfile_chm
--- a/doc/hal/Doxyfile_html
+++ b/doc/hal/Doxyfile_html
--- a/doc/hal/index.html
+++ b/doc/hal/index.html
@ -0,0 +1,8 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+  <head>
+    <meta http-equiv="Refresh" content="0; URL=html/index.html">
+  </head>
+  <body>
+  </body>
+</html>
--- a/doc/hal/makechm.bat
+++ b/doc/hal/makechm.bat
@ -0,0 +1,5 @@
+del html\*.* /Q
+Doxygen Doxyfile_chm
+del html\*.md5
+del html\*.map
+pause
--- a/doc/hal/makehtml.bat
+++ b/doc/hal/makehtml.bat
@ -0,0 +1,5 @@
+del html\*.* /Q
+Doxygen Doxyfile_html
+del html\*.md5
+del html\*.map
+pause
--- a/doc/hal/readme.txt
+++ b/doc/hal/readme.txt
@ -0,0 +1,11 @@
+*** Documentation build procedure ***
+
+The following software must be installed:
+- Doxygen 1.7.4 or later.
+- Graphviz 2.26.3 or later. The ./bin directory must be specified in the path
+  in order to make Graphviz accessible by Doxygen.
+
+Build procedure:
+- Run Doxywizard.
+- Load ./docs/Doxyfile_html or ./docs/Doxyfile_chm from Doxywizard.
+- Start.
--- a/doc/hal/rsync_web.sh
+++ b/doc/hal/rsync_web.sh
@ -0,0 +1,2 @@
+#!/bin/bash
+rsync -avP -e ssh --delete --exclude=.* ./html/ gdisirio,chibios@web.sourceforge.net:/home/groups/c/ch/chibios/htdocs/html
--- a/doc/hal/src/main.dox
+++ b/doc/hal/src/main.dox
@ -0,0 +1,42 @@
+/*
+    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
+                 2011,2012,2013 Giovanni Di Sirio.
+
+    This file is part of ChibiOS/RT.
+
+    ChibiOS/RT 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 3 of the License, or
+    (at your option) any later version.
+
+    ChibiOS/RT 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, see <http://www.gnu.org/licenses/>.
+
+                                      ---
+
+    A special exception to the GPL can be applied should you wish to distribute
+    a combined work that includes ChibiOS/RT, without being obliged to provide
+    the source code for any proprietary components. See the file exception.txt
+    for full details of how and when the exception can be applied.
+*/
+
+/**
+ * @mainpage Introdution
+ * @author Giovanni Di Sirio (gdisirio@users.sourceforge.net).
+ *
+ * <h2>Features</h2>
+ * - Hardware Abstraction Layer (HAL) supporting numerous high level device
+ *   drivers abstracting common features in modern MCUs.
+ * - Driver models for: ADC, CAN, DAC, EXT, GPT, I2C, I2S, ICU, MAC, MMC, PAL,
+ *   PWM, RTC, SDC, Serial, USB, USB-CDC, SPI, ST.
+ * - Abstraction of streams.
+ * - Abstraction of block devices.
+ * - The drivers can be ported to virtually any MCU architecture thanks to
+ *   an high level API.
+ * .
+ */
--- a/os/hal/templates/osal/osal.mk
+++ b/os/hal/templates/osal/osal.mk
@ -0,0 +1,5 @@
+# OSAL files.
+OSALSRC += ${CHIBIOS}/os/hal/templates/osal/osal.c
+
+# Required include directories
+OSALINC += ${CHIBIOS}/os/hal/templates/osal