Ngo Kien / BSP_DISCO_F746NG

Clone

Dependents:   SignalProcessLab DigitalSignalAlgorithm_Lab DigitalSignal_Lab

Drivers/BSP/Components/Common/io.h@0:fc80425b677a, 2019-08-26 (annotated)

Committer:
ngtkien
Date:
Mon Aug 26 16:33:09 2019 +0000
Revision:
0:fc80425b677a
Library

Who changed what in which revision?

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