source: mainline/uspace/lib/drv/include/driver.h@ 659ca07

/*
 * 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 libdrv
 * @{
 */
/** @file
 */

#ifndef LIBDRV_DRIVER_H_
#define LIBDRV_DRIVER_H_

#include <kernel/ddi/irq.h>
#include <adt/list.h>
#include <devman.h>
#include <ipc/devman.h>
#include <ipc/dev_iface.h>
#include <assert.h>
#include <ddi.h>
#include <libarch/ddi.h>
#include <fibril_synch.h>
#include <malloc.h>

#include "dev_iface.h"

struct device;
typedef struct device device_t;

struct function;
typedef struct function function_t;

/*
 * Device class
 */

/** Devices operations */
typedef struct device_ops {
        /**
         * Optional callback function called when a client is connecting to the
         * device.
         */
        int (*open)(function_t *);
        
        /**
         * Optional callback function called when a client is disconnecting from
         * the device.
         */
        void (*close)(function_t *);
        
        /** The table of standard interfaces implemented by the device. */
        void *interfaces[DEV_IFACE_COUNT];
        
        /**
         * The default handler of remote client requests. If the client's remote
         * request cannot be handled by any of the standard interfaces, the
         * default handler is used.
         */
        remote_handler_t *default_handler;
} device_ops_t;


/*
 * Device
 */

/** Device structure */
struct device {
        /**
         * Globally unique device identifier (assigned to the device by the
         * device manager).
         */
        devman_handle_t handle;
        
        /**
         * Phone to the parent device driver (if it is different from this
         * driver)
         */
        int parent_phone;
        
        /** Device name */
        const char *name;
        
        /** Driver-specific data associated with this device */
        void *driver_data;
        
        /** Link in the list of devices handled by the driver */
        link_t link;
};

/** Function structure */
struct function {
        /** True if bound to the device manager */
        bool bound;
        /** Function indentifier (asigned by device manager) */
        devman_handle_t handle;
        
        /** Device which this function belogs to */
        device_t *dev;
        
        /** Function type */
        fun_type_t ftype;
        /** Function name */
        const char *name;
        /** List of device ids for driver matching */
        match_id_list_t match_ids;
        /** Driver-specific data associated with this function */
        void *driver_data;
        /** Implementation of operations provided by this function */
        device_ops_t *ops;
        
        /** Link in the list of functions handled by the driver */
        link_t link;
};

/*
 * Driver
 */

/** Generic device driver operations */
typedef struct driver_ops {
        /** Callback method for passing a new device to the device driver */
        int (*add_device)(device_t *dev);
        /* TODO: add other generic driver operations */
} driver_ops_t;

/** Driver structure */
typedef struct driver {
        /** Name of the device driver */
        const char *name;
        /** Generic device driver operations */
        driver_ops_t *driver_ops;
} driver_t;

int driver_main(driver_t *);

extern function_t *ddf_fun_create(device_t *, fun_type_t, const char *);
extern void ddf_fun_destroy(function_t *);
extern int ddf_fun_bind(function_t *);
extern int ddf_fun_add_match_id(function_t *, const char *, int);

extern void *function_get_ops(function_t *, dev_inferface_idx_t);

/*
 * Interrupts
 */

typedef void interrupt_handler_t(device_t *, ipc_callid_t, ipc_call_t *);

typedef struct interrupt_context {
        int id;
        device_t *dev;
        int irq;
        interrupt_handler_t *handler;
        link_t link;
} interrupt_context_t;

typedef struct interrupt_context_list {
        int curr_id;
        link_t contexts;
        fibril_mutex_t mutex;
} interrupt_context_list_t;

extern interrupt_context_t *create_interrupt_context(void);
extern void delete_interrupt_context(interrupt_context_t *);
extern void init_interrupt_context_list(interrupt_context_list_t *);
extern void add_interrupt_context(interrupt_context_list_t *,
    interrupt_context_t *);
extern void remove_interrupt_context(interrupt_context_list_t *,
    interrupt_context_t *);
extern interrupt_context_t *find_interrupt_context_by_id(
    interrupt_context_list_t *, int);
extern interrupt_context_t *find_interrupt_context(
    interrupt_context_list_t *, device_t *, int);

extern int register_interrupt_handler(device_t *, int, interrupt_handler_t *,
    irq_code_t *);
extern int unregister_interrupt_handler(device_t *, int);

extern remote_handler_t *function_get_default_handler(function_t *);
extern int add_function_to_class(function_t *fun, const char *class_name);

#endif

/**
 * @}
 */