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