source: mainline/uspace/srv/devman/devman.h@ ba1a2fd

/*
 * Copyright (c) 2010 Lenka Trochtova
 * 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 devman
 * @{
 */

#ifndef DEVMAN_H_
#define DEVMAN_H_

#include <assert.h>
#include <bool.h>
#include <dirent.h>
#include <str.h>
#include <adt/list.h>
#include <adt/hash_table.h>
#include <ipc/ipc.h>
#include <ipc/devman.h>
#include <ipc/devmap.h>
#include <fibril_synch.h>
#include <atomic.h>

#include "util.h"

#define NAME "devman"

#define MATCH_EXT ".ma"
#define DEVICE_BUCKETS 256

#define DEVMAP_CLASS_NAMESPACE "class"
#define DEVMAP_DEVICE_NAMESPACE "devices"
#define DEVMAP_SEPARATOR '\\'

struct node;
typedef struct node node_t;

typedef enum {
        /** Driver has not been started. */
        DRIVER_NOT_STARTED = 0,
        
        /**
         * Driver has been started, but has not registered as running and ready
         * to receive requests.
         */
        DRIVER_STARTING,
        
        /** Driver is running and prepared to serve incomming requests. */
        DRIVER_RUNNING
} driver_state_t;

/** Representation of device driver. */
typedef struct driver {
        /** Pointers to previous and next drivers in a linked list. */
        link_t drivers;
        
        /**
         * Specifies whether the driver has been started and wheter is running
         * and prepared to receive requests.
         */
        int state;
        
        /** Phone asociated with this driver. */
        ipcarg_t phone;
        /** Name of the device driver. */
        char *name;
        /** Path to the driver's binary. */
        const char *binary_path;
        /** List of device ids for device-to-driver matching. */
        match_id_list_t match_ids;
        /** Pointer to the linked list of devices controlled by this driver. */
        link_t devices;
        
        /**
         * Fibril mutex for this driver - driver state, list of devices, phone.
         */
        fibril_mutex_t driver_mutex;
} driver_t;

/** The list of drivers. */
typedef struct driver_list {
        /** List of drivers */
        link_t drivers;
        /** Fibril mutex for list of drivers. */
        fibril_mutex_t drivers_mutex;
} driver_list_t;

/** The state of the device. */
typedef enum {
        DEVICE_NOT_INITIALIZED = 0,
        DEVICE_USABLE,
        DEVICE_NOT_PRESENT,
        DEVICE_INVALID
} device_state_t;

/** Representation of a node in the device tree. */
struct node {
        /** The global unique identifier of the device. */
        device_handle_t handle;
        /** The name of the device specified by its parent. */
        char *name;
        
        /**
         * Full path and name of the device in device hierarchi (i. e. in full
         * path in device tree).
         */
        char *pathname;
        
        /** The node of the parent device. */
        node_t *parent;
        
        /**
         * Pointers to previous and next child devices in the linked list of
         * parent device's node.
         */
        link_t sibling;
        
        /** List of child device nodes. */
        link_t children;
        /** List of device ids for device-to-driver matching. */
        match_id_list_t match_ids;
        /** Driver of this device. */
        driver_t *drv;
        /** The state of the device. */
        device_state_t state;
        /**
         * Pointer to the previous and next device in the list of devices
         * owned by one driver.
         */
        link_t driver_devices;
        
        /** The list of device classes to which this device belongs. */
        link_t classes;
        /** Devmap handle if the device is registered by devmapper. */
        dev_handle_t devmap_handle;
        
        /**
         * Used by the hash table of devices indexed by devman device handles.
         */
        link_t devman_link;
        
        /**
         * Used by the hash table of devices indexed by devmap device handles.
         */
        link_t devmap_link;
};

/** Represents device tree. */
typedef struct dev_tree {
        /** Root device node. */
        node_t *root_node;
        
        /**
         * The next available handle - handles are assigned in a sequential
         * manner.
         */
        device_handle_t current_handle;
        
        /** Synchronize access to the device tree. */
        fibril_rwlock_t rwlock;
        
        /** Hash table of all devices indexed by devman handles. */
        hash_table_t devman_devices;
        
        /**
         * Hash table of devices registered by devmapper, indexed by devmap
         * handles.
         */
        hash_table_t devmap_devices;
} dev_tree_t;

typedef struct dev_class {
        /** The name of the class. */
        const char *name;
        
        /**
         * Pointer to the previous and next class in the list of registered
         * classes.
         */
        link_t link;
        
        /**
         * List of dev_class_info structures - one for each device registered by
         * this class.
         */
        link_t devices;
        
        /**
         * Default base name for the device within the class, might be overrided
         * by the driver.
         */
        const char *base_dev_name;
        
        /** Unique numerical identifier of the newly added device. */
        size_t curr_dev_idx;
        /** Synchronize access to the list of devices in this class. */
        fibril_mutex_t mutex;
} dev_class_t;

/**
 * Provides n-to-m mapping between device nodes and classes - each device may
 * be register to the arbitrary number of classes and each class may contain
 * the arbitrary number of devices.
 */
typedef struct dev_class_info {
        /** The class. */
        dev_class_t *dev_class;
        /** The device. */
        node_t *dev;
        
        /**
         * Pointer to the previous and next class info in the list of devices
         * registered by the class.
         */
        link_t link;
        
        /**
         * Pointer to the previous and next class info in the list of classes
         * by which the device is registered.
         */
        link_t dev_classes;
        
        /** The name of the device within the class. */
        char *dev_name;
        /** The handle of the device by device mapper in the class namespace. */
        dev_handle_t devmap_handle;
        
        /**
         * Link in the hash table of devices registered by the devmapper using
         * their class names.
         */
        link_t devmap_link;
} dev_class_info_t;

/** The list of device classes. */
typedef struct class_list {
        /** List of classes. */
        link_t classes;
        
        /**
         * Hash table of devices registered by devmapper using their class name,
         * indexed by devmap handles.
         */
        hash_table_t devmap_devices;
        
        /** Fibril mutex for list of classes. */
        fibril_rwlock_t rwlock;
} class_list_t;

/* Match ids and scores */

extern int get_match_score(driver_t *, node_t *);

extern bool parse_match_ids(char *, match_id_list_t *);
extern bool read_match_ids(const char *, match_id_list_t *);
extern char *read_match_id(char **);
extern char *read_id(const char **);

/* Drivers */

/**
 * Initialize the list of device driver's.
 *
 * @param drv_list the list of device driver's.
 *
 */
static inline void init_driver_list(driver_list_t *drv_list)
{
        assert(drv_list != NULL);
        
        list_initialize(&drv_list->drivers);
        fibril_mutex_initialize(&drv_list->drivers_mutex);
}

extern driver_t *create_driver(void);
extern bool get_driver_info(const char *, const char *, driver_t *);
extern int lookup_available_drivers(driver_list_t *, const char *);

extern driver_t *find_best_match_driver(driver_list_t *, node_t *);
extern bool assign_driver(node_t *, driver_list_t *, dev_tree_t *);

extern void add_driver(driver_list_t *, driver_t *);
extern void attach_driver(node_t *, driver_t *);
extern void add_device(int, driver_t *, node_t *, dev_tree_t *);
extern bool start_driver(driver_t *);

extern driver_t *find_driver(driver_list_t *, const char *);
extern void set_driver_phone(driver_t *, ipcarg_t);
void initialize_running_driver(driver_t *, dev_tree_t *);

/** Initialize device driver structure.
 *
 * @param drv           The device driver structure.
 */
static inline void init_driver(driver_t *drv)
{
        assert(drv != NULL);

        memset(drv, 0, sizeof(driver_t));
        list_initialize(&drv->match_ids.ids);
        list_initialize(&drv->devices);
        fibril_mutex_initialize(&drv->driver_mutex);
}

/** Device driver structure clean-up.
 *
 * @param drv           The device driver structure.
 */
static inline void clean_driver(driver_t *drv)
{
        assert(drv != NULL);

        free_not_null(drv->name);
        free_not_null(drv->binary_path);

        clean_match_ids(&drv->match_ids);

        init_driver(drv);
}

/** Delete device driver structure.
 *
 * @param drv           The device driver structure.
 */
static inline void delete_driver(driver_t *drv)
{
        assert(drv != NULL);
        
        clean_driver(drv);
        free(drv);
}


/* Device nodes */

/** Create a new device node.
 *
 * @return              A device node structure.
 */
static inline node_t *create_dev_node(void)
{
        node_t *res = malloc(sizeof(node_t));
        
        if (res != NULL) {
                memset(res, 0, sizeof(node_t));
                list_initialize(&res->children);
                list_initialize(&res->match_ids.ids);
                list_initialize(&res->classes);
        }
        
        return res;
}

/** Delete a device node.
 *
 * @param node          The device node structure.
 */
static inline void delete_dev_node(node_t *node)
{
        assert(list_empty(&node->children));
        assert(node->parent == NULL);
        assert(node->drv == NULL);
        
        clean_match_ids(&node->match_ids);
        free_not_null(node->name);
        free_not_null(node->pathname);
        free(node);
}

/** Find the device node structure of the device witch has the specified handle.
 *
 * Device tree's rwlock should be held at least for reading.
 *
 * @param tree          The device tree where we look for the device node.
 * @param handle        The handle of the device.
 * @return              The device node.
 */
static inline node_t *find_dev_node_no_lock(dev_tree_t *tree,
    device_handle_t handle)
{
        unsigned long key = handle;
        link_t *link = hash_table_find(&tree->devman_devices, &key);
        return hash_table_get_instance(link, node_t, devman_link);
}

/** Find the device node structure of the device witch has the specified handle.
 *
 * @param tree          The device tree where we look for the device node.
 * @param handle        The handle of the device.
 * @return              The device node.
 */
static inline node_t *find_dev_node(dev_tree_t *tree, device_handle_t handle)
{
        node_t *node = NULL;
        
        fibril_rwlock_read_lock(&tree->rwlock);
        node = find_dev_node_no_lock(tree, handle);
        fibril_rwlock_read_unlock(&tree->rwlock);
        
        return node;
}

extern node_t *find_dev_node_by_path(dev_tree_t *, char *);
extern node_t *find_node_child(node_t *, const char *);


/* Device tree */

extern bool init_device_tree(dev_tree_t *, driver_list_t *);
extern bool create_root_node(dev_tree_t *);
extern bool insert_dev_node(dev_tree_t *, node_t *, char *, node_t *);


/* Device classes */

/** Create device class.
 *
 * @return      Device class.
 */
static inline dev_class_t *create_dev_class(void)
{
        dev_class_t *cl;
        
        cl = (dev_class_t *) malloc(sizeof(dev_class_t));
        if (cl != NULL) {
                memset(cl, 0, sizeof(dev_class_t));
                list_initialize(&cl->devices);
                fibril_mutex_initialize(&cl->mutex);
        }
        
        return cl;
}

/** Create device class info.
 *
 * @return              Device class info.
 */
static inline dev_class_info_t *create_dev_class_info(void)
{
        dev_class_info_t *info;
        
        info = (dev_class_info_t *) malloc(sizeof(dev_class_info_t));
        if (info != NULL)
                memset(info, 0, sizeof(dev_class_info_t));
        
        return info;
}

static inline size_t get_new_class_dev_idx(dev_class_t *cl)
{
        size_t dev_idx;
        
        fibril_mutex_lock(&cl->mutex);
        dev_idx = ++cl->curr_dev_idx;
        fibril_mutex_unlock(&cl->mutex);
        
        return dev_idx;
}

extern char *create_dev_name_for_class(dev_class_t *, const char *);
extern dev_class_info_t *add_device_to_class(node_t *, dev_class_t *,
    const char *);

extern void init_class_list(class_list_t *);

extern dev_class_t *get_dev_class(class_list_t *, char *);
extern dev_class_t *find_dev_class_no_lock(class_list_t *, const char *);

static inline void add_dev_class_no_lock(class_list_t *class_list,
    dev_class_t *cl)
{
        list_append(&cl->link, &class_list->classes);
}


/* Devmap devices */

extern node_t *find_devmap_tree_device(dev_tree_t *, dev_handle_t);
extern node_t *find_devmap_class_device(class_list_t *, dev_handle_t);

static inline void class_add_devmap_device(class_list_t *class_list,
    dev_class_info_t *cli)
{
        unsigned long key = (unsigned long) cli->devmap_handle;
        
        fibril_rwlock_write_lock(&class_list->rwlock);
        hash_table_insert(&class_list->devmap_devices, &key, &cli->devmap_link);
        fibril_rwlock_write_unlock(&class_list->rwlock);
}

static inline void tree_add_devmap_device(dev_tree_t *tree, node_t *node)
{
        unsigned long key = (unsigned long) node->devmap_handle;
        fibril_rwlock_write_lock(&tree->rwlock);
        hash_table_insert(&tree->devmap_devices, &key, &node->devmap_link);
        fibril_rwlock_write_unlock(&tree->rwlock);
}

#endif

/** @}
 */