Subversion Repositories HelenOS

Rev

Rev 3022 | Rev 4201 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2003 Josef Cejka
  3.  * Copyright (c) 2005 Jakub Jermar
  4.  * All rights reserved.
  5.  *
  6.  * Redistribution and use in source and binary forms, with or without
  7.  * modification, are permitted provided that the following conditions
  8.  * are met:
  9.  *
  10.  * - Redistributions of source code must retain the above copyright
  11.  *   notice, this list of conditions and the following disclaimer.
  12.  * - Redistributions in binary form must reproduce the above copyright
  13.  *   notice, this list of conditions and the following disclaimer in the
  14.  *   documentation and/or other materials provided with the distribution.
  15.  * - The name of the author may not be used to endorse or promote products
  16.  *   derived from this software without specific prior written permission.
  17.  *
  18.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  19.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  20.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  21.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  22.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  23.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  24.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  25.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  26.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  27.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28.  */
  29.  
  30. /** @addtogroup genericconsole
  31.  * @{
  32.  */
  33. /** @file
  34.  */
  35.  
  36. #include <console/console.h>
  37. #include <console/chardev.h>
  38. #include <sysinfo/sysinfo.h>
  39. #include <synch/waitq.h>
  40. #include <synch/spinlock.h>
  41. #include <arch/types.h>
  42. #include <ddi/device.h>
  43. #include <ddi/irq.h>
  44. #include <ddi/ddi.h>
  45. #include <ipc/irq.h>
  46. #include <arch.h>
  47. #include <func.h>
  48. #include <print.h>
  49. #include <atomic.h>
  50.  
  51. #define KLOG_SIZE PAGE_SIZE
  52. #define KLOG_LATENCY 8
  53.  
  54. /** Kernel log cyclic buffer */
  55. static char klog[KLOG_SIZE] __attribute__ ((aligned (PAGE_SIZE)));
  56.  
  57. /** Kernel log initialized */
  58. static bool klog_inited = false;
  59. /** First kernel log characters */
  60. static index_t klog_start = 0;
  61. /** Number of valid kernel log characters */
  62. static size_t klog_len = 0;
  63. /** Number of stored (not printed) kernel log characters */
  64. static size_t klog_stored = 0;
  65. /** Number of stored kernel log characters for uspace */
  66. static size_t klog_uspace = 0;
  67.  
  68. /** Silence output */
  69. bool silent = false;
  70.  
  71. /** Kernel log spinlock */
  72. SPINLOCK_INITIALIZE(klog_lock);
  73.  
  74. /** Physical memory area used for klog buffer */
  75. static parea_t klog_parea;
  76.  
  77. /*
  78.  * For now, we use 0 as INR.
  79.  * However, it is therefore desirable to have architecture specific
  80.  * definition of KLOG_VIRT_INR in the future.
  81.  */
  82. #define KLOG_VIRT_INR   0
  83.  
  84. static irq_t klog_irq;
  85.  
  86. static chardev_operations_t null_stdout_ops = {
  87.     .suspend = NULL,
  88.     .resume = NULL,
  89.     .write = NULL,
  90.     .read = NULL
  91. };
  92.  
  93. chardev_t null_stdout = {
  94.     .name = "null",
  95.     .op = &null_stdout_ops
  96. };
  97.  
  98. /** Allways refuse IRQ ownership.
  99.  *
  100.  * This is not a real IRQ, so we always decline.
  101.  *
  102.  * @return Always returns IRQ_DECLINE.
  103.  */
  104. static irq_ownership_t klog_claim(irq_t *irq)
  105. {
  106.     return IRQ_DECLINE;
  107. }
  108.  
  109. static void stdin_suspend(chardev_t *d)
  110. {
  111. }
  112.  
  113. static void stdin_resume(chardev_t *d)
  114. {
  115. }
  116.  
  117. static chardev_operations_t stdin_ops = {
  118.     .suspend = stdin_suspend,
  119.     .resume = stdin_resume,
  120. };
  121.  
  122. /** Standard input character device */
  123. static chardev_t _stdin;
  124. chardev_t *stdin = NULL;
  125. chardev_t *stdout = &null_stdout;
  126.  
  127. void console_init(void)
  128. {
  129.     chardev_initialize("stdin", &_stdin, &stdin_ops);
  130.     stdin = &_stdin;
  131. }
  132.  
  133. /** Initialize kernel logging facility
  134.  *
  135.  * The shared area contains kernel cyclic buffer. Userspace application may
  136.  * be notified on new data with indication of position and size
  137.  * of the data within the circular buffer.
  138.  */
  139. void klog_init(void)
  140. {
  141.     void *faddr = (void *) KA2PA(klog);
  142.    
  143.     ASSERT((uintptr_t) faddr % FRAME_SIZE == 0);
  144.     ASSERT(KLOG_SIZE % FRAME_SIZE == 0);
  145.  
  146.     devno_t devno = device_assign_devno();
  147.    
  148.     klog_parea.pbase = (uintptr_t) faddr;
  149.     klog_parea.frames = SIZE2FRAMES(KLOG_SIZE);
  150.     ddi_parea_register(&klog_parea);
  151.  
  152.     sysinfo_set_item_val("klog.faddr", NULL, (unative_t) faddr);
  153.     sysinfo_set_item_val("klog.pages", NULL, SIZE2FRAMES(KLOG_SIZE));
  154.     sysinfo_set_item_val("klog.devno", NULL, devno);
  155.     sysinfo_set_item_val("klog.inr", NULL, KLOG_VIRT_INR);
  156.  
  157.     irq_initialize(&klog_irq);
  158.     klog_irq.devno = devno;
  159.     klog_irq.inr = KLOG_VIRT_INR;
  160.     klog_irq.claim = klog_claim;
  161.     irq_register(&klog_irq);
  162.    
  163.     spinlock_lock(&klog_lock);
  164.     klog_inited = true;
  165.     spinlock_unlock(&klog_lock);
  166. }
  167.  
  168. void grab_console(void)
  169. {
  170.     silent = false;
  171.     arch_grab_console();
  172. }
  173.  
  174. void release_console(void)
  175. {
  176.     silent = true;
  177.     arch_release_console();
  178. }
  179.  
  180. /** Get character from character device. Do not echo character.
  181.  *
  182.  * @param chardev Character device.
  183.  *
  184.  * @return Character read.
  185.  */
  186. uint8_t _getc(chardev_t *chardev)
  187. {
  188.     uint8_t ch;
  189.     ipl_t ipl;
  190.  
  191.     if (atomic_get(&haltstate)) {
  192.         /* If we are here, we are hopefully on the processor, that
  193.          * issued the 'halt' command, so proceed to read the character
  194.          * directly from input
  195.          */
  196.         if (chardev->op->read)
  197.             return chardev->op->read(chardev);
  198.         /* no other way of interacting with user, halt */
  199.         if (CPU)
  200.             printf("cpu%u: ", CPU->id);
  201.         else
  202.             printf("cpu: ");
  203.         printf("halted (no kconsole)\n");
  204.         cpu_halt();
  205.     }
  206.  
  207.     waitq_sleep(&chardev->wq);
  208.     ipl = interrupts_disable();
  209.     spinlock_lock(&chardev->lock);
  210.     ch = chardev->buffer[(chardev->index - chardev->counter) % CHARDEV_BUFLEN];
  211.     chardev->counter--;
  212.     spinlock_unlock(&chardev->lock);
  213.     interrupts_restore(ipl);
  214.  
  215.     chardev->op->resume(chardev);
  216.  
  217.     return ch;
  218. }
  219.  
  220. /** Get string from character device.
  221.  *
  222.  * Read characters from character device until first occurrence
  223.  * of newline character.
  224.  *
  225.  * @param chardev Character device.
  226.  * @param buf Buffer where to store string terminated by '\0'.
  227.  * @param buflen Size of the buffer.
  228.  *
  229.  * @return Number of characters read.
  230.  */
  231. count_t gets(chardev_t *chardev, char *buf, size_t buflen)
  232. {
  233.     index_t index = 0;
  234.     char ch;
  235.    
  236.     while (index < buflen) {
  237.         ch = _getc(chardev);
  238.         if (ch == '\b') {
  239.             if (index > 0) {
  240.                 index--;
  241.                 /* Space backspace, space */
  242.                 putchar('\b');
  243.                 putchar(' ');
  244.                 putchar('\b');
  245.             }
  246.             continue;
  247.         }
  248.         putchar(ch);
  249.        
  250.         if (ch == '\n') { /* end of string => write 0, return */
  251.             buf[index] = '\0';
  252.             return (count_t) index;
  253.         }
  254.         buf[index++] = ch;
  255.     }
  256.     return (count_t) index;
  257. }
  258.  
  259. /** Get character from device & echo it to screen */
  260. uint8_t getc(chardev_t *chardev)
  261. {
  262.     uint8_t ch;
  263.  
  264.     ch = _getc(chardev);
  265.     putchar(ch);
  266.     return ch;
  267. }
  268.  
  269. void klog_update(void)
  270. {
  271.     spinlock_lock(&klog_lock);
  272.    
  273.     if ((klog_inited) && (klog_irq.notif_cfg.notify) && (klog_uspace > 0)) {
  274.         ipc_irq_send_msg_3(&klog_irq, klog_start, klog_len, klog_uspace);
  275.         klog_uspace = 0;
  276.     }
  277.    
  278.     spinlock_unlock(&klog_lock);
  279. }
  280.  
  281. void putchar(char c)
  282. {
  283.     spinlock_lock(&klog_lock);
  284.    
  285.     if ((klog_stored > 0) && (stdout->op->write)) {
  286.         /* Print charaters stored in kernel log */
  287.         index_t i;
  288.         for (i = klog_len - klog_stored; i < klog_len; i++)
  289.             stdout->op->write(stdout, klog[(klog_start + i) % KLOG_SIZE], silent);
  290.         klog_stored = 0;
  291.     }
  292.    
  293.     /* Store character in the cyclic kernel log */
  294.     klog[(klog_start + klog_len) % KLOG_SIZE] = c;
  295.     if (klog_len < KLOG_SIZE)
  296.         klog_len++;
  297.     else
  298.         klog_start = (klog_start + 1) % KLOG_SIZE;
  299.    
  300.     if (stdout->op->write)
  301.         stdout->op->write(stdout, c, silent);
  302.     else {
  303.         /* The character is just in the kernel log */
  304.         if (klog_stored < klog_len)
  305.             klog_stored++;
  306.     }
  307.    
  308.     /* The character is stored for uspace */
  309.     if (klog_uspace < klog_len)
  310.         klog_uspace++;
  311.    
  312.     /* Check notify uspace to update */
  313.     bool update;
  314.     if ((klog_uspace > KLOG_LATENCY) || (c == '\n'))
  315.         update = true;
  316.     else
  317.         update = false;
  318.    
  319.     spinlock_unlock(&klog_lock);
  320.    
  321.     if (update)
  322.         klog_update();
  323. }
  324.  
  325. /** @}
  326.  */
  327.