summaryrefslogtreecommitdiff
path: root/drivers/staging/rar_register/rar_register.h
diff options
context:
space:
mode:
authorMark Allyn <mark.a.allyn@intel.com>2010-02-05 18:52:26 (GMT)
committerGreg Kroah-Hartman <gregkh@suse.de>2010-03-04 00:42:56 (GMT)
commite33cc5cec039ac6aef68568c06998707bceb0953 (patch)
tree61e06e1a2a8fbf7af4fda3e92c9e2c07e9cf7976 /drivers/staging/rar_register/rar_register.h
parentee7dfb7e245e92c011c335e7bac2474967eda192 (diff)
downloadlinux-fsl-qoriq-e33cc5cec039ac6aef68568c06998707bceb0953.tar.xz
Staging: rar_register: renaming directory to rar_register
Renames the directory in which the driver files are located; again for clarity. Signed-off-by: Mark Allyn <mark.a.allyn@intel.com> Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>
Diffstat (limited to 'drivers/staging/rar_register/rar_register.h')
-rw-r--r--drivers/staging/rar_register/rar_register.h89
1 files changed, 89 insertions, 0 deletions
diff --git a/drivers/staging/rar_register/rar_register.h b/drivers/staging/rar_register/rar_register.h
new file mode 100644
index 0000000..4172fbf
--- /dev/null
+++ b/drivers/staging/rar_register/rar_register.h
@@ -0,0 +1,89 @@
+/* === RAR Physical Addresses === */
+struct RAR_address_struct {
+ u32 low;
+ u32 high;
+};
+
+/* The get_rar_address function is used by other device drivers
+ * to obtain RAR address information on a RAR. It takes two
+ * parameter:
+ *
+ * int rar_index
+ * The rar_index is an index to the rar for which you wish to retrieve
+ * the address information.
+ * Values can be 0,1, or 2.
+ *
+ * struct RAR_address_struct is a pointer to a place to which the function
+ * can return the address structure for the RAR.
+ *
+ * The function returns a 0 upon success or a -1 if there is no RAR
+ * facility on this system.
+ */
+int get_rar_address(int rar_index, struct RAR_address_struct *addresses);
+
+
+/* The lock_rar function is used by other device drivers to lock an RAR.
+ * once an RAR is locked, it stays locked until the next system reboot.
+ * The function takes one parameter:
+ *
+ * int rar_index
+ * The rar_index is an index to the rar that you want to lock.
+ * Values can be 0,1, or 2.
+ *
+ * The function returns a 0 upon success or a -1 if there is no RAR
+ * facility on this system.
+ */
+int lock_rar(int rar_index);
+
+
+/* DEBUG LEVEL MASKS */
+#define RAR_DEBUG_LEVEL_BASIC 0x1
+
+#define RAR_DEBUG_LEVEL_REGISTERS 0x2
+
+#define RAR_DEBUG_LEVEL_EXTENDED 0x4
+
+#define DEBUG_LEVEL 0x7
+
+/* FUNCTIONAL MACROS */
+
+/* debug macro without paramaters */
+#define DEBUG_PRINT_0(DEBUG_LEVEL , info) \
+do { \
+ if (DEBUG_LEVEL) { \
+ printk(KERN_WARNING info); \
+ } \
+} while (0)
+
+/* debug macro with 1 paramater */
+#define DEBUG_PRINT_1(DEBUG_LEVEL , info , param1) \
+do { \
+ if (DEBUG_LEVEL) { \
+ printk(KERN_WARNING info , param1); \
+ } \
+} while (0)
+
+/* debug macro with 2 paramaters */
+#define DEBUG_PRINT_2(DEBUG_LEVEL , info , param1, param2) \
+do { \
+ if (DEBUG_LEVEL) { \
+ printk(KERN_WARNING info , param1, param2); \
+ } \
+} while (0)
+
+/* debug macro with 3 paramaters */
+#define DEBUG_PRINT_3(DEBUG_LEVEL , info , param1, param2 , param3) \
+do { \
+ if (DEBUG_LEVEL) { \
+ printk(KERN_WARNING info , param1, param2 , param3); \
+ } \
+} while (0)
+
+/* debug macro with 4 paramaters */
+#define DEBUG_PRINT_4(DEBUG_LEVEL , info , param1, param2 , param3 , param4) \
+do { \
+ if (DEBUG_LEVEL) { \
+ printk(KERN_WARNING info , param1, param2 , param3 , param4); \
+ } \
+} while (0)
+