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 <asm/system.h> 25#include <asm/types.h> 26 27#include "ieee1394_core.h" 28#include "ieee1394_transactions.h" 29#include "ieee1394_types.h" 30 31struct csr1212_csr; 32struct csr1212_keyval; 33struct hpsb_host; 34struct ieee1394_device_id; 35 36/* This is the start of a Node entry structure. It should be a stable API 37 * for which to gather info from the Node Manager about devices attached 38 * to the bus. */ 39struct bus_options { 40 u8 irmc; /* Iso Resource Manager Capable */ 41 u8 cmc; /* Cycle Master Capable */ 42 u8 isc; /* Iso Capable */ 43 u8 bmc; /* Bus Master Capable */ 44 u8 pmc; /* Power Manager Capable (PNP spec) */ 45 u8 cyc_clk_acc; /* Cycle clock accuracy */ 46 u8 max_rom; /* Maximum block read supported in the CSR */ 47 u8 generation; /* Incremented when configrom changes */ 48 u8 lnkspd; /* Link speed */ 49 u16 max_rec; /* Maximum packet size node can receive */ 50}; 51 52#define UNIT_DIRECTORY_VENDOR_ID 0x01 53#define UNIT_DIRECTORY_MODEL_ID 0x02 54#define UNIT_DIRECTORY_SPECIFIER_ID 0x04 55#define UNIT_DIRECTORY_VERSION 0x08 56#define UNIT_DIRECTORY_HAS_LUN_DIRECTORY 0x10 57#define UNIT_DIRECTORY_LUN_DIRECTORY 0x20 58#define UNIT_DIRECTORY_HAS_LUN 0x40 59 60/* 61 * A unit directory corresponds to a protocol supported by the 62 * node. If a node supports eg. IP/1394 and AV/C, its config rom has a 63 * unit directory for each of these protocols. 64 */ 65struct unit_directory { 66 struct node_entry *ne; /* The node which this directory belongs to */ 67 octlet_t address; /* Address of the unit directory on the node */ 68 u8 flags; /* Indicates which entries were read */ 69 70 quadlet_t vendor_id; 71 struct csr1212_keyval *vendor_name_kv; 72 73 quadlet_t model_id; 74 struct csr1212_keyval *model_name_kv; 75 quadlet_t specifier_id; 76 quadlet_t version; 77 quadlet_t directory_id; 78 79 unsigned int id; 80 81 int ignore_driver; 82 83 int length; /* Number of quadlets */ 84 85 struct device device; 86 struct device unit_dev; 87 88 struct csr1212_keyval *ud_kv; 89 u32 lun; /* logical unit number immediate value */ 90}; 91 92struct node_entry { 93 u64 guid; /* GUID of this node */ 94 u32 guid_vendor_id; /* Top 24bits of guid */ 95 96 struct hpsb_host *host; /* Host this node is attached to */ 97 nodeid_t nodeid; /* NodeID */ 98 struct bus_options busopt; /* Bus Options */ 99 bool needs_probe; 100 unsigned int generation; /* Synced with hpsb generation */ 101 102 /* The following is read from the config rom */ 103 u32 vendor_id; 104 struct csr1212_keyval *vendor_name_kv; 105 106 u32 capabilities; 107 108 struct device device; 109 struct device node_dev; 110 111 /* Means this node is not attached anymore */ 112 bool in_limbo; 113 114 struct csr1212_csr *csr; 115}; 116 117struct hpsb_protocol_driver { 118 /* The name of the driver, e.g. SBP2 or IP1394 */ 119 const char *name; 120 121 /* 122 * The device id table describing the protocols and/or devices 123 * supported by this driver. This is used by the nodemgr to 124 * decide if a driver could support a given node, but the 125 * probe function below can implement further protocol 126 * dependent or vendor dependent checking. 127 */ 128 const struct ieee1394_device_id *id_table; 129 130 /* 131 * The update function is called when the node has just 132 * survived a bus reset, i.e. it is still present on the bus. 133 * However, it may be necessary to reestablish the connection 134 * or login into the node again, depending on the protocol. If the 135 * probe fails (returns non-zero), we unbind the driver from this 136 * device. 137 */ 138 int (*update)(struct unit_directory *ud); 139 140 /* Our LDM structure */ 141 struct device_driver driver; 142}; 143 144int __hpsb_register_protocol(struct hpsb_protocol_driver *, struct module *); 145static inline int hpsb_register_protocol(struct hpsb_protocol_driver *driver) 146{ 147 return __hpsb_register_protocol(driver, THIS_MODULE); 148} 149 150void hpsb_unregister_protocol(struct hpsb_protocol_driver *driver); 151 152static inline int hpsb_node_entry_valid(struct node_entry *ne) 153{ 154 return ne->generation == get_hpsb_generation(ne->host); 155} 156void hpsb_node_fill_packet(struct node_entry *ne, struct hpsb_packet *packet); 157int hpsb_node_write(struct node_entry *ne, u64 addr, 158 quadlet_t *buffer, size_t length); 159static inline int hpsb_node_read(struct node_entry *ne, u64 addr, 160 quadlet_t *buffer, size_t length) 161{ 162 unsigned int g = ne->generation; 163 164 smp_rmb(); 165 return hpsb_read(ne->host, ne->nodeid, g, addr, buffer, length); 166} 167static inline int hpsb_node_lock(struct node_entry *ne, u64 addr, int extcode, 168 quadlet_t *buffer, quadlet_t arg) 169{ 170 unsigned int g = ne->generation; 171 172 smp_rmb(); 173 return hpsb_lock(ne->host, ne->nodeid, g, addr, extcode, buffer, arg); 174} 175int nodemgr_for_each_host(void *data, int (*cb)(struct hpsb_host *, void *)); 176 177int init_ieee1394_nodemgr(void); 178void cleanup_ieee1394_nodemgr(void); 179 180/* The template for a host device */ 181extern struct device nodemgr_dev_template_host; 182 183/* Bus attributes we export */ 184extern struct bus_attribute *const fw_bus_attrs[]; 185 186#endif /* _IEEE1394_NODEMGR_H */ 187