iuu_phoenix.c 30 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217
  1. /*
  2. * Infinity Unlimited USB Phoenix driver
  3. *
  4. * Copyright (C) 2007 Alain Degreffe (eczema@ecze.com)
  5. *
  6. * Original code taken from iuutool (Copyright (C) 2006 Juan Carlos Borrás)
  7. *
  8. * This program is free software; you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation; either version 2 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * And tested with help of WB Electronics
  14. *
  15. */
  16. #include <linux/kernel.h>
  17. #include <linux/errno.h>
  18. #include <linux/init.h>
  19. #include <linux/slab.h>
  20. #include <linux/tty.h>
  21. #include <linux/tty_driver.h>
  22. #include <linux/tty_flip.h>
  23. #include <linux/serial.h>
  24. #include <linux/module.h>
  25. #include <linux/moduleparam.h>
  26. #include <linux/spinlock.h>
  27. #include <linux/uaccess.h>
  28. #include <linux/usb.h>
  29. #include <linux/usb/serial.h>
  30. #include "iuu_phoenix.h"
  31. #include <linux/random.h>
  32. #ifdef CONFIG_USB_SERIAL_DEBUG
  33. static int debug = 1;
  34. #else
  35. static int debug;
  36. #endif
  37. /*
  38. * Version Information
  39. */
  40. #define DRIVER_VERSION "v0.5"
  41. #define DRIVER_DESC "Infinity USB Unlimited Phoenix driver"
  42. static struct usb_device_id id_table[] = {
  43. {USB_DEVICE(IUU_USB_VENDOR_ID, IUU_USB_PRODUCT_ID)},
  44. {} /* Terminating entry */
  45. };
  46. MODULE_DEVICE_TABLE(usb, id_table);
  47. static struct usb_driver iuu_driver = {
  48. .name = "iuu_phoenix",
  49. .probe = usb_serial_probe,
  50. .disconnect = usb_serial_disconnect,
  51. .id_table = id_table,
  52. .no_dynamic_id = 1,
  53. };
  54. /* turbo parameter */
  55. static int boost = 100;
  56. static int clockmode = 1;
  57. static int cdmode = 1;
  58. static int iuu_cardin;
  59. static int iuu_cardout;
  60. static int xmas;
  61. static void read_rxcmd_callback(struct urb *urb);
  62. struct iuu_private {
  63. spinlock_t lock; /* store irq state */
  64. wait_queue_head_t delta_msr_wait;
  65. u8 line_control;
  66. u8 line_status;
  67. u8 termios_initialized;
  68. int tiostatus; /* store IUART SIGNAL for tiocmget call */
  69. u8 reset; /* if 1 reset is needed */
  70. int poll; /* number of poll */
  71. u8 *writebuf; /* buffer for writing to device */
  72. int writelen; /* num of byte to write to device */
  73. u8 *buf; /* used for initialize speed */
  74. u8 *dbgbuf; /* debug buffer */
  75. u8 len;
  76. };
  77. static void iuu_free_buf(struct iuu_private *priv)
  78. {
  79. kfree(priv->buf);
  80. kfree(priv->dbgbuf);
  81. kfree(priv->writebuf);
  82. }
  83. static int iuu_alloc_buf(struct iuu_private *priv)
  84. {
  85. priv->buf = kzalloc(256, GFP_KERNEL);
  86. priv->dbgbuf = kzalloc(256, GFP_KERNEL);
  87. priv->writebuf = kzalloc(256, GFP_KERNEL);
  88. if (!priv->buf || !priv->dbgbuf || !priv->writebuf) {
  89. iuu_free_buf(priv);
  90. dbg("%s problem allocation buffer", __FUNCTION__);
  91. return -ENOMEM;
  92. }
  93. dbg("%s - Privates buffers allocation success", __FUNCTION__);
  94. return 0;
  95. }
  96. static int iuu_startup(struct usb_serial *serial)
  97. {
  98. struct iuu_private *priv;
  99. priv = kzalloc(sizeof(struct iuu_private), GFP_KERNEL);
  100. dbg("%s- priv allocation success", __FUNCTION__);
  101. if (!priv)
  102. return -ENOMEM;
  103. if (iuu_alloc_buf(priv)) {
  104. kfree(priv);
  105. return -ENOMEM;
  106. }
  107. spin_lock_init(&priv->lock);
  108. init_waitqueue_head(&priv->delta_msr_wait);
  109. usb_set_serial_port_data(serial->port[0], priv);
  110. return 0;
  111. }
  112. /* Shutdown function */
  113. static void iuu_shutdown(struct usb_serial *serial)
  114. {
  115. struct usb_serial_port *port = serial->port[0];
  116. struct iuu_private *priv = usb_get_serial_port_data(port);
  117. if (!port)
  118. return;
  119. dbg("%s", __FUNCTION__);
  120. if (priv) {
  121. iuu_free_buf(priv);
  122. dbg("%s - I will free all", __FUNCTION__);
  123. usb_set_serial_port_data(port, NULL);
  124. dbg("%s - priv is not anymore in port structure", __FUNCTION__);
  125. kfree(priv);
  126. dbg("%s priv is now kfree", __FUNCTION__);
  127. }
  128. }
  129. static int iuu_tiocmset(struct usb_serial_port *port, struct file *file,
  130. unsigned int set, unsigned int clear)
  131. {
  132. struct iuu_private *priv = usb_get_serial_port_data(port);
  133. struct tty_struct *tty;
  134. tty = port->tty;
  135. dbg("%s (%d) msg : SET = 0x%04x, CLEAR = 0x%04x ", __FUNCTION__,
  136. port->number, set, clear);
  137. if (set & TIOCM_RTS)
  138. priv->tiostatus = TIOCM_RTS;
  139. if (!(set & TIOCM_RTS) && priv->tiostatus == TIOCM_RTS) {
  140. dbg("%s TIOCMSET RESET called !!!", __FUNCTION__);
  141. priv->reset = 1;
  142. return 0;
  143. }
  144. return 0;
  145. }
  146. /* This is used to provide a carrier detect mechanism
  147. * When a card is present, the response is 0x00
  148. * When no card , the reader respond with TIOCM_CD
  149. * This is known as CD autodetect mechanism
  150. */
  151. static int iuu_tiocmget(struct usb_serial_port *port, struct file *file)
  152. {
  153. struct iuu_private *priv = usb_get_serial_port_data(port);
  154. return priv->tiostatus;
  155. }
  156. static void iuu_rxcmd(struct urb *urb)
  157. {
  158. struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
  159. int result;
  160. dbg("%s - enter", __FUNCTION__);
  161. if (urb->status) {
  162. dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
  163. /* error stop all */
  164. return;
  165. }
  166. memset(port->write_urb->transfer_buffer, IUU_UART_RX, 1);
  167. usb_fill_bulk_urb(port->write_urb, port->serial->dev,
  168. usb_sndbulkpipe(port->serial->dev,
  169. port->bulk_out_endpointAddress),
  170. port->write_urb->transfer_buffer, 1,
  171. read_rxcmd_callback, port);
  172. result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
  173. }
  174. static int iuu_reset(struct usb_serial_port *port, u8 wt)
  175. {
  176. struct iuu_private *priv = usb_get_serial_port_data(port);
  177. int result;
  178. char *buf_ptr = port->write_urb->transfer_buffer;
  179. dbg("%s - enter", __FUNCTION__);
  180. /* Prepare the reset sequence */
  181. *buf_ptr++ = IUU_RST_SET;
  182. *buf_ptr++ = IUU_DELAY_MS;
  183. *buf_ptr++ = wt;
  184. *buf_ptr = IUU_RST_CLEAR;
  185. /* send the sequence */
  186. usb_fill_bulk_urb(port->write_urb,
  187. port->serial->dev,
  188. usb_sndbulkpipe(port->serial->dev,
  189. port->bulk_out_endpointAddress),
  190. port->write_urb->transfer_buffer, 4, iuu_rxcmd, port);
  191. result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
  192. priv->reset = 0;
  193. return result;
  194. }
  195. /* Status Function
  196. * Return value is
  197. * 0x00 = no card
  198. * 0x01 = smartcard
  199. * 0x02 = sim card
  200. */
  201. static void iuu_update_status_callback(struct urb *urb)
  202. {
  203. struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
  204. struct iuu_private *priv = usb_get_serial_port_data(port);
  205. u8 *st;
  206. dbg("%s - enter", __FUNCTION__);
  207. if (urb->status) {
  208. dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
  209. /* error stop all */
  210. return;
  211. }
  212. st = urb->transfer_buffer;
  213. dbg("%s - enter", __FUNCTION__);
  214. if (urb->actual_length == 1) {
  215. switch (st[0]) {
  216. case 0x1:
  217. priv->tiostatus = iuu_cardout;
  218. break;
  219. case 0x0:
  220. priv->tiostatus = iuu_cardin;
  221. break;
  222. default:
  223. priv->tiostatus = iuu_cardin;
  224. }
  225. }
  226. iuu_rxcmd(urb);
  227. }
  228. static void iuu_status_callback(struct urb *urb)
  229. {
  230. struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
  231. int result;
  232. dbg("%s - enter", __FUNCTION__);
  233. dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
  234. usb_fill_bulk_urb(port->read_urb, port->serial->dev,
  235. usb_rcvbulkpipe(port->serial->dev,
  236. port->bulk_in_endpointAddress),
  237. port->read_urb->transfer_buffer, 256,
  238. iuu_update_status_callback, port);
  239. result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
  240. }
  241. static int iuu_status(struct usb_serial_port *port)
  242. {
  243. int result;
  244. dbg("%s - enter", __FUNCTION__);
  245. memset(port->write_urb->transfer_buffer, IUU_GET_STATE_REGISTER, 1);
  246. usb_fill_bulk_urb(port->write_urb, port->serial->dev,
  247. usb_sndbulkpipe(port->serial->dev,
  248. port->bulk_out_endpointAddress),
  249. port->write_urb->transfer_buffer, 1,
  250. iuu_status_callback, port);
  251. result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
  252. return result;
  253. }
  254. static int bulk_immediate(struct usb_serial_port *port, u8 *buf, u8 count)
  255. {
  256. int status;
  257. struct usb_serial *serial = port->serial;
  258. int actual = 0;
  259. dbg("%s - enter", __FUNCTION__);
  260. /* send the data out the bulk port */
  261. status =
  262. usb_bulk_msg(serial->dev,
  263. usb_sndbulkpipe(serial->dev,
  264. port->bulk_out_endpointAddress), buf,
  265. count, &actual, HZ * 1);
  266. if (status != IUU_OPERATION_OK) {
  267. dbg("%s - error = %2x", __FUNCTION__, status);
  268. } else {
  269. dbg("%s - write OK !", __FUNCTION__);
  270. }
  271. return status;
  272. }
  273. static int read_immediate(struct usb_serial_port *port, u8 *buf, u8 count)
  274. {
  275. int status;
  276. struct usb_serial *serial = port->serial;
  277. int actual = 0;
  278. dbg("%s - enter", __FUNCTION__);
  279. /* send the data out the bulk port */
  280. status =
  281. usb_bulk_msg(serial->dev,
  282. usb_rcvbulkpipe(serial->dev,
  283. port->bulk_in_endpointAddress), buf,
  284. count, &actual, HZ * 1);
  285. if (status != IUU_OPERATION_OK) {
  286. dbg("%s - error = %2x", __FUNCTION__, status);
  287. } else {
  288. dbg("%s - read OK !", __FUNCTION__);
  289. }
  290. return status;
  291. }
  292. static int iuu_led(struct usb_serial_port *port, unsigned int R,
  293. unsigned int G, unsigned int B, u8 f)
  294. {
  295. int status;
  296. u8 *buf;
  297. buf = kmalloc(8, GFP_KERNEL);
  298. if (!buf)
  299. return -ENOMEM;
  300. dbg("%s - enter", __FUNCTION__);
  301. buf[0] = IUU_SET_LED;
  302. buf[1] = R & 0xFF;
  303. buf[2] = (R >> 8) & 0xFF;
  304. buf[3] = G & 0xFF;
  305. buf[4] = (G >> 8) & 0xFF;
  306. buf[5] = B & 0xFF;
  307. buf[6] = (B >> 8) & 0xFF;
  308. buf[7] = f;
  309. status = bulk_immediate(port, buf, 8);
  310. kfree(buf);
  311. if (status != IUU_OPERATION_OK)
  312. dbg("%s - led error status = %2x", __FUNCTION__, status);
  313. else
  314. dbg("%s - led OK !", __FUNCTION__);
  315. return IUU_OPERATION_OK;
  316. }
  317. static void iuu_rgbf_fill_buffer(u8 *buf, u8 r1, u8 r2, u8 g1, u8 g2, u8 b1,
  318. u8 b2, u8 freq)
  319. {
  320. *buf++ = IUU_SET_LED;
  321. *buf++ = r1;
  322. *buf++ = r2;
  323. *buf++ = g1;
  324. *buf++ = g2;
  325. *buf++ = b1;
  326. *buf++ = b2;
  327. *buf = freq;
  328. }
  329. static void iuu_led_activity_on(struct urb *urb)
  330. {
  331. struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
  332. int result;
  333. char *buf_ptr = port->write_urb->transfer_buffer;
  334. *buf_ptr++ = IUU_SET_LED;
  335. if (xmas == 1) {
  336. get_random_bytes(buf_ptr, 6);
  337. *(buf_ptr+7) = 1;
  338. } else {
  339. iuu_rgbf_fill_buffer(buf_ptr, 255, 255, 0, 0, 0, 0, 255);
  340. }
  341. usb_fill_bulk_urb(port->write_urb, port->serial->dev,
  342. usb_sndbulkpipe(port->serial->dev,
  343. port->bulk_out_endpointAddress),
  344. port->write_urb->transfer_buffer, 8 ,
  345. iuu_rxcmd, port);
  346. result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
  347. }
  348. static void iuu_led_activity_off(struct urb *urb)
  349. {
  350. struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
  351. int result;
  352. char *buf_ptr = port->write_urb->transfer_buffer;
  353. if (xmas == 1) {
  354. iuu_rxcmd(urb);
  355. return;
  356. } else {
  357. *buf_ptr++ = IUU_SET_LED;
  358. iuu_rgbf_fill_buffer(buf_ptr, 0, 0, 255, 255, 0, 0, 255);
  359. }
  360. usb_fill_bulk_urb(port->write_urb, port->serial->dev,
  361. usb_sndbulkpipe(port->serial->dev,
  362. port->bulk_out_endpointAddress),
  363. port->write_urb->transfer_buffer, 8 ,
  364. iuu_rxcmd, port);
  365. result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
  366. }
  367. static int iuu_clk(struct usb_serial_port *port, int dwFrq)
  368. {
  369. int status;
  370. struct iuu_private *priv = usb_get_serial_port_data(port);
  371. int Count = 0;
  372. u8 FrqGenAdr = 0x69;
  373. u8 DIV = 0; /* 8bit */
  374. u8 XDRV = 0; /* 8bit */
  375. u8 PUMP = 0; /* 3bit */
  376. u8 PBmsb = 0; /* 2bit */
  377. u8 PBlsb = 0; /* 8bit */
  378. u8 PO = 0; /* 1bit */
  379. u8 Q = 0; /* 7bit */
  380. /* 24bit = 3bytes */
  381. unsigned int P = 0;
  382. unsigned int P2 = 0;
  383. int frq = (int)dwFrq;
  384. dbg("%s - enter", __FUNCTION__);
  385. if (frq == 0) {
  386. priv->buf[Count++] = IUU_UART_WRITE_I2C;
  387. priv->buf[Count++] = FrqGenAdr << 1;
  388. priv->buf[Count++] = 0x09;
  389. priv->buf[Count++] = 0x00;
  390. status = bulk_immediate(port, (u8 *) priv->buf, Count);
  391. if (status != 0) {
  392. dbg("%s - write error ", __FUNCTION__);
  393. return status;
  394. }
  395. } else if (frq == 3579000) {
  396. DIV = 100;
  397. P = 1193;
  398. Q = 40;
  399. XDRV = 0;
  400. } else if (frq == 3680000) {
  401. DIV = 105;
  402. P = 161;
  403. Q = 5;
  404. XDRV = 0;
  405. } else if (frq == 6000000) {
  406. DIV = 66;
  407. P = 66;
  408. Q = 2;
  409. XDRV = 0x28;
  410. } else {
  411. unsigned int result = 0;
  412. unsigned int tmp = 0;
  413. unsigned int check;
  414. unsigned int check2;
  415. char found = 0x00;
  416. unsigned int lQ = 2;
  417. unsigned int lP = 2055;
  418. unsigned int lDiv = 4;
  419. for (lQ = 2; lQ <= 47 && !found; lQ++)
  420. for (lP = 2055; lP >= 8 && !found; lP--)
  421. for (lDiv = 4; lDiv <= 127 && !found; lDiv++) {
  422. tmp = (12000000 / lDiv) * (lP / lQ);
  423. if (abs((int)(tmp - frq)) <
  424. abs((int)(frq - result))) {
  425. check2 = (12000000 / lQ);
  426. if (check2 < 250000)
  427. continue;
  428. check = (12000000 / lQ) * lP;
  429. if (check > 400000000)
  430. continue;
  431. if (check < 100000000)
  432. continue;
  433. if (lDiv < 4 || lDiv > 127)
  434. continue;
  435. result = tmp;
  436. P = lP;
  437. DIV = lDiv;
  438. Q = lQ;
  439. if (result == frq)
  440. found = 0x01;
  441. }
  442. }
  443. }
  444. P2 = ((P - PO) / 2) - 4;
  445. DIV = DIV;
  446. PUMP = 0x04;
  447. PBmsb = (P2 >> 8 & 0x03);
  448. PBlsb = P2 & 0xFF;
  449. PO = (P >> 10) & 0x01;
  450. Q = Q - 2;
  451. priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
  452. priv->buf[Count++] = FrqGenAdr << 1;
  453. priv->buf[Count++] = 0x09;
  454. priv->buf[Count++] = 0x20; /* Adr = 0x09 */
  455. priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
  456. priv->buf[Count++] = FrqGenAdr << 1;
  457. priv->buf[Count++] = 0x0C;
  458. priv->buf[Count++] = DIV; /* Adr = 0x0C */
  459. priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
  460. priv->buf[Count++] = FrqGenAdr << 1;
  461. priv->buf[Count++] = 0x12;
  462. priv->buf[Count++] = XDRV; /* Adr = 0x12 */
  463. priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
  464. priv->buf[Count++] = FrqGenAdr << 1;
  465. priv->buf[Count++] = 0x13;
  466. priv->buf[Count++] = 0x6B; /* Adr = 0x13 */
  467. priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
  468. priv->buf[Count++] = FrqGenAdr << 1;
  469. priv->buf[Count++] = 0x40;
  470. priv->buf[Count++] = (0xC0 | ((PUMP & 0x07) << 2)) |
  471. (PBmsb & 0x03); /* Adr = 0x40 */
  472. priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
  473. priv->buf[Count++] = FrqGenAdr << 1;
  474. priv->buf[Count++] = 0x41;
  475. priv->buf[Count++] = PBlsb; /* Adr = 0x41 */
  476. priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
  477. priv->buf[Count++] = FrqGenAdr << 1;
  478. priv->buf[Count++] = 0x42;
  479. priv->buf[Count++] = Q | (((PO & 0x01) << 7)); /* Adr = 0x42 */
  480. priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
  481. priv->buf[Count++] = FrqGenAdr << 1;
  482. priv->buf[Count++] = 0x44;
  483. priv->buf[Count++] = (char)0xFF; /* Adr = 0x44 */
  484. priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
  485. priv->buf[Count++] = FrqGenAdr << 1;
  486. priv->buf[Count++] = 0x45;
  487. priv->buf[Count++] = (char)0xFE; /* Adr = 0x45 */
  488. priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
  489. priv->buf[Count++] = FrqGenAdr << 1;
  490. priv->buf[Count++] = 0x46;
  491. priv->buf[Count++] = 0x7F; /* Adr = 0x46 */
  492. priv->buf[Count++] = IUU_UART_WRITE_I2C; /* 0x4C */
  493. priv->buf[Count++] = FrqGenAdr << 1;
  494. priv->buf[Count++] = 0x47;
  495. priv->buf[Count++] = (char)0x84; /* Adr = 0x47 */
  496. status = bulk_immediate(port, (u8 *) priv->buf, Count);
  497. if (status != IUU_OPERATION_OK)
  498. dbg("%s - write error ", __FUNCTION__);
  499. return status;
  500. }
  501. static int iuu_uart_flush(struct usb_serial_port *port)
  502. {
  503. int i;
  504. int status;
  505. u8 rxcmd = IUU_UART_RX;
  506. struct iuu_private *priv = usb_get_serial_port_data(port);
  507. dbg("%s - enter", __FUNCTION__);
  508. if (iuu_led(port, 0xF000, 0, 0, 0xFF) < 0)
  509. return -EIO;
  510. for (i = 0; i < 2; i++) {
  511. status = bulk_immediate(port, &rxcmd, 1);
  512. if (status != IUU_OPERATION_OK) {
  513. dbg("%s - uart_flush_write error", __FUNCTION__);
  514. return status;
  515. }
  516. status = read_immediate(port, &priv->len, 1);
  517. if (status != IUU_OPERATION_OK) {
  518. dbg("%s - uart_flush_read error", __FUNCTION__);
  519. return status;
  520. }
  521. if (priv->len > 0) {
  522. dbg("%s - uart_flush datalen is : %i ", __FUNCTION__,
  523. priv->len);
  524. status = read_immediate(port, priv->buf, priv->len);
  525. if (status != IUU_OPERATION_OK) {
  526. dbg("%s - uart_flush_read error", __FUNCTION__);
  527. return status;
  528. }
  529. }
  530. }
  531. dbg("%s - uart_flush_read OK!", __FUNCTION__);
  532. iuu_led(port, 0, 0xF000, 0, 0xFF);
  533. return status;
  534. }
  535. static void read_buf_callback(struct urb *urb)
  536. {
  537. struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
  538. unsigned char *data = urb->transfer_buffer;
  539. struct tty_struct *tty;
  540. dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
  541. if (urb->status) {
  542. dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
  543. if (urb->status == -EPROTO) {
  544. /* reschedule needed */
  545. }
  546. return;
  547. }
  548. dbg("%s - %i chars to write", __FUNCTION__, urb->actual_length);
  549. tty = port->tty;
  550. if (data == NULL)
  551. dbg("%s - data is NULL !!!", __FUNCTION__);
  552. if (tty && urb->actual_length && data) {
  553. tty_insert_flip_string(tty, data, urb->actual_length);
  554. tty_flip_buffer_push(tty);
  555. }
  556. iuu_led_activity_on(urb);
  557. }
  558. static int iuu_bulk_write(struct usb_serial_port *port)
  559. {
  560. struct iuu_private *priv = usb_get_serial_port_data(port);
  561. unsigned int flags;
  562. int result;
  563. int i;
  564. char *buf_ptr = port->write_urb->transfer_buffer;
  565. dbg("%s - enter", __FUNCTION__);
  566. *buf_ptr++ = IUU_UART_ESC;
  567. *buf_ptr++ = IUU_UART_TX;
  568. *buf_ptr++ = priv->writelen;
  569. memcpy(buf_ptr, priv->writebuf,
  570. priv->writelen);
  571. if (debug == 1) {
  572. for (i = 0; i < priv->writelen; i++)
  573. sprintf(priv->dbgbuf + i*2 ,
  574. "%02X", priv->writebuf[i]);
  575. priv->dbgbuf[priv->writelen+i*2] = 0;
  576. dbg("%s - writing %i chars : %s", __FUNCTION__,
  577. priv->writelen, priv->dbgbuf);
  578. }
  579. usb_fill_bulk_urb(port->write_urb, port->serial->dev,
  580. usb_sndbulkpipe(port->serial->dev,
  581. port->bulk_out_endpointAddress),
  582. port->write_urb->transfer_buffer, priv->writelen + 3,
  583. iuu_rxcmd, port);
  584. result = usb_submit_urb(port->write_urb, GFP_ATOMIC);
  585. spin_lock_irqsave(&priv->lock, flags);
  586. priv->writelen = 0;
  587. spin_unlock_irqrestore(&priv->lock, flags);
  588. usb_serial_port_softint(port);
  589. return result;
  590. }
  591. static int iuu_read_buf(struct usb_serial_port *port, int len)
  592. {
  593. int result;
  594. dbg("%s - enter", __FUNCTION__);
  595. usb_fill_bulk_urb(port->read_urb, port->serial->dev,
  596. usb_rcvbulkpipe(port->serial->dev,
  597. port->bulk_in_endpointAddress),
  598. port->read_urb->transfer_buffer, len,
  599. read_buf_callback, port);
  600. result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
  601. return result;
  602. }
  603. static void iuu_uart_read_callback(struct urb *urb)
  604. {
  605. struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
  606. struct iuu_private *priv = usb_get_serial_port_data(port);
  607. unsigned int flags;
  608. int status;
  609. int error = 0;
  610. int len = 0;
  611. unsigned char *data = urb->transfer_buffer;
  612. priv->poll++;
  613. dbg("%s - enter", __FUNCTION__);
  614. if (urb->status) {
  615. dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
  616. /* error stop all */
  617. return;
  618. }
  619. if (data == NULL)
  620. dbg("%s - data is NULL !!!", __FUNCTION__);
  621. if (urb->actual_length == 1 && data != NULL)
  622. len = (int) data[0];
  623. if (urb->actual_length > 1) {
  624. dbg("%s - urb->actual_length = %i", __FUNCTION__,
  625. urb->actual_length);
  626. error = 1;
  627. return;
  628. }
  629. /* if len > 0 call readbuf */
  630. if (len > 0 && error == 0) {
  631. dbg("%s - call read buf - len to read is %i ",
  632. __FUNCTION__, len);
  633. status = iuu_read_buf(port, len);
  634. return;
  635. }
  636. /* need to update status ? */
  637. if (priv->poll > 99) {
  638. status = iuu_status(port);
  639. priv->poll = 0;
  640. return;
  641. }
  642. /* reset waiting ? */
  643. if (priv->reset == 1) {
  644. status = iuu_reset(port, 0xC);
  645. return;
  646. }
  647. /* Writebuf is waiting */
  648. spin_lock_irqsave(&priv->lock, flags);
  649. if (priv->writelen > 0) {
  650. spin_unlock_irqrestore(&priv->lock, flags);
  651. status = iuu_bulk_write(port);
  652. return;
  653. }
  654. spin_unlock_irqrestore(&priv->lock, flags);
  655. /* if nothing to write call again rxcmd */
  656. dbg("%s - rxcmd recall", __FUNCTION__);
  657. iuu_led_activity_off(urb);
  658. return;
  659. }
  660. static int iuu_uart_write(struct usb_serial_port *port, const u8 *buf,
  661. int count)
  662. {
  663. struct iuu_private *priv = usb_get_serial_port_data(port);
  664. unsigned int flags;
  665. dbg("%s - enter", __FUNCTION__);
  666. if (count > 256)
  667. return -ENOMEM;
  668. spin_lock_irqsave(&priv->lock, flags);
  669. if (priv->writelen > 0) {
  670. /* buffer already filled but not commited */
  671. spin_unlock_irqrestore(&priv->lock, flags);
  672. return (0);
  673. }
  674. /* fill the buffer */
  675. memcpy(priv->writebuf, buf, count);
  676. priv->writelen = count;
  677. spin_unlock_irqrestore(&priv->lock, flags);
  678. return (count);
  679. }
  680. static void read_rxcmd_callback(struct urb *urb)
  681. {
  682. struct usb_serial_port *port = (struct usb_serial_port *)urb->context;
  683. int result;
  684. dbg("%s - enter", __FUNCTION__);
  685. dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
  686. if (urb->status) {
  687. dbg("%s - urb->status = %d", __FUNCTION__, urb->status);
  688. /* error stop all */
  689. return;
  690. }
  691. usb_fill_bulk_urb(port->read_urb, port->serial->dev,
  692. usb_rcvbulkpipe(port->serial->dev,
  693. port->bulk_in_endpointAddress),
  694. port->read_urb->transfer_buffer, 256,
  695. iuu_uart_read_callback, port);
  696. result = usb_submit_urb(port->read_urb, GFP_ATOMIC);
  697. dbg("%s - submit result = %d", __FUNCTION__, result);
  698. return;
  699. }
  700. static int iuu_uart_on(struct usb_serial_port *port)
  701. {
  702. int status;
  703. u8 *buf;
  704. buf = kmalloc(sizeof(u8) * 4, GFP_KERNEL);
  705. if (!buf)
  706. return -ENOMEM;
  707. buf[0] = IUU_UART_ENABLE;
  708. buf[1] = (u8) ((IUU_BAUD_9600 >> 8) & 0x00FF);
  709. buf[2] = (u8) (0x00FF & IUU_BAUD_9600);
  710. buf[3] = (u8) (0x0F0 & IUU_TWO_STOP_BITS) | (0x07 & IUU_PARITY_EVEN);
  711. status = bulk_immediate(port, buf, 4);
  712. if (status != IUU_OPERATION_OK) {
  713. dbg("%s - uart_on error", __FUNCTION__);
  714. goto uart_enable_failed;
  715. }
  716. /* iuu_reset() the card after iuu_uart_on() */
  717. status = iuu_uart_flush(port);
  718. if (status != IUU_OPERATION_OK)
  719. dbg("%s - uart_flush error", __FUNCTION__);
  720. uart_enable_failed:
  721. kfree(buf);
  722. return status;
  723. }
  724. /* Diables the IUU UART (a.k.a. the Phoenix voiderface) */
  725. static int iuu_uart_off(struct usb_serial_port *port)
  726. {
  727. int status;
  728. u8 *buf;
  729. buf = kmalloc(1, GFP_KERNEL);
  730. if (!buf)
  731. return -ENOMEM;
  732. buf[0] = IUU_UART_DISABLE;
  733. status = bulk_immediate(port, buf, 1);
  734. if (status != IUU_OPERATION_OK)
  735. dbg("%s - uart_off error", __FUNCTION__);
  736. kfree(buf);
  737. return status;
  738. }
  739. static int iuu_uart_baud(struct usb_serial_port *port, u32 baud,
  740. u32 *actual, u8 parity)
  741. {
  742. int status;
  743. u8 *dataout;
  744. u8 DataCount = 0;
  745. u8 T1Frekvens = 0;
  746. u8 T1reload = 0;
  747. unsigned int T1FrekvensHZ = 0;
  748. dataout = kmalloc(sizeof(u8) * 5, GFP_KERNEL);
  749. if (!dataout)
  750. return -ENOMEM;
  751. if (baud < 1200 || baud > 230400) {
  752. kfree(dataout);
  753. return IUU_INVALID_PARAMETER;
  754. }
  755. if (baud > 977) {
  756. T1Frekvens = 3;
  757. T1FrekvensHZ = 500000;
  758. }
  759. if (baud > 3906) {
  760. T1Frekvens = 2;
  761. T1FrekvensHZ = 2000000;
  762. }
  763. if (baud > 11718) {
  764. T1Frekvens = 1;
  765. T1FrekvensHZ = 6000000;
  766. }
  767. if (baud > 46875) {
  768. T1Frekvens = 0;
  769. T1FrekvensHZ = 24000000;
  770. }
  771. T1reload = 256 - (u8) (T1FrekvensHZ / (baud * 2));
  772. /* magic number here: ENTER_FIRMWARE_UPDATE; */
  773. dataout[DataCount++] = IUU_UART_ESC;
  774. /* magic number here: CHANGE_BAUD; */
  775. dataout[DataCount++] = IUU_UART_CHANGE;
  776. dataout[DataCount++] = T1Frekvens;
  777. dataout[DataCount++] = T1reload;
  778. *actual = (T1FrekvensHZ / (256 - T1reload)) / 2;
  779. switch (parity & 0x0F) {
  780. case IUU_PARITY_NONE:
  781. dataout[DataCount++] = 0x00;
  782. break;
  783. case IUU_PARITY_EVEN:
  784. dataout[DataCount++] = 0x01;
  785. break;
  786. case IUU_PARITY_ODD:
  787. dataout[DataCount++] = 0x02;
  788. break;
  789. case IUU_PARITY_MARK:
  790. dataout[DataCount++] = 0x03;
  791. break;
  792. case IUU_PARITY_SPACE:
  793. dataout[DataCount++] = 0x04;
  794. break;
  795. default:
  796. kfree(dataout);
  797. return IUU_INVALID_PARAMETER;
  798. break;
  799. }
  800. switch (parity & 0xF0) {
  801. case IUU_ONE_STOP_BIT:
  802. dataout[DataCount - 1] |= IUU_ONE_STOP_BIT;
  803. break;
  804. case IUU_TWO_STOP_BITS:
  805. dataout[DataCount - 1] |= IUU_TWO_STOP_BITS;
  806. break;
  807. default:
  808. kfree(dataout);
  809. return IUU_INVALID_PARAMETER;
  810. break;
  811. }
  812. status = bulk_immediate(port, dataout, DataCount);
  813. if (status != IUU_OPERATION_OK)
  814. dbg("%s - uart_off error", __FUNCTION__);
  815. kfree(dataout);
  816. return status;
  817. }
  818. static int set_control_lines(struct usb_device *dev, u8 value)
  819. {
  820. return 0;
  821. }
  822. static void iuu_close(struct usb_serial_port *port, struct file *filp)
  823. {
  824. /* iuu_led (port,255,0,0,0); */
  825. struct usb_serial *serial;
  826. struct iuu_private *priv = usb_get_serial_port_data(port);
  827. unsigned long flags;
  828. unsigned int c_cflag;
  829. serial = port->serial;
  830. if (!serial)
  831. return;
  832. dbg("%s - port %d", __FUNCTION__, port->number);
  833. iuu_uart_off(port);
  834. if (serial->dev) {
  835. if (port->tty) {
  836. c_cflag = port->tty->termios->c_cflag;
  837. if (c_cflag & HUPCL) {
  838. /* drop DTR and RTS */
  839. priv = usb_get_serial_port_data(port);
  840. spin_lock_irqsave(&priv->lock, flags);
  841. priv->line_control = 0;
  842. spin_unlock_irqrestore(&priv->lock, flags);
  843. set_control_lines(port->serial->dev, 0);
  844. }
  845. }
  846. /* free writebuf */
  847. /* shutdown our urbs */
  848. dbg("%s - shutting down urbs", __FUNCTION__);
  849. usb_kill_urb(port->write_urb);
  850. usb_kill_urb(port->read_urb);
  851. usb_kill_urb(port->interrupt_in_urb);
  852. msleep(1000);
  853. /* wait one second to free all buffers */
  854. iuu_led(port, 0, 0, 0xF000, 0xFF);
  855. msleep(1000);
  856. usb_reset_device(port->serial->dev);
  857. }
  858. }
  859. static int iuu_open(struct usb_serial_port *port, struct file *filp)
  860. {
  861. struct usb_serial *serial = port->serial;
  862. u8 *buf;
  863. int result;
  864. u32 actual;
  865. unsigned long flags;
  866. struct iuu_private *priv = usb_get_serial_port_data(port);
  867. dbg("%s - port %d", __FUNCTION__, port->number);
  868. usb_clear_halt(serial->dev, port->write_urb->pipe);
  869. usb_clear_halt(serial->dev, port->read_urb->pipe);
  870. buf = kmalloc(10, GFP_KERNEL);
  871. if (buf == NULL)
  872. return -ENOMEM;
  873. /* fixup the endpoint buffer size */
  874. kfree(port->bulk_out_buffer);
  875. port->bulk_out_buffer = kmalloc(512, GFP_KERNEL);
  876. port->bulk_out_size = 512;
  877. kfree(port->bulk_in_buffer);
  878. port->bulk_in_buffer = kmalloc(512, GFP_KERNEL);
  879. port->bulk_in_size = 512;
  880. if (!port->bulk_out_buffer || !port->bulk_in_buffer) {
  881. kfree(port->bulk_out_buffer);
  882. kfree(port->bulk_in_buffer);
  883. kfree(buf);
  884. return -ENOMEM;
  885. }
  886. usb_fill_bulk_urb(port->write_urb, port->serial->dev,
  887. usb_sndbulkpipe(port->serial->dev,
  888. port->bulk_out_endpointAddress),
  889. port->bulk_out_buffer, 512,
  890. NULL, NULL);
  891. usb_fill_bulk_urb(port->read_urb, port->serial->dev,
  892. usb_rcvbulkpipe(port->serial->dev,
  893. port->bulk_in_endpointAddress),
  894. port->bulk_in_buffer, 512,
  895. NULL, NULL);
  896. /* set the termios structure */
  897. spin_lock_irqsave(&priv->lock, flags);
  898. if (!priv->termios_initialized) {
  899. *(port->tty->termios) = tty_std_termios;
  900. port->tty->termios->c_cflag = CLOCAL | CREAD | CS8 | B9600
  901. | TIOCM_CTS | CSTOPB | PARENB;
  902. port->tty->termios->c_lflag = 0;
  903. port->tty->termios->c_oflag = 0;
  904. port->tty->termios->c_iflag = 0;
  905. priv->termios_initialized = 1;
  906. port->tty->low_latency = 1;
  907. priv->poll = 0;
  908. }
  909. spin_unlock_irqrestore(&priv->lock, flags);
  910. /* initialize writebuf */
  911. #define FISH(a, b, c, d) do { \
  912. result = usb_control_msg(port->serial->dev, \
  913. usb_rcvctrlpipe(port->serial->dev, 0), \
  914. b, a, c, d, buf, 1, 1000); \
  915. dbg("0x%x:0x%x:0x%x:0x%x %d - %x", a, b, c, d, result, \
  916. buf[0]); } while (0);
  917. #define SOUP(a, b, c, d) do { \
  918. result = usb_control_msg(port->serial->dev, \
  919. usb_sndctrlpipe(port->serial->dev, 0), \
  920. b, a, c, d, NULL, 0, 1000); \
  921. dbg("0x%x:0x%x:0x%x:0x%x %d", a, b, c, d, result); } while (0)
  922. /* This is not UART related but IUU USB driver related or something */
  923. /* like that. Basically no IUU will accept any commands from the USB */
  924. /* host unless it has received the following message */
  925. /* sprintf(buf ,"%c%c%c%c",0x03,0x02,0x02,0x0); */
  926. SOUP(0x03, 0x02, 0x02, 0x0);
  927. kfree(buf);
  928. iuu_led(port, 0xF000, 0xF000, 0, 0xFF);
  929. iuu_uart_on(port);
  930. if (boost < 100)
  931. boost = 100;
  932. switch (clockmode) {
  933. case 2: /* 3.680 Mhz */
  934. iuu_clk(port, IUU_CLK_3680000 * boost / 100);
  935. result =
  936. iuu_uart_baud(port, 9600 * boost / 100, &actual,
  937. IUU_PARITY_EVEN);
  938. break;
  939. case 3: /* 6.00 Mhz */
  940. iuu_clk(port, IUU_CLK_6000000 * boost / 100);
  941. result =
  942. iuu_uart_baud(port, 16457 * boost / 100, &actual,
  943. IUU_PARITY_EVEN);
  944. break;
  945. default: /* 3.579 Mhz */
  946. iuu_clk(port, IUU_CLK_3579000 * boost / 100);
  947. result =
  948. iuu_uart_baud(port, 9600 * boost / 100, &actual,
  949. IUU_PARITY_EVEN);
  950. }
  951. /* set the cardin cardout signals */
  952. switch (cdmode) {
  953. case 0:
  954. iuu_cardin = 0;
  955. iuu_cardout = 0;
  956. break;
  957. case 1:
  958. iuu_cardin = TIOCM_CD;
  959. iuu_cardout = 0;
  960. break;
  961. case 2:
  962. iuu_cardin = 0;
  963. iuu_cardout = TIOCM_CD;
  964. break;
  965. case 3:
  966. iuu_cardin = TIOCM_DSR;
  967. iuu_cardout = 0;
  968. break;
  969. case 4:
  970. iuu_cardin = 0;
  971. iuu_cardout = TIOCM_DSR;
  972. break;
  973. case 5:
  974. iuu_cardin = TIOCM_CTS;
  975. iuu_cardout = 0;
  976. break;
  977. case 6:
  978. iuu_cardin = 0;
  979. iuu_cardout = TIOCM_CTS;
  980. break;
  981. case 7:
  982. iuu_cardin = TIOCM_RNG;
  983. iuu_cardout = 0;
  984. break;
  985. case 8:
  986. iuu_cardin = 0;
  987. iuu_cardout = TIOCM_RNG;
  988. }
  989. iuu_uart_flush(port);
  990. dbg("%s - initialization done", __FUNCTION__);
  991. memset(port->write_urb->transfer_buffer, IUU_UART_RX, 1);
  992. usb_fill_bulk_urb(port->write_urb, port->serial->dev,
  993. usb_sndbulkpipe(port->serial->dev,
  994. port->bulk_out_endpointAddress),
  995. port->write_urb->transfer_buffer, 1,
  996. read_rxcmd_callback, port);
  997. result = usb_submit_urb(port->write_urb, GFP_KERNEL);
  998. if (result) {
  999. dev_err(&port->dev, "%s - failed submitting read urb,"
  1000. " error %d\n", __FUNCTION__, result);
  1001. iuu_close(port, NULL);
  1002. return -EPROTO;
  1003. } else {
  1004. dbg("%s - rxcmd OK", __FUNCTION__);
  1005. }
  1006. return result;
  1007. }
  1008. static struct usb_serial_driver iuu_device = {
  1009. .driver = {
  1010. .owner = THIS_MODULE,
  1011. .name = "iuu_phoenix",
  1012. },
  1013. .id_table = id_table,
  1014. .num_interrupt_in = NUM_DONT_CARE,
  1015. .num_bulk_in = 1,
  1016. .num_bulk_out = 1,
  1017. .num_ports = 1,
  1018. .open = iuu_open,
  1019. .close = iuu_close,
  1020. .write = iuu_uart_write,
  1021. .read_bulk_callback = iuu_uart_read_callback,
  1022. .tiocmget = iuu_tiocmget,
  1023. .tiocmset = iuu_tiocmset,
  1024. .attach = iuu_startup,
  1025. .shutdown = iuu_shutdown,
  1026. };
  1027. static int __init iuu_init(void)
  1028. {
  1029. int retval;
  1030. retval = usb_serial_register(&iuu_device);
  1031. if (retval)
  1032. goto failed_usb_serial_register;
  1033. retval = usb_register(&iuu_driver);
  1034. if (retval)
  1035. goto failed_usb_register;
  1036. info(DRIVER_DESC " " DRIVER_VERSION);
  1037. return 0;
  1038. failed_usb_register:
  1039. usb_serial_deregister(&iuu_device);
  1040. failed_usb_serial_register:
  1041. return retval;
  1042. }
  1043. static void __exit iuu_exit(void)
  1044. {
  1045. usb_deregister(&iuu_driver);
  1046. usb_serial_deregister(&iuu_device);
  1047. }
  1048. module_init(iuu_init);
  1049. module_exit(iuu_exit);
  1050. MODULE_AUTHOR("Alain Degreffe eczema@ecze.com");
  1051. MODULE_DESCRIPTION(DRIVER_DESC);
  1052. MODULE_LICENSE("GPL");
  1053. MODULE_VERSION(DRIVER_VERSION);
  1054. module_param(debug, bool, S_IRUGO | S_IWUSR);
  1055. MODULE_PARM_DESC(debug, "Debug enabled or not");
  1056. module_param(xmas, bool, S_IRUGO | S_IWUSR);
  1057. MODULE_PARM_DESC(xmas, "xmas color enabled or not");
  1058. module_param(boost, int, S_IRUGO | S_IWUSR);
  1059. MODULE_PARM_DESC(boost, "overclock boost percent 100 to 500");
  1060. module_param(clockmode, int, S_IRUGO | S_IWUSR);
  1061. MODULE_PARM_DESC(clockmode, "1=3Mhz579,2=3Mhz680,3=6Mhz");
  1062. module_param(cdmode, int, S_IRUGO | S_IWUSR);
  1063. MODULE_PARM_DESC(cdmode, "Card detect mode 0=none, 1=CD, 2=!CD, 3=DSR, "
  1064. "4=!DSR, 5=CTS, 6=!CTS, 7=RING, 8=!RING");