All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
vexflash.h
Go to the documentation of this file.
1 /*-----------------------------------------------------------------------------*/
2 /* */
3 /* Copyright (c) James Pearman */
4 /* 2013 */
5 /* All Rights Reserved */
6 /* */
7 /*-----------------------------------------------------------------------------*/
8 /* */
9 /* Module: vexflash.h */
10 /* Author: James Pearman */
11 /* Created: 3 Sept 2013 */
12 /* */
13 /* Revisions: */
14 /* V1.00 3 Sept 2013 - Initial release */
15 /* */
16 /*-----------------------------------------------------------------------------*/
17 /* */
18 /* This file is part of ConVEX. */
19 /* */
20 /* The author is supplying this software for use with the VEX cortex */
21 /* control system. ConVEX is free software; you can redistribute it */
22 /* and/or modify it under the terms of the GNU General Public License */
23 /* as published by the Free Software Foundation; either version 3 of */
24 /* the License, or (at your option) any later version. */
25 /* */
26 /* ConVEX is distributed in the hope that it will be useful, */
27 /* but WITHOUT ANY WARRANTY; without even the implied warranty of */
28 /* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
29 /* GNU General Public License for more details. */
30 /* */
31 /* You should have received a copy of the GNU General Public License */
32 /* along with this program. If not, see <http://www.gnu.org/licenses/>. */
33 /* */
34 /* A special exception to the GPL can be applied should you wish to */
35 /* distribute a combined work that includes ConVEX, without being obliged */
36 /* to provide the source code for any proprietary components. */
37 /* See the file exception.txt for full details of how and when the */
38 /* exception can be applied. */
39 /* */
40 /* The author can be contacted on the vex forums as jpearman */
41 /* or electronic mail using jbpearman_at_mac_dot_com */
42 /* Mentor for team 8888 RoboLancers, Pasadena CA. */
43 /* */
44 /*-----------------------------------------------------------------------------*/
45 
46 #ifndef VEXFLASH_H_
47 #define VEXFLASH_H_
48 
49 /*-----------------------------------------------------------------------------*/
50 /** @file vexflash.h
51  * @brief Store user parameters in Flash macros and prototypes
52 *//*---------------------------------------------------------------------------*/
53 
54 #include "stm32f10x_flash.h"
55 
56 // For user functions, these are not in the stm32 library
57 #define FLASH_SUCCESS 1
58 #define FLASH_ERROR_WRITE (-1)
59 #define FLASH_ERROR_WRITE_LIMIT (-2)
60 #define FLASH_ERROR_ERASE (-3)
61 #define FLASH_ERROR_ERASE_LIMIT (-4)
62 #define FLASH_ERROR (-5)
63 
64 // Number of user parameter words
65 // Do not change !!
66 #define USER_PARAM_WORDS 8
67 
68 // Structure to hold user parameters
69 typedef struct _user_param {
70  // storage for the NV data
71  unsigned char data[USER_PARAM_WORDS * 4];
72 
73  // useful debug data
74  int offset;
75  void *addr;
76  } user_param;
77 
78 
79 #ifdef __cplusplus
80 extern "C" {
81 #endif
82 
83 // public functions
84 user_param *vexFlashUserParamRead( void );
85 int16_t vexFlashUserParamWrite( user_param *u );
86 int16_t vexFlashUserParamInit( void );
87 
88 #ifdef __cplusplus
89 }
90 #endif
91 
92 #endif // VEXFLASH_H_