Progetto STM32 / X_NUCLEO_IHM01A1

f

Dependencies:   ST_INTERFACES X_NUCLEO_COMMON

Fork of X_NUCLEO_IHM01A1 by ST

Components/Common/component_def.h@36:8a192295a94b, 2017-04-29 (annotated)

Committer:
d3dfantasy99
Date:
Sat Apr 29 08:16:25 2017 +0000
Revision:
36:8a192295a94b
Parent:
33:8daea0279301 
tolta libreria

Who changed what in which revision?

UserRevisionLine numberNew contents of line
davide.aliprandi@st.com 33:8daea0279301 1 /**
davide.aliprandi@st.com 33:8daea0279301 2 ******************************************************************************
davide.aliprandi@st.com 33:8daea0279301 3 * @file component_def.h
davide.aliprandi@st.com 33:8daea0279301 4 * @author AST
davide.aliprandi@st.com 33:8daea0279301 5 * @version V1.0.0
davide.aliprandi@st.com 33:8daea0279301 6 * @date 1 April 2015
davide.aliprandi@st.com 33:8daea0279301 7 * @brief Generic header file containing a generic component's definitions
davide.aliprandi@st.com 33:8daea0279301 8 * and I/O functions.
davide.aliprandi@st.com 33:8daea0279301 9 ******************************************************************************
davide.aliprandi@st.com 33:8daea0279301 10 * @attention
davide.aliprandi@st.com 33:8daea0279301 11 *
davide.aliprandi@st.com 33:8daea0279301 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
davide.aliprandi@st.com 33:8daea0279301 13 *
davide.aliprandi@st.com 33:8daea0279301 14 * Redistribution and use in source and binary forms, with or without modification,
davide.aliprandi@st.com 33:8daea0279301 15 * are permitted provided that the following conditions are met:
davide.aliprandi@st.com 33:8daea0279301 16 * 1. Redistributions of source code must retain the above copyright notice,
davide.aliprandi@st.com 33:8daea0279301 17 * this list of conditions and the following disclaimer.
davide.aliprandi@st.com 33:8daea0279301 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
davide.aliprandi@st.com 33:8daea0279301 19 * this list of conditions and the following disclaimer in the documentation
davide.aliprandi@st.com 33:8daea0279301 20 * and/or other materials provided with the distribution.
davide.aliprandi@st.com 33:8daea0279301 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
davide.aliprandi@st.com 33:8daea0279301 22 * may be used to endorse or promote products derived from this software
davide.aliprandi@st.com 33:8daea0279301 23 * without specific prior written permission.
davide.aliprandi@st.com 33:8daea0279301 24 *
davide.aliprandi@st.com 33:8daea0279301 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
davide.aliprandi@st.com 33:8daea0279301 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
davide.aliprandi@st.com 33:8daea0279301 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
davide.aliprandi@st.com 33:8daea0279301 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
davide.aliprandi@st.com 33:8daea0279301 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
davide.aliprandi@st.com 33:8daea0279301 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
davide.aliprandi@st.com 33:8daea0279301 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
davide.aliprandi@st.com 33:8daea0279301 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
davide.aliprandi@st.com 33:8daea0279301 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
davide.aliprandi@st.com 33:8daea0279301 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
davide.aliprandi@st.com 33:8daea0279301 35 *
davide.aliprandi@st.com 33:8daea0279301 36 ******************************************************************************
davide.aliprandi@st.com 33:8daea0279301 37 */
davide.aliprandi@st.com 33:8daea0279301 38
davide.aliprandi@st.com 33:8daea0279301 39
davide.aliprandi@st.com 33:8daea0279301 40 /* Define to prevent recursive inclusion -------------------------------------*/
davide.aliprandi@st.com 33:8daea0279301 41
davide.aliprandi@st.com 33:8daea0279301 42 #ifndef __COMPONENT_H
davide.aliprandi@st.com 33:8daea0279301 43 #define __COMPONENT_H
davide.aliprandi@st.com 33:8daea0279301 44
davide.aliprandi@st.com 33:8daea0279301 45
davide.aliprandi@st.com 33:8daea0279301 46 /* Types ---------------------------------------------------------------------*/
davide.aliprandi@st.com 33:8daea0279301 47
davide.aliprandi@st.com 33:8daea0279301 48 /**
davide.aliprandi@st.com 33:8daea0279301 49 * @brief Component's Context structure definition.
davide.aliprandi@st.com 33:8daea0279301 50 */
davide.aliprandi@st.com 33:8daea0279301 51 typedef struct
davide.aliprandi@st.com 33:8daea0279301 52 {
davide.aliprandi@st.com 33:8daea0279301 53 /* Identity. */
davide.aliprandi@st.com 33:8daea0279301 54 uint8_t who_am_i;
davide.aliprandi@st.com 33:8daea0279301 55
davide.aliprandi@st.com 33:8daea0279301 56 /* ACTION ----------------------------------------------------------------*/
davide.aliprandi@st.com 33:8daea0279301 57 /* There should be only a unique identifier for each component, which */
davide.aliprandi@st.com 33:8daea0279301 58 /* should be the "who_am_i" parameter, hence this parameter is optional. */
davide.aliprandi@st.com 33:8daea0279301 59 /* -----------------------------------------------------------------------*/
davide.aliprandi@st.com 33:8daea0279301 60 /* Type. */
davide.aliprandi@st.com 33:8daea0279301 61 uint8_t type;
davide.aliprandi@st.com 33:8daea0279301 62
davide.aliprandi@st.com 33:8daea0279301 63 /* Configuration. */
davide.aliprandi@st.com 33:8daea0279301 64 uint8_t address;
davide.aliprandi@st.com 33:8daea0279301 65
davide.aliprandi@st.com 33:8daea0279301 66 /* Pointer to the Data. */
davide.aliprandi@st.com 33:8daea0279301 67 void *p_data;
davide.aliprandi@st.com 33:8daea0279301 68
davide.aliprandi@st.com 33:8daea0279301 69 /* Pointer to the Virtual Table. */
davide.aliprandi@st.com 33:8daea0279301 70 void *p_vt;
davide.aliprandi@st.com 33:8daea0279301 71
davide.aliprandi@st.com 33:8daea0279301 72 /* ACTION ----------------------------------------------------------------*/
davide.aliprandi@st.com 33:8daea0279301 73 /* There should be only a unique virtual table for each component, which */
davide.aliprandi@st.com 33:8daea0279301 74 /* should be the "p_vt" parameter, hence this parameter is optional. */
davide.aliprandi@st.com 33:8daea0279301 75 /* -----------------------------------------------------------------------*/
davide.aliprandi@st.com 33:8daea0279301 76 /* Pointer to the Extended Virtual Table. */
davide.aliprandi@st.com 33:8daea0279301 77 void *p_ext_vt;
davide.aliprandi@st.com 33:8daea0279301 78 } handle_t;
davide.aliprandi@st.com 33:8daea0279301 79
davide.aliprandi@st.com 33:8daea0279301 80 /**
davide.aliprandi@st.com 33:8daea0279301 81 * @brief Component's Status enumerator definition.
davide.aliprandi@st.com 33:8daea0279301 82 */
davide.aliprandi@st.com 33:8daea0279301 83 typedef enum
davide.aliprandi@st.com 33:8daea0279301 84 {
davide.aliprandi@st.com 33:8daea0279301 85 COMPONENT_OK = 0,
davide.aliprandi@st.com 33:8daea0279301 86 COMPONENT_ERROR,
davide.aliprandi@st.com 33:8daea0279301 87 COMPONENT_TIMEOUT,
davide.aliprandi@st.com 33:8daea0279301 88 COMPONENT_NOT_IMPLEMENTED
davide.aliprandi@st.com 33:8daea0279301 89 } status_t;
davide.aliprandi@st.com 33:8daea0279301 90
davide.aliprandi@st.com 33:8daea0279301 91 #endif /* __COMPONENT_H */
davide.aliprandi@st.com 33:8daea0279301 92
davide.aliprandi@st.com 33:8daea0279301 93 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/