Changeset ddd0499d in mainline for uspace/lib/c/generic/device/hw_res_parsed.c

Timestamp:

2013-09-12T22:05:13Z (11 years ago)

Author:

Jakub Jermar <jakub@…>

Branches:

lfn, master, serial, ticket/834-toolchain-update, topic/msim-upgrade, topic/simplify-dev-export

Children:

4285851

Parents:

695b6ff (diff), 7de1988c (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:

Support for PIO window-relative and absolute HW resource ranges.

The goal of this merge is to allow bus drivers to pass resources with IO
and memory ranges to the child drivers either in the PIO window-relative
form or system bus absolute form. Using the PIO window and the
relative/absolute attribute of a range, each driver can now reconstruct
both forms. Helper functions are provided to automate these
transformations as much as possible.

Changes in this merge in a greater detail:

• Support for PIO_WINDOW_DEV_IFACE in isa so that it can provide the PIO window to its children.

• Add 'relative' member to both hw_resource_t.res.mem_range and hw_resource_t.res.io_range so that the drivers can actually tell whether a range is absolute (eg. it was absolutized by its parent).

• Add pio_enable_resource() to allow drivers to enable PIO without the need to actually care about what kind of range the resource contains. This is used by pci now.

• Automate things even more for drivers that use hw_res_get_list_parsed(). The parsed HW resources compute both forms (relative/absolute) and offer it to the driver which is using them. Such a driver then uses whatever form is more fit for it and its purposes.

• Drivers using the parsed resources can use pio_enable_range() to enable PIO and RNGABS*()/RNGREL()/RNGSZ courtesy macros for easier access to the actual range address/size are provided.

• Device drivers affected by these API changes were converted.

• uhcirh now requires uhci to provide PIO_WINDOW_DEV_IFACE; however, the uhcirh driver is removed in the feature USB branch so there was no point in implementing this feature and UHCI USB is thus temporarily broken.

File:

• uspace/lib/c/generic/device/hw_res_parsed.c (modified) (8 diffs)

uspace/lib/c/generic/device/hw_res_parsed.c

@@ -80 +80 @@
 }
 
+static uint64_t absolutize(uint64_t addr, bool relative, uint64_t base)
+{
+        if (!relative)
+                return addr;
+        else
+                return addr + base;
+}
+
+static uint64_t relativize(uint64_t addr, bool relative, uint64_t base)
+{
+        if (relative)
+                return addr;
+        else
+                return addr - base;
+}
+
 static void hw_res_parse_add_io_range(hw_res_list_parsed_t *out,
-    const hw_resource_t *res, int flags)
-{
+    const pio_window_t *win, const hw_resource_t *res, int flags)
+{
+        endianness_t endianness;
+        uint64_t absolute;
+        uint64_t relative;
+        size_t size;
+
         assert(res && (res->type == IO_RANGE));
         
-        uint64_t address = res->res.io_range.address;
-        endianness_t endianness = res->res.io_range.endianness;
-        size_t size = res->res.io_range.size;
+        absolute = absolutize(res->res.io_range.address,
+            res->res.io_range.relative, win->io.base);
+        relative = relativize(res->res.io_range.address,
+            res->res.io_range.relative, win->io.base);
+        size = res->res.io_range.size;
+        endianness = res->res.io_range.endianness;
         
         if ((size == 0) && (!(flags & HW_RES_KEEP_ZERO_AREA)))
@@ -97 +121 @@
         if (!keep_duplicit) {
                 for (size_t i = 0; i < count; i++) {
-                        uint64_t s_address = out->io_ranges.ranges[i].address;
-                        size_t s_size = out->io_ranges.ranges[i].size;
+                        uint64_t s_address;
+                        size_t s_size;
+
+                        s_address = RNGABS(out->io_ranges.ranges[i]);
+                        s_size = RNGSZ(out->io_ranges.ranges[i]);
                         
-                        if ((address == s_address) && (size == s_size))
-                                return;
-                }
-        }
-        
-        out->io_ranges.ranges[count].address = address;
+                        if ((absolute == s_address) && (size == s_size))
+                                return;
+                }
+        }
+        
+        RNGABS(out->io_ranges.ranges[count]) = absolute;
+        RNGREL(out->io_ranges.ranges[count]) = relative;
+        RNGSZ(out->io_ranges.ranges[count]) = size;
         out->io_ranges.ranges[count].endianness = endianness;
-        out->io_ranges.ranges[count].size = size;
         out->io_ranges.count++;
 }
 
 static void hw_res_parse_add_mem_range(hw_res_list_parsed_t *out,
-    const hw_resource_t *res, int flags)
-{
+    const pio_window_t *win, const hw_resource_t *res, int flags)
+{
+        endianness_t endianness;
+        uint64_t absolute;
+        uint64_t relative;
+        size_t size;
+        
         assert(res && (res->type == MEM_RANGE));
         
-        uint64_t address = res->res.mem_range.address;
-        endianness_t endianness = res->res.mem_range.endianness;
-        size_t size = res->res.mem_range.size;
+        absolute = absolutize(res->res.mem_range.address,
+            res->res.mem_range.relative, win->mem.base);
+        relative = relativize(res->res.mem_range.address,
+            res->res.mem_range.relative, win->mem.base);
+        size = res->res.mem_range.size;
+        endianness = res->res.mem_range.endianness;
         
         if ((size == 0) && (!(flags & HW_RES_KEEP_ZERO_AREA)))
@@ -128 +164 @@
         if (!keep_duplicit) {
                 for (size_t i = 0; i < count; ++i) {
-                        uint64_t s_address = out->mem_ranges.ranges[i].address;
-                        size_t s_size = out->mem_ranges.ranges[i].size;
+                        uint64_t s_address;
+                        size_t s_size;
+
+                        s_address = RNGABS(out->mem_ranges.ranges[i]);;
+                        s_size = RNGSZ(out->mem_ranges.ranges[i]);
                         
-                        if ((address == s_address) && (size == s_size))
-                                return;
-                }
-        }
-        
-        out->mem_ranges.ranges[count].address = address;
+                        if ((absolute == s_address) && (size == s_size))
+                                return;
+                }
+        }
+        
+        RNGABS(out->mem_ranges.ranges[count]) = absolute;
+        RNGREL(out->mem_ranges.ranges[count]) = relative;
+        RNGSZ(out->mem_ranges.ranges[count]) = size;
         out->mem_ranges.ranges[count].endianness = endianness;
-        out->mem_ranges.ranges[count].size = size;
         out->mem_ranges.count++;
 }
@@ -144 +184 @@
 /** Parse list of hardware resources
  *
- * @param      hw_resources Original structure resource
- * @param[out] out          Output parsed resources
- * @param      flags        Flags of the parsing.
- *                          HW_RES_KEEP_ZERO_AREA for keeping
- *                          zero-size areas, HW_RES_KEEP_DUPLICITIES
- *                          for keep duplicit areas
+ * @param      win          PIO window.
+ * @param      res          Original structure resource.
+ * @param[out] out          Output parsed resources.
+ * @param      flags        Flags of the parsing:
+ *                          HW_RES_KEEP_ZERO_AREA for keeping zero-size areas,
+ *                          HW_RES_KEEP_DUPLICITIES to keep duplicit areas.
  *
  * @return EOK if succeed, error code otherwise.
  *
  */
-int hw_res_list_parse(const hw_resource_list_t *hw_resources,
-    hw_res_list_parsed_t *out, int flags)
-{
-        if ((!hw_resources) || (!out))
+int hw_res_list_parse(const pio_window_t *win,
+    const hw_resource_list_t *res, hw_res_list_parsed_t *out, int flags)
+{
+        if (!res || !out)
                 return EINVAL;
         
-        size_t res_count = hw_resources->count;
+        size_t res_count = res->count;
         hw_res_list_parsed_clean(out);
         
@@ -174 +214 @@
         
         for (size_t i = 0; i < res_count; ++i) {
-                const hw_resource_t *resource = &(hw_resources->resources[i]);
+                const hw_resource_t *resource = &res->resources[i];
                 
                 switch (resource->type) {
@@ -181 +221 @@
                         break;
                 case IO_RANGE:
-                        hw_res_parse_add_io_range(out, resource, flags);
+                        hw_res_parse_add_io_range(out, win, resource, flags);
                         break;
                 case MEM_RANGE:
-                        hw_res_parse_add_mem_range(out, resource, flags);
+                        hw_res_parse_add_mem_range(out, win, resource, flags);
                         break;
                 case DMA_CHANNEL_8:
@@ -216 +256 @@
     hw_res_list_parsed_t *hw_res_parsed, int flags)
 {
+        pio_window_t pio_window;
+        int rc;
+
         if (!hw_res_parsed)
                 return EBADMEM;
@@ -222 +265 @@
         hw_res_list_parsed_clean(hw_res_parsed);
         memset(&hw_resources, 0, sizeof(hw_resource_list_t));
-        
-        int rc = hw_res_get_resource_list(sess, &hw_resources);
+
+        rc = pio_window_get(sess, &pio_window);
+        if (rc != EOK)
+                return rc; 
+        
+        rc = hw_res_get_resource_list(sess, &hw_resources);
         if (rc != EOK)
                 return rc;
-        
-        rc = hw_res_list_parse(&hw_resources, hw_res_parsed, flags);
+
+        rc = hw_res_list_parse(&pio_window, &hw_resources, hw_res_parsed,
+            flags);
         hw_res_clean_resource_list(&hw_resources);