1 // SPDX-License-Identifier: GPL-2.0+ 2 /* 3 * Maxim (Dallas) MAX3107/8/9, MAX14830 serial driver 4 * 5 * Copyright (C) 2012-2016 Alexander Shiyan <shc_work@mail.ru> 6 * 7 * Based on max3100.c, by Christian Pellegrin <chripell@evolware.org> 8 * Based on max3110.c, by Feng Tang <feng.tang@intel.com> 9 * Based on max3107.c, by Aavamobile 10 */ 11 12 #include <linux/bitops.h> 13 #include <linux/clk.h> 14 #include <linux/delay.h> 15 #include <linux/device.h> 16 #include <linux/gpio/driver.h> 17 #include <linux/i2c.h> 18 #include <linux/module.h> 19 #include <linux/mod_devicetable.h> 20 #include <linux/property.h> 21 #include <linux/regmap.h> 22 #include <linux/serial_core.h> 23 #include <linux/serial.h> 24 #include <linux/tty.h> 25 #include <linux/tty_flip.h> 26 #include <linux/spi/spi.h> 27 #include <linux/uaccess.h> 28 29 #define MAX310X_NAME "max310x" 30 #define MAX310X_MAJOR 204 31 #define MAX310X_MINOR 209 32 #define MAX310X_UART_NRMAX 16 33 34 /* MAX310X register definitions */ 35 #define MAX310X_RHR_REG (0x00) /* RX FIFO */ 36 #define MAX310X_THR_REG (0x00) /* TX FIFO */ 37 #define MAX310X_IRQEN_REG (0x01) /* IRQ enable */ 38 #define MAX310X_IRQSTS_REG (0x02) /* IRQ status */ 39 #define MAX310X_LSR_IRQEN_REG (0x03) /* LSR IRQ enable */ 40 #define MAX310X_LSR_IRQSTS_REG (0x04) /* LSR IRQ status */ 41 #define MAX310X_REG_05 (0x05) 42 #define MAX310X_SPCHR_IRQEN_REG MAX310X_REG_05 /* Special char IRQ en */ 43 #define MAX310X_SPCHR_IRQSTS_REG (0x06) /* Special char IRQ status */ 44 #define MAX310X_STS_IRQEN_REG (0x07) /* Status IRQ enable */ 45 #define MAX310X_STS_IRQSTS_REG (0x08) /* Status IRQ status */ 46 #define MAX310X_MODE1_REG (0x09) /* MODE1 */ 47 #define MAX310X_MODE2_REG (0x0a) /* MODE2 */ 48 #define MAX310X_LCR_REG (0x0b) /* LCR */ 49 #define MAX310X_RXTO_REG (0x0c) /* RX timeout */ 50 #define MAX310X_HDPIXDELAY_REG (0x0d) /* Auto transceiver delays */ 51 #define MAX310X_IRDA_REG (0x0e) /* IRDA settings */ 52 #define MAX310X_FLOWLVL_REG (0x0f) /* Flow control levels */ 53 #define MAX310X_FIFOTRIGLVL_REG (0x10) /* FIFO IRQ trigger levels */ 54 #define MAX310X_TXFIFOLVL_REG (0x11) /* TX FIFO level */ 55 #define MAX310X_RXFIFOLVL_REG (0x12) /* RX FIFO level */ 56 #define MAX310X_FLOWCTRL_REG (0x13) /* Flow control */ 57 #define MAX310X_XON1_REG (0x14) /* XON1 character */ 58 #define MAX310X_XON2_REG (0x15) /* XON2 character */ 59 #define MAX310X_XOFF1_REG (0x16) /* XOFF1 character */ 60 #define MAX310X_XOFF2_REG (0x17) /* XOFF2 character */ 61 #define MAX310X_GPIOCFG_REG (0x18) /* GPIO config */ 62 #define MAX310X_GPIODATA_REG (0x19) /* GPIO data */ 63 #define MAX310X_PLLCFG_REG (0x1a) /* PLL config */ 64 #define MAX310X_BRGCFG_REG (0x1b) /* Baud rate generator conf */ 65 #define MAX310X_BRGDIVLSB_REG (0x1c) /* Baud rate divisor LSB */ 66 #define MAX310X_BRGDIVMSB_REG (0x1d) /* Baud rate divisor MSB */ 67 #define MAX310X_CLKSRC_REG (0x1e) /* Clock source */ 68 #define MAX310X_REG_1F (0x1f) 69 70 #define MAX310X_REVID_REG MAX310X_REG_1F /* Revision ID */ 71 72 #define MAX310X_GLOBALIRQ_REG MAX310X_REG_1F /* Global IRQ (RO) */ 73 #define MAX310X_GLOBALCMD_REG MAX310X_REG_1F /* Global Command (WO) */ 74 75 /* Extended registers */ 76 #define MAX310X_SPI_REVID_EXTREG MAX310X_REG_05 /* Revision ID */ 77 #define MAX310X_I2C_REVID_EXTREG (0x25) /* Revision ID */ 78 79 /* IRQ register bits */ 80 #define MAX310X_IRQ_LSR_BIT (1 << 0) /* LSR interrupt */ 81 #define MAX310X_IRQ_SPCHR_BIT (1 << 1) /* Special char interrupt */ 82 #define MAX310X_IRQ_STS_BIT (1 << 2) /* Status interrupt */ 83 #define MAX310X_IRQ_RXFIFO_BIT (1 << 3) /* RX FIFO interrupt */ 84 #define MAX310X_IRQ_TXFIFO_BIT (1 << 4) /* TX FIFO interrupt */ 85 #define MAX310X_IRQ_TXEMPTY_BIT (1 << 5) /* TX FIFO empty interrupt */ 86 #define MAX310X_IRQ_RXEMPTY_BIT (1 << 6) /* RX FIFO empty interrupt */ 87 #define MAX310X_IRQ_CTS_BIT (1 << 7) /* CTS interrupt */ 88 89 /* LSR register bits */ 90 #define MAX310X_LSR_RXTO_BIT (1 << 0) /* RX timeout */ 91 #define MAX310X_LSR_RXOVR_BIT (1 << 1) /* RX overrun */ 92 #define MAX310X_LSR_RXPAR_BIT (1 << 2) /* RX parity error */ 93 #define MAX310X_LSR_FRERR_BIT (1 << 3) /* Frame error */ 94 #define MAX310X_LSR_RXBRK_BIT (1 << 4) /* RX break */ 95 #define MAX310X_LSR_RXNOISE_BIT (1 << 5) /* RX noise */ 96 #define MAX310X_LSR_CTS_BIT (1 << 7) /* CTS pin state */ 97 98 /* Special character register bits */ 99 #define MAX310X_SPCHR_XON1_BIT (1 << 0) /* XON1 character */ 100 #define MAX310X_SPCHR_XON2_BIT (1 << 1) /* XON2 character */ 101 #define MAX310X_SPCHR_XOFF1_BIT (1 << 2) /* XOFF1 character */ 102 #define MAX310X_SPCHR_XOFF2_BIT (1 << 3) /* XOFF2 character */ 103 #define MAX310X_SPCHR_BREAK_BIT (1 << 4) /* RX break */ 104 #define MAX310X_SPCHR_MULTIDROP_BIT (1 << 5) /* 9-bit multidrop addr char */ 105 106 /* Status register bits */ 107 #define MAX310X_STS_GPIO0_BIT (1 << 0) /* GPIO 0 interrupt */ 108 #define MAX310X_STS_GPIO1_BIT (1 << 1) /* GPIO 1 interrupt */ 109 #define MAX310X_STS_GPIO2_BIT (1 << 2) /* GPIO 2 interrupt */ 110 #define MAX310X_STS_GPIO3_BIT (1 << 3) /* GPIO 3 interrupt */ 111 #define MAX310X_STS_CLKREADY_BIT (1 << 5) /* Clock ready */ 112 #define MAX310X_STS_SLEEP_BIT (1 << 6) /* Sleep interrupt */ 113 114 /* MODE1 register bits */ 115 #define MAX310X_MODE1_RXDIS_BIT (1 << 0) /* RX disable */ 116 #define MAX310X_MODE1_TXDIS_BIT (1 << 1) /* TX disable */ 117 #define MAX310X_MODE1_TXHIZ_BIT (1 << 2) /* TX pin three-state */ 118 #define MAX310X_MODE1_RTSHIZ_BIT (1 << 3) /* RTS pin three-state */ 119 #define MAX310X_MODE1_TRNSCVCTRL_BIT (1 << 4) /* Transceiver ctrl enable */ 120 #define MAX310X_MODE1_FORCESLEEP_BIT (1 << 5) /* Force sleep mode */ 121 #define MAX310X_MODE1_AUTOSLEEP_BIT (1 << 6) /* Auto sleep enable */ 122 #define MAX310X_MODE1_IRQSEL_BIT (1 << 7) /* IRQ pin enable */ 123 124 /* MODE2 register bits */ 125 #define MAX310X_MODE2_RST_BIT (1 << 0) /* Chip reset */ 126 #define MAX310X_MODE2_FIFORST_BIT (1 << 1) /* FIFO reset */ 127 #define MAX310X_MODE2_RXTRIGINV_BIT (1 << 2) /* RX FIFO INT invert */ 128 #define MAX310X_MODE2_RXEMPTINV_BIT (1 << 3) /* RX FIFO empty INT invert */ 129 #define MAX310X_MODE2_SPCHR_BIT (1 << 4) /* Special chr detect enable */ 130 #define MAX310X_MODE2_LOOPBACK_BIT (1 << 5) /* Internal loopback enable */ 131 #define MAX310X_MODE2_MULTIDROP_BIT (1 << 6) /* 9-bit multidrop enable */ 132 #define MAX310X_MODE2_ECHOSUPR_BIT (1 << 7) /* ECHO suppression enable */ 133 134 /* LCR register bits */ 135 #define MAX310X_LCR_LENGTH0_BIT (1 << 0) /* Word length bit 0 */ 136 #define MAX310X_LCR_LENGTH1_BIT (1 << 1) /* Word length bit 1 137 * 138 * Word length bits table: 139 * 00 -> 5 bit words 140 * 01 -> 6 bit words 141 * 10 -> 7 bit words 142 * 11 -> 8 bit words 143 */ 144 #define MAX310X_LCR_STOPLEN_BIT (1 << 2) /* STOP length bit 145 * 146 * STOP length bit table: 147 * 0 -> 1 stop bit 148 * 1 -> 1-1.5 stop bits if 149 * word length is 5, 150 * 2 stop bits otherwise 151 */ 152 #define MAX310X_LCR_PARITY_BIT (1 << 3) /* Parity bit enable */ 153 #define MAX310X_LCR_EVENPARITY_BIT (1 << 4) /* Even parity bit enable */ 154 #define MAX310X_LCR_FORCEPARITY_BIT (1 << 5) /* 9-bit multidrop parity */ 155 #define MAX310X_LCR_TXBREAK_BIT (1 << 6) /* TX break enable */ 156 #define MAX310X_LCR_RTS_BIT (1 << 7) /* RTS pin control */ 157 158 /* IRDA register bits */ 159 #define MAX310X_IRDA_IRDAEN_BIT (1 << 0) /* IRDA mode enable */ 160 #define MAX310X_IRDA_SIR_BIT (1 << 1) /* SIR mode enable */ 161 162 /* Flow control trigger level register masks */ 163 #define MAX310X_FLOWLVL_HALT_MASK (0x000f) /* Flow control halt level */ 164 #define MAX310X_FLOWLVL_RES_MASK (0x00f0) /* Flow control resume level */ 165 #define MAX310X_FLOWLVL_HALT(words) ((words / 8) & 0x0f) 166 #define MAX310X_FLOWLVL_RES(words) (((words / 8) & 0x0f) << 4) 167 168 /* FIFO interrupt trigger level register masks */ 169 #define MAX310X_FIFOTRIGLVL_TX_MASK (0x0f) /* TX FIFO trigger level */ 170 #define MAX310X_FIFOTRIGLVL_RX_MASK (0xf0) /* RX FIFO trigger level */ 171 #define MAX310X_FIFOTRIGLVL_TX(words) ((words / 8) & 0x0f) 172 #define MAX310X_FIFOTRIGLVL_RX(words) (((words / 8) & 0x0f) << 4) 173 174 /* Flow control register bits */ 175 #define MAX310X_FLOWCTRL_AUTORTS_BIT (1 << 0) /* Auto RTS flow ctrl enable */ 176 #define MAX310X_FLOWCTRL_AUTOCTS_BIT (1 << 1) /* Auto CTS flow ctrl enable */ 177 #define MAX310X_FLOWCTRL_GPIADDR_BIT (1 << 2) /* Enables that GPIO inputs 178 * are used in conjunction with 179 * XOFF2 for definition of 180 * special character */ 181 #define MAX310X_FLOWCTRL_SWFLOWEN_BIT (1 << 3) /* Auto SW flow ctrl enable */ 182 #define MAX310X_FLOWCTRL_SWFLOW0_BIT (1 << 4) /* SWFLOW bit 0 */ 183 #define MAX310X_FLOWCTRL_SWFLOW1_BIT (1 << 5) /* SWFLOW bit 1 184 * 185 * SWFLOW bits 1 & 0 table: 186 * 00 -> no transmitter flow 187 * control 188 * 01 -> receiver compares 189 * XON2 and XOFF2 190 * and controls 191 * transmitter 192 * 10 -> receiver compares 193 * XON1 and XOFF1 194 * and controls 195 * transmitter 196 * 11 -> receiver compares 197 * XON1, XON2, XOFF1 and 198 * XOFF2 and controls 199 * transmitter 200 */ 201 #define MAX310X_FLOWCTRL_SWFLOW2_BIT (1 << 6) /* SWFLOW bit 2 */ 202 #define MAX310X_FLOWCTRL_SWFLOW3_BIT (1 << 7) /* SWFLOW bit 3 203 * 204 * SWFLOW bits 3 & 2 table: 205 * 00 -> no received flow 206 * control 207 * 01 -> transmitter generates 208 * XON2 and XOFF2 209 * 10 -> transmitter generates 210 * XON1 and XOFF1 211 * 11 -> transmitter generates 212 * XON1, XON2, XOFF1 and 213 * XOFF2 214 */ 215 216 /* PLL configuration register masks */ 217 #define MAX310X_PLLCFG_PREDIV_MASK (0x3f) /* PLL predivision value */ 218 #define MAX310X_PLLCFG_PLLFACTOR_MASK (0xc0) /* PLL multiplication factor */ 219 220 /* Baud rate generator configuration register bits */ 221 #define MAX310X_BRGCFG_2XMODE_BIT (1 << 4) /* Double baud rate */ 222 #define MAX310X_BRGCFG_4XMODE_BIT (1 << 5) /* Quadruple baud rate */ 223 224 /* Clock source register bits */ 225 #define MAX310X_CLKSRC_CRYST_BIT (1 << 1) /* Crystal osc enable */ 226 #define MAX310X_CLKSRC_PLL_BIT (1 << 2) /* PLL enable */ 227 #define MAX310X_CLKSRC_PLLBYP_BIT (1 << 3) /* PLL bypass */ 228 #define MAX310X_CLKSRC_EXTCLK_BIT (1 << 4) /* External clock enable */ 229 #define MAX310X_CLKSRC_CLK2RTS_BIT (1 << 7) /* Baud clk to RTS pin */ 230 231 /* Global commands */ 232 #define MAX310X_EXTREG_ENBL (0xce) 233 #define MAX310X_EXTREG_DSBL (0xcd) 234 235 /* Misc definitions */ 236 #define MAX310X_FIFO_SIZE (128) 237 #define MAX310x_REV_MASK (0xf8) 238 #define MAX310X_WRITE_BIT 0x80 239 240 /* MAX3107 specific */ 241 #define MAX3107_REV_ID (0xa0) 242 243 /* MAX3109 specific */ 244 #define MAX3109_REV_ID (0xc0) 245 246 /* MAX14830 specific */ 247 #define MAX14830_BRGCFG_CLKDIS_BIT (1 << 6) /* Clock Disable */ 248 #define MAX14830_REV_ID (0xb0) 249 250 struct max310x_if_cfg { 251 int (*extended_reg_enable)(struct device *dev, bool enable); 252 253 unsigned int rev_id_reg; 254 }; 255 256 struct max310x_devtype { 257 struct { 258 unsigned short min; 259 unsigned short max; 260 } slave_addr; 261 char name[9]; 262 int nr; 263 u8 mode1; 264 int (*detect)(struct device *); 265 void (*power)(struct uart_port *, int); 266 }; 267 268 struct max310x_one { 269 struct uart_port port; 270 struct work_struct tx_work; 271 struct work_struct md_work; 272 struct work_struct rs_work; 273 struct regmap *regmap; 274 275 u8 rx_buf[MAX310X_FIFO_SIZE]; 276 }; 277 #define to_max310x_port(_port) \ 278 container_of(_port, struct max310x_one, port) 279 280 struct max310x_port { 281 const struct max310x_devtype *devtype; 282 const struct max310x_if_cfg *if_cfg; 283 struct regmap *regmap; 284 struct clk *clk; 285 #ifdef CONFIG_GPIOLIB 286 struct gpio_chip gpio; 287 #endif 288 struct max310x_one p[]; 289 }; 290 291 static struct uart_driver max310x_uart = { 292 .owner = THIS_MODULE, 293 .driver_name = MAX310X_NAME, 294 .dev_name = "ttyMAX", 295 .major = MAX310X_MAJOR, 296 .minor = MAX310X_MINOR, 297 .nr = MAX310X_UART_NRMAX, 298 }; 299 300 static DECLARE_BITMAP(max310x_lines, MAX310X_UART_NRMAX); 301 302 static u8 max310x_port_read(struct uart_port *port, u8 reg) 303 { 304 struct max310x_one *one = to_max310x_port(port); 305 unsigned int val = 0; 306 307 regmap_read(one->regmap, reg, &val); 308 309 return val; 310 } 311 312 static void max310x_port_write(struct uart_port *port, u8 reg, u8 val) 313 { 314 struct max310x_one *one = to_max310x_port(port); 315 316 regmap_write(one->regmap, reg, val); 317 } 318 319 static void max310x_port_update(struct uart_port *port, u8 reg, u8 mask, u8 val) 320 { 321 struct max310x_one *one = to_max310x_port(port); 322 323 regmap_update_bits(one->regmap, reg, mask, val); 324 } 325 326 static int max3107_detect(struct device *dev) 327 { 328 struct max310x_port *s = dev_get_drvdata(dev); 329 unsigned int val = 0; 330 int ret; 331 332 ret = regmap_read(s->regmap, MAX310X_REVID_REG, &val); 333 if (ret) 334 return ret; 335 336 if (((val & MAX310x_REV_MASK) != MAX3107_REV_ID)) { 337 dev_err(dev, 338 "%s ID 0x%02x does not match\n", s->devtype->name, val); 339 return -ENODEV; 340 } 341 342 return 0; 343 } 344 345 static int max3108_detect(struct device *dev) 346 { 347 struct max310x_port *s = dev_get_drvdata(dev); 348 unsigned int val = 0; 349 int ret; 350 351 /* MAX3108 have not REV ID register, we just check default value 352 * from clocksource register to make sure everything works. 353 */ 354 ret = regmap_read(s->regmap, MAX310X_CLKSRC_REG, &val); 355 if (ret) 356 return ret; 357 358 if (val != (MAX310X_CLKSRC_EXTCLK_BIT | MAX310X_CLKSRC_PLLBYP_BIT)) { 359 dev_err(dev, "%s not present\n", s->devtype->name); 360 return -ENODEV; 361 } 362 363 return 0; 364 } 365 366 static int max3109_detect(struct device *dev) 367 { 368 struct max310x_port *s = dev_get_drvdata(dev); 369 unsigned int val = 0; 370 int ret; 371 372 ret = s->if_cfg->extended_reg_enable(dev, true); 373 if (ret) 374 return ret; 375 376 regmap_read(s->regmap, s->if_cfg->rev_id_reg, &val); 377 s->if_cfg->extended_reg_enable(dev, false); 378 if (((val & MAX310x_REV_MASK) != MAX3109_REV_ID)) { 379 dev_err(dev, 380 "%s ID 0x%02x does not match\n", s->devtype->name, val); 381 return -ENODEV; 382 } 383 384 return 0; 385 } 386 387 static void max310x_power(struct uart_port *port, int on) 388 { 389 max310x_port_update(port, MAX310X_MODE1_REG, 390 MAX310X_MODE1_FORCESLEEP_BIT, 391 on ? 0 : MAX310X_MODE1_FORCESLEEP_BIT); 392 if (on) 393 msleep(50); 394 } 395 396 static int max14830_detect(struct device *dev) 397 { 398 struct max310x_port *s = dev_get_drvdata(dev); 399 unsigned int val = 0; 400 int ret; 401 402 ret = s->if_cfg->extended_reg_enable(dev, true); 403 if (ret) 404 return ret; 405 406 regmap_read(s->regmap, s->if_cfg->rev_id_reg, &val); 407 s->if_cfg->extended_reg_enable(dev, false); 408 if (((val & MAX310x_REV_MASK) != MAX14830_REV_ID)) { 409 dev_err(dev, 410 "%s ID 0x%02x does not match\n", s->devtype->name, val); 411 return -ENODEV; 412 } 413 414 return 0; 415 } 416 417 static void max14830_power(struct uart_port *port, int on) 418 { 419 max310x_port_update(port, MAX310X_BRGCFG_REG, 420 MAX14830_BRGCFG_CLKDIS_BIT, 421 on ? 0 : MAX14830_BRGCFG_CLKDIS_BIT); 422 if (on) 423 msleep(50); 424 } 425 426 static const struct max310x_devtype max3107_devtype = { 427 .name = "MAX3107", 428 .nr = 1, 429 .mode1 = MAX310X_MODE1_AUTOSLEEP_BIT | MAX310X_MODE1_IRQSEL_BIT, 430 .detect = max3107_detect, 431 .power = max310x_power, 432 .slave_addr = { 433 .min = 0x2c, 434 .max = 0x2f, 435 }, 436 }; 437 438 static const struct max310x_devtype max3108_devtype = { 439 .name = "MAX3108", 440 .nr = 1, 441 .mode1 = MAX310X_MODE1_AUTOSLEEP_BIT, 442 .detect = max3108_detect, 443 .power = max310x_power, 444 .slave_addr = { 445 .min = 0x60, 446 .max = 0x6f, 447 }, 448 }; 449 450 static const struct max310x_devtype max3109_devtype = { 451 .name = "MAX3109", 452 .nr = 2, 453 .mode1 = MAX310X_MODE1_AUTOSLEEP_BIT, 454 .detect = max3109_detect, 455 .power = max310x_power, 456 .slave_addr = { 457 .min = 0x60, 458 .max = 0x6f, 459 }, 460 }; 461 462 static const struct max310x_devtype max14830_devtype = { 463 .name = "MAX14830", 464 .nr = 4, 465 .mode1 = MAX310X_MODE1_IRQSEL_BIT, 466 .detect = max14830_detect, 467 .power = max14830_power, 468 .slave_addr = { 469 .min = 0x60, 470 .max = 0x6f, 471 }, 472 }; 473 474 static bool max310x_reg_writeable(struct device *dev, unsigned int reg) 475 { 476 switch (reg) { 477 case MAX310X_IRQSTS_REG: 478 case MAX310X_LSR_IRQSTS_REG: 479 case MAX310X_SPCHR_IRQSTS_REG: 480 case MAX310X_STS_IRQSTS_REG: 481 case MAX310X_TXFIFOLVL_REG: 482 case MAX310X_RXFIFOLVL_REG: 483 return false; 484 default: 485 break; 486 } 487 488 return true; 489 } 490 491 static bool max310x_reg_volatile(struct device *dev, unsigned int reg) 492 { 493 switch (reg) { 494 case MAX310X_RHR_REG: 495 case MAX310X_IRQSTS_REG: 496 case MAX310X_LSR_IRQSTS_REG: 497 case MAX310X_SPCHR_IRQSTS_REG: 498 case MAX310X_STS_IRQSTS_REG: 499 case MAX310X_TXFIFOLVL_REG: 500 case MAX310X_RXFIFOLVL_REG: 501 case MAX310X_GPIODATA_REG: 502 case MAX310X_BRGDIVLSB_REG: 503 case MAX310X_REG_05: 504 case MAX310X_REG_1F: 505 return true; 506 default: 507 break; 508 } 509 510 return false; 511 } 512 513 static bool max310x_reg_precious(struct device *dev, unsigned int reg) 514 { 515 switch (reg) { 516 case MAX310X_RHR_REG: 517 case MAX310X_IRQSTS_REG: 518 case MAX310X_SPCHR_IRQSTS_REG: 519 case MAX310X_STS_IRQSTS_REG: 520 return true; 521 default: 522 break; 523 } 524 525 return false; 526 } 527 528 static bool max310x_reg_noinc(struct device *dev, unsigned int reg) 529 { 530 return reg == MAX310X_RHR_REG; 531 } 532 533 static int max310x_set_baud(struct uart_port *port, int baud) 534 { 535 unsigned int mode = 0, div = 0, frac = 0, c = 0, F = 0; 536 537 /* 538 * Calculate the integer divisor first. Select a proper mode 539 * in case if the requested baud is too high for the pre-defined 540 * clocks frequency. 541 */ 542 div = port->uartclk / baud; 543 if (div < 8) { 544 /* Mode x4 */ 545 c = 4; 546 mode = MAX310X_BRGCFG_4XMODE_BIT; 547 } else if (div < 16) { 548 /* Mode x2 */ 549 c = 8; 550 mode = MAX310X_BRGCFG_2XMODE_BIT; 551 } else { 552 c = 16; 553 } 554 555 /* Calculate the divisor in accordance with the fraction coefficient */ 556 div /= c; 557 F = c*baud; 558 559 /* Calculate the baud rate fraction */ 560 if (div > 0) 561 frac = (16*(port->uartclk % F)) / F; 562 else 563 div = 1; 564 565 max310x_port_write(port, MAX310X_BRGDIVMSB_REG, div >> 8); 566 max310x_port_write(port, MAX310X_BRGDIVLSB_REG, div); 567 max310x_port_write(port, MAX310X_BRGCFG_REG, frac | mode); 568 569 /* Return the actual baud rate we just programmed */ 570 return (16*port->uartclk) / (c*(16*div + frac)); 571 } 572 573 static int max310x_update_best_err(unsigned long f, long *besterr) 574 { 575 /* Use baudrate 115200 for calculate error */ 576 long err = f % (460800 * 16); 577 578 if ((*besterr < 0) || (*besterr > err)) { 579 *besterr = err; 580 return 0; 581 } 582 583 return 1; 584 } 585 586 static u32 max310x_set_ref_clk(struct device *dev, struct max310x_port *s, 587 unsigned long freq, bool xtal) 588 { 589 unsigned int div, clksrc, pllcfg = 0; 590 long besterr = -1; 591 unsigned long fdiv, fmul, bestfreq = freq; 592 593 /* First, update error without PLL */ 594 max310x_update_best_err(freq, &besterr); 595 596 /* Try all possible PLL dividers */ 597 for (div = 1; (div <= 63) && besterr; div++) { 598 fdiv = DIV_ROUND_CLOSEST(freq, div); 599 600 /* Try multiplier 6 */ 601 fmul = fdiv * 6; 602 if ((fdiv >= 500000) && (fdiv <= 800000)) 603 if (!max310x_update_best_err(fmul, &besterr)) { 604 pllcfg = (0 << 6) | div; 605 bestfreq = fmul; 606 } 607 /* Try multiplier 48 */ 608 fmul = fdiv * 48; 609 if ((fdiv >= 850000) && (fdiv <= 1200000)) 610 if (!max310x_update_best_err(fmul, &besterr)) { 611 pllcfg = (1 << 6) | div; 612 bestfreq = fmul; 613 } 614 /* Try multiplier 96 */ 615 fmul = fdiv * 96; 616 if ((fdiv >= 425000) && (fdiv <= 1000000)) 617 if (!max310x_update_best_err(fmul, &besterr)) { 618 pllcfg = (2 << 6) | div; 619 bestfreq = fmul; 620 } 621 /* Try multiplier 144 */ 622 fmul = fdiv * 144; 623 if ((fdiv >= 390000) && (fdiv <= 667000)) 624 if (!max310x_update_best_err(fmul, &besterr)) { 625 pllcfg = (3 << 6) | div; 626 bestfreq = fmul; 627 } 628 } 629 630 /* Configure clock source */ 631 clksrc = MAX310X_CLKSRC_EXTCLK_BIT | (xtal ? MAX310X_CLKSRC_CRYST_BIT : 0); 632 633 /* Configure PLL */ 634 if (pllcfg) { 635 clksrc |= MAX310X_CLKSRC_PLL_BIT; 636 regmap_write(s->regmap, MAX310X_PLLCFG_REG, pllcfg); 637 } else 638 clksrc |= MAX310X_CLKSRC_PLLBYP_BIT; 639 640 regmap_write(s->regmap, MAX310X_CLKSRC_REG, clksrc); 641 642 /* Wait for crystal */ 643 if (xtal) { 644 unsigned int val; 645 msleep(10); 646 regmap_read(s->regmap, MAX310X_STS_IRQSTS_REG, &val); 647 if (!(val & MAX310X_STS_CLKREADY_BIT)) { 648 dev_warn(dev, "clock is not stable yet\n"); 649 } 650 } 651 652 return bestfreq; 653 } 654 655 static void max310x_batch_write(struct uart_port *port, u8 *txbuf, unsigned int len) 656 { 657 struct max310x_one *one = to_max310x_port(port); 658 659 regmap_noinc_write(one->regmap, MAX310X_THR_REG, txbuf, len); 660 } 661 662 static void max310x_batch_read(struct uart_port *port, u8 *rxbuf, unsigned int len) 663 { 664 struct max310x_one *one = to_max310x_port(port); 665 666 regmap_noinc_read(one->regmap, MAX310X_RHR_REG, rxbuf, len); 667 } 668 669 static void max310x_handle_rx(struct uart_port *port, unsigned int rxlen) 670 { 671 struct max310x_one *one = to_max310x_port(port); 672 unsigned int sts, ch, flag, i; 673 674 if (port->read_status_mask == MAX310X_LSR_RXOVR_BIT) { 675 /* We are just reading, happily ignoring any error conditions. 676 * Break condition, parity checking, framing errors -- they 677 * are all ignored. That means that we can do a batch-read. 678 * 679 * There is a small opportunity for race if the RX FIFO 680 * overruns while we're reading the buffer; the datasheets says 681 * that the LSR register applies to the "current" character. 682 * That's also the reason why we cannot do batched reads when 683 * asked to check the individual statuses. 684 * */ 685 686 sts = max310x_port_read(port, MAX310X_LSR_IRQSTS_REG); 687 max310x_batch_read(port, one->rx_buf, rxlen); 688 689 port->icount.rx += rxlen; 690 flag = TTY_NORMAL; 691 sts &= port->read_status_mask; 692 693 if (sts & MAX310X_LSR_RXOVR_BIT) { 694 dev_warn_ratelimited(port->dev, "Hardware RX FIFO overrun\n"); 695 port->icount.overrun++; 696 } 697 698 for (i = 0; i < (rxlen - 1); ++i) 699 uart_insert_char(port, sts, 0, one->rx_buf[i], flag); 700 701 /* 702 * Handle the overrun case for the last character only, since 703 * the RxFIFO overflow happens after it is pushed to the FIFO 704 * tail. 705 */ 706 uart_insert_char(port, sts, MAX310X_LSR_RXOVR_BIT, 707 one->rx_buf[rxlen-1], flag); 708 709 } else { 710 if (unlikely(rxlen >= port->fifosize)) { 711 dev_warn_ratelimited(port->dev, "Possible RX FIFO overrun\n"); 712 port->icount.buf_overrun++; 713 /* Ensure sanity of RX level */ 714 rxlen = port->fifosize; 715 } 716 717 while (rxlen--) { 718 ch = max310x_port_read(port, MAX310X_RHR_REG); 719 sts = max310x_port_read(port, MAX310X_LSR_IRQSTS_REG); 720 721 sts &= MAX310X_LSR_RXPAR_BIT | MAX310X_LSR_FRERR_BIT | 722 MAX310X_LSR_RXOVR_BIT | MAX310X_LSR_RXBRK_BIT; 723 724 port->icount.rx++; 725 flag = TTY_NORMAL; 726 727 if (unlikely(sts)) { 728 if (sts & MAX310X_LSR_RXBRK_BIT) { 729 port->icount.brk++; 730 if (uart_handle_break(port)) 731 continue; 732 } else if (sts & MAX310X_LSR_RXPAR_BIT) 733 port->icount.parity++; 734 else if (sts & MAX310X_LSR_FRERR_BIT) 735 port->icount.frame++; 736 else if (sts & MAX310X_LSR_RXOVR_BIT) 737 port->icount.overrun++; 738 739 sts &= port->read_status_mask; 740 if (sts & MAX310X_LSR_RXBRK_BIT) 741 flag = TTY_BREAK; 742 else if (sts & MAX310X_LSR_RXPAR_BIT) 743 flag = TTY_PARITY; 744 else if (sts & MAX310X_LSR_FRERR_BIT) 745 flag = TTY_FRAME; 746 else if (sts & MAX310X_LSR_RXOVR_BIT) 747 flag = TTY_OVERRUN; 748 } 749 750 if (uart_handle_sysrq_char(port, ch)) 751 continue; 752 753 if (sts & port->ignore_status_mask) 754 continue; 755 756 uart_insert_char(port, sts, MAX310X_LSR_RXOVR_BIT, ch, flag); 757 } 758 } 759 760 tty_flip_buffer_push(&port->state->port); 761 } 762 763 static void max310x_handle_tx(struct uart_port *port) 764 { 765 struct circ_buf *xmit = &port->state->xmit; 766 unsigned int txlen, to_send, until_end; 767 768 if (unlikely(port->x_char)) { 769 max310x_port_write(port, MAX310X_THR_REG, port->x_char); 770 port->icount.tx++; 771 port->x_char = 0; 772 return; 773 } 774 775 if (uart_circ_empty(xmit) || uart_tx_stopped(port)) 776 return; 777 778 /* Get length of data pending in circular buffer */ 779 to_send = uart_circ_chars_pending(xmit); 780 until_end = CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE); 781 if (likely(to_send)) { 782 /* Limit to size of TX FIFO */ 783 txlen = max310x_port_read(port, MAX310X_TXFIFOLVL_REG); 784 txlen = port->fifosize - txlen; 785 to_send = (to_send > txlen) ? txlen : to_send; 786 787 if (until_end < to_send) { 788 /* It's a circ buffer -- wrap around. 789 * We could do that in one SPI transaction, but meh. */ 790 max310x_batch_write(port, xmit->buf + xmit->tail, until_end); 791 max310x_batch_write(port, xmit->buf, to_send - until_end); 792 } else { 793 max310x_batch_write(port, xmit->buf + xmit->tail, to_send); 794 } 795 uart_xmit_advance(port, to_send); 796 } 797 798 if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS) 799 uart_write_wakeup(port); 800 } 801 802 static void max310x_start_tx(struct uart_port *port) 803 { 804 struct max310x_one *one = to_max310x_port(port); 805 806 schedule_work(&one->tx_work); 807 } 808 809 static irqreturn_t max310x_port_irq(struct max310x_port *s, int portno) 810 { 811 struct uart_port *port = &s->p[portno].port; 812 irqreturn_t res = IRQ_NONE; 813 814 do { 815 unsigned int ists, lsr, rxlen; 816 817 /* Read IRQ status & RX FIFO level */ 818 ists = max310x_port_read(port, MAX310X_IRQSTS_REG); 819 rxlen = max310x_port_read(port, MAX310X_RXFIFOLVL_REG); 820 if (!ists && !rxlen) 821 break; 822 823 res = IRQ_HANDLED; 824 825 if (ists & MAX310X_IRQ_CTS_BIT) { 826 lsr = max310x_port_read(port, MAX310X_LSR_IRQSTS_REG); 827 uart_handle_cts_change(port, lsr & MAX310X_LSR_CTS_BIT); 828 } 829 if (rxlen) 830 max310x_handle_rx(port, rxlen); 831 if (ists & MAX310X_IRQ_TXEMPTY_BIT) 832 max310x_start_tx(port); 833 } while (1); 834 return res; 835 } 836 837 static irqreturn_t max310x_ist(int irq, void *dev_id) 838 { 839 struct max310x_port *s = (struct max310x_port *)dev_id; 840 bool handled = false; 841 842 if (s->devtype->nr > 1) { 843 do { 844 unsigned int val = ~0; 845 846 WARN_ON_ONCE(regmap_read(s->regmap, 847 MAX310X_GLOBALIRQ_REG, &val)); 848 val = ((1 << s->devtype->nr) - 1) & ~val; 849 if (!val) 850 break; 851 if (max310x_port_irq(s, fls(val) - 1) == IRQ_HANDLED) 852 handled = true; 853 } while (1); 854 } else { 855 if (max310x_port_irq(s, 0) == IRQ_HANDLED) 856 handled = true; 857 } 858 859 return IRQ_RETVAL(handled); 860 } 861 862 static void max310x_tx_proc(struct work_struct *ws) 863 { 864 struct max310x_one *one = container_of(ws, struct max310x_one, tx_work); 865 866 max310x_handle_tx(&one->port); 867 } 868 869 static unsigned int max310x_tx_empty(struct uart_port *port) 870 { 871 u8 lvl = max310x_port_read(port, MAX310X_TXFIFOLVL_REG); 872 873 return lvl ? 0 : TIOCSER_TEMT; 874 } 875 876 static unsigned int max310x_get_mctrl(struct uart_port *port) 877 { 878 /* DCD and DSR are not wired and CTS/RTS is handled automatically 879 * so just indicate DSR and CAR asserted 880 */ 881 return TIOCM_DSR | TIOCM_CAR; 882 } 883 884 static void max310x_md_proc(struct work_struct *ws) 885 { 886 struct max310x_one *one = container_of(ws, struct max310x_one, md_work); 887 888 max310x_port_update(&one->port, MAX310X_MODE2_REG, 889 MAX310X_MODE2_LOOPBACK_BIT, 890 (one->port.mctrl & TIOCM_LOOP) ? 891 MAX310X_MODE2_LOOPBACK_BIT : 0); 892 } 893 894 static void max310x_set_mctrl(struct uart_port *port, unsigned int mctrl) 895 { 896 struct max310x_one *one = to_max310x_port(port); 897 898 schedule_work(&one->md_work); 899 } 900 901 static void max310x_break_ctl(struct uart_port *port, int break_state) 902 { 903 max310x_port_update(port, MAX310X_LCR_REG, 904 MAX310X_LCR_TXBREAK_BIT, 905 break_state ? MAX310X_LCR_TXBREAK_BIT : 0); 906 } 907 908 static void max310x_set_termios(struct uart_port *port, 909 struct ktermios *termios, 910 const struct ktermios *old) 911 { 912 unsigned int lcr = 0, flow = 0; 913 int baud; 914 915 /* Mask termios capabilities we don't support */ 916 termios->c_cflag &= ~CMSPAR; 917 918 /* Word size */ 919 switch (termios->c_cflag & CSIZE) { 920 case CS5: 921 break; 922 case CS6: 923 lcr = MAX310X_LCR_LENGTH0_BIT; 924 break; 925 case CS7: 926 lcr = MAX310X_LCR_LENGTH1_BIT; 927 break; 928 case CS8: 929 default: 930 lcr = MAX310X_LCR_LENGTH1_BIT | MAX310X_LCR_LENGTH0_BIT; 931 break; 932 } 933 934 /* Parity */ 935 if (termios->c_cflag & PARENB) { 936 lcr |= MAX310X_LCR_PARITY_BIT; 937 if (!(termios->c_cflag & PARODD)) 938 lcr |= MAX310X_LCR_EVENPARITY_BIT; 939 } 940 941 /* Stop bits */ 942 if (termios->c_cflag & CSTOPB) 943 lcr |= MAX310X_LCR_STOPLEN_BIT; /* 2 stops */ 944 945 /* Update LCR register */ 946 max310x_port_write(port, MAX310X_LCR_REG, lcr); 947 948 /* Set read status mask */ 949 port->read_status_mask = MAX310X_LSR_RXOVR_BIT; 950 if (termios->c_iflag & INPCK) 951 port->read_status_mask |= MAX310X_LSR_RXPAR_BIT | 952 MAX310X_LSR_FRERR_BIT; 953 if (termios->c_iflag & (IGNBRK | BRKINT | PARMRK)) 954 port->read_status_mask |= MAX310X_LSR_RXBRK_BIT; 955 956 /* Set status ignore mask */ 957 port->ignore_status_mask = 0; 958 if (termios->c_iflag & IGNBRK) 959 port->ignore_status_mask |= MAX310X_LSR_RXBRK_BIT; 960 if (!(termios->c_cflag & CREAD)) 961 port->ignore_status_mask |= MAX310X_LSR_RXPAR_BIT | 962 MAX310X_LSR_RXOVR_BIT | 963 MAX310X_LSR_FRERR_BIT | 964 MAX310X_LSR_RXBRK_BIT; 965 966 /* Configure flow control */ 967 max310x_port_write(port, MAX310X_XON1_REG, termios->c_cc[VSTART]); 968 max310x_port_write(port, MAX310X_XOFF1_REG, termios->c_cc[VSTOP]); 969 970 /* Disable transmitter before enabling AutoCTS or auto transmitter 971 * flow control 972 */ 973 if (termios->c_cflag & CRTSCTS || termios->c_iflag & IXOFF) { 974 max310x_port_update(port, MAX310X_MODE1_REG, 975 MAX310X_MODE1_TXDIS_BIT, 976 MAX310X_MODE1_TXDIS_BIT); 977 } 978 979 port->status &= ~(UPSTAT_AUTOCTS | UPSTAT_AUTORTS | UPSTAT_AUTOXOFF); 980 981 if (termios->c_cflag & CRTSCTS) { 982 /* Enable AUTORTS and AUTOCTS */ 983 port->status |= UPSTAT_AUTOCTS | UPSTAT_AUTORTS; 984 flow |= MAX310X_FLOWCTRL_AUTOCTS_BIT | 985 MAX310X_FLOWCTRL_AUTORTS_BIT; 986 } 987 if (termios->c_iflag & IXON) 988 flow |= MAX310X_FLOWCTRL_SWFLOW3_BIT | 989 MAX310X_FLOWCTRL_SWFLOWEN_BIT; 990 if (termios->c_iflag & IXOFF) { 991 port->status |= UPSTAT_AUTOXOFF; 992 flow |= MAX310X_FLOWCTRL_SWFLOW1_BIT | 993 MAX310X_FLOWCTRL_SWFLOWEN_BIT; 994 } 995 max310x_port_write(port, MAX310X_FLOWCTRL_REG, flow); 996 997 /* Enable transmitter after disabling AutoCTS and auto transmitter 998 * flow control 999 */ 1000 if (!(termios->c_cflag & CRTSCTS) && !(termios->c_iflag & IXOFF)) { 1001 max310x_port_update(port, MAX310X_MODE1_REG, 1002 MAX310X_MODE1_TXDIS_BIT, 1003 0); 1004 } 1005 1006 /* Get baud rate generator configuration */ 1007 baud = uart_get_baud_rate(port, termios, old, 1008 port->uartclk / 16 / 0xffff, 1009 port->uartclk / 4); 1010 1011 /* Setup baudrate generator */ 1012 baud = max310x_set_baud(port, baud); 1013 1014 /* Update timeout according to new baud rate */ 1015 uart_update_timeout(port, termios->c_cflag, baud); 1016 } 1017 1018 static void max310x_rs_proc(struct work_struct *ws) 1019 { 1020 struct max310x_one *one = container_of(ws, struct max310x_one, rs_work); 1021 unsigned int delay, mode1 = 0, mode2 = 0; 1022 1023 delay = (one->port.rs485.delay_rts_before_send << 4) | 1024 one->port.rs485.delay_rts_after_send; 1025 max310x_port_write(&one->port, MAX310X_HDPIXDELAY_REG, delay); 1026 1027 if (one->port.rs485.flags & SER_RS485_ENABLED) { 1028 mode1 = MAX310X_MODE1_TRNSCVCTRL_BIT; 1029 1030 if (!(one->port.rs485.flags & SER_RS485_RX_DURING_TX)) 1031 mode2 = MAX310X_MODE2_ECHOSUPR_BIT; 1032 } 1033 1034 max310x_port_update(&one->port, MAX310X_MODE1_REG, 1035 MAX310X_MODE1_TRNSCVCTRL_BIT, mode1); 1036 max310x_port_update(&one->port, MAX310X_MODE2_REG, 1037 MAX310X_MODE2_ECHOSUPR_BIT, mode2); 1038 } 1039 1040 static int max310x_rs485_config(struct uart_port *port, struct ktermios *termios, 1041 struct serial_rs485 *rs485) 1042 { 1043 struct max310x_one *one = to_max310x_port(port); 1044 1045 if ((rs485->delay_rts_before_send > 0x0f) || 1046 (rs485->delay_rts_after_send > 0x0f)) 1047 return -ERANGE; 1048 1049 port->rs485 = *rs485; 1050 1051 schedule_work(&one->rs_work); 1052 1053 return 0; 1054 } 1055 1056 static int max310x_startup(struct uart_port *port) 1057 { 1058 struct max310x_port *s = dev_get_drvdata(port->dev); 1059 unsigned int val; 1060 1061 s->devtype->power(port, 1); 1062 1063 /* Configure MODE1 register */ 1064 max310x_port_update(port, MAX310X_MODE1_REG, 1065 MAX310X_MODE1_TRNSCVCTRL_BIT, 0); 1066 1067 /* Configure MODE2 register & Reset FIFOs*/ 1068 val = MAX310X_MODE2_RXEMPTINV_BIT | MAX310X_MODE2_FIFORST_BIT; 1069 max310x_port_write(port, MAX310X_MODE2_REG, val); 1070 max310x_port_update(port, MAX310X_MODE2_REG, 1071 MAX310X_MODE2_FIFORST_BIT, 0); 1072 1073 /* Configure mode1/mode2 to have rs485/rs232 enabled at startup */ 1074 val = (clamp(port->rs485.delay_rts_before_send, 0U, 15U) << 4) | 1075 clamp(port->rs485.delay_rts_after_send, 0U, 15U); 1076 max310x_port_write(port, MAX310X_HDPIXDELAY_REG, val); 1077 1078 if (port->rs485.flags & SER_RS485_ENABLED) { 1079 max310x_port_update(port, MAX310X_MODE1_REG, 1080 MAX310X_MODE1_TRNSCVCTRL_BIT, 1081 MAX310X_MODE1_TRNSCVCTRL_BIT); 1082 1083 if (!(port->rs485.flags & SER_RS485_RX_DURING_TX)) 1084 max310x_port_update(port, MAX310X_MODE2_REG, 1085 MAX310X_MODE2_ECHOSUPR_BIT, 1086 MAX310X_MODE2_ECHOSUPR_BIT); 1087 } 1088 1089 /* Configure flow control levels */ 1090 /* Flow control halt level 96, resume level 48 */ 1091 max310x_port_write(port, MAX310X_FLOWLVL_REG, 1092 MAX310X_FLOWLVL_RES(48) | MAX310X_FLOWLVL_HALT(96)); 1093 1094 /* Clear IRQ status register */ 1095 max310x_port_read(port, MAX310X_IRQSTS_REG); 1096 1097 /* Enable RX, TX, CTS change interrupts */ 1098 val = MAX310X_IRQ_RXEMPTY_BIT | MAX310X_IRQ_TXEMPTY_BIT; 1099 max310x_port_write(port, MAX310X_IRQEN_REG, val | MAX310X_IRQ_CTS_BIT); 1100 1101 return 0; 1102 } 1103 1104 static void max310x_shutdown(struct uart_port *port) 1105 { 1106 struct max310x_port *s = dev_get_drvdata(port->dev); 1107 1108 /* Disable all interrupts */ 1109 max310x_port_write(port, MAX310X_IRQEN_REG, 0); 1110 1111 s->devtype->power(port, 0); 1112 } 1113 1114 static const char *max310x_type(struct uart_port *port) 1115 { 1116 struct max310x_port *s = dev_get_drvdata(port->dev); 1117 1118 return (port->type == PORT_MAX310X) ? s->devtype->name : NULL; 1119 } 1120 1121 static int max310x_request_port(struct uart_port *port) 1122 { 1123 /* Do nothing */ 1124 return 0; 1125 } 1126 1127 static void max310x_config_port(struct uart_port *port, int flags) 1128 { 1129 if (flags & UART_CONFIG_TYPE) 1130 port->type = PORT_MAX310X; 1131 } 1132 1133 static int max310x_verify_port(struct uart_port *port, struct serial_struct *s) 1134 { 1135 if ((s->type != PORT_UNKNOWN) && (s->type != PORT_MAX310X)) 1136 return -EINVAL; 1137 if (s->irq != port->irq) 1138 return -EINVAL; 1139 1140 return 0; 1141 } 1142 1143 static void max310x_null_void(struct uart_port *port) 1144 { 1145 /* Do nothing */ 1146 } 1147 1148 static const struct uart_ops max310x_ops = { 1149 .tx_empty = max310x_tx_empty, 1150 .set_mctrl = max310x_set_mctrl, 1151 .get_mctrl = max310x_get_mctrl, 1152 .stop_tx = max310x_null_void, 1153 .start_tx = max310x_start_tx, 1154 .stop_rx = max310x_null_void, 1155 .break_ctl = max310x_break_ctl, 1156 .startup = max310x_startup, 1157 .shutdown = max310x_shutdown, 1158 .set_termios = max310x_set_termios, 1159 .type = max310x_type, 1160 .request_port = max310x_request_port, 1161 .release_port = max310x_null_void, 1162 .config_port = max310x_config_port, 1163 .verify_port = max310x_verify_port, 1164 }; 1165 1166 static int __maybe_unused max310x_suspend(struct device *dev) 1167 { 1168 struct max310x_port *s = dev_get_drvdata(dev); 1169 int i; 1170 1171 for (i = 0; i < s->devtype->nr; i++) { 1172 uart_suspend_port(&max310x_uart, &s->p[i].port); 1173 s->devtype->power(&s->p[i].port, 0); 1174 } 1175 1176 return 0; 1177 } 1178 1179 static int __maybe_unused max310x_resume(struct device *dev) 1180 { 1181 struct max310x_port *s = dev_get_drvdata(dev); 1182 int i; 1183 1184 for (i = 0; i < s->devtype->nr; i++) { 1185 s->devtype->power(&s->p[i].port, 1); 1186 uart_resume_port(&max310x_uart, &s->p[i].port); 1187 } 1188 1189 return 0; 1190 } 1191 1192 static SIMPLE_DEV_PM_OPS(max310x_pm_ops, max310x_suspend, max310x_resume); 1193 1194 #ifdef CONFIG_GPIOLIB 1195 static int max310x_gpio_get(struct gpio_chip *chip, unsigned offset) 1196 { 1197 unsigned int val; 1198 struct max310x_port *s = gpiochip_get_data(chip); 1199 struct uart_port *port = &s->p[offset / 4].port; 1200 1201 val = max310x_port_read(port, MAX310X_GPIODATA_REG); 1202 1203 return !!((val >> 4) & (1 << (offset % 4))); 1204 } 1205 1206 static void max310x_gpio_set(struct gpio_chip *chip, unsigned offset, int value) 1207 { 1208 struct max310x_port *s = gpiochip_get_data(chip); 1209 struct uart_port *port = &s->p[offset / 4].port; 1210 1211 max310x_port_update(port, MAX310X_GPIODATA_REG, 1 << (offset % 4), 1212 value ? 1 << (offset % 4) : 0); 1213 } 1214 1215 static int max310x_gpio_direction_input(struct gpio_chip *chip, unsigned offset) 1216 { 1217 struct max310x_port *s = gpiochip_get_data(chip); 1218 struct uart_port *port = &s->p[offset / 4].port; 1219 1220 max310x_port_update(port, MAX310X_GPIOCFG_REG, 1 << (offset % 4), 0); 1221 1222 return 0; 1223 } 1224 1225 static int max310x_gpio_direction_output(struct gpio_chip *chip, 1226 unsigned offset, int value) 1227 { 1228 struct max310x_port *s = gpiochip_get_data(chip); 1229 struct uart_port *port = &s->p[offset / 4].port; 1230 1231 max310x_port_update(port, MAX310X_GPIODATA_REG, 1 << (offset % 4), 1232 value ? 1 << (offset % 4) : 0); 1233 max310x_port_update(port, MAX310X_GPIOCFG_REG, 1 << (offset % 4), 1234 1 << (offset % 4)); 1235 1236 return 0; 1237 } 1238 1239 static int max310x_gpio_set_config(struct gpio_chip *chip, unsigned int offset, 1240 unsigned long config) 1241 { 1242 struct max310x_port *s = gpiochip_get_data(chip); 1243 struct uart_port *port = &s->p[offset / 4].port; 1244 1245 switch (pinconf_to_config_param(config)) { 1246 case PIN_CONFIG_DRIVE_OPEN_DRAIN: 1247 max310x_port_update(port, MAX310X_GPIOCFG_REG, 1248 1 << ((offset % 4) + 4), 1249 1 << ((offset % 4) + 4)); 1250 return 0; 1251 case PIN_CONFIG_DRIVE_PUSH_PULL: 1252 max310x_port_update(port, MAX310X_GPIOCFG_REG, 1253 1 << ((offset % 4) + 4), 0); 1254 return 0; 1255 default: 1256 return -ENOTSUPP; 1257 } 1258 } 1259 #endif 1260 1261 static const struct serial_rs485 max310x_rs485_supported = { 1262 .flags = SER_RS485_ENABLED | SER_RS485_RTS_ON_SEND | SER_RS485_RX_DURING_TX, 1263 .delay_rts_before_send = 1, 1264 .delay_rts_after_send = 1, 1265 }; 1266 1267 static int max310x_probe(struct device *dev, const struct max310x_devtype *devtype, 1268 const struct max310x_if_cfg *if_cfg, 1269 struct regmap *regmaps[], int irq) 1270 { 1271 int i, ret, fmin, fmax, freq; 1272 struct max310x_port *s; 1273 u32 uartclk = 0; 1274 bool xtal; 1275 1276 for (i = 0; i < devtype->nr; i++) 1277 if (IS_ERR(regmaps[i])) 1278 return PTR_ERR(regmaps[i]); 1279 1280 /* Alloc port structure */ 1281 s = devm_kzalloc(dev, struct_size(s, p, devtype->nr), GFP_KERNEL); 1282 if (!s) { 1283 dev_err(dev, "Error allocating port structure\n"); 1284 return -ENOMEM; 1285 } 1286 1287 /* Always ask for fixed clock rate from a property. */ 1288 device_property_read_u32(dev, "clock-frequency", &uartclk); 1289 1290 xtal = device_property_match_string(dev, "clock-names", "osc") < 0; 1291 if (xtal) 1292 s->clk = devm_clk_get_optional(dev, "xtal"); 1293 else 1294 s->clk = devm_clk_get_optional(dev, "osc"); 1295 if (IS_ERR(s->clk)) 1296 return PTR_ERR(s->clk); 1297 1298 ret = clk_prepare_enable(s->clk); 1299 if (ret) 1300 return ret; 1301 1302 freq = clk_get_rate(s->clk); 1303 if (freq == 0) 1304 freq = uartclk; 1305 if (freq == 0) { 1306 dev_err(dev, "Cannot get clock rate\n"); 1307 ret = -EINVAL; 1308 goto out_clk; 1309 } 1310 1311 if (xtal) { 1312 fmin = 1000000; 1313 fmax = 4000000; 1314 } else { 1315 fmin = 500000; 1316 fmax = 35000000; 1317 } 1318 1319 /* Check frequency limits */ 1320 if (freq < fmin || freq > fmax) { 1321 ret = -ERANGE; 1322 goto out_clk; 1323 } 1324 1325 s->regmap = regmaps[0]; 1326 s->devtype = devtype; 1327 s->if_cfg = if_cfg; 1328 dev_set_drvdata(dev, s); 1329 1330 /* Check device to ensure we are talking to what we expect */ 1331 ret = devtype->detect(dev); 1332 if (ret) 1333 goto out_clk; 1334 1335 for (i = 0; i < devtype->nr; i++) { 1336 /* Reset port */ 1337 regmap_write(regmaps[i], MAX310X_MODE2_REG, 1338 MAX310X_MODE2_RST_BIT); 1339 /* Clear port reset */ 1340 regmap_write(regmaps[i], MAX310X_MODE2_REG, 0); 1341 1342 /* Wait for port startup */ 1343 do { 1344 regmap_read(regmaps[i], MAX310X_BRGDIVLSB_REG, &ret); 1345 } while (ret != 0x01); 1346 1347 regmap_write(regmaps[i], MAX310X_MODE1_REG, devtype->mode1); 1348 } 1349 1350 uartclk = max310x_set_ref_clk(dev, s, freq, xtal); 1351 dev_dbg(dev, "Reference clock set to %i Hz\n", uartclk); 1352 1353 for (i = 0; i < devtype->nr; i++) { 1354 unsigned int line; 1355 1356 line = find_first_zero_bit(max310x_lines, MAX310X_UART_NRMAX); 1357 if (line == MAX310X_UART_NRMAX) { 1358 ret = -ERANGE; 1359 goto out_uart; 1360 } 1361 1362 /* Initialize port data */ 1363 s->p[i].port.line = line; 1364 s->p[i].port.dev = dev; 1365 s->p[i].port.irq = irq; 1366 s->p[i].port.type = PORT_MAX310X; 1367 s->p[i].port.fifosize = MAX310X_FIFO_SIZE; 1368 s->p[i].port.flags = UPF_FIXED_TYPE | UPF_LOW_LATENCY; 1369 s->p[i].port.iotype = UPIO_PORT; 1370 s->p[i].port.iobase = i; 1371 s->p[i].port.membase = (void __iomem *)~0; 1372 s->p[i].port.uartclk = uartclk; 1373 s->p[i].port.rs485_config = max310x_rs485_config; 1374 s->p[i].port.rs485_supported = max310x_rs485_supported; 1375 s->p[i].port.ops = &max310x_ops; 1376 s->p[i].regmap = regmaps[i]; 1377 1378 /* Disable all interrupts */ 1379 max310x_port_write(&s->p[i].port, MAX310X_IRQEN_REG, 0); 1380 /* Clear IRQ status register */ 1381 max310x_port_read(&s->p[i].port, MAX310X_IRQSTS_REG); 1382 /* Initialize queue for start TX */ 1383 INIT_WORK(&s->p[i].tx_work, max310x_tx_proc); 1384 /* Initialize queue for changing LOOPBACK mode */ 1385 INIT_WORK(&s->p[i].md_work, max310x_md_proc); 1386 /* Initialize queue for changing RS485 mode */ 1387 INIT_WORK(&s->p[i].rs_work, max310x_rs_proc); 1388 1389 /* Register port */ 1390 ret = uart_add_one_port(&max310x_uart, &s->p[i].port); 1391 if (ret) { 1392 s->p[i].port.dev = NULL; 1393 goto out_uart; 1394 } 1395 set_bit(line, max310x_lines); 1396 1397 /* Go to suspend mode */ 1398 devtype->power(&s->p[i].port, 0); 1399 } 1400 1401 #ifdef CONFIG_GPIOLIB 1402 /* Setup GPIO cotroller */ 1403 s->gpio.owner = THIS_MODULE; 1404 s->gpio.parent = dev; 1405 s->gpio.label = devtype->name; 1406 s->gpio.direction_input = max310x_gpio_direction_input; 1407 s->gpio.get = max310x_gpio_get; 1408 s->gpio.direction_output= max310x_gpio_direction_output; 1409 s->gpio.set = max310x_gpio_set; 1410 s->gpio.set_config = max310x_gpio_set_config; 1411 s->gpio.base = -1; 1412 s->gpio.ngpio = devtype->nr * 4; 1413 s->gpio.can_sleep = 1; 1414 ret = devm_gpiochip_add_data(dev, &s->gpio, s); 1415 if (ret) 1416 goto out_uart; 1417 #endif 1418 1419 /* Setup interrupt */ 1420 ret = devm_request_threaded_irq(dev, irq, NULL, max310x_ist, 1421 IRQF_ONESHOT | IRQF_SHARED, dev_name(dev), s); 1422 if (!ret) 1423 return 0; 1424 1425 dev_err(dev, "Unable to reguest IRQ %i\n", irq); 1426 1427 out_uart: 1428 for (i = 0; i < devtype->nr; i++) { 1429 if (s->p[i].port.dev) { 1430 uart_remove_one_port(&max310x_uart, &s->p[i].port); 1431 clear_bit(s->p[i].port.line, max310x_lines); 1432 } 1433 } 1434 1435 out_clk: 1436 clk_disable_unprepare(s->clk); 1437 1438 return ret; 1439 } 1440 1441 static void max310x_remove(struct device *dev) 1442 { 1443 struct max310x_port *s = dev_get_drvdata(dev); 1444 int i; 1445 1446 for (i = 0; i < s->devtype->nr; i++) { 1447 cancel_work_sync(&s->p[i].tx_work); 1448 cancel_work_sync(&s->p[i].md_work); 1449 cancel_work_sync(&s->p[i].rs_work); 1450 uart_remove_one_port(&max310x_uart, &s->p[i].port); 1451 clear_bit(s->p[i].port.line, max310x_lines); 1452 s->devtype->power(&s->p[i].port, 0); 1453 } 1454 1455 clk_disable_unprepare(s->clk); 1456 } 1457 1458 static const struct of_device_id __maybe_unused max310x_dt_ids[] = { 1459 { .compatible = "maxim,max3107", .data = &max3107_devtype, }, 1460 { .compatible = "maxim,max3108", .data = &max3108_devtype, }, 1461 { .compatible = "maxim,max3109", .data = &max3109_devtype, }, 1462 { .compatible = "maxim,max14830", .data = &max14830_devtype }, 1463 { } 1464 }; 1465 MODULE_DEVICE_TABLE(of, max310x_dt_ids); 1466 1467 static struct regmap_config regcfg = { 1468 .reg_bits = 8, 1469 .val_bits = 8, 1470 .write_flag_mask = MAX310X_WRITE_BIT, 1471 .cache_type = REGCACHE_RBTREE, 1472 .max_register = MAX310X_REG_1F, 1473 .writeable_reg = max310x_reg_writeable, 1474 .volatile_reg = max310x_reg_volatile, 1475 .precious_reg = max310x_reg_precious, 1476 .writeable_noinc_reg = max310x_reg_noinc, 1477 .readable_noinc_reg = max310x_reg_noinc, 1478 .max_raw_read = MAX310X_FIFO_SIZE, 1479 .max_raw_write = MAX310X_FIFO_SIZE, 1480 }; 1481 1482 #ifdef CONFIG_SPI_MASTER 1483 static int max310x_spi_extended_reg_enable(struct device *dev, bool enable) 1484 { 1485 struct max310x_port *s = dev_get_drvdata(dev); 1486 1487 return regmap_write(s->regmap, MAX310X_GLOBALCMD_REG, 1488 enable ? MAX310X_EXTREG_ENBL : MAX310X_EXTREG_DSBL); 1489 } 1490 1491 static const struct max310x_if_cfg __maybe_unused max310x_spi_if_cfg = { 1492 .extended_reg_enable = max310x_spi_extended_reg_enable, 1493 .rev_id_reg = MAX310X_SPI_REVID_EXTREG, 1494 }; 1495 1496 static int max310x_spi_probe(struct spi_device *spi) 1497 { 1498 const struct max310x_devtype *devtype; 1499 struct regmap *regmaps[4]; 1500 unsigned int i; 1501 int ret; 1502 1503 /* Setup SPI bus */ 1504 spi->bits_per_word = 8; 1505 spi->mode = spi->mode ? : SPI_MODE_0; 1506 spi->max_speed_hz = spi->max_speed_hz ? : 26000000; 1507 ret = spi_setup(spi); 1508 if (ret) 1509 return ret; 1510 1511 devtype = device_get_match_data(&spi->dev); 1512 if (!devtype) 1513 devtype = (struct max310x_devtype *)spi_get_device_id(spi)->driver_data; 1514 1515 for (i = 0; i < devtype->nr; i++) { 1516 u8 port_mask = i * 0x20; 1517 regcfg.read_flag_mask = port_mask; 1518 regcfg.write_flag_mask = port_mask | MAX310X_WRITE_BIT; 1519 regmaps[i] = devm_regmap_init_spi(spi, ®cfg); 1520 } 1521 1522 return max310x_probe(&spi->dev, devtype, &max310x_spi_if_cfg, regmaps, spi->irq); 1523 } 1524 1525 static void max310x_spi_remove(struct spi_device *spi) 1526 { 1527 max310x_remove(&spi->dev); 1528 } 1529 1530 static const struct spi_device_id max310x_id_table[] = { 1531 { "max3107", (kernel_ulong_t)&max3107_devtype, }, 1532 { "max3108", (kernel_ulong_t)&max3108_devtype, }, 1533 { "max3109", (kernel_ulong_t)&max3109_devtype, }, 1534 { "max14830", (kernel_ulong_t)&max14830_devtype, }, 1535 { } 1536 }; 1537 MODULE_DEVICE_TABLE(spi, max310x_id_table); 1538 1539 static struct spi_driver max310x_spi_driver = { 1540 .driver = { 1541 .name = MAX310X_NAME, 1542 .of_match_table = max310x_dt_ids, 1543 .pm = &max310x_pm_ops, 1544 }, 1545 .probe = max310x_spi_probe, 1546 .remove = max310x_spi_remove, 1547 .id_table = max310x_id_table, 1548 }; 1549 #endif 1550 1551 #ifdef CONFIG_I2C 1552 static int max310x_i2c_extended_reg_enable(struct device *dev, bool enable) 1553 { 1554 return 0; 1555 } 1556 1557 static struct regmap_config regcfg_i2c = { 1558 .reg_bits = 8, 1559 .val_bits = 8, 1560 .cache_type = REGCACHE_RBTREE, 1561 .writeable_reg = max310x_reg_writeable, 1562 .volatile_reg = max310x_reg_volatile, 1563 .precious_reg = max310x_reg_precious, 1564 .max_register = MAX310X_I2C_REVID_EXTREG, 1565 .writeable_noinc_reg = max310x_reg_noinc, 1566 .readable_noinc_reg = max310x_reg_noinc, 1567 .max_raw_read = MAX310X_FIFO_SIZE, 1568 .max_raw_write = MAX310X_FIFO_SIZE, 1569 }; 1570 1571 static const struct max310x_if_cfg max310x_i2c_if_cfg = { 1572 .extended_reg_enable = max310x_i2c_extended_reg_enable, 1573 .rev_id_reg = MAX310X_I2C_REVID_EXTREG, 1574 }; 1575 1576 static unsigned short max310x_i2c_slave_addr(unsigned short addr, 1577 unsigned int nr) 1578 { 1579 /* 1580 * For MAX14830 and MAX3109, the slave address depends on what the 1581 * A0 and A1 pins are tied to. 1582 * See Table I2C Address Map of the datasheet. 1583 * Based on that table, the following formulas were determined. 1584 * UART1 - UART0 = 0x10 1585 * UART2 - UART1 = 0x20 + 0x10 1586 * UART3 - UART2 = 0x10 1587 */ 1588 1589 addr -= nr * 0x10; 1590 1591 if (nr >= 2) 1592 addr -= 0x20; 1593 1594 return addr; 1595 } 1596 1597 static int max310x_i2c_probe(struct i2c_client *client) 1598 { 1599 const struct max310x_devtype *devtype = 1600 device_get_match_data(&client->dev); 1601 struct i2c_client *port_client; 1602 struct regmap *regmaps[4]; 1603 unsigned int i; 1604 u8 port_addr; 1605 1606 if (client->addr < devtype->slave_addr.min || 1607 client->addr > devtype->slave_addr.max) 1608 return dev_err_probe(&client->dev, -EINVAL, 1609 "Slave addr 0x%x outside of range [0x%x, 0x%x]\n", 1610 client->addr, devtype->slave_addr.min, 1611 devtype->slave_addr.max); 1612 1613 regmaps[0] = devm_regmap_init_i2c(client, ®cfg_i2c); 1614 1615 for (i = 1; i < devtype->nr; i++) { 1616 port_addr = max310x_i2c_slave_addr(client->addr, i); 1617 port_client = devm_i2c_new_dummy_device(&client->dev, 1618 client->adapter, 1619 port_addr); 1620 1621 regmaps[i] = devm_regmap_init_i2c(port_client, ®cfg_i2c); 1622 } 1623 1624 return max310x_probe(&client->dev, devtype, &max310x_i2c_if_cfg, 1625 regmaps, client->irq); 1626 } 1627 1628 static void max310x_i2c_remove(struct i2c_client *client) 1629 { 1630 max310x_remove(&client->dev); 1631 } 1632 1633 static struct i2c_driver max310x_i2c_driver = { 1634 .driver = { 1635 .name = MAX310X_NAME, 1636 .of_match_table = max310x_dt_ids, 1637 .pm = &max310x_pm_ops, 1638 }, 1639 .probe_new = max310x_i2c_probe, 1640 .remove = max310x_i2c_remove, 1641 }; 1642 #endif 1643 1644 static int __init max310x_uart_init(void) 1645 { 1646 int ret; 1647 1648 bitmap_zero(max310x_lines, MAX310X_UART_NRMAX); 1649 1650 ret = uart_register_driver(&max310x_uart); 1651 if (ret) 1652 return ret; 1653 1654 #ifdef CONFIG_SPI_MASTER 1655 ret = spi_register_driver(&max310x_spi_driver); 1656 if (ret) 1657 goto err_spi_register; 1658 #endif 1659 1660 #ifdef CONFIG_I2C 1661 ret = i2c_add_driver(&max310x_i2c_driver); 1662 if (ret) 1663 goto err_i2c_register; 1664 #endif 1665 1666 return 0; 1667 1668 #ifdef CONFIG_I2C 1669 err_i2c_register: 1670 spi_unregister_driver(&max310x_spi_driver); 1671 #endif 1672 1673 err_spi_register: 1674 uart_unregister_driver(&max310x_uart); 1675 1676 return ret; 1677 } 1678 module_init(max310x_uart_init); 1679 1680 static void __exit max310x_uart_exit(void) 1681 { 1682 #ifdef CONFIG_I2C 1683 i2c_del_driver(&max310x_i2c_driver); 1684 #endif 1685 1686 #ifdef CONFIG_SPI_MASTER 1687 spi_unregister_driver(&max310x_spi_driver); 1688 #endif 1689 1690 uart_unregister_driver(&max310x_uart); 1691 } 1692 module_exit(max310x_uart_exit); 1693 1694 MODULE_LICENSE("GPL"); 1695 MODULE_AUTHOR("Alexander Shiyan <shc_work@mail.ru>"); 1696 MODULE_DESCRIPTION("MAX310X serial driver"); 1697