IONX / EALib

Update version of EALib.

Dependencies:   FATFileSystem

Fork of EALib by IONX

SPIFI.h@18:9f1f1a8b4729, 2014-10-27 (annotated)

Committer:
embeddedartists
Date:
Mon Oct 27 10:18:08 2014 +0000
Revision:
18:9f1f1a8b4729
Parent:
12:15597e45eea0 
Added support for Macronix QSPI flash

Who changed what in which revision?

UserRevisionLine numberNew contents of line
embeddedartists 12:15597e45eea0 1 /*
embeddedartists 12:15597e45eea0 2 * Copyright 2013 Embedded Artists AB
embeddedartists 12:15597e45eea0 3 *
embeddedartists 12:15597e45eea0 4 * Licensed under the Apache License, Version 2.0 (the "License");
embeddedartists 12:15597e45eea0 5 * you may not use this file except in compliance with the License.
embeddedartists 12:15597e45eea0 6 * You may obtain a copy of the License at
embeddedartists 12:15597e45eea0 7 *
embeddedartists 12:15597e45eea0 8 * http://www.apache.org/licenses/LICENSE-2.0
embeddedartists 12:15597e45eea0 9 *
embeddedartists 12:15597e45eea0 10 * Unless required by applicable law or agreed to in writing, software
embeddedartists 12:15597e45eea0 11 * distributed under the License is distributed on an "AS IS" BASIS,
embeddedartists 12:15597e45eea0 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
embeddedartists 12:15597e45eea0 13 * See the License for the specific language governing permissions and
embeddedartists 12:15597e45eea0 14 * limitations under the License.
embeddedartists 12:15597e45eea0 15 */
embeddedartists 8:fe3cb3fbb64e 16
embeddedartists 8:fe3cb3fbb64e 17 #ifndef SPIFI_H
embeddedartists 8:fe3cb3fbb64e 18 #define SPIFI_H
embeddedartists 8:fe3cb3fbb64e 19
embeddedartists 8:fe3cb3fbb64e 20 #include "mbed.h"
embeddedartists 8:fe3cb3fbb64e 21 #include "spifi_rom_api.h"
embeddedartists 8:fe3cb3fbb64e 22
embeddedartists 8:fe3cb3fbb64e 23 /**
embeddedartists 8:fe3cb3fbb64e 24 * SPIFI Example
embeddedartists 8:fe3cb3fbb64e 25 *
embeddedartists 8:fe3cb3fbb64e 26 * @code
embeddedartists 8:fe3cb3fbb64e 27 * #include "mbed.h"
embeddedartists 8:fe3cb3fbb64e 28 * #include "SPIFI.h"
embeddedartists 8:fe3cb3fbb64e 29 *
embeddedartists 8:fe3cb3fbb64e 30 * int main(void) {
embeddedartists 8:fe3cb3fbb64e 31 * SPIFI::SpifiError err;
embeddedartists 8:fe3cb3fbb64e 32 *
embeddedartists 8:fe3cb3fbb64e 33 * err = SPIFI::instance().init();
embeddedartists 8:fe3cb3fbb64e 34 * if (err != SPIFI::Ok) {
embeddedartists 8:fe3cb3fbb64e 35 * printf("Failed to initialize SPIFI, error %d\n", err);
embeddedartists 8:fe3cb3fbb64e 36 * }
embeddedartists 8:fe3cb3fbb64e 37 *
embeddedartists 8:fe3cb3fbb64e 38 * // Write "Hello World!" into the first bytes of the SPIFI
embeddedartists 8:fe3cb3fbb64e 39 * char buff[20] = "Hello World!";
embeddedartists 8:fe3cb3fbb64e 40 * err = SPIFI::instance().program(0, strlen(buff)+1, buff, SPIFI::EraseAsRequired);
embeddedartists 8:fe3cb3fbb64e 41 * if (err != SPIFI::Ok) {
embeddedartists 8:fe3cb3fbb64e 42 * printf("Failed to write to SPIFI, error %d\n", err);
embeddedartists 8:fe3cb3fbb64e 43 * }
embeddedartists 8:fe3cb3fbb64e 44 *
embeddedartists 8:fe3cb3fbb64e 45 * // Now verify that it can be read
embeddedartists 8:fe3cb3fbb64e 46 * if (memcmp((char*)SPIFI::SpifiMemBase, buff, strlen(buff)+1) == 0) {
embeddedartists 8:fe3cb3fbb64e 47 * printf("Readback from memory OK: '%s'\n", SPIFI::SpifiMemBase);
embeddedartists 8:fe3cb3fbb64e 48 * } else {
embeddedartists 8:fe3cb3fbb64e 49 * printf("Spifi does not contain the correct data!\n");
embeddedartists 8:fe3cb3fbb64e 50 * }
embeddedartists 8:fe3cb3fbb64e 51 * }
embeddedartists 8:fe3cb3fbb64e 52 * @endcode
embeddedartists 8:fe3cb3fbb64e 53 */
embeddedartists 8:fe3cb3fbb64e 54 class SPIFI {
embeddedartists 8:fe3cb3fbb64e 55 public:
embeddedartists 8:fe3cb3fbb64e 56
embeddedartists 8:fe3cb3fbb64e 57 enum Constants {
embeddedartists 8:fe3cb3fbb64e 58 SpifiMemBase = 0x28000000
embeddedartists 8:fe3cb3fbb64e 59 };
embeddedartists 8:fe3cb3fbb64e 60
embeddedartists 8:fe3cb3fbb64e 61 enum Options {
embeddedartists 8:fe3cb3fbb64e 62 ForceErase = (0<<2),
embeddedartists 8:fe3cb3fbb64e 63 EraseAsRequired = (1<<2),
embeddedartists 8:fe3cb3fbb64e 64 CallerErase = (1<<3)
embeddedartists 8:fe3cb3fbb64e 65 };
embeddedartists 8:fe3cb3fbb64e 66
embeddedartists 8:fe3cb3fbb64e 67 enum SpifiError {
embeddedartists 8:fe3cb3fbb64e 68 Ok = 0,
embeddedartists 8:fe3cb3fbb64e 69 Uninitialized = 1,
embeddedartists 8:fe3cb3fbb64e 70 Verification = 2,
embeddedartists 8:fe3cb3fbb64e 71 SameAddress = 3,
embeddedartists 8:fe3cb3fbb64e 72 UnknownError = 4,
embeddedartists 8:fe3cb3fbb64e 73 InternalError = 0x20002,
embeddedartists 8:fe3cb3fbb64e 74 Timeout = 0x20003,
embeddedartists 8:fe3cb3fbb64e 75 OperandError = 0x20004,
embeddedartists 8:fe3cb3fbb64e 76 Status = 0x20005,
embeddedartists 8:fe3cb3fbb64e 77 ExtDeviceId = 0x20006,
embeddedartists 8:fe3cb3fbb64e 78 DeviceId = 0x20007,
embeddedartists 8:fe3cb3fbb64e 79 DeviceType = 0x20008,
embeddedartists 8:fe3cb3fbb64e 80 Manufacturer = 0x20009,
embeddedartists 8:fe3cb3fbb64e 81 InvalidJDECId = 0x2000A,
embeddedartists 8:fe3cb3fbb64e 82 EraseConflict = 0x2000B,
embeddedartists 8:fe3cb3fbb64e 83 };
embeddedartists 8:fe3cb3fbb64e 84
embeddedartists 8:fe3cb3fbb64e 85 enum Device {
embeddedartists 18:9f1f1a8b4729 86 Spansion_S25FL032, /* Manufacturer: 0x01, devType: 0x02, devID: 0x15 */
embeddedartists 18:9f1f1a8b4729 87 Winbond_W25Q64FV, /* Manufacturer: 0xEF, devType: 0x40, devID: 0x17 */
embeddedartists 18:9f1f1a8b4729 88 Macronix_MX25L6435EM2I, /* Manufacturer: 0xC2, devType: 0x20, devID: 0x17 */
embeddedartists 8:fe3cb3fbb64e 89 UnknownDevice
embeddedartists 8:fe3cb3fbb64e 90 };
embeddedartists 8:fe3cb3fbb64e 91
embeddedartists 8:fe3cb3fbb64e 92 static SPIFI& instance()
embeddedartists 8:fe3cb3fbb64e 93 {
embeddedartists 8:fe3cb3fbb64e 94 static SPIFI singleton;
embeddedartists 8:fe3cb3fbb64e 95 return singleton;
embeddedartists 8:fe3cb3fbb64e 96 }
embeddedartists 8:fe3cb3fbb64e 97
embeddedartists 8:fe3cb3fbb64e 98
embeddedartists 8:fe3cb3fbb64e 99 /** Initializes the SPIFI ROM driver making the content of the external serial flash available
embeddedartists 8:fe3cb3fbb64e 100 *
embeddedartists 8:fe3cb3fbb64e 101 * @returns
embeddedartists 8:fe3cb3fbb64e 102 * Ok on success
embeddedartists 8:fe3cb3fbb64e 103 * An error code on failure
embeddedartists 8:fe3cb3fbb64e 104 */
embeddedartists 8:fe3cb3fbb64e 105 SpifiError init();
embeddedartists 8:fe3cb3fbb64e 106
embeddedartists 8:fe3cb3fbb64e 107 /** Returns the detected external serial flash
embeddedartists 8:fe3cb3fbb64e 108 *
embeddedartists 8:fe3cb3fbb64e 109 * @returns
embeddedartists 8:fe3cb3fbb64e 110 * The detected device or UnknownDevice
embeddedartists 8:fe3cb3fbb64e 111 */
embeddedartists 8:fe3cb3fbb64e 112 Device device() { return _device; }
embeddedartists 8:fe3cb3fbb64e 113
embeddedartists 8:fe3cb3fbb64e 114 /** Returns the size (in bytes) of the external serial flash
embeddedartists 8:fe3cb3fbb64e 115 *
embeddedartists 8:fe3cb3fbb64e 116 * @returns
embeddedartists 8:fe3cb3fbb64e 117 * The size in bytes
embeddedartists 8:fe3cb3fbb64e 118 */
embeddedartists 8:fe3cb3fbb64e 119 uint32_t memorySize() { return _memorySize; }
embeddedartists 8:fe3cb3fbb64e 120
embeddedartists 8:fe3cb3fbb64e 121 /** Returns the size of an erase block (in bytes) on the external serial flash
embeddedartists 8:fe3cb3fbb64e 122 *
embeddedartists 8:fe3cb3fbb64e 123 * @returns
embeddedartists 8:fe3cb3fbb64e 124 * The erase block size in bytes
embeddedartists 8:fe3cb3fbb64e 125 */
embeddedartists 8:fe3cb3fbb64e 126 uint32_t eraseBlockSize() { return _eraseBlockSize; }
embeddedartists 8:fe3cb3fbb64e 127
embeddedartists 8:fe3cb3fbb64e 128 /** Returns the address where the verifcation failed. Use only after a Verification error code
embeddedartists 8:fe3cb3fbb64e 129 * has been retured from one of the other functions
embeddedartists 8:fe3cb3fbb64e 130 *
embeddedartists 8:fe3cb3fbb64e 131 * @returns
embeddedartists 8:fe3cb3fbb64e 132 * The address to where the program or erase operation failed
embeddedartists 8:fe3cb3fbb64e 133 */
embeddedartists 8:fe3cb3fbb64e 134 uint32_t getVerificationErrorAddr() { return _verError; }
embeddedartists 8:fe3cb3fbb64e 135
embeddedartists 8:fe3cb3fbb64e 136 /** Used by the QSPIFileSystem class to get access to all spifi internal data.
embeddedartists 8:fe3cb3fbb64e 137 *
embeddedartists 8:fe3cb3fbb64e 138 * @param initData The parameter returned by spifi_init
embeddedartists 8:fe3cb3fbb64e 139 * @param romPtr The location of the SPIFI ROM driver in memory
embeddedartists 8:fe3cb3fbb64e 140 */
embeddedartists 8:fe3cb3fbb64e 141 void internalData(SPIFIobj** initData, const SPIFI_RTNS** romPtr) { *initData = _romData; *romPtr = _spifi; }
embeddedartists 8:fe3cb3fbb64e 142
embeddedartists 8:fe3cb3fbb64e 143 /** Copies len data from src to dest. This function will split len > 256 into writes of 256 bytes each.
embeddedartists 8:fe3cb3fbb64e 144 *
embeddedartists 8:fe3cb3fbb64e 145 * Programming means that a bit can either be left at 0, or programmed from 1 to 0. Changing bits from 0 to 1 requires an erase operation.
embeddedartists 8:fe3cb3fbb64e 146 * While bits can be individually programmed from 1 to 0, erasing bits from 0 to 1 must be done in larger chunks (manufacturer dependant
embeddedartists 8:fe3cb3fbb64e 147 * but typically 4Kbyte to 64KByte at a time).
embeddedartists 8:fe3cb3fbb64e 148 *
embeddedartists 8:fe3cb3fbb64e 149 * Specify how/when erasing is done with the options parameter:
embeddedartists 8:fe3cb3fbb64e 150 *
embeddedartists 8:fe3cb3fbb64e 151 * - ForceErase causes len bytes to be erased starting at dest. If a scratch buffer (must be the size of an erase block) is
embeddedartists 8:fe3cb3fbb64e 152 * provided then only the len bytes will be erased. If no scratch buffer is provided then the erase block surrounding
embeddedartists 8:fe3cb3fbb64e 153 * dest will be erased.
embeddedartists 8:fe3cb3fbb64e 154 *
embeddedartists 8:fe3cb3fbb64e 155 * - EraseAsRequired tests if the destination can be written to without erasing. If it can then no erasing is done. If it
embeddedartists 8:fe3cb3fbb64e 156 * can't then behaviour is the same as if ForceErase was specified.
embeddedartists 8:fe3cb3fbb64e 157 *
embeddedartists 8:fe3cb3fbb64e 158 * - CallerErase tests if the destination can be written to without erasing. If it can then a data is written. If it
embeddedartists 8:fe3cb3fbb64e 159 * can't then an error code is returned and nothing is written.
embeddedartists 8:fe3cb3fbb64e 160 *
embeddedartists 8:fe3cb3fbb64e 161 * Scratch should be NULL or the address of an area of RAM that the SPIFI driver can use
embeddedartists 8:fe3cb3fbb64e 162 * to save data during erase operations. If provided, the scratch area should be as large
embeddedartists 8:fe3cb3fbb64e 163 * as the smallest erase size that is available throughout the serial flash device. If scratch
embeddedartists 8:fe3cb3fbb64e 164 * is NULL (zero) and an erase is necessary, any bytes in the first erase block before dest
embeddedartists 8:fe3cb3fbb64e 165 * are left in erased state (all ones), as are any bytes in the last erase block after dest + len
embeddedartists 8:fe3cb3fbb64e 166 *
embeddedartists 8:fe3cb3fbb64e 167 * @param dest Address to write to, highest byte must be 0x00 or 0x28 as in 0x28000000
embeddedartists 8:fe3cb3fbb64e 168 * @param len Number of bytes to write
embeddedartists 8:fe3cb3fbb64e 169 * @param src Data to write
embeddedartists 8:fe3cb3fbb64e 170 * @param options How to handle content of destination
embeddedartists 8:fe3cb3fbb64e 171 * @param verify Should all writes be verified or not
embeddedartists 8:fe3cb3fbb64e 172 * @param scratch Used with ForceErase and EraseAsRequired option to preserve content of flash outside of
embeddedartists 8:fe3cb3fbb64e 173 * written area. Size of buffer must be at least the size of one erase block.
embeddedartists 8:fe3cb3fbb64e 174 *
embeddedartists 8:fe3cb3fbb64e 175 * @returns
embeddedartists 8:fe3cb3fbb64e 176 * Ok on success
embeddedartists 8:fe3cb3fbb64e 177 * An error code on failure
embeddedartists 8:fe3cb3fbb64e 178 */
embeddedartists 8:fe3cb3fbb64e 179 SpifiError program(uint32_t dest, unsigned len, char* src, Options options, bool verify=false, char* scratch=NULL);
embeddedartists 8:fe3cb3fbb64e 180
embeddedartists 8:fe3cb3fbb64e 181 /** Erases the content of the memory at the specified address
embeddedartists 8:fe3cb3fbb64e 182 *
embeddedartists 8:fe3cb3fbb64e 183 * Scratch should be NULL or the address of an area of RAM that the SPIFI driver can use
embeddedartists 8:fe3cb3fbb64e 184 * to save data during erase operations. If provided, the scratch area should be as large
embeddedartists 8:fe3cb3fbb64e 185 * as the smallest erase size that is available throughout the serial flash device. If scratch
embeddedartists 8:fe3cb3fbb64e 186 * is NULL (zero) and an erase is necessary, any bytes in the first erase block before dest
embeddedartists 8:fe3cb3fbb64e 187 * are left in erased state (all ones), as are any bytes in the last erase block after dest + len
embeddedartists 8:fe3cb3fbb64e 188 *
embeddedartists 8:fe3cb3fbb64e 189 * @param dest Address to start erasing at, highest byte must be 0x00 or 0x28 as in 0x28000000
embeddedartists 8:fe3cb3fbb64e 190 * @param len Number of bytes to erase
embeddedartists 8:fe3cb3fbb64e 191 * @param verify Should the erased area be verified to make sure it is all 0xff
embeddedartists 8:fe3cb3fbb64e 192 * @param scratch Used to preserve content of flash outside of erased area.
embeddedartists 8:fe3cb3fbb64e 193 * Size of buffer must be at least the size of one erase block.
embeddedartists 8:fe3cb3fbb64e 194 *
embeddedartists 8:fe3cb3fbb64e 195 * @returns
embeddedartists 8:fe3cb3fbb64e 196 * Ok on success
embeddedartists 8:fe3cb3fbb64e 197 * An error code on failure
embeddedartists 8:fe3cb3fbb64e 198 */
embeddedartists 8:fe3cb3fbb64e 199 SpifiError erase(uint32_t dest, unsigned len, char* src, bool verify=false, char* scratch=NULL);
embeddedartists 8:fe3cb3fbb64e 200
embeddedartists 8:fe3cb3fbb64e 201
embeddedartists 8:fe3cb3fbb64e 202 private:
embeddedartists 8:fe3cb3fbb64e 203
embeddedartists 8:fe3cb3fbb64e 204 uint32_t _verError;
embeddedartists 8:fe3cb3fbb64e 205
embeddedartists 8:fe3cb3fbb64e 206 bool _initialized;
embeddedartists 8:fe3cb3fbb64e 207
embeddedartists 8:fe3cb3fbb64e 208 Device _device;
embeddedartists 8:fe3cb3fbb64e 209 uint32_t _memorySize;
embeddedartists 8:fe3cb3fbb64e 210 uint32_t _eraseBlockSize;
embeddedartists 8:fe3cb3fbb64e 211
embeddedartists 8:fe3cb3fbb64e 212 SPIFIobj* _romData;
embeddedartists 8:fe3cb3fbb64e 213 const SPIFI_RTNS* _spifi;
embeddedartists 8:fe3cb3fbb64e 214
embeddedartists 8:fe3cb3fbb64e 215 char _addrConflictBuff[256];
embeddedartists 8:fe3cb3fbb64e 216
embeddedartists 8:fe3cb3fbb64e 217 explicit SPIFI();
embeddedartists 8:fe3cb3fbb64e 218 // hide copy constructor
embeddedartists 8:fe3cb3fbb64e 219 SPIFI(const SPIFI&);
embeddedartists 8:fe3cb3fbb64e 220 // hide assign operator
embeddedartists 8:fe3cb3fbb64e 221 SPIFI& operator=(const SPIFI&);
embeddedartists 8:fe3cb3fbb64e 222 ~SPIFI();
embeddedartists 8:fe3cb3fbb64e 223
embeddedartists 8:fe3cb3fbb64e 224 SpifiError translateError(int err, bool verify = false);
embeddedartists 8:fe3cb3fbb64e 225 };
embeddedartists 8:fe3cb3fbb64e 226
embeddedartists 8:fe3cb3fbb64e 227 #endif
embeddedartists 8:fe3cb3fbb64e 228