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

4 files changed, 167 insertions, 6 deletions

diff --git a/os/hal/include/pwm.h b/os/hal/include/pwm.h
index 9b0043a21..562be26bc 100644
--- a/os/hal/include/pwm.h
+++ b/os/hal/include/pwm.h
@@ -78,6 +78,32 @@ typedef void (*pwmcallback_t)(void);
 /* Driver macros.                                                            */

 /*===========================================================================*/

 

+/**

+ * @brief   Enables a PWM channel.

+ * @details Programs (or reprograms) a PWM channel.

+ * @note    This function has to be invoked from a lock zone.

+ *

+ * @param[in] pwmp      pointer to a @p PWMDriver object

+ * @param[in] channel   PWM channel identifier

+ * @param[in] width     PWM pulse width as clock pulses number

+ */

+#define pwmEnableChannelI(pwmp, channel, width) {                           \

+  pwm_lld_enable_channel(pwmp, channel, width);                             \

+}

+

+/**

+ * @brief Disables a PWM channel.

+ * @details The channel is disabled and its output line returned to the

+ *          idle state.

+ * @note    This function has to be invoked from a lock zone.

+ *

+ * @param[in] pwmp      pointer to a @p PWMDriver object

+ * @param[in] channel   PWM channel identifier

+ */

+#define pwmDisableChannelI(pwmp, channel) {                                 \

+  pwm_lld_disable_channel(pwmp, channel);                                   \

+}

+

 /*===========================================================================*/

 /* External declarations.                                                    */

 /*===========================================================================*/

diff --git a/os/hal/src/adc.c b/os/hal/src/adc.c
index 2a329d003..5348d7e93 100644
--- a/os/hal/src/adc.c
+++ b/os/hal/src/adc.c
@@ -112,11 +112,10 @@ void adcStop(ADCDriver *adcp) {
  * @brief   Starts an ADC conversion.

  * @details Starts a conversion operation, there are two kind of conversion

  *          modes:

- *          - <b>LINEAR</b>, this mode is activated when the @p callback

- *            parameter is set to @p NULL, in this mode the buffer is filled

- *            once and then the conversion stops automatically.

- *          - <b>CIRCULAR</b>, when a callback function is defined the

- *            conversion never stops and the buffer is filled circularly.

+ *          - <b>LINEAR</b>, in this mode the buffer is filled once and then

+ *            the conversion stops automatically.

+ *          - <b>CIRCULAR</b>, in this mode the conversion never stops and

+ *            the buffer is filled circularly.<br>

  *            During the conversion the callback function is invoked when

  *            the buffer is 50% filled and when the buffer is 100% filled,

  *            this way is possible to process the conversion stream in real

@@ -133,7 +132,8 @@ void adcStop(ADCDriver *adcp) {
  * @param[out] samples  pointer to the samples buffer

  * @param[in] depth     buffer depth (matrix rows number). The buffer depth

  *                      must be one or an even number.

- * @param[in] callback  pointer to the conversion callback function

+ * @param[in] callback  pointer to the conversion callback function, this

+ *                      parameter can be @p NULL if a callback is not required

  * @return              The operation status.

  * @retval FALSE        the conversion has been started.

  * @retval TRUE         the driver is busy, conversion not started.

diff --git a/os/hal/src/pwm.c b/os/hal/src/pwm.c
index 3aeec1309..4b797da0c 100644
--- a/os/hal/src/pwm.c
+++ b/os/hal/src/pwm.c
@@ -20,6 +20,7 @@
 /**

  * @file    pwm.c

  * @brief   PWM Driver code.

+ *

  * @addtogroup PWM

  * @{

  */

@@ -104,6 +105,7 @@ void pwmStop(PWMDriver *pwmp) {
 

 /**

  * @brief   Enables a PWM channel.

+ * @details Programs (or reprograms) a PWM channel.

  *

  * @param[in] pwmp      pointer to a @p PWMDriver object

  * @param[in] channel   PWM channel identifier

diff --git a/os/kernel/include/chfiles.h b/os/kernel/include/chfiles.h
new file mode 100644
index 000000000..ecd03fd04
--- /dev/null
+++ b/os/kernel/include/chfiles.h
@@ -0,0 +1,133 @@
+/*

+    ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 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/>.

+*/

+

+/**

+ * @file    chfiles.h

+ * @brief   Data files.

+ * @details This header defines abstract interfaces useful to access generic

+ *          data files in a standardized way.

+ *

+ * @addtogroup data_files

+ * @details This module define an abstract interface for generic data files.

+ *          Note that no code is present, data files are just abstract

+ *          interface-like structures, you should look at the systems as to

+ *          a set of abstract C++ classes (even if written in C). This system

+ *          has the advantage to make the access to streams independent

+ *          from the implementation logic.<br>

+ *          The data files interface can be used as base class for high level

+ *          object types such as an API for a File System implementation.

+ * @{

+ */

+

+#ifndef _CHFILES_H_

+#define _CHFILES_H_

+

+/**

+ * @brief   Error code from the file stream methods.

+ */

+#define FILE_ERROR 0xFFFFFFFFUL

+

+/**

+ * @brief   File offset type.

+ */

+typedef uint32_t fileoffset_t;

+

+/**

+ * @brief   BaseFileStream specific methods.

+ */

+#define _base_file_stream_methods                                           \

+  _base_sequential_stream_methods                                           \

+  /* File close method.*/                                                   \

+  uint32_t (*close)(void *instance);                                        \

+  /* Get last error code method.*/                                          \

+  int (*geterror)(void *instance);                                          \

+  /* File get size method.*/                                                \

+  fileoffset_t (*getsize)(void *instance);                                  \

+  /* File get current position method.*/                                    \

+  fileoffset_t (*getposition)(void *instance);                              \

+  /* File seek method.*/                                                    \

+  fileoffset_t (*lseek)(void *instance, fileoffset_t offset);

+

+/**

+ * @brief   @p BaseFileStream specific data.

+ * @note    It is empty because @p BaseFileStream is only an interface

+ *          without implementation.

+ */

+#define _base_file_stream_data                                              \

+  _base_sequential_stream_data

+

+/**

+ * @brief   @p BaseFileStream virtual methods table.

+ */

+struct BaseFilelStreamVMT {

+  _base_file_stream_methods

+};

+

+/**

+ * @extends BaseSequentialStream

+ *

+ * @brief   Base file stream class.

+ * @details This class represents a generic file data stream.

+ */

+typedef struct {

+  /** @brief Virtual Methods Table.*/

+  const struct FileStreamVMT *vmt;

+  _base_file_stream_data

+} BaseFileStream;

+

+/**

+ * @brief   Base file Stream close.

+ * @details The function closes a file stream.

+ *

+ * @param[in] ip        pointer to a @p BaseFileStream or derived class

+ */

+#define chFileStreamClose(ip) ((ip)->vmt->close(ip))

+

+/**

+ * @brief   Returns an implementation dependent error code.

+ *

+ * @param[in] ip        pointer to a @p BaseFileStream or derived class

+ */

+#define chFileStreamGetError ((ip)->vmt->geterror(ip))

+

+/**

+ * @brief   Returns the current file size.

+ *

+ * @param[in] ip        pointer to a @p BaseFileStream or derived class

+ */

+#define chFileStreamGetSize ((ip)->vmt->getposition(ip))

+

+/**

+ * @brief   Returns the current file pointer position.

+ *

+ * @param[in] ip        pointer to a @p BaseFileStream or derived class

+ */

+#define chFileStreamGetPosition ((ip)->vmt->getposition(ip))

+

+/**

+ * @brief   Moves the file current pointer to an absolute position.

+ *

+ * @param[in] ip        pointer to a @p BaseFileStream or derived class

+ * @param[in] offset    new absolute position

+ */

+#define chFileStreamSeek ((ip)->vmt->lseek(ip, offset))

+

+#endif /* _CHFILES_H_ */

+

+/** @} */