[Armadeus-commitlog] armadeus branch, master, updated. armadeus-5.3-299-g2c49dcd
Brought to you by:
sszy
Menu
▾
▴
[Armadeus-commitlog] armadeus branch, master, updated. armadeus-5.3-299-g2c49dcd
|
From: Julien B a. A. <ar...@us...> - 2014-06-24 06:25:13
|
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "armadeus".
The branch, master has been updated
via 2c49dcd504faddca6379b6be6d29c1af3057bd19 (commit)
from a0721960e6e3f8b7f4d8ea0bf7070fad8c0721be (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit 2c49dcd504faddca6379b6be6d29c1af3057bd19
Author: Julien Boibessot <jul...@ar...>
Date: Tue Jun 24 08:24:37 2014 +0200
[ASDEVICES] Fixes Doxygen warning on some C modules
-----------------------------------------------------------------------
Summary of changes:
target/packages/as_devices/c/as_adc_iio.h | 31 ++++++++++----
target/packages/as_devices/c/as_backlight.h | 9 +++-
target/packages/as_devices/c/as_led.h | 38 ++++++++--------
target/packages/as_devices/c/as_max1027.h | 53 +++++++++++++++++------
target/packages/as_devices/c/as_power_supply.h | 6 +-
target/packages/as_devices/c/as_pwm.h | 11 +++--
target/packages/as_devices/c/as_tcs3472.h | 20 ++++++---
7 files changed, 110 insertions(+), 58 deletions(-)
diff --git a/target/packages/as_devices/c/as_adc_iio.h b/target/packages/as_devices/c/as_adc_iio.h
index e15fc64..14f9ad9 100644
--- a/target/packages/as_devices/c/as_adc_iio.h
+++ b/target/packages/as_devices/c/as_adc_iio.h
@@ -18,8 +18,8 @@
*
*/
-#ifndef AS_ADC_IMX28_LRADC_H_
-#define AS_ADC_IMX28_LRADC_H_
+#ifndef __AS_ADC_IIO_H__
+#define __AS_ADC_IIO_H__
#ifdef __cplusplus
extern "C" {
@@ -27,14 +27,29 @@ extern "C" {
#include "as_adc.h"
-struct as_adc_device *as_adc_open_iio(int aDeviceNum, int aVRef);
-int32_t as_adc_get_value_in_millivolts_iio(struct as_adc_device *aDev,
- int aChannel);
-int32_t as_adc_close_iio(struct as_adc_device *aDev);
+/** @brief Initialize ADC access
+ *
+ * @param dev_num device number for IIO infra
+ * @param vref reference voltage
+ */
+struct as_adc_device *as_adc_open_iio(int dev_num, int vref);
+
+/** @brief Get given IIO ADC channel voltage
+ *
+ * @param adc ADC handler returned by as_adc_open_iio()
+ * @param channel channel to sample
+ */
+int32_t as_adc_get_value_in_millivolts_iio(struct as_adc_device *adc,
+ int channel);
+
+/** @brief Close ADC access
+ *
+ * @param adc ADC handler returned by as_adc_open_iio()
+ */
+int32_t as_adc_close_iio(struct as_adc_device *adc);
#ifdef __cplusplus
}
#endif /* __cplusplus */
-#endif /* AS_ADC_IMX28_LRADC_H_ */
-
+#endif /* __AS_ADC_IIO_H__ */
diff --git a/target/packages/as_devices/c/as_backlight.h b/target/packages/as_devices/c/as_backlight.h
index 06b70be..b678f8c 100644
--- a/target/packages/as_devices/c/as_backlight.h
+++ b/target/packages/as_devices/c/as_backlight.h
@@ -28,10 +28,13 @@ extern "C" {
#include <stdint.h>
+/** @brief Structure to store backlight device parameters
+ *
+ */
struct as_backlight_device {
- int fileActualBrightness;
- int fileMaxBrightness;
- int fileBrightness;
+ int fileActualBrightness; /*!< file descriptor to get current brightness */
+ int fileMaxBrightness; /*!< file descriptor to get maximum brightness */
+ int fileBrightness; /*!< file descriptor to set brightness */
};
/** @brief Open Backlight device
diff --git a/target/packages/as_devices/c/as_led.h b/target/packages/as_devices/c/as_led.h
index b9ae389..5e43215 100644
--- a/target/packages/as_devices/c/as_led.h
+++ b/target/packages/as_devices/c/as_led.h
@@ -30,73 +30,73 @@ extern "C" {
/**
- * Store led parameters
+ * @brief Store LED device parameters
*/
struct as_led_device {
- char led_name[32];
- int file_brightness;
- int file_max_brightness;
+ char led_name[32]; /*!< LED device name */
+ int file_brightness; /*!< file descriptor to set LED brightness */
+ int file_max_brightness; /*!< file descriptor to get LED max possible brightness */
};
-/** @brief Initialize led access
+/** @brief Initialize LED access
*
- * @param a_led_name char* name of the led
+ * @param led_name char* name of the led
*
* @return NULL on error
*/
-struct as_led_device *as_led_open(char *a_led_name);
+struct as_led_device *as_led_open(char *led_name);
/** @brief Close led access
*
- * @param a_led_dev as_led_device pointer structure
+ * @param led LED handler returned by as_led_open()
*
* @return error if negative
*/
-int32_t as_led_close(struct as_led_device *a_led_dev);
+int32_t as_led_close(struct as_led_device *led);
/** @brief Get max brightness
*
- * @param a_led_dev as_led_device pointer structure
+ * @param led LED handler returned by as_led_open()
*
* @return maximum allowed brightness, negative value on error
*/
-int32_t as_led_get_max_brightness(struct as_led_device *a_led_dev);
+int32_t as_led_get_max_brightness(struct as_led_device *led);
/** @brief Set brightness
*
- * @param a_led_dev as_led_device pointer structure
+ * @param led LED handler returned by as_led_open()
* @param a_brightness uint32_t requested value for led brighthness
*
* @return current brightness, negative value on error
*/
-int32_t as_led_set_brightness(struct as_led_device *a_led_dev, uint32_t a_brightness);
+int32_t as_led_set_brightness(struct as_led_device *led, uint32_t a_brightness);
/** @brief Get brightness
*
- * @param a_led_dev as_led_device pointer structure
+ * @param led LED handler returned by as_led_open()
*
* @return current brightness, negative value on error
*/
-int32_t as_led_get_brightness(struct as_led_device *a_led_dev);
+int32_t as_led_get_brightness(struct as_led_device *led);
/** @brief Make a led blinking
*
- * @param a_led_dev as_led_device pointer structure
+ * @param led LED handler returned by as_led_open()
* @param a_delay_on uint32_t value for led on time
* @param a_delay_off uint32_t value for led off time
*
* @return negative value on error
*/
-int32_t as_led_start_blinking(struct as_led_device *a_led_dev, int32_t a_delay_on, int32_t a_delay_off);
+int32_t as_led_start_blinking(struct as_led_device *led, int32_t a_delay_on, int32_t a_delay_off);
/** @brief Led stop blinking
*
- * @param a_led_dev as_led_device pointer structure
+ * @param led LED handler returned by as_led_open()
*
* @return negative value on error
*/
-int32_t as_led_stop_blinking(struct as_led_device *a_led_dev);
+int32_t as_led_stop_blinking(struct as_led_device *led);
#ifdef __cplusplus
}
diff --git a/target/packages/as_devices/c/as_max1027.h b/target/packages/as_devices/c/as_max1027.h
index edd071f..eb3612d 100644
--- a/target/packages/as_devices/c/as_max1027.h
+++ b/target/packages/as_devices/c/as_max1027.h
@@ -18,36 +18,61 @@
*
*/
-#ifndef AS_MAX1027_H_
-#define AS_MAX1027_H_
+#ifndef __AS_MAX1027_H__
+#define __AS_MAX1027_H__
#ifdef __cplusplus
extern "C" {
#endif
#include "as_adc.h"
-#define NUMBER_OF_CHANNELS (7)
-#define PATH_SIZE (50)
+#define NUMBER_OF_CHANNELS (7)
+#define PATH_SIZE (50)
typedef enum {
- AS_MAX1027_FAST,
- AS_MAX1027_SLOW
+ AS_MAX1027_FAST, /*!< Fast mode */
+ AS_MAX1027_SLOW /*!< Slow mode */
} AS_max1027_mode;
+/** @brief Structure to store max1027 parameters
+ *
+ */
struct as_max1027_device {
- AS_max1027_mode mode;
- uint8_t scan_mode;
- char path[PATH_SIZE];
+ AS_max1027_mode mode; /*!< mode/speed */
+ uint8_t scan_mode; /*!< ?? */
+ char path[PATH_SIZE]; /*!< ?? */
};
-struct as_adc_device *as_adc_open_max1027(int aDeviceNum, int aVRef);
-int32_t as_adc_get_value_in_millivolts_max1027(struct as_adc_device *aDev,
- int aChannel);
-int32_t as_adc_close_max1027(struct as_adc_device *aDev);
+/** @brief Initialize max1027 access
+ *
+ * @param num device number
+ * @param vref reference voltage
+ *
+ * @return pointer to device structure, NULL if error
+ */
+struct as_adc_device *as_adc_open_max1027(int num, int vref);
+
+/** @brief Get given max1027 channel voltage value
+ *
+ * @param max1027 chip handler
+ * @param channel channel to sample
+ *
+ * @return negative if error
+ */
+int32_t as_adc_get_value_in_millivolts_max1027(struct as_adc_device *max1027,
+ int channel);
+
+/** @brief Close given max1027 access
+ *
+ * @param max1027 chip handler
+ *
+ * @return negative if error
+ */
+int32_t as_adc_close_max1027(struct as_adc_device *max1027);
#ifdef __cplusplus
}
#endif /* __cplusplus */
-#endif /* AS_MAX1027_H_ */
+#endif /* __AS_MAX1027_H__ */
diff --git a/target/packages/as_devices/c/as_power_supply.h b/target/packages/as_devices/c/as_power_supply.h
index 394452c..c696e0b 100644
--- a/target/packages/as_devices/c/as_power_supply.h
+++ b/target/packages/as_devices/c/as_power_supply.h
@@ -22,7 +22,7 @@
#ifndef __ASPOWERSUPPLY_H__
#define __ASPOWERSUPPLY_H__
-#include <stdint.h>
+#include <stdint.h> /* uint32_t */
#ifdef __cplusplus
extern "C" {
@@ -30,10 +30,10 @@ extern "C" {
/**
- * Store power supplier parameters
+ * @brief Store power supplier parameters
*/
struct as_power_supply_device {
- char power_supply_name[32];
+ char power_supply_name[32]; /*!< device name */
int file_online;
int file_capacity;
int file_status;
diff --git a/target/packages/as_devices/c/as_pwm.h b/target/packages/as_devices/c/as_pwm.h
index fb44b78..3089abe 100644
--- a/target/packages/as_devices/c/as_pwm.h
+++ b/target/packages/as_devices/c/as_pwm.h
@@ -31,11 +31,14 @@ extern "C" {
/* number of pwm under system */
#define NUMBER_OF_PWM 2
+/** @brief Structure to handle PWM device
+ *
+ */
struct as_pwm_device {
- int fileFrequency;
- int filePeriod;
- int fileDuty;
- int fileActive;
+ int fileFrequency; /*!< file descriptor to set frequency */
+ int filePeriod; /*!< file descriptor to set period */
+ int fileDuty; /*!< file descriptor to set duty cycle */
+ int fileActive; /*!< file descriptor to activate PWM */
};
/** @brief Open pwm
diff --git a/target/packages/as_devices/c/as_tcs3472.h b/target/packages/as_devices/c/as_tcs3472.h
index 8065c7e..7dcf89c 100644
--- a/target/packages/as_devices/c/as_tcs3472.h
+++ b/target/packages/as_devices/c/as_tcs3472.h
@@ -27,15 +27,21 @@ extern "C" {
#include "as_i2c.h"
+/** @brief Structure to handle TCS3274 device
+ *
+ */
struct as_tcs3472 {
- struct as_i2c_device *i2c_dev;
+ struct as_i2c_device *i2c_dev; /*!< I2C bus handler */
};
+/** @brief Structure to store color results from TCS3274
+ *
+ */
struct as_tcs3472_colours {
- int clear;
- int red;
- int green;
- int blue;
+ int clear; /*!< Clear component */
+ int red; /*!< Red component */
+ int green; /*!< Green component */
+ int blue; /*!< Blue component */
};
/** @brief Initialize access to a TCS3472* chip
@@ -76,5 +82,5 @@ int32_t as_tcs3472_close(struct as_tcs3472 *tcs3472);
#ifdef __cplusplus
}
-#endif /* __cplusplus */
-#endif /* __AS_TCS3472_H__ */
+#endif /* __cplusplus */
+#endif /* __AS_TCS3472_H__ */
hooks/post-receive
--
armadeus
|
