blob: 9dba89fc60ada2e1489a60cc950f39a2f170f5b0 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef IEEE1394_HIGHLEVEL_H
2#define IEEE1394_HIGHLEVEL_H
3
Stefan Richterde4394f2006-07-03 12:02:29 -04004#include <linux/list.h>
Stefan Richter055a7da2008-05-19 22:07:28 +02005#include <linux/spinlock.h>
Stefan Richterde4394f2006-07-03 12:02:29 -04006#include <linux/types.h>
7
8struct module;
9
10#include "ieee1394_types.h"
11
12struct hpsb_host;
13
Stefan Richtere1d118f2006-07-03 12:02:28 -040014/* internal to ieee1394 core */
Linus Torvalds1da177e2005-04-16 15:20:36 -070015struct hpsb_address_serve {
Stefan Richtere1d118f2006-07-03 12:02:28 -040016 struct list_head host_list; /* per host list */
17 struct list_head hl_list; /* hpsb_highlevel list */
Stefan Richterb17a5502008-11-26 01:35:21 +010018 const struct hpsb_address_ops *op;
Linus Torvalds1da177e2005-04-16 15:20:36 -070019 struct hpsb_host *host;
Stefan Richtere1d118f2006-07-03 12:02:28 -040020 u64 start; /* first address handled, quadlet aligned */
21 u64 end; /* first address behind, quadlet aligned */
Linus Torvalds1da177e2005-04-16 15:20:36 -070022};
23
Stefan Richtere1d118f2006-07-03 12:02:28 -040024/* Only the following structures are of interest to actual highlevel drivers. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26struct hpsb_highlevel {
Linus Torvalds1da177e2005-04-16 15:20:36 -070027 const char *name;
28
Stefan Richter53c96b42007-06-24 15:31:54 +020029 /* Any of the following pointers can legally be NULL. */
Linus Torvalds1da177e2005-04-16 15:20:36 -070030
Stefan Richtere1d118f2006-07-03 12:02:28 -040031 /* New host initialized. Will also be called during
32 * hpsb_register_highlevel for all hosts already installed. */
33 void (*add_host)(struct hpsb_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -070034
Stefan Richtere1d118f2006-07-03 12:02:28 -040035 /* Host about to be removed. Will also be called during
36 * hpsb_unregister_highlevel once for each host. */
37 void (*remove_host)(struct hpsb_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
Stefan Richtere1d118f2006-07-03 12:02:28 -040039 /* Host experienced bus reset with possible configuration changes.
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 * Note that this one may occur during interrupt/bottom half handling.
41 * You can not expect to be able to do stock hpsb_reads. */
Stefan Richtere1d118f2006-07-03 12:02:28 -040042 void (*host_reset)(struct hpsb_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -070043
Stefan Richtere1d118f2006-07-03 12:02:28 -040044 /* A write request was received on either the FCP_COMMAND (direction =
45 * 0) or the FCP_RESPONSE (direction = 1) register. The cts arg
46 * contains the cts field (first byte of data). */
47 void (*fcp_request)(struct hpsb_host *host, int nodeid, int direction,
48 int cts, u8 *data, size_t length);
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
50 /* These are initialized by the subsystem when the
51 * hpsb_higlevel is registered. */
52 struct list_head hl_list;
53 struct list_head irq_list;
54 struct list_head addr_list;
55
56 struct list_head host_info_list;
57 rwlock_t host_info_lock;
58};
59
60struct hpsb_address_ops {
Stefan Richtere1d118f2006-07-03 12:02:28 -040061 /*
62 * Null function pointers will make the respective operation complete
63 * with RCODE_TYPE_ERROR. Makes for easy to implement read-only
64 * registers (just leave everything but read NULL).
65 *
66 * All functions shall return appropriate IEEE 1394 rcodes.
67 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070068
Stefan Richtere1d118f2006-07-03 12:02:28 -040069 /* These functions have to implement block reads for themselves.
70 *
71 * These functions either return a response code or a negative number.
72 * In the first case a response will be generated. In the latter case,
73 * no response will be sent and the driver which handled the request
74 * will send the response itself. */
75 int (*read)(struct hpsb_host *host, int nodeid, quadlet_t *buffer,
76 u64 addr, size_t length, u16 flags);
77 int (*write)(struct hpsb_host *host, int nodeid, int destid,
78 quadlet_t *data, u64 addr, size_t length, u16 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
Stefan Richtere1d118f2006-07-03 12:02:28 -040080 /* Lock transactions: write results of ext_tcode operation into
81 * *store. */
82 int (*lock)(struct hpsb_host *host, int nodeid, quadlet_t *store,
83 u64 addr, quadlet_t data, quadlet_t arg, int ext_tcode,
84 u16 flags);
85 int (*lock64)(struct hpsb_host *host, int nodeid, octlet_t *store,
86 u64 addr, octlet_t data, octlet_t arg, int ext_tcode,
87 u16 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088};
89
Linus Torvalds1da177e2005-04-16 15:20:36 -070090void highlevel_add_host(struct hpsb_host *host);
91void highlevel_remove_host(struct hpsb_host *host);
92void highlevel_host_reset(struct hpsb_host *host);
Stefan Richtere1d118f2006-07-03 12:02:28 -040093int highlevel_read(struct hpsb_host *host, int nodeid, void *data, u64 addr,
94 unsigned int length, u16 flags);
95int highlevel_write(struct hpsb_host *host, int nodeid, int destid, void *data,
96 u64 addr, unsigned int length, u16 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097int highlevel_lock(struct hpsb_host *host, int nodeid, quadlet_t *store,
Stefan Richtere1d118f2006-07-03 12:02:28 -040098 u64 addr, quadlet_t data, quadlet_t arg, int ext_tcode,
99 u16 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100int highlevel_lock64(struct hpsb_host *host, int nodeid, octlet_t *store,
Stefan Richtere1d118f2006-07-03 12:02:28 -0400101 u64 addr, octlet_t data, octlet_t arg, int ext_tcode,
102 u16 flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700103void highlevel_fcp_request(struct hpsb_host *host, int nodeid, int direction,
Stefan Richtere1d118f2006-07-03 12:02:28 -0400104 void *data, size_t length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
Stefan Richter055a7da2008-05-19 22:07:28 +0200106/**
107 * hpsb_init_highlevel - initialize a struct hpsb_highlevel
108 *
109 * This is only necessary if hpsb_get_hostinfo_bykey can be called
110 * before hpsb_register_highlevel.
111 */
112static inline void hpsb_init_highlevel(struct hpsb_highlevel *hl)
113{
114 rwlock_init(&hl->host_info_lock);
115 INIT_LIST_HEAD(&hl->host_info_list);
116}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117void hpsb_register_highlevel(struct hpsb_highlevel *hl);
118void hpsb_unregister_highlevel(struct hpsb_highlevel *hl);
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120u64 hpsb_allocate_and_register_addrspace(struct hpsb_highlevel *hl,
121 struct hpsb_host *host,
Stefan Richterb17a5502008-11-26 01:35:21 +0100122 const struct hpsb_address_ops *ops,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700123 u64 size, u64 alignment,
124 u64 start, u64 end);
125int hpsb_register_addrspace(struct hpsb_highlevel *hl, struct hpsb_host *host,
Stefan Richterb17a5502008-11-26 01:35:21 +0100126 const struct hpsb_address_ops *ops,
127 u64 start, u64 end);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128int hpsb_unregister_addrspace(struct hpsb_highlevel *hl, struct hpsb_host *host,
Stefan Richtere1d118f2006-07-03 12:02:28 -0400129 u64 start);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130
Linus Torvalds1da177e2005-04-16 15:20:36 -0700131void *hpsb_get_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132void *hpsb_create_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host,
133 size_t data_size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700134void hpsb_destroy_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host);
Stefan Richtere1d118f2006-07-03 12:02:28 -0400135void hpsb_set_hostinfo_key(struct hpsb_highlevel *hl, struct hpsb_host *host,
136 unsigned long key);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137void *hpsb_get_hostinfo_bykey(struct hpsb_highlevel *hl, unsigned long key);
Stefan Richtere1d118f2006-07-03 12:02:28 -0400138int hpsb_set_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host,
139 void *data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700140
Linus Torvalds1da177e2005-04-16 15:20:36 -0700141#endif /* IEEE1394_HIGHLEVEL_H */