e2p_device_spi.h

Go to the documentation of this file.

/*
 * Copyright (c) 2025 HPMicro
 *
 * SPDX-License-Identifier: BSD-3-Clause
 *
 */
 
#ifndef _E2P_DEVICE_SPI_H
#define _E2P_DEVICE_SPI_H
 
#include "board.h"
#include "hpm_spi_drv.h"
#include "eeprom_device.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define E2P_SPI_INSTRUCTION_WREN 0x06
#define E2P_SPI_INSTRUCTION_RDSR 0x05
#define E2P_SPI_INSTRUCTION_WRDI 0x04
#define E2P_SPI_INSTRUCTION_READ 0x03
#define E2P_SPI_INSTRUCTION_WRITE 0x02
#define E2P_SPI_INSTRUCTION_WRSR 0x01
 
#define E2P_SPI_INSTRUCTION_STATUS_WIP_MASK 0x01
#define E2P_SPI_INSTRUCTION_STATUS_WEL_MASK 0x02
 
typedef struct {
    SPI_Type *base;                    /* SPI base address */
    uint32_t cs_pin;                  /* Chip select pin */
    uint32_t (*clock_init)(SPI_Type *ptr); /* Function to initialize SPI clock */
    void (*pin_init)(void);                /* Function to initialize SPI pins */
    void (*cs_control)(uint32_t pin, uint8_t state); /* Function to control chip select pin */
} e2p_device_spi_host_config_t;
 
typedef struct {
    uint32_t addr_bytes;  /* Number of address bytes */
    uint32_t page_size;  /* Page size in bytes */
    uint32_t timeout;   /* Write cycle timeout in milliseconds */
    uint32_t max_freq; /* Maximum supported frequency */
    uint8_t borrow_bits; /* Number of borrow bits */
} e2p_device_spi_attribute_t;
 
hpm_stat_t e2p_device_spi_register_param(hpm_eeprom_device_t *device, void *host_info, uint32_t dev_id);
 
e2p_device_spi_attribute_t *e2p_device_spi_get_attribute(hpm_eeprom_device_t *device);
 
hpm_stat_t e2p_device_spi_init(hpm_eeprom_device_t *device);
 
hpm_stat_t e2p_device_spi_deinit(hpm_eeprom_device_t *device);
 
hpm_stat_t e2p_device_spi_read(hpm_eeprom_device_t *device, uint32_t data_addr, uint32_t len, uint8_t *data);
 
hpm_stat_t e2p_device_spi_write(hpm_eeprom_device_t *device, uint32_t data_addr, uint32_t len, uint8_t *data);
 
#ifdef __cplusplus
}
#endif
 
#endif