ADMW1001_Mbed_FW / Mbed OS EV-PRO-MW1001_Development

Mbed Development branch for MeasrueWare

inc/admw_config_types.h@79:dddd92b3a416, 2020-05-20 (annotated)

Committer:
Vkadaba
Date:
Wed May 20 06:19:06 2020 +0000
Revision:
79:dddd92b3a416
Parent:
6:9d393a9677f4 
Updated Mbed release notes;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Vkadaba 5:0728bde67bdb 1 /*
Vkadaba 6:9d393a9677f4 2 Copyright (c) 2019 Analog Devices, Inc.
Vkadaba 5:0728bde67bdb 3
Vkadaba 5:0728bde67bdb 4 All rights reserved.
Vkadaba 5:0728bde67bdb 5
Vkadaba 5:0728bde67bdb 6 Redistribution and use in source and binary forms, with or without modification,
Vkadaba 5:0728bde67bdb 7 are permitted provided that the following conditions are met:
Vkadaba 5:0728bde67bdb 8 - Redistributions of source code must retain the above copyright notice,
Vkadaba 5:0728bde67bdb 9 this list of conditions and the following disclaimer.
Vkadaba 5:0728bde67bdb 10 - Redistributions in binary form must reproduce the above copyright notice,
Vkadaba 5:0728bde67bdb 11 this list of conditions and the following disclaimer in the documentation
Vkadaba 5:0728bde67bdb 12 and/or other materials provided with the distribution.
Vkadaba 5:0728bde67bdb 13 - Modified versions of the software must be conspicuously marked as such.
Vkadaba 5:0728bde67bdb 14 - This software is licensed solely and exclusively for use with processors
Vkadaba 5:0728bde67bdb 15 manufactured by or for Analog Devices, Inc.
Vkadaba 5:0728bde67bdb 16 - This software may not be combined or merged with other code in any manner
Vkadaba 5:0728bde67bdb 17 that would cause the software to become subject to terms and conditions
Vkadaba 5:0728bde67bdb 18 which differ from those listed here.
Vkadaba 5:0728bde67bdb 19 - Neither the name of Analog Devices, Inc. nor the names of its
Vkadaba 5:0728bde67bdb 20 contributors may be used to endorse or promote products derived
Vkadaba 5:0728bde67bdb 21 from this software without specific prior written permission.
Vkadaba 5:0728bde67bdb 22 - The use of this software may or may not infringe the patent rights of one
Vkadaba 5:0728bde67bdb 23 or more patent holders. This license does not release you from the
Vkadaba 5:0728bde67bdb 24 requirement that you obtain separate licenses from these patent holders
Vkadaba 5:0728bde67bdb 25 to use this software.
Vkadaba 5:0728bde67bdb 26
Vkadaba 5:0728bde67bdb 27 THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES, INC. AND CONTRIBUTORS "AS IS" AND ANY
Vkadaba 5:0728bde67bdb 28 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
Vkadaba 5:0728bde67bdb 29 TITLE, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
Vkadaba 5:0728bde67bdb 30 NO EVENT SHALL ANALOG DEVICES, INC. OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
Vkadaba 5:0728bde67bdb 31 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, PUNITIVE OR CONSEQUENTIAL DAMAGES
Vkadaba 5:0728bde67bdb 32 (INCLUDING, BUT NOT LIMITED TO, DAMAGES ARISING OUT OF CLAIMS OF INTELLECTUAL
Vkadaba 5:0728bde67bdb 33 PROPERTY RIGHTS INFRINGEMENT; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
Vkadaba 5:0728bde67bdb 34 OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Vkadaba 5:0728bde67bdb 35 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
Vkadaba 5:0728bde67bdb 36 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
Vkadaba 5:0728bde67bdb 37 EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Vkadaba 5:0728bde67bdb 38 */
Vkadaba 5:0728bde67bdb 39
Vkadaba 6:9d393a9677f4 40 /*!
Vkadaba 5:0728bde67bdb 41 ******************************************************************************
Vkadaba 5:0728bde67bdb 42 * @file: admw_config_types.h
Vkadaba 5:0728bde67bdb 43 * @brief: Type definitions for ADMW API.
Vkadaba 5:0728bde67bdb 44 *-----------------------------------------------------------------------------
Vkadaba 5:0728bde67bdb 45 */
Vkadaba 5:0728bde67bdb 46
Vkadaba 5:0728bde67bdb 47 #ifndef __ADMW_CONFIG_TYPES_H__
Vkadaba 5:0728bde67bdb 48 #define __ADMW_CONFIG_TYPES_H__
Vkadaba 5:0728bde67bdb 49
Vkadaba 5:0728bde67bdb 50 #include "admw_platform.h"
Vkadaba 5:0728bde67bdb 51 #include "admw1001/admw1001_config.h"
Vkadaba 5:0728bde67bdb 52
Vkadaba 5:0728bde67bdb 53 /*! @addtogroup ADMW_Api ADMW Host Library API
Vkadaba 5:0728bde67bdb 54 * @{
Vkadaba 5:0728bde67bdb 55 */
Vkadaba 5:0728bde67bdb 56
Vkadaba 5:0728bde67bdb 57 #ifdef __cplusplus
Vkadaba 5:0728bde67bdb 58 extern "C" {
Vkadaba 5:0728bde67bdb 59 #endif
Vkadaba 5:0728bde67bdb 60
Vkadaba 5:0728bde67bdb 61 /*! A list of supported product identifiers */
Vkadaba 5:0728bde67bdb 62 typedef enum {
Vkadaba 5:0728bde67bdb 63 ADMW_PRODUCT_ID_ADMW1001 = 0x0020,
Vkadaba 6:9d393a9677f4 64 /*!< ADSNS1000 */
Vkadaba 5:0728bde67bdb 65 } ADMW_PRODUCT_ID;
Vkadaba 5:0728bde67bdb 66
Vkadaba 6:9d393a9677f4 67 /*! ADMW Configuration schema version */
Vkadaba 5:0728bde67bdb 68 typedef struct {
Vkadaba 5:0728bde67bdb 69 uint8_t major; /*!< Major version number */
Vkadaba 5:0728bde67bdb 70 uint8_t minor; /*!< Minor version number */
Vkadaba 5:0728bde67bdb 71 } ADMW_CONFIG_VERSION_ID;
Vkadaba 5:0728bde67bdb 72
Vkadaba 6:9d393a9677f4 73 /*! ADMW UUID string length */
Vkadaba 5:0728bde67bdb 74 #define ADMW_UUID_LEN 36
Vkadaba 5:0728bde67bdb 75
Vkadaba 6:9d393a9677f4 76 /*! ADMW global configuration details */
Vkadaba 5:0728bde67bdb 77 typedef struct {
Vkadaba 5:0728bde67bdb 78 const char configUuid[ADMW_UUID_LEN];
Vkadaba 5:0728bde67bdb 79 /*!< Optional unique identifier for this configuration */
Vkadaba 5:0728bde67bdb 80 ADMW_CONFIG_VERSION_ID versionId;
Vkadaba 5:0728bde67bdb 81 /*!< Identifies the schema version for this configuration */
Vkadaba 5:0728bde67bdb 82 ADMW_PRODUCT_ID productId;
Vkadaba 5:0728bde67bdb 83 /*!< Identify the product type for which this configuration is valid */
Vkadaba 5:0728bde67bdb 84 union
Vkadaba 5:0728bde67bdb 85 {
Vkadaba 5:0728bde67bdb 86 ADMW1001_CONFIG admw1001;
Vkadaba 6:9d393a9677f4 87 /*!< ADSNS1000 product configuration parameters. Used if productId
Vkadaba 6:9d393a9677f4 88 * selected is ADMW_PRODUCT_ID_ADSNS1000 */
Vkadaba 5:0728bde67bdb 89 };
Vkadaba 5:0728bde67bdb 90 /*!< Product-specific configuration parameters, selected based on productId.
Vkadaba 5:0728bde67bdb 91 * @note Other product variants may be added here in the future */
Vkadaba 5:0728bde67bdb 92 } ADMW_CONFIG;
Vkadaba 5:0728bde67bdb 93
Vkadaba 5:0728bde67bdb 94 #ifdef __cplusplus
Vkadaba 5:0728bde67bdb 95 }
Vkadaba 5:0728bde67bdb 96 #endif
Vkadaba 5:0728bde67bdb 97
Vkadaba 5:0728bde67bdb 98 /*!
Vkadaba 5:0728bde67bdb 99 * @}
Vkadaba 5:0728bde67bdb 100 */
Vkadaba 5:0728bde67bdb 101
Vkadaba 5:0728bde67bdb 102 #endif /* __ADMW_CONFIG_TYPES_H__ */