TI-RTOS Drivers  tidrivers_full_2_20_00_08
NVSCC3200.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2016, Texas Instruments Incorporated
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * * Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * * Neither the name of Texas Instruments Incorporated nor the names of
17  * its contributors may be used to endorse or promote products derived
18  * from this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
22  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
30  * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 /*
34  * ======== NVSCC3200.h ========
35  */
36 
37 #ifndef ti_drivers_nvs_NVSCC3200__include
38 #define ti_drivers_nvs_NVSCC3200__include
39 
40 #include <stdint.h>
41 #include <stdbool.h>
42 
43 #if defined (__cplusplus)
44 extern "C" {
45 #endif
46 
66 #define NVSCC3200_CMD_SET_COPYBLOCK NVS_CMD_RESERVED + 0
67 
76 #define NVSCC3200_STATUS_ECOPYBLOCK (NVS_STATUS_RESERVED - 1)
77 
85 {
86  void *copyBlock;
88 
89 /* NVS function table pointer */
90 extern const NVS_FxnTable NVSCC3200_fxnTable;
91 
115 typedef struct NVSCC3200_HWAttrs {
116  void *copyBlock;
119  size_t blockSize;
121 
122 /*
123  * @brief NVSCC3200 Object
124  *
125  * The application must not access any member variables of this structure!
126  */
127 typedef struct NVSCC3200_Object {
128  bool opened; /* Has the obj been opened */
129  int id; /* Index to use for file name */
131 
132 #if defined (__cplusplus)
133 }
134 #endif /* defined (__cplusplus) */
135 
137 #endif /* ti_drivers_nvs_NVSCC3200__include */
struct NVSCC3200_HWAttrs NVSCC3200_HWAttrs
NVSCC3200 attributes.
const NVS_FxnTable NVSCC3200_fxnTable
struct NVSCC3200_Object NVSCC3200_Object
void * copyBlock
Definition: NVSCC3200.h:86
NVSCC3200 command structure for setting copy block.
Definition: NVSCC3200.h:84
size_t blockSize
Definition: NVSCC3200.h:119
int id
Definition: NVSCC3200.h:129
struct NVSCC3200_CmdSetCopyBlockArgs NVSCC3200_CmdSetCopyBlockArgs
NVSCC3200 command structure for setting copy block.
void * copyBlock
Definition: NVSCC3200.h:116
NVSCC3200 attributes.
Definition: NVSCC3200.h:115
Definition: NVSCC3200.h:127
bool opened
Definition: NVSCC3200.h:128
The definition of an NVS function table that contains the required set of functions to control a spec...
Definition: NVS.h:313
Copyright 2016, Texas Instruments Incorporated