ST / BSP_DISCO_F746NG

STM32746G-Discovery board drivers V1.0.0

Dependents:   DISCO-F746NG_LCDTS_CC3000_NTP DISCO-F746NG_ROPE_WIFI F746_SpectralAnalysis_NoPhoto ecte433 ... more

Drivers/BSP/Components/Common/io.h@13:85dbcff443aa, 2019-11-27 (annotated)

Committer:
jeromecoutant
Date:
Wed Nov 27 08:29:42 2019 +0000
Revision:
13:85dbcff443aa
Parent:
7:fe313c53cdb5 
Fix OV9655 Camera Driver

Who changed what in which revision?

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