blob: 979fd190f60f9d0e46b6da27e403caa5e573f608 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _IEEE1394_HOSTS_H
2#define _IEEE1394_HOSTS_H
3
4#include <linux/device.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -07005#include <linux/list.h>
Stefan Richterde4394f2006-07-03 12:02:29 -04006#include <linux/timer.h>
7#include <linux/types.h>
8#include <linux/workqueue.h>
9#include <asm/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
Stefan Richterde4394f2006-07-03 12:02:29 -040011struct pci_dev;
12struct module;
Linus Torvalds1da177e2005-04-16 15:20:36 -070013
14#include "ieee1394_types.h"
15#include "csr.h"
16
Linus Torvalds1da177e2005-04-16 15:20:36 -070017struct hpsb_packet;
18struct hpsb_iso;
19
20struct hpsb_host {
Stefan Richter741854e2005-12-01 18:52:03 -050021 struct list_head host_list;
Linus Torvalds1da177e2005-04-16 15:20:36 -070022
Stefan Richter741854e2005-12-01 18:52:03 -050023 void *hostdata;
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
Stefan Richter741854e2005-12-01 18:52:03 -050025 atomic_t generation;
Linus Torvalds1da177e2005-04-16 15:20:36 -070026
Stefan Richter7542e0e2007-03-25 22:22:40 +020027 struct list_head pending_packets;
Linus Torvalds1da177e2005-04-16 15:20:36 -070028 struct timer_list timeout;
29 unsigned long timeout_interval;
30
Stefan Richter741854e2005-12-01 18:52:03 -050031 unsigned char iso_listen_count[64];
Linus Torvalds1da177e2005-04-16 15:20:36 -070032
Ben Collinseaf88452006-06-12 18:12:49 -040033 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070036
Ben Collinseaf88452006-06-12 18:12:49 -040037 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 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Stefan Richter741854e2005-12-01 18:52:03 -050041 /* this nodes state */
42 unsigned in_bus_reset:1;
43 unsigned is_shutdown:1;
Stefan Richter14c0fa22005-12-01 18:51:52 -050044 unsigned resume_packet_sent:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070045
Stefan Richter741854e2005-12-01 18:52:03 -050046 /* 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -070051
Stefan Richter741854e2005-12-01 18:52:03 -050052 int reset_retries;
53 quadlet_t *topology_map;
54 u8 *speed_map;
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
56 int id;
Stefan Richter99519032006-07-02 14:17:00 +020057 struct hpsb_host_driver *driver;
58 struct pci_dev *pdev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 struct device device;
Kay Sieversdd7f2922007-05-25 11:50:53 +020060 struct device host_dev;
Linus Torvalds1da177e2005-04-16 15:20:36 -070061
David Howellsc4028952006-11-22 14:57:56 +000062 struct delayed_work delayed_reset;
Stefan Richterd06170a2007-01-07 21:51:48 +010063 unsigned config_roms:31;
64 unsigned update_config_rom:1;
Linus Torvalds1da177e2005-04-16 15:20:36 -070065
66 struct list_head addr_space;
Ben Collins8aef63f2006-06-12 18:13:21 -040067 u64 low_addr_space; /* upper bound of physical DMA area */
68 u64 middle_addr_space; /* upper bound of posted write area */
Stefan Richter99519032006-07-02 14:17:00 +020069
70 u8 speed[ALL_NODES]; /* speed between each node and local node */
71
72 /* per node tlabel allocation */
73 u8 next_tl[ALL_NODES];
74 struct { DECLARE_BITMAP(map, 64); } tl_pool[ALL_NODES];
75
76 struct csr_control csr;
Linus Torvalds1da177e2005-04-16 15:20:36 -070077};
78
Linus Torvalds1da177e2005-04-16 15:20:36 -070079enum devctl_cmd {
Stefan Richter741854e2005-12-01 18:52:03 -050080 /* 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,
Linus Torvalds1da177e2005-04-16 15:20:36 -070084
Stefan Richter741854e2005-12-01 18:52:03 -050085 /* Arg is void, return value is the hardware cycle counter value. */
86 GET_CYCLE_COUNTER,
Linus Torvalds1da177e2005-04-16 15:20:36 -070087
Stefan Richter741854e2005-12-01 18:52:03 -050088 /* Set the hardware cycle counter to the value in arg, return void.
89 * FIXME - setting is probably not required. */
90 SET_CYCLE_COUNTER,
Linus Torvalds1da177e2005-04-16 15:20:36 -070091
Stefan Richter741854e2005-12-01 18:52:03 -050092 /* Configure hardware for new bus ID in arg, return void. */
93 SET_BUS_ID,
Linus Torvalds1da177e2005-04-16 15:20:36 -070094
Stefan Richter741854e2005-12-01 18:52:03 -050095 /* If arg true, start sending cycle start packets, stop if arg == 0.
96 * Return void. */
97 ACT_CYCLE_MASTER,
Linus Torvalds1da177e2005-04-16 15:20:36 -070098
Stefan Richter741854e2005-12-01 18:52:03 -050099 /* Cancel all outstanding async requests without resetting the bus.
100 * Return void. */
101 CANCEL_REQUESTS,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102
Stefan Richter741854e2005-12-01 18:52:03 -0500103 /* 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
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108};
109
110enum isoctl_cmd {
111 /* rawiso API - see iso.h for the meanings of these commands
Stefan Richtere1d118f2006-07-03 12:02:28 -0400112 * (they correspond exactly to the hpsb_iso_* API functions)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113 * 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
137enum reset_types {
Stefan Richter741854e2005-12-01 18:52:03 -0500138 /* 166 microsecond reset -- only type of reset available on
139 non-1394a capable controllers */
140 LONG_RESET,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141
Stefan Richter741854e2005-12-01 18:52:03 -0500142 /* Short (arbitrated) reset -- only available on 1394a capable
143 controllers */
144 SHORT_RESET,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145
Jody McIntyre3256cc12005-09-30 11:59:16 -0700146 /* Variants that set force_root before issueing the bus reset */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147 LONG_RESET_FORCE_ROOT, SHORT_RESET_FORCE_ROOT,
148
Jody McIntyre3256cc12005-09-30 11:59:16 -0700149 /* Variants that clear force_root before issueing the bus reset */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 LONG_RESET_NO_FORCE_ROOT, SHORT_RESET_NO_FORCE_ROOT
151};
152
153struct 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. */
Stefan Richtere1d118f2006-07-03 12:02:28 -0400160 void (*set_hw_config_rom)(struct hpsb_host *host,
161 quadlet_t *config_rom);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162
Stefan Richter741854e2005-12-01 18:52:03 -0500163 /* 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 */
Stefan Richtere1d118f2006-07-03 12:02:28 -0400171 int (*transmit_packet)(struct hpsb_host *host,
172 struct hpsb_packet *packet);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
Stefan Richter741854e2005-12-01 18:52:03 -0500174 /* 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 */
Stefan Richtere1d118f2006-07-03 12:02:28 -0400178 int (*devctl)(struct hpsb_host *host, enum devctl_cmd command, int arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
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 */
Stefan Richtere1d118f2006-07-03 12:02:28 -0400184 int (*isoctl)(struct hpsb_iso *iso, enum isoctl_cmd command,
185 unsigned long arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
Stefan Richter741854e2005-12-01 18:52:03 -0500187 /* This function is mainly to redirect local CSR reads/locks to the iso
188 * management registers (bus manager id, bandwidth available, channels
189 * available) to the hardware registers in OHCI. reg is 0,1,2,3 for bus
190 * mgr, bwdth avail, ch avail hi, ch avail lo respectively (the same ids
191 * as OHCI uses). data and compare are the new data and expected data
192 * respectively, return value is the old value.
193 */
194 quadlet_t (*hw_csr_reg) (struct hpsb_host *host, int reg,
195 quadlet_t data, quadlet_t compare);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196};
197
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198struct hpsb_host *hpsb_alloc_host(struct hpsb_host_driver *drv, size_t extra,
199 struct device *dev);
200int hpsb_add_host(struct hpsb_host *host);
Stefan Richter33601772007-01-07 21:49:27 +0100201void hpsb_resume_host(struct hpsb_host *host);
202void hpsb_remove_host(struct hpsb_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203int hpsb_update_config_rom_image(struct hpsb_host *host);
204
205#endif /* _IEEE1394_HOSTS_H */