Senior Design: Sound Monitor / BSP

BSP Drivers

Dependencies:   CMSIS_STM32L4xx CMSIS_DSP_401 STM32L4xx_HAL_Driver

Dependents:   DiscoAudioRecord

Components/Common/magneto.h@0:ad9dfc0179dc, 2015-11-02 (annotated)

Committer:
EricLew
Date:
Mon Nov 02 19:38:36 2015 +0000
Revision:
0:ad9dfc0179dc
commit

Who changed what in which revision?

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