w25q128.c

/***********************************************************************************
 * @file        flash.c                                                            *
 * @author      Matt Ricci                                                         *
 * @addtogroup  Flash                                                              *
 * @brief       Brief description of the file's purpose.                           *
 *                                                                                 *
 * @{                                                                              *
 ***********************************************************************************/
 
#include "w25q128.h"
 
/* =============================================================================== */
W25Q128_t W25Q128_init(
    W25Q128_t *flash,
    SPI_t *spi,
    GPIOpin_t cs
) {
  flash->spi            = spi;
  flash->cs             = cs;
  flash->base.pageSize  = W25Q128_PAGE_SIZE;
  flash->base.pageCount = W25Q128_PAGE_COUNT;
  flash->base.erase     = W25Q128_erase;
  flash->base.readPage  = W25Q128_readPage;
  flash->base.writePage = W25Q128_writePage;
 
  return *flash;
}
 
/********************************* PRIVATE METHODS *********************************/
 
// ALLOW FORMATTING
#ifndef __DOXYGEN__
 
/* =============================================================================== */
void _W25Q128_writeEnable(W25Q128_t *flash) {
  SPI_t *spi   = flash->spi;
  GPIOpin_t cs = flash->cs;
 
  cs.reset(&cs);
  spi->transmit(spi, W25Q128_WRITE_ENABLE);
  cs.set(&cs);
}
 
/* =============================================================================== */
void _W25Q128_readStatus1(W25Q128_t *flash, uint8_t *status) {
  SPI_t *spi   = flash->spi;
  GPIOpin_t cs = flash->cs;
 
  cs.reset(&cs);
  *status = spi->transmit(spi, W25Q128_READ_STATUS_REGISTER_1);
  *status = spi->transmit(spi, 0x0F);
  cs.set(&cs);
}
 
/* =============================================================================== */
void _W25Q128_readStatus2(W25Q128_t *flash, uint8_t *status) {
  SPI_t *spi   = flash->spi;
  GPIOpin_t cs = flash->cs;
 
  cs.reset(&cs);
  *status = spi->transmit(spi, W25Q128_READ_STATUS_REGISTER_2);
  *status = spi->transmit(spi, 0x0F);
  cs.set(&cs);
}
 
/* =============================================================================== */
void _W25Q128_readStatus3(W25Q128_t *flash, uint8_t *status) {
  SPI_t *spi   = flash->spi;
  GPIOpin_t cs = flash->cs;
 
  cs.reset(&cs);
  *status = spi->transmit(spi, W25Q128_READ_STATUS_REGISTER_3);
  *status = spi->transmit(spi, 0x0F);
  cs.set(&cs);
}
 
#endif
 
/******************************** DEVICE API METHODS *******************************/
 
/* =============================================================================== */
void W25Q128_erase(Flash_t *flash) {
  W25Q128_t *driver = (W25Q128_t *)flash;
  _W25Q128_writeEnable(driver);
  SPI_t *spi     = driver->spi;
  GPIOpin_t cs   = driver->cs;
 
  uint8_t status = 0;
 
  // Send Erase Chip instruction
  cs.reset(&cs);
  spi->transmit(spi, W25Q128_ERASE_CHIP);
  cs.set(&cs);
 
  // Wait until chip BUSY is clear
  do {
    _W25Q128_readStatus1(driver, &status);
  } while (status & 0x01);
}
 
/* =============================================================================== */
void W25Q128_writePage(Flash_t *flash, uint32_t address, uint8_t *data) {
  W25Q128_t *driver = (W25Q128_t *)flash;
  _W25Q128_writeEnable(driver);
  SPI_t *spi     = driver->spi;
  GPIOpin_t cs   = driver->cs;
 
  uint8_t status = 0;
 
  cs.reset(&cs);
 
  // Send Page Program instruction and 24-bit address
  spi->transmit(spi, W25Q128_PAGE_PROGRAM);
  spi->transmit(spi, (address & 0xFF0000) >> 16);
  spi->transmit(spi, (address & 0xFF00) >> 8);
  spi->transmit(spi, (address & 0xFF));
 
  // Send page data
  for (int i = 0; i < 256; i++) {
    spi->transmit(spi, data[i]);
  }
 
  cs.set(&cs);
 
  // Wait until chip BUSY is clear
  do {
    _W25Q128_readStatus1(driver, &status);
  } while (status & 0x1);
}
 
/* =============================================================================== */
void W25Q128_readPage(Flash_t *flash, uint32_t address, volatile uint8_t *data) {
  W25Q128_t *driver = (W25Q128_t *)flash;
  SPI_t *spi        = driver->spi;
  GPIOpin_t cs      = driver->cs;
 
  cs.reset(&cs);
 
  // Send Read Data instruction and 24-bit address
  spi->transmit(spi, W25Q128_READ_DATA);
  spi->transmit(spi, (address & 0xFF0000) >> 16);
  spi->transmit(spi, (address & 0xFF00) >> 8);
  spi->transmit(spi, (address & 0xFF));
 
  for (int i = 0; i < 256; i++) {
    data[i] = spi->transmit(spi, 0x0F);
  }
 
  cs.set(&cs);
}