max310x.c 41.1 KB
Newer Older
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 8 9 10 11
 *
 *  Based on max3100.c, by Christian Pellegrin <chripell@evolware.org>
 *  Based on max3110.c, by Feng Tang <feng.tang@intel.com>
 *  Based on max3107.c, by Aavamobile
 */

12
#include <linux/bitops.h>
13
#include <linux/clk.h>
14 15
#include <linux/delay.h>
#include <linux/device.h>
16
#include <linux/gpio/driver.h>
17
#include <linux/module.h>
18 19
#include <linux/of.h>
#include <linux/of_device.h>
20
#include <linux/regmap.h>
21 22 23 24
#include <linux/serial_core.h>
#include <linux/serial.h>
#include <linux/tty.h>
#include <linux/tty_flip.h>
25
#include <linux/spi/spi.h>
26
#include <linux/uaccess.h>
27 28

#define MAX310X_NAME			"max310x"
29 30
#define MAX310X_MAJOR			204
#define MAX310X_MINOR			209
31
#define MAX310X_UART_NRMAX		16
32 33 34 35 36 37 38 39

/* MAX310X register definitions */
#define MAX310X_RHR_REG			(0x00) /* RX FIFO */
#define MAX310X_THR_REG			(0x00) /* TX FIFO */
#define MAX310X_IRQEN_REG		(0x01) /* IRQ enable */
#define MAX310X_IRQSTS_REG		(0x02) /* IRQ status */
#define MAX310X_LSR_IRQEN_REG		(0x03) /* LSR IRQ enable */
#define MAX310X_LSR_IRQSTS_REG		(0x04) /* LSR IRQ status */
40 41
#define MAX310X_REG_05			(0x05)
#define MAX310X_SPCHR_IRQEN_REG		MAX310X_REG_05 /* Special char IRQ en */
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
#define MAX310X_SPCHR_IRQSTS_REG	(0x06) /* Special char IRQ status */
#define MAX310X_STS_IRQEN_REG		(0x07) /* Status IRQ enable */
#define MAX310X_STS_IRQSTS_REG		(0x08) /* Status IRQ status */
#define MAX310X_MODE1_REG		(0x09) /* MODE1 */
#define MAX310X_MODE2_REG		(0x0a) /* MODE2 */
#define MAX310X_LCR_REG			(0x0b) /* LCR */
#define MAX310X_RXTO_REG		(0x0c) /* RX timeout */
#define MAX310X_HDPIXDELAY_REG		(0x0d) /* Auto transceiver delays */
#define MAX310X_IRDA_REG		(0x0e) /* IRDA settings */
#define MAX310X_FLOWLVL_REG		(0x0f) /* Flow control levels */
#define MAX310X_FIFOTRIGLVL_REG		(0x10) /* FIFO IRQ trigger levels */
#define MAX310X_TXFIFOLVL_REG		(0x11) /* TX FIFO level */
#define MAX310X_RXFIFOLVL_REG		(0x12) /* RX FIFO level */
#define MAX310X_FLOWCTRL_REG		(0x13) /* Flow control */
#define MAX310X_XON1_REG		(0x14) /* XON1 character */
#define MAX310X_XON2_REG		(0x15) /* XON2 character */
#define MAX310X_XOFF1_REG		(0x16) /* XOFF1 character */
#define MAX310X_XOFF2_REG		(0x17) /* XOFF2 character */
#define MAX310X_GPIOCFG_REG		(0x18) /* GPIO config */
#define MAX310X_GPIODATA_REG		(0x19) /* GPIO data */
#define MAX310X_PLLCFG_REG		(0x1a) /* PLL config */
#define MAX310X_BRGCFG_REG		(0x1b) /* Baud rate generator conf */
#define MAX310X_BRGDIVLSB_REG		(0x1c) /* Baud rate divisor LSB */
#define MAX310X_BRGDIVMSB_REG		(0x1d) /* Baud rate divisor MSB */
#define MAX310X_CLKSRC_REG		(0x1e) /* Clock source */
67 68 69 70 71 72 73 74 75
#define MAX310X_REG_1F			(0x1f)

#define MAX310X_REVID_REG		MAX310X_REG_1F /* Revision ID */

#define MAX310X_GLOBALIRQ_REG		MAX310X_REG_1F /* Global IRQ (RO) */
#define MAX310X_GLOBALCMD_REG		MAX310X_REG_1F /* Global Command (WO) */

/* Extended registers */
#define MAX310X_REVID_EXTREG		MAX310X_REG_05 /* Revision ID */
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228

/* IRQ register bits */
#define MAX310X_IRQ_LSR_BIT		(1 << 0) /* LSR interrupt */
#define MAX310X_IRQ_SPCHR_BIT		(1 << 1) /* Special char interrupt */
#define MAX310X_IRQ_STS_BIT		(1 << 2) /* Status interrupt */
#define MAX310X_IRQ_RXFIFO_BIT		(1 << 3) /* RX FIFO interrupt */
#define MAX310X_IRQ_TXFIFO_BIT		(1 << 4) /* TX FIFO interrupt */
#define MAX310X_IRQ_TXEMPTY_BIT		(1 << 5) /* TX FIFO empty interrupt */
#define MAX310X_IRQ_RXEMPTY_BIT		(1 << 6) /* RX FIFO empty interrupt */
#define MAX310X_IRQ_CTS_BIT		(1 << 7) /* CTS interrupt */

/* LSR register bits */
#define MAX310X_LSR_RXTO_BIT		(1 << 0) /* RX timeout */
#define MAX310X_LSR_RXOVR_BIT		(1 << 1) /* RX overrun */
#define MAX310X_LSR_RXPAR_BIT		(1 << 2) /* RX parity error */
#define MAX310X_LSR_FRERR_BIT		(1 << 3) /* Frame error */
#define MAX310X_LSR_RXBRK_BIT		(1 << 4) /* RX break */
#define MAX310X_LSR_RXNOISE_BIT		(1 << 5) /* RX noise */
#define MAX310X_LSR_CTS_BIT		(1 << 7) /* CTS pin state */

/* Special character register bits */
#define MAX310X_SPCHR_XON1_BIT		(1 << 0) /* XON1 character */
#define MAX310X_SPCHR_XON2_BIT		(1 << 1) /* XON2 character */
#define MAX310X_SPCHR_XOFF1_BIT		(1 << 2) /* XOFF1 character */
#define MAX310X_SPCHR_XOFF2_BIT		(1 << 3) /* XOFF2 character */
#define MAX310X_SPCHR_BREAK_BIT		(1 << 4) /* RX break */
#define MAX310X_SPCHR_MULTIDROP_BIT	(1 << 5) /* 9-bit multidrop addr char */

/* Status register bits */
#define MAX310X_STS_GPIO0_BIT		(1 << 0) /* GPIO 0 interrupt */
#define MAX310X_STS_GPIO1_BIT		(1 << 1) /* GPIO 1 interrupt */
#define MAX310X_STS_GPIO2_BIT		(1 << 2) /* GPIO 2 interrupt */
#define MAX310X_STS_GPIO3_BIT		(1 << 3) /* GPIO 3 interrupt */
#define MAX310X_STS_CLKREADY_BIT	(1 << 5) /* Clock ready */
#define MAX310X_STS_SLEEP_BIT		(1 << 6) /* Sleep interrupt */

/* MODE1 register bits */
#define MAX310X_MODE1_RXDIS_BIT		(1 << 0) /* RX disable */
#define MAX310X_MODE1_TXDIS_BIT		(1 << 1) /* TX disable */
#define MAX310X_MODE1_TXHIZ_BIT		(1 << 2) /* TX pin three-state */
#define MAX310X_MODE1_RTSHIZ_BIT	(1 << 3) /* RTS pin three-state */
#define MAX310X_MODE1_TRNSCVCTRL_BIT	(1 << 4) /* Transceiver ctrl enable */
#define MAX310X_MODE1_FORCESLEEP_BIT	(1 << 5) /* Force sleep mode */
#define MAX310X_MODE1_AUTOSLEEP_BIT	(1 << 6) /* Auto sleep enable */
#define MAX310X_MODE1_IRQSEL_BIT	(1 << 7) /* IRQ pin enable */

/* MODE2 register bits */
#define MAX310X_MODE2_RST_BIT		(1 << 0) /* Chip reset */
#define MAX310X_MODE2_FIFORST_BIT	(1 << 1) /* FIFO reset */
#define MAX310X_MODE2_RXTRIGINV_BIT	(1 << 2) /* RX FIFO INT invert */
#define MAX310X_MODE2_RXEMPTINV_BIT	(1 << 3) /* RX FIFO empty INT invert */
#define MAX310X_MODE2_SPCHR_BIT		(1 << 4) /* Special chr detect enable */
#define MAX310X_MODE2_LOOPBACK_BIT	(1 << 5) /* Internal loopback enable */
#define MAX310X_MODE2_MULTIDROP_BIT	(1 << 6) /* 9-bit multidrop enable */
#define MAX310X_MODE2_ECHOSUPR_BIT	(1 << 7) /* ECHO suppression enable */

/* LCR register bits */
#define MAX310X_LCR_LENGTH0_BIT		(1 << 0) /* Word length bit 0 */
#define MAX310X_LCR_LENGTH1_BIT		(1 << 1) /* Word length bit 1
						  *
						  * Word length bits table:
						  * 00 -> 5 bit words
						  * 01 -> 6 bit words
						  * 10 -> 7 bit words
						  * 11 -> 8 bit words
						  */
#define MAX310X_LCR_STOPLEN_BIT		(1 << 2) /* STOP length bit
						  *
						  * STOP length bit table:
						  * 0 -> 1 stop bit
						  * 1 -> 1-1.5 stop bits if
						  *      word length is 5,
						  *      2 stop bits otherwise
						  */
#define MAX310X_LCR_PARITY_BIT		(1 << 3) /* Parity bit enable */
#define MAX310X_LCR_EVENPARITY_BIT	(1 << 4) /* Even parity bit enable */
#define MAX310X_LCR_FORCEPARITY_BIT	(1 << 5) /* 9-bit multidrop parity */
#define MAX310X_LCR_TXBREAK_BIT		(1 << 6) /* TX break enable */
#define MAX310X_LCR_RTS_BIT		(1 << 7) /* RTS pin control */

/* IRDA register bits */
#define MAX310X_IRDA_IRDAEN_BIT		(1 << 0) /* IRDA mode enable */
#define MAX310X_IRDA_SIR_BIT		(1 << 1) /* SIR mode enable */

/* Flow control trigger level register masks */
#define MAX310X_FLOWLVL_HALT_MASK	(0x000f) /* Flow control halt level */
#define MAX310X_FLOWLVL_RES_MASK	(0x00f0) /* Flow control resume level */
#define MAX310X_FLOWLVL_HALT(words)	((words / 8) & 0x0f)
#define MAX310X_FLOWLVL_RES(words)	(((words / 8) & 0x0f) << 4)

/* FIFO interrupt trigger level register masks */
#define MAX310X_FIFOTRIGLVL_TX_MASK	(0x0f) /* TX FIFO trigger level */
#define MAX310X_FIFOTRIGLVL_RX_MASK	(0xf0) /* RX FIFO trigger level */
#define MAX310X_FIFOTRIGLVL_TX(words)	((words / 8) & 0x0f)
#define MAX310X_FIFOTRIGLVL_RX(words)	(((words / 8) & 0x0f) << 4)

/* Flow control register bits */
#define MAX310X_FLOWCTRL_AUTORTS_BIT	(1 << 0) /* Auto RTS flow ctrl enable */
#define MAX310X_FLOWCTRL_AUTOCTS_BIT	(1 << 1) /* Auto CTS flow ctrl enable */
#define MAX310X_FLOWCTRL_GPIADDR_BIT	(1 << 2) /* Enables that GPIO inputs
						  * are used in conjunction with
						  * XOFF2 for definition of
						  * special character */
#define MAX310X_FLOWCTRL_SWFLOWEN_BIT	(1 << 3) /* Auto SW flow ctrl enable */
#define MAX310X_FLOWCTRL_SWFLOW0_BIT	(1 << 4) /* SWFLOW bit 0 */
#define MAX310X_FLOWCTRL_SWFLOW1_BIT	(1 << 5) /* SWFLOW bit 1
						  *
						  * SWFLOW bits 1 & 0 table:
						  * 00 -> no transmitter flow
						  *       control
						  * 01 -> receiver compares
						  *       XON2 and XOFF2
						  *       and controls
						  *       transmitter
						  * 10 -> receiver compares
						  *       XON1 and XOFF1
						  *       and controls
						  *       transmitter
						  * 11 -> receiver compares
						  *       XON1, XON2, XOFF1 and
						  *       XOFF2 and controls
						  *       transmitter
						  */
#define MAX310X_FLOWCTRL_SWFLOW2_BIT	(1 << 6) /* SWFLOW bit 2 */
#define MAX310X_FLOWCTRL_SWFLOW3_BIT	(1 << 7) /* SWFLOW bit 3
						  *
						  * SWFLOW bits 3 & 2 table:
						  * 00 -> no received flow
						  *       control
						  * 01 -> transmitter generates
						  *       XON2 and XOFF2
						  * 10 -> transmitter generates
						  *       XON1 and XOFF1
						  * 11 -> transmitter generates
						  *       XON1, XON2, XOFF1 and
						  *       XOFF2
						  */

/* PLL configuration register masks */
#define MAX310X_PLLCFG_PREDIV_MASK	(0x3f) /* PLL predivision value */
#define MAX310X_PLLCFG_PLLFACTOR_MASK	(0xc0) /* PLL multiplication factor */

/* Baud rate generator configuration register bits */
#define MAX310X_BRGCFG_2XMODE_BIT	(1 << 4) /* Double baud rate */
#define MAX310X_BRGCFG_4XMODE_BIT	(1 << 5) /* Quadruple baud rate */

/* Clock source register bits */
#define MAX310X_CLKSRC_CRYST_BIT	(1 << 1) /* Crystal osc enable */
#define MAX310X_CLKSRC_PLL_BIT		(1 << 2) /* PLL enable */
#define MAX310X_CLKSRC_PLLBYP_BIT	(1 << 3) /* PLL bypass */
#define MAX310X_CLKSRC_EXTCLK_BIT	(1 << 4) /* External clock enable */
#define MAX310X_CLKSRC_CLK2RTS_BIT	(1 << 7) /* Baud clk to RTS pin */

229 230 231 232
/* Global commands */
#define MAX310X_EXTREG_ENBL		(0xce)
#define MAX310X_EXTREG_DSBL		(0xcd)

233 234
/* Misc definitions */
#define MAX310X_FIFO_SIZE		(128)
235
#define MAX310x_REV_MASK		(0xf8)
236
#define MAX310X_WRITE_BIT		0x80
237 238 239

/* MAX3107 specific */
#define MAX3107_REV_ID			(0xa0)
240

241 242 243
/* MAX3109 specific */
#define MAX3109_REV_ID			(0xc0)

244 245 246 247
/* MAX14830 specific */
#define MAX14830_BRGCFG_CLKDIS_BIT	(1 << 6) /* Clock Disable */
#define MAX14830_REV_ID			(0xb0)

248 249 250
struct max310x_devtype {
	char	name[9];
	int	nr;
251
	u8	mode1;
252 253
	int	(*detect)(struct device *);
	void	(*power)(struct uart_port *, int);
254 255
};

256
struct max310x_one {
257
	struct uart_port	port;
258
	struct work_struct	tx_work;
259
	struct work_struct	md_work;
260
	struct work_struct	rs_work;
261
};
262

263 264 265 266
struct max310x_port {
	struct max310x_devtype	*devtype;
	struct regmap		*regmap;
	struct mutex		mutex;
267
	struct clk		*clk;
268 269 270
#ifdef CONFIG_GPIOLIB
	struct gpio_chip	gpio;
#endif
271 272
	struct max310x_one	p[0];
};
273

274 275 276 277 278 279
static struct uart_driver max310x_uart = {
	.owner		= THIS_MODULE,
	.driver_name	= MAX310X_NAME,
	.dev_name	= "ttyMAX",
	.major		= MAX310X_MAJOR,
	.minor		= MAX310X_MINOR,
280
	.nr		= MAX310X_UART_NRMAX,
281 282
};

283 284
static DECLARE_BITMAP(max310x_lines, MAX310X_UART_NRMAX);

285 286 287 288
static u8 max310x_port_read(struct uart_port *port, u8 reg)
{
	struct max310x_port *s = dev_get_drvdata(port->dev);
	unsigned int val = 0;
289

290
	regmap_read(s->regmap, port->iobase + reg, &val);
291

292 293
	return val;
}
294

295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
static void max310x_port_write(struct uart_port *port, u8 reg, u8 val)
{
	struct max310x_port *s = dev_get_drvdata(port->dev);

	regmap_write(s->regmap, port->iobase + reg, val);
}

static void max310x_port_update(struct uart_port *port, u8 reg, u8 mask, u8 val)
{
	struct max310x_port *s = dev_get_drvdata(port->dev);

	regmap_update_bits(s->regmap, port->iobase + reg, mask, val);
}

static int max3107_detect(struct device *dev)
{
	struct max310x_port *s = dev_get_drvdata(dev);
	unsigned int val = 0;
	int ret;

	ret = regmap_read(s->regmap, MAX310X_REVID_REG, &val);
	if (ret)
		return ret;

	if (((val & MAX310x_REV_MASK) != MAX3107_REV_ID)) {
		dev_err(dev,
			"%s ID 0x%02x does not match\n", s->devtype->name, val);
		return -ENODEV;
	}

	return 0;
}

static int max3108_detect(struct device *dev)
{
	struct max310x_port *s = dev_get_drvdata(dev);
	unsigned int val = 0;
	int ret;

	/* MAX3108 have not REV ID register, we just check default value
	 * from clocksource register to make sure everything works.
	 */
	ret = regmap_read(s->regmap, MAX310X_CLKSRC_REG, &val);
	if (ret)
		return ret;

	if (val != (MAX310X_CLKSRC_EXTCLK_BIT | MAX310X_CLKSRC_PLLBYP_BIT)) {
		dev_err(dev, "%s not present\n", s->devtype->name);
		return -ENODEV;
	}

	return 0;
}

349 350 351 352 353 354
static int max3109_detect(struct device *dev)
{
	struct max310x_port *s = dev_get_drvdata(dev);
	unsigned int val = 0;
	int ret;

355 356
	ret = regmap_write(s->regmap, MAX310X_GLOBALCMD_REG,
			   MAX310X_EXTREG_ENBL);
357 358 359
	if (ret)
		return ret;

360 361
	regmap_read(s->regmap, MAX310X_REVID_EXTREG, &val);
	regmap_write(s->regmap, MAX310X_GLOBALCMD_REG, MAX310X_EXTREG_DSBL);
362 363 364 365 366 367 368 369 370
	if (((val & MAX310x_REV_MASK) != MAX3109_REV_ID)) {
		dev_err(dev,
			"%s ID 0x%02x does not match\n", s->devtype->name, val);
		return -ENODEV;
	}

	return 0;
}

371 372 373 374 375 376 377 378 379
static void max310x_power(struct uart_port *port, int on)
{
	max310x_port_update(port, MAX310X_MODE1_REG,
			    MAX310X_MODE1_FORCESLEEP_BIT,
			    on ? 0 : MAX310X_MODE1_FORCESLEEP_BIT);
	if (on)
		msleep(50);
}

380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
static int max14830_detect(struct device *dev)
{
	struct max310x_port *s = dev_get_drvdata(dev);
	unsigned int val = 0;
	int ret;

	ret = regmap_write(s->regmap, MAX310X_GLOBALCMD_REG,
			   MAX310X_EXTREG_ENBL);
	if (ret)
		return ret;
	
	regmap_read(s->regmap, MAX310X_REVID_EXTREG, &val);
	regmap_write(s->regmap, MAX310X_GLOBALCMD_REG, MAX310X_EXTREG_DSBL);
	if (((val & MAX310x_REV_MASK) != MAX14830_REV_ID)) {
		dev_err(dev,
			"%s ID 0x%02x does not match\n", s->devtype->name, val);
		return -ENODEV;
	}

	return 0;
}

static void max14830_power(struct uart_port *port, int on)
{
	max310x_port_update(port, MAX310X_BRGCFG_REG,
			    MAX14830_BRGCFG_CLKDIS_BIT,
			    on ? 0 : MAX14830_BRGCFG_CLKDIS_BIT);
	if (on)
		msleep(50);
}

411 412 413
static const struct max310x_devtype max3107_devtype = {
	.name	= "MAX3107",
	.nr	= 1,
414
	.mode1	= MAX310X_MODE1_AUTOSLEEP_BIT | MAX310X_MODE1_IRQSEL_BIT,
415 416
	.detect	= max3107_detect,
	.power	= max310x_power,
417 418
};

419 420 421
static const struct max310x_devtype max3108_devtype = {
	.name	= "MAX3108",
	.nr	= 1,
422
	.mode1	= MAX310X_MODE1_AUTOSLEEP_BIT,
423 424 425 426
	.detect	= max3108_detect,
	.power	= max310x_power,
};

427 428 429
static const struct max310x_devtype max3109_devtype = {
	.name	= "MAX3109",
	.nr	= 2,
430
	.mode1	= MAX310X_MODE1_AUTOSLEEP_BIT,
431 432 433 434
	.detect	= max3109_detect,
	.power	= max310x_power,
};

435 436 437
static const struct max310x_devtype max14830_devtype = {
	.name	= "MAX14830",
	.nr	= 4,
438
	.mode1	= MAX310X_MODE1_IRQSEL_BIT,
439 440 441 442
	.detect	= max14830_detect,
	.power	= max14830_power,
};

443
static bool max310x_reg_writeable(struct device *dev, unsigned int reg)
444
{
445
	switch (reg & 0x1f) {
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461
	case MAX310X_IRQSTS_REG:
	case MAX310X_LSR_IRQSTS_REG:
	case MAX310X_SPCHR_IRQSTS_REG:
	case MAX310X_STS_IRQSTS_REG:
	case MAX310X_TXFIFOLVL_REG:
	case MAX310X_RXFIFOLVL_REG:
		return false;
	default:
		break;
	}

	return true;
}

static bool max310x_reg_volatile(struct device *dev, unsigned int reg)
{
462
	switch (reg & 0x1f) {
463 464 465 466 467 468 469 470
	case MAX310X_RHR_REG:
	case MAX310X_IRQSTS_REG:
	case MAX310X_LSR_IRQSTS_REG:
	case MAX310X_SPCHR_IRQSTS_REG:
	case MAX310X_STS_IRQSTS_REG:
	case MAX310X_TXFIFOLVL_REG:
	case MAX310X_RXFIFOLVL_REG:
	case MAX310X_GPIODATA_REG:
471 472 473
	case MAX310X_BRGDIVLSB_REG:
	case MAX310X_REG_05:
	case MAX310X_REG_1F:
474 475 476 477 478 479 480 481 482 483
		return true;
	default:
		break;
	}

	return false;
}

static bool max310x_reg_precious(struct device *dev, unsigned int reg)
{
484
	switch (reg & 0x1f) {
485 486 487 488 489 490 491 492 493 494 495 496
	case MAX310X_RHR_REG:
	case MAX310X_IRQSTS_REG:
	case MAX310X_SPCHR_IRQSTS_REG:
	case MAX310X_STS_IRQSTS_REG:
		return true;
	default:
		break;
	}

	return false;
}

497
static int max310x_set_baud(struct uart_port *port, int baud)
498
{
499
	unsigned int mode = 0, clk = port->uartclk, div = clk / baud;
500

501 502 503 504 505
	/* Check for minimal value for divider */
	if (div < 16)
		div = 16;

	if (clk % baud && (div / 16) < 0x8000) {
506 507
		/* Mode x2 */
		mode = MAX310X_BRGCFG_2XMODE_BIT;
508 509 510 511 512 513 514 515 516
		clk = port->uartclk * 2;
		div = clk / baud;

		if (clk % baud && (div / 16) < 0x8000) {
			/* Mode x4 */
			mode = MAX310X_BRGCFG_4XMODE_BIT;
			clk = port->uartclk * 4;
			div = clk / baud;
		}
517 518
	}

519 520 521
	max310x_port_write(port, MAX310X_BRGDIVMSB_REG, (div / 16) >> 8);
	max310x_port_write(port, MAX310X_BRGDIVLSB_REG, div / 16);
	max310x_port_write(port, MAX310X_BRGCFG_REG, (div % 16) | mode);
522 523

	return DIV_ROUND_CLOSEST(clk, div);
524 525
}

B
Bill Pemberton 已提交
526
static int max310x_update_best_err(unsigned long f, long *besterr)
527 528 529 530 531 532 533 534 535 536 537 538
{
	/* Use baudrate 115200 for calculate error */
	long err = f % (115200 * 16);

	if ((*besterr < 0) || (*besterr > err)) {
		*besterr = err;
		return 0;
	}

	return 1;
}

539 540
static int max310x_set_ref_clk(struct device *dev, struct max310x_port *s,
			       unsigned long freq, bool xtal)
541 542 543
{
	unsigned int div, clksrc, pllcfg = 0;
	long besterr = -1;
544
	unsigned long fdiv, fmul, bestfreq = freq;
545 546

	/* First, update error without PLL */
547
	max310x_update_best_err(freq, &besterr);
548 549 550

	/* Try all possible PLL dividers */
	for (div = 1; (div <= 63) && besterr; div++) {
551
		fdiv = DIV_ROUND_CLOSEST(freq, div);
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583

		/* Try multiplier 6 */
		fmul = fdiv * 6;
		if ((fdiv >= 500000) && (fdiv <= 800000))
			if (!max310x_update_best_err(fmul, &besterr)) {
				pllcfg = (0 << 6) | div;
				bestfreq = fmul;
			}
		/* Try multiplier 48 */
		fmul = fdiv * 48;
		if ((fdiv >= 850000) && (fdiv <= 1200000))
			if (!max310x_update_best_err(fmul, &besterr)) {
				pllcfg = (1 << 6) | div;
				bestfreq = fmul;
			}
		/* Try multiplier 96 */
		fmul = fdiv * 96;
		if ((fdiv >= 425000) && (fdiv <= 1000000))
			if (!max310x_update_best_err(fmul, &besterr)) {
				pllcfg = (2 << 6) | div;
				bestfreq = fmul;
			}
		/* Try multiplier 144 */
		fmul = fdiv * 144;
		if ((fdiv >= 390000) && (fdiv <= 667000))
			if (!max310x_update_best_err(fmul, &besterr)) {
				pllcfg = (3 << 6) | div;
				bestfreq = fmul;
			}
	}

	/* Configure clock source */
584
	clksrc = MAX310X_CLKSRC_EXTCLK_BIT | (xtal ? MAX310X_CLKSRC_CRYST_BIT : 0);
585 586 587 588 589 590 591 592 593 594

	/* Configure PLL */
	if (pllcfg) {
		clksrc |= MAX310X_CLKSRC_PLL_BIT;
		regmap_write(s->regmap, MAX310X_PLLCFG_REG, pllcfg);
	} else
		clksrc |= MAX310X_CLKSRC_PLLBYP_BIT;

	regmap_write(s->regmap, MAX310X_CLKSRC_REG, clksrc);

595
	/* Wait for crystal */
596 597
	if (xtal) {
		unsigned int val;
598
		msleep(10);
599 600 601 602 603
		regmap_read(s->regmap, MAX310X_STS_IRQSTS_REG, &val);
		if (!(val & MAX310X_STS_CLKREADY_BIT)) {
			dev_warn(dev, "clock is not stable yet\n");
		}
	}
604 605 606 607

	return (int)bestfreq;
}

608 609 610 611 612 613 614 615 616 617 618 619 620 621 622
static void max310x_batch_write(struct uart_port *port, u8 *txbuf, unsigned int len)
{
	u8 header[] = { (port->iobase + MAX310X_THR_REG) | MAX310X_WRITE_BIT };
	struct spi_transfer xfer[] = {
		{
			.tx_buf = &header,
			.len = sizeof(header),
		}, {
			.tx_buf = txbuf,
			.len = len,
		}
	};
	spi_sync_transfer(to_spi_device(port->dev), xfer, ARRAY_SIZE(xfer));
}

623
static void max310x_batch_read(struct uart_port *port, u8 *rxbuf, unsigned int len)
624
{
625 626 627 628 629 630 631 632 633 634 635 636
	u8 header[] = { port->iobase + MAX310X_RHR_REG };
	struct spi_transfer xfer[] = {
		{
			.tx_buf = &header,
			.len = sizeof(header),
		}, {
			.rx_buf = rxbuf,
			.len = len,
		}
	};
	spi_sync_transfer(to_spi_device(port->dev), xfer, ARRAY_SIZE(xfer));
}
637

638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653
static void max310x_handle_rx(struct uart_port *port, unsigned int rxlen)
{
	unsigned int sts, ch, flag, i;
	u8 buf[MAX310X_FIFO_SIZE];

	if (port->read_status_mask == MAX310X_LSR_RXOVR_BIT) {
		/* We are just reading, happily ignoring any error conditions.
		 * Break condition, parity checking, framing errors -- they
		 * are all ignored. That means that we can do a batch-read.
		 *
		 * There is a small opportunity for race if the RX FIFO
		 * overruns while we're reading the buffer; the datasheets says
		 * that the LSR register applies to the "current" character.
		 * That's also the reason why we cannot do batched reads when
		 * asked to check the individual statuses.
		 * */
654

655
		sts = max310x_port_read(port, MAX310X_LSR_IRQSTS_REG);
656
		max310x_batch_read(port, buf, rxlen);
657

658
		port->icount.rx += rxlen;
659
		flag = TTY_NORMAL;
660
		sts &= port->read_status_mask;
661

662 663 664
		if (sts & MAX310X_LSR_RXOVR_BIT) {
			dev_warn_ratelimited(port->dev, "Hardware RX FIFO overrun\n");
			port->icount.overrun++;
665 666
		}

667 668 669
		for (i = 0; i < rxlen; ++i) {
			uart_insert_char(port, sts, MAX310X_LSR_RXOVR_BIT, buf[i], flag);
		}
670

671 672 673 674 675 676 677
	} else {
		if (unlikely(rxlen >= port->fifosize)) {
			dev_warn_ratelimited(port->dev, "Possible RX FIFO overrun\n");
			port->icount.buf_overrun++;
			/* Ensure sanity of RX level */
			rxlen = port->fifosize;
		}
678

679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
		while (rxlen--) {
			ch = max310x_port_read(port, MAX310X_RHR_REG);
			sts = max310x_port_read(port, MAX310X_LSR_IRQSTS_REG);

			sts &= MAX310X_LSR_RXPAR_BIT | MAX310X_LSR_FRERR_BIT |
			       MAX310X_LSR_RXOVR_BIT | MAX310X_LSR_RXBRK_BIT;

			port->icount.rx++;
			flag = TTY_NORMAL;

			if (unlikely(sts)) {
				if (sts & MAX310X_LSR_RXBRK_BIT) {
					port->icount.brk++;
					if (uart_handle_break(port))
						continue;
				} else if (sts & MAX310X_LSR_RXPAR_BIT)
					port->icount.parity++;
				else if (sts & MAX310X_LSR_FRERR_BIT)
					port->icount.frame++;
				else if (sts & MAX310X_LSR_RXOVR_BIT)
					port->icount.overrun++;

				sts &= port->read_status_mask;
				if (sts & MAX310X_LSR_RXBRK_BIT)
					flag = TTY_BREAK;
				else if (sts & MAX310X_LSR_RXPAR_BIT)
					flag = TTY_PARITY;
				else if (sts & MAX310X_LSR_FRERR_BIT)
					flag = TTY_FRAME;
				else if (sts & MAX310X_LSR_RXOVR_BIT)
					flag = TTY_OVERRUN;
			}

			if (uart_handle_sysrq_char(port, ch))
				continue;

			if (sts & port->ignore_status_mask)
				continue;

			uart_insert_char(port, sts, MAX310X_LSR_RXOVR_BIT, ch, flag);
		}
720 721
	}

722
	tty_flip_buffer_push(&port->state->port);
723 724
}

725
static void max310x_handle_tx(struct uart_port *port)
726
{
727
	struct circ_buf *xmit = &port->state->xmit;
728
	unsigned int txlen, to_send, until_end;
729

730 731 732 733
	if (unlikely(port->x_char)) {
		max310x_port_write(port, MAX310X_THR_REG, port->x_char);
		port->icount.tx++;
		port->x_char = 0;
734 735 736
		return;
	}

737
	if (uart_circ_empty(xmit) || uart_tx_stopped(port))
738 739 740 741
		return;

	/* Get length of data pending in circular buffer */
	to_send = uart_circ_chars_pending(xmit);
742
	until_end = CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE);
743 744
	if (likely(to_send)) {
		/* Limit to size of TX FIFO */
745 746
		txlen = max310x_port_read(port, MAX310X_TXFIFOLVL_REG);
		txlen = port->fifosize - txlen;
747 748
		to_send = (to_send > txlen) ? txlen : to_send;

749 750 751 752 753 754 755 756 757
		if (until_end < to_send) {
			/* It's a circ buffer -- wrap around.
			 * We could do that in one SPI transaction, but meh. */
			max310x_batch_write(port, xmit->buf + xmit->tail, until_end);
			max310x_batch_write(port, xmit->buf, to_send - until_end);
		} else {
			max310x_batch_write(port, xmit->buf + xmit->tail, to_send);
		}

758
		/* Add data to send */
759
		port->icount.tx += to_send;
760
		xmit->tail = (xmit->tail + to_send) & (UART_XMIT_SIZE - 1);
761 762 763
	}

	if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
764
		uart_write_wakeup(port);
765 766
}

767 768 769 770 771 772 773 774
static void max310x_start_tx(struct uart_port *port)
{
	struct max310x_one *one = container_of(port, struct max310x_one, port);

	if (!work_pending(&one->tx_work))
		schedule_work(&one->tx_work);
}

775
static irqreturn_t max310x_port_irq(struct max310x_port *s, int portno)
776
{
777
	struct uart_port *port = &s->p[portno].port;
778
	irqreturn_t res = IRQ_NONE;
779

780 781
	do {
		unsigned int ists, lsr, rxlen;
782 783

		/* Read IRQ status & RX FIFO level */
784 785 786
		ists = max310x_port_read(port, MAX310X_IRQSTS_REG);
		rxlen = max310x_port_read(port, MAX310X_RXFIFOLVL_REG);
		if (!ists && !rxlen)
787 788
			break;

789 790
		res = IRQ_HANDLED;

791 792 793
		if (ists & MAX310X_IRQ_CTS_BIT) {
			lsr = max310x_port_read(port, MAX310X_LSR_IRQSTS_REG);
			uart_handle_cts_change(port,
794
					       !!(lsr & MAX310X_LSR_CTS_BIT));
795 796 797
		}
		if (rxlen)
			max310x_handle_rx(port, rxlen);
798 799
		if (ists & MAX310X_IRQ_TXEMPTY_BIT)
			max310x_start_tx(port);
800
	} while (1);
801
	return res;
802
}
803

804 805 806
static irqreturn_t max310x_ist(int irq, void *dev_id)
{
	struct max310x_port *s = (struct max310x_port *)dev_id;
807
	bool handled = false;
808

809
	if (s->devtype->nr > 1) {
810 811 812 813 814
		do {
			unsigned int val = ~0;

			WARN_ON_ONCE(regmap_read(s->regmap,
						 MAX310X_GLOBALIRQ_REG, &val));
815
			val = ((1 << s->devtype->nr) - 1) & ~val;
816 817
			if (!val)
				break;
818 819
			if (max310x_port_irq(s, fls(val) - 1) == IRQ_HANDLED)
				handled = true;
820
		} while (1);
821 822 823 824
	} else {
		if (max310x_port_irq(s, 0) == IRQ_HANDLED)
			handled = true;
	}
825

826
	return IRQ_RETVAL(handled);
827 828 829 830
}

static void max310x_wq_proc(struct work_struct *ws)
{
831 832
	struct max310x_one *one = container_of(ws, struct max310x_one, tx_work);
	struct max310x_port *s = dev_get_drvdata(one->port.dev);
833

834 835 836
	mutex_lock(&s->mutex);
	max310x_handle_tx(&one->port);
	mutex_unlock(&s->mutex);
837 838 839 840
}

static unsigned int max310x_tx_empty(struct uart_port *port)
{
841
	u8 lvl = max310x_port_read(port, MAX310X_TXFIFOLVL_REG);
842

843
	return lvl ? 0 : TIOCSER_TEMT;
844 845 846 847 848 849 850 851 852 853
}

static unsigned int max310x_get_mctrl(struct uart_port *port)
{
	/* DCD and DSR are not wired and CTS/RTS is handled automatically
	 * so just indicate DSR and CAR asserted
	 */
	return TIOCM_DSR | TIOCM_CAR;
}

854 855 856 857 858 859 860 861 862 863
static void max310x_md_proc(struct work_struct *ws)
{
	struct max310x_one *one = container_of(ws, struct max310x_one, md_work);

	max310x_port_update(&one->port, MAX310X_MODE2_REG,
			    MAX310X_MODE2_LOOPBACK_BIT,
			    (one->port.mctrl & TIOCM_LOOP) ?
			    MAX310X_MODE2_LOOPBACK_BIT : 0);
}

864 865
static void max310x_set_mctrl(struct uart_port *port, unsigned int mctrl)
{
866 867 868
	struct max310x_one *one = container_of(port, struct max310x_one, port);

	schedule_work(&one->md_work);
869 870 871 872
}

static void max310x_break_ctl(struct uart_port *port, int break_state)
{
873 874 875
	max310x_port_update(port, MAX310X_LCR_REG,
			    MAX310X_LCR_TXBREAK_BIT,
			    break_state ? MAX310X_LCR_TXBREAK_BIT : 0);
876 877 878 879 880 881
}

static void max310x_set_termios(struct uart_port *port,
				struct ktermios *termios,
				struct ktermios *old)
{
882
	unsigned int lcr = 0, flow = 0;
883 884 885 886 887 888 889 890 891 892
	int baud;

	/* Mask termios capabilities we don't support */
	termios->c_cflag &= ~CMSPAR;

	/* Word size */
	switch (termios->c_cflag & CSIZE) {
	case CS5:
		break;
	case CS6:
893
		lcr = MAX310X_LCR_LENGTH0_BIT;
894 895
		break;
	case CS7:
896
		lcr = MAX310X_LCR_LENGTH1_BIT;
897 898 899
		break;
	case CS8:
	default:
900
		lcr = MAX310X_LCR_LENGTH1_BIT | MAX310X_LCR_LENGTH0_BIT;
901 902 903 904 905 906 907 908 909 910 911 912 913 914 915
		break;
	}

	/* Parity */
	if (termios->c_cflag & PARENB) {
		lcr |= MAX310X_LCR_PARITY_BIT;
		if (!(termios->c_cflag & PARODD))
			lcr |= MAX310X_LCR_EVENPARITY_BIT;
	}

	/* Stop bits */
	if (termios->c_cflag & CSTOPB)
		lcr |= MAX310X_LCR_STOPLEN_BIT; /* 2 stops */

	/* Update LCR register */
916
	max310x_port_write(port, MAX310X_LCR_REG, lcr);
917 918 919 920 921 922

	/* Set read status mask */
	port->read_status_mask = MAX310X_LSR_RXOVR_BIT;
	if (termios->c_iflag & INPCK)
		port->read_status_mask |= MAX310X_LSR_RXPAR_BIT |
					  MAX310X_LSR_FRERR_BIT;
P
Peter Hurley 已提交
923
	if (termios->c_iflag & (IGNBRK | BRKINT | PARMRK))
924 925 926 927 928 929 930 931 932 933 934 935 936
		port->read_status_mask |= MAX310X_LSR_RXBRK_BIT;

	/* Set status ignore mask */
	port->ignore_status_mask = 0;
	if (termios->c_iflag & IGNBRK)
		port->ignore_status_mask |= MAX310X_LSR_RXBRK_BIT;
	if (!(termios->c_cflag & CREAD))
		port->ignore_status_mask |= MAX310X_LSR_RXPAR_BIT |
					    MAX310X_LSR_RXOVR_BIT |
					    MAX310X_LSR_FRERR_BIT |
					    MAX310X_LSR_RXBRK_BIT;

	/* Configure flow control */
937 938
	max310x_port_write(port, MAX310X_XON1_REG, termios->c_cc[VSTART]);
	max310x_port_write(port, MAX310X_XOFF1_REG, termios->c_cc[VSTOP]);
939 940 941 942 943 944 945 946 947
	if (termios->c_cflag & CRTSCTS)
		flow |= MAX310X_FLOWCTRL_AUTOCTS_BIT |
			MAX310X_FLOWCTRL_AUTORTS_BIT;
	if (termios->c_iflag & IXON)
		flow |= MAX310X_FLOWCTRL_SWFLOW3_BIT |
			MAX310X_FLOWCTRL_SWFLOWEN_BIT;
	if (termios->c_iflag & IXOFF)
		flow |= MAX310X_FLOWCTRL_SWFLOW1_BIT |
			MAX310X_FLOWCTRL_SWFLOWEN_BIT;
948
	max310x_port_write(port, MAX310X_FLOWCTRL_REG, flow);
949 950 951 952 953 954 955

	/* Get baud rate generator configuration */
	baud = uart_get_baud_rate(port, termios, old,
				  port->uartclk / 16 / 0xffff,
				  port->uartclk / 4);

	/* Setup baudrate generator */
956
	baud = max310x_set_baud(port, baud);
957 958 959 960 961

	/* Update timeout according to new baud rate */
	uart_update_timeout(port, termios->c_cflag, baud);
}

962
static void max310x_rs_proc(struct work_struct *ws)
963
{
964
	struct max310x_one *one = container_of(ws, struct max310x_one, rs_work);
965 966
	unsigned int val;

967 968 969
	val = (one->port.rs485.delay_rts_before_send << 4) |
		one->port.rs485.delay_rts_after_send;
	max310x_port_write(&one->port, MAX310X_HDPIXDELAY_REG, val);
970

971 972
	if (one->port.rs485.flags & SER_RS485_ENABLED) {
		max310x_port_update(&one->port, MAX310X_MODE1_REG,
973 974
				MAX310X_MODE1_TRNSCVCTRL_BIT,
				MAX310X_MODE1_TRNSCVCTRL_BIT);
975
		max310x_port_update(&one->port, MAX310X_MODE2_REG,
976 977 978
				MAX310X_MODE2_ECHOSUPR_BIT,
				MAX310X_MODE2_ECHOSUPR_BIT);
	} else {
979
		max310x_port_update(&one->port, MAX310X_MODE1_REG,
980
				MAX310X_MODE1_TRNSCVCTRL_BIT, 0);
981
		max310x_port_update(&one->port, MAX310X_MODE2_REG,
982
				MAX310X_MODE2_ECHOSUPR_BIT, 0);
983
	}
984 985 986 987 988 989 990 991 992 993
}

static int max310x_rs485_config(struct uart_port *port,
				struct serial_rs485 *rs485)
{
	struct max310x_one *one = container_of(port, struct max310x_one, port);

	if ((rs485->delay_rts_before_send > 0x0f) ||
	    (rs485->delay_rts_after_send > 0x0f))
		return -ERANGE;
994

995 996 997 998
	rs485->flags &= SER_RS485_RTS_ON_SEND | SER_RS485_ENABLED;
	memset(rs485->padding, 0, sizeof(rs485->padding));
	port->rs485 = *rs485;

999 1000
	schedule_work(&one->rs_work);

1001
	return 0;
1002 1003
}

1004 1005
static int max310x_startup(struct uart_port *port)
{
1006
	struct max310x_port *s = dev_get_drvdata(port->dev);
1007
	unsigned int val;
1008

1009
	s->devtype->power(port, 1);
1010 1011

	/* Configure MODE1 register */
1012
	max310x_port_update(port, MAX310X_MODE1_REG,
1013
			    MAX310X_MODE1_TRNSCVCTRL_BIT, 0);
1014

1015 1016
	/* Configure MODE2 register & Reset FIFOs*/
	val = MAX310X_MODE2_RXEMPTINV_BIT | MAX310X_MODE2_FIFORST_BIT;
1017 1018 1019
	max310x_port_write(port, MAX310X_MODE2_REG, val);
	max310x_port_update(port, MAX310X_MODE2_REG,
			    MAX310X_MODE2_FIFORST_BIT, 0);
1020 1021 1022

	/* Configure flow control levels */
	/* Flow control halt level 96, resume level 48 */
1023 1024
	max310x_port_write(port, MAX310X_FLOWLVL_REG,
			   MAX310X_FLOWLVL_RES(48) | MAX310X_FLOWLVL_HALT(96));
1025

1026 1027
	/* Clear IRQ status register */
	max310x_port_read(port, MAX310X_IRQSTS_REG);
1028

1029 1030 1031
	/* Enable RX, TX, CTS change interrupts */
	val = MAX310X_IRQ_RXEMPTY_BIT | MAX310X_IRQ_TXEMPTY_BIT;
	max310x_port_write(port, MAX310X_IRQEN_REG, val | MAX310X_IRQ_CTS_BIT);
1032 1033 1034 1035 1036 1037

	return 0;
}

static void max310x_shutdown(struct uart_port *port)
{
1038
	struct max310x_port *s = dev_get_drvdata(port->dev);
1039 1040

	/* Disable all interrupts */
1041
	max310x_port_write(port, MAX310X_IRQEN_REG, 0);
1042

1043
	s->devtype->power(port, 0);
1044 1045 1046 1047
}

static const char *max310x_type(struct uart_port *port)
{
1048
	struct max310x_port *s = dev_get_drvdata(port->dev);
1049

1050
	return (port->type == PORT_MAX310X) ? s->devtype->name : NULL;
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064
}

static int max310x_request_port(struct uart_port *port)
{
	/* Do nothing */
	return 0;
}

static void max310x_config_port(struct uart_port *port, int flags)
{
	if (flags & UART_CONFIG_TYPE)
		port->type = PORT_MAX310X;
}

1065
static int max310x_verify_port(struct uart_port *port, struct serial_struct *s)
1066
{
1067 1068 1069 1070
	if ((s->type != PORT_UNKNOWN) && (s->type != PORT_MAX310X))
		return -EINVAL;
	if (s->irq != port->irq)
		return -EINVAL;
1071

1072
	return 0;
1073 1074
}

1075 1076 1077 1078 1079 1080
static void max310x_null_void(struct uart_port *port)
{
	/* Do nothing */
}

static const struct uart_ops max310x_ops = {
1081 1082 1083
	.tx_empty	= max310x_tx_empty,
	.set_mctrl	= max310x_set_mctrl,
	.get_mctrl	= max310x_get_mctrl,
1084
	.stop_tx	= max310x_null_void,
1085
	.start_tx	= max310x_start_tx,
1086
	.stop_rx	= max310x_null_void,
1087 1088 1089 1090 1091 1092
	.break_ctl	= max310x_break_ctl,
	.startup	= max310x_startup,
	.shutdown	= max310x_shutdown,
	.set_termios	= max310x_set_termios,
	.type		= max310x_type,
	.request_port	= max310x_request_port,
1093
	.release_port	= max310x_null_void,
1094 1095 1096 1097
	.config_port	= max310x_config_port,
	.verify_port	= max310x_verify_port,
};

1098
static int __maybe_unused max310x_suspend(struct device *dev)
1099
{
1100
	struct max310x_port *s = dev_get_drvdata(dev);
1101
	int i;
1102

1103 1104
	for (i = 0; i < s->devtype->nr; i++) {
		uart_suspend_port(&max310x_uart, &s->p[i].port);
1105 1106
		s->devtype->power(&s->p[i].port, 0);
	}
1107

1108
	return 0;
1109 1110
}

1111
static int __maybe_unused max310x_resume(struct device *dev)
1112
{
1113
	struct max310x_port *s = dev_get_drvdata(dev);
1114
	int i;
1115

1116
	for (i = 0; i < s->devtype->nr; i++) {
1117
		s->devtype->power(&s->p[i].port, 1);
1118
		uart_resume_port(&max310x_uart, &s->p[i].port);
1119
	}
1120

1121
	return 0;
1122 1123
}

1124 1125
static SIMPLE_DEV_PM_OPS(max310x_pm_ops, max310x_suspend, max310x_resume);

1126 1127 1128
#ifdef CONFIG_GPIOLIB
static int max310x_gpio_get(struct gpio_chip *chip, unsigned offset)
{
1129
	unsigned int val;
1130
	struct max310x_port *s = gpiochip_get_data(chip);
1131
	struct uart_port *port = &s->p[offset / 4].port;
1132

1133
	val = max310x_port_read(port, MAX310X_GPIODATA_REG);
1134

1135
	return !!((val >> 4) & (1 << (offset % 4)));
1136 1137 1138 1139
}

static void max310x_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
{
1140
	struct max310x_port *s = gpiochip_get_data(chip);
1141
	struct uart_port *port = &s->p[offset / 4].port;
1142

1143 1144
	max310x_port_update(port, MAX310X_GPIODATA_REG, 1 << (offset % 4),
			    value ? 1 << (offset % 4) : 0);
1145 1146 1147 1148
}

static int max310x_gpio_direction_input(struct gpio_chip *chip, unsigned offset)
{
1149
	struct max310x_port *s = gpiochip_get_data(chip);
1150
	struct uart_port *port = &s->p[offset / 4].port;
1151

1152
	max310x_port_update(port, MAX310X_GPIOCFG_REG, 1 << (offset % 4), 0);
1153 1154 1155 1156 1157 1158 1159

	return 0;
}

static int max310x_gpio_direction_output(struct gpio_chip *chip,
					 unsigned offset, int value)
{
1160
	struct max310x_port *s = gpiochip_get_data(chip);
1161
	struct uart_port *port = &s->p[offset / 4].port;
1162

1163 1164 1165 1166
	max310x_port_update(port, MAX310X_GPIODATA_REG, 1 << (offset % 4),
			    value ? 1 << (offset % 4) : 0);
	max310x_port_update(port, MAX310X_GPIOCFG_REG, 1 << (offset % 4),
			    1 << (offset % 4));
1167 1168 1169

	return 0;
}
1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190

static int max310x_gpio_set_config(struct gpio_chip *chip, unsigned int offset,
				   unsigned long config)
{
	struct max310x_port *s = gpiochip_get_data(chip);
	struct uart_port *port = &s->p[offset / 4].port;

	switch (pinconf_to_config_param(config)) {
	case PIN_CONFIG_DRIVE_OPEN_DRAIN:
		max310x_port_update(port, MAX310X_GPIOCFG_REG,
				1 << ((offset % 4) + 4),
				1 << ((offset % 4) + 4));
		return 0;
	case PIN_CONFIG_DRIVE_PUSH_PULL:
		max310x_port_update(port, MAX310X_GPIOCFG_REG,
				1 << ((offset % 4) + 4), 0);
		return 0;
	default:
		return -ENOTSUPP;
	}
}
1191 1192
#endif

1193
static int max310x_probe(struct device *dev, struct max310x_devtype *devtype,
1194
			 struct regmap *regmap, int irq)
1195
{
1196 1197 1198 1199
	int i, ret, fmin, fmax, freq, uartclk;
	struct clk *clk_osc, *clk_xtal;
	struct max310x_port *s;
	bool xtal = false;
1200

1201 1202 1203
	if (IS_ERR(regmap))
		return PTR_ERR(regmap);

1204
	/* Alloc port structure */
1205
	s = devm_kzalloc(dev, struct_size(s, p, devtype->nr), GFP_KERNEL);
1206 1207 1208 1209 1210
	if (!s) {
		dev_err(dev, "Error allocating port structure\n");
		return -ENOMEM;
	}

1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239
	clk_osc = devm_clk_get(dev, "osc");
	clk_xtal = devm_clk_get(dev, "xtal");
	if (!IS_ERR(clk_osc)) {
		s->clk = clk_osc;
		fmin = 500000;
		fmax = 35000000;
	} else if (!IS_ERR(clk_xtal)) {
		s->clk = clk_xtal;
		fmin = 1000000;
		fmax = 4000000;
		xtal = true;
	} else if (PTR_ERR(clk_osc) == -EPROBE_DEFER ||
		   PTR_ERR(clk_xtal) == -EPROBE_DEFER) {
		return -EPROBE_DEFER;
	} else {
		dev_err(dev, "Cannot get clock\n");
		return -EINVAL;
	}

	ret = clk_prepare_enable(s->clk);
	if (ret)
		return ret;

	freq = clk_get_rate(s->clk);
	/* Check frequency limits */
	if (freq < fmin || freq > fmax) {
		ret = -ERANGE;
		goto out_clk;
	}
1240

1241
	s->regmap = regmap;
1242 1243
	s->devtype = devtype;
	dev_set_drvdata(dev, s);
1244

1245 1246 1247
	/* Check device to ensure we are talking to what we expect */
	ret = devtype->detect(dev);
	if (ret)
1248
		goto out_clk;
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264

	for (i = 0; i < devtype->nr; i++) {
		unsigned int offs = i << 5;

		/* Reset port */
		regmap_write(s->regmap, MAX310X_MODE2_REG + offs,
			     MAX310X_MODE2_RST_BIT);
		/* Clear port reset */
		regmap_write(s->regmap, MAX310X_MODE2_REG + offs, 0);

		/* Wait for port startup */
		do {
			regmap_read(s->regmap,
				    MAX310X_BRGDIVLSB_REG + offs, &ret);
		} while (ret != 0x01);

1265 1266
		regmap_write(s->regmap, MAX310X_MODE1_REG + offs,
			     devtype->mode1);
1267 1268
	}

1269
	uartclk = max310x_set_ref_clk(dev, s, freq, xtal);
1270 1271
	dev_dbg(dev, "Reference clock set to %i Hz\n", uartclk);

1272 1273
	mutex_init(&s->mutex);

1274
	for (i = 0; i < devtype->nr; i++) {
1275 1276 1277 1278 1279 1280 1281 1282
		unsigned int line;

		line = find_first_zero_bit(max310x_lines, MAX310X_UART_NRMAX);
		if (line == MAX310X_UART_NRMAX) {
			ret = -ERANGE;
			goto out_uart;
		}

1283
		/* Initialize port data */
1284
		s->p[i].port.line	= line;
1285 1286 1287 1288
		s->p[i].port.dev	= dev;
		s->p[i].port.irq	= irq;
		s->p[i].port.type	= PORT_MAX310X;
		s->p[i].port.fifosize	= MAX310X_FIFO_SIZE;
1289
		s->p[i].port.flags	= UPF_FIXED_TYPE | UPF_LOW_LATENCY;
1290 1291 1292 1293
		s->p[i].port.iotype	= UPIO_PORT;
		s->p[i].port.iobase	= i * 0x20;
		s->p[i].port.membase	= (void __iomem *)~0;
		s->p[i].port.uartclk	= uartclk;
1294
		s->p[i].port.rs485_config = max310x_rs485_config;
1295 1296 1297 1298 1299 1300 1301
		s->p[i].port.ops	= &max310x_ops;
		/* Disable all interrupts */
		max310x_port_write(&s->p[i].port, MAX310X_IRQEN_REG, 0);
		/* Clear IRQ status register */
		max310x_port_read(&s->p[i].port, MAX310X_IRQSTS_REG);
		/* Initialize queue for start TX */
		INIT_WORK(&s->p[i].tx_work, max310x_wq_proc);
1302
		/* Initialize queue for changing LOOPBACK mode */
1303
		INIT_WORK(&s->p[i].md_work, max310x_md_proc);
1304 1305
		/* Initialize queue for changing RS485 mode */
		INIT_WORK(&s->p[i].rs_work, max310x_rs_proc);
1306

1307
		/* Register port */
1308 1309 1310 1311 1312 1313 1314
		ret = uart_add_one_port(&max310x_uart, &s->p[i].port);
		if (ret) {
			s->p[i].port.dev = NULL;
			goto out_uart;
		}
		set_bit(line, max310x_lines);

1315 1316 1317
		/* Go to suspend mode */
		devtype->power(&s->p[i].port, 0);
	}
1318

1319 1320 1321 1322
#ifdef CONFIG_GPIOLIB
	/* Setup GPIO cotroller */
	s->gpio.owner		= THIS_MODULE;
	s->gpio.parent		= dev;
1323
	s->gpio.label		= devtype->name;
1324 1325 1326 1327
	s->gpio.direction_input	= max310x_gpio_direction_input;
	s->gpio.get		= max310x_gpio_get;
	s->gpio.direction_output= max310x_gpio_direction_output;
	s->gpio.set		= max310x_gpio_set;
1328
	s->gpio.set_config	= max310x_gpio_set_config;
1329 1330 1331 1332 1333 1334 1335 1336
	s->gpio.base		= -1;
	s->gpio.ngpio		= devtype->nr * 4;
	s->gpio.can_sleep	= 1;
	ret = devm_gpiochip_add_data(dev, &s->gpio, s);
	if (ret)
		goto out_uart;
#endif

1337 1338
	/* Setup interrupt */
	ret = devm_request_threaded_irq(dev, irq, NULL, max310x_ist,
1339
					IRQF_ONESHOT | IRQF_SHARED, dev_name(dev), s);
1340 1341 1342 1343
	if (!ret)
		return 0;

	dev_err(dev, "Unable to reguest IRQ %i\n", irq);
1344

1345 1346 1347 1348 1349 1350 1351
out_uart:
	for (i = 0; i < devtype->nr; i++) {
		if (s->p[i].port.dev) {
			uart_remove_one_port(&max310x_uart, &s->p[i].port);
			clear_bit(s->p[i].port.line, max310x_lines);
		}
	}
1352

1353 1354
	mutex_destroy(&s->mutex);

1355 1356
out_clk:
	clk_disable_unprepare(s->clk);
1357

1358
	return ret;
1359 1360
}

1361
static int max310x_remove(struct device *dev)
1362 1363
{
	struct max310x_port *s = dev_get_drvdata(dev);
1364
	int i;
1365

1366
	for (i = 0; i < s->devtype->nr; i++) {
1367
		cancel_work_sync(&s->p[i].tx_work);
1368
		cancel_work_sync(&s->p[i].md_work);
1369
		cancel_work_sync(&s->p[i].rs_work);
1370
		uart_remove_one_port(&max310x_uart, &s->p[i].port);
1371
		clear_bit(s->p[i].port.line, max310x_lines);
1372 1373
		s->devtype->power(&s->p[i].port, 0);
	}
1374

1375
	mutex_destroy(&s->mutex);
1376
	clk_disable_unprepare(s->clk);
1377

1378
	return 0;
1379 1380
}

1381 1382 1383 1384 1385 1386 1387 1388 1389
static const struct of_device_id __maybe_unused max310x_dt_ids[] = {
	{ .compatible = "maxim,max3107",	.data = &max3107_devtype, },
	{ .compatible = "maxim,max3108",	.data = &max3108_devtype, },
	{ .compatible = "maxim,max3109",	.data = &max3109_devtype, },
	{ .compatible = "maxim,max14830",	.data = &max14830_devtype },
	{ }
};
MODULE_DEVICE_TABLE(of, max310x_dt_ids);

1390 1391 1392
static struct regmap_config regcfg = {
	.reg_bits = 8,
	.val_bits = 8,
1393
	.write_flag_mask = MAX310X_WRITE_BIT,
1394 1395 1396 1397 1398 1399
	.cache_type = REGCACHE_RBTREE,
	.writeable_reg = max310x_reg_writeable,
	.volatile_reg = max310x_reg_volatile,
	.precious_reg = max310x_reg_precious,
};

1400 1401 1402
#ifdef CONFIG_SPI_MASTER
static int max310x_spi_probe(struct spi_device *spi)
{
1403
	struct max310x_devtype *devtype;
1404
	struct regmap *regmap;
1405 1406 1407 1408 1409 1410 1411
	int ret;

	/* Setup SPI bus */
	spi->bits_per_word	= 8;
	spi->mode		= spi->mode ? : SPI_MODE_0;
	spi->max_speed_hz	= spi->max_speed_hz ? : 26000000;
	ret = spi_setup(spi);
1412
	if (ret)
1413 1414
		return ret;

1415 1416 1417
	if (spi->dev.of_node) {
		const struct of_device_id *of_id =
			of_match_device(max310x_dt_ids, &spi->dev);
1418 1419
		if (!of_id)
			return -ENODEV;
1420 1421 1422 1423 1424 1425 1426 1427

		devtype = (struct max310x_devtype *)of_id->data;
	} else {
		const struct spi_device_id *id_entry = spi_get_device_id(spi);

		devtype = (struct max310x_devtype *)id_entry->driver_data;
	}

1428 1429 1430
	regcfg.max_register = devtype->nr * 0x20 - 1;
	regmap = devm_regmap_init_spi(spi, &regcfg);

1431
	return max310x_probe(&spi->dev, devtype, regmap, spi->irq);
1432 1433 1434 1435 1436 1437 1438
}

static int max310x_spi_remove(struct spi_device *spi)
{
	return max310x_remove(&spi->dev);
}

1439
static const struct spi_device_id max310x_id_table[] = {
1440 1441
	{ "max3107",	(kernel_ulong_t)&max3107_devtype, },
	{ "max3108",	(kernel_ulong_t)&max3108_devtype, },
1442
	{ "max3109",	(kernel_ulong_t)&max3109_devtype, },
1443
	{ "max14830",	(kernel_ulong_t)&max14830_devtype, },
1444
	{ }
1445 1446 1447
};
MODULE_DEVICE_TABLE(spi, max310x_id_table);

1448
static struct spi_driver max310x_spi_driver = {
1449
	.driver = {
1450 1451 1452
		.name		= MAX310X_NAME,
		.of_match_table	= of_match_ptr(max310x_dt_ids),
		.pm		= &max310x_pm_ops,
1453
	},
1454 1455
	.probe		= max310x_spi_probe,
	.remove		= max310x_spi_remove,
1456 1457
	.id_table	= max310x_id_table,
};
1458
#endif
1459

1460 1461 1462 1463
static int __init max310x_uart_init(void)
{
	int ret;

1464 1465
	bitmap_zero(max310x_lines, MAX310X_UART_NRMAX);

1466 1467 1468 1469 1470
	ret = uart_register_driver(&max310x_uart);
	if (ret)
		return ret;

#ifdef CONFIG_SPI_MASTER
1471
	ret = spi_register_driver(&max310x_spi_driver);
1472 1473
#endif

1474
	return ret;
1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487
}
module_init(max310x_uart_init);

static void __exit max310x_uart_exit(void)
{
#ifdef CONFIG_SPI_MASTER
	spi_unregister_driver(&max310x_spi_driver);
#endif

	uart_unregister_driver(&max310x_uart);
}
module_exit(max310x_uart_exit);

1488
MODULE_LICENSE("GPL");
1489 1490
MODULE_AUTHOR("Alexander Shiyan <shc_work@mail.ru>");
MODULE_DESCRIPTION("MAX310X serial driver");