a9ace1f8dc3f86fd32683ad6333f74407cc30292
[linux-2.6.git] / drivers / firewire / core.h
1 #ifndef _FIREWIRE_CORE_H
2 #define _FIREWIRE_CORE_H
3
4 #include <linux/fs.h>
5 #include <linux/list.h>
6 #include <linux/idr.h>
7 #include <linux/mm_types.h>
8 #include <linux/rwsem.h>
9 #include <linux/slab.h>
10 #include <linux/types.h>
11
12 #include <asm/atomic.h>
13
14 struct device;
15 struct fw_card;
16 struct fw_device;
17 struct fw_iso_buffer;
18 struct fw_iso_context;
19 struct fw_iso_packet;
20 struct fw_node;
21 struct fw_packet;
22
23
24 /* -card */
25
26 /* bitfields within the PHY registers */
27 #define PHY_LINK_ACTIVE         0x80
28 #define PHY_CONTENDER           0x40
29 #define PHY_BUS_RESET           0x40
30 #define PHY_EXTENDED_REGISTERS  0xe0
31 #define PHY_BUS_SHORT_RESET     0x40
32 #define PHY_INT_STATUS_BITS     0x3c
33 #define PHY_ENABLE_ACCEL        0x02
34 #define PHY_ENABLE_MULTI        0x01
35 #define PHY_PAGE_SELECT         0xe0
36
37 #define BANDWIDTH_AVAILABLE_INITIAL     4915
38 #define BROADCAST_CHANNEL_INITIAL       (1 << 31 | 31)
39 #define BROADCAST_CHANNEL_VALID         (1 << 30)
40
41 #define FEATURE_PRIORITY_BUDGET         0x01
42
43 #define CSR_STATE_BIT_CMSTR     (1 << 8)
44 #define CSR_STATE_BIT_ABDICATE  (1 << 10)
45
46 struct fw_card_driver {
47         /*
48          * Enable the given card with the given initial config rom.
49          * This function is expected to activate the card, and either
50          * enable the PHY or set the link_on bit and initiate a bus
51          * reset.
52          */
53         int (*enable)(struct fw_card *card,
54                       const __be32 *config_rom, size_t length);
55
56         int (*update_phy_reg)(struct fw_card *card, int address,
57                               int clear_bits, int set_bits);
58
59         /*
60          * Update the config rom for an enabled card.  This function
61          * should change the config rom that is presented on the bus
62          * and initiate a bus reset.
63          */
64         int (*set_config_rom)(struct fw_card *card,
65                               const __be32 *config_rom, size_t length);
66
67         void (*send_request)(struct fw_card *card, struct fw_packet *packet);
68         void (*send_response)(struct fw_card *card, struct fw_packet *packet);
69         /* Calling cancel is valid once a packet has been submitted. */
70         int (*cancel_packet)(struct fw_card *card, struct fw_packet *packet);
71
72         /*
73          * Allow the specified node ID to do direct DMA out and in of
74          * host memory.  The card will disable this for all node when
75          * a bus reset happens, so driver need to reenable this after
76          * bus reset.  Returns 0 on success, -ENODEV if the card
77          * doesn't support this, -ESTALE if the generation doesn't
78          * match.
79          */
80         int (*enable_phys_dma)(struct fw_card *card,
81                                int node_id, int generation);
82
83         u32 (*read_csr_reg)(struct fw_card *card, int csr_offset);
84         void (*write_csr_reg)(struct fw_card *card, int csr_offset, u32 value);
85
86         unsigned int (*get_features)(struct fw_card *card);
87
88         struct fw_iso_context *
89         (*allocate_iso_context)(struct fw_card *card,
90                                 int type, int channel, size_t header_size);
91         void (*free_iso_context)(struct fw_iso_context *ctx);
92
93         int (*start_iso)(struct fw_iso_context *ctx,
94                          s32 cycle, u32 sync, u32 tags);
95
96         int (*queue_iso)(struct fw_iso_context *ctx,
97                          struct fw_iso_packet *packet,
98                          struct fw_iso_buffer *buffer,
99                          unsigned long payload);
100
101         int (*stop_iso)(struct fw_iso_context *ctx);
102 };
103
104 void fw_card_initialize(struct fw_card *card,
105                 const struct fw_card_driver *driver, struct device *device);
106 int fw_card_add(struct fw_card *card,
107                 u32 max_receive, u32 link_speed, u64 guid);
108 void fw_core_remove_card(struct fw_card *card);
109 int fw_core_initiate_bus_reset(struct fw_card *card, int short_reset);
110 int fw_compute_block_crc(__be32 *block);
111 void fw_schedule_bm_work(struct fw_card *card, unsigned long delay);
112
113 static inline struct fw_card *fw_card_get(struct fw_card *card)
114 {
115         kref_get(&card->kref);
116
117         return card;
118 }
119
120 void fw_card_release(struct kref *kref);
121
122 static inline void fw_card_put(struct fw_card *card)
123 {
124         kref_put(&card->kref, fw_card_release);
125 }
126
127
128 /* -cdev */
129
130 extern const struct file_operations fw_device_ops;
131
132 void fw_device_cdev_update(struct fw_device *device);
133 void fw_device_cdev_remove(struct fw_device *device);
134
135
136 /* -device */
137
138 extern struct rw_semaphore fw_device_rwsem;
139 extern struct idr fw_device_idr;
140 extern int fw_cdev_major;
141
142 struct fw_device *fw_device_get_by_devt(dev_t devt);
143 int fw_device_set_broadcast_channel(struct device *dev, void *gen);
144 void fw_node_event(struct fw_card *card, struct fw_node *node, int event);
145
146
147 /* -iso */
148
149 int fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma);
150 void fw_iso_resource_manage(struct fw_card *card, int generation,
151                             u64 channels_mask, int *channel, int *bandwidth,
152                             bool allocate, __be32 buffer[2]);
153
154
155 /* -topology */
156
157 enum {
158         FW_NODE_CREATED,
159         FW_NODE_UPDATED,
160         FW_NODE_DESTROYED,
161         FW_NODE_LINK_ON,
162         FW_NODE_LINK_OFF,
163         FW_NODE_INITIATED_RESET,
164 };
165
166 struct fw_node {
167         u16 node_id;
168         u8 color;
169         u8 port_count;
170         u8 link_on:1;
171         u8 initiated_reset:1;
172         u8 b_path:1;
173         u8 phy_speed:2; /* As in the self ID packet. */
174         u8 max_speed:2; /* Minimum of all phy-speeds on the path from the
175                          * local node to this node. */
176         u8 max_depth:4; /* Maximum depth to any leaf node */
177         u8 max_hops:4;  /* Max hops in this sub tree */
178         atomic_t ref_count;
179
180         /* For serializing node topology into a list. */
181         struct list_head link;
182
183         /* Upper layer specific data. */
184         void *data;
185
186         struct fw_node *ports[0];
187 };
188
189 static inline struct fw_node *fw_node_get(struct fw_node *node)
190 {
191         atomic_inc(&node->ref_count);
192
193         return node;
194 }
195
196 static inline void fw_node_put(struct fw_node *node)
197 {
198         if (atomic_dec_and_test(&node->ref_count))
199                 kfree(node);
200 }
201
202 void fw_core_handle_bus_reset(struct fw_card *card, int node_id,
203                               int generation, int self_id_count, u32 *self_ids);
204 void fw_destroy_nodes(struct fw_card *card);
205
206 /*
207  * Check whether new_generation is the immediate successor of old_generation.
208  * Take counter roll-over at 255 (as per OHCI) into account.
209  */
210 static inline bool is_next_generation(int new_generation, int old_generation)
211 {
212         return (new_generation & 0xff) == ((old_generation + 1) & 0xff);
213 }
214
215
216 /* -transaction */
217
218 #define TCODE_IS_READ_REQUEST(tcode)    (((tcode) & ~1) == 4)
219 #define TCODE_IS_BLOCK_PACKET(tcode)    (((tcode) &  1) != 0)
220 #define TCODE_IS_REQUEST(tcode)         (((tcode) &  2) == 0)
221 #define TCODE_IS_RESPONSE(tcode)        (((tcode) &  2) != 0)
222 #define TCODE_HAS_REQUEST_DATA(tcode)   (((tcode) & 12) != 4)
223 #define TCODE_HAS_RESPONSE_DATA(tcode)  (((tcode) & 12) != 0)
224
225 #define LOCAL_BUS 0xffc0
226
227 void fw_core_handle_request(struct fw_card *card, struct fw_packet *request);
228 void fw_core_handle_response(struct fw_card *card, struct fw_packet *packet);
229 int fw_get_response_length(struct fw_request *request);
230 void fw_fill_response(struct fw_packet *response, u32 *request_header,
231                       int rcode, void *payload, size_t length);
232 void fw_send_phy_config(struct fw_card *card,
233                         int node_id, int generation, int gap_count);
234
235 #endif /* _FIREWIRE_CORE_H */