1 #ifndef _IEEE1394_HOSTS_H 2 #define _IEEE1394_HOSTS_H 3 4 #include <linux/device.h> 5 #include <linux/list.h> 6 #include <linux/timer.h> 7 #include <linux/types.h> 8 #include <linux/workqueue.h> 9 #include <asm/atomic.h> 10 11 struct pci_dev; 12 struct module; 13 14 #include "ieee1394_types.h" 15 #include "csr.h" 16 #include "highlevel.h" 17 18 struct hpsb_packet; 19 struct hpsb_iso; 20 21 struct hpsb_host { 22 struct list_head host_list; 23 24 void *hostdata; 25 26 atomic_t generation; 27 28 struct list_head pending_packets; 29 struct timer_list timeout; 30 unsigned long timeout_interval; 31 32 int node_count; /* number of identified nodes on this bus */ 33 int selfid_count; /* total number of SelfIDs received */ 34 int nodes_active; /* number of nodes with active link layer */ 35 36 nodeid_t node_id; /* node ID of this host */ 37 nodeid_t irm_id; /* ID of this bus' isochronous resource manager */ 38 nodeid_t busmgr_id; /* ID of this bus' bus manager */ 39 40 /* this nodes state */ 41 unsigned in_bus_reset:1; 42 unsigned is_shutdown:1; 43 unsigned resume_packet_sent:1; 44 45 /* this nodes' duties on the bus */ 46 unsigned is_root:1; 47 unsigned is_cycmst:1; 48 unsigned is_irm:1; 49 unsigned is_busmgr:1; 50 51 int reset_retries; 52 quadlet_t *topology_map; 53 u8 *speed_map; 54 55 int id; 56 struct hpsb_host_driver *driver; 57 struct pci_dev *pdev; 58 struct device device; 59 struct device host_dev; 60 61 struct delayed_work delayed_reset; 62 unsigned config_roms:31; 63 unsigned update_config_rom:1; 64 65 struct list_head addr_space; 66 u64 low_addr_space; /* upper bound of physical DMA area */ 67 u64 middle_addr_space; /* upper bound of posted write area */ 68 69 u8 speed[ALL_NODES]; /* speed between each node and local node */ 70 71 /* per node tlabel allocation */ 72 u8 next_tl[ALL_NODES]; 73 struct { DECLARE_BITMAP(map, 64); } tl_pool[ALL_NODES]; 74 75 struct csr_control csr; 76 77 struct hpsb_address_serve dummy_zero_addr; 78 struct hpsb_address_serve dummy_max_addr; 79 }; 80 81 enum devctl_cmd { 82 /* Host is requested to reset its bus and cancel all outstanding async 83 * requests. If arg == 1, it shall also attempt to become root on the 84 * bus. Return void. */ 85 RESET_BUS, 86 87 /* Arg is void, return value is the hardware cycle counter value. */ 88 GET_CYCLE_COUNTER, 89 90 /* Set the hardware cycle counter to the value in arg, return void. 91 * FIXME - setting is probably not required. */ 92 SET_CYCLE_COUNTER, 93 94 /* Configure hardware for new bus ID in arg, return void. */ 95 SET_BUS_ID, 96 97 /* If arg true, start sending cycle start packets, stop if arg == 0. 98 * Return void. */ 99 ACT_CYCLE_MASTER, 100 101 /* Cancel all outstanding async requests without resetting the bus. 102 * Return void. */ 103 CANCEL_REQUESTS, 104 }; 105 106 enum isoctl_cmd { 107 /* rawiso API - see iso.h for the meanings of these commands 108 * (they correspond exactly to the hpsb_iso_* API functions) 109 * INIT = allocate resources 110 * START = begin transmission/reception 111 * STOP = halt transmission/reception 112 * QUEUE/RELEASE = produce/consume packets 113 * SHUTDOWN = deallocate resources 114 */ 115 116 XMIT_INIT, 117 XMIT_START, 118 XMIT_STOP, 119 XMIT_QUEUE, 120 XMIT_SHUTDOWN, 121 122 RECV_INIT, 123 RECV_LISTEN_CHANNEL, /* multi-channel only */ 124 RECV_UNLISTEN_CHANNEL, /* multi-channel only */ 125 RECV_SET_CHANNEL_MASK, /* multi-channel only; arg is a *u64 */ 126 RECV_START, 127 RECV_STOP, 128 RECV_RELEASE, 129 RECV_SHUTDOWN, 130 RECV_FLUSH 131 }; 132 133 enum reset_types { 134 /* 166 microsecond reset -- only type of reset available on 135 non-1394a capable controllers */ 136 LONG_RESET, 137 138 /* Short (arbitrated) reset -- only available on 1394a capable 139 controllers */ 140 SHORT_RESET, 141 142 /* Variants that set force_root before issueing the bus reset */ 143 LONG_RESET_FORCE_ROOT, SHORT_RESET_FORCE_ROOT, 144 145 /* Variants that clear force_root before issueing the bus reset */ 146 LONG_RESET_NO_FORCE_ROOT, SHORT_RESET_NO_FORCE_ROOT 147 }; 148 149 struct hpsb_host_driver { 150 struct module *owner; 151 const char *name; 152 153 /* The hardware driver may optionally support a function that is used 154 * to set the hardware ConfigROM if the hardware supports handling 155 * reads to the ConfigROM on its own. */ 156 void (*set_hw_config_rom)(struct hpsb_host *host, 157 __be32 *config_rom); 158 159 /* This function shall implement packet transmission based on 160 * packet->type. It shall CRC both parts of the packet (unless 161 * packet->type == raw) and do byte-swapping as necessary or instruct 162 * the hardware to do so. It can return immediately after the packet 163 * was queued for sending. After sending, hpsb_sent_packet() has to be 164 * called. Return 0 on success, negative errno on failure. 165 * NOTE: The function must be callable in interrupt context. 166 */ 167 int (*transmit_packet)(struct hpsb_host *host, 168 struct hpsb_packet *packet); 169 170 /* This function requests miscellanous services from the driver, see 171 * above for command codes and expected actions. Return -1 for unknown 172 * command, though that should never happen. 173 */ 174 int (*devctl)(struct hpsb_host *host, enum devctl_cmd command, int arg); 175 176 /* ISO transmission/reception functions. Return 0 on success, -1 177 * (or -EXXX errno code) on failure. If the low-level driver does not 178 * support the new ISO API, set isoctl to NULL. 179 */ 180 int (*isoctl)(struct hpsb_iso *iso, enum isoctl_cmd command, 181 unsigned long arg); 182 183 /* This function is mainly to redirect local CSR reads/locks to the iso 184 * management registers (bus manager id, bandwidth available, channels 185 * available) to the hardware registers in OHCI. reg is 0,1,2,3 for bus 186 * mgr, bwdth avail, ch avail hi, ch avail lo respectively (the same ids 187 * as OHCI uses). data and compare are the new data and expected data 188 * respectively, return value is the old value. 189 */ 190 quadlet_t (*hw_csr_reg) (struct hpsb_host *host, int reg, 191 quadlet_t data, quadlet_t compare); 192 }; 193 194 struct hpsb_host *hpsb_alloc_host(struct hpsb_host_driver *drv, size_t extra, 195 struct device *dev); 196 int hpsb_add_host(struct hpsb_host *host); 197 void hpsb_resume_host(struct hpsb_host *host); 198 void hpsb_remove_host(struct hpsb_host *host); 199 int hpsb_update_config_rom_image(struct hpsb_host *host); 200 201 #endif /* _IEEE1394_HOSTS_H */ 202