Nenad Djalovic / BSP_DISCO_F469NIfdsf

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of BSP_DISCO_F469NI by ST

Components/Common/io.h@0:0002c86c2220, 2015-12-18 (annotated)

Committer:
bcostm
Date:
Fri Dec 18 07:32:01 2015 +0000
Revision:
0:0002c86c2220
Initial version

Who changed what in which revision?

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