1/*
2 * Copyright (C) 2006 Freescale Semiconductor, Inc. All rights reserved.
3 *
4 * Authors: 	Shlomi Gridish <gridish@freescale.com>
5 * 		Li Yang <leoli@freescale.com>
6 *
7 * Description:
8 * QE UCC Fast API Set - UCC Fast specific routines implementations.
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#include <linux/kernel.h>
16#include <linux/errno.h>
17#include <linux/slab.h>
18#include <linux/stddef.h>
19#include <linux/interrupt.h>
20#include <linux/err.h>
21#include <linux/export.h>
22
23#include <asm/io.h>
24#include <asm/immap_qe.h>
25#include <asm/qe.h>
26
27#include <asm/ucc.h>
28#include <asm/ucc_fast.h>
29
30void ucc_fast_dump_regs(struct ucc_fast_private * uccf)
31{
32	printk(KERN_INFO "UCC%u Fast registers:\n", uccf->uf_info->ucc_num);
33	printk(KERN_INFO "Base address: 0x%p\n", uccf->uf_regs);
34
35	printk(KERN_INFO "gumr  : addr=0x%p, val=0x%08x\n",
36		  &uccf->uf_regs->gumr, in_be32(&uccf->uf_regs->gumr));
37	printk(KERN_INFO "upsmr : addr=0x%p, val=0x%08x\n",
38		  &uccf->uf_regs->upsmr, in_be32(&uccf->uf_regs->upsmr));
39	printk(KERN_INFO "utodr : addr=0x%p, val=0x%04x\n",
40		  &uccf->uf_regs->utodr, in_be16(&uccf->uf_regs->utodr));
41	printk(KERN_INFO "udsr  : addr=0x%p, val=0x%04x\n",
42		  &uccf->uf_regs->udsr, in_be16(&uccf->uf_regs->udsr));
43	printk(KERN_INFO "ucce  : addr=0x%p, val=0x%08x\n",
44		  &uccf->uf_regs->ucce, in_be32(&uccf->uf_regs->ucce));
45	printk(KERN_INFO "uccm  : addr=0x%p, val=0x%08x\n",
46		  &uccf->uf_regs->uccm, in_be32(&uccf->uf_regs->uccm));
47	printk(KERN_INFO "uccs  : addr=0x%p, val=0x%02x\n",
48		  &uccf->uf_regs->uccs, in_8(&uccf->uf_regs->uccs));
49	printk(KERN_INFO "urfb  : addr=0x%p, val=0x%08x\n",
50		  &uccf->uf_regs->urfb, in_be32(&uccf->uf_regs->urfb));
51	printk(KERN_INFO "urfs  : addr=0x%p, val=0x%04x\n",
52		  &uccf->uf_regs->urfs, in_be16(&uccf->uf_regs->urfs));
53	printk(KERN_INFO "urfet : addr=0x%p, val=0x%04x\n",
54		  &uccf->uf_regs->urfet, in_be16(&uccf->uf_regs->urfet));
55	printk(KERN_INFO "urfset: addr=0x%p, val=0x%04x\n",
56		  &uccf->uf_regs->urfset, in_be16(&uccf->uf_regs->urfset));
57	printk(KERN_INFO "utfb  : addr=0x%p, val=0x%08x\n",
58		  &uccf->uf_regs->utfb, in_be32(&uccf->uf_regs->utfb));
59	printk(KERN_INFO "utfs  : addr=0x%p, val=0x%04x\n",
60		  &uccf->uf_regs->utfs, in_be16(&uccf->uf_regs->utfs));
61	printk(KERN_INFO "utfet : addr=0x%p, val=0x%04x\n",
62		  &uccf->uf_regs->utfet, in_be16(&uccf->uf_regs->utfet));
63	printk(KERN_INFO "utftt : addr=0x%p, val=0x%04x\n",
64		  &uccf->uf_regs->utftt, in_be16(&uccf->uf_regs->utftt));
65	printk(KERN_INFO "utpt  : addr=0x%p, val=0x%04x\n",
66		  &uccf->uf_regs->utpt, in_be16(&uccf->uf_regs->utpt));
67	printk(KERN_INFO "urtry : addr=0x%p, val=0x%08x\n",
68		  &uccf->uf_regs->urtry, in_be32(&uccf->uf_regs->urtry));
69	printk(KERN_INFO "guemr : addr=0x%p, val=0x%02x\n",
70		  &uccf->uf_regs->guemr, in_8(&uccf->uf_regs->guemr));
71}
72EXPORT_SYMBOL(ucc_fast_dump_regs);
73
74u32 ucc_fast_get_qe_cr_subblock(int uccf_num)
75{
76	switch (uccf_num) {
77	case 0: return QE_CR_SUBBLOCK_UCCFAST1;
78	case 1: return QE_CR_SUBBLOCK_UCCFAST2;
79	case 2: return QE_CR_SUBBLOCK_UCCFAST3;
80	case 3: return QE_CR_SUBBLOCK_UCCFAST4;
81	case 4: return QE_CR_SUBBLOCK_UCCFAST5;
82	case 5: return QE_CR_SUBBLOCK_UCCFAST6;
83	case 6: return QE_CR_SUBBLOCK_UCCFAST7;
84	case 7: return QE_CR_SUBBLOCK_UCCFAST8;
85	default: return QE_CR_SUBBLOCK_INVALID;
86	}
87}
88EXPORT_SYMBOL(ucc_fast_get_qe_cr_subblock);
89
90void ucc_fast_transmit_on_demand(struct ucc_fast_private * uccf)
91{
92	out_be16(&uccf->uf_regs->utodr, UCC_FAST_TOD);
93}
94EXPORT_SYMBOL(ucc_fast_transmit_on_demand);
95
96void ucc_fast_enable(struct ucc_fast_private * uccf, enum comm_dir mode)
97{
98	struct ucc_fast __iomem *uf_regs;
99	u32 gumr;
100
101	uf_regs = uccf->uf_regs;
102
103	/* Enable reception and/or transmission on this UCC. */
104	gumr = in_be32(&uf_regs->gumr);
105	if (mode & COMM_DIR_TX) {
106		gumr |= UCC_FAST_GUMR_ENT;
107		uccf->enabled_tx = 1;
108	}
109	if (mode & COMM_DIR_RX) {
110		gumr |= UCC_FAST_GUMR_ENR;
111		uccf->enabled_rx = 1;
112	}
113	out_be32(&uf_regs->gumr, gumr);
114}
115EXPORT_SYMBOL(ucc_fast_enable);
116
117void ucc_fast_disable(struct ucc_fast_private * uccf, enum comm_dir mode)
118{
119	struct ucc_fast __iomem *uf_regs;
120	u32 gumr;
121
122	uf_regs = uccf->uf_regs;
123
124	/* Disable reception and/or transmission on this UCC. */
125	gumr = in_be32(&uf_regs->gumr);
126	if (mode & COMM_DIR_TX) {
127		gumr &= ~UCC_FAST_GUMR_ENT;
128		uccf->enabled_tx = 0;
129	}
130	if (mode & COMM_DIR_RX) {
131		gumr &= ~UCC_FAST_GUMR_ENR;
132		uccf->enabled_rx = 0;
133	}
134	out_be32(&uf_regs->gumr, gumr);
135}
136EXPORT_SYMBOL(ucc_fast_disable);
137
138int ucc_fast_init(struct ucc_fast_info * uf_info, struct ucc_fast_private ** uccf_ret)
139{
140	struct ucc_fast_private *uccf;
141	struct ucc_fast __iomem *uf_regs;
142	u32 gumr;
143	int ret;
144
145	if (!uf_info)
146		return -EINVAL;
147
148	/* check if the UCC port number is in range. */
149	if ((uf_info->ucc_num < 0) || (uf_info->ucc_num > UCC_MAX_NUM - 1)) {
150		printk(KERN_ERR "%s: illegal UCC number\n", __func__);
151		return -EINVAL;
152	}
153
154	/* Check that 'max_rx_buf_length' is properly aligned (4). */
155	if (uf_info->max_rx_buf_length & (UCC_FAST_MRBLR_ALIGNMENT - 1)) {
156		printk(KERN_ERR "%s: max_rx_buf_length not aligned\n",
157			__func__);
158		return -EINVAL;
159	}
160
161	/* Validate Virtual Fifo register values */
162	if (uf_info->urfs < UCC_FAST_URFS_MIN_VAL) {
163		printk(KERN_ERR "%s: urfs is too small\n", __func__);
164		return -EINVAL;
165	}
166
167	if (uf_info->urfs & (UCC_FAST_VIRT_FIFO_REGS_ALIGNMENT - 1)) {
168		printk(KERN_ERR "%s: urfs is not aligned\n", __func__);
169		return -EINVAL;
170	}
171
172	if (uf_info->urfet & (UCC_FAST_VIRT_FIFO_REGS_ALIGNMENT - 1)) {
173		printk(KERN_ERR "%s: urfet is not aligned.\n", __func__);
174		return -EINVAL;
175	}
176
177	if (uf_info->urfset & (UCC_FAST_VIRT_FIFO_REGS_ALIGNMENT - 1)) {
178		printk(KERN_ERR "%s: urfset is not aligned\n", __func__);
179		return -EINVAL;
180	}
181
182	if (uf_info->utfs & (UCC_FAST_VIRT_FIFO_REGS_ALIGNMENT - 1)) {
183		printk(KERN_ERR "%s: utfs is not aligned\n", __func__);
184		return -EINVAL;
185	}
186
187	if (uf_info->utfet & (UCC_FAST_VIRT_FIFO_REGS_ALIGNMENT - 1)) {
188		printk(KERN_ERR "%s: utfet is not aligned\n", __func__);
189		return -EINVAL;
190	}
191
192	if (uf_info->utftt & (UCC_FAST_VIRT_FIFO_REGS_ALIGNMENT - 1)) {
193		printk(KERN_ERR "%s: utftt is not aligned\n", __func__);
194		return -EINVAL;
195	}
196
197	uccf = kzalloc(sizeof(struct ucc_fast_private), GFP_KERNEL);
198	if (!uccf) {
199		printk(KERN_ERR "%s: Cannot allocate private data\n",
200			__func__);
201		return -ENOMEM;
202	}
203
204	/* Fill fast UCC structure */
205	uccf->uf_info = uf_info;
206	/* Set the PHY base address */
207	uccf->uf_regs = ioremap(uf_info->regs, sizeof(struct ucc_fast));
208	if (uccf->uf_regs == NULL) {
209		printk(KERN_ERR "%s: Cannot map UCC registers\n", __func__);
210		kfree(uccf);
211		return -ENOMEM;
212	}
213
214	uccf->enabled_tx = 0;
215	uccf->enabled_rx = 0;
216	uccf->stopped_tx = 0;
217	uccf->stopped_rx = 0;
218	uf_regs = uccf->uf_regs;
219	uccf->p_ucce = &uf_regs->ucce;
220	uccf->p_uccm = &uf_regs->uccm;
221#ifdef CONFIG_UGETH_TX_ON_DEMAND
222	uccf->p_utodr = &uf_regs->utodr;
223#endif
224#ifdef STATISTICS
225	uccf->tx_frames = 0;
226	uccf->rx_frames = 0;
227	uccf->rx_discarded = 0;
228#endif				/* STATISTICS */
229
230	/* Set UCC to fast type */
231	ret = ucc_set_type(uf_info->ucc_num, UCC_SPEED_TYPE_FAST);
232	if (ret) {
233		printk(KERN_ERR "%s: cannot set UCC type\n", __func__);
234		ucc_fast_free(uccf);
235		return ret;
236	}
237
238	uccf->mrblr = uf_info->max_rx_buf_length;
239
240	/* Set GUMR */
241	/* For more details see the hardware spec. */
242	gumr = uf_info->ttx_trx;
243	if (uf_info->tci)
244		gumr |= UCC_FAST_GUMR_TCI;
245	if (uf_info->cdp)
246		gumr |= UCC_FAST_GUMR_CDP;
247	if (uf_info->ctsp)
248		gumr |= UCC_FAST_GUMR_CTSP;
249	if (uf_info->cds)
250		gumr |= UCC_FAST_GUMR_CDS;
251	if (uf_info->ctss)
252		gumr |= UCC_FAST_GUMR_CTSS;
253	if (uf_info->txsy)
254		gumr |= UCC_FAST_GUMR_TXSY;
255	if (uf_info->rsyn)
256		gumr |= UCC_FAST_GUMR_RSYN;
257	gumr |= uf_info->synl;
258	if (uf_info->rtsm)
259		gumr |= UCC_FAST_GUMR_RTSM;
260	gumr |= uf_info->renc;
261	if (uf_info->revd)
262		gumr |= UCC_FAST_GUMR_REVD;
263	gumr |= uf_info->tenc;
264	gumr |= uf_info->tcrc;
265	gumr |= uf_info->mode;
266	out_be32(&uf_regs->gumr, gumr);
267
268	/* Allocate memory for Tx Virtual Fifo */
269	uccf->ucc_fast_tx_virtual_fifo_base_offset =
270	    qe_muram_alloc(uf_info->utfs, UCC_FAST_VIRT_FIFO_REGS_ALIGNMENT);
271	if (IS_ERR_VALUE(uccf->ucc_fast_tx_virtual_fifo_base_offset)) {
272		printk(KERN_ERR "%s: cannot allocate MURAM for TX FIFO\n",
273			__func__);
274		uccf->ucc_fast_tx_virtual_fifo_base_offset = 0;
275		ucc_fast_free(uccf);
276		return -ENOMEM;
277	}
278
279	/* Allocate memory for Rx Virtual Fifo */
280	uccf->ucc_fast_rx_virtual_fifo_base_offset =
281		qe_muram_alloc(uf_info->urfs +
282			   UCC_FAST_RECEIVE_VIRTUAL_FIFO_SIZE_FUDGE_FACTOR,
283			   UCC_FAST_VIRT_FIFO_REGS_ALIGNMENT);
284	if (IS_ERR_VALUE(uccf->ucc_fast_rx_virtual_fifo_base_offset)) {
285		printk(KERN_ERR "%s: cannot allocate MURAM for RX FIFO\n",
286			__func__);
287		uccf->ucc_fast_rx_virtual_fifo_base_offset = 0;
288		ucc_fast_free(uccf);
289		return -ENOMEM;
290	}
291
292	/* Set Virtual Fifo registers */
293	out_be16(&uf_regs->urfs, uf_info->urfs);
294	out_be16(&uf_regs->urfet, uf_info->urfet);
295	out_be16(&uf_regs->urfset, uf_info->urfset);
296	out_be16(&uf_regs->utfs, uf_info->utfs);
297	out_be16(&uf_regs->utfet, uf_info->utfet);
298	out_be16(&uf_regs->utftt, uf_info->utftt);
299	/* utfb, urfb are offsets from MURAM base */
300	out_be32(&uf_regs->utfb, uccf->ucc_fast_tx_virtual_fifo_base_offset);
301	out_be32(&uf_regs->urfb, uccf->ucc_fast_rx_virtual_fifo_base_offset);
302
303	/* Mux clocking */
304	/* Grant Support */
305	ucc_set_qe_mux_grant(uf_info->ucc_num, uf_info->grant_support);
306	/* Breakpoint Support */
307	ucc_set_qe_mux_bkpt(uf_info->ucc_num, uf_info->brkpt_support);
308	/* Set Tsa or NMSI mode. */
309	ucc_set_qe_mux_tsa(uf_info->ucc_num, uf_info->tsa);
310	/* If NMSI (not Tsa), set Tx and Rx clock. */
311	if (!uf_info->tsa) {
312		/* Rx clock routing */
313		if ((uf_info->rx_clock != QE_CLK_NONE) &&
314		    ucc_set_qe_mux_rxtx(uf_info->ucc_num, uf_info->rx_clock,
315					COMM_DIR_RX)) {
316			printk(KERN_ERR "%s: illegal value for RX clock\n",
317			       __func__);
318			ucc_fast_free(uccf);
319			return -EINVAL;
320		}
321		/* Tx clock routing */
322		if ((uf_info->tx_clock != QE_CLK_NONE) &&
323		    ucc_set_qe_mux_rxtx(uf_info->ucc_num, uf_info->tx_clock,
324					COMM_DIR_TX)) {
325			printk(KERN_ERR "%s: illegal value for TX clock\n",
326			       __func__);
327			ucc_fast_free(uccf);
328			return -EINVAL;
329		}
330	}
331
332	/* Set interrupt mask register at UCC level. */
333	out_be32(&uf_regs->uccm, uf_info->uccm_mask);
334
335	/* First, clear anything pending at UCC level,
336	 * otherwise, old garbage may come through
337	 * as soon as the dam is opened. */
338
339	/* Writing '1' clears */
340	out_be32(&uf_regs->ucce, 0xffffffff);
341
342	*uccf_ret = uccf;
343	return 0;
344}
345EXPORT_SYMBOL(ucc_fast_init);
346
347void ucc_fast_free(struct ucc_fast_private * uccf)
348{
349	if (!uccf)
350		return;
351
352	if (uccf->ucc_fast_tx_virtual_fifo_base_offset)
353		qe_muram_free(uccf->ucc_fast_tx_virtual_fifo_base_offset);
354
355	if (uccf->ucc_fast_rx_virtual_fifo_base_offset)
356		qe_muram_free(uccf->ucc_fast_rx_virtual_fifo_base_offset);
357
358	if (uccf->uf_regs)
359		iounmap(uccf->uf_regs);
360
361	kfree(uccf);
362}
363EXPORT_SYMBOL(ucc_fast_free);
364