3 * ===================================
4 * HARP | Host ATM Research Platform
5 * ===================================
8 * This Host ATM Research Platform ("HARP") file (the "Software") is
9 * made available by Network Computing Services, Inc. ("NetworkCS")
10 * "AS IS". NetworkCS does not provide maintenance, improvements or
11 * support of any kind.
13 * NETWORKCS MAKES NO WARRANTIES OR REPRESENTATIONS, EXPRESS OR IMPLIED,
14 * INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF MERCHANTABILITY
15 * AND FITNESS FOR A PARTICULAR PURPOSE, AS TO ANY ELEMENT OF THE
16 * SOFTWARE OR ANY SUPPORT PROVIDED IN CONNECTION WITH THIS SOFTWARE.
17 * In no event shall NetworkCS be responsible for any damages, including
18 * but not limited to consequential damages, arising from or relating to
19 * any use of the Software or related support.
21 * Copyright 1994-1998 Network Computing Services, Inc.
23 * Copies of this Software may be made, however, the above copyright
24 * notice must be reproduced on all copies.
26 * @(#) $FreeBSD: src/sys/dev/hea/eni_receive.c,v 1.5 1999/08/28 00:41:45 peter Exp $
31 * Efficient ENI Adapter Support
32 * -----------------------------
38 #include <netatm/kern_include.h>
40 #include <dev/hea/eni_stats.h>
41 #include <dev/hea/eni.h>
42 #include <dev/hea/eni_var.h>
45 __RCSID("@(#) $FreeBSD: src/sys/dev/hea/eni_receive.c,v 1.5 1999/08/28 00:41:45 peter Exp $");
48 static void eni_recv_stack __P((void *, KBuffer *));
51 extern int eni_pdu_print;
55 * Procedure to remove VCs from the Service List and generate DMA
56 * requests to move the associated PDUs into host memory. As PDUs
57 * are completed in adapter memory, the adapter examines the IN_SERVICE
58 * bit for the VC in the VC table. If this bit is not set, the adapter
59 * will place the VC number at the end of the service list queue, set
60 * the IN_SERVICE bit in the VC table, and interrupt the host. The host
61 * will remove VCs from the service list, clear the IN_SERVICE bit in
62 * the VC table, and create a DMA list to move the PDU into host buffers.
65 * eup pointer to per unit structure
72 eni_do_service ( eup )
82 u_long dma[TEMP_DMA_SIZE];
84 u_long dma_rd, dma_wr;
91 * Where is the adapter currently inserting entries?
93 servwrite = eup->eu_midway[MIDWAY_SVCWR] & SVC_SIZE_MASK;
95 * As long as we're not caught up with the adapter, keep
96 * removing VCs from the service list.
98 while ( servwrite != eup->eu_servread ) {
103 * Get VC number and find VC table entry.
105 vcc = eup->eu_svclist[eup->eu_servread];
106 vct = &eup->eu_vcitbl[vcc];
107 vci_hdr = vct->vci_control; /* Current status */
110 * Check that this VCC still needs servicing. We
111 * might have closed this VCC down in between
112 * the adapter setting the flag and our checking
113 * the flag. Also check that we haven't placed the
114 * VCC into TRASH mode.
116 if ( ( vci_hdr & VCI_IN_SERVICE ) == 0 ||
117 ( (vci_hdr & ~VCI_MODE_MASK) ==
118 (VCI_MODE_TRASH << VCI_MODE_SHIFT) ) )
122 * Find the size of this VCs buffer
124 mask = (vci_hdr >> VCI_SIZE_SHIFT) & VCI_SIZE_MASK;
125 mask = 1 << (ENI_LOC_PREDIV + mask);
126 /* Turn byte count into word count */
129 * Find the start of the adapter buffer for this VC.
132 ((int)(((vci_hdr >> VCI_LOC_SHIFT ) & VCI_LOC_MASK)
133 << ENI_LOC_PREDIV) + (int)eup->eu_ram);
135 * Locate incoming VCC for this PDU and find where we
136 * should next read from.
138 evp = (Eni_vcc *) atm_dev_vcc_find ( (Cmn_unit *)eup,
140 if ( evp == (Eni_vcc *)NULL )
141 goto next_vcc; /* VCI no longer active */
142 rdptr = evp->ev_rxpos;
144 * Find out where the adapter is currently reassembling.
145 * The PDU which starts at descr is not yet complete so we
148 descr = ( vct->vci_descr >> 16 ) & 0x7FFF;
150 * As long as we haven't processed all the completed PDUs on
151 * this VC, keep going...
153 while ( rdptr != descr )
160 * Ensure that the following are reset for every new
167 * Fisrt build a DMA with JK to skip the descriptor word.
168 * We must always skip the descriptor even if it turns out
169 * that there isn't any PDU here.
172 dma[j++] = (((rdptr + 1) & (mask-1)) << DMA_COUNT_SHIFT ) |
173 ( vcc << DMA_VCC_SHIFT ) | DMA_JK;
177 * We'll use some of the values below for skipping
178 * bad PDUs or counting statistics so compute them
183 * Grab a copy of the descriptor word
185 pdu_descr = rxp[rdptr];
188 * Strip out cell count from descriptor word.
189 * At this point, we still don't know if there
190 * is any real data until after we check for
193 n_cells = pdu_descr & DESCR_CELL_COUNT;
196 * Is this an AAL5 PDU? Check MODE in vci_hdr.
198 aal5 = ( ( vci_hdr & ~VCI_MODE_MASK ) ==
199 VCI_MODE_AAL5 << VCI_MODE_SHIFT );
202 * Now check to see if we're trashing on this vcc.
203 * If so, there is no data with this VC and the
204 * next word after the current descriptor is the
205 * descriptor for the next PDU.
207 if ( ( pdu_descr & DESCR_TRASH_BIT ) != 0 ) {
210 * Count as number of AAL5 cells dropped
212 eup->eu_stats.eni_st_aal5.aal5_drops += n_cells;
215 * Count as number of AAL0 cells dropped
217 eup->eu_stats.eni_st_aal0.aal0_drops += n_cells;
218 eup->eu_pif.pif_ierrors++;
220 * When cells have been trashed, all we have in the
221 * buffer is a descriptor word. There are no data
222 * words. Set the number of cells to zero so that
223 * we correctly skip to the next word which will
224 * be the descriptor for the next PDU.
228 * Go issue the DMA to skip this descriptor word.
234 * Data length: number of cells * cell size
236 pdulen = n_cells * BYTES_PER_CELL;
239 * If this is an AAL5 PDU, then we need to check
240 * for the presence of any CRC errors. If there
241 * is one or more CRC errors, then we are going to
244 if ( aal5 && ( pdu_descr & DESCR_CRC_ERR ) ) {
248 eup->eu_pif.pif_ierrors++;
249 eup->eu_stats.eni_st_aal5.aal5_pdu_crc++;
250 if ( evp->ev_connvc->cvc_vcc )
251 evp->ev_connvc->cvc_vcc->vc_ierrors++;
253 * Build a DMA entry to skip the rest of this
257 (((rdptr + n_cells*WORDS_PER_CELL + 1)
258 & (mask-1)) << DMA_COUNT_SHIFT ) |
259 (vcc << DMA_VCC_SHIFT ) | DMA_JK;
262 * All done with this PDU. Get a buffer to save some
263 * data for reclamation services.
265 KB_ALLOCPKT ( m, ENI_SMALL_BSIZE, KB_F_NOWAIT,
270 KB_DATASTART ( m, up, u_long * );
276 * Set buffer length - only driver overhead
278 KB_LEN ( m ) = 3 * sizeof ( u_long );
280 * Insert vcc, space for DMA pointers,
284 upp = up; /* Remember location */
285 up++; /* And skip it */
286 /* - to be filled later */
287 *up = pdulen; /* Actual PDU length if it */
291 * We've a real problem here as now we can't
292 * reclaim/advance resources/safety pointers.
294 eup->eu_stats.eni_st_drv.drv_rv_norsc++;
297 "eni_do_service: No drain buffers available. Receiver about to lock.\n" );
304 * Do we need to strip the AAL layer? Yes if this
309 * Grab the CS-PDU length. Find the address of the
310 * last word, back up one word to skip CRC, and
311 * then mask the whole thing to handle circular wraps.
313 pdulen = rxp[(rdptr + n_cells*WORDS_PER_CELL - 1)
319 * We now have a valid PDU of some length. Build
320 * the necessary DMA list to move it into host
325 * Get an initial buffer.
327 KB_ALLOCPKT ( m, ENI_SMALL_BSIZE, KB_F_NOWAIT, KB_T_DATA );
329 * Do we have a valid buffer?
331 if ( m != (KBuffer *)NULL )
337 KB_DATASTART ( m, up, u_long * );
339 * Fill in pdulen in PKTHDR structure (for IP).
341 KB_PLENSET ( m, pdulen );
343 * We're going to save the VCI nuber, the start
344 * and stop DMA pointers, and the PDU length at
345 * the head of the buffer. We'll pull this out
346 * later after the DMA has completed.
348 * Insert VCI number as first word in first buffer,
349 * remeber where we want to store the start/stop
350 * pointers, and store the PDU length.
352 *up++ = vcc; /* PDU's VCC */
353 upp = up; /* Remember where we are */
354 up++; /* To stuff start/stop pointers in */
355 *up++ = pdulen; /* PDU's length */
357 * Leave some extra room in case a higher protocol
358 * (IP) wants to do a pullup. Maybe we can keep
359 * someone from having to allocate another buffer
360 * a do a larger memory copy.
362 len = MIN ( ENI_SMALL_BSIZE, pdulen );
363 (void) eni_set_dma ( eup, 1, dma, TEMP_DMA_SIZE, &j,
364 vcc, (u_long)up, len );
366 * Adjust length of remaining data in PDU
370 * Set buffer length, including our overhead
372 KB_LEN ( m ) = len + 3 * sizeof ( u_long );
374 * Finish by moving anything which won't fit in
385 KB_ALLOCEXT ( m1, ENI_LARGE_BSIZE, KB_F_NOWAIT,
393 * Figure out how much we can move into
396 len = MIN ( ENI_LARGE_BSIZE, pdulen );
398 * Setup DMA list for this buffer
400 KB_DATASTART ( m1, data_addr, u_long );
402 ( eup, 1, dma, TEMP_DMA_SIZE, &j, vcc,
405 * Adjust remaining length
413 * Link new buffer onto end and advance
420 * Either we were unable to grab another
421 * buffer or there are no large buffers
422 * available. We know that the first
423 * buffer is valid, so drop everything
424 * else, build a JK DMA to skip/drop this
425 * PDU, set the pointers to reclaim
426 * resources/advance pointers, and
427 * finish this PDU now.
430 KB_FREEALL ( KB_NEXT ( m ) );
431 eup->eu_pif.pif_ierrors++;
434 (((rdptr + n_cells*WORDS_PER_CELL + 1)
435 & (mask-1)) << DMA_COUNT_SHIFT ) |
436 (vcc << DMA_VCC_SHIFT ) |
440 * Reset PDU length to zero
444 * Count some statistics
447 * Count this as dropped cells
450 eup->eu_stats.eni_st_aal5.aal5_drops +=
452 eup->eu_stats.eni_st_aal5.aal5_pdu_drops++;
454 eup->eu_stats.eni_st_aal0.aal0_drops +=
463 * If necessary, skip AAL layer
467 (((rdptr + n_cells*WORDS_PER_CELL + 1)
468 & (mask-1)) << DMA_COUNT_SHIFT)
469 | (vcc << DMA_VCC_SHIFT) | DMA_JK;
474 * We failed to get an initial buffer. Since we
475 * haven't changed anything for this PDU yet and the
476 * PDU is still valid, exit now and try to service it
477 * next time around. We're not very likely to get
478 * another buffer right now anyways.
480 eup->eu_stats.eni_st_drv.drv_rv_nobufs++;
483 "eni_do_service: No buffers available. Exiting without servicing service list.\n" );
486 * Clear the IN_SERVICE indicator for this VCC
488 vct->vci_control &= ~VCI_IN_SERVICE;
494 * Set the end bit on the last DMA for this PDU
496 dma[j-2] |= DMA_END_BIT;
499 * Where are the current DMA pointers
501 dma_rd = eup->eu_midway[MIDWAY_RX_RD];
502 dma_wr = eup->eu_midway[MIDWAY_RX_WR];
505 * Check how much space is available
507 if ( dma_rd == dma_wr )
508 dma_avail = DMA_LIST_SIZE;
510 dma_avail = ( dma_rd + DMA_LIST_SIZE - dma_wr )
514 * Check for queue full or wrap past write okay pointer
516 if ( dma_avail < j ||
517 ( dma_wr + j > eup->eu_rxdmawr + DMA_LIST_SIZE ) ) {
519 * There's no room in the DMA list to insert
520 * this request. Since we haven't changed anything
521 * yet and the PDU is good, exit now and service
522 * it next time around. What we really need to do
523 * is wait for the RX list to drain and that won't
524 * happen if we keep trying to process PDUs here.
526 eup->eu_stats.eni_st_drv.drv_rv_nodma++;
529 "eni_do_service: No room in receive DMA list. Postponing service request.\n" );
532 * Free the local buffer chain
536 * Clear the IN_SERVICE indicator for this VCC.
538 vct->vci_control &= ~VCI_IN_SERVICE;
543 * If we have a buffer chain, save the starting
554 for ( i = 0; i < j; i++ ) {
555 eup->eu_rxdma[dma_wr*2] = dma[i*2];
556 eup->eu_rxdma[dma_wr*2+1] = dma[i*2+1];
557 dma_wr = (dma_wr+1) & (DMA_LIST_SIZE-1);
560 * If we have a buffer chain, save the location of
561 * the ending dma_list location and queue the chain
562 * so that we can recover the resources later.
567 * Place buffer on receive queue waiting for RX_DMA
569 if ( IF_QFULL ( &eup->eu_rxqueue ) ) {
571 * We haven't done anything we can't back out
572 * of. Drop request and service it next time.
573 * We've inserted the DMA list but it's not
574 * valid until we advance the RX_WR pointer,
575 * thus it's okay to bail here...
577 eup->eu_stats.eni_st_drv.drv_rv_rxq++;
580 "eni_do_service: RX drain queue full. Postponing servicing.\n" );
584 * Clear the IN_SERVICE indicator for this VCC.
586 vct->vci_control &= ~VCI_IN_SERVICE;
589 IF_ENQUEUE ( &eup->eu_rxqueue, m );
591 * Advance the RX_WR pointer to cause
592 * the adapter to work on this DMA list.
594 eup->eu_midway[MIDWAY_RX_WR] = dma_wr;
598 * Advance our notion of where the next PDU
601 rdptr = (rdptr + n_cells*WORDS_PER_CELL + 1)
603 evp->ev_rxpos = rdptr;
606 * Increment cells/pdu received stats.
608 eup->eu_stats.eni_st_atm.atm_rcvd += n_cells;
610 eup->eu_stats.eni_st_aal5.aal5_rcvd += n_cells;
611 eup->eu_stats.eni_st_aal5.aal5_pdu_rcvd++;
613 eup->eu_stats.eni_st_aal0.aal0_rcvd += n_cells;
617 * Continue processing PDUs on this same VCI
623 * Advance to next entry in the service_list.
625 eup->eu_servread = (eup->eu_servread + 1) & SVC_SIZE_MASK;
628 * And clear the IN_SERVICE indicator for this VCC.
630 vct->vci_control &= ~VCI_IN_SERVICE;
636 * Drain Receive queue
638 * As we build DMA lists to move PDUs from adapter buffers into host
639 * buffers, we place the request on a private ifqueue so that we can
640 * free any resources AFTER we know they've been successfully DMAed.
641 * As part of the service processing, we record the PDUs start and stop
642 * entries in the DMA list, and prevent wrapping. When we pull the top
643 * entry off, we simply check that the current DMA location is outside
644 * this PDU and if so, it's okay to free things.
647 * eup pointer to device unit structure
654 eni_recv_drain ( eup )
668 /* Pop first buffer */
669 IF_DEQUEUE ( &eup->eu_rxqueue, m );
674 KB_DATASTART ( m, up, u_long * );
677 * Grab the VCI number
682 * Check to see if we can process this buffer yet.
684 /* Get current DMA_Rdptr */
685 DMA_Rdptr = eup->eu_midway[MIDWAY_RX_RD];
686 /* Boundaries for first buffer */
688 start = dma_wrp >> 16;
689 stop = dma_wrp & 0xffff;
691 * Start should not equal stop because that would
692 * mean we tried inserting a NULL DMA list.
694 if ( start > stop ) { /* We wrapped */
695 if ( !(DMA_Rdptr >= stop && DMA_Rdptr < start) ) {
696 IF_PREPEND ( &eup->eu_rxqueue, m );
700 if ( DMA_Rdptr < stop && DMA_Rdptr >= start ) {
701 IF_PREPEND ( &eup->eu_rxqueue, m );
706 * Adapter is finished with this buffer, we can
707 * continue processing it now.
711 * Locate incoming VCC for this PDU
713 evp = (Eni_vcc *) atm_dev_vcc_find ( (Cmn_unit *)eup,
717 eup->eu_stats.eni_st_drv.drv_rv_novcc++;
724 atm_dev_pdu_print ( (Cmn_unit *)eup, (Cmn_vcc *)evp, m,
729 * Grab theoretical PDU length
734 * Quick, count the PDU
736 eup->eu_pif.pif_ipdus++;
737 eup->eu_pif.pif_ibytes += pdulen;
739 vcp = evp->ev_connvc->cvc_vcc;
742 vcp->vc_ibytes += pdulen;
744 vcp->vc_nif->nif_ibytes += pdulen;
745 vcp->vc_nif->nif_if.if_ipackets++;
746 #if (defined(BSD) && (BSD >= 199103))
747 vcp->vc_nif->nif_if.if_ibytes += pdulen;
754 * Advance DMA write allowable pointer
756 eup->eu_rxdmawr = stop;
759 * Get packet PDU length
761 KB_PLENGET ( m, pdulen );
764 * Only try queueing this if there is data
765 * to be handed up to the next layer. Errors
766 * such as CRC and VC trashing will get us this
767 * far to advance pointers, etc., but the PDU
768 * length will be zero.
772 * We saved three words back in eni_do_service()
773 * to use for callback. Since the core only
774 * expects two words, skip over the first one.
775 * Then, reset up pointer to start of buffer data
776 * area and write the callback info.
778 KB_HEADADJ ( m, -sizeof(u_long) );
779 KB_DATASTART ( m, up, u_long * );
780 *((int *)up) = (int)eni_recv_stack;
782 *((int *)up) = (int)evp;
786 if ( !IF_QFULL ( &atm_intrq ) ) {
788 IF_ENQUEUE ( &atm_intrq, m );
790 eup->eu_stats.eni_st_drv.drv_rv_intrq++;
791 eup->eu_pif.pif_ierrors++;
794 "eni_receive_drain: ATM_INTRQ is full. Unable to pass up stack.\n" );
800 * Free zero-length buffer
807 * Look for next buffer
809 IF_DEQUEUE ( &eup->eu_rxqueue, m );
815 * If we found any completed buffers, schedule a call into
816 * the kernel to process the atm_intrq.
826 * Pass incoming PDU up Stack
828 * This function is called via the core ATM interrupt queue callback
829 * set in eni_recv_drain(). It will pass the supplied incoming
830 * PDU up the incoming VCC's stack.
833 * tok token to identify stack instantiation
834 * m pointer to incoming PDU buffer chain
840 eni_recv_stack ( tok, m )
844 Eni_vcc *evp = (Eni_vcc *)tok;
848 * This should never happen now but if it does and we don't stop it,
849 * we end up panic'ing in netatm when trying to pull a function
850 * pointer and token value out of a buffer with address zero.
855 "eni_recv_stack: NULL buffer, tok = %p\n", tok );
861 * Send the data up the stack
863 STACK_CALL ( CPCS_UNITDATA_SIG, evp->ev_upper,
864 (void *)evp->ev_toku, evp->ev_connvc, (int)m, 0, err );