driver.h

Go to the documentation of this file.

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

#ifndef DDF_DRIVER_H_
#define DDF_DRIVER_H_

#include <ipc/devman.h>
#include <ipc/dev_iface.h>

#include "../dev_iface.h"

typedef struct ddf_dev ddf_dev_t;
typedef struct ddf_fun ddf_fun_t;

/*
 * Device
 */

typedef struct ddf_dev_ops {
        int (*open)(ddf_fun_t *);
        
        void (*close)(ddf_fun_t *);
        
        void *interfaces[DEV_IFACE_COUNT];
        
        remote_handler_t *default_handler;
} ddf_dev_ops_t;

struct ddf_dev {
        devman_handle_t handle;
        
        int parent_phone;
        
        const char *name;
        
        void *driver_data;
        
        link_t link;
};

struct ddf_fun {
        bool bound;
        devman_handle_t handle;
        
        ddf_dev_t *dev;
        
        fun_type_t ftype;
        const char *name;
        match_id_list_t match_ids;
        void *driver_data;
        ddf_dev_ops_t *ops;
        
        link_t link;
};

/*
 * Driver
 */

typedef struct driver_ops {
        int (*add_device)(ddf_dev_t *dev);
        /* TODO: add other generic driver operations */
} driver_ops_t;

typedef struct driver {
        const char *name;
        driver_ops_t *driver_ops;
} driver_t;

extern int ddf_driver_main(driver_t *);

extern ddf_fun_t *ddf_fun_create(ddf_dev_t *, fun_type_t, const char *);
extern void ddf_fun_destroy(ddf_fun_t *);
extern int ddf_fun_bind(ddf_fun_t *);
extern int ddf_fun_add_match_id(ddf_fun_t *, const char *, int);

extern int ddf_fun_add_to_class(ddf_fun_t *, const char *);

#endif

---