Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
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 <linux/atomic.h>
13
14struct device;
15struct fw_card;
16struct fw_device;
17struct fw_iso_buffer;
18struct fw_iso_context;
19struct fw_iso_packet;
20struct fw_node;
21struct 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 CSR_STATE_BIT_CMSTR (1 << 8)
42#define CSR_STATE_BIT_ABDICATE (1 << 10)
43
44struct 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 */
51 int (*enable)(struct fw_card *card,
52 const __be32 *config_rom, size_t length);
53
54 int (*read_phy_reg)(struct fw_card *card, int address);
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
61 * and initiate a bus reset.
62 */
63 int (*set_config_rom)(struct fw_card *card,
64 const __be32 *config_rom, size_t length);
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
82 u32 (*read_csr)(struct fw_card *card, int csr_offset);
83 void (*write_csr)(struct fw_card *card, int csr_offset, u32 value);
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
93 int (*set_iso_channels)(struct fw_iso_context *ctx, u64 *channels);
94
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 void (*flush_queue_iso)(struct fw_iso_context *ctx);
101
102 int (*stop_iso)(struct fw_iso_context *ctx);
103};
104
105void fw_card_initialize(struct fw_card *card,
106 const struct fw_card_driver *driver, struct device *device);
107int fw_card_add(struct fw_card *card,
108 u32 max_receive, u32 link_speed, u64 guid);
109void fw_core_remove_card(struct fw_card *card);
110int fw_compute_block_crc(__be32 *block);
111void fw_schedule_bus_reset(struct fw_card *card, bool delayed, bool short_reset);
112void fw_schedule_bm_work(struct fw_card *card, unsigned long delay);
113
114static inline struct fw_card *fw_card_get(struct fw_card *card)
115{
116 kref_get(&card->kref);
117
118 return card;
119}
120
121void fw_card_release(struct kref *kref);
122
123static inline void fw_card_put(struct fw_card *card)
124{
125 kref_put(&card->kref, fw_card_release);
126}
127
128
129/* -cdev */
130
131extern const struct file_operations fw_device_ops;
132
133void fw_device_cdev_update(struct fw_device *device);
134void fw_device_cdev_remove(struct fw_device *device);
135void fw_cdev_handle_phy_packet(struct fw_card *card, struct fw_packet *p);
136
137
138/* -device */
139
140extern struct rw_semaphore fw_device_rwsem;
141extern struct idr fw_device_idr;
142extern int fw_cdev_major;
143
144struct fw_device *fw_device_get_by_devt(dev_t devt);
145int fw_device_set_broadcast_channel(struct device *dev, void *gen);
146void fw_node_event(struct fw_card *card, struct fw_node *node, int event);
147
148
149/* -iso */
150
151int fw_iso_buffer_map(struct fw_iso_buffer *buffer, struct vm_area_struct *vma);
152
153
154/* -topology */
155
156enum {
157 FW_NODE_CREATED,
158 FW_NODE_UPDATED,
159 FW_NODE_DESTROYED,
160 FW_NODE_LINK_ON,
161 FW_NODE_LINK_OFF,
162 FW_NODE_INITIATED_RESET,
163};
164
165struct fw_node {
166 u16 node_id;
167 u8 color;
168 u8 port_count;
169 u8 link_on:1;
170 u8 initiated_reset:1;
171 u8 b_path:1;
172 u8 phy_speed:2; /* As in the self ID packet. */
173 u8 max_speed:2; /* Minimum of all phy-speeds on the path from the
174 * local node to this node. */
175 u8 max_depth:4; /* Maximum depth to any leaf node */
176 u8 max_hops:4; /* Max hops in this sub tree */
177 atomic_t ref_count;
178
179 /* For serializing node topology into a list. */
180 struct list_head link;
181
182 /* Upper layer specific data. */
183 void *data;
184
185 struct fw_node *ports[0];
186};
187
188static inline struct fw_node *fw_node_get(struct fw_node *node)
189{
190 atomic_inc(&node->ref_count);
191
192 return node;
193}
194
195static inline void fw_node_put(struct fw_node *node)
196{
197 if (atomic_dec_and_test(&node->ref_count))
198 kfree(node);
199}
200
201void fw_core_handle_bus_reset(struct fw_card *card, int node_id,
202 int generation, int self_id_count, u32 *self_ids, bool bm_abdicate);
203void fw_destroy_nodes(struct fw_card *card);
204
205/*
206 * Check whether new_generation is the immediate successor of old_generation.
207 * Take counter roll-over at 255 (as per OHCI) into account.
208 */
209static inline bool is_next_generation(int new_generation, int old_generation)
210{
211 return (new_generation & 0xff) == ((old_generation + 1) & 0xff);
212}
213
214
215/* -transaction */
216
217#define TCODE_LINK_INTERNAL 0xe
218
219#define TCODE_IS_READ_REQUEST(tcode) (((tcode) & ~1) == 4)
220#define TCODE_IS_BLOCK_PACKET(tcode) (((tcode) & 1) != 0)
221#define TCODE_IS_LINK_INTERNAL(tcode) ((tcode) == TCODE_LINK_INTERNAL)
222#define TCODE_IS_REQUEST(tcode) (((tcode) & 2) == 0)
223#define TCODE_IS_RESPONSE(tcode) (((tcode) & 2) != 0)
224#define TCODE_HAS_REQUEST_DATA(tcode) (((tcode) & 12) != 4)
225#define TCODE_HAS_RESPONSE_DATA(tcode) (((tcode) & 12) != 0)
226
227#define LOCAL_BUS 0xffc0
228
229void fw_core_handle_request(struct fw_card *card, struct fw_packet *request);
230void fw_core_handle_response(struct fw_card *card, struct fw_packet *packet);
231int fw_get_response_length(struct fw_request *request);
232void fw_fill_response(struct fw_packet *response, u32 *request_header,
233 int rcode, void *payload, size_t length);
234
235#define FW_PHY_CONFIG_NO_NODE_ID -1
236#define FW_PHY_CONFIG_CURRENT_GAP_COUNT -1
237void fw_send_phy_config(struct fw_card *card,
238 int node_id, int generation, int gap_count);
239
240static inline bool is_ping_packet(u32 *data)
241{
242 return (data[0] & 0xc0ffffff) == 0 && ~data[0] == data[1];
243}
244
245#endif /* _FIREWIRE_CORE_H */