ST / BSP_DISCO_L476VG

STM32L476G-Discovery board drivers V1.0.0

Dependents:   DiscoLogger DISCO_L476VG_GlassLCD DISCO_L476VG_MicrophoneRecorder DISCO_L476VG_UART ... more

Drivers/BSP/Components/Common/idd.h@5:4943b15cce9f, 2019-09-24 (annotated)

Committer:
jeromecoutant
Date:
Tue Sep 24 18:00:58 2019 +0200
Revision:
5:4943b15cce9f
Parent:
3:4c7d003a8259 
Update BSP files with CubeL4 V1.14.0

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Jerome Coutant 1:917af0ca86df 1 /**
Jerome Coutant 1:917af0ca86df 2 ******************************************************************************
Jerome Coutant 1:917af0ca86df 3 * @file idd.h
Jerome Coutant 1:917af0ca86df 4 * @author MCD Application Team
Jerome Coutant 1:917af0ca86df 5 * @brief This file contains all the functions prototypes for the IDD driver.
Jerome Coutant 1:917af0ca86df 6 ******************************************************************************
Jerome Coutant 1:917af0ca86df 7 * @attention
Jerome Coutant 1:917af0ca86df 8 *
jeromecoutant 5:4943b15cce9f 9 * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
jeromecoutant 5:4943b15cce9f 10 * All rights reserved.</center></h2>
Jerome Coutant 1:917af0ca86df 11 *
jeromecoutant 5:4943b15cce9f 12 * This software component is licensed by ST under BSD 3-Clause license,
jeromecoutant 5:4943b15cce9f 13 * the "License"; You may not use this file except in compliance with the
jeromecoutant 5:4943b15cce9f 14 * License. You may obtain a copy of the License at:
jeromecoutant 5:4943b15cce9f 15 * opensource.org/licenses/BSD-3-Clause
Jerome Coutant 1:917af0ca86df 16 *
Jerome Coutant 1:917af0ca86df 17 ******************************************************************************
Jerome Coutant 1:917af0ca86df 18 */
Jerome Coutant 1:917af0ca86df 19
Jerome Coutant 1:917af0ca86df 20 /* Define to prevent recursive inclusion -------------------------------------*/
Jerome Coutant 1:917af0ca86df 21 #ifndef __IDD_H
Jerome Coutant 1:917af0ca86df 22 #define __IDD_H
Jerome Coutant 1:917af0ca86df 23
Jerome Coutant 1:917af0ca86df 24 #ifdef __cplusplus
Jerome Coutant 1:917af0ca86df 25 extern "C" {
Jerome Coutant 1:917af0ca86df 26 #endif
Jerome Coutant 1:917af0ca86df 27
Jerome Coutant 1:917af0ca86df 28 /* Includes ------------------------------------------------------------------*/
Jerome Coutant 1:917af0ca86df 29 #include <stdint.h>
Jerome Coutant 1:917af0ca86df 30
Jerome Coutant 1:917af0ca86df 31 /** @addtogroup BSP
Jerome Coutant 1:917af0ca86df 32 * @{
Jerome Coutant 1:917af0ca86df 33 */
Jerome Coutant 1:917af0ca86df 34
Jerome Coutant 1:917af0ca86df 35 /** @addtogroup Components
Jerome Coutant 1:917af0ca86df 36 * @{
Jerome Coutant 1:917af0ca86df 37 */
Jerome Coutant 1:917af0ca86df 38
Jerome Coutant 1:917af0ca86df 39 /** @addtogroup IDD
Jerome Coutant 1:917af0ca86df 40 * @{
Jerome Coutant 1:917af0ca86df 41 */
Jerome Coutant 1:917af0ca86df 42
Jerome Coutant 1:917af0ca86df 43 /** @defgroup IDD_Exported_Types IDD Exported Types
Jerome Coutant 1:917af0ca86df 44 * @{
Jerome Coutant 1:917af0ca86df 45 */
Jerome Coutant 1:917af0ca86df 46
Jerome Coutant 1:917af0ca86df 47 /** @defgroup IDD_Config_structure IDD Configuration structure
Jerome Coutant 1:917af0ca86df 48 * @{
Jerome Coutant 1:917af0ca86df 49 */
Jerome Coutant 1:917af0ca86df 50 typedef struct
Jerome Coutant 1:917af0ca86df 51 {
Jerome Coutant 1:917af0ca86df 52 uint16_t AmpliGain; /*!< Specifies ampli gain value
Jerome Coutant 1:917af0ca86df 53 */
Jerome Coutant 1:917af0ca86df 54 uint16_t VddMin; /*!< Specifies minimum MCU VDD can reach to protect MCU from reset
Jerome Coutant 1:917af0ca86df 55 */
Jerome Coutant 1:917af0ca86df 56 uint16_t Shunt0Value; /*!< Specifies value of Shunt 0 if existing
Jerome Coutant 1:917af0ca86df 57 */
Jerome Coutant 1:917af0ca86df 58 uint16_t Shunt1Value; /*!< Specifies value of Shunt 1 if existing
Jerome Coutant 1:917af0ca86df 59 */
Jerome Coutant 1:917af0ca86df 60 uint16_t Shunt2Value; /*!< Specifies value of Shunt 2 if existing
Jerome Coutant 1:917af0ca86df 61 */
Jerome Coutant 1:917af0ca86df 62 uint16_t Shunt3Value; /*!< Specifies value of Shunt 3 if existing
Jerome Coutant 1:917af0ca86df 63 */
Jerome Coutant 1:917af0ca86df 64 uint16_t Shunt4Value; /*!< Specifies value of Shunt 4 if existing
Jerome Coutant 1:917af0ca86df 65 */
Jerome Coutant 1:917af0ca86df 66 uint16_t Shunt0StabDelay; /*!< Specifies delay of Shunt 0 stabilization if existing
Jerome Coutant 1:917af0ca86df 67 */
Jerome Coutant 1:917af0ca86df 68 uint16_t Shunt1StabDelay; /*!< Specifies delay of Shunt 1 stabilization if existing
Jerome Coutant 1:917af0ca86df 69 */
Jerome Coutant 1:917af0ca86df 70 uint16_t Shunt2StabDelay; /*!< Specifies delay of Shunt 2 stabilization if existing
Jerome Coutant 1:917af0ca86df 71 */
Jerome Coutant 1:917af0ca86df 72 uint16_t Shunt3StabDelay; /*!< Specifies delay of Shunt 3 stabilization if existing
Jerome Coutant 1:917af0ca86df 73 */
Jerome Coutant 1:917af0ca86df 74 uint16_t Shunt4StabDelay; /*!< Specifies delay of Shunt 4 stabilization if existing
Jerome Coutant 1:917af0ca86df 75 */
Jerome Coutant 1:917af0ca86df 76 uint8_t ShuntNbOnBoard; /*!< Specifies number of shunts that are present on board
Jerome Coutant 1:917af0ca86df 77 This parameter can be a value of @ref IDD_shunt_number */
Jerome Coutant 1:917af0ca86df 78 uint8_t ShuntNbUsed; /*!< Specifies number of shunts used for measurement
Jerome Coutant 1:917af0ca86df 79 This parameter can be a value of @ref IDD_shunt_number */
Jerome Coutant 1:917af0ca86df 80 uint8_t VrefMeasurement; /*!< Specifies if Vref is automatically measured before each Idd measurement
Jerome Coutant 1:917af0ca86df 81 This parameter can be a value of @ref IDD_Vref_Measurement */
Jerome Coutant 1:917af0ca86df 82 uint8_t Calibration; /*!< Specifies if calibration is done before each Idd measurement
Jerome Coutant 1:917af0ca86df 83 */
Jerome Coutant 1:917af0ca86df 84 uint8_t PreDelayUnit; /*!< Specifies Pre delay unit
Jerome Coutant 1:917af0ca86df 85 This parameter can be a value of @ref IDD_PreDelay */
Jerome Coutant 1:917af0ca86df 86 uint8_t PreDelayValue; /*!< Specifies Pre delay value in selected unit
Jerome Coutant 1:917af0ca86df 87 */
Jerome Coutant 1:917af0ca86df 88 uint8_t MeasureNb; /*!< Specifies number of Measure to be performed
Jerome Coutant 1:917af0ca86df 89 This parameter can be a value between 1 and 256 */
Jerome Coutant 1:917af0ca86df 90 uint8_t DeltaDelayUnit; /*!< Specifies Delta delay unit
Jerome Coutant 1:917af0ca86df 91 This parameter can be a value of @ref IDD_DeltaDelay */
Jerome Coutant 1:917af0ca86df 92 uint8_t DeltaDelayValue; /*!< Specifies Delta delay between 2 measures
Jerome Coutant 1:917af0ca86df 93 value can be between 1 and 128 */
Jerome Coutant 1:917af0ca86df 94 }IDD_ConfigTypeDef;
Jerome Coutant 1:917af0ca86df 95 /**
Jerome Coutant 1:917af0ca86df 96 * @}
Jerome Coutant 1:917af0ca86df 97 */
Jerome Coutant 1:917af0ca86df 98
Jerome Coutant 1:917af0ca86df 99 /** @defgroup IDD_Driver_structure IDD Driver structure
Jerome Coutant 1:917af0ca86df 100 * @{
Jerome Coutant 1:917af0ca86df 101 */
Jerome Coutant 1:917af0ca86df 102 typedef struct
Jerome Coutant 1:917af0ca86df 103 {
Jerome Coutant 1:917af0ca86df 104 void (*Init)(uint16_t);
Jerome Coutant 1:917af0ca86df 105 void (*DeInit)(uint16_t);
Jerome Coutant 1:917af0ca86df 106 uint16_t (*ReadID)(uint16_t);
Jerome Coutant 1:917af0ca86df 107 void (*Reset)(uint16_t);
Jerome Coutant 1:917af0ca86df 108 void (*LowPower)(uint16_t);
Jerome Coutant 1:917af0ca86df 109 void (*WakeUp)(uint16_t);
Jerome Coutant 1:917af0ca86df 110 void (*Start)(uint16_t);
Jerome Coutant 1:917af0ca86df 111 void (*Config)(uint16_t,IDD_ConfigTypeDef);
Jerome Coutant 1:917af0ca86df 112 void (*GetValue)(uint16_t, uint32_t *);
Jerome Coutant 1:917af0ca86df 113 void (*EnableIT)(uint16_t);
Jerome Coutant 1:917af0ca86df 114 void (*ClearIT)(uint16_t);
Jerome Coutant 1:917af0ca86df 115 uint8_t (*GetITStatus)(uint16_t);
Jerome Coutant 1:917af0ca86df 116 void (*DisableIT)(uint16_t);
Jerome Coutant 1:917af0ca86df 117 void (*ErrorEnableIT)(uint16_t);
Jerome Coutant 1:917af0ca86df 118 void (*ErrorClearIT)(uint16_t);
Jerome Coutant 1:917af0ca86df 119 uint8_t (*ErrorGetITStatus)(uint16_t);
Jerome Coutant 1:917af0ca86df 120 void (*ErrorDisableIT)(uint16_t);
Jerome Coutant 1:917af0ca86df 121 uint8_t (*ErrorGetSrc)(uint16_t);
Jerome Coutant 1:917af0ca86df 122 uint8_t (*ErrorGetCode)(uint16_t);
Jerome Coutant 1:917af0ca86df 123 }IDD_DrvTypeDef;
Jerome Coutant 1:917af0ca86df 124 /**
Jerome Coutant 1:917af0ca86df 125 * @}
Jerome Coutant 1:917af0ca86df 126 */
Jerome Coutant 1:917af0ca86df 127
Jerome Coutant 1:917af0ca86df 128 /**
Jerome Coutant 1:917af0ca86df 129 * @}
Jerome Coutant 1:917af0ca86df 130 */
Jerome Coutant 1:917af0ca86df 131
Jerome Coutant 1:917af0ca86df 132 /**
Jerome Coutant 1:917af0ca86df 133 * @}
Jerome Coutant 1:917af0ca86df 134 */
Jerome Coutant 1:917af0ca86df 135
Jerome Coutant 1:917af0ca86df 136 /**
Jerome Coutant 1:917af0ca86df 137 * @}
Jerome Coutant 1:917af0ca86df 138 */
Jerome Coutant 1:917af0ca86df 139
Jerome Coutant 1:917af0ca86df 140 /**
Jerome Coutant 1:917af0ca86df 141 * @}
Jerome Coutant 1:917af0ca86df 142 */
Jerome Coutant 1:917af0ca86df 143
Jerome Coutant 1:917af0ca86df 144 #ifdef __cplusplus
Jerome Coutant 1:917af0ca86df 145 }
Jerome Coutant 1:917af0ca86df 146 #endif
Jerome Coutant 1:917af0ca86df 147
Jerome Coutant 1:917af0ca86df 148 #endif /* __IDD_H */
Jerome Coutant 1:917af0ca86df 149
Jerome Coutant 1:917af0ca86df 150 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/