summaryrefslogtreecommitdiffstats
path: root/drivers/ieee1394/hosts.h
diff options
context:
space:
mode:
authorRalf Baechle <ralf@linux-mips.org>2000-02-16 01:07:24 +0000
committerRalf Baechle <ralf@linux-mips.org>2000-02-16 01:07:24 +0000
commit95db6b748fc86297827fbd9c9ef174d491c9ad89 (patch)
tree27a92a942821cde1edda9a1b088718d436b3efe4 /drivers/ieee1394/hosts.h
parent45b27b0a0652331d104c953a5b192d843fff88f8 (diff)
Merge with Linux 2.3.40.
Diffstat (limited to 'drivers/ieee1394/hosts.h')
-rw-r--r--drivers/ieee1394/hosts.h192
1 files changed, 192 insertions, 0 deletions
diff --git a/drivers/ieee1394/hosts.h b/drivers/ieee1394/hosts.h
new file mode 100644
index 000000000..d516e7f8c
--- /dev/null
+++ b/drivers/ieee1394/hosts.h
@@ -0,0 +1,192 @@
+
+#ifndef _IEEE1394_HOSTS_H
+#define _IEEE1394_HOSTS_H
+
+#include <linux/wait.h>
+#include <linux/tqueue.h>
+
+#include "ieee1394_types.h"
+#include "csr.h"
+
+
+struct hpsb_packet;
+
+struct hpsb_host {
+/* private fields (hosts, do not use them) */
+ struct hpsb_host *next;
+
+ struct list_head pending_packets;
+ spinlock_t pending_pkt_lock;
+ struct tq_struct timeout_tq;
+
+ /* A bitmask where a set bit means that this tlabel is in use.
+ * FIXME - should be handled per node instead of per bus. */
+ u32 tlabel_pool[2];
+ int tlabel_count;
+ spinlock_t tlabel_lock;
+ wait_queue_head_t tlabel_wait;
+
+ int reset_retries;
+ quadlet_t *topology_map, *speed_map;
+ struct csr_control csr;
+
+ unsigned char iso_listen_count[64];
+
+/* readonly fields for hosts */
+ struct hpsb_host_template *template;
+
+ int node_count; /* number of identified nodes on this bus */
+ int selfid_count; /* total number of SelfIDs received */
+
+ nodeid_t node_id; /* node ID of this host */
+ nodeid_t irm_id; /* ID of this bus' isochronous resource manager */
+ nodeid_t busmgr_id; /* ID of this bus' bus manager */
+
+ unsigned initialized:1; /* initialized and usable */
+ unsigned in_bus_reset:1; /* in bus reset / SelfID stage */
+ unsigned attempt_root:1; /* attempt to become root during next reset */
+
+ /* this nodes' duties on the bus */
+ unsigned is_root:1;
+ unsigned is_cycmst:1;
+ unsigned is_irm:1;
+ unsigned is_busmgr:1;
+
+/* fields readable and writeable by the hosts */
+
+ void *hostdata;
+ int embedded_hostdata[0];
+};
+
+
+
+enum devctl_cmd {
+ /* Host is requested to reset its bus and cancel all outstanding async
+ * requests. If arg == 1, it shall also attempt to become root on the
+ * bus. Return void. */
+ RESET_BUS,
+
+ /* Arg is void, return value is the hardware cycle counter value. */
+ GET_CYCLE_COUNTER,
+
+ /* Set the hardware cycle counter to the value in arg, return void.
+ * FIXME - setting is probably not required. */
+ SET_CYCLE_COUNTER,
+
+ /* Configure hardware for new bus ID in arg, return void. */
+ SET_BUS_ID,
+
+ /* If arg true, start sending cycle start packets, stop if arg == 0.
+ * Return void. */
+ ACT_CYCLE_MASTER,
+
+ /* Cancel all outstanding async requests without resetting the bus.
+ * Return void. */
+ CANCEL_REQUESTS,
+
+ /* Decrease module usage count if arg == 0, increase otherwise. Return
+ * void. */
+ MODIFY_USAGE,
+
+ /* Start or stop receiving isochronous channel in arg. Return void.
+ * This acts as an optimization hint, hosts are not required not to
+ * listen on unrequested channels. */
+ ISO_LISTEN_CHANNEL,
+ ISO_UNLISTEN_CHANNEL
+};
+
+struct hpsb_host_template {
+ struct hpsb_host_template *next;
+
+ struct hpsb_host *hosts;
+ int number_of_hosts;
+
+ /* fields above will be ignored and overwritten after registering */
+
+ /* This should be the name of the driver (single word) and must not be
+ * NULL. */
+ const char *name;
+
+ /* This function shall detect all available adapters of this type and
+ * call hpsb_get_host for each one. The initialize_host function will
+ * be called to actually set up these adapters. The number of detected
+ * adapters or zero if there are none must be returned.
+ */
+ int (*detect_hosts) (struct hpsb_host_template *template);
+
+ /* After detecting and registering hosts, this function will be called
+ * for every registered host. It shall set up the host to be fully
+ * functional for bus operations and return 0 for failure.
+ */
+ int (*initialize_host) (struct hpsb_host *host);
+
+ /* To unload modules, this function is provided. It shall free all
+ * resources this host is using (if host is not NULL) or free all
+ * resources globally allocated by the driver (if host is NULL).
+ */
+ void (*release_host) (struct hpsb_host *host);
+
+ /* This function must store a pointer to the configuration ROM into the
+ * location referenced to by pointer and return the size of the ROM. It
+ * may not fail. If any allocation is required, it must be done
+ * earlier.
+ */
+ size_t (*get_rom) (struct hpsb_host *host, const quadlet_t **pointer);
+
+ /* This function shall implement packet transmission based on
+ * packet->type. It shall CRC both parts of the packet (unless
+ * packet->type == raw) and do byte-swapping as necessary or instruct
+ * the hardware to do so. It can return immediately after the packet
+ * was queued for sending. After sending, hpsb_sent_packet() has to be
+ * called. Return 0 for failure.
+ * NOTE: The function must be callable in interrupt context.
+ */
+ int (*transmit_packet) (struct hpsb_host *host,
+ struct hpsb_packet *packet);
+
+ /* This function requests miscellanous services from the driver, see
+ * above for command codes and expected actions. Return -1 for unknown
+ * command, though that should never happen.
+ */
+ int (*devctl) (struct hpsb_host *host, enum devctl_cmd command, int arg);
+};
+
+
+
+/* mid level internal use */
+void register_builtin_lowlevels(void);
+
+/* high level internal use */
+struct hpsb_highlevel;
+void hl_all_hosts(struct hpsb_highlevel *hl, int init);
+
+/*
+ * These functions are for lowlevel (host) driver use.
+ */
+int hpsb_register_lowlevel(struct hpsb_host_template *tmpl);
+void hpsb_unregister_lowlevel(struct hpsb_host_template *tmpl);
+
+/*
+ * Get a initialized host structure with hostdata_size bytes allocated in
+ * embedded_hostdata for free usage. Returns NULL for failure.
+ */
+struct hpsb_host *hpsb_get_host(struct hpsb_host_template *tmpl,
+ size_t hostdata_size);
+
+/*
+ * Write pointers to all available hpsb_hosts into list.
+ * Return number of host adapters (i.e. elements in list).
+ *
+ * DEPRECATED - register with highlevel instead.
+ */
+int hpsb_get_host_list(struct hpsb_host *list[], int max_list_size);
+
+/*
+ * Increase / decrease host usage counter. Increase function will return true
+ * only if successful (host still existed). Decrease function expects host to
+ * exist.
+ */
+int hpsb_inc_host_usage(struct hpsb_host *host);
+void hpsb_dec_host_usage(struct hpsb_host *host);
+
+#endif /* _IEEE1394_HOSTS_H */