ST / X_NUCLEO_IKA01A1

mbed library for STMicroelectronics' X-NUCLEO-IKA01A1 expansion board.

Dependents:   HelloWorld_IKA01A1

Fork of X_NUCLEO_IKA01A1 by ST Expansion SW Team

Library for STMicroelectronics' X-NUCLEO-IKA01A1 multifunctional expansion board based on operational amplifiers.

Components/Common/windcomp.h@17:cbdee5f7a2aa, 2016-04-08 (annotated)

Committer:
hemddabral
Date:
Fri Apr 08 08:59:17 2016 +0000
Revision:
17:cbdee5f7a2aa
Parent:
16:2f9443aedbe8
Child:
21:8d0624950dd1
review comments

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hemddabral 1:7fbcb56cc096 1 /**
hemddabral 1:7fbcb56cc096 2 ******************************************************************************
hemddabral 16:2f9443aedbe8 3 * @file WIND_COMP.h
hemddabral 1:7fbcb56cc096 4 * @author Central Labs
hemddabral 1:7fbcb56cc096 5 * @version 1.0.0
hemddabral 1:7fbcb56cc096 6 * @date 11-February-2016
hemddabral 1:7fbcb56cc096 7 * @brief Portable architecture for TSU104
hemddabral 1:7fbcb56cc096 8 ******************************************************************************
hemddabral 1:7fbcb56cc096 9 * @attention
hemddabral 1:7fbcb56cc096 10 *
hemddabral 1:7fbcb56cc096 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
hemddabral 1:7fbcb56cc096 12 *
hemddabral 1:7fbcb56cc096 13 * Redistribution and use in source and binary forms, with or without modification,
hemddabral 1:7fbcb56cc096 14 * are permitted provided that the following conditions are met:
hemddabral 1:7fbcb56cc096 15 * 1. Redistributions of source code must retain the above copyright notice,
hemddabral 1:7fbcb56cc096 16 * this list of conditions and the following disclaimer.
hemddabral 1:7fbcb56cc096 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
hemddabral 1:7fbcb56cc096 18 * this list of conditions and the following disclaimer in the documentation
hemddabral 1:7fbcb56cc096 19 * and/or other materials provided with the distribution.
hemddabral 1:7fbcb56cc096 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
hemddabral 1:7fbcb56cc096 21 * may be used to endorse or promote products derived from this software
hemddabral 1:7fbcb56cc096 22 * without specific prior written permission.
hemddabral 1:7fbcb56cc096 23 *
hemddabral 1:7fbcb56cc096 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
hemddabral 1:7fbcb56cc096 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
hemddabral 1:7fbcb56cc096 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
hemddabral 1:7fbcb56cc096 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
hemddabral 1:7fbcb56cc096 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
hemddabral 1:7fbcb56cc096 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
hemddabral 1:7fbcb56cc096 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
hemddabral 1:7fbcb56cc096 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
hemddabral 1:7fbcb56cc096 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
hemddabral 1:7fbcb56cc096 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
hemddabral 1:7fbcb56cc096 34 *
hemddabral 1:7fbcb56cc096 35 ******************************************************************************
hemddabral 1:7fbcb56cc096 36 */
hemddabral 1:7fbcb56cc096 37
hemddabral 1:7fbcb56cc096 38
hemddabral 1:7fbcb56cc096 39 /* Define to prevent recursive inclusion -------------------------------------*/
hemddabral 1:7fbcb56cc096 40
hemddabral 16:2f9443aedbe8 41 #ifndef __WIND_COMP_H
hemddabral 16:2f9443aedbe8 42 #define __WIND_COMP_H
hemddabral 1:7fbcb56cc096 43
hemddabral 1:7fbcb56cc096 44 #ifdef __cplusplus
hemddabral 1:7fbcb56cc096 45 extern "C" {
hemddabral 1:7fbcb56cc096 46 #endif
hemddabral 1:7fbcb56cc096 47
hemddabral 1:7fbcb56cc096 48
hemddabral 1:7fbcb56cc096 49 /* Includes ------------------------------------------------------------------*/
hemddabral 1:7fbcb56cc096 50
hemddabral 1:7fbcb56cc096 51 #include <stdint.h>
hemddabral 1:7fbcb56cc096 52 #include "component.h"
hemddabral 1:7fbcb56cc096 53
hemddabral 1:7fbcb56cc096 54
hemddabral 1:7fbcb56cc096 55 /* Types ---------------------------------------------------------------------*/
hemddabral 1:7fbcb56cc096 56
hemddabral 1:7fbcb56cc096 57 /** @addtogroup BSP
hemddabral 1:7fbcb56cc096 58 * @{
hemddabral 1:7fbcb56cc096 59 */
hemddabral 1:7fbcb56cc096 60
hemddabral 1:7fbcb56cc096 61 /** @addtogroup Components
hemddabral 1:7fbcb56cc096 62 * @{
hemddabral 1:7fbcb56cc096 63 */
hemddabral 1:7fbcb56cc096 64
hemddabral 16:2f9443aedbe8 65 /** @addtogroup WIND_COMP
hemddabral 1:7fbcb56cc096 66 * @{
hemddabral 1:7fbcb56cc096 67 */
hemddabral 1:7fbcb56cc096 68
hemddabral 16:2f9443aedbe8 69 /** @defgroup WIND_COMP_Exported_Types
hemddabral 1:7fbcb56cc096 70 * @{
hemddabral 1:7fbcb56cc096 71 */
hemddabral 1:7fbcb56cc096 72
hemddabral 1:7fbcb56cc096 73 /**
hemddabral 16:2f9443aedbe8 74 * @brief WIND_COMP component identifier enumerator definition.
hemddabral 1:7fbcb56cc096 75 */
hemddabral 1:7fbcb56cc096 76 typedef enum
hemddabral 1:7fbcb56cc096 77 {
hemddabral 16:2f9443aedbe8 78 WIND_COMP_NONE_COMPONENT = 0,
hemddabral 16:2f9443aedbe8 79 WIND_COMP_TSU104_COMPONENT = 1
hemddabral 16:2f9443aedbe8 80 } WIND_COMPE_Component_t;
hemddabral 1:7fbcb56cc096 81
hemddabral 1:7fbcb56cc096 82 /**
hemddabral 16:2f9443aedbe8 83 * @brief WIND_COMP driver virtual table structure definition.
hemddabral 1:7fbcb56cc096 84 */
hemddabral 1:7fbcb56cc096 85 typedef struct
hemddabral 1:7fbcb56cc096 86 {
hemddabral 1:7fbcb56cc096 87 /* ACTION ----------------------------------------------------------------*
hemddabral 1:7fbcb56cc096 88 * Declare here the component's generic functions. *
hemddabral 1:7fbcb56cc096 89 * Tag this group of functions with the " Generic " C-style comment. *
hemddabral 1:7fbcb56cc096 90 * A component's interface has to define at least the two generic *
hemddabral 1:7fbcb56cc096 91 * functions provided here below within the "Example" section, as the *
hemddabral 1:7fbcb56cc096 92 * first and second functions of its Virtual Table. They have to be *
hemddabral 1:7fbcb56cc096 93 * specified exactly in the given way. *
hemddabral 1:7fbcb56cc096 94 * *
hemddabral 1:7fbcb56cc096 95 * Example: *
hemddabral 1:7fbcb56cc096 96 * Status_t (*Init) (void *handle, void *init); *
hemddabral 1:7fbcb56cc096 97 * Status_t (*ReadID) (void *handle, uint8_t *id); *
hemddabral 1:7fbcb56cc096 98 *------------------------------------------------------------------------*/
hemddabral 1:7fbcb56cc096 99 /* Generic */
hemddabral 1:7fbcb56cc096 100 Status_t (*Init) (void *handle, void *init);
hemddabral 1:7fbcb56cc096 101 Status_t (*ReadID) (void *handle, uint8_t *id);
hemddabral 1:7fbcb56cc096 102
hemddabral 1:7fbcb56cc096 103 /* ACTION ----------------------------------------------------------------*
hemddabral 1:7fbcb56cc096 104 * Declare here the component's specific functions. *
hemddabral 1:7fbcb56cc096 105 * Tag this group of functions with the " Specific " C-style comment. *
hemddabral 1:7fbcb56cc096 106 * Do not specify any function if not required. *
hemddabral 1:7fbcb56cc096 107 * *
hemddabral 1:7fbcb56cc096 108 * Example: *
hemddabral 1:7fbcb56cc096 109 * Status_t (*GetValue) (void *handle, float *f); *
hemddabral 1:7fbcb56cc096 110 *------------------------------------------------------------------------*/
hemddabral 17:cbdee5f7a2aa 111 /* Specific */
hemddabral 15:114514787e83 112 unsigned int (*WindComp_Get_Signal1) (void *handle);
hemddabral 15:114514787e83 113 unsigned int (*WindComp_Get_Signal2) (void *handle);
hemddabral 1:7fbcb56cc096 114 } WINDCOMP_VTable_t;
hemddabral 1:7fbcb56cc096 115
hemddabral 1:7fbcb56cc096 116 #ifdef __cplusplus
hemddabral 1:7fbcb56cc096 117 }
hemddabral 1:7fbcb56cc096 118 #endif
hemddabral 1:7fbcb56cc096 119
hemddabral 16:2f9443aedbe8 120 #endif /* __WIND_COMP_H */
hemddabral 1:7fbcb56cc096 121
hemddabral 1:7fbcb56cc096 122 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
hemddabral 1:7fbcb56cc096 123