/* $Id$ */ /* * Copyright (c) 1990-1996 Sam Leffler * Copyright (c) 1991-1996 Silicon Graphics, Inc. * HylaFAX is a trademark of Silicon Graphics * * Permission to use, copy, modify, distribute, and sell this software and * its documentation for any purpose is hereby granted without fee, provided * that (i) the above copyright notices and this permission notice appear in * all copies of the software and related documentation, and (ii) the names of * Sam Leffler and Silicon Graphics may not be used in any advertising or * publicity relating to the software without the specific, prior written * permission of Sam Leffler and Silicon Graphics. * * THE SOFTWARE IS PROVIDED "AS-IS" AND WITHOUT WARRANTY OF ANY KIND, * EXPRESS, IMPLIED OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. * * IN NO EVENT SHALL SAM LEFFLER OR SILICON GRAPHICS BE LIABLE FOR * ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, * OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, * WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF * LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE * OF THIS SOFTWARE. */ #include "Class2Ersatz.h" #include "ModemConfig.h" #include #include Class2ErsatzModem::Class2ErsatzModem(FaxServer& s, const ModemConfig& c) : Class2Modem(s,c) { serviceType = SERVICE_CLASS2; setupDefault(classCmd, conf.class2Cmd, "AT+FCLASS=2"); setupDefault(mfrQueryCmd, conf.mfrQueryCmd, "AT+FMFR?"); setupDefault(modelQueryCmd, conf.modelQueryCmd, "AT+FMDL?"); setupDefault(revQueryCmd, conf.revQueryCmd, "AT+FREV?"); setupDefault(dccQueryCmd, conf.class2DCCQueryCmd, "AT+FDCC=?"); setupDefault(abortCmd, conf.class2AbortCmd, "AT+FK"); setupDefault(borCmd, conf.class2BORCmd, "AT+FBOR=0"); setupDefault(tbcCmd, conf.class2TBCCmd, "AT+FTBC=0"); setupDefault(crCmd, conf.class2CRCmd, "AT+FCR=1"); setupDefault(phctoCmd, conf.class2PHCTOCmd, "AT+FPHCTO=30"); setupDefault(bugCmd, conf.class2BUGCmd, "AT+FBUG=1"); setupDefault(lidCmd, conf.class2LIDCmd, "AT+FLID"); setupDefault(dccCmd, conf.class2DCCCmd, "AT+FDCC"); setupDefault(disCmd, conf.class2DISCmd, "AT+FDIS"); setupDefault(cigCmd, conf.class2CIGCmd, "AT+FCIG"); setupDefault(splCmd, conf.class2SPLCmd, "AT+FSPL"); setupDefault(ptsCmd, conf.class2PTSCmd, "AT+FPTS"); setupDefault(minspCmd, conf.class2MINSPCmd, "AT+FMINSP"); setupDefault(noFlowCmd, conf.class2NFLOCmd, ""); setupDefault(softFlowCmd, conf.class2SFLOCmd, ""); setupDefault(hardFlowCmd, conf.class2HFLOCmd, ""); } Class2ErsatzModem::~Class2ErsatzModem() { } ATResponse Class2ErsatzModem::atResponse(char* buf, long ms) { if (FaxModem::atResponse(buf, ms) == AT_OTHER && (buf[0] == '+' && buf[1] == 'F')) { if (strneq(buf, "+FHNG:", 6)) { processHangup(buf+6); lastResponse = AT_FHNG; hadHangup = true; } else if (strneq(buf, "+FCON", 5)) lastResponse = AT_FCON; else if (strneq(buf, "+FPOLL", 6)) lastResponse = AT_FPOLL; else if (strneq(buf, "+FDIS:", 6)) lastResponse = AT_FDIS; else if (strneq(buf, "+FNSF:", 6)) lastResponse = AT_FNSF; else if (strneq(buf, "+FCSI:", 6)) lastResponse = AT_FCSI; else if (strneq(buf, "+FPTS:", 6)) lastResponse = AT_FPTS; else if (strneq(buf, "+FDCS:", 6)) lastResponse = AT_FDCS; else if (strneq(buf, "+FNSS:", 6)) lastResponse = AT_FNSS; else if (strneq(buf, "+FTSI:", 6)) lastResponse = AT_FTSI; else if (strneq(buf, "+FET:", 5)) lastResponse = AT_FET; else if (strneq(buf, "+FPA:", 5)) lastResponse = AT_FPA; else if (strneq(buf, "+FSA:", 5)) lastResponse = AT_FSA; else if (strneq(buf, "+FPW:", 5)) lastResponse = AT_FPW; } return (lastResponse); } /* * Handle the page-end protocol. */ bool Class2ErsatzModem::pageDone(u_int ppm, u_int& ppr) { ppr = 0; // something invalid if (ppm == PPH_SKIP) { protoTrace("pageDone: PPH_SKIP"); ppr = PPR_MCF; return true; } if (class2Cmd("AT+FET", ppm, AT_NOTHING)) { for (;;) { switch (atResponse(rbuf, conf.pageDoneTimeout)) { case AT_FPTS: if (sscanf(rbuf+6, "%u", &ppr) != 1) { protoTrace("MODEM protocol botch (\"%s\"), %s", rbuf, "can not parse PPR"); return (false); // force termination } /* * This hack produces more problems than solves (latest ZyXELs * seem not to have the bug described below). But if there is * some delay between +FPTS and OK, and the next command is * feeded before OK is returned, some modems (e.g. Xircom) * will then return an error (+FHNG:2). Nonetheless I daren't * remove this code completely :-) -- dbely */ #if 0 /* * (In some firmware revisions...) The ZyXEL modem * appears to drop DCD when the remote side drops * carrier, no matter whether DCD is configured to * follow carrier or not. This results in a stream * of empty lines, sometimes* followed by the requisite * trailing OK. As a hack workaround to deal with * the situation we accept the post page response if * this is the last page that we're sending and the * page is good (i.e. we would hang up immediately anyway). */ if (ppm == PPM_EOP && ppr == PPR_MCF) return (true); #endif break; case AT_OK: // normal result code case AT_ERROR: // possible if page retransmit return (true); case AT_FHNG: waitFor(AT_OK); /* * Certain modems respond +FHNG:0 on the final page * w/o providing post-page status when sending to * broken fax machines. We interpret this to be an * acknowledgement, even though it's really a violation * of the spec. */ if (ppm == PPM_EOP && ppr == 0 && isNormalHangup()) { ppr = PPR_MCF; return (true); } return (isNormalHangup()); case AT_EMPTYLINE: case AT_TIMEOUT: case AT_NOCARRIER: case AT_NODIALTONE: case AT_NOANSWER: goto bad; } } } bad: processHangup("50"); // Unspecified Phase D error return (false); } /* * Abort a data transfer in progress. */ void Class2ErsatzModem::abortDataTransfer() { protoTrace("SEND abort data transfer"); char c = CAN; putModemData(&c, 1); } /* * Send an end-of-transmission signal to the modem. */ bool Class2ErsatzModem::sendEOT() { static char EOT[] = { DLE, ETX }; return (putModemData(EOT, sizeof (EOT))); } /* * Send a page of data using the ``stream interface''. */ bool Class2ErsatzModem::sendPage(TIFF* tif, u_int pageChop, bool cover) { protoTrace("SEND begin page"); if (flowControl == FLOW_XONXOFF) setXONXOFF(FLOW_XONXOFF, FLOW_NONE, ACT_FLUSH); bool rc = sendPageData(tif, pageChop, cover); if (rc && conf.class2SendRTC) rc = sendRTC(params); if (rc) rc = sendEOT(); else abortDataTransfer(); if (flowControl == FLOW_XONXOFF) setXONXOFF(getInputFlow(), FLOW_XONXOFF, ACT_DRAIN); protoTrace("SEND end page"); return (rc ? (waitFor(AT_OK, conf.pageDoneTimeout) && hangupCode[0] == '\0') : rc); }