Senior Design: Sound Monitor / BSP

BSP Drivers

Dependencies:   CMSIS_STM32L4xx CMSIS_DSP_401 STM32L4xx_HAL_Driver

Dependents:   DiscoAudioRecord

Components/Common/io.h@0:ad9dfc0179dc, 2015-11-02 (annotated)

Committer:
EricLew
Date:
Mon Nov 02 19:38:36 2015 +0000
Revision:
0:ad9dfc0179dc
commit

Who changed what in which revision?

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