-
Notifications
You must be signed in to change notification settings - Fork 21
/
FRAM_MB85RC_I2C.h
183 lines (156 loc) · 6.83 KB
/
FRAM_MB85RC_I2C.h
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/**************************************************************************/
/*!
@file FRAM_MB85RC_I2C.h
@author SOSAndroid.fr (E. Ha.)
@section HISTORY
v1.0 - First release
v1.0.1 - Robustness enhancement
v1.0.2 - fix constructor, introducing byte move in memory
v1.0.3 - fix writeLong() function
v1.0.4 - fix constructor call error
v1.0.5 - Enlarge density chip support by making check more flexible, Error codes not anymore hardcoded, add connect example, add Cypress FM24 & CY15B series comment.
v1.1.0b - adding support for devices without device IDs + 4K & 16 K devices support
v1.2.0 - Uses reinterpret_cast instead of bit shift / masking for performance. Breaks backward compatibility with previous code - See PR#6
v1.2.1 - Fix comment line #76 (issue #11), max address define statement for 512K & 1M chips (issue 13)
v1.2.2 - Fix issue #16
Driver for the MB85RC I2C FRAM from Fujitsu.
@section LICENSE
Software License Agreement (BSD License)
Copyright (c) 2013, SOSAndroid.fr (E. Ha.)
All rights reserved.
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 of the copyright holders 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 ''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 HOLDER 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 _FRAM_MB85RC_I2C_H_
#define _FRAM_MB85RC_I2C_H_
#if ARDUINO >= 100
#include <Arduino.h>
#else
#include <WProgram.h>
#endif
#include <Wire.h>
// Enabling debug I2C - comment to disable / normal operations
#ifndef SERIAL_DEBUG
#define SERIAL_DEBUG 1
#endif
// IDs
//Manufacturers codes
#define FUJITSU_MANUFACT_ID 0x00A
#define CYPRESS_MANUFACT_ID 0x004
#define MANUALMODE_MANUFACT_ID 0xF00
#define MANUALMODE_PRODUCT_ID 0xF00
#define MANUALMODE_DENSITY_ID 0xF00
// The density codes gives the memory's adressing scheme
#define DENSITY_MB85RC04V 0x00 // 4K
#define DENSITY_MB85RC64TA 0x03 // 64K
#define DENSITY_MB85RC256V 0x05 // 256K
#define DENSITY_MB85RC512T 0x06 // 512K
#define DENSITY_MB85RC1MT 0x07 // 1M
#define DENSITY_CY15B128J 0x01 // 128K - FM24V01A also
#define DENSITY_CY15B256J 0x02 // 256K - FM24V02A also
#define DENSITY_FM24V05 0x03 // 512K
#define DENSITY_FM24V10 0x04 // 1024K
// Devices MB85RC16, MB85RC16V, MB85RC64A, MB85RC64V and MB85RC128A do not support Device ID reading
// FM24W256,FM24CL64B, FM24C64B, FM24C16B, FM24C04B, FM24CL04B
#define MAXADDRESS_04 512
#define MAXADDRESS_16 2048
#define MAXADDRESS_64 8192
#define MAXADDRESS_128 16384
#define MAXADDRESS_256 32768
#define MAXADDRESS_512 65535
#define MAXADDRESS_1024 65535 // 1M devices are in fact managed as 2 512 devices from lib point of view > create 2 instances of the object with each a differnt address
// Adresses
#define MB85RC_ADDRESS_A000 0x50
#define MB85RC_ADDRESS_A001 0x51
#define MB85RC_ADDRESS_A010 0x52
#define MB85RC_ADDRESS_A011 0x53
#define MB85RC_ADDRESS_A100 0x54
#define MB85RC_ADDRESS_A101 0x55
#define MB85RC_ADDRESS_A110 0x56
#define MB85RC_ADDRESS_A111 0x57
#define MB85RC_DEFAULT_ADDRESS MB85RC_ADDRESS_A000
//Special commands
#define MASTER_CODE 0xF8
#define SLEEP_MODE 0x86 //Cypress codes, not used here
#define HIGH_SPEED 0x08 //Cypress codes, not used here
// Managing Write protect pin
#define MANAGE_WP true //false if WP pin remains not connected
#define DEFAULT_WP_PIN 13 //write protection pin - active high, write enabled when low
#define DEFAULT_WP_STATUS false //false means protection is off - write is enabled
// Error management
#define ERROR_0 0 // Success
#define ERROR_1 1 // Data too long to fit the transmission buffer on Arduino
#define ERROR_2 2 // received NACK on transmit of address
#define ERROR_3 3 // received NACK on transmit of data
#define ERROR_4 4 // Serial seems not available
#define ERROR_5 5 // Not referenced device ID
#define ERROR_6 6 // Unused
#define ERROR_7 7 // Fram chip unidentified
#define ERROR_8 8 // Number of bytes asked to read null
#define ERROR_9 9 // Bit position out of range
#define ERROR_10 10 // Not permitted opération
#define ERROR_11 11 // Memory address out of range
class FRAM_MB85RC_I2C {
public:
FRAM_MB85RC_I2C(void);
FRAM_MB85RC_I2C(uint8_t address, boolean wp);
FRAM_MB85RC_I2C(uint8_t address, boolean wp, int pin);
FRAM_MB85RC_I2C(uint8_t address, boolean wp, int pin, uint16_t chipDensity);
void begin(void);
byte checkDevice(void);
byte readBit(uint16_t framAddr, uint8_t bitNb, byte *bit);
byte setOneBit(uint16_t framAddr, uint8_t bitNb);
byte clearOneBit(uint16_t framAddr, uint8_t bitNb);
byte toggleBit(uint16_t framAddr, uint8_t bitNb);
byte readArray (uint16_t framAddr, byte items, uint8_t value[]);
byte writeArray (uint16_t framAddr, byte items, uint8_t value[]);
byte readByte (uint16_t framAddr, uint8_t *value);
byte writeByte (uint16_t framAddr, uint8_t value);
byte copyByte (uint16_t origAddr, uint16_t destAddr);
byte readWord(uint16_t framAddr, uint16_t *value);
byte writeWord(uint16_t framAddr, uint16_t value);
byte readLong(uint16_t framAddr, uint32_t *value);
byte writeLong(uint16_t framAddr, uint32_t value);
byte getOneDeviceID(uint8_t idType, uint16_t *id);
boolean isReady(void);
boolean getWPStatus(void);
byte enableWP(void);
byte disableWP(void);
byte eraseDevice(void);
private:
uint8_t i2c_addr;
boolean _framInitialised;
boolean _manualMode;
uint16_t manufacturer;
uint16_t productid;
uint16_t densitycode;
uint16_t density;
uint16_t maxaddress;
int wpPin;
boolean wpStatus;
byte getDeviceIDs(void);
byte setDeviceIDs(void);
byte initWP(boolean wp);
byte deviceIDs2Serial(void);
void I2CAddressAdapt(uint16_t framAddr);
};
#endif