ieee1394: remove old isochronous ABI
[linux-2.6.git] / drivers / ieee1394 / highlevel.h
1 #ifndef IEEE1394_HIGHLEVEL_H
2 #define IEEE1394_HIGHLEVEL_H
3
4 #include <linux/list.h>
5 #include <linux/spinlock_types.h>
6 #include <linux/types.h>
7
8 struct module;
9
10 #include "ieee1394_types.h"
11
12 struct hpsb_host;
13
14 /* internal to ieee1394 core */
15 struct hpsb_address_serve {
16         struct list_head host_list;     /* per host list */
17         struct list_head hl_list;       /* hpsb_highlevel list */
18         struct hpsb_address_ops *op;
19         struct hpsb_host *host;
20         u64 start;      /* first address handled, quadlet aligned */
21         u64 end;        /* first address behind, quadlet aligned */
22 };
23
24 /* Only the following structures are of interest to actual highlevel drivers. */
25
26 struct hpsb_highlevel {
27         const char *name;
28
29         /* Any of the following pointers can legally be NULL. */
30
31         /* New host initialized.  Will also be called during
32          * hpsb_register_highlevel for all hosts already installed. */
33         void (*add_host)(struct hpsb_host *host);
34
35         /* Host about to be removed.  Will also be called during
36          * hpsb_unregister_highlevel once for each host. */
37         void (*remove_host)(struct hpsb_host *host);
38
39         /* Host experienced bus reset with possible configuration changes.
40          * Note that this one may occur during interrupt/bottom half handling.
41          * You can not expect to be able to do stock hpsb_reads. */
42         void (*host_reset)(struct hpsb_host *host);
43
44         /* A write request was received on either the FCP_COMMAND (direction =
45          * 0) or the FCP_RESPONSE (direction = 1) register.  The cts arg
46          * contains the cts field (first byte of data). */
47         void (*fcp_request)(struct hpsb_host *host, int nodeid, int direction,
48                             int cts, u8 *data, size_t length);
49
50         /* These are initialized by the subsystem when the
51          * hpsb_higlevel is registered. */
52         struct list_head hl_list;
53         struct list_head irq_list;
54         struct list_head addr_list;
55
56         struct list_head host_info_list;
57         rwlock_t host_info_lock;
58 };
59
60 struct hpsb_address_ops {
61         /*
62          * Null function pointers will make the respective operation complete
63          * with RCODE_TYPE_ERROR.  Makes for easy to implement read-only
64          * registers (just leave everything but read NULL).
65          *
66          * All functions shall return appropriate IEEE 1394 rcodes.
67          */
68
69         /* These functions have to implement block reads for themselves.
70          *
71          * These functions either return a response code or a negative number.
72          * In the first case a response will be generated.  In the latter case,
73          * no response will be sent and the driver which handled the request
74          * will send the response itself. */
75         int (*read)(struct hpsb_host *host, int nodeid, quadlet_t *buffer,
76                     u64 addr, size_t length, u16 flags);
77         int (*write)(struct hpsb_host *host, int nodeid, int destid,
78                      quadlet_t *data, u64 addr, size_t length, u16 flags);
79
80         /* Lock transactions: write results of ext_tcode operation into
81          * *store. */
82         int (*lock)(struct hpsb_host *host, int nodeid, quadlet_t *store,
83                     u64 addr, quadlet_t data, quadlet_t arg, int ext_tcode,
84                     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);
88 };
89
90 void highlevel_add_host(struct hpsb_host *host);
91 void highlevel_remove_host(struct hpsb_host *host);
92 void highlevel_host_reset(struct hpsb_host *host);
93 int highlevel_read(struct hpsb_host *host, int nodeid, void *data, u64 addr,
94                    unsigned int length, u16 flags);
95 int highlevel_write(struct hpsb_host *host, int nodeid, int destid, void *data,
96                     u64 addr, unsigned int length, u16 flags);
97 int highlevel_lock(struct hpsb_host *host, int nodeid, quadlet_t *store,
98                    u64 addr, quadlet_t data, quadlet_t arg, int ext_tcode,
99                    u16 flags);
100 int highlevel_lock64(struct hpsb_host *host, int nodeid, octlet_t *store,
101                      u64 addr, octlet_t data, octlet_t arg, int ext_tcode,
102                      u16 flags);
103 void highlevel_fcp_request(struct hpsb_host *host, int nodeid, int direction,
104                            void *data, size_t length);
105
106 void hpsb_register_highlevel(struct hpsb_highlevel *hl);
107 void hpsb_unregister_highlevel(struct hpsb_highlevel *hl);
108
109 u64 hpsb_allocate_and_register_addrspace(struct hpsb_highlevel *hl,
110                                          struct hpsb_host *host,
111                                          struct hpsb_address_ops *ops,
112                                          u64 size, u64 alignment,
113                                          u64 start, u64 end);
114 int hpsb_register_addrspace(struct hpsb_highlevel *hl, struct hpsb_host *host,
115                             struct hpsb_address_ops *ops, u64 start, u64 end);
116 int hpsb_unregister_addrspace(struct hpsb_highlevel *hl, struct hpsb_host *host,
117                               u64 start);
118
119 void *hpsb_get_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host);
120 void *hpsb_create_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host,
121                            size_t data_size);
122 void hpsb_destroy_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host);
123 void hpsb_set_hostinfo_key(struct hpsb_highlevel *hl, struct hpsb_host *host,
124                            unsigned long key);
125 void *hpsb_get_hostinfo_bykey(struct hpsb_highlevel *hl, unsigned long key);
126 int hpsb_set_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host,
127                       void *data);
128
129 #endif /* IEEE1394_HIGHLEVEL_H */