programs/include/cdi.h

   1
   2 /*
   3  * Copyright (c) 2007 Kevin Wolf
   4  *
   5  * This program is free software. It comes without any warranty, to
   6  * the extent permitted by applicable law. You can redistribute it
   7  * and/or modify it under the terms of the Do What The Fuck You Want
   8  * To Public License, Version 2, as published by Sam Hocevar. See
   9  * http://sam.zoy.org/projects/COPYING.WTFPL for more details.
  10  */
  11
  12 #ifndef CDI_H_INCLUDED
  13 #define CDI_H_INCLUDED
  14
  15 #include <cdi/lists.h>
  16
  17 #define CDI_STANDALONE
  18
  19 typedef enum
  20 {
  21         CDI_UNKNOWN = 0,
  22         CDI_NETWORK = 1,
  23         CDI_STORAGE = 2,
  24         CDI_VIDEO = 3
  25 } cdi_device_type_t;
  26
  27 struct cdi_driver;
  28 struct cdi_device
  29 {
  30         cdi_device_type_t type;
  31         const char *name;
  32         struct cdi_driver *driver;
  33 };
  34
  35 struct cdi_driver
  36 {
  37         cdi_device_type_t type;
  38         const char *name;
  39         cdi_list_t devices;
  40
  41         void (*init_device)(struct cdi_device *device);
  42         void (*remove_device)(struct cdi_device *device);
  43
  44         void (*destroy)(struct cdi_driver *driver);
  45 };
  46
  47 /**
  48  * Has to be called before any other calls to CDI functions. Initialized the CDI
  49  * framework.
  50  *
  51  * Subsequent calls don't have any effect on the progam.
  52  */
  53 void cdi_init(void);
  54
  55 /**
  56  * Executes all registered drivers. This function does not necessarily return to
  57  * the calling code.
  58  */
  59 void cdi_run_drivers(void);
  60
  61 /**
  62  * Initializes the data structures for a driver.
  63  */
  64 void cdi_driver_init(struct cdi_driver* driver);
  65
  66 /**
  67  * Destroys the data structures for a driver.
  68  */
  69 void cdi_driver_destroy(struct cdi_driver* driver);
  70
  71 /**
  72  * Registers the driver for a new device.
  73  *
  74  * \param driver Driver to be registered
  75  */
  76 void cdi_driver_register(struct cdi_driver* driver);
  77
  78 #endif
  79