Actions_3085S4_V2/zephyr/drivers/flash/spi_flash.h

/*
 * Copyright (c) 2017 Actions Semiconductor Co., Ltd
 *
 * SPDX-License-Identifier: Apache-2.0
 */

#ifndef __SPI_FLASH_H__
#define __SPI_FLASH_H__

#include <drivers/flash.h>

#define SPINOR_MAX_3BYTES_ADDRESS               (0xFFFFFF)

#define SPI_FLAG_NO_IRQ_LOCK				    (1 << 0)
#define SPI_FLAG_SPI_MODE0					    (1 << 1)
#define SPI_FLAG_SPI_NXIO					    (1 << 2)
#define SPI_FLAG_NEED_EXIT_CONTINUOUS_READ	    (1 << 3)
#define SPI_FLAG_WR_4IO							(1 << 4)
#define SPI_FLAG_QPI_MODE						(1 << 5)
#define SPI_FLAG_NO_NEED_EXIT_CONTINUOUS_READ	(1 << 8)

#define SPINOR_FLAG_UNLOCK_IRQ_WAIT_READY		(1 << 0)
#define SPINOR_FLAG_4BYTE_ADDRESS_MODE_EN       (1 << 1)
#define SPINOR_FLAG_NO_WAIT_READY		        (1 << 2)



struct acts_spi_reg
{
	volatile uint32_t ctrl;
	volatile uint32_t status;
	volatile uint32_t txdat;
	volatile uint32_t rxdat;
	volatile uint32_t bc;
	volatile uint32_t reserve[4];
	volatile uint32_t delaychain;	
} ;

struct spi_info
{
	/* spi controller address */
	unsigned int base;
	unsigned int flag;

	unsigned short cs_gpio;
	unsigned char bus_width;
	unsigned char delay_chain;

	unsigned int freq_khz;
	unsigned int dma_base;

	void (*set_cs)(struct spi_info *si, int value);
	void (*set_clk)(struct spi_info *si, unsigned int freq_khz);
	void (*prepare_hook)(struct spi_info *si);
};

struct spinor_info {
	struct spi_info spi;
	unsigned int chipid;
	unsigned int flag;
};

struct spinor_operation_api {
	int (*init)(struct spinor_info *sni);
	void (*set_clk)(unsigned int clk_mhz);

	unsigned int (*read_chipid) (struct spinor_info *sni);

	unsigned int (*read_status) (struct spinor_info *sni, unsigned char cmd);
	void (*write_status)(struct spinor_info *sni, unsigned char cmd,
			unsigned char *status, int len);

	int (*read) (struct spinor_info *sni, unsigned int addr, void *buf, int len);
	int (*write) (struct spinor_info *sni, unsigned int addr, const void *buf, int len);
	int (*erase) (struct spinor_info *sni, unsigned int addr, int len);
	void (*continuous_read_reset) (struct spinor_info *sni);/*new add by lark*/
	int (*write_rdm)(struct spinor_info *sni, unsigned int addr, const void *data, int len);
	
	void (*set_addr_mode) (struct spinor_info *sni, unsigned char addr_len);
	void (*write_cmd) (struct spinor_info *sni, unsigned char cmd);
	int  (*transfer)(struct spinor_info *sni, unsigned char cmd, unsigned int addr,
			      int addr_len, void *buf, int length,
			      unsigned char dummy_len, unsigned int flag);

};
// brom api address
#define p_spinor_api	((struct spinor_operation_api *)SPINOR_API_ADDR)

/* NOR Flash vendors ID */
#define XSPI_NOR_MANU_ID_MACRONIX	0xc2	/* Macronix (MX) */

/* spinor commands */
#define	XSPI_NOR_CMD_READ_STATUS	0x05	/* read status1 */
#define	XSPI_NOR_CMD_READ_STATUS2	0x35	/* read status2 */
#define NOR_STATUS2_SUS1			(1<<7)
#define NOR_STATUS2_SUS2			(1<<2)
#define	XSPI_NOR_CMD_READ_STATUS3	0x15	/* read status3 */
#define	XSPI_NOR_CMD_WRITE_STATUS	0x01	/* write status1 */
#define	XSPI_NOR_CMD_WRITE_STATUS2	0x31	/* write status2 */
#define	XSPI_NOR_CMD_WRITE_STATUS3	0x11	/* write status3 */

#define	XSPI_NOR_CMD_QPI_ENABLE		0x38	/* QPI ENABLE CMD*/
#define	XSPI_NOR_CMD_QPI_DISABLE	0xFF	/* QPI DISABLE CMD*/
#define	XSPI_NOR_CMD_SETPARA_QPI	0xC0	/* set param in qpi mode*/

#define SPI_FLAG_SPI_4XIO			(1 << 2)
//#define SPI_FLAG_USE_MIO_ADDR_DATA	(1<<12)


struct spi_flash_acts_config {
#if IS_ENABLED(CONFIG_FLASH_PAGE_LAYOUT)
	struct flash_pages_layout pages_layout;
#endif
	uint32_t chip_size;
	uint32_t page_size;
};

#define DEV_CFG(dev) \
	((const struct spi_flash_acts_config *const)(dev)->config)
#define DEV_DATA(dev) \
	((struct spinor_info *)(dev)->data)

#define SPI_CTL(base)				(base+0x0000)
#define SPI_STA(base)				(base+0x0004)
#define SPI_TXDAT(base)		    	(base+0x0008)
#define SPI_RXDAT(base)			    (base+0x000c)
#define SPI_BC(base)				(base+0x0010)

#define SPI_STA_READY                       (0x1 << 8)

#ifdef CONFIG_SPI_NOR_FLASH_DRV_EXT
extern const struct spinor_operation_api spinor_4b_addr_op_api;
const struct spinor_operation_api *spi3nor_get_api(void);
int spinor_erase_security(struct spinor_info *sni, unsigned int addr);
int spinor_write_security(struct spinor_info *sni, unsigned int addr, const void *data, int len);
int spinor_read_security(struct spinor_info *sni, unsigned int addr,  void *data, int len);
int spinor_read_uid(struct spinor_info *sni,  void *data, int len);
void spinor_test_uid_securty(const struct device *dev);

#endif
#ifdef	CONFIG_NOR_CODE_IN_RAM
void spinor_resume_finished(struct spinor_info *sni);
#endif

void spi0_nor_xip_lock(void);
void spi0_nor_xip_unlock(void);

#endif	/* __SPI_FLASH_H__ */