aboutsummaryrefslogtreecommitdiffstats
path: root/os
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2010-11-09 18:50:57 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2010-11-09 18:50:57 +0000
commite5c365f61563007712f5f28500e04ba61e33994a (patch)
tree4cbebbb9674f56b6cc058e01da5497328cfcf496 /os
parent47afb406a180fe3e1dc7c593b202d131481ad4a5 (diff)
downloadChibiOS-e5c365f61563007712f5f28500e04ba61e33994a.tar.gz
ChibiOS-e5c365f61563007712f5f28500e04ba61e33994a.tar.bz2
ChibiOS-e5c365f61563007712f5f28500e04ba61e33994a.zip
Documentation related fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2340 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os')
-rw-r--r--os/hal/platforms/LPC11xx/platform.dox1
-rw-r--r--os/hal/platforms/LPC13xx/platform.dox1
-rw-r--r--os/hal/platforms/STM8/platform.dox27
-rw-r--r--os/kernel/include/ch.h4
4 files changed, 27 insertions, 6 deletions
diff --git a/os/hal/platforms/LPC11xx/platform.dox b/os/hal/platforms/LPC11xx/platform.dox
index fb8493659..19dd542ae 100644
--- a/os/hal/platforms/LPC11xx/platform.dox
+++ b/os/hal/platforms/LPC11xx/platform.dox
@@ -95,6 +95,7 @@
* - Clock stop for reduced power usage when the driver is in stop state.
* - Each SSP can be independently enabled and programmed. Unused
* peripherals are left in low power mode.
+ * - Fully interrupt driven.
* - Programmable interrupt priority levels for each SSP.
* .
* @ingroup LPC11xx
diff --git a/os/hal/platforms/LPC13xx/platform.dox b/os/hal/platforms/LPC13xx/platform.dox
index cb04828dc..7b1e09a60 100644
--- a/os/hal/platforms/LPC13xx/platform.dox
+++ b/os/hal/platforms/LPC13xx/platform.dox
@@ -95,6 +95,7 @@
* - Clock stop for reduced power usage when the driver is in stop state.
* - Each SSP can be independently enabled and programmed. Unused
* peripherals are left in low power mode.
+ * - Fully interrupt driven.
* - Programmable interrupt priority levels for each SSP.
* .
* @ingroup LPC13xx
diff --git a/os/hal/platforms/STM8/platform.dox b/os/hal/platforms/STM8/platform.dox
index 2b6e34f59..c71063910 100644
--- a/os/hal/platforms/STM8/platform.dox
+++ b/os/hal/platforms/STM8/platform.dox
@@ -18,7 +18,7 @@
*/
/**
- * @defgroup STM8_DRIVERS STM8x Drivers
+ * @defgroup STM8 STM8x Drivers
* @details This section describes all the supported drivers on the STM8S and
* STM8A platforms and the implementation details of the single
* drivers.
@@ -37,7 +37,7 @@
* - Clock tree initialization.
* - Clock source selection.
* .
- * @ingroup STM8_DRIVERS
+ * @ingroup STM8
*/
/**
@@ -81,7 +81,26 @@
* - Bus/group writing is not atomic.
* - Pad/group mode setup is not atomic.
* .
- * @ingroup STM8_DRIVERS
+ * @ingroup STM8
+ */
+
+/**
+ * @defgroup STM8_SPI STM8 SPI Support
+ * @details The SPI driver supports the STM8 SPI peripheral in an interrupt
+ * driven implementation.
+ * @note Being the SPI a fast peripheral, much care must be taken to
+ * not saturate the CPU bandwidth with an excessive IRQ rate. The
+ * maximum transfer bit rate is likely limited by the IRQ
+ * handling.
+ *
+ * @section stm8_spi_1 Supported HW resources
+ * - SPI.
+ * .
+ * @section stm8_spi_2 STM8 SPI driver implementation features
+ * - Clock stop for reduced power usage when the driver is in stop state.
+ * - Fully interrupt driven.
+ * .
+ * @ingroup STM8
*/
/**
@@ -101,5 +120,5 @@
* peripherals are left in low power mode.
* - Fully interrupt driven.
* .
- * @ingroup STM8_DRIVERS
+ * @ingroup STM8
*/
diff --git a/os/kernel/include/ch.h b/os/kernel/include/ch.h
index 58be5472a..07fc070d1 100644
--- a/os/kernel/include/ch.h
+++ b/os/kernel/include/ch.h
@@ -39,7 +39,7 @@
/**
* @brief Kernel version string.
*/
-#define CH_KERNEL_VERSION "2.1.3unstable"
+#define CH_KERNEL_VERSION "2.1.4unstable"
/**
* @brief Kernel version major number.
@@ -54,7 +54,7 @@
/**
* @brief Kernel version patch number.
*/
-#define CH_KERNEL_PATCH 3
+#define CH_KERNEL_PATCH 4
/*
* Common values.