Ngo Kien / BSP_DISCO_F746NG

Clone

Dependents:   SignalProcessLab DigitalSignalAlgorithm_Lab DigitalSignal_Lab

Drivers/BSP/Components/Common/gyro.h@0:fc80425b677a, 2019-08-26 (annotated)

Committer:
ngtkien
Date:
Mon Aug 26 16:33:09 2019 +0000
Revision:
0:fc80425b677a
Library

Who changed what in which revision?

UserRevisionLine numberNew contents of line
ngtkien 0:fc80425b677a 1 /**
ngtkien 0:fc80425b677a 2 ******************************************************************************
ngtkien 0:fc80425b677a 3 * @file gyro.h
ngtkien 0:fc80425b677a 4 * @author MCD Application Team
ngtkien 0:fc80425b677a 5 * @version V4.0.1
ngtkien 0:fc80425b677a 6 * @date 21-July-2015
ngtkien 0:fc80425b677a 7 * @brief This header file contains the functions prototypes for the gyroscope driver.
ngtkien 0:fc80425b677a 8 ******************************************************************************
ngtkien 0:fc80425b677a 9 * @attention
ngtkien 0:fc80425b677a 10 *
ngtkien 0:fc80425b677a 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
ngtkien 0:fc80425b677a 12 *
ngtkien 0:fc80425b677a 13 * Redistribution and use in source and binary forms, with or without modification,
ngtkien 0:fc80425b677a 14 * are permitted provided that the following conditions are met:
ngtkien 0:fc80425b677a 15 * 1. Redistributions of source code must retain the above copyright notice,
ngtkien 0:fc80425b677a 16 * this list of conditions and the following disclaimer.
ngtkien 0:fc80425b677a 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
ngtkien 0:fc80425b677a 18 * this list of conditions and the following disclaimer in the documentation
ngtkien 0:fc80425b677a 19 * and/or other materials provided with the distribution.
ngtkien 0:fc80425b677a 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
ngtkien 0:fc80425b677a 21 * may be used to endorse or promote products derived from this software
ngtkien 0:fc80425b677a 22 * without specific prior written permission.
ngtkien 0:fc80425b677a 23 *
ngtkien 0:fc80425b677a 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
ngtkien 0:fc80425b677a 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
ngtkien 0:fc80425b677a 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
ngtkien 0:fc80425b677a 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
ngtkien 0:fc80425b677a 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
ngtkien 0:fc80425b677a 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
ngtkien 0:fc80425b677a 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
ngtkien 0:fc80425b677a 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
ngtkien 0:fc80425b677a 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
ngtkien 0:fc80425b677a 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
ngtkien 0:fc80425b677a 34 *
ngtkien 0:fc80425b677a 35 ******************************************************************************
ngtkien 0:fc80425b677a 36 */
ngtkien 0:fc80425b677a 37
ngtkien 0:fc80425b677a 38
ngtkien 0:fc80425b677a 39 /* Define to prevent recursive inclusion -------------------------------------*/
ngtkien 0:fc80425b677a 40 #ifndef __GYRO_H
ngtkien 0:fc80425b677a 41 #define __GYRO_H
ngtkien 0:fc80425b677a 42
ngtkien 0:fc80425b677a 43 #ifdef __cplusplus
ngtkien 0:fc80425b677a 44 extern "C" {
ngtkien 0:fc80425b677a 45 #endif
ngtkien 0:fc80425b677a 46
ngtkien 0:fc80425b677a 47 /* Includes ------------------------------------------------------------------*/
ngtkien 0:fc80425b677a 48 #include <stdint.h>
ngtkien 0:fc80425b677a 49
ngtkien 0:fc80425b677a 50 /** @addtogroup BSP
ngtkien 0:fc80425b677a 51 * @{
ngtkien 0:fc80425b677a 52 */
ngtkien 0:fc80425b677a 53
ngtkien 0:fc80425b677a 54 /** @addtogroup Components
ngtkien 0:fc80425b677a 55 * @{
ngtkien 0:fc80425b677a 56 */
ngtkien 0:fc80425b677a 57
ngtkien 0:fc80425b677a 58 /** @addtogroup GYRO
ngtkien 0:fc80425b677a 59 * @{
ngtkien 0:fc80425b677a 60 */
ngtkien 0:fc80425b677a 61
ngtkien 0:fc80425b677a 62 /** @defgroup GYRO_Exported_Types
ngtkien 0:fc80425b677a 63 * @{
ngtkien 0:fc80425b677a 64 */
ngtkien 0:fc80425b677a 65
ngtkien 0:fc80425b677a 66 /** @defgroup GYRO_Driver_structure Gyroscope Driver structure
ngtkien 0:fc80425b677a 67 * @{
ngtkien 0:fc80425b677a 68 */
ngtkien 0:fc80425b677a 69 typedef struct
ngtkien 0:fc80425b677a 70 {
ngtkien 0:fc80425b677a 71 void (*Init)(uint16_t);
ngtkien 0:fc80425b677a 72 void (*DeInit)(void);
ngtkien 0:fc80425b677a 73 uint8_t (*ReadID)(void);
ngtkien 0:fc80425b677a 74 void (*Reset)(void);
ngtkien 0:fc80425b677a 75 void (*LowPower)(uint16_t);
ngtkien 0:fc80425b677a 76 void (*ConfigIT)(uint16_t);
ngtkien 0:fc80425b677a 77 void (*EnableIT)(uint8_t);
ngtkien 0:fc80425b677a 78 void (*DisableIT)(uint8_t);
ngtkien 0:fc80425b677a 79 uint8_t (*ITStatus)(uint16_t, uint16_t);
ngtkien 0:fc80425b677a 80 void (*ClearIT)(uint16_t, uint16_t);
ngtkien 0:fc80425b677a 81 void (*FilterConfig)(uint8_t);
ngtkien 0:fc80425b677a 82 void (*FilterCmd)(uint8_t);
ngtkien 0:fc80425b677a 83 void (*GetXYZ)(float *);
ngtkien 0:fc80425b677a 84 }GYRO_DrvTypeDef;
ngtkien 0:fc80425b677a 85 /**
ngtkien 0:fc80425b677a 86 * @}
ngtkien 0:fc80425b677a 87 */
ngtkien 0:fc80425b677a 88
ngtkien 0:fc80425b677a 89 /** @defgroup GYRO_Config_structure Gyroscope Configuration structure
ngtkien 0:fc80425b677a 90 * @{
ngtkien 0:fc80425b677a 91 */
ngtkien 0:fc80425b677a 92
ngtkien 0:fc80425b677a 93 typedef struct
ngtkien 0:fc80425b677a 94 {
ngtkien 0:fc80425b677a 95 uint8_t Power_Mode; /* Power-down/Sleep/Normal Mode */
ngtkien 0:fc80425b677a 96 uint8_t Output_DataRate; /* OUT data rate */
ngtkien 0:fc80425b677a 97 uint8_t Axes_Enable; /* Axes enable */
ngtkien 0:fc80425b677a 98 uint8_t Band_Width; /* Bandwidth selection */
ngtkien 0:fc80425b677a 99 uint8_t BlockData_Update; /* Block Data Update */
ngtkien 0:fc80425b677a 100 uint8_t Endianness; /* Endian Data selection */
ngtkien 0:fc80425b677a 101 uint8_t Full_Scale; /* Full Scale selection */
ngtkien 0:fc80425b677a 102 }GYRO_InitTypeDef;
ngtkien 0:fc80425b677a 103
ngtkien 0:fc80425b677a 104 /* GYRO High Pass Filter struct */
ngtkien 0:fc80425b677a 105 typedef struct
ngtkien 0:fc80425b677a 106 {
ngtkien 0:fc80425b677a 107 uint8_t HighPassFilter_Mode_Selection; /* Internal filter mode */
ngtkien 0:fc80425b677a 108 uint8_t HighPassFilter_CutOff_Frequency; /* High pass filter cut-off frequency */
ngtkien 0:fc80425b677a 109 }GYRO_FilterConfigTypeDef;
ngtkien 0:fc80425b677a 110
ngtkien 0:fc80425b677a 111 /*GYRO Interrupt struct */
ngtkien 0:fc80425b677a 112 typedef struct
ngtkien 0:fc80425b677a 113 {
ngtkien 0:fc80425b677a 114 uint8_t Latch_Request; /* Latch interrupt request into CLICK_SRC register */
ngtkien 0:fc80425b677a 115 uint8_t Interrupt_Axes; /* X, Y, Z Axes Interrupts */
ngtkien 0:fc80425b677a 116 uint8_t Interrupt_ActiveEdge; /* Interrupt Active edge */
ngtkien 0:fc80425b677a 117 }GYRO_InterruptConfigTypeDef;
ngtkien 0:fc80425b677a 118
ngtkien 0:fc80425b677a 119 /**
ngtkien 0:fc80425b677a 120 * @}
ngtkien 0:fc80425b677a 121 */
ngtkien 0:fc80425b677a 122
ngtkien 0:fc80425b677a 123 /**
ngtkien 0:fc80425b677a 124 * @}
ngtkien 0:fc80425b677a 125 */
ngtkien 0:fc80425b677a 126
ngtkien 0:fc80425b677a 127 /**
ngtkien 0:fc80425b677a 128 * @}
ngtkien 0:fc80425b677a 129 */
ngtkien 0:fc80425b677a 130
ngtkien 0:fc80425b677a 131 /**
ngtkien 0:fc80425b677a 132 * @}
ngtkien 0:fc80425b677a 133 */
ngtkien 0:fc80425b677a 134
ngtkien 0:fc80425b677a 135 /**
ngtkien 0:fc80425b677a 136 * @}
ngtkien 0:fc80425b677a 137 */
ngtkien 0:fc80425b677a 138
ngtkien 0:fc80425b677a 139 #ifdef __cplusplus
ngtkien 0:fc80425b677a 140 }
ngtkien 0:fc80425b677a 141 #endif
ngtkien 0:fc80425b677a 142
ngtkien 0:fc80425b677a 143 #endif /* __GYRO_H */
ngtkien 0:fc80425b677a 144
ngtkien 0:fc80425b677a 145 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/