summaryrefslogblamecommitdiffstats
path: root/private/ntos/ndis/pc586e/loopback.c
blob: dcee0afef8602b1df4795f54513ebc00091e9560 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523










































































































































































































































































































































































































































































































































                                                                               
/*++

Copyright (c) 1990  Microsoft Corporation

Module Name:

    loopback.c

Abstract:

    The routines here indicate packets on the loopback queue and are
    responsible for inserting and removing packets from the loopback
    queue and the send finishing queue.

Author:

    Anthony V. Ercolano (Tonye) 12-Sept-1990

Environment:

    Operates at dpc level - or the equivalent on os2 and dos.

Revision History:


--*/

#include <ntos.h>
#include <ndis.h>
#include <filter.h>
#include <pc586hrd.h>
#include <pc586sft.h>


extern
VOID
Pc586ProcessLoopback(
    IN PPC586_ADAPTER Adapter
    )

/*++

Routine Description:

    This routine is responsible for indicating *one* packet on
    the loopback queue either completing it or moving on to the
    finish send queue.

Arguments:

    Adapter - The adapter whose loopback queue we are processing.

Return Value:

    None.

--*/

{



    NdisAcquireSpinLock(&Adapter->Lock);

    if (Adapter->FirstLoopBack) {

        //
        // Packet at the head of the loopback list.
        //
        PNDIS_PACKET PacketToMove;

        //
        // The reserved portion of the above packet.
        //
        PPC586_RESERVED Reserved;

        //
        // Buffer for loopback.
        //
        CHAR Loopback[PC586_SIZE_OF_RECEIVE_BUFFERS];

        //
        // The first buffer in the ndis packet to be loopbacked.
        //
        PNDIS_BUFFER FirstBuffer;

        //
        // The total amount of user data in the packet to be
        // loopbacked.
        //
        UINT TotalPacketLength;

        //
        // Eventually the address of the data to be indicated
        // to the transport.
        //
        PVOID BufferAddress;

        //
        // Eventually the length of the data to be indicated
        // to the transport.
        //
        UINT BufferLength;

        PacketToMove = Adapter->FirstLoopBack;
        Pc586RemovePacketFromLoopBack(Adapter);
        NdisReleaseSpinLock(&Adapter->Lock);

        Reserved = PPC586_RESERVED_FROM_PACKET(PacketToMove);

        //
        // See if we need to copy the data from the packet
        // into the loopback buffer.
        //
        // We need to copy to the local loopback buffer if
        // the first buffer of the packet is less than the
        // minimum loopback size AND the first buffer isn't
        // the total packet.
        //

        NdisQueryPacket(
            PacketToMove,
            NULL,
            NULL,
            &FirstBuffer,
            &TotalPacketLength
            );

        NdisQueryBuffer(
            FirstBuffer,
            NULL,
            &BufferAddress,
            &BufferLength
            );

        if ((BufferLength < PC586_SIZE_OF_RECEIVE_BUFFERS) &&
            (BufferLength != TotalPacketLength)) {

            Pc586CopyFromPacketToBuffer(
                PacketToMove,
                0,
                PC586_SIZE_OF_RECEIVE_BUFFERS,
                Loopback,
                &BufferLength
                );

            BufferAddress = Loopback;

        }

        //
        // Indicate the packet to every open binding
        // that could want it.
        //

        MacFilterIndicateReceive(
            Adapter->FilterDB,
            PacketToMove,
            ((PCHAR)BufferAddress),
            BufferAddress,
            BufferLength,
            TotalPacketLength
            );

        //
        // Remove the packet from the loopback queue and
        // either indicate that it is finished or put
        // it on the finishing up queue for the real transmits.
        //

        NdisAcquireSpinLock(&Adapter->Lock);

        if (!Reserved->STAGE.STAGE4.ReadyToComplete) {

            //
            // We can decrement the reference count on the open by one since
            // it is no longer being "referenced" by the packet on the
            // loopback queue.
            //

            PPC586_OPEN_FROM_BINDING_HANDLE(
                Reserved->MacBindingHandle
                )->References--;
            Pc586PutPacketOnFinishTrans(
                Adapter,
                PacketToMove
                );

        } else {

            PPC586_OPEN Open;
            //
            // Increment the reference count on the open so that
            // it will not be deleted out from under us while
            // where indicating it.
            //

            Open = PPC586_OPEN_FROM_BINDING_HANDLE(Reserved->MacBindingHandle);
            Open->References++;
            NdisReleaseSpinLock(&Adapter->Lock);

            NdisCompleteSend(
                Open->NdisBindingContext,
                Reserved->RequestHandle,
                ((Reserved->STAGE.STAGE4.SuccessfulTransmit)?
                 (NDIS_STATUS_SUCCESS):(NDIS_STATUS_FAILURE))
                );

            NdisAcquireSpinLock(&Adapter->Lock);

            //
            // We can decrement the reference count by two since it is
            // no longer being referenced to indicate and it is no longer
            // being "referenced" by the packet on the loopback queue.
            //

            Open->References -= 2;

        }

        //
        // If there is nothing else on the loopback queue
        // then indicate that reception is "done".
        //

        if (!Adapter->FirstLoopBack) {

            //
            // We need to signal every open binding that the
            // "receives" are complete.  We increment the reference
            // count on the open binding while we're doing indications
            // so that the open can't be deleted out from under
            // us while we're indicating (recall that we can't own
            // the lock during the indication).
            //

            PPC586_OPEN Open;
            PLIST_ENTRY CurrentLink;

            CurrentLink = Adapter->OpenBindings.Flink;

            while (CurrentLink != &Adapter->OpenBindings) {

                Open = CONTAINING_RECORD(
                         CurrentLink,
                         PC586_OPEN,
                         OpenList
                         );

                Open->References++;
                NdisReleaseSpinLock(&Adapter->Lock);

                NdisIndicateReceiveComplete(Open->NdisBindingContext);

                NdisAcquireSpinLock(&Adapter->Lock);
                Open->References--;

                CurrentLink = CurrentLink->Flink;

            }

        }

    }

    NdisReleaseSpinLock(&Adapter->Lock);

}

extern
VOID
Pc586PutPacketOnFinishTrans(
    IN PPC586_ADAPTER Adapter,
    IN PNDIS_PACKET Packet
    )

/*++

Routine Description:

    Put the packet on the adapter wide queue for packets that
    are transmitting.

    NOTE: This routine assumes that the lock is held.

    NOTE: By definition any packet given to this routine is ready
    to complete.

Arguments:

    Adapter - The adapter that contains the queue.

    Packet - The packet to be put on the queue.

Return Value:

    None.

--*/

{

    PPC586_RESERVED Reserved, LastReserved;

    Reserved = PPC586_RESERVED_FROM_PACKET(Packet);

    Reserved->STAGE.ClearStage = 0;

    if (Adapter->LastFinishTransmit) {

        LastReserved =
           PPC586_RESERVED_FROM_PACKET(Adapter->LastFinishTransmit);

        LastReserved->Next = Packet;
        Reserved->STAGE.BackPointer = Adapter->LastFinishTransmit;

    } else {

        Reserved->STAGE.BackPointer = NULL;

    }

    Reserved->STAGE.STAGE4.ReadyToComplete = TRUE;
    Reserved->Next = NULL;

    Adapter->LastFinishTransmit = Packet;

    if (!Adapter->FirstFinishTransmit) {

        Adapter->FirstFinishTransmit = Packet;

    }

}

extern
VOID
Pc586RemovePacketOnFinishTrans(
    IN PPC586_ADAPTER Adapter,
    IN PNDIS_PACKET Packet
    )

/*++

Routine Description:

    Remove a packet on the adapter wide queue for packets that
    are transmitting.

    NOTE: This routine assumes that the lock is held.

Arguments:

    Adapter - The adapter that contains the queue.

    Packet - The packet to be removed from the queue.

Return Value:

    None.

--*/

{

    PPC586_RESERVED Reserved, RBack, RForward;
    PNDIS_PACKET Forward, Back;

    Reserved = PPC586_RESERVED_FROM_PACKET(Packet);
    //
    // Get rid of the low bits that is set in the backpointer by
    // the routine that inserted this packet on the finish
    // transmission list.
    //
    Reserved->STAGE.STAGE4.ReadyToComplete = 0;
    Reserved->STAGE.STAGE4.SuccessfulTransmit = 0;

    Forward = Reserved->Next;

    ASSERT(sizeof(UINT) == sizeof(PNDIS_PACKET));

    Back = Reserved->STAGE.BackPointer;

    if (!Back) {

        Adapter->FirstFinishTransmit = Forward;

    } else {

        RBack = PPC586_RESERVED_FROM_PACKET(Back);

        RBack->Next = Forward;

    }

    if (!Forward) {

        Adapter->LastFinishTransmit = Back;

    } else {

        RForward = PPC586_RESERVED_FROM_PACKET(Forward);

        RForward->STAGE.BackPointer = Back;
        RForward->STAGE.STAGE4.ReadyToComplete = TRUE;

    }

}

extern
VOID
Pc586PutPacketOnLoopBack(
    IN PPC586_ADAPTER Adapter,
    IN PNDIS_PACKET Packet,
    IN BOOLEAN ReadyToComplete
    )

/*++

Routine Description:

    Put the packet on the adapter wide loop back list.

    NOTE: This routine assumes that the lock is held.

    NOTE: This routine absolutely must be called before the packet
    is relinquished to the hardware.

    NOTE: This routine also increments the reference count on the
    open binding.

Arguments:

    Adapter - The adapter that contains the loop back list.

    Packet - The packet to be put on loop back.

    ReadyToComplete - This value should be placed in the
    reserved section.

    NOTE: If ReadyToComplete == TRUE then the packets completion status
    field will also be set TRUE.

Return Value:

    None.

--*/

{

    PPC586_RESERVED Reserved = PPC586_RESERVED_FROM_PACKET(Packet);

    if (!Adapter->FirstLoopBack) {

        Adapter->FirstLoopBack = Packet;

    } else {

        PPC586_RESERVED_FROM_PACKET(Adapter->LastLoopBack)->Next = Packet;

    }

    Reserved->STAGE.ClearStage = 0;
    Reserved->STAGE.STAGE4.ReadyToComplete = ReadyToComplete;

    if (ReadyToComplete) {

        Reserved->STAGE.STAGE4.SuccessfulTransmit = TRUE;

    }

    Reserved->Next = NULL;
    Adapter->LastLoopBack = Packet;

    //
    // Increment the reference count on the open since it will be
    // leaving a packet on the loopback queue.
    //

    PPC586_OPEN_FROM_BINDING_HANDLE(Reserved->MacBindingHandle)->References++;

}

extern
VOID
Pc586RemovePacketFromLoopBack(
    IN PPC586_ADAPTER Adapter
    )

/*++

Routine Description:

    Remove the first packet on the adapter wide loop back list.

    NOTE: This routine assumes that the lock is held.

Arguments:

    Adapter - The adapter that contains the loop back list.

Return Value:

    None.

--*/

{

    PPC586_RESERVED Reserved =
        PPC586_RESERVED_FROM_PACKET(Adapter->FirstLoopBack);

    if (!Reserved->Next) {

        Adapter->LastLoopBack = NULL;

    }

    Adapter->FirstLoopBack = Reserved->Next;

}