/*
* Copyright (c) 2010 Lenka Trochtova
* 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.
*/
/** @addtogroup devman
* @{
*/
#ifndef DEVMAN_H_
#define DEVMAN_H_
#include <stdbool.h>
#include <adt/list.h>
#include <adt/hash_table.h>
#include <ipc/devman.h>
#include <ipc/loc.h>
#include <fibril_synch.h>
#include <refcount.h>
#include <async.h>
#include "util.h"
#define NAME "devman"
#define LOC_DEVICE_NAMESPACE "devices"
#define LOC_SEPARATOR '\\'
struct dev_node;
typedef struct dev_node dev_node_t;
struct fun_node;
typedef struct fun_node fun_node_t;
typedef struct {
fibril_mutex_t mutex;
struct driver *driver;
} client_t;
/** Representation of device driver. */
typedef struct driver {
/** Pointers to previous and next drivers in a linked list. */
link_t drivers;
/** Handle */
devman_handle_t handle;
/**
* Specifies whether the driver has been started and wheter is running
* and prepared to receive requests.
*/
driver_state_t state;
/** Session asociated with this driver. */
async_sess_t *sess;
/** Name of the device driver. */
char *name;
/** Path to the driver's binary. */
char *binary_path;
/** List of device ids for device-to-driver matching. */
match_id_list_t match_ids;
/** List of devices controlled by this driver. */
list_t devices;
/**
* Fibril mutex for this driver - driver state, list of devices, session.
*/
fibril_mutex_t driver_mutex;
} driver_t;
/** The list of drivers. */
typedef struct driver_list {
/** List of drivers */
list_t drivers;
/** Fibril mutex for list of drivers. */
fibril_mutex_t drivers_mutex;
/** Next free handle */
devman_handle_t next_handle;
} driver_list_t;
/** Device state */
typedef enum {
DEVICE_NOT_INITIALIZED = 0,
DEVICE_USABLE,
DEVICE_NOT_PRESENT,
DEVICE_INVALID,
/** Device node has been removed from the tree */
DEVICE_REMOVED
} device_state_t;
/** Device node in the device tree. */
struct dev_node {
/** Reference count */
atomic_refcount_t refcnt;
/** The global unique identifier of the device. */
devman_handle_t handle;
/** (Parent) function the device is attached to. */
fun_node_t *pfun;
/** List of device functions. */
list_t functions;
/** Driver of this device. */
driver_t *drv;
/** The state of the device. */
device_state_t state;
/** Link to list of devices owned by driver (driver_t.devices) */
link_t driver_devices;
/**
* Used by the hash table of devices indexed by devman device handles.
*/
ht_link_t devman_dev;
/**
* Whether this device was already passed to the driver.
*/
bool passed_to_driver;
};
/** Function state */
typedef enum {
FUN_INIT = 0,
FUN_OFF_LINE,
FUN_ON_LINE,
/** Function node has been removed from the tree */
FUN_REMOVED
} fun_state_t;
/** Function node in the device tree. */
struct fun_node {
/** Reference count */
atomic_refcount_t refcnt;
/** State */
fun_state_t state;
/** Locked while performing reconfiguration operations */
fibril_mutex_t busy_lock;
/** The global unique identifier of the function */
devman_handle_t handle;
/** Name of the function, assigned by the device driver */
char *name;
/** Function type */
fun_type_t ftype;
/** Full path and name of the device in device hierarchy */
char *pathname;
/** Device which this function belongs to */
dev_node_t *dev;
/** Link to list of functions in the device (ddf_dev_t.functions) */
link_t dev_functions;
/** Child device node (if any attached). */
dev_node_t *child;
/** List of device ids for device-to-driver matching. */
match_id_list_t match_ids;
/** Service ID if the device function is registered with loc. */
service_id_t service_id;
/**
* Used by the hash table of functions indexed by devman device handles.
*/
ht_link_t devman_fun;
/**
* Used by the hash table of functions indexed by service IDs.
*/
ht_link_t loc_fun;
};
/** Represents device tree. */
typedef struct dev_tree {
/** Root device node. */
fun_node_t *root_node;
/**
* The next available handle - handles are assigned in a sequential
* manner.
*/
devman_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 all devices indexed by devman handles. */
hash_table_t devman_functions;
/**
* Hash table of services registered with location service, indexed by
* service IDs.
*/
hash_table_t loc_functions;
} dev_tree_t;
#endif
/** @}
*/