standardflash.h

Go to the documentation of this file.

/*
 * The Clear BSD License
 * Copyright (c) 2018 Adesto Technologies Corporation, Inc
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted (subject to the limitations in the disclaimer below) provided
 *  that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 *
 * o 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.
 *
 * o Neither the name of the copyright holder nor the names of its
 *   contributors may be used to endorse or promote products derived from this
 *   software without specific prior written permission.
 *
 * NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE.
 * 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, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER 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 STANDARDFLASH_H_
#define STANDARDFLASH_H_
    
#include "cmd_defs.h"
#include "spi_driver.h"
#include "helper_functions.h"
#include <stdio.h>
#include <stdlib.h>

#if (PARTNO == AT25SF641)   || \
    (PARTNO == AT25SF321)   || \
    (PARTNO == AT25SF161)   || \
    (PARTNO == AT25SF081)   || \
    (PARTNO == AT25SF041)   || \
    (PARTNO == AT25SL128A)  || \
    (PARTNO == AT25SL641)   || \
    (PARTNO == AT25SL321)   || \
    (PARTNO == AT25DL081)   || \
    (PARTNO == AT25DL161)   || \
    (PARTNO == AT25DF081A)  || \
    (PARTNO == AT25DF321A)  || \
    (PARTNO == AT25DF641A)  || \
    (PARTNO == AT25QL128A)  || \
    (PARTNO == AT25QL641)   || \
    (PARTNO == AT25QL321)   || \
    (PARTNO == AT25QF641)   || \
    (ALL == 1)

extern uint8_t txStandardflashInternalBuffer[MAXIMUM_TX_BYTES];

/******************************************
 *
 *
 * Standardflash Commands
 *
 *
 ******************************************/

void standardflashWaitOnReady();

void standardflashSetQEBit();

void standardflashClearQEBit();

void standardflashWriteEnable();

void standardflashWriteDisable();

void standardflashReadArrayLowFreq(uint32_t address, uint8_t *rxBuffer, uint32_t rxNumBytes);

void standardflashReadArrayHighFreq(uint32_t address, uint8_t *rxBuffer, uint32_t rxNumBytes);

void standardflashBytePageProgram(uint32_t address, uint8_t *txBuffer, uint32_t txNumBytes);

void standardflashBlockErase4K(uint32_t address);

void standardflashBlockErase32K(uint32_t address);

void standardflashBlockErase64K(uint32_t address);

void standardflashChipErase1();

void standardflashChipErase2();

void standardflashDPD();

void standardflashResumeFromDPD();

void standardflashReadID(uint8_t *rxBuffer);

void standardflashReadMID(uint8_t *rxBuffer);
#endif
#if (PARTNO == AT25SF641)   || \
    (PARTNO == AT25SF321)   || \
    (PARTNO == AT25SF161)   || \
    (PARTNO == AT25SF081)   || \
    (PARTNO == AT25SF041)   || \
    (PARTNO == AT25SL128A)  || \
    (PARTNO == AT25SL641)   || \
    (PARTNO == AT25SL321)   || \
    (PARTNO == AT25QL128A)  || \
    (PARTNO == AT25QL641)   || \
    (PARTNO == AT25QL321)   || \
    (PARTNO == AT25QF641)   || \
    (ALL == 1)

void standardflashWriteSR(uint8_t *txBuffer, uint8_t txNumBytes);
#endif

#if (PARTNO == AT25SF641)   || \
    (PARTNO == AT25SL128A)  || \
    (PARTNO == AT25SL641)   || \
    (PARTNO == AT25SL321)   || \
    (PARTNO == AT25QL128A)  || \
    (PARTNO == AT25QL641)   || \
    (PARTNO == AT25QL321)   || \
    (PARTNO == AT25QF641)   || \
    (PARTNO == AT25DL081)   || \
    (PARTNO == AT25DL161)   || \
    (PARTNO == AT25DF081A)  || \
    (PARTNO == AT25DF321A)  || \
    (PARTNO == AT25DF641A)  || \
    (ALL == 1)
void standardflashWriteSRB1(uint8_t regVal);
void standardflashWriteSRB2(uint8_t regVal);
#endif

#if (PARTNO == AT25SF641)   || \
    (PARTNO == AT25SF321)   || \
    (PARTNO == AT25SF161)   || \
    (PARTNO == AT25SF081)   || \
    (PARTNO == AT25SF041)   || \
    (PARTNO == AT25SL128A)  || \
    (PARTNO == AT25SL641)   || \
    (PARTNO == AT25SL321)   || \
    (PARTNO == AT25QL128A)  || \
    (PARTNO == AT25QL641)   || \
    (PARTNO == AT25QL321)   || \
    (PARTNO == AT25QF641)   || \
    (ALL == 1)

void standardflashWriteEnableVolatileSR();

uint8_t standardflashReadSRB1();

uint8_t standardflashReadSRB2();

void standardflashDualOutputRead(uint32_t address, uint8_t *rxBuffer, uint32_t rxNumBytes);

void standardflashDualIORead(uint32_t address, uint8_t *rxBuffer, uint32_t rxNumBytes, uint8_t readMode, uint8_t modeByteValue);

void standardflashQuadOutputRead(uint32_t address, uint8_t *rxBuffer, uint32_t rxNumBytes);

void standardflashQuadIORead(uint32_t address, uint8_t *rxBuffer, uint32_t rxNumBytes, uint8_t readMode, uint8_t modeByteValue);

void standardflashContinuousReadModeDualReset();

void standardflashContinuousReadModeQuadReset();

void standardflashEraseSecurityRegister(uint32_t address);

void standardflashProgramSecurityRegisters(uint32_t address, uint8_t *txBuffer, uint32_t txNumBytes);

void standardflashReadSecurityRegisters(uint32_t address, uint8_t *rxBuffer, uint32_t rxNumBytes);

void standardflashResumeFromDPDReadID(uint8_t *rxBuffer);

void standardflashQuadPageProgram(uint32_t address, uint8_t *txBuffer, uint32_t txNumBytes, uint8_t mode);
#endif

#if (PARTNO == AT25SF641)   || \
    (PARTNO == AT25SF321)   || \
    (PARTNO == AT25SF161)   || \
    (PARTNO == AT25SL128A)  || \
    (PARTNO == AT25SL641)   || \
    (PARTNO == AT25SL321)   || \
    (PARTNO == AT25QL128A)  || \
    (PARTNO == AT25QL641)   || \
    (PARTNO == AT25QL321)   || \
    (PARTNO == AT25QF641)   || \
    (ALL == 1)

void standardflashEraseProgramSuspend();

void standardflashEraseProgramResume();
#endif

#if (PARTNO == AT25SF641)   || \
    (PARTNO == AT25SL128A)  || \
    (PARTNO == AT25SL641)   || \
    (PARTNO == AT25SL321)   || \
    (PARTNO == AT25QL128A)  || \
    (PARTNO == AT25QL641)   || \
    (PARTNO == AT25QL321)   || \
    (PARTNO == AT25QF641)   || \
    (ALL == 1)

void standardflashEnableQPI();

void standardflashDisableQPI();

void standardflashEnableReset();

void standardflashReset();

void standardflashEnterSecureOTP();

void standardflashExitSecuredOTP();
#endif

#if (PARTNO == AT25DL081)   || \
    (PARTNO == AT25DL161)   || \
    (PARTNO == AT25DF081A)  || \
    (PARTNO == AT25DF321A)  || \
    (PARTNO == AT25DF641A)  || \
    (ALL == 1)

void standardflashReadSR(uint8_t *rxBuffer);

void standardflashDualInputBytePageProgram(uint32_t address, uint8_t *txBuffer, uint32_t txNumBytes);

void standardflashProgramEraseSuspend();

void standardflashProgramEraseResume();

void standardflashProtectSector(uint32_t address);

void standardflashUnprotectSector(uint32_t address);

uint8_t standardflashReadSectorProtectionReg(uint32_t address);

void standardflashFreezeLockdownState();

uint8_t standardflashReadLockdownReg(uint32_t address);

void standardflashProgramOTPReg(uint32_t address, uint8_t *txBuffer, uint32_t txNumBytes);

#endif

#endif /* STANDARDFLASH_H_ */