aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/char/ip2/i2ellis.c
diff options
context:
space:
mode:
authorLinus Torvalds <torvalds@ppc970.osdl.org>2005-04-16 18:20:36 -0400
committerLinus Torvalds <torvalds@ppc970.osdl.org>2005-04-16 18:20:36 -0400
commit1da177e4c3f41524e886b7f1b8a0c1fc7321cac2 (patch)
tree0bba044c4ce775e45a88a51686b5d9f90697ea9d /drivers/char/ip2/i2ellis.c
Linux-2.6.12-rc2v2.6.12-rc2
Initial git repository build. I'm not bothering with the full history, even though we have it. We can create a separate "historical" git archive of that later if we want to, and in the meantime it's about 3.2GB when imported into git - space that would just make the early git days unnecessarily complicated, when we don't have a lot of good infrastructure for it. Let it rip!
Diffstat (limited to 'drivers/char/ip2/i2ellis.c')
-rw-r--r--drivers/char/ip2/i2ellis.c1487
1 files changed, 1487 insertions, 0 deletions
diff --git a/drivers/char/ip2/i2ellis.c b/drivers/char/ip2/i2ellis.c
new file mode 100644
index 000000000000..f834d05ccc97
--- /dev/null
+++ b/drivers/char/ip2/i2ellis.c
@@ -0,0 +1,1487 @@
1/*******************************************************************************
2*
3* (c) 1998 by Computone Corporation
4*
5********************************************************************************
6*
7*
8* PACKAGE: Linux tty Device Driver for IntelliPort family of multiport
9* serial I/O controllers.
10*
11* DESCRIPTION: Low-level interface code for the device driver
12* (This is included source code, not a separate compilation
13* module.)
14*
15*******************************************************************************/
16//---------------------------------------------
17// Function declarations private to this module
18//---------------------------------------------
19// Functions called only indirectly through i2eBordStr entries.
20
21static int iiWriteBuf16(i2eBordStrPtr, unsigned char *, int);
22static int iiWriteBuf8(i2eBordStrPtr, unsigned char *, int);
23static int iiReadBuf16(i2eBordStrPtr, unsigned char *, int);
24static int iiReadBuf8(i2eBordStrPtr, unsigned char *, int);
25
26static unsigned short iiReadWord16(i2eBordStrPtr);
27static unsigned short iiReadWord8(i2eBordStrPtr);
28static void iiWriteWord16(i2eBordStrPtr, unsigned short);
29static void iiWriteWord8(i2eBordStrPtr, unsigned short);
30
31static int iiWaitForTxEmptyII(i2eBordStrPtr, int);
32static int iiWaitForTxEmptyIIEX(i2eBordStrPtr, int);
33static int iiTxMailEmptyII(i2eBordStrPtr);
34static int iiTxMailEmptyIIEX(i2eBordStrPtr);
35static int iiTrySendMailII(i2eBordStrPtr, unsigned char);
36static int iiTrySendMailIIEX(i2eBordStrPtr, unsigned char);
37
38static unsigned short iiGetMailII(i2eBordStrPtr);
39static unsigned short iiGetMailIIEX(i2eBordStrPtr);
40
41static void iiEnableMailIrqII(i2eBordStrPtr);
42static void iiEnableMailIrqIIEX(i2eBordStrPtr);
43static void iiWriteMaskII(i2eBordStrPtr, unsigned char);
44static void iiWriteMaskIIEX(i2eBordStrPtr, unsigned char);
45
46static void ii2DelayTimer(unsigned int);
47static void ii2DelayWakeup(unsigned long id);
48static void ii2Nop(void);
49
50//***************
51//* Static Data *
52//***************
53
54static int ii2Safe; // Safe I/O address for delay routine
55
56static int iiDelayed; // Set when the iiResetDelay function is
57 // called. Cleared when ANY board is reset.
58static struct timer_list * pDelayTimer; // Used by iiDelayTimer
59static wait_queue_head_t pDelayWait; // Used by iiDelayTimer
60static rwlock_t Dl_spinlock;
61
62//********
63//* Code *
64//********
65
66//=======================================================
67// Initialization Routines
68//
69// iiSetAddress
70// iiReset
71// iiResetDelay
72// iiInitialize
73//=======================================================
74
75//******************************************************************************
76// Function: iiEllisInit()
77// Parameters: None
78//
79// Returns: Nothing
80//
81// Description:
82//
83// This routine performs any required initialization of the iiEllis subsystem.
84//
85//******************************************************************************
86static void
87iiEllisInit(void)
88{
89 pDelayTimer = kmalloc ( sizeof (struct timer_list), GFP_KERNEL );
90 init_timer(pDelayTimer);
91 init_waitqueue_head(&pDelayWait);
92 LOCK_INIT(&Dl_spinlock);
93}
94
95//******************************************************************************
96// Function: iiEllisCleanup()
97// Parameters: None
98//
99// Returns: Nothing
100//
101// Description:
102//
103// This routine performs any required cleanup of the iiEllis subsystem.
104//
105//******************************************************************************
106static void
107iiEllisCleanup(void)
108{
109 if ( pDelayTimer != NULL ) {
110 kfree ( pDelayTimer );
111 }
112}
113
114//******************************************************************************
115// Function: iiSetAddress(pB, address, delay)
116// Parameters: pB - pointer to the board structure
117// address - the purported I/O address of the board
118// delay - pointer to the 1-ms delay function to use
119// in this and any future operations to this board
120//
121// Returns: True if everything appears copacetic.
122// False if there is any error: the pB->i2eError field has the error
123//
124// Description:
125//
126// This routine (roughly) checks for address validity, sets the i2eValid OK and
127// sets the state to II_STATE_COLD which means that we haven't even sent a reset
128// yet.
129//
130//******************************************************************************
131static int
132iiSetAddress( i2eBordStrPtr pB, int address, delayFunc_t delay )
133{
134 // Should any failure occur before init is finished...
135 pB->i2eValid = I2E_INCOMPLETE;
136
137 // Cannot check upper limit except extremely: Might be microchannel
138 // Address must be on an 8-byte boundary
139
140 if ((unsigned int)address <= 0x100
141 || (unsigned int)address >= 0xfff8
142 || (address & 0x7)
143 )
144 {
145 COMPLETE(pB,I2EE_BADADDR);
146 }
147
148 // Initialize accelerators
149 pB->i2eBase = address;
150 pB->i2eData = address + FIFO_DATA;
151 pB->i2eStatus = address + FIFO_STATUS;
152 pB->i2ePointer = address + FIFO_PTR;
153 pB->i2eXMail = address + FIFO_MAIL;
154 pB->i2eXMask = address + FIFO_MASK;
155
156 // Initialize i/o address for ii2DelayIO
157 ii2Safe = address + FIFO_NOP;
158
159 // Initialize the delay routine
160 pB->i2eDelay = ((delay != (delayFunc_t)NULL) ? delay : (delayFunc_t)ii2Nop);
161
162 pB->i2eValid = I2E_MAGIC;
163 pB->i2eState = II_STATE_COLD;
164
165 COMPLETE(pB, I2EE_GOOD);
166}
167
168//******************************************************************************
169// Function: iiReset(pB)
170// Parameters: pB - pointer to the board structure
171//
172// Returns: True if everything appears copacetic.
173// False if there is any error: the pB->i2eError field has the error
174//
175// Description:
176//
177// Attempts to reset the board (see also i2hw.h). Normally, we would use this to
178// reset a board immediately after iiSetAddress(), but it is valid to reset a
179// board from any state, say, in order to change or re-load loadware. (Under
180// such circumstances, no reason to re-run iiSetAddress(), which is why it is a
181// separate routine and not included in this routine.
182//
183//******************************************************************************
184static int
185iiReset(i2eBordStrPtr pB)
186{
187 // Magic number should be set, else even the address is suspect
188 if (pB->i2eValid != I2E_MAGIC)
189 {
190 COMPLETE(pB, I2EE_BADMAGIC);
191 }
192
193 OUTB(pB->i2eBase + FIFO_RESET, 0); // Any data will do
194 iiDelay(pB, 50); // Pause between resets
195 OUTB(pB->i2eBase + FIFO_RESET, 0); // Second reset
196
197 // We must wait before even attempting to read anything from the FIFO: the
198 // board's P.O.S.T may actually attempt to read and write its end of the
199 // FIFO in order to check flags, loop back (where supported), etc. On
200 // completion of this testing it would reset the FIFO, and on completion
201 // of all // P.O.S.T., write the message. We must not mistake data which
202 // might have been sent for testing as part of the reset message. To
203 // better utilize time, say, when resetting several boards, we allow the
204 // delay to be performed externally; in this way the caller can reset
205 // several boards, delay a single time, then call the initialization
206 // routine for all.
207
208 pB->i2eState = II_STATE_RESET;
209
210 iiDelayed = 0; // i.e., the delay routine hasn't been called since the most
211 // recent reset.
212
213 // Ensure anything which would have been of use to standard loadware is
214 // blanked out, since board has now forgotten everything!.
215
216 pB->i2eUsingIrq = IRQ_UNDEFINED; // Not set up to use an interrupt yet
217 pB->i2eWaitingForEmptyFifo = 0;
218 pB->i2eOutMailWaiting = 0;
219 pB->i2eChannelPtr = NULL;
220 pB->i2eChannelCnt = 0;
221
222 pB->i2eLeadoffWord[0] = 0;
223 pB->i2eFifoInInts = 0;
224 pB->i2eFifoOutInts = 0;
225 pB->i2eFatalTrap = NULL;
226 pB->i2eFatal = 0;
227
228 COMPLETE(pB, I2EE_GOOD);
229}
230
231//******************************************************************************
232// Function: iiResetDelay(pB)
233// Parameters: pB - pointer to the board structure
234//
235// Returns: True if everything appears copacetic.
236// False if there is any error: the pB->i2eError field has the error
237//
238// Description:
239//
240// Using the delay defined in board structure, waits two seconds (for board to
241// reset).
242//
243//******************************************************************************
244static int
245iiResetDelay(i2eBordStrPtr pB)
246{
247 if (pB->i2eValid != I2E_MAGIC) {
248 COMPLETE(pB, I2EE_BADMAGIC);
249 }
250 if (pB->i2eState != II_STATE_RESET) {
251 COMPLETE(pB, I2EE_BADSTATE);
252 }
253 iiDelay(pB,2000); /* Now we wait for two seconds. */
254 iiDelayed = 1; /* Delay has been called: ok to initialize */
255 COMPLETE(pB, I2EE_GOOD);
256}
257
258//******************************************************************************
259// Function: iiInitialize(pB)
260// Parameters: pB - pointer to the board structure
261//
262// Returns: True if everything appears copacetic.
263// False if there is any error: the pB->i2eError field has the error
264//
265// Description:
266//
267// Attempts to read the Power-on reset message. Initializes any remaining fields
268// in the pB structure.
269//
270// This should be called as the third step of a process beginning with
271// iiReset(), then iiResetDelay(). This routine checks to see that the structure
272// is "valid" and in the reset state, also confirms that the delay routine has
273// been called since the latest reset (to any board! overly strong!).
274//
275//******************************************************************************
276static int
277iiInitialize(i2eBordStrPtr pB)
278{
279 int itemp;
280 unsigned char c;
281 unsigned short utemp;
282 unsigned int ilimit;
283
284 if (pB->i2eValid != I2E_MAGIC)
285 {
286 COMPLETE(pB, I2EE_BADMAGIC);
287 }
288
289 if (pB->i2eState != II_STATE_RESET || !iiDelayed)
290 {
291 COMPLETE(pB, I2EE_BADSTATE);
292 }
293
294 // In case there is a failure short of our completely reading the power-up
295 // message.
296 pB->i2eValid = I2E_INCOMPLETE;
297
298
299 // Now attempt to read the message.
300
301 for (itemp = 0; itemp < sizeof(porStr); itemp++)
302 {
303 // We expect the entire message is ready.
304 if (HAS_NO_INPUT(pB))
305 {
306 pB->i2ePomSize = itemp;
307 COMPLETE(pB, I2EE_PORM_SHORT);
308 }
309
310 pB->i2ePom.c[itemp] = c = BYTE_FROM(pB);
311
312 // We check the magic numbers as soon as they are supposed to be read
313 // (rather than after) to minimize effect of reading something we
314 // already suspect can't be "us".
315 if ( (itemp == POR_1_INDEX && c != POR_MAGIC_1) ||
316 (itemp == POR_2_INDEX && c != POR_MAGIC_2))
317 {
318 pB->i2ePomSize = itemp+1;
319 COMPLETE(pB, I2EE_BADMAGIC);
320 }
321 }
322
323 pB->i2ePomSize = itemp;
324
325 // Ensure that this was all the data...
326 if (HAS_INPUT(pB))
327 COMPLETE(pB, I2EE_PORM_LONG);
328
329 // For now, we'll fail to initialize if P.O.S.T reports bad chip mapper:
330 // Implying we will not be able to download any code either: That's ok: the
331 // condition is pretty explicit.
332 if (pB->i2ePom.e.porDiag1 & POR_BAD_MAPPER)
333 {
334 COMPLETE(pB, I2EE_POSTERR);
335 }
336
337 // Determine anything which must be done differently depending on the family
338 // of boards!
339 switch (pB->i2ePom.e.porID & POR_ID_FAMILY)
340 {
341 case POR_ID_FII: // IntelliPort-II
342
343 pB->i2eFifoStyle = FIFO_II;
344 pB->i2eFifoSize = 512; // 512 bytes, always
345 pB->i2eDataWidth16 = NO;
346
347 pB->i2eMaxIrq = 15; // Because board cannot tell us it is in an 8-bit
348 // slot, we do allow it to be done (documentation!)
349
350 pB->i2eGoodMap[1] =
351 pB->i2eGoodMap[2] =
352 pB->i2eGoodMap[3] =
353 pB->i2eChannelMap[1] =
354 pB->i2eChannelMap[2] =
355 pB->i2eChannelMap[3] = 0;
356
357 switch (pB->i2ePom.e.porID & POR_ID_SIZE)
358 {
359 case POR_ID_II_4:
360 pB->i2eGoodMap[0] =
361 pB->i2eChannelMap[0] = 0x0f; // four-port
362
363 // Since porPorts1 is based on the Hardware ID register, the numbers
364 // should always be consistent for IntelliPort-II. Ditto below...
365 if (pB->i2ePom.e.porPorts1 != 4)
366 {
367 COMPLETE(pB, I2EE_INCONSIST);
368 }
369 break;
370
371 case POR_ID_II_8:
372 case POR_ID_II_8R:
373 pB->i2eGoodMap[0] =
374 pB->i2eChannelMap[0] = 0xff; // Eight port
375 if (pB->i2ePom.e.porPorts1 != 8)
376 {
377 COMPLETE(pB, I2EE_INCONSIST);
378 }
379 break;
380
381 case POR_ID_II_6:
382 pB->i2eGoodMap[0] =
383 pB->i2eChannelMap[0] = 0x3f; // Six Port
384 if (pB->i2ePom.e.porPorts1 != 6)
385 {
386 COMPLETE(pB, I2EE_INCONSIST);
387 }
388 break;
389 }
390
391 // Fix up the "good channel list based on any errors reported.
392 if (pB->i2ePom.e.porDiag1 & POR_BAD_UART1)
393 {
394 pB->i2eGoodMap[0] &= ~0x0f;
395 }
396
397 if (pB->i2ePom.e.porDiag1 & POR_BAD_UART2)
398 {
399 pB->i2eGoodMap[0] &= ~0xf0;
400 }
401
402 break; // POR_ID_FII case
403
404 case POR_ID_FIIEX: // IntelliPort-IIEX
405
406 pB->i2eFifoStyle = FIFO_IIEX;
407
408 itemp = pB->i2ePom.e.porFifoSize;
409
410 // Implicit assumption that fifo would not grow beyond 32k,
411 // nor would ever be less than 256.
412
413 if (itemp < 8 || itemp > 15)
414 {
415 COMPLETE(pB, I2EE_INCONSIST);
416 }
417 pB->i2eFifoSize = (1 << itemp);
418
419 // These are based on what P.O.S.T thinks should be there, based on
420 // box ID registers
421 ilimit = pB->i2ePom.e.porNumBoxes;
422 if (ilimit > ABS_MAX_BOXES)
423 {
424 ilimit = ABS_MAX_BOXES;
425 }
426
427 // For as many boxes as EXIST, gives the type of box.
428 // Added 8/6/93: check for the ISA-4 (asic) which looks like an
429 // expandable but for whom "8 or 16?" is not the right question.
430
431 utemp = pB->i2ePom.e.porFlags;
432 if (utemp & POR_CEX4)
433 {
434 pB->i2eChannelMap[0] = 0x000f;
435 } else {
436 utemp &= POR_BOXES;
437 for (itemp = 0; itemp < ilimit; itemp++)
438 {
439 pB->i2eChannelMap[itemp] =
440 ((utemp & POR_BOX_16) ? 0xffff : 0x00ff);
441 utemp >>= 1;
442 }
443 }
444
445 // These are based on what P.O.S.T actually found.
446
447 utemp = (pB->i2ePom.e.porPorts2 << 8) + pB->i2ePom.e.porPorts1;
448
449 for (itemp = 0; itemp < ilimit; itemp++)
450 {
451 pB->i2eGoodMap[itemp] = 0;
452 if (utemp & 1) pB->i2eGoodMap[itemp] |= 0x000f;
453 if (utemp & 2) pB->i2eGoodMap[itemp] |= 0x00f0;
454 if (utemp & 4) pB->i2eGoodMap[itemp] |= 0x0f00;
455 if (utemp & 8) pB->i2eGoodMap[itemp] |= 0xf000;
456 utemp >>= 4;
457 }
458
459 // Now determine whether we should transfer in 8 or 16-bit mode.
460 switch (pB->i2ePom.e.porBus & (POR_BUS_SLOT16 | POR_BUS_DIP16) )
461 {
462 case POR_BUS_SLOT16 | POR_BUS_DIP16:
463 pB->i2eDataWidth16 = YES;
464 pB->i2eMaxIrq = 15;
465 break;
466
467 case POR_BUS_SLOT16:
468 pB->i2eDataWidth16 = NO;
469 pB->i2eMaxIrq = 15;
470 break;
471
472 case 0:
473 case POR_BUS_DIP16: // In an 8-bit slot, DIP switch don't care.
474 default:
475 pB->i2eDataWidth16 = NO;
476 pB->i2eMaxIrq = 7;
477 break;
478 }
479 break; // POR_ID_FIIEX case
480
481 default: // Unknown type of board
482 COMPLETE(pB, I2EE_BAD_FAMILY);
483 break;
484 } // End the switch based on family
485
486 // Temporarily, claim there is no room in the outbound fifo.
487 // We will maintain this whenever we check for an empty outbound FIFO.
488 pB->i2eFifoRemains = 0;
489
490 // Now, based on the bus type, should we expect to be able to re-configure
491 // interrupts (say, for testing purposes).
492 switch (pB->i2ePom.e.porBus & POR_BUS_TYPE)
493 {
494 case POR_BUS_T_ISA:
495 case POR_BUS_T_UNK: // If the type of bus is undeclared, assume ok.
496 pB->i2eChangeIrq = YES;
497 break;
498 case POR_BUS_T_MCA:
499 case POR_BUS_T_EISA:
500 pB->i2eChangeIrq = NO;
501 break;
502 default:
503 COMPLETE(pB, I2EE_BADBUS);
504 }
505
506 if (pB->i2eDataWidth16 == YES)
507 {
508 pB->i2eWriteBuf = iiWriteBuf16;
509 pB->i2eReadBuf = iiReadBuf16;
510 pB->i2eWriteWord = iiWriteWord16;
511 pB->i2eReadWord = iiReadWord16;
512 } else {
513 pB->i2eWriteBuf = iiWriteBuf8;
514 pB->i2eReadBuf = iiReadBuf8;
515 pB->i2eWriteWord = iiWriteWord8;
516 pB->i2eReadWord = iiReadWord8;
517 }
518
519 switch(pB->i2eFifoStyle)
520 {
521 case FIFO_II:
522 pB->i2eWaitForTxEmpty = iiWaitForTxEmptyII;
523 pB->i2eTxMailEmpty = iiTxMailEmptyII;
524 pB->i2eTrySendMail = iiTrySendMailII;
525 pB->i2eGetMail = iiGetMailII;
526 pB->i2eEnableMailIrq = iiEnableMailIrqII;
527 pB->i2eWriteMask = iiWriteMaskII;
528
529 break;
530
531 case FIFO_IIEX:
532 pB->i2eWaitForTxEmpty = iiWaitForTxEmptyIIEX;
533 pB->i2eTxMailEmpty = iiTxMailEmptyIIEX;
534 pB->i2eTrySendMail = iiTrySendMailIIEX;
535 pB->i2eGetMail = iiGetMailIIEX;
536 pB->i2eEnableMailIrq = iiEnableMailIrqIIEX;
537 pB->i2eWriteMask = iiWriteMaskIIEX;
538
539 break;
540
541 default:
542 COMPLETE(pB, I2EE_INCONSIST);
543 }
544
545 // Initialize state information.
546 pB->i2eState = II_STATE_READY; // Ready to load loadware.
547
548 // Some Final cleanup:
549 // For some boards, the bootstrap firmware may perform some sort of test
550 // resulting in a stray character pending in the incoming mailbox. If one is
551 // there, it should be read and discarded, especially since for the standard
552 // firmware, it's the mailbox that interrupts the host.
553
554 pB->i2eStartMail = iiGetMail(pB);
555
556 // Throw it away and clear the mailbox structure element
557 pB->i2eStartMail = NO_MAIL_HERE;
558
559 // Everything is ok now, return with good status/
560
561 pB->i2eValid = I2E_MAGIC;
562 COMPLETE(pB, I2EE_GOOD);
563}
564
565//=======================================================
566// Delay Routines
567//
568// iiDelayIO
569// iiNop
570//=======================================================
571
572static void
573ii2DelayWakeup(unsigned long id)
574{
575 wake_up_interruptible ( &pDelayWait );
576}
577
578//******************************************************************************
579// Function: ii2DelayTimer(mseconds)
580// Parameters: mseconds - number of milliseconds to delay
581//
582// Returns: Nothing
583//
584// Description:
585//
586// This routine delays for approximately mseconds milliseconds and is intended
587// to be called indirectly through i2Delay field in i2eBordStr. It uses the
588// Linux timer_list mechanism.
589//
590// The Linux timers use a unit called "jiffies" which are 10mS in the Intel
591// architecture. This function rounds the delay period up to the next "jiffy".
592// In the Alpha architecture the "jiffy" is 1mS, but this driver is not intended
593// for Alpha platforms at this time.
594//
595//******************************************************************************
596static void
597ii2DelayTimer(unsigned int mseconds)
598{
599 wait_queue_t wait;
600
601 init_waitqueue_entry(&wait, current);
602
603 init_timer ( pDelayTimer );
604
605 add_wait_queue(&pDelayWait, &wait);
606
607 set_current_state( TASK_INTERRUPTIBLE );
608
609 pDelayTimer->expires = jiffies + ( mseconds + 9 ) / 10;
610 pDelayTimer->function = ii2DelayWakeup;
611 pDelayTimer->data = 0;
612
613 add_timer ( pDelayTimer );
614
615 schedule();
616
617 set_current_state( TASK_RUNNING );
618 remove_wait_queue(&pDelayWait, &wait);
619
620 del_timer ( pDelayTimer );
621}
622
623#if 0
624//static void ii2DelayIO(unsigned int);
625//******************************************************************************
626// !!! Not Used, this is DOS crap, some of you young folks may be interested in
627// in how things were done in the stone age of caculating machines !!!
628// Function: ii2DelayIO(mseconds)
629// Parameters: mseconds - number of milliseconds to delay
630//
631// Returns: Nothing
632//
633// Description:
634//
635// This routine delays for approximately mseconds milliseconds and is intended
636// to be called indirectly through i2Delay field in i2eBordStr. It is intended
637// for use where a clock-based function is impossible: for example, DOS drivers.
638//
639// This function uses the IN instruction to place bounds on the timing and
640// assumes that ii2Safe has been set. This is because I/O instructions are not
641// subject to caching and will therefore take a certain minimum time. To ensure
642// the delay is at least long enough on fast machines, it is based on some
643// fastest-case calculations. On slower machines this may cause VERY long
644// delays. (3 x fastest case). In the fastest case, everything is cached except
645// the I/O instruction itself.
646//
647// Timing calculations:
648// The fastest bus speed for I/O operations is likely to be 10 MHz. The I/O
649// operation in question is a byte operation to an odd address. For 8-bit
650// operations, the architecture generally enforces two wait states. At 10 MHz, a
651// single cycle time is 100nS. A read operation at two wait states takes 6
652// cycles for a total time of 600nS. Therefore approximately 1666 iterations
653// would be required to generate a single millisecond delay. The worst
654// (reasonable) case would be an 8MHz system with no cacheing. In this case, the
655// I/O instruction would take 125nS x 6 cyles = 750 nS. More importantly, code
656// fetch of other instructions in the loop would take time (zero wait states,
657// however) and would be hard to estimate. This is minimized by using in-line
658// assembler for the in inner loop of IN instructions. This consists of just a
659// few bytes. So we'll guess about four code fetches per loop. Each code fetch
660// should take four cycles, so we have 125nS * 8 = 1000nS. Worst case then is
661// that what should have taken 1 mS takes instead 1666 * (1750) = 2.9 mS.
662//
663// So much for theoretical timings: results using 1666 value on some actual
664// machines:
665// IBM 286 6MHz 3.15 mS
666// Zenith 386 33MHz 2.45 mS
667// (brandX) 386 33MHz 1.90 mS (has cache)
668// (brandY) 486 33MHz 2.35 mS
669// NCR 486 ?? 1.65 mS (microchannel)
670//
671// For most machines, it is probably safe to scale this number back (remember,
672// for robust operation use an actual timed delay if possible), so we are using
673// a value of 1190. This yields 1.17 mS for the fastest machine in our sample,
674// 1.75 mS for typical 386 machines, and 2.25 mS the absolute slowest machine.
675//
676// 1/29/93:
677// The above timings are too slow. Actual cycle times might be faster. ISA cycle
678// times could approach 500 nS, and ...
679// The IBM model 77 being microchannel has no wait states for 8-bit reads and
680// seems to be accessing the I/O at 440 nS per access (from start of one to
681// start of next). This would imply we need 1000/.440 = 2272 iterations to
682// guarantee we are fast enough. In actual testing, we see that 2 * 1190 are in
683// fact enough. For diagnostics, we keep the level at 1190, but developers note
684// this needs tuning.
685//
686// Safe assumption: 2270 i/o reads = 1 millisecond
687//
688//******************************************************************************
689
690
691static int ii2DelValue = 1190; // See timing calculations below
692 // 1666 for fastest theoretical machine
693 // 1190 safe for most fast 386 machines
694 // 1000 for fastest machine tested here
695 // 540 (sic) for AT286/6Mhz
696static void
697ii2DelayIO(unsigned int mseconds)
698{
699 if (!ii2Safe)
700 return; /* Do nothing if this variable uninitialized */
701
702 while(mseconds--) {
703 int i = ii2DelValue;
704 while ( i-- ) {
705 INB ( ii2Safe );
706 }
707 }
708}
709#endif
710
711//******************************************************************************
712// Function: ii2Nop()
713// Parameters: None
714//
715// Returns: Nothing
716//
717// Description:
718//
719// iiInitialize will set i2eDelay to this if the delay parameter is NULL. This
720// saves checking for a NULL pointer at every call.
721//******************************************************************************
722static void
723ii2Nop(void)
724{
725 return; // no mystery here
726}
727
728//=======================================================
729// Routines which are available in 8/16-bit versions, or
730// in different fifo styles. These are ALL called
731// indirectly through the board structure.
732//=======================================================
733
734//******************************************************************************
735// Function: iiWriteBuf16(pB, address, count)
736// Parameters: pB - pointer to board structure
737// address - address of data to write
738// count - number of data bytes to write
739//
740// Returns: True if everything appears copacetic.
741// False if there is any error: the pB->i2eError field has the error
742//
743// Description:
744//
745// Writes 'count' bytes from 'address' to the data fifo specified by the board
746// structure pointer pB. Should count happen to be odd, an extra pad byte is
747// sent (identity unknown...). Uses 16-bit (word) operations. Is called
748// indirectly through pB->i2eWriteBuf.
749//
750//******************************************************************************
751static int
752iiWriteBuf16(i2eBordStrPtr pB, unsigned char *address, int count)
753{
754 // Rudimentary sanity checking here.
755 if (pB->i2eValid != I2E_MAGIC)
756 COMPLETE(pB, I2EE_INVALID);
757
758 OUTSW ( pB->i2eData, address, count);
759
760 COMPLETE(pB, I2EE_GOOD);
761}
762
763//******************************************************************************
764// Function: iiWriteBuf8(pB, address, count)
765// Parameters: pB - pointer to board structure
766// address - address of data to write
767// count - number of data bytes to write
768//
769// Returns: True if everything appears copacetic.
770// False if there is any error: the pB->i2eError field has the error
771//
772// Description:
773//
774// Writes 'count' bytes from 'address' to the data fifo specified by the board
775// structure pointer pB. Should count happen to be odd, an extra pad byte is
776// sent (identity unknown...). This is to be consistent with the 16-bit version.
777// Uses 8-bit (byte) operations. Is called indirectly through pB->i2eWriteBuf.
778//
779//******************************************************************************
780static int
781iiWriteBuf8(i2eBordStrPtr pB, unsigned char *address, int count)
782{
783 /* Rudimentary sanity checking here */
784 if (pB->i2eValid != I2E_MAGIC)
785 COMPLETE(pB, I2EE_INVALID);
786
787 OUTSB ( pB->i2eData, address, count );
788
789 COMPLETE(pB, I2EE_GOOD);
790}
791
792//******************************************************************************
793// Function: iiReadBuf16(pB, address, count)
794// Parameters: pB - pointer to board structure
795// address - address to put data read
796// count - number of data bytes to read
797//
798// Returns: True if everything appears copacetic.
799// False if there is any error: the pB->i2eError field has the error
800//
801// Description:
802//
803// Reads 'count' bytes into 'address' from the data fifo specified by the board
804// structure pointer pB. Should count happen to be odd, an extra pad byte is
805// received (identity unknown...). Uses 16-bit (word) operations. Is called
806// indirectly through pB->i2eReadBuf.
807//
808//******************************************************************************
809static int
810iiReadBuf16(i2eBordStrPtr pB, unsigned char *address, int count)
811{
812 // Rudimentary sanity checking here.
813 if (pB->i2eValid != I2E_MAGIC)
814 COMPLETE(pB, I2EE_INVALID);
815
816 INSW ( pB->i2eData, address, count);
817
818 COMPLETE(pB, I2EE_GOOD);
819}
820
821//******************************************************************************
822// Function: iiReadBuf8(pB, address, count)
823// Parameters: pB - pointer to board structure
824// address - address to put data read
825// count - number of data bytes to read
826//
827// Returns: True if everything appears copacetic.
828// False if there is any error: the pB->i2eError field has the error
829//
830// Description:
831//
832// Reads 'count' bytes into 'address' from the data fifo specified by the board
833// structure pointer pB. Should count happen to be odd, an extra pad byte is
834// received (identity unknown...). This to match the 16-bit behaviour. Uses
835// 8-bit (byte) operations. Is called indirectly through pB->i2eReadBuf.
836//
837//******************************************************************************
838static int
839iiReadBuf8(i2eBordStrPtr pB, unsigned char *address, int count)
840{
841 // Rudimentary sanity checking here.
842 if (pB->i2eValid != I2E_MAGIC)
843 COMPLETE(pB, I2EE_INVALID);
844
845 INSB ( pB->i2eData, address, count);
846
847 COMPLETE(pB, I2EE_GOOD);
848}
849
850//******************************************************************************
851// Function: iiReadWord16(pB)
852// Parameters: pB - pointer to board structure
853//
854// Returns: True if everything appears copacetic.
855// False if there is any error: the pB->i2eError field has the error
856//
857// Description:
858//
859// Returns the word read from the data fifo specified by the board-structure
860// pointer pB. Uses a 16-bit operation. Is called indirectly through
861// pB->i2eReadWord.
862//
863//******************************************************************************
864static unsigned short
865iiReadWord16(i2eBordStrPtr pB)
866{
867 return (unsigned short)( INW(pB->i2eData) );
868}
869
870//******************************************************************************
871// Function: iiReadWord8(pB)
872// Parameters: pB - pointer to board structure
873//
874// Returns: True if everything appears copacetic.
875// False if there is any error: the pB->i2eError field has the error
876//
877// Description:
878//
879// Returns the word read from the data fifo specified by the board-structure
880// pointer pB. Uses two 8-bit operations. Bytes are assumed to be LSB first. Is
881// called indirectly through pB->i2eReadWord.
882//
883//******************************************************************************
884static unsigned short
885iiReadWord8(i2eBordStrPtr pB)
886{
887 unsigned short urs;
888
889 urs = INB ( pB->i2eData );
890
891 return ( ( INB ( pB->i2eData ) << 8 ) | urs );
892}
893
894//******************************************************************************
895// Function: iiWriteWord16(pB, value)
896// Parameters: pB - pointer to board structure
897// value - data to write
898//
899// Returns: True if everything appears copacetic.
900// False if there is any error: the pB->i2eError field has the error
901//
902// Description:
903//
904// Writes the word 'value' to the data fifo specified by the board-structure
905// pointer pB. Uses 16-bit operation. Is called indirectly through
906// pB->i2eWriteWord.
907//
908//******************************************************************************
909static void
910iiWriteWord16(i2eBordStrPtr pB, unsigned short value)
911{
912 WORD_TO(pB, (int)value);
913}
914
915//******************************************************************************
916// Function: iiWriteWord8(pB, value)
917// Parameters: pB - pointer to board structure
918// value - data to write
919//
920// Returns: True if everything appears copacetic.
921// False if there is any error: the pB->i2eError field has the error
922//
923// Description:
924//
925// Writes the word 'value' to the data fifo specified by the board-structure
926// pointer pB. Uses two 8-bit operations (writes LSB first). Is called
927// indirectly through pB->i2eWriteWord.
928//
929//******************************************************************************
930static void
931iiWriteWord8(i2eBordStrPtr pB, unsigned short value)
932{
933 BYTE_TO(pB, (char)value);
934 BYTE_TO(pB, (char)(value >> 8) );
935}
936
937//******************************************************************************
938// Function: iiWaitForTxEmptyII(pB, mSdelay)
939// Parameters: pB - pointer to board structure
940// mSdelay - period to wait before returning
941//
942// Returns: True if the FIFO is empty.
943// False if it not empty in the required time: the pB->i2eError
944// field has the error.
945//
946// Description:
947//
948// Waits up to "mSdelay" milliseconds for the outgoing FIFO to become empty; if
949// not empty by the required time, returns false and error in pB->i2eError,
950// otherwise returns true.
951//
952// mSdelay == 0 is taken to mean must be empty on the first test.
953//
954// This version operates on IntelliPort-II - style FIFO's
955//
956// Note this routine is organized so that if status is ok there is no delay at
957// all called either before or after the test. Is called indirectly through
958// pB->i2eWaitForTxEmpty.
959//
960//******************************************************************************
961static int
962iiWaitForTxEmptyII(i2eBordStrPtr pB, int mSdelay)
963{
964 unsigned long flags;
965 int itemp;
966
967 for (;;)
968 {
969 // This routine hinges on being able to see the "other" status register
970 // (as seen by the local processor). His incoming fifo is our outgoing
971 // FIFO.
972 //
973 // By the nature of this routine, you would be using this as part of a
974 // larger atomic context: i.e., you would use this routine to ensure the
975 // fifo empty, then act on this information. Between these two halves,
976 // you will generally not want to service interrupts or in any way
977 // disrupt the assumptions implicit in the larger context.
978 //
979 // Even worse, however, this routine "shifts" the status register to
980 // point to the local status register which is not the usual situation.
981 // Therefore for extra safety, we force the critical section to be
982 // completely atomic, and pick up after ourselves before allowing any
983 // interrupts of any kind.
984
985
986 WRITE_LOCK_IRQSAVE(&Dl_spinlock,flags)
987 OUTB(pB->i2ePointer, SEL_COMMAND);
988 OUTB(pB->i2ePointer, SEL_CMD_SH);
989
990 itemp = INB(pB->i2eStatus);
991
992 OUTB(pB->i2ePointer, SEL_COMMAND);
993 OUTB(pB->i2ePointer, SEL_CMD_UNSH);
994
995 if (itemp & ST_IN_EMPTY)
996 {
997 UPDATE_FIFO_ROOM(pB);
998 WRITE_UNLOCK_IRQRESTORE(&Dl_spinlock,flags)
999 COMPLETE(pB, I2EE_GOOD);
1000 }
1001
1002 WRITE_UNLOCK_IRQRESTORE(&Dl_spinlock,flags)
1003
1004 if (mSdelay-- == 0)
1005 break;
1006
1007 iiDelay(pB, 1); /* 1 mS granularity on checking condition */
1008 }
1009 COMPLETE(pB, I2EE_TXE_TIME);
1010}
1011
1012//******************************************************************************
1013// Function: iiWaitForTxEmptyIIEX(pB, mSdelay)
1014// Parameters: pB - pointer to board structure
1015// mSdelay - period to wait before returning
1016//
1017// Returns: True if the FIFO is empty.
1018// False if it not empty in the required time: the pB->i2eError
1019// field has the error.
1020//
1021// Description:
1022//
1023// Waits up to "mSdelay" milliseconds for the outgoing FIFO to become empty; if
1024// not empty by the required time, returns false and error in pB->i2eError,
1025// otherwise returns true.
1026//
1027// mSdelay == 0 is taken to mean must be empty on the first test.
1028//
1029// This version operates on IntelliPort-IIEX - style FIFO's
1030//
1031// Note this routine is organized so that if status is ok there is no delay at
1032// all called either before or after the test. Is called indirectly through
1033// pB->i2eWaitForTxEmpty.
1034//
1035//******************************************************************************
1036static int
1037iiWaitForTxEmptyIIEX(i2eBordStrPtr pB, int mSdelay)
1038{
1039 unsigned long flags;
1040
1041 for (;;)
1042 {
1043 // By the nature of this routine, you would be using this as part of a
1044 // larger atomic context: i.e., you would use this routine to ensure the
1045 // fifo empty, then act on this information. Between these two halves,
1046 // you will generally not want to service interrupts or in any way
1047 // disrupt the assumptions implicit in the larger context.
1048
1049 WRITE_LOCK_IRQSAVE(&Dl_spinlock,flags)
1050
1051 if (INB(pB->i2eStatus) & STE_OUT_MT) {
1052 UPDATE_FIFO_ROOM(pB);
1053 WRITE_UNLOCK_IRQRESTORE(&Dl_spinlock,flags)
1054 COMPLETE(pB, I2EE_GOOD);
1055 }
1056 WRITE_UNLOCK_IRQRESTORE(&Dl_spinlock,flags)
1057
1058 if (mSdelay-- == 0)
1059 break;
1060
1061 iiDelay(pB, 1); // 1 mS granularity on checking condition
1062 }
1063 COMPLETE(pB, I2EE_TXE_TIME);
1064}
1065
1066//******************************************************************************
1067// Function: iiTxMailEmptyII(pB)
1068// Parameters: pB - pointer to board structure
1069//
1070// Returns: True if the transmit mailbox is empty.
1071// False if it not empty.
1072//
1073// Description:
1074//
1075// Returns true or false according to whether the transmit mailbox is empty (and
1076// therefore able to accept more mail)
1077//
1078// This version operates on IntelliPort-II - style FIFO's
1079//
1080//******************************************************************************
1081static int
1082iiTxMailEmptyII(i2eBordStrPtr pB)
1083{
1084 int port = pB->i2ePointer;
1085 OUTB ( port, SEL_OUTMAIL );
1086 return ( INB(port) == 0 );
1087}
1088
1089//******************************************************************************
1090// Function: iiTxMailEmptyIIEX(pB)
1091// Parameters: pB - pointer to board structure
1092//
1093// Returns: True if the transmit mailbox is empty.
1094// False if it not empty.
1095//
1096// Description:
1097//
1098// Returns true or false according to whether the transmit mailbox is empty (and
1099// therefore able to accept more mail)
1100//
1101// This version operates on IntelliPort-IIEX - style FIFO's
1102//
1103//******************************************************************************
1104static int
1105iiTxMailEmptyIIEX(i2eBordStrPtr pB)
1106{
1107 return !(INB(pB->i2eStatus) & STE_OUT_MAIL);
1108}
1109
1110//******************************************************************************
1111// Function: iiTrySendMailII(pB,mail)
1112// Parameters: pB - pointer to board structure
1113// mail - value to write to mailbox
1114//
1115// Returns: True if the transmit mailbox is empty, and mail is sent.
1116// False if it not empty.
1117//
1118// Description:
1119//
1120// If outgoing mailbox is empty, sends mail and returns true. If outgoing
1121// mailbox is not empty, returns false.
1122//
1123// This version operates on IntelliPort-II - style FIFO's
1124//
1125//******************************************************************************
1126static int
1127iiTrySendMailII(i2eBordStrPtr pB, unsigned char mail)
1128{
1129 int port = pB->i2ePointer;
1130
1131 OUTB(port, SEL_OUTMAIL);
1132 if (INB(port) == 0) {
1133 OUTB(port, SEL_OUTMAIL);
1134 OUTB(port, mail);
1135 return 1;
1136 }
1137 return 0;
1138}
1139
1140//******************************************************************************
1141// Function: iiTrySendMailIIEX(pB,mail)
1142// Parameters: pB - pointer to board structure
1143// mail - value to write to mailbox
1144//
1145// Returns: True if the transmit mailbox is empty, and mail is sent.
1146// False if it not empty.
1147//
1148// Description:
1149//
1150// If outgoing mailbox is empty, sends mail and returns true. If outgoing
1151// mailbox is not empty, returns false.
1152//
1153// This version operates on IntelliPort-IIEX - style FIFO's
1154//
1155//******************************************************************************
1156static int
1157iiTrySendMailIIEX(i2eBordStrPtr pB, unsigned char mail)
1158{
1159 if(INB(pB->i2eStatus) & STE_OUT_MAIL) {
1160 return 0;
1161 }
1162 OUTB(pB->i2eXMail, mail);
1163 return 1;
1164}
1165
1166//******************************************************************************
1167// Function: iiGetMailII(pB,mail)
1168// Parameters: pB - pointer to board structure
1169//
1170// Returns: Mailbox data or NO_MAIL_HERE.
1171//
1172// Description:
1173//
1174// If no mail available, returns NO_MAIL_HERE otherwise returns the data from
1175// the mailbox, which is guaranteed != NO_MAIL_HERE.
1176//
1177// This version operates on IntelliPort-II - style FIFO's
1178//
1179//******************************************************************************
1180static unsigned short
1181iiGetMailII(i2eBordStrPtr pB)
1182{
1183 if (HAS_MAIL(pB)) {
1184 OUTB(pB->i2ePointer, SEL_INMAIL);
1185 return INB(pB->i2ePointer);
1186 } else {
1187 return NO_MAIL_HERE;
1188 }
1189}
1190
1191//******************************************************************************
1192// Function: iiGetMailIIEX(pB,mail)
1193// Parameters: pB - pointer to board structure
1194//
1195// Returns: Mailbox data or NO_MAIL_HERE.
1196//
1197// Description:
1198//
1199// If no mail available, returns NO_MAIL_HERE otherwise returns the data from
1200// the mailbox, which is guaranteed != NO_MAIL_HERE.
1201//
1202// This version operates on IntelliPort-IIEX - style FIFO's
1203//
1204//******************************************************************************
1205static unsigned short
1206iiGetMailIIEX(i2eBordStrPtr pB)
1207{
1208 if (HAS_MAIL(pB)) {
1209 return INB(pB->i2eXMail);
1210 } else {
1211 return NO_MAIL_HERE;
1212 }
1213}
1214
1215//******************************************************************************
1216// Function: iiEnableMailIrqII(pB)
1217// Parameters: pB - pointer to board structure
1218//
1219// Returns: Nothing
1220//
1221// Description:
1222//
1223// Enables board to interrupt host (only) by writing to host's in-bound mailbox.
1224//
1225// This version operates on IntelliPort-II - style FIFO's
1226//
1227//******************************************************************************
1228static void
1229iiEnableMailIrqII(i2eBordStrPtr pB)
1230{
1231 OUTB(pB->i2ePointer, SEL_MASK);
1232 OUTB(pB->i2ePointer, ST_IN_MAIL);
1233}
1234
1235//******************************************************************************
1236// Function: iiEnableMailIrqIIEX(pB)
1237// Parameters: pB - pointer to board structure
1238//
1239// Returns: Nothing
1240//
1241// Description:
1242//
1243// Enables board to interrupt host (only) by writing to host's in-bound mailbox.
1244//
1245// This version operates on IntelliPort-IIEX - style FIFO's
1246//
1247//******************************************************************************
1248static void
1249iiEnableMailIrqIIEX(i2eBordStrPtr pB)
1250{
1251 OUTB(pB->i2eXMask, MX_IN_MAIL);
1252}
1253
1254//******************************************************************************
1255// Function: iiWriteMaskII(pB)
1256// Parameters: pB - pointer to board structure
1257//
1258// Returns: Nothing
1259//
1260// Description:
1261//
1262// Writes arbitrary value to the mask register.
1263//
1264// This version operates on IntelliPort-II - style FIFO's
1265//
1266//******************************************************************************
1267static void
1268iiWriteMaskII(i2eBordStrPtr pB, unsigned char value)
1269{
1270 OUTB(pB->i2ePointer, SEL_MASK);
1271 OUTB(pB->i2ePointer, value);
1272}
1273
1274//******************************************************************************
1275// Function: iiWriteMaskIIEX(pB)
1276// Parameters: pB - pointer to board structure
1277//
1278// Returns: Nothing
1279//
1280// Description:
1281//
1282// Writes arbitrary value to the mask register.
1283//
1284// This version operates on IntelliPort-IIEX - style FIFO's
1285//
1286//******************************************************************************
1287static void
1288iiWriteMaskIIEX(i2eBordStrPtr pB, unsigned char value)
1289{
1290 OUTB(pB->i2eXMask, value);
1291}
1292
1293//******************************************************************************
1294// Function: iiDownloadBlock(pB, pSource, isStandard)
1295// Parameters: pB - pointer to board structure
1296// pSource - loadware block to download
1297// isStandard - True if "standard" loadware, else false.
1298//
1299// Returns: Success or Failure
1300//
1301// Description:
1302//
1303// Downloads a single block (at pSource)to the board referenced by pB. Caller
1304// sets isStandard to true/false according to whether the "standard" loadware is
1305// what's being loaded. The normal process, then, is to perform an iiInitialize
1306// to the board, then perform some number of iiDownloadBlocks using the returned
1307// state to determine when download is complete.
1308//
1309// Possible return values: (see I2ELLIS.H)
1310// II_DOWN_BADVALID
1311// II_DOWN_BADFILE
1312// II_DOWN_CONTINUING
1313// II_DOWN_GOOD
1314// II_DOWN_BAD
1315// II_DOWN_BADSTATE
1316// II_DOWN_TIMEOUT
1317//
1318// Uses the i2eState and i2eToLoad fields (initialized at iiInitialize) to
1319// determine whether this is the first block, whether to check for magic
1320// numbers, how many blocks there are to go...
1321//
1322//******************************************************************************
1323static int
1324iiDownloadBlock ( i2eBordStrPtr pB, loadHdrStrPtr pSource, int isStandard)
1325{
1326 int itemp;
1327 int loadedFirst;
1328
1329 if (pB->i2eValid != I2E_MAGIC) return II_DOWN_BADVALID;
1330
1331 switch(pB->i2eState)
1332 {
1333 case II_STATE_READY:
1334
1335 // Loading the first block after reset. Must check the magic number of the
1336 // loadfile, store the number of blocks we expect to load.
1337 if (pSource->e.loadMagic != MAGIC_LOADFILE)
1338 {
1339 return II_DOWN_BADFILE;
1340 }
1341
1342 // Next we store the total number of blocks to load, including this one.
1343 pB->i2eToLoad = 1 + pSource->e.loadBlocksMore;
1344
1345 // Set the state, store the version numbers. ('Cause this may have come
1346 // from a file - we might want to report these versions and revisions in
1347 // case of an error!
1348 pB->i2eState = II_STATE_LOADING;
1349 pB->i2eLVersion = pSource->e.loadVersion;
1350 pB->i2eLRevision = pSource->e.loadRevision;
1351 pB->i2eLSub = pSource->e.loadSubRevision;
1352
1353 // The time and date of compilation is also available but don't bother
1354 // storing it for normal purposes.
1355 loadedFirst = 1;
1356 break;
1357
1358 case II_STATE_LOADING:
1359 loadedFirst = 0;
1360 break;
1361
1362 default:
1363 return II_DOWN_BADSTATE;
1364 }
1365
1366 // Now we must be in the II_STATE_LOADING state, and we assume i2eToLoad
1367 // must be positive still, because otherwise we would have cleaned up last
1368 // time and set the state to II_STATE_LOADED.
1369 if (!iiWaitForTxEmpty(pB, MAX_DLOAD_READ_TIME)) {
1370 return II_DOWN_TIMEOUT;
1371 }
1372
1373 if (!iiWriteBuf(pB, pSource->c, LOADWARE_BLOCK_SIZE)) {
1374 return II_DOWN_BADVALID;
1375 }
1376
1377 // If we just loaded the first block, wait for the fifo to empty an extra
1378 // long time to allow for any special startup code in the firmware, like
1379 // sending status messages to the LCD's.
1380
1381 if (loadedFirst) {
1382 if (!iiWaitForTxEmpty(pB, MAX_DLOAD_START_TIME)) {
1383 return II_DOWN_TIMEOUT;
1384 }
1385 }
1386
1387 // Determine whether this was our last block!
1388 if (--(pB->i2eToLoad)) {
1389 return II_DOWN_CONTINUING; // more to come...
1390 }
1391
1392 // It WAS our last block: Clean up operations...
1393 // ...Wait for last buffer to drain from the board...
1394 if (!iiWaitForTxEmpty(pB, MAX_DLOAD_READ_TIME)) {
1395 return II_DOWN_TIMEOUT;
1396 }
1397 // If there were only a single block written, this would come back
1398 // immediately and be harmless, though not strictly necessary.
1399 itemp = MAX_DLOAD_ACK_TIME/10;
1400 while (--itemp) {
1401 if (HAS_INPUT(pB)) {
1402 switch(BYTE_FROM(pB))
1403 {
1404 case LOADWARE_OK:
1405 pB->i2eState =
1406 isStandard ? II_STATE_STDLOADED :II_STATE_LOADED;
1407
1408 // Some revisions of the bootstrap firmware (e.g. ISA-8 1.0.2)
1409 // will, // if there is a debug port attached, require some
1410 // time to send information to the debug port now. It will do
1411 // this before // executing any of the code we just downloaded.
1412 // It may take up to 700 milliseconds.
1413 if (pB->i2ePom.e.porDiag2 & POR_DEBUG_PORT) {
1414 iiDelay(pB, 700);
1415 }
1416
1417 return II_DOWN_GOOD;
1418
1419 case LOADWARE_BAD:
1420 default:
1421 return II_DOWN_BAD;
1422 }
1423 }
1424
1425 iiDelay(pB, 10); // 10 mS granularity on checking condition
1426 }
1427
1428 // Drop-through --> timed out waiting for firmware confirmation
1429
1430 pB->i2eState = II_STATE_BADLOAD;
1431 return II_DOWN_TIMEOUT;
1432}
1433
1434//******************************************************************************
1435// Function: iiDownloadAll(pB, pSource, isStandard, size)
1436// Parameters: pB - pointer to board structure
1437// pSource - loadware block to download
1438// isStandard - True if "standard" loadware, else false.
1439// size - size of data to download (in bytes)
1440//
1441// Returns: Success or Failure
1442//
1443// Description:
1444//
1445// Given a pointer to a board structure, a pointer to the beginning of some
1446// loadware, whether it is considered the "standard loadware", and the size of
1447// the array in bytes loads the entire array to the board as loadware.
1448//
1449// Assumes the board has been freshly reset and the power-up reset message read.
1450// (i.e., in II_STATE_READY). Complains if state is bad, or if there seems to be
1451// too much or too little data to load, or if iiDownloadBlock complains.
1452//******************************************************************************
1453static int
1454iiDownloadAll(i2eBordStrPtr pB, loadHdrStrPtr pSource, int isStandard, int size)
1455{
1456 int status;
1457
1458 // We know (from context) board should be ready for the first block of
1459 // download. Complain if not.
1460 if (pB->i2eState != II_STATE_READY) return II_DOWN_BADSTATE;
1461
1462 while (size > 0) {
1463 size -= LOADWARE_BLOCK_SIZE; // How much data should there be left to
1464 // load after the following operation ?
1465
1466 // Note we just bump pSource by "one", because its size is actually that
1467 // of an entire block, same as LOADWARE_BLOCK_SIZE.
1468 status = iiDownloadBlock(pB, pSource++, isStandard);
1469
1470 switch(status)
1471 {
1472 case II_DOWN_GOOD:
1473 return ( (size > 0) ? II_DOWN_OVER : II_DOWN_GOOD);
1474
1475 case II_DOWN_CONTINUING:
1476 break;
1477
1478 default:
1479 return status;
1480 }
1481 }
1482
1483 // We shouldn't drop out: it means "while" caught us with nothing left to
1484 // download, yet the previous DownloadBlock did not return complete. Ergo,
1485 // not enough data to match the size byte in the header.
1486 return II_DOWN_UNDER;
1487}