Subversion Repositories HelenOS

/*
 * Copyright (c) 2006 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/** @addtogroup sparc64 
 * @{
 */
/** @file
 */

#include <arch/drivers/kbd.h>
#include <genarch/ofw/ofw_tree.h>
#ifdef CONFIG_Z8530
#include <genarch/kbd/z8530.h>
#endif
#ifdef CONFIG_NS16550
#include <genarch/kbd/ns16550.h>
#endif
#include <ddi/device.h>
#include <ddi/irq.h>
#include <arch/mm/page.h>
#include <arch/types.h>
#include <align.h>
#include <func.h>
#include <print.h>
#include <sysinfo/sysinfo.h>

kbd_type_t kbd_type = KBD_UNKNOWN;

/** Initialize keyboard.
 *
 * Traverse OpenFirmware device tree in order to find necessary
 * info about the keyboard device.
 *
 * @param node Keyboard device node.
 */
void kbd_init(ofw_tree_node_t *node)
{
    size_t offset;
    uintptr_t aligned_addr;
    ofw_tree_property_t *prop;
    const char *name;
    cir_t cir;
    void *cir_arg;

#ifdef CONFIG_NS16550
    ns16550_t *ns16550;
#endif
#ifdef CONFIG_Z8530
    z8530_t *z8530;
#endif
    
    name = ofw_tree_node_name(node);
    
    /*
     * Determine keyboard serial controller type.
     */
    if (strcmp(name, "zs") == 0)
        kbd_type = KBD_Z8530;
    else if (strcmp(name, "su") == 0)
        kbd_type = KBD_NS16550;
    
    if (kbd_type == KBD_UNKNOWN) {
        printf("Unknown keyboard device.\n");
        return;
    }
    
    /*
     * Read 'interrupts' property.
     */
    uint32_t interrupts;
    prop = ofw_tree_getprop(node, "interrupts");
    if ((!prop) || (!prop->value))
        panic("Cannot find 'interrupt' property.");
    interrupts = *((uint32_t *) prop->value);
    
    /*
     * Read 'reg' property.
     */
    prop = ofw_tree_getprop(node, "reg");
    if ((!prop) || (!prop->value))
        panic("Cannot find 'reg' property.");
    
    uintptr_t pa;
    size_t size;
    devno_t devno;
    inr_t inr;
    
    switch (kbd_type) {
    case KBD_Z8530:
        size = ((ofw_fhc_reg_t *) prop->value)->size;
        if (!ofw_fhc_apply_ranges(node->parent,
            ((ofw_fhc_reg_t *) prop->value), &pa)) {
            printf("Failed to determine keyboard address.\n");
            return;
        }
        if (!ofw_fhc_map_interrupt(node->parent,
            ((ofw_fhc_reg_t *) prop->value), interrupts, &inr, &cir,
            &cir_arg)) {
            printf("Failed to determine keyboard interrupt.\n");
            return;
        }
        break;
        
    case KBD_NS16550:
        size = ((ofw_ebus_reg_t *) prop->value)->size;
        if (!ofw_ebus_apply_ranges(node->parent,
            ((ofw_ebus_reg_t *) prop->value), &pa)) {
            printf("Failed to determine keyboard address.\n");
            return;
        }
        if (!ofw_ebus_map_interrupt(node->parent,
            ((ofw_ebus_reg_t *) prop->value), interrupts, &inr, &cir,
            &cir_arg)) {
            printf("Failed to determine keyboard interrupt.\n");
            return;
        };
        break;
    default:
        panic("Unexpected keyboard type.");
    }
    
    /*
     * We need to pass aligned address to hw_map().
     * However, the physical keyboard address can
     * be pretty much unaligned, depending on the
     * underlying controller.
     */
    aligned_addr = ALIGN_DOWN(pa, PAGE_SIZE);
    offset = pa - aligned_addr;
    
    switch (kbd_type) {
#ifdef CONFIG_Z8530
    case KBD_Z8530:
        devno = device_assign_devno();
        z8530 = (z8530_t *) hw_map(aligned_addr, offset + size) +
            offset;
        (void) z8530_init(z8530, devno, inr, cir, cir_arg);
        
        /*
         * This is the necessary evil until the userspace drivers are
         * entirely self-sufficient.
         */
        sysinfo_set_item_val("kbd", NULL, true);
        sysinfo_set_item_val("kbd.type", NULL, KBD_Z8530);
        sysinfo_set_item_val("kbd.devno", NULL, devno);
        sysinfo_set_item_val("kbd.inr", NULL, inr);
        sysinfo_set_item_val("kbd.address.virtual", NULL,
            (uintptr_t) z8530);
        sysinfo_set_item_val("kbd.address.physical", NULL, pa);
        break;
#endif
#ifdef CONFIG_NS16550
    case KBD_NS16550:
        devno = device_assign_devno();
        ns16550 = (ns16550_t *) hw_map(aligned_addr, offset + size) +
            offset;
        (void) ns16550_init(ns16550, devno, inr, cir, cir_arg);
        
        /*
         * This is the necessary evil until the userspace driver is
         * entirely self-sufficient.
         */
        sysinfo_set_item_val("kbd", NULL, true);
        sysinfo_set_item_val("kbd.type", NULL, KBD_NS16550);
        sysinfo_set_item_val("kbd.devno", NULL, devno);
        sysinfo_set_item_val("kbd.inr", NULL, inr);
        sysinfo_set_item_val("kbd.address.virtual", NULL,
            (uintptr_t) ns16550);
        sysinfo_set_item_val("kbd.address.physical", NULL, pa);
        break;
#endif
    default:
        printf("Kernel is not compiled with the necessary keyboard "
            "driver this machine requires.\n");
    }
}

/** @}
 */