feat: support user-spcae pci rescan
[lunaix-os.git] / lunaix-os / includes / lunaix / device.h
index 52df8f0a0efcbde5c3fe6bf38d7e33d61ac207b9..fac62a9b54f179c5d42d1ed598c96fe81234e330 100644 (file)
@@ -8,9 +8,11 @@
 #include <lunaix/ds/hstr.h>
 #include <lunaix/ds/ldga.h>
 #include <lunaix/ds/llist.h>
-#include <lunaix/ds/semaphore.h>
+#include <lunaix/ds/mutex.h>
 #include <lunaix/types.h>
 
+#include <usr/lunaix/device.h>
+
 /**
  * @brief Export a device definition
  *
@@ -20,6 +22,7 @@
     export_ldga_el_sfx(devdefs, id##_ldorder, ptr_t, devdef, load_order);
 
 #define load_on_demand ld_ondemand
+#define load_pci_probe ld_ondemand
 
 /**
  * @brief Mark the device definition should be loaded automatically as earlier
  * @brief Declare a device class
  *
  */
-#define DEVCLASS(devif, devfn, devkind, devvar)                                \
+#define DEVCLASS(devif, devfn, dev)                                            \
+    (struct devclass)                                                          \
+    {                                                                          \
+        .fn_grp = DEV_FNGRP(devif, devfn), .device = (dev), .variant = 0       \
+    }
+
+#define DEVCLASSV(devif, devfn, dev, devvar)                                   \
     (struct devclass)                                                          \
     {                                                                          \
-        .meta = DEV_META(devif, devfn), .device = (devkind),                   \
+        .fn_grp = DEV_FNGRP(devif, devfn), .device = (dev),                    \
         .variant = (devvar)                                                    \
     }
 
 #define DEV_IFCAT 0x2 // a device category (as device groupping)
 #define DEV_IFSYS 0x3 // a system device
 
-typedef unsigned int dev_t;
-
-struct devclass
-{
-    u32_t meta;
-    u32_t device;
-    u32_t variant;
-    u32_t hash;
-};
-
 struct device
 {
     u32_t magic;
     struct llist_header siblings;
     struct llist_header children;
     struct device* parent;
+    mutex_t lock;
+
     // TODO investigate event polling
 
     struct hstr name;
-    struct devclass class;
-    dev_t dev_id;
+    struct devident ident;
+
+    u32_t dev_uid;
     int dev_type;
     char name_val[DEVICE_NAME_SIZE];
     void* underlay;
 
     struct
     {
+        // TODO Think about where will they fit.
+        int (*acquire)(struct device* dev);
+        int (*release)(struct device* dev);
+
         int (*read)(struct device* dev, void* buf, size_t offset, size_t len);
         int (*write)(struct device* dev, void* buf, size_t offset, size_t len);
         int (*read_page)(struct device* dev, void* buf, size_t offset);
@@ -110,49 +116,54 @@ struct device_def
     struct devclass class;
 
     int (*init)(struct device_def*);
-    int (*init_for)(struct device_def*, struct device*);
+    int (*bind)(struct device_def*, struct device*);
+    int (*free)(struct device_def*, void* instance);
 };
 
-static inline u32_t devclass_hash(struct devclass class)
+static inline u32_t
+device_id_from_class(struct devclass* class)
 {
-    return (((class.device & 0xffff) << 16) | (class.variant & 0xffff)) ^
-           ~class.meta;
+    return ((class->device & 0xffff) << 16) | ((class->variant & 0xffff));
 }
 
 void
-device_register_all();
+device_scan_drivers();
 
 void
-device_prepare(struct device* dev);
+device_setname_vargs(struct device* dev, char* fmt, va_list args);
 
 void
 device_setname(struct device* dev, char* fmt, ...);
 
 void
-device_setname(struct device* dev, char* fmt, ...);
+device_register(struct device* dev, struct devclass* class, char* fmt, ...);
 
-struct device*
-device_add_vargs(struct device* parent,
-                 void* underlay,
-                 char* name_fmt,
-                 u32_t type,
-                 va_list args);
+void
+device_create(struct device* dev,
+              struct device* parent,
+              u32_t type,
+              void* underlay);
 
 struct device*
-device_add(struct device* parent,
-           void* underlay,
-           u32_t type,
-           char* name_fmt,
-           ...);
+device_alloc(struct device* parent, u32_t type, void* underlay);
 
-struct device*
-device_addsys(struct device* parent, void* underlay, char* name_fmt, ...);
+static inline struct device*
+device_allocsys(struct device* parent, void* underlay)
+{
+    return device_alloc(parent, DEV_IFSYS, underlay);
+}
 
-struct device*
-device_addseq(struct device* parent, void* underlay, char* name_fmt, ...);
+static inline struct device*
+device_allocseq(struct device* parent, void* underlay)
+{
+    return device_alloc(parent, DEV_IFSEQ, underlay);
+}
 
-struct device*
-device_addvol(struct device* parent, void* underlay, char* name_fmt, ...);
+static inline struct device*
+device_allocvol(struct device* parent, void* underlay)
+{
+    return device_alloc(parent, DEV_IFVOL, underlay);
+}
 
 struct device*
 device_addcat(struct device* parent, char* name_fmt, ...);
@@ -161,7 +172,7 @@ void
 device_remove(struct device* dev);
 
 struct device*
-device_getbyid(struct llist_header* devlist, dev_t id);
+device_getbyid(struct llist_header* devlist, u32_t id);
 
 struct device*
 device_getbyhname(struct device* root_dev, struct hstr* name);
@@ -173,16 +184,19 @@ struct device*
 device_getbyoffset(struct device* root_dev, int pos);
 
 struct device*
-device_create_byclass(struct devclass* class,
-                      u32_t type,
-                      char* name,
-                      int* err_code);
+device_cast(void* obj);
 
 struct hbucket*
 device_definitions_byif(int if_type);
 
+struct device_def*
+devdef_byident(struct devident* class);
+
 void
-device_register_all();
+device_populate_info(struct device* dev, struct dev_info* devinfo);
+
+void
+device_scan_drivers();
 
 /*------ Load hooks ------*/
 
@@ -195,4 +209,24 @@ device_poststage();
 void
 device_timerstage();
 
+static inline void
+device_lock(struct device* dev)
+{
+    mutex_lock(&dev->lock);
+}
+
+static inline void
+device_unlock(struct device* dev)
+{
+    mutex_unlock(&dev->lock);
+}
+
+static inline int
+device_locked(struct device* dev)
+{
+    return mutex_on_hold(&dev->lock);
+}
+
+#define devprintf_expand(devident) (devident)->fn_grp, (devident)->unique
+
 #endif /* __LUNAIX_DEVICE_H */