• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2006 Freescale Semicondutor, Inc. All rights reserved.
3  *
4  * Authors: 	Shlomi Gridish <gridish@freescale.com>
5  * 		Li Yang <leoli@freescale.com>
6  *
7  * Description:
8  * QUICC Engine (QE) external definitions and structure.
9  *
10  * This program is free software; you can redistribute  it and/or modify it
11  * under  the terms of  the GNU General  Public License as published by the
12  * Free Software Foundation;  either version 2 of the  License, or (at your
13  * option) any later version.
14  */
15 #ifndef _ASM_POWERPC_QE_H
16 #define _ASM_POWERPC_QE_H
17 #ifdef __KERNEL__
18 
19 #include <linux/spinlock.h>
20 #include <linux/errno.h>
21 #include <linux/err.h>
22 #include <asm/cpm.h>
23 #include <asm/immap_qe.h>
24 
25 #define QE_NUM_OF_SNUM	28
26 #define QE_NUM_OF_BRGS	16
27 #define QE_NUM_OF_PORTS	1024
28 
29 /* Memory partitions
30 */
31 #define MEM_PART_SYSTEM		0
32 #define MEM_PART_SECONDARY	1
33 #define MEM_PART_MURAM		2
34 
35 /* Clocks and BRGs */
36 enum qe_clock {
37 	QE_CLK_NONE = 0,
38 	QE_BRG1,		/* Baud Rate Generator 1 */
39 	QE_BRG2,		/* Baud Rate Generator 2 */
40 	QE_BRG3,		/* Baud Rate Generator 3 */
41 	QE_BRG4,		/* Baud Rate Generator 4 */
42 	QE_BRG5,		/* Baud Rate Generator 5 */
43 	QE_BRG6,		/* Baud Rate Generator 6 */
44 	QE_BRG7,		/* Baud Rate Generator 7 */
45 	QE_BRG8,		/* Baud Rate Generator 8 */
46 	QE_BRG9,		/* Baud Rate Generator 9 */
47 	QE_BRG10,		/* Baud Rate Generator 10 */
48 	QE_BRG11,		/* Baud Rate Generator 11 */
49 	QE_BRG12,		/* Baud Rate Generator 12 */
50 	QE_BRG13,		/* Baud Rate Generator 13 */
51 	QE_BRG14,		/* Baud Rate Generator 14 */
52 	QE_BRG15,		/* Baud Rate Generator 15 */
53 	QE_BRG16,		/* Baud Rate Generator 16 */
54 	QE_CLK1,		/* Clock 1 */
55 	QE_CLK2,		/* Clock 2 */
56 	QE_CLK3,		/* Clock 3 */
57 	QE_CLK4,		/* Clock 4 */
58 	QE_CLK5,		/* Clock 5 */
59 	QE_CLK6,		/* Clock 6 */
60 	QE_CLK7,		/* Clock 7 */
61 	QE_CLK8,		/* Clock 8 */
62 	QE_CLK9,		/* Clock 9 */
63 	QE_CLK10,		/* Clock 10 */
64 	QE_CLK11,		/* Clock 11 */
65 	QE_CLK12,		/* Clock 12 */
66 	QE_CLK13,		/* Clock 13 */
67 	QE_CLK14,		/* Clock 14 */
68 	QE_CLK15,		/* Clock 15 */
69 	QE_CLK16,		/* Clock 16 */
70 	QE_CLK17,		/* Clock 17 */
71 	QE_CLK18,		/* Clock 18 */
72 	QE_CLK19,		/* Clock 19 */
73 	QE_CLK20,		/* Clock 20 */
74 	QE_CLK21,		/* Clock 21 */
75 	QE_CLK22,		/* Clock 22 */
76 	QE_CLK23,		/* Clock 23 */
77 	QE_CLK24,		/* Clock 24 */
78 	QE_CLK_DUMMY
79 };
80 
qe_clock_is_brg(enum qe_clock clk)81 static inline bool qe_clock_is_brg(enum qe_clock clk)
82 {
83 	return clk >= QE_BRG1 && clk <= QE_BRG16;
84 }
85 
86 extern spinlock_t cmxgcr_lock;
87 
88 /* Export QE common operations */
89 #ifdef CONFIG_QUICC_ENGINE
90 extern void __init qe_reset(void);
91 #else
qe_reset(void)92 static inline void qe_reset(void) {}
93 #endif
94 
95 /* QE PIO */
96 #define QE_PIO_PINS 32
97 
98 struct qe_pio_regs {
99 	__be32	cpodr;		/* Open drain register */
100 	__be32	cpdata;		/* Data register */
101 	__be32	cpdir1;		/* Direction register */
102 	__be32	cpdir2;		/* Direction register */
103 	__be32	cppar1;		/* Pin assignment register */
104 	__be32	cppar2;		/* Pin assignment register */
105 #ifdef CONFIG_PPC_85xx
106 	u8	pad[8];
107 #endif
108 };
109 
110 #define QE_PIO_DIR_IN	2
111 #define QE_PIO_DIR_OUT	1
112 extern void __par_io_config_pin(struct qe_pio_regs __iomem *par_io, u8 pin,
113 				int dir, int open_drain, int assignment,
114 				int has_irq);
115 #ifdef CONFIG_QUICC_ENGINE
116 extern int par_io_init(struct device_node *np);
117 extern int par_io_of_config(struct device_node *np);
118 extern int par_io_config_pin(u8 port, u8 pin, int dir, int open_drain,
119 			     int assignment, int has_irq);
120 extern int par_io_data_set(u8 port, u8 pin, u8 val);
121 #else
par_io_init(struct device_node * np)122 static inline int par_io_init(struct device_node *np) { return -ENOSYS; }
par_io_of_config(struct device_node * np)123 static inline int par_io_of_config(struct device_node *np) { return -ENOSYS; }
par_io_config_pin(u8 port,u8 pin,int dir,int open_drain,int assignment,int has_irq)124 static inline int par_io_config_pin(u8 port, u8 pin, int dir, int open_drain,
125 		int assignment, int has_irq) { return -ENOSYS; }
par_io_data_set(u8 port,u8 pin,u8 val)126 static inline int par_io_data_set(u8 port, u8 pin, u8 val) { return -ENOSYS; }
127 #endif /* CONFIG_QUICC_ENGINE */
128 
129 /*
130  * Pin multiplexing functions.
131  */
132 struct qe_pin;
133 #ifdef CONFIG_QE_GPIO
134 extern struct qe_pin *qe_pin_request(struct device_node *np, int index);
135 extern void qe_pin_free(struct qe_pin *qe_pin);
136 extern void qe_pin_set_gpio(struct qe_pin *qe_pin);
137 extern void qe_pin_set_dedicated(struct qe_pin *pin);
138 #else
qe_pin_request(struct device_node * np,int index)139 static inline struct qe_pin *qe_pin_request(struct device_node *np, int index)
140 {
141 	return ERR_PTR(-ENOSYS);
142 }
qe_pin_free(struct qe_pin * qe_pin)143 static inline void qe_pin_free(struct qe_pin *qe_pin) {}
qe_pin_set_gpio(struct qe_pin * qe_pin)144 static inline void qe_pin_set_gpio(struct qe_pin *qe_pin) {}
qe_pin_set_dedicated(struct qe_pin * pin)145 static inline void qe_pin_set_dedicated(struct qe_pin *pin) {}
146 #endif /* CONFIG_QE_GPIO */
147 
148 /* QE internal API */
149 int qe_issue_cmd(u32 cmd, u32 device, u8 mcn_protocol, u32 cmd_input);
150 enum qe_clock qe_clock_source(const char *source);
151 unsigned int qe_get_brg_clk(void);
152 int qe_setbrg(enum qe_clock brg, unsigned int rate, unsigned int multiplier);
153 int qe_get_snum(void);
154 void qe_put_snum(u8 snum);
155 /* we actually use cpm_muram implementation, define this for convenience */
156 #define qe_muram_init cpm_muram_init
157 #define qe_muram_alloc cpm_muram_alloc
158 #define qe_muram_alloc_fixed cpm_muram_alloc_fixed
159 #define qe_muram_free cpm_muram_free
160 #define qe_muram_addr cpm_muram_addr
161 #define qe_muram_offset cpm_muram_offset
162 
163 /* Structure that defines QE firmware binary files.
164  *
165  * See Documentation/powerpc/qe-firmware.txt for a description of these
166  * fields.
167  */
168 struct qe_firmware {
169 	struct qe_header {
170 		__be32 length;  /* Length of the entire structure, in bytes */
171 		u8 magic[3];    /* Set to { 'Q', 'E', 'F' } */
172 		u8 version;     /* Version of this layout. First ver is '1' */
173 	} header;
174 	u8 id[62];      /* Null-terminated identifier string */
175 	u8 split;	/* 0 = shared I-RAM, 1 = split I-RAM */
176 	u8 count;       /* Number of microcode[] structures */
177 	struct {
178 		__be16 model;   	/* The SOC model  */
179 		u8 major;       	/* The SOC revision major */
180 		u8 minor;       	/* The SOC revision minor */
181 	} __attribute__ ((packed)) soc;
182 	u8 padding[4];			/* Reserved, for alignment */
183 	__be64 extended_modes;		/* Extended modes */
184 	__be32 vtraps[8];		/* Virtual trap addresses */
185 	u8 reserved[4];			/* Reserved, for future expansion */
186 	struct qe_microcode {
187 		u8 id[32];      	/* Null-terminated identifier */
188 		__be32 traps[16];       /* Trap addresses, 0 == ignore */
189 		__be32 eccr;    	/* The value for the ECCR register */
190 		__be32 iram_offset;     /* Offset into I-RAM for the code */
191 		__be32 count;   	/* Number of 32-bit words of the code */
192 		__be32 code_offset;     /* Offset of the actual microcode */
193 		u8 major;       	/* The microcode version major */
194 		u8 minor;       	/* The microcode version minor */
195 		u8 revision;		/* The microcode version revision */
196 		u8 padding;		/* Reserved, for alignment */
197 		u8 reserved[4];		/* Reserved, for future expansion */
198 	} __attribute__ ((packed)) microcode[1];
199 	/* All microcode binaries should be located here */
200 	/* CRC32 should be located here, after the microcode binaries */
201 } __attribute__ ((packed));
202 
203 struct qe_firmware_info {
204 	char id[64];		/* Firmware name */
205 	u32 vtraps[8];		/* Virtual trap addresses */
206 	u64 extended_modes;	/* Extended modes */
207 };
208 
209 /* Upload a firmware to the QE */
210 int qe_upload_firmware(const struct qe_firmware *firmware);
211 
212 /* Obtain information on the uploaded firmware */
213 struct qe_firmware_info *qe_get_firmware_info(void);
214 
215 /* QE USB */
216 int qe_usb_clock_set(enum qe_clock clk, int rate);
217 
218 /* Buffer descriptors */
219 struct qe_bd {
220 	__be16 status;
221 	__be16 length;
222 	__be32 buf;
223 } __attribute__ ((packed));
224 
225 #define BD_STATUS_MASK	0xffff0000
226 #define BD_LENGTH_MASK	0x0000ffff
227 
228 /* Alignment */
229 #define QE_INTR_TABLE_ALIGN	16	/* ??? */
230 #define QE_ALIGNMENT_OF_BD	8
231 #define QE_ALIGNMENT_OF_PRAM	64
232 
233 /* RISC allocation */
234 enum qe_risc_allocation {
235 	QE_RISC_ALLOCATION_RISC1 = 1,	/* RISC 1 */
236 	QE_RISC_ALLOCATION_RISC2 = 2,	/* RISC 2 */
237 	QE_RISC_ALLOCATION_RISC1_AND_RISC2 = 3	/* Dynamically choose
238 						   RISC 1 or RISC 2 */
239 };
240 
241 /* QE extended filtering Table Lookup Key Size */
242 enum qe_fltr_tbl_lookup_key_size {
243 	QE_FLTR_TABLE_LOOKUP_KEY_SIZE_8_BYTES
244 		= 0x3f,		/* LookupKey parsed by the Generate LookupKey
245 				   CMD is truncated to 8 bytes */
246 	QE_FLTR_TABLE_LOOKUP_KEY_SIZE_16_BYTES
247 		= 0x5f,		/* LookupKey parsed by the Generate LookupKey
248 				   CMD is truncated to 16 bytes */
249 };
250 
251 /* QE FLTR extended filtering Largest External Table Lookup Key Size */
252 enum qe_fltr_largest_external_tbl_lookup_key_size {
253 	QE_FLTR_LARGEST_EXTERNAL_TABLE_LOOKUP_KEY_SIZE_NONE
254 		= 0x0,/* not used */
255 	QE_FLTR_LARGEST_EXTERNAL_TABLE_LOOKUP_KEY_SIZE_8_BYTES
256 		= QE_FLTR_TABLE_LOOKUP_KEY_SIZE_8_BYTES,	/* 8 bytes */
257 	QE_FLTR_LARGEST_EXTERNAL_TABLE_LOOKUP_KEY_SIZE_16_BYTES
258 		= QE_FLTR_TABLE_LOOKUP_KEY_SIZE_16_BYTES,	/* 16 bytes */
259 };
260 
261 /* structure representing QE parameter RAM */
262 struct qe_timer_tables {
263 	u16 tm_base;		/* QE timer table base adr */
264 	u16 tm_ptr;		/* QE timer table pointer */
265 	u16 r_tmr;		/* QE timer mode register */
266 	u16 r_tmv;		/* QE timer valid register */
267 	u32 tm_cmd;		/* QE timer cmd register */
268 	u32 tm_cnt;		/* QE timer internal cnt */
269 } __attribute__ ((packed));
270 
271 #define QE_FLTR_TAD_SIZE	8
272 
273 /* QE extended filtering Termination Action Descriptor (TAD) */
274 struct qe_fltr_tad {
275 	u8 serialized[QE_FLTR_TAD_SIZE];
276 } __attribute__ ((packed));
277 
278 /* Communication Direction */
279 enum comm_dir {
280 	COMM_DIR_NONE = 0,
281 	COMM_DIR_RX = 1,
282 	COMM_DIR_TX = 2,
283 	COMM_DIR_RX_AND_TX = 3
284 };
285 
286 /* QE CMXUCR Registers.
287  * There are two UCCs represented in each of the four CMXUCR registers.
288  * These values are for the UCC in the LSBs
289  */
290 #define QE_CMXUCR_MII_ENET_MNG		0x00007000
291 #define QE_CMXUCR_MII_ENET_MNG_SHIFT	12
292 #define QE_CMXUCR_GRANT			0x00008000
293 #define QE_CMXUCR_TSA			0x00004000
294 #define QE_CMXUCR_BKPT			0x00000100
295 #define QE_CMXUCR_TX_CLK_SRC_MASK	0x0000000F
296 
297 /* QE CMXGCR Registers.
298 */
299 #define QE_CMXGCR_MII_ENET_MNG		0x00007000
300 #define QE_CMXGCR_MII_ENET_MNG_SHIFT	12
301 #define QE_CMXGCR_USBCS			0x0000000f
302 #define QE_CMXGCR_USBCS_CLK3		0x1
303 #define QE_CMXGCR_USBCS_CLK5		0x2
304 #define QE_CMXGCR_USBCS_CLK7		0x3
305 #define QE_CMXGCR_USBCS_CLK9		0x4
306 #define QE_CMXGCR_USBCS_CLK13		0x5
307 #define QE_CMXGCR_USBCS_CLK17		0x6
308 #define QE_CMXGCR_USBCS_CLK19		0x7
309 #define QE_CMXGCR_USBCS_CLK21		0x8
310 #define QE_CMXGCR_USBCS_BRG9		0x9
311 #define QE_CMXGCR_USBCS_BRG10		0xa
312 
313 /* QE CECR Commands.
314 */
315 #define QE_CR_FLG			0x00010000
316 #define QE_RESET			0x80000000
317 #define QE_INIT_TX_RX			0x00000000
318 #define QE_INIT_RX			0x00000001
319 #define QE_INIT_TX			0x00000002
320 #define QE_ENTER_HUNT_MODE		0x00000003
321 #define QE_STOP_TX			0x00000004
322 #define QE_GRACEFUL_STOP_TX		0x00000005
323 #define QE_RESTART_TX			0x00000006
324 #define QE_CLOSE_RX_BD			0x00000007
325 #define QE_SWITCH_COMMAND		0x00000007
326 #define QE_SET_GROUP_ADDRESS		0x00000008
327 #define QE_START_IDMA			0x00000009
328 #define QE_MCC_STOP_RX			0x00000009
329 #define QE_ATM_TRANSMIT			0x0000000a
330 #define QE_HPAC_CLEAR_ALL		0x0000000b
331 #define QE_GRACEFUL_STOP_RX		0x0000001a
332 #define QE_RESTART_RX			0x0000001b
333 #define QE_HPAC_SET_PRIORITY		0x0000010b
334 #define QE_HPAC_STOP_TX			0x0000020b
335 #define QE_HPAC_STOP_RX			0x0000030b
336 #define QE_HPAC_GRACEFUL_STOP_TX	0x0000040b
337 #define QE_HPAC_GRACEFUL_STOP_RX	0x0000050b
338 #define QE_HPAC_START_TX		0x0000060b
339 #define QE_HPAC_START_RX		0x0000070b
340 #define QE_USB_STOP_TX			0x0000000a
341 #define QE_USB_RESTART_TX		0x0000000c
342 #define QE_QMC_STOP_TX			0x0000000c
343 #define QE_QMC_STOP_RX			0x0000000d
344 #define QE_SS7_SU_FIL_RESET		0x0000000e
345 /* jonathbr added from here down for 83xx */
346 #define QE_RESET_BCS			0x0000000a
347 #define QE_MCC_INIT_TX_RX_16		0x00000003
348 #define QE_MCC_STOP_TX			0x00000004
349 #define QE_MCC_INIT_TX_1		0x00000005
350 #define QE_MCC_INIT_RX_1		0x00000006
351 #define QE_MCC_RESET			0x00000007
352 #define QE_SET_TIMER			0x00000008
353 #define QE_RANDOM_NUMBER		0x0000000c
354 #define QE_ATM_MULTI_THREAD_INIT	0x00000011
355 #define QE_ASSIGN_PAGE			0x00000012
356 #define QE_ADD_REMOVE_HASH_ENTRY	0x00000013
357 #define QE_START_FLOW_CONTROL		0x00000014
358 #define QE_STOP_FLOW_CONTROL		0x00000015
359 #define QE_ASSIGN_PAGE_TO_DEVICE	0x00000016
360 
361 #define QE_ASSIGN_RISC			0x00000010
362 #define QE_CR_MCN_NORMAL_SHIFT		6
363 #define QE_CR_MCN_USB_SHIFT		4
364 #define QE_CR_MCN_RISC_ASSIGN_SHIFT	8
365 #define QE_CR_SNUM_SHIFT		17
366 
367 /* QE CECR Sub Block - sub block of QE command.
368 */
369 #define QE_CR_SUBBLOCK_INVALID		0x00000000
370 #define QE_CR_SUBBLOCK_USB		0x03200000
371 #define QE_CR_SUBBLOCK_UCCFAST1		0x02000000
372 #define QE_CR_SUBBLOCK_UCCFAST2		0x02200000
373 #define QE_CR_SUBBLOCK_UCCFAST3		0x02400000
374 #define QE_CR_SUBBLOCK_UCCFAST4		0x02600000
375 #define QE_CR_SUBBLOCK_UCCFAST5		0x02800000
376 #define QE_CR_SUBBLOCK_UCCFAST6		0x02a00000
377 #define QE_CR_SUBBLOCK_UCCFAST7		0x02c00000
378 #define QE_CR_SUBBLOCK_UCCFAST8		0x02e00000
379 #define QE_CR_SUBBLOCK_UCCSLOW1		0x00000000
380 #define QE_CR_SUBBLOCK_UCCSLOW2		0x00200000
381 #define QE_CR_SUBBLOCK_UCCSLOW3		0x00400000
382 #define QE_CR_SUBBLOCK_UCCSLOW4		0x00600000
383 #define QE_CR_SUBBLOCK_UCCSLOW5		0x00800000
384 #define QE_CR_SUBBLOCK_UCCSLOW6		0x00a00000
385 #define QE_CR_SUBBLOCK_UCCSLOW7		0x00c00000
386 #define QE_CR_SUBBLOCK_UCCSLOW8		0x00e00000
387 #define QE_CR_SUBBLOCK_MCC1		0x03800000
388 #define QE_CR_SUBBLOCK_MCC2		0x03a00000
389 #define QE_CR_SUBBLOCK_MCC3		0x03000000
390 #define QE_CR_SUBBLOCK_IDMA1		0x02800000
391 #define QE_CR_SUBBLOCK_IDMA2		0x02a00000
392 #define QE_CR_SUBBLOCK_IDMA3		0x02c00000
393 #define QE_CR_SUBBLOCK_IDMA4		0x02e00000
394 #define QE_CR_SUBBLOCK_HPAC		0x01e00000
395 #define QE_CR_SUBBLOCK_SPI1		0x01400000
396 #define QE_CR_SUBBLOCK_SPI2		0x01600000
397 #define QE_CR_SUBBLOCK_RAND		0x01c00000
398 #define QE_CR_SUBBLOCK_TIMER		0x01e00000
399 #define QE_CR_SUBBLOCK_GENERAL		0x03c00000
400 
401 /* QE CECR Protocol - For non-MCC, specifies mode for QE CECR command */
402 #define QE_CR_PROTOCOL_UNSPECIFIED	0x00	/* For all other protocols */
403 #define QE_CR_PROTOCOL_HDLC_TRANSPARENT	0x00
404 #define QE_CR_PROTOCOL_QMC		0x02
405 #define QE_CR_PROTOCOL_UART		0x04
406 #define QE_CR_PROTOCOL_ATM_POS		0x0A
407 #define QE_CR_PROTOCOL_ETHERNET		0x0C
408 #define QE_CR_PROTOCOL_L2_SWITCH	0x0D
409 
410 /* BRG configuration register */
411 #define QE_BRGC_ENABLE		0x00010000
412 #define QE_BRGC_DIVISOR_SHIFT	1
413 #define QE_BRGC_DIVISOR_MAX	0xFFF
414 #define QE_BRGC_DIV16		1
415 
416 /* QE Timers registers */
417 #define QE_GTCFR1_PCAS	0x80
418 #define QE_GTCFR1_STP2	0x20
419 #define QE_GTCFR1_RST2	0x10
420 #define QE_GTCFR1_GM2	0x08
421 #define QE_GTCFR1_GM1	0x04
422 #define QE_GTCFR1_STP1	0x02
423 #define QE_GTCFR1_RST1	0x01
424 
425 /* SDMA registers */
426 #define QE_SDSR_BER1	0x02000000
427 #define QE_SDSR_BER2	0x01000000
428 
429 #define QE_SDMR_GLB_1_MSK	0x80000000
430 #define QE_SDMR_ADR_SEL		0x20000000
431 #define QE_SDMR_BER1_MSK	0x02000000
432 #define QE_SDMR_BER2_MSK	0x01000000
433 #define QE_SDMR_EB1_MSK		0x00800000
434 #define QE_SDMR_ER1_MSK		0x00080000
435 #define QE_SDMR_ER2_MSK		0x00040000
436 #define QE_SDMR_CEN_MASK	0x0000E000
437 #define QE_SDMR_SBER_1		0x00000200
438 #define QE_SDMR_SBER_2		0x00000200
439 #define QE_SDMR_EB1_PR_MASK	0x000000C0
440 #define QE_SDMR_ER1_PR		0x00000008
441 
442 #define QE_SDMR_CEN_SHIFT	13
443 #define QE_SDMR_EB1_PR_SHIFT	6
444 
445 #define QE_SDTM_MSNUM_SHIFT	24
446 
447 #define QE_SDEBCR_BA_MASK	0x01FFFFFF
448 
449 /* Communication Processor */
450 #define QE_CP_CERCR_MEE		0x8000	/* Multi-user RAM ECC enable */
451 #define QE_CP_CERCR_IEE		0x4000	/* Instruction RAM ECC enable */
452 #define QE_CP_CERCR_CIR		0x0800	/* Common instruction RAM */
453 
454 /* I-RAM */
455 #define QE_IRAM_IADD_AIE	0x80000000	/* Auto Increment Enable */
456 #define QE_IRAM_IADD_BADDR	0x00080000	/* Base Address */
457 
458 /* UPC */
459 #define UPGCR_PROTOCOL	0x80000000	/* protocol ul2 or pl2 */
460 #define UPGCR_TMS	0x40000000	/* Transmit master/slave mode */
461 #define UPGCR_RMS	0x20000000	/* Receive master/slave mode */
462 #define UPGCR_ADDR	0x10000000	/* Master MPHY Addr multiplexing */
463 #define UPGCR_DIAG	0x01000000	/* Diagnostic mode */
464 
465 /* UCC GUEMR register */
466 #define UCC_GUEMR_MODE_MASK_RX	0x02
467 #define UCC_GUEMR_MODE_FAST_RX	0x02
468 #define UCC_GUEMR_MODE_SLOW_RX	0x00
469 #define UCC_GUEMR_MODE_MASK_TX	0x01
470 #define UCC_GUEMR_MODE_FAST_TX	0x01
471 #define UCC_GUEMR_MODE_SLOW_TX	0x00
472 #define UCC_GUEMR_MODE_MASK (UCC_GUEMR_MODE_MASK_RX | UCC_GUEMR_MODE_MASK_TX)
473 #define UCC_GUEMR_SET_RESERVED3	0x10	/* Bit 3 in the guemr is reserved but
474 					   must be set 1 */
475 
476 /* structure representing UCC SLOW parameter RAM */
477 struct ucc_slow_pram {
478 	__be16 rbase;		/* RX BD base address */
479 	__be16 tbase;		/* TX BD base address */
480 	u8 rbmr;		/* RX bus mode register (same as CPM's RFCR) */
481 	u8 tbmr;		/* TX bus mode register (same as CPM's TFCR) */
482 	__be16 mrblr;		/* Rx buffer length */
483 	__be32 rstate;		/* Rx internal state */
484 	__be32 rptr;		/* Rx internal data pointer */
485 	__be16 rbptr;		/* rb BD Pointer */
486 	__be16 rcount;		/* Rx internal byte count */
487 	__be32 rtemp;		/* Rx temp */
488 	__be32 tstate;		/* Tx internal state */
489 	__be32 tptr;		/* Tx internal data pointer */
490 	__be16 tbptr;		/* Tx BD pointer */
491 	__be16 tcount;		/* Tx byte count */
492 	__be32 ttemp;		/* Tx temp */
493 	__be32 rcrc;		/* temp receive CRC */
494 	__be32 tcrc;		/* temp transmit CRC */
495 } __attribute__ ((packed));
496 
497 /* General UCC SLOW Mode Register (GUMRH & GUMRL) */
498 #define UCC_SLOW_GUMR_H_SAM_QMC		0x00000000
499 #define UCC_SLOW_GUMR_H_SAM_SATM	0x00008000
500 #define UCC_SLOW_GUMR_H_REVD		0x00002000
501 #define UCC_SLOW_GUMR_H_TRX		0x00001000
502 #define UCC_SLOW_GUMR_H_TTX		0x00000800
503 #define UCC_SLOW_GUMR_H_CDP		0x00000400
504 #define UCC_SLOW_GUMR_H_CTSP		0x00000200
505 #define UCC_SLOW_GUMR_H_CDS		0x00000100
506 #define UCC_SLOW_GUMR_H_CTSS		0x00000080
507 #define UCC_SLOW_GUMR_H_TFL		0x00000040
508 #define UCC_SLOW_GUMR_H_RFW		0x00000020
509 #define UCC_SLOW_GUMR_H_TXSY		0x00000010
510 #define UCC_SLOW_GUMR_H_4SYNC		0x00000004
511 #define UCC_SLOW_GUMR_H_8SYNC		0x00000008
512 #define UCC_SLOW_GUMR_H_16SYNC		0x0000000c
513 #define UCC_SLOW_GUMR_H_RTSM		0x00000002
514 #define UCC_SLOW_GUMR_H_RSYN		0x00000001
515 
516 #define UCC_SLOW_GUMR_L_TCI		0x10000000
517 #define UCC_SLOW_GUMR_L_RINV		0x02000000
518 #define UCC_SLOW_GUMR_L_TINV		0x01000000
519 #define UCC_SLOW_GUMR_L_TEND		0x00040000
520 #define UCC_SLOW_GUMR_L_TDCR_MASK	0x00030000
521 #define UCC_SLOW_GUMR_L_TDCR_32	        0x00030000
522 #define UCC_SLOW_GUMR_L_TDCR_16	        0x00020000
523 #define UCC_SLOW_GUMR_L_TDCR_8	        0x00010000
524 #define UCC_SLOW_GUMR_L_TDCR_1	        0x00000000
525 #define UCC_SLOW_GUMR_L_RDCR_MASK	0x0000c000
526 #define UCC_SLOW_GUMR_L_RDCR_32		0x0000c000
527 #define UCC_SLOW_GUMR_L_RDCR_16	        0x00008000
528 #define UCC_SLOW_GUMR_L_RDCR_8	        0x00004000
529 #define UCC_SLOW_GUMR_L_RDCR_1		0x00000000
530 #define UCC_SLOW_GUMR_L_RENC_NRZI	0x00000800
531 #define UCC_SLOW_GUMR_L_RENC_NRZ	0x00000000
532 #define UCC_SLOW_GUMR_L_TENC_NRZI	0x00000100
533 #define UCC_SLOW_GUMR_L_TENC_NRZ	0x00000000
534 #define UCC_SLOW_GUMR_L_DIAG_MASK	0x000000c0
535 #define UCC_SLOW_GUMR_L_DIAG_LE	        0x000000c0
536 #define UCC_SLOW_GUMR_L_DIAG_ECHO	0x00000080
537 #define UCC_SLOW_GUMR_L_DIAG_LOOP	0x00000040
538 #define UCC_SLOW_GUMR_L_DIAG_NORM	0x00000000
539 #define UCC_SLOW_GUMR_L_ENR		0x00000020
540 #define UCC_SLOW_GUMR_L_ENT		0x00000010
541 #define UCC_SLOW_GUMR_L_MODE_MASK	0x0000000F
542 #define UCC_SLOW_GUMR_L_MODE_BISYNC	0x00000008
543 #define UCC_SLOW_GUMR_L_MODE_AHDLC	0x00000006
544 #define UCC_SLOW_GUMR_L_MODE_UART	0x00000004
545 #define UCC_SLOW_GUMR_L_MODE_QMC	0x00000002
546 
547 /* General UCC FAST Mode Register */
548 #define UCC_FAST_GUMR_TCI	0x20000000
549 #define UCC_FAST_GUMR_TRX	0x10000000
550 #define UCC_FAST_GUMR_TTX	0x08000000
551 #define UCC_FAST_GUMR_CDP	0x04000000
552 #define UCC_FAST_GUMR_CTSP	0x02000000
553 #define UCC_FAST_GUMR_CDS	0x01000000
554 #define UCC_FAST_GUMR_CTSS	0x00800000
555 #define UCC_FAST_GUMR_TXSY	0x00020000
556 #define UCC_FAST_GUMR_RSYN	0x00010000
557 #define UCC_FAST_GUMR_RTSM	0x00002000
558 #define UCC_FAST_GUMR_REVD	0x00000400
559 #define UCC_FAST_GUMR_ENR	0x00000020
560 #define UCC_FAST_GUMR_ENT	0x00000010
561 
562 /* UART Slow UCC Event Register (UCCE) */
563 #define UCC_UART_UCCE_AB	0x0200
564 #define UCC_UART_UCCE_IDLE	0x0100
565 #define UCC_UART_UCCE_GRA	0x0080
566 #define UCC_UART_UCCE_BRKE	0x0040
567 #define UCC_UART_UCCE_BRKS	0x0020
568 #define UCC_UART_UCCE_CCR	0x0008
569 #define UCC_UART_UCCE_BSY	0x0004
570 #define UCC_UART_UCCE_TX	0x0002
571 #define UCC_UART_UCCE_RX	0x0001
572 
573 /* HDLC Slow UCC Event Register (UCCE) */
574 #define UCC_HDLC_UCCE_GLR	0x1000
575 #define UCC_HDLC_UCCE_GLT	0x0800
576 #define UCC_HDLC_UCCE_IDLE	0x0100
577 #define UCC_HDLC_UCCE_BRKE	0x0040
578 #define UCC_HDLC_UCCE_BRKS	0x0020
579 #define UCC_HDLC_UCCE_TXE	0x0010
580 #define UCC_HDLC_UCCE_RXF	0x0008
581 #define UCC_HDLC_UCCE_BSY	0x0004
582 #define UCC_HDLC_UCCE_TXB	0x0002
583 #define UCC_HDLC_UCCE_RXB	0x0001
584 
585 /* BISYNC Slow UCC Event Register (UCCE) */
586 #define UCC_BISYNC_UCCE_GRA	0x0080
587 #define UCC_BISYNC_UCCE_TXE	0x0010
588 #define UCC_BISYNC_UCCE_RCH	0x0008
589 #define UCC_BISYNC_UCCE_BSY	0x0004
590 #define UCC_BISYNC_UCCE_TXB	0x0002
591 #define UCC_BISYNC_UCCE_RXB	0x0001
592 
593 /* Gigabit Ethernet Fast UCC Event Register (UCCE) */
594 #define UCC_GETH_UCCE_MPD       0x80000000
595 #define UCC_GETH_UCCE_SCAR      0x40000000
596 #define UCC_GETH_UCCE_GRA       0x20000000
597 #define UCC_GETH_UCCE_CBPR      0x10000000
598 #define UCC_GETH_UCCE_BSY       0x08000000
599 #define UCC_GETH_UCCE_RXC       0x04000000
600 #define UCC_GETH_UCCE_TXC       0x02000000
601 #define UCC_GETH_UCCE_TXE       0x01000000
602 #define UCC_GETH_UCCE_TXB7      0x00800000
603 #define UCC_GETH_UCCE_TXB6      0x00400000
604 #define UCC_GETH_UCCE_TXB5      0x00200000
605 #define UCC_GETH_UCCE_TXB4      0x00100000
606 #define UCC_GETH_UCCE_TXB3      0x00080000
607 #define UCC_GETH_UCCE_TXB2      0x00040000
608 #define UCC_GETH_UCCE_TXB1      0x00020000
609 #define UCC_GETH_UCCE_TXB0      0x00010000
610 #define UCC_GETH_UCCE_RXB7      0x00008000
611 #define UCC_GETH_UCCE_RXB6      0x00004000
612 #define UCC_GETH_UCCE_RXB5      0x00002000
613 #define UCC_GETH_UCCE_RXB4      0x00001000
614 #define UCC_GETH_UCCE_RXB3      0x00000800
615 #define UCC_GETH_UCCE_RXB2      0x00000400
616 #define UCC_GETH_UCCE_RXB1      0x00000200
617 #define UCC_GETH_UCCE_RXB0      0x00000100
618 #define UCC_GETH_UCCE_RXF7      0x00000080
619 #define UCC_GETH_UCCE_RXF6      0x00000040
620 #define UCC_GETH_UCCE_RXF5      0x00000020
621 #define UCC_GETH_UCCE_RXF4      0x00000010
622 #define UCC_GETH_UCCE_RXF3      0x00000008
623 #define UCC_GETH_UCCE_RXF2      0x00000004
624 #define UCC_GETH_UCCE_RXF1      0x00000002
625 #define UCC_GETH_UCCE_RXF0      0x00000001
626 
627 /* UCC Protocol Specific Mode Register (UPSMR), when used for UART */
628 #define UCC_UART_UPSMR_FLC		0x8000
629 #define UCC_UART_UPSMR_SL		0x4000
630 #define UCC_UART_UPSMR_CL_MASK		0x3000
631 #define UCC_UART_UPSMR_CL_8		0x3000
632 #define UCC_UART_UPSMR_CL_7		0x2000
633 #define UCC_UART_UPSMR_CL_6		0x1000
634 #define UCC_UART_UPSMR_CL_5		0x0000
635 #define UCC_UART_UPSMR_UM_MASK		0x0c00
636 #define UCC_UART_UPSMR_UM_NORMAL	0x0000
637 #define UCC_UART_UPSMR_UM_MAN_MULTI	0x0400
638 #define UCC_UART_UPSMR_UM_AUTO_MULTI	0x0c00
639 #define UCC_UART_UPSMR_FRZ		0x0200
640 #define UCC_UART_UPSMR_RZS		0x0100
641 #define UCC_UART_UPSMR_SYN		0x0080
642 #define UCC_UART_UPSMR_DRT		0x0040
643 #define UCC_UART_UPSMR_PEN		0x0010
644 #define UCC_UART_UPSMR_RPM_MASK		0x000c
645 #define UCC_UART_UPSMR_RPM_ODD		0x0000
646 #define UCC_UART_UPSMR_RPM_LOW		0x0004
647 #define UCC_UART_UPSMR_RPM_EVEN		0x0008
648 #define UCC_UART_UPSMR_RPM_HIGH		0x000C
649 #define UCC_UART_UPSMR_TPM_MASK		0x0003
650 #define UCC_UART_UPSMR_TPM_ODD		0x0000
651 #define UCC_UART_UPSMR_TPM_LOW		0x0001
652 #define UCC_UART_UPSMR_TPM_EVEN		0x0002
653 #define UCC_UART_UPSMR_TPM_HIGH		0x0003
654 
655 /* UCC Protocol Specific Mode Register (UPSMR), when used for Ethernet */
656 #define UCC_GETH_UPSMR_FTFE     0x80000000
657 #define UCC_GETH_UPSMR_PTPE     0x40000000
658 #define UCC_GETH_UPSMR_ECM      0x04000000
659 #define UCC_GETH_UPSMR_HSE      0x02000000
660 #define UCC_GETH_UPSMR_PRO      0x00400000
661 #define UCC_GETH_UPSMR_CAP      0x00200000
662 #define UCC_GETH_UPSMR_RSH      0x00100000
663 #define UCC_GETH_UPSMR_RPM      0x00080000
664 #define UCC_GETH_UPSMR_R10M     0x00040000
665 #define UCC_GETH_UPSMR_RLPB     0x00020000
666 #define UCC_GETH_UPSMR_TBIM     0x00010000
667 #define UCC_GETH_UPSMR_RES1     0x00002000
668 #define UCC_GETH_UPSMR_RMM      0x00001000
669 #define UCC_GETH_UPSMR_CAM      0x00000400
670 #define UCC_GETH_UPSMR_BRO      0x00000200
671 
672 /* UCC Transmit On Demand Register (UTODR) */
673 #define UCC_SLOW_TOD	0x8000
674 #define UCC_FAST_TOD	0x8000
675 
676 /* UCC Bus Mode Register masks */
677 /* Not to be confused with the Bundle Mode Register */
678 #define UCC_BMR_GBL		0x20
679 #define UCC_BMR_BO_BE		0x10
680 #define UCC_BMR_CETM		0x04
681 #define UCC_BMR_DTB		0x02
682 #define UCC_BMR_BDB		0x01
683 
684 /* Function code masks */
685 #define FC_GBL				0x20
686 #define FC_DTB_LCL			0x02
687 #define UCC_FAST_FUNCTION_CODE_GBL	0x20
688 #define UCC_FAST_FUNCTION_CODE_DTB_LCL	0x02
689 #define UCC_FAST_FUNCTION_CODE_BDB_LCL	0x01
690 
691 #endif /* __KERNEL__ */
692 #endif /* _ASM_POWERPC_QE_H */
693