Sean Wilson / Mbed OS AdiSense1000_V21

AdiSense1000_V21 MBED API

Fork of AdiSense1000 by PoC_Team

inc/adi_sense_types.h@2:625a45555a85, 2017-08-25 (annotated)

Committer:
kevin1990
Date:
Fri Aug 25 11:17:37 2017 +0000
Revision:
2:625a45555a85
Sensor Channel 0 Type K example

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kevin1990 2:625a45555a85 1 /*!
kevin1990 2:625a45555a85 2 ******************************************************************************
kevin1990 2:625a45555a85 3 * @file: adi_sense_types.h
kevin1990 2:625a45555a85 4 * @brief: Type definitions for ADI Sense API.
kevin1990 2:625a45555a85 5 *-----------------------------------------------------------------------------
kevin1990 2:625a45555a85 6 *
kevin1990 2:625a45555a85 7 Copyright (c) 2017 Emutex Ltd. / Analog Devices, Inc.
kevin1990 2:625a45555a85 8
kevin1990 2:625a45555a85 9 All rights reserved.
kevin1990 2:625a45555a85 10
kevin1990 2:625a45555a85 11 Redistribution and use in source and binary forms, with or without modification,
kevin1990 2:625a45555a85 12 are permitted provided that the following conditions are met:
kevin1990 2:625a45555a85 13 - Redistributions of source code must retain the above copyright notice,
kevin1990 2:625a45555a85 14 this list of conditions and the following disclaimer.
kevin1990 2:625a45555a85 15 - Redistributions in binary form must reproduce the above copyright notice,
kevin1990 2:625a45555a85 16 this list of conditions and the following disclaimer in the documentation
kevin1990 2:625a45555a85 17 and/or other materials provided with the distribution.
kevin1990 2:625a45555a85 18 - Modified versions of the software must be conspicuously marked as such.
kevin1990 2:625a45555a85 19 - This software is licensed solely and exclusively for use with processors
kevin1990 2:625a45555a85 20 manufactured by or for Analog Devices, Inc.
kevin1990 2:625a45555a85 21 - This software may not be combined or merged with other code in any manner
kevin1990 2:625a45555a85 22 that would cause the software to become subject to terms and conditions
kevin1990 2:625a45555a85 23 which differ from those listed here.
kevin1990 2:625a45555a85 24 - Neither the name of Analog Devices, Inc. nor the names of its
kevin1990 2:625a45555a85 25 contributors may be used to endorse or promote products derived
kevin1990 2:625a45555a85 26 from this software without specific prior written permission.
kevin1990 2:625a45555a85 27 - The use of this software may or may not infringe the patent rights of one
kevin1990 2:625a45555a85 28 or more patent holders. This license does not release you from the
kevin1990 2:625a45555a85 29 requirement that you obtain separate licenses from these patent holders
kevin1990 2:625a45555a85 30 to use this software.
kevin1990 2:625a45555a85 31
kevin1990 2:625a45555a85 32 THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. AND CONTRIBUTORS "AS IS" AND ANY
kevin1990 2:625a45555a85 33 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
kevin1990 2:625a45555a85 34 TITLE, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
kevin1990 2:625a45555a85 35 NO EVENT SHALL ANALOG DEVICES, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
kevin1990 2:625a45555a85 36 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE OR CONSEQUENTIAL DAMAGES
kevin1990 2:625a45555a85 37 (INCLUDING, BUT NOT LIMITED TO, DAMAGES ARISING OUT OF CLAIMS OF INTELLECTUAL
kevin1990 2:625a45555a85 38 PROPERTY RIGHTS INFRINGEMENT; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
kevin1990 2:625a45555a85 39 OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
kevin1990 2:625a45555a85 40 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
kevin1990 2:625a45555a85 41 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
kevin1990 2:625a45555a85 42 EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
kevin1990 2:625a45555a85 43 *
kevin1990 2:625a45555a85 44 *****************************************************************************/
kevin1990 2:625a45555a85 45 #ifndef __ADI_SENSE_TYPES_H__
kevin1990 2:625a45555a85 46 #define __ADI_SENSE_TYPES_H__
kevin1990 2:625a45555a85 47
kevin1990 2:625a45555a85 48 /******************************************************************************/
kevin1990 2:625a45555a85 49 /* Include Files */
kevin1990 2:625a45555a85 50 /******************************************************************************/
kevin1990 2:625a45555a85 51
kevin1990 2:625a45555a85 52 /*!
kevin1990 2:625a45555a85 53 *****************************************************************************
kevin1990 2:625a45555a85 54 * \enum ADI_SENSE_RESULT
kevin1990 2:625a45555a85 55 *
kevin1990 2:625a45555a85 56 * ADI Sense API Error Codes. #ADI_SENSE_SUCCESS is always zero
kevin1990 2:625a45555a85 57 * The return value of all ADI Sense APIs returning #ADI_SENSE_RESULT
kevin1990 2:625a45555a85 58 * should always be tested at the application level for success or failure.
kevin1990 2:625a45555a85 59 *
kevin1990 2:625a45555a85 60 *****************************************************************************/
kevin1990 2:625a45555a85 61 typedef enum
kevin1990 2:625a45555a85 62 {
kevin1990 2:625a45555a85 63 /*! Generic success. */
kevin1990 2:625a45555a85 64 ADI_SENSE_SUCCESS,
kevin1990 2:625a45555a85 65 /*! Generic Failure. */
kevin1990 2:625a45555a85 66 ADI_SENSE_FAILURE,
kevin1990 2:625a45555a85 67 /*! Operation incomplete, call again */
kevin1990 2:625a45555a85 68 ADI_SENSE_INCOMPLETE,
kevin1990 2:625a45555a85 69 /*! Device is already initialized. */
kevin1990 2:625a45555a85 70 ADI_SENSE_IN_USE,
kevin1990 2:625a45555a85 71 /*! Invalid device handle. */
kevin1990 2:625a45555a85 72 ADI_SENSE_INVALID_HANDLE,
kevin1990 2:625a45555a85 73 /*! Invalid device ID. */
kevin1990 2:625a45555a85 74 ADI_SENSE_INVALID_DEVICE_NUM,
kevin1990 2:625a45555a85 75 /*! Device is uninitialized. */
kevin1990 2:625a45555a85 76 ADI_SENSE_ERR_NOT_INITIALIZED,
kevin1990 2:625a45555a85 77 /*! NULL data pointer not allowed. */
kevin1990 2:625a45555a85 78 ADI_SENSE_INVALID_POINTER,
kevin1990 2:625a45555a85 79 /*! Parameter is out of range. */
kevin1990 2:625a45555a85 80 ADI_SENSE_INVALID_PARAM,
kevin1990 2:625a45555a85 81 /*! Unsupported mode of operation. */
kevin1990 2:625a45555a85 82 ADI_SENSE_UNSUPPORTED_MODE,
kevin1990 2:625a45555a85 83 /*! Invalid operation */
kevin1990 2:625a45555a85 84 ADI_SENSE_INVALID_OPERATION,
kevin1990 2:625a45555a85 85 /*! No data available, or buffer full */
kevin1990 2:625a45555a85 86 ADI_SENSE_NO_DATA,
kevin1990 2:625a45555a85 87 /*! No buffer space available */
kevin1990 2:625a45555a85 88 ADI_SENSE_NO_SPACE,
kevin1990 2:625a45555a85 89 /*! Square root of a negative number */
kevin1990 2:625a45555a85 90 ADI_SENSE_NEGATIVE_SQRT,
kevin1990 2:625a45555a85 91 /*! Division by 0 or 0.0 */
kevin1990 2:625a45555a85 92 ADI_SENSE_DIVIDE_BY_ZERO,
kevin1990 2:625a45555a85 93 /*! Invalid signature */
kevin1990 2:625a45555a85 94 ADI_SENSE_INVALID_SIGNATURE,
kevin1990 2:625a45555a85 95 /*! Wrong size */
kevin1990 2:625a45555a85 96 ADI_SENSE_WRONG_SIZE,
kevin1990 2:625a45555a85 97 /*! Sample Out of the dsp data limits */
kevin1990 2:625a45555a85 98 ADI_SENSE_OUT_OF_RANGE,
kevin1990 2:625a45555a85 99 /*! Unable to operate with not a number */
kevin1990 2:625a45555a85 100 ADI_SENSE_NAN_FOUND,
kevin1990 2:625a45555a85 101 } ADI_SENSE_RESULT;
kevin1990 2:625a45555a85 102
kevin1990 2:625a45555a85 103 #endif /* __ADI_SENSE_TYPES_H__ */
kevin1990 2:625a45555a85 104