drivers/ieee1394/highlevel.h

   1
   2 #ifndef IEEE1394_HIGHLEVEL_H
   3 #define IEEE1394_HIGHLEVEL_H
   4
   5
   6 struct hpsb_address_serve {
   7         struct list_head as_list; /* global list */
   8
   9         struct list_head addr_list; /* hpsb_highlevel list */
  10
  11         struct hpsb_address_ops *op;
  12
  13         /* first address handled and first address behind, quadlet aligned */
  14         u64 start, end;
  15 };
  16
  17
  18 /*
  19  * The above structs are internal to highlevel driver handling.  Only the
  20  * following structures are of interest to actual highlevel drivers.
  21  */
  22
  23 struct hpsb_highlevel {
  24         struct module *owner;
  25         const char *name;
  26
  27         /* Any of the following pointers can legally be NULL, except for
  28          * iso_receive which can only be NULL when you don't request
  29          * channels. */
  30
  31         /* 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);
  34
  35         /* 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);
  38
  39         /* Host experienced bus reset with possible configuration changes.  Note
  40          * that this one may occur during interrupt/bottom half handling.  You
  41          * can not expect to be able to do stock hpsb_reads. */
  42         void (*host_reset) (struct hpsb_host *host);
  43
  44         /* An isochronous packet was received.  Channel contains the channel
  45          * number for your convenience, it is also contained in the included
  46          * packet header (first quadlet, CRCs are missing).  You may get called
  47          * for channel/host combinations you did not request. */
  48         void (*iso_receive) (struct hpsb_host *host, int channel,
  49                              quadlet_t *data, size_t length);
  50
  51         /* A write request was received on either the FCP_COMMAND (direction =
  52          * 0) or the FCP_RESPONSE (direction = 1) register.  The cts arg
  53          * contains the cts field (first byte of data).
  54          */
  55         void (*fcp_request) (struct hpsb_host *host, int nodeid, int direction,
  56                              int cts, u8 *data, size_t length);
  57
  58
  59         struct list_head hl_list;
  60         struct list_head addr_list;
  61
  62         struct list_head host_info_list;
  63         rwlock_t host_info_lock;
  64 };
  65
  66 struct hpsb_address_ops {
  67         /*
  68          * Null function pointers will make the respective operation complete
  69          * with RCODE_TYPE_ERROR.  Makes for easy to implement read-only
  70          * registers (just leave everything but read NULL).
  71          *
  72          * All functions shall return appropriate IEEE 1394 rcodes.
  73          */
  74
  75         /* These functions have to implement block reads for themselves. */
  76         /* These functions either return a response code
  77            or a negative number. In the first case a response will be generated; in the
  78            later case, no response will be sent and the driver, that handled the request
  79            will send the response itself
  80         */
  81         int (*read) (struct hpsb_host *host, int nodeid, quadlet_t *buffer,
  82                      u64 addr, size_t length, u16 flags);
  83         int (*write) (struct hpsb_host *host, int nodeid, int destid,
  84                       quadlet_t *data, u64 addr, size_t length, u16 flags);
  85
  86         /* Lock transactions: write results of ext_tcode operation into
  87          * *store. */
  88         int (*lock) (struct hpsb_host *host, int nodeid, quadlet_t *store,
  89                      u64 addr, quadlet_t data, quadlet_t arg, int ext_tcode, u16 flags);
  90         int (*lock64) (struct hpsb_host *host, int nodeid, octlet_t *store,
  91                        u64 addr, octlet_t data, octlet_t arg, int ext_tcode, u16 flags);
  92 };
  93
  94
  95 void init_hpsb_highlevel(void);
  96
  97 void highlevel_add_host(struct hpsb_host *host);
  98 void highlevel_remove_host(struct hpsb_host *host);
  99 void highlevel_host_reset(struct hpsb_host *host);
 100
 101
 102 /* these functions are called to handle transactions. They are called, when
 103    a packet arrives. The flags argument contains the second word of the first header
 104    quadlet of the incoming packet (containing transaction label, retry code,
 105    transaction code and priority). These functions either return a response code
 106    or a negative number. In the first case a response will be generated; in the
 107    later case, no response will be sent and the driver, that handled the request
 108    will send the response itself.
 109 */
 110 int highlevel_read(struct hpsb_host *host, int nodeid, void *data,
 111                    u64 addr, unsigned int length, u16 flags);
 112 int highlevel_write(struct hpsb_host *host, int nodeid, int destid,
 113                     void *data, u64 addr, unsigned int length, u16 flags);
 114 int highlevel_lock(struct hpsb_host *host, int nodeid, quadlet_t *store,
 115                    u64 addr, quadlet_t data, quadlet_t arg, int ext_tcode, u16 flags);
 116 int highlevel_lock64(struct hpsb_host *host, int nodeid, octlet_t *store,
 117                      u64 addr, octlet_t data, octlet_t arg, int ext_tcode, u16 flags);
 118
 119 void highlevel_iso_receive(struct hpsb_host *host, void *data,
 120                            size_t length);
 121 void highlevel_fcp_request(struct hpsb_host *host, int nodeid, int direction,
 122                            void *data, size_t length);
 123
 124
 125 /*
 126  * Register highlevel driver.  The name pointer has to stay valid at all times
 127  * because the string is not copied.
 128  */
 129 void hpsb_register_highlevel(struct hpsb_highlevel *hl);
 130 void hpsb_unregister_highlevel(struct hpsb_highlevel *hl);
 131
 132 /*
 133  * Register handlers for host address spaces.  Start and end are 48 bit pointers
 134  * and have to be quadlet aligned (end points to the first address behind the
 135  * handled addresses.  This function can be called multiple times for a single
 136  * hpsb_highlevel to implement sparse register sets.  The requested region must
 137  * not overlap any previously allocated region, otherwise registering will fail.
 138  *
 139  * It returns true for successful allocation.  There is no unregister function,
 140  * all address spaces are deallocated together with the hpsb_highlevel.
 141  */
 142 int hpsb_register_addrspace(struct hpsb_highlevel *hl,
 143                             struct hpsb_address_ops *ops, u64 start, u64 end);
 144
 145 int hpsb_unregister_addrspace(struct hpsb_highlevel *hl, u64 start);
 146
 147 /*
 148  * Enable or disable receving a certain isochronous channel through the
 149  * iso_receive op.
 150  */
 151 int hpsb_listen_channel(struct hpsb_highlevel *hl, struct hpsb_host *host,
 152                          unsigned int channel);
 153 void hpsb_unlisten_channel(struct hpsb_highlevel *hl, struct hpsb_host *host,
 154                            unsigned int channel);
 155
 156
 157 /* Retrieve a hostinfo pointer bound to this driver/host */
 158 void *hpsb_get_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host);
 159
 160 /* Allocate a hostinfo pointer of data_size bound to this driver/host */
 161 void *hpsb_create_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host,
 162                            size_t data_size);
 163
 164 /* Free and remove the hostinfo pointer bound to this driver/host */
 165 void hpsb_destroy_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host);
 166
 167 /* Set an alternate lookup key for the hostinfo bound to this driver/host */
 168 void hpsb_set_hostinfo_key(struct hpsb_highlevel *hl, struct hpsb_host *host, unsigned long key);
 169
 170 /* Retrieve the alternate lookup key for the hostinfo bound to this driver/host */
 171 unsigned long hpsb_get_hostinfo_key(struct hpsb_highlevel *hl, struct hpsb_host *host);
 172
 173 /* Retrieve a hostinfo pointer bound to this driver using its alternate key */
 174 void *hpsb_get_hostinfo_bykey(struct hpsb_highlevel *hl, unsigned long key);
 175
 176 /* Set the hostinfo pointer to something useful. Usually follows a call to
 177  * hpsb_create_hostinfo, where the size is 0. */
 178 int hpsb_set_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host, void *data);
 179
 180 /* Retrieve hpsb_host using a highlevel handle and a key */
 181 struct hpsb_host *hpsb_get_host_bykey(struct hpsb_highlevel *hl, unsigned long key);
 182
 183 #endif /* IEEE1394_HIGHLEVEL_H */