WebSVN – HelenOS – Diff – /branches/tracing/kernel/arch/sparc64/src/drivers/sgcn.c

 /** @addtogroup sparc64
  * @{
  */
 /**
  * @file
- * @brief   SGCN driver.
+ * @brief SGCN driver.
  */
+#include <arch.h>
 #include <arch/drivers/sgcn.h>
 #include <arch/drivers/kbd.h>
 #include <genarch/ofw/ofw_tree.h>
 #include <debug.h>
-#include <func.h>
+#include <string.h>
 #include <print.h>
 #include <mm/page.h>
-#include <ipc/irq.h>
+#include <proc/thread.h>
-#include <ddi/ddi.h>
-#include <ddi/device.h>
 #include <console/chardev.h>
 #include <console/console.h>
-#include <ddi/device.h>
 #include <sysinfo/sysinfo.h>
 #include <synch/spinlock.h>
+#define POLL_INTERVAL       10000
 /*
  * Physical address at which the SBBC starts. This value has been obtained
  * by inspecting (using Simics) memory accesses made by OBP. It is valid
  * for the Simics-simulated Serengeti machine. The author of this code is
  * not sure whether this value is valid generally.
  * Key into the SRAM table of contents which identifies the entry
  * describing the OBP console buffer. It is worth mentioning
  * that the OBP console buffer is not the only console buffer
  * which can be used. It is, however, used because when the kernel
  * is running, the OBP buffer is not used by OBP any more but OBP
- * has already made neccessary arangements so that the output will
+ * has already made necessary arrangements so that the output will
  * be read from the OBP buffer and input will go to the OBP buffer.
  * Therefore HelenOS needs to make no such arrangements any more.
  */
 #define CONSOLE_KEY     "OBPCONS"
 /* magic string contained at the beginning of the console buffer */
 #define SGCN_BUFFER_MAGIC   "CON"
-/**
- * The driver is polling based, but in order to notify the userspace
- * of a key being pressed, we need to supply the interface with some
- * interrupt number. The interrupt number can be arbitrary as it it
- * will never be used for identifying HW interrupts, but only in
- * notifying the userspace.
- */
-#define FICTIONAL_INR       1
 /*
  * Returns a pointer to the object of a given type which is placed at the given
  * offset from the SRAM beginning.
  */
 #define SRAM(type, offset)  ((type *) (sram_begin + (offset)))
 /*
  * Returns a pointer to the object of a given type which is placed at the given
  * offset from the console buffer beginning.
  */
 #define SGCN_BUFFER(type, offset) \
-                ((type *) (sgcn_buffer_begin + (offset)))
+    ((type *) (sgcn_buffer_begin + (offset)))
 /** Returns a pointer to the console buffer header. */
 #define SGCN_BUFFER_HEADER  (SGCN_BUFFER(sgcn_buffer_header_t, 0))
-/** defined in drivers/kbd.c */
-extern kbd_type_t kbd_type;
 /** starting address of SRAM, will be set by the init_sram_begin function */
 static uintptr_t sram_begin;
 /**
  * starting address of the SGCN buffer, will be set by the
  * init_sgcn_buffer_begin function
  */
 static uintptr_t sgcn_buffer_begin;
-/**
- * SGCN IRQ structure. So far used only for notifying the userspace of the
+/* true iff the kernel driver should ignore pressed keys */
- * key being pressed, not for kernel being informed about keyboard interrupts.
- */
-static irq_t sgcn_irq;
+static bool kbd_disabled;
-// TODO think of a way how to synchronize accesses to SGCN buffer between the kernel and the userspace
 /*
  * Ensures that writing to the buffer and consequent update of the write pointer
  * are together one atomic operation.
  */
  */
 SPINLOCK_INITIALIZE(sgcn_input_lock);
 /* functions referenced from definitions of I/O operations structures */
-static void sgcn_noop(chardev_t *);
-static void sgcn_putchar(chardev_t *, const char);
+static void sgcn_putchar(outdev_t *, const wchar_t, bool);
-static char sgcn_key_read(chardev_t *);
-/** character device operations */
+/** SGCN output device operations */
-static chardev_operations_t sgcn_ops = {
+static outdev_operations_t sgcnout_ops = {
-    .suspend = sgcn_noop,
-    .resume = sgcn_noop,
-    .read = sgcn_key_read,
     .write = sgcn_putchar
 };
-/** SGCN character device */
+static outdev_t sgcnout;    /**< SGCN output device. */
-chardev_t sgcn_io;
 /**
- * Registers the physical area of the SRAM so that the userspace SGCN
+ * Set some sysinfo values (SRAM address and SRAM size).
- * driver can map it. Moreover, it sets some sysinfo values (SRAM address
- * and SRAM size).
  */
-static void register_sram_parea(uintptr_t sram_begin_physical)
+static void register_sram(uintptr_t sram_begin_physical)
 {
-    static parea_t sram_parea;
-    sram_parea.pbase = sram_begin_physical;
-    sram_parea.vbase = (uintptr_t) sram_begin;
-    sram_parea.frames = MAPPED_AREA_SIZE / FRAME_SIZE;
-    sram_parea.cacheable = false;
-    ddi_parea_register(&sram_parea);
     sysinfo_set_item_val("sram.area.size", NULL, MAPPED_AREA_SIZE);
     sysinfo_set_item_val("sram.address.physical", NULL,
         sram_begin_physical);
+}
 /**
  * Initializes the starting address of SRAM.
+ *
  * The SRAM starts 0x900000 + C bytes behind the SBBC start in the
  * physical memory, where C is the value read from the "iosram-toc"
  * property of the "/chosen" OBP node. The sram_begin variable will
  * be set to the virtual address which maps to the SRAM physical
  * address.
- *
- * It also registers the physical area of SRAM and sets some sysinfo
- * values (SRAM address and SRAM size).
  */
 static void init_sram_begin(void)
+{
     ofw_tree_node_t *chosen;
     ofw_tree_property_t *iosram_toc;
     uintptr_t sram_begin_physical;
     chosen = ofw_tree_lookup("/chosen");
     if (!chosen)
-        panic("Can't find /chosen.\n");
+        panic("Cannot find '/chosen'.");
     iosram_toc = ofw_tree_getprop(chosen, "iosram-toc");
     if (!iosram_toc)
-        panic("Can't find property \"iosram-toc\".\n");
+        panic("Cannot find property 'iosram-toc'.");
     if (!iosram_toc->value)
-        panic("Can't find SRAM TOC.\n");
+        panic("Cannot find SRAM TOC.");
     sram_begin_physical = SBBC_START + SBBC_SRAM_OFFSET
         + *((uint32_t *) iosram_toc->value);
     sram_begin = hw_map(sram_begin_physical, MAPPED_AREA_SIZE);
-    register_sram_parea(sram_begin_physical);
+    register_sram(sram_begin_physical);
+}
 /**
  * Initializes the starting address of the SGCN buffer.
+ *
  * This function also writes the offset of the SGCN buffer within SRAM
  * under the sram.buffer.offset sysinfo key.
  */
 static void sgcn_buffer_begin_init(void)
+{
+    static bool initialized;
+    if (initialized)
+        return;
     init_sram_begin();
-    ASSERT(strcmp(SRAM_TOC->magic, SRAM_TOC_MAGIC) == 0);
+    ASSERT(str_cmp(SRAM_TOC->magic, SRAM_TOC_MAGIC) == 0);
     /* lookup TOC entry with the correct key */
     uint32_t i;
     for (i = 0; i < MAX_TOC_ENTRIES; i++) {
-        if (strcmp(SRAM_TOC->keys[i].key, CONSOLE_KEY) == 0)
+        if (str_cmp(SRAM_TOC->keys[i].key, CONSOLE_KEY) == 0)
             break;
+    }
     ASSERT(i < MAX_TOC_ENTRIES);
     sgcn_buffer_begin = sram_begin + SRAM_TOC->keys[i].offset;
     sysinfo_set_item_val("sram.buffer.offset", NULL,
         SRAM_TOC->keys[i].offset);
-}
-/**
- * Default suspend/resume operation for the input device.
- */
-static void sgcn_noop(chardev_t *d)
+    initialized = true;
-{
+}
 /**
  * Writes a single character to the SGCN (circular) output buffer
  * and updates the output write pointer so that SGCN gets to know
     uint32_t end = SGCN_BUFFER_HEADER->out_end;
     uint32_t size = end - begin;
     /* we need pointers to volatile variables */
     volatile char *buf_ptr = (volatile char *)
         SGCN_BUFFER(char, SGCN_BUFFER_HEADER->out_wrptr);
     volatile uint32_t *out_wrptr_ptr = &(SGCN_BUFFER_HEADER->out_wrptr);
     volatile uint32_t *out_rdptr_ptr = &(SGCN_BUFFER_HEADER->out_rdptr);
     /*
      * Write the character and increment the write pointer modulo the
     *buf_ptr = c;
     *out_wrptr_ptr = new_wrptr;
+}
 /**
- * SGCN output operation. Prints a single character to the SGCN. If the line
+ * SGCN output operation. Prints a single character to the SGCN. Newline
- * feed character is written ('\n'), the carriage return character ('\r') is
- * written straight away.
+ * character is converted to CRLF.
  */
-static void sgcn_putchar(struct chardev * cd, const char c)
+static void sgcn_putchar(outdev_t *od, const wchar_t ch, bool silent)
+{
+    if (!silent) {
-    spinlock_lock(&sgcn_output_lock);
+        spinlock_lock(&sgcn_output_lock);
-    sgcn_do_putchar(c);
+        if (ascii_check(ch)) {
-    if (c == '\n') {
+            if (ch == '\n')
-        sgcn_do_putchar('\r');
+                sgcn_do_putchar('\r');
+            sgcn_do_putchar(ch);
+        } else
+            sgcn_do_putchar(U_SPECIAL);
+        spinlock_unlock(&sgcn_output_lock);
+    }
-    spinlock_unlock(&sgcn_output_lock);
-}
-/**
- * Called when actively reading the character. Not implemented yet.
- */
-static char sgcn_key_read(chardev_t *d)
-{
-    return (char) 0;
-}
-/**
- * The driver works in polled mode, so no interrupt should be handled by it.
- */
-static irq_ownership_t sgcn_claim(void)
-{
-    return IRQ_DECLINE;
-}
-/**
- * The driver works in polled mode, so no interrupt should be handled by it.
- */
-static void sgcn_irq_handler(irq_t *irq, void *arg, ...)
-{
-    panic("Not yet implemented, SGCN works in polled mode.\n");
+}
 /**
  * Grabs the input for kernel.
  */
 void sgcn_grab(void)
+{
-    ipl_t ipl = interrupts_disable();
-    volatile uint32_t *in_wrptr_ptr = &(SGCN_BUFFER_HEADER->in_wrptr);
-    volatile uint32_t *in_rdptr_ptr = &(SGCN_BUFFER_HEADER->in_rdptr);
-    /* skip all the user typed before the grab and hasn't been processed */
-    spinlock_lock(&sgcn_input_lock);
-    *in_rdptr_ptr = *in_wrptr_ptr;
-    spinlock_unlock(&sgcn_input_lock);
-    spinlock_lock(&sgcn_irq.lock);
-    sgcn_irq.notif_cfg.notify = false;
+    kbd_disabled = false;
-    spinlock_unlock(&sgcn_irq.lock);
-    interrupts_restore(ipl);
+}
 /**
  * Releases the input so that userspace can use it.
  */
 void sgcn_release(void)
+{
-    ipl_t ipl = interrupts_disable();
-    spinlock_lock(&sgcn_irq.lock);
-    if (sgcn_irq.notif_cfg.answerbox)
-        sgcn_irq.notif_cfg.notify = true;
+    kbd_disabled = true;
-    spinlock_unlock(&sgcn_irq.lock);
-    interrupts_restore(ipl);
+}
 /**
  * Function regularly called by the keyboard polling thread. Finds out whether
  * there are some unread characters in the input queue. If so, it picks them up
  * and sends them to the upper layers of HelenOS.
  */
-void sgcn_poll(void)
+static void sgcn_poll(sgcn_instance_t *instance)
+{
     uint32_t begin = SGCN_BUFFER_HEADER->in_begin;
     uint32_t end = SGCN_BUFFER_HEADER->in_end;
     uint32_t size = end - begin;
+    if (kbd_disabled)
+        return;
     spinlock_lock(&sgcn_input_lock);
-    ipl_t ipl = interrupts_disable();
-    spinlock_lock(&sgcn_irq.lock);
     /* we need pointers to volatile variables */
     volatile char *buf_ptr = (volatile char *)
         SGCN_BUFFER(char, SGCN_BUFFER_HEADER->in_rdptr);
     volatile uint32_t *in_wrptr_ptr = &(SGCN_BUFFER_HEADER->in_wrptr);
     volatile uint32_t *in_rdptr_ptr = &(SGCN_BUFFER_HEADER->in_rdptr);
-    if (*in_rdptr_ptr != *in_wrptr_ptr) {
-        if (sgcn_irq.notif_cfg.notify && sgcn_irq.notif_cfg.answerbox) {
-            ipc_irq_send_notif(&sgcn_irq);
-            spinlock_unlock(&sgcn_irq.lock);
-            interrupts_restore(ipl);
-            spinlock_unlock(&sgcn_input_lock);
-            return;
-        }
-    }
-    spinlock_unlock(&sgcn_irq.lock);
-    interrupts_restore(ipl);
     while (*in_rdptr_ptr != *in_wrptr_ptr) {
         buf_ptr = (volatile char *)
             SGCN_BUFFER(char, SGCN_BUFFER_HEADER->in_rdptr);
         char c = *buf_ptr;
         *in_rdptr_ptr = (((*in_rdptr_ptr) - begin + 1) % size) + begin;
-        if (c == '\r') {
-            c = '\n';
-        }
-        chardev_push_character(&sgcn_io, c);
+        indev_push_character(instance->srlnin, c);
+    }
     spinlock_unlock(&sgcn_input_lock);
+}
 /**
+ * Polling thread function.
+ */
+static void ksgcnpoll(void *instance) {
+    while (1) {
+        if (!silent)
+            sgcn_poll(instance);
+        thread_usleep(POLL_INTERVAL);
+    }
+}
+/**
- * A public function which initializes I/O from/to Serengeti console
+ * A public function which initializes input from the Serengeti console.
- * and sets it as a default input/output.
  */
-void sgcn_init(void)
+sgcn_instance_t *sgcnin_init(void)
+{
     sgcn_buffer_begin_init();
+    sgcn_instance_t *instance =
+        malloc(sizeof(sgcn_instance_t), FRAME_ATOMIC);
+    if (instance) {
+        instance->srlnin = NULL;
+        instance->thread = thread_create(ksgcnpoll, instance, TASK, 0,
+            "ksgcnpoll", true);
+        if (!instance->thread) {
+            free(instance);
+            return NULL;
+        }
+    }
+    return instance;
+}
+void sgcnin_wire(sgcn_instance_t *instance, indev_t *srlnin)
+{
-    kbd_type = KBD_SGCN;
+    ASSERT(instance);
+    ASSERT(srlnin);
+    instance->srlnin = srlnin;
+    thread_ready(instance->thread);
-    devno_t devno = device_assign_devno();
-    irq_initialize(&sgcn_irq);
-    sgcn_irq.devno = devno;
-    sgcn_irq.inr = FICTIONAL_INR;
-    sgcn_irq.claim = sgcn_claim;
-    sgcn_irq.handler = sgcn_irq_handler;
-    irq_register(&sgcn_irq);
     sysinfo_set_item_val("kbd", NULL, true);
+}
+/**
-    sysinfo_set_item_val("kbd.type", NULL, KBD_SGCN);
+ * A public function which initializes output to the Serengeti console.
+ */
-    sysinfo_set_item_val("kbd.devno", NULL, devno);
+void sgcnout_init(void)
+{
-    sysinfo_set_item_val("kbd.inr", NULL, FICTIONAL_INR);
+    sgcn_buffer_begin_init();
     sysinfo_set_item_val("fb.kind", NULL, 4);
-    chardev_initialize("sgcn_io", &sgcn_io, &sgcn_ops);
+    outdev_initialize("sgcnout", &sgcnout, &sgcnout_ops);
-    stdin = &sgcn_io;
-    stdout = &sgcn_io;
+    stdout = &sgcnout;
+}
 /** @}
  */

Subversion Repositories HelenOS

(root)/branches/tracing/kernel/arch/sparc64/src/drivers/sgcn.c – Rev 3675 → 4377