W25QFlashQSPI.hpp

/*
 * W25QFlashQSPI.hpp
 *
 * STM32 HAL QUADSPI driver for the Winbond W25Q-series QSPI DIP breakout
 * boards (Adafruit 5632/5633/5634 -- W25Q16/W25Q64/W25Q128), operated in
 * single-line-address / single-line-data indirect mode -- see the class-level
 * note below on why this isn't using all four IO lines for data yet.
 *
 * 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: Sep 3, 2026
 *      Author: johng
 */
 
#ifndef W25Q_W25QFLASHQSPI_HPP_
#define W25Q_W25QFLASHQSPI_HPP_
 
#include "main.h"
#include "w25q_commands.h"
 
class W25QFlashQSPI {
public:
    explicit W25QFlashQSPI(uint32_t qspiTimeoutMs = 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:
    QSPI_HandleTypeDef *_hqspi;
 
    uint32_t _qspiTimeoutMs;
 
    HAL_StatusTypeDef runCommand(uint8_t instruction);
 
    HAL_StatusTypeDef readCommand(uint8_t instruction, uint8_t *resp, uint32_t len);
 
    HAL_StatusTypeDef writeCommand(uint8_t instruction, const uint8_t *data, uint32_t len);
 
    HAL_StatusTypeDef eraseCommand(uint8_t instruction, uint32_t addr);
 
    HAL_StatusTypeDef writeEnable();
};
 
#endif /* W25Q_W25QFLASHQSPI_HPP_ */