component_def.h

00001 /**
00002  ******************************************************************************
00003  * @file    component_def.h
00004  * @author  AST
00005  * @version V1.0.0
00006  * @date    1 April 2015
00007  * @brief   Generic header file containing a generic component's definitions
00008  *          and I/O functions.
00009  ******************************************************************************
00010  * @attention
00011  *
00012  * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
00013  *
00014  * Redistribution and use in source and binary forms, with or without modification,
00015  * are permitted provided that the following conditions are met:
00016  *   1. Redistributions of source code must retain the above copyright notice,
00017  *      this list of conditions and the following disclaimer.
00018  *   2. Redistributions in binary form must reproduce the above copyright notice,
00019  *      this list of conditions and the following disclaimer in the documentation
00020  *      and/or other materials provided with the distribution.
00021  *   3. Neither the name of STMicroelectronics nor the names of its contributors
00022  *      may be used to endorse or promote products derived from this software
00023  *      without specific prior written permission.
00024  *
00025  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00026  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00028  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
00029  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00030  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
00031  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
00032  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00033  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
00034  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00035  *
00036  ******************************************************************************
00037  */
00038 
00039 
00040 /* Define to prevent recursive inclusion -------------------------------------*/
00041 
00042 #ifndef __COMPONENT_H
00043 #define __COMPONENT_H
00044 
00045 
00046 /* Types ---------------------------------------------------------------------*/
00047 
00048 /**
00049  * @brief  Component's Context structure definition.
00050  */
00051 typedef struct
00052 {  
00053     /* Identity. */
00054     uint8_t who_am_i;
00055 
00056     /* ACTION ----------------------------------------------------------------*/
00057     /* There should be only a unique identifier for each component, which     */
00058     /* should be the "who_am_i" parameter, hence this parameter is optional.  */
00059     /* -----------------------------------------------------------------------*/
00060     /* Type. */
00061     uint8_t type;
00062 
00063     /* Configuration. */
00064     uint8_t address;
00065 
00066     /* Pointer to the Data. */
00067     void *p_data;
00068 
00069     /* Pointer to the Virtual Table. */
00070     void *p_vt;
00071 
00072     /* ACTION ----------------------------------------------------------------*/
00073     /* There should be only a unique virtual table for each component, which  */
00074     /* should be the "p_vt" parameter, hence this parameter is optional.      */
00075     /* -----------------------------------------------------------------------*/
00076     /* Pointer to the Extended Virtual Table. */
00077     void *p_ext_vt;
00078 } handle_t;
00079 
00080 /**
00081  * @brief  Component's Status enumerator definition.
00082  */
00083 typedef enum
00084 {
00085     COMPONENT_OK = 0,
00086     COMPONENT_ERROR,
00087     COMPONENT_TIMEOUT,
00088     COMPONENT_NOT_IMPLEMENTED
00089 } status_t;
00090 
00091 #endif /* __COMPONENT_H */
00092 
00093 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/