RA0E1マイコンでSPI Flash Memoryを動かす

/*
 * w25q64.c
 *
 *  Created on: 2026/02/21
 *      Author: 13963
 */

/* ヘッダファイル : 一部デバイス依存 */
#include "hal_data.h"
#include "r_sau_spi.h"
#include "bsp_api.h"
#include "w25q64.h"

/* -------------------------------------------------------
 * CS マクロ（BSP I/O access API・アクティブロー）
 * R_BSP_PinWrite の前後に Enable/Disable が必要
 * 端子設定はデバイス依存
 * ------------------------------------------------------- */
#define CS_LOW()  R_IOPORT_PinWrite(&g_ioport_ctrl, W25Q64_CS_PORT, BSP_IO_LEVEL_LOW)
#define CS_HIGH() R_IOPORT_PinWrite(&g_ioport_ctrl, W25Q64_CS_PORT, BSP_IO_LEVEL_HIGH)

/* -------------------------------------------------------
 * 転送完了フラグ（コールバックでセット）
 * ------------------------------------------------------- */
static volatile bool s_spi_done  = false;
static volatile bool s_spi_error = false;

/* -------------------------------------------------------
 * SAU SPI コールバック
 * FSP Configurator の Callback 欄に "sau_spi0_callback" を登録
 * ------------------------------------------------------- */
void sau_spi0_callback(spi_callback_args_t *p_args)
{
    if (SPI_EVENT_TRANSFER_COMPLETE == p_args->event)
    {
        s_spi_done = true;
    }
    else
    {
        s_spi_error = true;
    }
}

/* -------------------------------------------------------
 * 内部：転送完了待ち（タイムアウト付き）
 * ------------------------------------------------------- */
static fsp_err_t spi_wait(void)
{
    uint32_t timeout = 500000UL;

    while (!s_spi_done && !s_spi_error)
    {
        if (--timeout == 0U)
        {
            return FSP_ERR_TIMEOUT;
        }
    }

    if (s_spi_error)
    {
        s_spi_error = false;
        s_spi_done  = false;
        return FSP_ERR_TRANSFER_ABORTED;
    }

    s_spi_done = false;
    return FSP_SUCCESS;
}

/* -------------------------------------------------------
 * 内部：送信のみ（CSはこの関数の外で制御）
 * ------------------------------------------------------- */
static fsp_err_t spi_write(const uint8_t *tx, uint32_t len)
{
    fsp_err_t err = R_SAU_SPI_Write(&g_spi0_ctrl, tx, len, SPI_BIT_WIDTH_8_BITS);
    if (FSP_SUCCESS != err) return err;
    return spi_wait();
}

/* -------------------------------------------------------
 * 内部：受信のみ（CSはこの関数の外で制御）
 * ------------------------------------------------------- */
static fsp_err_t spi_read(uint8_t *rx, uint32_t len)
{
    fsp_err_t err = R_SAU_SPI_Read(&g_spi0_ctrl, rx, len, SPI_BIT_WIDTH_8_BITS);
    if (FSP_SUCCESS != err) return err;
    return spi_wait();
}

/* -------------------------------------------------------
 * 内部：送受信（CSはこの関数の外で制御）
 * ------------------------------------------------------- */
static fsp_err_t spi_write_read(const uint8_t *tx, uint8_t *rx, uint32_t len)
{
    fsp_err_t err = R_SAU_SPI_WriteRead(&g_spi0_ctrl, tx, rx, len, SPI_BIT_WIDTH_8_BITS);
    if (FSP_SUCCESS != err) return err;
    return spi_wait();
}

/* -------------------------------------------------------
 * 初期化
 * ------------------------------------------------------- */
fsp_err_t W25Q64_Init(void)
{
    CS_HIGH();  /* 非選択状態を確定 */

    fsp_err_t err = R_SAU_SPI_Open(&g_spi0_ctrl, &g_spi0_cfg);
    if (FSP_SUCCESS != err) return err;

    /* パワーダウン解除 */
    uint8_t cmd = W25Q64_CMD_RELEASE_POWER_DOWN;
    CS_LOW();
    err = spi_write(&cmd, 1U);
    CS_HIGH();

    /* tRES1 待機（最低3us → 余裕を持って1ms） */
    R_BSP_SoftwareDelay(1U, BSP_DELAY_UNITS_MILLISECONDS);

    return err;
}

/* -------------------------------------------------------
 * JEDEC ID 読み出し
 * 正常時：id[0]=0xEF  id[1]=0x40  id[2]=0x17
 * ------------------------------------------------------- */
fsp_err_t W25Q64_ReadJEDECID(uint8_t *id)
{
    uint8_t tx[4] = { W25Q64_CMD_JEDEC_ID, 0xFFU, 0xFFU, 0xFFU };
    uint8_t rx[4] = { 0U };

    CS_LOW();
    fsp_err_t err = spi_write_read(tx, rx, 4U);
    CS_HIGH();

    if (FSP_SUCCESS == err)
    {
        id[0] = rx[1];  /* Manufacturer ID : 0xEF */
        id[1] = rx[2];  /* Memory Type     : 0x40 */
        id[2] = rx[3];  /* Capacity        : 0x17 */
    }
    return err;
}

/* -------------------------------------------------------
 * 内部：ステータスレジスタ1 読み出し
 * ------------------------------------------------------- */
static fsp_err_t read_status1(uint8_t *status)
{
    uint8_t tx[2] = { W25Q64_CMD_READ_STATUS1, 0xFFU };
    uint8_t rx[2] = { 0U };

    CS_LOW();
    fsp_err_t err = spi_write_read(tx, rx, 2U);
    CS_HIGH();

    if (FSP_SUCCESS == err) *status = rx[1];
    return err;
}

/* -------------------------------------------------------
 * ビジー確認
 * ------------------------------------------------------- */
bool W25Q64_IsBusy(void)
{
    uint8_t status = 0U;
    read_status1(&status);
    return (bool)(status & W25Q64_STATUS_BUSY);
}

/* -------------------------------------------------------
 * 書き込み/消去完了待ち
 * ------------------------------------------------------- */
void W25Q64_WaitDone(void)
{
    while (W25Q64_IsBusy())
    {
        R_BSP_SoftwareDelay(1U, BSP_DELAY_UNITS_MILLISECONDS);
    }
}

/* -------------------------------------------------------
 * 内部：ライトイネーブル
 * ------------------------------------------------------- */
static fsp_err_t write_enable(void)
{
    uint8_t cmd = W25Q64_CMD_WRITE_ENABLE;
    CS_LOW();
    fsp_err_t err = spi_write(&cmd, 1U);
    CS_HIGH();
    return err;
}

/* -------------------------------------------------------
 * データ読み出し
 * コマンド＋アドレス送信後、CSを維持したままデータ受信
 * ------------------------------------------------------- */
fsp_err_t W25Q64_ReadData(uint32_t addr, uint8_t *buf, uint32_t len)
{
    uint8_t hdr[4] = {
        W25Q64_CMD_READ_DATA,
        (uint8_t)(addr >> 16U),
        (uint8_t)(addr >>  8U),
        (uint8_t)(addr >>  0U)
    };

    CS_LOW();                               /* CS アサート */
    fsp_err_t err = spi_write(hdr, 4U);    /* コマンド＋アドレス送信 */
    if (FSP_SUCCESS == err)
    {
        err = spi_read(buf, len);            /* データ受信（CS維持） */
    }
    CS_HIGH();                              /* CS ネゲート */

    return err;
}

/* -------------------------------------------------------
 * ページプログラム（最大256バイト）
 * addr はページ境界（256バイト境界）を推奨
 * ------------------------------------------------------- */
fsp_err_t W25Q64_PageProgram(uint32_t addr, const uint8_t *buf, uint32_t len)
{
    if (len == 0U || len > W25Q64_PAGE_SIZE)
    {
        return FSP_ERR_INVALID_ARGUMENT;
    }

    fsp_err_t err = write_enable();
    if (FSP_SUCCESS != err) return err;

    uint8_t hdr[4] = {
        W25Q64_CMD_PAGE_PROGRAM,
        (uint8_t)(addr >> 16U),
        (uint8_t)(addr >>  8U),
        (uint8_t)(addr >>  0U)
    };

    CS_LOW();                               /* CS アサート */
    err = spi_write(hdr, 4U);              /* コマンド＋アドレス送信 */
    if (FSP_SUCCESS == err)
    {
        err = spi_write(buf, len);           /* データ送信（CS維持） */
    }
    CS_HIGH();                              /* CS ネゲート */

    if (FSP_SUCCESS == err)
    {
        W25Q64_WaitDone();                   /* tPP 完了待ち（最大3ms） */
    }
    return err;
}

/* -------------------------------------------------------
 * セクタ消去（4KB単位）
 * addr は 4KB 境界アドレス（下位12bitは無視される）
 * ------------------------------------------------------- */
fsp_err_t W25Q64_SectorErase(uint32_t addr)
{
    fsp_err_t err = write_enable();
    if (FSP_SUCCESS != err) return err;

    uint8_t tx[4] = {
        W25Q64_CMD_SECTOR_ERASE,
        (uint8_t)(addr >> 16U),
        (uint8_t)(addr >>  8U),
        (uint8_t)(addr >>  0U)
    };

    CS_LOW();
    err = spi_write(tx, 4U);
    CS_HIGH();

    if (FSP_SUCCESS == err)
    {
        W25Q64_WaitDone();                   /* tSE 完了待ち（最大400ms） */
    }
    return err;
}

/* -------------------------------------------------------
 * チップ全消去
 * 完了まで最大200秒かかる場合あり（W25Q64仕様）
 * ------------------------------------------------------- */
fsp_err_t W25Q64_ChipErase(void)
{
    fsp_err_t err = write_enable();
    if (FSP_SUCCESS != err) return err;

    uint8_t cmd = W25Q64_CMD_CHIP_ERASE;
    CS_LOW();
    err = spi_write(&cmd, 1U);
    CS_HIGH();

    if (FSP_SUCCESS == err)
    {
        W25Q64_WaitDone();
    }
    return err;
}