Mbed Development branch for MeasrueWare

common/utils.h

Committer:
Vkadaba
Date:
2020-05-20
Revision:
79:dddd92b3a416
Parent:
74:27a28f452d71

File content as of revision 79:dddd92b3a416:

/*
Copyright 2019 (c) 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.
  - 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.
  - Use of the software either in source or binary form, must be run
    on or directly connected to an Analog Devices Inc. component.

THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, 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.
 */

/*!
 ******************************************************************************
 * @file:  utils.h
 * @brief: Interface Utilities for ADMW1001
 *-----------------------------------------------------------------------------
 */
#ifndef __UTILS_H__
#define __UTILS_H__

#include "admw_api.h"
#include "admw1001/admw1001_api.h"

#ifdef __cplusplus
extern "C" {
#endif

/* Utility function to print the status read from the ADMW1001 device */
void utils_printStatus(
    ADMW_STATUS *pStatus);

/* Utility function to print data samples read from the ADMW1001 device */
void utils_printSamples(
    ADMW_DATA_SAMPLE *pSampleBuffer,
    uint32_t nNumSamples,
    ADMW_MEASUREMENT_MODE eMeasurementMode);

/* Utility function to register callbacks for ADMW1001 device notification signals  */
ADMW_RESULT utils_registerCallbacks(
    ADMW_DEVICE_HANDLE hDevice,
    volatile bool *pbDataReady,
    volatile bool *pbError,
    volatile bool *pbAlert);

/* Utility function to de-register callbacks for ADMW1001 device notification signals */
ADMW_RESULT utils_deregisterCallbacks(
    ADMW_DEVICE_HANDLE hDevice);

/* Utility function to run measurements on ADMW1001 device, according to its current
 * configuration, and display data samples and device status following each cycle */
ADMW_RESULT utils_runMeasurement(
    ADMW_DEVICE_HANDLE hDevice,
    ADMW_MEASUREMENT_MODE eMeasurementMode);

/* Utility function to retrieve and print the factory calibration coefficients table from the ADMW1001 device */
ADMW_RESULT utils_printCalTable(
    ADMW_DEVICE_HANDLE hDevice);

#ifdef __cplusplus
}
#endif

#endif /* __UTILS_H__ */