dataflash.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 DATAFLASH_H_
#define DATAFLASH_H_
    
#include "cmd_defs.h"
#include "spi_driver.h"
#include "helper_functions.h"
#include <stdio.h>
#include <stdlib.h>

#if (PARTNO == AT45DB021E) || \
    (PARTNO == AT45DB041E) || \
    (PARTNO == AT45DB081E) || \
    (PARTNO == AT45DB161E) || \
    (PARTNO == AT45DB321E) || \
    (PARTNO == AT45DB641E) || \
    (PARTNO == AT45DQ161)  || \
    (PARTNO == AT45DQ321)  || \
    (PARTNO == AT25PE20)   || \
    (PARTNO == AT25PE40)   || \
    (PARTNO == AT25PE80)   || \
    (PARTNO == AT25PE16)   || \
    (ALL == 1)

extern uint8_t txDataflashInternalBuffer[MAXIMUM_TX_BYTES];

/******************************************
 *
 *
 * Dataflash Commands
 *
 *
 ******************************************/
void dataflashWaitOnReady();

void dataflashReadMID(uint8_t *rxBuffer);

void dataflashReadSR(uint8_t *rxBuffer);

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

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

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

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

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

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

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

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

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

void dataflashBuffer1ToMainMemoryWithErase(uint32_t address);

void dataflashBuffer1ToMainMemoryWithoutErase(uint32_t address);

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

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

void dataflashPageErase(uint32_t address);

void dataflashBlockErase(uint32_t address);

void dataflashSectorErase(uint32_t address);

void dataflashChipErase();

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

void dataflashEnableSectorProtection();

void dataflashDisableSectorProtection();

void dataflashEraseSectorProtectionReg();

void dataflashProgSectorProtectionReg(uint8_t *txBuffer, uint32_t txNumBytes);

void dataflashReadSectorProtectionReg(uint8_t *rxBuffer, uint32_t rxNumBytes);


void dataflashReadSecurityReg(uint8_t *rxBuffer, uint32_t rxNumBytes);

void dataflashMemtoBuffer1Transfer(uint32_t address);

void dataflashMemtoBuffer1Compare(uint32_t address);

void dataflashAutoPageRewrite1(uint32_t address);

void dataflashDPD();

void dataflashResumeFromDPD();

void dataflashUDPDMode();

void dataflashHardwareReset();

void dataflashConfigurePower2PageSize();

void dataflashConfigureStandardPageSize();

void dataflashSoftwareReset();

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

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

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

void dataflashReadSRLegacy(uint8_t *rxBuffer);
#if (PARTNO == AT45DQ161) || \
    (PARTNO == AT45DQ321) || \
    (ALL == 1)

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

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

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

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

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

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

void dataflashReadConfigRegister(uint8_t *rxBuffer);

void dataflashQuadEnable();

void dataflashQuadDisable();
#endif

#if (PARTNO == AT45DB021E) || \
    (PARTNO == AT45DB041E) || \
    (PARTNO == AT45DB081E) || \
    (PARTNO == AT45DB161E) || \
    (PARTNO == AT45DB321E) || \
    (PARTNO == AT45DB641E) || \
    (PARTNO == AT45DQ161)  || \
    (PARTNO == AT45DQ321)  || \
    (ALL == 1)

void dataflashProgramEraseSuspend();

void dataflashProgramEraseResume();

void dataflashSectorLockdown(uint32_t address);

void dataflashReadSectorLockdownReg(uint8_t *rxBuffer, uint32_t rxNumBytes);

void dataflashFreezeSectorLockdown();

void dataflashProgSecurityReg(uint8_t *txBuffer, uint32_t txNumBytes);
#endif
#if (PARTNO == AT45DB021E) || \
    (PARTNO == AT45DB041E) || \
    (PARTNO == AT45DB081E) || \
    (PARTNO == AT45DB161E) || \
    (PARTNO == AT45DB321E) || \
    (PARTNO == AT45DB641E) || \
    (PARTNO == AT45DQ161)  || \
    (PARTNO == AT45DQ321)  || \
    (PARTNO == AT25PE40)   || \
    (PARTNO == AT25PE80)   || \
    (PARTNO == AT25PE16)   || \
    (ALL == 1)

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

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

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

void dataflashBuffer2ToMainMemoryWithErase(uint32_t address);

void dataflashBuffer2ToMainMemoryWithoutErase(uint32_t address);

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

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

void dataflashMemtoBuffer2Transfer(uint32_t address);

void dataflashMemtoBuffer2Compare(uint32_t address);

void dataflashAutoPageRewrite2(uint32_t address);

void dataflashBuffer2ReadLegacy(uint8_t address, uint8_t *rxBuffer, uint32_t rxNumBytes);
#endif

#endif

#endif /* DATAFLASH_H_ */