Davide Aliprandi / X_NUCLEO_IHM14A1

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   ST_INTERFACES

Components/Common/component_def.h@0:77ad55a7f6d2, 2018-04-27 (annotated)

Committer:
Davidroid
Date:
Fri Apr 27 16:24:53 2018 +0000
Revision:
0:77ad55a7f6d2
Create repository

Who changed what in which revision?

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