NVSTiva.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015, Texas Instruments Incorporated
 * 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 Texas Instruments Incorporated 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 OWNER 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.
 */

/*
 *  ======== NVSTiva.h ========
 */

#ifndef ti_drivers_nvs_NVSTiva__include
#define ti_drivers_nvs_NVSTiva__include

#include <stdint.h>
#include <stdbool.h>

#if defined (__cplusplus)
extern "C" {
#endif

#define NVSTiva_STATUS_ECOPYBLOCK      (NVS_STATUS_RESERVED - 0)

#define NVSTiva_CMD_SET_COPYBLOCK      NVS_CMD_RESERVED + 0

typedef struct NVSTiva_CmdSetCopyBlockArgs
{
    void *copyBlock;     
    bool isRam;          
} NVSTiva_CmdSetCopyBlockArgs;

/* NVS function table pointer */
extern const NVS_FxnTable NVSTiva_fxnTable;

typedef struct NVSTiva_HWAttrs {
    void         *block;      
    size_t        blockSize;  
    void         *copyBlock;  
    bool          isRam;      
} NVSTiva_HWAttrs;

/*
 *  @brief      NVSTiva Object
 *
 *  The application must not access any member variables of this structure!
 */
typedef struct NVSTiva_Object {
    bool                 opened;   /* Has the obj been opened */
} NVSTiva_Object;

#if defined (__cplusplus)
}
#endif /* defined (__cplusplus) */

#endif /* ti_drivers_nvs_NVSTiva__include */