ST / BSP_DISCO_F413ZH

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.

Dependents:   DISCO_F413ZH-LCD-demo DISCO_F413ZH-touch-screen-demo DISCO_F413ZH-SD-demo DISCO_F413ZH-PSRAM-demo ... more

Drivers/BSP/Components/Common/magneto.h@3:42b354f5069c, 2018-02-28 (annotated)

Committer:
Jerome Coutant
Date:
Wed Feb 28 14:35:04 2018 +0100
Revision:
3:42b354f5069c
Parent:
0:4af3ca173992 
STM32Cube_FW_F4_V1.19.0 BSP_DISCO_F413ZH

Who changed what in which revision?

UserRevisionLine numberNew contents of line
arostm 0:4af3ca173992 1 /**
arostm 0:4af3ca173992 2 ******************************************************************************
arostm 0:4af3ca173992 3 * @file magneto.h
arostm 0:4af3ca173992 4 * @author MCD Application Team
arostm 0:4af3ca173992 5 * @version V4.0.1
arostm 0:4af3ca173992 6 * @date 21-July-2015
arostm 0:4af3ca173992 7 * @brief This header file contains the functions prototypes for the MAGNETO driver.
arostm 0:4af3ca173992 8 ******************************************************************************
arostm 0:4af3ca173992 9 * @attention
arostm 0:4af3ca173992 10 *
arostm 0:4af3ca173992 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
arostm 0:4af3ca173992 12 *
arostm 0:4af3ca173992 13 * Redistribution and use in source and binary forms, with or without modification,
arostm 0:4af3ca173992 14 * are permitted provided that the following conditions are met:
arostm 0:4af3ca173992 15 * 1. Redistributions of source code must retain the above copyright notice,
arostm 0:4af3ca173992 16 * this list of conditions and the following disclaimer.
arostm 0:4af3ca173992 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
arostm 0:4af3ca173992 18 * this list of conditions and the following disclaimer in the documentation
arostm 0:4af3ca173992 19 * and/or other materials provided with the distribution.
arostm 0:4af3ca173992 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
arostm 0:4af3ca173992 21 * may be used to endorse or promote products derived from this software
arostm 0:4af3ca173992 22 * without specific prior written permission.
arostm 0:4af3ca173992 23 *
arostm 0:4af3ca173992 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
arostm 0:4af3ca173992 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
arostm 0:4af3ca173992 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
arostm 0:4af3ca173992 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
arostm 0:4af3ca173992 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
arostm 0:4af3ca173992 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
arostm 0:4af3ca173992 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
arostm 0:4af3ca173992 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
arostm 0:4af3ca173992 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
arostm 0:4af3ca173992 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
arostm 0:4af3ca173992 34 *
arostm 0:4af3ca173992 35 ******************************************************************************
arostm 0:4af3ca173992 36 */
arostm 0:4af3ca173992 37
arostm 0:4af3ca173992 38 /* Define to prevent recursive inclusion -------------------------------------*/
arostm 0:4af3ca173992 39 #ifndef __MAGNETO_H
arostm 0:4af3ca173992 40 #define __MAGNETO_H
arostm 0:4af3ca173992 41
arostm 0:4af3ca173992 42 #ifdef __cplusplus
arostm 0:4af3ca173992 43 extern "C" {
arostm 0:4af3ca173992 44 #endif
arostm 0:4af3ca173992 45
arostm 0:4af3ca173992 46 /* Includes ------------------------------------------------------------------*/
arostm 0:4af3ca173992 47 #include <stdint.h>
arostm 0:4af3ca173992 48
arostm 0:4af3ca173992 49 /** @addtogroup BSP
arostm 0:4af3ca173992 50 * @{
arostm 0:4af3ca173992 51 */
arostm 0:4af3ca173992 52
arostm 0:4af3ca173992 53 /** @addtogroup Components
arostm 0:4af3ca173992 54 * @{
arostm 0:4af3ca173992 55 */
arostm 0:4af3ca173992 56
arostm 0:4af3ca173992 57 /** @addtogroup MAGNETO
arostm 0:4af3ca173992 58 * @{
arostm 0:4af3ca173992 59 */
arostm 0:4af3ca173992 60
arostm 0:4af3ca173992 61 /** @defgroup MAGNETO_Exported_Types
arostm 0:4af3ca173992 62 * @{
arostm 0:4af3ca173992 63 */
arostm 0:4af3ca173992 64
arostm 0:4af3ca173992 65 /** @defgroup MAGNETO_Config_structure Magnetometer Configuration structure
arostm 0:4af3ca173992 66 * @{
arostm 0:4af3ca173992 67 */
arostm 0:4af3ca173992 68 typedef struct
arostm 0:4af3ca173992 69 {
arostm 0:4af3ca173992 70 uint8_t Register1;
arostm 0:4af3ca173992 71 uint8_t Register2;
arostm 0:4af3ca173992 72 uint8_t Register3;
arostm 0:4af3ca173992 73 uint8_t Register4;
arostm 0:4af3ca173992 74 uint8_t Register5;
arostm 0:4af3ca173992 75 }MAGNETO_InitTypeDef;
arostm 0:4af3ca173992 76 /**
arostm 0:4af3ca173992 77 * @}
arostm 0:4af3ca173992 78 */
arostm 0:4af3ca173992 79
arostm 0:4af3ca173992 80 /** @defgroup MAGNETO_Driver_structure Magnetometer Driver structure
arostm 0:4af3ca173992 81 * @{
arostm 0:4af3ca173992 82 */
arostm 0:4af3ca173992 83 typedef struct
arostm 0:4af3ca173992 84 {
arostm 0:4af3ca173992 85 void (*Init)(MAGNETO_InitTypeDef);
arostm 0:4af3ca173992 86 void (*DeInit)(void);
arostm 0:4af3ca173992 87 uint8_t (*ReadID)(void);
arostm 0:4af3ca173992 88 void (*Reset)(void);
arostm 0:4af3ca173992 89 void (*LowPower)(void);
arostm 0:4af3ca173992 90 void (*ConfigIT)(void);
arostm 0:4af3ca173992 91 void (*EnableIT)(uint8_t);
arostm 0:4af3ca173992 92 void (*DisableIT)(uint8_t);
arostm 0:4af3ca173992 93 uint8_t (*ITStatus)(uint16_t);
arostm 0:4af3ca173992 94 void (*ClearIT)(void);
arostm 0:4af3ca173992 95 void (*FilterConfig)(uint8_t);
arostm 0:4af3ca173992 96 void (*FilterCmd)(uint8_t);
arostm 0:4af3ca173992 97 void (*GetXYZ)(int16_t *);
arostm 0:4af3ca173992 98 }MAGNETO_DrvTypeDef;
arostm 0:4af3ca173992 99 /**
arostm 0:4af3ca173992 100 * @}
arostm 0:4af3ca173992 101 */
arostm 0:4af3ca173992 102
arostm 0:4af3ca173992 103 /**
arostm 0:4af3ca173992 104 * @}
arostm 0:4af3ca173992 105 */
arostm 0:4af3ca173992 106
arostm 0:4af3ca173992 107 /**
arostm 0:4af3ca173992 108 * @}
arostm 0:4af3ca173992 109 */
arostm 0:4af3ca173992 110
arostm 0:4af3ca173992 111 /**
arostm 0:4af3ca173992 112 * @}
arostm 0:4af3ca173992 113 */
arostm 0:4af3ca173992 114
arostm 0:4af3ca173992 115 /**
arostm 0:4af3ca173992 116 * @}
arostm 0:4af3ca173992 117 */
arostm 0:4af3ca173992 118
arostm 0:4af3ca173992 119 #ifdef __cplusplus
arostm 0:4af3ca173992 120 }
arostm 0:4af3ca173992 121 #endif
arostm 0:4af3ca173992 122
arostm 0:4af3ca173992 123 #endif /* __MAGNETO_H */
arostm 0:4af3ca173992 124
arostm 0:4af3ca173992 125 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/