Changeset 357b5f5 in mainline for uspace/lib/drv/include/driver.h


Ignore:
Timestamp:
2011-01-23T20:09:13Z (13 years ago)
Author:
Jakub Jermar <jakub@…>
Branches:
lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export
Children:
fdb9982c
Parents:
cead2aa (diff), 7e36c8d (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.
Message:

Merge mainline changes.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • uspace/lib/drv/include/driver.h

    rcead2aa r357b5f5  
    4141#include <ipc/devman.h>
    4242#include <ipc/dev_iface.h>
    43 #include <device/hw_res.h>
    44 #include <device/char.h>
    4543#include <assert.h>
    4644#include <ddi.h>
    … …  
    4947#include <malloc.h>
    5048
     49#include "dev_iface.h"
     50
    5151struct device;
    5252typedef struct device device_t;
    5353
    54 /* device interface */
     54/*
     55 * Device class
     56 */
    5557
    56 /*
    57  * First two parameters: device and interface structure registered by the
    58  * devices driver.
    59  */
    60 typedef void remote_iface_func_t(device_t *, void *, ipc_callid_t,
    61     ipc_call_t *);
    62 typedef remote_iface_func_t *remote_iface_func_ptr_t;
    63 typedef void remote_handler_t(device_t *, ipc_callid_t, ipc_call_t *);
    64 
    65 typedef struct {
    66         size_t method_count;
    67         remote_iface_func_ptr_t *methods;
    68 } remote_iface_t;
    69 
    70 typedef struct {
    71         remote_iface_t *ifaces[DEV_IFACE_COUNT];
    72 } iface_dipatch_table_t;
    73 
    74 
    75 static inline bool is_valid_iface_idx(int idx)
    76 {
    77         return 0 <= idx && idx < DEV_IFACE_MAX;
    78 }
    79 
    80 remote_iface_t *get_remote_iface(int);
    81 remote_iface_func_ptr_t get_remote_method(remote_iface_t *, ipcarg_t);
    82 
    83 
    84 /* device class */
    85 
    86 /** Devices operations. */
     58/** Devices operations */
    8759typedef struct device_ops {
    8860        /**
    … …  
    11082
    11183
    112 /* device */
     84/*
     85 * Device
     86 */
    11387
    114 /** The device. */
     88/** Device structure */
    11589struct device {
    11690        /**
    … …  
    12195       
    12296        /**
    123          * The phone to the parent device driver (if it is different from this
    124          * driver).
     97         * Phone to the parent device driver (if it is different from this
     98         * driver)
    12599         */
    126100        int parent_phone;
    127101       
    128         /** Parent device if handled by this driver, NULL otherwise. */
     102        /** Parent device if handled by this driver, NULL otherwise */
    129103        device_t *parent;
    130         /** The device's name. */
     104        /** Device name */
    131105        const char *name;
    132         /** The list of device ids for device-to-driver matching. */
     106        /** List of device ids for device-to-driver matching */
    133107        match_id_list_t match_ids;
    134         /** The device driver's data associated with this device. */
     108        /** Driver-specific data associated with this device */
    135109        void *driver_data;
    136         /** The implementation of operations provided by this device. */
     110        /** The implementation of operations provided by this device */
    137111        device_ops_t *ops;
    138112       
    139         /**
    140          * Pointer to the previous and next device in the list of devices
    141          * handled by the driver.
    142          */
     113        /** Link in the list of devices handled by the driver */
    143114        link_t link;
    144115};
    145116
     117/*
     118 * Driver
     119 */
    146120
    147 /* driver */
    148 
    149 /** Generic device driver operations. */
     121/** Generic device driver operations */
    150122typedef struct driver_ops {
    151         /** Callback method for passing a new device to the device driver.*/
     123        /** Callback method for passing a new device to the device driver */
    152124        int (*add_device)(device_t *dev);
    153         /* TODO add other generic driver operations */
     125        /* TODO: add other generic driver operations */
    154126} driver_ops_t;
    155127
    156 /** The driver structure.*/
     128/** Driver structure */
    157129typedef struct driver {
    158         /** The name of the device driver. */
     130        /** Name of the device driver */
    159131        const char *name;
    160         /** Generic device driver operations. */
     132        /** Generic device driver operations */
    161133        driver_ops_t *driver_ops;
    162134} driver_t;
    … …  
    168140 * @return              The device structure.
    169141 */
    170 static inline device_t *create_device(void)
    171 {
    172         device_t *dev = malloc(sizeof(device_t));
    173         if (NULL != dev) {
    174                 memset(dev, 0, sizeof(device_t));
    175                 init_match_ids(&dev->match_ids);
    176         }       
    177         return dev;
    178 }
     142extern device_t *create_device(void);
     143extern void delete_device(device_t *);
     144extern void *device_get_ops(device_t *, dev_inferface_idx_t);
    179145
    180 /** Delete device structure.
    181  *
    182  * @param dev           The device structure.
     146extern int child_device_register(device_t *, device_t *);
     147extern int child_device_register_wrapper(device_t *, const char *, const char *,
     148    int);
     149
     150/*
     151 * Interrupts
    183152 */
    184 static inline void delete_device(device_t *dev)
    185 {
    186         clean_match_ids(&dev->match_ids);
    187         if (NULL != dev->name)
    188                 free(dev->name);
    189         free(dev);
    190 }
    191 
    192 static inline void *device_get_iface(device_t *dev, dev_inferface_idx_t idx)
    193 {
    194         assert(is_valid_iface_idx(idx));
    195         if (NULL == dev->ops)
    196                 return NULL;
    197         return dev->ops->interfaces[idx];
    198 }
    199 
    200 int child_device_register(device_t *, device_t *);
    201 
    202 
    203 /* interrupts */
    204153
    205154typedef void interrupt_handler_t(device_t *, ipc_callid_t, ipc_call_t *);
    … …  
    219168} interrupt_context_list_t;
    220169
    221 static inline interrupt_context_t *create_interrupt_context(void)
    222 {
    223         interrupt_context_t *ctx;
    224        
    225         ctx = (interrupt_context_t *) malloc(sizeof(interrupt_context_t));
    226         if (NULL != ctx)
    227                 memset(ctx, 0, sizeof(interrupt_context_t));
    228        
    229         return ctx;
    230 }
     170extern interrupt_context_t *create_interrupt_context(void);
     171extern void delete_interrupt_context(interrupt_context_t *);
     172extern void init_interrupt_context_list(interrupt_context_list_t *);
     173extern void add_interrupt_context(interrupt_context_list_t *,
     174    interrupt_context_t *);
     175extern void remove_interrupt_context(interrupt_context_list_t *,
     176    interrupt_context_t *);
     177extern interrupt_context_t *find_interrupt_context_by_id(
     178    interrupt_context_list_t *, int);
     179extern interrupt_context_t *find_interrupt_context(
     180    interrupt_context_list_t *, device_t *, int);
    231181
    232 static inline void delete_interrupt_context(interrupt_context_t *ctx)
    233 {
    234         if (NULL != ctx)
    235                 free(ctx);
    236 }
     182extern int register_interrupt_handler(device_t *, int, interrupt_handler_t *,
     183    irq_code_t *);
     184extern int unregister_interrupt_handler(device_t *, int);
    237185
    238 static inline void init_interrupt_context_list(interrupt_context_list_t *list)
    239 {
    240         memset(list, 0, sizeof(interrupt_context_list_t));
    241         fibril_mutex_initialize(&list->mutex);
    242         list_initialize(&list->contexts);
    243 }
    244 
    245 static inline void
    246 add_interrupt_context(interrupt_context_list_t *list, interrupt_context_t *ctx)
    247 {
    248         fibril_mutex_lock(&list->mutex);
    249         ctx->id = list->curr_id++;
    250         list_append(&ctx->link, &list->contexts);
    251         fibril_mutex_unlock(&list->mutex);
    252 }
    253 
    254 static inline void
    255 remove_interrupt_context(interrupt_context_list_t *list,
    256     interrupt_context_t *ctx)
    257 {
    258         fibril_mutex_lock(&list->mutex);
    259         list_remove(&ctx->link);
    260         fibril_mutex_unlock(&list->mutex);
    261 }
    262 
    263 static inline interrupt_context_t *
    264 find_interrupt_context_by_id(interrupt_context_list_t *list, int id)
    265 {
    266         fibril_mutex_lock(&list->mutex);
    267        
    268         link_t *link = list->contexts.next;
    269         interrupt_context_t *ctx;
    270        
    271         while (link != &list->contexts) {
    272                 ctx = list_get_instance(link, interrupt_context_t, link);
    273                 if (id == ctx->id) {
    274                         fibril_mutex_unlock(&list->mutex);
    275                         return ctx;
    276                 }
    277                 link = link->next;
    278         }
    279        
    280         fibril_mutex_unlock(&list->mutex);
    281         return NULL;
    282 }
    283 
    284 static inline interrupt_context_t *
    285 find_interrupt_context(interrupt_context_list_t *list, device_t *dev, int irq)
    286 {
    287         fibril_mutex_lock(&list->mutex);
    288        
    289         link_t *link = list->contexts.next;
    290         interrupt_context_t *ctx;
    291        
    292         while (link != &list->contexts) {
    293                 ctx = list_get_instance(link, interrupt_context_t, link);
    294                 if (irq == ctx->irq && dev == ctx->dev) {
    295                         fibril_mutex_unlock(&list->mutex);
    296                         return ctx;
    297                 }
    298                 link = link->next;
    299         }
    300        
    301         fibril_mutex_unlock(&list->mutex);
    302         return NULL;
    303 }
    304 
    305 int register_interrupt_handler(device_t *, int, interrupt_handler_t *,
    306     irq_code_t *);
    307 int unregister_interrupt_handler(device_t *, int);
    308 
    309 
    310 /* default handler for client requests */
    311 
    312 static inline remote_handler_t *device_get_default_handler(device_t *dev)
    313 {
    314         if (NULL == dev->ops)
    315                 return NULL;
    316         return dev->ops->default_handler;
    317 }
    318 
    319 static inline int add_device_to_class(device_t *dev, const char *class_name)
    320 {
    321         return devman_add_device_to_class(dev->handle, class_name);
    322 }
     186extern remote_handler_t *device_get_default_handler(device_t *);
     187extern int add_device_to_class(device_t *, const char *);
    323188
    324189#endif
Note: See TracChangeset for help on using the changeset viewer.