2 ** -----------------------------------------------------------------------------
4 ** Perle Specialix driver for Linux
5 ** Ported from existing RIO Driver for SCO sources.
7 * (C) 1990 - 2000 Specialix International Ltd., Byfleet, Surrey, UK.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
25 ** Last Modified : 11/6/98 10:33:44
26 ** Retrieved : 11/6/98 10:33:49
28 ** ident @(#)riointr.c 1.2
30 ** -----------------------------------------------------------------------------
33 static char *_riointr_c_sccs_ = "@(#)riointr.c 1.2";
37 #include <linux/module.h>
38 #include <linux/slab.h>
39 #include <linux/errno.h>
40 #include <linux/tty.h>
41 #include <linux/tty_flip.h>
43 #include <asm/system.h>
44 #include <asm/string.h>
45 #include <asm/semaphore.h>
46 #include <asm/uaccess.h>
48 #include <linux/termios.h>
49 #include <linux/serial.h>
51 #include <linux/generic_serial.h>
53 #include <linux/delay.h>
55 #include "linux_compat.h"
56 #include "rio_linux.h"
83 static void RIOReceive(struct rio_info *, struct Port *);
86 static char *firstchars(char *p, int nch)
88 static char buf[2][128];
91 memcpy(buf[t], p, nch);
97 #define INCR( P, I ) ((P) = (((P)+(I)) & p->RIOBufferMask))
98 /* Enable and start the transmission of packets */
99 void RIOTxEnable(char *en)
103 struct tty_struct *tty;
105 struct PKT __iomem *PacketP;
108 PortP = (struct Port *) en;
109 p = (struct rio_info *) PortP->p;
113 rio_dprintk(RIO_DEBUG_INTR, "tx port %d: %d chars queued.\n", PortP->PortNum, PortP->gs.xmit_cnt);
115 if (!PortP->gs.xmit_cnt)
119 /* This routine is an order of magnitude simpler than the specialix
120 version. One of the disadvantages is that this version will send
121 an incomplete packet (usually 64 bytes instead of 72) once for
122 every 4k worth of data. Let's just say that this won't influence
123 performance significantly..... */
125 rio_spin_lock_irqsave(&PortP->portSem, flags);
127 while (can_add_transmit(&PacketP, PortP)) {
128 c = PortP->gs.xmit_cnt;
129 if (c > PKT_MAX_DATA_LEN)
130 c = PKT_MAX_DATA_LEN;
132 /* Don't copy past the end of the source buffer */
133 if (c > SERIAL_XMIT_SIZE - PortP->gs.xmit_tail)
134 c = SERIAL_XMIT_SIZE - PortP->gs.xmit_tail;
138 t = (c > 10) ? 10 : c;
140 rio_dprintk(RIO_DEBUG_INTR, "rio: tx port %d: copying %d chars: %s - %s\n", PortP->PortNum, c, firstchars(PortP->gs.xmit_buf + PortP->gs.xmit_tail, t), firstchars(PortP->gs.xmit_buf + PortP->gs.xmit_tail + c - t, t));
142 /* If for one reason or another, we can't copy more data,
147 rio_memcpy_toio(PortP->HostP->Caddr, PacketP->data, PortP->gs.xmit_buf + PortP->gs.xmit_tail, c);
150 writeb(c, &(PacketP->len));
151 if (!(PortP->State & RIO_DELETED)) {
154 ** Count chars tx'd for port statistics reporting
156 if (PortP->statsGather)
159 PortP->gs.xmit_tail = (PortP->gs.xmit_tail + c) & (SERIAL_XMIT_SIZE - 1);
160 PortP->gs.xmit_cnt -= c;
163 rio_spin_unlock_irqrestore(&PortP->portSem, flags);
165 if (PortP->gs.xmit_cnt <= (PortP->gs.wakeup_chars + 2 * PKT_MAX_DATA_LEN))
166 tty_wakeup(PortP->gs.tty);
172 ** RIO Host Service routine. Does all the work traditionally associated with an
179 void RIOServiceHost(struct rio_info *p, struct Host *HostP)
181 rio_spin_lock(&HostP->HostLock);
182 if ((HostP->Flags & RUN_STATE) != RC_RUNNING) {
184 rio_spin_unlock(&HostP->HostLock);
185 if ((t++ % 200) == 0)
186 rio_dprintk(RIO_DEBUG_INTR, "Interrupt but host not running. flags=%x.\n", (int) HostP->Flags);
189 rio_spin_unlock(&HostP->HostLock);
191 if (readw(&HostP->ParmMapP->rup_intr)) {
192 writew(0, &HostP->ParmMapP->rup_intr);
195 rio_dprintk(RIO_DEBUG_INTR, "rio: RUP interrupt on host %Zd\n", HostP - p->RIOHosts);
196 RIOPollHostCommands(p, HostP);
199 if (readw(&HostP->ParmMapP->rx_intr)) {
202 writew(0, &HostP->ParmMapP->rx_intr);
206 rio_dprintk(RIO_DEBUG_INTR, "rio: RX interrupt on host %Zd\n", HostP - p->RIOHosts);
208 ** Loop through every port. If the port is mapped into
209 ** the system ( i.e. has /dev/ttyXXXX associated ) then it is
210 ** worth checking. If the port isn't open, grab any packets
211 ** hanging on its receive queue and stuff them on the free
212 ** list; check for commands on the way.
214 for (port = p->RIOFirstPortsBooted; port < p->RIOLastPortsBooted + PORTS_PER_RTA; port++) {
215 struct Port *PortP = p->RIOPortp[port];
216 struct tty_struct *ttyP;
217 struct PKT __iomem *PacketP;
220 ** not mapped in - most of the RIOPortp[] information
221 ** has not been set up!
222 ** Optimise: ports come in bundles of eight.
224 if (!PortP->Mapped) {
226 continue; /* with the next port */
230 ** If the host board isn't THIS host board, check the next one.
231 ** optimise: ports come in bundles of eight.
233 if (PortP->HostP != HostP) {
239 ** Let us see - is the port open? If not, then don't service it.
241 if (!(PortP->PortState & PORT_ISOPEN)) {
246 ** find corresponding tty structure. The process of mapping
247 ** the ports puts these here.
249 ttyP = PortP->gs.tty;
252 ** Lock the port before we begin working on it.
254 rio_spin_lock(&PortP->portSem);
257 ** Process received data if there is any.
259 if (can_remove_receive(&PacketP, PortP))
260 RIOReceive(p, PortP);
263 ** If there is no data left to be read from the port, and
264 ** it's handshake bit is set, then we must clear the handshake,
265 ** so that that downstream RTA is re-enabled.
267 if (!can_remove_receive(&PacketP, PortP) && (readw(&PortP->PhbP->handshake) == PHB_HANDSHAKE_SET)) {
269 ** MAGIC! ( Basically, handshake the RX buffer, so that
270 ** the RTAs upstream can be re-enabled. )
272 rio_dprintk(RIO_DEBUG_INTR, "Set RX handshake bit\n");
273 writew(PHB_HANDSHAKE_SET | PHB_HANDSHAKE_RESET, &PortP->PhbP->handshake);
275 rio_spin_unlock(&PortP->portSem);
279 if (readw(&HostP->ParmMapP->tx_intr)) {
282 writew(0, &HostP->ParmMapP->tx_intr);
286 rio_dprintk(RIO_DEBUG_INTR, "rio: TX interrupt on host %Zd\n", HostP - p->RIOHosts);
289 ** Loop through every port.
290 ** If the port is mapped into the system ( i.e. has /dev/ttyXXXX
291 ** associated ) then it is worth checking.
293 for (port = p->RIOFirstPortsBooted; port < p->RIOLastPortsBooted + PORTS_PER_RTA; port++) {
294 struct Port *PortP = p->RIOPortp[port];
295 struct tty_struct *ttyP;
296 struct PKT __iomem *PacketP;
299 ** not mapped in - most of the RIOPortp[] information
300 ** has not been set up!
302 if (!PortP->Mapped) {
304 continue; /* with the next port */
308 ** If the host board isn't running, then its data structures
309 ** are no use to us - continue quietly.
311 if (PortP->HostP != HostP) {
313 continue; /* with the next port */
317 ** Let us see - is the port open? If not, then don't service it.
319 if (!(PortP->PortState & PORT_ISOPEN)) {
323 rio_dprintk(RIO_DEBUG_INTR, "rio: Looking into port %d.\n", port);
325 ** Lock the port before we begin working on it.
327 rio_spin_lock(&PortP->portSem);
330 ** If we can't add anything to the transmit queue, then
331 ** we need do none of this processing.
333 if (!can_add_transmit(&PacketP, PortP)) {
334 rio_dprintk(RIO_DEBUG_INTR, "Can't add to port, so skipping.\n");
335 rio_spin_unlock(&PortP->portSem);
340 ** find corresponding tty structure. The process of mapping
341 ** the ports puts these here.
343 ttyP = PortP->gs.tty;
344 /* If ttyP is NULL, the port is getting closed. Forget about it. */
346 rio_dprintk(RIO_DEBUG_INTR, "no tty, so skipping.\n");
347 rio_spin_unlock(&PortP->portSem);
351 ** If there is more room available we start up the transmit
352 ** data process again. This can be direct I/O, if the cookmode
353 ** is set to COOK_RAW or COOK_MEDIUM, or will be a call to the
354 ** riotproc( T_OUTPUT ) if we are in COOK_WELL mode, to fetch
355 ** characters via the line discipline. We must always call
356 ** the line discipline,
357 ** so that user input characters can be echoed correctly.
360 ** With the advent of double buffering, we now see if
361 ** TxBufferOut-In is non-zero. If so, then we copy a packet
362 ** to the output place, and set it going. If this empties
363 ** the buffer, then we must issue a wakeup( ) on OUT.
364 ** If it frees space in the buffer then we must issue
365 ** a wakeup( ) on IN.
367 ** ++++ Extra! Extra! If PortP->WflushFlag is set, then we
368 ** have to send a WFLUSH command down the PHB, to mark the
369 ** end point of a WFLUSH. We also need to clear out any
370 ** data from the double buffer! ( note that WflushFlag is a
371 ** *count* of the number of WFLUSH commands outstanding! )
373 ** ++++ And there's more!
374 ** If an RTA is powered off, then on again, and rebooted,
375 ** whilst it has ports open, then we need to re-open the ports.
376 ** ( reasonable enough ). We can't do this when we spot the
377 ** re-boot, in interrupt time, because the queue is probably
378 ** full. So, when we come in here, we need to test if any
379 ** ports are in this condition, and re-open the port before
380 ** we try to send any more data to it. Now, the re-booted
381 ** RTA will be discarding packets from the PHB until it
382 ** receives this open packet, but don't worry tooo much
383 ** about that. The one thing that is interesting is the
384 ** combination of this effect and the WFLUSH effect!
386 /* For now don't handle RTA reboots. -- REW.
387 Reenabled. Otherwise RTA reboots didn't work. Duh. -- REW */
388 if (PortP->MagicFlags) {
389 if (PortP->MagicFlags & MAGIC_REBOOT) {
391 ** well, the RTA has been rebooted, and there is room
392 ** on its queue to add the open packet that is required.
394 ** The messy part of this line is trying to decide if
395 ** we need to call the Param function as a tty or as
397 ** DONT USE CLOCAL AS A TEST FOR THIS!
399 ** If we can't param the port, then move on to the
402 PortP->InUse = NOT_INUSE;
404 rio_spin_unlock(&PortP->portSem);
405 if (RIOParam(PortP, OPEN, ((PortP->Cor2Copy & (COR2_RTSFLOW | COR2_CTSFLOW)) == (COR2_RTSFLOW | COR2_CTSFLOW)) ? 1 : 0, DONT_SLEEP) == RIO_FAIL) {
406 continue; /* with next port */
408 rio_spin_lock(&PortP->portSem);
409 PortP->MagicFlags &= ~MAGIC_REBOOT;
413 ** As mentioned above, this is a tacky hack to cope
416 if (PortP->WflushFlag) {
417 rio_dprintk(RIO_DEBUG_INTR, "Want to WFLUSH mark this port\n");
420 rio_dprintk(RIO_DEBUG_INTR, "FAILS - PORT IS IN USE\n");
423 while (PortP->WflushFlag && can_add_transmit(&PacketP, PortP) && (PortP->InUse == NOT_INUSE)) {
425 struct PktCmd __iomem *PktCmdP;
427 rio_dprintk(RIO_DEBUG_INTR, "Add WFLUSH marker to data queue\n");
429 ** make it look just like a WFLUSH command
431 PktCmdP = (struct PktCmd __iomem *) &PacketP->data[0];
433 writeb(WFLUSH, &PktCmdP->Command);
435 p = PortP->HostPort % (u16) PORTS_PER_RTA;
438 ** If second block of ports for 16 port RTA, add 8
441 if (PortP->SecondBlock)
444 writeb(p, &PktCmdP->PhbNum);
447 ** to make debuggery easier
449 writeb('W', &PacketP->data[2]);
450 writeb('F', &PacketP->data[3]);
451 writeb('L', &PacketP->data[4]);
452 writeb('U', &PacketP->data[5]);
453 writeb('S', &PacketP->data[6]);
454 writeb('H', &PacketP->data[7]);
455 writeb(' ', &PacketP->data[8]);
456 writeb('0' + PortP->WflushFlag, &PacketP->data[9]);
457 writeb(' ', &PacketP->data[10]);
458 writeb(' ', &PacketP->data[11]);
459 writeb('\0', &PacketP->data[12]);
462 ** its two bytes long!
464 writeb(PKT_CMD_BIT | 2, &PacketP->len);
469 if (!(PortP->State & RIO_DELETED)) {
472 ** Count chars tx'd for port statistics reporting
474 if (PortP->statsGather)
478 if (--(PortP->WflushFlag) == 0) {
479 PortP->MagicFlags &= ~MAGIC_FLUSH;
482 rio_dprintk(RIO_DEBUG_INTR, "Wflush count now stands at %d\n", PortP->WflushFlag);
484 if (PortP->MagicFlags & MORE_OUTPUT_EYGOR) {
485 if (PortP->MagicFlags & MAGIC_FLUSH) {
486 PortP->MagicFlags |= MORE_OUTPUT_EYGOR;
488 if (!can_add_transmit(&PacketP, PortP)) {
489 rio_spin_unlock(&PortP->portSem);
492 rio_spin_unlock(&PortP->portSem);
493 RIOTxEnable((char *) PortP);
494 rio_spin_lock(&PortP->portSem);
495 PortP->MagicFlags &= ~MORE_OUTPUT_EYGOR;
502 ** If we can't add anything to the transmit queue, then
503 ** we need do none of the remaining processing.
505 if (!can_add_transmit(&PacketP, PortP)) {
506 rio_spin_unlock(&PortP->portSem);
510 rio_spin_unlock(&PortP->portSem);
511 RIOTxEnable((char *) PortP);
517 ** Routine for handling received data for tty drivers
519 static void RIOReceive(struct rio_info *p, struct Port *PortP)
521 struct tty_struct *TtyP;
522 unsigned short transCount;
523 struct PKT __iomem *PacketP;
524 register unsigned int DataCnt;
525 unsigned char __iomem *ptr;
529 static int intCount, RxIntCnt;
532 ** The receive data process is to remove packets from the
533 ** PHB until there aren't any more or the current cblock
534 ** is full. When this occurs, there will be some left over
535 ** data in the packet, that we must do something with.
536 ** As we haven't unhooked the packet from the read list
537 ** yet, we can just leave the packet there, having first
538 ** made a note of how far we got. This means that we need
539 ** a pointer per port saying where we start taking the
540 ** data from - this will normally be zero, but when we
541 ** run out of space it will be set to the offset of the
542 ** next byte to copy from the packet data area. The packet
543 ** length field is decremented by the number of bytes that
544 ** we successfully removed from the packet. When this reaches
545 ** zero, we reset the offset pointer to be zero, and free
546 ** the packet from the front of the queue.
551 TtyP = PortP->gs.tty;
553 rio_dprintk(RIO_DEBUG_INTR, "RIOReceive: tty is null. \n");
557 if (PortP->State & RIO_THROTTLE_RX) {
558 rio_dprintk(RIO_DEBUG_INTR, "RIOReceive: Throttled. Can't handle more input.\n");
562 if (PortP->State & RIO_DELETED) {
563 while (can_remove_receive(&PacketP, PortP)) {
564 remove_receive(PortP);
565 put_free_end(PortP->HostP, PacketP);
569 ** loop, just so long as:
570 ** i ) there's some data ( i.e. can_remove_receive )
571 ** ii ) we haven't been blocked
572 ** iii ) there's somewhere to put the data
573 ** iv ) we haven't outstayed our welcome
576 while (can_remove_receive(&PacketP, PortP)
581 ** check that it is not a command!
583 if (readb(&PacketP->len) & PKT_CMD_BIT) {
584 rio_dprintk(RIO_DEBUG_INTR, "RIO: unexpected command packet received on PHB\n");
585 /* rio_dprint(RIO_DEBUG_INTR, (" sysport = %d\n", p->RIOPortp->PortNum)); */
586 rio_dprintk(RIO_DEBUG_INTR, " dest_unit = %d\n", readb(&PacketP->dest_unit));
587 rio_dprintk(RIO_DEBUG_INTR, " dest_port = %d\n", readb(&PacketP->dest_port));
588 rio_dprintk(RIO_DEBUG_INTR, " src_unit = %d\n", readb(&PacketP->src_unit));
589 rio_dprintk(RIO_DEBUG_INTR, " src_port = %d\n", readb(&PacketP->src_port));
590 rio_dprintk(RIO_DEBUG_INTR, " len = %d\n", readb(&PacketP->len));
591 rio_dprintk(RIO_DEBUG_INTR, " control = %d\n", readb(&PacketP->control));
592 rio_dprintk(RIO_DEBUG_INTR, " csum = %d\n", readw(&PacketP->csum));
593 rio_dprintk(RIO_DEBUG_INTR, " data bytes: ");
594 for (DataCnt = 0; DataCnt < PKT_MAX_DATA_LEN; DataCnt++)
595 rio_dprintk(RIO_DEBUG_INTR, "%d\n", readb(&PacketP->data[DataCnt]));
596 remove_receive(PortP);
597 put_free_end(PortP->HostP, PacketP);
598 continue; /* with next packet */
602 ** How many characters can we move 'upstream' ?
604 ** Determine the minimum of the amount of data
605 ** available and the amount of space in which to
608 ** 1. Get the packet length by masking 'len'
609 ** for only the length bits.
610 ** 2. Available space is [buffer size] - [space used]
612 ** Transfer count is the minimum of packet length
613 ** and available space.
616 transCount = tty_buffer_request_room(TtyP, readb(&PacketP->len) & PKT_LEN_MASK);
617 rio_dprintk(RIO_DEBUG_REC, "port %d: Copy %d bytes\n", PortP->PortNum, transCount);
619 ** To use the following 'kkprintfs' for debugging - change the '#undef'
620 ** to '#define', (this is the only place ___DEBUG_IT___ occurs in the
623 ptr = (unsigned char __iomem *) PacketP->data + PortP->RxDataStart;
625 tty_prepare_flip_string(TtyP, &buf, transCount);
626 rio_memcpy_fromio(buf, ptr, transCount);
627 PortP->RxDataStart += transCount;
628 writeb(readb(&PacketP->len)-transCount, &PacketP->len);
629 copied += transCount;
633 if (readb(&PacketP->len) == 0) {
635 ** If we have emptied the packet, then we can
636 ** free it, and reset the start pointer for
639 remove_receive(PortP);
640 put_free_end(PortP->HostP, PacketP);
641 PortP->RxDataStart = 0;
646 rio_dprintk(RIO_DEBUG_REC, "port %d: pushing tty flip buffer: %d total bytes copied.\n", PortP->PortNum, copied);
647 tty_flip_buffer_push(TtyP);