SPIFlash.h

Go to the documentation of this file.

// Copyright (c) 2013-2015 by Felix Rusu, LowPowerLab.com
// SPI Flash memory library for arduino/moteino.
// This works with 256byte/page SPI flash memory
// For instance a 4MBit (512Kbyte) flash chip will have 2048 pages: 256*2048 = 524288 bytes (512Kbytes)
// Minimal modifications should allow chips that have different page size but modifications
// DEPENDS ON: Arduino SPI library
// > Updated Jan. 5, 2015, TomWS1, modified writeBytes to allow blocks > 256 bytes and handle page misalignment.
// > Updated Feb. 26, 2015 TomWS1, added support for SPI Transactions (Arduino 1.5.8 and above)
// > Selective merge by Felix after testing in IDE 1.0.6, 1.6.4
// > Updated May 19, 2016 D-H-R, added support for SST25/Microchip Flash which does not support Page programming with OPCode 0x02,
// >                             use define MY_SPIFLASH_SST25TYPE for SST25 Type Flash Memory. Added / changed comments to better suit doxygen
// > Updated Sep 07, 2018 tekka, sync with https://github.com/LowPowerLab/SPIFlash
// **********************************************************************************
// License
// **********************************************************************************
// 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/>.
//
// Licence can be viewed at
// http://www.gnu.org/licenses/gpl-3.0.txt
//
// Please maintain this license information along with authorship
// and copyright notices in any redistribution of this code
 
 
#ifndef _SPIFLASH_H_
#define _SPIFLASH_H_
 
#if ARDUINO >= 100
#include <Arduino.h>
#else
#include <wiring.h>
#include "pins_arduino.h"
#endif
 
#include <SPI.h>
 
#ifndef SPIFLASH_WRITEENABLE
#define SPIFLASH_WRITEENABLE      0x06        
#endif
 
#ifndef SPIFLASH_WRITEDISABLE
#define SPIFLASH_WRITEDISABLE     0x04        
#endif
 
#ifndef SPIFLASH_BLOCKERASE_4K
#define SPIFLASH_BLOCKERASE_4K    0x20        
#endif
 
#ifndef SPIFLASH_BLOCKERASE_32K
#define SPIFLASH_BLOCKERASE_32K   0x52        
#endif
 
#ifndef SPIFLASH_BLOCKERASE_64K
#define SPIFLASH_BLOCKERASE_64K   0xD8        
#endif
 
#ifndef SPIFLASH_CHIPERASE
#define SPIFLASH_CHIPERASE        0x60        
#endif
 
#ifndef SPIFLASH_STATUSREAD
#define SPIFLASH_STATUSREAD       0x05        
#endif
 
#ifndef SPIFLASH_STATUSWRITE
#define SPIFLASH_STATUSWRITE      0x01        
#endif
 
#ifndef SPIFLASH_ARRAYREAD
#define SPIFLASH_ARRAYREAD        0x0B        
#endif
 
#ifndef SPIFLASH_ARRAYREADLOWFREQ
#define SPIFLASH_ARRAYREADLOWFREQ 0x03        
#endif
 
#ifndef SPIFLASH_SLEEP
#define SPIFLASH_SLEEP            0xB9        
#endif
 
#ifndef SPIFLASH_WAKE
#define SPIFLASH_WAKE             0xAB        
#endif
 
#ifndef SPIFLASH_BYTEPAGEPROGRAM
#define SPIFLASH_BYTEPAGEPROGRAM  0x02        
#endif
 
#ifndef SPIFLASH_AAIWORDPROGRAM
#define SPIFLASH_AAIWORDPROGRAM   0xAD        
#endif
 
#ifndef SPIFLASH_IDREAD
#define SPIFLASH_IDREAD           0x9F        
#endif
 
#ifndef SPIFLASH_MACREAD
#define SPIFLASH_MACREAD          0x4B        
#endif
 
#ifdef DOXYGEN //needed to tell doxygen not to ignore the define which is actually made somewhere else
#define MY_SPIFLASH_SST25TYPE
#endif
 
class SPIFlash
{
public:
    static uint8_t UNIQUEID[8]; 
    explicit SPIFlash(uint8_t slaveSelectPin, uint16_t jedecID=0); 
    bool initialize(); 
    void command(uint8_t cmd, bool isWrite=
                     false); 
    uint8_t readStatus(); 
    uint8_t readByte(uint32_t addr); 
    void readBytes(uint32_t addr, void* buf, uint16_t len); 
    void writeByte(uint32_t addr, uint8_t byt); 
    void writeBytes(uint32_t addr, const void* buf,
                    uint16_t len); 
    bool busy(); 
    void chipErase(); 
    void blockErase4K(uint32_t address); 
    void blockErase32K(uint32_t address); 
    void blockErase64K(uint32_t addr); 
    uint16_t readDeviceId(); 
    uint8_t* readUniqueId(); 
 
    void sleep(); 
    void wakeup(); 
    void end(); 
protected:
    void select(); 
    void unselect(); 
    uint8_t _slaveSelectPin; 
    uint16_t _jedecID; 
    uint8_t _SPCR; 
    uint8_t _SPSR; 
#ifdef SPI_HAS_TRANSACTION
    SPISettings _settings;
#endif
};
 
#endif