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

/*
 * Copyright (c) 2011 The Chromium OS Authors.
 *
 * SPDX-License-Identifier:	GPL-2.0+
 *
 * This file is derived from the flashrom project.
 */

#ifndef _ICH_H_
#define _ICH_H_

struct ich7_spi_regs {
	uint16_t spis;
	uint16_t spic;
	uint32_t spia;
	uint64_t spid[8];
	uint64_t _pad;
	uint32_t bbar;
	uint16_t preop;
	uint16_t optype;
	uint8_t opmenu[8];
} __packed;

struct ich9_spi_regs {
	uint32_t bfpr;		/* 0x00 */
	uint16_t hsfs;
	uint16_t hsfc;
	uint32_t faddr;
	uint32_t _reserved0;
	uint32_t fdata[16];	/* 0x10 */
	uint32_t frap;		/* 0x50 */
	uint32_t freg[5];
	uint32_t _reserved1[3];
	uint32_t pr[5];		/* 0x74 */
	uint32_t _reserved2[2];
	uint8_t ssfs;		/* 0x90 */
	uint8_t ssfc[3];
	uint16_t preop;		/* 0x94 */
	uint16_t optype;
	uint8_t opmenu[8];	/* 0x98 */
	uint32_t bbar;
	uint8_t _reserved3[12];
	uint32_t fdoc;		/* 0xb0 */
	uint32_t fdod;
	uint8_t _reserved4[8];
	uint32_t afc;		/* 0xc0 */
	uint32_t lvscc;
	uint32_t uvscc;
	uint8_t _reserved5[4];
	uint32_t fpb;		/* 0xd0 */
	uint8_t _reserved6[28];
	uint32_t srdl;		/* 0xf0 */
	uint32_t srdc;
	uint32_t scs;
	uint32_t bcr;
} __packed;

enum {
	SPIS_SCIP =		0x0001,
	SPIS_GRANT =		0x0002,
	SPIS_CDS =		0x0004,
	SPIS_FCERR =		0x0008,
	SSFS_AEL =		0x0010,
	SPIS_LOCK =		0x8000,
	SPIS_RESERVED_MASK =	0x7ff0,
	SSFS_RESERVED_MASK =	0x7fe2
};

enum {
	SPIC_SCGO =		0x000002,
	SPIC_ACS =		0x000004,
	SPIC_SPOP =		0x000008,
	SPIC_DBC =		0x003f00,
	SPIC_DS =		0x004000,
	SPIC_SME =		0x008000,
	SSFC_SCF_MASK =		0x070000,
	SSFC_RESERVED =		0xf80000,

	/* Mask for speed byte, biuts 23:16 of SSFC */
	SSFC_SCF_33MHZ	=	0x01,
};

enum {
	HSFS_FDONE =		0x0001,
	HSFS_FCERR =		0x0002,
	HSFS_AEL =		0x0004,
	HSFS_BERASE_MASK =	0x0018,
	HSFS_BERASE_SHIFT =	3,
	HSFS_SCIP =		0x0020,
	HSFS_FDOPSS =		0x2000,
	HSFS_FDV =		0x4000,
	HSFS_FLOCKDN =		0x8000
};

enum {
	HSFC_FGO =		0x0001,
	HSFC_FCYCLE_MASK =	0x0006,
	HSFC_FCYCLE_SHIFT =	1,
	HSFC_FDBC_MASK =	0x3f00,
	HSFC_FDBC_SHIFT =	8,
	HSFC_FSMIE =		0x8000
};

enum {
	ICH_MAX_CMD_LEN		= 5,
};

struct spi_trans {
	uint8_t cmd[ICH_MAX_CMD_LEN];
	int cmd_len;
	const uint8_t *out;
	uint32_t bytesout;
	uint8_t *in;
	uint32_t bytesin;
	uint8_t type;
	uint8_t opcode;
	uint32_t offset;
};

#define SPI_OPCODE_WRSR		0x01
#define SPI_OPCODE_PAGE_PROGRAM	0x02
#define SPI_OPCODE_READ		0x03
#define SPI_OPCODE_WRDIS	0x04
#define SPI_OPCODE_RDSR		0x05
#define SPI_OPCODE_WREN		0x06
#define SPI_OPCODE_FAST_READ	0x0b
#define SPI_OPCODE_ERASE_SECT	0x20
#define SPI_OPCODE_READ_ID	0x9f
#define SPI_OPCODE_ERASE_BLOCK	0xd8

#define SPI_OPCODE_TYPE_READ_NO_ADDRESS		0
#define SPI_OPCODE_TYPE_WRITE_NO_ADDRESS	1
#define SPI_OPCODE_TYPE_READ_WITH_ADDRESS	2
#define SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS	3

#define SPI_OPMENU_0	SPI_OPCODE_WRSR
#define SPI_OPTYPE_0	SPI_OPCODE_TYPE_WRITE_NO_ADDRESS

#define SPI_OPMENU_1	SPI_OPCODE_PAGE_PROGRAM
#define SPI_OPTYPE_1	SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS

#define SPI_OPMENU_2	SPI_OPCODE_READ
#define SPI_OPTYPE_2	SPI_OPCODE_TYPE_READ_WITH_ADDRESS

#define SPI_OPMENU_3	SPI_OPCODE_RDSR
#define SPI_OPTYPE_3	SPI_OPCODE_TYPE_READ_NO_ADDRESS

#define SPI_OPMENU_4	SPI_OPCODE_ERASE_SECT
#define SPI_OPTYPE_4	SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS

#define SPI_OPMENU_5	SPI_OPCODE_READ_ID
#define SPI_OPTYPE_5	SPI_OPCODE_TYPE_READ_NO_ADDRESS

#define SPI_OPMENU_6	SPI_OPCODE_ERASE_BLOCK
#define SPI_OPTYPE_6	SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS

#define SPI_OPMENU_7	SPI_OPCODE_FAST_READ
#define SPI_OPTYPE_7	SPI_OPCODE_TYPE_READ_WITH_ADDRESS

#define SPI_OPPREFIX	((SPI_OPCODE_WREN << 8) | SPI_OPCODE_WREN)
#define SPI_OPTYPE	((SPI_OPTYPE_7 << 14) | (SPI_OPTYPE_6 << 12) | \
			 (SPI_OPTYPE_5 << 10) | (SPI_OPTYPE_4 <<  8) | \
			 (SPI_OPTYPE_3 <<  6) | (SPI_OPTYPE_2 <<  4) | \
			 (SPI_OPTYPE_1 <<  2) | (SPI_OPTYPE_0 <<  0))
#define SPI_OPMENU_UPPER ((SPI_OPMENU_7 << 24) | (SPI_OPMENU_6 << 16) | \
			  (SPI_OPMENU_5 <<  8) | (SPI_OPMENU_4 <<  0))
#define SPI_OPMENU_LOWER ((SPI_OPMENU_3 << 24) | (SPI_OPMENU_2 << 16) | \
			  (SPI_OPMENU_1 <<  8) | (SPI_OPMENU_0 <<  0))

enum ich_version {
	ICHV_7,
	ICHV_9,
};

struct ich_spi_platdata {
	enum ich_version ich_version;	/* Controller version, 7 or 9 */
	bool lockdown;			/* lock down controller settings? */
};

struct ich_spi_priv {
	int opmenu;
	int menubytes;
	void *base;		/* Base of register set */
	int preop;
	int optype;
	int addr;
	int data;
	unsigned databytes;
	int status;
	int control;
	int bbar;
	int bcr;
	uint32_t *pr;		/* only for ich9 */
	int speed;		/* pointer to speed control */
	ulong max_speed;	/* Maximum bus speed in MHz */
	ulong cur_speed;	/* Current bus speed */
	struct spi_trans trans;	/* current transaction in progress */
};

#endif /* _ICH_H_ */
Commit	Line	Data
1853030e SG	1	/*
	2	* Copyright (c) 2011 The Chromium OS Authors.
	3	*
1a459660	4	* SPDX-License-Identifier: GPL-2.0+
1853030e SG	5	*
	6	* This file is derived from the flashrom project.
	7	*/
	8
9eb4339b BM	9	#ifndef _ICH_H_
	10	#define _ICH_H_
	11
1853030e SG	12	struct ich7_spi_regs {
	13	uint16_t spis;
	14	uint16_t spic;
	15	uint32_t spia;
	16	uint64_t spid[8];
	17	uint64_t _pad;
	18	uint32_t bbar;
	19	uint16_t preop;
	20	uint16_t optype;
	21	uint8_t opmenu[8];
	22	} __packed;
	23
	24	struct ich9_spi_regs {
9eb4339b	25	uint32_t bfpr; /* 0x00 */
1853030e SG	26	uint16_t hsfs;
	27	uint16_t hsfc;
	28	uint32_t faddr;
	29	uint32_t _reserved0;
9eb4339b BM	30	uint32_t fdata[16]; /* 0x10 */
9eb4339b BM	31	uint32_t frap; /* 0x50 */
1853030e SG	32	uint32_t freg[5];
1853030e SG	33	uint32_t _reserved1[3];
9eb4339b	34	uint32_t pr[5]; /* 0x74 */
1853030e	35	uint32_t _reserved2[2];
9eb4339b	36	uint8_t ssfs; /* 0x90 */
1853030e	37	uint8_t ssfc[3];
9eb4339b	38	uint16_t preop; /* 0x94 */
1853030e	39	uint16_t optype;
9eb4339b	40	uint8_t opmenu[8]; /* 0x98 */
1853030e SG	41	uint32_t bbar;
1853030e SG	42	uint8_t _reserved3[12];
9eb4339b	43	uint32_t fdoc; /* 0xb0 */
1853030e SG	44	uint32_t fdod;
1853030e SG	45	uint8_t _reserved4[8];
9eb4339b	46	uint32_t afc; /* 0xc0 */
1853030e SG	47	uint32_t lvscc;
	48	uint32_t uvscc;
	49	uint8_t _reserved5[4];
9eb4339b	50	uint32_t fpb; /* 0xd0 */
1853030e	51	uint8_t _reserved6[28];
9eb4339b	52	uint32_t srdl; /* 0xf0 */
1853030e	53	uint32_t srdc;
5093badb SG	54	uint32_t scs;
5093badb SG	55	uint32_t bcr;
1853030e SG	56	} __packed;
	57
	58	enum {
	59	SPIS_SCIP = 0x0001,
	60	SPIS_GRANT = 0x0002,
	61	SPIS_CDS = 0x0004,
	62	SPIS_FCERR = 0x0008,
	63	SSFS_AEL = 0x0010,
	64	SPIS_LOCK = 0x8000,
	65	SPIS_RESERVED_MASK = 0x7ff0,
	66	SSFS_RESERVED_MASK = 0x7fe2
	67	};
	68
	69	enum {
	70	SPIC_SCGO = 0x000002,
	71	SPIC_ACS = 0x000004,
	72	SPIC_SPOP = 0x000008,
	73	SPIC_DBC = 0x003f00,
	74	SPIC_DS = 0x004000,
	75	SPIC_SME = 0x008000,
	76	SSFC_SCF_MASK = 0x070000,
	77	SSFC_RESERVED = 0xf80000,
	78
	79	/* Mask for speed byte, biuts 23:16 of SSFC */
	80	SSFC_SCF_33MHZ = 0x01,
	81	};
	82
	83	enum {
	84	HSFS_FDONE = 0x0001,
	85	HSFS_FCERR = 0x0002,
	86	HSFS_AEL = 0x0004,
	87	HSFS_BERASE_MASK = 0x0018,
	88	HSFS_BERASE_SHIFT = 3,
	89	HSFS_SCIP = 0x0020,
	90	HSFS_FDOPSS = 0x2000,
	91	HSFS_FDV = 0x4000,
	92	HSFS_FLOCKDN = 0x8000
	93	};
	94
	95	enum {
	96	HSFC_FGO = 0x0001,
	97	HSFC_FCYCLE_MASK = 0x0006,
	98	HSFC_FCYCLE_SHIFT = 1,
	99	HSFC_FDBC_MASK = 0x3f00,
	100	HSFC_FDBC_SHIFT = 8,
	101	HSFC_FSMIE = 0x8000
	102	};
	103
1853030e SG	104	enum {
	105	ICH_MAX_CMD_LEN = 5,
	106	};
	107
	108	struct spi_trans {
	109	uint8_t cmd[ICH_MAX_CMD_LEN];
	110	int cmd_len;
	111	const uint8_t *out;
	112	uint32_t bytesout;
	113	uint8_t *in;
	114	uint32_t bytesin;
	115	uint8_t type;
	116	uint8_t opcode;
	117	uint32_t offset;
	118	};
	119
4759dffe SR	120	#define SPI_OPCODE_WRSR 0x01
	121	#define SPI_OPCODE_PAGE_PROGRAM 0x02
	122	#define SPI_OPCODE_READ 0x03
	123	#define SPI_OPCODE_WRDIS 0x04
	124	#define SPI_OPCODE_RDSR 0x05
9eb4339b BM	125	#define SPI_OPCODE_WREN 0x06
9eb4339b BM	126	#define SPI_OPCODE_FAST_READ 0x0b
4759dffe SR	127	#define SPI_OPCODE_ERASE_SECT 0x20
	128	#define SPI_OPCODE_READ_ID 0x9f
	129	#define SPI_OPCODE_ERASE_BLOCK 0xd8
	130
	131	#define SPI_OPCODE_TYPE_READ_NO_ADDRESS 0
	132	#define SPI_OPCODE_TYPE_WRITE_NO_ADDRESS 1
	133	#define SPI_OPCODE_TYPE_READ_WITH_ADDRESS 2
	134	#define SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS 3
	135
	136	#define SPI_OPMENU_0 SPI_OPCODE_WRSR
	137	#define SPI_OPTYPE_0 SPI_OPCODE_TYPE_WRITE_NO_ADDRESS
	138
	139	#define SPI_OPMENU_1 SPI_OPCODE_PAGE_PROGRAM
	140	#define SPI_OPTYPE_1 SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS
	141
	142	#define SPI_OPMENU_2 SPI_OPCODE_READ
	143	#define SPI_OPTYPE_2 SPI_OPCODE_TYPE_READ_WITH_ADDRESS
	144
	145	#define SPI_OPMENU_3 SPI_OPCODE_RDSR
	146	#define SPI_OPTYPE_3 SPI_OPCODE_TYPE_READ_NO_ADDRESS
	147
	148	#define SPI_OPMENU_4 SPI_OPCODE_ERASE_SECT
	149	#define SPI_OPTYPE_4 SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS
	150
	151	#define SPI_OPMENU_5 SPI_OPCODE_READ_ID
	152	#define SPI_OPTYPE_5 SPI_OPCODE_TYPE_READ_NO_ADDRESS
	153
	154	#define SPI_OPMENU_6 SPI_OPCODE_ERASE_BLOCK
	155	#define SPI_OPTYPE_6 SPI_OPCODE_TYPE_WRITE_WITH_ADDRESS
	156
	157	#define SPI_OPMENU_7 SPI_OPCODE_FAST_READ
	158	#define SPI_OPTYPE_7 SPI_OPCODE_TYPE_READ_WITH_ADDRESS
	159
	160	#define SPI_OPPREFIX ((SPI_OPCODE_WREN << 8) \| SPI_OPCODE_WREN)
	161	#define SPI_OPTYPE ((SPI_OPTYPE_7 << 14) \| (SPI_OPTYPE_6 << 12) \| \
	162	(SPI_OPTYPE_5 << 10) \| (SPI_OPTYPE_4 << 8) \| \
	163	(SPI_OPTYPE_3 << 6) \| (SPI_OPTYPE_2 << 4) \| \
	164	(SPI_OPTYPE_1 << 2) \| (SPI_OPTYPE_0 << 0))
	165	#define SPI_OPMENU_UPPER ((SPI_OPMENU_7 << 24) \| (SPI_OPMENU_6 << 16) \| \
	166	(SPI_OPMENU_5 << 8) \| (SPI_OPMENU_4 << 0))
	167	#define SPI_OPMENU_LOWER ((SPI_OPMENU_3 << 24) \| (SPI_OPMENU_2 << 16) \| \
	168	(SPI_OPMENU_1 << 8) \| (SPI_OPMENU_0 << 0))
9eb4339b	169
6e670b5c BM	170	enum ich_version {
	171	ICHV_7,
	172	ICHV_9,
	173	};
	174
9eb4339b	175	struct ich_spi_platdata {
6e670b5c	176	enum ich_version ich_version; /* Controller version, 7 or 9 */
ab201074	177	bool lockdown; /* lock down controller settings? */
9eb4339b BM	178	};
	179
	180	struct ich_spi_priv {
9eb4339b BM	181	int opmenu;
	182	int menubytes;
	183	void base; / Base of register set */
	184	int preop;
	185	int optype;
	186	int addr;
	187	int data;
	188	unsigned databytes;
	189	int status;
	190	int control;
	191	int bbar;
	192	int bcr;
	193	uint32_t pr; / only for ich9 */
	194	int speed; /* pointer to speed control */
	195	ulong max_speed; /* Maximum bus speed in MHz */
	196	ulong cur_speed; /* Current bus speed */
1853030e	197	struct spi_trans trans; /* current transaction in progress */
1853030e	198	};
9eb4339b BM	199
9eb4339b BM	200	#endif /* _ICH_H_ */