ST / BSP_DISCO_F769NI

STM32Cube BSP FW for STM32F769I-Discovery

Dependents:   mbed-os-example-blinky-5 DISCO-F769NI_TOUCHSCREEN_demo_custom_1 Datarecorder2 DISCO-F769NI_TOUCHSCREEN_demo ... more

Drivers/BSP/Components/Common/io.h@0:c0f3bbab73d2, 2017-02-10 (annotated)

Committer:
Jerome Coutant
Date:
Fri Feb 10 13:08:21 2017 +0100
Revision:
0:c0f3bbab73d2
STM32Cube_FW_F7_V1.5.1 BSP STM32F769I-Discovery

Who changed what in which revision?

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