Vybhav Kadaba
Minor changes to support ADMW FWv1.17.75
Diff: inc/admw1001/admw1001_api.h
- Revision:
- 8:2f2775c34640
- Parent:
- 6:9d393a9677f4
--- a/inc/admw1001/admw1001_api.h Tue Jun 18 09:28:16 2019 +0000
+++ b/inc/admw1001/admw1001_api.h Thu Jun 20 18:13:57 2019 +0000
@@ -1,65 +1,4 @@
/*
-Copyright 2018 (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.
- */
-
-/*
-Copyright 2017 (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,/*
Copyright 2019 (c) Analog Devices, Inc.
All rights reserved.
@@ -140,10 +79,10 @@
* according to documentation for those registers.
*/
ADMW_RESULT admw1001_ReadRegister(
- ADMW_DEVICE_HANDLE const hDevice,
- uint16_t const nAddress,
- void * const pData,
- unsigned const nLength);
+ ADMW_DEVICE_HANDLE const hDevice,
+ uint16_t const nAddress,
+ void *const pData,
+ unsigned const nLength);
/*!
* @brief Read one or more device registers at the specified debug register address.
*
@@ -162,10 +101,10 @@
* according to documentation for those registers.
*/
ADMW_RESULT admw1001_Read_Debug_Register(
- ADMW_DEVICE_HANDLE const hDevice,
- uint16_t const nAddress,
- void * const pData,
- unsigned const nLength);
+ ADMW_DEVICE_HANDLE const hDevice,
+ uint16_t const nAddress,
+ void *const pData,
+ unsigned const nLength);
/*!
* @brief Write one or more device registers at the specified register address.
@@ -186,10 +125,10 @@
* documentation for those registers.
*/
ADMW_RESULT admw1001_WriteRegister(
- ADMW_DEVICE_HANDLE const hDevice,
- uint16_t const nAddress,
- void * const pData,
- unsigned const nLength);
+ ADMW_DEVICE_HANDLE const hDevice,
+ uint16_t const nAddress,
+ void *const pData,
+ unsigned const nLength);
/*!
* @brief Write one or more device registers at the specified debug register address.
@@ -207,10 +146,10 @@
*
*/
ADMW_RESULT admw1001_Write_Debug_Register(
- ADMW_DEVICE_HANDLE const hDevice,
- uint16_t const nAddress,
- void * const pData,
- unsigned const nLength);
+ ADMW_DEVICE_HANDLE const hDevice,
+ uint16_t const nAddress,
+ void *const pData,
+ unsigned const nLength);
/*
* @brief Update power configuration settings on the device.
*
@@ -226,8 +165,8 @@
* @note Settings are not applied until admw_ApplyConfigUpdates() is called
*/
ADMW_RESULT admw1001_SetPowerConfig(
- ADMW_DEVICE_HANDLE hDevice,
- ADMW1001_POWER_CONFIG *pPowerConfig);
+ ADMW_DEVICE_HANDLE hDevice,
+ ADMW1001_POWER_CONFIG *pPowerConfig);
/*!
* @brief Update measurement configuration settings on the device.
@@ -244,7 +183,7 @@
* @note Settings are not applied until admw_ApplyConfigUpdates() is called
*/
ADMW_RESULT admw1001_SetMeasurementConfig(
- ADMW_DEVICE_HANDLE hDevice,
+ ADMW_DEVICE_HANDLE hDevice,
ADMW1001_MEASUREMENT_CONFIG *pMeasurementConfig);
/*!
@@ -262,7 +201,7 @@
* @note Settings are not applied until admw_ApplyConfigUpdates() is called
*/
ADMW_RESULT admw1001_SetDiagnosticsConfig(
- ADMW_DEVICE_HANDLE hDevice,
+ ADMW_DEVICE_HANDLE hDevice,
ADMW1001_DIAGNOSTICS_CONFIG *pDiagnosticsConfig);
/*!
@@ -283,8 +222,8 @@
* @note Settings are not applied until admw_ApplyConfigUpdates() is called
*/
ADMW_RESULT admw1001_SetChannelConfig(
- ADMW_DEVICE_HANDLE hDevice,
- ADMW1001_CHANNEL_ID eChannelId,
+ ADMW_DEVICE_HANDLE hDevice,
+ ADMW1001_CH_ID eChannelId,
ADMW1001_CHANNEL_CONFIG *pChannelConfig);
/*!
@@ -308,9 +247,9 @@
* @note Settings are not applied until admw_ApplyConfigUpdates() is called
*/
ADMW_RESULT admw1001_SetChannelCount(
- ADMW_DEVICE_HANDLE hDevice,
- ADMW1001_CHANNEL_ID eChannelId,
- uint32_t nMeasurementsPerCycle);
+ ADMW_DEVICE_HANDLE hDevice,
+ ADMW1001_CH_ID eChannelId,
+ uint32_t nMeasurementsPerCycle);
/*!
* @brief Update priority level for a specific channel.
@@ -329,9 +268,9 @@
* @note Settings are not applied until admw_ApplyConfigUpdates() is called
*/
ADMW_RESULT admw1001_SetChannelPriority(
- ADMW_DEVICE_HANDLE hDevice,
- ADMW1001_CHANNEL_ID eChannelId,
- ADMW1001_CHANNEL_PRIORITY ePriority);
+ ADMW_DEVICE_HANDLE hDevice,
+ ADMW1001_CH_ID eChannelId,
+ ADMW1001_CHANNEL_PRIORITY ePriority);
/*!
* @brief Update the measurement threshold limits for a specified channel.
@@ -359,10 +298,10 @@
* @note Settings are not applied until admw_ApplyConfigUpdates() is called
*/
ADMW_RESULT admw1001_SetChannelThresholdLimits(
- ADMW_DEVICE_HANDLE hDevice,
- ADMW1001_CHANNEL_ID eChannelId,
- float32_t fHighThresholdLimit,
- float32_t fLowThresholdLimit);
+ ADMW_DEVICE_HANDLE hDevice,
+ ADMW1001_CH_ID eChannelId,
+ float32_t fHighThresholdLimit,
+ float32_t fLowThresholdLimit);
/*!
@@ -382,9 +321,9 @@
* @note Settings are not applied until admw_ApplyConfigUpdates() is called
*/
ADMW_RESULT admw1001_SetSensorParameter(
- ADMW_DEVICE_HANDLE hDevice,
- ADMW1001_CHANNEL_ID eChannelId,
- float32_t fSensorParam);
+ ADMW_DEVICE_HANDLE hDevice,
+ ADMW1001_CH_ID eChannelId,
+ float32_t fSensorParam);
/*!
* @brief Update the extra settling time for a specified channel.
*
@@ -406,9 +345,9 @@
* @note Settings are not applied until admw_ApplyConfigUpdates() is called
*/
ADMW_RESULT admw1001_SetChannelSettlingTime(
- ADMW_DEVICE_HANDLE hDevice,
- ADMW1001_CHANNEL_ID eChannelId,
- uint32_t nSettlingTime);
+ ADMW_DEVICE_HANDLE hDevice,
+ ADMW1001_CH_ID eChannelId,
+ uint32_t nSettlingTime);
#ifdef __V2_3_CFG_FMT__
/*!
@@ -426,8 +365,8 @@
* @note Settings are not applied until admw_ApplyConfigUpdates() is called
*/
ADMW_RESULT admw1001_SetAdvancedAccess(
- ADMW_DEVICE_HANDLE const hDevice,
- ADMW1001_ADVANCED_ACCESS_KEY key);
+ ADMW_DEVICE_HANDLE hDevice,
+ ADMW1001_ADVANCED_ACCESS_KEY key);
#endif
/*!
@@ -454,11 +393,11 @@
* written to the device memory using @ref admw1001_SetLutData.
*/
ADMW_RESULT admw1001_AssembleLutData(
- ADMW1001_LUT * pLutBuffer,
- unsigned nLutBufferSize,
- unsigned const nNumTables,
- ADMW1001_LUT_DESCRIPTOR * const ppDesc[],
- ADMW1001_LUT_TABLE_DATA * const ppData[]);
+ ADMW1001_LUT *pLutBuffer,
+ unsigned nLutBufferSize,
+ unsigned const nNumTables,
+ ADMW1001_LUT_DESCRIPTOR *const ppDesc[],
+ ADMW1001_LUT_TABLE_DATA *const ppData[]);
/*!
* @brief Write Look-Up Table data to the device memory
@@ -475,8 +414,8 @@
* @note Settings are not applied until admw_ApplyConfigUpdates() is called
*/
ADMW_RESULT admw1001_SetLutData(
- ADMW_DEVICE_HANDLE const hDevice,
- ADMW1001_LUT * const pLutData);
+ ADMW_DEVICE_HANDLE hDevice,
+ ADMW1001_LUT *const pLutData);
/*!
* @brief Write Look-Up Table raw data to the device memory
@@ -494,8 +433,8 @@
* @note Settings are not applied until admw_ApplyConfigUpdates() is called
*/
ADMW_RESULT admw1001_SetLutDataRaw(
- ADMW_DEVICE_HANDLE const hDevice,
- ADMW1001_LUT_RAW * const pLutData);
+ ADMW_DEVICE_HANDLE hDevice,
+ ADMW1001_LUT_RAW *const pLutData);
/*!
* @brief Get the number of samples available when DATAREADY status is asserted.
@@ -521,13 +460,13 @@
* many samples to retrieve whenever the DATAREADY status is asserted.
*/
ADMW_RESULT admw1001_GetDataReadyModeInfo(
- ADMW_DEVICE_HANDLE const hDevice,
- ADMW_MEASUREMENT_MODE const eMeasurementMode,
- ADMW1001_OPERATING_MODE * const peOperatingMode,
- ADMW1001_DATAREADY_MODE * const peDataReadyMode,
- uint32_t * const pnSamplesPerDataready,
- uint32_t * const pnSamplesPerCycle,
- uint8_t * const pnBytesPerSample);
+ ADMW_DEVICE_HANDLE const hDevice,
+ ADMW_MEASUREMENT_MODE const eMeasurementMode,
+ ADMW1001_OPERATING_MODE *const peOperatingMode,
+ ADMW1001_DATAREADY_MODE *const peDataReadyMode,
+ uint32_t *const pnSamplesPerDataready,
+ uint32_t *const pnSamplesPerCycle,
+ uint8_t *const pnBytesPerSample);
#ifdef __cplusplus
}
@@ -537,4 +476,4 @@
* @}
*/
-#endif /* __ADMW1001_API_H__ */
\ No newline at end of file
+#endif /* __ADMW1001_API_H__ */