W25QFlashSPI.hpp

/*
 * W25QFlashSPI.hpp
 *
 * STM32 HAL SPI driver for the Winbond W25Q-series QSPI DIP breakout boards
 * (Adafruit 5632/5633/5634 -- W25Q16/W25Q64/W25Q128), operated in standard
 * single-line SPI mode.
 *
 * Adapted from Adafruit_SPIFlash (https://github.com/adafruit/Adafruit_SPIFlash,
 * MIT License, Copyright (c) 2019 hathach for Adafruit Industries) as a design
 * reference for the command set and driver structure -- this is an independent
 * STM32 HAL implementation, not a direct port of Adafruit's Arduino source
 * (which depends on Arduino-only types this toolchain doesn't have).
 *
 *  Created on: Aug 30, 2026
 *      Author: johng
 */
 
#ifndef W25Q_W25QFLASHSPI_HPP_
#define W25Q_W25QFLASHSPI_HPP_
 
#include "main.h"
#include "w25q_commands.h"
 
class W25QFlashSPI {
public:
    explicit W25QFlashSPI(uint32_t spiTimeoutMs = 100);
 
    bool Init();
 
    bool readJEDECID(uint32_t &id);
 
    bool readStatus(uint8_t &status1, uint8_t &status2);
 
    bool waitUntilReady(uint32_t timeout_ms = 100);
 
    bool eraseSector(uint32_t addr);
 
    bool eraseRange(uint32_t addr, uint32_t len);
 
    bool eraseBlock(uint32_t addr);
 
    bool eraseChip();
 
    bool readBuffer(uint32_t addr, uint8_t *buf, uint32_t len);
 
    bool writeBuffer(uint32_t addr, const uint8_t *data, uint32_t len);
 
private:
    SPI_HandleTypeDef *_hspi;
 
    uint32_t _spiTimeoutMs;
 
    void csEnable();
 
    void csDisable();
 
    HAL_StatusTypeDef writeEnable();
 
    HAL_StatusTypeDef runCommand(uint8_t cmd);
 
    HAL_StatusTypeDef readCommand(uint8_t cmd, uint8_t *resp, uint32_t len);
 
    HAL_StatusTypeDef writeCommand(uint8_t cmd, const uint8_t *data, uint32_t len);
 
    HAL_StatusTypeDef eraseCommand(uint8_t cmd, uint32_t addr);
 
    void fillAddress(uint8_t *buf, uint32_t addr);
};
 
#endif /* W25Q_W25QFLASHSPI_HPP_ */