devman.h

/*
 * 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.
 */

#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/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 dev_node;
typedef struct dev_node dev_node_t;

struct fun_node;
typedef struct fun_node fun_node_t;

typedef enum {
        DRIVER_NOT_STARTED = 0,
        
        DRIVER_STARTING,
        
        DRIVER_RUNNING
} driver_state_t;

typedef struct driver {
        link_t drivers;
        
        int state;
        
        int phone;
        char *name;
        const char *binary_path;
        match_id_list_t match_ids;
        link_t devices;
        
        fibril_mutex_t driver_mutex;
} driver_t;

typedef struct driver_list {
        link_t drivers;
        fibril_mutex_t drivers_mutex;
} driver_list_t;

typedef enum {
        DEVICE_NOT_INITIALIZED = 0,
        DEVICE_USABLE,
        DEVICE_NOT_PRESENT,
        DEVICE_INVALID
} device_state_t;

struct dev_node {
        devman_handle_t handle;
        
        fun_node_t *pfun;
        
        link_t functions;
        driver_t *drv;
        device_state_t state;
        link_t driver_devices;
        
        link_t devman_dev;
        
        bool passed_to_driver;
};

struct fun_node {
        devman_handle_t handle;
        char *name;
        
        char *pathname;
        
        dev_node_t *dev;
        
        link_t dev_functions;
        
        dev_node_t *child;
        match_id_list_t match_ids;
        
        link_t classes;
        devmap_handle_t devmap_handle;
        
        link_t devman_fun;
        
        link_t devmap_fun;
};


typedef struct dev_tree {
        fun_node_t *root_node;
        
        devman_handle_t current_handle;
        
        fibril_rwlock_t rwlock;
        
        hash_table_t devman_devices;
        
        hash_table_t devman_functions;
        
        hash_table_t devmap_functions;
} dev_tree_t;

typedef struct dev_class {
        const char *name;
        
        link_t link;
        
        link_t devices;
        
        const char *base_dev_name;
        
        size_t curr_dev_idx;
        fibril_mutex_t mutex;
} dev_class_t;

typedef struct dev_class_info {
        dev_class_t *dev_class;
        fun_node_t *fun;
        
        link_t link;
        
        link_t dev_classes;
        
        char *dev_name;
        devmap_handle_t devmap_handle;
        
        link_t devmap_link;
} dev_class_info_t;

typedef struct class_list {
        link_t classes;
        
        hash_table_t devmap_functions;
        
        fibril_rwlock_t rwlock;
} class_list_t;

/* Match ids and scores */

extern int get_match_score(driver_t *, dev_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 */

extern void init_driver_list(driver_list_t *);
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 *, dev_node_t *);
extern bool assign_driver(dev_node_t *, driver_list_t *, dev_tree_t *);

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

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

extern void init_driver(driver_t *);
extern void clean_driver(driver_t *);
extern void delete_driver(driver_t *);

/* Device nodes */

extern dev_node_t *create_dev_node(void);
extern void delete_dev_node(dev_node_t *node);
extern dev_node_t *find_dev_node_no_lock(dev_tree_t *tree,
    devman_handle_t handle);
extern dev_node_t *find_dev_node(dev_tree_t *tree, devman_handle_t handle);
extern dev_node_t *find_dev_function(dev_node_t *, const char *);

extern fun_node_t *create_fun_node(void);
extern void delete_fun_node(fun_node_t *);
extern fun_node_t *find_fun_node_no_lock(dev_tree_t *tree,
    devman_handle_t handle);
extern fun_node_t *find_fun_node(dev_tree_t *tree, devman_handle_t handle);
extern fun_node_t *find_fun_node_by_path(dev_tree_t *, char *);
extern fun_node_t *find_fun_node_in_device(dev_node_t *, const char *);
extern fun_node_t *find_fun_node_by_class(class_list_t *, const char *, const char *);

/* Device tree */

extern bool init_device_tree(dev_tree_t *, driver_list_t *);
extern bool create_root_nodes(dev_tree_t *);
extern bool insert_dev_node(dev_tree_t *, dev_node_t *, fun_node_t *);
extern bool insert_fun_node(dev_tree_t *, fun_node_t *, char *, dev_node_t *);

/* Device classes */

extern dev_class_t *create_dev_class(void);
extern dev_class_info_t *create_dev_class_info(void);
extern size_t get_new_class_dev_idx(dev_class_t *);
extern char *create_dev_name_for_class(dev_class_t *, const char *);
extern dev_class_info_t *add_function_to_class(fun_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 *);
extern dev_class_info_t *find_dev_in_class(dev_class_t *, const char *);
extern void add_dev_class_no_lock(class_list_t *, dev_class_t *);

/* Devmap devices */

extern void devmap_register_tree_function(fun_node_t *, dev_tree_t *);

extern fun_node_t *find_devmap_tree_function(dev_tree_t *, devmap_handle_t);
extern fun_node_t *find_devmap_class_function(class_list_t *, devmap_handle_t);

extern void class_add_devmap_function(class_list_t *, dev_class_info_t *);
extern void tree_add_devmap_function(dev_tree_t *, fun_node_t *);

#endif

---