Changeset 48197c1 in mainline

Timestamp:

2017-06-15T19:04:29Z (7 years ago)

Author:

Ondřej Hlavatý <aearsis@…>

Branches:

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

Children:

ce6e001

Parents:

5cbccd4

Message:

xhci: completed register access macros (+tests)

Files:

• boot/Makefile.common (modified) (1 diff)
• uspace/drv/bus/usb/xhci/Makefile (modified) (1 diff)
• uspace/drv/bus/usb/xhci/hw_struct/regs.h (modified) (1 diff)
• uspace/lib/c/include/bitops.h (modified) (1 diff)

boot/Makefile.common

@@ -235 +235 @@
         $(USPACE_PATH)/lib/posix/test-libposix \
         $(USPACE_PATH)/lib/uri/test-liburi \
+        $(USPACE_PATH)/drv/bus/usb/xhci/test-xhci \
         $(USPACE_PATH)/app/bdsh/test-bdsh
 

uspace/drv/bus/usb/xhci/Makefile

@@ -47 +47 @@
         main.c
 
+TEST_SOURCES = \
+        test/reg-ops.c
+
 include $(USPACE_PREFIX)/Makefile.common

uspace/drv/bus/usb/xhci/hw_struct/regs.h

@@ -45 +45 @@
  * provide flexible interface abstracting from the real storage of given
  * register, but to avoid having to specify several constants per register.
- *
- * The key thing here is the order of macro expansion, expanding one argument
- * as more arguments (comma delimited) for another macro.
- */
+ */
+
+#define XHCI_PIO_CHANGE_UDELAY 5
 
 #define host2xhci(size, val) host2uint##size##_t_le((val))
 #define xhci2host(size, val) uint##size##_t_le2host((val))
 
-#define XHCI_REG_RD_FIELD(ptr, size) \
-        xhci2host(size, pio_read_##size((ptr)))
-
-#define XHCI_REG_RD_RANGE(ptr, size, hi, lo) \
-        BIT_RANGE_EXTRACT(uint##size##_t, hi, lo, XHCI_REG_RD_FIELD((ptr), size))
-
-#define XHCI_REG_RD_FLAG(ptr, size, offset) \
-        XHCI_REG_RD_RANGE((ptr), size, offset, offset)
-
+/*
+ * These four are the main macros to be used.
+ * Semantics is usual - READ reads value, WRITE changes value, SET sets
+ * selected bits, CLEAR clears selected bits to 0.
+ *
+ * The key thing here is the order of macro expansion, expanding the reg_spec
+ * argument as more arguments (comma delimited) for the inner macro.
+ */
+#define XHCI_REG_RD(reg_set, reg_spec)         XHCI_REG_RD_INNER(reg_set, reg_spec)
+#define XHCI_REG_WR(reg_set, reg_spec, value)  XHCI_REG_WR_INNER(reg_set, value, reg_spec)
+#define XHCI_REG_SET(reg_set, reg_spec, value) XHCI_REG_SET_INNER(reg_set, value, reg_spec)
+#define XHCI_REG_CLR(reg_set, reg_spec, value) XHCI_REG_CLR_INNER(reg_set, value, reg_spec)
+
+/*
+ * These take a pointer to the field, and selects the type-specific macro.
+ */
 #define XHCI_REG_RD_INNER(reg_set, field, size, type, ...) \
         XHCI_REG_RD_##type(&((reg_set)->field), size, ##__VA_ARGS__)
 
-#define XHCI_REG_RD(reg_set, reg_spec) XHCI_REG_RD_INNER(reg_set, reg_spec)
-
-#define XHCI_REG_SET_FIELD(ptr, value, size) \
-        pio_write_##size((ptr), host2xhci(size, value))
-
-#define XHCI_REG_SET_RANGE(ptr, value, size, hi, lo) \
-        pio_change_##size((ptr), host2xhci(size, (value) << (lo)), host2xhci(size, BIT_RANGE(uint##size##_t, hi, lo)), 5);
-
-#define XHCI_REG_SET_FLAG(ptr, value, size, offset) \
-        XHCI_REG_SET_RANGE(ptr, value, size, offset, offset)
+#define XHCI_REG_WR_INNER(reg_set, value, field, size, type, ...) \
+        XHCI_REG_WR_##type(&(reg_set)->field, value, size, ##__VA_ARGS__)
 
 #define XHCI_REG_SET_INNER(reg_set, value, field, size, type, ...) \
         XHCI_REG_SET_##type(&(reg_set)->field, value, size, ##__VA_ARGS__)
 
-#define XHCI_REG_SET(reg_set, reg_spec) XHCI_REG_SET_INNER(reg_set, value, reg_spec)
+#define XHCI_REG_CLR_INNER(reg_set, value, field, size, type, ...) \
+        XHCI_REG_CLR_##type(&(reg_set)->field, value, size, ##__VA_ARGS__)
+
+/*
+ * Field handling is the easiest. Just do it with whole field.
+ */
+#define XHCI_REG_RD_FIELD(ptr, size)         xhci2host(size, pio_read_##size((ptr)))
+#define XHCI_REG_WR_FIELD(ptr, value, size)  pio_write_##size((ptr), host2xhci(size, value))
+#define XHCI_REG_SET_FIELD(ptr, value, size) pio_set_##size((ptr), host2xhci(size, value), XHCI_PIO_CHANGE_UDELAY);
+#define XHCI_REG_CLR_FIELD(ptr, value, size) pio_clear_##size((ptr), host2xhci(size, value), XHCI_PIO_CHANGE_UDELAY);
+
+/*
+ * Flags are just trivial case of ranges.
+ */
+#define XHCI_REG_RD_FLAG(ptr, size, offset)         XHCI_REG_RD_RANGE((ptr), size, (offset), (offset))
+#define XHCI_REG_WR_FLAG(ptr, value, size, offset)  XHCI_REG_WR_RANGE((ptr), (value), size, (offset), (offset))
+#define XHCI_REG_SET_FLAG(ptr, value, size, offset) XHCI_REG_SET_RANGE((ptr), (value), size, (offset), (offset))
+#define XHCI_REG_CLR_FLAG(ptr, value, size, offset) XHCI_REG_CLR_RANGE((ptr), (value), size, (offset), (offset))
+
+/*
+ * Ranges are the most difficult. We need to play around with bitmasks.
+ */
+#define XHCI_REG_RD_RANGE(ptr, size, hi, lo) \
+        BIT_RANGE_EXTRACT(uint##size##_t, (hi), (lo), XHCI_REG_RD_FIELD((ptr), size))
+
+#define XHCI_REG_WR_RANGE(ptr, value, size, hi, lo) \
+        pio_change_##size((ptr), host2xhci(size, BIT_RANGE_INSERT(uint##size##_t, (hi), (lo), (value))), \
+                host2xhci(size, BIT_RANGE(uint##size##_t, (hi), (lo))), \
+                XHCI_PIO_CHANGE_UDELAY);
+
+#define XHCI_REG_SET_RANGE(ptr, value, size, hi, lo) \
+        pio_set_##size((ptr), host2xhci(size, BIT_RANGE_INSERT(uint##size##_t, (hi), (lo), (value))), \
+                XHCI_PIO_CHANGE_UDELAY);
+
+#define XHCI_REG_CLR_RANGE(ptr, value, size, hi, lo) \
+        pio_clear_##size((ptr), host2xhci(size, BIT_RANGE_INSERT(uint##size##_t, (hi), (lo), (value))), \
+                XHCI_PIO_CHANGE_UDELAY);
 
 /*

uspace/lib/c/include/bitops.h

@@ -54 +54 @@
 #define BIT_RANGE_EXTRACT(type, hi, lo, value) \
     (((value) >> (lo)) & BIT_RRANGE(type, (hi) - (lo) + 1))
+
+/** Insert @a value between bits @a hi .. @a lo. */
+#define BIT_RANGE_INSERT(type, hi, lo, value) \
+    (((value) & BIT_RRANGE(type, (hi) - (lo) + 1)) << (lo))
 
 /** Return position of first non-zero bit from left (i.e. [log_2(arg)]).