TUKS MCU Introductory course / TUKS-COURSE-2-LED

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.

BSP_DISCO_L476VG/magneto.h@1:d0dfbce63a89, 2017-02-24 (annotated)

Committer:
elmot
Date:
Fri Feb 24 21:13:56 2017 +0000
Revision:
1:d0dfbce63a89
Ready-to-copy

Who changed what in which revision?

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