4 * Copyright (C) 1999 Andreas E. Bombe
6 * This code is licensed under the GPL. See the file COPYING in the root
7 * directory of the kernel sources for details.
12 * Christian Toegel <christian.toegel@gmx.at>
13 * unregister address space
15 * Manfred Weihs <weihs@ict.tuwien.ac.at>
16 * unregister address space
20 #include <linux/slab.h>
21 #include <linux/list.h>
22 #include <linux/bitops.h>
25 #include "ieee1394_types.h"
27 #include "ieee1394_core.h"
28 #include "highlevel.h"
33 struct list_head list;
34 struct hpsb_host *host;
41 static LIST_HEAD(hl_drivers);
42 static DECLARE_RWSEM(hl_drivers_sem);
44 static LIST_HEAD(hl_irqs);
45 static DEFINE_RWLOCK(hl_irqs_lock);
47 static DEFINE_RWLOCK(addr_space_lock);
49 /* addr_space list will have zero and max already included as bounds */
50 static struct hpsb_address_ops dummy_ops = { NULL, NULL, NULL, NULL };
51 static struct hpsb_address_serve dummy_zero_addr, dummy_max_addr;
54 static struct hl_host_info *hl_get_hostinfo(struct hpsb_highlevel *hl,
55 struct hpsb_host *host)
57 struct hl_host_info *hi = NULL;
62 read_lock(&hl->host_info_lock);
63 list_for_each_entry(hi, &hl->host_info_list, list) {
64 if (hi->host == host) {
65 read_unlock(&hl->host_info_lock);
69 read_unlock(&hl->host_info_lock);
74 * hpsb_get_hostinfo - retrieve a hostinfo pointer bound to this driver/host
76 * Returns a per @host and @hl driver data structure that was previously stored
77 * by hpsb_create_hostinfo.
79 void *hpsb_get_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host)
81 struct hl_host_info *hi = hl_get_hostinfo(hl, host);
83 return hi ? hi->data : NULL;
87 * hpsb_create_hostinfo - allocate a hostinfo pointer bound to this driver/host
89 * Allocate a hostinfo pointer backed by memory with @data_size and bind it to
90 * to this @hl driver and @host. If @data_size is zero, then the return here is
91 * only valid for error checking.
93 void *hpsb_create_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host,
96 struct hl_host_info *hi;
100 hi = hl_get_hostinfo(hl, host);
102 HPSB_ERR("%s called hpsb_create_hostinfo when hostinfo already"
103 " exists", hl->name);
107 hi = kzalloc(sizeof(*hi) + data_size, GFP_ATOMIC);
112 data = hi->data = hi + 1;
113 hi->size = data_size;
119 write_lock_irqsave(&hl->host_info_lock, flags);
120 list_add_tail(&hi->list, &hl->host_info_list);
121 write_unlock_irqrestore(&hl->host_info_lock, flags);
127 * hpsb_set_hostinfo - set the hostinfo pointer to something useful
129 * Usually follows a call to hpsb_create_hostinfo, where the size is 0.
131 int hpsb_set_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host,
134 struct hl_host_info *hi;
136 hi = hl_get_hostinfo(hl, host);
138 if (!hi->size && !hi->data) {
142 HPSB_ERR("%s called hpsb_set_hostinfo when hostinfo "
143 "already has data", hl->name);
145 HPSB_ERR("%s called hpsb_set_hostinfo when no hostinfo exists",
151 * hpsb_destroy_hostinfo - free and remove a hostinfo pointer
153 * Free and remove the hostinfo pointer bound to this @hl driver and @host.
155 void hpsb_destroy_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host)
157 struct hl_host_info *hi;
159 hi = hl_get_hostinfo(hl, host);
162 write_lock_irqsave(&hl->host_info_lock, flags);
164 write_unlock_irqrestore(&hl->host_info_lock, flags);
171 * hpsb_set_hostinfo_key - set an alternate lookup key for an hostinfo
173 * Sets an alternate lookup key for the hostinfo bound to this @hl driver and
176 void hpsb_set_hostinfo_key(struct hpsb_highlevel *hl, struct hpsb_host *host,
179 struct hl_host_info *hi;
181 hi = hl_get_hostinfo(hl, host);
188 * hpsb_get_hostinfo_bykey - retrieve a hostinfo pointer by its alternate key
190 void *hpsb_get_hostinfo_bykey(struct hpsb_highlevel *hl, unsigned long key)
192 struct hl_host_info *hi;
198 read_lock(&hl->host_info_lock);
199 list_for_each_entry(hi, &hl->host_info_list, list) {
200 if (hi->key == key) {
205 read_unlock(&hl->host_info_lock);
209 static int highlevel_for_each_host_reg(struct hpsb_host *host, void *__data)
211 struct hpsb_highlevel *hl = __data;
215 if (host->update_config_rom && hpsb_update_config_rom_image(host) < 0)
216 HPSB_ERR("Failed to generate Configuration ROM image for host "
217 "%s-%d", hl->name, host->id);
222 * hpsb_register_highlevel - register highlevel driver
224 * The name pointer in @hl has to stay valid at all times because the string is
227 void hpsb_register_highlevel(struct hpsb_highlevel *hl)
231 INIT_LIST_HEAD(&hl->addr_list);
232 INIT_LIST_HEAD(&hl->host_info_list);
234 rwlock_init(&hl->host_info_lock);
236 down_write(&hl_drivers_sem);
237 list_add_tail(&hl->hl_list, &hl_drivers);
238 up_write(&hl_drivers_sem);
240 write_lock_irqsave(&hl_irqs_lock, flags);
241 list_add_tail(&hl->irq_list, &hl_irqs);
242 write_unlock_irqrestore(&hl_irqs_lock, flags);
245 nodemgr_for_each_host(hl, highlevel_for_each_host_reg);
249 static void __delete_addr(struct hpsb_address_serve *as)
251 list_del(&as->host_list);
252 list_del(&as->hl_list);
256 static void __unregister_host(struct hpsb_highlevel *hl, struct hpsb_host *host,
260 struct list_head *lh, *next;
261 struct hpsb_address_serve *as;
263 /* First, let the highlevel driver unreg */
265 hl->remove_host(host);
267 /* Remove any addresses that are matched for this highlevel driver
268 * and this particular host. */
269 write_lock_irqsave(&addr_space_lock, flags);
270 list_for_each_safe (lh, next, &hl->addr_list) {
271 as = list_entry(lh, struct hpsb_address_serve, hl_list);
272 if (as->host == host)
275 write_unlock_irqrestore(&addr_space_lock, flags);
277 /* Now update the config-rom to reflect anything removed by the
278 * highlevel driver. */
279 if (update_cr && host->update_config_rom &&
280 hpsb_update_config_rom_image(host) < 0)
281 HPSB_ERR("Failed to generate Configuration ROM image for host "
282 "%s-%d", hl->name, host->id);
284 /* Finally remove all the host info associated between these two. */
285 hpsb_destroy_hostinfo(hl, host);
288 static int highlevel_for_each_host_unreg(struct hpsb_host *host, void *__data)
290 struct hpsb_highlevel *hl = __data;
292 __unregister_host(hl, host, 1);
297 * hpsb_unregister_highlevel - unregister highlevel driver
299 void hpsb_unregister_highlevel(struct hpsb_highlevel *hl)
303 write_lock_irqsave(&hl_irqs_lock, flags);
304 list_del(&hl->irq_list);
305 write_unlock_irqrestore(&hl_irqs_lock, flags);
307 down_write(&hl_drivers_sem);
308 list_del(&hl->hl_list);
309 up_write(&hl_drivers_sem);
311 nodemgr_for_each_host(hl, highlevel_for_each_host_unreg);
315 * hpsb_allocate_and_register_addrspace - alloc' and reg' a host address space
317 * @start and @end are 48 bit pointers and have to be quadlet aligned.
318 * @end points to the first address behind the handled addresses. This
319 * function can be called multiple times for a single hpsb_highlevel @hl to
320 * implement sparse register sets. The requested region must not overlap any
321 * previously allocated region, otherwise registering will fail.
323 * It returns true for successful allocation. Address spaces can be
324 * unregistered with hpsb_unregister_addrspace. All remaining address spaces
325 * are automatically deallocated together with the hpsb_highlevel @hl.
327 u64 hpsb_allocate_and_register_addrspace(struct hpsb_highlevel *hl,
328 struct hpsb_host *host,
329 struct hpsb_address_ops *ops,
330 u64 size, u64 alignment,
333 struct hpsb_address_serve *as, *a1, *a2;
334 struct list_head *entry;
335 u64 retval = CSR1212_INVALID_ADDR_SPACE;
337 u64 align_mask = ~(alignment - 1);
339 if ((alignment & 3) || (alignment > 0x800000000000ULL) ||
340 (hweight64(alignment) != 1)) {
341 HPSB_ERR("%s called with invalid alignment: 0x%048llx",
342 __FUNCTION__, (unsigned long long)alignment);
347 * avoids controller's posted write area (see OHCI 1.1 clause 1.5) */
348 if (start == CSR1212_INVALID_ADDR_SPACE &&
349 end == CSR1212_INVALID_ADDR_SPACE) {
350 start = host->middle_addr_space;
351 end = CSR1212_ALL_SPACE_END;
354 if (((start|end) & ~align_mask) || (start >= end) ||
355 (end > CSR1212_ALL_SPACE_END)) {
356 HPSB_ERR("%s called with invalid addresses "
357 "(start = %012Lx end = %012Lx)", __FUNCTION__,
358 (unsigned long long)start,(unsigned long long)end);
362 as = kmalloc(sizeof(*as), GFP_KERNEL);
366 INIT_LIST_HEAD(&as->host_list);
367 INIT_LIST_HEAD(&as->hl_list);
371 write_lock_irqsave(&addr_space_lock, flags);
372 list_for_each(entry, &host->addr_space) {
376 a1 = list_entry(entry, struct hpsb_address_serve, host_list);
377 a2 = list_entry(entry->next, struct hpsb_address_serve,
380 a1sa = a1->start & align_mask;
381 a1ea = (a1->end + alignment -1) & align_mask;
382 a2sa = a2->start & align_mask;
383 a2ea = (a2->end + alignment -1) & align_mask;
385 if ((a2sa - a1ea >= size) && (a2sa - start >= size) &&
387 as->start = max(start, a1ea);
388 as->end = as->start + size;
389 list_add(&as->host_list, entry);
390 list_add_tail(&as->hl_list, &hl->addr_list);
395 write_unlock_irqrestore(&addr_space_lock, flags);
397 if (retval == CSR1212_INVALID_ADDR_SPACE)
403 * hpsb_register_addrspace - register a host address space
405 * @start and @end are 48 bit pointers and have to be quadlet aligned.
406 * @end points to the first address behind the handled addresses. This
407 * function can be called multiple times for a single hpsb_highlevel @hl to
408 * implement sparse register sets. The requested region must not overlap any
409 * previously allocated region, otherwise registering will fail.
411 * It returns true for successful allocation. Address spaces can be
412 * unregistered with hpsb_unregister_addrspace. All remaining address spaces
413 * are automatically deallocated together with the hpsb_highlevel @hl.
415 int hpsb_register_addrspace(struct hpsb_highlevel *hl, struct hpsb_host *host,
416 struct hpsb_address_ops *ops, u64 start, u64 end)
418 struct hpsb_address_serve *as;
419 struct list_head *lh;
423 if (((start|end) & 3) || (start >= end) ||
424 (end > CSR1212_ALL_SPACE_END)) {
425 HPSB_ERR("%s called with invalid addresses", __FUNCTION__);
429 as = kmalloc(sizeof(*as), GFP_ATOMIC);
433 INIT_LIST_HEAD(&as->host_list);
434 INIT_LIST_HEAD(&as->hl_list);
440 write_lock_irqsave(&addr_space_lock, flags);
441 list_for_each(lh, &host->addr_space) {
442 struct hpsb_address_serve *as_this =
443 list_entry(lh, struct hpsb_address_serve, host_list);
444 struct hpsb_address_serve *as_next =
445 list_entry(lh->next, struct hpsb_address_serve,
448 if (as_this->end > as->start)
451 if (as_next->start >= as->end) {
452 list_add(&as->host_list, lh);
453 list_add_tail(&as->hl_list, &hl->addr_list);
458 write_unlock_irqrestore(&addr_space_lock, flags);
465 int hpsb_unregister_addrspace(struct hpsb_highlevel *hl, struct hpsb_host *host,
469 struct hpsb_address_serve *as;
470 struct list_head *lh, *next;
473 write_lock_irqsave(&addr_space_lock, flags);
474 list_for_each_safe (lh, next, &hl->addr_list) {
475 as = list_entry(lh, struct hpsb_address_serve, hl_list);
476 if (as->start == start && as->host == host) {
482 write_unlock_irqrestore(&addr_space_lock, flags);
487 * hpsb_listen_channel - enable receving a certain isochronous channel
489 * Reception is handled through the @hl's iso_receive op.
491 int hpsb_listen_channel(struct hpsb_highlevel *hl, struct hpsb_host *host,
492 unsigned int channel)
495 HPSB_ERR("%s called with invalid channel", __FUNCTION__);
498 if (host->iso_listen_count[channel]++ == 0)
499 return host->driver->devctl(host, ISO_LISTEN_CHANNEL, channel);
504 * hpsb_unlisten_channel - disable receving a certain isochronous channel
506 void hpsb_unlisten_channel(struct hpsb_highlevel *hl, struct hpsb_host *host,
507 unsigned int channel)
510 HPSB_ERR("%s called with invalid channel", __FUNCTION__);
513 if (--host->iso_listen_count[channel] == 0)
514 host->driver->devctl(host, ISO_UNLISTEN_CHANNEL, channel);
517 static void init_hpsb_highlevel(struct hpsb_host *host)
519 INIT_LIST_HEAD(&dummy_zero_addr.host_list);
520 INIT_LIST_HEAD(&dummy_zero_addr.hl_list);
521 INIT_LIST_HEAD(&dummy_max_addr.host_list);
522 INIT_LIST_HEAD(&dummy_max_addr.hl_list);
524 dummy_zero_addr.op = dummy_max_addr.op = &dummy_ops;
526 dummy_zero_addr.start = dummy_zero_addr.end = 0;
527 dummy_max_addr.start = dummy_max_addr.end = ((u64) 1) << 48;
529 list_add_tail(&dummy_zero_addr.host_list, &host->addr_space);
530 list_add_tail(&dummy_max_addr.host_list, &host->addr_space);
533 void highlevel_add_host(struct hpsb_host *host)
535 struct hpsb_highlevel *hl;
537 init_hpsb_highlevel(host);
539 down_read(&hl_drivers_sem);
540 list_for_each_entry(hl, &hl_drivers, hl_list) {
544 up_read(&hl_drivers_sem);
545 if (host->update_config_rom && hpsb_update_config_rom_image(host) < 0)
546 HPSB_ERR("Failed to generate Configuration ROM image for host "
547 "%s-%d", hl->name, host->id);
550 void highlevel_remove_host(struct hpsb_host *host)
552 struct hpsb_highlevel *hl;
554 down_read(&hl_drivers_sem);
555 list_for_each_entry(hl, &hl_drivers, hl_list)
556 __unregister_host(hl, host, 0);
557 up_read(&hl_drivers_sem);
560 void highlevel_host_reset(struct hpsb_host *host)
563 struct hpsb_highlevel *hl;
565 read_lock_irqsave(&hl_irqs_lock, flags);
566 list_for_each_entry(hl, &hl_irqs, irq_list) {
568 hl->host_reset(host);
570 read_unlock_irqrestore(&hl_irqs_lock, flags);
573 void highlevel_iso_receive(struct hpsb_host *host, void *data, size_t length)
576 struct hpsb_highlevel *hl;
577 int channel = (((quadlet_t *)data)[0] >> 8) & 0x3f;
579 read_lock_irqsave(&hl_irqs_lock, flags);
580 list_for_each_entry(hl, &hl_irqs, irq_list) {
582 hl->iso_receive(host, channel, data, length);
584 read_unlock_irqrestore(&hl_irqs_lock, flags);
587 void highlevel_fcp_request(struct hpsb_host *host, int nodeid, int direction,
588 void *data, size_t length)
591 struct hpsb_highlevel *hl;
592 int cts = ((quadlet_t *)data)[0] >> 4;
594 read_lock_irqsave(&hl_irqs_lock, flags);
595 list_for_each_entry(hl, &hl_irqs, irq_list) {
597 hl->fcp_request(host, nodeid, direction, cts, data,
600 read_unlock_irqrestore(&hl_irqs_lock, flags);
604 * highlevel_read, highlevel_write, highlevel_lock, highlevel_lock64:
606 * These functions are called to handle transactions. They are called when a
607 * packet arrives. The flags argument contains the second word of the first
608 * header quadlet of the incoming packet (containing transaction label, retry
609 * code, transaction code and priority). These functions either return a
610 * response code or a negative number. In the first case a response will be
611 * generated. In the latter case, no response will be sent and the driver which
612 * handled the request will send the response itself.
614 int highlevel_read(struct hpsb_host *host, int nodeid, void *data, u64 addr,
615 unsigned int length, u16 flags)
617 struct hpsb_address_serve *as;
618 unsigned int partlength;
619 int rcode = RCODE_ADDRESS_ERROR;
621 read_lock(&addr_space_lock);
622 list_for_each_entry(as, &host->addr_space, host_list) {
623 if (as->start > addr)
626 if (as->end > addr) {
627 partlength = min(as->end - addr, (u64) length);
630 rcode = as->op->read(host, nodeid, data,
631 addr, partlength, flags);
633 rcode = RCODE_TYPE_ERROR;
636 length -= partlength;
639 if ((rcode != RCODE_COMPLETE) || !length)
643 read_unlock(&addr_space_lock);
645 if (length && (rcode == RCODE_COMPLETE))
646 rcode = RCODE_ADDRESS_ERROR;
650 int highlevel_write(struct hpsb_host *host, int nodeid, int destid, void *data,
651 u64 addr, unsigned int length, u16 flags)
653 struct hpsb_address_serve *as;
654 unsigned int partlength;
655 int rcode = RCODE_ADDRESS_ERROR;
657 read_lock(&addr_space_lock);
658 list_for_each_entry(as, &host->addr_space, host_list) {
659 if (as->start > addr)
662 if (as->end > addr) {
663 partlength = min(as->end - addr, (u64) length);
666 rcode = as->op->write(host, nodeid, destid,
667 data, addr, partlength,
670 rcode = RCODE_TYPE_ERROR;
673 length -= partlength;
676 if ((rcode != RCODE_COMPLETE) || !length)
680 read_unlock(&addr_space_lock);
682 if (length && (rcode == RCODE_COMPLETE))
683 rcode = RCODE_ADDRESS_ERROR;
687 int highlevel_lock(struct hpsb_host *host, int nodeid, quadlet_t *store,
688 u64 addr, quadlet_t data, quadlet_t arg, int ext_tcode,
691 struct hpsb_address_serve *as;
692 int rcode = RCODE_ADDRESS_ERROR;
694 read_lock(&addr_space_lock);
695 list_for_each_entry(as, &host->addr_space, host_list) {
696 if (as->start > addr)
699 if (as->end > addr) {
701 rcode = as->op->lock(host, nodeid, store, addr,
702 data, arg, ext_tcode,
705 rcode = RCODE_TYPE_ERROR;
709 read_unlock(&addr_space_lock);
713 int highlevel_lock64(struct hpsb_host *host, int nodeid, octlet_t *store,
714 u64 addr, octlet_t data, octlet_t arg, int ext_tcode,
717 struct hpsb_address_serve *as;
718 int rcode = RCODE_ADDRESS_ERROR;
720 read_lock(&addr_space_lock);
722 list_for_each_entry(as, &host->addr_space, host_list) {
723 if (as->start > addr)
726 if (as->end > addr) {
728 rcode = as->op->lock64(host, nodeid, store,
732 rcode = RCODE_TYPE_ERROR;
736 read_unlock(&addr_space_lock);