hvc_console.c 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907
  1. /*
  2. * Copyright (C) 2001 Anton Blanchard <anton@au.ibm.com>, IBM
  3. * Copyright (C) 2001 Paul Mackerras <paulus@au.ibm.com>, IBM
  4. * Copyright (C) 2004 Benjamin Herrenschmidt <benh@kernel.crashing.org>, IBM Corp.
  5. * Copyright (C) 2004 IBM Corporation
  6. *
  7. * Additional Author(s):
  8. * Ryan S. Arnold <rsa@us.ibm.com>
  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. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU General Public License
  21. * along with this program; if not, write to the Free Software
  22. * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  23. */
  24. #include <linux/console.h>
  25. #include <linux/cpumask.h>
  26. #include <linux/init.h>
  27. #include <linux/kbd_kern.h>
  28. #include <linux/kernel.h>
  29. #include <linux/kthread.h>
  30. #include <linux/list.h>
  31. #include <linux/module.h>
  32. #include <linux/major.h>
  33. #include <linux/sysrq.h>
  34. #include <linux/tty.h>
  35. #include <linux/tty_flip.h>
  36. #include <linux/sched.h>
  37. #include <linux/spinlock.h>
  38. #include <linux/delay.h>
  39. #include <linux/freezer.h>
  40. #include <asm/uaccess.h>
  41. #include "hvc_console.h"
  42. #define HVC_MAJOR 229
  43. #define HVC_MINOR 0
  44. /*
  45. * Wait this long per iteration while trying to push buffered data to the
  46. * hypervisor before allowing the tty to complete a close operation.
  47. */
  48. #define HVC_CLOSE_WAIT (HZ/100) /* 1/10 of a second */
  49. /*
  50. * These sizes are most efficient for vio, because they are the
  51. * native transfer size. We could make them selectable in the
  52. * future to better deal with backends that want other buffer sizes.
  53. */
  54. #define N_OUTBUF 16
  55. #define N_INBUF 16
  56. #define __ALIGNED__ __attribute__((__aligned__(sizeof(long))))
  57. static struct tty_driver *hvc_driver;
  58. static struct task_struct *hvc_task;
  59. /* Picks up late kicks after list walk but before schedule() */
  60. static int hvc_kicked;
  61. static int hvc_init(void);
  62. #ifdef CONFIG_MAGIC_SYSRQ
  63. static int sysrq_pressed;
  64. #endif
  65. /* dynamic list of hvc_struct instances */
  66. static LIST_HEAD(hvc_structs);
  67. /*
  68. * Protect the list of hvc_struct instances from inserts and removals during
  69. * list traversal.
  70. */
  71. static DEFINE_SPINLOCK(hvc_structs_lock);
  72. /*
  73. * This value is used to assign a tty->index value to a hvc_struct based
  74. * upon order of exposure via hvc_probe(), when we can not match it to
  75. * a console candidate registered with hvc_instantiate().
  76. */
  77. static int last_hvc = -1;
  78. /*
  79. * Do not call this function with either the hvc_structs_lock or the hvc_struct
  80. * lock held. If successful, this function increments the kref reference
  81. * count against the target hvc_struct so it should be released when finished.
  82. */
  83. static struct hvc_struct *hvc_get_by_index(int index)
  84. {
  85. struct hvc_struct *hp;
  86. unsigned long flags;
  87. spin_lock(&hvc_structs_lock);
  88. list_for_each_entry(hp, &hvc_structs, next) {
  89. spin_lock_irqsave(&hp->lock, flags);
  90. if (hp->index == index) {
  91. kref_get(&hp->kref);
  92. spin_unlock_irqrestore(&hp->lock, flags);
  93. spin_unlock(&hvc_structs_lock);
  94. return hp;
  95. }
  96. spin_unlock_irqrestore(&hp->lock, flags);
  97. }
  98. hp = NULL;
  99. spin_unlock(&hvc_structs_lock);
  100. return hp;
  101. }
  102. /*
  103. * Initial console vtermnos for console API usage prior to full console
  104. * initialization. Any vty adapter outside this range will not have usable
  105. * console interfaces but can still be used as a tty device. This has to be
  106. * static because kmalloc will not work during early console init.
  107. */
  108. static struct hv_ops *cons_ops[MAX_NR_HVC_CONSOLES];
  109. static uint32_t vtermnos[MAX_NR_HVC_CONSOLES] =
  110. {[0 ... MAX_NR_HVC_CONSOLES - 1] = -1};
  111. /*
  112. * Console APIs, NOT TTY. These APIs are available immediately when
  113. * hvc_console_setup() finds adapters.
  114. */
  115. static void hvc_console_print(struct console *co, const char *b,
  116. unsigned count)
  117. {
  118. char c[N_OUTBUF] __ALIGNED__;
  119. unsigned i = 0, n = 0;
  120. int r, donecr = 0, index = co->index;
  121. /* Console access attempt outside of acceptable console range. */
  122. if (index >= MAX_NR_HVC_CONSOLES)
  123. return;
  124. /* This console adapter was removed so it is not usable. */
  125. if (vtermnos[index] < 0)
  126. return;
  127. while (count > 0 || i > 0) {
  128. if (count > 0 && i < sizeof(c)) {
  129. if (b[n] == '\n' && !donecr) {
  130. c[i++] = '\r';
  131. donecr = 1;
  132. } else {
  133. c[i++] = b[n++];
  134. donecr = 0;
  135. --count;
  136. }
  137. } else {
  138. r = cons_ops[index]->put_chars(vtermnos[index], c, i);
  139. if (r <= 0) {
  140. /* throw away chars on error */
  141. i = 0;
  142. } else if (r > 0) {
  143. i -= r;
  144. if (i > 0)
  145. memmove(c, c+r, i);
  146. }
  147. }
  148. }
  149. }
  150. static struct tty_driver *hvc_console_device(struct console *c, int *index)
  151. {
  152. if (vtermnos[c->index] == -1)
  153. return NULL;
  154. *index = c->index;
  155. return hvc_driver;
  156. }
  157. static int __init hvc_console_setup(struct console *co, char *options)
  158. {
  159. if (co->index < 0 || co->index >= MAX_NR_HVC_CONSOLES)
  160. return -ENODEV;
  161. if (vtermnos[co->index] == -1)
  162. return -ENODEV;
  163. return 0;
  164. }
  165. static struct console hvc_con_driver = {
  166. .name = "hvc",
  167. .write = hvc_console_print,
  168. .device = hvc_console_device,
  169. .setup = hvc_console_setup,
  170. .flags = CON_PRINTBUFFER,
  171. .index = -1,
  172. };
  173. /*
  174. * Early console initialization. Precedes driver initialization.
  175. *
  176. * (1) we are first, and the user specified another driver
  177. * -- index will remain -1
  178. * (2) we are first and the user specified no driver
  179. * -- index will be set to 0, then we will fail setup.
  180. * (3) we are first and the user specified our driver
  181. * -- index will be set to user specified driver, and we will fail
  182. * (4) we are after driver, and this initcall will register us
  183. * -- if the user didn't specify a driver then the console will match
  184. *
  185. * Note that for cases 2 and 3, we will match later when the io driver
  186. * calls hvc_instantiate() and call register again.
  187. */
  188. static int __init hvc_console_init(void)
  189. {
  190. register_console(&hvc_con_driver);
  191. return 0;
  192. }
  193. console_initcall(hvc_console_init);
  194. /* callback when the kboject ref count reaches zero. */
  195. static void destroy_hvc_struct(struct kref *kref)
  196. {
  197. struct hvc_struct *hp = container_of(kref, struct hvc_struct, kref);
  198. unsigned long flags;
  199. spin_lock(&hvc_structs_lock);
  200. spin_lock_irqsave(&hp->lock, flags);
  201. list_del(&(hp->next));
  202. spin_unlock_irqrestore(&hp->lock, flags);
  203. spin_unlock(&hvc_structs_lock);
  204. kfree(hp);
  205. }
  206. /*
  207. * hvc_instantiate() is an early console discovery method which locates
  208. * consoles * prior to the vio subsystem discovering them. Hotplugged
  209. * vty adapters do NOT get an hvc_instantiate() callback since they
  210. * appear after early console init.
  211. */
  212. int hvc_instantiate(uint32_t vtermno, int index, struct hv_ops *ops)
  213. {
  214. struct hvc_struct *hp;
  215. if (index < 0 || index >= MAX_NR_HVC_CONSOLES)
  216. return -1;
  217. if (vtermnos[index] != -1)
  218. return -1;
  219. /* make sure no no tty has been registered in this index */
  220. hp = hvc_get_by_index(index);
  221. if (hp) {
  222. kref_put(&hp->kref, destroy_hvc_struct);
  223. return -1;
  224. }
  225. vtermnos[index] = vtermno;
  226. cons_ops[index] = ops;
  227. /* reserve all indices up to and including this index */
  228. if (last_hvc < index)
  229. last_hvc = index;
  230. /* if this index is what the user requested, then register
  231. * now (setup won't fail at this point). It's ok to just
  232. * call register again if previously .setup failed.
  233. */
  234. if (index == hvc_con_driver.index)
  235. register_console(&hvc_con_driver);
  236. return 0;
  237. }
  238. EXPORT_SYMBOL_GPL(hvc_instantiate);
  239. /* Wake the sleeping khvcd */
  240. void hvc_kick(void)
  241. {
  242. hvc_kicked = 1;
  243. wake_up_process(hvc_task);
  244. }
  245. EXPORT_SYMBOL_GPL(hvc_kick);
  246. static void hvc_unthrottle(struct tty_struct *tty)
  247. {
  248. hvc_kick();
  249. }
  250. /*
  251. * The TTY interface won't be used until after the vio layer has exposed the vty
  252. * adapter to the kernel.
  253. */
  254. static int hvc_open(struct tty_struct *tty, struct file * filp)
  255. {
  256. struct hvc_struct *hp;
  257. unsigned long flags;
  258. int rc = 0;
  259. /* Auto increments kref reference if found. */
  260. if (!(hp = hvc_get_by_index(tty->index)))
  261. return -ENODEV;
  262. spin_lock_irqsave(&hp->lock, flags);
  263. /* Check and then increment for fast path open. */
  264. if (hp->count++ > 0) {
  265. spin_unlock_irqrestore(&hp->lock, flags);
  266. hvc_kick();
  267. return 0;
  268. } /* else count == 0 */
  269. tty->driver_data = hp;
  270. hp->tty = tty;
  271. spin_unlock_irqrestore(&hp->lock, flags);
  272. if (hp->ops->notifier_add)
  273. rc = hp->ops->notifier_add(hp, hp->data);
  274. /*
  275. * If the notifier fails we return an error. The tty layer
  276. * will call hvc_close() after a failed open but we don't want to clean
  277. * up there so we'll clean up here and clear out the previously set
  278. * tty fields and return the kref reference.
  279. */
  280. if (rc) {
  281. spin_lock_irqsave(&hp->lock, flags);
  282. hp->tty = NULL;
  283. spin_unlock_irqrestore(&hp->lock, flags);
  284. tty->driver_data = NULL;
  285. kref_put(&hp->kref, destroy_hvc_struct);
  286. printk(KERN_ERR "hvc_open: request_irq failed with rc %d.\n", rc);
  287. }
  288. /* Force wakeup of the polling thread */
  289. hvc_kick();
  290. return rc;
  291. }
  292. static void hvc_close(struct tty_struct *tty, struct file * filp)
  293. {
  294. struct hvc_struct *hp;
  295. unsigned long flags;
  296. if (tty_hung_up_p(filp))
  297. return;
  298. /*
  299. * No driver_data means that this close was issued after a failed
  300. * hvc_open by the tty layer's release_dev() function and we can just
  301. * exit cleanly because the kref reference wasn't made.
  302. */
  303. if (!tty->driver_data)
  304. return;
  305. hp = tty->driver_data;
  306. spin_lock_irqsave(&hp->lock, flags);
  307. if (--hp->count == 0) {
  308. /* We are done with the tty pointer now. */
  309. hp->tty = NULL;
  310. spin_unlock_irqrestore(&hp->lock, flags);
  311. if (hp->ops->notifier_del)
  312. hp->ops->notifier_del(hp, hp->data);
  313. /* cancel pending tty resize work */
  314. cancel_work_sync(&hp->tty_resize);
  315. /*
  316. * Chain calls chars_in_buffer() and returns immediately if
  317. * there is no buffered data otherwise sleeps on a wait queue
  318. * waking periodically to check chars_in_buffer().
  319. */
  320. tty_wait_until_sent(tty, HVC_CLOSE_WAIT);
  321. } else {
  322. if (hp->count < 0)
  323. printk(KERN_ERR "hvc_close %X: oops, count is %d\n",
  324. hp->vtermno, hp->count);
  325. spin_unlock_irqrestore(&hp->lock, flags);
  326. }
  327. kref_put(&hp->kref, destroy_hvc_struct);
  328. }
  329. static void hvc_hangup(struct tty_struct *tty)
  330. {
  331. struct hvc_struct *hp = tty->driver_data;
  332. unsigned long flags;
  333. int temp_open_count;
  334. if (!hp)
  335. return;
  336. /* cancel pending tty resize work */
  337. cancel_work_sync(&hp->tty_resize);
  338. spin_lock_irqsave(&hp->lock, flags);
  339. /*
  340. * The N_TTY line discipline has problems such that in a close vs
  341. * open->hangup case this can be called after the final close so prevent
  342. * that from happening for now.
  343. */
  344. if (hp->count <= 0) {
  345. spin_unlock_irqrestore(&hp->lock, flags);
  346. return;
  347. }
  348. temp_open_count = hp->count;
  349. hp->count = 0;
  350. hp->n_outbuf = 0;
  351. hp->tty = NULL;
  352. spin_unlock_irqrestore(&hp->lock, flags);
  353. if (hp->ops->notifier_hangup)
  354. hp->ops->notifier_hangup(hp, hp->data);
  355. while(temp_open_count) {
  356. --temp_open_count;
  357. kref_put(&hp->kref, destroy_hvc_struct);
  358. }
  359. }
  360. /*
  361. * Push buffered characters whether they were just recently buffered or waiting
  362. * on a blocked hypervisor. Call this function with hp->lock held.
  363. */
  364. static int hvc_push(struct hvc_struct *hp)
  365. {
  366. int n;
  367. n = hp->ops->put_chars(hp->vtermno, hp->outbuf, hp->n_outbuf);
  368. if (n <= 0) {
  369. if (n == 0) {
  370. hp->do_wakeup = 1;
  371. return 0;
  372. }
  373. /* throw away output on error; this happens when
  374. there is no session connected to the vterm. */
  375. hp->n_outbuf = 0;
  376. } else
  377. hp->n_outbuf -= n;
  378. if (hp->n_outbuf > 0)
  379. memmove(hp->outbuf, hp->outbuf + n, hp->n_outbuf);
  380. else
  381. hp->do_wakeup = 1;
  382. return n;
  383. }
  384. static int hvc_write(struct tty_struct *tty, const unsigned char *buf, int count)
  385. {
  386. struct hvc_struct *hp = tty->driver_data;
  387. unsigned long flags;
  388. int rsize, written = 0;
  389. /* This write was probably executed during a tty close. */
  390. if (!hp)
  391. return -EPIPE;
  392. if (hp->count <= 0)
  393. return -EIO;
  394. spin_lock_irqsave(&hp->lock, flags);
  395. /* Push pending writes */
  396. if (hp->n_outbuf > 0)
  397. hvc_push(hp);
  398. while (count > 0 && (rsize = hp->outbuf_size - hp->n_outbuf) > 0) {
  399. if (rsize > count)
  400. rsize = count;
  401. memcpy(hp->outbuf + hp->n_outbuf, buf, rsize);
  402. count -= rsize;
  403. buf += rsize;
  404. hp->n_outbuf += rsize;
  405. written += rsize;
  406. hvc_push(hp);
  407. }
  408. spin_unlock_irqrestore(&hp->lock, flags);
  409. /*
  410. * Racy, but harmless, kick thread if there is still pending data.
  411. */
  412. if (hp->n_outbuf)
  413. hvc_kick();
  414. return written;
  415. }
  416. /**
  417. * hvc_set_winsz() - Resize the hvc tty terminal window.
  418. * @work: work structure.
  419. *
  420. * The routine shall not be called within an atomic context because it
  421. * might sleep.
  422. *
  423. * Locking: hp->lock
  424. */
  425. static void hvc_set_winsz(struct work_struct *work)
  426. {
  427. struct hvc_struct *hp;
  428. unsigned long hvc_flags;
  429. struct tty_struct *tty;
  430. struct winsize ws;
  431. hp = container_of(work, struct hvc_struct, tty_resize);
  432. if (!hp)
  433. return;
  434. spin_lock_irqsave(&hp->lock, hvc_flags);
  435. if (!hp->tty) {
  436. spin_unlock_irqrestore(&hp->lock, hvc_flags);
  437. return;
  438. }
  439. ws = hp->ws;
  440. tty = tty_kref_get(hp->tty);
  441. spin_unlock_irqrestore(&hp->lock, hvc_flags);
  442. tty_do_resize(tty, &ws);
  443. tty_kref_put(tty);
  444. }
  445. /*
  446. * This is actually a contract between the driver and the tty layer outlining
  447. * how much write room the driver can guarantee will be sent OR BUFFERED. This
  448. * driver MUST honor the return value.
  449. */
  450. static int hvc_write_room(struct tty_struct *tty)
  451. {
  452. struct hvc_struct *hp = tty->driver_data;
  453. if (!hp)
  454. return -1;
  455. return hp->outbuf_size - hp->n_outbuf;
  456. }
  457. static int hvc_chars_in_buffer(struct tty_struct *tty)
  458. {
  459. struct hvc_struct *hp = tty->driver_data;
  460. if (!hp)
  461. return 0;
  462. return hp->n_outbuf;
  463. }
  464. /*
  465. * timeout will vary between the MIN and MAX values defined here. By default
  466. * and during console activity we will use a default MIN_TIMEOUT of 10. When
  467. * the console is idle, we increase the timeout value on each pass through
  468. * msleep until we reach the max. This may be noticeable as a brief (average
  469. * one second) delay on the console before the console responds to input when
  470. * there has been no input for some time.
  471. */
  472. #define MIN_TIMEOUT (10)
  473. #define MAX_TIMEOUT (2000)
  474. static u32 timeout = MIN_TIMEOUT;
  475. #define HVC_POLL_READ 0x00000001
  476. #define HVC_POLL_WRITE 0x00000002
  477. int hvc_poll(struct hvc_struct *hp)
  478. {
  479. struct tty_struct *tty;
  480. int i, n, poll_mask = 0;
  481. char buf[N_INBUF] __ALIGNED__;
  482. unsigned long flags;
  483. int read_total = 0;
  484. int written_total = 0;
  485. spin_lock_irqsave(&hp->lock, flags);
  486. /* Push pending writes */
  487. if (hp->n_outbuf > 0)
  488. written_total = hvc_push(hp);
  489. /* Reschedule us if still some write pending */
  490. if (hp->n_outbuf > 0) {
  491. poll_mask |= HVC_POLL_WRITE;
  492. /* If hvc_push() was not able to write, sleep a few msecs */
  493. timeout = (written_total) ? 0 : MIN_TIMEOUT;
  494. }
  495. /* No tty attached, just skip */
  496. tty = hp->tty;
  497. if (tty == NULL)
  498. goto bail;
  499. /* Now check if we can get data (are we throttled ?) */
  500. if (test_bit(TTY_THROTTLED, &tty->flags))
  501. goto throttled;
  502. /* If we aren't notifier driven and aren't throttled, we always
  503. * request a reschedule
  504. */
  505. if (!hp->irq_requested)
  506. poll_mask |= HVC_POLL_READ;
  507. /* Read data if any */
  508. for (;;) {
  509. int count = tty_buffer_request_room(tty, N_INBUF);
  510. /* If flip is full, just reschedule a later read */
  511. if (count == 0) {
  512. poll_mask |= HVC_POLL_READ;
  513. break;
  514. }
  515. n = hp->ops->get_chars(hp->vtermno, buf, count);
  516. if (n <= 0) {
  517. /* Hangup the tty when disconnected from host */
  518. if (n == -EPIPE) {
  519. spin_unlock_irqrestore(&hp->lock, flags);
  520. tty_hangup(tty);
  521. spin_lock_irqsave(&hp->lock, flags);
  522. } else if ( n == -EAGAIN ) {
  523. /*
  524. * Some back-ends can only ensure a certain min
  525. * num of bytes read, which may be > 'count'.
  526. * Let the tty clear the flip buff to make room.
  527. */
  528. poll_mask |= HVC_POLL_READ;
  529. }
  530. break;
  531. }
  532. for (i = 0; i < n; ++i) {
  533. #ifdef CONFIG_MAGIC_SYSRQ
  534. if (hp->index == hvc_con_driver.index) {
  535. /* Handle the SysRq Hack */
  536. /* XXX should support a sequence */
  537. if (buf[i] == '\x0f') { /* ^O */
  538. /* if ^O is pressed again, reset
  539. * sysrq_pressed and flip ^O char */
  540. sysrq_pressed = !sysrq_pressed;
  541. if (sysrq_pressed)
  542. continue;
  543. } else if (sysrq_pressed) {
  544. handle_sysrq(buf[i], tty);
  545. sysrq_pressed = 0;
  546. continue;
  547. }
  548. }
  549. #endif /* CONFIG_MAGIC_SYSRQ */
  550. tty_insert_flip_char(tty, buf[i], 0);
  551. }
  552. read_total += n;
  553. }
  554. throttled:
  555. /* Wakeup write queue if necessary */
  556. if (hp->do_wakeup) {
  557. hp->do_wakeup = 0;
  558. tty_wakeup(tty);
  559. }
  560. bail:
  561. spin_unlock_irqrestore(&hp->lock, flags);
  562. if (read_total) {
  563. /* Activity is occurring, so reset the polling backoff value to
  564. a minimum for performance. */
  565. timeout = MIN_TIMEOUT;
  566. tty_flip_buffer_push(tty);
  567. }
  568. return poll_mask;
  569. }
  570. EXPORT_SYMBOL_GPL(hvc_poll);
  571. /**
  572. * hvc_resize() - Update terminal window size information.
  573. * @hp: HVC console pointer
  574. * @ws: Terminal window size structure
  575. *
  576. * Stores the specified window size information in the hvc structure of @hp.
  577. * The function schedule the tty resize update.
  578. *
  579. * Locking: Locking free; the function MUST be called holding hp->lock
  580. */
  581. void hvc_resize(struct hvc_struct *hp, struct winsize ws)
  582. {
  583. hp->ws = ws;
  584. schedule_work(&hp->tty_resize);
  585. }
  586. EXPORT_SYMBOL_GPL(hvc_resize);
  587. /*
  588. * This kthread is either polling or interrupt driven. This is determined by
  589. * calling hvc_poll() who determines whether a console adapter support
  590. * interrupts.
  591. */
  592. static int khvcd(void *unused)
  593. {
  594. int poll_mask;
  595. struct hvc_struct *hp;
  596. set_freezable();
  597. __set_current_state(TASK_RUNNING);
  598. do {
  599. poll_mask = 0;
  600. hvc_kicked = 0;
  601. try_to_freeze();
  602. wmb();
  603. if (!cpus_are_in_xmon()) {
  604. spin_lock(&hvc_structs_lock);
  605. list_for_each_entry(hp, &hvc_structs, next) {
  606. poll_mask |= hvc_poll(hp);
  607. }
  608. spin_unlock(&hvc_structs_lock);
  609. } else
  610. poll_mask |= HVC_POLL_READ;
  611. if (hvc_kicked)
  612. continue;
  613. set_current_state(TASK_INTERRUPTIBLE);
  614. if (!hvc_kicked) {
  615. if (poll_mask == 0)
  616. schedule();
  617. else {
  618. if (timeout < MAX_TIMEOUT)
  619. timeout += (timeout >> 6) + 1;
  620. msleep_interruptible(timeout);
  621. }
  622. }
  623. __set_current_state(TASK_RUNNING);
  624. } while (!kthread_should_stop());
  625. return 0;
  626. }
  627. static const struct tty_operations hvc_ops = {
  628. .open = hvc_open,
  629. .close = hvc_close,
  630. .write = hvc_write,
  631. .hangup = hvc_hangup,
  632. .unthrottle = hvc_unthrottle,
  633. .write_room = hvc_write_room,
  634. .chars_in_buffer = hvc_chars_in_buffer,
  635. };
  636. struct hvc_struct __devinit *hvc_alloc(uint32_t vtermno, int data,
  637. struct hv_ops *ops, int outbuf_size)
  638. {
  639. struct hvc_struct *hp;
  640. int i;
  641. /* We wait until a driver actually comes along */
  642. if (!hvc_driver) {
  643. int err = hvc_init();
  644. if (err)
  645. return ERR_PTR(err);
  646. }
  647. hp = kzalloc(ALIGN(sizeof(*hp), sizeof(long)) + outbuf_size,
  648. GFP_KERNEL);
  649. if (!hp)
  650. return ERR_PTR(-ENOMEM);
  651. hp->vtermno = vtermno;
  652. hp->data = data;
  653. hp->ops = ops;
  654. hp->outbuf_size = outbuf_size;
  655. hp->outbuf = &((char *)hp)[ALIGN(sizeof(*hp), sizeof(long))];
  656. kref_init(&hp->kref);
  657. INIT_WORK(&hp->tty_resize, hvc_set_winsz);
  658. spin_lock_init(&hp->lock);
  659. spin_lock(&hvc_structs_lock);
  660. /*
  661. * find index to use:
  662. * see if this vterm id matches one registered for console.
  663. */
  664. for (i=0; i < MAX_NR_HVC_CONSOLES; i++)
  665. if (vtermnos[i] == hp->vtermno &&
  666. cons_ops[i] == hp->ops)
  667. break;
  668. /* no matching slot, just use a counter */
  669. if (i >= MAX_NR_HVC_CONSOLES)
  670. i = ++last_hvc;
  671. hp->index = i;
  672. list_add_tail(&(hp->next), &hvc_structs);
  673. spin_unlock(&hvc_structs_lock);
  674. return hp;
  675. }
  676. EXPORT_SYMBOL_GPL(hvc_alloc);
  677. int hvc_remove(struct hvc_struct *hp)
  678. {
  679. unsigned long flags;
  680. struct tty_struct *tty;
  681. spin_lock_irqsave(&hp->lock, flags);
  682. tty = hp->tty;
  683. if (hp->index < MAX_NR_HVC_CONSOLES)
  684. vtermnos[hp->index] = -1;
  685. /* Don't whack hp->irq because tty_hangup() will need to free the irq. */
  686. spin_unlock_irqrestore(&hp->lock, flags);
  687. /*
  688. * We 'put' the instance that was grabbed when the kref instance
  689. * was initialized using kref_init(). Let the last holder of this
  690. * kref cause it to be removed, which will probably be the tty_hangup
  691. * below.
  692. */
  693. kref_put(&hp->kref, destroy_hvc_struct);
  694. /*
  695. * This function call will auto chain call hvc_hangup. The tty should
  696. * always be valid at this time unless a simultaneous tty close already
  697. * cleaned up the hvc_struct.
  698. */
  699. if (tty)
  700. tty_hangup(tty);
  701. return 0;
  702. }
  703. /* Driver initialization: called as soon as someone uses hvc_alloc(). */
  704. static int hvc_init(void)
  705. {
  706. struct tty_driver *drv;
  707. int err;
  708. /* We need more than hvc_count adapters due to hotplug additions. */
  709. drv = alloc_tty_driver(HVC_ALLOC_TTY_ADAPTERS);
  710. if (!drv) {
  711. err = -ENOMEM;
  712. goto out;
  713. }
  714. drv->owner = THIS_MODULE;
  715. drv->driver_name = "hvc";
  716. drv->name = "hvc";
  717. drv->major = HVC_MAJOR;
  718. drv->minor_start = HVC_MINOR;
  719. drv->type = TTY_DRIVER_TYPE_SYSTEM;
  720. drv->init_termios = tty_std_termios;
  721. drv->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_RESET_TERMIOS;
  722. tty_set_operations(drv, &hvc_ops);
  723. /* Always start the kthread because there can be hotplug vty adapters
  724. * added later. */
  725. hvc_task = kthread_run(khvcd, NULL, "khvcd");
  726. if (IS_ERR(hvc_task)) {
  727. printk(KERN_ERR "Couldn't create kthread for console.\n");
  728. err = PTR_ERR(hvc_task);
  729. goto put_tty;
  730. }
  731. err = tty_register_driver(drv);
  732. if (err) {
  733. printk(KERN_ERR "Couldn't register hvc console driver\n");
  734. goto stop_thread;
  735. }
  736. /*
  737. * Make sure tty is fully registered before allowing it to be
  738. * found by hvc_console_device.
  739. */
  740. smp_mb();
  741. hvc_driver = drv;
  742. return 0;
  743. stop_thread:
  744. kthread_stop(hvc_task);
  745. hvc_task = NULL;
  746. put_tty:
  747. put_tty_driver(drv);
  748. out:
  749. return err;
  750. }
  751. /* This isn't particularly necessary due to this being a console driver
  752. * but it is nice to be thorough.
  753. */
  754. static void __exit hvc_exit(void)
  755. {
  756. if (hvc_driver) {
  757. kthread_stop(hvc_task);
  758. tty_unregister_driver(hvc_driver);
  759. /* return tty_struct instances allocated in hvc_init(). */
  760. put_tty_driver(hvc_driver);
  761. unregister_console(&hvc_con_driver);
  762. }
  763. }
  764. module_exit(hvc_exit);