From b24cd5b34f11aa3e7dbbec3f6fd0a390fb93233d Mon Sep 17 00:00:00 2001 From: Rocco Marco Guglielmi Date: Wed, 11 May 2016 15:27:25 +0000 Subject: EX: improved documentation. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@9467 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/ex/ST/l3gd20.h | 56 +++++++++++++++++----------------- os/ex/ST/lis302dl.h | 50 +++++++++++++++---------------- os/ex/ST/lsm6ds0.h | 86 ++++++++++++++++++++++++++--------------------------- 3 files changed, 96 insertions(+), 96 deletions(-) (limited to 'os') diff --git a/os/ex/ST/l3gd20.h b/os/ex/ST/l3gd20.h index d3eb7121f..f798d0c25 100644 --- a/os/ex/ST/l3gd20.h +++ b/os/ex/ST/l3gd20.h @@ -125,58 +125,58 @@ * @brief L3GD20 full scale */ typedef enum { - L3GD20_FS_250DPS = 0x00, /**< Full scale 250 degree per second. */ - L3GD20_FS_500DPS = 0x10, /**< Full scale 500 degree per second. */ - L3GD20_FS_2000DPS = 0x20 /**< Full scale 2000 degree per second. */ + L3GD20_FS_250DPS = 0x00, /**< Full scale 250 degree per second. */ + L3GD20_FS_500DPS = 0x10, /**< Full scale 500 degree per second. */ + L3GD20_FS_2000DPS = 0x20 /**< Full scale 2000 degree per second. */ }l3gd20_fs_t; /** * @brief L3GD20 output data rate and bandwidth */ typedef enum { - L3GD20_ODR_95HZ_FC_12_5 = 0x00, /**< ODR 95 Hz, BW 12.5 Hz. */ - L3GD20_ODR_95HZ_FC_25 = 0x10, /**< ODR 95 Hz, BW 25Hz. */ - L3GD20_ODR_190HZ_FC_12_5 = 0x40, /**< ODR 190 Hz, BW 12.5 Hz. */ - L3GD20_ODR_190HZ_FC_25 = 0x50, /**< ODR 190 Hz, BW 25 Hz. */ - L3GD20_ODR_190HZ_FC_50 = 0x60, /**< ODR 190 Hz, BW 50 Hz. */ - L3GD20_ODR_190HZ_FC_70 = 0x70, /**< ODR 190 Hz, BW 70 Hz. */ - L3GD20_ODR_380HZ_FC_20 = 0x80, /**< ODR 380 Hz, BW 20 Hz. */ - L3GD20_ODR_380HZ_FC_25 = 0x90, /**< ODR 380 Hz, BW 25 Hz. */ - L3GD20_ODR_380HZ_FC_50 = 0xA0, /**< ODR 380 Hz, BW 50 Hz. */ - L3GD20_ODR_380HZ_FC_100 = 0xB0, /**< ODR 380 Hz, BW 100 Hz. */ - L3GD20_ODR_760HZ_FC_30 = 0xC0, /**< ODR 760 Hz, BW 30 Hz. */ - L3GD20_ODR_760HZ_FC_35 = 0xD0, /**< ODR 760 Hz, BW 35 Hz. */ - L3GD20_ODR_760HZ_FC_50 = 0xE0, /**< ODR 760 Hz, BW 50 Hz. */ - L3GD20_ODR_760HZ_FC_100 = 0xF0 /**< ODR 760 Hz, BW 100 Hz. */ + L3GD20_ODR_95HZ_FC_12_5 = 0x00, /**< ODR 95 Hz, BW 12.5 Hz. */ + L3GD20_ODR_95HZ_FC_25 = 0x10, /**< ODR 95 Hz, BW 25Hz. */ + L3GD20_ODR_190HZ_FC_12_5 = 0x40, /**< ODR 190 Hz, BW 12.5 Hz. */ + L3GD20_ODR_190HZ_FC_25 = 0x50, /**< ODR 190 Hz, BW 25 Hz. */ + L3GD20_ODR_190HZ_FC_50 = 0x60, /**< ODR 190 Hz, BW 50 Hz. */ + L3GD20_ODR_190HZ_FC_70 = 0x70, /**< ODR 190 Hz, BW 70 Hz. */ + L3GD20_ODR_380HZ_FC_20 = 0x80, /**< ODR 380 Hz, BW 20 Hz. */ + L3GD20_ODR_380HZ_FC_25 = 0x90, /**< ODR 380 Hz, BW 25 Hz. */ + L3GD20_ODR_380HZ_FC_50 = 0xA0, /**< ODR 380 Hz, BW 50 Hz. */ + L3GD20_ODR_380HZ_FC_100 = 0xB0, /**< ODR 380 Hz, BW 100 Hz. */ + L3GD20_ODR_760HZ_FC_30 = 0xC0, /**< ODR 760 Hz, BW 30 Hz. */ + L3GD20_ODR_760HZ_FC_35 = 0xD0, /**< ODR 760 Hz, BW 35 Hz. */ + L3GD20_ODR_760HZ_FC_50 = 0xE0, /**< ODR 760 Hz, BW 50 Hz. */ + L3GD20_ODR_760HZ_FC_100 = 0xF0 /**< ODR 760 Hz, BW 100 Hz. */ }l3gd20_odr_t; /** * @brief L3GD20 axes enabling */ typedef enum { - L3GD20_AE_DISABLED = 0x00, /**< All axes disabled. */ - L3GD20_AE_X = 0x01, /**< Only X-axis enabled. */ - L3GD20_AE_Y = 0x02, /**< Only Y-axis enabled. */ - L3GD20_AE_XY = 0x03, /**< X and Y axes enabled. */ - L3GD20_AE_Z = 0x04, /**< Only Z-axis enabled. */ - L3GD20_AE_XZ = 0x05, /**< X and Z axes enabled. */ - L3GD20_AE_YZ = 0x06, /**< Y and Z axes enabled. */ - L3GD20_AE_XYZ = 0x07 /**< All axes enabled. */ + L3GD20_AE_DISABLED = 0x00, /**< All axes disabled. */ + L3GD20_AE_X = 0x01, /**< Only X-axis enabled. */ + L3GD20_AE_Y = 0x02, /**< Only Y-axis enabled. */ + L3GD20_AE_XY = 0x03, /**< X and Y axes enabled. */ + L3GD20_AE_Z = 0x04, /**< Only Z-axis enabled. */ + L3GD20_AE_XZ = 0x05, /**< X and Z axes enabled. */ + L3GD20_AE_YZ = 0x06, /**< Y and Z axes enabled. */ + L3GD20_AE_XYZ = 0x07 /**< All axes enabled. */ }l3gd20_ae_t; /** * @brief L3GD20 block data update */ typedef enum { - L3GD20_BDU_CONTINUOUS = 0x00, /**< Block data continuously updated. */ - L3GD20_BDU_BLOCKED = 0x80 /**< Block data updated after reading. */ + L3GD20_BDU_CONTINUOUS = 0x00, /**< Block data continuously updated. */ + L3GD20_BDU_BLOCKED = 0x80 /**< Block data updated after reading. */ }l3gd20_bdu_t; /** * @brief L3GD20 endianness */ typedef enum { - L3GD20_END_LITTLE = 0x00, /**< Little endian. */ + L3GD20_END_LITTLE = 0x00, /**< Little endian. */ L3GD20_END_BIG = 0x40 /**< Big endian. */ }l3gd20_end_t; diff --git a/os/ex/ST/lis302dl.h b/os/ex/ST/lis302dl.h index d372da15e..baa513205 100644 --- a/os/ex/ST/lis302dl.h +++ b/os/ex/ST/lis302dl.h @@ -69,7 +69,7 @@ * @brief LIS302DL shared SPI switch. * @details If set to @p TRUE the device acquires SPI bus ownership * on each transaction. - * @note The default is @p FALSE. Requires SPI_USE_MUTUAL_EXCLUSION + * @note The default is @p FALSE. Requires SPI_USE_MUTUAL_EXCLUSION. */ #if !defined(LIS302DL_SHARED_SPI) || defined(__DOXYGEN__) #define LIS302DL_SHARED_SPI FALSE @@ -105,48 +105,48 @@ * @{ */ /** - * @brief LIS302DL full scale + * @brief LIS302DL full scale. */ typedef enum { - LIS302DL_FS_2G = 0x00, /**< Full scale ±2g. */ - LIS302DL_FS_8G = 0x20 /**< Full scale ±8g. */ + LIS302DL_FS_2G = 0x00, /**< Full scale ±2g. */ + LIS302DL_FS_8G = 0x20 /**< Full scale ±8g. */ }lis302dl_fs_t; /** - * @brief LIS302DL output data rate and bandwidth + * @brief LIS302DL output data rate and bandwidth. */ typedef enum { - LIS302DL_ODR_100HZ = 0x00, /**< ODR 100 Hz. */ - LIS302DL_ODR_400HZ = 0x80 /**< ODR 400 Hz. */ + LIS302DL_ODR_100HZ = 0x00, /**< ODR 100 Hz. */ + LIS302DL_ODR_400HZ = 0x80 /**< ODR 400 Hz. */ }lis302dl_odr_t; /** - * @brief LIS302DL high pass filtering + * @brief LIS302DL high pass filtering. */ typedef enum { - LIS302DL_HP_DISABLED = 0x00, /**< HP bypassed. */ - LIS302DL_HP_0 = 0x10, /**< HP cutoff 2Hz (ODR 100Hz) or 8Hz */ - LIS302DL_HP_1 = 0x11, /**< HP cutoff 1Hz or 4Hz */ - LIS302DL_HP_2 = 0x12, /**< HP cutoff 0.5Hz or 2Hz */ + LIS302DL_HP_DISABLED = 0x00, /**< HP bypassed. */ + LIS302DL_HP_0 = 0x10, /**< HP cutoff 2Hz (ODR 100Hz) or 8Hz */ + LIS302DL_HP_1 = 0x11, /**< HP cutoff 1Hz or 4Hz */ + LIS302DL_HP_2 = 0x12, /**< HP cutoff 0.5Hz or 2Hz */ LIS302DL_HP_3 = 0x13 /**< HP cutoff 0.25Hz or 1Hz */ }lis302dl_hp_t; /** - * @brief LIS302DL axes enabling + * @brief LIS302DL axes enabling. */ typedef enum { - LIS302DL_AE_DISABLED = 0x00, /**< All axes disabled. */ - LIS302DL_AE_X = 0x01, /**< Only X-axis enabled. */ - LIS302DL_AE_Y = 0x02, /**< Only Y-axis enabled. */ - LIS302DL_AE_XY = 0x03, /**< X and Y axes enabled. */ - LIS302DL_AE_Z = 0x04, /**< Only Z-axis enabled. */ - LIS302DL_AE_XZ = 0x05, /**< X and Z axes enabled. */ - LIS302DL_AE_YZ = 0x06, /**< Y and Z axes enabled. */ - LIS302DL_AE_XYZ = 0x07 /**< All axes enabled. */ + LIS302DL_AE_DISABLED = 0x00, /**< All axes disabled. */ + LIS302DL_AE_X = 0x01, /**< Only X-axis enabled. */ + LIS302DL_AE_Y = 0x02, /**< Only Y-axis enabled. */ + LIS302DL_AE_XY = 0x03, /**< X and Y axes enabled. */ + LIS302DL_AE_Z = 0x04, /**< Only Z-axis enabled. */ + LIS302DL_AE_XZ = 0x05, /**< X and Z axes enabled. */ + LIS302DL_AE_YZ = 0x06, /**< Y and Z axes enabled. */ + LIS302DL_AE_XYZ = 0x07 /**< All axes enabled. */ }lis302dl_ae_t; /** - * @brief LIS302DL accelerometer subsystem unit + * @brief LIS302DL accelerometer subsystem unit. */ typedef enum { LIS302DL_ACC_UNIT_G = 0x00, /**< Cooked data in g. */ @@ -223,7 +223,7 @@ typedef struct LIS302DLDriver LIS302DLDriver; /** - * @extends BaseAccelerometerVMT + * @extends BaseAccelerometerVMT. * * @brief @p LIS302DL virtual methods table. */ @@ -246,7 +246,7 @@ struct LIS302DLVMT { int32_t bias[LIS302DL_NUMBER_OF_AXES]; /** - * @extends BaseAccelerometer + * @extends BaseAccelerometer. * * @brief LIS302DL 3-axis accelerometer class. * @details This class extends @p BaseAccelerometer by adding physical @@ -269,7 +269,7 @@ struct LIS302DLDriver { /** * @brief Get current MEMS temperature. - * @detail This information is very useful especially for high accuracy IMU + * @detail This information is very useful especially for high accuracy IMU. * * @param[in] ip pointer to a @p BaseAccelerometer class. * @param[out] temp the MEMS temperature as single precision floating. diff --git a/os/ex/ST/lsm6ds0.h b/os/ex/ST/lsm6ds0.h index 47b46dfcb..a43bf7ad9 100644 --- a/os/ex/ST/lsm6ds0.h +++ b/os/ex/ST/lsm6ds0.h @@ -74,14 +74,14 @@ * @brief LSM6DS0 shared I2C switch. * @details If set to @p TRUE the device acquires I2C bus ownership * on each transaction. - * @note The default is @p FALSE. Requires I2C_USE_MUTUAL_EXCLUSION + * @note The default is @p FALSE. Requires I2C_USE_MUTUAL_EXCLUSION. */ #if !defined(LSM6DS0_SHARED_I2C) || defined(__DOXYGEN__) #define LSM6DS0_SHARED_I2C FALSE #endif /** - * @brief Number of acquisitions for gyroscope bias removal + * @brief Number of acquisitions for gyroscope bias removal. * @details This is the number of acquisitions performed to compute the * bias. A repetition is required in order to remove noise. */ @@ -90,7 +90,7 @@ #endif /** - * @brief Settling time for gyroscope bias removal + * @brief Settling time for gyroscope bias removal. * @details This is the time between each bias acquisition. */ #if !defined(LSM6DS0_GYRO_BIAS_SETTLING_uS) || defined(__DOXYGEN__) @@ -123,12 +123,12 @@ /*===========================================================================*/ /** - * @name LSM6DS0 accelerometer subsystem data structures and types + * @name LSM6DS0 accelerometer subsystem data structures and types. * @{ */ /** - * @brief LSM6DS0 accelerometer subsystem full scale + * @brief LSM6DS0 accelerometer subsystem full scale. */ typedef enum { LSM6DS0_ACC_FS_2G = 0x00, /**< Full scale ±2g. */ @@ -138,7 +138,7 @@ typedef enum { } lsm6ds0_acc_fs_t; /** - * @brief LSM6DS0 accelerometer subsystem output data rate + * @brief LSM6DS0 accelerometer subsystem output data rate. */ typedef enum { LSM6DS0_ACC_ODR_PD = 0x00, /**< Power down */ @@ -151,7 +151,7 @@ typedef enum { } lsm6ds0_acc_odr_t; /** - * @brief LSM6DS0 accelerometer subsystem axes enabling + * @brief LSM6DS0 accelerometer subsystem axes enabling. */ typedef enum { LSM6DS0_ACC_AE_DISABLED = 0x00, /**< All axes disabled. */ @@ -165,7 +165,7 @@ typedef enum { } lsm6ds0_acc_ae_t; /** - * @brief LSM6DS0 accelerometer subsystem anti aliasing filter bandwidth + * @brief LSM6DS0 accelerometer subsystem anti aliasing filter bandwidth. */ typedef enum { LSM6DS0_ACC_OBW_ODR = 0x00, /**< Depending on ODR. */ @@ -173,7 +173,7 @@ typedef enum { } lsm6ds0_acc_obw_t; /** - * @brief LSM6DS0 accelerometer subsystem high resolution mode + * @brief LSM6DS0 accelerometer subsystem high resolution mode. */ typedef enum { LSM6DS0_ACC_HR_DISABLED = 0x00, /**< High resolution mode disabled. */ @@ -181,7 +181,7 @@ typedef enum { } lsm6ds0_acc_hr_t; /** - * @brief LSM6DS0 accelerometer subsystem filtered data selection + * @brief LSM6DS0 accelerometer subsystem filtered data selection. */ typedef enum { LSM6DS0_ACC_FDS_ENABLED = 0x00, /**< Internal filter bypassed. */ @@ -189,7 +189,7 @@ typedef enum { } lsm6ds0_acc_fds_t; /** - * @brief LSM6DS0 accelerometer subsystem digital filter + * @brief LSM6DS0 accelerometer subsystem digital filter. */ typedef enum { LSM6DS0_ACC_DCF_400 = 0x00, /**< Low pass cutoff freq. ODR/400 Hz. */ @@ -199,7 +199,7 @@ typedef enum { } lsm6ds0_acc_dcf_t; /** - * @brief LSM6DS0 accelerometer subsystem anti aliasing filter bandwidth + * @brief LSM6DS0 accelerometer subsystem anti aliasing filter bandwidth. */ typedef enum { LSM6DS0_ACC_AABW_408Hz = 0x00, /**< Anti Aliasing filter BW 408Hz. */ @@ -210,7 +210,7 @@ typedef enum { } lsm6ds0_acc_aabw_t; /** - * @brief LSM6DS0 accelerometer subsystem decimation mode + * @brief LSM6DS0 accelerometer subsystem decimation mode. */ typedef enum { LSM6DS0_ACC_DEC_DISABLED = 0x00, /**< Decimation disabled. */ @@ -220,7 +220,7 @@ typedef enum { } lsm6ds0_acc_dec_t; /** - * @brief LSM6DS0 accelerometer subsystem unit + * @brief LSM6DS0 accelerometer subsystem unit. */ typedef enum { LSM6DS0_ACC_UNIT_G = 0x00, /**< Cooked data in g. */ @@ -233,54 +233,54 @@ typedef enum { */ typedef struct { /** - * @brief LSM6DS0 accelerometer subsystem full scale + * @brief LSM6DS0 accelerometer subsystem full scale. */ lsm6ds0_acc_fs_t fullscale; /** - * @brief LSM6DS0 accelerometer subsystem output data rate + * @brief LSM6DS0 accelerometer subsystem output data rate. */ lsm6ds0_acc_odr_t outdatarate; /** - * @brief LSM6DS0 accelerometer subsystem axes enabling + * @brief LSM6DS0 accelerometer subsystem axes enabling. */ lsm6ds0_acc_ae_t axesenabling; /** - * @brief LSM6DS0 accelerometer subsystem output bandwidth + * @brief LSM6DS0 accelerometer subsystem output bandwidth. */ lsm6ds0_acc_obw_t outbandwidth; /** - * @brief LSM6DS0 accelerometer subsystem high resolution mode + * @brief LSM6DS0 accelerometer subsystem high resolution mode. */ lsm6ds0_acc_hr_t highresmode; /** - * @brief LSM6DS0 accelerometer subsystem filtered data selection + * @brief LSM6DS0 accelerometer subsystem filtered data selection. */ lsm6ds0_acc_fds_t filtdatasel; /** - * @brief LSM6DS0 accelerometer subsystem digital filter + * @brief LSM6DS0 accelerometer subsystem digital filter. */ lsm6ds0_acc_dcf_t digifilter; /** - * @brief LSM6DS0 accelerometer subsystem anti aliasing filter bandwidth + * @brief LSM6DS0 accelerometer subsystem anti aliasing filter bandwidth. */ lsm6ds0_acc_aabw_t aabandwidth; /** - * @brief LSM6DS0 accelerometer subsystem decimation mode + * @brief LSM6DS0 accelerometer subsystem decimation mode. */ lsm6ds0_acc_dec_t decmode; /** - * @brief LSM6DS0 accelerometer subsystem unit + * @brief LSM6DS0 accelerometer subsystem unit. */ lsm6ds0_acc_unit_t unit; } LSM6DS0AccConfig; /** @} */ /** - * @name LSM6DS0 gyroscope subsystem data structures and types + * @name LSM6DS0 gyroscope subsystem data structures and types. * @{ */ /** - * @brief LSM6DS0 gyroscope subsystem full scale + * @brief LSM6DS0 gyroscope subsystem full scale. */ typedef enum { LSM6DS0_GYRO_FS_245DSP = 0x00, /**< Full scale ±245 degree per second */ @@ -289,7 +289,7 @@ typedef enum { } lsm6ds0_gyro_fs_t; /** - * @brief LSM6DS0 gyroscope subsystem output data rate + * @brief LSM6DS0 gyroscope subsystem output data rate. */ typedef enum { LSM6DS0_GYRO_ODR_PD = 0x00, @@ -313,7 +313,7 @@ typedef enum { } lsm6ds0_gyro_odr_t; /** - * @brief LSM6DS0 gyroscope subsystem axes enabling + * @brief LSM6DS0 gyroscope subsystem axes enabling. */ typedef enum { LSM6DS0_GYRO_AE_DISABLED = 0x00, /**< All axes disabled. */ @@ -327,7 +327,7 @@ typedef enum { } lsm6ds0_gyro_ae_t; /** - * @brief LSM6DS0 gyroscope subsystem low mode configuration + * @brief LSM6DS0 gyroscope subsystem low mode configuration. */ typedef enum { LSM6DS0_GYRO_LP_DISABLED = 0x00, /**< Low power mode disabled. */ @@ -335,7 +335,7 @@ typedef enum { } lsm6ds0_gyro_lp_t; /** - * @brief LSM6DS0 gyroscope subsystem output selection + * @brief LSM6DS0 gyroscope subsystem output selection. */ typedef enum { LSM6DS0_GYRO_OUT_SEL_0 = 0x00, /**< Low pass filter 1. */ @@ -344,7 +344,7 @@ typedef enum { } lsm6ds0_gyro_out_sel_t; /** - * @brief LSM6DS0 gyroscope subsystem high pass filter + * @brief LSM6DS0 gyroscope subsystem high pass filter. */ typedef enum { LSM6DS0_GYRO_HP_DISABLED = 0x00, /**< High pass filter disabled. */ @@ -352,7 +352,7 @@ typedef enum { } lsm6ds0_gyro_hp_t; /** - * @brief LSM6DS0 gyroscope subsystem high pass filter configuration + * @brief LSM6DS0 gyroscope subsystem high pass filter configuration. */ typedef enum { LSM6DS0_GYRO_HPCF_0 = 0x00, /**< Refer to table 48 of RM */ @@ -372,42 +372,42 @@ typedef enum { */ typedef struct { /** - * @brief LSM6DS0 gyroscope subsystem full scale + * @brief LSM6DS0 gyroscope subsystem full scale. */ lsm6ds0_gyro_fs_t fullscale; /** - * @brief LSM6DS0 gyroscope subsystem output data rate + * @brief LSM6DS0 gyroscope subsystem output data rate. */ lsm6ds0_gyro_odr_t outdatarate; /** - * @brief LSM6DS0 gyroscope subsystem axes enabling + * @brief LSM6DS0 gyroscope subsystem axes enabling. */ lsm6ds0_gyro_ae_t axesenabling; /** - * @brief LSM6DS0 gyroscope subsystem low mode configuration + * @brief LSM6DS0 gyroscope subsystem low mode configuration. */ lsm6ds0_gyro_lp_t lowmodecfg; /** - * @brief LSM6DS0 gyroscope subsystem output selection + * @brief LSM6DS0 gyroscope subsystem output selection. */ lsm6ds0_gyro_out_sel_t outsel; /** - * @brief LSM6DS0 gyroscope subsystem high pass filter + * @brief LSM6DS0 gyroscope subsystem high pass filter. */ lsm6ds0_gyro_hp_t hpfenable; /** - * @brief LSM6DS0 gyroscope subsystem high pass filter configuration + * @brief LSM6DS0 gyroscope subsystem high pass filter configuration. */ lsm6ds0_gyro_hpcf_t hpcfg; } LSM6DS0GyroConfig; /** @} */ /** - * @name LSM6DS0 main system data structures and types + * @name LSM6DS0 main system data structures and types. * @{ */ /** - * @brief Accelerometer and Gyroscope Slave Address + * @brief Accelerometer and Gyroscope Slave Address. */ typedef enum { LSM6DS0_SAD_GND = 0x6A, /**< SAD pin connected to GND. */ @@ -415,7 +415,7 @@ typedef enum { } lsm6ds0_sad_t; /** - * @brief LSM6DS0 block data update + * @brief LSM6DS0 block data update. */ typedef enum { LSM6DS0_BDU_CONTINUOUS = 0x00, /**< Block data continuously updated. */ @@ -423,7 +423,7 @@ typedef enum { } lsm6ds0_bdu_t; /** - * @brief LSM6DS0 endianness + * @brief LSM6DS0 endianness. */ typedef enum { LSM6DS0_END_LITTLE = 0x00, /**< Little endian. */ -- cgit v1.2.3