Commit | Line | Data |
---|---|---|
77c9a5da SR |
1 | #ifndef _FIREWIRE_CORE_H |
2 | #define _FIREWIRE_CORE_H | |
3 | ||
77c9a5da SR |
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 | |
925e7a65 | 30 | #define PHY_EXTENDED_REGISTERS 0xe0 |
77c9a5da | 31 | #define PHY_BUS_SHORT_RESET 0x40 |
e7014dad | 32 | #define PHY_INT_STATUS_BITS 0x3c |
925e7a65 CL |
33 | #define PHY_ENABLE_ACCEL 0x02 |
34 | #define PHY_ENABLE_MULTI 0x01 | |
35 | #define PHY_PAGE_SELECT 0xe0 | |
77c9a5da SR |
36 | |
37 | #define BANDWIDTH_AVAILABLE_INITIAL 4915 | |
38 | #define BROADCAST_CHANNEL_INITIAL (1 << 31 | 31) | |
39 | #define BROADCAST_CHANNEL_VALID (1 << 30) | |
40 | ||
4ffb7a6a | 41 | #define CSR_STATE_BIT_CMSTR (1 << 8) |
7e0e314f | 42 | #define CSR_STATE_BIT_ABDICATE (1 << 10) |
4ffb7a6a | 43 | |
77c9a5da SR |
44 | struct fw_card_driver { |
45 | /* | |
46 | * Enable the given card with the given initial config rom. | |
47 | * This function is expected to activate the card, and either | |
48 | * enable the PHY or set the link_on bit and initiate a bus | |
49 | * reset. | |
50 | */ | |
8e85973e SR |
51 | int (*enable)(struct fw_card *card, |
52 | const __be32 *config_rom, size_t length); | |
77c9a5da | 53 | |
02d37bed | 54 | int (*read_phy_reg)(struct fw_card *card, int address); |
77c9a5da SR |
55 | int (*update_phy_reg)(struct fw_card *card, int address, |
56 | int clear_bits, int set_bits); | |
57 | ||
58 | /* | |
59 | * Update the config rom for an enabled card. This function | |
60 | * should change the config rom that is presented on the bus | |
8e85973e | 61 | * and initiate a bus reset. |
77c9a5da SR |
62 | */ |
63 | int (*set_config_rom)(struct fw_card *card, | |
8e85973e | 64 | const __be32 *config_rom, size_t length); |
77c9a5da SR |
65 | |
66 | void (*send_request)(struct fw_card *card, struct fw_packet *packet); | |
67 | void (*send_response)(struct fw_card *card, struct fw_packet *packet); | |
68 | /* Calling cancel is valid once a packet has been submitted. */ | |
69 | int (*cancel_packet)(struct fw_card *card, struct fw_packet *packet); | |
70 | ||
71 | /* | |
72 | * Allow the specified node ID to do direct DMA out and in of | |
73 | * host memory. The card will disable this for all node when | |
74 | * a bus reset happens, so driver need to reenable this after | |
75 | * bus reset. Returns 0 on success, -ENODEV if the card | |
76 | * doesn't support this, -ESTALE if the generation doesn't | |
77 | * match. | |
78 | */ | |
79 | int (*enable_phys_dma)(struct fw_card *card, | |
80 | int node_id, int generation); | |
81 | ||
0fcff4e3 SR |
82 | u32 (*read_csr)(struct fw_card *card, int csr_offset); |
83 | void (*write_csr)(struct fw_card *card, int csr_offset, u32 value); | |
77c9a5da SR |
84 | |
85 | struct fw_iso_context * | |
86 | (*allocate_iso_context)(struct fw_card *card, | |
87 | int type, int channel, size_t header_size); | |
88 | void (*free_iso_context)(struct fw_iso_context *ctx); | |
89 | ||
90 | int (*start_iso)(struct fw_iso_context *ctx, | |
91 | s32 cycle, u32 sync, u32 tags); | |
92 | ||
872e330e SR |
93 | int (*set_iso_channels)(struct fw_iso_context *ctx, u64 *channels); |
94 | ||
77c9a5da SR |
95 | int (*queue_iso)(struct fw_iso_context *ctx, |
96 | struct fw_iso_packet *packet, | |
97 | struct fw_iso_buffer *buffer, | |
98 | unsigned long payload); | |
99 | ||
100 | int (*stop_iso)(struct fw_iso_context *ctx); | |
101 | }; | |
102 | ||
103 | void fw_card_initialize(struct fw_card *card, | |
104 | const struct fw_card_driver *driver, struct device *device); | |
105 | int fw_card_add(struct fw_card *card, | |
106 | u32 max_receive, u32 link_speed, u64 guid); | |
107 | void fw_core_remove_card(struct fw_card *card); | |
cb7c96da | 108 | int fw_compute_block_crc(__be32 *block); |
02d37bed | 109 | void fw_schedule_bus_reset(struct fw_card *card, bool delayed, bool short_reset); |
77c9a5da SR |
110 | void fw_schedule_bm_work(struct fw_card *card, unsigned long delay); |
111 | ||
18668ff9 SR |
112 | static inline struct fw_card *fw_card_get(struct fw_card *card) |
113 | { | |
114 | kref_get(&card->kref); | |
115 | ||
116 | return card; | |
117 | } | |
118 | ||
119 | void fw_card_release(struct kref *kref); | |
120 | ||
121 | static inline void fw_card_put(struct fw_card *card) | |
122 | { | |
123 | kref_put(&card->kref, fw_card_release); | |
124 | } | |
125 | ||
77c9a5da SR |
126 | |
127 | /* -cdev */ | |
128 | ||
129 | extern const struct file_operations fw_device_ops; | |
130 | ||
131 | void fw_device_cdev_update(struct fw_device *device); | |
132 | void fw_device_cdev_remove(struct fw_device *device); | |
bf54e146 | 133 | void fw_cdev_handle_phy_packet(struct fw_card *card, struct fw_packet *p); |
77c9a5da SR |
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); | |
099d5414 | 143 | int fw_device_set_broadcast_channel(struct device *dev, void *gen); |
77c9a5da SR |
144 | void fw_node_event(struct fw_card *card, struct fw_node *node, int event); |
145 | ||
146 | ||
147 | /* -iso */ | |
148 | ||
77c9a5da | 149 | int fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma); |
77c9a5da | 150 | void fw_iso_resource_manage(struct fw_card *card, int generation, |
6fdc0370 SR |
151 | u64 channels_mask, int *channel, int *bandwidth, |
152 | bool allocate, __be32 buffer[2]); | |
77c9a5da SR |
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, | |
c8a94ded | 203 | int generation, int self_id_count, u32 *self_ids, bool bm_abdicate); |
77c9a5da SR |
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) | |
bf54e146 | 220 | #define TCODE_IS_LINK_INTERNAL(tcode) ((tcode) == 0xe) |
77c9a5da SR |
221 | #define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0) |
222 | #define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0) | |
223 | #define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4) | |
224 | #define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0) | |
225 | ||
226 | #define LOCAL_BUS 0xffc0 | |
227 | ||
228 | void fw_core_handle_request(struct fw_card *card, struct fw_packet *request); | |
229 | void fw_core_handle_response(struct fw_card *card, struct fw_packet *packet); | |
a10c0ce7 | 230 | int fw_get_response_length(struct fw_request *request); |
77c9a5da SR |
231 | void fw_fill_response(struct fw_packet *response, u32 *request_header, |
232 | int rcode, void *payload, size_t length); | |
02d37bed SR |
233 | |
234 | #define FW_PHY_CONFIG_NO_NODE_ID -1 | |
235 | #define FW_PHY_CONFIG_CURRENT_GAP_COUNT -1 | |
77c9a5da SR |
236 | void fw_send_phy_config(struct fw_card *card, |
237 | int node_id, int generation, int gap_count); | |
238 | ||
cc550216 SR |
239 | static inline bool is_ping_packet(u32 *data) |
240 | { | |
241 | return (data[0] & 0xc0ffffff) == 0 && ~data[0] == data[1]; | |
242 | } | |
243 | ||
77c9a5da | 244 | #endif /* _FIREWIRE_CORE_H */ |