1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * Copyright (C) 2006-2009 Freescale Semiconductor, Inc.
4  *
5  * Dave Liu <daveliu@freescale.com>
6  * based on source code of Shlomi Gridish
7  */
8 
9 #ifndef __QE_H__
10 #define __QE_H__
11 
12 #include "common.h"
13 #ifdef CONFIG_U_QE
14 #include <linux/immap_qe.h>
15 #endif
16 
17 #define QE_NUM_OF_BRGS	16
18 #define UCC_MAX_NUM	8
19 
20 #define QE_DATAONLY_BASE	0
21 #define QE_DATAONLY_SIZE	(QE_MURAM_SIZE - QE_DATAONLY_BASE)
22 
23 struct udevice;
24 
25 /* QE threads SNUM
26 */
27 typedef enum qe_snum_state {
28 	QE_SNUM_STATE_USED,   /* used */
29 	QE_SNUM_STATE_FREE    /* free */
30 } qe_snum_state_e;
31 
32 typedef struct qe_snum {
33 	u8		num;   /* snum	*/
34 	qe_snum_state_e	state; /* state */
35 } qe_snum_t;
36 
37 /* QE RISC allocation
38 */
39 #define	QE_RISC_ALLOCATION_RISC1	0x1  /* RISC 1 */
40 #define	QE_RISC_ALLOCATION_RISC2	0x2  /* RISC 2 */
41 #define	QE_RISC_ALLOCATION_RISC3	0x4  /* RISC 3 */
42 #define	QE_RISC_ALLOCATION_RISC4	0x8  /* RISC 4 */
43 #define	QE_RISC_ALLOCATION_RISC1_AND_RISC2 	(QE_RISC_ALLOCATION_RISC1 | \
44 						 QE_RISC_ALLOCATION_RISC2)
45 #define	QE_RISC_ALLOCATION_FOUR_RISCS	(QE_RISC_ALLOCATION_RISC1 | \
46 					 QE_RISC_ALLOCATION_RISC2 | \
47 					 QE_RISC_ALLOCATION_RISC3 | \
48 					 QE_RISC_ALLOCATION_RISC4)
49 
50 /* QE CECR commands for UCC fast.
51 */
52 #define QE_CR_FLG			0x00010000
53 #define QE_RESET			0x80000000
54 #define QE_INIT_TX_RX			0x00000000
55 #define QE_INIT_RX			0x00000001
56 #define QE_INIT_TX			0x00000002
57 #define QE_ENTER_HUNT_MODE		0x00000003
58 #define QE_STOP_TX			0x00000004
59 #define QE_GRACEFUL_STOP_TX		0x00000005
60 #define QE_RESTART_TX			0x00000006
61 #define QE_SWITCH_COMMAND		0x00000007
62 #define QE_SET_GROUP_ADDRESS		0x00000008
63 #define QE_INSERT_CELL			0x00000009
64 #define QE_ATM_TRANSMIT			0x0000000a
65 #define QE_CELL_POOL_GET		0x0000000b
66 #define QE_CELL_POOL_PUT		0x0000000c
67 #define QE_IMA_HOST_CMD			0x0000000d
68 #define QE_ATM_MULTI_THREAD_INIT	0x00000011
69 #define QE_ASSIGN_PAGE			0x00000012
70 #define QE_START_FLOW_CONTROL		0x00000014
71 #define QE_STOP_FLOW_CONTROL		0x00000015
72 #define QE_ASSIGN_PAGE_TO_DEVICE	0x00000016
73 #define QE_GRACEFUL_STOP_RX		0x0000001a
74 #define QE_RESTART_RX			0x0000001b
75 
76 /* QE CECR Sub Block Code - sub block code of QE command.
77 */
78 #define QE_CR_SUBBLOCK_INVALID		0x00000000
79 #define QE_CR_SUBBLOCK_USB		0x03200000
80 #define QE_CR_SUBBLOCK_UCCFAST1		0x02000000
81 #define QE_CR_SUBBLOCK_UCCFAST2		0x02200000
82 #define QE_CR_SUBBLOCK_UCCFAST3		0x02400000
83 #define QE_CR_SUBBLOCK_UCCFAST4		0x02600000
84 #define QE_CR_SUBBLOCK_UCCFAST5		0x02800000
85 #define QE_CR_SUBBLOCK_UCCFAST6		0x02a00000
86 #define QE_CR_SUBBLOCK_UCCFAST7		0x02c00000
87 #define QE_CR_SUBBLOCK_UCCFAST8		0x02e00000
88 #define QE_CR_SUBBLOCK_UCCSLOW1		0x00000000
89 #define QE_CR_SUBBLOCK_UCCSLOW2		0x00200000
90 #define QE_CR_SUBBLOCK_UCCSLOW3		0x00400000
91 #define QE_CR_SUBBLOCK_UCCSLOW4		0x00600000
92 #define QE_CR_SUBBLOCK_UCCSLOW5		0x00800000
93 #define QE_CR_SUBBLOCK_UCCSLOW6		0x00a00000
94 #define QE_CR_SUBBLOCK_UCCSLOW7		0x00c00000
95 #define QE_CR_SUBBLOCK_UCCSLOW8		0x00e00000
96 #define QE_CR_SUBBLOCK_MCC1		0x03800000
97 #define QE_CR_SUBBLOCK_MCC2		0x03a00000
98 #define QE_CR_SUBBLOCK_MCC3		0x03000000
99 #define QE_CR_SUBBLOCK_IDMA1		0x02800000
100 #define QE_CR_SUBBLOCK_IDMA2		0x02a00000
101 #define QE_CR_SUBBLOCK_IDMA3		0x02c00000
102 #define QE_CR_SUBBLOCK_IDMA4		0x02e00000
103 #define QE_CR_SUBBLOCK_HPAC		0x01e00000
104 #define QE_CR_SUBBLOCK_SPI1		0x01400000
105 #define QE_CR_SUBBLOCK_SPI2		0x01600000
106 #define QE_CR_SUBBLOCK_RAND		0x01c00000
107 #define QE_CR_SUBBLOCK_TIMER		0x01e00000
108 #define QE_CR_SUBBLOCK_GENERAL		0x03c00000
109 
110 /* QE CECR Protocol - For non-MCC, specifies mode for QE CECR command.
111 */
112 #define QE_CR_PROTOCOL_UNSPECIFIED	0x00 /* For all other protocols */
113 #define QE_CR_PROTOCOL_HDLC_TRANSPARENT	0x00
114 #define QE_CR_PROTOCOL_ATM_POS		0x0A
115 #define QE_CR_PROTOCOL_ETHERNET		0x0C
116 #define QE_CR_PROTOCOL_L2_SWITCH	0x0D
117 #define QE_CR_PROTOCOL_SHIFT		6
118 
119 /* QE ASSIGN PAGE command
120 */
121 #define QE_CR_ASSIGN_PAGE_SNUM_SHIFT	17
122 
123 /* Communication Direction.
124 */
125 typedef enum comm_dir {
126 	COMM_DIR_NONE		= 0,
127 	COMM_DIR_RX		= 1,
128 	COMM_DIR_TX		= 2,
129 	COMM_DIR_RX_AND_TX	= 3
130 } comm_dir_e;
131 
132 /* Clocks and BRG's
133 */
134 typedef enum qe_clock {
135 	QE_CLK_NONE = 0,
136 	QE_BRG1,     /* Baud Rate Generator  1 */
137 	QE_BRG2,     /* Baud Rate Generator  2 */
138 	QE_BRG3,     /* Baud Rate Generator  3 */
139 	QE_BRG4,     /* Baud Rate Generator  4 */
140 	QE_BRG5,     /* Baud Rate Generator  5 */
141 	QE_BRG6,     /* Baud Rate Generator  6 */
142 	QE_BRG7,     /* Baud Rate Generator  7 */
143 	QE_BRG8,     /* Baud Rate Generator  8 */
144 	QE_BRG9,     /* Baud Rate Generator  9 */
145 	QE_BRG10,    /* Baud Rate Generator 10 */
146 	QE_BRG11,    /* Baud Rate Generator 11 */
147 	QE_BRG12,    /* Baud Rate Generator 12 */
148 	QE_BRG13,    /* Baud Rate Generator 13 */
149 	QE_BRG14,    /* Baud Rate Generator 14 */
150 	QE_BRG15,    /* Baud Rate Generator 15 */
151 	QE_BRG16,    /* Baud Rate Generator 16 */
152 	QE_CLK1,     /* Clock  1	       */
153 	QE_CLK2,     /* Clock  2	       */
154 	QE_CLK3,     /* Clock  3	       */
155 	QE_CLK4,     /* Clock  4	       */
156 	QE_CLK5,     /* Clock  5	       */
157 	QE_CLK6,     /* Clock  6	       */
158 	QE_CLK7,     /* Clock  7	       */
159 	QE_CLK8,     /* Clock  8	       */
160 	QE_CLK9,     /* Clock  9	       */
161 	QE_CLK10,    /* Clock 10	       */
162 	QE_CLK11,    /* Clock 11	       */
163 	QE_CLK12,    /* Clock 12	       */
164 	QE_CLK13,    /* Clock 13	       */
165 	QE_CLK14,    /* Clock 14	       */
166 	QE_CLK15,    /* Clock 15	       */
167 	QE_CLK16,    /* Clock 16	       */
168 	QE_CLK17,    /* Clock 17	       */
169 	QE_CLK18,    /* Clock 18	       */
170 	QE_CLK19,    /* Clock 19	       */
171 	QE_CLK20,    /* Clock 20	       */
172 	QE_CLK21,    /* Clock 21	       */
173 	QE_CLK22,    /* Clock 22	       */
174 	QE_CLK23,    /* Clock 23	       */
175 	QE_CLK24,    /* Clock 24	       */
176 	QE_CLK_DUMMY
177 } qe_clock_e;
178 
179 /* QE CMXGCR register
180 */
181 #define QE_CMXGCR_MII_ENET_MNG_MASK	0x00007000
182 #define QE_CMXGCR_MII_ENET_MNG_SHIFT	12
183 
184 /* QE CMXUCR registers
185  */
186 #define QE_CMXUCR_TX_CLK_SRC_MASK	0x0000000F
187 
188 /* QE BRG configuration register
189 */
190 #define QE_BRGC_ENABLE			0x00010000
191 #define QE_BRGC_DIVISOR_SHIFT		1
192 #define QE_BRGC_DIVISOR_MAX		0xFFF
193 #define QE_BRGC_DIV16			1
194 
195 /* QE SDMA registers
196 */
197 #define QE_SDSR_BER1			0x02000000
198 #define QE_SDSR_BER2			0x01000000
199 
200 #define QE_SDMR_GLB_1_MSK		0x80000000
201 #define QE_SDMR_ADR_SEL			0x20000000
202 #define QE_SDMR_BER1_MSK		0x02000000
203 #define QE_SDMR_BER2_MSK		0x01000000
204 #define QE_SDMR_EB1_MSK			0x00800000
205 #define QE_SDMR_ER1_MSK			0x00080000
206 #define QE_SDMR_ER2_MSK			0x00040000
207 #define QE_SDMR_CEN_MASK		0x0000E000
208 #define QE_SDMR_SBER_1			0x00000200
209 #define QE_SDMR_SBER_2			0x00000200
210 #define QE_SDMR_EB1_PR_MASK		0x000000C0
211 #define QE_SDMR_ER1_PR			0x00000008
212 
213 #define QE_SDMR_CEN_SHIFT		13
214 #define QE_SDMR_EB1_PR_SHIFT		6
215 
216 #define QE_SDTM_MSNUM_SHIFT		24
217 
218 #define QE_SDEBCR_BA_MASK		0x01FFFFFF
219 
220 /* Communication Processor */
221 #define QE_CP_CERCR_MEE		0x8000	/* Multi-user RAM ECC enable */
222 #define QE_CP_CERCR_IEE		0x4000	/* Instruction RAM ECC enable */
223 #define QE_CP_CERCR_CIR		0x0800	/* Common instruction RAM */
224 
225 /* I-RAM */
226 #define QE_IRAM_IADD_AIE	0x80000000	/* Auto Increment Enable */
227 #define QE_IRAM_IADD_BADDR	0x00080000	/* Base Address */
228 #define QE_IRAM_READY		0x80000000
229 
230 /* Structure that defines QE firmware binary files.
231  *
232  * See Documentation/powerpc/qe_firmware.rst in the Linux kernel tree for
233  * a description of these fields.
234  */
235 struct qe_firmware {
236 	struct qe_header {
237 		u32 length;	/* Length of the entire structure, in bytes */
238 		u8 magic[3];	/* Set to { 'Q', 'E', 'F' } */
239 		u8 version;	/* Version of this layout. First ver is '1' */
240 	} header;
241 	u8 id[62];		/* Null-terminated identifier string */
242 	u8 split;		/* 0 = shared I-RAM, 1 = split I-RAM */
243 	u8 count;		/* Number of microcode[] structures */
244 	struct {
245 		u16 model;	/* The SOC model  */
246 		u8 major;	/* The SOC revision major */
247 		u8 minor;	/* The SOC revision minor */
248 	} __attribute__ ((packed)) soc;
249 	u8 padding[4];		/* Reserved, for alignment */
250 	u64 extended_modes;	/* Extended modes */
251 	u32 vtraps[8];		/* Virtual trap addresses */
252 	u8 reserved[4];		/* Reserved, for future expansion */
253 	struct qe_microcode {
254 		u8 id[32];	/* Null-terminated identifier */
255 		u32 traps[16];	/* Trap addresses, 0 == ignore */
256 		u32 eccr;	/* The value for the ECCR register */
257 		u32 iram_offset;/* Offset into I-RAM for the code */
258 		u32 count;	/* Number of 32-bit words of the code */
259 		u32 code_offset;/* Offset of the actual microcode */
260 		u8 major;	/* The microcode version major */
261 		u8 minor;	/* The microcode version minor */
262 		u8 revision;	/* The microcode version revision */
263 		u8 padding;	/* Reserved, for alignment */
264 		u8 reserved[4];	/* Reserved, for future expansion */
265 	} __attribute__ ((packed)) microcode[1];
266 	/* All microcode binaries should be located here */
267 	/* CRC32 should be located here, after the microcode binaries */
268 } __attribute__ ((packed));
269 
270 struct qe_firmware_info {
271 	char id[64];		/* Firmware name */
272 	u32 vtraps[8];		/* Virtual trap addresses */
273 	u64 extended_modes;	/* Extended modes */
274 };
275 
276 void qe_config_iopin(u8 port, u8 pin, int dir, int open_drain, int assign);
277 void qe_issue_cmd(uint cmd, uint sbc, u8 mcn, u32 cmd_data);
278 uint qe_muram_alloc(uint size, uint align);
279 void *qe_muram_addr(uint offset);
280 int qe_get_snum(void);
281 void qe_put_snum(u8 snum);
282 void qe_init(uint qe_base);
283 void qe_reset(void);
284 void qe_assign_page(uint snum, uint para_ram_base);
285 int qe_set_brg(uint brg, uint rate);
286 int qe_set_mii_clk_src(int ucc_num);
287 int qe_upload_firmware(const struct qe_firmware *firmware);
288 struct qe_firmware_info *qe_get_firmware_info(void);
289 void ft_qe_setup(void *blob);
290 void qe_init(uint qe_base);
291 void qe_reset(void);
292 
293 #ifdef CONFIG_U_QE
294 void u_qe_init(void);
295 int u_qe_upload_firmware(const struct qe_firmware *firmware);
296 void u_qe_resume(void);
297 int u_qe_firmware_resume(const struct qe_firmware *firmware,
298 			 qe_map_t *qe_immrr);
299 #endif
300 
301 #if defined(CONFIG_PINCTRL)
302 int par_io_of_config(struct udevice *dev);
303 #endif
304 #endif /* __QE_H__ */
305