![](/media/cache/img/default_profile.jpg.50x50_q85.jpg)
ADISense1000 Version 2.1 code base
Fork of AdiSense1000_V21 by
Diff: inc/adi_sense_types.h
- Revision:
- 6:ef0331efed74
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/inc/adi_sense_types.h Mon Sep 25 14:45:35 2017 +0000 @@ -0,0 +1,106 @@ +/*! + ****************************************************************************** + * @file: adi_sense_types.h + * @brief: Type definitions for ADI Sense API. + *----------------------------------------------------------------------------- + * +Copyright (c) 2017 Emutex Ltd. / Analog Devices, Inc. + +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + - Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + - Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + - Modified versions of the software must be conspicuously marked as such. + - This software is licensed solely and exclusively for use with processors + manufactured by or for Analog Devices, Inc. + - This software may not be combined or merged with other code in any manner + that would cause the software to become subject to terms and conditions + which differ from those listed here. + - Neither the name of Analog Devices, Inc. nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + - The use of this software may or may not infringe the patent rights of one + or more patent holders. This license does not release you from the + requirement that you obtain separate licenses from these patent holders + to use this software. + +THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. AND CONTRIBUTORS "AS IS" AND ANY +EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT, +TITLE, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN +NO EVENT SHALL ANALOG DEVICES, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, +INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, DAMAGES ARISING OUT OF CLAIMS OF INTELLECTUAL +PROPERTY RIGHTS INFRINGEMENT; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS +OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING +NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, +EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + *****************************************************************************/ +#ifndef __ADI_SENSE_TYPES_H__ +#define __ADI_SENSE_TYPES_H__ + +/******************************************************************************/ +/* Include Files */ +/******************************************************************************/ + +/*! + ***************************************************************************** + * \enum ADI_SENSE_RESULT + * + * ADI Sense API Error Codes. #ADI_SENSE_SUCCESS is always zero + * The return value of all ADI Sense APIs returning #ADI_SENSE_RESULT + * should always be tested at the application level for success or failure. + * + *****************************************************************************/ +typedef enum +{ + /*! Generic success. */ + ADI_SENSE_SUCCESS, + /*! Generic Failure. */ + ADI_SENSE_FAILURE, + /*! Operation incomplete, call again */ + ADI_SENSE_INCOMPLETE, + /*! Device is already initialized. */ + ADI_SENSE_IN_USE, + /*! Invalid device handle. */ + ADI_SENSE_INVALID_HANDLE, + /*! Invalid device ID. */ + ADI_SENSE_INVALID_DEVICE_NUM, + /*! Device is uninitialized. */ + ADI_SENSE_ERR_NOT_INITIALIZED, + /*! NULL data pointer not allowed. */ + ADI_SENSE_INVALID_POINTER, + /*! Parameter is out of range. */ + ADI_SENSE_INVALID_PARAM, + /*! Unsupported mode of operation. */ + ADI_SENSE_UNSUPPORTED_MODE, + /*! Invalid operation */ + ADI_SENSE_INVALID_OPERATION, + /*! No data available, or buffer full */ + ADI_SENSE_NO_DATA, + /*! No buffer space available */ + ADI_SENSE_NO_SPACE, + /*! Square root of a negative number */ + ADI_SENSE_NEGATIVE_SQRT, + /*! Division by 0 or 0.0 */ + ADI_SENSE_DIVIDE_BY_ZERO, + /*! Invalid signature */ + ADI_SENSE_INVALID_SIGNATURE, + /*! Wrong size */ + ADI_SENSE_WRONG_SIZE, + /*! Sample Out of the dsp data limits */ + ADI_SENSE_OUT_OF_RANGE, + /*! Unable to operate with not a number */ + ADI_SENSE_NAN_FOUND, + /*! Timeout error */ + ADI_SENSE_TIMEOUT, +} ADI_SENSE_RESULT; + +#endif /* __ADI_SENSE_TYPES_H__ */ +