2 * Copyright (c) 2006 Sam Leffler, Errno Consulting
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer,
10 * without modification.
11 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
12 * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
13 * redistribution must be conditioned upon including a substantially
14 * similar Disclaimer requirement for further binary redistribution.
17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
20 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
21 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
22 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
27 * THE POSSIBILITY OF SUCH DAMAGES.
31 * Copyright (c) 2001-2005, Intel Corporation.
32 * All rights reserved.
34 * Redistribution and use in source and binary forms, with or without
35 * modification, are permitted provided that the following conditions
37 * 1. Redistributions of source code must retain the above copyright
38 * notice, this list of conditions and the following disclaimer.
39 * 2. Redistributions in binary form must reproduce the above copyright
40 * notice, this list of conditions and the following disclaimer in the
41 * documentation and/or other materials provided with the distribution.
42 * 3. Neither the name of the Intel Corporation nor the names of its contributors
43 * may be used to endorse or promote products derived from this software
44 * without specific prior written permission.
47 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
48 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
49 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
50 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
51 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
52 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
53 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
54 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
55 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
56 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59 #include <sys/cdefs.h>
60 __FBSDID("$FreeBSD$");
63 * Intel XScale Queue Manager support.
65 * Each IXP4XXX device has a hardware block that implements a priority
66 * queue manager that is shared between the XScale cpu and the backend
67 * devices (such as the NPE). Queues are accessed by reading/writing
68 * special memory locations. The queue contents are mapped into a shared
69 * SRAM region with entries managed in a circular buffer. The XScale
70 * processor can receive interrupts based on queue contents (a condition
71 * code determines when interrupts should be delivered).
73 * The code here basically replaces the qmgr class in the Intel Access
76 #include <sys/param.h>
77 #include <sys/systm.h>
78 #include <sys/kernel.h>
79 #include <sys/module.h>
82 #include <sys/resource.h>
84 #include <sys/sysctl.h>
86 #include <machine/bus.h>
87 #include <machine/cpu.h>
88 #include <machine/cpufunc.h>
89 #include <machine/resource.h>
90 #include <machine/intr.h>
91 #include <arm/xscale/ixp425/ixp425reg.h>
92 #include <arm/xscale/ixp425/ixp425var.h>
94 #include <arm/xscale/ixp425/ixp425_qmgr.h>
97 * State per AQM hw queue.
98 * This structure holds q configuration and dispatch state.
101 int qSizeInWords; /* queue size in words */
103 uint32_t qOflowStatBitMask; /* overflow status mask */
104 int qWriteCount; /* queue write count */
106 bus_size_t qAccRegAddr; /* access register */
107 bus_size_t qUOStatRegAddr; /* status register */
108 bus_size_t qConfigRegAddr; /* config register */
109 int qSizeInEntries; /* queue size in entries */
111 uint32_t qUflowStatBitMask; /* underflow status mask */
112 int qReadCount; /* queue read count */
115 uint32_t qStatRegAddr;
116 uint32_t qStatBitsOffset;
117 uint32_t qStat0BitMask;
118 uint32_t qStat1BitMask;
120 uint32_t intRegCheckMask; /* interrupt reg check mask */
121 void (*cb)(int, void *); /* callback function */
122 void *cbarg; /* callback argument */
123 int priority; /* dispatch priority */
125 /* NB: needed only for A0 parts */
126 u_int statusWordOffset; /* status word offset */
127 uint32_t statusMask; /* status mask */
128 uint32_t statusCheckValue; /* status check value */
132 struct ixpqmgr_softc {
134 bus_space_tag_t sc_iot;
135 bus_space_handle_t sc_ioh;
137 struct resource *sc_irq1; /* IRQ resource */
138 void *sc_ih1; /* interrupt handler */
139 int sc_rid1; /* resource id for irq */
141 struct resource *sc_irq2;
145 struct qmgrInfo qinfo[IX_QMGR_MAX_NUM_QUEUES];
147 * This array contains a list of queue identifiers ordered by
148 * priority. The table is split logically between queue
149 * identifiers 0-31 and 32-63. To optimize lookups bit masks
150 * are kept for the first-32 and last-32 q's. When the
151 * table needs to be rebuilt mark rebuildTable and it'll
152 * happen after the next interrupt.
154 int priorityTable[IX_QMGR_MAX_NUM_QUEUES];
155 uint32_t lowPriorityTableFirstHalfMask;
156 uint32_t uppPriorityTableFirstHalfMask;
157 int rebuildTable; /* rebuild priorityTable */
159 uint32_t aqmFreeSramAddress; /* SRAM free space */
162 static int qmgr_debug = 0;
163 SYSCTL_INT(_debug, OID_AUTO, qmgr, CTLFLAG_RW, &qmgr_debug,
164 0, "IXP4XX Q-Manager debug msgs");
165 TUNABLE_INT("debug.qmgr", &qmgr_debug);
166 #define DPRINTF(dev, fmt, ...) do { \
167 if (qmgr_debug) printf(fmt, __VA_ARGS__); \
169 #define DPRINTFn(n, dev, fmt, ...) do { \
170 if (qmgr_debug >= n) printf(fmt, __VA_ARGS__); \
173 static struct ixpqmgr_softc *ixpqmgr_sc = NULL;
175 static void ixpqmgr_rebuild(struct ixpqmgr_softc *);
176 static void ixpqmgr_intr(void *);
178 static void aqm_int_enable(struct ixpqmgr_softc *sc, int qId);
179 static void aqm_int_disable(struct ixpqmgr_softc *sc, int qId);
180 static void aqm_qcfg(struct ixpqmgr_softc *sc, int qId, u_int ne, u_int nf);
181 static void aqm_srcsel_write(struct ixpqmgr_softc *sc, int qId, int sourceId);
182 static void aqm_reset(struct ixpqmgr_softc *sc);
185 dummyCallback(int qId, void *arg)
191 aqm_reg_read(struct ixpqmgr_softc *sc, bus_size_t off)
193 DPRINTFn(9, sc->sc_dev, "%s(0x%x)\n", __func__, (int)off);
194 return bus_space_read_4(sc->sc_iot, sc->sc_ioh, off);
198 aqm_reg_write(struct ixpqmgr_softc *sc, bus_size_t off, uint32_t val)
200 DPRINTFn(9, sc->sc_dev, "%s(0x%x, 0x%x)\n", __func__, (int)off, val);
201 bus_space_write_4(sc->sc_iot, sc->sc_ioh, off, val);
205 ixpqmgr_probe(device_t dev)
207 device_set_desc(dev, "IXP4XX Q-Manager");
212 ixpqmgr_attach(device_t dev)
214 struct ixpqmgr_softc *sc = device_get_softc(dev);
215 struct ixp425_softc *sa = device_get_softc(device_get_parent(dev));
221 sc->sc_iot = sa->sc_iot;
222 if (bus_space_map(sc->sc_iot, IXP425_QMGR_HWBASE, IXP425_QMGR_SIZE,
224 panic("%s: Cannot map registers", device_get_name(dev));
226 /* NB: we only use the lower 32 q's */
228 /* Set up QMGR interrupts */
230 sc->sc_irq1 = bus_alloc_resource(dev, SYS_RES_IRQ, &sc->sc_rid1,
231 IXP425_INT_QUE1_32, IXP425_INT_QUE1_32, 1, RF_ACTIVE);
233 sc->sc_irq2 = bus_alloc_resource(dev, SYS_RES_IRQ, &sc->sc_rid2,
234 IXP425_INT_QUE33_64, IXP425_INT_QUE33_64, 1, RF_ACTIVE);
236 if (sc->sc_irq1 == NULL || sc->sc_irq2 == NULL)
237 panic("Unable to allocate the qmgr irqs.\n");
239 err = bus_setup_intr(dev, sc->sc_irq1, INTR_TYPE_NET | INTR_MPSAFE,
240 NULL, ixpqmgr_intr, NULL, &sc->sc_ih1);
242 device_printf(dev, "failed to set up qmgr irq=%d\n",
246 err = bus_setup_intr(dev, sc->sc_irq2, INTR_TYPE_NET | INTR_MPSAFE,
247 NULL, ixpqmgr_intr, NULL, &sc->sc_ih2);
249 device_printf(dev, "failed to set up qmgr irq=%d\n",
250 IXP425_INT_QUE33_64);
254 /* NB: softc is pre-zero'd */
255 for (i = 0; i < IX_QMGR_MAX_NUM_QUEUES; i++) {
256 struct qmgrInfo *qi = &sc->qinfo[i];
258 qi->cb = dummyCallback;
259 qi->priority = IX_QMGR_Q_PRIORITY_0; /* default priority */
261 * There are two interrupt registers, 32 bits each. One
262 * for the lower queues(0-31) and one for the upper
263 * queues(32-63). Therefore need to mod by 32 i.e the
264 * min upper queue identifier.
266 qi->intRegCheckMask = (1<<(i%(IX_QMGR_MIN_QUEUPP_QID)));
269 * Register addresses and bit masks are calculated and
270 * stored here to optimize QRead, QWrite and QStatusGet
274 /* AQM Queue access reg addresses, per queue */
275 qi->qAccRegAddr = IX_QMGR_Q_ACCESS_ADDR_GET(i);
276 qi->qAccRegAddr = IX_QMGR_Q_ACCESS_ADDR_GET(i);
277 qi->qConfigRegAddr = IX_QMGR_Q_CONFIG_ADDR_GET(i);
279 /* AQM Queue lower-group (0-31), only */
280 if (i < IX_QMGR_MIN_QUEUPP_QID) {
281 /* AQM Q underflow/overflow status reg address, per queue */
282 qi->qUOStatRegAddr = IX_QMGR_QUEUOSTAT0_OFFSET +
283 ((i / IX_QMGR_QUEUOSTAT_NUM_QUE_PER_WORD) *
286 /* AQM Q underflow status bit masks for status reg per queue */
287 qi->qUflowStatBitMask =
288 (IX_QMGR_UNDERFLOW_BIT_OFFSET + 1) <<
289 ((i & (IX_QMGR_QUEUOSTAT_NUM_QUE_PER_WORD - 1)) *
290 (32 / IX_QMGR_QUEUOSTAT_NUM_QUE_PER_WORD));
292 /* AQM Q overflow status bit masks for status reg, per queue */
293 qi->qOflowStatBitMask =
294 (IX_QMGR_OVERFLOW_BIT_OFFSET + 1) <<
295 ((i & (IX_QMGR_QUEUOSTAT_NUM_QUE_PER_WORD - 1)) *
296 (32 / IX_QMGR_QUEUOSTAT_NUM_QUE_PER_WORD));
298 /* AQM Q lower-group (0-31) status reg addresses, per queue */
299 qi->qStatRegAddr = IX_QMGR_QUELOWSTAT0_OFFSET +
300 ((i / IX_QMGR_QUELOWSTAT_NUM_QUE_PER_WORD) *
303 /* AQM Q lower-group (0-31) status register bit offset */
304 qi->qStatBitsOffset =
305 (i & (IX_QMGR_QUELOWSTAT_NUM_QUE_PER_WORD - 1)) *
306 (32 / IX_QMGR_QUELOWSTAT_NUM_QUE_PER_WORD);
307 } else { /* AQM Q upper-group (32-63), only */
308 qi->qUOStatRegAddr = 0; /* XXX */
310 /* AQM Q upper-group (32-63) Nearly Empty status reg bitmasks */
311 qi->qStat0BitMask = (1 << (i - IX_QMGR_MIN_QUEUPP_QID));
313 /* AQM Q upper-group (32-63) Full status register bitmasks */
314 qi->qStat1BitMask = (1 << (i - IX_QMGR_MIN_QUEUPP_QID));
318 sc->aqmFreeSramAddress = 0x100; /* Q buffer space starts at 0x2100 */
320 ixpqmgr_rebuild(sc); /* build initial priority table */
321 aqm_reset(sc); /* reset h/w */
326 ixpqmgr_detach(device_t dev)
328 struct ixpqmgr_softc *sc = device_get_softc(dev);
330 aqm_reset(sc); /* disable interrupts */
331 bus_teardown_intr(dev, sc->sc_irq1, sc->sc_ih1);
332 bus_teardown_intr(dev, sc->sc_irq2, sc->sc_ih2);
333 bus_release_resource(dev, SYS_RES_IRQ, sc->sc_rid1, sc->sc_irq1);
334 bus_release_resource(dev, SYS_RES_IRQ, sc->sc_rid2, sc->sc_irq2);
335 bus_space_unmap(sc->sc_iot, sc->sc_ioh, IXP425_QMGR_SIZE);
340 ixpqmgr_qconfig(int qId, int qEntries, int ne, int nf, int srcSel,
341 qconfig_hand_t *cb, void *cbarg)
343 struct ixpqmgr_softc *sc = ixpqmgr_sc;
344 struct qmgrInfo *qi = &sc->qinfo[qId];
346 DPRINTF(sc->sc_dev, "%s(%u, %u, %u, %u, %u, %p, %p)\n",
347 __func__, qId, qEntries, ne, nf, srcSel, cb, cbarg);
349 /* NB: entry size is always 1 */
350 qi->qSizeInWords = qEntries;
354 qi->qSizeInEntries = qEntries; /* XXX kept for code clarity */
357 /* Reset to dummy callback */
358 qi->cb = dummyCallback;
365 /* Write the config register; NB must be AFTER qinfo setup */
366 aqm_qcfg(sc, qId, ne, nf);
368 * Account for space just allocated to queue.
370 sc->aqmFreeSramAddress += (qi->qSizeInWords * sizeof(uint32_t));
372 /* Set the interrupt source if this queue is in the range 0-31 */
373 if (qId < IX_QMGR_MIN_QUEUPP_QID)
374 aqm_srcsel_write(sc, qId, srcSel);
376 if (cb != NULL) /* Enable the interrupt */
377 aqm_int_enable(sc, qId);
379 sc->rebuildTable = TRUE;
385 ixpqmgr_qwrite(int qId, uint32_t entry)
387 struct ixpqmgr_softc *sc = ixpqmgr_sc;
388 struct qmgrInfo *qi = &sc->qinfo[qId];
390 DPRINTFn(3, sc->sc_dev, "%s(%u, 0x%x) writeCount %u size %u\n",
391 __func__, qId, entry, qi->qWriteCount, qi->qSizeInEntries);
393 /* write the entry */
394 aqm_reg_write(sc, qi->qAccRegAddr, entry);
396 /* NB: overflow is available for lower queues only */
397 if (qId < IX_QMGR_MIN_QUEUPP_QID) {
398 int qSize = qi->qSizeInEntries;
400 * Increment the current number of entries in the queue
401 * and check for overflow .
403 if (qi->qWriteCount++ == qSize) { /* check for overflow */
404 uint32_t status = aqm_reg_read(sc, qi->qUOStatRegAddr);
408 * Read the status twice because the status may
409 * not be immediately ready after the write operation
411 if ((status & qi->qOflowStatBitMask) ||
412 ((status = aqm_reg_read(sc, qi->qUOStatRegAddr)) & qi->qOflowStatBitMask)) {
414 * The queue is full, clear the overflow status bit if set.
416 aqm_reg_write(sc, qi->qUOStatRegAddr,
417 status & ~qi->qOflowStatBitMask);
418 qi->qWriteCount = qSize;
419 DPRINTFn(5, sc->sc_dev,
420 "%s(%u, 0x%x) Q full, overflow status cleared\n",
421 __func__, qId, entry);
425 * No overflow occured : someone is draining the queue
426 * and the current counter needs to be
427 * updated from the current number of entries in the queue
430 /* calculate number of words in q */
431 qPtrs = aqm_reg_read(sc, qi->qConfigRegAddr);
432 DPRINTFn(2, sc->sc_dev,
433 "%s(%u, 0x%x) Q full, no overflow status, qConfig 0x%x\n",
434 __func__, qId, entry, qPtrs);
435 qPtrs = (qPtrs - (qPtrs >> 7)) & 0x7f;
439 * The queue may be full at the time of the
440 * snapshot. Next access will check
441 * the overflow status again.
443 qi->qWriteCount = qSize;
445 /* convert the number of words to a number of entries */
446 qi->qWriteCount = qPtrs & (qSize - 1);
454 ixpqmgr_qread(int qId, uint32_t *entry)
456 struct ixpqmgr_softc *sc = ixpqmgr_sc;
457 struct qmgrInfo *qi = &sc->qinfo[qId];
458 bus_size_t off = qi->qAccRegAddr;
460 *entry = aqm_reg_read(sc, off);
463 * Reset the current read count : next access to the read function
464 * will force a underflow status check.
468 /* Check if underflow occurred on the read */
469 if (*entry == 0 && qId < IX_QMGR_MIN_QUEUPP_QID) {
470 /* get the queue status */
471 uint32_t status = aqm_reg_read(sc, qi->qUOStatRegAddr);
473 if (status & qi->qUflowStatBitMask) { /* clear underflow status */
474 aqm_reg_write(sc, qi->qUOStatRegAddr,
475 status &~ qi->qUflowStatBitMask);
483 ixpqmgr_qreadm(int qId, uint32_t n, uint32_t *p)
485 struct ixpqmgr_softc *sc = ixpqmgr_sc;
486 struct qmgrInfo *qi = &sc->qinfo[qId];
488 bus_size_t off = qi->qAccRegAddr;
490 entry = aqm_reg_read(sc, off);
493 /* if we read a NULL entry, stop. We have underflowed */
496 *p++ = entry; /* store */
497 entry = aqm_reg_read(sc, off);
502 * Reset the current read count : next access to the read function
503 * will force a underflow status check.
507 /* Check if underflow occurred on the read */
508 if (entry == 0 && qId < IX_QMGR_MIN_QUEUPP_QID) {
509 /* get the queue status */
510 uint32_t status = aqm_reg_read(sc, qi->qUOStatRegAddr);
512 if (status & qi->qUflowStatBitMask) { /* clear underflow status */
513 aqm_reg_write(sc, qi->qUOStatRegAddr,
514 status &~ qi->qUflowStatBitMask);
522 ixpqmgr_getqstatus(int qId)
524 #define QLOWSTATMASK \
525 ((1 << (32 / IX_QMGR_QUELOWSTAT_NUM_QUE_PER_WORD)) - 1)
526 struct ixpqmgr_softc *sc = ixpqmgr_sc;
527 const struct qmgrInfo *qi = &sc->qinfo[qId];
530 if (qId < IX_QMGR_MIN_QUEUPP_QID) {
531 /* read the status of a queue in the range 0-31 */
532 status = aqm_reg_read(sc, qi->qStatRegAddr);
534 /* mask out the status bits relevant only to this queue */
535 status = (status >> qi->qStatBitsOffset) & QLOWSTATMASK;
536 } else { /* read status of a queue in the range 32-63 */
538 if (aqm_reg_read(sc, IX_QMGR_QUEUPPSTAT0_OFFSET)&qi->qStat0BitMask)
539 status |= IX_QMGR_Q_STATUS_NE_BIT_MASK; /* nearly empty */
540 if (aqm_reg_read(sc, IX_QMGR_QUEUPPSTAT1_OFFSET)&qi->qStat1BitMask)
541 status |= IX_QMGR_Q_STATUS_F_BIT_MASK; /* full */
548 ixpqmgr_getqconfig(int qId)
550 struct ixpqmgr_softc *sc = ixpqmgr_sc;
552 return aqm_reg_read(sc, IX_QMGR_Q_CONFIG_ADDR_GET(qId));
558 struct ixpqmgr_softc *sc = ixpqmgr_sc;
561 /* status registers */
562 printf("0x%04x: %08x %08x %08x %08x\n"
564 , aqm_reg_read(sc, 0x400)
565 , aqm_reg_read(sc, 0x400+4)
566 , aqm_reg_read(sc, 0x400+8)
567 , aqm_reg_read(sc, 0x400+12)
569 printf("0x%04x: %08x %08x %08x %08x\n"
571 , aqm_reg_read(sc, 0x410)
572 , aqm_reg_read(sc, 0x410+4)
573 , aqm_reg_read(sc, 0x410+8)
574 , aqm_reg_read(sc, 0x410+12)
576 printf("0x%04x: %08x %08x %08x %08x\n"
578 , aqm_reg_read(sc, 0x420)
579 , aqm_reg_read(sc, 0x420+4)
580 , aqm_reg_read(sc, 0x420+8)
581 , aqm_reg_read(sc, 0x420+12)
583 printf("0x%04x: %08x %08x %08x %08x\n"
585 , aqm_reg_read(sc, 0x430)
586 , aqm_reg_read(sc, 0x430+4)
587 , aqm_reg_read(sc, 0x430+8)
588 , aqm_reg_read(sc, 0x430+12)
590 /* q configuration registers */
591 for (a = 0x2000; a < 0x20ff; a += 32)
592 printf("0x%04x: %08x %08x %08x %08x %08x %08x %08x %08x\n"
594 , aqm_reg_read(sc, a)
595 , aqm_reg_read(sc, a+4)
596 , aqm_reg_read(sc, a+8)
597 , aqm_reg_read(sc, a+12)
598 , aqm_reg_read(sc, a+16)
599 , aqm_reg_read(sc, a+20)
600 , aqm_reg_read(sc, a+24)
601 , aqm_reg_read(sc, a+28)
604 for (i = 0x100; i < sc->aqmFreeSramAddress; i += 32) {
606 printf("0x%04x: %08x %08x %08x %08x %08x %08x %08x %08x\n"
608 , aqm_reg_read(sc, a)
609 , aqm_reg_read(sc, a+4)
610 , aqm_reg_read(sc, a+8)
611 , aqm_reg_read(sc, a+12)
612 , aqm_reg_read(sc, a+16)
613 , aqm_reg_read(sc, a+20)
614 , aqm_reg_read(sc, a+24)
615 , aqm_reg_read(sc, a+28)
618 for (i = 0; i < 16; i++) {
619 printf("Q[%2d] config 0x%08x status 0x%02x "
620 "Q[%2d] config 0x%08x status 0x%02x\n"
621 , i, ixpqmgr_getqconfig(i), ixpqmgr_getqstatus(i)
622 , i+16, ixpqmgr_getqconfig(i+16), ixpqmgr_getqstatus(i+16)
628 ixpqmgr_notify_enable(int qId, int srcSel)
630 struct ixpqmgr_softc *sc = ixpqmgr_sc;
632 /* Calculate the checkMask and checkValue for this q */
633 aqm_calc_statuscheck(sc, qId, srcSel);
635 /* Set the interrupt source if this queue is in the range 0-31 */
636 if (qId < IX_QMGR_MIN_QUEUPP_QID)
637 aqm_srcsel_write(sc, qId, srcSel);
639 /* Enable the interrupt */
640 aqm_int_enable(sc, qId);
644 ixpqmgr_notify_disable(int qId)
646 struct ixpqmgr_softc *sc = ixpqmgr_sc;
648 aqm_int_disable(sc, qId);
652 * Rebuild the priority table used by the dispatcher.
655 ixpqmgr_rebuild(struct ixpqmgr_softc *sc)
658 int lowQuePriorityTableIndex, uppQuePriorityTableIndex;
661 sc->lowPriorityTableFirstHalfMask = 0;
662 sc->uppPriorityTableFirstHalfMask = 0;
664 lowQuePriorityTableIndex = 0;
665 uppQuePriorityTableIndex = 32;
666 for (pri = 0; pri < IX_QMGR_NUM_PRIORITY_LEVELS; pri++) {
667 /* low priority q's */
668 for (q = 0; q < IX_QMGR_MIN_QUEUPP_QID; q++) {
670 if (qi->priority == pri) {
672 * Build the priority table bitmask which match the
673 * queues of the first half of the priority table.
675 if (lowQuePriorityTableIndex < 16) {
676 sc->lowPriorityTableFirstHalfMask |=
679 sc->priorityTable[lowQuePriorityTableIndex++] = q;
682 /* high priority q's */
683 for (; q < IX_QMGR_MAX_NUM_QUEUES; q++) {
685 if (qi->priority == pri) {
687 * Build the priority table bitmask which match the
688 * queues of the first half of the priority table .
690 if (uppQuePriorityTableIndex < 48) {
691 sc->uppPriorityTableFirstHalfMask |=
694 sc->priorityTable[uppQuePriorityTableIndex++] = q;
698 sc->rebuildTable = FALSE;
702 * Count the number of leading zero bits in a word,
703 * and return the same value than the CLZ instruction.
704 * Note this is similar to the standard ffs function but
705 * it counts zero's from the MSB instead of the LSB.
707 * word (in) return value (out)
715 * The C version of this function is used as a replacement
716 * for system not providing the equivalent of the CLZ
717 * assembly language instruction.
719 * Note that this version is big-endian
722 _lzcount(uint32_t word)
724 unsigned int lzcount = 0;
728 while ((word & 0x80000000) == 0) {
736 ixpqmgr_intr(void *arg)
738 struct ixpqmgr_softc *sc = ixpqmgr_sc;
739 uint32_t intRegVal; /* Interrupt reg val */
741 int priorityTableIndex; /* Priority table index */
742 int qIndex; /* Current queue being processed */
744 /* Read the interrupt register */
745 intRegVal = aqm_reg_read(sc, IX_QMGR_QINTREG0_OFFSET);
746 /* Write back to clear interrupt */
747 aqm_reg_write(sc, IX_QMGR_QINTREG0_OFFSET, intRegVal);
749 DPRINTFn(5, sc->sc_dev, "%s: ISR0 0x%x ISR1 0x%x\n",
750 __func__, intRegVal, aqm_reg_read(sc, IX_QMGR_QINTREG1_OFFSET));
752 /* No queue has interrupt register set */
753 if (intRegVal != 0) {
754 /* get the first queue Id from the interrupt register value */
755 qIndex = (32 - 1) - _lzcount(intRegVal);
757 DPRINTFn(2, sc->sc_dev, "%s: ISR0 0x%x qIndex %u\n",
758 __func__, intRegVal, qIndex);
761 * Optimize for single callback case.
763 qi = &sc->qinfo[qIndex];
764 if (intRegVal == qi->intRegCheckMask) {
766 * Only 1 queue event triggered a notification.
767 * Call the callback function for this queue
769 qi->cb(qIndex, qi->cbarg);
772 * The event is triggered by more than 1 queue,
773 * the queue search will start from the beginning
774 * or the middle of the priority table.
776 * The search will end when all the bits of the interrupt
777 * register are cleared. There is no need to maintain
778 * a separate value and test it at each iteration.
780 if (intRegVal & sc->lowPriorityTableFirstHalfMask) {
781 priorityTableIndex = 0;
783 priorityTableIndex = 16;
786 * Iterate over the priority table until all the bits
787 * of the interrupt register are cleared.
790 qIndex = sc->priorityTable[priorityTableIndex++];
791 qi = &sc->qinfo[qIndex];
793 /* If this queue caused this interrupt to be raised */
794 if (intRegVal & qi->intRegCheckMask) {
795 /* Call the callback function for this queue */
796 qi->cb(qIndex, qi->cbarg);
797 /* Clear the interrupt register bit */
798 intRegVal &= ~qi->intRegCheckMask;
804 /* Rebuild the priority table if needed */
805 if (sc->rebuildTable)
811 * Generate the parameters used to check if a Q's status matches
812 * the specified source select. We calculate which status word
813 * to check (statusWordOffset), the value to check the status
814 * against (statusCheckValue) and the mask (statusMask) to mask
815 * out all but the bits to check in the status word.
818 aqm_calc_statuscheck(int qId, IxQMgrSourceId srcSel)
820 struct qmgrInfo *qi = &qinfo[qId];
823 if (qId < IX_QMGR_MIN_QUEUPP_QID) {
825 case IX_QMGR_Q_SOURCE_ID_E:
826 qi->statusCheckValue = IX_QMGR_Q_STATUS_E_BIT_MASK;
827 qi->statusMask = IX_QMGR_Q_STATUS_E_BIT_MASK;
829 case IX_QMGR_Q_SOURCE_ID_NE:
830 qi->statusCheckValue = IX_QMGR_Q_STATUS_NE_BIT_MASK;
831 qi->statusMask = IX_QMGR_Q_STATUS_NE_BIT_MASK;
833 case IX_QMGR_Q_SOURCE_ID_NF:
834 qi->statusCheckValue = IX_QMGR_Q_STATUS_NF_BIT_MASK;
835 qi->statusMask = IX_QMGR_Q_STATUS_NF_BIT_MASK;
837 case IX_QMGR_Q_SOURCE_ID_F:
838 qi->statusCheckValue = IX_QMGR_Q_STATUS_F_BIT_MASK;
839 qi->statusMask = IX_QMGR_Q_STATUS_F_BIT_MASK;
841 case IX_QMGR_Q_SOURCE_ID_NOT_E:
842 qi->statusCheckValue = 0;
843 qi->statusMask = IX_QMGR_Q_STATUS_E_BIT_MASK;
845 case IX_QMGR_Q_SOURCE_ID_NOT_NE:
846 qi->statusCheckValue = 0;
847 qi->statusMask = IX_QMGR_Q_STATUS_NE_BIT_MASK;
849 case IX_QMGR_Q_SOURCE_ID_NOT_NF:
850 qi->statusCheckValue = 0;
851 qi->statusMask = IX_QMGR_Q_STATUS_NF_BIT_MASK;
853 case IX_QMGR_Q_SOURCE_ID_NOT_F:
854 qi->statusCheckValue = 0;
855 qi->statusMask = IX_QMGR_Q_STATUS_F_BIT_MASK;
858 /* Should never hit */
863 /* One nibble of status per queue so need to shift the
864 * check value and mask out to the correct position.
866 shiftVal = (qId % IX_QMGR_QUELOWSTAT_NUM_QUE_PER_WORD) *
867 IX_QMGR_QUELOWSTAT_BITS_PER_Q;
869 /* Calculate the which status word to check from the qId,
870 * 8 Qs status per word
872 qi->statusWordOffset = qId / IX_QMGR_QUELOWSTAT_NUM_QUE_PER_WORD;
874 qi->statusCheckValue <<= shiftVal;
875 qi->statusMask <<= shiftVal;
877 /* One status word */
878 qi->statusWordOffset = 0;
879 /* Single bits per queue and int source bit hardwired NE,
882 qi->statusMask = 1 << (qId - IX_QMGR_MIN_QUEUPP_QID);
883 qi->statusCheckValue = qi->statusMask;
889 aqm_int_enable(struct ixpqmgr_softc *sc, int qId)
894 if (qId < IX_QMGR_MIN_QUEUPP_QID)
895 reg = IX_QMGR_QUEIEREG0_OFFSET;
897 reg = IX_QMGR_QUEIEREG1_OFFSET;
898 v = aqm_reg_read(sc, reg);
899 aqm_reg_write(sc, reg, v | (1 << (qId % IX_QMGR_MIN_QUEUPP_QID)));
901 DPRINTF(sc->sc_dev, "%s(%u) 0x%lx: 0x%x => 0x%x\n",
902 __func__, qId, reg, v, aqm_reg_read(sc, reg));
906 aqm_int_disable(struct ixpqmgr_softc *sc, int qId)
911 if (qId < IX_QMGR_MIN_QUEUPP_QID)
912 reg = IX_QMGR_QUEIEREG0_OFFSET;
914 reg = IX_QMGR_QUEIEREG1_OFFSET;
915 v = aqm_reg_read(sc, reg);
916 aqm_reg_write(sc, reg, v &~ (1 << (qId % IX_QMGR_MIN_QUEUPP_QID)));
918 DPRINTF(sc->sc_dev, "%s(%u) 0x%lx: 0x%x => 0x%x\n",
919 __func__, qId, reg, v, aqm_reg_read(sc, reg));
927 * N.B. this function will return 0 if supplied 0.
929 for (count = 0; n/2; count++)
934 static __inline unsigned
935 toAqmEntrySize(int entrySize)
937 /* entrySize 1("00"),2("01"),4("10") */
938 return log2(entrySize);
941 static __inline unsigned
942 toAqmBufferSize(unsigned bufferSizeInWords)
944 /* bufferSize 16("00"),32("01),64("10"),128("11") */
945 return log2(bufferSizeInWords / IX_QMGR_MIN_BUFFER_SIZE);
948 static __inline unsigned
949 toAqmWatermark(int watermark)
952 * Watermarks 0("000"),1("001"),2("010"),4("011"),
953 * 8("100"),16("101"),32("110"),64("111")
955 return log2(2 * watermark);
959 aqm_qcfg(struct ixpqmgr_softc *sc, int qId, u_int ne, u_int nf)
961 const struct qmgrInfo *qi = &sc->qinfo[qId];
963 uint32_t baseAddress;
965 /* Build config register */
966 qCfg = ((toAqmEntrySize(1) & IX_QMGR_ENTRY_SIZE_MASK) <<
967 IX_QMGR_Q_CONFIG_ESIZE_OFFSET)
968 | ((toAqmBufferSize(qi->qSizeInWords) & IX_QMGR_SIZE_MASK) <<
969 IX_QMGR_Q_CONFIG_BSIZE_OFFSET);
971 /* baseAddress, calculated relative to start address */
972 baseAddress = sc->aqmFreeSramAddress;
974 /* base address must be word-aligned */
975 KASSERT((baseAddress % IX_QMGR_BASE_ADDR_16_WORD_ALIGN) == 0,
976 ("address not word-aligned"));
978 /* Now convert to a 16 word pointer as required by QUECONFIG register */
979 baseAddress >>= IX_QMGR_BASE_ADDR_16_WORD_SHIFT;
980 qCfg |= baseAddress << IX_QMGR_Q_CONFIG_BADDR_OFFSET;
983 qCfg |= (toAqmWatermark(ne) << IX_QMGR_Q_CONFIG_NE_OFFSET)
984 | (toAqmWatermark(nf) << IX_QMGR_Q_CONFIG_NF_OFFSET);
986 DPRINTF(sc->sc_dev, "%s(%u, %u, %u) 0x%x => 0x%x @ 0x%x\n",
987 __func__, qId, ne, nf,
988 aqm_reg_read(sc, IX_QMGR_Q_CONFIG_ADDR_GET(qId)),
989 qCfg, IX_QMGR_Q_CONFIG_ADDR_GET(qId));
991 aqm_reg_write(sc, IX_QMGR_Q_CONFIG_ADDR_GET(qId), qCfg);
995 aqm_srcsel_write(struct ixpqmgr_softc *sc, int qId, int sourceId)
1001 * Calculate the register offset; multiple queues split across registers
1003 off = IX_QMGR_INT0SRCSELREG0_OFFSET +
1004 ((qId / IX_QMGR_INTSRC_NUM_QUE_PER_WORD) * sizeof(uint32_t));
1006 v = aqm_reg_read(sc, off);
1007 if (off == IX_QMGR_INT0SRCSELREG0_OFFSET && qId == 0) {
1008 /* Queue 0 at INT0SRCSELREG should not corrupt the value bit-3 */
1011 const uint32_t bpq = 32 / IX_QMGR_INTSRC_NUM_QUE_PER_WORD;
1015 qshift = (qId & (IX_QMGR_INTSRC_NUM_QUE_PER_WORD-1)) * bpq;
1016 mask = ((1 << bpq) - 1) << qshift; /* q's status mask */
1018 /* merge sourceId */
1019 v = (v &~ mask) | ((sourceId << qshift) & mask);
1022 DPRINTF(sc->sc_dev, "%s(%u, %u) 0x%x => 0x%x @ 0x%lx\n",
1023 __func__, qId, sourceId, aqm_reg_read(sc, off), v, off);
1024 aqm_reg_write(sc, off, v);
1028 * Reset AQM registers to default values.
1031 aqm_reset(struct ixpqmgr_softc *sc)
1035 /* Reset queues 0..31 status registers 0..3 */
1036 aqm_reg_write(sc, IX_QMGR_QUELOWSTAT0_OFFSET,
1037 IX_QMGR_QUELOWSTAT_RESET_VALUE);
1038 aqm_reg_write(sc, IX_QMGR_QUELOWSTAT1_OFFSET,
1039 IX_QMGR_QUELOWSTAT_RESET_VALUE);
1040 aqm_reg_write(sc, IX_QMGR_QUELOWSTAT2_OFFSET,
1041 IX_QMGR_QUELOWSTAT_RESET_VALUE);
1042 aqm_reg_write(sc, IX_QMGR_QUELOWSTAT3_OFFSET,
1043 IX_QMGR_QUELOWSTAT_RESET_VALUE);
1045 /* Reset underflow/overflow status registers 0..1 */
1046 aqm_reg_write(sc, IX_QMGR_QUEUOSTAT0_OFFSET,
1047 IX_QMGR_QUEUOSTAT_RESET_VALUE);
1048 aqm_reg_write(sc, IX_QMGR_QUEUOSTAT1_OFFSET,
1049 IX_QMGR_QUEUOSTAT_RESET_VALUE);
1051 /* Reset queues 32..63 nearly empty status registers */
1052 aqm_reg_write(sc, IX_QMGR_QUEUPPSTAT0_OFFSET,
1053 IX_QMGR_QUEUPPSTAT0_RESET_VALUE);
1055 /* Reset queues 32..63 full status registers */
1056 aqm_reg_write(sc, IX_QMGR_QUEUPPSTAT1_OFFSET,
1057 IX_QMGR_QUEUPPSTAT1_RESET_VALUE);
1059 /* Reset int0 status flag source select registers 0..3 */
1060 aqm_reg_write(sc, IX_QMGR_INT0SRCSELREG0_OFFSET,
1061 IX_QMGR_INT0SRCSELREG_RESET_VALUE);
1062 aqm_reg_write(sc, IX_QMGR_INT0SRCSELREG1_OFFSET,
1063 IX_QMGR_INT0SRCSELREG_RESET_VALUE);
1064 aqm_reg_write(sc, IX_QMGR_INT0SRCSELREG2_OFFSET,
1065 IX_QMGR_INT0SRCSELREG_RESET_VALUE);
1066 aqm_reg_write(sc, IX_QMGR_INT0SRCSELREG3_OFFSET,
1067 IX_QMGR_INT0SRCSELREG_RESET_VALUE);
1069 /* Reset queue interrupt enable register 0..1 */
1070 aqm_reg_write(sc, IX_QMGR_QUEIEREG0_OFFSET,
1071 IX_QMGR_QUEIEREG_RESET_VALUE);
1072 aqm_reg_write(sc, IX_QMGR_QUEIEREG1_OFFSET,
1073 IX_QMGR_QUEIEREG_RESET_VALUE);
1075 /* Reset queue interrupt register 0..1 */
1076 aqm_reg_write(sc, IX_QMGR_QINTREG0_OFFSET, IX_QMGR_QINTREG_RESET_VALUE);
1077 aqm_reg_write(sc, IX_QMGR_QINTREG1_OFFSET, IX_QMGR_QINTREG_RESET_VALUE);
1079 /* Reset queue configuration words 0..63 */
1080 for (i = 0; i < IX_QMGR_MAX_NUM_QUEUES; i++)
1081 aqm_reg_write(sc, sc->qinfo[i].qConfigRegAddr,
1082 IX_QMGR_QUECONFIG_RESET_VALUE);
1084 /* XXX zero SRAM to simplify debugging */
1085 for (i = IX_QMGR_QUEBUFFER_SPACE_OFFSET;
1086 i < IX_QMGR_AQM_SRAM_SIZE_IN_BYTES; i += sizeof(uint32_t))
1087 aqm_reg_write(sc, i, 0);
1090 static device_method_t ixpqmgr_methods[] = {
1091 DEVMETHOD(device_probe, ixpqmgr_probe),
1092 DEVMETHOD(device_attach, ixpqmgr_attach),
1093 DEVMETHOD(device_detach, ixpqmgr_detach),
1098 static driver_t ixpqmgr_driver = {
1101 sizeof(struct ixpqmgr_softc),
1103 static devclass_t ixpqmgr_devclass;
1105 DRIVER_MODULE(ixpqmgr, ixp, ixpqmgr_driver, ixpqmgr_devclass, 0, 0);