Senior Design: Sound Monitor / BSP

BSP Drivers

Dependencies:   CMSIS_STM32L4xx CMSIS_DSP_401 STM32L4xx_HAL_Driver

Dependents:   DiscoAudioRecord

Disco/stm32l476g_discovery_idd.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 stm32l476g_discovery_idd.h
EricLew 0:ad9dfc0179dc 4 * @author MCD Application Team
EricLew 0:ad9dfc0179dc 5 * @version V1.0.1
EricLew 0:ad9dfc0179dc 6 * @date 16-September-2015
EricLew 0:ad9dfc0179dc 7 * @brief Header file for stm32l476g_discovery_idd.c module.
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 __STM32L476G_DISCOVERY_IDD_H
EricLew 0:ad9dfc0179dc 40 #define __STM32L476G_DISCOVERY_IDD_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 "stm32l476g_discovery.h"
EricLew 0:ad9dfc0179dc 48 /* Include Idd measurement component driver */
EricLew 0:ad9dfc0179dc 49 #include "../Components/mfxstm32l152/mfxstm32l152.h"
EricLew 0:ad9dfc0179dc 50
EricLew 0:ad9dfc0179dc 51 /** @addtogroup BSP
EricLew 0:ad9dfc0179dc 52 * @{
EricLew 0:ad9dfc0179dc 53 */
EricLew 0:ad9dfc0179dc 54
EricLew 0:ad9dfc0179dc 55 /** @addtogroup STM32L476G_DISCOVERY
EricLew 0:ad9dfc0179dc 56 * @{
EricLew 0:ad9dfc0179dc 57 */
EricLew 0:ad9dfc0179dc 58
EricLew 0:ad9dfc0179dc 59 /** @addtogroup STM32L476G_DISCOVERY_IDD
EricLew 0:ad9dfc0179dc 60 * @{
EricLew 0:ad9dfc0179dc 61 */
EricLew 0:ad9dfc0179dc 62
EricLew 0:ad9dfc0179dc 63 /** @defgroup STM32L476G_DISCOVERY_IDD_Exported_Types Exported Types
EricLew 0:ad9dfc0179dc 64 * @{
EricLew 0:ad9dfc0179dc 65 */
EricLew 0:ad9dfc0179dc 66
EricLew 0:ad9dfc0179dc 67 /** @defgroup IDD_Config IDD Config
EricLew 0:ad9dfc0179dc 68 * @{
EricLew 0:ad9dfc0179dc 69 */
EricLew 0:ad9dfc0179dc 70 typedef enum
EricLew 0:ad9dfc0179dc 71 {
EricLew 0:ad9dfc0179dc 72 IDD_OK = 0,
EricLew 0:ad9dfc0179dc 73 IDD_TIMEOUT = 1,
EricLew 0:ad9dfc0179dc 74 IDD_ZERO_VALUE = 2,
EricLew 0:ad9dfc0179dc 75 IDD_ERROR = 0xFF
EricLew 0:ad9dfc0179dc 76 }
EricLew 0:ad9dfc0179dc 77 IDD_StatusTypeDef;
EricLew 0:ad9dfc0179dc 78 /**
EricLew 0:ad9dfc0179dc 79 * @}
EricLew 0:ad9dfc0179dc 80 */
EricLew 0:ad9dfc0179dc 81
EricLew 0:ad9dfc0179dc 82 /**
EricLew 0:ad9dfc0179dc 83 * @}
EricLew 0:ad9dfc0179dc 84 */
EricLew 0:ad9dfc0179dc 85
EricLew 0:ad9dfc0179dc 86 /** @defgroup STM32L476G_DISCOVERY_IDD_Exported_Defines Exported Defines
EricLew 0:ad9dfc0179dc 87 * @{
EricLew 0:ad9dfc0179dc 88 */
EricLew 0:ad9dfc0179dc 89 /**
EricLew 0:ad9dfc0179dc 90 * @brief Shunt values on discovery in milli ohms
EricLew 0:ad9dfc0179dc 91 */
EricLew 0:ad9dfc0179dc 92 #define DISCOVERY_IDD_SHUNT0_VALUE ((uint16_t) 1000) /*!< value in milliohm */
EricLew 0:ad9dfc0179dc 93 #define DISCOVERY_IDD_SHUNT1_VALUE ((uint16_t) 24) /*!< value in ohm */
EricLew 0:ad9dfc0179dc 94 #define DISCOVERY_IDD_SHUNT2_VALUE ((uint16_t) 620) /*!< value in ohm */
EricLew 0:ad9dfc0179dc 95 #define DISCOVERY_IDD_SHUNT4_VALUE ((uint16_t) 10000) /*!< value in ohm */
EricLew 0:ad9dfc0179dc 96
EricLew 0:ad9dfc0179dc 97 /**
EricLew 0:ad9dfc0179dc 98 * @brief Shunt stabilization delay on discovery in milli ohms
EricLew 0:ad9dfc0179dc 99 */
EricLew 0:ad9dfc0179dc 100 #define DISCOVERY_IDD_SHUNT0_STABDELAY ((uint8_t) 149) /*!< value in millisec */
EricLew 0:ad9dfc0179dc 101 #define DISCOVERY_IDD_SHUNT1_STABDELAY ((uint8_t) 149) /*!< value in millisec */
EricLew 0:ad9dfc0179dc 102 #define DISCOVERY_IDD_SHUNT2_STABDELAY ((uint8_t) 149) /*!< value in millisec */
EricLew 0:ad9dfc0179dc 103 #define DISCOVERY_IDD_SHUNT4_STABDELAY ((uint8_t) 255) /*!< value in millisec */
EricLew 0:ad9dfc0179dc 104
EricLew 0:ad9dfc0179dc 105 /**
EricLew 0:ad9dfc0179dc 106 * @brief IDD Ampli Gain on discovery
EricLew 0:ad9dfc0179dc 107 */
EricLew 0:ad9dfc0179dc 108 #if defined(USE_STM32L476G_DISCO_REVC)
EricLew 0:ad9dfc0179dc 109 #define DISCOVERY_IDD_AMPLI_GAIN ((uint16_t) 4967) /*!< value is gain * 100 */
EricLew 0:ad9dfc0179dc 110 #else
EricLew 0:ad9dfc0179dc 111 #define DISCOVERY_IDD_AMPLI_GAIN ((uint16_t) 4990) /*!< value is gain * 100 */
EricLew 0:ad9dfc0179dc 112 #endif
EricLew 0:ad9dfc0179dc 113
EricLew 0:ad9dfc0179dc 114 /**
EricLew 0:ad9dfc0179dc 115 * @brief IDD Vdd Min on discovery
EricLew 0:ad9dfc0179dc 116 */
EricLew 0:ad9dfc0179dc 117 #define DISCOVERY_IDD_VDD_MIN ((uint16_t) 2000) /*!< value in millivolt */
EricLew 0:ad9dfc0179dc 118
EricLew 0:ad9dfc0179dc 119 /**
EricLew 0:ad9dfc0179dc 120 * @}
EricLew 0:ad9dfc0179dc 121 */
EricLew 0:ad9dfc0179dc 122
EricLew 0:ad9dfc0179dc 123 /* Exported functions --------------------------------------------------------*/
EricLew 0:ad9dfc0179dc 124 /** @defgroup STM32L476G_DISCOVERY_IDD_Exported_Functions Exported Functions
EricLew 0:ad9dfc0179dc 125 * @{
EricLew 0:ad9dfc0179dc 126 */
EricLew 0:ad9dfc0179dc 127 uint8_t BSP_IDD_Init(void);
EricLew 0:ad9dfc0179dc 128 void BSP_IDD_DeInit(void);
EricLew 0:ad9dfc0179dc 129 void BSP_IDD_Reset(void);
EricLew 0:ad9dfc0179dc 130 void BSP_IDD_LowPower(void);
EricLew 0:ad9dfc0179dc 131 void BSP_IDD_WakeUp(void);
EricLew 0:ad9dfc0179dc 132 void BSP_IDD_StartMeasure(void);
EricLew 0:ad9dfc0179dc 133 void BSP_IDD_Config(IDD_ConfigTypeDef IddConfig);
EricLew 0:ad9dfc0179dc 134 void BSP_IDD_GetValue(uint32_t *IddValue);
EricLew 0:ad9dfc0179dc 135 void BSP_IDD_EnableIT(void);
EricLew 0:ad9dfc0179dc 136 void BSP_IDD_ClearIT(void);
EricLew 0:ad9dfc0179dc 137 uint8_t BSP_IDD_GetITStatus(void);
EricLew 0:ad9dfc0179dc 138 void BSP_IDD_DisableIT(void);
EricLew 0:ad9dfc0179dc 139 uint8_t BSP_IDD_ErrorGetCode(void);
EricLew 0:ad9dfc0179dc 140 void BSP_IDD_ErrorEnableIT(void);
EricLew 0:ad9dfc0179dc 141 void BSP_IDD_ErrorClearIT(void);
EricLew 0:ad9dfc0179dc 142 uint8_t BSP_IDD_ErrorGetITStatus(void);
EricLew 0:ad9dfc0179dc 143 void BSP_IDD_ErrorDisableIT(void);
EricLew 0:ad9dfc0179dc 144
EricLew 0:ad9dfc0179dc 145 /**
EricLew 0:ad9dfc0179dc 146 * @}
EricLew 0:ad9dfc0179dc 147 */
EricLew 0:ad9dfc0179dc 148
EricLew 0:ad9dfc0179dc 149 /**
EricLew 0:ad9dfc0179dc 150 * @}
EricLew 0:ad9dfc0179dc 151 */
EricLew 0:ad9dfc0179dc 152
EricLew 0:ad9dfc0179dc 153 /**
EricLew 0:ad9dfc0179dc 154 * @}
EricLew 0:ad9dfc0179dc 155 */
EricLew 0:ad9dfc0179dc 156
EricLew 0:ad9dfc0179dc 157 /**
EricLew 0:ad9dfc0179dc 158 * @}
EricLew 0:ad9dfc0179dc 159 */
EricLew 0:ad9dfc0179dc 160
EricLew 0:ad9dfc0179dc 161 #ifdef __cplusplus
EricLew 0:ad9dfc0179dc 162 }
EricLew 0:ad9dfc0179dc 163 #endif
EricLew 0:ad9dfc0179dc 164
EricLew 0:ad9dfc0179dc 165 #endif /* __STM32L476G_DISCOVERY_IDD_H */
EricLew 0:ad9dfc0179dc 166
EricLew 0:ad9dfc0179dc 167 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
EricLew 0:ad9dfc0179dc 168