luban-lite-t3e-pro/bsp/examples_bare/test-spinor/spinor.c

/*
 * Copyright (c) 2022-2024, ArtInChip Technology Co., Ltd
 *
 * SPDX-License-Identifier: Apache-2.0
 *
 * Authors: Wu Dehuang <dehuang.wu@artinchip.com>
 */

#include <stdio.h>
#include <stdlib.h>
#include <stdint.h>
#include <string.h>
#include <console.h>
#include <aic_common.h>
#include <aic_errno.h>
#include <aic_utils.h>
#include <sfud.h>

#define SPINOR_HELP                           \
    "spinor read write command:\n"            \
    "  spinor init [spi bus id]\n"            \
    "  spinor dump  [offset] [size]\n"        \
    "  spinor read  [addr] [offset] [size]\n" \
    "  spinor erase [offset] [size]\n"        \
    "  spinor write [addr] [offset] [size]\n" \
    "  spinor regs\n"                         \
    "  spinor regwrite reg val\n"             \
    "  spinor statuswrite [reg] [val] <volatile>\n"             \
    "  spinor regread  reg\n"                 \
    "e.g.: \n"                                \
    "  spinor read 0x40000000 0 256\n"        \
    "  spinor statuswrite 0x05 0x60 non-volatile\n" \

#if defined(SFUD_USING_SECURITY_REGISTER)
#define SECURITY_REGISTER_HELP                \
    "security register:\n"                    \
    "  spinor se read reg\n"                 \
    "  spinor se erase reg\n"                \
    "  spinor se write reg addr size\n"      \
    "  spinor se lock reg\n"
#else
#define SECURITY_REGISTER_HELP      "\n"
#endif


extern sfud_flash *sfud_probe(u32 spi_bus);

static void spinor_help(void)
{
    puts(SPINOR_HELP);
    puts(SECURITY_REGISTER_HELP);
}

sfud_flash *g_spinor_flash;
static int do_spinor_init(int argc, char *argv[])
{
    unsigned long id;
    sfud_flash *flash;

    if (argc < 2) {
        spinor_help();
        return 0;
    }
    id = strtol(argv[1], NULL, 0);

    flash = sfud_probe(id);
    if (flash == NULL) {
        printf("Failed to probe spinor flash.\n");
        return -1;
    }

    printf("probe spinor flash success.\n");

    g_spinor_flash = flash;
    return 0;
}

static int do_spinor_dump(int argc, char *argv[])
{
    sfud_err err;
    sfud_flash *flash;
    u8 *data;
    unsigned long offset, size;

    flash = g_spinor_flash;
    if (flash == NULL) {
        printf("spinor init first.\n");
        return 0;
    }

    offset = strtol(argv[1], NULL, 0);
    size = strtol(argv[2], NULL, 0);

    data = malloc(size);
    if (data == NULL) {
        printf("Out of memory.\n");
        return -1;
    }

    memset(data, 0, size);

    err = sfud_read(flash, offset, size, data);
    if (!err)
        hexdump((void *)data, size, 1);
    free(data);
    return err;
}

static int do_spinor_read(int argc, char *argv[])
{
    sfud_err err;
    sfud_flash *flash;
    u8 *data;
    unsigned long addr, offset, size;

    flash = g_spinor_flash;
    if (flash == NULL) {
        printf("spinor init first.\n");
        return 0;
    }

    addr = strtol(argv[1], NULL, 0);
    offset = strtol(argv[2], NULL, 0);
    size = strtol(argv[3], NULL, 0);

    data = (u8 *)addr;
    if (data == NULL) {
        printf("Dest address is not correct.\n");
        return -1;
    }

    err = sfud_read(flash, offset, size, data);
    return err;
}

static int do_spinor_erase(int argc, char *argv[])
{
    sfud_err err;
    sfud_flash *flash;
    unsigned long offset, size;

    flash = g_spinor_flash;
    if (flash == NULL) {
        printf("spinor init first.\n");
        return 0;
    }

    offset = strtol(argv[1], NULL, 0);
    size = strtol(argv[2], NULL, 0);

    err = sfud_erase(flash, offset, size);
    return err;
}

static int do_spinor_write(int argc, char *argv[])
{
    sfud_err err;
    sfud_flash *flash;
    u8 *data;
    unsigned long addr, offset, size;

    flash = g_spinor_flash;
    if (flash == NULL) {
        printf("spinor init first.\n");
        return 0;
    }

    addr = strtol(argv[1], NULL, 0);
    offset = strtol(argv[2], NULL, 0);
    size = strtol(argv[3], NULL, 0);

    data = (u8 *)addr;
    if (data == NULL) {
        printf("Source address is not correct.\n");
        return -1;
    }

    err = sfud_write(flash, offset, size, data);
    return err;
}

static int do_spinor_reg_dump(int argc, char *argv[])
{
    sfud_err err;
    sfud_flash *flash;
    u8 data;

    flash = g_spinor_flash;
    if (flash == NULL) {
        printf("spinor init first.\n");
        return 0;
    }
    err = sfud_read_status(flash, &data);
    if (err)
        printf("Read SR1 failure.\n");
    else
        printf("SR1: 0x%x\n", data);
    err = sfud_read_cr(flash, &data);
    if (err)
        printf("Read SR2/CR failure.\n");
    else
        printf("SR2/CR: 0x%x\n", data);
    return err;
}

static int do_spinor_reg_write(int argc, char *argv[])
{
    sfud_err err;
    sfud_flash *flash;
    u8 reg, val;

    reg = (u8)strtol(argv[1], NULL, 0);
    val = (u8)strtol(argv[2], NULL, 0);

    flash = g_spinor_flash;
    if (flash == NULL) {
        printf("spinor init first.\n");
        return 0;
    }
    err = sfud_write_reg(flash, reg, &val);
    if (err)
        printf("Write Register failure.\n");
    printf("Reg 0x%x, Value: 0x%x\n", reg, val);
    return err;
}

static int do_spinor_status_write(int argc, char *argv[])
{
    sfud_err err = 0;
    sfud_flash *flash;
    u8 val;
    u32 reg;
    bool is_volatile = true;

    if (argc < 3) {
        spinor_help();
        return 0;
    }

    reg = strtol(argv[1], NULL, 0);
    val = (u8)strtol(argv[2], NULL, 0);

    if (argc >= 4) {
        if (!strncmp(argv[3], "non-volatile", 12))
            is_volatile = false;
    }

    flash = g_spinor_flash;
    if (flash == NULL) {
        printf("spinor init first.\n");
        return 0;
    }

    err = sfud_write_status_ext(flash, is_volatile, reg, val);
    if (err)
        printf("Write Register failure.\n");

    val = 0;
    err = sfud_read_reg(flash, reg, &val);
    if (err)
        printf("Read Register failure.\n");
    printf("Write status 0x%x success, val: 0x%x\n", reg, val);
    return err;
}

static int do_spinor_reg_read(int argc, char *argv[])
{
    sfud_err err;
    sfud_flash *flash;
    u8 reg, val;

    reg = (u8)strtol(argv[1], NULL, 0);

    flash = g_spinor_flash;
    if (flash == NULL) {
        printf("spinor init first.\n");
        return 0;
    }
    err = sfud_read_reg(flash, reg, &val);
    if (err)
        printf("Read Register failure.\n");
    printf("Reg 0x%x, Value: 0x%x\n", reg, val);
    return err;
}

#ifdef SFUD_USING_SECURITY_REGISTER
static int do_spinor_secureg_read(int argc, char *argv[])
{
    sfud_err err;
    sfud_flash *flash;
    u8 reg, *data;

    reg = (u8)strtol(argv[1], NULL, 0);

    if (reg <= 0 || reg > 3) {
        printf("Error: reg out of bound\n");
        return -1;
    }

    flash = g_spinor_flash;
    if (flash == NULL) {
        printf("spinor init first.\n");
        return 0;
    }
    data = malloc(256);
    if (data == NULL) {
        printf("Malloc memory failed.\n");
        return -1;
    }
    err = sfud_read_secur(flash, reg, data);
    if (err)
        printf("Read Security Register %d failure.\n", reg);
    else
        hexdump((void *)data, 256, 1);

    free(data);
    return err;
}

static int do_spinor_secureg_erase(int argc, char *argv[])
{
    sfud_err err;
    sfud_flash *flash;
    u8 reg;

    reg = (u8)strtol(argv[1], NULL, 0);

    if (reg <= 0 || reg > 3) {
        printf("Error: reg out of bound\n");
        return -1;
    }

    flash = g_spinor_flash;
    if (flash == NULL) {
        printf("spinor init first.\n");
        return 0;
    }

    err = sfud_erase_secur(flash, reg);
    if (err)
        printf("Erase security register %u failed!\n", reg);
    return err;
}

static int do_spinor_secureg_write(int argc, char *argv[])
{
    sfud_err err;
    sfud_flash *flash;
    u8 *data;
    unsigned long addr, size;
    u8 reg;

    flash = g_spinor_flash;
    if (flash == NULL) {
        printf("spinor init first.\n");
        return 0;
    }

    reg = strtol(argv[1], NULL, 0);
    addr = strtol(argv[2], NULL, 0);
    size = strtol(argv[3], NULL, 0);

    if (reg <= 0 || reg > 3) {
        printf("Error: reg out of bound\n");
        return -1;
    }

    data = (u8 *)addr;
    if (data == NULL) {
        printf("Source address is not correct.\n");
        return -1;
    }

    err = sfud_write_secur(flash, reg, size, data);
    return err;
}

static int do_spinor_secureg_lock(int argc, char *argv[])
{
    sfud_err err;
    sfud_flash *flash;
    u8 reg, val;

    reg = (u8)strtol(argv[1], NULL, 0);

    if (reg <= 0 || reg > 3) {
        printf("Error: reg out of bound\n");
        return -1;
    }

    flash = g_spinor_flash;
    if (flash == NULL) {
        printf("spinor init first.\n");
        return 0;
    }
    /* read status register2 */
    err = sfud_read_reg(flash, 0x35, &val);
    if (err)
        printf("Read status register2 failure.\n");
    printf("Reg 0x%x, Value: 0x%x\n", reg, val);

    if (val & (0x1 << (2 + reg))) {
        printf("Security Register%x has been locked.\n", reg);
        return err;
    }

    val |= (0x1 << (2 + reg));
    err = sfud_write_status_ext(flash, false, 0x35, val);
    err = sfud_read_reg(flash, 0x35, &val);
    if (err)
        printf("Read status register2 failure.\n");
    printf("Reg 0x%x, Value: 0x%x\n", reg, val);

    if (val & (0x1 << (2 + reg))) {
        printf("Security Register%x locked done.\n", reg);
        return err;
    }

    return err;
}

static int do_spinor_se(int argc, char *argv[])
{
    if (argc < 3) {
        spinor_help();
        return 0;
    }

    else if (!strncmp(argv[1], "read", 4))
        return do_spinor_secureg_read(argc - 1, &argv[1]);
    else if (!strncmp(argv[1], "erase", 5))
        return do_spinor_secureg_erase(argc - 1, &argv[1]);
    else if (!strncmp(argv[1], "write", 5))
        return do_spinor_secureg_write(argc - 1, &argv[1]);
    else if (!strncmp(argv[1], "lock", 4))
        return do_spinor_secureg_lock(argc - 1, &argv[1]);

    return 0;
}
#endif

/*
 * spinor init 0
 * spinor dump offset size
 * spinor read addr offset size
 * spinor write addr offset size
 */
static int do_spinor(int argc, char *argv[])
{
    if (argc < 3) {
        spinor_help();
        return 0;
    }

    if (!strncmp(argv[1], "init", 4))
        return do_spinor_init(argc - 1, &argv[1]);
    else if (!strncmp(argv[1], "dump", 4))
        return do_spinor_dump(argc - 1, &argv[1]);
    else if (!strncmp(argv[1], "read", 4))
        return do_spinor_read(argc - 1, &argv[1]);
    else if (!strncmp(argv[1], "write", 5))
        return do_spinor_write(argc - 1, &argv[1]);
    else if (!strncmp(argv[1], "erase", 5))
        return do_spinor_erase(argc - 1, &argv[1]);
    else if (!strncmp(argv[1], "regs", 4))
        return do_spinor_reg_dump(argc - 1, &argv[1]);
    else if (!strncmp(argv[1], "regwrite", 8))
        return do_spinor_reg_write(argc - 1, &argv[1]);
    else if (!strncmp(argv[1], "statuswrite", 11))
        return do_spinor_status_write(argc - 1, &argv[1]);
    else if (!strncmp(argv[1], "regread", 7))
        return do_spinor_reg_read(argc - 1, &argv[1]);
#ifdef SFUD_USING_SECURITY_REGISTER
    else if (!strncmp(argv[1], "se", 2))
        return do_spinor_se(argc - 1, &argv[1]);
#endif

    spinor_help();
    return 0;
}

CONSOLE_CMD(spinor, do_spinor,  "SPI NOR flash R/W command.");