cascoda_settings.h

Go to the documentation of this file.

/*
 *  Copyright (c) 2016, The OpenThread Authors.
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions are met:
 *  1. Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  2. 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.
 *  3. Neither the name of the copyright holder nor the
 *     names of its contributors may be used to endorse or promote products
 *     derived from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 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 CASCODA_SETTINGS_H
#define CASCODA_SETTINGS_H
 
#include "ca821x_api.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct settingBuffer
{
    const uint8_t *value;  
    uint16_t       length; 
};
 
void caUtilSettingsInit(struct ca821x_dev *aInstance, const char *aApplicationName, uint32_t aNodeId);
 
void caUtilSettingsDeinit(struct ca821x_dev *aInstance);
 
ca_error caUtilSettingsGet(struct ca821x_dev *aInstance,
                           uint16_t           aKey,
                           int                aIndex,
                           uint8_t           *aValue,
                           uint16_t          *aValueLength);
 
ca_error caUtilSettingsSet(struct ca821x_dev *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength);
 
ca_error caUtilSettingsAdd(struct ca821x_dev *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength);
 
ca_error caUtilSettingsDelete(struct ca821x_dev *aInstance, uint16_t aKey, int aIndex);
 
void caUtilSettingsWipe(struct ca821x_dev *aInstance, const char *aApplicationName, uint32_t aNodeId);
 
ca_error caUtilSettingsGetAddress(struct ca821x_dev *aInstance,
                                  uint16_t           aKey,
                                  int                aIndex,
                                  void             **aValue,
                                  uint16_t          *aValueLength);
 
ca_error caUtilSettingsAddVector(struct ca821x_dev    *aInstance,
                                 uint16_t              aKey,
                                 struct settingBuffer *aVector,
                                 size_t                aCount);
 
#ifdef __cplusplus
} // extern "C"
#endif
 
#endif // CASCODA_SETTINGS_H