1e3b3d0f5SGreg Kroah-Hartman // SPDX-License-Identifier: GPL-2.0 2fff0a2caSNicolas Pitre /* 3fff0a2caSNicolas Pitre * Copyright (C) 1991, 1992, 1993, 1994 Linus Torvalds 4fff0a2caSNicolas Pitre */ 5fff0a2caSNicolas Pitre 6fff0a2caSNicolas Pitre #include <linux/types.h> 7fff0a2caSNicolas Pitre #include <linux/kernel.h> 8fff0a2caSNicolas Pitre #include <linux/termios.h> 9fff0a2caSNicolas Pitre #include <linux/tty.h> 10fff0a2caSNicolas Pitre #include <linux/export.h> 11fff0a2caSNicolas Pitre 12fff0a2caSNicolas Pitre 13fff0a2caSNicolas Pitre /* 14fff0a2caSNicolas Pitre * Routine which returns the baud rate of the tty 15fff0a2caSNicolas Pitre * 16fff0a2caSNicolas Pitre * Note that the baud_table needs to be kept in sync with the 17fff0a2caSNicolas Pitre * include/asm/termbits.h file. 18fff0a2caSNicolas Pitre */ 19fff0a2caSNicolas Pitre static const speed_t baud_table[] = { 206ada6064SAndy Shevchenko 0, 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 216ada6064SAndy Shevchenko 4800, 9600, 19200, 38400, 57600, 115200, 230400, 460800, 22fff0a2caSNicolas Pitre #ifdef __sparc__ 23fff0a2caSNicolas Pitre 76800, 153600, 307200, 614400, 921600 24fff0a2caSNicolas Pitre #else 25fff0a2caSNicolas Pitre 500000, 576000, 921600, 1000000, 1152000, 1500000, 2000000, 26fff0a2caSNicolas Pitre 2500000, 3000000, 3500000, 4000000 27fff0a2caSNicolas Pitre #endif 28fff0a2caSNicolas Pitre }; 29fff0a2caSNicolas Pitre 30fff0a2caSNicolas Pitre static const tcflag_t baud_bits[] = { 316ada6064SAndy Shevchenko B0, B50, B75, B110, B134, B150, B200, B300, B600, B1200, B1800, B2400, 326ada6064SAndy Shevchenko B4800, B9600, B19200, B38400, B57600, B115200, B230400, B460800, 336ada6064SAndy Shevchenko #ifdef __sparc__ 346ada6064SAndy Shevchenko B76800, B153600, B307200, B614400, B921600 35fff0a2caSNicolas Pitre #else 366ada6064SAndy Shevchenko B500000, B576000, B921600, B1000000, B1152000, B1500000, B2000000, 376ada6064SAndy Shevchenko B2500000, B3000000, B3500000, B4000000 38fff0a2caSNicolas Pitre #endif 396ada6064SAndy Shevchenko }; 40fff0a2caSNicolas Pitre 41fff0a2caSNicolas Pitre static int n_baud_table = ARRAY_SIZE(baud_table); 42fff0a2caSNicolas Pitre 43fff0a2caSNicolas Pitre /** 44fff0a2caSNicolas Pitre * tty_termios_baud_rate 45fff0a2caSNicolas Pitre * @termios: termios structure 46fff0a2caSNicolas Pitre * 47fff0a2caSNicolas Pitre * Convert termios baud rate data into a speed. This should be called 48fff0a2caSNicolas Pitre * with the termios lock held if this termios is a terminal termios 49fff0a2caSNicolas Pitre * structure. May change the termios data. Device drivers can call this 50fff0a2caSNicolas Pitre * function but should use ->c_[io]speed directly as they are updated. 51fff0a2caSNicolas Pitre * 52fff0a2caSNicolas Pitre * Locking: none 53fff0a2caSNicolas Pitre */ 54fff0a2caSNicolas Pitre 55fff0a2caSNicolas Pitre speed_t tty_termios_baud_rate(struct ktermios *termios) 56fff0a2caSNicolas Pitre { 57fff0a2caSNicolas Pitre unsigned int cbaud; 58fff0a2caSNicolas Pitre 59fff0a2caSNicolas Pitre cbaud = termios->c_cflag & CBAUD; 60fff0a2caSNicolas Pitre 61fff0a2caSNicolas Pitre #ifdef BOTHER 62fff0a2caSNicolas Pitre /* Magic token for arbitrary speed via c_ispeed/c_ospeed */ 63fff0a2caSNicolas Pitre if (cbaud == BOTHER) 64fff0a2caSNicolas Pitre return termios->c_ospeed; 65fff0a2caSNicolas Pitre #endif 66fff0a2caSNicolas Pitre if (cbaud & CBAUDEX) { 67fff0a2caSNicolas Pitre cbaud &= ~CBAUDEX; 68fff0a2caSNicolas Pitre 69fff0a2caSNicolas Pitre if (cbaud < 1 || cbaud + 15 > n_baud_table) 70fff0a2caSNicolas Pitre termios->c_cflag &= ~CBAUDEX; 71fff0a2caSNicolas Pitre else 72fff0a2caSNicolas Pitre cbaud += 15; 73fff0a2caSNicolas Pitre } 74991a2519SH. Peter Anvin return cbaud >= n_baud_table ? 0 : baud_table[cbaud]; 75fff0a2caSNicolas Pitre } 76fff0a2caSNicolas Pitre EXPORT_SYMBOL(tty_termios_baud_rate); 77fff0a2caSNicolas Pitre 78fff0a2caSNicolas Pitre /** 79fff0a2caSNicolas Pitre * tty_termios_input_baud_rate 80fff0a2caSNicolas Pitre * @termios: termios structure 81fff0a2caSNicolas Pitre * 82fff0a2caSNicolas Pitre * Convert termios baud rate data into a speed. This should be called 83fff0a2caSNicolas Pitre * with the termios lock held if this termios is a terminal termios 84fff0a2caSNicolas Pitre * structure. May change the termios data. Device drivers can call this 85fff0a2caSNicolas Pitre * function but should use ->c_[io]speed directly as they are updated. 86fff0a2caSNicolas Pitre * 87fff0a2caSNicolas Pitre * Locking: none 88fff0a2caSNicolas Pitre */ 89fff0a2caSNicolas Pitre 90fff0a2caSNicolas Pitre speed_t tty_termios_input_baud_rate(struct ktermios *termios) 91fff0a2caSNicolas Pitre { 92fff0a2caSNicolas Pitre #ifdef IBSHIFT 93fff0a2caSNicolas Pitre unsigned int cbaud = (termios->c_cflag >> IBSHIFT) & CBAUD; 94fff0a2caSNicolas Pitre 95fff0a2caSNicolas Pitre if (cbaud == B0) 96fff0a2caSNicolas Pitre return tty_termios_baud_rate(termios); 97fefe287eSJohan Hovold #ifdef BOTHER 98fff0a2caSNicolas Pitre /* Magic token for arbitrary speed via c_ispeed*/ 99fff0a2caSNicolas Pitre if (cbaud == BOTHER) 100fff0a2caSNicolas Pitre return termios->c_ispeed; 101fefe287eSJohan Hovold #endif 102fff0a2caSNicolas Pitre if (cbaud & CBAUDEX) { 103fff0a2caSNicolas Pitre cbaud &= ~CBAUDEX; 104fff0a2caSNicolas Pitre 105fff0a2caSNicolas Pitre if (cbaud < 1 || cbaud + 15 > n_baud_table) 106fff0a2caSNicolas Pitre termios->c_cflag &= ~(CBAUDEX << IBSHIFT); 107fff0a2caSNicolas Pitre else 108fff0a2caSNicolas Pitre cbaud += 15; 109fff0a2caSNicolas Pitre } 110991a2519SH. Peter Anvin return cbaud >= n_baud_table ? 0 : baud_table[cbaud]; 111fefe287eSJohan Hovold #else /* IBSHIFT */ 112fff0a2caSNicolas Pitre return tty_termios_baud_rate(termios); 113fefe287eSJohan Hovold #endif /* IBSHIFT */ 114fff0a2caSNicolas Pitre } 115fff0a2caSNicolas Pitre EXPORT_SYMBOL(tty_termios_input_baud_rate); 116fff0a2caSNicolas Pitre 117fff0a2caSNicolas Pitre /** 118fff0a2caSNicolas Pitre * tty_termios_encode_baud_rate 119fff0a2caSNicolas Pitre * @termios: ktermios structure holding user requested state 120fff0a2caSNicolas Pitre * @ispeed: input speed 121fff0a2caSNicolas Pitre * @ospeed: output speed 122fff0a2caSNicolas Pitre * 123fff0a2caSNicolas Pitre * Encode the speeds set into the passed termios structure. This is 124fff0a2caSNicolas Pitre * used as a library helper for drivers so that they can report back 125fff0a2caSNicolas Pitre * the actual speed selected when it differs from the speed requested 126fff0a2caSNicolas Pitre * 127fff0a2caSNicolas Pitre * For maximal back compatibility with legacy SYS5/POSIX *nix behaviour 128fff0a2caSNicolas Pitre * we need to carefully set the bits when the user does not get the 129fff0a2caSNicolas Pitre * desired speed. We allow small margins and preserve as much of possible 130fff0a2caSNicolas Pitre * of the input intent to keep compatibility. 131fff0a2caSNicolas Pitre * 132fff0a2caSNicolas Pitre * Locking: Caller should hold termios lock. This is already held 133fff0a2caSNicolas Pitre * when calling this function from the driver termios handler. 134fff0a2caSNicolas Pitre * 135fff0a2caSNicolas Pitre * The ifdefs deal with platforms whose owners have yet to update them 136fff0a2caSNicolas Pitre * and will all go away once this is done. 137fff0a2caSNicolas Pitre */ 138fff0a2caSNicolas Pitre 139fff0a2caSNicolas Pitre void tty_termios_encode_baud_rate(struct ktermios *termios, 140fff0a2caSNicolas Pitre speed_t ibaud, speed_t obaud) 141fff0a2caSNicolas Pitre { 142fff0a2caSNicolas Pitre int i = 0; 143fff0a2caSNicolas Pitre int ifound = -1, ofound = -1; 144fff0a2caSNicolas Pitre int iclose = ibaud/50, oclose = obaud/50; 145fff0a2caSNicolas Pitre int ibinput = 0; 146fff0a2caSNicolas Pitre 147fff0a2caSNicolas Pitre if (obaud == 0) /* CD dropped */ 148fff0a2caSNicolas Pitre ibaud = 0; /* Clear ibaud to be sure */ 149fff0a2caSNicolas Pitre 150fff0a2caSNicolas Pitre termios->c_ispeed = ibaud; 151fff0a2caSNicolas Pitre termios->c_ospeed = obaud; 152fff0a2caSNicolas Pitre 153fefe287eSJohan Hovold #ifdef IBSHIFT 1541cee38f0SJohan Hovold if ((termios->c_cflag >> IBSHIFT) & CBAUD) 1551cee38f0SJohan Hovold ibinput = 1; /* An input speed was specified */ 156fefe287eSJohan Hovold #endif 157fefe287eSJohan Hovold #ifdef BOTHER 158fff0a2caSNicolas Pitre /* If the user asked for a precise weird speed give a precise weird 159fff0a2caSNicolas Pitre answer. If they asked for a Bfoo speed they may have problems 160fff0a2caSNicolas Pitre digesting non-exact replies so fuzz a bit */ 161fff0a2caSNicolas Pitre 1621cee38f0SJohan Hovold if ((termios->c_cflag & CBAUD) == BOTHER) { 163fff0a2caSNicolas Pitre oclose = 0; 1641cee38f0SJohan Hovold if (!ibinput) 1651cee38f0SJohan Hovold iclose = 0; 1661cee38f0SJohan Hovold } 167fff0a2caSNicolas Pitre if (((termios->c_cflag >> IBSHIFT) & CBAUD) == BOTHER) 168fff0a2caSNicolas Pitre iclose = 0; 169fff0a2caSNicolas Pitre #endif 170fff0a2caSNicolas Pitre termios->c_cflag &= ~CBAUD; 171fada18c4SJohan Hovold #ifdef IBSHIFT 172fada18c4SJohan Hovold termios->c_cflag &= ~(CBAUD << IBSHIFT); 173fada18c4SJohan Hovold #endif 174fff0a2caSNicolas Pitre 175fff0a2caSNicolas Pitre /* 176fff0a2caSNicolas Pitre * Our goal is to find a close match to the standard baud rate 177fff0a2caSNicolas Pitre * returned. Walk the baud rate table and if we get a very close 178fff0a2caSNicolas Pitre * match then report back the speed as a POSIX Bxxxx value by 179fff0a2caSNicolas Pitre * preference 180fff0a2caSNicolas Pitre */ 181fff0a2caSNicolas Pitre 182fff0a2caSNicolas Pitre do { 183fff0a2caSNicolas Pitre if (obaud - oclose <= baud_table[i] && 184fff0a2caSNicolas Pitre obaud + oclose >= baud_table[i]) { 185fff0a2caSNicolas Pitre termios->c_cflag |= baud_bits[i]; 186fff0a2caSNicolas Pitre ofound = i; 187fff0a2caSNicolas Pitre } 188fff0a2caSNicolas Pitre if (ibaud - iclose <= baud_table[i] && 189fff0a2caSNicolas Pitre ibaud + iclose >= baud_table[i]) { 190fff0a2caSNicolas Pitre /* For the case input == output don't set IBAUD bits 191fff0a2caSNicolas Pitre if the user didn't do so */ 192fff0a2caSNicolas Pitre if (ofound == i && !ibinput) 193fff0a2caSNicolas Pitre ifound = i; 194fff0a2caSNicolas Pitre #ifdef IBSHIFT 195fff0a2caSNicolas Pitre else { 196fff0a2caSNicolas Pitre ifound = i; 197fff0a2caSNicolas Pitre termios->c_cflag |= (baud_bits[i] << IBSHIFT); 198fff0a2caSNicolas Pitre } 199fff0a2caSNicolas Pitre #endif 200fff0a2caSNicolas Pitre } 201fff0a2caSNicolas Pitre } while (++i < n_baud_table); 202fff0a2caSNicolas Pitre 203fff0a2caSNicolas Pitre /* 204fff0a2caSNicolas Pitre * If we found no match then use BOTHER if provided or warn 205fff0a2caSNicolas Pitre * the user their platform maintainer needs to wake up if not. 206fff0a2caSNicolas Pitre */ 207fff0a2caSNicolas Pitre #ifdef BOTHER 208fff0a2caSNicolas Pitre if (ofound == -1) 209fff0a2caSNicolas Pitre termios->c_cflag |= BOTHER; 210fff0a2caSNicolas Pitre /* Set exact input bits only if the input and output differ or the 211fff0a2caSNicolas Pitre user already did */ 212fff0a2caSNicolas Pitre if (ifound == -1 && (ibaud != obaud || ibinput)) 213fff0a2caSNicolas Pitre termios->c_cflag |= (BOTHER << IBSHIFT); 214fff0a2caSNicolas Pitre #else 215fff0a2caSNicolas Pitre if (ifound == -1 || ofound == -1) 216fff0a2caSNicolas Pitre pr_warn_once("tty: Unable to return correct speed data as your architecture needs updating.\n"); 217fff0a2caSNicolas Pitre #endif 218fff0a2caSNicolas Pitre } 219fff0a2caSNicolas Pitre EXPORT_SYMBOL_GPL(tty_termios_encode_baud_rate); 220fff0a2caSNicolas Pitre 221fff0a2caSNicolas Pitre /** 222fff0a2caSNicolas Pitre * tty_encode_baud_rate - set baud rate of the tty 223fff0a2caSNicolas Pitre * @ibaud: input baud rate 224fff0a2caSNicolas Pitre * @obad: output baud rate 225fff0a2caSNicolas Pitre * 226fff0a2caSNicolas Pitre * Update the current termios data for the tty with the new speed 227fff0a2caSNicolas Pitre * settings. The caller must hold the termios_rwsem for the tty in 228fff0a2caSNicolas Pitre * question. 229fff0a2caSNicolas Pitre */ 230fff0a2caSNicolas Pitre 231fff0a2caSNicolas Pitre void tty_encode_baud_rate(struct tty_struct *tty, speed_t ibaud, speed_t obaud) 232fff0a2caSNicolas Pitre { 233fff0a2caSNicolas Pitre tty_termios_encode_baud_rate(&tty->termios, ibaud, obaud); 234fff0a2caSNicolas Pitre } 235fff0a2caSNicolas Pitre EXPORT_SYMBOL_GPL(tty_encode_baud_rate); 236