Álvaro de Rada / X_NUCLEO_PLC01A1

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.

Components/Interfaces/Component_class.h@0:b66a560b6618, 2016-02-19 (annotated)

Committer:
apalmieri
Date:
Fri Feb 19 10:56:30 2016 +0000
Revision:
0:b66a560b6618
Child:
2:1ec0dea195f8
Library to handle the X-NUCLEO-PLC01A1 Programmable Logic Controller Expansion Board.

Who changed what in which revision?

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