drivers/ieee1394/highlevel.c

   1 /*
   2  * IEEE 1394 for Linux
   3  *
   4  * Copyright (C) 1999 Andreas E. Bombe
   5  *
   6  * This code is licensed under the GPL.  See the file COPYING in the root
   7  * directory of the kernel sources for details.
   8  *
   9  *
  10  * Contributions:
  11  *
  12  * Christian Toegel <christian.toegel@gmx.at>
  13  *        unregister address space
  14  *
  15  * Manfred Weihs <weihs@ict.tuwien.ac.at>
  16  *        unregister address space
  17  *
  18  */
  19
  20 #include <linux/config.h>
  21 #include <linux/slab.h>
  22 #include <linux/list.h>
  23 #include <linux/bitops.h>
  24
  25 #include "ieee1394.h"
  26 #include "ieee1394_types.h"
  27 #include "hosts.h"
  28 #include "ieee1394_core.h"
  29 #include "highlevel.h"
  30 #include "nodemgr.h"
  31
  32
  33 struct hl_host_info {
  34         struct list_head list;
  35         struct hpsb_host *host;
  36         size_t size;
  37         unsigned long key;
  38         void *data;
  39 };
  40
  41
  42 static LIST_HEAD(hl_drivers);
  43 static DECLARE_RWSEM(hl_drivers_sem);
  44
  45 static LIST_HEAD(hl_irqs);
  46 static DEFINE_RWLOCK(hl_irqs_lock);
  47
  48 static DEFINE_RWLOCK(addr_space_lock);
  49
  50 /* addr_space list will have zero and max already included as bounds */
  51 static struct hpsb_address_ops dummy_ops = { NULL, NULL, NULL, NULL };
  52 static struct hpsb_address_serve dummy_zero_addr, dummy_max_addr;
  53
  54
  55 static struct hl_host_info *hl_get_hostinfo(struct hpsb_highlevel *hl,
  56                                               struct hpsb_host *host)
  57 {
  58         struct hl_host_info *hi = NULL;
  59
  60         if (!hl || !host)
  61                 return NULL;
  62
  63         read_lock(&hl->host_info_lock);
  64         list_for_each_entry(hi, &hl->host_info_list, list) {
  65                 if (hi->host == host) {
  66                         read_unlock(&hl->host_info_lock);
  67                         return hi;
  68                 }
  69         }
  70         read_unlock(&hl->host_info_lock);
  71
  72         return NULL;
  73 }
  74
  75
  76 /* Returns a per host/driver data structure that was previously stored by
  77  * hpsb_create_hostinfo. */
  78 void *hpsb_get_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host)
  79 {
  80         struct hl_host_info *hi = hl_get_hostinfo(hl, host);
  81
  82         if (hi)
  83                 return hi->data;
  84
  85         return NULL;
  86 }
  87
  88
  89 /* If size is zero, then the return here is only valid for error checking */
  90 void *hpsb_create_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host,
  91                            size_t data_size)
  92 {
  93         struct hl_host_info *hi;
  94         void *data;
  95         unsigned long flags;
  96
  97         hi = hl_get_hostinfo(hl, host);
  98         if (hi) {
  99                 HPSB_ERR("%s called hpsb_create_hostinfo when hostinfo already exists",
 100                          hl->name);
 101                 return NULL;
 102         }
 103
 104         hi = kzalloc(sizeof(*hi) + data_size, GFP_ATOMIC);
 105         if (!hi)
 106                 return NULL;
 107
 108         if (data_size) {
 109                 data = hi->data = hi + 1;
 110                 hi->size = data_size;
 111         } else
 112                 data = hi;
 113
 114         hi->host = host;
 115
 116         write_lock_irqsave(&hl->host_info_lock, flags);
 117         list_add_tail(&hi->list, &hl->host_info_list);
 118         write_unlock_irqrestore(&hl->host_info_lock, flags);
 119
 120         return data;
 121 }
 122
 123
 124 int hpsb_set_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host,
 125                       void *data)
 126 {
 127         struct hl_host_info *hi;
 128
 129         hi = hl_get_hostinfo(hl, host);
 130         if (hi) {
 131                 if (!hi->size && !hi->data) {
 132                         hi->data = data;
 133                         return 0;
 134                 } else
 135                         HPSB_ERR("%s called hpsb_set_hostinfo when hostinfo already has data",
 136                                  hl->name);
 137         } else
 138                 HPSB_ERR("%s called hpsb_set_hostinfo when no hostinfo exists",
 139                          hl->name);
 140
 141         return -EINVAL;
 142 }
 143
 144
 145 void hpsb_destroy_hostinfo(struct hpsb_highlevel *hl, struct hpsb_host *host)
 146 {
 147         struct hl_host_info *hi;
 148
 149         hi = hl_get_hostinfo(hl, host);
 150         if (hi) {
 151                 unsigned long flags;
 152                 write_lock_irqsave(&hl->host_info_lock, flags);
 153                 list_del(&hi->list);
 154                 write_unlock_irqrestore(&hl->host_info_lock, flags);
 155                 kfree(hi);
 156         }
 157
 158         return;
 159 }
 160
 161
 162 void hpsb_set_hostinfo_key(struct hpsb_highlevel *hl, struct hpsb_host *host, unsigned long key)
 163 {
 164         struct hl_host_info *hi;
 165
 166         hi = hl_get_hostinfo(hl, host);
 167         if (hi)
 168                 hi->key = key;
 169
 170         return;
 171 }
 172
 173
 174 void *hpsb_get_hostinfo_bykey(struct hpsb_highlevel *hl, unsigned long key)
 175 {
 176         struct hl_host_info *hi;
 177         void *data = NULL;
 178
 179         if (!hl)
 180                 return NULL;
 181
 182         read_lock(&hl->host_info_lock);
 183         list_for_each_entry(hi, &hl->host_info_list, list) {
 184                 if (hi->key == key) {
 185                         data = hi->data;
 186                         break;
 187                 }
 188         }
 189         read_unlock(&hl->host_info_lock);
 190
 191         return data;
 192 }
 193
 194
 195 static int highlevel_for_each_host_reg(struct hpsb_host *host, void *__data)
 196 {
 197         struct hpsb_highlevel *hl = __data;
 198
 199         hl->add_host(host);
 200
 201         if (host->update_config_rom) {
 202                 if (hpsb_update_config_rom_image(host) < 0) {
 203                         HPSB_ERR("Failed to generate Configuration ROM image for host "
 204                                  "%s-%d", hl->name, host->id);
 205                 }
 206         }
 207
 208         return 0;
 209 }
 210
 211 void hpsb_register_highlevel(struct hpsb_highlevel *hl)
 212 {
 213         INIT_LIST_HEAD(&hl->addr_list);
 214         INIT_LIST_HEAD(&hl->host_info_list);
 215
 216         rwlock_init(&hl->host_info_lock);
 217
 218         down_write(&hl_drivers_sem);
 219         list_add_tail(&hl->hl_list, &hl_drivers);
 220         up_write(&hl_drivers_sem);
 221
 222         write_lock(&hl_irqs_lock);
 223         list_add_tail(&hl->irq_list, &hl_irqs);
 224         write_unlock(&hl_irqs_lock);
 225
 226         if (hl->add_host)
 227                 nodemgr_for_each_host(hl, highlevel_for_each_host_reg);
 228
 229         return;
 230 }
 231
 232 static void __delete_addr(struct hpsb_address_serve *as)
 233 {
 234         list_del(&as->host_list);
 235         list_del(&as->hl_list);
 236         kfree(as);
 237 }
 238
 239 static void __unregister_host(struct hpsb_highlevel *hl, struct hpsb_host *host, int update_cr)
 240 {
 241         unsigned long flags;
 242         struct list_head *lh, *next;
 243         struct hpsb_address_serve *as;
 244
 245         /* First, let the highlevel driver unreg */
 246         if (hl->remove_host)
 247                 hl->remove_host(host);
 248
 249         /* Remove any addresses that are matched for this highlevel driver
 250          * and this particular host. */
 251         write_lock_irqsave(&addr_space_lock, flags);
 252         list_for_each_safe (lh, next, &hl->addr_list) {
 253                 as = list_entry(lh, struct hpsb_address_serve, hl_list);
 254
 255                 if (as->host == host)
 256                         __delete_addr(as);
 257         }
 258         write_unlock_irqrestore(&addr_space_lock, flags);
 259
 260         /* Now update the config-rom to reflect anything removed by the
 261          * highlevel driver. */
 262         if (update_cr && host->update_config_rom) {
 263                 if (hpsb_update_config_rom_image(host) < 0) {
 264                         HPSB_ERR("Failed to generate Configuration ROM image for host "
 265                                  "%s-%d", hl->name, host->id);
 266                 }
 267         }
 268
 269         /* And finally, remove all the host info associated between these
 270          * two. */
 271         hpsb_destroy_hostinfo(hl, host);
 272 }
 273
 274 static int highlevel_for_each_host_unreg(struct hpsb_host *host, void *__data)
 275 {
 276         struct hpsb_highlevel *hl = __data;
 277
 278         __unregister_host(hl, host, 1);
 279
 280         return 0;
 281 }
 282
 283 void hpsb_unregister_highlevel(struct hpsb_highlevel *hl)
 284 {
 285         write_lock(&hl_irqs_lock);
 286         list_del(&hl->irq_list);
 287         write_unlock(&hl_irqs_lock);
 288
 289         down_write(&hl_drivers_sem);
 290         list_del(&hl->hl_list);
 291         up_write(&hl_drivers_sem);
 292
 293         nodemgr_for_each_host(hl, highlevel_for_each_host_unreg);
 294 }
 295
 296 u64 hpsb_allocate_and_register_addrspace(struct hpsb_highlevel *hl,
 297                                          struct hpsb_host *host,
 298                                          struct hpsb_address_ops *ops,
 299                                          u64 size, u64 alignment,
 300                                          u64 start, u64 end)
 301 {
 302         struct hpsb_address_serve *as, *a1, *a2;
 303         struct list_head *entry;
 304         u64 retval = ~0ULL;
 305         unsigned long flags;
 306         u64 align_mask = ~(alignment - 1);
 307
 308         if ((alignment & 3) || (alignment > 0x800000000000ULL) ||
 309             (hweight64(alignment) != 1)) {
 310                 HPSB_ERR("%s called with invalid alignment: 0x%048llx",
 311                          __FUNCTION__, (unsigned long long)alignment);
 312                 return retval;
 313         }
 314
 315         /* default range,
 316          * avoids controller's posted write area (see OHCI 1.1 clause 1.5) */
 317         if (start == ~0ULL && end == ~0ULL) {
 318                 start = host->middle_addr_space;
 319                 end = CSR1212_ALL_SPACE_END;
 320         }
 321
 322         if (((start|end) & ~align_mask) || (start >= end) || (end > 0x1000000000000ULL)) {
 323                 HPSB_ERR("%s called with invalid addresses (start = %012Lx    end = %012Lx)",
 324                          __FUNCTION__, (unsigned long long)start, (unsigned long long)end);
 325                 return retval;
 326         }
 327
 328         as = kmalloc(sizeof(*as), GFP_KERNEL);
 329         if (!as)
 330                 return retval;
 331
 332         INIT_LIST_HEAD(&as->host_list);
 333         INIT_LIST_HEAD(&as->hl_list);
 334         as->op = ops;
 335         as->host = host;
 336
 337         write_lock_irqsave(&addr_space_lock, flags);
 338
 339         list_for_each(entry, &host->addr_space) {
 340                 u64 a1sa, a1ea;
 341                 u64 a2sa, a2ea;
 342
 343                 a1 = list_entry(entry, struct hpsb_address_serve, host_list);
 344                 a2 = list_entry(entry->next, struct hpsb_address_serve, host_list);
 345
 346                 a1sa = a1->start & align_mask;
 347                 a1ea = (a1->end + alignment -1) & align_mask;
 348                 a2sa = a2->start & align_mask;
 349                 a2ea = (a2->end + alignment -1) & align_mask;
 350
 351                 if ((a2sa - a1ea >= size) && (a2sa - start >= size) && (a2sa > start)) {
 352                         as->start = max(start, a1ea);
 353                         as->end = as->start + size;
 354                         list_add(&as->host_list, entry);
 355                         list_add_tail(&as->hl_list, &hl->addr_list);
 356                         retval = as->start;
 357                         break;
 358                 }
 359         }
 360
 361         write_unlock_irqrestore(&addr_space_lock, flags);
 362
 363         if (retval == ~0ULL) {
 364                 kfree(as);
 365         }
 366
 367         return retval;
 368 }
 369
 370 int hpsb_register_addrspace(struct hpsb_highlevel *hl, struct hpsb_host *host,
 371                             struct hpsb_address_ops *ops, u64 start, u64 end)
 372 {
 373         struct hpsb_address_serve *as;
 374         struct list_head *lh;
 375         int retval = 0;
 376         unsigned long flags;
 377
 378         if (((start|end) & 3) || (start >= end) || (end > 0x1000000000000ULL)) {
 379                 HPSB_ERR("%s called with invalid addresses", __FUNCTION__);
 380                 return 0;
 381         }
 382
 383         as = kmalloc(sizeof(*as), GFP_ATOMIC);
 384         if (!as)
 385                 return 0;
 386
 387         INIT_LIST_HEAD(&as->host_list);
 388         INIT_LIST_HEAD(&as->hl_list);
 389         as->op = ops;
 390         as->start = start;
 391         as->end = end;
 392         as->host = host;
 393
 394         write_lock_irqsave(&addr_space_lock, flags);
 395
 396         list_for_each(lh, &host->addr_space) {
 397                 struct hpsb_address_serve *as_this =
 398                         list_entry(lh, struct hpsb_address_serve, host_list);
 399                 struct hpsb_address_serve *as_next =
 400                         list_entry(lh->next, struct hpsb_address_serve, host_list);
 401
 402                 if (as_this->end > as->start)
 403                         break;
 404
 405                 if (as_next->start >= as->end) {
 406                         list_add(&as->host_list, lh);
 407                         list_add_tail(&as->hl_list, &hl->addr_list);
 408                         retval = 1;
 409                         break;
 410                 }
 411         }
 412         write_unlock_irqrestore(&addr_space_lock, flags);
 413
 414         if (retval == 0)
 415                 kfree(as);
 416
 417         return retval;
 418 }
 419
 420 int hpsb_unregister_addrspace(struct hpsb_highlevel *hl, struct hpsb_host *host,
 421                               u64 start)
 422 {
 423         int retval = 0;
 424         struct hpsb_address_serve *as;
 425         struct list_head *lh, *next;
 426         unsigned long flags;
 427
 428         write_lock_irqsave(&addr_space_lock, flags);
 429
 430         list_for_each_safe (lh, next, &hl->addr_list) {
 431                 as = list_entry(lh, struct hpsb_address_serve, hl_list);
 432                 if (as->start == start && as->host == host) {
 433                         __delete_addr(as);
 434                         retval = 1;
 435                         break;
 436                 }
 437         }
 438
 439         write_unlock_irqrestore(&addr_space_lock, flags);
 440
 441         return retval;
 442 }
 443
 444 int hpsb_listen_channel(struct hpsb_highlevel *hl, struct hpsb_host *host,
 445                          unsigned int channel)
 446 {
 447         if (channel > 63) {
 448                 HPSB_ERR("%s called with invalid channel", __FUNCTION__);
 449                 return -EINVAL;
 450         }
 451
 452         if (host->iso_listen_count[channel]++ == 0) {
 453                 return host->driver->devctl(host, ISO_LISTEN_CHANNEL, channel);
 454         }
 455
 456         return 0;
 457 }
 458
 459 void hpsb_unlisten_channel(struct hpsb_highlevel *hl, struct hpsb_host *host,
 460                            unsigned int channel)
 461 {
 462         if (channel > 63) {
 463                 HPSB_ERR("%s called with invalid channel", __FUNCTION__);
 464                 return;
 465         }
 466
 467         if (--host->iso_listen_count[channel] == 0) {
 468                 host->driver->devctl(host, ISO_UNLISTEN_CHANNEL, channel);
 469         }
 470 }
 471
 472 static void init_hpsb_highlevel(struct hpsb_host *host)
 473 {
 474         INIT_LIST_HEAD(&dummy_zero_addr.host_list);
 475         INIT_LIST_HEAD(&dummy_zero_addr.hl_list);
 476         INIT_LIST_HEAD(&dummy_max_addr.host_list);
 477         INIT_LIST_HEAD(&dummy_max_addr.hl_list);
 478
 479         dummy_zero_addr.op = dummy_max_addr.op = &dummy_ops;
 480
 481         dummy_zero_addr.start = dummy_zero_addr.end = 0;
 482         dummy_max_addr.start = dummy_max_addr.end = ((u64) 1) << 48;
 483
 484         list_add_tail(&dummy_zero_addr.host_list, &host->addr_space);
 485         list_add_tail(&dummy_max_addr.host_list, &host->addr_space);
 486 }
 487
 488 void highlevel_add_host(struct hpsb_host *host)
 489 {
 490         struct hpsb_highlevel *hl;
 491
 492         init_hpsb_highlevel(host);
 493
 494         down_read(&hl_drivers_sem);
 495         list_for_each_entry(hl, &hl_drivers, hl_list) {
 496                 if (hl->add_host)
 497                         hl->add_host(host);
 498         }
 499         up_read(&hl_drivers_sem);
 500         if (host->update_config_rom) {
 501                 if (hpsb_update_config_rom_image(host) < 0)
 502                         HPSB_ERR("Failed to generate Configuration ROM image for "
 503                                  "host %s-%d", hl->name, host->id);
 504         }
 505 }
 506
 507 void highlevel_remove_host(struct hpsb_host *host)
 508 {
 509         struct hpsb_highlevel *hl;
 510
 511         down_read(&hl_drivers_sem);
 512         list_for_each_entry(hl, &hl_drivers, hl_list)
 513                 __unregister_host(hl, host, 0);
 514         up_read(&hl_drivers_sem);
 515 }
 516
 517 void highlevel_host_reset(struct hpsb_host *host)
 518 {
 519         struct hpsb_highlevel *hl;
 520
 521         read_lock(&hl_irqs_lock);
 522         list_for_each_entry(hl, &hl_irqs, irq_list) {
 523                 if (hl->host_reset)
 524                         hl->host_reset(host);
 525         }
 526         read_unlock(&hl_irqs_lock);
 527 }
 528
 529 void highlevel_iso_receive(struct hpsb_host *host, void *data, size_t length)
 530 {
 531         struct hpsb_highlevel *hl;
 532         int channel = (((quadlet_t *)data)[0] >> 8) & 0x3f;
 533
 534         read_lock(&hl_irqs_lock);
 535         list_for_each_entry(hl, &hl_irqs, irq_list) {
 536                 if (hl->iso_receive)
 537                         hl->iso_receive(host, channel, data, length);
 538         }
 539         read_unlock(&hl_irqs_lock);
 540 }
 541
 542 void highlevel_fcp_request(struct hpsb_host *host, int nodeid, int direction,
 543                            void *data, size_t length)
 544 {
 545         struct hpsb_highlevel *hl;
 546         int cts = ((quadlet_t *)data)[0] >> 4;
 547
 548         read_lock(&hl_irqs_lock);
 549         list_for_each_entry(hl, &hl_irqs, irq_list) {
 550                 if (hl->fcp_request)
 551                         hl->fcp_request(host, nodeid, direction, cts, data,
 552                                         length);
 553         }
 554         read_unlock(&hl_irqs_lock);
 555 }
 556
 557 int highlevel_read(struct hpsb_host *host, int nodeid, void *data,
 558                    u64 addr, unsigned int length, u16 flags)
 559 {
 560         struct hpsb_address_serve *as;
 561         unsigned int partlength;
 562         int rcode = RCODE_ADDRESS_ERROR;
 563
 564         read_lock(&addr_space_lock);
 565
 566         list_for_each_entry(as, &host->addr_space, host_list) {
 567                 if (as->start > addr)
 568                         break;
 569
 570                 if (as->end > addr) {
 571                         partlength = min(as->end - addr, (u64) length);
 572
 573                         if (as->op->read) {
 574                                 rcode = as->op->read(host, nodeid, data,
 575                                                      addr, partlength, flags);
 576                         } else {
 577                                 rcode = RCODE_TYPE_ERROR;
 578                         }
 579
 580                         data += partlength;
 581                         length -= partlength;
 582                         addr += partlength;
 583
 584                         if ((rcode != RCODE_COMPLETE) || !length) {
 585                                 break;
 586                         }
 587                 }
 588         }
 589
 590         read_unlock(&addr_space_lock);
 591
 592         if (length && (rcode == RCODE_COMPLETE)) {
 593                 rcode = RCODE_ADDRESS_ERROR;
 594         }
 595
 596         return rcode;
 597 }
 598
 599 int highlevel_write(struct hpsb_host *host, int nodeid, int destid,
 600                     void *data, u64 addr, unsigned int length, u16 flags)
 601 {
 602         struct hpsb_address_serve *as;
 603         unsigned int partlength;
 604         int rcode = RCODE_ADDRESS_ERROR;
 605
 606         read_lock(&addr_space_lock);
 607
 608         list_for_each_entry(as, &host->addr_space, host_list) {
 609                 if (as->start > addr)
 610                         break;
 611
 612                 if (as->end > addr) {
 613                         partlength = min(as->end - addr, (u64) length);
 614
 615                         if (as->op->write) {
 616                                 rcode = as->op->write(host, nodeid, destid,
 617                                                       data, addr, partlength, flags);
 618                         } else {
 619                                 rcode = RCODE_TYPE_ERROR;
 620                         }
 621
 622                         data += partlength;
 623                         length -= partlength;
 624                         addr += partlength;
 625
 626                         if ((rcode != RCODE_COMPLETE) || !length) {
 627                                 break;
 628                         }
 629                 }
 630         }
 631
 632         read_unlock(&addr_space_lock);
 633
 634         if (length && (rcode == RCODE_COMPLETE)) {
 635                 rcode = RCODE_ADDRESS_ERROR;
 636         }
 637
 638         return rcode;
 639 }
 640
 641
 642 int highlevel_lock(struct hpsb_host *host, int nodeid, quadlet_t *store,
 643                    u64 addr, quadlet_t data, quadlet_t arg, int ext_tcode, u16 flags)
 644 {
 645         struct hpsb_address_serve *as;
 646         int rcode = RCODE_ADDRESS_ERROR;
 647
 648         read_lock(&addr_space_lock);
 649
 650         list_for_each_entry(as, &host->addr_space, host_list) {
 651                 if (as->start > addr)
 652                         break;
 653
 654                 if (as->end > addr) {
 655                         if (as->op->lock) {
 656                                 rcode = as->op->lock(host, nodeid, store, addr,
 657                                                      data, arg, ext_tcode, flags);
 658                         } else {
 659                                 rcode = RCODE_TYPE_ERROR;
 660                         }
 661
 662                         break;
 663                 }
 664         }
 665
 666         read_unlock(&addr_space_lock);
 667
 668         return rcode;
 669 }
 670
 671 int highlevel_lock64(struct hpsb_host *host, int nodeid, octlet_t *store,
 672                      u64 addr, octlet_t data, octlet_t arg, int ext_tcode, u16 flags)
 673 {
 674         struct hpsb_address_serve *as;
 675         int rcode = RCODE_ADDRESS_ERROR;
 676
 677         read_lock(&addr_space_lock);
 678
 679         list_for_each_entry(as, &host->addr_space, host_list) {
 680                 if (as->start > addr)
 681                         break;
 682
 683                 if (as->end > addr) {
 684                         if (as->op->lock64) {
 685                                 rcode = as->op->lock64(host, nodeid, store,
 686                                                        addr, data, arg,
 687                                                        ext_tcode, flags);
 688                         } else {
 689                                 rcode = RCODE_TYPE_ERROR;
 690                         }
 691
 692                         break;
 693                 }
 694         }
 695
 696         read_unlock(&addr_space_lock);
 697
 698         return rcode;
 699 }