[SPARC64]: Use more mearningful names for IRQ registry.
[safe/jmp/linux-2.6] / include / asm-sparc64 / ldc.h
1 #ifndef _SPARC64_LDC_H
2 #define _SPARC64_LDC_H
3
4 #include <asm/hypervisor.h>
5
6 extern int ldom_domaining_enabled;
7
8 /* The event handler will be evoked when link state changes
9  * or data becomes available on the receive side.
10  *
11  * For non-RAW links, if the LDC_EVENT_RESET event arrives the
12  * driver should reset all of it's internal state and reinvoke
13  * ldc_connect() to try and bring the link up again.
14  *
15  * For RAW links, ldc_connect() is not used.  Instead the driver
16  * just waits for the LDC_EVENT_UP event.
17  */
18 struct ldc_channel_config {
19         void (*event)(void *arg, int event);
20
21         u32                     mtu;
22         unsigned int            rx_irq;
23         unsigned int            tx_irq;
24         u8                      mode;
25 #define LDC_MODE_RAW            0x00
26 #define LDC_MODE_UNRELIABLE     0x01
27 #define LDC_MODE_RESERVED       0x02
28 #define LDC_MODE_STREAM         0x03
29
30         u8                      debug;
31 #define LDC_DEBUG_HS            0x01
32 #define LDC_DEBUG_STATE         0x02
33 #define LDC_DEBUG_RX            0x04
34 #define LDC_DEBUG_TX            0x08
35 #define LDC_DEBUG_DATA          0x10
36 };
37
38 #define LDC_EVENT_RESET         0x01
39 #define LDC_EVENT_UP            0x02
40 #define LDC_EVENT_DATA_READY    0x04
41
42 #define LDC_STATE_INVALID       0x00
43 #define LDC_STATE_INIT          0x01
44 #define LDC_STATE_BOUND         0x02
45 #define LDC_STATE_READY         0x03
46 #define LDC_STATE_CONNECTED     0x04
47
48 struct ldc_channel;
49
50 /* Allocate state for a channel.  */
51 extern struct ldc_channel *ldc_alloc(unsigned long id,
52                                      const struct ldc_channel_config *cfgp,
53                                      void *event_arg);
54
55 /* Shut down and free state for a channel.  */
56 extern void ldc_free(struct ldc_channel *lp);
57
58 /* Register TX and RX queues of the link with the hypervisor.  */
59 extern int ldc_bind(struct ldc_channel *lp, const char *name);
60
61 /* For non-RAW protocols we need to complete a handshake before
62  * communication can proceed.  ldc_connect() does that, if the
63  * handshake completes successfully, an LDC_EVENT_UP event will
64  * be sent up to the driver.
65  */
66 extern int ldc_connect(struct ldc_channel *lp);
67 extern int ldc_disconnect(struct ldc_channel *lp);
68
69 extern int ldc_state(struct ldc_channel *lp);
70
71 /* Read and write operations.  Only valid when the link is up.  */
72 extern int ldc_write(struct ldc_channel *lp, const void *buf,
73                      unsigned int size);
74 extern int ldc_read(struct ldc_channel *lp, void *buf, unsigned int size);
75
76 #define LDC_MAP_SHADOW  0x01
77 #define LDC_MAP_DIRECT  0x02
78 #define LDC_MAP_IO      0x04
79 #define LDC_MAP_R       0x08
80 #define LDC_MAP_W       0x10
81 #define LDC_MAP_X       0x20
82 #define LDC_MAP_RW      (LDC_MAP_R | LDC_MAP_W)
83 #define LDC_MAP_RWX     (LDC_MAP_R | LDC_MAP_W | LDC_MAP_X)
84 #define LDC_MAP_ALL     0x03f
85
86 struct ldc_trans_cookie {
87         u64                     cookie_addr;
88         u64                     cookie_size;
89 };
90
91 struct scatterlist;
92 extern int ldc_map_sg(struct ldc_channel *lp,
93                       struct scatterlist *sg, int num_sg,
94                       struct ldc_trans_cookie *cookies, int ncookies,
95                       unsigned int map_perm);
96
97 extern int ldc_map_single(struct ldc_channel *lp,
98                           void *buf, unsigned int len,
99                           struct ldc_trans_cookie *cookies, int ncookies,
100                           unsigned int map_perm);
101
102 extern void ldc_unmap(struct ldc_channel *lp, struct ldc_trans_cookie *cookies,
103                       int ncookies);
104
105 extern int ldc_copy(struct ldc_channel *lp, int copy_dir,
106                     void *buf, unsigned int len, unsigned long offset,
107                     struct ldc_trans_cookie *cookies, int ncookies);
108
109 static inline int ldc_get_dring_entry(struct ldc_channel *lp,
110                                       void *buf, unsigned int len,
111                                       unsigned long offset,
112                                       struct ldc_trans_cookie *cookies,
113                                       int ncookies)
114 {
115         return ldc_copy(lp, LDC_COPY_IN, buf, len, offset, cookies, ncookies);
116 }
117
118 static inline int ldc_put_dring_entry(struct ldc_channel *lp,
119                                       void *buf, unsigned int len,
120                                       unsigned long offset,
121                                       struct ldc_trans_cookie *cookies,
122                                       int ncookies)
123 {
124         return ldc_copy(lp, LDC_COPY_OUT, buf, len, offset, cookies, ncookies);
125 }
126
127 extern void *ldc_alloc_exp_dring(struct ldc_channel *lp, unsigned int len,
128                                  struct ldc_trans_cookie *cookies,
129                                  int *ncookies, unsigned int map_perm);
130
131 extern void ldc_free_exp_dring(struct ldc_channel *lp, void *buf,
132                                unsigned int len,
133                                struct ldc_trans_cookie *cookies, int ncookies);
134
135 #endif /* _SPARC64_LDC_H */