max310x.c 41 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492
  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. #include <linux/bitops.h>
  12. #include <linux/clk.h>
  13. #include <linux/delay.h>
  14. #include <linux/device.h>
  15. #include <linux/gpio/driver.h>
  16. #include <linux/module.h>
  17. #include <linux/of.h>
  18. #include <linux/of_device.h>
  19. #include <linux/regmap.h>
  20. #include <linux/serial_core.h>
  21. #include <linux/serial.h>
  22. #include <linux/tty.h>
  23. #include <linux/tty_flip.h>
  24. #include <linux/spi/spi.h>
  25. #include <linux/uaccess.h>
  26. #define MAX310X_NAME "max310x"
  27. #define MAX310X_MAJOR 204
  28. #define MAX310X_MINOR 209
  29. #define MAX310X_UART_NRMAX 16
  30. /* MAX310X register definitions */
  31. #define MAX310X_RHR_REG (0x00) /* RX FIFO */
  32. #define MAX310X_THR_REG (0x00) /* TX FIFO */
  33. #define MAX310X_IRQEN_REG (0x01) /* IRQ enable */
  34. #define MAX310X_IRQSTS_REG (0x02) /* IRQ status */
  35. #define MAX310X_LSR_IRQEN_REG (0x03) /* LSR IRQ enable */
  36. #define MAX310X_LSR_IRQSTS_REG (0x04) /* LSR IRQ status */
  37. #define MAX310X_REG_05 (0x05)
  38. #define MAX310X_SPCHR_IRQEN_REG MAX310X_REG_05 /* Special char IRQ en */
  39. #define MAX310X_SPCHR_IRQSTS_REG (0x06) /* Special char IRQ status */
  40. #define MAX310X_STS_IRQEN_REG (0x07) /* Status IRQ enable */
  41. #define MAX310X_STS_IRQSTS_REG (0x08) /* Status IRQ status */
  42. #define MAX310X_MODE1_REG (0x09) /* MODE1 */
  43. #define MAX310X_MODE2_REG (0x0a) /* MODE2 */
  44. #define MAX310X_LCR_REG (0x0b) /* LCR */
  45. #define MAX310X_RXTO_REG (0x0c) /* RX timeout */
  46. #define MAX310X_HDPIXDELAY_REG (0x0d) /* Auto transceiver delays */
  47. #define MAX310X_IRDA_REG (0x0e) /* IRDA settings */
  48. #define MAX310X_FLOWLVL_REG (0x0f) /* Flow control levels */
  49. #define MAX310X_FIFOTRIGLVL_REG (0x10) /* FIFO IRQ trigger levels */
  50. #define MAX310X_TXFIFOLVL_REG (0x11) /* TX FIFO level */
  51. #define MAX310X_RXFIFOLVL_REG (0x12) /* RX FIFO level */
  52. #define MAX310X_FLOWCTRL_REG (0x13) /* Flow control */
  53. #define MAX310X_XON1_REG (0x14) /* XON1 character */
  54. #define MAX310X_XON2_REG (0x15) /* XON2 character */
  55. #define MAX310X_XOFF1_REG (0x16) /* XOFF1 character */
  56. #define MAX310X_XOFF2_REG (0x17) /* XOFF2 character */
  57. #define MAX310X_GPIOCFG_REG (0x18) /* GPIO config */
  58. #define MAX310X_GPIODATA_REG (0x19) /* GPIO data */
  59. #define MAX310X_PLLCFG_REG (0x1a) /* PLL config */
  60. #define MAX310X_BRGCFG_REG (0x1b) /* Baud rate generator conf */
  61. #define MAX310X_BRGDIVLSB_REG (0x1c) /* Baud rate divisor LSB */
  62. #define MAX310X_BRGDIVMSB_REG (0x1d) /* Baud rate divisor MSB */
  63. #define MAX310X_CLKSRC_REG (0x1e) /* Clock source */
  64. #define MAX310X_REG_1F (0x1f)
  65. #define MAX310X_REVID_REG MAX310X_REG_1F /* Revision ID */
  66. #define MAX310X_GLOBALIRQ_REG MAX310X_REG_1F /* Global IRQ (RO) */
  67. #define MAX310X_GLOBALCMD_REG MAX310X_REG_1F /* Global Command (WO) */
  68. /* Extended registers */
  69. #define MAX310X_REVID_EXTREG MAX310X_REG_05 /* Revision ID */
  70. /* IRQ register bits */
  71. #define MAX310X_IRQ_LSR_BIT (1 << 0) /* LSR interrupt */
  72. #define MAX310X_IRQ_SPCHR_BIT (1 << 1) /* Special char interrupt */
  73. #define MAX310X_IRQ_STS_BIT (1 << 2) /* Status interrupt */
  74. #define MAX310X_IRQ_RXFIFO_BIT (1 << 3) /* RX FIFO interrupt */
  75. #define MAX310X_IRQ_TXFIFO_BIT (1 << 4) /* TX FIFO interrupt */
  76. #define MAX310X_IRQ_TXEMPTY_BIT (1 << 5) /* TX FIFO empty interrupt */
  77. #define MAX310X_IRQ_RXEMPTY_BIT (1 << 6) /* RX FIFO empty interrupt */
  78. #define MAX310X_IRQ_CTS_BIT (1 << 7) /* CTS interrupt */
  79. /* LSR register bits */
  80. #define MAX310X_LSR_RXTO_BIT (1 << 0) /* RX timeout */
  81. #define MAX310X_LSR_RXOVR_BIT (1 << 1) /* RX overrun */
  82. #define MAX310X_LSR_RXPAR_BIT (1 << 2) /* RX parity error */
  83. #define MAX310X_LSR_FRERR_BIT (1 << 3) /* Frame error */
  84. #define MAX310X_LSR_RXBRK_BIT (1 << 4) /* RX break */
  85. #define MAX310X_LSR_RXNOISE_BIT (1 << 5) /* RX noise */
  86. #define MAX310X_LSR_CTS_BIT (1 << 7) /* CTS pin state */
  87. /* Special character register bits */
  88. #define MAX310X_SPCHR_XON1_BIT (1 << 0) /* XON1 character */
  89. #define MAX310X_SPCHR_XON2_BIT (1 << 1) /* XON2 character */
  90. #define MAX310X_SPCHR_XOFF1_BIT (1 << 2) /* XOFF1 character */
  91. #define MAX310X_SPCHR_XOFF2_BIT (1 << 3) /* XOFF2 character */
  92. #define MAX310X_SPCHR_BREAK_BIT (1 << 4) /* RX break */
  93. #define MAX310X_SPCHR_MULTIDROP_BIT (1 << 5) /* 9-bit multidrop addr char */
  94. /* Status register bits */
  95. #define MAX310X_STS_GPIO0_BIT (1 << 0) /* GPIO 0 interrupt */
  96. #define MAX310X_STS_GPIO1_BIT (1 << 1) /* GPIO 1 interrupt */
  97. #define MAX310X_STS_GPIO2_BIT (1 << 2) /* GPIO 2 interrupt */
  98. #define MAX310X_STS_GPIO3_BIT (1 << 3) /* GPIO 3 interrupt */
  99. #define MAX310X_STS_CLKREADY_BIT (1 << 5) /* Clock ready */
  100. #define MAX310X_STS_SLEEP_BIT (1 << 6) /* Sleep interrupt */
  101. /* MODE1 register bits */
  102. #define MAX310X_MODE1_RXDIS_BIT (1 << 0) /* RX disable */
  103. #define MAX310X_MODE1_TXDIS_BIT (1 << 1) /* TX disable */
  104. #define MAX310X_MODE1_TXHIZ_BIT (1 << 2) /* TX pin three-state */
  105. #define MAX310X_MODE1_RTSHIZ_BIT (1 << 3) /* RTS pin three-state */
  106. #define MAX310X_MODE1_TRNSCVCTRL_BIT (1 << 4) /* Transceiver ctrl enable */
  107. #define MAX310X_MODE1_FORCESLEEP_BIT (1 << 5) /* Force sleep mode */
  108. #define MAX310X_MODE1_AUTOSLEEP_BIT (1 << 6) /* Auto sleep enable */
  109. #define MAX310X_MODE1_IRQSEL_BIT (1 << 7) /* IRQ pin enable */
  110. /* MODE2 register bits */
  111. #define MAX310X_MODE2_RST_BIT (1 << 0) /* Chip reset */
  112. #define MAX310X_MODE2_FIFORST_BIT (1 << 1) /* FIFO reset */
  113. #define MAX310X_MODE2_RXTRIGINV_BIT (1 << 2) /* RX FIFO INT invert */
  114. #define MAX310X_MODE2_RXEMPTINV_BIT (1 << 3) /* RX FIFO empty INT invert */
  115. #define MAX310X_MODE2_SPCHR_BIT (1 << 4) /* Special chr detect enable */
  116. #define MAX310X_MODE2_LOOPBACK_BIT (1 << 5) /* Internal loopback enable */
  117. #define MAX310X_MODE2_MULTIDROP_BIT (1 << 6) /* 9-bit multidrop enable */
  118. #define MAX310X_MODE2_ECHOSUPR_BIT (1 << 7) /* ECHO suppression enable */
  119. /* LCR register bits */
  120. #define MAX310X_LCR_LENGTH0_BIT (1 << 0) /* Word length bit 0 */
  121. #define MAX310X_LCR_LENGTH1_BIT (1 << 1) /* Word length bit 1
  122. *
  123. * Word length bits table:
  124. * 00 -> 5 bit words
  125. * 01 -> 6 bit words
  126. * 10 -> 7 bit words
  127. * 11 -> 8 bit words
  128. */
  129. #define MAX310X_LCR_STOPLEN_BIT (1 << 2) /* STOP length bit
  130. *
  131. * STOP length bit table:
  132. * 0 -> 1 stop bit
  133. * 1 -> 1-1.5 stop bits if
  134. * word length is 5,
  135. * 2 stop bits otherwise
  136. */
  137. #define MAX310X_LCR_PARITY_BIT (1 << 3) /* Parity bit enable */
  138. #define MAX310X_LCR_EVENPARITY_BIT (1 << 4) /* Even parity bit enable */
  139. #define MAX310X_LCR_FORCEPARITY_BIT (1 << 5) /* 9-bit multidrop parity */
  140. #define MAX310X_LCR_TXBREAK_BIT (1 << 6) /* TX break enable */
  141. #define MAX310X_LCR_RTS_BIT (1 << 7) /* RTS pin control */
  142. /* IRDA register bits */
  143. #define MAX310X_IRDA_IRDAEN_BIT (1 << 0) /* IRDA mode enable */
  144. #define MAX310X_IRDA_SIR_BIT (1 << 1) /* SIR mode enable */
  145. /* Flow control trigger level register masks */
  146. #define MAX310X_FLOWLVL_HALT_MASK (0x000f) /* Flow control halt level */
  147. #define MAX310X_FLOWLVL_RES_MASK (0x00f0) /* Flow control resume level */
  148. #define MAX310X_FLOWLVL_HALT(words) ((words / 8) & 0x0f)
  149. #define MAX310X_FLOWLVL_RES(words) (((words / 8) & 0x0f) << 4)
  150. /* FIFO interrupt trigger level register masks */
  151. #define MAX310X_FIFOTRIGLVL_TX_MASK (0x0f) /* TX FIFO trigger level */
  152. #define MAX310X_FIFOTRIGLVL_RX_MASK (0xf0) /* RX FIFO trigger level */
  153. #define MAX310X_FIFOTRIGLVL_TX(words) ((words / 8) & 0x0f)
  154. #define MAX310X_FIFOTRIGLVL_RX(words) (((words / 8) & 0x0f) << 4)
  155. /* Flow control register bits */
  156. #define MAX310X_FLOWCTRL_AUTORTS_BIT (1 << 0) /* Auto RTS flow ctrl enable */
  157. #define MAX310X_FLOWCTRL_AUTOCTS_BIT (1 << 1) /* Auto CTS flow ctrl enable */
  158. #define MAX310X_FLOWCTRL_GPIADDR_BIT (1 << 2) /* Enables that GPIO inputs
  159. * are used in conjunction with
  160. * XOFF2 for definition of
  161. * special character */
  162. #define MAX310X_FLOWCTRL_SWFLOWEN_BIT (1 << 3) /* Auto SW flow ctrl enable */
  163. #define MAX310X_FLOWCTRL_SWFLOW0_BIT (1 << 4) /* SWFLOW bit 0 */
  164. #define MAX310X_FLOWCTRL_SWFLOW1_BIT (1 << 5) /* SWFLOW bit 1
  165. *
  166. * SWFLOW bits 1 & 0 table:
  167. * 00 -> no transmitter flow
  168. * control
  169. * 01 -> receiver compares
  170. * XON2 and XOFF2
  171. * and controls
  172. * transmitter
  173. * 10 -> receiver compares
  174. * XON1 and XOFF1
  175. * and controls
  176. * transmitter
  177. * 11 -> receiver compares
  178. * XON1, XON2, XOFF1 and
  179. * XOFF2 and controls
  180. * transmitter
  181. */
  182. #define MAX310X_FLOWCTRL_SWFLOW2_BIT (1 << 6) /* SWFLOW bit 2 */
  183. #define MAX310X_FLOWCTRL_SWFLOW3_BIT (1 << 7) /* SWFLOW bit 3
  184. *
  185. * SWFLOW bits 3 & 2 table:
  186. * 00 -> no received flow
  187. * control
  188. * 01 -> transmitter generates
  189. * XON2 and XOFF2
  190. * 10 -> transmitter generates
  191. * XON1 and XOFF1
  192. * 11 -> transmitter generates
  193. * XON1, XON2, XOFF1 and
  194. * XOFF2
  195. */
  196. /* PLL configuration register masks */
  197. #define MAX310X_PLLCFG_PREDIV_MASK (0x3f) /* PLL predivision value */
  198. #define MAX310X_PLLCFG_PLLFACTOR_MASK (0xc0) /* PLL multiplication factor */
  199. /* Baud rate generator configuration register bits */
  200. #define MAX310X_BRGCFG_2XMODE_BIT (1 << 4) /* Double baud rate */
  201. #define MAX310X_BRGCFG_4XMODE_BIT (1 << 5) /* Quadruple baud rate */
  202. /* Clock source register bits */
  203. #define MAX310X_CLKSRC_CRYST_BIT (1 << 1) /* Crystal osc enable */
  204. #define MAX310X_CLKSRC_PLL_BIT (1 << 2) /* PLL enable */
  205. #define MAX310X_CLKSRC_PLLBYP_BIT (1 << 3) /* PLL bypass */
  206. #define MAX310X_CLKSRC_EXTCLK_BIT (1 << 4) /* External clock enable */
  207. #define MAX310X_CLKSRC_CLK2RTS_BIT (1 << 7) /* Baud clk to RTS pin */
  208. /* Global commands */
  209. #define MAX310X_EXTREG_ENBL (0xce)
  210. #define MAX310X_EXTREG_DSBL (0xcd)
  211. /* Misc definitions */
  212. #define MAX310X_FIFO_SIZE (128)
  213. #define MAX310x_REV_MASK (0xf8)
  214. #define MAX310X_WRITE_BIT 0x80
  215. /* MAX3107 specific */
  216. #define MAX3107_REV_ID (0xa0)
  217. /* MAX3109 specific */
  218. #define MAX3109_REV_ID (0xc0)
  219. /* MAX14830 specific */
  220. #define MAX14830_BRGCFG_CLKDIS_BIT (1 << 6) /* Clock Disable */
  221. #define MAX14830_REV_ID (0xb0)
  222. struct max310x_devtype {
  223. char name[9];
  224. int nr;
  225. int (*detect)(struct device *);
  226. void (*power)(struct uart_port *, int);
  227. };
  228. struct max310x_one {
  229. struct uart_port port;
  230. struct work_struct tx_work;
  231. struct work_struct md_work;
  232. struct work_struct rs_work;
  233. };
  234. struct max310x_port {
  235. struct max310x_devtype *devtype;
  236. struct regmap *regmap;
  237. struct mutex mutex;
  238. struct clk *clk;
  239. #ifdef CONFIG_GPIOLIB
  240. struct gpio_chip gpio;
  241. #endif
  242. struct max310x_one p[0];
  243. };
  244. static struct uart_driver max310x_uart = {
  245. .owner = THIS_MODULE,
  246. .driver_name = MAX310X_NAME,
  247. .dev_name = "ttyMAX",
  248. .major = MAX310X_MAJOR,
  249. .minor = MAX310X_MINOR,
  250. .nr = MAX310X_UART_NRMAX,
  251. };
  252. static DECLARE_BITMAP(max310x_lines, MAX310X_UART_NRMAX);
  253. static u8 max310x_port_read(struct uart_port *port, u8 reg)
  254. {
  255. struct max310x_port *s = dev_get_drvdata(port->dev);
  256. unsigned int val = 0;
  257. regmap_read(s->regmap, port->iobase + reg, &val);
  258. return val;
  259. }
  260. static void max310x_port_write(struct uart_port *port, u8 reg, u8 val)
  261. {
  262. struct max310x_port *s = dev_get_drvdata(port->dev);
  263. regmap_write(s->regmap, port->iobase + reg, val);
  264. }
  265. static void max310x_port_update(struct uart_port *port, u8 reg, u8 mask, u8 val)
  266. {
  267. struct max310x_port *s = dev_get_drvdata(port->dev);
  268. regmap_update_bits(s->regmap, port->iobase + reg, mask, val);
  269. }
  270. static int max3107_detect(struct device *dev)
  271. {
  272. struct max310x_port *s = dev_get_drvdata(dev);
  273. unsigned int val = 0;
  274. int ret;
  275. ret = regmap_read(s->regmap, MAX310X_REVID_REG, &val);
  276. if (ret)
  277. return ret;
  278. if (((val & MAX310x_REV_MASK) != MAX3107_REV_ID)) {
  279. dev_err(dev,
  280. "%s ID 0x%02x does not match\n", s->devtype->name, val);
  281. return -ENODEV;
  282. }
  283. return 0;
  284. }
  285. static int max3108_detect(struct device *dev)
  286. {
  287. struct max310x_port *s = dev_get_drvdata(dev);
  288. unsigned int val = 0;
  289. int ret;
  290. /* MAX3108 have not REV ID register, we just check default value
  291. * from clocksource register to make sure everything works.
  292. */
  293. ret = regmap_read(s->regmap, MAX310X_CLKSRC_REG, &val);
  294. if (ret)
  295. return ret;
  296. if (val != (MAX310X_CLKSRC_EXTCLK_BIT | MAX310X_CLKSRC_PLLBYP_BIT)) {
  297. dev_err(dev, "%s not present\n", s->devtype->name);
  298. return -ENODEV;
  299. }
  300. return 0;
  301. }
  302. static int max3109_detect(struct device *dev)
  303. {
  304. struct max310x_port *s = dev_get_drvdata(dev);
  305. unsigned int val = 0;
  306. int ret;
  307. ret = regmap_write(s->regmap, MAX310X_GLOBALCMD_REG,
  308. MAX310X_EXTREG_ENBL);
  309. if (ret)
  310. return ret;
  311. regmap_read(s->regmap, MAX310X_REVID_EXTREG, &val);
  312. regmap_write(s->regmap, MAX310X_GLOBALCMD_REG, MAX310X_EXTREG_DSBL);
  313. if (((val & MAX310x_REV_MASK) != MAX3109_REV_ID)) {
  314. dev_err(dev,
  315. "%s ID 0x%02x does not match\n", s->devtype->name, val);
  316. return -ENODEV;
  317. }
  318. return 0;
  319. }
  320. static void max310x_power(struct uart_port *port, int on)
  321. {
  322. max310x_port_update(port, MAX310X_MODE1_REG,
  323. MAX310X_MODE1_FORCESLEEP_BIT,
  324. on ? 0 : MAX310X_MODE1_FORCESLEEP_BIT);
  325. if (on)
  326. msleep(50);
  327. }
  328. static int max14830_detect(struct device *dev)
  329. {
  330. struct max310x_port *s = dev_get_drvdata(dev);
  331. unsigned int val = 0;
  332. int ret;
  333. ret = regmap_write(s->regmap, MAX310X_GLOBALCMD_REG,
  334. MAX310X_EXTREG_ENBL);
  335. if (ret)
  336. return ret;
  337. regmap_read(s->regmap, MAX310X_REVID_EXTREG, &val);
  338. regmap_write(s->regmap, MAX310X_GLOBALCMD_REG, MAX310X_EXTREG_DSBL);
  339. if (((val & MAX310x_REV_MASK) != MAX14830_REV_ID)) {
  340. dev_err(dev,
  341. "%s ID 0x%02x does not match\n", s->devtype->name, val);
  342. return -ENODEV;
  343. }
  344. return 0;
  345. }
  346. static void max14830_power(struct uart_port *port, int on)
  347. {
  348. max310x_port_update(port, MAX310X_BRGCFG_REG,
  349. MAX14830_BRGCFG_CLKDIS_BIT,
  350. on ? 0 : MAX14830_BRGCFG_CLKDIS_BIT);
  351. if (on)
  352. msleep(50);
  353. }
  354. static const struct max310x_devtype max3107_devtype = {
  355. .name = "MAX3107",
  356. .nr = 1,
  357. .detect = max3107_detect,
  358. .power = max310x_power,
  359. };
  360. static const struct max310x_devtype max3108_devtype = {
  361. .name = "MAX3108",
  362. .nr = 1,
  363. .detect = max3108_detect,
  364. .power = max310x_power,
  365. };
  366. static const struct max310x_devtype max3109_devtype = {
  367. .name = "MAX3109",
  368. .nr = 2,
  369. .detect = max3109_detect,
  370. .power = max310x_power,
  371. };
  372. static const struct max310x_devtype max14830_devtype = {
  373. .name = "MAX14830",
  374. .nr = 4,
  375. .detect = max14830_detect,
  376. .power = max14830_power,
  377. };
  378. static bool max310x_reg_writeable(struct device *dev, unsigned int reg)
  379. {
  380. switch (reg & 0x1f) {
  381. case MAX310X_IRQSTS_REG:
  382. case MAX310X_LSR_IRQSTS_REG:
  383. case MAX310X_SPCHR_IRQSTS_REG:
  384. case MAX310X_STS_IRQSTS_REG:
  385. case MAX310X_TXFIFOLVL_REG:
  386. case MAX310X_RXFIFOLVL_REG:
  387. return false;
  388. default:
  389. break;
  390. }
  391. return true;
  392. }
  393. static bool max310x_reg_volatile(struct device *dev, unsigned int reg)
  394. {
  395. switch (reg & 0x1f) {
  396. case MAX310X_RHR_REG:
  397. case MAX310X_IRQSTS_REG:
  398. case MAX310X_LSR_IRQSTS_REG:
  399. case MAX310X_SPCHR_IRQSTS_REG:
  400. case MAX310X_STS_IRQSTS_REG:
  401. case MAX310X_TXFIFOLVL_REG:
  402. case MAX310X_RXFIFOLVL_REG:
  403. case MAX310X_GPIODATA_REG:
  404. case MAX310X_BRGDIVLSB_REG:
  405. case MAX310X_REG_05:
  406. case MAX310X_REG_1F:
  407. return true;
  408. default:
  409. break;
  410. }
  411. return false;
  412. }
  413. static bool max310x_reg_precious(struct device *dev, unsigned int reg)
  414. {
  415. switch (reg & 0x1f) {
  416. case MAX310X_RHR_REG:
  417. case MAX310X_IRQSTS_REG:
  418. case MAX310X_SPCHR_IRQSTS_REG:
  419. case MAX310X_STS_IRQSTS_REG:
  420. return true;
  421. default:
  422. break;
  423. }
  424. return false;
  425. }
  426. static int max310x_set_baud(struct uart_port *port, int baud)
  427. {
  428. unsigned int mode = 0, clk = port->uartclk, div = clk / baud;
  429. /* Check for minimal value for divider */
  430. if (div < 16)
  431. div = 16;
  432. if (clk % baud && (div / 16) < 0x8000) {
  433. /* Mode x2 */
  434. mode = MAX310X_BRGCFG_2XMODE_BIT;
  435. clk = port->uartclk * 2;
  436. div = clk / baud;
  437. if (clk % baud && (div / 16) < 0x8000) {
  438. /* Mode x4 */
  439. mode = MAX310X_BRGCFG_4XMODE_BIT;
  440. clk = port->uartclk * 4;
  441. div = clk / baud;
  442. }
  443. }
  444. max310x_port_write(port, MAX310X_BRGDIVMSB_REG, (div / 16) >> 8);
  445. max310x_port_write(port, MAX310X_BRGDIVLSB_REG, div / 16);
  446. max310x_port_write(port, MAX310X_BRGCFG_REG, (div % 16) | mode);
  447. return DIV_ROUND_CLOSEST(clk, div);
  448. }
  449. static int max310x_update_best_err(unsigned long f, long *besterr)
  450. {
  451. /* Use baudrate 115200 for calculate error */
  452. long err = f % (115200 * 16);
  453. if ((*besterr < 0) || (*besterr > err)) {
  454. *besterr = err;
  455. return 0;
  456. }
  457. return 1;
  458. }
  459. static int max310x_set_ref_clk(struct device *dev, struct max310x_port *s,
  460. unsigned long freq, bool xtal)
  461. {
  462. unsigned int div, clksrc, pllcfg = 0;
  463. long besterr = -1;
  464. unsigned long fdiv, fmul, bestfreq = freq;
  465. /* First, update error without PLL */
  466. max310x_update_best_err(freq, &besterr);
  467. /* Try all possible PLL dividers */
  468. for (div = 1; (div <= 63) && besterr; div++) {
  469. fdiv = DIV_ROUND_CLOSEST(freq, div);
  470. /* Try multiplier 6 */
  471. fmul = fdiv * 6;
  472. if ((fdiv >= 500000) && (fdiv <= 800000))
  473. if (!max310x_update_best_err(fmul, &besterr)) {
  474. pllcfg = (0 << 6) | div;
  475. bestfreq = fmul;
  476. }
  477. /* Try multiplier 48 */
  478. fmul = fdiv * 48;
  479. if ((fdiv >= 850000) && (fdiv <= 1200000))
  480. if (!max310x_update_best_err(fmul, &besterr)) {
  481. pllcfg = (1 << 6) | div;
  482. bestfreq = fmul;
  483. }
  484. /* Try multiplier 96 */
  485. fmul = fdiv * 96;
  486. if ((fdiv >= 425000) && (fdiv <= 1000000))
  487. if (!max310x_update_best_err(fmul, &besterr)) {
  488. pllcfg = (2 << 6) | div;
  489. bestfreq = fmul;
  490. }
  491. /* Try multiplier 144 */
  492. fmul = fdiv * 144;
  493. if ((fdiv >= 390000) && (fdiv <= 667000))
  494. if (!max310x_update_best_err(fmul, &besterr)) {
  495. pllcfg = (3 << 6) | div;
  496. bestfreq = fmul;
  497. }
  498. }
  499. /* Configure clock source */
  500. clksrc = xtal ? MAX310X_CLKSRC_CRYST_BIT : MAX310X_CLKSRC_EXTCLK_BIT;
  501. /* Configure PLL */
  502. if (pllcfg) {
  503. clksrc |= MAX310X_CLKSRC_PLL_BIT;
  504. regmap_write(s->regmap, MAX310X_PLLCFG_REG, pllcfg);
  505. } else
  506. clksrc |= MAX310X_CLKSRC_PLLBYP_BIT;
  507. regmap_write(s->regmap, MAX310X_CLKSRC_REG, clksrc);
  508. /* Wait for crystal */
  509. if (xtal) {
  510. unsigned int val;
  511. msleep(10);
  512. regmap_read(s->regmap, MAX310X_STS_IRQSTS_REG, &val);
  513. if (!(val & MAX310X_STS_CLKREADY_BIT)) {
  514. dev_warn(dev, "clock is not stable yet\n");
  515. }
  516. }
  517. return (int)bestfreq;
  518. }
  519. static void max310x_batch_write(struct uart_port *port, u8 *txbuf, unsigned int len)
  520. {
  521. u8 header[] = { (port->iobase + MAX310X_THR_REG) | MAX310X_WRITE_BIT };
  522. struct spi_transfer xfer[] = {
  523. {
  524. .tx_buf = &header,
  525. .len = sizeof(header),
  526. }, {
  527. .tx_buf = txbuf,
  528. .len = len,
  529. }
  530. };
  531. spi_sync_transfer(to_spi_device(port->dev), xfer, ARRAY_SIZE(xfer));
  532. }
  533. static void max310x_batch_read(struct uart_port *port, u8 *rxbuf, unsigned int len)
  534. {
  535. u8 header[] = { port->iobase + MAX310X_RHR_REG };
  536. struct spi_transfer xfer[] = {
  537. {
  538. .tx_buf = &header,
  539. .len = sizeof(header),
  540. }, {
  541. .rx_buf = rxbuf,
  542. .len = len,
  543. }
  544. };
  545. spi_sync_transfer(to_spi_device(port->dev), xfer, ARRAY_SIZE(xfer));
  546. }
  547. static void max310x_handle_rx(struct uart_port *port, unsigned int rxlen)
  548. {
  549. unsigned int sts, ch, flag, i;
  550. u8 buf[MAX310X_FIFO_SIZE];
  551. if (port->read_status_mask == MAX310X_LSR_RXOVR_BIT) {
  552. /* We are just reading, happily ignoring any error conditions.
  553. * Break condition, parity checking, framing errors -- they
  554. * are all ignored. That means that we can do a batch-read.
  555. *
  556. * There is a small opportunity for race if the RX FIFO
  557. * overruns while we're reading the buffer; the datasheets says
  558. * that the LSR register applies to the "current" character.
  559. * That's also the reason why we cannot do batched reads when
  560. * asked to check the individual statuses.
  561. * */
  562. sts = max310x_port_read(port, MAX310X_LSR_IRQSTS_REG);
  563. max310x_batch_read(port, buf, rxlen);
  564. port->icount.rx += rxlen;
  565. flag = TTY_NORMAL;
  566. sts &= port->read_status_mask;
  567. if (sts & MAX310X_LSR_RXOVR_BIT) {
  568. dev_warn_ratelimited(port->dev, "Hardware RX FIFO overrun\n");
  569. port->icount.overrun++;
  570. }
  571. for (i = 0; i < rxlen; ++i) {
  572. uart_insert_char(port, sts, MAX310X_LSR_RXOVR_BIT, buf[i], flag);
  573. }
  574. } else {
  575. if (unlikely(rxlen >= port->fifosize)) {
  576. dev_warn_ratelimited(port->dev, "Possible RX FIFO overrun\n");
  577. port->icount.buf_overrun++;
  578. /* Ensure sanity of RX level */
  579. rxlen = port->fifosize;
  580. }
  581. while (rxlen--) {
  582. ch = max310x_port_read(port, MAX310X_RHR_REG);
  583. sts = max310x_port_read(port, MAX310X_LSR_IRQSTS_REG);
  584. sts &= MAX310X_LSR_RXPAR_BIT | MAX310X_LSR_FRERR_BIT |
  585. MAX310X_LSR_RXOVR_BIT | MAX310X_LSR_RXBRK_BIT;
  586. port->icount.rx++;
  587. flag = TTY_NORMAL;
  588. if (unlikely(sts)) {
  589. if (sts & MAX310X_LSR_RXBRK_BIT) {
  590. port->icount.brk++;
  591. if (uart_handle_break(port))
  592. continue;
  593. } else if (sts & MAX310X_LSR_RXPAR_BIT)
  594. port->icount.parity++;
  595. else if (sts & MAX310X_LSR_FRERR_BIT)
  596. port->icount.frame++;
  597. else if (sts & MAX310X_LSR_RXOVR_BIT)
  598. port->icount.overrun++;
  599. sts &= port->read_status_mask;
  600. if (sts & MAX310X_LSR_RXBRK_BIT)
  601. flag = TTY_BREAK;
  602. else if (sts & MAX310X_LSR_RXPAR_BIT)
  603. flag = TTY_PARITY;
  604. else if (sts & MAX310X_LSR_FRERR_BIT)
  605. flag = TTY_FRAME;
  606. else if (sts & MAX310X_LSR_RXOVR_BIT)
  607. flag = TTY_OVERRUN;
  608. }
  609. if (uart_handle_sysrq_char(port, ch))
  610. continue;
  611. if (sts & port->ignore_status_mask)
  612. continue;
  613. uart_insert_char(port, sts, MAX310X_LSR_RXOVR_BIT, ch, flag);
  614. }
  615. }
  616. tty_flip_buffer_push(&port->state->port);
  617. }
  618. static void max310x_handle_tx(struct uart_port *port)
  619. {
  620. struct circ_buf *xmit = &port->state->xmit;
  621. unsigned int txlen, to_send, until_end;
  622. if (unlikely(port->x_char)) {
  623. max310x_port_write(port, MAX310X_THR_REG, port->x_char);
  624. port->icount.tx++;
  625. port->x_char = 0;
  626. return;
  627. }
  628. if (uart_circ_empty(xmit) || uart_tx_stopped(port))
  629. return;
  630. /* Get length of data pending in circular buffer */
  631. to_send = uart_circ_chars_pending(xmit);
  632. until_end = CIRC_CNT_TO_END(xmit->head, xmit->tail, UART_XMIT_SIZE);
  633. if (likely(to_send)) {
  634. /* Limit to size of TX FIFO */
  635. txlen = max310x_port_read(port, MAX310X_TXFIFOLVL_REG);
  636. txlen = port->fifosize - txlen;
  637. to_send = (to_send > txlen) ? txlen : to_send;
  638. if (until_end < to_send) {
  639. /* It's a circ buffer -- wrap around.
  640. * We could do that in one SPI transaction, but meh. */
  641. max310x_batch_write(port, xmit->buf + xmit->tail, until_end);
  642. max310x_batch_write(port, xmit->buf, to_send - until_end);
  643. } else {
  644. max310x_batch_write(port, xmit->buf + xmit->tail, to_send);
  645. }
  646. /* Add data to send */
  647. port->icount.tx += to_send;
  648. xmit->tail = (xmit->tail + to_send) & (UART_XMIT_SIZE - 1);
  649. }
  650. if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
  651. uart_write_wakeup(port);
  652. }
  653. static void max310x_start_tx(struct uart_port *port)
  654. {
  655. struct max310x_one *one = container_of(port, struct max310x_one, port);
  656. if (!work_pending(&one->tx_work))
  657. schedule_work(&one->tx_work);
  658. }
  659. static irqreturn_t max310x_port_irq(struct max310x_port *s, int portno)
  660. {
  661. struct uart_port *port = &s->p[portno].port;
  662. irqreturn_t res = IRQ_NONE;
  663. do {
  664. unsigned int ists, lsr, rxlen;
  665. /* Read IRQ status & RX FIFO level */
  666. ists = max310x_port_read(port, MAX310X_IRQSTS_REG);
  667. rxlen = max310x_port_read(port, MAX310X_RXFIFOLVL_REG);
  668. if (!ists && !rxlen)
  669. break;
  670. res = IRQ_HANDLED;
  671. if (ists & MAX310X_IRQ_CTS_BIT) {
  672. lsr = max310x_port_read(port, MAX310X_LSR_IRQSTS_REG);
  673. uart_handle_cts_change(port,
  674. !!(lsr & MAX310X_LSR_CTS_BIT));
  675. }
  676. if (rxlen)
  677. max310x_handle_rx(port, rxlen);
  678. if (ists & MAX310X_IRQ_TXEMPTY_BIT)
  679. max310x_start_tx(port);
  680. } while (1);
  681. return res;
  682. }
  683. static irqreturn_t max310x_ist(int irq, void *dev_id)
  684. {
  685. struct max310x_port *s = (struct max310x_port *)dev_id;
  686. bool handled = false;
  687. if (s->devtype->nr > 1) {
  688. do {
  689. unsigned int val = ~0;
  690. WARN_ON_ONCE(regmap_read(s->regmap,
  691. MAX310X_GLOBALIRQ_REG, &val));
  692. val = ((1 << s->devtype->nr) - 1) & ~val;
  693. if (!val)
  694. break;
  695. if (max310x_port_irq(s, fls(val) - 1) == IRQ_HANDLED)
  696. handled = true;
  697. } while (1);
  698. } else {
  699. if (max310x_port_irq(s, 0) == IRQ_HANDLED)
  700. handled = true;
  701. }
  702. return IRQ_RETVAL(handled);
  703. }
  704. static void max310x_wq_proc(struct work_struct *ws)
  705. {
  706. struct max310x_one *one = container_of(ws, struct max310x_one, tx_work);
  707. struct max310x_port *s = dev_get_drvdata(one->port.dev);
  708. mutex_lock(&s->mutex);
  709. max310x_handle_tx(&one->port);
  710. mutex_unlock(&s->mutex);
  711. }
  712. static unsigned int max310x_tx_empty(struct uart_port *port)
  713. {
  714. unsigned int lvl, sts;
  715. lvl = max310x_port_read(port, MAX310X_TXFIFOLVL_REG);
  716. sts = max310x_port_read(port, MAX310X_IRQSTS_REG);
  717. return ((sts & MAX310X_IRQ_TXEMPTY_BIT) && !lvl) ? TIOCSER_TEMT : 0;
  718. }
  719. static unsigned int max310x_get_mctrl(struct uart_port *port)
  720. {
  721. /* DCD and DSR are not wired and CTS/RTS is handled automatically
  722. * so just indicate DSR and CAR asserted
  723. */
  724. return TIOCM_DSR | TIOCM_CAR;
  725. }
  726. static void max310x_md_proc(struct work_struct *ws)
  727. {
  728. struct max310x_one *one = container_of(ws, struct max310x_one, md_work);
  729. max310x_port_update(&one->port, MAX310X_MODE2_REG,
  730. MAX310X_MODE2_LOOPBACK_BIT,
  731. (one->port.mctrl & TIOCM_LOOP) ?
  732. MAX310X_MODE2_LOOPBACK_BIT : 0);
  733. }
  734. static void max310x_set_mctrl(struct uart_port *port, unsigned int mctrl)
  735. {
  736. struct max310x_one *one = container_of(port, struct max310x_one, port);
  737. schedule_work(&one->md_work);
  738. }
  739. static void max310x_break_ctl(struct uart_port *port, int break_state)
  740. {
  741. max310x_port_update(port, MAX310X_LCR_REG,
  742. MAX310X_LCR_TXBREAK_BIT,
  743. break_state ? MAX310X_LCR_TXBREAK_BIT : 0);
  744. }
  745. static void max310x_set_termios(struct uart_port *port,
  746. struct ktermios *termios,
  747. struct ktermios *old)
  748. {
  749. unsigned int lcr = 0, flow = 0;
  750. int baud;
  751. /* Mask termios capabilities we don't support */
  752. termios->c_cflag &= ~CMSPAR;
  753. /* Word size */
  754. switch (termios->c_cflag & CSIZE) {
  755. case CS5:
  756. break;
  757. case CS6:
  758. lcr = MAX310X_LCR_LENGTH0_BIT;
  759. break;
  760. case CS7:
  761. lcr = MAX310X_LCR_LENGTH1_BIT;
  762. break;
  763. case CS8:
  764. default:
  765. lcr = MAX310X_LCR_LENGTH1_BIT | MAX310X_LCR_LENGTH0_BIT;
  766. break;
  767. }
  768. /* Parity */
  769. if (termios->c_cflag & PARENB) {
  770. lcr |= MAX310X_LCR_PARITY_BIT;
  771. if (!(termios->c_cflag & PARODD))
  772. lcr |= MAX310X_LCR_EVENPARITY_BIT;
  773. }
  774. /* Stop bits */
  775. if (termios->c_cflag & CSTOPB)
  776. lcr |= MAX310X_LCR_STOPLEN_BIT; /* 2 stops */
  777. /* Update LCR register */
  778. max310x_port_write(port, MAX310X_LCR_REG, lcr);
  779. /* Set read status mask */
  780. port->read_status_mask = MAX310X_LSR_RXOVR_BIT;
  781. if (termios->c_iflag & INPCK)
  782. port->read_status_mask |= MAX310X_LSR_RXPAR_BIT |
  783. MAX310X_LSR_FRERR_BIT;
  784. if (termios->c_iflag & (IGNBRK | BRKINT | PARMRK))
  785. port->read_status_mask |= MAX310X_LSR_RXBRK_BIT;
  786. /* Set status ignore mask */
  787. port->ignore_status_mask = 0;
  788. if (termios->c_iflag & IGNBRK)
  789. port->ignore_status_mask |= MAX310X_LSR_RXBRK_BIT;
  790. if (!(termios->c_cflag & CREAD))
  791. port->ignore_status_mask |= MAX310X_LSR_RXPAR_BIT |
  792. MAX310X_LSR_RXOVR_BIT |
  793. MAX310X_LSR_FRERR_BIT |
  794. MAX310X_LSR_RXBRK_BIT;
  795. /* Configure flow control */
  796. max310x_port_write(port, MAX310X_XON1_REG, termios->c_cc[VSTART]);
  797. max310x_port_write(port, MAX310X_XOFF1_REG, termios->c_cc[VSTOP]);
  798. if (termios->c_cflag & CRTSCTS)
  799. flow |= MAX310X_FLOWCTRL_AUTOCTS_BIT |
  800. MAX310X_FLOWCTRL_AUTORTS_BIT;
  801. if (termios->c_iflag & IXON)
  802. flow |= MAX310X_FLOWCTRL_SWFLOW3_BIT |
  803. MAX310X_FLOWCTRL_SWFLOWEN_BIT;
  804. if (termios->c_iflag & IXOFF)
  805. flow |= MAX310X_FLOWCTRL_SWFLOW1_BIT |
  806. MAX310X_FLOWCTRL_SWFLOWEN_BIT;
  807. max310x_port_write(port, MAX310X_FLOWCTRL_REG, flow);
  808. /* Get baud rate generator configuration */
  809. baud = uart_get_baud_rate(port, termios, old,
  810. port->uartclk / 16 / 0xffff,
  811. port->uartclk / 4);
  812. /* Setup baudrate generator */
  813. baud = max310x_set_baud(port, baud);
  814. /* Update timeout according to new baud rate */
  815. uart_update_timeout(port, termios->c_cflag, baud);
  816. }
  817. static void max310x_rs_proc(struct work_struct *ws)
  818. {
  819. struct max310x_one *one = container_of(ws, struct max310x_one, rs_work);
  820. unsigned int val;
  821. val = (one->port.rs485.delay_rts_before_send << 4) |
  822. one->port.rs485.delay_rts_after_send;
  823. max310x_port_write(&one->port, MAX310X_HDPIXDELAY_REG, val);
  824. if (one->port.rs485.flags & SER_RS485_ENABLED) {
  825. max310x_port_update(&one->port, MAX310X_MODE1_REG,
  826. MAX310X_MODE1_TRNSCVCTRL_BIT,
  827. MAX310X_MODE1_TRNSCVCTRL_BIT);
  828. max310x_port_update(&one->port, MAX310X_MODE2_REG,
  829. MAX310X_MODE2_ECHOSUPR_BIT,
  830. MAX310X_MODE2_ECHOSUPR_BIT);
  831. } else {
  832. max310x_port_update(&one->port, MAX310X_MODE1_REG,
  833. MAX310X_MODE1_TRNSCVCTRL_BIT, 0);
  834. max310x_port_update(&one->port, MAX310X_MODE2_REG,
  835. MAX310X_MODE2_ECHOSUPR_BIT, 0);
  836. }
  837. }
  838. static int max310x_rs485_config(struct uart_port *port,
  839. struct serial_rs485 *rs485)
  840. {
  841. struct max310x_one *one = container_of(port, struct max310x_one, port);
  842. if ((rs485->delay_rts_before_send > 0x0f) ||
  843. (rs485->delay_rts_after_send > 0x0f))
  844. return -ERANGE;
  845. rs485->flags &= SER_RS485_RTS_ON_SEND | SER_RS485_ENABLED;
  846. memset(rs485->padding, 0, sizeof(rs485->padding));
  847. port->rs485 = *rs485;
  848. schedule_work(&one->rs_work);
  849. return 0;
  850. }
  851. static int max310x_startup(struct uart_port *port)
  852. {
  853. struct max310x_port *s = dev_get_drvdata(port->dev);
  854. unsigned int val;
  855. s->devtype->power(port, 1);
  856. /* Configure MODE1 register */
  857. max310x_port_update(port, MAX310X_MODE1_REG,
  858. MAX310X_MODE1_TRNSCVCTRL_BIT, 0);
  859. /* Configure MODE2 register & Reset FIFOs*/
  860. val = MAX310X_MODE2_RXEMPTINV_BIT | MAX310X_MODE2_FIFORST_BIT;
  861. max310x_port_write(port, MAX310X_MODE2_REG, val);
  862. max310x_port_update(port, MAX310X_MODE2_REG,
  863. MAX310X_MODE2_FIFORST_BIT, 0);
  864. /* Configure flow control levels */
  865. /* Flow control halt level 96, resume level 48 */
  866. max310x_port_write(port, MAX310X_FLOWLVL_REG,
  867. MAX310X_FLOWLVL_RES(48) | MAX310X_FLOWLVL_HALT(96));
  868. /* Clear IRQ status register */
  869. max310x_port_read(port, MAX310X_IRQSTS_REG);
  870. /* Enable RX, TX, CTS change interrupts */
  871. val = MAX310X_IRQ_RXEMPTY_BIT | MAX310X_IRQ_TXEMPTY_BIT;
  872. max310x_port_write(port, MAX310X_IRQEN_REG, val | MAX310X_IRQ_CTS_BIT);
  873. return 0;
  874. }
  875. static void max310x_shutdown(struct uart_port *port)
  876. {
  877. struct max310x_port *s = dev_get_drvdata(port->dev);
  878. /* Disable all interrupts */
  879. max310x_port_write(port, MAX310X_IRQEN_REG, 0);
  880. s->devtype->power(port, 0);
  881. }
  882. static const char *max310x_type(struct uart_port *port)
  883. {
  884. struct max310x_port *s = dev_get_drvdata(port->dev);
  885. return (port->type == PORT_MAX310X) ? s->devtype->name : NULL;
  886. }
  887. static int max310x_request_port(struct uart_port *port)
  888. {
  889. /* Do nothing */
  890. return 0;
  891. }
  892. static void max310x_config_port(struct uart_port *port, int flags)
  893. {
  894. if (flags & UART_CONFIG_TYPE)
  895. port->type = PORT_MAX310X;
  896. }
  897. static int max310x_verify_port(struct uart_port *port, struct serial_struct *s)
  898. {
  899. if ((s->type != PORT_UNKNOWN) && (s->type != PORT_MAX310X))
  900. return -EINVAL;
  901. if (s->irq != port->irq)
  902. return -EINVAL;
  903. return 0;
  904. }
  905. static void max310x_null_void(struct uart_port *port)
  906. {
  907. /* Do nothing */
  908. }
  909. static const struct uart_ops max310x_ops = {
  910. .tx_empty = max310x_tx_empty,
  911. .set_mctrl = max310x_set_mctrl,
  912. .get_mctrl = max310x_get_mctrl,
  913. .stop_tx = max310x_null_void,
  914. .start_tx = max310x_start_tx,
  915. .stop_rx = max310x_null_void,
  916. .break_ctl = max310x_break_ctl,
  917. .startup = max310x_startup,
  918. .shutdown = max310x_shutdown,
  919. .set_termios = max310x_set_termios,
  920. .type = max310x_type,
  921. .request_port = max310x_request_port,
  922. .release_port = max310x_null_void,
  923. .config_port = max310x_config_port,
  924. .verify_port = max310x_verify_port,
  925. };
  926. static int __maybe_unused max310x_suspend(struct device *dev)
  927. {
  928. struct max310x_port *s = dev_get_drvdata(dev);
  929. int i;
  930. for (i = 0; i < s->devtype->nr; i++) {
  931. uart_suspend_port(&max310x_uart, &s->p[i].port);
  932. s->devtype->power(&s->p[i].port, 0);
  933. }
  934. return 0;
  935. }
  936. static int __maybe_unused max310x_resume(struct device *dev)
  937. {
  938. struct max310x_port *s = dev_get_drvdata(dev);
  939. int i;
  940. for (i = 0; i < s->devtype->nr; i++) {
  941. s->devtype->power(&s->p[i].port, 1);
  942. uart_resume_port(&max310x_uart, &s->p[i].port);
  943. }
  944. return 0;
  945. }
  946. static SIMPLE_DEV_PM_OPS(max310x_pm_ops, max310x_suspend, max310x_resume);
  947. #ifdef CONFIG_GPIOLIB
  948. static int max310x_gpio_get(struct gpio_chip *chip, unsigned offset)
  949. {
  950. unsigned int val;
  951. struct max310x_port *s = gpiochip_get_data(chip);
  952. struct uart_port *port = &s->p[offset / 4].port;
  953. val = max310x_port_read(port, MAX310X_GPIODATA_REG);
  954. return !!((val >> 4) & (1 << (offset % 4)));
  955. }
  956. static void max310x_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
  957. {
  958. struct max310x_port *s = gpiochip_get_data(chip);
  959. struct uart_port *port = &s->p[offset / 4].port;
  960. max310x_port_update(port, MAX310X_GPIODATA_REG, 1 << (offset % 4),
  961. value ? 1 << (offset % 4) : 0);
  962. }
  963. static int max310x_gpio_direction_input(struct gpio_chip *chip, unsigned offset)
  964. {
  965. struct max310x_port *s = gpiochip_get_data(chip);
  966. struct uart_port *port = &s->p[offset / 4].port;
  967. max310x_port_update(port, MAX310X_GPIOCFG_REG, 1 << (offset % 4), 0);
  968. return 0;
  969. }
  970. static int max310x_gpio_direction_output(struct gpio_chip *chip,
  971. unsigned offset, int value)
  972. {
  973. struct max310x_port *s = gpiochip_get_data(chip);
  974. struct uart_port *port = &s->p[offset / 4].port;
  975. max310x_port_update(port, MAX310X_GPIODATA_REG, 1 << (offset % 4),
  976. value ? 1 << (offset % 4) : 0);
  977. max310x_port_update(port, MAX310X_GPIOCFG_REG, 1 << (offset % 4),
  978. 1 << (offset % 4));
  979. return 0;
  980. }
  981. static int max310x_gpio_set_config(struct gpio_chip *chip, unsigned int offset,
  982. unsigned long config)
  983. {
  984. struct max310x_port *s = gpiochip_get_data(chip);
  985. struct uart_port *port = &s->p[offset / 4].port;
  986. switch (pinconf_to_config_param(config)) {
  987. case PIN_CONFIG_DRIVE_OPEN_DRAIN:
  988. max310x_port_update(port, MAX310X_GPIOCFG_REG,
  989. 1 << ((offset % 4) + 4),
  990. 1 << ((offset % 4) + 4));
  991. return 0;
  992. case PIN_CONFIG_DRIVE_PUSH_PULL:
  993. max310x_port_update(port, MAX310X_GPIOCFG_REG,
  994. 1 << ((offset % 4) + 4), 0);
  995. return 0;
  996. default:
  997. return -ENOTSUPP;
  998. }
  999. }
  1000. #endif
  1001. static int max310x_probe(struct device *dev, struct max310x_devtype *devtype,
  1002. struct regmap *regmap, int irq)
  1003. {
  1004. int i, ret, fmin, fmax, freq, uartclk;
  1005. struct clk *clk_osc, *clk_xtal;
  1006. struct max310x_port *s;
  1007. bool xtal = false;
  1008. if (IS_ERR(regmap))
  1009. return PTR_ERR(regmap);
  1010. /* Alloc port structure */
  1011. s = devm_kzalloc(dev, sizeof(*s) +
  1012. sizeof(struct max310x_one) * devtype->nr, GFP_KERNEL);
  1013. if (!s) {
  1014. dev_err(dev, "Error allocating port structure\n");
  1015. return -ENOMEM;
  1016. }
  1017. clk_osc = devm_clk_get(dev, "osc");
  1018. clk_xtal = devm_clk_get(dev, "xtal");
  1019. if (!IS_ERR(clk_osc)) {
  1020. s->clk = clk_osc;
  1021. fmin = 500000;
  1022. fmax = 35000000;
  1023. } else if (!IS_ERR(clk_xtal)) {
  1024. s->clk = clk_xtal;
  1025. fmin = 1000000;
  1026. fmax = 4000000;
  1027. xtal = true;
  1028. } else if (PTR_ERR(clk_osc) == -EPROBE_DEFER ||
  1029. PTR_ERR(clk_xtal) == -EPROBE_DEFER) {
  1030. return -EPROBE_DEFER;
  1031. } else {
  1032. dev_err(dev, "Cannot get clock\n");
  1033. return -EINVAL;
  1034. }
  1035. ret = clk_prepare_enable(s->clk);
  1036. if (ret)
  1037. return ret;
  1038. freq = clk_get_rate(s->clk);
  1039. /* Check frequency limits */
  1040. if (freq < fmin || freq > fmax) {
  1041. ret = -ERANGE;
  1042. goto out_clk;
  1043. }
  1044. s->regmap = regmap;
  1045. s->devtype = devtype;
  1046. dev_set_drvdata(dev, s);
  1047. /* Check device to ensure we are talking to what we expect */
  1048. ret = devtype->detect(dev);
  1049. if (ret)
  1050. goto out_clk;
  1051. for (i = 0; i < devtype->nr; i++) {
  1052. unsigned int offs = i << 5;
  1053. /* Reset port */
  1054. regmap_write(s->regmap, MAX310X_MODE2_REG + offs,
  1055. MAX310X_MODE2_RST_BIT);
  1056. /* Clear port reset */
  1057. regmap_write(s->regmap, MAX310X_MODE2_REG + offs, 0);
  1058. /* Wait for port startup */
  1059. do {
  1060. regmap_read(s->regmap,
  1061. MAX310X_BRGDIVLSB_REG + offs, &ret);
  1062. } while (ret != 0x01);
  1063. regmap_update_bits(s->regmap, MAX310X_MODE1_REG + offs,
  1064. MAX310X_MODE1_AUTOSLEEP_BIT,
  1065. MAX310X_MODE1_AUTOSLEEP_BIT);
  1066. }
  1067. uartclk = max310x_set_ref_clk(dev, s, freq, xtal);
  1068. dev_dbg(dev, "Reference clock set to %i Hz\n", uartclk);
  1069. mutex_init(&s->mutex);
  1070. for (i = 0; i < devtype->nr; i++) {
  1071. unsigned int line;
  1072. line = find_first_zero_bit(max310x_lines, MAX310X_UART_NRMAX);
  1073. if (line == MAX310X_UART_NRMAX) {
  1074. ret = -ERANGE;
  1075. goto out_uart;
  1076. }
  1077. /* Initialize port data */
  1078. s->p[i].port.line = line;
  1079. s->p[i].port.dev = dev;
  1080. s->p[i].port.irq = irq;
  1081. s->p[i].port.type = PORT_MAX310X;
  1082. s->p[i].port.fifosize = MAX310X_FIFO_SIZE;
  1083. s->p[i].port.flags = UPF_FIXED_TYPE | UPF_LOW_LATENCY;
  1084. s->p[i].port.iotype = UPIO_PORT;
  1085. s->p[i].port.iobase = i * 0x20;
  1086. s->p[i].port.membase = (void __iomem *)~0;
  1087. s->p[i].port.uartclk = uartclk;
  1088. s->p[i].port.rs485_config = max310x_rs485_config;
  1089. s->p[i].port.ops = &max310x_ops;
  1090. /* Disable all interrupts */
  1091. max310x_port_write(&s->p[i].port, MAX310X_IRQEN_REG, 0);
  1092. /* Clear IRQ status register */
  1093. max310x_port_read(&s->p[i].port, MAX310X_IRQSTS_REG);
  1094. /* Enable IRQ pin */
  1095. max310x_port_update(&s->p[i].port, MAX310X_MODE1_REG,
  1096. MAX310X_MODE1_IRQSEL_BIT,
  1097. MAX310X_MODE1_IRQSEL_BIT);
  1098. /* Initialize queue for start TX */
  1099. INIT_WORK(&s->p[i].tx_work, max310x_wq_proc);
  1100. /* Initialize queue for changing LOOPBACK mode */
  1101. INIT_WORK(&s->p[i].md_work, max310x_md_proc);
  1102. /* Initialize queue for changing RS485 mode */
  1103. INIT_WORK(&s->p[i].rs_work, max310x_rs_proc);
  1104. /* Register port */
  1105. ret = uart_add_one_port(&max310x_uart, &s->p[i].port);
  1106. if (ret) {
  1107. s->p[i].port.dev = NULL;
  1108. goto out_uart;
  1109. }
  1110. set_bit(line, max310x_lines);
  1111. /* Go to suspend mode */
  1112. devtype->power(&s->p[i].port, 0);
  1113. }
  1114. #ifdef CONFIG_GPIOLIB
  1115. /* Setup GPIO cotroller */
  1116. s->gpio.owner = THIS_MODULE;
  1117. s->gpio.parent = dev;
  1118. s->gpio.label = devtype->name;
  1119. s->gpio.direction_input = max310x_gpio_direction_input;
  1120. s->gpio.get = max310x_gpio_get;
  1121. s->gpio.direction_output= max310x_gpio_direction_output;
  1122. s->gpio.set = max310x_gpio_set;
  1123. s->gpio.set_config = max310x_gpio_set_config;
  1124. s->gpio.base = -1;
  1125. s->gpio.ngpio = devtype->nr * 4;
  1126. s->gpio.can_sleep = 1;
  1127. ret = devm_gpiochip_add_data(dev, &s->gpio, s);
  1128. if (ret)
  1129. goto out_uart;
  1130. #endif
  1131. /* Setup interrupt */
  1132. ret = devm_request_threaded_irq(dev, irq, NULL, max310x_ist,
  1133. IRQF_ONESHOT | IRQF_SHARED, dev_name(dev), s);
  1134. if (!ret)
  1135. return 0;
  1136. dev_err(dev, "Unable to reguest IRQ %i\n", irq);
  1137. out_uart:
  1138. for (i = 0; i < devtype->nr; i++) {
  1139. if (s->p[i].port.dev) {
  1140. uart_remove_one_port(&max310x_uart, &s->p[i].port);
  1141. clear_bit(s->p[i].port.line, max310x_lines);
  1142. }
  1143. }
  1144. mutex_destroy(&s->mutex);
  1145. out_clk:
  1146. clk_disable_unprepare(s->clk);
  1147. return ret;
  1148. }
  1149. static int max310x_remove(struct device *dev)
  1150. {
  1151. struct max310x_port *s = dev_get_drvdata(dev);
  1152. int i;
  1153. for (i = 0; i < s->devtype->nr; i++) {
  1154. cancel_work_sync(&s->p[i].tx_work);
  1155. cancel_work_sync(&s->p[i].md_work);
  1156. cancel_work_sync(&s->p[i].rs_work);
  1157. uart_remove_one_port(&max310x_uart, &s->p[i].port);
  1158. clear_bit(s->p[i].port.line, max310x_lines);
  1159. s->devtype->power(&s->p[i].port, 0);
  1160. }
  1161. mutex_destroy(&s->mutex);
  1162. clk_disable_unprepare(s->clk);
  1163. return 0;
  1164. }
  1165. static const struct of_device_id __maybe_unused max310x_dt_ids[] = {
  1166. { .compatible = "maxim,max3107", .data = &max3107_devtype, },
  1167. { .compatible = "maxim,max3108", .data = &max3108_devtype, },
  1168. { .compatible = "maxim,max3109", .data = &max3109_devtype, },
  1169. { .compatible = "maxim,max14830", .data = &max14830_devtype },
  1170. { }
  1171. };
  1172. MODULE_DEVICE_TABLE(of, max310x_dt_ids);
  1173. static struct regmap_config regcfg = {
  1174. .reg_bits = 8,
  1175. .val_bits = 8,
  1176. .write_flag_mask = MAX310X_WRITE_BIT,
  1177. .cache_type = REGCACHE_RBTREE,
  1178. .writeable_reg = max310x_reg_writeable,
  1179. .volatile_reg = max310x_reg_volatile,
  1180. .precious_reg = max310x_reg_precious,
  1181. };
  1182. #ifdef CONFIG_SPI_MASTER
  1183. static int max310x_spi_probe(struct spi_device *spi)
  1184. {
  1185. struct max310x_devtype *devtype;
  1186. struct regmap *regmap;
  1187. int ret;
  1188. /* Setup SPI bus */
  1189. spi->bits_per_word = 8;
  1190. spi->mode = spi->mode ? : SPI_MODE_0;
  1191. spi->max_speed_hz = spi->max_speed_hz ? : 26000000;
  1192. ret = spi_setup(spi);
  1193. if (ret)
  1194. return ret;
  1195. if (spi->dev.of_node) {
  1196. const struct of_device_id *of_id =
  1197. of_match_device(max310x_dt_ids, &spi->dev);
  1198. devtype = (struct max310x_devtype *)of_id->data;
  1199. } else {
  1200. const struct spi_device_id *id_entry = spi_get_device_id(spi);
  1201. devtype = (struct max310x_devtype *)id_entry->driver_data;
  1202. }
  1203. regcfg.max_register = devtype->nr * 0x20 - 1;
  1204. regmap = devm_regmap_init_spi(spi, &regcfg);
  1205. return max310x_probe(&spi->dev, devtype, regmap, spi->irq);
  1206. }
  1207. static int max310x_spi_remove(struct spi_device *spi)
  1208. {
  1209. return max310x_remove(&spi->dev);
  1210. }
  1211. static const struct spi_device_id max310x_id_table[] = {
  1212. { "max3107", (kernel_ulong_t)&max3107_devtype, },
  1213. { "max3108", (kernel_ulong_t)&max3108_devtype, },
  1214. { "max3109", (kernel_ulong_t)&max3109_devtype, },
  1215. { "max14830", (kernel_ulong_t)&max14830_devtype, },
  1216. { }
  1217. };
  1218. MODULE_DEVICE_TABLE(spi, max310x_id_table);
  1219. static struct spi_driver max310x_spi_driver = {
  1220. .driver = {
  1221. .name = MAX310X_NAME,
  1222. .of_match_table = of_match_ptr(max310x_dt_ids),
  1223. .pm = &max310x_pm_ops,
  1224. },
  1225. .probe = max310x_spi_probe,
  1226. .remove = max310x_spi_remove,
  1227. .id_table = max310x_id_table,
  1228. };
  1229. #endif
  1230. static int __init max310x_uart_init(void)
  1231. {
  1232. int ret;
  1233. bitmap_zero(max310x_lines, MAX310X_UART_NRMAX);
  1234. ret = uart_register_driver(&max310x_uart);
  1235. if (ret)
  1236. return ret;
  1237. #ifdef CONFIG_SPI_MASTER
  1238. spi_register_driver(&max310x_spi_driver);
  1239. #endif
  1240. return 0;
  1241. }
  1242. module_init(max310x_uart_init);
  1243. static void __exit max310x_uart_exit(void)
  1244. {
  1245. #ifdef CONFIG_SPI_MASTER
  1246. spi_unregister_driver(&max310x_spi_driver);
  1247. #endif
  1248. uart_unregister_driver(&max310x_uart);
  1249. }
  1250. module_exit(max310x_uart_exit);
  1251. MODULE_LICENSE("GPL");
  1252. MODULE_AUTHOR("Alexander Shiyan <shc_work@mail.ru>");
  1253. MODULE_DESCRIPTION("MAX310X serial driver");