[J-u-boot.git] / drivers / spi / cadence_qspi.h

/* SPDX-License-Identifier: GPL-2.0+ */
/*
 * Copyright (C) 2012
 * Altera Corporation <www.altera.com>
 */

#ifndef __CADENCE_QSPI_H__
#define __CADENCE_QSPI_H__

#include <reset.h>

#define CQSPI_IS_ADDR(cmd_len)		(cmd_len > 1 ? 1 : 0)

#define CQSPI_NO_DECODER_MAX_CS		4
#define CQSPI_DECODER_MAX_CS		16
#define CQSPI_READ_CAPTURE_MAX_DELAY	16

struct cadence_spi_plat {
	unsigned int	ref_clk_hz;
	unsigned int	max_hz;
	void		*regbase;
	void		*ahbbase;
	bool		is_decoded_cs;
	u32		fifo_depth;
	u32		fifo_width;
	u32		trigger_address;
	fdt_addr_t	ahbsize;
	bool		use_dac_mode;
	int		read_delay;
	u32		wr_delay;

	/* Flash parameters */
	u32		page_size;
	u32		block_size;
	u32		tshsl_ns;
	u32		tsd2d_ns;
	u32		tchsh_ns;
	u32		tslch_ns;

	/* Transaction protocol parameters. */
	u8		inst_width;
	u8		addr_width;
	u8		data_width;
	bool		dtr;
};

struct cadence_spi_priv {
	void		*regbase;
	void		*ahbbase;
	size_t		cmd_len;
	u8		cmd_buf[32];
	size_t		data_len;

	int		qspi_is_init;
	unsigned int	qspi_calibrated_hz;
	unsigned int	qspi_calibrated_cs;
	unsigned int	previous_hz;

	struct reset_ctl_bulk resets;
};

/* Functions call declaration */
void cadence_qspi_apb_controller_init(struct cadence_spi_plat *plat);
void cadence_qspi_apb_controller_enable(void *reg_base_addr);
void cadence_qspi_apb_controller_disable(void *reg_base_addr);
void cadence_qspi_apb_dac_mode_enable(void *reg_base);

int cadence_qspi_apb_command_read_setup(struct cadence_spi_plat *plat,
					const struct spi_mem_op *op);
int cadence_qspi_apb_command_read(struct cadence_spi_plat *plat,
				  const struct spi_mem_op *op);
int cadence_qspi_apb_command_write_setup(struct cadence_spi_plat *plat,
					 const struct spi_mem_op *op);
int cadence_qspi_apb_command_write(struct cadence_spi_plat *plat,
				   const struct spi_mem_op *op);

int cadence_qspi_apb_read_setup(struct cadence_spi_plat *plat,
				const struct spi_mem_op *op);
int cadence_qspi_apb_read_execute(struct cadence_spi_plat *plat,
				  const struct spi_mem_op *op);
int cadence_qspi_apb_write_setup(struct cadence_spi_plat *plat,
				 const struct spi_mem_op *op);
int cadence_qspi_apb_write_execute(struct cadence_spi_plat *plat,
				   const struct spi_mem_op *op);

void cadence_qspi_apb_chipselect(void *reg_base,
	unsigned int chip_select, unsigned int decoder_enable);
void cadence_qspi_apb_set_clk_mode(void *reg_base, uint mode);
void cadence_qspi_apb_config_baudrate_div(void *reg_base,
	unsigned int ref_clk_hz, unsigned int sclk_hz);
void cadence_qspi_apb_delay(void *reg_base,
	unsigned int ref_clk, unsigned int sclk_hz,
	unsigned int tshsl_ns, unsigned int tsd2d_ns,
	unsigned int tchsh_ns, unsigned int tslch_ns);
void cadence_qspi_apb_enter_xip(void *reg_base, char xip_dummy);
void cadence_qspi_apb_readdata_capture(void *reg_base,
	unsigned int bypass, unsigned int delay);

#endif /* __CADENCE_QSPI_H__ */
Commit	Line	Data
83d290c5	1	/* SPDX-License-Identifier: GPL-2.0+ */
10e8bf88 SR	2	/*
	3	* Copyright (C) 2012
	4	* Altera Corporation <www.altera.com>
10e8bf88 SR	5	*/
	6
	7	#ifndef __CADENCE_QSPI_H__
	8	#define __CADENCE_QSPI_H__
	9
ac7e14ae SG	10	#include <reset.h>
ac7e14ae SG	11
10e8bf88 SR	12	#define CQSPI_IS_ADDR(cmd_len) (cmd_len > 1 ? 1 : 0)
	13
	14	#define CQSPI_NO_DECODER_MAX_CS 4
	15	#define CQSPI_DECODER_MAX_CS 16
	16	#define CQSPI_READ_CAPTURE_MAX_DELAY 16
	17
8a8d24bd	18	struct cadence_spi_plat {
64c7c8c9	19	unsigned int ref_clk_hz;
10e8bf88 SR	20	unsigned int max_hz;
	21	void *regbase;
	22	void *ahbbase;
15a70a5d JR	23	bool is_decoded_cs;
	24	u32 fifo_depth;
	25	u32 fifo_width;
	26	u32 trigger_address;
ffab2121 VR	27	fdt_addr_t ahbsize;
ffab2121 VR	28	bool use_dac_mode;
bd8c8dcd	29	int read_delay;
a6903aa7	30	u32 wr_delay;
10e8bf88	31
15a70a5d	32	/* Flash parameters */
10e8bf88 SR	33	u32 page_size;
	34	u32 block_size;
	35	u32 tshsl_ns;
	36	u32 tsd2d_ns;
	37	u32 tchsh_ns;
	38	u32 tslch_ns;
38b0852b PY	39
	40	/* Transaction protocol parameters. */
	41	u8 inst_width;
	42	u8 addr_width;
	43	u8 data_width;
	44	bool dtr;
10e8bf88 SR	45	};
	46
	47	struct cadence_spi_priv {
	48	void *regbase;
	49	void *ahbbase;
	50	size_t cmd_len;
	51	u8 cmd_buf[32];
	52	size_t data_len;
	53
	54	int qspi_is_init;
	55	unsigned int qspi_calibrated_hz;
	56	unsigned int qspi_calibrated_cs;
98fbd71d	57	unsigned int previous_hz;
ac7e14ae SG	58
ac7e14ae SG	59	struct reset_ctl_bulk resets;
10e8bf88 SR	60	};
	61
	62	/* Functions call declaration */
8a8d24bd	63	void cadence_qspi_apb_controller_init(struct cadence_spi_plat *plat);
10e8bf88 SR	64	void cadence_qspi_apb_controller_enable(void *reg_base_addr);
10e8bf88 SR	65	void cadence_qspi_apb_controller_disable(void *reg_base_addr);
ffab2121	66	void cadence_qspi_apb_dac_mode_enable(void *reg_base);
10e8bf88	67
38b0852b PY	68	int cadence_qspi_apb_command_read_setup(struct cadence_spi_plat *plat,
	69	const struct spi_mem_op *op);
	70	int cadence_qspi_apb_command_read(struct cadence_spi_plat *plat,
d6407720	71	const struct spi_mem_op *op);
38b0852b PY	72	int cadence_qspi_apb_command_write_setup(struct cadence_spi_plat *plat,
	73	const struct spi_mem_op *op);
	74	int cadence_qspi_apb_command_write(struct cadence_spi_plat *plat,
d6407720	75	const struct spi_mem_op *op);
10e8bf88	76
8a8d24bd	77	int cadence_qspi_apb_read_setup(struct cadence_spi_plat *plat,
ffab2121	78	const struct spi_mem_op *op);
8a8d24bd	79	int cadence_qspi_apb_read_execute(struct cadence_spi_plat *plat,
ffab2121	80	const struct spi_mem_op *op);
8a8d24bd	81	int cadence_qspi_apb_write_setup(struct cadence_spi_plat *plat,
ffab2121	82	const struct spi_mem_op *op);
8a8d24bd	83	int cadence_qspi_apb_write_execute(struct cadence_spi_plat *plat,
ffab2121	84	const struct spi_mem_op *op);
10e8bf88 SR	85
	86	void cadence_qspi_apb_chipselect(void *reg_base,
	87	unsigned int chip_select, unsigned int decoder_enable);
7d403f28	88	void cadence_qspi_apb_set_clk_mode(void *reg_base, uint mode);
10e8bf88 SR	89	void cadence_qspi_apb_config_baudrate_div(void *reg_base,
	90	unsigned int ref_clk_hz, unsigned int sclk_hz);
	91	void cadence_qspi_apb_delay(void *reg_base,
	92	unsigned int ref_clk, unsigned int sclk_hz,
	93	unsigned int tshsl_ns, unsigned int tsd2d_ns,
	94	unsigned int tchsh_ns, unsigned int tslch_ns);
	95	void cadence_qspi_apb_enter_xip(void *reg_base, char xip_dummy);
	96	void cadence_qspi_apb_readdata_capture(void *reg_base,
	97	unsigned int bypass, unsigned int delay);
	98
	99	#endif /* __CADENCE_QSPI_H__ */