ST / ST_INTERFACES

Official interfaces for ST components.

Dependents:   X_NUCLEO_IKS01A1 mDot_X_NUCLEO_IKS01A1 53L0A1 X_NUCLEO_IKS01A1 ... more

Fork of ST_INTERFACES by Davide Aliprandi

This library contains all abstract classes which together constitute the common API to which all existing and future ST components will adhere to.

Common/Component_class.h@0:f6dd8f22f875, 2016-08-01 (annotated)

Committer:
Davidroid
Date:
Mon Aug 01 15:06:25 2016 +0000
Revision:
0:f6dd8f22f875
Interfaces for mbed libraries.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Davidroid 0:f6dd8f22f875 1 /**
Davidroid 0:f6dd8f22f875 2 ******************************************************************************
Davidroid 0:f6dd8f22f875 3 * @file Component_class.h
Davidroid 0:f6dd8f22f875 4 * @author AST
Davidroid 0:f6dd8f22f875 5 * @version V1.0.0
Davidroid 0:f6dd8f22f875 6 * @date April 13th, 2015
Davidroid 0:f6dd8f22f875 7 * @brief This file contains the abstract class describing the interface of a
Davidroid 0:f6dd8f22f875 8 * generic component.
Davidroid 0:f6dd8f22f875 9 ******************************************************************************
Davidroid 0:f6dd8f22f875 10 * @attention
Davidroid 0:f6dd8f22f875 11 *
Davidroid 0:f6dd8f22f875 12 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
Davidroid 0:f6dd8f22f875 13 *
Davidroid 0:f6dd8f22f875 14 * Redistribution and use in source and binary forms, with or without modification,
Davidroid 0:f6dd8f22f875 15 * are permitted provided that the following conditions are met:
Davidroid 0:f6dd8f22f875 16 * 1. Redistributions of source code must retain the above copyright notice,
Davidroid 0:f6dd8f22f875 17 * this list of conditions and the following disclaimer.
Davidroid 0:f6dd8f22f875 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
Davidroid 0:f6dd8f22f875 19 * this list of conditions and the following disclaimer in the documentation
Davidroid 0:f6dd8f22f875 20 * and/or other materials provided with the distribution.
Davidroid 0:f6dd8f22f875 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
Davidroid 0:f6dd8f22f875 22 * may be used to endorse or promote products derived from this software
Davidroid 0:f6dd8f22f875 23 * without specific prior written permission.
Davidroid 0:f6dd8f22f875 24 *
Davidroid 0:f6dd8f22f875 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
Davidroid 0:f6dd8f22f875 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
Davidroid 0:f6dd8f22f875 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
Davidroid 0:f6dd8f22f875 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
Davidroid 0:f6dd8f22f875 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
Davidroid 0:f6dd8f22f875 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
Davidroid 0:f6dd8f22f875 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
Davidroid 0:f6dd8f22f875 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
Davidroid 0:f6dd8f22f875 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
Davidroid 0:f6dd8f22f875 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Davidroid 0:f6dd8f22f875 35 *
Davidroid 0:f6dd8f22f875 36 ******************************************************************************
Davidroid 0:f6dd8f22f875 37 */
Davidroid 0:f6dd8f22f875 38
Davidroid 0:f6dd8f22f875 39
Davidroid 0:f6dd8f22f875 40 /* Define to prevent recursive inclusion -------------------------------------*/
Davidroid 0:f6dd8f22f875 41
Davidroid 0:f6dd8f22f875 42 #ifndef __COMPONENT_CLASS_H
Davidroid 0:f6dd8f22f875 43 #define __COMPONENT_CLASS_H
Davidroid 0:f6dd8f22f875 44
Davidroid 0:f6dd8f22f875 45
Davidroid 0:f6dd8f22f875 46 /* Includes ------------------------------------------------------------------*/
Davidroid 0:f6dd8f22f875 47
Davidroid 0:f6dd8f22f875 48 #include <stdint.h>
Davidroid 0:f6dd8f22f875 49
Davidroid 0:f6dd8f22f875 50
Davidroid 0:f6dd8f22f875 51 /* Classes ------------------------------------------------------------------*/
Davidroid 0:f6dd8f22f875 52
Davidroid 0:f6dd8f22f875 53 /** An abstract class for Generic components.
Davidroid 0:f6dd8f22f875 54 */
Davidroid 0:f6dd8f22f875 55 class Component
Davidroid 0:f6dd8f22f875 56 {
Davidroid 0:f6dd8f22f875 57 public:
Davidroid 0:f6dd8f22f875 58 /**
Davidroid 0:f6dd8f22f875 59 * @brief Initializing the component.
Davidroid 0:f6dd8f22f875 60 * @param[in] init pointer to device specific initalization structure.
Davidroid 0:f6dd8f22f875 61 * @retval "0" in case of success, an error code otherwise.
Davidroid 0:f6dd8f22f875 62 */
Davidroid 0:f6dd8f22f875 63 virtual int Init(void *init) = 0;
Davidroid 0:f6dd8f22f875 64
Davidroid 0:f6dd8f22f875 65 /**
Davidroid 0:f6dd8f22f875 66 * @brief Getting the ID of the component.
Davidroid 0:f6dd8f22f875 67 * @param[out] id pointer to an allocated variable to store the ID into.
Davidroid 0:f6dd8f22f875 68 * @retval "0" in case of success, an error code otherwise.
Davidroid 0:f6dd8f22f875 69 */
Davidroid 0:f6dd8f22f875 70 virtual int ReadID(uint8_t *id) = 0;
Davidroid 0:f6dd8f22f875 71 };
Davidroid 0:f6dd8f22f875 72
Davidroid 0:f6dd8f22f875 73 #endif /* __COMPONENT_CLASS_H */
Davidroid 0:f6dd8f22f875 74
Davidroid 0:f6dd8f22f875 75 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/