windcomp_def.h

00001 /**
00002  ******************************************************************************
00003  * @file    WIND_COMP.h
00004  * @author  Central Labs
00005  * @version 1.0.0
00006  * @date    11-February-2016
00007  * @brief   Portable architecture for TSU104
00008  ******************************************************************************
00009  * @attention
00010  *
00011  * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
00012  *
00013  * Redistribution and use in source and binary forms, with or without modification,
00014  * are permitted provided that the following conditions are met:
00015  *   1. Redistributions of source code must retain the above copyright notice,
00016  *      this list of conditions and the following disclaimer.
00017  *   2. Redistributions in binary form must reproduce the above copyright notice,
00018  *      this list of conditions and the following disclaimer in the documentation
00019  *      and/or other materials provided with the distribution.
00020  *   3. Neither the name of STMicroelectronics nor the names of its contributors
00021  *      may be used to endorse or promote products derived from this software
00022  *      without specific prior written permission.
00023  *
00024  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00025  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00026  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00027  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00028  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00029  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00030  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00031  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00032  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00033  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00034  *
00035  ******************************************************************************
00036  */
00037 
00038 
00039 /* Define to prevent recursive inclusion -------------------------------------*/
00040 
00041 #ifndef __WIND_COMP_H
00042 #define __WIND_COMP_H
00043 
00044 #ifdef __cplusplus
00045 extern "C" {
00046 #endif
00047 
00048 
00049 /* Includes ------------------------------------------------------------------*/
00050 
00051 #include <stdint.h>
00052 #include "component_def.h"
00053 
00054 
00055 /* Types ---------------------------------------------------------------------*/
00056 
00057 /** @addtogroup BSP
00058   * @{
00059   */
00060 
00061 /** @addtogroup Components
00062   * @{
00063   */
00064     
00065 /** @addtogroup WIND_COMP
00066   * @{
00067   */
00068 
00069 /** @defgroup WIND_COMP_Exported_Types
00070   * @{
00071   */
00072 
00073 /**
00074  * @brief  WIND_COMP component identifier enumerator definition.
00075  */
00076 typedef enum
00077 {
00078     WIND_COMP_NONE_COMPONENT = 0,
00079     WIND_COMP_TSU104_COMPONENT = 1
00080 } WIND_COMPE_component_t;
00081 
00082 /** 
00083  * @brief  WIND_COMP driver virtual table structure definition.
00084  */
00085 typedef struct
00086 {
00087     /* ACTION ----------------------------------------------------------------*
00088      * Declare here the component's generic functions.                        *
00089      * Tag this group of functions with the " Generic " C-style comment.      *
00090      * A component's interface has to define at least the two generic         *
00091      * functions provided here below within the "Example" section, as the     *
00092      * first and second functions of its Virtual Table. They have to be       *
00093      * specified exactly in the given way.                                    *
00094      *                                                                        *
00095      * Example:                                                               *
00096      *   status_t (*Init)   (void *handle, void *init);                       *
00097      *   status_t (*ReadID) (void *handle, uint8_t *id);                      *
00098      *------------------------------------------------------------------------*/
00099     /* Generic */
00100     status_t (*Init)      (void *handle, void *init);
00101     status_t (*ReadID)    (void *handle, uint8_t *id);
00102 
00103     /* ACTION ----------------------------------------------------------------*
00104      * Declare here the component's specific functions.                       *
00105      * Tag this group of functions with the " Specific " C-style comment.     *
00106      * Do not specify any function if not required.                           *
00107      *                                                                        *
00108      * Example:                                                               *
00109      *   status_t (*GetValue) (void *handle, float *f);                       *
00110      *------------------------------------------------------------------------*/
00111     /* Specific */
00112     unsigned int (*GetSignal1) (void *handle);
00113     unsigned int (*GetSignal2) (void *handle);
00114 } WINDCOMP_vt_t;
00115 
00116 #ifdef __cplusplus
00117 }
00118 #endif
00119 
00120 #endif /* __WIND_COMP_H */
00121 
00122 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
00123