blob: 5513d4239965c03d63600ce0c9883747f88f1bd0 (
plain)
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
|
//
// Copyright 2014 Ettus Research LLC
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
//
#ifndef INCLUDED_N230_EEPROM_H
#define INCLUDED_N230_EEPROM_H
#include <stdint.h>
#ifndef __cplusplus
#include <stdbool.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
#define N230_NUM_ETH_PORTS 2
#define N230_MAX_NUM_ETH_PORTS 2
#if (N230_NUM_ETH_PORTS > N230_MAX_NUM_ETH_PORTS)
#error
#endif
#define N230_EEPROM_VER_MAJOR 1
#define N230_EEPROM_VER_MINOR 0
#define N230_EEPROM_SERIAL_LEN 9
#define N230_EEPROM_NAME_LEN 32
typedef struct
{
uint8_t mac_addr[6];
uint8_t _pad[2];
uint32_t subnet;
uint32_t ip_addr;
} n230_eth_eeprom_map_t;
typedef struct
{
//Data format version
uint16_t data_version_major;
uint16_t data_version_minor;
//HW identification info
uint16_t hw_revision;
uint16_t hw_product;
uint8_t serial[N230_EEPROM_SERIAL_LEN];
uint8_t _pad0[20 - N230_EEPROM_SERIAL_LEN];
//Ethernet specific
uint32_t gateway;
n230_eth_eeprom_map_t eth_info[N230_MAX_NUM_ETH_PORTS];
//User specific
uint8_t user_name[N230_EEPROM_NAME_LEN];
} n230_eeprom_map_t;
#ifdef __cplusplus
} //extern "C"
#endif
// The following definitions are only useful in firmware. Exclude in host code.
#ifndef __cplusplus
/*!
* Read the eeprom and update caches.
* Returns true if read was successful.
* If the read was not successful then the cache is initialized with
* default values and marked as dirty.
*/
bool read_n230_eeprom();
/*!
* Write the contents of the cache to the eeprom.
* Returns true if write was successful.
*/
bool write_n230_eeprom();
/*!
* Returns the dirty state of the cache.
*/
bool is_n230_eeprom_cache_dirty();
/*!
* Returns a const pointer to the EEPROM map.
*/
const n230_eeprom_map_t* get_n230_const_eeprom_map();
/*!
* Returns the settings for the the 'iface'th ethernet interface
*/
const n230_eth_eeprom_map_t* get_n230_ethernet_info(uint32_t iface);
/*!
* Returns a non-const pointer to the EEPROM map. Will mark the cache as dirty.
*/
n230_eeprom_map_t* get_n230_eeprom_map();
/*!
* FPGA Image operations
*/
inline void read_n230_fpga_image_page(uint32_t offset, void *buf, uint32_t num_bytes);
inline bool write_n230_fpga_image_page(uint32_t offset, const void *buf, uint32_t num_bytes);
inline bool erase_n230_fpga_image_sector(uint32_t offset);
#endif //ifdef __cplusplus
#endif /* INCLUDED_N230_EEPROM_H */
|
