aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/staging/rar/rar_driver.h
blob: 3690f984ff55a7b68d0dd86de04154f043c7f00f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
/* === 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 ued 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)