source: mainline/uspace/drv/infrastructure/root/root.c@ 84c89718

/*
 * Copyright (c) 2010 Lenka Trochtova
 * Copyright (c) 2010 Vojtech Horky
 * Copyright (c) 2011 Jiri Svoboda
 * 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.
 */

/**
 * @defgroup root Root device driver.
 * @brief HelenOS root device driver.
 * @{
 */

/** @file
 */

#include <assert.h>
#include <stdio.h>
#include <errno.h>
#include <bool.h>
#include <fibril_synch.h>
#include <stdlib.h>
#include <str.h>
#include <str_error.h>
#include <ctype.h>
#include <macros.h>
#include <inttypes.h>
#include <sysinfo.h>

#include <ddf/driver.h>
#include <ddf/log.h>

#define NAME "root"

#define PLATFORM_FUN_NAME "hw"
#define PLATFORM_FUN_MATCH_ID_FMT "platform/%s"
#define PLATFORM_FUN_MATCH_SCORE 100

#define VIRTUAL_FUN_NAME "virt"
#define VIRTUAL_FUN_MATCH_ID "rootvirt"
#define VIRTUAL_FUN_MATCH_SCORE 100

static int root_dev_add(ddf_dev_t *dev);
static int root_fun_online(ddf_fun_t *fun);
static int root_fun_offline(ddf_fun_t *fun);

/** The root device driver's standard operations. */
static driver_ops_t root_ops = {
        .dev_add = &root_dev_add,
        .fun_online = &root_fun_online,
        .fun_offline = &root_fun_offline
};

/** The root device driver structure. */
static driver_t root_driver = {
        .name = NAME,
        .driver_ops = &root_ops
};

/** Create the function which represents the root of virtual device tree.
 *
 * @param dev   Device
 * @return      EOK on success or negative error code
 */
static int add_virtual_root_fun(ddf_dev_t *dev)
{
        const char *name = VIRTUAL_FUN_NAME;
        ddf_fun_t *fun;
        int rc;

        ddf_msg(LVL_DEBUG, "Adding new function for virtual devices. "
            "Function node is `%s' (%d %s)", name,
            VIRTUAL_FUN_MATCH_SCORE, VIRTUAL_FUN_MATCH_ID);

        fun = ddf_fun_create(dev, fun_inner, name);
        if (fun == NULL) {
                ddf_msg(LVL_ERROR, "Failed creating function %s", name);
                return ENOMEM;
        }

        rc = ddf_fun_add_match_id(fun, VIRTUAL_FUN_MATCH_ID,
            VIRTUAL_FUN_MATCH_SCORE);
        if (rc != EOK) {
                ddf_msg(LVL_ERROR, "Failed adding match IDs to function %s",
                    name);
                ddf_fun_destroy(fun);
                return rc;
        }

        rc = ddf_fun_bind(fun);
        if (rc != EOK) {
                ddf_msg(LVL_ERROR, "Failed binding function %s: %s", name,
                    str_error(rc));
                ddf_fun_destroy(fun);
                return rc;
        }

        return EOK;
}

/** Create the function which represents the root of HW device tree.
 *
 * @param dev   Device
 * @return      EOK on success or negative error code
 */
static int add_platform_fun(ddf_dev_t *dev)
{
        char *match_id;
        char *platform;
        size_t platform_size;

        const char *name = PLATFORM_FUN_NAME;
        ddf_fun_t *fun;
        int rc;

        /* Get platform name from sysinfo. */
        platform = sysinfo_get_data("platform", &platform_size);
        if (platform == NULL) {
                ddf_msg(LVL_ERROR, "Failed to obtain platform name.");
                return ENOENT;
        }

        /* Null-terminate string. */
        platform = realloc(platform, platform_size + 1);
        if (platform == NULL) {
                ddf_msg(LVL_ERROR, "Memory allocation failed.");
                return ENOMEM;
        }

        platform[platform_size] = '\0';

        /* Construct match ID. */
        if (asprintf(&match_id, PLATFORM_FUN_MATCH_ID_FMT, platform) == -1) {
                ddf_msg(LVL_ERROR, "Memory allocation failed.");
                free(platform);
                return ENOMEM;
        }

        free(platform);

        /* Add function. */
        ddf_msg(LVL_DEBUG, "Adding platform function. Function node is `%s' "
            " (%d %s)", PLATFORM_FUN_NAME, PLATFORM_FUN_MATCH_SCORE,
            match_id);

        fun = ddf_fun_create(dev, fun_inner, name);
        if (fun == NULL) {
                ddf_msg(LVL_ERROR, "Error creating function %s", name);
                free(match_id);
                return ENOMEM;
        }

        rc = ddf_fun_add_match_id(fun, match_id, PLATFORM_FUN_MATCH_SCORE);
        if (rc != EOK) {
                ddf_msg(LVL_ERROR, "Failed adding match IDs to function %s",
                    name);
                free(match_id);
                ddf_fun_destroy(fun);
                return rc;
        }

        free(match_id);

        rc = ddf_fun_bind(fun);
        if (rc != EOK) {
                ddf_msg(LVL_ERROR, "Failed binding function %s: %s", name,
                    str_error(rc));
                ddf_fun_destroy(fun);
                return rc;
        }

        return EOK;
}

/** Get the root device.
 *
 * @param dev           The device which is root of the whole device tree (both
 *                      of HW and pseudo devices).
 */
static int root_dev_add(ddf_dev_t *dev)
{
        ddf_msg(LVL_DEBUG, "root_dev_add, device handle=%" PRIun,
            dev->handle);

        /*
         * Register virtual devices root.
         * We ignore error occurrence because virtual devices shall not be
         * vital for the system.
         */
        (void) add_virtual_root_fun(dev);

        /* Register root device's children. */
        int res = add_platform_fun(dev);
        if (EOK != res)
                ddf_msg(LVL_ERROR, "Failed adding child device for platform.");

        return res;
}

static int root_fun_online(ddf_fun_t *fun)
{
        ddf_msg(LVL_DEBUG, "root_fun_online()");
        return ddf_fun_online(fun);
}

static int root_fun_offline(ddf_fun_t *fun)
{
        ddf_msg(LVL_DEBUG, "root_fun_offline()");
        return ddf_fun_offline(fun);
}

int main(int argc, char *argv[])
{
        printf(NAME ": HelenOS root device driver\n");

        ddf_log_init(NAME, LVL_ERROR);
        return ddf_driver_main(&root_driver);
}

/**
 * @}
 */