ChibiOS  19.1.4
l3gd20.h File Reference

L3GD20 MEMS interface module header. More...

#include "hal_gyroscope.h"

Go to the source code of this file.

Data Structures

struct  L3GD20Config
 L3GD20 configuration structure. More...
 
struct  L3GD20VMT
 L3GD20 virtual methods table. More...
 
struct  L3GD20Driver
 L3GD20 3-axis gyroscope class. More...
 

Macros

#define l3gd20GyroscopeGetAxesNumber(devp)   gyroscopeGetAxesNumber(&((devp)->gyro_if))
 Return the number of axes of the BaseGyroscope. More...
 
#define l3gd20GyroscopeReadRaw(devp, axes)   gyroscopeReadRaw(&((devp)->gyro_if), axes)
 Retrieves raw data from the BaseGyroscope. More...
 
#define l3gd20GyroscopeReadCooked(devp, axes)   gyroscopeReadCooked(&((devp)->gyro_if), axes)
 Retrieves cooked data from the BaseGyroscope. More...
 
#define l3gd20GyroscopeSampleBias(devp)   gyroscopeSampleBias(&((devp)->gyro_if))
 Samples bias values for the BaseGyroscope. More...
 
#define l3gd20GyroscopeSetBias(devp, bp)   gyroscopeSetBias(&((devp)->gyro_if), bp)
 Set bias values for the BaseGyroscope. More...
 
#define l3gd20GyroscopeResetBias(devp)   gyroscopeResetBias(&((devp)->gyro_if))
 Reset bias values for the BaseGyroscope. More...
 
#define l3gd20GyroscopeSetSensitivity(devp, sp)   gyroscopeSetSensitivity(&((devp)->gyro_if), sp)
 Set sensitivity values for the BaseGyroscope. More...
 
#define l3gd20GyroscopeResetSensitivity(devp)   gyroscopeResetSensitivity(&((devp)->gyro_if))
 Reset sensitivity values for the BaseGyroscope. More...
 
#define l3gd20GyroscopeSetFullScale(devp, fs)   (devp)->vmt->acc_set_full_scale(devp, fs)
 Changes the L3GD20Driver gyroscope fullscale value. More...
 
Version identification
#define EX_L3GD20_VERSION   "1.1.2"
 L3GD20 driver version string. More...
 
#define EX_L3GD20_MAJOR   1
 L3GD20 driver version major number. More...
 
#define EX_L3GD20_MINOR   1
 L3GD20 driver version minor number. More...
 
#define EX_L3GD20_PATCH   2
 L3GD20 driver version patch number. More...
 
#define L3GD20_GYRO_NUMBER_OF_AXES   3U
 L3GD20 gyroscope system characteristics. More...
 
L3GD20 communication interfaces related bit masks
#define L3GD20_DI_MASK   0xFF
 
#define L3GD20_DI(n)   (1 << n)
 
#define L3GD20_AD_MASK   0x3F
 
#define L3GD20_AD(n)   (1 << n)
 
#define L3GD20_MS   (1 << 6)
 
#define L3GD20_RW   (1 << 7)
 
L3GD20 register addresses
#define L3GD20_AD_WHO_AM_I   0x0F
 
#define L3GD20_AD_CTRL_REG1   0x20
 
#define L3GD20_AD_CTRL_REG2   0x21
 
#define L3GD20_AD_CTRL_REG3   0x22
 
#define L3GD20_AD_CTRL_REG4   0x23
 
#define L3GD20_AD_CTRL_REG5   0x24
 
#define L3GD20_AD_REFERENCE   0x25
 
#define L3GD20_AD_OUT_TEMP   0x26
 
#define L3GD20_AD_STATUS_REG   0x27
 
#define L3GD20_AD_OUT_X_L   0x28
 
#define L3GD20_AD_OUT_X_H   0x29
 
#define L3GD20_AD_OUT_Y_L   0x2A
 
#define L3GD20_AD_OUT_Y_H   0x2B
 
#define L3GD20_AD_OUT_Z_L   0x2C
 
#define L3GD20_AD_OUT_Z_H   0x2D
 
#define L3GD20_AD_FIFO_CTRL_REG   0x2E
 
#define L3GD20_AD_FIFO_SRC_REG   0x2F
 
#define L3GD20_AD_INT1_CFG   0x30
 
#define L3GD20_AD_INT1_SRC   0x31
 
#define L3GD20_AD_INT1_THS_XH   0x32
 
#define L3GD20_AD_INT1_THS_XL   0x33
 
#define L3GD20_AD_INT1_THS_YH   0x34
 
#define L3GD20_AD_INT1_THS_YL   0x35
 
#define L3GD20_AD_INT1_THS_ZH   0x36
 
#define L3GD20_AD_INT1_THS_ZL   0x37
 
#define L3GD20_AD_INT1_DURATION   0x38
 
L3GD20_CTRL_REG1 register bits definitions
#define L3GD20_CTRL_REG1_MASK   0xFF
 
#define L3GD20_CTRL_REG1_XEN   (1 << 0)
 
#define L3GD20_CTRL_REG1_YEN   (1 << 1)
 
#define L3GD20_CTRL_REG1_ZEN   (1 << 2)
 
#define L3GD20_CTRL_REG1_PD   (1 << 3)
 
#define L3GD20_CTRL_REG1_BW0   (1 << 4)
 
#define L3GD20_CTRL_REG1_BW1   (1 << 5)
 
#define L3GD20_CTRL_REG1_DR0   (1 << 6)
 
#define L3GD20_CTRL_REG1_DR1   (1 << 7)
 
L3GD20_CTRL_REG2 register bits definitions
#define L3GD20_CTRL_REG2_MASK   0x3F
 
#define L3GD20_CTRL_REG2_HPCF0   (1 << 0)
 
#define L3GD20_CTRL_REG2_HPCF1   (1 << 1)
 
#define L3GD20_CTRL_REG2_HPCF2   (1 << 2)
 
#define L3GD20_CTRL_REG2_HPCF3   (1 << 3)
 
#define L3GD20_CTRL_REG2_HPM0   (1 << 4)
 
#define L3GD20_CTRL_REG2_HPM1   (1 << 5)
 
L3GD20_CTRL_REG3 register bits definitions
#define L3GD20_CTRL_REG3_MASK   0xFF
 
#define L3GD20_CTRL_REG3_I2_EMPTY   (1 << 0)
 
#define L3GD20_CTRL_REG3_I2_ORUN   (1 << 1)
 
#define L3GD20_CTRL_REG3_I2_WTM   (1 << 2)
 
#define L3GD20_CTRL_REG3_I2_DRDY   (1 << 3)
 
#define L3GD20_CTRL_REG3_PP_OD   (1 << 4)
 
#define L3GD20_CTRL_REG3_H_LACTIVE   (1 << 5)
 
#define L3GD20_CTRL_REG3_I1_BOOT   (1 << 6)
 
#define L3GD20_CTRL_REG3_I1_INT1   (1 << 7)
 
L3GD20_CTRL_REG4 register bits definitions
#define L3GD20_CTRL_REG4_MASK   0xF1
 
#define L3GD20_CTRL_REG4_SIM   (1 << 0)
 
#define L3GD20_CTRL_REG4_FS_MASK   0x30
 
#define L3GD20_CTRL_REG4_FS0   (1 << 4)
 
#define L3GD20_CTRL_REG4_FS1   (1 << 5)
 
#define L3GD20_CTRL_REG4_BLE   (1 << 6)
 
#define L3GD20_CTRL_REG4_BDU   (1 << 7)
 
L3GD20_CTRL_REG5 register bits definitions
#define L3GD20_CTRL_REG5_MASK   0xDF
 
#define L3GD20_CTRL_REG5_OUT_SEL0   (1 << 0)
 
#define L3GD20_CTRL_REG5_OUT_SEL1   (1 << 1)
 
#define L3GD20_CTRL_REG5_INT1_SEL0   (1 << 2)
 
#define L3GD20_CTRL_REG5_INT1_SEL1   (1 << 3)
 
#define L3GD20_CTRL_REG5_HPEN   (1 << 4)
 
#define L3GD20_CTRL_REG5_FIFO_EN   (1 << 6)
 
#define L3GD20_CTRL_REG5_BOOT   (1 << 7)
 
L3GD20_INT1_CFG register bits definitions
#define L3GD20_INT1_CFG_MASK   0xFF
 
#define L3GD20_INT1_CFG_XLIE   (1 << 0)
 
#define L3GD20_INT1_CFG_XHIE   (1 << 1)
 
#define L3GD20_INT1_CFG_YLIE   (1 << 2)
 
#define L3GD20_INT1_CFG_YHIE   (1 << 3)
 
#define L3GD20_INT1_CFG_ZLIE   (1 << 4)
 
#define L3GD20_INT1_CFG_ZHIE   (1 << 5)
 
#define L3GD20_INT1_CFG_LIR   (1 << 6)
 
#define L3GD20_INT1_CFG_AND_OR   (1 << 7)
 
L3GD20_INT1_SRC register bits definitions
#define L3GD20_INT1_SRC_MASK   0x7F
 
#define L3GD20_INT1_SRC_XL   (1 << 0)
 
#define L3GD20_INT1_SRC_XH   (1 << 1)
 
#define L3GD20_INT1_SRC_YL   (1 << 2)
 
#define L3GD20_INT1_SRC_YH   (1 << 3)
 
#define L3GD20_INT1_SRC_ZL   (1 << 4)
 
#define L3GD20_INT1_SRC_ZH   (1 << 5)
 
#define L3GD20_INT1_SRC_IA   (1 << 6)
 
Configuration options
#define L3GD20_USE_SPI   TRUE
 L3GD20 SPI interface switch. More...
 
#define L3GD20_SHARED_SPI   FALSE
 L3GD20 shared SPI switch. More...
 
#define L3GD20_USE_I2C   FALSE
 L3GD20 I2C interface switch. More...
 
#define L3GD20_SHARED_I2C   FALSE
 L3GD20 shared I2C switch. More...
 
#define L3GD20_USE_ADVANCED   FALSE
 L3GD20 advanced configurations switch. More...
 
#define L3GD20_BIAS_ACQ_TIMES   50
 Number of acquisitions for bias removal. More...
 
#define L3GD20_BIAS_SETTLING_US   5000
 Settling time for bias removal. More...
 

Functions

void l3gd20ObjectInit (L3GD20Driver *devp)
 Initializes an instance. More...
 
void l3gd20Start (L3GD20Driver *devp, const L3GD20Config *config)
 Configures and activates L3GD20 Complex Driver peripheral. More...
 
void l3gd20Stop (L3GD20Driver *devp)
 Deactivates the L3GD20 Complex Driver peripheral. More...
 

L3GD20 data structures and types.

Todo:
Add support for L3GD20 over I2C.
#define _l3gd20_methods_alone
 L3GD20 specific methods. More...
 
#define _l3gd20_methods
 L3GD20 specific methods with inherited ones. More...
 
#define _l3gd20_data
 L3GD20Driver specific data. More...
 
typedef struct L3GD20Driver L3GD20Driver
 Structure representing a L3GD20 driver. More...
 

Detailed Description

L3GD20 MEMS interface module header.

Definition in file l3gd20.h.