1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
|
/****************************************************************************
* apps/include/platform/configdata.h
*
* Copyright (C) 2013 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* 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 NuttX 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.
*
****************************************************************************/
#ifndef __APPS_INCLUDE_PLATFORM_CONFIGDATA_H
#define __APPS_INCLUDE_PLATFORM_CONFIGDATA_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <sys/types.h>
#ifdef CONFIG_PLATFORM_CONFIGDATA
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/****************************************************************************
* Public Types
****************************************************************************/
/* This enumeration identifies classes of configuration data */
enum config_data_e
{
/* Product identification */
CONFIGDATA_SERIALNUMBER = 0, /* Product serial number */
/* Prduct networking configuration */
CONFIGDATA_MACADDRESS, /* Assigned MAC address */
CONFIGDATA_IPADDRESS, /* Configured IP address */
CONFIGDATA_NETMASK, /* Configured network mask */
CONFIGDATA_DIPADDR, /* Configured default router address */
/* GUI configuration */
CONFIGDATA_TSCALIBRATION, /* Measured touchscreen calibration data */
CONFIGDATA_OTHER /* Other configuration data */
};
/****************************************************************************
* Public Data
****************************************************************************/
#undef EXTERN
#if defined(__cplusplus)
#define EXTERN extern "C"
extern "C" {
#els
#define EXTERN extern
#endif
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: platform_setconfig
*
* Description:
* Save platform-specific configuration data
*
* Input Parameter:
* id - Defines the class of configuration data
* instance - Defines which instance of configuration data. For example,
* if a board has two networks, then there would be two MAC
* addresses: instance 0 and instance 1
* configdata - The new configuration data to be saved
* datalen - The size of the configuration data in bytes.
*
* Returned Value:
* This is an end-user function, so it follows the normal convention:
* Returns the OK (zero) on success. On failure, it.returns -1 (ERROR) and
* sets errno appropriately.
*
* Values for the errno would include:
*
* EINVAL - The configdata point is invalid
* ENOSYS - The request ID/instance is not supported on this platform
*
* Other errors may be returned from lower level drivers on failure to
* write to the underlying media (if applicable)
*
****************************************************************************/
int platform_setconfig(enum config_data_e id, int instance,
FAR const uint8_t *configdata, size_t datalen);
/****************************************************************************
* Name: platform_getconfig
*
* Description:
* Get platform-specific configuration data
*
* Input Parameter:
* id - Defines the class of configuration data
* instance - Defines which instance of configuration data. For example,
* if a board has two networks, then there would be two MAC
* addresses: instance 0 and instance 1
* configdata - The user provided location to return the configuration data
* datalen - The expected size of the configuration data to be returned.
*
* Returned Value:
* This is an end-user function, so it follows the normal convention:
* Returns the OK (zero) on success. On failure, it.returns -1 (ERROR) and
* sets errno appropriately.
*
* Values for the errno would include:
*
* EINVAL - The configdata point is invalid
* ENOSYS - The request ID/instance is not supported on this platform
*
* Other errors may be returned from lower level drivers on failure to
* read from the underlying media (if applicable)
*
****************************************************************************/
int platform_getconfig(enum config_data_e id, int instance,
FAR uint8_t *configdata, size_t datalen);
#undef EXTERN
#if defined(__cplusplus)
}
#endif
#endif /* CONFIG_PLATFORM_CONFIGDATA */
#endif /* __APPS_INCLUDE_PLATFORM_CONFIGDATA_H */
|
