E&R S3 prime / BSP_DISCO_L476VG

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Drivers/BSP/Components/Common/gyro.h@3:4c7d003a8259, 2018-01-17 (annotated)

Committer:
bcostm
Date:
Wed Jan 17 14:57:52 2018 +0100
Revision:
3:4c7d003a8259
Parent:
1:917af0ca86df
Child:
5:4943b15cce9f
Update BSP files with CubeL4 V1.11.0

Who changed what in which revision?

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