ST / BSP_DISCO_L476VG

Dependents:   DiscoLogger DISCO_L476VG_GlassLCD DISCO_L476VG_MicrophoneRecorder DISCO_L476VG_UART ... more

Drivers/BSP/Components/Common/io.h@3:4c7d003a8259, 2018-01-17 (annotated)

Committer:
bcostm
Date:
Wed Jan 17 14:57:52 2018 +0100
Revision:
3:4c7d003a8259
Parent:
1:917af0ca86df
Child:
5:4943b15cce9f
Update BSP files with CubeL4 V1.11.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 io.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 IO driver.
Jerome Coutant 1:917af0ca86df 6 ******************************************************************************
Jerome Coutant 1:917af0ca86df 7 * @attention
Jerome Coutant 1:917af0ca86df 8 *
Jerome Coutant 1:917af0ca86df 9 * <h2><center>&copy; COPYRIGHT(c) 2017 STMicroelectronics</center></h2>
Jerome Coutant 1:917af0ca86df 10 *
Jerome Coutant 1:917af0ca86df 11 * Redistribution and use in source and binary forms, with or without modification,
Jerome Coutant 1:917af0ca86df 12 * are permitted provided that the following conditions are met:
Jerome Coutant 1:917af0ca86df 13 * 1. Redistributions of source code must retain the above copyright notice,
Jerome Coutant 1:917af0ca86df 14 * this list of conditions and the following disclaimer.
Jerome Coutant 1:917af0ca86df 15 * 2. Redistributions in binary form must reproduce the above copyright notice,
Jerome Coutant 1:917af0ca86df 16 * this list of conditions and the following disclaimer in the documentation
Jerome Coutant 1:917af0ca86df 17 * and/or other materials provided with the distribution.
Jerome Coutant 1:917af0ca86df 18 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Jerome Coutant 1:917af0ca86df 19 * may be used to endorse or promote products derived from this software
Jerome Coutant 1:917af0ca86df 20 * without specific prior written permission.
Jerome Coutant 1:917af0ca86df 21 *
Jerome Coutant 1:917af0ca86df 22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Jerome Coutant 1:917af0ca86df 23 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Jerome Coutant 1:917af0ca86df 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Jerome Coutant 1:917af0ca86df 25 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Jerome Coutant 1:917af0ca86df 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Jerome Coutant 1:917af0ca86df 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Jerome Coutant 1:917af0ca86df 28 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Jerome Coutant 1:917af0ca86df 29 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Jerome Coutant 1:917af0ca86df 30 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Jerome Coutant 1:917af0ca86df 31 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Jerome Coutant 1:917af0ca86df 32 *
Jerome Coutant 1:917af0ca86df 33 ******************************************************************************
Jerome Coutant 1:917af0ca86df 34 */
Jerome Coutant 1:917af0ca86df 35
Jerome Coutant 1:917af0ca86df 36 /* Define to prevent recursive inclusion -------------------------------------*/
Jerome Coutant 1:917af0ca86df 37 #ifndef __IO_H
Jerome Coutant 1:917af0ca86df 38 #define __IO_H
Jerome Coutant 1:917af0ca86df 39
Jerome Coutant 1:917af0ca86df 40 #ifdef __cplusplus
Jerome Coutant 1:917af0ca86df 41 extern "C" {
Jerome Coutant 1:917af0ca86df 42 #endif
Jerome Coutant 1:917af0ca86df 43
Jerome Coutant 1:917af0ca86df 44 /* Includes ------------------------------------------------------------------*/
Jerome Coutant 1:917af0ca86df 45 #include <stdint.h>
Jerome Coutant 1:917af0ca86df 46
Jerome Coutant 1:917af0ca86df 47 /** @addtogroup BSP
Jerome Coutant 1:917af0ca86df 48 * @{
Jerome Coutant 1:917af0ca86df 49 */
Jerome Coutant 1:917af0ca86df 50
Jerome Coutant 1:917af0ca86df 51 /** @addtogroup Components
Jerome Coutant 1:917af0ca86df 52 * @{
Jerome Coutant 1:917af0ca86df 53 */
Jerome Coutant 1:917af0ca86df 54
Jerome Coutant 1:917af0ca86df 55 /** @addtogroup IO
Jerome Coutant 1:917af0ca86df 56 * @{
Jerome Coutant 1:917af0ca86df 57 */
Jerome Coutant 1:917af0ca86df 58
Jerome Coutant 1:917af0ca86df 59 /** @defgroup IO_Exported_Types
Jerome Coutant 1:917af0ca86df 60 * @{
Jerome Coutant 1:917af0ca86df 61 */
Jerome Coutant 1:917af0ca86df 62
Jerome Coutant 1:917af0ca86df 63 /**
Jerome Coutant 1:917af0ca86df 64 * @brief IO Bit SET and Bit RESET enumeration
Jerome Coutant 1:917af0ca86df 65 */
Jerome Coutant 1:917af0ca86df 66 typedef enum
Jerome Coutant 1:917af0ca86df 67 {
Jerome Coutant 1:917af0ca86df 68 IO_PIN_RESET = 0,
Jerome Coutant 1:917af0ca86df 69 IO_PIN_SET
Jerome Coutant 1:917af0ca86df 70 }IO_PinState;
Jerome Coutant 1:917af0ca86df 71
Jerome Coutant 1:917af0ca86df 72 typedef enum
Jerome Coutant 1:917af0ca86df 73 {
Jerome Coutant 1:917af0ca86df 74 IO_MODE_INPUT = 0, /* input floating */
Jerome Coutant 1:917af0ca86df 75 IO_MODE_OUTPUT, /* output Push Pull */
Jerome Coutant 1:917af0ca86df 76 IO_MODE_IT_RISING_EDGE, /* float input - irq detect on rising edge */
Jerome Coutant 1:917af0ca86df 77 IO_MODE_IT_FALLING_EDGE, /* float input - irq detect on falling edge */
Jerome Coutant 1:917af0ca86df 78 IO_MODE_IT_LOW_LEVEL, /* float input - irq detect on low level */
Jerome Coutant 1:917af0ca86df 79 IO_MODE_IT_HIGH_LEVEL, /* float input - irq detect on high level */
Jerome Coutant 1:917af0ca86df 80 /* following modes only available on MFX*/
Jerome Coutant 1:917af0ca86df 81 IO_MODE_ANALOG, /* analog mode */
Jerome Coutant 1:917af0ca86df 82 IO_MODE_OFF, /* when pin isn't used*/
Jerome Coutant 1:917af0ca86df 83 IO_MODE_INPUT_PU, /* input with internal pull up resistor */
Jerome Coutant 1:917af0ca86df 84 IO_MODE_INPUT_PD, /* input with internal pull down resistor */
Jerome Coutant 1:917af0ca86df 85 IO_MODE_OUTPUT_OD, /* Open Drain output without internal resistor */
Jerome Coutant 1:917af0ca86df 86 IO_MODE_OUTPUT_OD_PU, /* Open Drain output with internal pullup resistor */
Jerome Coutant 1:917af0ca86df 87 IO_MODE_OUTPUT_OD_PD, /* Open Drain output with internal pulldown resistor */
Jerome Coutant 1:917af0ca86df 88 IO_MODE_OUTPUT_PP, /* PushPull output without internal resistor */
Jerome Coutant 1:917af0ca86df 89 IO_MODE_OUTPUT_PP_PU, /* PushPull output with internal pullup resistor */
Jerome Coutant 1:917af0ca86df 90 IO_MODE_OUTPUT_PP_PD, /* PushPull output with internal pulldown resistor */
Jerome Coutant 1:917af0ca86df 91 IO_MODE_IT_RISING_EDGE_PU, /* push up resistor input - irq on rising edge */
Jerome Coutant 1:917af0ca86df 92 IO_MODE_IT_RISING_EDGE_PD, /* push dw resistor input - irq on rising edge */
Jerome Coutant 1:917af0ca86df 93 IO_MODE_IT_FALLING_EDGE_PU, /* push up resistor input - irq on falling edge */
Jerome Coutant 1:917af0ca86df 94 IO_MODE_IT_FALLING_EDGE_PD, /* push dw resistor input - irq on falling edge */
Jerome Coutant 1:917af0ca86df 95 IO_MODE_IT_LOW_LEVEL_PU, /* push up resistor input - irq detect on low level */
Jerome Coutant 1:917af0ca86df 96 IO_MODE_IT_LOW_LEVEL_PD, /* push dw resistor input - irq detect on low level */
Jerome Coutant 1:917af0ca86df 97 IO_MODE_IT_HIGH_LEVEL_PU, /* push up resistor input - irq detect on high level */
Jerome Coutant 1:917af0ca86df 98 IO_MODE_IT_HIGH_LEVEL_PD, /* push dw resistor input - irq detect on high level */
Jerome Coutant 1:917af0ca86df 99
Jerome Coutant 1:917af0ca86df 100 }IO_ModeTypedef;
Jerome Coutant 1:917af0ca86df 101
Jerome Coutant 1:917af0ca86df 102 /** @defgroup IO_Driver_structure IO Driver structure
Jerome Coutant 1:917af0ca86df 103 * @{
Jerome Coutant 1:917af0ca86df 104 */
Jerome Coutant 1:917af0ca86df 105 typedef struct
Jerome Coutant 1:917af0ca86df 106 {
Jerome Coutant 1:917af0ca86df 107 void (*Init)(uint16_t);
Jerome Coutant 1:917af0ca86df 108 uint16_t (*ReadID)(uint16_t);
Jerome Coutant 1:917af0ca86df 109 void (*Reset)(uint16_t);
Jerome Coutant 1:917af0ca86df 110
Jerome Coutant 1:917af0ca86df 111 void (*Start)(uint16_t, uint32_t);
Jerome Coutant 1:917af0ca86df 112 uint8_t (*Config)(uint16_t, uint32_t, IO_ModeTypedef);
Jerome Coutant 1:917af0ca86df 113 void (*WritePin)(uint16_t, uint32_t, uint8_t);
Jerome Coutant 1:917af0ca86df 114 uint32_t (*ReadPin)(uint16_t, uint32_t);
Jerome Coutant 1:917af0ca86df 115
Jerome Coutant 1:917af0ca86df 116 void (*EnableIT)(uint16_t);
Jerome Coutant 1:917af0ca86df 117 void (*DisableIT)(uint16_t);
Jerome Coutant 1:917af0ca86df 118 uint32_t (*ITStatus)(uint16_t, uint32_t);
Jerome Coutant 1:917af0ca86df 119 void (*ClearIT)(uint16_t, uint32_t);
Jerome Coutant 1:917af0ca86df 120
Jerome Coutant 1:917af0ca86df 121 }IO_DrvTypeDef;
Jerome Coutant 1:917af0ca86df 122 /**
Jerome Coutant 1:917af0ca86df 123 * @}
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 #ifdef __cplusplus
Jerome Coutant 1:917af0ca86df 143 }
Jerome Coutant 1:917af0ca86df 144 #endif
Jerome Coutant 1:917af0ca86df 145
Jerome Coutant 1:917af0ca86df 146 #endif /* __IO_H */
Jerome Coutant 1:917af0ca86df 147
Jerome Coutant 1:917af0ca86df 148 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/