Personal fork of the library for direct control instead of library control
Dependents: Thesis_Rotating_Platform
Fork of X_NUCLEO_IHM01A1 by
Components/Common/component.h
- Committer:
- Davidroid
- Date:
- 2015-10-14
- Revision:
- 0:2887415a46cd
- Child:
- 22:ed3a6990a6eb
File content as of revision 0:2887415a46cd:
/** ****************************************************************************** * @file component.h * @author AST * @version V1.0.0 * @date 1 April 2015 * @brief Generic header file containing a generic component's definitions * and I/O functions. ****************************************************************************** * @attention * * <h2><center>© COPYRIGHT(c) 2015 STMicroelectronics</center></h2> * * Redistribution and use in source and binary forms, with or without modification, * are permitted provided that the following conditions are met: * 1. Redistributions of source code must retain the above copyright notice, * this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright notice, * this list of conditions and the following disclaimer in the documentation * and/or other materials provided with the distribution. * 3. Neither the name of STMicroelectronics nor the names of its contributors * may be used to endorse or promote products derived from this software * without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * ****************************************************************************** */ /* Prevent recursive inclusion -----------------------------------------------*/ #ifndef __COMPONENT_H__ #define __COMPONENT_H__ /* Types ---------------------------------------------------------------------*/ /** * @brief Component's Context structure definition. */ typedef struct { /* Identity. */ uint8_t who_am_i; /* ACTION ----------------------------------------------------------------*/ /* There should be only a unique identifier for each component, which */ /* should be the "who_am_i" parameter, hence this parameter is optional. */ /* -----------------------------------------------------------------------*/ /* Type. */ uint8_t type; /* Configuration. */ uint8_t address; /* Pointer to the Data. */ void *pData; /* Pointer to the Virtual Table. */ void *pVTable; /* ACTION ----------------------------------------------------------------*/ /* There should be only a unique virtual table for each component, which */ /* should be the "pVTable" parameter, hence this parameter is optional. */ /* -----------------------------------------------------------------------*/ /* Pointer to the Extended Virtual Table. */ void *pExtVTable; } DrvContextTypeDef; /** * @brief Component's Status enumerator definition. */ typedef enum { COMPONENT_OK = 0, COMPONENT_ERROR, COMPONENT_TIMEOUT, COMPONENT_NOT_IMPLEMENTED } DrvStatusTypeDef; #endif