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:47
26 ** Retrieved : 11/6/98 10:33:50
28 ** ident @(#)riotty.c 1.3
30 ** -----------------------------------------------------------------------------
33 static char *_riotty_c_sccs_
= "@(#)riotty.c 1.3";
37 #define __EXPLICIT_DEF_H__
39 #include <linux/module.h>
40 #include <linux/slab.h>
41 #include <linux/errno.h>
42 #include <linux/tty.h>
43 #include <linux/string.h>
45 #include <asm/system.h>
46 #include <asm/string.h>
47 #include <asm/semaphore.h>
48 #include <asm/uaccess.h>
50 #include <linux/termios.h>
52 #include <linux/serial.h>
54 #include <linux/generic_serial.h>
57 #include "linux_compat.h"
58 #include "rio_linux.h"
85 static void RIOClearUp(struct Port
*PortP
);
87 /* Below belongs in func.h */
88 int RIOShortCommand(struct rio_info
*p
, struct Port
*PortP
, int command
, int len
, int arg
);
91 extern struct rio_info
*p
;
94 int riotopen(struct tty_struct
*tty
, struct file
*filp
)
97 int repeat_this
= 250;
98 struct Port
*PortP
; /* pointer to the port structure */
104 /* Make sure driver_data is NULL in case the rio isn't booted jet. Else gs_close
107 tty
->driver_data
= NULL
;
109 SysPort
= rio_minor(tty
);
112 rio_dprintk(RIO_DEBUG_TTY
, "System initialisation failed\n");
117 rio_dprintk(RIO_DEBUG_TTY
, "port open SysPort %d (mapped:%d)\n", SysPort
, p
->RIOPortp
[SysPort
]->Mapped
);
120 ** Validate that we have received a legitimate request.
121 ** Currently, just check that we are opening a port on
122 ** a host card that actually exists, and that the port
123 ** has been mapped onto a host.
125 if (SysPort
>= RIO_PORTS
) { /* out of range ? */
126 rio_dprintk(RIO_DEBUG_TTY
, "Illegal port number %d\n", SysPort
);
132 ** Grab pointer to the port stucture
134 PortP
= p
->RIOPortp
[SysPort
]; /* Get control struc */
135 rio_dprintk(RIO_DEBUG_TTY
, "PortP: %p\n", PortP
);
136 if (!PortP
->Mapped
) { /* we aren't mapped yet! */
138 ** The system doesn't know which RTA this port
141 rio_dprintk(RIO_DEBUG_TTY
, "port not mapped into system\n");
146 tty
->driver_data
= PortP
;
151 rio_dprintk(RIO_DEBUG_TTY
, "%d bytes in tx buffer\n", PortP
->gs
.xmit_cnt
);
153 retval
= gs_init_port(&PortP
->gs
);
159 ** If the host hasn't been booted yet, then
162 if ((PortP
->HostP
->Flags
& RUN_STATE
) != RC_RUNNING
) {
163 rio_dprintk(RIO_DEBUG_TTY
, "Host not running\n");
169 ** If the RTA has not booted yet and the user has choosen to block
170 ** until the RTA is present then we must spin here waiting for
173 /* I find the above code a bit hairy. I find the below code
174 easier to read and shorter. Now, if it works too that would
177 rio_dprintk(RIO_DEBUG_TTY
, "Checking if RTA has booted... \n");
178 while (!(PortP
->HostP
->Mapping
[PortP
->RupNum
].Flags
& RTA_BOOTED
)) {
179 if (!PortP
->WaitUntilBooted
) {
180 rio_dprintk(RIO_DEBUG_TTY
, "RTA never booted\n");
185 /* Under Linux you'd normally use a wait instead of this
186 busy-waiting. I'll stick with the old implementation for
189 if (RIODelay(PortP
, HUNDRED_MS
) == RIO_FAIL
) {
190 rio_dprintk(RIO_DEBUG_TTY
, "RTA_wait_for_boot: EINTR in delay \n");
194 if (repeat_this
-- <= 0) {
195 rio_dprintk(RIO_DEBUG_TTY
, "Waiting for RTA to boot timeout\n");
200 rio_dprintk(RIO_DEBUG_TTY
, "RTA has been booted\n");
201 rio_spin_lock_irqsave(&PortP
->portSem
, flags
);
207 ** If the port is in the final throws of being closed,
208 ** we should wait here (politely), waiting
209 ** for it to finish, so that it doesn't close us!
211 while ((PortP
->State
& RIO_CLOSING
) && !p
->RIOHalted
) {
212 rio_dprintk(RIO_DEBUG_TTY
, "Waiting for RIO_CLOSING to go away\n");
213 if (repeat_this
-- <= 0) {
214 rio_dprintk(RIO_DEBUG_TTY
, "Waiting for not idle closed broken by signal\n");
215 RIOPreemptiveCmd(p
, PortP
, FCLOSE
);
219 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
220 if (RIODelay(PortP
, HUNDRED_MS
) == RIO_FAIL
) {
221 rio_spin_lock_irqsave(&PortP
->portSem
, flags
);
225 rio_spin_lock_irqsave(&PortP
->portSem
, flags
);
228 if (!PortP
->Mapped
) {
229 rio_dprintk(RIO_DEBUG_TTY
, "Port unmapped while closing!\n");
230 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
241 ** 15.10.1998 ARG - ESIL 0761 part fix
242 ** RIO has it's own CTSFLOW and RTSFLOW flags in 'Config' in the port structure,
243 ** we need to make sure that the flags are clear when the port is opened.
245 /* Uh? Suppose I turn these on and then another process opens
246 the port again? The flags get cleared! Not good. -- REW */
247 if (!(PortP
->State
& (RIO_LOPEN
| RIO_MOPEN
))) {
248 PortP
->Config
&= ~(RIO_CTSFLOW
| RIO_RTSFLOW
);
251 if (!(PortP
->firstOpen
)) { /* First time ? */
252 rio_dprintk(RIO_DEBUG_TTY
, "First open for this port\n");
256 PortP
->CookMode
= 0; /* XXX RIOCookMode(tp); */
257 PortP
->InUse
= NOT_INUSE
;
259 /* Tentative fix for bug PR27. Didn't work. */
260 /* PortP->gs.xmit_cnt = 0; */
262 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
264 /* Someone explain to me why this delay/config is
265 here. If I read the docs correctly the "open"
266 command piggybacks the parameters immediately.
268 RIOParam(PortP
, OPEN
, 1, OK_TO_SLEEP
); /* Open the port */
269 rio_spin_lock_irqsave(&PortP
->portSem
, flags
);
272 ** wait for the port to be not closed.
274 while (!(PortP
->PortState
& PORT_ISOPEN
) && !p
->RIOHalted
) {
275 rio_dprintk(RIO_DEBUG_TTY
, "Waiting for PORT_ISOPEN-currently %x\n", PortP
->PortState
);
276 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
277 if (RIODelay(PortP
, HUNDRED_MS
) == RIO_FAIL
) {
278 rio_dprintk(RIO_DEBUG_TTY
, "Waiting for open to finish broken by signal\n");
279 RIOPreemptiveCmd(p
, PortP
, FCLOSE
);
283 rio_spin_lock_irqsave(&PortP
->portSem
, flags
);
289 /* RIOClearUp( PortP ); */
290 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
293 rio_dprintk(RIO_DEBUG_TTY
, "PORT_ISOPEN found\n");
295 rio_dprintk(RIO_DEBUG_TTY
, "Modem - test for carrier\n");
298 ** insert test for carrier here. -- ???
299 ** I already see that test here. What's the deal? -- REW
301 if ((PortP
->gs
.tty
->termios
->c_cflag
& CLOCAL
) || (PortP
->ModemState
& MSVR1_CD
)) {
302 rio_dprintk(RIO_DEBUG_TTY
, "open(%d) Modem carr on\n", SysPort
);
304 tp->tm.c_state |= CARR_ON;
305 wakeup((caddr_t) &tp->tm.c_canq);
307 PortP
->State
|= RIO_CARR_ON
;
308 wake_up_interruptible(&PortP
->gs
.open_wait
);
309 } else { /* no carrier - wait for DCD */
311 while (!(PortP->gs.tty->termios->c_state & CARR_ON) &&
312 !(filp->f_flags & O_NONBLOCK) && !p->RIOHalted )
314 while (!(PortP
->State
& RIO_CARR_ON
) && !(filp
->f_flags
& O_NONBLOCK
) && !p
->RIOHalted
) {
315 rio_dprintk(RIO_DEBUG_TTY
, "open(%d) sleeping for carr on\n", SysPort
);
317 PortP->gs.tty->termios->c_state |= WOPEN;
319 PortP
->State
|= RIO_WOPEN
;
320 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
321 if (RIODelay(PortP
, HUNDRED_MS
) == RIO_FAIL
) {
323 ** ACTION: verify that this is a good thing
324 ** to do here. -- ???
325 ** I think it's OK. -- REW
327 rio_dprintk(RIO_DEBUG_TTY
, "open(%d) sleeping for carr broken by signal\n", SysPort
);
328 RIOPreemptiveCmd(p
, PortP
, FCLOSE
);
330 tp->tm.c_state &= ~WOPEN;
332 PortP
->State
&= ~RIO_WOPEN
;
333 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
338 PortP
->State
&= ~RIO_WOPEN
;
342 rio_dprintk(RIO_DEBUG_TTY
, "Setting RIO_MOPEN\n");
343 PortP
->State
|= RIO_MOPEN
;
348 rio_dprintk(RIO_DEBUG_TTY
, "high level open done\n");
351 ** Count opens for port statistics reporting
353 if (PortP
->statsGather
)
356 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
357 rio_dprintk(RIO_DEBUG_TTY
, "Returning from open\n");
363 ** RIOClose the port.
364 ** The operating system thinks that this is last close for the device.
365 ** As there are two interfaces to the port (Modem and tty), we need to
366 ** check that both are closed before we close the device.
368 int riotclose(void *ptr
)
370 struct Port
*PortP
= ptr
; /* pointer to the port structure */
372 int try = -1; /* Disable the timeouts by setting them to -1 */
373 int repeat_this
= -1; /* Congrats to those having 15 years of
374 uptime! (You get to break the driver.) */
375 unsigned long end_time
;
376 struct tty_struct
*tty
;
380 rio_dprintk(RIO_DEBUG_TTY
, "port close SysPort %d\n", PortP
->PortNum
);
382 /* PortP = p->RIOPortp[SysPort]; */
383 rio_dprintk(RIO_DEBUG_TTY
, "Port is at address %p\n", PortP
);
384 /* tp = PortP->TtyP; *//* Get tty */
386 rio_dprintk(RIO_DEBUG_TTY
, "TTY is at address %p\n", tty
);
388 if (PortP
->gs
.closing_wait
)
389 end_time
= jiffies
+ PortP
->gs
.closing_wait
;
391 end_time
= jiffies
+ MAX_SCHEDULE_TIMEOUT
;
393 rio_spin_lock_irqsave(&PortP
->portSem
, flags
);
396 ** Setting this flag will make any process trying to open
397 ** this port block until we are complete closing it.
399 PortP
->State
|= RIO_CLOSING
;
401 if ((PortP
->State
& RIO_DELETED
)) {
402 rio_dprintk(RIO_DEBUG_TTY
, "Close on deleted RTA\n");
412 rio_dprintk(RIO_DEBUG_TTY
, "Clear bits\n");
414 ** clear the open bits for this device
416 PortP
->State
&= ~RIO_MOPEN
;
417 PortP
->State
&= ~RIO_CARR_ON
;
418 PortP
->ModemState
&= ~MSVR1_CD
;
420 ** If the device was open as both a Modem and a tty line
421 ** then we need to wimp out here, as the port has not really
422 ** been finally closed (gee, whizz!) The test here uses the
423 ** bit for the OTHER mode of operation, to see if THAT is
426 if ((PortP
->State
& (RIO_LOPEN
| RIO_MOPEN
))) {
428 ** The port is still open for the other task -
429 ** return, pretending that we are still active.
431 rio_dprintk(RIO_DEBUG_TTY
, "Channel %d still open !\n", PortP
->PortNum
);
432 PortP
->State
&= ~RIO_CLOSING
;
433 if (PortP
->firstOpen
)
435 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
439 rio_dprintk(RIO_DEBUG_TTY
, "Closing down - everything must go!\n");
441 PortP
->State
&= ~RIO_DYNOROD
;
444 ** This is where we wait for the port
445 ** to drain down before closing. Bye-bye....
446 ** (We never meant to do this)
448 rio_dprintk(RIO_DEBUG_TTY
, "Timeout 1 starts\n");
451 while ((PortP
->InUse
!= NOT_INUSE
) && !p
->RIOHalted
&& (PortP
->TxBufferIn
!= PortP
->TxBufferOut
)) {
452 if (repeat_this
-- <= 0) {
454 rio_dprintk(RIO_DEBUG_TTY
, "Waiting for not idle closed broken by signal\n");
455 RIOPreemptiveCmd(p
, PortP
, FCLOSE
);
458 rio_dprintk(RIO_DEBUG_TTY
, "Calling timeout to flush in closing\n");
459 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
460 if (RIODelay_ni(PortP
, HUNDRED_MS
* 10) == RIO_FAIL
) {
461 rio_dprintk(RIO_DEBUG_TTY
, "RTA EINTR in delay \n");
463 rio_spin_lock_irqsave(&PortP
->portSem
, flags
);
466 rio_spin_lock_irqsave(&PortP
->portSem
, flags
);
469 PortP
->TxBufferIn
= PortP
->TxBufferOut
= 0;
473 if ((PortP
->State
& (RIO_LOPEN
| RIO_MOPEN
))) {
475 ** The port has been re-opened for the other task -
476 ** return, pretending that we are still active.
478 rio_dprintk(RIO_DEBUG_TTY
, "Channel %d re-open!\n", PortP
->PortNum
);
479 PortP
->State
&= ~RIO_CLOSING
;
480 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
481 if (PortP
->firstOpen
)
491 /* Can't call RIOShortCommand with the port locked. */
492 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
494 if (RIOShortCommand(p
, PortP
, CLOSE
, 1, 0) == RIO_FAIL
) {
495 RIOPreemptiveCmd(p
, PortP
, FCLOSE
);
500 while (try && (PortP
->PortState
& PORT_ISOPEN
)) {
502 if (time_after(jiffies
, end_time
)) {
503 rio_dprintk(RIO_DEBUG_TTY
, "Run out of tries - force the bugger shut!\n");
504 RIOPreemptiveCmd(p
, PortP
, FCLOSE
);
507 rio_dprintk(RIO_DEBUG_TTY
, "Close: PortState:ISOPEN is %d\n", PortP
->PortState
& PORT_ISOPEN
);
513 if (RIODelay(PortP
, HUNDRED_MS
) == RIO_FAIL
) {
514 rio_dprintk(RIO_DEBUG_TTY
, "RTA EINTR in delay \n");
515 RIOPreemptiveCmd(p
, PortP
, FCLOSE
);
519 rio_spin_lock_irqsave(&PortP
->portSem
, flags
);
520 rio_dprintk(RIO_DEBUG_TTY
, "Close: try was %d on completion\n", try);
522 /* RIOPreemptiveCmd(p, PortP, FCLOSE); */
525 ** 15.10.1998 ARG - ESIL 0761 part fix
526 ** RIO has it's own CTSFLOW and RTSFLOW flags in 'Config' in the port structure,** we need to make sure that the flags are clear when the port is opened.
528 PortP
->Config
&= ~(RIO_CTSFLOW
| RIO_RTSFLOW
);
531 ** Count opens for port statistics reporting
533 if (PortP
->statsGather
)
537 /* XXX: Why would a "DELETED" flag be reset here? I'd have
538 thought that a "deleted" flag means that the port was
539 permanently gone, but here we can make it reappear by it
540 being in close during the "deletion".
542 PortP
->State
&= ~(RIO_CLOSING
| RIO_DELETED
);
543 if (PortP
->firstOpen
)
545 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
546 rio_dprintk(RIO_DEBUG_TTY
, "Return from close\n");
552 static void RIOClearUp(struct Port
*PortP
)
554 rio_dprintk(RIO_DEBUG_TTY
, "RIOHalted set\n");
555 PortP
->Config
= 0; /* Direct semaphore */
556 PortP
->PortState
= 0;
557 PortP
->firstOpen
= 0;
558 PortP
->FlushCmdBodge
= 0;
559 PortP
->ModemState
= PortP
->CookMode
= 0;
561 PortP
->WflushFlag
= 0;
562 PortP
->MagicFlags
= 0;
563 PortP
->RxDataStart
= 0;
564 PortP
->TxBufferIn
= 0;
565 PortP
->TxBufferOut
= 0;
569 ** Put a command onto a port.
570 ** The PortPointer, command, length and arg are passed.
571 ** The len is the length *inclusive* of the command byte,
572 ** and so for a command that takes no data, len==1.
573 ** The arg is a single byte, and is only used if len==2.
574 ** Other values of len aren't allowed, and will cause
577 int RIOShortCommand(struct rio_info
*p
, struct Port
*PortP
, int command
, int len
, int arg
)
579 struct PKT __iomem
*PacketP
;
580 int retries
= 20; /* at 10 per second -> 2 seconds */
583 rio_dprintk(RIO_DEBUG_TTY
, "entering shortcommand.\n");
585 if (PortP
->State
& RIO_DELETED
) {
586 rio_dprintk(RIO_DEBUG_TTY
, "Short command to deleted RTA ignored\n");
589 rio_spin_lock_irqsave(&PortP
->portSem
, flags
);
592 ** If the port is in use for pre-emptive command, then wait for it to
595 while ((PortP
->InUse
!= NOT_INUSE
) && !p
->RIOHalted
) {
596 rio_dprintk(RIO_DEBUG_TTY
, "Waiting for not in use (%d)\n", retries
);
597 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
598 if (retries
-- <= 0) {
601 if (RIODelay_ni(PortP
, HUNDRED_MS
) == RIO_FAIL
) {
604 rio_spin_lock_irqsave(&PortP
->portSem
, flags
);
606 if (PortP
->State
& RIO_DELETED
) {
607 rio_dprintk(RIO_DEBUG_TTY
, "Short command to deleted RTA ignored\n");
608 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
612 while (!can_add_transmit(&PacketP
, PortP
) && !p
->RIOHalted
) {
613 rio_dprintk(RIO_DEBUG_TTY
, "Waiting to add short command to queue (%d)\n", retries
);
614 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
615 if (retries
-- <= 0) {
616 rio_dprintk(RIO_DEBUG_TTY
, "out of tries. Failing\n");
619 if (RIODelay_ni(PortP
, HUNDRED_MS
) == RIO_FAIL
) {
622 rio_spin_lock_irqsave(&PortP
->portSem
, flags
);
626 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
631 ** set the command byte and the argument byte
633 writeb(command
, &PacketP
->data
[0]);
636 writeb(arg
, &PacketP
->data
[1]);
639 ** set the length of the packet and set the command bit.
641 writeb(PKT_CMD_BIT
| len
, &PacketP
->len
);
645 ** Count characters transmitted for port statistics reporting
647 if (PortP
->statsGather
)
648 PortP
->txchars
+= len
;
650 rio_spin_unlock_irqrestore(&PortP
->portSem
, flags
);
651 return p
->RIOHalted
? RIO_FAIL
: ~RIO_FAIL
;