/*====================================================================*
*
* Copyright (c) 2013 Qualcomm Atheros, Inc.
* Copyright (c) 2014 I2SE GmbH
*
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or
* without modification, are permitted (subject to the limitations
* in the disclaimer below) provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials
* provided with the distribution.
*
* * Neither the name of Qualcomm Atheros nor the names of
* its contributors may be used to endorse or promote products
* derived from this software without specific prior written
* permission.
*
* NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
* GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE
* COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
* OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*
*--------------------------------------------------------------------*/
/*====================================================================*"
*
* plchostd2.c -
*
*
* Contributor(s):
* Charles Maier <cmaier@qca.qualcomm.com>
* Nathaniel Houghton <nhoughto@qca.qualcomm.com>
* Stefan Wahren <stefan.wahren@i2se.com>
*
*--------------------------------------------------------------------*/
/*====================================================================*"
* system header files;
*--------------------------------------------------------------------*/
#include <unistd.h>
#include <stdlib.h>
#include <limits.h>
#include <string.h>
#include <ctype.h>
#include <memory.h>
#include <signal.h>
#include <errno.h>
#include <sys/socket.h>
#include <sys/un.h>
/*====================================================================*
* custom header files;
*--------------------------------------------------------------------*/
#include "../ether/channel.h"
#include "../tools/getoptv.h"
#include "../tools/putoptv.h"
#include "../tools/memory.h"
#include "../tools/number.h"
#include "../tools/types.h"
#include "../tools/flags.h"
#include "../tools/files.h"
#include "../tools/error.h"
#include "../ram/nvram.h"
#include "../ram/sdram.h"
#include "../nvm/nvm.h"
#include "../pib/pib.h"
#include "../plc/plc.h"
/*====================================================================*
* custom source files;
*--------------------------------------------------------------------*/
#ifndef MAKEFILE
#include "../plc/BootDevice2.c"
#include "../plc/BootFirmware2.c"
#include "../plc/BootParameters2.c"
#include "../plc/chipset.c"
#include "../plc/Confirm.c"
#include "../plc/Devices.c"
#include "../plc/Failure.c"
#include "../plc/FlashDevice2.c"
#include "../plc/FlashSoftloader.c"
#include "../plc/FlashFirmware.c"
#include "../plc/FlashParameters.c"
#include "../plc/FlashNVM.c"
#include "../plc/HostActionResponse.c"
#include "../plc/InitDevice2.c"
#include "../plc/ModuleRead.c"
#include "../plc/ModuleSpec.c"
#include "../plc/ModuleSession.c"
#include "../plc/ModuleWrite.c"
#include "../plc/ModuleCommit.c"
#include "../plc/LocalDevices.c"
#include "../plc/NVMSelect.c"
#include "../plc/ReadFirmware2.c"
#include "../plc/ReadParameters2.c"
#include "../plc/Request.c"
#include "../plc/ResetDevice.c"
#include "../plc/ReadMME.c"
#include "../plc/SendMME.c"
#include "../plc/WaitForReset.c"
#include "../plc/WaitForStart.c"
#include "../plc/WriteMEM.c"
#include "../plc/WriteNVM.c"
#include "../plc/WritePIB.c"
#include "../plc/WriteExecuteFirmware2.c"
#include "../plc/WriteExecuteParameters2.c"
#include "../plc/WriteExecuteApplet2.c"
#include "../plc/Platform.c"
#include "../plc/WriteFirmware2.c"
#include "../plc/PLCSelect.c"
#endif
#ifndef MAKEFILE
#include "../tools/getoptv.c"
#include "../tools/putoptv.c"
#include "../tools/version.c"
#include "../tools/uintspec.c"
#include "../tools/checkfilename.c"
#include "../tools/hexdecode.c"
#include "../tools/hexstring.c"
#include "../tools/todigit.c"
#include "../tools/hexdump.c"
#include "../tools/checksum32.c"
#include "../tools/fdchecksum32.c"
#include "../tools/error.c"
#include "../tools/strfbits.c"
#include "../tools/typename.c"
#endif
#ifndef MAKEFILE
#include "../ether/openchannel.c"
#include "../ether/closechannel.c"
#include "../ether/readpacket.c"
#include "../ether/sendpacket.c"
#include "../ether/channel.c"
#endif
#ifndef MAKEFILE
#include "../mme/EthernetHeader.c"
#include "../mme/QualcommHeader.c"
#include "../mme/UnwantedMessage.c"
#include "../mme/MMECode.c"
#ifdef AR7x00
#include "../mme/QualcommHeader1.c"
#endif
#endif
#ifndef MAKEFILE
#include "../key/keys.c"
#endif
#ifndef MAKEFILE
#include "../nvm/nvmfile2.c"
#endif
#ifndef MAKEFILE
#include "../pib/pibfile2.c"
#include "../pib/pibpeek2.c"
#endif
/*====================================================================*
* program constants;
*--------------------------------------------------------------------*/
#define MESSAGE "Starting PLC Host Server\n"
#define SOCKETNAME "/tmp/socket"
#define NEWPIB "user.pib"
#define NEWNVM "user.nvm"
/*====================================================================*
* program variables;
*--------------------------------------------------------------------*/
static bool done = false;
/*====================================================================*
*
* void terminate (signo_t signal);
*
*
*
* Contributor(s):
* Charles Maier <cmaier@qca.qualcomm.com>
*
*--------------------------------------------------------------------*/
static void terminate (signo_t signal)
{
done = true;
return;
}
/*====================================================================*
*
* signed opensocket (char const * socketname);
*
*
*
* Contributor(s):
* Charles Maier <cmaier@qca.qualcomm.com>
*
*--------------------------------------------------------------------*/
static signed opensocket (char const * socketname)
{
signed fd;
struct sockaddr_un sockaddr_un =
{
#if defined (__OpenBSD__) || defined (__APPLE__)
0,
#endif
AF_UNIX,
"/tmp/socket"
};
strncpy (sockaddr_un.sun_path, socketname, sizeof (sockaddr_un.sun_path));
#if defined (__OpenBSD__) || defined (__APPLE__)
sockaddr_un.sun_len = SUN_LEN (&sockaddr_un);
#endif
if (unlink (sockaddr_un.sun_path))
{
if (errno != ENOENT)
{
error (1, errno, "%s", sockaddr_un.sun_path);
}
}
if ((fd = socket (AF_UNIX, SOCK_DGRAM, 0)) == -1)
{
error (1, errno, "%s", sockaddr_un.sun_path);
}
if (bind (fd, (struct sockaddr *)(&sockaddr_un), sizeof (sockaddr_un)) == -1)
{
error (1, errno, "%s", sockaddr_un.sun_path);
}
if (chmod (sockaddr_un.sun_path, 0666) == -1)
{
error (1, errno, "%s", sockaddr_un.sun_path);
}
return (fd);
}
/*====================================================================*
*
* signed function (struct plc * plc, char const * socket);
*
* wait indefinitely for VS_HOST_ACTION messages; service the device
* only; it will stop dead - like a bug! - on error;
*
*
* Contributor(s):
* Charles Maier <cmaier@qca.qualcomm.com>
*
*--------------------------------------------------------------------*/
signed function (struct plc * plc, char const * socket)
{
struct channel * channel = (struct channel *)(plc->channel);
struct message * message = (struct message *)(plc->message);
static char const * actions [] =
{
"start device",
"store firmware",
"store parameters",
"update host",
"config memory",
"restore defaults",
"unknown"
};
#ifndef __GNUC__
#pragma pack (push,1)
#endif
struct __packed vs_host_action_ind
{
struct ethernet_hdr ethernet;
struct qualcomm_hdr qualcomm;
uint8_t MACTION;
uint8_t MAJOR_VERSION;
uint8_t MINOR_VERSION;
}
* indicate = (struct vs_host_action_ind *) (message);
#ifndef __GNUC__
#pragma pack (pop)
#endif
signed fd = opensocket (socket);
char firmware [PLC_VERSION_STRING];
char const * FactoryNVM = plc->NVM.name;
char const * FactoryPIB = plc->PIB.name;
signed action;
signed status;
write (fd, MESSAGE, strlen (MESSAGE));
while (!done)
{
status = ReadMME (plc, 0, (VS_HOST_ACTION | MMTYPE_IND));
if (status < 0)
{
break;
}
if (status < 1)
{
continue;
}
action = indicate->MACTION;
if (action < SIZEOF (actions))
{
fprintf(stderr, "plchostd2: action = %s\n", actions[action]);
}
else
{
fprintf(stderr, "plchostd2: action = %d\n", action);
}
memcpy (channel->peer, indicate->ethernet.OSA, sizeof (channel->peer));
if (HostActionResponse (plc))
{
return (-1);
}
if (action == 0x00)
{
if (BootDevice2 (plc))
{
return (-1);
}
if (WaitForStart (plc, firmware, sizeof (firmware)))
{
return (-1);
}
if (_anyset (plc->flags, PLC_FLASH_DEVICE))
{
FlashDevice2 (plc, (PLC_COMMIT_FORCE | PLC_COMMIT_NORESET | PLC_COMMIT_FACTPIB));
}
continue;
}
if (action == 0x01)
{
close (plc->NVM.file);
if (ReadFirmware2 (plc))
{
return (-1);
}
if ((plc->NVM.file = open (plc->NVM.name = plc->nvm.name, O_BINARY|O_RDONLY)) == -1)
{
error (1, errno, "%s", plc->NVM.name);
}
continue;
}
if (action == 0x02)
{
close (plc->PIB.file);
if (ReadParameters2 (plc))
{
return (-1);
}
if ((plc->PIB.file = open (plc->PIB.name = plc->pib.name, O_BINARY|O_RDONLY)) == -1)
{
error (1, errno, "%s", plc->PIB.name);
}
if (ResetDevice (plc))
{
return (-1);
}
continue;
}
if (action == 0x03)
{
close (plc->PIB.file);
if (ReadParameters2 (plc))
{
return (-1);
}
if ((plc->PIB.file = open (plc->PIB.name = plc->pib.name, O_BINARY|O_RDONLY)) == -1)
{
error (1, errno, "%s", plc->PIB.name);
}
close (plc->NVM.file);
if (ReadFirmware2 (plc))
{
return (-1);
}
if ((plc->NVM.file = open (plc->NVM.name = plc->nvm.name, O_BINARY|O_RDONLY)) == -1)
{
error (1, errno, "%s", plc->NVM.name);
}
if (ResetDevice (plc))
{
return (-1);
}
continue;
}
if (action == 0x04)
{
if (InitDevice2 (plc))
{
return (-1);
}
continue;
}
if (action == 0x05)
{
close (plc->NVM.file);
if ((plc->NVM.file = open (plc->NVM.name = FactoryNVM, O_BINARY|O_RDONLY)) == -1)
{
error (1, errno, "%s", plc->NVM.name);
}
close (plc->PIB.file);
if ((plc->PIB.file = open (plc->PIB.name = FactoryPIB, O_BINARY|O_RDONLY)) == -1)
{
error (1, errno, "%s", plc->PIB.name);
}
if (ResetDevice (plc))
{
return (-1);
}
continue;
}
if (action == 0x06)
{
close (plc->PIB.file);
if (ReadParameters2 (plc))
{
return (-1);
}
if ((plc->PIB.file = open (plc->PIB.name = plc->pib.name, O_BINARY|O_RDONLY)) == -1)
{
error (1, errno, "%s", plc->PIB.name);
}
continue;
}
error (0, ENOSYS, "Host Action 0x%02X", action);
}
close (fd);
return (0);
}
/*====================================================================*
*
* int main (int argc, char const * argv[]);
*
* parse command line, populate plc structure and perform selected
* operations; show help summary when asked; see getoptv and putoptv
* to understand command line parsing and help summary display; see
* plc.h for the definition of struct plc;
*
*
*--------------------------------------------------------------------*/
int main (int argc, char const * argv [])
{
extern struct channel channel;
extern void terminate (signo_t);
static char const * optv [] =
{
"dFi:n:N:p:P:qS:t:vw:x",
"-N file -P file [-S file]",
"Qualcomm Atheros Panther/Lynx PLC Host Daemon",
"d\texecute in background as daemon",
"F [F]\tflash [force] non-volatile memory",
#if defined (WINPCAP) || defined (LIBPCAP)
"i n\thost interface is (n) [" LITERAL (CHANNEL_ETHNUMBER) "]",
#else
"i s\thost interface is (s) [" LITERAL (CHANNEL_ETHDEVICE) "]",
#endif
"n f\tread firmware from device into file (f)",
"N f\tfirmware file is (f)",
"p f\tread parameters from device into file (f)",
"P f\tparameter file is (f)",
"q\tquiet mode",
"S f\tsoftloader file is (f)",
"t n\tread timeout is (n) milliseconds [" LITERAL (CHANNEL_TIMEOUT) "]",
"v\tverbose mode",
"w n\twakeup every (n) seconds [" LITERAL (PLC_LONGTIME) "]",
"x\texit on error",
(char const *) (0)
};
#include "../plc/plc.c"
struct sigaction sa;
char const * socketname = SOCKETNAME;
signed c;
if (getenv (PLCDEVICE))
{
#if defined (WINPCAP) || defined (LIBPCAP)
channel.ifindex = atoi (getenv (PLCDEVICE));
#else
channel.ifname = strdup (getenv (PLCDEVICE));
#endif
}
optind = 1;
plc.timer = PLC_LONGTIME;
while ((c = getoptv (argc, argv, optv)) != -1)
{
switch (c)
{
case 'd':
_setbits (plc.flags, PLC_DAEMON);
break;
case 'F':
_setbits (plc.module, (VS_MODULE_MAC | VS_MODULE_PIB));
if (_anyset (plc.flags, PLC_FLASH_DEVICE))
{
_setbits (plc.module, VS_MODULE_FORCE);
}
_setbits (plc.flags, PLC_FLASH_DEVICE);
break;
case 'i':
#if defined (WINPCAP) || defined (LIBPCAP)
channel.ifindex = atoi (optarg);
#else
channel.ifname = optarg;
#endif
break;
case 'N':
if (!checkfilename (optarg))
{
error (1, EINVAL, "%s", optarg);
}
if ((plc.NVM.file = open (plc.NVM.name = optarg, O_BINARY|O_RDONLY)) == -1)
{
error (1, errno, "%s", plc.NVM.name);
}
if (nvmfile2 (&plc.NVM))
{
error (1, errno, "Bad firmware file: %s", plc.NVM.name);
}
_setbits (plc.flags, PLC_WRITE_MAC);
break;
case 'n':
if (!checkfilename (optarg))
{
error (1, EINVAL, "%s", optarg);
}
if ((plc.nvm.file = open (plc.nvm.name = optarg, O_BINARY|O_CREAT|O_RDWR|O_TRUNC, FILE_FILEMODE)) == -1)
{
error (1, errno, "%s", plc.nvm.name);
}
break;
case 'P':
if (!checkfilename (optarg))
{
error (1, EINVAL, "%s", optarg);
}
if ((plc.PIB.file = open (plc.PIB.name = optarg, O_BINARY|O_RDONLY)) == -1)
{
error (1, errno, "%s", plc.PIB.name);
}
if (pibfile2 (&plc.PIB))
{
error (1, errno, "Bad parameter file: %s", plc.PIB.name);
}
_setbits (plc.flags, PLC_WRITE_PIB);
break;
case 'p':
if (!checkfilename (optarg))
{
error (1, EINVAL, "%s", optarg);
}
if ((plc.pib.file = open (plc.pib.name = optarg, O_BINARY|O_CREAT|O_RDWR|O_TRUNC, FILE_FILEMODE)) == -1)
{
error (1, errno, "%s", plc.pib.name);
}
break;
case 'q':
_setbits (channel.flags, CHANNEL_SILENCE);
_setbits (plc.flags, PLC_SILENCE);
break;
case 'S':
if (!checkfilename (optarg))
{
error (1, EINVAL, "%s", optarg);
}
if ((plc.CFG.file = open (plc.CFG.name = optarg, O_BINARY|O_RDONLY)) == -1)
{
error (1, errno, "%s", plc.CFG.name);
}
if (nvmfile2 (&plc.CFG))
{
error (1, errno, "Bad firmware file: %s", plc.CFG.name);
}
break;
case 't':
channel.timeout = (signed)(uintspec (optarg, 0, UINT_MAX));
break;
case 'v':
_setbits (channel.flags, CHANNEL_VERBOSE);
_setbits (plc.flags, PLC_VERBOSE);
break;
case 'w':
plc.timer = (unsigned)(uintspec (optarg, 1, 3600));
break;
case 'x':
_setbits (plc.flags, PLC_BAILOUT);
break;
default:
break;
}
}
argc -= optind;
argv += optind;
if (argc)
{
error (1, ENOTSUP, ERROR_TOOMANY);
}
if (plc.NVM.file == -1)
{
error (1, ECANCELED, "No host NVM file named");
}
if (plc.PIB.file == -1)
{
error (1, ECANCELED, "No host PIB file named");
}
if (plc.CFG.file == -1)
{
if (_anyset (plc.flags, PLC_FLASH_DEVICE))
{
error (1, ECANCELED, "No Softloader file named");
}
}
if (plc.nvm.file == -1)
{
if ((plc.nvm.file = open (plc.nvm.name = NEWNVM, O_BINARY|O_CREAT|O_RDWR|O_TRUNC, FILE_FILEMODE)) == -1)
{
error (1, errno, "%s", plc.nvm.name);
}
}
if (plc.pib.file == -1)
{
if ((plc.pib.file = open (plc.pib.name = NEWPIB, O_BINARY|O_CREAT|O_RDWR|O_TRUNC, FILE_FILEMODE)) == -1)
{
error (1, errno, "%s", plc.pib.name);
}
}
#ifndef WIN32
if (_anyset (plc.flags, PLC_DAEMON))
{
pid_t pid = fork ();
if (pid < 0)
{
error (1, errno, "Can't start daemon");
}
if (pid > 0)
{
exit (0);
}
}
memset (&sa, 0, sizeof (struct sigaction));
sa.sa_handler = terminate;
sigaction (SIGTERM, &sa, (struct sigaction *)(0));
sigaction (SIGQUIT, &sa, (struct sigaction *)(0));
sigaction (SIGTSTP, &sa, (struct sigaction *)(0));
sigaction (SIGINT, &sa, (struct sigaction *)(0));
sigaction (SIGHUP, &sa, (struct sigaction *)(0));
#endif
openchannel (&channel);
if (!(plc.message = malloc (sizeof (* plc.message))))
{
error (1, errno, PLC_NOMEMORY);
}
function (&plc, socketname);
free (plc.message);
closechannel (&channel);
exit (0);
}