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.
23 ** Module : rioparam.c
25 ** Last Modified : 11/6/98 10:33:45
26 ** Retrieved : 11/6/98 10:33:50
28 ** ident @(#)rioparam.c 1.3
30 ** -----------------------------------------------------------------------------
33 #include <linux/module.h>
34 #include <linux/slab.h>
35 #include <linux/errno.h>
36 #include <linux/tty.h>
38 #include <asm/system.h>
39 #include <asm/string.h>
40 #include <asm/uaccess.h>
42 #include <linux/termios.h>
43 #include <linux/serial.h>
45 #include <linux/generic_serial.h>
48 #include "linux_compat.h"
49 #include "rio_linux.h"
79 ** The Scam, based on email from jeremyr@bugs.specialix.co.uk....
81 ** To send a command on a particular port, you put a packet with the
82 ** command bit set onto the port. The command bit is in the len field,
83 ** and gets ORed in with the actual byte count.
85 ** When you send a packet with the command bit set the first
86 ** data byte (data[0]) is interpreted as the command to execute.
87 ** It also governs what data structure overlay should accompany the packet.
88 ** Commands are defined in cirrus/cirrus.h
90 ** If you want the command to pre-emt data already on the queue for the
91 ** port, set the pre-emptive bit in conjunction with the command bit.
92 ** It is not defined what will happen if you set the preemptive bit
93 ** on a packet that is NOT a command.
95 ** Pre-emptive commands should be queued at the head of the queue using
96 ** add_start(), whereas normal commands and data are enqueued using
99 ** Most commands do not use the remaining bytes in the data array. The
100 ** exceptions are OPEN MOPEN and CONFIG. (NB. As with the SI CONFIG and
101 ** OPEN are currently analogous). With these three commands the following
102 ** 11 data bytes are all used to pass config information such as baud rate etc.
103 ** The fields are also defined in cirrus.h. Some contain straightforward
104 ** information such as the transmit XON character. Two contain the transmit and
105 ** receive baud rates respectively. For most baud rates there is a direct
106 ** mapping between the rates defined in <sys/termio.h> and the byte in the
107 ** packet. There are additional (non UNIX-standard) rates defined in
108 ** /u/dos/rio/cirrus/h/brates.h.
110 ** The rest of the data fields contain approximations to the Cirrus registers
111 ** that are used to program number of bits etc. Each registers bit fields is
112 ** defined in cirrus.h.
114 ** NB. Only use those bits that are defined as being driver specific
115 ** or common to the RTA and the driver.
117 ** All commands going from RTA->Host will be dealt with by the Host code - you
118 ** will never see them. As with the SI there will be three fields to look out
119 ** for in each phb (not yet defined - needs defining a.s.a.p).
121 ** modem_status - current state of handshake pins.
123 ** port_status - current port status - equivalent to hi_stat for SI, indicates
124 ** if port is IDLE_OPEN, IDLE_CLOSED etc.
126 ** break_status - bit X set if break has been received.
133 ** RIOParam is used to open or configure a port. You pass it a PortP,
134 ** which will have a tty struct attached to it. You also pass a command,
135 ** either OPEN or CONFIG. The port's setup is taken from the t_ fields
136 ** of the tty struct inside the PortP, and the port is either opened
137 ** or re-configured. You must also tell RIOParam if the device is a modem
138 ** device or not (i.e. top bit of minor number set or clear - take special
139 ** care when deciding on this!).
140 ** RIOParam neither flushes nor waits for drain, and is NOT preemptive.
142 ** RIOParam assumes it will be called at splrio(), and also assumes
143 ** that CookMode is set correctly in the port structure.
146 ** tty lock must NOT have been previously acquired.
148 int RIOParam(struct Port *PortP, int cmd, int Modem, int SleepFlag)
150 struct tty_struct *TtyP;
152 struct phb_param __iomem *phb_param_ptr;
153 struct PKT __iomem *PacketP;
155 u8 Cor1 = 0, Cor2 = 0, Cor4 = 0, Cor5 = 0;
156 u8 TxXon = 0, TxXoff = 0, RxXon = 0, RxXoff = 0;
157 u8 LNext = 0, TxBaud = 0, RxBaud = 0;
163 TtyP = PortP->gs.port.tty;
165 rio_dprintk(RIO_DEBUG_PARAM, "RIOParam: Port:%d cmd:%d Modem:%d SleepFlag:%d Mapped: %d, tty=%p\n", PortP->PortNum, cmd, Modem, SleepFlag, PortP->Mapped, TtyP);
168 rio_dprintk(RIO_DEBUG_PARAM, "Can't call rioparam with null tty.\n");
174 rio_spin_lock_irqsave(&PortP->portSem, flags);
176 if (cmd == RIOC_OPEN) {
178 ** If the port is set to store or lock the parameters, and it is
179 ** paramed with OPEN, we want to restore the saved port termio, but
180 ** only if StoredTermio has been saved, i.e. NOT 1st open after reboot.
187 while (!(res = can_add_transmit(&PacketP, PortP)) || (PortP->InUse != NOT_INUSE)) {
188 if (retries-- <= 0) {
191 if (PortP->InUse != NOT_INUSE) {
192 rio_dprintk(RIO_DEBUG_PARAM, "Port IN_USE for pre-emptive command\n");
196 rio_dprintk(RIO_DEBUG_PARAM, "Port has no space on transmit queue\n");
199 if (SleepFlag != OK_TO_SLEEP) {
200 rio_spin_unlock_irqrestore(&PortP->portSem, flags);
206 rio_dprintk(RIO_DEBUG_PARAM, "wait for can_add_transmit\n");
207 rio_spin_unlock_irqrestore(&PortP->portSem, flags);
208 retval = RIODelay(PortP, HUNDRED_MS);
209 rio_spin_lock_irqsave(&PortP->portSem, flags);
210 if (retval == RIO_FAIL) {
211 rio_dprintk(RIO_DEBUG_PARAM, "wait for can_add_transmit broken by signal\n");
212 rio_spin_unlock_irqrestore(&PortP->portSem, flags);
216 if (PortP->State & RIO_DELETED) {
217 rio_spin_unlock_irqrestore(&PortP->portSem, flags);
224 rio_spin_unlock_irqrestore(&PortP->portSem, flags);
230 rio_dprintk(RIO_DEBUG_PARAM, "can_add_transmit() returns %x\n", res);
231 rio_dprintk(RIO_DEBUG_PARAM, "Packet is %p\n", PacketP);
233 phb_param_ptr = (struct phb_param __iomem *) PacketP->data;
236 switch (TtyP->termios->c_cflag & CSIZE) {
239 rio_dprintk(RIO_DEBUG_PARAM, "5 bit data\n");
240 Cor1 |= RIOC_COR1_5BITS;
245 rio_dprintk(RIO_DEBUG_PARAM, "6 bit data\n");
246 Cor1 |= RIOC_COR1_6BITS;
251 rio_dprintk(RIO_DEBUG_PARAM, "7 bit data\n");
252 Cor1 |= RIOC_COR1_7BITS;
257 rio_dprintk(RIO_DEBUG_PARAM, "8 bit data\n");
258 Cor1 |= RIOC_COR1_8BITS;
263 if (TtyP->termios->c_cflag & CSTOPB) {
264 rio_dprintk(RIO_DEBUG_PARAM, "2 stop bits\n");
265 Cor1 |= RIOC_COR1_2STOP;
267 rio_dprintk(RIO_DEBUG_PARAM, "1 stop bit\n");
268 Cor1 |= RIOC_COR1_1STOP;
271 if (TtyP->termios->c_cflag & PARENB) {
272 rio_dprintk(RIO_DEBUG_PARAM, "Enable parity\n");
273 Cor1 |= RIOC_COR1_NORMAL;
275 rio_dprintk(RIO_DEBUG_PARAM, "Disable parity\n");
276 Cor1 |= RIOC_COR1_NOP;
278 if (TtyP->termios->c_cflag & PARODD) {
279 rio_dprintk(RIO_DEBUG_PARAM, "Odd parity\n");
280 Cor1 |= RIOC_COR1_ODD;
282 rio_dprintk(RIO_DEBUG_PARAM, "Even parity\n");
283 Cor1 |= RIOC_COR1_EVEN;
289 if (TtyP->termios->c_iflag & IXON) {
290 rio_dprintk(RIO_DEBUG_PARAM, "Enable start/stop output control\n");
291 Cor2 |= RIOC_COR2_IXON;
293 if (PortP->Config & RIO_IXON) {
294 rio_dprintk(RIO_DEBUG_PARAM, "Force enable start/stop output control\n");
295 Cor2 |= RIOC_COR2_IXON;
297 rio_dprintk(RIO_DEBUG_PARAM, "IXON has been disabled.\n");
300 if (TtyP->termios->c_iflag & IXANY) {
301 if (PortP->Config & RIO_IXANY) {
302 rio_dprintk(RIO_DEBUG_PARAM, "Enable any key to restart output\n");
303 Cor2 |= RIOC_COR2_IXANY;
305 rio_dprintk(RIO_DEBUG_PARAM, "IXANY has been disabled due to sanity reasons.\n");
308 if (TtyP->termios->c_iflag & IXOFF) {
309 rio_dprintk(RIO_DEBUG_PARAM, "Enable start/stop input control 2\n");
310 Cor2 |= RIOC_COR2_IXOFF;
313 if (TtyP->termios->c_cflag & HUPCL) {
314 rio_dprintk(RIO_DEBUG_PARAM, "Hangup on last close\n");
315 Cor2 |= RIOC_COR2_HUPCL;
318 if (C_CRTSCTS(TtyP)) {
319 rio_dprintk(RIO_DEBUG_PARAM, "Rx hardware flow control enabled\n");
320 Cor2 |= RIOC_COR2_CTSFLOW;
321 Cor2 |= RIOC_COR2_RTSFLOW;
323 rio_dprintk(RIO_DEBUG_PARAM, "Rx hardware flow control disabled\n");
324 Cor2 &= ~RIOC_COR2_CTSFLOW;
325 Cor2 &= ~RIOC_COR2_RTSFLOW;
329 if (TtyP->termios->c_cflag & CLOCAL) {
330 rio_dprintk(RIO_DEBUG_PARAM, "Local line\n");
332 rio_dprintk(RIO_DEBUG_PARAM, "Possible Modem line\n");
336 ** COR 4 (there is no COR 3)
338 if (TtyP->termios->c_iflag & IGNBRK) {
339 rio_dprintk(RIO_DEBUG_PARAM, "Ignore break condition\n");
340 Cor4 |= RIOC_COR4_IGNBRK;
342 if (!(TtyP->termios->c_iflag & BRKINT)) {
343 rio_dprintk(RIO_DEBUG_PARAM, "Break generates NULL condition\n");
344 Cor4 |= RIOC_COR4_NBRKINT;
346 rio_dprintk(RIO_DEBUG_PARAM, "Interrupt on break condition\n");
349 if (TtyP->termios->c_iflag & INLCR) {
350 rio_dprintk(RIO_DEBUG_PARAM, "Map newline to carriage return on input\n");
351 Cor4 |= RIOC_COR4_INLCR;
354 if (TtyP->termios->c_iflag & IGNCR) {
355 rio_dprintk(RIO_DEBUG_PARAM, "Ignore carriage return on input\n");
356 Cor4 |= RIOC_COR4_IGNCR;
359 if (TtyP->termios->c_iflag & ICRNL) {
360 rio_dprintk(RIO_DEBUG_PARAM, "Map carriage return to newline on input\n");
361 Cor4 |= RIOC_COR4_ICRNL;
363 if (TtyP->termios->c_iflag & IGNPAR) {
364 rio_dprintk(RIO_DEBUG_PARAM, "Ignore characters with parity errors\n");
365 Cor4 |= RIOC_COR4_IGNPAR;
367 if (TtyP->termios->c_iflag & PARMRK) {
368 rio_dprintk(RIO_DEBUG_PARAM, "Mark parity errors\n");
369 Cor4 |= RIOC_COR4_PARMRK;
373 ** Set the RAISEMOD flag to ensure that the modem lines are raised
374 ** on reception of a config packet.
375 ** The download code handles the zero baud condition.
377 Cor4 |= RIOC_COR4_RAISEMOD;
383 Cor5 = RIOC_COR5_CMOE;
386 ** Set to monitor tbusy/tstop (or not).
389 if (PortP->MonitorTstate)
390 Cor5 |= RIOC_COR5_TSTATE_ON;
392 Cor5 |= RIOC_COR5_TSTATE_OFF;
395 ** Could set LNE here if you wanted LNext processing. SVR4 will use it.
397 if (TtyP->termios->c_iflag & ISTRIP) {
398 rio_dprintk(RIO_DEBUG_PARAM, "Strip input characters\n");
399 if (!(PortP->State & RIO_TRIAD_MODE)) {
400 Cor5 |= RIOC_COR5_ISTRIP;
404 if (TtyP->termios->c_oflag & ONLCR) {
405 rio_dprintk(RIO_DEBUG_PARAM, "Map newline to carriage-return, newline on output\n");
406 if (PortP->CookMode == COOK_MEDIUM)
407 Cor5 |= RIOC_COR5_ONLCR;
409 if (TtyP->termios->c_oflag & OCRNL) {
410 rio_dprintk(RIO_DEBUG_PARAM, "Map carriage return to newline on output\n");
411 if (PortP->CookMode == COOK_MEDIUM)
412 Cor5 |= RIOC_COR5_OCRNL;
414 if ((TtyP->termios->c_oflag & TABDLY) == TAB3) {
415 rio_dprintk(RIO_DEBUG_PARAM, "Tab delay 3 set\n");
416 if (PortP->CookMode == COOK_MEDIUM)
417 Cor5 |= RIOC_COR5_TAB3;
421 ** Flow control bytes.
423 TxXon = TtyP->termios->c_cc[VSTART];
424 TxXoff = TtyP->termios->c_cc[VSTOP];
425 RxXon = TtyP->termios->c_cc[VSTART];
426 RxXoff = TtyP->termios->c_cc[VSTOP];
435 rio_dprintk(RIO_DEBUG_PARAM, "Mapping of rx/tx baud %x (%x)\n", TtyP->termios->c_cflag, CBAUD);
437 switch (TtyP->termios->c_cflag & CBAUD) {
438 #define e(b) case B ## b : RxBaud = TxBaud = RIO_B ## b ;break
455 e(115200); /* e(230400);e(460800); e(921600); */
458 rio_dprintk(RIO_DEBUG_PARAM, "tx baud 0x%x, rx baud 0x%x\n", TxBaud, RxBaud);
464 if (TtyP->termios->c_cflag & CREAD)
465 rio_dprintk(RIO_DEBUG_PARAM, "Enable receiver\n");
467 if (TtyP->termios->c_cflag & RCV1EN)
468 rio_dprintk(RIO_DEBUG_PARAM, "RCV1EN (?)\n");
471 if (TtyP->termios->c_cflag & XMT1EN)
472 rio_dprintk(RIO_DEBUG_PARAM, "XMT1EN (?)\n");
474 if (TtyP->termios->c_lflag & ISIG)
475 rio_dprintk(RIO_DEBUG_PARAM, "Input character signal generating enabled\n");
476 if (TtyP->termios->c_lflag & ICANON)
477 rio_dprintk(RIO_DEBUG_PARAM, "Canonical input: erase and kill enabled\n");
478 if (TtyP->termios->c_lflag & XCASE)
479 rio_dprintk(RIO_DEBUG_PARAM, "Canonical upper/lower presentation\n");
480 if (TtyP->termios->c_lflag & ECHO)
481 rio_dprintk(RIO_DEBUG_PARAM, "Enable input echo\n");
482 if (TtyP->termios->c_lflag & ECHOE)
483 rio_dprintk(RIO_DEBUG_PARAM, "Enable echo erase\n");
484 if (TtyP->termios->c_lflag & ECHOK)
485 rio_dprintk(RIO_DEBUG_PARAM, "Enable echo kill\n");
486 if (TtyP->termios->c_lflag & ECHONL)
487 rio_dprintk(RIO_DEBUG_PARAM, "Enable echo newline\n");
488 if (TtyP->termios->c_lflag & NOFLSH)
489 rio_dprintk(RIO_DEBUG_PARAM, "Disable flush after interrupt or quit\n");
491 if (TtyP->termios->c_lflag & TOSTOP)
492 rio_dprintk(RIO_DEBUG_PARAM, "Send SIGTTOU for background output\n");
495 if (TtyP->termios->c_lflag & XCLUDE)
496 rio_dprintk(RIO_DEBUG_PARAM, "Exclusive use of this line\n");
498 if (TtyP->termios->c_iflag & IUCLC)
499 rio_dprintk(RIO_DEBUG_PARAM, "Map uppercase to lowercase on input\n");
500 if (TtyP->termios->c_oflag & OPOST)
501 rio_dprintk(RIO_DEBUG_PARAM, "Enable output post-processing\n");
502 if (TtyP->termios->c_oflag & OLCUC)
503 rio_dprintk(RIO_DEBUG_PARAM, "Map lowercase to uppercase on output\n");
504 if (TtyP->termios->c_oflag & ONOCR)
505 rio_dprintk(RIO_DEBUG_PARAM, "No carriage return output at column 0\n");
506 if (TtyP->termios->c_oflag & ONLRET)
507 rio_dprintk(RIO_DEBUG_PARAM, "Newline performs carriage return function\n");
508 if (TtyP->termios->c_oflag & OFILL)
509 rio_dprintk(RIO_DEBUG_PARAM, "Use fill characters for delay\n");
510 if (TtyP->termios->c_oflag & OFDEL)
511 rio_dprintk(RIO_DEBUG_PARAM, "Fill character is DEL\n");
512 if (TtyP->termios->c_oflag & NLDLY)
513 rio_dprintk(RIO_DEBUG_PARAM, "Newline delay set\n");
514 if (TtyP->termios->c_oflag & CRDLY)
515 rio_dprintk(RIO_DEBUG_PARAM, "Carriage return delay set\n");
516 if (TtyP->termios->c_oflag & TABDLY)
517 rio_dprintk(RIO_DEBUG_PARAM, "Tab delay set\n");
519 ** These things are kind of useful in a later life!
521 PortP->Cor2Copy = Cor2;
523 if (PortP->State & RIO_DELETED) {
524 rio_spin_unlock_irqrestore(&PortP->portSem, flags);
531 ** Actually write the info into the packet to be sent
533 writeb(cmd, &phb_param_ptr->Cmd);
534 writeb(Cor1, &phb_param_ptr->Cor1);
535 writeb(Cor2, &phb_param_ptr->Cor2);
536 writeb(Cor4, &phb_param_ptr->Cor4);
537 writeb(Cor5, &phb_param_ptr->Cor5);
538 writeb(TxXon, &phb_param_ptr->TxXon);
539 writeb(RxXon, &phb_param_ptr->RxXon);
540 writeb(TxXoff, &phb_param_ptr->TxXoff);
541 writeb(RxXoff, &phb_param_ptr->RxXoff);
542 writeb(LNext, &phb_param_ptr->LNext);
543 writeb(TxBaud, &phb_param_ptr->TxBaud);
544 writeb(RxBaud, &phb_param_ptr->RxBaud);
547 ** Set the length/command field
549 writeb(12 | PKT_CMD_BIT, &PacketP->len);
552 ** The packet is formed - now, whack it off
553 ** to its final destination:
557 ** Count characters transmitted for port statistics reporting
559 if (PortP->statsGather)
560 PortP->txchars += 12;
562 rio_spin_unlock_irqrestore(&PortP->portSem, flags);
564 rio_dprintk(RIO_DEBUG_PARAM, "add_transmit returned.\n");
575 ** We can add another packet to a transmit queue if the packet pointer pointed
576 ** to by the TxAdd pointer has PKT_IN_USE clear in its address.
578 int can_add_transmit(struct PKT __iomem **PktP, struct Port *PortP)
580 struct PKT __iomem *tp;
582 *PktP = tp = (struct PKT __iomem *) RIO_PTR(PortP->Caddr, readw(PortP->TxAdd));
584 return !((unsigned long) tp & PKT_IN_USE);
588 ** To add a packet to the queue, you set the PKT_IN_USE bit in the address,
589 ** and then move the TxAdd pointer along one position to point to the next
590 ** packet pointer. You must wrap the pointer from the end back to the start.
592 void add_transmit(struct Port *PortP)
594 if (readw(PortP->TxAdd) & PKT_IN_USE) {
595 rio_dprintk(RIO_DEBUG_PARAM, "add_transmit: Packet has been stolen!");
597 writew(readw(PortP->TxAdd) | PKT_IN_USE, PortP->TxAdd);
598 PortP->TxAdd = (PortP->TxAdd == PortP->TxEnd) ? PortP->TxStart : PortP->TxAdd + 1;
599 writew(RIO_OFF(PortP->Caddr, PortP->TxAdd), &PortP->PhbP->tx_add);
602 /****************************************
603 * Put a packet onto the end of the
605 ****************************************/
606 void put_free_end(struct Host *HostP, struct PKT __iomem *PktP)
608 struct rio_free_list __iomem *tmp_pointer;
609 unsigned short old_end, new_end;
612 rio_spin_lock_irqsave(&HostP->HostLock, flags);
614 /*************************************************
615 * Put a packet back onto the back of the free list
617 ************************************************/
619 rio_dprintk(RIO_DEBUG_PFE, "put_free_end(PktP=%p)\n", PktP);
621 if ((old_end = readw(&HostP->ParmMapP->free_list_end)) != TPNULL) {
622 new_end = RIO_OFF(HostP->Caddr, PktP);
623 tmp_pointer = (struct rio_free_list __iomem *) RIO_PTR(HostP->Caddr, old_end);
624 writew(new_end, &tmp_pointer->next);
625 writew(old_end, &((struct rio_free_list __iomem *) PktP)->prev);
626 writew(TPNULL, &((struct rio_free_list __iomem *) PktP)->next);
627 writew(new_end, &HostP->ParmMapP->free_list_end);
628 } else { /* First packet on the free list this should never happen! */
629 rio_dprintk(RIO_DEBUG_PFE, "put_free_end(): This should never happen\n");
630 writew(RIO_OFF(HostP->Caddr, PktP), &HostP->ParmMapP->free_list_end);
631 tmp_pointer = (struct rio_free_list __iomem *) PktP;
632 writew(TPNULL, &tmp_pointer->prev);
633 writew(TPNULL, &tmp_pointer->next);
635 rio_dprintk(RIO_DEBUG_CMD, "Before unlock: %p\n", &HostP->HostLock);
636 rio_spin_unlock_irqrestore(&HostP->HostLock, flags);
640 ** can_remove_receive(PktP,P) returns non-zero if PKT_IN_USE is set
641 ** for the next packet on the queue. It will also set PktP to point to the
642 ** relevant packet, [having cleared the PKT_IN_USE bit]. If PKT_IN_USE is clear,
643 ** then can_remove_receive() returns 0.
645 int can_remove_receive(struct PKT __iomem **PktP, struct Port *PortP)
647 if (readw(PortP->RxRemove) & PKT_IN_USE) {
648 *PktP = (struct PKT __iomem *) RIO_PTR(PortP->Caddr, readw(PortP->RxRemove) & ~PKT_IN_USE);
655 ** To remove a packet from the receive queue you clear its PKT_IN_USE bit,
656 ** and then bump the pointers. Once the pointers get to the end, they must
657 ** be wrapped back to the start.
659 void remove_receive(struct Port *PortP)
661 writew(readw(PortP->RxRemove) & ~PKT_IN_USE, PortP->RxRemove);
662 PortP->RxRemove = (PortP->RxRemove == PortP->RxEnd) ? PortP->RxStart : PortP->RxRemove + 1;
663 writew(RIO_OFF(PortP->Caddr, PortP->RxRemove), &PortP->PhbP->rx_remove);