Ngo Kien / BSP_DISCO_F746NG

Clone

Dependents:   SignalProcessLab DigitalSignalAlgorithm_Lab DigitalSignal_Lab

Drivers/BSP/Components/Common/magneto.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 magneto.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 MAGNETO 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 /* Define to prevent recursive inclusion -------------------------------------*/
ngtkien 0:fc80425b677a 39 #ifndef __MAGNETO_H
ngtkien 0:fc80425b677a 40 #define __MAGNETO_H
ngtkien 0:fc80425b677a 41
ngtkien 0:fc80425b677a 42 #ifdef __cplusplus
ngtkien 0:fc80425b677a 43 extern "C" {
ngtkien 0:fc80425b677a 44 #endif
ngtkien 0:fc80425b677a 45
ngtkien 0:fc80425b677a 46 /* Includes ------------------------------------------------------------------*/
ngtkien 0:fc80425b677a 47 #include <stdint.h>
ngtkien 0:fc80425b677a 48
ngtkien 0:fc80425b677a 49 /** @addtogroup BSP
ngtkien 0:fc80425b677a 50 * @{
ngtkien 0:fc80425b677a 51 */
ngtkien 0:fc80425b677a 52
ngtkien 0:fc80425b677a 53 /** @addtogroup Components
ngtkien 0:fc80425b677a 54 * @{
ngtkien 0:fc80425b677a 55 */
ngtkien 0:fc80425b677a 56
ngtkien 0:fc80425b677a 57 /** @addtogroup MAGNETO
ngtkien 0:fc80425b677a 58 * @{
ngtkien 0:fc80425b677a 59 */
ngtkien 0:fc80425b677a 60
ngtkien 0:fc80425b677a 61 /** @defgroup MAGNETO_Exported_Types
ngtkien 0:fc80425b677a 62 * @{
ngtkien 0:fc80425b677a 63 */
ngtkien 0:fc80425b677a 64
ngtkien 0:fc80425b677a 65 /** @defgroup MAGNETO_Config_structure Magnetometer Configuration structure
ngtkien 0:fc80425b677a 66 * @{
ngtkien 0:fc80425b677a 67 */
ngtkien 0:fc80425b677a 68 typedef struct
ngtkien 0:fc80425b677a 69 {
ngtkien 0:fc80425b677a 70 uint8_t Register1;
ngtkien 0:fc80425b677a 71 uint8_t Register2;
ngtkien 0:fc80425b677a 72 uint8_t Register3;
ngtkien 0:fc80425b677a 73 uint8_t Register4;
ngtkien 0:fc80425b677a 74 uint8_t Register5;
ngtkien 0:fc80425b677a 75 }MAGNETO_InitTypeDef;
ngtkien 0:fc80425b677a 76 /**
ngtkien 0:fc80425b677a 77 * @}
ngtkien 0:fc80425b677a 78 */
ngtkien 0:fc80425b677a 79
ngtkien 0:fc80425b677a 80 /** @defgroup MAGNETO_Driver_structure Magnetometer Driver structure
ngtkien 0:fc80425b677a 81 * @{
ngtkien 0:fc80425b677a 82 */
ngtkien 0:fc80425b677a 83 typedef struct
ngtkien 0:fc80425b677a 84 {
ngtkien 0:fc80425b677a 85 void (*Init)(MAGNETO_InitTypeDef);
ngtkien 0:fc80425b677a 86 void (*DeInit)(void);
ngtkien 0:fc80425b677a 87 uint8_t (*ReadID)(void);
ngtkien 0:fc80425b677a 88 void (*Reset)(void);
ngtkien 0:fc80425b677a 89 void (*LowPower)(void);
ngtkien 0:fc80425b677a 90 void (*ConfigIT)(void);
ngtkien 0:fc80425b677a 91 void (*EnableIT)(uint8_t);
ngtkien 0:fc80425b677a 92 void (*DisableIT)(uint8_t);
ngtkien 0:fc80425b677a 93 uint8_t (*ITStatus)(uint16_t);
ngtkien 0:fc80425b677a 94 void (*ClearIT)(void);
ngtkien 0:fc80425b677a 95 void (*FilterConfig)(uint8_t);
ngtkien 0:fc80425b677a 96 void (*FilterCmd)(uint8_t);
ngtkien 0:fc80425b677a 97 void (*GetXYZ)(int16_t *);
ngtkien 0:fc80425b677a 98 }MAGNETO_DrvTypeDef;
ngtkien 0:fc80425b677a 99 /**
ngtkien 0:fc80425b677a 100 * @}
ngtkien 0:fc80425b677a 101 */
ngtkien 0:fc80425b677a 102
ngtkien 0:fc80425b677a 103 /**
ngtkien 0:fc80425b677a 104 * @}
ngtkien 0:fc80425b677a 105 */
ngtkien 0:fc80425b677a 106
ngtkien 0:fc80425b677a 107 /**
ngtkien 0:fc80425b677a 108 * @}
ngtkien 0:fc80425b677a 109 */
ngtkien 0:fc80425b677a 110
ngtkien 0:fc80425b677a 111 /**
ngtkien 0:fc80425b677a 112 * @}
ngtkien 0:fc80425b677a 113 */
ngtkien 0:fc80425b677a 114
ngtkien 0:fc80425b677a 115 /**
ngtkien 0:fc80425b677a 116 * @}
ngtkien 0:fc80425b677a 117 */
ngtkien 0:fc80425b677a 118
ngtkien 0:fc80425b677a 119 #ifdef __cplusplus
ngtkien 0:fc80425b677a 120 }
ngtkien 0:fc80425b677a 121 #endif
ngtkien 0:fc80425b677a 122
ngtkien 0:fc80425b677a 123 #endif /* __MAGNETO_H */
ngtkien 0:fc80425b677a 124
ngtkien 0:fc80425b677a 125 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/