max310x.c 36 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256
  1. /*
  2. * Maxim (Dallas) MAX3107/8 serial driver
  3. *
  4. * Copyright (C) 2012 Alexander Shiyan <shc_work@mail.ru>
  5. *
  6. * Based on max3100.c, by Christian Pellegrin <chripell@evolware.org>
  7. * Based on max3110.c, by Feng Tang <feng.tang@intel.com>
  8. * Based on max3107.c, by Aavamobile
  9. *
  10. * This program is free software; you can redistribute it and/or modify
  11. * it under the terms of the GNU General Public License as published by
  12. * the Free Software Foundation; either version 2 of the License, or
  13. * (at your option) any later version.
  14. */
  15. /* TODO: MAX3109 support (Dual) */
  16. /* TODO: MAX14830 support (Quad) */
  17. #include <linux/module.h>
  18. #include <linux/device.h>
  19. #include <linux/serial_core.h>
  20. #include <linux/serial.h>
  21. #include <linux/tty.h>
  22. #include <linux/tty_flip.h>
  23. #include <linux/regmap.h>
  24. #include <linux/gpio.h>
  25. #include <linux/spi/spi.h>
  26. #include <linux/platform_data/max310x.h>
  27. #define MAX310X_MAJOR 204
  28. #define MAX310X_MINOR 209
  29. /* MAX310X register definitions */
  30. #define MAX310X_RHR_REG (0x00) /* RX FIFO */
  31. #define MAX310X_THR_REG (0x00) /* TX FIFO */
  32. #define MAX310X_IRQEN_REG (0x01) /* IRQ enable */
  33. #define MAX310X_IRQSTS_REG (0x02) /* IRQ status */
  34. #define MAX310X_LSR_IRQEN_REG (0x03) /* LSR IRQ enable */
  35. #define MAX310X_LSR_IRQSTS_REG (0x04) /* LSR IRQ status */
  36. #define MAX310X_SPCHR_IRQEN_REG (0x05) /* Special char IRQ enable */
  37. #define MAX310X_SPCHR_IRQSTS_REG (0x06) /* Special char IRQ status */
  38. #define MAX310X_STS_IRQEN_REG (0x07) /* Status IRQ enable */
  39. #define MAX310X_STS_IRQSTS_REG (0x08) /* Status IRQ status */
  40. #define MAX310X_MODE1_REG (0x09) /* MODE1 */
  41. #define MAX310X_MODE2_REG (0x0a) /* MODE2 */
  42. #define MAX310X_LCR_REG (0x0b) /* LCR */
  43. #define MAX310X_RXTO_REG (0x0c) /* RX timeout */
  44. #define MAX310X_HDPIXDELAY_REG (0x0d) /* Auto transceiver delays */
  45. #define MAX310X_IRDA_REG (0x0e) /* IRDA settings */
  46. #define MAX310X_FLOWLVL_REG (0x0f) /* Flow control levels */
  47. #define MAX310X_FIFOTRIGLVL_REG (0x10) /* FIFO IRQ trigger levels */
  48. #define MAX310X_TXFIFOLVL_REG (0x11) /* TX FIFO level */
  49. #define MAX310X_RXFIFOLVL_REG (0x12) /* RX FIFO level */
  50. #define MAX310X_FLOWCTRL_REG (0x13) /* Flow control */
  51. #define MAX310X_XON1_REG (0x14) /* XON1 character */
  52. #define MAX310X_XON2_REG (0x15) /* XON2 character */
  53. #define MAX310X_XOFF1_REG (0x16) /* XOFF1 character */
  54. #define MAX310X_XOFF2_REG (0x17) /* XOFF2 character */
  55. #define MAX310X_GPIOCFG_REG (0x18) /* GPIO config */
  56. #define MAX310X_GPIODATA_REG (0x19) /* GPIO data */
  57. #define MAX310X_PLLCFG_REG (0x1a) /* PLL config */
  58. #define MAX310X_BRGCFG_REG (0x1b) /* Baud rate generator conf */
  59. #define MAX310X_BRGDIVLSB_REG (0x1c) /* Baud rate divisor LSB */
  60. #define MAX310X_BRGDIVMSB_REG (0x1d) /* Baud rate divisor MSB */
  61. #define MAX310X_CLKSRC_REG (0x1e) /* Clock source */
  62. /* Only present in MAX3107 */
  63. #define MAX3107_REVID_REG (0x1f) /* Revision identification */
  64. /* IRQ register bits */
  65. #define MAX310X_IRQ_LSR_BIT (1 << 0) /* LSR interrupt */
  66. #define MAX310X_IRQ_SPCHR_BIT (1 << 1) /* Special char interrupt */
  67. #define MAX310X_IRQ_STS_BIT (1 << 2) /* Status interrupt */
  68. #define MAX310X_IRQ_RXFIFO_BIT (1 << 3) /* RX FIFO interrupt */
  69. #define MAX310X_IRQ_TXFIFO_BIT (1 << 4) /* TX FIFO interrupt */
  70. #define MAX310X_IRQ_TXEMPTY_BIT (1 << 5) /* TX FIFO empty interrupt */
  71. #define MAX310X_IRQ_RXEMPTY_BIT (1 << 6) /* RX FIFO empty interrupt */
  72. #define MAX310X_IRQ_CTS_BIT (1 << 7) /* CTS interrupt */
  73. /* LSR register bits */
  74. #define MAX310X_LSR_RXTO_BIT (1 << 0) /* RX timeout */
  75. #define MAX310X_LSR_RXOVR_BIT (1 << 1) /* RX overrun */
  76. #define MAX310X_LSR_RXPAR_BIT (1 << 2) /* RX parity error */
  77. #define MAX310X_LSR_FRERR_BIT (1 << 3) /* Frame error */
  78. #define MAX310X_LSR_RXBRK_BIT (1 << 4) /* RX break */
  79. #define MAX310X_LSR_RXNOISE_BIT (1 << 5) /* RX noise */
  80. #define MAX310X_LSR_CTS_BIT (1 << 7) /* CTS pin state */
  81. /* Special character register bits */
  82. #define MAX310X_SPCHR_XON1_BIT (1 << 0) /* XON1 character */
  83. #define MAX310X_SPCHR_XON2_BIT (1 << 1) /* XON2 character */
  84. #define MAX310X_SPCHR_XOFF1_BIT (1 << 2) /* XOFF1 character */
  85. #define MAX310X_SPCHR_XOFF2_BIT (1 << 3) /* XOFF2 character */
  86. #define MAX310X_SPCHR_BREAK_BIT (1 << 4) /* RX break */
  87. #define MAX310X_SPCHR_MULTIDROP_BIT (1 << 5) /* 9-bit multidrop addr char */
  88. /* Status register bits */
  89. #define MAX310X_STS_GPIO0_BIT (1 << 0) /* GPIO 0 interrupt */
  90. #define MAX310X_STS_GPIO1_BIT (1 << 1) /* GPIO 1 interrupt */
  91. #define MAX310X_STS_GPIO2_BIT (1 << 2) /* GPIO 2 interrupt */
  92. #define MAX310X_STS_GPIO3_BIT (1 << 3) /* GPIO 3 interrupt */
  93. #define MAX310X_STS_CLKREADY_BIT (1 << 5) /* Clock ready */
  94. #define MAX310X_STS_SLEEP_BIT (1 << 6) /* Sleep interrupt */
  95. /* MODE1 register bits */
  96. #define MAX310X_MODE1_RXDIS_BIT (1 << 0) /* RX disable */
  97. #define MAX310X_MODE1_TXDIS_BIT (1 << 1) /* TX disable */
  98. #define MAX310X_MODE1_TXHIZ_BIT (1 << 2) /* TX pin three-state */
  99. #define MAX310X_MODE1_RTSHIZ_BIT (1 << 3) /* RTS pin three-state */
  100. #define MAX310X_MODE1_TRNSCVCTRL_BIT (1 << 4) /* Transceiver ctrl enable */
  101. #define MAX310X_MODE1_FORCESLEEP_BIT (1 << 5) /* Force sleep mode */
  102. #define MAX310X_MODE1_AUTOSLEEP_BIT (1 << 6) /* Auto sleep enable */
  103. #define MAX310X_MODE1_IRQSEL_BIT (1 << 7) /* IRQ pin enable */
  104. /* MODE2 register bits */
  105. #define MAX310X_MODE2_RST_BIT (1 << 0) /* Chip reset */
  106. #define MAX310X_MODE2_FIFORST_BIT (1 << 1) /* FIFO reset */
  107. #define MAX310X_MODE2_RXTRIGINV_BIT (1 << 2) /* RX FIFO INT invert */
  108. #define MAX310X_MODE2_RXEMPTINV_BIT (1 << 3) /* RX FIFO empty INT invert */
  109. #define MAX310X_MODE2_SPCHR_BIT (1 << 4) /* Special chr detect enable */
  110. #define MAX310X_MODE2_LOOPBACK_BIT (1 << 5) /* Internal loopback enable */
  111. #define MAX310X_MODE2_MULTIDROP_BIT (1 << 6) /* 9-bit multidrop enable */
  112. #define MAX310X_MODE2_ECHOSUPR_BIT (1 << 7) /* ECHO suppression enable */
  113. /* LCR register bits */
  114. #define MAX310X_LCR_LENGTH0_BIT (1 << 0) /* Word length bit 0 */
  115. #define MAX310X_LCR_LENGTH1_BIT (1 << 1) /* Word length bit 1
  116. *
  117. * Word length bits table:
  118. * 00 -> 5 bit words
  119. * 01 -> 6 bit words
  120. * 10 -> 7 bit words
  121. * 11 -> 8 bit words
  122. */
  123. #define MAX310X_LCR_STOPLEN_BIT (1 << 2) /* STOP length bit
  124. *
  125. * STOP length bit table:
  126. * 0 -> 1 stop bit
  127. * 1 -> 1-1.5 stop bits if
  128. * word length is 5,
  129. * 2 stop bits otherwise
  130. */
  131. #define MAX310X_LCR_PARITY_BIT (1 << 3) /* Parity bit enable */
  132. #define MAX310X_LCR_EVENPARITY_BIT (1 << 4) /* Even parity bit enable */
  133. #define MAX310X_LCR_FORCEPARITY_BIT (1 << 5) /* 9-bit multidrop parity */
  134. #define MAX310X_LCR_TXBREAK_BIT (1 << 6) /* TX break enable */
  135. #define MAX310X_LCR_RTS_BIT (1 << 7) /* RTS pin control */
  136. #define MAX310X_LCR_WORD_LEN_5 (0x00)
  137. #define MAX310X_LCR_WORD_LEN_6 (0x01)
  138. #define MAX310X_LCR_WORD_LEN_7 (0x02)
  139. #define MAX310X_LCR_WORD_LEN_8 (0x03)
  140. /* IRDA register bits */
  141. #define MAX310X_IRDA_IRDAEN_BIT (1 << 0) /* IRDA mode enable */
  142. #define MAX310X_IRDA_SIR_BIT (1 << 1) /* SIR mode enable */
  143. #define MAX310X_IRDA_SHORTIR_BIT (1 << 2) /* Short SIR mode enable */
  144. #define MAX310X_IRDA_MIR_BIT (1 << 3) /* MIR mode enable */
  145. #define MAX310X_IRDA_RXINV_BIT (1 << 4) /* RX logic inversion enable */
  146. #define MAX310X_IRDA_TXINV_BIT (1 << 5) /* TX logic inversion enable */
  147. /* Flow control trigger level register masks */
  148. #define MAX310X_FLOWLVL_HALT_MASK (0x000f) /* Flow control halt level */
  149. #define MAX310X_FLOWLVL_RES_MASK (0x00f0) /* Flow control resume level */
  150. #define MAX310X_FLOWLVL_HALT(words) ((words / 8) & 0x0f)
  151. #define MAX310X_FLOWLVL_RES(words) (((words / 8) & 0x0f) << 4)
  152. /* FIFO interrupt trigger level register masks */
  153. #define MAX310X_FIFOTRIGLVL_TX_MASK (0x0f) /* TX FIFO trigger level */
  154. #define MAX310X_FIFOTRIGLVL_RX_MASK (0xf0) /* RX FIFO trigger level */
  155. #define MAX310X_FIFOTRIGLVL_TX(words) ((words / 8) & 0x0f)
  156. #define MAX310X_FIFOTRIGLVL_RX(words) (((words / 8) & 0x0f) << 4)
  157. /* Flow control register bits */
  158. #define MAX310X_FLOWCTRL_AUTORTS_BIT (1 << 0) /* Auto RTS flow ctrl enable */
  159. #define MAX310X_FLOWCTRL_AUTOCTS_BIT (1 << 1) /* Auto CTS flow ctrl enable */
  160. #define MAX310X_FLOWCTRL_GPIADDR_BIT (1 << 2) /* Enables that GPIO inputs
  161. * are used in conjunction with
  162. * XOFF2 for definition of
  163. * special character */
  164. #define MAX310X_FLOWCTRL_SWFLOWEN_BIT (1 << 3) /* Auto SW flow ctrl enable */
  165. #define MAX310X_FLOWCTRL_SWFLOW0_BIT (1 << 4) /* SWFLOW bit 0 */
  166. #define MAX310X_FLOWCTRL_SWFLOW1_BIT (1 << 5) /* SWFLOW bit 1
  167. *
  168. * SWFLOW bits 1 & 0 table:
  169. * 00 -> no transmitter flow
  170. * control
  171. * 01 -> receiver compares
  172. * XON2 and XOFF2
  173. * and controls
  174. * transmitter
  175. * 10 -> receiver compares
  176. * XON1 and XOFF1
  177. * and controls
  178. * transmitter
  179. * 11 -> receiver compares
  180. * XON1, XON2, XOFF1 and
  181. * XOFF2 and controls
  182. * transmitter
  183. */
  184. #define MAX310X_FLOWCTRL_SWFLOW2_BIT (1 << 6) /* SWFLOW bit 2 */
  185. #define MAX310X_FLOWCTRL_SWFLOW3_BIT (1 << 7) /* SWFLOW bit 3
  186. *
  187. * SWFLOW bits 3 & 2 table:
  188. * 00 -> no received flow
  189. * control
  190. * 01 -> transmitter generates
  191. * XON2 and XOFF2
  192. * 10 -> transmitter generates
  193. * XON1 and XOFF1
  194. * 11 -> transmitter generates
  195. * XON1, XON2, XOFF1 and
  196. * XOFF2
  197. */
  198. /* GPIO configuration register bits */
  199. #define MAX310X_GPIOCFG_GP0OUT_BIT (1 << 0) /* GPIO 0 output enable */
  200. #define MAX310X_GPIOCFG_GP1OUT_BIT (1 << 1) /* GPIO 1 output enable */
  201. #define MAX310X_GPIOCFG_GP2OUT_BIT (1 << 2) /* GPIO 2 output enable */
  202. #define MAX310X_GPIOCFG_GP3OUT_BIT (1 << 3) /* GPIO 3 output enable */
  203. #define MAX310X_GPIOCFG_GP0OD_BIT (1 << 4) /* GPIO 0 open-drain enable */
  204. #define MAX310X_GPIOCFG_GP1OD_BIT (1 << 5) /* GPIO 1 open-drain enable */
  205. #define MAX310X_GPIOCFG_GP2OD_BIT (1 << 6) /* GPIO 2 open-drain enable */
  206. #define MAX310X_GPIOCFG_GP3OD_BIT (1 << 7) /* GPIO 3 open-drain enable */
  207. /* GPIO DATA register bits */
  208. #define MAX310X_GPIODATA_GP0OUT_BIT (1 << 0) /* GPIO 0 output value */
  209. #define MAX310X_GPIODATA_GP1OUT_BIT (1 << 1) /* GPIO 1 output value */
  210. #define MAX310X_GPIODATA_GP2OUT_BIT (1 << 2) /* GPIO 2 output value */
  211. #define MAX310X_GPIODATA_GP3OUT_BIT (1 << 3) /* GPIO 3 output value */
  212. #define MAX310X_GPIODATA_GP0IN_BIT (1 << 4) /* GPIO 0 input value */
  213. #define MAX310X_GPIODATA_GP1IN_BIT (1 << 5) /* GPIO 1 input value */
  214. #define MAX310X_GPIODATA_GP2IN_BIT (1 << 6) /* GPIO 2 input value */
  215. #define MAX310X_GPIODATA_GP3IN_BIT (1 << 7) /* GPIO 3 input value */
  216. /* PLL configuration register masks */
  217. #define MAX310X_PLLCFG_PREDIV_MASK (0x3f) /* PLL predivision value */
  218. #define MAX310X_PLLCFG_PLLFACTOR_MASK (0xc0) /* PLL multiplication factor */
  219. /* Baud rate generator configuration register bits */
  220. #define MAX310X_BRGCFG_2XMODE_BIT (1 << 4) /* Double baud rate */
  221. #define MAX310X_BRGCFG_4XMODE_BIT (1 << 5) /* Quadruple baud rate */
  222. /* Clock source register bits */
  223. #define MAX310X_CLKSRC_CRYST_BIT (1 << 1) /* Crystal osc enable */
  224. #define MAX310X_CLKSRC_PLL_BIT (1 << 2) /* PLL enable */
  225. #define MAX310X_CLKSRC_PLLBYP_BIT (1 << 3) /* PLL bypass */
  226. #define MAX310X_CLKSRC_EXTCLK_BIT (1 << 4) /* External clock enable */
  227. #define MAX310X_CLKSRC_CLK2RTS_BIT (1 << 7) /* Baud clk to RTS pin */
  228. /* Misc definitions */
  229. #define MAX310X_FIFO_SIZE (128)
  230. /* MAX3107 specific */
  231. #define MAX3107_REV_ID (0xa0)
  232. #define MAX3107_REV_MASK (0xfe)
  233. /* IRQ status bits definitions */
  234. #define MAX310X_IRQ_TX (MAX310X_IRQ_TXFIFO_BIT | \
  235. MAX310X_IRQ_TXEMPTY_BIT)
  236. #define MAX310X_IRQ_RX (MAX310X_IRQ_RXFIFO_BIT | \
  237. MAX310X_IRQ_RXEMPTY_BIT)
  238. /* Supported chip types */
  239. enum {
  240. MAX310X_TYPE_MAX3107 = 3107,
  241. MAX310X_TYPE_MAX3108 = 3108,
  242. };
  243. struct max310x_port {
  244. struct uart_driver uart;
  245. struct uart_port port;
  246. const char *name;
  247. int uartclk;
  248. unsigned int nr_gpio;
  249. #ifdef CONFIG_GPIOLIB
  250. struct gpio_chip gpio;
  251. #endif
  252. struct regmap *regmap;
  253. struct regmap_config regcfg;
  254. struct workqueue_struct *wq;
  255. struct work_struct tx_work;
  256. struct mutex max310x_mutex;
  257. struct max310x_pdata *pdata;
  258. };
  259. static bool max3107_8_reg_writeable(struct device *dev, unsigned int reg)
  260. {
  261. switch (reg) {
  262. case MAX310X_IRQSTS_REG:
  263. case MAX310X_LSR_IRQSTS_REG:
  264. case MAX310X_SPCHR_IRQSTS_REG:
  265. case MAX310X_STS_IRQSTS_REG:
  266. case MAX310X_TXFIFOLVL_REG:
  267. case MAX310X_RXFIFOLVL_REG:
  268. case MAX3107_REVID_REG: /* Only available on MAX3107 */
  269. return false;
  270. default:
  271. break;
  272. }
  273. return true;
  274. }
  275. static bool max310x_reg_volatile(struct device *dev, unsigned int reg)
  276. {
  277. switch (reg) {
  278. case MAX310X_RHR_REG:
  279. case MAX310X_IRQSTS_REG:
  280. case MAX310X_LSR_IRQSTS_REG:
  281. case MAX310X_SPCHR_IRQSTS_REG:
  282. case MAX310X_STS_IRQSTS_REG:
  283. case MAX310X_TXFIFOLVL_REG:
  284. case MAX310X_RXFIFOLVL_REG:
  285. case MAX310X_GPIODATA_REG:
  286. return true;
  287. default:
  288. break;
  289. }
  290. return false;
  291. }
  292. static bool max310x_reg_precious(struct device *dev, unsigned int reg)
  293. {
  294. switch (reg) {
  295. case MAX310X_RHR_REG:
  296. case MAX310X_IRQSTS_REG:
  297. case MAX310X_SPCHR_IRQSTS_REG:
  298. case MAX310X_STS_IRQSTS_REG:
  299. return true;
  300. default:
  301. break;
  302. }
  303. return false;
  304. }
  305. static void max310x_set_baud(struct max310x_port *s, int baud)
  306. {
  307. unsigned int mode = 0, div = s->uartclk / baud;
  308. if (!(div / 16)) {
  309. /* Mode x2 */
  310. mode = MAX310X_BRGCFG_2XMODE_BIT;
  311. div = (s->uartclk * 2) / baud;
  312. }
  313. if (!(div / 16)) {
  314. /* Mode x4 */
  315. mode = MAX310X_BRGCFG_4XMODE_BIT;
  316. div = (s->uartclk * 4) / baud;
  317. }
  318. regmap_write(s->regmap, MAX310X_BRGDIVMSB_REG,
  319. ((div / 16) >> 8) & 0xff);
  320. regmap_write(s->regmap, MAX310X_BRGDIVLSB_REG, (div / 16) & 0xff);
  321. regmap_write(s->regmap, MAX310X_BRGCFG_REG, (div % 16) | mode);
  322. }
  323. static void max310x_wait_pll(struct max310x_port *s)
  324. {
  325. int tryes = 1000;
  326. /* Wait for PLL only if crystal is used */
  327. if (!(s->pdata->driver_flags & MAX310X_EXT_CLK)) {
  328. unsigned int sts = 0;
  329. while (tryes--) {
  330. regmap_read(s->regmap, MAX310X_STS_IRQSTS_REG, &sts);
  331. if (sts & MAX310X_STS_CLKREADY_BIT)
  332. break;
  333. }
  334. }
  335. }
  336. static int max310x_update_best_err(unsigned long f, long *besterr)
  337. {
  338. /* Use baudrate 115200 for calculate error */
  339. long err = f % (115200 * 16);
  340. if ((*besterr < 0) || (*besterr > err)) {
  341. *besterr = err;
  342. return 0;
  343. }
  344. return 1;
  345. }
  346. static int max310x_set_ref_clk(struct max310x_port *s)
  347. {
  348. unsigned int div, clksrc, pllcfg = 0;
  349. long besterr = -1;
  350. unsigned long fdiv, fmul, bestfreq = s->pdata->frequency;
  351. /* First, update error without PLL */
  352. max310x_update_best_err(s->pdata->frequency, &besterr);
  353. /* Try all possible PLL dividers */
  354. for (div = 1; (div <= 63) && besterr; div++) {
  355. fdiv = DIV_ROUND_CLOSEST(s->pdata->frequency, div);
  356. /* Try multiplier 6 */
  357. fmul = fdiv * 6;
  358. if ((fdiv >= 500000) && (fdiv <= 800000))
  359. if (!max310x_update_best_err(fmul, &besterr)) {
  360. pllcfg = (0 << 6) | div;
  361. bestfreq = fmul;
  362. }
  363. /* Try multiplier 48 */
  364. fmul = fdiv * 48;
  365. if ((fdiv >= 850000) && (fdiv <= 1200000))
  366. if (!max310x_update_best_err(fmul, &besterr)) {
  367. pllcfg = (1 << 6) | div;
  368. bestfreq = fmul;
  369. }
  370. /* Try multiplier 96 */
  371. fmul = fdiv * 96;
  372. if ((fdiv >= 425000) && (fdiv <= 1000000))
  373. if (!max310x_update_best_err(fmul, &besterr)) {
  374. pllcfg = (2 << 6) | div;
  375. bestfreq = fmul;
  376. }
  377. /* Try multiplier 144 */
  378. fmul = fdiv * 144;
  379. if ((fdiv >= 390000) && (fdiv <= 667000))
  380. if (!max310x_update_best_err(fmul, &besterr)) {
  381. pllcfg = (3 << 6) | div;
  382. bestfreq = fmul;
  383. }
  384. }
  385. /* Configure clock source */
  386. if (s->pdata->driver_flags & MAX310X_EXT_CLK)
  387. clksrc = MAX310X_CLKSRC_EXTCLK_BIT;
  388. else
  389. clksrc = MAX310X_CLKSRC_CRYST_BIT;
  390. /* Configure PLL */
  391. if (pllcfg) {
  392. clksrc |= MAX310X_CLKSRC_PLL_BIT;
  393. regmap_write(s->regmap, MAX310X_PLLCFG_REG, pllcfg);
  394. } else
  395. clksrc |= MAX310X_CLKSRC_PLLBYP_BIT;
  396. regmap_write(s->regmap, MAX310X_CLKSRC_REG, clksrc);
  397. if (pllcfg)
  398. max310x_wait_pll(s);
  399. dev_dbg(s->port.dev, "Reference clock set to %lu Hz\n", bestfreq);
  400. return (int)bestfreq;
  401. }
  402. static void max310x_handle_rx(struct max310x_port *s, unsigned int rxlen)
  403. {
  404. unsigned int sts = 0, ch = 0, flag;
  405. if (unlikely(rxlen >= MAX310X_FIFO_SIZE)) {
  406. dev_warn(s->port.dev, "Possible RX FIFO overrun %d\n", rxlen);
  407. /* Ensure sanity of RX level */
  408. rxlen = MAX310X_FIFO_SIZE;
  409. }
  410. dev_dbg(s->port.dev, "RX Len = %u\n", rxlen);
  411. while (rxlen--) {
  412. regmap_read(s->regmap, MAX310X_RHR_REG, &ch);
  413. regmap_read(s->regmap, MAX310X_LSR_IRQSTS_REG, &sts);
  414. sts &= MAX310X_LSR_RXPAR_BIT | MAX310X_LSR_FRERR_BIT |
  415. MAX310X_LSR_RXOVR_BIT | MAX310X_LSR_RXBRK_BIT;
  416. s->port.icount.rx++;
  417. flag = TTY_NORMAL;
  418. if (unlikely(sts)) {
  419. if (sts & MAX310X_LSR_RXBRK_BIT) {
  420. s->port.icount.brk++;
  421. if (uart_handle_break(&s->port))
  422. continue;
  423. } else if (sts & MAX310X_LSR_RXPAR_BIT)
  424. s->port.icount.parity++;
  425. else if (sts & MAX310X_LSR_FRERR_BIT)
  426. s->port.icount.frame++;
  427. else if (sts & MAX310X_LSR_RXOVR_BIT)
  428. s->port.icount.overrun++;
  429. sts &= s->port.read_status_mask;
  430. if (sts & MAX310X_LSR_RXBRK_BIT)
  431. flag = TTY_BREAK;
  432. else if (sts & MAX310X_LSR_RXPAR_BIT)
  433. flag = TTY_PARITY;
  434. else if (sts & MAX310X_LSR_FRERR_BIT)
  435. flag = TTY_FRAME;
  436. else if (sts & MAX310X_LSR_RXOVR_BIT)
  437. flag = TTY_OVERRUN;
  438. }
  439. if (uart_handle_sysrq_char(s->port, ch))
  440. continue;
  441. if (sts & s->port.ignore_status_mask)
  442. continue;
  443. uart_insert_char(&s->port, sts, MAX310X_LSR_RXOVR_BIT,
  444. ch, flag);
  445. }
  446. tty_flip_buffer_push(&s->port.state->port);
  447. }
  448. static void max310x_handle_tx(struct max310x_port *s)
  449. {
  450. struct circ_buf *xmit = &s->port.state->xmit;
  451. unsigned int txlen = 0, to_send;
  452. if (unlikely(s->port.x_char)) {
  453. regmap_write(s->regmap, MAX310X_THR_REG, s->port.x_char);
  454. s->port.icount.tx++;
  455. s->port.x_char = 0;
  456. return;
  457. }
  458. if (uart_circ_empty(xmit) || uart_tx_stopped(&s->port))
  459. return;
  460. /* Get length of data pending in circular buffer */
  461. to_send = uart_circ_chars_pending(xmit);
  462. if (likely(to_send)) {
  463. /* Limit to size of TX FIFO */
  464. regmap_read(s->regmap, MAX310X_TXFIFOLVL_REG, &txlen);
  465. txlen = MAX310X_FIFO_SIZE - txlen;
  466. to_send = (to_send > txlen) ? txlen : to_send;
  467. dev_dbg(s->port.dev, "TX Len = %u\n", to_send);
  468. /* Add data to send */
  469. s->port.icount.tx += to_send;
  470. while (to_send--) {
  471. regmap_write(s->regmap, MAX310X_THR_REG,
  472. xmit->buf[xmit->tail]);
  473. xmit->tail = (xmit->tail + 1) & (UART_XMIT_SIZE - 1);
  474. };
  475. }
  476. if (uart_circ_chars_pending(xmit) < WAKEUP_CHARS)
  477. uart_write_wakeup(&s->port);
  478. }
  479. static irqreturn_t max310x_ist(int irq, void *dev_id)
  480. {
  481. struct max310x_port *s = (struct max310x_port *)dev_id;
  482. unsigned int ists = 0, lsr = 0, rxlen = 0;
  483. mutex_lock(&s->max310x_mutex);
  484. for (;;) {
  485. /* Read IRQ status & RX FIFO level */
  486. regmap_read(s->regmap, MAX310X_IRQSTS_REG, &ists);
  487. regmap_read(s->regmap, MAX310X_LSR_IRQSTS_REG, &lsr);
  488. regmap_read(s->regmap, MAX310X_RXFIFOLVL_REG, &rxlen);
  489. if (!ists && !(lsr & MAX310X_LSR_RXTO_BIT) && !rxlen)
  490. break;
  491. dev_dbg(s->port.dev, "IRQ status: 0x%02x\n", ists);
  492. if (rxlen)
  493. max310x_handle_rx(s, rxlen);
  494. if (ists & MAX310X_IRQ_TX)
  495. max310x_handle_tx(s);
  496. if (ists & MAX310X_IRQ_CTS_BIT)
  497. uart_handle_cts_change(&s->port,
  498. !!(lsr & MAX310X_LSR_CTS_BIT));
  499. }
  500. mutex_unlock(&s->max310x_mutex);
  501. return IRQ_HANDLED;
  502. }
  503. static void max310x_wq_proc(struct work_struct *ws)
  504. {
  505. struct max310x_port *s = container_of(ws, struct max310x_port, tx_work);
  506. mutex_lock(&s->max310x_mutex);
  507. max310x_handle_tx(s);
  508. mutex_unlock(&s->max310x_mutex);
  509. }
  510. static void max310x_start_tx(struct uart_port *port)
  511. {
  512. struct max310x_port *s = container_of(port, struct max310x_port, port);
  513. queue_work(s->wq, &s->tx_work);
  514. }
  515. static void max310x_stop_tx(struct uart_port *port)
  516. {
  517. /* Do nothing */
  518. }
  519. static void max310x_stop_rx(struct uart_port *port)
  520. {
  521. /* Do nothing */
  522. }
  523. static unsigned int max310x_tx_empty(struct uart_port *port)
  524. {
  525. unsigned int val = 0;
  526. struct max310x_port *s = container_of(port, struct max310x_port, port);
  527. mutex_lock(&s->max310x_mutex);
  528. regmap_read(s->regmap, MAX310X_TXFIFOLVL_REG, &val);
  529. mutex_unlock(&s->max310x_mutex);
  530. return val ? 0 : TIOCSER_TEMT;
  531. }
  532. static void max310x_enable_ms(struct uart_port *port)
  533. {
  534. /* Modem status not supported */
  535. }
  536. static unsigned int max310x_get_mctrl(struct uart_port *port)
  537. {
  538. /* DCD and DSR are not wired and CTS/RTS is handled automatically
  539. * so just indicate DSR and CAR asserted
  540. */
  541. return TIOCM_DSR | TIOCM_CAR;
  542. }
  543. static void max310x_set_mctrl(struct uart_port *port, unsigned int mctrl)
  544. {
  545. /* DCD and DSR are not wired and CTS/RTS is hadnled automatically
  546. * so do nothing
  547. */
  548. }
  549. static void max310x_break_ctl(struct uart_port *port, int break_state)
  550. {
  551. struct max310x_port *s = container_of(port, struct max310x_port, port);
  552. mutex_lock(&s->max310x_mutex);
  553. regmap_update_bits(s->regmap, MAX310X_LCR_REG,
  554. MAX310X_LCR_TXBREAK_BIT,
  555. break_state ? MAX310X_LCR_TXBREAK_BIT : 0);
  556. mutex_unlock(&s->max310x_mutex);
  557. }
  558. static void max310x_set_termios(struct uart_port *port,
  559. struct ktermios *termios,
  560. struct ktermios *old)
  561. {
  562. struct max310x_port *s = container_of(port, struct max310x_port, port);
  563. unsigned int lcr, flow = 0;
  564. int baud;
  565. mutex_lock(&s->max310x_mutex);
  566. /* Mask termios capabilities we don't support */
  567. termios->c_cflag &= ~CMSPAR;
  568. termios->c_iflag &= ~IXANY;
  569. /* Word size */
  570. switch (termios->c_cflag & CSIZE) {
  571. case CS5:
  572. lcr = MAX310X_LCR_WORD_LEN_5;
  573. break;
  574. case CS6:
  575. lcr = MAX310X_LCR_WORD_LEN_6;
  576. break;
  577. case CS7:
  578. lcr = MAX310X_LCR_WORD_LEN_7;
  579. break;
  580. case CS8:
  581. default:
  582. lcr = MAX310X_LCR_WORD_LEN_8;
  583. break;
  584. }
  585. /* Parity */
  586. if (termios->c_cflag & PARENB) {
  587. lcr |= MAX310X_LCR_PARITY_BIT;
  588. if (!(termios->c_cflag & PARODD))
  589. lcr |= MAX310X_LCR_EVENPARITY_BIT;
  590. }
  591. /* Stop bits */
  592. if (termios->c_cflag & CSTOPB)
  593. lcr |= MAX310X_LCR_STOPLEN_BIT; /* 2 stops */
  594. /* Update LCR register */
  595. regmap_write(s->regmap, MAX310X_LCR_REG, lcr);
  596. /* Set read status mask */
  597. port->read_status_mask = MAX310X_LSR_RXOVR_BIT;
  598. if (termios->c_iflag & INPCK)
  599. port->read_status_mask |= MAX310X_LSR_RXPAR_BIT |
  600. MAX310X_LSR_FRERR_BIT;
  601. if (termios->c_iflag & (BRKINT | PARMRK))
  602. port->read_status_mask |= MAX310X_LSR_RXBRK_BIT;
  603. /* Set status ignore mask */
  604. port->ignore_status_mask = 0;
  605. if (termios->c_iflag & IGNBRK)
  606. port->ignore_status_mask |= MAX310X_LSR_RXBRK_BIT;
  607. if (!(termios->c_cflag & CREAD))
  608. port->ignore_status_mask |= MAX310X_LSR_RXPAR_BIT |
  609. MAX310X_LSR_RXOVR_BIT |
  610. MAX310X_LSR_FRERR_BIT |
  611. MAX310X_LSR_RXBRK_BIT;
  612. /* Configure flow control */
  613. regmap_write(s->regmap, MAX310X_XON1_REG, termios->c_cc[VSTART]);
  614. regmap_write(s->regmap, MAX310X_XOFF1_REG, termios->c_cc[VSTOP]);
  615. if (termios->c_cflag & CRTSCTS)
  616. flow |= MAX310X_FLOWCTRL_AUTOCTS_BIT |
  617. MAX310X_FLOWCTRL_AUTORTS_BIT;
  618. if (termios->c_iflag & IXON)
  619. flow |= MAX310X_FLOWCTRL_SWFLOW3_BIT |
  620. MAX310X_FLOWCTRL_SWFLOWEN_BIT;
  621. if (termios->c_iflag & IXOFF)
  622. flow |= MAX310X_FLOWCTRL_SWFLOW1_BIT |
  623. MAX310X_FLOWCTRL_SWFLOWEN_BIT;
  624. regmap_write(s->regmap, MAX310X_FLOWCTRL_REG, flow);
  625. /* Get baud rate generator configuration */
  626. baud = uart_get_baud_rate(port, termios, old,
  627. port->uartclk / 16 / 0xffff,
  628. port->uartclk / 4);
  629. /* Setup baudrate generator */
  630. max310x_set_baud(s, baud);
  631. /* Update timeout according to new baud rate */
  632. uart_update_timeout(port, termios->c_cflag, baud);
  633. mutex_unlock(&s->max310x_mutex);
  634. }
  635. static int max310x_startup(struct uart_port *port)
  636. {
  637. unsigned int val, line = port->line;
  638. struct max310x_port *s = container_of(port, struct max310x_port, port);
  639. if (s->pdata->suspend)
  640. s->pdata->suspend(0);
  641. mutex_lock(&s->max310x_mutex);
  642. /* Configure baud rate, 9600 as default */
  643. max310x_set_baud(s, 9600);
  644. /* Configure LCR register, 8N1 mode by default */
  645. val = MAX310X_LCR_WORD_LEN_8;
  646. regmap_write(s->regmap, MAX310X_LCR_REG, val);
  647. /* Configure MODE1 register */
  648. regmap_update_bits(s->regmap, MAX310X_MODE1_REG,
  649. MAX310X_MODE1_TRNSCVCTRL_BIT,
  650. (s->pdata->uart_flags[line] & MAX310X_AUTO_DIR_CTRL)
  651. ? MAX310X_MODE1_TRNSCVCTRL_BIT : 0);
  652. /* Configure MODE2 register */
  653. val = MAX310X_MODE2_RXEMPTINV_BIT;
  654. if (s->pdata->uart_flags[line] & MAX310X_LOOPBACK)
  655. val |= MAX310X_MODE2_LOOPBACK_BIT;
  656. if (s->pdata->uart_flags[line] & MAX310X_ECHO_SUPRESS)
  657. val |= MAX310X_MODE2_ECHOSUPR_BIT;
  658. /* Reset FIFOs */
  659. val |= MAX310X_MODE2_FIFORST_BIT;
  660. regmap_write(s->regmap, MAX310X_MODE2_REG, val);
  661. /* Configure FIFO trigger level register */
  662. /* RX FIFO trigger for 16 words, TX FIFO trigger for 64 words */
  663. val = MAX310X_FIFOTRIGLVL_RX(16) | MAX310X_FIFOTRIGLVL_TX(64);
  664. regmap_write(s->regmap, MAX310X_FIFOTRIGLVL_REG, val);
  665. /* Configure flow control levels */
  666. /* Flow control halt level 96, resume level 48 */
  667. val = MAX310X_FLOWLVL_RES(48) | MAX310X_FLOWLVL_HALT(96);
  668. regmap_write(s->regmap, MAX310X_FLOWLVL_REG, val);
  669. /* Clear timeout register */
  670. regmap_write(s->regmap, MAX310X_RXTO_REG, 0);
  671. /* Configure LSR interrupt enable register */
  672. /* Enable RX timeout interrupt */
  673. val = MAX310X_LSR_RXTO_BIT;
  674. regmap_write(s->regmap, MAX310X_LSR_IRQEN_REG, val);
  675. /* Clear FIFO reset */
  676. regmap_update_bits(s->regmap, MAX310X_MODE2_REG,
  677. MAX310X_MODE2_FIFORST_BIT, 0);
  678. /* Clear IRQ status register by reading it */
  679. regmap_read(s->regmap, MAX310X_IRQSTS_REG, &val);
  680. /* Configure interrupt enable register */
  681. /* Enable CTS change interrupt */
  682. val = MAX310X_IRQ_CTS_BIT;
  683. /* Enable RX, TX interrupts */
  684. val |= MAX310X_IRQ_RX | MAX310X_IRQ_TX;
  685. regmap_write(s->regmap, MAX310X_IRQEN_REG, val);
  686. mutex_unlock(&s->max310x_mutex);
  687. return 0;
  688. }
  689. static void max310x_shutdown(struct uart_port *port)
  690. {
  691. struct max310x_port *s = container_of(port, struct max310x_port, port);
  692. /* Disable all interrupts */
  693. mutex_lock(&s->max310x_mutex);
  694. regmap_write(s->regmap, MAX310X_IRQEN_REG, 0);
  695. mutex_unlock(&s->max310x_mutex);
  696. if (s->pdata->suspend)
  697. s->pdata->suspend(1);
  698. }
  699. static const char *max310x_type(struct uart_port *port)
  700. {
  701. struct max310x_port *s = container_of(port, struct max310x_port, port);
  702. return (port->type == PORT_MAX310X) ? s->name : NULL;
  703. }
  704. static int max310x_request_port(struct uart_port *port)
  705. {
  706. /* Do nothing */
  707. return 0;
  708. }
  709. static void max310x_release_port(struct uart_port *port)
  710. {
  711. /* Do nothing */
  712. }
  713. static void max310x_config_port(struct uart_port *port, int flags)
  714. {
  715. if (flags & UART_CONFIG_TYPE)
  716. port->type = PORT_MAX310X;
  717. }
  718. static int max310x_verify_port(struct uart_port *port, struct serial_struct *ser)
  719. {
  720. if ((ser->type == PORT_UNKNOWN) || (ser->type == PORT_MAX310X))
  721. return 0;
  722. if (ser->irq == port->irq)
  723. return 0;
  724. return -EINVAL;
  725. }
  726. static struct uart_ops max310x_ops = {
  727. .tx_empty = max310x_tx_empty,
  728. .set_mctrl = max310x_set_mctrl,
  729. .get_mctrl = max310x_get_mctrl,
  730. .stop_tx = max310x_stop_tx,
  731. .start_tx = max310x_start_tx,
  732. .stop_rx = max310x_stop_rx,
  733. .enable_ms = max310x_enable_ms,
  734. .break_ctl = max310x_break_ctl,
  735. .startup = max310x_startup,
  736. .shutdown = max310x_shutdown,
  737. .set_termios = max310x_set_termios,
  738. .type = max310x_type,
  739. .request_port = max310x_request_port,
  740. .release_port = max310x_release_port,
  741. .config_port = max310x_config_port,
  742. .verify_port = max310x_verify_port,
  743. };
  744. static int max310x_suspend(struct spi_device *spi, pm_message_t state)
  745. {
  746. int ret;
  747. struct max310x_port *s = dev_get_drvdata(&spi->dev);
  748. dev_dbg(&spi->dev, "Suspend\n");
  749. ret = uart_suspend_port(&s->uart, &s->port);
  750. mutex_lock(&s->max310x_mutex);
  751. /* Enable sleep mode */
  752. regmap_update_bits(s->regmap, MAX310X_MODE1_REG,
  753. MAX310X_MODE1_FORCESLEEP_BIT,
  754. MAX310X_MODE1_FORCESLEEP_BIT);
  755. mutex_unlock(&s->max310x_mutex);
  756. if (s->pdata->suspend)
  757. s->pdata->suspend(1);
  758. return ret;
  759. }
  760. static int max310x_resume(struct spi_device *spi)
  761. {
  762. struct max310x_port *s = dev_get_drvdata(&spi->dev);
  763. dev_dbg(&spi->dev, "Resume\n");
  764. if (s->pdata->suspend)
  765. s->pdata->suspend(0);
  766. mutex_lock(&s->max310x_mutex);
  767. /* Disable sleep mode */
  768. regmap_update_bits(s->regmap, MAX310X_MODE1_REG,
  769. MAX310X_MODE1_FORCESLEEP_BIT,
  770. 0);
  771. max310x_wait_pll(s);
  772. mutex_unlock(&s->max310x_mutex);
  773. return uart_resume_port(&s->uart, &s->port);
  774. }
  775. #ifdef CONFIG_GPIOLIB
  776. static int max310x_gpio_get(struct gpio_chip *chip, unsigned offset)
  777. {
  778. unsigned int val = 0;
  779. struct max310x_port *s = container_of(chip, struct max310x_port, gpio);
  780. mutex_lock(&s->max310x_mutex);
  781. regmap_read(s->regmap, MAX310X_GPIODATA_REG, &val);
  782. mutex_unlock(&s->max310x_mutex);
  783. return !!((val >> 4) & (1 << offset));
  784. }
  785. static void max310x_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
  786. {
  787. struct max310x_port *s = container_of(chip, struct max310x_port, gpio);
  788. mutex_lock(&s->max310x_mutex);
  789. regmap_update_bits(s->regmap, MAX310X_GPIODATA_REG, 1 << offset, value ?
  790. 1 << offset : 0);
  791. mutex_unlock(&s->max310x_mutex);
  792. }
  793. static int max310x_gpio_direction_input(struct gpio_chip *chip, unsigned offset)
  794. {
  795. struct max310x_port *s = container_of(chip, struct max310x_port, gpio);
  796. mutex_lock(&s->max310x_mutex);
  797. regmap_update_bits(s->regmap, MAX310X_GPIOCFG_REG, 1 << offset, 0);
  798. mutex_unlock(&s->max310x_mutex);
  799. return 0;
  800. }
  801. static int max310x_gpio_direction_output(struct gpio_chip *chip,
  802. unsigned offset, int value)
  803. {
  804. struct max310x_port *s = container_of(chip, struct max310x_port, gpio);
  805. mutex_lock(&s->max310x_mutex);
  806. regmap_update_bits(s->regmap, MAX310X_GPIOCFG_REG, 1 << offset,
  807. 1 << offset);
  808. regmap_update_bits(s->regmap, MAX310X_GPIODATA_REG, 1 << offset, value ?
  809. 1 << offset : 0);
  810. mutex_unlock(&s->max310x_mutex);
  811. return 0;
  812. }
  813. #endif
  814. /* Generic platform data */
  815. static struct max310x_pdata generic_plat_data = {
  816. .driver_flags = MAX310X_EXT_CLK,
  817. .uart_flags[0] = MAX310X_ECHO_SUPRESS,
  818. .frequency = 26000000,
  819. };
  820. static int max310x_probe(struct spi_device *spi)
  821. {
  822. struct max310x_port *s;
  823. struct device *dev = &spi->dev;
  824. int chiptype = spi_get_device_id(spi)->driver_data;
  825. struct max310x_pdata *pdata = dev->platform_data;
  826. unsigned int val = 0;
  827. int ret;
  828. /* Check for IRQ */
  829. if (spi->irq <= 0) {
  830. dev_err(dev, "No IRQ specified\n");
  831. return -ENOTSUPP;
  832. }
  833. /* Alloc port structure */
  834. s = devm_kzalloc(dev, sizeof(struct max310x_port), GFP_KERNEL);
  835. if (!s) {
  836. dev_err(dev, "Error allocating port structure\n");
  837. return -ENOMEM;
  838. }
  839. dev_set_drvdata(dev, s);
  840. if (!pdata) {
  841. dev_warn(dev, "No platform data supplied, using defaults\n");
  842. pdata = &generic_plat_data;
  843. }
  844. s->pdata = pdata;
  845. /* Individual chip settings */
  846. switch (chiptype) {
  847. case MAX310X_TYPE_MAX3107:
  848. s->name = "MAX3107";
  849. s->nr_gpio = 4;
  850. s->uart.nr = 1;
  851. s->regcfg.max_register = 0x1f;
  852. break;
  853. case MAX310X_TYPE_MAX3108:
  854. s->name = "MAX3108";
  855. s->nr_gpio = 4;
  856. s->uart.nr = 1;
  857. s->regcfg.max_register = 0x1e;
  858. break;
  859. default:
  860. dev_err(dev, "Unsupported chip type %i\n", chiptype);
  861. return -ENOTSUPP;
  862. }
  863. /* Check input frequency */
  864. if ((pdata->driver_flags & MAX310X_EXT_CLK) &&
  865. ((pdata->frequency < 500000) || (pdata->frequency > 35000000)))
  866. goto err_freq;
  867. /* Check frequency for quartz */
  868. if (!(pdata->driver_flags & MAX310X_EXT_CLK) &&
  869. ((pdata->frequency < 1000000) || (pdata->frequency > 4000000)))
  870. goto err_freq;
  871. mutex_init(&s->max310x_mutex);
  872. /* Setup SPI bus */
  873. spi->mode = SPI_MODE_0;
  874. spi->bits_per_word = 8;
  875. spi->max_speed_hz = 26000000;
  876. spi_setup(spi);
  877. /* Setup regmap */
  878. s->regcfg.reg_bits = 8;
  879. s->regcfg.val_bits = 8;
  880. s->regcfg.read_flag_mask = 0x00;
  881. s->regcfg.write_flag_mask = 0x80;
  882. s->regcfg.cache_type = REGCACHE_RBTREE;
  883. s->regcfg.writeable_reg = max3107_8_reg_writeable;
  884. s->regcfg.volatile_reg = max310x_reg_volatile;
  885. s->regcfg.precious_reg = max310x_reg_precious;
  886. s->regmap = devm_regmap_init_spi(spi, &s->regcfg);
  887. if (IS_ERR(s->regmap)) {
  888. ret = PTR_ERR(s->regmap);
  889. dev_err(dev, "Failed to initialize register map\n");
  890. goto err_out;
  891. }
  892. /* Reset chip & check SPI function */
  893. ret = regmap_write(s->regmap, MAX310X_MODE2_REG, MAX310X_MODE2_RST_BIT);
  894. if (ret) {
  895. dev_err(dev, "SPI transfer failed\n");
  896. goto err_out;
  897. }
  898. /* Clear chip reset */
  899. regmap_write(s->regmap, MAX310X_MODE2_REG, 0);
  900. switch (chiptype) {
  901. case MAX310X_TYPE_MAX3107:
  902. /* Check REV ID to ensure we are talking to what we expect */
  903. regmap_read(s->regmap, MAX3107_REVID_REG, &val);
  904. if (((val & MAX3107_REV_MASK) != MAX3107_REV_ID)) {
  905. dev_err(dev, "%s ID 0x%02x does not match\n",
  906. s->name, val);
  907. ret = -ENODEV;
  908. goto err_out;
  909. }
  910. break;
  911. case MAX310X_TYPE_MAX3108:
  912. /* MAX3108 have not REV ID register, we just check default value
  913. * from clocksource register to make sure everything works.
  914. */
  915. regmap_read(s->regmap, MAX310X_CLKSRC_REG, &val);
  916. if (val != (MAX310X_CLKSRC_EXTCLK_BIT |
  917. MAX310X_CLKSRC_PLLBYP_BIT)) {
  918. dev_err(dev, "%s not present\n", s->name);
  919. ret = -ENODEV;
  920. goto err_out;
  921. }
  922. break;
  923. }
  924. /* Board specific configure */
  925. if (pdata->init)
  926. pdata->init();
  927. if (pdata->suspend)
  928. pdata->suspend(0);
  929. /* Calculate referecne clock */
  930. s->uartclk = max310x_set_ref_clk(s);
  931. /* Disable all interrupts */
  932. regmap_write(s->regmap, MAX310X_IRQEN_REG, 0);
  933. /* Setup MODE1 register */
  934. val = MAX310X_MODE1_IRQSEL_BIT; /* Enable IRQ pin */
  935. if (pdata->driver_flags & MAX310X_AUTOSLEEP)
  936. val = MAX310X_MODE1_AUTOSLEEP_BIT;
  937. regmap_write(s->regmap, MAX310X_MODE1_REG, val);
  938. /* Setup interrupt */
  939. ret = devm_request_threaded_irq(dev, spi->irq, NULL, max310x_ist,
  940. IRQF_TRIGGER_FALLING | IRQF_ONESHOT,
  941. dev_name(dev), s);
  942. if (ret) {
  943. dev_err(dev, "Unable to reguest IRQ %i\n", spi->irq);
  944. goto err_out;
  945. }
  946. /* Register UART driver */
  947. s->uart.owner = THIS_MODULE;
  948. s->uart.driver_name = dev_name(dev);
  949. s->uart.dev_name = "ttyMAX";
  950. s->uart.major = MAX310X_MAJOR;
  951. s->uart.minor = MAX310X_MINOR;
  952. ret = uart_register_driver(&s->uart);
  953. if (ret) {
  954. dev_err(dev, "Registering UART driver failed\n");
  955. goto err_out;
  956. }
  957. /* Initialize workqueue for start TX */
  958. s->wq = create_freezable_workqueue(dev_name(dev));
  959. INIT_WORK(&s->tx_work, max310x_wq_proc);
  960. /* Initialize UART port data */
  961. s->port.line = 0;
  962. s->port.dev = dev;
  963. s->port.irq = spi->irq;
  964. s->port.type = PORT_MAX310X;
  965. s->port.fifosize = MAX310X_FIFO_SIZE;
  966. s->port.flags = UPF_SKIP_TEST | UPF_FIXED_TYPE;
  967. s->port.iotype = UPIO_PORT;
  968. s->port.membase = (void __iomem *)0xffffffff; /* Bogus value */
  969. s->port.uartclk = s->uartclk;
  970. s->port.ops = &max310x_ops;
  971. uart_add_one_port(&s->uart, &s->port);
  972. #ifdef CONFIG_GPIOLIB
  973. /* Setup GPIO cotroller */
  974. if (pdata->gpio_base) {
  975. s->gpio.owner = THIS_MODULE;
  976. s->gpio.dev = dev;
  977. s->gpio.label = dev_name(dev);
  978. s->gpio.direction_input = max310x_gpio_direction_input;
  979. s->gpio.get = max310x_gpio_get;
  980. s->gpio.direction_output= max310x_gpio_direction_output;
  981. s->gpio.set = max310x_gpio_set;
  982. s->gpio.base = pdata->gpio_base;
  983. s->gpio.ngpio = s->nr_gpio;
  984. s->gpio.can_sleep = 1;
  985. if (gpiochip_add(&s->gpio)) {
  986. /* Indicate that we should not call gpiochip_remove */
  987. s->gpio.base = 0;
  988. }
  989. } else
  990. dev_info(dev, "GPIO support not enabled\n");
  991. #endif
  992. /* Go to suspend mode */
  993. if (pdata->suspend)
  994. pdata->suspend(1);
  995. return 0;
  996. err_freq:
  997. dev_err(dev, "Frequency parameter incorrect\n");
  998. ret = -EINVAL;
  999. err_out:
  1000. dev_set_drvdata(dev, NULL);
  1001. return ret;
  1002. }
  1003. static int max310x_remove(struct spi_device *spi)
  1004. {
  1005. struct device *dev = &spi->dev;
  1006. struct max310x_port *s = dev_get_drvdata(dev);
  1007. int ret = 0;
  1008. dev_dbg(dev, "Removing port\n");
  1009. devm_free_irq(dev, s->port.irq, s);
  1010. destroy_workqueue(s->wq);
  1011. uart_remove_one_port(&s->uart, &s->port);
  1012. uart_unregister_driver(&s->uart);
  1013. #ifdef CONFIG_GPIOLIB
  1014. if (s->pdata->gpio_base) {
  1015. ret = gpiochip_remove(&s->gpio);
  1016. if (ret)
  1017. dev_err(dev, "Failed to remove gpio chip: %d\n", ret);
  1018. }
  1019. #endif
  1020. dev_set_drvdata(dev, NULL);
  1021. if (s->pdata->suspend)
  1022. s->pdata->suspend(1);
  1023. if (s->pdata->exit)
  1024. s->pdata->exit();
  1025. return ret;
  1026. }
  1027. static const struct spi_device_id max310x_id_table[] = {
  1028. { "max3107", MAX310X_TYPE_MAX3107 },
  1029. { "max3108", MAX310X_TYPE_MAX3108 },
  1030. { }
  1031. };
  1032. MODULE_DEVICE_TABLE(spi, max310x_id_table);
  1033. static struct spi_driver max310x_driver = {
  1034. .driver = {
  1035. .name = "max310x",
  1036. .owner = THIS_MODULE,
  1037. },
  1038. .probe = max310x_probe,
  1039. .remove = max310x_remove,
  1040. .suspend = max310x_suspend,
  1041. .resume = max310x_resume,
  1042. .id_table = max310x_id_table,
  1043. };
  1044. module_spi_driver(max310x_driver);
  1045. MODULE_LICENSE("GPL v2");
  1046. MODULE_AUTHOR("Alexander Shiyan <shc_work@mail.ru>");
  1047. MODULE_DESCRIPTION("MAX310X serial driver");