aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/ieee1394/highlevel.h
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/ieee1394/highlevel.h')
-rw-r--r--drivers/ieee1394/highlevel.h197
1 files changed, 97 insertions, 100 deletions
diff --git a/drivers/ieee1394/highlevel.h b/drivers/ieee1394/highlevel.h
index e119fb87e5b5..134bb6c3eadb 100644
--- a/drivers/ieee1394/highlevel.h
+++ b/drivers/ieee1394/highlevel.h
@@ -1,60 +1,51 @@
1
2#ifndef IEEE1394_HIGHLEVEL_H 1#ifndef IEEE1394_HIGHLEVEL_H
3#define IEEE1394_HIGHLEVEL_H 2#define IEEE1394_HIGHLEVEL_H
4 3
5 4/* internal to ieee1394 core */
6struct hpsb_address_serve { 5struct hpsb_address_serve {
7 struct list_head host_list; /* per host list */ 6 struct list_head host_list; /* per host list */
8 7 struct list_head hl_list; /* hpsb_highlevel list */
9 struct list_head hl_list; /* hpsb_highlevel list */ 8 struct hpsb_address_ops *op;
10
11 struct hpsb_address_ops *op;
12
13 struct hpsb_host *host; 9 struct hpsb_host *host;
14 10 u64 start; /* first address handled, quadlet aligned */
15 /* first address handled and first address behind, quadlet aligned */ 11 u64 end; /* first address behind, quadlet aligned */
16 u64 start, end;
17}; 12};
18 13
19 14/* Only the following structures are of interest to actual highlevel drivers. */
20/*
21 * The above structs are internal to highlevel driver handling. Only the
22 * following structures are of interest to actual highlevel drivers.
23 */
24 15
25struct hpsb_highlevel { 16struct hpsb_highlevel {
26 struct module *owner; 17 struct module *owner;
27 const char *name; 18 const char *name;
28 19
29 /* Any of the following pointers can legally be NULL, except for 20 /* Any of the following pointers can legally be NULL, except for
30 * iso_receive which can only be NULL when you don't request 21 * iso_receive which can only be NULL when you don't request
31 * channels. */ 22 * channels. */
32 23
33 /* New host initialized. Will also be called during 24 /* New host initialized. Will also be called during
34 * hpsb_register_highlevel for all hosts already installed. */ 25 * hpsb_register_highlevel for all hosts already installed. */
35 void (*add_host) (struct hpsb_host *host); 26 void (*add_host)(struct hpsb_host *host);
36 27
37 /* Host about to be removed. Will also be called during 28 /* Host about to be removed. Will also be called during
38 * hpsb_unregister_highlevel once for each host. */ 29 * hpsb_unregister_highlevel once for each host. */
39 void (*remove_host) (struct hpsb_host *host); 30 void (*remove_host)(struct hpsb_host *host);
40 31
41 /* Host experienced bus reset with possible configuration changes. 32 /* Host experienced bus reset with possible configuration changes.
42 * Note that this one may occur during interrupt/bottom half handling. 33 * Note that this one may occur during interrupt/bottom half handling.
43 * You can not expect to be able to do stock hpsb_reads. */ 34 * You can not expect to be able to do stock hpsb_reads. */
44 void (*host_reset) (struct hpsb_host *host); 35 void (*host_reset)(struct hpsb_host *host);
45 36
46 /* An isochronous packet was received. Channel contains the channel 37 /* An isochronous packet was received. Channel contains the channel
47 * number for your convenience, it is also contained in the included 38 * number for your convenience, it is also contained in the included
48 * packet header (first quadlet, CRCs are missing). You may get called 39 * packet header (first quadlet, CRCs are missing). You may get called
49 * for channel/host combinations you did not request. */ 40 * for channel/host combinations you did not request. */
50 void (*iso_receive) (struct hpsb_host *host, int channel, 41 void (*iso_receive)(struct hpsb_host *host, int channel,
51 quadlet_t *data, size_t length); 42 quadlet_t *data, size_t length);
52 43
53 /* A write request was received on either the FCP_COMMAND (direction = 44 /* A write request was received on either the FCP_COMMAND (direction =
54 * 0) or the FCP_RESPONSE (direction = 1) register. The cts arg 45 * 0) or the FCP_RESPONSE (direction = 1) register. The cts arg
55 * contains the cts field (first byte of data). */ 46 * contains the cts field (first byte of data). */
56 void (*fcp_request) (struct hpsb_host *host, int nodeid, int direction, 47 void (*fcp_request)(struct hpsb_host *host, int nodeid, int direction,
57 int cts, u8 *data, size_t length); 48 int cts, u8 *data, size_t length);
58 49
59 /* These are initialized by the subsystem when the 50 /* These are initialized by the subsystem when the
60 * hpsb_higlevel is registered. */ 51 * hpsb_higlevel is registered. */
@@ -67,61 +58,62 @@ struct hpsb_highlevel {
67}; 58};
68 59
69struct hpsb_address_ops { 60struct hpsb_address_ops {
70 /* 61 /*
71 * Null function pointers will make the respective operation complete 62 * Null function pointers will make the respective operation complete
72 * with RCODE_TYPE_ERROR. Makes for easy to implement read-only 63 * with RCODE_TYPE_ERROR. Makes for easy to implement read-only
73 * registers (just leave everything but read NULL). 64 * registers (just leave everything but read NULL).
74 * 65 *
75 * All functions shall return appropriate IEEE 1394 rcodes. 66 * All functions shall return appropriate IEEE 1394 rcodes.
76 */ 67 */
77 68
78 /* These functions have to implement block reads for themselves. */ 69 /* These functions have to implement block reads for themselves.
79 /* These functions either return a response code 70 *
80 or a negative number. In the first case a response will be generated; in the 71 * These functions either return a response code or a negative number.
81 later case, no response will be sent and the driver, that handled the request 72 * In the first case a response will be generated. In the latter case,
82 will send the response itself 73 * no response will be sent and the driver which handled the request
83 */ 74 * will send the response itself. */
84 int (*read) (struct hpsb_host *host, int nodeid, quadlet_t *buffer, 75 int (*read)(struct hpsb_host *host, int nodeid, quadlet_t *buffer,
85 u64 addr, size_t length, u16 flags); 76 u64 addr, size_t length, u16 flags);
86 int (*write) (struct hpsb_host *host, int nodeid, int destid, 77 int (*write)(struct hpsb_host *host, int nodeid, int destid,
87 quadlet_t *data, u64 addr, size_t length, u16 flags); 78 quadlet_t *data, u64 addr, size_t length, u16 flags);
88 79
89 /* Lock transactions: write results of ext_tcode operation into 80 /* Lock transactions: write results of ext_tcode operation into
90 * *store. */ 81 * *store. */
91 int (*lock) (struct hpsb_host *host, int nodeid, quadlet_t *store, 82 int (*lock)(struct hpsb_host *host, int nodeid, quadlet_t *store,
92 u64 addr, quadlet_t data, quadlet_t arg, int ext_tcode, u16 flags); 83 u64 addr, quadlet_t data, quadlet_t arg, int ext_tcode,
93 int (*lock64) (struct hpsb_host *host, int nodeid, octlet_t *store, 84 u16 flags);
94 u64 addr, octlet_t data, octlet_t arg, int ext_tcode, u16 flags); 85 int (*lock64)(struct hpsb_host *host, int nodeid, octlet_t *store,
86 u64 addr, octlet_t data, octlet_t arg, int ext_tcode,
87 u16 flags);
95}; 88};
96 89
97
98void highlevel_add_host(struct hpsb_host *host); 90void highlevel_add_host(struct hpsb_host *host);
99void highlevel_remove_host(struct hpsb_host *host); 91void highlevel_remove_host(struct hpsb_host *host);
100void highlevel_host_reset(struct hpsb_host *host); 92void highlevel_host_reset(struct hpsb_host *host);
101 93
102 94/*
103/* these functions are called to handle transactions. They are called, when 95 * These functions are called to handle transactions. They are called when a
104 a packet arrives. The flags argument contains the second word of the first header 96 * packet arrives. The flags argument contains the second word of the first
105 quadlet of the incoming packet (containing transaction label, retry code, 97 * header quadlet of the incoming packet (containing transaction label, retry
106 transaction code and priority). These functions either return a response code 98 * code, transaction code and priority). These functions either return a
107 or a negative number. In the first case a response will be generated; in the 99 * response code or a negative number. In the first case a response will be
108 later case, no response will be sent and the driver, that handled the request 100 * generated. In the latter case, no response will be sent and the driver which
109 will send the response itself. 101 * handled the request will send the response itself.
110*/ 102 */
111int highlevel_read(struct hpsb_host *host, int nodeid, void *data, 103int highlevel_read(struct hpsb_host *host, int nodeid, void *data, u64 addr,
112 u64 addr, unsigned int length, u16 flags); 104 unsigned int length, u16 flags);
113int highlevel_write(struct hpsb_host *host, int nodeid, int destid, 105int highlevel_write(struct hpsb_host *host, int nodeid, int destid, void *data,
114 void *data, u64 addr, unsigned int length, u16 flags); 106 u64 addr, unsigned int length, u16 flags);
115int highlevel_lock(struct hpsb_host *host, int nodeid, quadlet_t *store, 107int highlevel_lock(struct hpsb_host *host, int nodeid, quadlet_t *store,
116 u64 addr, quadlet_t data, quadlet_t arg, int ext_tcode, u16 flags); 108 u64 addr, quadlet_t data, quadlet_t arg, int ext_tcode,
109 u16 flags);
117int highlevel_lock64(struct hpsb_host *host, int nodeid, octlet_t *store, 110int highlevel_lock64(struct hpsb_host *host, int nodeid, octlet_t *store,
118 u64 addr, octlet_t data, octlet_t arg, int ext_tcode, u16 flags); 111 u64 addr, octlet_t data, octlet_t arg, int ext_tcode,
112 u16 flags);
119 113
120void highlevel_iso_receive(struct hpsb_host *host, void *data, 114void highlevel_iso_receive(struct hpsb_host *host, void *data, size_t length);
121 size_t length);
122void highlevel_fcp_request(struct hpsb_host *host, int nodeid, int direction, 115void highlevel_fcp_request(struct hpsb_host *host, int nodeid, int direction,
123 void *data, size_t length); 116 void *data, size_t length);
124
125 117
126/* 118/*
127 * Register highlevel driver. The name pointer has to stay valid at all times 119 * Register highlevel driver. The name pointer has to stay valid at all times
@@ -132,13 +124,15 @@ void hpsb_unregister_highlevel(struct hpsb_highlevel *hl);
132 124
133/* 125/*
134 * Register handlers for host address spaces. Start and end are 48 bit pointers 126 * Register handlers for host address spaces. Start and end are 48 bit pointers
135 * and have to be quadlet aligned (end points to the first address behind the 127 * and have to be quadlet aligned. Argument "end" points to the first address
136 * handled addresses. This function can be called multiple times for a single 128 * behind the handled addresses. This function can be called multiple times for
137 * hpsb_highlevel to implement sparse register sets. The requested region must 129 * a single hpsb_highlevel to implement sparse register sets. The requested
138 * not overlap any previously allocated region, otherwise registering will fail. 130 * region must not overlap any previously allocated region, otherwise
131 * registering will fail.
139 * 132 *
140 * It returns true for successful allocation. There is no unregister function, 133 * It returns true for successful allocation. Address spaces can be
141 * all address spaces are deallocated together with the hpsb_highlevel. 134 * unregistered with hpsb_unregister_addrspace. All remaining address spaces
135 * are automatically deallocated together with the hpsb_highlevel.
142 */ 136 */
143u64 hpsb_allocate_and_register_addrspace(struct hpsb_highlevel *hl, 137u64 hpsb_allocate_and_register_addrspace(struct hpsb_highlevel *hl,
144 struct hpsb_host *host, 138 struct hpsb_host *host,
@@ -146,20 +140,18 @@ u64 hpsb_allocate_and_register_addrspace(struct hpsb_highlevel *hl,
146 u64 size, u64 alignment, 140 u64 size, u64 alignment,
147 u64 start, u64 end); 141 u64 start, u64 end);
148int hpsb_register_addrspace(struct hpsb_highlevel *hl, struct hpsb_host *host, 142int hpsb_register_addrspace(struct hpsb_highlevel *hl, struct hpsb_host *host,
149 struct hpsb_address_ops *ops, u64 start, u64 end); 143 struct hpsb_address_ops *ops, u64 start, u64 end);
150
151int hpsb_unregister_addrspace(struct hpsb_highlevel *hl, struct hpsb_host *host, 144int hpsb_unregister_addrspace(struct hpsb_highlevel *hl, struct hpsb_host *host,
152 u64 start); 145 u64 start);
153 146
154/* 147/*
155 * Enable or disable receving a certain isochronous channel through the 148 * Enable or disable receving a certain isochronous channel through the
156 * iso_receive op. 149 * iso_receive op.
157 */ 150 */
158int hpsb_listen_channel(struct hpsb_highlevel *hl, struct hpsb_host *host, 151int hpsb_listen_channel(struct hpsb_highlevel *hl, struct hpsb_host *host,
159 unsigned int channel); 152 unsigned int channel);
160void hpsb_unlisten_channel(struct hpsb_highlevel *hl, struct hpsb_host *host, 153void hpsb_unlisten_channel(struct hpsb_highlevel *hl, struct hpsb_host *host,
161 unsigned int channel); 154 unsigned int channel);
162
163 155
164/* Retrieve a hostinfo pointer bound to this driver/host */ 156/* Retrieve a hostinfo pointer bound to this driver/host */
165void *hpsb_get_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host); 157void *hpsb_get_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host);
@@ -172,19 +164,24 @@ void *hpsb_create_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host,
172void hpsb_destroy_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host); 164void hpsb_destroy_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host);
173 165
174/* Set an alternate lookup key for the hostinfo bound to this driver/host */ 166/* Set an alternate lookup key for the hostinfo bound to this driver/host */
175void hpsb_set_hostinfo_key(struct hpsb_highlevel *hl, struct hpsb_host *host, unsigned long key); 167void hpsb_set_hostinfo_key(struct hpsb_highlevel *hl, struct hpsb_host *host,
168 unsigned long key);
176 169
177/* Retrieve the alternate lookup key for the hostinfo bound to this driver/host */ 170/* Retrieve the alternate lookup key for the hostinfo bound to this
178unsigned long hpsb_get_hostinfo_key(struct hpsb_highlevel *hl, struct hpsb_host *host); 171 * driver/host */
172unsigned long hpsb_get_hostinfo_key(struct hpsb_highlevel *hl,
173 struct hpsb_host *host);
179 174
180/* Retrieve a hostinfo pointer bound to this driver using its alternate key */ 175/* Retrieve a hostinfo pointer bound to this driver using its alternate key */
181void *hpsb_get_hostinfo_bykey(struct hpsb_highlevel *hl, unsigned long key); 176void *hpsb_get_hostinfo_bykey(struct hpsb_highlevel *hl, unsigned long key);
182 177
183/* Set the hostinfo pointer to something useful. Usually follows a call to 178/* Set the hostinfo pointer to something useful. Usually follows a call to
184 * hpsb_create_hostinfo, where the size is 0. */ 179 * hpsb_create_hostinfo, where the size is 0. */
185int hpsb_set_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host, void *data); 180int hpsb_set_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host,
181 void *data);
186 182
187/* Retrieve hpsb_host using a highlevel handle and a key */ 183/* Retrieve hpsb_host using a highlevel handle and a key */
188struct hpsb_host *hpsb_get_host_bykey(struct hpsb_highlevel *hl, unsigned long key); 184struct hpsb_host *hpsb_get_host_bykey(struct hpsb_highlevel *hl,
185 unsigned long key);
189 186
190#endif /* IEEE1394_HIGHLEVEL_H */ 187#endif /* IEEE1394_HIGHLEVEL_H */