JHE YU CHEN / X_NUCLEO_IHM02A1

hi

Dependencies:   ST_INTERFACES X_NUCLEO_COMMON

Fork of X_NUCLEO_IHM02A1 by ST

Components/Common/component_def.h@22:ba7f4131a5e0, 2017-03-10 (annotated)

Committer:
davide.aliprandi@st.com
Date:
Fri Mar 10 11:09:21 2017 +0100
Revision:
22:ba7f4131a5e0
Aligning to ARM mbed coding style.

Who changed what in which revision?

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