ST / X_NUCLEO_IKA01A1

mbed library for STMicroelectronics' X-NUCLEO-IKA01A1 expansion board.

Dependents:   HelloWorld_IKA01A1

Fork of X_NUCLEO_IKA01A1 by ST Expansion SW Team

Library for STMicroelectronics' X-NUCLEO-IKA01A1 multifunctional expansion board based on operational amplifiers.

Components/Common/instrumentation_amp.h@0:8d2ff26a1946, 2016-02-24 (annotated)

Committer:
hemddabral
Date:
Wed Feb 24 12:16:21 2016 +0000
Revision:
0:8d2ff26a1946
first version of IKA01A1 mbed library;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
hemddabral 0:8d2ff26a1946 1 /**
hemddabral 0:8d2ff26a1946 2 ******************************************************************************
hemddabral 0:8d2ff26a1946 3 * @file instrumentation_amp.h
hemddabral 0:8d2ff26a1946 4 * @author Central Labs
hemddabral 0:8d2ff26a1946 5 * @version 1.0.0
hemddabral 0:8d2ff26a1946 6 * @date 11-February-2016
hemddabral 0:8d2ff26a1946 7 * @brief Portable architecture for TSZ124
hemddabral 0:8d2ff26a1946 8 ******************************************************************************
hemddabral 0:8d2ff26a1946 9 * @attention
hemddabral 0:8d2ff26a1946 10 *
hemddabral 0:8d2ff26a1946 11 * <h2><center>&copy; COPYRIGHT(c) 2015 STMicroelectronics</center></h2>
hemddabral 0:8d2ff26a1946 12 *
hemddabral 0:8d2ff26a1946 13 * Redistribution and use in source and binary forms, with or without modification,
hemddabral 0:8d2ff26a1946 14 * are permitted provided that the following conditions are met:
hemddabral 0:8d2ff26a1946 15 * 1. Redistributions of source code must retain the above copyright notice,
hemddabral 0:8d2ff26a1946 16 * this list of conditions and the following disclaimer.
hemddabral 0:8d2ff26a1946 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
hemddabral 0:8d2ff26a1946 18 * this list of conditions and the following disclaimer in the documentation
hemddabral 0:8d2ff26a1946 19 * and/or other materials provided with the distribution.
hemddabral 0:8d2ff26a1946 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
hemddabral 0:8d2ff26a1946 21 * may be used to endorse or promote products derived from this software
hemddabral 0:8d2ff26a1946 22 * without specific prior written permission.
hemddabral 0:8d2ff26a1946 23 *
hemddabral 0:8d2ff26a1946 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
hemddabral 0:8d2ff26a1946 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
hemddabral 0:8d2ff26a1946 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
hemddabral 0:8d2ff26a1946 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
hemddabral 0:8d2ff26a1946 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
hemddabral 0:8d2ff26a1946 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
hemddabral 0:8d2ff26a1946 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
hemddabral 0:8d2ff26a1946 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
hemddabral 0:8d2ff26a1946 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
hemddabral 0:8d2ff26a1946 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
hemddabral 0:8d2ff26a1946 34 *
hemddabral 0:8d2ff26a1946 35 ******************************************************************************
hemddabral 0:8d2ff26a1946 36 */
hemddabral 0:8d2ff26a1946 37
hemddabral 0:8d2ff26a1946 38
hemddabral 0:8d2ff26a1946 39 /* Define to prevent recursive inclusion -------------------------------------*/
hemddabral 0:8d2ff26a1946 40
hemddabral 0:8d2ff26a1946 41 #ifndef __INSTRUMENTATION_AMP_H
hemddabral 0:8d2ff26a1946 42 #define __INSTRUMENTATION_AMP_H
hemddabral 0:8d2ff26a1946 43
hemddabral 0:8d2ff26a1946 44 #ifdef __cplusplus
hemddabral 0:8d2ff26a1946 45 extern "C" {
hemddabral 0:8d2ff26a1946 46 #endif
hemddabral 0:8d2ff26a1946 47
hemddabral 0:8d2ff26a1946 48
hemddabral 0:8d2ff26a1946 49 /* Includes ------------------------------------------------------------------*/
hemddabral 0:8d2ff26a1946 50
hemddabral 0:8d2ff26a1946 51 #include <stdint.h>
hemddabral 0:8d2ff26a1946 52 #include "component.h"
hemddabral 0:8d2ff26a1946 53
hemddabral 0:8d2ff26a1946 54
hemddabral 0:8d2ff26a1946 55 /* Types ---------------------------------------------------------------------*/
hemddabral 0:8d2ff26a1946 56
hemddabral 0:8d2ff26a1946 57 /** @addtogroup BSP
hemddabral 0:8d2ff26a1946 58 * @{
hemddabral 0:8d2ff26a1946 59 */
hemddabral 0:8d2ff26a1946 60
hemddabral 0:8d2ff26a1946 61 /** @addtogroup Components
hemddabral 0:8d2ff26a1946 62 * @{
hemddabral 0:8d2ff26a1946 63 */
hemddabral 0:8d2ff26a1946 64
hemddabral 0:8d2ff26a1946 65 /** @addtogroup INSTRUMENTATION_AMP
hemddabral 0:8d2ff26a1946 66 * @{
hemddabral 0:8d2ff26a1946 67 */
hemddabral 0:8d2ff26a1946 68
hemddabral 0:8d2ff26a1946 69 /** @defgroup INSTRUMENTATION_AMP_Exported_Types
hemddabral 0:8d2ff26a1946 70 * @{
hemddabral 0:8d2ff26a1946 71 */
hemddabral 0:8d2ff26a1946 72
hemddabral 0:8d2ff26a1946 73 /**
hemddabral 0:8d2ff26a1946 74 * @brief INSTRUMENTATION_AMP component identifier enumerator definition.
hemddabral 0:8d2ff26a1946 75 */
hemddabral 0:8d2ff26a1946 76 typedef enum
hemddabral 0:8d2ff26a1946 77 {
hemddabral 0:8d2ff26a1946 78 INSTRUMENTATION_AMP_NONE_COMPONENT = 0,
hemddabral 0:8d2ff26a1946 79 INSTRUMENTATION_AMP_TSZ124_COMPONENT = 1
hemddabral 0:8d2ff26a1946 80 } INSTRUMENTATION_AMP_Component_t;
hemddabral 0:8d2ff26a1946 81
hemddabral 0:8d2ff26a1946 82 /**
hemddabral 0:8d2ff26a1946 83 * @brief INSTRUMENTATION_AMP driver virtual table structure definition.
hemddabral 0:8d2ff26a1946 84 */
hemddabral 0:8d2ff26a1946 85 typedef struct
hemddabral 0:8d2ff26a1946 86 {
hemddabral 0:8d2ff26a1946 87 /* ACTION ----------------------------------------------------------------*
hemddabral 0:8d2ff26a1946 88 * Declare here the component's generic functions. *
hemddabral 0:8d2ff26a1946 89 * Tag this group of functions with the " Generic " C-style comment. *
hemddabral 0:8d2ff26a1946 90 * A component's interface has to define at least the two generic *
hemddabral 0:8d2ff26a1946 91 * functions provided here below within the "Example" section, as the *
hemddabral 0:8d2ff26a1946 92 * first and second functions of its Virtual Table. They have to be *
hemddabral 0:8d2ff26a1946 93 * specified exactly in the given way. *
hemddabral 0:8d2ff26a1946 94 * *
hemddabral 0:8d2ff26a1946 95 * Example: *
hemddabral 0:8d2ff26a1946 96 * Status_t (*Init) (void *handle, void *init); *
hemddabral 0:8d2ff26a1946 97 * Status_t (*ReadID) (void *handle, uint8_t *id); *
hemddabral 0:8d2ff26a1946 98 *------------------------------------------------------------------------*/
hemddabral 0:8d2ff26a1946 99 /* Generic */
hemddabral 0:8d2ff26a1946 100 Status_t (*Init) (void *handle, void *init);
hemddabral 0:8d2ff26a1946 101 Status_t (*ReadID) (void *handle, uint8_t *id);
hemddabral 0:8d2ff26a1946 102
hemddabral 0:8d2ff26a1946 103 /* ACTION ----------------------------------------------------------------*
hemddabral 0:8d2ff26a1946 104 * Declare here the component's specific functions. *
hemddabral 0:8d2ff26a1946 105 * Tag this group of functions with the " Specific " C-style comment. *
hemddabral 0:8d2ff26a1946 106 * Do not specify any function if not required. *
hemddabral 0:8d2ff26a1946 107 * *
hemddabral 0:8d2ff26a1946 108 * Example: *
hemddabral 0:8d2ff26a1946 109 * Status_t (*GetValue) (void *handle, float *f); *
hemddabral 0:8d2ff26a1946 110 *------------------------------------------------------------------------*/
hemddabral 0:8d2ff26a1946 111 /* Specific */
hemddabral 0:8d2ff26a1946 112 Status_t (*GetVoltage) (void *handle, unsigned int *ptrVoltage);
hemddabral 0:8d2ff26a1946 113 Status_t (*GetCurrent) (void *handle, unsigned int *ptrCurrent);
hemddabral 0:8d2ff26a1946 114 } INSTRUMENTATION_AMP_VTable_t;
hemddabral 0:8d2ff26a1946 115
hemddabral 0:8d2ff26a1946 116 #ifdef __cplusplus
hemddabral 0:8d2ff26a1946 117 }
hemddabral 0:8d2ff26a1946 118 #endif
hemddabral 0:8d2ff26a1946 119
hemddabral 0:8d2ff26a1946 120 #endif /* __INSTRUMENTATION_AMP_H */
hemddabral 0:8d2ff26a1946 121
hemddabral 0:8d2ff26a1946 122 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/
hemddabral 0:8d2ff26a1946 123