aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/ieee1394/nodemgr.h
diff options
context:
space:
mode:
Diffstat (limited to 'drivers/ieee1394/nodemgr.h')
-rw-r--r--drivers/ieee1394/nodemgr.h207
1 files changed, 207 insertions, 0 deletions
diff --git a/drivers/ieee1394/nodemgr.h b/drivers/ieee1394/nodemgr.h
new file mode 100644
index 000000000000..3a2f0c02fd08
--- /dev/null
+++ b/drivers/ieee1394/nodemgr.h
@@ -0,0 +1,207 @@
1/*
2 * Copyright (C) 2000 Andreas E. Bombe
3 * 2001 Ben Collins <bcollins@debian.org>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software Foundation,
17 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
18 */
19
20#ifndef _IEEE1394_NODEMGR_H
21#define _IEEE1394_NODEMGR_H
22
23#include <linux/device.h>
24#include "csr1212.h"
25#include "ieee1394_core.h"
26#include "ieee1394_hotplug.h"
27
28/* '1' '3' '9' '4' in ASCII */
29#define IEEE1394_BUSID_MAGIC __constant_cpu_to_be32(0x31333934)
30
31/* This is the start of a Node entry structure. It should be a stable API
32 * for which to gather info from the Node Manager about devices attached
33 * to the bus. */
34struct bus_options {
35 u8 irmc; /* Iso Resource Manager Capable */
36 u8 cmc; /* Cycle Master Capable */
37 u8 isc; /* Iso Capable */
38 u8 bmc; /* Bus Master Capable */
39 u8 pmc; /* Power Manager Capable (PNP spec) */
40 u8 cyc_clk_acc; /* Cycle clock accuracy */
41 u8 max_rom; /* Maximum block read supported in the CSR */
42 u8 generation; /* Incremented when configrom changes */
43 u8 lnkspd; /* Link speed */
44 u16 max_rec; /* Maximum packet size node can receive */
45};
46
47
48#define UNIT_DIRECTORY_VENDOR_ID 0x01
49#define UNIT_DIRECTORY_MODEL_ID 0x02
50#define UNIT_DIRECTORY_SPECIFIER_ID 0x04
51#define UNIT_DIRECTORY_VERSION 0x08
52#define UNIT_DIRECTORY_HAS_LUN_DIRECTORY 0x10
53#define UNIT_DIRECTORY_LUN_DIRECTORY 0x20
54#define UNIT_DIRECTORY_HAS_LUN 0x40
55
56/*
57 * A unit directory corresponds to a protocol supported by the
58 * node. If a node supports eg. IP/1394 and AV/C, its config rom has a
59 * unit directory for each of these protocols.
60 */
61struct unit_directory {
62 struct node_entry *ne; /* The node which this directory belongs to */
63 octlet_t address; /* Address of the unit directory on the node */
64 u8 flags; /* Indicates which entries were read */
65
66 quadlet_t vendor_id;
67 struct csr1212_keyval *vendor_name_kv;
68 const char *vendor_oui;
69
70 quadlet_t model_id;
71 struct csr1212_keyval *model_name_kv;
72 quadlet_t specifier_id;
73 quadlet_t version;
74
75 unsigned int id;
76
77 int ignore_driver;
78
79 int length; /* Number of quadlets */
80
81 struct device device;
82
83 struct class_device class_dev;
84
85 struct csr1212_keyval *ud_kv;
86 u32 lun; /* logical unit number immediate value */
87};
88
89struct node_entry {
90 u64 guid; /* GUID of this node */
91 u32 guid_vendor_id; /* Top 24bits of guid */
92 const char *guid_vendor_oui; /* OUI name of guid vendor id */
93
94 struct hpsb_host *host; /* Host this node is attached to */
95 nodeid_t nodeid; /* NodeID */
96 struct bus_options busopt; /* Bus Options */
97 int needs_probe;
98 unsigned int generation; /* Synced with hpsb generation */
99
100 /* The following is read from the config rom */
101 u32 vendor_id;
102 struct csr1212_keyval *vendor_name_kv;
103 const char *vendor_oui;
104
105 u32 capabilities;
106 struct hpsb_tlabel_pool *tpool;
107
108 struct device device;
109
110 struct class_device class_dev;
111
112 /* Means this node is not attached anymore */
113 int in_limbo;
114
115 struct csr1212_csr *csr;
116};
117
118struct hpsb_protocol_driver {
119 /* The name of the driver, e.g. SBP2 or IP1394 */
120 const char *name;
121
122 /*
123 * The device id table describing the protocols and/or devices
124 * supported by this driver. This is used by the nodemgr to
125 * decide if a driver could support a given node, but the
126 * probe function below can implement further protocol
127 * dependent or vendor dependent checking.
128 */
129 struct ieee1394_device_id *id_table;
130
131 /*
132 * The update function is called when the node has just
133 * survived a bus reset, i.e. it is still present on the bus.
134 * However, it may be necessary to reestablish the connection
135 * or login into the node again, depending on the protocol. If the
136 * probe fails (returns non-zero), we unbind the driver from this
137 * device.
138 */
139 int (*update)(struct unit_directory *ud);
140
141 /* Our LDM structure */
142 struct device_driver driver;
143};
144
145int hpsb_register_protocol(struct hpsb_protocol_driver *driver);
146void hpsb_unregister_protocol(struct hpsb_protocol_driver *driver);
147
148static inline int hpsb_node_entry_valid(struct node_entry *ne)
149{
150 return ne->generation == get_hpsb_generation(ne->host);
151}
152
153/*
154 * Returns a node entry (which has its reference count incremented) or NULL if
155 * the GUID in question is not known. Getting a valid entry does not mean that
156 * the node with this GUID is currently accessible (might be powered down).
157 */
158struct node_entry *hpsb_guid_get_entry(u64 guid);
159
160/* Same as above, but use the nodeid to get an node entry. This is not
161 * fool-proof by itself, since the nodeid can change. */
162struct node_entry *hpsb_nodeid_get_entry(struct hpsb_host *host, nodeid_t nodeid);
163
164/*
165 * If the entry refers to a local host, this function will return the pointer
166 * to the hpsb_host structure. It will return NULL otherwise. Once you have
167 * established it is a local host, you can use that knowledge from then on (the
168 * GUID won't wander to an external node). */
169struct hpsb_host *hpsb_get_host_by_ne(struct node_entry *ne);
170
171/*
172 * This will fill in the given, pre-initialised hpsb_packet with the current
173 * information from the node entry (host, node ID, generation number). It will
174 * return false if the node owning the GUID is not accessible (and not modify the
175 * hpsb_packet) and return true otherwise.
176 *
177 * Note that packet sending may still fail in hpsb_send_packet if a bus reset
178 * happens while you are trying to set up the packet (due to obsolete generation
179 * number). It will at least reliably fail so that you don't accidentally and
180 * unknowingly send your packet to the wrong node.
181 */
182void hpsb_node_fill_packet(struct node_entry *ne, struct hpsb_packet *pkt);
183
184int hpsb_node_read(struct node_entry *ne, u64 addr,
185 quadlet_t *buffer, size_t length);
186int hpsb_node_write(struct node_entry *ne, u64 addr,
187 quadlet_t *buffer, size_t length);
188int hpsb_node_lock(struct node_entry *ne, u64 addr,
189 int extcode, quadlet_t *data, quadlet_t arg);
190
191
192/* Iterate the hosts, calling a given function with supplied data for each
193 * host. */
194int nodemgr_for_each_host(void *__data, int (*cb)(struct hpsb_host *, void *));
195
196
197int init_ieee1394_nodemgr(void);
198void cleanup_ieee1394_nodemgr(void);
199
200
201/* The template for a host device */
202extern struct device nodemgr_dev_template_host;
203
204/* Bus attributes we export */
205extern struct bus_attribute *const fw_bus_attrs[];
206
207#endif /* _IEEE1394_NODEMGR_H */
generated by cgit v1.2.2 (git 2.25.0) at 2024-11-28 10:01:44 -0500