Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | #ifndef _IEEE1394_HOSTS_H |
2 | #define _IEEE1394_HOSTS_H | |
3 | ||
4 | #include <linux/device.h> | |
5 | #include <linux/wait.h> | |
6 | #include <linux/list.h> | |
7 | #include <linux/timer.h> | |
8 | #include <linux/skbuff.h> | |
9 | ||
10 | #include <asm/semaphore.h> | |
11 | ||
12 | #include "ieee1394_types.h" | |
13 | #include "csr.h" | |
14 | ||
15 | ||
16 | struct hpsb_packet; | |
17 | struct hpsb_iso; | |
18 | ||
19 | struct hpsb_host { | |
20 | struct list_head host_list; | |
21 | ||
22 | void *hostdata; | |
23 | ||
24 | atomic_t generation; | |
25 | ||
26 | struct sk_buff_head pending_packet_queue; | |
27 | ||
28 | struct timer_list timeout; | |
29 | unsigned long timeout_interval; | |
30 | ||
31 | unsigned char iso_listen_count[64]; | |
32 | ||
33 | int node_count; /* number of identified nodes on this bus */ | |
34 | int selfid_count; /* total number of SelfIDs received */ | |
35 | int nodes_active; /* number of nodes that are actually active */ | |
36 | ||
37 | nodeid_t node_id; /* node ID of this host */ | |
38 | nodeid_t irm_id; /* ID of this bus' isochronous resource manager */ | |
39 | nodeid_t busmgr_id; /* ID of this bus' bus manager */ | |
40 | ||
41 | /* this nodes state */ | |
42 | unsigned in_bus_reset:1; | |
43 | unsigned is_shutdown:1; | |
14c0fa24 | 44 | unsigned resume_packet_sent:1; |
1da177e4 LT |
45 | |
46 | /* this nodes' duties on the bus */ | |
47 | unsigned is_root:1; | |
48 | unsigned is_cycmst:1; | |
49 | unsigned is_irm:1; | |
50 | unsigned is_busmgr:1; | |
51 | ||
52 | int reset_retries; | |
53 | quadlet_t *topology_map; | |
54 | u8 *speed_map; | |
55 | struct csr_control csr; | |
56 | ||
57 | /* Per node tlabel pool allocation */ | |
58 | struct hpsb_tlabel_pool tpool[64]; | |
59 | ||
60 | struct hpsb_host_driver *driver; | |
61 | ||
62 | struct pci_dev *pdev; | |
63 | ||
64 | int id; | |
65 | ||
66 | struct device device; | |
67 | struct class_device class_dev; | |
68 | ||
69 | int update_config_rom; | |
70 | struct work_struct delayed_reset; | |
71 | ||
72 | unsigned int config_roms; | |
73 | ||
74 | struct list_head addr_space; | |
75 | }; | |
76 | ||
77 | ||
78 | ||
79 | enum devctl_cmd { | |
80 | /* Host is requested to reset its bus and cancel all outstanding async | |
81 | * requests. If arg == 1, it shall also attempt to become root on the | |
82 | * bus. Return void. */ | |
83 | RESET_BUS, | |
84 | ||
85 | /* Arg is void, return value is the hardware cycle counter value. */ | |
86 | GET_CYCLE_COUNTER, | |
87 | ||
88 | /* Set the hardware cycle counter to the value in arg, return void. | |
89 | * FIXME - setting is probably not required. */ | |
90 | SET_CYCLE_COUNTER, | |
91 | ||
92 | /* Configure hardware for new bus ID in arg, return void. */ | |
93 | SET_BUS_ID, | |
94 | ||
95 | /* If arg true, start sending cycle start packets, stop if arg == 0. | |
96 | * Return void. */ | |
97 | ACT_CYCLE_MASTER, | |
98 | ||
99 | /* Cancel all outstanding async requests without resetting the bus. | |
100 | * Return void. */ | |
101 | CANCEL_REQUESTS, | |
102 | ||
103 | /* Start or stop receiving isochronous channel in arg. Return void. | |
104 | * This acts as an optimization hint, hosts are not required not to | |
105 | * listen on unrequested channels. */ | |
106 | ISO_LISTEN_CHANNEL, | |
107 | ISO_UNLISTEN_CHANNEL | |
108 | }; | |
109 | ||
110 | enum isoctl_cmd { | |
111 | /* rawiso API - see iso.h for the meanings of these commands | |
112 | (they correspond exactly to the hpsb_iso_* API functions) | |
113 | * INIT = allocate resources | |
114 | * START = begin transmission/reception | |
115 | * STOP = halt transmission/reception | |
116 | * QUEUE/RELEASE = produce/consume packets | |
117 | * SHUTDOWN = deallocate resources | |
118 | */ | |
119 | ||
120 | XMIT_INIT, | |
121 | XMIT_START, | |
122 | XMIT_STOP, | |
123 | XMIT_QUEUE, | |
124 | XMIT_SHUTDOWN, | |
125 | ||
126 | RECV_INIT, | |
127 | RECV_LISTEN_CHANNEL, /* multi-channel only */ | |
128 | RECV_UNLISTEN_CHANNEL, /* multi-channel only */ | |
129 | RECV_SET_CHANNEL_MASK, /* multi-channel only; arg is a *u64 */ | |
130 | RECV_START, | |
131 | RECV_STOP, | |
132 | RECV_RELEASE, | |
133 | RECV_SHUTDOWN, | |
134 | RECV_FLUSH | |
135 | }; | |
136 | ||
137 | enum reset_types { | |
138 | /* 166 microsecond reset -- only type of reset available on | |
3256cc13 | 139 | non-1394a capable controllers */ |
1da177e4 LT |
140 | LONG_RESET, |
141 | ||
142 | /* Short (arbitrated) reset -- only available on 1394a capable | |
3256cc13 | 143 | controllers */ |
1da177e4 LT |
144 | SHORT_RESET, |
145 | ||
3256cc13 | 146 | /* Variants that set force_root before issueing the bus reset */ |
1da177e4 LT |
147 | LONG_RESET_FORCE_ROOT, SHORT_RESET_FORCE_ROOT, |
148 | ||
3256cc13 | 149 | /* Variants that clear force_root before issueing the bus reset */ |
1da177e4 LT |
150 | LONG_RESET_NO_FORCE_ROOT, SHORT_RESET_NO_FORCE_ROOT |
151 | }; | |
152 | ||
153 | struct hpsb_host_driver { | |
154 | struct module *owner; | |
155 | const char *name; | |
156 | ||
157 | /* The hardware driver may optionally support a function that is used | |
158 | * to set the hardware ConfigROM if the hardware supports handling | |
159 | * reads to the ConfigROM on its own. */ | |
160 | void (*set_hw_config_rom) (struct hpsb_host *host, quadlet_t *config_rom); | |
161 | ||
162 | /* This function shall implement packet transmission based on | |
163 | * packet->type. It shall CRC both parts of the packet (unless | |
164 | * packet->type == raw) and do byte-swapping as necessary or instruct | |
165 | * the hardware to do so. It can return immediately after the packet | |
166 | * was queued for sending. After sending, hpsb_sent_packet() has to be | |
167 | * called. Return 0 on success, negative errno on failure. | |
168 | * NOTE: The function must be callable in interrupt context. | |
169 | */ | |
170 | int (*transmit_packet) (struct hpsb_host *host, | |
171 | struct hpsb_packet *packet); | |
172 | ||
173 | /* This function requests miscellanous services from the driver, see | |
174 | * above for command codes and expected actions. Return -1 for unknown | |
175 | * command, though that should never happen. | |
176 | */ | |
177 | int (*devctl) (struct hpsb_host *host, enum devctl_cmd command, int arg); | |
178 | ||
179 | /* ISO transmission/reception functions. Return 0 on success, -1 | |
180 | * (or -EXXX errno code) on failure. If the low-level driver does not | |
181 | * support the new ISO API, set isoctl to NULL. | |
182 | */ | |
183 | int (*isoctl) (struct hpsb_iso *iso, enum isoctl_cmd command, unsigned long arg); | |
184 | ||
185 | /* This function is mainly to redirect local CSR reads/locks to the iso | |
186 | * management registers (bus manager id, bandwidth available, channels | |
187 | * available) to the hardware registers in OHCI. reg is 0,1,2,3 for bus | |
188 | * mgr, bwdth avail, ch avail hi, ch avail lo respectively (the same ids | |
189 | * as OHCI uses). data and compare are the new data and expected data | |
190 | * respectively, return value is the old value. | |
191 | */ | |
192 | quadlet_t (*hw_csr_reg) (struct hpsb_host *host, int reg, | |
193 | quadlet_t data, quadlet_t compare); | |
194 | }; | |
195 | ||
196 | ||
197 | struct hpsb_host *hpsb_alloc_host(struct hpsb_host_driver *drv, size_t extra, | |
198 | struct device *dev); | |
199 | int hpsb_add_host(struct hpsb_host *host); | |
200 | void hpsb_remove_host(struct hpsb_host *h); | |
201 | ||
202 | /* The following 2 functions are deprecated and will be removed when the | |
203 | * raw1394/libraw1394 update is complete. */ | |
204 | int hpsb_update_config_rom(struct hpsb_host *host, | |
205 | const quadlet_t *new_rom, size_t size, unsigned char rom_version); | |
206 | int hpsb_get_config_rom(struct hpsb_host *host, quadlet_t *buffer, | |
207 | size_t buffersize, size_t *rom_size, unsigned char *rom_version); | |
208 | ||
209 | /* Updates the configuration rom image of a host. rom_version must be the | |
210 | * current version, otherwise it will fail with return value -1. If this | |
211 | * host does not support config-rom-update, it will return -EINVAL. | |
212 | * Return value 0 indicates success. | |
213 | */ | |
214 | int hpsb_update_config_rom_image(struct hpsb_host *host); | |
215 | ||
216 | #endif /* _IEEE1394_HOSTS_H */ |