chiark / gitweb /
[PATCH] libsysfs update for refresh + namedev.c changes
[elogind.git] / libsysfs / sysfs_driver.c
index f8e842c65c9b0a91763eebefffce91d898d65eaf..a4440cfdf9f9e5daa4a7f42c1f4682e8192b0de8 100644 (file)
 #include "libsysfs.h"
 #include "sysfs.h"
 
-static void sysfs_close_driver_by_name_dev(void *device)
+static void sysfs_close_driver_device(void *device)
 {
        sysfs_close_device((struct sysfs_device *)device);
 }
 
-/**
- * sysfs_close_driver: closes and cleans up driver structure
- * NOTE: This routine does not deallocate devices list
- * @driver: driver to close
- */
-void sysfs_close_driver(struct sysfs_driver *driver)
-{
-       if (driver != NULL) {
-               if (driver->devices != NULL) {
-                       dlist_for_each(driver->devices) 
-                               dlist_shift(driver->devices);
-                       free(driver->devices);
-                       driver->devices = NULL;
-               }
-               if (driver->directory != NULL)
-                       sysfs_close_directory(driver->directory);
-               free(driver);
-       }
-}
-
 /** 
- * sysfs_close_driver_by_name: closes driver and deletes device lists too
+ * sysfs_close_driver: closes driver and deletes device lists too
  * @driver: driver to close
  */ 
-void sysfs_close_driver_by_name(struct sysfs_driver *driver)
+void sysfs_close_driver(struct sysfs_driver *driver)
 {
        if (driver != NULL) {
                if (driver->devices != NULL) 
@@ -63,6 +43,28 @@ void sysfs_close_driver_by_name(struct sysfs_driver *driver)
        }
 }
                
+/**
+ * open_driver_dir: Open the sysfs_directory for this driver
+ * @driver: Driver whose directory to be opened
+ * Returns 0 on success and 1 on failure
+ */ 
+static int open_driver_dir(struct sysfs_driver *driver)
+{
+       if (driver == NULL) {
+               errno = EINVAL;
+               return 1;
+       }
+       if (driver->directory == NULL) {
+               driver->directory = sysfs_open_directory(driver->path);
+               if (driver->directory == NULL) {
+                       dprintf("Error opening driver directory at %s\n", 
+                                       driver->path);
+                       return 1;
+               }
+       }
+       return 0;
+}
+
 /**
  * alloc_driver: allocates and initializes driver
  * returns struct sysfs_driver with success and NULL with error.
@@ -73,38 +75,39 @@ static struct sysfs_driver *alloc_driver(void)
 }
 
 /**
- * sysfs_open_driver: opens and initializes driver structure
+ * sysfs_open_driver_path: opens and initializes driver structure
  * @path: path to driver directory
  * returns struct sysfs_driver with success and NULL with error
  */
-struct sysfs_driver *sysfs_open_driver(const unsigned char *path)
+struct sysfs_driver *sysfs_open_driver_path(const unsigned char *path)
 {
        struct sysfs_driver *driver = NULL;
-       struct sysfs_directory *sdir = NULL;
 
        if (path == NULL) {
                errno = EINVAL;
                return NULL;
        }
-       sdir = sysfs_open_directory(path);
-       if (sdir == NULL) {
-               dprintf("Error opening directory %s\n", path);
-               return NULL;
-       }
-       if ((sysfs_read_directory(sdir)) != 0) {
-               dprintf("Error reading directory %s\n", path);
-               sysfs_close_directory(sdir);
+       if ((sysfs_path_is_dir(path)) != 0) {
+               dprintf("Invalid path to driver: %s\n", path);
                return NULL;
        }
        driver = alloc_driver();
        if (driver == NULL) {
                dprintf("Error allocating driver at %s\n", path);
-               sysfs_close_directory(sdir);
                return NULL;
        }
-       strcpy(driver->name, sdir->name);
-       driver->directory = sdir;       
-       strcpy(driver->path, sdir->path);
+       if ((sysfs_get_name_from_path(path, driver->name, 
+                                       SYSFS_NAME_LEN)) != 0) {
+               dprintf("Error getting driver name from path\n");
+               free(driver);
+               return NULL;
+       }
+       strcpy(driver->path, path);
+       if ((sysfs_remove_trailing_slash(driver->path)) != 0) {
+               dprintf("Invalid path to driver %s\n", driver->path);
+               sysfs_close_driver(driver);
+               return NULL;
+       }
        
        return driver;
 }
@@ -117,12 +120,47 @@ struct sysfs_driver *sysfs_open_driver(const unsigned char *path)
  */
 struct dlist *sysfs_get_driver_attributes(struct sysfs_driver *driver)
 {
-       if (driver == NULL || driver->directory == NULL)
+       if (driver == NULL) {
+               errno = EINVAL;
                return NULL;
+       }
 
+       if (driver->directory == NULL) {
+               if ((open_driver_dir(driver)) == 1) 
+                       return NULL;
+       }
+       if (driver->directory->attributes == NULL) {
+               if ((sysfs_read_dir_attributes(driver->directory)) != 0) 
+                       return NULL;
+       }
        return(driver->directory->attributes);
 }
 
+/**
+ * sysfs_refresh_driver_attributes: refreshes the driver's list of attributes
+ * @driver: sysfs_driver whose attributes to refresh
+ *
+ * NOTE: Upon return, prior references to sysfs_attributes for this driver
+ *             _may_ not be valid
+ *             
+ * Returns list of attributes on success and NULL on failure
+ */
+struct dlist *sysfs_refresh_driver_attributes(struct sysfs_driver *driver)
+{
+       if (driver == NULL) {
+               errno = EINVAL;
+               return NULL;
+       }
+       if (driver->directory == NULL)
+               return (sysfs_get_driver_attributes(driver));
+       
+       if ((sysfs_refresh_dir_attributes(driver->directory)) != 0) {
+               dprintf("Error refreshing driver attributes\n");
+               return NULL;
+       }
+       return (driver->directory->attributes);
+}
+
 /**
  * sysfs_get_driver_attr: searches driver's attributes by name
  * @drv: driver to look through
@@ -132,20 +170,19 @@ struct dlist *sysfs_get_driver_attributes(struct sysfs_driver *driver)
 struct sysfs_attribute *sysfs_get_driver_attr(struct sysfs_driver *drv,
                                        const unsigned char *name)
 {
-       struct sysfs_attribute *cur = NULL;
+       struct dlist *attrlist = NULL;
 
-        if (drv == NULL || drv->directory == NULL
-            || drv->directory->attributes == NULL || name == NULL) {
+        if (drv == NULL) {
                 errno = EINVAL;
                 return NULL;
         }
+       
+       attrlist = sysfs_get_driver_attributes(drv);
+       if (attrlist != NULL) 
+               return NULL;
 
-        cur = sysfs_get_directory_attribute(drv->directory,
-                                       (unsigned char *)name);
-        if (cur != NULL)
-                return cur;
-
-        return NULL;
+       return sysfs_get_directory_attribute(drv->directory,
+                                               (unsigned char *)name);
 }
 
 /**
@@ -156,212 +193,229 @@ struct sysfs_attribute *sysfs_get_driver_attr(struct sysfs_driver *drv,
  */
 struct dlist *sysfs_get_driver_links(struct sysfs_driver *driver)
 {
-       if (driver == NULL || driver->directory == NULL)
+       if (driver == NULL) {
+               errno = EINVAL;
                return NULL;
-
+       }
+       if (driver->directory == NULL) {
+               if ((open_driver_dir(driver)) == 1)
+                       return NULL;
+               if ((sysfs_read_dir_links(driver->directory)) != 0) 
+                       return NULL;
+       }
        return(driver->directory->links);
 }
 
 /**
- * sysfs_open_driver_by_name: open a driver by name and return the bus
- * the driver is on.
- * @drv_name: driver to open
- * @bus: the driver bus
- * @bsize: size of bus buffer
- * returns struct sysfs_driver if found, NULL otherwise
- * NOTE: 
- * 1. Need to call sysfs_close_driver_by_name to free up memory
- * 2. Bus the driver is registered with must be supplied.
- *     Use sysfs_find_driver_bus() to obtain the bus name
- */
-struct sysfs_driver *sysfs_open_driver_by_name(const unsigned char *drv_name,
-                               const unsigned char *bus, size_t bsize)
+ * sysfs_get_driver_devices: open up the list of devices this driver supports
+ * @driver: sysfs_driver for which devices are needed
+ * Returns dlist of devices on SUCCESS or NULL with ERROR
+ */ 
+struct dlist *sysfs_get_driver_devices(struct sysfs_driver *driver)
 {
-       struct sysfs_driver *driver = NULL;
-       struct sysfs_device *device = NULL;
        struct sysfs_link *curlink = NULL;
-       unsigned char path[SYSFS_PATH_MAX];
+       struct sysfs_device *device = NULL;
 
-       if (drv_name == NULL || bus == NULL) {
+       if (driver == NULL) {
                errno = EINVAL;
                return NULL;
        }
+       
+       if (driver->devices != NULL)
+               return (driver->devices);
 
-       memset(path, 0, SYSFS_PATH_MAX);
-       if (sysfs_get_mnt_path(path, SYSFS_PATH_MAX) != 0) {
-               dprintf("Error getting sysfs mount path\n");
-               return NULL;
-       }
-       strcat(path, SYSFS_BUS_DIR);
-       strcat(path, "/");
-       strcat(path, bus);
-       strcat(path, SYSFS_DRIVERS_DIR);
-       strcat(path, "/");
-       strcat(path, drv_name);
-       driver = sysfs_open_driver(path);
-       if (driver == NULL) {
-               dprintf("Could not open driver %s\n", drv_name);
-               return NULL;
+       if (driver->directory == NULL) {
+               if ((open_driver_dir(driver)) == 1) 
+                       return NULL;
+               if ((sysfs_read_dir_links(driver->directory)) != 0) 
+                       return NULL;
        }
        if (driver->directory->links != NULL) {
                dlist_for_each_data(driver->directory->links, curlink, 
-                                                       struct sysfs_link) {
-                       device = sysfs_open_device(curlink->target);
+                                               struct sysfs_link) {
+                       device = sysfs_open_device_path(curlink->target);
                        if (device == NULL) {
                                dprintf("Error opening device at %s\n", 
                                                curlink->target);
-                               sysfs_close_driver_by_name(driver);
                                return NULL;
                        }
-                       strcpy(device->driver_name, drv_name);
+                       strcpy(device->driver_name, driver->name);
                        if (driver->devices == NULL) 
                                driver->devices = dlist_new_with_delete
                                                (sizeof(struct sysfs_device),
-                                                       sysfs_close_driver_by_name_dev);
+                                                sysfs_close_driver_device);
                        dlist_unshift(driver->devices, device);
                }
        }
-       return driver;
+       return (driver->devices);
+}
+
+/**
+ * sysfs_refresh_driver_devices: Refreshes drivers list of devices
+ * @driver: sysfs_driver whose devices list needs to be refreshed
+ *
+ * NOTE: Upon return from this function, prior sysfs_device references from
+ *             this driver's list of devices _may_ not be valid
+ *             
+ * Returns dlist of devices on success and NULL on failure
+ */
+struct dlist *sysfs_refresh_driver_devices(struct sysfs_driver *driver)
+{
+       if (driver == NULL) {
+               errno = EINVAL;
+               return NULL;
+       }
+       
+       if (driver->devices != NULL) {
+               dlist_destroy(driver->devices);
+               driver->devices = NULL;
+       }
+       
+       if (driver->directory == NULL)
+               return (sysfs_get_driver_devices(driver));
+
+       if ((sysfs_refresh_dir_links(driver->directory)) != 0) {
+               dprintf("Error refreshing driver links\n");
+               return NULL;
+       }
+       
+       return (sysfs_get_driver_devices(driver));
+}
+
+/**
+ * sysfs_get_driver_device: looks up a device from a list of driver's devices
+ *     and returns its sysfs_device corresponding to it
+ * @driver: sysfs_driver on which to search
+ * @name: name of the device to search
+ * Returns a sysfs_device if found, NULL otherwise
+ */
+struct sysfs_device *sysfs_get_driver_device(struct sysfs_driver *driver,
+                               const unsigned char *name)
+{
+       struct sysfs_device *device = NULL;
+       struct dlist *devlist = NULL;
+
+       if (driver == NULL || name == NULL) {
+               errno = EINVAL;
+               return NULL;
+       }
+
+       if (driver->devices == NULL) {
+               devlist = sysfs_get_driver_devices(driver);
+               if (devlist == NULL) {
+                       dprintf("Error getting driver devices\n");
+                       return NULL;
+               }
+       }
+       dlist_for_each_data(driver->devices, device, struct sysfs_device) {
+               if (!(strncmp(device->name, name, SYSFS_NAME_LEN)))
+                       return device;
+       }
+       return NULL;
 }
 
 /**
  * get_driver_path: looks up the bus the driver is on and builds path to
  *             the driver.
+ * @bus: bus on which to search
  * @drv: driver to look for
  * @path: buffer to return path to driver
  * @psize: size of "path"
  * Returns 0 on success and -1 on error
  */
-static int get_driver_path(const unsigned char *drv
-                               unsigned char *path, size_t psize)
+static int get_driver_path(const unsigned char *bus
+               const unsigned char *drv, unsigned char *path, size_t psize)
 {
-       unsigned char bus_name[SYSFS_NAME_LEN];
-
-       if (drv == NULL || path == NULL) {
+       if (bus == NULL || drv == NULL || path == NULL) {
                errno = EINVAL;
                return -1;
        }
-       memset(bus_name, 0, SYSFS_NAME_LEN);
-       memset(path, 0, SYSFS_PATH_MAX);
-       if ((sysfs_find_driver_bus(drv, bus_name, SYSFS_NAME_LEN)) < 0) {
-               dprintf("Driver %s not found\n", drv);
-               return -1;
-       }
-       if (sysfs_get_mnt_path(path, SYSFS_PATH_MAX) != 0) {
+       if (sysfs_get_mnt_path(path, psize) != 0) {
                dprintf("Error getting sysfs mount path\n");
                return -1;
        }
-       strcat(path, SYSFS_BUS_DIR);
        strcat(path, "/");
-       strcat(path, bus_name);
-       strcat(path, SYSFS_DRIVERS_DIR);
+       strcat(path, SYSFS_BUS_NAME);
+       strcat(path, "/");
+       strcat(path, bus);
+       strcat(path, "/");
+       strcat(path, SYSFS_DRIVERS_NAME);
        strcat(path, "/");
        strcat(path, drv);
-       fprintf(stdout, "get_driver_path %s\n", path);
        return 0;
 }
 
 /**
- * sysfs_write_driver_attr: modify "writable" driver attribute
- * @drv: driver whose attribute has to be modified
- * @attrib: Attribute to be modified
- * @value: Value to change to
- * Returns 0 on success -1 on failure
+ * sysfs_open_driver_attr: read the user supplied driver attribute
+ * @bus: bus on which to look 
+ * @drv: driver whose attribute has to be read
+ * @attrib: Attribute to be read
+ * Returns struct sysfs_attribute on success and NULL on failure
+ *
+ * NOTE:
+ *     A call to sysfs_close_attribute() is required to close the
+ *     attribute returned and to free memory
  */ 
-int sysfs_write_driver_attr(unsigned char *drv, unsigned char *attrib,
-                                       unsigned char *value, size_t len)
+struct sysfs_attribute *sysfs_open_driver_attr(const unsigned char *bus, 
+               const unsigned char *drv, const unsigned char *attrib)
 {
        struct sysfs_attribute *attribute = NULL;
        unsigned char path[SYSFS_PATH_MAX];
 
-       if (drv == NULL || attrib == NULL || value == NULL) {
+       if (bus == NULL || drv == NULL || attrib == NULL) {
                errno = EINVAL;
-               return -1;
+               return NULL;
        }
 
        memset(path, 0, SYSFS_PATH_MAX);
-       if ((get_driver_path(drv, path, SYSFS_PATH_MAX)) != 0) {
+       if ((get_driver_path(bus, drv, path, SYSFS_PATH_MAX)) != 0) {
                dprintf("Error getting to driver %s\n", drv);
-               return -1;
+               return NULL;
        }
        strcat(path, "/");
        strcat(path, attrib);
        attribute = sysfs_open_attribute(path);
         if (attribute == NULL) {
-                dprintf("Attribute %s could not be retrieved for driver %s\n",
-                                                       attrib, drv);
-               return -1;
-       }
-       if (attribute->method & SYSFS_METHOD_SHOW) {
-               if ((sysfs_read_attribute(attribute)) != 0) {
-                       dprintf("Error reading attribute %s for driver %s\n",
-                                       attrib, drv);
-                       sysfs_close_attribute(attribute);
-                       return -1;
-               }
+               dprintf("Error opening attribute %s for driver %s\n",
+                               attrib, drv);
+               return NULL;
        }
-       if ((sysfs_write_attribute(attribute, value, len)) < 0) {
-               dprintf("Error setting %s to %s\n", attrib, value);
+       if ((sysfs_read_attribute(attribute)) != 0) {
+                dprintf("Error reading attribute %s for driver %s\n", 
+                               attrib, drv);
                sysfs_close_attribute(attribute);
-               return -1;
+               return NULL;
        }
-       sysfs_close_attribute(attribute);
-       return 0;
+       return attribute;
 }
 
 /**
- * sysfs_read_driver_attr: read the user supplied driver attribute
- * @drv: driver whose attribute has to be read
- * @attrib: Attribute to be read
- * @value: Buffer to return the read value
- * @len: Length of the buffer "value"
- * Returns 0 on success -1 on failure
- */ 
-int sysfs_read_driver_attr(unsigned char *drv, unsigned char *attrib,
-                                       unsigned char *value, size_t len)
+ * sysfs_open_driver: open driver by name, given its bus
+ * @drv_name: Name of the driver
+ * @bus_name: Name of the bus
+ * Returns the sysfs_driver reference on success and NULL on failure
+ */
+struct sysfs_driver *sysfs_open_driver(const unsigned char *drv_name,
+                               const unsigned char *bus_name)
 {
-       struct sysfs_attribute *attribute = NULL;
        unsigned char path[SYSFS_PATH_MAX];
+       struct sysfs_driver *driver = NULL;
 
-       if (drv == NULL || attrib == NULL || value == NULL) {
+       if (drv_name == NULL || bus_name == NULL) {
                errno = EINVAL;
-               return -1;
+               return NULL;
        }
 
-       memset(path, 0, SYSFS_NAME_LEN);
-       if ((get_driver_path(drv, path, SYSFS_PATH_MAX)) != 0) {
-               dprintf("Error getting to driver %s\n", drv);
-               return -1;
-       }
-       strcat(path, "/");
-       strcat(path, attrib);
-       attribute = sysfs_open_attribute(path);
-        if (attribute == NULL) {
-               dprintf("Error opening attribute %s for driver %s\n",
-                               attrib, drv);
-               return -1;
-       }
-       if (!(attribute->method & SYSFS_METHOD_SHOW)) {
-               dprintf("Show method not supported for attribute %s\n",
-                               attrib);
-               sysfs_close_attribute(attribute);
-               return -1;
-       }
-       if ((sysfs_read_attribute(attribute)) != 0) {
-                dprintf("Error reading attribute %s for driver %s\n", 
-                               attrib, drv);
-               sysfs_close_attribute(attribute);
-               return -1;
+       memset(path, 0, SYSFS_PATH_MAX);
+       if ((get_driver_path(bus_name, drv_name, path, SYSFS_PATH_MAX)) != 0) {
+               dprintf("Error getting to driver %s\n", drv_name);
+               return NULL;
        }
-       if (attribute->len > len) {
-               dprintf("Value length %d is larger than supplied buffer %d\n",
-                               attribute->len, len);
-               sysfs_close_attribute(attribute);
-               return -1;
+       driver = sysfs_open_driver_path(path);
+       if (driver == NULL) {
+               dprintf("Error opening driver at %s\n", path);
+               return NULL;
        }
-       strncpy(value, attribute->value, attribute->len);
-       value[(attribute->len)+1] = 0;
-       sysfs_close_attribute(attribute);
-       return 0;
+       return driver;
 }