[PATCH] ieee1394: coding style and comment fixes in midlayer header files
[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         u64 low_addr_space;     /* upper bound of physical DMA area */
77         u64 middle_addr_space;  /* upper bound of posted write area */
78 };
79
80
81
82 enum devctl_cmd {
83         /* Host is requested to reset its bus and cancel all outstanding async
84          * requests.  If arg == 1, it shall also attempt to become root on the
85          * bus.  Return void. */
86         RESET_BUS,
87
88         /* Arg is void, return value is the hardware cycle counter value. */
89         GET_CYCLE_COUNTER,
90
91         /* Set the hardware cycle counter to the value in arg, return void.
92          * FIXME - setting is probably not required. */
93         SET_CYCLE_COUNTER,
94
95         /* Configure hardware for new bus ID in arg, return void. */
96         SET_BUS_ID,
97
98         /* If arg true, start sending cycle start packets, stop if arg == 0.
99          * Return void. */
100         ACT_CYCLE_MASTER,
101
102         /* Cancel all outstanding async requests without resetting the bus.
103          * Return void. */
104         CANCEL_REQUESTS,
105
106         /* Start or stop receiving isochronous channel in arg.  Return void.
107          * This acts as an optimization hint, hosts are not required not to
108          * listen on unrequested channels. */
109         ISO_LISTEN_CHANNEL,
110         ISO_UNLISTEN_CHANNEL
111 };
112
113 enum isoctl_cmd {
114         /* rawiso API - see iso.h for the meanings of these commands
115          * (they correspond exactly to the hpsb_iso_* API functions)
116          * INIT = allocate resources
117          * START = begin transmission/reception
118          * STOP = halt transmission/reception
119          * QUEUE/RELEASE = produce/consume packets
120          * SHUTDOWN = deallocate resources
121          */
122
123         XMIT_INIT,
124         XMIT_START,
125         XMIT_STOP,
126         XMIT_QUEUE,
127         XMIT_SHUTDOWN,
128
129         RECV_INIT,
130         RECV_LISTEN_CHANNEL,   /* multi-channel only */
131         RECV_UNLISTEN_CHANNEL, /* multi-channel only */
132         RECV_SET_CHANNEL_MASK, /* multi-channel only; arg is a *u64 */
133         RECV_START,
134         RECV_STOP,
135         RECV_RELEASE,
136         RECV_SHUTDOWN,
137         RECV_FLUSH
138 };
139
140 enum reset_types {
141         /* 166 microsecond reset -- only type of reset available on
142            non-1394a capable controllers */
143         LONG_RESET,
144
145         /* Short (arbitrated) reset -- only available on 1394a capable
146            controllers */
147         SHORT_RESET,
148
149         /* Variants that set force_root before issueing the bus reset */
150         LONG_RESET_FORCE_ROOT, SHORT_RESET_FORCE_ROOT,
151
152         /* Variants that clear force_root before issueing the bus reset */
153         LONG_RESET_NO_FORCE_ROOT, SHORT_RESET_NO_FORCE_ROOT
154 };
155
156 struct hpsb_host_driver {
157         struct module *owner;
158         const char *name;
159
160         /* The hardware driver may optionally support a function that is used
161          * to set the hardware ConfigROM if the hardware supports handling
162          * reads to the ConfigROM on its own. */
163         void (*set_hw_config_rom)(struct hpsb_host *host,
164                                   quadlet_t *config_rom);
165
166         /* This function shall implement packet transmission based on
167          * packet->type.  It shall CRC both parts of the packet (unless
168          * packet->type == raw) and do byte-swapping as necessary or instruct
169          * the hardware to do so.  It can return immediately after the packet
170          * was queued for sending.  After sending, hpsb_sent_packet() has to be
171          * called.  Return 0 on success, negative errno on failure.
172          * NOTE: The function must be callable in interrupt context.
173          */
174         int (*transmit_packet)(struct hpsb_host *host,
175                                struct hpsb_packet *packet);
176
177         /* This function requests miscellanous services from the driver, see
178          * above for command codes and expected actions.  Return -1 for unknown
179          * command, though that should never happen.
180          */
181         int (*devctl)(struct hpsb_host *host, enum devctl_cmd command, int arg);
182
183          /* ISO transmission/reception functions. Return 0 on success, -1
184           * (or -EXXX errno code) on failure. If the low-level driver does not
185           * support the new ISO API, set isoctl to NULL.
186           */
187         int (*isoctl)(struct hpsb_iso *iso, enum isoctl_cmd command,
188                       unsigned long arg);
189
190         /* This function is mainly to redirect local CSR reads/locks to the iso
191          * management registers (bus manager id, bandwidth available, channels
192          * available) to the hardware registers in OHCI.  reg is 0,1,2,3 for bus
193          * mgr, bwdth avail, ch avail hi, ch avail lo respectively (the same ids
194          * as OHCI uses).  data and compare are the new data and expected data
195          * respectively, return value is the old value.
196          */
197         quadlet_t (*hw_csr_reg) (struct hpsb_host *host, int reg,
198                                  quadlet_t data, quadlet_t compare);
199 };
200
201 struct hpsb_host *hpsb_alloc_host(struct hpsb_host_driver *drv, size_t extra,
202                                   struct device *dev);
203 int hpsb_add_host(struct hpsb_host *host);
204 void hpsb_remove_host(struct hpsb_host *h);
205
206 /* The following 2 functions are deprecated and will be removed when the
207  * raw1394/libraw1394 update is complete. */
208 int hpsb_update_config_rom(struct hpsb_host *host,
209       const quadlet_t *new_rom, size_t size, unsigned char rom_version);
210 int hpsb_get_config_rom(struct hpsb_host *host, quadlet_t *buffer,
211       size_t buffersize, size_t *rom_size, unsigned char *rom_version);
212
213 /* Updates the configuration rom image of a host.  rom_version must be the
214  * current version, otherwise it will fail with return value -1. If this
215  * host does not support config-rom-update, it will return -EINVAL.
216  * Return value 0 indicates success.
217  */
218 int hpsb_update_config_rom_image(struct hpsb_host *host);
219
220 #endif /* _IEEE1394_HOSTS_H */