Commit | Line | Data |
---|---|---|
1da177e4 LT |
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> | |
de4394f1 SR |
24 | #include <asm/types.h> |
25 | ||
1da177e4 | 26 | #include "ieee1394_core.h" |
de4394f1 SR |
27 | #include "ieee1394_types.h" |
28 | ||
29 | struct csr1212_csr; | |
30 | struct csr1212_keyval; | |
31 | struct hpsb_host; | |
32 | struct ieee1394_device_id; | |
1da177e4 LT |
33 | |
34 | /* '1' '3' '9' '4' in ASCII */ | |
35 | #define IEEE1394_BUSID_MAGIC __constant_cpu_to_be32(0x31333934) | |
36 | ||
37 | /* This is the start of a Node entry structure. It should be a stable API | |
38 | * for which to gather info from the Node Manager about devices attached | |
39 | * to the bus. */ | |
40 | struct bus_options { | |
41 | u8 irmc; /* Iso Resource Manager Capable */ | |
42 | u8 cmc; /* Cycle Master Capable */ | |
43 | u8 isc; /* Iso Capable */ | |
44 | u8 bmc; /* Bus Master Capable */ | |
45 | u8 pmc; /* Power Manager Capable (PNP spec) */ | |
46 | u8 cyc_clk_acc; /* Cycle clock accuracy */ | |
47 | u8 max_rom; /* Maximum block read supported in the CSR */ | |
48 | u8 generation; /* Incremented when configrom changes */ | |
49 | u8 lnkspd; /* Link speed */ | |
50 | u16 max_rec; /* Maximum packet size node can receive */ | |
51 | }; | |
52 | ||
1da177e4 LT |
53 | #define UNIT_DIRECTORY_VENDOR_ID 0x01 |
54 | #define UNIT_DIRECTORY_MODEL_ID 0x02 | |
55 | #define UNIT_DIRECTORY_SPECIFIER_ID 0x04 | |
56 | #define UNIT_DIRECTORY_VERSION 0x08 | |
57 | #define UNIT_DIRECTORY_HAS_LUN_DIRECTORY 0x10 | |
58 | #define UNIT_DIRECTORY_LUN_DIRECTORY 0x20 | |
59 | #define UNIT_DIRECTORY_HAS_LUN 0x40 | |
60 | ||
61 | /* | |
62 | * A unit directory corresponds to a protocol supported by the | |
63 | * node. If a node supports eg. IP/1394 and AV/C, its config rom has a | |
64 | * unit directory for each of these protocols. | |
65 | */ | |
66 | struct unit_directory { | |
e1d118f1 SR |
67 | struct node_entry *ne; /* The node which this directory belongs to */ |
68 | octlet_t address; /* Address of the unit directory on the node */ | |
1da177e4 LT |
69 | u8 flags; /* Indicates which entries were read */ |
70 | ||
71 | quadlet_t vendor_id; | |
72 | struct csr1212_keyval *vendor_name_kv; | |
1da177e4 LT |
73 | |
74 | quadlet_t model_id; | |
75 | struct csr1212_keyval *model_name_kv; | |
76 | quadlet_t specifier_id; | |
77 | quadlet_t version; | |
d7794c86 | 78 | quadlet_t directory_id; |
1da177e4 LT |
79 | |
80 | unsigned int id; | |
81 | ||
82 | int ignore_driver; | |
83 | ||
84 | int length; /* Number of quadlets */ | |
85 | ||
86 | struct device device; | |
dd7f2928 | 87 | struct device unit_dev; |
1da177e4 LT |
88 | |
89 | struct csr1212_keyval *ud_kv; | |
e1d118f1 | 90 | u32 lun; /* logical unit number immediate value */ |
1da177e4 LT |
91 | }; |
92 | ||
93 | struct node_entry { | |
94 | u64 guid; /* GUID of this node */ | |
95 | u32 guid_vendor_id; /* Top 24bits of guid */ | |
1da177e4 LT |
96 | |
97 | struct hpsb_host *host; /* Host this node is attached to */ | |
98 | nodeid_t nodeid; /* NodeID */ | |
99 | struct bus_options busopt; /* Bus Options */ | |
100 | int needs_probe; | |
101 | unsigned int generation; /* Synced with hpsb generation */ | |
102 | ||
103 | /* The following is read from the config rom */ | |
104 | u32 vendor_id; | |
105 | struct csr1212_keyval *vendor_name_kv; | |
1da177e4 LT |
106 | |
107 | u32 capabilities; | |
1da177e4 LT |
108 | |
109 | struct device device; | |
dd7f2928 | 110 | struct device node_dev; |
1da177e4 LT |
111 | |
112 | /* Means this node is not attached anymore */ | |
113 | int in_limbo; | |
114 | ||
115 | struct csr1212_csr *csr; | |
116 | }; | |
117 | ||
118 | struct 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 | ||
ed30c26e BC |
145 | int __hpsb_register_protocol(struct hpsb_protocol_driver *, struct module *); |
146 | static inline int hpsb_register_protocol(struct hpsb_protocol_driver *driver) | |
147 | { | |
148 | return __hpsb_register_protocol(driver, THIS_MODULE); | |
149 | } | |
150 | ||
1da177e4 LT |
151 | void hpsb_unregister_protocol(struct hpsb_protocol_driver *driver); |
152 | ||
153 | static inline int hpsb_node_entry_valid(struct node_entry *ne) | |
154 | { | |
155 | return ne->generation == get_hpsb_generation(ne->host); | |
156 | } | |
afd6546d | 157 | void hpsb_node_fill_packet(struct node_entry *ne, struct hpsb_packet *packet); |
1da177e4 LT |
158 | int hpsb_node_write(struct node_entry *ne, u64 addr, |
159 | quadlet_t *buffer, size_t length); | |
afd6546d | 160 | int nodemgr_for_each_host(void *data, int (*cb)(struct hpsb_host *, void *)); |
1da177e4 | 161 | |
1da177e4 LT |
162 | int init_ieee1394_nodemgr(void); |
163 | void cleanup_ieee1394_nodemgr(void); | |
164 | ||
1da177e4 LT |
165 | /* The template for a host device */ |
166 | extern struct device nodemgr_dev_template_host; | |
167 | ||
168 | /* Bus attributes we export */ | |
169 | extern struct bus_attribute *const fw_bus_attrs[]; | |
170 | ||
171 | #endif /* _IEEE1394_NODEMGR_H */ |