wvdial/wvmodemscan.cc

   1 /*
   2  * Worldvisions Weaver Software:
   3  *   Copyright (C) 1997-2003 Net Integration Technologies, Inc.
   4  *
   5  * Intelligent serial port scanner: try to find a port (or ports)
   6  * with a working modem, guess a basic startup init string, and find
   7  * the maximum baud rate.
   8  */
   9 #include "wvmodemscan.h"
  10 #include "wvmodem.h"
  11 #include "strutils.h"
  12 #include <time.h>
  13 #include <assert.h>
  14 #include <dirent.h>
  15 #include <ctype.h>
  16 #include <sys/stat.h>
  17
  18 WvString isdn_init;
  19 bool     default_asyncmap = false;
  20
  21 // startup at atz atq0 atv1 ate1 ats0 carrier dtr fastdial
  22 // baudstep reinit done
  23 static char *commands[WvModemScan::NUM_STAGES] = {
  24     NULL, "Q0 V1 E1", "Z", "S0=0",
  25     "&C1", "&D2", "+FCLASS=0", NULL,
  26     NULL, "", NULL
  27 };
  28
  29 static int baudcheck[6] = {
  30         2400,
  31         9600,
  32         115200,
  33         0
  34 };
  35
  36 static int default_baud =   baudcheck[0];
  37 static int isdn_speed   = 115200;
  38
  39 WvModemScan::WvModemScan(WvStringParm devname, bool is_modem_link)
  40         : debug(devname, WvLog::Debug)
  41 {
  42     stage = Startup;
  43     memset(status, 0, sizeof(status));
  44
  45     if (devname[0] == '/')
  46         file = devname;
  47     else
  48         file = WvString("/dev/%s", devname);
  49
  50     use_modem_link = is_modem_link;
  51     baud = default_baud;
  52     modem = NULL;
  53     tries = 0;
  54     broken = false;
  55 }
  56
  57
  58 WvModemScan::~WvModemScan()
  59 {
  60     if (isok() && isdone())
  61         debug(WvLog::Info, "Speed %s; init \"%s\"\n", maxbaud(), initstr());
  62
  63     WVRELEASE(modem);
  64 }
  65
  66
  67 bool WvModemScan::use_default_asyncmap() const
  68 {
  69     return default_asyncmap;
  70 }
  71
  72 bool WvModemScan::isok() const
  73 {
  74     return !broken;
  75 }
  76
  77
  78
  79 WvString WvModemScan::initstr() const
  80 {
  81     char s[200];
  82
  83     if (isdn_init)
  84         return (isdn_init);
  85
  86     strcpy(s, "AT");
  87
  88     for (int i = 0; i < NUM_STAGES; i++)
  89     {
  90         if (status[i] != Worked && status[i] != Test)
  91             continue;
  92         if (!commands[i] || !commands[i][0])
  93             continue;
  94         if ((commands[i][0]=='Z' || commands[i][0]=='I') && status[i] != Test)
  95             continue;
  96
  97         strcat(s, commands[i]);
  98         strcat(s, " ");
  99     }
 100
 101     return WvString(trim_string(s));
 102 }
 103
 104
 105 void WvModemScan::execute()
 106 {
 107     if (isdone() || !isok()) return;
 108
 109     switch ((Stage)stage)
 110     {
 111     case Startup:
 112         assert(!modem);
 113         modem = new WvModem(file, baud);
 114         modem->die_fast = true;
 115         if (!modem->isok())
 116         {
 117             if (modem->geterr()
 118                 && modem->geterr() != EIO
 119                 && modem->geterr() != ENOENT
 120                 && modem->geterr() != ENODEV)
 121             {
 122                 debug(WvLog::Info, "%s\n", modem->errstr());
 123             }
 124             broken = true;
 125         }
 126         else
 127             stage++;
 128         break;
 129
 130     case AT:
 131     case ATZ:
 132     case ATS0:
 133     case Carrier:
 134     case DTR:
 135     case FCLASS:
 136     case Reinit:
 137         assert(modem);
 138         status[stage] = Test;
 139         if (!strncmp(file, "/dev/ircomm", 11))
 140         {
 141             while (baudcheck[tries+1] <= 9600 && baudcheck[tries+1] != 0)
 142                 tries++;
 143
 144             if (baudcheck[tries] > 19200 || baudcheck[tries] == 0)
 145             {
 146                 broken = true;
 147                 debug("failed at 9600 and 19200 baud.\n");
 148                 return;
 149             }
 150             baud = modem->speed(baudcheck[tries]);
 151         }
 152         if (!doresult(WvString("%s\r", initstr()), stage==ATZ ? 3000 : 500)
 153             || ((stage <= AT || stage == Reinit) && status[stage]==Fail))
 154         {
 155             int old_baud = baud;
 156             tries++;
 157             //modem->drain();
 158             //modem->speed(baud*2);
 159             //baud = modem->speed(baud);
 160             if (baudcheck[tries] == 0)
 161             {
 162                 broken = true;
 163                 debug("and failed too at %s, giving up.\n",
 164                         WvString(isdn_speed));
 165                 // Go back to default_baud:
 166                 modem->speed(default_baud);
 167                 baud = modem->getspeed();
 168             }
 169             else if (strncmp(file, "/dev/ircomm", 11))
 170                 debug("failed with %s baud, next try: %s baud\n",
 171                       old_baud,
 172                       baud = modem->speed(baudcheck[tries]));
 173                     //baud = modem->speed(baud*2));
 174 #if 0
 175             if (tries >= 4)
 176             {
 177                 if (baud == default_baud)
 178                 {
 179                         debug("nothing at %s baud,\n", WvString(default_baud));
 180                         // Ok, then let's try ISDN speed for ISDN TAs:
 181                         modem->speed(isdn_speed);
 182                         baud = modem->getspeed();
 183                         tries = 0;
 184                 }
 185                 else
 186                 {
 187                         // Ok, we tried default_baud and ISDN speed, give up:
 188                         broken = true;
 189                         debug("nor at %s.\n", WvString(isdn_speed));
 190                         // Go back to default_baud:
 191                         modem->speed(default_baud);
 192                         baud = modem->getspeed();
 193                 }
 194             }
 195 #endif
 196
 197             // else try again shortly
 198         }
 199         else
 200         {
 201             tries = 0;
 202             stage++;
 203         }
 204         break;
 205
 206     case GetIdent:
 207         assert(modem);
 208         status[stage] = Test;
 209         debug("Modem Identifier: ");
 210         if (!doresult(WvString("ATI\r"), 500) || (status[stage]==Fail))
 211         {
 212             tries++;
 213
 214             if (tries >= 3)
 215                 debug("nothing.\n");
 216
 217             // else try again shortly
 218         }
 219         else
 220         {
 221             if (is_isdn())
 222                 debug("Looks like an ISDN modem.\n");
 223
 224             if (!strncmp(identifier, "Hagenuk", 7))
 225             {
 226                 status[stage] = Test;
 227                 if (doresult(WvString("ATI1\r"), 500))
 228                     if (!strncmp(identifier, "Speed Dragon", 12)
 229                     ||  !strncmp(identifier, "Power Dragon", 12))
 230                     {
 231                         isdn_init = "ATB8";
 232                         modem_name = WvString("Hagenuk %s", identifier);
 233                     }
 234                 status[stage] = Worked;
 235             }
 236             else if (!strncmp(identifier, "346900", 6))
 237             {
 238                 status[stage] = Test;
 239                 if (doresult(WvString("ATI3\r"), 500))
 240                     if (!strncmp(identifier, "3Com U.S. Robotics ISDN",23))
 241                     {
 242                         isdn_init = "AT*PPP=1";
 243                         modem_name = identifier;
 244                     }
 245                 status[stage] = Worked;
 246             }
 247             else if (!strncmp(identifier, "SP ISDN", 7))
 248             {
 249                 status[stage] = Test;
 250                 if (doresult(WvString("ATI4\r"), 500))
 251                     if (!strncmp(identifier, "Sportster ISDN TA", 17))
 252                     {
 253                         isdn_init = "ATB3";
 254                         modem_name = identifier;
 255                     }
 256                 status[stage] = Worked;
 257             }
 258             else if (!strncmp(identifier, "\"Version", 8))
 259             {
 260                 status[stage] = Test;
 261                 if (doresult(WvString("ATI6\r"), 500))
 262                     modem_name = identifier;
 263                 status[stage] = Worked;
 264             }
 265             else if (!strncmp(identifier, "644", 3))
 266             {
 267                 status[stage] = Test;
 268                 if (doresult(WvString("ATI6\r"), 500))
 269                     if (!strncmp(identifier, "ELSA MicroLink ISDN", 19))
 270                     {
 271                         isdn_init = "AT$IBP=HDLCP";
 272                         modem_name = identifier;
 273                         default_asyncmap = true;
 274                     }
 275                 status[stage] = Worked;
 276             }
 277             else if (!strncmp(identifier, "643", 3))
 278             {
 279                 status[stage] = Test;
 280                 if (doresult(WvString("ATI6\r"), 500))
 281                     if (!strncmp(identifier, "MicroLink ISDN/TLV.34", 21))
 282                     {
 283                         isdn_init = "AT\\N10%P1";
 284                         modem_name = identifier;
 285                     }
 286                 status[stage] = Worked;
 287             }
 288             else if (!strncmp(identifier, "ISDN TA", 6))
 289             {
 290                 status[stage] = Test;
 291                 if (doresult(WvString("ATI5\r"), 500))
 292                     if (strstr(identifier, ";ASU"))
 293                     {
 294                         isdn_init = "ATB40";
 295                         modem_name = "ASUSCOM ISDNLink TA";
 296                     }
 297                 status[stage] = Worked;
 298             }
 299             else if (!strncmp(identifier, "128000", 6))
 300             {
 301                 status[stage] = Test;
 302                 if (doresult(WvString("ATI3\r"), 500))
 303                     if (!strncmp(identifier, "Lasat Speed", 11))
 304                     {
 305                         isdn_init = "AT\\P1&B2X3";
 306                         modem_name = identifier;
 307                     }
 308                 status[stage] = Worked;
 309             }
 310             else if (!strncmp(identifier, "28642", 5) // Elite 2864I
 311                      || !strncmp(identifier, "1281", 4)  // Omni TA128 USA
 312                      || !strncmp(identifier, "1282", 4)  // Omni TA128 DSS1
 313                      || !strncmp(identifier, "1283", 4)  // Omni TA128 1TR6
 314                      || !strncmp(identifier, "1291", 4)  // Omni.Net USA
 315                      || !strncmp(identifier, "1292", 4)  // Omni.Net DSS1
 316                      || !strncmp(identifier, "1293", 4)  // Omni.Net 1TR6
 317                      )
 318             {
 319                 status[stage] = Test;
 320                 if (doresult(WvString("ATI1\r"), 500))
 321                     if (!strncmp(identifier, "Elite 2864I", 11)
 322                         || !strncmp(identifier, "ZyXEL omni", 10))
 323                     {
 324                         isdn_init = "AT&O2B40";
 325                         if (strncmp(identifier, "ZyXEL", 5))
 326                             modem_name = WvString("ZyXEL %s", identifier);
 327                         else
 328                             modem_name = identifier;
 329                     }
 330                 status[stage] = Worked;
 331             }
 332
 333             tries = 0;
 334             stage++;
 335         }
 336
 337     case BaudStep:
 338         assert(modem);
 339         modem->drain();
 340         modem->speed(baud*2);
 341
 342         // if we try 2*baud three times without success, or setting 2*baud
 343         // results in a lower setting than 1*baud, we have reached the
 344         // top speed of the modem or the serial port, respectively.
 345         if (tries >= 3 || modem->getspeed() <= baud)
 346         {
 347             // using the absolute maximum baud rate confuses many slower modems
 348             // in obscure ways; step down one.
 349             baud = modem->speed(baud);
 350             debug("Max speed is %s; that should be safe.\n", baud);
 351
 352             stage++;
 353             status[stage] = Worked;
 354             break;
 355         }
 356
 357         debug("Speed %s: ", modem->getspeed());
 358
 359         if (!doresult("AT\r", 500) || status[stage] == Fail)
 360         {
 361             tries++;
 362         }
 363         else // got a response
 364         {
 365             baud = modem->getspeed();
 366             tries = 0;
 367             // next time through we try a faster speed
 368         }
 369         break;
 370
 371     case Done:
 372     case NUM_STAGES:
 373         assert(0);
 374         break; // should never happen
 375     }
 376
 377     if (stage == Done) // we just incremented stage number to Done
 378     {
 379         WVRELEASE(modem);
 380     }
 381 }
 382
 383
 384 bool WvModemScan::doresult(WvStringParm _s, int msec)
 385 {
 386     char buf[1024], *cptr;
 387     size_t len;
 388     WvString s(_s);
 389
 390     modem->drain();
 391     usleep(50 * 1000); // delay a bit after emptying the buffer
 392     modem->write(s);
 393
 394     debug("%s -- ", trim_string(s.edit()));
 395
 396     len = coagulate(buf, sizeof(buf), msec);
 397
 398     if (!len)
 399     {
 400         // debug("(no answer yet)\n");
 401         return false;
 402     }
 403
 404     buf[len] = 0;
 405
 406     cptr = trim_string(buf);
 407     while (strchr(cptr, '\r'))
 408     {
 409         cptr = trim_string(strchr(cptr, '\r'));
 410         if (stage == GetIdent && status[stage] == Test)
 411         {
 412             char *p = strpbrk(cptr, "\n\r");
 413             if (p) *p=0;
 414             identifier = cptr;
 415             status[stage] = Worked;
 416             debug("%s\n", identifier);
 417             return true;
 418         }
 419     }
 420     while (strchr(cptr, '\n'))
 421         cptr = trim_string(strchr(cptr, '\n'));
 422
 423     debug("%s\n", cptr);
 424
 425     if (!strncmp(cptr, "OK", 2))
 426         status[stage] = Worked;
 427     else
 428         status[stage] = Fail;
 429
 430     return true;
 431 }
 432
 433
 434 size_t WvModemScan::coagulate(char *buf, size_t size, int msec)
 435 {
 436     size_t len = 0, amt;
 437     char *cptr = buf;
 438
 439     assert(modem);
 440
 441     if (!modem->isok())
 442     {
 443         broken = true;
 444         return 0;
 445     }
 446
 447     while (modem->select(msec, true, false))
 448     {
 449         amt = modem->read(cptr, size-1);
 450         cptr[amt] = 0;
 451
 452         len += amt;
 453         size -= amt;
 454         cptr += amt;
 455
 456         if (strstr(buf, "OK") || strstr(buf, "ERROR"))
 457             break;
 458     }
 459
 460     return len;
 461 }
 462
 463
 464 const char *WvModemScan::is_isdn() const
 465 {
 466     if (isdn_init)
 467         return isdn_init;
 468
 469     if (!identifier)
 470         return NULL;
 471
 472     if (identifier == "3C882")          // 3Com Impact IQ
 473         return identifier;
 474     if (identifier == "346800")         // USR ISDN TA
 475         return identifier;
 476
 477 #if 0 // this isn't nearly unique enough...
 478     if (identifier == "960")            // Motorola BitSurfr
 479         return identifier;
 480 #endif
 481
 482     return NULL;
 483 }
 484
 485
 486 static int fileselect(const struct dirent *e)
 487 {
 488     return !strncmp(e->d_name, "ttyS", 4)       // serial
 489        || !strncmp(e->d_name, "ttyLT", 5)       // Lucent WinModem
 490        || !strncmp(e->d_name, "ttyACM", 6)      // USB acm Modems
 491        || !strncmp(e->d_name, "ttyUSB", 6)      // Modems on USB RS232
 492        || !strncmp(e->d_name, "ircomm", 6)      // Handys over IrDA
 493        || !strncmp(e->d_name, "ttySL", 5);      // SmartLink WinModem
 494
 495         // (no internal ISDN support)   || !strncmp(e->d_name, "ttyI", 4);
 496 }
 497
 498
 499 static int filesort(const void *_e1, const void *_e2)
 500 {
 501     dirent const * const *e1 = (dirent const * const *)_e1;
 502     dirent const * const *e2 = (dirent const * const *)_e2;
 503     const char *p1, *p2;
 504     int diff;
 505
 506     for (p1=(*e1)->d_name, p2=(*e2)->d_name; *p1 || *p2; p1++, p2++)
 507     {
 508         if (!isdigit(*p1) || !isdigit(*p2))
 509         {
 510             // Scan i (ircomm*) after t (tty*):
 511             if (*p1 == 'i' && *p2 == 't')
 512                 return(1);
 513             // Scan A (ttyACM*) after S (ttyS*):
 514             if (*p1 == 'A' && *p2 == 'S')
 515                 return(1);
 516             if (*p1 == 'S' && *p2 == 'A')
 517                 return(-1);
 518             diff = *p1 - *p2;
 519             if (diff) return diff;
 520         }
 521         else // both are digits
 522         {
 523             return atoi(p1) - atoi(p2);
 524         }
 525     }
 526
 527     return 0;
 528 }
 529
 530
 531 WvModemScanList::WvModemScanList(WvStringParm _exception)
 532     : log("Modem Port Scan", WvLog::Debug)
 533 {
 534     struct dirent **namelist;
 535     struct stat mouse, modem;
 536     int num, count, mousestat, modemstat;
 537     WvString exception;
 538
 539     thisline = -1;
 540     printed = false;
 541
 542     mousestat = stat("/dev/mouse", &mouse);
 543     modemstat = stat("/dev/modem", &modem);
 544     num = scandir("/dev", &namelist, fileselect, filesort);
 545
 546     if (num < 0)
 547         return;
 548
 549     // there shouldn't be a /dev/
 550     if (!!_exception)
 551         exception = strrchr(_exception, '/') + 1;
 552
 553     for (count = 0; count < num; count++)
 554     {
 555         // never search the device assigned to /dev/mouse; most mouse-using
 556         // programs neglect to lock the device, so we could mess up the
 557         // mouse response!  (We are careful to put things back when done,
 558         // but X seems to still get confused.)  Anyway the mouse is seldom
 559         // a modem.
 560         if (mousestat==0 && mouse.st_ino == (ino_t)namelist[count]->d_ino)
 561         {
 562             log("\nIgnoring %s because /dev/mouse is a link to it.\n",
 563                        namelist[count]->d_name);
 564             continue;
 565         }
 566
 567         if (!!exception && !strcmp(exception, namelist[count]->d_name))
 568         {
 569             log("\nIgnoring %s because I've been told to ignore it.\n",
 570                 namelist[count]->d_name);
 571             continue;
 572         }
 573
 574         // bump /dev/modem to the top of the list, if it exists
 575         // and also use /dev/modem as the device name which will be used later
 576         // so PCMCIA can change it where it has detected a serial port and
 577         // wvdial will follow without the need for another wvdialconf call.
 578         if (modemstat==0 && modem.st_ino == (ino_t)namelist[count]->d_ino)
 579         {
 580             log("\nScanning %s first, /dev/modem is a link to it.\n",
 581                        namelist[count]->d_name);
 582             prepend(new WvModemScan(WvString("%s", namelist[count]->d_name), true),
 583                    true);
 584         }
 585         else
 586             append(new WvModemScan(WvString("%s", namelist[count]->d_name), false),
 587                    true);
 588     }
 589
 590     while (--num >= 0)
 591         free(namelist[num]);
 592     free(namelist);
 593 }
 594
 595
 596 // we used to try to scan all ports simultaneously; unfortunately, this
 597 // caused problems when people had "noncritical" IRQ conflicts (ie. two
 598 // serial ports with the same IRQ, but they work as long as only one port
 599 // is used at a time).  Also, the log messages looked really confused.
 600 //
 601 // So now we do the scanning sequentially, which is slower.  The port
 602 // being scanned is at the head of the list.  If the probe fails, we
 603 // unlink the element.  If it succeeds, we have found a modem -- so,
 604 // isdone() knows we are done when the _first_ element is done.
 605 //
 606 void WvModemScanList::execute()
 607 {
 608     assert (!isdone());
 609
 610     WvModemScanList::Iter i(*this);
 611
 612     for (i.rewind(); i.next(); )
 613         if (!i().isdone()) break;
 614
 615     if (!i.cur()) return;
 616
 617     WvModemScan &s(*i);
 618
 619     if (!s.isok())
 620     {
 621         if (!printed)
 622         {
 623             WvStringParm f = s.filename();
 624             const char *cptr = strrchr(f, '/');
 625             if (cptr)
 626                 cptr++;
 627             else
 628                 cptr = f;
 629
 630             if (!strncmp(cptr, "tty", 3))
 631                 cptr += 3;
 632
 633             ++thisline %= 8;
 634             if (!thisline)
 635                 log("\n");
 636
 637             log("%-4s ", cptr);
 638         }
 639
 640         i.unlink();
 641         printed = false;
 642     }
 643     else
 644     {
 645         s.execute();
 646
 647         if (s.isok())
 648             printed = true;
 649     }
 650
 651     if (isdone())
 652         log("\n");
 653 }
 654
 655
 656 bool WvModemScanList::isdone()
 657 {
 658     WvModemScanList::Iter i(*this);
 659
 660     for (i.rewind(); i.next(); )
 661         if (!i().isdone()) return false;
 662
 663     return true;
 664 }