ching-yang Trui / X_NUCLEO_IHM02A1

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 X_NUCLEO_COMMON

Dependents:   selfbalansingcar

Fork of X_NUCLEO_IHM02A1 by ST

Components/Common/component.h@0:92706998571a, 2015-11-20 (annotated)

Committer:
Davidroid
Date:
Fri Nov 20 18:07:45 2015 +0000
Revision:
0:92706998571a
Child:
14:e614697ebf34
Library to handle the X_NUCLEO_IHM02A1 Motor Control Expansion Board based on the the L6470 component.

Who changed what in which revision?

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