Arkadi Rafalovich / X_NUCLEO_IHM01A1_Disabled_Control

Personal fork of the library for direct control instead of library control

Dependencies:   X_NUCLEO_COMMON

Dependents:   Thesis_Rotating_Platform

Fork of X_NUCLEO_IHM01A1 by Arkadi Rafalovich

Components/Common/component.h@26:e2049a15fb15, 2017-05-24 (annotated)

Committer:
Arkadi
Date:
Wed May 24 13:49:40 2017 +0000
Revision:
26:e2049a15fb15
Parent:
22:ed3a6990a6eb 
Disabled PWM & direction control in library

Who changed what in which revision?

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