-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * unsigned ARPCPeek (void const * memory, size_t extent, FILE * fp);
- *
- * mme.h
- *
- *
- *--------------------------------------------------------------------*/
-
-#include <stdio.h>
-#include <unistd.h>
-
-#include "../tools/types.h"
-#include "../tools/endian.h"
-
-void ARPCPeek (void const * memory, size_t extent, FILE * fp)
-
-{
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_arpc_data
- {
- uint32_t BYPASS;
- uint16_t ARPCID;
- uint16_t DATALENGTH;
- uint8_t DATAOFFSET;
- uint8_t RESERVED [3];
- uint16_t ARGOFFSET;
- uint16_t STROFFSET;
- uint16_t ARGLENGTH;
- uint16_t STRLENGTH;
- uint8_t LIST [1];
- }
- * data = (struct vs_arpc_data *)(memory);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- fprintf (fp, "BYPASS=%d ", data->BYPASS);
- fprintf (fp, "ARPCID=%d ", data->ARPCID);
- fprintf (fp, "DATALENGTH=%d ", LE16TOH (data->DATALENGTH));
- fprintf (fp, "DATAOFFSET=%d ", data->DATAOFFSET);
- fprintf (fp, "ARGOFFSET=%d ", LE16TOH (data->ARGOFFSET));
- fprintf (fp, "STROFFSET=%d ", LE16TOH (data->STROFFSET));
- fprintf (fp, "ARGLENGTH=%d ", LE16TOH (data->ARGLENGTH));
- fprintf (fp, "STRLENGTH=%d ", LE16TOH (data->STRLENGTH));
- if (data->ARPCID == 1)
- {
- fprintf (fp, "FORMAT=[%s]\n", &data->LIST [data->STROFFSET]);
- }
- return;
-}
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void ARPCPrint (FILE * fp, void const * memory, size_t extent);
- *
- * mme.h
- *
- * print formatted VS_ARPC payload on the specified output stream;
- * this implementation is generic; memory is the start address of
- * the message data (&RDATA [RDATAOFFSET]) and extent is the data
- * length (RDATALENGTH); the call might look like this ...
- *
- * ARPCPrint (fp, &ARPC->RDATA [ARPC->RDATAOFFSET], LE16TOH (ARPC->RDATALENGTH) - ARPC->RDATAOFFSET);
- *
- * ... where LE16TOH () performs 16-bit host endian conversion;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- * Florian Fainelli <f.fainelli@gmail.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef ARPCPRINT_SOURCE
-#define ARPCPRINT_SOURCE
-
-#include <stdio.h>
-#include <stddef.h>
-
-#include "../tools/types.h"
-#include "../tools/endian.h"
-#include "../tools/memory.h"
-#include "../mme/mme.h"
-
-void ARPCPrint (FILE * fp, void const * memory, size_t extent)
-
-{
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_arpc_data
- {
- uint32_t BYPASS;
- uint16_t ARPCID;
- uint16_t DATALENGTH;
- uint8_t DATAOFFSET;
- uint8_t RESERVED [3];
- uint16_t ARGOFFSET;
- uint16_t STROFFSET;
- uint16_t ARGLENGTH;
- uint16_t STRLENGTH;
- uint8_t LIST [1];
- }
- * data = (struct vs_arpc_data *)(memory);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- uint32_t * argp = (uint32_t *)(&data->LIST [LE16TOH (data->ARGOFFSET)]);
- uint16_t argc = LE16TOH (data->ARGLENGTH) >> 2;
- while (argc--)
- {
- *argp = LE32TOH (*argp);
- argp++;
- }
-
-#if defined (__UCLIBC__)
-
-/*
- * This is a simple fix to work around uclibc implementation issue with variable arugment lists; We are
- * testing a better one but most PLC users will not have access to firmware that exercises this module;
- */
-
- argp = (uint32_t *)(&data->LIST [LE16TOH (data->ARGOFFSET)]);
- fprintf (fp, (char *)(&data->LIST [LE16TOH (data->STROFFSET)]), argp [0], argp [1], argp [2], argp [3], argp [4], argp [5], argp [6], argp [7], argp [8], argp [9], argp [10], argp [11], argp [12], argp [13], argp [14], argp [15], argp [16], argp [17], argp [18], argp [19], argp [20], argp [21], argp [22], argp [23], argp [24], argp [25], argp [26], argp [27], argp [28], argp [29], argp [30], argp [31], argp [32], argp [33], argp [34], argp [35], argp [36], argp [37], argp [38], argp [39]);
-
-#else
-
- vfprintf (fp, (char *)(&data->LIST [LE16TOH (data->STROFFSET)]), (void *)(&data->LIST [LE16TOH (data->ARGOFFSET)]));
-
-#endif
-
- fprintf (fp, "\n");
- fflush (fp);
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void ARPCWrite (signed fd, void const * memory, size_t extent);
- *
- * mme.h
- *
- * write an unformatted VS_ARPC payload on the specified output
- * stream; this implementation is generic; memory is the start
- * address of the message data (&RDATA [RDATAOFFSET]) and extent
- * is the data length (RDATALENGTH); the call might look like
- * this ...
- *
- * ARPCWrite (fd, &ARPC->RDATA [ARPC->RDATAOFFSET], LE16TOH (ARPC->RDATALENGTH - ARPC->RDATAOFFSET));
- *
- * ... where LE16TOH () performs 16-bit host endian conversion;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef ARPCWRITE_SOURCE
-#define ARPCWRITE_SOURCE
-
-#include <stdio.h>
-
-#include "../tools/types.h"
-#include "../tools/endian.h"
-#include "../tools/memory.h"
-#include "../tools/number.h"
-#include "../mme/mme.h"
-
-void ARPCWrite (signed fd, void const * memory, size_t extent)
-
-{
-
-#if 0
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_arpc_data
- {
- uint32_t BYPASS;
- uint16_t ARPCID;
- uint16_t DATALENGTH;
- uint8_t DATAOFFSET;
- uint8_t RESERVED [3];
- uint16_t ARGOFFSET;
- uint16_t STROFFSET;
- uint16_t ARGLENGTH;
- uint16_t STRLENGTH;
- uint8_t LIST [1];
- }
- * data = (struct vs_arpc_data *)(memory);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
-#endif
- uint16_t length = (uint16_t)(extent);
- if (isatty (fd))
- {
- hexwrite (fd, &length, sizeof (length));
- hexwrite (fd, memory, length);
-
-#if defined (_WIN32)
-
- write (fd, "\r", sizeof (char));
-
-#endif
-
- write (fd, "\n", sizeof (char));
- }
- else
- {
- write (fd, &length, sizeof (length));
- write (fd, memory, length);
- }
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed Antiphon (struct plc * plc);
- *
- * plc.h
- *
- * instruct one powerline device to send trash frames to another
- * for a given period (in seconds) to establish source device RX
- * PHY rate and target device TX PHY rate; this does not work if
- * the source device is also the local device, for some reason;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef ANTIPHON_SOURCE
-#define ANTIPHON_SOURCE
-
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../plc/plc.h"
-
-signed Antiphon (struct plc * plc, byte source [], byte target [])
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_fr_lbk_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t DURATION;
- uint8_t RESERVED;
- uint16_t LENGTH;
- uint8_t PACKET [1038];
- }
- * request = (struct vs_fr_lbk_request *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- if (_allclr (plc->flags, PLC_SILENCE))
- {
- char sourcename [ETHER_ADDR_LEN * 3];
- char targetname [ETHER_ADDR_LEN * 3];
- hexdecode (source, ETHER_ADDR_LEN, sourcename, sizeof (sourcename));
- hexdecode (target, ETHER_ADDR_LEN, targetname, sizeof (targetname));
- fprintf (stderr, "%s %s %s\n", channel->ifname, sourcename, targetname);
- }
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, source, target, channel->type);
- QualcommHeader (&request->qualcomm, 0, 41036);
- request->DURATION = plc->timer;
- request->LENGTH = HTOLE16 (sizeof (request->PACKET));
- memset (request->PACKET, 0xA5, sizeof (request->PACKET));
- EthernetHeader (request->PACKET, target, source, ETHERTYPE_IP);
- plc->packetsize = sizeof (* request);
- if (SendMME (plc) <= 0)
- {
- error (1, errno, CHANNEL_CANTSEND);
- }
-
-#if 0
-
-/*
- * This causes a multi-device session to terminate if the device has recently
- * been removed or powered-off; The device appears to be present but will not
- * respond; Also, this terminates a session if the network is overloaded with
- * traffic;
- */
-
- if (ReadMME (plc, 0, 41037) <= 0)
- {
- error (1, errno, CHANNEL_CANTREAD);
- }
-
-#endif
-
- sleep (plc->timer);
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed Attributes (struct plc * plc);
- *
- * plc.h
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef ATTRIBUTES_SOURCE
-#define ATTRIBUTES_SOURCE
-
-#include "../plc/plc.h"
-
-signed Attributes (struct plc * plc)
-
-{
- return (PLCSelect (plc, Attributes1, Attributes2));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed BootDevice (struct plc * plc);
- *
- * plc.h
- *
- * call appropriate function based on the image file format;
- *
- * boot a powerline device by writing parameters and firmware into
- * memory and starting execution; this function may be called when
- * a VS_HOST_ACTION.IND is received with HOST_ACTION_REQ set to 0;
- *
- * this implementation handles both old and new image file formats;
- * call BootDevice1 or BootDevice2 directly if you know which file
- * format will be used;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef BOOTDEVICE_SOURCE
-#define BOOTDEVICE_SOURCE
-
-#include "../plc/plc.h"
-
-signed BootDevice (struct plc * plc)
-
-{
- return (NVMSelect (plc, BootDevice1, BootDevice2));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed BootDevice1 (struct plc * plc);
- *
- * plc.h
- *
- * boot a powerline device by writing parameters and firmware into
- * volatile memory and starting execution; volatile memory must be
- * initialized and configured before calling this function;
- *
- * this function is identical to BootDevice2 but calls functions
- * that expect the older image file format;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef BOOTDEVICE1_SOURCE
-#define BOOTDEVICE1_SOURCE
-
-#include <memory.h>
-
-#include "../plc/plc.h"
-
-signed BootDevice1 (struct plc * plc)
-
-{
- char string [PLC_VERSION_STRING];
- if (BootParameters1 (plc))
- {
- return (-1);
- }
- if (BootFirmware1 (plc))
- {
- return (-1);
- }
- if (WaitForStart (plc, string, sizeof (string)))
- {
- return (-1);
- }
- Confirm (plc, "%s is running", string);
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed BootDevice2 (struct plc * plc);
- *
- * plc.h
- *
- * boot a powerline device by writing parameters and firmware into
- * volatile memory and starting execution; volatile memory must be
- * initialized and configured before calling this function;
- *
- * this function is identical to BootDevice1 but calls functions
- * that expect the newer image file format;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef BOOTDEVICE2_SOURCE
-#define BOOTDEVICE2_SOURCE
-
-#include <memory.h>
-
-#include "../plc/plc.h"
-
-signed BootDevice2 (struct plc * plc)
-
-{
- char string [PLC_VERSION_STRING];
- if (BootParameters2 (plc))
- {
- return (-1);
- }
- if (BootFirmware2 (plc))
- {
- return (-1);
- }
- if (WaitForStart (plc, string, sizeof (string)))
- {
- return (-1);
- }
- Confirm (plc, "%s is running", string);
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed BootFirmware1 (struct plc * plc);
- *
- * plc.h
- *
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef BOOTFIRMWARE1_SOURCE
-#define BOOTFIRMWARE1_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../plc/plc.h"
-#include "../nvm/nvm.h"
-
-signed BootFirmware1 (struct plc * plc)
-
-{
- unsigned module = 0;
- struct nvm_header1 nvm_header;
- if (lseek (plc->NVM.file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, plc->NVM.name);
- }
- do
- {
- if (read (plc->NVM.file, &nvm_header, sizeof (nvm_header)) != sizeof (nvm_header))
- {
- error (PLC_EXIT (plc), errno, NVM_HDR_CANTREAD, plc->NVM.name, module);
- }
- if (LE32TOH (nvm_header.HEADERVERSION) != 0x60000000)
- {
- error (PLC_EXIT (plc), ECANCELED, NVM_HDR_VERSION, plc->NVM.name, module);
- }
- if (checksum32 (&nvm_header, sizeof (nvm_header), 0))
- {
- error (PLC_EXIT (plc), ECANCELED, NVM_HDR_CHECKSUM, plc->NVM.name, module);
- }
-
-#if 0
-
- if (_anyset (LE16TOH (nvm_header.IGNOREMASK), (1 << (plc->hardwareID - 1))))
- {
- if (lseek (plc->NVM.file, LE32TOH (nvm_header.NEXTHEADER), SEEK_SET) == -1)
- {
- error (PLC_EXIT (plc), errno, "Can't skip module: %s (%d)", plc->NVM.name, module);
- }
- }
- else
-
-#endif
-
- if (nvm_header.IMAGETYPE == NVM_IMAGE_FIRMWARE)
- {
- if (plc->hardwareID < CHIPSET_AR7400)
- {
- if (WriteFirmware1 (plc, module, &nvm_header))
- {
- return (-1);
- }
- if (StartFirmware1 (plc, module, &nvm_header))
- {
- return (-1);
- }
- break;
- }
- if (WriteExecuteFirmware1 (plc, module, &nvm_header))
- {
- return (-1);
- }
- break;
- }
- if (lseek (plc->NVM.file, LE32TOH (nvm_header.NEXTHEADER), SEEK_SET) == -1)
- {
- error (PLC_EXIT (plc), errno, "Can't skip module: %s (%d)", plc->NVM.name, module);
- }
- module++;
- }
- while (nvm_header.NEXTHEADER);
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed BootFirmware2 (struct plc * plc)
- *
- * plc.h
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef BOOTFIRMWARE2_SOURCE
-#define BOOTFIRMWARE2_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../plc/plc.h"
-#include "../nvm/nvm.h"
-
-signed BootFirmware2 (struct plc * plc)
-
-{
- unsigned module = 0;
- struct nvm_header2 nvm_header;
- if (lseek (plc->NVM.file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, plc->NVM.name);
- }
- do
- {
- if (read (plc->NVM.file, &nvm_header, sizeof (nvm_header)) != sizeof (nvm_header))
- {
- error (1, errno, NVM_HDR_CANTREAD, plc->NVM.name, module);
- }
- if (LE16TOH (nvm_header.MajorVersion) != 1)
- {
- error (1, ECANCELED, NVM_HDR_VERSION, plc->NVM.name, module);
- }
- if (LE16TOH (nvm_header.MinorVersion) != 1)
- {
- error (1, ECANCELED, NVM_HDR_VERSION, plc->NVM.name, module);
- }
- if (checksum32 (&nvm_header, sizeof (nvm_header), 0))
- {
- error (1, ECANCELED, NVM_HDR_CHECKSUM, plc->NVM.name, module);
- }
-
-#if 0
-
- if (_allclr (LE16TOH (nvm_header.ExecuteMask), (1 << (plc->hardwareID - 1))))
- {
- if (lseek (plc->NVM.file, LE32TOH (nvm_header.NextHeader), SEEK_SET) == -1)
- {
- error (1, errno, "Can't skip module: %s (%d)", plc->NVM.name, module);
- }
- }
- else
-
-#endif
-
- if (LE32TOH (nvm_header.ImageType) == NVM_IMAGE_FIRMWARE)
- {
- if (WriteExecuteFirmware2 (plc, module, &nvm_header))
- {
- return (-1);
- }
- break;
- }
- if (lseek (plc->NVM.file, LE32TOH (nvm_header.NextHeader), SEEK_SET) == -1)
- {
- error (1, errno, "Can't skip module: %s (%d)", plc->NVM.name, module);
- }
- module++;
- }
- while (~nvm_header.NextHeader);
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed BootParameters1 (struct plc * plc)
- *
- * pib.h
- *
- * write the parameter information block to SDRAM on a thunderbolt/
- * lightning powerline device;
- *
- * The PIB is written to different SDRAM locations depending on the
- * chipset used; we use PIB major/minor version to determine where
- * to write the PIB but may switch to using the hardware platform
- * code derived from the VS_SW_VER message;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef BOOTPARAMETERS1_SOURCE
-#define BOOTPARAMETERS1_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../plc/plc.h"
-#include "../pib/pib.h"
-
-signed BootParameters1 (struct plc * plc)
-
-{
- struct pib_header pib_header;
- uint32_t offset;
- if (lseek (plc->PIB.file, 0, SEEK_SET))
- {
- error (PLC_EXIT (plc), errno, FILE_CANTHOME, plc->PIB.name);
- }
- if (read (plc->PIB.file, &pib_header, sizeof (pib_header)) != sizeof (pib_header))
- {
- error (PLC_EXIT (plc), errno, FILE_CANTREAD, plc->PIB.name);
- }
- if (lseek (plc->PIB.file, 0, SEEK_SET))
- {
- error (PLC_EXIT (plc), errno, FILE_CANTHOME, plc->PIB.name);
- }
-
-#if 1
-
-/*
- * this code is a fix to accommodate PIB relocation in memory; it is not needed when
- * the PIB is stored in an NVM file since the memory address is recorded in the image
- * header;
- */
-
- if (BE16TOH (*(uint16_t *)(&pib_header)) < 0x0305)
- {
- offset = LEGACY_PIBOFFSET;
- }
- else if (BE16TOH (*(uint16_t *)(&pib_header)) < 0x0500)
- {
- offset = INT6x00_PIBOFFSET;
- }
- else
- {
- offset = AR7x00_PIBOFFSET;
- }
-
-#endif
-
- if (plc->hardwareID < CHIPSET_AR7400)
- {
- if (WriteMEM (plc, &plc->PIB, 0, offset, LE16TOH (pib_header.PIBLENGTH)))
- {
- return (-1);
- }
- return (0);
- }
- if (WriteExecutePIB (plc, offset, &pib_header))
- {
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed BootParameters2 (struct plc * plc)
- *
- * pib.h
- *
- * write the parameter information block to SDRAM on a panther/
- * lynx powerline device;
- *
- * the parameter information block is stored in an NVM image chain
- * and the image header specifies the memory location;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef BOOTPARAMETERS2_SOURCE
-#define BOOTPARAMETERS2_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../plc/plc.h"
-#include "../pib/pib.h"
-
-signed BootParameters2 (struct plc * plc)
-
-{
- unsigned module = 0;
- struct nvm_header2 nvm_header;
- if (lseek (plc->PIB.file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, plc->PIB.name);
- }
- do
- {
- if (read (plc->PIB.file, &nvm_header, sizeof (nvm_header)) != sizeof (nvm_header))
- {
- error (1, errno, NVM_HDR_CANTREAD, plc->PIB.name, module);
- }
- if (LE16TOH (nvm_header.MajorVersion) != 1)
- {
- error (1, ECANCELED, NVM_HDR_VERSION, plc->PIB.name, module);
- }
- if (LE16TOH (nvm_header.MinorVersion) != 1)
- {
- error (1, ECANCELED, NVM_HDR_VERSION, plc->PIB.name, module);
- }
- if (checksum32 (&nvm_header, sizeof (nvm_header), 0))
- {
- error (1, ECANCELED, NVM_HDR_CHECKSUM, plc->PIB.name, module);
- }
-
-#if 0
-
- if (_allclr (LE16TOH (nvm_header.ExecuteMask), (1 << (plc->hardwareID - 1))))
- {
- if (lseek (plc->PIB.file, LE32TOH (nvm_header.NextHeader), SEEK_SET) == -1)
- {
- error (1, errno, "Can't skip module: %s (%d)", plc->PIB.name, module);
- }
- }
- else
-
-#endif
-
- if (LE32TOH (nvm_header.ImageType) == NVM_IMAGE_PIB)
- {
- if (WriteExecuteParameters2 (plc, module, &nvm_header))
- {
- return (-1);
- }
- break;
- }
- if (lseek (plc->PIB.file, LE32TOH (nvm_header.NextHeader), SEEK_SET) == -1)
- {
- error (1, errno, "Can't skip module: %s (%d)", plc->PIB.name, module);
- }
- module++;
- }
- while (~nvm_header.NextHeader);
- return (0);
-}
-
-#endif
-
-
-
-CMEncrypt(1) Qualcomm Atheros Open Powerline Toolkit CMEncrypt(1)
-
-NAME
- CMEncrypt - Send Encrypted Payload
-
-SYNOPSIS
- CMEncrypt [options] [device] [device] [...]
-
-DESCRIPTION
- Transmit a file over powerline using CM_ENCRYPTED_PAYLOAD messages. This program tests and demonstrates proper (or
- improper) message routing but does not support encrypted transmission. All payloads are sent unencrypted at this time.
-
-OPTIONS
- -A status
- The AVLN Status. This indicates the current association status and capabilities of the sending station. Permit‐
- ted values are 0 through 255 but only value 0 through 5 and 8 are recognized by the firmware. Values may be
- entered in decimal, hexadecimal or binary format. Hexadecimal value are prefixed with "0x" or "0X". Binary val‐
- ues are prefixed with "0b" or "0B". The default is 0.
-
- -f file
- The name of the payload file. File content may be text or binary and forms the payload of one or more messages.
- Payloads are transmitted unencrypted when PID is 4 and PEKS is 15 which is default.
-
- -K PEKS
- The Payload Encryption Key Select. This value indicates the key used to encrypt the payload. Permitted values
- are 0 through 15. Values may be entered in decimal, hexadecimal or binary format. Hexadecimal value are prefixed
- with "0x" or "0X". Binary values are prefixed with "0b" or "0B".. The default is 15 for "No Encryption".
-
- -P PID The Protocol Identifier. This value detemines how the payload is interpreted by powerline devices. Permitted
- values are 0 through 4. The default is 4 for "HLE Protocol".
-
- -v Print incoming and outgoing Ethernet frames in hex dump format on stdout.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The Media Access Control (MAC) address of a remote host, not a powerline device. Addresses are 6 hexadecimal
- octets optionally separated by colon. For example, the addresses "00b052000001", "00:b0:52:00:00:01" and
- "00b052:000001" are all valid and equivalent. For convenience, the symbolic address "local" resolves to
- "00:b0:52:00:00:01" and the symbolic addresses "all" and "broadcast" both resolve to "ff:ff:ff:ff:ff:ff".
-
-INTERNALS
- This program lets the user specify some CM_ENCRYPTED_PAYLOAD fields but not others. The following are fields that the
- user cannot specify. The program automatically computes these values.
-
- PRN The Protocol Run Number. This is a random number used to distinguish between runs having the same protocol. This
- program uses the system time variable.
-
- UUID The Universally Unique Identifier. This program uses the left-most 16 bytes of the SHA256 digest for the payload.
-
-REFERENCES
- Consult the HomePlug AV Specification or Atheros Firmware Technical Reference Manual for more information.
-
-EXAMPLES
- The following example transmits file myfile.txt to host 00:85:73:00:94:01 in unecrypted format because that is the pro‐
- gram default. The remote address is required and refers to the ultimate recipient, not the local device.
-
- # CMEncrypt -f myfile.txt 00:85:73:00:94:01 The next example does the same but specifies the program defaults.
- Observe that operands can be expressed in decimal, binary or hexadecimal format.
-
- # CMEncrypt -f myfile.txt -A 0 -P 0b0100 -K 0x0F 00:85:73:00:94:01
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information is not available. Qualcomm Atheros reserves the right to modify message structure
- or content in future firmware releases without any obligation to notify or compensate users of this program.
-
-SEE ALSO
- None.
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 CMEncrypt(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ChangeIdent (struct plc * plc);
- *
- * plc.h
- *
- * read PIB file header; replace MAC, DAK and NMK; update preferred
- * NID; re-write PIB file header and PIB file checksum; use the MAC,
- * DAK and NMK values stored in struct plc;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef CHANGEIDENT_SOURCE
-#define CHANGEIDENT_SOURCE
-
-#include <unistd.h>
-#include <stdint.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/files.h"
-#include "../key/HPAVKey.h"
-#include "../pib/pib.h"
-
-signed ChangeIdent (struct plc * plc)
-
-{
- struct simple_pib simple_pib;
- memset (&simple_pib, 0, sizeof (simple_pib));
- if (lseek (plc->PIB.file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, plc->PIB.name);
- }
- if (read (plc->PIB.file, &simple_pib, sizeof (simple_pib)) != sizeof (simple_pib))
- {
- error (1, errno, FILE_CANTREAD, plc->PIB.name);
- }
- memcpy (simple_pib.MAC, plc->MAC, sizeof (simple_pib.MAC));
- memcpy (simple_pib.DAK, plc->DAK, sizeof (simple_pib.DAK));
- memcpy (simple_pib.NMK, plc->NMK, sizeof (simple_pib.NMK));
- {
- uint8_t level = simple_pib.PreferredNID [HPAVKEY_NID_LEN-1] >> 4;
- HPAVKeyNID (simple_pib.PreferredNID, simple_pib.NMK, level & 1);
- }
- simple_pib.CHECKSUM = 0;
- if (lseek (plc->PIB.file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, plc->PIB.name);
- }
- if (write (plc->PIB.file, &simple_pib, sizeof (simple_pib)) != sizeof (simple_pib))
- {
- error (1, errno, FILE_CANTSAVE, plc->PIB.name);
- }
- if (lseek (plc->PIB.file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, plc->PIB.name);
- }
- simple_pib.CHECKSUM = fdchecksum32 (plc->PIB.file, LE16TOH (simple_pib.PIBLENGTH), 0);
- if (lseek (plc->PIB.file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, plc->PIB.name);
- }
- if (write (plc->PIB.file, &simple_pib, sizeof (simple_pib)) != sizeof (simple_pib))
- {
- error (1, errno, FILE_CANTSAVE, plc->PIB.name);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void Confirm (struct plc * plc, char const * message);
- *
- * plc.h
- *
- * Inform the user that an operation has completed; print the channel
- * name, frame source address and user message on stdout unless the
- * PLC_SILENCE flag is set;
- *
- * this function is identical to Request () except that it prints the
- * packet source address instead of the template destination address;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef CONFIRM_SOURCE
-#define CONFIRM_SOURCE
-
-#include <stdio.h>
-#include <stdarg.h>
-
-#include "../plc/plc.h"
-#include "../tools/memory.h"
-#include "../tools/flags.h"
-
-#ifdef __GNUC__
-
-__attribute__ ((format (printf, 2, 3)))
-
-#endif
-
-void Confirm (struct plc * plc, char const *format, ...)
-
-{
- if (_allclr (plc->flags, PLC_SILENCE))
- {
- char address [ETHER_ADDR_LEN * 3];
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
- hexdecode (message->ethernet.OSA, sizeof (message->ethernet.OSA), address, sizeof (address));
- fprintf (stderr, "%s %s ", channel->ifname, address);
- if ((format) && (*format))
- {
- va_list arglist;
- va_start (arglist, format);
- vfprintf (stderr, format, arglist);
- va_end (arglist);
- }
- fprintf (stderr, "\n");
- }
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed DeviceIdent (struct plc * plc);
- *
- * plc.h
- *
- * This plugin for program plc reads the first block of a device
- * PIB using VS_RD_MOD and updates the plc structure with device
- * network identity information, including MAC, DAK and NMK;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef DEVICEIDENT_SOURCE
-#define DEVICEIDENT_SOURCE
-
-#include <string.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../tools/memory.h"
-#include "../pib/pib.h"
-
-signed DeviceIdent (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_rd_mod_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MODULEID;
- uint8_t MACCESS;
- uint16_t MLENGTH;
- uint32_t MOFFSET;
- uint8_t MSECRET [16];
- }
- * request = (struct vs_rd_mod_request *) (message);
- struct __packed vs_rd_mod_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t RES [3];
- uint8_t MODULEID;
- uint8_t RESERVED;
- uint16_t MLENGTH;
- uint32_t MOFFSET;
- uint32_t MCHKSUM;
- struct simple_pib IDENT;
- }
- * confirm = (struct vs_rd_mod_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_RD_MOD | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- request->MODULEID = VS_MODULE_PIB;
- request->MLENGTH = HTOLE16 (sizeof (confirm->IDENT));
- request->MOFFSET = 0;
- if (SendMME (plc) <= 0)
- {
- error (1, errno, CHANNEL_CANTSEND);
- }
- while (ReadMME (plc, 0, (VS_RD_MOD | MMTYPE_CNF)) <= 0)
- {
- plc->flags |= PLC_BAILOUT;
- Failure (plc, PLC_NODETECT);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- }
- memcpy (plc->MAC, confirm->IDENT.MAC, sizeof (plc->MAC));
- memcpy (plc->DAK, confirm->IDENT.DAK, sizeof (plc->DAK));
- memcpy (plc->NMK, confirm->IDENT.NMK, sizeof (plc->NMK));
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * Devices.c - device address synonym tables
- *
- * plc.h
- *
- * some device addresses are so common or significant that we give
- * them names; users can enter the name instead of the address; all
- * toolkit programs reference this table via function synonym();
- *
- * function synonym() uses a binary search to lookup symbols and so
- * they must be entered in alphabetical order or lookup errors will
- * occur;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef DEVICES_SOURCE
-#define DEVICES_SOURCE
-
-/*====================================================================*
- * custom include files;
- *--------------------------------------------------------------------*/
-
-#include "../plc/plc.h"
-#include "../mme/mme.h"
-#include "../tools/types.h"
-
-/*====================================================================*
- * variables;
- *--------------------------------------------------------------------*/
-
-struct _term_ const devices [PLCDEVICES] =
-
-{
- {
- "all",
- BROADCAST
- },
- {
- "broadcast",
- BROADCAST
- },
- {
- "local",
- LOCALCAST
- }
-};
-
-uint8_t const broadcast [ETHER_ADDR_LEN] =
-
-{
- 0xFF,
- 0xFF,
- 0xFF,
- 0xFF,
- 0xFF,
- 0xFF
-};
-
-uint8_t const localcast [ETHER_ADDR_LEN] =
-
-{
- 0x00,
- 0xB0,
- 0x52,
- 0x00,
- 0x00,
- 0x01
-};
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void Display (struct plc * plc, char const * message);
- *
- * plc.h
- *
- * Inform the user that an operation suceeded; print channel name,
- * packet source device and user defined message on stdout;
- *
- * This function is identical to Confirm () except that a message
- * is always printed on stdout and cannot be suppressed;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef DISPLAY_SOURCE
-#define DISPLAY_SOURCE
-
-#include <stdio.h>
-#include <stdarg.h>
-
-#include "../plc/plc.h"
-#include "../tools/memory.h"
-
-#ifdef __GNUC__
-
-__attribute__ ((format (printf, 2, 3)))
-
-#endif
-
-void Display (struct plc * plc, char const *format, ...)
-
-{
- char address [ETHER_ADDR_LEN * 3];
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
- hexdecode (message->ethernet.OSA, sizeof (message->ethernet.OSA), address, sizeof (address));
- printf ("%s %s ", channel->ifname, address);
- if ((format) && (*format))
- {
- va_list arglist;
- va_start (arglist, format);
- vprintf (format, arglist);
- va_end (arglist);
- }
- printf ("\n");
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed EthernetHeader (void * memory, const uint8_t peer [], const uint8_t host [], uint16_t protocol);
- *
- * mme.h
- *
- * encode a memory region with a standard Ethernet frame header in
- * network byte order;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef ETHERNETHEADER_SOURCE
-#define ETHERNETHEADER_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../mme/mme.h"
-
-signed EthernetHeader (void * memory, const uint8_t peer [], const uint8_t host [], uint16_t protocol)
-
-{
- struct ether_header * header = (struct ether_header *)(memory);
- memcpy (header->ether_dhost, peer, sizeof (header->ether_dhost));
- memcpy (header->ether_shost, host, sizeof (header->ether_shost));
- header->ether_type = htons (protocol);
- return (sizeof (* header));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ExecuteApplets (struct plc * plc);
- *
- * plc.h
- *
- * call appropriate ExecuteApplets function based on detected NVM
- * file format;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef EXECUTEAPPLETS_SOURCE
-#define EXECUTEAPPLETS_SOURCE
-
-#include "../plc/plc.h"
-
-signed ExecuteApplets (struct plc * plc)
-
-{
- return (NVMSelect (plc, ExecuteApplets1, ExecuteApplets2));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ExecuteApplets1 (struct plc * plc);
- *
- * plc.h
- *
- * download and execute all modules in an older nvm file chain;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef EXECUTEAPPLETS1_SOURCE
-#define EXECUTEAPPLETS1_SOURCE
-
-#include "../tools/flags.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-signed ExecuteApplets1 (struct plc * plc)
-
-{
- unsigned module = 0;
- struct nvm_header1 nvm_header;
- if (lseek (plc->NVM.file, 0, SEEK_SET))
- {
- if (_allclr (plc->flags, PLC_SILENCE))
- {
- error (PLC_EXIT (plc), errno, FILE_CANTHOME, plc->NVM.name);
- }
- return (-1);
- }
- do
- {
- if (read (plc->NVM.file, &nvm_header, sizeof (nvm_header)) != sizeof (nvm_header))
- {
- if (_allclr (plc->flags, PLC_SILENCE))
- {
- error (PLC_EXIT (plc), errno, NVM_HDR_CANTREAD, plc->NVM.name, module);
- }
- return (-1);
- }
- if (LE32TOH (nvm_header.HEADERVERSION) != 0x60000000)
- {
- if (_allclr (plc->flags, PLC_SILENCE))
- {
- error (PLC_EXIT (plc), 0, NVM_HDR_VERSION, plc->NVM.name, module);
- }
- return (-1);
- }
- if (checksum32 (&nvm_header, sizeof (nvm_header), 0))
- {
- if (_allclr (plc->flags, PLC_SILENCE))
- {
- error (PLC_EXIT (plc), 0, NVM_HDR_CHECKSUM, plc->NVM.name, module);
- }
- return (-1);
- }
- if (plc->hardwareID < CHIPSET_AR7400)
- {
- if (WriteFirmware1 (plc, module, &nvm_header))
- {
- return (-1);
- }
- if (StartFirmware1 (plc, module, &nvm_header))
- {
- return (-1);
- }
- }
- else
- {
- if (WriteExecuteFirmware1 (plc, module, &nvm_header))
- {
- return (-1);
- }
- }
- if (_anyset (plc->flags, PLC_QUICK_FLASH))
- {
- break;
- }
- while (!ReadMME (plc, 0, (VS_HOST_ACTION | MMTYPE_IND)));
- module++;
- }
- while (nvm_header.NEXTHEADER);
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ExecuteApplets2 (struct plc * plc);
- *
- * plc.h
- *
- * download and execute all modules in a new nvm image files;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef EXECUTEAPPLETS2_SOURCE
-#define EXECUTEAPPLETS2_SOURCE
-
-#include "../tools/flags.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-signed ExecuteApplets2 (struct plc * plc)
-
-{
- unsigned module = 0;
- struct nvm_header2 nvm_header;
- if (lseek (plc->NVM.file, 0, SEEK_SET))
- {
- if (_allclr (plc->flags, PLC_SILENCE))
- {
- error (PLC_EXIT (plc), errno, FILE_CANTHOME, plc->NVM.name);
- }
- return (-1);
- }
- do
- {
- if (read (plc->NVM.file, &nvm_header, sizeof (nvm_header)) != sizeof (nvm_header))
- {
- if (_allclr (plc->flags, PLC_SILENCE))
- {
- error (PLC_EXIT (plc), errno, NVM_HDR_CANTREAD, plc->NVM.name, module);
- }
- return (-1);
- }
- if (LE16TOH (nvm_header.MajorVersion) != 1)
- {
- if (_allclr (plc->flags, PLC_SILENCE))
- {
- error (PLC_EXIT (plc), 0, NVM_HDR_VERSION, plc->NVM.name, module);
- }
- return (-1);
- }
- if (LE32TOH (nvm_header.MinorVersion) != 1)
- {
- if (_allclr (plc->flags, PLC_SILENCE))
- {
- error (PLC_EXIT (plc), 0, NVM_HDR_VERSION, plc->NVM.name, module);
- }
- return (-1);
- }
- if (checksum32 (&nvm_header, sizeof (nvm_header), 0))
- {
- if (_allclr (plc->flags, PLC_SILENCE))
- {
- error (PLC_EXIT (plc), 0, NVM_HDR_CHECKSUM, plc->NVM.name, module);
- }
- return (-1);
- }
- if (WriteExecuteApplet2 (plc, module, &nvm_header))
- {
- return (-1);
- }
- if (_anyset (plc->flags, PLC_QUICK_FLASH))
- {
- break;
- }
- while (!ReadMME (plc, 0, (VS_HOST_ACTION | MMTYPE_IND)));
- module++;
- }
- while (~nvm_header.NextHeader);
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed FactoryDefaults (struct plc * plc);
- *
- * plc.h
- *
- * This plug-in for program plc restores factory defaults using
- * a VS_FAC_DEFAULTS message;
- *
- *
- * Contributor(s):
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef FACTORYDEFAULTS_SOURCE
-#define FACTORYDEFAULTS_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/memory.h"
-#include "../tools/error.h"
-
-signed FactoryDefaults (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_fac_defaults_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_fac_defaults_request *) (message);
- struct __packed vs_fac_defaults_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- }
- * confirm = (struct vs_fac_defaults_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Restore Factory Defaults");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_FAC_DEFAULTS | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- while (ReadMME (plc, 0, (VS_FAC_DEFAULTS | MMTYPE_CNF)) > 0)
- {
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- continue;
- }
- Confirm (plc, "Restoring ...");
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed FactoryReset (struct plc * plc);
- *
- * plc.h
- *
- * This plug-in for program plc restores factory defaults using
- * a VS_FAC_DEFAULTS message;
- *
- *
- * Contributor(s):
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef FACTORYRESET_SOURCE
-#define FACTORYRESET_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/memory.h"
-#include "../tools/error.h"
-
-signed FactoryReset (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_fac_defaults_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_fac_defaults_request *) (message);
- struct __packed vs_fac_defaults_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- }
- * confirm = (struct vs_fac_defaults_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_FAC_DEFAULTS | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- while (ReadMME (plc, 0, (VS_FAC_DEFAULTS | MMTYPE_CNF)) > 0)
- {
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- continue;
- }
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void Failure (struct plc * plc, char const *format, ...)
- *
- * error.h
- *
- * Inform the user that an operation failed; print the channel name,
- * source device, error message and user defined message on stderr
- * unless the PLC_SILENCE flags is set;
- *
- * This function is similar to Confirm () except that the message
- * status or result code and description is output when the code
- * is non-zero; overtime, result codes have replaced status codes
- * and so we look in different places for codes in some MMEs;
- *
- * the status and result code fields appear at different offsets
- * in different messages; consequently, check the MMTYPE to find
- * field;
- *
- *
- * Contributor(s);
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef FAILURE_SOURCE
-#define FAILURE_SOURCE
-
-#include <stdio.h>
-#include <stdarg.h>
-#include <stdlib.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../tools/memory.h"
-#include "../mme/mme.h"
-
-#ifdef __GNUC__
-
-__attribute__ ((format (printf, 2, 3)))
-
-#endif
-
-void Failure (struct plc * plc, char const *format, ...)
-
-{
- if (_allclr (plc->flags, PLC_SILENCE))
- {
- char address [ETHER_ADDR_LEN * 3];
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
- struct __packed header_confirm
- {
- ethernet_hdr ethernet;
- qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- }
- * header = (struct header_confirm *)(message);
- hexdecode (header->ethernet.OSA, sizeof (header->ethernet.OSA), address, sizeof (address));
- fprintf (stderr, "%s %s ", channel->ifname, address);
- switch (LE16TOH (header->qualcomm.MMTYPE))
- {
- case VS_CONN_ADD | MMTYPE_CNF:
- case VS_CONN_MOD | MMTYPE_CNF:
- case VS_CONN_REL | MMTYPE_CNF:
- case VS_CONN_INFO | MMTYPE_CNF:
- {
- struct __packed header_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint32_t REQUEST;
- uint8_t MSTATUS;
- }
- * header = (struct header_confirm *)(message);
- if (header->MSTATUS)
- {
- fprintf (stderr, "%s (0x%02X): ", MMECode (header->qualcomm.MMTYPE, header->MSTATUS), header->MSTATUS);
- }
- }
- break;
- case VS_SELFTEST_RESULTS | MMTYPE_CNF:
- case VS_FORWARD_CONFIG | MMTYPE_CNF:
- {
- struct __packed header_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MVERSION;
- uint8_t RESULTCODE;
- }
- * header = (struct header_confirm *)(message);
- if (header->RESULTCODE)
- {
- fprintf (stderr, "%s (0x%02X): ", MMECode (header->qualcomm.MMTYPE, header->RESULTCODE), header->RESULTCODE);
- }
- }
- break;
- default:
- if (header->MSTATUS)
- {
- fprintf (stderr, "%s (0x%02X): ", MMECode (header->qualcomm.MMTYPE, header->MSTATUS), header->MSTATUS);
- }
- break;
- }
- if ((format) && (*format))
- {
- va_list arglist;
- va_start (arglist, format);
- vfprintf (stderr, format, arglist);
- va_end (arglist);
- }
- fprintf (stderr, "\n");
- }
- if (_anyset (plc->flags, PLC_BAILOUT))
- {
- if (_allclr (plc->flags, PLC_SILENCE))
- {
- error (1, 0, "Bailing Out!");
- }
- exit (1);
- }
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed FirmwareMessage (void const * memory);
- *
- * mme.h
- *
- * intercept and print Qualcomm Atheros vendor-specific VS_ARPC
- * messages on stdout; this message type is used for diagnostic
- * reporting and should not appear in released firmware;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef FIRMWAREMESSAGE_SOURCE
-#define FIRMWAREMESSAGE_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/memory.h"
-#include "../tools/endian.h"
-#include "../mme/mme.h"
-
-signed FirmwareMessage (void const * memory)
-
-{
- const struct message * message = (const struct message *)(memory);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- static struct qualcomm_hdr header_arpc =
- {
- 0,
- 0,
- {
- 0x00,
- 0xB0,
- 0x52
- }
- };
- struct __packed vs_arpc_indicate
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint16_t RDATALENGTH;
- uint8_t RDATAOFFSET;
- uint8_t RDATA [1];
- }
- * indicate = (struct vs_arpc_indicate *)(message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- header_arpc.MMTYPE = HTOLE16 (VS_ARPC | MMTYPE_IND);
- if (!memcmp (&indicate->qualcomm, &header_arpc, sizeof (header_arpc)))
- {
- ARPCPrint (stderr, &indicate->RDATA [indicate->RDATAOFFSET], LE16TOH (indicate->RDATALENGTH) - indicate->RDATAOFFSET);
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed FlashDevice (struct plc * plc);
- *
- * plc.h
- *
- * wait for device to start; determin chipset type and confirm that
- * firmware is running; call appropriate FlashDevice function based
- * on the PLC device type;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef FLASHDEVICE_SOURCE
-#define FLASHDEVICE_SOURCE
-
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-signed FlashDevice (struct plc * plc)
-
-{
- return (PLCSelect (plc, FlashDevice1, FlashDevice2));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed FlashDevice1 (struct plc * plc);
- *
- * plc.h
- *
- * permanently write parameters and firmware to flash memory using
- * VS_WR_MOD messagesand VS_MOD_NVM messages;
- *
- * paramters and firmware are written to device SDRAM and stored
- * until commited to flash memory;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef FLASHDEVICE1_SOURCE
-#define FLASHDEVICE1_SOURCE
-
-#include "../tools/flags.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-signed FlashDevice1 (struct plc * plc)
-
-{
- if (WritePIB (plc))
- {
- return (-1);
- }
- if (WriteNVM (plc))
- {
- return (-1);
- }
- if (FlashNVM (plc))
- {
- return (-1);
- }
- if (WaitForRestart (plc))
- {
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed FlashDevice2 (struct plc * plc, uint32_t options);
- *
- * plc.h
- *
- * flash a QCA7420 device; force a reset because a reset is not
- * automatic;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef FLASHDEVICE2_SOURCE
-#define FLASHDEVICE2_SOURCE
-
-#include "../plc/plc.h"
-
-signed FlashDevice2 (struct plc * plc, uint32_t options)
-
-{
- char firmware [256];
- if (plc->SFT.file != -1)
- {
- if (FlashSoftloader (plc, options))
- {
- return (-1);
- }
- }
- if ((plc->NVM.file != -1) && (plc->PIB.file != -1))
- {
- if (FlashFirmware (plc, options))
- {
- return (-1);
- }
- }
- else if (plc->PIB.file != -1)
- {
- if (FlashParameters (plc, options))
- {
- return (-1);
- }
- }
- if (ResetDevice (plc))
- {
- return (-1);
- }
- sleep (5);
- if (WaitForStart (plc, firmware, sizeof (firmware)))
- {
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed FlashFirmware (struct plc * plc, uint32_t options);
- *
- * plc.h
- *
- * write powerline parameters and firmware into flash memory using
- * VS_MODULE_OPERATION messages; force flash and do not reset;
- *
- * struct vs_module_spec is defined in plc.h;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef FLASHFIRMWARE_SOURCE
-#define FLASHFIRMWARE_SOURCE
-
-#include "../plc/plc.h"
-
-signed FlashFirmware (struct plc * plc, uint32_t options)
-
-{
- struct vs_module_spec vs_module_spec [] =
- {
- {
- PLC_MODULEID_PARAMETERS,
- 0,
- 0,
- 0
- },
- {
- PLC_MODULEID_FIRMWARE,
- 0,
- 0,
- 0
- }
- };
- ModuleSpec (&plc->PIB, &vs_module_spec [0]);
- ModuleSpec (&plc->NVM, &vs_module_spec [1]);
- if (ModuleSession (plc, (sizeof (vs_module_spec) / sizeof (struct vs_module_spec)), vs_module_spec))
- {
- return (-1);
- }
- if (ModuleWrite (plc, &plc->PIB, 0, &vs_module_spec [0]))
- {
- return (-1);
- }
- if (ModuleWrite (plc, &plc->NVM, 1, &vs_module_spec [1]))
- {
- return (-1);
- }
- if (ModuleCommit (plc, options))
- {
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed FlashMOD (struct channel * channel, uint8_t module);
- *
- * plc.h
- *
- * commit downloaded firmware and/or parameters to NVRAM using a
- * VS_MOD_NVM message; flash-less devices will attempt to upload
- * to the local host since they have no NVRAM; the host must be
- * ready to receive the module;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- * Matthieu Poullet <m.poullet@avm.de>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef FLASHMOD_SOURCE
-#define FLASHMOD_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-
-signed FlashMOD (struct channel * channel, uint8_t module)
-
-{
- struct message message;
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_mod_nvm_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MODULEID;
- }
- * request = (struct vs_mod_nvm_request *) (&message);
- struct __packed vs_mod_nvm_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MODULEID;
- }
- * confirm = (struct vs_mod_nvm_confirm *) (&message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- ssize_t packetsize;
- memset (&message, 0, sizeof (message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_MOD_NVM | MMTYPE_REQ));
- request->MODULEID = module;
- if (sendpacket (channel, &message, (ETHER_MIN_LEN - ETHER_CRC_LEN)) <= 0)
- {
- error (1, errno, CHANNEL_CANTSEND);
- }
- if ((packetsize = readpacket (channel, &message, sizeof (message))) <= 0)
- {
- error (1, errno, CHANNEL_CANTREAD);
- }
- if (UnwantedMessage (&message, packetsize, 0, (VS_MOD_NVM | MMTYPE_CNF)))
- {
- error (1, ECANCELED, PLC_BADFRAME);
- }
- if (confirm->MSTATUS)
- {
- error (1, ECANCELED, PLC_WONTDOIT);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed FlashNVM (struct plc * plc);
- *
- * plc.h
- *
- * commit downloaded firmware and/or parameters to NVRAM using a
- * VS_MOD_NVM message; flash-less devices will attempt to upload
- * to their local host because they have no NVRAM; the host must
- * be prepared to handle this situation;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef FLASHNVM_SOURCE
-#define FLASHNVM_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-
-signed FlashNVM (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_mod_nvm_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MODULEID;
- }
- * request = (struct vs_mod_nvm_request *) (message);
- struct __packed vs_mod_nvm_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MODULEID;
- }
- * confirm = (struct vs_mod_nvm_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Flash device");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_MOD_NVM | MMTYPE_REQ));
- request->MODULEID = plc->module;
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_MOD_NVM | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed FlashParameters (struct plc * plc, uint32_t options);
- *
- * plc.h
- *
- * write runtime powerline parameters into flash memory using
- * VS_MODULE_OPERATION messages;
- *
- * struct vs_module_spec is defined in plc.h;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef FLASHPARAMETERS_SOURCE
-#define FLASHPARAMETERS_SOURCE
-
-#include "../plc/plc.h"
-
-signed FlashParameters (struct plc * plc, uint32_t options)
-
-{
- struct vs_module_spec vs_module_spec =
- {
- PLC_MODULEID_PARAMETERS,
- 0,
- 0,
- 0
- };
- ModuleSpec (&plc->PIB, &vs_module_spec);
- if (ModuleSession (plc, 1, &vs_module_spec))
- {
- return (-1);
- }
- if (ModuleWrite (plc, &plc->PIB, 0, &vs_module_spec))
- {
- return (-1);
- }
- if (ModuleCommit (plc, options))
- {
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed FlashSoftloader (struct plc * plc, uint32_t options);
- *
- * plc.h
- *
- * This plugin upgrades a device having NVRAM; runtime firmware must
- * be running for this to work; NVM and PIB files in struct plc must
- * be opened before calling this plugin; this plugin is used by many
- * programs;
- *
- * This function is for panther/lynx devices although is should also
- * work for AR7400 devices, too.
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef FLASHSOFTLOADER_SOURCE
-#define FLASHSOFTLOADER_SOURCE
-
-#include "../plc/plc.h"
-
-signed FlashSoftloader (struct plc * plc, uint32_t options)
-
-{
- struct vs_module_spec vs_module_spec =
- {
- PLC_MODULEID_SOFTLOADER,
- 0,
- 0,
- 0
- };
- ModuleSpec (&plc->SFT, &vs_module_spec);
- if (ModuleSession (plc, 1, &vs_module_spec))
- {
- return (-1);
- }
- if (ModuleWrite (plc, &plc->SFT, 0, &vs_module_spec))
- {
- return (-1);
- }
- if (ModuleCommit (plc, options))
- {
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed QualcommHeader1 (struct qualcomm_fmi * header, uint8_t MMV, uint16_t MMTYPE, uint16_tFMI);
- *
- * mme.h
- *
- * Encode memory with an Atheros vendor specific message header
- * having HomePlug message protocol version (INTELLON_MMV) and
- * Atheros message type (MMTYPE);
- *
- * return the number of bytes actually encoded or 0 on encode error;
- * the error code is stored in errno;
- *
- * see the INT6000 Firmware Technical Reference Manual for more
- * about MME headers and message types; the Atheros OUI is
- * implicit in this function;
- *
- * MMV is the version number of the MME command set; currently,
- * there is only one command set for Atheros MMEs;
- *
- * MMTYPE indicates the desired Atheros device operation taken
- * from the TRM; some operations are undocumented and should not
- * be used;
- *
- * OUI is the Organizationally Unique Identifier resgistered with
- * the IEEE by the vendor and is a constant for Atheros Devices;
- *
- * There is no need to flush the header since this function writes
- * to all locations unless there is an error; the caller may elect
- * to flush the buffer before calling this function;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef FRAGMENTHEADER_SOURCE
-#define FRAGMENTHEADER_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../tools/endian.h"
-#include "../mme/mme.h"
-
-signed QualcommHeader1 (struct qualcomm_fmi * header, uint8_t MMV, uint16_t MMTYPE)
-
-{
- header->MMV = MMV;
- header->MMTYPE = HTOLE16 (MMTYPE);
- header->FMSN = 0;
- header->FMID = 0;
- header->OUI [0] = 0x00;
- header->OUI [1] = 0xB0;
- header->OUI [2] = 0x52;
- return (sizeof (* header));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed GetProperty (struct plc * plc, struct property * property);
- *
- * plc.h
- *
- * interrogte PLC devices for a property using the VS_GET_PROPERTY
- * message and display the property value on stdout as a series of
- * binary, decimal or hexadecimal bytes or an ASCII string;
- *
- * the current implementation retrieves properties by number, not
- * by name;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef GETPROPERTY_SOURCE
-#define GETPROPERTY_SOURCE
-
-#include <ctype.h>
-#include <stdint.h>
-#include <memory.h>
-
-#include "../tools/error.h"
-#include "../tools/memory.h"
-#include "../tools/number.h"
-#include "../plc/plc.h"
-
-signed GetProperty (struct plc * plc, struct plcproperty * plcproperty)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_get_property_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint32_t COOKIE;
- uint8_t DATA_FORMAT;
- uint8_t PROP_FORMAT;
- uint8_t RESERVED [2];
- uint32_t PROP_VERSION;
- uint32_t PROP_LENGTH;
- uint8_t PROP_NUMBER;
- }
- * request = (struct vs_get_property_request *) (message);
- struct __packed vs_get_property_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint32_t MSTATUS;
- uint32_t COOKIE;
- uint8_t DATA_FORMAT;
- uint8_t RESERVED [3];
- uint32_t DATA_LENGTH;
- uint32_t DATA_BUFFER [1];
- }
- * confirm = (struct vs_get_property_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Get Property");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_GET_PROPERTY | MMTYPE_REQ));
- request->COOKIE = HTOLE32 (plc->cookie);
- request->DATA_FORMAT = plcproperty->DATA_FORMAT;
- request->PROP_FORMAT = plcproperty->PROP_FORMAT;
- request->PROP_VERSION = HTOLE32 (plcproperty->PROP_VERSION);
- request->PROP_LENGTH = HTOLE32 (plcproperty->PROP_LENGTH);
- request->PROP_NUMBER = HTOLE32 (plcproperty->PROP_NUMBER);
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- while (ReadMME (plc, 0, (VS_GET_PROPERTY | MMTYPE_CNF)) > 0)
- {
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- continue;
- }
- if (plcproperty->DATA_FORMAT == PLC_FORMAT_BIN)
- {
- binout (confirm->DATA_BUFFER, confirm->DATA_LENGTH, ' ', '\n', stdout);
- continue;
- }
- if (plcproperty->DATA_FORMAT == PLC_FORMAT_HEX)
- {
- hexout (confirm->DATA_BUFFER, confirm->DATA_LENGTH, ' ', '\n', stdout);
- continue;
- }
- if (plcproperty->DATA_FORMAT == PLC_FORMAT_DEC)
- {
- decout (confirm->DATA_BUFFER, confirm->DATA_LENGTH, ' ', '\n', stdout);
- continue;
- }
- if (plcproperty->DATA_FORMAT == PLC_FORMAT_ASC)
- {
- chrout (confirm->DATA_BUFFER, confirm->DATA_LENGTH, '.', '\n', stdout);
- continue;
- }
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * HPAVKey.h - HomePlug AV key definitions and constants;
- *
- *. Qualcomm Atheros HomePlug AV Powerline Toolkit
- *: Copyright (c) 2009-2013 by Qualcomm Atheros Inc. ALL RIGHTS RESERVED;
- *; For demonstration and evaluation only; Not for production use.
- *
- * Contributor(s);
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef HPAVKEY_HEADER
-#define HPAVKEY_HEADER
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <stdint.h>
-#include <string.h>
-
-/*====================================================================*
- * constants;
- *--------------------------------------------------------------------*/
-
-#define HPAVKEY_CHAR_MIN 0x20
-#define HPAVKEY_CHAR_MAX 0x7E
-#define HPAVKEY_PHRASE_MIN 12
-#define HPAVKEY_PHRASE_MAX 64
-#define HPAVKEY_DIGEST_LEN 32
-#define HPAVKEY_SHA_LEN 32
-#define HPAVKEY_DAK_LEN 16
-#define HPAVKEY_NMK_LEN 16
-#define HPAVKEY_NID_LEN 7
-
-#define HPAVKEY_SHA 0
-#define HPAVKEY_DAK 1
-#define HPAVKEY_NMK 2
-#define HPAVKEY_NID 3
-
-#define HPAVKEY_VERBOSE (1 << 0)
-#define HPAVKEY_SILENCE (1 << 1)
-#define HPAVKEY_ENFORCE (1 << 2)
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-void HPAVKeyNMK (uint8_t NMK [], char const * string);
-void HPAVKeyDAK (uint8_t DAK [], char const * string);
-void HPAVKeyNID (uint8_t NID [], const uint8_t NMK [], uint8_t mode);
-void HPAVKeySHA (uint8_t digest [], char const * string);
-void HPAVKeyOut (const uint8_t digest [], size_t length, char const * phrase, unsigned flags);
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void HPAVKeyDAK (uint8_t DAK [], const char * string);
- *
- * HPAVKey.h
- *
- * compute the HomePlugAV compliant Device Access Key (DAK) for a
- * NUL terminated string; return the key in buffer DAK[]; the key
- * will be HPAVKEY_DAK_LEN bytes as defined in HPAVKey.h;
- *
- * seed the digest then salt the digest then rehash the digest 999
- * times per HomePlug AV Specification;
- *
- *
- * Contributor(s);
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef HPAVKEYDAK_SOURCE
-#define HPAVKEYDAK_SOURCE
-
-#include <memory.h>
-
-#include "../key/HPAVKey.h"
-#include "../key/SHA256.h"
-
-void HPAVKeyDAK (uint8_t DAK [], const char * string)
-
-{
- struct sha256 sha256;
- uint8_t digest [SHA256_DIGEST_LENGTH];
- const uint8_t secret [] =
- {
- 0x08,
- 0x85,
- 0x6D,
- 0xAF,
- 0x7C,
- 0xF5,
- 0x81,
- 0x85
- };
- unsigned rehash = 999;
- SHA256Reset (&sha256);
- SHA256Write (&sha256, string, strlen (string));
- SHA256Write (&sha256, secret, sizeof (secret));
- SHA256Fetch (&sha256, digest);
- while (rehash--)
- {
- SHA256Reset (&sha256);
- SHA256Write (&sha256, digest, sizeof (digest));
- SHA256Fetch (&sha256, digest);
- }
- memcpy (DAK, digest, HPAVKEY_DAK_LEN);
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void HPAVKeyNID (uint8_t NID [], const uint8_t NMK [], signed level);
- *
- * HPAVKey.h
- *
- * compute the HomePlugAV compliant Network Identification Key (NID)
- * for a given Network Membership Key (NMK); return the key in buffer
- * NID []; the key will be HPAVKEY_NID_LEN bytes as defined in
- * HPAVKey.h;
- *
- * unlike the NMK, the NID is 54-bits and includes a 2-bit security
- * level; See the HomePlug AV Specification for more info;
- *
- * hash the NMK then rehash the digest 4 times per HomePlug AV
- * Specification; no salt is used;
- *
- *
- * Contributor(s);
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef HPAVKEYNID_SOURCE
-#define HPAVKEYNID_SOURCE
-
-#include <memory.h>
-
-#include "../key/HPAVKey.h"
-#include "../key/SHA256.h"
-
-void HPAVKeyNID (uint8_t NID [], const uint8_t NMK [], uint8_t level)
-
-{
- struct sha256 sha256;
- uint8_t digest [SHA256_DIGEST_LENGTH];
- unsigned rehash = 4;
- SHA256Reset (&sha256);
- SHA256Write (&sha256, NMK, HPAVKEY_NMK_LEN);
- SHA256Fetch (&sha256, digest);
- while (rehash--)
- {
- SHA256Reset (&sha256);
- SHA256Write (&sha256, digest, sizeof (digest));
- SHA256Fetch (&sha256, digest);
- }
-
-#if 1
-
- level <<= 4;
- digest [HPAVKEY_NID_LEN - 1] >>= 4;
- digest [HPAVKEY_NID_LEN - 1] |= level;
-
-#else
-
- digest [HPAVKEY_NID_LEN - 1] &= ~0xC0;
- digest [HPAVKEY_NID_LEN - 1] |= level << 6;
-
-#endif
-
- memcpy (NID, digest, HPAVKEY_NID_LEN);
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void HPAVKeyNMK (uint8_t NMK [], const char * string);
- *
- * HPAVKey.h
- *
- * compute the HomePlugAV compliant Network Membership Key (NMK)
- * for a NUL terminated string; return the key in buffer NMK [];
- * the key will be HPAVKEY_NMK_LEN bytes as defined in HPAVKey.h;
- *
- * seed the digest then salt the digest then rehash the digest 999
- * times per HomePlug AV Specification;
- *
- *
- * Contributor(s);
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef HPAVKEYNMK_SOURCE
-#define HPAVKEYNMK_SOURCE
-
-#include <memory.h>
-
-#include "../key/HPAVKey.h"
-#include "../key/SHA256.h"
-
-void HPAVKeyNMK (uint8_t NMK [], const char * string)
-
-{
- struct sha256 sha256;
- uint8_t digest [SHA256_DIGEST_LENGTH];
- const uint8_t secret [] =
- {
- 0x08,
- 0x85,
- 0x6D,
- 0xAF,
- 0x7C,
- 0xF5,
- 0x81,
- 0x86
- };
- unsigned rehash = 999;
- SHA256Reset (&sha256);
- SHA256Write (&sha256, string, strlen (string));
- SHA256Write (&sha256, secret, sizeof (secret));
- SHA256Fetch (&sha256, digest);
- while (rehash--)
- {
- SHA256Reset (&sha256);
- SHA256Write (&sha256, digest, sizeof (digest));
- SHA256Fetch (&sha256, digest);
- }
- memcpy (NMK, digest, HPAVKEY_NMK_LEN);
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void HPAVKeyOut (byte digest [], size_t length, const char * phrase, flag_t flags);
- *
- * HPAVKey.h
- *
- * print a digest in hexadecimal format on stdout; also print the
- * phrase after the digest if the HPAVKEY_VERBOSE flag bit is set;
- *
- *
- * Contributor(s);
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef HPAVKEYOUT_SOURCE
-#define HPAVKEYOUT_SOURCE
-
-#include <stdio.h>
-
-#include "../key/HPAVKey.h"
-#include "../tools/memory.h"
-#include "../tools/number.h"
-#include "../tools/types.h"
-#include "../tools/flags.h"
-
-void HPAVKeyOut (const uint8_t digest [], size_t length, const char * phrase, flag_t flags)
-
-{
- hexout (digest, length, 0, 0, stdout);
- if (_anyset (flags, HPAVKEY_VERBOSE))
- {
- printf (" %s", phrase);
- }
- printf ("\n");
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void HPAVKeySHA (uint8_t digest [], const char * string);
- *
- * HPAVKey.h
- *
- * compute the SHA256 digest for a NUL terminated string; the
- * will always 256 bits (32 bytes) long for any string length;
- *
- *
- * Contributor(s);
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef HPAVKEYSHA_SOURCE
-#define HPAVKEYSHA_SOURCE
-
-#include "../key/HPAVKey.h"
-#include "../key/SHA256.h"
-
-void HPAVKeySHA (uint8_t digest [], const char * string)
-
-{
- struct sha256 sha256;
- SHA256Reset (&sha256);
- SHA256Write (&sha256, string, strlen (string));
- SHA256Fetch (&sha256, digest);
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void HPAVKeySpec (const char * string);
- *
- * HPAVKey.h
- *
- * confirm that a string is a legal HomePlug AV pass phrase; return
- * on success; exit the program on failure; legal pass phrases have
- * 12 to 64 characters ranging from 0x20 thru 0x7F;
- *
- * this function is intended to check pass phrases entered from the
- * command line as arguments therefore it explains why it failed;
- *
- *
- * Contributor(s);
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef HPAVKEYSPEC_SOURCE
-#define HPAVKEYSPEC_SOURCE
-
-#include <ctype.h>
-
-#include "../tools/error.h"
-#include "../key/HPAVKey.h"
-
-void HPAVKeySpec (const char * string)
-
-{
- const char * sp = string;
- while (isprint (*sp))
- {
- sp++;
- }
- if (*sp)
- {
- error (1, ENOTSUP, "Phrase \"%s\" has illegal characters", string);
- }
- if ((sp - string) < HPAVKEY_PHRASE_MIN)
- {
- error (1, ENOTSUP, "Phrase \"%s\" less than %d characters", string, HPAVKEY_PHRASE_MIN);
- }
- if ((sp - string) > HPAVKEY_PHRASE_MAX)
- {
- error (1, ENOTSUP, "Phrase \"%s\" more than %d characters", string, HPAVKEY_PHRASE_MAX);
- }
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed HomePlugHeader (struct homeplug_hdr * header, uint8_t MMV, uint16_t MMTYPE);
- *
- * mme.h
- *
- * encode memory with a standard HomePlug AV header having HomePlug
- * protocol version (HOMEPLUG_MMV) and HomePlug message type (MMTYPE);
- * return the number of bytes actually encoded;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef HOMEPLUGHEADER_SOURCE
-#define HOMEPLUGHEADER_SOURCE
-
-#include <stdint.h>
-
-#include "../mme/mme.h"
-#include "../tools/endian.h"
-
-signed HomePlugHeader (struct homeplug_hdr * header, uint8_t MMV, uint16_t MMTYPE)
-
-{
- header->MMV = MMV;
- header->MMTYPE = HTOLE16 (MMTYPE);
- return (sizeof (* header));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed HomePlugHeader1 (struct homeplug_fmi * header, uint8_t MMV, uint16_t MMTYPE);
- *
- * mme.h
- *
- * encode memory with a standard HomePlug AV header having HomePlug
- * protocol version (HOMEPLUG_MMV) and HomePlug message type (MMTYPE);
- * return the number of bytes actually encoded;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef HOMEPLUGHEADER1_SOURCE
-#define HOMEPLUGHEADER1_SOURCE
-
-#include <stdint.h>
-
-#include "../mme/mme.h"
-#include "../tools/endian.h"
-
-signed HomePlugHeader1 (struct homeplug_fmi * header, uint8_t MMV, uint16_t MMTYPE)
-
-{
- header->MMV = MMV;
- header->MMTYPE = HTOLE16 (MMTYPE);
- header->FMSN = 0;
- header->FMID = 0;
- return (sizeof (* header));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed HostActionIndicate (struct plc * plc);
- *
- * plc.h
- *
- * This test plugin requests come action from a local host using a
- * VS_HOST_ACTION indication message; the message must be sent to a
- * host, not a device; it can be used to verify that your host
- * application correctly responds to device requests;
- *
- * this function is provided so that you can emulate a device boot
- * sequence by prompting a listening host to download firmware; it
- * has no practical purpose other than development and test;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef HOSTACTIONINDICATE_SOURCE
-#define HOSTACTIONINDICATE_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-
-signed HostActionIndicate (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#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);
- struct __packed vs_host_action_rsp
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- }
- * response = (struct vs_host_action_rsp *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Start Host Action");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&indicate->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&indicate->qualcomm, 0, (VS_HOST_ACTION | MMTYPE_IND));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- indicate->MACTION = plc->action;
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- while (ReadMME (plc, 0, (VS_HOST_ACTION | MMTYPE_RSP)) > 0)
- {
- if (response->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- continue;
- }
- Confirm (plc, "Start.");
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * int HostActionResponse (struct plc * plc);
- *
- * plc.h
- *
- * respond to a VS_HOST_ACTION.IND message sent from a device to
- * the local host using a VS_HOST_ACTION.RSP message; this tells
- * the bootloader to stop sending VS_HOST_ACTION.IND messages;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef HOSTACTIONRESPONSE_SOURCE
-#define HOSTACTIONRESPONSE_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-
-signed HostActionResponse (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_host_action_rsp
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- }
- * response = (struct vs_host_action_rsp *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- memset (message, 0, sizeof (* message));
- EthernetHeader (&response->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&response->qualcomm, 0, (VS_HOST_ACTION | MMTYPE_RSP));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed Identity (struct plc * plc);
- *
- * plc.h
- *
- * select the appropriate function based on the device type;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef IDENTITY_SOURCE
-#define IDENTITY_SOURCE
-
-#include "../plc/plc.h"
-
-signed Identity (struct plc * plc)
-
-{
- return (PLCSelect (plc, Identity1, Identity2));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed Identity1 (struct plc * plc);
- *
- * plc.h
- *
- * Read the first block of the PIB image from a powerline device
- * using VA_RD_MOD; print identity information on stdout;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef IDENTITY1_SOURCE
-#define IDENTITY1_SOURCE
-
-#include <string.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-#include "../pib/pib.h"
-
-signed Identity1 (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_rd_mod_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MODULEID;
- uint8_t MACCESS;
- uint16_t MLENGTH;
- uint32_t MOFFSET;
- uint8_t MSECRET [16];
- }
- * request = (struct vs_rd_mod_request *) (message);
- struct __packed vs_rd_mod_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t RES [3];
- uint8_t MODULEID;
- uint8_t RESERVED;
- uint16_t MLENGTH;
- uint32_t MOFFSET;
- uint32_t MCHKSUM;
- uint8_t BUFFER [PLC_RECORD_SIZE];
- }
- * confirm = (struct vs_rd_mod_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Device Identity");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_RD_MOD | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- request->MODULEID = VS_MODULE_PIB;
- request->MLENGTH = HTOLE16 (sizeof (confirm->BUFFER));
- request->MOFFSET = HTOLE32 (0);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- while (ReadMME (plc, 0, (VS_RD_MOD | MMTYPE_CNF)) > 0)
- {
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- continue;
- }
- Confirm (plc, "-------");
- pibpeek1 (confirm->BUFFER);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed InitDevice (struct plc * plc);
- *
- * plc.h
- *
- * call appropriate function based on image file format;
- *
- * initialize powerline device memory before writing and starting
- * runtime parameters and firmare; each generation of device has
- * a different memory type; newer devices store memory parameters
- * and configuration programs in an image file;
- *
- * this implementation handles both old and new image file formats;
- * call InitDevice1 or InitDevice2 directly if you know which file
- * format will be used;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef INITMEMORY_SOURCE
-#define INITMEMORY_SOURCE
-
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-signed InitDevice (struct plc * plc)
-
-{
- return (NVMSelect (plc, InitDevice1, InitDevice2));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * int InitDevice1 (struct plc * plc);
- *
- * plc.h
- *
- * configure volatile memory by finding the memctl applet in an
- * older .nvm file then downloading it and executing it;
- *
- * this implementation detects chipsets prior to INT6400 and uses
- * VS_WR_MEM/VS_ST_MAC messages instead of VS_WRITE_AND_EXECUTE
- * messages;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef INITDEVICE1_SOURCE
-#define INITDEVICE1_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/memory.h"
-#include "../tools/files.h"
-#include "../tools/flags.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-#include "../nvm/nvm.h"
-
-int InitDevice1 (struct plc * plc)
-
-{
- unsigned module = 0;
- struct nvm_header1 nvm_header;
- if (lseek (plc->NVM.file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, plc->NVM.name);
- }
- do
- {
- if (read (plc->NVM.file, &nvm_header, sizeof (nvm_header)) != sizeof (nvm_header))
- {
- error (1, errno, NVM_HDR_CANTREAD, plc->NVM.name, module);
- }
- if (LE32TOH (nvm_header.HEADERVERSION) != 0x60000000)
- {
- error (1, 0, NVM_HDR_VERSION, plc->NVM.name, module);
- }
- if (checksum32 (&nvm_header, sizeof (nvm_header), 0))
- {
- error (1, 0, NVM_HDR_CHECKSUM, plc->NVM.name, module);
- }
-
-#if 0
-
- if (_anyset (LE16TOH (nvm_header.IGNOREMASK), (1 << (plc->hardwareID - 1))))
- {
- if (lseek (plc->NVM.file, LE32TOH (nvm_header.NEXTHEADER), SEEK_SET) == -1)
- {
- error (1, errno, "Can't skip module: %s (%d)", plc->NVM.name, module);
- }
- }
- else
-
-#endif
-
- if (nvm_header.IMAGETYPE == NVM_IMAGE_MEMCTL)
- {
- if (plc->hardwareID < CHIPSET_AR7400)
- {
- if (WriteFirmware1 (plc, module, &nvm_header))
- {
- return (-1);
- }
- if (StartFirmware1 (plc, module, &nvm_header))
- {
- return (-1);
- }
- break;
- }
- WriteExecuteFirmware1 (plc, module, &nvm_header);
- break;
- }
- if (lseek (plc->NVM.file, LE32TOH (nvm_header.NEXTHEADER), SEEK_SET) == -1)
- {
- error (1, errno, "Can't skip module: %s (%d)", plc->NVM.name, module);
- }
- module++;
- }
- while (nvm_header.NEXTHEADER);
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * int InitDevice2 (struct plc * plc);
- *
- * plc.h
- *
- * configure volatile memory by finding the memctl applet in a
- * newer .nvm file then downloading it and executing it;
- *
- * this implementation detects chipsets prior to INT6400 and uses
- * VS_WR_MEM/VS_ST_MAC messages instead of VS_WRITE_AND_EXECUTE
- * messages;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef INITMEMORY2_SOURCE
-#define INITMEMORY2_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/memory.h"
-#include "../tools/files.h"
-#include "../tools/flags.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-#include "../nvm/nvm.h"
-
-int InitDevice2 (struct plc * plc)
-
-{
- unsigned module = 0;
- struct nvm_header2 nvm_header;
- if (lseek (plc->NVM.file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, plc->NVM.name);
- }
- do
- {
- if (read (plc->NVM.file, &nvm_header, sizeof (nvm_header)) != sizeof (nvm_header))
- {
- error (1, errno, NVM_HDR_CANTREAD, plc->NVM.name, module);
- }
- if (LE16TOH (nvm_header.MajorVersion) != 1)
- {
- error (1, 0, NVM_HDR_VERSION, plc->NVM.name, module);
- }
- if (LE16TOH (nvm_header.MinorVersion) != 1)
- {
- error (1, 0, NVM_HDR_VERSION, plc->NVM.name, module);
- }
- if (checksum32 (&nvm_header, sizeof (nvm_header), 0))
- {
- error (1, 0, NVM_HDR_CHECKSUM, plc->NVM.name, module);
- }
-
-#if 0
-
- if (_allclr (LE16TOH (nvm_header.ExecuteMask), (1 << (plc->hardwareID - 1))))
- {
- if (lseek (plc->NVM.file, LE32TOH (nvm_header.NextHeader), SEEK_SET) == -1)
- {
- error (1, errno, "Can't skip module: %s (%d)", plc->NVM.name, module);
- }
- }
- else
-
-#endif
-
- if (LE32TOH (nvm_header.ImageType) == NVM_IMAGE_MEMCTL)
- {
- if (WriteExecuteFirmware2 (plc, module, &nvm_header))
- {
- return (-1);
- }
- break;
- }
- if (lseek (plc->NVM.file, LE32TOH (nvm_header.NextHeader), SEEK_SET) == -1)
- {
- error (1, errno, "Can't skip module: %s (%d)", plc->NVM.name, module);
- }
- module++;
- }
- while (~nvm_header.NextHeader);
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed VersionInfo (struct plc * plc);
- *
- * plc.h
- *
- * read hardware and software version information from an INT6x00
- * using a VS_SW_VER Request Message;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef LINKSTATUS_SOURCE
-#define LINKSTATUS_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../tools/error.h"
-#include "../tools/memory.h"
-#include "../tools/symbol.h"
-#include "../plc/plc.h"
-
-signed LinkStatus (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_link_status_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_link_status_request *) (message);
- struct __packed vs_link_status_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t LINKSTATUS;
- }
- * confirm = (struct vs_link_status_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Request Version Information");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_PL_LINK_STATUS | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- while (ReadMME (plc, 0, (VS_PL_LINK_STATUS | MMTYPE_CNF)) > 0)
- {
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- continue;
- }
- Display (plc, "%d", confirm->LINKSTATUS);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ListLocalDevices (struct plc * plc, char const * space, char const * comma);
- *
- * plc.h
- *
- * print local device hardware addresses on stdout;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Matthieu Poullet <m.poullet@avm.de>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef LISTLOCALDEVICES_SOURCE
-#define LISTLOCALDEVICES_SOURCE
-
-#include "../tools/number.h"
-#include "../plc/plc.h"
-
-signed ListLocalDevices (struct plc * plc, char const * space, char const * comma)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
- ssize_t packetsize;
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_sw_ver_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_sw_ver_request *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SW_VER | MMTYPE_REQ));
- if (sendpacket (channel, message, (ETHER_MIN_LEN - ETHER_CRC_LEN)) <= 0)
- {
- return (-1);
- }
- while ((packetsize = readpacket (channel, message, sizeof (* message))) > 0)
- {
- if (UnwantedMessage (message, packetsize, 0, (VS_SW_VER | MMTYPE_CNF)))
- {
- continue;
- }
- hexout (request->ethernet.OSA, sizeof (request->ethernet.OSA), HEX_EXTENDER, 0, stdout);
- if ((space) && (*space))
- {
- printf ("%s", space);
- }
- }
- if ((comma) && (* comma))
- {
- printf ("%s", comma);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ListRemoteDevices (struct channel * channel, char const * space);
- *
- * print the neighbor device list on stdout;
- *
- *
- *--------------------------------------------------------------------*/
-
-#ifndef LISTREMOTEDEVICES_SOURCE
-#define LISTREMOTEDEVICES_SOURCE
-
-#include "../plc/plc.h"
-
-signed ListRemoteDevices (struct plc * plc, char const * space, char const * comma)
-
-{
- return ((plc->hardwareID < CHIPSET_AR7400)? ListRemoteDevices1 (plc, space, comma): ListRemoteDevices2 (plc, space, comma));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed LocalDeviceList (struct plc * plc, char const * space, char const * comma);
- *
- * plc.h
- *
- * print local device hardware addresses on stdout;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Matthieu Poullet <m.poullet@avm.de>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef LOCALDEVICELIST_SOURCE
-#define LOCALDEVICELIST_SOURCE
-
-#include "../tools/number.h"
-#include "../plc/plc.h"
-
-signed LocalDeviceList (struct plc * plc, char const * space, char const * comma)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
- ssize_t packetsize;
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_sw_ver_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_sw_ver_request *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SW_VER | MMTYPE_REQ));
- if (sendpacket (channel, message, (ETHER_MIN_LEN - ETHER_CRC_LEN)) <= 0)
- {
- return (-1);
- }
- while ((packetsize = readpacket (channel, message, sizeof (* message))) > 0)
- {
- if (UnwantedMessage (message, packetsize, 0, (VS_SW_VER | MMTYPE_CNF)))
- {
- continue;
- }
- hexout (request->ethernet.OSA, sizeof (request->ethernet.OSA), HEX_EXTENDER, 0, stdout);
- if ((space) && (*space))
- {
- printf ("%s", space);
- }
- }
- if ((comma) && (* comma))
- {
- printf ("%s", comma);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * unsigned LocalDevices (struct channel * channel, struct message * message, void * memory, size_t extent);
- *
- * plc.h
- *
- * populate a memory region with consecutive Ethernet addresses;
- * the addresses belong to Atheros powerline devices connected to
- * the host interface specified in struct channel; each bridge may
- * be connected to one or more HomePlug AV devices via powerline;
- *
- * each powerline bridge normally belongs to a different powerline
- * network but is is possible for multiple bridges to belong to the
- * same powerline network thus leading to confusing configurations;
- *
- * use function NetworkDevices() to discover all devices on each
- * powerline network;
- *
- * although this function accepts a channel structure, it ignores
- * the channel peer address and sends a VS_SW_VER request message
- * to the Local Management Address; this causes all local devices
- * to respond; the list is a collection of source addresses taken
- * from all responses;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Matthieu Poullet <m.poullet@avm.de>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NETWORKBRIDGES_SOURCE
-#define NETWORKBRIDGES_SOURCE
-
-#include <memory.h>
-#include <errno.h>
-
-#include "../plc/plc.h"
-#include "../ether/channel.h"
-#include "../tools/types.h"
-#include "../tools/error.h"
-
-unsigned LocalDevices (struct channel const * channel, struct message * message, void * memory, size_t extent)
-
-{
- extern const byte localcast [ETHER_ADDR_LEN];
- struct vs_sw_ver_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_sw_ver_request *)(message);
- uint8_t * origin = (uint8_t *)(memory);
- uint8_t * offset = (uint8_t *)(memory);
- ssize_t packetsize;
- memset (memory, 0, extent);
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, localcast, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SW_VER | MMTYPE_REQ));
- if (sendpacket (channel, message, (ETHER_MIN_LEN - ETHER_CRC_LEN)) <= 0)
- {
- return (0);
- }
- while ((packetsize = readpacket (channel, message, sizeof (* message))) > 0)
- {
- if (UnwantedMessage (message, packetsize, 0, (VS_SW_VER | MMTYPE_CNF)))
- {
- continue;
- }
- if (extent >= sizeof (message->ethernet.OSA))
- {
- memcpy (offset, message->ethernet.OSA, sizeof (message->ethernet.OSA));
- offset += sizeof (message->ethernet.OSA);
- extent -= sizeof (message->ethernet.OSA);
- }
- }
- return ((unsigned)(offset - origin) / ETHER_ADDR_LEN);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * char const * MMEMode (uint16_t MMTYPE);
- *
- * mme.h
- *
- * Return the mneumoic associates with a HomePlug AV MME mode; All
- * HomePlug AV message types permit four variants, as follows, but
- * not all messages implement all four.
- *
- * REQ unsolicited request from host to device;
- * CNF solicited response from device to host;
- * IND unsolicited request from device to host;
- * RSP solicited responds from host to device;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef MMEMODE_SOURCE
-#define MMEMODE_SOURCE
-
-#include <stdint.h>
-
-#include "../mme/mme.h"
-
-static char const * mme_modes [] =
-
-{
- "REQ",
- "CNF",
- "IND",
- "RSP"
-};
-
-char const *MMEMode (uint16_t MMTYPE)
-
-{
- return (mme_modes [MMTYPE & MMTYPE_MODE]);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed MakeRule (struct plc * plc, struct rule * rule);
- *
- * plc.h
- *
- * This plugin for program plcrule adds or removes a temporary
- * or permanent network classification rule to a device using a
- * VS_CLASSIFICATION message;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef MAKERULE_SOURCE
-#define MAKERULE_SOURCE
-
-#include "../tools/error.h"
-
-#include "../plc/rules.h"
-#include "../plc/plc.h"
-
-signed MakeRule (struct plc * plc, struct MMERule * rule)
-
-{
- struct channel * channel = (struct channel *) (plc->channel);
- struct message * message = (struct message *) (plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_classification_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- struct MMERule rule;
- }
- * request = (struct vs_classification_request *) (message);
- struct __packed vs_classification_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- }
- * confirm = (struct vs_classification_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Set MakeRules Rules");
- memset (message, 0, sizeof (* message));
- EthernetHeader (& request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (& request->qualcomm, 0, (VS_CLASSIFICATION | MMTYPE_REQ));
- plc->packetsize = sizeof (struct vs_classification_request);
- memcpy (& request->rule, rule, sizeof (request->rule));
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_CLASSIFICATION | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- Confirm (plc, "Setting ...");
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ModuleCommit (struct plc * plc, uint32_t options);
- *
- * commit previously downloaded modules to NVM; this action closes
- * the current module download session; the timer is temporarily
- * set to 10 seconds so that the operation can complete;
- *
- *
- *--------------------------------------------------------------------*/
-
-#ifndef MODULECOMMIT_SOURCE
-#define MODULECOMMIT_SOURCE
-
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-signed ModuleCommit (struct plc * plc, uint32_t options)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_module_operation_commit_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint32_t RESERVED;
- uint8_t NUM_OP_DATA;
- struct __packed
- {
- uint16_t MOD_OP;
- uint16_t MOD_OP_DATA_LEN;
- uint32_t MOD_OP_RSVD;
- uint32_t MOD_OP_SESSION_ID;
- uint32_t COMMIT_CODE;
- }
- request;
- uint8_t RSVD [20];
- }
- * request = (struct vs_module_operation_commit_request *)(message);
- struct __packed vs_module_operation_commit_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint16_t MSTATUS;
- uint16_t ERR_REC_CODE;
- uint32_t RESERVED1;
- uint8_t NUM_OP_DATA;
- struct __packed
- {
- uint16_t MOD_OP;
- uint16_t MOD_OP_DATA_LEN;
- uint32_t MOD_OP_RSVD;
- uint32_t MOD_OP_SESSION_ID;
- uint32_t COMMIT_CODE;
- uint8_t NUM_MODULES;
- }
- request;
- struct __packed
- {
- uint16_t MOD_STATUS;
- uint16_t ERR_REC_CODE;
- }
- MOD_OP_DATA [1];
- }
- * confirm = (struct vs_module_operation_commit_confirm *)(message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- unsigned timer = channel->timeout;
- Request (plc, "Close Session");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_MODULE_OPERATION | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- request->NUM_OP_DATA = 1;
- request->request.MOD_OP = HTOLE16 (PLC_MOD_OP_CLOSE_SESSION);
- request->request.MOD_OP_DATA_LEN = HTOLE16 (sizeof (request->request) + sizeof (request->RSVD));
- request->request.MOD_OP_SESSION_ID = HTOLE32 (plc->cookie);
- request->request.COMMIT_CODE = HTOLE32 (options);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- channel->timeout = PLC_MODULE_WRITE_TIMEOUT;
- if (ReadMME (plc, 0, (VS_MODULE_OPERATION | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- channel->timeout = timer;
- return (-1);
- }
- channel->timeout = timer;
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ModuleSpec (struct _file_ * module, struct vs_module_spec * vs_module_spec);
- *
- * plc.h
- *
- * compute file length and checksum for module operation functions;
- * struct vs_module_spec is defined in plc.h;
- *
- *
- *--------------------------------------------------------------------*/
-
-#ifndef MODULESPEC_SOURCE
-#define MODULESPEC_SOURCE
-
-#include "../tools/error.h"
-#include "../tools/files.h"
-#include "../plc/plc.h"
-
-signed ModuleSpec (struct _file_ * file, struct vs_module_spec * spec)
-
-{
- off_t length;
- if ((length = lseek (file->file, 0, SEEK_END)) == -1)
- {
- error (1, errno, FILE_CANTSIZE, file->name);
- }
-
-#if 1
-
- if (length % sizeof (uint32_t))
- {
- error (1, ENOTSUP, "%s not multiple of " SIZE_T_SPEC " bytes", file->name, sizeof (uint32_t));
- }
-
-#endif
-
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- spec->MODULE_LENGTH = length;
- spec->MODULE_CHKSUM = fdchecksum32 (file->file, length, 0);
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed NVMSelect (struct plc * plc, signed old (struct plc *), signed new (struct plc *));
- *
- * plc.h
- *
- * read the .nvm header to determine file format; rewind the file
- * then call the right function to execute the applets;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NVMSELECT_SOURCE
-#define NVMSELECT_SOURCE
-
-#include "../tools/error.h"
-#include "../tools/files.h"
-#include "../plc/plc.h"
-
-signed NVMSelect (struct plc * plc, signed old (struct plc *), signed new (struct plc *))
-
-{
- uint32_t version;
- if (lseek (plc->NVM.file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, plc->NVM.name);
- }
- if (read (plc->NVM.file, &version, sizeof (version)) != sizeof (version))
- {
- error (1, errno, FILE_CANTREAD, plc->NVM.name);
- }
- if (lseek (plc->NVM.file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, plc->NVM.name);
- }
- return (LE32TOH (version) == 0x60000000? old (plc): new (plc));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed NVRAMInfo (struct plc * plc);
- *
- * plc.h
- *
- * This plugin for program plc requests a device NVRAM parameter
- * block using a VS_GET_NVM message; the information is displayed
- * and can be used to determine the flash memory characteristics
- * before downloading firmware;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NVRAMINFO_SOURCE
-#define NVRAMINFO_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-#include "../tools/symbol.h"
-#include "../ram/nvram.h"
-
-signed NVRAMInfo (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_get_nvm_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_get_nvm_request *) (message);
- struct __packed vs_get_nvm_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- struct config_nvram config_nvram;
- }
- * confirm = (struct vs_get_nvm_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- struct config_nvram * config_nvram = (struct config_nvram *)(&confirm->config_nvram);
- Request (plc, "Fetch NVRAM Configuration");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_GET_NVM | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- while (ReadMME (plc, 0, (VS_GET_NVM | MMTYPE_CNF)) > 0)
- {
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- continue;
- }
- Display (plc, "TYPE=0x%02X (%s) PAGE=0x%04X (%d) BLOCK=0x%04X (%d) SIZE=0x%04X (%d)", LE32TOH (config_nvram->NVRAMTYPE), NVRAMName (LE32TOH (config_nvram->NVRAMTYPE)), LE32TOH (config_nvram->NVRAMPAGE), LE32TOH (config_nvram->NVRAMPAGE), LE32TOH (config_nvram->NVRAMBLOCK), LE32TOH (config_nvram->NVRAMBLOCK), LE32TOH (config_nvram->NVRAMSIZE), LE32TOH (config_nvram->NVRAMSIZE));
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed NetInfo (struct plc * plc);
- *
- * plc.h
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NETINFO_SOURCE
-#define NETINFO_SOURCE
-
-#include "../plc/plc.h"
-
-signed NetInfo (struct plc * plc)
-
-{
- return (PLCSelect (plc, NetInfo1, NetInfo2));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed NetworkDevices (struct plc * plc, void * memory, size_t extent);
- *
- * plc.h
- *
- * return a list powerline network device addresses on a powerline
- * network; the list consists of a known device plus all others on
- * the same powerline network; the device is defined by the channel
- * peer address and appears first in the list;
- *
- * the device address must be explicit; it cannot be the broadcast
- * or localcast address;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NETWORKDEVICES_SOURCE
-#define NETWORKDEVICES_SOURCE
-
-#include "../plc/plc.h"
-
-signed NetworkDevices (struct plc * plc, void * memory, size_t extent)
-
-{
- return ((plc->hardwareID < CHIPSET_AR7400)? NetworkDevices1 (plc, memory, extent): NetworkDevices2 (plc, memory, extent));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed NetworkInformation (struct plc * plc);
- *
- * plc.h
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NETWORKINFORMATION_SOURCE
-#define NETWORKINFORMATION_SOURCE
-
-#include "../plc/plc.h"
-
-signed NetworkInformation (struct plc * plc)
-
-{
- return (PLCSelect (plc, NetworkInformation1, NetworkInformation2));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed NetworkTraffic (struct plc * plc);
- *
- * plc.h
- *
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NETWORKTRAFFIC_SOURCE
-#define NETWORKTRAFFIC_SOURCE
-
-#include "../plc/plc.h"
-
-signed NetworkTraffic (struct plc * plc)
-
-{
- return ((plc->hardwareID < CHIPSET_AR7400)? NetworkTraffic1 (plc): NetworkTraffic2 (plc));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed PLCNetworkInfo (struct plc * plc)
- *
- * Request network membership information from the peer device using
- * the VS_NW_INFO message;
- *
- * This function is similar to function NetworkInformation() but the
- * output format is different;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PLCNETWORKINFO_SOURCE
-#define PLCNETWORKINFO_SOURCE
-
-#include <unistd.h>
-#include <stdlib.h>
-#include <stdint.h>
-#include <limits.h>
-
-#include "../tools/types.h"
-#include "../tools/flags.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-signed PLCNetworkInfo (struct plc * plc)
-
-{
- signed status;
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_sw_ver_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MDEVICEID;
- uint8_t MVERLENGTH;
- char MVERSION [PLC_VERSION_STRING];
- }
- * request = (struct vs_sw_ver_request *) (message);
- struct __packed vs_sw_ver_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MDEVICEID;
- uint8_t MVERLENGTH;
- char MVERSION [PLC_VERSION_STRING];
- }
- * confirm = (struct vs_sw_ver_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SW_VER | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_SW_VER | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, "Device will not start");
- return (-1);
- }
- chipset (confirm);
- if ((plc->hardwareID = confirm->MDEVICEID) < CHIPSET_AR7400)
- {
- status = NetInfo1 (plc);
- }
- else
- {
- status = NetInfo2 (plc);
- }
- return (status);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed PhyRates (struct plc * plc)
- *
- * detect the chipset type and call appropriate function to
- * display the PHY rates; older devices use 16-bit rates but newer
- * devices use 32-bit;
- *
- * if you already know the chipset being interrogated, then you can
- * call INTPhyRate or AMPPhyRate directly and save some overhead;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PHYRATES_SOURCE
-#define PHYRATES_SOURCE
-
-#include <unistd.h>
-#include <stdlib.h>
-#include <stdint.h>
-#include <limits.h>
-
-#include "../tools/types.h"
-#include "../tools/flags.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-signed PLCPhyRates (struct plc * plc)
-
-{
- signed status;
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_sw_ver_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MDEVICEID;
- uint8_t MVERLENGTH;
- char MVERSION [PLC_VERSION_STRING];
- }
- * request = (struct vs_sw_ver_request *) (message);
- struct __packed vs_sw_ver_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MDEVICEID;
- uint8_t MVERLENGTH;
- char MVERSION [PLC_VERSION_STRING];
- }
- * confirm = (struct vs_sw_ver_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SW_VER | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_SW_VER | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, "Device will not start");
- return (-1);
- }
- chipset (confirm);
- if ((plc->hardwareID = confirm->MDEVICEID) < CHIPSET_AR7400)
- {
- status = PhyRates1 (plc);
- }
- else
- {
- status = PhyRates2 (plc);
- }
- return (status);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed PLCReadParameterBlock (struct channel * channel, struct message * message, void * memory, size_t extent);
- *
- * plc.h
- *
- * Read the PIB Image from an INT6000 using as many VS_RD_MOD
- * messages as needed; Write image blocks to file as they are
- * read;
- *
- * the objective here is to read the PIB module in 1024 byte blocks
- * until the module offset equals or exceeds the PIB actual; we do
- * not know the PIB actual until we have read the header contained
- * in the first block read from OFFSET 0;
- *
- * MOFFSET and MLENGTH fields occupy different offsets in REQ and CNF
- * messages; we exploit that by initializing them using CNF message
- * offsets then copying values into REQ message offsets before each
- * read; this works because confirmation messages always return all
- * the data we request or nothing at all;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef READPARAMETERBLOCK_SOURCE
-#define READPARAMETERBLOCK_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-
-#include "../tools/error.h"
-#include "../tools/files.h"
-#include "../pib/pib.h"
-#include "../plc/plc.h"
-
-signed PLCReadParameterBlock (struct channel * channel, struct message * message, void * memory, size_t extent)
-
-{
- uint8_t * buffer = (uint8_t *)(memory);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_rd_mod_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MODULEID;
- uint8_t MACCESS;
- uint16_t MLENGTH;
- uint32_t MOFFSET;
- uint8_t MSECRET [16];
- }
- * request = (struct vs_rd_mod_request *) (message);
- struct __packed vs_rd_mod_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t RESERVED1 [3];
- uint8_t MODULEID;
- uint8_t RESERVED;
- uint16_t MLENGTH;
- uint32_t MOFFSET;
- uint32_t CHKSUM;
- uint8_t BUFFER [PLC_RECORD_SIZE];
- }
- * confirm = (struct vs_rd_mod_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- uint16_t length = 0;
- uint32_t offset = 0;
- signed actual = PLC_RECORD_SIZE;
- do
- {
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_RD_MOD | MMTYPE_REQ));
- request->MODULEID = VS_MODULE_PIB;
- request->MLENGTH = HTOLE16 (actual);
- request->MOFFSET = HTOLE32 (offset);
- if (sendpacket (channel, message, (ETHER_MIN_LEN - ETHER_CRC_LEN)) <= 0)
- {
- error (1, errno, CHANNEL_CANTSEND);
- }
- if (readpacket (channel, message, sizeof (* message)) <= 0)
- {
- error (1, errno, CHANNEL_CANTREAD);
- }
- if (UnwantedMessage (message, sizeof (* confirm), 0, (VS_RD_MOD | MMTYPE_CNF)))
- {
- actual = PLC_RECORD_SIZE;
- offset = 0;
- continue;
- }
- if (confirm->MSTATUS)
- {
- error (1, ECANCELED, PLC_WONTDOIT);
- }
- if (LE16TOH (confirm->MLENGTH) != actual)
- {
- error (1, ECANCELED, PLC_ERR_LENGTH);
- }
- if (LE32TOH (confirm->MOFFSET) != offset)
- {
- error (1, ECANCELED, PLC_ERR_OFFSET);
- }
- actual = LE16TOH (confirm->MLENGTH);
- offset = LE32TOH (confirm->MOFFSET);
- if (checksum32 (confirm->BUFFER, actual, confirm->CHKSUM))
- {
- error (1, ECANCELED, "Bad Packet Checksum");
- }
- if (offset == length)
- {
- struct pib_header * pib_header = (struct pib_header *) (confirm->BUFFER);
- length = LE16TOH (pib_header->PIBLENGTH);
- }
- if ((offset + actual) > length)
- {
- actual = length - offset;
- }
- memcpy (buffer + offset, confirm->BUFFER, actual);
- offset += actual;
- extent -= actual;
- }
- while (offset < length);
- return (offset);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed PLCSelect (struct plc * plc, signed old (struct plc *), signed new (struct plc *));
- *
- * plc.h
- *
- * wait for device to start in order to determine chipset then call
- * the approproate function based on chipset; unfortunately, chipset
- * detection and selection may not be this simple in the future;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PLCSELECT_SOURCE
-#define PLCSELECT_SOURCE
-
-#include <stdlib.h>
-
-#include "../plc/plc.h"
-
-signed PLCSelect (struct plc * plc, signed old (struct plc *), signed new (struct plc *))
-
-{
- char firmware [PLC_VERSION_STRING];
- if (WaitForStart (plc, firmware, sizeof (firmware)))
- {
- Failure (plc, PLC_NODETECT);
- exit (1);
- }
- return ((plc->hardwareID < CHIPSET_AR7400)? old (plc): new (plc));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- *
- * PLCSession.c -
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef QCARAND_SOURCE
-#define QCARAND_SOURCE
-
-#include <stdint.h>
-
-#include "../tools/number.h"
-
-uint64_t QCASeed = 0;
-uint64_t QCASRand (uint32_t seed)
-
-{
- uint64_t temp = QCASeed;
- QCASeed = (uint64_t)(seed);
- return (temp);
-}
-
-uint32_t QCARand ()
-
-{
- QCASeed *= 0x41C64E6D;
- QCASeed += 0x00003029;
- return ((uint32_t)((QCASeed >> 0x10) & 0x7FFFFFFF));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed TopologyPrint (struct plcnetworks * plctopology);
- *
- * plc.h
- *
- * print plctopology structure in human readable format on stdout;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef TOPOLOGYPRINT_SOURCE
-#define TOPOLOGYPRINT_SOURCE
-
-#include <stdio.h>
-
-#include "../plc/plc.h"
-#include "../tools/memory.h"
-
-signed PLCTopologyPrint (struct plctopology * plctopology)
-
-{
- signed plcnetworks = plctopology->plcnetworks;
- struct plcnetwork * plcnetwork = (struct plcnetwork *)(&plctopology->plcnetwork);
- while (plcnetworks--)
- {
- signed plcstations = plcnetwork->plcstations;
- struct plcstation * plcstation = (struct plcstation *)(&plcnetwork->plcstation);
- while (plcstations--)
- {
- char address [ETHER_ADDR_LEN * 3];
- printf ("%s ", plcstation->LOC? "LOC": "REM");
- printf ("%s ", plcstation->CCO? "CCO": "STA");
- printf ("%03d ", plcstation->TEI);
- printf ("%s ", hexstring (address, sizeof (address), plcstation->MAC, sizeof (plcstation->MAC)));
- printf ("%s ", hexstring (address, sizeof (address), plcstation->BDA, sizeof (plcstation->BDA)));
- printf ("%03d ", plcstation->RX);
- printf ("%03d ", plcstation->TX);
- printf ("%s ", plcstation->hardware);
- printf ("%s ", plcstation->firmware);
- printf ("\n");
- plcstation++;
- }
- plcnetwork = (struct plcnetwork *)(plcstation);
- }
-
- return (0);
-}
-
-#endif
-
-
-
-/*
- * Copyright (c) 1999 - 2005 NetGroup, Politecnico di Torino (Italy)
- * Copyright (c) 2005 - 2007 CACE Technologies, Davis (California)
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. 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.
- * 3. Neither the name of the Politecnico di Torino, CACE Technologies
- * nor the names of its contributors may be used to endorse or promote
- * products derived from this software without specific prior written
- * permission.
- *
- * 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.
- *
- */
-
-/** @ingroup packetapi
- * @{
- */
-
-/** @defgroup packet32h Packet.dll definitions and data structures
- * Packet32.h contains the data structures and the definitions used by packet.dll.
- * The file is used both by the Win9x and the WinNTx versions of packet.dll, and can be included
- * by the applications that use the functions of this library
- * @{
- */
-
-#ifndef __PACKET32
-#define __PACKET32
-
-#include <winsock2.h>
-
-#ifdef HAVE_AIRPCAP_API
-#include <airpcap.h>
-#else
-#if !defined(AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_)
-#define AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_
-typedef struct _AirpcapHandle *PAirpcapHandle;
-#endif /* AIRPCAP_HANDLE__EAE405F5_0171_9592_B3C2_C19EC426AD34__DEFINED_ */
-#endif /* HAVE_AIRPCAP_API */
-
-#ifdef HAVE_DAG_API
-#include <dagc.h>
-#endif /* HAVE_DAG_API */
-
-// Working modes
-#define PACKET_MODE_CAPT 0x0 ///< Capture mode
-#define PACKET_MODE_STAT 0x1 ///< Statistical mode
-#define PACKET_MODE_MON 0x2 ///< Monitoring mode
-#define PACKET_MODE_DUMP 0x10 ///< Dump mode
-#define PACKET_MODE_STAT_DUMP MODE_DUMP | MODE_STAT ///< Statistical dump Mode
-
-/// Alignment macro. Defines the alignment size.
-#define Packet_ALIGNMENT sizeof(int)
-/// Alignment macro. Rounds up to the next even multiple of Packet_ALIGNMENT.
-#define Packet_WORDALIGN(x) (((x)+(Packet_ALIGNMENT-1))&~(Packet_ALIGNMENT-1))
-
-#define NdisMediumNull -1 ///< Custom linktype: NDIS doesn't provide an equivalent
-#define NdisMediumCHDLC -2 ///< Custom linktype: NDIS doesn't provide an equivalent
-#define NdisMediumPPPSerial -3 ///< Custom linktype: NDIS doesn't provide an equivalent
-#define NdisMediumBare80211 -4 ///< Custom linktype: NDIS doesn't provide an equivalent
-#define NdisMediumRadio80211 -5 ///< Custom linktype: NDIS doesn't provide an equivalent
-#define NdisMediumPpi -6 ///< Custom linktype: NDIS doesn't provide an equivalent
-
-// Loopback behaviour definitions
-#define NPF_DISABLE_LOOPBACK 1 ///< Drop the packets sent by the NPF driver
-#define NPF_ENABLE_LOOPBACK 2 ///< Capture the packets sent by the NPF driver
-
-/*!
- \brief Network type structure.
-
- This structure is used by the PacketGetNetType() function to return information on the current adapter's type and speed.
-*/
-typedef struct NetType
-{
- UINT LinkType; ///< The MAC of the current network adapter (see function PacketGetNetType() for more information)
- ULONGLONG LinkSpeed; ///< The speed of the network in bits per second
-}NetType;
-
-//some definitions stolen from libpcap
-
-#ifndef BPF_MAJOR_VERSION
-
-/*!
- \brief A BPF pseudo-assembly program.
-
- The program will be injected in the kernel by the PacketSetBPF() function and applied to every incoming packet.
-*/
-struct bpf_program
-{
- UINT bf_len; ///< Indicates the number of instructions of the program, i.e. the number of struct bpf_insn that will follow.
- struct bpf_insn *bf_insns; ///< A pointer to the first instruction of the program.
-};
-
-/*!
- \brief A single BPF pseudo-instruction.
-
- bpf_insn contains a single instruction for the BPF register-machine. It is used to send a filter program to the driver.
-*/
-struct bpf_insn
-{
- USHORT code; ///< Instruction type and addressing mode.
- UCHAR jt; ///< Jump if true
- UCHAR jf; ///< Jump if false
- int k; ///< Generic field used for various purposes.
-};
-
-/*!
- \brief Structure that contains a couple of statistics values on the current capture.
-
- It is used by packet.dll to return statistics about a capture session.
-*/
-struct bpf_stat
-{
- UINT bs_recv; ///< Number of packets that the driver received from the network adapter
- ///< from the beginning of the current capture. This value includes the packets
- ///< lost by the driver.
- UINT bs_drop; ///< number of packets that the driver lost from the beginning of a capture.
- ///< Basically, a packet is lost when the the buffer of the driver is full.
- ///< In this situation the packet cannot be stored and the driver rejects it.
- UINT ps_ifdrop; ///< drops by interface. XXX not yet supported
- UINT bs_capt; ///< number of packets that pass the filter, find place in the kernel buffer and
- ///< thus reach the application.
-};
-
-/*!
- \brief Packet header.
-
- This structure defines the header associated with every packet delivered to the application.
-*/
-struct bpf_hdr
-{
- struct timeval bh_tstamp; ///< The timestamp associated with the captured packet.
- ///< It is stored in a TimeVal structure.
- UINT bh_caplen; ///< Length of captured portion. The captured portion <b>can be different</b>
- ///< from the original packet, because it is possible (with a proper filter)
- ///< to instruct the driver to capture only a portion of the packets.
- UINT bh_datalen; ///< Original length of packet
- USHORT bh_hdrlen; ///< Length of bpf header (this struct plus alignment padding). In some cases,
- ///< a padding could be added between the end of this structure and the packet
- ///< data for performance reasons. This filed can be used to retrieve the actual data
- ///< of the packet.
-};
-
-/*!
- \brief Dump packet header.
-
- This structure defines the header associated with the packets in a buffer to be used with PacketSendPackets().
- It is simpler than the bpf_hdr, because it corresponds to the header associated by WinPcap and libpcap to a
- packet in a dump file. This makes straightforward sending WinPcap dump files to the network.
-*/
-struct dump_bpf_hdr{
- struct timeval ts; ///< Time stamp of the packet
- UINT caplen; ///< Length of captured portion. The captured portion can smaller than the
- ///< the original packet, because it is possible (with a proper filter) to
- ///< instruct the driver to capture only a portion of the packets.
- UINT len; ///< Length of the original packet (off wire).
-};
-
-#endif
-
-struct bpf_stat;
-
-#define DOSNAMEPREFIX TEXT("Packet_") ///< Prefix added to the adapters device names to create the WinPcap devices
-#define MAX_LINK_NAME_LENGTH 64 //< Maximum length of the devices symbolic links
-#define NMAX_PACKET 65535
-
-/*!
- \brief Addresses of a network adapter.
-
- This structure is used by the PacketGetNetInfoEx() function to return the IP addresses associated with
- an adapter.
-*/
-typedef struct npf_if_addr {
- struct sockaddr_storage IPAddress; ///< IP address.
- struct sockaddr_storage SubnetMask; ///< Netmask for that address.
- struct sockaddr_storage Broadcast; ///< Broadcast address.
-}npf_if_addr;
-
-#define ADAPTER_NAME_LENGTH 256 + 12 ///< Maximum length for the name of an adapter. The value is the same used by the IP Helper API.
-#define ADAPTER_DESC_LENGTH 128 ///< Maximum length for the description of an adapter. The value is the same used by the IP Helper API.
-#define MAX_MAC_ADDR_LENGTH 8 ///< Maximum length for the link layer address of an adapter. The value is the same used by the IP Helper API.
-#define MAX_NETWORK_ADDRESSES 16 ///< Maximum length for the link layer address of an adapter. The value is the same used by the IP Helper API.
-
-typedef struct WAN_ADAPTER_INT WAN_ADAPTER; ///< Describes an opened wan (dialup, VPN...) network adapter using the NetMon API
-typedef WAN_ADAPTER *PWAN_ADAPTER; ///< Describes an opened wan (dialup, VPN...) network adapter using the NetMon API
-
-#define INFO_FLAG_NDIS_ADAPTER 0 ///< Flag for ADAPTER_INFO: this is a traditional ndis adapter
-#define INFO_FLAG_NDISWAN_ADAPTER 1 ///< Flag for ADAPTER_INFO: this is a NdisWan adapter, and it's managed by WANPACKET
-#define INFO_FLAG_DAG_CARD 2 ///< Flag for ADAPTER_INFO: this is a DAG card
-#define INFO_FLAG_DAG_FILE 6 ///< Flag for ADAPTER_INFO: this is a DAG file
-#define INFO_FLAG_DONT_EXPORT 8 ///< Flag for ADAPTER_INFO: when this flag is set, the adapter will not be listed or openend by winpcap. This allows to prevent exporting broken network adapters, like for example FireWire ones.
-#define INFO_FLAG_AIRPCAP_CARD 16 ///< Flag for ADAPTER_INFO: this is an airpcap card
-#define INFO_FLAG_NPFIM_DEVICE 32
-
-/*!
- \brief Describes an opened network adapter.
-
- This structure is the most important for the functioning of packet.dll, but the great part of its fields
- should be ignored by the user, since the library offers functions that avoid to cope with low-level parameters
-*/
-typedef struct _ADAPTER {
- HANDLE hFile; ///< \internal Handle to an open instance of the NPF driver.
- CHAR SymbolicLink[MAX_LINK_NAME_LENGTH]; ///< \internal A string containing the name of the network adapter currently opened.
- int NumWrites; ///< \internal Number of times a packets written on this adapter will be repeated
- ///< on the wire.
- HANDLE ReadEvent; ///< A notification event associated with the read calls on the adapter.
- ///< It can be passed to standard Win32 functions (like WaitForSingleObject
- ///< or WaitForMultipleObjects) to wait until the driver's buffer contains some
- ///< data. It is particularly useful in GUI applications that need to wait
- ///< concurrently on several events. In Windows NT/2000 the PacketSetMinToCopy()
- ///< function can be used to define the minimum amount of data in the kernel buffer
- ///< that will cause the event to be signalled.
-
- UINT ReadTimeOut; ///< \internal The amount of time after which a read on the driver will be released and
- ///< ReadEvent will be signaled, also if no packets were captured
- CHAR Name[ADAPTER_NAME_LENGTH];
- PWAN_ADAPTER pWanAdapter;
- UINT Flags; ///< Adapter's flags. Tell if this adapter must be treated in a different way, using the Netmon API or the dagc API.
-
-#ifdef HAVE_AIRPCAP_API
- PAirpcapHandle AirpcapAd;
-#endif // HAVE_AIRPCAP_API
-
-#ifdef HAVE_NPFIM_API
- void* NpfImHandle;
-#endif // HAVE_NPFIM_API
-
-#ifdef HAVE_DAG_API
- dagc_t *pDagCard; ///< Pointer to the dagc API adapter descriptor for this adapter
- PCHAR DagBuffer; ///< Pointer to the buffer with the packets that is received from the DAG card
- struct timeval DagReadTimeout; ///< Read timeout. The dagc API requires a timeval structure
- unsigned DagFcsLen; ///< Length of the frame check sequence attached to any packet by the card. Obtained from the registry
- DWORD DagFastProcess; ///< True if the user requests fast capture processing on this card. Higher level applications can use this value to provide a faster but possibly unprecise capture (for example, libpcap doesn't convert the timestamps).
-#endif // HAVE_DAG_API
-} ADAPTER, *LPADAPTER;
-
-/*!
- \brief Structure that contains a group of packets coming from the driver.
-
- This structure defines the header associated with every packet delivered to the application.
-*/
-typedef struct _PACKET {
- HANDLE hEvent; ///< \deprecated Still present for compatibility with old applications.
- OVERLAPPED OverLapped; ///< \deprecated Still present for compatibility with old applications.
- PVOID Buffer; ///< Buffer with containing the packets. See the PacketReceivePacket() for
- ///< details about the organization of the data in this buffer
- UINT Length; ///< Length of the buffer
- DWORD ulBytesReceived; ///< Number of valid bytes present in the buffer, i.e. amount of data
- ///< received by the last call to PacketReceivePacket()
- BOOLEAN bIoComplete; ///< \deprecated Still present for compatibility with old applications.
-} PACKET, *LPPACKET;
-
-/*!
- \brief Structure containing an OID request.
-
- It is used by the PacketRequest() function to send an OID to the interface card driver.
- It can be used, for example, to retrieve the status of the error counters on the adapter, its MAC address,
- the list of the multicast groups defined on it, and so on.
-*/
-struct _PACKET_OID_DATA {
- ULONG Oid; ///< OID code. See the Microsoft DDK documentation or the file ntddndis.h
- ///< for a complete list of valid codes.
- ULONG Length; ///< Length of the data field
- UCHAR Data[1]; ///< variable-lenght field that contains the information passed to or received
- ///< from the adapter.
-};
-typedef struct _PACKET_OID_DATA PACKET_OID_DATA, *PPACKET_OID_DATA;
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/**
- * @}
- */
-
-/*
-BOOLEAN QueryWinPcapRegistryStringA(CHAR *SubKeyName,
- CHAR *Value,
- UINT *pValueLen,
- CHAR *DefaultVal);
-
-BOOLEAN QueryWinPcapRegistryStringW(WCHAR *SubKeyName,
- WCHAR *Value,
- UINT *pValueLen,
- WCHAR *DefaultVal);
-*/
-
-//---------------------------------------------------------------------------
-// EXPORTED FUNCTIONS
-//---------------------------------------------------------------------------
-
-PCHAR PacketGetVersion();
-PCHAR PacketGetDriverVersion();
-BOOLEAN PacketSetMinToCopy(LPADAPTER AdapterObject,int nbytes);
-BOOLEAN PacketSetNumWrites(LPADAPTER AdapterObject,int nwrites);
-BOOLEAN PacketSetMode(LPADAPTER AdapterObject,int mode);
-BOOLEAN PacketSetReadTimeout(LPADAPTER AdapterObject,int timeout);
-BOOLEAN PacketSetBpf(LPADAPTER AdapterObject,struct bpf_program *fp);
-BOOLEAN PacketSetLoopbackBehavior(LPADAPTER AdapterObject, UINT LoopbackBehavior);
-INT PacketSetSnapLen(LPADAPTER AdapterObject,int snaplen);
-BOOLEAN PacketGetStats(LPADAPTER AdapterObject,struct bpf_stat *s);
-BOOLEAN PacketGetStatsEx(LPADAPTER AdapterObject,struct bpf_stat *s);
-BOOLEAN PacketSetBuff(LPADAPTER AdapterObject,int dim);
-BOOLEAN PacketGetNetType (LPADAPTER AdapterObject,NetType *type);
-LPADAPTER PacketOpenAdapter(PCHAR AdapterName);
-BOOLEAN PacketSendPacket(LPADAPTER AdapterObject,LPPACKET pPacket,BOOLEAN Sync);
-INT PacketSendPackets(LPADAPTER AdapterObject,PVOID PacketBuff,ULONG Size, BOOLEAN Sync);
-LPPACKET PacketAllocatePacket(void);
-VOID PacketInitPacket(LPPACKET lpPacket,PVOID Buffer,UINT Length);
-VOID PacketFreePacket(LPPACKET lpPacket);
-BOOLEAN PacketReceivePacket(LPADAPTER AdapterObject,LPPACKET lpPacket,BOOLEAN Sync);
-BOOLEAN PacketSetHwFilter(LPADAPTER AdapterObject,ULONG Filter);
-BOOLEAN PacketGetAdapterNames(PTSTR pStr,PULONG BufferSize);
-BOOLEAN PacketGetNetInfoEx(PCHAR AdapterName, npf_if_addr* buffer, PLONG NEntries);
-BOOLEAN PacketRequest(LPADAPTER AdapterObject,BOOLEAN Set,PPACKET_OID_DATA OidData);
-HANDLE PacketGetReadEvent(LPADAPTER AdapterObject);
-BOOLEAN PacketSetDumpName(LPADAPTER AdapterObject, void *name, int len);
-BOOLEAN PacketSetDumpLimits(LPADAPTER AdapterObject, UINT maxfilesize, UINT maxnpacks);
-BOOLEAN PacketIsDumpEnded(LPADAPTER AdapterObject, BOOLEAN sync);
-BOOL PacketStopDriver();
-VOID PacketCloseAdapter(LPADAPTER lpAdapter);
-BOOLEAN PacketStartOem(PCHAR errorString, UINT errorStringLength);
-BOOLEAN PacketStartOemEx(PCHAR errorString, UINT errorStringLength, ULONG flags);
-PAirpcapHandle PacketGetAirPcapHandle(LPADAPTER AdapterObject);
-
-//
-// Used by PacketStartOemEx
-//
-#define PACKET_START_OEM_NO_NETMON 0x00000001
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif //__PACKET32
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed PhyRates (struct plc * plc)
- *
- * plc.h
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PHYRATES_SOURCE
-#define PHYRATES_SOURCE
-
-#include "../plc/plc.h"
-
-signed PhyRates (struct plc * plc)
-
-{
- return (PLCSelect (plc, PhyRates1, PhyRates2));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed Platform (struct channel * channel, const uint8_t device []);
- *
- * plc.h
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Matthieu Poullet <m.poullet@avm.de>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PLATFORM_SOURCE
-#define PLATFORM_SOURCE
-
-#include <memory.h>
-#include <errno.h>
-
-#include "../ether/channel.h"
-#include "../tools/memory.h"
-#include "../tools/symbol.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../plc/plc.h"
-
-signed Platform (struct channel * channel, const uint8_t device [])
-
-{
- struct message message;
- ssize_t packetsize;
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_sw_ver_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_sw_ver_request *) (&message);
- struct __packed vs_sw_ver_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MDEVICEID;
- uint8_t MVERLENGTH;
- char MVERSION [PLC_VERSION_STRING];
- }
- * confirm = (struct vs_sw_ver_confirm *) (&message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- memset (&message, 0, sizeof (message));
- EthernetHeader (&request->ethernet, device, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SW_VER | MMTYPE_REQ));
- if (sendpacket (channel, &message, (ETHER_MIN_LEN - ETHER_CRC_LEN)) > 0)
- {
- while ((packetsize = readpacket (channel, &message, sizeof (message))) > 0)
- {
- if (!UnwantedMessage (&message, packetsize, 0, (VS_SW_VER | MMTYPE_CNF)))
- {
- chipset (confirm);
- printf (" %s", chipsetname (confirm->MDEVICEID));
- printf (" %s", confirm->MVERSION);
- return (0);
- }
- }
- }
- return (-1);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed PrintRule (uint32_t CR_PID, uint32_t CR_OPERAND, uint8_t CR_VALUE []);
- *
- * rules.h
- *
- * print one classifier rule on stdout;
- *
- * some classifier rule structures have an 8-bit PID and OPERAND
- * while others have a 32-bit PID and OPERAND; this function is
- * the common demominator;
- *
- * Contributor(s):
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PRINTRULE_SOURCE
-#define PRINTRULE_SOURCE
-
-#include <string.h>
-
-#include "../plc/rules.h"
-#include "../tools/error.h"
-
-signed PrintRule (uint32_t CR_PID, uint32_t CR_OPERAND, uint8_t CR_VALUE [])
-
-{
- char buffer [CLASSIFIER_STRING];
- uint32_t val32;
- uint16_t val16;
- uint8_t val8;
- const char * p1;
- const char * p2;
- p1 = reword (CR_PID, fields, SIZEOF (fields));
- if (p1 == NULL)
- {
- error (1, 0, "invalid classifier PID");
- }
- p2 = reword (CR_OPERAND, operators, SIZEOF (operators));
- if (p2 == NULL)
- {
- error (1, 0, "invalid classifier operand");
- }
- printf ("%s %s", p1, p2);
- switch (CR_PID)
- {
- case FIELD_ETH_SA:
- case FIELD_ETH_DA:
- printf (" %s", hexstring (buffer, sizeof (buffer), CR_VALUE, ETHER_ADDR_LEN));
- break;
- case FIELD_IPV4_SA:
- case FIELD_IPV4_DA:
- putchar (' ');
- memout (CR_VALUE, IPv4_LEN, "%d", 1, '.', 0, stdout);
- break;
- case FIELD_IPV6_SA:
- case FIELD_IPV6_DA:
- putchar (' ');
- memout (CR_VALUE, IPv6_LEN, "%02x", 2, ':', 0, stdout);
- break;
- case FIELD_VLAN_UP:
- case FIELD_IPV6_TC:
- case FIELD_IPV4_TOS:
- case FIELD_IPV4_PROT:
- memcpy (& val8, CR_VALUE, sizeof (val8));
- printf (" 0x%02X", val8);
- break;
- case FIELD_VLAN_ID:
- case FIELD_TCP_SP:
- case FIELD_TCP_DP:
- case FIELD_UDP_SP:
- case FIELD_UDP_DP:
- case FIELD_IP_SP:
- case FIELD_IP_DP:
- memcpy (& val16, CR_VALUE, sizeof (val16));
- val16 = ntohs (val16);
- printf (" %d", val16);
- break;
- case FIELD_ETH_TYPE:
- memcpy (& val16, CR_VALUE, sizeof (val16));
- val16 = ntohs (val16);
- printf (" 0x%04X", val16);
- break;
- case FIELD_IPV6_FL:
- memcpy (& val32, & CR_VALUE [0], sizeof (val32));
- val32 = ntohl (val32);
- printf (" 0x%08X", val32);
- break;
- case FIELD_HPAV_MME:
- memcpy (& val8, & CR_VALUE [0], sizeof (val8));
- memcpy (& val16, & CR_VALUE [1], sizeof (val16));
- printf (" %02x:%04x", val8, val16);
- break;
- case FIELD_TCP_ACK:
- {
- code_t val;
- const char * p;
- memcpy (& val, CR_VALUE, sizeof (val));
- p = reword (val, states, SIZEOF (states));
- if (p == NULL)
- {
- error (1, 0, "invalid TCP ACK flag");
- }
- printf (" %s", p);
- }
- break;
- case FIELD_VLAN_TAG:
- {
- code_t val;
- const char * p;
- memcpy (& val, CR_VALUE, sizeof (val));
- p = reword (val, states, SIZEOF (states));
- if (p == NULL)
- {
- error (1, 0, "invalid VLAN tag flag");
- }
- printf (" %s", p);
- }
- break;
- default:
- printf (" *****UNSUPPORTED CODE*****");
- break;
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed PushButton (struct plc * plc);
- *
- * plc.h
- *
- * THis plugin for program plc emulates pushbutton functionality
- * using a MS_PB_ENC message;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PUSHBUTTON_SOURCE
-#define PUSHBUTTON_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../tools/error.h"
-#include "../tools/memory.h"
-#include "../plc/plc.h"
-
-signed PushButton (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed ms_pb_enc_request
- {
- struct ethernet_hdr ethernet;
- struct homeplug_hdr homeplug;
- uint8_t PBACTION;
- }
- * request = (struct ms_pb_enc_request *) (message);
- struct __packed ms_pb_enc_confirm
- {
- struct ethernet_hdr ethernet;
- struct homeplug_hdr homeplug;
- uint8_t MSTATUS;
- uint8_t AVLNSTAT;
- }
- * confirm = (struct ms_pb_enc_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- if (plc->pushbutton == 1)
- {
- Request (plc, "Join Network");
- }
- if (plc->pushbutton == 2)
- {
- Request (plc, "Leave Network");
- }
- if (plc->pushbutton == 3)
- {
- Request (plc, "Fetch Network Status");
- }
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- request->homeplug.MMV = 0;
- request->homeplug.MMTYPE = HTOLE16 (MS_PB_ENC | MMTYPE_REQ);
- request->PBACTION = plc->pushbutton;
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMFG (plc, 0, (MS_PB_ENC | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- if (plc->pushbutton == 1)
- {
- Confirm (plc, "Joining ...");
- return (0);
- }
- if (plc->pushbutton == 2)
- {
- Confirm (plc, "Leaving ...");
- return (0);
- }
- if (plc->pushbutton == 3)
- {
- Confirm (plc, "Membership Status %d", confirm->AVLNSTAT);
- return (0);
- }
- Failure (plc, "Unexpected pushbutton action code");
- return (-1);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- *
- * QCARand.c -
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef QCARAND_SOURCE
-#define QCARAND_SOURCE
-
-#include <stdint.h>
-
-#include "../tools/number.h"
-
-uint64_t QCASeed = 0;
-uint64_t QCASRand (uint64_t seed)
-
-{
- uint64_t temp = QCASeed;
- QCASeed = seed;
- return (temp);
-}
-
-uint32_t QCARand ()
-
-{
- QCASeed *= 0x41C64E6D;
- QCASeed += 0x00003029;
- return ((uint32_t)((QCASeed >> 0x10) & 0x7FFFFFFF));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed QualcommHeader (struct qualcomm_hdr * header, uint8_t MMV, uint16_t MMTYPE);
- *
- * mme.h
- *
- * Encode memory with an Atheros vendor specific message header
- * having HomePlug message protocol version (INTELLON_MMV) and
- * Atheros message type (MMTYPE);
- *
- * return the number of bytes actually encoded or 0 on encode error;
- * the error code is stored in errno;
- *
- * MMTYPE indicates the desired Atheros device operation taken
- * from the TRM; some operations are undocumented and should not
- * be used;
- *
- * OUI is the Organizationally Unique Identifier resgistered with
- * the IEEE by the vendor and is a constant for Atheros Devices;
- *
- * There is no need to flush the header since this function writes
- * to all locations unless there is an error; the caller may elect
- * to flush the buffer before calling this function;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef QUALCOMMHEADER_SOURCE
-#define QUALCOMMHEADER_SOURCE
-
-#include <stdint.h>
-
-#include "../mme/mme.h"
-#include "../tools/endian.h"
-
-signed QualcommHeader (struct qualcomm_hdr * header, uint8_t MMV, uint16_t MMTYPE)
-
-{
- header->MMV = MMV;
- header->MMTYPE = HTOLE16 (MMTYPE);
- header->OUI [0] = 0x00;
- header->OUI [1] = 0xB0;
- header->OUI [2] = 0x52;
- return (sizeof (* header));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed QualcommHeader1 (struct qualcomm_fmi * header, uint8_t MMV, uint16_t MMTYPE, uint16_tFMI);
- *
- * mme.h
- *
- * Encode memory with an Atheros vendor specific message header
- * having HomePlug message protocol version (INTELLON_MMV) and
- * Atheros message type (MMTYPE);
- *
- * return the number of bytes actually encoded or 0 on encode error;
- * the error code is stored in errno;
- *
- * see the INT6000 Firmware Technical Reference Manual for more
- * about MME headers and message types; the Atheros OUI is
- * implicit in this function;
- *
- * MMV is the version number of the MME command set; currently,
- * there is only one command set for Atheros MMEs;
- *
- * MMTYPE indicates the desired Atheros device operation taken
- * from the TRM; some operations are undocumented and should not
- * be used;
- *
- * OUI is the Organizationally Unique Identifier resgistered with
- * the IEEE by the vendor and is a constant for Atheros Devices;
- *
- * There is no need to flush the header since this function writes
- * to all locations unless there is an error; the caller may elect
- * to flush the buffer before calling this function;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef QUALCOMMHEADER1_SOURCE
-#define QUALCOMMHEADER1_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../tools/endian.h"
-#include "../mme/mme.h"
-
-signed QualcommHeader1 (struct qualcomm_fmi * header, uint8_t MMV, uint16_t MMTYPE)
-
-{
- header->MMV = MMV;
- header->MMTYPE = HTOLE16 (MMTYPE);
- header->FMSN = 0;
- header->FMID = 0;
- header->OUI [0] = 0x00;
- header->OUI [1] = 0xB0;
- header->OUI [2] = 0x52;
- return (sizeof (* header));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void RNDPasswords (unsigned vendor, unsigned device, unsigned number, unsigned count, unsigned group, unsigned space, flag_t flags);
- *
- * keys.h
- *
- * print a number of device address/password pairs on stdout; print
- * an optional usage flag in the first column for PTS compatability;
- *
- * vendor is the 24-bit OUI expressed as an integer; device is the
- * 24-bit starting unit address expressed as an integer; number is
- * the number of address/password pairs to generate; count is the
- * number of letters/numbers in the password excluding delimiters;
- * group is the number of letters or numbers appear between space
- * characters; space characters are suppressed when group is zero
- * or greater than count;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef RNDPASSWORDS_SOURCE
-#define RNDPASSWORDS_SOURCE
-
-#include <stdio.h>
-#include <unistd.h>
-#include <fcntl.h>
-#include <errno.h>
-
-#include "../tools/types.h"
-#include "../tools/error.h"
-#include "../tools/files.h"
-#include "../tools/flags.h"
-#include "../key/keys.h"
-
-void RNDPasswords (unsigned vendor, unsigned device, unsigned number, unsigned count, unsigned group, char space, flag_t flags)
-
-{
- if (vendor >> 24)
- {
- return;
- }
- if (device >> 24)
- {
- return;
- }
- if (number >> 24)
- {
- return;
- }
- while (number--)
- {
- if (_anyset (flags, PASSWORD_VERBOSE))
- {
- putc ('0', stdout);
- putc (' ', stdout);
- }
- if (_allclr (flags, PASSWORD_SILENCE))
- {
- printf ("%06X", vendor);
- printf ("%06X", device);
- putc (' ', stdout);
- }
- putpwd (count, group, space);
- putc ('\n', stdout);
- device++;
- }
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ReadFMI (struct plc * plc, uint8_t MMV, uint16_t MMTYPE);
- *
- * plc.h
- *
- * read a fragmented message and return a pointer to a buffer that
- * contains the concatenated message fragments; the buffer address
- * is returned in plc->content; the calling function must free the
- * buffer when done; buffer length is computed from the number of
- * fragments returned in the FMI field of the first fragment;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef READFMI_SOURCE
-#define READFMI_SOURCE
-
-#include <stdint.h>
-#include <stdlib.h>
-#include <memory.h>
-
-#include "../tools/memory.h"
-#include "../tools/number.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-signed ReadFMI (struct plc * plc, uint8_t MMV, uint16_t MMTYPE)
-
-{
- if (ReadMME (plc, MMV, MMTYPE) > 0)
- {
- struct homeplug * homeplug = (struct homeplug *)(plc->message);
- unsigned count = ((homeplug->homeplug.FMID >> 0) & 0x0F);
- unsigned extra = ((homeplug->homeplug.FMID >> 4) & 0x0F);
- unsigned length = sizeof (* homeplug) + extra * sizeof (homeplug->content);
- if ((plc->content = malloc (length)))
- {
- signed offset = plc->packetsize;
- memcpy (plc->content, homeplug, offset);
- while (count < extra)
- {
- if (ReadMME (plc, MMV, MMTYPE) <= 0)
- {
- free (plc->content);
- plc->content = NULL;
- return (- 1);
- }
- count = ((homeplug->homeplug.FMID >> 0) & 0x0F);
- extra = ((homeplug->homeplug.FMID >> 4) & 0x0F);
- plc->packetsize -= sizeof (struct ethernet_hdr);
- plc->packetsize -= sizeof (struct homeplug_fmi);
- memcpy ((uint8_t *)(plc->content) + offset, homeplug->content, plc->packetsize);
- offset += plc->packetsize;
- }
- plc->packetsize = offset;
- }
- else
- {
- error (1, errno, "%s", __func__);
- }
- }
- return (plc->packetsize);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ReadFirmware (struct plc * plc);
- *
- * plc.h
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef READFIRMWARE_SOURCE
-#define READFIRMWARE_SOURCE
-
-#include "../plc/plc.h"
-
-signed ReadFirmware (struct plc * plc)
-
-{
- return (PLCSelect (plc, ReadFirmware1, ReadFirmware2));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ReadFirmware2 (struct plc * plc);
- *
- * plc.h
- *
- * Read the firmware from flash memory using VS_MODULE_OPERATION
- * messages and write to file;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef READFIRMWARE2_SOURCE
-#define READFIRMWARE2_SOURCE
-
-#include "../plc/plc.h"
-
-signed ReadFirmware2 (struct plc * plc)
-
-{
- return (ModuleRead (plc, &plc->nvm, PLC_MOD_OP_READ_MEMORY, PLC_MODULEID_FIRMWARE, 0));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ReadMFG (struct plc * plc, uint16_t MMTYPE);
- *
- * plc.h
- *
- * read a manufacturer specific management message of the given
- * type in platform independent manner; return the number of bytes
- * read, 0 on timeout or -1 on error;
- *
- * see SendMME for the send counterpart to this function;
- *
- * see ReadMME for the vendor specific version of this function;
- *
- * readpacket behaves like the read function but there are several
- * readpacket functions in the toolkit and each performs raw packet
- * i/o differently depending on environment; they all use a channel
- * structure;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef READMFG_SOURCE
-#define READMFG_SOURCE
-
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../ether/channel.h"
-#include "../tools/memory.h"
-#include "../tools/flags.h"
-
-signed ReadMFG (struct plc * plc, uint8_t MMV, uint16_t MMTYPE)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
- struct homeplug * homeplug = (struct homeplug *)(message);
- while ((plc->packetsize = readpacket (channel, message, sizeof (* message))) > 0)
- {
- if (homeplug->homeplug.MMV != MMV)
- {
- continue;
- }
- if (homeplug->homeplug.MMTYPE != HTOLE16 (MMTYPE))
- {
- continue;
- }
- break;
- }
- return (plc->packetsize);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ReadMME (struct plc * plc, uint8_t MMV, uint16_t MMTYPE);
- *
- * plc.h
- *
- * wait for a QCA vendor specific message of given MMV and MMTYPE;
- * discard unwanted messages until the desired message arrives or
- * the channel timeout expires; return packetsize on success, 0 on
- * timeout or -1 on error;
- *
- * see SendMME for the send counterpart to this function;
- *
- * a well designed UnwantedMessage function is critical here;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- * Matthieu Poullet <m.poullet@avm.de>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef READMME_SOURCE
-#define READMME_SOURCE
-
-#include <sys/time.h>
-
-#include <stdint.h>
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/error.h"
-#include "../tools/timer.h"
-#include "../plc/plc.h"
-#include "../mme/mme.h"
-
-signed ReadMME (struct plc * plc, uint8_t MMV, uint16_t MMTYPE)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
- struct timeval ts;
- struct timeval tc;
- if (gettimeofday (&ts, NULL) == -1)
- {
- error (1, errno, CANT_START_TIMER);
- }
- while ((plc->packetsize = readpacket (channel, message, sizeof (* message))) >= 0)
- {
- if (UnwantedMessage (message, plc->packetsize, MMV, MMTYPE))
- {
- if (gettimeofday (&tc, NULL) == -1)
- {
- error (1, errno, CANT_RESET_TIMER);
- }
- if (channel->timeout < 0)
- {
- continue;
- }
- if (channel->timeout > MILLISECONDS (ts, tc))
- {
- continue;
- }
- plc->packetsize = 0;
- }
- break;
- }
- return (plc->packetsize);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed PLCReadParameterBlock (struct plc * plc, void * memory, size_t extent);
- *
- * plc.h
- *
- * Read the PIB Image from an INT6x00 using as many VS_RD_MOD
- * messages as needed; Write image blocks to file as they are
- * read;
- *
- * the objective here is to read the PIB module in 1024 byte blocks
- * until the module offset equals or exceeds the PIB actual; we do
- * not know the PIB actual until we have read the header contained
- * in the first block read from OFFSET 0;
- *
- * MOFFSET and MLENGTH fields occupy different offsets in REQ and CNF
- * messages; we exploit that by initializing them using CNF message
- * offsets then copying values into REQ message offsets before each
- * read; this works because confirmation messages always return all
- * the data we request or nothing at all;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef READPARAMETERBLOCK_SOURCE
-#define READPARAMETERBLOCK_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-
-#include "../tools/error.h"
-#include "../tools/files.h"
-#include "../plc/plc.h"
-#include "../pib/pib.h"
-
-signed ReadParameterBlock (struct plc * plc, void * memory, size_t extent)
-
-{
- uint8_t * buffer = (uint8_t *)(memory);
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_rd_mod_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MODULEID;
- uint8_t MACCESS;
- uint16_t MLENGTH;
- uint32_t MOFFSET;
- uint8_t MSECRET [16];
- }
- * request = (struct vs_rd_mod_request *) (message);
- struct __packed vs_rd_mod_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t RESERVED1 [3];
- uint8_t MODULEID;
- uint8_t RESERVED;
- uint16_t MLENGTH;
- uint32_t MOFFSET;
- uint32_t CHKSUM;
- uint8_t BUFFER [PLC_RECORD_SIZE];
- }
- * confirm = (struct vs_rd_mod_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- uint16_t length = 0;
- uint32_t offset = 0;
- signed actual = PLC_RECORD_SIZE;
- do
- {
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_RD_MOD | MMTYPE_REQ));
- request->MODULEID = VS_MODULE_PIB;
- request->MLENGTH = HTOLE16 (actual);
- request->MOFFSET = HTOLE32 (offset);
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_RD_MOD | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- error (PLC_EXIT (plc), ECANCELED, PLC_WONTDOIT);
- return (-1);
- }
- if (LE16TOH (confirm->MLENGTH) != actual)
- {
- Failure (plc, PLC_ERR_LENGTH);
- return (-1);
- }
- if (LE32TOH (confirm->MOFFSET) != offset)
- {
- Failure (plc, PLC_ERR_OFFSET);
- return (-1);
- }
- actual = LE16TOH (confirm->MLENGTH);
- offset = LE32TOH (confirm->MOFFSET);
- if (checksum32 (confirm->BUFFER, actual, confirm->CHKSUM))
- {
- error (PLC_EXIT (plc), ECANCELED, "Bad Packet Checksum");
- return (-1);
- }
- if (offset == length)
- {
- struct pib_header * pib_header = (struct pib_header *) (confirm->BUFFER);
- length = LE16TOH (pib_header->PIBLENGTH);
- }
- if ((offset + actual) > length)
- {
- actual = length - offset;
- }
- memcpy (buffer + offset, confirm->BUFFER, actual);
- offset += actual;
- extent -= actual;
- }
- while (offset < length);
- return (offset);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ReadParameters (struct plc * plc);
- *
- * plc.h
- *
- * Read the PIB Image from an INT6000 using as many VS_RD_MOD
- * messages as needed; Write image blocks to file as they are
- * read;
- *
- * the objective here is to read the PIB module in 1024 byte blocks
- * until the module offset equals or exceeds the PIB length; we do
- * not know the PIB length until we have read the header contained
- * in the first block at OFFSET 0;
- *
- * MOFFSET and MLENGTH fields occupy different offsets in REQ and CNF
- * messages; we exploit that by initializing them using CNF message
- * offsets then copying values into REQ message offsets before each
- * read; this works because confirmation messages always return all
- * the data we request or nothing at all;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef READPARAMETERS_SOURCE
-#define READPARAMETERS_SOURCE
-
-#include "../plc/plc.h"
-
-signed ReadParameters (struct plc * plc)
-
-{
- return (PLCSelect (plc, ReadParameters1, ReadParameters2));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ReadParameters1 (struct plc * plc);
- *
- * plc.h
- *
- * Read the PIB Image from an INT6x00 or AR7x00 using as many
- * VS_RD_MOD messages as needed; Write image blocks to file as
- * they are read;
- *
- * the objective here is to read the PIB module in 1024 byte blocks
- * until the module offset equals or exceeds the PIB length; we do
- * not know the PIB length until we have read the header contained
- * in the first block at OFFSET 0;
- *
- * MOFFSET and MLENGTH fields occupy different offsets in REQ and CNF
- * messages; we exploit that by initializing them using CNF message
- * offsets then copying values into REQ message offsets before each
- * read; this works because confirmation messages always return all
- * the data we request or nothing at all;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- * Lluis Paulet Gimbert <dimat.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef READPARAMETERS1_SOURCE
-#define READPARAMETERS1_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-
-#include "../tools/error.h"
-#include "../tools/files.h"
-#include "../plc/plc.h"
-#include "../pib/pib.h"
-
-signed ReadParameters1 (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_rd_mod_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MODULEID;
- uint8_t MACCESS;
- uint16_t MLENGTH;
- uint32_t MOFFSET;
- uint8_t MSECRET [16];
- }
- * request = (struct vs_rd_mod_request *) (message);
- struct __packed vs_rd_mod_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t RESERVED1 [3];
- uint8_t MODULEID;
- uint8_t RESERVED;
- uint16_t MLENGTH;
- uint32_t MOFFSET;
- uint32_t CHKSUM;
- uint8_t BUFFER [PLC_RECORD_SIZE];
- }
- * confirm = (struct vs_rd_mod_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- uint32_t extent = 0;
- uint32_t offset = 0;
- uint16_t length = PLC_RECORD_SIZE;
- Request (plc, "Read Parameters from Device");
- if (lseek (plc->pib.file, 0, SEEK_SET))
- {
- error (PLC_EXIT (plc), errno, FILE_CANTHOME, plc->pib.name);
- return (1);
- }
- do
- {
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_RD_MOD | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- request->MODULEID = VS_MODULE_PIB;
- request->MLENGTH = HTOLE16 (length);
- request->MOFFSET = HTOLE32 (offset);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_RD_MOD | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- if (LE16TOH (confirm->MLENGTH) != length)
- {
- error (PLC_EXIT (plc), 0, PLC_ERR_LENGTH);
- return (-1);
- }
- if (LE32TOH (confirm->MOFFSET) != offset)
- {
- error (PLC_EXIT (plc), 0, PLC_ERR_OFFSET);
- return (-1);
- }
- length = LE16TOH (confirm->MLENGTH);
- offset = LE32TOH (confirm->MOFFSET);
- if (checksum32 (confirm->BUFFER, length, confirm->CHKSUM))
- {
- error (PLC_EXIT (plc), ECANCELED, "Bad Packet Checksum");
- return (-1);
- }
- if (offset == extent)
- {
- struct pib_header * pib_header = (struct pib_header *) (confirm->BUFFER);
- extent = LE16TOH (pib_header->PIBLENGTH);
- }
- if ((offset + length) > extent)
- {
- length = extent - offset;
- }
- if (lseek (plc->pib.file, offset, SEEK_SET) != (signed)(offset))
- {
- error (PLC_EXIT (plc), errno, FILE_CANTSEEK, plc->pib.name);
- return (-1);
- }
- if (write (plc->pib.file, confirm->BUFFER, length) != (signed)(length))
- {
- error (PLC_EXIT (plc), errno, FILE_CANTSAVE, plc->pib.name);
- return (-1);
- }
- offset += length;
- }
- while (offset < extent);
- Confirm (plc, "Read %s", plc->pib.name);
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ReadParameters2 (struct plc * plc);
- *
- * plc.h
- *
- * Read the PIB Image from a QCA6410, QCA7000 or QCA7420 using as
- * many VS_MODULE_OPERATION messages as needed; Write image blocks
- * to file as they are read;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef READPARAMETERS2_SOURCE
-#define READPARAMETERS2_SOURCE
-
-#include "../plc/plc.h"
-
-signed ReadParameters2 (struct plc * plc)
-
-{
- return (ModuleRead (plc, &plc->pib, PLC_MOD_OP_READ_MEMORY, PLC_MODULEID_PARAMETERS, 0));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed RemoteDeviceList (struct channel * channel, char const * space);
- *
- * print the neighbor device list on stdout;
- *
- *
- *--------------------------------------------------------------------*/
-
-#ifndef REMOTEDEVICELIST_SOURCE
-#define REMOTEDEVICELIST_SOURCE
-
-#include "../plc/plc.h"
-
-signed RemoteDeviceList (struct plc * plc, char const * space, char const * comma)
-
-{
- return ((plc->hardwareID < CHIPSET_AR7400)? RemoteDeviceList1 (plc, space, comma): RemoteDeviceList2 (plc, space, comma));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed RemoteHosts (struct plc * plc);
- *
- * plc.h
- *
- * read hardware and software version information from an INT6000
- * using a VS_SW_VER Request Message;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef REMOTEHOSTS_SOURCE
-#define REMOTEHOSTS_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../tools/error.h"
-#include "../tools/memory.h"
-#include "../tools/symbol.h"
-#include "../plc/plc.h"
-
-signed RemoteHosts (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_sw_ver_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_sw_ver_request *) (message);
- struct __packed vs_sw_ver_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint32_t NUMDEVICES;
- struct __packed
- {
- uint8_t MACADDRESS [ETHER_ADDR_LEN];
- uint8_t ENUMID;
- }
- DEVICE [1];
- }
- * confirm = (struct vs_sw_ver_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Request Enumeration ID Table");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_EM_ID_TABLE | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- while (ReadMME (plc, 0, (VS_EM_ID_TABLE | MMTYPE_CNF)) > 0)
- {
- unsigned count = LE32TOH (confirm->NUMDEVICES);
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- continue;
- }
- while (count--)
- {
- hexout (confirm->DEVICE [count].MACADDRESS, ETHER_ADDR_LEN, ':', count? ' ': '\n', stdout);
- }
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void Request (struct plc * plc, char const * format, ...);
- *
- * plc.h
- *
- * Inform the user that an operation has started; print the channel
- * name, template destination address and user message on stdout
- * unless the PLC_SILENCE flag is set;
- *
- * This function is identical to Confirm () except that it prints
- * the template destination address instead of the packet source
- * address because it is called before outgoing frames are encoded;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef REQUEST_SOURCE
-#define REQUEST_SOURCE
-
-#include <stdio.h>
-#include <stdarg.h>
-
-#include "../plc/plc.h"
-#include "../tools/memory.h"
-#include "../tools/flags.h"
-
-#ifdef __GNUC__
-
-__attribute__ ((format (printf, 2, 3)))
-
-#endif
-
-void Request (struct plc * plc, char const *format, ...)
-
-{
- if (_allclr (plc->flags, PLC_SILENCE))
- {
- char address [ETHER_ADDR_LEN * 3];
- struct channel * channel = (struct channel *)(plc->channel);
- hexdecode (channel->peer, sizeof (channel->peer), address, sizeof (address));
- fprintf (stderr, "%s %s ", channel->ifname, address);
- if ((format) && (*format))
- {
- va_list arglist;
- va_start (arglist, format);
- vfprintf (stderr, format, arglist);
- va_end (arglist);
- }
- fprintf (stderr, "\n");
- }
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ResetAndWait (struct plc * plc);
- *
- * plc.h
- *
- * Reset the device using a VS_RS_DEV Request message then wait for
- * the device to reset and reboot before returning;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef RESETANDWAIT_SOURCE
-#define RESETANDWAIT_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-
-signed ResetAndWait (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_rs_dev_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- }
- * request = (struct vs_rs_dev_request *) (message);
- struct __packed vs_rs_dev_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MDEVICEID;
- uint8_t MVERLENGTH;
- char MVERSION [PLC_VERSION_STRING];
- }
- * confirm = (struct vs_rs_dev_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- char firmware [PLC_VERSION_STRING];
- Request (plc, "Reset Device");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_RS_DEV | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- memset (firmware, 0, sizeof (firmware));
-
-#if 0
-
- if (ReadMME (plc, (VS_RS_DEV | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- Confirm (plc, "Resetting ...");
- if (WaitForReset (plc))
- {
- Failure (plc, "Device did not Reset");
- return (-1);
- }
- if (WaitForStart (plc, firmware, sizeof (firmware)))
- {
- Failure (plc, "Device did not Start");
- return (-1);
- }
-
-#else
-
- while (ReadMME (plc, 0, (VS_RS_DEV | MMTYPE_CNF)) > 0)
- {
- if (confirm->MSTATUS)
- {
- continue;
- }
- return (0);
- }
-
-#endif
-
- return (-1);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed ResetDevice (struct plc * plc);
- *
- * plc.h
- *
- * This plugin for program plc and plcrate resets the device
- * using a VS_RS_DEV message; resetting can take several seconds
- * after this function returns to the caller;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef RESETDEVICE1_SOURCE
-#define RESETDEVICE1_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-
-signed ResetDevice (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_rs_dev_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_rs_dev_request *) (message);
- struct __packed vs_rs_dev_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- }
- * confirm = (struct vs_rs_dev_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Reset Device");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_RS_DEV | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- while (ReadMME (plc, 0, (VS_RS_DEV | MMTYPE_CNF)) > 0)
- {
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- continue;
- }
- Confirm (plc, "Resetting ...");
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed SDRAMInfo (struct plc * plc);
- *
- * plc.h
- *
- * read the flash resident NVM header and SDRAM configuration block
- * with VS_RD_CBLOCK;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SDRAMINFO_SOURCE
-#define SDRAMINFO_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-#include "../ram/sdram.h"
-#include "../nvm/nvm.h"
-
-signed SDRAMInfo (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_rd_cblock_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_rd_cblock_request *) (message);
- struct __packed vs_rd_cblock_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t CONFIGLENGTH;
- struct nvm_header1 nvm_header;
- struct config_ram config_ram;
- }
- * confirm = (struct vs_rd_cblock_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- struct config_ram * config_ram = (struct config_ram *)(&confirm->config_ram);
- Request (plc, "Fetch SDRAM Parameters");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_RD_CBLOCK | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- while (ReadMME (plc, 0, (VS_RD_CBLOCK | MMTYPE_CNF)) > 0)
- {
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- continue;
- }
- Confirm (plc, "-------");
- sdrampeek (config_ram);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed SHA256Match (signed fd, const uint8_t digest[]);
- *
- * SHA256.h
- *
- * search a fingerprint file for the given digest; return true
- * on success and false on failure; digests in the fingerprint
- * file must be upper case because comparison is binary;
- *
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SHA256MATCH_SOURCE
-#define SHA256MATCH_SOURCE
-
-#include <unistd.h>
-#include <errno.h>
-
-#include "../tools/number.h"
-#include "../key/SHA256.h"
-
-signed SHA256Match (signed fd, const uint8_t digest [])
-
-{
- char string [SHA256_DIGEST_LENGTH << 1];
- char buffer [SHA256_DIGEST_LENGTH << 1];
- signed length = 0;
- while (length < (signed)(sizeof (string)))
- {
- string [length++] = DIGITS_HEX [(*digest >> 4) & 0x0F];
- string [length++] = DIGITS_HEX [(*digest >> 0) & 0x0F];
- digest++;
- }
- while (read (fd, buffer, sizeof (buffer)) == sizeof (buffer))
- {
- char c;
- if (!memcmp (string, buffer, sizeof (string)))
- {
- return (1);
- }
- while (read (fd, &c, sizeof (c)) == sizeof (c))
- {
- if (c == '\n')
- {
- break;
- }
- }
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed SendMME (struct plc * plc);
- *
- * plc.h
- *
- * send management message over Ethernet in a platform independent
- * fashion; return the number of bytes sent on succes, 0 on timeout
- * or -1 on error;
- *
- * see ReadMME for the vendor specific read counterpart to this
- * function;
- *
- * see ReadMFG for the manufacturer specific read counterpart to
- * this function;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SENDMME_SOURCE
-#define SENDMME_SOURCE
-
-#include <stdint.h>
-
-#include "../plc/plc.h"
-
-signed SendMME (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
- signed length = sendpacket (channel, message, plc->packetsize);
- return (length);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed SetNMK (struct plc * plc);
- *
- * plc.h
- *
- * set NMK on a local or remote device using a VS_SET_KEY message;
- *
- * using this message to set the NMK on a remote device requires
- * both the remote device address (RDA) and the remote device
- * access key (DAK);
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SETNMK_SOURCE
-#define SETNMK_SOURCE
-
-#include <string.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../tools/memory.h"
-#include "../key/HPAVKey.h"
-
-signed SetNMK (struct plc * plc)
-
-{
- extern const byte localcast [ETHER_ADDR_LEN];
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_set_key_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t EKS;
- uint8_t NMK [HPAVKEY_NMK_LEN];
- uint8_t PEKS;
- uint8_t RDA [ETHER_ADDR_LEN];
- uint8_t DAK [HPAVKEY_DAK_LEN];
- }
- * request = (struct vs_set_key_request *) (message);
- struct __packed vs_set_key_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- }
- * confirm = (struct vs_set_key_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, localcast, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SET_KEY | MMTYPE_REQ));
- plc->packetsize = sizeof (struct vs_set_key_request);
- request->EKS = 0x01;
- memcpy (request->NMK, plc->NMK, sizeof (request->NMK));
- if (_anyset (plc->flags, PLC_SETREMOTEKEY))
- {
- Request (plc, "Set Remote Network Membership Key");
- memcpy (request->RDA, plc->RDA, sizeof (request->RDA));
- memcpy (request->DAK, plc->DAK, sizeof (request->DAK));
- request->PEKS = 0x00;
- }
- else
- {
- Request (plc, "Set Local Network Membership Key");
- memset (request->RDA, 0, sizeof (request->RDA));
- memset (request->DAK, 0, sizeof (request->DAK));
- request->PEKS = 0x0F;
- }
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_SET_KEY | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- Confirm (plc, "Setting ...");
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed SetProperty (struct plc * plc);
- *
- * plc.h
- *
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SETPROPERTY_SOURCE
-#define SETPROPERTY_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-
-signed SetProperty (struct plc * plc, struct plcproperty * plcproperty)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_set_property_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint32_t COOKIE;
- uint8_t OPTION;
- uint8_t RESERVED [3];
- uint32_t PROP_VERSION;
- uint32_t PROP_NUMBER;
- uint32_t DATA_LENGTH;
- uint8_t DATA_BUFFER [256];
- }
- * request = (struct vs_set_property_request *) (message);
- struct __packed vs_set_property_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint32_t MSTATUS;
- uint32_t COOKIE;
- }
- * confirm = (struct vs_set_property_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Set Property");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SET_PROPERTY | MMTYPE_REQ));
- request->COOKIE = HTOLE32 (plc->cookie);
- request->OPTION = plcproperty->PROP_OPTION;
- request->PROP_VERSION = HTOLE32 (plcproperty->PROP_VERSION);
- request->PROP_NUMBER = HTOLE32 (plcproperty->PROP_NUMBER);
- request->DATA_LENGTH = HTOLE32 (plcproperty->DATA_LENGTH);
- memcpy (&request->DATA_BUFFER, &plcproperty->DATA_BUFFER, plcproperty->DATA_LENGTH);
- plc->packetsize = sizeof (* request);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- while (ReadMME (plc, 0, (VS_SET_PROPERTY | MMTYPE_CNF)) > 0)
- {
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- continue;
- }
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed SlaveMembership (struct plc * plc);
- *
- * plc.h
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SLAVEMEMBERSHIP_SOURCE
-#define SLAVEMEMBERSHIP_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-#include "../key/HPAVKey.h"
-
-#define VS_SLAVE_MEM 0xA078
-
-signed SlaveMembership (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_slave_mem_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t SLAVE_ADDR [ETHER_ADDR_LEN];
- uint8_t AUTHORIZATION_MODE;
- uint8_t ASSOC_RETRY_TIME;
- }
- * request = (struct vs_slave_mem_request *) (message);
- struct __packed vs_slave_mem_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- }
- * confirm = (struct vs_slave_mem_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Request Slave Membership Change");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SLAVE_MEM | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- memcpy (request->SLAVE_ADDR, plc->RDA, sizeof (request->SLAVE_ADDR));
- request->AUTHORIZATION_MODE = plc->pushbutton;
- request->ASSOC_RETRY_TIME = plc->module;
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_SLAVE_MEM | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- Confirm (plc, "Requested ...");
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * int StartDevice1 (struct plc * plc);
- *
- * plc.h
- *
- * This int6kboot plugin initialize a device having no NVRAM or blank
- * or corrupted NVRAM; ensure Bootloader is running before starting;
- * write SDRAM configuration then NVM and PIB files to SDRAM and
- * start firmware execution;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef STARTDEVICE1_SOURCE
-#define STARTDEVICE1_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/error.h"
-#include "../tools/files.h"
-#include "../nvm/nvm.h"
-#include "../pib/pib.h"
-#include "../plc/plc.h"
-
-int StartDevice1 (struct plc * plc)
-
-{
- unsigned module = 0;
- struct nvm_header1 nvm_header;
- struct pib_header pib_header;
- uint32_t offset;
- if (WriteCFG (plc))
- {
- return (-1);
- }
- if (lseek (plc->NVM.file, 0, SEEK_SET))
- {
- error (PLC_EXIT (plc), errno, FILE_CANTHOME, plc->NVM.name);
- return (-1);
- }
- if (read (plc->NVM.file, &nvm_header, sizeof (nvm_header)) != sizeof (nvm_header))
- {
- error (PLC_EXIT (plc), errno, FILE_CANTREAD, plc->NVM.name);
- return (-1);
- }
- while (nvm_header.NEXTHEADER)
- {
- if (lseek (plc->NVM.file, LE32TOH (nvm_header.NEXTHEADER), SEEK_SET) == -1)
- {
- error (PLC_EXIT (plc), errno, FILE_CANTHOME, plc->NVM.name);
- return (-1);
- }
- if (read (plc->NVM.file, &nvm_header, sizeof (nvm_header)) != sizeof (nvm_header))
- {
- error (PLC_EXIT (plc), errno, FILE_CANTREAD, plc->NVM.name);
- return (-1);
- }
- module++;
- }
- if (lseek (plc->PIB.file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, plc->PIB.name);
- }
- if (read (plc->PIB.file, &pib_header, sizeof (pib_header)) != sizeof (pib_header))
- {
- error (1, errno, FILE_CANTREAD, plc->PIB.name);
- }
- if (lseek (plc->PIB.file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, plc->PIB.name);
- }
- if (BE16TOH (*(uint16_t *)(&pib_header)) < 0x0305)
- {
- offset = LEGACY_PIBOFFSET;
- }
- else if (BE16TOH (*(uint16_t *)(&pib_header)) < 0x0500)
- {
- offset = INT6x00_PIBOFFSET;
- }
- else
- {
- offset = AR7x00_PIBOFFSET;
- }
- if (WriteMEM (plc, &plc->PIB, 0, offset, LE16TOH (pib_header.PIBLENGTH)))
- {
- return (-1);
- }
- if (WriteFirmware1 (plc, module, &nvm_header))
- {
- return (-1);
- }
- if (StartFirmware1 (plc, module, &nvm_header))
- {
- return (-1);
- }
- if (lseek (plc->NVM.file, 0, SEEK_SET))
- {
- error (PLC_EXIT (plc), errno, FILE_CANTHOME, plc->NVM.name);
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * struct StartFirmware (struct plc * plc, unsigned module, void const * header)
- *
- * plc.h
- *
- * This plugin starts software execution using VS_ST_MAC; despite
- * an affirmative respond from the device, there is no guarantee
- * that the firmware will actually start or continue to run so we
- * wait for a response and report the result;
- *
- * struct nvm_header1 must be little-endian order and ready to send
- * to the device;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef STARTSOFTWARE_SOURCE
-#define STARTSOFTWARE_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-signed StartFirmware (struct plc * plc, unsigned module, void const * header)
-
-{
- return ((LE32TOH (*(uint32_t *)(header)) == 0x60000000)? StartFirmware1 (plc, module, header): StartFirmware2 (plc, module, header));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * struct StartFirmware1 (struct plc * plc, unsigned module, const struct nvm_header1 * nvm_header)
- *
- * plc.h
- *
- * This plugin starts software execution using VS_ST_MAC; despite
- * an affirmative respond from the device, there is no guarantee
- * that the firmware will actually start or continue to run so we
- * wait for a response and report the result;
- *
- * struct nvm_header1 must be little-endian order and ready to send
- * to the device;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef STARTSOFTWARE1_SOURCE
-#define STARTSOFTWARE1_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-signed StartFirmware1 (struct plc * plc, unsigned module, const struct nvm_header1 * nvm_header)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_st_mac_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MODULEID;
- uint8_t RESERVED [3];
- uint32_t IMAGEBOOT;
- uint32_t IMAGELENGTH;
- uint32_t IMAGECHECKSUM;
- uint32_t IMAGESTART;
- }
- * request = (struct vs_st_mac_request *) (message);
- struct __packed vs_st_mac_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MODULEID;
- }
- * confirm = (struct vs_st_mac_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- memset (message, 0, sizeof (* message));
- Request (plc, "Start %s (%d) (%08X)", plc->NVM.name, module, LE32TOH (nvm_header->ENTRYPOINT));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_ST_MAC | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- request->IMAGEBOOT = nvm_header->IMAGEADDRESS;
- request->IMAGELENGTH = nvm_header->IMAGELENGTH;
- request->IMAGECHECKSUM = nvm_header->IMAGECHECKSUM;
- request->IMAGESTART = nvm_header->ENTRYPOINT;
- request->MODULEID = VS_MODULE_MAC;
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_ST_MAC | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * struct StartFirmware2 (struct plc * plc, unsigned module, const struct nvm_header2 * nvm_header)
- *
- * plc.h
- *
- * This plugin starts software execution using VS_ST_MAC; despite
- * an affirmative respond from the device, there is no guarantee
- * that the firmware will actually start or continue to run so we
- * wait for a response and report the result;
- *
- * struct nvm_header1 must be little-endian order and ready to send
- * to the device;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef STARTSOFTWARE2_SOURCE
-#define STARTSOFTWARE2_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-signed StartFirmware2 (struct plc * plc, unsigned module, const struct nvm_header2 * nvm_header)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_st_mac_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MODULEID;
- uint8_t RESERVED [3];
- uint32_t IMAGEBOOT;
- uint32_t IMAGELENGTH;
- uint32_t IMAGECHECKSUM;
- uint32_t IMAGESTART;
- }
- * request = (struct vs_st_mac_request *) (message);
- struct __packed vs_st_mac_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MODULEID;
- }
- * confirm = (struct vs_st_mac_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- memset (message, 0, sizeof (* message));
- Request (plc, "Start %s (%d) (%08X)", plc->NVM.name, module, LE32TOH (nvm_header->EntryPoint));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_ST_MAC | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- request->IMAGEBOOT = nvm_header->ImageAddress;
- request->IMAGELENGTH = nvm_header->ImageLength;
- request->IMAGECHECKSUM = nvm_header->ImageChecksum;
- request->IMAGESTART = nvm_header->EntryPoint;
- request->MODULEID = VS_MODULE_MAC;
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_ST_MAC | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * StationRole.c - Station Role Strings;
- *
- * plc.h
- *
- *--------------------------------------------------------------------*/
-
-#ifndef STATIONROLE_SOURCE
-#define STATIONROLE_SOURCE
-
-#include "../plc/plc.h"
-
-char const * StationRole [] =
-
-{
- "STA",
- "PCO",
- "CCO"
-};
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed Topology (struct plc * plc);
- *
- * plc.h
- *
- * call appropriate topology module based on the PLC device
- * type;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef TOPOLOGY_SOURCE
-#define TOPOLOGY_SOURCE
-
-#include "../plc/plc.h"
-
-signed Topology (struct plc * plc)
-
-{
- return (PLCSelect (plc, Topology1, Topology2));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed Traffic (struct plc * plc);
- *
- * plc.h
- *
- * generate bi-directional traffic between a local device and all
- * remote devices on a powerline network; remote devices need not
- * be connected; no traffic is generated between remote devices;
- *
- * this function is similar to NetworkTraffic but takes less time
- * since not all powerline paths are exercised and those that are
- * can be exercised in parallel;
- *
- *
- *--------------------------------------------------------------------*/
-
-#ifndef TRAFFIC_SOURCE
-#define TRAFFIC_SOURCE
-
-#include "../plc/plc.h"
-
-signed Traffic (struct plc * plc)
-
-{
- return (PLCSelect (plc, Traffic1, Traffic2));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed Traffic1 (struct plc * plc);
- *
- * generate bi-directional traffic between a local device and all
- * remote devices on a powerline network; remote devices need not
- * be connected; no traffic is generated between remote devices;
- *
- * this function is similar to NetworkTraffic but takes less time
- * since not all powerline paths are exercised and those that are
- * can be exercised in parallel;
- *
- * this function is for INT6x00 chipsets only due to changes in chip
- * design; use Traffic2 for AR7x00 chipsets;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Matthieu Poullet <m.poullet@avm.de>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef TRAFFIC1_SOURCE
-#define TRAFFIC1_SOURCE
-
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/memory.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../mme/mme.h"
-#include "../plc/plc.h"
-
-signed Traffic1 (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_nw_info_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_nw_info_request *)(message);
- struct __packed vs_nw_info_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t DATA [1];
- }
- * confirm = (struct vs_nw_info_confirm *)(message);
- struct __packed station
- {
- uint8_t MAC [ETHER_ADDR_LEN];
- uint8_t TEI;
- uint8_t BDA [ETHER_ADDR_LEN];
- uint8_t AVGTX;
- uint8_t AVGRX;
- }
- * station;
- struct __packed network
- {
- uint8_t NID [7];
- uint8_t SNID;
- uint8_t TEI;
- uint8_t ROLE;
- uint8_t CCO_MAC [ETHER_ADDR_LEN];
- uint8_t CCO_TEI;
- uint8_t NUMSTAS;
- struct station stations [1];
- }
- * network;
- struct __packed networks
- {
- uint8_t NUMAVLNS;
- struct network networks [1];
- }
- * networks = (struct networks *) (confirm->DATA);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- byte bridgelist [255] [ETHER_ADDR_LEN];
- unsigned bridges = LocalDevices (channel, message, bridgelist, sizeof (bridgelist));
- while (bridges--)
- {
- byte devicelist [255] [ETHER_ADDR_LEN];
- unsigned devices = 0;
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, bridgelist [bridges], channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_NW_INFO | MMTYPE_REQ));
- plc->packetsize = ETHER_MIN_LEN - ETHER_CRC_LEN;
- if (SendMME (plc) <= 0)
- {
- error (0, errno, CHANNEL_CANTSEND);
- continue;
- }
- if (ReadMME (plc, 0, (VS_NW_INFO | MMTYPE_CNF)) <= 0)
- {
- error (0, errno, CHANNEL_CANTREAD);
- continue;
- }
- memcpy (devicelist [devices++], request->ethernet.OSA, sizeof (devicelist [0]));
- network = (struct network *)(&networks->networks);
- while (networks->NUMAVLNS--)
- {
- station = (struct station *)(&network->stations);
- while (network->NUMSTAS--)
- {
- memcpy (devicelist [devices++], station->MAC, sizeof (devicelist [0]));
- station++;
- }
- network = (struct network *)(station);
- }
- while (devices-- > 1)
- {
- Transmit (plc, devicelist [0], devicelist [devices]);
- Antiphon (plc, devicelist [devices], devicelist [0]);
- }
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed Traffic2 (struct plc * plc);
- *
- * generate bi-directional traffic between a local device and all
- * remote devices on a powerline network; remote devices need not
- * be connected; no traffic is generated between remote devices;
- *
- * this function is similar to NetworkTraffic but takes less time
- * since not all powerline paths are exercised and those that are
- * can be exercised in parallel;
- *
- * this function is for AR7x00 chipsets due to chipset design
- * changes; use Traffic1 for INT6x00 chipsets;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Matthieu Poullet <m.poullet@avm.de>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef TRAFFIC2_SOURCE
-#define TRAFFIC2_SOURCE
-
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/memory.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../mme/mme.h"
-#include "../plc/plc.h"
-
-signed Traffic2 (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_nw_info_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_fmi qualcomm;
- }
- * request = (struct vs_nw_info_request *)(message);
- struct __packed vs_nw_info_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_fmi qualcomm;
- uint8_t SUB_VERSION;
- uint8_t Reserved;
- uint16_t DATA_LEN;
- uint8_t DATA [1];
- }
- * confirm = (struct vs_nw_info_confirm *)(message);
- struct __packed station
- {
- uint8_t MAC [ETHER_ADDR_LEN];
- uint8_t TEI;
- uint8_t Reserved [3];
- uint8_t BDA [ETHER_ADDR_LEN];
- uint16_t AVGTX;
- uint8_t COUPLING;
- uint8_t Reserved3;
- uint16_t AVGRX;
- uint16_t Reserved4;
- }
- * station;
- struct __packed network
- {
- uint8_t NID [7];
- uint8_t Reserved1 [2];
- uint8_t SNID;
- uint8_t TEI;
- uint8_t Reserved2 [4];
- uint8_t ROLE;
- uint8_t CCO_MAC [ETHER_ADDR_LEN];
- uint8_t CCO_TEI;
- uint8_t Reserved3 [3];
- uint8_t NUMSTAS;
- uint8_t Reserved4 [5];
- struct station stations [1];
- }
- * network;
- struct __packed networks
- {
- uint8_t Reserved;
- uint8_t NUMAVLNS;
- struct network networks [1];
- }
- * networks = (struct networks *) (confirm->DATA);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- byte bridgelist [255] [ETHER_ADDR_LEN];
- unsigned bridges = LocalDevices (channel, message, bridgelist, sizeof (bridgelist));
- while (bridges--)
- {
- byte devicelist [255] [ETHER_ADDR_LEN];
- unsigned devices = 0;
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, bridgelist [bridges], channel->host, channel->type);
- QualcommHeader1 (&request->qualcomm, 1, (VS_NW_INFO | MMTYPE_REQ));
- plc->packetsize = ETHER_MIN_LEN - ETHER_CRC_LEN;
- if (SendMME (plc) <= 0)
- {
- error (0, errno, CHANNEL_CANTSEND);
- continue;
- }
- if (ReadMME (plc, 1, (VS_NW_INFO | MMTYPE_CNF)) <= 0)
- {
- error (0, errno, CHANNEL_CANTREAD);
- continue;
- }
- memcpy (devicelist [devices++], request->ethernet.OSA, sizeof (devicelist [0]));
- network = (struct network *)(&networks->networks);
- while (networks->NUMAVLNS--)
- {
- station = (struct station *)(&network->stations);
- while (network->NUMSTAS--)
- {
- memcpy (devicelist [devices++], station->MAC, sizeof (devicelist [0]));
- station++;
- }
- network = (struct network *)(station);
- }
- while (devices-- > 1)
- {
- Transmit (plc, devicelist [0], devicelist [devices]);
- Antiphon (plc, devicelist [devices], devicelist [0]);
- }
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed Transmit (struct plc * plc, byte source [], byte target []) ;
- *
- * send TCP/IP frames to a remote powerline device to establish
- * the source device TX PHY rate and remote device RX PHY rate;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef TRANSMIT_SOURCE
-#define TRANSMIT_SOURCE
-
-#include <memory.h>
-#include <errno.h>
-#include <sys/time.h>
-
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../tools/types.h"
-#include "../tools/timer.h"
-#include "../plc/plc.h"
-
-signed Transmit (struct plc * plc, byte source [], byte target [])
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
- struct timeval ts;
- struct timeval tc;
- unsigned timer = 0;
- if (_allclr (plc->flags, PLC_SILENCE))
- {
- char sourcename [ETHER_ADDR_LEN * 3];
- char targetname [ETHER_ADDR_LEN * 3];
- hexdecode (source, ETHER_ADDR_LEN, sourcename, sizeof (sourcename));
- hexdecode (target, ETHER_ADDR_LEN, targetname, sizeof (targetname));
- fprintf (stderr, "%s %s %s\n", channel->ifname, sourcename, targetname);
- }
- memset (message, 0xA5, sizeof (* message));
- EthernetHeader (message, target, source, ETHERTYPE_IP);
- if (gettimeofday (&ts, NULL) == -1)
- {
- error (1, errno, CANT_START_TIMER);
- }
- for (timer = 0; timer < plc->timer; timer = SECONDS (ts, tc))
- {
- if (sendpacket (channel, message, sizeof (* message)) <= 0)
- {
- error (1, ECANCELED, CHANNEL_CANTSEND);
- }
- if (gettimeofday (&tc, NULL) == -1)
- {
- error (1, errno, CANT_RESET_TIMER);
- }
- SLEEP (100);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed UnwantedMessage (void const * memory, size_t extent, uint8_t MMV, uint16_t MMTYPE);
- *
- * mme.h
- *
- * return true if memory does not contains a Qualcomm Atheros message
- * of the specified version and type; the message version determines
- * the location of the OUI field; messages with MMV = 1 have an FMI
- * used to track multi-part confirmation counts; out of order counts
- * are treated as an error;
- *
- * constant __WHYNOT__ displays reason for message rejection;
- *
- * batch is the fragment group identifier taken from the fragment
- * frame;
- *
- * total is the number of fragements in the group taken from the
- * fragment frame;
- *
- * index is the fragment identifier from the fragment frame;
- *
- * count is the number of fragments received so far;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Matthieu Poullet <m.poullet@avm.de>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef UNWANTEDMESSAGE_SOURCE
-#define UNWANTEDMESSAGE_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../tools/endian.h"
-#include "../tools/error.h"
-#include "../mme/mme.h"
-
-signed UnwantedMessage (void const * memory, size_t extent, uint8_t MMV, uint16_t MMTYPE)
-
-{
- extern const byte localcast [ETHER_ADDR_LEN];
-// struct message * message = (struct message *)(memory);
- struct homeplug * homeplug = (struct homeplug *)(memory);
- if (!extent)
- {
- return (-1);
- }
- if (extent < (ETHER_MIN_LEN - ETHER_CRC_LEN))
- {
-
-#if defined (__WHYNOT__)
-
- error (0, 0, "Wrong Ethernet Frame Size: Received " SIZE_T_SPEC " bytes but need at least %d", extent, ETHER_MIN_LEN - ETHER_CRC_LEN);
-
-#endif
-
- return (-1);
- }
- if (extent > (ETHER_MAX_LEN))
- {
-
-#if defined (__WHYNOT__)
-
- error (0, 0, "Wrong Ethernet Frame Size: Received " SIZE_T_SPEC " bytes but need at most %d", extent, ETHER_MAX_LEN);
-
-#endif
-
- return (-1);
- }
- if (ntohs (homeplug->ethernet.MTYPE) != ETH_P_HPAV)
- {
-
-#if defined (__WHYNOT__)
-
- error (0, 0, "Wrong Ethernet Frame Type: Received %04X while waiting for %04X", ntohs (homeplug->ethernet.MTYPE), ETH_P_HPAV);
-
-#endif
-
- return (-1);
- }
- if (homeplug->homeplug.MMV != MMV)
- {
-
-#if defined (__WHYNOT__)
-
- error (0, 0, "Wrong Message Version: Received %02X but expected %02X", homeplug->homeplug.MMV, MMV);
-
-#endif
-
- return (-1);
- }
- if (homeplug->homeplug.MMV == 0)
- {
- struct qualcomm_hdr * qualcomm = (struct qualcomm_hdr *)(&homeplug->homeplug);
- if (LE16TOH (qualcomm->MMTYPE) != MMTYPE)
- {
-
-#if defined (__WHYNOT__)
-
- error (0, 0, "Wrong Message Type: Received %04X while waiting for %04X", LE16TOH (qualcomm->MMTYPE), MMTYPE);
-
-#endif
-
- return (-1);
- }
- if ((MMTYPE < VS_MMTYPE_MIN) || (MMTYPE > VS_MMTYPE_MAX))
- {
- }
- else if (memcmp (localcast, qualcomm->OUI, sizeof (qualcomm->OUI)))
- {
-
-#if defined (__WHYNOT__)
-
- error (0, 0, "Wrong Message Vendor");
-
-#endif
-
- return (-1);
- }
- }
- if (homeplug->homeplug.MMV == 1)
- {
- struct qualcomm_fmi * qualcomm = (struct qualcomm_fmi *)(&homeplug->homeplug);
-
-#if FMI
-
- static unsigned total = 0;
- static unsigned index = 0;
- static unsigned count = 0;
-
-#endif
-
- if (LE16TOH (qualcomm->MMTYPE) != MMTYPE)
- {
-
-#if defined (__WHYNOT__)
-
- error (0, 0, "Wrong Message Type: Received %04X while waiting for %04X", LE16TOH (qualcomm->MMTYPE), MMTYPE);
-
-#endif
-
- return (-1);
- }
-
-#if FMI
-
- index = qualcomm->FMID >> 0 & 0x0F;
- if (!index)
- {
- total = qualcomm->FMID >> 4 & 0x0F;
- count = qualcomm->FMID >> 0 & 0x0F;
- if (memcmp (localcast, qualcomm->OUI, sizeof (qualcomm->OUI)))
- {
-
-#if defined (__WHYNOT__)
-
- error (0, 0, "Wrong Message Vendor");
-
-#endif
-
- return (-1);
- }
- }
- if (index != count)
- {
-
-#if defined (__WHYNOT__)
-
- error (0, 0, "Message Fragment Out-of-order");
-
-#endif
-
- return (-1);
- }
- if (count > total)
- {
-
-#if defined (__WHYNOT__)
-
- error (0, 0, "Fragment Count Exceeds Total");
-
-#endif
-
- return (-1);
- }
- count++;
-
-#endif
-
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * int UpgradeDevice1 (struct int6k * int6k);
- *
- * int6k.h
- *
- * This plugin upgrades a device having NVRAM; runtime firmware must
- * be running for this to work; NVM and PIB files in struct int6k
- * must be opened before calling this plugin; this plugin is used by
- * several program like int6k, int6kf and int6khost;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef UPGRADEDEVICE1_SOURCE
-#define UPGRADEDEVICE1_SOURCE
-
-#include "../plc/plc.h"
-
-int UpgradeDevice1 (struct plc * plc)
-
-{
- if (WriteNVM (plc))
- {
- return (-1);
- }
- if (WritePIB (plc))
- {
- return (-1);
- }
- if (FlashDevice1 (plc))
- {
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed VersionInfo (struct plc * plc);
- *
- * plc.h
- *
- * read hardware and software version information from an INT6x00
- * using a VS_SW_VER Request Message;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef VERSIONINFO1_SOURCE
-#define VERSIONINFO1_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../tools/error.h"
-#include "../tools/memory.h"
-#include "../tools/symbol.h"
-#include "../plc/plc.h"
-
-signed VersionInfo1 (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_sw_ver_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_sw_ver_request *) (message);
- struct __packed vs_sw_ver_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MDEVICEID;
- uint8_t MVERLENGTH;
- char MVERSION [PLC_VERSION_STRING];
- }
- * confirm = (struct vs_sw_ver_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Request Version Information");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SW_VER | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- while (ReadMME (plc, 0, (VS_SW_VER | MMTYPE_CNF)) > 0)
- {
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- continue;
- }
- chipset (confirm);
- Display (plc, "%s %s", chipsetname (confirm->MDEVICEID), confirm->MVERSION);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed VersionInfo2 (struct plc * plc);
- *
- * plc.h
- *
- * read hardware and software version information from an INT6000
- * using a VS_SW_VER Request Message;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef VERSIONINFO2_SOURCE
-#define VERSIONINFO2_SOURCE
-
-#include <stdint.h>
-#include <memory.h>
-
-#include "../tools/error.h"
-#include "../tools/memory.h"
-#include "../tools/symbol.h"
-#include "../plc/plc.h"
-
-signed VersionInfo2 (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_sw_ver_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint32_t COOKIE;
- }
- * request = (struct vs_sw_ver_request *) (message);
- struct __packed vs_sw_ver_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MDEVICE_CLASS;
- uint8_t MVERLENGTH;
- char MVERSION [254];
- uint32_t IDENT;
- uint32_t STEPPING_NUM;
- uint32_t COOKIE;
- uint32_t RSVD [6];
- }
- * confirm = (struct vs_sw_ver_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Request Version Information");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SW_VER | MMTYPE_REQ));
- request->COOKIE = HTOLE32 (plc->cookie);
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- while (ReadMME (plc, 0, (VS_SW_VER | MMTYPE_CNF)) > 0)
- {
-
-#if 0
-
- fprintf (stderr, "DEVICE CLASS (%d)\n", LE32TOH (confirm->MDEVICE_CLASS));
- fprintf (stderr, "VERSION LENGTH (%d)\n", LE32TOH (confirm->MVERLENGTH));
- fprintf (stderr, "VERSION STRING [%s]\n", LE32TOH (confirm->MVERSION));
- fprintf (stderr, "IDENT [0x%08X]\n", LE32TOH (confirm->IDENT));
- fprintf (stderr, "STEPPING NUMBER [0x%08X]\n", LE32TOH (confirm->STEPPING_NUM));
- fprintf (stderr, "COOKIE [0x%08X]\n", LE32TOH (confirm->COOKIE));
-
-#endif
-
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- continue;
- }
- chipset (confirm);
- Display (plc, "%s %s", chipsetname (confirm->MDEVICE_CLASS), confirm->MVERSION);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed WaitForReset (struct plc * plc, char string [], size_t length);
- *
- * plc.h
- *
- * poll the device using VS_SW_VER messages until no confirmation
- * messages are received indicating that the firmware has stopped
- * running; return 0 if the firmware stops within the allotted time
- * or -1 if it does not or if transmission errors occur;
- *
- * this function cannot distinguish between a software reset and
- * a power failure;
- *
- * retry is number of times to poll the device before returniung
- * an error to indicate that the device failed to reset; timer is
- * is the time between poll attempts;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef WAITFORRESET_SOURCE
-#define WAITFORRESET_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-#include <sys/time.h>
-
-#include "../plc/plc.h"
-#include "../tools/timer.h"
-#include "../tools/error.h"
-
-signed WaitForReset (struct plc * plc, char string [], size_t length)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
- struct timeval ts;
- struct timeval tc;
- unsigned timer = 0;
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_sw_ver_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_sw_ver_request *) (message);
- struct __packed vs_sw_ver_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MDEVICEID;
- uint8_t MVERLENGTH;
- char MVERSION [PLC_VERSION_STRING];
- }
- * confirm = (struct vs_sw_ver_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- memset (string, 0, length);
- if (gettimeofday (&ts, NULL) == -1)
- {
- error (1, errno, CANT_START_TIMER);
- }
- for (timer = 0; timer < plc->timer; timer = SECONDS (ts, tc))
- {
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SW_VER | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_SW_VER | MMTYPE_CNF)) < 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (gettimeofday (&tc, NULL) == -1)
- {
- error (1, errno, CANT_RESET_TIMER);
- }
- if (!plc->packetsize)
- {
- memcpy (string, confirm->MVERSION, confirm->MVERLENGTH);
- return (0);
- }
- }
- return (-1);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed WaitForRestart (struct plc * plc, char string [], size_t length);
- *
- * plc.h
- *
- * wait for the local powerline device to reset then start again;
- * this function may be called to stop the program from returning
- * to the command line until a flash or reset action is completed;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef WAITFORRESTART_SOURCE
-#define WAITFORRESTART_SOURCE
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-
-signed WaitForRestart (struct plc * plc)
-
-{
- if (_allclr (plc->flags, PLC_QUICK_FLASH))
- {
- char firmware [PLC_VERSION_STRING];
- if (WaitForReset (plc, firmware, sizeof (firmware)))
- {
- error (PLC_EXIT (plc), 0, "Device did not Reset");
- return (-1);
- }
- if (WaitForStart (plc, firmware, sizeof (firmware)))
- {
- error (PLC_EXIT (plc), 0, "Device did not Start");
- return (-1);
- }
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed WaitForStart (struct plc * plc, char string [], size_t length);
- *
- * plc.h
- *
- * poll the local device with VS_SW_VER messages until it responds
- * or the retry count expires; return 0 if the device responds in
- * time or -1 if it does not;
- *
- * if the device responds then set the struct plc hardwareID field
- * to indicate the true hardware platform; function chipset corrects
- * some unfortunate bootloader errors;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef WAITFORSTART_SOURCE
-#define WAITFORSTART_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-#include <string.h>
-#include <sys/time.h>
-
-#include "../plc/plc.h"
-#include "../tools/timer.h"
-#include "../tools/error.h"
-
-signed WaitForStart (struct plc * plc, char string [], size_t length)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
- struct timeval ts;
- struct timeval tc;
- unsigned timer = 0;
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_sw_ver_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_sw_ver_request *) (message);
- struct __packed vs_sw_ver_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MDEVICEID;
- uint8_t MVERLENGTH;
- char MVERSION [PLC_VERSION_STRING];
- uint16_t MPLATFORM;
- }
- * confirm = (struct vs_sw_ver_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- memset (string, 0, length);
- if (gettimeofday (&ts, NULL) == -1)
- {
- error (1, errno, CANT_START_TIMER);
- }
- for (timer = 0; timer < plc->timer; timer = SECONDS (ts, tc))
- {
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SW_VER | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_SW_VER | MMTYPE_CNF)) < 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (gettimeofday (&tc, NULL) == -1)
- {
- error (1, errno, CANT_RESET_TIMER);
- }
- if (plc->packetsize)
- {
- chipset (confirm);
- plc->hardwareID = confirm->MDEVICEID;
- memcpy (channel->peer, request->ethernet.OSA, sizeof (channel->peer));
- memcpy (string, confirm->MVERSION, confirm->MVERLENGTH);
- return (0);
- }
- }
- return (-1);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed WatchdogReport (struct plc * plc);
- *
- * plc.h
- *
- * Read the watchdog report using VS_WD_RPT and write it to a file
- * in binary format; this file can be sent to Atheros Support for
- * analysis;
- *
- * The VS_WD_RPT message returns an indication, not a confirmation
- * message;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef WATCHDOGREPORT_SOURCE
-#define WATCHDOGREPORT_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../tools/files.h"
-#include "../tools/memory.h"
-#include "../tools/format.h"
-
-signed WatchdogReport (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_wd_rpt_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint16_t SESSIONID;
- uint8_t CLR;
- }
- * request = (struct vs_wd_rpt_request *) (message);
- struct __packed vs_wd_rpt_ind
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint16_t SESSIONID;
- uint8_t NUMPARTS;
- uint8_t CURPART;
- uint16_t RDATALENGTH;
- uint8_t RDATAOFFSET;
- uint8_t RDATA [1];
- }
- * indicate = (struct vs_wd_rpt_ind *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Read Watchdog Report");
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_WD_RPT | MMTYPE_REQ));
- request->SESSIONID = HTOLE32 (plc->cookie);
- request->CLR = plc->readaction;
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- do
- {
- if (ReadMME (plc, 0, (VS_WD_RPT | MMTYPE_IND)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (indicate->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- if (write (plc->rpt.file, indicate->RDATA + indicate->RDATAOFFSET, LE16TOH (indicate->RDATALENGTH)) != LE16TOH (indicate->RDATALENGTH))
- {
- Failure (plc, FILE_CANTSAVE, plc->rpt.name);
- return (-1);
- }
- }
- while (indicate->CURPART < indicate->NUMPARTS);
- Confirm (plc, "Read %s", plc->rpt.name);
- return (0);
-}
-
-#endif
-
-
-
-
-
-
diff --git a/docbook/Win7-ftp-installer.png b/docbook/Win7-ftp-installer.png
deleted file mode 100644
index c4009956..00000000
Binary files a/docbook/Win7-ftp-installer.png and /dev/null differ
diff --git a/docbook/Win7-ftp-market.png b/docbook/Win7-ftp-market.png
deleted file mode 100644
index c5cf9b5f..00000000
Binary files a/docbook/Win7-ftp-market.png and /dev/null differ
diff --git a/docbook/Win7-ftp-toolkit.png b/docbook/Win7-ftp-toolkit.png
deleted file mode 100644
index c82af14c..00000000
Binary files a/docbook/Win7-ftp-toolkit.png and /dev/null differ
diff --git a/docbook/Win7-installer-dialogue.png b/docbook/Win7-installer-dialogue.png
deleted file mode 100644
index 31fc01fa..00000000
Binary files a/docbook/Win7-installer-dialogue.png and /dev/null differ
diff --git a/docbook/Win7-remove-program.png b/docbook/Win7-remove-program.png
deleted file mode 100644
index 18f0f0ec..00000000
Binary files a/docbook/Win7-remove-program.png and /dev/null differ
diff --git a/docbook/Win7-run-installer.png b/docbook/Win7-run-installer.png
deleted file mode 100644
index 24c9728e..00000000
Binary files a/docbook/Win7-run-installer.png and /dev/null differ
diff --git a/docbook/Win7-system-settings.png b/docbook/Win7-system-settings.png
deleted file mode 100644
index b6779dc2..00000000
Binary files a/docbook/Win7-system-settings.png and /dev/null differ
diff --git a/docbook/WinXP-AddRemoveProgram.png b/docbook/WinXP-AddRemoveProgram.png
deleted file mode 100644
index f915c28a..00000000
Binary files a/docbook/WinXP-AddRemoveProgram.png and /dev/null differ
diff --git a/docbook/WinXP-PathVariable.png b/docbook/WinXP-PathVariable.png
deleted file mode 100644
index 25ab7572..00000000
Binary files a/docbook/WinXP-PathVariable.png and /dev/null differ
diff --git a/docbook/WinXP-VisualStudioNET.png b/docbook/WinXP-VisualStudioNET.png
deleted file mode 100644
index cb1d9f6c..00000000
Binary files a/docbook/WinXP-VisualStudioNET.png and /dev/null differ
diff --git a/docbook/WinXP-WindowsInstaller.png b/docbook/WinXP-WindowsInstaller.png
deleted file mode 100644
index 310b1838..00000000
Binary files a/docbook/WinXP-WindowsInstaller.png and /dev/null differ
diff --git a/docbook/WriteCFG.c.html b/docbook/WriteCFG.c.html
deleted file mode 100644
index 1779850a..00000000
--- a/docbook/WriteCFG.c.html
+++ /dev/null
@@ -1,175 +0,0 @@
-
-
-
-
-
- WriteCFG.c
-
-
-
-
-
-
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed WriteCFG (struct plc * plc);
- *
- * plc.h
- *
- * This plugin for program plc writes the contents of an SDRAM
- * confirmation file to a device using a VS_SET_SDRAM message; the
- * CFG file in struct plc must be opened before this function is
- * called; the bootloader must be running for this to work;
- *
- * the VS_SET_SDRAM message is recognized by the INT600 BootLoader
- * only; the INT6400 BootLoader recognizes it but does nothing with
- * it;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef WRITECFG_SOURCE
-#define WRITECFG_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/memory.h"
-#include "../tools/error.h"
-#include "../tools/files.h"
-#include "../ram/sdram.h"
-
-int WriteCFG (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_set_sdram_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- struct config_ram config_ram;
- uint32_t CHECKSUM;
- }
- * request = (struct vs_set_sdram_request *) (message);
- struct __packed vs_set_sdram_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- }
- * confirm = (struct vs_set_sdram_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Write Configuration Applet from %s", plc->CFG.name);
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SET_SDRAM | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (lseek (plc->CFG.file, 0, SEEK_SET))
- {
- error (PLC_EXIT (plc), errno, FILE_CANTHOME, plc->CFG.name);
- return (-1);
- }
- if (read (plc->CFG.file, &request->config_ram, sizeof (struct config_ram)) != sizeof (struct config_ram))
- {
- error (PLC_EXIT (plc), errno, FILE_CANTREAD, plc->CFG.name);
- return (-1);
- }
- if (read (plc->CFG.file, &request->CHECKSUM, sizeof (request->CHECKSUM)) != sizeof (request->CHECKSUM))
- {
- error (PLC_EXIT (plc), errno, "can't read %s checksum", plc->CFG.name);
- return (-1);
- }
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_SET_SDRAM | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- Confirm (plc, "Written");
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed WriteExecuteFirmware (struct plc * plc, unsigned module, void const * nvm_header);
- *
- * plc.h
- *
- * call appropriate firmware download function based on the
- * image file format;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef WRITEEXECUTEFIRMWARE_SOURCE
-#define WRITEEXECUTEFIRMWARE_SOURCE
-
-#include "../plc/plc.h"
-
-signed WriteExecuteFirmware (struct plc * plc, unsigned module, void const * nvm_header)
-
-{
- return ((LE32TOH (*(uint32_t *)(nvm_header)) == 0x60000000)? WriteExecuteFirmware1 (plc, module, nvm_header): WriteExecuteFirmware2 (plc, module, nvm_header));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed WriteExecuteParameters (struct plc * plc, unsigned module, void const * nvm_header);
- *
- * plc.h
- *
- * call appropriate parameter block downlaod function based on
- * the image file format;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef WRITEEXECUTEPARAMETERS_SOURCE
-#define WRITEEXECUTEPARAMETERS_SOURCE
-
-#include "../plc/plc.h"
-
-signed WriteExecuteParameters (struct plc * plc, unsigned module, void const * nvm_header)
-
-{
- return ((LE32TOH (*(uint32_t *)(nvm_header)) == 0x60000000)? WriteExecuteParameters1 (plc, module, nvm_header): WriteExecuteParameters2 (plc, module, nvm_header));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed WriteFirmware (struct plc * plc, unsigned module, void const * nvm_header);
- *
- * plc.h
- *
- * call appropriate function based on the image file format;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef WRITEFIRMWARE_SOURCE
-#define WRITEFIRMWARE_SOURCE
-
-#include "../plc/plc.h"
-
-signed WriteFirmware (struct plc * plc, unsigned module, void const * nvm_header)
-
-{
- return ((LE32TOH (*(uint32_t *)(nvm_header)) == 0x60000000)? WriteFirmware1 (plc, module, nvm_header): WriteFirmware2 (plc, module, nvm_header));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed WriteFirmware1 (struct plc * plc, unsigned module, const struct nvm_header1 * nvm_header);
- *
- * plc.h
- *
- * read a firmware image from an image file and write it to SDRAM;
- * this function assumes that the calling program has positioned the
- * file to the start of the image;
- *
- * the boot loader must be running for this to work since runtime
- * firmware ignores VS_WR_MEM messages;
- *
- * future devices will ignore VS_WR_MEM messages to use function
- * WriteExecuteFirmware1, instead;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef WRITEFIRMWARE1_SOURCE
-#define WRITEFIRMWARE1_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-#include "../plc/plc.h"
-
-signed WriteFirmware1 (struct plc * plc, unsigned module, const struct nvm_header1 * nvm_header)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_wr_mem_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint32_t MOFFSET;
- uint32_t MLENGTH;
- uint8_t BUFFER [PLC_RECORD_SIZE];
- }
- * request = (struct vs_wr_mem_request *) (message);
- struct __packed vs_wr_mem_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint32_t MOFFSET;
- uint32_t MLENGTH;
- }
- * confirm = (struct vs_wr_mem_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- uint32_t length = PLC_RECORD_SIZE;
- uint32_t offset = LE32TOH (nvm_header->IMAGEADDRESS);
- uint32_t extent = LE32TOH (nvm_header->IMAGELENGTH);
- Request (plc, "Write %s (%d) (%08X:%d)", plc->NVM.name, module, offset, extent);
- while (extent)
- {
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_WR_MEM | MMTYPE_REQ));
- if (length > extent)
- {
- length = extent;
- }
- if (read (plc->NVM.file, request->BUFFER, length) != (signed)(length))
- {
- error (1, errno, FILE_CANTREAD, plc->NVM.name);
- }
- request->MLENGTH = HTOLE32 (length);
- request->MOFFSET = HTOLE32 (offset);
- plc->packetsize = sizeof (* request);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_WR_MEM | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- if (LE32TOH (confirm->MLENGTH) != length)
- {
- error (PLC_EXIT (plc), 0, PLC_ERR_LENGTH);
- return (-1);
- }
- if (LE32TOH (confirm->MOFFSET) != offset)
- {
- error (PLC_EXIT (plc), 0, PLC_ERR_OFFSET);
- return (-1);
- }
- offset += length;
- extent -= length;
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed WriteFirmware2 (struct plc * plc, unsigned module, const struct nvm_header2 * nvm_header);
- *
- * plc.h
- *
- * use VS_WR_MEM message to write a firmware image into SDRAM and
- * start execution when the image is stored in the new image file
- * format;
- *
- * the boot loader must be running for this to work since runtime
- * firmware ignores VS_WR_MEM messages;
- *
- * future devices will ignore VS_WR_MEM messages, so use function
- * WriteExecuteFirmware2, instead;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef WRITEFIRMWARE2_SOURCE
-#define WRITEFIRMWARE2_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-#include "../plc/plc.h"
-
-signed WriteFirmware2 (struct plc * plc, unsigned module, const struct nvm_header2 * nvm_header)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_wr_mem_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint32_t MOFFSET;
- uint32_t MLENGTH;
- uint8_t BUFFER [PLC_RECORD_SIZE];
- }
- * request = (struct vs_wr_mem_request *) (message);
- struct __packed vs_wr_mem_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint32_t MOFFSET;
- uint32_t MLENGTH;
- }
- * confirm = (struct vs_wr_mem_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- uint32_t length = PLC_RECORD_SIZE;
- uint32_t offset = LE32TOH (nvm_header->ImageAddress);
- uint32_t extent = LE32TOH (nvm_header->ImageLength);
- Request (plc, "Write %s (%d) (%08X:%d)", plc->NVM.name, module, offset, extent);
- while (extent)
- {
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_WR_MEM | MMTYPE_REQ));
- if (length > extent)
- {
- length = extent;
- }
- if (read (plc->NVM.file, request->BUFFER, length) != (signed)(length))
- {
- error (1, errno, FILE_CANTREAD, plc->NVM.name);
- }
- request->MLENGTH = HTOLE32 (length);
- request->MOFFSET = HTOLE32 (offset);
- plc->packetsize = sizeof (* request);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_WR_MEM | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- if (LE32TOH (confirm->MLENGTH) != length)
- {
- error (PLC_EXIT (plc), 0, PLC_ERR_LENGTH);
- return (-1);
- }
- if (LE32TOH (confirm->MOFFSET) != offset)
- {
- error (PLC_EXIT (plc), 0, PLC_ERR_OFFSET);
- return (-1);
- }
- offset += length;
- extent -= length;
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed WriteMEM (struct plc * plc, struct _file_ * file, unsigned module, uint32_t offset, uint32_t length);
- *
- * plc.h
- *
- * Write the contents of a file directly into device SDRAM using
- * VS_WR_MEM messages; the bootloader must be running for this to
- * work; the function is used to dowload firmware or test applets;
- *
- * this function makes no attempt to validate the information sent
- * to the device;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef WRITEMEM_SOURCE
-#define WRITEMEM_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-
-#include "../tools/files.h"
-#include "../tools/memory.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-signed WriteMEM (struct plc * plc, struct _file_ * file, unsigned module, uint32_t offset, uint32_t extent)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_wr_mem_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint32_t MOFFSET;
- uint32_t MLENGTH;
- uint8_t BUFFER [PLC_RECORD_SIZE];
- }
- * request = (struct vs_wr_mem_request *) (message);
- struct __packed vs_wr_mem_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint32_t MOFFSET;
- uint32_t MLENGTH;
- }
- * confirm = (struct vs_wr_mem_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- uint32_t length = PLC_RECORD_SIZE;
- Request (plc, "Write %s (%d) (%08X:%d)", file->name, module, offset, extent);
- while (extent)
- {
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_WR_MEM | MMTYPE_REQ));
- if (length > extent)
- {
- length = extent;
- }
- if (read (file->file, request->BUFFER, length) != (signed)(length))
- {
- error (1, errno, FILE_CANTREAD, file->name);
- }
- request->MLENGTH = HTOLE32 (length);
- request->MOFFSET = HTOLE32 (offset);
- plc->packetsize = sizeof (* request);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_WR_MEM | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- if (LE32TOH (confirm->MLENGTH) != length)
- {
- error (PLC_EXIT (plc), 0, PLC_ERR_LENGTH);
- return (-1);
- }
- if (LE32TOH (confirm->MOFFSET) != offset)
- {
- error (PLC_EXIT (plc), 0, PLC_ERR_OFFSET);
- return (-1);
- }
- offset += length;
- extent -= length;
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed WriteMOD (struct channel * channel, uint8_t module, void const * memory, size_t extent);
- *
- * plc.h
- *
- * This plugin writes a memory resident NVM image to device SDRAM
- * using as many VS_WR_MOD messages as needed to complete transfer;
- * runtime firmware must be running for this to work; the NVM file
- * in struct plc must be opened before calling this function;
- *
- * This function is functionally similar to WriteNVM but downloads
- * the image from memory instead of reading the image from a file;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef WRITEMOD_SOURCE
-#define WRITEMOD_SOURCE
-
-#include <unistd.h>
-#include <stdint.h>
-#include <memory.h>
-
-#include "../plc/plc.h"
-#include "../tools/memory.h"
-#include "../tools/error.h"
-#include "../tools/files.h"
-
-signed WriteMOD (struct plc * plc, uint8_t module, void const * memory, size_t extent)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_wr_mod_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MODULEID;
- uint8_t MACCESS;
- uint16_t MLENGTH;
- uint32_t MOFFSET;
- uint32_t MCHKSUM;
- uint8_t MBUFFER [PLC_RECORD_SIZE];
- }
- * request = (struct vs_wr_mod_request *) (message);
- struct __packed vs_wr_mod_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MODULEID;
- uint8_t MACCESS;
- uint16_t MLENGTH;
- uint32_t MOFFSET;
- }
- * confirm = (struct vs_wr_mod_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- uint32_t length = PLC_RECORD_SIZE;
- uint32_t offset = 0;
- while (extent)
- {
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_WR_MOD | MMTYPE_REQ));
- if (length > extent)
- {
- length = (signed)(extent);
- }
- memcpy (request->MBUFFER, (byte *)(memory) + offset, length);
- request->MODULEID = module;
- request->MACCESS = 0;
- request->MLENGTH = HTOLE16 (length);
- request->MOFFSET = HTOLE32 (offset);
- request->MCHKSUM = checksum32 (request->MBUFFER, length, 0);
- plc->packetsize = sizeof (* request);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_WR_MOD | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- if (LE16TOH (confirm->MLENGTH) != length)
- {
- error (PLC_EXIT (plc), 0, PLC_ERR_LENGTH);
- return (-1);
- }
- if (LE32TOH (confirm->MOFFSET) != offset)
- {
- error (PLC_EXIT (plc), 0, PLC_ERR_OFFSET);
- return (-1);
- }
- offset += length;
- extent -= length;
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed WriteParameters (struct plc * plc, unsigned module, void const * nvm_header);
- *
- * plc.h
- *
- * call appropriate function based on the image file format;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef WRITEFIRMWARE_SOURCE
-#define WRITEFIRMWARE_SOURCE
-
-#include "../plc/plc.h"
-
-signed WriteParameters (struct plc * plc, unsigned module, void const * nvm_header)
-
-{
- return ((LE32TOH (*(uint32_t *)(nvm_header)) == 0x60000000)? WriteParameters1 (plc, module, nvm_header): WriteParameters2 (plc, module, nvm_header));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed WriteParameters1 (struct plc * plc, unsigned module, const struct nvm_header1 * nvm_header);
- *
- * plc.h
- *
- * read a powerline parameter block image from plc->PIB and write
- * the image to SDRAM; this function assumes that plc->PIB is an
- * image chain and is positioned to the start of the PIB image in
- * that chain;
- *
- * in reality, this function should never be called because there
- * are no cases that require it but it has been implemented for
- * completeness;
- *
- * the boot loader must be running for this to work since runtime
- * firmware ignores VS_WR_MEM messages;
- *
- * future devices will ignore VS_WR_MEM messages so use function
- * WriteExecuteParameters1, instead;
- *
- * this function makes no attempt to validate the information sent
- * to the device;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef WRITEPARAMETERS1_SOURCE
-#define WRITEPARAMETERS1_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-#include "../plc/plc.h"
-
-signed WriteParameters1 (struct plc * plc, unsigned module, const struct nvm_header1 * nvm_header)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_wr_mem_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint32_t MOFFSET;
- uint32_t MLENGTH;
- uint8_t BUFFER [PLC_RECORD_SIZE];
- }
- * request = (struct vs_wr_mem_request *) (message);
- struct __packed vs_wr_mem_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint32_t MOFFSET;
- uint32_t MLENGTH;
- }
- * confirm = (struct vs_wr_mem_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- uint32_t length = PLC_RECORD_SIZE;
- uint32_t offset = LE32TOH (nvm_header->IMAGEADDRESS);
- uint32_t extent = LE32TOH (nvm_header->IMAGELENGTH);
- Request (plc, "Write %s (%d) (%08X:%d)", plc->PIB.name, module, offset, extent);
- while (extent)
- {
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_WR_MEM | MMTYPE_REQ));
- if (length > extent)
- {
- length = extent;
- }
- if (read (plc->PIB.file, request->BUFFER, length) != (signed)(length))
- {
- error (1, errno, FILE_CANTREAD, plc->PIB.name);
- }
- request->MLENGTH = HTOLE32 (length);
- request->MOFFSET = HTOLE32 (offset);
- plc->packetsize = sizeof (* request);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_WR_MEM | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- if (LE32TOH (confirm->MLENGTH) != length)
- {
- error (PLC_EXIT (plc), 0, PLC_ERR_LENGTH);
- return (-1);
- }
- if (LE32TOH (confirm->MOFFSET) != offset)
- {
- error (PLC_EXIT (plc), 0, PLC_ERR_OFFSET);
- return (-1);
- }
- offset += length;
- extent -= length;
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed WriteParameters2 (struct plc * plc, unsigned module, const struct nvm_header2 * nvm_header);
- *
- * plc.h
- *
- * use VS_WR_MEM message to write a parameter block into SDRAM
- * when the image is stored in the old image file format;
- *
- * the boot loader must be running for this to work since runtime
- * firmware ignores VS_WR_MEM messages;
- *
- * future devices will ignore VS_WR_MEM messages so use function
- * WriteExecuteParameters2, instead;
- *
- * this function makes no attempt to validate the information sent
- * to the device;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef WRITEPARAMETERS2_SOURCE
-#define WRITEPARAMETERS2_SOURCE
-
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-#include "../plc/plc.h"
-
-signed WriteParameters2 (struct plc * plc, unsigned module, const struct nvm_header2 * nvm_header)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_wr_mem_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint32_t MOFFSET;
- uint32_t MLENGTH;
- uint8_t BUFFER [PLC_RECORD_SIZE];
- }
- * request = (struct vs_wr_mem_request *) (message);
- struct __packed vs_wr_mem_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint32_t MOFFSET;
- uint32_t MLENGTH;
- }
- * confirm = (struct vs_wr_mem_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- uint32_t length = PLC_RECORD_SIZE;
- uint32_t offset = LE32TOH (nvm_header->ImageAddress);
- uint32_t extent = LE32TOH (nvm_header->ImageLength);
- Request (plc, "Write %s (%d) (%08X:%d)", plc->PIB.name, module, offset, extent);
- while (extent)
- {
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_WR_MEM | MMTYPE_REQ));
- if (length > extent)
- {
- length = extent;
- }
- if (read (plc->PIB.file, request->BUFFER, length) != (signed)(length))
- {
- error (1, errno, FILE_CANTREAD, plc->PIB.name);
- }
- request->MLENGTH = HTOLE32 (length);
- request->MOFFSET = HTOLE32 (offset);
- plc->packetsize = sizeof (* request);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_WR_MEM | MMTYPE_CNF)) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- if (LE32TOH (confirm->MLENGTH) != length)
- {
- error (PLC_EXIT (plc), 0, PLC_ERR_LENGTH);
- length = PLC_RECORD_SIZE;
- offset = 0;
- continue;
- }
- if (LE32TOH (confirm->MOFFSET) != offset)
- {
- error (PLC_EXIT (plc), 0, PLC_ERR_OFFSET);
- length = PLC_RECORD_SIZE;
- offset = 0;
- continue;
- }
- offset += length;
- extent -= length;
- }
- return (0);
-}
-
-#endif
-
-
-
-ampID(1) Qualcomm Atheros Open Powerline Toolkit ampID(1)
-
-NAME
- ampID - Echo Device Key
-
-SYNOPSIS
- ampID [options] [device] [device] [ ... ]
-
-DESCRIPTION
- This program prints a single powerline device key or HFID on stdout. It can be used to dynamically define environment
- variables or insert command line arguments in scripts at runtime. It is intended to echo a specific key read from a sin‐
- gle device but it can be used to echo a specific key type read from several devices by specifying either the Qualcomm
- Atheros Local Management Address or a broadcast address.
-
- This program is, in some sense, the inverse of modpib but it reads the key and HFID directly from the powerline device
- instead of reading from a PIB file.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -A Prints the Ethernet address (MAC) for each specified device. This option and options -D, -M, -N, -S and -U are
- mutually exclusive.
-
- -D Prints the Device Access Key (DAK) for each specified device. This option and options -A, -M, -N, -S and -U are
- mutually exclusive.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -n Append a newline to the end of each key. Newlines are omitted by default so that program output can be used as
- the raw input to another program. If you want the newline then you must request it with this option.
-
- -M Prints the Network Membership Key (NMK) for each specified device. This option and options -A, -D, -N, -S and -U
- are mutually exclusive.
-
- -N Prints the network HFID string for each specified device. This option and options -A, -D, -M, -S and -U are mutu‐
- ally exclusive.
-
- -q Suppresses status messages on stderr.
-
- -S Prints the manufacturer HFID string for each specified device. This option and options -A, -D, -M, -N and -U are
- mutually exclusive.
-
- -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
- be saved as text files for reference.
-
- -x Cause the program to exit on the first error instead of continuing with remaining iterations, operations or
- devices. Normally, the program reports errors and moves on to the next operation, iteration or device depending
- on the command line.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-EXAMPLES
- The following example prints the DAK of the local device on stdout. The local device is interrogated because no MAC
- address was specified. The default interface, eth1 on Linux and 2 on Windows, is used unless environment variable PLC is
- defined. The DAK is always printed by default. Depending on your system, you may want to use option -n when using this
- program interactively.
-
- # ampID
- 00:11:22:33:44:55:66:77:88:99:AA:DD:CC:DD:EE:FF
-
- The following example prints the NMK of device 00:B0:52:DA:DA:57 connected to interface eth2 on a Linux system. Several
- devices could be specified but that is not a common request.
-
- # DAK -Mi eth2 00:B0:52:DA:DA:57
- F4:23:71:4A:51:39:C2:2D:E5:EA:87:43:99:A1:37:81
-
- The following example dynamically inserts the DAK and NMK of the previous device on the command line of another program.
- In this example, we want to insert the DAK and NMK into PIB file abc.pib using program modpib. See the modpib man page
- for an explanation of command line syntax. See the GNU bash manuals for an explanation of why this works.
-
- # modpib abc.pib -D $(ampID -Di eth2 00:B0:52:DA:DA:57) -N $(ampID -Mi eth2 00:B0:52:DA:DA:57)
-
- The following example is an alternate way of accomplishing the same thing using shell script variables. This method may
- be easier to read and maintain. Notice that we 'squished' all the options together for brevity.
-
- # PLC=00:B0:52:DA:DA:57
- # DAK=$(ampID -Dieth2 ${PLC})
- # NMK=$(ampID -Mieth2 ${PLC})
- # modpib abc.pib -D ${DAK} -N ${NMK}
-
-SEE ALSO
- plc(1), amptool(1), ampboot(1), ampinit(1), modpib(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 ampID(1)
-
-ampboot(1) Qualcomm Atheros Open Powerline Toolkit ampboot(1)
-
-NAME
- ampboot - Qualcomm Atheros AR7x00 Powerline Device Bootstrapper
-
-SYNOPSIS
- ampboot [options] -N file -P file [device] [device] [...]
-
-DESCRIPTION
- Download and start runtime firmware on a local powerline device when it is in bootloader mode. A device remains in boot‐
- loader mode when it cannot load firmware from flash memory for some reason. This can happen if the device has no flash
- memory or the flash memory is either blank or corrupted. You can use this progrm to start a device or start the device
- and then, once runtime firmware starts, program flash memory.
-
- The bootloader only recognizes a subset of Atheros message types. This program uses that subset to write runtime
- firmware and parameters into SDRAM then start firmware execution. Optionally, it can proceed to download the same
- firmware and parameters again and commit them to flash memory.
-
- Starting a device is a three phase operation. The first phase writes an SDRAM configuration program into TCM and exe‐
- cutes it. The second phase writes runtime firmware and parameters as images into SDRAM. The third phase starts firmware
- execution. Once the runtime firmware starts, the device is operational.
-
- Flashing a device is a two phase operation. The first phase downloads runtime firmare and parameters under firmware con‐
- trol into scratch buffers. The second phase instructs the firmware to write the scratch buffers to flash memory and
- reboot the device. After flashing the device is self-sustaining.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -F[F] Write previously downloaded MAC and PIB to NVRAM using VS_MOD_NVM. Adding a second F here or another -F anywhere
- on the command line will force-flash a blank or corrupted NVRAM. Firmware loaded from NVRAM will treat force-
- flash as an error. This option can be used to create factory settings but cannot be used to change them once cre‐
- ated. Subsequent use creates and updates operational settings that can be erased using a factory reset.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -N filename
- Read the named NVM file and write it to the device. This option and argument are required. Any file having an
- invalid NVM file format will be rejected. No assumptions are made based on filename and no filename conventions
- are enforced.
-
- -P filename
- Read the named PIB file and write it to the device. This option and argument are required. Any file having an
- invalid PIB file format will be rejected. No assumptions are made based on filename and no filename conventions
- are enforced.
-
- -q Suppresses status messages on stderr.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The Ethernet hardware address of some powerline device. More than one address may be specified on the command
- line. If more than one address is specified then operations are performed on each device in turn. The default
- address is local. as explained in the DEVICES section.
-
-DEVICES
- Powerline device addresses are 12 hexadecimal digits in upper, lower or mixed case. Individual octets may be separated
- by colons, for clarity, but colons are not required. For example, "00b052000001", "00:b0:52:00:00:01" and
- "00b052:000001" are valid and equivalent.
-
- A local device is any Atheros Powerline Device connected directly to a host Ethernet interface. A remote device is any
- Atheros Powerline Device at the far end of a powerline connection. A foreign device is any powerline device not manufac‐
- tured by Atheros.
-
- Common device addresses have symbolic names that can be used in place of the actual address value. The following sym‐
- bolic addresses are recognized by this program and most other toolkit programs.
-
- all Equivalent to "broadcast", described next.
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- will respond to this address.
-
- local A synonym for the Qualcomm Atheros Local Management Address (LMA), 00:B0:52:00:00:01. All local Atheros devices
- will respond to this address but remote and foreign devices will not.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for technical information. See the Qualcomm
- Atheros Powerline Toolkit Online Documetation for practical information and examples.
-
-EXAMPLES
- The -N and -P options are always required. Their order is not important. Tne MAC address is not needed because devices
- default to address 00:B0:52:00:00:01 (the program default address) in bootloader mode. Once this operation completes,
- firmware is running in SDRAM but the NVRAM, if present, has not been programmed. This operation is common for flash-less
- devices. If we reset the device at this point then the device will return to bootloader mode.
-
- ampboot -N test.nvm -P test.pib
- # eth0 00:B0:52:00:00:01 Write SDRAM Configuration
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Write to device memory
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Write to device memory
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Start Firmware
- # eth0 00:B0:52:00:00:01 Started.
-
- The next example does the same thing but performs the extra steps needed to program NVRAM. It first downloads the
- firmware image from file test.nvm and the parameter block image from file test.pib using VS_WR_MEM then starts firmware
- execution using VS_ST_MAC. Once runtime firmware has started, it downloads the same firmware image and parameter block
- image (again) using VS_WR_MOD and commits them to NVRAM using VS_MOD_NVM.
-
- ampboot -N test.nvm -P test.pib -F
- # eth0 00:B0:52:00:00:01 Write SDRAM Configuration
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Write to device memory
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Write to device memory
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Start Firmware
- # eth0 00:B0:52:00:00:01 Started.
- # eth0 00:B0:52:00:00:01 Write MAC as module
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Write PIB as module
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Flash Device
- # eth0 00:B0:52:00:00:01 Flashed.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-SEE ALSO
- plc(1), amptool(1), chknvm(1), chkpib(1), modpib(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 ampboot(1)
-
-amphost(1) Qualcomm Atheros Open Powerline Toolkit amphost(1)
-
-NAME
- amphost - Qualcomm Atheros Powerline Device Host Emulator
-
-SYNOPSIS
- amphost [options] -N file -P file -n file -p file
-
-DESCRIPTION
- Wait for VS_HST_ACTION.IND messages from a local device and service them as described in the QCA Firmware Technical Ref‐
- erence Manual. This program can be used to demonstrate or verify proper powerline device/host interaction for flash-less
- devices. This implementation is not production grade and will stop dead - like a bug! - when things go wrong. Consider
- using the Qualcomm Atheros Embedded API for real-time, production-grade applications.
-
- Host emulation applies to flash-less device designs where a local host processor provides the persistent storage. The
- local host can provide a wide range of intelligent storage functions for a device but this program offers one. Options
- -N and -P name existing files that store the factory default runtime firmware and parameters, respectively. Options -n
- and -p name scratch files that will store user firmware and parameters, respectively. This is similiar to the standard
- Atheros NVRAM scheme but is not the same.
-
- To use the program, connect a flash-less device to the host via ethernet then start this program with the correct file‐
- names. The program will automatically respond to device requests to download memory configuration, firmware and/or
- parameters and upload firmware or and/or parameters under device control. See the Qualcomm Atheros Firmware Technical
- Reference Manual for more information.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -F[F] Flash NVRAM once downloaded firmware has started. The same firmware and PIB are downloaded, again, using
- VS_WR_MOD and written to NVRAM using VS_MOD_NVM. Adding a second F here or another -F anywhere on the command
- line will perform a forced flash. When no NVRAM is present, normal and force flash cause the device to upload to
- the host. When blank or corrupted NVRAM is present, forced flash writes to NVRAM. This operation will fail when
- no NVRAM is present.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -N filename
- Use this file to download firmware when requested by the local device. The file must exist and have a valid NVM
- file format or it will be rejected. No assumptions are made based on filename and no filename conventions are
- enforced. The program will not over-write this file. This option and argument are required.
-
- -n filename
- Use this file to store firmware uploaded from the local device. The file need not exist but an error will occur
- if it cannot be created or written. If firmware is uploaded to this file, it is used for subsequent firmware
- downloads unless the device requests a factory reset. In that case, the file specified by option -N is used.
- This option and argument are optional. If omitted then the default filename user.pib will be used.
-
- -P filename
- Use this file to download parameters when requested by the local device. The file must exist and have a valid PIB
- file format or it will be rejected. No assumptions are made based on filename and no filename conventions are
- enforced. The program will not over-write this file. This option and argument are required.
-
- -p filename
- Use this file to store parameters uploaded from the local device. The file need not exist but an error will occur
- if it cannot be created or written. Once parameters are uploaded to this file, it is used for subsequent parame‐
- ter downloads unless the device requests a factory reset. In that case, the file specified by option -P is used.
- This option and argument are optional. If omitted then the default filename user.nvm will be used.
-
- -q Suppress status messages on stderr.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -v Print additional information on stdout. In particular, this option will print incoming and outgoing Ethernet
- frames on stdout.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- None.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-EXAMPLES
- The following command starts the host emulator. The -N and -P options are always required. Their order is not impor‐
- tant.
-
- # amphost -N test.nvm -P test.pib -n temp.nvm -p temp.pib
- eth1 00:B0:52:00:00:01 Waiting for Host Action Requests
-
- eth1 00:B0:52:00:00:01 Host Action Request is (4) configure memory.
- eth1 00:B0:52:00:00:01 Write Memory (00000040:15752)
- eth1 00:B0:52:00:00:01 Wrote mac-release-X.nvm
- eth1 00:B0:52:00:00:01 Started BootLoader
-
- eth1 00:B0:52:00:00:01 Host Action Request is (0) initialize device.
- eth1 00:B0:52:00:00:01 Write Memory (00000040:15752)
- eth1 00:B0:52:00:00:01 Wrote mac-release-X.nvm
- eth1 00:B0:52:00:00:01 Started BootLoader
- eth1 00:B0:52:00:00:01 Write Memory (00204000:1013952)
- eth1 00:B0:52:00:00:01 Wrote mac-release-X.nvm
- eth1 00:B0:52:00:00:01 Write Memory (01F00000:11400)
- eth1 00:B0:52:00:00:01 Wrote AR7400-WallAdapter-HomePlugAV_NorthAmerica.pib
- eth1 00:B0:52:00:00:03 Started INT7400-MAC-0-0-1008-00-63-20100227-AUTO-D
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- plc(1), ampboot(1), amptool(1),
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 amphost(1)
-
-amplist(1) Qualcomm Atheros Open Powerline Toolkit amplist(1)
-
-NAME
- amplist - List Atheros Device Addresses
-
-SYNOPSIS
- amplist [options] [device] [device] [...]
-
-DESCRIPTION
- print the local device address or all network device addresses for a specific device. This program is ideal for that
- special script jokey in your life. It only prints device addresses. Nothing else.
-
- Devices are detected using one of two methods. The two methods can be used in combination to determine network topology.
-
- The first method sends one VS_SW_VER message to the Qualcomm Atheros Local Management Address and prints the Ethernet
- source address found in each received confirmation message. The method is used when no device addresses appear on the
- command line. The result is a list of all local devices, being this connected directly to the local host. Each local
- device device may bridge to an independent powerline network having remote devices as members.
-
- The second method sends one VS_NW_INFO message to each specified device and prints the Ethernet source address found in
- each received message plus the Ethernet addresses of each network station identified in that message body. This method
- is used whenever one, or more, device addresses appear on the command line. It is possible to query remote powerline
- devices directly and so duplicate devices addresses are printed when devices share powerline neighbors.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-COMMENTS
- This program is identical to legacy program int6klist but uses version 1 of the Qualcomm Atheros VS_NW_INFO vendor-spe‐
- cific message. Older firmware versions may not recognize this message version.
-
-OPTIONS
- -b Print bridge device addresses. Each specified device reports it's own address. This option has no effect if no
- devices are specified.
-
- -i Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -n Append a newline to output.
-
- -q Enter quiet mode. This option has no effect at this time.
-
- -r Print remote device addresses. Each specified device reports neighbor device addresses. This option has no effect
- when no devices are specified.
-
- -s Insert a newline, instead of a space, between each device address.
-
- -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If omitted the the program out‐
- put consists of local device addresses only. Otherwise, output conisists of the specified device followed by all
- devices associated with it. The default address is local. See DEVICES for information about symbolic device
- addresses.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at the
- far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-EXAMPLES
- The following command lists all local devices. Since no devices are specified on the command line, one VS_SW_VER message
- is addressed to 00:B0:52:00:00:01 and the responses are collected. As we can see, there is only one local device avail‐
- able at this time. Observe that the prompt appears immediately after the address because newlines are omitted by default.
-
- # amplist
- 00:B0:52:BE:EF:04 #
-
- The next example does the same thing but there are now three local devices available. Observe that all devices are
- printed without intervening newlines so that the output of this program can be used as input to other toolkit programs.
-
- # amplist
- 00:B0:52:BE:EF:04 00:B0:52:BA:BE:02 00:B0:52:BA:BE:01 # int6k
-
- The next example queries the first local device from the previous example, 00:B0:52:BE:EF:04, for a list neighbor
- devices. This time a VS_NW_INFO message is sent because we named a device on the command line. The named device happens
- to be a local device but it need not be. We can see that the device has no neighbors.
-
- # amplist 00:B0:52:BE:EF:04
- 00:B0:52:BE:EF:04 # int6k
-
- The next example we query the next local device, 00:B0:52:BA:BE:02, and find that it has two neighbor devices that did
- not show up earlier because they are remote devices. Observe that the three devices comprise a complete logical powerline
- network. Device 00:B0:52:BA:BE:02 is connected to the local host but 00:0F:33:F2:01:21 and 00:0f:00:F2:01:13 are con‐
- nected to other hosts, somewhere.
-
- # amplist 00:B0:52:BA:BE:02
- 00:B0:52:BA:BE:02 00:0F:33:F2:01:21 00:0F:00:F2:01:13
-
- The next example shows that we can query multiple devices at a time for neighbors. We have copied the output from the
- second example and pasted it onto the command line. We now have a list of all devices, local and remote.
-
- # amplist 00:B0:52:BE:EF:04 00:B0:52:BA:BE:02 00:B0:52:BA:BE:01
- 00:B0:52:BE:EF:04 00:B0:52:BA:BE:01 00:B0:52:BA:BE:02 00:0F:33:F2:01:21 00:0F:00:F2:01:13
-
- This next example does the same thing but uses option -n to append a newline after each query. This output is eaiser to
- understand because each device queried starts on a new line and is followed by any neighbors.
-
- # amplist 00:B0:52:BE:EF:04 00:B0:52:BA:BE:02 00:B0:52:BA:BE:01 -n
- 00:B0:52:BE:EF:04
- 00:B0:52:BA:BE:02 00:0F:33:F2:01:21 00:0F:00:F2:01:13
- 00:B0:52:BA:BE:01
-
- This example invokes amplist which returns a list of local devices. That list is inserted into another amplist command
- line. This demontrates how program output can be used in scripts.
-
- # amplist $(amplist) -n
- 00:B0:52:BE:EF:04
- 00:B0:52:BA:BE:02 00:0F:33:F2:01:21 00:0F:00:F2:01:13
- 00:B0:52:BA:BE:01
-
- This next example accomplishes the same thing since all local device respond with a list of powerline neighbors.
-
- # amplist local
- 00:B0:52:BE:EF:04
- 00:B0:52:BA:BE:02 00:0F:33:F2:01:21 00:0F:00:F2:01:13
- 00:B0:52:BA:BE:01
-
-SEE ALSO
- plc(1), amprate(1), ampstat(1), amptone(1), amptool(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 amplist(1)
-
-amprate(1) Qualcomm Atheros Open Powerline Toolkit amprate(1)
-
-NAME
- amprate - Qualcomm Atheros AR7x00 PHY Rate Monitor
-
-SYNOPSIS
- amprate [options] [device] [device] [...]
-
-DESCRIPTION
- The Atheros PHY Rate Utility polls one or more devices and prints the average transmit and receive PHY rates between a
- device and each neighboring network device. Output is column-oriented and suitable for loading into a spreadsheet or
- being read by a simple program.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-COMMENTS
- This program version is identical to legacy program int6k, except for options -t and -T which use version 1 of the Qual‐
- comm Atheros VS_NW_INFO vendor-specific message. Older firmware versions may not recognize this message version.
-
-OPTIONS
- -c Display coded PHY rates. Coded PHY rates are displayed by default so this option is redundant but it has been
- kept for backword compatibility. This option and option -u are mutually exclusive.
-
- -d seconds
- Traffic duration in seconds per connection. Directional traffic is systematically sent between each pair of pow‐
- erline network devices for this period of time. Consequently, the total time needed to generate traffic between
- all network devices will be approximately n! times this value, so don''t get carried away. The minimum value is 1
- second and the maximum value is 60 seconds.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -n Reads the average transmit and receive PHY rate for wach device using VS_NW_INFO and prints it on stdout. Each
- output line displays the ethernet interface, source address, destination address and either the transmit or
- receive PHY rate.
-
- -o milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -r Reads device hardware and software revision information using VS_SW_VER and prints it on stdout.
-
- -R Resets the device using VS_RS_DEV.
-
- -t Generate powerline traffic between the local device and each remote device on each powerline network connected to
- the host. It does not generate any traffic between remote powerline device pairs. This option is especially use‐
- ful when remote powerline devices are not connected to Ethernet devices capable of sending traffic back to the
- host.
-
- -T Generate powerline traffic between all devices on each powerline network connected to the host. This option is
- similar to option -t but it takes much longer because traffic is systematically generated between each pair of
- powerline devices. Consequently, the time to complete will increase factorially as the number of network devices
- increases. Such complete traffic path coverage is not always needed.
-
- -u Display un-coded PHY rates. Coded PHY rates are displayed by default. This option and option -c are mutually
- exclusive.
-
- -q Enter quiet mode. Progress messages are suppressed.
-
- -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
-
- -x Exit program on first error with a non-zero exit code. This option allows shell scripts to detect failed or
- incomplete operations and take the appropriate action.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-EXAMPLES
- The following example displays the average transmit and receive PHY rates from each of two devices. One is a local
- device connected to interface eth2 and the other is a remote device at the far end of the powerline. In this case, they
- are the only two devices on the powerline network. Observe the recipricol rates shown.
-
- # amprate -ni eth2 00:B0:52:00:00:AA 00:B0:52:00:00:BB
- eth2 00:B0:52:00:00:AA 00:B0:52:00:00:BB TX 163 mbps
- eth2 00:B0:52:00:00:AA 00:B0:52:00:00:BB RX 176 mbps
- eth2 00:B0:52:00:00:BB 00:B0:52:00:00:AA TX 176 mbps
- eth2 00:B0:52:00:00:BB 00:B0:52:00:00:AA RX 163 mbps
-
- The following example generates powerline traffic between the local device and each remote device because option -t is
- present. It then displays the PHY rate read from the local device.
-
- # amprate -tni eth2
- eth2 00:B0:52:00:00:AA 00:B0:52:00:00:BB TX 163 mbps
- eth2 00:B0:52:00:00:AA 00:B0:52:00:00:BB RX 176 mbps
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- plc(1), amprule(1), ampstat(1), amptone(1)
-
-CREDITS
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 amprate(1)
-
-amprule(1) Qualcomm Atheros Open Powerline Toolkit amprule(1)
-
-NAME
- amprule - Stream Classification Utility
-
-SYNOPSIS
- amprule [options] action operand condition [condition] [condition] control volatility [device] [device] [...]
-
- where condition is a field operator value sequence.
-
-DESCRIPTION
- Format and send stream classification rules to one or more devices. Rules specify an action to be taken when a frame
- satisfies selection criteria. Selection criteria consists of one, two or three conditions where any or all conditions
- must be satisfied. Each condition consists of a field type, a relational operator and a value. Rules may be added to a
- device, or removed from a device, so that they have permanent or temporary effect.
-
- Classification rules are cumulative. If a new rule set is identical to an old rule set then an error will occur unless
- it contains a different Transmission Action. In that case the old rule will be replaced. Identical classification rule
- sets are permitted if one of the sets is associated with a VLAN tag action. Classification is based on the original
- frame before is is altered by VLAN Tag insertion or removal.
-
- Classification is multi-dimensional and the terminology used here may seem strange at first. Refer to the Qualcomm
- Atheros Firmware Techncial Reference Manual description of the VS_CLASSIFICATION management message for a full explana‐
- tion.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -q Suppresses status messages on stderr. -r Read rules from a device and display them on stdout.
-
- -s Print a list of program keywords on stdout. This option over-rides all others, except -? and -!, and the program
- will terminate without further action.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu. -T tag The VLAN tag to be inserted into frames
- before they are transmitted. The tag is a 32-bit hexadecimal integer with optional "0x" prefix. This option is
- required for action TagTX and must be omitted for all other actions.
-
- -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
- be saved as text files for reference.
-
- -V version
- The CSPEC version number expressed as a small decimal integer. This option is required (and should be 2) for
- action TagTX and must be omitted for all other actions.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- action The action to be taken for frames that meet any (or all) selection criteria. Valid actions are listed and
- described under ACTIONS.
-
- operand
- The operand specifies the logical relationship between conditions before the action to be taken. Valid operands
- are listed and described under OPERANDS.
-
- condition
- A conditional expression consisting of a field, operator and value. See CONDITIONS for more information.
-
- control
- The control specifies the action to be taken by the device upon receipt of the rule. The basic actions are to add
- it to, or remove it from, the list of existing rules. Valid controls are listed and described under CONTROLS.
-
- volatility
- The volatility specifies the effective lifetime of the rule. Temoprary rules are stored in SDRAM and are lost
- then the device is reset. Permanent rules are stored in NVRAM and are restored after the device is reset. Valid
- volatilities are listed and described under VOLATILITY.
-
- device The MAC address of some powerline device. More than one address may be specified on the command line. If more
- than one address is specified then operations are performed on each device in turn. The default address is
- "local". See DEVICES for more information.
-
-ACTIONS
- Actions indcate the disposition of frames that match selection criteria. They are expressed as discrete alphanumeric
- strings entered in upper, lower or mixed character case. They are position sensitive. Failure to enter a known action
- will results in an error message that lists permitted actions.
-
- CAP0,CAP1,CAP2,CAP3
- Assign a specific Channel Access Priority to frames.
-
- Drop,DropTX
- Do not forward frames over powerline.
-
- DropRX Do not forward frames to host.
-
- Boost Boost frame priority to CAP3 for MMEs only. At least one condition must be "MME".
-
- StripTX
- Remove the VLAN Tag from frames before transmission over powerline. This option checks for a VLAN Tag even when
- there are no VLAN related conditions.
-
- StripRX
- Remove the VLAN Tag from frames before forwarding to host. This option checks for a VLAN Tag even when there are
- no VLAN related conditions.
-
- TagTX Insert a given VLAN Tag into frames before transmission over powerline. This action requires option -T to specify
- the tag and option -V to specify the CSPEC version.
-
-OPERANDS
- The operand indicates the logical relationship that must exist between conditions in the rule set before the action is
- applied to a frame. Operands are expressed as discrete alphanumeric strings entered in upper, lower or mixed character
- case. Failure to enter a known operand will result in an error message that lists permitted operands. They are positon
- sensitive. One operand is allowed and it must appear after the action and before any condition.
-
- Any Apply the action to frames that satisfy any of the conditions. This is equivalent to the logical or operation.
-
- All Apply the action to frames that satisfy all of the conditions. This is equivalent to the logical and operation.
-
- Always Apply the action to all frames. All conditions are ignored.
-
-CONDITIONS
- A condition consists of a field, an operator and a value. One condition is required but three are permitted. Condition
- order is not important but all conditions must appear after the operand and before the control.
-
- field The field is the part of the Ethernet frame to be examined. Some fields are not valid for some actions but this
- program does not enforce such rules since validation is performed by runtime firmware on each device. Recognized
- fields are listed and described under FIELDS.
-
- operator
- The operator specifies the relationsip that must exist between the field and value in order for the condition to
- evaluate True. Currently, only equality operators are supported. Valid operators are listed and described under
- OPERATORS.
-
- value The value must be appropriate to the field type. Some fields are MAC or IP addresses, some are integers, some are
- bitmaps and others are states. Integers and bitmaps may be expressed in binary, decimal or hexadecimal format.
- Binary values staRt with 0b. Hexadecimal values start with 0x. States are expressed using keywords. Users are
- responsible for knowing how many bits are significant for each type of value. Valid values are described along
- with fields under FIELDS.
-
-FIELDS
- Fields indicate the portion of the frame that is inspected during selection and the size and format of the value permited
- in the condition statement. They are expressed as discrete alphanumeric strings entered in upper, lower or mixed charac‐
- ter case. Failure to enter a known field will result in an error message that lists permitted fields.
-
- ET A 16-bit Ethertype expressed in hexadecimal with optional "0x" prefix. The format is described in IEEE Standard
- 802-2001 [4].
-
- EthDA A 48-bit Ethernet destination address expressed in hexadecimal. Octets may be separated with optional colons for
- clarity. The format is described in IEEE Standard 802-2001 [4].
-
- EthSA A 48-bit Ethernet source address expressed in hexadecimal. Octets may be separated with optional colons for clar‐
- ity. The format is described in IEEE Standard 802-2001 [4].
-
- IPSP A 16-bit IP source port expressed as a decimal integer. This condition applies to either TCP or UDP packets,
- depending on the protocol used, and is valid only for actions "CAP0", "CAP1", "CAP2", "CAP3" and "Drop".
-
- IPDP A 16-bit IP destination port expressed as a decimal integer. This condition applies to either TCP or UDP packets,
- depending on the protocol used, and is valid only for actions "CAP0", "CAP1", "CAP2", "CAP3" and "Drop".
-
- IPV4TOS
- An 8-bit Type-of-Service code where the format is defined in the RFC 791 (Internet Protocol) [14].
-
- IPV4PROT
- An 8-bit Ethernet protocol code. The format is defined in the RFC 791 (Internet Protocol) [14].
-
- IPV4SA A 32-bit Internet Protocol source address expressed in dotted-decimal notation. The official format is defined in
- RFC 791 (Internet Protocol) [14]. Our implementation permits empty octets and leading zeros within fields. For
- example, "..." is equivalent to "0.0.0.0 and "127..000.001" is equivalent to "127.0.0.1".
-
- IPV4DA A 32-bit Internet Protocol destination address expressed in dotted-decimal notation. The official format is
- defined in RFC 791 (internet Protocol) [14]. Our implementation permits empty octets and leading zeros within
- fields. For example, "..." is equivalent to "0.0.0.0 and "127..000.001" is equivalent to "127.0.0.1".
-
- IPV6TC An 8-bit Internet Protocol V6 traffic class expressed as defined in RFC 2460 (Internet Protocol Version 6) [17].
-
- IPV6FL A 24-bit IPV6 flow label where the lower 20 bits are the IPv6 Flow Label defined in RFC 2460 (Internat Protocol
- Version 6) [17]. The upper 4 bits should be zero. The value can be entered either as a decimal, binary or hex
- integer.
-
- IPV6SA A 128-bit IPV6 source address expressed as colon-separated hexadecmial quartets (octet pairs). The official for‐
- mat is defined in RFC 2460 (Internet Protocol Version 6) [17]. Our implementation permits multiple empty fields,
- abreviated fields and leading zeros within fields. When multiple empty fields appear, the right-most occurance
- expands to multiple zeros. For example, "AAAA::BBBB::CCCC" is equivalent to
- "AAAA:0000:BBBB:0000:0000:0000:0000:CCCC".
-
- IPV6DA A 128-bit IPV6 destination address expressed as colon-separated hexadecimal quartets (octet pairs). The official
- format is defined in RFC 2460 (Internet Protocol Version 6) [17]. Our implementation permits multiple empty
- fields, abbreviated fields and leading zeros within fields. When multiple empty fields appear, the right-most
- occurance expands to zeros. For example, ":1::2" is equivalent to "0000:0001:0000:0000:0000:0000:0000:0002".
-
- MME A 24-bit Atheros HomePlugAV Management Message type expressed as a hex byte stream. For clarity, the recommeded
- format it "xx:xxxx". The first byte is the MMV. The next two bytes are the MMTYPE. Both are defined in the
- HomePlug AV Specification. The MMTYPE will match all MME variants, such as Request, Confirm, Indicate and
- Response because the lower two bits are ignored. This field is only valid for action "Boost".
-
- TCPAck The string "True" or "False" to indicate that the frame is (or is not) a TCP Acknowledgement. Double negatives
- are allowed so "Is True" is equvalent to "Not False" and "Is False" is equivalent to "Not True".
-
- TCPSP A 16-bit TCP source port as a decimal integer. The format is defined in RFC 793 (Transmission Control Protocol
- [15]).
-
- TCPDP A 16-bit TCP destination port expressed as a decimal integer. The format is defined in RFC 793 (Transmission Con‐
- trol Protocol [15]).
-
- UDPSP A 16-bit UDP source port expressed as a decimal integer. The format is defined in RFC 768 (User Datagram Protocol
- [13]).
-
- UDPDP A 16-bit UDP destination port expressed as a decimal integer. The format is defined in RFC 768 (User Datagram
- Protocol [13]).
-
- VLANID A 16-bit VLAN identifier where the lower 12 bits are the VLAN Identifier (VID) defined in IEEE Std 802.1Q-1998
- (Virtual Bridged Local Area Networks) [11]. The upper 4 bits should be zero.
-
- VLANUP An 8-bit Ethernet VLAN tag where the lower 3 bits are the User Priority sub-field of a VLAN Tag defined in IEEE
- Std 802.1Q-1998 (Virtual Bridged Local Area Networks) [11]. The upper 5 bits should be zero.
-
- VLANTag
- The string "Present" or "Missing" to indicate the presence (or absence) of one or more VLAN Tags within a frame.
- This classifier is essentially equivalent to "ET Is 0x8100". Double negatives are allowed so "Is Present" is
- equivalent to "Not Missing" and "Is Missing" is equivalent to "Not Present".
-
-OPERATORS
- An operator indicates an equality between a field and a value. An operator is an alphanumeric string entered in upper,
- lower or mixed character case. Failure to enter a known operator will result in an error message that lists permitted
- operators. Operators are position sensitive and must appear between each field and value.
-
- Is Indicates that the frame field must equal the associated value for the condition to evaluate true.
-
- Not Indicates that the frame field must not equal the associated value for the condition to evaluate true.
-
-STATES
- A state is a special case of value.
-
- True,On,Yes,Present
- Indicates a positive state or presence of some entity. All are equivalent and can be used interchangeably. Dou‐
- ble negatives are permitted so "Is True" is equvalent to "Not False".
-
- False,Off,No,Missing
- Indicates a negative state or absence of some entity. All are equivalent and can be used interchangeably. Double
- negatives are permitted so "Is False" is equvalent to "Not True".
-
-CONTROLS
- The control determines how the devices will handle the rule after it is validated. It is expressed as a discrete
- alphanumeric string entered in upper, lower or mixed character case. Failure to enter a known control will result in an
- error message that lists permitted controls. The control is position sensitive and must occur after condition and before
- volatility.
-
- Add Adds the rule to the current list of rules unless a violation occurs. In some cases, a rule may replace an exist‐
- ing rule instead of being added.
-
- Rem,Remove
- Remove the rule from the current list of rules unless a violation occurs.
-
-VOLATILITY
- The volatility determines which device rule set will be affected by the action. It is expressed as a discrete alphanu‐
- meric string entered in upper, lower or mixed character case. Failure to enter a known volatility will result in an
- error message that lists permitted volatilities. The volatility is position sensitive and must occur after control.
-
- Temp The temporary rule set will be modified. The temporary rule set resides in the working PIB stored in SDRAM.
-
- Perm The permanent rule set will be modified. The permanent rule set resides in the user PIB stored in NVRAM.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information is not available. Qualcomm Atheros reserves the right to modify message structure
- or content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- This command adds a temporary classification rule to the classification table on device B00:B0:52:BA:BE:01. The rule
- instructs the device to drop frames that match either (any) of two conditions. The first condition states that the IPv4
- source address is 192.168.99.2. The second conditon states that the IPv4 destination address is 192.168.99.100.
-
- # amprule drop any IPv4SA is 192.168.99.2 IPv4DA is 192.168.99.100 add temp 00:B0:52:BA:BE:01
-
- Observe that the action, operand and conditions come first then the control and volatility then the affected devices. Up
- to three conditions may be specified. Keyword order is important. Character case is not important.
-
- The following example prints a list of programmed keywords on stdout for reference. The example shown here has been
- abbreviate due to formatting limitations.
-
- # amprule -t
-
- Controls are 'Add'|'Rem'|'Remove'
- Volatilities are 'Temp'|'Perm'
- Actions are 'CAP0'|'CAP1'|'CAP2'|'CAP3'|'Boost'|...|'StripTX'|'StripRX'|'TagRX'
- Operands are 'All'|'Any'|'Always'
- Fields are 'EthDA'|'EthSA'|'VLANUP'|'VLANID'|'IPv4TOS'|...|'TCPAck'|'VLANTag'
- Operators are 'Is'|'Not'
-
- More example follow:
-
- Ethernet Address Rules
-
- Ethernet address rules have the following general format:
-
- | CAP0 | ANY | EthSA | IS | xx:xx:xx:xx:xx:xx | ADD | TEMP | xx:xx:xx:xx:xx:xx
- | CAP1 | ALL | EthDA | NOT | | REMOVE | PERM |
- | CAP2 |
- | CAP3 |
- | DROP |
-
- For example, instruct device 00:B0:52:BA:BE:FF to temporarily add a rule to forward frames from 00:2B:FE:CA:FE:BA at
- CAP3. Observe Ethernet hardware addresses are used both in the condition and for the affected powerline devices.
-
- # amprule cap3 any ethsa is 00:2b:fe:ca:fe:ba add temp 00:b0;52:ba:be:ff
-
- IP Address Rules
-
- IP address rules have the following general format:
-
- | CAP0 | ANY | IPv4SA | IS | ddd.ddd.ddd.ddd | ADD | TEMP | xx:xx:xx:xx:xx:xx
- | CAP1 | ALL | IPv4DA | NOT | | REMOVE | PERM |
- | CAP2 |
- | CAP3 |
- | DROP |
-
- For example, instruct device 00:B0:52:BA:BE:FF to permanently remove the rule that drops packets from 192.168.99.1.
- Notice that the IP address is specified in dotted decimal format but the device address is specified in hexadecimal octet
- format. Dotted decimal format permits empty and variable length octets but octet delimiters are mandatory. Hexadecimal
- octet format requires fixed length octets but octet delimiters are optional.
-
- # amprule drop any ipv4sa is 192.168.99.1 remove perm 00:b0:52:ba:be:ff
-
- IP Protocol Rules
-
- IP protocol rules have the following general format:
-
- | CAP0 | ANY | IPv4PROT | IS | xxxx | ADD | TEMP | xx:xx:xx:xx:xx:xx
- | CAP1 | ALL | | NOT | | REMOVE | PERM |
- | CAP2 |
- | CAP3 |
- | DROP |
-
- For example, to instruct device 00:B0:52:BA:BE:FF to permanently add a rule to forward non-IP packets at CAP2. In this
- example, delmiters have been omitted from the device Ethernet address.
-
- # amprule CAP2 all ipv4prot not 0x0800 add perm 00b052babeff
-
-SEE ALSO
- plc(1), amprate(1), ampstat(1), amptone(7)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 amprule(1)
-
-ampstat(1) Qualcomm Atheros Open Powerline Toolkit ampstat(1)
-
-NAME
- ampstat - Qualcomm Atheros AR7x00 Link Statistics
-
-SYNOPSIS
- ampstat [options] [device] [device] [...]
-
-DESCRIPTION
- The Atheros Device Statistics Utility polls a device and prints network and link statistics in various formats suitable
- for use by other programs. This is a work in progress so user feedback is encouraged. Link statistics are only valid
- between one powerline device and another.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-COMMENTS
- This program is identical to legacy program int6kstat but uses version 1 of the Qualcomm Atheros VS_NW_INFO Atheros ven‐
- dor-specific message. Older firmware versions may not recognize this message version.
-
-OPTIONS
- -C Clear device link statistics using VS_LNK_STATS. Statistics are read and cleared then displayed. The statistics
- that are read and displayed depend on options -d, -p and -s but all link statistics are cleared.
-
- -d direction
- Return statistics for the specified direction using VS_LNK_STATS. Direction can be 0=tx, 1=rx, 2=both or "rx",
- "tx" or "both".
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -l count
- Define the number of times that the command will be repeated for each device specified. Normally, you will repeat
- operations on one device only.
-
- -m Displays network membership information, as seen by one device, using VS_NW_INFO. Use option -t for complete net‐
- work topology seen by the local host.
-
- -p peernode
- Ethernet hardware address of the peer node for VS_LNK_STATS. This option is required for all Link ID values
- except 0xFC. The default is 00:00:00:00:00:00.
-
- -q Enter quiet mode. Progress messages are suppressed.
-
- -s linkid
- The Link ID for VS_LNK_STATS. Link ID values range from 0 through 255 but not all values are accepted by the
- device firmware. Values may be expressed in decimal, binary prefixed with "0b" or hexadecimal prefixed by "0x".
- Many valid values can be expressed by name. Valid values are listed and explained under LINKID. The default Link
- ID is 0xFC.
-
- -t Display network topology using VS_SW_VER and VS_NW_INFO messages. This option is similar to option -m but pro‐
- vides complete network topology plus device hardware and firmware version. Topology is always relative to the
- local host, or local hosts if present. Powerline devices that appear on the command line are not used for this
- operation. Older QCA powerline devices may fail to respond to this this option. In that event, use program
- int6kstat or plcstat.
-
- -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
-
- -w seconds
- Defines the number of seconds to wait before repeating command line options. This option has no effect unless
- option -l is also specified with a non-zero value.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-LINKID
- 0x00,CSMA-CAP0
- Display CSMA statistics for CAP0 traffic using a single peer node. The peer node MAC address must be specified
- using option -p.
-
- 0x01,CSMA-CAP1
- Display CSMA statistics for CAP1 traffic using a single peer node. The peer node MAC address must be specified
- using option -p.
-
- 0x02,CSMA-CAP2
- Display CSMA statistics for CAP2 traffic using a single peer node. The peer node MAC address must be specified
- using option -p.
-
- 0x03,CSMA-CAP3
- Display CSMA statistics for CAP3 traffic using a single peer node. The peer node MAC address must be specified
- using option -p.
-
- 0xF8,CSMA-PEER
- Display CSMA statistics for all traffic using a single peer node. The peer node MAC address must be specified
- using option -p.
-
- 0xFC,CSMA-ALL
- Display CSMA statistics for all traffic with all peer nodes. A peer node MAC address is not needed and will be
- ignored if provided. This value is the default for option -s.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-EXAMPLES
- None.
-
-SEE ALSO
- plc(1), amplist(1), amprate(1), ampstat(1), amptone(1), amptool(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 ampstat(1)
-
-amptest(1) Qualcomm Atheros Open Powerline Toolkit amptest(1)
-
-NAME
- amptest - Qualcomm Atheros PLC Test Applet Loader
-
-SYNOPSIS
- amptest [options] [file] [file] [...]
-
-DESCRIPTION
- Download and execute one or more test applets on the local Qualcomm Atheros PLC device. An applet is a small firmware
- image that can be started by the bootloader and that returns to the bootloader when done. This program is an alternative
- to program int6ktest but has been replaced by program plctest.
-
- A Qualcomm Atheros firmware image file may contain one or more applets. Each applet is preceded by a header that speci‐
- fies the image size, load address and start address. Program amptest sequentially downloads and executes each applet
- found in each image file specified on the command line. It waits for each applet to complete before downloading and exe‐
- cuting the next one. The program terminates once all applets in all files have been executed or some applet fails to
- complete within 60 seconds.
-
- Most applets return to the Bootloader on successful completion so that another applet can be downloaded and executed.
- This allows applet chains to be executed using one command. A chain may consist of one file containing multiple applets
- or multiple files each containing one applet or any combination of single and multiple applet files. The chain will
- break, after a timeout, if any applet in the chain fails to return to the Bootloader in time. Failure to return in time
- may be either a good thing or a bad thing depending on applet design.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the APT man page for an overview and installation
- instructions.
-
-COMMENTS
- The Qualcomm Atheros Powerline Toolkit contains a set of legacy applets in folder applets. These were designed for use
- with program int6ktest and most will not display console messages properly using this program. A new series of compati‐
- ble applets are under development and should be available through Atheros Field Application Engineering.
-
- Assuming a good set of applets are available, this program is ideal for testing reference designs for performance and
- production units for defects. Applets may become available for testing onboard connections, memory integrity and noise
- immunity. Consult with Atheros Field Application Engineering for applet availability.
-
-OPTIONS
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -l Sequentially execute and re-execute all applets in all files on the command line until the program is terminated
- with ^C.
-
- -q Suppresses normal progress and status messages.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -v Print additional information on stdout. Specifically, this option prints incoming and outgoing frames in hexadec‐
- imal format on stdout. Output can be directed to a text file for analysis.
-
- -w seconds
- Application timeout in seconds. This application will wait this long for an applet to terminate and return to the
- bootloader before reporting an error and proceeding to the next applet.
-
- -x Cause the program to exit on the first error instead of moving on to the next applet. Error exits return a non-
- zero value to the shell.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of an Atheros image file. The image file may contain one or more images. Each image will be downloaded
- and executed in turn until all images are executed or an image fails to return to the Bootloader within 1 minute
- for some reason.
-
-EXAMPLES
- The following example sequentially downloads then executes each image in file abc.nvm in turn. Each image must complete
- and return to the bootloader before the next one downloads. Observe that no device address is needed because Atheros
- powerline devices use address 00:b0:52:00:00:01 when in bootloader mode.
-
- # amptest abc.nvm
-
- The following example will sequentially download and execute the images in each file abc.nvm, def.nvm and ghi.nvm in
- turn.
-
- # amptest abc.nvm def.nvm ghi.nvm
-
-DISCLAIMER
- Atheros image file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public informa‐
- tion is not available. Qualcomm Atheros reserves the right to change file structure or content in future firmware
- releases without any obligation to notify or compensate users of this program. This program is reserved for use by
- Atheros Field Engineers. Use of this program may void some contractual obligations made by Atheros.
-
-SEE ALSO
- APT(1), chknvm(1), chknvm2(1), int6ktest(1), nvmsplit(1), nvmmerge(1), plctest(1), setnvm(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 amptest(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- *
- * amptone.c -
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <unistd.h>
-#include <stdlib.h>
-#include <stdint.h>
-#include <limits.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#include "../tools/getoptv.h"
-#include "../tools/putoptv.h"
-#include "../tools/memory.h"
-#include "../tools/symbol.h"
-#include "../tools/number.h"
-#include "../tools/types.h"
-#include "../tools/flags.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-/*====================================================================*
- * custom source files;
- *--------------------------------------------------------------------*/
-
-#ifndef MAKEFILE
-#include "../plc/Devices.c"
-#include "../plc/Failure.c"
-#include "../plc/ReadMME.c"
-#include "../plc/SendMME.c"
-#include "../plc/ToneMaps2.c"
-#include "../plc/SignalToNoise2.c"
-#endif
-
-#ifndef MAKEFILE
-#include "../tools/error.c"
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-#include "../tools/uintspec.c"
-#include "../tools/hexdump.c"
-#include "../tools/hexencode.c"
-#include "../tools/hexdecode.c"
-#include "../tools/hexstring.c"
-#include "../tools/todigit.c"
-#include "../tools/synonym.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/QualcommHeader1.c"
-#include "../mme/UnwantedMessage.c"
-#include "../mme/MMECode.c"
-#endif
-
-/*====================================================================*
- * program variables;
- *--------------------------------------------------------------------*/
-
-static const struct _term_ couple [] =
-
-{
- {
- "alt",
- "1"
- },
- {
- "pri",
- "0"
- }
-};
-
-/*====================================================================*
- *
- * int main (int argc, char const * argv[]);
- *
- * parse command line, populate plc structure and perform selected
- * operations; show help summary if asked; see getoptv and putoptv
- * to understand command line parsing and help summary display; see
- * plc.h for the definition of struct plc;
- *
- * the command line accepts multiple MAC addresses and the program
- * performs the specified operations on each address, in turn; the
- * address order is significant but the option order is not; the
- * default address is a local broadcast that causes all devices on
- * the local H1 interface to respond but not those at the remote
- * end of the powerline;
- *
- * the default address is 00:B0:52:00:00:01; omitting the address
- * will automatically address the local device; some options will
- * cancel themselves if this makes no sense;
- *
- * the default interface is eth1 because most people use eth0 as
- * their principle network connection; you can specify another
- * interface with -i or define environment string PLC to make
- * that the default interface and save typing;
- *
- *
- *--------------------------------------------------------------------*/
-
-int main (int argc, char const * argv [])
-
-{
- extern struct channel channel;
- static char const * optv [] =
- {
- "ehi:p:qst:vx",
- "node peer [> stdout]",
- "Qualcomm Atheros Thunderbolt/Lightning Tone Map Dump",
- "e\tredirect stderr to stdout",
- "h\tprint mean-square histogram",
-
-#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
-
- "p n\tcoupling [" LITERAL (PLCOUPLING) "]",
- "q\tquiet mode",
- "s\tcompute signal-to-noise and bits-per-carrier ratios",
- "t n\tread timeout is (n) milliseconds [" LITERAL (CHANNEL_TIMEOUT) "]",
- "v\tverbose mode",
- "x\texit on error",
- (char const *) (0)
- };
-
-#include "../plc/plc.c"
-
- signed (* function) (struct plc *) = ToneMaps2;
- signed c;
- plc.action = PLCOUPLING;
- if (getenv (PLCDEVICE))
- {
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (getenv (PLCDEVICE));
-
-#else
-
- channel.ifname = strdup (getenv (PLCDEVICE));
-
-#endif
-
- }
- optind = 1;
- while ((c = getoptv (argc, argv, optv)) != -1)
- {
- switch (c)
- {
- case 'p':
- plc.coupling = (unsigned)(uintspec (synonym (optarg, couple, SIZEOF (couple)), 0, UCHAR_MAX));
- break;
- case 'e':
- dup2 (STDOUT_FILENO, STDERR_FILENO);
- break;
- case 'h':
- _setbits (plc.flags, PLC_GRAPH);
- break;
- case 'i':
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (optarg);
-
-#else
-
- channel.ifname = optarg;
-
-#endif
-
- break;
- case 'q':
- _setbits (channel.flags, CHANNEL_SILENCE);
- _setbits (plc.flags, PLC_SILENCE);
- break;
- case 's':
- _setbits (plc.flags, PLC_ANALYSE);
- function = SignalToNoise2;
- 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 'x':
- _setbits (plc.flags, PLC_BAILOUT);
- break;
- default:
- break;
- }
- }
- argc -= optind;
- argv += optind;
- if (!argc || !argv)
- {
- error (1, ECANCELED, "No node address given");
- }
- if (!hexencode (channel.peer, sizeof (channel.peer), synonym (* argv, devices, SIZEOF (devices))))
- {
- error (1, errno, PLC_BAD_MAC, * argv);
- }
- argc--;
- argv++;
- if (!argc || !argv)
- {
- error (1, ECANCELED, "No peer address given");
- }
- if (!hexencode (plc.RDA, sizeof (plc.RDA), synonym (* argv, devices, SIZEOF (devices))))
- {
- error (1, errno, PLC_BAD_MAC, * argv);
- }
- argc--;
- argv++;
- openchannel (&channel);
- if (!(plc.message = malloc (sizeof (* plc.message))))
- {
- error (1, errno, PLC_NOMEMORY);
- }
- function (&plc);
- free (plc.message);
- closechannel (&channel);
- return (0);
-}
-
-
-
-amptool(1) Qualcomm Atheros Open Powerline Toolkit amptool(1)
-
-NAME
- amptool - Qualcomm Atheros AR7x00 Powerline Device Manager
-
-SYNOPSIS
- amptool [options] [device] [device] [...]
-
-DESCRIPTION
- This version of the Qualcomm Atheros Device Manager for Linux performs basic operations on Atheros AR7400 devices using
- the raw Ethernet protocol described in the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual. It can be
- used to interrogate and control devices or upgrade firmware if on-board NVRAM is present.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. It supports chipset AR7400 and QCA7450. See plctool to
- support QCA6410, QCA7000 and QCA7420 devices. See the plc man page for an overview and installation instructions.
-
-COMMENTS
- This program version is identical to legacy program int6k except for option -m which uses version 1 of the Qualcomm
- Atheros VS_NW_INFO vendor-specific message. Older firmware versions may not recognize this message version.
-
-OPTIONS
- -a Read device attributes using VS_OP_ATTRIBUTES. Attributes are short strings and integers that describe device
- hardware and firmware. They are concatenated to form the output that is similar to option -r but derived differ‐
- ently.
-
- -B action
- Press the simple connect pushbutton using VS_PB_ENC. The action can be specified by number 1, 2, 3 or 4 or by
- symbol "join", "leave", "status" or "reset", respectively. Use 1 on both devices that are expected to join. Use
- 2 only on the device that is expected to leave the network.
-
- -C module
- Commit (flash) downloaded modules to NVRAM using VS_MOD_NVM. The module can be spedified by number 1, 2 or 3 or
- by symbol "nvm", "pib" or "all", repectively. Module 3 is equivalent to option -F which writes the NVM and PIB
- together. You cannot force flash NVRAM using this option. Use option -FF to force flash.
-
- -d filename
- Read Watchdog Report from the device and write it to the named file in binary format using VS_WD_RPT. The report
- file can be sent to Qualcomm Atheros for technical analysis. No assumptions are made based on filename and no
- filename convetions are enforced; however, you should use a .log file extension to indicate binary format.
-
- -D xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx
- Define the 16 octet Device Access Key (DAK) in hex format. The DAK is used by option -J. It may also be set to
- "key1" or "key2" as explained in the KEYS section.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -f Read flash memory parameters using VS_GET_NVM. An error will be reported if no flash memory is present.
-
- -F[F] Write previously downloaded MAC and PIB to NVRAM using VS_MOD_NVM. Adding a second F here or another -F anywhere
- on the command line will force-flash a blank or corrupted NVRAM. Firmware loaded from NVRAM will treat force-
- flash as an error. This option can be used to create factory settings but cannot be used to change them once cre‐
- ated. Subsequent use creates and updates operational settings that can be erased using a factory reset. This
- option is executed after all others on the command line, except for the -R option.
-
- -g Read multicast group information discovered while IGMP snooping using VS_MULTICAST_INFO.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -I Read the device PIB header using VS_RD_MOD and print the firmware major revision number, PIB minor revision num‐
- ber, Device Access Key (DAK), Network Membership Key (NMK), MAC address and other information on stdout. The val‐
- ues displayed can be changed using program modpib.
-
- -J xx:xx:xx:xx:xx:xx
- Set the Network Membership Key (NMK) on a remote device using VS_SET_KEY. This option is similar to option -K but
- requires the remote device MAC and DAK in addition to the NMK and local device MAC address. The NMK value is
- defined using option -K unless you want to use the default value. The remote DAK is defined using option -D
- unless you want to use the default value. Programming remote device keys is complicated. It is often easier to
- connect the device directly to the host and use the -K option.
-
- -K xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx
- Define the Network Membership Key (NMK) value used by options -M or -J. The symbolic names "key1" and "key2" are
- recognized as described in the KEY section.
-
- -l count
- Define the number of times that the command will be repeated for each device specified. Normally, you will repeat
- operations on one device only.
-
- -m Read network membership information using VS_NW_INFO. This can be used to determine network configuration.
-
- -M Set the Network Membership Key (NMK) on the local device using VS_SET_KEY. The NMK value is specified using the
- -K option unless you want to use the default value.
-
- -n filename
- Read firmware from the device SDRAM and write it to the named .nvm file using multiple VS_RD_MOD messages. No
- assumptions are made based on filename and no filename conventions are enforced. This option is performed before
- option -N when both are specified.
-
- -N filename
- Read the named .nvm file and write it to the device using multiple VS_WR_MOD messages. No assumptions are made
- based on filename and no filename conventions are enforced; however, files having invalid .nvm format will be
- rejected. This option is executed after -n when both are specified.
-
- -p filename
- Read parameters from the device SDRAM and write them to the named .pib file using multiple VS_RD_MOD messages. No
- assumptions are made based on filename and no filename convetions are enforced. This option is executed before
- option BP when both are specified.
-
- -P filename
- Read the named .pib file and write it to the device using multiple VS_WR_MOD messages. No assumptions are made
- based on filename and no filename conventions are enforced; however, files having invalid .pib format will be
- rejected. This option is executed after -p when both are specified.
-
- -q Suppresses status messages on stderr.
-
- -Q Quick flash. The program will not wait for a device to reset or the firmware to restart after writing flash mem‐
- ory. This option is desirable with newer firmware that writes flash memory in the background. It has no effect
- unless used with option -F or -C.
-
- -r Read device firmware and hardware revision using VS_SW_VER. Output is similar to option -a but is derived differ‐
- ently.
-
- -R Reset the device using VS_RS_DEV. This option is executed after all others on the same command line.
-
- -s Read device SDRAM configuration using VS_RD_CBLOCK.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -T Restore factory defaults. This permanently erases all PIB changes made since the device was last programmed with
- factory default settings. The device will automatically reset and reboot.
-
- -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
- be saved as text files for reference.
-
- -w seconds
- Defines the number of seconds to wait before repeating command line options. This option has no effect unless
- option -l is also specified with a non-zero value.
-
- -x Cause the program to exit on the first error instead of continuing with remaining iterations, operations or
- devices. Normally, the program reports errors and moves on to the next operation, iteration or device depending
- on the command line.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The Ethernet hardware address of some powerline device. More than one address may be specified on the command
- line. If more than one address is specified then operations are performed on each device in turn. The default
- address is local. as explained in the DEVICES section.
-
-KEYS
- Passwords are variable length character strings that end-users can remember. Keys are fixed length binary values created
- by encrypting passwords. There are two encryption algorithms for HomePlugAV. One for DAKs and the other for NMKs. This
- means that a given password will produce different keys depending on use. This program only deals with keys because that
- is what powerline devices recognize. The passwords that generated the keys are irrelevant here.
-
- Encryption keys are tedious to type and prone to error. For convenience, symbolic names have been assigned to common
- encryption keys and are recognized by options -D and -K.
-
- key1 Key for encrypted password "HomePlugAV". This is "689F074B8B0275A2710B0B5779AD1630" for option -D and
- "50D3E4933F855B7040784DF815AA8DB7" for option -K.
-
- key2 Key for encrypted password "HomePlugAV0123". This is "F084B4E8F6069FF1300C9BDB812367FF" for option -D and
- "B59319D7E8157BA001B018669CCEE30D" for option -K.
-
- none Always "00000000000000000000000000000000".
-
-DEVICES
- Powerline devices use Ethernet hardware, or Media Access Control (MAC), addresses. Device addresses are 12 hexadecimal
- digits (0123456789ABCDEFabcdef) in upper, lower or mixed case. Individual octets may be separated by colons, for clar‐
- ity, but not all octets need to be seperated. For example, "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are
- valid and equivalent.
-
- These symbolic addresses are recognized by this program and may be used instead of the actual address value.
-
- all Equivalent to "broadcast", described next.
-
- broadcast
- A synonym for the standard Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or
- foreign will respond to this address.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices will recognize this address but remote and foreign devices will not. A remote device is any
- device at the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure or content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- # amptool -n old.nvm -p old.pib -N new.nvm -P new.pib -F 01:23:45:67:89:AB
-
- Performs 5 operations on one device. Uploads the firmware and PIB from the device and writes them to files old.nvm and
- old.pib, respectively. Reads files new.nvm and new.pib and downloads them as new firmware and PIB, respectively. Com‐
- mits the downloaded firmware and PIB to NVRAM. Operations are executed in the order just described regardless of the
- order specified on the command line. If you want reading and writing to occur in a different order then you must use two
- or more commands to accomplish tasks in the order you want.
-
- # amptool -N new.nvm 01:23:45:67:89:28
- # amptool -P new.pib 01:23:45:67:89:28
- # amptool -C 3 01:23:45:67:89:28
-
- It is not neccessary to specify all operations on one command line. The three command lines above do essentially the
- same thing as the command line shown in the previou example. Notice that this example uses -C 3, instead of -F, as an
- alternate way to write MAC and PIB to NVRAM. Specifying -C 1, instead, would write the .nvm file only. Specifying, -C
- 2, instead, would write the .pib file only. The value 3 is the logical OR of 1 and 2.
-
- # amptool -N new.nvm -P new.pib -FF local
-
- Downloads file new.nvm and file new.pib and force flashes the local device. Force flashing only works on running
- firmware that has been downloaded and stated by the Qualcomm Atheros Boot Loader. See amptoolf to download, start
- firmware and perform a force flash in one operation.
-
- # amptool -MK key1
- # amptool -M
-
- These two commands are equivalent. They set the NMK on the local device to key1 as descripted in the KEYS section. The
- first command resets the NMK on the local device with -M then specifies the NMK as key1. The second command omits the
- key specification since key1 is the program default NMK. One could, of course, type the encryption key.
-
-SEE ALSO
- plc(1), ampboot(1), ampboot(1), amphost(1), int6kid(1), amprate(1), amprule(1), ampstat(1), ampwait(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 amptool(1)
-
-ampwait(1) Qualcomm Atheros Open Powerline Toolkit ampwait(1)
-
-NAME
- ampwait - Qualcomm Atheros Powerline Procrastinator
-
-SYNOPSIS
- ampwait [options] [device] [device] [...]
-
-DESCRIPTION
- Poll a Qualcomm Atheros powerline device, waiting for one or more events to occur before continuing or returning. The
- events include reset or power off, restart or power on and network association. It is used to pause shell scripts at
- critical points where a device must be in a known state before continuing.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -a Poll the device every few seconds using VS_NW_INFO messages until the device indicates that a networks exists and
- has at least one station. This option can give false readings if other devices have dropped off-line and the
- device bridging table still holds information about them. The program always checks for this event last if other
- event options are specified.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -f firmware
- The identification string for firmware that should be running after the device starts. This option can be used to
- detect a failed firmware load. If the actual identification string does not match this one once the device starts
- then an error is reported. If option -x is present then the program terminates with a non-zero exit code. This
- option has no effect unless option -s is present. An identification string looks like
- "INT6000-MAC-3-1-3143-1690-20071107-FINAL-B" and can be obtained using int6k -r.
-
- -i Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -p seconds
- Fixed pause time in seconds. This adds an fixed delay after the other events have occured. A pause does not
- occur if any of the specified events timeout. When no other events are specified this option is effectively
- equivalent to sleep. This option can be used to allow the device or the network to settle. For example, a nomi‐
- nal 5 second wait is recommended after a device successfully associates before attempting to transfer data.
-
- -q Enter quiet mode. Progress messages are suppressed.
-
- -R Reset the device then check return status. Exit program on error if option -x is present; otherwise, repeat the
- reset request until the device either accepts the request or the wait time is exceeded.
-
- -s Poll the device every few seconds using VS_SW_VER messages until the bootloader or runtime firmware responds or
- the poll count exhausts. The presence of a response indicates that the device has either connected to the host,
- received power or finished reboot.
-
- -t milliseconds
- Channel read/write timeout in milliseconds. This is the maximum time allowed for a confirmation or a response
- from a powerline device before abandoning a read/write operation. Permitted values range from 0 through UINT_MAX
- as defined in limits.h. The default is 50 milliseconds.
-
- -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
-
- -w seconds
- Wait timeout in seconds. This is the maximum time that this application will wait for an event to occur where an
- event is reset, start or assoc. If an event does no occur within this time, the program proceeds to wait for the
- next specified event. This timeout applies to each event in turn when more than one event is specified. Permit‐
- ted values are 0 through 86400 seconds which is 24 hours.
-
- -x Exit program on first error with a non-zero exit code. This option allows shell scripts to detect failed or
- incomplete operations and take the appropriate action.
-
- -y Display actual wait times on stdout.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The Media Access Control (MAC) address of some device. Addresses are 6 hexadecimal octets optionally separated by
- colon. For example, the addresses "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are all valid and
- equivalent. For convenience, the symbolic address "local" resolves to "00:b0:52:00:00:01" and the symbolic
- addresses "all" and "broadcast" both resolve to "ff:ff:ff:ff:ff:ff".
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-EXAMPLES
- The following command polls the local device until firmware stops running then polls the device until firmware starts
- running again. This command can be inserted into a shell script at a point where the device must reset and reboot before
- proceeding. Observe that the program waits up to 60 seconds for each event, in turn, because 60 seconds is the default
- wait period. If an event occurs before the specified timeout the program will move on to the next event.
-
- # ampwait -rs
- eth0 00:B0:52:BA:BA:01 Allow 60 seconds for Reset
- eth0 00:B0:52:BA:BA:01 Allow 60 seconds for Start
-
- The following example waits up to 30 seconds for the local device to reset (-r) then up to 50 seconds for the local
- device to start (-s). This is the same as above but we have specified 30 seconds using option -w.
-
- # ampwait -r -s -w 30
- eth0 00:B0:52:BA:BA:01 Allow 30 seconds for Reset
- eth0 00:B0:52:BA:BA:01 Allow 30 seconds for Start
-
- The next example reports the actual amount of time taken for each event to occur. Observe that the last event, device
- association, did not occur within the allotted time.
-
- # ampwait -rsay
- eth0 00:B0:52:BA:BA:01 Allow 60 seconds for Reset
- etho 00:B0:52:BA:BA:01 Waited 22 seconds to Reset
- eth0 00:B0:52:BA:BA:01 Allow 60 seconds for Start
- etho 00:B0:52:BA:BA:01 Waited 4 seconds to Start
- eth0 00:B0:52:BA:BA:01 Allow 60 seconds for Assoc
- etho 00:B0:52:BA:BA:01 Waited 60 seconds for Assoc
- etho 00:B0:52:BA:BA:01 Device did not Assoc
-
- The following example illustrates use of the revision string to detect mismatched firmware. In this example, we reset
- the device first, using program amptool, then wait for it to reset then start up again. There are also operation that
- can cause the device to reset.
-
- # amptool -R
- # ampwait -xrsf INT6000-MAC-3-1-3143-1690-20071107-FINAL-B
- eth0 00:B0:52:BA:BA:01 Device started wrong firmware
-
- Immediately after a reset we wait for the firmware to stop responding, with option -r, and then start responding, with
- option -s, and then perform a string comparison against the actual firmware revision string, with option -f. If the
- strings do not match then an error is reported. In this case, the program will exit with a non-zero return code since
- option -x is present.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- amp(1), amptool(1), amphost(1), amprate(1), ampid(1), ampstat(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 ampwait(1)
-
-#!/bin/sh
-
-# ====================================================================
-# set serial port parameters on a Linux system;
-# --------------------------------------------------------------------
-
-stty -F /dev/ttyUSB1 1115200 cs8 -cstopb -ixon
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * baud_t baudrate (unsigned rate)
- *
- * convert integer baud rate to system constant or bitmap;
- *
- *
- * Contributor(s):
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef BAUDRATE_SOURCE
-#define BAUDRATE_SOURCE
-
-#include <termios.h>
-#include <errno.h>
-
-#include "../tools/error.h"
-
-signed baudrate (unsigned baud, speed_t * speed)
-
-{
- static struct baud
- {
- unsigned baud;
- speed_t code;
- }
- bauds [] =
- {
- {
- 0,
- B0
- },
- {
- 50,
- B50
- },
- {
- 75,
- B75
- },
- {
- 110,
- B110
- },
- {
- 134,
- B134
- },
- {
- 150,
- B150
- },
- {
- 200,
- B200
- },
- {
- 300,
- B300
- },
- {
- 600,
- B600
- },
- {
- 1200,
- B1200
- },
- {
- 1800,
- B1800
- },
- {
- 2400,
- B2400
- },
- {
- 4800,
- B4800
- },
- {
- 9600,
- B9600
- },
- {
- 19200,
- B19200
- },
- {
- 38400,
- B38400
- },
- {
- 57600,
- B57600
- },
- {
- 115200,
- B115200
- },
-
-#ifdef B230400
-
- {
- 230400,
- B230400
- },
-
-#endif
-#ifdef B460800
-
- {
- 460800,
- B460800
- },
-
-#endif
-#ifdef B500000
-
- {
- 500000,
- B500000
- },
-
-#endif
-#ifdef B921600
-
- {
- 921600,
- B921600
- },
-
-#endif
-
- };
- signed lower = 0;
- signed upper = sizeof (bauds) / sizeof (struct baud);
- while (lower < upper)
- {
- signed index = (lower + upper) >> 1;
- signed order = baud - bauds [index].baud;
- if (order < 0)
- {
- upper = index - 0;
- continue;
- }
- if (order > 0)
- {
- lower = index + 1;
- continue;
- }
- *speed = bauds [index].code;
- return (0);
- }
- return (-1);
-}
-
-#endif
-
-
-
-/*
- * Copyright (C) 1999 WIDE Project.
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. 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.
- * 3. Neither the name of the project nor the names of its contributors
- * may be used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE PROJECT 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 PROJECT 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.
- */
-#ifndef _BITTYPES_H
-#define _BITTYPES_H
-
-#define HAVE_U_INT8_T
-#ifndef HAVE_U_INT8_T
-
-#if SIZEOF_CHAR == 1
-typedef unsigned char u_int8_t;
-typedef signed char int8_t;
-#elif SIZEOF_INT == 1
-typedef unsigned int u_int8_t;
-typedef signed int int8_t;
-#else /* XXX */
-#error "there's no appropriate type for u_int8_t"
-#endif
-#define HAVE_U_INT8_T 1
-#define HAVE_INT8_T 1
-
-#endif /* HAVE_U_INT8_T */
-
-#ifndef HAVE_U_INT16_T
-
-#if SIZEOF_SHORT == 2
-typedef unsigned short u_int16_t;
-typedef signed short int16_t;
-#elif SIZEOF_INT == 2
-typedef unsigned int u_int16_t;
-typedef signed int int16_t;
-#elif SIZEOF_CHAR == 2
-typedef unsigned char u_int16_t;
-typedef signed char int16_t;
-#else /* XXX */
-#error "there's no appropriate type for u_int16_t"
-#endif
-#define HAVE_U_INT16_T 1
-#define HAVE_INT16_T 1
-
-#endif /* HAVE_U_INT16_T */
-
-#ifndef HAVE_U_INT32_T
-
-#if SIZEOF_INT == 4
-typedef unsigned int u_int32_t;
-typedef signed int int32_t;
-#elif SIZEOF_LONG == 4
-typedef unsigned long u_int32_t;
-typedef signed long int32_t;
-#elif SIZEOF_SHORT == 4
-typedef unsigned short u_int32_t;
-typedef signed short int32_t;
-#else /* XXX */
-#error "there's no appropriate type for u_int32_t"
-#endif
-#define HAVE_U_INT32_T 1
-#define HAVE_INT32_T 1
-
-#endif /* HAVE_U_INT32_T */
-
-#ifndef HAVE_U_INT64_T
-#if SIZEOF_LONG_LONG == 8
-typedef unsigned long long u_int64_t;
-typedef long long int64_t;
-#elif defined(_MSC_EXTENSIONS)
-typedef unsigned _int64 u_int64_t;
-typedef _int64 int64_t;
-#elif SIZEOF_INT == 8
-typedef unsigned int u_int64_t;
-#elif SIZEOF_LONG == 8
-typedef unsigned long u_int64_t;
-#elif SIZEOF_SHORT == 8
-typedef unsigned short u_int64_t;
-#else /* XXX */
-#error "there's no appropriate type for u_int64_t"
-#endif
-
-#endif /* HAVE_U_INT64_T */
-
-#ifndef PRId64
-#ifdef _MSC_EXTENSIONS
-#define PRId64 "I64d"
-#else /* _MSC_EXTENSIONS */
-#define PRId64 "lld"
-#endif /* _MSC_EXTENSIONS */
-#endif /* PRId64 */
-
-#ifndef PRIo64
-#ifdef _MSC_EXTENSIONS
-#define PRIo64 "I64o"
-#else /* _MSC_EXTENSIONS */
-#define PRIo64 "llo"
-#endif /* _MSC_EXTENSIONS */
-#endif /* PRIo64 */
-
-#ifndef PRIx64
-#ifdef _MSC_EXTENSIONS
-#define PRIx64 "I64x"
-#else /* _MSC_EXTENSIONS */
-#define PRIx64 "llx"
-#endif /* _MSC_EXTENSIONS */
-#endif /* PRIx64 */
-
-#ifndef PRIu64
-#ifdef _MSC_EXTENSIONS
-#define PRIu64 "I64u"
-#else /* _MSC_EXTENSIONS */
-#define PRIu64 "llu"
-#endif /* _MSC_EXTENSIONS */
-#endif /* PRIu64 */
-
-#endif /* _BITTYPES_H */
-
-/*
- * Copyright (c) 2006 Paolo Abeni (Italy)
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. 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.
- * 3. The name of the author may not be used to endorse or promote
- * products derived from this software without specific prior written
- * permission.
- *
- * 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.
- *
- * bluetooth data struct
- * By Paolo Abeni <paolo.abeni@email.it>
- *
- * @(#) $Header: /tcpdump/master/libpcap/pcap/bluetooth.h,v 1.1 2007/09/22 02:10:17 guy Exp $
- */
-
-#ifndef _PCAP_BLUETOOTH_STRUCTS_H__
-#define _PCAP_BLUETOOTH_STRUCTS_H__
-
-/*
- * Header prepended libpcap to each bluetooth h:4 frame.
- * fields are in network byte order
- */
-typedef struct _pcap_bluetooth_h4_header {
- u_int32_t direction; /* if first bit is set direction is incoming */
-} pcap_bluetooth_h4_header;
-
-#endif
-
-/*-
- * Copyright (c) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997
- * The Regents of the University of California. All rights reserved.
- *
- * This code is derived from the Stanford/CMU enet packet filter,
- * (net/enet.c) distributed as part of 4.3BSD, and code contributed
- * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
- * Berkeley Laboratory.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. 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.
- * 3. All advertising materials mentioning features or use of this software
- * must display the following acknowledgement:
- * This product includes software developed by the University of
- * California, Berkeley and its contributors.
- * 4. Neither the name of the University nor the names of its contributors
- * may be used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
- *
- * @(#)bpf.h 7.1 (Berkeley) 5/7/91
- *
- * @(#) $Header: /tcpdump/master/libpcap/pcap/bpf.h,v 1.19.2.8 2008-09-22 20:16:01 guy Exp $ (LBL)
- */
-
-/*
- * This is libpcap's cut-down version of bpf.h; it includes only
- * the stuff needed for the code generator and the userland BPF
- * interpreter, and the libpcap APIs for setting filters, etc..
- *
- * "pcap-bpf.c" will include the native OS version, as it deals with
- * the OS's BPF implementation.
- *
- * XXX - should this all just be moved to "pcap.h"?
- */
-
-#ifndef BPF_MAJOR_VERSION
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/* BSD style release date */
-#define BPF_RELEASE 199606
-
-#ifdef MSDOS /* must be 32-bit */
-typedef long bpf_int32;
-typedef unsigned long bpf_u_int32;
-#else
-typedef int bpf_int32;
-typedef u_int bpf_u_int32;
-#endif
-
-/*
- * Alignment macros. BPF_WORDALIGN rounds up to the next
- * even multiple of BPF_ALIGNMENT.
- */
-#ifndef __NetBSD__
-#define BPF_ALIGNMENT sizeof(bpf_int32)
-#else
-#define BPF_ALIGNMENT sizeof(long)
-#endif
-#define BPF_WORDALIGN(x) (((x)+(BPF_ALIGNMENT-1))&~(BPF_ALIGNMENT-1))
-
-#define BPF_MAXBUFSIZE 0x8000
-#define BPF_MINBUFSIZE 32
-
-/*
- * Structure for "pcap_compile()", "pcap_setfilter()", etc..
- */
-struct bpf_program {
- u_int bf_len;
- struct bpf_insn *bf_insns;
-};
-
-/*
- * Struct return by BIOCVERSION. This represents the version number of
- * the filter language described by the instruction encodings below.
- * bpf understands a program iff kernel_major == filter_major &&
- * kernel_minor >= filter_minor, that is, if the value returned by the
- * running kernel has the same major number and a minor number equal
- * equal to or less than the filter being downloaded. Otherwise, the
- * results are undefined, meaning an error may be returned or packets
- * may be accepted haphazardly.
- * It has nothing to do with the source code version.
- */
-struct bpf_version {
- u_short bv_major;
- u_short bv_minor;
-};
-/* Current version number of filter architecture. */
-#define BPF_MAJOR_VERSION 1
-#define BPF_MINOR_VERSION 1
-
-/*
- * Data-link level type codes.
- *
- * Do *NOT* add new values to this list without asking
- * "tcpdump-workers@lists.tcpdump.org" for a value. Otherwise, you run
- * the risk of using a value that's already being used for some other
- * purpose, and of having tools that read libpcap-format captures not
- * being able to handle captures with your new DLT_ value, with no hope
- * that they will ever be changed to do so (as that would destroy their
- * ability to read captures using that value for that other purpose).
- */
-
-/*
- * These are the types that are the same on all platforms, and that
- * have been defined by <net/bpf.h> for ages.
- */
-#define DLT_NULL 0 /* BSD loopback encapsulation */
-#define DLT_EN10MB 1 /* Ethernet (10Mb) */
-#define DLT_EN3MB 2 /* Experimental Ethernet (3Mb) */
-#define DLT_AX25 3 /* Amateur Radio AX.25 */
-#define DLT_PRONET 4 /* Proteon ProNET Token Ring */
-#define DLT_CHAOS 5 /* Chaos */
-#define DLT_IEEE802 6 /* 802.5 Token Ring */
-#define DLT_ARCNET 7 /* ARCNET, with BSD-style header */
-#define DLT_SLIP 8 /* Serial Line IP */
-#define DLT_PPP 9 /* Point-to-point Protocol */
-#define DLT_FDDI 10 /* FDDI */
-
-/*
- * These are types that are different on some platforms, and that
- * have been defined by <net/bpf.h> for ages. We use #ifdefs to
- * detect the BSDs that define them differently from the traditional
- * libpcap <net/bpf.h>
- *
- * XXX - DLT_ATM_RFC1483 is 13 in BSD/OS, and DLT_RAW is 14 in BSD/OS,
- * but I don't know what the right #define is for BSD/OS.
- */
-#define DLT_ATM_RFC1483 11 /* LLC-encapsulated ATM */
-
-#ifdef __OpenBSD__
-#define DLT_RAW 14 /* raw IP */
-#else
-#define DLT_RAW 12 /* raw IP */
-#endif
-
-/*
- * Given that the only OS that currently generates BSD/OS SLIP or PPP
- * is, well, BSD/OS, arguably everybody should have chosen its values
- * for DLT_SLIP_BSDOS and DLT_PPP_BSDOS, which are 15 and 16, but they
- * didn't. So it goes.
- */
-#if defined(__NetBSD__) || defined(__FreeBSD__)
-#ifndef DLT_SLIP_BSDOS
-#define DLT_SLIP_BSDOS 13 /* BSD/OS Serial Line IP */
-#define DLT_PPP_BSDOS 14 /* BSD/OS Point-to-point Protocol */
-#endif
-#else
-#define DLT_SLIP_BSDOS 15 /* BSD/OS Serial Line IP */
-#define DLT_PPP_BSDOS 16 /* BSD/OS Point-to-point Protocol */
-#endif
-
-/*
- * 17 is used for DLT_OLD_PFLOG in OpenBSD;
- * OBSOLETE: DLT_PFLOG is 117 in OpenBSD now as well. See below.
- * 18 is used for DLT_PFSYNC in OpenBSD; don't use it for anything else.
- */
-
-#define DLT_ATM_CLIP 19 /* Linux Classical-IP over ATM */
-
-/*
- * Apparently Redback uses this for its SmartEdge 400/800. I hope
- * nobody else decided to use it, too.
- */
-#define DLT_REDBACK_SMARTEDGE 32
-
-/*
- * These values are defined by NetBSD; other platforms should refrain from
- * using them for other purposes, so that NetBSD savefiles with link
- * types of 50 or 51 can be read as this type on all platforms.
- */
-#define DLT_PPP_SERIAL 50 /* PPP over serial with HDLC encapsulation */
-#define DLT_PPP_ETHER 51 /* PPP over Ethernet */
-
-/*
- * The Axent Raptor firewall - now the Symantec Enterprise Firewall - uses
- * a link-layer type of 99 for the tcpdump it supplies. The link-layer
- * header has 6 bytes of unknown data, something that appears to be an
- * Ethernet type, and 36 bytes that appear to be 0 in at least one capture
- * I've seen.
- */
-#define DLT_SYMANTEC_FIREWALL 99
-
-/*
- * Values between 100 and 103 are used in capture file headers as
- * link-layer types corresponding to DLT_ types that differ
- * between platforms; don't use those values for new DLT_ new types.
- */
-
-/*
- * This value was defined by libpcap 0.5; platforms that have defined
- * it with a different value should define it here with that value -
- * a link type of 104 in a save file will be mapped to DLT_C_HDLC,
- * whatever value that happens to be, so programs will correctly
- * handle files with that link type regardless of the value of
- * DLT_C_HDLC.
- *
- * The name DLT_C_HDLC was used by BSD/OS; we use that name for source
- * compatibility with programs written for BSD/OS.
- *
- * libpcap 0.5 defined it as DLT_CHDLC; we define DLT_CHDLC as well,
- * for source compatibility with programs written for libpcap 0.5.
- */
-#define DLT_C_HDLC 104 /* Cisco HDLC */
-#define DLT_CHDLC DLT_C_HDLC
-
-#define DLT_IEEE802_11 105 /* IEEE 802.11 wireless */
-
-/*
- * 106 is reserved for Linux Classical IP over ATM; it's like DLT_RAW,
- * except when it isn't. (I.e., sometimes it's just raw IP, and
- * sometimes it isn't.) We currently handle it as DLT_LINUX_SLL,
- * so that we don't have to worry about the link-layer header.)
- */
-
-/*
- * Frame Relay; BSD/OS has a DLT_FR with a value of 11, but that collides
- * with other values.
- * DLT_FR and DLT_FRELAY packets start with the Q.922 Frame Relay header
- * (DLCI, etc.).
- */
-#define DLT_FRELAY 107
-
-/*
- * OpenBSD DLT_LOOP, for loopback devices; it's like DLT_NULL, except
- * that the AF_ type in the link-layer header is in network byte order.
- *
- * DLT_LOOP is 12 in OpenBSD, but that's DLT_RAW in other OSes, so
- * we don't use 12 for it in OSes other than OpenBSD.
- */
-#ifdef __OpenBSD__
-#define DLT_LOOP 12
-#else
-#define DLT_LOOP 108
-#endif
-
-/*
- * Encapsulated packets for IPsec; DLT_ENC is 13 in OpenBSD, but that's
- * DLT_SLIP_BSDOS in NetBSD, so we don't use 13 for it in OSes other
- * than OpenBSD.
- */
-#ifdef __OpenBSD__
-#define DLT_ENC 13
-#else
-#define DLT_ENC 109
-#endif
-
-/*
- * Values between 110 and 112 are reserved for use in capture file headers
- * as link-layer types corresponding to DLT_ types that might differ
- * between platforms; don't use those values for new DLT_ types
- * other than the corresponding DLT_ types.
- */
-
-/*
- * This is for Linux cooked sockets.
- */
-#define DLT_LINUX_SLL 113
-
-/*
- * Apple LocalTalk hardware.
- */
-#define DLT_LTALK 114
-
-/*
- * Acorn Econet.
- */
-#define DLT_ECONET 115
-
-/*
- * Reserved for use with OpenBSD ipfilter.
- */
-#define DLT_IPFILTER 116
-
-/*
- * OpenBSD DLT_PFLOG; DLT_PFLOG is 17 in OpenBSD, but that's DLT_LANE8023
- * in SuSE 6.3, so we can't use 17 for it in capture-file headers.
- *
- * XXX: is there a conflict with DLT_PFSYNC 18 as well?
- */
-#ifdef __OpenBSD__
-#define DLT_OLD_PFLOG 17
-#define DLT_PFSYNC 18
-#endif
-#define DLT_PFLOG 117
-
-/*
- * Registered for Cisco-internal use.
- */
-#define DLT_CISCO_IOS 118
-
-/*
- * For 802.11 cards using the Prism II chips, with a link-layer
- * header including Prism monitor mode information plus an 802.11
- * header.
- */
-#define DLT_PRISM_HEADER 119
-
-/*
- * Reserved for Aironet 802.11 cards, with an Aironet link-layer header
- * (see Doug Ambrisko's FreeBSD patches).
- */
-#define DLT_AIRONET_HEADER 120
-
-/*
- * Reserved for Siemens HiPath HDLC.
- */
-#define DLT_HHDLC 121
-
-/*
- * This is for RFC 2625 IP-over-Fibre Channel.
- *
- * This is not for use with raw Fibre Channel, where the link-layer
- * header starts with a Fibre Channel frame header; it's for IP-over-FC,
- * where the link-layer header starts with an RFC 2625 Network_Header
- * field.
- */
-#define DLT_IP_OVER_FC 122
-
-/*
- * This is for Full Frontal ATM on Solaris with SunATM, with a
- * pseudo-header followed by an AALn PDU.
- *
- * There may be other forms of Full Frontal ATM on other OSes,
- * with different pseudo-headers.
- *
- * If ATM software returns a pseudo-header with VPI/VCI information
- * (and, ideally, packet type information, e.g. signalling, ILMI,
- * LANE, LLC-multiplexed traffic, etc.), it should not use
- * DLT_ATM_RFC1483, but should get a new DLT_ value, so tcpdump
- * and the like don't have to infer the presence or absence of a
- * pseudo-header and the form of the pseudo-header.
- */
-#define DLT_SUNATM 123 /* Solaris+SunATM */
-
-/*
- * Reserved as per request from Kent Dahlgren <kent@praesum.com>
- * for private use.
- */
-#define DLT_RIO 124 /* RapidIO */
-#define DLT_PCI_EXP 125 /* PCI Express */
-#define DLT_AURORA 126 /* Xilinx Aurora link layer */
-
-/*
- * Header for 802.11 plus a number of bits of link-layer information
- * including radio information, used by some recent BSD drivers as
- * well as the madwifi Atheros driver for Linux.
- */
-#define DLT_IEEE802_11_RADIO 127 /* 802.11 plus radiotap radio header */
-
-/*
- * Reserved for the TZSP encapsulation, as per request from
- * Chris Waters <chris.waters@networkchemistry.com>
- * TZSP is a generic encapsulation for any other link type,
- * which includes a means to include meta-information
- * with the packet, e.g. signal strength and channel
- * for 802.11 packets.
- */
-#define DLT_TZSP 128 /* Tazmen Sniffer Protocol */
-
-/*
- * BSD's ARCNET headers have the source host, destination host,
- * and type at the beginning of the packet; that's what's handed
- * up to userland via BPF.
- *
- * Linux's ARCNET headers, however, have a 2-byte offset field
- * between the host IDs and the type; that's what's handed up
- * to userland via PF_PACKET sockets.
- *
- * We therefore have to have separate DLT_ values for them.
- */
-#define DLT_ARCNET_LINUX 129 /* ARCNET */
-
-/*
- * Juniper-private data link types, as per request from
- * Hannes Gredler <hannes@juniper.net>. The DLT_s are used
- * for passing on chassis-internal metainformation such as
- * QOS profiles, etc..
- */
-#define DLT_JUNIPER_MLPPP 130
-#define DLT_JUNIPER_MLFR 131
-#define DLT_JUNIPER_ES 132
-#define DLT_JUNIPER_GGSN 133
-#define DLT_JUNIPER_MFR 134
-#define DLT_JUNIPER_ATM2 135
-#define DLT_JUNIPER_SERVICES 136
-#define DLT_JUNIPER_ATM1 137
-
-/*
- * Apple IP-over-IEEE 1394, as per a request from Dieter Siegmund
- * <dieter@apple.com>. The header that's presented is an Ethernet-like
- * header:
- *
- * #define FIREWIRE_EUI64_LEN 8
- * struct firewire_header {
- * u_char firewire_dhost[FIREWIRE_EUI64_LEN];
- * u_char firewire_shost[FIREWIRE_EUI64_LEN];
- * u_short firewire_type;
- * };
- *
- * with "firewire_type" being an Ethernet type value, rather than,
- * for example, raw GASP frames being handed up.
- */
-#define DLT_APPLE_IP_OVER_IEEE1394 138
-
-/*
- * Various SS7 encapsulations, as per a request from Jeff Morriss
- * <jeff.morriss[AT]ulticom.com> and subsequent discussions.
- */
-#define DLT_MTP2_WITH_PHDR 139 /* pseudo-header with various info, followed by MTP2 */
-#define DLT_MTP2 140 /* MTP2, without pseudo-header */
-#define DLT_MTP3 141 /* MTP3, without pseudo-header or MTP2 */
-#define DLT_SCCP 142 /* SCCP, without pseudo-header or MTP2 or MTP3 */
-
-/*
- * DOCSIS MAC frames.
- */
-#define DLT_DOCSIS 143
-
-/*
- * Linux-IrDA packets. Protocol defined at http://www.irda.org.
- * Those packets include IrLAP headers and above (IrLMP...), but
- * don't include Phy framing (SOF/EOF/CRC & byte stuffing), because Phy
- * framing can be handled by the hardware and depend on the bitrate.
- * This is exactly the format you would get capturing on a Linux-IrDA
- * interface (irdaX), but not on a raw serial port.
- * Note the capture is done in "Linux-cooked" mode, so each packet include
- * a fake packet header (struct sll_header). This is because IrDA packet
- * decoding is dependant on the direction of the packet (incomming or
- * outgoing).
- * When/if other platform implement IrDA capture, we may revisit the
- * issue and define a real DLT_IRDA...
- * Jean II
- */
-#define DLT_LINUX_IRDA 144
-
-/*
- * Reserved for IBM SP switch and IBM Next Federation switch.
- */
-#define DLT_IBM_SP 145
-#define DLT_IBM_SN 146
-
-/*
- * Reserved for private use. If you have some link-layer header type
- * that you want to use within your organization, with the capture files
- * using that link-layer header type not ever be sent outside your
- * organization, you can use these values.
- *
- * No libpcap release will use these for any purpose, nor will any
- * tcpdump release use them, either.
- *
- * Do *NOT* use these in capture files that you expect anybody not using
- * your private versions of capture-file-reading tools to read; in
- * particular, do *NOT* use them in products, otherwise you may find that
- * people won't be able to use tcpdump, or snort, or Ethereal, or... to
- * read capture files from your firewall/intrusion detection/traffic
- * monitoring/etc. appliance, or whatever product uses that DLT_ value,
- * and you may also find that the developers of those applications will
- * not accept patches to let them read those files.
- *
- * Also, do not use them if somebody might send you a capture using them
- * for *their* private type and tools using them for *your* private type
- * would have to read them.
- *
- * Instead, ask "tcpdump-workers@lists.tcpdump.org" for a new DLT_ value,
- * as per the comment above, and use the type you're given.
- */
-#define DLT_USER0 147
-#define DLT_USER1 148
-#define DLT_USER2 149
-#define DLT_USER3 150
-#define DLT_USER4 151
-#define DLT_USER5 152
-#define DLT_USER6 153
-#define DLT_USER7 154
-#define DLT_USER8 155
-#define DLT_USER9 156
-#define DLT_USER10 157
-#define DLT_USER11 158
-#define DLT_USER12 159
-#define DLT_USER13 160
-#define DLT_USER14 161
-#define DLT_USER15 162
-
-/*
- * For future use with 802.11 captures - defined by AbsoluteValue
- * Systems to store a number of bits of link-layer information
- * including radio information:
- *
- * http://www.shaftnet.org/~pizza/software/capturefrm.txt
- *
- * but it might be used by some non-AVS drivers now or in the
- * future.
- */
-#define DLT_IEEE802_11_RADIO_AVS 163 /* 802.11 plus AVS radio header */
-
-/*
- * Juniper-private data link type, as per request from
- * Hannes Gredler <hannes@juniper.net>. The DLT_s are used
- * for passing on chassis-internal metainformation such as
- * QOS profiles, etc..
- */
-#define DLT_JUNIPER_MONITOR 164
-
-/*
- * Reserved for BACnet MS/TP.
- */
-#define DLT_BACNET_MS_TP 165
-
-/*
- * Another PPP variant as per request from Karsten Keil <kkeil@suse.de>.
- *
- * This is used in some OSes to allow a kernel socket filter to distinguish
- * between incoming and outgoing packets, on a socket intended to
- * supply pppd with outgoing packets so it can do dial-on-demand and
- * hangup-on-lack-of-demand; incoming packets are filtered out so they
- * don't cause pppd to hold the connection up (you don't want random
- * input packets such as port scans, packets from old lost connections,
- * etc. to force the connection to stay up).
- *
- * The first byte of the PPP header (0xff03) is modified to accomodate
- * the direction - 0x00 = IN, 0x01 = OUT.
- */
-#define DLT_PPP_PPPD 166
-
-/*
- * Names for backwards compatibility with older versions of some PPP
- * software; new software should use DLT_PPP_PPPD.
- */
-#define DLT_PPP_WITH_DIRECTION DLT_PPP_PPPD
-#define DLT_LINUX_PPP_WITHDIRECTION DLT_PPP_PPPD
-
-/*
- * Juniper-private data link type, as per request from
- * Hannes Gredler <hannes@juniper.net>. The DLT_s are used
- * for passing on chassis-internal metainformation such as
- * QOS profiles, cookies, etc..
- */
-#define DLT_JUNIPER_PPPOE 167
-#define DLT_JUNIPER_PPPOE_ATM 168
-
-#define DLT_GPRS_LLC 169 /* GPRS LLC */
-#define DLT_GPF_T 170 /* GPF-T (ITU-T G.7041/Y.1303) */
-#define DLT_GPF_F 171 /* GPF-F (ITU-T G.7041/Y.1303) */
-
-/*
- * Requested by Oolan Zimmer <oz@gcom.com> for use in Gcom's T1/E1 line
- * monitoring equipment.
- */
-#define DLT_GCOM_T1E1 172
-#define DLT_GCOM_SERIAL 173
-
-/*
- * Juniper-private data link type, as per request from
- * Hannes Gredler <hannes@juniper.net>. The DLT_ is used
- * for internal communication to Physical Interface Cards (PIC)
- */
-#define DLT_JUNIPER_PIC_PEER 174
-
-/*
- * Link types requested by Gregor Maier <gregor@endace.com> of Endace
- * Measurement Systems. They add an ERF header (see
- * http://www.endace.com/support/EndaceRecordFormat.pdf) in front of
- * the link-layer header.
- */
-#define DLT_ERF_ETH 175 /* Ethernet */
-#define DLT_ERF_POS 176 /* Packet-over-SONET */
-
-/*
- * Requested by Daniele Orlandi <daniele@orlandi.com> for raw LAPD
- * for vISDN (http://www.orlandi.com/visdn/). Its link-layer header
- * includes additional information before the LAPD header, so it's
- * not necessarily a generic LAPD header.
- */
-#define DLT_LINUX_LAPD 177
-
-/*
- * Juniper-private data link type, as per request from
- * Hannes Gredler <hannes@juniper.net>.
- * The DLT_ are used for prepending meta-information
- * like interface index, interface name
- * before standard Ethernet, PPP, Frelay & C-HDLC Frames
- */
-#define DLT_JUNIPER_ETHER 178
-#define DLT_JUNIPER_PPP 179
-#define DLT_JUNIPER_FRELAY 180
-#define DLT_JUNIPER_CHDLC 181
-
-/*
- * Multi Link Frame Relay (FRF.16)
- */
-#define DLT_MFR 182
-
-/*
- * Juniper-private data link type, as per request from
- * Hannes Gredler <hannes@juniper.net>.
- * The DLT_ is used for internal communication with a
- * voice Adapter Card (PIC)
- */
-#define DLT_JUNIPER_VP 183
-
-/*
- * Arinc 429 frames.
- * DLT_ requested by Gianluca Varenni <gianluca.varenni@cacetech.com>.
- * Every frame contains a 32bit A429 label.
- * More documentation on Arinc 429 can be found at
- * http://www.condoreng.com/support/downloads/tutorials/ARINCTutorial.pdf
- */
-#define DLT_A429 184
-
-/*
- * Arinc 653 Interpartition Communication messages.
- * DLT_ requested by Gianluca Varenni <gianluca.varenni@cacetech.com>.
- * Please refer to the A653-1 standard for more information.
- */
-#define DLT_A653_ICM 185
-
-/*
- * USB packets, beginning with a USB setup header; requested by
- * Paolo Abeni <paolo.abeni@email.it>.
- */
-#define DLT_USB 186
-
-/*
- * Bluetooth HCI UART transport layer (part H:4); requested by
- * Paolo Abeni.
- */
-#define DLT_BLUETOOTH_HCI_H4 187
-
-/*
- * IEEE 802.16 MAC Common Part Sublayer; requested by Maria Cruz
- * <cruz_petagay@bah.com>.
- */
-#define DLT_IEEE802_16_MAC_CPS 188
-
-/*
- * USB packets, beginning with a Linux USB header; requested by
- * Paolo Abeni <paolo.abeni@email.it>.
- */
-#define DLT_USB_LINUX 189
-
-/*
- * Controller Area Network (CAN) v. 2.0B packets.
- * DLT_ requested by Gianluca Varenni <gianluca.varenni@cacetech.com>.
- * Used to dump CAN packets coming from a CAN Vector board.
- * More documentation on the CAN v2.0B frames can be found at
- * http://www.can-cia.org/downloads/?269
- */
-#define DLT_CAN20B 190
-
-/*
- * IEEE 802.15.4, with address fields padded, as is done by Linux
- * drivers; requested by Juergen Schimmer.
- */
-#define DLT_IEEE802_15_4_LINUX 191
-
-/*
- * Per Packet Information encapsulated packets.
- * DLT_ requested by Gianluca Varenni <gianluca.varenni@cacetech.com>.
- */
-#define DLT_PPI 192
-
-/*
- * Header for 802.16 MAC Common Part Sublayer plus a radiotap radio header;
- * requested by Charles Clancy.
- */
-#define DLT_IEEE802_16_MAC_CPS_RADIO 193
-
-/*
- * Juniper-private data link type, as per request from
- * Hannes Gredler <hannes@juniper.net>.
- * The DLT_ is used for internal communication with a
- * integrated service module (ISM).
- */
-#define DLT_JUNIPER_ISM 194
-
-/*
- * IEEE 802.15.4, exactly as it appears in the spec (no padding, no
- * nothing); requested by Mikko Saarnivala <mikko.saarnivala@sensinode.com>.
- */
-#define DLT_IEEE802_15_4 195
-
-/*
- * Various link-layer types, with a pseudo-header, for SITA
- * (http://www.sita.aero/); requested by Fulko Hew (fulko.hew@gmail.com).
- */
-#define DLT_SITA 196
-
-/*
- * Various link-layer types, with a pseudo-header, for Endace DAG cards;
- * encapsulates Endace ERF records. Requested by Stephen Donnelly
- * <stephen@endace.com>.
- */
-#define DLT_ERF 197
-
-/*
- * Special header prepended to Ethernet packets when capturing from a
- * u10 Networks board. Requested by Phil Mulholland
- * <phil@u10networks.com>.
- */
-#define DLT_RAIF1 198
-
-/*
- * IPMB packet for IPMI, beginning with the I2C slave address, followed
- * by the netFn and LUN, etc.. Requested by Chanthy Toeung
- * <chanthy.toeung@ca.kontron.com>.
- */
-#define DLT_IPMB 199
-
-/*
- * Juniper-private data link type, as per request from
- * Hannes Gredler <hannes@juniper.net>.
- * The DLT_ is used for capturing data on a secure tunnel interface.
- */
-#define DLT_JUNIPER_ST 200
-
-/*
- * Bluetooth HCI UART transport layer (part H:4), with pseudo-header
- * that includes direction information; requested by Paolo Abeni.
- */
-#define DLT_BLUETOOTH_HCI_H4_WITH_PHDR 201
-
-/*
- * AX.25 packet with a 1-byte KISS header; see
- *
- * http://www.ax25.net/kiss.htm
- *
- * as per Richard Stearn <richard@rns-stearn.demon.co.uk>.
- */
-#define DLT_AX25_KISS 202
-
-/*
- * LAPD packets from an ISDN channel, starting with the address field,
- * with no pseudo-header.
- * Requested by Varuna De Silva <varunax@gmail.com>.
- */
-#define DLT_LAPD 203
-
-/*
- * Variants of various link-layer headers, with a one-byte direction
- * pseudo-header prepended - zero means "received by this host",
- * non-zero (any non-zero value) means "sent by this host" - as per
- * Will Barker <w.barker@zen.co.uk>.
- */
-#define DLT_PPP_WITH_DIR 204 /* PPP - don't confuse with DLT_PPP_WITH_DIRECTION */
-#define DLT_C_HDLC_WITH_DIR 205 /* Cisco HDLC */
-#define DLT_FRELAY_WITH_DIR 206 /* Frame Relay */
-#define DLT_LAPB_WITH_DIR 207 /* LAPB */
-
-/*
- * 208 is reserved for an as-yet-unspecified proprietary link-layer
- * type, as requested by Will Barker.
- */
-
-/*
- * IPMB with a Linux-specific pseudo-header; as requested by Alexey Neyman
- * <avn@pigeonpoint.com>.
- */
-#define DLT_IPMB_LINUX 209
-
-/*
- * FlexRay automotive bus - http://www.flexray.com/ - as requested
- * by Hannes Kaelber <hannes.kaelber@x2e.de>.
- */
-#define DLT_FLEXRAY 210
-
-/*
- * Media Oriented Systems Transport (MOST) bus for multimedia
- * transport - http://www.mostcooperation.com/ - as requested
- * by Hannes Kaelber <hannes.kaelber@x2e.de>.
- */
-#define DLT_MOST 211
-
-/*
- * Local Interconnect Network (LIN) bus for vehicle networks -
- * http://www.lin-subbus.org/ - as requested by Hannes Kaelber
- * <hannes.kaelber@x2e.de>.
- */
-#define DLT_LIN 212
-
-/*
- * X2E-private data link type used for serial line capture,
- * as requested by Hannes Kaelber <hannes.kaelber@x2e.de>.
- */
-#define DLT_X2E_SERIAL 213
-
-/*
- * X2E-private data link type used for the Xoraya data logger
- * family, as requested by Hannes Kaelber <hannes.kaelber@x2e.de>.
- */
-#define DLT_X2E_XORAYA 214
-
-/*
- * IEEE 802.15.4, exactly as it appears in the spec (no padding, no
- * nothing), but with the PHY-level data for non-ASK PHYs (4 octets
- * of 0 as preamble, one octet of SFD, one octet of frame length+
- * reserved bit, and then the MAC-layer data, starting with the
- * frame control field).
- *
- * Requested by Max Filippov <jcmvbkbc@gmail.com>.
- */
-#define DLT_IEEE802_15_4_NONASK_PHY 215
-
-/*
- * DLT and savefile link type values are split into a class and
- * a member of that class. A class value of 0 indicates a regular
- * DLT_/LINKTYPE_ value.
- */
-#define DLT_CLASS(x) ((x) & 0x03ff0000)
-
-/*
- * NetBSD-specific generic "raw" link type. The class value indicates
- * that this is the generic raw type, and the lower 16 bits are the
- * address family we're dealing with. Those values are NetBSD-specific;
- * do not assume that they correspond to AF_ values for your operating
- * system.
- */
-#define DLT_CLASS_NETBSD_RAWAF 0x02240000
-#define DLT_NETBSD_RAWAF(af) (DLT_CLASS_NETBSD_RAWAF | (af))
-#define DLT_NETBSD_RAWAF_AF(x) ((x) & 0x0000ffff)
-#define DLT_IS_NETBSD_RAWAF(x) (DLT_CLASS(x) == DLT_CLASS_NETBSD_RAWAF)
-
-/*
- * The instruction encodings.
- */
-/* instruction classes */
-#define BPF_CLASS(code) ((code) & 0x07)
-#define BPF_LD 0x00
-#define BPF_LDX 0x01
-#define BPF_ST 0x02
-#define BPF_STX 0x03
-#define BPF_ALU 0x04
-#define BPF_JMP 0x05
-#define BPF_RET 0x06
-#define BPF_MISC 0x07
-
-/* ld/ldx fields */
-#define BPF_SIZE(code) ((code) & 0x18)
-#define BPF_W 0x00
-#define BPF_H 0x08
-#define BPF_B 0x10
-#define BPF_MODE(code) ((code) & 0xe0)
-#define BPF_IMM 0x00
-#define BPF_ABS 0x20
-#define BPF_IND 0x40
-#define BPF_MEM 0x60
-#define BPF_LEN 0x80
-#define BPF_MSH 0xa0
-
-/* alu/jmp fields */
-#define BPF_OP(code) ((code) & 0xf0)
-#define BPF_ADD 0x00
-#define BPF_SUB 0x10
-#define BPF_MUL 0x20
-#define BPF_DIV 0x30
-#define BPF_OR 0x40
-#define BPF_AND 0x50
-#define BPF_LSH 0x60
-#define BPF_RSH 0x70
-#define BPF_NEG 0x80
-#define BPF_JA 0x00
-#define BPF_JEQ 0x10
-#define BPF_JGT 0x20
-#define BPF_JGE 0x30
-#define BPF_JSET 0x40
-#define BPF_SRC(code) ((code) & 0x08)
-#define BPF_K 0x00
-#define BPF_X 0x08
-
-/* ret - BPF_K and BPF_X also apply */
-#define BPF_RVAL(code) ((code) & 0x18)
-#define BPF_A 0x10
-
-/* misc */
-#define BPF_MISCOP(code) ((code) & 0xf8)
-#define BPF_TAX 0x00
-#define BPF_TXA 0x80
-
-/*
- * The instruction data structure.
- */
-struct bpf_insn {
- u_short code;
- u_char jt;
- u_char jf;
- bpf_u_int32 k;
-};
-
-/*
- * Macros for insn array initializers.
- */
-#define BPF_STMT(code, k) { (u_short)(code), 0, 0, k }
-#define BPF_JUMP(code, k, jt, jf) { (u_short)(code), jt, jf, k }
-
-#if __STDC__ || defined(__cplusplus)
-extern int bpf_validate(const struct bpf_insn *, int);
-extern u_int bpf_filter(const struct bpf_insn *, const u_char *, u_int, u_int);
-#else
-extern int bpf_validate();
-extern u_int bpf_filter();
-#endif
-
-/*
- * Number of scratch memory words (for BPF_LD|BPF_MEM and BPF_ST).
- */
-#define BPF_MEMWORDS 16
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif
-
- The Open Powerline Toolkit (vanilla version) may be downloaded from https://github.com/qca/open-plc-utils.git by any interested party. An advanced version (chocolate version) may be downloaded from the Qualcomm Atheros Customer FTP site by parties having permission to do so. The chocolate version includes special programs that perform advanced engineering, production and maintenance tasks. Within this document, we refer to both versions, collectively, as “the toolkit”.
-
- The toolkit contains C Language source code and GNU™ makefiles to compile many useful programs. It also includes Linux shell scripts that use these programs, in various ways, to interrogate, control and manage Qualcomm Atheros INT6000™, INT6300™, INT6400™, AR7400™ and later powerline devices. Qualcomm Atheros also provides a similar, but less extensive, toolkit for INT5500™ powerline devices.
-
- The toolkit is intended for hardware engineers, verification engineers, field engineers and embedded software developers, consequently, programs are simple and compact. It is not intended for computer novices or retail users. Many customers embed a subset of toolkit programs in products for troubleshooting purposes.
-
- The toolkit includes extensive HTML documentation and online man pages for users who cannot access installed man pages. HTML documentation starts with file docbook/index.html. Online man pages start with file docbook/toolkit.html. Qualcomm Atheros recommends that you add these two pages to your browser favorites for later reference.
-
- All toolkit programs are written in C and have command line intefaces. The source code essentially conforms to ISO/IEC9899:1999. The source tree cleanly compiles using gcc or pcc on Ubuntu, OpenBSD and MacOSX. It also compiles under Microsoft C with the inclusion of special header files. The command line interface conforms to Section 12.2 Utility Syntax Guidelines of The Open Group Base Specification Issue 6 (
-IEEE Std 1003.1, 2004 Edition).
-
- The toolkit includes Microsoft Visual Studio .NET project files and solutions files to compile toolkit programs, plus the executable version (.exe) of each program and a set of Microsoft installation file (.msi) so that the toolkit package comes ready to install and run on any Windows host; however, Qualcomm Atheros does not provide support for Microsoft windows version of this toolkit. Toolkit documentation does provide Windows developers with special guidance on setting up their own Visual Studio projects and solutions, should they want to do that.
-
- HomePlug® AV is an industry standard protocol for powerline communications developed by the HomePlug Powerline Alliance. Qualcomm Atheros manufactures a family of chipsets that conform to that standard and have MII, UART and SPI host interfaces. The INT6x00™ and AR7x00™ series are flagship members of that chipset family. The principle difference between the chipsets is their boot method, cost and speed. The INT6000™ requires onboard NVRAM but the INT6300™, INT6400™ and AR7400™ do not.
-
- The HomePlug® AV protocol is based on IEEE-802.3, has ethertype 0x88E1 and uses special message formats. A subset of those message formats is reserved for each chipset vendor to define their own message formats. Qualcomm Atheros uses this vendor-specific subset to communicate between host processors and Qualcomm Atheros devices. This toolkit uses Qualcomm Atheros vendor-specific message formats to communicates with Qualcomm Atheros devices. It also understands Qualcomm Atheros firmware and configuration file formats.
-
- This toolkit sends and receives Qualcomm Atheros vendor-specific messages but not generic HomePlug® AV messages. Qualcomm Atheros vendor-specific management message formats are described in the Qualcomm Atheros HomePlug® AV Firmware Technical Reference Manual. If you do not have a copy of this document then you may request one from Qualcomm Atheros.
-
diff --git a/docbook/ch01s03.html b/docbook/ch01s03.html
deleted file mode 100644
index 69ce8bea..00000000
--- a/docbook/ch01s03.html
+++ /dev/null
@@ -1,19 +0,0 @@
-Toolkit Distribution
- The Qualcomm Atheros Open Powerline Toolkit is distributed using compressed tape archive files named open-plc-utils-x.x.x.tar.gz and open-plc-utils-x.x.x.tar.bz2 and standard compressed archive file named open-plc-utils-x.x.x.zip, where x.x.x is the version number. Archive files ending in .gz can be decompressed with the Linux gzip utility. Archive files ending in .bz2 can be decompressed with the Linux bzip2 utility. Archive files ending in .zip can be decompressed using the Linux unzip utility or the Windows WinZip utility. The contents of decompressed archives can be extracted using the Linux tar utility. Recent versions of the Linux tar utility allow decompression and extraction in one operation. The WinZip or 7-zip program may be used to decompress archives and extract contents on Microsoft Windows platforms.
-
- Some Windows network administrators enable security software that removes .exe and other executable files from .zip archives in transit or in-situ. In that case, Windows user may want to download the *.tar.gz archive and use a program like 7zip to unpack the archive file.
-
- The toolkit includes source code, build scripts, documentation and pre-compiled programs for Microsoft Windows. Some third party libraries may also be included to support Microsoft platforms. Although the Microsoft Windows versions of toolkit programs are pre-compiled and ready-to-run, they are not supported because this package is designed for use on Linux platforms.
-
- The Windows installer included in this version of the toolkit needs Microsoft .NET 1.1. Windows versions of toolkit programs that communicate with powerline devices need WinPcap 4.1.2 or later. A copy of Microsoft .NET 1.1 and WinPcap 4.1.2 is included in the support folder.
-
diff --git a/docbook/ch01s04.html b/docbook/ch01s04.html
deleted file mode 100644
index e050cc98..00000000
--- a/docbook/ch01s04.html
+++ /dev/null
@@ -1,49 +0,0 @@
-Toolkit Installation on Linux
- The Linux version of the toolkit must be compiled from source code. The only requirement is the standard GNU/Linux toolchain consisting of make, gcc and ld. These are included with most Linux distributions but may require installation. On Debian™ based distributions, such as Ubuntu™, they may be installed using apt-get. On RedHat™ distributions, such as Fedora™, they may be installed using rpm. On SuSE™ based distributions, they may be installed using YaST2.
-
- Toolkit Installation on GNU/Linux™
-
Example 1.1.
- Toolkit Installation on GNU/Linux™
-
-# cp plc-utils-1.2.1.tar.gz /home/mydir
-# cd /home/mydir
-# tar -vzxf plc-utils-1.2.1.tar.gz
-# cd plc-utils-1.2.1
-# make
-# make install
-# make manuals
-
- Decompress the archive and extract the contents with the tar utility. This will create a folder having the same basename as the archive such that one version will not over-write another. Consult the tar man page on your system for detailed instructions. Change directory to the appropriate folder.
-
- The main package folder contains a recursive Makefile that will compile and install all toolkit programs. If you do not want to compile and install all programs then change directory to the appropriate folder and run make from there. To compile binary files, type make. To install binary files, type make install. To install man pages, type make manuals. The package does not automatically install examples, scripts, applets or man pages.
-
- We recommend that you login as root user before installing the toolkit; otherwise, you will be prompted for the root password as each program or component is installed.
-
- Programs are installed in folder /usr/local/bin and man pages are installed in folders /usr/share/man/man1. If these folders are not correct for your system, or if you want to install in other folders, then edit the folder names defined in the make.def file found in main toolkit folder or over-ride these definitions in subordinate makefiles.
-
- Toolkit Documentation on GNU/Linux
-
- Toolkit web pages are not automatically installed. To access toolkit documentation, point your browser to docbook/index.html and add the page to the browser bookmark or favorites list. If you are interested in how the toolkit has been implemented then do the same for page docbook/toolkit.html.
- The method described above is only recommended if you do not plan to move or remove toolkit folders. Otherwise, you can merely copy the entire contents of the toolkit docbook folder to another folder of your choice and point your browser to the new file locations.
-
-cp -rv docbook/* /home/mydir/toolkit
-
- Toolkit Removal on GNU/Linux™
-
- To uninstall installed programs and man pages on Linux, change to the main toolkit folder and type make uninstall.
-
Example 1.2.
- Toolkit Removal on GNU/Linux™
-
-# cd /home/mydir/plc-utils-1.2.1
-make uninstall
-
diff --git a/docbook/ch01s05.html b/docbook/ch01s05.html
deleted file mode 100644
index 8a1780e1..00000000
--- a/docbook/ch01s05.html
+++ /dev/null
@@ -1,32 +0,0 @@
-Toolkit Installation on Mac OS X
- Toolkit installation on Mac OS X™ is essentially identical to installation on Linux but special steps are needed before starting.
-
- First, you must install the toolkit as the root user or you will be denied permission. The root user account is disabled by default and so you must enable it in order to login. Follow instructions at Enabling the "root" user in Mac OS X to enable the account and login. After installation, toolkit programs should be run from a normal user account.
-
- Second, Mac OS X™ does not include C Language development tools by default. You must download and install them in order to build the toolkit. You can download and install them from the Apple website or (if you are ambitious) download, compile and install them from various open source websites. Consider using Xcode on Mac OS X Leopard or Lion.
-
- Login as the root user and download or copy the toolkit archive file to your preferred folder then follow the instructions for installing the toolkit on Linux.
-
Example 1.3.
- Setting the PATH variable on OS X™
-
- While still logged in as the root user, edit /etc/profile and add folder/usr/local/bin to the PATH definition found there. This will ensure that all users can access toolkit programs. The change may not take effect until the next time you login or open a new command shell.
-
-PATH="/bin:/sbin:/usr/local/bin"
-
Example 1.4.
- Removing the Toolkit from Mac OS X™
-
- While still logged in as the root user, remember to delete the toolkit source folder or, at least change ownership of all files in the toolkit folder, so that you can access and/or remove them later. This deletes the toolkit source code and intermmediate files without removing any installed toolkit programs.
-
-cd ..
-rm -r plc-utils-x.x.x
-
diff --git a/docbook/ch01s06.html b/docbook/ch01s06.html
deleted file mode 100644
index 37b45884..00000000
--- a/docbook/ch01s06.html
+++ /dev/null
@@ -1,65 +0,0 @@
-Toolkit Installation on Windows XP™
- The Windows™ version of the toolkit comes pre-compiled and ready to install and run using the Windows Installer. You may copy and distribute installation file plc-utils-x.x.x.msi. Users may then click on the installation file to install the package then discard it afterwards. The installation file permits remote installation over the network.
-
- The version of the Windows Installer used here needs Microsoft .NET Framework 1.1™ to work correctly. Newer versions of the .NET Framework™ will not work. The .NET Framework™ must be installed before the toolkit is installed or the Windows Installer™ will report dependency errors and refuse to complete installation. Multiple versions of the .NET Framework™ can coexist under Windows 7™. The .NET Framework™ needed is included in the toolkit support folder.
-
- Windows versions of toolkit programs that communicate with powerline devices all need WinPcap™ from winpcap.org to read and write Ethernet frames. WinPcap™ may be installed before or after toolkit installation but tools that access powerline devices will not run without it. You may want to install WinPcap™ before starting toolkit installation. If you have Wireshark™ installed then you probably already have WinPcap™ installed. A recent copy of WinPcap™ is included in the toolkit support folder.
-
- Failure to remove previous toolkit versions on some systems may result in the message "Another version of this product is already installed" when trying to install a new version. You may want to remove prior version before starting toolkit installation.
-
- Obtaining the Toolkit
-
- QCA customers can download the toolkit from the QCA Customer FTP Site.
-
- QCA employees may be able to download the toolkit from the QCA Application Engineering World FTP site ftp://appslinux01.qca.qualcomm.com/toolkit/plc-utils/. There are several installers available for Windows. Each installs a subset of the toolkit. Download the desired installer files to your local machine then execute them by right-clicking on them and selecting option "Run as Administrator".
-
- Installing the Toolkit
-
- Use a compression program like WinZip to decompress the archive file and extract all files. Use Microsoft Windows Explorer to locate file .\VisualStudioNET\plc-utils-x.x.x.msi under the main toolkit folder. Click on the file to start the Windows Installer then follow the installation instructions.
-
Figure 1.1.
- Windows Installer Dialogue
-
- Older toolkit programs were installed in folder C:\Program Files\Atheros\Toolkit but they are now installed in folder C:\Program Files\Qualcomm Atheros\Open Powerline Toolkit instead. If you select a different folder, remember it for the next step.
-
- Setting the PATH variable
-
- Toolkit programs have command line interfaces and must be run from an open console window. To simplify program access and minimize the typing required, add the toolkit installation path mentioned above to the PATH environment variable by following steps listed below. If you have Administrator privileges then we recommend that you edit the system PATH variable; otherwise, you may need to create and/or edit a user PATH variable.
-
Figure 1.2.
- Control Panel System Dialogue
-
- On the Start menu, select the Control Panel option.
-
- In the Control Panel window, select the System icon.
-
- On the System Properties dialog box, select the Advanced tab.
-
- On the Advanced tab, press the Environment Variables button.
-
- On the Environment Variables dialog box, scroll down the System variables list and select the Path variable then press the Edit button.
-
- On the Edit System Variable dialogue box, append the installation path to the Variable value field.
-
- Press the OK button.
-
- Removing the Toolkit
-
- To remove an existing version of the Qualcomm Atheros Open Powerline Toolkit from your system, follow the steps listed below. If the toolkit is not installed on your system then omit these steps. If you are unsure, you can follow them to determine if you have the toolkit installed or you can attempt to install, anyway, and return here if installation is prevented.
-
Figure 1.3.
- Control Panel Add/Remove Dialogue
-
- On the Start menu, select the Control Panel option.
-
- In the Control Panel window, select the Add or Remove Programs icon.
-
- On the Add or Remove Programs dialog box, scroll down and select the Qualcomm Atheros Open Powerline Toolkit entry then press the Remove pushbutton.
-
diff --git a/docbook/ch01s07.html b/docbook/ch01s07.html
deleted file mode 100644
index ae054beb..00000000
--- a/docbook/ch01s07.html
+++ /dev/null
@@ -1,67 +0,0 @@
-Toolkit Installation on Windows 7™
- The Windows™ version of the toolkit comes pre-compiled and ready to install and run using the native Windows Installer. You may copy and distribute installation file plc-utils-x.x.x.msi. Users merely click on the file to install the package and may discard it afterwards. This method of installation permits remote installation over network.
-
- The version of the Windows Installer used here needs Microsoft .NET Framework 1.1™ to work correctly. Newer versions of the .NET Framework™ will not work. The .NET Framework™ must be installed before the toolkit is installed or the Windows Installer™ will report dependency errors and refuse to complete installation. Multiple versions of the .NET Framework™ can coexist under Windows 7™. The .NET Framework™ needed is included in the toolkit support folder.
-
- Failure to remove previous toolkit versions on some systems may result in the message "Another version of this product is already installed" when trying to install a new version. You may want to remove prior version before starting toolkit installation.
-
- Windows versions of toolkit programs that communicate with powerline devices all need WinPcap™ from winpcap.org to read and write Ethernet frames. WinPcap™ may be installed before or after toolkit installation but tools that access powerline devices will not run without it. You may want to install WinPcap™ before starting toolkit installation. If you have Wireshark™ installed then you probably already have WinPcap™ installed. A recent copy of WinPcap™ is included in the toolkit support folder.
-
- Obtaining the Toolkit
-
- QCA customers can download the toolkit from the QCA Customer FTP Site.
-
- QCA employees may be able to download the toolkit from the QCA Application Engineering World FTP site ftp://appslinux01.qca.qualcomm.com/toolkit/plc-utils/. There are several installers available for Windows. Each installs a subset of the toolkit. Download the desired installer files to your local machine then execute them by right-clicking on them and selecting option "Run as Administrator".
-
- Installing the Toolkit
-
- Older toolkit programs were installed in folder C:\Program Files\Atheros\Toolkit by default but now they are installed in C:\Program Files (x86)\Qualcomm Atheros\Open Powerline Toolkit instead. If you select a different folder during installation then remember it for the next step.
-
Figure 1.4.
- Windows Installer Dialogue
-
- Accept install defaults.
-
- Setting the PATH variable
-
- Toolkit programs have command line interfaces and must be run from an open console window. To simplify program access and minimize the typing required, add the toolkit installation path mentioned above to the PATH environment variable by following steps listed below. If you have Administrator privileges then we recommend that you edit the system PATH variable; otherwise, you may need to create and/or edit a user PATH variable.
-
Figure 1.5.
- Control Panel System Dialogue
-
- On the Start menu, select the Control Panel option.
-
- On the Adjust system settings page, select the System icon.
-
- On the View basic information about your computer page, select the Advanced system settings option.
-
- On the System Properties dialog, press the Environment Variables button.
-
- On the Environment Variables dialog box, scroll down the System variables list and select the Path variable then press the Edit button.
-
- On the Edit System Variable dialogue box, append the installation path to the Variable value field.
-
- Press the OK button.
-
- Environment variable changes made here do not take effect until a console window is opened. This means that you may need to close and then reopen console windows that depend on the changes. It is a good idea to immediately open a console window and execute a toolkit command in order to confirm that the PATH variable is properly defined.
-
- Removing the Toolkit
-
- To remove an existing version of the Qualcomm Atheros Open Powerline Toolkit from your system, follow the steps listed below. If the toolkit is not installed on your system then omit these steps. If you are unsure, you can follow them to determine if you have the toolkit installed or you can attempt to install, anyway, and return here if installation is prevented.
-
Figure 1.6.
- Control Panel Add/Remove Dialogue
-
- On the Start menu, select the Control Panel option.
-
- On the Adjust system settings page, select the Programs and Features icon.
-
- On the Uninstall or change a program page, scroll down and select the appropriate QCA Open Powerline Toolkit entry then press the Remove pushbutton. There may be several different QCA Open Powerline Toolkit entries so be sure to select the correct one.
-
- The Qualcomm Atheros Open Powerline Toolkit is a collection of small, command line programs. Each program deals with some aspect of powerline device management. Programs can be combined, in various ways, using shell scripts, to perform sophisticated and complex tasks. With these program, one can identify chipset and firmware version, reset devices, flash devices, identify other powerline network devices, validate *.pib and *.nvm files, sniff HomePlug® AV Ethernet frames, send generic Ethernet frames and so on.
-
- Program source code is designed to demonstrate device hardware and firmware features and to illustrate techniques for software developers and hardware engineers. The source code may be modified and distributed without obligation to Qualcomm Atheros; however Qualcomm Atheros would appreciate feedback concerning improvements to program useability, reliability or efficiency. Keep in mind that these tools, unlike some other tools, are intended to be simple and compact.
-
- Most programs in this toolkit start their life on Linux and are eventually ported to other environments. Consequently, not all programs are available in the Windows version of the toolkit but most of them are.
-
- Program descriptions appear below in alphabetical order. Alternately, you may browse the latest program descriptions and source code here.
-
- INT6400 Device Management
-
- Programs in this group are older versions that communicate with INT6x00 chipsets. Many still work on AR7x00 chipsets. The main difference is due to the higher PHY data rates on AR7x00 chipsets. The higher data rates must be expressed using 16-bits instead of 8-bits. Consequently, some MME formats have changed.
-
-
- int64host
-
-
- A command line utility that waits for and services VS_HST_ACTION messages from a flash-less device INT6300™ or INT6400™ device. It is similar to program int6khost but does not use an SDRAM configuration files. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int64host man page for more information.
-
-
- int6k
-
-
- A command line utility to inspect and control INT6000™ and INT6300™ devices connected to the local host. It performs several of the device maintenance functions available in the Atheros Windows Device Manager but is small enough to run on an embedded system. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder .int6k. See the int6k man page for more information.
-
-
- int6k2
-
-
- A command line utility to inspect and control INT6000™ and int6300™ devices connected to the local host. It is similar to int6k but calls the Atheros Embedded API, described in the Atheros HomePlug® AV API User's Guide, to perform device management tasks. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6k2 man page for more information.
-
-
- int6kboot
-
-
- A command line utility to start and optionally flash INT6300™ and INT6400™' devices that have no NVRAM or have a blank or corrupted NVRAM. It communicates with the Atheros Bootloader to configure SDRAM, download runtime firmware and PIB and start firmware execution. Users can optionally request that the same PIB and firmware then be used to flash NVRAM. It is similar to program int6kf but does not accept an SDRAM configuration file. Instead, it uses on the memctl applet. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6kboot man page for more information.
-
-
- int6kf
-
-
- A command line utility to start and optionally flash INT6000™ and INT6300™ devices having no NVRAM or having a blank or corrupted NVRAM. It communicates with the Atheros Bootloader to configure SDRAM, download runtime firmware and PIB and start firmwrae execution. It can also be used to force flash blank or corrupted NVRAM. It is similar to program int6kboot but requires an SDRAM parameter file. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6kf man page for more information.
-
-
- int6khost
-
-
- A command line utility that waits for and services VS_HST_ACTION messages from a flash-less INT6000™ or INT6300™ device. It is similar to program in64host but needs an SDRAM configuration file. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6khost man page for more information.
-
-
- int6kid
-
-
- A command line utility that prints the DAK or NMK strings read from one or more devices. It can be used in shell scripts to dynamically obtain device keys and insert them on program command lines as arguments. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6kid man page for more information.
-
-
- int6klist
-
-
- A command line utility that lists local devices, or remote devices associated with a specific device, on stdout in undecorated format. It can be used in shell scripts to dynamically determine, and then traverse, network topology. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6klist man page for more information.
-
-
- int6kprobe
-
-
- A command line utility that probes for neighboring networks. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6kprobe man page for more information.
-
-
- int6krule
-
-
- A command line utility to format and send classification rules to a device. Classification rules are specified using symbolic names for actions, options, conditions and frame fields. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6krule man page for more information.
-
-
- int6ktest
-
-
- A command line utility that downloads and executes program images stored in an Atheros .nvm file. This program can be used to download and execute Atheros hardware diagnostic programs like those in the ./applets folder. It is not intended to download and start runtime firmware, although it may be used for that. The program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6ktest man page for more information.
-
-
- int6kuart
-
-
- A command line utility used to manage a local powerline device over a host serial line interface. Program command line options are translated to AT-style serial commands and sent to the device. THe primary benefits of using this program, in place of a terminal emulator, is the ability to download parameter blocks and upload paameter blocks and firmware images. The program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./serial. See the int6kuart man page for more information.
-
-
- int6kwait
-
-
- A command line utility that polls the local powerline device and waits for the bootloader or runtime firmware to either stop executing or start executing or wait for a device to associate with another device. It can be used to synchronize scripts with device or network events such as connection make or break, power on or off and firmware stop or start. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6kwait man page for more information.
-
- INT6400 Device Monitoring
-
-
- int6klog
-
-
- A command line utility that exports the runtime watchdog report in binary or XML format. Output is suitable for input to the Atheros Windows Device Manager. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6klog man page for more information.
-
-
- int6krate
-
-
- A command line utility that polls a device and prints the average transmit and receive PHY rates between it and each of it's network neighbors. Program output is suitable for loading into a spreadsheet or other program that can process column-oriented information. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6krate man page for more information.
-
- This program is suitable for use with INT6x00 chipsets but not AR7x00 chipsets due to higher PHY rates. Use program amprate for AR7x00 chipsets and plcrate for mixed chipset environments.
-
-
- int6kstat
-
-
- A command line utility that polls a poserline device and prints various network and link statistics in a format suitable for processing by another program. It is a work in progress because we are investigating different ways to present the information. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6kstat man page for more information.
-
- AR7400 Device Management
-
- The programs in this group are essentially identical to those in the INT6x00 group but they support higher PHY data rates offered by the AR7x00 chipsets. Specifically, they handle the new VS_NW_INFO and VS_LNK_STATS message formats.
-
-
- ampboot
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the ampboot man page for more information.
-
-
- amphost
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the amphost man page for more information.
-
-
- ampinit
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the ampinit man page for more information.
-
-
- amplist
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the amplist man page for more information.
-
-
- amptest
-
-
- A command line utility that downloads and executes program images stored in an Atheros .nvm file. It can be used to download and execute special Atheros hardware diagnostic programs. It is not intended to download and start runtime firmware. The program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the amptest man page for more information.
-
-
- amptool
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the amptool man page for more information.
-
-
- ampwait
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the ampwait man page for more information.
-
- AR7400 Device Monitoring
-
- The programs in this group are essentially identical to those in the INT6x00 group but they support higher PHY data rates offered by the AR7x00 chipsets. Specifically, they handle the new VS_NW_INFO and VS_LNK_STATS message formats.
-
-
- amprate
-
-
- A command line utility that polls a device and prints the average transmit and receive PHY rates between it and each of it's network neighbors. Program output is suitable for loading into a spreadsheet or other program that can process column-oriented information. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the amprate man page for more information.
-
- This program is suitable for use with AR7x00 chipsets and later that have higher PHY rates and newer firmware. Use program int6krate for AR6x00 running earlier runtime firmware that may not recognize newer message formats. Use program plcrate for mixed chipset environments
-
-
- ampsnif
-
-
- Enables or disables the powerline sniffer mode on the local powerline device using the VS_SNIFFER message. Use program ampsnot to display and/or record sniffer output. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the ampsnif man page for more information.
-
-
- ampsnot
-
-
- Listens for sniffer output from the local powerline device and display results on the console. Use program ampsnif to enable or disable sniffer output. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the ampsnot man page for more information.
-
-
- ampstat
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the ampstat man page for more information.
-
-
- amptone
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the amptone man page for more information.
-
- mdustats
-
- A command line utility to collect and display various MDU traffic statistics. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./plc. See the mdustats man page for more information.
-
- AR7420 Device Configuration
-
- Programs in this group understand changes to .nvm file formats and to the device boot and memory flash messages and sequences.
-
-
- plchost
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the plchost man page for more information.
-
-
- plctest
-
-
- A command line utility that downloads and executes small program images stored in older and newer .nvm files. It can be used to download and execute small powerline diagnostic programs. It is not intended to download and start runtime firmware. The program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the plctest man page for more information.
-
- This program automatically detects the type of .nvm file format and adapts.
-
- Parameter File Management
-
- Programs in this group are used to inspect and change .pib files in various ways. The do not communicate directly with the powerline device. Use program int6k, amptool or plctool to read the PIB from a powerline device or write a PIB to the powerline device.
-
-
- chkpib
-
-
- A command line utility to validate .pib files based on their internal checksum, file size and other characteristics. It can also be used to produce a text catalog of .pib files. This program is slower than program chkpib2 but requires less memory to execute. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./pib. See the chkpib man page for more information.
-
-
- chkpib2
-
-
- A command line utility to validate .pib files based on their internal checksum, file size and other characteristics. It can also be used to produce a text catalog of .pib files. This program is faster than program chkpib but requires more memory to execute. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./pib. See the chkpib2 man page for more information.
-
-
- getpib
-
-
- A free-form means of extracting paremeters from a PIB file when the offset, length and format of the parameter is known. It is a companion to program setpib. The user specifies the filename, a starting offset and a sequence of type/data pairs. Values are echoed in order on the console in the specified format. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./pib. See the getpib man page for more information.
-
-
- modpib
-
-
- A command line utility to change the MAC, DAK and/or NMK of an existing PIB file and recompute the checksum. It can also be used to change the manufacturer string, network name and username strings. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./pib. See the modpib man page for more information.
-
-
- mrgpib
-
-
- A command line utility that transfers parameters from one PIB file to another. The two files needs not have the same PIB version. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./pib. See the mrgpib man page for more information.
-
-
- pib2xml
-
-
- An offset-driven XML dump utility for the PIB. It requires an offset description file to be useful. The user specifies an offset description file and a PIB file. The program output an XML description of PIB fields. An example file, piboffset.txt, is included as a basic example. The example offset description file is intentionally incomplete. Complete files are reserved for use by Atheros Field Application Engineers. This program is an alternative to program pibdump. The main source code is located in folder ./tools. See the pib2xml man page for more information.
-
-
- pibcomp
-
-
- An offset-driven binary file compare utility for the PIB. It requires an offset description file to be useful. The user specifies an offset description file and two binary files. The files are compared, field by field, and differences are printed on stdout, field by field. An example file, piboffset.txt, is included as a basic example. The example offset description file is intentionally incomplete. Complete files are reserved for use by Atheros Field Application Engineers. This program is an alternative to program pib2xml and a companion to program pibdump. The main source code is located in folder ./tools. See the pibcomp man page for more information.
-
-
- pibdump
-
-
- An offset-driven dump utility for the PIB. It requires an offset description file to be useful. An example file, piboffset.txt, is included as a basic example. The example offset description file is intentionally incomplete. Complete files are reserved for use by Atheros Field Application Engineers. This program is a companion to program pibcomp. The main source code is located in folder ./tools. See the pibdump man page for more information.
-
-
- pibruin
-
-
- A command line utility that inserts classifier rules, read from a file, into a PIB file. It is an alternative to program int6krule and companion to program pibrump. The main source code is located in folder ./pib. See the pibruin man page for more information.
-
- This program supports INT6300, INT6400 and AR7400 PIBs only and is deprecated.
-
-
- pibrump
-
-
- A command line utility that reads classifier rules from a PIB file and prints them on stdout in a format suitable for input to program pibruin. The main source code is located in folder ./pib. See the pibrump man page for more information.
-
-
- psin
-
-
- A command line utility to insert an amplitude map into an existing PIB file. The map is read from stdin in text format allowing the output of program psout to be piped directly into this program. The main source code is located in folder ./pib. See the psin man page for more information.
-
-
- psout
-
-
- A command line utility to that exports an amplitude map stored in an existing PIB file. The map is written directly to stdin in text format allowing the output of this program to be piped into the input of program psin. The main source code is located in folder ./pib. See the psout man page for more information.
-
-
- pxe
-
-
- A generic 'Remote PIB Management' tool. One or more XML files define decimal, hexadecimal and string edits to be applied to a PIB file. The PIB is read, edits are applied, a new checksum is computed and the PIB is saved. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./pib. See the pxe man page for more information.
-
-
- setpib
-
-
- A simple means of setting PIB parameters when the parameter offset, length and format are known. It is an alternative to program pxe and a companion to program getpib. The user specifies the filename, a starting offset and a sequence of type/data pairs. Edits are applied in order and a new checksum is computed. A full or partial dump of the PIB displays the result. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./pib. See the setpib man page for more information.
-
- Firmware File Management
-
-
- chknvm
-
-
- A command line utility to validate .nvm files based on their internal checksum, file size and other characteristics. This program is slower than program chknvm2 but requires less memory to execute. Optionally, it can be used to display the image headers inside the file. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./nvm. See the chknvm man page for more information.
-
-
- chknvm2
-
-
- A command line utility to validate .nvm files based on their internal checksum, file size and other characteristics. Optionally, it can be used to display the image headers inside the file. This program is faster than program chknvm but requires more memory to execute. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./nvm. See the chknvm2 man page for more information.
-
-
- config2cfg
-
-
- A command line utility to convert an SDRAM configruation file used by the Atheros Windows Device Manager to the configuration file format used by the Open Powerline Toolkit applications. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./sdram. See the config2cfg man page for more information.
-
-
- nvmmerge
-
-
- A command line utility to combine multiple Atheros image files into one. It is reserved for use by Atheros Field Application Engineers. Use of this probram could void some contractual obligations made by Atheros. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./nvm. See the nvmmerge man page for more information.
-
-
- nvmsplit
-
-
- A command line utility to extract all constituent images from an Atheros image file. It is reserved for use by Atheros Field Application Engineers. Use of this probram could void some contractual obligations made by Atheros. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./nvm. See the nvmsplit man page for more information.
-
- Ethernet Traffic
-
-
- edru
-
-
- A command line program that reads one or more Ethernet II (IEEE 802.2) frames and write frame data to stdout as a continuous stream. This program can be used to capture serial data sent from a remote UART-enabled powerline device. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./ether. See the edru man page for more information.
-
-
- edsu
-
-
- A command line program sends one or more files over the network using Ethernet II (IEEE 802.2) Frames. This program can be used to test remote UART-enabled powerline devices. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./ether. See the edsu man page for more information.
-
-
- efsu
-
-
- A freeform Ethernet frame send utility used to define and send Ethernet packets. Packets are defined in text files containing hexadecimal byte codes plus optional comments and whitespace. Input files are stripped of comments and whitespace then transmitted as Ethernet frames. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./ether. See the efsu man page for more information.
-
-
- hpav
-
-
- A basic HomePlug® AV packet sniffer that displays only HomePlug® AV protocol frames on the console as they are sent or arrive on a given interface. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./mme. See the hpav man page for more information.
-
-
- pcapdevs
-
-
- A utility to enumerate LibPcap or WinPcap devices available on the host. It is compiled but only works if one of these two packages is installed on the host. At present, it is only needed with the Windows version of the Toolkit which is compiled against the WinPcap library. The main source code is located in folder ./ether. See the pcapdevs man page for more information.
-
- Passwords and Keys
-
-
- hpavkey
-
-
- A HomePlug® AV key generator. Pass phrase arguments are hashed to form the corresponding Device Access Key (DAK), Network Membership Key (NMK) or Network Identifier (NID). This program is installed in folder /usr/local/bin with 4555 permissions. The main source code is located in folder ./crypt. See the hpavkey man page for more information.
-
-
- hpavkeys
-
-
- A HomePlug® AV key generator. Pass phrases are read from a file and hashed to form the corresponding Device Access Key (DAK), Network Membership Key (NMK) or Network Identifier (NID). This program is installed in folder /usr/local/bin with 4555 permissions. The main source code is located in folder ./crypt. See the hpavkeys man page for more information.
-
-
- mac2pw
-
-
- A device password generator that prints a range of MAC address and passwords on stdout. It is an alternative to the Atheros Production Test System (PTS) DBBuilder Utility and toolkit program mac2pwd. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./crypt. See the mac2pw man page for more information.
-
-
- mac2pwd
-
-
- A device password generator that reads files containing MAC addresses and prints address/password pairs. It is an alternative to the Atheros Production Test System (PTS) DBBuilder Utility and toolkit program mac2pw. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./crypt. See the mac2pwd man page for more information.
-
-
- rkey
-
-
- A command line utility to dynamically generate distinct HomePlug AV compliant keys from a user created keyfile. It can be used in shell scripts to dynamically insert random and distinct keys on program command lines as arguments. For example, a Linux bash script can reference "$(rkey -i eth0 -D secret.key)" inline. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./crypt. See the rkey man page for more information.
-
- MDIO Programming
-
- int6kmdio
-
- A command line utility that uses VS_MDIO_COMMAND messages to read and write MDIO registers on a switch chip connected to the local powerline device. MDIO instructions are specified and send as Clause 22 instructions. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./mdio. See the mdioblock man page for more information.
-
- int6kmdio2
-
- A command line utility that uses VS_MDIO_COMMAND messages to read and write MDIO registers on a switch chip connected to the local powerline device. Instructions are read as Clause 45 instructions but send as Clause 22 instructions. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./mdio. See the mdioblock man page for more information.
-
- mdioblock
-
- A command line utility to assemble an Atheros MDIO instruction block from hexadecimal register instructions. MDIO instruction blocks are written to Atheros powerline devices as modules using the VS_MOD_OP message type. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./mdio. See the mdioblock man page for more information.
-
- mdioblock2
-
- A command line utility to assemble an Atheros MDIO instruction block from hexadecimal register instructions. MDIO instruction blocks are written to Atheros powerline devices as modules using the VS_MOD_OP message type. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./mdio. See the mdioblock2 man page for more information.
-
- mdiodump
-
- A command line utility to read and display Atheros MDIO custom modules in human readable format. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./mdio. See the mdiodump man page for more information.
-
- mdiogen
-
- A rudimentary command line utility that write a custom MDIO block to a fixed file. The user must edit a data statements, in the main program, to define MDIO command fields. A series of macros then mask, shift and merge the fields to create complete Clause 22 or Clause 45 MDIO commands on output. The program has no dependencies on other toolkit modules and so it will compile anywhere. This program must be manually compiled and it is not automatically installed. The main source code is located in folder ./mdio and file mdio.h is required for compilation. There are no help files available at this time. If you do not understand how to use it then you may not need it.
-
- Serial Programming
-
-
- ptsctl
-
-
- A command line program used to control a bank of three Weeder programmable attenuators. It may be used to construct a Production Test System (PTS) for Qualcomm Atheros SmartLink™ devices. See program weeder to control a bank of two Weeder programmable attenuators. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./serial. See the ptsctl man page for more information.
-
-
- ttycat
-
-
- A command line program that copies one or more host files to a specific serial port. It can be used to stream serial data to the local UART-enabled powerline device for transmission over powerline. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./serial. See the ttycat man page for more information.
-
-
- weeder
-
-
- A command line program used to control a bank of two Weeder programmable attenuators. It may be used to construct a Production Test System (PTS) for Qualcomm Atheros powerline devices. See program ptsctl to control a bank of three Weeder programmable attenuators. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./serial. See the weeder man page for more information.
-
- Atheros Communications reserves the right to add, remove or rename utility programs or modify their command line options or their functionality in future software releases without any obligation to notify or compensate users of this software.
-
- The Atheros Open Powerline Toolkit package folder has many subfolders. Some contain source code, some contain documentation and others contain shell scripts. Some source folders contain programs that require components in neighboring folders. Consequently, you will see references to relative pathnames like ../folder, throughout source code, makefiles and shell scripts. This notation simplifies development and maintenance and is helpful when locating specific files.
-
- Folder descriptions appear below in alphabetical order:
-
- ./applets
-
- A library of programs that can run, stand-alone, on Atheros powerline devices and perform diagnostic tests for connection, functionality and performance. Some run to completion and return to the Bootloader. Others run continuously until the device is reset. Most can be run and executed in sequence using program int6ktest.
-
- ./classes
-
- A collection of C++ classes that implement many of the ANSI C functions found elsewhere in the toolkit. These classes will compile and run on most platforms but are still a work-in-progress. The programs folder contains actual and sample programs that use these classes.
-
- ./docbook
-
- HTML pages generated by several methods, but mostly Docbook 4.5. Some pages have been created using special tools that are not provided and will not be made available. The Makefile in this folder will compile the core XML source files on GNU/Linux systems that have Docbook 4.5 installed with extentions by Normal Walsh but it does not install the pages. See Installation on Linux for more information.
-
- ./ether
-
- Network specific source code that supports raw ethernet packets in a platform independent fashion using plugin modules. The principle feature is the channel data structure used to read and write raw ethernet packets using network features on GNU/Linux, with or without libpcap, and on Windows™ with winpcap. The source code in this folder is difficult to port cross-platform due to the way different operating systems implement their system header files and network stacks.
-
- ./plc
-
- The main source code for programs that communicate with Qualcomm Atheros powerline devices over Ethernet. The programs in this folder are essential programs for engineers and embedded software developers wanting to explore powerline device behavior. The Makefile in this folder will compile and install programs in /usr/local/bin on GNU/Linux systems.
-
- ./mme
-
- A collection of helper functions dealing with HomePlug® and Atheros management messages. They are not needed for proper toolkit operation but they can be useful during development and debugging because they print message content in readable format. Most of these functions require extra memory because they include symbol tables and extra data conversion functions.
-
- ./nodes
-
- A collection of functions that comrpise a generic, light-weight XML parser. Atheros is currently exprimenting with various XML-based applications to support device management on embedded systems. These functions are the core. Currently, they are only used by the pxe and int6k2 programs. See XML Editing Functions for more information.
-
- ./nvm
-
- Programs, functions and make files related to Atheros NonVolatile Memory (NVM) files. All programs in this folder either read from or write to NVM files. None communicate with powerline devices. Some of the popular programs are chknvm, nvmsplit and nvmmerge.
-
- ./patches
-
- A collection of useful Linux™ kernel patches and install scripts. Of particular interest is the send-to-self patch that enables external routing of ISO Layer 3 traffic between two Ethernet interfaces on the same host. Atheros provides them but does not support them.
-
- ./pib
-
- Programs, functions and make files related to Atheros Parameter Information Block (PIB) files. All programs in this folder either read from or write to PIB files. None communicate with powerline devices. Some of the popular programs are chkpib, modpib, getpib and setpib.
-
- ./programs
-
- A small collection of sample C++ programs that use the Atheros C++ powerline classes. These programs compile and run on most environments but are still a work-in-progress. Users may actually find netifs and plcnets useful.
-
- ./serial
-
- Programs, functions and make files related to the Atheros Serial Communication Interface for Powerline devices. All of the programs in this folder communicate using a host serial port. None communicate with powerline devices over Ethernet. The main program of interest is int6kuart.
-
- ./scripts
-
- Miscellaneous shell scripts that call various programs in this package to perform tasks such as flashing a FW2.0 device. Care must be taken here to ensure that environment variables at the start of each script are appropriate for your system.
-
- ./ram
-
- Support modules for reading, printing and checking NVRAM and SDRAM configuration files. The .cfg files in this folder have a different format than the .config files released with the Atheros Windows Device Manager. The files distributed with the Windows Device Manger are 64 ASCII character with no checksum. The files in this directory are 32 binary bites with trailing checksum. Users may create new sdram configuration files by compiling sdram.c, using gcc -o sdram sdram.c and running it without any command line arguments.
-
- ./tools
-
- Source code and header files used by virtually all programs in the toolkit. These files are generic and have application beyond this package. They provide GNU/Linux-style or POSIX-style functionality to programs running in environments that do not have either. They also implement operations like checksum computation and multi-byte hexadecimal encoding and decoding. See Support Function Reference for more information.
-
- ./VisualStudioNET
-
- Components unique to Microsoft Windows are kept in and under this folder. Specifically, it contains a Visual Studio .NET™ solution to compile most of the programs in this package using only Microsoft and winpcap libraries. Compiled .exe files can be run on Windows™ enabled systems having winpcap installed. Adjustments may be necessary depending on your environment.
-
- Microsoft does not provide full POSIX support on Windows platforms. Consequently, alternative headers and libraries are included under this folder. For example, an abridged version of unistd.h and an alternative version of stdint.h are included under VisualStudioNET/include. Other significant header files included here are ethernet.h, if_ether.h and in.h. Subfolder VisualStudio\Library contains WinPcap™ libraries. These folders are referenced in appropriate compiler and linker options for Microsoft Development environments.
-
- The following table lists programs and the release packages that contains them. Packages contain programs of interest to various customer and engineering groups based on the activities that they normally perform. Some groups may need multiple packages. Some packages are restricted.
-
Table 1.1.
- Program/Package Matrix
-
- The toolkit is divided into 5 groups loosely based on chipset family, intended audience, network security, intellectual property, code maturity and other criteria. Some individual programs may be hard to classify and so their placement may be subject to some debate.
-
- amp-utils
-
- Tools developed for INT6000™, INT6300™, INT6400™ and AR7400™ chipsets.
-Some are obsolete but most are still useful.
-This package is a candidate for public distribution under a permissive open source license.
-
- plc-utils
-
- Tools developed for QCA6410™, QCA7000™ and AR7420™ chipsets.
-These tools handle the newer files formats, hardware boot conventsions and flash memory layouts for chipsets having fixed internal SRAM.
-This package is a candidate for public distribution under a permissive open source license.
-
- nda-utils
-
- Tools designed to manipulate parameter blocks or access reserved or restricted features on powerline devices.
-Most are useful during powerline product development and production but are not needed for proper product operation or maintenance.
-This package is reserved for Qualcomm Atheros customers who sign a non-disclosure agreement covering Qualcomm Atheros intellectual property.
-Parts of this package are candidates for some sort of restrictive license.
-
- key-utils
-
- Tools that generate HomePlug AV compliant keys from device MAC address or user passwords.
-This package is reserved for Qualcomm Atheros customers who sign a non-disclosure agreement related to Qualcomm Atheros powerline intellectual property.
-Parts of this package are candidates for some sort of restrictive license.
-
- qca-utils
-
- Tools that perform restricted or experiemental operations on active powerline devices or parameter information blocks.
-Some of these tools here are one-of-a-kind or could present security risks to active powerline networks.
-This package not not released to customers. It is reserved for Qualcomm Atheros PLC Engineering use.
-Most of this package is a candidate for restrictive license.
-
- Program
-
- amp-utils
-
- plc-utils
-
- nda-utils
-
- key-utils
-
- qca-utils
-
- source-only
-
- deprecated
-
- CMEncrypt
-
- amp-utils
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- adccap
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- ampagc
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- ampboot
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- amphost
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- ampinit
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- ampID
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- amplist
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- amprate
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- ampsnr
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- ampstat
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- amptest
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- amptone
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- amptool
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- ampwait
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- arpc
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- arpc1
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- chknvm
-
- amp-utils
-
- plc-utils
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- chknvm2
-
- amp-utils
-
- plc-utils
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- chkpib
-
- amp-utils
-
- plc-utils
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- chkpib2
-
- amp-utils
-
- plc-utils
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- config2cfg
-
-
-
-
-
-
-
-
-
-
-
- source-only
-
-
-
- coqos_add
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- coqos_info
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- coqos_man
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- coqos_mod
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- coqos_rel
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- dlinkug
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- edru
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- edsu
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- efbu
-
- amp-utils
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- efeu
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- efru
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- efsu
-
- amp-utils
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- fetchpib
-
-
-
-
-
-
-
-
-
-
-
- source-only
-
-
-
- getpib
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- grab
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- hpav
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- hpavkey
-
-
-
-
-
- nda-utils
-
- key-utils
-
- qca-utils
-
-
-
-
-
- hpavkeys
-
-
-
-
-
- nda-utils
-
- key-utils
-
- qca-utils
-
-
-
-
-
- int64host
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6k
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6kbaud
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6kboot
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6kdetect
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6kecho
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- int6keth
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- int6khost
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
- deprecated
-
- int6kid
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6klist
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6klog
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6kmdio
-
- amp-utils
-
-
-
-
-
-
-
-
-
-
-
- deprecated
-
- int6kmdio2
-
- amp-utils
-
-
-
-
-
-
-
-
-
-
-
- deprecated
-
- int6kmod
-
- amp-utils
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- int6kp
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- int6kpair
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6kprobe
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- int6krate
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6krule
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6kstat
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6ktest
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6ktone
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6kuart
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6kug
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- int6kwait
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- mac2pw
-
-
-
-
-
- nda-utils
-
- key-utils
-
- qca-utils
-
-
-
-
-
- mac2pwd
-
-
-
-
-
- nda-utils
-
- key-utils
-
- qca-utils
-
-
-
-
-
- mdioblock
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- mdioblock2
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- mdiodump
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- mdustats
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- mme
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- modpib
-
- amp-utils
-
- plc-utils
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- mrgpib
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- netifs
-
- amp-utils
-
- plc-utils
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- nvmmerge
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- nvmsplit
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- odc
-
-
-
-
-
-
-
-
-
-
-
-
-
- deprecated
-
- odd
-
-
-
-
-
-
-
-
-
-
-
-
-
- deprecated
-
- odx
-
-
-
-
-
-
-
-
-
-
-
-
-
- deprecated
-
- pcapdevs
-
- amp-utils
-
- plc-utils
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- pib2xml
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- pibcomp
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- pibdump
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- pibruin
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- pibrump
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- plcboot
-
-
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plcecho
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- plcfwd
-
- amp-utils
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plcget
-
- amp-utils
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plchost
-
-
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plcId
-
-
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plcinit
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- plclist
-
-
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plcm
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plcmmcinfo
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- plcmdio16
-
-
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plcmdio32
-
-
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plcmod
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- plcnets
-
- amp-utils
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plcrate
-
-
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plcrule
-
-
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plcset
-
- amp-utils
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plcstat
-
-
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plcsnif
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plctest
-
-
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plctone
-
-
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plctool
-
-
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- plcwait
-
-
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- po1
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- po2
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
-
-
- psgen
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- psin
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- pskey
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- psnotch
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- psout
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- ptsctl
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- pxe
-
-
-
-
-
-
-
-
-
-
-
-
-
- deprecated
-
- rkey
-
-
-
-
-
- nda-utils
-
- key-utils
-
- qca-utils
-
-
-
-
-
- sada
-
- amp-utils
-
- plc-utils
-
-
-
-
-
- qca-utils
-
-
-
-
-
- sdram
-
- amp-utils
-
-
-
-
-
-
-
- qca-utils
-
-
-
- deprecated
-
- setpib
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- slac
-
-
-
-
-
-
-
-
-
- qca-utils
-
-
-
- deprecated
-
- throwpib
-
-
-
-
-
-
-
-
-
-
-
- source-only
-
-
-
- weeder
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
- xml2pib
-
-
-
-
-
- nda-utils
-
-
-
- qca-utils
-
-
-
-
-
diff --git a/docbook/ch01s11.html b/docbook/ch01s11.html
deleted file mode 100644
index 9d42390e..00000000
--- a/docbook/ch01s11.html
+++ /dev/null
@@ -1,13 +0,0 @@
-Toolkit Support
- Contact the Qualcomm Atheros System Application Engineering Team if you have questions concerning the content, operation, application or direction of this toolkit on GNU/Linux systems. If you are having trouble communicating with Qualcomm Atheros powerline devices using the toolkit, try following the troubleshooting procedure found later in this document.
-
- Atheros Communications, Ocala FL USA designs and manufactures chipsets that permit network communications over powerline. They do no not manufacture powerline communication products for market. Instead, they provide chipsets, reference designs and expertise needed to build powerline communications products. Atheros does manufacture some sample products, in various form factors, for evaluation purposes only.
-
- Wall Adapters
-
- A small unit that plugs into any power outlet and has one RJ45 Ethernet jack. The RJ45 jack can be used to connect the unit to another Ethernet device, such as a hub, switch or computer network interface card using CAT5 Ethernet cable. Two or more such units can be used to connect Ethernet devices over the powerline. For example, a computer on one room can be connected to a network printer in another room. See Atheros Product Brief 27003417 - RD6300-ETH HomePlug® AV Wall Adapter Reference Design for more information.
-
- Desktop Adapters
-
- A compact unit having a 6ft power cord, one threaded coax cable F connector and one RJ45 Ethernet jack. Two such units can be used to connect Ethernet devices over either powerline (as above) or coax cable. Use of coax cable improves performance over longer distances and permits network segments to be isolated from each other. See Atheros Product Brief 27002824 - RD6000-ETH HomePlug® AV Ethernet Hybrid Adapter Reference Design for more information.
-
- PCI Cards
-
- A standard PCI compliant computer card having one DIN powerline connector and one threaded coax cable F connector. The card can be inserted into a PCI bus slot on a computer, or other device. Atheros provides device drivers that make the card behave like an ordinary Ethernet card. Like the desktop unit (above), computers and embedded systems can be connected either over powerline or coax cable. See Atheros Product Brief 27003239 - EK6000-PCI HomePlug® AV Card Evaluation Kit for more information.
-
- PCI cards are no longer available from Atheros but reference designs may be obtained from selected Atheros customers that specialize in PCI designs.
-
- Mini-PLC
-
- A Mini-PCI form factor card that integrates most components needed to embed HomePlug® AV into your product design. Although the card will insert into a Mini-PCI slot, it is not electrically compatible with the Mini-PCI standard. Atheros uses this card in both the RD6000-ETH Desktop Adaptor and the EK6000-PCI Card described above. See Atheros Product Brief 27002835 - RD6000-PLC HomePlug® AV Mini-PLC Module Reference Design for more information.
-
- Unlike Wall and Desktop Adapters, the Mini-PLC Cards require a device driver written for the particular operating system used. Atheros provides a device drivers for the Windows XP Operating System and for the Linux 2.4 and Linux 2.6 kernel. These drivers make the PCI card look like an ordinary Ethernet interface card.
-
- Mini-PLC cards are no longer available from Atheros but cards may be obtained from selected Atheros customers that specialize in PCI designs.
-
- Embedded Systems
-
- Atheros offers an expanding family of reference designs for powerline-enabled switches and routers. Most include onboard CPU and enablement software based on Linux, OpenWRT and other suitable operating systems. Atheros will assist customers in adapting the basic hardware and software to suite particular markets.
-
- Chipsets
-
- Atheros offers an expanding family of Powerline enabled chipsets. Several SoC chipsets are also planned to support a variety of communications applications.
-
- Atheros powerline communication chipsets serve as a transparent bridges between an Ethernet network and an active powerline or passive coax cable, effectively extending the Ethernet network. HomePlug® AV devices on the powerline, or at either end of a coax cable, will automatically detect each other and establish communications. Normal Ethernet frames that are detected by one HomePlug® AV device are passed over powerline or coax to other HomePlug® AV devices which then pass the frames on to any Etherenet devices that may be connected to them.
-
- There are three levels of communication.
-
- Powerline Communications
-
- HomePlug® AV devices use a proprietary protocol defined by the HomePlug Powerline Alliance. In most cases, HomePlug® AV communications do not leave the powerline or coax media used to connect devices. Connected devices use this protocol to detect each other, establish connection, encapsulate Ethernet frames and route them between devices. This level of communications is proprietary and hidden. See the HomePlug Powerline Alliance HomePlug® AV Specification for more information.
-
- Atheros Device Communications
-
- Atheros devices use a subset of the HomePlug® AV protocol, mentioned above, to communicate with a local host processor. The subset is known as
-
- vendor-specific messages
-
- . Atheros vendor-specific messages are intercepted and processed by Atheros devices. In some cases, they are forwared over powerline or coax to other Atheros devices. Atheros vendor-specific messages are used to interrogate, synchronize, configure and control Atheros devices without affecting HomePlug® AV devices from other manufacturers. See the Atheros HomePlug® AV Firmware Technical Reference Manual for more information.
-
- Network Traffic
-
- This is the normal network traffic that passes transparently from local Ethernet, over powerline or coax, to remote Ethernet through HomePlug® AV devices.
-
- There are several test configurations that can be used to experiment with Atheros powerline communication devices. Configurations vary based on the powerline communications devices you have available to work with. All configurations described here require at least one computer with an Ethernet card and the Open Powerline Toolkit installed. Most configurations require two Atheros powerline devices.
-
- Open Powerline Toolkit programs let the user specify which Ethernet interface card to use when sending and receiving Ethernet frames. This means that a computer with two interface cards installed can emulate two computers provided there are not internal routing conflicts. To avoid routing conflicts, Atheros recommends that you start with two computers until your are ready for more sophisticated experimentation.
-
- Open Powerline Toolkit programs default to eth0 . This allows the computer to be connected to the normal network on eth0 and connected to the powerline network on eth1. To over-ride the default powerline interfaces, set environment variable PLC to the desired interface name. All configurations assume that the Ethernet card is installed, the Ethernet driver for that card is loaded and the correct interface is enabled.
-
- Atheros powerline communication devices radiate across powerline or coax at radio frequencies. If two devices are connected, in any way, without intermmediate filters or isolation, they will attempt to commicate. Additionally, they will attempt to circumvent certain types of powerline noise or competing frequencies which can cause reduce data rates. Atheros recomends that devices under test (DUT) take their power from a shared but isolated power source like an isolation power strip or an uninterruptable power supply.
-
- ( ... explain about powerline isolation ... ) The power strip should have no filtering, surge protectors or electronic cirtuits inside.
-
- This is the simplest configuration. It establishes an Ethernet connection between the host and one powerline device. It can be used to test or program a single powerline device.
-
- It requires
-
- One host computer with an Ethernet interface card
-
- One CAT-5 Ethernet cable with an RJ-45 connector at either end.
-
- One Atheros powerline device with RJ-45 connector.
-
- Connect the local host to the powerline device with an ordinary CAT-5 Ethernet cable. Apply power to the powerline device. The local host cannot ping the powerline device because it functions at the data link layer. The local host can interrogate and control the powerline device using
-
- int6k
-
- or
-
- int6k2
-
- programs.
-
- Type "int6k -r" and note the hardware and firmware revision.
-
- Type "int6k -I" and note the device MAC, DAK and NMK.
-
-
- Type "int6k -m" and confirm that the device detects no other devices indicating proper powerline isolation.
-
- Local Host to Remote Device
-
- This configuration is the simplest powerline network configuration. It expands the previous configuration by creating a simple powerline network having two powerline devices. One device, the "local device", is connected to the host via Ethernet. A second device, the "remote device", is connected to the first via powerline.
-
- It requires
-
- One host computer with an Ethernet interface card
-
- One CAT-5 Ethernet cable with an RJ-45 connector at either end.
-
- Two Atheros powerline devices, one with RJ-45 connector.
-
- Configure the previous network then plug a second powerline device into the same power source as the first powerline device. The local host still cannot ping any Ethernet network devices because there are no remote Ethernet devices to ping but it can interrogate and control both powerline devices.
-
- Local Host to Remote Host
-
- This configuration is the simplest Ethernet network configuration. It expands the previous network by connecting the second powerline device to an existing Ethernet network through an Ethernet switch.
-
- It requires
-
- Two host computers, each with an Ethernet interface card
-
- Two CAT-5 Ethernet cables with RJ-45 connectors at either end.
-
- Two Atheros powerline devices, each with RJ-45 connector.
-
- Configure the previous network then plug the second powerline device into an Ethernet switch connected to an exiting Ethernet network. The local host can now ping other Ethernet network devices on the.
-
- The Open Powerline Toolkit is a collection of independent programs. Individually, they perform basic but useful operations on powerline communication devices and associated support files such as PIB and NVM files. Collectively, they can perform many types of engineering experiments, functional tests and production tasks. Their simplicity and high degree of flexibility lets customers adapt an off-the-shelf linux host to meet a wide range of production requirements. We call this configuration a “powerline workstation”.
-
- This section explains how to configure a powerline workstation and setup the Open Powerline Toolkit on that workstation. It covers some necessary aspects of Linux and the Toolkit but it is not a Linux tutorial or a Open Powerline Toolkit tutorial. Linux essentials are covered on the Internet and Open Powerline Toolkit essentials are covered in other sections of this documentation and on-line man pages. Although some typical configurations are illustrated, many variations are possible and are left to the customer to develop based on our examples. There is no single correct way to do anything.
-
- Host Hardware
-
- A powerline workstation host has no special hardware requirements. Any host capable of running Linux and supporting multiple Ethernet cards will do. For example, a 450mhz CPU having 128mb of memory, one 3gb disk and three 10/100 Ethernet cards is adequate.
-
- Production tasks such as device initialization or firmware upgrade require one Ethernet card. Experimentation and functional testing typically require two Ethernet cards. Atheros recommends three Ethernet cards so that the host can communicate with other hosts over a local area network while talking to powerline devices. Atheros also recommends that all Ethernet cards installed support at least 100mbps and be of the same type to simplify network configuration.
-
- Host Software
-
- Atheros recommends installiing a Debian-based or Ubuntu-based Linux distribution due to the simplicity of network configuration. Redhat™-based or SuSE™-based distributions are also acceptable. A complete GNU toolchain is required to compile and install the Open Powerline Toolkit. Atheros uses GNU make 3.8.0, GNU gcc 3.3.5 and GNU ld 2.15. If these components are not installed then you must install them. Linux system installation and configuration is beyond the scope of this documentation but there is a wealth of information available on the Internet.
-
- Of course, the Open Powerline Toolkit needs to be installed and successful installation proves that all required Linux components are installed correctly. See Installation on Linux for more information on how to install the Open Powerline Toolkit.
-
- Network Configuration
-
- Linux will assign interface names like eth0, eth1 and eth2 to each installed network card. Atheros recommends that eth0 be connected to your local network so that you can communicate with other hosts on that network. The other two interface cards can then be connected to Atheros devices that are plugged into an isolated power-strip. Of course, one CAT-5 Ethenet cable will be needed for each Ethernet card installed.
-
- Interfaces eth1 and eth2 should be assigned IP addresses on a separate sub-net so that you can ping one card from the other over the powerline without sending traffic over the local network. Remember that powerline devices have MAC addresses but not IP addresses. Also, Linux ping uses the routing table to route messages and so you may need to use the -I option when pinging over the powerline. Otherwise, ping packets may go out over the local network by default.
-
-# ifconfig
-eth0 Link encap:Ethernet HWaddr 00:50:04:A5:D9:5A
- inet addr:192.168.99.12 Bcast:192.168.99.255 Mask:255.255.255.0
- UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
-
-eth1 Link encap:Ethernet HWaddr 00:01:03:2B:03:67
- inet addr:192.168.101.10 Bcast:192.168.101.255 Mask:255.255.255.0
- UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
-
-eth2 Link encap:Ethernet HWaddr 00:01:03:2B:03:73
- inet addr:192.168.101.11 Bcast:192.168.101.255 Mask:255.255.255.0
- UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
-
-lo Link encap:Local Loopback
- inet addr:127.0.0.1 Mask:255.0.0.0
- UP LOOPBACK RUNNING MTU:16436 Metric:1
-
- The abbreviated ifconfig console display, shown above, illustrates a typical Ethernet configuration using three cards, as recommended by Atheros. Interface eth0 is on the 192.168.99.0 subnet which serves as the local network, in this case. Interfaces eth1 and eth2 are both on the 192.168.101.0 subnet which serves as the powerline network, in this case.
-
- Although not required, installing both wireshark and tshark is a great idea because they can be used to monitor and log network traffic on any or all of the Ethernet interfaces during various operations.
-
- Isolated Power-strip
-
- Atheros devices have a way of finding each other over powerline and sometimes across nearby powerlines. Power-strip isolation prevents cross-talk with other powerline devices that may be plugged into nearby. Proper isolation is not critical when getting started but can be critical in technical evaluation and production environments.
-
- There are many ways to isolate powerline devices. One way is to plug the powerline workstation and the power-strip into an Uninterruptable Power Supply (UPS). Atheros also provides several reference designs for both expensive and inexpensive hardware that can be used to isolate devices and workstations.
-
- Atheros powerline devices tend to work best when there is some signal attenuation over powerline or coax connections. Engineering evaluation configurations should insert some type of variable attenuation between powerline devices to measure the performance of their own powerline device designs. Consult with your Atheros Field Application Engineer on this matter.
-
- One advantage of Linux™ powerline workstations is the ability to control the low-level networking environment. ISO Layer 2 traffic can be easily directed from one Ethernet interface to another on the same host but Layer 3 traffic is a different matter because routing software merely routes this type of traffic internally.
-
- A Linux™ kernel patch is available that will allow ISO Layer 3 traffic to be routed from one Ethernet interface to another on the same host. With this patch, multiple instances of a traffic generator, like ttcp or iperf, can be effectively deployed on the same host without modification.
-
- This patch is useful for testing on a closed network but it could pose a security risk to the local host when connected to a public network. Kernels having this patch installed should have a special designation such as “linux-2.6.28-send-to-self” so that users are aware that the patch is installed.
-
Example 2.1.
- “send-to-self” Patch Description
-
- The following is the full, original patch description.
-
- Send-To-Self interface flag
- Julian Anastasov <ja@ssi.bg>, July 2003
-
- Patches for different kernels:
-
- send-to-self-2.4.21-1.diff
- send-to-self-2.5.73-1.diff
-
- The presented patch implements routing of traffic between local
-IP addresses externally via ethernet interfaces. This patch is basically
-the Ben Greear's send-to-self work but reimplemented entirely on routing
-level. The idea is to return output route via external interfaces if
-path between two local IP addresses is requested and they are configured
-on different interfaces with /proc/sys/net/ipv4/conf/DEVNAME/loop set to
-1. As result, arp_filter (if enabled - the recommended value)
-automatically accepts the ARP requests on the right interface. The
-rp_filter check is modified to accept traffic from such interfaces with
-local IP as sender, so using loop=1 for interfaces attached to insecure
-mediums is not recommended.
-
-Pros:
-- it can be used from all existing applications without change
-- it is not limited to 2 interfaces
-- you can use it with many IP addresses
-- does not depend on the rp_filter and arp_filter states, they
-can be set to 1
-- the packets are not altered in any way, useful for QoS testings
-- the routing result is cached, the routing checks are not per packet
-
-Cons:
-- not possible to use it for interfaces attached to insecure
-mediums (the rp_filter protection allows saddr to be local IP).
-By design. Use at your own risk.
-
- The usage is simple:
-
-# Connect two or more interfaces to same hub or via crossover cable
-
-# Enable loopback mode for eth0 and eth1. This even can be
-# default mode without breaking any other talks. By this way
-# we allow external routing only between local IPs configured
-# on the specified interfaces.
-
-echo 1 > /proc/sys/net/ipv4/conf/eth0/loop
-echo 1 > /proc/sys/net/ipv4/conf/eth1/loop
-
-# Add some IP addresses for testing, eg. client and server IP
-
-ip address add 192.168.1.1 dev eth0
-ip address add 192.168.2.1 dev eth1
-
-# Testing with applications that are aware of this binding.
-# The main thing the apps need to know is what src and dst IP
-# addresses to use. The client app needs to bind to the src IP
-# and by this way to request output route to the dst IP. There
-# is no specific configuration for the server app listening on
-# 192.168.2.1
-
-ping -I 192.168.1.1 192.168.2.1
-
-# Note that specifying the output device (SO_BINDTODEVICE is
-# not recommended)
-
-
-# Testing with applications that are not aware of this feature:
-# for 192.168.1.1 client (the same for the server is not needed).
-# Note that by default, in local routes the kernel uses the local
-# IPs as preferred source. This is the safe default mode (if loop=1)
-# for applications that do not care what src IP will be used
-# for their talks with local IPs. We try to change that and to
-# use IPs from different interfaces.
-
-ip route replace local 192.168.2.1 dev eth1 scope host src 192.168.1.1 proto kernel
-
-# but for any case, here it is and for the "server":
-
-ip route replace local 192.168.1.1 dev eth0 scope host src 192.168.2.1 proto kernel
-
-# Testing it:
-
-ping 192.168.2.1
-ping -I 192.168.1.1 192.168.2.1
-telnet 192.168.2.1
-
-# Note that by replacing the local route's preferred source IP address
-# we help the IP address autoselection to select proper IP to the
-# target, in our case, route via eth
-
Example 2.2.
- “send-to-self” Patch Application
-
- The following example illustrates how to use iperf to perform TCP and UDP traffic measurements once this patch is installed. We illustrate the use of iperf but do not necessarily endorse it for traffic measurement. We also illustrate the use of two interfaces but the “send-to-self” patch will support additional interfaces. We also illustrate the use of environment variables so that procedures can execute on different hosts without modification but these environment variables are not required.
-
- First, we define environment variables, IF1 and IF2, for each Ethernet interface and, IP1 and IP2, for their IP addresses. Each interface must be on a separate IP subnet. We export definitions here so that they are accessible to this process and any subprocesses, such as shell scripts. Do whatever is appropriate for your environment.
-
- Next, we assign the IP addresses to the interfaces using program ifconfig. There are other ways to do this. Observe that we reference our environment variables on the command line.
-
-ifconfig ${IF1} ${IP1}
-ifconfig ${IF2} ${IP2}
-
- Next, we suppress internal routing between local interfaces. The loop propery only exists on kernels that have the “send-to-self” patch installed and have the /proc filesystem mounted. Some systems may not mount this file system.
-
- Alternately, you could edit file /etc/sysctl.conf, as follows, to set the loop property for each interface during system startup. Again, the loop propery only exists on kernels that have the “send-to-self” patch installed and so errors will occur if you boot another kernel that does not have it installed.
-
- Open a console window and start iperf as a server. Option -s identifies this instance of iperf as the server. Option -B binds this instance to one host interface by IP address, in this case IP1 defined earlier.
-
-iperf -B ${IP1} -s
-------------------------------------------------------------
-Server listening on TCP port 5001
-Binding to local address 192.168.1.1
-TCP window size: 85.3 KByte (default)
-------------------------------------------------------------
-
- Open a second console window and start iperf as a client. Option -c identifies this instance of iperf as a client. Option -B binds this instance to the one interface by IP address, in this case IP2 defined earlier. The server address must also be specified, in this case IP1 bound to the server in the last step.
-
-iperf -B ${IP2} -c ${IP1}
-------------------------------------------------------------
-Client connecting to 192.168.1.1, TCP port 5001
-Binding to local address 192.168.2.1
-TCP window size: 16.0 KByte (default)
-------------------------------------------------------------
-[ 3] local 192.168.2.1 port 5001 connected with 192.168.1.1 port 5001
-[ ID] Interval Transfer Bandwidth
-[ 3] 0.0-10.0 sec 31.1 MBytes 26.0 Mbits/sec
-
Example 2.3.
- “send-to-self” Patch Installation
-
- The “send-to-self” patch exists for several recent Linux™ kernel versions but not all versions. Assuming you have obtained the correct kernel archive and the correct patch version, the following script illustrates the steps needed to apply the patch on Ubuntu 9.04™ and recompile the kernel. Observe that, in this case, the patch version does not match the kernel version because a patch has not been published for that kernel version.
-
- The following script can be used on a Ubuntu Linux distribution to download kernel source, the send-to-self patch, apply the patch then compile and install the resulting kernal image. When the menuconfig screen appears:
-
- Select General Setup on the “Linux Kernel Configuration” screen.
-
- Select Local version - append to kernel release on the “General Setup” screen.
-
- Enter the version suffix “-send-to-self”.
-
- Select ok to return to the “General Setup” screen.
-
- Select Automatically append version information to the version string on the “General Setup” screen.
-
- Select exit to return to the “Linux Kernel Configuration” screen.
-
- Select exit to close the menuconfig program.
-
- Select yes if prompted to save your new kernel configuration. This message does not appear each time.
-
- The apt-get program is only available on Debian-based distributions. If you do not use a Debian-based system then you must find another way to obtain the necessary packages. Option --reinstall instructs apt-get to download the kernel even though it has been installed before. It is not needed on the first script execution but may be needed on subsequent script executions if you have deleted the kernel archive file.
-
- mkinitramfs
-
- This script uses mkinitramfs instead of the mkinitrd. This may differ on other distributions. The kernel source package used here has Ubuntu™ modifications that result in a minor version being appended to the kernel version. This may not happen with other distributions or with kernels obtained directly from kernel.org.
-
- cut-and-paste
-
- This script, or some like it, are included in the ./patches folder of the toolkit. You can also copy and paste this script but remember to edit the environment variables at the top, remove all carriage returns and set correct file permissions with chmod 0755 before executing it on your Linux™ host. Run the script as root user.
- grub/menu.lst
-
- If your system uses grub then edit file /boot/grub/menu.lst and add a new reference to the new initrd.img, System.map and vmlinuz files installed in folder /boot by this script. We recommend adding these references as the last ones in the file so that the new kernel does not start by default. Once you are confident that everything works, you can then move the references to the first entry. We also recommend setting the timeout value to 10 for now.
-
Example 2.4.
- “send-to-self” Patch Listing
-
- The following “send-to-self” patch is specifically for Linux™ kernel 2.6.30 and is provided for information only. For practical purposes, the patch has not changed much from version to version but the line numbers have changed. Some recent “send-to-self” patches are included in the toolkit ./patches folder.
-
- The Open Powerline Toolkit is designed to support hardware engineers and embedded software developers working on GNU/Linux and Linux-like systems. Debian GNU/Linux is the platform of choice because it is open source and has extensive cross-platform support. The toolkit has been compiled and executed on several platforms but Qualcomm Atheros does not necessarily support the toolkit on those platforms. Qualcomm Atheros has made every effort to enable cross-platform compatibility by conforming to POSIX standards and following good programming practice but there are limitations on any such effort.
-
- Toolkit programs are installed in /usr/local/bin with owner root and group root (chown root:root) and with read and execute permissions for owner, group and others (chmod 0555). This lets anyone execute these programs even though they are owned by user root.
-
- Additionally, programs that send raw Ethernet frames are installed with seteuid owner (chmod 4555) so that they will execute with root user privileges, regardless of the user executing them. This lets any user send raw Ethernet frames but it also presents a security risk on the host computer. For example, program int6k is intended to read and write .nvm and .pib files but a malicious user could use it to overwrite other files normally protected by standard file permissions.
-
- You can change the default file permissions by changing the -m 4555 option on the install command in various Makefiles. Be aware that doing so will restrict program access to the the root user.
-
- Qualcomm Atheros makes no claim that the Open Powerline Toolkit will compile and link in all environments without generating warnings or errors. Different compilers, and compiler versions, treat certain conditions differently and different distributions include different header files or define standard constants and macros differently. Developers should expect to make some source code and makefile modifications to match their environment.
-
- The principle consideration is support for raw Ethernet frames. Other considerations include POSIX compliance, system header file locations, compiler version and library support. This section discusses some of these considerations.
-
- GNU/Linux
-
- The toolkit will compile and execute on GNU/Linux systems without modification by using standard Linux header files and native Linux libraries. Raw socket support is native to the Linux Kernel. This is the preferred environment due to cost, networking speed and ease of access to Layer 2 networking.
-
- Qualcomm Atheros has cross-compiled and executed versions of the toolkit on MontaVista™ and AMiLDA™ Linux both for MIPSEL™ processors. Most toolkit makefiles have symbolic hooks for cross-compilers but Qualcomm Atheros does not support cross-compilation efforts on any platform.
-
- GNU/Linux with Libpcap
-
- The toolkit can compile and will execute on GNU/Linux systems having the libpcap development package and runtime libraries installed; however, this feature is disabled by default because it is not needed on Linux and offers no benefits over native Linux sockets.
-
- GNU/Linux with BPF
-
- The toolkit should compile and execute on GNU/Linux systems having BPF compiled into the kernel but modifications would be needed to toolkit source code. This configuration has not been tested but the source code is present to support it. Consult Qualcomm Atheros if this option is of interest to you.
-
- Mac OS X™ with BPF
-
- The toolkit will compile and execute on Mac OS X without modification by using native BPF support compiled into the Darwin kernel. Compilation is clean on Leopard and should be fairly clean on Tiger.
-
- You may observe compiler warnings concerning the size_t data type and print statements. These warning occur because Mac OS X defined the size_t data type as a 64-bit integer while most other systems define it as a 32-bit integer. Ignore the warnings. We will eventually eliminate them all.
-
- You may observe a compiler warning concerning the definition of intrinsic function snprinf. We are not sure what causes this warning but it will be corrected eventually.
-
- Windows XP™ with Winpcap
-
- The toolkit will compile and execute on Microsoft Windows XP™ having WinPcap 4.0.1 runtime libraries installed. To assist windows developers, the toolkit includes a Microsoft Visual Studio .NET 2003™ solution file plus required WinPcap 4.0.1 header files and libraries. The resulting programs should execute on any Microsoft Windows™ computer having WinPcap 4.0.1 runtime libraries installed. Qualcomm Atheros does not support the toolkit under any Microsoft Windows™ operating system at this time.
-
- Recent versions of the toolkit include self-extracting file .\VisualStudioNET\WinPcap4_0_1.exe that installs WinPcap 4.0.1 libraries on your system in cases where you have another version installed. If this creates a conflict the you must resolve it to satisfy your system requirements.
-
- This is not the preferred Toolkit environment due to cost, networking overhead, difficulty accessing Layer network support and lack of a powerful native scripting language. Qualcomm Atheros has not implemented all Toolkit programs on Windows for technical reasons.
-
diff --git a/docbook/ch03s04.html b/docbook/ch03s04.html
deleted file mode 100644
index 65ae9973..00000000
--- a/docbook/ch03s04.html
+++ /dev/null
@@ -1,51 +0,0 @@
-GNU Makefiles on Linux
- The toolkit includes recursive GNU makefiles for Linux. The Makefile in the root folder calls Makefiles in subordinate folders. Makefiles in subordinate folders can be run independently to produce individual toolkit components. Developers can control which components are compiled and installed by editing the FOLDERS symbol in the main Makefile.
-
- Component Makefiles have a standard format that includes the following targets:
-
- compile
-
- Compiles source code files prior to installation. Intermmediate files and target files are created in the same folder as the Makefile. This is the default target. That means that typing make or make compile have the same result.
-
- library
-
- Creates any special folders that are needed for installation. This target is built by the install target but it can be built independently.
-
- scripts
-
- Installs scripts required for proper toolkit operation. This target must be built explicitly to prevent accidental loss of changes made to existing scripts. This target may be built at any time, before or after the install target.
-
- manuals
-
- Creates manuals, documents or html pages. Documentation files are not automatically installed by any target. Installation is left to the user.
-
- install
-
- Installs executable files in folder /usr/local/bin. This target automatically builds the compile target before installation. This means that make install will compile and install in one step.
-
- uninstall
-
- Removes installed components. This target does nothing for Makefiles that have install targets defined.
-
- clean
-
- Removes intermmediate and temporary files. Temporary files are defined by variable TRASH at the start of each Makefile.
-
- fresh
-
- Removes intermmediate and temporary then re-compiles local targets. It is normally equivalent to make clean followed by make compile.
-
- Developers wanting to compile the toolkit under Windows™ should use Visual Studio .NET™ solution files instead of makefiles.
-
- Developers wanting to compile the toolkit under OpenBSD must make changes to accommodate variations in make program syntax.
-
- You do not need makefiles to build toolkit programs because source files explicitly include all required components using include statement blocks like that shown below. You will see similar blocks near the top of most programs.
-
- This mechanism has several advantages. First, the preprocessor include statements form a complete inventory of required files. Secondly, the relative pathnames help developers locate needed source files. Third, the complete program can be compiled with one gcc command, like the one shown below. This allows program compilation in environments where the GNU make program or the Atheros Makefiles are not available.
-
Example 3.2.
- Stand-alone Compiling on GNU/Linux
-
-# gcc -o program program.c
-
- Most toolkit makefiles define the preprocessor constant MAKEFILE as a compiler option using CFLAGS= ... -DMAKEFILE .... When this constant is defined, the compiler will not include components inside an include block like that shown above and so the Makefile is responsible for compiling and linking all components. If the constant is not defined, because no Makefile was used, the compiler will merely include everything needed.
-
- Makefiles are setup for cross-compilation using custom toolchains. File make.def, in the main toolkit folder, defines cross-comilation symbols referenced in lower-level makefiles. Lower-level makefiles include make.def before building their targets. The following is an example make.def file used when cross-compiling for the ADM5120 MIPSEL-based gateway.
-
- Developers are encouraged to make changes in this file rather than adding additional variables to the lower-level makefiles. For example, you can edit variable BIN to install toolkit programs in some location other than /usr/local/bin or variable WWW to install HTML documentation on your local website.
-
diff --git a/docbook/ch03s07.html b/docbook/ch03s07.html
deleted file mode 100644
index fe8f8061..00000000
--- a/docbook/ch03s07.html
+++ /dev/null
@@ -1,27 +0,0 @@
-Compilation with Visual Studio .NET 2003
- To build the Open Powerline Toolkit on Windows XP, you must have access to a Windows computer with Visual Studio .NET 2003 and WinPcap runtime libraries installed. WinPcap is an open source version of the packet capture library, libpcap, widely used on Linux and OpenBSD systems. It is readily available on the Internet. Installation of these components is beyond the scope of this document.
-
- The Windows and Linux versions of the Open Powerline Toolkit use the same code base but the Windows version requires a Microsoft solution file that includes special compiler settings and specific POSIX header files. The solution file and header files are included in the same archive as Linux version.
-
Example 3.4.
- Microsoft Visual Studio .NET 2003
-
- Use an application like WinZip to extract archived files into a build folder of your choice. Use Windows Explorer to locate solution file .\VisualStudioNET\plc-utils.sln under the toolkit root folder. Double-click the file to open it with Visual Studio .NET. In Visual Studio .NET, open the Solution Explorer window and observe a display similar to that shown above.
-
- Figure 1 illustrates a Visual Studio .NET window with the Solution Explorer pane exposed. In the Solution Explorer window, right-click the plc-utils solution and select the Rebuild menu option. Compiliation should begin. Watch for comilation errors.
-
- On successful compilation of all projects in this solution, you should find executable programs in the Release folder under each project folder. If not then look in the Debug folder, instead. You can now open a console window, change to each Release or Debug folder in turn and run the programs located there. Instead, we recommend that you create a Windows Installer package by right-clicking on the Install project in the Solution Explorer window and selecting the Build menu option. Compilation should resume.
-
- On successful completion of the install project build, you should find the Windows Installer file plc-utils.msi in the VisualStudioNET folder above the install project folder. Double-clicking on this file will start the Windows Installer program.
-
- To distribute the toolkit package to other Windows computers, copy the Windows Installer file to a public network share or some type of portable media.
-
- The Atheros Open Powerline Toolkit includes a Visual Studio .NET™ solution file, ./VisualStudioNET/plc-utils.sln, that will build the toolkit on Windows XP SP2 from the Linux code base. The following information may be helpful to developers wanting to modify or extend the solution or port it to another version of Microsoft Visual Studio:
-
- All projects are WIN32 Console Projects.
-
- All projects have pre-compiled headers suppressed.
-
- All projects should globally define preprocessor constant MAKEFILE to prevent proliferation of "already defined" link errors. See Stand-alone Compiling on GNU/Linux for an explanation of this constant.
-
- All projects search folder ..\include for stdint.h and unistd.h because Microsoft does not provide them. These header files are customized or abbreviated versions of their POSIX counterparts and should be used when originals are available.
-
- Projects that perform raw Ethernet I/O should globally define preprocessor constant WINPCAP to enable appropriate code segments. Preprocessor error statements should (but may not) alert you if WINPCAP is not defined on Windows™ platforms.
- Projects that perform raw Ethernet I/O search folder ..\include for WinPcap header files. These files are taken from the WinPcap development package and may require periodic updates. Header files pcap.h, pca-stdinc.h, pcap-bpf.h, ipv6_misc.h and bittypes.h belong in folder VisualStudioNET\include. Other header files belong in folder VisualStudioNET\include\pcap.
-
- Projects that perform raw Ethernet I/O should include folder ..\library for core WinPcap libraries.
-
- Projects that perform raw Ethernet I/O should link to libraries ws2_32.lib, packet.lib and wpcap.lib. The first library is the Microsoft Winsock2 library. The others are core WinPcap libraries.
-
- Atheros Open Powerline Toolkit programs reference POSIX functions and constants where possible. Specifically, they make wide use of the data types uint8_t, uint16_t and uint32_t which are defined in file stdint.h. Microsoft Visual C™ and .NET™ environments do not include this file. Consequently, Atheros provides an alternative in folder ../Windows/include. This file is open source and was designed to be compatible with the Microsoft development environments; however, you may occassionally experience warnings about the "benign redefinition" for some of these data types.
-
- Where possible, this toolkit includes OpenBSD™ network constants because the OpenBSD project pioneered many of the common network protocols and applications used today. Some systems do not include all OpenBSD™ network header files or do not define all OpenBSD™ network constants. Specifically, Microsoft systems do not provide file netinet/if_ether.h and so an alternative is included in folder ../Windows/include/netinet and Windows™ applications should include it.
-
- When the gcc -std=iso9899:1999 option is enabled, some OpenBSD™ header files found on GNU/Linux systems will exclude required constant definitions because they do not conform to that standard. Atheros is investigating the best way to address this problem.
-
- On some systems, such as OpenBSD™, FreeBSD™ and Mac OS X™, header files must be included in specific order to avoid compilation errors. We have done our best to deal with this problem. Visit the GNU Autocnf Project for more information about this.
-
- Platform constants conditionaly compile source code blocks based on the hardware architecture and host operating system. Hardware architecture constants are normally defined in system header files. Operating system constants are often compiler intrinsic or defined in system header files.
-
- __APPLE__
-
- A intrinsic compiler constant indicating Mac OS X™ operating system support.
-
- __BYTE_ORDER
-
- A standard constant indicating big or little endian host architecture. Some systems may not define this constant and so an alternative should be used.
-
- LIBPCAP
-
- An Atheros constant, that must be manually defined in your makefile or solution file, to indicate that the target host will have LibPcap support. It is not used by the toolkit, at this time, and so the associated code has not been tested.
-
- __linux__
-
- A standard constant indicating GNU/Linux™ kernel support. It is automatically defined on GNU/Linux™ systems.
-
- __OpenBSD__
-
- A standard constant indicating OpenBSD™ kernel support. It is automatically define on OpenBSD™ systems. It is not used by the toolkit, at this time, and so the associated code has not been extensively tested.
-
- WIN32
-
- A standard constant indicating Microsoft Windows™ support. It is automatically defined in Microsoft Windows™ environments.
-
- WINPCAP
-
- An Atheros constant, that must be manually defined in your makefile or solution file, to indicate that the target host will have WinPcap support. The toolkit only defines this constant in Windows Microsoft project files for programs that perform raw Ethernet I/O.
-
- Ethernet Constants
-
- The toolkit attempts to use existing definitions for Ethernet related constants where possible. This has been problematic due to inconsistencies in the way different systems structure their header files. Most of the following definitions already exist on Linux™, OpenBSD™ and OS X™ but there are still some differences between Linux™ distributions and many constants are undefined on Windows™.
-
- The Windows™ version of the toolkit includes an abbreviated net/ethernet.h that provides constant definitions mentioned in this section.
-
- ETHER_ADDR_LEN
-
- The length of an Ethernet hardware address in bytes. The value is 6 bytes. On Linux™ and OS X™, this is defined in net/ethernet.h.
-
- ETHER_CRC_LEN
-
- The length of an Ethernet frame FCS trailer. The value is 4 bytes. On Linux™ and OS X™, this is defined in net/ethernet.h. Atheros also includes a conditional definition in int6k/int6k.h because some Linux™ system do not define it anywhere.
-
- ETHER_HDR_LEN
-
- The length of an Ethernet frame header including the source address, destination address and type/length field. The value is 14 bytes or ETHER_ADDR_LEN + ETHER_ADDR_LEN + ETHER_TYPE_LEN. On Linux™ and OS X™, this is defined in net/ethernet.h.
-
- ETHER_MAX_LEN
-
- The maximum length of an Ethernet frame in bytes. The value is 1518 bytes of ETHER_HDR_LEN + ETHERMTU + ETHER_CRC_LEN. On Linux™ and OS X™, this is defined in net/ethernet.h.
-
- ETHER_MIN_LEN
-
- The minimum length of an Ethernet frame in bytes. The value is 64 bytes. On Linux™ and OS X™ this is defined in net/ethernet.h
-
- ETHER_TYPE_LEN
-
- The length of Ethernet type/length, or ethertype, field in bytes. The value is 2. On Linux™ and OS X™, it is defined in net/ethernet.h.
-
- ETHERMTU
-
- The maximum transfer unit (ie; data handling capacity) for an Ethernet frame in bytes. The value is 1500 bytes. On Linux™ and OS X™, this is defined in net/ethernet.h
-
- LibPcap is an open source Ethernet packet capture library that is widely used. It provides core functionality for the Wireshark packet sniffer, formerly known as Ethereal.
-LibPcap libraries are available for Linux and OpenBSD. On Linux and OpenBSD you must link applications to libpcap.a and libwpcap.a. The toolkit does not use either of these libraries on Linux because they are not needed there.
-
- WinPcap is an open source version of LibPcap written for Microsoft Windows™. The WinPcap libraries let Windows applications send and receive raw packets. On Windows™ you must link applications to Packet.lib and wpcap.lib.
-
- In principle, the LibPcap and WinPcap library implementations should function identically but they do not; however, they are similar enough to provide a useful degree of platform independence. Defining preprocessor constants LIBPCAP or WINPCAP when compiling the toolkit will enable the corresponding source code. This can be done by adding "-DLIBPCAP" or "-DWINPCAP" to variable LFLAGS in file Makefile in folders int6k, int6k2, efsu and hpav. Constant WINPCAP need only be defined this way when compiling the toolkit using cygwin™ or mingw™ environments. Do not define both constants LIBPCAP and WINPCAP at the same time or compiler errors will occur.
-
- Berkeley Packet Filters (BPF) is an open source Ethernet packet capture mechanism available on many UNIX™-like systems. Native BPF is supported on some systems but must be explicitly compiled into the kernel on other systems. Linux™ systems normally do not support BPF by default but Mac OS X™ does and so we automatically use it whenever compiler constant __APPLE__ is defined. In principle, one could compile a custom Linux™ kernel with BPF enabled.
-
Programs in this toolkit make extensive use of packed data structures to simplify source code and guarantee reliability; however, this creates portability issues because different compilers implement structure packing in different ways. Three common structure packing mechanisms are:
- _packed
-
- The __packed keyword is not part of any C or C++ standard but it is recognized by some compilers, such as the ARM C/C++ and OpenBSD C compiler. This keyword only affects the data structure that it prefaces and it is an ideal way to selectively pack structures. It can be easily defined and undefined using a preprocessor macro. Atheros has elected to insert this keyword wherever it might be appropriate. The ARM C compilers accept this keyword.
-
Example 3.5.
- Packing Structures with keyword “__packed”
-
- Attributes are not part of any C or C++ standard but they are recognized by the gcc and Sun Microsystems C compiler. Attributes only affect structures and functions that reference them in their declaration. This is convenient because we can use a preprocessor macro to define the keyword __packed, mentioned above, to be __attribute__ ((packed)). Atheros includes this definition in tools/types.h and OpenBSD does this in their system header files.
-
Example 3.6.
- Packing Structures with Attribute “packed”
-
- Pragmas are part of most C and C++ language standards but some compilers do not recognize or implement the pack pragma. In addition, different compilers implement it in different ways. The pack pragma affects all data structures up the next pack pragma or end of compile unit. Most pragma implementations accept the push and pop option for pragma nesting. Some pragma pack implementations accept no arguments, most permit either one or two arguments while others allow three arguments. OpenBSD does not recognize this pragma and generates warnings in all cases. Aside from all that, the pack pragma is the most widely supported method for declaring packed structures.
-
Example 3.7.
- Packing Structures with the Pragma “pack”
-
- Atheros vendor-specific messages contain information in mixed endian format. The Ethernet header portion is sent big endian but the Atheros header and payload are sent in little endian . The traditional endian converstion functions htons(), htonl(), ntohs() and ntohl() can be used to perform platform independent conversions on the Ethernet header but not the Atheros header payload.
-
- The Open Powerline Toolkit includes similar macros HTOLE16, HTOLE32, LE16TOH and LE32TOH in endian.h which serve the same function but conform to recommendations for standarized byte order function on Linux, OpenBSD and FreeBSD. Observe that the names are independent of any network implications.
-
- Local and remote HomePlug® AV powerline devices are managed by sending Ethernet frames that contain HomePlug AV® formatted management messages. These frames have an 802.3 Ethernet header and a payload that contains the Management Message (MM).
-
- The Ethernet header must be transmitted in newtwork byte order which is big-endian. The Ethernet payload must be sent in ARM™ host byte order which is little endian. You should use standard network functions htons() and htonl() to write Ethernet headers and ntohs() and ntohl() to read them. You should use function HTOLE16() and HTOLE32() to write integer payload values and LE26TOH() and LE32TOH() to read them.
-
- Ethernet headers consist of a destination address (ODA), a source address (OSA) and an ethertype (MTYPE). The ethertype is always 0x88E1 for Homeplug frames of any type. Programmers may use either function EthernetHeader.c or EncodeEthernetHeader to encode a buffer with the ODA and OSA and the HomePlug ethertype. An example appears later on. Structure header_eth is defined in ihp.h for this purpose.
-
-+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ ... +---+---+
-| ODA | OSA | MTYPE | Ethernet Payload |
-+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+---+ ... +---+---+
-
- Management messages consist of a message header (MMHEADER) and a message entry (MMENTRY). The message header identifies the nature of the message entry that follows it. The acronyms MME and MMENTRY both mean Management Message Entry but they are often used to mean the entire management message or Ethernet frame. This imprecise usage can be confusing at times. Structure header_mme is defined in ihp.h for this purpose.
-
- The message header contains message protocol version (MMV), message type (MMTYPE) and vendor identifier (OUI). The management message entry (MMENTRY) that follows the header contains information unique to a the request (REQ), confirmation (CNF), response (RSP) or indication (IND). Programmers may use the Atheros EncodeAtherosHeader function to encode a buffer with a specific MMTYPE and the Atheros MMV and OUI. AN example appears later on.
-
- The MMV value, within MMHEADER, indicates the Homeplug AV Management Message protocol version which determines how the message should be interpreted. The protocol version is defined in the HomePlug AV Specification and may change from time to time. One notable change is the recent insertion of an FMI (Fragment Management Information ) field between MMTYPE and OUI , as shown below.
-
- In most cases, protocol changes are hidden from the application by the Atheros API functions; however, software developers should set the HOMEPLUG_MMV constant, defined in ihp.h, to the version appropriate for their firmware or application. The value of this constant enables or disables conditional compilation statements throughout the HomePlug API code base.
-
- To send an MME, you must encode an Ethernet frame buffer with information and transmit it. To read an MME, you must read an Ethernet frame buffer and decode it. The information necessary to encode or decode Atheros vendor-specific Ethernet frames is covered in the INT6000™ Firmware Technical Reference Manual; however, the Atheros HomePlug API includes many buffer encode and decode functions that support basic operational requirements.
-
- The following technique illustrates one way to encode a frame buffer with an Ethernet header followed by an Atheros message header. We first declare the frame buffer then a length variable to keep track of how many bytes have actually been encoded. At any time, the value 'buffer + length' is the address of the next buffer position to encode and the expression 'sizeof (buffer) - length' is the number of un-encoded bytes remaining in the buffer. Each call to an encoding function will increment the length for the next operation. This technique minimizes the number of intermmediate application variables and makes maximum use of compiler generated constants.
-
- For those who prefer to use pointers, the following technique accomplishes the same thing because. At any given time, the value bp - buffer is the encoded length.
-
- An Atheros chipset consists of an integral CPU, ROM and proprietary circuitry. The CPU requires a minimum amount of external SDRAM to execute runtime software and store runtime configuration parameters. The INT6000™ chipset also requires a minimum amount of external flash memory in order to start. The INT6300™ can use external flash memory in the same way as the INT6000™ or it can use a local host processor as surrogate flash memory.
-
- On startup, the SDRAM memory controller must be configured before runtime firmware and parameters are loaded. On the INT6000™, runtime firmware and configuration parameters must be loaded from external flash memory. On the INT6300™, it may be loaded from external flash memory or from a external host processor. Runtime firmware determines device capability. Runtime configuration parameters determine device network identity and personality.
-
- The following sections identify and describe firmware related components and discuss some of the routine actions required to manage them. Consult the Atheros HomePlug AV Hardware Technical Reference Manual and HomePlug AV Firmware Technical Reference Manual for more information.
-
- Device initialization involves the following components. They are described here and then referenced throughout the toolkit documentation. You may want to read and re-read this page.
-
- Bootloader
-
- The Bootloader is permanent software burned into the chipset. The INT6000™ and INT6300™ both have a Bootloader program but they behave differently because the INT6000™ needs flash memory and the INT6300™ does not. Neither the INT6000™ Bootloader nor the INT6300™ Bootloader can write to flash memory.
-
- On startup, the INT6000™ Bootloader attempts to load runtime firmware from flash memory into SDRAM. If flash memory is not available, or the runtime firmware stored there cannot be loaded, then the INT6000™ Bootloader cannot continue so the device cannot function.
-
- On startup, the INT6300™ Bootloader attempts to load runtime firmware from flash memory into SDRAM. If flash memory is not available, or the runtime firmware stored there cannot be loaded, then Bootloader will request runtime firmware from the local host processor.
-
- Softloader
-
- An optional program stored in flash memory in place of runtime firmware. This program is used on the INT6000™ to support the Boot From Host operation, if needed. It is not used on the INT6300™ because the INT6300™ Bootloader now performs similar functions. The Softloader cannot write to flash memory.
-
- On startup, the INT6000™ Bootloader loads the Softloader from flash memory into SDRAM, as it would do with runtime firmware. The Softloader then requests the actual runtime firmware from local host.
-
- Memory Configuration Parameters
-
- A small block of information that describes the type, size and characteristics of the SDRAM available for the benefit of the Bootloader. On the INT6000, SDRAM configuration must be stored in flash memory. On the INT6300, it may be stored in flash memory or on the local host. The INT6300™ Bootloader attempts to read configuration information from flash memory when it is present; otherwise, it requests that information from the local host using a VS_HST_ACTION message and so the host must store this information until it is requested.
-
- There are two SDRAM configuration file formats. The first format is used by the Windows Device Manager and the
- int6k2
- program and typically has a .config file extension. The second format is used by the
- int6k
- program and
- int6kf
- program and typically has a .cfg file extension. The latter format is more robust and should eventually replace the format.
-
- The Windows Device Manager form consists of 64 hexadecimal ASCII characters. Files are at least 64 bytes but only the first 64 bytes are used. Files can be modified using a text editor. ASCII hex to binary conversion and checksum computation is needed on input. The
- config2cfg
- program can be used to convert this format to Open Powerline Toolkit format.
-
- The Open Powerline Toolkit format consists of 32 binary bytes plus a 4 byte checksum. The file size is exactly 36 bytes. No conversion or checksum computation is needed on input. The
- chkcfg
- program can be used the validate this file format because it contains a checksum.
-
- The INT6400™ chipset does not need a memory configuration parameter file because it has a different memory controller than earlier chipsets. SDRAM is now configured dynamically by an applets stored in the .nvm file.
-
- Runtime Firmware (MAC Software)
-
- The executable image that determines INT6000™ or INT6300™ capability and functionality. Runtime firmware refers to any executable image except the Bootloader which is considered to be boot firmware. Firmware files have a .nvm extension and can contain multiple firmware images. One of these images could be the parameter information block but Atheros currently distributes that as a separate file. The chknvm program can be used to detect obsolete or corrupt .nvm files. Runtime firmware can write to flash memory and must be running in order to re-program the chipset.
-
- Parameter Information Block (PIB)
-
- The configuration image that determines device network identity, functional capability and operational mode. The PIB structure often changes from one major firmware release to the next and often is not portable across major releases. Parameter information files have a .pib extension by convention and contain one parameter set. The chkpib program can be used to detect obsolete or corrupt PIB files.
-
- Recent firmware releases support two PIB images in flash memory: the Factory PIB and the User PIB. The Factory PIB is the first PIB image written to flash memory. Once written, the Factory PIB cannot be changed without special software. The User PIB is created and over-written whenever the device needs to save new PIB parameters. Factory default values are restored by erasing the User PIB and rebooting the device. When a device reboots, it attempts to load the User PIB from flash memory. Failing that, it attempts to load the Factory PIB from flash memory. Failing that, it loads a Default PIB having minimum functionality. The loaded PIB becomes the Working PIB and determines runtime device identity and behavior.
-
- The following figure illustrates a hypothetical powerline network consisting of two devices. Each device has an INT6300™ with optional dedicated flash memory and an onboard processor with associated storage. The processor in each device is the local host for that device and the remote host for the other device. The processor storage is unspecified but it must be persistent. The two devices are connected via coax or powerline. The flash memory is optional in this design because it uses the INT6300™ chipset.
-
Figure 4.1.
- Simple Network
-
- The Boot Loader is permanent program that executes on startup. It detects the presence of flash memory and attempts to read SDRAM configuration from flash memory then load and runtime the firmware image and PIB from flash memory. On success, the Boot runtime firmware starts and the device assumes HomePlug AV compliant behavior. On failure, the Boot Loader requests SDRAM configuration, runtime firmware image and PIB from the local host. The local host must be prepared to respond to these requests.
-
- On a system having no flash memory, the Boot Loader will request SDRAM configuration information from the local host. Once that is received, the Boot Loader will request a firmware image and PIB from the local host. The local host determines which firmware image and PIB to download, manages the download sequence and starts firmware execution.
-
- Atheros software, such as the Windows Device Manager, Linux Flash Utility and Embedded API all support the Boot from Host configuration.
-
- Once the firmware is running on the INT6300™ , a remote host can forward runtime firmware and PIB to the local host via the INT6300™ firmware. The remote host might reside on anotherINT6300™ device, as shown in the previous figure, or be located anywhere on the HomePlug® AV network. In either case, the operations described are the same.
-
- The INT6300™ can boot HomePlug AV firmware from either dedicated flash memory or a local host processor. This means that dedicated flash memory in not necessary when an onboard processor having persistent storage is available. The absence of dedicated flash memory and availability of an onboard host processor is called a Boot from Host configuration.
-
- The Boot from Host configuration is of interest to customers who are committed to using a host processor in their INT6300™ based product and want to use it to eliminate the additional cost of dedicated flash memory to store HomePlug AV firmware for INT6300™ devices.
-
- The Boot from Host configuration supports three operations: Upgrade Device, Update Local Host and Boot from Host. Product designers must write host software to support all three operations as described later in this document. Atheros provides an Embedded Application Program Interface to assist product designers with this effort. Obtain a copy of the HomePlug AV Application Programming Interface User's Guide from Atheros Communications, Ocala FL USA for more information.
-
- Readers should not confuse a Boot from Host configuration with the Boot from Host operation. The former is a hardware configuration having an INT6300™ with no dedicated flash memory available. The latter is the process of downloading configuration information, firmware and PIB from the local host to the device and starting firmware execution on startup.
-
- This discussion assumes that the reader is familiar with the following:
-
- The distinction between a local and remote host
-
- The relationship between the powerline device H1, M1 and PHY interfaces.
-
- The structure of the following Atheros Management Message types: VS_HST_ACTION, VS_SET_SDRAM, VS_WR_MEM, VS_WR_MOD, VS_RS_DEV, VS_ST_MAC and VS_WRITE_AND_EXECUTE. Be aware that message types VS_SET_SDRAM, VS_WR_MEM, VS_WR_MOD and VS_ST_MAC are deprecated and will no longer be supported by the newest firmware.
-
- Hardware architecture covered in the QCA Powerline Hardware Technical Reference Manual and the management message formats covered in the QCA Powerline Firmware Technical Reference Manual.
-
- The Boot from Host configuration requires a permanent connection between the powerline device and a local host having some type of persistent storage. In most cases, the powerline device and local host are co-located, possibly on the same board or same chip, and act together as an integral unit. Essentially, the local host provides persistent memory for the device.
-
- The Boot from Host configuration lets the local host decide which runtime parameters and firmware to download on startup. This offers a considerable degree of product adaptability, allowing different parameter and firmware combinations to be downloaded based on external factors.
-
- In a Boot from Host configuration, the processor must act as local host while the device is booting but it can also act as remote host when upgrading other devices. The former is a design requirement and latter is a design option.
-
- The Boot from Host configuration offers design flexibility but also increases the possibilities. Remember that the processes described here are based on simple rules that ultimately dictate why each process step is needed. Readers may find it helpful to review these rules.
-
-
- The softloader and bootloader programs have limited vocabulary.
-
-
- The INT6000™ softloader recognizes only the VS_SW_VER, VS_ST_MAC, VS_RS_DEV, VS_WR_MOD requests. It does not recognize VS_WR_MEM.
-
- The INT6300™ bootloader recognizes only the VS_SW_VER, VS_WR_MEM, VS_ST_MAC, VS_RS_DEV and VS_SET_SDRAM requests. It does not recognize VS_WR_MOD.
-
- The INT6400™ bootloader recognizes only the VS_SW_VER, VS_WR_MEM, VS_ST_MAC, VS_RS_DEV requests. It recognizes VS_SET_SDRAM and responds to it but ignores it. It does not recognize VS_WR_MOD.
-
- The AR7400™ bootloader recognizes only VS_SW_VER, VS_WR_MEM, VS_ST_MAC, VS_RS_DEV requests. It recognizes VS_SET_SDRAM and responds to it but ignores it. It does not recognize VS_WR_MOD.
-
- The AR7420™ bootloader recognizes only VS_SW_VER, VS_RS_DEV, VS_WRITE_AND_EXECUTE and VS_RAND_MAC_ADDRESS requests. Early versions recognize VS_WRITE_MEM and VS_ST_MAC requests but they must not be used.
-
Table 4.1.
- Softloader/Bootloader MMEs
-
- MME
-
- NAME
-
- INT6000 Softloader
-
- INT6300 Bootloader
-
- INT6400 Bootloader
-
- AR7400 Bootloader
-
- AR7420 Bootloader
-
- 0xA000
-
- VS_SW_VER
-
- Yes
-
- Yes
-
- Yes
-
- Yes
-
- Yes
-
- 0xA008
-
- VS_WR_MEM
-
- No
-
- Yes
-
- Yes
-
- Yes
-
- Deprecated
-
- 0xA00C
-
- VS_ST_MAC
-
- Yes
-
- Yes
-
- Yes
-
- Yes
-
- Deprecated
-
- 0xA01C
-
- VS_RS_DEV
-
- Yes
-
- Yes
-
- Yes
-
- Yes
-
- Yes
-
- 0xA020
-
- VS_WR_MOD
-
- Yes
-
- No
-
- No
-
- No
-
- No
-
- 0xA05C
-
- VS_SDRAM
-
- No
-
- Yes
-
- Ignored
-
- Ignored
-
- No
-
- 0xA060
-
- VS_HOST_ACTION
-
- No
-
- Yes
-
- Yes
-
- Yes
-
- Yes
-
- 0xA098
-
- VS_WRITE_AND_EXECUTE
-
- No
-
- No
-
- No
-
- Yes
-
- Yes
-
- 0xA0D4
-
- VS_RAND_MAC_ADDRESS
-
- No
-
- No
-
- No
-
- Yes
-
- Yes
-
- The Softloader, Bootloader and runtime firmware may treat the same MME differently because each is a different program. A notorious obvious example is the VS_SW_VER message type. This means that one may need to be aware of the device state when anticipating device behaviour or interpreting device response.
-
- The local host is surrogate flash memory. When dedicated flash memory is not available to a device, the device will request firmware and parameter storage services from the local host using VS_HST_ACTION messages. The local host must be programmed to detect and respond to these messages or the firmware will appear to hang. See program int6khost, int64host, amphost or plchost to demonstrate and experiment with this interaction.
-
- Only runtime firmware can write flash memory. Runtime firmware must be executing in order to write flash memory or upload to the local host. The Softloader and Bootloader cannot perform either operation.
-
- All PIB changes must be written in flash memory. There are several things that can cause PIB changes. When a PIB change is needed, the Working PIB is copied to a scratch area and modified there. The Scratch PIB must then be written to flash memory or sent to the local host for storage. The device then resets causing the stored PIB to replace the Working PIB. If a freshly downloaded PIB changes for any reason then the cycle will repeat, automatically.
-
- Runtime firmware updates the PIB after joining and before leaving an AVLN. This will cause a device reset in each case. If the device is using the local host for persistent storage, runtime firmware will send the associated VS_HST_ACTION messages to the host and the host will send the associated VS_RD_MOD and VS_RS_DEV messages as per Update Local Host.
-
diff --git a/docbook/ch04s07.html b/docbook/ch04s07.html
deleted file mode 100644
index 2f3dd051..00000000
--- a/docbook/ch04s07.html
+++ /dev/null
@@ -1,15 +0,0 @@
-Every Little Bit Hurts
- With the addition of Push Button Encryption, and other planned features, runtime firmware can now modify the PIB. Consequently, host applications must not assume that the PIB has not changed since it was last downloaded. Atheros strongly recommends that applications always perform a read-modify-write when making PIB modifications. Failure to do so can result in infinite reset loops caused when a device modifies the PIB that has just been downloaded.
-
- As one example, recent PIBs contain a network membership bit to indicate that the device has successfully joined the network associated with the current NMK. If the firmware detects the network and discovers that the membership bit is clear then it will join the network and set the bit. The firmware will then attempt to preserve the change by sending a VS_HOST_ACTION message to the local host. If the host application does not upload and store the changed PIB (as the device requested) before resetting the device then the original PIB will be downloaded again, after reset, and the process will repeat. Of course, a similar situation will occur when the device leaves the network and again when it joins another network.
-
- It is important to use the right Boot from Host sequence for each type of Atheros device. This means that you should query the device using a VS_SW_VER message beforehand to determine or confirm the device type. Although this should be a simple operation, there have been several changes that complicate matters.
-
- The INT6300™ Bootloader incorrectly identifies the chipset as an INT6000™ chipset in the MDEVICEID field of the VS_SW_VER message.
-
- The AR7400™ Bootloader incorrectly identifies the chipset as an INT6400™ chipset in the MDEVICEID field of the VS_SW_VER message.
-
- The Bootloader, for INT6400™ chipsets and later, returns two additional field, IDENT and STEP_NUMBER in the VS_SW_VER confirmation message. These fields, the hardware identifier and step number, are correct but are not returned in earlier chipsets.
-
- The table below illustrates what is reported by various firmware, in the DEVICEID field of the VS_SW_VER message, on each type of hardware platform.
-
Table 4.2.
- Legacy Device Identification
-
- Chipset
-
- DEVICEID/IDENT (Bootloader)
-
- MVERSION (Bootloader)
-
- DEVICEID/IDENT (Firmware)
-
- MVERSION (Firmware)
-
- INT6000
-
- 0x01 / 0x00000042
-
- BootLoader
-
- 0x01 / na
-
- INT6000-MAC-0-0-3213-1206-20071224-FINAL
-
- INT6300
-
- 0x02 / 0x00006300
-
- BootLoader
-
- 0x02 / na
-
- INT6300-MAC-0-0-4203-00-4089-20091105-FINAL
-
- INT6400
-
- 0x03 / 0x00006400
-
- BootLoader
-
- 0x03 / na
-
- INT6400-MAC-4-3-4304-01-4397-20100924-FINAL
-
- INT7400
-
- 0x03 / 0x00007400
-
- BootLoader
-
- 0x04 / na
-
- INT7400-MAC-5-2-5213-01-1027-20110428-FINAL
-
- INT7450
-
- 0x03 / 0x0F001D1A
-
- BootLoader
-
- 0x20 / 0x00001D1A
-
- QCA7450-MAC-5-2-5213-01-1027-20110428-FINAL
-
- INT7451
-
- 0x03 / 0x00007400
-
- BootLoader
-
- 0x20 / 0x0E001D1A
-
- QCA7451-MAC-5-2-5213-01-1027-20110428-FINAL
-
- AR6405
-
- 0x03 / 0x00006400
-
- BootLoader
-
- 0x05 / na
-
- INT6405-MAC-4-3-4304-01-4397-20100924-FINAL
-
- AR7420
-
- 0x05 / 0x001CFCFC
-
- BootLoader
-
- 0x20 / 0x001CFCFC
-
- MAC-QCA7420-2.5.14.2259-23-20110621-FINAL
-
- QCA6410
-
- 0x05 / 0x001B58EC
-
- BootLoader
-
- 0x21 / 0x001B58EC
-
- MAC-QCA6410-2.5.14.2259-23-20110621-FINAL
-
- QCA6411
-
- 0x05 / 0x001B58BC
-
- BootLoader
-
- 0x21 / 0x001B58BC
-
- MAC-QCA6411-2.5.14.2259-23-20110621-FINAL
-
- QCA7000
-
- 0x05 / 0x001B589C
-
- BootLoader
-
- 0x22 / 0x001B589C
-
- MAC-QCA7000-1.4.13.3259-43-20110621-FINAL
-
- To properly detect the correct chipset perform the following steps.
-
- Send a VS_SW_VER request message from the local host to the local device using the Atheros Local Management Address.
-
- Read the VS_SW_VER confirm message returned to the host by the device.
-
- Extract and save the MDEVICEID field (a small integer) and the MVERSION field (a string).
-
- If the MVERSION string is “SoftLoader” then the MDEVICEID field is valid.
-
- If the MVERSION string is not “BootLoader” then the MDEVICEID field is valid unless it is 0x07. In that case, set the stored DEVICEID to 0x04 to indicate an AR7400™. Do not inspect the IDENT field because it does not exist in the firmware version of the VS_SW_VER message on any platform.
-
- If the MDEVICEID field is 1, indicating an INT6000™, then the chipset is actually an INT6300™. Set the stored MDEVICEID to 2, indicating an INT6300™. Do not inspect the IDENT field because it does not exist in the BootLoader version of the VS_SW_VER message for either of these two chipsets.
-
- If the MDEVICEID field is 3, indicating an INT6400™, then the chipset could be either an INT6300™ or an AR7400™. Inspect the IDENT field.
-
- If the IDENT field is 0x6400, indicating an INT6400™, then the stored MDEVICEID is valid.
-
- If the IDENT field is 0x7400, indicating an AR7400™, then set the stored MDEVICEID to 4, indicating an AR7400™.
-
- Having performed the previous conversions, the expression (1 << (DEVICEID - 1)) now indicates the proper IGNORE bit found in each NVM file header. Unfortunately, this only works for DeviceID values from 0x01 through 0x06. After that, the device identification scheme changes.
-
- Starting with the AR7420™, the DeviceID field in VS_SW_VER is now the DEVICE_CLASS field and identifies the “Device Family”, not the device type. Instead, the IDENT field in VS_SW_VER identifies the device type and the IDENT field is located at a variable offset within the message frame. Previously, the IDENT was located a fixed offset within the frame.
-
- The Upgrade Device operation downloads firmware and/or PIB from a remote host to an Atheros device for permanent storage and immediate execution. The device determines where and how it will store the information based on the availability of onboard flash memory. If the device has dedicated flash memory then it will store the firmware and PIB there and reset itself; otherwise, it will hand the firmware and PIB to the local host for storage and the local host will reset the device. The reset ensures that new firmware and PIB take immediate effect once they are saved. This operation requires custom software on the remote host and Atheros firmware on the device.
-
- Optionally, the remote host writes firmware to the device by sending a series of VS_WR_MOD.REQ messages and waiting for a VS_WR_MOD.CNF message after each one. The message MODULEID field is set to 0x01 for this operation.
-
- Optionally, the remote host writes the PIB to the device by sending VS_WR_MOD.REQ messages and waiting for a VS_WR_MOD.CNF message after each one. The MODULEID is set to 0x02 for this operation.
-
- The remote host commits the firmware and/or PIB to persistent storage by sending a VS_MOD_NVM.REQ message and waiting for a VS_MOD_NVM.CNF message.
-
- The device received the VS_MOD_NVM.REQ and sends a VS_MOD_NVM.CNF message to the remote host.
-
- The remote host receives the VS_MOD_NVM.CNF and proceeds with other activity. The remote host does not know or care that the device may not have dedicated flash memory available.
-
- The device determines where and how to store the information. If dedicated flash memory is available, the device writes the downloaded firmware and PIB to flash memory and performs a software reset that results in a normal Boot from Flash operation. If no dedicated flash memory is available, the device initiates an Update Local Host operation.
-
- The device does not notify the remote host when the upgrade operation completes. It is therefore incumbent on the remote host to determine ultimate success or failure by polling the device, possiby using a VS_SW_VER.REQ message, until a response is received. The complete upgrade operation can take from 20 seconds to 45 seconds depending on device configuration.
-
- The Update Local Host operation transfers a firmware image and/or PIB image from the device to the local host for permanent storage. After the firmware and PIB are stored, the local host will reset the device and the device will retrieve parameters and firmware using the Boot from Host operation described in the next section.
-
- The firmware may initiate this operation after a remote host has downloaded new firmware or PIB and issued a VS_MOD_NVM.REQ to the device, the device has been asked to restore factory default settings or the firmware has dynamically altered the runtime PIB in some way. Consequently, the device will be reset by the host in each case.
-
- The device initiates this operation to complete an Upgrade Device operation when the device has no dedicated flash memory onboard. This operation requires running Atheros firmware on the device and custom software on the local host.
-
Figure 4.3.
- Update Local Host (INT6000/INT6300/INT6400)
-
- The runtime firmware initiates this operation by broadcasting VS_HOST_ACTION.IND messages every 500 milliseconds. The HOST_ACTION_REQ field of the message can be either 0x01, 0x02 or 0x03 to indicate that a firmware image, a parameter block image or both are ready for upload by the local host.
-
- The local host sends a VS_HOST_ACTION.RSP message to the device to indicate the ability and willingness to upload the information. The MSTATUS field is set to 0x00 for affirmative and 0x01 for negative.
-
- Assuming an affirmative response, the device stops broadcasting and will wait indefinitely for local host action.
-
- Optionally, the local host reads the firmware image from the device by sending a series of VS_RD_MOD.REQ messages to the device and waiting for a VS_RD_MOD.CNF message after each one. The message MODULEID field is set to 0x01 for this operation.
-
- Optionally, the local host reads the PIB from the device by sending a series of VS_RD_MOD.REQ messages to the device and waiting for a VS_RD_MOD.CNF message after each one. The message MODULEID field is set to 0x02 for this operation.
-
- The local host sends a VS_RS_DEV.REQ message to the device to initiate a firmware reboot.
-
- The device sends a VS_RS_DEV.CNF to the host and performs a software reset. This forces a Boot from Host.
-
- The Boot from Host operation downloads a firmware image and PIB image from the local host and starts firmware execution. The process is initiated by the INT6000™ Bootloader following a device reset. The Bootloader passes control to the INT6000™ Softloader to negotiate with the local host. The process therefore requires Softloader aware software running on the local host in order to complete.
-
- The device does not have a unique hardware address until the firmware starts and assigns one. Until that time, the Softloader accepts messages addressed to 00:B0:52:00:00:01. In addition, the Softloader does not know the hardware address of the local host and so it addresses VS_HST_ACTION messages to FF:FF:FF:FF:FF:FF; however, these messages are not forwarded over powerline.
-
- The INT6000™ Bootloader automatically starts after device reset. It reads the Softloader from NVRAM, writes it into SDRAM and starts execution. The Softloader then manages the Boot from Host process.
-
- The Softloader broadcasts a VS_HST_ACTION.IND message every 500 milliseconds to request the download of runtime firmware and PIB. The HOST_ACTION_REQ field of the message is 0x00 in this case. The message source address if 00:B0:52:00:00:01 as explained above.
-
- The local host receives the VS_HST_ACTION.IND message and inspects the HOST_ACTION_REQ field to determine action requested. It may then elect to service the request or ignore it. On a single-host system, the host must service the request or the device will not start. On a multi-host system, one of the hosts must elect to service the request or the device will not start.
-
- The local host sends a VS_HST_ACTION.RSP message to the device to indicate the ability and willingness to service the request. The MSTATUS field is set to 0x00 for affirmative and 0x01 for negative.
-
- The Softloader receives the VS_HST_ACTION.RSP from the host and inspects the MSTATUS field. On affirmative status, the Softloader stops sending VS_HST_ACTION messages and waits indefinitely for the firmware image and PIB.
-
- The local host determines which firmware image and PIB to download. In some cases there may be no choice. In other cases, there may be a choice between default and custom software or between current and upgraded software. This is a principle design issue to consider.
-
- The local host downloads a firmware image to the device by sending VS_WR_MOD.REQ messages to the device and waiting for a VS_WR_MEM.CNF messages from the device after each request. Each message contains an image segment, the memory offset, the segment length and the checksum used to monitor and manage download progress. If a single transaction fails, the local host should detect it and repeat it.
-
- The local host downloads a PIB to the device by sending VS_WR_MOD.REQ messages to the device and waiting for a VS_WR_MEM.CNF message from the device after each request. Each message contains an image segement, the memory offset, the segment length and the checksum used to monitor and manage download progress. If a single transaction fails, the local host should detect it and repeat it.
-
- The local host starts execution of the downloaded firmware by sending a VS_ST_MAC.REQ message to the device. The message contains the start address for the firmware.
-
- The Softloader receives the VS_ST_MAC.REQ from the local host, validates the content.
-
The Softloader sends a VS_ST_MAC.CNF message to the local host to indicate an ability or willingness to start execution. Assuming an ability and willingness, the Softloader immediately starts firmware execution which relinquishes device control to the firmware.
-
- The local host receives the VS_ST_MAC.CNF message from the device, inspects the MSTATUS field and acts accordingly. Assuming an affirmative status, this process terminates.
-
- The boot-from-host operation downloads SDRAM configuration information, runtime parameters and runtime firmware from a local host and starts firmware execution. This method is initiated by the device bootloader after reset reset if the device has no flash memory, blank flash memory or corrupted flash memory. The method requires the bootloader aware software running on the local host to detect and service VS_HOST_ACTION messages from the device.
-
- The INT6300™ boot-from-host method is similar to the INT6000™ method but it has an extra stage to download SDRAM configuration parameters and it uses VS_WR_MEM messages to download runtime parameters and firmware instead of VS_WR_MOD messages. The VS_WR_MEM messages write directly to SDRAM and an VS_ST_MAC message is needed to start firmware execution. Once the firmware is running, another method is used to write runtime parameters and firmware to flash memory.
-
- The INT6300™ does not have a unique hardware address until runtime firmware starts and assigns one from the runtime parameter block. Until that time, the bootloader will accept messages addressed to 00:B0:52:00:00:01. In addition, the bootloader does not know the hardware address of the local host and so it addresses VS_HOST_ACTION messages to FF:FF:FF:FF:FF:FF; however, these messages are not transmitted over the powerline.
-
- The bootloader automatically starts after device reset and attempts to read the runtime firmware image from flash memory, write it into SDRAM and start execution. If it succeeds then normal operation begins and no further action is required. If it fails, for any reason, then the bootloader starts the boot-from-host process.
-
- The bootloader broadcasts VS_HOST_ACTION.IND with HOST_ACTION_REQ set to 0x04 to indicate that configuration is required. The destination address is FF:FF:FF:FF:FF:FF and the source address is 00:B0:52:00:00:01 as explained above. This message is sent every 10 seconds which differs from that of other chips.
-
- The host receives the VS_HOST_ACTION.IND message and inspects the HOST_ACTION_REQ field to determine the action requested. On a single-host system, the local host must elect to service the request or the device will not start. On a multi-host system, one of the hosts must elect to service the request of the device will not start.
-
- The host sends a VS_HOST_ACTION.RSP message to the device to indicate an ability and willingness to service the request. The MSTATUS field is set to 0x00 for affirmative and 0x01 for negative.
-
- The bootloader receives the VS_HOST_ACTION.RSP from the host and inspects the MSTATUS field. On affirmative response, the bootloader stops broadcasting VS_HOST_ACTION.IND and waits indefinitely for SDRAM configuration information from the host.
-
- The host sends a VS_SET_SDRAM.REQ message to the device containing an SDRAM configuration block and the block checksum.
-
- The bootloader receives the VS_SET_SDRAM.REQ, validates the content, initializes SDRAM parameters and sends a VS_SET_SDRAM.CNF message to the servicing host to indicate either success or failure.
-
- The local host receives the VS_SET_SDRAM.CNF and inspects the MSTATUS field for success or failure. Assuming success, the local host waits indefinitely for further requests from the device.
-
- The local host determines which parameter block and firmware image to download. In some cases there may be no choice. In other cases, there may be a choice between default and custom software or between current and upgraded software. This is a principle design issue to consider.
-
- The local host downloads the firmware image to the device by sending VS_WR_MEM.REQ messages to the device and waiting for a VS_WR_MEM.CNF messages from the device after each request. Each message contains an image segment, the memory offset, the segment length and the checksum used to monitor and manage download progress. It a single transaction fails, the local host should detect it and repeat it.
-
- The local host downloads a parameter block to the device by sending VS_WR_MEM.REQ messages to the device and waiting for a VS_WR_MEM.CNF message from the device after each request. Each message contains an image segment, the memory offset, the segment length and the checksum used to monitor and manage download progress. If a single transaction fails, the local host should detect it and repeat it.
-
- The local host starts firmware execution by sending a VS_ST_MAC.REQ message to the device. The message contains the firmware start address.
-
- The bootloader receives the VS_ST_MAC.REQ from the local host, validates the content.
-
The device sends a VS_ST_MAC.CNF message to indicate an ability or willingness to start firmware execution. The device immediately starts firmware execution which relinquishes device control to the firmware. It can take 5 to 10 seconds for the firmware to start.
-
- The host receives the VS_ST_MAC.CNF message from the device, inspects the MSTATUS field and acts accordingly. An afffirmative indication means that the firmware will start executing on the device in 5 to 10 seconds. Once the firmware starts, future messages will contain the unique hardware address for the device.
-
- The INT6400™ boot-from-host operation downloads and executes a memory configuration applet then downloads runtime parameters and firmware from a local host and starts firmware execution. This method is initiated by the INT6400™ bootloader after reset on a device having no flash memory, blank flash memory or corrupted flash memory. The method requires bootloader aware software running on the local host in order to complete.
-
- The INT6400™ boot-from-host method is similar to the INT6300™ boot-from-host method but it downloads and executes an SDRAM configuration applet instead of downloading SDRAM parameters. The applet is downloaded and executed using the same mechanism as runtime firmware. The applet executes and returns to the bootloader when done. The bootloader then continues to drive the boot process using VS_HOST_ACTION messages.
-
- The INT6400™ boot-from-host method will work for AR7400™ and QCA7420™ chipsets but will not work on successive chipsets. Customers should adopt or implement the AR7400™ boot-from-host method, instead of this one, to avoid building obsolete products.
-
- The INT6400™ does not have a unique hardware address until the firmware starts and assigns one from the parameter information block. Until that time, the bootloader will only acknowledge messages addressed to 00:B0:52:00:00:01. In addition, the bootloader does not know the hardware address of the local host and so it addresses VS_HOST_ACTION messages to FF:FF:FF:FF:FF:FF; however, these messages are not transmitted over the powerline.
-
- The bootloader automatically starts after device reset and attempts to read the runtime firmware image from flash memory, write it into SDRAM and start execution. If it succeeds then normal operation begins and no futher action is required. If it fails, for any reason, then the bootloader initiates the boot-from-host sequence.
-
- The bootloader broadcasts VS_HOST_ACTION.IND with HOST_ACTION_REQ set to 0x04 to request configuration. The destination address is FF:FF:FF:FF:FF:FF and source address is 00:B0:52:00:00:01 as explained above. This message is sent every 500 milliseconds which differs from that of other chips.
-
- The local host receives the VS_HOST_ACTION.IND message and inspects the HOST_ACTION_REQ field to determine the appropriate action. On a single-host system, the lone host must service the request or the device will not start. On a multi-host system, one host must elect to service the request of the device will not start.
-
- The local host sends VS_HOST_ACTION.RSP to silence the bootloader or indicate the ability and willingness to service the request. The destination address must be 00:B0:52:00:00:01 and the source address is that of the host interface. The MSTATUS field is set to 0x00 for affirmative and 0x01 for negative.
-
- The bootloader receives the VS_HOST_ACTION.RSP from the host and inspects the MSTATUS field. On affirmative response, the bootloader stops broadcasting VS_HOST_ACTION.IND messages and waits indefinitely for the local host to download a configuation applet and start execution.
-
- The host downloads the memory control applet to the device by sending VS_WR_MEM.REQ messages to the device and waiting for a VS_WR_MEM.CNF message from the device after each one. Each message contains an image segment and the segment memory offset, length and checksum. These values are used to monitor and manage download progress. If a transaction fails, the host can detect it and should repeat it.
-
- The host starts execution of the memory control applet by sending a VS_ST_MAC.REQ message to the device. The message contains the applet load address, length, checksum and start address. These values are often obtained from an NVM file image header.
-
-
- The bootloader receives the VS_ST_MAC.REQ from the host and validates the contents.
-
- The bootloader sends a VS_ST_MAC.CNF message to the host indicating the ability and willingness to start applet execution. The MSTATUS field is set to 0x00 for affirmative and 0x01 for negative.
-
- The host receives the VS_ST_MAC.CNF message from the device and evaluates the MSTATUS field. On affirmative, the host waits for further requests from the device. On negative, the host may attempt another start or another download followed by a start or attempt to alert a human.
-
- The bootloader starts applet execution. The applet configures memory, runs to completion and returns to the Bootloader.
-
- The bootloader broadcasts a VS_HOST_ACTION.IND message every 500 milliseconds to request runtime firmware and parameter download. The message destination address is FF:FF:FF:FF:FF:FF and source address is 00:B0:52:00:00:01 as explained above. The HOST_ACTION_REQ field is set to 0x00.
-
- The host receives the VS_HOST_ACTION.IND message and inspects the HOST_ACTION_REQ field to determine the requested action. On a single-host system, the lone host must service the request or the device will not start. On a multi-host system, one host must elect to service the request of the device will not start.
-
- The host sends a VS_HOST_ACTION.RSP message to the device to indicate the ability and willingness to service the request. The MSTATUS field is set to 0x00 for affirmative and 0x01 for negative.
-
- The bootloader receives the VS_HOST_ACTION.RSP from the host and inspects the MSTATUS field. On affirmative response, the bootloader stops broadcasting VS_HOST_ACTION.IND messages and waits indefinitely for the host to download the runtime firmware and parameters and start execution.
-
- The host determines which firmware and parameter image to download. In some cases there may be no choice. In other cases, there may be a choice between default and custom images or between current and upgraded images. This is a principle design issue to consider.
-
- The host downloads the firmware image to the device by sending VS_WR_MEM.REQ messages to the device and waiting for a VS_WR_MEM.CNF message from the device after each one. Each message contains an image segment and the segment memory offset, length and checksum. These values are used to monitor and manage download progress. If a transaction fails, the local host can detect it and should repeat it.
-
- The host downloads the parameter block to the device by sending VS_WR_MEM.REQ messages to the device and waiting for a VS_WR_MEM.CNF message from the device after each one. Each message contains an image segment and the segment memory offset, length and checksum. These values are used to monitor and manage download progress. If a transaction fails, the local host can detect it and should repeat it.
-
- The host starts runtime firmware execution by sending a VS_ST_MAC.REQ message to the device. The message contains the firmware load address, length, checksum and start address. These values are often obtained from an NVM file image header.
-
- The bootloader receives the VS_ST_MAC.REQ from the host and validates the content.
-
- The bootloader sends a VS_ST_MAC.CNF message to indicate the ability or willingness to start firmware execution.
-
- The host receives the VS_ST_MAC.CNF message from the device, inspects the MSTATUS field and acts accordingly.
-
- The bootloader starts runtime firmware execution. The firmware reads and validates the parameter block then assumes full control of the device. It can take several seconds for firmware start to be evident. Once the firmware starts, any future VS_HOST_ACTION messages will contain the unique hardware address for the device.
-
- The AR7400™ boot-from-host method downloads and executes a device configuration applet then downloads runtime parameters and firmware from a local host and starts firmware execution. This method is initiated by the Bootloader after reset on a device having no flash memory, blank flash memory or corrupted flash memory. The method requires Bootloader aware software running on the local host in order to complete.
-
- The AR7400™ boot-from-host method is similar to the INT6400™ boot-from-host method but it uses the VS_WRITE_AND_EXECUTE message instead of the VS_WR_MEM message write into SDRAM and start firmware execution. This eliminates the need for the VS_ST_MAC message. The VS_WR_MEM and VS_ST_MAC message types will no longer be recognized by bootloaders after the QCA7420™ chipset.
-
- The AR7400™ boot-from-host method works on AR6400™ and will continue to work on QCA7420™ and planned successors. Customers should implement this boot-from-host method now to avoid building obsolete products.
-
- The AR7400™ does not have a unique hardware address until the firmware starts and assigns one read from the PIB. Until that time, the Bootloader will only acknowledge messages addressed to 00:B0:52:00:00:01. In addition, the Bootloader does not know the hardware address of the local host and so it addresses all VS_HOST_ACTION messages to FF:FF:FF:FF:FF:FF; however, these messages are not transmitted over the powerline.
-
- The bootloader automatically starts after device reset and attempts to read the runtime firmware image from flash memory, write it into SDRAM and start execution. If it succeeds then normal operation begins and no further action is required. If it fails, for any reason, then the bootloader initiates the boot-from-host sequence.
-
- The bootloader broadcasts VS_HOST_ACTION.IND with HOST_ACTION_REQ set to 0x04 to indicate that it is waiting to be configured. The bootloader continues to broadcast this message message every 750 milliseconds which differs from that of other chips.
-
- The local host receives the VS_HOST_ACTION.IND and inspects HOST_ACTION_REQ field to determine the required action. The local host must be programmed to listen and act appropriately.
-
- The local host sends a VS_HOST_ACTION.RSP message with MSTATUS set to 0 to indicate the start of sequence.
-
- The bootloader receives the VS_HOST_ACTION.RSP message, stops broadcasting VS_HOST_ACTION.IND messages and waits indefinitely for the local host to act.
-
- The local host retrieves the firmware chain and extracts the configuration applet image from the chain. The firmware chain may be stored on disk or in memory depending on how the local host is programmed.
-
- The local host sends a VS_WRITE_AND_EXECUTE.REQ message with FLAGS set to 2 and ALLOWED_MEM_TYPES to 1 to download the applet in absolute address mode. Alternately, setting FLAGS to 0 and CURR_PART_OFFSET to 0 will download the applet in relative address mode. The TOTAL_LENGTH will be the applet image header IMAGELENGTH but CURR_PART_LENGTH cannot exceed 1400 bytes.
-
- The bootloader acknowledges each VS_WRITE_AND_EXECUTE.REQ message with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
- The local host continues to increment CURR_PART_OFFSET and download the configuration applet in 1400 byte blocks until the last block is reached. The local host then sets START_ADDR to the applet image header ENTRYPOINT, the CHECKSUM to the applet image header IMAGECHECKSUM and the execute bit in FLAGS to 1 in the last message frame.
-
- The bootloader receives the last VS_WRITE_AND_EXECUTE.REQ message, confirms the configuration applet checksum then acknowledges with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
- The local host exists the boot from host sequence and returns to listening mode.
-
- The bootloader executes the configuration applet. The device hardware address is 00:B0:52:00:00:01 in this state.
-
- The bootloader broadcasts a VS_HOST_ACTION.IND message with HOST_ACTION_REQ set to 0 to indicate that it is waiting for runtime parameters and firmware.
-
- The local host receives a VS_HOST_ACTION.IND message and inspects the HOST_ACTION_REQ field to determine the required action. The local host must be programmed to listen and act appropriately.
-
- The bootloader receives the VS_HOST_ACTION.RSP message, stops broadcasting VS_HOST_ACTION.IND messages and waits indefinitely for the local host to act.
-
- The local host locates the parameter chain and firmware chain. The chains may be stored on disk or in memory depending on how the local host is programmed.
-
- The local host sends a VS_WRITE_AND_EXECUTE.REQ message with FLAGS set to 2 and ALLOWED_MEM_TYPES set to 1 to download parameters in absolute address mode. Alternately, setting FLAGS to 0 and CURR_PART_OFFSET to 0 will download parameters in relative address mode. The TOTAL_LENGTH will be the entire parameter file length but the CURR_PART_LENGTH cannot exceed 1400 bytes.
-
- The bootloader acknowledges each VS_WRITE_AND_EXECUTE.REQ message with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
- The local host continues to CURR_PART_OFFSET and download the parameter chain in 1400 byte blocks until the last block is reached. The local host then sets the START_ADDR field to the parameter image header ENTRYPOINT, the CHECKSUM to the parameter image header IMAGECHECKSUM and the execute bit in FLAGS to 1 in the last message frame.
-
- The bootloader receives the last VS_WRITE_AND_EXECUTE.REQ message, confirms the parameter chain checksum and acknowledges with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
- The local host sends a VS_WRITE_AND_EXECUTE.REQ message with FLAGS set to 2 and ALLOWED_MEM_TYPES to 1 to download firmware in absolute address mode. Alternately, setting FLAGS to 0 and CURR_PART_OFFSET to 0 will download firmware in relative address mode. The TOTAL_LENGTH will be the firmware image header IMAGELENGTH but the CURR_PART_LENGTH cannot exceed 1400 bytes.
-
- The bootloader acknowledges each VS_WRITE_AND_EXECUTE.REQ message with a VS_WRITE_AND_EXECUTE.CNF message having the MSTATUS field set to 0.
-
- The local host continues to increment CURR_PART_OFFSET and download the parameter chain in 1400 byte blocks until the last block is reached. The local host then sets START_ADDR to the parameter image header ENTRYPOINT, the CHECKSUM to the parameter image header IMAGECHECKSUM and the execute bit in FLAGS to 1 in the last message frame.
-
- The bootloader receives the last VS_WRITE_AND_EXECUTE.REQ message, confirms the firmware chain checksum and acknowledges with a VS_WRITE_AND_EXECUTE.CNF message having the MSTATUS field set to 0.
-
- The bootloader executes the runtime firmware and the device begins operation. The device hardware address will become that programmed into the parameter inforamtion block.
-
- The VS_WRITE_AND_EXECUTE message is now the only way to write runtime parameters and firmware into volatile memory. The legacy VS_RD_MEM, VS_WR_MEM and VS_ST_MAC are deprecated and will no longer be supported by the bootloader. This means that some customers must re-write their applications to boot newer powerline devices.
-
- The bootloader enters boot-from-host mode based on the hardware strapping or failure to load runtime firmware from flash memory. The device hardware address is 00:B0:52:00:00:01 in this state.
-
- The bootloader broadcasts a VS_HOST_ACTION.IND message with HOST_ACTION_REQ set to 4 to indicate that it is waiting to be configured. The bootloader will continue to broadcast the VS_HOST_ACTION.IND message every 750ms until it receives a VS_HOST_ACTION.RSP message from the local host. The BootROM does not know the local host hardware address at this stage so indications are broadcast, not addressed.
-
- The local host receives a VS_HOST_ACTION.IND message and inspects HOST_ACTION_REQ field to determine the required action. The local host must be programmed to listen and act appropriately. The first indcation requests device configuration.
-
- The local host sends a VS_HOST_ACTION.RSP message with MSTATUS set to 0 to indicate a willingness and ability to service the request.
-
- The bootloader receives the VS_HOST_ACTION.RSP message, stops broadcasting VS_HOST_ACTION.IND messages and waits indefinitely for the local host to act.
-
- The local host retrieves the firmware chain and extracts the configuration applet image from the chain. The firmware chain may be stored on disk or in memory depending on how the local host is programmed.
-
- The local host sends a VS_WRITE_AND_EXECUTE.REQ message with FLAGS set to 2, ALLOWED_MEM_TYPES to 1, CURR_PART_OFFSET to the applet image header IMAGEADDRESS and CURR_PART_LENGTH to the applet image header IMAGELENGTH to download the applet in absolute address mode. Alternately, setting FLAGS to 0 and CURR_PART_OFFSET to 0 will download the applet in relative address mode.
-
- The bootloader acknowledges each VS_WRITE_AND_EXECUTE.REQ message with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
- The local host continues to download the configuration applet in 1400 byte blocks until the last block is reached. The local host sets START_ADDR to the applet image header ENTRYPOINT, CHECKSUM to the applet image header IMAGECHECKSUM and the execute bit in FLAGS to 1.
-
- The bootloader receives the last VS_WRITE_AND_EXECUTE.REQ message, confirms the configuration applet checksum then acknowledges with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
- The local host exists the boot from host sequence and returns to listening mode.
-
- The bootloader executes the configuration applet. The device hardware address is 00:B0:52:00:00:01 in this state.
-
- The bootloader broadcasts a VS_HOST_ACTION.IND message with HOST_ACTION_REQ set to 0 to indicate that it is waiting for runtime parameters and firmware.
-
- The local host receives a VS_HOST_ACTION.IND message and inspects the HOST_ACTION_REQ field to determine the required action. The local host must be programmed to listen and act appropriately.
-
- The bootloader receives the VS_HOST_ACTION.RSP message, stops broadcasting VS_HOST_ACTION.IND messages and waits indefinitely for the local host to act.
-
- The local host locates the parameter chain and firmware chain. The chains may be stored on disk or in memory depending on how the local host is programmed.
-
- The local host sends a VS_WRITE_AND_EXECUTE.REQ message with FLAGS set to 2, ALLOWED_MEM_TYPES set to 1, CURR_PART_OFFSET to the parameter image header IMAGEADDRESS and CURR_PART_LENGTH to the entire parameter image chain length to download parameters in absolute address mode. Alternately, setting FLAGS to 0 and CURR_PART_OFFSET to 0 will download parameters in relative address mode.
-
- The bootloader acknowledges each VS_WRITE_AND_EXECUTE.REQ message with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
- The local host continues to download the parameter chain in 1400 byte blocks until the last block is reached. The local host then sets the START_ADDR field to the parameter image header ENTRYPOINT, CHECKSUM to the parameter image header IMAGECHECKSUM and the execute bit in FLAGS to 1.
-
- The bootloader receives the last VS_WRITE_AND_EXECUTE.REQ message, confirms the parameter chain checksum and acknowledges with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
- The local host sends a VS_WRITE_AND_EXECUTE.REQ message with FLAGS set to 2, ALLOWED_MEM_TYPES to 1, CURR_PART_OFFSET to the firmware image header IMAGEADDRESS and CURR_PART_LENGTH to the firmware image header IMAGELENGTH to download firmware in absolute address mode. Alternately, setting FLAGS to 0 and CURR_PART_OFFSET to 0 will download firmware in relative address mode.
-
- The bootloader acknowledges each VS_WRITE_AND_EXECUTE.REQ message with a VS_WRITE_AND_EXECUTE.CNF message having the MSTATUS field set to 0.
-
- The local host continues to download the parameter chain in 1400 byte blocks until the last block is reached. The local host then sets START_ADDR to the parameter image header ENTRYPOINT, CHECKSUM to the parameter image header IMAGECHECKSUM and the execute bit in FLAGS to 1.
-
- The bootloader receives the last VS_WRITE_AND_EXECUTE.REQ message, confirms the firmware chain checksum and acknowledges with a VS_WRITE_AND_EXECUTE.CNF message having the MSTATUS field set to 0.
-
- The bootloader executes the runtime firmware and the device begins operation. The device hardware address will become that programmed into the parameter inforamtion block.
-
- At this point, runtime firmware is executing in volatile memory with runtime parameters. If the power is reset at this point then all would be lost. If the device has dedicated flash memory attached then we may want to write runtime parameters and firmware to flash memory so that the device can boot from flash in case of a power failure or reset.
-
- The VS_MODULE_OPERATION message is now the only way of write flash memory. The legacy message types VS_RD_MOD, VS_WR_MOD, VS_MOD_NVM and VS_PTS_NVM are deprecated and will no longer be supported by runtime firmware. This means that some customers must re-write their applications to flash newer powerline devices.
-
Tip
- The VS_MODULE_OPERATION message type has many formats and the structure differs with each format. Readers should consult the QCA Firmware Technical Reference Manual for a complete description.
-
- A blank flash memory must first be programmed with a softloader module. The module consists of a manifest, the executable softloader program image and a flash memory map. The map is used to manage flash memory during initializations and upgrades. The softloader module must be written into flash memory as a separate module before parameter and firmware modules are written. After that, parameter and firmware modules may be written and re-written without re-writing the softloader module. Of course, the softloader module must be re-written if flash memory is erased.
-
- The local host sends a VS_MODULE_OPERATION.REQ module write session request to register a session identifier and the module identifier, module length and module checksum of the softloader module. The softloader module identifier is 0x7003. The softloader module is the entire softloader chain including manifest, softloader image and flash memory layout.
-
- The device receives the request, validates the module identifier and preserves the module length and checksum until the module write session is closed. The local host has 30 minutes to complete registered module write operations and close the module write session.
-
- The device responds with VS_MODULE_OPERATION.CNF with MSTATUS set to 0, if things went well.
-
- The local host receives the confirmation and prepares to download the softloader module.
-
- The local host sends a VS_MODULE_OPERATION.REQ module write request containing the offset, length and content of the first portion of the module being downloaded.
-
- The device receives the request and write to a scrath region of flash memory awaiting session close.
-
- The device responds with VS_MODULE_OPERATION.CNF with MSTATUS set to 0 if things went well.
-
- The local host receives the confirmation and continues downloading the softloader in fragments using VS_MODULE_OPERATION write requests, advancing the offset and adjusting the length with each write.
-
- The local host send a VS_MODULE_OPERATION.REQ close module write session request having COMMIT_CODE bits 0 and 1 set. to indicate “Force Commit” and “Commit without reset”, respectively.
-
- The device recevies the request, verifies the module length and checksum then transfers the module from scratch memory to it's final location in flash memory.
-
- The device responds with VS_MODULE_OPERATION.CNF close module write session with MSTATUS set to 0 if things went well. If things did not go well then the local host must request a new write module session and start over.
-
- Once the softloader module is written, the parameter and firmware modules may be written in much the same way except that they must be written as a pair. The parameter module must be downloaded first. The firmware module cannot be committed to without a compatible parameter module.
-
- When parameters and firmware are written together the User PIB, Factory PIB and firmware are modified modified. The new User PIB is created by copying the old User PIB over the new one. Consequently the only change comes from extra fields found at the end of the new User PIB. The new Factory PIB becomes the new User PIB with certain fields from the old User PIB preserved, such as the MAC, DAK and so on.
-
Figure 4.10.
- Flash Parameters and Firmware (AR7420)
-
- The local host sends a VS_MODULE_OPERATION.REQ module write session request to register the session identifier, module identifiers, module lengths and module checksums. In this case, the two modules are the runtime parameters and runtime firmware. The module identifiers are 0x7002 and 0x7003, respectively. The application running on the local must must locate these modules and determine their size and checksum.
-
- The device receives the request, validates the module identifier and preserves the module lengths and checksums until the module write session is closed. The local host has 30 minutes to complete registered module write operations and close the module write session.
-
- The device responds with VS_MODULE_OPERATION.CNF with MSTATUS set to 0, if things went well.
-
- The local host receives the confirmation and prepares to download the parameter module.
-
- The local host sends a VS_MODULE_OPERATION.REQ module write request containing the offset, length and content of the first portion of the module being downloaded.
-
- The device receives the request and write to a scratch region of flash memory awaiting write session close.
-
- The device responds with VS_MODULE_OPERATION.CNF with MSTATUS set to 0 if things went well.
-
- The local host receives the confirmation and continues downloading the parameter module in fragments using VS_MODULE_OPERATION write requests, advancing the offset and adjusting the length with each write.
-
- The local host receives the confirmation and prepares to download the firmware module.
-
- The local host sends a VS_MODULE_OPERATION.REQ module write request containing the offset, length and content of the first portion of the module being downloaded.
-
- The device receives the request and write to a scratch region of flash memory awaiting write session close.
-
- The device responds with VS_MODULE_OPERATION.CNF with MSTATUS set to 0 if things went well.
-
- The local host receives the confirmation and continues downloading the firmware module in fragments using VS_MODULE_OPERATION write requests, advancing the offset and adjusting the length with each write.
-
- The local host send a VS_MODULE_OPERATION.REQ close module write session request having COMMIT_CODE bits 0 and 1 set. to indicate “force commit” and “commit without reset”, respectively.
-
- The device receives the request, verifies the module length and checksum then transfers the module from scratch memory to it's final location in flash memory.
-
- The device responds with VS_MODULE_OPERATION.CNF close module write session with MSTATUS set to 0 if things went well. If things did not go well then the local host must request a new write module session and start over.
-
- At this point, the device is ready to boot from flash memory if the power fails or the device resets.
-
- The Open Powerline Toolkit can perform all sorts of operations on Atheros powerline devices. Many operations are simple and can be accomplished using one command. Others are more complex and may require several commands. This section demonstrates common console commands that you might want to use when experimenting or working with Atheros powerline devices. Multi-command procedures can be generalized and automated using any programming or scripting language that can execute console commands.
-
diff --git a/docbook/ch05s02.html b/docbook/ch05s02.html
deleted file mode 100644
index 27099193..00000000
--- a/docbook/ch05s02.html
+++ /dev/null
@@ -1,61 +0,0 @@
-Select an Interface on Linux
- Linux network interfaces are referenced by name. Use Linux utility ifconfig to determine the names of interfaces on your host. By default, Toolkit programs communicate with powerline devices on interface eth1 but another interface can be specified on the command line with the -i option:
-
Example 5.1.
- Selecting another Interface on Linux
-
-# int6k -i eth3 ...
-
- In the previous example, int6k will send and receive frames on interface eth3 instead of the default interface. Having to specify the interface can become become tedious when entering commands manually. An alternative method involves setting environment variable PLC to your preferred Ethernet interfaces, as follows:
-
Example 5.2.
- Changing the Default Interface on Linux
-
-# export PLC="eth2"
-
- In the previous example, environment variable PLC is defined and exported, making it available to all programs running under the current console session. This command can be included in ~/.profile or /etc/profile or in /etc/environment on Debian ™ and Ubuntu™ systems.
-
- The previous example demonstrates the use of Linux ifconfig utility to identify available network interfaces by name and MAC address.
-
- If your computer has multiple Ethernet interface cards installed, you can connect each card to a different Atheros powerline device and communicate with each device, independently, from one console session (window) by specifying the appropriate interface card with each command. It is also possible to open multiple console sessions (windows), each having a unique enviroment, and assign a different value for PLC in each enviroment.
-
diff --git a/docbook/ch05s03.html b/docbook/ch05s03.html
deleted file mode 100644
index 542dcd7c..00000000
--- a/docbook/ch05s03.html
+++ /dev/null
@@ -1,29 +0,0 @@
-Select an Interface on Windows
- Winpcap references host network interfaces by number, not name. This means that you must determine the proper interface number for the network adapter that you plan to use. Use Toolkit pcapdevs utility will enumerate available host network adapters by number, MAC address and description. By default, Toolkit programs communicate with powerline devices on pcap interface 2 but another interface can be specified on the command line with the -i option:
-
Example 5.4.
- Selecting another Interface on Windows
-
-# int6k -i 3 ...
-
- In the previous example, int6k will send and receive frames using host interface 3 instead of the default interface. Having to specify the interface can become tedious when entering commands manually. Presently there is no way to specify a default interface on WIndows platforms.
-
Example 5.5.
- Finding Interfaces on Windows
-
-# pcapdevs
- 1 00:00:00:00:00:00 \Device\NPF_GenericDialupAdapter (Adapter for generic dialup
- 2 00:0E:2E:03:5F:B8 \Device\NPF_{4CFAABD5-C929-4942-914B-BDFE72B13611} (Realtek R
- 3 00:C0:49:D5:CB:14 \Device\NPF_{73E0D2EF-6069-4831-B379-507025F2BDCD} (Realtek R
- 4 00:0C:76:87:3E:3D \Device\NPF_{86B96905-3AA7-46F1-969A-6C23E3BBBA8B} (Broadcom
-
- The previous example illustrates the use of Toolkit pcapdevs utility to identify available network interfaces by interface number, MAC address and description. The descriptions have been truncated in this example because they are too long. Devices having MAC address 00:00:00:00:00:00 are unavailable.
-
- Before you start working with Atheros powerline devices, you should determine the chipset and firmware revision because that will determine the types of operations that can be performed and the order in which some operations should be performed. The following example illustrates how to determine this information.
-
Example 5.6.
- Device Identification
-
-# int6k -r
-eth1 00:B0:52:00:00:01 Fetch Version Information
-eth1 00:B0:52:DA:DA:23 INT6300A0 INT6000-MAC-3-0-3001-1081-LA-A NOT_UPGRADEABLE
-eth1 00:B0:52:FE:87:2D INT6000A1 INT6000-SL-0-1-0110-200-2006-0415-BETA NOT_UPGRADEABLE
-
- This example demonstrates several things.
-
- First, the int6k-r option requests hardware and software revision information from a device by sending an Atheros VS_SW_VER vendor-specific managerment message and waiting for a response. Atheros vendor-specific management messages are described in the Atheros HomePlug AV Firmware Technical Reference Manual. It you do not have access to this document then many toolkit features may be difficult to understand.
-
- Since we did not specify an Ethernet interface on the command line, the default interface was used. In this case, the default interface was eth1 and so we observe that eth1 was used to both send requests and receive responses.
-
- Since we did not specify a device address on the command line, the default address was used. Device addresses are also known as MAC, “Ethernet” or “hardware” addresses. They uniquely identify a device on a network. Unlike Ethernet cards, powlerlines device do not have IP addresses.
-
- The default device address for toolkit programs is 00:B0:52:00:00:01. This address is the Local Management Address (LMA). All Atheros devices connected to the local host will respond to this address and include their actual address in the response. In the above example, two devices responded. This means that both were connected directly to eth1, perhaps via a network hub. Observer that device 00:B0:52:DA:DA:23 is an INT6300 and device 00:B0:52:FE:87:2D is an INT6000. The first device is running Atheros firmware and the second device is running the Atheros Softloader.
-
Example 5.7.
- Inspecting Device Configuration
-
- To find out more about device 00:B0:52:DA:DA:23 we might issue the following command where option -I requests identity information stored in the device PIB. In this case, we specified the device by MAC address to prevent other local devices from responding. There is no harm in having both devices respond so we could have specified both hardware addresses.
-
-# int6k -I 00:B0:52:DA:DA:23
-eth1 00:B0:52:DA:DA:23 Device Identity
-eth1 00:B0:52:DA:DA:23 -------
- PIB 3-2 7864 bytes
- MAC 00:B0:52:DA:DA:23
- DAK 24:03:D7:84:09:A0:9A:78:8D:F6:82:75:AF:0D:0F:D8
- NMK 50:D3:E4:93:3F:85:5B:70:40:78:4D:F8:15:AA:8D:B7 (HomePlugAV)
- NID B0:F2:E6:95:66:6B:03
- NET Jupiter-23
- MFG Intergalactic Death Rays Inc.
- USR Rattin Tordo
- CCo Auto
-
- Pay special attention to the MAC address after flashing NVRAM. Hardware address 00:B0:52:00:00:03 indicates the Default PIB used when no other PIB is available. The Default PIB disables communication over powerline.
-
- Pay special attention to the NMK when devices cannot communicate. Devices having different NMK values will not form a network. Conversely, all devices having the same NMK will form a network. This becomes important when programming large numbers of devices. You must have an out-of-the-box networking strategy that balances user convenience and network security.
-
- The string next to the NMK indicates that password “HomePlugAV” was used to generate that key. This is one of two default passwords and keys used by Atheros. In some cases, it may be another clue that the device is using the default PIB.
-
- A powerline network consists of one or more powerline devices that share a common NMK. One device on the network is in charge of the network and known as the Central Coordinator (CCo). All other devices on that network are known as stations (STA). Each device maintains internal information about the network to which it belongs. You can view that information at any time.
-
- The example above prompts the local device on interface eth3 for network membership (-m) information. Device 00:B0:52:00:00:BB responded and reported that it belongs to one powerline network. The first block of information identifies the network CCo. The second block of information identifies a network STA. This second block will repeat when multiple stations are present. Each device on the network has a unique Terminal Equipment Identifier (TEI) within the network. The average PHY rates show the data rates between the reporting device and each STA. In this cases there has been no traffic.
-
- A powerline network is formed when two or more devices share a common Network Membership Key (NMK). An NMK is always 16 bytes (32 hexadecimal digits) in length and can have any value, including all zeros. Devices programmed with the same NMK value can communicate while those programmed with different NMK values cannot. Program int6k can be used to program a local or remote device with a specific NMK value.
-
Example 5.9.
- Setting the Network Membership Key
-
-# int6k -M
-eth1 00:B0:52:00:00:01 Set Local Network Membership Key
-eth1 00:B0:52:BA:BA:56 Setting ...
-
- This example programs the local device with the default NMK. Option -M sets the network membership key with the default key value. The default key is used because we omitted option -K and the local device is programmed because we omitted the device MAC address.
-
- One can quickly and easily create a default network by connecting each device, in turn, to the local host and executing this command shown above. The devices will then form a network when connected via the powerline. Although fast and simple, this method is not very secure because the default NMK is used by many Atheros tools and is well known.
-
- There are cases where one wants to create separate, independent networks on the powerline. This is accomplished by programming some devices with one NMK and other devices with another NMK. In such cases we need to specify an NMK value.
-
Example 5.10.
- Forming a Custom Network
-
-# int6k -M -K 00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF
-eth1 00:B0:52:00:00:01 Set Local Network Membership Key
-eth1 00:B0:52:BA:BA:56 Setting ...
-
- This example programs the local device NMK with the value 00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF. Option -K sets the default key value used by option -M. The default device is programmed because we omitted a target MAC address from the command line but we could have specified the local device using the actual device MAC address or the Local Management Address (LMA) of 00:B0:52:00:00:01 or the keyword local, like so ...
-
- Once a network has been established, one can change the NMK of remote devices over the powerline but once the NMK on the remote device has changed, it is no longer part of original network and can no longer be returned to the network in the same way. Additionally, one cannot change the NMK on a remote device without specifying the DAK of the device to be changed.
-
- This example sets the NMK on remote device via the local device. Option -J specified the MAC address of the remote device. Option -D specified the DAK of the remote device. The request is sent to the local device, because we omitted the target MAC address, and the local device forwards our request to the remote device. The request will fail if the remote device is not accessible or the remote device DAK is incorrect.
-
- This command is one of the more complicated int6k commands, requires lots of typing and is consequently prone to typing errors. The order of command line options is not important.
-
- Device identity, capability and behavior are controlled by runtime parameters stored in the device PIB. To change device identity, capability or behavior you must alter a template PIB file, download it to the device and flash it into NVRAM. A template PIB can come from several sources but an excellent souce is the device, itself. Configuration changes then become a simple read, modify and write back operation.
-
Example 5.12.
- Read a PIB File
-
-# int6k -i eth2 -p old.pib local
-eth2 00:B0:52:00:00:01 Read Parameters from Device
-eth2 00:B0:52:00:00:BE Read.
-
- This example reads the PIB from the local device and writes it to a file. The toolkit has a growing number of programs designed to inspect and change pibfiles in various ways. Program modpib is one program that can be used for this purpose.
-
- The example above edits identity parameters in PIB file, old.pib, recomputes the internal checksum and re-writes the file. The network identity parameters are MAC (-M), NMK (-N) and DAK (-D). The user identity parameters are MFG_HFID (-S), NET_HFID (-T) and USR_HFID (-U). The PIB file is ready for download and flash.
-
- Program modpib is a safe way to edit a PIB file because it only change selected parameters. Use program setpib to edit other parameters if required.
-
- This example writes the modified PIB file, old.pib, to the local device and commits it to NVRAM. Option -P writes the PIB file to the device instead of reading it from the device. Option -C with argument pib commits only the PIB, and not firmware, to NVRAM.
-
- Eventually, you may want to upgrade (or downgrade) the runtime firmware stored in NVRAM. To do this, you must locate a copy of the new .nvm file on the Atheros FTP site and download it to your host. You must then download the file to the device and ask the runtime firmware on the device to write the file to NVRAM. Writing firmware to NVRAM is also called “flashing the device”. Program int6k can be used for this purpose when runtime firmware is executing on the device.
-
- Program int6k instructs runtime firmware to write to NVRAM but the firmware will behave differently depending on how it was loaded and started. The first time NVRAM is written by runtime firmware, the Factory PIB is created in NVRAM. The second time, the User PIB is created. Thereafter, the User PIB will be re-written each time. This preserves original factory settings and permits their restoration regardless of intervening parameter changes. This means that you should make an effort to get things right the first time.
-
Example 5.15.
- Upgrade Firmware and PIB
-
-# int6k -i eth2 -P ../firmware/new.pib -N ../firmware/new.nvm -F
-eth2 00:B0:52:00:00:01 Write Firmware to Device
-eth2 00:B0:52:00:00:BE Wrote ../firmware/new.nvm
-eth2 00:B0:52:00:00:01 Write Parameters to Device
-eth2 00:B0:52:00:00:BE Wrote ../firmware/new.pib
-eth2 00:B0:52:00:00:01 Flash NVRAM
-eth2 00:B0:52:00:00:BE Flashing ...
-eth2 00:B0:52:00:00:BE Started INT6000-MAC-3-3-3325-00-2443-20080414-FINAL-B
-
- This example downloads a PIB file (-P) and an NVM file (-N) to the device then instructs the runtime firmware to write (or flash) (-F) both of them to NVRAM. Option -F always writes both to NVRAM but option -C can be used to write only one or the other or both.
-
- Observe that options -P, -N and -F are all in uppercase. As a rule, uppercase options modify the device and lowercase options do not. One notable exception to this rule is -I which merely displays device identity.
-
- When flashing a PIB to the local device, the PIB DAK must match that of the local device or you will get a “DAK Not Zero” error message. This message is incorrect and should probably read “DAK Mismatch”. The following two toolkit commands should prevent this error from occuring on Linux. The first command reads the actual MAC (-A) and DAK (-D) from the device using program int6kid and inserts them on the command lise as modpib arguments using options -M and -D. We need not include the station MAC address on the int6k command line because the device is local, but we could include it.
-
- When flashing a PIB to a remote device, the PIB DAK must be all zeros or you will get a “DAK Not Zero” error message. This message occurs because the HomePlug™ AV Specification does not permit a DAK to be transmitted over powerline in any form. The following two toolkit commands should prevent this error on Linux. We must include the device MAC on the command line when invoking each program because the device is remote. Notice that symbol none can be used as shorthand 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00 when specifying the DAK.
-
- The MAC address stored in the PIB can have any value but it is good practice to preserve the original value. This avoids the common mistake of flashing multiple network stations with the same MAC address because the PIB was not updated.
-
- Some device configurations have no flash memory to store runtime parameters and firmware so the local host must store them until needed then write them into device SDRAM and start execution. This is also needed when the flash memory is blank or corrupted because the runtime firmware is the only way to write flash memory. Programs int6kf, int6kboot, ampboot and plcboot are used to configure a blank device then download runtime parameters and firmware and start execution. They all perform the same basic function but in different ways.
-
Example 5.18.
- Start Firmware on INT6000™
-
-# int6kf -C abc.cfg -N abc.nvm -P abc.pib
-
- Program int6kf can be used to download runtime firmware and parameters and start execution on and INT6000™ chipset. The process involves downloading a .cfg file using VS_SET_SDRAM, downloading a .nvm file using VS_WR_MEM, downloading a .pib file using VS_WR_MEM then starting firmware execution using VS_ST_MAC. See the int6kf man page for an explanation of the command line options and arguments used here.
-
Example 5.19.
- Start Firmware on INT6300™ and INT6400™
-
-# int6kboot -N abc.nvm -P abc.pib
-
- Program int6kboot can be used to download runtime firmware and parameters and start execution on an INT6300™ or INT6400™ chipset. The process involves downloading a .nvm file using VS_WR_MEM, downloading a .pib file using VS_WR_MEM then starting firmware execution using VS_ST_MAC. No .cfg file is needed or permitted with this application.
-
Example 5.20.
- Start Firmware on AR7400™
-
-# ampboot -N abc.nvm -P abc.pib
-
- Program ampboot can be used to download runtime firmware and parameters and start execution of runtime firmware on an INT6300™, INT6400™ or AR7400™ chipset. The process involves downloading a .pib file using VS_WR_MEM, downloading a .nvm file using VS_WR_MEM then starting firmware execution using VS_ST_MAC. A general purpose applet, stored in the .nvm file, configures SDRAM. No .cfg file is needed or permitted with this application.
-
Example 5.21.
- Start Firmware on AR7420™
-
-# plcboot -N abc.nvm -P abc.pib
-
- Program plcboot can be used to download runtime firmware and parameters and start execution an INT6300™, INT6400™, AR7400™ or AR7420™ chipset. This program detects the type of chipset and the image file format. The boot process varies depending on the chipset that is detected and the image file format. For the AR7420™ chipset, this process involves downloading a .pib and .nvm file using only VS_WRITE_EXECUTE messages. For earlier chipsets, the process is as described above.
-
- When the Bootloader is running, it is possible to perform systematic diagnostic testing by downloading and executing a variety of small programs, called “applets”. A collection of applets can be found in the toolkit Applets folder. Applet manpages describe the purpose of each one. Some applets are more useful than others. Start by reading the applets manpage.
-
- Program int6ktest can be used to sequentially download and execute a series of applets. Applets have evolved over time and some are more useful or informative than others. Newer applets report progress and errors on the console. Older applets report progress or errors by flashing the onboard LEDs. This means of testing cannot be used after the flash memory has been programmed unless you erase, corrupt or remove the flash.
-
- This example uses program int6ktest to download and execute applets connection.nvm, memctl.nvm and marchloop.nvm to the powerline device on host interface “eth4”. The first applet checks circuit board connections to memory and reports progress and errors by flashing onboard LEDs. The second configures the SDRAM controller and exits without any indication. The third performs a systematic test of SDRAM and reports progress and errors on the console. In this case the test passed.
-
- See programs amptest and plctest for updated versions of this program for use with AR7400™ and QCA7420™ chipsets.
-
- The INT6300™ and INT6400™ do not require a special SDRAM configuration file and so program int6kboot may be used in place of int6kf which is described here. The only real difference between the two programs is the presence or absence of option -C on the command line.
-
- The int6kf program can program a blank or corrupted NVRAM on the INT6300. The process involves starting the runtime firmware as shown in the previous example then downloading a .nvm file using a VS_WR_MOD message, downloading a .pib file using another WR_WR_MOD message then writing both to NVRAM using a VS_MOD_NVM message. An example int6kf command line is shown below. It is identical to the one shown above except for the addition of the flash option at the end.
-
Example 5.22.
- Flash NVRAM with int6kf
-
-# int6kf -C abc.cfg -N abc.nvm -P abc.pib -F
-
- The example above starts the firmware then uses it to program the NVRAM. This was done in one step rather than two seperate steps as shown in the examples before it. The only difference is that int6k needs to use the 'force flash' option when using downloaded firmware to write NVRAM. The following example accomplishes the same thing as the previous example but uses int6k to program NVRAM. See the int6k man page for an explanation of the command line options and arguments used here.
-
- The int6kf program cannot program blank or corrupted NVRAM on the INT6000 unless the Softloader is running. Since the Softloader resides in NVRAM, the NVRAM must be either pre-programmed before use or removed and externally re-programmed if it corrupts.
-
- This procedure describes how to pair two UART-enabled powerline adapters once they have been programmed, personalized and tested. This example assumes you are using a Windows host and two powerline adapters having MAC addresses 00:B0:52:00:05:F9 and 00:B0:52:00:05:FA.
-
- Start with the first device, 00:B0:52)(00:05:F9. Plug the host serial cable into the RJ45 port on the device and plug the device into an AC power source.
-
- Change to transparent mode using program int6kuart. Option -v displays outgoing command and incoming serial responses. The “+++” is the serial data sent to the device and the “OK” is the device response.
-
-# int6kuart -s com3 -wv
-+++
-OK
-
-
- Read the adapter PIB into a temporary file using program int6kuart. The following command reads the PIB from serial device com3 and saves it to file temp.pib on the host. You will see a series of dots appear on the console as the PIB is read from the device. The filename used is not important.
-
- Program the PIB file with the default destination address using program setpib. The following command inserts the MAC address of the second device, 00B0520005FA, at fixed offset 0x2C8A in file temp.pib downloaded in the previous step.
-
-# setpib temp.pib 2C8A data 00B0520005FA
-
-
- Write the modified PIB file back to the adapter and commit it to flash memory using program int6kuart. The following command write file temp.pib to serial device com3 then commits the PIB to flash memory. You will see a series of dots appear on the console as the PIB is written to the device. The device will reboot.
-
- Change the device to Transparent Mode using program int6kuart once the device resets.
-
-# inc6kuart -s com3 -wv
-+++
-OK
-
-
- Verify that the destination MAC address is correct using program int6kuart.
-
-# int6kuart -s com3 -d
-00B0520005FA
-
-
- Repeat this process on the second adapter, 00:B0:52:00:05:FA, using the MAC address of the first device, 00:B0:52:00:05:F9, as the destination address.
-
- The following steps may help determine why two devices cannot communicate via ethernet over the powerline. They assume that you have successfully installed the Powerline Toolkit but are having trouble forming a powerline network.
-
- On Linux, run program ifconfig to determine available interface names as described earlier. The default interface name is eth1 on Linux. You must use interface names, not numbers, on the Linux command line.
-
- On Windows, run program pcapdevs to determine available interface numbers as described earlier. The default interface number is 2 on Windows. You must use interface numbers, not names, on Windows command lines, even under Cygwin.
-
- In either case, Linux or Windows, if a powerline device is connected to any interface other than the default interface then you must specify the name or number on the command line each time you run int6k. In the following examples, we will use device numbers 3 and 4 to indicate two different interfaces on the same host.
-
- Make sure both devices respond to int6k -ri3 and int6k -ri4 as described earlier. They should each display the software revision information. If you get no response then check your connections and network configuration. If you see “Bootloader” then the connection is good but the firmware is not running. If the firmware versions are different then make them the same.
-
- You must have running firmware to continue and the firmware revisions should be the same.
-
- Make sure both devices respond to int6k -Ii3 then int6k -Ii4 as described earlier. They should display about 10 lines of information showing their MAC, DAK and NMK.
-
- If the MAC is 00:B0:52:00:00:01 then either the default Atheros PIB was stored in NVRAM or you downloaded and flashed the generic Atheros PIB without changing the MAC address beforehand.
-
- If the MAC is 00:B0:52:00:00:03 then either no PIB was stored in NVRAM or you downloaded and attempted to flashed an invalid PIB. The firmware will disable powerline communications in this case.
-
- If the devices have different NMKs they will not form a network.
-
- One way to form a network is to manually set the NMK on each device to a known value with int6k -Mi3 then int6k -Mi4. Each device will reset afterwards and may reset again when the other device is changed. Repeat Step 3 and confirm that both devices have the same NMK and that “(HomePlugAV)” appears next to the NMK.
-
- Another way to form a network is to physically press the push-button on each device for 2 to 3 seconds or simulate a push-button press on each device with int6k -B1 -i3 then int6k -B1 -i4. The devices should reset several times and then form a network.
-
- Make sure each device knows the other one is present on the network with int6k -mi3 then int6k -Mi4. Each device should show that a network exists and identify the other device as a station on that network. It may take up to 120 seconds for one device to find another and up to 5 minutes to recognise that the other device has left the network.
-
- Step 5 should also show the TX and RX PHY rates for each device. Ping each host Interface from the other several times to generate traffic. The PHY Rates should then be non-zero. We use efsu to generate traffic inside our own scripts. You may elect to use another method.
-
- Power down both devices then power them up. Wait about 20 seconds and confirm that you can ping in either direction.
-
- Avitar can be used to configure a PLC device as either a normal PLC station or a SLAC PEV-PLC or SLAC EVSE-PLC station. In doing so, Avitar changes several PIB values at the same time. This section illustrates how to configurat a PIB the same way using the toolkit.
-
- The HomePlug Green PHY Specification refers to the APCM_SET_CCO.REQ and APCM_CONF_SLAC primatives in the SLAC protocol description. These are virtual operations to be implemented by the user. In both cases, one must read the PIB from the PLC device, edit the PIB, recompute PIB checksums and write the PIB back to the PLC device. This can be done manually, using Avitar, or in a script, using the Powerline Toolkit as shown below, or programatically, using custom software.
-
Table 5.1.
- PEV-PLC PIB Settings
-
- OFFSET
-
- LENGTH
-
- SYMBOL
-
- DESCRIPTION
-
- 0000F4
-
- 1
-
- CCoSelection
-
- 1: This sets CCo Selection to Never;
-
- 001653
-
- 1
-
- SLAC_EnableMode
-
- 1: This sets SLAC Selection to PEV;
-
- 001C98
-
- 4
-
- LowLinkSpeed_kbps
-
- 10240
-
- 001C9C
-
- 4
-
- HighLinkSpeed_kbps
-
- 102400
-
-
- The following shell script converts a factory PIB to a SLAC PEV by setting the CCO Mode to Never and the SLAC Mode to PEV. The User HFID is set to “PEV” for role identification, optionally. This PIB must be written into PEV-PLC flash memory for proper operation.
-
-#!/bin/sh
-# file: pev.sh
-# ========================================================================
-# convert a factory PIB to a SLAC PEV PIB by changing these PIB settings;
-# ------------------------------------------------------------------------
-setpib ${1} 74 hfid "PEV"
-setpib ${1} F4 byte 1
-setpib ${1} 1653 byte 1
-setpib ${1} 1C98 long 10240 long 102400
-
Table 5.2.
- PEV-EVSE PIB Settings
-
- OFFSET
-
- LENGTH
-
- SYMBOL
-
- DESCRIPTION
-
- 0000F4
-
- 1
-
- CcoSelection
-
- 2: This sets CCo Mode to Always;
-
- 001653
-
- 1
-
- SLAC_EnableMode
-
- 2: This sets SLAC Mode to EVSE;
-
- 001C98
-
- 4
-
- LowLinkSpeed_kbps
-
- 10240
-
- 001C9C
-
- 4
-
- HighLinkSpeed_kbps
-
- 102400
-
- The following shell script converts a factory PIB to a SLAC EVSE by setting the CCO Mode to Always and the SLAC Mode to EVSE. The User HFID is set to “EVSE” for role identification, optionally. This PIB must be written into EVSE-PLC flash memory for proper operation.
-
-#!/bin/sh
-# file: evse.sh
-# ========================================================================
-# convert a factory PIB to a SLAC EVSE PIB by changing these PIB settings;
-# ------------------------------------------------------------------------
-setpib ${1} 74 hfid "EVSE"
-setpib ${1} F4 byte 2
-setpib ${1} 1653 byte 2
-setpib ${1} 1C98 long 10240 long 102400
-
- APCM_SET_CCO Primative
-
- This primative configures a PLC state by reading PIB from PLC, changing CCoSelection, computing new PIB checksum then writing the PIB back to PLC. It can be performed manually using Avitar, in a script using the Powerline Toolkit or programatically using custom software.
-
- This page explains how to install and use two Qualcomm Atheros Powerline Toolkit programs, pev and evse, to demonstrate the HomePlug AV Signal Level Attenuation Characterization (SLAC) protocol.
-
- On Microsoft Windows, the two programs are distributed in a seperate Microsoft installation file slac-utils-x.x.x.msi. To install them on Microsoft Windows, double-click on the installation file. The programs will be installed in folder c:\Program Files (x86)\Qualcomm Atheros\Powerline Toolkit unless the user overrides the default settings durin installation. New users should add this folder to the PATH environment variable and define environment variable PLC to reference the Ethernet interface connected to their PLC device.
-
- On Linux, the two programs are distibuted inside the full toolkit tarball plc-utils-x.x.x. To install them on Linux, unpack the tarball and change directory to the package folder. Type "sudo make install" to compile and install the toolkit. Type type "sudo make manuals" to install man pages. New users should define environment variable PLC to reference the inteface connected to their PLC device.
-
- Exception!
-
- In some cases QCA will distribute two Windows .exe files and two monolithic .c files. On Windows, copy the executable files to folder c:\Program Files (x86)\Qualcomm Atheros\Powerline Toolkit and update the system PATH and PLC environment variables. On Linux, compile the two source files using "gcc -o pev pev.c" and "gcc -o evse evse.c" and copy the two binary files to /usr/local/bin then update the system PLC environment variable. You will need root priviledge to copy the binary files to the system folder and you must change the binary file permissions to 4555 in order to execute them as a non-root user.
-
- Each program reads an optional configuration file on start-up. Program pev reads pev.ini and program evse reads evse.ini. Qualcomm Atheros does not provide these files but option -c, on each program, can be used to print a template configuration file on stdout. Once a user settles on a convenient working folder, they should run command "pev -c > pev.ini" to create the configuration file for program pev and "evse -c > evse.ini" to create the configuration file for program evse.
-
- A SLAC demonstration can be setup using two Qualcomm Atheros PL16 boards, two personal computers, a power strip and a powerline impairment of some kind. One PL16 board must be configured as a PEV and the other must be configured as an EVSE. Plug both PL16 boards into the powerstrip and connect each board to a different computer via Ethernet. Run program pev on the computer connected to the PEV configured board. Run program evse on the computer connected to the EVSE configured board. Program evse runs continuously waiting to service pev programs running on other computers. Program pev runs until charging occurs then exits.
-
- On the EVSE host, start program evse as shown below. It will run until cancelled.
-
-# evse
-evse: UnoccupiedState: Listening ...
-
- Messages will appear on the console as events occur. The first field is the program name, in this case “evse”. The second field is the function name, in this case “UnoccupiedState”. In this case, program evse does nothing until some PEV trys to associate.
-
- On the EVSE host, run program evse as shown below. It will run until it detects and connects to an available EVSE-HLE. Use option -w to vary probe timeouts.
-
- Messages will appear on the console as events occur. The first field is the program name, in this case “pev”. The second field is the function name, in this case DisconnectedState and pev_cm_slac_param. The right arrow indicates that function pev_cm_slac_param is sending a CM_SLAC_PARAM.REQ message. If things work properly, you will see a another message indicating that function pev_cm_slac_param is receiving a CM_SLAC_PARAM.CNF message.
-
- Unimpaired SLAC configuration. Result should be below threshold and PEV should connect.
-
- Impaired SLAC configuration. Result should be above threshold and PEV should not connect.
-
- The Open Powerline Toolkit comes with a variety of example scripts in the scripts folder. They have proven useful to Atheros engineers but may not satisfy your specific needs. This chapter explains how some of these scripts work so that you can modify them to do what you need to do. Most scripts covered in this chapter are intended for a Powerline Workstation.
-
- Atheros provides GNU bash scripts as examples and does not guarantee that they are suitable in any or all situations. Furthermore, Atheros may not always update them to reflect changes to toolkit programs. Toolkit command line syntax may change from one release to the next and so Atheros cannot guarantee that older scripts will work with newer programs. The scrips are small, simple and well organized. Do not run them until you have read them and understand what they do and how they work.
-
- Although Toolkit programs run under Windows their power is realized through scripts. Scripting requires environmental support for sophisticated symbol substitution and expansion. Most Linux shells are suitable but Microsoft DOS is not. On Windows, consider using installing Cygwin and using their bash shell. Scripting languages Tcl and Python are suitable alternatives. Another alternative is to write small Windows programs that format and execute the DOS shell commands you want.
-
- We summarize some scripting rules here for those who may not be familiar with Linux scripting. If you do not understand the rules or the syntax or have questions then you should consult Linux documentation available on the internet.
-
- On Linux, all commands typed in a console window are read and interpreted by a command interpreter called a shell program. The are several shell programs available for Linux but we use bash exclusively. If you elect to use a different shell program, like csh, then you will probably need to modify our scripts.
-
- If you do not set execute permissions you must submit it to the shell for execution. If you set execute permissions on a script file then you can execute it directly by typing the filename. You can set execute permission on Linux with the chmod utility as shown in the example below.
-
- The example above show how to run a script file using bash when it does not have execute permissions set. It then shows how to set the execute permissions and run it directly without using bash.
-
- It is good practice to insert a bang-path on the first line of a script to ensure is is executed by the correct shell program, regardless of the shell used to open the script. It is possible to open a script with one shell and have it execute under another shell.
-
-#!/bin/bash
-
- The next example shows an example bang-path. The first two characters inform the shell that this file contains scripting commands. The remainder of the bang-path line includes a program path with any options and arguments needed by the program. The shell will invoke that program and pass the rest of the script file to the program as standard input.
-
- Symbols are defined with the symbol name then an equals sign then the definition text. By convention, symbol names use uppercase letters. The definition consists of all characters from the equals sign to the line end. If a definition contains white space, enclose it in quotes so that it is treated as one string when expanded. Symbol scope ends with the defining file unless it is exported.
-
-NIC=eth0
-MAC=00:B0:52:00:12:34
-MFG="Intergalactic Software Pirates, Inc."
-...
-echo NIC is ${NIC} MAC is ${MAC} MFG is ${MFG}
-
- To reference a symbol, precede the variable name with a dollar sign. Atheros scripts go one step further by enclosing the symbol name is braces. This improves readability and simplifies global search-and-replace operations.
-
- Different hosts may use interfaces for different purposes. For example, one host might use eth0 for local network communications and eth1 for powerline communications. Another host might do the opposite. A portability problem is created when scripts use the literal interface names on the command line, as illustrated below:
-
- The commands shown above will work on a host where eth1 and eth2 are used for powerline communications but will not work on another host where eth1 or eth2 are configured differently. Editing scripts can become a chore when they contain many interface references. One solution is the consistent use of symbols. For example, the following example provides some degree of portability.
-
- The commands shown above are an improvment because symbols NIC1 and NIC2 can be edited once; however, if you frequently move many scripts from one host to another then each script must be changed. That can also become a chore. A better solution is to define the symbols NIC1 and NIC2 once in a single file and then include the definitions in scripts that need them. For example, if we created file hardware.sh like so ...
-
- On Linux, the . command causes the named file to be included in-line as though it were part of the including file. This elminates the need to export symbol definitions. A full discussion of Linux environment variable scope can be found on the internet. The point is that each host should have it's own definitions files stored in a common folder so that other scripts can include them and reference them in a consistent manner.
-
- Atheros example scripts include two definitions files: hardware.sh and firmware.sh. File hardware.sh defines hardware related symbols as shown below and file firmware.sh defines firmware and configuration filenames. They reside in a scripts folder and relative path is used to access them. This has proven to work well in most situations.
-
Example 6.1.
- hardware.sh
-
- You should create a hardware.sh file in a common folder on each host where you want to execute toolkit scripts. In this way, a script created on one host can be executed on another host without modification.
-
- File hardware.sh assigns specific values to symbols that are used in many of the scripts found in the scripts folder. Some Atheros scripts uses all these symbols and some do not. By convention, NIC1 and NIC2 name the Ethernet interfaces connected to a Golden Node and Device Under Test. MAC1 and MAC2 are the hardware addresses of NIC1 and NIC2, respectively. These symbols can be referenced in scripts with references like ${NIC1} or ${MAC1}. Of course, you could define other symbols here, as well. See the script under Device Upgrade as one example of how file hardware.sh can be included in another script.
-
- Some scripts, such as flash.sh and upgrade.sh, only operate on one device and do not need to define both NIC1 and NIC2. By convention, these scripts reference interface DUT only.
-
Example 6.2.
- firmware.sh
-
- You should create a firmware.sh file in a common folder on each host where you want to execute toolkit scripts. In this way, a script created on one host can be executed on another host without modification.
-
- File firmware.sh assigns specific filenames to symbols that are used in some of the scripts found in the scripts folder. Some Atheros scripts use all of these symbols and some do not. By convention, CFG defines the SDRAM configuration file used to initialize an INT6000™ or INT6300™ device, PIB defines the Parameter Information Block file to be used and NVM defines the firmware image file to be used.
-
- This file is especially useful when working with a specific version of firmware. If there are multiple definitions for a symbol, the last definition is the one that takes effect. At Atheros, this file often contains dozens of definitions and we merely move or copy the ones we want to the end of the file. Our custom scripts then operate on the same configuration, parameter and firmware files until we reorder the definitions in firmware.sh.
-
- You may want to confirm that a device is actually connected to an Etherenet interface before attempting to run a script. Program int6kwait can be used for this purpose. We often print a brief message to alert the operator that there is no connection or the device has no power applied.
-
-int6kwait -xqsi ${NIC1}
-if [ ${?} != 0 ]; then
- echo "Device is not connected"
- exit 1
-fi
-
- In the above example, we invoke int6kwait to poll the device connected to a specific Ethernet interface (-i) until the firmware starts (-s). The program will return a non-zero return value (-x) if the device does not start within a given period of time. By default, the timeout period is 60 seconds. On return, we check the return code then print an error message and exit the script on timeout. Symbol NIC1 must be defined earlier in the script, possibly in hardware.sh.
-
- Some Atheros scripts need random MAC, DAK or NMK strings as arguments to Toolkit programs. Program rkey can be used for this purpose. We demonstrate one way to define symbols here and demonstrate how to use symbols later on.
-
- The first statement, above, uses program rkey to read file secret.key and compute a random DAK (-D). The ouput string is assigned to symbol DAK. The second statement uses program rkey to read the file secret.key and compute a random NMK (-M). The output is assigned to symbol NMK.
-
- Some scripts need actual MAC, DAK or NMK strings as arguments to Toolkit programs. Program int6kid can be used for this purpose. We demonstrate one way to define symbols here and demonstrate how to use them later on.
-
-
- The first statement, above, uses program int6kid to echo the DAK (-D) from the device connected to Ethernet interface NIC1 and assign the output to symbol DAK. The second statement uses program int6kid to echo the NMK (-M) of the device connected to Ethernet interface NIC1 and assign the output to symbol NMK.
-
- Many scripts place a device in a known state by editing a PIB file and writing it to the device before starting an operation. Program modpib can be used for this purpose. It is safe because only certain values can be changed and, where necessary, certain cross-parameter computations are performed automatically.
-
- The example above uses modpib to set the CCo state (-C), the MAC address (-M), the DAK (-D) and the NMK (-N) in the defined PIB file. Argument 0 means “CCo Auto” and argument next increments the MAC address. The DAK and NMK were defined earlier in the script. Symbol PIB must be defined earlier in the script, possibly in firmware.sh.
-
- Program modpib will print an error message and return a non-zero value on error. We test the return value and exit the script on error to avoid subsequent errors. One could, of course, suppress normal output (-q) and print your own error message using the Linux echo utility.
-
- Initializing a device involves downloading memory configuration parameters, runtime firmware and runtime parameters into SDRAM and then starting the runtime firmware to make the device fully functional. Program int6kf can be used for this purpose when the INT6000 Softloader or INT6300 Bootloader is running. Additionally, program int6kf can be used to flash blank or corrupted NVRAM once runtime firmware has started.
-
- Device initialization is only necessary when a device that has no NVRAM or has corrupted NVRAM or has a Softloader stored in NVRAM. It is only possible when either the INT6000 Softloader or INT6300 Bootloader is running. See The Boot Process for detailed information.
-
- The example above uses program int6kf to download an SDRAM configuration file (-C), PIB file (-P) and NVM file (-N) then start firmware execution. Symbols NIC1, CFG, PIB and NVM must be defined earlier in the script, perhaps in files hardware.sh and firmware.sh.
-
- Program int6kf returns a non-zero value on error. We can check the return code and exit the script on error to avoid subsequent errors. We could, of course, suppress normal output (-q) and print our own error message using the Linux echo utility.
-
- In some cases, we may want to flash a blank or corrupted NVRAM after the runtime firmware has started. We could use program int6k for this purpose but program int6kf can be used, as well. Essentially, it initializes the device (as above) then downloads the PIB and NVM files again and flashes them into NVRAM.
-
- The example above initializes a device with an SDRAM configuration file (-C), PIB file (-P) and NVM file (-N) as before. Once the runtime firmware has started, the PIB and NVM files are downloaded again and flashed (-FF) into NVRAM.
-
- The force-flash option (-FF) is needed in this case because runtime firmware that has been written directly to SDRAM and started by the local host assumes there is no NVRAM present to flash or there might be Softloader firmware stored in NVRAM that must be protected from accidental flashing. Runtime firmware that has been read from NVRAM need not make that assumption.
-
- In some cases we want to replace the runtime firmware or runtime parameters stored in NVRAM. Program int6k can be used for this purpose when runtime firmware is running.
-
- A device update may be necessary when new runtime firmware or new runtime parameters or both must be programmed into NVRAM. It is only possible when NVRAM is present and the runtime firmware is running.
-
- The example above uses int6k to download a PIB file (-P) and NVM file (-N) then flash NVRAM (-F). Symbol NIC1 must be defined earlier in the script, perhaps in file hardware.sh. Symbols PIB and NVM must also be defined earlier in the script, perhaps in file firmware.sh.
-
- Program int6k returns a non-zero value on error. We can check the return code and exit the script on error to avoid subsequent errors. We could, of course, suppress normal output (-q) and print our own error message using the Linux echo utility.
-
-
- In some cases, you may want to preserve the current firmware on a device and update only the PIB. Program int6k can be used for this purpose, as well.
-
- The example above downloads a PIB file (-P) and commits (-C) the PIB only to NVRAM. There are a variety of device flash scenarios and each requires some varation on one of the examples shown here.
-
- Once two devices associate, you must send data across the powerline in both direction so that each device can compute a TX and RX PHY rate. One method is to use the efsu program that comes with the Toolkit. The program is designed to send free-form Ethernet frames for test and debug purposes but we can also use it to send lots of junk frames in either direction.
-
- The example above uses efsu to send the generic Ethernet frame stored in file frame.hex between the two Ethernet interfaces NIC1 and NIC2 (-i). In this example, NIC1 and NIC2 are both installed in the host. We have efsu insert the host source address in the OSA field (-h) and destination address in the ODA field (-d) of each frame as it is sent. The entire operation sends the same frame 1000 times (-l) in each direction, twice.
-
- Other methods of generating bi-directional traffic can be used but this method is simple, needs nothing other than the toolkit programs and permits easy synchronization. Program efsu is designed to send custom Etherenet frames, not measure or control data rates, but the toolkit includes open source program ttcp which is designed to measure and control data rates.
-
- Atheros powerline devices automatically compute their average PHY rate which can be read and displayed. Average PHY rate is an indication of performance and can be affected by attenuation and ambient powerline noise. Program int6krate is designed to report the average PHY rate.
-
-int6krate -xni ${NIC2}
-if [ ${?} != 0 ]; then
- echo "Network did not converge"
- exit 1
-fi
-
- The example above uses int6krate to read and display the average TX and RX PHY rates for the device connected to Ethernet interface NIC2. Option -n requests PHY rates. Option -x exits with a status that can be tested in the subsequent “if” statement. Output appears in fix-width columns to facilitate post-processing. Other ways to obtain PHY rates are “int6k -m” and “int6kstat -t”.
-
- Scripts should be designed, whenever possible, to perform correctly without user intervention but there are cases where user intervention is appropriate. The following example illustrates one bash shell method that only requires user input when default values are wrong.
-
- First, we define symbol MAC with a default value. The Linux echo utility prints a prompt on the console that includes the symbol value. The trailing newline is suppressed (-n) so that text can be typed immediately after the prompt. The echo command is terminated with semicolon (;) so that another command can be included on the same line. The shell read statement waits for the user to type something and press the enter key. The shell will assign the input to shell variable REPLY. The value of REPLY is evaluated and used to redefine the symbol only if the input was a non-zero length string.
-
-MAC Address [00:B0:52:00:BA:BE]:
-
- The user will see something like this. If the value is correct the user can press the enter key to generate a zero length string. Otherwise, the user can type the correct value before pressing the enter key.
-
diff --git a/docbook/ch07.html b/docbook/ch07.html
deleted file mode 100644
index ac18bb5f..00000000
--- a/docbook/ch07.html
+++ /dev/null
@@ -1,235 +0,0 @@
-Chapter 7. Support Function Reference
- The Open Powerline Toolkit includes many general-purpose or multi-purpose functions that may appear in other Qualcomm Atheros applications or in third party packages. Consequently, we describe them separately and store them in separate folders withing the toolkit.
-
- Command line functions are used by all toolkit programs. They are generic functions but we include them in a special section because they collectively co-operate to convert command line options and arguments into appropriate binary representations and provide concise but meaningful feedback when that is not possible.
-
- Show why a symbolic name was rejected by function lookup or similar functions. Argument type contains a title for the class of names stored in list. This function prints an error message on file stream fp showing the program name, the type string, the symbolic name and all names stored in the list. The _code_ structure is declared in types.h. The function is declared in symbol.h and defined in assist.c. Function expect is used to print list names.
-
- Return the unsigned integer equivalent of a numeric string. Print an error message on stderr and exit the program with status 1 if a syntax error occurs or the result exceeds the capacity of the requested integer size in bytes. If base is 0, numeric values may be expressed in decimal, hexadecimal or binary notation where hexadecimal values start with "0x" and binary values start with "0b". When base is non-zero, the notation in string must conform to the corresponding number base rules. Applications should cast the return value to the appropriate data type prevent loss-of-data compiler warnings. This function is typically used to convert and length-check integers entered as command line arguments. The function is declared in number.h and defined in basespec.c.
-
- Like function uintspec, this function both converts and range checks numeric string values, but the minimum and maximum value are implicit in the size of the integer. The minimum value is always 0 and the maximum value can be computed by ((1 << size << 3) - 1).
-
- Encode a memory region with the binary equivalent of a fixed-length hexadecimal string. Print an error message on stderr and exit the program with status 1 if a syntax error occurs or the number of octets does not equal extent. Hexadecimal octets may be separated by colons for readability but colons are not required. Empty octets are illegal. The function is declared in memory.h and defined in bytespec.c.
-
- This function is typically used to enter fixed-length data, like hardware addresses and encryption keys, on the command line.
-
- checkfilename
-
bool checkfilename(
filename);
char const * filename;
- Return logical true if the filename argument contains only letters, digits, slashes, periods, underscores and hyphens. This function can be used to detect cases where a user accidentally entered an Ethernet address in place of a filename on the command line. Ethernet address strings are, as it happens, also valid filenames. The function is declared in files.h and defined in checkfilename.c.
-
- Encode a memory region with the binary equivalent of a variable-length hexadecimal string. Print an error message on stderr and exit the program with the status 1 if a syntax error occurs or the number of octets exceeds extent. The number of octets may, however, be less than extent. Unlike function bytespec, hexadecimal octets may not be separated by colons. This function is typically used to enter variable-length data from the command line. The function is declared in memory.h and defined in dataspec.c.
-
- This function works like printf except that printed messages appear on stderr and are prefixed with the program name and error information. If argument errno is non-zero then messages are prefixed with the system error description. If argument exitcode is non-zero then function error exits the program with value exitcode after printing the message and does not return to the caller. The function is declared in error.h and defined in error.c.
-
- This function is used to print informative error messages on the console and prevent program execution from proceeding when input is invalid or some error condition exists.
-
- expect
-
void expect(
list,
size,
fp);
const struct _code_ list []; size_t size; FILE * fp;
- Display all names in argument list on file stream fp. This function is called by runction assist to print the list of symbolic names but other function may have use for it. The _code_ structure is declared in types.h. The function is declared in symbol.h and defined in expect.c.
-
- A custom version of the POSIX function getopt. It supports standard global variables optind, opterr, optopt and optarg and the non-standard variable optmin. It extracts the program name from argv[0] and sets global string pointer program_name for use by functions alert, error and others. Options -? and --help both display program information on stdout. Options -! and --version both display program version information on stdout. String vector optv includes both the standard argument optstring and usage text found in many programs. The function is declared in getoptv.h and defined in getoptv.c.
-
- ipv4spec
-
size_t ipv4spec(
string,
memory);
char const * string; void * memory;
- Encode a 4-byte memory region with an IPv4 dotted-decimal string and return the number of bytes encoded. Terminate the program with an error message and exitcode of 1 on conversion error. The value returned by this function is always 4 and memory is always encoded in network byte order. This function is typically used to convert IPv4 strings entered as command line arguments. The function is declared in memory.h and defined in ipv4spec.c.
-
- Dotted-decimal format consists of decimal values in the range 0 through 255. Each value represents one octet or 8-bit value. IPv4 addresses require 4 such values separated by one decimal point. This function permits empty octets and leading zeros within octets. For example, “...” is equivalent to “0.0.0.0” and “127.0.000.001” is equivalent to “127.0.0.1”. The second example will encode memory as follows { 0x7F, 0x00, 0x00, 0x01 } which is in network byte order, or big endian.
-
- ipv6spec
-
size_t ipv6spec(
string,
memory);
char const * string; void * memory;
- Encode a 16-byte memory region with an IPv6 colon-separated hexadecimal quartet string and return the number of bytes encoded. Terminate the program with an error message and exitcode of 1 on conversion error. The value returned by this function is always 16 and memory is always encoded in network byte order. This function is typically used to convert IPv6 strings entered as command line arguments. The function is declared in memory.h and defined in ipv6spec.c.
-
- Colon-separated hexadecimal quartet notation consists of hexadecimal values in the range 0 through FFFF. Each value represents a quartet or a 32-bit value. IPv6 addresses require 8 quartets separated by one colon. By convention, an empty quartet expands with enough zeros to right-justify the remainder of the address. This function permits multiple empty quartets and leading zeros within quartets. When multiple empty quartets appear, only the right-most occurance expands to zeros. For example, “AA12::BB34::CC56::DD78” is equivalent to “AA12:0000:BB34:0000:CC56:0000:0000:DD78” because only the right-most empty field expands. This will encode memory as follows { 0xAA, 0x12, 0x00, 0x00, 0xBB, 0x34, 0x00, 0x00, 0xCC, 0x56, 0x00, 0x00, 0x00, 0x00, 0xDD, 0x78 } which is in network byte order, or big-endian.
-
- Lookup a symbolic name in a list and return an associated integer or -1 if the name does not appear in the list. A typical use is the translation of symbolic command line arguments to integer codes. For example, some Toolkit programs assign symbolic names to field codes so that users can enter names instead of numbers. This approach becomes more useful as the number of permitted codes increases. The _code_ structure is declared in types.h. The function is declared in symbol.h and defined in lookup.c.
-
- This function offers two benefits: 1) multiple symbols can translate to one code and 2) names can be changed or new names added without affecting program logic. This function is similar to but different from function synonym which returns a character string instead of an integer.
-
- putoptv
-
void putoptv(
optv);
char const * optv [];
- Print program information on stdout. Program information is stored in string vector optv. String indexes are defined in file putoptv.h. String optv[0] is the POSIX standard argument optstring. This function is called by function getoptv whenever option -? or --help is detected on the command line. There is virtually no need to call this function directly. The function is declared in putoptv.h and defined in putoptv.c.
-
- Lookup a symbolic name in a list and return an associated string or the original string if the name does not appear in the list. A typical use is the translation of symbolic command line arguments to their equivalent numeric strings before encoding them. For example, many Toolkit programs convert the command line argument “local” to “00:B0:52:00:00:01” before encoding the device MAC address. The _term_ structure is declared in types.h. The function is declared in symbol.h and defined in synonym.c.
-
- This function is similar to but different from function lookup which returns an integer instead of a character string.
-
- Return the unsigned integer equivalent of a numeric string. Print an error message on stderr and exit the program with the value 1 when a syntax error occurs or the result exceeds the specified minimum or maximum value. Numeric values may be expressed in decimal, hexadecimal or binary notation where hexadecimal values start with "0x" and binary values start with "0b". Applications should cast the return value to the appropriate data type to avoid loss-of-data warnings on some compilers. This function is typically used to convert and range-check integer values entered as command-line arguments. The function is declared in number.h and defined in uintspec.c.
-
- version
-
void version(
);
- Print package and program version information on stdout. This function is called by function getoptv whenever option -! or --version is detected on the command line. There is no need to call this function directly. The function is declared in version.h and defined in version.c. Constants PACKAGE and VERSION define the information that is displayed. They are defined in file version.h and must be maintained by developers.
-
- The Open Powerline Toolkit supports raw Ethernet I/O on several popular operating systems, including Linux™, Mac OS X™ and Microsoft Windows™. Other operating systems will probably be added over time. These functions are found in the ether folder.
-
- Each operating system has a different raw Ethernet interface and so some abstraction was needed to support the toolkit for all environments. Our solution was the channel which is implemented like a FILE pointer but is used like a file descriptor. All toolkit programs, with a few exceptions, perform raw Ethernet I/O by opening a channel, reading and writing to it and then closing it.
-
- channel
-
- The channel structure contains enough information to perform raw Ethernet I/O in several common runtime environments; however, portions of the structure vary depending on the environment. These differences are appled by compile time constants that include required structure members and exclude others. The common structure members are identified and described below. The others elements are not discussed because they may change.
-
- Ethernet device index. The index only applies when the toolkit is compiled for LibPcap or WinPcap. This value is the same as that returned in the .ifr_ifindex member of the ifreq structure available on most operating systems.
-
- .ifname
-
- The interface name. On Linux, ethernet names are typically “eth0”, “eth1” and so on. On Mac OS X, interface names are “en0”, “en1” and so on. This string is the same as that returned by the ifr_ifname member of the ifreq structure available on most operating systems.
-
- .peer
-
- The Ethernet hardware address of some remote device. It is used to encode the ODA field of outgoing Ethernet frames and format some console messages. It is initialized to the Atheros Local Management Address, 00:B0:52:00:00:01 for HomePlug AV applications. Application programs can, and often do, replace this value at runtime.
-
- .host
-
- The Ethernet hardware address of the host computer. It is used to encode the OSA field of outgoing Ethernet frames and format some console messages. This address is initialized to the hardware address assigned to the interface by the host operating system. The value should not change.
-
- .type
-
- The Ethernet type/length field. It is used to encode the MTYPE field of outgoing Ethernet frames. The values is initialized to 0x88E1 for HomePlug AV application and 0x887B for HomePlug 1.0 application. The value should not change.
-
- .timeout
-
- A time interval. On Linux™ and Mac OS X™, it is the maximum time that the application will wait for a device to respond when a response is expected. With LibPcap™ and WinPcap™ it the mininum time the application will wait. It is initialized to 50 milliseconds which is a reasonable compromise but most toolkit programs allow the user to change this value.
-
- .flags
-
- A bitmap where each bit enables a special behavior during channel open or close or packet read or write. Of general interest is the CHANNEL_VERBOSE bit which prints outgoing and incoming frames on stderr in hexadecimal dump format. The verbose feature is implemented in for all toolkit programs that perform raw Ethernet I/O and is helpful when debugging device behavior.
-
- Since toolkit applications typically communicate with one powerline device at a time, this structure is statically initialized in a stand-alone module that is linked into each application. It is possible to dynamically initialize it, if needed. The structure is declared in channel.h and statically defined in channel.c.
-
- closechannel
-
signed closechannel(
channel);
struct channel * channel;
- Close the Ethernet socket associated with a channel and free associated memory and data structures. Return 0 on success. Return -1 on failure. This function is declared in channel.h and defined in closechannel.c.
-
- openchannel
-
signed openchannel(
channel,
protocol);
struct channel * channel; uint16_t protocol;
- Open an Ethernet socket that supports the specified protocol and associate it with the interface referenced by the channel structure .name member. Initialize the interface as needed. The protocol effectively filters incoming frames for the application.
-
- Interface initialization differs significantly from environment to environment. The socket descriptor is stored in the channel structure .fd member and the interface hardware address is stored in the channel structure .host member. Return 0 on success. Terminate the program with an error message on failure. This function is declared in channel.h and defined in openchannel.c.
-
- readpacket
-
signed readpacket(
channel,
packet,
length);
struct channel * channel; void * packet; signed length;
- Read one Ethernet frame from the specified channel. The frame is written into memory starting at address packet and is truncated to the specified length, if necessary. Return the actual number of bytes read on success. Return 0 on timeout. Return -1 on network error. This function behaves like the standard library read function. The target memory region remains unchanged on timeout or error. This function is declared in channel.h and defined in readpacket.c.
-
- On systems using Berkeley Packet Filters, such as MacOS X, the ODA field is automatically replaced on transmission to prevent Ethernet address spoofing. This may not be true on other systems but the practice is becoming more common.
-
- sendpacket
-
signed sendpacket(
channel,
packet,
length);
struct channel * channel; void * packet; signed length;
- Write one Ethernet frame to the specified channel. The frame is read from memory starting at address packet and ending at the specified length. Return the actual number of bytes sent on success. Return 0 on timeout. Return -1 on network error. The frame should be properly formatted as an ethernet frame and must be at least 60 bytes long or it will not be sent. This function behaves like the standard library write function. The source memory region is not modified. This function is declared in channel.h and defined in sendpacket.c.
-
- Search a channel for local powerline devices (bridges) and store their Ethernet hardware in consecutive memory locations. The memory extent is specified in bytes. The number of devices found is returned as the function value, provided enough space is available to store all addressed. Unlike function NetworkDevices, the channel peer address is ignored.
-
- We call local devices “bridges” because each serves as an Ethernet-to-Powerline bridge for the local host.
-
- The code segment shown above illustrates how to use function NetworkBridges to identify all local devices. We do not need to set the channelpeer because NetworkBridges always uses the Atheros localcast address. Array address is declared with two dimensions to simplify access to individual addresses on return.
-
- Query a powerline device, specified by channel, for neighboring network devices and store their Ethernet addresses in consecutive memory locations. The memory extent is specified in bytes. The number of devices found is returned as the function value, provided sufficient space is available to store all addresses. Unlike function NetworkBridges, the channelpeer address is identifies the device to be queried.
-
- The code segment shown above illustrates how to use function NetworkDevices to identify all devices on a specific network. You must set the channelpeer address before calling NetworkDevices. Array address is declared with two dimensions to simplify access to individual addresses on return. If the channelpeer address is not the Ethernet broadcast or Atheros localcast address then the first address returned will be the channelpeer address.
-
- The functions in this chapter are generic and may have application beyond the Open Powerline Toolkit. In some cases, these functions appear in other Atheros or Open Source software packages. In a few cases, the Toolkit may include complementary or supplementary support functions but only use one or two of them. For example, functions memincr and memdecr are both included but memdecr is not used.
-
- Print a memory region as a series of binary octets separated by character c and terminated by character e. Normally, character c will be BIN_EXTENDER, defined in file number.h, but it could be any character value. Normally, character e will be a space or newline, but it could be any character value. A typical use might be to print a register in readable format. For example, specifying c as '-', e as ';' and extent as 4 would produce output looking something like "10101010-1111111-00000000-11001100;" where each octet is expressed as a binary integer. The function is declared in memory.h and defined in binout.c.
-
- Return the 32 bit checksum of a memory region. The checksum is the one's complement of the XOR of all 32 bit words in the region. Argument extent is the region extent in 32 bit words. Argument checksum is the reference checksum. The function will return the computed checksum when referencechecksum is 0 and will return 0 if reference checksum equals the computed checksum. A typical use is to validate PIB and NVM files or compute new checksums when these files are created or modified. The function is declared in memory.h and defined in checksum32.c.
-
- This function is similar to checksum_32 but is used exclusively by API functions. It may be deprecated at some point in the future.
-
- Return the 32 bit checksum of a memory region. The checksum is the one's complement of the XOR of all 32 bit words in the region. The region extent is specified in bytes but it will be rounded down to the nearest multiple of 4 bytes. Argument checksum is the reference checksum. The function will return the computed checksum when referencechecksum is 0 and will return 0 if reference checksum equals the computed checksum. A typical use is to validate PIB and NVM files or compute new checksums when these files are created or modified. The function is declared in memory.h and defined in checksum_32.c.
-
- This function is similar to function checksum32 however there is no need to cast memory to uint32_t and there is no need to round extent down to a multiple of 4 bytes before calling the function because both operations are performed internally. Also, there is no unecessary endian manipulation of the checksum. It is the prefered method of computing a checksum.
-
- Print a memory region as a string of printable ASCII characters terminated by character e. Character c is printed in place of non-printable characters. The string is terminated by character e. Normally, character c is '.' but it could be any character value. Normally, character e is space or newline but it could be any charcter value. A typical use might be to print a memory region that may (or may not) contain an HFID or other printable text. The function is declared in memory.h and defined in chrout.c.
-
- Print a memory region as a series of decimal octets separated by character c and terminated by character e. Normally, character c will be DEC_EXTENDER, defined in file number.h, but it could be any character value. Normally, character e will be a space or newline but it could be any character value. A typical use might be to print an IP address in readable format. For example, specifying c as '.', character e as '/' and extent as 4 would produce output looking something like "192.168.099.001/" where each octet is expressed as a decimal integer. The function is declared in memory.h and defined in decout.c.
-
- endian
-
void endian(
memory,
extent);
void * memory; size_t extent;
- Reverse the byte order of a memory region. It is a variable extent version of functions like __bswap_16, __bswap_32 and __bswap_64. The function is declared in memory.h and defined in endian.c.
-
- fdchecksum32
-
unit32_t fdchecksum32(
fd,
extent,
checksum);
int fd; size_t extent; unit32_t checksum;
- Return the 32 bit checksum of a file region starting from the current file position. The checksum is the one's complement of the XOR or of all 32 bit words in the region. Argument extent must be specified in 32 bit words, not bytes. Argument checksum is the reference checksum. The function will return the computed checksum when referencechecksum is 0 and will return 0 if reference checksum equals the computed checksum. A typical use is to validate NVM files header by header or section by section. The function is declared in memory.h and defined in fdchecksum32.c.
-
- fdchecksum_32
-
unit32_t fdchecksum_32(
fd,
extent,
checksum);
int fd; size_t extent; unit32_t checksum;
- Return the 32 bit checksum of a file region starting from the current file position. The checksum is the one's complement of the XOR or of all 32 bit words in the region. Argument extent is specified in bytes but is rounded down to the nearest multiple of 4 bytes. Argument checksum is the reference checksum. The function will return the computed checksum when referencechecksum is 0 and will return 0 if reference checksum equals the computed checksum. A typical use is to validate NVM files header by header or section by section. The function is declared in memory.h and defined in fdchecksum_32.c.
-
- This function is similar to function fdchecksum32 but there is no need to round extent down to the nearest multiple of 4 bytes before calling the function because that is done internally. Also, there is no unecessary endian manuipulation of the checksum.
-
- filepart
-
char const * filepart(
pathname);
char const * pathname;
- Return the address of the filename portion of a pathname string. The filename portion is everything after the rightmost path separator. If a path separator is not present then the address of the pathname string is returned. This function is similar to the POSIX basename function but it returns an empty string whenever the rightmost character is a path separator. The path separator can be either slash ('/') or backslash ('\\'). The function is declared in files.h and defined in filepart.c.
-
- Decode a memory region as a string of ASCII hexadecimal digits. Convert memory until the buffer or memory exhausts and return the string extent. Allow three (3) string characters for each memory byte to be decoded. The number of bytes decoded will be the lesser of argument extent divided by 3 or argument extent. The function is declared in memory.h and defined in hexdecode.c.
-
- Print a full or partial memory region in hexadecimal format showing memory offsets, hexadecimal byte values and ASCII character values. Argument memory contains some memory region. Argument extent is the region extent. Argument offset is the starting display location. Locations memory [offset] up to memory [extent] are displayed, allowing a partial dump of the memory region. An offset of 0 will display the entire region. The function is declared in memory.h and defined in hexdump.c.
-
- This function is similar to but different from function hexview .
-
- Encode a memory region with the binary equivalent of an ASCII hexadecimal string. Return the number of bytes encoded or 0 on error. The value of errno is set to EINVAL if the number of bytes encoded is less than extent or the entire string cannot be converted due to illegal digits or excessive digits. Ignore optional HEX_EXTENDER characters separating octets in argument string. Constant HEX_EXTENDER is defined in file number.h. The function is declared in memory.h and defined in hexencode.c.
-
- hexin
-
ssize_t hexin(
memory,
extent,
fp);
void const * memory; size_t extent; FILE * fp;
- This function is similar to hexencode but it reads from file, instead of a string and ignores non-hexadecimal text and comments within the input stream. Incoming text is binary encoded and written to the specified memory region. The actual number of bytes encoded is returned or -1 on error. See the efsu man page for a thorough explanation of function behavior. The function is declared in memory.h and defined in hexin.c.
-
- Print a memory region as a series of hexdecimal octets separated by character c and termianted by character e. Normally, character c will be HEX_EXTENDER, defined in file number.h, but it could be any character value. Normally, character e will be a space or newline but it could be any character value. A typical use might be to print a MAC or Ethernet address in readable format. For example, specifying c as ':', character e as ',' and extent as 6 would produce output looking something like "00:B0:52:DA:DA:01," where each octet is expressed as a hexadecimal integer. The function is declared in memory.h and defined in hexout.c.
-
- Convert a memory region to a NUL terminated string and return the string address. This function is identical to function hexdecode but it return the string address instead of the number of characters decoded. The function is declared in memory.h and defined in hexstring.c.
-
- Print a partial memory region in hexadecimal format showing memory offsets, hexadecimal byte values and ASCII character values. Argument memory contains part of a larger memory region, much like a file window. Argument extent is the window length. Argument offset is the relative offset of the window within the region. Locations memory [0] up to but excluding memory [extent] are displayed as a partial dump, providing a window into the region. The function is declared in memory.h and defined in hexview.c.
- This function is similar to but different from function hexdump.
-
- memdecr
-
signed memdecr(
memory,
extent);
void * memory; size_t extent;
- Decrement a multi-byte memory region. Return 0 on success or -1 if all bytes have decremented to 0x00. For example, { 0xFF, 0xFF, 0xFF } decrements to { 0xFF, 0xFF, 0xFE } and { 0xFF, 0x00, 0x00 } decrements to { 0xFE, 0xFF, 0xFF }. A typical use is to iterate through a range if IP or MAC address values. The function is declared in memory.h and defined in memdecr.c.
-
- memincr
-
signed memincr(
memory,
extent);
void * memory; size_t extent;
- Increment a multi-byte memory region. Return 0 on success or -1 once all bytes have been incremented to 0xFF. For example { 0x00, 0x00, 0x00 } increments to { 0x00, 0x00, 0x01 } and { 0x00, 0xFF, 0xFF } increments to { 0x01, 0x00, 0x00 }. A typical use is to iterate through a range of IP or MAC address values. The function is declared in memory.h and defined in memincr.c.
-
- Print a memory region as a series of octet groups wach separated by character c. The group argument specifies the number of octets per group. The format argument determines how each octet is displayed. Normally, character c will be one of BIN_EXTENDER, DEC_EXTENDER or HEX_EXTENDER as defined in file number.h, but it could be any character value. The function is declared in memory.h and defined in memout.c.
-
- memswap
-
void memswap(
buffer1,
buffer2,
length);
void * buffer1; void * buffer2; size_t length;
- Exchange the contents of one buffer with that of another. No provision is made for buffer overlap. No value is returned. A typical use might be to exchange source and destination addresses in an ethernet packet. The function is declared in memory.h and defined in memswap.c.
-
- strdecr
-
signed strdecr(
memory,
extent,
min,
max);
void * memory; size_t extent; byte min; byte max;
- Decrement a multi-byte memory region using only ASCII character values in the range min through max. Return 0 on success or -1 once all characters have been decremented to the value of argument min. For example, if argument min is 'A' and argument max is 'Z' then { 'A', 'B', 'C' } decrements to { 'A', 'B', 'B' } and { 'B', 'Z', 'Z' } decrements to { 'A', 'A', 'A' }. A typical use is to generate a sequence of distinct character strings to seed encryption key functions. The function is declared in memory.h and defined in strdecr.c.
-
- Encode a buffer with an enumerated list of the operands associated with the corresponding bits in flagword. separate enumerated operands with an operator string. For example, given char const *operands [] = { "loop", "wait", "busy" } and unsigned flagword = 0x05 then strfbits (buffer, length, operands, "|", flagword) would encode buffer with "loop|busy". Observe that each bit set in flagword appears in buffer as the corresponding string from operands. A typical application for this function is the enumeration of flagword states. The function is declared in format.h and defined in strfbits.c.
-
- strincr
-
signed strincr(
memory,
extent,
min,
max);
void * memory; size_t extent; byte min; byte max;
- Increment a multi-byte memory region using only ASCII character values in the range min through max. Return 0 on success or -1 once all characters have been incremented to the value of argument max. For example, if argument min is 'A' and argument max is 'Z' then { 'A', 'B', 'C' } increments to { 'A', 'B', 'D' } and { 'A', 'Z', 'Z' } increments to { 'B', 'A', 'A' }. A typical use is to generate a sequence of distinct character strings to seed encryption key functions. The function is declared in memory.h and defined in strincr.c.
-
- todigit
-
unsigned todigit(
c);
unsigned c;
- Return the integer value of character c interpreted as digit in the base 36 number system. It is called by many encode functions to support number base conversion. If the value of c is '0' through '9' then integer 0 through 9 is returned. If the value of c is 'A' through 'Z' or 'a' through 'z' then integer 10 through 35 is returned. The function is declared in number.h and defined in todigit.c.
-
- Return the name associated with a message type by searching a list arranged in ascending order by message type. Return argument name as the function value if the message type is not present in the list. Data types struct _type_ and type_t are defined in file types.h. A typical use might be to return the name of message based on the message type. The function is declared in symbol.h and defined in typename.c.
-
- Message debug functions are not needed for proper toolkit operation but they can be useful during development, debugging and testing phases of product development. They are specific to HomePlug AV messages only.
-
- MMECode
-
char const * MMECode(
MMTYPE,
MSTATUS);
uint16_t MMTYPE; uint8_t MSTATUS;
- Return text that explains the status code for a given Atheros vendor-specific management message. Argument MMTYPE is an unsigned integer in the range 0xA000 through 0xAFFF and must exactly match the MMTYPE of the message returning the status code. For example, the CNF variant of a message is currently the only variant that has an MSTATUS field and so other variants return a default string. The function is declared in mme.h and defined in MMECode.c.
-
- Inclusion of this function can increase application size by 3kb because the text associated with all Atheros vendor-specific management messages and errors are included whether needed or not. Conditional compilation statements are provided internally to suppress the full table with a terse substitute.
-
- Although the Bootloader and firmware share some common Vendor Specific Management Messages, the two programs may return different codes for a given message and error condition. Where there are conflicts, Bootloader codes take precedence over firmware codes because it is unlikely that users will .issue the same messages to a device running firmware.
-
- MMEMode
-
char const * MMEMode(
MMTYPE);
uint16_t MMTYPE;
- Return the mode of a given management message type as a string. The mode is determined by the two least significant bits of argument MMTYPE. The mode string will be one of “REQ”, “CNF”, “IND” or “RSP”. The function is declared in ihp.h and defined in MMEMode.c.
-
- Most management messages have a request and a confirmation variant while a few have an indication and a response variant. Requests originate from the host and are acknolwedged by a confirmation from the device. Indications originate from a device and are acknowledged by a response from the host.
-
- MMEName
-
char const * MMEName(
MMTYPE);
uint16_t MMTYPE;
- Return the name associated with a given management message type. The name is the mnemonic used to distinguish one message type from another in the HomePlug AV Specification or Atheros Firwmare Technical Reference Manual. Argument MMTYPE is an unsigned integer in the range 0x0000 through 0xAFFF. The request, confirmation, indication and response variants of a management message will all return the same message name. The function is declared in mme.h and defined in MMEName.c.
-
- MMEPeek
-
void MMEPeek(
memory,
extent,
fp);
void const * memory; size_t extent; FILE *fp;
- Prints an Atheros vendor-specific management message to stream fp in human readable format. Argument buffer is the message address and argument extent is the message extent in bytes. Output consists of a formatted header showing decoded header. The function is declared in mme.h and defined in MMEPeek.c.
-
- Atheros applications use the SHA256 algorithm to compute unique HomePlug AV keys, including the Device Access Key (DAK), Network Membership Key (NMK) and Network Identifier (NID). The SHA256 algorithm is seeded, salted and rehashed differently for each type of HomePlug AV key. A different function is used to compute each type of HomePlug AV key but all of them call the SHA256 functions. The SHA256 algorithm returns a 256 bit (32 byte) digest but only the upper 128 bits (16 bytes) are used for HomePlug AV keys.
-
Example 7.3.
- SHA256 Digest Computation
-
- The following code example illustrates how to generate, rehash and print an SHA256 digest, or key, from a user-defined seed string and salt string. This logic is typical of that used to generate HomePlug AV compliant keys. See the HomePlug AV Specification for the specific rules used to generate each type of key.
-
- Above, we declare struct sha256 and initialize it using function SHA256Reset. We then write a user-defined seed string (or password) followed by an optional salt string to the digest using function SHA256Write. The resulting digest (or key) is obtained by calling function SHA256Fetch. Constant SHA256_DIGEST_SIZE is defined in SHA256.h. Although the digest is probably secure enough at this point, we rehash it 999 times for good measure. We then print the first 16 bytes of the result because HomePlug AV keys are always 16 bytes long.
-
- Print a range of device addresses and user passwords on stdout. The calling application must split the starting device address into a three-byte OUI and three-byte device number and pass them as the unsigned 32-bit integers vendor and device, respectively. Argument device is the first device number in the range and number is the final device number. Argument count is the number of uppercase letters comprising a password. Passwords contain this many letters but the letters are grouped for easy reading. Letter groups are separated by hyphens. Argument bunch defines how many letters form each group. Argument space is the character used to separate groups of letters. Argument flags enables or disables function features such as insertion of a “used” flag for use by the Atheros Production Test System or the omission of the device address on output. The output of this function is similar to that produced by the DB Builder utility distributed with the PTS. This function is declared in keys.h and defined in MACPasswords.c.
- HPAVKeyDAK
-
void HPAVKeyDAK(
DAK,
string);
byte DAK []; char const string;
- Encode buffer DAK with the Device Access Key (DAK) derived from the NUL terminated string. The string is salted, hashed and re-hashed using the SHA256 algorithm. The DAK is always HPAVKEY_DAK_LEN bytes, defined in HPAVKey.h, so no length argument is needed. See the HomePlug AV Specification for more information. This function is declared in HPAVKey.h and defined in HPAVKeyDAK.c.
-
- HPAVKeyNMK
-
void HPAVKeyNMK(
digest,
string);
byte digest []; char const string;
- Encode buffer NMK with the Network Membership Key (NMK) derived from the NUL terminated string. The string is salted, hashed and re-hashed using the SHA256 algorithm. The DAK is always HPAVKEY_NMK_LEN bytes, as defined in HPAVKey.h, so no length argument is needed. See the HomePlug AV Specification for more information. This function is declared in HPAVKey.h and defined in HPAVKeyNMK.c.
-
- HPAVKeyNID
-
void HPAVKeyNID(
NID,
NMK,
level);
byte NID []; byte const NMK []; signed level;
- Encode buffer NID with the Network Identification Key (NID) derived from the 16-byte Network Membership Key (NMK). The NMK is hashed and re-hashed using the SHA256 algorithm then encoded with the security level. The NID is always HPAVKEY_NID_LEN bytes, as defined in HPAVKey.h, so no length argument is needed. See the HomePlug AV Specification for more information. This function is declared in HPAVKey.h and defined in HPAVKeyNID.c.
-
- Decode and print up to length bytes from buffer digest on stdout. Print NUL terminated phrase on the same line following the digest when bit HPAVKEY_VERBOSE, defined in HPAVKey.h, is set in flags. This procedure prints keys and phrases in a standard column-oriented format that other applications can easily read and use. This function is declared in HPAVKey.h and defined in HPAVKeyOut.c.
-
- SHA256Block
-
void SHA256Block(
sha256,
memory);
struct sha256 * sha256; void const * memory;
- Merge 64 bytes of memory into the current SHA256 digest. This function performs the core computations required by the SHA256 algoithm. It is called by function SHA256Fetch and so there is no reason to call this function directly. The sha256 structure is defined in SHA256.h. The function is declared in SHA256.h and defined in SHA256Block.c.
-
- SHA256Fetch
-
void SHA256Fetch(
sha256,
digest);
struct sha256 * sha256; byte digest [];
- Conclude SHA256 computation and transfer the result to the named 32-byte digest then flush the sha256 structure. The digest is always 32 bytes long regardless of the amount of information that has been written using function SHA256Write. The sha256 structure is defined in SHA256.h. This function is declared in SHA256.h and defined in SHA256Fetch.c.
-
- Once this function is called, the sha256 structure is purged for security reasons. You must call SHA256Reset again before starting another hash or subsequent calls to this function or SHA256Write will have unpredictable results. .
-
- SHA256Ident
-
void SHA256Ident(
fd,
digest);
int fd; byte digest [];
- Compute the SHA256 digest from the content of a file. The digest serves as the file “fingerprint” and can be used to identify identical content despite filename changes. File descriptor fd is the subject file which must be positioned to the start befor calling this function. Buffer digest will be written with the computed 256-digest and must be SHA256_DIGEST_SIZE bytes long, as defined in SHA256.h. This function is declared in SHA256.h and defined in SHA256Ident.c.
-
- SHA256Match
-
void SHA256Match(
fd,
digest);
int fd; byte const digest [];
- Search a registry file for a known SHA256 digest. Return true on success or false on failure. File descriptor fd is the registry file which must be positioned to the start before calling this function. Buffer digest contains the known 256-bit digest and must be SHA256_DIGEST_SIZE bytes long, as defined in SHA256.h. A registry file consists of 64-digit hexadecimal strings that represent SHA256 digest values. Optional text may be appear between the digest and newline to document digest significance. This function ignores such text. This function is declared in SHA256.h and defined in SHA256Match.c.
-
- SHA256Print
-
void SHA256Print(
digest,
string);
byte const digest []; char const * string;
- Print an SHA256 digest and optional string on stdout. Buffer digest must be SHA256_DIGEST_SIZE bytes long, as defined in SHA256.h, which results in 64 hexadecimal digits on output. Variable length string is NUL terminated but may be NULL. If string is not NULL and is not empty then a space is inserted between the digest and the string on output. This function may be used to print SHA256 digests and optional strings in standard format, such as a registry file. This function is declared in SHA256.h and defined in SHA256Print.c.
-
- SHA256Reset
-
void SHA256Reset(
sha256);
struct sha256 * sha256;
- Initialize a sha256 structure before computing a new SHA256 digest. This function should be called once before calling SHA256Write for the first time for a given digest. The sha256 structure is defined in SHA256.h. This function is declared in SHA256.h and defined in SHA256Reset.c.
-
- Writes a region of memory to the current SHA256 digest contained in an sha256 structure. An application may call this function any number of times to concatinate multiple memory regions before fetching the digest with function SHA256Fetch. The sha256 structure is defined in SHA256.h. This function is declared in SHA256.h and defined in SHA256Write.c.
-
- Atheros provides support for remote PIB management using XML instruction files. The concept is based on an XML schema that defines the elements and attributes needed to edit a PIB file. The schema is located in file piboffset.xsd. In practice, this schema could be used to edit any buffer containing data but we are only interested in editing PIB files here.
-
- Users may create XML files that conform to the schema and specify the PIB objects they want to change and how they want each to change. In brief, the files specify an offset, a data length and a data value. A data value has type dataString, dataHex or dataByte and may be a single data item or an array of data items. Each XML file should include a reference to the Atheros schema and be submitted to a validating XML parser, such as Internet Explorer or Firefox, to ensure that file structure and syntax are correct before use. An example XML file can be seen in piboffset.xml.
-
- Editing involves the following steps. An example of these steps can be seen in the pxe program source code and in function RdModWrPib2.c which is a component of the int6k2 program.
-
- Obtain a copy of the PIB to be edited. This can be done by opening a PIB file and reading the entire file into memory or by requesting the PIB directly from an active Atheros powerline device. The PIB length can be determined from the PIB header.
-
- Open the XML file, generate an XML parse tree and close the file. This can be done by passing the filename to function xmlopen. It will perform all these steps and return the parse tree root node.
-
- Modify the PIB based to instructions stored in the parse tree. This is done by passing the parse tree, PIB buffer and PIB length to function xmledit. It will traverse the parse tree and apply changes to the buffer as defined in the parse tree.
-
- Discard the parse tree. This can be done by passing the parse tree to function xmlfree.
-
- Compute a new PIB checksum. This can be done by clearing the PIB checksum then passing the PIB buffer and PIB length to function checksum32 with a checksum value of 0.
-
- Write the PIB to file or transmit it over the network to an Atheros powerline device.
-
- Write data into memory based on the data offset and length defined in XML parse tree, node. This function will not apply modifications having malformed structure or having an invalid or illegal offset, length or data value. Use function xmlschema to print the current schema. The function is declared in node.h and defined in xmledit.c. The node structure is defined in node.h.
-
- xmlfree
-
void xmlfree(
node);
struct node * node;
- Release memory associated with an XML parse tree. The function is declared in node.h and defined in xmlfree.c. The node structure is defined in node.h.
-
- The text member if the parse tree root node points to memory allocated by xmlscan to store the original XML string. The application must either deallocate that memory before calling this function or store the text address and deallocate that memory after calling this function; otherwise, memory leaks will result.
-
- xmlnode
-
struct node *xmlnode(
node);
struct node *node;
- Create an empty node blow the specified node and return a pointer to it. A typical application can be seen in function xmlscan.c. The function is declared in node.h and defined in xmlnode.c. The node structure is defined in node.h.
-
- xmlopen
-
struct node * xmlopen(
filename);
char const * filename;
- Open the named XML file, parse it and return the XML parse tree. The parse tree contains, among other things, all XML elements, attributes and values specified in the file. The function is declared in node.h and defined in xmlopen.c. The node structure is defined in node.h.
-
- The returned parse tree is ready to traverse using struct node members above, below, prior and after. Each node has a line, type and test member. This function calls function xmlscan to parse the file and generate the tree. The parse tree can be inspected by passing the root node to function xmltree.
-
- xmlscan
-
signed xmlscan (
node);
struct node * node;
- Scan the XML string attached to the specified node and create a parse tree below it. Return 0 if parsing is successrul or -1 if not. The function is declared in node.h and defined in xmlscan.c. The node structure is defined in node.h.
-
- The application must point the text member to a copy of the XML string before calling this function because parsing is destructive and requires write access to the string. The application can search and manipulate the tree on return. The application should deallocate string memory before calling xmlfree.
-
Example 7.4.
- XML Source File
-
- The following is sample input to function xmlscan. The element and attribute names shown are for illustration and were selected to that they can be easily identified in the output. The parse tree from this file can be seen in the example for function xmltree.
-
-<?xml version="1.0" encoding="UTF-8" ?>
-<xmlfile
- xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:noNamespaceSchemaLocation="myschema.xsd">
- <element name="Element1">
- <attribute name="Attribute1">
- 1234567890
- </attribute>
- <attribute name="Attribute2">
- The quick brown fox jumped over the lazy dog.
- </attribute>
- </element>
- <element name="Element2">
- <attribute name="Attribute1">
- </attribute>
- <attribute name="Attribute2">
- The quick brown
- fox jumped over
- the lazy dog.
- </attribute>
- </element>
-<!-- comments can go anywhere -->
- <element name="Element2">
- <attribute name="Attribute1"/>
- <attribute name="Attribute2">
- value2
- </attribute>
- </element>
- </xmlfile>
-
- xmlschema
-
void xmlschema(
);
;
- Print an XML schema that supports function xmledit on stdout. This function has no argument. The schema produced by this function is guaranteed to support the parse logic implemented by function xmledit. Scheme element names are defined as constants in node.h so that they can be referenced by applications that create their own XML edit instructions. The function is declared in node.h and defined in xmlschema.c.
-
- The text member in the parse tree root node points to memory allocated by xmlscan to store the original XML string. The application must either deallocate that memory before calling this function or store the text address and deallocate that memory after calling this function; otherwise, memory leaks will result.
-
- The schema shown above was produced by function xmlschema. It is should be used to validate XML edit instructions before submitting them to program pxe.
-
- xmltree
-
void xmltree(
node);
struct node * node;
- Print the XML parse tree on stdout. The function is declared in node.h and defined in xmltree.c.
-
Example 7.6.
- XML Parse Tree
-
- The following is sample output from function xmltree. The XML source is shown in the example for function xmlscan . The numbers appearing down the left margin indicate the input line number from the XML source file parsed by function xmlscan . The character codes indicate the node type and are defined in node.h. The node structure is defined in node.h.
-
- Download function write applets, parameters and runtime firmware to device SDRAM or NVRAM.
-
- WriteExecuteApplet
-
signed WriteExecuteApplet(
plc,
header);
struct plc * plc; void const * header;
- Write an NVM image directly into SDRAM using VS_WRITE_AND_EXECUTE messages. This function calls either WriteExecuteApplet1 or WriteExecuteApplet2 based on the NVM header version. The function is declared in plc.h and defined in WriteExecuteApplet.c. The plc structure is defined in plc.h.
-
- WriteExecuteApplet1
-
signed WriteExecuteApplet1(
plc,
header);
struct plc * plc; struct nvm_header1 * header;
- Write an NVM image directly into SDRAM using VS_WRITE_AND_EXECUTE messages. This function is similar to WriteExecuteApplet2 but expects a structure nvm_header1 pointer instead of a structure nvm_header2 pointer. The function is declared in plc.h and defined in WriteExecuteApplet.c. Structure plc is defined in file plc.h. Structure nvm_header1 is defined in file nvm.h.
-
- WriteExecuteApplet2
-
signed WriteExecuteApplet2(
plc,
header);
struct plc * plc; struct nvm_header2 * header;
- Write an NVM image directly into SDRAM using VS_WRITE_AND_EXECUTE messages. This function is similar to WriteExecuteApplet1 but expects a structure nvm_header2 pointer instead of a structure nvm_header1 pointer. The function is declared in plc.h and defined in WriteExecuteApplet.c. Structure plc is defined in file plc.h. Structure nvm_header1 is defined in file nvm.h.
-
- Procrastinations functions wait for specific events to occur or fail to occur.
-
- WaitForAssoc
-
signed WaitForAssoc(
plc);
struct plc * plc;
- Poll a powerline device using VS_NW_INFO messages until the device forms or joins a network. The host ethernet interface, destination hardware address and source hardware address are specified in structure plc. It calls either WaitForAssoc1 or WaitForAssoc2 to procrastinate based on the hardwareID member of structure plc. The function is declared in plc.h and defined in file WaitForAssoc.c. Struct plc is declared in file plc.h and defined in file plc.c.
-
- WaitForAssoc1
-
signed WaitForAssoc1(
plc);
struct plc * plc;
- Poll a 200mbs powerline device using VS_NW_INFO version 0 messages until the device joins or forms a network. The host ethernet interface, destination hardware address and source hardware address are specified in structure plc. The function is declared in file plc.h and defined in file WaitForAssoc1.c. Struct plc is declared in file plc.h and defined in file plc.c.
-
- WaitForAssoc2
-
signed WaitForAssoc2(
plc);
struct plc * plc;
- Poll a 1000mbs powerline device using VS_NW_INFO version 1 messages until the device joins or forms a network. The host ethernet interface, destination hardware address and source hardware address are specified in structure plc. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in file plc.h and defined in file WaitForAssoc2.c.
-
- WaitForReset
-
signed WaitForReset(
plc);
struct plc * plc;
- Poll a powerline device using VS_SW_VER messages until the device stops responding. The host ethernet interface, destination hardware address and source hardware address are specified in structure plc. Structure plc is declared in file plc.h and define in file plc.c. The function is declared in plc.h and defined in file WaitForReset.c.
-
- WaitForStart
-
signed WaitForStart(
plc,
firmware,
length);
struct plc * plc; char firmware; size_t length;
- Poll a powerline device using VS_SW_VER messages until the device responds. The host ethernet interface, destination hardware address and source hardware address are specified in structure plc. Update the hardwareID member of the plc structure. Return the firmware revision string contained in the confirmation message. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in file plc.h and defined in file WaitForStart.c.
-
- Traffic functions generate powerline traffic in various ways. Some send traffic direct from the host to each device while others use the VS_FR_LBK message to echo Ethernet frames back to the sender.
-
- CrossTraffic1
-
signed CrossTraffic1(
plc);
struct plc * plc;
- Instruct a powerline device to send a generic Ethernet frame to another powerline device for a fixed period of time in order to set the TX rate on the source device and the RX rate on the destination device. The source and destination address are specified in plc->MAC and plc->RDA, respectively, and the duration is specified in plc->timeperiod. This function is similar to function CrossTraffic2 but the source and destination addresses are reversed. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file CrossTraffic1.c.
-
- CrossTraffic2
-
signed CrossTraffic2(
plc);
struct plc * plc;
- Instruct a powerline device to send a generic Ethernet frame to another powerline device for a fixed period of time in order to set the TX rate on the source device and the RX rate on the destination device. The source and destination address are specified in plc->RDA and plc->MAC, respectively, and the duration is specified in plc->timeperiod. This function is similar to function CrossTraffic1 but the source and destination addresses are reversed. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file CrossTraffic2.c.
-
- LocalTraffic1
-
signed LocalTraffic1(
plc);
struct plc * plc;
- Send a fixed number of generic frames from the local host a remote powerline device in order to set the TX rate on the local powerline device and the RX rate on the remote powerline device. The local and remote device address are specified in plc->MAC and plc->RDA, respectively, and the count is specified in plc->count. This function is similar to function LocalTraffic2 which instructs a remote device to echo frames back to the local device. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file LocalTraffic1.c.
-
- LocalTraffic2
-
signed LocalTraffic2(
plc);
struct plc * plc;
- Instruct a remote powerline device to echo generic Ethernet frames back to the local host for a fixed period of time in order to set the TX rate on the remote powerline device and the RX rate on the local powerline device. The local and remote device address are specified in plc->MAC and plc->RDA, respectively, and the count is specified in plc->count. This function is useful when there is no easy way to send traffic from the remote host. This function complements function LocalTraffic1 which send frames from the local device to a remote device. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file LocalTraffic2.c.
-
- NetworkTraffic1
-
signed NetworkTraffic1(
plc);
struct plc * plc;
- This function is an alternative to function NetworkTraffic2 which uses Qualcomm Version 1 management messages to determine network topology. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file NetworkTraffic1.c.
-
- This function use VS_SW_INFO and VS_NW_INFO messages to discover powerline network topology then calls functions LocalTraffic1 and LocalTraffic2 to generate traffic between the local powerline device and each remote powerline device. Unlike function NetworkTraffic1, it does not generate traffic between various remote devices.
-
- NetworkTraffic2
-
signed NetworkTraffic2(
plc);
struct plc * plc;
- This function is an alternative to function NetworkTraffic1 which uses Qualcomm Version 0 management messages to determine network topology. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file NetworkTraffic2.c.
-
- Traffic1
-
signed Traffic1(
plc);
struct plc * plc;
- This function is an alternative to function Traffic2 which uses Qualcomm Version 1 management messages to determine network topology. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file Traffic1.c.
-
- This function use VS_SW_INFO and VS_NW_INFO messages to discover powerline network topology then calls functions LocalTraffic1 and LocalTraffic2 to generate traffic between the local powerline device and each remote powerline device. Unlike function NetworkTraffic1, it does not generate traffic between remote devices.
-
- Traffic2
-
signed Traffic2(
plc);
struct plc * plc;
- This function is an alternative to function Traffic1 which uses Qualcomm Version 0 management messages to determine network topology. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file Traffic2.c.
-
- This function use VS_SW_INFO and VS_NW_INFO messages to discover powerline network topology then calls functions LocalTraffic1 and LocalTraffic2 to generate traffic between the local powerline device and each remote powerline device. Unlike function NetworkTraffic2, it does not generate traffic between remote devices.
-
- The functions described in this chapter implement SLAC protocol building blocks. Essentially, there is one function for each dataflow shown on the SLAC interface diagram. The implementations are not sophisticated. Customers must adapt them their own run-time environments.
-
- To assist in adapting functions fo various environments, SLAC functions all accept three arguments. The first is a session variable that references information that supports a single PEV-EVSE SLAC interaction. The second is a channel variable that references information that supports ISO Layer 2 network communications. The third is a message variable that references an IEEE 802.3 frame buffer used to format, transmit, receive and interpret SLAC messages. Applications may create lists, stacks, queues or heaps of session variables to support multiple PEV-EVSE conversations. That has not been done here but may be done in the future.
-
- PEV-HLE determines the application type and security type and stores them in the session variable before attempting a new SLAC session. PEV-HLE also generates and stores the run identifier in the session variable before attempting a new SLAC session. The run identifier is included in messages so that the EVSE-HLE can distinguish frames from different PEV-HLEs when transmitted in broadcast.
-
- The Session Variable
-
- The session variable is a structure defined in slac.h. It stores the information needed to manage a single SLAC protocol session between PEV-HLE and EVSE-HLE. It is necessary because there are cases where multiple PEV-HLE attempt to communicate with one EVSE-HLE or vice verse and each communication involves multiple steps and some steps will fail or be abandoned.
-
- session.RunID
-
-A session identifier used to support multiple PEV-EVSE sessions.
-The PEV-HLE defines a new value with each associateion attempt and broadcasts it to EVSE-HLE in CM_SLAC_PARAM.REQRunID.
-EVSE-HLE receive it and store it in their session variable.
-Once association starts, subsequent messages, in both directions, include this identifier so that PEV-HLE and EVSE-HLE can detect and collate messages from the same conversation.
-
- session.APPLICATION_TYPE
-
-Indicates the context in which the SLAC process is being carried out.
-Currently, the only context is PEV-EVSE association.
-The PEV-HLE sends this value to the EVSE-HLE in EVSE-HLE in CM_SLAC_PARAM.REQ message APPLICATION_TYPE field.
-EVSE-HLE receive it and store it in their session variable.
-
- session.SECURITY_TYPE
-
-Indicates that the sender prefers Secure SLAC for PEV-EVSE matching.
-Currently, the only value used in SLAC demonstration software is 0 for “No Security”.
-The PEV-HLE defines this value as 0 on startup and broadcasts it to EVSE-HLE in in CM_SLAC_PARAM.REQ message SECURITY_TYPE field.
-EVSE-HLE receive it and store it in their session variable for later use when sending SLAC messages.
-
- session.RESP_TYPE
-
-The EVSE-HLE defines this value and sends it to the PEV-HLE in CM_SLAC_PARAM.CNF message RESP_TYPE field.
-THe default is 0 but this can be changed using “response type =” in profile evse.ini.
-
- session.NUM_SOUNDS
-
-The number of CM_MNBC_SOUND.IND messages that the PEV-HLE should send during sounding.
-The EVSE-HLE defines this value and sends it to PEV-HLE in CM_SLAC_PARAM.CNF message NUM_SOUNDS field.
-The default is 10 but this can be changed using “time to soundi =” in profile evse.ini.
-
- session.TIME_OUT
-
-The total time allowed for all session sounding to complete.
-Any msounds arriving after the timeout will be lost.
-The time is expressed in 100 msec increments.
-The EVSE-HLE defines this value and sends it to PEV_HLE in CM_SLAC_PARAM.CNF.
-The default is 8 but this can be changed using “number of sounds =” in profile evse.ini.
-
- session.AAG []
-
-The cumulative average attenuation across 58 groups of 16 carriers.
-The EVSE-HLE computes these averages from multiple CM_ATTEN_PROFILE.IND and forwards them to PEV-HLE in CM_ATTEN_CHAR.IND.
-PEV_HLE populates array from CM_ATTEN_CHAR.IND message ACVarField.ATTEN_PROFILE.AAG field and evaluates it by averaging all values in the array to determine the overall average attenuation.
-If that values is less than or equal to session.limit then a match may be attempted.
-
- session.NumGroups
-
-The number of elements in array session.AAG.
-This EVSE-HLE defines this number and sends it to PEV-HLE in CM_ATTEN_CHAR.INDACVarField.NumGroups.
-For practical purposes, this value of this variable is constant at 58.
-
- session.MSOUND_TARGET
-
-MAC address of EVSE-HLE that will receive CM_MNBC_SOUND.IND messages.
-The EVSE-HLE defines this address and broadcasts it to PEV-HLE in CM_SLAC_PARAM.CNF message M-SOUND_TRAGET field.
-THe PEV-HLE stores this address in its session variable.
-The default is FF:FF:FF:FF:FF:FF and remains constant.
-This value is not used at this time.
-
- session.FORWARDING_STA
-
-MAC address of PEV-HLE to receive CM_SLAC_PROFILE.IND messages.
-The EVSE-HLE defines this address and sends it to PEV-HLE in CM_SLAC_PARAM.CNF message FORWARDING_STA field.
-THe PEV-HLE stores this address in its session variable.
-The default is FF:FF:FF:FF:FF:FF and remains constant.
-This value is ignored when RESP_TYPE=0.
-
- session.PEV_ID
-
-The vehicle identification number.
-The PEV-HLE sends this value to the EVSE-HLE in CM_SLAC_MATCH.REQMatchVarField.PEV_ID field.
-The default is AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA but is can be changed using “vehicle identifier =” in profile pev.ini.
-The MatchVarField portion of the message forms the transaction record and may be encrypted.
-
- session.PEV_MAC
-
-PEV-HLE MAC address.
-The PEV-HLE sends this address to the EVSE-HLE in CM_SLAC_MATCH.REQMatchVarField.PEV_MAC field.
-The MatchVarField portion of the message forms the transaction record and may be encrypted.
-
- session.EVSE_ID
-
-The station identification number.
-The EVSE-HLE sends this value to PEV-HLE in CM_SLAC_MATCH.CNF message MatchVarField.EVSE_ID field.
-The default is BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB but is can be changed using “station identifier =” in profile evse.ini.
-The MatchVarField portion of the message forms the transaction record and may be encrypted.
-
- session.EVSE_MAC
-
-EVSE-HLE MAC address.
-The EVSE-HLE sends this value to PEV-HLE in CM_SLAC_MATCH.CNF message MatchVarField.EVSE_MAC field.
-The MatchVarField portion of the message forms the transaction record and may be encrypted.
-
- session.NMK
-
-The EVSE-PLC Network Membership Key.
-The EVSE-HLE defines this value when the station powers on.
-The EVSE-HLE sends the NMK to the PEV-HLE in CM_SLAC_MATCH.CNF message MatchField.NMK field.
-The PEV-HLE uses this value to form a network with the EVSE-PLC during charging.
-The MatchVarField portion of the message forms the transaction record and may be encrypted.
-
-The default for PEV-HLE is 50D3E4933F855B7040784DF815AA8DB7, which is the key derived from network password “HomePlugAV”, but that can be changed using “nwtwork membership key =” in profile pev.ini.
-
-The default for EVSE-HLE is B59319D7E8157BA001B018669CCEE30D, which is the key derived from network password “HomePlugAV0123”, but that can be changed using “nwtwork membership key =” in profile evse.ini.
-
- session.NID
-
-The EVSE-PLC Network Identifier.
-The EVSE-HLE defines this value when the station powers.
-The EVSE-HLE sends the NID to the PEV-HLE in CM_SLAC_MATCH.CNF message MatchField.NID field.
-The PEV-HLE uses this value to form a network with the EVSE-PLC during charging.
-The MatchVarField portion of the message forms the transaction record and may be encrypted.
-
-The default for PEV-HLE is B0F2E695666B03, which is the key derived from network password “HomePlugAV”, but that can be changed using “nwtwork membership key =” in profile pev.ini.
-
-The default for EVSE-HLE is 026BCBA5354E08, which is the key derived from network password “HomePlugAV0123”, but that can be changed using “nwtwork membership key =” in profile evse.ini.
-
- session.RND
-
-A random value.
-PEV-HLE computes this value and sends it to EVSE-HLE in CM_MNBC_SOUND.IND.
-This value is not used at this time.
-
- session.original_nmk
-
-The original PEV-PLC Network Membership Key.
-This is the original NMK of the PEV-HLE.
-The PEV-HLE preserves this value before, and restores it after, the charging cycle.
-The Qualcomm Atheros PEV-HLE and EVSE-HLE demonstration software reads these values from profile pev.ini and evse.ini, respectively, by “network membership key = ”.
-
- session.original_nid
-
-The PLC Network Identifier (NID).
-PEV-PLC and EVSE-PLC will each have a different NID at the start of the SLAC process.
-This value must be preserved before, and restored after, charging.
-Once charging is complete, PEV-HLE and EVSE-HLE restore this value to their respective PLC using CM_SET_KEY.
-In a real world implementation, PEV-HLE and EVSE-HLE would read this value from their repective PLC and save it in session.nmk and session.NMK.
-The Qualcomm Atheros PEV-HLE and EVSE-HLE demonstration software reads these values from profile pev.ini and evse.ini, respectively, by “network identifier = ”.
-
- session.state
-
-The current SLAC protocol session state. Qualcomm Atheros PEV-HLE and EVSE-HLE demonstration programs use this value to direct internal state transitions.
-Values range from 0 through 3.
-
- session.sounds
-
-The number of MSounds captured received by EVSE-HLE.
-This value may be less that NUM_SOUNDS the requested by the EVSE_HLE due to network interruptions or EVSE-HLE overloading.
-This is the denominator used when computing the average attenuation in array session.AAG.
-The values is set by PEV_HLE from CM_ATTEN_CHAR.IND message NUM_SOUNDS field.
-
- session.limit
-
-The attenuation threshold.
-If the average attenuation value in session.AAG exceeds this value the PEV-HLE will make no attempt to connect the PEV-PLC to the EVSE-PLC.
-The default value is 10 but this can be re-defined in profile pev.ini by “attenuation threshold = ”.
-
- session.pause
-
-The time in milliseconds between MSounds.
-Sounding too frequently does not allow enough time for the EVSE-PLC to sample and compute values.
-Sounding too infrequently wastes time.
-The maximum sample rate may be limited by the quality of the powerline media and traffic passwing through the EVSE-PLC.
-The default is 10 but can be re-defined in profile pev.ini by “msound pause = ”.
-
- session.chargetime
-
-The time in milliseconds allowed for the charging cycle to complete.
-The default is 10 but this can be changed using “charge time =” in profile pev.ini and evse.ini.
-The charge time should be the same for PEV-HLE and EVSE-HLE when running long tests.
-
- session.settletime
-
-The time in milliseconds allowed for the charging cycle to complete.
-The default is 10 but this can be changed using “settle time =” in profile pev.ini and evse.ini.
-The settle time should be the same for PEV-HLE and EVSE-HLE when running long tests.
-
- session.counter
-
-The number of chaging session that have take place.
-This variable is not part of the SLAC protocol.
-The PEV-HLE and EVSE-HLE increment this counter each time they enter the “Charging” state and exchange this value in the unused CM_SLAC_PARAM.REW and CM_SLAC_PARAM.CNF message CipherSuite field.
-Runtime options can be used to instruct either the PEV-HLE or EVSE-HLE to terminate if their counts are out-of-sync.
-
- session.flags
-
-A bit-mapped flagword used to control program flow based on user-specified command line options.
-
-PEV-HLE broadcasts CM_SLAC_PARAM.REQ messages and waits for a CM_SLAC_PARAM.CNF from EVSE-HLEs.
-This is the first message sent and it initiates SLAC session one some EVSE-HLE responds.
-Function pev_cm_slac_param copies session.APPLICATION_TYPE, session.SECURITY_TYPE and session.RunID into CM_SLAC_PARAM.REQ and broadcasts it to listening EVSE-HLE.
-
-It is possible that multiple EVSE-HLEs will respond but one response is sufficient to proceed.
-If a CM_SLAC_PARAM.CNF is not received within a reasonable time, PEV-HLE sends another another CM_SLAC_PARAM.REQ message.
-PEV-HLE should compare the run identifier in the CM_SLAC_PARAM.CNF to that stored in the session variable to ensure that it is not processing CM_SLAC_PARAM.CNF messages from some other session.
-PEV-HLE compares RunID, APPLICATION_TYPE and SECURITY_TYPE from CM_SLAC_PARAM.CNF to that stored in the session variable to ensure they have not changed.
-PEV-HLE stores MSOUND_TARGET, NUM_SOUNDS and TIME_OUT in the session variable for later use.
-
-EVSE-HLE receives a CM_SLAC_PARAM.REQ and responds with a CM_SLAC_PARAM.CNF message.
-This function waits indefinitly for CM_SLAC_PARAM.REQ then copies RunID, APPLICATION_TYPE and SECURITY_TYPE from CM_SLAC_PARAM.REQ to the session variable for later use.
-It then copies session.MSOUND_TARGET, session.NUM_SOUNDS, session.TIME_OUT, session.RESP_TYPE, session.FORWARDING_STA, session.APPLICATION_TYPE, session.SECURITY_TYPE and session.RunID to CM_SLAC_PARAM.CNF and sends it unicast to the requesting PEV-HLE.
-
-PEV-HLE informs listening EVSE-HLE that sounding is about to start by broadcasting CM_START_ATTEN_CHAR.IND.
-Function pev_cm_start_char copies session.NUM_SOUNDS, session.TIME_OUT, session.RESP_TYPE, session.FORWARDING_STA and session.RunID to CM_START_ATTEN_CHAR.IND.
-
- The standard recommends that this message be sent three times. Our demonstration software does not do this.
-
-EVSE-HLE receives CM_START_ATTEN_CHAR from PEV-HLE and prepares to receive sounds by initializing msound counters and starting a timer.
-This function compares RunID from CM_START_ATTEN_CHAR to session.RunID to ensure that this message belongs to a known session.
-This function compares APPLICATION_TYPE, SECURITY_TYPE, NUM_SOUNDS, TIME_OUT, RESP_TYPE and FORWARDING_STA to the session variable to ensure that values have not changed.
-
-EVSE-HLE receives interleaved CM_MNBC_SOUND.IND from PEV-HLE and CM_ATTEN_PROFILE.IND messages from EVSE-PLC.
-This function maintains a running average of attenuation values across each carrier group in array session.AAG.
-
-PEV-HLE sends CM_SLAC_MATCH.REQ to selected EVSE-HLE and waits for CM_SLAC_MATCH.CNF.
-This function evaluates sounds across all carrier groups and compares result to some threshold and selects one EVSE-HLE.
-This function copies session.APPLICAION_TYPE, session.SECURITY_TYPE, session.PEV_ID, session.PEV_MAC and session.RunID to CM_SLAC_PARAM.REQ and sends it unicast to the selected EVSE-HLE.
-
-EVSE-HLE listens for CM_SLAC_MATCH.REQ from PEV-HLE and abandons the session if no indication is received within a reasonable time.
-If an indication is received then this function compares RunID from CM_SLAC_MATCH.REQ to the session.RunID to ensure the message is part of the current session.
-This function compares APPLICATION_TYPE and SECURITY_TYPE to the session.APPLICATION_TYPE and session.SECURITY_TYPE to ensure that they have not changed.
-This function copies PEV_ID and PEV_MAC from CM_SLAC_MATCH.REQ to the session variable for later use.
-This function updates session.NMK and session.NID with random values.
-This function copies session.EVSE_ID, session.EVSE_MAC, session.NMK and session.NID to CM_SLAC_MATCH.RSP and sends it unicast to the selecing PEV-HLE.
-
- Most Qualcomm Atheros PLC chipsets are Ethernet-to-Powerline bridges but the QCA7000 is a Serial-to-Powerline bridge, ... with a big difference. The QCA7000 expects the host serial stream to be segmented into Ethernet frames where each frame is encapsulated by a distinct serial header and trailer. This means the host can format and transmit, or receive and decode, standard Ethernet 802.3 frames over an ordinary SPI or UART interface thereby enabling full Ethernet or Internet protocol communications over powerline at low cost and low speed. The enabling component here is an Ethernet-to-Serial driver that supports the SPI or UART interface connected to the QCA7000. This section covers such a driver.
-
- The example driver described here was written for the Freescale iMX28 board support package running a custom Freescale Linux distribution. As such, we believe that this driver is suitable for the iMX28 processor out of the box but it could be adapted to other processors.
-
- The basic unit of data transfer over MII and powerline is the IEEE 802.3 Ethernet frame. On output, the host must encapsulate each Ethernet frame as shown below before serial transmission to the QCA7000. The QCA7000 strips off the serial header and footer and forwards the frame over powerline.
-
Table 8.1.
- SPI Transmit Frame
-
- Allocate a 1528-byte buffer to accommodate the largest outgoing serial packet and pad with NUL bytes. Write SOF, compute and write FL, copy the outgoing frame then write EOF. Serially transmit FL + 12 buffer bytes to the QCA7000.
-
- Offset
-
- Length
-
- Symbol
-
- Description
-
- 0x0000
-
- 4
-
- SOF
-
- Start Of Frame. Must be 0xAAAAAAAA.
-
- 0x0004
-
- 2
-
- FL
-
- The Ethernet frame length in little endian format. The frame starts at offset 0x0008 here and includes all fields up to but excluding EOF. The minimum is 60. The maximum is 1518 if VLAN is omitted and 1522 if not.
-
- 0x0006
-
- 2
-
- RSVD
-
- Must be 0x0000. Reserved to ensure 4-byte frame alignment.
-
- 0x0008
-
- 6
-
- DA
-
- Destination address.
-
- 0x000E
-
- 6
-
- SA
-
- Source address. This must not be the MAC address of the powerline device. This must be the MAC address of the local host serial interface as assigned by the SP or UART driver. The PLC device and the associated host interface must have different MAC address.
-
- 0x0014
-
- 4
-
- VLAN
-
- Virtual LAN tag. This field may be omitted.
-
- 0x0018
-
- 2
-
- ET
-
- Ethertype. This field starts at offset 0x0014 if VLAN is omitted.
-
- 0x001A
-
- 42 to 1500
-
- BODY
-
- Frame body. This field starts at offset 0x0016 and ranges from 46 to 1500 bytes if VLAN is omitted.
-
- 0x004A to 0x05F8
-
- 4
-
- EOF
-
- End Of Frame. Must be 0x5555. This field starts at offset 0x0008 plus FL.
-
Table 8.2.
- SPI Receive Frame
-
- The SPI read frame occurs in response to a read interrupt generated by the QCA7000. The host must acknowledge a read interrupt and service it by reading and acting on QCA7000 SPI register values. For incoming frames, the host reads the 32-bit overall packet length reported by the QCA7000 then read that many bytes, stripping off the serial header and footer and forwarding the Ethernet frame to the host.
-
- Allocate a 1532-byte buffer to accomodate the largest incoming serial packet. Read LEN to determine the size of the incoming serial packet. Read LEN bytes into the buffer. Beware that LEN is a multiple of 4-bytes so there may be a few trailing NUL bytes in buffer.
-
- Offset
-
- Length
-
- Symbol
-
- Description
-
- 0x0000
-
- 4
-
- LEN
-
- Hardware generated packet length. This field is only generated for SPI packets, not the UART packets.
-
- 0x0004
-
- 4
-
- SOF
-
- Start Of Frame. Must be 0xAAAAAAAA.
-
- 0x0008
-
- 2
-
- FL
-
- Ethernet frame length in little endian format. The frame starts at offset 0x000C here and includes all fields up to but excluding EOF. The minimum length is 60. The maximum is 1518 if VLAN is omitted and 1522 if not.
-
- 0x000A
-
- 2
-
- RSVD
-
- Must be 0x0000. Reserved to ensure 4-byte frame alignment.
-
- 0x000C
-
- 6
-
- DA
-
- Destination address.
-
- 0x0012
-
- 6
-
- SA
-
- Source address. This must not be the MAC address of the powerline device. This must be the MAC address of the local host serial interface as assigned by the SP or UART driver. The PLC device and the associated host interface must have different MAC address.
-
- 0x0018
-
- 4
-
- VLAN
-
- Virtual LAN tag. This field may be omitted.
-
- 0x001C
-
- 2
-
- ET
-
- Ethertype. This field starts offset 0x0018 if VLAN is omitted.
-
- 0x001E
-
- 42 to 1500
-
- BODY
-
- Frame body. This field starts at offset 0x001A and ranges from 46 to 1500 bytes if VLAN is omitted.
-
- 0x004A to 0x05F8
-
- 4
-
- EOF
-
- End Of Frame. Must be 0x5555. This field starts at offset 0x000C plus FL.
-
- Manages synchronization with the exteranl QCA7000.
- Handles interrupts fomr the external QCA7000.
- Transmits frames for the transmit queue to the QCA7000.
-
- qcaspi_qca7k_sync
-
void qca_qca7k_sync(
qca,
event);
char struct qcaspi * qca; int event;
- Keeps track of the current synchonization state.
-
- Reads the QCA7000 read buffer bytes register and reads all available data from the QCA7000. Calls function to parse out the individual Ethernet frames and passes them to the Linux kernel protocol stack.
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * channel.c - global channel structure;
- *
- * channel.h
- *
- * define and initialize a global channel structure; this structure
- * is initialized for communication with Atheros devices and it is
- * referenced by Atheros Linux Toolkit programs that do not need a
- * full int6k data structure;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef CHANNEL_SOURCE
-#define CHANNEL_SOURCE
-
-#include "../ether/channel.h"
-
-struct channel channel =
-
-{
- (file_t)(-1),
- 0,
- CHANNEL_ETHNUMBER,
- CHANNEL_ETHDEVICE,
- {
- 0x00,
- 0xB0,
- 0x52,
- 0x00,
- 0x00,
- 0x01
- },
- {
- 0x00,
- 0x00,
- 0x00,
- 0x00,
- 0x00,
- 0x00
- },
- 0x88E1,
-
-#if defined (__linux__)
-
-#elif defined (__APPLE__) || defined (__OpenBSD__)
-
- (struct bpf *) (0),
-
-#elif defined (WINPCAP) || defined (LIBPCAP)
-
- (pcap_t *)(0),
- {
- 0
- },
-
-#else
-#error "Unknown Environment"
-#endif
-
- CHANNEL_TIMEOUT,
- CHANNEL_TIMEOUT,
- CHANNEL_FLAGS
-};
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * channel.h - raw packet channel definitions and declarations;
- *
- * the channel structure contains information needed to perform
- * ISO Layer 2, raw packet I/O in a variety of environments;
- *
- *. Qualcomm Atheros HomePlug AV Powerline Toolkit
- *: Copyright (c) 2009-2013 by Qualcomm Atheros Inc. ALL RIGHTS RESERVED;
- *; For demonstration and evaluation only; Not for production use.
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nathaniel.houghton@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef CHANNEL_HEADER
-#define CHANNEL_HEADER
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <unistd.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#include "../ether/ether.h"
-#include "../tools/types.h"
-
-/*====================================================================*
- * sort out the raw socket mess;
- *--------------------------------------------------------------------*/
-
-#if defined (__linux__) || defined (__APPLE__) || defined (__OpenBSD__)
-# ifdef WINPCAP
-# error "Don't enable winpcap on Linux. It won't work."
-# endif
-# ifdef LIBPCAP
-# error "Don't enable libpcap on Linux. You don't need it."
-# endif
-#elif defined (WIN32)
-# ifndef WINPCAP
-# error "Define preprocessor constant WINPCAP on Windows."
-# endif
-# ifdef LIBPCAP
-# error "Don't enable libpcap on Windows. It won't work."
-# endif
-#elif defined (__CYGWIN__)
-# error "cygwin is unsupported!"
-#else
-# error "unknown environment"
-#endif
-
-/*====================================================================*
- * channel flagword bitmasks;
- *--------------------------------------------------------------------*/
-
-#define CHANNEL_VERBOSE (1 << 0)
-#define CHANNEL_SILENCE (1 << 1)
-#define CHANNEL_WARNING (1 << 2)
-#define CHANNEL_SUCCESS (1 << 3)
-#define CHANNEL_FAILURE (1 << 4)
-#define CHANNEL_MONITOR (1 << 5)
-
-#define CHANNEL_UPDATE_TARGET (1 << 5) /* used by efsu only */
-#define CHANNEL_UPDATE_SOURCE (1 << 6) /* used by efsu only */
-#define CHANNEL_LISTEN (1 << 7) /* used by efsu only */
-
-#define CHANNEL_ETHNUMBER 2
-#if defined (__linux__)
-# define CHANNEL_ETHDEVICE "eth1"
-#elif defined (__APPLE__)
-# define CHANNEL_ETHDEVICE "en0"
-# define CHANNEL_BPFDEVICE "/dev/bpf%d"
-#elif defined (__OpenBSD__)
-# define CHANNEL_ETHDEVICE "bce0"
-# define CHANNEL_BPFDEVICE "/dev/bpf%d"
-#else
-# define CHANNEL_ETHDEVICE "nic1"
-#endif
-
-#define CHANNEL_FOREVER (unsigned)(-1)
-#define CHANNEL_BAILOUT 0
-#define CHANNEL_FLAGS 0
-
-#if defined (WIN32)
-#define CHANNEL_CAPTURE 50
-#define CHANNEL_TIMEOUT 200
-#else
-#define CHANNEL_CAPTURE 15
-#define CHANNEL_TIMEOUT 50
-#endif
-
-/*====================================================================*
- * common channel error messages;
- *--------------------------------------------------------------------*/
-
-#define CHANNEL_CANTSEND "%s: Send timeout or network error", __func__
-#define CHANNEL_CANTREAD "%s: Read timeout or network error", __func__
-
-/*====================================================================*
- * channel ethertype definitions;
- *--------------------------------------------------------------------*/
-
-#if !defined (__linux__)
-# define ETH_P_802_2 1
-#endif
-
-/*====================================================================*
- * communication channel structure;
- *--------------------------------------------------------------------*/
-
-typedef struct channel
-
-{
- signed fd;
- signed ifstate;
- signed ifindex;
- char const * ifname;
- uint8_t peer [ETHER_ADDR_LEN];
- uint8_t host [ETHER_ADDR_LEN];
- uint16_t type;
-
-#if defined (__linux__)
-
-#elif defined (__APPLE__) || defined (__OpenBSD__)
-
- struct bpf
- {
- signed bpf_length;
- uint8_t * bpf_buffer;
- uint8_t * bpf_bp;
- signed bpf_bufused;
- }
- * bpf;
-
-#elif defined (WINPCAP) || defined (LIBPCAP)
-
- pcap_t * socket;
- char errbuf [PCAP_ERRBUF_SIZE];
-
-#else
-#error "Unknown Environment"
-#endif
-
- signed capture;
- signed timeout;
- flag_t flags;
-}
-
-CHANNEL;
-
-/*====================================================================*
- * channel functions;
- *--------------------------------------------------------------------*/
-
-signed openchannel (struct channel *);
-signed closechannel (struct channel const *);
-ssize_t sendpacket (struct channel const *, void * memory, ssize_t extent);
-ssize_t readpacket (struct channel const *, void * memory, ssize_t extent);
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-#ifndef CHIPSET_HEADER
-#define CHIPSET_HEADER
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <stdint.h>
-
-/*====================================================================*
- * constants;
- *--------------------------------------------------------------------*/
-
-#define PLCHIPSET "PLCDEVICE"
-
-/*====================================================================*
- * chipset codes returned in VS_SW_VER MDEVICE_CLASS field;
- *--------------------------------------------------------------------*/
-
-#define CHIPSET_UNKNOWN 0x00
-#define CHIPSET_INT6000A1 0x01
-#define CHIPSET_INT6300A0 0x02
-#define CHIPSET_INT6400A0 0x03
-#define CHIPSET_AR7400A0 0x04
-#define CHIPSET_AR6405A0 0x05
-#define CHIPSET_PANTHER_LYNX 0x06
-#define CHIPSET_QCA7450A0 0x07
-#define CHIPSET_QCA7451A0 0x08
-#define CHIPSET_QCA7452A0 0x09
-#define CHIPSET_QCA7420A0 0x20
-#define CHIPSET_QCA6410A0 0x21
-#define CHIPSET_QCA6411A0 0x21
-#define CHIPSET_QCA7000A0 0x22
-#define CHIPSET_QCA7000I 0x22
-#define CHIPSET_QCA7005A0 0x22
-#define CHIPSET_QCA7500A0 0x30
-
-/*
- * the following definitions define older constants in terms of
- * newer constants to avoid compiler errors; there is nothing
- * magic about the A0/A1 suffixes;
- */
-
-#define CHIPSET_INT6000 CHIPSET_INT6000A1
-#define CHIPSET_INT6300 CHIPSET_INT6300A0
-#define CHIPSET_INT6400 CHIPSET_INT6400A0
-#define CHIPSET_AR7400 CHIPSET_AR7400A0
-#define CHIPSET_INT6405 CHIPSET_AR6405A0
-#define CHIPSET_AR6405 CHIPSET_AR6405A0
-#define CHIPSET_QCA7450 CHIPSET_QCA7450A0
-#define CHIPSET_QCA7451 CHIPSET_QCA7451A0
-#define CHIPSET_QCA7452 CHIPSET_QCA7452A0
-#define CHIPSET_QCA7420 CHIPSET_QCA7420A0
-#define CHIPSET_QCA6410 CHIPSET_QCA6410A0
-#define CHIPSET_QCA6411 CHIPSET_QCA6411A0
-#define CHIPSET_QCA7000 CHIPSET_QCA7000A0
-#define CHIPSET_QCA7005 CHIPSET_QCA7005A0
-#define CHIPSET_QCA7500 CHIPSET_QCA7500A0
-
-/*====================================================================*
- * chipset functions;
- *--------------------------------------------------------------------*/
-
-char const * chipsetname (uint8_t chipset);
-void chipset (void const * memory);
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-chknvm(1) Qualcomm Atheros Open Powerline Toolkit chknvm(1)
-
-NAME
- chknvm - Qualcomm Atheros PLC Image File Validator
-
-SYNOPSIS
- chknvm [options] file [file] [...]
-
-DESCRIPTION
- Validate the image chain found inside a Qualcomm Atheros PLC firmware or parameter file by checking file structure, file
- size, image header sizes and checksums and image sizes and checksums. Optionally, display internal image header informa‐
- tion or information extracted from selected image types, when present. Use this program to detect corrupted firmware or
- parameter files or inspect image files to determine content.
-
- This program handles both the older Thunderbolt and Lightning and the newer Panther and Lynx firmware file formats. It
- validates files directly from disk and so it is slower than program chknvm2 but needs less memory at runtime.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -i Print revision string identity fields in fixed-width columns. This option is useful when searching .nvm folders
- for a specific build.
-
- -m Display manifest content, if present. The manifest is a special module, included in some image chains, that con‐
- tains useful information about the chain. This option suppresses the summary 'looks good' message.
-
- -r Print firmware revision string on stdout. This option suppresses the summary 'looks good' message.
-
- -s Print SDRAM configuration block on stdout. This option automatically suppresses the summary 'looks good' message.
-
- -q Suppresses printing of routine messages. Specifically, it suppresses the summary 'looks good' message.
-
- -v Print additional information such as the image header for each image processed. This information can be used to
- distinguish one firmware file from another, if you know what to look for.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of an Atheros image file. By convention, Atheros Image files have a .nvm file extension but this program
- does not enforce this convention.
-
-DISCLAIMER
- Qualcomm Atheros firmware file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently,
- public information is not available. Qualcomm Atheros reserves the right to change firmware file structure or content or
- change the name or behavior of any program that inspects or changes firmware files, in future software releases without
- any obligation to notify or compensate users of such programs.
-
-EXAMPLES
- This example reads file abc.nvm and validates it. The message shown indicates that the file is the correct length, image
- headers and images have the correct length and checksum and there are no read errors. The file can be have either the
- newer or older format.
-
- # chknvm abc.nvm
- abc.nvm looks good
-
- The following example reads three files in succession and reports on each one. You can suppress good news with the -q
- option.
-
- # chknvm INT6400.nvm AR7400.nvm AR7420.nvm
- INT6400.nvm looks good
- AR7400.nvm looks good
- AR7420.nvm looks good
-
- This next example displays the SDRAM parameter block found in the named files. SDRAM parameter blocks are a legacy fea‐
- ture. They were to configure memory. Powerline device now run a configuration applet, instead. Observe that file
- AR6400.nvm us the only one that contains SDRAM parameters.
-
- # chknvm -s INT6400.nvm AR7400.nvm AR7420.nvm
- ------- INT6400.nvm (0) -------
- SIZE=0x04000000 (64mb)
- CONF=0x00143188
- TIM0=0x01E1D491
- TIM1=0x000883D6
- CNTRL=0x00003089
- REF=0x00000366
- CLOCK=0x00000001
-
- This next example prints the firmware revision string found inside older image files. The option can be used to identify
- the actual firmware image present when the filename has been changed. Newer image files have a manifest, instead.
- Observe that file AR7420.nvm shows no firmware revision string because it has the newer image file format.
-
- # chknvm -r INT6400.nvm AR7400.nvm AR7420.nvm
- INT6400.nvm (3) INT6000-MAC-4-1-4122-01-4020-20100219-FINAL
- AR7400.nvm (5) INT7400-MAC-7-0-7011-01-52-20110811-FINAL
-
- This example prints the manifest found inside newer firmware files. This can be used to distinguish firmware files from
- parameter files, determine exact firmware or parameter file revisions and so forth. Observe that we specified several
- files on the command line but only one file, AR7420.nvm, contained a mainfest.
-
- # chknvm -m INT6400.nvm AR7400.nvm AR7420.nvm
- ------- AR7420.nvm (0) -------
- Signature: 1234ABCD
- Hardware Compatibility: AR74200
- Chain Major Version: 0
- Chain Minor Version: 1
- Chain Type: Firmware
- Build Major Version: 0
- Build Minor Version: 0
- Build Type: Special
- Manifest Version: 1
- Build Number: 0
- Build Date: 20110811
- Build Time: 203853
- Device Type: 29728
- Build Hostname: TOR-SW-SIM04
- Build Username: buildbot
- Build Description: Custom
- Build Version String: AR-7420-FW-0_0-0_2-20110811:203853-buildbot:TOR-SW-SIM04-1-0_1
-
-SEE ALSO
- chknvm2(1), chkpib(1), chkpib2(1), int6ktest(7), nvmmerge(1), nvmsplit(1), plctest(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 chknvm(1)
-
-chknvm2(1) Qualcomm Atheros Open Powerline Toolkit chknvm2(1)
-
-NAME
- chknvm2 - Qualcomm Atheros PLC Image File Validator
-
-SYNOPSIS
- chknvm2 [options] file [file] [...]
-
-DESCRIPTION
- Check Atheros HomePlug AV firmware files for obvious errors, including obsolete format, incorrect file size, bad check‐
- sums and read errors. Make no attempt to check any internal information other than firmware header checksums, image
- lengths and image checksums. Optionally, display header and image information on stdout.
-
- This program handles both the older Thunderbolt and Lightning and the newer Panther and Lynx firmware file formats. It
- validates files directly from memory and so it is faster than program chknvm but needs more memory at runtime.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -i Print revision string identity fields in fixed-width columns. This option is useful when searching .nvm folders
- for a specific build.
-
- -m Display manifest content, if present. The manifest is a special module, included in some image chains, that con‐
- tains useful information about the chain. This option suppresses the summary 'looks good' message.
-
- -r Print firmware revision string on stdout. This option automatically suppresses the summary 'looks good' message.
-
- -q Suppresses printing of routine messages. Specifically, it suppresses the summary 'looks good' message.
-
- -v Print additional information such as the image header for each image processed. This information can be used to
- distinguish one firmware file from another, if you know what to look for.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of an Atheros image file. By convention, Atheros Image files have a .nvm file extension but this program
- does not enforce this convention.
-
-DISCLAIMER
- Qualcomm Atheros firmware file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently,
- public information is not available. Qualcomm Atheros reserves the right to change firmware file structure or content or
- change the name or behavior of any program that inspects or changes firmware files, in future software releases without
- any obligation to notify or compensate users of such programs.
-
-EXAMPLES
- This example reads file abc.nvm and validates it. The message shown indicates that the file is the correct length, image
- headers and images have the correct length and checksum and there are no read errors. The file can be have either the
- newer or older format.
-
- # chknvm2 abc.nvm
- abc.nvm looks good
-
- The following example reads three files in succession and reports on each one. You can suppress good news with the -q
- option.
-
- # chknvm2 INT6400.nvm AR7400.nvm AR7420.nvm
- INT6400.nvm looks good
- AR7400.nvm looks good
- AR7420.nvm looks good
-
- This next example prints the firmware revision string found inside older image files. The option can be used to identify
- the actual firmware image present when the filename has been changed. Newer image files have a manifest, instead.
- Observe that file AR7420.nvm shows no revision string since it is the newer image format where firmware images are com‐
- pressed.
-
- # chknvm2 -r INT6400.nvm AR7400.nvm AR7420.nvm
- INT6400.nvm (3) INT6000-MAC-4-1-4122-01-4020-20100219-FINAL
- AR7400.nvm (5) INT7400-MAC-7-0-7011-01-52-20110811-FINAL
-
- The following example displays the firmware revision strings, from the last example, as fixed width columns. Observe
- that the external filename may, in some cases, not reflect the file content.
-
- # chknvm2 -i INT6400.nvm AR7400.nvm AR7420.nvm
- INT6000 4020 20100219 4.1 INT6400.nvm (3)
- INT7400 0052 20110811 7.0 AR7400.nvm (5)
-
- This example prints the manifest found inside newer firmware files. This can be used to distinguish firmware files from
- parameter files, determine exact firmware or parameter file revisions and so forth. Observe that we specified several
- files on the command line but only one file, AR7420.nvm, contained a mainfest.
-
- # chknvm2 -m INT6400.nvm AR7400.nvm AR7420.nvm
- ------- AR7420.nvm (0) -------
- Signature: 1234ABCD
- Hardware Compatibility: AR74200
- Chain Major Version: 0
- Chain Minor Version: 1
- Chain Type: Firmware
- Build Major Version: 0
- Build Minor Version: 0
- Build Type: Special
- Manifest Version: 1
- Build Number: 0
- Build Date: 20110811
- Build Time: 203853
- Device Type: 29728
- Build Hostname: TOR-SW-SIM04
- Build Username: buildbot
- Build Description: Custom
- Build Version String: AR-7420-FW-0_0-0_2-20110811:203853-buildbot:TOR-SW-SIM04-1-0_1
-
-SEE ALSO
- chknvm(1), chkpib(1), chkpib2(1), int6ktest(7), nvmmerge(1), nvmsplit(1), plctest(7)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 chknvm2(1)
-
-chkpib(1) Qualcomm Atheros Open Powerline Toolkit chkpib(1)
-
-NAME
- chkpib - Qualcomm Atheros PLC Parameter File Inspector
-
-SYNOPSIS
- chkpib [options] file [file] [...]
-
-DESCRIPTION
- The Qualcomm Atheros Parameter File Validator checks Qualcomm Atheros powerline parameter files for obvious errors,
- including obsolete format, wrong file size, bad checksums and read errors. It makes no attempt to check any internal
- information other than file length and checksum.
-
- This program handles both the older Thunderbolt and Lightning and the newer Panther and Lynx parameter file formats. It
- validates files directly from disk and so it is slower than program chkpib2 but needs less memory at runtime.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -m Display manifest content, if present. The manifest is a special module, included in some image chains, that con‐
- tains useful information about the chain. This option suppresses the summary 'looks good' message.
-
- -q Suppresses printing of progress messages.
-
- -v Print additional information such as the PIB header for each file. This information can be used to confirm pib
- version and distinguish one PIB file from another.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of a runtime parameter file. By convention, runtime parameter files have a .pib extention but this pro‐
- gram does not enforce that convention.
-
-DISCLAIMER
- Qualcomm Atheros parameter file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently,
- public information is not available. Qualcomm Atheros reserves the right to change parameter file structure or content
- or change the name or behavior of any program that inspects or changes parameter files, in future software releases with‐
- out any obligation to notify or compensate users of such programs.
-
-EXAMPLES
- The next example reads file abc.pib and validates it. The message shown indicates that the PIB version is recent, the
- file is the correct size, the checksum is valid computes and there are no read errors.
-
- # chkpib abc.pib
- abc.pib looks good
-
- The next example reads three files and reports on each one. You can suppress good news with the -q option. Remember
- that "looking good" does not mean "is good".
-
- # chkpib INT6400.pib AR7400.pib AR7420.pib
- INT6400.pib looks good
- AR7400.pib looks good
- AR7420.pib looks good
-
- The next example reads three files and displays selected information about each one because option -v is present. Ov
- course, program output could be piped to a file and used for documentation purposes.
-
- # chkpib -v INT6400.pib AR7400.pib AR7420.pib
- ------- INT6400.pib -------
- PIB 4-2 10888 bytes
- MAC 00:B0:52:BA:BE:00
- DAK 68:9F:07:4B:8B:02:75:A2:71:0B:0B:57:79:AD:16:30 (HomePlugAV)
- NMK 50:D3:E4:93:3F:85:5B:70:40:78:4D:F8:15:AA:8D:B7 (HomePlugAV)
- NID B0:F2:E6:95:66:6B:03
- NET Intellon Enabled Network
- MFG Intellon HomePlug AV Device
- USR Intellon Enabled Product
- CCo Auto
- MDU N/A
- ------- AR7400.pib -------
- PIB 7-1 16352 bytes
- MAC 00:B0:52:00:00:08
- DAK F0:84:B4:E8:F6:06:9F:F1:30:0C:9B:DB:81:23:67:FF (HomePlugAV0123)
- NMK 50:D3:E4:93:3F:85:5B:70:40:78:4D:F8:15:AA:8D:B7 (HomePlugAV)
- NID B0:F2:E6:95:66:6B:03
- NET Atheros Enabled Network
- MFG Atheros HomePlug AV Device
- USR Intergalactic Software Pirates
- CCo Never
- MDU Slave
- ------- AR7420.pib -------
- PIB 0-2 10904 bytes
- MAC 00:B0:52:00:00:01
- DAK 68:9F:07:4B:8B:02:75:A2:71:0B:0B:57:79:AD:16:30 (HomePlugAV)
- NMK 50:D3:E4:93:3F:85:5B:70:40:78:4D:F8:15:AA:8D:B7 (HomePlugAV)
- NID B0:F2:E6:95:66:6B:03
- NET Atheros Enabled Network
- MFG Atheros HomePlug AV Device
- USR Atheros Enabled Product
- CCo Auto
- MDU N/A
-
- This example prints the manifest found inside newer parameter files. This can be used to distinguish parameter files
- from firmware files, determine exact firmware or parameter file revisions and so forth. Observe that we specified sev‐
- eral files on the command line but only one file, AR7420.pib, contained a manifest.
-
- # chkpib -m INT6400.pib AR7400.pib AR7420.pib
- ------- AR7420.pib (0) -------
- Signature: 1234ABCD
- Hardware Compatibility: AR74200
- Chain Major Version: 0
- Chain Minor Version: 1
- Chain Type: Parameter Block
- Build Major Version: 0
- Build Minor Version: 0
- Build Type: Special
- Manifest Version: 1
- Build Number: 0
- Build Date: 20110811
- Build Time: 203853
- Device Type: 29728
- Build Hostname: TOR-SW-SIM04
- Build Username: buildbot
- Build Description: Custom
- Build Version String: AR-7420-FW-0_0-0_2-20110811:203853-buildbot:TOR-SW-SIM04-1-0_1
-
-SEE ALSO
- chkpib2(7), getpib(7), modpib(1), pib2xml(1), pibcomp(1), pibdump(1), setpib(1), xml2pib(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 chkpib(1)
-
-chkpib2(1) Qualcomm Atheros Open Powerline Toolkit chkpib2(1)
-
-NAME
- chkpib2 - Qualcomm Atheros PLC Parameter File Inspector
-
-SYNOPSIS
- chkpib2 [options] file [file] [...]
-
-DESCRIPTION
- This program checks Atheros HomePlug AV parameter files for obvious errors, including obsolete format, wrong file size,
- bad checksums and read errors. It makes no attempt to check internal information other than file length and checksum.
-
- This program handles both the older Thunderbolt and Lightning and the newer Panther and Lynx parameter file formats. It
- validates files directly from memory and so it is faster than program chkpib but needs more memory at runtime.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -m Display manifest content, if present. The manifest is a special module, included in some image chains, that con‐
- tains useful information about the chain. This option suppresses the summary 'looks good' message.
-
- -q Suppresses printing of progress messages.
-
- -v Print additional information such as the PIB header for each file processed. This information can be used to con‐
- firm pib version and distinguish one PIB file from another.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of a runtime parameter file. By convention, runtime parameter files have a .pib extention but this pro‐
- gram does not enforce that convention.
-
-DISCLAIMER
- Qualcomm Atheros parameter file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently,
- public information is not available. Qualcomm Atheros reserves the right to change parameter file structure or content
- or change the name or behavior of any program that inspects or changes parameter files, in future software releases with‐
- out any obligation to notify or compensate users of such programs.
-
-EXAMPLES
- The next example reads file abc.pib and validates it. The message shown indicates that the PIB version is recent, the
- file is the correct size, the checksum is valid computes and there are no read errors.
-
- # chkpib2 abc.pib
- abc.pib looks good
-
- The next example reads three files and reports on each one. You can suppress good news with the -q option. Remember
- that "looking good" does not mean "is good".
-
- # chkpib2 INT6400.pib AR7400.pib AR7420.pib
- INT6400.pib looks good
- AR7400.pib looks good
- AR7420.pib looks good
-
- The next example reads three files and displays selected information about each one because option -v is present.
-
- # chkpib2 -v INT6400.pib AR7400.pib AR7420.pib
- ------- INT6400.pib -------
- PIB 4-2 10888 bytes
- MAC 00:B0:52:BA:BE:00
- DAK 68:9F:07:4B:8B:02:75:A2:71:0B:0B:57:79:AD:16:30 (HomePlugAV)
- NMK 50:D3:E4:93:3F:85:5B:70:40:78:4D:F8:15:AA:8D:B7 (HomePlugAV)
- NID B0:F2:E6:95:66:6B:03
- NET Intellon Enabled Network
- MFG Intellon HomePlug AV Device
- USR Intellon Enabled Product
- CCo Auto
- MDU N/A
- ------- AR7400.pib -------
- PIB 7-1 16352 bytes
- MAC 00:B0:52:00:00:08
- DAK F0:84:B4:E8:F6:06:9F:F1:30:0C:9B:DB:81:23:67:FF (HomePlugAV0123)
- NMK 50:D3:E4:93:3F:85:5B:70:40:78:4D:F8:15:AA:8D:B7 (HomePlugAV)
- NID B0:F2:E6:95:66:6B:03
- NET Atheros Enabled Network
- MFG Atheros HomePlug AV Device
- USR Intergalactic Software Pirates
- CCo Never
- MDU Slave
- ------- AR7420.pib -------
- PIB 0-2 10904 bytes
- MAC 00:B0:52:00:00:01
- DAK 68:9F:07:4B:8B:02:75:A2:71:0B:0B:57:79:AD:16:30 (HomePlugAV)
- NMK 50:D3:E4:93:3F:85:5B:70:40:78:4D:F8:15:AA:8D:B7 (HomePlugAV)
- NID B0:F2:E6:95:66:6B:03
- NET Atheros Enabled Network
- MFG Atheros HomePlug AV Device
- USR Atheros Enabled Product
- CCo Auto
- MDU N/A
-
- This example prints the manifest found inside newer parameter files. This can be used to distinguish parameter files
- from firmware files, determine exact firmware or parameter file revisions and so forth. Observe that we specified sev‐
- eral files on the command line but only one file, AR7420.pib, contained a manifest.
-
- # chkpib2 -m INT6400.pib AR7400.pib AR7420.pib
- ------- AR7420.pib (0) -------
- Signature: 1234ABCD
- Hardware Compatibility: AR74200
- Chain Major Version: 0
- Chain Minor Version: 1
- Chain Type: Parameter Block
- Build Major Version: 0
- Build Minor Version: 0
- Build Type: Special
- Manifest Version: 1
- Build Number: 0
- Build Date: 20110811
- Build Time: 203853
- Device Type: 29728
- Build Hostname: TOR-SW-SIM04
- Build Username: buildbot
- Build Description: Custom
- Build Version String: AR-7420-FW-0_0-0_2-20110811:203853-buildbot:TOR-SW-SIM04-1-0_1
-
-SEE ALSO
- chkpib(7), getpib(7), modpib(1), pib2xml(1), pibcomp(1), pibdump(1), setpib(1), xml2pib(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 chkpib2(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed closechannel (struct channel const * channel);
- *
- * channel.h
- *
- * close ethernet raw packet channel;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef CLOSECHANNEL_SOURCE
-#define CLOSECHANNEL_SOURCE
-
-#include <unistd.h>
-#include <stdlib.h>
-
-#include "../ether/channel.h"
-
-signed closechannel (struct channel const * channel)
-
-{
-
-#if defined (__linux__)
-
- return (close (channel->fd));
-
-#elif defined (__APPLE__) || (__OpenBSD__)
-
- free (channel->bpf->bpf_buffer);
- free (channel->bpf);
- return (close (channel->fd));
-
-#elif defined (WINPCAP) || defined (LIBPCAP)
-
- pcap_close (channel->socket);
- return (0);
-
-#else
-#error "Unknown Environment"
-#endif
-
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void closeport (struct _file_ * port);
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef CLOSEPORT_SOURCE
-#define CLOSEPORT_SOURCE
-
-#include <unistd.h>
-#include <stdlib.h>
-
-#include "../tools/types.h"
-#include "../serial/serial.h"
-
-void closeport (struct _file_ * port)
-
-{
- close (port->file);
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * config.c - configuration file reader;
- *
- * configuration files contain named parts where each part may
- * contain one of more named items that have text definitions;
- *
- * the named file can be searched for the first occurance of a
- * named part then the first occurance of a named item;
- *
- * [part1]
- * item1=text
- * item2=text
- *
- * [part2]
- * item1=text
- * item2=text
- *
- *--------------------------------------------------------------------*/
-
-#ifndef CONFIG_SOURCE
-#define CONFIG_SOURCE
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <stdio.h>
-#include <ctype.h>
-#include <unistd.h>
-#include <string.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#include "../tools/config.h"
-#include "../tools/types.h"
-#include "../tools/chars.h"
-
-/*====================================================================*
- * program variables;
- *--------------------------------------------------------------------*/
-
-static char buffer [1024] = "";
-static signed c;
-
-/*====================================================================*
- *
- * bool compare (FILE * fp, char const *sp);
- *
- * compare file and text characters until they differ or until end
- * of text, line or file occurs; a match is declared when the text
- * ends before the line or file;
- *
- * spaces and tabs within the argument string or file string are
- * ignored such that "item1", " item1 " and "item 1" all match;
- *
- *--------------------------------------------------------------------*/
-
-static bool compare (FILE * fp, char const * sp)
-
-{
- while (isblank (*sp))
- {
- sp++;
- }
- while ((*sp) && (c != '\n') && (c != EOF))
- {
- if (toupper (c) != toupper (*sp))
- {
- return (0);
- }
- do
- {
- sp++;
- }
- while (isblank (*sp));
- do
- {
- c = getc (fp);
- }
- while (isblank (c));
- }
- return (!*sp);
-}
-
-/*====================================================================*
- *
- * void collect (FILE * fp);
- *
- * collect text to end of line; remove leading and trailing space
- * but preserve embedded space; replace selected escape sequences;
- *
- *--------------------------------------------------------------------*/
-
-static void collect (FILE * fp)
-
-{
- char *bp = buffer;
- char *cp = buffer;
- while ((c != ';') && (c != '\n') && (c != EOF))
- {
- if (c == '\\')
- {
- c = getc (fp);
- if (c == 'n')
- {
- c = '\n';
- }
- if (c == 't')
- {
- c = '\t';
- }
- }
- if ((cp - buffer) < (signed)(sizeof (buffer) - 1))
- {
- *cp++ = c;
- }
- if (!isblank (c))
- {
- bp = cp;
- }
- c = getc (fp);
- }
- *bp = '\0';
- return;
-}
-
-/*====================================================================*
- *
- * void discard (FILE * fp);
- *
- * read and discard characters until end-of-line or end-of-file
- * is detected; read the first character of next line if end of
- * file has not been detected;
- *
- *--------------------------------------------------------------------*/
-
-static void discard (FILE * fp)
-
-{
- while ((c != '\n') && (c != EOF))
- {
- c = getc (fp);
- }
- if (c != EOF)
- {
- c = getc (fp);
- }
- return;
-}
-
-/*====================================================================*
- *
- * Const char * configstring (char const * file, char const * part, char const * item, char const * text)
- *
- * open the named file, locate the named part and return the named
- * item text, if present; return alternative text if the file part
- * or item is missing; the calling function must preserve returned
- * text because it may be over-written on successive calls;
- *
- *--------------------------------------------------------------------*/
-
-char const * configstring (char const * file, char const * part, char const * item, char const * text)
-
-{
- FILE *fp;
- if ((!file) || (!part) || (!item))
- {
- return (text);
- }
- if ((fp = fopen (file, "rb")))
- {
- for (c = getc (fp); c != EOF; discard (fp))
- {
- while (isblank (c))
- {
- c = getc (fp);
- }
- if (c != '[')
- {
- continue;
- }
- do
- {
- c = getc (fp);
- }
- while (isblank (c));
- if (!compare (fp, part))
- {
- continue;
- }
- if (c != ']')
- {
- continue;
- }
- for (discard (fp); (c != '[') && (c != EOF); discard (fp))
- {
- while (isblank (c))
- {
- c = getc (fp);
- }
- if (c == ';')
- {
- continue;
- }
- if (!compare (fp, item))
- {
- continue;
- }
- if (c != '=')
- {
- continue;
- }
- do
- {
- c = getc (fp);
- }
- while (isblank (c));
- collect (fp);
- text = strdup (buffer);
- break;
- }
- break;
- }
- fclose (fp);
- }
- return (text);
-}
-
-/*====================================================================*
- *
- * unsigned confignumber (char const * file, char const * part, char const * item, unsigned number)
- *
- * open the named file, locate the named part and return the named
- * item as an unsigned integer, if present; return a default number
- * if the file, part or item is missing;
- *
- *--------------------------------------------------------------------*/
-
-unsigned confignumber (char const * file, char const * part, char const * item, unsigned number)
-
-{
- unsigned value = 0;
- char const * string = configstring (file, part, item, "");
- if ((string) && (* string))
- {
- while (isdigit (* string))
- {
- value *= 10;
- value += * string++ - '0';
- }
- if (! (* string))
- {
- number = value;
- }
- }
- return (number);
-}
-
-/*====================================================================*
- *
- * unsigned confignumber_range (char const * file, char const * part, char const * item, unsigned number, unsigned min, unsigned max)
- *
- * open the named file, locate the named part and return the named
- * item as an unsigned integer, if present; return a default number
- * if the file, part or item is missing or item is out of range;
- *
- *--------------------------------------------------------------------*/
-
-unsigned confignumber_range (char const * file, char const * part, char const * item, unsigned number, unsigned min, unsigned max)
-
-{
- unsigned value = 0;
- char const * string = configstring (file, part, item, "");
- if ((string) && (* string))
- {
- while (isdigit (* string))
- {
- value *= 10;
- value += * string++ - '0';
- }
- if (! (* string))
- {
- if ((value >= min) && (value <= max))
- {
- number = value;
- }
- }
- }
- return (number);
-}
-
-/*====================================================================*
- *
- * int main (int argc, char const * argv []);
- *
- * demo/test program; arguments are file, part, item and text in
- * that order; you can construct your own configuration file and
- * observe behaviour;
- *
- *--------------------------------------------------------------------*/
-
-#if 0
-
-#include <stdio.h>
-
-int main (int argc, char const * argv [])
-
-{
- char const * text = configstring (argv [1], argv [2], argv [3], argv [4]);
- printf ("file=[%s] part=[%s] item=[%s] text=[%s]\n", argv [1], argv [2], argv [3], text);
- return (0);
-}
-
-#endif
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * config.h - configuration file definitions and declarations;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef CONFIG_HEADER
-#define CONFIG_HEADER
-
-/*====================================================================*
- * functions;
- *--------------------------------------------------------------------*/
-
-char const * configstring (char const * file, char const * part, char const * item, char const * text);
-unsigned confignumber (char const * file, char const * part, char const * item, unsigned number);
-unsigned confignumber_range (char const * file, char const * part, char const * item, unsigned number, unsigned min, unsigned max);
-
-/*====================================================================*
- * end definitions;
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-config2cfg(1) Qualcomm Atheros Open Powerline Toolkit config2cfg(1)
-
-NAME
- config2cfg - Atheros Configuration File Converter
-
-SYNOPSIS
- config2cfg [options] file [file] [...]
-
-DESCRIPTION
- The config2cfg program converts an SDRAM configuration file used by the Windows Device Manager to the configuration file
- format used by the Qualcomm Atheros Powerline Toolkit.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- There are no options.
-
-EXPLANATION
- The Windows Device Manager format consists of 64 ASCII hexadecomal characters. Files usually have a .config extension.
- File size is at least 64 characters. Excess characters are ignored in input. This means that files can be modified
- using any text editor and there is no way to detect modification. From a programmin standpoint, ASCII-to-binary conver‐
- tion and checksum computation is required on input and binary-to-ASCII conversion iw required on output.
-
- The Atheros Powerline Toolkit format consists of 32 binary bytes plus a 4 byte (32 bit) checksum. Files usually have a
- .cfg extension. File size is always 36 characters. The files can be edited using any hex editor but a new checksum must
- be computed and inserted after any change. No conversion or computation is required on input or output. Input is ready
- for direct insertion into a VS_SET_SDRAM message.
-
- Programs int6k and int6kf expect this latter format and so you can use this program determine if a given file has the
- proper format.
-
-OPTIONS
- file The filename of a Windows Device Manager SDRAM configuration file. The file is re-written such that the filename
- is preserved but the contents are not. Windows Device Manager SDRAM configuration files usually have a .config
- extension but the program makes no assumption based on filename and does not enforce any filename conventions.
-
- -q Suppresses printing of progress messages. There are no progress messages in this version.
-
- -v Print additional information. There is no additional information printed in this version.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-EXAMPLES
- The following example reads file abc.cfg and validates it. The message shown indicates that the configuration file is
- the correct size and has a checksums and there are no read errors.
-
- > chkcfg abc.cfg
- chkcfg: abc.cfg looks good
-
- The following example reads three files in succession and reports on each one. You can suppress good news with the -q
- option.
-
- # chkcfg abc.cfg def.cfg ghi.cfg
- chkcfg: abc.cfg looks good
- chkcfg: def.cfg is corrupt
- chkcfg: ghi.cfg looks good
-
- The following example displays the SDRAM configuration values in all files having names that match the wildcard pattern
- sdram*.cfg. We can confirm that the values inside are correct for their filenames. Program output could have been sent
- to a file and saved for later reference.
-
- # chknvm -qv sdram*.cfg
- ------- sdram32.cfg -------
- SIZE=0x02000000 (32mb)
- CONF=0x00143188
- TIM0=0x01E1D491
- TIM1=0x000883D6
- CNTRL=0x00003089
- REF=0x00000366
- CLOCK=0x00000001
- ------- sdram16.cfg -------
- SIZE=0x01000000 (16mb)
- CONF=0x00142F68
- TIM0=0x0115124E
- TIM1=0x000883D6
- CNTRL=0x00003089
- REF=0x00000493
- CLOCK=0x00000001
-
-DISCLAIMER
- The SDRAM file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information
- is not available. Qualcomm Atheros reserves the right to change the file structure or content in future firmware
- releases without any obligation to notify or compensate users of this program.
-
-SEE ALSO
- int6k(1), int6kf(1), modpib(1), chknvm(1), chkpib(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 config2cfg(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * coqos.h - Qualcomm Atheros Definitions and Declarations;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef COQOS_HEADER
-#define COQOS_HEADER
-
-/*====================================================================*
- * custom heder files;
- *--------------------------------------------------------------------*/
-
-#include "../plc/rules.h"
-
-/*====================================================================*
- * network classification rule structure;
- *--------------------------------------------------------------------*/
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
-struct __packed connection
-
-{
- uint32_t REQ_ID;
- uint32_t RSVD;
- uint8_t APP_DA [6];
- uint8_t RSVD2;
- struct __packed
- {
- uint8_t MOPERAND;
- uint8_t NUM_CLASSIFIERS;
- struct MMEClassifier CLASSIFIERS [RULE_MAX_CLASSIFIERS];
- }
- rule;
- struct __packed
- {
- uint16_t CSPEC_VERSION;
- uint8_t CONN_CAP;
- uint8_t CONN_COQOS_PRIO;
- uint16_t CONN_RATE;
- uint32_t CONN_TTL;
- }
- cspec;
-};
-
-struct __packed conn_info
-
-{
- uint8_t SNID;
- uint16_t CID;
- uint8_t STEI;
- uint8_t DTEI;
- uint8_t LLID;
- uint8_t RSVD;
- uint16_t CSPECVERSION;
- uint8_t CONN_CAP;
- uint8_t CONN_COQOS_PRIO;
- uint16_t CONN_RATE;
- uint32_t CONN_TTL;
- uint16_t BW_USED;
-};
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-coqos_add(1) Qualcomm Atheros Open Powerline Toolkit coqos_add(1)
-
-NAME
- coqos_add - Add a managed data stream
-
-SYNOPSIS
- coqos_add action priority rate ttl operand condition [condition] [...] [device] [...]
-
-DESCRIPTION
- This page is under construction.
-
- Add a managed stream to one or more powerline devices using the VS_CONN_ADD message. Consult the Qualcomm Atheros
- Firmware Technical Reference Manual for a description of this vendor specific message type.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-BACKGROUND
- Bandwidth management prioritizes streams so that data from lowest priority stream is dropped first whenever one of the
- following conditions is detected. This ensures that the remaining streams continue operate at their full pontential.
-
- Degraded line condition
- The channel degrades to the point where the available PHY rate from the transmitter to the receiver is too low due
- to the variability of the power line.s characteristics.
-
- Over subscription
- Too much data is being sent per second, resulting in packet loss due to excessive collisions due to excessive
- channel oversubscription.
-
- Lack of channel Capacity
- On starting new source there is not enough channel capacity to support it.
-
-OPTIONS
- -e Redirects stderr messages to stdout. By convention progress messages and error messages are printed on stderr
- while primary program output is printed on stdout. This option prints all output on stdout in cases where this is
- desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -q Suppresses status messages on stderr.
-
- -r Display relative memory offsets on output. This option is the default.
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -?,--help
- Displays program help information on stderr. This option takes precedence over all other options on the command
- line except version information.
-
- -!,--version
- Displays program version information on stderr. This option takes precedence over all other options on the com‐
- mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
-
-ARGUMENTS
- action The action taken for frames that satisfy the selection criteria. Valid actions are "CAP0", "CAP1", "CAP2", "CAP3"
- to specify the channel access priority queue. CAP0 and CAP1 are for best effort data. CAP2 is for video and non
- urgent MMEs. CAP3 is for voice, urgent MMEs and control messages such as IGMP and MLD.
-
- priority
- The relative priority of this stream. Valid values are 0 through 15 where 0 is the lowest priority and 15 is the
- highest.
-
- destination
- The destination MAC address.
-
- rate The average expected data rate for this stream. Valid values are 1 to 9000 where units are in 10kbps so the mini‐
- mum rate is 10kbps and the maximum rate is 90mbps.
-
- ttl The time to live for this stream. Valid values are 10000 to 2000000 where units are in microseconds so the mini‐
- mum is time is 10 milliseconds and the maximum time is 2 seconds.
-
- operand
- The operand specifies the logical relationship between conditions before the action to be taken. Valid operands
- are listed and described under OPERANDS.
-
- condition
- A conditional expression consisting of a field, operator and value. See CONDITIONS for more information.
-
- device The MAC address of some powerline device. More than one address may be specified on the command line. If more
- than one address is specified then operations are performed on each device in turn. The default address is
- "local". See DEVICES for more information.
-
-CONDITIONS
- A condition consists of a field, an operator and a value. One condition is required but three are permitted. Condition
- order is not important but all conditions must appear after the operand and before the control.
-
- field The field is the part of the Ethernet frame to be examined. Some fields are not valid for some actions but this
- program does not enforce such rules since validation is performed by runtime firmware on each device. Recognized
- fields are listed and described under FIELDS.
-
- operator
- The operator specifies the relationsip that must exist between the field and value in order for the condition to
- evaluate True. Currently, only equality operators are supported. Valid operators are listed and described under
- OPERATORS.
-
- value The value must be appropriate to the field type. Some fields are MAC or IP addresses, some are integers, some are
- bitmaps and others are states. Integers and bitmaps may be expressed in binary, decimal or hexadecimal format.
- Binary values staRt with 0b. Hexadecimal values start with 0x. States are expressed using keywords. Users are
- responsible for knowing how many bits are significant for each type of value. Valid values are described along
- with fields under FIELDS.
-
-OPERANDS
- The operand indicates the logical relationship that must exist between conditions in the rule set before the action is
- applied to a frame. Operands are expressed as discrete alphanumeric strings entered in upper, lower or mixed character
- case. Failure to enter a known operand will result in an error message that lists all possible operands. They are posi‐
- ton sensitive. One operand is allowed and it must appear after the action and before any condition.
-
- Any Apply the action to frames that satisfy any of the conditions. This is equivalent to the logical or operation.
-
- All Apply the action to frames that satisfy all of the conditions. This is equivalent to the logical and operation.
-
- Always Apply the action to all frames, regardless of any and all conditions that may be specified.
-
-FIELDS
- Fields indicate the portion of the frame that is inspected during selection and the size and format of the value permited
- in the condition statement. They are expressed as discrete alphanumeric strings entered in upper, lower or mixed charac‐
- ter case. Failure to enter a known field will result in an error message that lists all possible fields.
-
- ET A 16-bit Ethertype expressed in decimal, hexadecimal or binary. The format is described in IEEE Standard 802-2001
- [4].
-
- EthDA A 48-bit Ethernet destination address expressed in hexadecimal. The format is described in IEEE Standard 802-2001
- [4].
-
- EthSA A 48-bit Ethernet source address expressed in hexadecimal. The format is described in IEEE Standard 802-2001 [4].
-
- VLANUP An 8-bit Ethernet VLAN tag where the lower 3 bits are the User Priority sub-field of a VLAN Tag defined in IEEE
- Std 802.1Q-1998 (Virtual Bridged Local Area Networks) [11]. The upper 5 bits should be zero.
-
- VLANID A 16-bit VLAN identifier where the lower 12 bits are the VLAN Identifier (VID) defined in IEEE Std 802.1Q-1998
- (Virtual Bridged Local Area Networks) [11]. The upper 4 bits should be zero.
-
- IPV4TOS
- An 8-bit Type-of-Service code where the format is defined in the RFC 791 (Internet Protocol) [14].
-
- IPV4PROT
- An 8-bit Ethernet Protocol identifier. The format is defined in the RFC 791 (Internet Protocol) [14].
-
- IPV4SA A 32-bit Internet Protocol source address expressed in dotted-decimal notation. The official format is defined in
- RFC 791 (Internet Protocol) [14]. Our implementation permits empty octets and leading zeros within fields. For
- example, "..." is equivalent to "0.0.0.0 and "127..000.001" is equivalent to "127.0.0.1".
-
- IPV4DA A 32-bit Internet Protocol destination address expressed in dotted-decimal notation. The official format is
- defined in RFC 791 (internet Protocol) [14]. Our implementation permits empty octets and leading zeros within
- fields. For example, "..." is equivalent to "0.0.0.0 and "127..000.001" is equivalent to "127.0.0.1".
-
- IPV6TC An 8-bit Internet Protocol V6 traffic class expressed as defined in RFC 2460 (Internet Protocol Version 6) [17].
-
- IPV6FL A 24-bit IPV6 flow label where the lower 20 bits are the IPv6 Flow Label defined in RFC 2460 (Internat Protocol
- Version 6) [17]. The upper 4 bits should be zero. The value can be entered either as a decimal, binary or hex
- integer.
-
- IPV6SA A 128-bit IPV6 source address expressed as colon-separated hexadecmial quartets (octet pairs). The official for‐
- mat is defined in RFC 2460 (Internet Protocol Version 6) [17]. Our implementation permits multiple empty fields,
- abreviated fields and leading zeros within fields. When multiple empty fields appear, only the right-most occu‐
- rance expands to zeros. For example, "FFFF::DDDD::BBBB::AAAA" is equivalent to
- "FFFF:0000:DDDD:0000:BBBB:0000:0000:AAAA".
-
- IPV6DA A 128-bit IPV6 destination address expressed as colon-separated hexadecimal quartets (octet pairs). The official
- format is defined in RFC 2460 (Internet Protocol Version 6) [17]. Our implementation permits multiple empty
- fields, abbreviated fields and leading zeros within fields. When multiple empty fields appear, only the right-
- most occurance expands to zeros. For example, "AAAA::BBBB::CCCC::DDDD" is equivalent to
- "AAAA:0000:BBBB:0000:CCCC:0000:0000:DDDD".
-
- TCPSP A 16-bit TCP source port as a decimal integer. The format is defined in RFC 793 (Transmission Control Protocol
- [15]).
-
- TCPDP A 16-bit TCP destination port expressed as a decimal integer. The format is defined in RFC 793 (Transmission Con‐
- trol Protocol [15]).
-
- UDPSP A 16-bit UDP source port expressed as a decimal integer. The format is defined in RFC 768 (User Datagram Protocol
- [13]).
-
- UDPDP A 16-bit UDP destination port expressed as a decimal integer. The format is defined in RFC 768 (User Datagram
- Protocol [13]).
-
- IPSP A 16-bit IP source port expressed as a decimal integer. This condition applies to either TCP or UDP packets,
- depending on the protocol used, and is valid only for actions "CAP0", "CAP1", "CAP2", "CAP3" and "Drop".
-
- IPDP A 16-bit IP destination port expressed as a decimal integer. This condition applies to either TCP or UDP packets,
- depending on the protocol used, and is valid only for actions "CAP0", "CAP1", "CAP2", "CAP3" and "Drop".
-
- MME A 24-bit Atheros HomePlugAV Management Message type expressed in hexadecimal. The first byte is the MMV and the
- next two bytes are the MMTYPE for a HomePlug AV frame as defined in the HomePlug AV Specification. The MMTYPE
- will match any MME sub-type (Request; Confirm; Indicate; Response). This field is only valid for action "Boost".
-
-OPERATORS
- An operator indicates an equality between a field and a value. An operator is an alphanumeric string entered in upper,
- lower or mixed character case. Failure to enter a known operator will result in an error message that lists all possible
- operators. Operators are position sensitive and must appear between each field and value.
-
- Is Indicates that the frame field must equal the associated value for the condition to evaluate true.
-
- Not Indicates that the frame field must not equal the associated value for the condition to true true.
-
-STATES
- A state is a special case of value.
-
- True,On,Yes,Present
- Indicates a positive state or presence of some entity. All are equivalent and can be used interchangeably. Dou‐
- ble negatives are permitted so "Is True" is equvalent to "Not False".
-
- False,Off,No,Missing
- Indicates a negative state or absence of some entity. ALl are equivalent and can be used interchangeably. Double
- negatives are permitted so "Is False" is equvalent to "Not True".
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are common or special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros. See the Qual‐
- comm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- The following example adds a temporary stream to device 00:b0:52:BA:BE:01 which will then manage the bandwidth for that
- stream until removed with program coqos_rel.
-
- # coqos_add CAP2 15 5000 200000 any ethda is 192.168.105 00:B0:52:BA:BE:01
-
- This adds a stream to the bandwidth manager that sets all traffic to destination address of 192.168.0.105 as priority 15
- (the highest priority). This would then need to also be sent to each device on the network. Refer to int6krule for more
- details on how to specify conditions.
-
-SEE ALSO
- coqos_info(1), coqos_man(1), coqos_mod(1), coqos_rel(1)
-
-CREDITS
- Bill Wike <bill.wike@qca.qualcomm.com>
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 coqos_add(1)
-
-coqos_info(1) Qualcomm Atheros Open Powerline Toolkit coqos_info(1)
-
-NAME
- coqos_info - CoQoS Stream Utility
-
-SYNOPSIS
- coqos_info [options] type [cid] [limit] [device]
-
-DESCRIPTION
- This page is under construction.
-
- None.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -e Redirects stderr messages to stdout. By convention progress messages and error messages are printed on stderr
- while primary program output is printed on stdout. This option prints all output on stdout in cases where this is
- desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -q Suppresses status messages on stderr.
-
- -r Display relative memory offsets on output. This option is the default.
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -?,--help
- Displays program help information on stderr. This option takes precedence over all other options on the command
- line except version information.
-
- -!,--version
- Displays program version information on stderr. This option takes precedence over all other options on the com‐
- mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
-
-ARGUMENTS
- type The request type. Valid types are "STA", "CID", "RSVD", "VIC", "BW", and "BW". Individual request types are
- described below.
-
- device The MAC address of some powerline device. More than one address may be specified on the command line. If more
- than one address is specified then operations are performed on each device in turn. The default address is
- "local". See DEVICES for more information.
-
-TYPES
- STA Station. Request information on all active connections for this station.
-
- CID number
- Connection identifier. If present, it must be followed by a valid connection identifier. Connection identifiers
- are assigned when the connection is added using program coqos_add. The connection identifier is two bytes where
- byte 0 is the LLID-F and byte 1 is the OrigTEI.
-
- RSVD Reserved. Sets REQ_TYPE = 2 in the mme.
-
- VIC Vicinity. Provide all active connections in the vicinity.
-
- BW number
- Bandwidth. set station to provide info when the limit is exceeded. BW must be followed by a number. This number
- is in units of 10kbps. BWC cancels all previous requests.
-
-DEVICES
- Ethernet MAC addresses are expressed as six hexadecimal octets optionally separated by colon. For example, the Qualcomm
- Atheros Local Management Address (LMA) of "00b052000001" may also be entered as "00:b0:52:00:00:01" or "00b052:000001".
- Addresses are case insensitive and quotes are optional. In addition, some special addresses may be entered by name
- rather than number where names are case sensitive.
-
- all A synonym for the "broadcast" address, described next.
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- will respond to this address.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros. See the Qual‐
- comm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- This command requests connection from the station
-
- # coqos_info STA 00:B0:52:BA:BE:01
-
- This command set the station to provide notification if the bandwidth used exceeds 20mbps
-
- # coqos_info BW 2000 00:B0:52:BA:BE:01
-
-SEE ALSO
- coqos_add(1), coqos_rel(1), coqos_man(1), coqos_mod(1)
-
-CREDITS
- Bill Wike <bill.wike@qca.qualcomm.com>
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 coqos_info(1)
-
-coqos_man(1) Qualcomm Atheros Open Powerline Toolkit coqos_man(1)
-
-NAME
- coqos_man - Set and monitor bandwidth
-
-SYNOPSIS
- coqos_man [options] [device] [...]
-
-DESCRIPTION
- This page is under construction.
-
- Monitors the bandwidth being used and sets a bandwidth limit. If the bandwidth limit is exceeded it will suspend the
- lower priority streams in priority order until the bandwidth being used is less than the limit.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -e Redirects stderr messages to stdout. By convention progress messages and error messages are printed on stderr
- while primary program output is printed on stdout. This option prints all output on stdout in cases where this is
- desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -q Suppresses status messages on stderr.
-
- -r Display relative memory offsets on output. This option is the default.
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -?,--help
- Displays program help information on stderr. This option takes precedence over all other options on the command
- line except version information.
-
- -!,--version
- Displays program version information on stderr. This option takes precedence over all other options on the com‐
- mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
-
-ARGUMENTS
- limit The bandwidth limit, in kbps, expressed as a decimal integer. This argument is required. The range is 10 through
- 90000.
-
- device The MAC address of some powerline device. More than one address may be specified on the command line. If more
- than one address is specified then operations are performed on each device in turn. The default address is
- "local". See DEVICES for more information.
-
-DEVICES
- Ethernet MAC addresses are expressed as six hexadecimal octets optionally separated by colon. For example, the Qualcomm
- Atheros Local Management Address (LMA) of "00b052000001" may also be entered as "00:b0:52:00:00:01" or "00b052:000001".
- Addresses are case insensitive and quotes are optional. In addition, some special addresses may be entered by name
- rather than number where names are case sensitive.
-
- all A synonym for the "broadcast" address, described next.
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- will respond to this address.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros. See the Qual‐
- comm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- The following example suspends streams if the bandwidth used exceeds 20mbps.
-
- # coqos_man 20000 00:B0:52:BA:BE:01
-
-SEE ALSO
- coqos_add(1), coqos_info(1), coqos_mod(1), coqos_rel(1)
-
-CREDITS
- Bill Wike <bill.wike@qca.qualcomm.com>
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 coqos_man(1)
-
-coqos_mod(1) Qualcomm Atheros Open Powerline Toolkit coqos_mod(1)
-
-NAME
- coqos_mod - Suspend or resume a managed data stream
-
-SYNOPSIS
- coqos_mod [options] action cid [device] [...]
-
-DESCRIPTION
- This page is under construction.
-
- Suspend or resume a stream through the bandwidth manager using an Atheros vendor specific VS_MOD_CONN message. This is
- the proper way to stop a stream flowing if the data rate exceeds the available bandwidth. Use program coqos_man to set
- stream bandwidth.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -q Suppresses status messages on stderr.
-
- -r Display relative memory offsets on output. This option is the default.
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -?,--help
- Displays program help information on stderr. This option takes precedence over all other options on the command
- line except version information.
-
- -!,--version
- Displays program version information on stderr. This option takes precedence over all other options on the com‐
- mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
-
-ARGUMENTS
- action A symbol indicating the action to be performed on the stream identified by argument cid. Valid actions are "sus‐
- pend" and "resume". See ACTIONS for an explanation of each action.
-
- cid A connection identifier. (Charlie, expand on this.) Connection ID. 2 byte number to identify the stream to
- delete. Byte 0 is the OrigTEI and byte one is the LLID-F.
-
- device The MAC address of some powerline device. More than one address may be specified on the command line. If more
- than one address is specified then operations are performed on each device in turn. The default address is
- "local". See DEVICES for more information.
-
-ACTIONS
- suspend
- Suspend the identified stream. See argument cid for more information.
-
- resume Resume the identified stream. See argument cid for more information.
-
-DEVICES
- Ethernet MAC addresses are expressed as six hexadecimal octets optionally separated by colon. For example, the Qualcomm
- Atheros Local Management Address (LMA) of "00b052000001" may also be entered as "00:b0:52:00:00:01" or "00b052:000001".
- Addresses are case insensitive and quotes are optional. In addition, some special addresses may be entered by name
- rather than number where names are case sensitive.
-
- all A synonym for the "broadcast" address, described next.
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- will respond to this address.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros. Ethernet MAC
- addresses are six hexadecimal octets optionally separated by colon. For example, the addresses "00b052000001",
- "00:b0:52:00:00:01" and "00b052:000001" are all valid and equivalent. Certain Ethernet device addresses are spe‐
- cial and may be entered by name rather than number.
-
- all A synonym for "broadcast", described next.
-
- broadcast
- A synonym for the standard Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or
- foreign will respond to this address.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- The following example suspends a stream 805. All data in this cid will be discarded and not sent over the channel.
-
- # coqos_mod SPND 805 00:B0:52:BA:BE:01
-
-SEE ALSO
- coqos_add(1), coqos_info(1), coqos_man(1), coqos_rel(1)
-
-CREDITS
- Bill Wike <bill.wike@qca.qualcomm.com>
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 coqos_mod(1)
-
-coqos_rel(1) Qualcomm Atheros Open Powerline Toolkit coqos_rel(1)
-
-NAME
- coqos_rel - Release Bandwidth Management
-
-SYNOPSIS
- coqos_rel [options] cid [device] [...]
-
-DESCRIPTION
- This page is under construction.
-
- Instructs one or more devices to stop managing a stream. Use this program when bandwidth management is no longer needed
- or wanted. Use program coqos_mod to suspend and resume bandwidth management of a stream.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -q Suppresses status messages on stderr.
-
- -r Display relative memory offsets on output. This option is the default.
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -?,--help
- Displays program help information on stderr. This option takes precedence over all other options on the command
- line except version information.
-
- -!,--version
- Displays program version information on stderr. This option takes precedence over all other options on the com‐
- mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
-
-ARGUMENTS
- cid The connection identifier of the affected stream.
-
- device The MAC address of some powerline device. More than one address may be specified on the command line. If more
- than one address is specified then operations are performed on each device in turn. The default address is
- "local". See DEVICES for more information.
-
-DEVICES
- Ethernet MAC addresses are expressed as six hexadecimal octets optionally separated by colon. For example, the Qualcomm
- Atheros Local Management Address (LMA) of "00b052000001" may also be entered as "00:b0:52:00:00:01" or "00b052:000001".
- Addresses are case insensitive and quotes are optional. In addition, some special addresses may be entered by name
- rather than number where names are case sensitive.
-
- all A synonym for the "broadcast" address, described next.
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- will respond to this address.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- The next example instructs device 00:B0:52:BA:BE"01 to release stream 803. The stream will the remain unmanaged indefi‐
- nitely.
-
- # coqos_rel 803 00:B0:52:BA:BE:01
-
-SEE ALSO
- coqos_add(1), coqos_info(1), coqos_man(1), coqos_mod(1)
-
-CREDITS
- Bill Wike <bill.wike@qca.qualcomm.com>
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- Charles Maier <cmaier@qca.qualcomm.com> "
-
-open-plc-utils-0.0.3 Mar 2014 coqos_rel(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * debug.h - Debugging Definitions and Declarations;
- *
- * this file is a subset of the original that includes only those
- * definitions and declaration needed for toolkit programs;
- *
- *. Qualcomm Atheros HomePlug AV Powerline Toolkit
- *: Copyright (c) 2009-2013 by Qualcomm Atheros Inc. ALL RIGHTS RESERVED;
- *; For demonstration and evaluation only; Not for production use.
- *
- *--------------------------------------------------------------------*/
-
-#ifndef DEBUG_HEADER
-#define DEBUG_HEADER
-
-/*====================================================================*
- * constants;
- *--------------------------------------------------------------------*/
-
-#define QUALCOMM_DEBUG 1
-#define QUALCOMM_TRACE 1
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#if QUALCOMM_TRACE
-#define EVENT(s) printk(KERN_DEBUG "---[ %s ]---\n", (s))
-#define ENTER printk(KERN_DEBUG "-->[ %s:%d ]\n", __func__,__LINE__)
-#define ABORT printk(KERN_DEBUG "<--( %s:%d )\n", __func__,__LINE__)
-#define LEAVE printk(KERN_DEBUG "<--[ %s:%d ]\n", __func__,__LINE__)
-#define CRUMB printk(KERN_DEBUG "... %s:%d\n",__func__,__LINE__)
-#else
-#define EVENT {}
-#define ENTER {}
-#define ABORT {}
-#define LEAVE {}
-#define CRUMB {}
-#endif
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#if QUALCOMM_DEBUG
-#define address(e) if (!(e)) { printk ("%s(%d): address %s is null\n",__func__,__LINE__,#e); }
-#define confirm(e) if (!(e)) { printk ("%s(%d): assertion %s is wrong\n",__func__,__LINE__, #e); }
-#else
-#define address(e) {}
-#define confirm(e) {}
-#endif
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-edru(1) Qualcomm Atheros Open Powerline Toolkit edru(1)
-
-NAME
- edru - Qualcomm Atheros Ethernet II Data Read Utility
-
-SYNOPSIS
- edru [options] [>stdout]
-
-DESCRIPTION
- Listen for incoming Ethernet II frames and write frame data, less header information, to stdout as a binary data stream.
- Since frame data can contain anything, users should direct output to a file or pipe it through some type of filter to
- prevent corruption of the terminal session. If all incoming data is known to be ASCII then directing stdout to the con‐
- sole should not cause any problems.
-
- This program can be used to test remote Atheros UART-enabled powerline devices. Remote device package serial data from
- their local host as Ethernet II frames and forwared them over the powerline to a specific destination. The destination
- must be the Ethernet address of the receiving host. This program reads such frames, discards the frame headers and
- writes the frame dat on stdout. Data should appear exactly as sent by the remote hos.
-
-OPTIONS
- -e ethertype
- The protocol (or ethertype) of interest expressed as a 16-bit hexadecimal integer. Prefix "0x" is optional. This
- filters out frames having any other ethertype. The default is ETH_P_802_2 as defined in if_ether.h.
-
- -i interface
- The host interface used to read frames. The default is "eth1" because most people use "eth0" as their principle
- network connection; however, if the string "PLC" is defined in the environment then it will over-ride the program
- default. Any interface specified on the command line will over-ride the default.
-
- -q Quiet mode. This option has no effect at this time.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is 50 milliseconds.
-
- -v Verbose mode. This option has no effect at this time.
-
-ARGUMENTS
- None.
-
-EXAMPLES
- The following example monitors host interface eth1 for incoming 802.2 Ethernet frames and writes frame data to stdout.
- In this case, stdout is the console. Frame data is written, as it arrives, and forms a single output stream. Directing
- output to the console may corrupt your terminal session, forcing you to close the console window and open another one.
-
- # edru -ieth1
-
- The next example does the same thing but directs output to file test.log. The output file may be inspected using a
- binary hex editor. The programs continues to read and write until interrupted using ctrl-c or ctrl-z.
-
- # edru -ieth1 > test.log
-
- The next example does the same thing but pipes output into program hexdmp which displays data in hexadecimal format.
- This prevents terminal session corruptions caused by binary data. Programhexdmp may not be provided with the toolkit.
-
- # edru -ieth1 | hexdmp
-
-SEE ALSO
- amp(1), efsu(1), hpav(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 edru(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * edru.c - Qualcomm Atheros Ethernet II Data Read Utility
- *
- * Listen for incoming Ethernet II frames and write frame data to
- * stdout as a continuous binary data stream. Since frame data can
- * contain anything, users should send program output to a file or
- * pipe it through a filter program to prevent corruption of the
- * terminal session. If all incoming data is ASCII then directing
- * stdout to the console should not cause any problems.
- *
- * this program can be used as a data target when testing AR6405
- * UART applications; use program edsu to send files from a remote
- * host and this program to display or save them;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <fcntl.h>
-#include <stdio.h>
-#include <limits.h>
-#include <ctype.h>
-#include <unistd.h>
-#include <stdint.h>
-#include <stdlib.h>
-#include <string.h>
-#include <errno.h>
-
-#ifdef __linux__
-#include <net/if.h>
-#include <net/if_arp.h>
-#include <netpacket/packet.h>
-#include <signal.h>
-#endif
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#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/error.h"
-#include "../ether/channel.h"
-
-/*====================================================================*
- * custom source files;
- *--------------------------------------------------------------------*/
-
-#ifndef MAKEFILE
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-#include "../tools/hexdump.c"
-#include "../tools/hexdecode.c"
-#include "../tools/hexstring.c"
-#include "../tools/basespec.c"
-#include "../tools/uintspec.c"
-#include "../tools/todigit.c"
-#include "../tools/error.c"
-#endif
-
-#ifndef MAKEFILE
-#include "../ether/channel.c"
-#include "../ether/openchannel.c"
-#include "../ether/closechannel.c"
-#include "../ether/sendpacket.c"
-#include "../ether/readpacket.c"
-#endif
-
-/*====================================================================*
- * program constants;
- *--------------------------------------------------------------------*/
-
-#define PLCDEVICE "PLC"
-#define EDRU_ETHERTYPE ETH_P_802_2
-
-/*====================================================================*
- *
- * int main (int argc, char * argv[]);
- *
- *
- *--------------------------------------------------------------------*/
-
-int main (int argc, char const * argv [])
-
-{
- extern struct channel channel;
- struct ethernet_frame frame;
- signed length;
- static char const * optv [] =
- {
- "e:i:qt:v",
- PUTOPTV_S_DIVINE,
- "Qualcomm Atheros Ethernet II Data Read Utility",
- "e x\tethertype is (x) [" LITERAL (EDRU_ETHERTYPE) "]",
-
-#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
-
- "q\tsuppress normal output",
- "t n\tread timeout is (n) milliseconds [" LITERAL (CHANNEL_FOREVER) "]",
- "v\tverbose messages on stdout",
- (char const *) (0)
- };
- signed c;
- channel.type = EDRU_ETHERTYPE;
- channel.timeout = CHANNEL_FOREVER;
- if (getenv (PLCDEVICE))
- {
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (getenv (PLCDEVICE));
-
-#else
-
- channel.ifname = strdup (getenv (PLCDEVICE));
-
-#endif
-
- }
- optind = 1;
- while ((c = getoptv (argc, argv, optv)) != -1)
- {
- switch (c)
- {
- case 'e':
- channel.type = (uint16_t)(basespec (optarg, 16, sizeof (channel.type)));
- break;
- case 'i':
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (optarg);
-
-#else
-
- channel.ifname = optarg;
-
-#endif
-
- break;
- case 'q':
- _setbits (channel.flags, CHANNEL_SILENCE);
- break;
- case 't':
- channel.timeout = (signed)(uintspec (optarg, 0, UINT_MAX));
- break;
- case 'v':
- _setbits (channel.flags, CHANNEL_VERBOSE);
- break;
- default:
- break;
- }
- }
- argc -= optind;
- argv += optind;
- if (argc)
- {
- error (1, ECANCELED, ERROR_TOOMANY);
- }
- openchannel (&channel);
- while ((length = readpacket (&channel, &frame, sizeof (frame))) > 0)
- {
- write (STDOUT_FILENO, frame.frame_data, ntohs (frame.frame_type));
- }
- closechannel (&channel);
- return (0);
-}
-
-
-
-edsu(1) Qualcomm Atheros Open Powerline Toolkit edsu(1)
-
-NAME
- edsu - Qualcomm Atheros Ethernet II Data Send Utility
-
-SYNOPSIS
- edsu [options] file [file] [...]
-
-DESCRIPTION
- Send one or more files as a series of Ethernet II (IEEE 802.2) frames. Input files are sequentially read and sent over
- network as a continuous stream of standard Ethernet frames. All frames (except perhaps the last frame for each file)
- will contain 1500 bytes of file data. The receiving host may elect to concatenate frame data as frames arrive.
-
- This program can be used to test remote Atheros UART-enabled powerline devices. The remote UART-enabled powerline device
- will remove frame headers and forward frame data to the local host as a serial data stream. No protocol is imposed on
- the serial data stream. For example, there is no indication of frame or file start or end within the stream. The ret‐
- mote powerline device must be in Transparent Mode and configured to accept frames from the sending host. The remote host
- must also be ready to handle serial data as it arrives.
-
-OPTIONS
- -d xx:xx:xx:xx:xx:xx
- The Ethernet address of the destination device. If the destination device is a Linux, Mac OSX or Windows host
- then program edru can be used to receive and write frame data to stdout as a serial stream. If the destination
- device is an Atheros UART-enabled powerline device then received frame data will be converted to a serial data
- stream and forwared to the host connected to that device. In that case, the UART-enabled powerline device must be
- programmed with the address of the sending host.
-
- -e ethertype
- The protocol (or ethertype) of interest expressed as a 16-bit hexadecimal integer. Prefix "0x" is optional. This
- filters out frames having any other ethertype. The default is ETH_P_802_2 as defined in if_ether.h.
-
- -i interface
- The host interface used to send frames. The program default is "eth1" on Linux, "en0" on MacOSX or OpenBSD and
- "2" on Windows; however, if environment string "PLC" is defined, it supersedes the program default. Any inter‐
- face specified on the command line supersedes all others.
-
- -p seconds
- Pause time in seconds between sending each frame. Pauses may be necessary when the destination device is a UART-
- enabled powerline device because each frame must be converted and transmitted serially from the remote device to
- the remote host. Permitted pause times are 0 through 255 seconds. The default is 0.
-
- -q Quiet mode. This option has no effect at this time.
-
- -v Verbose mode. This option displays outgoing frames on stdout in hexadecimal dump format as they are sent.
-
-ARGUMENTS
- file The name of a text or binary file accessible from the local host.
-
-EXAMPLES
- The following example sends files abc.txt then def.bin to the remote Atheros UART-enabled powerline device
- 00:B0:52:BA:BE:55 over network interface eth1. There is a constant 1 second delay between each frame sent so that remote
- UART-enabled powerline devices have time to convert and forward each frame to their local host.
-
- # edsu -ieth1 -d 00:b0:52:BA:BE:55 abc.txt def.bin
-
-SEE ALSO
- amp(1), edru(1) efsu(1),
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 edsu(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * edsu.c - Qualcomm Atheros Ethernet II Data Send Utility
- *
- * send one or more files over Ethernet using IEEE 802.2 Ethernet
- * Frames;
- *
- * this program can be used as a data source when testing AR6405
- * UART applications; use this program to send files and program
- * edru to read and display or save them at the other end;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <stdlib.h>
-#include <limits.h>
-#include <memory.h>
-#include <signal.h>
-#include <unistd.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#include "../tools/getoptv.h"
-#include "../tools/putoptv.h"
-#include "../tools/memory.h"
-#include "../tools/number.h"
-#include "../tools/error.h"
-#include "../tools/files.h"
-#include "../tools/flags.h"
-#include "../ether/ether.h"
-#include "../ether/channel.h"
-
-/*====================================================================*
- * custom source files;
- *--------------------------------------------------------------------*/
-
-#ifndef MAKEFILE
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-#include "../tools/efreopen.c"
-#include "../tools/basespec.c"
-#include "../tools/uintspec.c"
-#include "../tools/todigit.c"
-#include "../tools/hexdump.c"
-#include "../tools/hexencode.c"
-#include "../tools/error.c"
-#endif
-
-#ifndef MAKEFILE
-#include "../ether/channel.c"
-#include "../ether/openchannel.c"
-#include "../ether/closechannel.c"
-#include "../ether/readpacket.c"
-#include "../ether/sendpacket.c"
-#endif
-
-/*====================================================================*
- * program constants;
- *--------------------------------------------------------------------*/
-
-#define EDSU_INTERFACE "PLC"
-#define EDSU_ETHERTYPE ETH_P_802_2
-#define EDSU_PAUSE 0
-
-/*====================================================================*
- *
- * signed function (struct channel * channel, unsigned pause, signed fd);
- *
- * read a file and transmit it over network as a stream of Ethernet
- * frames; pause between frames to prevent over-loading the remote
- * host;
- *
- *
- *--------------------------------------------------------------------*/
-
-signed function (struct channel * channel, unsigned pause, signed fd)
-
-{
- struct ethernet_frame frame;
- signed length = sizeof (frame.frame_data);
- memcpy (frame.frame_dhost, channel->peer, sizeof (frame.frame_dhost));
- memcpy (frame.frame_shost, channel->host, sizeof (frame.frame_shost));
- while ((length = read (fd, frame.frame_data, sizeof (frame.frame_data))) > 0)
- {
- frame.frame_type = htons (length);
- if (length < ETHERMIN)
- {
- length = ETHERMIN;
- }
- length += ETHER_HDR_LEN;
- if (sendpacket (channel, &frame, length) < 0)
- {
- error (1, errno, CHANNEL_CANTSEND);
- }
- sleep (pause);
- }
- return (0);
-}
-
-/*====================================================================*
- *
- * int main (int argc, char const * argv []);
- *
- *
- *
- *--------------------------------------------------------------------*/
-
-int main (int argc, char const * argv [])
-
-{
- extern struct channel channel;
- static char const * optv [] =
- {
- "e:d:i:p:qv",
- "file [file] [...]",
- "Qualcomm Atheros Ethernet II Data Send Utility",
- "e x\tethertype is (x) [" LITERAL (EDSU_ETHERTYPE) "]",
- "d x\tdestination address is (x) [00:B0:52:00:00:01]",
-
-#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
-
- "p n\tpause (n) seconds between frames [" LITERAL (EDSU_PAUSE) "]",
- "q\tquiet mode",
- "v\tverbose mode",
- (char const *)(0)
- };
- unsigned pause = EDSU_PAUSE;
- signed c;
- if (getenv (EDSU_INTERFACE))
- {
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (getenv (EDSU_INTERFACE));
-
-#else
-
- channel.ifname = strdup (getenv (EDSU_INTERFACE));
-
-#endif
-
- }
- channel.type = EDSU_ETHERTYPE;
- while ((c = getoptv (argc, argv, optv)) != -1)
- {
- switch (c)
- {
- case 'e':
- channel.type = (uint16_t)(basespec (optarg, 16, sizeof (channel.type)));
- break;
- case 'd':
- if (!hexencode (channel.peer, sizeof (channel.peer), optarg))
- {
- error (1, errno, "%s", optarg);
- }
- break;
- case 'i':
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (optarg);
-
-#else
-
- channel.ifname = optarg;
-
-#endif
-
- break;
- case 'p':
- pause = (unsigned)(uintspec (optarg, 0, UCHAR_MAX));
- break;
- case 'q':
- _setbits (channel.flags, CHANNEL_SILENCE);
- break;
- case 'v':
- _setbits (channel.flags, CHANNEL_VERBOSE);
- break;
- default:
- break;
- }
- }
- argc -= optind;
- argv += optind;
- openchannel (&channel);
- if (!argc)
- {
- function (&channel, pause, STDIN_FILENO);
- }
- while ((argc) && (* argv))
- {
- if (efreopen (* argv, "rb", stdin))
- {
- function (&channel, pause, fileno (stdin));
- }
- argc--;
- argv++;
- }
- closechannel (&channel);
- exit (0);
-}
-
-
-
-efbu(1) Qualcomm Atheros Open Powerline Toolkit efbu(1)
-
-NAME
- efbu - Ethernet Frame Blast Utility
-
-SYNOPSIS
- efbu [options]
-
-DESCRIPTION
- Send IP broadcast frames of maximum length at maximum rate over a given interface for a given period in seconds. The
- maximum frame length is ETHER_MAX_LEN as defined in <net/ethernet.h>. The maximum rate is limited by the host processor
- type, the number of active processes, the interface hardware and so on. This program does the best it can within the
- given execution environment. Multi-processosr and faster hosts should see at least 85mb. Single-processor and slower
- hosts will see less.
-
- This program is for test purposes. It has no practical application beyond flooding the network with useless traffic and
- annoying the network administrator. Don't abuse it.
-
-OPTIONS
- -b value
- Byte value used to pad Ethernet frames. Valid values are 0 through 255 and may be specified in decimal, hexadeci‐
- mal or binary. Hexadecimal is prefixed with 0x. Binary is prefixed with 0b. The default is 0xAA or 0b10101010.
-
- -d address
- Replace the destination Ethernet address of each transmitted frame with the option argument. The destination
- address consists of 12 hex digits in upper, lower or mixed case. Octets may be seperated with colons for clarity
- but colons are not required.
-
- -e ethertype
- The ethertype expressed as a 16-bit hexadecimal integer. Prefix "0x" is optional. The default is ETH_P_802_2 as
- defined in if_ether.h.
-
- -h Replace the source address of each transmitted frame with the Ethernet address of the host interface used to send
- the frame. This allows frames to be sent correctly from any host interface. Use option -i to specify an interface.
-
- -i interface
- The host interface used to send frames. The default is "eth1" because most people use "eth0" as their principle
- network connection; however, if the string "PLC" is defined in the environment then it will over-ride the program
- default. Any interface specified on the command line will over-ride the default.
-
- -p milliseconds
- The pause time in milliseconds. The program pause this long after sending each frame. If 0 then the network will
- be flooded with frames for the duration. The default is 50 milliseconds which results in about 20 frames per sec‐
- ond for the duration. Permitted values are 0 through UINT_MAX as defined in <limits.h>.
-
- -t milliseconds
- The blast duration in milliseconds. The default is 1000 milliseconds seconds which is about 1 second. Permitted
- values are 0 through UINT_MAX as defined in <limits.h>.
-
- -v Print transmitted frames in hex dump format on stdout as they are sent. This reduces network transmission rate, as
- a consequence.
-
-ARGUMENTS
- None.
-
-EXAMPLES
- The following example sends an IP broadcast frame of maximum length on host interface eth2 for a duration of 20 seconds.
- The destination address will be the Ethernet broadcast address because option -d is omitted. The source address will be
- the host Ethernet interface address because option -h is present. Frames will be send at about 20 frames per second
- because option -p is not present.
-
- # efbu -ieth2 -t20000 -h -e0800
-
- The outgoing frame will look something like this when captured with wireshark.
-
- 00000000 FF FF FF FF FF FF 00 50 04 D3 4E F2 08 00 AA AA .......P..N.....
- 00000010 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000020 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000030 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000040 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000050 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000060 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000070 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000080 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000090 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000000A0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000000B0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000000C0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000000D0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000000E0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000000F0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000100 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000110 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000120 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000130 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000140 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000150 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000160 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000170 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000180 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000190 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000001A0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000001B0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000001C0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000001D0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000001E0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000001F0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000200 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000210 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000220 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000230 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000240 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000250 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000260 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000270 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000280 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000290 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000002A0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000002B0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000002C0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000002D0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000002E0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000002F0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000300 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000310 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000320 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000330 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000340 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000350 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000360 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000370 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000380 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000390 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000003A0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000003B0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000003C0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000003D0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000003E0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000003F0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000400 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000410 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000420 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000430 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000440 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000450 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000460 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000470 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000480 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000490 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000004A0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000004B0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000004C0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000004D0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000004E0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000004F0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000500 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000510 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000520 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000530 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000540 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000550 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000560 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000570 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000580 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 00000590 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000005A0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000005B0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000005C0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000005D0 AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA AA ................
- 000005E0 AA AA AA AA AA AA AA AA AA AA ..........
-
-SEE ALSO
- amp(1), efsu(1), hpav(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 efbu(1)
-
-efeu(1) Qualcomm Atheros Open Powerline Toolkit efeu(1)
-
-NAME
- efeu - HomePlug AV Packet Reflector
-
-SYNOPSIS
- efeu [options]
-
-DESCRIPTION
- Read and reflect 802.3 Ethernet messages addressed to this host or the broadcast address. Do not display reflected
- frames.
-
- The program is one example of a simple packet listener. Engineers and software developers can extend it to build custom
- sniffers or servers. The framework is present but additional features must be added.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -e ethertype
- The protocol (or ethertype) of interest expressed as a 16-bit hexadecimal integer. Prefix "0x" is optional. This
- filters out frames having any other ethertype. The default is ETH_P_802_2 as defined in if_ether.h.
-
- -i interface
- Names the host ethernet interface to watch. The named interface, such as eth0, eth1 and so on, must be connected
- to a HomePlug AV ethernet-to-powerline bridge adapter to receive any HomePlug AV traffic. The default interface
- is eth1.
-
- -q Quiet mode. Suppress the printing of the normal message descriptions on stdout.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is 50 milliseconds.
-
- -v Verbose mode. Displays incoming frames in hexadecimal dump format on stdout. This option is independent of
- option -a which prints VS_ARPC message text on stderr.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line. -!,
- --version Print program version information on stdout. This option takes precedence over other options on the
- command line. Use this option when sending screen dumps to Atheros Technical Support so that they know exactly
- which version of the Linux Toolkit you are using. See the HomePlug AV Specification for a description of all
- HomePlug AV message types. See the Qualcomm Atheros INT6000 Firmware Reference Manual for a description of
- Atheros Vendor Specific message types.
-
-EXAMPLES
- The following command monitors the default interface eth1 for HomePlug AV traffic and dumps detected frames on the con‐
- sole as they occur. Terminate the foreground process by typing ^C or ^Z at the console. This program is usually run in
- a separate console window when performing other toolkit operations.
-
- # efeu
-
- The following command monitors host interface eth4 for incoming HomePlug AV frames and dumps writes them to file
- efeu.log. Frames are printed in hexadecimal dump format because option -v is present. Terminate the foreground process
- by typing ^C or ^Z at the console.
-
- # efeu -v -i eth4 > efeu.log
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information is not available. Qualcomm Atheros reserves the right to modify management mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- plc(1), efru(1), efsu(1), hpav(1), mme(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 efeu(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * edeu.c - Ethernet Frame Echo Utility
- *
- * Listen for incoming Ethernet II frames and write frame data to
- * stdout as a continuous binary data stream. Since frame data can
- * contain anything, users should send program output to a file or
- * pipe it through a filter program to prevent corruption of the
- * terminal session. If all incoming data is ASCII then directing
- * stdout to the console should not cause any problems.
- *
- * this program can be used as a data target when testing AR6405
- * UART applications; use program edsu to send files from a remote
- * host and this program to display or save them;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <fcntl.h>
-#include <stdio.h>
-#include <limits.h>
-#include <ctype.h>
-#include <unistd.h>
-#include <stdint.h>
-#include <stdlib.h>
-#include <string.h>
-#include <errno.h>
-
-#ifdef __linux__
-#include <net/if.h>
-#include <net/if_arp.h>
-#include <netpacket/packet.h>
-#include <signal.h>
-#endif
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#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/error.h"
-#include "../ether/channel.h"
-
-/*====================================================================*
- * custom source files;
- *--------------------------------------------------------------------*/
-
-#ifndef MAKEFILE
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-#include "../tools/hexdump.c"
-#include "../tools/hexdecode.c"
-#include "../tools/hexstring.c"
-#include "../tools/uintspec.c"
-#include "../tools/memswap.c"
-#include "../tools/todigit.c"
-#include "../tools/error.c"
-#endif
-
-#ifndef MAKEFILE
-#include "../ether/channel.c"
-#include "../ether/openchannel.c"
-#include "../ether/closechannel.c"
-#include "../ether/sendpacket.c"
-#include "../ether/readpacket.c"
-#endif
-
-/*====================================================================*
- * program constants;
- *--------------------------------------------------------------------*/
-
-#define EFEU_INTERFACE "PLC"
-#define EFEU_ETHERTYPE ETH_P_802_2
-
-/*====================================================================*
- *
- * int main (int argc, char * argv[]);
- *
- *
- *--------------------------------------------------------------------*/
-
-int main (int argc, char const * argv [])
-
-{
- extern struct channel channel;
- struct ethernet_frame frame;
- signed length;
- static char const * optv [] =
- {
- "e:i:qt:v",
- PUTOPTV_S_DIVINE,
- "Qualcomm Atheros Ethernet Frame Echo Utility",
- "e x\tethertype is (x) [" LITERAL (EFEU_ETHERTYPE) "]",
-
-#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
-
- "q\tsuppress normal output",
- "t n\tread timeout is (n) milliseconds [" LITERAL (CHANNEL_FOREVER) "]",
- "v\tverbose messages on stdout",
- (char const *) (0)
- };
- signed c;
- channel.type = EFEU_ETHERTYPE;
- channel.timeout = CHANNEL_FOREVER;
- if (getenv (EFEU_INTERFACE))
- {
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (getenv (EFEU_INTERFACE));
-
-#else
-
- channel.ifname = strdup (getenv (EFEU_INTERFACE));
-
-#endif
-
- }
- optind = 1;
- while ((c = getoptv (argc, argv, optv)) != -1)
- {
- switch (c)
- {
- case 'e':
- channel.type = (uint16_t)(basespec (optarg, 16, sizeof (channel.type)));
- break;
- case 'i':
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (optarg);
-
-#else
-
- channel.ifname = optarg;
-
-#endif
-
- break;
- case 'q':
- _setbits (channel.flags, CHANNEL_SILENCE);
- break;
- case 't':
- channel.timeout = (signed)(uintspec (optarg, 0, UINT_MAX));
- break;
- case 'v':
- _setbits (channel.flags, CHANNEL_VERBOSE);
- break;
- default:
- break;
- }
- }
- argc -= optind;
- argv += optind;
- if (argc)
- {
- error (1, ECANCELED, ERROR_TOOMANY);
- }
- openchannel (&channel);
- while ((length = readpacket (&channel, &frame, sizeof (frame))) > 0)
- {
- memswap (&frame.frame_dhost, &frame.frame_shost, sizeof (frame.frame_dhost));
- if (sendpacket (&channel, &frame, length) != length)
- {
- error (1, errno, CHANNEL_CANTSEND);
- }
- }
- closechannel (&channel);
- return (0);
-}
-
-
-
-efru(1) Qualcomm Atheros Open Powerline Toolkit efru(1)
-
-NAME
- efru - HomePlug AV Packet Listener
-
-SYNOPSIS
- efru [options]
-
-DESCRIPTION
- Display incoming 802.3 Ethernet frames addressed to this host or broadcast. Do not display outgoing frames.
-
- The program is an example of a simple packet listener. Engineers and software developers can extend this code to build
- custom sniffers or servers. The framework is present here but you must add any additional features.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -e ethertype
- The protocol (or ethertype) of interest expressed as a 16-bit hexadecimal integer. Prefix "0x" is optional. This
- filters out frames having any other ethertype. The default is ETH_P_802_2 as defined in if_ether.h.
-
- -i interface
- Names the host ethernet interface to watch. The named interface, such as eth0, eth1 and so on, must be connected
- to a HomePlug AV ethernet-to-powerline bridge adapter to receive any HomePlug AV traffic. The default interface
- is eth1.
-
- -q Quiet mode. Suppress the printing of the normal message descriptions on stdout.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is 50 milliseconds.
-
- -v Verbose mode. Displays incoming frames in hexadecimal dump format on stdout. This option is independent of
- option -a which prints VS_ARPC message text on stderr.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line. -!,
- --version Print program version information on stdout. This option takes precedence over other options on the
- command line. Use this option when sending screen dumps to Atheros Technical Support so that they know exactly
- which version of the Linux Toolkit you are using. See the HomePlug AV Specification for a description of all
- HomePlug AV message types. See the Qualcomm Atheros INT6000 Firmware Reference Manual for a description of
- Atheros Vendor Specific message types.
-
-EXAMPLES
- The following command monitors the default interface eth1 for HomePlug AV traffic and dumps detected frames on the con‐
- sole as they occur. Terminate the foreground process by typing ^C or ^Z at the console. This program is usually run in
- a separate console window when performing other toolkit operations.
-
- # efru
-
- The following command monitors host interface eth4 for incoming HomePlug AV frames and dumps writes them to file
- efru.log. Frames are printed in hexadecimal dump format because option -v is present. Terminate the foreground process
- by typing ^C or ^Z at the console.
-
- # efru -v -i eth4 > efru.log
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information is not available. Qualcomm Atheros reserves the right to modify management mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- plc(1), efsu(1), hpav(1), hpavd(1), mme(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 efru(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * efru.c - Ethernet Frame Read Utility
- *
- * print message header and/or full message content on stdout for
- * each HomePlugAV or Atheros Vendor Specific message received by
- * the host;
- *
- * this program receives raw ethernet frames and so requires root
- * privileges; if you install it using "chmod 555" and "chown
- * root:root" then you must login as root to run it; otherwise, you
- * can install it using "chmod 4555" and "chown root:root" so that
- * anyone can run it; the program will refuse to run until you get
- * thing right;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <fcntl.h>
-#include <stdio.h>
-#include <limits.h>
-#include <ctype.h>
-#include <unistd.h>
-#include <stdint.h>
-#include <stdlib.h>
-#include <string.h>
-#include <errno.h>
-
-#ifdef __linux__
-#include <net/if.h>
-#include <net/if_arp.h>
-#include <netpacket/packet.h>
-#include <signal.h>
-#endif
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#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/error.h"
-#include "../ether/channel.h"
-#include "../plc/plc.h"
-#include "../mme/mme.h"
-
-/*====================================================================*
- * custom source files;
- *--------------------------------------------------------------------*/
-
-#ifndef MAKEFILE
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-#include "../tools/hexdump.c"
-#include "../tools/basespec.c"
-#include "../tools/uintspec.c"
-#include "../tools/todigit.c"
-#include "../tools/error.c"
-#endif
-
-#ifndef MAKEFILE
-#include "../ether/channel.c"
-#include "../ether/openchannel.c"
-#include "../ether/closechannel.c"
-#include "../ether/sendpacket.c"
-#include "../ether/readpacket.c"
-#endif
-
-/*====================================================================*
- * program constants;
- *--------------------------------------------------------------------*/
-
-#define EFRU_VERBOSE (1 << 0)
-#define EFRU_SILENCE (1 << 1)
-
-#define EFRU_INTERFACE "PLC"
-#define EFRU_ETHERTYPE ETH_P_802_2
-
-/*====================================================================*
- *
- * int main (int argc, char * argv[]);
- *
- *
- *--------------------------------------------------------------------*/
-
-int main (int argc, char const * argv [])
-
-{
- extern struct channel channel;
- struct message message;
- static char const * optv [] =
- {
- "e:i:qt:v",
- PUTOPTV_S_DIVINE,
- "Qualcomm Atheros Ethernet Frame Read Utility",
- "e x\tethertype is (x) [" LITERAL (EFRU_ETHERTYPE) "]",
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- "i n\thost interface is (s) [" LITERAL (CHANNEL_ETHNUMBER) "]",
-
-#else
-
- "i s\thost interface is (n) [" LITERAL (CHANNEL_ETHDEVICE) "]",
-
-#endif
-
- "q\tsuppress normal output",
- "t n\tread timeout is (n) milliseconds [" LITERAL (CHANNEL_FOREVER) "]",
- "v\tverbose messages on stdout",
- (char const *) (0)
- };
- flag_t flags = (flag_t)(0);
- signed length;
- signed c;
- if (getenv (EFRU_INTERFACE))
- {
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (getenv (EFRU_INTERFACE));
-
-#else
-
- channel.ifname = strdup (getenv (EFRU_INTERFACE));
-
-#endif
-
- }
- optind = 1;
- channel.type = EFRU_ETHERTYPE;
- channel.timeout = CHANNEL_FOREVER;
- while ((c = getoptv (argc, argv, optv)) != -1)
- {
- switch (c)
- {
- case 'e':
- channel.type = (uint16_t)(basespec (optarg, 16, sizeof (channel.type)));
- break;
- case 'i':
-
-#if defined (WIN32)
-
- channel.ifindex = atoi (optarg);
-
-#else
-
- channel.ifname = optarg;
-
-#endif
-
- break;
- case 'q':
- _setbits (flags, EFRU_SILENCE);
- break;
- case 't':
- channel.timeout = (signed)(uintspec (optarg, 0, UINT_MAX));
- break;
- case 'v':
- _setbits (flags, EFRU_VERBOSE);
- break;
- default:
- break;
- }
- }
- argc -= optind;
- argv += optind;
- if (argc)
- {
- error (1, ECANCELED, ERROR_TOOMANY);
- }
- openchannel (&channel);
- while ((length = readpacket (&channel, &message, sizeof (message))) >= 0)
- {
- hexdump (&message, 0, length, stdout);
- }
- closechannel (&channel);
- return (0);
-}
-
-
-
-efsu(1) Qualcomm Atheros Open Powerline Toolkit efsu(1)
-
-NAME
- efsu - Ethernet Frame Send Utility
-
-SYNOPSIS
- efsu [options] file [file] [...]
-
- efsu [options] [<stdin]
-
-DESCRIPTION
- Sends custom Ethernet frames over a specific host Ethernet interface.
-
- A frame is specified as a text stream of hexadecimal octets read from one or more frame description files or from stdin.
- Each octet is converted to a binary byte, buffered and transmitted over the network on the specified host interface. The
- program assumes that frames are valid and will transmit whatever you specify, right or wrong. The program only checks
- minimum and maximum frame length.
-
- Frame descriptions are stored as plain text files. Multiple frames may be specified in one file by separating them with
- a semicolon. All descriptions in a file are read and sent immediately but multiple files may be specified on the command
- line and options allow pauses between files, command line repetition and pauses between command line iterations.
-
- A frame descriptions is a continuous stream of hexadecimal digits. Intervening text, punctuation, white space and com‐
- ments are discarded. Hex characters inside script-style, C-style or C++-style comments are ignored. Script-style com‐
- ments include all characters between a hash ('#') and the next newline or EOF. C-style and C++-style comments follow
- normal language rules. Comments may be used to document frame descriptions or hide frame segments. In the end, there
- must be an even number of hex digits that represent 60 to 1518 octets;
-
-OPTIONS
- -d address
- Replace the destination Ethernet address of each transmitted frame with the option argument. The destination
- address consists of 12 hex digits in upper, lower or mixed case. Octets may be seperated with colons for clarity
- but colons are not required.
-
- -e ethertype
- Echo received frames having ethertype. This effectively filters received frames but does not filter transmitted
- frames. The ethertype is expressed in hexadecimal without the "0x" prefix. The keyword "hp10" can be used for
- 887B and keyword "hpav" can be used for 88E1.
-
- -h Replace the source address of each transmitted frame with the Ethernet address of the host interface used to send
- the frame. This allows frames to be sent correctly from any host interface. Use option -i to specify an inter‐
- face.
-
- -i interface
- The host interface used to send frames. The default is "eth1" because most people use "eth0" as their principle
- network connection; however, if the string "PLC" is defined in the environment then it will over-ride the program
- default. Any interface specified on the command line will over-ride the default.
-
- -l count
- Repeat command line count times by re-sending all files each time. The default is 1.
-
- -p seconds
- Pause between each file on the command line. The default is 0 seconds.
-
- -t timer
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is 50 milliseconds.
-
- -v Dumps transmitted frames on stdout as they are sent. If an Ethertype was specified using option -e the received
- frames having that Ethertype will also be dumped.
-
- -w seconds
- Wait between command line iterations. The default is 0 seconds.
-
-ARGUMENTS
- file The name of a file containing one or more frame specifications. When more than one file is specified, efsu
- behaves like the cat utility by reading and sending each file in turn. The program makes no assumptions based on
- filename or extension and enforces no filename conventions; however, giving frame description files the *.hex
- extension is a good convention. Some toolkit distributions include example .hex files in the source folder.
- These files are not needed for proper execution and may be deleted.
-
-NOTES
- One way to create a frame description file is to cut-and-paste output from a packet sniffer program and discard the line
- numbers and ASCII text columns. You can then break out selected frame segments onto new lines and insert comments.
-
-EXAMPLES
- For example, a simple file might look like:
-
- #!/usr/local/bin/efsu -ieth0
- # file: abc.hex
- # =====================================
- # this is an example frame description;
- # -------------------------------------
- 00 B0 52 00 00 01
- // 00 B0 52 BE DE 73
- 00 E0 45 DA DA 07
- 88 E1
- /* content */
- 00 00 00 00 00 00 00 00
- 00 00 00 00 00 00 00 00
- 00000000 0000 00 /* control byte */ 00
- 00 00 00 00 00 00 00 00
- 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
- 00 00 00 00 00 00 00 00
-
- The bang path permits direct execution of the file if 1) efsu is installed in the bang path directory, 2) the description
- file has execute permissions and 3) the user has execute privileges for that file. The script-style, C++-style and C-
- style comments are ignored along with any white space. Only the hexadecimal octets are read and sent. Since the number
- of octets exceeds 60 and the number of digits is even, efsu will report no errors and send the packet. There is no guar‐
- antee that this packet is valid.
-
- Assuming the above file is named abc.hex, we can transmit the file over the network as an Ethernet frame with the next
- command. A hexadecimal dump of the transmitted frame appears on the console because option -v is present.
-
- # efsu abc.hex -v
- 00000000 00 B0 52 00 00 01 00 E0 45 DA DA 07 88 E1 00 00 ..R.....E.......
- 00000010 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
- 00000020 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
- 00000030 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
- 00000040 00 00 00 00 00 00 ......
-
- Since every host interface has a different hardware address, one can replace the source address of transmitted frames
- with the actual host interface address using option -h. Observe that the source address above has been replaced with
- that of the local host interface used to transmit the frame.
-
- # efsu abc.hex -vh
- 00000000 00 B0 52 00 00 01 00 0F EA 10 D5 1C 88 E1 00 00 ..R.............
- 00000010 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
- 00000020 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
- 00000030 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
- 00000040 00 00 00 00 00 00 ......
-
- You can also direct the frame to another device using option -d. Observe that the destination address above has been
- replaced with the one specified on the command line.
-
- # efsu abc.hex -vhd 00b052beef01
- 00000000 00 B0 52 BE EF 01 00 0F EA 10 D5 1C 88 E1 00 00 ..R.............
- 00000010 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
- 00000020 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
- 00000030 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
- 00000040 00 00 00 00 00 00 ......
-
-SEE ALSO
- amp(1), hpav(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 efsu(1)
-
-/*====================================================================*
- *
- * void * emalloc (size_t length)
- *
- * error.h
- *
- * attempt to allocate memory using malloc(); return the memory address
- * on success; print an error message on stderr and then terminate the
- * program on failure;
- *
- * Motley Tools by Charles Maier <cmaier@cmassoc.net>;
- * Copyright (c) 2001-2006 by Charles Maier Associates;
- * Licensed under the Internet Software Consortium License;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef EMALLOC_SOURCE
-#define EMALLOC_SOURCE
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <errno.h>
-
-#include "../tools/error.h"
-
-void * emalloc (size_t length)
-
-{
- void * memory = malloc (length);
- if (!memory)
- {
- error (1, errno, "need %lu bytes", (long)(length));
- }
- return (memory);
-}
-
-#endif
-
-
-
-
-
-
diff --git a/docbook/embedding.xml b/docbook/embedding.xml
deleted file mode 100644
index 24b0e887..00000000
--- a/docbook/embedding.xml
+++ /dev/null
@@ -1,15 +0,0 @@
-
-
- Embedded Applications
-
-
-
- Introduction
-
-
- The Open Powerline Toolkit has been developed with embedded applications in mind but it is not an embedded turn-key system. It has been successfully cross-compiled for several big and little endian platforms. Qualcomm Atheros does not claim to support cross-compilation for any particular environment or guarantee proper program execution on all platforms. Customers should have (or obtain) embedded system expertise or allow time to develop the expertise before attempting any embedded project.
-
-
- Many embedded systems use flash memory for persistent storage. When power is applied, an image is read from flash memory into volatile memory and executed there. The image contains an operating system kernel and filesystem image. The kernel mounts the filesystem image and starts applications found there. The filesystem stores application programs, support libraries and configuration files and should have enough free space for temporary files that might be needed. A typical embedded system uses Linux as the operating system kernel, Busybox as the principle application and uClib as the support library. All executable components must be compiled for the target host processor instruction set.
-
-
diff --git a/docbook/endian.h.html b/docbook/endian.h.html
deleted file mode 100644
index dbd04097..00000000
--- a/docbook/endian.h.html
+++ /dev/null
@@ -1,201 +0,0 @@
-
-
-
-
-
- endian.h
-
-
-
-
-
-
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2011 by Qualcomm Atheros.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose with or without fee is hereby granted, provided
- * that the above copyright notice and this permission notice appear
- * in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
- * THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
- * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
- * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
- * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * ethernet.h - substitute net/ethernet.h for systems without one;
- *
- *. Intellon INT6000 Linux Toolkit for HomePlug AV;
- *: Published 2006-2009 by Intellon Corp. ALL RIGHTS RESERVED;
- *; For demonstration; Not for production use;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef ETHERNET_HEADER
-#define ETHERNET_HEADER
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <stdint.h>
-
-/*====================================================================*
- * Ethernet frame lengths;
- *--------------------------------------------------------------------*/
-
-#define ETHER_ADDR_LEN 6
-#define ETHER_TYPE_LEN 2
-#define ETHER_CRC_LEN 4
-#define ETHER_HDR_LEN (ETHER_ADDR_LEN + ETHER_ADDR_LEN + ETHER_TYPE_LEN)
-#define ETHER_MIN_LEN 64
-#define ETHER_MAX_LEN 1518
-#define ETHERMTU 1500
-#define ETHERMIN (ETHER_MIN_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN)
-
-/*====================================================================*
- * Ethernet type/length field values;
- *--------------------------------------------------------------------*/
-
-#define ETHERTYPE_PUP 0x0200
-#define ETHERTYPE_IP 0x0800
-#define ETHERTYPE_ARP 0x0806
-#define ETHERTYPE_REVARP 0x8035
-#define ETHERTYPE_VLAN 0x8100
-#define ETHERTYPE_IPV6 0x86dd
-#define ETHERTYPE_LOOPBACK 0x9000
-#define ETHERTYPE_HP10 0x887B
-#define ETHERTYPE_HPAV 0x88E1
-
-/*====================================================================*
- * Ethernet frame structure;
- *--------------------------------------------------------------------*/
-
-#pragma pack (push, 1)
-
-struct ether_header
-
-{
- uint8_t ether_dhost [ETHER_ADDR_LEN];
- uint8_t ether_shost [ETHER_ADDR_LEN];
- uint16_t ether_type;
-};
-
-#pragma pack (pop)
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-evse(1) Qualcomm Atheros Open Powerline Toolkit evse(1)
-
-NAME
- evse - Qualcomm Atheros Electric Vehicle Supply Equipment Emulator
-
-SYNOPSIS
- evse [options]
-
-DESCRIPTION
- Emulate the EVSE part of the HomePlug AV Signal Level Attentuation Characterization (SLAC) protocol where a PEV is a
- "Plug-in Electric Vehicle" and an EVSE is an "Electric Vehicle Supply Equipment" or charging station. This program
- remains active until terminated by the user. It waits for some PEV-HLE on the powerline network to attempt to connect in
- order to charge a virtual vehicle then services the PEV-HLE until the PEV-HLE elects to connect, elects not to connect or
- abandons the attempt. See the HomePlug Green PHY Specification Release Version 1.1 for more information on this proto‐
- col.
-
- Signal Level Attenuation Characterization (SLAC) enables a station to measure the signal level of its transmission at
- other stations in the network. It is designed for automotive applications where there are multiple plug-in vehicle
- (PEVs) and electric vehicle supply equipment (EVSE) on the network. The PEV signal level is measured at multiple EVSEs
- to determine which EVSE the PEV is actually plugged into. The process leading to this determination is called "Green PHY
- PEV-EVSE Association" (GreenPPEA).
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -c Print the EVSE-HLE configuration profile on stdout. The configuration profile specifies program defaults in a
- format that you, as a user, can edit and save. Use options -p and -s to read named profiles and sections.
-
- -d Print the contents of the EVSE-HLE session variable on stdout. The session variable is an program data structure
- that stores information passed between the PEV-HLE and EVSE-HLE during SLAC association. This option is used to
- inspect and veriify information relevant to the process.
-
- If the program was compiled with variable SLAC_DEBUG defined then this option also prints MME message fields before mes‐
- sages are sent or after they are received. Interested parties can follow along in the source code.
-
- -i Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -p profile
- The EVSE-HLE configuration profile name. The program will supply default values for missing profile elements.
- See the example profile shown below. The default profile is "evse.ini".
-
- -q Enter quiet mode. Progress messages are suppressed.
-
- -s section
- The configuration profile section name. The program will supply default values for missing configuration profile
- elements. See the example profile shown below. The default section name is "default".
-
- -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-PROFILE
- The default configuration profile for this program is "evse.ini". The default profile section is "default". Users may
- create addition profiles and reference them with option -p or add additional sections to an existing profiles and refer‐
- ence them with option -s.
-
- Time to Sound
- The time in 100 millisecond increments for all msounds to arrive at the msound target. The msound target may pro‐
- ceed with attenuation characterization computations should all msounds fail to arrive within this period. This
- value is read but not used by program pev or program evse. This value is the same as CM_SLAC_PARAM.CNF.TIME_OUT.
- The default value is 10 which represents 1000 milliseconds.
-
- Number of Sounds
-
- The total number of msounds that will be sent to the msound target.
- All msounds must arrive within the allotted time or they will be lost. This value is the same as
- CM_SLAC_PARAM.CNF.NUM_SOUNDS. The default is 8.
-
- Response Type
- Controls whether the msound recipient sends signal attenuation characteristic profile data to the EVSE-HLE or
- another station. The only response specified at this time is the EVSE-HLE. The default value is 0. Any other
- value is ignored.
-
- Station Identifier
- Vehicle identification. The 17-byte Vehicle Identification Number to be placed in CM_MNBC_SOUND.IND.SenderID.
- This value is not used but is can be changed here so that the field is easy to spot within network message traces.
-
- Network Membership Key
- The 16-byte Network Memberhip Key (NMK) for the PEV-PLC device. This program uses CM_SET_KEY to sets the EVSE-PLC
- NMK to this value after disconnecting. The default value is the key for Network Password "HomePlugAV0123".
-
- Network Identifier
- The 7-byte Network Identifier (NID) for the PEV-PLC device. This program uses CM_SET_KEY to sets the EVSE-PLC NID
- to this value after disconnecting. The default value is the same as that for Network Password "HomePlugAV0123".
-
-REFERENCES
- See the Qualcomm Atheros AR7420, QCA6410 IEEE 1901, HomePlug AV and QCA7000 HomePlug Green PHY PLC Chipset Programmer's
- Guide or the HomePlug Green PHY Specification Release Version 1.1 for more information on this protocol.
-
-REFERENCES
- See the Qualcomm Atheros AR7420, QCA6410 IEEE 1901, HomePlug AV and QCA7000 HomePlug Green PHY PLC Chipset Programmer'sw
- Guide or the HomePlug Green PHY Specification Release Version 1.1 for more information on this protocol.
-
-EXAMPLES
- The following example starts a EVSE session on interface eth0 and wait up to 2000 milliseconds (or 2 seconds) for the PEV
- to respond during any given exchange.
-
- # evse -ieth0 -w2000
-
- The default EVSE-HLE configuration profile, "evse.ini", looks something like this but it can be changed using a normal
- text editor. Use option -P to produce a template profile, if one is needed.
-
- # file: evse.ini
- # ====================================================================
- # EVSE-HLE initiaization;
- # --------------------------------------------------------------------
- [default]
- time to sound = 10
- number of sounds = 8
- response type = 0
- station identifier = BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB
- network membership key = B59319D7E8157BA001B018669CCEE30D
- network identifier = 026BCBA5354E08
-
-SEE ALSO
- plc(1), pev(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 evse(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed evse_cm_atten_char (struct session * session, struct channel * channel, struct message * message);
- *
- * slac.h
- *
- * EVSE-HLE sends average msound values to the PEV-HLE for a match
- * decision;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef EVSE_CM_ATTEN_CHAR_SOURCE
-#define EVSE_CM_ATTEN_CHAR_SOURCE
-
-#include <string.h>
-
-#include "../ether/channel.h"
-#include "../tools/memory.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../iso15118/slac.h"
-
-signed evse_cm_atten_char (struct session * session, struct channel * channel, struct message * message)
-
-{
- struct cm_atten_char_indicate * indicate = (struct cm_atten_char_indicate *) (message);
- struct cm_atten_char_response * response = (struct cm_atten_char_response *) (message);
- slac_debug (session, 0, __func__, "--> CM_ATTEN_CHAR.IND");
- memset (message, 0, sizeof (* message));
- EthernetHeader (& indicate->ethernet, session->PEV_MAC, channel->host, channel->type);
- HomePlugHeader1 (& indicate->homeplug, HOMEPLUG_MMV, (CM_ATTEN_CHAR | MMTYPE_IND));
- indicate->APPLICATION_TYPE = session->APPLICATION_TYPE;
- indicate->SECURITY_TYPE = session->SECURITY_TYPE;
- memcpy (indicate->ACVarField.SOURCE_ADDRESS, session->PEV_MAC, sizeof (indicate->ACVarField.SOURCE_ADDRESS));
- memcpy (indicate->ACVarField.RunID, session->RunID, sizeof (indicate->ACVarField.RunID));
- memset (indicate->ACVarField.SOURCE_ID, 0, sizeof (indicate->ACVarField.SOURCE_ID));
- memset (indicate->ACVarField.RESP_ID, 0, sizeof (indicate->ACVarField.RESP_ID));
- indicate->ACVarField.NUM_SOUNDS = session->sounds;
- indicate->ACVarField.ATTEN_PROFILE.NumGroups = session->NumGroups;
- memcpy (indicate->ACVarField.ATTEN_PROFILE.AAG, session->AAG, session->NumGroups);
- if (sendmessage (channel, message, sizeof (* indicate)) <= 0)
- {
- return (slac_debug (session, 1, __func__, CHANNEL_CANTSEND));
- }
- if (readmessage (channel, message, HOMEPLUG_MMV, (CM_ATTEN_CHAR | MMTYPE_RSP)) > 0)
- {
- if (! memcmp (session->RunID, response->ACVarField.RunID, sizeof (session->RunID)))
- {
- slac_debug (session, 0, __func__, "<-- CM_ATTEN_CHAR.RSP");
-
-#if SLAC_DEBUG
-
- if (_anyset (session->flags, SLAC_VERBOSE))
- {
- char string [256];
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.RSP.APPLICATION_TYPE %d", response->APPLICATION_TYPE);
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.RSP.SECURITY_TYPE %d", response->SECURITY_TYPE);
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.RSP.ACVarfield.SOURCE_ADDRESS %s", HEXSTRING (string, response->ACVarField.SOURCE_ADDRESS));
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.RSP.ACVarFIeld.RunID %s", HEXSTRING (string, response->ACVarField.RunID));
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.RSP.ACVarField.SOURCE_ID %s", HEXSTRING (string, response->ACVarField.SOURCE_ID));
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.RSP.ACVarField.RESP_ID %s", HEXSTRING (string, response->ACVarField.RESP_ID));
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.RSP.ACVarField.Result %d", response->ACVarField.Result);
- }
-
-#endif
-
- return (0);
- }
- }
- return (slac_debug (session, session->exit, __func__, "<-- CM_ATTEN_CHAR.RSP ?"));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed evse_cm_slac_match (struct session * session, struct channel * channel, struct message * message);
- *
- * slac.h
- *
- * receive CM_SLAC_MATCH.REQ and send CM_SLAC_MATCH.CNF containing
- * random NMK/NID that EVSE-HLE will use to configure EVSE-PLC for
- * charging;
- *
- * users must develop their own means of generating random NMK/NID
- * pairs because it is not part of the standard; this example does
- * not attempt to randomize NMK/NID;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef EVSE_CM_SLAC_MATCH_SOURCE
-#define EVSE_CM_SLAC_MATCH_SOURCE
-
-#include <stdio.h>
-#include <string.h>
-
-#include "../ether/channel.h"
-#include "../tools/memory.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../iso15118/slac.h"
-
-signed evse_cm_slac_match (struct session * session, struct channel * channel, struct message * message)
-
-{
- struct cm_slac_match_request * request = (struct cm_slac_match_request *) (message);
- struct cm_slac_match_confirm * confirm = (struct cm_slac_match_confirm *) (message);
- while (readmessage (channel, message, HOMEPLUG_MMV, (CM_SLAC_MATCH | MMTYPE_REQ)) > 0)
- {
- if (! memcmp (session->RunID, request->MatchVarField.RunID, sizeof (session->RunID)))
- {
- slac_debug (session, 0, __func__, "<-- CM_SLAC_MATCH.REQ");
- memcpy (session->PEV_ID, request->MatchVarField.PEV_ID, sizeof (session->PEV_ID));
- memcpy (session->PEV_MAC, request->MatchVarField.PEV_MAC, sizeof (session->PEV_MAC));
- memcpy (session->RunID, request->MatchVarField.RunID, sizeof (session->RunID));
-
-#if SLAC_DEBUG
-
- if (_anyset (session->flags, SLAC_VERBOSE))
- {
- char string [256];
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.REQ.APPLICATION_TYPE %d", request->APPLICATION_TYPE);
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.REQ.SECURITY_TYPE %d", request->SECURITY_TYPE);
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.REQ.MVFLength %d", LE16TOH (request->MVFLength));
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.REQ.PEV_ID %s", HEXSTRING (string, request->MatchVarField.PEV_ID));
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.REQ.PEV_MAC %s", HEXSTRING (string, request->MatchVarField.PEV_MAC));
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.REQ.EVSE_ID %s", HEXSTRING (string, request->MatchVarField.EVSE_ID));
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.REQ.EVSE_MAC %s", HEXSTRING (string, request->MatchVarField.EVSE_MAC));
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.REQ.RunID %s", HEXSTRING (string, request->MatchVarField.RunID));
- }
-
-#endif
-
- slac_debug (session, 0, __func__, "--> CM_SLAC_MATCH.CNF");
- memset (message, 0, sizeof (* message));
- EthernetHeader (& confirm->ethernet, session->PEV_MAC, channel->host, channel->type);
- HomePlugHeader1 (& confirm->homeplug, HOMEPLUG_MMV, (CM_SLAC_MATCH | MMTYPE_CNF));
- confirm->APPLICATION_TYPE = session->APPLICATION_TYPE;
- confirm->SECURITY_TYPE = session->SECURITY_TYPE;
- confirm->MVFLength = HTOLE16 (sizeof (confirm->MatchVarField));
- memcpy (confirm->MatchVarField.PEV_ID, session->PEV_ID, sizeof (confirm->MatchVarField.PEV_ID));
- memcpy (confirm->MatchVarField.PEV_MAC, session->PEV_MAC, sizeof (confirm->MatchVarField.PEV_MAC));
- memcpy (confirm->MatchVarField.EVSE_ID, session->EVSE_ID, sizeof (confirm->MatchVarField.EVSE_ID));
- memcpy (confirm->MatchVarField.EVSE_MAC, session->EVSE_MAC, sizeof (confirm->MatchVarField.EVSE_MAC));
- memcpy (confirm->MatchVarField.RunID, session->RunID, sizeof (confirm->MatchVarField.RunID));
- memcpy (confirm->MatchVarField.NID, session->NID, sizeof (confirm->MatchVarField.NID));
- memcpy (confirm->MatchVarField.NMK, session->NMK, sizeof (confirm->MatchVarField.NMK));
- if (sendmessage (channel, message, sizeof (* confirm)) <= 0)
- {
- return (slac_debug (session, 1, __func__, CHANNEL_CANTSEND));
- }
- return (0);
- }
- }
- return (slac_debug (session, session->exit, __func__, "<-- CM_SLAC_MATCH.REQ ?"));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed evse_cm_slac_param (struct session * session, struct channel * channel, struct message * message);
- *
- * slac.h
- *
- * EVSE-HLE listens indefinitely for a cm_slac_param request and
- * responds with a cm_slac_param confirm; this function should not
- * exit untile a cm_slac_param request so that SLAC sessions will
- * properly synchronize;
- *
- * unlike some other EVSE-HLE functions, this one does not check
- * the run identifier because this is the first point at which a
- * new run identifier is received; it should, however, store the
- * run identifier to verify future messages from the PEV;
- *
- * EVSE-HLE should copy the message OSA to the session variable PEV
- * MAC address; the PEV MAC address can then be used to respond in
- * unicast to the right PEVHLE;
- *
- * EVSE-HLE should copy the run identifier to the session variable
- * for use later in the session; this will be used to distinguish
- * one PEV-EVSE session from another;
- *
- * EVSE-HLE should copy the application type and security type to
- * the session variable unless it wants to operate in a mode that
- * is different from the PEV;
- *
- * at this point, the EVSE-HLE dictates the number of msounds and
- * the msound timeout;
- *
- * EVSE-HLE should set the msound target to the broadcast address;
- *
- * EVSE-HLE should set the number of sounds to 8 and the timeout
- * to 10 intervals of 100ms.
- *
- * EVSE-HLE may send zeros for the forwarding station since it is
- * not used here;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef EVSE_CM_SLAC_PARAM_SOURCE
-#define EVSE_CM_SLAC_PARAM_SOURCE
-
-#include <stdio.h>
-#include <string.h>
-
-#include "../ether/channel.h"
-#include "../tools/types.h"
-#include "../tools/flags.h"
-#include "../tools/error.h"
-#include "../tools/memory.h"
-#include "../iso15118/slac.h"
-
-signed evse_cm_slac_param (struct session * session, struct channel * channel, struct message * message)
-
-{
- extern byte const broadcast [ETHER_ADDR_LEN];
- struct cm_slac_param_request * request = (struct cm_slac_param_request *) (message);
- struct cm_slac_param_confirm * confirm = (struct cm_slac_param_confirm *) (message);
- while (readmessage (channel, message, HOMEPLUG_MMV, (CM_SLAC_PARAM | MMTYPE_REQ)) > 0)
- {
- slac_debug (session, 0, __func__, "<-- CM_SLAC_PARAM.REQ");
- session->APPLICATION_TYPE = request->APPLICATION_TYPE;
- session->SECURITY_TYPE = request->SECURITY_TYPE;
- memcpy (session->PEV_MAC, request->ethernet.OSA, sizeof (session->PEV_MAC));
- memcpy (session->RunID, request->RunID, sizeof (session->RunID));
-
-#if SLAC_DEBUG
-
- if (_anyset (session->flags, SLAC_VERBOSE))
- {
- char string [256];
- slac_debug (session, 0, __func__, "CM_SLAC_PARAM.REQ.APPLICATION_TYPE %d", request->APPLICATION_TYPE);
- slac_debug (session, 0, __func__, "CM_SLAC_PARAM.REQ.SECURITY_TYPE %d", request->SECURITY_TYPE);
- slac_debug (session, 0, __func__, "CM_SLAC_PARAM.REQ.RunID %s", HEXSTRING (string, request->RunID));
- slac_debug (session, 0, __func__, "CM_SLAC_PARAM.REQ.CipherSuiteSetSize %d", request->CipherSuiteSetSize);
- slac_debug (session, 0, __func__, "CM_SLAC_PARAM.REQ.CipherSuite [0] %d", request->CipherSuite [0]);
- slac_debug (session, 0, __func__, "CM_SLAC_PARAM.REQ.CipherSuite [1] %d", request->CipherSuite [1]);
- }
-
-#endif
-
- if (_anyset (session->flags, SLAC_COMPARE))
- {
- if (LE16TOH (request->CipherSuite [0]) != (uint16_t) (session->counter))
- {
- slac_debug (session, session->exit, __func__, "session->counter mismatch! PEV=(%d) EVSE=(%d)", LE16TOH (request->CipherSuite [0]), session->counter);
- }
- }
- slac_debug (session, 0, __func__, "--> CM_SLAC_PARAM.CNF");
- memset (message, 0, sizeof (* message));
- EthernetHeader (& confirm->ethernet, session->PEV_MAC, channel->host, channel->type);
- HomePlugHeader1 (& confirm->homeplug, HOMEPLUG_MMV, (CM_SLAC_PARAM | MMTYPE_CNF));
- memcpy (confirm->MSOUND_TARGET, broadcast, sizeof (confirm->MSOUND_TARGET));
- confirm->NUM_SOUNDS = session->NUM_SOUNDS;
- confirm->TIME_OUT = session->TIME_OUT;
- confirm->RESP_TYPE = session->RESP_TYPE;
- memcpy (confirm->FORWARDING_STA, session->FORWARDING_STA, sizeof (confirm->FORWARDING_STA));
- confirm->APPLICATION_TYPE = session->APPLICATION_TYPE;
- confirm->SECURITY_TYPE = session->SECURITY_TYPE;
- memcpy (confirm->RunID, session->RunID, sizeof (confirm->RunID));
- confirm->CipherSuite = HTOLE16 ((uint16_t) (session->counter));
- if (sendmessage (channel, message, (ETHER_MIN_LEN - ETHER_CRC_LEN)) <= 0)
- {
- return (slac_debug (session, 1, __func__, CHANNEL_CANTSEND));
- }
- return (0);
- }
- return (slac_debug (session, 0, __func__, "<-- CM_SLAC_PARAM.REQ ?"));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed evse_cm_start_atten_char (struct session * session, struct channel * channel, struct message * message);
- *
- * slac.h
- *
- * EVSE_HLE stores NUM_SOUNDS, TIME_OUT and FORWARDING_STA for use
- * later in the SLAC session;
- *
- * accept only CM_ATTEN_CHAR.IND with RunID that match the earlier
- * CM_SLAC_PARAM.REQ;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef EVSE_CM_START_ATTEN_CHAR_SOURCE
-#define EVSE_CM_START_ATTEN_CHAR_SOURCE
-
-#include <string.h>
-
-#include "../ether/channel.h"
-#include "../tools/memory.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../iso15118/slac.h"
-
-signed evse_cm_start_atten_char (struct session * session, struct channel * channel, struct message * message)
-
-{
- struct cm_start_atten_char_indicate * indicate = (struct cm_start_atten_char_indicate *) (message);
- if (readmessage (channel, message, HOMEPLUG_MMV, (CM_START_ATTEN_CHAR | MMTYPE_IND)) > 0)
- {
- if (! memcmp (session->RunID, indicate->ACVarField.RunID, sizeof (session->RunID)))
- {
- slac_debug (session, 0, __func__, "<-- CM_START_ATTEN_CHAR.IND");
-
-#if SLAC_DEBUG
-
- if (_anyset (session->flags, SLAC_VERBOSE))
- {
- char string [256];
- slac_debug (session, 0, __func__, "CM_START_ATTEN_CHAR.IND.APPLICATION_TYPE %d", indicate->APPLICATION_TYPE);
- slac_debug (session, 0, __func__, "CM_START_ATTEN_CHAR.IND.SECURITY_TYPE %d", indicate->SECURITY_TYPE);
- slac_debug (session, 0, __func__, "CM_START_ATTEN_CHAR.IND.ACVarField.NUM_SOUNDS %d", indicate->ACVarField.NUM_SOUNDS);
- slac_debug (session, 0, __func__, "CM_START_ATTEN_CHAR.IND.ACVarField.TIME_OUT %d", indicate->ACVarField.TIME_OUT);
- slac_debug (session, 0, __func__, "CM_START_ATTEN_CHAR.IND.ACVarField.RESP_TYPE %d", indicate->ACVarField.RESP_TYPE);
- slac_debug (session, 0, __func__, "CM_START_ATTEN_CHAR.IND.ACVarField.FORWARDING_STA %s", HEXSTRING (string, indicate->ACVarField.FORWARDING_STA));
- slac_debug (session, 0, __func__, "CM_START_ATTEN_CHAR.IND.ACVarField.RunID %s", HEXSTRING (string, indicate->ACVarField.RunID));
- }
-
-#endif
-
- if (indicate->APPLICATION_TYPE != session->APPLICATION_TYPE)
- {
- slac_debug (session, session->exit, __func__, "%s: APPLICATION_TYPE", __func__);
- }
- if (indicate->SECURITY_TYPE != session->SECURITY_TYPE)
- {
- slac_debug (session, session->exit, __func__, "%s: SECURITY_TYPE", __func__);
- }
- session->NUM_SOUNDS = indicate->ACVarField.NUM_SOUNDS;
- session->TIME_OUT = indicate->ACVarField.TIME_OUT;
- if (indicate->ACVarField.RESP_TYPE != session->RESP_TYPE)
- {
- slac_debug (session, session->exit, __func__, "%s: RESP_TYPE", __func__);
- }
- memcpy (session->FORWARDING_STA, indicate->ACVarField.FORWARDING_STA, sizeof (session->FORWARDING_STA));
- return (0);
- }
- }
- return (slac_debug (session, session->exit, __func__, "CM_START_ATTEN_CHAR.IND ?"));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed fdmanifest (signed fd, char const * filename, struct nvm_header2 * nvm_header, unsigned module);
- *
- * given the manifest image header and a file positioned to the
- * start of the manifest image, extract the manifest and print
- * it on stdout in human readable form;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef FDMANIFEST_SOURCE
-#define FDMANIFEST_SOURCE
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <stdint.h>
-#include <errno.h>
-
-#include "../tools/endian.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../nvm/nvm.h"
-
-signed fdmanifest (signed fd, char const * filename, struct nvm_header2 * nvm_header, unsigned module)
-
-{
- off_t extent = LE32TOH (nvm_header->ImageLength);
- void * memory = malloc (extent);
- if (!memory)
- {
- error (1, 0, FILE_CANTLOAD, filename);
- }
- if (read (fd, memory, extent) != (signed)(extent))
- {
- error (1, errno, FILE_CANTREAD, filename);
- }
- if (lseek (fd, (off_t)(0) - extent, SEEK_CUR) == -1)
- {
- error (1, errno, FILE_CANTSEEK, filename);
- }
- printf ("------- %s (%d) -------\n", filename, module);
- if (manifest (memory, extent))
- {
- error (1, 0, "Bad manifest: %s", filename);
- }
- free (memory);
- return (0);
-}
-
-#endif
-
-
-
-
-
-
diff --git a/docbook/firmware-6000-boot.xml b/docbook/firmware-6000-boot.xml
deleted file mode 100644
index 5f2ea866..00000000
--- a/docbook/firmware-6000-boot.xml
+++ /dev/null
@@ -1,98 +0,0 @@
-
-
- Boot from Host (INT6000)
-
-
- The Boot from Host operation downloads a firmware image and PIB image from the local host and starts firmware execution. The process is initiated by the INT6000Bootloader following a device reset. The Bootloader passes control to the INT6000Softloader to negotiate with the local host. The process therefore requires Softloader aware software running on the local host in order to complete.
-
-
- The device does not have a unique hardware address until the firmware starts and assigns one. Until that time, the Softloader accepts messages addressed to 00:B0:52:00:00:01. In addition, the Softloader does not know the hardware address of the local host and so it addresses VS_HST_ACTION messages to FF:FF:FF:FF:FF:FF; however, these messages are not forwarded over powerline.
-
-
-
- Boot from Host (INT6000)
-
-| [03]
- [05] |<------- VS_HST_ACTION.RSP ---------| [04]
- | |
- [07] |<------- VS_WR_MOD.REQ -------------| [07]
- [07] |-------- VS_WR_MOD.CNF ------------>| [07]
- [07] |<-----------------------------------| [07]
- [07] |----------------------------------->| [07]
- | |
- [08] |<------- VS_WR_MOD.REQ -------------| [08]
- [08] |-------- VS_WR_MOD.CNF ------------>| [08]
- [08] |<-----------------------------------| [08]
- [08] |----------------------------------->| [08]
- | |
- [10] |<------- VS_ST_MAC.REQ -------------| [09]
- [11] |-------- VS_ST_MAC.CNF ------------>| [12]
-
- ]]>
-
-
-
-
- The INT6000Bootloader automatically starts after device reset. It reads the Softloader from NVRAM, writes it into SDRAM and starts execution. The Softloader then manages the Boot from Host process.
-
-
-
-
- The Softloader broadcasts a VS_HST_ACTION.IND message every 500 milliseconds to request the download of runtime firmware and PIB. The HOST_ACTION_REQ field of the message is 0x00 in this case. The message source address if 00:B0:52:00:00:01 as explained above.
-
-
-
-
- The local host receives the VS_HST_ACTION.IND message and inspects the HOST_ACTION_REQ field to determine action requested. It may then elect to service the request or ignore it. On a single-host system, the host must service the request or the device will not start. On a multi-host system, one of the hosts must elect to service the request or the device will not start.
-
-
-
-
- The local host sends a VS_HST_ACTION.RSP message to the device to indicate the ability and willingness to service the request. The MSTATUS field is set to 0x00 for affirmative and 0x01 for negative.
-
-
-
-
- The Softloader receives the VS_HST_ACTION.RSP from the host and inspects the MSTATUS field. On affirmative status, the Softloader stops sending VS_HST_ACTION messages and waits indefinitely for the firmware image and PIB.
-
-
-
-
- The local host determines which firmware image and PIB to download. In some cases there may be no choice. In other cases, there may be a choice between default and custom software or between current and upgraded software. This is a principle design issue to consider.
-
-
-
-
- The local host downloads a firmware image to the device by sending VS_WR_MOD.REQ messages to the device and waiting for a VS_WR_MEM.CNF messages from the device after each request. Each message contains an image segment, the memory offset, the segment length and the checksum used to monitor and manage download progress. If a single transaction fails, the local host should detect it and repeat it.
-
-
-
-
- The local host downloads a PIB to the device by sending VS_WR_MOD.REQ messages to the device and waiting for a VS_WR_MEM.CNF message from the device after each request. Each message contains an image segement, the memory offset, the segment length and the checksum used to monitor and manage download progress. If a single transaction fails, the local host should detect it and repeat it.
-
-
-
-
- The local host starts execution of the downloaded firmware by sending a VS_ST_MAC.REQ message to the device. The message contains the start address for the firmware.
-
-
-
-
- The Softloader receives the VS_ST_MAC.REQ from the local host, validates the content.
-
-
-
- The Softloader sends a VS_ST_MAC.CNF message to the local host to indicate an ability or willingness to start execution. Assuming an ability and willingness, the Softloader immediately starts firmware execution which relinquishes device control to the firmware.
-
-
-
-
- The local host receives the VS_ST_MAC.CNF message from the device, inspects the MSTATUS field and acts accordingly. Assuming an affirmative status, this process terminates.
-
-
-
-
diff --git a/docbook/firmware-6000-flash.xml b/docbook/firmware-6000-flash.xml
deleted file mode 100644
index 06c91b9b..00000000
--- a/docbook/firmware-6000-flash.xml
+++ /dev/null
@@ -1,66 +0,0 @@
-
-
- Upgrade Device (INT6000/INT6300/INT6400)
-
-
- The Upgrade Device operation downloads firmware and/or PIB from a remote host to an Atheros device for permanent storage and immediate execution. The device determines where and how it will store the information based on the availability of onboard flash memory. If the device has dedicated flash memory then it will store the firmware and PIB there and reset itself; otherwise, it will hand the firmware and PIB to the local host for storage and the local host will reset the device. The reset ensures that new firmware and PIB take immediate effect once they are saved. This operation requires custom software on the remote host and Atheros firmware on the device.
-
-
-
- Upgrade Device (INT6000/INT6300/INT6400)
-
- | [01]
- [01] |<------- VS_WR_MOD.CNF -------------| [01]
- [01] |----------------------------------->| [01]
- [01] |<-----------------------------------| [01]
- | |
- [02] |-------- VS_WR_MOD.REQ ------------>| [02]
- [02] |<------- VS_WR_MOD.CNF -------------| [02]
- [02] |----------------------------------->| [02]
- [02] |<-----------------------------------| [02]
- | |
- [03] |-------- VS_MOD_NVM.REQ ----------->| [04]
- [05] |<------- VS_MOD_NVM.CNF ------------| [04]
- | | [06]
-
-]]>
-
-
-
-
- Optionally, the remote host writes firmware to the device by sending a series of VS_WR_MOD.REQ messages and waiting for a VS_WR_MOD.CNF message after each one. The message MODULEID field is set to 0x01 for this operation.
-
-
-
-
- Optionally, the remote host writes the PIB to the device by sending VS_WR_MOD.REQ messages and waiting for a VS_WR_MOD.CNF message after each one. The MODULEID is set to 0x02 for this operation.
-
-
-
-
- The remote host commits the firmware and/or PIB to persistent storage by sending a VS_MOD_NVM.REQ message and waiting for a VS_MOD_NVM.CNF message.
-
-
-
-
- The device received the VS_MOD_NVM.REQ and sends a VS_MOD_NVM.CNF message to the remote host.
-
-
-
-
- The remote host receives the VS_MOD_NVM.CNF and proceeds with other activity. The remote host does not know or care that the device may not have dedicated flash memory available.
-
-
-
-
- The device determines where and how to store the information. If dedicated flash memory is available, the device writes the downloaded firmware and PIB to flash memory and performs a software reset that results in a normal Boot from Flash operation. If no dedicated flash memory is available, the device initiates an Update Local Host operation.
-
-
-
-
- The device does not notify the remote host when the upgrade operation completes. It is therefore incumbent on the remote host to determine ultimate success or failure by polling the device, possiby using a VS_SW_VER.REQ message, until a response is received. The complete upgrade operation can take from 20 seconds to 45 seconds depending on device configuration.
-
-
diff --git a/docbook/firmware-6000-upload.xml b/docbook/firmware-6000-upload.xml
deleted file mode 100644
index a004b783..00000000
--- a/docbook/firmware-6000-upload.xml
+++ /dev/null
@@ -1,76 +0,0 @@
-
-
- Update Local Host (INT6000/INT6300/INT6400)
-
-
- The Update Local Host operation transfers a firmware image and/or PIB image from the device to the local host for permanent storage. After the firmware and PIB are stored, the local host will reset the device and the device will retrieve parameters and firmware using the Boot from Host operation described in the next section.
-
-
- The firmware may initiate this operation after a remote host has downloaded new firmware or PIB and issued a VS_MOD_NVM.REQ to the device, the device has been asked to restore factory default settings or the firmware has dynamically altered the runtime PIB in some way. Consequently, the device will be reset by the host in each case.
-
-
- The device initiates this operation to complete an Upgrade Device operation when the device has no dedicated flash memory onboard. This operation requires running Atheros firmware on the device and custom software on the local host.
-
-
-
- Update Local Host (INT6000/INT6300/INT6400)
-
- | [01]
- [03] |<------- VS_HOST_ACTION.RSP --------| [02]
- | |
- [04] |<------- VS_RD_MOD.REQ -------------| [04]
- [04] |-------- VS_RD_MOD.CNF ------------>| [04]
- [04] |<-----------------------------------| [04]
- [04] |----------------------------------->| [04]
- | |
- [05] |<------- VS_RD_MOD.REQ -------------| [05]
- [05] |-------- VS_RD_MOD.CNF ------------>| [05]
- [05] |<-----------------------------------| [05]
- [05] |----------------------------------->| [05]
- | |
- [06] |<------- VS_RS_DEV.REQ -------------| [06]
- [07] |-------- VS_RS_DEV.CNF ------------>| [07]
-
-]]>
-
-
-
-
- The runtime firmware initiates this operation by broadcasting VS_HOST_ACTION.IND messages every 500 milliseconds. The HOST_ACTION_REQ field of the message can be either 0x01, 0x02 or 0x03 to indicate that a firmware image, a parameter block image or both are ready for upload by the local host.
-
-
-
-
- The local host sends a VS_HOST_ACTION.RSP message to the device to indicate the ability and willingness to upload the information. The MSTATUS field is set to 0x00 for affirmative and 0x01 for negative.
-
-
-
-
- Assuming an affirmative response, the device stops broadcasting and will wait indefinitely for local host action.
-
-
-
-
- Optionally, the local host reads the firmware image from the device by sending a series of VS_RD_MOD.REQ messages to the device and waiting for a VS_RD_MOD.CNF message after each one. The message MODULEID field is set to 0x01 for this operation.
-
-
-
-
- Optionally, the local host reads the PIB from the device by sending a series of VS_RD_MOD.REQ messages to the device and waiting for a VS_RD_MOD.CNF message after each one. The message MODULEID field is set to 0x02 for this operation.
-
-
-
-
- The local host sends a VS_RS_DEV.REQ message to the device to initiate a firmware reboot.
-
-
-
-
- The device sends a VS_RS_DEV.CNF to the host and performs a software reset. This forces a Boot from Host.
-
-
-
-
diff --git a/docbook/firmware-6300-boot.xml b/docbook/firmware-6300-boot.xml
deleted file mode 100644
index 9621a0cb..00000000
--- a/docbook/firmware-6300-boot.xml
+++ /dev/null
@@ -1,119 +0,0 @@
-
-
- Boot from Host (INT6300)
-
-
- The boot-from-host operation downloads SDRAM configuration information, runtime parameters and runtime firmware from a local host and starts firmware execution. This method is initiated by the device bootloader after reset reset if the device has no flash memory, blank flash memory or corrupted flash memory. The method requires the bootloader aware software running on the local host to detect and service VS_HOST_ACTION messages from the device.
-
-
- The INT6300 boot-from-host method is similar to the INT6000 method but it has an extra stage to download SDRAM configuration parameters and it uses VS_WR_MEM messages to download runtime parameters and firmware instead of VS_WR_MOD messages. The VS_WR_MEM messages write directly to SDRAM and an VS_ST_MAC message is needed to start firmware execution. Once the firmware is running, another method is used to write runtime parameters and firmware to flash memory.
-
-
- The INT6300 does not have a unique hardware address until runtime firmware starts and assigns one from the runtime parameter block. Until that time, the bootloader will accept messages addressed to 00:B0:52:00:00:01. In addition, the bootloader does not know the hardware address of the local host and so it addresses VS_HOST_ACTION messages to FF:FF:FF:FF:FF:FF; however, these messages are not transmitted over the powerline.
-
-
-
- boot-from-host (INT6300)
-
- | [03]
- [05] |<------- VS_HOST_ACTION.RSP --------| [04]
- | |
- [07] |<------- VS_SET_SDRAM.REQ ----------| [06]
- [07] |-------- VS_SET_SDRAM.CNF --------->| [08]
- | | [09]
- [10] |<------- VS_WR_MEM.REQ -------------| [10]
- [10] |-------- VS_WR_MEM.CNF ------------>| [10]
- [10] |<-----------------------------------| [10]
- [10] |----------------------------------->| [10]
- | |
- [11] |<------- VS_WR_MEM.REQ -------------| [11]
- [11] |-------- VS_WR_MEM.CNF ------------>| [11]
- [11] |<-----------------------------------| [11]
- [11] |----------------------------------->| [11]
- | |
- [13] |<------- VS_ST_MAC.REQ -------------| [12]
- [14] |-------- VS_ST_MAC.CNF ------------>| [15]
-
- ]]>
-
-
-
-
- The bootloader automatically starts after device reset and attempts to read the runtime firmware image from flash memory, write it into SDRAM and start execution. If it succeeds then normal operation begins and no further action is required. If it fails, for any reason, then the bootloader starts the boot-from-host process.
-
-
-
-
- The bootloader broadcasts VS_HOST_ACTION.IND with HOST_ACTION_REQ set to 0x04 to indicate that configuration is required. The destination address is FF:FF:FF:FF:FF:FF and the source address is 00:B0:52:00:00:01 as explained above. This message is sent every 10 seconds which differs from that of other chips.
-
-
-
-
- The host receives the VS_HOST_ACTION.IND message and inspects the HOST_ACTION_REQ field to determine the action requested. On a single-host system, the local host must elect to service the request or the device will not start. On a multi-host system, one of the hosts must elect to service the request of the device will not start.
-
-
-
-
- The host sends a VS_HOST_ACTION.RSP message to the device to indicate an ability and willingness to service the request. The MSTATUS field is set to 0x00 for affirmative and 0x01 for negative.
-
-
-
-
- The bootloader receives the VS_HOST_ACTION.RSP from the host and inspects the MSTATUS field. On affirmative response, the bootloader stops broadcasting VS_HOST_ACTION.IND and waits indefinitely for SDRAM configuration information from the host.
-
-
-
-
- The host sends a VS_SET_SDRAM.REQ message to the device containing an SDRAM configuration block and the block checksum.
-
-
-
-
- The bootloader receives the VS_SET_SDRAM.REQ, validates the content, initializes SDRAM parameters and sends a VS_SET_SDRAM.CNF message to the servicing host to indicate either success or failure.
-
-
-
-
- The local host receives the VS_SET_SDRAM.CNF and inspects the MSTATUS field for success or failure. Assuming success, the local host waits indefinitely for further requests from the device.
-
-
-
-
- The local host determines which parameter block and firmware image to download. In some cases there may be no choice. In other cases, there may be a choice between default and custom software or between current and upgraded software. This is a principle design issue to consider.
-
-
-
-
- The local host downloads the firmware image to the device by sending VS_WR_MEM.REQ messages to the device and waiting for a VS_WR_MEM.CNF messages from the device after each request. Each message contains an image segment, the memory offset, the segment length and the checksum used to monitor and manage download progress. It a single transaction fails, the local host should detect it and repeat it.
-
-
-
-
- The local host downloads a parameter block to the device by sending VS_WR_MEM.REQ messages to the device and waiting for a VS_WR_MEM.CNF message from the device after each request. Each message contains an image segment, the memory offset, the segment length and the checksum used to monitor and manage download progress. If a single transaction fails, the local host should detect it and repeat it.
-
-
-
-
- The local host starts firmware execution by sending a VS_ST_MAC.REQ message to the device. The message contains the firmware start address.
-
-
-
-
- The bootloader receives the VS_ST_MAC.REQ from the local host, validates the content.
-
-
-
- The device sends a VS_ST_MAC.CNF message to indicate an ability or willingness to start firmware execution. The device immediately starts firmware execution which relinquishes device control to the firmware. It can take 5 to 10 seconds for the firmware to start.
-
-
-
-
- The host receives the VS_ST_MAC.CNF message from the device, inspects the MSTATUS field and acts accordingly. An afffirmative indication means that the firmware will start executing on the device in 5 to 10 seconds. Once the firmware starts, future messages will contain the unique hardware address for the device.
-
-
-
-
diff --git a/docbook/firmware-6400-boot.xml b/docbook/firmware-6400-boot.xml
deleted file mode 100644
index c1d3a830..00000000
--- a/docbook/firmware-6400-boot.xml
+++ /dev/null
@@ -1,174 +0,0 @@
-
-
- Boot from Host (INT6400)
-
-
- The INT6400 boot-from-host operation downloads and executes a memory configuration applet then downloads runtime parameters and firmware from a local host and starts firmware execution. This method is initiated by the INT6400 bootloader after reset on a device having no flash memory, blank flash memory or corrupted flash memory. The method requires bootloader aware software running on the local host in order to complete.
-
-
- The INT6400 boot-from-host method is similar to the INT6300 boot-from-host method but it downloads and executes an SDRAM configuration applet instead of downloading SDRAM parameters. The applet is downloaded and executed using the same mechanism as runtime firmware. The applet executes and returns to the bootloader when done. The bootloader then continues to drive the boot process using VS_HOST_ACTION messages.
-
-
- The INT6400 boot-from-host method will work for AR7400 and QCA7420 chipsets but will not work on successive chipsets. Customers should adopt or implement the AR7400 boot-from-host method, instead of this one, to avoid building obsolete products.
-
-
- The INT6400 does not have a unique hardware address until the firmware starts and assigns one from the parameter information block. Until that time, the bootloader will only acknowledge messages addressed to 00:B0:52:00:00:01. In addition, the bootloader does not know the hardware address of the local host and so it addresses VS_HOST_ACTION messages to FF:FF:FF:FF:FF:FF; however, these messages are not transmitted over the powerline.
-
-
-
- Boot from Host (INT6400)
-
-| [03]
- [05] |<------- VS_HOST_ACTION.RSP --------| [04]
- | |
- [06] |<------- VS_WR_MEM.REQ -------------| [06]
- [06] |-------- VS_WR_MEM.CNF ------------>| [06]
- [06] |<-----------------------------------| [06]
- [06] |----------------------------------->| [06]
- | |
- [08] |<------- VS_ST_MAC.REQ -------------| [07]
- [09] |-------- VS_ST_MAC.CNF ------------>| [10]
- [11] | |
- [12] |-------- VS_HOST_ACTION.IND ------->| [13]
- [15] |<------- VS_HOST_ACTION.RSP --------| [14]
- | |
- | | [16]
- | |
- [17] |<------- VS_WR_MEM.REQ -------------| [17]
- [17] |-------- VS_WR_MEM.CNF ------------>| [17]
- [17] |<-----------------------------------| [17]
- [17] |----------------------------------->| [17]
- | |
- [18] |<------- VS_WR_MEM.REQ -------------| [18]
- [18] |-------- VS_WR_MEM.CNF ------------>| [18]
- [18] |<-----------------------------------| [18]
- [18] |----------------------------------->| [18]
- | |
- [20] |<------- VS_ST_MAC.REQ -------------| [19]
- [21] |-------- VS_ST_MAC.CNF ------------>| [22]
-
- ]]>
-
-
-
-
- The bootloader automatically starts after device reset and attempts to read the runtime firmware image from flash memory, write it into SDRAM and start execution. If it succeeds then normal operation begins and no futher action is required. If it fails, for any reason, then the bootloader initiates the boot-from-host sequence.
-
-
-
-
- The bootloader broadcasts VS_HOST_ACTION.IND with HOST_ACTION_REQ set to 0x04 to request configuration. The destination address is FF:FF:FF:FF:FF:FF and source address is 00:B0:52:00:00:01 as explained above. This message is sent every 500 milliseconds which differs from that of other chips.
-
-
-
-
- The local host receives the VS_HOST_ACTION.IND message and inspects the HOST_ACTION_REQ field to determine the appropriate action. On a single-host system, the lone host must service the request or the device will not start. On a multi-host system, one host must elect to service the request of the device will not start.
-
-
-
-
- The local host sends VS_HOST_ACTION.RSP to silence the bootloader or indicate the ability and willingness to service the request. The destination address must be 00:B0:52:00:00:01 and the source address is that of the host interface. The MSTATUS field is set to 0x00 for affirmative and 0x01 for negative.
-
-
-
-
- The bootloader receives the VS_HOST_ACTION.RSP from the host and inspects the MSTATUS field. On affirmative response, the bootloader stops broadcasting VS_HOST_ACTION.IND messages and waits indefinitely for the local host to download a configuation applet and start execution.
-
-
-
-
- The host downloads the memory control applet to the device by sending VS_WR_MEM.REQ messages to the device and waiting for a VS_WR_MEM.CNF message from the device after each one. Each message contains an image segment and the segment memory offset, length and checksum. These values are used to monitor and manage download progress. If a transaction fails, the host can detect it and should repeat it.
-
-
-
-
- The host starts execution of the memory control applet by sending a VS_ST_MAC.REQ message to the device. The message contains the applet load address, length, checksum and start address. These values are often obtained from an NVM file image header.
-
-
-
-
-
- The bootloader receives the VS_ST_MAC.REQ from the host and validates the contents.
-
-
-
-
- The bootloader sends a VS_ST_MAC.CNF message to the host indicating the ability and willingness to start applet execution. The MSTATUS field is set to 0x00 for affirmative and 0x01 for negative.
-
-
-
-
- The host receives the VS_ST_MAC.CNF message from the device and evaluates the MSTATUS field. On affirmative, the host waits for further requests from the device. On negative, the host may attempt another start or another download followed by a start or attempt to alert a human.
-
-
-
-
- The bootloader starts applet execution. The applet configures memory, runs to completion and returns to the Bootloader.
-
-
-
-
- The bootloader broadcasts a VS_HOST_ACTION.IND message every 500 milliseconds to request runtime firmware and parameter download. The message destination address is FF:FF:FF:FF:FF:FF and source address is 00:B0:52:00:00:01 as explained above. The HOST_ACTION_REQ field is set to 0x00.
-
-
-
-
- The host receives the VS_HOST_ACTION.IND message and inspects the HOST_ACTION_REQ field to determine the requested action. On a single-host system, the lone host must service the request or the device will not start. On a multi-host system, one host must elect to service the request of the device will not start.
-
-
-
-
- The host sends a VS_HOST_ACTION.RSP message to the device to indicate the ability and willingness to service the request. The MSTATUS field is set to 0x00 for affirmative and 0x01 for negative.
-
-
-
-
- The bootloader receives the VS_HOST_ACTION.RSP from the host and inspects the MSTATUS field. On affirmative response, the bootloader stops broadcasting VS_HOST_ACTION.IND messages and waits indefinitely for the host to download the runtime firmware and parameters and start execution.
-
-
-
-
- The host determines which firmware and parameter image to download. In some cases there may be no choice. In other cases, there may be a choice between default and custom images or between current and upgraded images. This is a principle design issue to consider.
-
-
-
-
- The host downloads the firmware image to the device by sending VS_WR_MEM.REQ messages to the device and waiting for a VS_WR_MEM.CNF message from the device after each one. Each message contains an image segment and the segment memory offset, length and checksum. These values are used to monitor and manage download progress. If a transaction fails, the local host can detect it and should repeat it.
-
-
-
-
- The host downloads the parameter block to the device by sending VS_WR_MEM.REQ messages to the device and waiting for a VS_WR_MEM.CNF message from the device after each one. Each message contains an image segment and the segment memory offset, length and checksum. These values are used to monitor and manage download progress. If a transaction fails, the local host can detect it and should repeat it.
-
-
-
-
- The host starts runtime firmware execution by sending a VS_ST_MAC.REQ message to the device. The message contains the firmware load address, length, checksum and start address. These values are often obtained from an NVM file image header.
-
-
-
-
- The bootloader receives the VS_ST_MAC.REQ from the host and validates the content.
-
-
-
-
- The bootloader sends a VS_ST_MAC.CNF message to indicate the ability or willingness to start firmware execution.
-
-
-
-
- The host receives the VS_ST_MAC.CNF message from the device, inspects the MSTATUS field and acts accordingly.
-
-
-
-
- The bootloader starts runtime firmware execution. The firmware reads and validates the parameter block then assumes full control of the device. It can take several seconds for firmware start to be evident. Once the firmware starts, any future VS_HOST_ACTION messages will contain the unique hardware address for the device.
-
-
-
-
diff --git a/docbook/firmware-7400-boot.xml b/docbook/firmware-7400-boot.xml
deleted file mode 100644
index 7c14e931..00000000
--- a/docbook/firmware-7400-boot.xml
+++ /dev/null
@@ -1,175 +0,0 @@
-
-
- Boot from Host (AR7400)
-
-
- The AR7400 boot-from-host method downloads and executes a device configuration applet then downloads runtime parameters and firmware from a local host and starts firmware execution. This method is initiated by the Bootloader after reset on a device having no flash memory, blank flash memory or corrupted flash memory. The method requires Bootloader aware software running on the local host in order to complete.
-
-
- The AR7400 boot-from-host method is similar to the INT6400 boot-from-host method but it uses the VS_WRITE_AND_EXECUTE message instead of the VS_WR_MEM message write into SDRAM and start firmware execution. This eliminates the need for the VS_ST_MAC message. The VS_WR_MEM and VS_ST_MAC message types will no longer be recognized by bootloaders after the QCA7420 chipset.
-
-
- The AR7400 boot-from-host method works on AR6400 and will continue to work on QCA7420 and planned successors. Customers should implement this boot-from-host method now to avoid building obsolete products.
-
-
- The AR7400 does not have a unique hardware address until the firmware starts and assigns one read from the PIB. Until that time, the Bootloader will only acknowledge messages addressed to 00:B0:52:00:00:01. In addition, the Bootloader does not know the hardware address of the local host and so it addresses all VS_HOST_ACTION messages to FF:FF:FF:FF:FF:FF; however, these messages are not transmitted over the powerline.
-
-
-
- Boot from Host (AR7400)
-
-| [03]
- [05] |<------- VS_HOST_ACTION.RSP --------| [04]
- | | [06]
- |<---- VS_WRITE_AND_EXECUTE.REQ -----| [07]
- [08] |----- VS_WRITE_AND_EXECUTE.CNF ---->|
- |<-----------------------------------| [09]
- [10] |----------------------------------->| [11]
- [12] | |
- [13] |-------- VS_HOST_ACTION.IND ------->| [14]
- [16] |<------- VS_HOST_ACTION.RSP --------| [15]
- | | [16]
- |<-VS_WRITE_AND_EXECUTE_APPLET.REQ --| [17]
- [18] |--VS_WRITE_AND_EXECUTE_APPLET.CNF ->|
- |<-----------------------------------| [19]
- [20] |----------------------------------->|
- |<-VS_WRITE_AND_EXECUTE_APPLET.REQ --| [21]
- [22] |--VS_WRITE_AND_EXECUTE_APPLET.CNF ->|
- |<-----------------------------------| [23]
- [24] |----------------------------------->|
- [25] | |
-
- ]]>
-
-
-
-
- The bootloader automatically starts after device reset and attempts to read the runtime firmware image from flash memory, write it into SDRAM and start execution. If it succeeds then normal operation begins and no further action is required. If it fails, for any reason, then the bootloader initiates the boot-from-host sequence.
-
-
-
-
- The bootloader broadcasts VS_HOST_ACTION.IND with HOST_ACTION_REQ set to 0x04 to indicate that it is waiting to be configured. The bootloader continues to broadcast this message message every 750 milliseconds which differs from that of other chips.
-
-
-
-
- The local host receives the VS_HOST_ACTION.IND and inspects HOST_ACTION_REQ field to determine the required action. The local host must be programmed to listen and act appropriately.
-
-
-
-
- The local host sends a VS_HOST_ACTION.RSP message with MSTATUS set to 0 to indicate the start of sequence.
-
-
-
-
- The bootloader receives the VS_HOST_ACTION.RSP message, stops broadcasting VS_HOST_ACTION.IND messages and waits indefinitely for the local host to act.
-
-
-
-
- The local host retrieves the firmware chain and extracts the configuration applet image from the chain. The firmware chain may be stored on disk or in memory depending on how the local host is programmed.
-
-
-
-
- The local host sends a VS_WRITE_AND_EXECUTE.REQ message with FLAGS set to 2 and ALLOWED_MEM_TYPES to 1 to download the applet in absolute address mode. Alternately, setting FLAGS to 0 and CURR_PART_OFFSET to 0 will download the applet in relative address mode. The TOTAL_LENGTH will be the applet image header IMAGELENGTH but CURR_PART_LENGTH cannot exceed 1400 bytes.
-
-
-
-
- The bootloader acknowledges each VS_WRITE_AND_EXECUTE.REQ message with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
-
-
-
- The local host continues to increment CURR_PART_OFFSET and download the configuration applet in 1400 byte blocks until the last block is reached. The local host then sets START_ADDR to the applet image header ENTRYPOINT, the CHECKSUM to the applet image header IMAGECHECKSUM and the execute bit in FLAGS to 1 in the last message frame.
-
-
-
-
- The bootloader receives the last VS_WRITE_AND_EXECUTE.REQ message, confirms the configuration applet checksum then acknowledges with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
-
-
-
- The local host exists the boot from host sequence and returns to listening mode.
-
-
-
-
- The bootloader executes the configuration applet. The device hardware address is 00:B0:52:00:00:01 in this state.
-
-
-
-
- The bootloader broadcasts a VS_HOST_ACTION.IND message with HOST_ACTION_REQ set to 0 to indicate that it is waiting for runtime parameters and firmware.
-
-
-
-
- The local host receives a VS_HOST_ACTION.IND message and inspects the HOST_ACTION_REQ field to determine the required action. The local host must be programmed to listen and act appropriately.
-
-
-
-
- The bootloader receives the VS_HOST_ACTION.RSP message, stops broadcasting VS_HOST_ACTION.IND messages and waits indefinitely for the local host to act.
-
-
-
-
- The local host locates the parameter chain and firmware chain. The chains may be stored on disk or in memory depending on how the local host is programmed.
-
-
-
-
- The local host sends a VS_WRITE_AND_EXECUTE.REQ message with FLAGS set to 2 and ALLOWED_MEM_TYPES set to 1 to download parameters in absolute address mode. Alternately, setting FLAGS to 0 and CURR_PART_OFFSET to 0 will download parameters in relative address mode. The TOTAL_LENGTH will be the entire parameter file length but the CURR_PART_LENGTH cannot exceed 1400 bytes.
-
-
-
-
- The bootloader acknowledges each VS_WRITE_AND_EXECUTE.REQ message with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
-
-
-
- The local host continues to CURR_PART_OFFSET and download the parameter chain in 1400 byte blocks until the last block is reached. The local host then sets the START_ADDR field to the parameter image header ENTRYPOINT, the CHECKSUM to the parameter image header IMAGECHECKSUM and the execute bit in FLAGS to 1 in the last message frame.
-
-
-
-
- The bootloader receives the last VS_WRITE_AND_EXECUTE.REQ message, confirms the parameter chain checksum and acknowledges with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
-
-
-
- The local host sends a VS_WRITE_AND_EXECUTE.REQ message with FLAGS set to 2 and ALLOWED_MEM_TYPES to 1 to download firmware in absolute address mode. Alternately, setting FLAGS to 0 and CURR_PART_OFFSET to 0 will download firmware in relative address mode. The TOTAL_LENGTH will be the firmware image header IMAGELENGTH but the CURR_PART_LENGTH cannot exceed 1400 bytes.
-
-
-
-
- The bootloader acknowledges each VS_WRITE_AND_EXECUTE.REQ message with a VS_WRITE_AND_EXECUTE.CNF message having the MSTATUS field set to 0.
-
-
-
-
- The local host continues to increment CURR_PART_OFFSET and download the parameter chain in 1400 byte blocks until the last block is reached. The local host then sets START_ADDR to the parameter image header ENTRYPOINT, the CHECKSUM to the parameter image header IMAGECHECKSUM and the execute bit in FLAGS to 1 in the last message frame.
-
-
-
-
- The bootloader receives the last VS_WRITE_AND_EXECUTE.REQ message, confirms the firmware chain checksum and acknowledges with a VS_WRITE_AND_EXECUTE.CNF message having the MSTATUS field set to 0.
-
-
-
-
- The bootloader executes the runtime firmware and the device begins operation. The device hardware address will become that programmed into the parameter inforamtion block.
-
-
-
-
diff --git a/docbook/firmware-7420-boot.xml b/docbook/firmware-7420-boot.xml
deleted file mode 100644
index ff4b4cb1..00000000
--- a/docbook/firmware-7420-boot.xml
+++ /dev/null
@@ -1,169 +0,0 @@
-
-
- Boot from Host (AR7420)
-
-
- The VS_WRITE_AND_EXECUTE message is now the only way to write runtime parameters and firmware into volatile memory. The legacy VS_RD_MEM, VS_WR_MEM and VS_ST_MAC are deprecated and will no longer be supported by the bootloader. This means that some customers must re-write their applications to boot newer powerline devices.
-
-
-
- Boot from Host (AR6410/AR7420)
-
-| [03]
- [05] |<------- VS_HOST_ACTION.RSP --------| [04]
- | | [06]
- |<---- VS_WRITE_AND_EXECUTE.REQ -----| [07]
- [08] |----- VS_WRITE_AND_EXECUTE.CNF ---->|
- |<-----------------------------------| [09]
- [10] |----------------------------------->| [11]
- [12] | |
- [13] |-------- VS_HOST_ACTION.IND ------->| [14]
- [16] |<------- VS_HOST_ACTION.RSP --------| [15]
- | | [16]
- |<-VS_WRITE_AND_EXECUTE_APPLET.REQ --| [17]
- [18] |--VS_WRITE_AND_EXECUTE_APPLET.CNF ->|
- |<-----------------------------------| [19]
- [20] |----------------------------------->|
- |<-VS_WRITE_AND_EXECUTE_APPLET.REQ --| [21]
- [22] |--VS_WRITE_AND_EXECUTE_APPLET.CNF ->|
- |<-----------------------------------| [23]
- [24] |----------------------------------->|
- [25] | |
-
- ]]>
-
-
-
-
- The bootloader enters boot-from-host mode based on the hardware strapping or failure to load runtime firmware from flash memory. The device hardware address is 00:B0:52:00:00:01 in this state.
-
-
-
-
- The bootloader broadcasts a VS_HOST_ACTION.IND message with HOST_ACTION_REQ set to 4 to indicate that it is waiting to be configured. The bootloader will continue to broadcast the VS_HOST_ACTION.IND message every 750ms until it receives a VS_HOST_ACTION.RSP message from the local host. The BootROM does not know the local host hardware address at this stage so indications are broadcast, not addressed.
-
-
-
-
- The local host receives a VS_HOST_ACTION.IND message and inspects HOST_ACTION_REQ field to determine the required action. The local host must be programmed to listen and act appropriately. The first indcation requests device configuration.
-
-
-
-
- The local host sends a VS_HOST_ACTION.RSP message with MSTATUS set to 0 to indicate a willingness and ability to service the request.
-
-
-
-
- The bootloader receives the VS_HOST_ACTION.RSP message, stops broadcasting VS_HOST_ACTION.IND messages and waits indefinitely for the local host to act.
-
-
-
-
- The local host retrieves the firmware chain and extracts the configuration applet image from the chain. The firmware chain may be stored on disk or in memory depending on how the local host is programmed.
-
-
-
-
- The local host sends a VS_WRITE_AND_EXECUTE.REQ message with FLAGS set to 2, ALLOWED_MEM_TYPES to 1, CURR_PART_OFFSET to the applet image header IMAGEADDRESS and CURR_PART_LENGTH to the applet image header IMAGELENGTH to download the applet in absolute address mode. Alternately, setting FLAGS to 0 and CURR_PART_OFFSET to 0 will download the applet in relative address mode.
-
-
-
-
- The bootloader acknowledges each VS_WRITE_AND_EXECUTE.REQ message with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
-
-
-
- The local host continues to download the configuration applet in 1400 byte blocks until the last block is reached. The local host sets START_ADDR to the applet image header ENTRYPOINT, CHECKSUM to the applet image header IMAGECHECKSUM and the execute bit in FLAGS to 1.
-
-
-
-
- The bootloader receives the last VS_WRITE_AND_EXECUTE.REQ message, confirms the configuration applet checksum then acknowledges with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
-
-
-
- The local host exists the boot from host sequence and returns to listening mode.
-
-
-
-
- The bootloader executes the configuration applet. The device hardware address is 00:B0:52:00:00:01 in this state.
-
-
-
-
- The bootloader broadcasts a VS_HOST_ACTION.IND message with HOST_ACTION_REQ set to 0 to indicate that it is waiting for runtime parameters and firmware.
-
-
-
-
- The local host receives a VS_HOST_ACTION.IND message and inspects the HOST_ACTION_REQ field to determine the required action. The local host must be programmed to listen and act appropriately.
-
-
-
-
- The bootloader receives the VS_HOST_ACTION.RSP message, stops broadcasting VS_HOST_ACTION.IND messages and waits indefinitely for the local host to act.
-
-
-
-
- The local host locates the parameter chain and firmware chain. The chains may be stored on disk or in memory depending on how the local host is programmed.
-
-
-
-
- The local host sends a VS_WRITE_AND_EXECUTE.REQ message with FLAGS set to 2, ALLOWED_MEM_TYPES set to 1, CURR_PART_OFFSET to the parameter image header IMAGEADDRESS and CURR_PART_LENGTH to the entire parameter image chain length to download parameters in absolute address mode. Alternately, setting FLAGS to 0 and CURR_PART_OFFSET to 0 will download parameters in relative address mode.
-
-
-
-
- The bootloader acknowledges each VS_WRITE_AND_EXECUTE.REQ message with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
-
-
-
- The local host continues to download the parameter chain in 1400 byte blocks until the last block is reached. The local host then sets the START_ADDR field to the parameter image header ENTRYPOINT, CHECKSUM to the parameter image header IMAGECHECKSUM and the execute bit in FLAGS to 1.
-
-
-
-
- The bootloader receives the last VS_WRITE_AND_EXECUTE.REQ message, confirms the parameter chain checksum and acknowledges with a VS_WRITE_AND_EXECUTE.CNF message having MSTATUS set to 0.
-
-
-
-
- The local host sends a VS_WRITE_AND_EXECUTE.REQ message with FLAGS set to 2, ALLOWED_MEM_TYPES to 1, CURR_PART_OFFSET to the firmware image header IMAGEADDRESS and CURR_PART_LENGTH to the firmware image header IMAGELENGTH to download firmware in absolute address mode. Alternately, setting FLAGS to 0 and CURR_PART_OFFSET to 0 will download firmware in relative address mode.
-
-
-
-
- The bootloader acknowledges each VS_WRITE_AND_EXECUTE.REQ message with a VS_WRITE_AND_EXECUTE.CNF message having the MSTATUS field set to 0.
-
-
-
-
- The local host continues to download the parameter chain in 1400 byte blocks until the last block is reached. The local host then sets START_ADDR to the parameter image header ENTRYPOINT, CHECKSUM to the parameter image header IMAGECHECKSUM and the execute bit in FLAGS to 1.
-
-
-
-
- The bootloader receives the last VS_WRITE_AND_EXECUTE.REQ message, confirms the firmware chain checksum and acknowledges with a VS_WRITE_AND_EXECUTE.CNF message having the MSTATUS field set to 0.
-
-
-
-
- The bootloader executes the runtime firmware and the device begins operation. The device hardware address will become that programmed into the parameter inforamtion block.
-
-
-
-
- At this point, runtime firmware is executing in volatile memory with runtime parameters. If the power is reset at this point then all would be lost. If the device has dedicated flash memory attached then we may want to write runtime parameters and firmware to flash memory so that the device can boot from flash in case of a power failure or reset.
-
-
diff --git a/docbook/firmware-7420-flash.xml b/docbook/firmware-7420-flash.xml
deleted file mode 100644
index 45f7aa0b..00000000
--- a/docbook/firmware-7420-flash.xml
+++ /dev/null
@@ -1,212 +0,0 @@
-
-
- Flash Memory (AR6410/AR7420)
-
-
- The VS_MODULE_OPERATION message is now the only way of write flash memory. The legacy message types VS_RD_MOD, VS_WR_MOD, VS_MOD_NVM and VS_PTS_NVM are deprecated and will no longer be supported by runtime firmware. This means that some customers must re-write their applications to flash newer powerline devices.
-
-
-
- The VS_MODULE_OPERATION message type has many formats and the structure differs with each format. Readers should consult the QCA Firmware Technical Reference Manual for a complete description.
-
-
-
- A blank flash memory must first be programmed with a softloader module. The module consists of a manifest, the executable softloader program image and a flash memory map. The map is used to manage flash memory during initializations and upgrades. The softloader module must be written into flash memory as a separate module before parameter and firmware modules are written. After that, parameter and firmware modules may be written and re-written without re-writing the softloader module. Of course, the softloader module must be re-written if flash memory is erased.
-
-
-
- Flashing the Softloader (AR7420)
-
- | [04]
- | |
- [06] |<-- VS_MODULE_OPERATION.REQ (Write Module) ---| [05]
- [07] |--- VS_MODULE_OPERATION.CNF (Write Module) -->| [08]
- |<---------------------------------------------|
- |--------------------------------------------->|
- | |
- [10] |<- VS_MODULE_OPERATION.REQ (Close Session) ---| [09]
- [11] |-- VS_MODULE_OPERATION.CNF (Close Session) -->| [12]
-
- ]]>
-
-
-
-
- The local host sends a VS_MODULE_OPERATION.REQ module write session request to register a session identifier and the module identifier, module length and module checksum of the softloader module. The softloader module identifier is 0x7003. The softloader module is the entire softloader chain including manifest, softloader image and flash memory layout.
-
-
-
-
- The device receives the request, validates the module identifier and preserves the module length and checksum until the module write session is closed. The local host has 30 minutes to complete registered module write operations and close the module write session.
-
-
-
-
- The device responds with VS_MODULE_OPERATION.CNF with MSTATUS set to 0, if things went well.
-
-
-
-
- The local host receives the confirmation and prepares to download the softloader module.
-
-
-
-
- The local host sends a VS_MODULE_OPERATION.REQ module write request containing the offset, length and content of the first portion of the module being downloaded.
-
-
-
-
- The device receives the request and write to a scrath region of flash memory awaiting session close.
-
-
-
-
- The device responds with VS_MODULE_OPERATION.CNF with MSTATUS set to 0 if things went well.
-
-
-
-
- The local host receives the confirmation and continues downloading the softloader in fragments using VS_MODULE_OPERATION write requests, advancing the offset and adjusting the length with each write.
-
-
-
-
- The local host send a VS_MODULE_OPERATION.REQ close module write session request having COMMIT_CODE bits 0 and 1 set. to indicate Force Commit and Commit without reset, respectively.
-
-
-
-
- The device recevies the request, verifies the module length and checksum then transfers the module from scratch memory to it's final location in flash memory.
-
-
-
-
- The device responds with VS_MODULE_OPERATION.CNF close module write session with MSTATUS set to 0 if things went well. If things did not go well then the local host must request a new write module session and start over.
-
-
-
-
- Once the softloader module is written, the parameter and firmware modules may be written in much the same way except that they must be written as a pair. The parameter module must be downloaded first. The firmware module cannot be committed to without a compatible parameter module.
-
-
- When parameters and firmware are written together the User PIB, Factory PIB and firmware are modified modified. The new User PIB is created by copying the old User PIB over the new one. Consequently the only change comes from extra fields found at the end of the new User PIB. The new Factory PIB becomes the new User PIB with certain fields from the old User PIB preserved, such as the MAC, DAK and so on.
-
-
-
- Flash Parameters and Firmware (AR7420)
-
- | [04]
- | |
- [06] |<-- VS_MODULE_OPERATION.REQ (write module) ---| [05]
- [07] |--- VS_MODULE_OPERATION.CNF (write module) -->| [08]
- |<---------------------------------------------|
- |--------------------------------------------->|
- | |
- [10] |<-- VS_MODULE_OPERATION.REQ (write module) ---| [09]
- [11] |--- VS_MODULE_OPERATION.CNF (write module) -->| [12]
- |<---------------------------------------------|
- |--------------------------------------------->|
- | |
- [14] |<- VS_MODULE_OPERATION.REQ (commit modules) --| [13]
- [15] |-- VS_MODULE_OPERATION.CNF (commit modules) ->| [16]
-
- ]]>
-
-
-
-
- The local host sends a VS_MODULE_OPERATION.REQ module write session request to register the session identifier, module identifiers, module lengths and module checksums. In this case, the two modules are the runtime parameters and runtime firmware. The module identifiers are 0x7002 and 0x7003, respectively. The application running on the local must must locate these modules and determine their size and checksum.
-
-
-
-
- The device receives the request, validates the module identifier and preserves the module lengths and checksums until the module write session is closed. The local host has 30 minutes to complete registered module write operations and close the module write session.
-
-
-
-
- The device responds with VS_MODULE_OPERATION.CNF with MSTATUS set to 0, if things went well.
-
-
-
-
- The local host receives the confirmation and prepares to download the parameter module.
-
-
-
-
- The local host sends a VS_MODULE_OPERATION.REQ module write request containing the offset, length and content of the first portion of the module being downloaded.
-
-
-
-
- The device receives the request and write to a scratch region of flash memory awaiting write session close.
-
-
-
-
- The device responds with VS_MODULE_OPERATION.CNF with MSTATUS set to 0 if things went well.
-
-
-
-
- The local host receives the confirmation and continues downloading the parameter module in fragments using VS_MODULE_OPERATION write requests, advancing the offset and adjusting the length with each write.
-
-
-
-
-
-
- The local host receives the confirmation and prepares to download the firmware module.
-
-
-
-
- The local host sends a VS_MODULE_OPERATION.REQ module write request containing the offset, length and content of the first portion of the module being downloaded.
-
-
-
-
- The device receives the request and write to a scratch region of flash memory awaiting write session close.
-
-
-
-
- The device responds with VS_MODULE_OPERATION.CNF with MSTATUS set to 0 if things went well.
-
-
-
-
- The local host receives the confirmation and continues downloading the firmware module in fragments using VS_MODULE_OPERATION write requests, advancing the offset and adjusting the length with each write.
-
-
-
-
-
- The local host send a VS_MODULE_OPERATION.REQ close module write session request having COMMIT_CODE bits 0 and 1 set. to indicate force commit and commit without reset, respectively.
-
-
-
-
- The device receives the request, verifies the module length and checksum then transfers the module from scratch memory to it's final location in flash memory.
-
-
-
-
- The device responds with VS_MODULE_OPERATION.CNF close module write session with MSTATUS set to 0 if things went well. If things did not go well then the local host must request a new write module session and start over.
-
-
-
-
- At this point, the device is ready to boot from flash memory if the power fails or the device resets.
-
-
diff --git a/docbook/firmware.sh.html b/docbook/firmware.sh.html
deleted file mode 100644
index b85e6a2a..00000000
--- a/docbook/firmware.sh.html
+++ /dev/null
@@ -1,207 +0,0 @@
-
-
-
-
-
- firmware.sh
-
-
-
-
-
-
-
-
-
-#!/bin/sh
-# file: scripts/firmware.sh
-
-#
-# this file contains a list of *.cfg, *.pib and *.nvm files available
-# on the host for use by scripts; scripts such as start.sh, flash.sh,
-# upgrade.sh and pts.sh all include this file;
-#
-# the last definition is the one that takes effect so you can merely
-# move the definition you want to the bottom of this file;
-#
-# to include this file in a new script:
-#
-# . ${SCRIPTS}/firmware.sh
-#
-
-# ====================================================================
-# a la carte;
-# --------------------------------------------------------------------
-
-. /etc/environment
-CFG=${FIRMWARE}/sdram64mb.cfg
-CFG=${FIRMWARE}/sdram16mb.cfg
-
-# ====================================================================
-# a la carte;
-# --------------------------------------------------------------------
-
-PIB=${FIRMWARE}/v2.0.4.pib
-NVM=${FIRMWARE}/v2.0.4-0-0-A-FINAL.nvm
-NVM=${FIRMWARE}/v2.0.4-0-0-B-FINAL.nvm
-
-PIB=${FIRMWARE}/v3.0.1.pib
-NVM=${FIRMWARE}/v3.0.1-0-1-A-RC3.nvm
-NVM=${FIRMWARE}/v3.0.1-0-1-B-RC3.nvm
-
-PIB=${FIRMWARE}/v3.0.5.pib
-NVM=${FIRMWARE}/v3.0.5-0-2-A-FINAL.nvm
-NVM=${FIRMWARE}/v3.0.5-0-2-B-FINAL.nvm
-
-PIB=${FIRMWARE}/v3.1.0.pib
-NVM=${FIRMWARE}/v3.1.0-0-3-A-FINAL.nvm
-NVM=${FIRMWARE}/v3.1.0-0-3-B-FINAL.nvm
-
-PIB=${FIRMWARE}/v3.1.3.pib
-NVM=${FIRMWARE}/v3.1.3-0-3-A-FINAL.nvm
-NVM=${FIRMWARE}/v3.1.3-0-3-B-FINAL.nvm
-
-PIB=${FIRMWARE}/v3.1.4.pib
-NVM=${FIRMWARE}/v3.1.4-0-3-A-FINAL.nvm
-NVM=${FIRMWARE}/v3.1.4-0-3-B-FINAL.nvm
-
-PIB=${FIRMWARE}/v3.1.7.pib
-NVM=${FIRMWARE}/v3.1.7-0-3-A-FINAL.nvm
-NVM=${FIRMWARE}/v3.1.7-0-3-B-FINAL.nvm
-
-PIB=${FIRMWARE}/v3.1.8.pib
-NVM=${FIRMWARE}/v3.1.8-0-3-A-FINAL.nvm
-NVM=${FIRMWARE}/v3.1.8-0-3-B-FINAL.nvm
-
-PIB=${FIRMWARE}/v3.1.9.pib
-NVM=${FIRMWARE}/v3.1.9-0-3-A-FINAL.nvm
-NVM=${FIRMWARE}/v3.1.9-0-3-B-FINAL.nvm
-
-PIB=${FIRMWARE}/v3.3.0.pib
-NVM=${FIRMWARE}/v3.3.0-0-5-A-RC3.nvm
-NVM=${FIRMWARE}/v3.3.0-0-5-C-RC3.nvm
-NVM=${FIRMWARE}/v3.3.0-0-5-B-RC3.nvm
-
-PIB=${FIRMWARE}/v3.3.0.pib
-NVM=${FIRMWARE}/v3.3.0-0-5-A-RC5.nvm
-NVM=${FIRMWARE}/v3.3.0-0-5-C-RC5.nvm
-NVM=${FIRMWARE}/v3.3.0-0-5-B-RC5.nvm
-
-PIB=${FIRMWARE}/v3.3.0.pib
-NVM=${FIRMWARE}/v3.3.0-0-5-A-RC8.nvm
-NVM=${FIRMWARE}/v3.3.0-0-5-C-RC8.nvm
-NVM=${FIRMWARE}/v3.3.0-0-5-B-RC8.nvm
-
-PIB=${FIRMWARE}/v3.3.1.pib
-NVM=${FIRMWARE}/v3.3.1-0-5-A-RC5.nvm
-NVM=${FIRMWARE}/v3.3.1-0-5-B-RC5.nvm
-NVM=${FIRMWARE}/v3.3.1-0-5-C-RC5.nvm
-
-PIB=${FIRMWARE}/v3.3.4.pib
-NVM=${FIRMWARE}/v3.3.4-0-8-A-RC1.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-B-RC1.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-C-RC1.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-D-RC1.nvm
-
-PIB=${FIRMWARE}/v3.3.4.pib
-NVM=${FIRMWARE}/v3.3.4-0-8-A-RC2.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-B-RC2.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-C-RC2.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-D-RC2.nvm
-
-PIB=${FIRMWARE}/v3.3.4.pib
-NVM=${FIRMWARE}/v3.3.4-0-8-A-RC3.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-B-RC3.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-C-RC3.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-D-RC3.nvm
-
-PIB=${FIRMWARE}/v3.3.4.pib
-NVM=${FIRMWARE}/v3.3.4-0-8-A-RC5.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-B-RC5.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-C-RC5.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-D-RC5.nvm
-
-PIB=${FIRMWARE}/v3.3.4.pib
-NVM=${FIRMWARE}/v3.3.4-0-8-A-RC6.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-B-RC6.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-C-RC6.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-D-RC6.nvm
-
-PIB=${FIRMWARE}/v3.3.4.pib
-NVM=${FIRMWARE}/v3.3.4-0-8-A-RC7.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-B-RC7.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-C-RC7.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-D-RC7.nvm
-
-PIB=${FIRMWARE}/v3.3.4.pib
-NVM=${FIRMWARE}/v3.3.4-0-8-A-RC9.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-B-RC9.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-C-RC9.nvm
-NVM=${FIRMWARE}/v3.3.4-0-8-D-RC9.nvm
-
-PIB=${FIRMWARE}/v3.3.5.pib
-NVM=${FIRMWARE}/v3.3.5-0-8-A-RC1.nvm
-NVM=${FIRMWARE}/v3.3.5-0-8-B-RC1.nvm
-NVM=${FIRMWARE}/v3.3.5-0-8-C-RC1.nvm
-NVM=${FIRMWARE}/v3.3.5-0-8-D-RC1.nvm
-
-PIB=${FIRMWARE}/v3.3.5.pib
-NVM=${FIRMWARE}/v3.3.5-0-8-A-RC2.nvm
-NVM=${FIRMWARE}/v3.3.5-0-8-B-RC2.nvm
-NVM=${FIRMWARE}/v3.3.5-0-8-C-RC2.nvm
-NVM=${FIRMWARE}/v3.3.5-0-8-D-RC2.nvm
-
-PIB=${FIRMWARE}/v3.3.5.pib
-NVM=${FIRMWARE}/v3.3.5-0-8-A-RC3.nvm
-NVM=${FIRMWARE}/v3.3.5-0-8-B-RC3.nvm
-NVM=${FIRMWARE}/v3.3.5-0-8-C-RC3.nvm
-NVM=${FIRMWARE}/v3.3.5-0-8-D-RC3.nvm
-
-PIB=${FIRMWARE}/v3.3.5.pib
-NVM=${FIRMWARE}/v3.3.5-0-8-A-RC4.nvm
-NVM=${FIRMWARE}/v3.3.5-0-8-B-RC4.nvm
-NVM=${FIRMWARE}/v3.3.5-0-8-C-RC4.nvm
-NVM=${FIRMWARE}/v3.3.5-0-8-D-RC4.nvm
-
-PIB=${FIRMWARE}/v3.3.5.pib
-NVM=${FIRMWARE}/v3.3.5-0-8-A-RC5.nvm
-NVM=${FIRMWARE}/v3.3.5-0-8-B-RC5.nvm
-NVM=${FIRMWARE}/v3.3.5-0-8-C-RC5.nvm
-NVM=${FIRMWARE}/v3.3.5-0-8-D-RC5.nvm
-
-PIB=${FIRMWARE}/v3.3.6.pib
-NVM=${FIRMWARE}/v3.3.6-0-8-A-RC3.nvm
-NVM=${FIRMWARE}/v3.3.6-0-8-B-RC3.nvm
-NVM=${FIRMWARE}/v3.3.6-0-8-C-RC3.nvm
-NVM=${FIRMWARE}/v3.3.6-0-8-D-RC3.nvm
-
-PIB=${FIRMWARE}/v3.3.6.pib
-NVM=${FIRMWARE}/v3.3.6-0-8-A-RC4.nvm
-NVM=${FIRMWARE}/v3.3.6-0-8-B-RC4.nvm
-NVM=${FIRMWARE}/v3.3.6-0-8-C-RC4.nvm
-NVM=${FIRMWARE}/v3.3.6-0-8-D-RC4.nvm
-
-PIB=${FIRMWARE}/v3.3.6.pib
-NVM=${FIRMWARE}/v3.3.6-0-8-A-RC1.nvm
-NVM=${FIRMWARE}/v3.3.6-0-8-B-RC1.nvm
-NVM=${FIRMWARE}/v3.3.6-0-8-C-RC1.nvm
-NVM=${FIRMWARE}/v3.3.6-0-8-D-RC1.nvm
-
-# ====================================================================
-#
-# --------------------------------------------------------------------
-
-
-
-
-
-
diff --git a/docbook/firmware.xml b/docbook/firmware.xml
deleted file mode 100644
index 9084cb99..00000000
--- a/docbook/firmware.xml
+++ /dev/null
@@ -1,987 +0,0 @@
-
-
- Firmware
-
-
-
- Introduction
-
-
- An Atheros chipset consists of an integral CPU, ROM and proprietary circuitry. The CPU requires a minimum amount of external SDRAM to execute runtime software and store runtime configuration parameters. The INT6000 chipset also requires a minimum amount of external flash memory in order to start. The INT6300 can use external flash memory in the same way as the INT6000 or it can use a local host processor as surrogate flash memory.
-
-
- On startup, the SDRAM memory controller must be configured before runtime firmware and parameters are loaded. On the INT6000, runtime firmware and configuration parameters must be loaded from external flash memory. On the INT6300, it may be loaded from external flash memory or from a external host processor. Runtime firmware determines device capability. Runtime configuration parameters determine device network identity and personality.
-
-
- The following sections identify and describe firmware related components and discuss some of the routine actions required to manage them. Consult the Atheros HomePlug AV Hardware Technical Reference Manual and HomePlug AV Firmware Technical Reference Manual for more information.
-
-
-
- Firmware Components
-
- Device initialization involves the following components. They are described here and then referenced throughout the toolkit documentation. You may want to read and re-read this page.
-
-
-
- Bootloader
-
-
- The Bootloader is permanent software burned into the chipset. The INT6000 and INT6300 both have a Bootloader program but they behave differently because the INT6000 needs flash memory and the INT6300 does not. Neither the INT6000Bootloader nor the INT6300Bootloader can write to flash memory.
-
-
- On startup, the INT6000Bootloader attempts to load runtime firmware from flash memory into SDRAM. If flash memory is not available, or the runtime firmware stored there cannot be loaded, then the INT6000Bootloader cannot continue so the device cannot function.
-
-
- On startup, the INT6300Bootloader attempts to load runtime firmware from flash memory into SDRAM. If flash memory is not available, or the runtime firmware stored there cannot be loaded, then Bootloader will request runtime firmware from the local host processor.
-
-
-
-
- Softloader
-
-
- An optional program stored in flash memory in place of runtime firmware. This program is used on the INT6000 to support the Boot From Host operation, if needed. It is not used on the INT6300 because the INT6300Bootloader now performs similar functions. The Softloader cannot write to flash memory.
-
-
- On startup, the INT6000Bootloader loads the Softloader from flash memory into SDRAM, as it would do with runtime firmware. The Softloader then requests the actual runtime firmware from local host.
-
-
-
-
- Memory Configuration Parameters
-
-
- A small block of information that describes the type, size and characteristics of the SDRAM available for the benefit of the Bootloader. On the INT6000, SDRAM configuration must be stored in flash memory. On the INT6300, it may be stored in flash memory or on the local host. The INT6300Bootloader attempts to read configuration information from flash memory when it is present; otherwise, it requests that information from the local host using a VS_HST_ACTION message and so the host must store this information until it is requested.
-
-
- There are two SDRAM configuration file formats. The first format is used by the Windows Device Manager and the
- int6k2
- program and typically has a .config file extension. The second format is used by the
- int6k
- program and
- int6kf
- program and typically has a .cfg file extension. The latter format is more robust and should eventually replace the format.
-
-
- The Windows Device Manager form consists of 64 hexadecimal ASCII characters. Files are at least 64 bytes but only the first 64 bytes are used. Files can be modified using a text editor. ASCII hex to binary conversion and checksum computation is needed on input. The
- config2cfg
- program can be used to convert this format to Open Powerline Toolkit format.
-
-
- The Open Powerline Toolkit format consists of 32 binary bytes plus a 4 byte checksum. The file size is exactly 36 bytes. No conversion or checksum computation is needed on input. The
- chkcfg
- program can be used the validate this file format because it contains a checksum.
-
-
- The INT6400 chipset does not need a memory configuration parameter file because it has a different memory controller than earlier chipsets. SDRAM is now configured dynamically by an applets stored in the .nvm file.
-
-
-
-
- Runtime Firmware (MAC Software)
-
-
- The executable image that determines INT6000 or INT6300 capability and functionality. Runtime firmware refers to any executable image except the Bootloader which is considered to be boot firmware. Firmware files have a .nvm extension and can contain multiple firmware images. One of these images could be the parameter information block but Atheros currently distributes that as a separate file. The chknvm program can be used to detect obsolete or corrupt .nvm files. Runtime firmware can write to flash memory and must be running in order to re-program the chipset.
-
-
-
-
- Parameter Information Block (PIB)
-
-
- The configuration image that determines device network identity, functional capability and operational mode. The PIB structure often changes from one major firmware release to the next and often is not portable across major releases. Parameter information files have a .pib extension by convention and contain one parameter set. The chkpib program can be used to detect obsolete or corrupt PIB files.
-
-
- Recent firmware releases support two PIB images in flash memory: the Factory PIB and the User PIB. The Factory PIB is the first PIB image written to flash memory. Once written, the Factory PIB cannot be changed without special software. The User PIB is created and over-written whenever the device needs to save new PIB parameters. Factory default values are restored by erasing the User PIB and rebooting the device. When a device reboots, it attempts to load the User PIB from flash memory. Failing that, it attempts to load the Factory PIB from flash memory. Failing that, it loads a Default PIB having minimum functionality. The loaded PIB becomes the Working PIB and determines runtime device identity and behavior.
-
-
-
-
-
- Architecture Overview
-
-
- The following figure illustrates a hypothetical powerline network consisting of two devices. Each device has an INT6300 with optional dedicated flash memory and an onboard processor with associated storage. The processor in each device is the local host for that device and the remote host for the other device. The processor storage is unspecified but it must be persistent. The two devices are connected via coax or powerline. The flash memory is optional in this design because it uses the INT6300 chipset.
-
-
-
- Simple Network
-
-
-
-
-
-
-
-
- The Boot Loader is permanent program that executes on startup. It detects the presence of flash memory and attempts to read SDRAM configuration from flash memory then load and runtime the firmware image and PIB from flash memory. On success, the Boot runtime firmware starts and the device assumes HomePlug AV compliant behavior. On failure, the Boot Loader requests SDRAM configuration, runtime firmware image and PIB from the local host. The local host must be prepared to respond to these requests.
-
-
- On a system having no flash memory, the Boot Loader will request SDRAM configuration information from the local host. Once that is received, the Boot Loader will request a firmware image and PIB from the local host. The local host determines which firmware image and PIB to download, manages the download sequence and starts firmware execution.
-
-
- Atheros software, such as the Windows Device Manager, Linux Flash Utility and Embedded API all support the Boot from Host configuration.
-
-
- Once the firmware is running on the INT6300 , a remote host can forward runtime firmware and PIB to the local host via the INT6300 firmware. The remote host might reside on anotherINT6300 device, as shown in the previous figure, or be located anywhere on the HomePlug AV network. In either case, the operations described are the same.
-
-
-
-
- Firmware Boot Process
-
-
- The INT6300 can boot HomePlug AV firmware from either dedicated flash memory or a local host processor. This means that dedicated flash memory in not necessary when an onboard processor having persistent storage is available. The absence of dedicated flash memory and availability of an onboard host processor is called a Boot from Host configuration.
-
-
- The Boot from Host configuration is of interest to customers who are committed to using a host processor in their INT6300 based product and want to use it to eliminate the additional cost of dedicated flash memory to store HomePlug AV firmware for INT6300 devices.
-
-
- The Boot from Host configuration supports three operations: Upgrade Device, Update Local Host and Boot from Host. Product designers must write host software to support all three operations as described later in this document. Atheros provides an Embedded Application Program Interface to assist product designers with this effort. Obtain a copy of the HomePlug AV Application Programming Interface User's Guide from Atheros Communications, Ocala FL USA for more information.
-
-
- Readers should not confuse a Boot from Host configuration with the Boot from Host operation. The former is a hardware configuration having an INT6300 with no dedicated flash memory available. The latter is the process of downloading configuration information, firmware and PIB from the local host to the device and starting firmware execution on startup.
-
-
- This discussion assumes that the reader is familiar with the following:
-
-
-
-
- The distinction between a local and remote host
-
-
-
-
- The relationship between the powerline device H1, M1 and PHY interfaces.
-
-
-
-
- The structure of the following Atheros Management Message types: VS_HST_ACTION, VS_SET_SDRAM, VS_WR_MEM, VS_WR_MOD, VS_RS_DEV, VS_ST_MAC and VS_WRITE_AND_EXECUTE. Be aware that message types VS_SET_SDRAM, VS_WR_MEM, VS_WR_MOD and VS_ST_MAC are deprecated and will no longer be supported by the newest firmware.
-
-
-
-
- Hardware architecture covered in the QCA Powerline Hardware Technical Reference Manual and the management message formats covered in the QCA Powerline Firmware Technical Reference Manual.
-
-
-
-
-
-
-
- Boot from Host Configuration
-
-
- The Boot from Host configuration requires a permanent connection between the powerline device and a local host having some type of persistent storage. In most cases, the powerline device and local host are co-located, possibly on the same board or same chip, and act together as an integral unit. Essentially, the local host provides persistent memory for the device.
-
-
- The Boot from Host configuration lets the local host decide which runtime parameters and firmware to download on startup. This offers a considerable degree of product adaptability, allowing different parameter and firmware combinations to be downloaded based on external factors.
-
-
- In a Boot from Host configuration, the processor must act as local host while the device is booting but it can also act as remote host when upgrading other devices. The former is a design requirement and latter is a design option.
-
-
-
-
- Things to Remember
-
-
- The Boot from Host configuration offers design flexibility but also increases the possibilities. Remember that the processes described here are based on simple rules that ultimately dictate why each process step is needed. Readers may find it helpful to review these rules.
-
-
-
-
-
- The softloader and bootloader programs have limited vocabulary.
-
-
-
- The INT6000 softloader recognizes only the VS_SW_VER, VS_ST_MAC, VS_RS_DEV, VS_WR_MOD requests. It does not recognize VS_WR_MEM.
-
-
- The INT6300 bootloader recognizes only the VS_SW_VER, VS_WR_MEM, VS_ST_MAC, VS_RS_DEV and VS_SET_SDRAM requests. It does not recognize VS_WR_MOD.
-
-
- The INT6400 bootloader recognizes only the VS_SW_VER, VS_WR_MEM, VS_ST_MAC, VS_RS_DEV requests. It recognizes VS_SET_SDRAM and responds to it but ignores it. It does not recognize VS_WR_MOD.
-
-
- The AR7400 bootloader recognizes only VS_SW_VER, VS_WR_MEM, VS_ST_MAC, VS_RS_DEV requests. It recognizes VS_SET_SDRAM and responds to it but ignores it. It does not recognize VS_WR_MOD.
-
-
- The AR7420 bootloader recognizes only VS_SW_VER, VS_RS_DEV, VS_WRITE_AND_EXECUTE and VS_RAND_MAC_ADDRESS requests. Early versions recognize VS_WRITE_MEM and VS_ST_MAC requests but they must not be used.
-
-
-
-
-
- The Softloader, Bootloader and runtime firmware may treat the same MME differently because each is a different program. A notorious obvious example is the VS_SW_VER message type. This means that one may need to be aware of the device state when anticipating device behaviour or interpreting device response.
-
-
-
-
- The local host is surrogate flash memory. When dedicated flash memory is not available to a device, the device will request firmware and parameter storage services from the local host using VS_HST_ACTION messages. The local host must be programmed to detect and respond to these messages or the firmware will appear to hang. See program int6khost, int64host, amphost or plchost to demonstrate and experiment with this interaction.
-
-
-
-
- Only runtime firmware can write flash memory. Runtime firmware must be executing in order to write flash memory or upload to the local host. The Softloader and Bootloader cannot perform either operation.
-
-
-
-
- All PIB changes must be written in flash memory. There are several things that can cause PIB changes. When a PIB change is needed, the Working PIB is copied to a scratch area and modified there. The Scratch PIB must then be written to flash memory or sent to the local host for storage. The device then resets causing the stored PIB to replace the Working PIB. If a freshly downloaded PIB changes for any reason then the cycle will repeat, automatically.
-
-
-
-
- Runtime firmware updates the PIB after joining and before leaving an AVLN. This will cause a device reset in each case. If the device is using the local host for persistent storage, runtime firmware will send the associated VS_HST_ACTION messages to the host and the host will send the associated VS_RD_MOD and VS_RS_DEV messages as per Update Local Host.
-
-
-
-
-
-
- Every Little Bit Hurts
-
-
- With the addition of Push Button Encryption, and other planned features, runtime firmware can now modify the PIB. Consequently, host applications must not assume that the PIB has not changed since it was last downloaded. Atheros strongly recommends that applications always perform a read-modify-write when making PIB modifications. Failure to do so can result in infinite reset loops caused when a device modifies the PIB that has just been downloaded.
-
-
- As one example, recent PIBs contain a network membership bit to indicate that the device has successfully joined the network associated with the current NMK. If the firmware detects the network and discovers that the membership bit is clear then it will join the network and set the bit. The firmware will then attempt to preserve the change by sending a VS_HOST_ACTION message to the local host. If the host application does not upload and store the changed PIB (as the device requested) before resetting the device then the original PIB will be downloaded again, after reset, and the process will repeat. Of course, a similar situation will occur when the device leaves the network and again when it joins another network.
-
-
-
-
- Liar! Liar! Pants on Fire!
-
-
- It is important to use the right Boot from Host sequence for each type of Atheros device. This means that you should query the device using a VS_SW_VER message beforehand to determine or confirm the device type. Although this should be a simple operation, there have been several changes that complicate matters.
-
-
-
-
- The INT6300Bootloader incorrectly identifies the chipset as an INT6000 chipset in the MDEVICEID field of the VS_SW_VER message.
-
-
-
-
- The AR7400Bootloader incorrectly identifies the chipset as an INT6400 chipset in the MDEVICEID field of the VS_SW_VER message.
-
-
-
-
- The Bootloader, for INT6400 chipsets and later, returns two additional field, IDENT and STEP_NUMBER in the VS_SW_VER confirmation message. These fields, the hardware identifier and step number, are correct but are not returned in earlier chipsets.
-
-
-
-
- The table below illustrates what is reported by various firmware, in the DEVICEID field of the VS_SW_VER message, on each type of hardware platform.
-
-
-
- To properly detect the correct chipset perform the following steps.
-
-
-
-
- Send a VS_SW_VER request message from the local host to the local device using the Atheros Local Management Address.
-
-
-
-
- Read the VS_SW_VER confirm message returned to the host by the device.
-
-
-
-
- Extract and save the MDEVICEID field (a small integer) and the MVERSION field (a string).
-
-
-
-
- If the MVERSION string is SoftLoader then the MDEVICEID field is valid.
-
-
-
-
- If the MVERSION string is not BootLoader then the MDEVICEID field is valid unless it is 0x07. In that case, set the stored DEVICEID to 0x04 to indicate an AR7400. Do not inspect the IDENT field because it does not exist in the firmware version of the VS_SW_VER message on any platform.
-
-
-
-
- If the MDEVICEID field is 1, indicating an INT6000, then the chipset is actually an INT6300. Set the stored MDEVICEID to 2, indicating an INT6300. Do not inspect the IDENT field because it does not exist in the BootLoader version of the VS_SW_VER message for either of these two chipsets.
-
-
-
-
- If the MDEVICEID field is 3, indicating an INT6400, then the chipset could be either an INT6300 or an AR7400. Inspect the IDENT field.
-
-
-
-
- If the IDENT field is 0x6400, indicating an INT6400, then the stored MDEVICEID is valid.
-
-
-
-
- If the IDENT field is 0x7400, indicating an AR7400, then set the stored MDEVICEID to 4, indicating an AR7400.
-
-
-
-
- Having performed the previous conversions, the expression (1 << (DEVICEID - 1)) now indicates the proper IGNORE bit found in each NVM file header. Unfortunately, this only works for DeviceID values from 0x01 through 0x06. After that, the device identification scheme changes.
-
-
-
-
- But wait! There's more ...
-
-
- Starting with the AR7420, the DeviceID field in VS_SW_VER is now the DEVICE_CLASS field and identifies the Device Family, not the device type. Instead, the IDENT field in VS_SW_VER identifies the device type and the IDENT field is located at a variable offset within the message frame. Previously, the IDENT was located a fixed offset within the frame.
-
-
-
-
-
diff --git a/docbook/folders.xml b/docbook/folders.xml
deleted file mode 100644
index 55817b76..00000000
--- a/docbook/folders.xml
+++ /dev/null
@@ -1,176 +0,0 @@
-
-
- Toolkit Folders
-
-
- The Atheros Open Powerline Toolkit package folder has many subfolders. Some contain source code, some contain documentation and others contain shell scripts. Some source folders contain programs that require components in neighboring folders. Consequently, you will see references to relative pathnames like ../folder, throughout source code, makefiles and shell scripts. This notation simplifies development and maintenance and is helpful when locating specific files.
-
-
- Folder descriptions appear below in alphabetical order:
-
-
-
-
- ./applets
-
-
-
- A library of programs that can run, stand-alone, on Atheros powerline devices and perform diagnostic tests for connection, functionality and performance. Some run to completion and return to the Bootloader. Others run continuously until the device is reset. Most can be run and executed in sequence using program int6ktest.
-
-
-
-
-
- ./classes
-
-
-
- A collection of C++ classes that implement many of the ANSI C functions found elsewhere in the toolkit. These classes will compile and run on most platforms but are still a work-in-progress. The programs folder contains actual and sample programs that use these classes.
-
-
-
-
-
- ./docbook
-
-
-
- HTML pages generated by several methods, but mostly Docbook 4.5. Some pages have been created using special tools that are not provided and will not be made available. The Makefile in this folder will compile the core XML source files on GNU/Linux systems that have Docbook 4.5 installed with extentions by Normal Walsh but it does not install the pages. See Installation on Linux for more information.
-
-
-
-
-
- ./ether
-
-
-
- Network specific source code that supports raw ethernet packets in a platform independent fashion using plugin modules. The principle feature is the channel data structure used to read and write raw ethernet packets using network features on GNU/Linux, with or without libpcap, and on Windows with winpcap. The source code in this folder is difficult to port cross-platform due to the way different operating systems implement their system header files and network stacks.
-
-
-
-
-
- ./plc
-
-
-
- The main source code for programs that communicate with Qualcomm Atheros powerline devices over Ethernet. The programs in this folder are essential programs for engineers and embedded software developers wanting to explore powerline device behavior. The Makefile in this folder will compile and install programs in /usr/local/bin on GNU/Linux systems.
-
-
-
-
-
- ./mme
-
-
-
- A collection of helper functions dealing with HomePlug and Atheros management messages. They are not needed for proper toolkit operation but they can be useful during development and debugging because they print message content in readable format. Most of these functions require extra memory because they include symbol tables and extra data conversion functions.
-
-
-
-
-
- ./nodes
-
-
-
- A collection of functions that comrpise a generic, light-weight XML parser. Atheros is currently exprimenting with various XML-based applications to support device management on embedded systems. These functions are the core. Currently, they are only used by the pxe and int6k2 programs. See XML Editing Functions for more information.
-
-
-
-
-
- ./nvm
-
-
-
- Programs, functions and make files related to Atheros NonVolatile Memory (NVM) files. All programs in this folder either read from or write to NVM files. None communicate with powerline devices. Some of the popular programs are chknvm, nvmsplit and nvmmerge.
-
-
-
-
-
- ./patches
-
-
-
- A collection of useful Linux kernel patches and install scripts. Of particular interest is the send-to-self patch that enables external routing of ISO Layer 3 traffic between two Ethernet interfaces on the same host. Atheros provides them but does not support them.
-
-
-
-
-
- ./pib
-
-
-
- Programs, functions and make files related to Atheros Parameter Information Block (PIB) files. All programs in this folder either read from or write to PIB files. None communicate with powerline devices. Some of the popular programs are chkpib, modpib, getpib and setpib.
-
-
-
-
-
- ./programs
-
-
-
- A small collection of sample C++ programs that use the Atheros C++ powerline classes. These programs compile and run on most environments but are still a work-in-progress. Users may actually find netifs and plcnets useful.
-
-
-
-
-
- ./serial
-
-
-
- Programs, functions and make files related to the Atheros Serial Communication Interface for Powerline devices. All of the programs in this folder communicate using a host serial port. None communicate with powerline devices over Ethernet. The main program of interest is int6kuart.
-
-
-
-
-
- ./scripts
-
-
-
- Miscellaneous shell scripts that call various programs in this package to perform tasks such as flashing a FW2.0 device. Care must be taken here to ensure that environment variables at the start of each script are appropriate for your system.
-
-
-
-
-
- ./ram
-
-
-
- Support modules for reading, printing and checking NVRAM and SDRAM configuration files. The .cfg files in this folder have a different format than the .config files released with the Atheros Windows Device Manager. The files distributed with the Windows Device Manger are 64 ASCII character with no checksum. The files in this directory are 32 binary bites with trailing checksum. Users may create new sdram configuration files by compiling sdram.c, using gcc -o sdram sdram.c and running it without any command line arguments.
-
-
-
-
-
- ./tools
-
-
-
- Source code and header files used by virtually all programs in the toolkit. These files are generic and have application beyond this package. They provide GNU/Linux-style or POSIX-style functionality to programs running in environments that do not have either. They also implement operations like checksum computation and multi-byte hexadecimal encoding and decoding. See Support Function Reference for more information.
-
-
-
-
-
- ./VisualStudioNET
-
-
-
- Components unique to Microsoft Windows are kept in and under this folder. Specifically, it contains a Visual Studio .NET solution to compile most of the programs in this package using only Microsoft and winpcap libraries. Compiled .exe files can be run on Windows enabled systems having winpcap installed. Adjustments may be necessary depending on your environment.
-
-
- Microsoft does not provide full POSIX support on Windows platforms. Consequently, alternative headers and libraries are included under this folder. For example, an abridged version of unistd.h and an alternative version of stdint.h are included under VisualStudioNET/include. Other significant header files included here are ethernet.h, if_ether.h and in.h. Subfolder VisualStudio\Library contains WinPcap libraries. These folders are referenced in appropriate compiler and linker options for Microsoft Development environments.
-
-
-
-
-
diff --git a/docbook/format.h.html b/docbook/format.h.html
deleted file mode 100644
index 42c37a67..00000000
--- a/docbook/format.h.html
+++ /dev/null
@@ -1,83 +0,0 @@
-
-
-
-
-
- format.h
-
-
-
-
-
-
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2012 Qualcomm Atheros Inc.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose with or without fee is hereby granted, provided
- * that the above copyright notice and this permission notice appear
- * in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
- * THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
- * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
- * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
- * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed getargv (signed argc, char const * argv [])
- *
- * symbol.h
- *
- * read one line from stdin; fill argv [] with fields from that
- * line; return the number of fields found; ignore blank lines
- * and script style comment lines; this implementation inserts
- * a program name at argv [0] to emulate a true argv [];
- *
- *--------------------------------------------------------------------*/
-
-#ifndef GETARGV_SOURCE
-#define GETARGV_SOURCE
-
-#include <stdio.h>
-#include <ctype.h>
-#include <memory.h>
-
-#include "../tools/symbol.h"
-#include "../tools/chars.h"
-
-signed getargv (signed argc, char const * argv [])
-
-{
- extern char const * program_name;
- static char string [1024];
- char const ** argp = argv;
- char * sp = string;
- signed c = getc (stdin);
- memset (string, 0, sizeof (string));
- memset ((char **)(argv), 0, argc * sizeof (char const *));
- while (nobreak (c))
- {
- if (isspace (c))
- {
- do
- {
- c = getc (stdin);
- }
- while (isspace (c));
- }
- if (c == '#')
- {
- do
- {
- c = getc (stdin);
- }
- while (nobreak (c));
- c = getc (stdin);
- continue;
- }
- *argp++ = program_name;
- *argp++ = sp = string;
- while (nobreak (c))
- {
- if (c == '#')
- {
- do
- {
- c = getc (stdin);
- }
- while (nobreak (c));
- break;
- }
- if (isblank (c))
- {
- c = (char)(0);
- *argp = sp + 1;
- }
- else if (sp == *argp)
- {
- if ((signed)(argp - argv) < argc)
- {
- argp++;
- }
- }
- *sp++ = (char)(c);
- c = getc (stdin);
- }
- *argp = (char const *)(0);
- *sp = (char)(0);
- }
- return ((unsigned)(argp - argv));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * char * getifname (signed number);
- *
- * ether.h
- *
- * return the PCAP interface name for a given interface number; this
- * function is only needed when using LIBPCAP or WINPCAP libraries;
- *
- *
- * Contributor(s):
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef GETIFNAME_SOURCE
-#define GETIFNAME_SOURCE
-
-#include <string.h>
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-#include <pcap.h>
-#endif
-
-#include "../ether/ether.h"
-#include "../tools/error.h"
-
-char * getifname (signed index)
-
-{
- char * name = (char *)(0);
-
-#if defined (__linux__)
-
-#elif defined (__APPLE__) || defined (__OpenBSD__)
-
-#elif defined (WINPCAP) || defined (LIBPCAP)
-
- char buffer [PCAP_ERRBUF_SIZE];
- pcap_if_t *devices = (pcap_if_t *)(0);
- pcap_if_t *device;
- signed count;
- if (pcap_findalldevs (&devices, buffer) == -1)
- {
- error (1, errno, "can't enumerate pcap devices");
- }
- for (device = devices, count = 1; device; device = device->next, count++)
- {
- if (count == index)
- {
- name = strdup (device->name);
- break;
- }
- }
- if (!device)
- {
- error (1, EINVAL, "invalid interface: %d", index);
- }
- pcap_freealldevs (devices);
-
-#else
-#error "Unknown environment"
-#endif
-
- return (name);
-}
-
-#endif
-
-
-
-getpib(1) Qualcomm Atheros Open Powerline Toolkit getpib(1)
-
-NAME
- getpib - Qualcomm Atheros PIB Data Extractor
-
-SYNOPSIS
- getpib file offset format [length]
-
-DESCRIPTION
- This program is a companion to program setpib and is designed to support shell scripts. It extracts PIB file parameters
- so that a scripting language can evaluate, manipulate or store them with minimal effort. Good scripting skills and some
- imagination may be required to make effective use of this program.
-
- Users having a detailed knowledge of PIB content and structure can make extremely effective use of this program; however,
- Atheros is under no obligation to provide customers with the offset, length or format of PIB file parameters.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- - c character
- The appended character. Append this character each line of output instead of newline. Use this to create a comma
- separated list of value, for example, by specifying a comma.
-
- -n Append a newline to the output.
-
- -q Enable quiet mode which has no effect.
-
- -v Verbose mode. Does nothing.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Usethis option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The PIB filename. This argument is required and must appear first on the command line. No assumptions are made
- based on filename and no filename conventions are enforced; however, an invalid PIB file will be rejected.
-
- offset The data offset in bytes expressed in hexadecimal. This argument is required and must follow the filename. A
- leading "0x" prefix is optional. The data offset plus the data length cannot exceed the file extent.
-
- format The output format. This argument is required and must follow the offset. Some formats imply fixed data length.
- Others formats are for variable length data. The fixed data formats are byte, word, long, hfid, mac and key. The
- variable data formats are data and text. The formats are described in the next section.
-
- length The data length in bytes expressed in decimal. This argument is only required for the the data formats data and
- text. The data offset plus the data length cannot exceed the file extent. The data length cannot exceed 1024.
-
-FORMATS
- byte Extract 1 byte and display it as an unsigned decimal integer value. The offset advances byte before starting
- another extraction.
-
- word Extract 2 consecutive bytes and display them as an unsigned decimal integer value after endian conversion. The
- offset advances bytes before starting another extraction.
-
- long Extract 4 consecutive bytes and display them as an unsigned decimal integer value after endian conversion. The
- offset advances 4 bytes before starting another extraction.
-
- huge Extract 8 consecutive bytes and display them as an unsigned decimal integer value after endian conversion. The
- offset advances 8 bytes before starting another extraction.
-
- xbyte Extract 1 byte and display it as a hexadecimal integer value. The offset advances byte before starting another
- extraction.
-
- xword Extract 2 consecutive bytes and display them as a hexadecimal integer value after endian conversion. The offset
- advances bytes before starting another extraction.
-
- xlong Extract 4 consecutive bytes and display them as a hexadecimal integer value after endian conversion. The offset
- advances 4 bytes before starting another extraction.
-
- xhuge Extract 8 consecutive bytes and display them as a hexadecimal integer value after endian conversion. The offset
- advances 8 bytes before starting another extraction.
-
- data length
- Extract the specified number of bytes and display them as a hexadecimal string with no punctuation to separate
- octets. The offset advances length bytes before starting another extraction. The minimum length is 1. The maxi‐
- mum length is 1024.
-
- mac Extract 6 bytes and display them as a colon-separated hexadecimal string. The offset advances 6 bytes before
- starting another extraction. This is similar to "data 6" but colons separate each octet.
-
- key Extract 16 bytes and display them as a colon-separated hexadecimal string. The offset advances 16 bytes before
- starting another extraction. This is similar to "data 16" but colons separate each octet.
-
- hfid Extract 64 consecutive bytes and display them as an ASCII string that terminates at the first non-printable char‐
- acter. The offset advances 64 bytes before starting another extraction. This is equivalent to "text 64".
-
- skip length
- Advance the specified number of bytes without displaying anything. The offset advances by length bytes before
- starting another extraction. The minimum length is 1. The maximum length is 1024.
-
- text length
- Extract the specified number of bytes and display them as an ASCII string that terminates at the first non-print‐
- able character. The offset advances the specified number of bytes before starting another extraction.
-
-TR-069
- accesspassword
- Extract 65 consecutive bytes and display them as an ASCII string that terminates at the first non-printable char‐
- acter. The offset advances 65 bytes before starting another extraction. This format is equivalent to "text 65".
-
- accessusername
- Extract 33 consecutive bytes and display them as an ASCII string that terminates at the first non-printable char‐
- acter. The offset advances 33 bytes before starting another extraction. This format is equivalent to "text 33".
-
- adminpassword
- Extract 33 consecutive bytes and display them as an ASCII string that terminates at the first non-printable char‐
- acter. The offset advances 33 bytes before starting another extraction. This format is equivalent to "text 33".
-
- adminusername
- Extract 33 consecutive bytes and display them as an ASCII string that terminates at the first non-printable char‐
- acter. The offset advances 33 bytes before starting another extraction. This format is equivalent to "text 33".
-
- password
- Extract 257 consecutive bytes and display them as an ASCII string that terminates at the first non-printable char‐
- acter. The offset advances 257 bytes before starting another extraction. This format is equivalent to "text
- 257".
-
- url Extract 257 consecutive bytes and display them as an ASCII string that terminates at the first non-printable char‐
- acter. The offset advances 257 bytes before starting another extraction. This format is equivalent to "text
- 257".
-
- username
- Extract 257 consecutive bytes and display them as an ASCII string that terminates at the first non-printable char‐
- acter. The offset advances 257 bytes before starting another extraction. This format is equivalent to "text
- 257".
-
-EXAMPLES
- The following example extracts one byte from offset 01F7 of PIB file abc.pib and displays it as an unsigned decimal inte‐
- ger string. No length specification is needed because the byte format has an implied length of 1 byte. The displayed
- value is 232 because the byte format is decimal. We could have specified "data 1" to display the byte in hexadecimal.
- The return prompt appears on the display line because option -n was omitted.
-
- # getpib abc.pib 01F7 byte
- 232#
-
- The next example extracts two bytes at offset 01F7 and displays them as a hexadecimal string. A length of 2 is needed
- because the data format is variable length. We could have specified "word" to display these bytes as an unsigned decimal
- integer string. The hexadecimal string consists two octets E8 and 8A. The first byte is the same one extracted in the
- last example. The return prompt appears on a new line because option -n was present.
-
- # getpib abc.pib 01F7 data 2 -n
- E88A
- #
-
-DISCLAIMER
- PIB file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information is not
- available. Qualcomm Atheros reserves the right to modify PIB file structure or content in future firmware releases with‐
- out any obligation to notify or compensate users of this program.
-
-SEE ALSO
- chkpib(7), chkpib2(7), modpib(1), pib2xml(1), pibcomp(1), pibdump(1), setpib(1), xml2pib(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 getpib(1)
-
-#!/bin/sh
-# file: scripts/hardware.sh
-
-# this file defines the names and addresses of ethernet interfaces
-# on the host and the powerline device connected to each; every host
-# should have its own copy of this file so that generic scripts can
-# written and moved from one host to another without change;
-#
-# symbol ETH is referenced in files such as start.sh, flash.sh and
-# upgrade.sh that operation on one device only;
-#
-# symbols ETH1, ETH2, NIC1, NIC, PLD1 and PLD22 are referenced in
-# files such as pts.sh that operate on two devices; by convention:
-#
-# interface ETH1 has address NIC1 and is connected to device PLD1;
-# interface ETH2 had address NIC2 and is connected to device PLD2;
-#
-# to include this file in a new script:
-#
-# . ${SCRIPTS}/hardware.sh
-#
-
-# ====================================================================
-# symbols;
-# --------------------------------------------------------------------
-
-ETH=eth1
-
-# ====================================================================
-# host interface names;
-# --------------------------------------------------------------------
-
-ETH1=eth2
-ETH2=eth4
-
-# ====================================================================
-# host interface addresses;
-# --------------------------------------------------------------------
-
-NIC1=00:50:04:a5:d9:5a
-NIC2=00:01:02:d0:8f:89
-
-# ====================================================================
-# powerline device addresses;
-# --------------------------------------------------------------------
-
-PLD1=00:B0:52:00:FD:0D
-PLD2=00:B0:52:00:FD:0E
-
-# ====================================================================
-# miscellaneous device addresses;
-# --------------------------------------------------------------------
-
-master=00:b0:52:da:da:01
-slave1=00:b0:52:da:da:02
-slave2=00:b0:52:da:da:03
-slave3=00:b0:52:da:da:04
-slave4=00:b0:52:dd:dd:05
-
-
-
-
-
-
diff --git a/docbook/hardware.xml b/docbook/hardware.xml
deleted file mode 100644
index d1ccd93e..00000000
--- a/docbook/hardware.xml
+++ /dev/null
@@ -1,921 +0,0 @@
-
-
- Hardware
-
-
-
- Introduction
-
-
-
-
-
-
- Device Form Factors
-
-
- Atheros Communications, Ocala FL USA designs and manufactures chipsets that permit network communications over powerline. They do no not manufacture powerline communication products for market. Instead, they provide chipsets, reference designs and expertise needed to build powerline communications products. Atheros does manufacture some sample products, in various form factors, for evaluation purposes only.
-
-
-
-
- Wall Adapters
-
-
-
- A small unit that plugs into any power outlet and has one RJ45 Ethernet jack. The RJ45 jack can be used to connect the unit to another Ethernet device, such as a hub, switch or computer network interface card using CAT5 Ethernet cable. Two or more such units can be used to connect Ethernet devices over the powerline. For example, a computer on one room can be connected to a network printer in another room. See Atheros Product Brief 27003417 - RD6300-ETH HomePlug AV Wall Adapter Reference Design for more information.
-
-
-
-
-
- Desktop Adapters
-
-
-
- A compact unit having a 6ft power cord, one threaded coax cable F connector and one RJ45 Ethernet jack. Two such units can be used to connect Ethernet devices over either powerline (as above) or coax cable. Use of coax cable improves performance over longer distances and permits network segments to be isolated from each other. See Atheros Product Brief 27002824 - RD6000-ETH HomePlug AV Ethernet Hybrid Adapter Reference Design for more information.
-
-
-
-
-
- PCI Cards
-
-
-
- A standard PCI compliant computer card having one DIN powerline connector and one threaded coax cable F connector. The card can be inserted into a PCI bus slot on a computer, or other device. Atheros provides device drivers that make the card behave like an ordinary Ethernet card. Like the desktop unit (above), computers and embedded systems can be connected either over powerline or coax cable. See Atheros Product Brief 27003239 - EK6000-PCI HomePlug AV Card Evaluation Kit for more information.
-
-
- PCI cards are no longer available from Atheros but reference designs may be obtained from selected Atheros customers that specialize in PCI designs.
-
-
-
-
-
- Mini-PLC
-
-
-
- A Mini-PCI form factor card that integrates most components needed to embed HomePlug AV into your product design. Although the card will insert into a Mini-PCI slot, it is not electrically compatible with the Mini-PCI standard. Atheros uses this card in both the RD6000-ETH Desktop Adaptor and the EK6000-PCI Card described above. See Atheros Product Brief 27002835 - RD6000-PLC HomePlug AV Mini-PLC Module Reference Design for more information.
-
-
- Unlike Wall and Desktop Adapters, the Mini-PLC Cards require a device driver written for the particular operating system used. Atheros provides a device drivers for the Windows XP Operating System and for the Linux 2.4 and Linux 2.6 kernel. These drivers make the PCI card look like an ordinary Ethernet interface card.
-
-
- Mini-PLC cards are no longer available from Atheros but cards may be obtained from selected Atheros customers that specialize in PCI designs.
-
-
-
-
-
- Embedded Systems
-
-
-
- Atheros offers an expanding family of reference designs for powerline-enabled switches and routers. Most include onboard CPU and enablement software based on Linux, OpenWRT and other suitable operating systems. Atheros will assist customers in adapting the basic hardware and software to suite particular markets.
-
-
-
-
-
- Chipsets
-
-
-
- Atheros offers an expanding family of Powerline enabled chipsets. Several SoC chipsets are also planned to support a variety of communications applications.
-
-
-
-
-
-
-
- Device Communications
-
-
- Atheros powerline communication chipsets serve as a transparent bridges between an Ethernet network and an active powerline or passive coax cable, effectively extending the Ethernet network. HomePlug AV devices on the powerline, or at either end of a coax cable, will automatically detect each other and establish communications. Normal Ethernet frames that are detected by one HomePlug AV device are passed over powerline or coax to other HomePlug AV devices which then pass the frames on to any Etherenet devices that may be connected to them.
-
-
- There are three levels of communication.
-
-
-
-
- Powerline Communications
-
-
-
- HomePlug AV devices use a proprietary protocol defined by the HomePlug Powerline Alliance. In most cases, HomePlug AV communications do not leave the powerline or coax media used to connect devices. Connected devices use this protocol to detect each other, establish connection, encapsulate Ethernet frames and route them between devices. This level of communications is proprietary and hidden. See the HomePlug Powerline Alliance HomePlug AV Specification for more information.
-
-
-
-
-
- Atheros Device Communications
-
-
-
- Atheros devices use a subset of the HomePlug AV protocol, mentioned above, to communicate with a local host processor. The subset is known as
-
- vendor-specific messages
-
- . Atheros vendor-specific messages are intercepted and processed by Atheros devices. In some cases, they are forwared over powerline or coax to other Atheros devices. Atheros vendor-specific messages are used to interrogate, synchronize, configure and control Atheros devices without affecting HomePlug AV devices from other manufacturers. See the Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-
-
-
-
- Network Traffic
-
-
-
- This is the normal network traffic that passes transparently from local Ethernet, over powerline or coax, to remote Ethernet through HomePlug AV devices.
-
-
-
-
-
-
-
- Device Configurations
-
-
- There are several test configurations that can be used to experiment with Atheros powerline communication devices. Configurations vary based on the powerline communications devices you have available to work with. All configurations described here require at least one computer with an Ethernet card and the Open Powerline Toolkit installed. Most configurations require two Atheros powerline devices.
-
-
- Open Powerline Toolkit programs let the user specify which Ethernet interface card to use when sending and receiving Ethernet frames. This means that a computer with two interface cards installed can emulate two computers provided there are not internal routing conflicts. To avoid routing conflicts, Atheros recommends that you start with two computers until your are ready for more sophisticated experimentation.
-
-
- Open Powerline Toolkit programs default to eth0 . This allows the computer to be connected to the normal network on eth0 and connected to the powerline network on eth1. To over-ride the default powerline interfaces, set environment variable PLC to the desired interface name. All configurations assume that the Ethernet card is installed, the Ethernet driver for that card is loaded and the correct interface is enabled.
-
-
- Atheros powerline communication devices radiate across powerline or coax at radio frequencies. If two devices are connected, in any way, without intermmediate filters or isolation, they will attempt to commicate. Additionally, they will attempt to circumvent certain types of powerline noise or competing frequencies which can cause reduce data rates. Atheros recomends that devices under test (DUT) take their power from a shared but isolated power source like an isolation power strip or an uninterruptable power supply.
-
-
- ( ... explain about powerline isolation ... ) The power strip should have no filtering, surge protectors or electronic cirtuits inside.
-
-
- ---> [ATTENUATOR] ---> [POWER_STRIP] ---> [POWERLINE_DEVICE] --->
-
-
- Typical configurations are:
-
-
-
- Local Host to Local Device
-
-
- This is the simplest configuration. It establishes an Ethernet connection between the host and one powerline device. It can be used to test or program a single powerline device.
-
-
- It requires
-
-
-
-
- One host computer with an Ethernet interface card
-
-
-
-
- One CAT-5 Ethernet cable with an RJ-45 connector at either end.
-
-
-
-
- One Atheros powerline device with RJ-45 connector.
-
-
-
-
- An isolated power source
-
-
-
-
- [LOCAL_HOST] ---/ ethernet /-----> [POWERLINE_DEVICE] ---/ powerline /----->
-
-
- Connect the local host to the powerline device with an ordinary CAT-5 Ethernet cable. Apply power to the powerline device. The local host cannot ping the powerline device because it functions at the data link layer. The local host can interrogate and control the powerline device using
-
- int6k
-
- or
-
- int6k2
-
- programs.
-
-
-
-
- Type "int6k -r" and note the hardware and firmware revision.
-
-
-
-
- Type "int6k -I" and note the device MAC, DAK and NMK.
-
-
-
-
-
- Type "int6k -m" and confirm that the device detects no other devices indicating proper powerline isolation.
-
-
-
-
-
-
- Local Host to Remote Device
-
-
- This configuration is the simplest powerline network configuration. It expands the previous configuration by creating a simple powerline network having two powerline devices. One device, the "local device", is connected to the host via Ethernet. A second device, the "remote device", is connected to the first via powerline.
-
-
- It requires
-
-
-
-
- One host computer with an Ethernet interface card
-
-
-
-
- One CAT-5 Ethernet cable with an RJ-45 connector at either end.
-
-
-
-
- Two Atheros powerline devices, one with RJ-45 connector.
-
-
-
-
- An isolated power source.
-
-
-
-
- [LOCAL_HOST] ---/ ethernet /-----> [POWERLINE_DEVICE] ---/ powerline /----->
- [POWERLINE_DEVICE] ---/ powerline /----->
-
-
- Configure the previous network then plug a second powerline device into the same power source as the first powerline device. The local host still cannot ping any Ethernet network devices because there are no remote Ethernet devices to ping but it can interrogate and control both powerline devices.
-
-
-
-
- Local Host to Remote Host
-
-
- This configuration is the simplest Ethernet network configuration. It expands the previous network by connecting the second powerline device to an existing Ethernet network through an Ethernet switch.
-
-
- It requires
-
-
-
-
- Two host computers, each with an Ethernet interface card
-
-
-
-
- Two CAT-5 Ethernet cables with RJ-45 connectors at either end.
-
-
-
-
- Two Atheros powerline devices, each with RJ-45 connector.
-
-
-
-
- An isolated power source.
-
-
-
-
- [LOCAL_HOST] ---/ ethernet /-----> [POWERLINE_DEVICE] ---/ powerline /----->
- [REMOTE_HOST] ---/ ethernet /-----> [POWERLINE_DEVICE] ---/ powerline /----->
-
-
- Configure the previous network then plug the second powerline device into an Ethernet switch connected to an exiting Ethernet network. The local host can now ping other Ethernet network devices on the.
-
-
-
-
-
- Powerline Workstations
-
-
- The Open Powerline Toolkit is a collection of independent programs. Individually, they perform basic but useful operations on powerline communication devices and associated support files such as PIB and NVM files. Collectively, they can perform many types of engineering experiments, functional tests and production tasks. Their simplicity and high degree of flexibility lets customers adapt an off-the-shelf linux host to meet a wide range of production requirements. We call this configuration a powerline workstation.
-
-
- This section explains how to configure a powerline workstation and setup the Open Powerline Toolkit on that workstation. It covers some necessary aspects of Linux and the Toolkit but it is not a Linux tutorial or a Open Powerline Toolkit tutorial. Linux essentials are covered on the Internet and Open Powerline Toolkit essentials are covered in other sections of this documentation and on-line man pages. Although some typical configurations are illustrated, many variations are possible and are left to the customer to develop based on our examples. There is no single correct way to do anything.
-
-
-
- Host Hardware
-
-
- A powerline workstation host has no special hardware requirements. Any host capable of running Linux and supporting multiple Ethernet cards will do. For example, a 450mhz CPU having 128mb of memory, one 3gb disk and three 10/100 Ethernet cards is adequate.
-
-
- Production tasks such as device initialization or firmware upgrade require one Ethernet card. Experimentation and functional testing typically require two Ethernet cards. Atheros recommends three Ethernet cards so that the host can communicate with other hosts over a local area network while talking to powerline devices. Atheros also recommends that all Ethernet cards installed support at least 100mbps and be of the same type to simplify network configuration.
-
-
-
-
- Host Software
-
-
- Atheros recommends installiing a Debian-based or Ubuntu-based Linux distribution due to the simplicity of network configuration. Redhat-based or SuSE-based distributions are also acceptable. A complete GNU toolchain is required to compile and install the Open Powerline Toolkit. Atheros uses GNU make 3.8.0, GNU gcc 3.3.5 and GNU ld 2.15. If these components are not installed then you must install them. Linux system installation and configuration is beyond the scope of this documentation but there is a wealth of information available on the Internet.
-
-
- Of course, the Open Powerline Toolkit needs to be installed and successful installation proves that all required Linux components are installed correctly. See Installation on Linux for more information on how to install the Open Powerline Toolkit.
-
-
-
-
- Network Configuration
-
-
- Linux will assign interface names like eth0, eth1 and eth2 to each installed network card. Atheros recommends that eth0 be connected to your local network so that you can communicate with other hosts on that network. The other two interface cards can then be connected to Atheros devices that are plugged into an isolated power-strip. Of course, one CAT-5 Ethenet cable will be needed for each Ethernet card installed.
-
-
- Interfaces eth1 and eth2 should be assigned IP addresses on a separate sub-net so that you can ping one card from the other over the powerline without sending traffic over the local network. Remember that powerline devices have MAC addresses but not IP addresses. Also, Linux ping uses the routing table to route messages and so you may need to use the -I option when pinging over the powerline. Otherwise, ping packets may go out over the local network by default.
-
-
-# ifconfig
-eth0 Link encap:Ethernet HWaddr 00:50:04:A5:D9:5A
- inet addr:192.168.99.12 Bcast:192.168.99.255 Mask:255.255.255.0
- UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
-
-eth1 Link encap:Ethernet HWaddr 00:01:03:2B:03:67
- inet addr:192.168.101.10 Bcast:192.168.101.255 Mask:255.255.255.0
- UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
-
-eth2 Link encap:Ethernet HWaddr 00:01:03:2B:03:73
- inet addr:192.168.101.11 Bcast:192.168.101.255 Mask:255.255.255.0
- UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
-
-lo Link encap:Local Loopback
- inet addr:127.0.0.1 Mask:255.0.0.0
- UP LOOPBACK RUNNING MTU:16436 Metric:1
-
-
- The abbreviated ifconfig console display, shown above, illustrates a typical Ethernet configuration using three cards, as recommended by Atheros. Interface eth0 is on the 192.168.99.0 subnet which serves as the local network, in this case. Interfaces eth1 and eth2 are both on the 192.168.101.0 subnet which serves as the powerline network, in this case.
-
-
- Although not required, installing both wireshark and tshark is a great idea because they can be used to monitor and log network traffic on any or all of the Ethernet interfaces during various operations.
-
-
-
-
- Isolated Power-strip
-
-
- Atheros devices have a way of finding each other over powerline and sometimes across nearby powerlines. Power-strip isolation prevents cross-talk with other powerline devices that may be plugged into nearby. Proper isolation is not critical when getting started but can be critical in technical evaluation and production environments.
-
-
- There are many ways to isolate powerline devices. One way is to plug the powerline workstation and the power-strip into an Uninterruptable Power Supply (UPS). Atheros also provides several reference designs for both expensive and inexpensive hardware that can be used to isolate devices and workstations.
-
-
- Atheros powerline devices tend to work best when there is some signal attenuation over powerline or coax connections. Engineering evaluation configurations should insert some type of variable attenuation between powerline devices to measure the performance of their own powerline device designs. Consult with your Atheros Field Application Engineer on this matter.
-
-
-
-
-
- Send-to-self Patch
-
-
- One advantage of Linux powerline workstations is the ability to control the low-level networking environment. ISO Layer 2 traffic can be easily directed from one Ethernet interface to another on the same host but Layer 3 traffic is a different matter because routing software merely routes this type of traffic internally.
-
-
- A Linux kernel patch is available that will allow ISO Layer 3 traffic to be routed from one Ethernet interface to another on the same host. With this patch, multiple instances of a traffic generator, like ttcp or iperf, can be effectively deployed on the same host without modification.
-
-
- This patch is useful for testing on a closed network but it could pose a security risk to the local host when connected to a public network. Kernels having this patch installed should have a special designation such as linux-2.6.28-send-to-self so that users are aware that the patch is installed.
-
-
-
- <quote>send-to-self</quote> Patch Description
-
-
- The following is the full, original patch description.
-
-, July 2003
-
- Patches for different kernels:
-
- send-to-self-2.4.21-1.diff
- send-to-self-2.5.73-1.diff
-
- The presented patch implements routing of traffic between local
-IP addresses externally via ethernet interfaces. This patch is basically
-the Ben Greear's send-to-self work but reimplemented entirely on routing
-level. The idea is to return output route via external interfaces if
-path between two local IP addresses is requested and they are configured
-on different interfaces with /proc/sys/net/ipv4/conf/DEVNAME/loop set to
-1. As result, arp_filter (if enabled - the recommended value)
-automatically accepts the ARP requests on the right interface. The
-rp_filter check is modified to accept traffic from such interfaces with
-local IP as sender, so using loop=1 for interfaces attached to insecure
-mediums is not recommended.
-
-Pros:
-- it can be used from all existing applications without change
-- it is not limited to 2 interfaces
-- you can use it with many IP addresses
-- does not depend on the rp_filter and arp_filter states, they
-can be set to 1
-- the packets are not altered in any way, useful for QoS testings
-- the routing result is cached, the routing checks are not per packet
-
-Cons:
-- not possible to use it for interfaces attached to insecure
-mediums (the rp_filter protection allows saddr to be local IP).
-By design. Use at your own risk.
-
- The usage is simple:
-
-# Connect two or more interfaces to same hub or via crossover cable
-
-# Enable loopback mode for eth0 and eth1. This even can be
-# default mode without breaking any other talks. By this way
-# we allow external routing only between local IPs configured
-# on the specified interfaces.
-
-echo 1 > /proc/sys/net/ipv4/conf/eth0/loop
-echo 1 > /proc/sys/net/ipv4/conf/eth1/loop
-
-# Add some IP addresses for testing, eg. client and server IP
-
-ip address add 192.168.1.1 dev eth0
-ip address add 192.168.2.1 dev eth1
-
-# Testing with applications that are aware of this binding.
-# The main thing the apps need to know is what src and dst IP
-# addresses to use. The client app needs to bind to the src IP
-# and by this way to request output route to the dst IP. There
-# is no specific configuration for the server app listening on
-# 192.168.2.1
-
-ping -I 192.168.1.1 192.168.2.1
-
-# Note that specifying the output device (SO_BINDTODEVICE is
-# not recommended)
-
-
-# Testing with applications that are not aware of this feature:
-# for 192.168.1.1 client (the same for the server is not needed).
-# Note that by default, in local routes the kernel uses the local
-# IPs as preferred source. This is the safe default mode (if loop=1)
-# for applications that do not care what src IP will be used
-# for their talks with local IPs. We try to change that and to
-# use IPs from different interfaces.
-
-ip route replace local 192.168.2.1 dev eth1 scope host src 192.168.1.1 proto kernel
-
-# but for any case, here it is and for the "server":
-
-ip route replace local 192.168.1.1 dev eth0 scope host src 192.168.2.1 proto kernel
-
-# Testing it:
-
-ping 192.168.2.1
-ping -I 192.168.1.1 192.168.2.1
-telnet 192.168.2.1
-
-# Note that by replacing the local route's preferred source IP address
-# we help the IP address autoselection to select proper IP to the
-# target, in our case, route via eth
-]]>
-
-
-
- <quote>send-to-self</quote> Patch Application
-
-
- The following example illustrates how to use iperf to perform TCP and UDP traffic measurements once this patch is installed. We illustrate the use of iperf but do not necessarily endorse it for traffic measurement. We also illustrate the use of two interfaces but the send-to-self patch will support additional interfaces. We also illustrate the use of environment variables so that procedures can execute on different hosts without modification but these environment variables are not required.
-
-
- First, we define environment variables, IF1 and IF2, for each Ethernet interface and, IP1 and IP2, for their IP addresses. Each interface must be on a separate IP subnet. We export definitions here so that they are accessible to this process and any subprocesses, such as shell scripts. Do whatever is appropriate for your environment.
-
-
-
- Next, we assign the IP addresses to the interfaces using program ifconfig. There are other ways to do this. Observe that we reference our environment variables on the command line.
-
-
-
- Next, we suppress internal routing between local interfaces. The loop propery only exists on kernels that have the send-to-self patch installed and have the /proc filesystem mounted. Some systems may not mount this file system.
-
- /proc/sys/net/ipv4/conf/${IF1}/loop
-echo 1 > /proc/sys/net/ipv4/conf/${IF2}/loop
-]]>
-
- Alternately, you could edit file /etc/sysctl.conf, as follows, to set the loop property for each interface during system startup. Again, the loop propery only exists on kernels that have the send-to-self patch installed and so errors will occur if you boot another kernel that does not have it installed.
-
-
-
- Open a console window and start iperf as a server. Option -s identifies this instance of iperf as the server. Option -B binds this instance to one host interface by IP address, in this case IP1 defined earlier.
-
-
-
- Open a second console window and start iperf as a client. Option -c identifies this instance of iperf as a client. Option -B binds this instance to the one interface by IP address, in this case IP2 defined earlier. The server address must also be specified, in this case IP1 bound to the server in the last step.
-
-
-
-
-
- <quote>send-to-self</quote> Patch Installation
-
-
- The send-to-self patch exists for several recent Linux kernel versions but not all versions. Assuming you have obtained the correct kernel archive and the correct patch version, the following script illustrates the steps needed to apply the patch on Ubuntu 9.04 and recompile the kernel. Observe that, in this case, the patch version does not match the kernel version because a patch has not been published for that kernel version.
-
-
- The following script can be used on a Ubuntu Linux distribution to download kernel source, the send-to-self patch, apply the patch then compile and install the resulting kernal image. When the menuconfig screen appears:
-
-
-
-
- Select General Setup on the Linux Kernel Configuration screen.
-
-
-
-
- Select Local version - append to kernel release on the General Setup screen.
-
-
-
-
- Enter the version suffix -send-to-self.
-
-
-
-
- Select ok to return to the General Setup screen.
-
-
-
-
- Select Automatically append version information to the version string on the General Setup screen.
-
-
-
-
- Select exit to return to the Linux Kernel Configuration screen.
-
-
-
-
- Select exit to close the menuconfig program.
-
-
-
-
- Select yes if prompted to save your new kernel configuration. This message does not appear each time.
-
-
-
-
-
-
-
- In case you don't know ...
-
-
- apt-get --reinstall
-
-
- The apt-get program is only available on Debian-based distributions. If you do not use a Debian-based system then you must find another way to obtain the necessary packages. Option --reinstall instructs apt-get to download the kernel even though it has been installed before. It is not needed on the first script execution but may be needed on subsequent script executions if you have deleted the kernel archive file.
-
-
- mkinitramfs
-
-
- This script uses mkinitramfs instead of the mkinitrd. This may differ on other distributions. The kernel source package used here has Ubuntu modifications that result in a minor version being appended to the kernel version. This may not happen with other distributions or with kernels obtained directly from kernel.org.
-
-
- cut-and-paste
-
-
- This script, or some like it, are included in the ./patches folder of the toolkit. You can also copy and paste this script but remember to edit the environment variables at the top, remove all carriage returns and set correct file permissions with chmod 0755 before executing it on your Linux host. Run the script as root user.
-
- grub/menu.lst
-
-
- If your system uses grub then edit file /boot/grub/menu.lst and add a new reference to the new initrd.img, System.map and vmlinuz files installed in folder /boot by this script. We recommend adding these references as the last ones in the file so that the new kernel does not start by default. Once you are confident that everything works, you can then move the references to the first entry. We also recommend setting the timeout value to 10 for now.
-
-
-
-
- <quote>send-to-self</quote> Patch Listing
-
-
- The following send-to-self patch is specifically for Linux kernel 2.6.30 and is provided for information only. For practical purposes, the patch has not changed much from version to version but the line numbers have changed. Some recent send-to-self patches are included in the toolkit ./patches folder.
-
-ifa_list == NULL;
- rpf = IN_DEV_RPFILTER(in_dev);
-+ loop = IN_DEV_LOOP(in_dev);
- }
- rcu_read_unlock();
-
-@@ -258,6 +259,11 @@ int fib_validate_source(__be32 src, __be
- net = dev_net(dev);
- if (fib_lookup(net, &fl, &res))
- goto last_resort;
-+ if (loop && res.type == RTN_LOCAL) {
-+ *spec_dst = FIB_RES_PREFSRC(res);
-+ fib_res_put(&res);
-+ return 0;
-+ }
- if (res.type != RTN_UNICAST)
- goto e_inval_res;
- *spec_dst = FIB_RES_PREFSRC(res);
-diff -urp v2.6.30/linux/net/ipv4/route.c linux/net/ipv4/route.c
---- v2.6.30/linux/net/ipv4/route.c 2009-06-13 10:53:58.000000000 +0300
-+++ linux/net/ipv4/route.c 2009-06-13 15:54:15.000000000 +0300
-@@ -2521,6 +2521,11 @@ static int ip_route_output_slow(struct n
- dev_put(dev_out);
- goto out; /* Wrong error code */
- }
-+ err = -ENETDOWN;
-+ if (!(dev_out->flags&IFF_UP)) {
-+ dev_put(dev_out);
-+ goto out;
-+ }
-
- if (ipv4_is_local_multicast(oldflp->fl4_dst) ||
- oldflp->fl4_dst == htonl(0xFFFFFFFF)) {
-@@ -2588,10 +2593,41 @@ static int ip_route_output_slow(struct n
- free_res = 1;
-
- if (res.type == RTN_LOCAL) {
-- if (!fl.fl4_src)
-- fl.fl4_src = fl.fl4_dst;
-+ struct in_device *in_dev;
-+ __be32 src;
-+
- if (dev_out)
- dev_put(dev_out);
-+ dev_out = FIB_RES_DEV(res);
-+ in_dev = in_dev_get(dev_out);
-+ src = fl.fl4_src? : FIB_RES_PREFSRC(res);
-+ if (in_dev && IN_DEV_LOOP(in_dev) && src) {
-+ struct net_device *dev_src;
-+
-+ in_dev_put(in_dev);
-+ in_dev = NULL;
-+ dev_src = ip_dev_find(net, src);
-+ if (dev_src && dev_src != dev_out &&
-+ (in_dev = in_dev_get(dev_src)) &&
-+ IN_DEV_LOOP(in_dev)) {
-+ in_dev_put(in_dev);
-+ dev_out = dev_src;
-+ fl.fl4_src = src;
-+ fl.oif = dev_out->ifindex;
-+ res.type = RTN_UNICAST;
-+ if (res.fi) {
-+ fib_info_put(res.fi);
-+ res.fi = NULL;
-+ }
-+ goto make_route;
-+ }
-+ if (dev_src)
-+ dev_put(dev_src);
-+ }
-+ if (in_dev)
-+ in_dev_put(in_dev);
-+ if (!fl.fl4_src)
-+ fl.fl4_src = fl.fl4_dst;
- dev_out = net->loopback_dev;
- dev_hold(dev_out);
- fl.oif = dev_out->ifindex;
-]]>
-
-
-
-
diff --git a/docbook/hexdecode.c.html b/docbook/hexdecode.c.html
deleted file mode 100644
index 5298cb50..00000000
--- a/docbook/hexdecode.c.html
+++ /dev/null
@@ -1,80 +0,0 @@
-
-
-
-
-
- hexdecode.c
-
-
-
-
-
-
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void hexwrite (signed fd, void const * memory, size_t extent);
- *
- * number.h
- *
- * write a memory region as a stream of hexadecimal characters;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef HEXWRITE_SOURCE
-#define HEXWRITE_SOURCE
-
-#include <unistd.h>
-
-#include "../tools/types.h"
-#include "../tools/number.h"
-
-void hexwrite (signed fd, void const * memory, size_t extent)
-
-{
- byte * offset = (byte *)(memory);
- while (extent--)
- {
- byte byte = * offset;
- write (fd, &DIGITS_HEX [(byte >> 4) & 0x0F], sizeof (byte));
- write (fd, &DIGITS_HEX [(byte >> 0) & 0x0F], sizeof (byte));
- offset++;
- }
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * homeplug.h - HomePlug Definitions and Declarations;
- *
- *. Qualcomm Atheros HomePlug AV Powerline Toolkit
- *: Copyright (c) 2009-2013 by Qualcomm Atheros Inc. ALL RIGHTS RESERVED;
- *; For demonstration and evaluation only; Not for production use.
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Alex Vasquez <alex.vasquez@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef HOMEPLUG_HEADER
-#define HOMEPLUG_HEADER
-
-/*====================================================================*
- * HomePlug AV Constants;
- *--------------------------------------------------------------------*/
-
-#define HOMEPLUG_MMV 0x01
-#define HOMEPLUG_MMTYPE 0x0000
-
-/*====================================================================*
- * HomePlug Management Message Ranges for Information Only;
- *--------------------------------------------------------------------*/
-
-#define CC_MMTYPE_MIN 0x0000
-#define CC_MMTYPE_MAX 0x1FFF
-#define CP_MMTYPE_MIN 0x2000
-#define CP_MMTYPE_MAX 0x3FFF
-#define NN_MMTYPE_MIN 0x4000
-#define NN_MMTYPE_MAX 0x5FFF
-#define CM_MMTYPE_MIN 0x6000
-#define CM_MMTYPE_MAX 0x7FFF
-#define MS_MMTYPE_MIN 0x8000
-#define MS_MMTYPE_MAX 0x9FFF
-#define VS_MMTYPE_MIN 0xA000
-#define VS_MMTYPE_MAX 0xBFFF
-#define HA_MMTYPE_MIN 0xC000
-#define HA_MMTYPE_MAX 0xFFFF
-
-/*====================================================================*
- * HomePlug AV MMEs have 4 variants indicated by the 2 MMTYPE LSBs;
- *--------------------------------------------------------------------*/
-
-#define MMTYPE_CC 0x0000
-#define MMTYPE_CP 0x2000
-#define MMTYPE_NN 0x4000
-#define MMTYPE_CM 0x6000
-#define MMTYPE_MS 0x8000
-#define MMTYPE_VS 0xA000
-#define MMTYPE_XX 0xC000
-
-#ifndef IHPAPI_HEADER
-#define MMTYPE_REQ 0x0000
-#define MMTYPE_CNF 0x0001
-#define MMTYPE_IND 0x0002
-#define MMTYPE_RSP 0x0003
-#define MMTYPE_MODE (MMTYPE_REQ|MMTYPE_CNF|MMTYPE_IND|MMTYPE_RSP)
-#define MMTYPE_MASK ~(MMTYPE_REQ|MMTYPE_CNF|MMTYPE_IND|MMTYPE_RSP)
-#endif
-
-/*====================================================================*
- * HomePlug AV Management Message Types;
- *--------------------------------------------------------------------*/
-
-#define CC_CCO_APPOINT 0x0000
-#define CC_BACKUP_APPOINT 0x0004
-#define CC_LINK_INFO 0x0008
-#define CC_HANDOVER 0x000C
-#define CC_HANDOVER_INFO 0x0010
-#define CC_DISCOVER_LIST 0x0014
-#define CC_LINK_NEW 0x0018
-#define CC_LINK_MOD 0x001C
-#define CC_LINK_SQZ 0x0020
-#define CC_LINK_REL 0x0024
-#define CC_DETECT_REPORT 0x0028
-#define CC_WHO_RU 0x002C
-#define CC_ASSOC 0x0030
-#define CC_LEAVE 0x0034
-#define CC_SET_TEI_MAP 0x0038
-#define CC_RELAY 0x003C
-#define CC_BEACON_RELIABILITY 0x0040
-#define CC_ALLOC_MOVE 0x0044
-#define CC_ACCESS_NEW 0x0048
-#define CC_ACCESS_REL 0x004C
-#define CC_DCPPC 0x0050
-#define CC_HP1_DET 0x0054
-#define CC_BLE_UPDATE 0x0058
-#define CP_PROXY_APPOINT 0x2000
-#define PH_PROXY_APPOINT 0x2004
-#define CP_PROXY_WAKE 0x2008
-#define NN_INL 0x4000
-#define NN_NEW_NET 0x4004
-#define NN_ADD_ALLOC 0x4008
-#define NN_REL_ALLOC 0x400C
-#define NN_REL_NET 0x4010
-#define CM_ASSOCIATED_STA 0x6000
-#define CM_ENCRYPTED_PAYLOAD 0x6004
-#define CM_SET_KEY 0x6008
-#define CM_GET_KEY 0x600C
-#define CM_SC_JOIN 0x6010
-#define CM_CHAN_EST 0x6014
-#define CM_TM_UPDATE 0x6018
-#define CM_AMP_MAP 0x601C
-#define CM_BRG_INFO 0x6020
-#define CM_CONN_NEW 0x6024
-#define CM_CONN_REL 0x6028
-#define CM_CONN_MOD 0x602C
-#define CM_CONN_INFO 0x6030
-#define CM_STA_CAP 0x6034
-#define CM_NW_INFO 0x6038
-#define CM_GET_BEACON 0x603C
-#define CM_HFID 0x6040
-#define CM_MME_ERROR 0x6044
-#define CM_NW_STATS 0x6048
-#define CM_SLAC_PARAM 0x6064
-#define CM_START_ATTEN_CHAR 0x6068
-#define CM_ATTEN_CHAR 0x606C
-#define CM_PKCS_CERT 0x6070
-#define CM_MNBC_SOUND 0x6074
-#define CM_VALIDATE 0x6078
-#define CM_SLAC_MATCH 0x607C
-#define CM_SLAC_USER_DATA 0x6080
-#define CM_ATTEN_PROFILE 0x6084
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * unsigned hostnics (struct nic list [], unsigned size);
- *
- * ether.h
- *
- * encode an external memory region with a packed list of available
- * nost network interfaces; return the number of interfaces found;
- * each interface has an index, ethernet address, internet address,
- * name and description;
- *
- * this function is implemented for Linux and MacOSX;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef HOSTNICS_SOURCE
-#define HOSTNICS_SOURCE
-
-#if defined (__linux__)
-# include <net/if.h>
-# include <net/ethernet.h>
-# include <sys/ioctl.h>
-#elif defined (__linux__)
-# include <net/if.h>
-# include <netpacket/packet.h>
-# include <ifaddrs.h>
-#elif defined (__APPLE__) || defined (__OpenBSD__)
-# include <sys/types.h>
-# include <sys/socket.h>
-# include <net/if.h>
-# include <net/if_dl.h>
-# include <net/if_types.h>
-# include <ifaddrs.h>
-#elif defined (WIN32)
-#error "Not implemented for Windows"
-#else
-#error "Unknown environment"
-#endif
-
-#include <unistd.h>
-#include <memory.h>
-#include <errno.h>
-
-#include "../ether/ether.h"
-#include "../tools/error.h"
-
-unsigned hostnics (struct nic nics [], unsigned size)
-
-{
-
-#if defined (__linux__)
-
-/*
- * native method on Linux systems;
- */
-
- char buffer [1024];
- struct ifconf ifconf;
- struct ifreq * ifreq;
- unsigned next;
- signed fd;
- memset (nics, 0, size * sizeof (struct nic));
- ifconf.ifc_len = sizeof (buffer);
- ifconf.ifc_buf = buffer;
- if ((fd = socket (AF_INET, SOCK_DGRAM, 0)) < 0)
- {
- error (1, errno, "Can't open socket");
- }
- if (ioctl (fd, SIOCGIFCONF, &ifconf) < 0)
- {
- error (1, errno, "Can't read socket configuration");
- }
- ifreq = ifconf.ifc_req;
- next = ifconf.ifc_len / sizeof (struct ifreq);
- if (next > size)
- {
- next = size;
- }
- if (next < size)
- {
- size = next;
- }
- for (next = 0; next < size; next++)
- {
- struct nic * nic = &nics [next];
- struct sockaddr_in * sockaddr_in = (struct sockaddr_in *)(&ifreq->ifr_addr);
- memcpy (nic->ifname, ifreq->ifr_name, sizeof (nic->ifname));
- memcpy (nic->ifdesc, ifreq->ifr_name, sizeof (nic->ifdesc));
- memcpy (nic->internet, &sockaddr_in->sin_addr, sizeof (nic->internet));
- if (ioctl (fd, SIOCGIFHWADDR, ifreq) == -1)
- {
- error (0, errno, "Can't read hardware address: %s", ifreq->ifr_name);
- }
- memcpy (nic->ethernet, ifreq->ifr_hwaddr.sa_data, sizeof (nic->ethernet));
- if (ioctl (fd, SIOCGIFINDEX, ifreq) == -1)
- {
- error (0, errno, "Can't read interface index: %s", ifreq->ifr_name);
- }
- nic->ifindex = ifreq->ifr_ifindex;
- ifreq++;
- }
- close (fd);
-
-#elif defined (__linux__) || defined (__APPLE__) || defined (__OpenBSD__)
-
-/*
- * generic (POSIX) method for unix-like systems;
- */
-
- struct ifaddrs * ifaddrs;
- memset (nics, 0, size * sizeof (struct nic));
- unsigned next = 0;
- if (getifaddrs (&ifaddrs) != -1)
- {
- struct ifaddrs * ifaddr;
- for (ifaddr = ifaddrs; ifaddr && size; ifaddr = ifaddr->ifa_next)
- {
- struct nic * nic = &nics [next];
- struct nic * tmp = nics;
- if (!ifaddr->ifa_addr)
- {
- continue;
- }
- nic->ifindex = if_nametoindex (ifaddr->ifa_name);
- for (tmp = nics; tmp->ifindex != nic->ifindex; tmp++);
- if (tmp == nic)
- {
- next++;
- size--;
- }
- else
- {
- nic = tmp;
- }
- memcpy (nic->ifname, ifaddr->ifa_name, sizeof (nic->ifname));
- memcpy (nic->ifdesc, ifaddr->ifa_name, sizeof (nic->ifdesc));
- if (ifaddr->ifa_addr->sa_family == AF_INET)
- {
- struct sockaddr_in * sockaddr_in = (struct sockaddr_in *) (ifaddr->ifa_addr);
- struct in_addr * in_addr = (struct in_addr *)(&sockaddr_in->sin_addr);
- memcpy (nic->internet, &in_addr->s_addr, sizeof (nic->internet));
- }
-
-#if defined (__linux__)
-#define LLADDR(socket) &(socket)->sll_addr
-
- if (ifaddr->ifa_addr->sa_family == AF_PACKET)
- {
- struct sockaddr_ll * sockaddr_ll = (struct sockaddr_ll *) (ifaddr->ifa_addr);
- memcpy (nic->ethernet, LLADDR (sockaddr_ll), sizeof (nic->ethernet));
- }
-
-#elif defined (__APPLE__) || defined (__OpenBSD__)
-
- if (ifaddr->ifa_addr->sa_family == AF_LINK)
- {
- struct sockaddr_dl * sockaddr_dl = (struct sockaddr_dl *) (ifaddr->ifa_addr);
- if (sockaddr_dl->sdl_type == IFT_ETHER)
- {
-
-#if 1
-
- memcpy (nic->ethernet, LLADDR (sockaddr_dl), sizeof (nic->ethernet));
-
-#else
-
- memcpy (nic->ethernet, LLADDR (sockaddr_dl), sockaddr_dl->sdl_alen);
-
-#endif
-
- }
- }
-
-#else
-#error "Abandon all hope!"
-#endif
-
- }
- freeifaddrs (ifaddrs);
- }
-
-#else
-#error "Unknown environment"
-#endif
-
- return (next);
-}
-
-#endif
-
-
-
-hpav(1) Qualcomm Atheros Open Powerline Toolkit hpav(1)
-
-NAME
- hpav - HomePlug AV Packet Listener
-
-SYNOPSIS
- hpav [options]
-
-DESCRIPTION
- Display HomePlug AV Ethernet messages sent by a local powerline device to the host or the broadcast address. Do not dis‐
- play HomePlug AV frames sent from the host to powerline devices or forwarded over powerline through the local powerline
- devices.
-
- The program is an example of a simple packet listener and daemon. Engineers and software developers can extend it to
- build custom sniffers or servers. The framework is present but additional features must be added.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -i interface
- Names the host ethernet interface to watch. The named interface, such as eth0, eth1 and so on, must be connected
- to a HomePlug AV ethernet-to-powerline bridge adapter to receive any HomePlug AV traffic. The default interface
- is eth1.
-
- -q Quiet mode. Suppress the printing of the normal message descriptions on stdout.
-
- -v Verbose mode. Displays incoming frames in hexadecimal dump format on stdout. This option is independent of
- option -a which prints VS_ARPC message text on stderr.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using. See the HomePlug AV Specification for a description of all HomePlug AV message
- types. See the Qualcomm Atheros INT6000 Firmware Reference Manual for a description of Atheros Vendor Specific
- message types.
-
-EXAMPLES
- The following command monitors the default host interface eth1 for HomePlug AV traffic and dumps detected frames on the
- console as they arrive. To terminate the process, type ^C or ^Z at the console. This program is usually run in a sepa‐
- rate console window while performing powerline operations.
-
- # hpav
-
- The following command monitors host interface eth4 for incoming HomePlug AV frames and dumps writes them to file
- hpav.log. Frames are printed in hexadecimal dump format because option -v is present. Terminate the foreground process
- by typing ^C or ^Z at the console.
-
- # hpav -v -i eth4 > hpav.log
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information is not available. Qualcomm Atheros reserves the right to modify management mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- plc(1), efru(1), efsu(1), mme(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 hpav(1)
-
-hpavkey(1) Qualcomm Atheros Open Powerline Toolkit hpavkey(1)
-
-NAME
- hpavkey - HomePlug AV Key Generator
-
-SYNOPSIS
- hpavkey [options] phrase [phrase] [...]
-
-DESCRIPTION
- Convert one or more phrases to encrypted HomePlug AV keys. Phrases are read as command line arguments, converted to
- either Device Access Keys, Network Membership Keys or Network Identification Keys and printed on stdout. By default,
- only keys are printed, one key per line, but keys and phrases can both be printed, one pair per line.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-BACKGROUND
- HomePlug AV technology makes use of special 16-byte binary values, called "keys", for various purposes such as identity
- and security. Three keys of interest to users are the Device Access Key (DAK), the Network Memership Key (NMK) and Net‐
- work Identification Key (NID). Their purpose is described in the HomePlug AV Specification.
-
- The HomePlug AV Specification explains how to generate 16-byte binary DAK, NMK and NID values using the SHA-256 algorithm
- to hash user-supplied ASCII strings, called "pass phrases" in the specification. HomePlug AV compliant pass phrases have
- from 12 to 64 7-bit ASCII character values in the range 0x20 to 0x7F. In some cases, a specified 8-byte salt is added to
- the pass phrase before computing the 32-byte hash value. In all cases, the computed hash is then rehashed a specified
- number of times to produce the final 32-byte value. The HomePlug AV key is the lower 16-bytes of that value.
-
- Keys can be any 16-byte binary value but binary values are difficult to remember. HomePlug AV applications, such as the
- Qualcomm Atheros Windows Device Manager, will ask users for a pass phrase that is converted to a 16-byte binary value
- using a known hashing algorithm. In principle, no two phrases will product the same key and it would be computationally
- expensive to derive the pass phrase given the key. Although HomePlug AV software deals directly with the key, users need
- only remember the pass phrase in order to reproduce the key.
-
-OPTIONS
- -D Uses HomePlug AV rules to compute Device Access Keys (DAK) from pass phrases read from file or stdin. A DAK is 16
- bytes expressed as 32 hexadecimal digits. This option over-rides any -M and -N options previously specified on
- the command line.
-
- -e Enforce HomePlug AV length and content rules for phrases. Non-compliant phrases are reported and ignored. Com‐
- pliant phrases are 12 to 64 7-bit ASCII characters in the range 0x20 (SP) through 0x7F (DEL). Essentially, this
- includes any character that can be typed on a standard US or UK keyboard, excluding horizontal tab (HT). Be aware
- that some command shells intercept and act on special characters instead of passing them to the application. In
- such cases, you may need to include meta characters.
-
- -L level
- Set security level. The security level is encoded into the NID. Level 0 enables pushbutton pairing. Level 1
- disables it. This option has no effect unless a NID is computed.
-
- -M Uses HomePlug AV rules to compute Network Membership Keys (NMK) from pass phrases read from file or stdin. An NMK
- is 16 bytes expressed as 32 hexadecimal digits. This option over-rides any -D or -N options previously specified
- on the command line.
-
- -N Uses HomePlug AV rules to compute Network Identification Keys (NID) from pass phrases read from file or stdin. A
- NID is 7 bytes expressed as 14 hexadecimal digits. This option over-rides any -D or -M options previously speci‐
- fied on the command line.
-
- -q Enable quiet mode which, for this application, has no effect.
-
- -v Enable verbose mode which, for this application, prints the pass phrase after each key.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- phrase A pass phrase to be converted to a DAK, NMK or NID. More than one pass phrase can be entered on the command line.
- Each phrase will be converted to the same type of key and printed in the order specified. Phrases that contain
- quotes or special delimiters should be enclosed in quotes or apostrophes. By default, phrases can be any length
- and contain any ASCII chracter except ASCII NUL. Use option -e to enforce HomePlug AV password character and
- length rules.
-
-EXAMPLES
- The following example prints the ordinary SHA256 key for the phrase, "HomePlugAV0123", entered on the command line. An
- SHA key is 256 bits or 32 bytes expressed as 64 hexadecimal characters. SHA256 keys are the default output when no key
- type is specified. SHA256 is a public domain standard, not a HomePlug AV standard.
-
- # hpavkey HomePlugAV0123
- EA41A2383355FA7CA3B467DF0848A8EB9C41591BE53696C5F45DDAF621784F07
-
- The following example prints the DAK for the phrase, "HomePlugAV0123", entered on the command line.
-
- # hpavkey -D HomePlugAV0123
- F084B4E8F6069FF1300C9BDB812367FF
-
- The following command prints the NMK, instead of the DAK, for the phrase entered on the command line. The ouput is dif‐
- ferent because the DAK and NMK are computed differently given the same pass phrase.
-
- # hpavkey -M HomePlugAV0123
- B59319D7E8157BA001B018669CCEE30D
-
- The following command prints the NMK for each phrase entered on the command line. Notice that spaces are legal and sig‐
- nificant. Phrases containing spaces must be enclosed in quotes.
-
- # hpavkey -M HomePlugAV0123 "The quick brown fox jumped over the lazy dog."
- B59319D7E8157BA001B018669CCEE30D
- 56F3C7F539D4F8F5EEC00E63F11A8DEC
-
- The following command prints the NMK and pass phrase for each pass phrase entered on the command line because the verbose
- option is specified.
-
- # hpavkey -v -M HomePlugAV0123 "The quick brown fox jumped over the lazy dog."
- B59319D7E8157BA001B018669CCEE30D HomePlugAV0123
- 56F3C7F539D4F8F5EEC00E63F11A8DEC The quick brown fox jumped over the lazy dog.
-
- hpavkey can be used to compute a key and pass it to another program as an argument. The modpib command shown below will
- edit file example.pib by replacing the DAK. The -D option expects a hexadecimal key so we can supply one from the phrase
- "HomePlugAV0123".
-
- # modpid -D $(hpavkey -D HomePlugAV0123) example.pib
-
-TIPS&TRICKS
- The following example illustrates an unusual case where the passwords start with dash ("-"). The program assumes that
- the dash is an option prefix which is incorrect in this case. An error occurs because option -H is illegal.
-
- # hpavkey -vM -HomePlugAV -HomePlugAV123
- hpavkey: Operation canceled: Option 'H' has no meaning
-
- one solution is to insert a double-dash ("--") on the command line to indicate that no further options appear on the com‐
- mand line. We include option -v to display the passwords on output.
-
- # hpavkey -vM -- -HomePlugAV -HomePlugAV123
- 80B74B14E92A739AD41ACDC377451D1B -HomePlugAV
- 1A46BDE6F75209292FDFC4CCE4D19B4E -HomePlugAV123
-
- See the hpavkeys man page for yet another solution to this problem.
-
-REFERENCES
- See the HomePlug AV Specification for more information on encryption keys, pass phrases and hash algorithms used. See
- standard FIPS180-2 sec 5.3.2 for more information on SHA256 encoding.
-
-DISCLAIMER
- Qualcomm Atheros reserves the right to modify program names, functionality, input format or output format in future tool‐
- kit releases without any obligation to notify or compensate toolkit users.
-
-SEE ALSO
- hpavkeys(1), mac2pw(1), mac2pwd(1), rkey(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 hpavkey(1)
-
-hpavkeys(1) Qualcomm Atheros Open Powerline Toolkit hpavkeys(1)
-
-NAME
- hpavkeys - HomePlug AV Key Generator
-
-SYNOPSIS
- hpavkeys [options] file [file] [...]
-
-DESCRIPTION
- Convert blocks of phrases to encrypted HomePlug AV keys. Phrases are read from one or more files, converted to either
- Device Access Keys, Networks Membership Keys or Network Identification Keys and printed on stdout. By default, only keys
- are printed, one per line, but both keys and phrases can be printed, one pair per line.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-BACKGROUND
- HomePlug AV technology uses 16-byte binary values, called "keys", for various purposes such as identity and security.
- Three keys of interest to users are the Device Access Key (DAK), the Network Memership Key (NMK) and Network Identifica‐
- tion Key (NID). Their purpose is described in the HomePlug AV Specification.
-
- The HomePlug AV Specification explains how to generate 16-byte binary DAK, NMK and NID values using the SHA-256 algorithm
- to hash user-supplied ASCII strings, called "pass phrases" in the specification. HomePlug AV compliant pass phrases have
- from 12 to 64 7-bit ASCII character values in the range 0x20 to 0x7F. In some cases, a specified 8-byte salt is added to
- the pass phrase before computing the 32-byte hash value. In all cases, the computed hash is then rehashed a specified
- number of times to produce the final 32-byte value. The HomePlug AV key is the lower 16-bytes of that value.
-
- Keys can be any 16-byte binary value but binary values are difficult to remember. HomePlug AV compliant applications,
- like the Qualcomm Atheros Device Manager, ask users for a pass phrase that is converted to a 16-byte binary value using a
- standard hashing algorithm. In principle, no two phrases will produce the same key and it would be computationally
- expensive to derive the pass phrase given the key. Although HomePlug AV software deals directly with the key, users need
- only remember the pass phrase in order to reproduce the key.
-
-OPTIONS
- -D Uses HomePlug AV rules to compute Device Access Keys (DAK) from pass phrases read from file or stdin. A DAK is 16
- bytes expressed as 32 hexadecimal digits. This option over-rides any -M and -N options previously specified on
- the command line.
-
- -e Enforce HomePlug AV length and content rules for phrases. Non-compliant phrases are reported and ignored. Com‐
- pliant phrases are 12 to 64 7-bit ASCII characters in the range 0x20 (SP) through 0x7F (DEL). Essentially, this
- includes any character that can be typed on a standard US or UK keyboard, excluding horizontal tab (HT). Be aware
- that some command shells intercept and act on special characters instead of passing them to the application. In
- such cases, you may need to include meta characters.
-
- -L level
- Set security level. The security level is encoded into the NID. Level 0 enables pushbutton pairing. Level 1
- disables it. This option has no effect unless a NID is computed.
-
- -M Uses HomePlug AV rules to compute Network Membership Keys (NMK) from pass phrases read from file or stdin. An NMK
- is 16 bytes expressed as 32 hexadecimal characters. This option over-rides any -D or -N options previsously spec‐
- ified on the command line.
-
- -N Uses HomePlug AV rules to compute Network Identification Keys (NID) from pass phrases read from file or stdin. An
- NID is 7 bytes expressed as 14 hexadecimal digits. This option over-rides any -D or -M options previously speci‐
- fied on the command line.
-
- -p Print the password, or pass phrase, used to generate each key after each key on stdout. One single space seper‐
- ates the pass phrase from the key string. The pass phrase consists of all subsequent characters, including spa‐
- ces, appearing up to the end of the line. Without this option, only the keys are printed.
-
- -q Enable quiet mode which, for this application, has no effect. This behavior has changed from earlier program ver‐
- sions.
-
- -v Enable verbose mode which, for this application, prints the input phrase after each key. This behavior has
- changed from earlier program versions.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file Any valid filename. Each file on the command line is read in turn and output is written to stdout, much like the
- cat utility. Input is read from the console when no filenames are specified.
-
-EXAMPLES
- The following command reads file example.keys and prints the SHA256 key for each phrase in that file. An SHA256 key is
- 128 bits or 32 bytes expressed as 32 hexadecimal digits. SHA256 keys are the default output when no key type is speci‐
- fied. SHA256 is a public domain standard, not a HomePlug AV standard.
-
- # hpavkeys example.keys
- EA41A2383355FA7CA3B467DF0848A8EB9C41591BE53696C5F45DDAF621784F07
- 4E76AD8354461437C04EF9B9B242540B6406D782FF2C3FB28AFDAB5B423F88FE
- 71C480DF93D6AE2F1EFAD1447C66C9525E316218CF51FC8D9ED832F2DAF18B73
- 7257DF11A035A49119FD881F20AA7FE88970F1A034E4BBBF2D50FAB0D0239F25
- FAC202F439E47EB5EACF6B9CC4151BF6B2B6E736A79BCAB0F589C63BCB78D16B
-
- The following command reads file example.keys and prints the DAK for each phrase in that file. Input phrases are checked
- for HomePlugAV compliance and illegal phrases are reported then ignored. A legal HomePlug pass phrase is 12 to 64 char‐
- acters consisting of ASCII characters ' ' through '~'. Essentially, these are the only characters that one can enter on
- a standard English keyboard.
-
- # hpavkeys -D example.keys
- F084B4E8F6069FF1300C9BDB812367FF
- 7A6F36AC0DF1031CF04C5AF8DC0A70F0
- 910B3D08D309BCE66452DBB40FDCB551
- 309743236F0403C450A718494825FC02
- 3C94A168BDF4BC19AA111BAB930171A5
- 72D6E17E6756CD778F59FAFC6BF6D2B6
- 914EB1D58AB66461A27794BFF648C04F
- 7B7C094380A6E26F9F4618884C81DB63
- 08AE750B07884E2C380BDCEDBC28D2C8
- F8EE1AC7F4234A3F724D21F8B837B547
-
- The following example reads the same file as above but prints the NMK for each phrase, instead of the DAK. The keys
- printed here have different values because the HomePlug AV Specification requires different hash algorithms for the DAK
- and NMK. Don't mix them up.
-
- # hpavkeys -M example.keys
- B59319D7E8157BA001B018669CCEE30D
- F2B0C7F6C355981EBDD484FF49957420
- 54CB8AB1235896E45E6B643C7BF11ADB
- 75CD66973ED683E041F8AC37ACA88B58
- E20A0A69A3C6326C623202D3F42AF416
- 1671D61F305E81BAF000D58AF09888D5
- 05EFD9C9452BF8415D84BB1C415EE52A
- 56F3C7F539D4F8F5EEC00E63F11A8DEC
- 9718D29451897404DA2719CB80CA2ADA
- E5A7C020E0889A0265759D80DB3F9834
-
- The following command reads the same file as above but prints the pass phrase because the -v option is specified. Keys
- are printed as 32 hex digits then one space then the phrase. Spaces are significant within the phrase. Printed phrases
- start in column 34 and continue to the end of the line.
-
- # hpavkeys -M example.keys -v
- B59319D7E8157BA001B018669CCEE30D HomePlugAV0123
- F2B0C7F6C355981EBDD484FF49957420 01234567890123456789
- 54CB8AB1235896E45E6B643C7BF11ADB abcdefghijklmnopqrstuvwxyz
- 75CD66973ED683E041F8AC37ACA88B58 I love my dog .
- E20A0A69A3C6326C623202D3F42AF416 A.B.C.D.E.F.G.H.I.J.K.L.M.N.O.P.Q.R.S.T.U.V.W.X.Y.Z
- 1671D61F305E81BAF000D58AF09888D5 ~!@#$%^&*()_-`{}[]":;'<>./?
- 05EFD9C9452BF8415D84BB1C415EE52A QWRT-YPSD-FGHJ-KLZX
- 56F3C7F539D4F8F5EEC00E63F11A8DEC The quick brown fox jumped over the lazy dog.
- 9718D29451897404DA2719CB80CA2ADA Super-Duper Electrosonic Frepitator SSEI43
- E5A7C020E0889A0265759D80DB3F9834 A = 3 * (5+2) - 1045
-
-TIPS&TRICKS
- The following example illustrates an unusual case where passwords start with dash ("-"). Program hpavkey assumes that
- the dash is an option prefix which is incorrect in this case. An error occurs because option -H is illegal.
-
- # hpavkey -vM -HomePlugAV -HomePlugAV123
- hpavkey: Operation canceled: Option 'H' has no meaning
-
- One solution is to insert the keys verbatim in a password file, in this case password.txt, then run program hpavkeys on
- that file.
-
- # hpavkeys -vM password.txt
- 80B74B14E92A739AD41ACDC377451D1B -HomePlugAV
- 1A46BDE6F75209292FDFC4CCE4D19B4E -HomePlugAV123
-
-REFERENCES
- See the HomePlug AV Specification for more information on encryption keys, pass phrases and hash algorithms used. See
- standard FIPS180-2 sec 5.3.2 for more information on SHA256 encoding.
-
-DISCLAIMER
- Qualcomm Atheros reserves the right to modify program names, functionality, input format or output format in future tool‐
- kit releases without any obligation to notify or compensate toolkit users.
-
-SEE ALSO
- hpavkey(1), keys(1), mac2pw(1), mac2pwd(1), rkey(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 hpavkeys(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2011 by Qualcomm Atheros.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose with or without fee is hereby granted, provided
- * that the above copyright notice and this permission notice appear
- * in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
- * THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
- * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
- * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
- * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * if.h - substitute net/if.h for systems without one;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef IF_HEADER
-#define IF_HEADER
-
-/*====================================================================*
- * constants;
- *--------------------------------------------------------------------*/
-
-#if defined (WIN32)
-#define IF_NAMESIZE 128
-#endif
-
-/*====================================================================*
- * end;
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2011 by Qualcomm Atheros.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose with or without fee is hereby granted, provided
- * that the above copyright notice and this permission notice appear
- * in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
- * THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
- * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
- * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
- * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * if_arp.h - Substitute Linux header for systems without one;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef IF_ARP_HEADER
-#define IF_ARP_HEADER
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-/*
- * do nothing with blinding speed and absolute accuracy;
- */
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2011 by Qualcomm Atheros.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose with or without fee is hereby granted, provided
- * that the above copyright notice and this permission notice appear
- * in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
- * THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
- * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
- * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
- * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * if_ether.h - Substitute Linux header for systems without one;
- *
- * On Linux systems, this file is actually included by header file
- * net/ethernet.h which defines ethernet constants in terms of the
- * ones defined here;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef IF_ETHER_HEADER
-#define IF_ETHER_HEADER
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#include <net/ethernet.h>
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2011 by Qualcomm Atheros.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose with or without fee is hereby granted, provided
- * that the above copyright notice and this permission notice appear
- * in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
- * THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
- * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
- * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
- * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * in.h - Substitute Linux header for systems without one;
- *
- * Emulate the POSIX header netinet/in.h;
- *
- * specifically, obtain declare endian conversion functions htons(),
- * ntohs(), htonl() and ntohl();
- *
- *. Intellon Linux Toolkit;
- *: Published 2007 by Intellon Corp. ALL RIGHTS RESERVED;
- *; For demonstration; Not for production use;
- *
- * Contributor(s):
- * Charles Maier <charles.maier@atheros.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef IN_HEADER
-#define IN_HEADER
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#if defined (WIN32)
-#include <winsock2.h>
-#endif
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-
- Andrew Barnes <abarnes@qca.qualcomm.com>
-
- Marc Bertola <mbertola@qti.qualcomm.com>
-
- Florian Fainelli <f.fainelli@gmail.com>
-
- Nate Houghton <nhoughto@qca.qualcomm.com>
-
- Mathieu Poullet <m.poullet@avm.de>
-
- Stefan Wahren <stefan.wahren@i2se.com>
-
- Bill Wike <bwike@qca.qualcomm.com>
-
- Alejandro Vasquez <avasquez@qca.qualcomm.com>
-
- open-plc-utils-0.0.4
-
Abstract
- This document is the manual for the Qualcomm Atheros Open Powerline Toolkit. New users should read the first chapter before starting using the toolkit because it will answer many questions about toolkit installation, structure, content and application. New users may want to add this page and toolkit.html to their browser favorites for later reference.
-
- HomePlug® AV is a registered trademark of the HomePlug Powerline Alliance. Linux™ is a trademark of Linus Tovalds. Windows® is a registered trademark of Microsoft Corporation. INT6000™, INT6300™, INT6400™, AR6410™, QCA7000™, AR7400™ and AR7420™ are powerline products from Qualcomm Atheros.
-
-/*====================================================================*
- *
- * Copyright (c) 2011 by Qualcomm Atheros.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose with or without fee is hereby granted, provided
- * that the above copyright notice and this permission notice appear
- * in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
- * THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
- * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
- * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
- * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * inet.h - Substitute Linux header for systems without one;
- *
- * Emulate the POSIX header arpa/inet.h;
- *
- * specifically, obtain declare endian conversion functions htons(),
- * ntohs(), htonl() and ntohl();
- *
- *. Intellon Linux Toolkit;
- *: Published 2007 by Intellon Corp. ALL RIGHTS RESERVED;
- *; For demonstration; Not for production use;
- *
- * Contributor(s):
- * Charles Maier <charles.maier@atheros.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef IN_HEADER
-#define IN_HEADER
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#include <winsock2.h>
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-
-
-
-
diff --git a/docbook/install-linux.xml b/docbook/install-linux.xml
deleted file mode 100644
index ae388334..00000000
--- a/docbook/install-linux.xml
+++ /dev/null
@@ -1,69 +0,0 @@
-
-
- Toolkit Installation on Linux
-
-
- The Linux version of the toolkit must be compiled from source code. The only requirement is the standard GNU/Linux toolchain consisting of make, gcc and ld. These are included with most Linux distributions but may require installation. On Debian based distributions, such as Ubuntu, they may be installed using apt-get. On RedHat distributions, such as Fedora, they may be installed using rpm. On SuSE based distributions, they may be installed using YaST2.
-
-
-
- Toolkit Installation on GNU/<productname>Linux</productname>
-
-
-
- Toolkit Installation on GNU/<productname>Linux</productname>
-
-
-# cp plc-utils-1.2.1.tar.gz /home/mydir
-# cd /home/mydir
-# tar -vzxf plc-utils-1.2.1.tar.gz
-# cd plc-utils-1.2.1
-# make
-# make install
-# make manuals
-
-
-
- Decompress the archive and extract the contents with the tar utility. This will create a folder having the same basename as the archive such that one version will not over-write another. Consult the tar man page on your system for detailed instructions. Change directory to the appropriate folder.
-
-
- The main package folder contains a recursive Makefile that will compile and install all toolkit programs. If you do not want to compile and install all programs then change directory to the appropriate folder and run make from there. To compile binary files, type make. To install binary files, type make install. To install man pages, type make manuals. The package does not automatically install examples, scripts, applets or man pages.
-
-
- We recommend that you login as root user before installing the toolkit; otherwise, you will be prompted for the root password as each program or component is installed.
-
-
- Programs are installed in folder /usr/local/bin and man pages are installed in folders /usr/share/man/man1. If these folders are not correct for your system, or if you want to install in other folders, then edit the folder names defined in the make.def file found in main toolkit folder or over-ride these definitions in subordinate makefiles.
-
-
-
-
- Toolkit Documentation on GNU/Linux
-
-
- Toolkit web pages are not automatically installed. To access toolkit documentation, point your browser to docbook/index.html and add the page to the browser bookmark or favorites list. If you are interested in how the toolkit has been implemented then do the same for page docbook/toolkit.html.
-
- The method described above is only recommended if you do not plan to move or remove toolkit folders. Otherwise, you can merely copy the entire contents of the toolkit docbook folder to another folder of your choice and point your browser to the new file locations.
-
-
-cp -rv docbook/* /home/mydir/toolkit
-
-
-
-
- Toolkit Removal on GNU/<productname>Linux</productname>
-
-
- To uninstall installed programs and man pages on Linux, change to the main toolkit folder and type make uninstall.
-
-
-
- Toolkit Removal on GNU/<productname>Linux</productname>
-
-
-# cd /home/mydir/plc-utils-1.2.1
-make uninstall
-
-
-
-
diff --git a/docbook/install-macosx.xml b/docbook/install-macosx.xml
deleted file mode 100644
index c1cf655d..00000000
--- a/docbook/install-macosx.xml
+++ /dev/null
@@ -1,41 +0,0 @@
-
-
- Toolkit Installation on Mac OS X
-
-
- Toolkit installation on Mac OS X is essentially identical to installation on Linux but special steps are needed before starting.
-
-
- First, you must install the toolkit as the root user or you will be denied permission. The root user account is disabled by default and so you must enable it in order to login. Follow instructions at Enabling the "root" user in Mac OS X to enable the account and login. After installation, toolkit programs should be run from a normal user account.
-
-
- Second, Mac OS X does not include C Language development tools by default. You must download and install them in order to build the toolkit. You can download and install them from the Apple website or (if you are ambitious) download, compile and install them from various open source websites. Consider using Xcode on Mac OS X Leopard or Lion.
-
-
- Login as the root user and download or copy the toolkit archive file to your preferred folder then follow the instructions for installing the toolkit on Linux.
-
-
-
- Setting the <constant>PATH</constant> variable on <productname>OS X</productname>
-
-
- While still logged in as the root user, edit /etc/profile and add folder/usr/local/bin to the PATH definition found there. This will ensure that all users can access toolkit programs. The change may not take effect until the next time you login or open a new command shell.
-
-
-
-PATH="/bin:/sbin:/usr/local/bin"
-
-
-
-
- Installing the Toolkit on <productname>Mac OS X</productname>
-
-
- While still logged in as the root user, remember to delete the toolkit source folder or, at least change ownership of all files in the toolkit folder, so that you can access and/or remove them later.
-
-
-cd ..
-rm -r plc-utils-x.x.x
-
-
-
diff --git a/docbook/install-windows-7.xml b/docbook/install-windows-7.xml
deleted file mode 100644
index 75b78bd0..00000000
--- a/docbook/install-windows-7.xml
+++ /dev/null
@@ -1,142 +0,0 @@
-
-
- Toolkit Installation on <productname>Windows 7</productname>
-
-
- The Windows version of the toolkit comes pre-compiled and ready to install and run using the native Windows Installer. You may copy and distribute installation file plc-utils-x.x.x.msi. Users merely click on the file to install the package and may discard it afterwards. This method of installation permits remote installation over network.
-
-
- The version of the Windows Installer used here needs Microsoft .NET Framework 1.1 to work correctly. Newer versions of the .NET Framework will not work. The .NET Framework must be installed before the toolkit is installed or the Windows Installer will report dependency errors and refuse to complete installation. Multiple versions of the .NET Framework can coexist under Windows 7. The .NET Framework needed is included in the toolkit support folder.
-
-
- Failure to remove previous toolkit versions on some systems may result in the message "Another version of this product is already installed" when trying to install a new version. You may want to remove prior version before starting toolkit installation.
-
-
- Windows versions of toolkit programs that communicate with powerline devices all need WinPcap from winpcap.org to read and write Ethernet frames. WinPcap may be installed before or after toolkit installation but tools that access powerline devices will not run without it. You may want to install WinPcap before starting toolkit installation. If you have Wireshark installed then you probably already have WinPcap installed. A recent copy of WinPcap is included in the toolkit support folder.
-
-
-
- Obtaining the Toolkit
-
-
- QCA customers can download the toolkit from the QCA Customer FTP Site.
-
-
- QCA employees may be able to download the toolkit from the QCA Application Engineering World FTP site ftp://appslinux01.qca.qualcomm.com/toolkit/plc-utils/. There are several installers available for Windows. Each installs a subset of the toolkit. Download the desired installer files to your local machine then execute them by right-clicking on them and selecting option "Run as Administrator".
-
-
-
-
- Installing the Toolkit
-
-
- Older toolkit programs were installed in folder C:\Program Files\Atheros\Toolkit by default but now they are installed in C:\Program Files (x86)\Qualcomm Atheros\Open Powerline Toolkit instead. If you select a different folder during installation then remember it for the next step.
-
-
-
- Windows Installer Dialogue
-
-
-
-
-
-
-
-
- Accept install defaults.
-
-
-
-
- Setting the PATH variable
-
-
- Toolkit programs have command line interfaces and must be run from an open console window. To simplify program access and minimize the typing required, add the toolkit installation path mentioned above to the PATH environment variable by following steps listed below. If you have Administrator privileges then we recommend that you edit the system PATH variable; otherwise, you may need to create and/or edit a user PATH variable.
-
-
-
- Control Panel System Dialogue
-
-
-
-
-
-
-
-
-
-
- On the Start menu, select the Control Panel option.
-
-
-
-
- On the Adjust system settings page, select the System icon.
-
-
-
-
- On the View basic information about your computer page, select the Advanced system settings option.
-
-
-
-
- On the System Properties dialog, press the Environment Variables button.
-
-
-
-
- On the Environment Variables dialog box, scroll down the System variables list and select the Path variable then press the Edit button.
-
-
-
-
- On the Edit System Variable dialogue box, append the installation path to the Variable value field.
-
-
-
-
- Press the OK button.
-
-
-
-
- Environment variable changes made here do not take effect until a console window is opened. This means that you may need to close and then reopen console windows that depend on the changes. It is a good idea to immediately open a console window and execute a toolkit command in order to confirm that the PATH variable is properly defined.
-
-
-
-
- Removing the Toolkit
-
-
- To remove an existing version of the Qualcomm Atheros Open Powerline Toolkit from your system, follow the steps listed below. If the toolkit is not installed on your system then omit these steps. If you are unsure, you can follow them to determine if you have the toolkit installed or you can attempt to install, anyway, and return here if installation is prevented.
-
-
-
- Control Panel Add/Remove Dialogue
-
-
-
-
-
-
-
-
-
-
- On the Start menu, select the option.
-
-
-
-
- On the Adjust system settings page, select the Programs and Features icon.
-
-
-
-
- On the Uninstall or change a program page, scroll down and select the appropriate QCA entry then press the pushbutton. There may be several different QCA Open Powerline Toolkit entries so be sure to select the correct one.
-
-
-
-
-
diff --git a/docbook/install-windows-xp.xml b/docbook/install-windows-xp.xml
deleted file mode 100644
index 7cc4eab6..00000000
--- a/docbook/install-windows-xp.xml
+++ /dev/null
@@ -1,139 +0,0 @@
-
-
- Toolkit Installation on <productname>Windows XP</productname>
-
-
- The Windows version of the toolkit comes pre-compiled and ready to install and run using the Windows Installer. You may copy and distribute installation file plc-utils-x.x.x.msi. Users may then click on the installation file to install the package then discard it afterwards. The installation file permits remote installation over the network.
-
-
- The version of the Windows Installer used here needs Microsoft .NET Framework 1.1 to work correctly. Newer versions of the .NET Framework will not work. The .NET Framework must be installed before the toolkit is installed or the Windows Installer will report dependency errors and refuse to complete installation. Multiple versions of the .NET Framework can coexist under Windows 7. The .NET Framework needed is included in the toolkit support folder.
-
-
- Windows versions of toolkit programs that communicate with powerline devices all need WinPcap from winpcap.org to read and write Ethernet frames. WinPcap may be installed before or after toolkit installation but tools that access powerline devices will not run without it. You may want to install WinPcap before starting toolkit installation. If you have Wireshark installed then you probably already have WinPcap installed. A recent copy of WinPcap is included in the toolkit support folder.
-
-
- Failure to remove previous toolkit versions on some systems may result in the message "Another version of this product is already installed" when trying to install a new version. You may want to remove prior version before starting toolkit installation.
-
-
-
- Obtaining the Toolkit
-
-
- QCA customers can download the toolkit from the QCA Customer FTP Site.
-
-
- QCA employees may be able to download the toolkit from the QCA Application Engineering World FTP site ftp://appslinux01.qca.qualcomm.com/toolkit/plc-utils/. There are several installers available for Windows. Each installs a subset of the toolkit. Download the desired installer files to your local machine then execute them by right-clicking on them and selecting option "Run as Administrator".
-
-
-
-
- Installing the Toolkit
-
-
- Use a compression program like WinZip to decompress the archive file and extract all files. Use Microsoft Windows Explorer to locate file .\VisualStudioNET\plc-utils-x.x.x.msi under the main toolkit folder. Click on the file to start the Windows Installer then follow the installation instructions.
-
-
-
- Windows Installer Dialogue
-
-
-
-
-
-
-
-
- Older toolkit programs were installed in folder C:\Program Files\Atheros\Toolkit but they are now installed in folder C:\Program Files\Qualcomm Atheros\Open Powerline Toolkit instead. If you select a different folder, remember it for the next step.
-
-
-
-
- Setting the PATH variable
-
-
- Toolkit programs have command line interfaces and must be run from an open console window. To simplify program access and minimize the typing required, add the toolkit installation path mentioned above to the PATH environment variable by following steps listed below. If you have Administrator privileges then we recommend that you edit the system PATH variable; otherwise, you may need to create and/or edit a user PATH variable.
-
-
-
- Control Panel System Dialogue
-
-
-
-
-
-
-
-
-
-
- On the Start menu, select the Control Panel option.
-
-
-
-
- In the Control Panel window, select the System icon.
-
-
-
-
- On the System Properties dialog box, select the Advanced tab.
-
-
-
-
- On the Advanced tab, press the Environment Variables button.
-
-
-
-
- On the Environment Variables dialog box, scroll down the System variables list and select the Path variable then press the Edit button.
-
-
-
-
- On the Edit System Variable dialogue box, append the installation path to the Variable value field.
-
-
-
-
- Press the OK button.
-
-
-
-
-
-
- Removing the Toolkit
-
-
- To remove an existing version of the Qualcomm Atheros Open Powerline Toolkit from your system, follow the steps listed below. If the toolkit is not installed on your system then omit these steps. If you are unsure, you can follow them to determine if you have the toolkit installed or you can attempt to install, anyway, and return here if installation is prevented.
-
-
-
- Control Panel Add/Remove Dialogue
-
-
-
-
-
-
-
-
-
-
- On the Start menu, select the option.
-
-
-
-
- In the Control Panel window, select the icon.
-
-
-
-
- On the Add or Remove Programs dialog box, scroll down and select the Qualcomm Atheros entry then press the pushbutton.
-
-
-
-
-
diff --git a/docbook/install.xml b/docbook/install.xml
deleted file mode 100644
index 33db17a0..00000000
--- a/docbook/install.xml
+++ /dev/null
@@ -1,5 +0,0 @@
-&install-linux;
-&install-macosx;
-&install-windows-xp;
-&install-windows-7;
-
diff --git a/docbook/int64host.1.html b/docbook/int64host.1.html
deleted file mode 100644
index ac16e64c..00000000
--- a/docbook/int64host.1.html
+++ /dev/null
@@ -1,150 +0,0 @@
-
-
-
-
-
- int64host.1
-
-
-
-
-
-
-
-
-
-int64host(1) Qualcomm Atheros Open Powerline Toolkit int64host(1)
-
-NAME
- int64host - INT6400 Host Emulator
-
-SYNOPSIS
- int64host [options] -N file -P file -n file -p file
-
-DESCRIPTION
- The INT6400 Host Emulator waits for VS_HST_ACTION.IND messages from a local device and services them as described in the
- INT6400 Technical Reference Manual. It can be used to demonstrate or verify proper device/host interaction for flash-
- less devices. This program is not production grade and will stop dead - like a bug! - when things go wrong. Use the
- Qualcomm Atheros Embedded API for real-time, production-grade applications.
-
- Host emulation applies to flash-less device designs where a local host processor provides the persistent storage. The
- local host can provide a wide range of intelligent storage functions for a device but this program offers one. Options
- -N and -P name existing files that store the factory default runtime firmware and parameters, respectively. Options -n
- and -p name scratch files that will store user firmware and parameters, respectively. This is similiar to the standard
- Atheros NVRAM scheme but is not the same.
-
- To use the program, connect a flash-less device to the host via ethernet then start this program with the correct file‐
- names. The program will automatically respond to device requests to download memory configuration, firmware and/or
- parameters and upload firmware or and/or parameters under device control. See the Qualcomm Atheros Firmware Technical
- Reference Manual for more information.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -F[F] Flash NVRAM once downloaded firmware has started. The same firmware and PIB are downloaded, again, using
- VS_WR_MOD and written to NVRAM using VS_MOD_NVM. Adding a second F here or another -F anywhere on the command
- line will perform a forced flash. When no NVRAM is present, normal and force flash cause the device to upload to
- the host. When blank or corrupted NVRAM is present, forced flash writes to NVRAM. This operation will fail when
- no NVRAM is present.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -N filename
- Use this file to download firmware when requested by the local device. The file must exist and have a valid NVM
- file format or it will be rejected. No assumptions are made based on filename and no filename conventions are
- enforced. The program will not over-write this file. This option and argument are required.
-
- -n filename
- Use this file to store firmware uploaded from the local device. The file need not exist but an error will occur
- if it cannot be created or written. If firmware is uploaded to this file, it is used for subsequent firmware
- downloads unless the device requests a factory reset. In that case, the file specified by option -N is used.
- This option and argument are optional. If omitted then the default filename host.pib will be used.
-
- -P filename
- Use this file to download parameters when requested by the local device. The file must exist and have a valid PIB
- file format or it will be rejected. No assumptions are made based on filename and no filename conventions are
- enforced. The program will not over-write this file. This option and argument are required.
-
- -p filename
- Use this file to store parameters uploaded from the local device. The file need not exist but an error will occur
- if it cannot be created or written. Once parameters are uploaded to this file, it is used for subsequent parame‐
- ter downloads unless the device requests a factory reset. In that case, the file specified by option -P is used.
- This option and argument are optional. If omitted then the default filename host.nvm will be used.
-
- -q Suppress status messages on stderr.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -v Print additional information on stdout. In particular, this option will print incoming and outgoing Ethernet
- frames on stdout.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- None.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-EXAMPLES
- The following command starts the host emulator. The -N and -P options are always required. Their order is not impor‐
- tant.
-
- # int64host -N test.nvm -P test.pib -n temp.nvm -p temp.pib
- eth1 00:B0:52:00:00:01 Waiting for Host Action Requests
-
- eth1 00:B0:52:00:00:01 Waiting for Host Action
- eth1 00:B0:52:00:00:01 Host Action Request is (4) configure memory.
- eth1 00:B0:52:00:00:01 Write Memory (00000040:15752)
- eth1 00:B0:52:00:00:01 Wrote mac-release-X.nvm
- eth1 00:B0:52:00:00:01 Started BootLoader
-
- eth1 00:B0:52:00:00:01 Host Action Request is (0) initialize device.
- eth1 00:B0:52:00:00:01 Write Memory (00000040:15752)
- eth1 00:B0:52:00:00:01 Wrote mac-release-X.nvm
- eth1 00:B0:52:00:00:01 Started BootLoader
- eth1 00:B0:52:00:00:01 Write Memory (00204000:1013952)
- eth1 00:B0:52:00:00:01 Wrote mac-release-X.nvm
- eth1 00:B0:52:00:00:01 Write Memory (01F00000:11400)
- eth1 00:B0:52:00:00:01 Wrote AR7400-WallAdapter-HomePlugAV_NorthAmerica.pib
- eth1 00:B0:52:00:00:03 Started INT7400-MAC-0-0-1008-00-63-20100227-AUTO-D
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- plc(1), int64host(1), int6k(1), int6kboot(1) plchost(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int64host(1)
-
-int6k(1) Qualcomm Atheros Open Powerline Toolkit int6k(1)
-
-NAME
- int6k - Qualcomm Atheros INT6x00 Powerline Device Manager
-
-SYNOPSIS
- int6k [options] [device] [device] [...]
-
-DESCRIPTION
- This version of the Qualcomm Atheros Device Manager for Linux performs basic operations on Atheros INT6x00 devices using
- the raw Ethernet protocol described in the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual. It can be
- used to interrogate and control devices or upgrade firmware if on-board NVRAM is present.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. Is supports legacy chipsets INT6000, INT6300 and
- INT6400. See program amptool for AR7400 and AR7450 chipsets. See program plctool for QCA6410, QCA7000 and QCA7420
- chipsets. See the plc man page for an overview and installation instructions.
-
-OPTIONS
- -a Read device attributes using VS_OP_ATTRIBUTES. Attributes are short strings and integers that describe device
- hardware and firmware. They are concatenated to form the output that is similar to option -r but derived differ‐
- ently.
-
- -B action
- Press the simple connect pushbutton using VS_PB_ENC. The action can be specified by number 1, 2, 3 or 4 or by
- symbol "join", "leave", "status" or "reset", respectively. Use 1 on both devices that are expected to join. Use
- 2 only on the device that is expected to leave the network.
-
- -C module
- Commit (flash) downloaded modules to NVRAM using VS_MOD_NVM. The module can be spedified by number 1, 2 or 3 or
- by symbol "nvm", "pib" or "both", repectively. Module 3 is equivalent to option -F which writes the NVM and PIB
- together. You cannot force flash NVRAM using this option. Use option -FF to force flash.
-
- -d filename
- Read Watchdog Report from the device and write it to the named file in binary format using VS_WD_RPT. The report
- file can be sent to Qualcomm Atheros for technical analysis. No assumptions are made based on filename and no
- filename convetions are enforced; however, you should use a .log file extension to indicate binary format.
-
- -D xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx
- Define the 16 octet Device Access Key (DAK) in hex format. The DAK is used by option -J. It may also be set to
- "key1" or "key2" as explained in the KEYS section.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -f Read device NVRAM parameters using VS_GET_NVM. An error will be reported when no NVRAM is present. This option
- can be used to determine if NVRAM is large enough to store the runtime firmware and parameter block.
-
- -F[F] Write previously downloaded MAC and PIB to NVRAM using VS_MOD_NVM. Adding a second F here or another -F anywhere
- on the command line will force-flash a blank or corrupted NVRAM. Firmware loaded from NVRAM will treat force-
- flash as an error. This option can be used to create factory settings but cannot be used to change them once cre‐
- ated. Subsequent use creates and updates operational settings that can be erased using a factory reset. This
- option is executed after all others on the command line, except for the -R option.
-
- -g Read multicast group information discovered while IGMP snooping using VS_MULTICAST_INFO.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -I Read the device PIB header using VS_RD_MOD and print the firmware major revision number, PIB minor revision num‐
- ber, Device Access Key (DAK), Network Membership Key (NMK), MAC address and other information on stdout.
-
- -J xx:xx:xx:xx:xx:xx
- Set the Network Membership Key (NMK) on the remote device, specified by MAC, using VS_SET_KEY. This option is
- similar to option -K but requires the remote device MAC and DAK in addition to the NMK and local device MAC
- address. The NMK value is defined using option -K unless you want to use the default value. The remote DAK is
- defined using option -D unless you want to use the default value. Programming remote device keys is complicated.
- It is often easier to connect the device directly to the host and use the -K option.
-
- -K xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx
- Define the Network Membership Key (NMK) value used by options -M or -J. The symbolic names "key1" and "key2" are
- recognized as described in the KEY section.
-
- -l count
- Define the number of times that the command will be repeated for each device specified. Normally, you will repeat
- operations on one device only.
-
- -m Read network membership information using VS_NW_INFO. This can be used to determine network configuration.
-
- -M Set the Network Membership Key (NMK) on the local device using VS_SET_KEY. The NMK value is specified using the
- -K option unless you want to use the default value.
-
- -n filename
- Read firmware from the device SDRAM and write it to the named .nvm file using multiple VS_RD_MOD messages. No
- assumptions are made based on filename and no filename conventions are enforced. This option is performed before
- option -N when both are specified.
-
- -N filename
- Read the named .nvm file and write it to the device using multiple VS_WR_MOD messages. No assumptions are made
- based on filename and no filename conventions are enforced; however, files having invalid .nvm format will be
- rejected. This option is executed after -n when both are specified.
-
- -p filename
- Read parameters from the device SDRAM and write them to the named .pib file using multiple VS_RD_MOD messages. No
- assumptions are made based on filename and no filename convetions are enforced. This option is executed before
- option BP when both are specified.
-
- -P filename
- Read the named .pib file and write it to the device using multiple VS_WR_MOD messages. No assumptions are made
- based on filename and no filename conventions are enforced; however, files having invalid .pib format will be
- rejected. This option is executed after -p when both are specified.
-
- -q Suppresses status messages on stderr.
-
- -Q Quick flash. The program will not wait for a device to reset or the firmware to restart after writing flash mem‐
- ory. This option is desirable with newer firmware that writes flash memory in the background. It has no effect
- unless used with option -F or -C.
-
- -r Read device firmware and hardware revision using VS_SW_VER. Output is similar to option -a but is derived differ‐
- ently.
-
- -R Reset the device using VS_RS_DEV. This option is executed after all others on the same command line.
-
- -s Read device SDRAM configuration using VS_RD_CBLOCK.
-
- -S filename
- Read the named .cfg file and write it to the device using VS_SET_SDRAM. No assumptions are made based on filename
- and no filename conventions are enforced; however, files having an invalid .cfg file format will be rejected. Do
- not confuse .cfg files with .config files. See chkcfg and config2cfg for more information on SDRAM configuration
- file formats.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -T Restore factory defaults. This permanently erases all PIB changes made since the device was last programmed with
- factory default settings. The device will automatically reset and reboot.
-
- -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
- be saved as text files for reference.
-
- -w seconds
- Defines the number of seconds to wait before repeating command line options. This option has no effect unless
- option -l is also specified with a non-zero value.
-
- -x Cause the program to exit on the first error instead of continuing with remaining iterations, operations or
- devices. Normally, the program reports errors and moves on to the next operation, iteration or device depending
- on the command line.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The Ethernet hardware address of some powerline device. More than one address may be specified on the command
- line. If more than one address is specified then operations are performed on each device in turn. The default
- address is local. as explained in the DEVICES section.
-
-KEYS
- Passwords are variable length character strings that end-users can remember. Keys are fixed length binary values created
- by encrypting passwords. There are two encryption algorithms for HomePlugAV. One for DAKs and the other for NMKs. This
- means that a given password will produce different keys depending on use. This program only deals with keys because that
- is what powerline devices recognize. The passwords that generated the keys are irrelevant here.
-
- Encryption keys are tedious to type and prone to error. For convenience, symbolic names have been assigned to common
- encryption keys and are recognized by options -D and -K.
-
- key1 Key for encrypted password "HomePlugAV". This is "689F074B8B0275A2710B0B5779AD1630" for option -D and
- "50D3E4933F855B7040784DF815AA8DB7" for option -K.
-
- key2 Key for encrypted password "HomePlugAV0123". This is "F084B4E8F6069FF1300C9BDB812367FF" for option -D and
- "B59319D7E8157BA001B018669CCEE30D" for option -K.
-
- none Always "00000000000000000000000000000000".
-
-DEVICES
- Powerline devices use Ethernet hardware, or Media Access Control (MAC), addresses. Device addresses are 12 hexadecimal
- digits (0123456789ABCDEFabcdef) in upper, lower or mixed case. Individual octets may be separated by colons, for clar‐
- ity, but not all octets need to be seperated. For example, "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are
- valid and equivalent.
-
- These symbolic addresses are recognized by this program and may be used instead of the actual address value.
-
- all Equivalent to "broadcast", described next.
-
- broadcast
- The Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign will respond to
- this address.
-
- local The Atheros Local Management Address (LMA), 00:B0:52:00:00:01. Local Atheros powerline devices recognize this
- address but remote and foreign powerline devices do not. A remote device is any poserline device at the far end
- of the powerline. A foreign device is a powerline device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure or content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- # int6k -n old.nvm -p old.pib -N new.nvm -P new.pib -F 01:23:45:67:89:AB
-
- Performs 5 operations on one device. Uploads the firmware and PIB from the device and writes them to files old.nvm and
- old.pib, respectively. Reads files new.nvm and new.pib and downloads them as new firmware and PIB, respectively. Com‐
- mits the downloaded firmware and PIB to NVRAM. Operations are executed in the order just described regardless of the
- order specified on the command line. If you want reading and writing to occur in a different order then you must use two
- or more commands to accomplish tasks in the order you want.
-
- # int6k -N new.nvm 01:23:45:67:89:28
- # int6k -P new.pib 01:23:45:67:89:28
- # int6k -C 3 01:23:45:67:89:28
-
- It is not neccessary to specify all operations on one command line. The three command lines above do essentially the
- same thing as the command line shown in the previou example. Notice that this example uses -C 3, instead of -F, as an
- alternate way to write MAC and PIB to NVRAM. Specifying -C 1, instead, would write the .nvm file only. Specifying, -C
- 2, instead, would write the .pib file only. The value 3 is the logical OR of 1 and 2.
-
- # int6k -N new.nvm -P new.pib -FF local
-
- Downloads file new.nvm and file new.pib and force flashes the local device. Force flashing only works on running
- firmware that has been downloaded and stated by the Qualcomm Atheros Boot Loader. See int6kf to download, start firmware
- and perform a force flash in one operation.
-
- # int6k -MK key1
- # int6k -M
-
- These two commands are equivalent. They set the NMK on the local device to key1 as descripted in the KEYS section. The
- first command resets the NMK on the local device with -M then specifies the NMK as key1. The second command omits the
- key specification since key1 is the program default NMK. One could, of course, type the encryption key.
-
-SEE ALSO
- plc(1), amptool(1), int6kf(1), int6khost(1), int6kid(1), int6krate(1), int6krule(1), int6kstat(1), int6kwait(1),
- plctool(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6k(1)
-
-int6kbaud(1) Qualcomm Atheros Open Powerline Toolkit int6kbaud(1)
-
-NAME
- int6kbaud - Qualcomm Atheros Serial Line Device Configuration
-
-SYNOPSIS
- int6kbaud [options] [...]
-
-DESCRIPTION
- Set serial line parameters on a UART-enabled Atheros powerline device using the ATBR serial line command.
-
- Serial line commands are 7-bit ASCII character strings sent to the local powerline device over the host serial port.
- They can be sent using any terminal emulator but this program will, in many cases, reduce typing and simplify scripting.
- It is especially useful for downloading device parameters and uploading device parameters or firmware because those oper‐
- ations involve large volumes of data. Also, this program permits decimal integer arguments in many cases where the
- serial line commands require hexadecimal integer values. See the COMMANDS section below for a list of supported serial
- line commands;
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-COMMENTS
- This program does not configure or reconfigure host serial port settings since most systems provide a utility to do that.
- Be sure to configure them before using this program since other programs may change them before or after use. Atheros
- factory default settings for UART-enabled powerline devices are 1115200 baud, 8 data bits, 1 stop bit, no parity and no
- flow control.
-
- On Linux, use the stty utility to inspect and set serial port parameters. The following Linux command will configure
- serial device /dev/ttyS0 speed to 115200 baud with 8 data bits, 1 stop bit, no parity bit and no flow control. Consult
- the stty man page for an explanation of these and other options.
-
- #stty -f /dev/ttyS0 115200 cs8 cstopb -cparenb -ixon
-
- On Windows, use the the Device Manager dialog to set serial Port properties. To open this dialog, select Start Menu,
- Control Panel, System, Hardware, Device Manager, Ports, Advanced.
-
-OPTIONS
- -B baudrate
- The new baud rate. Any integer value may be entered here but only certain values may be accepted by the powerline
- device. Although the device may support some value, the local host may not support it. Supported values are 300,
- 600, 1200, 2400, 4800, 9600, 38400, 57600, 115200, 230400, 460800 and 921600. The default is 115200.
-
- -D databits
- The number of bits per data byte. Accepted values are 7 and 8. The default is 8.
-
- -F flowctrl
- The hardware flowcontrol state. Accepted values are 0=off and 1=on where numeric values or keywords "off" or "on"
- may be used. Keyword "none" is synonymous with "off" for this option. The default is none.
-
- -m mode
- Accepted values are 1=transparent and 2=command where numeric values or keywords "transparent" or "command" may be
- used.
-
- -P parity
- The number of parity bits and parity mode. Accepted values are 0=none, 1=odd and 2=even where numeric values of
- keywords "none", "odd" or "even" may be used. The default is none.
-
- -q Suppress progress and error information on stderr.
-
- -s tty Communicate with the local powerline device over the named serial interface on the local host. The program
- default is "/dev/ttyUSB0" for Linux and "com1:" for Windows. The program default may be replace by defining envi‐
- ronment variable PLCUART. This command line option will over-ride those defaults.
-
- -S stopbits
- The number of stop bits. Accepted values are 1 or 2. The default is 1.
-
- -u Force default host port settings to match the default setting for UART-enabled Atheros powerline devices. The
- setting are 115200 baud, 8 data bits, no parity bits and 1 stop bit. These settings will remain active when the
- program terminates and will not change unless changed by some other means, perhaps by another application. This
- option is an easy means of establishg an initial serial connection with a powerline device, unless it's settings
- have been changed.
-
- -v Display serial line commands and responses on stdout.
-
- -w Place the local powerline device in Command Mode using the +++ serial line command. The device will remain in com‐
- mand mode until it is reset or forced into Transparaent Mode or High Speed Command Mode.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- None.
-
-COMMANDS
- This section lists serial line commands recognized by local powerline devices when in Command Mode. Commands can be
- issued interactively using a terminal emulator, like minicom on Linux or HyperTerminal on Windows or stored as text and
- copied to the serial port using system utilities, like cat on Linux or type on Windows. This program merely converts com‐
- mand line options and arguments into one or more of the serial line commands shown below.
-
- +++ Exit Transparent Mode and enter Command Mode. See option -w above.
-
- AT Test for Command Mode by doing nothing, successfully. See option -t above.
-
- ATBRmode,baudrate,databits,parity,stopbits,flowctrl
- Set serial line parameters on the local powerline device. Beware that this will break the existing serial connec‐
- tion when the new parameters differ from those of the local host.
-
- ATBSZ? Get Transparent Mode buffer size. See option -z above.
-
- ATBSZsize
- Set Transparent Mode buffer size. See option -Z above.
-
- ATDST? Get Transparent Mode destination device address. See option -d above.
-
- ATDSTaddress
- Set Transparent Mode destination device address. See option -D above.
-
- ATFD Reset local device to factory defaults. See option -T above.
-
- ATHSC Exit Command Mode and enter High Speed Command Mode. Once the OK response is received, the local host should send
- commands to the device at successively higher speeds until a valid response is received.
-
- ATNI? Read nework information and store the information internally. Return the number of associated stations and infor‐
- mation about the first associated station. The information includes the peer station device address, TX rate and
- RX rate.
-
- ATNIstation
- Extract and display previously stored network information for a specific peer station. The information returned is
- that previosly stored using a ATNI serial line command query.
-
- ATO Exit Command Mode and enter Transparent Mode. Successful switch requires a valid destination MAC address, buffer
- size and aggregation timeout value. Use serial line commands ATDST and ATBSZ to get and/or set the first two val‐
- ues. Use serial line command ATTO to set the timeout value.
-
- ATPStime
- Place the device in Power Save Mode for a specified time in seconds. Accepted values are 1 to 384 seconds. The
- default time is A seconds.
-
- ATRPlength,offset
- Read and display a parameter block segment where length is the number of bytes read and offset is the relative
- position, in bytes, from the start of the parameter block. Valid length values are 0 through 400 hexadecimal. See
- option -p above to read and save an entire parameter block.
-
- ATRPM Get PIB version and device MAC address.
-
- ATRV Get hardware and firmware revision. See option -r above.
-
- ATSK? Get device Network Membership Key. See option -m above.
-
- ATSKkey
- Set device Network Membership Key. See option -M above.
-
- ATTO? Get the Transparent Mode aggregation timeout in milliseconds.
-
- ATTOtimeout
- Set the Transparent Mode aggregation timeout in milliseconds. See option -W above.
-
- ATWNVmodule
- Update NVM with PIB and/or Firmware module. See option -C above.
-
- ATWPFmodule,length,offset,checksum,data
- Write a parameter block or firmware segment to the local powerline device where module is the module identifier,
- length is the number of bytes to write, offset is the relative position from the start of the module, checksum is
- the 1's complement of the data and data is the data to be written. Valid module identifiers are 1=FW and 2=PIB.
- Valid length values are 0 up to 400 hexadecimal. See options -N and -P above to write an entire parameter block
- or firmware images.
-
- ATZ Reset device. See option -R above.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros serial line commands are proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information is not
- available. Qualcomm Atheros reserves the right to modify command line syntax or command functionality in future firmware
- releases without any obligation to notify or compensate product or program users.
-
-EXAMPLES
- The following example sets the baud speed to 115200 baud with 8 data bits, 1 stop bits, no flow control and no parity.
- The outgoing serial line command and incoming response are displayed on stderr because option -f is present.
-
- #int6kbaud -B 115200 -D 8 -F 0 -P 0 -S 1 -v
- ATBR00,000000000001C200,08,00,01,00
- OK
-
- Observe that decimal command line arguments are converted to hexadecimal on output. Although this program outputs fixed-
- length fields, including leaing zeros, device firmware ignores them. Leading zeros may be omitted when entering serial
- line commands manually.
-
- The next example set the speed to 38400. Observe that program default values appear in the outgoing serial line command
- when the corresponding command line options are omitted.
-
- #int6kbaud -B 38400 -v
- ATBR00,0000000000009600,08,00,01,00
- OK
-
- The next command does the same thing as the first example except that keywords replace numeric values for some of the
- options. Since option -v is omitted the outgoing command and incoming response are not displayed.
- #int6kbaud -B 115200 -D 8 -F off -P none -S 1
-
-SEE ALSO
- amp(1), int6kuart(1), ttysig(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6kbaud(1)
-
-int6kboot(1) Qualcomm Atheros Open Powerline Toolkit int6kboot(1)
-
-NAME
- int6kboot - Qualcomm Atheros Powerline Device Boot Utility I
-
-SYNOPSIS
- int6kboot [options] -N file -P file [device] [device] [...]
-
-DESCRIPTION
- Download and start runtime firmware on any local Atheros powerline device that is in bootloader mode. A device remains
- in bootloader mode when it cannot load firmware from flash memory for some reason. This can happen because there is no
- flash memory or because the flash memory is blank or corrupted. This program can start a device or start then flash a
- device.
-
- The bootloader only recognizes a subset of Atheros message types. This program uses that subset to write runtime
- firmware and parameters into SDRAM then start firmware execution at a known address. Optionally, this program can then
- proceed to download the same firmware and parameters, again, and instruct the runtime firmware to write them to flash
- memory.
-
- Starting a device is a three phase operation that can only be performed when the bootloader is running. The first phase
- writes an SDRAM configuration program into TCM and executes it. The second phase writes runtime firmware and parameters
- as images into SDRAM. The third phase starts firmware execution. Once the runtime firmware starts, the device will be
- operational.
-
- Flashing a device is a two phase operation that can only be performed when the firmware is running. The first phase
- downloads runtime firmare and parameters into scratch buffers under firmware control. The second phase instructs the
- firmware to write the scratch buffers to flash memory and restart the device. After flashing, the device will be self-
- sustaining.
-
- Since the device address is 00:B0:52:00:00:01 on boot, the host must send all messages to that address. This can cause
- problems if multiple devices are connected to the host and in Bootloader mode. The devices will have the same firmware
- and MAC address because their PIBs will be identical. One should avoid this situation.
-
- Is probably alright to have other device connected to the host that are running firmware because they will still see but
- not recognize the messages used in this operation. If only one device is connected to the host, then is save to flash
- the device using address 00:B0:52:00:00:01. Otherwise, the host should address messages to the actual device address so
- that other devices do not attempt to write to their own flash memory at the same time.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -F[F] Write previously downloaded MAC and PIB to NVRAM using VS_MOD_NVM. Adding a second F here or another -F anywhere
- on the command line will force-flash a blank or corrupted NVRAM. Firmware loaded from NVRAM will treat force-
- flash as an error. This option can be used to create factory settings but cannot be used to change them once cre‐
- ated. Subsequent use creates and updates operational settings that can be erased using a factory reset.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -N filename
- Read the named NVM file and write it to the device. This option and argument are required. Any file having an
- invalid NVM file format will be rejected. No assumptions are made based on filename and no filename conventions
- are enforced.
-
- -P filename
- Read the named PIB file and write it to the device. This option and argument are required. Any file having an
- invalid PIB file format will be rejected. No assumptions are made based on filename and no filename conventions
- are enforced.
-
- -q Suppresses status messages on stderr.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The Ethernet hardware address of some powerline device. More than one address may be specified on the command
- line. If more than one address is specified then operations are performed on each device in turn. The default
- address is local. as explained in the DEVICES section.
-
-DEVICES
- Powerline device addresses are 12 hexadecimal digits in upper, lower or mixed case. Individual octets may be separated
- by colons, for clarity, but colons are not required. For example, "00b052000001", "00:b0:52:00:00:01" and
- "00b052:000001" are valid and equivalent.
-
- A local device is any Atheros Powerline Device connected directly to a host Ethernet interface. A remote device is any
- Atheros Powerline Device at the far end of a powerline connection. A foreign device is any powerline device not manufac‐
- tured by Atheros.
-
- Common device addresses have symbolic names that can be used in place of the actual address value. The following sym‐
- bolic addresses are recognized by this program and most other toolkit programs.
-
- all Equivalent to "broadcast", described next.
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- will respond to this address.
-
- local A synonym for the Qualcomm Atheros Local Management Address (LMA), 00:B0:52:00:00:01. All local Atheros devices
- will respond to this address but remote and foreign devices will not.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for technical information. See the Qualcomm
- Atheros Powerline Toolkit Online Documetation for practical information and examples.
-
-EXAMPLES
- The -N and -P options are always required. Their order is not important. Tne MAC address is not needed because devices
- default to address 00:B0:52:00:00:01 (the program default address) in bootloader mode. Once this operation completes,
- firmware is running in SDRAM but the NVRAM, if present, has not been programmed. This operation is common for flash-less
- devices. If we reset the device at this point then the device will return to bootloader mode.
-
- int6kboot -N test.nvm -P test.pib
- # eth0 00:B0:52:00:00:01 Write SDRAM Configuration
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Write to device memory
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Write to device memory
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Start Firmware
- # eth0 00:B0:52:00:00:01 Started.
-
- The next example does the same thing but performs the extra steps needed to program NVRAM. It first downloads the
- firmware image from file test.nvm and the parameter block image from file test.pib using VS_WR_MEM then starts firmware
- execution using VS_ST_MAC. Once runtime firmware has started, it downloads the same firmware image and parameter block
- image (again) using VS_WR_MOD and commits them to NVRAM using VS_MOD_NVM.
-
- int6kboot -N test.nvm -P test.pib -F
- # eth0 00:B0:52:00:00:01 Write SDRAM Configuration
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Write to device memory
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Write to device memory
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Start Firmware
- # eth0 00:B0:52:00:00:01 Started.
- # eth0 00:B0:52:00:00:01 Write MAC as module
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Write PIB as module
- # eth0 00:B0:52:00:00:01 Written.
- # eth0 00:B0:52:00:00:01 Flash Device
- # eth0 00:B0:52:00:00:01 Flashed.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-SEE ALSO
- plc(1), ampboot(1), chknvm(1), chkpib(1), int6k(1), modpib(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6kboot(1)
-
-int6kdetect(1) Qualcomm Atheros Open Powerline Toolkit int6kdetect(1)
-
-NAME
- int6kdetect - Qualcomm Atheros UART Device Detector
-
-SYNOPSIS
- int6kdetect [options] [...]
-
-DESCRIPTION
- None.
-
-COMMENTS
- None.
-
-OPTIONS
- -c Assume device is in command mode. This reduces the amount of time needed to detect serial device settings.
-
- -l tty Communicate with the local powerline device over the named serial interface on the local host. The program
- default is "/dev/ttyUSB0" for Linux and "com1:" for Windows. The program default is replaced if environment vari‐
- able PLCUART is defined. This option over-rides those default settings.
-
- -q Suppress progress and error information on stderr.
-
- -v Display actual serial line commands and responses on stdout.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- None.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Qualcomm Atheros serial line commands are proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public informa‐
- tion is not available. Qualcomm Atheros reserves the right to modify command line syntax or command functionality in
- future firmware releases without any obligation to notify or compensate product or program users.
-
-EXAMPLES
- None.
-
-SEE ALSO
- amp(1), int6kbaud(1), int6kuart(1), ttysig(1)
-
-CREDITS
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6kdetect(1)
-
-int6keth(1) Qualcomm Atheros Open Powerline Toolkit int6keth(1)
-
-NAME
- int6keth - Qualcomm Atheros Ethernet PHY Settings
-
-SYNOPSIS
- int6keth [options] [device] [device] [...]
-
-DESCRIPTION
- Read or write INT6x00 Ethernet PHY Settings using VS_ENET_SETTINGS.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -a mode
- Advertise auto-negotiate capabilities. This option takes effect when option -w is present. It is ignored when
- option -r is present. Valid values are "1000Full", "100Full", "100Half", "10Full" and "10Half". The default
- value is no advertisement of capabilities.
-
- -d mode
- Device duplex transmission mode. This option takes effect when option -w is present. It is ignored when option
- -r is present. Valid values are "Half" and "Full". The default value is "Half".
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -f control
- Flow control enable. This option takes effect when option -w is present. It is ignored when option -r is
- present. Valid values are "On", "Off", "Tx" and "Rx". The default value is "Off".
-
- -n mode
- Auto-negotiate mode. This option takes effect when option -w is present. It is ignored when option -r is
- present. Valid values are "On" and "Off". The default value is "On".
-
- -p number
- The ethernet port number. Available port numbers differ with chipset and firmware version so consult the appro‐
- priate technical documentation. Permitted values are 0 through 7. The default port is 0.
-
- -s speed
- Network transmission speed in mbps. This option takes effect when option -w is present. It is ignored when
- option -r is present. Valid values are "10", "100" and "1000". The default value is "10".
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -q Suppresses status messages on stderr.
-
- -r Read settings from the Ethernet interface on the designated port. If present, or implied by default, then options
- -a, -d, -f, -n and -s have no effect. This option and option -w are mutually exclusive.
-
- -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
- be saved as text files for reference.
-
- -w Write settings to the Ethernet interface on the specified port. Be sure to specify all settings to avoid writing
- default values. This option and option -r are mutually exclusive.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified on the command line. If more
- than one address is specified then operations are performed on each device in turn. The default address is local.
- See DEVICES for information.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information is not available. Qualcomm Atheros reserves the right to modify message structure
- or content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- None.
-
-SEE ALSO
- plc(1) int6kid(1), int6krule(1), int6kstat(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6keth(1)
-
-int6kf(1) Qualcomm Atheros Open Powerline Toolkit int6kf(1)
-
-NAME
- int6kf - INT6300 Flash Utility for Linux
-
-SYNOPSIS
- int6kf [options] -C file -N file -P file
-
-DESCRIPTION
- This program is deprecated. Use int6kboot when downloading firmware 3.3.4 or later on INT6300 devices or later.
-
- Download and start runtime firmware on a local Atheros powerline device that is in bootloader mode. A device stays in
- bootloader mode when it cannot load firmware from NVRAM. That can happen because there is no NVRAM or because the NVRAM
- is blank or corrupted. The bootloader only understands a subset of Atheros message types and cannot flash NVRAM. This
- program uses that subset to download runtime firmware and start execution. Optionally, it will proceed to flash NVRAM
- after the firmware has started.
-
- Booting a device is a two part operation. The first part downloads SDRAM configuration parameters then download runtime
- firmware and parameters into SDRAM and starts the firmware. The second part downloads runtime firmare and parameters
- (again) into scratch buffers and instructs the firmware to write them into to NVRAM. This program can perform the first
- part alone or the first then the second part but not the second part alone. The second part can be performed alone using
- program int6k.
-
- This program is part of the Atheros Powerline Toolkit. See the AMP man page for compilation and installation instruc‐
- tions.
-
-OPTIONS
- -a Wait until device sends a VS_HOST_ACTION.IND before downloading SDRAM configuration, firmware and PIB.
-
- -C filename
- Read the named SDRAM configuration file and write it to the device. This option and argument are required. Any
- file having an invalid SDRAM configuration file format will be rejected. No assumptions are made based on file‐
- name and no filename conventions are enforced.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -F[F] Write previously downloaded MAC and PIB to NVRAM using VS_MOD_NVM. Adding a second F here or another -F anywhere
- on the command line will force-flash a blank or corrupted NVRAM. Firmware loaded from NVRAM will treat force-
- flash as an error. This option can be used to create factory settings but cannot be used to change them once cre‐
- ated. Subsequent use creates and updates operational settings that can be erased using a factory reset. This
- option is executed after all others on the command line, except for the -R option.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this interface and only reponses received via this
- interface are recognized. The default interface is eth1 because most people use eth0 as their principle network
- connection; however, if environment string "PLC" is defined then it takes precedence over the default interface.
- This option then takes precedence over either default.
-
- -N filename
- Read the named NVM file and write it to the device. This option and argument are required. Any file having an
- invalid NVM file format will be rejected. No assumptions are made based on filename and no filename conventions
- are enforced.
-
- -P filename
- Read the named PIB file and write it to the device. This option and argument are required. Any file having an
- invalid PIB file format will be rejected. No assumptions are made based on filename and no filename conventions
- are enforced.
-
- -q Suppresses status messages on stderr.
-
- -t timer
- Read timeout or capture period in milliseconds. Values range from 0 through UINT_MAX. This value has different
- effects on Linux and Windows. On Linux, where native raw sockets are used, this is the maximum time allowed for a
- response and so larger values should not affect performance. On Windows, where WinPcap is used, this is the time
- allotted for packet capture and so larger values will certainly affect performance. The default is shown in
- brackets on the program menu.
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- None.
-
-REFERENCES
- See the Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-EXAMPLES
- The -C, -N and -P options are always required. Their order is not important. Notice that no MAC address is needed
- because devices use address 00:B0:52:00:00:01, the program default address, when in bootloader mode.
-
- int6kf -C test.cfg -N test.nvm -P test.pib
- > eth0 00:B0:52:00:00:01 Write SDRAM Configuration
- > eth0 00:B0:52:00:00:01 Written.
- > eth0 00:B0:52:00:00:01 Write to device memory
- > eth0 00:B0:52:00:00:01 Written.
- > eth0 00:B0:52:00:00:01 Write to device memory
- > eth0 00:B0:52:00:00:01 Written.
- > eth0 00:B0:52:00:00:01 Start Firmware
- > eth0 00:B0:52:00:00:01 Started.
-
- Downloads SDRAM configuration file test.cfg with VS_SET_SDRAM then firmware from file test.nvm with VS_WR_MEM then PIB
- from file test.pib then starts firmware execution with VS_ST_MAC. This operation is common on flash-less systems.
-
- int6kf -C test.cfg -N test.nvm -P test.pib -F
- > eth0 00:B0:52:00:00:01 Write SDRAM Configuration
- > eth0 00:B0:52:00:00:01 Written.
- > eth0 00:B0:52:00:00:01 Write to device memory
- > eth0 00:B0:52:00:00:01 Written.
- > eth0 00:B0:52:00:00:01 Write to device memory
- > eth0 00:B0:52:00:00:01 Written.
- > eth0 00:B0:52:00:00:01 Start Firmware
- > eth0 00:B0:52:00:00:01 Started.
- > eth0 00:B0:52:00:00:01 Write MAC as module
- > eth0 00:B0:52:00:00:01 Written.
- > eth0 00:B0:52:00:00:01 Write PIB as module
- > eth0 00:B0:52:00:00:01 Written.
- > eth0 00:B0:52:00:00:01 Flash Device
- > eth0 00:B0:52:00:00:01 Flashed.
-
- Perform the same actions as before with some extra steps. After starting firmware execution, the same firmware and PIB
- are downloaded again, using VS_WR_MOD instead of VS_WR_MEM, and written to NVRAM using VS_MOD_NVM with force. The force
- option is only recognized by firmware that has been started by the bootloader and will fail when no flash memory is
- present.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Atheros Communica‐
- tions, Ocala FL USA. Consequently, public information may not be available. Atheros Communications reserves the right
- to modify message structure and content in future firmware releases without any obligation to notify or compensate users
- of this program.
-
-SEE ALSO
- AMP(1), int6k(1), int6kid(1), int6krate(1), int6kwait(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6kf(1)
-
-int6khost(1) Qualcomm Atheros Open Powerline Toolkit int6khost(1)
-
-NAME
- int6khost - INT6300 Host Emulator
-
-SYNOPSIS
- int6khost [options] -C file -N file -P file -n file -p file
-
-DESCRIPTION
- The INT6300 Host Emulator waits for VS_HST_ACTION.IND messages from a local device and services them as described in the
- INT6300 Technical Reference Manual. It can be used to demonstrate or verify proper device/host interaction for flash-
- less devices. This program is not production grade and will stop dead - like a bug! - when things go wrong. Use the
- Qualcomm Atheros Embedded API for real-time, production-grade applications.
-
- Host emulation applies to flash-less device designs where a local host processor provides the persistent storage. The
- local host can provide a wide range of intelligent storage functions for a device but this program offers one. Options
- -C, -N and -P name existing files that store factory default memory configuration, runtime firmware and parameters,
- respectively. Options -n and -p name scratch files that will store user firmware and parameters, respectively.This is
- similiar to the standard Atheros NVRAM scheme but still different.
-
- To use the program, connect a flash-less device to the host via ethernet then start this program with the correct file‐
- names. The program will automatically respond to device requests to download memory configuration, firmware and/or
- parameters and upload firmware or and/or parameters under device control. See the Qualcomm Atheros Firmware Technical
- Reference Manual for more information.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -C filename
- Use this file to download memory configuration when requested by the local device. The file must exist and have a
- valid configuration file format or it will be rejected. No assumptions are made based on filename and no filename
- conventions are enforced. The program will not over-write this file. This option and argument are required.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -F[F] Flash NVRAM once downloaded firmware has started. The same firmware and PIB are downloaded, again, using
- VS_WR_MOD and written to NVRAM using VS_MOD_NVM. Adding a second F here or another -F anywhere on the command
- line will perform a forced flash. When no NVRAM is present, normal and force flash cause the device to upload to
- the host. When blank or corrupted NVRAM is present, forced flash writes to NVRAM. This operation will fail when
- no NVRAM is present.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -N filename
- Use this file to download firmware when requested by the local device. The file must exist and have a valid NVM
- file format or it will be rejected. No assumptions are made based on filename and no filename conventions are
- enforced. The program will not over-write this file. This option and argument are required.
-
- -n filename
- Use this file to store firmware uploaded from the local device. The file need not exist but an error will occur
- if it cannot be created or written. If firmware is uploaded to this file, it is used for subsequent firmware
- downloads unless the device requests a factory reset. In that case, the file specified by option -N is used.
- This option and argument are optional. If omitted then the default filename host.pib will be used.
-
- -P filename
- Use this file to download parameters when requested by the local device. The file must exist and have a valid PIB
- file format or it will be rejected. No assumptions are made based on filename and no filename conventions are
- enforced. The program will not over-write this file. This option and argument are required.
-
- -p filename
- Use this file to store parameters uploaded from the local device. The file need not exist but an error will occur
- if it cannot be created or written. Once parameters are uploaded to this file, it is used for subsequent parame‐
- ter downloads unless the device requests a factory reset. In that case, the file specified by option -P is used.
- This option and argument are optional. If omitted then the default filename host.nvm will be used.
-
- -q Suppress status messages on stderr.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -v Print additional information on stdout. In particular, this option will print incoming and outgoing Ethernet
- frames on stdout.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- None.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-EXAMPLES
- The following command starts the host emulator. The -C, -N and -P options are always required. Their order is not
- important.
-
- int6khost -C test.cfg -N test.nvm -P test.pib
- > eth0 00:B0:52:00:00:01 Waiting for Host Action Requests
- >
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- plc(1), int64host(1), int6k(1), int6kboot(1) plchost(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6khost(1)
-
-int6kid(1) Qualcomm Atheros Open Powerline Toolkit int6kid(1)
-
-NAME
- int6kid - Echo Device Key
-
-SYNOPSIS
- int6kid [options] [device] [device] [ ... ]
-
-DESCRIPTION
- This program prints a single powerline device key or HFID on stdout. It can be used to dynamically define environment
- variables or insert command line arguments in scripts at runtime. It is intended to echo a specific key read from a sin‐
- gle device but it can be used to echo a specific key type read from several devices by specifying either the Qualcomm
- Atheros Local Management Address or a broadcast address.
-
- This program is, in some sense, the inverse of modpib but it reads the key and HFID directly from the powerline device
- instead of reading from a PIB file.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -A Prints the Ethernet address (MAC) for each specified device. This option and options -D, -M, -N, -S and -U are
- mutually exclusive.
-
- -D Prints the Device Access Key (DAK) for each specified device. This option and options -A, -M, -N, -S and -U are
- mutually exclusive.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -n Append a newline to the end of each key. Newlines are omitted by default so that program output can be used as
- the raw input to another program. If you want the newline then you must request it with this option.
-
- -M Prints the Network Membership Key (NMK) for each specified device. This option and options -A, -D, -N, -S and -U
- are mutually exclusive.
-
- -N Prints the network HFID string for each specified device. This option and options -A, -D, -M, -S and -U are mutu‐
- ally exclusive.
-
- -q Suppresses status messages on stderr.
-
- -S Prints the manufacturer HFID string for each specified device. This option and options -A, -D, -M, -N and -U are
- mutually exclusive.
-
- -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
- be saved as text files for reference.
-
- -x Cause the program to exit on the first error instead of continuing with remaining iterations, operations or
- devices. Normally, the program reports errors and moves on to the next operation, iteration or device depending
- on the command line.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-EXAMPLES
- The following example prints the DAK of the local device on stdout. The local device is interrogated because no MAC
- address was specified. The default interface, eth1 on Linux and 2 on Windows, is used unless environment variable PLC is
- defined. The DAK is always printed by default. Depending on your system, you may want to use option -n when using this
- program interactively.
-
- # int6kid
- 00:11:22:33:44:55:66:77:88:99:AA:DD:CC:DD:EE:FF
-
- The following example prints the NMK of device 00:B0:52:DA:DA:57 connected to interface eth2 on a Linux system. Several
- devices could be specified but that is not a common request.
-
- # DAK -Mi eth2 00:B0:52:DA:DA:57
- F4:23:71:4A:51:39:C2:2D:E5:EA:87:43:99:A1:37:81
-
- The following example dynamically inserts the DAK and NMK of the previous device on the command line of another program.
- In this example, we want to insert the DAK and NMK into PIB file abc.pib using program modpib. See the modpib man page
- for an explanation of command line syntax. See the GNU bash manuals for an explanation of why this works.
-
- # modpib abc.pib -D $(int6kid -Di eth2 00:B0:52:DA:DA:57) -N $(int6kid -Mi eth2 00:B0:52:DA:DA:57)
-
- The following example is an alternate way of accomplishing the same thing using shell script variables. This method may
- be easier to read and maintain. Notice that we 'squished' all the options together for brevity.
-
- # PLC=00:B0:52:DA:DA:57
- # DAK=$(int6kid -Dieth2 ${PLC})
- # NMK=$(int6kid -Mieth2 ${PLC})
- # modpib abc.pib -D ${DAK} -N ${NMK}
-
-SEE ALSO
- plc(1), int6k(1), int6kf(1), int6kp(1), modpib(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6kid(1)
-
-int6klist(1) Qualcomm Atheros Open Powerline Toolkit int6klist(1)
-
-NAME
- int6klist - List Atheros Device Addresses
-
-SYNOPSIS
- int6klist [options] [device] [device] [...]
-
-DESCRIPTION
- print the local device address or all network device addresses for a specific device. This program is ideal for that
- special script jokey in your life. It only prints device addresses. Nothing else.
-
- Devices are detected using one of two methods. The two methods can be used in combination to determine network topology.
-
- The first method sends one VS_SW_VER message to the Qualcomm Atheros Local Management Address and prints the Ethernet
- source address found in each received confirmation message. The method is used when no device addresses appear on the
- command line. The result is a list of all local devices, being this connected directly to the local host. Each local
- device device may bridge to an independent powerline network having remote devices as members.
-
- The second method sends one VS_NW_INFO message to each specified device and prints the Ethernet source address found in
- each received message plus the Ethernet addresses of each network station identified in that message body. This method
- is used whenever one, or more, device addresses appear on the command line. It is possible to query remote powerline
- devices directly and so duplicate devices addresses are printed when devices share powerline neighbors.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -b Print bridge device addresses. Each specified device reports it's own address. This option has no effect if no
- devices are specified.
-
- -i Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -n Append a newline to output.
-
- -q Enter quiet mode. This option has no effect at this time.
-
- -r Print remote device addresses. Each specified device reports neighbor device addresses. This option has no effect
- when no devices are speceified.
-
- -s Insert a newline, instead of a space, between each device address.
-
- -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If omitted the the program out‐
- put consists of local device addresses only. Otherwise, output conisists of the specified device followed by all
- devices associated with it. The default address is local. See DEVICES for information about symbolic device
- addresses.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at the
- far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-EXAMPLES
- The following command lists all local devices because no device was specified. Because no devices are specified on the
- command line, a VS_SW_VER message is sent to 00:B0:52:00:00:01 and device responses are collected. As we can see, there
- is only one local device available at this time. Observe that the prompt appears immediately after the address because
- newlines are omitted by default.
-
- # int6klist
- 00:B0:52:BE:EF:04 #
-
- The next examples do the same thing but this time there are several local devicer available.
-
- # int6klist
- 00:B0:52:BE:EF:04 00:B0:52:BA:BE:02 00:B0:52:BA:BE:01 # int6k
-
- The next example queries the first local device from the previous example, 00:B0:52:BE:EF:04, for a list neighbor
- devices. This time a VS_NW_INFO message is sent because we named a device on the command line. The named device happens
- to be a local device but it need not be. We can see that the device has no neighbors.
-
- # int6klist 00:B0:52:BE:EF:04
- 00:B0:52:BE:EF:04 # int6k
-
- The next example we query the next ocal device, 00:B0:52:BA:BE:02, and find that it has two neighbor devices that did not
- show up earlier because they are remote devices. Observe that the three devices comprise a complete logical powerline
- network. Device 00:B0:52:BA:BE:02 is connected to the local host but 00:0F:33:F2:01:21 and 00:0f:00:F2:01:13 are con‐
- nected to other hosts, somewhere.
-
- # int6klist 00:B0:52:BA:BE:02
- 00:B0:52:BA:BE:02 00:0F:33:F2:01:21 00:0F:00:F2:01:13
-
- The next example shows that we can query multiple devices at a time for neighbors. We have copied the output from the
- second example and pasted it onto the command line. We now have a list of all devices, local and remote.
-
- # int6klist 00:B0:52:BE:EF:04 00:B0:52:BA:BE:02 00:B0:52:BA:BE:01
- 00:B0:52:BE:EF:04 00:B0:52:BA:BE:01 00:B0:52:BA:BE:02 00:0F:33:F2:01:21 00:0F:00:F2:01:13
-
- This next example does the same thing but uses option -n to append a newline after each query. This output is eaiser to
- understand because each device queried starts on a new line and is followed by any neighbors.
-
- # int6klist 00:B0:52:BE:EF:04 00:B0:52:BA:BE:02 00:B0:52:BA:BE:01 -n
- 00:B0:52:BE:EF:04
- 00:B0:52:BA:BE:02 00:0F:33:F2:01:21 00:0F:00:F2:01:13
- 00:B0:52:BA:BE:01
-
- This example invokes int6klist which returns a list of local devices. That list is inserted into another int6klist com‐
- mand line. This demontrates how program output can be used in scripts.
-
- # int6klist $(int6klist) -n
- 00:B0:52:BE:EF:04
- 00:B0:52:BA:BE:02 00:0F:33:F2:01:21 00:0F:00:F2:01:13
- 00:B0:52:BA:BE:01
-
- This next example accomplishes the same thing since all local device respond with a list of powerline neighbors.
-
- # int6klist local
- 00:B0:52:BE:EF:04
- 00:B0:52:BA:BE:02 00:0F:33:F2:01:21 00:0F:00:F2:01:13
- 00:B0:52:BA:BE:01
-
-SEE ALSO
- plc(1), int6krate(1), int6krule(1), int6ktone(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6klist(1)
-
-int6klog(1) Qualcomm Atheros Open Powerline Toolkit int6klog(1)
-
-NAME
- int6klog - Qualcomm Atheros Log Retrieval Utility
-
-SYNOPSIS
- int6klog [options] [device] [device] [...] [>stdout]
-
-DESCRIPTION
- Read and print the device watchdog and checkpoint report on stdout for subsequent analysis by Atheros Technical Support.
- Report output is in XML format and contains base-64 encoded binary data returned by the device. Aside from the XML tags,
- output is not in human readable format.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -C Return customer log. This option has no effect unless used with option -r and is for EoC only.
-
- -c Clear report. This option is independent of options -r and -C.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -f Specifies the output format. Possible values are "xml" and "raw". "xml" will output the watchdog and checkpoint
- log in the customer XML xlog format. "raw" will output the watchdog log in the Engineering Device Manager .log
- format.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -q Suppresses status messages on stderr.
-
- -r Read watchdog log. This is not the default option and must be specified when needed.
-
- -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
- be saved as text files for reference.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-LOGFILES
- Log files are save in binary format by default but they can also be saved in XML format by adding option -x to the com‐
- mand line. By convention, binary log files have a .log extension and XML log files have a .xlog extension. The exten‐
- sion is not critical but it helps us determine the format before we open the file.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. MAC addresses are 12 hexadecimal digits
- (0123456789ABCDEFabcdef) in upper, lower or mixed case. Individual octets may be separated by colons, for clarity, but
- not all octets need to be seperated. For example, "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and
- equivalent.
-
- The following MAC addresses are special and may be expressed by name instead of number.
-
- all Equivalent to "broadcast", described next.
-
- broadcast
- A synonym for the standard Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or
- foreign will respond to this address.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices will recognize this address but remote and foreign devices will not. A remote device is any
- device at the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Atheros Communications,
- Ocala FL USA. Consequently, public information is not available. Atheros Communications reserves the right to modify
- message structure or content in future firmware releases without any obligation to notify or compensate users of this
- program.
-
-EXAMPLES
- The following example reads the Watchdog and Checkpoint Report from device 00:B0:52:BA:BE:02 and prints them on stdout in
- XML format. The output contains data segments formatted in base-64 notation which preserved data integrity when read or
- transmitted in text format.
-
- # int6klog 00:B0:52:BA:BE:02
-
- The next example does the same thing but pipes output to file temp.log. Atheros recommends using a .log extension for
- compatibility with the WIndows Device Manager.
-
- # int6klog 00:B0:52:BA:BE:02 > temp.log
-
-SEE ALSO
- amp(1), int6k(1), int6kf(1), int6khost(1), int6kid(1), int6krate(1), int6krule(1), int6kstat(1), int6kwait(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6klog(1)
-
-int6kmdio(1) Qualcomm Atheros Open Powerline Toolkit int6kmdio(1)
-
-NAME
- int6kmdio - Qualcomm Atheros 16-bit MDIO Register Editor
-
-SYNOPSIS
- int6kmdio [options] [device] [device] [...]
-
-DESCRIPTION
- Read or write the generic MDIO registers on an Atheros powerline device using the Qualcomm Atheros VS_MDIO_COMMAND ven‐
- dor-specific management message. The default operation is to read a register. Registers are written only if data is
- specified on the command line.
-
- This program writes MDIO instructions using 802.3 Clause 22 (phy, reg, data and mask) format. See program int6kmdio2 for
- a similar program to write instructions using 802.3ae Clause 45 (address, data and mask) format.
-
- This program is deprecated and may be removed in later toolkit releases. Use program plcmdio16 instead.
-
-OPTIONS
- -d data
- A 16-bit data value to be inserted into the specified register. The specified data value is written when this
- option is present; otherwise the specified register is read and the content is displayed. Data values may be
- expressed in decimal, hexadecimal or binary notation. Hexadecimal values are prefixed with "0x" or "0X". Binary
- values are prefixed with "0b" or "0B".
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -p address
- The 5-bit PHY address. Some devices may not support all possible addresses. Addresses may be expressed in deci‐
- mal, hexadecimal or binary notation. Hexadecimal values must be prefixed with "0x" or "0X". Binary values must
- be prefixed with "0b" or "0B".
-
- -q Suppresses status messages on stderr.
-
- -r register
- The 5-bit register address. Addresses may be expressed in decimal, hexadecimal or binary notation. Hexadecimal
- values must be prefixed with "0x" or "0X". Binary values must be prefixed with "0b" or "0B". Some devices may
- not support all possible addresses.
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -?,--help
- Displays program help information on stderr. This option takes precedence over all other options on the command
- line except version information.
-
- -!,--version
- Displays program version information on stderr. This option takes precedence over all other options on the com‐
- mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for technical information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- None.
-
-SEE ALSO
- plc(1), int6kmod(1), int6kmdio2(1), mdioblock(1), mdioblock2(1), mdiodump(1), mdiogen(1), plcmdio16(1), plcmdio32(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6kmdio(1)
-
-int6kmdio2(1) Qualcomm Atheros Open Powerline Toolkit int6kmdio2(1)
-
-NAME
- int6kmdio2 - Qualcomm Atheros 32-bit MDIO Register Editor
-
-SYNOPSIS
- int6kmdio2 [options] [device] [device] [...]
-
-DESCRIPTION
- Read or write the global MDIO registers on an Atheros powerline device using multiple VS_MDIO_COMMAND vendor-specific
- management messages. Commands are entered using 32-bit register and data values then converted to three equivalent
- 16-bit commands. The default operation is to read a register. Registers are written only if data is specified on the
- command line.
-
- This program writes MDIO instructions using 802.3ae Clause 45 (address, data and mask) format. See program int6kmdio for
- a similar program to write instructions using 802.3 Clause 22 (phy, reg, data and mask) format.
-
- This program is deprecated and may be removed in future toolkit releases. Use program plcmdio32 instead.
-
-OPTIONS
- -a address
- The 19-bit global register address. Some devices may not support all possible addresses. Addresses may be
- expressed in decimal, hexadecimal or binary notation. Hexadecimal values must be prefixed with "0x" or "0X".
- Binary values must be prefixed with "0b" or "0B".
-
- -d data
- A 32-bit data value to be inserted into the specified register. The specified data value is written when this
- option is present; otherwise the specified register is read and the content is displayed. Data values may be
- expressed in decimal, hexadecimal or binary notation. Hexadecimal values are prefixed with "0x" or "0X". Binary
- values are prefixed with "0b" or "0B".
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -h Write high order-byte before low-order byte. This option is only useful on some architectures.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -q Suppresses status messages on stderr.
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -?,--help
- Displays program help information on stderr. This option takes precedence over all other options on the command
- line except version information.
-
- -!,--version
- Displays program version information on stderr. This option takes precedence over all other options on the com‐
- mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for technical information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- None.
-
-SEE ALSO
- plc(1), int6kmod(1), int6kmdio(1), int6kmdio2(1), mdioblock(1), mdioblock2(1), mdiodump(1), mdiogen(1), plcmdio16(1),
- plcmdio32(1)
-
-CREDITS
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6kmdio2(1)
-
-int6kmod(1) Qualcomm Atheros Open Powerline Toolkit int6kmod(1)
-
-NAME
- int6kmod - Qualcomm Atheros Powerline Device Module Manager
-
-SYNOPSIS
- int6kmod [options] [device] [device] [...]
-
-DESCRIPTION
- Read or write Atheros custom powerline modules using VS_MODULE_OPERATION messages. Modules may be read from a device and
- written to a file or read from a file and written to a device. Modules may have any of several formats and purposes.
- Where the firmware permits, this program can now read modules in excess of 1400 bytes and can write multiple modules that
- exceed 1400 bytes in one operation.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -d Read the specified module from NVRAM and write to standard output in hexadecimal dump format. The module is iden‐
- tified by module and sub-module using options -t and -s. Runtime firmware will report an error if the module is
- not available. The session identifier is not required for a module read operation and is ignored. The largest
- module that can be read is 1400 bytes. This option and option -m are mutually exclusive.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -m filename
- Read the specified module from NVRAM and write it to the named file. The module is identified by module and sub-
- module using options -t and -s. Runtime firmware will report an error if the module is not available. The ses‐
- sion identifier is not required for a module read operation and is ignored. The largest module that can be read
- is 1400 bytes. This option and option -d are mutually exclusive.
-
- -M filename
- Read the named module file and download it to the named device and commit NVRAM. The module is assigned to a mod‐
- ule and sub-module identifier using options -t and -s. Runtime firmware will reject modules having invalid module
- and sub-mocule identifiers. Module files must be a multiple of four bytes or an error will occur. As imple‐
- mented, int6kmod will reject files exceeding 1400 bytes but this restriction will be removed in later versions.
-
- -q Suppresses status messages on stderr.
-
- -s sub-module-id
- The sub-module identifier expressed as a 16-bit hexadecimal value with optional 0x prefix. This identifier indi‐
- cates a specific module with the module class specified using option -t. Any 16-bit value is permitted but only
- certain values are accepted by device firmware depending on firmware type and revision. The default value is
- 0x0000.
-
- -S session-id
- The session identifier expressed as a 32-bit hexadecimal value with optional 0x prefix. The session identifier
- value is arbitrary and so any 32-bit value is permitted but 0x00000000 and 0xFFFFFFFF are illegal. The 0x prefix
- is optional for this argument. The default session-id is 0x78563412.
-
- -t module-id
- The module identifier expressed as a 16-bit hexadecimal value with optional 0x prefix. This identifier indicates
- the module type or class. Option -s indicates the specific member of a module class. Any 16-bit value is permit‐
- ted but only certain values will be accepted by device firmware. The default value is 0x0000.
-
- -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
- be saved as text files for reference.
-
- -w Write settings to the device instead of reading settings from the device. If omitted then settings are read from
- the device and displayed. If present, the user should specify all settings to avoid writing default values to the
- device.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified on the command line. If more
- than one address is specified then operations are performed on each device in turn. The default address is local.
- See DEVICES for information.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information is not available. Qualcomm Atheros reserves the right to modify message structure
- or content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- The following command reads module file abc.bin and writes it to the local device. The module identifier 0x1000 indi‐
- cates that it is an MDIO Init module. The sub-module identifer defaults to 0x0000 because option -s is omitted. The
- session identifier defaults to 0x78563412 because option -S is omitted. The operation takes place in three steps. The
- last step may take 2 or 3 seconds to complete.
-
- # int6kmod -M abc.bin -t 0x1000
- eth1 00:B0:52:00:00:01 Request Session
- eth1 00:B0:52:BE:EF:03 Request Granted
- eth1 00:B0:52:00:00:01 Write abc.bin
- eth1 00:B0:52:BE:EF:03 Written
- eth1 00:B0:52:00:00:01 Commit Modules
- eth1 00:B0:52:BE:EF:03 Committed
-
- The next example does the same thing but writes module file def.bin to remote device 00:B0:52:BA:BE:02. The module iden‐
- tifier 0x4000 indicates that it is an Advanced Power Management uC module. The session identifier used is 0xA5A5A5A5.
- The sub-module identifer defaults to 0x0000 because option -s is omitted.
-
- # int6kmod -M def.bin -t 0x4000 -S A5A5A5A5 00:B0:52:BA:BE:02
- eth1 00:B0:52:00:00:01 Request Session
- eth1 00:B0:52:BE:EF:03 Request Granted
- eth1 00:B0:52:00:00:01 Write abc.bin
- eth1 00:B0:52:BE:EF:03 Written
- eth1 00:B0:52:00:00:01 Commit Modules
- eth1 00:B0:52:BE:EF:03 Committed
-
- The next example reads back the module written in the first example and saves it in file zyx.bin.
-
- # int6kmod -m xyz.bin -t 0x1000
- eth1 00:B0:52:00:00:01 Read zyx.bin
- eth1 00:B0:52:BE:EF:03 Read
-
-SEE ALSO
- plc(1), int6kmdio(1), int6kmdio2(1), mdioblock(1), mdioblock2(1), mdiodump(1), mdiogen(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6kmod(1)
-
-int6krate(1) Qualcomm Atheros Open Powerline Toolkit int6krate(1)
-
-NAME
- int6krate - Qualcomm Atheros INT6x00 PHY Rate Monitor
-
-SYNOPSIS
- int6krate [options] [device] [device] [...]
-
-DESCRIPTION
- The Atheros PHY Rate Utility polls one or more devices and prints the average transmit and receive PHY rates between a
- device and each neighboring network device. Output is column-oriented and suitable for loading into a spreadsheet or
- being read by a simple program.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -c Display coded PHY rates. Coded PHY rates are displayed by default so this option is redundant but it has been
- kept for backword compatibility. This option and option -u are mutually exclusive.
-
- -d seconds
- Traffic duration in seconds per connection. Directional traffic is systematically sent between each pair of pow‐
- erline network devices for this period of time. Consequently, the total time needed to generate traffic between
- all network devices will be approximately n! times this value, so don''t get carried away. The minimum value is 1
- second and the maximum value is 60 seconds.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -n Reads the average transmit and receive PHY rate for wach device using VS_NW_INFO and prints it on stdout. Each
- output line displays the ethernet interface, source address, destination address and either the transmit or
- receive PHY rate.
-
- -o milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -q Enter quiet mode. Progress messages are suppressed.
-
- -r Reads device hardware and software revision information using VS_SW_VER and prints it on stdout.
-
- -R Resets the device using VS_RS_DEV.
-
- -t Generate powerline traffic between the local device and each remote device on each powerline network connected to
- the host. It does not generate any traffic between remote powerline device pairs. This option is especially use‐
- ful when remote powerline devices are not connected to Ethernet devices capable of sending traffic back to the
- host.
-
- -T Generate powerline traffic between all devices on each powerline network connected to the host. This option is
- similar to option -t but it takes much longer because traffic is systematically generated between each pair of
- powerline devices. Consequently, the time to complete will increase factorially as the number of network devices
- increases. Such complete traffic path coverage is not always needed.
-
- -u Display un-coded PHY rates. Coded PHY rates are displayed by default. This option and option -c are mutually
- exclusive.
-
- -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
-
- -x Exit program on first error with a non-zero exit code. This option allows shell scripts to detect failed or
- incomplete operations and take the appropriate action.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-EXAMPLES
- The following example displays the average transmit and receive PHY rates from each of two devices. One is a local
- device connected to interface eth2 and the other is a remote device at the far end of the powerline. In this case, they
- are the only two devices on the powerline network. Observe the recipricol rates shown.
-
- # int6krate -ni eth2 00:B0:52:00:00:AA 00:B0:52:00:00:BB
- eth2 00:B0:52:00:00:AA 00:B0:52:00:00:BB TX 163 mbps
- eth2 00:B0:52:00:00:AA 00:B0:52:00:00:BB RX 176 mbps
- eth2 00:B0:52:00:00:BB 00:B0:52:00:00:AA TX 176 mbps
- eth2 00:B0:52:00:00:BB 00:B0:52:00:00:AA RX 163 mbps
-
- The following example generates powerline traffic between the local device and each remote device because option -t is
- present. It then displays the PHY rate read from the local device.
-
- # int6krate -tni eth2
- eth2 00:B0:52:00:00:AA 00:B0:52:00:00:BB TX 163 mbps
- eth2 00:B0:52:00:00:AA 00:B0:52:00:00:BB RX 176 mbps
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- plc(1), int6krule(1), int6kstat(1), int6ktone(1)
-
-CREDITS
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6krate(1)
-
-int6krule(1) Qualcomm Atheros Open Powerline Toolkit int6krule(1)
-
-NAME
- int6krule - Stream Classification Utility
-
-SYNOPSIS
- int6krule [options] action operand condition [condition] [condition] control volatility [device] [device] [...]
-
- where condition is a field operator value sequence.
-
-DESCRIPTION
- Format and send stream classification rules to one or more devices. Rules specify an action to be taken when a frame
- satisfies selection criteria. Selection criteria consists of one, two or three conditions where any or all conditions
- must be satisfied. Each condition consists of a field type, a relational operator and a value. Rules may be added to a
- device, or removed from a device, so that they have permanent or temporary effect.
-
- Classification rules are cumulative. If a new rule set is identical to an old rule set then an error will occur unless
- it contains a different Transmission Action. In that case the old rule will be replaced. Identical classification rule
- sets are permitted if one of the sets is associated with a VLAN tag action. Classification is based on the original
- frame before is is altered by VLAN Tag insertion or removal.
-
- Classification is multi-dimensional and the terminology used here may seem strange at first. Refer to the Qualcomm
- Atheros Firmware Techncial Reference Manual description of the VS_CLASSIFICATION management message for a full explana‐
- tion.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -r Read rules from a device and display them on stdout.
-
- -q Suppresses status messages on stderr.
-
- -s Print a list of program keywords on stdout. This option over-rides all others, except -? and -!, and the program
- will terminate without further action.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu. -T tag The VLAN tag to be inserted into frames
- before they are transmitted. The tag is a 32-bit hexadecimal integer with optional "0x" prefix. This option is
- required for action TagTX and must be omitted for all other actions.
-
- -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
- be saved as text files for reference.
-
- -V version
- The CSPEC version number expressed as a small decimal integer. This option is required (and should be 2) for
- action TagTX and must be omitted for all other actions.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- action The action to be taken for frames that meet any (or all) selection criteria. Valid actions are listed and
- described under ACTIONS.
-
- operand
- The operand specifies the logical relationship between conditions before the action to be taken. Valid operands
- are listed and described under OPERANDS.
-
- condition
- A conditional expression consisting of a field, operator and value. See CONDITIONS for more information.
-
- control
- The control specifies the action to be taken by the device upon receipt of the rule. The basic actions are to add
- it to, or remove it from, the list of existing rules. Valid controls are listed and described under CONTROLS.
-
- volatility
- The volatility specifies the effective lifetime of the rule. Temoprary rules are stored in SDRAM and are lost
- then the device is reset. Permanent rules are stored in NVRAM and are restored after the device is reset. Valid
- volatilities are listed and described under VOLATILITY.
-
- device The MAC address of some powerline device. More than one address may be specified on the command line. If more
- than one address is specified then operations are performed on each device in turn. The default address is
- "local". See DEVICES for more information.
-
-ACTIONS
- Actions indcate the disposition of frames that match selection criteria. They are expressed as discrete alphanumeric
- strings entered in upper, lower or mixed character case. They are position sensitive. Failure to enter a known action
- will results in an error message that lists permitted actions.
-
- CAP0,CAP1,CAP2,CAP3
- Assign a specific Channel Access Priority to frames.
-
- Drop,DropTX
- Do not forward frames over powerline.
-
- DropRX Do not forward frames to host.
-
- Boost Boost frame priority to CAP3 for MMEs only. At least one condition must be "MME".
-
- StripTX
- Remove the VLAN Tag from frames before transmission over powerline. This option checks for a VLAN Tag even when
- there are no VLAN related conditions.
-
- StripRX
- Remove the VLAN Tag from frames before forwarding to host. This option checks for a VLAN Tag even when there are
- no VLAN related conditions.
-
- TagTX Insert a given VLAN Tag into frames before transmission over powerline. This action requires option -T to specify
- the tag and option -V to specify the CSPEC version.
-
-OPERANDS
- The operand indicates the logical relationship that must exist between conditions in the rule set before the action is
- applied to a frame. Operands are expressed as discrete alphanumeric strings entered in upper, lower or mixed character
- case. Failure to enter a known operand will result in an error message that lists permitted operands. They are positon
- sensitive. One operand is allowed and it must appear after the action and before any condition.
-
- Any Apply the action to frames that satisfy any of the conditions. This is equivalent to the logical or operation.
-
- All Apply the action to frames that satisfy all of the conditions. This is equivalent to the logical and operation.
-
- Always Apply the action to all frames. All conditions are ignored.
-
-CONDITIONS
- A condition consists of a field, an operator and a value. One condition is required but three are permitted. Condition
- order is not important but all conditions must appear after the operand and before the control.
-
- field The field is the part of the Ethernet frame to be examined. Some fields are not valid for some actions but this
- program does not enforce such rules since validation is performed by runtime firmware on each device. Recognized
- fields are listed and described under FIELDS.
-
- operator
- The operator specifies the relationsip that must exist between the field and value in order for the condition to
- evaluate True. Currently, only equality operators are supported. Valid operators are listed and described under
- OPERATORS.
-
- value The value must be appropriate to the field type. Some fields are MAC or IP addresses, some are integers, some are
- bitmaps and others are states. Integers and bitmaps may be expressed in binary, decimal or hexadecimal format.
- Binary values staRt with 0b. Hexadecimal values start with 0x. States are expressed using keywords. Users are
- responsible for knowing how many bits are significant for each type of value. Valid values are described along
- with fields under FIELDS.
-
-FIELDS
- Fields indicate the portion of the frame that is inspected during selection and the size and format of the value permited
- in the condition statement. They are expressed as discrete alphanumeric strings entered in upper, lower or mixed charac‐
- ter case. Failure to enter a known field will result in an error message that lists permitted fields.
-
- ET A 16-bit Ethertype expressed in hexadecimal with optional "0x" prefix. The format is described in IEEE Standard
- 802-2001 [4].
-
- EthDA A 48-bit Ethernet destination address expressed in hexadecimal. Octets may be separated with optional colons for
- clarity. The format is described in IEEE Standard 802-2001 [4].
-
- EthSA A 48-bit Ethernet source address expressed in hexadecimal. Octets may be separated with optional colons for clar‐
- ity. The format is described in IEEE Standard 802-2001 [4].
-
- IPSP A 16-bit IP source port expressed as a decimal integer. This condition applies to either TCP or UDP packets,
- depending on the protocol used, and is valid only for actions "CAP0", "CAP1", "CAP2", "CAP3" and "Drop".
-
- IPDP A 16-bit IP destination port expressed as a decimal integer. This condition applies to either TCP or UDP packets,
- depending on the protocol used, and is valid only for actions "CAP0", "CAP1", "CAP2", "CAP3" and "Drop".
-
- IPV4TOS
- An 8-bit Type-of-Service code where the format is defined in the RFC 791 (Internet Protocol) [14].
-
- IPV4PROT
- An 8-bit Ethernet protocol code. The format is defined in the RFC 791 (Internet Protocol) [14].
-
- IPV4SA A 32-bit Internet Protocol source address expressed in dotted-decimal notation. The official format is defined in
- RFC 791 (Internet Protocol) [14]. Our implementation permits empty octets and leading zeros within fields. For
- example, "..." is equivalent to "0.0.0.0 and "127..000.001" is equivalent to "127.0.0.1".
-
- IPV4DA A 32-bit Internet Protocol destination address expressed in dotted-decimal notation. The official format is
- defined in RFC 791 (internet Protocol) [14]. Our implementation permits empty octets and leading zeros within
- fields. For example, "..." is equivalent to "0.0.0.0 and "127..000.001" is equivalent to "127.0.0.1".
-
- IPV6TC An 8-bit Internet Protocol V6 traffic class expressed as defined in RFC 2460 (Internet Protocol Version 6) [17].
-
- IPV6FL A 24-bit IPV6 flow label where the lower 20 bits are the IPv6 Flow Label defined in RFC 2460 (Internat Protocol
- Version 6) [17]. The upper 4 bits should be zero. The value can be entered either as a decimal, binary or hex
- integer.
-
- IPV6SA A 128-bit IPV6 source address expressed as colon-separated hexadecmial quartets (octet pairs). The official for‐
- mat is defined in RFC 2460 (Internet Protocol Version 6) [17]. Our implementation permits multiple empty fields,
- abreviated fields and leading zeros within fields. When multiple empty fields appear, the right-most occurance
- expands to multiple zeros. For example, "AAAA::BBBB::CCCC" is equivalent to
- "AAAA:0000:BBBB:0000:0000:0000:0000:CCCC".
-
- IPV6DA A 128-bit IPV6 destination address expressed as colon-separated hexadecimal quartets (octet pairs). The official
- format is defined in RFC 2460 (Internet Protocol Version 6) [17]. Our implementation permits multiple empty
- fields, abbreviated fields and leading zeros within fields. When multiple empty fields appear, the right-most
- occurance expands to zeros. For example, ":1::2" is equivalent to "0000:0001:0000:0000:0000:0000:0000:0002".
-
- MME A 24-bit Atheros HomePlugAV Management Message type expressed as a hex byte stream. For clarity, the recommeded
- format it "xx:xxxx". The first byte is the MMV. The next two bytes are the MMTYPE. Both are defined in the
- HomePlug AV Specification. The MMTYPE will match all MME variants, such as Request, Confirm, Indicate and
- Response because the lower two bits are ignored. This field is only valid for action "Boost".
-
- TCPAck The string "True" or "False" to indicate that the frame is (or is not) a TCP Acknowledgement. Double negatives
- are allowed so "Is True" is equvalent to "Not False" and "Is False" is equivalent to "Not True".
-
- TCPSP A 16-bit TCP source port as a decimal integer. The format is defined in RFC 793 (Transmission Control Protocol
- [15]).
-
- TCPDP A 16-bit TCP destination port expressed as a decimal integer. The format is defined in RFC 793 (Transmission Con‐
- trol Protocol [15]).
-
- UDPSP A 16-bit UDP source port expressed as a decimal integer. The format is defined in RFC 768 (User Datagram Protocol
- [13]).
-
- UDPDP A 16-bit UDP destination port expressed as a decimal integer. The format is defined in RFC 768 (User Datagram
- Protocol [13]).
-
- VLANID A 16-bit VLAN identifier where the lower 12 bits are the VLAN Identifier (VID) defined in IEEE Std 802.1Q-1998
- (Virtual Bridged Local Area Networks) [11]. The upper 4 bits should be zero.
-
- VLANUP An 8-bit Ethernet VLAN tag where the lower 3 bits are the User Priority sub-field of a VLAN Tag defined in IEEE
- Std 802.1Q-1998 (Virtual Bridged Local Area Networks) [11]. The upper 5 bits should be zero.
-
- VLANTag
- The string "Present" or "Missing" to indicate the presence (or absence) of one or more VLAN Tags within a frame.
- This classifier is essentially equivalent to "ET Is 0x8100". Double negatives are allowed so "Is Present" is
- equivalent to "Not Missing" and "Is Missing" is equivalent to "Not Present".
-
-OPERATORS
- An operator indicates an equality between a field and a value. An operator is an alphanumeric string entered in upper,
- lower or mixed character case. Failure to enter a known operator will result in an error message that lists permitted
- operators. Operators are position sensitive and must appear between each field and value.
-
- Is Indicates that the frame field must equal the associated value for the condition to evaluate true.
-
- Not Indicates that the frame field must not equal the associated value for the condition to evaluate true.
-
-STATES
- A state is a special case of value.
-
- True,On,Yes,Present
- Indicates a positive state or presence of some entity. All are equivalent and can be used interchangeably. Dou‐
- ble negatives are permitted so "Is True" is equvalent to "Not False".
-
- False,Off,No,Missing
- Indicates a negative state or absence of some entity. All are equivalent and can be used interchangeably. Double
- negatives are permitted so "Is False" is equvalent to "Not True".
-
-CONTROLS
- The control determines how the devices will handle the rule after it is validated. It is expressed as a discrete
- alphanumeric string entered in upper, lower or mixed character case. Failure to enter a known control will result in an
- error message that lists permitted controls. The control is position sensitive and must occur after condition and before
- volatility.
-
- Add Adds the rule to the current list of rules unless a violation occurs. In some cases, a rule may replace an exist‐
- ing rule instead of being added.
-
- Rem,Remove
- Remove the rule from the current list of rules unless a violation occurs.
-
-VOLATILITY
- The volatility determines which device rule set will be affected by the action. It is expressed as a discrete alphanu‐
- meric string entered in upper, lower or mixed character case. Failure to enter a known volatility will result in an
- error message that lists permitted volatilities. The volatility is position sensitive and must occur after control.
-
- Temp The temporary rule set will be modified. The temporary rule set resides in the working PIB stored in SDRAM.
-
- Perm The permanent rule set will be modified. The permanent rule set resides in the user PIB stored in NVRAM.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information is not available. Qualcomm Atheros reserves the right to modify message structure
- or content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- This command adds a temporary classification rule to the classification table on device B00:B0:52:BA:BE:01. The rule
- instructs the device to drop frames that match either (any) of two conditions. The first condition states that the IPv4
- source address is 192.168.99.2. The second conditon states that the IPv4 destination address is 192.168.99.100.
-
- # int6krule drop any IPv4SA is 192.168.99.2 IPv4DA is 192.168.99.100 add temp 00:B0:52:BA:BE:01
-
- Observe that the action, operand and conditions come first then the control and volatility then the affected devices. Up
- to three conditions may be specified. Keyword order is important. Character case is not important.
-
- The following example prints a list of programmed keywords on stdout for reference. The example shown here has been
- abbreviate due to formatting limitations.
-
- # int6krule -s
-
- Controls are 'Add'|'Rem'|'Remove'
- Volatilities are 'Temp'|'Perm'
- Actions are 'CAP0'|'CAP1'|'CAP2'|'CAP3'|'Boost'|...|'StripTX'|'StripRX'|'TagRX'
- Operands are 'All'|'Any'|'Always'
- Fields are 'EthDA'|'EthSA'|'VLANUP'|'VLANID'|'IPv4TOS'|...|'TCPAck'|'VLANTag'
- Operators are 'Is'|'Not'
-
- More example follow:
-
- Ethernet Address Rules
-
- Ethernet address rules have the following general format:
-
- | CAP0 | ANY | EthSA | IS | xx:xx:xx:xx:xx:xx | ADD | TEMP | xx:xx:xx:xx:xx:xx
- | CAP1 | ALL | EthDA | NOT | | REMOVE | PERM |
- | CAP2 |
- | CAP3 |
- | DROP |
-
- For example, instruct device 00:B0:52:BA:BE:FF to temporarily add a rule to forward frames from 00:2B:FE:CA:FE:BA at
- CAP3. Observe Ethernet hardware addresses are used both in the condition and for the affected powerline devices.
-
- # int6krule cap3 any ethsa is 00:2b:fe:ca:fe:ba add temp 00:b0;52:ba:be:ff
-
- IP Address Rules
-
- IP address rules have the following general format:
-
- | CAP0 | ANY | IPv4SA | IS | ddd.ddd.ddd.ddd | ADD | TEMP | xx:xx:xx:xx:xx:xx
- | CAP1 | ALL | IPv4DA | NOT | | REMOVE | PERM |
- | CAP2 |
- | CAP3 |
- | DROP |
-
- For example, instruct device 00:B0:52:BA:BE:FF to permanently remove the rule that drops packets from 192.168.99.1.
- Notice that the IP address is specified in dotted decimal format but the device address is specified in hexadecimal octet
- format. Dotted decimal format permits empty and variable length octets but octet delimiters are mandatory. Hexadecimal
- octet format requires fixed length octets but octet delimiters are optional.
-
- # int6krule drop any ipv4sa is 192.168.99.1 remove perm 00:b0:52:ba:be:ff
-
- IP Protocol Rules
-
- IP protocol rules have the following general format:
-
- | CAP0 | ANY | IPv4PROT | IS | xxxx | ADD | TEMP | xx:xx:xx:xx:xx:xx
- | CAP1 | ALL | | NOT | | REMOVE | PERM |
- | CAP2 |
- | CAP3 |
- | DROP |
-
- For example, to instruct device 00:B0:52:BA:BE:FF to permanently add a rule to forward non-IP packets at CAP2. In this
- example, delmiters have been omitted from the device Ethernet address.
-
- # int6krule CAP2 all ipv4prot not 0x0800 add perm 00b052babeff
-
-SEE ALSO
- plc(1), int6krate(1), int6kstat(1), int6ktone(7)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6krule(1)
-
-int6kstat(1) Qualcomm Atheros Open Powerline Toolkit int6kstat(1)
-
-NAME
- int6kstat - Qualcomm Atheros INT6x00 Link Statistics
-
-SYNOPSIS
- int6kstat [options] [device] [device] [...]
-
-DESCRIPTION
- The Atheros Device Statistics Utility polls a device and prints network and link statistics in various formats suitable
- for use by other programs. This is a work in progress so usr feedback is encouraged.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -C Clear device link statistics using VS_LNK_STATS. Statistics are read and cleared then displayed. The statistics
- that are read and displayed depend on options -d, -p and -s but all link statistics are cleared.
-
- -d direction
- Return statistics for the specified direction using VS_LNK_STATS. Direction can be 0=tx, 1=rx, 2=both or "rx",
- "tx" or "both".
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -l count
- Define the number of times that the command will be repeated for each device specified. Normally, you will repeat
- operations on one device only.
-
- -m Displays network membership information, as seen by one device, using VS_NW_INFO. Use option -t for complete net‐
- work topology seen by the local host.
-
- -p peernode
- Ethernet hardware address of the peer node for VS_LNK_STATS. This option is required for all Link ID values
- except 0xFC. The default is 00:00:00:00:00:00.
-
- -q Enter quiet mode. Progress messages are suppressed.
-
- -s linkid
- The Link ID for VS_LNK_STATS. Link ID values range from 0 through 255 but not all values are accepted by the
- device firmware. Values may be expressed in decimal, binary prefixed with "0b" or hexadecimal prefixed by "0x".
- Many valid values can be expressed by name. Valid values are listed and explained under LINKID. The default Link
- ID is 0xFC.
-
- -t Display network topology using VS_SW_VER and VS_NW_INFO messages. This option is similar to option -m but pro‐
- vides complete network topology plus device hardware and firmware version. Topology is always relative to the
- local host, or local hosts if present. Powerline devices that appear on the command line are not used for this
- operation. PHY rates displaye by this option may saturate at 255 mbps.
-
- -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
-
- -w seconds
- Defines the number of seconds to wait before repeating command line options. This option has no effect unless
- option -l is also specified with a non-zero value.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-LINKID
- 0x00,CSMA-CAP0
- Display CSMA statistics for CAP0 traffic using a single peer node. The peer node MAC address must be specified
- using option -p.
-
- 0x01,CSMA-CAP1
- Display CSMA statistics for CAP1 traffic using a single peer node. The peer node MAC address must be specified
- using option -p.
-
- 0x02,CSMA-CAP2
- Display CSMA statistics for CAP2 traffic using a single peer node. The peer node MAC address must be specified
- using option -p.
-
- 0x03,CSMA-CAP3
- Display CSMA statistics for CAP3 traffic using a single peer node. The peer node MAC address must be specified
- using option -p.
-
- 0xF8,CSMA-PEER
- Display CSMA statistics for all traffic using a single peer node. The peer node MAC address must be specified
- using option -p.
-
- 0xFC,CSMA-ALL
- Display CSMA statistics for all traffic with all peer nodes. A peer node MAC address is not needed and will be
- ignored if provided. This value is the default for option -s.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-EXAMPLES
- None.
-
-SEE ALSO
- plc(1), int6krate(1), int6krule(1), int6ktone(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6kstat(1)
-
-int6ktest(1) Qualcomm Atheros Open Powerline Toolkit int6ktest(1)
-
-NAME
- int6ktest - Qualcomm Atheros Test Applet Loader
-
-SYNOPSIS
- int6ktest [options] [file] [file] [...]
-
-DESCRIPTION
- Download and execute one or more test applets on the local powerline device. An applet is a small firmware image that
- can be started by the bootloader and that returns to the bootloader when done.
-
- An Atheros image file can contain one or more firmware images. Each image is preceded by a header that specifies the
- image size, load address and start address. int6ktest sequentially dowloads and executes each image found in each image
- file specified as a command line argument. It waits for each image to complete before it will download and execute the
- next image. The program terminates once all images in all image files have been executed or some image fails to complete
- within 60 seconds.
-
- Most applets return to the Bootloader on successful completion so that another applet can be downloaded and executed.
- This allows applet chains to be executed using one command. A chain may consist of one image file containing many
- applets or several image files containing one applet each or any combination. The chain will break, after a timeout, if
- any applet in the chain fails to return to the Bootloader.
-
- The toolkit contains a set of useful applets in folder applets. Most, if not all, are as single applet image files.
- Program chknvm can be used to inspect image files and programs nvmmerge and nvmsplit can be used to assemble and disas‐
- semble multi-applet image files. This allows custom applet chains to be created and kept together in one file. The num‐
- ber and quality of available applets will probably increase with time.
-
- Users should take the time to understand the applets they attempt to execute or confusion may result. Each applet should
- have an associated man page to explain what it does and how it works. Most applets execute and return to the bootloader
- within seconds but some loop indefinitely or stop on failure. Newer applets print test progress and outcomes on the con‐
- sole but older applets merely flash device LEDs to indicate test progress and outcomes.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-COMMENTS
- This program is an alternative to program amptest but is deprecated. In the future, applet designers should develop
- applets for amptest instead of this program.
-
-OPTIONS
- -c count
- The number of times the program will poll the device before declaring an event failure. The program will wait a
- fixed period of time between each poll attempt. Overall wait time is count/frequency where count can be modified
- using option -c. Overall wait time is always approximate since operating system overhead and latency are not
- taken into account. The default count is 60.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -l Sequentially execute and re-execute all applets in all files on the command line until the program is terminated
- with ^C.
-
- -p frequency
- The polling frequency expressed in polls-per-second. For example, 1 means one poll per second and 10 means ten
- polls per second. Overall wait time is count/frequency where count may be modified using option -c. Overall wait
- time is always approximate since operating system overhead and latency are not taken into account. The default
- frequency is 5.
-
- -q Suppresses normal progress and status messages.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -v Print additional information on stdout. Specifically, this option prints incoming and outgoing frames in hexadec‐
- imal format on stdout. Output can be directed to a text file for analysis.
-
- -x Cause the program to exit on the first error instead of moving on to the next applet. Error exits return a non-
- zero value to the shell.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of an Atheros image file. The image file may contain one or more images. Each image will be downloaded
- and executed in turn until all images are executed or an image fails to return the device to the Bootloader within
- 1 hour for some reason.
-
-EXAMPLES
- The following example sequentially downloads then executes each image in file abc.nvm in turn. Each image must complete
- and return to the bootloader before the next one downloads. Observe that no device address is needed because Atheros
- powerline devices all use address 00:b0:52:00:00:01 when in bootloader mode.
-
- # int6ktest abc.nvm
-
- The following example will sequentially download and execute the images in each file abc.nvm, def.nvm and ghi.nvm in
- turn.
-
- # int6ktest abc.nvm def.nvm ghi.nvm
-
-DISCLAIMER
- Atheros image file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public informa‐
- tion is not available. Qualcomm Atheros reserves the right to change file structure or content in future firmware
- releases without any obligation to notify or compensate users of this program. This program is reserved for use by
- Atheros Field Engineers. Use of this program may void some contractual obligations made by Atheros.
-
-SEE ALSO
- chknvm(1), chknvm2(1), amptest(1), nvmsplit(1), nvmmerge(1), plctest(1), setnvm(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6ktest(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * int6ktone.c - Atheros INT6x00 Tone Map Dump Utility
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <unistd.h>
-#include <stdlib.h>
-#include <stdint.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#include "../tools/getoptv.h"
-#include "../tools/putoptv.h"
-#include "../tools/memory.h"
-#include "../tools/symbol.h"
-#include "../tools/types.h"
-#include "../tools/flags.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-/*====================================================================*
- * custom source files;
- *--------------------------------------------------------------------*/
-
-#ifndef MAKEFILE
-#include "../plc/Devices.c"
-#include "../plc/Failure.c"
-#include "../plc/ReadMME.c"
-#include "../plc/SendMME.c"
-#include "../plc/SignalToNoise1.c"
-#include "../plc/ToneMaps1.c"
-#endif
-
-#ifndef MAKEFILE
-#include "../tools/error.c"
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-#include "../tools/uintspec.c"
-#include "../tools/hexdump.c"
-#include "../tools/hexencode.c"
-#include "../tools/hexdecode.c"
-#include "../tools/hexstring.c"
-#include "../tools/todigit.c"
-#include "../tools/synonym.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/MMECode.c"
-#include "../mme/EthernetHeader.c"
-#include "../mme/QualcommHeader.c"
-#include "../mme/UnwantedMessage.c"
-#endif
-
-/*====================================================================*
- *
- * int main (int argc, char const * argv[]);
- *
- * parse command line, populate plc structure and perform selected
- * operations; show help summary if asked; see getoptv and putoptv
- * to understand command line parsing and help summary display; see
- * plc.h for the definition of struct plc;
- *
- * the command line accepts multiple MAC addresses and the program
- * performs the specified operations on each address, in turn; the
- * address order is significant but the option order is not; the
- * default address is a local broadcast that causes all devices on
- * the local H1 interface to respond but not those at the remote
- * end of the powerline;
- *
- * the default address is 00:B0:52:00:00:01; omitting the address
- * will automatically address the local device; some options will
- * cancel themselves if this makes no sense;
- *
- * the default interface is eth1 because most people use eth0 as
- * their principle network connection; you can specify another
- * interface with -i or define environment string PLC to make
- * that the default interface and save typing;
- *
- *
- *--------------------------------------------------------------------*/
-
-int main (int argc, char const * argv [])
-
-{
- extern struct channel channel;
- static char const * optv [] =
- {
- "ehi:qsvx",
- "node peer [> stdout]",
- "Qualcomm Atheros INT6x00 Tone Map Dump Utility",
- "e\tredirect stderr to stdout",
- "h\tprint mean-square histogram",
-
-#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
-
- "q\tquiet mode",
- "s\tcompute signal-to-noise and bits-per-carrier ratios",
- "v\tverbose mode",
- "x\texit on error",
- (char const *) (0)
- };
-
-#include "../plc/plc.c"
-
- signed (* function)(struct plc *) = ToneMaps1;
- signed c;
- if (getenv (PLCDEVICE))
- {
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (getenv (PLCDEVICE));
-
-#else
-
- channel.ifname = strdup (getenv (PLCDEVICE));
-
-#endif
-
- }
- optind = 1;
- while ((c = getoptv (argc, argv, optv)) != -1)
- {
- switch (c)
- {
- case 'e':
- dup2 (STDOUT_FILENO, STDERR_FILENO);
- break;
- case 'h':
- _setbits (plc.flags, PLC_GRAPH);
- break;
- case 'i':
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (optarg);
-
-#else
-
- channel.ifname = optarg;
-
-#endif
-
- break;
- case 'q':
- _setbits (channel.flags, CHANNEL_SILENCE);
- _setbits (plc.flags, PLC_SILENCE);
- break;
- case 's':
- _setbits (plc.flags, PLC_ANALYSE);
- function = SignalToNoise1;
- break;
- case 'v':
- _setbits (channel.flags, CHANNEL_VERBOSE);
- _setbits (plc.flags, PLC_VERBOSE);
- break;
- case 'x':
- _setbits (plc.flags, PLC_BAILOUT);
- break;
- default:
- break;
- }
- }
- argc -= optind;
- argv += optind;
- if (!argc || !argv)
- {
- error (1, ECANCELED, "No node address given");
- }
- if (!hexencode (channel.peer, sizeof (channel.peer), synonym (* argv, devices, SIZEOF (devices))))
- {
- error (1, errno, PLC_BAD_MAC, * argv);
- }
- argc--;
- argv++;
- if (!argc || !argv)
- {
- error (1, ECANCELED, "No peer address given");
- }
- if (!hexencode (plc.RDA, sizeof (plc.RDA), synonym (* argv, devices, SIZEOF (devices))))
- {
- error (1, errno, PLC_BAD_MAC, * argv);
- }
- argc--;
- argv++;
- openchannel (&channel);
- if (!(plc.message = malloc (sizeof (* plc.message))))
- {
- error (1, errno, PLC_NOMEMORY);
- }
- function (&plc);
- free (plc.message);
- closechannel (&channel);
- return (0);
-}
-
-
-
-int6kuart(1) Qualcomm Atheros Open Powerline Toolkit int6kuart(1)
-
-NAME
- int6kuart - Qualcomm Atheros Serial Line Device Manager
-
-SYNOPSIS
- int6kuart [options] [...]
-
-DESCRIPTION
- Perform powerline device management operations over serial line interface.
-
- Serial line commands are 7-bit ASCII character strings sent to the local powerline device over the host serial port.
- They can be sent using any terminal emulator but this program will, in many cases, reduce typing and simplify scripting.
- It is especially useful for downloading device parameters and uploading device parameters or firmware because those oper‐
- ations involve large volumes of data. Also, this program permits decimal integer arguments in many cases where the
- serial line commands require hexadecimal integer values. See the COMMANDS section (below) for a list of supported serial
- line commands.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-COMMENTS
- This program does not configure or reconfigure host serial port settings by default because most operating systems have
- their own serial port configuration utility. Be sure to configure host serial port settings before using this program
- because other programs may change them before or after use. Atheros factory default settings for UART-enabled powerline
- devices are 115200 baud, 8 data bits, 1 stop bit, no parity and no flow control. See option -b for a quick way to match
- host serial port settings the Qualcomm Atheros default settings.
-
- On Windows, use the DOS mode command. The general form of this command is mode,baud,parity,databits,stopbits. The fol‐
- lowing example will set a Windows host to the default serial settings used by Atheros powerline devices.
-
- # mode com3:115200,n,8,1
-
- On Linux, use the stty utility to inspect and set serial port parameters. The following Linux command will configure
- serial device /dev/ttyS0 speed to 115200 baud with 8 data bits, 1 stop bit, no parity bit and no flow control. Consult
- the stty man page for an explanation of these and other options.
-
- # stty -F /dev/ttyS0 115200 cs8 cstopb -parenb -ixon
-
- On Linux, you can also use the minicom terminal emulator to communicate using the underlying serial line commands
- described in the COMMANDS section. The minicom program reads default settings from configuration file /etc/mini‐
- com/minirc.dfl if present on startup. A basic configuration file looks like this:
-
- pu port /dev/ttyUSB0
- pu baudrate 115200
- pu bits 8
- pu parity N
- pu stopbits 1
- pu rtscts No
-
-OPTIONS
- -b Set host serial port to the default settings mentioned above. The original host serial port settings are not
- restored when the program terminates. You must restore them manually or by other means. Changing host serial
- port settings will break serial communications with the local powerline device if the device is not using the same
- settings.
-
- -c command
- Send a custom serial line command to the local powerline device over the host serial interface. Argument command
- is sent as specified but will be terminated with a carriage return. The command must be enclosed in quotes if it
- contains spaces or special characters. This option can be used to send serial line commands that are not sup‐
- ported by this program.
-
- -C module
- Commit downloaded parameters and/or firmware to NVM using the ATWNV serial line command. Argument module is one
- hexadecimal octet. The low-order nibble contains the module number. The high-order nibble contains optional con‐
- trol bits. Acceptable module values are 0x01=Firmware, 0x02=Parameters, 0x10=Force Flash and 0x20=Do Not Reboot.
- The default value is 0x00 which has no effect. The 0x prefix is optional.
-
- -d Read and display the destination device address using the ATDST serial line command. This option is similar to
- option -D but substitutes ? for the device address.
-
- -D address
- Set the destination device address for Transparent Mode using the ATDST serial line command. This address will
- supercede the default destination device address, stored in the PIB, until the device is reset. Multicast address
- values are not permitted by the device. Argument address is six hexadecimal octets optionally separated by
- colons.
-
- -F filename
- Read the named frame description file and send it over powerline as an Atheros vendor-specific management message
- using the ATM serial line command. Unlike program efsu, only the first file frame is sent. Any subsequent frames
- defined in the file are ignored.
-
- -H Exit Command Mode and enter High Speed Command Mode using the ATHSC serial line command.
-
- -i Get and display network information using the ATNI serial line command. The information includes the TEI, MAC
- address, receive rate and transmit rate for each remote device on the network.
-
- -I Get and display the PIB version and device MAC address using the ATRPM serial line command.
-
- -m Read and display the Network Membership Key of the local powerline device using the ATSK serial line command.
- This option is similar to option -M but substitutes ? for the membership key.
-
- -M key Set the Network Membership Key of the local powerline device using the ATSK serial line command. The key consists
- of 16 hexadecimal octets optionally separated by colons.
-
- -N filename
- Open the named firmware file on the local host and write it to the local device using multiple ATWPF serial line
- commands. There is no default filename or extension. The file is assumed to contain a valid firmware image.
-
- -O Exit Command Mode and enter Transparent Mode using the ATO serial line command. Subsequent serial data will be
- transmitted over the powerline to the destination device address as raw data. Use option -d to set the destina‐
- tion device address.
-
- -p filename
- Read the parameter block from the local powerline device and write it to the named file on the local host using
- multiple ATRP serial line commands. Required length and offset values are automatically computed for each serial
- line command sent. There is no default filename or extention.
-
- -P filename
- Open the parameter file on the local host and write it to the local powerline device using multiple ATWPF serial
- line commands. Required length and offset values are automatically computed for each serial line command sent.
- There is no default filename or extention. The named file is assumed to contain a valid parameter block.
-
- -q Suppress progress and error information on stderr.
-
- -r Read and display the local powerline device hardware identifier and firmware version string using the ATRV serial
- line command.
-
- -R Reset the local device using the ATZ serial line command
-
- -s tty Communicate with the local powerline device over the named serial interface on the local host. The program
- default is "/dev/ttyUSB0" for Linux and "com1:" for Windows. The program default is replaced if environment vari‐
- able PLCUART is defined. This option over-rides those default settings.
-
- -S Place the local power line device in Power Save Mode using the ATPS serial line command.
-
- -t Test device using the AT serial line command. The device will respond with "OK" when in Command Mode.
-
- -T Restore factory defaults on the local power line device using the ATFD serial line command. Among other things,
- this will restore the destination device address stored in the factory PIB. Any destination device address previ‐
- ously set using option -d will be lost.
-
- -u Force default host port settings to match the default setting for UART-enabled Atheros powerline devices. The
- setting are 115200 baud, 8 data bits, no parity bits and 1 stop bit. These settings will remain active when the
- program terminates and will not change unless changed by some other means, perhaps by another application. This
- option is an easy means of establishg an initial serial connection with a powerline device, unless it's settings
- have been changed.
-
- -v Display actual serial line commands and responses on stdout.
-
- -w Place the local powerline device in Command Mode using the +++ serial line command. The device will remain in com‐
- mand mode until it is reset or forced into Transparaent Mode or High Speed Command Mode.
-
- -W timeout
- Set the Transparent Mode aggregation timeout using the ATTO serial line command. The timeout is expressed in deci‐
- mal milliseconds. Valid values are 1 through 2000.
-
- -z Get the Transparent Mode buffer size using the ATBSZ serial line command. This option is similar to option -B but
- substitutes ? for the buffer size.
-
- -Z size
- Set the Transparent Mode buffer size using the ATBSZ serial line command. The size in bytes is specified in deci‐
- mal here and converted to hexadecimal for transmission. Valid values range from 46 to 1500. The default is 500
- bytes.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- None.
-
-COMMANDS
- This section lists serial line commands recognized by local powerline devices when in Command Mode. Commands can be
- issued interactively using a terminal emulator, like minicom on Linux or HyperTerminal on Windows or stored as text and
- copied to the serial port using system utilities, like cat on Linux or type on Windows. This program merely converts the
- command line options and arguments described above into one or more of the serial line commands shown below.
-
- +++ Exit Transparent Mode and enter Command Mode. See option -w above.
-
- AT Test for Command Mode by doing nothing, successfully. See option -t above.
-
- ATBRmode,baudrate,databits,parity,stopbits,flowctrl
- Set serial line parameters on the local powerline device. Beware that this will break the existing serial connec‐
- tion when the new parameters differ from those of the local host.
-
- ATBSZ? Get Transparent Mode buffer size. See option -z above.
-
- ATBSZsize
- Set Transparent Mode buffer size. See option -Z above.
-
- ATDST? Get Transparent Mode destination device address. See option -d above.
-
- ATDSTaddress
- Set Transparent Mode destination device address. See option -D above.
-
- ATFD Reset local device to factory defaults. See option -T above.
-
- ATHSC Exit Command Mode and enter High Speed Command Mode. Once the OK response is received, the local host should send
- commands to the device at successively higher speeds until a valid response is received.
-
- ATMmessage
- Send an Atheros vendor-specific management message over powerline. The message is expressed as a series of hexa‐
- decimal digits.
-
- ATNI? Read nework information and store the information internally. Return the number of associated stations and infor‐
- mation about the first associated station. The information includes the peer station device address, TX rate and
- RX rate.
-
- ATNIstation
- Extract and display previously stored network information for a specific peer station. The information returned is
- that previosly stored using a ATNI serial line command query.
-
- ATO Exit Command Mode and enter Transparent Mode. Successful switch requires a valid destination MAC address, buffer
- size and aggregation timeout value. Use serial line commands ATDST and ATBSZ to get and/or set the first two val‐
- ues. Use serial line command ATTO to set the timeout value.
-
- ATPStime
- Place the device in Power Save Mode for a specified time in seconds. Valid values are 1 to 384 seconds. The
- default time is A seconds.
-
- ATRPlength,offset
- Read and display a parameter block segment where length is the number of bytes read and offset is the relative
- position, in bytes, from the start of the parameter block. Valid length values are 0 through 400 hexadecimal. See
- option -p above to read and save an entire parameter block.
-
- ATRPM Get PIB version and device MAC address.
-
- ATRV Get hardware and firmware revision. See option -r above.
-
- ATSK? Get device Network Membership Key. See option -m above.
-
- ATSKkey
- Set device Network Membership Key. See option -M above.
-
- ATTO? Get the Transparent Mode aggregation timeout in milliseconds.
-
- ATTOtimeout
- Set the Transparent Mode aggregation timeout in milliseconds. See option -W above.
-
- ATWNVmodule
- Update NVM with PIB and/or Firmware module. See option -C above.
-
- ATWPFmodule,length,offset,checksum,data
- Write a parameter block or firmware segment to the local powerline device where module is the module identifier,
- length is the number of bytes to write, offset is the relative position from the start of the module, checksum is
- the 1's complement of the data and data is the data to be written. Valid module identifiers are 1=FW and 2=PIB.
- Valid length values are 0 up to 400 hexadecimal. See options -N and -P above to write an entire parameter block
- or firmware images.
-
- ATZ Reset device. See option -R above.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros serial line commands are proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information is not
- available. Qualcomm Atheros reserves the right to modify command line syntax or command functionality in future firmware
- releases without any obligation to notify or compensate product or program users.
-
-EXAMPLES
- The following example places the device in Command Mode (wakeup). Serial line commands are ignored unless the device is
- in this mode so this is often the first command issued.
-
- # int6kuart -w
-
- The next example sets the destination device address on the local powerline device to 00B052BABE12. The destination
- device can be any remote powerline device on the same logical network as the local device.
-
- # int6kuart -D 00:B0:52:BA:BE:12
-
- The next example places the device in Transparent Mode where serial line output is sent over powerline to the destination
- powerline device and forwarded the remote host connected to it.
-
- # int6kuart -O
-
- The next example sends the serial line command "ATSK?" to the local powerline device.
-
- # int6kuart -c "ATSK?"
-
-SEE ALSO
- amp(1), int6kbaud(1), ttysig(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6kuart(1)
-
-int6kwait(1) Qualcomm Atheros Open Powerline Toolkit int6kwait(1)
-
-NAME
- int6kwait - Qualcomm Atheros INT6x00 Powerline Device Procrastinator
-
-SYNOPSIS
- int6kwait [options] [device] [device] [...]
-
-DESCRIPTION
- Poll a Qualcomm Atheros powerline device, waiting for one or more events to occur before continuing or returning. The
- events include reset or power off, restart or power on and network association. It is used to pause shell scripts at
- critical points where a device must be in a known state before continuing.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -a Poll the device every few seconds using VS_NW_INFO messages until the device indicates that a networks exists and
- has at least one station. This option can give false readings if other devices have dropped off-line and the
- device bridging table still holds information about them. The program always checks for this event last if other
- event options are specified.
-
- -c count
- The number of times the program will poll the device before declaring an event failure. The program will wait a
- fixed period of time between each poll attempt. Overall wait time is count/frequency where count can be modified
- using option -c. Overall wait time is always approximate since operating system overhead and latency are not
- taken into account. The default count is 300.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -f firmware
- The identification string for firmware that should be running after the device starts. This option can be used to
- detect a failed firmware load. If the actual identification string does not match this one once the device starts
- then an error is reported. If option -x is present then the program terminates with a non-zero exit code. This
- option has no effect unless option -s is present. An identification string looks like
- "INT6000-MAC-3-1-3143-1690-20071107-FINAL-B" and can be obtained using int6k -r.
-
- -i Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -p frequency
- The polling frequency expressed in polls-per-second. For example, 1 means one poll per second and 10 means ten
- polls per second. Overall wait time is count/frequency where count may be modified using option -c. Overall wait
- time is always approximate since operating system overhead and latency are not taken into account. The default
- frequency is 5.
-
- -q Enter quiet mode. Progress messages are suppressed.
-
- -r Poll the device every few seconds using VS_SW_VER messages until the bootloader or runtime firmware fails to
- respond or the poll count exhausts. The absence of a response indicates that the device either lost connection to
- the host, lost power or has reset. The program always checks for this event first when other events are speci‐
- fied.
-
- -R Reset the device then check return status. Exit program on error if option -x is present; otherwise, repeat the
- reset request until the device either accepts the request or the wait time is exceeded.
-
- -s Poll the device every few seconds using VS_SW_VER messages until the bootloader or runtime firmware responds or
- the poll count exhausts. The presence of a response indicates that the device has either connected to the host,
- received power or finished reboot.
-
- -t Display the actual time in seconds taken for successful completion, or waited for unsuccessful completion, of ecah
- event.
-
- -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
-
- -w seconds
- Additional time to wait once all events have occured. This wait does not occur if any of the events timeout.
- When no other events are specified this option is effectively equivalent to sleep. This option can be used to
- allow the device or the network to settle. For example, a nominal 5 second wait is recommended after a device
- successfully associates before attempting to transfer data.
-
- -x Exit program on first error with a non-zero exit code. This option allows shell scripts to detect failed or
- incomplete operations and take the appropriate action.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The Media Access Control (MAC) address of some device. Addresses are 6 hexadecimal octets optionally separated by
- colon. For example, the addresses "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are all valid and
- equivalent. For convenience, the symbolic address "local" resolves to "00:b0:52:00:00:01" and the symbolic
- addresses "all" and "broadcast" both resolve to "ff:ff:ff:ff:ff:ff".
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-EXAMPLES
- The following command polls the local device until firmware stops running then polls the device until firmware starts
- running again. This command can be inserted into a shell script at a point where the device must reset and reboot before
- proceeding. Observer that the program waits up to 60 seconds for each event, in turn. The 60 seconds is the product of
- 60 poll attempts spaced 1 second apart.
-
- # int6kwait -rs
- eth0 00:B0:52:BA:BA:01 Allow 60 seconds for Reset
- eth0 00:B0:52:BA:BA:01 Allow 60 seconds for Start
-
- The following example specifies 5 poll attempts spaced 10 seconds apart. Less frequent polling reduces network traffic
- but makes the program less responsive to events. Observe that the allotted time applies to each event in turn.
-
- # int6kwait -rs -p 10 -c 5
- eth0 00:B0:52:BA:BA:01 Allow 50 seconds for Reset
- eth0 00:B0:52:BA:BA:01 Allow 50 seconds for Start
-
- The next example reports the actual amount of time taken for each event to occur. Observe that the last event, device
- association, did not occur within the allotted time.
-
- # int6kwait -rsat
- eth0 00:B0:52:BA:BA:01 Allow 60 seconds for Reset
- etho 00:B0:52:BA:BA:01 Waited 22 seconds to Reset
- eth0 00:B0:52:BA:BA:01 Allow 60 seconds for Start
- etho 00:B0:52:BA:BA:01 Waited 4 seconds to Start
- eth0 00:B0:52:BA:BA:01 Allow 60 seconds for Assoc
- etho 00:B0:52:BA:BA:01 Waited 60 seconds for Assoc
- etho 00:B0:52:BA:BA:01 Device did not Assoc
-
- The following example illustrates use of the revision string to detect mismatched firmware. In this example, we reset
- the device first, using program int6k, then wait for it to reset then start up again. There are also operation that can
- cause the device to reset.
-
- # int6k -R
- # int6kwait -xrsf INT6000-MAC-3-1-3143-1690-20071107-FINAL-B
- eth0 00:B0:52:BA:BA:01 Device started wrong firmware
-
- Immediately after a reset we wait for the firmware to stop responding, with option -r, and then start responding, with
- option -s, and then perform a string comparison against the actual firmware revision string, with option -f. If the
- strings do not match then an error is reported. In this case, the program will exit with a non-zero return code since
- option -x is present.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- plc(1), int6k(1), int6kf(1), int6khost(1), int6kid(1), int6krate(1), int6krule(1), int6kstat(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 int6kwait(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 by Qualcomm Atheros.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose with or without fee is hereby granted, provided
- * that the above copyright notice and this permission notice appear
- * in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
- * THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
- * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
- * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
- * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * inttypes.h - substitute inttypes.h file for Windows;
- *
- * this is an important POSIX header that Microsoft ommits;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Mathieu Olivari <mathieu@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef INTTYPES_HEADER
-#define INTTYPES_HEADER
-
-#define PRId64 "I64d"
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * keys.h -
- *
- *. Qualcomm Atheros HomePlug AV Powerline Toolkit
- *: Copyright (c) 2009-2013 by Qualcomm Atheros Inc. ALL RIGHTS RESERVED;
- *; For demonstration and evaluation only; Not for production use.
- *
- *--------------------------------------------------------------------*/
-
-#ifndef KEYS_HEADER
-#define KEYS_HEADER
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <stdint.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#include "../tools/types.h"
-#include "../key/HPAVKey.h"
-
-/*====================================================================*
- * constants;
- *--------------------------------------------------------------------*/
-
-#define PASSWORD_SILENCE (1 << 0)
-#define PASSWORD_VERBOSE (1 << 1)
-
-#define DAK0 "00000000000000000000000000000000"
-#define DAK1 "689F074B8B0275A2710B0B5779AD1630"
-#define DAK2 "F084B4E8F6069FF1300C9BDB812367FF"
-
-#define NMK0 "00000000000000000000000000000000"
-#define NMK1 "50D3E4933F855B7040784DF815AA8DB7"
-#define NMK2 "B59319D7E8157BA001B018669CCEE30D"
-
-#define KEYS 3
-#define DAKS 6
-#define NMKS 5
-
-/*====================================================================*
- * variables;
- *--------------------------------------------------------------------*/
-
-typedef struct key
-
-{
- char const * phrase;
- uint8_t DAK [HPAVKEY_DAK_LEN];
- uint8_t NMK [HPAVKEY_NMK_LEN];
-}
-
-key;
-
-extern struct key const keys [KEYS];
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-extern struct _term_ const daks [DAKS];
-extern struct _term_ const nmks [NMKS];
-
-/*====================================================================*
- * functions;
- *--------------------------------------------------------------------*/
-
-void MACPasswords (unsigned vendor, unsigned device, unsigned count, unsigned alpha, unsigned bunch, char space, flag_t flags);
-void RNDPasswords (unsigned vendor, unsigned device, unsigned count, unsigned alpha, unsigned bunch, char space, flag_t flags);
-char * strnpwd (char buffer [], unsigned length, unsigned count, unsigned group, char space);
-void putpwd (unsigned count, unsigned group, char space);
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-
-
-
diff --git a/docbook/library.xml b/docbook/library.xml
deleted file mode 100644
index 0ab8980f..00000000
--- a/docbook/library.xml
+++ /dev/null
@@ -1,1245 +0,0 @@
-
-
- Support Function Reference
-
-
-
- Introduction
-
-
- The Atheros Open Powerline Toolkit includes many functions that have application outside the Open Powerline Toolkit. They are distributed with the toolkit but may also appear in other Atheros applications or third party packages. Consequently, we describe them separately and store them in separate folders.
-
-
-
-
-
- tools/error.h
-
-
- The functions in this group have general application beyond the Open Powerline Toolkit. In some cases, these functions may appear in other Atheros or Open Source software packages. In a few cases, the Toolkit may include complementary or supplementary support functions but only use one or two of them. For example, functions memincr and memdecr are both included but memdecr is not used.
-
-
-
- alert
-
-
-
- void alert
- const char *format
- ...
-
-
-
- This function is similar to function printf but messages are prefixed with the program name and appear on stderr instead of stdout. It is equivalent to calling function error with argument exitcode set to 0 and argument errno set to 0. A typical use is to print progress messages. The function is declared in error.h and defined in alert.c.
-
-
-
-
- error
-
-
-
- void error
- intexitcode
- errno_t number
- const char * format
- ...
-
-
-
- This function works like printf except that printed messages appear on stderr and are prefixed with the program name and error information. If argument errno is non-zero then messages are prefixed with the system error description. If argument exitcode is non-zero then function error exits the program with value exitcode after printing the message and does not return to the caller. The function is declared in error.h and defined in error.c.
-
-
-
-
-
-
- tools/files.h
-
-
-
- checkfilename
-
-
-
- bool checkfilename
- const char *filename
-
-
-
- Return logical true if the filename argument contains only letters, digits, slashes, periods, underscores and hyphens. This function can be used to detect cases where a user accidentally entered an Ethernet address in place of a filename on the command line. Ethernet address strings are, as it happens, also valid filenames. The function is declared in files.h and defined in checkfilename.c.
-
-
-
-
- filepart
-
-
-
- const char * filepart
- const char * pathname
-
-
-
- Return the address of the filename portion of a pathname string. The filename portion is everything after the rightmost path separator. If a path separator is not present then the address of the pathname string is returned. This function is similar to the POSIX basename function but it returns an empty string whenever the rightmost character is a path separator. The path separator can be either slash ('/') or backslash ('\\'). The function is declared in files.h and defined in filepart.c.
-
-
-
-
-
-
-
- tools/format.h
-
-
-
- strfbits
-
-
-
- size_t strfbits
- char buffer []
- size_t length
- const char *operands []
- const char *operator
- unsigned flagword
-
-
-
- Encode a buffer with an enumerated list of the operands associated with the corresponding bits in flagword. separate enumerated operands with an operator string. For example, given const char *operands [] = { "loop", "wait", "busy" } and unsigned flagword = 0x05 then strfbits (buffer, length, operands, "|", flagword) would encode buffer with "loop|busy". Observe that each bit set in flagword appears in buffer as the corresponding string from operands. A typical application for this function is the enumeration of flagword states. The function is declared in tools.h and defined in strfbits.c.
-
-
-
-
-
-
-
- tools/getoptv.h
-
-
-
- getoptv
-
-
-
- int getoptv
- int argc
- const char * argv []
- const char * optv []
-
-
-
- A custom version of the POSIX function getopt. It supports standard global variables optind, opterr, optopt and optarg and the non-standard variable optmin. It extracts the program name from argv[0] and posts it for use by functions alert, error and other functions using the global string pointer program_name. Options -? and --help both display program information on stdout. Options -! and --version both display program version information on stdout. String vector optv includes both the standard argument optstring and usage text found in many programs. The function is declared in getoptv.h and defined in getoptv.c.
-
-
-
-
-
-
- tools/memory.h
-
-
-
- bytespec
-
-
-
- void bytespec
- const char * string
- byte memory []
- size_t extent
-
-
-
- Encode a memory region with the binary equivalent of a fixed-length hexadecimal string. Print an error message on stderr and exit the program with status 1 if a syntax error occurs or the number of octets does not equal extent. Hexadecimal octets may be separated by colons for readability but colons are not required. Empty octets are illegal. This function is typically used to enter fixed-length data, like hardware addresses and encryption keys, on the command line. The function is declared in memory.h and defined in bytespec.c.
-
-
-
-
- checksum32
-
-
-
- unint32_t checksum32
- const uint32_t memory []
- size_t length
- uint32_t checksum
-
-
-
- Return the 32 bit checksum of a memory region. The checksum is the one's complement of the XOR of all 32 bit words in the region. Argument length is the region extent in 32 bit words. Argument checksum is the reference checksum. When the checksum argument is 0, the function value will be the computed checksum. When the checksum argument is the computed checksum, the function value will be 0 such that any other value indicates a checksum error. A typical use is to validate PIB and NVM files or compute new checksums when these files are created or modified. The function is declared in memory.h and defined in checksum32.c.
-
-
-
-
- checksum_32
-
-
-
- unint32_t checksum_32
- const void * memory
- size_t extent
- uint32_t checksum
-
-
-
- Return the 32 bit checksum of a memory region. The checksum is the one's complement of the XOR of all 32 bit words in the region. The region extent is specified in bytes but it will be rounded down to the nearest multiple of 4 bytes. Argument checksum is the reference checksum. The function will return the computed checksum when argument checksum is 0 and will return 0 if argument checksum equals the computed checksum. A typical use is to validate PIB and NVM files or compute new checksums when these files are created or modified. The function is declared in memory.h and defined in checksum_32.c.
-
-
- This function is similar to function checksum32 however there is no need to cast memory to uint32_t and there is no need to round extent down to a multiple of 4 bytes before calling the function because both operations are performed internally. Also, there is no unecessary endian manipulation of the checksum.
-
-
-
-
- decout
-
-
-
- void decout
- const byte memory []
- size_t length
- char c
- FILE *fp
-
-
-
- Print a memory region as a series of decimal octets separated by character c. Normally, character c will be DEC_EXTENDER, defined in file number.h, but it could be any character value. For example, specifying c as '.' and length as 4 would produce output looking something like "192.168.099.001" where each octet is expressed as a decimal integer. A typical use might be to print an IP or MAC address in readable format. The function is declared in memory.h and defined in decout.c.
-
-
-
-
- endian
-
-
-
- void endian
- void * memory
- size_t extent
-
-
-
- Reverse the byte order of a memory region. It is a variable length version of functions like _bswap_16, _bswap_32 and _bswap_64. The function is declared in memory.h and defined in endian.c.
-
-
-
-
- hexdecode
-
-
-
- signed hexdecode
- byte memory []
- size_t extent
- const char buffer []
- size_t length
-
-
-
- Decode a memory region as a string of ASCII hexadecimal digits. Convert memory until the buffer or memory exhausts and return the string length. Allow three (3) string characters for each memory byte to be decoded. The number of bytes decoded will be the lesser of argument length divided by 3 or argument extent. The function is declared in memory.h and defined in hexdecode.c.
-
-
-
-
- hexdump
-
-
-
- void hexdump
- const void * memory
- size_t offset
- size_t extent
- FILE * fp
-
-
-
- Print a full or partial memory region in hexadecimal format showing memory offsets, hexadecimal byte values and ASCII character values. Argument memory contains some memory region. Argument extent is the region length. Argument offset is the starting display location. Locations memory [offset] up to memory [extent] are displayed, allowing a partial dump of the memory region. An offset of 0 will display the entire region. The function is declared in memory.h and defined in hexdump.c.
-
-
- This function is similar to but different from function hexview .
-
-
-
-
- hexencode
-
-
-
- signed hexencode
- byte memory []
- size_t extent
- const char * string
-
-
-
- Encode a memory region with the binary equivalent of an ASCII hexadecimal string. Return the number of bytes encoded or 0 on error. The value of errno is set to EINVAL if the number of bytes encoded is less than extent or the entire string cannot be converted due to illegal digits or excessive digits. Ignore optional HEX_EXTENDER characters separating octets in argument string. Constant HEX_EXTENDER is defined in file number.h. The function is declared in memory.h and defined in hexencode.c.
-
-
-
-
- hexin
-
-
-
- void hexin
- const byte memory []
- size_t extent
- FILE *fp
-
-
-
- This function is similar to hexencode but it reads from file, instead of a string, and ignores any non-hexadecimal text and comments embedded within the input stream. Incoming text is binary encoded and written to the specified memory region. Reading terminates on the next occurance of a semicolon or end of file. The actual number of bytes encoded is returned. The function is declared in memory.h and defined in hexin.c.
-
-
-
-
- hexout
-
-
-
- void hexout
- const byte memory []
- size_t length
- char c
- FILE *fp
-
-
-
- Print a memory region as a series of decimal octets separated by character c. Normally, character c will be HEX_EXTENDER, defined in file number.h, but it could be any character value. For example, specifying c as ':' and length as 6 would produce output looking something like "00:B0:52:DA:DA:01" where each octet is expressed as a hexadecimal integer. A typical use might be to print a MAC or Ethernet address in readable format. The function is declared in memory.h and defined in hexout.c.
-
-
-
-
- hexstring
-
-
-
- char * hexstring
- char buffer []
- size_t length
- const byte memory []
- size_t extent
-
-
-
- Convert a memory region to a NUL terminated string and return the string address. This function is identical to function hexdecode but it return the string address instead of the number of characters decoded. The function is declared in memory.h and defined in hexstring.c.
-
-
-
-
- hexview
-
-
-
- void hexview
- const void * memory
- size_t offset
- size_t extent
- FILE * fp
-
-
-
- Print a partial memory region in hexadecimal format showing memory offsets, hexadecimal byte values and ASCII character values. Argument memory contains part of a larger memory region, much like a file window. Argument extent is the window length. Argument offset is the relative offset of the window within the region. Locations memory [0] up to memory [extent] are displayed as a partial dump, providing a window into the region. The function is declared in memory.h and defined in hexview.c.
-
- This function is similar to but different from function hexdump.
-
-
-
-
- ipv4spec
-
-
-
- size_t ipv4spec
- const char * string
- byte memory []
-
-
-
- Encode a 4-byte memory region with an IPv4 dotted-decimal string and return the number of bytes encoded. Terminate the program with an error message and exitcode of 1 on conversion error. The value returned by this function is always 4 and memory is always encoded in network byte order. This function is typically used to convert IPv4 strings entered as command line arguments. The function is declared in memory.h and defined in ipv4spec.c.
-
-
- Dotted-decimal format consists of decimal values in the range 0 through 255. Each value represents one octet or 8-bit value. IPv4 addresses require 4 such values separated by one decimal point. This function permits empty octets and leading zeros within octets. For example, ... is equivalent to 0.0.0.0 and 127.0.000.001 is equivalent to 127.0.0.1. The second example will encode memory as follows { 0x7F, 0x00, 0x00, 0x01 } which is in network byte order, or big endian.
-
-
-
-
- ipv6spec
-
-
-
- size_t ipv6spec
- const char * string
- byte memory []
-
-
-
- Encode a 16-byte memory region with an IPv6 colon-separated hexadecimal quartet string and return the number of bytes encoded. Terminate the program with an error message and exitcode of 1 on conversion error. The value returned by this function is always 16 and memory is always encoded in network byte order. This function is typically used to convert IPv6 strings entered as command line arguments. The function is declared in memory.h and defined in ipv6spec.c.
-
-
- Colon-separated hexadecimal quartet notation consists of hexadecimal values in the range 0 through FFFF. Each value represents a quartet or a 32-bit value. IPv6 addresses require 8 quartets separated by one colon. By convention, an empty quartet expands with enough zeros to right-justify the remainder of the address. This function permits multiple empty quartets and leading zeros within quartets. When multiple empty quartets appear, only the right-most occurance expands to zeros. For example, AA12::BB34::CC56::DD78 is equivalent to AA12:0000:BB34:0000:CC56:0000:0000:DD78 because only the right-most empty field expands. This will encode memory as follows { 0xAA, 0x12, 0x00, 0x00, 0xBB, 0x34, 0x00, 0x00, 0xCC, 0x56, 0x00, 0x00, 0x00, 0x00, 0xDD, 0x78 } which is in network byte order, or big-endian.
-
-
-
-
- memdecr
-
-
-
- signed memdecr
- byte memory []
- size_t length
-
-
-
- Decrement a multi-byte memory region. Return 0 on success or -1 if all bytes have decremented to 0x00. For example, { 0xFF, 0xFF, 0xFF } decrements to { 0xFF, 0xFF, 0xFE } and { 0xFF, 0x00, 0x00 } decrements to { 0xFE, 0xFF, 0xFF }. A typical use is to iterate through a range if IP or MAC address values. The function is declared in memory.h and defined in memdecr.c.
-
-
-
-
- memincr
-
-
-
- signed memincr
- byte memory []
- size_t length
-
-
-
- Increment a multi-byte memory region. Return 0 on success or -1 once all bytes have been incremented to 0xFF. For example { 0x00, 0x00, 0x00 } increments to { 0x00, 0x00, 0x01 } and { 0x00, 0xFF, 0xFF } increments to { 0x01, 0x00, 0x00 }. A typical use is to iterate through a range of IP or MAC address values. The function is declared in memory.h and defined in memincr.c.
-
-
-
-
- memswap
-
-
-
- void memswap
- void * buffer1
- void * buffer2
- size_t length
-
-
-
- Exchange the contents of one buffer with that of another. No provision is made for buffer overlap. No value is returned. A typical use might be to exchange source and destination addresses in an ethernet packet. The function is declared in memory.h and defined in memswap.c.
-
-
-
-
- strdecr
-
-
-
- signed strdecr
- byte memory []
- size_t length
- byte min
- byte max
-
-
-
- Decrement a multi-byte memory region using only ASCII character values in the range min through max. Return 0 on success or -1 once all characters have been decremented to the value of argument min. For example, if argument min is 'A' and argument max is 'Z' then { 'A', 'B', 'C' } decrements to { 'A', 'B', 'B' } and { 'B', 'Z', 'Z' } decrements to { 'A', 'A', 'A' }. A typical use is to generate a sequence of distinct character strings to seed encryption key functions. The function is declared in memory.h and defined in strdecr.c.
-
-
-
-
- strincr
-
-
-
- signed strincr
- byte memory []
- size_t length
- byte min
- byte max
-
-
-
- Increment a multi-byte memory region using only ASCII character values in the range min through max. Return 0 on success or -1 once all characters have been incremented to the value of argument max. For example, if argument min is 'A' and argument max is 'Z' then { 'A', 'B', 'C' } increments to { 'A', 'B', 'D' } and { 'A', 'Z', 'Z' } increments to { 'B', 'A', 'A' }. A typical use is to generate a sequence of distinct character strings to seed encryption key functions. The function is declared in memory.h and defined in strincr.c.
-
-
-
-
-
-
-
-
- tools/number.h
-
-
-
- todigit
-
-
-
- unsigned todigit
- unsigned c
-
-
-
- Return the integer value of character c interpreted as digit in the base 36 number system. It is called by many encode functions to support number base conversion. If the value of c is '0' through '9' then integer 0 through 9 is returned. If the value of c is 'A' through 'Z' or 'a' through 'z' then integer 10 through 35 is returned. The function is declared in number.h and defined in todogit.c.
-
-
-
-
- basespec
-
-
-
- uint64_t basespec
- const char * string
- unsigned base
- unsigned size
-
-
-
- Return the unsigned integer equivalent of a numeric string. Print an error message on stderr and exit the program with status 1 if a syntax error occurs or the result exceeds the capacity of the requested integer size in bytes. If base is 0, numeric values may be expressed in decimal, hexadecimal or binary notation where hexadecimal values start with "0x" and binary values start with "0b". When base is non-zero, the notation in string must conform to the corresponding number base rules. Applications should cast the return value to the appropriate data type prevent loss-of-data compiler warnings. This function is typically used to convert and length-check integers entered as command line arguments. The function is declared in number.h and defined in basespec.c.
-
-
- Like function uintspec, this function both converts and range checks numeric string values, but the minimum and maximum value are implicit in the size of the integer. The minimum value is always 0 and the maximum value can be computed by ((1 << size << 3) - 1).
-
-
-
-
- dataspec
-
-
-
- void dataspec
- const char * string
- byte memory []
- size_t extent
-
-
-
- Encode a memory region with the binary equivalent of a variable-length hexadecimal string. Print an error message on stderr and exit the program with the status 1 if a syntax error occurs or the number of octets exceeds extent. The number of octets may, however, be less than extent. Unlike function bytespec, hexadecimal octets may not be separated by colons. This function is typically used to enter variable-length data from the command line. The function is declared in memory.h and defined in dataspec.c.
-
-
-
-
- uintspec
-
-
-
- uint64_t uintspec
- const char * string
- uint64_t minimum
- uint64_t maximum
-
-
-
- Return the unsigned integer equivalent of a numeric string. Print an error message on stderr and exit the program with the value 1 when a syntax error occurs or the result exceeds the specified minimum or maximum value. Numeric values may be expressed in decimal, hexadecimal or binary notation where hexadecimal values start with "0x" and binary values start with "0b". Applications should cast the return value to the appropriate data type to avoid loss-of-data warnings on some compilers. This function is typically used to convert and range-check integer values entered as command-line arguments. The function is declared in number.h and defined in uintspec.c.
-
-
-
-
-
-
-
- tools/symbol.h
-
-
-
- assist
-
-
-
- void assist
- const char * name
- const char * type
- const struct _code_ list []
- size_t size
- FILE * fp
-
-
-
- Show why a symbolic name was rejected by function lookup or similar functions. Argument type contains a title for the class of names stored in list. This function prints an error message on file stream fp showing the program name, the type string, the symbolic name and all names stored in the list. The _code_ structure is declared in types.h. The function is declared in symbol.h and defined in assist.c. Function expect is used to print list names.
-
-
-
-
- expect
-
-
-
- void expect
- const struct _code_ list []
- size_t size
- FILE * fp
-
-
-
- Display all names in argument list on file stream fp. This function is called by runction assist to print the list of symbolic names but other function may have use for it. The _code_ structure is declared in types.h. The function is declared in symbol.h and defined in expect.c.
-
-
-
-
- lookup
-
-
-
- signed lookup
- const char * name
- const struct _code_ list []
- size_t size
-
-
-
- Lookup a symbolic name in a list and return an associated integer or -1 if the name does not appear in the list. A typical use is the translation of symbolic command line arguments to integer codes. For example, some Toolkit programs assign symbolic names to field codes so that users can enter names instead of numbers. This approach becomes more useful as the number of permitted codes increases. The _code_ structure is declared in types.h. The function is declared in symbol.h and defined in lookup.c.
-
-
- This function offers two benefits: 1) multiple symbols can translate to one code and 2) names can be changed or new names added without affecting program logic. This function is similar to but different from function synonym which returns a character string instead of an integer.
-
-
-
-
- synonym
-
-
-
- const char * synonym
- const char * string
- const struct _term_ list []
- size_t size
-
-
-
- Lookup a symbolic name in a list and return an associated string or the original string if the name does not appear in the list. A typical use is the translation of symbolic command line arguments to their equivalent numeric strings before encoding them. For example, many Toolkit programs convert the command line argument local to 00:B0:52:00:00:01 before encoding the device MAC address. The _term_ structure is declared in types.h. The function is declared in symbol.h and defined in synonym.c.
-
-
- This function is similar to but different from function lookup which returns an integer instead of a character string.
-
-
-
-
- typename
-
-
-
- const char * typename
- const struct _type_ list []
- size_t size
- type_t type
- const char * name
-
-
-
- Return the name associated with a message type by searching a list arranged in ascending order by message type. Return argument name as the function value if the message type is not present in the list. Data types struct _type_ and type_t are defined in file types.h. A typical use might be to return the name of message based on the message type. The function is declared in tools.h and defined in typename.c.
-
-
-
-
-
-
-
-
-
- tools/putoptv.h
-
-
-
- putoptv
-
-
-
- void putoptv
- const char * optv []
-
-
-
- Print program information on stdout. Program information is stored in string vector optv. String indexes are defined in file putoptv.h. String optv[0] is the POSIX standard argument optstring. This function is called by function getoptv whenever option -? or --help is detected on the command line. There is virtually no need to call this function directly. The function is declared in putoptv.h and defined in putoptv.c.
-
-
-
-
-
-
- tools/version.h
-
-
-
- version
-
-
-
- void version
-
-
-
-
- Print package and program version information on stdout. This function is called by function getoptv whenever option -! or --version is detected on the command line. There is virtually no need to call this function directly. The function is declared in version.h and defined in version.c. Constants PACKAGE and VERSION define the information that is displayed. They are defined in file version.h and must be maintained by developers.
-
-
-
-
-
-
- mme/mme.h
-
-
-
- MMECode
-
-
-
- const char *MMECode
- uint16_t MMTYPE
- uint8_t MSTATUS
-
-
-
- Return text that explains the status code for a given Atheros vendor-specific management message. Argument MMTYPE is an unsigned integer in the range 0xA000 through 0xAFFF and must exactly match the MMTYPE of the message returning the status code. For example, the CNF variant of a message is currently the only variant that has an MSTATUS field and so other variants return a default string. The function is declared in mme.h and defined in MMECode.c.
-
-
- Inclusion of this function can increase application size by 3kb because the text associated with all Atheros vendor-specific management messages and errors are included whether needed or not. Conditional compilation statements are provided internally to suppress the full table with a terse substitute.
-
-
- Although the Bootloader and firmware share some common Vendor Specific Management Messages, the two programs may return different codes for a given message and error condition. Where there are conflicts, Bootloader codes take precedence over firmware codes because it is unlikely that users will .issue the same messages to a device running firmware.
-
-
-
-
- MMEMode
-
-
-
- const char *MMEMode
- uint16_t MMTYPE
-
-
-
- Return the mode of a given management message type as a string. The mode is determined by the two least significant bits of argument MMTYPE. The mode string will be one of REQ, CNF, IND or RSP. The function is declared in ihp.h and defined in MMEMode.c.
-
-
- Most management messages have a request and a confirmation variant while a few have an indication and a response variant. Requests originate from the host and are acknolwedged by a confirmation from the device. Indications originate from a device and are acknowledged by a response from the host.
-
-
-
-
- MMEName
-
-
-
- const char *MMEName
- uint16_t MMTYPE
-
-
-
- Return the name associated with a given management message type. The name is the mnemonic used to distinguish one message type from another in the HomePlug AV Specification or Atheros Firwmare Technical Reference Manual. Argument MMTYPE is an unsigned integer in the range 0x0000 through 0xAFFF. The request, confirmation, indication and response variants of a management message will all return the same message name. The function is declared in mme.h and defined in MMEName.c.
-
-
-
-
- MMEPeek
-
-
-
- void MMEPeek
- const byte memory []
- size_t length
- size_t length, FILE *fp
-
-
-
- Prints an Atheros vendor-specific management message to stream fp in human readable format. Argument buffer is the message address and argument length is the message length in bytes. Output consists of a formatted header showing decoded header. The function is declared in mme.h and defined in MMEPeek.c.
-
-
-
-
-
-
-
- crypt/keys.h
-
-
-
- MACPasswords
-
-
-
- void MACPasswords
- uint32_tvendor
- uint32_tdevice
- uint32_tnumber
- unsigned count
- unsigned bunch
- unsigned space
- flag_t flags
-
-
-
- Print a range of device addresses and user passwords on stdout. The calling application must split the starting device address into a three-byte OUI and three-byte device number and pass them as the unsigned 32-bit integers vendor and device, respectively. Argument device is the first device number in the range and number is the final device number. Argument count is the number of uppercase letters comprising a password. Passwords contain this many letters but the letters are grouped for easy reading. Letter groups are separated by hyphens. Argument bunch defines how many letters form each group. Argument space is the character used to separate groups of letters. Argument flags enables or disables function features such as insertion of a used flag for use by the Atheros Production Test System or the omission of the device address on output. The output of this function is similar to that produced by the DB Builder utility distributed with the PTS. This function is declared in keys.h and defined in MACPasswords.c.
-
-
-
-
-
-
- crypt/HPAVKey.h
-
-
-
- HPAVKeyDAK
-
-
-
- void HPAVKeyDAK
- byte DAK []
- const char string
-
-
-
- Encode buffer DAK with the Device Access Key (DAK) derived from the NUL terminated string. The string is salted, hashed and re-hashed using the SHA256 algorithm. The DAK is always HPAVKEY_DAK_LEN bytes, defined in HPAVKey.h, so no length argument is needed. See the HomePlug AV Specification for more information. This function is declared in HPAVKey.h and defined in HPAVKeyDAK.c.
-
-
-
-
- HPAVKeyNMK
-
-
-
- void HPAVKeyNMK
- byte digest []
- const char string
-
-
-
- Encode buffer NMK with the Network Membership Key (NMK) derived from the NUL terminated string. The string is salted, hashed and re-hashed using the SHA256 algorithm. The DAK is always HPAVKEY_NMK_LEN bytes, as defined in HPAVKey.h, so no length argument is needed. See the HomePlug AV Specification for more information. This function is declared in HPAVKey.h and defined in HPAVKeyNMK.c.
-
-
-
-
- HPAVKeyNID
-
-
-
- void HPAVKeyNID
- byte NID []
- const byte NMK []
- signed level
-
-
-
- Encode buffer NID with the Network Identification Key (NID) derived from the 16-byte Network Membership Key (NMK). The NMK is hashed and re-hashed using the SHA256 algorithm then encoded with the security level. The NID is always HPAVKEY_NID_LEN bytes, as defined in HPAVKey.h, so no length argument is needed. See the HomePlug AV Specification for more information. This function is declared in HPAVKey.h and defined in HPAVKeyNID.c.
-
-
-
-
- HPAVKeyOut
-
-
-
- void HPAVKeyOut
- const byte digest []
- size_t length
- const char * phrase
- flag_t flags
-
-
-
- Decode and print up to length bytes from buffer digest on stdout. Print NUL terminated phrase on the same line following the digest when bit HPAVKEY_VERBOSE, defined in HPAVKey.h, is set in flags. This procedure prints keys and phrases in a standard column-oriented format that other applications can easily read and use. This function is declared in HPAVKey.h and defined in HPAVKeyOut.c.
-
-
-
-
-
- crypt/SHA256.h
-
-
-
- SHA256Block
-
-
-
- void SHA256Block
- struct sha256 *sha256
- const byte buffer []
-
-
-
- Merge one 64 byte block of information into the current SHA256 digest. This function performs the core computations required by the SHA256 algoithm. It is called by function SHA256Fetch and there is no reason to call this function directly. This function is declared in SHA256.h and defined in SHA256Block.c. The sha256 structure is defined in SHA256.h.
-
-
-
-
- SHA256Fetch
-
-
-
- void SHA256Fetch
- struct sha256 *sha256
- byte digest []
-
-
-
- Conclude SHA256 computation and copy the result to the specified 32-byte digest buffer. The digest is always 32 bytes long regardless of the amount of information written using function SHA256Write. The sha256 structure is defined in SHA256.h. This function is declared in SHA256.h and defined in SHA256Fetch.c.
-
-
-
-
- SHA256Ident
-
-
-
- void SHA256Ident
- int fd
- byte digest []
-
-
-
- Compute the SHA256 digest from the content of a file. The digest serves as the file fingerprint and can be used to identify identical content despite filename changes. File descriptor fd is the subject file which must be positioned to the start befor calling this function. Buffer digest will be written with the computed 256-digest and must be SHA256_DIGEST_SIZE bytes long, as defined in SHA256.h. This function is declared in SHA256.h and defined in SHA256Ident.c.
-
-
-
-
- SHA256Match
-
-
-
- void SHA256Match
- int fd
- const byte digest []
-
-
-
- Search a registry file for a known SHA256 digest. Return true on success or false on failure. File descriptor fd is the registry file which must be positioned to the start before calling this function. Buffer digest contains the known 256-bit digest and must be SHA256_DIGEST_SIZE bytes long, as defined in SHA256.h. A registry file consists of 64-digit hexadecimal strings that represent SHA256 digest values. Optional text may be appear between the digest and newline to document digest significance. This function ignores such text. This function is declared in SHA256.h and defined in SHA256Match.c.
-
-
-
-
- SHA256Print
-
-
-
- void SHA256Print
- const byte digest []
- const char * string
-
-
-
- Print an SHA256 digest and optional string on stdout. Buffer digest must be SHA256_DIGEST_SIZE bytes long, as defined in SHA256.h, which results in 64 hexadecimal digits on output. Variable length string is NUL terminated but may be NULL. If string is not NULL and is not empty then a space is inserted between the digest and the string on output. This function may be used to print SHA256 digests and optional strings in standard format, such as a registry file. This function is declared in SHA256.h and defined in SHA256Print.c.
-
-
-
-
- SHA256Reset
-
-
-
- void SHA256Reset
- struct sha256 *sha256
-
-
-
- Initialize a sha256 structure before computing a new SHA256 digest. This function should be called once before calling SHA256Write for the first time for a given digest. The sha256 structure is defined in SHA256.h. This function is declared in SHA256.h and defined in SHA256Reset.c.
-
-
-
-
- SHA256Write
-
-
-
- void SHA256Write
- struct sha256 *sha256
- const byte buffer []
- size_t length
-
-
-
- Writes a variable-length block of information to the current SHA256 digest contained in an sha256 structure. An application may call this function any number of times to concatinate multiple blocks of information before fetching the digest with function SHA256Fetch. The sha256 structure is defined in SHA256.h. This function is declared in SHA256.h and defined in SHA256Write.c.
-
-
-
-
-
-
-
-
- nodes/node.h
-
-
-
- xmledit
-
-
-
- signed xmledit
- struct node *node
- byte buffer []
- size_t length
-
-
-
- Write data into buffer based on offset and length values defined in XML parse tree, node. This function will not apply modifications having malformed structure or having an invalid or an illegal offset, length or data value. Use function xmlschema to print the current schema. The function is declared in node.h and defined in xmledit.c. The node structure is defined in node.h.
-
-
-
-
- xmlfree
-
-
-
- void xmlfree
- struct node *node
-
-
-
- Release memory associated with an XML parse tree. The function is declared in node.h and defined in xmlfree.c. The node structure is defined in node.h.
-
-
- The text member if the parse tree root node points to memory allocated by xmlscan to store the original XML string. The application must either deallocate that memory before calling this function or store the text address and deallocate that memory after calling this function; otherwise, memory leaks will result.
-
-
-
-
- xmlnode
-
-
-
- struct node *xmlnode
- struct node *node
-
-
-
- Create an empty node blow the specified node and return a pointer to it. A typical application can be seen in function xmlscan.c. The function is declared in node.h and defined in xmlnode.c. The node structure is defined in node.h.
-
-
-
-
- xmlopen
-
-
-
- struct node *xmlopen
- const char *filename
-
-
-
- Open the named XML file, parse it and return the XML parse tree. The parse tree contains, among other things, all XML elements, attributes and values specified in the file. The function is declared in node.h and defined in xmlopen.c. The node structure is defined in node.h.
-
-
- The returned parse tree is ready to traverse using struct node members above, below, prior and after. Each node has a line, type and test member. This function calls function xmlscan to parse the file and generate the tree. The parse tree can be inspected by passing the root node to function xmltree.
-
-
-
-
- xmlscan
-
-
-
- signed xmlscan
- struct node *node
-
-
-
- Scan the XML string attached to the specified node and create a parse tree below it. Return 0 if parsing is successrul or -1 if not. The function is declared in node.h and defined in xmlscan.c. The node structure is defined in node.h.
-
-
- The application must point the text member to a copy of the XML string before calling this function because parsing is destructive and requires write access to the string. The application can search and manipulate the tree on return. The application should deallocate string memory before calling xmlfree.
-
-
-
- XML Source File
-
-
- The following is sample input to function xmlscan. The element and attribute names shown are for illustration and were selected to that they can be easily identified in the output. The parse tree from this file can be seen in the example for function xmltree.
-
-
-
-
-
- 1234567890
-
-
- The quick brown fox jumped over the lazy dog.
-
-
-
-
-
-
- The quick brown
- fox jumped over
- the lazy dog.
-
-
-
-
-
-
- value2
-
-
-
-]]>
-
-
-
-
- xmlschema
-
-
-
- void xmlschema
-
-
-
-
- Print an XML schema that supports function xmledit on stdout. This function has no argument. The schema produced by this function is guaranteed to support the parse logic implemented by function xmledit. Scheme element names are defined as constants in node.h so that they can be referenced by applications that create their own XML edit instructions. The function is declared in node.h and defined in xmlschema.c.
-
-
- The text member in the parse tree root node points to memory allocated by xmlscan to store the original XML string. The application must either deallocate that memory before calling this function or store the text address and deallocate that memory after calling this function; otherwise, memory leaks will result.
-
-
-
- XML Edit Schema
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-]]>
-
- The schema shown above was produced by function xmlschema. It is should be used to validate XML edit instructions before submitting them to program pxe.
-
-
-
-
-
- xmltree
-
-
-
- void xmltree
- struct node *node
-
-
-
- Print the XML parse tree on stdout. The function is declared in node.h and defined in xmltree.c.
-
-
-
- XML Parse Tree
-
-
- The following is sample output from function xmltree. The XML source is shown in the example for function xmlscan . The numbers appearing down the left margin indicate the input line number from the XML source file parsed by function xmlscan . The character codes indicate the node type and are defined in node.h. The node structure is defined in node.h.
-
-] [1234567890]
-006 [/] [attribute]
-007 [<] [attribute]
-007 [ ] [name]
-007 [=] [Attribute2]
-008 [>] [The quick brown fox jumped over the lazy dog.]
-009 [/] [attribute]
-010 [/] [element]
-011 [<] [element]
-011 [ ] [name]
-011 [=] [Element2]
-012 [<] [attribute]
-012 [ ] [name]
-012 [=] [Attribute1]
-013 [/] [attribute]
-014 [<] [attribute]
-014 [ ] [name]
-014 [=] [Attribute2]
-015 [>] [The quick brown fox jumped over the lazy dog.azy]
-018 [/] [attribute]
-019 [/] [element]
-020 [!] [-- comments can go anywhere --]
-021 [<] [element]
-021 [ ] [name]
-021 [=] [Element2]
-022 [<] [attribute]
-022 [ ] [name]
-022 [=] [Attribute1]
-023 [<] [attribute]
-023 [ ] [name]
-023 [=] [Attribute2]
-024 [>] [value2]
-025 [/] [attribute]
-026 [/] [element]
-027 [/] [xmlfile]
-]]>
-
-
-
-
-
- scan/scan.h
-
-
-
- scaninput
-
-
-
- void scaninput
- struct scan * content
- const char buffer []
- signed length
-
-
-
- Initializes a SCAN structure for scanning by pointing the structure a buffer of given length, resetting intermmediate pointers and clearing the token class code.
-
-
-
-
diff --git a/docbook/lists.xsl b/docbook/lists.xsl
deleted file mode 100644
index 072a3499..00000000
--- a/docbook/lists.xsl
+++ /dev/null
@@ -1,1087 +0,0 @@
-
-
-
-
-
-
-
-
-
-mac2pw(1) Qualcomm Atheros Open Powerline Toolkit mac2pw(1)
-
-NAME
- mac2pw - Qualcomm Atheros Ethernet Device Password Generator
-
-SYNOPSIS
- mac2pw [options] address [address] [...]
-
-DESCRIPTION
- Print a range of consecutive Ethernet addresses and passwords on stdout such that each device has a unique password.
- Program output is suitable as input to the Qualcomm Atheros HomePlug AV Production Test System or may be used in custom
- production systems. A starting address and an address range are specified. Computed passwords consist of upper case
- letters and digits with optional group separators. Output consists of address/password pairs in text format.
-
- This program is designed to generate passwords for a large number of consecutive device addresses. It complements pro‐
- gram mac2pwd which generates passwords for non-consecutive device addresses occurring in unspecified order.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-CAVEATS
- Atheros provides this program as a simple means of generating unique device passwords for a large volume of Ethernet
- devices. Two different password algorithms are implemented but neither one is required for HomePlug AV compliance. Ven‐
- dors are free to use other methods to generate their own device passwords and are encouraged to do so.
-
- Random Method
- Generate passwords based on system entropy. A different set of passwords is generated for a given address range
- with each program execution. There is no correlation at between addresses and passwords. This method is secure
- but requires care when programming and labelling devices at the factory. It may be necessary to maintain a data‐
- base if regular device maintenance and firmware upgrade are needed.
-
- Device Method
- Generate passwords based on device address. The same set of passwords will be generated for a given address range
- with each program execution. This method may be appropriate on system where regular maintenance and firmware
- updates are required. This method is not secure because device addresses can be determined using a variety of
- network management programs. Anyone having access to this program, or the algorithm, could compute the device
- password and gain access to device features reserved for privileged users. This program does provide features to
- mitigate the risks of using this method.
-
-OPTIONS
- -b bunch
- The password bunching factor. Passwords consists of count uppercase letters and digits optionally displayed in
- groups separated by hyphens. The bunching factor specifies the number of letters and digits in each group. When
- bunch is 0 or greater than count, bunching is suppressed. Separating hyphens increase overall password length.
- The minimum is 0 and the maximum is 255. The default is 0 which suppresses bunching.
-
- -e Compute passwords based on host system entropy. Passwords consist of uppercase letters [A-Z] optionally grouped
- using option -b. This method produces a non-repeatable set of unique passwords over a given address range. This
- method is the default and is secure.
-
- -l count
- The number of letters in the password string. Overall password length is the sum of count plus the number of
- delimiters implied by bunch. The minimum is 12 and the maximum is 64. The default is 16.
-
- -m Compute passwords based on target device address. Passwords consist of uppercase letters [A-Z]. This method pro‐
- duces a repeatable set of unique passwords over a given address range. This method is not secure.
-
- -n number
- The number of consecutive addresses and passwords to compute and print. The minimum is 0 and the maximum is
- 1677215 or 0xFFFFFF. The default is 1. In addition, number cannot exceed the remaining available addresses in
- the vendor range. For example, given start address 00:B0:52:FF:FF:00, there are only 255 remaining addresses in
- the 00:B0:52 vendor range so it would be an error to request more than that number.
-
- -q Quiet mode. Exclude the device address on output. This option can be used in scripts to return the password
- associated with a given device address.
-
- -v Verbose mode. Prefix each line with a '0' column. The Atheros Production Test System (PTS) uses the first column
- of a password database file to indicate which addresses and passwords have already been used.
-
- -?,--help
- Print program help information on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- address
- The first Ethernet address expressed as 12 consecutive hexadecimal digits. Puncutation is not permitted. The
- final address of the range is computed by adding number to this address. This argument is required. There is no
- default address. If more than one device address is specified then an address/password series will be computed
- for each.
-
-EXAMPLES
- The following example prints the given device address and a random password string on stdout. The default password
- length is 25 characters long but the length can be changes using option -l.
-
- # mac2pw 00B052000001
- 00B052000001 5KAXCQFQNN4PPNC76XN2YUWMS
-
- Repeating the command will generate a new password string. This is the default behaviour and is the same as specifying
- option -e for "entropy".
-
- # mac2pw 00B052000001
- 00B052000001 CA35TM5JLG4S6XBKSM3HSU6J4
-
- This example ommits the device address. Repeating the command produces a new password string.
-
- # mac2pw 00B052000001 -q
- 2LJ6P5JPEHE6V63GZWC337Q8E
- # mac2pw 00B052000001 -q
- 5Z8J7EGGL2HJDKMZ978W8V94W
-
- The next example shows how to generate passwords for three different devices with one command. The program generates a
- password for each device address specified on the command line.
-
- # mac2pw 00B052000001 00B05200BABE 00B05200DEAD
- 00B052000001 NJHWXEFRPVVW87C9J4BQEHYYE
- 00B05200BABE 5PT9Z64Z4TVRPEJCK8LR2XFMR
- 00B05200DEAD 7R2LJYGJB42329AS4NM29H8V4
-
- The next example prints 10 consecutive device addresses and random passwords on stdout. The starting device address is
- given and option -n specifies the number of addresses to print. Output can be piped to a file or another process.
-
- # mac2pw 00B052000001 -n 10
- 00B052000001 LEKWS42VX92YR3LLL6KBD5RCG
- 00B052000002 BHYKXG3VEVXNZ7CF2UERCU4G6
- 00B052000003 UBP87NFZMMW5WY8KK5GJFAWS3
- 00B052000004 CU7Y7JKFNASS6E4GQ3XL3HWGZ
- 00B052000005 9RN3WTXAQUXV8THZUB898ZGB3
- 00B052000006 HCXNPW2CM9JVHBJN2TZVRVDU6
- 00B052000007 DFD5QY5HATC5NFC5SF3AWL2PD
- 00B052000008 837GAN4HSG9U6TTRCPRXMG84T
- 00B052000009 HBLZHG32FSZKQ8TANGK5U8DS9
- 00B05200000A KEY9D3DW66HX68AWZRCD4VPD9
-
- The following example prints 10 consecutive device addresses and passwords but inserts a 0 at the start of each line to
- indicate that the address and password have not been used. The Qualcomm Atheros Production Test System (PTS) will set
- the 0 to 1 after it programs a device. This format is simlar to PTS DBBuilder Utility output.
-
- # mac2pw 00B052000006 -n 10 -v
- 0 00B052000006 VZNKWJUHAV2687NV6EJYUVQ4D
- 0 00B052000007 RENKKWRNFLU4ZNZ3P6K4SZ4PG
- 0 00B052000008 NEL6LL2V2YZAL2Q27E2DJ25BG
- 0 00B052000009 MYX2T5HM68T5JCK7YYJNDWH2P
- 0 00B05200000A 6UY4MPYP43GXSD39VLTNZCJEZ
- 0 00B05200000B MD47KPFZLSNL9XRLJTN3MKJ5N
- 0 00B05200000C BKVTVYE47LE4DKMUNQPPXR7HL
- 0 00B05200000D RBJ8DA5DB48TZUTAQXZ9CPFTM
- 0 00B05200000E HSK6N9ZGZPGV4T5YXST4DH3W8
- 0 00B05200000F BLW8QQ4JMEVSQJYHRPBDGG5RS
-
- The next example prints 10 consecutive device addresses and passwords, as before, but changes password length and charac‐
- ter bunching. Option -l specifies 12 characters and option -b specifies a bunching factor of three.
-
- # mac2pw 00B052000001 -n 10 -l 12 -b 3
- 00B052000001 S2J-V4B-NB6-37M
- 00B052000002 QEX-292-CYF-AVV
- 00B052000003 5VH-2KR-FYP-EVH
- 00B052000004 NYU-TPB-ZK3-6H6
- 00B052000005 MGX-GB7-P2P-42B
- 00B052000006 DDM-UD8-8NS-BZA
- 00B052000007 MLZ-86G-F4G-MS8
- 00B052000008 DTY-U8D-DT8-3G2
- 00B052000009 6BY-WVU-GB9-UEB
- 00B05200000A TX3-NUS-TKM-LVL
-
- The next example prints 10 consecutive device addresses and passwords, as before, but starts from a different device
- address. We specified option -m so that passwords are generated based on the MAC address. This ensures that the same
- password is generated each time for a given device address. We also specified password length or 16 characters using
- option -l and bunching factor of 4 with option -b.
-
- # mac2pw 00B052000001 -m -l 16 -b 4 -n 10
- 00B052000001 HBXY-FVHN-COML-MVLY
- 00B052000002 KYCC-KFFD-BHCN-CSUL
- 00B052000003 LQXF-TULV-IOQB-SKJI
- 00B052000004 SOBX-FRNC-EIHL-KBPW
- 00B052000005 XPAC-KESG-MDYY-OFPQ
- 00B052000006 SFTQ-DWEF-GHYC-VOWW
- 00B052000007 NNZQ-FCTW-VQLG-ESBV
- 00B052000008 SEPC-KYYS-JZEO-HHVT
- 00B052000009 OYPS-DSDV-QILZ-JYOV
- 00B05200000A HQYV-FIWJ-CJDZ-XPNZ
-
- The following example prints 10 consecutive device addresses and passwords, as before, but starts from a different device
- address. The address range here overlaps the range shown above but identical device addresses have identical passwords.
- Address based passwords may be of interest on large private networks requireing frequent firmware upgrades or device con‐
- figuration.
-
- # mac2pw 00B052000006 -m -l 16 -b 4 -n 10
- 00B052000006 SFTQ-DWEF-GHYC-VOWW
- 00B052000007 NNZQ-FCTW-VQLG-ESBV
- 00B052000008 SEPC-KYYS-JZEO-HHVT
- 00B052000009 OYPS-DSDV-QILZ-JYOV
- 00B05200000A HQYV-FIWJ-CJDZ-XPNZ
- 00B05200000B MQIG-KUKM-YQSJ-KPRM
- 00B05200000C VTLW-DAVK-JCMU-JQLU
- 00B05200000D PIQB-OITS-RFCY-PUVE
- 00B05200000E IWAV-KYJM-JBEM-GPMR
- 00B05200000F LQJY-DSEX-WDHE-FVMB
-
-DISCLAIMER
- Qualcomm Atheros reserves the right to modify program names, functionality, input format or output format in future tool‐
- kit releases without any obligation to notify or compensate toolkit users.
-
-SEE ALSO
- hpavkey(1), hpavkeys(1), keys(1), mac2pwd(1), rkey(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
- Pouyan Sepehrdad <pouyans@qti.qualcomm.com>
- Ning Shang <nshang@qti.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 mac2pw(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-#define _GETOPT_H
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <stdio.h>
-#include <string.h>
-#include <limits.h>
-#include <errno.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#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/error.h"
-#include "../key/keys.h"
-
-/*====================================================================*
- * custom source files;
- *--------------------------------------------------------------------*/
-
-#ifndef MAKEFILE
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-#include "../tools/todigit.c"
-#include "../tools/uintspec.c"
-#include "../tools/error.c"
-#endif
-
-#ifndef MAKEFILE
-#include "../key/MACPasswords.c"
-#include "../key/RNDPasswords.c"
-#include "../key/putpwd.c"
-#endif
-
-/*====================================================================*
- * program constants;
- *--------------------------------------------------------------------*/
-
-#ifndef ETHER_ADDR_LEN
-#define ETHER_ADDR_LEN 6
-#endif
-
-/*====================================================================*
- * program functions;
- *--------------------------------------------------------------------*/
-
-void (* generate)(unsigned, unsigned, unsigned, unsigned, unsigned, char, flag_t) = RNDPasswords;
-
-/*====================================================================*
- *
- * void function (const char * string, unsigned range, unsigned alpha, unsigned bunch, unsigned space, flag_t flags)
- *
- * parse an Ethernet hardware address string into vendor and device
- * ID substrings; print a specified number of consecutive addresses
- * and password strings having a defined letter count and grouping;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-static void function (const char * string, unsigned range, unsigned alpha, unsigned bunch, unsigned space, flag_t flags)
-
-{
- extern void (* generate)(unsigned, unsigned, unsigned, unsigned, unsigned, char, flag_t);
- const char * offset = string;
- unsigned vendor = 0;
- unsigned device = 0;
- unsigned radix = 0x10;
- unsigned width;
- unsigned digit;
- for (width = 0; width < ETHER_ADDR_LEN; width++)
- {
- if ((digit = todigit (*offset)) < radix)
- {
- vendor *= radix;
- vendor += digit;
- offset++;
- continue;
- }
- error (1, EINVAL, "Bad MAC Address: %s", string);
- }
- if (!vendor)
- {
- error (1, EPERM, "Vendor ID can't be zero");
- }
- for (width = 0; width < ETHER_ADDR_LEN; width++)
- {
- if ((digit = todigit (*offset)) < radix)
- {
- device *= radix;
- device += digit;
- offset++;
- continue;
- }
- error (1, EINVAL, "Bad MAC Address: %s", string);
- }
- if (!device)
- {
- error (1, EPERM, "Device ID can't be zero");
- }
- if (*offset)
- {
- error (1, EINVAL, "Bad MAC address: %s", string);
- }
- if (range > (0x00FFFFFF - device))
- {
- error (1, ERANGE, "Want %d passwords but only %d left in range", range, (0x00FFFFFF - device));
- }
- generate (vendor, device, range, alpha, bunch, space, flags);
- return;
-}
-
-/*====================================================================*
- *
- * int main (int argc, const char * argv []);
- *
- * generate unique password strings for a range of device hardware
- * addresses; print paired addresses and passwords on stdout;
- *
- * Many Atheros programs expect the user to enter a password to
- * access a device; the password is encoded to produce the 16-bit
- * Device Access Key (DAK) stored in the PIB;
- *
- * Vendors must publish the device password so that end users can
- * reproduce the same 16-byte hexadecimal value later; a password
- * is more user-friendly than a 16-byte hexadecimal value;
- *
- * given a range of MAC address, this program will produce unique
- * passwords so vendors can program devices and print labels that
- * ship devices;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#define DEFAULT_RANGE 1
-#define DEFAULT_ALPHA 25
-#define DEFAULT_BUNCH 0
-
-int main (int argc, const char * argv [])
-
-{
- extern void (* generate)(unsigned, unsigned, unsigned, unsigned, unsigned, char, flag_t);
- static const char * optv [] =
- {
- "b:el:mn:qv",
- "address [address] [...]",
- "Atheros device password generator",
- "b n\tbunching factor [" LITERAL (DEFAULT_BUNCH) "]",
- "e\tbase passwords on host system entropy (more secure)",
- "l n\tpassword letters [" LITERAL (DEFAULT_ALPHA) "]",
- "m\tbase passwords on MAC addresses (non-secure)",
- "n n\tgenerate n consecutive passwords [" LITERAL (DEFAULT_RANGE) "]",
- "q\tomit device address on output",
- "v\tprepend PTS flag on output",
- (const char *)(0)
- };
- unsigned range = DEFAULT_RANGE;
- unsigned alpha = DEFAULT_ALPHA;
- unsigned bunch = DEFAULT_BUNCH;
- unsigned space = '-';
- flag_t flags = (flag_t)(0);
- signed c;
- optind = 1;
- while ((c = getoptv (argc, argv, optv)) != -1)
- {
- switch ((char)(c))
- {
- case 'b':
- bunch = uintspec (optarg, 0, UCHAR_MAX);
- break;
- case 'e':
- generate = RNDPasswords;
- break;
- case 'l':
- alpha = uintspec (optarg, 12, 64);
- break;
- case 'm':
- generate = MACPasswords;
- break;
- case 'n':
- range = uintspec (optarg, 0, 0x00FFFFFF);
- break;
- case 'q':
- _setbits (flags, PASSWORD_SILENCE);
- break;
- case 'v':
- _setbits (flags, PASSWORD_VERBOSE);
- break;
- default:
- break;
- }
- }
- argc -= optind;
- argv += optind;
- while ((argv) && (* argv))
- {
- function (* argv, range, alpha, bunch, space, flags);
- argc--;
- argv++;
- }
- return (0);
-}
-
-
-
-mac2pwd(1) Qualcomm Atheros Open Powerline Toolkit mac2pwd(1)
-
-NAME
- mac2pwd - Qualcomm Atheros Ethernet Device Password Generator
-
-SYNOPSIS
- mac2pwd [options] file [file] [ ... ]
-
-DESCRIPTION
- Read Ethernet MAC addresses from one or more files and print a unique password for each address. Program output is suit‐
- able as input to the Qualcomm Atheros HomePlug AV Production Test System or may be used in custom production systems.
- Input addresses can appear in any order and need not be consecutive. Computed passwords consist of upper case letters
- and digits with optional group separators. Output consists of address/password pairs in text format.
-
- This program may be used to generate passwords for large numbers of non-consecutive MAC addresses that occur in unspeci‐
- fied order. It complements program mac2pw which generates passwords for consecutive MAC addresses over a given range.
- Options exist to modify the password algorithm, password length and character bunching.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-CAVEATS
- Atheros provides this program as a simple means of generating unique and apparently random device passwords for a large
- volume of Ethernet devices. Two different password algorithms are implemented but neither one is required for HomePlug
- AV compliance. Vendors are free to use other methods to generate their own device passwords and are encouraged to do so.
-
- Random Method
- Generate random passwords based on system entropy. A different set of passwords is generated for a given address
- range with each program execution. There is no correlation at between addresses and passwords. This method
- secure but requires care when programming and labelling devices at the factory. It may be necessary to maintain a
- database if regular device maintenance and firmware upgrade are needed.
-
- Device Method
- Generate apparently random passwords based on device address. The same set of passwords will be generated for a
- given address range with each program execution. This method may be appropriate on system where regular mainte‐
- nance and firmware updates are required. This method is not secure because device addresses can be determined
- using a variety of network management programs. Anyone having access to this program, or the algorithm, could
- compute the device password and gain access to device features reserved for privileged users. This program does
- provide features to mitigate the risks of using this method.
-
-OPTIONS
- -b bunch
- The password bunching factor. Passwords consists of count uppercase letters and digits optionally displayed in
- groups separated by hyphens. The bunching factor specifies the number of letters and digits in each group. When
- bunch is 0 or greater than count, bunching is suppressed. Separating hyphens increase overall password length.
- The minimum is 0 and the maximum is 255. The default is 0 which suppresses bunching.
-
- -e Compute passwords based on host system entropy. Passwords consist of uppercase letters [A-Z] optionally grouped
- using option -b. This method produces a non-repeatable set of unique passwords over a given address range. This
- method is the default and is secure.
-
- -l count
- The number of letters in the password string. The default count is 16. Overall password length is the sum of
- count plus the number of delimiters implied by bunch.
-
- -m Compute passwords based on target device address. Passwords consist of uppercase letters [A-Z]. This method pro‐
- duces a repeatable set of unique passwords over a given address range. This method is not secure.
-
- -q Quiet mode. Exclude the MAC address on output. This option can be used in scripts to return the password associ‐
- ated with a given MAC address.
-
- -v Verbose mode. Prefix each line with a '0' column. The Atheros Production Test System (PTS) uses the first column
- of a password database file to indicate which addresses and passwords have already been used.
-
- -?,--help
- Print program help information on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of a file that contains Ethernet address strings. Individual address strings consist of 12 consecutive
- hexadecimal digits. Addresses are seperated by whites space. This allows multiple addresses on a line. There is
- no line length limit. Punctuation is not permitted; however, a hash ('#') or semicolon (';') in any column starts
- comment text that continues to the end of that line. An error in any input file terminates the program with an
- error message.
-
-EXAMPLES
- An example input file, mac.txt, is shown below. Comment lines document the file. Blank lines are permitted and multiple
- addresses appear on one line. This file contains 5 MAC addresses. Punctuation is not permitted within a MAC address.
-
- # =================================
- # unused MAC addresses;
- # ---------------------------------
- 00b052000004
- 00b052BABE33
- 00b052BABE34 00b052CAFE05
- 00b052CAFE01
-
- Another example input file, mac2.txt, appears below. A hash ('#') and a semi-colon (';') are used to hide selected
- addresses. Hidden addresses are ignored because they are comments. This file contains 7 addresses but only 5 will be
- recognized.
-
- 002b88ffff00
- 002b887fff00
- # 002b88660066
- 002b88660067
- 002b88660063 ; 002b8800FFFF
- 002b88660066
-
- The next example reads the two files shown above and prints 10 addresses, 5 from each file, with associated passwords.
- Output appears on the console but may be piped to a file or another process.
-
- # mac2pwd mac.txt more.mac
- 00B052000004 8C69GFCXATB8RA9SF52LK79UD
- 00B052BABE33 MMKGF5SP5DP23KHY27BSLRV2A
- 00B052BABE34 CVBG6QHJFQVVCYSACPAPBZT79
- 00B052CAFE05 MCXUABFPC33CPMXWFWYX5N2KC
- 00B052CAFE01 5GHUWD9YDEL8TCAGEZJ8ESRCC
- 002B88FFFF00 CJCW4VB2HZ37DAK2XE9CGCWZZ
- 002B887FFF00 W2W9AQU5TE8K4ZLH7R3K5C6X4
- 002B88660067 2LWQ5LGBUCDFDYSZYQ2XZSPJ2
- 002B88660063 62NKW6RM87UBZG34KH87AXXEY
- 002B88660066 KNQAGGFH9G9XQGR96GR4HK4SS
-
- The next example does the the two files, as before but shortens password length and groups password character. Overall
- password length includes password characters plus delimiters. Option -l sets password length to 16 characters. Option
- -b sets bunching to 4 characters.
-
- # mac2pwd mac.txt more.mac -l 16 -b 4
- 00B052000004 R5YH-E6XG-TECA-24R8
- 00B052BABE33 WBQJ-77PC-VQTX-63Q5
- 00B052BABE34 4M2X-GVUY-6PYH-H5V7
- 00B052CAFE05 Z8JA-A2MV-49JF-WJZZ
- 00B052CAFE01 5L7Z-ZXZP-NUFS-RBKE
- 002B88FFFF00 3RAD-HQPN-92G2-HJKA
- 002B887FFF00 7YD7-9NJJ-39S7-8ZGF
- 002B88660067 HZ6K-SBG5-ZL8S-K2DK
- 002B88660063 MX5K-W7PF-T823-38MJ
- 002B88660066 PDXL-84QH-GKUN-KVEE
-
- The next example is the same but prints output suitable for input to the Qualcomm Atheros PTS because option -v is speci‐
- fied. The output format is similar to that produced by the Qualcomm Atheros DB Builder Utility for Windows.
-
- # mac2pwd -v mac.txt more.mac
- 0 00B052000004 ZZYBQP7EAZKBNWWCKKC4HX3AW
- 0 00B052BABE33 LG7XD97UPSBUHA6F7CU28P3WW
- 0 00B052BABE34 8BF288CZN4NTBUFSJAQLUYYNF
- 0 00B052CAFE05 RTK4XHMWKWWD654QRBQGW5UNH
- 0 00B052CAFE01 EE5YLRXD2EGKS6TSGZZK7ES74
- 0 002B88FFFF00 BRYJDWYGP79GFWZN8ZU8ZQ3GN
- 0 002B887FFF00 KEULLGC6PYFAM3FE89TYTSMP6
- 0 002B88660067 H4STMXB67QR22J39MAZQRHHA5
- 0 002B88660063 HKF32QX2GCZKGR3XYTMQCWTRB
- 0 002B88660066 STKF28Q2JXYEMAQZVQSFVTKFB
-
- The next example omits the MAC address. This may used to generate random passwords for other purposes.
-
- # mac2pwd -q mac.txt more.mac
- W6QXL6KDY4SZLL538CAMWSH8N
- PMYLFYMNA5TKYU2S6LBJS6QCR
- B2P58XQ2L4JSNR6SXEZ6BSVSN
- GYG6MS8NFEVH8EFBPD483WWCJ
- 44TQ6FYCVSGP9GLS6YSYRTWFQ
- GUGPUJ6284X22ZU4RKXAX5T65
- LGSV6L9Y9398DFY3Z2TUFBCAJ
- H95A2FYV3LNT7BBFSLCLHXEH8
- JXSY7TMKK6CP3LDWNE3M74G87
- V4TEAG2ZX3J3NJHPAJMMQTQNT
-
-DISCLAIMER
- Qualcomm Atheros reserves the right to modify program names, functionality, input format or output format in future tool‐
- kit releases without any obligation to notify or compensate toolkit users.
-
-SEE ALSO
- hpavkey(1), hpavkeys(1), keys(1), mac2pw(1), rkey(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
- Pouyan Sepehrdad <pouyans@qti.qualcomm.com>
- Ning Shang <nshang@qti.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 mac2pwd(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-#define _GETOPT_H
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <stdio.h>
-#include <ctype.h>
-#include <errno.h>
-#include <limits.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#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/error.h"
-#include "../key/keys.h"
-
-/*====================================================================*
- * custom source files;
- *--------------------------------------------------------------------*/
-
-#ifndef MAKEFILE
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-#include "../tools/todigit.c"
-#include "../tools/uintspec.c"
-#include "../tools/error.c"
-#endif
-
-#ifndef MAKEFILE
-#include "../key/MACPasswords.c"
-#include "../key/RNDPasswords.c"
-#include "../key/putpwd.c"
-#endif
-
-/*====================================================================*
- * program constants;
- *--------------------------------------------------------------------*/
-
-#ifndef ETHER_ADDR_LEN
-#define ETHER_ADDR_LEN 6
-#endif
-
-/*====================================================================*
- * program functions;
- *--------------------------------------------------------------------*/
-
-void (* generate)(unsigned, unsigned, unsigned, unsigned, unsigned, char, flag_t) = RNDPasswords;
-
-/*====================================================================*
- *
- * void function (const char * file, unsigned alpha, unsigned bunch, flag_t flags)
- *
- * read Ethernet hardware address strings from a file and print
- * address passwords pairs on stdout;
- *
- * parse an Ethernet hardware address string into vendor and device
- * ID substrings; print a specified number of consecutive addresses
- * and password strings having a defined letter count and grouping;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-static void function (const char * file, unsigned alpha, unsigned bunch, unsigned space, flag_t flags)
-
-{
- extern void (* generate)(unsigned, unsigned, unsigned, unsigned, unsigned, char, flag_t);
- unsigned line = 1;
- unsigned radix = 0x10;
- unsigned width;
- unsigned digit;
- signed c = getc (stdin);
- while (c != EOF)
- {
- uint32_t vendor = 0;
- uint32_t device = 0;
- while (isspace (c))
- {
- if (c == '\n')
- {
- line++;
- }
- c = getc (stdin);
- }
- if ((c == '#') || (c == ';'))
- {
- do
- {
- c = getc (stdin);
- }
- while ((c != '\n') && (c != EOF));
- continue;
- }
- for (width = 0; width < ETHER_ADDR_LEN; width++)
- {
- if ((digit = todigit (c)) < radix)
- {
- vendor *= radix;
- vendor += digit;
- c = getc (stdin);
- continue;
- }
- error (1, EINVAL, "%s: line %d: Illegal vendor", file, line);
- }
- if (!vendor)
- {
- error (1, EPERM, "%s: line %d: Vendor can't be zero", file, line);
- }
- for (width = 0; width < ETHER_ADDR_LEN; width++)
- {
- if ((digit = todigit (c)) < radix)
- {
- device *= radix;
- device += digit;
- c = getc (stdin);
- continue;
- }
- error (1, EINVAL, "%s: line %d: Illegal device", file, line);
- }
- if (!device)
- {
- error (1, EPERM, "%s: line %d: Device can't be zero", file, line);
- }
- while (isspace (c))
- {
- if (c == '\n')
- {
- line++;
- }
- c = getc (stdin);
- }
- generate (vendor, device, 1, alpha, bunch, space, flags);
- }
- return;
-}
-
-/*====================================================================*
- *
- * int main (int argc, const char * argv []);
- *
- * read one or more text files containing device address strings
- * and print a stream of address/password pairs; device addresses
- * must be separated by white space;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#define DEFAULT_ALPHA 25
-#define DEFAULT_BUNCH 0
-
-int main (int argc, const char * argv [])
-
-{
- extern void (* generate)(unsigned, unsigned, unsigned, unsigned, unsigned, char, flag_t);
- static const char * optv [] =
- {
- "b:el:mqv",
- PUTOPTV_S_FUNNEL,
- "Atheros device password generator",
- "b n\tbunching factor [" LITERAL (DEFAULT_BUNCH) "]",
- "e\tbase passwords on host system entropy (more secure)",
- "l n\tpassword letters [" LITERAL (DEFAULT_ALPHA) "]",
- "m\tbase passwords on MAC addresses (non-secure)",
- "q\tomit device address on output",
- "v\tprepend PTS flag on output",
- (const char *)(0)
- };
- unsigned alpha = DEFAULT_ALPHA;
- unsigned bunch = DEFAULT_BUNCH;
- unsigned space = '-';
- flag_t flags = (flag_t)(0);
- signed c;
- optind = 1;
- while ((c = getoptv (argc, argv, optv)) != -1)
- {
- switch ((char)(c))
- {
- case 'b':
- bunch = uintspec (optarg, 0, UCHAR_MAX);
- break;
- case 'e':
- generate = RNDPasswords;
- break;
- case 'l':
- alpha = uintspec (optarg, 12, 64);
- break;
- case 'm':
- generate = MACPasswords;
- break;
- case 'q':
- _setbits (flags, PASSWORD_SILENCE);
- break;
- case 'v':
- _setbits (flags, PASSWORD_VERBOSE);
- break;
- default:
- break;
- }
- }
- argc -= optind;
- argv += optind;
- if (!argc)
- {
- function ("stdin", alpha, bunch, space, flags);
- }
- while ((argv) && (* argv))
- {
- if (!freopen (* argv, "rb", stdin))
- {
- error (1, EINVAL, "Can't open %s", * argv);
- }
- function (* argv, alpha, bunch, space, flags);
- argc--;
- argv++;
- }
- return (0);
-}
-
-
-
-
-
-
diff --git a/docbook/management.xml b/docbook/management.xml
deleted file mode 100644
index 3a7f7bb3..00000000
--- a/docbook/management.xml
+++ /dev/null
@@ -1,132 +0,0 @@
-
-
- Remote Management
-
-
-
- Introduction
-
-
- The Atheros Open Powerline Toolkit includes several example applications that perform basic powerline device management from a remote host. Each example implements a different network protocol, such as HTTP, SNMP or TR-069. These applications merely demonstrate the underlying concepts but none perform full network device management. That is left to our customers because their needs vary.
-
-
- All examples are proxy implementations where a local host communicates with one powerline device over Ethernet. That device then communicates with other devices over powerline or coax. All management functionality is programmed into the local host but other hosts are able to request information or services from it over Ethernet. The local host could be either part of the local powerline device or an external workstation.
-
-
-
-
- HTTP Protocol
-
-
-
- Overview
-
-
- HTTP provides a simple means for one device to interact with one or more remote hosts. The device merely needs requires a basic web server with Common Gateway Interface (CGI) support. With CGI support, one can write programs that read structured data from their standard input and write HTML to their standard output. Generally, the HTML output is a form that the user can complete and submit for subsequent processing by some application on device.
-
-
- The basic chain of events looks something like this:
-
-
-
-
- A user connects the client (some remote computer) to the server (some powerline device) using a web browser.
-
-
-
-
- The server executes the application (some CGI program) designated as the default Uniform Resource Locator (URL) and passes any associated data to the application. Initially there is no data to pass.
-
-
-
-
- The application sees there is no data on stdin and prints an HTML form on stdout. The form contains one or more submit buttons and assigns some URL as the ultimate recipient of form data.
-
-
-
-
- The server forwards the form to the requesting client.
-
-
-
-
- The client displays the form.
-
-
-
-
- The user completes the form and presses one of the submit buttons. This creates some data for the application to process.
-
-
-
-
- The client forwards the form to the URL designated by the application. Often, this URL is an application on the originating server but it could be an application on another server.
-
-
-
-
- The server executes the application designated by the URL and passes the associated data to the application.
-
-
-
-
- The application reads the form data from stdin, processes it and writes new HTML to stdout. This could be the same form with new data or new fields or new submit buttons or a different form.
-
-
-
-
- The chain of events described above is the same even for scripting languages such as PHP, ASP and JSP. The only difference is the nature of the application. In our case, the application is a compiled C Language program because we do not want the overhead of a full scripting language. We also elected of have one application process all forms to minimize the number of files that must be distributed and maintained.
-
-
- One design consideration is the method used to store information from one data exchange to the next. We cannot store the information in memory because the application does not run continuously. Consequently, we defined a data structure to hold all the required information then write the structure directly to a file in binary format on exit and read it back on start up. This data structure is known as a session variable and the process of reading and writing it in binary is known as serialization.
-
-
-
-
- Read session state from a file.
-
-
-
-
- Read form data from stdin and parse it. Update the session state based on the form data. For example, record which submit button was pressed by the user. Store the content of form fields changed by the user.
-
-
-
-
- Inspect the session state and perform any tasks indicated. Update the session state based on task results.
-
-
-
-
- Write new HTML to stdout. Indicate the new session state for the user to see. This could include new data in form fields, new form fields, a new form or new submit buttons.
-
-
-
-
- Save the session state to a file.
-
-
-
-
- Terminate the application.
-
-
-
-
-
-
- Installation
-
-
-
-
-
- SNMP Protocol
-
-
-
-
- TR-069 Protocol
-
-
-
diff --git a/docbook/manifest.c.html b/docbook/manifest.c.html
deleted file mode 100644
index b907a261..00000000
--- a/docbook/manifest.c.html
+++ /dev/null
@@ -1,271 +0,0 @@
-
-
-
-
-
- manifest.c
-
-
-
-
-
-
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed manifest (void const * memory, size_t extent);
- *
- * print manifest contents on stdout in human readable format;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef MANIFEST_SOURCE
-#define MANIFEST_SOURCE
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <stdint.h>
-#include <errno.h>
-
-#include "../tools/format.h"
-#include "../tools/memory.h"
-#include "../tools/endian.h"
-#include "../tools/error.h"
-#include "../tools/files.h"
-#include "../tools/tlv.h"
-#include "../nvm/nvm.h"
-
-/*
- * strings must appear in order of hardware types;
- */
-
-static char const * compatibility [] =
-
-{
- "QCA7420",
- (char const *) (0)
-};
-
-/*
- * strings must appear in order of field type; the last string is the error string;
- */
-
-static char const * nvm_fields [] =
-
-{
- "Signature",
- "Hardware Compatibility",
- "Chain Major Version",
- "Chain Minor Version",
- "Chain Type",
- "Build Major Version",
- "Build Minor Version",
- "Build Type",
- "Manifest Version",
- "Build Number",
- "Build Date",
- "Build Time",
- "Device Type",
- "Build Hostname",
- "Build Username",
- "Build Description",
- "Build Version String",
- "Build Sustaining Release",
- "Build Major Subversion",
- "Generic Identifier 0",
- "Generic Identifier 1",
- "Softloader Major Version",
- "Softloader Minor Version",
- "Manifest Free Space",
- "Unknown Type"
-};
-
-/*
- * strings must appear in order of chain type;
- */
-
-static char const * nvm_chains [] =
-
-{
- "Softloader",
- "Firmware",
- "Parameter Block",
- "CustomModule"
-};
-
-/*====================================================================*
- *
- * char * myitoa (unsigned number, char buffer [], size_t length);
- *
- * non-standard version of itoa () where buffer is packed right-
- * to-left to avoid reversing digits; ensure buffer is longer
- * than needed;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-static char * myitoa (unsigned number, char buffer [], size_t length)
-
-{
- buffer [-- length] = (char) (0);
- do
- {
- buffer [-- length] = '0' + (number % 10);
- number /= 10;
- }
- while (number);
- return (buffer);
-}
-
-/*====================================================================*
- *
- * signed manifest (void const * memory, size_t extent);
- *
- * nvm.h
- *
- * walk through a manifest and print known values, when present;
- * known values are those defined in nvm.h and named here;
- *
- * the TLVNode data structure used here is not the same a that in
- * the firmware headers; our structure assumes values are 32-bit
- * integers and treats strings are exceptions to that rule;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-signed manifest (void const * memory, size_t extent)
-
-{
- uint8_t * offset = (uint8_t *) (memory);
- uint32_t length = (uint32_t) (extent);
- char string [1024];
- while (length > 0)
- {
- struct TLVNode * node = (struct TLVNode *) (offset);
- uint32_t type = LE32TOH (node->type);
- uint32_t size = LE32TOH (node->size);
- uint32_t data = LE32TOH (node->data);
-
- switch (type)
- {
- case NVM_FIELD_SIGNATURE:
- case NVM_FIELD_BUILD_DATE:
- printf ("\t%s: %08X\n", nvm_fields [type], data);
- break;
- case NVM_FIELD_BUILD_TIME:
- printf ("\t%s: %06X\n", nvm_fields [type], data);
- break;
- case NVM_FIELD_DEVICE_TYPE:
- printf ("\t%s: %04X\n", nvm_fields [type], data);
- break;
- case NVM_FIELD_CHAIN_TYPE:
- printf ("\t%s: %s\n", nvm_fields [type], data < SIZEOF (nvm_chains)? nvm_chains [data]: myitoa (data, string, sizeof (string)));
- break;
- case NVM_FIELD_BUILD_HOSTNAME:
- case NVM_FIELD_BUILD_USERNAME:
- case NVM_FIELD_BUILD_DESCRIPTION:
- case NVM_FIELD_BUILD_VERSION_STRING:
- case NVM_FIELD_BUILD_TYPE:
- printf ("\t%s: %s\n", nvm_fields [type], (char const *) (& node->data));
- break;
- case NVM_FIELD_HARDWARE_COMPAT:
- strfbits (string, sizeof (string), compatibility, "|", data);
- printf ("\t%s: %s\n", nvm_fields [type], string);
- break;
- case NVM_FIELD_MANIFEST_VERSION:
- case NVM_FIELD_CHAIN_MAJOR_VERSION:
- case NVM_FIELD_CHAIN_MINOR_VERSION:
- case NVM_FIELD_BUILD_NUMBER:
- case NVM_FIELD_BUILD_MAJOR_VERSION:
- case NVM_FIELD_BUILD_MINOR_VERSION:
- case NVM_FIELD_BUILD_MAJOR_SUBVERSION:
- case NVM_FIELD_BUILD_SUSTAINING_RELEASE:
- case NVM_FIELD_GENERIC_ID0:
- case NVM_FIELD_GENERIC_ID1:
- case NVM_FIELD_SL_MAJOR_VERSION:
- case NVM_FIELD_SL_MINOR_VERSION:
- printf ("\t%s: %d\n", nvm_fields [type], data);
- break;
- case NVM_FIELD_FREE_SPACE:
- printf ("\t%s: %d/" SIZE_T_SPEC " bytes\n", nvm_fields [type], size, extent);
- break;
- default:
- error (0, 0, "%s: %d", nvm_fields [sizeof (nvm_fields) / sizeof (const char *) - 1], type);
- break;
- }
-
- length -= sizeof (* node) - sizeof (node->size) + LE32TOH (node->size);
- offset += sizeof (* node) - sizeof (node->size) + LE32TOH (node->size);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void * manifetch (void const * memory, size_t extent);
- *
- * nvm.h
- *
- * search an nvm manifest for a given variable type and return a
- * void pointer to the value, if present, or NULL if not; users
- * must apply the correct type cast to the pointer to access the
- * value;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef MANIFETCH_SOURCE
-#define MANIFETCH_SOURCE
-
-#include <stdio.h>
-#include <stdint.h>
-
-#include "../tools/endian.h"
-#include "../tools/tlv.h"
-
-void * manifetch (void const * memory, size_t extent, uint32_t type)
-
-{
- uint8_t * offset = (uint8_t *) (memory);
- while (extent)
- {
- struct TLVNode * node = (struct TLVNode *) (offset);
- if (LE32TOH (node->type) == type)
- {
- return ((void *) (& node->data));
- }
- extent -= TLVSPAN (node);
- offset += TLVSPAN (node);
- }
- return ((void *) (0));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * mdio.h - mdio related definitions and declarations;
- *
- *. Atheros Powerline Toolkit for HomePlug AV;
- *: Copyright (c) 2009-2013 by Qualcomm Atheros Inc. ALL RIGHTS RESERVED;
- *; For demonstration and evaluation only; Not for production use.
- *
- *--------------------------------------------------------------------*/
-
-#ifndef MDIO_HEADER
-#define MDIO_HEADER
-
-/*====================================================================*
- * constants;
- *--------------------------------------------------------------------*/
-
-#define MDIO_VERBOSE (1 << 0)
-#define MDIO_SILENCE (1 << 1)
-
-#define MDIO16_USE(x) (((x) & 0x0001) << 0)
-#define MDIO16_RSVD(x) (((x) & 0x001F) << 1)
-#define MDIO16_CNT(x) (((x) & 0x03FF) << 6)
-#define MDIO16_START(use,rsvd,cnt) (MDIO16_USE (use) | MDIO16_RSVD (rsvd) | MDIO16_CNT (cnt))
-
-#define MDIO16_SRT(x) (((x) & 0x0003) << 0)
-#define MDIO16_OP(x) (((x) & 0x0003) << 2)
-#define MDIO16_PHY(x) (((x) & 0x001F) << 4)
-#define MDIO16_REG(x) (((x) & 0x001F) << 9)
-#define MDIO16_TA(x) (((x) & 0x0003) << 14)
-#define MDIO16_INSTR(srt,op,phy,reg,ta) (MDIO16_SRT (srt) | MDIO16_OP (op) | MDIO16_PHY (phy) | MDIO16_REG (reg) | MDIO16_TA (ta))
-
-#define MDIO32_HI_ADDR_SHIFT 9
-#define MDIO32_LO_ADDR_SHIFT 1
-#define MDIO32_HI_ADDR_MASK (0x000003FF << MDIO32_HI_ADDR_SHIFT)
-#define MDIO32_LO_ADDR_MASK 0x000001FC
-
-#define MDIO32_CODE_SHIFT 3
-#define MDIO32_CODE_MASK (0x03 << CODE_SHIFT)
-#define MDIO32_CODE_HI_ADDR 0x03
-#define MDIO32_CODE_LO_ADDR 0x02
-
-#define MDIO32_HI_ADDR(a) ((a & MDIO32_HI_ADDR_MASK) >> MDIO32_HI_ADDR_SHIFT)
-#define MDIO32_LO_ADDR(a) ((a & MDIO32_LO_ADDR_MASK) >> MDIO32_LO_ADDR_SHIFT)
-
-#define MDIO32_INSTR(addr, data, mask) MDIO16_INSTR (1, 1, (MDIO32_CODE_HI_ADDR << MDIO32_CODE_SHIFT), 0x00, 2), MDIO32_HI_ADDR (addr), 0xFFFF, MDIO16_INSTR (1, 1, (MDIO32_CODE_LO_ADDR << MDIO32_CODE_SHIFT) | ((MDIO32_LO_ADDR (addr) & 0xE0) >> 5), MDIO32_LO_ADDR (addr) & 0x1F, 2), (data & 0x0000FFFF), mask & 0x0000FFFF, MDIO16_INSTR (1, 1, (MDIO32_CODE_LO_ADDR << MDIO32_CODE_SHIFT) | ((MDIO32_LO_ADDR (addr) & 0xE0) >> 5), (MDIO32_LO_ADDR (addr) & 0x1F) | 0x01, 2), (data & 0xFFFF0000) >> 16, (mask & 0xFFFF0000) >> 16
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-mdioblock(1) Qualcomm Atheros Open Powerline Toolkit mdioblock(1)
-
-NAME
- mdioblock - Qualcomm Atheros Clause 22 MDIO Instruction Block Assembler
-
-SYNOPSIS
- mdioblock [options] file [file] [...] [>stdout]
-
- mdioblock [options] [<stdin] [>stdout]
-
-DESCRIPTION
- Assemble an Atheros MDIO instruction block from hexadecimal register instructions. MDIO instruction blocks are written
- to Atheros powerline devices as modules using the VS_MOD_OP message type. Alternately, program int6kmod can be used.
-
- Atheros MDIO modules consists of a 16-bit header followed by one or more MDIO communication frames with register masks
- and padded to the nearest multiple of 32-bits for download purposes. MDIO instructions are specified here using 802.3
- Clause 22 (or phy, reg, data and mask) format. See program mdioblock2 for a similar program that accepts instructions in
- 802.3ae Clause 45 (or address, data and mask) format.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -q Quiet mode. Suppresses error messages caused by instruction syntax errors.
-
- -v Verbose mode. Prints instructions on stderr as they are processed.
-
- -?,--help
- Displays program help information on stderr. This option takes precedence over all other options on the command
- line except version information.
-
- -!,--version
- Displays program version information on stderr. This option takes precedence over all other options on the com‐
- mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
-
-ARGUMENTS
- file A text files contining one or more generic MDIO register intructions consisting of a phy, reg, data and mask
- fields. Fields are seperated by whitespace and instructions are terminated with semicolon. Multiple instructions
- may appear on a single line or a single instruction can span multiple lines. Script-style comments are permitted
- between instructions but not between fields.
-
-REFERENCES
- See the Qualcomm Atheros AR7x00 Firmware Technical Reference Manual section on the Module Operation message type for more
- information on MDIO Block format.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- The following command reads register instructions from file mdio.txt and writes them as an MDIO program block to file
- mdio.bin. In this example, the program acts as a filter.
-
- # mdioblock < mdio.txt > mdio.bin
-
- The following command reads register instructions from files physetup.dat, flowctl.dat and misc.ins and write them all as
- one MDIO block to file mdio.bin. The previous contents of file mdio.bin is overwritten.
-
- # mdioblock physetup.dat flowctl.dat misc.ins > mdio.bin
-
- An example register instruction file might look like this. The first two lines consist of one instruction each. An
- instruction has phy, reg, data and mask fields. Instruction fields are separated by whitespace. Instructions are sepa‐
- rated by a semicolon. Multiple instruction may appear on one line and one instruction can span multiple lines. Script-
- style comments are permitted between instructions but not between instruction fields.
-
- 18 00 0000 FFFF;
- 10 16 003F FFFF;
-
- # multiple instructions on one line;
-
- 10 17 7E3F FFFF; 18 00 0000 FFFF;
-
- # one instruction on multiple lines;
-
- 10
-
- 02
-
- 0700
-
- FFFF;
-
- 10 03 0000 FFFF;
- 18 00 0000 FFFF;
- 14 00 007D FFFF;
- 14 01 0000 FFFF;
-
- A 16-bit hexdump of the MDIO block will look like this on little-endian hosts. The block consists of a 16-bit header
- followed by a variable number of 16-bit triplets. The header indicates the number of triplets that follow. Each triplet
- specifies a 16-bit operation, a 16-bit data value and a 16-bit data mask. The application of these fields is beyond the
- scope of this man page. Consult the IEEE standards for more information.
-
- # hexdump mdio.bin
- 0000000 0241 8185 0000 ffff ad05 003f ffff af05
- 0000010 7e3f ffff 8185 0000 ffff 8505 0700 ffff
- 0000020 8705 0000 ffff 8185 0000 ffff 8145 007d
- 0000030 ffff 8345 0000 ffff
-
- An 8-bit dump of the MDIO block will look like this on all hosts since the MDIO block is always distributed in little-
- endian format.
- # hexdmp mdio.bin
- 00000000 41 02 85 81 00 00 FF FF 05 AD 3F 00 FF FF 05 AF A.........?.....
- 00000010 3F 7E FF FF 85 81 00 00 FF FF 05 85 00 07 FF FF ?~..............
- 00000020 05 87 00 00 FF FF 85 81 00 00 FF FF 45 81 7D 00 ............E.}.
- 00000030 FF FF 45 83 00 00 FF FF ..E.....
-
-SEE ALSO
- amp(1), int6kmod(1), int6kmdio(1), int6kmdio2(1), mdioblock2(1), mdiodump(1), mdiogen(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 mdioblock(1)
-
-mdioblock2(1) Qualcomm Atheros Open Powerline Toolkit mdioblock2(1)
-
-NAME
- mdioblock2 - Qualcomm Atheros Clause 45 MDIO Instruction Block Assembler
-
-SYNOPSIS
- mdioblock2 [options] file [file] [...] [>stdout]
-
- mdioblock2 [options] [<stdin] [>stdout]
-
-DESCRIPTION
- Assemble an Atheros MDIO instruction block from hexadecimal register instructions. MDIO instruction blocks are written
- to Atheros powerline devices as modules using the VS_MOD_OP message type. Alternately, program int6kmod can be used.
-
- Atheros MDIO modules consists of a 16-bit header followed by one or more MDIO communication frames with register masks
- and padded to the nearest multiple of 32-bits for download purposes. MDIO instructions are entered here using 802.3ae
- Clause 45 (or addr, data and mask) format. See program mdioblock for a similar program that accepts instructions in
- 802.3 Clause 22 (or phy, reg, data and mask) format.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -q Quiet mode. Suppresses error messages caused by instruction syntax errors.
-
- -v Verbose mode. Prints instructions on stderr as they are processed.
-
- -?,--help
- Displays program help information on stderr. This option takes precedence over all other options on the command
- line except version information.
-
- -!,--version
- Displays program version information on stderr. This option takes precedence over all other options on the com‐
- mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
-
-ARGUMENTS
- file A text files contining one or more generic MDIO register intructions consisting of a address, data and mask
- fields. Fields are separated by whitespace. Instructions are terminated with semicolon. Multiple instructions
- may appear on one line and one instruction may span multiple lines. Script-style comments are permitted between
- instructions but not between instruction fields.
-
-REFERENCES
- See the Qualcomm Atheros AR7x00 Firmware Technical Reference Manual section on the Module Operation message type for more
- information on MDIO Block format.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- The following command reads register instructions from text file mdio.txt and writes binary file mdio.bin. In this exam‐
- ple, the program acts as a filter, reading from stdin and writing to stdout. Progress and error messages, if any, are
- written to stderr.
-
- # mdioblock2 < mdio.txt > mdio.bin
-
- The following command reads register instructions from files physetup.dat then flowctl.dat then misc.ins and writes one
- binary MDIO block to file mdio.bin. The previous contents of file mdio.bin are overwritten.
-
- # mdioblock2 physetup.dat flowctl.dat misc.ins > mdio.bin
-
- An example register instruction file might look like this. Instructions have addr, data and mask fields. Instruction
- fields are separated by whitespace and instructions are terminate by a semicolon. Multiple instructions can appear on
- one line or one instruction can span multiple lines. Script-style comments are permitted between instructions but not
- between instruction fields.
-
- 2c 7e3f003f ffffffff;
- 8 500 ffffffff;
- 100 7d ffffffff; 30 19f005f2 ffffffff;
- 200
- 7d
- ffffffff;
- 300 7d ffffffff;
- # Hello World
- 400 7d ffffffff;
- 500 7d ffffffff;
-
-SEE ALSO
- amp(1), int6kmod(1), int6kmdio(1), int6kmdio2(1), mdioblock(1), mdiodump(1), mdiogen(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 mdioblock2(1)
-
-mdiodump(1) Qualcomm Atheros Open Powerline Toolkit mdiodump(1)
-
-NAME
- mdiodump - Qualcomm Atheros MDIO Custom Module Analyser
-
-SYNOPSIS
- mdiodump [options] file [file] [...]
-
-DESCRIPTION
- Read one or more binary MDIO program files and output MDIO instructions on stdout. These instructions are suitable as
- input to program mdioblock which outputs MDIO programs. See the mdioblock manpage for more information.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the PLC man page for an overview and installation
- instructions.
-
-OPTIONS
- -s Print summary information on stdout instead of MDIO instructions.
-
- -t phy_type
- Specify the PHY chipset that this MDIO module will be used with. The only supported option arguments are "ar8236"
- and "generic". Argument "ar8236" indicates that the MDIO register instructions are Atheros AR8236 specific. The
- AR8236 supports special MDIO registers and instructions in addition to generic MDIO registers and instructions.
- The default is "generic" which displays instructions as standard MDIO instructions. This option and option -b are
- mutually exclusive.
-
- -v Prints additional information on stdout. In particular, this option causes mdiodump to display every MDIO command
- present instead of just the simulation summary.
-
- -?,--help
- Displays program help information on stderr. This option takes precedence over all other options on the command
- line except version information.
-
- -!,--version
- Displays program version information on stderr. This option takes precedence over all other options on the com‐
- mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
-
-ARGUMENTS
- file The MDIO custom module file to operate on.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for information about generic MDIO register
- instruction. See the Qualcomm Atheros AR8236 Six-Port Fast Ethernet Switch Data Sheet for detailed information about
- AR8236 specific MDIO registers and instructions.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- None.
-
-SEE ALSO
- amp(1), int6kmod(1), int6kmdio(1), int6kmdio2(1), mdioblock(1), mdioblock2(1), mdiogen(1), plcmdio16(1), plcmdio32(1)
-
-CREDITS
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- Charles Maier <cmaier@qca.qualcomm.com>
- Marc Bertola <marc.bertola@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 mdiodump(1)
-
-mdustats(1) Qualcomm Atheros Open Powerline Toolkit mdustats(1)
-
-NAME
- mdustats
-
-SYNOPSIS
- mdustats [options] [device] [device] [...]
-
-DESCRIPTION
- Collect and display MDU traffic statisitcs using the Qualcomm Atheros vendor specific VS_MDU_TRAFFIC_STATS message.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -c command
- An integer indicating the type of statistics to be collected and reported. Permitted values are 0 through 255
- decimal but only 4 through 15 are valid at this time. This option is mandatory because the default value of 0 is
- invalid.
- 4 - retrieve traffic statistics on the slave side
- 5 - retrieve traffic statistics (master TX/RX) collected on the master side
- 6 - retrieve traffic statistics (slave TX/RX) collected on the master side
- 7 - retrieve traffic statistics (master/slave TX/RX) collected on the master side
- 8 - clear traffic statistics on the slave side
- 9 - clear traffic statistics (master TX/RX) colleted on the master side
- 10 - clear traffic statistics (slave TX/RX) collected on the master side
- 11 - clear traffic statistics (master/slave TX/RX) collected on the master side
- 12 - retrieve then clear traffic statistics collected on the slave side
- 13 - retrieve then clear traffic statistics (master TX/RX) collected on the master side
- 14 - retrieve then clear traffic statistics (slave TX/RX) collected on the master side
- 15 - retrieve then clear traffic statistics (master/slave TX/RX) collected on the master side
-
- -s session
- The session identifier used to associate request/confirm message pairs. Valid identifiers are 0 through 255. The
- default is 0.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -u unit
- The slave unit number. This is the same as the slave Terminal Equipment Identifier or TEI. Valid unit numbers
- are 0 through 255. Unit 0 is the default. This option is ignored when option -c specified any of the "slave
- side" commands 4, 8 or 12.
-
- -v Print additional information on stdout.
-
- -x Cause the program to exit on the first error instead of continuing with remaining iterations, operations or
- devices. Normally, the program reports errors and moves on to the next operation, iteration or device depending
- on the command line.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The Ethernet hardware address of some powerline device. More than one address may be specified on the command
- line. If more than one address is specified then operations are performed on each device in turn. The default
- address is local. as explained in the DEVICES section.
-
-DEVICES
- Powerline devices use Ethernet hardware, or Media Access Control (MAC), addresses. Device addresses are expressed as 12
- hexadecimal digits (0123456789ABCDEFabcdef) in upper, lower or mixed case. Individual octets may be separated by colons,
- for clarity, but not all octets need to be seperated. For example, "00b052000001", "00:b0:52:00:00:01" and
- "00b052:000001" are valid and equivalent.
-
- These symbolic addresses are recognized by this program and may be used instead of the actual address value.
-
- all Equivalent to "broadcast", described next.
-
- broadcast
- A synonym for the standard Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or
- foreign will respond to this address.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices will recognize this address but remote and foreign devices will not. A remote device is any
- device at the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros Powerline Firmware Technical Reference Manual for more information about MDU powerline configu‐
- ration and the VS_MDU_TRAFFIC_STATS message type.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure or content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- The following example collects and displays MDU traffic statistics on the slave side of the local device because option
- -c is 4. The local device is implicit because no device is specified on the command line.
-
- # mdustats -c 4
-
- The next example collects and displays MDU traffic statistics for slave 2 on the master side of device 00:b0:52:9F:E0:14
- because option -c is 5 and option -s is 2. The master device is explicit in this example.
-
- # mdustats -c 5 -u 2 00b0529FE014
-
-SEE ALSO
- plc(1), int6kstat(1), sada(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 mdustats(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * mdustats.c -
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <unistd.h>
-#include <stdlib.h>
-#include <stdint.h>
-#include <limits.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#include "../tools/getoptv.h"
-#include "../tools/putoptv.h"
-#include "../tools/memory.h"
-#include "../tools/number.h"
-#include "../tools/symbol.h"
-#include "../tools/types.h"
-#include "../tools/flags.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-/*====================================================================*
- * custom source files;
- *--------------------------------------------------------------------*/
-
-#ifndef MAKEFILE
-#include "../plc/Display.c"
-#include "../plc/Request.c"
-#include "../plc/ReadMME.c"
-#include "../plc/SendMME.c"
-#include "../plc/MDUTrafficStats.c"
-#include "../plc/Devices.c"
-#include "../plc/chipset.c"
-#include "../mme/UnwantedMessage.c"
-#endif
-
-#ifndef MAKEFILE
-#include "../tools/error.c"
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-#include "../tools/uintspec.c"
-#include "../tools/hexdump.c"
-#include "../tools/hexencode.c"
-#include "../tools/hexdecode.c"
-#include "../tools/hexstring.c"
-#include "../tools/todigit.c"
-#include "../tools/set32bitmap.c"
-#include "../tools/synonym.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/MMECode.c"
-#include "../mme/EthernetHeader.c"
-#include "../mme/QualcommHeader.c"
-#endif
-
-/*====================================================================*
- * program constants;
- *--------------------------------------------------------------------*/
-
-#define MDUSTATS_COMMAND 4
-#define MDUSTATS_SESSION 255
-#define MDUSTATS_SLAVE 0
-
-/*====================================================================*
- *
- * int main (int argc, char const * argv[]);
- *
- * parse command line, populate plc structure and perform selected
- * operations; show help summary if asked; see getoptv and putoptv
- * to understand command line parsing and help summary display; see
- * plc.h for the definition of struct plc;
- *
- * the command line accepts multiple MAC addresses and the program
- * performs the specified operations on each address, in turn; the
- * address order is significant but the option order is not; the
- * default address is a local broadcast that causes all devices on
- * the local H1 interface to respond but not those at the remote
- * end of the powerline;
- *
- * the default address is 00:B0:52:00:00:01; omitting the address
- * will automatically address the local device; some options will
- * cancel themselves if this makes no sense;
- *
- * the default interface is eth1 because most people use eth0 as
- * their principle network connection; you can specify another
- * interface with -i or define environment string PLC to make
- * that the default interface and save typing;
- *
- *
- *--------------------------------------------------------------------*/
-
-int main (int argc, char const * argv [])
-
-{
- extern struct channel channel;
- static char const * optv [] =
- {
- "c:ei:qs:t:u:v",
- "device [device] [...] [> stdout]",
- "Qualcomm Atheros INT6x00 Powerline Link Statistics",
-
-#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
-
- "c n\tcommand [" LITERAL (MDUSTATS_COMMAND) "]",
- "e\tredirect stderr to stdout",
- "q\tquiet mode",
- "s n\tsession identifier [" LITERAL (MDUSTATS_SESSION) "]",
- "t n\tread timeout is (n) milliseconds [" LITERAL (CHANNEL_TIMEOUT) "]",
- "u n\tslave unit number [" LITERAL (MDUSTATS_SLAVE) "]",
- "v\tverbose mode",
- (char const *) (0)
- };
-
-#include "../plc/plc.c"
-
- uint8_t command = MDUSTATS_COMMAND;
- uint8_t session = MDUSTATS_SESSION;
- uint8_t slave = MDUSTATS_SLAVE;
- signed c;
- if (getenv (PLCDEVICE))
- {
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (getenv (PLCDEVICE));
-
-#else
-
- channel.ifname = strdup (getenv (PLCDEVICE));
-
-#endif
-
- }
- optind = 1;
- while ((c = getoptv (argc, argv, optv)) != -1)
- {
- switch (c)
- {
- case 'c':
- command = (uint8_t)(uintspec (optarg, 0, 255));
- break;
- case 'e':
- dup2 (STDOUT_FILENO, STDERR_FILENO);
- break;
- case 'i':
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (optarg);
-
-#else
-
- channel.ifname = optarg;
-
-#endif
-
- break;
- case 'q':
- _setbits (channel.flags, CHANNEL_SILENCE);
- _setbits (plc.flags, PLC_SILENCE);
- break;
- case 's':
- session = (uint8_t)(uintspec (optarg, 0, 255));
- break;
- case 't':
- channel.timeout = (signed)(uintspec (optarg, 0, UINT_MAX));
- break;
- case 'u':
- slave = (uint8_t)(uintspec (optarg, 0, 255));
- break;
- case 'v':
- _setbits (channel.flags, CHANNEL_VERBOSE);
- _setbits (plc.flags, PLC_VERBOSE);
- break;
- default:
- break;
- }
- }
- argc -= optind;
- argv += optind;
- openchannel (&channel);
- if (!(plc.message = malloc (sizeof (* plc.message))))
- {
- error (1, errno, PLC_NOMEMORY);
- }
- if (!argc)
- {
- MDUTrafficStats (&plc, command, session, slave);
- }
- while ((argc) && (* argv))
- {
- if (!hexencode (channel.peer, sizeof (channel.peer), synonym (* argv, devices, SIZEOF (devices))))
- {
- error (1, errno, PLC_BAD_MAC, * argv);
- }
- MDUTrafficStats (&plc, command, session, slave);
- argc--;
- argv++;
- }
- free (plc.message);
- closechannel (&channel);
- return (0);
-}
-
-
-
-mme(1) Qualcomm Atheros Open Powerline Toolkit mme(1)
-
-NAME
- mme - Qualcomm Atheros vendor-specific message enumerator
-
-SYNOPSIS
- mme [options]
-
-DESCRIPTION
- Print Atheros vendor-specific message types and names with associated error codes and text on stdout. Output can be
- printed in various formats such as HTML, CSV and plain text. The plain text format is ideal for searching using a util‐
- ity like grep.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -c Output in Comma Separated Value (CSV) format. This format is suitable for import into a spreadsheet or database.
-
- -h Output in Hypertext Markup Language (HTML) format. This format is suitable for inclusion on a basic webpage.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using. See the HomePlug AV Specification for a description of all HomePlug AV message
- types. See the Qualcomm Atheros INT6000 Firmware Reference Manual for a description of Atheros Vendor Specific
- message types.
-
-EXAMPLES
- The following example prints Atheros vendor-specific message codes and names, along with associated error codes and text,
- on stdout. The output format is plain text because no formatting options were specified on the command line.
-
- # mme
- 0xA005 VS_WR_MEM.CNF 0x14 "Bad Checksum"
- 0xA005 VS_WR_MEM.CNF 0x1C "Bad Length"
- 0xA005 VS_WR_MEM.CNF 0x38 "Bad Address"
- 0xA005 VS_WR_MEM.CNF 0x3C "Bad Data Alignment"
- 0xA009 VS_RD_MEM.CNF 0x10 "Bad Offset"
- 0xA009 VS_RD_MEM.CNF 0x14 "Bad Length"
- 0xA00D VS_ST_MAC.CNF 0x10 "Bad Module ID"
- 0xA00D VS_ST_MAC.CNF 0x14 "Bad Image Checksum"
- 0xA00D VS_ST_MAC.CNF 0x1C "Bad Image Length"
- 0xA00D VS_ST_MAC.CNF 0x38 "Bad Image Load Address"
- 0xA00D VS_ST_MAC.CNF 0x3C "Bad Data Alignment"
- 0xA00D VS_ST_MAC.CNF 0x40 "Bad Start Address"
- 0xA011 VS_GET_NVM.CNF 0x10 "No NVRAM"
- 0xA01D VS_RS_DEV.CNF 0x01 "Device Failed to Reset"
- 0xA01D VS_RS_DEV.CNF 0x02 "Device Busy"
- 0xA021 VS_WR_MOD.CNF 0x10 "Bad Module"
- 0xA021 VS_WR_MOD.CNF 0x12 "Bad Length"
- 0xA021 VS_WR_MOD.CNF 0x14 "Bad Checksum"
- 0xA021 VS_WR_MOD.CNF 0x20 "Bad Offset"
- 0xA021 VS_WR_MOD.CNF 0x40 "Operation Blocked"
- 0xA021 VS_WR_MOD.CNF 0x50 "Fail to lock NVM"
- 0xA025 VS_RD_MOD.CNF 0x10 "Bad Module"
- 0xA025 VS_RD_MOD.CNF 0x12 "Bad Length"
- 0xA025 VS_RD_MOD.CNF 0x14 "Bad Checksum"
- ......
-
- The next example does the same thing but output is piped into the grep utility which selects only those lines containing
- the substring "0x40". The result shows that this error code is used by two different Atheros vendor-specific messages.
-
- # mme | grep "0x40"
- 0xA00D VS_ST_MAC.CNF 0x40 "Bad Start Address"
- 0xA021 VS_WR_MOD.CNF 0x40 "Operation Blocked"
- ......
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information is not available. Qualcomm Atheros reserves the right to modify management mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- amp(1), efsu(1), hpav(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 mme(1)
-
-modpib(1) Qualcomm Atheros Open Powerline Toolkit modpib(1)
-
-NAME
- modpib - Qualcomm Atheros PIB File Editor
-
-SYNOPSIS
- modpib [options] filename
-
-DESCRIPTION
- Change device identity parameters in a PIB file and update the checksum. Device identity parameters are the MAC, DAK,
- NMK and the Manufacturer, Network and User HFID. Collectively, they establish the device network identity.
-
- This program is the safe way to edit identity parameters since only valid PIB files can be edited and only selected val‐
- ues changed. In addition, critical cross-parameter updates are automatically applied.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -C mode
- Set Central Coordinator Selection mode. Permitted values for mode are 0=Auto, 1=Never, 2=Always, 3=UserAssigned
- and 4=Covert.
-
- -D xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx
- The new Device Access Key (DAK). This key will replace the original DAK. Keys are 16 hex octet strings. Octets
- may be seperated by optional colons. The symbol none, key1 or key2 may be specified in place of a hexadecimal
- string, for convenience. Use program hpavkey to compute the DAK for a specific password, if required.
-
- -L level
- Set security level. The security level is written into the PreferredNID. Level 0 enables pushbutton pairing.
- Level 1 disables it. The default secutity level is 0.
-
- -M xx:xx:xx:xx:xx:xx
- The new Media Access Control (MAC) address. This address will replace the original address, if specified.
- Addresses are 6 hex octet strings. Octets may be seperated by optional colons. Qualcomm Atheros powerline
- devices derive their MAC address from their PIB and each device on a network must have a unique address. To
- facilitate the assignement of unique addresses, substituting the word "auto", "next" or "plus" will cause the
- original MAC address to be incremented before a new checksum is calculated. Successive uses of this option will
- continue to increment the stored address. You can inspect the stored MAC address with "chkpib -v pibfile".
-
- -N xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx
- The new Network Membership Key (NMK). This key will replace the original NMK, create a new PreferredNID and clear
- the AVLNMembership bit. Keys are 16 hex octets. Optionally, octets may be seperated colons. The symbol key1 or
- key2 can be specified in place of a hexadecimal string, for convenience. Use program hpavkey to compute the NMK
- from a specific password, if required.
-
- -P filename
- The specified file is loaded from disk and written into the prescaler section of the PIB. This file must be in
- the format used by the Qualcomm Atheros Windows Device Manager, which is a two column file, each column consisting
- of 8 ASCII alpha-numeric characters. The first column corresponds to the array index value (00000000 through
- 00001155, decimal), and the second column is the value stored at that position in the prescaler array (00000000
- through 000000ff, hexadecimal). The two columns may be separated by any whitespace characters when using this
- tool. However, for full compatibility with the Windows Device Manager it is advised to use a single space between
- the columns. The '#' character may also be used at the start of a line to denote a comment.
-
- -S string
- The new manufacturing string. The maximum length is 63 characters.
-
- -T string
- The new network name string. The maximum length is 63 character.
-
- -U string
- The new username string. The maximum length is 63 characters.
-
- -q Enable quiet mode. This option has no effect at present.
-
- -v Print PIB identity parameters on stdout after changes have been applied. This option helps verify that changes
- have been applied correctly. It can also be used, without changes, to merely inspect existing parameters.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Qualcomm Atheros Technical Support so that they know exactly which
- version of the Linux Toolkit you are using.
-
-ARGUMENTS
- filename
- The name of the PIB file to be modified. No assumptions are made based on filename and no filename conventions
- are enforced.
-
-KEYS
- Encryption keys are long, tedious to type and prone to error. For convenience, symbolic names may be used to specify the
- key for options -D and -N. Symbolic name "none" translates to zeros. Symbolic name "key1" translates to the HomePlug AV
- compliant key for pass phrase "HomePlugAV". Symbolic name "key2" translates to the HomePlug AV compliant key for pass
- phrase "HomePlugAV0123". The actual key that is generated for key1 or key2 will differ depending on context.
-
-EXAMPLES
- The following example replaces the MAC address in pib file abc.pib and computes a new checksum. The input file is over-
- written. A command like this one can be used to establish the start MAC address when downloading a series of PIBs.
-
- # modpib -M 00:b0:52:DA:DA:FF abc.pib
-
- The following example increments the MAC address in pib file abc.pib and computes a new checksum. The word auto, next or
- plus, in place of a MAC address, will increment the old address each time the command is executed. This command can be
- used to ensure that unique and consecutive MAC addresses are used each time a PIB is downloaded.
-
- # modpib -M auto abc.pib
-
- The following command updates pib file abc.pib with the DAK and NMK read from the device connected to eth0. In similar
- fashion, program rkey can be used to compute random key values from a keyfile.
-
- # modpib -D $(int6kid -Di eth0) -N $(rkey secret.key -M) abc.pib
-
- The following example displays the current value of keys and strings stored in pib file abc.pib because option -v is
- present. This can be used to verify PIB identity settings before or after an edit.
-
- # modpib -v abc.pib
- PIB 4-4 15560 bytes
- MAC 00:B0:52:00:00:01
- DAK 68:9F:07:4B:8B:02:75:A2:71:0B:0B:57:79:AD:16:30 (HomePlugAV)
- NMK 50:D3:E4:93:3F:85:5B:70:40:78:4D:F8:15:AA:8D:B7 (HomePlugAV)
- NID B0:F2:E6:95:66:6B:03
- NET Qualcomm Atheros Enabled Network
- MFG Qualcomm Atheros HomePlug AV Device
- USR Qualcomm Atheros Enabled Product
- CCo Auto
- MDU N/A
-
-DISCLAIMER
- PIB file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information is not
- available. Qualcomm Atheros reserves the right to modify PIB file structure or content in future firmware releases with‐
- out any obligation to notify or compensate users of this program.
-
-SEE ALSO
- chkpib(7), chkpib2(7), getpib(7), modpib(1), pib2xml(1), pibcomp(1), pibdump(1), setpib(1), xml2pib(1)
-
-CREDITS
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 modpib(1)
-
-/*
- * Copyright (c) 1994, 1996
- * The Regents of the University of California. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. 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.
- * 3. All advertising materials mentioning features or use of this software
- * must display the following acknowledgement:
- * This product includes software developed by the Computer Systems
- * Engineering Group at Lawrence Berkeley Laboratory.
- * 4. Neither the name of the University nor of the Laboratory may be used
- * to endorse or promote products derived from this software without
- * specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
- *
- * @(#) $Header: /tcpdump/master/libpcap/pcap/namedb.h,v 1.1 2006/10/04 18:09:22 guy Exp $ (LBL)
- */
-
-#ifndef lib_pcap_namedb_h
-#define lib_pcap_namedb_h
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/*
- * As returned by the pcap_next_etherent()
- * XXX this stuff doesn't belong in this interface, but this
- * library already must do name to address translation, so
- * on systems that don't have support for /etc/ethers, we
- * export these hooks since they'll
- */
-struct pcap_etherent {
- u_char addr[6];
- char name[122];
-};
-#ifndef PCAP_ETHERS_FILE
-#define PCAP_ETHERS_FILE "/etc/ethers"
-#endif
-struct pcap_etherent *pcap_next_etherent(FILE *);
-u_char *pcap_ether_hostton(const char*);
-u_char *pcap_ether_aton(const char *);
-
-bpf_u_int32 **pcap_nametoaddr(const char *);
-#ifdef INET6
-struct addrinfo *pcap_nametoaddrinfo(const char *);
-#endif
-bpf_u_int32 pcap_nametonetaddr(const char *);
-
-int pcap_nametoport(const char *, int *, int *);
-int pcap_nametoportrange(const char *, int *, int *, int *);
-int pcap_nametoproto(const char *);
-int pcap_nametoeproto(const char *);
-int pcap_nametollc(const char *);
-/*
- * If a protocol is unknown, PROTO_UNDEF is returned.
- * Also, pcap_nametoport() returns the protocol along with the port number.
- * If there are ambiguous entried in /etc/services (i.e. domain
- * can be either tcp or udp) PROTO_UNDEF is returned.
- */
-#define PROTO_UNDEF -1
-
-/* XXX move these to pcap-int.h? */
-int __pcap_atodn(const char *, bpf_u_int32 *);
-int __pcap_atoin(const char *, bpf_u_int32 *);
-u_short __pcap_nametodnaddr(const char *);
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif
-
-nics(1) Qualcomm Atheros Open Powerline Toolkit nics(1)
-
-NAME
- nics - Host Network Interface Enumerator
-
-SYNOPSIS
- nics
-
-DESCRIPTION
- Search host for Ethernet interfaces and display the interface index, hardware address, IP address, interface name and
- interface description on stdout. This provides a simple, consistent, cross-platform format for presenting interface
- information to scripts and user applications.
-
-COMMENTS
- This program illustrates use of basic Atheros Ethernet interface C functions. See program ifs for an alternative C++
- implementation.
-
-OPTIONS
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Intellon Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- None.
-
-EXAMPLES
- The following example searches a Linux host and displays information about available interfaces.
-
- # nics
- 2 00:50:04:A5:D8:98 000.000.000.000 eth4 eth4
- 3 00:0F:EA:4B:98:CB 192.168.172.239 eth3 eth3
-
- The following example searches a MacOSX host and displays information about available interfaces. Observe that interface
- names are varied.
-
- # nics
- 4 00:26:BB:52:DD:A8 192.168.172.149 en0 en0
- 6 04:1E:64:F0:FB:EC 000.000.000.000 en1 en1
-
-SEE ALSO
- amp(1), ifs(1), nics(1), pcapdevs(1), plcnets(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 nics(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- *
- * nvm.c -
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NVM_SOURCE
-#define NVM_SOURCE
-
-#include "../nvm/nvm.h"
-
-char const * nvm_platforms [NVM_PLATFORMS] =
-
-{
- "INT6000",
- "INT6300",
- "INT6400",
- "AR7400",
- "AR7420"
-};
-
-char const * nvm_imagetypes [NVM_IMAGETYPES] =
-
-{
- "Generic Image",
- "Synopsis Configuration",
- "Denali Configuration",
- "Denali Applet",
- "Runtime Firmware",
- "OAS Client",
- "Custom Image",
- "Memory Control Applet",
- "Power Management Applet",
- "OAS Client IP Stack",
- "OAS Client TR069",
- "SoftLoader",
- "Flash Layout",
- "Unknown13",
- "Chain Manifest",
- "Runtime Parameters",
- "Custom Module In Scratch",
- "Custom Module Update Applet"
-};
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed nvmfile (struct _file_ const * file);
- *
- * nvm.h
- *
- * open an NVM file and validate it by walking the header and image
- * chain and validating all checksums; rewind valid files; return a
- * file descriptor on success or terminate the program on error;
- *
- * the checksum of the entire header, including header checksum, is
- * always 0 for valid headers; similarly, the checksum of the image
- * and image checksum is always 0 for valid images;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NVMFILE_SOURCE
-#define NVMFILE_SOURCE
-
-#include "../tools/endian.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../nvm/nvm.h"
-
-signed nvmfile (struct _file_ const * file)
-
-{
- uint32_t version;
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- if (read (file->file, &version, sizeof (version)) != sizeof (version))
- {
- error (1, errno, FILE_CANTREAD, file->name);
- }
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- if (LE32TOH (version) == 0x60000000)
- {
- return (nvmfile1 (file));
- }
- return (nvmfile2 (file));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed nvmfile1 (struct _file_ const * file);
- *
- * validate a Thunderbolt/Lightning firmware image file;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NVMFILE1_SOURCE
-#define NVMFILE1_SOURCE
-
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/memory.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../nvm/nvm.h"
-
-signed nvmfile1 (struct _file_ const * file)
-
-{
- unsigned module = 0;
- struct nvm_header1 nvm_header;
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- do
- {
- if (read (file->file, &nvm_header, sizeof (nvm_header)) != sizeof (nvm_header))
- {
- error (1, errno, NVM_HDR_CANTREAD, file->name, module);
- }
- if (LE32TOH (nvm_header.HEADERVERSION) != 0x60000000)
- {
- error (1, errno, NVM_HDR_VERSION, file->name, module);
- }
- if (checksum32 (&nvm_header, sizeof (nvm_header), 0))
- {
- error (1, errno, NVM_HDR_CHECKSUM, file->name, module);
- }
- if (fdchecksum32 (file->file, LE32TOH (nvm_header.IMAGELENGTH), nvm_header.IMAGECHECKSUM))
- {
- error (1, errno, NVM_IMG_CHECKSUM, file->name, module);
- }
- module++;
- }
- while (nvm_header.NEXTHEADER);
- if (lseek (file->file, 0, SEEK_CUR) != lseek (file->file, 0, SEEK_END))
- {
- error (1, errno, NVM_HDR_LINK, file->name, module);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed nvmfile2 (struct _file_ const * file);
- *
- * validate a Panther/Lynx firmware module file;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NVMFILE2_SOURCE
-#define NVMFILE2_SOURCE
-
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/memory.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../nvm/nvm.h"
-
-signed nvmfile2 (struct _file_ const * file)
-
-{
- unsigned module = 0;
- struct nvm_header2 nvm_header;
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- do
- {
- if (read (file->file, &nvm_header, sizeof (nvm_header)) != sizeof (nvm_header))
- {
- error (1, errno, NVM_HDR_CANTREAD, file->name, module);
- }
- if (LE16TOH (nvm_header.MajorVersion) != 1)
- {
- error (1, errno, NVM_HDR_VERSION, file->name, module);
- }
- if (LE16TOH (nvm_header.MinorVersion) != 1)
- {
- error (1, errno, NVM_HDR_VERSION, file->name, module);
- }
- if (checksum32 (&nvm_header, sizeof (nvm_header), 0))
- {
- error (1, errno, NVM_HDR_CHECKSUM, file->name, module);
- }
- if (fdchecksum32 (file->file, LE32TOH (nvm_header.ImageLength), nvm_header.ImageChecksum))
- {
- error (1, errno, NVM_IMG_CHECKSUM, file->name, module);
- }
- module++;
- }
- while (~nvm_header.NextHeader);
- if (lseek (file->file, 0, SEEK_CUR) != lseek (file->file, 0, SEEK_END))
- {
- error (1, errno, NVM_HDR_LINK, file->name, module);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void nvmlock2 (struct nvm_header2 * header);
- *
- * example function to update an NVM image header after the image
- * had been modified; this assumes that the updated image follows
- * the header in memory.
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NVMLOCK2_SOURCE
-#define NVMLOCK2_SOURCE
-
-#include "../tools/memory.h"
-#include "../nvm/nvm.h"
-
-void nvmlock2 (struct nvm_header2 * header)
-
-{
- header->ImageChecksum = checksum32 ((char *)(header) + sizeof (* header), LE32TOH (header->ImageLength), 0);
- header->HeaderChecksum = checksum32 (header, sizeof (* header), header->HeaderChecksum);
- return;
-}
-
-#endif
-
-
-
-nvmmerge(1) Qualcomm Atheros Open Powerline Toolkit nvmmerge(1)
-
-NAME
- nvmmerge - Qualcomm Atheros PLC Firmware Image File Splicer
-
-SYNOPSIS
- nvmmerge [options] file [file] [...] [>stdout]
-
-DESCRIPTION
- Combine multiple binary image files into a single Qualcomm Atheros binary image file, leaving the original files intact.
-
- Qualcomm Atheros image files consist of a chain of image headers, each followed by an image block. Image blocks can con‐
- tain data, applets or programs. Atheros software reads the header chain and decides which images to download and execute
- based on information in image headers. Tampering with image headers or images may void some contractual obligations made
- by Atheros.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -q Suppresses printing of routine messages. This option has no efect.
-
- -v Print input file names on stderr as they are merged.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of a Qualcomm Atheros image file. By convention, these image files have a .nvm file extension but this
- program does not enforce that convention. Invalid image files will be rejected causing the output to be incom‐
- plete.
-
-EXAMPLES
- The following example combines three files, abc-00.nvm, abc-01.nvm and abc-06.nvm into one file abc.nvm. Option -v dis‐
- plays the input file names as they are merged. Program output is in binary format and so output should be directed to a
- file or pipe and not the console.
-
- # nvmmerge -v abc-00.nvm abc-01.nvm abc-06.nvm > abc.nvm
- nvmmerge: abc-00.nvm
- nvmmerge: abc-01.nvm
- nvmmerge: abc-06.nvm
-
-DISCLAIMER
- Atheros image file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public informa‐
- tion is not available. Qualcomm Atheros reserves the right to change file structure or content in future firmware
- releases without any obligation to notify or compensate users of this program. This program is reserved for use by Qual‐
- comm Atheros Field Engineers. Use of this program may void certain contractual obligations made by Qualcomm Atheros.
-
-SEE ALSO
- ampboot(1), amptest(1), amptool(1), chknvm(1), chknvm2(1), int6k(1), int6kf(1), int6ktest(1), nvmsplit(1), plcboot(1),
- plctest(1), plctool(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 nvmmerge(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void nvmpeek (void const * memory);
- *
- * nvm.h
- *
- * assume memory points to a Qualcomm Atheros .nvm file header and
- * call the appropriate function to display it based on the header
- * version number;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NVMPEEK_SOURCE
-#define NVMPEEK_SOURCE
-
-#include "../tools/memory.h"
-#include "../nvm/nvm.h"
-
-void nvmpeek (void const * memory)
-
-{
- if (LE32TOH (*(uint32_t *)(memory)) == 0x60000000)
- {
- nvmpeek1 (memory);
- return;
- }
- nvmpeek2 (memory);
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void nvmpeek1 (void const * memory);
- *
- * print a memory resident firmware image header on stdout;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NVMPEEK1_SOURCE
-#define NVMPEEK1_SOURCE
-
-#include <stdio.h>
-
-#include "../tools/memory.h"
-#include "../tools/format.h"
-#include "../nvm/nvm.h"
-
-void nvmpeek1 (void const * memory)
-
-{
- extern char const * nvm_imagetypes [];
- extern char const * nvm_platforms [];
- struct nvm_header1 * nvm_header = (struct nvm_header1 *)(memory);
- char const * string = "Unknown";
- char platform [100];
- printf ("\tHeader Version = 0x%08X-%02X\n", LE32TOH (nvm_header->HEADERVERSION), nvm_header->HEADERMINORVERSION);
- printf ("\tHeader Checksum = 0x%08X\n", LE32TOH (nvm_header->HEADERCHECKSUM));
- printf ("\tHeader Next = 0x%08X\n", LE32TOH (nvm_header->NEXTHEADER));
- printf ("\tFlash Address = 0x%08X\n", LE32TOH (nvm_header->IMAGEROMADDR));
- printf ("\tImage Address = 0x%08X\n", LE32TOH (nvm_header->IMAGEADDRESS));
- printf ("\tEntry Address = 0x%08X\n", LE32TOH (nvm_header->ENTRYPOINT));
- printf ("\tImage Checksum = 0x%08X\n", LE32TOH (nvm_header->IMAGECHECKSUM));
- printf ("\tImage Size = 0x%08X (%d)\n", LE32TOH (nvm_header->IMAGELENGTH), LE32TOH (nvm_header->IMAGELENGTH));
- if (LE32TOH (nvm_header->IMAGETYPE) < NVM_IMAGETYPES)
- {
- string = nvm_imagetypes [LE32TOH (nvm_header->IMAGETYPE)];
- }
- printf ("\tImage Type = %s\n", string);
- strfbits (platform, sizeof (platform), nvm_platforms, "|", LE16TOH (nvm_header->IGNOREMASK));
- printf ("\tImage Omit = %s\n", platform);
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void nvmpeek2 (void const * memory);
- *
- * print a memory resident firmware image header on stdout;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NVMPEEK2_SOURCE
-#define NVMPEEK2_SOURCE
-
-#include <stdio.h>
-
-#include "../tools/memory.h"
-#include "../tools/format.h"
-#include "../nvm/nvm.h"
-
-void nvmpeek2 (void const * memory)
-
-{
- extern char const * nvm_imagetypes [];
- extern char const * nvm_platforms [];
- struct nvm_header2 * nvm_header = (struct nvm_header2 *)(memory);
- char const * string = "Unknown";
- char platform [100];
- printf ("\tHeader Version = 0x%04x-0x%04x\n", LE16TOH (nvm_header->MajorVersion), nvm_header->MinorVersion);
- printf ("\tHeader Checksum = 0x%08X\n", LE32TOH (nvm_header->HeaderChecksum));
- printf ("\tHeader Next = 0x%08X\n", LE32TOH (nvm_header->NextHeader));
- printf ("\tHeader Prev = 0x%08X\n", LE32TOH (nvm_header->PrevHeader));
- printf ("\tFlash Address = 0x%08X\n", LE32TOH (nvm_header->ImageNvmAddress));
- printf ("\tImage Address = 0x%08X\n", LE32TOH (nvm_header->ImageAddress));
- printf ("\tEntry Address = 0x%08X\n", LE32TOH (nvm_header->EntryPoint));
- printf ("\tEntry Version = 0x%04X\n", LE16TOH (nvm_header->AppletEntryVersion));
- printf ("\tImage Checksum = 0x%08X\n", LE32TOH (nvm_header->ImageChecksum));
- printf ("\tImage ModuleID = 0x%04X\n", LE32TOH (nvm_header->ModuleID));
- printf ("\tImage ModuleSubID = 0x%04X\n", LE32TOH (nvm_header->ModuleSubID));
- printf ("\tImage Size = 0x%08X (%d)\n", LE32TOH (nvm_header->ImageLength), LE32TOH (nvm_header->ImageLength));
- if (LE32TOH (nvm_header->ImageType) < NVM_IMAGETYPES)
- {
- string = nvm_imagetypes [LE32TOH (nvm_header->ImageType)];
- }
- printf ("\tImage Type = %s\n", string);
- strfbits (platform, sizeof (platform), nvm_platforms, "|", LE16TOH (nvm_header->ExecuteMask));
- printf ("\tImage Exec = %s\n", platform);
-
-#if 0
-
- printf ("\tReserved = 0x%04X\n", LE16TOH (nvm_header->Reserved0));
- printf ("\tReserved = 0x%08X\n", LE32TOH (nvm_header->Reserved1));
- printf ("\tReserved = 0x%08X\n", LE32TOH (nvm_header->Reserved2));
- printf ("\tReserved = 0x%08X\n", LE32TOH (nvm_header->Reserved3));
- printf ("\tReserved = 0x%08X\n", LE32TOH (nvm_header->Reserved4));
- printf ("\tReserved = 0x%08X\n", LE32TOH (nvm_header->Reserved5));
- printf ("\tReserved = 0x%08X\n", LE32TOH (nvm_header->Reserved6));
- printf ("\tReserved = 0x%08X\n", LE32TOH (nvm_header->Reserved7));
- printf ("\tReserved = 0x%08X\n", LE32TOH (nvm_header->Reserved8));
- printf ("\tReserved = 0x%08X\n", LE32TOH (nvm_header->Reserved9));
- printf ("\tReserved = 0x%08X\n", LE32TOH (nvm_header->Reserved10));
- printf ("\tReserved = 0x%08X\n", LE32TOH (nvm_header->Reserved11));
-
-#endif
-
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed nvmseek1 (signed fd, char const * filename, struct nvm_header1 * nvm_header, uint32_t imagetype);
- *
- * nvm.h
- *
- * search a thunderbolt/lightning PIB file for the next image of a
- * given type; return 0 on success or -1 on failure to find another
- * image of the given type;
- *
- * the call must provide an image header strucuture for use while
- * searching; on success, that structure will contain information
- * about the image and file will be positioned to the start of
- * the image;
- *
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NVMSEEK1_SOURCE
-#define NVMSEEK1_SOURCE
-
-#include <unistd.h>
-
-#include "../tools/endian.h"
-#include "../tools/error.h"
-#include "../pib/pib.h"
-#include "../nvm/nvm.h"
-
-signed nvmseek1 (signed fd, char const * filename, struct nvm_header1 * nvm_header, uint32_t imagetype)
-
-{
- unsigned module = 0;
- do
- {
- if (read (fd, nvm_header, sizeof (* nvm_header)) != sizeof (* nvm_header))
- {
- error (1, errno, NVM_HDR_CANTREAD, filename, module);
- }
- if (LE32TOH (nvm_header->HEADERVERSION) != 0x60000000)
- {
- error (1, errno, NVM_HDR_VERSION, filename, module);
- }
- if (checksum32 (nvm_header, sizeof (* nvm_header), 0))
- {
- error (1, 0, NVM_HDR_CHECKSUM, filename, module);
- }
- if (nvm_header->IMAGETYPE == imagetype)
- {
- return (0);
- }
- if (fdchecksum32 (fd, LE32TOH (nvm_header->IMAGELENGTH), nvm_header->IMAGECHECKSUM))
- {
- error (1, ECANCELED, NVM_IMG_CHECKSUM, filename, module);
- }
- module++;
- }
- while (~nvm_header->NEXTHEADER);
- if (lseek (fd, 0, SEEK_CUR) != lseek (fd, 0, SEEK_END))
- {
- error (1, errno, NVM_HDR_LINK, filename, module);
- }
- return (-1);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed nvmseek2 (signd fd, char const * filename, struct nvm_header2 * nvm_header, uint32_t imagetype);
- *
- * nvm.h
- *
- * search a panther/lynx PIB file for the next image of a given
- * type; return 0 on success or -1 on failure to find another
- * image of the given type;
- *
- * the call must provide an image header strucuture for use while
- * searching; on success, that structure will contain information
- * about the image and file will be positioned to the start of
- * the image;
- *
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NVMSEEK2_SOURCE
-#define NVMSEEK2_SOURCE
-
-#include <unistd.h>
-
-#include "../tools/endian.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../pib/pib.h"
-#include "../nvm/nvm.h"
-
-signed nvmseek2 (signed fd, char const * filename, struct nvm_header2 * nvm_header, uint32_t imagetype)
-
-{
- unsigned module = 0;
- uint32_t origin = ~0;
- uint32_t offset = 0;
- do
- {
- if (read (fd, nvm_header, sizeof (* nvm_header)) != sizeof (* nvm_header))
- {
- error (1, errno, NVM_HDR_CANTREAD, filename, module);
- }
- if (LE16TOH (nvm_header->MajorVersion) != 1)
- {
- error (1, 0, "(0) " NVM_HDR_VERSION , filename, module);
- }
- if (LE16TOH (nvm_header->MinorVersion) != 1)
- {
- error (1, 0, "(1) " NVM_HDR_VERSION, filename, module);
- }
- if (checksum32 (nvm_header, sizeof (* nvm_header), 0))
- {
- error (1, 0, NVM_HDR_CHECKSUM, filename, module);
- }
- if (LE32TOH (nvm_header->PrevHeader) != origin)
- {
- error (1, 0, NVM_HDR_LINK, filename, module);
- }
- if (LE32TOH (nvm_header->ImageType) == imagetype)
- {
- return (0);
- }
- if (fdchecksum32 (fd, LE32TOH (nvm_header->ImageLength), nvm_header->ImageChecksum))
- {
- error (1, ECANCELED, NVM_IMG_CHECKSUM, filename, module);
- }
- origin = offset;
- offset = LE32TOH (nvm_header->NextHeader);
- module++;
- }
- while (~nvm_header->NextHeader);
- if (lseek (fd, 0, SEEK_CUR) != lseek (fd, 0, SEEK_END))
- {
- error (1, errno, NVM_HDR_LINK, filename, module);
- }
- if (lseek (fd, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, filename);
- }
- return (-1);
-}
-
-#endif
-
-
-
-nvmsplit(1) Qualcomm Atheros Open Powerline Toolkit nvmsplit(1)
-
-NAME
- nvmsplit - Qualcomm Atheros PLC Firmware Image File Slicer
-
-SYNOPSIS
- nvmsplit [options] file [file] [...]
-
-DESCRIPTION
- Extract all images from an Atheros binary image file, leaving the original files intact. Extracted images appear in
- files having the input file basename with sequence numbers indicating the relative position of the image within the orig‐
- inal file. For example, image file abc.nvm might result in files abc-00.nvm, abc-01.nvm, abc-02.nvm and so on. Each
- output file is a valid, single-image file and so they can be combined using program nvmmerge.
-
- Atheros image files consist of a chain of image headers, each followed by an image block. Image blocks can contain data,
- applets or programs. Atheros software reads the header chain and decides which images to download and execute based on
- information in the image headers. Tampering with image headers or images may void some contractual obligations made by
- Atheros.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -q Suppress routine messages. This option has no effect at this time.
-
- -v Print component file names on stderr as they are created.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of an Atheros image file. By convention, Atheros Image files have a .nvm file extension but this program
- does not enforce this convention. Invalid image files will be rejected causing the output to be incomplete.
-
-EXAMPLES
- The following example reads Atheros image file abc.nvm and creates one or more output files. Each file contains one
- image with associated header.
-
- # nvmsplit abc.nvm -v
- nvmsplit: abc.nvm --> abc-00.nvm
- nvmsplit: abc.nvm --> abc-01.nvm
- nvmsplit: abc.nvm --> abc-02.nvm
- nvmsplit: abc.nvm --> abc-03.nvm
-
-DISCLAIMER
- Atheros image file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public informa‐
- tion is not available. Qualcomm Atheros reserves the right to change file structure or content in future firmware
- releases without any obligation to notify or compensate users of this program. This program is reserved for use by
- Atheros Field Engineers. Use of this program may void some contractual obligations made by Atheros.
-
-SEE ALSO
- chknvm(1), int6k(1), int6kf(1), int6ktest(1), nvmmerge(1), setnvm(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 nvmsplit(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * nvram.c - NVRAM type information;
- *
- * nvram.h
- *
- * nvram codes for display purposes;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NVRAM_SOURCE
-#define NVRAM_SOURCE
-
-#include "../tools/types.h"
-#include "../tools/symbol.h"
-#include "../ram/nvram.h"
-
-#define NVRAM_TYPES (sizeof (nvram_types) / sizeof (struct _type_))
-
-static const struct _type_ nvram_types [] =
-
-{
- {
- 0x00000005,
- "500KB"
- },
- {
- 0x00000010,
- "1MB"
- },
- {
- 0x00000011,
- "M25P20"
- },
- {
- 0x00000012,
- "M25P40"
- },
- {
- 0x00000013,
- "M25P80"
- },
- {
- 0x00000014,
- "M25P16_ES"
- },
- {
- 0x00000015,
- "M25P32_ES"
- },
- {
- 0x00000016,
- "M25P64_ES"
- },
- {
- 0x00000046,
- "AT26DF161"
- },
- {
- 0x00000146,
- "AT26DF161A"
- },
- {
- 0x00001020,
- "M25P05A"
- },
- {
- 0x00001120,
- "M25P10A"
- },
- {
- 0x00001402,
- "S25FL016AOLMFI01"
- },
- {
- 0x00001420,
- "M25P80"
- },
- {
- 0x00001520,
- "M25P16"
- },
- {
- 0x00001532,
- "FM25S16/FM25Q16"
- },
- {
- 0x00001571,
- "M25PX16"
- },
- {
- 0x00001620,
- "M25P32"
- },
- {
- 0x00001632,
- "FM25Q32"
- },
- {
- 0x00001720,
- "M25P64"
- },
- {
- 0x00004125,
- "SST25VF016B"
- }
-};
-
-char const * NVRAMName (uint16_t NVRAMTYPE)
-
-{
- return (typename (nvram_types, NVRAM_TYPES, NVRAMTYPE, "Unknown NVRAM Type"));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * nvnvm.h - nvram definitions and declarations;
- *
- * The Boot ROM reads a linked list of NVM headers containing
- * information about the size, location and execution address
- * of various software images;
- *
- * See INT6300 Boot ROM Software Design Specification for more
- * information; the document may not be available to some
- * customers so don't push it;
- *
- *. Qualcomm Atheros HomePlug AV Powerline Toolkit;
- *: Copyright (c) 2006-2010 by Intellon Corporation; ALL RIGHTS RESERVED;
- *; For demonstration and evaluation only; Not for production use.
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NVRAM_HEADER
-#define NVRAM_HEADER
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <stdint.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#include "../tools/types.h"
-
-/*====================================================================*
- * constants;
- *--------------------------------------------------------------------*/
-
-#define NVRAM_500KB 0x00000005
-#define NVRAM_1MB 0x00000010
-#define NVRAM_2MB 0x00000011
-#define NVRAM_4MB 0x00000012
-#define NVRAM_8MB 0x00000013
-#define NVRAM_16MB 0x00000014
-#define NVRAM_32MB 0x00000015
-
-#define NVRAM_M25P20 = 0x00000011;
-#define NVRAM_M25P40 = 0x00000012;
-#define NVRAM_M25P80 = 0x00000013;
-#define NVRAM_M25P16_ES = 0x00000014;
-#define NVRAM_M25P32_ES = 0x00000015;
-#define NVRAM_M25P64_ES = 0x00000016;
-#define NVRAM_AT26DF161 = 0x00000046;
-#define NVRAM_AT26DF161A = 0x00000146;
-#define NVRAM_M25P05A = 0x00001020;
-#define NVRAM_M25P10A = 0x00001120;
-#define NVRAM_M25P16 = 0x00001520;
-#define NVRAM_M25PX16 = 0x00001571;
-#define NVRAM_M25P32 = 0x00001620;
-#define NVRAM_M25P64 = 0x00001720;
-#define NVRAM_FM25S16 = 0x00001532;
-#define NVRAM_FM25Q16 = 0x00001532;
-#define NVRAM_FM25Q32 = 0x00001632;
-#define NVRAM_SST25VF016B = 0x00004125;
-
-/*====================================================================*
- * variables;
- *--------------------------------------------------------------------*/
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
-typedef struct __packed config_nvram
-
-{
- uint32_t NVRAMTYPE;
- uint32_t NVRAMPAGE;
- uint32_t NVRAMBLOCK;
- uint32_t NVRAMSIZE;
-}
-
-config_nvram;
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
-/*====================================================================*
- * functions;
- *--------------------------------------------------------------------*/
-
-void nvrampeek (struct config_nvram *);
-char const * NVRAMName (uint16_t nvramtype);
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void nvrampeek(struct config_nvram * config_nvram);
- *
- * nvram.h
- *
- * print an nvram configuration block;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef NVRAMPEEK_SOURCE
-#define NVRAMPEEK_SOURCE
-
-#include <stdio.h>
-
-#include "../ram/nvram.h"
-#include "../tools/memory.h"
-#include "../tools/symbol.h"
-
-void nvrampeek (struct config_nvram * config_nvram)
-
-{
- printf ("TYPE=0x%02X ", LE32TOH (config_nvram->NVRAMTYPE));
- printf ("(%s) ", NVRAMName (LE32TOH (config_nvram->NVRAMTYPE)));
- printf ("PAGE=0x%04X ", LE32TOH (config_nvram->NVRAMPAGE));
- printf ("BLOCK=0x%04X ", LE32TOH (config_nvram->NVRAMBLOCK));
- printf ("SIZE=0x%04X ", LE32TOH (config_nvram->NVRAMSIZE));
- printf ("(%d) ", LE32TOH (config_nvram->NVRAMSIZE));
- printf ("\n");
- return;
-}
-
-#endif
-
-
-
-
-
-
diff --git a/docbook/open-plc-utils.xml b/docbook/open-plc-utils.xml
deleted file mode 100644
index 33fac96c..00000000
--- a/docbook/open-plc-utils.xml
+++ /dev/null
@@ -1,140 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-]>
-
-
-
- Qualcomm Atheros Open Powerline Toolkit
-
-
-
- Qualcomm Atheros, Ocala FL USA
-
-
-
- Charles
-
-
- Maier
-
-
-
-
- Andrew Barnes <abarnes@qca.qualcomm.com>
-
-
-
-
- Marc Bertola <mbertola@qti.qualcomm.com>
-
-
-
-
- Florian Fainelli <f.fainelli@gmail.com>
-
-
-
-
- Nate Houghton <nhoughto@qca.qualcomm.com>
-
-
-
-
- Mathieu Poullet <m.poullet@avm.de>
-
-
-
-
- Stefan Wahren <stefan.wahren@i2se.com>
-
-
-
-
- Bill Wike <bwike@qca.qualcomm.com>
-
-
-
-
- Alejandro Vasquez <avasquez@qca.qualcomm.com>
-
-
-
-
- NOV 2013
-
-
- open-plc-utils-0.0.4
-
-
-
- This document is the manual for the Qualcomm Atheros Open Powerline Toolkit. New users should read the first chapter before starting using the toolkit because it will answer many questions about toolkit installation, structure, content and application. New users may want to add this page and toolkit.html to their browser favorites for later reference.
-
-
- HomePlug AV is a registered trademark of the HomePlug Powerline Alliance. Linux is a trademark of Linus Tovalds. Windows is a registered trademark of Microsoft Corporation. INT6000, INT6300, INT6400, AR6410, QCA7000, AR7400 and AR7420 are powerline products from Qualcomm Atheros.
-
-
-
- Intellon
- Atheros
- Qualcomm
- HomePlug
- powerline
- communications
- INT6000
- INT6300
- INT6400
- AR7400
- AR7420
-
-
- &overview;
- &hardware;
- &software;
- &firmware;
- &procedures;
- &scripting;
- &support;
- &driver1;
-
diff --git a/docbook/openchannel.c.html b/docbook/openchannel.c.html
deleted file mode 100644
index f7a81205..00000000
--- a/docbook/openchannel.c.html
+++ /dev/null
@@ -1,541 +0,0 @@
-
-
-
-
-
- openchannel.c
-
-
-
-
-
-
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void openport (struct _file_ * port, flag_t flags);
- *
- * open the serial port named by port->name and set file descriptor
- * port->file; datatype struct _file_ is define in tools/types.h;
- *
- * this function no longer initializes port settings because there
- * are too many differences in constants, variables and functions
- * between Linux, OpenBSD, MacOSX and Windows to cleanly implement
- * a single approach to serial port configuration; this means that
- * users should manually configure a port and then leave it alone;
- *
- * use stty on Linux systems and the Control Panel on Windows;
- *
- * port configuration code for Linux and Windows can be enabled if
- * needed by defining SERIAL_CONFIG at compile time; this will not
- * restore original port setting when the port is closed;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Mathieu Olivari <mathieu@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef OPENPORT_SOURCE
-#define OPENPORT_SOURCE
-
-#include <unistd.h>
-#include <stdlib.h>
-#include <errno.h>
-
-#if defined (WIN32)
-# include <windows.h>
-#elif defined (__linux__)
-# include <termios.h>
-#elif defined (__APPLE__)
-# include <termios.h>
-# include <net/ethernet.h>
-#elif defined (__OpenBSD__)
-# include <termios.h>
-#else
-#error "Unknown Environment"
-#endif
-
-#include "../tools/types.h"
-#include "../tools/files.h"
-#include "../tools/flags.h"
-#include "../tools/error.h"
-#include "../serial/serial.h"
-
-void openport (struct _file_ * port, flag_t flags)
-
-{
-
-#if defined (WIN32)
-
- HANDLE hSerial;
- COMMTIMEOUTS timeouts;
- hSerial = CreateFile (port->name, GENERIC_READ | GENERIC_WRITE, 0, 0, OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL, 0);
- if (hSerial == INVALID_HANDLE_VALUE)
- {
- error (1, errno, "%s", port->name);
- }
- if (_anyset (flags, UART_DEFAULT))
- {
- DCB dcbSerial =
- {
- 0
- };
- dcbSerial.DCBlength = sizeof (dcbSerial);
- if (!GetCommState (hSerial, &dcbSerial))
- {
- error (1, errno, "Can't read state: %s", port->name);
- }
- if (_anyset (flags, UART_VERBOSE))
- {
- printf ("getting %s ", port->name);
- printf ("Baud %6d ", dcbSerial.BaudRate);
- printf ("Data %d ", dcbSerial.ByteSize);
- printf ("Stop %d ", dcbSerial.StopBits);
- printf ("Parity %d\n", dcbSerial.Parity);
- }
- dcbSerial.BaudRate = CBR_115200;
- dcbSerial.ByteSize = DATABITS_8;
- dcbSerial.StopBits = ONESTOPBIT;
- dcbSerial.Parity = NOPARITY;
- if (_anyset (flags, UART_VERBOSE))
- {
- printf ("setting %s ", port->name);
- printf ("Baud %6d ", dcbSerial.BaudRate);
- printf ("Data %d ", dcbSerial.ByteSize);
- printf ("Stop %d ", dcbSerial.StopBits);
- printf ("Parity %d\n", dcbSerial.Parity);
- }
- if (!SetCommState (hSerial, &dcbSerial))
- {
- error (1, errno, "Can't save state: %s", port->name);
- }
- }
- timeouts.ReadIntervalTimeout = 10;
- timeouts.ReadTotalTimeoutConstant = 50;
- timeouts.ReadTotalTimeoutMultiplier = 10;
- timeouts.WriteTotalTimeoutConstant = 50;
- timeouts.WriteTotalTimeoutMultiplier = 10;
- if (!SetCommTimeouts (hSerial, &timeouts))
- {
- error (1, errno, "Can't set timeouts: %s", port->name);
- }
- CloseHandle (hSerial);
- if ((port->file = open (port->name, O_BINARY|O_RDWR)) == -1)
- {
- error (1, errno, "%s", port->name);
- }
-
-#else
-
- if ((port->file = open (port->name, O_BINARY|O_RDWR)) == -1)
- {
- error (1, errno, "%s", port->name);
- }
- if (_anyset (flags, UART_DEFAULT))
- {
- struct termios termios;
-
-#if 1
-
-/*
- * POSIX generic code;
- */
-
- tcgetattr (port->file, &termios);
- cfmakeraw (&termios);
- termios.c_cflag |= CS8;
- termios.c_cflag &= ~(CSTOPB);
- cfsetospeed (&termios, B115200);
-
-#else
-
-/*
- * Linux specific code;
- */
-
- termios.c_cflag = B115200 | CS8 | CLOCAL | CREAD;
- termios.c_iflag = IGNPAR;
- termios.c_oflag = 0;
- termios.c_lflag = 0;
- termios.c_cc [VTIME] = 0;
- termios.c_cc [VMIN] = 5;
-
-#endif
-
- tcsetattr (port->file, TCSANOW, &termios);
- }
-
-#endif
-
- return;
-}
-
-#endif
-
-
-
-
-
-
diff --git a/docbook/overview.xml b/docbook/overview.xml
deleted file mode 100644
index 411b6f05..00000000
--- a/docbook/overview.xml
+++ /dev/null
@@ -1,80 +0,0 @@
-
-
- Overview
-
-
-
- Introduction
-
-
- The Open Powerline Toolkit (vanilla version) may be downloaded from https://github.com/qca/open-plc-utils.git by any interested party. An advanced version (chocolate version) may be downloaded from the Qualcomm Atheros Customer FTP site by parties having permission to do so. The chocolate version includes special programs that perform advanced engineering, production and maintenance tasks. Within this document, we refer to both versions, collectively, as the toolkit.
-
-
- The toolkit contains C Language source code and GNU makefiles to compile many useful programs. It also includes Linux shell scripts that use these programs, in various ways, to interrogate, control and manage Qualcomm Atheros INT6000, INT6300, INT6400, AR7400 and later powerline devices. Qualcomm Atheros also provides a similar, but less extensive, toolkit for INT5500 powerline devices.
-
-
- The toolkit is intended for hardware engineers, verification engineers, field engineers and embedded software developers, consequently, programs are simple and compact. It is not intended for computer novices or retail users. Many customers embed a subset of toolkit programs in products for troubleshooting purposes.
-
-
- The toolkit includes extensive HTML documentation and online man pages for users who cannot access installed man pages. HTML documentation starts with file docbook/index.html. Online man pages start with file docbook/toolkit.html. Qualcomm Atheros recommends that you add these two pages to your browser favorites for later reference.
-
-
- All toolkit programs are written in C and have command line intefaces. The source code essentially conforms to ISO/IEC9899:1999. The source tree cleanly compiles using gcc or pcc on Ubuntu, OpenBSD and MacOSX. It also compiles under Microsoft C with the inclusion of special header files. The command line interface conforms to Section 12.2 Utility Syntax Guidelines of The Open Group Base Specification Issue 6 (
-IEEE Std 1003.1, 2004 Edition).
-
-
- The toolkit includes Microsoft Visual Studio .NET project files and solutions files to compile toolkit programs, plus the executable version (.exe) of each program and a set of Microsoft installation file (.msi) so that the toolkit package comes ready to install and run on any Windows host; however, Qualcomm Atheros does not provide support for Microsoft windows version of this toolkit. Toolkit documentation does provide Windows developers with special guidance on setting up their own Visual Studio projects and solutions, should they want to do that.
-
-
-
-
- Background
-
-
- HomePlug AV is an industry standard protocol for powerline communications developed by the HomePlug Powerline Alliance. Qualcomm Atheros manufactures a family of chipsets that conform to that standard and have MII, UART and SPI host interfaces. The INT6x00 and AR7x00 series are flagship members of that chipset family. The principle difference between the chipsets is their boot method, cost and speed. The INT6000 requires onboard NVRAM but the INT6300, INT6400 and AR7400 do not.
-
-
- The HomePlug AV protocol is based on IEEE-802.3, has ethertype 0x88E1 and uses special message formats. A subset of those message formats is reserved for each chipset vendor to define their own message formats. Qualcomm Atheros uses this vendor-specific subset to communicate between host processors and Qualcomm Atheros devices. This toolkit uses Qualcomm Atheros vendor-specific message formats to communicates with Qualcomm Atheros devices. It also understands Qualcomm Atheros firmware and configuration file formats.
-
-
- This toolkit sends and receives Qualcomm Atheros vendor-specific messages but not generic HomePlug AV messages. Qualcomm Atheros vendor-specific management message formats are described in the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual. If you do not have a copy of this document then you may request one from Qualcomm Atheros.
-
-
-
-
- Toolkit Distribution
-
-
- The Qualcomm Atheros Open Powerline Toolkit is distributed using compressed tape archive files named open-plc-utils-x.x.x.tar.gz and open-plc-utils-x.x.x.tar.bz2 and standard compressed archive file named open-plc-utils-x.x.x.zip, where x.x.x is the version number. Archive files ending in .gz can be decompressed with the Linux gzip utility. Archive files ending in .bz2 can be decompressed with the Linux bzip2 utility. Archive files ending in .zip can be decompressed using the Linux unzip utility or the Windows WinZip utility. The contents of decompressed archives can be extracted using the Linux tar utility. Recent versions of the Linux tar utility allow decompression and extraction in one operation. The WinZip or 7-zip program may be used to decompress archives and extract contents on Microsoft Windows platforms.
-
-
- Some Windows network administrators enable security software that removes .exe and other executable files from .zip archives in transit or in-situ. In that case, Windows user may want to download the *.tar.gz archive and use a program like 7zip to unpack the archive file.
-
-
- The toolkit includes source code, build scripts, documentation and pre-compiled programs for Microsoft Windows. Some third party libraries may also be included to support Microsoft platforms. Although the Microsoft Windows versions of toolkit programs are pre-compiled and ready-to-run, they are not supported because this package is designed for use on Linux platforms.
-
-
- The Windows installer included in this version of the toolkit needs Microsoft .NET 1.1. Windows versions of toolkit programs that communicate with powerline devices need WinPcap 4.1.2 or later. A copy of Microsoft .NET 1.1 and WinPcap 4.1.2 is included in the support folder.
-
-
- &install;
- &programs;
- &folders;
-
-
- Packages
-
-
- The following table lists programs and the release packages that contains them. Packages contain programs of interest to various customer and engineering groups based on the activities that they normally perform. Some groups may need multiple packages. Some packages are restricted.
-
- &packages;
-
-
-
- Toolkit Support
-
-
- Contact the Qualcomm Atheros System Application Engineering Team if you have questions concerning the content, operation, application or direction of this toolkit on GNU/Linux systems. If you are having trouble communicating with Qualcomm Atheros powerline devices using the toolkit, try following the troubleshooting procedure found later in this document.
-
-
-
diff --git a/docbook/packages.xml b/docbook/packages.xml
deleted file mode 100644
index 9d4427b7..00000000
--- a/docbook/packages.xml
+++ /dev/null
@@ -1,3381 +0,0 @@
-
The following is an alphabetical index of the manual pages, header files, source files, scripts and applets that comprise the Qualcomm Atheros Open Powerline Toolkit. It is provided for those who do not have access to on-line manual pages or want to browse through the software.
-/*-
- * Copyright (c) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997
- * The Regents of the University of California. All rights reserved.
- *
- * This code is derived from the Stanford/CMU enet packet filter,
- * (net/enet.c) distributed as part of 4.3BSD, and code contributed
- * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
- * Berkeley Laboratory.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. 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.
- * 3. All advertising materials mentioning features or use of this software
- * must display the following acknowledgement:
- * This product includes software developed by the University of
- * California, Berkeley and its contributors.
- * 4. Neither the name of the University nor the names of its contributors
- * may be used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
- *
- * @(#) $Header: /tcpdump/master/libpcap/pcap-bpf.h,v 1.50 2007/04/01 21:43:55 guy Exp $ (LBL)
- */
-
-/*
- * For backwards compatibility.
- *
- * Note to OS vendors: do NOT get rid of this file! Some applications
- * might expect to be able to include <pcap-bpf.h>.
- */
-#include <pcap/bpf.h>
-
-/*
- * Copyright (c) 1994, 1995, 1996
- * The Regents of the University of California. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. 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.
- * 3. All advertising materials mentioning features or use of this software
- * must display the following acknowledgement:
- * This product includes software developed by the Computer Systems
- * Engineering Group at Lawrence Berkeley Laboratory.
- * 4. Neither the name of the University nor of the Laboratory may be used
- * to endorse or promote products derived from this software without
- * specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
- *
- * @(#) $Header: /home/cvs/plc-utils/VisualStudioNET/include/pcap-int.h,v 1.1.1.1 2011-08-27 15:30:16 cmaier Exp $ (LBL)
- */
-
-#ifndef pcap_int_h
-#define pcap_int_h
-
-#ifdef __cplusplus
-
-extern "C"
-
-{
-
-#endif
-
-#include <pcap.h>
-
-#ifdef WIN32
-#include <Packet32.h>
-#endif /* WIN32 */
-
-#ifdef MSDOS
-#include <fcntl.h>
-#include <io.h>
-#endif
-
-/*
- * Savefile
- */
-
- typedef enum
- {
- NOT_SWAPPED,
- SWAPPED,
- MAYBE_SWAPPED
- }
- swapped_type_t;
- struct pcap_sf
- {
- FILE *rfile;
- int swapped;
- int hdrsize;
- swapped_type_t lengths_swapped;
- int version_major;
- int version_minor;
- u_char *base;
- };
- struct pcap_md
- {
- struct pcap_stat stat;
-
-/*XXX*/
-
- int use_bpf;
-
-/* using kernel filter */
-
- u_long TotPkts;
-
-/* can't oflow for 79 hrs on ether */
-
- u_long TotAccepted;
-
-/* count accepted by filter */
-
- u_long TotDrops;
-
-/* count of dropped packets */
-
- long TotMissed;
-
-/* missed by i/f during this run */
-
- long OrigMissed;
-
-/* missed by i/f before this run */
-
- char *device;
-
-/* device name */
-
-#ifdef linux
-
- int sock_packet;
-
-/* using Linux 2.0 compatible interface */
-
- int timeout;
-
-/* timeout specified to pcap_open_live */
-
- int clear_promisc;
-
-/* must clear promiscuous mode when we close */
-
- int cooked;
-
-/* using SOCK_DGRAM rather than SOCK_RAW */
-
- int ifindex;
-
-/* interface index of device we're bound to */
-
- int lo_ifindex;
-
-/* interface index of the loopback device */
-
- struct pcap *next;
-
-/* list of open promiscuous sock_packet pcaps */
-
- u_int packets_read;
-
-/* count of packets read with recvfrom() */
-
-#endif
-
-#ifdef HAVE_DAG_API
-#ifdef HAVE_DAG_STREAMS_API
-
- u_char *dag_mem_bottom;
-
-/* DAG card current memory bottom pointer */
-
- u_char *dag_mem_top;
-
-/* DAG card current memory top pointer */
-
-#else
-
- void *dag_mem_base;
-
-/* DAG card memory base address */
-
- u_int dag_mem_bottom;
-
-/* DAG card current memory bottom offset */
-
- u_int dag_mem_top;
-
-/* DAG card current memory top offset */
-
-#endif /* HAVE_DAG_STREAMS_API */
-
- int dag_fcs_bits;
-
-/* Number of checksum bits from link layer */
-
- int dag_offset_flags;
-
-/* Flags to pass to dag_offset(). */
-
- int dag_stream;
-
-/* DAG stream number */
-
- int dag_timeout;
-
-/* timeout specified to pcap_open_live.
- * Same as in linux above, introduce
- * generally? */
-
-#endif /* HAVE_DAG_API */
-
-#ifdef HAVE_REMOTE
-
-/*!
- * There is really a mess with previous variables, and it seems to me that they are not used
- * (they are used in pcap_pf.c only). I think we have to start using them.
- * The meaning is the following:
- *
- * - TotPkts: the amount of packets received by the bpf filter, *before* applying the filter
- * - TotAccepted: the amount of packets that satisfies the filter
- * - TotDrops: the amount of packet that were dropped into the kernel buffer because of lack of space
- * - TotMissed: the amount of packets that were dropped by the physical interface; it is basically
- * the value of the hardware counter into the card. This number is never put to zero, so this number
- * takes into account the *total* number of interface drops starting from the interface power-on.
- * - OrigMissed: the amount of packets that were dropped by the interface *when the capture begins*.
- * This value is used to detect the number of packets dropped by the interface *during the present
- * capture*, so that (ps_ifdrops= TotMissed - OrigMissed).
- */
-
- unsigned int TotNetDrops;
-
-//!< keeps the number of packets that have been dropped by the network
-/*!
- * \brief It keeps the number of packets that have been received by the application.
- *
- * Packets dropped by the kernel buffer are not counted in this variable. The variable is always
- * equal to (TotAccepted - TotDrops), exept for the case of remote capture, in which we have also
- * packets in fligh, i.e. that have been transmitted by the remote host, but that have not been
- * received (yet) from the client. In this case, (TotAccepted - TotDrops - TotNetDrops) gives a
- * wrong result, since this number does not corresponds always to the number of packet received by
- * the application. For this reason, in the remote capture we need another variable that takes
- * into account of the number of packets actually received by the application.
- */
-
- unsigned int TotCapt;
-
-#endif /* HAVE_REMOTE */
-
- };
-
-/*
- * Ultrix, DEC OSF/1^H^H^H^H^H^H^H^H^HDigital UNIX^H^H^H^H^H^H^H^H^H^H^H^H
- * Tru64 UNIX, and NetBSD pad to make everything line up on a nice boundary.
- */
-
-#if defined(ultrix) || defined(__osf__) || (defined(__NetBSD__) && __NetBSD_Version__ > 106000000)
-#define PCAP_FDDIPAD 3
-#endif
-
- struct pcap
- {
-
-#ifdef WIN32
-
- ADAPTER *adapter;
- LPPACKET Packet;
- int timeout;
- int nonblock;
-
-#else
-
- int fd;
- int selectable_fd;
- int send_fd;
-
-#endif /* WIN32 */
-
- int snapshot;
- int linktype;
- int tzoff;
-
-/* timezone offset */
-
- int offset;
-
-/* offset for proper alignment */
-
- int break_loop;
-
-/* flag set to force break from packet-reading loop */
-
-#ifdef PCAP_FDDIPAD
-
- int fddipad;
-
-#endif
-
-#ifdef MSDOS
-
- int inter_packet_wait;
-
-/* offline: wait between packets */
-
- void (*wait_proc)(void);
-
-/* call proc while waiting */
-
-#endif
-
- struct pcap_sf sf;
- struct pcap_md md;
-
-/*
- * Read buffer.
- */
-
- int bufsize;
- u_char *buffer;
- u_char *bp;
- int cc;
-
-/*
- * Place holder for pcap_next().
- */
-
- u_char *pkt;
-
-/* We're accepting only packets in this direction/these directions. */
-
- pcap_direction_t direction;
-
-/*
- * Methods.
- */
-
- int (*read_op)(pcap_t *, int cnt, pcap_handler, u_char *);
- int (*inject_op)(pcap_t *, const void *, size_t);
- int (*setfilter_op)(pcap_t *, struct bpf_program *);
- int (*setdirection_op)(pcap_t *, pcap_direction_t);
- int (*set_datalink_op)(pcap_t *, int);
- int (*getnonblock_op)(pcap_t *, char *);
- int (*setnonblock_op)(pcap_t *, int, char *);
- int (*stats_op)(pcap_t *, struct pcap_stat *);
- void (*close_op)(pcap_t *);
-
-/*
- * Placeholder for filter code if bpf not in kernel.
- */
-
- struct bpf_program fcode;
- char errbuf [PCAP_ERRBUF_SIZE + 1];
- int dlt_count;
- u_int *dlt_list;
- struct pcap_pkthdr pcap_header;
-
-/* This is needed for the pcap_next_ex() to work */
-
-#ifdef HAVE_REMOTE
-#ifndef WIN32 // Win32 already defines 'timeout'
-
- int timeout;
-
-//!< timeout to be used in the pcap_open()
-
-#endif
-
-/*! \brief '1' if we're the network client; needed by several functions (like pcap_setfilter() ) to know if
- * they have to use the socket or they have to open the local adapter. */
-
- int rmt_clientside;
- SOCKET rmt_sockctrl;
-
-//!< socket ID of the socket used for the control connection
-
- SOCKET rmt_sockdata;
-
-//!< socket ID of the socket used for the data connection
-
- int rmt_flags;
-
-//!< we have to save flags, since they are passed by the pcap_open_live(), but they are used by the pcap_startcapture()
-
- int rmt_capstarted;
-
-//!< 'true' if the capture is already started (needed to knoe if we have to call the pcap_startcapture()
-
- struct pcap_samp rmt_samp;
-
-//!< Keeps the parameters related to the sampling process.
-
- char *currentfilter;
-
-//!< Pointer to a buffer (allocated at run-time) that stores the current filter. Needed when flag PCAP_OPENFLAG_NOCAPTURE_RPCAP is turned on.
-
-#endif /* HAVE_REMOTE */
-
- };
-
-/*
- * This is a timeval as stored in a savefile.
- * It has to use the same types everywhere, independent of the actual
- * `struct timeval'; `struct timeval' has 32-bit tv_sec values on some
- * platforms and 64-bit tv_sec values on other platforms, and writing
- * out native `struct timeval' values would mean files could only be
- * read on systems with the same tv_sec size as the system on which
- * the file was written.
- */
-
- struct pcap_timeval
- {
- bpf_int32 tv_sec;
-
-/* seconds */
-
- bpf_int32 tv_usec;
-
-/* microseconds */
-
- };
-
-/*
- * This is a `pcap_pkthdr' as actually stored in a savefile.
- *
- * Do not change the format of this structure, in any way (this includes
- * changes that only affect the length of fields in this structure),
- * and do not make the time stamp anything other than seconds and
- * microseconds (e.g., seconds and nanoseconds). Instead:
- *
- * introduce a new structure for the new format;
- *
- * send mail to "tcpdump-workers@tcpdump.org", requesting a new
- * magic number for your new capture file format, and, when
- * you get the new magic number, put it in "savefile.c";
- *
- * use that magic number for save files with the changed record
- * header;
- *
- * make the code in "savefile.c" capable of reading files with
- * the old record header as well as files with the new record header
- * (using the magic number to determine the header format).
- *
- * Then supply the changes to "patches@tcpdump.org", so that future
- * versions of libpcap and programs that use it (such as tcpdump) will
- * be able to read your new capture file format.
- */
-
- struct pcap_sf_pkthdr
- {
- struct pcap_timeval ts;
-
-/* time stamp */
-
- bpf_u_int32 caplen;
-
-/* length of portion present */
-
- bpf_u_int32 len;
-
-/* length this packet (off wire) */
-
- };
-
-/*
- * How a `pcap_pkthdr' is actually stored in savefiles written
- * by some patched versions of libpcap (e.g. the ones in Red
- * Hat Linux 6.1 and 6.2).
- *
- * Do not change the format of this structure, in any way (this includes
- * changes that only affect the length of fields in this structure).
- * Instead, introduce a new structure, as per the above.
- */
-
- struct pcap_sf_patched_pkthdr
- {
- struct pcap_timeval ts;
-
-/* time stamp */
-
- bpf_u_int32 caplen;
-
-/* length of portion present */
-
- bpf_u_int32 len;
-
-/* length this packet (off wire) */
-
- int index;
- unsigned short protocol;
- unsigned char pkt_type;
- };
- int yylex (void);
-
-#ifndef min
-#define min(a, b) ((a) > (b) ? (b) : (a))
-#endif
-
-/* XXX should these be in pcap.h? */
-
- int pcap_offline_read (pcap_t *, int, pcap_handler, u_char *);
- int pcap_read (pcap_t *, int cnt, pcap_handler, u_char *);
-
-#ifndef HAVE_STRLCPY
-#define strlcpy(x, y, z) \
- (strncpy ((x), (y), (z)), \ ((z) <= 0? 0: ((x)[(z) - 1] = '\0')), \ strlen ((y)))
-
-#endif
-
-#include <stdarg.h>
-
-#if !defined(HAVE_SNPRINTF)
-#define snprintf pcap_snprintf
-
- extern int snprintf (char *, size_t, const char *, ...);
-
-#endif
-
-#if !defined(HAVE_VSNPRINTF)
-#define vsnprintf pcap_vsnprintf
-
- extern int vsnprintf (char *, size_t, const char *, va_list ap);
-
-#endif
-
-/*
- * Routines that most pcap implementations can use for non-blocking mode.
- */
-
-#if !defined(WIN32) && !defined(MSDOS)
-
- int pcap_getnonblock_fd (pcap_t *, char *);
- int pcap_setnonblock_fd (pcap_t *p, int, char *);
-
-#endif
-
- void pcap_close_common (pcap_t *);
-
-/*
- * Internal interfaces for "pcap_findalldevs()".
- *
- * "pcap_platform_finddevs()" is a platform-dependent routine to
- * add devices not found by the "standard" mechanisms (SIOCGIFCONF,
- * "getifaddrs()", etc..
- *
- * "pcap_add_if()" adds an interface to the list of interfaces.
- */
-
- int pcap_platform_finddevs (pcap_if_t **, char *);
- int add_addr_to_iflist (pcap_if_t **, const char *, u_int, struct sockaddr *, size_t, struct sockaddr *, size_t, struct sockaddr *, size_t, struct sockaddr *, size_t, char *);
- int pcap_add_if (pcap_if_t **, const char *, u_int, const char *, char *);
- struct sockaddr *dup_sockaddr (struct sockaddr *, size_t);
- int add_or_find_if (pcap_if_t **, pcap_if_t **, const char *, u_int, const char *, char *);
-
-#ifdef WIN32
-
- char *pcap_win32strerror (void);
-
-#endif
-
- int install_bpf_program (pcap_t *, struct bpf_program *);
- int pcap_strcasecmp (const char *, const char *);
-
-#ifdef __cplusplus
-
-}
-
-#endif
-
-#endif
-
-
-
-/*
- * Copyright (c) 2002 - 2005 NetGroup, Politecnico di Torino (Italy)
- * Copyright (c) 2005 - 2009 CACE Technologies, Inc. Davis (California)
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. 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.
- * 3. Neither the name of the Politecnico di Torino nor the names of its
- * contributors may be used to endorse or promote products derived from
- * this software without specific prior written permission.
- *
- * 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.
- *
- * @(#) $Header: /tcpdump/master/libpcap/pcap-stdinc.h,v 1.10.2.1 2008-10-06 15:38:39 gianluca Exp $ (LBL)
- */
-
-#define SIZEOF_CHAR 1
-#define SIZEOF_SHORT 2
-#define SIZEOF_INT 4
-#ifndef _MSC_EXTENSIONS
-#define SIZEOF_LONG_LONG 8
-#endif
-
-/*
- * Avoids a compiler warning in case this was already defined
- * (someone defined _WINSOCKAPI_ when including 'windows.h', in order
- * to prevent it from including 'winsock.h')
- */
-#ifdef _WINSOCKAPI_
-#undef _WINSOCKAPI_
-#endif
-#include <winsock2.h>
-
-#include <fcntl.h>
-
-#include "bittypes.h"
-#include <time.h>
-#include <io.h>
-
-#ifndef __MINGW32__
-#include "IP6_misc.h"
-#endif
-
-#define caddr_t char*
-
-#if _MSC_VER < 1500
-#define snprintf _snprintf
-#define vsnprintf _vsnprintf
-#define strdup _strdup
-#endif
-
-#define inline __inline
-
-#ifdef __MINGW32__
-#include <stdint.h>
-#else /*__MINGW32__*/
-/* MSVC compiler */
-#ifndef _UINTPTR_T_DEFINED
-#ifdef _WIN64
-typedef unsigned __int64 uintptr_t;
-#else
-typedef _W64 unsigned int uintptr_t;
-#endif
-#define _UINTPTR_T_DEFINED
-#endif
-
-#ifndef _INTPTR_T_DEFINED
-#ifdef _WIN64
-typedef __int64 intptr_t;
-#else
-typedef _W64 int intptr_t;
-#endif
-#define _INTPTR_T_DEFINED
-#endif
-
-#endif /*__MINGW32__*/
-
-/*
- * Copyright (c) 1993, 1994, 1995, 1996, 1997
- * The Regents of the University of California. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. 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.
- * 3. All advertising materials mentioning features or use of this software
- * must display the following acknowledgement:
- * This product includes software developed by the Computer Systems
- * Engineering Group at Lawrence Berkeley Laboratory.
- * 4. Neither the name of the University nor of the Laboratory may be used
- * to endorse or promote products derived from this software without
- * specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
- *
- * @(#) $Header: /tcpdump/master/libpcap/pcap.h,v 1.59 2006/10/04 18:09:22 guy Exp $ (LBL)
- */
-
-/*
- * For backwards compatibility.
- *
- * Note to OS vendors: do NOT get rid of this file! Many applications
- * expect to be able to include <pcap.h>, and at least some of them
- * go through contortions in their configure scripts to try to detect
- * OSes that have "helpfully" moved pcap.h to <pcap/pcap.h> without
- * leaving behind a <pcap.h> file.
- */
-#include <pcap/pcap.h>
-*/
-
-#ifndef PCAP_DONT_INCLUDE_PCAP_BPF_H
-#include <pcap/bpf.h>
-#endif
-
-#include <stdio.h>
-
-#ifdef HAVE_REMOTE
- // We have to define the SOCKET here, although it has been defined in sockutils.h
- // This is to avoid the distribution of the 'sockutils.h' file around
- // (for example in the WinPcap developer's pack)
- #ifndef SOCKET
- #ifdef WIN32
- #define SOCKET unsigned int
- #else
- #define SOCKET int
- #endif
- #endif
-#endif
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-#define PCAP_VERSION_MAJOR 2
-#define PCAP_VERSION_MINOR 4
-
-#define PCAP_ERRBUF_SIZE 256
-
-/*
- * Compatibility for systems that have a bpf.h that
- * predates the bpf typedefs for 64-bit support.
- */
-#if BPF_RELEASE - 0 < 199406
-typedef int bpf_int32;
-typedef u_int bpf_u_int32;
-#endif
-
-typedef struct pcap pcap_t;
-typedef struct pcap_dumper pcap_dumper_t;
-typedef struct pcap_if pcap_if_t;
-typedef struct pcap_addr pcap_addr_t;
-
-/*
- * The first record in the file contains saved values for some
- * of the flags used in the printout phases of tcpdump.
- * Many fields here are 32 bit ints so compilers won't insert unwanted
- * padding; these files need to be interchangeable across architectures.
- *
- * Do not change the layout of this structure, in any way (this includes
- * changes that only affect the length of fields in this structure).
- *
- * Also, do not change the interpretation of any of the members of this
- * structure, in any way (this includes using values other than
- * LINKTYPE_ values, as defined in "savefile.c", in the "linktype"
- * field).
- *
- * Instead:
- *
- * introduce a new structure for the new format, if the layout
- * of the structure changed;
- *
- * send mail to "tcpdump-workers@lists.tcpdump.org", requesting
- * a new magic number for your new capture file format, and, when
- * you get the new magic number, put it in "savefile.c";
- *
- * use that magic number for save files with the changed file
- * header;
- *
- * make the code in "savefile.c" capable of reading files with
- * the old file header as well as files with the new file header
- * (using the magic number to determine the header format).
- *
- * Then supply the changes as a patch at
- *
- * http://sourceforge.net/projects/libpcap/
- *
- * so that future versions of libpcap and programs that use it (such as
- * tcpdump) will be able to read your new capture file format.
- */
-struct pcap_file_header {
- bpf_u_int32 magic;
- u_short version_major;
- u_short version_minor;
- bpf_int32 thiszone; /* gmt to local correction */
- bpf_u_int32 sigfigs; /* accuracy of timestamps */
- bpf_u_int32 snaplen; /* max length saved portion of each pkt */
- bpf_u_int32 linktype; /* data link type (LINKTYPE_*) */
-};
-
-/*
- * Macros for the value returned by pcap_datalink_ext().
- *
- * If LT_FCS_LENGTH_PRESENT(x) is true, the LT_FCS_LENGTH(x) macro
- * gives the FCS length of packets in the capture.
- */
-#define LT_FCS_LENGTH_PRESENT(x) ((x) & 0x04000000)
-#define LT_FCS_LENGTH(x) (((x) & 0xF0000000) >> 28)
-#define LT_FCS_DATALINK_EXT(x) ((((x) & 0xF) << 28) | 0x04000000)
-
-typedef enum {
- PCAP_D_INOUT = 0,
- PCAP_D_IN,
- PCAP_D_OUT
-} pcap_direction_t;
-
-/*
- * Generic per-packet information, as supplied by libpcap.
- *
- * The time stamp can and should be a "struct timeval", regardless of
- * whether your system supports 32-bit tv_sec in "struct timeval",
- * 64-bit tv_sec in "struct timeval", or both if it supports both 32-bit
- * and 64-bit applications. The on-disk format of savefiles uses 32-bit
- * tv_sec (and tv_usec); this structure is irrelevant to that. 32-bit
- * and 64-bit versions of libpcap, even if they're on the same platform,
- * should supply the appropriate version of "struct timeval", even if
- * that's not what the underlying packet capture mechanism supplies.
- */
-struct pcap_pkthdr {
- struct timeval ts; /* time stamp */
- bpf_u_int32 caplen; /* length of portion present */
- bpf_u_int32 len; /* length this packet (off wire) */
-};
-
-/*
- * As returned by the pcap_stats()
- */
-struct pcap_stat {
- u_int ps_recv; /* number of packets received */
- u_int ps_drop; /* number of packets dropped */
- u_int ps_ifdrop; /* drops by interface XXX not yet supported */
-#ifdef HAVE_REMOTE
- u_int ps_capt; /* number of packets that are received by the application; please get rid off the Win32 ifdef */
- u_int ps_sent; /* number of packets sent by the server on the network */
- u_int ps_netdrop; /* number of packets lost on the network */
-#endif /* HAVE_REMOTE */
-};
-
-#ifdef MSDOS
-/*
- * As returned by the pcap_stats_ex()
- */
-struct pcap_stat_ex {
- u_long rx_packets; /* total packets received */
- u_long tx_packets; /* total packets transmitted */
- u_long rx_bytes; /* total bytes received */
- u_long tx_bytes; /* total bytes transmitted */
- u_long rx_errors; /* bad packets received */
- u_long tx_errors; /* packet transmit problems */
- u_long rx_dropped; /* no space in Rx buffers */
- u_long tx_dropped; /* no space available for Tx */
- u_long multicast; /* multicast packets received */
- u_long collisions;
-
- /* detailed rx_errors: */
- u_long rx_length_errors;
- u_long rx_over_errors; /* receiver ring buff overflow */
- u_long rx_crc_errors; /* recv'd pkt with crc error */
- u_long rx_frame_errors; /* recv'd frame alignment error */
- u_long rx_fifo_errors; /* recv'r fifo overrun */
- u_long rx_missed_errors; /* recv'r missed packet */
-
- /* detailed tx_errors */
- u_long tx_aborted_errors;
- u_long tx_carrier_errors;
- u_long tx_fifo_errors;
- u_long tx_heartbeat_errors;
- u_long tx_window_errors;
- };
-#endif
-
-/*
- * Item in a list of interfaces.
- */
-struct pcap_if {
- struct pcap_if *next;
- char *name; /* name to hand to "pcap_open_live()" */
- char *description; /* textual description of interface, or NULL */
- struct pcap_addr *addresses;
- bpf_u_int32 flags; /* PCAP_IF_ interface flags */
-};
-
-#define PCAP_IF_LOOPBACK 0x00000001 /* interface is loopback */
-
-/*
- * Representation of an interface address.
- */
-struct pcap_addr {
- struct pcap_addr *next;
- struct sockaddr *addr; /* address */
- struct sockaddr *netmask; /* netmask for that address */
- struct sockaddr *broadaddr; /* broadcast address for that address */
- struct sockaddr *dstaddr; /* P2P destination address for that address */
-};
-
-typedef void (*pcap_handler)(u_char *, const struct pcap_pkthdr *,
- const u_char *);
-
-/*
- * Error codes for the pcap API.
- * These will all be negative, so you can check for the success or
- * failure of a call that returns these codes by checking for a
- * negative value.
- */
-#define PCAP_ERROR -1 /* generic error code */
-#define PCAP_ERROR_BREAK -2 /* loop terminated by pcap_breakloop */
-#define PCAP_ERROR_NOT_ACTIVATED -3 /* the capture needs to be activated */
-#define PCAP_ERROR_ACTIVATED -4 /* the operation can't be performed on already activated captures */
-#define PCAP_ERROR_NO_SUCH_DEVICE -5 /* no such device exists */
-#define PCAP_ERROR_RFMON_NOTSUP -6 /* this device doesn't support rfmon (monitor) mode */
-#define PCAP_ERROR_NOT_RFMON -7 /* operation supported only in monitor mode */
-#define PCAP_ERROR_PERM_DENIED -8 /* no permission to open the device */
-#define PCAP_ERROR_IFACE_NOT_UP -9 /* interface isn't up */
-
-/*
- * Warning codes for the pcap API.
- * These will all be positive and non-zero, so they won't look like
- * errors.
- */
-#define PCAP_WARNING 1 /* generic warning code */
-#define PCAP_WARNING_PROMISC_NOTSUP 2 /* this device doesn't support promiscuous mode */
-
-char *pcap_lookupdev(char *);
-int pcap_lookupnet(const char *, bpf_u_int32 *, bpf_u_int32 *, char *);
-
-pcap_t *pcap_create(const char *, char *);
-int pcap_set_snaplen(pcap_t *, int);
-int pcap_set_promisc(pcap_t *, int);
-int pcap_can_set_rfmon(pcap_t *);
-int pcap_set_rfmon(pcap_t *, int);
-int pcap_set_timeout(pcap_t *, int);
-int pcap_set_buffer_size(pcap_t *, int);
-int pcap_activate(pcap_t *);
-
-pcap_t *pcap_open_live(const char *, int, int, int, char *);
-pcap_t *pcap_open_dead(int, int);
-pcap_t *pcap_open_offline(const char *, char *);
-#if defined(WIN32)
-pcap_t *pcap_hopen_offline(intptr_t, char *);
-#if !defined(LIBPCAP_EXPORTS)
-#define pcap_fopen_offline(f,b) \
- pcap_hopen_offline(_get_osfhandle(_fileno(f)), b)
-#else /*LIBPCAP_EXPORTS*/
-static pcap_t *pcap_fopen_offline(FILE *, char *);
-#endif
-#else /*WIN32*/
-pcap_t *pcap_fopen_offline(FILE *, char *);
-#endif /*WIN32*/
-
-void pcap_close(pcap_t *);
-int pcap_loop(pcap_t *, int, pcap_handler, u_char *);
-int pcap_dispatch(pcap_t *, int, pcap_handler, u_char *);
-const u_char*
- pcap_next(pcap_t *, struct pcap_pkthdr *);
-int pcap_next_ex(pcap_t *, struct pcap_pkthdr **, const u_char **);
-void pcap_breakloop(pcap_t *);
-int pcap_stats(pcap_t *, struct pcap_stat *);
-int pcap_setfilter(pcap_t *, struct bpf_program *);
-int pcap_setdirection(pcap_t *, pcap_direction_t);
-int pcap_getnonblock(pcap_t *, char *);
-int pcap_setnonblock(pcap_t *, int, char *);
-int pcap_inject(pcap_t *, const void *, size_t);
-int pcap_sendpacket(pcap_t *, const u_char *, int);
-const char *pcap_statustostr(int);
-const char *pcap_strerror(int);
-char *pcap_geterr(pcap_t *);
-void pcap_perror(pcap_t *, char *);
-int pcap_compile(pcap_t *, struct bpf_program *, const char *, int,
- bpf_u_int32);
-int pcap_compile_nopcap(int, int, struct bpf_program *,
- const char *, int, bpf_u_int32);
-void pcap_freecode(struct bpf_program *);
-int pcap_offline_filter(struct bpf_program *, const struct pcap_pkthdr *,
- const u_char *);
-int pcap_datalink(pcap_t *);
-int pcap_datalink_ext(pcap_t *);
-int pcap_list_datalinks(pcap_t *, int **);
-int pcap_set_datalink(pcap_t *, int);
-void pcap_free_datalinks(int *);
-int pcap_datalink_name_to_val(const char *);
-const char *pcap_datalink_val_to_name(int);
-const char *pcap_datalink_val_to_description(int);
-int pcap_snapshot(pcap_t *);
-int pcap_is_swapped(pcap_t *);
-int pcap_major_version(pcap_t *);
-int pcap_minor_version(pcap_t *);
-
-/* XXX */
-FILE *pcap_file(pcap_t *);
-int pcap_fileno(pcap_t *);
-
-pcap_dumper_t *pcap_dump_open(pcap_t *, const char *);
-pcap_dumper_t *pcap_dump_fopen(pcap_t *, FILE *fp);
-FILE *pcap_dump_file(pcap_dumper_t *);
-long pcap_dump_ftell(pcap_dumper_t *);
-int pcap_dump_flush(pcap_dumper_t *);
-void pcap_dump_close(pcap_dumper_t *);
-void pcap_dump(u_char *, const struct pcap_pkthdr *, const u_char *);
-
-int pcap_findalldevs(pcap_if_t **, char *);
-void pcap_freealldevs(pcap_if_t *);
-
-const char *pcap_lib_version(void);
-
-/* XXX this guy lives in the bpf tree */
-u_int bpf_filter(const struct bpf_insn *, const u_char *, u_int, u_int);
-int bpf_validate(const struct bpf_insn *f, int len);
-char *bpf_image(const struct bpf_insn *, int);
-void bpf_dump(const struct bpf_program *, int);
-
-#if defined(WIN32)
-
-/*
- * Win32 definitions
- */
-
-int pcap_setbuff(pcap_t *p, int dim);
-int pcap_setmode(pcap_t *p, int mode);
-int pcap_setmintocopy(pcap_t *p, int size);
-
-#ifdef WPCAP
-/* Include file with the wpcap-specific extensions */
-#include <Win32-Extensions.h>
-#endif /* WPCAP */
-
-#define MODE_CAPT 0
-#define MODE_STAT 1
-#define MODE_MON 2
-
-#elif defined(MSDOS)
-
-/*
- * MS-DOS definitions
- */
-
-int pcap_stats_ex (pcap_t *, struct pcap_stat_ex *);
-void pcap_set_wait (pcap_t *p, void (*yield)(void), int wait);
-u_long pcap_mac_packets (void);
-
-#else /* UN*X */
-
-/*
- * UN*X definitions
- */
-
-int pcap_get_selectable_fd(pcap_t *);
-
-#endif /* WIN32/MSDOS/UN*X */
-
-#ifdef HAVE_REMOTE
-/* Includes most of the public stuff that is needed for the remote capture */
-#include <remote-ext.h>
-#endif /* HAVE_REMOTE */
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void pcap_freenameindex (struct if_nameindex *)
- *
- * ether.h
- *
- * a WinPcap version of POSIX if_freenameindex function;
- *
- * see The Open Group Base Specifications Issue 6 IEEE Std 1003.1,
- * 2004 Edition for a description of this function;
- *
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PCAP_FREENAMEINDEX_SOURCE
-#define PCAP_FREENAMEINDEX_SOURCE
-
-#include <pcap.h>
-#include <stdlib.h>
-
-#include "../ether/ether.h"
-
-void pcap_freenameindex (struct if_nameindex * if_nameindex)
-
-{
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- struct if_nameindex * ifp = if_nameindex;
- while (ifp->if_index)
- {
- free (ifp->if_name);
- }
- free (if_nameindex);
-
-#endif
-
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * char * pcap_indextoname (unsigned ifindex, char * ifname);
- *
- * ether.h
- *
- * a WinPcap version of POSIX if_indextoname function; return error
- * in non-pcap environments; set errno to ENXIO on error on MacOSX;
- *
- * see The Open Group Base Specifications Issue 6 IEEE Std 1003.1,
- * 2004 Edition for a description of this function;
- *
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PCAP_INDEXTONAME_SOURCE
-#define PCAP_INDEXTONAME_SOURCE
-
-#include <pcap.h>
-#include <string.h>
-#include <errno.h>
-
-#include "../ether/ether.h"
-
-char * pcap_indextoname (unsigned ifindex, char * ifname)
-
-{
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- char buffer [PCAP_ERRBUF_SIZE];
- pcap_if_t * devices = (pcap_if_t *)(0);
- pcap_if_t * device;
- if ((index--) && (pcap_findalldevs (&devices, buffer) != -1))
- {
- for (device = devices; device; device = device->next)
- {
- if (!index--)
- {
- memcpy (ifname, device->name, strlen (device->name));
- pcap_freealldevs (devices);
- return (ifname);
- }
- }
- pcap_freealldevs (devices);
- }
-
-#endif
-#if defined (__APPLE__)
-
- errno = ENXIO;
-
-#endif
-
- return ((char *)(0));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * struct if_nameindex * pcap_nameindex (void)
- *
- * ether.h
- *
- * a WinPcap version of POSIX if_nameindex function; return error
- * in non-pcap environments;
- *
- * see The Open Group Base Specifications Issue 6 IEEE Std 1003.1,
- * 2004 Edition for a description of this function;
- *
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PCAP_NAMEINDEX_SOURCE
-#define PCAP_NAMEINDEX_SOURCE
-
-#include <pcap.h>
-#include <string.h>
-#include <stdlib.h>
-
-#include "../ether/ether.h"
-
-struct if_nameindex * pcap_nameindex (void)
-
-{
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- char buffer [PCAP_ERRBUF_SIZE];
- pcap_if_t * devices = (pcap_if_t *)(0);
- pcap_if_t * device;
- if (pcap_findalldevs (&devices, buffer) != -1)
- {
- struct if_nameindex * ifs;
- struct if_nameindex * ifp;
- unsigned count = 1;
- for (device = devices; device; device = device->next)
- {
- count++;
- }
- ifp = ifs = (struct if_nameindex *)(malloc (count * sizeof (struct if_nameindex)));
- if (ifs) for (device = devices; device; device = device->next)
- {
- ifp->if_index = device->index;
- ifp->if_name = strdup (device->name);
- ifp++;
- }
- memset (ifp, 0, sizeof (* ifp));
- pcap_freealldevs (devices);
- return (ifs);
- }
-
-#endif
-
- return ((struct if_nameindex *)(0));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * unsigned pcap_nametoindex (char const * name);
- *
- * ether.h
- *
- * a WinPcap version of POSIX if_nametoindex function; return error
- * in non-pcap environments;
- *
- * see The Open Group Base Specifications Issue 6 IEEE Std 1003.1,
- * 2004 Edition for a description of this function;
- *
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PCAP_NAMETOINDEX_SOURCE
-#define PCAP_NAMETOINDEX_SOURCE
-
-#include <pcap.h>
-#include <string.h>
-#include <errno.h>
-
-#include "../ether/ether.h"
-
-unsigned pcap_nametoindex (char const * name)
-
-{
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- char buffer [PCAP_ERRBUF_SIZE];
- pcap_if_t * devices = (pcap_if_t *)(0);
- pcap_if_t * device;
- if (pcap_findalldevs (&devices, buffer) != -1)
- {
- unsigned index = 1;
- for (device = devices; device; device = device->next)
- {
- if (!strcmp (name, device->name))
- {
- index++;
- continue;
- }
- pcap_freealldevs (devices);
- return (index);
- }
- pcap_freealldevs (devices);
- }
-
-#endif
-#if defined (__APPLE__)
-
- errno = ENXIO;
-
-#endif
-
- return (0);
-}
-
-#endif
-
-
-
-pcapdevs(1) Qualcomm Atheros Open Powerline Toolkit pcapdevs(1)
-
-NAME
- pcapdevs - Qualcomm Atheros PCAP Device Enumerator
-
-SYNOPSIS
- pcapdevs [options]
-
-DESCRIPTION
- The pcapdevs program enumerates available libpcap or winpcap devices on stdout.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for compilation and installation
- instructions.
-
-COMMENTS
- This program is only compiled in the Windows version of the toolkit because it is not needed on other platforms. It can
- be compiled, possibly with some modifications, on Linux or OpenBSD systems where libpcap development libraries are
- installed.
-
-BACKGROUND
- The Atheros Powerline Toolkit uses the libpcap or winpcap package to enable raw socket operations on systems that have no
- native raw packet support. Unfortunately, libpcap and winpcap reference available network interfaces by number rather
- than by name. Consequently, users need some way to determine what network interfaces are available and determine the
- number associated with each one. This utility does that.
-
-OPTIONS
- -h Print bash compatible variable definitions on stdout. The definitions enumerate available devices and their MAC
- addresses. This is merely a convenience to minimze typing errors and, consequently, some editing may be required.
- The output is a generous start when creating file hardware.sh.
-
- -q Suppresses printing of progress messages.
-
- -v Print additional information.
-
-EXAMPLES
- The following command enumerates available libpcap devices for a Linux host. Users should note the interface numbers and
- use them when specifying a network interfaces on libpcap enabled programs in this toolkit. The Ethernet hardware
- addresses shown may be useful when writing scripts.
-
- # pcapdevs
- 1 00:60:97:05:97:0C eth0
- 2 00:0F:EA:10:D5:1C eth1
- 3 00:0F:EA:10:D5:1C any (Pseudo-device that captures on all interfaces)
- 4 00:00:00:00:00:00 lo
-
- The next example enumaerates available winpcap devices on a Windows hosts. Observe that device names and descriptions
- are much longer than on Linux.
-
- # pcapdevs
- 1 00:00:00:00:00:00 \Device\NPF_GenericDialupAdapter (Adapter for generic dialup and VPN capture)
- 2 00:0E:2E:03:5F:B8 \Device\NPF_{4CFAABD5-C929-4942-914B-BDFE72B13611} (Realtek RTL8139 Family)
- 3 00:C0:49:D5:CB:14 \Device\NPF_{73E0D2EF-6069-4831-B379-507025F2BDCD} (Realtek RTL8139 Family)
- 4 00:0C:76:87:3E:3D \Device\NPF_{86B96905-3AA7-46F1-969A-6C23E3BBBA8B} (Broadcom NetXtreme Gigabit)
-
- Assuming that we have compiled and installed the Linux Toolkit with libpcap or winpcap support, we can use int6k to
- request revision information on all devices connected to interface 2 with the following command. Interface 2 is the
- default interface when the toolkit is comipled with either libpcap or winpcap and so option -i could have been omitted in
- this case.
-
- # int6k -i 2 -r
-
- Most example Atheros scripts include file hardware.sh that defines symbolic Ethernet interfaces, NIC1 and NIC2 and their
- respective hardware addresses, MAC1 and MAC2. These symbols are referenced by scripts when needed, providing a degree of
- host independence. The following example illustrates some typical output for a Windows environment. The output can be
- used with the Cygwin bash shell, for example.
-
- # pcapdevs -h > hardware.sh
- # cat hardware.sh
- NIC1=1 # Adapter for generic dialup and VPN capture
- NIC2=2 # Realtek RTL8139 Family Fast Ethernet Adapter (Microsoft's Packet Scheduler)
- NIC3=3 # Realtek RTL8139 Family Fast Ethernet Adapter (Microsoft's Packet Scheduler)
- NIC4=4 # Broadcom NetXtreme Gigabit Ethernet Driver
- MAC1=00:00:00:00:00:00 # Adapter for generic dialup and VPN capture
- MAC2=00:0E:2E:03:5F:B8 # Realtek RTL8139 Family Fast Ethernet Adapter (Microsoft's Packet Scheduler)
- MAC3=00:C0:49:D5:CB:14 # Realtek RTL8139 Family Fast Ethernet Adapter (Microsoft's Packet Scheduler)
- MAC4=00:0C:76:87:3E:3D # Broadcom NetXtreme Gigabit Ethernet Driver
-
- The previous example creats a basic hardware.sh file but some editing is still required. You should add a bang path at
- the top, delete definitions of NIC1 and MAC and renumber the remaining symbols. You may also want to add other host-spe‐
- cific definitions.
-
-SEE ALSO
- amp(1), ifs(1), plcnets(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 pcapdevs(1)
-
-pev(1) Qualcomm Atheros Open Powerline Toolkit pev(1)
-
-NAME
- pev - Qualcomm Atheros Plug-in Electric Vehicle Emulator
-
-SYNOPSIS
- pev [options]
-
-DESCRIPTION
- Emulate the PEV part of the HomePlug AV Signal Level Attentuation Characterization (SLAC) protocol where a PEV is a
- "Plug-in Electric Vehicle" and an EVSE is an "Electric Vehicle Supply Equipment" or charging station. This program will
- remain active until it detects and connects to an available EVSE-HLE on the powerline network. Once connected, it
- charges a virtual vehicle for about 10 seconds then disconnects and terminates. See the HomePlug Green PHY Specification
- Release Version 1.1 for more information on this protocol.
-
- Signal Level Attenuation Characterization (SLAC) enables a station to measure the signal level of its transmission at
- other stations in the network. It is designed for automotive applications where there are multiple plug-in vehicle
- (PEVs) and electric vehicle supply equipment (EVSE) on the network. The PEV signal level is measured at multiple EVSEs
- to determine which EVSE the PEV is actually plugged into. The process leading to this determination is called "Green PHY
- PEV-EVSE Association" (GreenPPEA).
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -c Print the PEV-HLE configuration profile on stdout. The configuration profile specifies program defaults in a for‐
- mat that you, as a user, can edit and save. Use options -p and -s to read named profiles and sections.
-
- -d Print the contents of the PEV-HLE session variable on stdout. The session variable is an program data structure
- that stores information passed between the PEV-HLE and EVSE-HLE during SLAC association. This option is used to
- inspect and veriify information relevant to the process. If the program was compiled with variable SLAC_DEBUG
- defined then this option also prints MME message fields before messages are sent or after they are received.
- Interested parties can follow along in the source code.
-
- -i Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -p profile
- The PEV-HLE configuration profile name. The program will supply default values for missing profile elements. See
- the example profile shown below. The default profile name is "pev.ini".
-
- -q Enter quiet mode. Progress messages are suppressed.
-
- -s section
- The configuration profile section name. The program will supply default values for missing configuration profile
- elements. See the example profile shown below. The default section name is "default".
-
- -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-PROFILES
- The default configuration profile for this program is "pev.ini". The default profile section is "default". Users may
- create addition profiles and reference them with option -p or add additional sections to an existing profiles and refer‐
- ence them with option -s.
-
- Attenuation Theshold
- The average attenuation above which the PEV will not connect to an EVSE. The default value is 10db.
-
- MSound Pause
- The time in milliseconds between each MSound sent by the PEV-HLE to the EVSE-HLE. Sending MSounds too frequently
- overloads the EVSE-PLC. Sending them too infrequently wastes time. This value is derived and does not appear in
- the HPGP specification. The default pause is 10 milliseconds.
-
- Vehicle Identifier
- Vehicle identification. The 17-byte Vehicle Identification Number to be placed in CM_MNBC_SOUND.IND.SenderID.
- This value is not used but is can be changed here so that the field is easy to spot within network message traces.
-
- Network Membership Key
- The 16-byte Network Memberhip Key (NMK) for the PEV-PLC device. This program uses CM_SET_KEY to sets the PEV-PLC
- NMK to this value after disconnecting. The default value is the key for Network Password "HomePlugAV".
-
- Network Identifier
- The 7-byte Network Identifier (NID) for the PEV-PLC device. This program uses CM_SET_KEY to sets the PEV-PLC NID
- to this value after disconnecting. The default value is the same as that for Network Password "HomePlugAV".
-
-REFERENCES
- See the Qualcomm Atheros AR7420, QCA6410 IEEE 1901, HomePlug AV and QCA7000 HomePlug Green PHY PLC Chipset Programmer''s
- Guide or the HomePlug Green PHY Specification Release Version 1.1 for more information on this protocol.
-
-EXAMPLES
- The following example starts a PEV session on interface eth0 and wait up to 2000 milliseconds (or 2 seconds) for the EVSE
- to respond during any given exchange.
-
- # pev -ieth0 -w2000
-
- The default PEV-HLE configuration profile, "pev.ini", looks something like this but it can be changed using a normal text
- editor. Use option -P to produce a template profile, if one is needed.
-
- # file: pev.ini
- # ====================================================================
- # PEV-HLE initialization;
- # --------------------------------------------------------------------
- [default]
- attenuation threshold = 10
- msound pause = 10
- vehicle identifier = AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
- network membership key = 50D3E4933F855B7040784DF815AA8DB7
- network identifier = B0F2E695666B03
-
-SEE ALSO
- plc(1), evse(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 pev(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed pev_cm_atten_char (struct session * session, struct channel * channel, struct message * message);
- *
- * slac.h
- *
- * PEV-HLE waits for CM_ATTEN_CHAR.IND from EVSE-HLE and responds
- * to indicate the data was received in good order; this response
- * does not mean that PEV-HLE will mate with EVSE-HLE;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PEV_CM_ATTEN_CHAR_SOURCE
-#define PEV_CM_ATTEN_CHAR_SOURCE
-
-#include <string.h>
-
-#include "../ether/channel.h"
-#include "../tools/memory.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../iso15118/slac.h"
-
-signed pev_cm_atten_char (struct session * session, struct channel * channel, struct message * message)
-
-{
- struct cm_atten_char_indicate * indicate = (struct cm_atten_char_indicate *) (message);
- struct cm_atten_char_response * response = (struct cm_atten_char_response *) (message);
- while (readmessage (channel, message, HOMEPLUG_MMV, (CM_ATTEN_CHAR | MMTYPE_IND)) > 0)
- {
- if (! memcmp (session->RunID, indicate->ACVarField.RunID, sizeof (session->RunID)))
- {
- slac_debug (session, 0, __func__, "<-- CM_ATTEN_CHAR.IND");
- memcpy (session->EVSE_MAC, indicate->ethernet.OSA, sizeof (session->EVSE_MAC));
- session->NUM_SOUNDS = indicate->ACVarField.NUM_SOUNDS;
- session->NumGroups = indicate->ACVarField.ATTEN_PROFILE.NumGroups;
- memcpy (session->AAG, indicate->ACVarField.ATTEN_PROFILE.AAG, indicate->ACVarField.ATTEN_PROFILE.NumGroups);
-
-#if SLAC_DEBUG
-
- if (_anyset (session->flags, SLAC_VERBOSE))
- {
- char string [256];
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.IND.ACVarField.APPLICATION_TYPE %d", indicate->APPLICATION_TYPE);
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.IND.ACVarField.SECURITY_TYPE %d", indicate->SECURITY_TYPE);
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.IND.ACVarField.SOURCE_ADDRESS %s", HEXSTRING (string, indicate->ACVarField.SOURCE_ADDRESS));
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.IND.ACVarField.RunID %s", HEXSTRING (string, indicate->ACVarField.RunID));
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.IND.ACVarField.SOURCE_ID %s", HEXSTRING (string, indicate->ACVarField.SOURCE_ID));
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.IND.ACVarField.RESP_ID %s", HEXSTRING (string, indicate->ACVarField.RESP_ID));
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.IND.ACVarField.NUM_SOUNDS %d", indicate->ACVarField.NUM_SOUNDS);
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.IND.ACVarField.ATTEN_PROFILE.NumGroups %d", indicate->ACVarField.ATTEN_PROFILE.NumGroups);
- slac_debug (session, 0, __func__, "CM_ATTEN_CHAR.IND.ACVarField.ATTEN_PROFILE.AAG %s", hexstring (string, sizeof (string), indicate->ACVarField.ATTEN_PROFILE.AAG, indicate->ACVarField.ATTEN_PROFILE.NumGroups));
- }
-
-#endif
-
- slac_debug (session, 0, __func__, "--> CM_ATTEN_CHAR.RSP");
- memset (message, 0, sizeof (* message));
- EthernetHeader (& response->ethernet, session->EVSE_MAC, channel->host, channel->type);
- HomePlugHeader1 (& response->homeplug, HOMEPLUG_MMV, (CM_ATTEN_CHAR | MMTYPE_RSP));
- response->APPLICATION_TYPE = session->APPLICATION_TYPE;
- response->SECURITY_TYPE = session->SECURITY_TYPE;
- memcpy (response->ACVarField.SOURCE_ADDRESS, session->PEV_MAC, sizeof (response->ACVarField.SOURCE_ADDRESS));
- memcpy (response->ACVarField.RunID, session->RunID, sizeof (response->ACVarField.RunID));
- memset (response->ACVarField.SOURCE_ID, 0, sizeof (response->ACVarField.SOURCE_ID));
- memset (response->ACVarField.RESP_ID, 0, sizeof (response->ACVarField.RESP_ID));
- response->ACVarField.Result = 0;
- if (sendmessage (channel, message, sizeof (* response)) <= 0)
- {
- return (slac_debug (session, 1, __func__, CHANNEL_CANTSEND));
- }
- return (0);
- }
- }
- return (slac_debug (session, session->exit, __func__, "<-- CM_ATTEN_CHAR.IND ?"));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed pev_cm_mnbc_sound (struct session * session, struct channel * channel, struct message * message);
- *
- * slac.h
- *
- * As HLE-PEV send cm_mnbc_sound indications unicast to the
- * MSOUND_TARGET address recorded in the session variable;
- *
- * a brief delay of a few milliseconds is needed between msounds
- * so that EVSE-PLC has time to forward CM_MNBC_SOUND.IND and
- * CM_ATTEN_PROFILE.IND to EVSE-HLE; session.timer controls this
- * delay;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PEV_CM_MNBC_SOUND_SOURCE
-#define PEV_CM_MNBC_SOUND_SOURCE
-
-#include <string.h>
-#include <errno.h>
-
-#include "../ether/channel.h"
-#include "../tools/memory.h"
-#include "../tools/error.h"
-#include "../tools/timer.h"
-#include "../iso15118/slac.h"
-
-signed pev_cm_mnbc_sound (struct session * session, struct channel * channel, struct message * message)
-
-{
- struct cm_mnbc_sound_indicate * indicate = (struct cm_mnbc_sound_indicate *) (message);
- signed sound = session->NUM_SOUNDS;
- while (sound--)
- {
- slac_debug (session, 0, __func__, "--> CM_MNBC_SOUND.IND");
- memset (message, 0, sizeof (* message));
- EthernetHeader (& indicate->ethernet, session->MSOUND_TARGET, channel->host, channel->type);
- HomePlugHeader1 (& indicate->homeplug, HOMEPLUG_MMV, (CM_MNBC_SOUND | MMTYPE_IND));
- indicate->APPLICATION_TYPE = session->APPLICATION_TYPE;
- indicate->SECURITY_TYPE = session->SECURITY_TYPE;
- memcpy (indicate->MSVarField.SenderID, session->PEV_ID, sizeof (indicate->MSVarField.SenderID));
- indicate->MSVarField.CNT = sound;
- memcpy (indicate->MSVarField.RunID, session->RunID, sizeof (indicate->MSVarField.RunID));
- memset (indicate->MSVarField.RND, 0, sizeof (indicate->MSVarField.RND));
- if (sendmessage (channel, message, sizeof (* indicate)) <= 0)
- {
- return (slac_debug (session, 1, __func__, CHANNEL_CANTSEND));
- }
- SLEEP (session->pause);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed pev_cm_slac_match (struct session * session, struct channel * channel, struct message * message);
- *
- * slac.h
- *
- * send CM_SLAC_MATCH.REQ and receive CM_SLAC_MATCH.CNF; store NMK
- * and NID in the session variable so that PEV-HLE can configure
- * PEV-PLC to form a network with EVSE-PLC;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PEV_CM_SLAC_MATCH_SOURCE
-#define PEV_CM_SLAC_MATCH_SOURCE
-
-#include <string.h>
-#include <errno.h>
-
-#include "../ether/channel.h"
-#include "../tools/memory.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../iso15118/slac.h"
-
-signed pev_cm_slac_match (struct session * session, struct channel * channel, struct message * message)
-
-{
- struct cm_slac_match_request * request = (struct cm_slac_match_request *) (message);
- struct cm_slac_match_confirm * confirm = (struct cm_slac_match_confirm *) (message);
- slac_debug (session, 0, __func__, "--> CM_SLAC_MATCH.REQ");
- memset (message, 0, sizeof (* message));
- EthernetHeader (& request->ethernet, session->EVSE_MAC, channel->host, channel->type);
- HomePlugHeader1 (& request->homeplug, HOMEPLUG_MMV, (CM_SLAC_MATCH | MMTYPE_REQ));
- request->APPLICATION_TYPE = session->APPLICATION_TYPE;
- request->SECURITY_TYPE = session->SECURITY_TYPE;
- request->MVFLength = HTOLE16 (sizeof (request->MatchVarField));
- memcpy (request->MatchVarField.PEV_ID, session->PEV_ID, sizeof (request->MatchVarField.PEV_ID));
- memcpy (request->MatchVarField.PEV_MAC, session->PEV_MAC, sizeof (request->MatchVarField.PEV_MAC));
- memcpy (request->MatchVarField.RunID, session->RunID, sizeof (request->MatchVarField.RunID));
- if (sendmessage (channel, message, sizeof (* request)) <= 0)
- {
- return (slac_debug (session, 1, __func__, CHANNEL_CANTSEND));
- }
- if (readmessage (channel, message, HOMEPLUG_MMV, (CM_SLAC_MATCH | MMTYPE_CNF)) > 0)
- {
- if (! memcmp (session->RunID, confirm->MatchVarField.RunID, sizeof (session->RunID)))
- {
- slac_debug (session, 0, __func__, "<-- CM_SLAC_MATCH.CNF");
-
-#if SLAC_DEBUG
-
- if (_anyset (session->flags, SLAC_VERBOSE))
- {
- char string [256];
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.CNF.APPLICATION_TYPE %d", confirm->APPLICATION_TYPE);
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.CNF.SECURITY_TYPE %d", confirm->SECURITY_TYPE);
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.CNF.MVFLength %d", LE16TOH (confirm->MVFLength));
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.CNF.MatchVarField.PEV_ID %s", HEXSTRING (string, confirm->MatchVarField.PEV_ID));
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.CNF.MatchVarField.PEV_MAC %s", HEXSTRING (string, confirm->MatchVarField.PEV_MAC));
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.CNF.MatchVarField.EVSE_ID %s", HEXSTRING (string, confirm->MatchVarField.EVSE_ID));
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.CNF.MatchVarField.EVSE_MAC %s", HEXSTRING (string, confirm->MatchVarField.EVSE_MAC));
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.CNF.MatchVarField.RunID %s", HEXSTRING (string, confirm->MatchVarField.RunID));
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.CNF.MatchVarField.NID %s", HEXSTRING (string, confirm->MatchVarField.NID));
- slac_debug (session, 0, __func__, "CM_SLAC_MATCH.CNF.MatchVarField.NMK %s", HEXSTRING (string, confirm->MatchVarField.NMK));
- }
-
-#endif
-
- memcpy (session->EVSE_ID, confirm->MatchVarField.EVSE_ID, sizeof (session->EVSE_ID));
- memcpy (session->EVSE_MAC, confirm->MatchVarField.EVSE_MAC, sizeof (session->EVSE_MAC));
- memcpy (session->NMK, confirm->MatchVarField.NMK, sizeof (session->NMK));
- memcpy (session->NID, confirm->MatchVarField.NID, sizeof (session->NID));
- return (0);
- }
- }
- return (slac_debug (session, session->exit, __func__, "<-- CM_SLAC_MATCH.CNF ?"));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed pev_cm_slac_param (struct session * session, struct channel * channel, struct message * message);
- *
- * slac.h
- *
- * PEV-HLE broadcasts cm_slac_param requests until at least one
- * matching cm_slac_param confirm is received; matching confirm
- * has the same run identifier; EVSE-HLE returns information to
- * the PEV-HLE;
- *
- * return 0 on success, -1 on error and 1 on timeout;
- *
- * this interaction effectivey synchronizes the PEV-HLE and one
- * or more EVSE-HLEs by initiating the SLAC protocol sequence;
- *
- * MSOUND-TARGET will be FF:FF:FF:FF:FF:FF for SLAC;
- * NUM_SOUNDS will be 8 for SLAC;
- * TIME_OUT will be 10 for SLAC;
- * RESP_TYPE will be 00 for SLAC (???);
- * FORWARDING_STA will be 00:00:00:00:00:00 for SLAC when RESP_TYPE=0;
- * APPLICATION_TYPE will be 0 for SLAC;
- * SECUTITY_TYPE will be 0 for this application;
- * RunID will be that defined by PEV-HLE;
- *
- * send cm_slac_param request then wait up to channel.timeout
- * milliseconds for a cm_slac_param confirm having the same
- * RunID as the request; the application type and security
- * type should be the same as in the request;
- *
- * save the msound target, forwarding station, number of sounds,
- * sounding timeout and response type for use later in the session;
- *
- * the forwarding stations is a vague concept; the specification
- * authors say it should be FF:FF:FF:FF:FF:FF but here, the EVSE-HLE
- * will set it to the PEV MAC;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PEV_CM_SLAC_PARAM_SOURCE
-#define PEV_CM_SLAC_PARAM_SOURCE
-
-#include <string.h>
-#include <errno.h>
-
-#include "../ether/channel.h"
-#include "../tools/memory.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../iso15118/slac.h"
-
-signed pev_cm_slac_param (struct session * session, struct channel * channel, struct message * message)
-
-{
- extern byte const broadcast [ETHER_ADDR_LEN];
- struct cm_slac_param_request * request = (struct cm_slac_param_request *) (message);
- struct cm_slac_param_confirm * confirm = (struct cm_slac_param_confirm *) (message);
- slac_debug (session, 0, __func__, "--> CM_SLAC_PARAM.REQ");
- memset (message, 0, sizeof (* message));
- EthernetHeader (& request->ethernet, broadcast, channel->host, channel->type);
- HomePlugHeader1 (& request->homeplug, HOMEPLUG_MMV, (CM_SLAC_PARAM | MMTYPE_REQ));
- request->APPLICATION_TYPE = session->APPLICATION_TYPE;
- request->SECURITY_TYPE = session->SECURITY_TYPE;
- memcpy (request->RunID, session->RunID, sizeof (request->RunID));
- request->CipherSuite [0] = HTOLE16 ((uint16_t) (session->counter));
- if (sendmessage (channel, message, (ETHER_MIN_LEN - ETHER_CRC_LEN)) <= 0)
- {
- return (slac_debug (session, 1, __func__, CHANNEL_CANTSEND));
- }
- while (readmessage (channel, message, HOMEPLUG_MMV, (CM_SLAC_PARAM | MMTYPE_CNF)) > 0)
- {
- if (! memcmp (session->RunID, confirm->RunID, sizeof (session->RunID)))
- {
- slac_debug (session, 0, __func__, "<-- CM_SLAC_PARAM.CNF");
- if (confirm->APPLICATION_TYPE != session->APPLICATION_TYPE)
- {
- slac_debug (session, session->exit, __func__, "Unexpected APPLICATION_TYPE");
- }
- if (confirm->SECURITY_TYPE != session->SECURITY_TYPE)
- {
- slac_debug (session, session->exit, __func__, "Unexpected SECURITY_TYPE");
- }
- if (_anyset (session->flags, SLAC_COMPARE))
- {
- if (LE16TOH (confirm->CipherSuite) != (uint16_t) (session->counter))
- {
- slac_debug (session, session->exit, __func__, "session->counter mismatch! PEV=(%d) EVSE=(%d)", LE16TOH (confirm->CipherSuite), session->counter);
- }
- }
-
-#if SLAC_DEBUG
-
- if (_anyset (session->flags, SLAC_VERBOSE))
- {
- char string [256];
- slac_debug (session, 0, __func__, "CM_SLAC_PARAM.CNF.MSOUND_TARGET %s", HEXSTRING (string, confirm->MSOUND_TARGET));
- slac_debug (session, 0, __func__, "CM_SLAC_PARAM.CNF.NUM_SOUNDS %d", confirm->NUM_SOUNDS);
- slac_debug (session, 0, __func__, "CM_SLAC_PARAM.CNF.TIME_OUT %d", confirm->TIME_OUT);
- slac_debug (session, 0, __func__, "CM_SLAC_PARAM.CNF.RESP_TYPE %d", confirm->RESP_TYPE);
- slac_debug (session, 0, __func__, "CM_SLAC_PARAM.CNF.FORWARDING_STA %s", HEXSTRING (string, confirm->FORWARDING_STA));
- slac_debug (session, 0, __func__, "CM_SLAC_PARAM.CNF.APPLICATION_TYPE %d", confirm->APPLICATION_TYPE);
- slac_debug (session, 0, __func__, "CM_SLAC_PARAM.CNF.SECURITY_TYPE %d", confirm->SECURITY_TYPE);
- slac_debug (session, 0, __func__, "CM_SLAC_PARAM.CNF.RunID %s", HEXSTRING (string, confirm->RunID));
- slac_debug (session, 0, __func__, "CM_SLAC_PARAM.CNF.CipherSuite %d", confirm->CipherSuite);
- }
-
-#endif
-
- memcpy (session->FORWARDING_STA, confirm->FORWARDING_STA, sizeof (session->FORWARDING_STA));
- memcpy (session->MSOUND_TARGET, confirm->MSOUND_TARGET, sizeof (session->MSOUND_TARGET));
- session->NUM_SOUNDS = confirm->NUM_SOUNDS;
- session->TIME_OUT = confirm->TIME_OUT;
- session->RESP_TYPE = confirm->RESP_TYPE;
- return (0);
- }
- }
- return (slac_debug (session, 0, __func__, "<-- CM_SLAC_PARAM.CNF ?"));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed pev_cm_start_atten_char (struct session * session, struct channel * channel, struct message * message);
- *
- * slac.h
- *
- * the PEV-HLE broadcasts a CM_START_ATTEN_CHAR.IND to initiate a
- * SLAC session; we broadcast three times per HPGP specification;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PEV_CM_START_ATTEN_CHAR_SOURCE
-#define PEV_CM_START_ATTEN_CHAR_SOURCE
-
-#include <sys/time.h>
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/types.h"
-#include "../tools/error.h"
-#include "../ether/channel.h"
-#include "../iso15118/slac.h"
-
-signed pev_cm_start_atten_char (struct session * session, struct channel * channel, struct message * message)
-
-{
- struct cm_start_atten_char_indicate * indicate = (struct cm_start_atten_char_indicate *) (message);
- slac_debug (session, 0, __func__, "--> CM_START_ATTEN_CHAR.IND");
- memset (message, 0, sizeof (* message));
- EthernetHeader (& indicate->ethernet, session->MSOUND_TARGET, channel->host, channel->type);
- HomePlugHeader1 (& indicate->homeplug, HOMEPLUG_MMV, (CM_START_ATTEN_CHAR | MMTYPE_IND));
- indicate->APPLICATION_TYPE = session->APPLICATION_TYPE;
- indicate->SECURITY_TYPE = session->SECURITY_TYPE;
- indicate->ACVarField.NUM_SOUNDS = session->NUM_SOUNDS;
- indicate->ACVarField.TIME_OUT = session->TIME_OUT;
- indicate->ACVarField.RESP_TYPE = session->RESP_TYPE;
- memcpy (indicate->ACVarField.FORWARDING_STA, session->FORWARDING_STA, sizeof (indicate->ACVarField.FORWARDING_STA));
- memcpy (indicate->ACVarField.RunID, session->RunID, sizeof (indicate->ACVarField.RunID));
- if (sendmessage (channel, message, (ETHER_MIN_LEN - ETHER_CRC_LEN)) <= 0)
- {
- return (slac_debug (session, 1, __func__, CHANNEL_CANTSEND));
- }
-
-#if 0
-
-/*
- * the GreenPHY spec says to send CM_START_ATTEN.IND three times to ensure
- * that is is received;
- */
-
- if (sendmessage (channel, message, (ETHER_MIN_LEN - ETHER_CRC_LEN)) <= 0)
- {
- return (slac_debug (session, 1, __func__, CHANNEL_CANTSEND));
- }
- if (sendmessage (channel, message, (ETHER_MIN_LEN - ETHER_CRC_LEN)) <= 0)
- {
- return (slac_debug (session, 1, __func__, CHANNEL_CANTSEND));
- }
-
-#endif
-
- return (0);
-}
-
-#endif
-
-
-
-pib2xml(1) Qualcomm Atheros Open Powerline Toolkit pib2xml(1)
-
-NAME
- pib2xml - print object driven xml editior intructions
-
-SYNOPSIS
- pib2xml [options] file [file] [...] [>stdout]
-
-DESCRIPTION
- Write XML editor instructions on stdout. This requires an object definition file that contains the size and name of data
- regions and members within a binary object or file. Individual data members are presented as XML instructions that can
- be used by program pxe to edit PIB files.
-
-OPTIONS
- -f definitions
- The name of the object definition file that contains the size, name and description of objects within a binary
- file. The definition file is not modified. This option is required. There is no default file.
-
- -s schema
- The url for the XML schema. The default schema is piboffset.xsd for the Qualcomm Atheros Powerline Toolkit verion
- of this program.
-
- -x Print an XML schema on stdout. This schema defines the elements and attributes used to define data objects and
- members read from input files. It can be used to validate XML files used with program pxe.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of a binary file. The file must have either Thunderbolt/Lightning or Panther/Lynx format or output will
- be incorrect. The file is not modified by this program. Only one such file is permitted on the command line.
-
-EXAMPLES
- The following is an example object definition file that defines a standard ethernet frame and member fields within it.
- The comments and descriptions shown are optional. The field lengths and field names are not. Zero-length fields denote
- arbitrary field groups and are used by program offset to print headings.
-
- # ========================================
- #
- # ----------------------------------------
-
- 0 header
- 6 ODA Own Destination Address
- 6 OSA Own Source Address
- 2 ET Ethertype or frame length
-
- # ========================================
- #
- # ----------------------------------------
-
- 0 body
- 1500 Payload
-
- # ========================================
- #
- # ----------------------------------------
-
- 0 trailer
- 4 CRC Cyclical Redundancy Check
-
- The following command uses object definition file ether.txt to identify and display member fields within binary file
- abc.bin as a set of xml instructions that can be used by program xde to edit other files.
-
- # pib2xml -f ether.txt abc.bin
-
- The next command writes the xml schema that defines the elements and attributes used in the edit instructions to file
- data.xsd. This file can be used to validate xml edit instructions.
-
- # pib2xml -x > data.xsd
-
-SEE ALSO
- chkpib(7), chkpib2(7), getpib(7), modpib(1), pibcomp(1), pibdump(1), setpib(1), xml2pib(1)
-
-CREDITS
- Charles Maier <cmaier@cmassoc.net>
-
-open-plc-utils-0.0.3 Mar 2014 pib2xml(1)
-
-pibcomp(1) Qualcomm Atheros Open Powerline Toolkit pibcomp(1)
-
-NAME
- pibcomp - Qualcomm Atheros Parameter Block Compare Utility
-
-SYNOPSIS
- pibcomp [options] file file [>stdout]
-
-DESCRIPTION
- Read and compare two Qualcomm Atheros powerline parameter block files and print only those objects that are different.
- It will detect and handle both old and new powerline parameter file formats. This program is similar to program odc but
- is designed specifically for Qualcomm Atheros powerline parameter files. Program odc is no longer supported and will be
- removed from future toolkit releases.
-
- Object driven comparison requires an object definition file that lists the size and name of data data objects (ie; inte‐
- gers, arrays or structures) within the parameter file. Individual data members are presented as smaller, individual data
- dumps within a larger, overall data dump. See program pibdump for more information of object definition file format.
-
-OPTIONS
- -f file
- The object definition file that lists the size, name and description of individual individual objects in order of
- occurance. If this option is omitted then object definitions are read from stdin. The object definition file is
- not modified by this program. See the pibdump man page for an example of an object definition file.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of a binary file. Two binary files are needed for comparison and both should conform to the object defi‐
- nition file for the comarison to be meaningful.
-
-EXAMPLES
- The following example compares file abc.bin and def.bin and prints objects that are different in hexdump format. Objects
- are defined in objects.txt and read using -f.
-
- # pibcomp -f objects.txt abc.bin def.bin
-
-SEE ALSO
- chkpib(7), chkpib2(7), getpib(7), modpib(1), pib2xml(1), pibdump(1), setpib(1), xml2pib(1)
-
-CREDITS
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 pibcomp(1)
-
-pibdump(1) Qualcomm Atheros Open Powerline Toolkit pibdump(1)
-
-NAME
- pibdump - Qualcomm Atheros Parameter Information Block Dump Utility
-
-SYNOPSIS
- pibdump [options] file [>stdout]
-
-DESCRIPTION
- Read a Qualcomm Atheros powerline parameter information block (PIB) file and print an object driven dump on stdout. This
- program replaces program odd because it distinguishes between legacy and current PIB file formats.
-
- An object driven dump requires an object definition file that lists the size and name of data objects (ie; integers,
- arrays or structures) within the parameter file. Individual data members are presented as smaller, individual data dumps
- within a larger, overall data dump.
-
-OPTIONS
- -f file
- The object definition file that lists the size, name and description of individual individual objects in order of
- occurance. If this option is omitted then object definitions are read from stdin. The object definition file is
- not modified by this program.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of a binary file. The file must have either Thunderbolt/Lightning or Panther/Lynx format or output will
- be incorrect. The file is not modified by this program. Only one such file is permitted on the command line.
-
-EXAMPLES
- The following is an example object definition file for an Ethernet frame. Frame fields, like ODA, OSA and ETHTYPE, are
- defined by length in order of their appears in the frame. Array subscripts following object names are optional but, if
- present, become part of the object name. Fields having no length are headers and will be ignored. Comments and blank
- lines are also ignored.
-
- # ========================================
- #
- # ----------------------------------------
-
- 0 header
-
- 6 ODA[6] Own Destination Address
- 6 OSA[6] Own Source Address
- 2 ETHTYPE Ethertype or frame length
-
- # ========================================
- #
- # ----------------------------------------
-
- 0 body
-
- 1500 Payload[1500]
-
- # ========================================
- #
- # ----------------------------------------
-
- 0 trailer
-
- 4 CRC Cyclical Redundancy Check
-
- The following command uses object definition file ether.txt to identify and display member fields within binary file
- abc.bin in hexadecimal dump format.
-
- # pibdump -f ether.txt abc.bin
-
-SEE ALSO
- chkpib(7), chkpib2(7), getpib(7), modpib(1), pib2xml(1), pibcomp(1), setpib(1), xml2pib(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 pibdump(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed pibfile (struct _file_ const * file);
- *
- * pib.h
- *
- * confirm that pib->file is a valid PIB file; determine if the
- * file is a panther/lynx image chain or flat file and call the
- * correct functions;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PIBFILE_SOURCE
-#define PIBFILE_SOURCE
-
-#include <stdio.h>
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/memory.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../pib/pib.h"
-
-signed pibfile (struct _file_ const * file)
-
-{
- uint32_t version;
- if (read (file->file, &version, sizeof (version)) != sizeof (version))
- {
- error (1, errno, FILE_CANTREAD, file->name);
- }
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- if (LE32TOH (version) == 0x60000000)
- {
- return (-1);
- }
- if (LE32TOH (version) == 0x00010001)
- {
- return (pibfile2 (file));
- }
- return (pibfile1 (file));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed pibfile1 (struct _file_ const * file);
- *
- * pib.h
- *
- * open a thunderbolt/lightning PIB file and validate it by
- * checking file size, checksum and selected internal parameters;
- * return a file descriptor on success; terminate the program on
- * error;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PIBFILE1_SOURCE
-#define PIBFILE1_SOURCE
-
-#include <unistd.h>
-#include <errno.h>
-
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../pib/pib.h"
-
-signed pibfile1 (struct _file_ const * file)
-
-{
- struct simple_pib simple_pib;
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- if (read (file->file, &simple_pib, sizeof (simple_pib)) != sizeof (simple_pib))
- {
- error (1, errno, FILE_CANTREAD, file->name);
- }
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- if ((simple_pib.RESERVED1) || (simple_pib.RESERVED2))
- {
- error (1, errno, PIB_BADCONTENT, file->name);
- }
- if (fdchecksum32 (file->file, LE16TOH (simple_pib.PIBLENGTH), 0))
- {
- error (1, errno, PIB_BADCHECKSUM, file->name);
- }
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed pibfile2 (struct _file_ const * file);
- *
- * pib.h
- *
- * open a panther/lynx PIB file and validate it by
- * checking file size, checksum and selected internal parameters;
- * return a file descriptor on success; terminate the program on
- * error;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PIBFILE2_SOURCE
-#define PIBFILE2_SOURCE
-
-#include <stdio.h>
-#include <stdint.h>
-#include <unistd.h>
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/memory.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../nvm/nvm.h"
-#include "../pib/pib.h"
-
-signed pibfile2 (struct _file_ const * file)
-
-{
- struct nvm_header2 nvm_header;
- uint32_t origin = ~0;
- uint32_t offset = 0;
- unsigned module = 0;
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- do
- {
- if (read (file->file, &nvm_header, sizeof (nvm_header)) != sizeof (nvm_header))
- {
- error (1, errno, NVM_HDR_CANTREAD, file->name, module);
- }
- if (LE16TOH (nvm_header.MajorVersion) != 1)
- {
- error (1, errno, NVM_HDR_VERSION, file->name, module);
- }
- if (LE16TOH (nvm_header.MinorVersion) != 1)
- {
- error (1, errno, NVM_HDR_VERSION, file->name, module);
- }
- if (checksum32 (&nvm_header, sizeof (nvm_header), 0))
- {
- error (1, errno, NVM_HDR_CHECKSUM, file->name, module);
- }
- if (LE32TOH (nvm_header.PrevHeader) != origin)
- {
- error (1, errno, NVM_HDR_LINK, file->name, module);
- }
- if (LE32TOH (nvm_header.ImageType) == NVM_IMAGE_PIB)
- {
- if (fdchecksum32 (file->file, LE32TOH (nvm_header.ImageLength), nvm_header.ImageChecksum))
- {
- error (1, errno, NVM_IMG_CHECKSUM, file->name, module);
- }
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- return (0);
- }
- if (fdchecksum32 (file->file, LE32TOH (nvm_header.ImageLength), nvm_header.ImageChecksum))
- {
- error (1, errno, NVM_IMG_CHECKSUM, file->name, module);
- }
- origin = offset;
- offset = LE32TOH (nvm_header.NextHeader);
- module++;
- }
- while (~nvm_header.NextHeader);
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- return (-1);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed piblock (struct _file_ const * pib);
- *
- * recompute and update the checksum on a thunderbolt or lightning
- * PIB file where the checksum is located inside the PIB;
- *
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PIBLOCK_SOURCE
-#define PIBLOCK_SOURCE
-
-#include <unistd.h>
-#include <errno.h>
-
-#include "../tools/error.h"
-#include "../tools/files.h"
-#include "../pib/pib.h"
-
-signed piblock (struct _file_ const * file)
-
-{
- struct simple_pib simple_pib;
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, "1 " FILE_CANTHOME, file->name);
- }
- if (read (file->file, &simple_pib, sizeof (simple_pib)) != sizeof (simple_pib))
- {
- error (1, errno, FILE_CANTREAD, file->name);
- }
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- simple_pib.CHECKSUM = fdchecksum32 (file->file, LE16TOH (simple_pib.PIBLENGTH), simple_pib.CHECKSUM);
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, "2 " FILE_CANTHOME, file->name);
- }
- if (write (file->file, &simple_pib, sizeof (simple_pib)) != sizeof (simple_pib))
- {
- error (1, errno, FILE_CANTSAVE, file->name);
- }
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * uint32_t piboffset (struct _file_ * file)
- *
- * The PIB is written to different SDRAM locations depending on
- * the chipset used; we use the PIN major/minor version here to
- * determine where to write the PIB but probably should switch
- * to using the hardware platform code derived from the
- * VS_SW_VER message;
- *
- *--------------------------------------------------------------------*/
-
-#include <stdlib.h>
-
-#include "../plc/plc.h"
-#include "../pib/pib.h"
-
-uint32_t piboffset (struct _file_ * file)
-
-{
- struct pib_header pib_header;
- uint32_t offset = 0;
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- if (read (file->file, &pib_header, sizeof (pib_header)) < sizeof (pib_header))
- {
- error (1, errno, FILE_CANTREAD, file->name);
- }
- if (lseek (file->file, 0, SEEK_SET))
- {
- error (1, errno, FILE_CANTHOME, file->name);
- }
- if (BE16TOH (*(uint16_t *)(&pib_header)) < 0x0305)
- {
- offset = LEGACY_PIBOFFSET;
- }
- else if (BE16TOH (*(uint16_t *)(&pib_header)) < 0x0500)
- {
- offset = INT6x00_PIBOFFSET;
- }
- else
- {
- offset = AR7x00_PIBOFFSET;
- }
- return (offset);
-}
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed pibpeek2 (void const * memory);
- *
- * pib.h
- *
- * print Panther/Lynx PIB identity information on stdout;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PIBPEEK2_SOURCE
-#define PIBPEEK2_SOURCE
-
-#include <stdio.h>
-#include <memory.h>
-
-#include "../tools/memory.h"
-#include "../tools/number.h"
-#include "../key/HPAVKey.h"
-#include "../key/keys.h"
-#include "../pib/pib.h"
-
-static char const * CCoMode2 [] =
-
-{
- "Auto",
- "Never",
- "Always",
- "User",
- "Covert",
- "Unknown"
-};
-
-static char const * MDURole2 [] =
-
-{
- "Slave",
- "Master"
-};
-
-signed pibpeek2 (void const * memory)
-
-{
- extern const struct key keys [KEYS];
- extern char const * CCoMode2 [];
- extern char const * MDURole2 [];
- struct PIB3_0 * PIB = (struct PIB3_0 *)(memory);
- char buffer [HPAVKEY_SHA_LEN * 3];
- size_t key;
- printf ("\tPIB %d-%d %d bytes\n", PIB->VersionHeader.FWVersion, PIB->VersionHeader.PIBVersion, LE16TOH (PIB->VersionHeader.PIBLength));
- printf ("\tMAC %s\n", hexstring (buffer, sizeof (buffer), PIB->LocalDeviceConfig.MAC, sizeof (PIB->LocalDeviceConfig.MAC)));
- printf ("\tDAK %s", hexstring (buffer, sizeof (buffer), PIB->LocalDeviceConfig.DAK, sizeof (PIB->LocalDeviceConfig.DAK)));
- for (key = 0; key < KEYS; key++)
- {
- if (!memcmp (keys [key].DAK, PIB->LocalDeviceConfig.DAK, HPAVKEY_DAK_LEN))
- {
- printf (" (%s)", keys [key].phrase);
- break;
- }
- }
- printf ("\n");
- printf ("\tNMK %s", hexstring (buffer, sizeof (buffer), PIB->LocalDeviceConfig.NMK, sizeof (PIB->LocalDeviceConfig.NMK)));
- for (key = 0; key < KEYS; key++)
- {
- if (!memcmp (keys [key].NMK, PIB->LocalDeviceConfig.NMK, HPAVKEY_NMK_LEN))
- {
- printf (" (%s)", keys [key].phrase);
- break;
- }
- }
- printf ("\n");
- printf ("\tNID %s\n", hexstring (buffer, sizeof (buffer), PIB->LocalDeviceConfig.PreferredNID, sizeof (PIB->LocalDeviceConfig.PreferredNID)));
- printf ("\tNET %s\n", PIB->LocalDeviceConfig.NET);
- printf ("\tMFG %s\n", PIB->LocalDeviceConfig.MFG);
- printf ("\tUSR %s\n", PIB->LocalDeviceConfig.USR);
- printf ("\tCCo %s\n", CCoMode2 [PIB->LocalDeviceConfig.CCoSelection > SIZEOF (CCoMode2)-1?SIZEOF (CCoMode2)-1:PIB->LocalDeviceConfig.CCoSelection]);
- printf ("\tMDU %s\n", PIB->LocalDeviceConfig.MDUConfiguration? MDURole2 [PIB->LocalDeviceConfig.MDURole & 1]: "N/A");
- return (0);
-}
-
-#endif
-
-
-
-pibruin(1) Qualcomm Atheros Open Powerline Toolkit pibruin(1)
-
-NAME
- pibruin - Classification Rule Insert Utility
-
-SYNOPSIS
- pibruin [options] [<rules] file
-
-DESCRIPTION
- Read a set of classification rules from stdin and insert them directly into a PIB file. This program is an alternative
- to program int6krule and a companion to program pibrump. Although it is possible to ruin a PIB using this command, the
- name is short for "rule insert".
-
- Atheros recommends that users validate all classification rule sets used with this program before inserting them into an
- operational PIB. Individual rules may be syntactically valid but they can still be technically invalid or conflict with
- other. This program does not perform any technical or cross-rule validation what-so-ever.
-
- Cross-rule validation is normally done by runtime firmware when a rule arrives in a VS_CLASSIFIER management message.
- This validation prevents the insertion of meaningless or conflicting rules into the PIB. It may be possible to commit a
- PIB containing mis-configured classification rule sets thus causing the device to lockup or misbehave on reboot.
-
- One recommended method of rule set validation is to program a device with individual rules using program int6krule then
- read the PIB and extract the rule set with program pibrump. The rule set should be valid at that point.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -o offset
- Specify an alternative PIB offset when inserting the classifier block. Customers should not use this option. It
- is provided to account for firmware changes that might occur in the future. Improper use of this option can ren‐
- der a PIB file unrecoverable.
-
- -q Suppresses progress messages.
-
- -v Print additional information on stdout.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of a valid Atheros runtime parameter file. The file is modified by this program only if the classifica‐
- tion rule file is syntactically correct. See the DISCLAIMER section below. No backup file is created. By con‐
- vention, runtime parameter files have a .pib extention but this program does not enforce that convention. The
- file must exist and be a valid PIB file or errors will occur.
-
- rules The name of a valid classifier rule file. The file is not modified by this program. Classifier rule files are
- standard ASCII text and may be created manually using a normal text editor or may be generated automatically using
- another program such as pubrump. By convention, classifier rule files have a ..qos extension but this program
- does not enforce that convention. If this file is omitted then rules are read from from the console, one rule per
- line.
-
-DISCLAIMER
- PIB file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information is not
- available. Qualcomm Atheros reserves the right to change the file structure or content in future firmware releases with‐
- out any obligation to notify or compensate users of this program.
-
- This program is provided for convenience only. It is possible to insert meaningless or confilicting rule sets into a PIB
- with this program because approved cross-rule validation is not performed. Incorrect application of perfectly valid
- rules may render a device ineffective or unusable on a powerline network. Program users are responsible for ensuring
- that their rule sets are verified by other means before using this program to insert them into an operational PIB file.
-
-EXAMPLES
- The following is an example set of classification rules stored in file rules.txt. The file contains 5 rules, one rule
- per line. The rules are identical to command line arguments expected by program int6krule and one could type them, one
- at a time, into int6krule and wait for the device to reset each time. Alternately, we could insert all the rules
- directly into a PIB file at once then download and commit the PIB, resulting in only one reset.
-
- # cat rules.txt
- Cap1 any VLANID is 20 add perm
- DropRX any VLANID is 25 add perm
- StripRx any VLANID is 5 VLANID is 10 VLANID is 15 add perm
- StripRx any VLANID is 20 add perm
- Cap1 any VLANID is 5 VLANID is 10 VLANID is 15 add perm
-
- The following example reads file rules.txt from stdin and writes it into file def.pib. This may be usefule if one wanted
- to distribute a known set of rules to other users or wanted to test various combinations of rules. Sincd rule files are
-
- # pibruin < rules.txt
-
- The next example reads classification rules directly from file abc.pib using program pibrump and writes them directly
- into file def.pbi using program pibruin. This is one means of transfering classification rules from one PIB to another.
-
-SEE ALSO
- int6krule(7), pibrump(7)
-
-CREDITS
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 pibruin(1)
-
-pibrump(1) Qualcomm Atheros Open Powerline Toolkit pibrump(1)
-
-NAME
- pibrump - Classification Rule Dump Utility
-
-SYNOPSIS
- pibrump [options] file [file] [...]
-
-DESCRIPTION
- Read classifier rules stored in a PIB file and print them on stdout in a format similar to the command line for program
- int6krule. The output can be read by program pibruin for insertion into another PIB file. The program name is short for
- "rule dump".
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -q Suppresses comments used to group classification rules.
-
- -v Print additional information on stdout. Presently, this option has no effect.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of a valid Atheros runtime parameter file. The file is not modified by this program. The file must
- exist and be a valid runtime parameter file or errors will occur. By convention, runtime parameter files have a
- .pib extention but this program does not enforce that convention.
-
-DISCLAIMER
- PIB file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information is not
- available. Qualcomm Atheros reserves the right to change the file structure or content in future firmware releases with‐
- out any obligation to notify or compensate users of this program.
-
-EXAMPLES
- The following example prints the classifier rules stored in file abc.pib on stdout. Individual rules are printed in a
- format that is essentially the same as that used to enter rules using program int6krule. Rules are grouped by their cat‐
- egory using comments.
-
- > pibrump abc.pib
- # auto connection rules:
- StripRX Any VLANID Is 5 VLANID Is 10 VLANID Is 15 add perm
- StripRX Any VLANID Is 20 add perm
- CAP1 Any VLANID Is 5 VLANID Is 10 VLANID Is 15 add perm
- # priority mapping rules:
- CAP1 Any VLANID Is 20 add perm
- DropRX Any VLANID Is 25 add perm
-
- The next example prints the classifier rules stored in file def.pib but output is a huge disappointment because there are
- no rules, much like a Rambo movie.
-
- > pibrump def.pib
- # auto connection rules:
- # priority mapping rules:
-
- The next example shows a case where the the user has selected two rules from the first example and used them as input to
- program int6krule. There is no PIB file involved here because an MME is sent directly to the device with each command
- and the device will reset each time. There are times when you may not want to set rules this way.
-
- > int6krule StripRX Any VLANID Is 5 VLANID Is 10 VLANID Is 15 add perm
- # int6krule CAP1 Any VLANID Is 20 add perm
-
- The next example reads classification rules from file abc.pib and write them to file rules.txt instead of the console.
- The rules are then read from file rules.txt and written into file def.pib using program pibruin. This procedure can be
- used to distribute a given rule set to other toolkit users.
-
- > pibrump abc.def > rules.txt
- # pibruin < rules.txt def.pib
-
- The next example reads classification rules directly from file abc.pib and writes them directly into file def.pib using
- program pibruin.
-
- > pibrump abc.pib | pibruin def.pib
-
-SEE ALSO
- int6krule(7), pibruin(7)
-
-CREDITS
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 pibrump(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * uint16_t pibscalers (struct _file_ * pib);
- *
- * return the number of scalers (carriers) based on the FWVERSION
- * stored in a .pib file; this function is a fix so that older
- * toolkit programs will work with newer chipsets;
- *
- * chipsets with the following carriers are supported:
- * - 1155 carriers
- * - 1345 carriers
- * - 2880 carriers
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PIBSCALERS_SOURCE
-#define PIBSCALERS_SOURCE
-
-#include <unistd.h>
-#include <errno.h>
-
-#include "../plc/plc.h"
-#include "../pib/pib.h"
-#include "../tools/error.h"
-
-uint16_t pibscalers (struct _file_ * pib)
-
-{
- // TODO: improve chipset detection
-
- struct pib_header pib_header;
- if (read (pib->file, &pib_header, sizeof (pib_header)) != sizeof (pib_header))
- {
- error (1, errno, "%s", pib->name);
- }
- if ((pib_header.FWVERSION == 0x01) &&
- (pib_header.PIBVERSION == 0x00))
- {
- return (PLC_CARRIERS);
- }
- if (pib_header.FWVERSION < 0x05)
- {
- return (INT_CARRIERS);
- }
- return (AMP_CARRIERS);
-}
-
-#endif
-
-
-
-plc(1) Qualcomm Atheros Open Powerline Toolkit plc(1)
-
-NAME
- Qualcomm Atheros Powerline Toolkit
-
-SYNOPSIS
- Qualcomm Atheros provides the Powerline Toolkit to customers free of charge. The toolkit contains source code and make‐
- files to build many useful programs. It also includes example shell scripts that use these programs, in various ways, to
- interrogate, control and manage QCA powerline devices. The programs are intended for hardware engineers and software
- developers, consequently. They are not intended for end users or computer novices. Most are compact and simple by
- design and can be included and executed on embedded platforms having few resources.
-
-INSTALLATION
- The Powerline Toolkit is distributed as a tarball named plc-utils-x.x.x.tar.gz or plc-utils-x.x.x.tar.bz2. Users may
- unpack the tarball and change to the directory that it creates to inspect the source code and documentation. To compile
- the source code, type "make". To install the programs, type "make install". To install man pages, type "make manuals".
- To uninstall programs and man pages, type "make uninstall". To read about the Toolkit, browse file docbook/index.html
- and docbook/toolkit.html. This package does not automatically install scripts or html pages. They must be manually
- copied to the preferred locations.
-
- We recommend that you login as root before installing this package; otherwise, you will be prompted for the root password
- as each component is installed. On some systems, "sudo make install" will work. Programs are installed in
- /usr/local/bin. Man pages are installed in /usr/share/man/man[1-9]. If these folders are not correct for your system,
- or if you want to install in other folders, then edit folder names defined in the Makefile in each package folder. The
- package has been compiled in a variety of Linux distributions (debian, ubuntu, redhat, monta vista, amilda) and on MacOSX
- (10.5, 10.6). It has also been cross-compiled for MIPS and Freescale iMX35 but QCA does not support general cross compi‐
- lation efforts.
-
- Although this package has been compiled on several platforms, there is no guarantee that it will compile without errors
- or warnings on non-GNU/Linux platforms. We continuously update the package but do not attempt to compile or test it on
- systems other than GNU/Linux and Microsoft VisualStudio .NET. Some programs have been excluded from the Windows instal‐
- lation for technical reasons.
-
-BACKGROUND
- HomePlug 1.0 and HomePlug AV are industry standard protocols for powerline communications. Qualcomm Atheros manufactures
- a family of chipsets that conform to these standards and have various USB, PCI, Ethernet, MII, SPI and UART host inter‐
- faces.
-
- The HomePlug 1.0 protocol is based on IEEE-802.3, has ethertype 0x887B and uses special message formats.
-
- The HomePlug AV protocol is based on IEEE-802.3, has ethertype 0x88E1 and special message formats. A subset of those
- message formats are left unspecified so that chipset vendors can define message formats for their own products. QCA ven‐
- dor specific management message formats are described in the QCA HomePlugAV Firmware Technical Reference Manual. This
- toolkit uses these messages to communicate with QCA powerline devices. Customers may use the toolkit to send these mes‐
- sages, explore device behavior and develope their own applications.
-
- Each program in the toolkit deals with a narrow aspect of QCA powerline device management but they can be called from
- shell scripts to perform complex tasks. With them, one can identify chipset hardware and firmware version, reset
- devices, flash devices, identify other QCA network devices, validate *.pib and *.nvm files, sniff HomePlug AV Ethernet
- frames, send generic Ethernet frames and so on.
-
- The source code is designed to demonstrate and educate and may be modified without obligation to Qualcomm Atheros. The
- QCA Application Engineering Team would appreciate feedback concerning changes that improve the useability, reliability or
- efficiency. Keep in mind that these tools are supposed to be small and simple.
-
-TOOLS
- There are many independent programs in this package. Significant ones are listed below. See html/overview.html for more
- information about the Atheros Powerline Toolkit.
-
- ampboot
- A command line utility to start, and optionally flash, newer Atheros Powerline Devices. It is an alternative to
- program int6kboot that may have additional options specific to the AR7400.
-
- amphost
- A example embedded host emulator that responds to VS_HST_ACTION messages sent from a flash-less device to a local
- host processor. It can be used to investigate and verify device-to-host interaction. The Atheros embedded API
- can perform similar functionality in a production environment.
-
- ampsnif
- A command line utility to enable or disable sniffer mode on an Atheros Powerline Device.
-
- amptest
- A command line utility to download and execute a sequence of test applets to the local powerline device. It is
- not for general use because there are no interlocks to prevent loading images designed for other platforms or
- loading images in illogical order. It is an laternative to, and replacement for, program int6ktest.
-
- amptool
- A basic device manager used to inspect and control Atheros powerline devices connected to the local host. It is
- similar to int6k but is specific to the AR7400 chipsets.
-
- ampwait
- A command line utility used to pause shell scripts at critical points where a device must be in a known state
- before proceeding. Typical cases involve waiting for device power off or reset, power on or restart and network
- device association.
-
- ar8236mdioblock
- Produce an MDIO block from Atheros AR8236 special register instructions. The output is suitable for downloading
- to INT6x00 and AR7x00 powerline devices.
-
- ar8236regedit
- Insert values into Atheros AR8236 special registers.
-
- chknvm A command line utility that validates NVM files based on internal header information, filesize, checksums and
- other general characteristics. Optionally, it can be used to display all image headers within an NVM file or the
- firmware revision contained in the file.
-
- chkpib A command line utility that validates PIB files based on internal header information, filesize, checksum, and
- other general characteristics. It can also be used to produce a text catalog of PIB files contained in a direc‐
- tory.
-
- coqos_add
- CoQoS stream utility. No description.
-
- coqos_info
- CoQoS stream utility. No description.
-
- coqos_man
- CoQoS stream utility. No description.
-
- coqos_mod
- CoQoS stream utility. No description.
-
- coqos_rel
- CoQoS stream utility. No description.
-
- efsu A utility to send freeform Ethernet frames. Frames are defined as text files containing hexadecimal byte codes
- having optional comments and whitespace. Comments and white space are stripped from the input file and the hexa‐
- decimal byte codes are transmitted as Ethernet frames.
-
- ethcat Send on or more files to a remote UART-enabled powerline device using IEEE 802.2 Ethernet frames. Transmitted
- frames are assembled into a serial data stream and forwarded to the local host by the remote device.
-
- fp A command line utility that prints the SHA256 digest for one or more files based on their content. Output can be
- used to compare files or identify files based soley on their content despite any filename changes.
-
- getpib A command line utility for extracting data from a valid PIB file based on data offset, length and format. It is a
- companion to program setpib. Both programs are intended for use in shell scripts. Users must have some knowledge
- about the data they are extracting.
-
- hpav An basic packet sniffer that displays incoming HomePlug AV protocol frames addressed to the host as they arrive.
- The program may be run in the background as a daemon.
-
- hpavkey
- A HomePlug AV key generator. HomePlug AV devices use has keys for various purposes. This program converts one or
- more pass phrases, entered on the command line, to either DAKs, NMKs or NIDs. It is similar to hpavkeys but con‐
- verts a limited number of pass phrases at one time.
-
- hpavkeys
- A HomePlug AV key generator. This program is similar to hpavkey but converts large number of pass phrases, read
- from stdin, and converts them to either DAKs, NMKs or NIDs.
-
- int6k A basic device manager used to inspect and control Atheros INT6x00 devices connected to the local host. It is
- similar to amptool and plctool but is implemented for INT6000, INT6300 and INT6400 devices only. Some options
- work on newer chipsets but otherd do not.
-
- int6kbaud
- A command line utility to configurate UART settings on a UART-enabled Atheros powerline device using the ATBR
- serial line command.
-
- int6kboot
- A command line utility used to bootstrap powerline devices having no flash memory, blank flash memory or corrupted
- memory. It interacts with the Atheros BootLoader to configure SDRAM then download runtime firmware and PIB and
- start firmware execution. It can also be used to force flash blank or corrupted flash memory.
-
- int6keth
- A command line utility to read and write device Ethernet PHY settings.
-
- int6kf A basic flash utility used to initialize INT6300 devices having no flash memory, blank flash memory or corrupted
- memory. It interacts with the Atheros Boot Loader to download SDRAM configuration, runtime firmware and PIB. It
- can also be used to force flash blank or corrupted flash memory.
-
- int6khost
- A example embedded host emulator that responds to VS_HST_ACTION messages sent from a flash-less device to a local
- host processor. It can be used to investigate and verify device-to-host interaction. The Atheros embedded API
- can perform similar functionality in a production environment.
-
- int6khost64
- An updated version of int6khost that omits the needed for an external SDRAM configuration file. It takes advan‐
- tage of the memctl applet included in the newer *.nvm files.
-
- int6kid
- A command line utility to print the DAK or NMK read from one or more devices. It can be used in shell scripts to
- dynamically obtain device key values and insert them on the command line of other programs.
-
- int6km A basic memory read utility used to inspect INT6x000 accessible SDRAM memory locations and mapped registers. Not
- all locations or registers are accessible.
-
- int6kmdio
- Insert values into MDIO PHY address registers using an VS_MDIO_COMMAND message.
-
- int6kmod
- A command line utility that downloads raw modules using a sequence of VS_MODULE_OPERATION messages.
-
- int6kprobe
- A command line utility that detects and reports neighbor networks using the VS_DIAG_PROBE message.
-
- int6krate
- A command line utility that reports computed PHY rates for a single device or all devices on a logical network.
- Ouput is designed for import into a spread sheet.
-
- int6krule
- A command line utility used to format and send classification rules to a device. Classification rules are speci‐
- fied using symbolic names for actions, options, conditons and frame fields.
-
- int6kstat
- A command line utility that prints device link statistics on stdout in a relatively undecorated format. Output is
- designed for easy interpretation by other programs.
-
- int6ktest
- A command line utility to download and execute a series of test applets to the local powerline device. It is not
- for general use because there are no interlocks to prevent loading images designed for other platforms or loading
- images in illogical order.
-
- int6kuart
- A command line utility to send serial line commands to a UART-enabled Atheros Powerline device. This program
- elminates the need for terminal emulation software and can be used to download PIB and firmware files to a device
- over the serial line interface.
-
- int6kwait
- A command line utility used to pause shell scripts at critical points where a device must be in a known state
- before proceeding. Typical cases involve waiting for device power off or reset, power on or restart and network
- device association.
-
- mac2pw A device password generator that prints a range of MAC addresses and user passwords on stdout. It is an alterna‐
- tive to the Atheros Production Test System (PTS) DBBuilder Utility.
-
- mac2pwd
- A device password generator that reads MAC addresses from one or more input files and prints addresses and pass‐
- words on stdout. It is an alternative to the Atheros Production Test System (PTS) DBBuilder utility.
-
- mdioblock
- Produce an MDIO block from generic MDIO register instructions. The output is suitable for downloading to INT6x00
- and AR7x00 powerline devices.
-
- mdiodump
- Display a binary MDIO program file in human readable form.
-
- mdiogen
- Generate a binary MDIO program file from a series of instruction macros. This program is for folks who know what
- they are doing. It has no man page or instructions for use.
-
- mdustats
- Collect and display various MDU traffic statistics using the VS_MDU_TRAFFIC_STATS message.
-
- modpib A basic command line PIB editor used to change the MAC, DAK and/or NMK of an existing PIB file. It can also be
- used to change the manufacturer string, network name and username strings.
-
- mrgpib A command line utility to copy PIB settings from one PIB file to another where the PIB files have different PIB
- versions.
-
- nvmmerge
- A command line utility to merge multiple applets or NVM files into a single NVM file.
-
- nvmsplit
- A command line utility to split an NVM file into multiple NVM files each containing one image. The original NVM
- file is preserved.
-
- odc An offset-driven hex compare utility for analysing the difference between two files having a fixed structure. An
- offset definition file is required for proper use. This program has been superceded by program pibcomp.
-
- odd An offset-driven hex dump utility for analyzing any binary file that has a fixed structured, such as an INT6000
- PIB file or an INT5500 CFG file. An offset definition file is required for proper use. This program has been
- superceded by program pibdump.
-
- odx An offset-driven XML generator used to convert an offset definition file, used by programs odc and odd, to an XML
- edit definition file used by program pxe.
-
- pibdump
- Read a Qualcomm Atheros powerline parameter file and print an object driven dump on stdout. This program requires
- an object definition file.
-
- pibcomp
- Read and compare two Qualcomm Atheros powerline parameter files and print an objec driver dump for only those
- object that are different. This program requires and object definition file.
-
- pibruin
- A classifier rule input utility used to insert multiple classifier rules into a pib file. Use program pibrump to
- read rules from another PIB file or create a rule file manually with any text editor. This program is an alterna‐
- tive to program int6krule.
-
- pibrump
- A classifier rule dump utility used to read rules from a PIB file and print them in a format similar to the input
- for program int6krule. The output can be read directly by program pibruin.
-
- plcboot
- A command line utility to start, and optionally flash, Qualcomm Atheros Powerline Devices. It is a newer version
- of program ampboot having options specific to the QCA6410, QCA7000 and AR7420 chipsets.
-
- plchost
- A example embedded host emulator that responds to VS_HST_ACTION messages sent from a flash-less device to a local
- host processor. It can be used to investigate and verify device-to-host interaction. The Atheros embedded API
- can perform similar functionality in a production environment.
-
- plcmod A command line utility that downloads raw modules using a sequence of VS_MODULE_OPERATION messages. This version
- can handle multiple module writes and modules exceeding 1400 bytes.
-
- plcnets
- A powerline network enumerator that searches all host network interfaces for powerline devices and their neigh‐
- bors.
-
- plctool
-
- plctest
- A command line utility to download and execute a sequence of test applets to the local powerline device. It is
- not for general use because there are no interlocks to prevent loading images designed for other platforms or
- loading images in illogical order. It is a newer version of program amptest.
-
- pskey Print the SHA256 digest for the amplitude make stored in a PIB file. The digest can be used as a fingerprint or
- signature for the prescaler set.
-
- psin Read a prescaler file from stdin and replace the amplitude map stored in a PIB file.
-
- psout Read a PIB file and print a prescaler file suitable for input using psin or the WIndows Device Manager.
-
- rkey A command line utility to generate distinct HomePlug AV compliant keys from a user defined keyfile that seeds the
- hash algorithm. It can be used to dynamically generate distinct keys inside shell scripts or create long lists of
- unique keys for use by other programs.
-
- setnvm A command line utility to modify slected header parameters for all image within a given NVM file. This program
- can be used to translate legacy NVM files to contemporary NVM file and vice verse.
-
- setpib A command line utility to insert arbitrary values into a PIB file based on data offset, length and format then
- compute a new PIB checksum. This program is a general purpose program intended for use in shell scripts but it
- requires detailed knowledge of PIB structure.
-
- ttycat A command line utility to write one or more files to a serial device. This program is a convenient tool for test‐
- ing Atheros UART-enabled powerline devices.
-
- weeder A command line utility to set the programmable attenuators build into the Atheros Production Test System (PTS).
-
- There may be other programs added, from time to time, that are not listed here.
-
-SEE ALSO
- amphost(1), ampinit(1), plcmod(1), amptest(1), amptool(1), ar8236regedit(1), chkpib(1), chknvm(1), coqos_add(1),
- coqos_info(1), coqos_man(1), coqos_mod(1), coqos_rel(1), efsu(1), efbu(1), getpib(1), hpav(1), hpavkey(1), hpavkeys(1),
- int6k(1), int6kbaud(1), int6kboot(1), int6keth(1), int6kf(1), int6khost(1), int6khost64(1), int6kid(1), int6km(1),
- int6kmdio(1), int6kmod(1), int6kprobe(1), int6krate(1), int6krule(1), int6kstat(1), int6ktest(1), int6kuart(1),
- int6kwait(1), mac2pw(1), mac2pwd(1), mdiodump(1), modpib(1), mrgpib(1), nvmmerge(1), nvmsplit(1), odc(1), odd(1), odx(1),
- pibdump(1), pibcomp(1), pibruin(1), pibrump(1), plcboot(1), plchost(1), plcmod(1), plcinit(1), plctest(1), plctool(1),
- plcrate(1), plcrate(1), plcwait(1), psin(1), pskey(1), psout(1), rkey(1), setnvm(1), setpib(1), ttycat(1), ttyrecv(1),
- ttysend(1), weeder(1)
-
-CREDITS
- Alex Vasquez <alex.vasques@qca.qualcomm.com>
- Andy Barnes <andy.barnes@qca.qualcomm.com>
- Bill Wike <bill.wike@qca.qualcomm.com>
- Charles Maier <cmaier@qca.qualcomm.com>
- John Byron <john.byron@qca.qualcomm.com>
- Mathieu Olivari <mathieu@qca.qualcomm.com>
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- Marc Bertola <marc.bertola@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plc(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * plc.c - Qualcomm Atheros Powerline Data Structure;
- *
- * this structure contains information needed to perform various
- * operations on Qualcomm Atheros powerline devices; it represents
- * one instance of a device and could easily be converted to an
- * object in the future;
- *
- * this structure points to a channel and a message structure;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Alex Vasquez <avasquez@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PLC_SOURCE
-#define PLC_SOURCE
-
-#include "../plc/plc.h"
-#include "../ether/channel.h"
-
-struct plc plc =
-
-{
- (struct channel *) (& channel),
- (struct message *) (0),
- (void *) (0),
- 0,
-
-/*
- * Local Device Address (LDA) buffer needed by all operations;
- */
-
- {
- 0x00,
- 0x00,
- 0x00,
- 0x00,
- 0x00,
- 0x00
- },
-
-/*
- * Remote Device Address (RDA) buffer needed by selected operations;
- */
-
- {
- 0x00,
- 0x00,
- 0x00,
- 0x00,
- 0x00,
- 0x00
- },
-
-/*
- * Network Membership Key (NMK) needed by VS_SET_KEY operations;
- * The default is an encrypted version of password "HomePlugAV";
- */
-
- {
- 0x50,
- 0xD3,
- 0xE4,
- 0x93,
- 0x3F,
- 0x85,
- 0x5B,
- 0x70,
- 0x40,
- 0x78,
- 0x4D,
- 0xF8,
- 0x15,
- 0xAA,
- 0x8D,
- 0xB7
- },
-
-/*
- * Device Access Key (DAK) needed for VS_SET_KEY operations;
- * The default is an encrypted version of password "HomePlugAV";
- */
-
- {
- 0x68,
- 0x9F,
- 0x07,
- 0x4B,
- 0x8B,
- 0x02,
- 0x75,
- 0xA2,
- 0x71,
- 0x0B,
- 0x0B,
- 0x57,
- 0x79,
- 0xAD,
- 0x16,
- 0x30
- },
-
-/*
- * struct _file_ CFG; MAC software will be read from this file and
- * written to RAM for each device specified on the command line;
- * some tools use this file for the panther/lynx softloader;
- */
-
- {
- (file_t) (-1),
- (char const *) (0)
- },
-
-/*
- * struct _file_ cfg; SDRAM configuration will be read from flash
- * on the specified device and written to this file;
- */
-
- {
- (file_t) (-1),
- (char const *) (0)
- },
-
-/*
- * struct _file_ SFT; softloader file to be written to flash
- * memory;
- */
-
- {
- (file_t) (-1),
- (char const *) (0)
- },
-
-/*
- * struct _file_ sft; softloader file to be read from flash
- * memory;
- */
-
- {
- (file_t) (-1),
- (char const *) (0)
- },
-
-/*
- * struct _file_ NVM; runtime firmware will be read from this file
- * and written to RAM for each device specified on the command line;
- */
-
- {
- (file_t) (-1),
- (char const *) (0)
- },
-
-/*
- * struct _file_ nvm; MAC software will be read from SDRAM on the
- * specified device and written to this file; interlocks elsewhere
- * in the code should prevent this file from being overwritten
- * multiple times, by accident, and ensure that it is created before
- * and new MAC software is written to device RAM;
- */
-
- {
- (file_t) (-1),
- (char const *) (0)
- },
-
-/*
- * struct _file_ PIB; PIB information will be read from this file
- * and written to RAM for each device specified on the command line;
- */
-
- {
- (file_t) (-1),
- (char const *) (0)
- },
-
-/*
- * struct _file_ pib; PIB information will be read from SDRAM on
- * the specified device and written to this file; interlocks elsewhere
- * in the code should prevent this file from being overwritten
- * multiple times, by accident, and ensure that it is created before
- * any new PIB software is written to device RAM;
- */
-
- {
- (file_t) (-1),
- (char const *) (0)
- },
-
-/*
- * struct _file_ XML; optional XML PIB edit instructions; this is an
- * advanced feature;
- */
-
- {
- (file_t) (-1),
- (char const *) (0)
- },
-
-/*
- * struct _file_ rpt; Watchdog Report data will be read from the device
- * and written to this file;
- */
-
- {
- (file_t) (-1),
- (char const *) (0)
- },
-
-/*
- * struct _file_ socket;
- */
-
- {
- (file_t) (-1),
- (char const *) (0)
- },
-
-/*
- * miscellaneous small integers used as needed when arguments
- * are required for an MME;
- */
-
- HARDWAREID,
- SOFTWAREID,
- PLCSESSION,
- HOSTACTION,
- SECTORCODE,
- MODULECODE,
- PUSHBUTTON,
- READACTION,
- PLCOUPLING,
- FLASH_SIZE,
-
-/*
- * various boolean flags; bailout causes exit on first failure;
- * timeout indicates a real timeout; count is the loop counter;
- * pause is a loop wait timer; values are declared as constants
- * above;
- */
-
- PLC_STATE,
- PLC_TIMER,
- PLC_SLEEP,
- PLC_COUNT,
- PLC_INDEX,
- PLC_FLAGS,
- PLC_FLAGS
-};
-
-#endif
-
-
-
-plcID(1) Qualcomm Atheros Open Powerline Toolkit plcID(1)
-
-NAME
- plcID - Echo Device Key
-
-SYNOPSIS
- plcID [options] [device] [device] [ ... ]
-
-DESCRIPTION
- This program prints a single powerline device key or HFID on stdout. It can be used to dynamically define environment
- variables or insert command line arguments in scripts at runtime. It is intended to echo a specific key read from a sin‐
- gle device but it can be used to echo a specific key type read from several devices by specifying either the Qualcomm
- Atheros Local Management Address or a broadcast address.
-
- This program is, in some sense, the inverse of modpib but it reads the key and HFID directly from the powerline device
- instead of reading from a PIB file.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -A Prints the Ethernet address (MAC) for each specified device. This option and options -D, -M, -N, -S and -U are
- mutually exclusive.
-
- -D Prints the Device Access Key (DAK) for each specified device. This option and options -A, -M, -N, -S and -U are
- mutually exclusive.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -n Append a newline to the end of each key. Newlines are omitted by default so that program output can be used as
- the raw input to another program. If you want the newline then you must request it with this option.
-
- -M Prints the Network Membership Key (NMK) for each specified device. This option and options -A, -D, -N, -S and -U
- are mutually exclusive.
-
- -N Prints the network HFID string for each specified device. This option and options -A, -D, -M, -S and -U are mutu‐
- ally exclusive.
-
- -q Suppresses status messages on stderr.
-
- -S Prints the manufacturer HFID string for each specified device. This option and options -A, -D, -M, -N and -U are
- mutually exclusive.
-
- -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
- be saved as text files for reference.
-
- -x Cause the program to exit on the first error instead of continuing with remaining iterations, operations or
- devices. Normally, the program reports errors and moves on to the next operation, iteration or device depending
- on the command line.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-EXAMPLES
- The following example prints the DAK of the local device on stdout. The local device is interrogated because no MAC
- address was specified. The default interface, eth1 on Linux and 2 on Windows, is used unless environment variable PLC is
- defined. The DAK is always printed by default. Depending on your system, you may want to use option -n when using this
- program interactively.
-
- # plcID
- 00:11:22:33:44:55:66:77:88:99:AA:DD:CC:DD:EE:FF
-
- The following example prints the NMK of device 00:B0:52:DA:DA:57 connected to interface eth2 on a Linux system. Several
- devices could be specified but that is not a common request.
-
- # DAK -Mi eth2 00:B0:52:DA:DA:57
- F4:23:71:4A:51:39:C2:2D:E5:EA:87:43:99:A1:37:81
-
- The following example dynamically inserts the DAK and NMK of the previous device on the command line of another program.
- In this example, we want to insert the DAK and NMK into PIB file abc.pib using program modpib. See the modpib man page
- for an explanation of command line syntax. See the GNU bash manuals for an explanation of why this works.
-
- # modpib abc.pib -D $(plcID -Di eth2 00:B0:52:DA:DA:57) -N $(plcID -Mi eth2 00:B0:52:DA:DA:57)
-
- The following example is an alternate way of accomplishing the same thing using shell script variables. This method may
- be easier to read and maintain. Notice that we 'squished' all the options together for brevity.
-
- # PLC=00:B0:52:DA:DA:57
- # DAK=$(plcID -Dieth2 ${PLC})
- # NMK=$(plcID -Mieth2 ${PLC})
- # modpib abc.pib -D ${DAK} -N ${NMK}
-
-SEE ALSO
- plc(1), plcboot(1), plcinit(1), plctool(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plcID(1)
-
-plcboot(1) Qualcomm Atheros Open Powerline Toolkit plcboot(1)
-
-NAME
- plcboot - Qualcomm Atheros Panther/Lynx Powerline Device Bootstrapper
-
-SYNOPSIS
- plcboot [options] -N file -P file [device] [device] [...]
-
-DESCRIPTION
- Download and start runtime firmware on a local powerline device when it is in bootloader mode. A powerline device enters
- bootloader mode if it has not flash memory or cannot load firmware from flash memory for some reason. You can use this
- progrm to start the device and then, optionally, permanently write a softloader, parameters and firmware into flash mem‐
- ory.
-
- Qualcomm Atheros introduced new boot methods with the Lightning chipset and new file formats and flash methods with the
- Panther chipset. This program supports the newer formats and methods. It does not support the older formats and meth‐
- ods. See programs int6kboot or ampboot to initialize earlier chipsets.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -e Redirects stderr messages to stdout. Normally, status and error messages are printed on stderr while primary pro‐
- gram output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -F[F] Flash or Force Flash NVRAM using either VS_MOD_NVM or VS_MODULE_OPERATION. Adding a second F here or another -F
- anywhere on the command line will force-flash a blank or corrupted NVRAM. Firmware loaded from NVRAM may treat
- force-flash as an error, depending of the firmware version.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -N filename
- The file containing the firmware chain used to boot and flash the device. This option and argument are required
- when booting or flashing a device but may appear anywhere on the command line. Invalid image files will be
- rejected. No assumptions are made about this file based on filename and no filename conventions are enforced.
-
- -P filename
- The file containing the firmware chain used to boot and flash the device. This option and argument are required
- when booting or flashing a device but may appear anywhere on the command line. Invalid image files will be
- rejected. No assumptions are made about this file based on filename and no filename conventions are enforced.
-
- -q Suppresses status messages on stderr.
-
- -S filename
- The file containing the softloader chain used to flash the device. On prior versions of plcboot, the presence of
- this option indicated that flash memory should be programmed but that is no longer the case. You must now specify
- bot this option and option -F in order to program flash memory. This option and argument are required when flash‐
- ing a device but may appear anywhere on the command line. Invalid image files will be rejected. No assumptions
- are made about this file based on filename and no filename conventions are enforced.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The Ethernet hardware address of some powerline device. More than one address may be specified on the command
- line. If more than one address is specified then operations are performed on each device in turn. The default
- address is local. as explained in the DEVICES section.
-
-DEVICES
- Powerline device addresses are 12 hexadecimal digits in upper, lower or mixed case. Individual octets may be separated
- by colons, for clarity, but colons are not required. For example, "00b052000001", "00:b0:52:00:00:01" and
- "00b052:000001" are valid and equivalent.
-
- A local device is any Atheros Powerline Device connected directly to a host Ethernet interface. A remote device is any
- Atheros Powerline Device at the far end of a powerline connection. A foreign device is any powerline device not manufac‐
- tured by Atheros.
-
- Common device addresses have symbolic names that can be used in place of the actual address value. The following sym‐
- bolic addresses are recognized by this program and most other toolkit programs.
-
- all Equivalent to "broadcast", described next.
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- will respond to this address.
-
- local A synonym for the Qualcomm Atheros Local Management Address (LMA), 00:B0:52:00:00:01. All local Atheros devices
- will respond to this address but remote and foreign devices will not.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for technical information. See the Qualcomm
- Atheros Powerline Toolkit Online Documetation for practical information and examples.
-
-EXAMPLES
- This example boots a powerline device by downloading runtime parameters and firmware then starting firmware execution.
- The actual boot method used will depend on the file formats and powerline device type detected by the program. The out‐
- put shown here is typical for panther and lynx chipsets. Option -P and -N are required but their order is not important.
- Tne MAC address may be omitted beccause it will default to 00:B0:52:00:00:01 which is also the default bootloader device
- address. On completion, runtime firmware is executing in SDRAM but flash memory has not been programmed. If This opera‐
- tion is common for flash-less devices. If we reset the device at this point then it will return to bootloader mode.
-
- # plcboot -P AR7420.pib -N AR7400.nvm
- eth1 00:B0:52:00:00:01 BootLoader is running
- eth1 00:B0:52:00:00:01 Write AR7420.nvm (1) (0x00000040:6212)
- eth1 00:B0:52:00:00:01 Start AR7420.nvm (1) (0x000000C0)
- eth1 00:B0:52:00:00:01 Write AR7420.pib (1) (0x00200000:10904)
- eth1 00:B0:52:00:00:01 Write AR7420.nvm (5) (0x002B610C:281252)
- eth1 00:B0:52:00:00:01 Start AR7420.nvm (5) (0x002B64FC)
- eth1 00:B0:52:BA:BE:88 MAC-QCA7420ES-0.9.0.278-0-20110914-INTERNAL is running
-
- The next example boots a device, as before, then flashes the same parameters and firmware into non-volatile memory
- attached to the device. Observe that a softloader is required and will be written to flash memory before runtime parame‐
- ters and firmware. The softloader need only be written once when first programming a blank flash memory. Option -FF is
- optional but permitted for backward compatibility with programs ampboot and int6kboot.
-
- # plcboot -P AR7420.pib -N AR7400.nvm -S AR7420-softloader.nvm -FF
- eth1 00:B0:52:00:00:01 Write AR7420.nvm (1) (00000040:6212)
- eth1 00:B0:52:00:00:01 Start AR7420.nvm (1) (000000C0)
- eth1 00:B0:52:00:00:01 Write AR7420.pib (1) (00200000:11692)
- eth1 00:B0:52:00:00:01 Write AR7420.nvm (5) (002B6A4C:282444)
- eth1 00:B0:52:00:00:01 Start AR7420.nvm (5) (002B6E3C)
- eth1 00:B0:52:00:00:06 MAC-QCA7420ES-1.0.0.280-00-20110923-ALPHA is running
- eth1 00:B0:52:00:00:06 Start Session
- eth1 00:B0:52:00:00:06 Flash AR7420-softloader.nvm
- eth1 00:B0:52:00:00:06 Close Session
- eth1 00:B0:52:00:00:06 Start Session
- eth1 00:B0:52:00:00:06 Flash AR7420.pib
- eth1 00:B0:52:00:00:06 Flash AR7420.nvm
- eth1 00:B0:52:00:00:06 Close Session
-
-DISCLAIMER
- Qualcomm Atheros firmware file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently,
- public information is not available. Qualcomm Atheros reserves the right to change firmware file structure or content or
- change the name or behavior of any program that inspects or changes firmware files, in future software releases without
- any obligation to notify or compensate users of such programs. Qualcomm Atheros HomePlug AV Vendor Specific Management
- Message structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information may not
- be available. Aualcomm Atheros reserves the right to modify message structure and content in future firmware releases
- without any obligation to notify or compensate users of this program.
-
-SEE ALSO
- ampboot(1), amptool(1), chknvm(1), chkpib(1), int6kboot(1), modpib(1), plctool(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plcboot(1)
-
-plcdevs(1) Qualcomm Atheros Open Powerline Toolkit plcdevs(1)
-
-NAME
- plcdevs - Qualcomm Atheros Powerline Device Enumerator
-
-SYNOPSIS
- plcdevs [options]
-
-DESCRIPTION
- Search host Ethernet interfaces for local Atheros powerline devices. This program is useful on host computers having
- multiple interface cards and powerline device are connected to only one or two of them.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Intellon Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- None.
-
-EXAMPLES
- The following example searches host Ethernet interfaces for powerline devices. We can see that there are three network
- interfaces present but interface eth3 is the only one having a local powerline device connected.
-
- # plcdevs
- eth2 00:0f:EA:4b:98:CA 010.234.095.003
- eth3 00:0F:EA:4B:98:CB 010.234.094.099 AR7400 INT7400-MAC-Test mac-release 2011/02/09 14:59:43 OCAFAE01494
- eth4 00:50:04:A5:D8:98 192.168.099.001
-
-SEE ALSO
- plc(1), ifs(1), plcnets(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plcdevs(1)
-
-plcfwd(1) Qualcomm Atheros Open Powerline Toolkit plcfwd(1)
-
-NAME
- plcfwd - Qualcomm Atheros Forward Configuration
-
-SYNOPSIS
- plcfwd [options] [device] [device] [...]
-
-DESCRIPTION
- Set VLAN and MAC address lookup for tx path traffic. Setup requests are processed by master PLC device attached to the
- local device. Upon receiving the request MME, the PLC device will send a confirm MME back with the results to the origi‐
- nating host.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -A Add VLANIDs of multiple slaves to memory.
-
- -C Commit configruation to flash memory.
-
- -D VLANID
- Set the default VLAN ID expressed as a 32-bit decimal value.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -f filename
- Read additional device addresses and VLAN IDs from the named file. This option may appear multiple times and may
- appear in addition option -z. Each occurance of this option adds one or more entries to the VLANID table used by
- options -A or -R. The format used on each line of this file is identical to that used by option -z.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -l length
- The read data length in bytes. This option is ignored during other operations. The length is expressed in deci‐
- mal. The default is 0 bytes.
-
- -M state
- Enable or disable VLANID forwarding on the master. Valid states are 0 to disable and 1 but values up to 255 are
- permitted. Keywords "on" and "enable" are the same as 1. Keywords "off" and "disable" are the same as 0.
-
- -o offset
- The read data offset in bytes. This option is ignored during other operations. The offset is expressed in hexa‐
- decimal. The default is 0 bytes;
-
- -q Suppresses status messages on stderr.
-
- -R Remove VLANIDs of multiple slaves from memory.
-
- -S state
- Enable or disable VLANID forwarding on all slaves. Valid states are 0 to disable and 1 but values up to 255 are
- permitted. Keywords "on" and "enable" are the same as 1. Keywords "off" and "disable" are the same as 0.
-
- -t timeout
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -z address,id[,id[,...]]
- A device address and associated VLAN IDs separated by commas. This option may appear multiple times and may
- appear in addition option -f. Each occurance of this option adds one entry to the VLANID table used by options -A
- or -R. The string format used here is identical to that used on each line of input files named by option -f.
-
- -?,--help
- Displays program help information on stderr. This option takes precedence over all other options on the command
- line except version information.
-
- -!,--version
- Displays program version information on stderr. This option takes precedence over all other options on the com‐
- mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for technical information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- The following example reads 100 bytes starting at offset 0x24. The operation is read because no other operation is
- specifed using -A, -C, -R, -M or -S. The offset is always in hexadecimal and length is always in decimal.
-
- # plcfwd -o 24 -l 100
-
- The following example adds three VLAN IDs to the VLANID table on device 00:B0:52:CA:FE:08. Option -z creates the VLANID
- table and option -A adds table content to the device. This program supports up to 10 VLAN IDs per entry but PLC firmware
- supports 8 maximum.
-
- # plcfwd -A -z 00:B0:52:CA:FE:08,2300,2313,2415
-
- The following example does the same thing but adds three table entries. The first entry is enclosed in quotes because
- spaces appear in the entry. The third entry has more than 10 VLAN IDs. The program will discard the last ID without
- indication but PLC firmware should report an error because there are more than 8 IDs reported in the request message.
-
- # plcfwd -A -z "00:B0:52:CA:FE:08, 2300, 2313 , 2415" -z 00B052BABE01,0100 -z
- 00B052888888,100,200,300,400,500,600,700,800,900,1000,1100
-
- To avoid typing the above command line many times, you can save the entries in file plcfwd.txt, like so ...
-
- 00:B0:52:CA:FE:08, 2300, 2313 , 2415
- 00B052BABE01,0100
- 00B052888888,100,200,300,400,500,600,700,800,900,1000,1100
-
- The next example adds these entries to the VLANID table by naming the file that contains the entries using option -f.
-
- # plcfwd -A -f plcfwd.txt
-
- The next example removes the same entries to the VLANID table.
-
- # plcfwd -R -f plcfwd.txt
-
- Of course, you can combine options -z and -f to cumulative effect.
-
-SEE ALSO
- PLC(1),
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plcfwd(1)
-
-plcget(1) Qualcomm Atheros Open Powerline Toolkit plcget(1)
-
-NAME
- plcget - Qualcomm Atheros PLC Get Propery
-
-SYNOPSIS
- plcget [options] [device] [device] [...]
-
-DESCRIPTION
- Read a specific property value from a Qualcomm Atheros powerline device using the VS_GET_PROPERTY message. Properties
- are selected using their numeric property identifier. Property names are not supported. Property values are printed on
- stdout in hexadecimal format by default. Alternate formats are ASCII, binary and decimal.
-
- Only selected properties can be read using this message type. See the Qualcomm Atheros Firmware Technical Reference Man‐
- ual for supported properties and versions.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -a Display output in string format where each byte appears as an ASCII character. Non-ASCII characters are displayed
- as a period or full-stop. This option is useful for displaying HFID property values.
-
- -b Display output in binary format where each byte appears as 8 bits or binary digits. This option is useful for
- interpreting bit-mapped property values.
-
- -d Display output in decimal format where each byte appears as three decimal digits. This option is useful for prop‐
- erties with small integer values.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -h Display output in hexadecimal format where each byte appears as a hexadecimal octet consisting of two hexadecimal
- digits. Hexadecimal is the default output format.
-
- -n number
- The property identifier or property version. Property identifiers and versions are entered as 32-bit decimal
- integers. Property names are not supported. The default is 0. This option may appear more than once on the com‐
- mand line. The first occurance specifies the property identifier. The second occurances specifies the property
- version. See the Firmware Technical Reference Manual for an list of valid property identifiers and versions.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this interface and only reponses received via this
- interface are recognized. The default interface is eth1 because most people use eth0 as their principle network
- connection; however, if environment string "PLC" is defined then it takes precedence over the default interface.
- This option then takes precedence over either default.
-
- -q Suppresses status messages on stderr.
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -?,--help
- Displays program help information on stderr. This option takes precedence over all other options on the command
- line except version information.
-
- -!,--version
- Displays program version information on stderr. This option takes precedence over all other options on the com‐
- mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for technical information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- None.
-
-SEE ALSO
- plc(1), getpib(1), modpib(1), plcset(1), setpib(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plcget(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- *
- * plcget.c -
- *
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <unistd.h>
-#include <stdlib.h>
-#include <stdint.h>
-#include <limits.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#include "../tools/getoptv.h"
-#include "../tools/putoptv.h"
-#include "../tools/memory.h"
-#include "../tools/number.h"
-#include "../tools/symbol.h"
-#include "../tools/types.h"
-#include "../tools/flags.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-#include "../ether/channel.h"
-
-/*====================================================================*
- * custom source files;
- *--------------------------------------------------------------------*/
-
-#ifndef MAKEFILE
-#include "../plc/Devices.c"
-#include "../plc/Confirm.c"
-#include "../plc/Display.c"
-#include "../plc/Failure.c"
-#include "../plc/Request.c"
-#include "../plc/ReadMME.c"
-#include "../plc/SendMME.c"
-#include "../plc/GetProperty.c"
-#endif
-
-#ifndef MAKEFILE
-#include "../tools/synonym.c"
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-#include "../tools/uintspec.c"
-#include "../tools/basespec.c"
-#include "../tools/hexdump.c"
-#include "../tools/hexencode.c"
-#include "../tools/hexdecode.c"
-#include "../tools/todigit.c"
-#include "../tools/binout.c"
-#include "../tools/hexout.c"
-#include "../tools/decout.c"
-#include "../tools/chrout.c"
-#include "../tools/error.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/MMECode.c"
-#include "../mme/EthernetHeader.c"
-#include "../mme/QualcommHeader.c"
-#include "../mme/UnwantedMessage.c"
-#endif
-
-/*====================================================================*
- *
- * int main (int argc, char const * argv[]);
- *
- * parse command line, populate plc structure and perform selected
- * operations; show help summary if asked; see getoptv and putoptv
- * to understand command line parsing and help summary display; see
- * plc.h for the definition of struct plc;
- *
- * the command line accepts multiple MAC addresses and the program
- * performs the specified operations on each address, in turn; the
- * address order is significant but the option order is not; the
- * default address is a local broadcast that causes all devices on
- * the local H1 interface to respond but not those at the remote
- * end of the powerline;
- *
- * the default address is 00:B0:52:00:00:01; omitting the address
- * will automatically address the local device; some options will
- * cancel themselves if this makes no sense;
- *
- * the default interface is eth1 because most people use eth0 as
- * their principle network connection; you can specify another
- * interface with -i or define environment string PLC to make
- * that the default interface and save typing;
- *
- *
- *--------------------------------------------------------------------*/
-
-int main (int argc, char const * argv [])
-
-{
- extern struct channel channel;
- static char const * optv [] =
- {
- "abdehi:n:qs:t:v",
- "device [device] [...]",
- "Qualcomm Atheros PLC Get Property",
- "a\tdisplay property in ASCII",
- "b\tdisplay property in binary",
- "d\tdisplay property in decimal",
- "e\tredirect stderr to stdout",
- "h\tdisplay property in hexadecimal",
-
-#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 n\tproperty identifier or version is (n) [0]",
- "q\tquiet mode",
- "s x\tsession identifier is (x) [" LITERAL (PLCSESSION) "]",
- "t n\tread timeout is (n) milliseconds [" LITERAL (CHANNEL_TIMEOUT) "]",
- "v\tverbose mode",
- (char const *) (0)
- };
-
-#include "../plc/plc.c"
-
- struct plcproperty plcproperty;
- signed c;
- if (getenv (PLCDEVICE))
- {
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (getenv (PLCDEVICE));
-
-#else
-
- channel.ifname = strdup (getenv (PLCDEVICE));
-
-#endif
-
- }
- optind = 1;
- memset (&plcproperty, 0, sizeof (plcproperty));
- while ((c = getoptv (argc, argv, optv)) != -1)
- {
- switch (c)
- {
- case 'a':
- plcproperty.DATA_FORMAT = PLC_FORMAT_ASC;
- break;
- case 'b':
- plcproperty.DATA_FORMAT = PLC_FORMAT_BIN;
- break;
- case 'h':
- plcproperty.DATA_FORMAT = PLC_FORMAT_HEX;
- break;
- case 'd':
- plcproperty.DATA_FORMAT = PLC_FORMAT_DEC;
- break;
- case 'e':
- dup2 (STDOUT_FILENO, STDERR_FILENO);
- break;
- case 'i':
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (optarg);
-
-#else
-
- channel.ifname = optarg;
-
-#endif
-
- break;
- case 'n':
- if (!plcproperty.PROP_NUMBER)
- {
- plcproperty.PROP_FORMAT = 1;
- plcproperty.PROP_LENGTH = sizeof (uint32_t);
- plcproperty.PROP_NUMBER = (uint32_t)(uintspec (optarg, 0, UINT_MAX));
- }
- else
- {
- plcproperty.PROP_VERSION = (uint32_t)(uintspec (optarg, 0, UINT_MAX));
- }
- break;
- case 'q':
- _setbits (channel.flags, CHANNEL_SILENCE);
- _setbits (plc.flags, PLC_SILENCE);
- break;
- case 's':
- plc.cookie = (uint32_t)(basespec (optarg, 16, sizeof (plc.cookie)));
- 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;
- default:
- break;
- }
- }
- argc -= optind;
- argv += optind;
- openchannel (&channel);
- if (!(plc.message = malloc (sizeof (* plc.message))))
- {
- error (1, errno, PLC_NOMEMORY);
- }
- if (!argc)
- {
- GetProperty (&plc, &plcproperty);
- }
- while ((argc) && (* argv))
- {
- if (!hexencode (channel.peer, sizeof (channel.peer), synonym (* argv, devices, SIZEOF (devices))))
- {
- error (1, errno, PLC_BAD_MAC, * argv);
- }
- GetProperty (&plc, &plcproperty);
- argc--;
- argv++;
- }
- free (plc.message);
- closechannel (&channel);
- exit (0);
-}
-
-
-
-plchost(1) Qualcomm Atheros Open Powerline Toolkit plchost(1)
-
-NAME
- plchost - Qualcomm Atheros Powerline Device Host Emulator
-
-SYNOPSIS
- plchost [options] -N file -P file
-
-DESCRIPTION
- Wait for VS_HST_ACTION.IND messages from a local device and service them as described in the QCA Firmware Technical Ref‐
- erence Manual. This program can be used to demonstrate or verify proper powerline device/host interaction for flash-less
- devices. This implementation is not production grade and will stop dead - like a bug! - when things go wrong. Consider
- using the Qualcomm Atheros Embedded API for real-time, production-grade applications.
-
- Host emulation applies to flash-less device designs where a local host processor provides the persistent storage. The
- local host can provide a wide range of intelligent storage functions for a device but this program offers one. Options
- -N and -P name existing files that store the factory default runtime firmware and parameters, respectively. Options -n
- and -p name scratch files that will store user firmware and parameters, respectively. This is similiar to the standard
- Atheros NVRAM scheme but is not the same.
-
- To use the program, connect a flash-less device to the host via ethernet then start this program with the correct file‐
- names. The program will automatically respond to device requests to download memory configuration, firmware and/or
- parameters and upload firmware or and/or parameters under device control. See the Qualcomm Atheros Firmware Technical
- Reference Manual for more information.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -F[F] Flash NVRAM once downloaded firmware has started. The same firmware and PIB are downloaded, again, using
- VS_WR_MOD and written to NVRAM using VS_MOD_NVM. Adding a second F here or another -F anywhere on the command
- line will perform a forced flash. When no NVRAM is present, normal and force flash cause the device to upload to
- the host. When blank or corrupted NVRAM is present, forced flash writes to NVRAM. This operation will fail when
- no NVRAM is present.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -N filename
- Use this fIle to download firmware when requested by the local device. The file must exist and have a valid NVM
- file format or it will be rejected. No assumptions are made based on filename and no filename conventions are
- enforced. The program will not over-write this file. This option and argument are required.
-
- -n filename
- Use this file to store firmware uploaded from the local device. The file need not exist but an error will occur
- if it cannot be created or written. If firmware is uploaded to this file, it is used for subsequent firmware
- downloads unless the device requests a factory reset. In that case, the file specified by option -N is used.
- This option and argument are optional. If omitted then the default filename user.pib will be used.
-
- -P filename
- Use this file to download parameters when requested by the local device. The file must exist and have a valid PIB
- file format or it will be rejected. No assumptions are made based on filename and no filename conventions are
- enforced. The program will not over-write this file. This option and argument are required.
-
- -p filename
- Use this file to store parameters uploaded from the local device. The file need not exist but an error will occur
- if it cannot be created or written. Once parameters are uploaded to this file, it is used for subsequent parame‐
- ter downloads unless the device requests a factory reset. In that case, the file specified by option -P is used.
- This option and argument are optional. If omitted then the default filename user.nvm will be used.
-
- -q Suppress status messages on stderr.
-
- -Sfilename
- Use this file to download the softloader when requested by the local device. The file must exist and have a valid
- NVM file format or it will be rejected. No assumptions are made based on filename and no filename conventions are
- enforced. The program will not over-write this file. This option and argument are required.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -v Print additional information on stdout. In particular, this option will print incoming and outgoing Ethernet
- frames on stdout.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- None.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-EXAMPLES
- The following command starts the host emulator. The -N and -P options are always required. Their order is not impor‐
- tant.
-
- # plchost -N test.nvm -P test.pib -n temp.nvm -p temp.pib
- eth1 00:B0:52:00:00:01 Waiting for Host Action Requests
-
- eth1 00:B0:52:00:00:01 Host Action Request is (4) configure memory.
- eth1 00:B0:52:00:00:01 Write Memory (00000040:15752)
- eth1 00:B0:52:00:00:01 Wrote mac-release-X.nvm
- eth1 00:B0:52:00:00:01 Started BootLoader
-
- eth1 00:B0:52:00:00:01 Host Action Request is (0) initialize device.
- eth1 00:B0:52:00:00:01 Write Memory (00000040:15752)
- eth1 00:B0:52:00:00:01 Wrote mac-release-X.nvm
- eth1 00:B0:52:00:00:01 Started BootLoader
- eth1 00:B0:52:00:00:01 Write Memory (00204000:1013952)
- eth1 00:B0:52:00:00:01 Wrote mac-release-X.nvm
- eth1 00:B0:52:00:00:01 Write Memory (01F00000:11400)
- eth1 00:B0:52:00:00:01 Wrote AR7400-WallAdapter-HomePlugAV_NorthAmerica.pib
- eth1 00:B0:52:00:00:03 Started INT7400-MAC-0-0-1008-00-63-20100227-AUTO-D
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- plc(1), ampboot(1), amptool(1),
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plchost(1)
-
-plchostd(1) Qualcomm Atheros Open Powerline Toolkit plchostd(1)
-
-NAME
- plchostd - Qualcomm Atheros PLC Host Daemon
-
-SYNOPSIS
- plchostd [options] -N nvmfile -P pibfile
-
-DESCRIPTION
- Wait for VS_HST_ACTION.IND messages from a local device and service them as described in the Qualcomm Atheros Firmware
- Technical Reference Manual for powerline devices. Unlike programs int6khost and int64host, this program uses operating
- system features available on POSIX, Unix, BSD and Linux systems but not available on Microsoft or VxWorks systems.
-
- To use the program, connect a flash-less device to the host via ethernet then start this program with the correct file‐
- names. The program will automatically respond to device requests to download memory configuration, firmware and/or
- parameters and upload firmware or and/or parameters under device control. See the Qualcomm Atheros Firmware Technical
- Reference Manual for more information.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -i interface
- Select the host Ethernet interface. All requests are sent via this interface and only reponses received via this
- interface are recognized. The default interface is eth1 because most people use eth0 as their principle network
- connection; however, if environment string "PLC" is defined then it takes precedence over the default interface.
- This option then takes precedence over either default.
-
- -N nvmfile
- The file containing the firmware chain used to boot and flash the device. The file must exist and have a valid
- NVM file format or it will be rejected. No assumptions are made based on filename and no filename conventions are
- enforced. The program will not over-write this file. This option and argument are required.
-
- -n filename
- Use this file to store firmware uploaded from the local device. The file need not exist but an error will occur
- if it cannot be created or written. If firmware is uploaded to this file, it is used for subsequent firmware
- downloads unless the device requests a factory reset. In that case, the file specified by option -N is used.
- This option and argument are optional. If omitted then the default filename host.pib will be used.
-
- -P pibfile
- The file containing the parameter chain used to boot and flash the device. The file must exist and have a valid
- PIB file format or it will be rejected. No assumptions are made based on filename and no filename conventions are
- enforced. The program will not over-write this file. This option and argument are required.
-
- -p filename
- Use this file to store parameters uploaded from the local device. The file need not exist but an error will occur
- if it cannot be created or written. Once parameters are uploaded to this file, it is used for subsequent parame‐
- ter downloads unless the device requests a factory reset. In that case, the file specified by option -P is used.
- This option and argument are optional. If omitted then the default filename host.nvm will be used.
-
- -q Suppress status messages on stderr.
-
- -s pathname
- The server socket pathname. Automatically open this Unix socket and post event information to it for the benefit
- of other host processes.
-
- -S filename
- The file containing the softloader chain used to flash the device. The presence of this file causes the device to
- be flashed once it has booted. The file must exist and have a valid PIB file format or it will be rejected. No
- assumptions are made based on filename and no filename conventions are enforced. The program will not over-write
- this file. This option and argument are required.
-
- -t timeout
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -v Print additional information on stdout. In particular, this option will print incoming and outgoing Ethernet
- frames on stdout.
-
- -w wakeup
- Wakeup time in seconds. If no VS_HST_ACTION.IND message is received within this time period then the process will
- wakeup and perform periodic functions such as posting network topography to the server socket specified by option
- -s.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- None.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-EXAMPLES
- The following example starts the host server. The -N and -P options are always required. Option order is not important.
- Control does not return to the console until the program is terminated by the user using CTRL-C or another command line
- interrupt.
-
- # plchostd -N test.nvm -P test.pib -n temp.nvm -p temp.pib
-
- The next example does the same but spawns the program as an independent process and returns control to the console. In
- this case, that process must be terminated or killed using an appropriate command such ad kill.
-
- # plchostd -N test.nvm -P test.pib -n temp.nvm -p temp.pib -d
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- plc(1), int64host(1), int6k(1), int6kboot(1), int6khost(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plchostd(1)
-
-plchostd2(1) Qualcomm Atheros Open Powerline Toolkit plchostd2(1)
-
-NAME
- plchostd2 - Qualcomm Atheros Panther/Lynx PLC Host Daemon
-
-SYNOPSIS
- plchostd2 [options] -N nvmfile -P pibfile
-
-DESCRIPTION
- Wait for VS_HST_ACTION.IND messages from a local device and service them as described in the Qualcomm Atheros Firmware
- Technical Reference Manual for powerline devices. Unlike programs int6khost and int64host, this program uses operating
- system features available on POSIX, Unix, BSD and Linux systems but not available on Microsoft or VxWorks systems. This
- program supports chipsets QCA6410, QCA7000 and QCA7420.
-
- To use the program, connect a flash-less device to the host via ethernet then start this program with the correct file‐
- names. The program will automatically respond to device requests to download memory configuration, firmware and/or
- parameters and upload firmware or and/or parameters under device control. See the Qualcomm Atheros Firmware Technical
- Reference Manual for more information.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -i interface
- Select the host Ethernet interface. All requests are sent via this interface and only reponses received via this
- interface are recognized. The default interface is eth1 because most people use eth0 as their principle network
- connection; however, if environment string "PLC" is defined then it takes precedence over the default interface.
- This option then takes precedence over either default.
-
- -N nvmfile
- The file containing the firmware chain used to boot and flash the device. The file must exist and have a valid
- NVM file format or it will be rejected. No assumptions are made based on filename and no filename conventions are
- enforced. The program will not over-write this file. This option and argument are required.
-
- -n filename
- Use this file to store firmware uploaded from the local device. The file need not exist but an error will occur
- if it cannot be created or written. If firmware is uploaded to this file, it is used for subsequent firmware
- downloads unless the device requests a factory reset. In that case, the file specified by option -N is used.
- This option and argument are optional. If omitted then the default filename host.pib will be used.
-
- -P pibfile
- The file containing the parameter chain used to boot and flash the device. The file must exist and have a valid
- PIB file format or it will be rejected. No assumptions are made based on filename and no filename conventions are
- enforced. The program will not over-write this file. This option and argument are required.
-
- -p filename
- Use this file to store parameters uploaded from the local device. The file need not exist but an error will occur
- if it cannot be created or written. Once parameters are uploaded to this file, it is used for subsequent parame‐
- ter downloads unless the device requests a factory reset. In that case, the file specified by option -P is used.
- This option and argument are optional. If omitted then the default filename host.nvm will be used.
-
- -q Suppress status messages on stderr.
-
- -S filename
- The file containing the softloader chain used to flash the device. The presence of this file causes the device to
- be flashed once it has booted. The file must exist and have a valid PIB file format or it will be rejected. No
- assumptions are made based on filename and no filename conventions are enforced. The program will not over-write
- this file. This option and argument are required.
-
- -t timeout
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -v Print additional information on stdout. In particular, this option will print incoming and outgoing Ethernet
- frames on stdout.
-
- -w wakeup
- Wakeup time in seconds. If no VS_HST_ACTION.IND message is received within this time period then the process will
- wakeup and perform periodic functions such as posting network topography to the server socket specified by option
- -s.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- None.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-EXAMPLES
- The following example starts the host server. The -N and -P options are always required. Option order is not important.
- Control does not return to the console until the program is terminated by the user using CTRL-C or another command line
- interrupt.
-
- # plchostd2 -N test.nvm -P test.pib -n temp.nvm -p temp.pib
-
- The next example does the same but spawns the program as an independent process and returns control to the console. In
- this case, that process must be terminated or killed using an appropriate command such ad kill.
-
- # plchostd2 -N test.nvm -P test.pib -n temp.nvm -p temp.pib -d
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- plc(1), int64host(1), int6k(1), int6kboot(1), int6khost(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plchostd2(1)
-
-plclist(1) Qualcomm Atheros Open Powerline Toolkit plclist(1)
-
-NAME
- plclist - List Atheros Device Addresses
-
-SYNOPSIS
- plclist [options] [device] [device] [...]
-
-DESCRIPTION
- print the local device address or all network device addresses for a specific device. This program is ideal for that
- special script jokey in your life. It only prints device addresses. Nothing else.
-
- Devices are detected using one of two methods. The two methods can be used in combination to determine network topology.
-
- The first method sends one VS_SW_VER message to the Qualcomm Atheros Local Management Address and prints the Ethernet
- source address found in each received confirmation message. The method is used when no device addresses appear on the
- command line. The result is a list of all local devices, being this connected directly to the local host. Each local
- device device may bridge to an independent powerline network having remote devices as members.
-
- The second method sends one VS_NW_INFO message to each specified device and prints the Ethernet source address found in
- each received message plus the Ethernet addresses of each network station identified in that message body. This method
- is used whenever one, or more, device addresses appear on the command line. It is possible to query remote powerline
- devices directly and so duplicate devices addresses are printed when devices share powerline neighbors.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-COMMENTS
- This program is identical to legacy program int6klist but uses version 1 of the Qualcomm Atheros VS_NW_INFO vendor-spe‐
- cific message. Older firmware versions may not recognize this message version.
-
-OPTIONS
- -b Print bridge device addresses. Each specified device reports it's own address. This option has no effect if no
- devices are specified.
-
- -i Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -n Append a newline to output.
-
- -q Enter quiet mode. This option has no effect at this time.
-
- -r Print remote device addresses. Each specified device reports neighbor device addresses. This option has no effect
- when no devices are specified.
-
- -s Insert a newline, instead of a space, between each device address.
-
- -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If omitted the the program out‐
- put consists of local device addresses only. Otherwise, output conisists of the specified device followed by all
- devices associated with it. The default address is local. See DEVICES for information about symbolic device
- addresses.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at the
- far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-EXAMPLES
- The following command lists all local devices. Since no devices are specified on the command line, one VS_SW_VER message
- is addressed to 00:B0:52:00:00:01 and the responses are collected. As we can see, there is only one local device avail‐
- able at this time. Observe that the prompt appears immediately after the address because newlines are omitted by default.
-
- # plclist
- 00:B0:52:BE:EF:04 #
-
- The next example does the same thing but there are now three local devices available. Observe that all devices are
- printed without intervening newlines so that the output of this program can be used as input to other toolkit programs.
-
- # plclist
- 00:B0:52:BE:EF:04 00:B0:52:BA:BE:02 00:B0:52:BA:BE:01 # int6k
-
- The next example queries the first local device from the previous example, 00:B0:52:BE:EF:04, for a list neighbor
- devices. This time a VS_NW_INFO message is sent because we named a device on the command line. The named device happens
- to be a local device but it need not be. We can see that the device has no neighbors.
-
- # plclist 00:B0:52:BE:EF:04
- 00:B0:52:BE:EF:04 # int6k
-
- The next example we query the next local device, 00:B0:52:BA:BE:02, and find that it has two neighbor devices that did
- not show up earlier because they are remote devices. Observe that the three devices comprise a complete logical powerline
- network. Device 00:B0:52:BA:BE:02 is connected to the local host but 00:0F:33:F2:01:21 and 00:0f:00:F2:01:13 are con‐
- nected to other hosts, somewhere.
-
- # plclist 00:B0:52:BA:BE:02
- 00:B0:52:BA:BE:02 00:0F:33:F2:01:21 00:0F:00:F2:01:13
-
- The next example shows that we can query multiple devices at a time for neighbors. We have copied the output from the
- second example and pasted it onto the command line. We now have a list of all devices, local and remote.
-
- # plclist 00:B0:52:BE:EF:04 00:B0:52:BA:BE:02 00:B0:52:BA:BE:01
- 00:B0:52:BE:EF:04 00:B0:52:BA:BE:01 00:B0:52:BA:BE:02 00:0F:33:F2:01:21 00:0F:00:F2:01:13
-
- This next example does the same thing but uses option -n to append a newline after each query. This output is eaiser to
- understand because each device queried starts on a new line and is followed by any neighbors.
-
- # plclist 00:B0:52:BE:EF:04 00:B0:52:BA:BE:02 00:B0:52:BA:BE:01 -n
- 00:B0:52:BE:EF:04
- 00:B0:52:BA:BE:02 00:0F:33:F2:01:21 00:0F:00:F2:01:13
- 00:B0:52:BA:BE:01
-
- This example invokes plclist which returns a list of local devices. That list is inserted into another plclist command
- line. This demontrates how program output can be used in scripts.
-
- # plclist $(plclist) -n
- 00:B0:52:BE:EF:04
- 00:B0:52:BA:BE:02 00:0F:33:F2:01:21 00:0F:00:F2:01:13
- 00:B0:52:BA:BE:01
-
- This next example accomplishes the same thing since all local device respond with a list of powerline neighbors.
-
- # plclist local
- 00:B0:52:BE:EF:04
- 00:B0:52:BA:BE:02 00:0F:33:F2:01:21 00:0F:00:F2:01:13
- 00:B0:52:BA:BE:01
-
-SEE ALSO
- plc(1), plcrate(1), plcstat(1), plctool(1), plctone(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plclist(1)
-
-plclog(1) Qualcomm Atheros Open Powerline Toolkit plclog(1)
-
-NAME
- plclog - Qualcomm Atheros Log Retrieval Utility
-
-SYNOPSIS
- plclog [options] [device] [device] [...] [>stdout]
-
-DESCRIPTION
- Read and print the device watchdog and checkpoint report on stdout for subsequent analysis by Atheros Technical Support.
- Report output is in XML format and contains base-64 encoded binary data returned by the device. Aside from the XML tags,
- output is not in human readable format.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -c Specify custom watchdog report.
-
- -C Clear the report after reading.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -x Print the report in XML format. The default is raw (or binary) format.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -q Suppresses status messages on stderr.
-
- -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
- be saved as text files for reference.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-LOGFILES
- Log files are save in binary format by default but they can also be saved in XML format by adding option -x to the com‐
- mand line. By convention, binary log files have a .log extension and XML log files have a .xlog extension. The exten‐
- sion is not critical but it helps us determine the format before we open the file.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. MAC addresses are 12 hexadecimal digits
- (0123456789ABCDEFabcdef) in upper, lower or mixed case. Individual octets may be separated by colons, for clarity, but
- not all octets need to be seperated. For example, "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and
- equivalent.
-
- The following MAC addresses are special and may be expressed by name instead of number.
-
- all Equivalent to "broadcast", described next.
-
- broadcast
- A synonym for the standard Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or
- foreign will respond to this address.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices will recognize this address but remote and foreign devices will not. A remote device is any
- device at the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Atheros Communications,
- Ocala FL USA. Consequently, public information is not available. Atheros Communications reserves the right to modify
- message structure or content in future firmware releases without any obligation to notify or compensate users of this
- program.
-
-EXAMPLES
- The following example reads the Watchdog and Checkpoint Report from device 00:B0:52:BA:BE:02 and prints them on stdout in
- XML format. The output contains data segments formatted in base-64 notation which preserved data integrity when read or
- transmitted in text format.
-
- # plclog 00:B0:52:BA:BE:02
-
- The next example does the same thing but pipes output to file temp.log. Atheros recommends using a .log extension for
- compatibility with the WIndows Device Manager.
-
- # plclog 00:B0:52:BA:BE:02 > temp.log
-
-SEE ALSO
- amp(1), plctool(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plclog(1)
-
-plcmdio16(1) Qualcomm Atheros Open Powerline Toolkit plcmdio16(1)
-
-NAME
- plcmdio16 - Qualcomm Atheros 16-bit MDIO Register Editor
-
-SYNOPSIS
- plcmdio16 [options] [device] [device] [...]
-
-DESCRIPTION
- Read or write generic MDIO registers using the Qualcomm Atheros VS_MDIO_COMMAND vendor-specific management message. The
- default operation is to read a register. Registers are written only if data is specified on the command line. This pro‐
- gram replaces program int6kmdio.
-
- This program writes MDIO instructions using 802.3 Clause 22 (phy, reg, data and mask) format. See program plcmdio162 for
- a similar program to write instructions using 802.3ae Clause 45 (address, data and mask) format.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. It replaces legacy program int6kmdio. See the plc man
- page for an overview and installation instructions.
-
-OPTIONS
- -d data
- A 16-bit data value to be inserted into the specified register. The specified data value is written when this
- option is present; otherwise the specified register is read and the content is displayed. Data values may be
- expressed in decimal, hexadecimal or binary notation. Hexadecimal values are prefixed with "0x" or "0X". Binary
- values are prefixed with "0b" or "0B".
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -p address
- The 5-bit PHY address. Some devices may not support all possible addresses. Addresses may be expressed in deci‐
- mal, hexadecimal or binary notation. Hexadecimal values must be prefixed with "0x" or "0X". Binary values must
- be prefixed with "0b" or "0B".
-
- -q Suppresses status messages on stderr.
-
- -r register
- The 5-bit register address. Addresses may be expressed in decimal, hexadecimal or binary notation. Hexadecimal
- values must be prefixed with "0x" or "0X". Binary values must be prefixed with "0b" or "0B". Some devices may
- not support all possible addresses.
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -?,--help
- Displays program help information on stderr. This option takes precedence over all other options on the command
- line except version information.
-
- -!,--version
- Displays program version information on stderr. This option takes precedence over all other options on the com‐
- mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for technical information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- None.
-
-SEE ALSO
- plc(1), int6kmdio(1), plcmod(1), plcmdio32(1), mdioblock(1), mdioblock2(1),
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plcmdio16(1)
-
-plcmdio32(1) Qualcomm Atheros Open Powerline Toolkit plcmdio32(1)
-
-NAME
- plcmdio32 - Qualcomm Atheros 32-bit MDIO Register Editor
-
-SYNOPSIS
- plcmdio32 [options] [device] [device] [...]
-
-DESCRIPTION
- Read or write global MDIO registers using multiple VS_MDIO_COMMAND vendor-specific management messages. Commands are
- entered using 32-bit register and data values then converted to threeequivalen 16-bit commands. The default operation
- is to read a register. Registers are written only if data is specified on the command line. Thsi program replaces pro‐
- gram int6kmdio2.
-
- This program writes MDIO instructions using 802.3ae Clause 45 (address, data and mask) format. See program int6kmdio for
- a similar program to write instructions using 802.3 Clause 22 (phy, reg, data and mask) format.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. It replaces legacy program int6kmdio2. See the plc man
- page for an overview and installation instructions.
-
-OPTIONS
- -a address
- The 19-bit global register address. Some devices may not support all possible addresses. Addresses may be
- expressed in decimal, hexadecimal or binary notation. Hexadecimal values must be prefixed with "0x" or "0X".
- Binary values must be prefixed with "0b" or "0B".
-
- -d data
- A 32-bit data value to be inserted into the specified register. The specified data value is written when this
- option is present; otherwise the specified register is read and the content is displayed. Data values may be
- expressed in decimal, hexadecimal or binary notation. Hexadecimal values are prefixed with "0x" or "0X". Binary
- values are prefixed with "0b" or "0B".
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -h When writing 32-bit values, write to the high-order register before the low-order register. This option is needed
- in cases where the value in one register may affect the interpretation of some value written to the other regis‐
- ter. This is not a common situation.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -q Suppresses status messages on stderr.
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -?,--help
- Displays program help information on stderr. This option takes precedence over all other options on the command
- line except version information.
-
- -!,--version
- Displays program version information on stderr. This option takes precedence over all other options on the com‐
- mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for technical information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- None.
-
-SEE ALSO
- plc(1), plcmod(1), plcmdio16(1), mdioblock(1), mdioblock2(1), mdiodump(1), mdiogen(1)
-
-CREDITS
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plcmdio32(1)
-
-plcotst(1) Qualcomm Atheros Open Powerline Toolkit plcotst(1)
-
-NAME
- plcotst - PLC One-Time Self-Test Manager
-
-SYNOPSIS
- plcotst [options] [device] [device] [...]
-
-DESCRIPTION
- Manage the PLC One-Time Self-Test feature on Atheros powerline devices. Normally, selftest is performed once, on startup
- at the factory, but it can also be configured and run again using this utility. Selftest results are stored by the
- firmware and can be read using this utility, as well. The selftest is configured when configuration options are speci‐
- fied on the command line; otherwise, selftest results are read or cleared.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -c version Configuration version number. Permitted values are 0 through 255. The default is 0. This option applies to
- both selftest configuration and selftest results.
-
- -C Clear stored selftest results. This option clears stored selftest results. This option implies selftest results
- and supercedes options -d, -f, -m, -r and -R, if present on the command line.
-
- -d seconds
- Delay selftest after reboot. Permitted delay times are 0 through UINT_MAX seconds. The default is 0 seconds.
- This option implies selftest configuration and supercedes option -C, if present on the command line.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -f count
- Run the flash memory selftest count times. Valid values are 0 through UINT_MAX. The default is 0 which effec‐
- tively suppresses the test. This option implies selftest configuration and supercedes option -C, if present on
- the command line.
-
- -m count
- Run the memory selftest count times. Valid values are 0 through UINT_MAX. The default is 0 which suppresses
- effectively the test. This option implies selftest configuration and supercedes option -C, if present on the com‐
- mand line.
-
- -q Suppresses status messages on stderr.
-
- -r flag
- Run selftest after reboot. Permitted values are 0 through 255. Expected values are 0 for false and 1 for true.
- The default is 1. If the memory test count and flash test count are both 0 no testing will occur when the time
- comes. This option implies selftest configuration and supercedes option -C, if present on the command line.
-
- -R flag
- Reset device after selftest. Permitted values are 0 through 255. Expected values are 0 for false and 1 for true.
- The default is 0. This option applies to selftest configuration only and supercedes option -C, if present on the
- command line.
-
- -t timeout
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
- be saved as text files for reference.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The Ethernet hardware address of some powerline device. More than one address may be specified on the command
- line. If more than one address is specified then operations are performed on each device in turn. The default
- address is local. as explained in the DEVICES section.
-
-EXAMPLES
- The following example prints stored test results for the local device on stdout because no options are specified on the
- command line.
-
- # plcotst
-
- The next example prints stored test results for remote device 00:B0:52:BA:BE:DE and clears them afterwards.
-
- # plcotst -C
-
- The next example configures the PLC selftest to wait 5 seconds before execution because option -d is present. It also
- configures the selftest to reset the device after execution because option -R is present
-
- # plcotst -d 5 -R
-
-REFERENCES
- See the Qualcomm Atheros Powerline Firmware Technical Reference Manual for more information about firmware selftest.
-
-DISCLAIMER
- None.
-
-SEE ALSO
- plc(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plcotst(1)
-
-plcrate(1) Qualcomm Atheros Open Powerline Toolkit plcrate(1)
-
-NAME
- plcrate - Qualcomm Atheros AR7x00 PHY Rate Monitor
-
-SYNOPSIS
- plcrate [options] [device] [device] [...]
-
-DESCRIPTION
- The Atheros PHY Rate Utility polls one or more devices and prints the average transmit and receive PHY rates between a
- device and each neighboring network device. Output is column-oriented and suitable for loading into a spreadsheet or
- being read by a simple program.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-CHIPSETS
- QCA6410, QCA7000, QCA7420
-
-OPTIONS
- -c Display coded PHY rates. Coded PHY rates are displayed by default so this option is redundant but it has been
- kept for backword compatibility. This option and option -u are mutually exclusive.
-
- -d seconds
- Traffic duration in seconds per connection. Directional traffic is systematically sent between each pair of pow‐
- erline network devices for this period of time. Consequently, the total time needed to generate traffic between
- all network devices will be approximately n! times this value, so don''t get carried away. The minimum value is 1
- second and the maximum value is 60 seconds.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -n Reads the average transmit and receive PHY rate for wach device using VS_NW_INFO and prints it on stdout. Each
- output line displays the ethernet interface, source address, destination address and either the transmit or
- receive PHY rate.
-
- -o milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -q Enter quiet mode. Progress messages are suppressed.
-
- -r Reads device hardware and software revision information using VS_SW_VER and prints it on stdout.
-
- -R Resets the device using VS_RS_DEV.
-
- -t Generate powerline traffic between the local device and each remote device on each powerline network connected to
- the host. It does not generate any traffic between remote powerline device pairs. This option is especially use‐
- ful when remote powerline devices are not connected to Ethernet devices capable of sending traffic back to the
- host.
-
- -T Generate powerline traffic between all devices on each powerline network connected to the host. This option is
- similar to option -t but it takes much longer because traffic is systematically generated between each pair of
- powerline devices. Consequently, the time to complete will increase factorially as the number of network devices
- increases. Such complete traffic path coverage is not always needed.
-
- -u Display un-coded PHY rates. Coded PHY rates are displayed by default. This option and option -c are mutually
- exclusive.
-
- -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
-
- -x Exit program on first error with a non-zero exit code. This option allows shell scripts to detect failed or
- incomplete operations and take the appropriate action.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-EXAMPLES
- The following example displays the average transmit and receive PHY rates from each of two devices. One is a local
- device connected to interface eth2 and the other is a remote device at the far end of the powerline. In this case, they
- are the only two devices on the powerline network. Observe the recipricol rates shown.
-
- # plcrate -ni eth2 00:B0:52:00:00:AA 00:B0:52:00:00:BB
- eth2 00:B0:52:00:00:AA 00:B0:52:00:00:BB TX 163 mbps
- eth2 00:B0:52:00:00:AA 00:B0:52:00:00:BB RX 176 mbps
- eth2 00:B0:52:00:00:BB 00:B0:52:00:00:AA TX 176 mbps
- eth2 00:B0:52:00:00:BB 00:B0:52:00:00:AA RX 163 mbps
-
- The following example generates powerline traffic between the local device and each remote device because option -t is
- present. It then displays the PHY rate read from the local device.
-
- # plcrate -tni eth2
- eth2 00:B0:52:00:00:AA 00:B0:52:00:00:BB TX 163 mbps
- eth2 00:B0:52:00:00:AA 00:B0:52:00:00:BB RX 176 mbps
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- PLC(1), amprate(1), int6krate(1)
-
-CREDITS
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plcrate(1)
-
-plcrule(1) Qualcomm Atheros Open Powerline Toolkit plcrule(1)
-
-NAME
- plcrule - Stream Classification Utility
-
-SYNOPSIS
- plcrule [options] action operand condition [condition] [condition] control volatility [device] [device] [...]
-
- where condition is a field operator value sequence.
-
-DESCRIPTION
- Format and send stream classification rules to one or more devices. Rules specify an action to be taken when a frame
- satisfies selection criteria. Selection criteria consists of one, two or three conditions where any or all conditions
- must be satisfied. Each condition consists of a field type, a relational operator and a value. Rules may be added to a
- device, or removed from a device, so that they have permanent or temporary effect.
-
- Classification rules are cumulative. If a new rule set is identical to an old rule set then an error will occur unless
- it contains a different Transmission Action. In that case the old rule will be replaced. Identical classification rule
- sets are permitted if one of the sets is associated with a VLAN tag action. Classification is based on the original
- frame before is is altered by VLAN Tag insertion or removal.
-
- Classification is multi-dimensional and the terminology used here may seem strange at first. Refer to the Qualcomm
- Atheros Firmware Techncial Reference Manual description of the VS_CLASSIFICATION management message for a full explana‐
- tion.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -q Suppresses status messages on stderr.
-
- -r Read rules from a device and display them on stdout.
-
- -s Print a list of program keywords on stdout. This option over-rides all others, except -? and -!, and the program
- will terminate without further action.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu. -T tag The VLAN tag to be inserted into frames
- before they are transmitted. The tag is a 32-bit hexadecimal integer with optional "0x" prefix. This option is
- required for action TagTX and must be omitted for all other actions.
-
- -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
- be saved as text files for reference.
-
- -V version
- The CSPEC version number expressed as a small decimal integer. This option is required (and should be 2) for
- action TagTX and must be omitted for all other actions.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- action The action to be taken for frames that meet any (or all) selection criteria. Valid actions are listed and
- described under ACTIONS.
-
- operand
- The operand specifies the logical relationship between conditions before the action to be taken. Valid operands
- are listed and described under OPERANDS.
-
- condition
- A conditional expression consisting of a field, operator and value. See CONDITIONS for more information.
-
- control
- The control specifies the action to be taken by the device upon receipt of the rule. The basic actions are to add
- it to, or remove it from, the list of existing rules. Valid controls are listed and described under CONTROLS.
-
- volatility
- The volatility specifies the effective lifetime of the rule. Temoprary rules are stored in SDRAM and are lost
- then the device is reset. Permanent rules are stored in NVRAM and are restored after the device is reset. Valid
- volatilities are listed and described under VOLATILITY.
-
- device The MAC address of some powerline device. More than one address may be specified on the command line. If more
- than one address is specified then operations are performed on each device in turn. The default address is
- "local". See DEVICES for more information.
-
-ACTIONS
- Actions indcate the disposition of frames that match selection criteria. They are expressed as discrete alphanumeric
- strings entered in upper, lower or mixed character case. They are position sensitive. Failure to enter a known action
- will results in an error message that lists permitted actions.
-
- CAP0,CAP1,CAP2,CAP3
- Assign a specific Channel Access Priority to frames.
-
- Drop,DropTX
- Do not forward frames over powerline.
-
- DropRX Do not forward frames to host.
-
- Boost Boost frame priority to CAP3 for MMEs only. At least one condition must be "MME".
-
- StripTX
- Remove the VLAN Tag from frames before transmission over powerline. This option checks for a VLAN Tag even when
- there are no VLAN related conditions.
-
- StripRX
- Remove the VLAN Tag from frames before forwarding to host. This option checks for a VLAN Tag even when there are
- no VLAN related conditions.
-
- TagTX Insert a given VLAN Tag into frames before transmission over powerline. This action requires option -T to specify
- the tag and option -V to specify the CSPEC version.
-
-OPERANDS
- The operand indicates the logical relationship that must exist between conditions in the rule set before the action is
- applied to a frame. Operands are expressed as discrete alphanumeric strings entered in upper, lower or mixed character
- case. Failure to enter a known operand will result in an error message that lists permitted operands. They are positon
- sensitive. One operand is allowed and it must appear after the action and before any condition.
-
- Any Apply the action to frames that satisfy any of the conditions. This is equivalent to the logical or operation.
-
- All Apply the action to frames that satisfy all of the conditions. This is equivalent to the logical and operation.
-
- Always Apply the action to all frames. All conditions are ignored.
-
-CONDITIONS
- A condition consists of a field, an operator and a value. One condition is required but three are permitted. Condition
- order is not important but all conditions must appear after the operand and before the control.
-
- field The field is the part of the Ethernet frame to be examined. Some fields are not valid for some actions but this
- program does not enforce such rules since validation is performed by runtime firmware on each device. Recognized
- fields are listed and described under FIELDS.
-
- operator
- The operator specifies the relationsip that must exist between the field and value in order for the condition to
- evaluate True. Currently, only equality operators are supported. Valid operators are listed and described under
- OPERATORS.
-
- value The value must be appropriate to the field type. Some fields are MAC or IP addresses, some are integers, some are
- bitmaps and others are states. Integers and bitmaps may be expressed in binary, decimal or hexadecimal format.
- Binary values staRt with 0b. Hexadecimal values start with 0x. States are expressed using keywords. Users are
- responsible for knowing how many bits are significant for each type of value. Valid values are described along
- with fields under FIELDS.
-
-FIELDS
- Fields indicate the portion of the frame that is inspected during selection and the size and format of the value permited
- in the condition statement. They are expressed as discrete alphanumeric strings entered in upper, lower or mixed charac‐
- ter case. Failure to enter a known field will result in an error message that lists permitted fields.
-
- ET A 16-bit Ethertype expressed in hexadecimal with optional "0x" prefix. The format is described in IEEE Standard
- 802-2001 [4].
-
- EthDA A 48-bit Ethernet destination address expressed in hexadecimal. Octets may be separated with optional colons for
- clarity. The format is described in IEEE Standard 802-2001 [4].
-
- EthSA A 48-bit Ethernet source address expressed in hexadecimal. Octets may be separated with optional colons for clar‐
- ity. The format is described in IEEE Standard 802-2001 [4].
-
- IPSP A 16-bit IP source port expressed as a decimal integer. This condition applies to either TCP or UDP packets,
- depending on the protocol used, and is valid only for actions "CAP0", "CAP1", "CAP2", "CAP3" and "Drop".
-
- IPDP A 16-bit IP destination port expressed as a decimal integer. This condition applies to either TCP or UDP packets,
- depending on the protocol used, and is valid only for actions "CAP0", "CAP1", "CAP2", "CAP3" and "Drop".
-
- IPV4TOS
- An 8-bit Type-of-Service code where the format is defined in the RFC 791 (Internet Protocol) [14].
-
- IPV4PROT
- An 8-bit Ethernet protocol code. The format is defined in the RFC 791 (Internet Protocol) [14].
-
- IPV4SA A 32-bit Internet Protocol source address expressed in dotted-decimal notation. The official format is defined in
- RFC 791 (Internet Protocol) [14]. Our implementation permits empty octets and leading zeros within fields. For
- example, "..." is equivalent to "0.0.0.0 and "127..000.001" is equivalent to "127.0.0.1".
-
- IPV4DA A 32-bit Internet Protocol destination address expressed in dotted-decimal notation. The official format is
- defined in RFC 791 (internet Protocol) [14]. Our implementation permits empty octets and leading zeros within
- fields. For example, "..." is equivalent to "0.0.0.0 and "127..000.001" is equivalent to "127.0.0.1".
-
- IPV6TC An 8-bit Internet Protocol V6 traffic class expressed as defined in RFC 2460 (Internet Protocol Version 6) [17].
-
- IPV6FL A 24-bit IPV6 flow label where the lower 20 bits are the IPv6 Flow Label defined in RFC 2460 (Internat Protocol
- Version 6) [17]. The upper 4 bits should be zero. The value can be entered either as a decimal, binary or hex
- integer.
-
- IPV6SA A 128-bit IPV6 source address expressed as colon-separated hexadecmial quartets (octet pairs). The official for‐
- mat is defined in RFC 2460 (Internet Protocol Version 6) [17]. Our implementation permits multiple empty fields,
- abreviated fields and leading zeros within fields. When multiple empty fields appear, the right-most occurance
- expands to multiple zeros. For example, "AAAA::BBBB::CCCC" is equivalent to
- "AAAA:0000:BBBB:0000:0000:0000:0000:CCCC".
-
- IPV6DA A 128-bit IPV6 destination address expressed as colon-separated hexadecimal quartets (octet pairs). The official
- format is defined in RFC 2460 (Internet Protocol Version 6) [17]. Our implementation permits multiple empty
- fields, abbreviated fields and leading zeros within fields. When multiple empty fields appear, the right-most
- occurance expands to zeros. For example, ":1::2" is equivalent to "0000:0001:0000:0000:0000:0000:0000:0002".
-
- MME A 24-bit Atheros HomePlugAV Management Message type expressed as a hex byte stream. For clarity, the recommeded
- format it "xx:xxxx". The first byte is the MMV. The next two bytes are the MMTYPE. Both are defined in the
- HomePlug AV Specification. The MMTYPE will match all MME variants, such as Request, Confirm, Indicate and
- Response because the lower two bits are ignored. This field is only valid for action "Boost".
-
- TCPAck The string "True" or "False" to indicate that the frame is (or is not) a TCP Acknowledgement. Double negatives
- are allowed so "Is True" is equvalent to "Not False" and "Is False" is equivalent to "Not True".
-
- TCPSP A 16-bit TCP source port as a decimal integer. The format is defined in RFC 793 (Transmission Control Protocol
- [15]).
-
- TCPDP A 16-bit TCP destination port expressed as a decimal integer. The format is defined in RFC 793 (Transmission Con‐
- trol Protocol [15]).
-
- UDPSP A 16-bit UDP source port expressed as a decimal integer. The format is defined in RFC 768 (User Datagram Protocol
- [13]).
-
- UDPDP A 16-bit UDP destination port expressed as a decimal integer. The format is defined in RFC 768 (User Datagram
- Protocol [13]).
-
- VLANID A 16-bit VLAN identifier where the lower 12 bits are the VLAN Identifier (VID) defined in IEEE Std 802.1Q-1998
- (Virtual Bridged Local Area Networks) [11]. The upper 4 bits should be zero.
-
- VLANUP An 8-bit Ethernet VLAN tag where the lower 3 bits are the User Priority sub-field of a VLAN Tag defined in IEEE
- Std 802.1Q-1998 (Virtual Bridged Local Area Networks) [11]. The upper 5 bits should be zero.
-
- VLANTag
- The string "Present" or "Missing" to indicate the presence (or absence) of one or more VLAN Tags within a frame.
- This classifier is essentially equivalent to "ET Is 0x8100". Double negatives are allowed so "Is Present" is
- equivalent to "Not Missing" and "Is Missing" is equivalent to "Not Present".
-
-OPERATORS
- An operator indicates an equality between a field and a value. An operator is an alphanumeric string entered in upper,
- lower or mixed character case. Failure to enter a known operator will result in an error message that lists permitted
- operators. Operators are position sensitive and must appear between each field and value.
-
- Is Indicates that the frame field must equal the associated value for the condition to evaluate true.
-
- Not Indicates that the frame field must not equal the associated value for the condition to evaluate true.
-
-STATES
- A state is a special case of value.
-
- True,On,Yes,Present
- Indicates a positive state or presence of some entity. All are equivalent and can be used interchangeably. Dou‐
- ble negatives are permitted so "Is True" is equvalent to "Not False".
-
- False,Off,No,Missing
- Indicates a negative state or absence of some entity. All are equivalent and can be used interchangeably. Double
- negatives are permitted so "Is False" is equvalent to "Not True".
-
-CONTROLS
- The control determines how the devices will handle the rule after it is validated. It is expressed as a discrete
- alphanumeric string entered in upper, lower or mixed character case. Failure to enter a known control will result in an
- error message that lists permitted controls. The control is position sensitive and must occur after condition and before
- volatility.
-
- Add Adds the rule to the current list of rules unless a violation occurs. In some cases, a rule may replace an exist‐
- ing rule instead of being added.
-
- Rem,Remove
- Remove the rule from the current list of rules unless a violation occurs.
-
-VOLATILITY
- The volatility determines which device rule set will be affected by the action. It is expressed as a discrete alphanu‐
- meric string entered in upper, lower or mixed character case. Failure to enter a known volatility will result in an
- error message that lists permitted volatilities. The volatility is position sensitive and must occur after control.
-
- Temp The temporary rule set will be modified. The temporary rule set resides in the working PIB stored in SDRAM.
-
- Perm The permanent rule set will be modified. The permanent rule set resides in the user PIB stored in NVRAM.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information is not available. Qualcomm Atheros reserves the right to modify message structure
- or content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- This command adds a temporary classification rule to the classification table on device B00:B0:52:BA:BE:01. The rule
- instructs the device to drop frames that match either (any) of two conditions. The first condition states that the IPv4
- source address is 192.168.99.2. The second conditon states that the IPv4 destination address is 192.168.99.100.
-
- # plcrule drop any IPv4SA is 192.168.99.2 IPv4DA is 192.168.99.100 add temp 00:B0:52:BA:BE:01
-
- Observe that the action, operand and conditions come first then the control and volatility then the affected devices. Up
- to three conditions may be specified. Keyword order is important. Character case is not important.
-
- The following example prints a list of programmed keywords on stdout for reference. The example shown here has been
- abbreviate due to formatting limitations.
-
- # plcrule -t
-
- Controls are 'Add'|'Rem'|'Remove'
- Volatilities are 'Temp'|'Perm'
- Actions are 'CAP0'|'CAP1'|'CAP2'|'CAP3'|'Boost'|...|'StripTX'|'StripRX'|'TagRX'
- Operands are 'All'|'Any'|'Always'
- Fields are 'EthDA'|'EthSA'|'VLANUP'|'VLANID'|'IPv4TOS'|...|'TCPAck'|'VLANTag'
- Operators are 'Is'|'Not'
-
- More example follow:
-
- Ethernet Address Rules
-
- Ethernet address rules have the following general format:
-
- | CAP0 | ANY | EthSA | IS | xx:xx:xx:xx:xx:xx | ADD | TEMP | xx:xx:xx:xx:xx:xx
- | CAP1 | ALL | EthDA | NOT | | REMOVE | PERM |
- | CAP2 |
- | CAP3 |
- | DROP |
-
- For example, instruct device 00:B0:52:BA:BE:FF to temporarily add a rule to forward frames from 00:2B:FE:CA:FE:BA at
- CAP3. Observe Ethernet hardware addresses are used both in the condition and for the affected powerline devices.
-
- # plcrule cap3 any ethsa is 00:2b:fe:ca:fe:ba add temp 00:b0;52:ba:be:ff
-
- IP Address Rules
-
- IP address rules have the following general format:
-
- | CAP0 | ANY | IPv4SA | IS | ddd.ddd.ddd.ddd | ADD | TEMP | xx:xx:xx:xx:xx:xx
- | CAP1 | ALL | IPv4DA | NOT | | REMOVE | PERM |
- | CAP2 |
- | CAP3 |
- | DROP |
-
- For example, instruct device 00:B0:52:BA:BE:FF to permanently remove the rule that drops packets from 192.168.99.1.
- Notice that the IP address is specified in dotted decimal format but the device address is specified in hexadecimal octet
- format. Dotted decimal format permits empty and variable length octets but octet delimiters are mandatory. Hexadecimal
- octet format requires fixed length octets but octet delimiters are optional.
-
- # plcrule drop any ipv4sa is 192.168.99.1 remove perm 00:b0:52:ba:be:ff
-
- IP Protocol Rules
-
- IP protocol rules have the following general format:
-
- | CAP0 | ANY | IPv4PROT | IS | xxxx | ADD | TEMP | xx:xx:xx:xx:xx:xx
- | CAP1 | ALL | | NOT | | REMOVE | PERM |
- | CAP2 |
- | CAP3 |
- | DROP |
-
- For example, to instruct device 00:B0:52:BA:BE:FF to permanently add a rule to forward non-IP packets at CAP2. In this
- example, delmiters have been omitted from the device Ethernet address.
-
- # plcrule CAP2 all ipv4prot not 0x0800 add perm 00b052babeff
-
-SEE ALSO
- plc(1), plcrate(1), plcstat(1), plctone(7)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plcrule(1)
-
-plcset(1) Qualcomm Atheros Open Powerline Toolkit plcset(1)
-
-NAME
- plcset - Qualcomm Atheros PLC Set Property
-
-SYNOPSIS
- plcset [options] [type data] [type data] [device] [device] [...]
-
-DESCRIPTION
- Set a specific property value on an Qualcomm Atheros powerline device using the VS_SET_PROPERTY message. Properties are
- specified using their numeric property identifier. Property names are not supported. Property values are entered using
- type and data pairs. Users familiar with program setpib should already understand this method of entering data values.
-
- Only selected properties can be set using this message type. See the Qualcomm Atheros Firmware Technical Reference Man‐
- ual for supported property identifiers, versions, values and data formats.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit.
-
-OPTIONS
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -n number
- The property identifier or peoperty version. Property identifiers and versions are entered as 32-bit decimal
- integers. Property names are not supported. The default is 0. This option may appear more than once on the com‐
- mand line. The first occurance specifies the property identifier. The second occurances specifies the property
- version. See the Firmware Technical Reference Manual for an list of valid property identifiers and versions.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this interface and only reponses received via this
- interface are recognized. The default interface is eth1 because most people use eth0 as their principle network
- connection; however, if environment string "PLC" is defined then it takes precedence over the default interface.
- This option then takes precedence over either default.
-
- -o option
- The update option (or method) expressed as an 8-bit hexadecimal integer. The prefix "0x" is optional. Option
- values are constructed from the logical OR of 0x01=ApplyNow, 0x02=Persist and 0x04=Reset. The only legal option
- values are 0x01, 0x02, 0x03 and 0x06.
-
- -q Suppresses status messages on stderr.
-
- -v Prints additional information on stdout. In particular, this option dumps outgoing Ethernet packets on stdout.
-
- -?,--help
- Displays program help information on stderr. This option takes precedence over all other options on the command
- line except version information.
-
- -!,--version
- Displays program version information on stderr. This option takes precedence over all other options on the com‐
- mand line except help information. Use this option when sending screen dumps to Atheros technical staff.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-FORMATS
- Each property is assigned one or more values. Each value may have a different type and size. The expected type, size
- and order of property values is described in the Firmware Technical Reference Manual under the VS_SET_PROPERTY message
- description. Expected data types and values must be entered on the command line in the order specified in the manual and
- must appear on the command line before any device addresses appear.
-
- byte integer
- An unsigned integer stored as 8 bits or 1 byte. The value is expressed in decimal by default. A binary value may
- be expressed with a 0b prefix. A hexadecimal value may be expressed using a 0x prefix. The offset increments by
- 1 prior to the next insertion.
-
- word integer
- An unsigned integer stored as 16 bits or 2 bytes. The value is expressed in decimal by default. A binary value
- may be expressed with a 0b prefix. A hexadecimal value may be expressed using a 0x prefix. The result will be
- sent in little endian byte order. The offset increments by 2 prior to the next insertion.
-
- long integer
- An unsigned integer stored as 32 bits or 4 bytes. The value is expressed in decimal by default. A binary value
- may be expressed with a 0b prefix. A hexadecimal value may be expressed using a 0x prefix. The result will be
- sent in little endian byte order. The offset increments by 4 prior to the next insertions.
-
- huge integer
- An unsigned integer stored as 64 bits or 8 bytes. The value is expressed in decimal by default. A binary value
- may be expressed with a 0b prefix. A hexadecimal value may be expressed using a 0x prefix. The offset increments
- by 8 prior to the next insertion. The result will be sent in little endian byte order. This type is only avail‐
- able on hosts that support 64 bit data values.
-
- data hex
- A sequence of hexadecimal octets. Octets may be separated by a colon for clarity. The number of octets deter‐
- mines the number of bytes written. The result is sent in the byte order specified on the command line. The off‐
- set increments by the number of bytes written. This is similar to "key" and "mac" below but accepts variable
- length input.
-
- key hex
- A sequence of hexadecimal octets. Octets may be separated by a colon for clarity. The number of octets must con‐
- vert to 16 bytes or an error will occur. The result is sent in the byte order specified on the command line. The
- offset increments by 16 prior to the next insertion. This is similar "data" above but accepts ony fixed length
- input. This option may be used to set the DAK, NMK or NVAK values.
-
- mac hex
- A sequence of hexadecimal octets. Octets may be separated by a colon for clarity. The number of octets must con‐
- vert to 6 bytes or an error will occur. The result is sent in the byte order specified on the command line. The
- offset increments by 6 prior to the next insertion. This is similar "data" above but accepts only fixed length
- input. This option may be used to set the DAK, NMK or NVAK values.
-
- hfid string
- An ASCII character string. The string is always stored as 64 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 64 prior to the next insertion. This option may be used to enter user, network and manufacturer identi‐
- fication strings.
-
- zero count
- An unsigned integer representing the number of consecutive bytes to fill with 0x00. The offset increments by the
- number of bytes written. This option may be used to erase regions of the PIB.
-
- fill count
- An unsigned integer representing the number of consecutive bytes to fill with 0xFF. The offset increments by the
- number of bytes written. This option may be used to erase regions of the PIB.
-
- skip count
- An unsigned integer indicating the number of bytes to skip over before staring another change. Intervening data
- data locations are unchanged.
-
-TR69 DATA TYPES
- These data types are not currently recognized by the runtime firmware and so errors will certainly result if they are
- used.
-
- accesspassword string
- An ASCII character string. The string is always stored as 257 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 257 prior to the next insertion.
-
- accessusername string
- An ASCII character string. The string is always stored as 33 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 33 prior to the next insertion.
-
- adminpassword string
- An ASCII character string. The string is always stored as 33 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 33 prior to the next insertion.
-
- adminusername string
- An ASCII character string. The string is always stored as 33 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 33 prior to the next insertion.
-
- password string
- An ASCII character string. The string is always stored as 257 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 257 prior to the next insertion.
-
- url string
- An ASCII character string. The string is always stored as 257 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 257 prior to the next insertion.
-
- username string
- An ASCII character string. The string is always stored as 257 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 257 prior to the next insertion.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for the latest information on available proper‐
- ties.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure and content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- The following example sets the "time-to-live" property for each channel access priority type: CAP0, CAP1, CAP2, CAP3 and
- MME. The property identifier is 101. It needs five 32-bit decimal integer values in microseconds. Data type long spec‐
- ifies a 32-bit decimal value that will be converted to little endian format on output.
-
- # plcset -n 101 long 100 long 200 long 250 long 300 long 100
-
- The next example set the User HFID. The first occurance of option -n specifies the property by number as 105. The sec‐
- ond occurance specifies the property version as 1. This is merely an example of how to specify the propery version. At
- the time of writing, property 105 is still version 0.
-
- # plcset -n 105 -n 1 hfid "Intergalactic Software Pirates"
-
-SEE ALSO
- plc(1), getpib(1), modpib(1), plcset(1), setpib(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plcset(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- *
- * plcset.c -
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <unistd.h>
-#include <stdlib.h>
-#include <stdint.h>
-#include <limits.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#include "../tools/getoptv.h"
-#include "../tools/putoptv.h"
-#include "../tools/memory.h"
-#include "../tools/number.h"
-#include "../tools/symbol.h"
-#include "../tools/types.h"
-#include "../tools/flags.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-#include "../ether/channel.h"
-
-/*====================================================================*
- * custom source files;
- *--------------------------------------------------------------------*/
-
-#ifndef MAKEFILE
-#include "../plc/Devices.c"
-#include "../plc/Confirm.c"
-#include "../plc/Display.c"
-#include "../plc/Failure.c"
-#include "../plc/Request.c"
-#include "../plc/ReadMME.c"
-#include "../plc/SendMME.c"
-#include "../plc/SetProperty.c"
-#endif
-
-#ifndef MAKEFILE
-#include "../tools/synonym.c"
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-#include "../tools/uintspec.c"
-#include "../tools/basespec.c"
-#include "../tools/dataspec.c"
-#include "../tools/bytespec.c"
-#include "../tools/hexdump.c"
-#include "../tools/hexencode.c"
-#include "../tools/hexdecode.c"
-#include "../tools/todigit.c"
-#include "../tools/binout.c"
-#include "../tools/error.c"
-#include "../tools/memencode.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/MMECode.c"
-#include "../mme/EthernetHeader.c"
-#include "../mme/QualcommHeader.c"
-#include "../mme/UnwantedMessage.c"
-#endif
-
-/*====================================================================*
- * program constants;
- *--------------------------------------------------------------------*/
-
-#define PLCSET_PROP_VERSION 0
-#define PLCSET_PROP_OPTION 1
-
-/*====================================================================*
- *
- * int main (int argc, char const * argv[]);
- *
- * parse command line, populate plc structure and perform selected
- * operations; show help summary if asked; see getoptv and putoptv
- * to understand command line parsing and help summary display; see
- * plc.h for the definition of struct plc;
- *
- * the command line accepts multiple MAC addresses and the program
- * performs the specified operations on each address, in turn; the
- * address order is significant but the option order is not; the
- * default address is a local broadcast that causes all devices on
- * the local H1 interface to respond but not those at the remote
- * end of the powerline;
- *
- * the default address is 00:B0:52:00:00:01; omitting the address
- * will automatically address the local device; some options will
- * cancel themselves if this makes no sense;
- *
- * the default interface is eth1 because most people use eth0 as
- * their principle network connection; you can specify another
- * interface with -i or define environment string PLC to make
- * that the default interface and save typing;
- *
- *
- *--------------------------------------------------------------------*/
-
-int main (int argc, char const * argv [])
-
-{
- extern struct channel channel;
- static char const * optv [] =
- {
- "ei:n:o:qs:t:v",
- "[type data] [type data] [...] [device] [device] [...]\n\n\ttype :== 'byte'|'word'|'long'|'huge'|'text'|'data'|'zero'|'fill'|'skip'|'hfid'|'mac'|'key'",
- "Qualcomm Atheros PLC Set Property",
- "e\tredirect stderr to stdout",
-
-#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 n\tproperty identifier or version is (n) [" LITERAL (PLCSET_PROP_VERSION) "]",
- "o n\tproperty option is (n) [" LITERAL (PLCSET_PROP_OPTION) "]",
- "q\tquiet mode",
- "s x\tsession identifier is (x) [" LITERAL (PLCSESSION) "]",
- "t n\tread timeout is (n) milliseconds [" LITERAL (CHANNEL_TIMEOUT) "]",
- "v\tverbose mode",
- (char const *) (0)
- };
-
-#include "../plc/plc.c"
-
- struct plcproperty plcproperty;
- signed c;
- if (getenv (PLCDEVICE))
- {
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (getenv (PLCDEVICE));
-
-#else
-
- channel.ifname = strdup (getenv (PLCDEVICE));
-
-#endif
-
- }
- optind = 1;
- memset (&plcproperty, 0, sizeof (plcproperty));
- plcproperty.PROP_OPTION = PLCSET_PROP_OPTION;
- plcproperty.PROP_VERSION = PLCSET_PROP_VERSION;
- while ((c = getoptv (argc, argv, optv)) != -1)
- {
- switch (c)
- {
- case 'e':
- dup2 (STDOUT_FILENO, STDERR_FILENO);
- break;
- case 'i':
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (optarg);
-
-#else
-
- channel.ifname = optarg;
-
-#endif
-
- break;
- case 'n':
- if (!plcproperty.PROP_NUMBER)
- {
- plcproperty.PROP_NUMBER = (uint32_t)(uintspec (optarg, 0, UINT_MAX));
- }
- else
- {
- plcproperty.PROP_VERSION = (uint32_t)(uintspec (optarg, 0, UINT_MAX));
- }
- break;
- case 'o':
- plcproperty.PROP_OPTION = (uint8_t)(basespec (optarg, 16, sizeof (plcproperty.PROP_OPTION)));
- break;
- case 'q':
- _setbits (channel.flags, CHANNEL_SILENCE);
- _setbits (plc.flags, PLC_SILENCE);
- break;
- case 's':
- plc.cookie = (uint32_t)(basespec (optarg, 16, sizeof (plc.cookie)));
- 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;
- default:
- break;
- }
- }
- argc -= optind;
- argv += optind;
- while ((argc > 1) && (* argv))
- {
- plcproperty.DATA_LENGTH += (uint32_t)(memencode (plcproperty.DATA_BUFFER + plcproperty.DATA_LENGTH, sizeof (plcproperty.DATA_BUFFER) - plcproperty.DATA_LENGTH, argv [0], argv [1]));
- argc -= 2;
- argv += 2;
- }
- openchannel (&channel);
- if (!(plc.message = malloc (sizeof (* plc.message))))
- {
- error (1, errno, PLC_NOMEMORY);
- }
- if (!argc)
- {
- SetProperty (&plc, &plcproperty);
- }
- while ((argc) && (* argv))
- {
- if (!hexencode (channel.peer, sizeof (channel.peer), synonym (* argv, devices, SIZEOF (devices))))
- {
- error (1, errno, PLC_BAD_MAC, * argv);
- }
- SetProperty (&plc, &plcproperty);
- argc--;
- argv++;
- }
- free (plc.message);
- closechannel (&channel);
- exit (0);
-}
-
-
-
-plcstat(1) Qualcomm Atheros Open Powerline Toolkit plcstat(1)
-
-NAME
- plcstat - Qualcomm Atheros AR7x00 Link Statistics
-
-SYNOPSIS
- plcstat [options] [device] [device] [...]
-
-DESCRIPTION
- The Atheros Device Statistics Utility polls a device and prints network and link statistics in various formats suitable
- for use by other programs. This is a work in progress so user feedback is encouraged. Link statistics are only valid
- between one powerline device and another.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-COMMENTS
- This program is identical to legacy program int6kstat but uses version 1 of the Qualcomm Atheros VS_NW_INFO Atheros ven‐
- dor-specific message. Older firmware versions may not recognize this message version.
-
-OPTIONS
- -C Clear device link statistics using VS_LNK_STATS. Statistics are read and cleared then displayed. The statistics
- that are read and displayed depend on options -d, -p and -s but all link statistics are cleared.
-
- -d direction
- Return statistics for the specified direction using VS_LNK_STATS. Direction can be 0=tx, 1=rx, 2=both or "rx",
- "tx" or "both".
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -l count
- Define the number of times that the command will be repeated for each device specified. Normally, you will repeat
- operations on one device only.
-
- -m Displays network membership information, as seen by one device, using VS_NW_INFO. Use option -t for complete net‐
- work topology seen by the local host.
-
- -p peernode
- Ethernet hardware address of the peer node for VS_LNK_STATS. This option is required for all Link ID values
- except 0xFC. The default is 00:00:00:00:00:00.
-
- -q Enter quiet mode. Progress messages are suppressed.
-
- -s linkid
- The Link ID for VS_LNK_STATS. Link ID values range from 0 through 255 but not all values are accepted by the
- device firmware. Values may be expressed in decimal, binary prefixed with "0b" or hexadecimal prefixed by "0x".
- Many valid values can be expressed by name. Valid values are listed and explained under LINKID. The default Link
- ID is 0xFC.
-
- -t Display network topology using VS_SW_VER and VS_NW_INFO messages. This option is similar to option -m but pro‐
- vides complete network topology plus device hardware and firmware version. Topology is always relative to the
- local host, or local hosts if present. Powerline devices that appear on the command line are not used for this
- operation.
-
- -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
-
- -w seconds
- Defines the number of seconds to wait before repeating command line options. This option has no effect unless
- option -l is also specified with a non-zero value.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The MAC address of some powerline device. More than one address may be specified. If more than one address is
- specified then operations are performed on each device in turn. The default address is local. See DEVICES for
- information about symbolic device addresses.
-
-LINKID
- 0x00,CSMA-CAP0
- Display CSMA statistics for CAP0 traffic using a single peer node. The peer node MAC address must be specified
- using option -p.
-
- 0x01,CSMA-CAP1
- Display CSMA statistics for CAP1 traffic using a single peer node. The peer node MAC address must be specified
- using option -p.
-
- 0x02,CSMA-CAP2
- Display CSMA statistics for CAP2 traffic using a single peer node. The peer node MAC address must be specified
- using option -p.
-
- 0x03,CSMA-CAP3
- Display CSMA statistics for CAP3 traffic using a single peer node. The peer node MAC address must be specified
- using option -p.
-
- 0xF8,CSMA-PEER
- Display CSMA statistics for all traffic using a single peer node. The peer node MAC address must be specified
- using option -p.
-
- 0xFC,CSMA-ALL
- Display CSMA statistics for all traffic with all peer nodes. A peer node MAC address is not needed and will be
- ignored if provided. This value is the default for option -s.
-
-DEVICES
- Powerline devices use Ethernet Media Access Control (MAC) addresses. A MAC address is a 48-bit value entered as 12 hexa‐
- decimal digits in upper, lower or mixed character case. Octets may be separated with colons for clarity. For example,
- "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are valid and equivalent.
-
- The following MAC addresses are special and may be entered by name instead of number.
-
- all Same as "broadcast".
-
- broadcast
- A synonym for the Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or foreign
- recognize messages sent to this address. A remote device is any device at the far end of a powerline connection.
- A foreign device is any device not manufactured by Atheros.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices recognize this address but remote and foreign devices do not. A remote device is any device at
- the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-EXAMPLES
- None.
-
-SEE ALSO
- plc(1), plcrate(1), plcstat(1), plctool(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plcstat(1)
-
-plctest(1) Qualcomm Atheros Open Powerline Toolkit plctest(1)
-
-NAME
- plctest - Qualcomm Atheros PLC Test Applet Loader
-
-SYNOPSIS
- plctest [options] [file] [file] [...]
-
-DESCRIPTION
- Download and execute one or more test applets to the local Qualcomm Atheros powerline device. An applet is a small
- firmware image that can be started by the bootloader and will return to the bootloader when done. This program replaces
- int6ktest and amptest because is supports both old and new image file formats and the old and new powerline device boot
- methods.
-
- Qualcomm Atheros firmware files may contain one or more applets. Each applet is preceded by a header that specifies the
- image size, load address and start address and other information. Program plctest sequentially dowloads and executes
- every applet in each image file named on the command line. It waits for each applet to complete before downloading and
- executing the next one. The program terminates once all applets in all files have been executed or some applet fails to
- complete within 60 seconds.
-
- Most applets return to the Bootloader on successful completion so that another applet can be downloaded and executed.
- This allows applet sequences to be executed with one command. A sequence may consist of one file having multiple applets
- or multiple files each having one applet or any combination of single and multiple applet files. The sequence will
- break, after a timeout, if any applet in the chain fails to return to the Bootloader in time. Failure to return in time
- may be either a good thing or a bad thing depending on applet design.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the APT man page for an overview and installation
- instructions.
-
-COMMENTS
- The Powerline Toolkit contains a set of legacy applets in folder applets. These were originally designed for use with
- program int6ktest and most will not display console messages properly using this program; however, a new series of com‐
- patible applets are under development and should be available through Qualcomm Atheros Field Application Engineering.
-
- Assuming a good set of applets are available, this program is ideal for testing reference designs for performance and
- production units for defects. Applets may become available for testing onboard connections, memory integrity and noise
- immunity. Consult with Atheros Field Application Engineering for applet availability.
-
-OPTIONS
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -l Execute all applets in all files on the command line until the program is terminated using ^C.
-
- -p frequency
- The polling frequency expressed in polls-per-second. For example, 1 means one poll per second and 10 means ten
- polls per second. Overall wait time is count/frequency where count may be modified using option -c. Overall wait
- time is always approximate since operating system overhead and latency are not taken into account. The default
- frequency is 5.
-
- -q Suppresses normal progress and status messages.
-
- -t timeout
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -v Print additional information on stdout. Specifically, this option prints incoming and outgoing frames in hexadec‐
- imal format on stdout. Output can be directed to a text file for analysis.
-
- -w seconds
- Application timeout in seconds. This application will wait this long for an applet to terminate and return to the
- bootloader before reporting an error and proceeding to the next applet.
-
- -x Exit program on first error instead of proceeding to the next applet. Error exits return a non-zero value to the
- shell.
-
- -X Exit program on first applet load instead of waiting for the applet to complete. This exit returns a zero value
- to the shell.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of an Atheros image file. The image file may contain one or more images. Each image will be downloaded
- and executed in turn until all images are executed or an image fails to return to the Bootloader within 1 minute
- for some reason.
-
-EXAMPLES
- The following example sequentially downloads then executes each image in file abc.nvm in turn. Each image must complete
- and return to the bootloader before the next one downloads. Observe that no device address is needed because Atheros
- powerline devices use address 00:b0:52:00:00:01 when in bootloader mode.
-
- # plctest abc.nvm
-
- The following example will sequentially download and execute the images in each file abc.nvm, def.nvm and ghi.nvm in
- turn.
-
- # plctest abc.nvm def.nvm ghi.nvm
-
-DISCLAIMER
- Atheros image file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public informa‐
- tion is not available. Qualcomm Atheros reserves the right to change file structure or content in future firmware
- releases without any obligation to notify or compensate users of this program. This program is reserved for use by
- Atheros Field Engineers. Use of this program may void some contractual obligations made by Atheros.
-
-SEE ALSO
- APT(1), chknvm(1), chknvm2(1), amptest(1), int6ktest(1), nvmsplit(1), nvmmerge(1), setnvm(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plctest(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- *
- * plctone.c -
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <unistd.h>
-#include <stdlib.h>
-#include <stdint.h>
-#include <limits.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#include "../tools/getoptv.h"
-#include "../tools/putoptv.h"
-#include "../tools/memory.h"
-#include "../tools/symbol.h"
-#include "../tools/number.h"
-#include "../tools/types.h"
-#include "../tools/flags.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-/*====================================================================*
- * custom source files;
- *--------------------------------------------------------------------*/
-
-#ifndef MAKEFILE
-#include "../plc/Devices.c"
-#include "../plc/Failure.c"
-#include "../plc/ReadMME.c"
-#include "../plc/SendMME.c"
-#include "../plc/ToneMaps2.c"
-#include "../plc/SignalToNoise2.c"
-#endif
-
-#ifndef MAKEFILE
-#include "../tools/error.c"
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-#include "../tools/uintspec.c"
-#include "../tools/hexdump.c"
-#include "../tools/hexencode.c"
-#include "../tools/hexdecode.c"
-#include "../tools/hexstring.c"
-#include "../tools/todigit.c"
-#include "../tools/synonym.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/QualcommHeader1.c"
-#include "../mme/UnwantedMessage.c"
-#include "../mme/MMECode.c"
-#endif
-
-/*====================================================================*
- * program variables;
- *--------------------------------------------------------------------*/
-
-static const struct _term_ couple [] =
-
-{
- {
- "alt",
- "1"
- },
- {
- "pri",
- "0"
- }
-};
-
-/*====================================================================*
- *
- * int main (int argc, char const * argv[]);
- *
- * parse command line, populate plc structure and perform selected
- * operations; show help summary if asked; see getoptv and putoptv
- * to understand command line parsing and help summary display; see
- * plc.h for the definition of struct plc;
- *
- * the command line accepts multiple MAC addresses and the program
- * performs the specified operations on each address, in turn; the
- * address order is significant but the option order is not; the
- * default address is a local broadcast that causes all devices on
- * the local H1 interface to respond but not those at the remote
- * end of the powerline;
- *
- * the default address is 00:B0:52:00:00:01; omitting the address
- * will automatically address the local device; some options will
- * cancel themselves if this makes no sense;
- *
- * the default interface is eth1 because most people use eth0 as
- * their principle network connection; you can specify another
- * interface with -i or define environment string PLC to make
- * that the default interface and save typing;
- *
- *
- *--------------------------------------------------------------------*/
-
-int main (int argc, char const * argv [])
-
-{
- extern struct channel channel;
- static char const * optv [] =
- {
- "ehi:p:qsvx",
- "node peer [> stdout]",
- "Qualcomm Atheros Panther/Lynx Tone Map Dump",
- "e\tredirect stderr to stdout",
- "h\tprint mean-square histogram",
-
-#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
-
- "p n\tcoupling [" LITERAL (PLCOUPLING) "]",
- "q\tquiet mode",
- "s\tcompute signal-to-noise and bits-per-carrier ratios",
- "v\tverbose mode",
- "x\texit on error",
- (char const *) (0)
- };
-
-#include "../plc/plc.c"
-
- signed (* function) (struct plc *) = ToneMaps2;
- signed c;
- plc.action = PLCOUPLING;
- if (getenv (PLCDEVICE))
- {
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (getenv (PLCDEVICE));
-
-#else
-
- channel.ifname = strdup (getenv (PLCDEVICE));
-
-#endif
-
- }
- optind = 1;
- while ((c = getoptv (argc, argv, optv)) != -1)
- {
- switch (c)
- {
- case 'p':
- plc.coupling = (unsigned)(uintspec (synonym (optarg, couple, SIZEOF (couple)), 0, UCHAR_MAX));
- break;
- case 'e':
- dup2 (STDOUT_FILENO, STDERR_FILENO);
- break;
- case 'h':
- _setbits (plc.flags, PLC_GRAPH);
- break;
- case 'i':
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (optarg);
-
-#else
-
- channel.ifname = optarg;
-
-#endif
-
- break;
- case 'q':
- _setbits (channel.flags, CHANNEL_SILENCE);
- _setbits (plc.flags, PLC_SILENCE);
- break;
- case 's':
- _setbits (plc.flags, PLC_ANALYSE);
- function = SignalToNoise2;
- break;
- case 'v':
- _setbits (channel.flags, CHANNEL_VERBOSE);
- _setbits (plc.flags, PLC_VERBOSE);
- break;
- case 'x':
- _setbits (plc.flags, PLC_BAILOUT);
- break;
- default:
- break;
- }
- }
- argc -= optind;
- argv += optind;
- if (!argc || !argv)
- {
- error (1, ECANCELED, "No node address given");
- }
- if (!hexencode (channel.peer, sizeof (channel.peer), synonym (* argv, devices, SIZEOF (devices))))
- {
- error (1, errno, PLC_BAD_MAC, * argv);
- }
- argc--;
- argv++;
- if (!argc || !argv)
- {
- error (1, ECANCELED, "No peer address given");
- }
- if (!hexencode (plc.RDA, sizeof (plc.RDA), synonym (* argv, devices, SIZEOF (devices))))
- {
- error (1, errno, PLC_BAD_MAC, * argv);
- }
- argc--;
- argv++;
- openchannel (&channel);
- if (!(plc.message = malloc (sizeof (* plc.message))))
- {
- error (1, errno, PLC_NOMEMORY);
- }
- function (&plc);
- free (plc.message);
- closechannel (&channel);
- return (0);
-}
-
-
-
-plctool(1) Qualcomm Atheros Open Powerline Toolkit plctool(1)
-
-NAME
- plctool - Qualcomm Atheros Panther/Lynx Powerline Device Manager
-
-SYNOPSIS
- plctool [options] [device] [device] [...]
-
-DESCRIPTION
- This version of the Qualcomm Atheros Powerline Device Manager performs basic operations on powerline devices using ven‐
- dor-specific management messages. It can be used to interrogate and control devices or upgrade firmware if on-board
- NVRAM is present. See amptool for a similar utility that supports AR7400 devices. It supports chipsets QCA6410, QCA7000
- and QCA7420.
-
- This program is the proper tool for upgrading panther/lynx devices. It is important to reset panther/lynx devices after
- update since reset after update is not automatic anymore. Also, everything takes longer because part memory is erased
- before being written. Some operations may take 20 to 40 seconds so be patient.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-COMMENTS
- This program version is identical to legacy program int6k except for option -m which uses version 1 of the Qualcomm
- Atheros VS_NW_INFO vendor-specific message. Older firmware versions may not recognize this message version.
-
-OPTIONS
- -a Read device attributes using VS_OP_ATTRIBUTES. Attributes are short strings and integers that describe device
- hardware and firmware. They are concatenated to form the output that is similar to option -r but derived differ‐
- ently.
-
- -B action
- press the simple connect pushbutton using VS_PB_ENC. The action can be specified by number 1, 2, 3 or 4 or by
- symbol "join", "leave", "status" or "reset", respectively. Use 1 on both devices that are expected to join. Use
- 2 only on the device that is expected to leave the network.
-
- -d filename
- Read Watchdog Report from the device and write it to the named file in binary format using VS_WD_RPT. The report
- file can be sent to Qualcomm Atheros for technical analysis. No assumptions are made based on filename and no
- filename convetions are enforced; however, you should use a .log file extension to indicate binary format.
-
- -D xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx
- Define the 16 octet Device Access Key (DAK) in hex format. The DAK is used by option -J. It may also be set to
- "key1" or "key2" as explained in the KEYS section.
-
- -e Redirects stderr messages to stdout. Normally, status and error messages are printed on stderr while primary pro‐
- gram output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -f Read flash memory parameters using VS_GET_NVM. An error will be reported if no flash memory is present.
-
- -F[F] Write previously downloaded MAC and PIB to NVRAM using VS_MOD_NVM. Adding a second F here or another -F anywhere
- on the command line WILL NOT force-flash a blank or corrupted NVRAM as with programs int6k and amptool. Firmware
- loaded from NVRAM will treat force-flash as an error. This option can be used to create factory settings but can‐
- not be used to change them once created. Subsequent use creates and updates operational settings that can be
- erased using a factory reset. This option is executed after all others on the command line, except for the -R
- option.
-
- -g Read multicast group information discovered while IGMP snooping using VS_MULTICAST_INFO.
-
- -i interface
- Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -I Read the device PIB header using VS_MODULE_OPERATION and print the PIB major and minor revision number, Device
- Access Key (DAK), Network Membership Key (NMK), MAC address and other identity information on stdout. The values
- displayed can be changed using program modpib.
-
- -J xx:xx:xx:xx:xx:xx
- Set the Network Membership Key (NMK) on a remote device using VS_SET_KEY. This option is similar to option -K but
- requires the remote device MAC and DAK in addition to the NMK and local device MAC address. The NMK value is
- defined using option -K unless you want to use the default value. The remote DAK is defined using option -D
- unless you want to use the default value. Programming remote device keys is complicated. It is often easier to
- connect the device directly to the host and use the -K option.
-
- -K xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx
- Define the Network Membership Key (NMK) value used by options -M or -J. The symbolic names "key1" and "key2" are
- recognized as described in the KEY section.
-
- -l count
- Define the number of times that the command will be repeated for each device specified. Normally, you will repeat
- operations on one device only.
-
- -L Read and display powerline link status.
-
- -m Read network membership information using VS_NW_INFO. This can be used to determine network configuration.
-
- -M Set the Network Membership Key (NMK) on the local device using VS_SET_KEY. The NMK value is specified using the
- -K option unless you want to use the default value.
-
- -n filename
- Read firmware from the device SDRAM and write it to the named .nvm file using multiple VS_RD_MOD messages. No
- assumptions are made based on filename and no filename conventions are enforced. This option is performed before
- option -N when both are specified.
-
- -N filename
- Read the named .nvm file and write it to the device using multiple VS_WR_MOD messages. No assumptions are made
- based on filename and no filename conventions are enforced; however, files having invalid .nvm format will be
- rejected. This option is executed after -n when both are specified.
-
- -p filename
- Read parameters from the device NVRAM and write them to the named .pib file using multiple VS_RD_MOD messages. No
- assumptions are made based on filename and no filename convetions are enforced. This option is executed before
- option BP when both are specified.
-
- -P filename
- Read the named .pib file and write it to the device using multiple VS_WR_MOD messages. No assumptions are made
- based on filename and no filename conventions are enforced; however, files having invalid .pib format will be
- rejected. This option is executed after -p when both are specified.
-
- -q Suppresses status messages on stderr.
-
- -Q Quick flash. The program will not wait for a device to reset or the firmware to restart after writing flash mem‐
- ory. This option is desirable with newer firmware that writes flash memory in the background. It has no effect
- unless used with option -F or -C.
-
- -r Read device firmware and hardware revision using VS_SW_VER. Output is similar to option -a but is derived differ‐
- ently.
-
- -R Reset the device using VS_RS_DEV. This option is executed after all others on the same command line.
-
- -t milliseconds
- Read timeout in milliseconds. Values range from 0 through UINT_MAX. This is the maximum time allowed for a
- response. The default is shown in brackets on the program menu.
-
- -T Restore factory defaults. This permanently erases all PIB changes made since the device was last programmed with
- factory default settings. The device will automatically reset and reboot.
-
- -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
- be saved as text files for reference.
-
- -w seconds
- Defines the number of seconds to wait before repeating command line options. This option has no effect unless
- option -l is also specified with a non-zero value.
-
- -x Cause the program to exit on the first error instead of continuing with remaining iterations, operations or
- devices. Normally, the program reports errors and moves on to the next operation, iteration or device depending
- on the command line.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The Ethernet hardware address of some powerline device. More than one address may be specified on the command
- line. If more than one address is specified then operations are performed on each device in turn. The default
- address is local. as explained in the DEVICES section.
-
-KEYS
- Passwords are variable length character strings that end-users can remember. Keys are fixed length binary values created
- by encrypting passwords. There are two encryption algorithms for HomePlugAV. One for DAKs and the other for NMKs. This
- means that a given password will produce different keys depending on use. This program only deals with keys because that
- is what powerline devices recognize. The passwords that generated the keys are irrelevant here.
-
- Encryption keys are tedious to type and prone to error. For convenience, symbolic names have been assigned to common
- encryption keys and are recognized by options -D and -K.
-
- key1 Key for encrypted password "HomePlugAV". This is "689F074B8B0275A2710B0B5779AD1630" for option -D and
- "50D3E4933F855B7040784DF815AA8DB7" for option -K.
-
- key2 Key for encrypted password "HomePlugAV0123". This is "F084B4E8F6069FF1300C9BDB812367FF" for option -D and
- "B59319D7E8157BA001B018669CCEE30D" for option -K.
-
- none Always "00000000000000000000000000000000".
-
-DEVICES
- Powerline devices use Ethernet hardware, or Media Access Control (MAC), addresses. Device addresses are 12 hexadecimal
- digits (0123456789ABCDEFabcdef) in upper, lower or mixed case. Individual octets may be separated by colons, for clar‐
- ity, but not all octets need to be seperated. For example, "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are
- valid and equivalent.
-
- These symbolic addresses are recognized by this program and may be used instead of the actual address value.
-
- all Equivalent to "broadcast", described next.
-
- broadcast
- A synonym for the standard Ethernet broadcast address, FF:FF:FF:FF:FF:FF. All devices, whether local, remote or
- foreign will respond to this address.
-
- local A synonym for the Qualcomm Atheros vendor specific Local Management Address (LMA), 00:B0:52:00:00:01. All local
- Atheros devices will recognize this address but remote and foreign devices will not. A remote device is any
- device at the far end of a powerline connection. A foreign device is any device not manufactured by Atheros.
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message structure and content is proprietary to Qualcomm Atheros, Ocala FL
- USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify message
- structure or content in future firmware releases without any obligation to notify or compensate users of this program.
-
-EXAMPLES
- The following command writew file QCA7000.pib and QCA7000.nvm to a remote powerline device then resets it. The reset is
- required because reset after flash is no longer automatic.
-
- # plctool -P QCA7000.pib -N QCA7000.nvm -R 00B05201053E
-
- The previous command does not replace existing PIB values. Instead, it appends the new PIB values to the end of the old
- PIB. To replace existing PIB values, you must write the same PIB again, as follows.
-
- # plctool -P QCA7000.pib -R 00B05201053E
-
- The following commands do the same thing but avoid one unecessary reset.
-
- # plctool -P QCA7000.pib -N QCA7000.nvm 00B05201053E
- # plctool -P QCA7000.pib -R 00B05201053E
-
- The reset can also be postponed as follows.
-
- # plctool -P QCA7000.pib -N QCA7000.nvm 00B05201053E
- # plctool -P QCA7000.pib 00B05201053E
- # plctool -R 00B05201053E
-
- The next two commands are equivalent. They set the NMK on the local device to key1 as descripted in the KEYS section.
- The first command resets the NMK on the local device with -M then specifies the NMK as key1. The second command omits
- the key specification since key1 is the program default NMK. One could, of course, type the encryption key.
-
- # plctool -MK key1
- # plctool -M
-
-SEE ALSO
- plc(1), ampboot(1), ampboot(1), amphost(1), int6kid(1), amprate(1), amprule(1), ampstat(1), ampwait(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plctool(1)
-
-plcwait(1) Qualcomm Atheros Open Powerline Toolkit plcwait(1)
-
-NAME
- ampwait - Qualcomm Atheros Powerline Procrastinator
-
-SYNOPSIS
- ampwait [options] [device] [device] [...]
-
-DESCRIPTION
- Poll a Qualcomm Atheros powerline device, waiting for one or more events to occur before continuing or returning. The
- events include reset or power off, restart or power on and network association. It is used to pause shell scripts at
- critical points where a device must be in a known state before continuing.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the plc man page for an overview and installation
- instructions.
-
-OPTIONS
- -a Poll the device every few seconds using VS_NW_INFO messages until the device indicates that a networks exists and
- has at least one station. This option can give false readings if other devices have dropped off-line and the
- device bridging table still holds information about them. The program always checks for this event last if other
- event options are specified.
-
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired.
-
- -f firmware
- The identification string for firmware that should be running after the device starts. This option can be used to
- detect a failed firmware load. If the actual identification string does not match this one once the device starts
- then an error is reported. If option -x is present then the program terminates with a non-zero exit code. This
- option has no effect unless option -s is present. An identification string looks like
- "INT6000-MAC-3-1-3143-1690-20071107-FINAL-B" and can be obtained using int6k -r.
-
- -i Select the host Ethernet interface. All requests are sent via this host interface and only reponses received via
- this host interface are recognized. The default interface is eth1 because most people use eth0 as their principle
- network connection; however, if environment string "PLC" is defined then it takes precedence over the default
- interface. This option then takes precedence over either default.
-
- -p seconds
- Fixed pause time in seconds. This adds an fixed delay after the other events have occured. A pause does not
- occur if any of the specified events timeout. When no other events are specified this option is effectively
- equivalent to sleep. This option can be used to allow the device or the network to settle. For example, a nomi‐
- nal 5 second wait is recommended after a device successfully associates before attempting to transfer data.
-
- -q Enter quiet mode. Progress messages are suppressed.
-
- -R Reset the device then check return status. Exit program on error if option -x is present; otherwise, repeat the
- reset request until the device either accepts the request or the wait time is exceeded.
-
- -s Poll the device every few seconds using VS_SW_VER messages until the bootloader or runtime firmware responds or
- the poll count exhausts. The presence of a response indicates that the device has either connected to the host,
- received power or finished reboot.
-
- -t milliseconds
- Channel read/write timeout in milliseconds. This is the maximum time allowed for a confirmation or a response
- from a powerline device before abandoning a read/write operation. Permitted values range from 0 through UINT_MAX
- as defined in limits.h. The default is 50 milliseconds.
-
- -v Enter verbose mode. All Etherenet frames sent or received by the program are displayed on stdout.
-
- -w seconds
- Wait timeout in seconds. This is the maximum time that this application will wait for an event to occur where an
- event is reset, start or assoc. If an event does no occur within this time, the program proceeds to wait for the
- next specified event. This timeout applies to each event in turn when more than one event is specified. Permit‐
- ted values are 0 through 86400 seconds which is 24 hours.
-
- -x Exit program on first error with a non-zero exit code. This option allows shell scripts to detect failed or
- incomplete operations and take the appropriate action.
-
- -y Display actual wait times on stdout.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- device The Media Access Control (MAC) address of some device. Addresses are 6 hexadecimal octets optionally separated by
- colon. For example, the addresses "00b052000001", "00:b0:52:00:00:01" and "00b052:000001" are all valid and
- equivalent. For convenience, the symbolic address "local" resolves to "00:b0:52:00:00:01" and the symbolic
- addresses "all" and "broadcast" both resolve to "ff:ff:ff:ff:ff:ff".
-
-REFERENCES
- See the Qualcomm Atheros HomePlug AV Firmware Technical Reference Manual for more information.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-EXAMPLES
- The following command polls the local device until firmware stops running then polls the device until firmware starts
- running again. This command can be inserted into a shell script at a point where the device must reset and reboot before
- proceeding. Observe that the program waits up to 60 seconds for each event, in turn, because 60 seconds is the default
- wait period. If an event occurs before the specified timeout the program will move on to the next event.
-
- # ampwait -rs
- eth0 00:B0:52:BA:BA:01 Allow 60 seconds for Reset
- eth0 00:B0:52:BA:BA:01 Allow 60 seconds for Start
-
- The following example waits up to 30 seconds for the local device to reset (-r) then up to 50 seconds for the local
- device to start (-s). This is the same as above but we have specified 30 seconds using option -w.
-
- # ampwait -r -s -w 30
- eth0 00:B0:52:BA:BA:01 Allow 30 seconds for Reset
- eth0 00:B0:52:BA:BA:01 Allow 30 seconds for Start
-
- The next example reports the actual amount of time taken for each event to occur. Observe that the last event, device
- association, did not occur within the allotted time.
-
- # ampwait -rsay
- eth0 00:B0:52:BA:BA:01 Allow 60 seconds for Reset
- etho 00:B0:52:BA:BA:01 Waited 22 seconds to Reset
- eth0 00:B0:52:BA:BA:01 Allow 60 seconds for Start
- etho 00:B0:52:BA:BA:01 Waited 4 seconds to Start
- eth0 00:B0:52:BA:BA:01 Allow 60 seconds for Assoc
- etho 00:B0:52:BA:BA:01 Waited 60 seconds for Assoc
- etho 00:B0:52:BA:BA:01 Device did not Assoc
-
- The following example illustrates use of the revision string to detect mismatched firmware. In this example, we reset
- the device first, using program amptool, then wait for it to reset then start up again. There are also operation that
- can cause the device to reset.
-
- # amptool -R
- # ampwait -xrsf INT6000-MAC-3-1-3143-1690-20071107-FINAL-B
- eth0 00:B0:52:BA:BA:01 Device started wrong firmware
-
- Immediately after a reset we wait for the firmware to stop responding, with option -r, and then start responding, with
- option -s, and then perform a string comparison against the actual firmware revision string, with option -f. If the
- strings do not match then an error is reported. In this case, the program will exit with a non-zero return code since
- option -x is present.
-
-DISCLAIMER
- Atheros HomePlug AV Vendor Specific Management Message Entry structure and content is proprietary to Qualcomm Atheros,
- Ocala FL USA. Consequently, public information may not be available. Qualcomm Atheros reserves the right to modify mes‐
- sage structure and content in future firmware releases without any obligation to notify or compensate users of this pro‐
- gram.
-
-SEE ALSO
- amp(1), amptool(1), amphost(1), amprate(1), ampid(1), ampstat(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 plcwait(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- *
- * plcwait.c -
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <unistd.h>
-#include <stdlib.h>
-#include <stdint.h>
-#include <limits.h>
-#include <sys/time.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#include "../tools/getoptv.h"
-#include "../tools/putoptv.h"
-#include "../tools/memory.h"
-#include "../tools/number.h"
-#include "../tools/symbol.h"
-#include "../tools/types.h"
-#include "../tools/flags.h"
-#include "../tools/files.h"
-#include "../tools/timer.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-
-/*====================================================================*
- * custom source files;
- *--------------------------------------------------------------------*/
-
-#ifndef MAKEFILE
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-#include "../tools/uintspec.c"
-#include "../tools/hexdump.c"
-#include "../tools/hexencode.c"
-#include "../tools/hexdecode.c"
-#include "../tools/todigit.c"
-#include "../tools/checkfilename.c"
-#include "../tools/synonym.c"
-#include "../tools/error.c"
-#endif
-
-#ifndef MAKEFILE
-#include "../plc/Confirm.c"
-#include "../plc/Display.c"
-#include "../plc/Failure.c"
-#include "../plc/ReadMME.c"
-#include "../plc/Request.c"
-#include "../plc/SendMME.c"
-#include "../plc/Devices.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/MMECode.c"
-#include "../mme/EthernetHeader.c"
-#include "../mme/QualcommHeader.c"
-#include "../mme/QualcommHeader1.c"
-#include "../mme/UnwantedMessage.c"
-#endif
-
-/*====================================================================*
- *
- * signed ResetAndWait (struct plc * plc);
- *
- * plc.h
- *
- * send VS_RS_DEV.REQ messages every channel->timeout milliseconds
- * until the device responds to indicate that it is ready to reset;
- * return 0 if the device eventually responds within plc->timer
- * seconds or -1 if not;
- *
- *--------------------------------------------------------------------*/
-
-signed ResetAndWait (struct plc * plc)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
- struct timeval ts;
- struct timeval tc;
- unsigned timer = 0;
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_rs_dev_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- }
- * request = (struct vs_rs_dev_request *) (message);
- struct __packed vs_rs_dev_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- }
- * confirm = (struct vs_rs_dev_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Reset when Ready");
- if (gettimeofday (&ts, NULL) == -1)
- {
- error (1, errno, CANT_START_TIMER);
- }
- for (timer = 0; timer < plc->timer; timer = SECONDS (ts, tc))
- {
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_RS_DEV | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_RS_DEV | MMTYPE_CNF)) < 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (gettimeofday (&tc, NULL) == -1)
- {
- error (1, errno, CANT_RESET_TIMER);
- }
- if (plc->packetsize)
- {
- if (!confirm->MSTATUS)
- {
- Confirm (plc, "Resetting ...");
- return (0);
- }
- }
- }
- return (-1);
-}
-
-/*====================================================================*
- *
- * signed WaitForReset (struct plc * plc, char string [], size_t length);
- *
- * plc.h
- *
- * send VS_SW_VER.REQ messages every channel->timeout milliseconds
- * until the device stops responding to indicate that it is inactive;
- * return 0 if the device eventually stops responding within
- * plc->timer seconds or -1 if not;
- *
- * this function cannot distinguish between a software reset and
- * hardware reset;
- *
- *--------------------------------------------------------------------*/
-
-signed WaitForReset (struct plc * plc, char string [], size_t length)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
- struct timeval ts;
- struct timeval tc;
- unsigned timer = 0;
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_sw_ver_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MDEVICEID;
- uint8_t MVERLENGTH;
- char MVERSION [PLC_VERSION_STRING];
- }
- * request = (struct vs_sw_ver_request *) (message);
- struct __packed vs_sw_ver_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MDEVICEID;
- uint8_t MVERLENGTH;
- char MVERSION [PLC_VERSION_STRING];
- }
- * confirm = (struct vs_sw_ver_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- memset (string, 0, length);
- Request (plc, "Allow %d seconds for Reset", plc->timer);
- if (gettimeofday (&ts, NULL) == -1)
- {
- error (1, errno, CANT_START_TIMER);
- }
- for (timer = 0; timer < plc->timer; timer = SECONDS (ts, tc))
- {
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SW_VER | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_SW_VER | MMTYPE_CNF)) < 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (gettimeofday (&tc, NULL) == -1)
- {
- error (1, errno, CANT_RESET_TIMER);
- }
- if (!plc->packetsize)
- {
- if (_allset (plc->flags, (PLC_WAITFORRESET | PLC_ANALYSE)))
- {
- Confirm (plc, "Waited %d seconds for Reset", timer);
- }
- memcpy (string, confirm->MVERSION, confirm->MVERLENGTH);
- return (0);
- }
- }
- if (_allset (plc->flags, (PLC_WAITFORRESET | PLC_ANALYSE)))
- {
- Confirm (plc, "Waited %d seconds for Reset", timer);
- }
- return (-1);
-}
-
-/*====================================================================*
- *
- * signed WaitForStart (struct plc * plc, char string [], size_t length);
- *
- * plc.h
- *
- * send VS_SW_VER.REQ messages every channel->timeout milliseconds
- * until the device responds to indicate that it is active; return
- * 0 if the device eventually responds within plc->timer seconds
- * or -1 if not;
- *
- *--------------------------------------------------------------------*/
-
-signed WaitForStart (struct plc * plc, char string [], size_t length)
-
-{
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
- struct timeval ts;
- struct timeval tc;
- unsigned timer = 0;
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_sw_ver_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MDEVICEID;
- uint8_t MVERLENGTH;
- char MVERSION [PLC_VERSION_STRING];
- }
- * request = (struct vs_sw_ver_request *) (message);
- struct __packed vs_sw_ver_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_hdr qualcomm;
- uint8_t MSTATUS;
- uint8_t MDEVICEID;
- uint8_t MVERLENGTH;
- char MVERSION [PLC_VERSION_STRING];
- }
- * confirm = (struct vs_sw_ver_confirm *) (message);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Allow %d seconds for Start", plc->timer);
- if (gettimeofday (&ts, NULL) == -1)
- {
- error (1, errno, CANT_START_TIMER);
- }
- for (timer = 0; timer < plc->timer; timer = SECONDS (ts, tc))
- {
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader (&request->qualcomm, 0, (VS_SW_VER | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 0, (VS_SW_VER | MMTYPE_CNF)) < 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (gettimeofday (&tc, NULL) == -1)
- {
- error (1, errno, CANT_RESET_TIMER);
- }
- if (plc->packetsize)
- {
- if (confirm->MSTATUS)
- {
- Failure (plc, PLC_WONTDOIT);
- return (-1);
- }
- if (_allset (plc->flags, (PLC_WAITFORSTART | PLC_ANALYSE)))
- {
- Confirm (plc, "Waited %d seconds for Start", timer);
- }
- strncpy (string, confirm->MVERSION, length);
- return (0);
- }
- }
- if (_allset (plc->flags, (PLC_WAITFORSTART | PLC_ANALYSE)))
- {
- Confirm (plc, "Waited %d seconds for Start", timer);
- }
- return (-1);
-}
-
-/*====================================================================*
- *
- * signed WaitForAssoc (struct plc * plc);
- *
- * plc.h
- *
- * send VS_NW_INFO.REQ messages every channel->timeout milliseconds
- * until the device reports that a network has formed; return 0 if a
- * network forms within plc->timer seconds or -1 if not;
- *
- *--------------------------------------------------------------------*/
-
-signed WaitForAssoc (struct plc * plc)
-
-{
- extern const uint8_t broadcast [ETHER_ADDR_LEN];
- struct channel * channel = (struct channel *)(plc->channel);
- struct message * message = (struct message *)(plc->message);
- struct timeval ts;
- struct timeval tc;
- unsigned timer = 0;
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
- struct __packed vs_nw_info_request
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_fmi qualcomm;
- }
- * request = (struct vs_nw_info_request *)(message);
- struct __packed vs_nw_info_confirm
- {
- struct ethernet_hdr ethernet;
- struct qualcomm_fmi qualcomm;
- uint8_t SUB_VERSION;
- uint8_t Reserved;
- uint16_t DATA_LEN;
- uint8_t DATA [1];
- }
- * confirm = (struct vs_nw_info_confirm *)(message);
- struct __packed station
- {
- uint8_t MAC [ETHER_ADDR_LEN];
- uint8_t TEI;
- uint8_t Reserved [3];
- uint8_t BDA [ETHER_ADDR_LEN];
- uint16_t AVGTX;
- uint8_t COUPLING;
- uint8_t Reserved3;
- uint16_t AVGRX;
- uint16_t Reserved4;
- }
- * station;
- struct __packed network
- {
- uint8_t NID [7];
- uint8_t Reserved1 [2];
- uint8_t SNID;
- uint8_t TEI;
- uint8_t Reserved2 [4];
- uint8_t ROLE;
- uint8_t CCO_MAC [ETHER_ADDR_LEN];
- uint8_t CCO_TEI;
- uint8_t Reserved3 [3];
- uint8_t NUMSTAS;
- uint8_t Reserved4 [5];
- struct station stations [1];
- }
- * network;
- struct __packed networks
- {
- uint8_t Reserved;
- uint8_t NUMAVLNS;
- struct network networks [1];
- }
- * networks = (struct networks *) (confirm->DATA);
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
- Request (plc, "Allow %d seconds for Assoc", plc->timer);
- if (gettimeofday (&ts, NULL) == -1)
- {
- error (1, errno, CANT_START_TIMER);
- }
- for (timer = 0; timer < plc->timer; timer = SECONDS (ts, tc))
- {
- memset (message, 0, sizeof (* message));
- EthernetHeader (&request->ethernet, channel->peer, channel->host, channel->type);
- QualcommHeader1 (&request->qualcomm, 1, (VS_NW_INFO | MMTYPE_REQ));
- plc->packetsize = (ETHER_MIN_LEN - ETHER_CRC_LEN);
- if (SendMME (plc) <= 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
- return (-1);
- }
- if (ReadMME (plc, 1, (VS_NW_INFO | MMTYPE_CNF)) < 0)
- {
- error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
- return (-1);
- }
- if (gettimeofday (&tc, NULL) == -1)
- {
- error (1, errno, CANT_RESET_TIMER);
- }
- if (plc->packetsize)
- {
- network = (struct network *)(&networks->networks);
- while (networks->NUMAVLNS--)
- {
- station = (struct station *)(&network->stations);
- while (network->NUMSTAS--)
- {
- if (memcmp (station->MAC, broadcast, sizeof (broadcast)))
- {
- if (_allset (plc->flags, (PLC_WAITFORASSOC | PLC_ANALYSE)))
- {
- Confirm (plc, "Waited %d seconds for Assoc", timer);
- }
- return (0);
- }
- station++;
- }
- network = (struct network *)(station);
- }
- }
- }
- if (_allset (plc->flags, (PLC_WAITFORASSOC | PLC_ANALYSE)))
- {
- Confirm (plc, "Waited %d seconds for Assoc", timer);
- }
- return (-1);
-}
-
-#define COMPARE_TYPE_NONE 0
-#define COMPARE_TYPE_EXACT 1
-#define COMPARE_TYPE_CONTAINS 2
-
-/*====================================================================*
- *
- * void function (struct plc * plc, char const * firmware, int compare_type);
- *
- * perform operations in a logical order;
- *
- *
- *--------------------------------------------------------------------*/
-
-static void function (struct plc * plc, char const * firmware, int compare_type)
-
-{
- char string [PLC_VERSION_STRING];
- if (_anyset (plc->flags, PLC_RESET_DEVICE))
- {
- if (ResetAndWait (plc))
- {
- Failure (plc, "Device did not Reset.");
- }
- }
- if (_anyset (plc->flags, PLC_WAITFORRESET))
- {
- if (WaitForReset (plc, string, sizeof (string)))
- {
- Failure (plc, "Device did not Reset.");
- }
- }
- if (_anyset (plc->flags, PLC_WAITFORSTART))
- {
- if (WaitForStart (plc, string, sizeof (string)))
- {
- Failure (plc, "Device did not Start.");
- }
- if ((firmware) && (*firmware))
- {
- switch (compare_type)
- {
- case COMPARE_TYPE_EXACT:
- if (strcmp (firmware, string))
- {
- Failure (plc, "Started wrong firmware");
- }
- break;
- case COMPARE_TYPE_CONTAINS:
- if (strstr (string, firmware) == NULL)
- {
- Failure (plc, "Started wrong firmware");
- }
- break;
- }
- }
- }
- if (_anyset (plc->flags, PLC_WAITFORASSOC))
- {
- if (WaitForAssoc (plc))
- {
- Failure (plc, "Device did not Assoc.");
- }
- }
- if (plc->sleep)
- {
- Request (plc, "Pause %d seconds", plc->sleep);
- sleep (plc->sleep);
- }
- return;
-}
-
-/*====================================================================*
- *
- * int main (int argc, char const * argv[]);
- *
- * parse command line, populate plc structure and perform selected
- * operations; show help summary if asked; see getoptv and putoptv
- * to understand command line parsing and help summary display; see
- * plc.h for the definition of struct plc;
- *
- * the command line accepts multiple MAC addresses and the program
- * performs the specified operations on each address, in turn; the
- * address order is significant but the option order is not; the
- * default address is a local broadcast that causes all devices on
- * the local H1 interface to respond but not those at the remote
- * end of the powerline;
- *
- * the default address is 00:B0:52:00:00:01; omitting the address
- * will automatically address the local device; some options will
- * cancel themselves if this makes no sense;
- *
- * the default interface is eth1 because most people use eth0 as
- * their principle network connection; you can specify another
- * interface with -i or define environment string PLC to make
- * that the default interface and save typing;
- *
- *
- *--------------------------------------------------------------------*/
-
-int main (int argc, char const * argv [])
-
-{
- extern struct channel channel;
- static char const * optv [] =
- {
- "aef:F:i:p:qrRst:vw:xy",
- "device [device] [...] [> stdout]",
- "Qualcomm Atheros Powerline Procrastinator",
- "a\twait for device assoc",
- "e\tredirect stderr to stdout",
- "f s\tconfirm firmware is revision s",
- "F s\tconfirm firmware revision contains substring s",
-
-#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
-
- "p n\tpause (n) seconds",
- "q\tquiet mode",
- "r\twait for device reset",
- "R\treset device and wait",
- "s\twait for device start",
- "t n\tchannel timeout is (n) milliseconds [" LITERAL (CHANNEL_TIMEOUT) "]",
- "v\tverbose mode",
- "w n\twait up to (n) seconds for action [" LITERAL (PLC_TIMER) "]",
- "x\texit on error",
- "y\treport failure times",
- (char const *) (0)
- };
-
-#include "../plc/plc.c"
-
- char const * firmware = "";
- signed c;
- int compare_type = COMPARE_TYPE_NONE;
- if (getenv (PLCDEVICE))
- {
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (getenv (PLCDEVICE));
-
-#else
-
- channel.ifname = strdup (getenv (PLCDEVICE));
-
-#endif
-
- }
- optind = 1;
- while ((c = getoptv (argc, argv, optv)) != -1)
- {
- switch (c)
- {
- case 'a':
- _setbits (plc.flags, PLC_WAITFORASSOC);
- break;
- case 'e':
- dup2 (STDOUT_FILENO, STDERR_FILENO);
- break;
- case 'f':
- firmware = optarg;
- compare_type = COMPARE_TYPE_EXACT;
- break;
- case 'F':
- firmware = optarg;
- compare_type = COMPARE_TYPE_CONTAINS;
- break;
- case 'i':
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (optarg);
-
-#else
-
- channel.ifname = optarg;
-
-#endif
-
- break;
- case 'p':
- plc.sleep = (unsigned)(uintspec (optarg, 0, 3600));
- break;
- case 'q':
- _setbits (channel.flags, CHANNEL_SILENCE);
- _setbits (plc.flags, PLC_SILENCE);
- break;
- case 'r':
- _setbits (plc.flags, PLC_WAITFORRESET);
- break;
- case 'R':
- _setbits (plc.flags, PLC_RESET_DEVICE);
- break;
- case 's':
- _setbits (plc.flags, PLC_WAITFORSTART);
- 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, 0, 86400));
- break;
- case 'x':
- _setbits (plc.flags, PLC_BAILOUT);
- break;
- case 'y':
- _setbits (plc.flags, PLC_ANALYSE);
- break;
- default:
- break;
- }
- }
- argc -= optind;
- argv += optind;
- openchannel (&channel);
- if (!(plc.message = malloc (sizeof (* plc.message))))
- {
- error (1, errno, PLC_NOMEMORY);
- }
- if (!argc)
- {
- function (&plc, firmware, compare_type);
- }
- while ((argc) && (* argv))
- {
- if (!hexencode (channel.peer, sizeof (channel.peer), synonym (* argv, devices, SIZEOF (devices))))
- {
- error (1, errno, PLC_BAD_MAC, * argv);
- }
- function (&plc, firmware, compare_type);
- argv++;
- argc--;
- }
- free (plc.message);
- closechannel (&channel);
- exit (0);
-}
-
-
-
-
-
-
diff --git a/docbook/procedures.xml b/docbook/procedures.xml
deleted file mode 100644
index 4e5914bc..00000000
--- a/docbook/procedures.xml
+++ /dev/null
@@ -1,586 +0,0 @@
-
-
- Procedures
-
-
-
- Introduction
-
-
- The Open Powerline Toolkit can perform all sorts of operations on Atheros powerline devices. Many operations are simple and can be accomplished using one command. Others are more complex and may require several commands. This section demonstrates common console commands that you might want to use when experimenting or working with Atheros powerline devices. Multi-command procedures can be generalized and automated using any programming or scripting language that can execute console commands.
-
-
-
-
- Select an Interface on Linux
-
-
- Linux network interfaces are referenced by name. Use Linux utility ifconfig to determine the names of interfaces on your host. By default, Toolkit programs communicate with powerline devices on interface eth1 but another interface can be specified on the command line with the -i option:
-
-
-
- Selecting another Interface on Linux
-
-
-# int6k -i eth3 ...
-
-
-
- In the previous example, int6k will send and receive frames on interface eth3 instead of the default interface. Having to specify the interface can become become tedious when entering commands manually. An alternative method involves setting environment variable PLC to your preferred Ethernet interfaces, as follows:
-
-
-
- Changing the Default Interface on Linux
-
-
-# export PLC="eth2"
-
-
-
- In the previous example, environment variable PLC is defined and exported, making it available to all programs running under the current console session. This command can be included in ~/.profile or /etc/profile or in /etc/environment on Debian and Ubuntu systems.
-
-
-
- Finding Interfaces on Linux
-
-
-# ifconfig
-eth0 Link encap:Ethernet HWaddr 00:60:97:05:97:0C
- inet addr:192.168.170.179 Bcast:192.168.170.255 Mask:255.255.255.0
- inet6 addr: fe80::260:97ff:fe05:970c/64 Scope:Link
- UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
- RX packets:52130758 errors:0 dropped:0 overruns:0 frame:0
- TX packets:59629414 errors:0 dropped:0 overruns:0 carrier:0
- collisions:0 txqueuelen:1000
- RX bytes:43781526 (41.7 MiB) TX bytes:4226651392 (3.9 GiB)
- Interrupt:209 Base address:0xe000
-
-eth1 Link encap:Ethernet HWaddr 00:0F:EA:10:D5:1C
- inet addr:192.168.99.1 Bcast:192.168.99.255 Mask:255.255.255.0
- inet6 addr: fe80::20f:eaff:fe10:d51c/64 Scope:Link
- UP BROADCAST RUNNING MULTICAST MTU:1500 Metric:1
- RX packets:68711621 errors:0 dropped:0 overruns:0 frame:0
- TX packets:70059644 errors:0 dropped:0 overruns:0 carrier:0
- collisions:0 txqueuelen:1000
- RX bytes:3449044517 (3.2 GiB) TX bytes:1328494982 (1.2 GiB)
- Interrupt:217
-
-lo Link encap:Local Loopback
- inet addr:127.0.0.1 Mask:255.0.0.0
- inet6 addr: ::1/128 Scope:Host
- UP LOOPBACK RUNNING MTU:16436 Metric:1
- RX packets:177789 errors:0 dropped:0 overruns:0 frame:0
- TX packets:177789 errors:0 dropped:0 overruns:0 carrier:0
- collisions:0 txqueuelen:0
- RX bytes:599522176 (571.7 MiB) TX bytes:599522176 (571.7 MiB)
-
-
-
- The previous example demonstrates the use of Linux ifconfig utility to identify available network interfaces by name and MAC address.
-
-
- If your computer has multiple Ethernet interface cards installed, you can connect each card to a different Atheros powerline device and communicate with each device, independently, from one console session (window) by specifying the appropriate interface card with each command. It is also possible to open multiple console sessions (windows), each having a unique enviroment, and assign a different value for PLC in each enviroment.
-
-
-
-
- Select an Interface on Windows
-
-
- Winpcap references host network interfaces by number, not name. This means that you must determine the proper interface number for the network adapter that you plan to use. Use Toolkit pcapdevs utility will enumerate available host network adapters by number, MAC address and description. By default, Toolkit programs communicate with powerline devices on pcap interface 2 but another interface can be specified on the command line with the -i option:
-
-
-
- Selecting another Interface on Windows
-
-
-# int6k -i 3 ...
-
-
-
- In the previous example, int6k will send and receive frames using host interface 3 instead of the default interface. Having to specify the interface can become tedious when entering commands manually. Presently there is no way to specify a default interface on WIndows platforms.
-
-
-
- Finding Interfaces on Windows
-
-
-# pcapdevs
- 1 00:00:00:00:00:00 \Device\NPF_GenericDialupAdapter (Adapter for generic dialup
- 2 00:0E:2E:03:5F:B8 \Device\NPF_{4CFAABD5-C929-4942-914B-BDFE72B13611} (Realtek R
- 3 00:C0:49:D5:CB:14 \Device\NPF_{73E0D2EF-6069-4831-B379-507025F2BDCD} (Realtek R
- 4 00:0C:76:87:3E:3D \Device\NPF_{86B96905-3AA7-46F1-969A-6C23E3BBBA8B} (Broadcom
-
-
-
- The previous example illustrates the use of Toolkit pcapdevs utility to identify available network interfaces by interface number, MAC address and description. The descriptions have been truncated in this example because they are too long. Devices having MAC address 00:00:00:00:00:00 are unavailable.
-
-
-
-
- Identify a Device
-
-
- Before you start working with Atheros powerline devices, you should determine the chipset and firmware revision because that will determine the types of operations that can be performed and the order in which some operations should be performed. The following example illustrates how to determine this information.
-
-
-
- Device Identification
-
-
-# int6k -r
-eth1 00:B0:52:00:00:01 Fetch Version Information
-eth1 00:B0:52:DA:DA:23 INT6300A0 INT6000-MAC-3-0-3001-1081-LA-A NOT_UPGRADEABLE
-eth1 00:B0:52:FE:87:2D INT6000A1 INT6000-SL-0-1-0110-200-2006-0415-BETA NOT_UPGRADEABLE
-
-
-
- This example demonstrates several things.
-
-
- First, the int6k-r option requests hardware and software revision information from a device by sending an Atheros VS_SW_VER vendor-specific managerment message and waiting for a response. Atheros vendor-specific management messages are described in the Atheros HomePlug AV Firmware Technical Reference Manual. It you do not have access to this document then many toolkit features may be difficult to understand.
-
-
- Since we did not specify an Ethernet interface on the command line, the default interface was used. In this case, the default interface was eth1 and so we observe that eth1 was used to both send requests and receive responses.
-
-
- Since we did not specify a device address on the command line, the default address was used. Device addresses are also known as MAC, Ethernet or hardware addresses. They uniquely identify a device on a network. Unlike Ethernet cards, powlerlines device do not have IP addresses.
-
-
- The default device address for toolkit programs is 00:B0:52:00:00:01. This address is the Local Management Address (LMA). All Atheros devices connected to the local host will respond to this address and include their actual address in the response. In the above example, two devices responded. This means that both were connected directly to eth1, perhaps via a network hub. Observer that device 00:B0:52:DA:DA:23 is an INT6300 and device 00:B0:52:FE:87:2D is an INT6000. The first device is running Atheros firmware and the second device is running the Atheros Softloader.
-
-
-
- Inspecting Device Configuration
-
-
- To find out more about device 00:B0:52:DA:DA:23 we might issue the following command where option -I requests identity information stored in the device PIB. In this case, we specified the device by MAC address to prevent other local devices from responding. There is no harm in having both devices respond so we could have specified both hardware addresses.
-
-
-
- Pay special attention to the MAC address after flashing NVRAM. Hardware address 00:B0:52:00:00:03 indicates the Default PIB used when no other PIB is available. The Default PIB disables communication over powerline.
-
-
- Pay special attention to the NMK when devices cannot communicate. Devices having different NMK values will not form a network. Conversely, all devices having the same NMK will form a network. This becomes important when programming large numbers of devices. You must have an out-of-the-box networking strategy that balances user convenience and network security.
-
-
- The string next to the NMK indicates that password HomePlugAV was used to generate that key. This is one of two default passwords and keys used by Atheros. In some cases, it may be another clue that the device is using the default PIB.
-
-
-
-
-
- Browse the Network
-
-
- A powerline network consists of one or more powerline devices that share a common NMK. One device on the network is in charge of the network and known as the Central Coordinator (CCo). All other devices on that network are known as stations (STA). Each device maintains internal information about the network to which it belongs. You can view that information at any time.
-
-
-
- Display Network Information
-
-NID = 77:23:0D:91:06:6E
- network->SNID = 6
- network->TEI = 1
- network->ROLE = 0x02 (CCO)
- network->CCO_DA = 00:B0:52:00:00:BB
- network->CCO_TEI = 1
- network->STATIONS = 1
-
- station->DA = 00:B0:52:00:00:AA
- station->TEI = 2
- station->BDA = FF:FF:FF:FF:FF:FF
- station->AvgPHYDR_TX = 0 mbps
- station->AvgPHYDR_RX = 0 mbps
-]]>
-
-
- The example above prompts the local device on interface eth3 for network membership (-m) information. Device 00:B0:52:00:00:BB responded and reported that it belongs to one powerline network. The first block of information identifies the network CCo. The second block of information identifies a network STA. This second block will repeat when multiple stations are present. Each device on the network has a unique Terminal Equipment Identifier (TEI) within the network. The average PHY rates show the data rates between the reporting device and each STA. In this cases there has been no traffic.
-
-
-
-
- Forming a Network
-
-
- A powerline network is formed when two or more devices share a common Network Membership Key (NMK). An NMK is always 16 bytes (32 hexadecimal digits) in length and can have any value, including all zeros. Devices programmed with the same NMK value can communicate while those programmed with different NMK values cannot. Program int6k can be used to program a local or remote device with a specific NMK value.
-
-
-
- Setting the Network Membership Key
-
-
-
-
- This example programs the local device with the default NMK. Option -M sets the network membership key with the default key value. The default key is used because we omitted option -K and the local device is programmed because we omitted the device MAC address.
-
-
- One can quickly and easily create a default network by connecting each device, in turn, to the local host and executing this command shown above. The devices will then form a network when connected via the powerline. Although fast and simple, this method is not very secure because the default NMK is used by many Atheros tools and is well known.
-
-
- There are cases where one wants to create separate, independent networks on the powerline. This is accomplished by programming some devices with one NMK and other devices with another NMK. In such cases we need to specify an NMK value.
-
-
-
- Forming a Custom Network
-
-
-
- This example programs the local device NMK with the value 00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF. Option -K sets the default key value used by option -M. The default device is programmed because we omitted a target MAC address from the command line but we could have specified the local device using the actual device MAC address or the Local Management Address (LMA) of 00:B0:52:00:00:01 or the keyword local, like so ...
-
-
-
-
-
- Remote Network Configuration
-
-
- Once a network has been established, one can change the NMK of remote devices over the powerline but once the NMK on the remote device has changed, it is no longer part of original network and can no longer be returned to the network in the same way. Additionally, one cannot change the NMK on a remote device without specifying the DAK of the device to be changed.
-
-
-# int6k -M -K 00:11:22:33:44:55:66:77:88:99:AA:BB:CC:DD:EE:FF \
- -J 00:B0:52:BA:BE:57 \
- -D A7:8E:11:FB:6A:90:2C:CB:A7:8E:11:FB:6A:90:2C:CB
-eth1 00:B0:52:00:00:01 Set Remote Network Membership Key
-eth1 00:B0:52:BA:BA:56 Setting ...
-
-
- This example sets the NMK on remote device via the local device. Option -J specified the MAC address of the remote device. Option -D specified the DAK of the remote device. The request is sent to the local device, because we omitted the target MAC address, and the local device forwards our request to the remote device. The request will fail if the remote device is not accessible or the remote device DAK is incorrect.
-
-
- This command is one of the more complicated int6k commands, requires lots of typing and is consequently prone to typing errors. The order of command line options is not important.
-
-
-
-
-
- Configuring a Device
-
-
- Device identity, capability and behavior are controlled by runtime parameters stored in the device PIB. To change device identity, capability or behavior you must alter a template PIB file, download it to the device and flash it into NVRAM. A template PIB can come from several sources but an excellent souce is the device, itself. Configuration changes then become a simple read, modify and write back operation.
-
-
-
- Read a PIB File
-
-
-
- This example reads the PIB from the local device and writes it to a file. The toolkit has a growing number of programs designed to inspect and change pibfiles in various ways. Program modpib is one program that can be used for this purpose.
-
-
-
-
- Modify a PIB File
-
-
-
-
- The example above edits identity parameters in PIB file, old.pib, recomputes the internal checksum and re-writes the file. The network identity parameters are MAC (-M), NMK (-N) and DAK (-D). The user identity parameters are MFG_HFID (-S), NET_HFID (-T) and USR_HFID (-U). The PIB file is ready for download and flash.
-
-
- Program modpib is a safe way to edit a PIB file because it only change selected parameters. Use program setpib to edit other parameters if required.
-
-
-
- Save a PIB File
-
-
-
-
- This example writes the modified PIB file, old.pib, to the local device and commits it to NVRAM. Option -P writes the PIB file to the device instead of reading it from the device. Option -C with argument pib commits only the PIB, and not firmware, to NVRAM.
-
-
-
-
- Upgrading Firmware and PIB
-
-
- Eventually, you may want to upgrade (or downgrade) the runtime firmware stored in NVRAM. To do this, you must locate a copy of the new .nvm file on the Atheros FTP site and download it to your host. You must then download the file to the device and ask the runtime firmware on the device to write the file to NVRAM. Writing firmware to NVRAM is also called flashing the device. Program int6k can be used for this purpose when runtime firmware is executing on the device.
-
-
- Program int6k instructs runtime firmware to write to NVRAM but the firmware will behave differently depending on how it was loaded and started. The first time NVRAM is written by runtime firmware, the Factory PIB is created in NVRAM. The second time, the User PIB is created. Thereafter, the User PIB will be re-written each time. This preserves original factory settings and permits their restoration regardless of intervening parameter changes. This means that you should make an effort to get things right the first time.
-
-
-
- Upgrade Firmware and PIB
-
-
-
-
- This example downloads a PIB file (-P) and an NVM file (-N) to the device then instructs the runtime firmware to write (or flash) (-F) both of them to NVRAM. Option -F always writes both to NVRAM but option -C can be used to write only one or the other or both.
-
-
- Observe that options -P, -N and -F are all in uppercase. As a rule, uppercase options modify the device and lowercase options do not. One notable exception to this rule is -I which merely displays device identity.
-
-
-
-
- Upgrading PIB Only
-
-
- When flashing a PIB to the local device, the PIB DAK must match that of the local device or you will get a DAK Not Zero error message. This message is incorrect and should probably read DAK Mismatch. The following two toolkit commands should prevent this error from occuring on Linux. The first command reads the actual MAC (-A) and DAK (-D) from the device using program int6kid and inserts them on the command lise as modpib arguments using options -M and -D. We need not include the station MAC address on the int6k command line because the device is local, but we could include it.
-
-
-
- Upgrade local device PIB
-
-
-
-
- When flashing a PIB to a remote device, the PIB DAK must be all zeros or you will get a DAK Not Zero error message. This message occurs because the HomePlug AV Specification does not permit a DAK to be transmitted over powerline in any form. The following two toolkit commands should prevent this error on Linux. We must include the device MAC on the command line when invoking each program because the device is remote. Notice that symbol none can be used as shorthand 00:00:00:00:00:00:00:00:00:00:00:00:00:00:00:00 when specifying the DAK.
-
-
-
- Upgrade remote PIB
-
-
-
-
- The MAC address stored in the PIB can have any value but it is good practice to preserve the original value. This avoids the common mistake of flashing multiple network stations with the same MAC address because the PIB was not updated.
-
-
-
-
- Starting a Device
-
-
- Some device configurations have no flash memory to store runtime parameters and firmware so the local host must store them until needed then write them into device SDRAM and start execution. This is also needed when the flash memory is blank or corrupted because the runtime firmware is the only way to write flash memory. Programs int6kf, int6kboot, ampboot and plcboot are used to configure a blank device then download runtime parameters and firmware and start execution. They all perform the same basic function but in different ways.
-
-
-
- Start Firmware on <productname>INT6000</productname>
-
-
-# int6kf -C abc.cfg -N abc.nvm -P abc.pib
-
-
- Program int6kf can be used to download runtime firmware and parameters and start execution on and INT6000 chipset. The process involves downloading a .cfg file using VS_SET_SDRAM, downloading a .nvm file using VS_WR_MEM, downloading a .pib file using VS_WR_MEM then starting firmware execution using VS_ST_MAC. See the int6kf man page for an explanation of the command line options and arguments used here.
-
-
-
-
- Start Firmware on <productname>INT6300</productname> and <productname>INT6400</productname>
-
-
-# int6kboot -N abc.nvm -P abc.pib
-
-
- Program int6kboot can be used to download runtime firmware and parameters and start execution on an INT6300 or INT6400 chipset. The process involves downloading a .nvm file using VS_WR_MEM, downloading a .pib file using VS_WR_MEM then starting firmware execution using VS_ST_MAC. No .cfg file is needed or permitted with this application.
-
-
-
-
- Start Firmware on <productname>AR7400</productname>
-
-
-# ampboot -N abc.nvm -P abc.pib
-
-
- Program ampboot can be used to download runtime firmware and parameters and start execution of runtime firmware on an INT6300, INT6400 or AR7400 chipset. The process involves downloading a .pib file using VS_WR_MEM, downloading a .nvm file using VS_WR_MEM then starting firmware execution using VS_ST_MAC. A general purpose applet, stored in the .nvm file, configures SDRAM. No .cfg file is needed or permitted with this application.
-
-
-
-
- Start Firmware on <productname>AR7420</productname>
-
-
-# plcboot -N abc.nvm -P abc.pib
-
-
- Program plcboot can be used to download runtime firmware and parameters and start execution an INT6300, INT6400, AR7400 or AR7420 chipset. This program detects the type of chipset and the image file format. The boot process varies depending on the chipset that is detected and the image file format. For the AR7420 chipset, this process involves downloading a .pib and .nvm file using only VS_WRITE_EXECUTE messages. For earlier chipsets, the process is as described above.
-
-
-
-
-
- Testing a Device
-
-
- When the Bootloader is running, it is possible to perform systematic diagnostic testing by downloading and executing a variety of small programs, called applets. A collection of applets can be found in the toolkit Applets folder. Applet manpages describe the purpose of each one. Some applets are more useful than others. Start by reading the applets manpage.
-
-
- Program int6ktest can be used to sequentially download and execute a series of applets. Applets have evolved over time and some are more useful or informative than others. Newer applets report progress and errors on the console. Older applets report progress or errors by flashing the onboard LEDs. This means of testing cannot be used after the flash memory has been programmed unless you erase, corrupt or remove the flash.
-
-
-# int6ktest -i eth4 connection.nvm memctl.nvm marchloop.nvm
-eth4 00:B0:52:00:00:01 Write Memory (00000000:32)
-eth4 00:B0:52:00:00:01 Wrote connection.nvm
-eth4 00:B0:52:00:00:01 Start connection.nvm (0)
-eth4 00:B0:52:00:00:01 Write Memory (00001000:664)
-eth4 00:B0:52:00:00:01 Wrote connection.nvm
-eth4 00:B0:52:00:00:01 Start connection.nvm (1)
-eth4 00:B0:52:00:00:01 Write Memory (00000040:6076)
-eth4 00:B0:52:00:00:01 Wrote memctl.nvm
-eth4 00:B0:52:00:00:01 Start memctl.nvm (0)
-eth4 00:B0:52:00:00:01 Write Memory (00001000:2212)
-eth4 00:B0:52:00:00:01 Wrote marchloop.nvm
-eth4 00:B0:52:00:00:01 Start marchloop.nvm (0)
-eth4 00:B0:52:00:00:01 0x00 March2 test - Pass
-
-
- This example uses program int6ktest to download and execute applets connection.nvm, memctl.nvm and marchloop.nvm to the powerline device on host interface eth4. The first applet checks circuit board connections to memory and reports progress and errors by flashing onboard LEDs. The second configures the SDRAM controller and exits without any indication. The third performs a systematic test of SDRAM and reports progress and errors on the console. In this case the test passed.
-
-
- See programs amptest and plctest for updated versions of this program for use with AR7400 and QCA7420 chipsets.
-
-
-
-
- Programming NVRAM
-
-
-
- int6kf and int6kboot
-
-
- The INT6300 and INT6400 do not require a special SDRAM configuration file and so program int6kboot may be used in place of int6kf which is described here. The only real difference between the two programs is the presence or absence of option -C on the command line.
-
-
-
- The int6kf program can program a blank or corrupted NVRAM on the INT6300. The process involves starting the runtime firmware as shown in the previous example then downloading a .nvm file using a VS_WR_MOD message, downloading a .pib file using another WR_WR_MOD message then writing both to NVRAM using a VS_MOD_NVM message. An example int6kf command line is shown below. It is identical to the one shown above except for the addition of the flash option at the end.
-
-
-
- Flash NVRAM with int6kf
-
-
-# int6kf -C abc.cfg -N abc.nvm -P abc.pib -F
-
-
-
- The example above starts the firmware then uses it to program the NVRAM. This was done in one step rather than two seperate steps as shown in the examples before it. The only difference is that int6k needs to use the 'force flash' option when using downloaded firmware to write NVRAM. The following example accomplishes the same thing as the previous example but uses int6k to program NVRAM. See the int6k man page for an explanation of the command line options and arguments used here.
-
-
- The int6kf program cannot program blank or corrupted NVRAM on the INT6000 unless the Softloader is running. Since the Softloader resides in NVRAM, the NVRAM must be either pre-programmed before use or removed and externally re-programmed if it corrupts.
-
-
-
- Flash NVRAM with int6k
-
-
-# int6kf -C abc.cfg -N abc.nvm -P abc.pib
-# int6k -N abc.nvm -P abc.pib -FF
-
-
-
-
-
- Pairing UART Devices post PTS
-
-
- This procedure describes how to pair two UART-enabled powerline adapters once they have been programmed, personalized and tested. This example assumes you are using a Windows host and two powerline adapters having MAC addresses 00:B0:52:00:05:F9 and 00:B0:52:00:05:FA.
-
-
- Start with the first device, 00:B0:52)(00:05:F9. Plug the host serial cable into the RJ45 port on the device and plug the device into an AC power source.
-
-
- Change to transparent mode using program int6kuart. Option -v displays outgoing command and incoming serial responses. The +++ is the serial data sent to the device and the OK is the device response.
-
-# int6kuart -s com3 -wv
-+++
-OK
-
-
-
- Read the adapter PIB into a temporary file using program int6kuart. The following command reads the PIB from serial device com3 and saves it to file temp.pib on the host. You will see a series of dots appear on the console as the PIB is read from the device. The filename used is not important.
-
-# int6kuart -s com3 -p temp.pib
-....................
-
-
-
- Program the PIB file with the default destination address using program setpib. The following command inserts the MAC address of the second device, 00B0520005FA, at fixed offset 0x2C8A in file temp.pib downloaded in the previous step.
-
-# setpib temp.pib 2C8A data 00B0520005FA
-
-
-
- Write the modified PIB file back to the adapter and commit it to flash memory using program int6kuart. The following command write file temp.pib to serial device com3 then commits the PIB to flash memory. You will see a series of dots appear on the console as the PIB is written to the device. The device will reboot.
-
-# int6kuart -s com3 -P temp.pib -C2
-....................
-
-
-
- Change the device to Transparent Mode using program int6kuart once the device resets.
-
-# inc6kuart -s com3 -wv
-+++
-OK
-
-
-
- Verify that the destination MAC address is correct using program int6kuart.
-
-# int6kuart -s com3 -d
-00B0520005FA
-
-
-
- Repeat this process on the second adapter, 00:B0:52:00:05:FA, using the MAC address of the first device, 00:B0:52:00:05:F9, as the destination address.
-
-
- &procedure-trouble-shooting;
- &procedure-slac-config;
- &procedure-slac-demo;
-
diff --git a/docbook/programs.xml b/docbook/programs.xml
deleted file mode 100644
index 27b904c2..00000000
--- a/docbook/programs.xml
+++ /dev/null
@@ -1,958 +0,0 @@
-
-
- Toolkit Programs
-
-
- The Qualcomm Atheros Open Powerline Toolkit is a collection of small, command line programs. Each program deals with some aspect of powerline device management. Programs can be combined, in various ways, using shell scripts, to perform sophisticated and complex tasks. With these program, one can identify chipset and firmware version, reset devices, flash devices, identify other powerline network devices, validate *.pib and *.nvm files, sniff HomePlug AV Ethernet frames, send generic Ethernet frames and so on.
-
-
- Program source code is designed to demonstrate device hardware and firmware features and to illustrate techniques for software developers and hardware engineers. The source code may be modified and distributed without obligation to Qualcomm Atheros; however Qualcomm Atheros would appreciate feedback concerning improvements to program useability, reliability or efficiency. Keep in mind that these tools, unlike some other tools, are intended to be simple and compact.
-
-
- Most programs in this toolkit start their life on Linux and are eventually ported to other environments. Consequently, not all programs are available in the Windows version of the toolkit but most of them are.
-
-
- Program descriptions appear below in alphabetical order. Alternately, you may browse the latest program descriptions and source code here.
-
-
-
-
-
- INT6400 Device Management
-
-
- Programs in this group are older versions that communicate with INT6x00 chipsets. Many still work on AR7x00 chipsets. The main difference is due to the higher PHY data rates on AR7x00 chipsets. The higher data rates must be expressed using 16-bits instead of 8-bits. Consequently, some MME formats have changed.
-
-
-
-
-
- int64host
-
-
-
-
- A command line utility that waits for and services VS_HST_ACTION messages from a flash-less device INT6300 or INT6400 device. It is similar to program int6khost but does not use an SDRAM configuration files. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int64host man page for more information.
-
-
-
-
-
-
- int6k
-
-
-
-
- A command line utility to inspect and control INT6000 and INT6300 devices connected to the local host. It performs several of the device maintenance functions available in the Atheros Windows Device Manager but is small enough to run on an embedded system. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder .int6k. See the int6k man page for more information.
-
-
-
-
-
-
- int6k2
-
-
-
-
- A command line utility to inspect and control INT6000 and int6300 devices connected to the local host. It is similar to int6k but calls the Atheros Embedded API, described in the Atheros HomePlug AV API User's Guide, to perform device management tasks. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6k2 man page for more information.
-
-
-
-
-
-
- int6kboot
-
-
-
-
- A command line utility to start and optionally flash INT6300 and INT6400' devices that have no NVRAM or have a blank or corrupted NVRAM. It communicates with the Atheros Bootloader to configure SDRAM, download runtime firmware and PIB and start firmware execution. Users can optionally request that the same PIB and firmware then be used to flash NVRAM. It is similar to program int6kf but does not accept an SDRAM configuration file. Instead, it uses on the memctl applet. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6kboot man page for more information.
-
-
-
-
-
-
- int6kf
-
-
-
-
- A command line utility to start and optionally flash INT6000 and INT6300 devices having no NVRAM or having a blank or corrupted NVRAM. It communicates with the Atheros Bootloader to configure SDRAM, download runtime firmware and PIB and start firmwrae execution. It can also be used to force flash blank or corrupted NVRAM. It is similar to program int6kboot but requires an SDRAM parameter file. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6kf man page for more information.
-
-
-
-
-
-
- int6khost
-
-
-
-
- A command line utility that waits for and services VS_HST_ACTION messages from a flash-less INT6000 or INT6300 device. It is similar to program in64host but needs an SDRAM configuration file. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6khost man page for more information.
-
-
-
-
-
-
- int6kid
-
-
-
-
- A command line utility that prints the DAK or NMK strings read from one or more devices. It can be used in shell scripts to dynamically obtain device keys and insert them on program command lines as arguments. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6kid man page for more information.
-
-
-
-
-
-
- int6klist
-
-
-
-
- A command line utility that lists local devices, or remote devices associated with a specific device, on stdout in undecorated format. It can be used in shell scripts to dynamically determine, and then traverse, network topology. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6klist man page for more information.
-
-
-
-
-
-
- int6kprobe
-
-
-
-
- A command line utility that probes for neighboring networks. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6kprobe man page for more information.
-
-
-
-
-
-
- int6krule
-
-
-
-
- A command line utility to format and send classification rules to a device. Classification rules are specified using symbolic names for actions, options, conditions and frame fields. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6krule man page for more information.
-
-
-
-
-
-
- int6ktest
-
-
-
-
- A command line utility that downloads and executes program images stored in an Atheros .nvm file. This program can be used to download and execute Atheros hardware diagnostic programs like those in the ./applets folder. It is not intended to download and start runtime firmware, although it may be used for that. The program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6ktest man page for more information.
-
-
-
-
-
-
- int6kuart
-
-
-
-
- A command line utility used to manage a local powerline device over a host serial line interface. Program command line options are translated to AT-style serial commands and sent to the device. THe primary benefits of using this program, in place of a terminal emulator, is the ability to download parameter blocks and upload paameter blocks and firmware images. The program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./serial. See the int6kuart man page for more information.
-
-
-
-
-
-
- int6kwait
-
-
-
-
- A command line utility that polls the local powerline device and waits for the bootloader or runtime firmware to either stop executing or start executing or wait for a device to associate with another device. It can be used to synchronize scripts with device or network events such as connection make or break, power on or off and firmware stop or start. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6kwait man page for more information.
-
-
-
-
-
-
-
-
- INT6400 Device Monitoring
-
-
-
-
-
- int6klog
-
-
-
-
- A command line utility that exports the runtime watchdog report in binary or XML format. Output is suitable for input to the Atheros Windows Device Manager. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6klog man page for more information.
-
-
-
-
-
-
- int6krate
-
-
-
-
- A command line utility that polls a device and prints the average transmit and receive PHY rates between it and each of it's network neighbors. Program output is suitable for loading into a spreadsheet or other program that can process column-oriented information. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6krate man page for more information.
-
-
- This program is suitable for use with INT6x00 chipsets but not AR7x00 chipsets due to higher PHY rates. Use program amprate for AR7x00 chipsets and plcrate for mixed chipset environments.
-
-
-
-
-
-
- int6kstat
-
-
-
-
- A command line utility that polls a poserline device and prints various network and link statistics in a format suitable for processing by another program. It is a work in progress because we are investigating different ways to present the information. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the int6kstat man page for more information.
-
-
-
-
-
-
-
-
- AR7400 Device Management
-
-
- The programs in this group are essentially identical to those in the INT6x00 group but they support higher PHY data rates offered by the AR7x00 chipsets. Specifically, they handle the new VS_NW_INFO and VS_LNK_STATS message formats.
-
-
-
-
-
- ampboot
-
-
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the ampboot man page for more information.
-
-
-
-
-
-
- amphost
-
-
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the amphost man page for more information.
-
-
-
-
-
-
- ampinit
-
-
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the ampinit man page for more information.
-
-
-
-
-
-
- amplist
-
-
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the amplist man page for more information.
-
-
-
-
-
-
- amptest
-
-
-
-
- A command line utility that downloads and executes program images stored in an Atheros .nvm file. It can be used to download and execute special Atheros hardware diagnostic programs. It is not intended to download and start runtime firmware. The program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the amptest man page for more information.
-
-
-
-
-
-
- amptool
-
-
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the amptool man page for more information.
-
-
-
-
-
-
- ampwait
-
-
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the ampwait man page for more information.
-
-
-
-
-
-
-
-
- AR7400 Device Monitoring
-
-
- The programs in this group are essentially identical to those in the INT6x00 group but they support higher PHY data rates offered by the AR7x00 chipsets. Specifically, they handle the new VS_NW_INFO and VS_LNK_STATS message formats.
-
-
-
-
-
- amprate
-
-
-
-
- A command line utility that polls a device and prints the average transmit and receive PHY rates between it and each of it's network neighbors. Program output is suitable for loading into a spreadsheet or other program that can process column-oriented information. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the amprate man page for more information.
-
-
- This program is suitable for use with AR7x00 chipsets and later that have higher PHY rates and newer firmware. Use program int6krate for AR6x00 running earlier runtime firmware that may not recognize newer message formats. Use program plcrate for mixed chipset environments
-
-
-
-
-
-
- ampsnif
-
-
-
-
- Enables or disables the powerline sniffer mode on the local powerline device using the VS_SNIFFER message. Use program ampsnot to display and/or record sniffer output. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the ampsnif man page for more information.
-
-
-
-
-
-
- ampsnot
-
-
-
-
- Listens for sniffer output from the local powerline device and display results on the console. Use program ampsnif to enable or disable sniffer output. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the ampsnot man page for more information.
-
-
-
-
-
-
- ampstat
-
-
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the ampstat man page for more information.
-
-
-
-
-
-
- amptone
-
-
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the amptone man page for more information.
-
-
-
-
-
- mdustats
-
-
-
- A command line utility to collect and display various MDU traffic statistics. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./plc. See the mdustats man page for more information.
-
-
-
-
-
-
-
-
- AR7420 Device Configuration
-
-
- Programs in this group understand changes to .nvm file formats and to the device boot and memory flash messages and sequences.
-
-
-
-
-
- plchost
-
-
-
-
- This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the plchost man page for more information.
-
-
-
-
-
-
- plctest
-
-
-
-
- A command line utility that downloads and executes small program images stored in older and newer .nvm files. It can be used to download and execute small powerline diagnostic programs. It is not intended to download and start runtime firmware. The program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./plc. See the plctest man page for more information.
-
-
- This program automatically detects the type of .nvm file format and adapts.
-
-
-
-
-
-
-
-
-
- Parameter File Management
-
-
- Programs in this group are used to inspect and change .pib files in various ways. The do not communicate directly with the powerline device. Use program int6k, amptool or plctool to read the PIB from a powerline device or write a PIB to the powerline device.
-
-
-
-
-
- chkpib
-
-
-
-
- A command line utility to validate .pib files based on their internal checksum, file size and other characteristics. It can also be used to produce a text catalog of .pib files. This program is slower than program chkpib2 but requires less memory to execute. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./pib. See the chkpib man page for more information.
-
-
-
-
-
-
- chkpib2
-
-
-
-
- A command line utility to validate .pib files based on their internal checksum, file size and other characteristics. It can also be used to produce a text catalog of .pib files. This program is faster than program chkpib but requires more memory to execute. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./pib. See the chkpib2 man page for more information.
-
-
-
-
-
-
- getpib
-
-
-
-
- A free-form means of extracting paremeters from a PIB file when the offset, length and format of the parameter is known. It is a companion to program setpib. The user specifies the filename, a starting offset and a sequence of type/data pairs. Values are echoed in order on the console in the specified format. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./pib. See the getpib man page for more information.
-
-
-
-
-
-
- modpib
-
-
-
-
- A command line utility to change the MAC, DAK and/or NMK of an existing PIB file and recompute the checksum. It can also be used to change the manufacturer string, network name and username strings. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./pib. See the modpib man page for more information.
-
-
-
-
-
-
- mrgpib
-
-
-
-
- A command line utility that transfers parameters from one PIB file to another. The two files needs not have the same PIB version. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./pib. See the mrgpib man page for more information.
-
-
-
-
-
-
- pib2xml
-
-
-
-
- An offset-driven XML dump utility for the PIB. It requires an offset description file to be useful. The user specifies an offset description file and a PIB file. The program output an XML description of PIB fields. An example file, piboffset.txt, is included as a basic example. The example offset description file is intentionally incomplete. Complete files are reserved for use by Atheros Field Application Engineers. This program is an alternative to program pibdump. The main source code is located in folder ./tools. See the pib2xml man page for more information.
-
-
-
-
-
-
- pibcomp
-
-
-
-
- An offset-driven binary file compare utility for the PIB. It requires an offset description file to be useful. The user specifies an offset description file and two binary files. The files are compared, field by field, and differences are printed on stdout, field by field. An example file, piboffset.txt, is included as a basic example. The example offset description file is intentionally incomplete. Complete files are reserved for use by Atheros Field Application Engineers. This program is an alternative to program pib2xml and a companion to program pibdump. The main source code is located in folder ./tools. See the pibcomp man page for more information.
-
-
-
-
-
-
- pibdump
-
-
-
-
- An offset-driven dump utility for the PIB. It requires an offset description file to be useful. An example file, piboffset.txt, is included as a basic example. The example offset description file is intentionally incomplete. Complete files are reserved for use by Atheros Field Application Engineers. This program is a companion to program pibcomp. The main source code is located in folder ./tools. See the pibdump man page for more information.
-
-
-
-
-
-
- pibruin
-
-
-
-
- A command line utility that inserts classifier rules, read from a file, into a PIB file. It is an alternative to program int6krule and companion to program pibrump. The main source code is located in folder ./pib. See the pibruin man page for more information.
-
-
- This program supports INT6300, INT6400 and AR7400 PIBs only and is deprecated.
-
-
-
-
-
-
- pibrump
-
-
-
-
- A command line utility that reads classifier rules from a PIB file and prints them on stdout in a format suitable for input to program pibruin. The main source code is located in folder ./pib. See the pibrump man page for more information.
-
-
-
-
-
-
- psin
-
-
-
-
- A command line utility to insert an amplitude map into an existing PIB file. The map is read from stdin in text format allowing the output of program psout to be piped directly into this program. The main source code is located in folder ./pib. See the psin man page for more information.
-
-
-
-
-
-
- psout
-
-
-
-
- A command line utility to that exports an amplitude map stored in an existing PIB file. The map is written directly to stdin in text format allowing the output of this program to be piped into the input of program psin. The main source code is located in folder ./pib. See the psout man page for more information.
-
-
-
-
-
-
- pxe
-
-
-
-
- A generic 'Remote PIB Management' tool. One or more XML files define decimal, hexadecimal and string edits to be applied to a PIB file. The PIB is read, edits are applied, a new checksum is computed and the PIB is saved. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./pib. See the pxe man page for more information.
-
-
-
-
-
-
- setpib
-
-
-
-
- A simple means of setting PIB parameters when the parameter offset, length and format are known. It is an alternative to program pxe and a companion to program getpib. The user specifies the filename, a starting offset and a sequence of type/data pairs. Edits are applied in order and a new checksum is computed. A full or partial dump of the PIB displays the result. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./pib. See the setpib man page for more information.
-
-
-
-
-
-
-
-
-
- Firmware File Management
-
-
-
-
-
- chknvm
-
-
-
-
- A command line utility to validate .nvm files based on their internal checksum, file size and other characteristics. This program is slower than program chknvm2 but requires less memory to execute. Optionally, it can be used to display the image headers inside the file. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./nvm. See the chknvm man page for more information.
-
-
-
-
-
-
- chknvm2
-
-
-
-
- A command line utility to validate .nvm files based on their internal checksum, file size and other characteristics. Optionally, it can be used to display the image headers inside the file. This program is faster than program chknvm but requires more memory to execute. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./nvm. See the chknvm2 man page for more information.
-
-
-
-
-
-
- config2cfg
-
-
-
-
- A command line utility to convert an SDRAM configruation file used by the Atheros Windows Device Manager to the configuration file format used by the Open Powerline Toolkit applications. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./sdram. See the config2cfg man page for more information.
-
-
-
-
-
-
- nvmmerge
-
-
-
-
- A command line utility to combine multiple Atheros image files into one. It is reserved for use by Atheros Field Application Engineers. Use of this probram could void some contractual obligations made by Atheros. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./nvm. See the nvmmerge man page for more information.
-
-
-
-
-
-
- nvmsplit
-
-
-
-
- A command line utility to extract all constituent images from an Atheros image file. It is reserved for use by Atheros Field Application Engineers. Use of this probram could void some contractual obligations made by Atheros. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./nvm. See the nvmsplit man page for more information.
-
-
-
-
-
-
-
-
-
- Ethernet Traffic
-
-
-
-
-
- edru
-
-
-
-
- A command line program that reads one or more Ethernet II (IEEE 802.2) frames and write frame data to stdout as a continuous stream. This program can be used to capture serial data sent from a remote UART-enabled powerline device. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./ether. See the edru man page for more information.
-
-
-
-
-
-
- edsu
-
-
-
-
- A command line program sends one or more files over the network using Ethernet II (IEEE 802.2) Frames. This program can be used to test remote UART-enabled powerline devices. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./ether. See the edsu man page for more information.
-
-
-
-
-
-
- efsu
-
-
-
-
- A freeform Ethernet frame send utility used to define and send Ethernet packets. Packets are defined in text files containing hexadecimal byte codes plus optional comments and whitespace. Input files are stripped of comments and whitespace then transmitted as Ethernet frames. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./ether. See the efsu man page for more information.
-
-
-
-
-
-
- hpav
-
-
-
-
- A basic HomePlug AV packet sniffer that displays only HomePlug AV protocol frames on the console as they are sent or arrive on a given interface. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./mme. See the hpav man page for more information.
-
-
-
-
-
-
- pcapdevs
-
-
-
-
- A utility to enumerate LibPcap or WinPcap devices available on the host. It is compiled but only works if one of these two packages is installed on the host. At present, it is only needed with the Windows version of the Toolkit which is compiled against the WinPcap library. The main source code is located in folder ./ether. See the pcapdevs man page for more information.
-
-
-
-
-
-
-
-
-
- Passwords and Keys
-
-
-
-
-
- hpavkey
-
-
-
-
- A HomePlug AV key generator. Pass phrase arguments are hashed to form the corresponding Device Access Key (DAK), Network Membership Key (NMK) or Network Identifier (NID). This program is installed in folder /usr/local/bin with 4555 permissions. The main source code is located in folder ./crypt. See the hpavkey man page for more information.
-
-
-
-
-
-
- hpavkeys
-
-
-
-
- A HomePlug AV key generator. Pass phrases are read from a file and hashed to form the corresponding Device Access Key (DAK), Network Membership Key (NMK) or Network Identifier (NID). This program is installed in folder /usr/local/bin with 4555 permissions. The main source code is located in folder ./crypt. See the hpavkeys man page for more information.
-
-
-
-
-
-
- mac2pw
-
-
-
-
- A device password generator that prints a range of MAC address and passwords on stdout. It is an alternative to the Atheros Production Test System (PTS) DBBuilder Utility and toolkit program mac2pwd. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./crypt. See the mac2pw man page for more information.
-
-
-
-
-
-
- mac2pwd
-
-
-
-
- A device password generator that reads files containing MAC addresses and prints address/password pairs. It is an alternative to the Atheros Production Test System (PTS) DBBuilder Utility and toolkit program mac2pw. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./crypt. See the mac2pwd man page for more information.
-
-
-
-
-
-
- rkey
-
-
-
-
- A command line utility to dynamically generate distinct HomePlug AV compliant keys from a user created keyfile. It can be used in shell scripts to dynamically insert random and distinct keys on program command lines as arguments. For example, a Linux bash script can reference "$(rkey -i eth0 -D secret.key)" inline. This program is installed in folder /usr/local/bin with 4555 file permissions. See the discussion on security for more information about file permissions. The main source code is located in folder ./crypt. See the rkey man page for more information.
-
-
-
-
-
-
-
-
-
- MDIO Programming
-
-
-
-
- int6kmdio
-
-
-
- A command line utility that uses VS_MDIO_COMMAND messages to read and write MDIO registers on a switch chip connected to the local powerline device. MDIO instructions are specified and send as Clause 22 instructions. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./mdio. See the mdioblock man page for more information.
-
-
-
-
-
- int6kmdio2
-
-
-
- A command line utility that uses VS_MDIO_COMMAND messages to read and write MDIO registers on a switch chip connected to the local powerline device. Instructions are read as Clause 45 instructions but send as Clause 22 instructions. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./mdio. See the mdioblock man page for more information.
-
-
-
-
-
- mdioblock
-
-
-
- A command line utility to assemble an Atheros MDIO instruction block from hexadecimal register instructions. MDIO instruction blocks are written to Atheros powerline devices as modules using the VS_MOD_OP message type. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./mdio. See the mdioblock man page for more information.
-
-
-
-
-
- mdioblock2
-
-
-
- A command line utility to assemble an Atheros MDIO instruction block from hexadecimal register instructions. MDIO instruction blocks are written to Atheros powerline devices as modules using the VS_MOD_OP message type. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./mdio. See the mdioblock2 man page for more information.
-
-
-
-
-
- mdiodump
-
-
-
- A command line utility to read and display Atheros MDIO custom modules in human readable format. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./mdio. See the mdiodump man page for more information.
-
-
-
-
-
- mdiogen
-
-
-
- A rudimentary command line utility that write a custom MDIO block to a fixed file. The user must edit a data statements, in the main program, to define MDIO command fields. A series of macros then mask, shift and merge the fields to create complete Clause 22 or Clause 45 MDIO commands on output. The program has no dependencies on other toolkit modules and so it will compile anywhere. This program must be manually compiled and it is not automatically installed. The main source code is located in folder ./mdio and file mdio.h is required for compilation. There are no help files available at this time. If you do not understand how to use it then you may not need it.
-
-
-
-
-
-
-
-
-
- Serial Programming
-
-
-
-
-
- ptsctl
-
-
-
-
- A command line program used to control a bank of three Weeder programmable attenuators. It may be used to construct a Production Test System (PTS) for Qualcomm Atheros SmartLink devices. See program weeder to control a bank of two Weeder programmable attenuators. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./serial. See the ptsctl man page for more information.
-
-
-
-
-
-
- ttycat
-
-
-
-
- A command line program that copies one or more host files to a specific serial port. It can be used to stream serial data to the local UART-enabled powerline device for transmission over powerline. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./serial. See the ttycat man page for more information.
-
-
-
-
-
-
- weeder
-
-
-
-
- A command line program used to control a bank of two Weeder programmable attenuators. It may be used to construct a Production Test System (PTS) for Qualcomm Atheros powerline devices. See program ptsctl to control a bank of three Weeder programmable attenuators. This program is installed in folder /usr/local/bin with 0555 file permissions. The main source code is located in folder ./serial. See the weeder man page for more information.
-
-
-
-
-
- Atheros Communications reserves the right to add, remove or rename utility programs or modify their command line options or their functionality in future software releases without any obligation to notify or compensate users of this software.
-
-
-
-
-
diff --git a/docbook/pseudo.c.html b/docbook/pseudo.c.html
deleted file mode 100644
index 00ca1776..00000000
--- a/docbook/pseudo.c.html
+++ /dev/null
@@ -1,162 +0,0 @@
-
-
-
-
-
- pseudo.c
-
-
-
-
-
-
-
-
-
-/*====================================================================*
- *
- * encapsulate and transmit as many Ethernet frames as possible
- * without overflowing the SPI write buffer;
- *
- *--------------------------------------------------------------------*/
-
-function transmit frame do read write buffer space available register;
-while transmit queue is not empty and write buffer space is available do encapsulate transmit frame;
-write transmit frame to write buffer;
-if error then return failure;
-end if;
-update transmit statistics;
-remove frame from transmit queue;
-end while;
-return (success);
-end function;
-
-/*====================================================================*
- *
- * read as many frames as possible from the read buffer;
- *
- *--------------------------------------------------------------------*/
-
-function receive frame do allocate an input buffer;
-if no memory available then return failure;
-end if;
-read read space available register;
-if read buffer is empty then return failure;
-end if;
-write frame length into buffer size register;
-if mode is legacy then send read command;
-end if;
-while read buffer is not empty do read read buffer into frame buffer;
-extract Ethernet frame from frame buffer;
-update read statistics;
-end while;
-return (success);
-end function;
-
-/*====================================================================*
- *
- * state machine to manage QCA7000 SPI slave synchronization;
- *
- *--------------------------------------------------------------------*/
-
-function synchronize SPI slave do allocate a static reset counter;
-if synchronization state is CPU on then read QCA7000 signature register;
-read QCA7000 signature register;
-if signature is invalid then set synchronization state to unknown;
-else read SPI write buffer space available register;
-if write buffer is empty then qca->SynchState = QCASPI_SYNC_READY;
-set synchronization state to ready;
-return;
-else set synchronization state to unknown;
-end if;
-end if;
-end if;
-if synchronization stats is ready then if mode is legacy then return;
-end if;
-read QCA7000 signature register;
-if signature is invalid then set synchronization state to unknown;
-return;
-end if;
-end if;
-if synchronization state is unknown then if mode is legacy then use GPIO to reset QCA7000;
-else read QCA7000 signature register;
-if signature is invalid then return;
-end if;
-set soc_core_reset bit in QCA SPI configuration register;
-end if set synchronization state to reset;
-clear reset counter;
-return;
-end if;
-if synchronization state is reset then increment reset counter;
-if reset counter exceeds reset limit then set synchronization state to unknown;
-end if;
-end if;
-return;
-end function;
-
-/*====================================================================*
- *
- * handle QCA7000 interrupts and transmit requests; interrupts are
- * from the QCA7000; transmit requests are from the host computer;
- *
- *--------------------------------------------------------------------*/
-
-function interrupt serivce routine do while terminate is false do set thread state to interruptable;
-if no interrupts and synchronization state is synchronized and transmit queue is empty then allow other tasks to run;
-end if set thread state to busy;
-check synchronization state;
-if syncrhonization state is not synchronized then flush transmit queue;
-suspend for a while;
-end if;
-if interrupt occurred then disable SPI interrupts;
-read SPI interrupt cause register;
-if SPI interrupt cause is CPU on then update synchronization state;
-if synchronization state is synchronized then continue;
-end if;
-end if;
-if SPI interrupt cause is packet available then if synchronization state is synchronized then call receive frame function;
-end if;
-end if;
-if SPI interrupt cause is read buffer error then set synchronization state to unknown;
-continue;
-end if;
-if SPI interrupt cause is write buffer error then set synchronization state to unknown;
-continue;
-end if;
-clear SPI interrupt cause register;
-clear SPI interrupt register;
-end if;
-if transmit queue is not empty then call transmit frame function;
-end if;
-end while;
-set thread state to dormant;
-return;
-end function;
-
-/*====================================================================*
- *
- * basic interrupt handler; count interrupts since last service;
- * wake up dormant service routine;
- *
- *--------------------------------------------------------------------*/
-
-function interrupt handler do increment interrupt count;
-if thread is available and thread is dormant then wake up thread to service interrupt;
-end if;
-return (success);
-end function;
-
-
-
-psin(1) Qualcomm Atheros Open Powerline Toolkit psin(1)
-
-NAME
- psin - Import PIB Prescalers
-
-SYNOPSIS
- psin [options] [<stdin] file
-
-SYNOPSIS
- Read an amplitude map from stdin and insert it into a nexisting PIB file, replacing the previous amplitude map. This
- program permits custom amplitude maps to be loaded into a PIB file. It can also pipe a map directly from one PIB file to
- another. Atheros can provide standard amplitude maps (prescalers) that conform to most national or international EMI
- regulations. Generally speaking, these maps should not be modified but there are execeptions.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-CAVEATS
- The Atheros Windows Device Manager determines the type of prescalers stored in the PIB by inspecting the ToneMaskType
- code which is also stored in the PIB but is not part of the prescaler set. If this program is used to store a new
- prescaler set in a PIB and the ToneMaskType code is not updated to reflect the change then the Windows Device Manager
- will continue to display the previous prescaler type. This will confuse Windows Device Manager users. Use program set‐
- pib to set the ToneMaskType code and program pskey to verify the true prescaler type.
-
-OPTIONS
- None.
-
-ARGUMENTS
- file The name of an Atheros Parameter Information Block (PIB) file. The original prescalers are replaced and the
- checksum is re-computed. By convention, PIB files have a .pib extension but this program does not enforce that
- convention and does not make any assumption based on filename or extension but the program will reject invalid PIB
- files. Only one file may be specified on the command line.
-
-FILES
- An amplitude map consists of 1155 frequency-amplitude pairs. Each pair consists of a decimal index and a hexadecimal
- scaler value. The index represents a frequecy from 1.8 mhz through 30 mhz. The scaler represents the amplitude attenua‐
- tion applied at that frequency. The frequency and attenuation are computed as follows.
-
- frequency = (index + 74) / 40.96
- decibels = 20 * log10 (scaler / 256)
-
-EXAMPLE
- The following example loads prescaler file abc.psc into PIB file abc.pib. The ToneMaskType code is not updated by this
- operation and should be updated separately to avoid confusing Windows Device Manager users. Program setpib is one means
- of updating this code.
-
- # psin < abc.psc abc.pib
-
-DISCLAIMER
- PIB file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information is not
- available. Qualcomm Atheros reserves the right to modify PIB file structure or content in future firmware releases with‐
- out any obligation to notify or compensate users of this program.
-
- Tampering with prescaler settings may violate national or international electo-magnetic emission standards and lead to
- fines or penalties. Qualcomm Atheros shall not be held responsible for any consequences of modifications made to
- prescaler sets provided to their customers.
-
-SEE ALSO
- psgraph(7), pskey(1), psout(1), setpib(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 psin(1)
-
-pskey(1) Qualcomm Atheros Open Powerline Toolkit pskey(1)
-
-NAME
- pskey - Print prescaler key
-
-SYNOPSIS
- pskey [options] file [file] [...] [>stdout]
-
-DESCRIPTION
- Read the prescaler section of a .pib file and print the SHA256 digest (key) on stdout. The digest acts as a finger-print
- of the prescalers stored within and may be used to compare prescalers and detect changes. Only the prescaler section is
- read. The rest of the PIB is ignored.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -q Enable quiet mode. This suppresses the filename after prescaler keys on output.
-
- -v Verbose mode. This option has no effect at present. None.
-
-ARGUMENTS
- file The name of an Atheros Parameter Information Block (PIB) file. This file is not modified. By convention, PIB
- files have a .pib extenstion but this program does not enforce that convention but invalid PIB files will be
- rejected on input.
-
-DISCLAIMER
- PIB file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information is not
- available. Qualcomm Atheros reserves the right to modify PIB file structure or content in future firmware releases with‐
- out any obligation to notify or compensate users of this program.
-
-EXAMPLES
- This example prints the SHA256 digest for the prescaler section in file v3.3.4.pib. The digest uniquely identifies that
- particular prescaler set. PIB files with the same prescaler digest contain the same prescaler set.
-
- # pskey v3.3.4.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.3.4.pib
-
- The next example is the same as before but does not print the input filename after the key.
-
- # pskey v3.3.4.pib -q
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4
-
- The next example does the same for all .pib files in the current folder. Observe that several files have the same fin‐
- gerprint and so contain identical prescaler sets. Prescalers are designed to satisfy EMI requirements for various appli‐
- cations and world regions. It is critical that the correct prescalers are used.
-
- # pskey *.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 2008-06-25.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v2.0.4.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.0.1.pib
- 9D6F711B81BEAE3DE9182ECC264C47DDD187264A2B89A162C54F3C1FDD5CE240 v3.0.4.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.0.5.pib
- 9D6F711B81BEAE3DE9182ECC264C47DDD187264A2B89A162C54F3C1FDD5CE240 v3.1.0.pib
- 9D6F711B81BEAE3DE9182ECC264C47DDD187264A2B89A162C54F3C1FDD5CE240 v3.1.3.pib
- 9D6F711B81BEAE3DE9182ECC264C47DDD187264A2B89A162C54F3C1FDD5CE240 v3.1.4.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.1.6.pib
- 9D6F711B81BEAE3DE9182ECC264C47DDD187264A2B89A162C54F3C1FDD5CE240 v3.1.7.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.1.8.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.1.9.pib
- 9D6F711B81BEAE3DE9182ECC264C47DDD187264A2B89A162C54F3C1FDD5CE240 v3.2.0.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.3.0.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.3.1.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.3.2.pib
- 980444623A8B8E76121E5014B054D9D1306C06C4D7FD7E2E158D13C9B24CFDE1 v3.3.4-1.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.3.4-2.pib
- 649C3B280E20A78994D11048C6E2ABEB6BA5DBCBBE3BA2BDD3BA3C3CFF8EF7E4 v3.3.4-RC9.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.3.4.pib
-
- The next example does the same as the previous one but sorts on the digest in order to group files by their prescaler
- sets. This highlights the fact that we have four different prescaler sets in the group and two files are apparently dif‐
- ferent from the others. The sort program is a Linux utility and may not be available on some systems.
-
- # pskey *.pib | sort
- 649C3B280E20A78994D11048C6E2ABEB6BA5DBCBBE3BA2BDD3BA3C3CFF8EF7E4 v3.3.4-RC9.pib
- 980444623A8B8E76121E5014B054D9D1306C06C4D7FD7E2E158D13C9B24CFDE1 v3.3.4-1.pib
- 9D6F711B81BEAE3DE9182ECC264C47DDD187264A2B89A162C54F3C1FDD5CE240 v3.0.4.pib
- 9D6F711B81BEAE3DE9182ECC264C47DDD187264A2B89A162C54F3C1FDD5CE240 v3.1.0.pib
- 9D6F711B81BEAE3DE9182ECC264C47DDD187264A2B89A162C54F3C1FDD5CE240 v3.1.3.pib
- 9D6F711B81BEAE3DE9182ECC264C47DDD187264A2B89A162C54F3C1FDD5CE240 v3.1.4.pib
- 9D6F711B81BEAE3DE9182ECC264C47DDD187264A2B89A162C54F3C1FDD5CE240 v3.1.7.pib
- 9D6F711B81BEAE3DE9182ECC264C47DDD187264A2B89A162C54F3C1FDD5CE240 v3.2.0.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 2008-06-25.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v2.0.4.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.0.1.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.0.5.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.1.6.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.1.8.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.1.9.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.3.0.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.3.1.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.3.2.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.3.4-2.pib
- AF26B02BB5044BE70986A5C2F5705671213D63A7827928C240D131E940EF4FC4 v3.3.4.pib
-
-DISCLAIMER
- PIB file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information is not
- available. Qualcomm Atheros reserves the right to modify PIB file structure or content in future firmware releases with‐
- out any obligation to notify or compensate users of this program.
-
-SEE ALSO
- psgraph(7), psin(1), psout(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 pskey(1)
-
-#!/bin/sh
-# file: scripts/pibnotch.sh
-
-# This is an experimental script used to test dynamic PIB notching;
-# if you do not know what that is then you probably don't need this
-# script;
-
-# ====================================================================
-#
-# --------------------------------------------------------------------
-
-. /etc/environment
-. ${SCRIPTS}/hardware.sh
-. ${SCRIPTS}/firmware.sh
-
-# ====================================================================
-#
-# ETH1 is Host Interface for Device 1
-# ETH2 is Host Interface for Device 2
-#
-# PLD1 is MAC of Powerline Device 1
-# PLD2 is MAC of Powerline Device 2
-#
-# PIB the PIB file used to load prescalars
-# MAP the MAP file used to save tonemaps read from device
-# OLD the OLD prescalars (no notches)
-# NEW the NEW prescalars (with notches)
-#
-# --------------------------------------------------------------------
-
-PIB=abc.pib # the PIB file used to load prescalars
-MAP=tonemap # the MAP file used to save tonemaps read from device
-OLD=scalars # the OLD prescalars (no notches)
-NEW=notches # the NEW prescalars (with notches)
-
-# ====================================================================
-# 1. print message;
-# 2. load OLD prescalars into PIB
-# 3. download and flash PIB
-# --------------------------------------------------------------------
-
-echo
-echo Setup
-echo
-psout ../firmware/v3.3.6.pib > ${OLD}
-psin < ${OLD} ${PIB}
-int6k -i ${ETH2} -P ${PIB} ${PLD1} -C2
-
-# ====================================================================
-# 1. Increment loop counter and print message
-# 2. request tonemap between PLD1 and PLD2; save in MAP
-# 3. read OLD prescalars and write NEW prescalars based on MAP; only
-# notch prescalars 57 through 63 if tone threshold is below 3;
-# 4. load NEW prescalars into PIB;
-# 5. plot prescalars from PIB discarding unwanted lines;
-# 6. print a message
-# 7. download and flash PIB to apply changes;
-# 8. wait some time
-# 9. load OLD prescalars into PIB
-# 10. print a message
-# 11. download and flash PIB to sample changes;
-# 12. wait some time
-# 13. repeat forever;
-# --------------------------------------------------------------------
-
-while [ 1 ]; do
- echo
- echo Check $((++count))
- echo
- int6ktone -qhi ${ETH2} ${PLD1} ${PLD2} > ${MAP}
- psnotch -v -L 40 -U 66 -l 57 -u 62 -t 3 -f ${MAP} < ${OLD} > ${NEW}
- psin < ${NEW} ${PIB}
- psgraph ${PIB} | head -n 66 | tail -n 36
- echo
- echo blocking ...
- echo
- int6k -i ${ETH2} -P ${PIB} ${PLD1} -C2
- sleep 10
- psin < ${OLD} ${PIB}
- echo
- echo sampling ...
- echo
- int6k -i ${ETH2} -P ${PIB} ${PLD1} -C2
- sleep 60
-done
-
-
-
-psout(1) Qualcomm Atheros Open Powerline Toolkit psout(1)
-
-NAME
- psout - Export PIB Prescalers
-
-SYNOPSIS
- psout [options] file [>stdout]
-
-DESCRIPTION
- Export the prescaler section of a PIB file as an amplitude map suitable for input to program psin or the Qualcomm Atheros
- Windows Device Manager. Prescalers are stored in the PIB in binary format but the amplitude map is in text format so
- that values may be changed using an ordinary text editor. Program psin can be used to import an amplitude map into the
- original or another PIB file.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- None.
-
-ARGUMENTS
- file The name of an Atheros Parameter Information Block (PIB) file. This file is not modified. By convention, PIB
- files have a .pib extension but this program does not enforce that convention and does not make any assumption
- based on filename or extension but the program will reject invalid PIB files. Only one filename is permitted on
- the command line.
-
-FILES
- An amplitude map consists of 1155 frequency-amplitude pairs. Each pair consists of a decimal index and a hexadecimal
- scaler. The index represents a frequecy from 1.8 mhz through 30 mhz. The scaler represents the amplitude attenuation
- applied at that frequency. The frequency and attenuation are computed as follows.
-
- frequency = 40.96 * (index + 74)
-
- index = (frequency / 40.96) - 74
-
- decibels = 20 * log10 (scaler / 256)
-
- scaler = 256 * pow (decibels / 20)
-
-EXAMPLES
- The following example prints the prescaler section of file abc.pib on stdout as an amplitude map. The output has been
- abbreviated here to save space. A single comment line identifies the prescaler source file. Output may be directed to a
- text file, edited using a text editor and read into the same or another PIB file with program psin.
-
- # psout abc.pib
- # file: abc.pib
- 00000000 00000000
- 00000001 00000000
- 00000002 00000000
- 00000003 00000000
- ...
- 00000027 000000D0
- 00000028 000000D0
- 00000029 000000D1
- 00000030 000000D1
- ...
- 00000214 00000000
- 00000215 00000000
- 00000216 00000000
- ...
- 00001155 00000000
-
- The next example copies prescalers from file abc.pib to def.pib using a command line pipe.
-
- # psout abc.pib | psin def.pib
-
-DISCLAIMER
- PIB file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information is not
- available. Qualcomm Atheros reserves the right to modify PIB file structure or content in future firmware releases with‐
- out any obligation to notify or compensate users of this program.
-
- Tampering with prescaler settings may violate national or international electo-magnetic emission standards and lead to
- fines or penalties. Qualcomm Atheros shall not be held responsible for any consequences of modifications made to
- prescaler sets provided to their customers.
-
-SEE ALSO
- psgraph(1), pskey(1), psin(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 psout(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * uint16_t psread (uint16_t values [], uint16_t limit, FILE * fp);
- *
- * pib.h
- *
- * read a prescaler file and populate a scaler array;
- *
- *
- *--------------------------------------------------------------------*/
-
-#include <stdio.h>
-#include <ctype.h>
-#include <stdint.h>
-
-#include "../tools/chars.h"
-#include "../tools/error.h"
-#include "../tools/number.h"
-#include "../pib/pib.h"
-
-uint16_t psread (uint16_t values [], uint16_t limit, FILE * fp)
-
-{
- uint16_t index = 0;
- uint16_t count = 0;
- uint32_t value = 0;
- signed c;
- while ((c = getc (fp)) != EOF)
- {
- if (isspace (c))
- {
- continue;
- }
- if ((c == '#') || (c == ';'))
- {
- do
- {
- c = getc (fp);
- }
- while ((c != '\n') && (c != EOF));
- continue;
- }
- index = 0;
- while (isdigit (c))
- {
- index *= 10;
- index += c - '0';
- c = getc (fp);
- }
- if (index != count)
- {
- error (1, ECANCELED, "Carrier %d out of order", index);
- }
- if (index >= limit)
- {
- error (1, EOVERFLOW, "Too many prescalers");
- }
- while (isblank (c))
- {
- c = getc (fp);
- }
- value = 0;
- while (isxdigit (c))
- {
- value *= 16;
- value += todigit (c);
- c = getc (fp);
- }
- values [index] = value;
- while ((c != '\n') && (c != EOF))
- {
- c = getc (fp);
- };
- count++;
- }
- return (count);
-}
-
-
-
-ptsctl(1) Qualcomm Atheros Open Powerline Toolkit ptsctl(1)
-
-NAME
- ptsctl - PTS Module Controller
-
-SYNOPSIS
- ptsctl [options]
-
-DESCRIPTION
- Set attenuation level on the Qualcomm Atheros Production Test System using a local RS-232 communication port. The port
- settings must be configured before running this program. Settings are 9600 baud, no parity, 8 data and 1 stop bit. See
- datasheet http://www.weedtech.com/wtssr-m.pdf for more information.
-
-OPTIONS
- -f file
- The name of the serial port. On Linux, the name is usually "/dev/ttyS[0-4]". On OS/X, the name is usually
- "/dev/cua[0-4]". On Windows, the name is "com[0-9]:". The default is "/dev/ttyS0" on Linux and "com1:" on Win‐
- dows. If environment string "PTSCTL" is defined then it takes precedence over the default serial port. This
- option then takes precedence over either default.
-
- -g attenuation
- The desired line/ground attenation in Decibels. The value may be expressed in decimal, binary, or hexadecimal.
- Binary varues start with "0b" and hexadecimal values start with "0x". The default for this option is 127 dB.
-
- -n attenuation
- The desired line/neutral attenation in Decibels. The value may be expressed in decimal, binary, or hexadecimal.
- Binary varues start with "0b" and hexadecimal values start with "0x". The default for this option is 127 dB.
-
- -p power
- Turn on or off the Device Under Test power. The value of power can be 1=on or 0=off. Alternately, keywords "on"
- and "off" can be used.
-
- -r Read and display undecorated attenuator settings on stdout. Setting appear as two decimal integers representing
- the attenuation in decibels. The line/neutral setting appears first then the line/ground setting. This option is
- independent of options -n and -g. If this option is present and the other are missing then settings are display
- but not changed. If this setting appears with either or both of the other two then the settings are changed then
- read and displayed.
-
- -w wait
- Wait time in milliseconds. Serial I/O operation are slow and a delay is needed after each write operation.
- Unfortunately, different operating systems require different wait times. This options lets you adjust the time.
- The default is 10 milliseconds which should be adequate on most systems.
-
-EXAMPLES
- The following example turns the Device Under Test power on and configures the line/neutral attenuator for 72dB attenua‐
- tion. Line ground attenation is automatically set to 127 dB since it is not specified on the command line. Option -p is
- not necessary if the Device Under Test power is already on.
-
- # ptsctl -p 1 -n 72
-
- The next example configures the controller for 42 dB attenuation on line/neutral and 100 dB on line/ground. There is no
- needed to turn the Device Under Test on again because it remains on until turned off.
-
- # ptsctl -n 42 -g 100
-
- The next example configures the controller for 56 dB attenuation on line/ground and 127 dB on line/neutral, and turns the
- Device Under Test off.
-
- # ptsctl -p off -g 56
-
- The next example reads the atteuator setting and displays them on decimal format on stdout. The line/neutral setting
- appears first then the line/ground setting. In this example, line/neutral has 55 dB attenuation and line/ground has 120
- dB attenuation.
-
- # ptsctl -r
- 55 120
-
- You can also set the attenuation and read it back using one command. The next example sets line/neutral attenuation to
- 10 db and line/ground attenuation to 50 db then reads the attenuator settings and displays them in the standard order,
- line/neutral then line/ground.
-
- # ptsctl -g 50 -r -n 10
- 10 50
-
-REFERENCES
- Information shown above applies to WTSSR-M Solid State Relay Module by Weeder Technologies, 90-A Beal Pkwy NW, Fort Wal‐
- ton Beach FL 32548 USA; Tel +44 850 863 5723.
-
-SEE ALSO
- plc(1), WTSSR-M(1), weeder(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 ptsctl(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2015 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-/*====================================================================*
- *
- * void putpwd (unsigned count, unsigned group, char space);
- *
- * keys.h
- *
- * print a random password on stdout; passwords consist of count
- * letters and digits; optionally, group letters and digits and
- * separate groups with a space character;
- *
- * alphabet is an array of 32 printable password characters;
- * count is the number of characters to be selected from alphabet;
- * group is the grouping factor;
- * space is the group separator;
- *
- * grouping is suppressed when group is zero or greater than or
- * equal to count;
- *
- * Contributors:
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef PUTPWD_SOURCE
-#define PUTPWD_SOURCE
-
-#include <unistd.h>
-#include <stdio.h>
-#include <fcntl.h>
-#include <errno.h>
-
-#include "../tools/types.h"
-#include "../tools/error.h"
-#include "../key/keys.h"
-
-void putpwd (unsigned count, unsigned group, char space)
-
-{
- signed fd;
- if ((fd = open ("/dev/urandom", O_RDONLY)) == -1)
- {
- error (1, errno, "can't open /dev/urandom");
- }
- while (count--)
- {
- static const char alphabet [] =
- {
- '2',
- '3',
- '4',
- '5',
- '6',
- '7',
- '8',
- '9',
- 'A',
- 'B',
- 'C',
- 'D',
- 'E',
- 'F',
- 'G',
- 'H',
- 'J',
- 'K',
- 'L',
- 'M',
- 'N',
- 'P',
- 'Q',
- 'R',
- 'S',
- 'T',
- 'U',
- 'V',
- 'W',
- 'X',
- 'Y',
- 'Z'
- };
- unsigned member;
- if (read (fd, & member, sizeof (member)) != sizeof (member))
- {
- error (1, errno, "can't read /dev/urandom");
- }
- member &= 0x1F;
- putc (alphabet [member % sizeof (alphabet)], stdout);
- if ((count) && (group) && ! (count % group))
- {
- putc (space, stdout);
- }
- }
- close (fd);
- return;
-}
-
-#endif
-
-
-
-
-
-
diff --git a/docbook/qcaspi.xml b/docbook/qcaspi.xml
deleted file mode 100644
index c34d5fcc..00000000
--- a/docbook/qcaspi.xml
+++ /dev/null
@@ -1,814 +0,0 @@
-
-
- Serial Drivers
-
-
-
- Introduction
-
-
- Most Qualcomm Atheros PLC chipsets are Ethernet-to-Powerline bridges but the QCA7000 is a Serial-to-Powerline bridge, ... with a big difference. The QCA7000 expects the host serial stream to be segmented into Ethernet frames where each frame is encapsulated by a distinct serial header and trailer. This means the host can format and transmit, or receive and decode, standard Ethernet 802.3 frames over an ordinary SPI or UART interface thereby enabling full Ethernet or Internet protocol communications over powerline at low cost and low speed. The enabling component here is an Ethernet-to-Serial driver that supports the SPI or UART interface connected to the QCA7000. This section covers such a driver.
-
-
- The example driver described here was written for the Freescale iMX28 board support package running a custom Freescale Linux distribution. As such, we believe that this driver is suitable for the iMX28 processor out of the box but it could be adapted to other processors.
-
-
-
-
-
- Principles of Operation
-
-
- The basic unit of data transfer over MII and powerline is the IEEE 802.3 Ethernet frame. On output, the host must encapsulate each Ethernet frame as shown below before serial transmission to the QCA7000. The QCA7000 strips off the serial header and footer and forwards the frame over powerline.
-
-
-
- SPI Transmit Frame
-
-
- Allocate a 1528-byte buffer to accommodate the largest outgoing serial packet and pad with NUL bytes. Write SOF, compute and write FL, copy the outgoing frame then write EOF. Serially transmit FL + 12 buffer bytes to the QCA7000.
-
-
-
-
-
- Offset
-
-
- Length
-
-
- Symbol
-
-
- Description
-
-
-
-
-
-
- 0x0000
-
-
- 4
-
-
- SOF
-
-
- Start Of Frame. Must be 0xAAAAAAAA.
-
-
-
-
- 0x0004
-
-
- 2
-
-
- FL
-
-
- The Ethernet frame length in little endian format. The frame starts at offset 0x0008 here and includes all fields up to but excluding EOF. The minimum is 60. The maximum is 1518 if VLAN is omitted and 1522 if not.
-
-
-
-
- 0x0006
-
-
- 2
-
-
- RSVD
-
-
- Must be 0x0000. Reserved to ensure 4-byte frame alignment.
-
-
-
-
- 0x0008
-
-
- 6
-
-
- DA
-
-
- Destination address.
-
-
-
-
- 0x000E
-
-
- 6
-
-
- SA
-
-
- Source address. This must not be the MAC address of the powerline device. This must be the MAC address of the local host serial interface as assigned by the SP or UART driver. The PLC device and the associated host interface must have different MAC address.
-
-
-
-
- 0x0014
-
-
- 4
-
-
- VLAN
-
-
- Virtual LAN tag. This field may be omitted.
-
-
-
-
- 0x0018
-
-
- 2
-
-
- ET
-
-
- Ethertype. This field starts at offset 0x0014 if VLAN is omitted.
-
-
-
-
- 0x001A
-
-
- 42 to 1500
-
-
- BODY
-
-
- Frame body. This field starts at offset 0x0016 and ranges from 46 to 1500 bytes if VLAN is omitted.
-
-
-
-
- 0x004A to 0x05F8
-
-
- 4
-
-
- EOF
-
-
- End Of Frame. Must be 0x5555. This field starts at offset 0x0008 plus FL.
-
-
-
-
-
-
-
- SPI Receive Frame
-
-
- The SPI read frame occurs in response to a read interrupt generated by the QCA7000. The host must acknowledge a read interrupt and service it by reading and acting on QCA7000 SPI register values. For incoming frames, the host reads the 32-bit overall packet length reported by the QCA7000 then read that many bytes, stripping off the serial header and footer and forwarding the Ethernet frame to the host.
-
-
- Allocate a 1532-byte buffer to accomodate the largest incoming serial packet. Read LEN to determine the size of the incoming serial packet. Read LEN bytes into the buffer. Beware that LEN is a multiple of 4-bytes so there may be a few trailing NUL bytes in buffer.
-
-
-
-
-
- Offset
-
-
- Length
-
-
- Symbol
-
-
- Description
-
-
-
-
-
-
- 0x0000
-
-
- 4
-
-
- LEN
-
-
- Hardware generated packet length. This field is only generated for SPI packets, not the UART packets.
-
-
-
-
- 0x0004
-
-
- 4
-
-
- SOF
-
-
- Start Of Frame. Must be 0xAAAAAAAA.
-
-
-
-
- 0x0008
-
-
- 2
-
-
- FL
-
-
- Ethernet frame length in little endian format. The frame starts at offset 0x000C here and includes all fields up to but excluding EOF. The minimum length is 60. The maximum is 1518 if VLAN is omitted and 1522 if not.
-
-
-
-
- 0x000A
-
-
- 2
-
-
- RSVD
-
-
- Must be 0x0000. Reserved to ensure 4-byte frame alignment.
-
-
-
-
- 0x000C
-
-
- 6
-
-
- DA
-
-
- Destination address.
-
-
-
-
- 0x0012
-
-
- 6
-
-
- SA
-
-
- Source address. This must not be the MAC address of the powerline device. This must be the MAC address of the local host serial interface as assigned by the SP or UART driver. The PLC device and the associated host interface must have different MAC address.
-
-
-
-
- 0x0018
-
-
- 4
-
-
- VLAN
-
-
- Virtual LAN tag. This field may be omitted.
-
-
-
-
- 0x001C
-
-
- 2
-
-
- ET
-
-
- Ethertype. This field starts offset 0x0018 if VLAN is omitted.
-
-
-
-
- 0x001E
-
-
- 42 to 1500
-
-
- BODY
-
-
- Frame body. This field starts at offset 0x001A and ranges from 46 to 1500 bytes if VLAN is omitted.
-
-
-
-
- 0x004A to 0x05F8
-
-
- 4
-
-
- EOF
-
-
- End Of Frame. Must be 0x5555. This field starts at offset 0x000C plus FL.
-
-
-
-
-
-
-
-
- SPI Serial Driver
-
-
-
- qcaspi_spi_thread
-
-
-
- static int qcaspi_spi_thread
- char void * data
-
-
-
- Manages synchronization with the exteranl QCA7000.
- Handles interrupts fomr the external QCA7000.
- Transmits frames for the transmit queue to the QCA7000.
-
-
-
-
- qcaspi_qca7k_sync
-
-
-
- void qca_qca7k_sync
- char struct qcaspi * qca
- int event
-
-
-
- Keeps track of the current synchonization state.
-
-
-
-
-
-
- Register Functions
-
-
-
- qcaspi_read_register
-
-
-
- uint16_t qcaspi_read_register
- struct qcaspi * qca
- uint16_t reg
-
-
-
- Reads a QCA7000 register and returns register content.
-
-
-
-
- qcaspi_write_register
-
-
-
- void qcaspi_write_register
- struct qcaspi * qca
- uint16_t reg
- uint16_t value
-
-
-
- Write a value into a QCA7000 register.
-
-
-
-
- qcaspi_tx_cmd
-
-
-
- int qcaspi_tx_cmd
- struct qcaspi * qca
- uint16_t cmd
-
-
-
- Transmit a 16-bit command to the QCA7000. This is currently used when performing a legacy DMA read or write.
-
-
-
-
-
-
- Interrupt Functions
-
-
-
- disable_spi_interrupts
-
-
-
- uint32_t disable_spi_interrupts
- struct qcaspi * qca
-
-
-
- Disables interrupts by writing 0 to the QCA7000 INTR_ENABLE register.
-
-
-
-
- enable_spi_interrupts
-
-
-
- uint32_t enable_spi_interrupts
- struct qcaspi * qca
- uint32_t intr_enable
-
-
-
- Enables interrupts specified by writing to the QCA7000 INTR_ENABLE register and returns the previous register value.
-
-
-
-
- qcaspi_intr_handler
-
-
-
- static irqreturn_t qcaspi_intr_handler
- int irq
- void * data
-
-
-
- Called to service interrupts on rising edge of the QCA7000 interrupt line.
-
-
-
-
-
-
- Transmit Functions
-
-
-
- qcaspi_transmit
-
-
-
- int qcaspi_transmit
- struct qcaspi * qca
-
-
-
- Transmit as many frames as possible from the transmit queue.
-
-
-
-
- qcaspi_tx_frame
-
-
-
- int qcaspi_tx_frame
- struct qcaspi * qca
- struct sk_buff * skb
-
-
-
- Transmit a single socket buffer over the SPI interface.
-
-
-
-
- qcaspi_flush_txq
-
-
-
- void qcaspi_flush_txq
- struct qcaspi * qca
-
-
-
- Flush the transmit queue. Typically called when a synchronization issue is detected between the SPI master (host) and SPI slave (QCA7000).
-
-
-
-
-
-
- Receive Functions
-
-
-
- qcaspi_receive
-
-
-
- int qcaspi_receive
- struct qcaspi * qca
-
-
-
- Reads the QCA7000 read buffer bytes register and reads all available data from the QCA7000. Calls function to parse out the individual Ethernet frames and passes them to the Linux kernel protocol stack.
-
-
-
-
-
-
- DMA Functions
-
-
-
- qcaspi_dma_read_burst
-
-
-
- uint32_t qcaspi_dma_read_burst
- struct qcaspi * qca
- uint8_t * buffer
- uint32_t length
-
-
-
- Performs QCA7000 DMA burst read.
-
-
-
-
- qcaspi_dma_read_legacy
-
-
-
- uint32_t qcaspi_dma_read_legacy
- struct qcaspi * qca
- uint8_t * buffer
- uint32_t length
-
-
-
- Performs QCA7000 DMA legacy read.
-
-
-
-
- qcaspi_dma_write_burst
-
-
-
- uint32_t qcaspi_dma_write_burst
- struct qcaspi * qca
- uint8_t * buffer
- uint32_t length
-
-
-
- Called by qcaspi_tx_frame to peform a DMA burst write instead of a legacy write.
-
-
-
-
- qcaspi_dma_write_legacy
-
-
-
- uint32_t qcaspi_dma_write_legacy
- struct qcaspi * qca
- uint8_t * buffer
- uint32_t length
-
-
-
- Called by qcaspi_tx_frame to peform a DMA legacy write instead of a burst write.
-
-
-
-
-
-
- Support Functions
-
-
-
- QcaFrmCreateHeader
-
-
-
- uint32_t QcaFrmCreateHeader
- uint8_t * buffer
- uint16_t length
-
-
-
- Encode buffer with the required SPI header and overall frame length.
-
-
-
-
- QcaFrmCreateFooter
-
-
-
- uint32_t QcaFrmCreateFooter
- uint8_t * buffer
-
-
-
- Encode buffer with the required SPI footer.
-
-
-
-
- QcaFrmFsmInit
-
-
-
- void QcaFrmFsmInit
- QcaFrmHdl * frmHdl
-
-
-
- Initialize the state machine used to decode the incoming QCA7000 byte stream.
-
-
-
-
- QcaFrmFsmDecode
-
-
-
- uint32_t QcaFrmFsmDecode
- QcaFrmHdl * frmHdl
- uint8_t * buffer
- uint16_t length
- uint8_t bytevalue
-
-
-
- Feeds incoming bytes into the state machine and breaks the stream into individual frames. Frames are passed to the Linux kernel.
-
-
-
-
-
-
- Kernel Functions
-
-
-
- qcaspi_netdev_xmit
-
-
-
- int qcaspi_netdev_xmit
- struct sk_buff * skb
- struct net_device * device
-
-
-
- Called by the Linux kernel append outgoing frames to the transmit queue.
-
-
-
-
- qcaspi_netdev_tx_timeout
-
-
-
- void qcaspi_netdev_tx_timeout
- struct net_device * device
-
-
-
- Called by the Linux kernel after the transmit queue has been stopped for an extended period of time.
-
-
-
-
- qcaspi_netdev_uninit
-
-
-
- static void qcaspi_netdev_uninit
- struct net_device * device
-
-
-
- Called when function unregister_netdev is called. For the QCA7000 driver, function qcaspi_mod_exit calls function unregister_netdev.
-
-
-
-
- qcaspi_netdev_get_stats
-
-
-
- struct net_device_stats * qcaspi_netdev_get_stats
- struct net_device * device
-
-
-
- Returns transmit, receive and error statistics associated with the net device. These are the statistics displayed by ifconfig.
-
-
-
-
- qcaspi_netdev_change_mtu
-
-
-
- int qcaspi_netdev_change_mtu
- struct net_device * device
- int new_mtu
-
-
-
- Changes the serial interface MTU size.
-
-
-
-
- qcaspi_netdev_set_mac_address
-
-
-
- static int qcaspi_netdev_set_mac_address
- struct net_device * device
- void * memory
-
-
-
- Sets the serial interface MAC address. Called by ifconfig whenever user types ifconfig qca0 hw ether xx:xx:xx:xx:xx:xx.
-
-
-
-
- qcaspi_netdev_close
-
-
-
- int qcaspi_netdev_close
- struct net_device * device
-
-
-
- Called by ifconfig to disable the network interface.
-
-
-
-
- qcaspi_mod_exit
-
-
-
- static void qcaspi_mod_exit
- void
-
-
-
- Called by the kernel to shutdown the driver module.
-
-
-
-
diff --git a/docbook/qosinfo.c.html b/docbook/qosinfo.c.html
deleted file mode 100644
index e7ec1334..00000000
--- a/docbook/qosinfo.c.html
+++ /dev/null
@@ -1,223 +0,0 @@
-
-
-
-
-
- qosinfo.c
-
-
-
-
-
-
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * qualcomm.h - Qualcomm Definitions and Declarations;
- *
- *. Qualcomm Atheros HomePlug AV Powerline Toolkit
- *: Copyright (c) 2009-2013 by Qualcomm Atheros Inc. ALL RIGHTS RESERVED;
- *; For demonstration and evaluation only; Not for production use.
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef QUALCOMM_HEADER
-#define QUALCOMM_HEADER
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <stdint.h>
-
-/*====================================================================*
- * header constants;
- *--------------------------------------------------------------------*/
-
-#define BROADCAST "FF:FF:FF:FF:FF:FF"
-#define LOCALCAST "00:B0:52:00:00:01"
-
-/*====================================================================*
- * Qualcomm Manufacturer Specific Management Message Types;
- *--------------------------------------------------------------------*/
-
-#define MS_PB_ENC 0x8000
-#define MS_ADC_CAP 0x8004
-#define MS_DISCOVER 0x8008
-
-/*====================================================================*
- * Qualcomm Vendor Specific Management Message Types;
- *--------------------------------------------------------------------*/
-
-#define VS_SW_VER 0xA000
-#define VS_WR_MEM 0xA004
-#define VS_RD_MEM 0xA008
-#define VS_ST_MAC 0xA00C
-#define VS_GET_NVM 0xA010
-#define VS_RSVD_1 0xA014
-#define VS_RSVD_2 0xA018
-#define VS_RS_DEV 0xA01C
-#define VS_WR_MOD 0xA020
-#define VS_RD_MOD 0xA024
-#define VS_MOD_NVM 0xA028
-#define VS_WD_RPT 0xA02C
-#define VS_LNK_STATS 0xA030
-#define VS_SNIFFER 0xA034
-#define VS_NW_INFO 0xA038
-#define VS_RSVD_3 0xA03C
-#define VS_CP_RPT 0xA040
-#define VS_ARPC 0xA044
-#define VS_SET_KEY 0xA050
-#define VS_MFG_STRING 0xA054
-#define VS_RD_CBLOCK 0xA058
-#define VS_SET_SDRAM 0xA05C
-#define VS_HOST_ACTION 0xA060
-#define VS_OP_ATTRIBUTES 0xA068
-#define VS_ENET_SETTINGS 0xA06C
-#define VS_TONE_MAP_CHAR 0xA070
-#define VS_NW_INFO_STATS 0xA074
-#define VS_SLAVE_MEM 0xA078
-#define VS_FAC_DEFAULTS 0xA07C
-#define VS_MULTICAST_INFO 0xA084
-#define VS_CLASSIFICATION 0xA088
-#define VS_RX_TONE_MAP_CHAR 0xA090
-#define VS_SET_LED_BEHAVIOR 0xA094
-#define VS_WRITE_AND_EXECUTE_APPLET 0xA098
-#define VS_MDIO_COMMAND 0xA09C
-#define VS_SLAVE_REG 0xA0A0
-#define VS_BANDWIDTH_LIMITING 0xA0A4
-#define VS_SNID_OPERATION 0xA0A8
-#define VS_NN_MITIGATE 0xA0AC
-#define VS_MODULE_OPERATION 0xA0B0
-#define VS_DIAG_NETWORK_PROBE 0xA0B4
-#define VS_PL_LINK_STATUS 0xA0B8
-#define VS_GPIO_STATE_CHANGE 0xA0BC
-#define VS_CONN_ADD 0xA0C0
-#define VS_CONN_MOD 0xA0C4
-#define VS_CONN_REL 0xA0C8
-#define VS_CONN_INFO 0xA0CC
-#define VS_MULTIPORT_LNK_STA 0xA0D0
-#define VS_EM_ID_TABLE 0xA0DC
-#define VS_STANDBY 0xA0E0
-#define VS_SLEEPSCHEDULE 0xA0E4
-#define VS_SLEEPSCHEDULE_NOTIFICATION 0xA0E8
-#define VS_MICROCONTROLLER_DIAG 0xA0F0
-#define VS_GET_PROPERTY 0xA0F8
-#define VS_SET_PROPERTY 0xA100
-#define VS_PHYSWITCH_MDIO 0xA104
-#define VS_SELFTEST_ONETIME_CONFIG 0xA10C
-#define VS_SELFTEST_RESULTS 0xA110
-#define VS_MDU_TRAFFIC_STATS 0xA114
-#define VS_FORWARD_CONFIG 0xA118
-#define VS_HYBRID_INFO 0xA200
-
-/*====================================================================*
- * module codes for VS_RD_MOD, VS_WR_MOD and VS_MOD_NVM;
- *--------------------------------------------------------------------*/
-
-#define VS_MODULE_MAC (1 << 0)
-#define VS_MODULE_PIB (1 << 1)
-#define VS_MODULE_FORCE (1 << 4)
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * ssize_t readmessage (struct channel const * channel, struct message * message, uint8_t MMV, uint16_t MMTYPE);
- *
- * plc.h
- *
- * wait for a QCA vendor specific message of given MMV and MMTYPE;
- * discard unwanted messages until the desired message arrives or
- * the channel timeout expires; return packet length on success,
- * 0 on timeout or -1 on error;
- *
- * see sendmessage for the send counterpart to this function;
- *
- * a well designed UnwantedMessage function is critical here;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef READMESSAGE_SOURCE
-#define READMESSAGE_SOURCE
-
-#include <sys/time.h>
-#include <memory.h>
-#include <errno.h>
-
-#include "../tools/error.h"
-#include "../tools/timer.h"
-#include "../plc/plc.h"
-
-ssize_t readmessage (struct channel const * channel, struct message * message, uint8_t MMV, uint16_t MMTYPE)
-
-{
- struct timeval ts;
- struct timeval tc;
- ssize_t length;
- if (gettimeofday (& ts, NULL) == - 1)
- {
- error (1, errno, CANT_START_TIMER);
- }
- while ((length = readpacket (channel, message, sizeof (* message))) >= 0)
- {
- if (! UnwantedMessage (message, length, MMV, MMTYPE))
- {
- return (length);
- }
- if (gettimeofday (& tc, NULL) == - 1)
- {
- error (1, errno, CANT_RESET_TIMER);
- }
- if (channel->timeout < 0)
- {
- continue;
- }
- if (channel->timeout > MILLISECONDS (ts, tc))
- {
- continue;
- }
- return (0);
- }
- return (- 1);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * char const * reword (code_t code, struct _code_ const list [], size_t size);
- *
- * symbol.h
- *
- * search a _code_ list by code and return the associated name; return the
- * corresponding name on success or NULL on failure;
- *
- * Contributor(s):
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef REWORD_SOURCE
-#define REWORD_SOURCE
-
-#include <unistd.h>
-#include <string.h>
-
-#include "../tools/symbol.h"
-
-char const * reword (code_t code, struct _code_ const list [], size_t size)
-
-{
- struct _code_ const * item = list;
- while ((unsigned)(item - list) < size)
- {
- if (item->code == code)
- {
- return (item->name);
- }
- item++;
- }
- return (NULL);
-}
-
-#endif
-
-
-
-rkey(1) Qualcomm Atheros Open Powerline Toolkit rkey(1)
-
-NAME
- rkey - HomePlug AV Random Key Generator
-
-SYNOPSIS
- rkey [options] file
-
-DESCRIPTION
- Dynamically generate distinct HomePlug AV compliant keys. A new key is printed on stdout with each program invocation or
- iteration, unless this is suppressed. Key computation is seeded using a 64 ASCII character string stored in a user cre‐
- ated seedfile. The program automatically increments the seedfile string to preserve continuity and uniqueness across
- program invocations, program iterations, console sessions, host reboots and production sites.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -D Uses HomePlug AV rules for computing a Device Access Key (DAK) from a pass phrase. A DAK is 16 bytes expressed as
- 32 hexadecimal digits. This option over-rides any -M and -N options previously specified on the command line.
-
- -L level
- Set security level. The security level is encoded into the NID. Level 0 enables pushbutton pairing. Level 1
- disables it. This option has no effect unless a NID is computed.
-
- -M Uses HomePlug AV rules for computing a Network Membership Key (NMK) from a pass phrase. An NMK is 16 bytes
- expressed as 32 hexadecimal digits. This option over-rides any -D or -N options previsously specified on the com‐
- mand line.
-
- -N Uses HomePlug AV rules for computing a Network Identification Key (NID) from a pass phrase. An NID is 7 bytes
- expressed as 14 hexadecimal digits. This option over-rides any -D or -M options previously specified on the com‐
- mand line.
-
- -n count
- The number of keys to generate and print. This program prints the specified number of distinct keys of the speci‐
- fied type, one key per line. Normally, program output is directed to a file or a pipe when this option is used.
- It is useful for creating a file of random keys.
-
- -o Use the old seedfile string. This option prevents the seedfile string from being incremented before a new key is
- computed. This feature allows additional key types to be computed from the same seedfile string.
-
- -q Enable quiet mode which, for this application, has no effect.
-
- -v Enable verbose mode which, for this application, prints the pass phrase for each key.
-
- --?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- seedfile
- The text file containing the seed string. This file may be any length but only the first 64 characters are sig‐
- nificant. If it is less than 64 characters then it will be extended to 64 characters after the first use. The
- full 64 character string is incremented, character by character, right to left each time this program is run. The
- seedfile string is salted differently for each type of key requested and used to seed the SHA256 key engine. One
- property of the SHA256 algorithm is that small changes in the seed will produce radically different output having
- an extremely small chance of collision.
-
-EXAMPLES
- The following example shows how to create a seedfile. The seedfile acts as the seed for the SHA256 algorithm. The seed
- is then salted (modified) differently for each type of key generated by this program. The seedfile string is then incre‐
- mented and re-written each time the program is executed, unless behaviors is suppressed. Initially, the seedfile must
- contain at least one character or an error will occur.
-
- # echo "My Company Name, Inc." > secret.key
-
- The following example prints an SHA256 key on stdout. An SHA256 key is 256 bits or 32 bytes expressed as 64 hexadecimal
- digits. An SHA256 key is the default output when no key type is specified. SHA256 is a public domain standard, not a
- HomePlug AV standard.
-
- # rkey secret.key
- BFF0F6E3C83CE13829EA7F1F6D25042F4B05052E44C0B801EEA7CD6317F3622E
-
- The following command prints a new Device Access Key (DAK) on stdout using the seedfile secret.key as the seed. The key
- will be different each time this program is executed because the seedfile string is incremented each time.
-
- # rkey -D secret.key
- F084B4E8F6069FF1300C9BDB812367FF
-
- To observe the seedfile string, use option -v. Notice that the seedfile string is 64 characters long and that spaces are
- significant.
-
- # rkey -D secret.key -v
- 89F96BC11480B0E1A37441397695E676 Qualcomm Atheros, Ocala FL [8@Z
-
- The following command prints a new Network Membership Key (NMK) on stdout, instead of a DAK, using the seedfile
- secret.key as the seed. Of course, one could specify another seedfile.
-
- # rkey -M secret.key
- B59319D7E8157BA001B018669CCEE30D
-
- The following command prints 10 random SHA256 keys on stdout. SHA256 keys were printed because no other type of key was
- specified. Program output could have been directed to a file or a pipe for further processing.
-
- # rkey secret.key -n 10
- 780AC153CD47AB01520B5B0246DE7B78584C0413393EDA4430773DED80DDF01A
- C7FF68DB206B1E98B8752CC95296692D45AB3DFA418F5CF5DD13479836FEDD4E
- 127C8E27F4C8AC7DB27EC8F977968F64D950830B8D511B798FA5A20BE807A7E1
- 79E00DBD57A0E22DCEE2C9CF29F3B7DBA95137BEDC8C76EBE3C32BFFA653D136
- AC9B8DA1B480EF0ECD7A734383DC1B0F3886D0959BAE77F30F1F16C069D2FE4A
- B1F57B211EE774B506106DEC90B7D18FE0328377FCFD9A4D523B632DFAEFF87A
- B1C1C746BDC3E45EBE65FC8D5C15D68F41E9981757024A25A4C3261A154BE6F2
- 06E6CCEA8C919162D22CE2ADCB2DDFBDCBB876631CE73F48525EC27E435934E9
- F26C0636C6B2D51956D04AD73DE03BE6D112661040CB23DD74922C6E05EC7E6B
- A62219B0BBABA1DBC444574D0D73A52954847E6DB2BE44441C73E12B9F8EA6E7
-
- The following three commands use the -o option to prevent the seedfile from being incremented before or after the key is
- computed. Notice that a DAK is first generated then regenerated again. The third command generates an NMK using the
- same seedfile value used to compute the previous two keys.
-
- # rkey -D secret.key
- B12E8BA7B0FF31D107BE15E96EF65B86
- # rkey -oD secret.key
- B12E8BA7B0FF31D107BE15E96EF65B86
- # rkey -oM secret.key
- FAD7EA3713497F2E134299FF1118F6B0
-
- This utterly useless example demonstrates how to generate 10 identical device access keys by suppressing the normal
- string increment between each key computation.
-
- # rkey -oDn 10 secret.key
- B12E8BA7B0FF31D107BE15E96EF65B86
- B12E8BA7B0FF31D107BE15E96EF65B86
- B12E8BA7B0FF31D107BE15E96EF65B86
- B12E8BA7B0FF31D107BE15E96EF65B86
- B12E8BA7B0FF31D107BE15E96EF65B86
- B12E8BA7B0FF31D107BE15E96EF65B86
- B12E8BA7B0FF31D107BE15E96EF65B86
- B12E8BA7B0FF31D107BE15E96EF65B86
- B12E8BA7B0FF31D107BE15E96EF65B86
- B12E8BA7B0FF31D107BE15E96EF65B86
-
- This example demonstrates how to assign distinct keys to script variables or insert them on a command line using this
- program. Read the GNU bash manual for more information on shell scripting. See the modpib man page for an explanation
- of program options shown.
-
- # DAK=$(rkey -D secret.key)
- # NMK=$(rkey -M secret.key)
- # echo DAK=${DAK} NMK=${NMK}
- # modpib -D $(rkey -D secret.key) -N ${NMK}
-
-RECOMMENDATIONS
- The seedfile is critical to the continuity and uniqueness of generated keys. The 64 character string stored in the seed‐
- file is incremented, character by character, right to left, with each file access unless that behavior is suppressed
- using the -o option. The SHA256 algorithm generates radially different output given minor changes in this string. The
- key space is huge and the probability of collision is statistically small.
-
- Be aware that two seedfiles containing the same start string will generate the same key sequence. To minimize the chance
- of duplicate key values across production lines, each production line should use seedfiles having different start
- strings. The length of the start string is not important but it should be different for each production line. If a
- seedfile is lost, merely replace it with another one, as though you are opening another production line.
-
- Mathematically, the shorter the start string the longer it will take for two different seedfiles to coincidentally pro‐
- duce identical output. From 12 to 24 character is a reasonable length but this is not a restriction. If you have sev‐
- eral production lines, you may want to maintain a record of the start strings used on each line in case a new seedfile
- must be created.
-
-REFERENCES
- See the HomePlug AV Specification for more information on encryption keys, pass phrases and hash algorithms used and
- standard FIPS180-2 sec 5.3.2 for more information on SHA256 encoding.
-
-DISCLAIMER
- Qualcomm Atheros reserves the right to modify program names, functionality, input format or output format in future tool‐
- kit releases without any obligation to notify or compensate toolkit users.
-
-SEE ALSO
- hpavkey(1), hpavkeys(1), keys(1), mac2pw(1), mac2pwd(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com> ]
-
-open-plc-utils-0.0.3 Mar 2014 rkey(1)
-
-sada(1) Qualcomm Atheros Open Powerline Toolkit sada(1)
-
-NAME
- sada - slave authorization/deauthorization
-
-SYNOPSIS
- sada [options] [...]
-
-DESCRIPTION
-OPTIONS
- -e Redirects stderr messages to stdout. By convention status and error messages are printed on stderr while primary
- program output is printed on stdout. This option prints all output on stdout in cases where this is desired. -q
- Suppresses status messages on stderr.
-
- -v Print additional information on stdout. In particular, this option dumps incoming and outgoing packets which can
- be saved as text files for reference.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
-EXAMPLES
- None.
-
-REFERENCES
- See the Qualcomm Atheros Powerline Firmware Technical Reference Manual for more information about MDU powerline configu‐
- ration.
-
-DISCLAIMER
- None.
-
-SEE ALSO
- plc(1), mdustats(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 sada(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * sada.c - Slave Membership Manager;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*"
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <unistd.h>
-#include <stdlib.h>
-#include <stdint.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#include "../tools/getoptv.h"
-#include "../tools/putoptv.h"
-#include "../tools/memory.h"
-#include "../tools/number.h"
-#include "../tools/symbol.h"
-#include "../tools/types.h"
-#include "../tools/flags.h"
-#include "../tools/files.h"
-#include "../tools/error.h"
-#include "../plc/plc.h"
-#include "../key/HPAVKey.h"
-#include "../ram/sdram.h"
-#include "../pib/pib.h"
-#include "../nvm/nvm.h"
-
-/*====================================================================*
- * custom source files;
- *--------------------------------------------------------------------*/
-
-#ifndef MAKEFILE
-#include "../plc/Confirm.c"
-#include "../plc/Display.c"
-#include "../plc/Failure.c"
-#include "../plc/Request.c"
-#include "../plc/ReadMME.c"
-#include "../plc/SendMME.c"
-#include "../mme/UnwantedMessage.c"
-#include "../plc/SlaveMembership.c"
-#include "../plc/Devices.c"
-#endif
-
-#ifndef MAKEFILE
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-#include "../tools/uintspec.c"
-#include "../tools/hexdump.c"
-#include "../tools/hexencode.c"
-#include "../tools/hexdecode.c"
-#include "../tools/todigit.c"
-#include "../tools/synonym.c"
-#include "../tools/error.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/MMECode.c"
-#include "../mme/EthernetHeader.c"
-#include "../mme/QualcommHeader.c"
-#endif
-
-/*====================================================================*
- * program constants;
- *--------------------------------------------------------------------*/
-
-#define SADA_AUTH_MODE 0
-#define SADA_RETRY_TIME 0
-
-/*====================================================================*
- *
- * void manager (struct plc * plc, signed count, signed pause);
- *
- * perform operations in logical order despite any order specfied
- * on the command line; for example read PIB before writing PIB;
- *
- * operation order is controlled by the order of "if" statements
- * shown here; the entire operation sequence can be repeated with
- * an optional pause between each iteration;
- *
- *
- *--------------------------------------------------------------------*/
-
-static void manager (struct plc * plc, signed count, signed pause)
-
-{
- while (count--)
- {
- SlaveMembership (plc);
- sleep (pause);
- }
- return;
-}
-
-/*====================================================================*
- *
- * int main (int argc, char const * argv[]);
- *
- * parse command line, populate plc structure and perform selected
- * operations; show help summary if asked; see getoptv and putoptv
- * to understand command line parsing and help summary display; see
- * plc.h for the definition of struct plc;
- *
- * the command line accepts multiple MAC addresses and the program
- * performs the specified operations on each address, in turn; the
- * address order is significant but the option order is not; the
- * default address is a local broadcast that causes all devices on
- * the local H1 interface to respond but not those at the remote
- * end of the powerline;
- *
- * the default address is 00:B0:52:00:00:01; omitting the address
- * will automatically address the local device; some options will
- * cancel themselves if this makes no sense;
- *
- * the default interface is eth1 because most people use eth0 as
- * their principle network connection; you can specify another
- * interface with -i or define environment string PLC to make
- * that the default interface and save typing;
- *
- *
- *--------------------------------------------------------------------*/
-
-int main (int argc, char const * argv [])
-
-{
- extern struct channel channel;
- static char const * optv [] =
- {
- "A:a:ei:qt:vx",
- "device [device] [...] [> stdout]",
- "Qualcomm Atheros Slave Membership Manager",
- "A x\tslave MAC address",
- "a n\tauthorization mode is n [" LITERAL (SADA_AUTH_MODE) "]\n\t0 = retain slave in AVLN\n\t1 = eject slave from AVNL\n\t2 = eject slave from AVLN and associates with next master",
- "e\tredirect stderr to stdout",
-
-#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
-
- "q\tquiet mode",
- "t n\tassociation retry time [" LITERAL (SADA_RETRY_TIME) "]",
- "v\tverbose mode",
- "x\texit on error",
- (char const *) (0)
- };
-
-#include "../plc/plc.c"
-
- signed loop = 1;
- signed wait = 0;
- signed c;
- if (getenv (PLCDEVICE))
- {
- channel.ifname = strdup (getenv (PLCDEVICE));
- }
- optind = 1;
- plc.pushbutton = SADA_AUTH_MODE;
- plc.module = SADA_RETRY_TIME;
- while ((c = getoptv (argc, argv, optv)) != -1)
- {
- switch (c)
- {
- case 'A':
- if (!hexencode (plc.RDA, sizeof (plc.RDA), (char const *)(optarg)))
- {
- error (1, errno, PLC_BAD_MAC, optarg);
- }
- break;
- case 'a':
- plc.pushbutton = (uint32_t)(uintspec (optarg, 0, 2));
- break;
- case 'e':
- dup2 (STDOUT_FILENO, STDERR_FILENO);
- break;
- case 'i':
-
-#if defined (WINPCAP) || defined (LIBPCAP)
-
- channel.ifindex = atoi (optarg);
-
-#else
-
- channel.ifname = optarg;
-
-#endif
-
- break;
- case 'q':
- _setbits (channel.flags, CHANNEL_SILENCE);
- _setbits (plc.flags, PLC_SILENCE);
- break;
- case 't':
- plc.module = (uint32_t)(uintspec (optarg, 0, 0x0F));
- break;
- case 'v':
- _setbits (channel.flags, CHANNEL_VERBOSE);
- _setbits (plc.flags, PLC_VERBOSE);
- break;
- case 'x':
- _setbits (plc.flags, PLC_BAILOUT);
- break;
- default:
- break;
- }
- }
- argc -= optind;
- argv += optind;
- openchannel (&channel);
- if (!(plc.message = malloc (sizeof (* plc.message))))
- {
- error (1, errno, PLC_NOMEMORY);
- }
- if (!argc)
- {
- manager (&plc, loop, wait);
- }
- while ((argc) && (* argv))
- {
- if (!hexencode (channel.peer, sizeof (channel.peer), synonym (* argv, devices, SIZEOF (devices))))
- {
- error (1, errno, PLC_BAD_MAC, * argv);
- }
- manager (&plc, loop, wait);
- argv++;
- argc--;
- }
- free (plc.message);
- closechannel (&channel);
- return (0);
-}
-
-
-
-
-
-
diff --git a/docbook/scripting.xml b/docbook/scripting.xml
deleted file mode 100644
index 6a37c015..00000000
--- a/docbook/scripting.xml
+++ /dev/null
@@ -1,386 +0,0 @@
-
-
- Scripting
-
-
-
- Introduction
-
-
- The Open Powerline Toolkit comes with a variety of example scripts in the scripts folder. They have proven useful to Atheros engineers but may not satisfy your specific needs. This chapter explains how some of these scripts work so that you can modify them to do what you need to do. Most scripts covered in this chapter are intended for a Powerline Workstation.
-
-
- Atheros provides GNU bash scripts as examples and does not guarantee that they are suitable in any or all situations. Furthermore, Atheros may not always update them to reflect changes to toolkit programs. Toolkit command line syntax may change from one release to the next and so Atheros cannot guarantee that older scripts will work with newer programs. The scrips are small, simple and well organized. Do not run them until you have read them and understand what they do and how they work.
-
-
- Sample scripts are available in the scripts folder. Some extremely useful ones are flash.sh, upgrade.sh and traffic.sh. They all reference files hardware.sh and firmware.sh.
-
- Although Toolkit programs run under Windows their power is realized through scripts. Scripting requires environmental support for sophisticated symbol substitution and expansion. Most Linux shells are suitable but Microsoft DOS is not. On Windows, consider using installing Cygwin and using their bash shell. Scripting languages Tcl and Python are suitable alternatives. Another alternative is to write small Windows programs that format and execute the DOS shell commands you want.
-
-
-
-
- Linux Script Basics
-
-
- We summarize some scripting rules here for those who may not be familiar with Linux scripting. If you do not understand the rules or the syntax or have questions then you should consult Linux documentation available on the internet.
-
-
- On Linux, all commands typed in a console window are read and interpreted by a command interpreter called a shell program. The are several shell programs available for Linux but we use bash exclusively. If you elect to use a different shell program, like csh, then you will probably need to modify our scripts.
-
-
- If you do not set execute permissions you must submit it to the shell for execution. If you set execute permissions on a script file then you can execute it directly by typing the filename. You can set execute permission on Linux with the chmod utility as shown in the example below.
-
-
-
- The example above show how to run a script file using bash when it does not have execute permissions set. It then shows how to set the execute permissions and run it directly without using bash.
-
-
- It is good practice to insert a bang-path on the first line of a script to ensure is is executed by the correct shell program, regardless of the shell used to open the script. It is possible to open a script with one shell and have it execute under another shell.
-
-
-
- The next example shows an example bang-path. The first two characters inform the shell that this file contains scripting commands. The remainder of the bang-path line includes a program path with any options and arguments needed by the program. The shell will invoke that program and pass the rest of the script file to the program as standard input.
-
-
- Symbols are defined with the symbol name then an equals sign then the definition text. By convention, symbol names use uppercase letters. The definition consists of all characters from the equals sign to the line end. If a definition contains white space, enclose it in quotes so that it is treated as one string when expanded. Symbol scope ends with the defining file unless it is exported.
-
-
-
- To reference a symbol, precede the variable name with a dollar sign. Atheros scripts go one step further by enclosing the symbol name is braces. This improves readability and simplifies global search-and-replace operations.
-
-
-
-
-
- Host Independence
-
-
- Different hosts may use interfaces for different purposes. For example, one host might use eth0 for local network communications and eth1 for powerline communications. Another host might do the opposite. A portability problem is created when scripts use the literal interface names on the command line, as illustrated below:
-
-
-
-
-
- The commands shown above will work on a host where eth1 and eth2 are used for powerline communications but will not work on another host where eth1 or eth2 are configured differently. Editing scripts can become a chore when they contain many interface references. One solution is the consistent use of symbols. For example, the following example provides some degree of portability.
-
-
-
-
-
- The commands shown above are an improvment because symbols NIC1 and NIC2 can be edited once; however, if you frequently move many scripts from one host to another then each script must be changed. That can also become a chore. A better solution is to define the symbols NIC1 and NIC2 once in a single file and then include the definitions in scripts that need them. For example, if we created file hardware.sh like so ...
-
-
-
-
-
- ... then we could include it in one or more other scripts, like so ...
-
-
-
-
-
- On Linux, the . command causes the named file to be included in-line as though it were part of the including file. This elminates the need to export symbol definitions. A full discussion of Linux environment variable scope can be found on the internet. The point is that each host should have it's own definitions files stored in a common folder so that other scripts can include them and reference them in a consistent manner.
-
-
- Atheros example scripts include two definitions files: hardware.sh and firmware.sh. File hardware.sh defines hardware related symbols as shown below and file firmware.sh defines firmware and configuration filenames. They reside in a scripts folder and relative path is used to access them. This has proven to work well in most situations.
-
-
-
- hardware.sh
-
-
-
- You should create a hardware.sh file in a common folder on each host where you want to execute toolkit scripts. In this way, a script created on one host can be executed on another host without modification.
-
-
-
-
- File hardware.sh assigns specific values to symbols that are used in many of the scripts found in the scripts folder. Some Atheros scripts uses all these symbols and some do not. By convention, NIC1 and NIC2 name the Ethernet interfaces connected to a Golden Node and Device Under Test. MAC1 and MAC2 are the hardware addresses of NIC1 and NIC2, respectively. These symbols can be referenced in scripts with references like ${NIC1} or ${MAC1}. Of course, you could define other symbols here, as well. See the script under Device Upgrade as one example of how file hardware.sh can be included in another script.
-
-
- Some scripts, such as flash.sh and upgrade.sh, only operate on one device and do not need to define both NIC1 and NIC2. By convention, these scripts reference interface DUT only.
-
-
-
-
- firmware.sh
-
-
- You should create a firmware.sh file in a common folder on each host where you want to execute toolkit scripts. In this way, a script created on one host can be executed on another host without modification.
-
-
-
-
- File firmware.sh assigns specific filenames to symbols that are used in some of the scripts found in the scripts folder. Some Atheros scripts use all of these symbols and some do not. By convention, CFG defines the SDRAM configuration file used to initialize an INT6000 or INT6300 device, PIB defines the Parameter Information Block file to be used and NVM defines the firmware image file to be used.
-
-
- This file is especially useful when working with a specific version of firmware. If there are multiple definitions for a symbol, the last definition is the one that takes effect. At Atheros, this file often contains dozens of definitions and we merely move or copy the ones we want to the end of the file. Our custom scripts then operate on the same configuration, parameter and firmware files until we reorder the definitions in firmware.sh.
-
-
-
-
-
- Checking Device Connection
-
-
- You may want to confirm that a device is actually connected to an Etherenet interface before attempting to run a script. Program int6kwait can be used for this purpose. We often print a brief message to alert the operator that there is no connection or the device has no power applied.
-
-
-
- In the above example, we invoke int6kwait to poll the device connected to a specific Ethernet interface (-i) until the firmware starts (-s). The program will return a non-zero return value (-x) if the device does not start within a given period of time. By default, the timeout period is 60 seconds. On return, we check the return code then print an error message and exit the script on timeout. Symbol NIC1 must be defined earlier in the script, possibly in hardware.sh.
-
-
-
-
- Random Device Identity
-
-
- Some Atheros scripts need random MAC, DAK or NMK strings as arguments to Toolkit programs. Program rkey can be used for this purpose. We demonstrate one way to define symbols here and demonstrate how to use symbols later on.
-
-
-
- The first statement, above, uses program rkey to read file secret.key and compute a random DAK (-D). The ouput string is assigned to symbol DAK. The second statement uses program rkey to read the file secret.key and compute a random NMK (-M). The output is assigned to symbol NMK.
-
-
-
-
- Actual Device Identity
-
-
- Some scripts need actual MAC, DAK or NMK strings as arguments to Toolkit programs. Program int6kid can be used for this purpose. We demonstrate one way to define symbols here and demonstrate how to use them later on.
-
-
-
-
- The first statement, above, uses program int6kid to echo the DAK (-D) from the device connected to Ethernet interface NIC1 and assign the output to symbol DAK. The second statement uses program int6kid to echo the NMK (-M) of the device connected to Ethernet interface NIC1 and assign the output to symbol NMK.
-
-
-
-
- Editing a PIB
-
-
- Many scripts place a device in a known state by editing a PIB file and writing it to the device before starting an operation. Program modpib can be used for this purpose. It is safe because only certain values can be changed and, where necessary, certain cross-parameter computations are performed automatically.
-
-
-
- The example above uses modpib to set the CCo state (-C), the MAC address (-M), the DAK (-D) and the NMK (-N) in the defined PIB file. Argument 0 means CCo Auto and argument next increments the MAC address. The DAK and NMK were defined earlier in the script. Symbol PIB must be defined earlier in the script, possibly in firmware.sh.
-
-
- Program modpib will print an error message and return a non-zero value on error. We test the return value and exit the script on error to avoid subsequent errors. One could, of course, suppress normal output (-q) and print your own error message using the Linux echo utility.
-
-
-
-
- Initialize a Device
-
-
- Initializing a device involves downloading memory configuration parameters, runtime firmware and runtime parameters into SDRAM and then starting the runtime firmware to make the device fully functional. Program int6kf can be used for this purpose when the INT6000 Softloader or INT6300 Bootloader is running. Additionally, program int6kf can be used to flash blank or corrupted NVRAM once runtime firmware has started.
-
-
- Device initialization is only necessary when a device that has no NVRAM or has corrupted NVRAM or has a Softloader stored in NVRAM. It is only possible when either the INT6000 Softloader or INT6300 Bootloader is running. See The Boot Process for detailed information.
-
-
-
- The example above uses program int6kf to download an SDRAM configuration file (-C), PIB file (-P) and NVM file (-N) then start firmware execution. Symbols NIC1, CFG, PIB and NVM must be defined earlier in the script, perhaps in files hardware.sh and firmware.sh.
-
-
- Program int6kf returns a non-zero value on error. We can check the return code and exit the script on error to avoid subsequent errors. We could, of course, suppress normal output (-q) and print our own error message using the Linux echo utility.
-
-
- In some cases, we may want to flash a blank or corrupted NVRAM after the runtime firmware has started. We could use program int6k for this purpose but program int6kf can be used, as well. Essentially, it initializes the device (as above) then downloads the PIB and NVM files again and flashes them into NVRAM.
-
-
-
- The example above initializes a device with an SDRAM configuration file (-C), PIB file (-P) and NVM file (-N) as before. Once the runtime firmware has started, the PIB and NVM files are downloaded again and flashed (-FF) into NVRAM.
-
-
- The force-flash option (-FF) is needed in this case because runtime firmware that has been written directly to SDRAM and started by the local host assumes there is no NVRAM present to flash or there might be Softloader firmware stored in NVRAM that must be protected from accidental flashing. Runtime firmware that has been read from NVRAM need not make that assumption.
-
-
-
-
- Update a Device
-
-
- In some cases we want to replace the runtime firmware or runtime parameters stored in NVRAM. Program int6k can be used for this purpose when runtime firmware is running.
-
-
- A device update may be necessary when new runtime firmware or new runtime parameters or both must be programmed into NVRAM. It is only possible when NVRAM is present and the runtime firmware is running.
-
-
-
- The example above uses int6k to download a PIB file (-P) and NVM file (-N) then flash NVRAM (-F). Symbol NIC1 must be defined earlier in the script, perhaps in file hardware.sh. Symbols PIB and NVM must also be defined earlier in the script, perhaps in file firmware.sh.
-
-
- Program int6k returns a non-zero value on error. We can check the return code and exit the script on error to avoid subsequent errors. We could, of course, suppress normal output (-q) and print our own error message using the Linux echo utility.
-
-
-
- In some cases, you may want to preserve the current firmware on a device and update only the PIB. Program int6k can be used for this purpose, as well.
-
-
-
- The example above downloads a PIB file (-P) and commits (-C) the PIB only to NVRAM. There are a variety of device flash scenarios and each requires some varation on one of the examples shown here.
-
-
-
-
- Generating Powerline Traffic
-
-
- Once two devices associate, you must send data across the powerline in both direction so that each device can compute a TX and RX PHY rate. One method is to use the efsu program that comes with the Toolkit. The program is designed to send free-form Ethernet frames for test and debug purposes but we can also use it to send lots of junk frames in either direction.
-
-
-
- The example above uses efsu to send the generic Ethernet frame stored in file frame.hex between the two Ethernet interfaces NIC1 and NIC2 (-i). In this example, NIC1 and NIC2 are both installed in the host. We have efsu insert the host source address in the OSA field (-h) and destination address in the ODA field (-d) of each frame as it is sent. The entire operation sends the same frame 1000 times (-l) in each direction, twice.
-
-
- Other methods of generating bi-directional traffic can be used but this method is simple, needs nothing other than the toolkit programs and permits easy synchronization. Program efsu is designed to send custom Etherenet frames, not measure or control data rates, but the toolkit includes open source program ttcp which is designed to measure and control data rates.
-
-
-
-
- Reading PHY Rates
-
-
- Atheros powerline devices automatically compute their average PHY rate which can be read and displayed. Average PHY rate is an indication of performance and can be affected by attenuation and ambient powerline noise. Program int6krate is designed to report the average PHY rate.
-
-
-
- The example above uses int6krate to read and display the average TX and RX PHY rates for the device connected to Ethernet interface NIC2. Option -n requests PHY rates. Option -x exits with a status that can be tested in the subsequent if statement. Output appears in fix-width columns to facilitate post-processing. Other ways to obtain PHY rates are int6k -m and int6kstat -t.
-
-
-
-
- User Interaction
-
-
- Scripts should be designed, whenever possible, to perform correctly without user intervention but there are cases where user intervention is appropriate. The following example illustrates one bash shell method that only requires user input when default values are wrong.
-
-
-
- First, we define symbol MAC with a default value. The Linux echo utility prints a prompt on the console that includes the symbol value. The trailing newline is suppressed () so that text can be typed immediately after the prompt. The echo command is terminated with semicolon (;) so that another command can be included on the same line. The shell read statement waits for the user to type something and press the enter key. The shell will assign the input to shell variable REPLY. The value of REPLY is evaluated and used to redefine the symbol only if the input was a non-zero length string.
-
-
-MAC Address [00:B0:52:00:BA:BE]:
-
-
- The user will see something like this. If the value is correct the user can press the enter key to generate a zero length string. Otherwise, the user can type the correct value before pressing the enter key.
-
-
-
diff --git a/docbook/sdram.1.html b/docbook/sdram.1.html
deleted file mode 100644
index 019456ab..00000000
--- a/docbook/sdram.1.html
+++ /dev/null
@@ -1,76 +0,0 @@
-
-
-
-
-
- sdram.1
-
-
-
-
-
-
-
-
-
-sdram(1) Qualcomm Atheros Open Powerline Toolkit sdram(1)
-
-NAME
- sdram - Atheros SDRAM Configuration File Generator
-
-SYNOPSIS
- sdram
-
-DESCRIPTION
- The Atheros SDRAM Configuration File Generator creates two INT6300 SDRAM configuration files in the current working
- folder. Either of them may be used as the argument for the int6kf -C option when initializing INT6300 devices. Read the
- int6kf man page for more information.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-BACKGROUND
- Configuration files for the Linux Toolkit have .cfg extensions and consist of 32 binary bytes plus a 32 bit checksum.
- They are difficult to modify but easy to verify. The format requires no conversion on input or output and, consequently,
- it is preferred to that used by the Windows Device Manager.
-
- Configuration files for the Windows Device Manager have .config extensions and consist of 64 hexadecimal ASCII charac‐
- ters. They are easily modified using a text editor but cannot be easily validated. They require ASCII to binary conver‐
- sion on input and binary to ASCII conversion on output. Read the config2cfg man page for more information.
-
-OPTIONS
- There are no options.
-
-EXAMPLES
- The following example writes two files, sdram16mb.cfg and sdram64.cfg, in the current working folder. They will replace
- any existing files having the same names.
-
- # sdram
- writing sdram16mb.cfg
- writing sdram64mb.cfg
-
-DISCLAIMER
- The SDRAM file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information
- is not available. Qualcomm Atheros reserves the right to change the file structure or content in future firmware
- releases without any obligation to notify or compensate users of this program.
-
-SEE ALSO
- config2cfg(1), int6kf(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 sdram(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * sdram.c - create INT6300 sdram configuration files;
- *
- * sdram.h
- *
- * this program writes two sdram configuration files in the current
- * working directory; both files are for Linux toolkit programs and
- * not the Windows Device Manager;
- *
- * one of these sdram configuration blocks must be sent to the
- * INT6300 bootloader with VS_SET_SDRAM before downloading NVM
- * and PIB files;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#include <stdio.h>
-#include <unistd.h>
-#include <stdint.h>
-#include <fcntl.h>
-
-#include "../tools/memory.h"
-#include "../ram/sdram.h"
-
-#ifndef MAKEFILE
-#include "../tools/checksum32.c"
-#endif
-
-#define FILE1 "sdram16mb.cfg"
-#define FILE2 "sdram64mb.cfg"
-
-int main (int argc, char const * argv [])
-
-{
- const uint8_t sdram16mb [32] =
- {
- 0x00,
- 0x00,
- 0x00,
- 0x01,
- 0x68,
- 0x2f,
- 0x14,
- 0x00,
- 0x92,
- 0xd4,
- 0xe1,
- 0x01,
- 0xd6,
- 0x83,
- 0x08,
- 0x00,
- 0x88,
- 0x32,
- 0x00,
- 0x00,
- 0xdb,
- 0x06,
- 0x00,
- 0x00,
- 0x00,
- 0x00,
- 0x00,
- 0x00,
- 0x00,
- 0x00,
- 0x00,
- 0x00
- };
- const uint8_t sdram64mb [32] =
- {
- 0x00,
- 0x00,
- 0x00,
- 0x04,
- 0x88,
- 0x31,
- 0x14,
- 0x00,
- 0x91,
- 0xd4,
- 0xe1,
- 0x01,
- 0xe3,
- 0x2b,
- 0x01,
- 0x00,
- 0x89,
- 0x30,
- 0x00,
- 0x00,
- 0x66,
- 0x03,
- 0x00,
- 0x00,
- 0x00,
- 0x01,
- 0x00,
- 0x00,
- 0x00,
- 0x00,
- 0x00,
- 0x00
- };
- int fd;
- uint32_t checksum;
- if ((fd = open (FILE1, O_CREAT|O_WRONLY|O_TRUNC, 0444)) != -1)
- {
- printf ("writing %s\n", FILE1);
- checksum = checksum32 (sdram16mb, sizeof (sdram16mb), 0);
- write (fd, sdram16mb, sizeof (sdram16mb));
- write (fd, &checksum, sizeof (checksum));
- close (fd);
- }
- if ((fd = open (FILE2, O_CREAT|O_WRONLY|O_TRUNC, 0444)) != -1)
- {
- printf ("writing %s\n", FILE2);
- checksum = checksum32 (sdram64mb, sizeof (sdram64mb), 0);
- write (fd, sdram64mb, sizeof (sdram64mb));
- write (fd, &checksum, sizeof (checksum));
- close (fd);
- }
- return (0);
-}
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * sdram.h - SDRAM definitions and declarations;
- *
- * the first section if an NVM file contains SDRAM parameters used
- * by the bootloader;
- *
- *. Qualcomm Atheros HomePlug AV Powerline Toolkit;
- *: Copyright (c) 2006-2010 by Intellon Corporation; ALL RIGHTS RESERVED;
- *; For demonstration and evaluation only; Not for production use.
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SDRAM_HEADER
-#define SDRAM_HEADER
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <stdint.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#include "../tools/types.h"
-#include "../tools/flags.h"
-
-/*====================================================================*
- * constants;
- *--------------------------------------------------------------------*/
-
-#define SDRAM_SILENCE (1 << 0)
-#define SDRAM_VERBOSE (1 << 1)
-#define SDRAM_BASENAME (1 << 2)
-
-/*====================================================================*
- * variables;
- *--------------------------------------------------------------------*/
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
-typedef struct __packed config_ram
-
-{
- uint32_t SDRAMSIZE;
- uint32_t SDRAMCONF;
- uint32_t SDRAMTIM0;
- uint32_t SDRAMTIM1;
- uint32_t SDRAMCNTRL;
- uint32_t SDRAMREF;
- uint32_t MACCLOCK;
- uint32_t SDRAMRSVD;
-}
-
-config_ram;
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
-/*====================================================================*
- * functions;
- *--------------------------------------------------------------------*/
-
-void sdrampeek (struct config_ram * config_ram);
-void sdramtext (struct config_ram * config_ram);
-int sdramfile (int fd, char const *title, flag_t flags);
-int sdramfileA (int fd, char const *title, flag_t flags);
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * int sdramfile (int fd, char const * filename, flag_t flags);
- *
- * sdram.h
- *
- * open an SDRAM configuration file and validate it by checking the
- * file length; unfortunately there are not many things to check;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SDRAMFILE_SOURCE
-#define SDRAMFILE_SOURCE
-
-#include <unistd.h>
-#include <memory.h>
-#include <fcntl.h>
-#include <errno.h>
-
-#include "../ram/sdram.h"
-#include "../tools/memory.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-
-int sdramfile (int fd, char const * filename, flag_t flags)
-
-{
- uint32_t checksum;
- struct config_ram config_ram;
- memset (&config_ram, 0, sizeof (config_ram));
- if (lseek (fd, 0, SEEK_SET) == -1)
- {
- if (_allclr (flags, SDRAM_SILENCE))
- {
- error (0, errno, "Can't rewind file: %s", filename);
- }
- return (-1);
- }
- if (read (fd, &config_ram, sizeof (config_ram)) != sizeof (config_ram))
- {
- if (_allclr (flags, SDRAM_SILENCE))
- {
- error (0, errno, "Wrong file size: %s", filename);
- }
- return (-1);
- }
- if (read (fd, &checksum, sizeof (checksum)) != sizeof (checksum))
- {
- if (_allclr (flags, SDRAM_SILENCE))
- {
- error (0, errno, "Can't read checksum: %s", filename);
- }
- return (-1);
- }
- if (checksum32 (&config_ram, sizeof (config_ram), checksum))
- {
- if (_allclr (flags, SDRAM_SILENCE))
- {
- error (0, 0, "Bad checksum: %s", filename);
- }
- return (-1);
- }
- if (lseek (fd, 0, SEEK_SET) == -1)
- {
- if (_allclr (flags, SDRAM_SILENCE))
- {
- error (0, errno, "Can't rewind file: %s", filename);
- }
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * int sdramfileA (int fd, char const * filename, flag_t flags);
- *
- * sdram.h
- *
- * open an SDRAM configuration file and validate it by checking the
- * file length; unfortunately there are not many things to check;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SDRAMFILEA_SOURCE
-#define SDRAMFILEA_SOURCE
-
-#include <unistd.h>
-#include <memory.h>
-#include <fcntl.h>
-#include <errno.h>
-
-#include "../ram/sdram.h"
-#include "../tools/memory.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-
-int sdramfileA (int fd, char const * filename, flag_t flags)
-
-{
- uint32_t checksum;
- struct config_ram config_ram;
- memset (&config_ram, 0, sizeof (config_ram));
- if (lseek (fd, 0, SEEK_SET) == -1)
- {
- if (_allclr (flags, SDRAM_SILENCE))
- {
- error (0, errno, "Can't rewind file: %s", filename);
- }
- return (-1);
- }
- if (read (fd, &config_ram, sizeof (config_ram)) != sizeof (config_ram))
- {
- if (_allclr (flags, SDRAM_SILENCE))
- {
- error (0, errno, "Wrong file size: %s", filename);
- }
- return (-1);
- }
- if (read (fd, &checksum, sizeof (checksum)) != sizeof (checksum))
- {
- if (_allclr (flags, SDRAM_SILENCE))
- {
- error (0, errno, "Can't read checksum: %s", filename);
- }
- return (-1);
- }
- if (checksum32 ((uint32_t *)(&config_ram), sizeof (config_ram) >> 2, checksum))
- {
- if (_allclr (flags, SDRAM_SILENCE))
- {
- error (0, 0, "Bad checksum: %s", filename);
- }
- return (-1);
- }
- if (_anyset (flags, SDRAM_VERBOSE))
- {
- if ((filename) && (*filename))
- {
- printf ("------- %s -------\n", filename);
- }
- sdrampeek (&config_ram);
- }
- if (lseek (fd, 0, SEEK_SET) == -1)
- {
- if (_allclr (flags, SDRAM_SILENCE))
- {
- error (0, errno, "Can't rewind file: %s", filename);
- }
- return (-1);
- }
- return (0);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void sdrampeek(const struct config_ram * config_ram);
- *
- * sdram.h
- *
- * print SDRAM configuration on stdout in human-readable format;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SDRAMPEEK_SOURCE
-#define SDRAMPEEK_SOURCE
-
-#include <stdio.h>
-
-#include "../ram/sdram.h"
-#include "../tools/memory.h"
-
-void sdrampeek (struct config_ram * config_ram)
-
-{
- printf ("\tSIZE=0x%08X (%dmb)\n", LE32TOH (config_ram->SDRAMSIZE), LE32TOH (config_ram->SDRAMSIZE)>>20);
- printf ("\tCONF=0x%08X\n", LE32TOH (config_ram->SDRAMCONF));
- printf ("\tTIM0=0x%08X\n", LE32TOH (config_ram->SDRAMTIM0));
- printf ("\tTIM1=0x%08X\n", LE32TOH (config_ram->SDRAMTIM1));
- printf ("\tCNTRL=0x%08X\n", LE32TOH (config_ram->SDRAMCNTRL));
- printf ("\tREF=0x%08X\n", LE32TOH (config_ram->SDRAMREF));
- printf ("\tCLOCK=0x%08X\n", LE32TOH (config_ram->MACCLOCK));
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void sdramtext(const struct config_ram * config_ram);
- *
- * sdram.h
- *
- * print SDRAM configuration on stdout as an ASCII string; this
- * format is suitable input for Atheros Windows Device Manager;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SDRAMTEXT_SOURCE
-#define SDRAMTEXT_SOURCE
-
-#include <stdio.h>
-#include <unistd.h>
-
-#include "../ram/sdram.h"
-#include "../tools/memory.h"
-
-void sdramtext (struct config_ram * config_ram)
-
-{
- printf ("%08X", htonl (config_ram->SDRAMSIZE));
- printf ("%08X", htonl (config_ram->SDRAMCONF));
- printf ("%08X", htonl (config_ram->SDRAMTIM0));
- printf ("%08X", htonl (config_ram->SDRAMTIM1));
- printf ("%08X", htonl (config_ram->SDRAMCNTRL));
- printf ("%08X", htonl (config_ram->SDRAMREF));
- printf ("%08X", htonl (config_ram->MACCLOCK));
- printf ("%08X", htonl (config_ram->SDRAMRSVD));
- return;
-}
-
-#endif
-
-
-
-
-
-
diff --git a/docbook/security.xml b/docbook/security.xml
deleted file mode 100644
index 00b15abc..00000000
--- a/docbook/security.xml
+++ /dev/null
@@ -1,45 +0,0 @@
-
-
- Security
-
-
-
- Introduction
-
-
- HomePlug AV devices support two types of secure access: Network Access and Device Access. Network access requires a Network Membership Key (NMK) that grants a device the right to join and participate in a given HomePlug AV powerline network. Device access requires a Device Access Key (DAK) that grants a local host the right to perform privileged operations on a given device. Both types of keys, the NMK and the DAK, are apparently random 128-bit (or 16-byte) integers. At the network level, any application that can produce the correct NMK or DAK can gain access to the network or the device that demands that key.
-
-
-
-
- Encryption Keys
-
-
- There are many ways to generate keys but some methods are preferred to others. The HomePlug Powerline Alliance has published two algorithms for generating fixed-length, binary keys from human-friendly, variable-length character strings. One method generates an NMK and the other generates a DAK. We call these character strings "pass phrases" or "passwords".
-
-
- Both HomePlug AV algorithms use the widely published SHA256 algorithm that converts variable length input to a statistically unique 256-bit (or 32 byte) digest or signature. It is statistically improbable that two inputs will produce the same output and is would be computationally expensive to determine the input given the output. Although these algorithms are approved by the HomePlug Powerline Alliance, there is no requirement to used them. Many other excellent algorithms exist.
-
-
-
-
- User Passwords
-
-
- Atheros end-user software implements the recommended HomePlug AV algorithms for converting variable-length character strings (passwords) to fixed-length binary values (keys). This ensures that a given password will always produce the same key. It also ensures that no two passwords will produce the same key and that the key cannot be used to determine the password. A given password will also produce a different NMK and DAK.
-
-
- HomePlug AV passwords are 12 to 64 characters long and may contain any ASCII character in the range 0x20 (space) through 0x7E (~). This character set essentially includes all printable characters that can be entered using an English Language keyboard.
-
-
- People frequently confuse the DAK with the device password and the NMK with the network password. The password is a character string and the key is a binary value. The password are for people and the key is for computers.
-
-
-
-
- Password Strategy
-
-
-
-
-
diff --git a/docbook/sendmessage.c.html b/docbook/sendmessage.c.html
deleted file mode 100644
index fbfb2599..00000000
--- a/docbook/sendmessage.c.html
+++ /dev/null
@@ -1,104 +0,0 @@
-
-
-
-
-
- sendmessage.c
-
-
-
-
-
-
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * ssize_t sendmessage (struct channel const * channel, struct message * message, ssize_t length);
- *
- * plc.h
- *
- * send management message over Ethernet in a platform independent
- * fashion; return the number of bytes sent on succes, 0 on timeout
- * or -1 on error;
- *
- * see readmessage for the vendor specific read counterpart to this
- * function;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SENDMESSAGE_SOURCE
-#define SENDMESSAGE_SOURCE
-
-#include <stdint.h>
-
-#include "../plc/plc.h"
-
-ssize_t sendmessage (struct channel const * channel, struct message * message, ssize_t length)
-
-{
- return (sendpacket (channel, message, length));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * ssize_t sendpacket (struct channel const * channel, void * memory, ssize_t extent);
- *
- * channel.h
- *
- * send one packet over a raw packet channel; return the number of
- * bytes sent or -1 on error; dump outgoing packets on stdout when
- * the VERBOSE flag is set;
- *
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SENDPACKET_SOURCE
-#define SENDPACKET_SOURCE
-
-#include <unistd.h>
-
-#include "../ether/channel.h"
-#include "../tools/memory.h"
-#include "../tools/flags.h"
-
-ssize_t sendpacket (struct channel const * channel, void * memory, ssize_t extent)
-
-{
- if (_anyset (channel->flags, CHANNEL_VERBOSE))
- {
- hexdump (memory, 0, extent, stdout);
- }
-
-#if defined (__linux__)
-
- extent = sendto (channel->fd, memory, extent, 0, (struct sockaddr *) (0), (socklen_t) (0));
-
-#elif defined (__APPLE__) || defined (__OpenBSD__)
-
- extent = write (channel->fd, memory, extent);
-
-#elif defined (WINPCAP) || defined (LIBPCAP)
-
- if (pcap_sendpacket (channel->socket, (byte *)(memory), extent))
- {
- extent = -1;
- }
-
-#else
-#error "Unknown Environment"
-#endif
-
- return (extent);
-}
-
-#endif
-
-
-
-setpib(1) Qualcomm Atheros Open Powerline Toolkit setpib(1)
-
-NAME
- setpib - Qualcomm Atheros PIB File Editor
-
-SYNOPSIS
- setpib [options] file base [type data] [type data] [...]
-
-DESCRIPTION
- Replace one or more values in a Qualcomm Atheros powerline parameter (or PIB) file and re-compute the checksum. Values
- are specified as a sequence of type/data pairs. Users must know the offset, length and type of the values they change or
- problems will certainly result. This program makes absolutely no effort to validate offsets or values.
-
- This program can be used to change any PIB value, including those that should not be changed. Be warned that some PIB
- values are derived from, or interact with, other PIB values. Failure to observe such dependencies may diminish perfor‐
- mance or render a device inoperable.
-
- Atheros does not recommend the use of this program to edit PIB parameters because small mistakes can cause big problems.
- In addition, Atheros is under no obligation to provide customers with the offset, length or type of any PIB file parame‐
- ters.
-
- Atheros recommends using program modpib to change device identity parameters and the Windows Device Manager to change
- other parameters whenever possible.
-
- This program handles older Thunderbolt/Lightning parameter files and newer Panther/Lynx parameter files but it has a
- larger footprint that may not be acceptable for embedded systems. In cases where only the older or the newer parameter
- files are used, consider using program setpib1 for an older Thunderbolt/Lightning only version or setpib2 for a newer
- Panther/Lynx only version.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -q Enable quiet mode which has not effect.
-
- -v Print a hexdump of the edited region. Print hexdump headers if this option appears twice. The region window may
- be changed with option -w.
-
- -w window
- The display window in bytes. When option -v is present, PIB information surrounding the edited region is dis‐
- played to provide some sort of context. The edited region appears in the middle of this window. The default win‐
- dow is 32 bytes. This means that the 32 bytes before and the 32 bytes after the edited region are included in the
- display.
-
- -x Repair the checksum. By default, this program does not modify files that fail the size or checksum test on input.
- In addition, it does not re-compute the checksum on output if no data has changed. This option skips the size and
- checksum test on input and re-computes the checksum on output even if no data has changed. This option only works
- on legacy PIB files. It does not work on PIB files having NVM file format.
-
- -?, --help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!, --version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Usethis option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The PIB filename. The file must exist and will be re-written. No assumptions are made based on filename and no
- filename conventions are enforced. This argument is required and must precede the base argument.
-
- base The byte offset where changes will start. The offset is expressed in hexadecimal with (or without) the leading
- "0x". Changes are applied in order, left to right, and offset automatically increments by the correct amount
- after each change is applied. This permits consectuive PIB locations to be changed with one command. This argu‐
- ment is required and must follow the file argument. It must also precede all format/data pairs. Normally, you
- must use multiple setpib commands to change non-consecutive PIB locations but careful use of format skip can
- achive the same results using one command.
-
- type The implied length and encoding of the data. Valid types are byte, word, long, data and hfid. A valid format
- must precede each data item. A byte is 8 bits, a word is 16 bits, a long is 32 bits and a huge is 64 bits. The
- format implies the maximum data value except for format data which is limited by the number of octets entered on
- the command line.
-
- data The information written to the current PIB offset. Integer data may be expressed in binary, decimal or hexadeci‐
- mal but must not exceed the type minimum or maximum. String data may contain any ASCII characters that can be
- entered via keyboard but must be enclosed in quotes when spaces are included. Binary values start with 0b or 0B
- and hexadecimal values start with 0x or 0X.
-
-FORMATS
- byte integer
- A signed or unsigned integer stored as 8 bits or 1 byte. The value is expressed in decimal by default. A binary
- value may be expressed with a 0b prefix. A hexadecimal value may be expressed using a 0x prefix. Negative
- type/data values must appear at the end of the command line, after option "--", to avoid parsing errors. The off‐
- set increments by 1 prior to the next insertion.
-
- word integer
- A signed or unsigned integer stored as 16 bits or 2 bytes. The value is expressed in decimal by default. A
- binary value may be expressed with a 0b prefix. A hexadecimal value may be expressed using a 0x prefix. Negative
- type/data values must appear at the end of the command line, after option "--", to avoid parsing errors. The off‐
- set increments by 2 prior to the next insertion.
-
- long integer
- A signed or unsigned integer stored as 32 bits or 4 bytes. The value is expressed in decimal by default. A
- binary value may be expressed with a 0b prefix. A hexadecimal value may be expressed using a 0x prefix. Negative
- type/data values must appear at the end of the command line, after option "--", to avoid parsing errors. The off‐
- set increments by 4 prior to the next insertions.
-
- huge integer
- A signed or unsigned integer stored as 64 bits or 8 bytes. The value is expressed in decimal by default. A
- binary value may be expressed with a 0b prefix. A hexadecimal value may be expressed using a 0x prefix. The off‐
- set increments by 8 prior to the next insertion. Negative type/data values must appear at the end of the command
- line, after option "--", to avoid parsing errors. This format is only available on hosts that support 64 bit data
- values.
-
- data hex
- A sequence of hexadecimal octets. Octets may be separated by a colon for clarity. The number of octets deter‐
- mines the number of bytes written. The offset increments by the number of bytes written. This is similar to
- "key" and "mac" below but accepts variable length input.
-
- key hex
- A sequence of hexadecimal octets. Octets may be separated by a colon for clarity. The number of octets must con‐
- vert to 16 bytes or an error will occur. The offset increments by 16 prior to the next insertion. This is simi‐
- lar "data" above but accepts only fixed length input. This option may be used to set the DAK, NMK or NVAK values.
-
- mac hex
- A sequence of hexadecimal octets. Octets may be separated by a colon for clarity. The number of octets must con‐
- vert to 6 bytes or an error will occur. The offset increments by 6 prior to the next insertion. This is similar
- "data" above but accepts only fixed length input. This option may be used to set the DAK, NMK or NVAK values.
-
- text string
- An ASCII character string. The string string length determines the number of bytes stored. The string is stored
- with NUL terminator included. It is not padded or truncated. The offset increments by the number of bytes stored
- prior to the next insertion. This option may be used to enter a variable length string.
-
- hfid string
- An ASCII character string. The string is always stored as 64 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 64 bytes prior to the next insertion. This option may be used to enter user, network and manufacturer
- identification strings.
-
- zero count
- An unsigned integer representing the number of consecutive bytes to fill with 0x00. The offset increments by the
- number of bytes written. This option may be used to erase regions of the PIB.
-
- fill count
- An unsigned integer representing the number of consecutive bytes to fill with 0xFF. The offset increments by the
- number of bytes written. This option may be used to erase regions of the PIB.
-
- skip count
- An unsigned integer indicating the number of bytes to skip over before staring another change. Intervening data
- data locations are unchanged.
-
-TR69 DATA TYPES
- accesspassword string
- An ASCII character string. The string is always stored as 257 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 257 prior to the next insertion.
-
- accessusername string
- An ASCII character string. The string is always stored as 33 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 33 prior to the next insertion.
-
- adminpassword string
- An ASCII character string. The string is always stored as 33 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 33 prior to the next insertion.
-
- adminusername string
- An ASCII character string. The string is always stored as 33 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 33 prior to the next insertion.
-
- password string
- An ASCII character string. The string is always stored as 257 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 257 prior to the next insertion.
-
- url string
- An ASCII character string. The string is always stored as 257 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 257 prior to the next insertion.
-
- username string
- An ASCII character string. The string is always stored as 257 bytes. Short strings are padded on the right with
- NUL characters. Long strings are truncated on the right and the last byte is forced to NUL. The offset incre‐
- ments by 257 prior to the next insertion.
-
-EXAMPLES
- The following example edits file abc.pib by writing decimal value 1 at offset 01F7 followed by hexadecimal value
- 00B052BABE01. A partial dump is printed showing 16 bytes before and 16 bytes after the changed data because the default
- display windows is 16 bytes. Unless the change occurs right at the start or end of the file, it will appear in the cen‐
- ter of the display window.
-
- # setpib -v abc.pib 01F7 byte 1 data 00:B0:52:BA:BE:01
- 000001D0 00 00 00 00 00 00 00 00 00 .........
- 000001E0 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
- 000001F0 00 00 00 00 00 00 00 01 00 B0 52 BA BE 01 00 00 ..........R.....
- 00000200 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
- 00000210 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ..............
-
- The following example sets the manufacturer HFID string in PIB file def.pib. HFID strings are 64 characters long and
- either truncated or padded on the right with NUL characters. You may need to enclose the string in quotes it it contains
- spaces.
-
- # setpib -v def.pib 24 hfid "Galactic Software Pirates, Inc."
- 00000000 38 1F 00 00 30 1B EB 04 00 B0 52 00 8...0.....R.
- 00000010 00 66 50 D3 E4 93 3F 85 5B 70 40 78 4D F8 15 AA .fP...?.[p@xM...
- 00000020 8D B7 00 00 47 61 6C 61 63 74 69 63 20 53 6F 66 ....Galactic Sof
- 00000030 74 77 61 72 65 20 50 69 72 61 74 65 73 2C 20 49 tware Pirates, I
- 00000040 6E 63 2E 00 00 00 00 00 00 00 00 00 00 00 00 00 nc..............
- 00000050 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
- 00000060 00 00 00 00 50 D3 E4 93 3F 85 5B 70 40 78 4D F8 ....P...?.[p@xM.
- 00000070 15 AA 8D B7 49 6E 74 65 6C 6C 6F 6E 20 45 6E 61 ....Atheros Ena
- 00000080 62 6C 65 64 bled
-
- The following example displays the contents of PIB file abc.pib without changing any data. The region displayed is 24
- bytes starting at offset 0x24. The format skip specifies the region but does not change it. By default, the 32 bytes
- before and 32 bytes after are included in the display. This technique can be used to inspect a specific portion of a PIB
- file.
-
- # setpib -v abc.pib 24 skip 64
- 00000000 38 1F 00 00 30 1B EB 04 00 B0 52 00 8...0.....R.
- 00000010 00 66 50 D3 E4 93 3F 85 5B 70 40 78 4D F8 15 AA .fP...?.[p@xM...
- 00000020 8D B7 00 00 47 61 6C 61 63 74 69 63 20 53 6F 66 ....Galactic Sof
- 00000030 74 77 61 72 65 20 50 69 72 61 74 65 73 2C 20 49 tware Pirates, I
- 00000040 6E 63 2E 00 00 00 00 00 00 00 00 00 00 00 00 00 nc..............
- 00000050 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
- 00000060 00 00 00 00 50 D3 E4 93 3F 85 5B 70 40 78 4D F8 ....P...?.[p@xM.
- 00000070 15 AA 8D B7 49 6E 74 65 6C 6C 6F 6E 20 45 6E 61 ....Atheros Ena
- 00000080 62 6C 65 64 bled
-
- The next example does the same thing for a negative value. This is tricky because the minus sign will be interpreted as
- the start of another option. We must use "--" to end normal option parsing. This is a POSIX standard feature. See IEEE
- Std 1002.1-2001, Section 12.2, Utility Syntax Guidelines for more an explanation.
-
- # setpib -v abc.pib 1471 -- long -50
- 00001450 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ...............
- 00001460 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
- 00001470 00 CE FF FF FF 00 00 00 00 00 00 00 00 00 00 00 ................
- 00001480 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
- 00001490 00 00 00 00 00 .....
-
- The following example computes a new checksum without changing any data. The filename and an offset are required but no
- other values are needed. This technique can be used to compute a new checksum after modifying the file using software
- that does not update the checksum.
-
- # setpib abc.pib 0 -x
-
-DISCLAIMER
- PIB file structure and content is proprietary to Qualcomm Atheros, Ocala FL USA. Consequently, public information is not
- available. Qualcomm Atheros reserves the right to modify PIB file structure or content in future firmware releases with‐
- out any obligation to notify or compensate users of this program.
-
-SEE ALSO
- chkpib(7), chkpib2(7), getpib(7), modpib(1), pib2xml(1), pibcomp(1), pibdump(1), xml2pib(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com> ]
-
-open-plc-utils-0.0.3 Mar 2014 setpib(1)
-
-/*====================================================================*
- *
- * sizes.h - common data size definitions and declarations;
- *
- * Motley Tools by Charles Maier <cmaier@cmassoc.net>;
- * Copyright 2001-2006 by Charles Maier Associates;
- * Licensed under the Internet Software Consortium License;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SIZES_HEADER
-#define SIZES_HEADER
-
-#define _ADDRSIZE 0x0008
-#define _NAMESIZE 0x0100
-#define _LINESIZE 0x1000
-
-#endif
-
-
-
-
-
-
diff --git a/docbook/slac-config.xml b/docbook/slac-config.xml
deleted file mode 100644
index b0a12294..00000000
--- a/docbook/slac-config.xml
+++ /dev/null
@@ -1,227 +0,0 @@
-
-
- SLAC Configuration
-
-
- Avitar can be used to configure a PLC device as either a normal PLC station or a SLAC PEV-PLC or SLAC EVSE-PLC station. In doing so, Avitar changes several PIB values at the same time. This section illustrates how to configurat a PIB the same way using the toolkit.
-
-
- The HomePlug Green PHY Specification refers to the APCM_SET_CCO.REQ and APCM_CONF_SLAC primatives in the SLAC protocol description. These are virtual operations to be implemented by the user. In both cases, one must read the PIB from the PLC device, edit the PIB, recompute PIB checksums and write the PIB back to the PLC device. This can be done manually, using Avitar, or in a script, using the Powerline Toolkit as shown below, or programatically, using custom software.
-
-
-
-
-
- The following shell script converts a factory PIB to a SLAC PEV by setting the CCO Mode to Never and the SLAC Mode to PEV. The User HFID is set to PEV for role identification, optionally. This PIB must be written into PEV-PLC flash memory for proper operation.
-
-
-#!/bin/sh
-# file: pev.sh
-# ========================================================================
-# convert a factory PIB to a SLAC PEV PIB by changing these PIB settings;
-# ------------------------------------------------------------------------
-setpib ${1} 74 hfid "PEV"
-setpib ${1} F4 byte 1
-setpib ${1} 1653 byte 1
-setpib ${1} 1C98 long 10240 long 102400
-
-
-
- The following shell script converts a factory PIB to a SLAC EVSE by setting the CCO Mode to Always and the SLAC Mode to EVSE. The User HFID is set to EVSE for role identification, optionally. This PIB must be written into EVSE-PLC flash memory for proper operation.
-
-
-#!/bin/sh
-# file: evse.sh
-# ========================================================================
-# convert a factory PIB to a SLAC EVSE PIB by changing these PIB settings;
-# ------------------------------------------------------------------------
-setpib ${1} 74 hfid "EVSE"
-setpib ${1} F4 byte 2
-setpib ${1} 1653 byte 2
-setpib ${1} 1C98 long 10240 long 102400
-
-
-
-
- APCM_SET_CCO Primative
-
-
- This primative configures a PLC state by reading PIB from PLC, changing CCoSelection, computing new PIB checksum then writing the PIB back to PLC. It can be performed manually using Avitar, in a script using the Powerline Toolkit or programatically using custom software.
-
-
-
-
- APCM_CONFIG_SLAC Primative
-
-
-
-
-
diff --git a/docbook/slac-demo.xml b/docbook/slac-demo.xml
deleted file mode 100644
index f8749775..00000000
--- a/docbook/slac-demo.xml
+++ /dev/null
@@ -1,77 +0,0 @@
-
-
- SLAC Demonstration
-
-
- This page explains how to install and use two Qualcomm Atheros Powerline Toolkit programs, pev and evse, to demonstrate the HomePlug AV Signal Level Attenuation Characterization (SLAC) protocol.
-
-
- On Microsoft Windows, the two programs are distributed in a seperate Microsoft installation file slac-utils-x.x.x.msi. To install them on Microsoft Windows, double-click on the installation file. The programs will be installed in folder c:\Program Files (x86)\Qualcomm Atheros\Powerline Toolkit unless the user overrides the default settings durin installation. New users should add this folder to the PATH environment variable and define environment variable PLC to reference the Ethernet interface connected to their PLC device.
-
-
- On Linux, the two programs are distibuted inside the full toolkit tarball plc-utils-x.x.x. To install them on Linux, unpack the tarball and change directory to the package folder. Type "sudo make install" to compile and install the toolkit. Type type "sudo make manuals" to install man pages. New users should define environment variable PLC to reference the inteface connected to their PLC device.
-
-
-
- Exception!
-
-
- In some cases QCA will distribute two Windows .exe files and two monolithic .c files. On Windows, copy the executable files to folder c:\Program Files (x86)\Qualcomm Atheros\Powerline Toolkit and update the system PATH and PLC environment variables. On Linux, compile the two source files using "gcc -o pev pev.c" and "gcc -o evse evse.c" and copy the two binary files to /usr/local/bin then update the system PLC environment variable. You will need root priviledge to copy the binary files to the system folder and you must change the binary file permissions to 4555 in order to execute them as a non-root user.
-
-
-
- Each program reads an optional configuration file on start-up. Program pev reads pev.ini and program evse reads evse.ini. Qualcomm Atheros does not provide these files but option -c, on each program, can be used to print a template configuration file on stdout. Once a user settles on a convenient working folder, they should run command "pev -c > pev.ini" to create the configuration file for program pev and "evse -c > evse.ini" to create the configuration file for program evse.
-
-
- A SLAC demonstration can be setup using two Qualcomm Atheros PL16 boards, two personal computers, a power strip and a powerline impairment of some kind. One PL16 board must be configured as a PEV and the other must be configured as an EVSE. Plug both PL16 boards into the powerstrip and connect each board to a different computer via Ethernet. Run program pev on the computer connected to the PEV configured board. Run program evse on the computer connected to the EVSE configured board. Program evse runs continuously waiting to service pev programs running on other computers. Program pev runs until charging occurs then exits.
-
-
- On the EVSE host, start program evse as shown below. It will run until cancelled.
-
-
-# evse
-evse: UnoccupiedState: Listening ...
-
-
- Messages will appear on the console as events occur. The first field is the program name, in this case evse. The second field is the function name, in this case UnoccupiedState. In this case, program evse does nothing until some PEV trys to associate.
-
-
- On the EVSE host, run program evse as shown below. It will run until it detects and connects to an available EVSE-HLE. Use option -w to vary probe timeouts.
-
-
-# pev
-pev: DisconnectedState: Probing ...
-pev: pev_cm_slac_param: --> CM_SLAC_PARAM.REQ
-pev: pev_cm_slac_param: <-- CM_SLAC_PARAM.CNF
-
-
- Messages will appear on the console as events occur. The first field is the program name, in this case pev. The second field is the function name, in this case DisconnectedState and pev_cm_slac_param. The right arrow indicates that function pev_cm_slac_param is sending a CM_SLAC_PARAM.REQ message. If things work properly, you will see a another message indicating that function pev_cm_slac_param is receiving a CM_SLAC_PARAM.CNF message.
-
-
-
-
-
-
- IMG_20130227_145749.jpg
-
-
-
- Unimpaired SLAC configuration. Result should be below threshold and PEV should connect.
-
-
-
-
-
-
-
-
- IMG_20130227_151458.jpg
-
-
-
- Impaired SLAC configuration. Result should be above threshold and PEV should not connect.
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void slac_connect (struct session * session);
- *
- * slac.h
- *
- * compute the arithmetic mean of session attenuation values and
- * compare to the session limit; average attenuation greater than
- * the session limit is considered a bad connection;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SLAC_AVERAGE_SOURCE
-#define SLAC_AVERAGE_SOURCE
-
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../tools/memory.h"
-#include "../iso15118/slac.h"
-
-signed slac_connect (struct session * session)
-
-{
- unsigned group = 0;
- unsigned total = 0;
- if (session->NumGroups > SIZEOF (session->AAG))
- {
- return (slac_debug (session, session->exit, __func__, "Too much data to analyse!"));
- }
- if (session->NumGroups > 0)
- {
- char string [512];
- while (group < session->NumGroups)
- {
- total += session->AAG [group];
- group++;
- }
- total /= group;
- if (total > session->limit)
- {
- char string [512];
- slac_debug (session, 0, __func__, "Average attenuation (%u) more than limit (%u) frow %d groups", total, session->limit, group);
- slac_debug (session, 0, __func__, "%s", HEXSTRING (string, session->AAG));
- return (- 1);
- }
- if (total > 0)
- {
- slac_debug (session, 0, __func__, "Average attenuation (%u) less than limit (%u) from %d groups", total, session->limit, group);
- slac_debug (session, 0, __func__, "%s", HEXSTRING (string, session->AAG));
- return (0);
- }
- }
- return (slac_debug (session, session->exit, __func__, "Nothing to analyse"));
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- * Copyright (c) 2013 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * signed slac_debug (struct session * session, signed status, char const * string, char const * format, ...);
- *
- * slac.h
- *
- * variation of the GNU error() function that accepts a message in
- * place of an error code and always returns -1;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SLAC_DEBUG_SOURCE
-#define SLAC_DEBUG_SOURCE
-
-#include <stdio.h>
-#include <stdlib.h>
-#include <stdarg.h>
-#include <string.h>
-
-#include "../iso15118/slac.h"
-#include "../tools/types.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-
-#ifdef __GNUC__
-
-__attribute__ ((format (printf, 4, 5)))
-
-#endif
-
-signed slac_debug (struct session * session, signed status, char const * string, char const * format, ...)
-
-{
- extern char const * program_name;
-
- if (_allclr (session->flags, SLAC_SILENCE))
- {
- if ((program_name) && (* program_name))
- {
- fprintf (stderr, "%s: ", program_name);
- }
- if ((string) && (* string))
- {
- fprintf (stderr, "%s: ", string);
- }
- if ((format) && (*format))
- {
- va_list arglist;
- va_start (arglist, format);
- vfprintf (stderr, format, arglist);
- va_end (arglist);
- }
- fprintf (stderr, "\n");
- fflush (stderr);
- }
- if (status)
- {
- exit (status);
- }
- return (-1);
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void slac_session (struct session * session);
- *
- * slac.h
- *
- * print the SLAC session variable if the SLAC_SESSION bit is set
- * in the sesssion variable flagword;
- *
- * macro HEXSTRING is defined in memory.h and is used to reduce the
- * number of arguments one must type to invoke function hexstring;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SLAC_SESSION_SOURCE
-#define SLAC_SESSION_SOURCE
-
-#include <stdio.h>
-
-#include "../tools/memory.h"
-#include "../tools/error.h"
-#include "../tools/flags.h"
-#include "../iso15118/slac.h"
-
-void slac_session (struct session * session)
-
-{
- if (_anyset (session->flags, SLAC_SESSION))
- {
- char string [256];
- slac_debug (session, 0, __func__, "session.RunID %s", HEXSTRING (string, session->RunID));
- slac_debug (session, 0, __func__, "session.APPLICATION_TYPE %d", session->APPLICATION_TYPE);
- slac_debug (session, 0, __func__, "session.SECURITY_TYPE %d", session->SECURITY_TYPE);
- slac_debug (session, 0, __func__, "session.RESP_TYPE %d", session->RESP_TYPE);
- slac_debug (session, 0, __func__, "session.NUM_SOUNDS %d", session->NUM_SOUNDS);
- slac_debug (session, 0, __func__, "session.TIME_OUT %d", session->TIME_OUT);
- slac_debug (session, 0, __func__, "session.NumGroups %d", session->NumGroups);
- slac_debug (session, 0, __func__, "session.AAG %s", hexstring (string, sizeof (string), session->AAG, sizeof (session->AAG)));
- slac_debug (session, 0, __func__, "session.MSOUND_TARGET %s", HEXSTRING (string, session->MSOUND_TARGET));
- slac_debug (session, 0, __func__, "session.FORWARDING_STA %s", HEXSTRING (string, session->FORWARDING_STA));
- slac_debug (session, 0, __func__, "session.PEV_ID %s", HEXSTRING (string, session->PEV_ID));
- slac_debug (session, 0, __func__, "session.PEV_MAC %s", HEXSTRING (string, session->PEV_MAC));
- slac_debug (session, 0, __func__, "session.EVSE_ID %s", HEXSTRING (string, session->EVSE_ID));
- slac_debug (session, 0, __func__, "session.EVSE_MAC %s", HEXSTRING (string, session->EVSE_MAC));
- slac_debug (session, 0, __func__, "session.RND %s", HEXSTRING (string, session->RND));
- slac_debug (session, 0, __func__, "session.NMK %s", HEXSTRING (string, session->NMK));
- slac_debug (session, 0, __func__, "session.NID %s", HEXSTRING (string, session->NID));
- slac_debug (session, 0, __func__, "session.original_nmk %s", HEXSTRING (string, session->original_nmk));
- slac_debug (session, 0, __func__, "session.original_nid %s", HEXSTRING (string, session->original_nid));
- slac_debug (session, 0, __func__, "session.state %d", session->state);
- slac_debug (session, 0, __func__, "session.sounds %d", session->sounds);
- slac_debug (session, 0, __func__, "session.limit %d", session->limit);
- slac_debug (session, 0, __func__, "session.pause %d", session->pause);
- slac_debug (session, 0, __func__, "session.chargetime %d", session->chargetime);
- slac_debug (session, 0, __func__, "session.settletime %d", session->settletime);
- slac_debug (session, 0, __func__, "session.counter %d", session->counter);
- slac_debug (session, 0, __func__, "session.flags 0x%04X", session->flags);
- }
- return;
-}
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * void slac_structs ()
- *
- * slac.h
- *
- *--------------------------------------------------------------------*/
-
-#include <unistd.h>
-
-#include "../iso15118/slac.h"
-
-void slac_structs ()
-
-{
- fprintf (stderr, "sizeof struct cm_sta_identity_request %d\n", sizeof (struct cm_sta_identity_request));
- fprintf (stderr, "sizeof struct cm_sta_identity_confirm %d\n", sizeof (struct cm_sta_identity_confirm));
- fprintf (stderr, "sizeof struct cm_slac_param_request %d\n", sizeof (struct cm_slac_param_request));
- fprintf (stderr, "sizeof struct cm_slac_param_confirm %d\n", sizeof (struct cm_slac_param_confirm));
- fprintf (stderr, "sizeof struct cm_start_atten_char_indicate %d\n", sizeof (struct cm_start_atten_char_indicate));
- fprintf (stderr, "sizeof struct cm_start_atten_char_response %d\n", sizeof (struct cm_start_atten_char_response));
- fprintf (stderr, "sizeof struct cm_atten_char_indicate %d\n", sizeof (struct cm_atten_char_indicate));
- fprintf (stderr, "sizeof struct cm_atten_char_response %d\n", sizeof (struct cm_atten_char_response));
- fprintf (stderr, "sizeof struct cm_mnbc_sound_indicate %d\n", sizeof (struct cm_mnbc_sound_indicate));
- fprintf (stderr, "sizeof struct cm_validate_request %d\n", sizeof (struct cm_validate_request));
- fprintf (stderr, "sizeof struct cm_validate_confirm %d\n", sizeof (struct cm_validate_confirm));
- fprintf (stderr, "sizeof struct cm_slac_match_request %d\n", sizeof (struct cm_slac_match_request));
- fprintf (stderr, "sizeof struct cm_slac_match_confirm %d\n", sizeof (struct cm_slac_match_confirm));
- return;
-}
-
-
-
-/*-
- * Copyright (c) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997
- * The Regents of the University of California. All rights reserved.
- *
- * This code is derived from the Stanford/CMU enet packet filter,
- * (net/enet.c) distributed as part of 4.3BSD, and code contributed
- * to Berkeley by Steven McCanne and Van Jacobson both of Lawrence
- * Berkeley Laboratory.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. 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.
- * 3. All advertising materials mentioning features or use of this software
- * must display the following acknowledgement:
- * This product includes software developed by the University of
- * California, Berkeley and its contributors.
- * 4. Neither the name of the University nor the names of its contributors
- * may be used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
- *
- * @(#) $Header: /tcpdump/master/libpcap/pcap/sll.h,v 1.2.2.1 2008-05-30 01:36:06 guy Exp $ (LBL)
- */
-
-/*
- * For captures on Linux cooked sockets, we construct a fake header
- * that includes:
- *
- * a 2-byte "packet type" which is one of:
- *
- * LINUX_SLL_HOST packet was sent to us
- * LINUX_SLL_BROADCAST packet was broadcast
- * LINUX_SLL_MULTICAST packet was multicast
- * LINUX_SLL_OTHERHOST packet was sent to somebody else
- * LINUX_SLL_OUTGOING packet was sent *by* us;
- *
- * a 2-byte Ethernet protocol field;
- *
- * a 2-byte link-layer type;
- *
- * a 2-byte link-layer address length;
- *
- * an 8-byte source link-layer address, whose actual length is
- * specified by the previous value.
- *
- * All fields except for the link-layer address are in network byte order.
- *
- * DO NOT change the layout of this structure, or change any of the
- * LINUX_SLL_ values below. If you must change the link-layer header
- * for a "cooked" Linux capture, introduce a new DLT_ type (ask
- * "tcpdump-workers@lists.tcpdump.org" for one, so that you don't give it
- * a value that collides with a value already being used), and use the
- * new header in captures of that type, so that programs that can
- * handle DLT_LINUX_SLL captures will continue to handle them correctly
- * without any change, and so that capture files with different headers
- * can be told apart and programs that read them can dissect the
- * packets in them.
- */
-
-#ifndef lib_pcap_sll_h
-#define lib_pcap_sll_h
-
-/*
- * A DLT_LINUX_SLL fake link-layer header.
- */
-#define SLL_HDR_LEN 16 /* total header length */
-#define SLL_ADDRLEN 8 /* length of address field */
-
-struct sll_header {
- u_int16_t sll_pkttype; /* packet type */
- u_int16_t sll_hatype; /* link-layer address type */
- u_int16_t sll_halen; /* link-layer address length */
- u_int8_t sll_addr[SLL_ADDRLEN]; /* link-layer address */
- u_int16_t sll_protocol; /* protocol */
-};
-
-/*
- * The LINUX_SLL_ values for "sll_pkttype"; these correspond to the
- * PACKET_ values on Linux, but are defined here so that they're
- * available even on systems other than Linux, and so that they
- * don't change even if the PACKET_ values change.
- */
-#define LINUX_SLL_HOST 0
-#define LINUX_SLL_BROADCAST 1
-#define LINUX_SLL_MULTICAST 2
-#define LINUX_SLL_OTHERHOST 3
-#define LINUX_SLL_OUTGOING 4
-
-/*
- * The LINUX_SLL_ values for "sll_protocol"; these correspond to the
- * ETH_P_ values on Linux, but are defined here so that they're
- * available even on systems other than Linux. We assume, for now,
- * that the ETH_P_ values won't change in Linux; if they do, then:
- *
- * if we don't translate them in "pcap-linux.c", capture files
- * won't necessarily be readable if captured on a system that
- * defines ETH_P_ values that don't match these values;
- *
- * if we do translate them in "pcap-linux.c", that makes life
- * unpleasant for the BPF code generator, as the values you test
- * for in the kernel aren't the values that you test for when
- * reading a capture file, so the fixup code run on BPF programs
- * handed to the kernel ends up having to do more work.
- *
- * Add other values here as necessary, for handling packet types that
- * might show up on non-Ethernet, non-802.x networks. (Not all the ones
- * in the Linux "if_ether.h" will, I suspect, actually show up in
- * captures.)
- */
-#define LINUX_SLL_P_802_3 0x0001 /* Novell 802.3 frames without 802.2 LLC header */
-#define LINUX_SLL_P_802_2 0x0004 /* 802.2 frames (not D/I/X Ethernet) */
-
-#endif
-
-/*====================================================================*
- *
- * Copyright (c) 2011 by Qualcomm Atheros.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose with or without fee is hereby granted, provided
- * that the above copyright notice and this permission notice appear
- * in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
- * THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
- * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
- * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
- * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * socket.h - substitute sys/socket.h for systems without one;
- *
- * include Microsoft equivalent definitions and declarations;
- *
- *. Intellon INT6000 Linux Toolkit for HomePlug AV;
- *: Published 2006-2009 by Intellon Corp. ALL RIGHTS RESERVED;
- *; For demonstration; Not for production use;
- *
- *--------------------------------------------------------------------*/
-
-#ifndef SOCKET_HEADER
-#define SOCKET_HEADER
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#if defined (WIN32)
-#include <winsock2.h>
-#endif
-
-/*====================================================================*
- * end;
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-
-
-
diff --git a/docbook/software.xml b/docbook/software.xml
deleted file mode 100644
index debf835c..00000000
--- a/docbook/software.xml
+++ /dev/null
@@ -1,843 +0,0 @@
-
-
- Software
-
-
-
- Introduction
-
-
- The Open Powerline Toolkit is designed to support hardware engineers and embedded software developers working on GNU/Linux and Linux-like systems. Debian GNU/Linux is the platform of choice because it is open source and has extensive cross-platform support. The toolkit has been compiled and executed on several platforms but Qualcomm Atheros does not necessarily support the toolkit on those platforms. Qualcomm Atheros has made every effort to enable cross-platform compatibility by conforming to POSIX standards and following good programming practice but there are limitations on any such effort.
-
-
-
-
- Security Considerations
-
-
- Toolkit programs are installed in /usr/local/bin with owner root and group root (chown root:root) and with read and execute permissions for owner, group and others (chmod 0555). This lets anyone execute these programs even though they are owned by user root.
-
-
- Additionally, programs that send raw Ethernet frames are installed with seteuid owner (chmod 4555) so that they will execute with root user privileges, regardless of the user executing them. This lets any user send raw Ethernet frames but it also presents a security risk on the host computer. For example, program int6k is intended to read and write .nvm and .pib files but a malicious user could use it to overwrite other files normally protected by standard file permissions.
-
-
- You can change the default file permissions by changing the -m 4555 option on the install command in various Makefiles. Be aware that doing so will restrict program access to the the root user.
-
-
-
-
- Platform Options
-
-
- Qualcomm Atheros makes no claim that the Open Powerline Toolkit will compile and link in all environments without generating warnings or errors. Different compilers, and compiler versions, treat certain conditions differently and different distributions include different header files or define standard constants and macros differently. Developers should expect to make some source code and makefile modifications to match their environment.
-
-
- The principle consideration is support for raw Ethernet frames. Other considerations include POSIX compliance, system header file locations, compiler version and library support. This section discusses some of these considerations.
-
-
-
- <application>GNU/Linux</application>
-
-
- The toolkit will compile and execute on GNU/Linux systems without modification by using standard Linux header files and native Linux libraries. Raw socket support is native to the Linux Kernel. This is the preferred environment due to cost, networking speed and ease of access to Layer 2 networking.
-
-
- Qualcomm Atheros has cross-compiled and executed versions of the toolkit on MontaVista and AMiLDA Linux both for MIPSEL processors. Most toolkit makefiles have symbolic hooks for cross-compilers but Qualcomm Atheros does not support cross-compilation efforts on any platform.
-
-
-
-
- GNU/Linux with Libpcap
-
-
- The toolkit can compile and will execute on GNU/Linux systems having the libpcap development package and runtime libraries installed; however, this feature is disabled by default because it is not needed on Linux and offers no benefits over native Linux sockets.
-
-
-
-
- GNU/Linux with BPF
-
-
- The toolkit should compile and execute on GNU/Linux systems having BPF compiled into the kernel but modifications would be needed to toolkit source code. This configuration has not been tested but the source code is present to support it. Consult Qualcomm Atheros if this option is of interest to you.
-
-
-
-
- <productname>Mac OS X</productname> with BPF
-
-
- The toolkit will compile and execute on Mac OS X without modification by using native BPF support compiled into the Darwin kernel. Compilation is clean on Leopard and should be fairly clean on Tiger.
-
-
- You may observe compiler warnings concerning the size_t data type and print statements. These warning occur because Mac OS X defined the size_t data type as a 64-bit integer while most other systems define it as a 32-bit integer. Ignore the warnings. We will eventually eliminate them all.
-
-
- You may observe a compiler warning concerning the definition of intrinsic function snprinf. We are not sure what causes this warning but it will be corrected eventually.
-
-
-
-
- <productname>Windows XP</productname> with Winpcap
-
-
- The toolkit will compile and execute on Microsoft Windows XP having WinPcap 4.0.1 runtime libraries installed. To assist windows developers, the toolkit includes a Microsoft Visual Studio .NET 2003 solution file plus required WinPcap 4.0.1 header files and libraries. The resulting programs should execute on any Microsoft Windows computer having WinPcap 4.0.1 runtime libraries installed. Qualcomm Atheros does not support the toolkit under any Microsoft Windows operating system at this time.
-
-
- Recent versions of the toolkit include self-extracting file .\VisualStudioNET\WinPcap4_0_1.exe that installs WinPcap 4.0.1 libraries on your system in cases where you have another version installed. If this creates a conflict the you must resolve it to satisfy your system requirements.
-
-
- This is not the preferred Toolkit environment due to cost, networking overhead, difficulty accessing Layer network support and lack of a powerful native scripting language. Qualcomm Atheros has not implemented all Toolkit programs on Windows for technical reasons.
-
-
-
-
-
- GNU Makefiles on Linux
-
-
- The toolkit includes recursive GNU makefiles for Linux. The Makefile in the root folder calls Makefiles in subordinate folders. Makefiles in subordinate folders can be run independently to produce individual toolkit components. Developers can control which components are compiled and installed by editing the FOLDERS symbol in the main Makefile.
-
-
- Component Makefiles have a standard format that includes the following targets:
-
-
-
-
- compile
-
-
-
- Compiles source code files prior to installation. Intermmediate files and target files are created in the same folder as the Makefile. This is the default target. That means that typing make or make compile have the same result.
-
-
-
-
-
- library
-
-
-
- Creates any special folders that are needed for installation. This target is built by the install target but it can be built independently.
-
-
-
-
-
- scripts
-
-
-
- Installs scripts required for proper toolkit operation. This target must be built explicitly to prevent accidental loss of changes made to existing scripts. This target may be built at any time, before or after the install target.
-
-
-
-
-
- manuals
-
-
-
- Creates manuals, documents or html pages. Documentation files are not automatically installed by any target. Installation is left to the user.
-
-
-
-
-
- install
-
-
-
- Installs executable files in folder /usr/local/bin. This target automatically builds the compile target before installation. This means that make install will compile and install in one step.
-
-
-
-
-
- uninstall
-
-
-
- Removes installed components. This target does nothing for Makefiles that have install targets defined.
-
-
-
-
-
- clean
-
-
-
- Removes intermmediate and temporary files. Temporary files are defined by variable TRASH at the start of each Makefile.
-
-
-
-
-
- fresh
-
-
-
- Removes intermmediate and temporary then re-compiles local targets. It is normally equivalent to make clean followed by make compile.
-
-
-
-
-
- Developers wanting to compile the toolkit under Windows should use Visual Studio .NET solution files instead of makefiles.
-
-
- Developers wanting to compile the toolkit under OpenBSD must make changes to accommodate variations in make program syntax.
-
-
-
-
- Stand-alone Compiling on GNU/Linux
-
-
- You do not need makefiles to build toolkit programs because source files explicitly include all required components using include statement blocks like that shown below. You will see similar blocks near the top of most programs.
-
-
-
- The <constant>MAKEFILE</constant> constant
-
-
-#ifndef MAKEFILE
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-...
-#endif
-
-
-
- This mechanism has several advantages. First, the preprocessor include statements form a complete inventory of required files. Secondly, the relative pathnames help developers locate needed source files. Third, the complete program can be compiled with one gcc command, like the one shown below. This allows program compilation in environments where the GNU make program or the Atheros Makefiles are not available.
-
-
-
- Stand-alone Compiling on GNU/Linux
-
-
-
-
- Most toolkit makefiles define the preprocessor constant MAKEFILE as a compiler option using CFLAGS= ... -DMAKEFILE .... When this constant is defined, the compiler will not include components inside an include block like that shown above and so the Makefile is responsible for compiling and linking all components. If the constant is not defined, because no Makefile was used, the compiler will merely include everything needed.
-
-
-
-
- Cross-Compiling on GNU/Linux
-
-
- Makefiles are setup for cross-compilation using custom toolchains. File make.def, in the main toolkit folder, defines cross-comilation symbols referenced in lower-level makefiles. Lower-level makefiles include make.def before building their targets. The following is an example make.def file used when cross-compiling for the ADM5120 MIPSEL-based gateway.
-
-
-
- Cross-compiling with make.def
-
-
-# file: make.def
-
-# ====================================================================
-# Edimax Hardware;
-# --------------------------------------------------------------------
-
-PLATFORM=-D_ADM5120_
-MODEL=-D_6104KP_
-ENDIAN=-D_LITTLE_ENDIAN_
-GATEWAY=y
-
-# ====================================================================
-# AMiLDA Software; uncomment these lines when cross-compiling;
-# --------------------------------------------------------------------
-
-# CROSS=/export/tools/mipsel-linux-uclibc/bin/mipsel-uclibc-
-# CROSS_LINUX=/export/tools/bin/mipsel-linux-
-
-# ====================================================================
-# toolchain;
-# --------------------------------------------------------------------
-
-CC=$(CROSS)gcc
-STRIP=$(CROSS)strip
-LD=$(CROSS)ld
-AR=$(CROSS)ar
-RANLIB=$(CROSS)ranlib
-CAS=$(CROSS)gcc -c
-CPP=$(CROSS)gcc -E
-
-# ====================================================================
-# folders;
-# --------------------------------------------------------------------
-
-BIN=/usr/local/bin
-MAN=/usr/share/man/man7
-WWW=/home/www
-DOC=/home/www/software/plc-utils/
-
-# ====================================================================
-# permissions;
-# --------------------------------------------------------------------
-
-OWNER=0
-GROUP=0
-
-
-
-
- Developers are encouraged to make changes in this file rather than adding additional variables to the lower-level makefiles. For example, you can edit variable BIN to install toolkit programs in some location other than /usr/local/bin or variable WWW to install HTML documentation on your local website.
-
-
-
-
- Compilation with Visual Studio .NET 2003
-
-
- To build the Open Powerline Toolkit on Windows XP, you must have access to a Windows computer with Visual Studio .NET 2003 and WinPcap runtime libraries installed. WinPcap is an open source version of the packet capture library, libpcap, widely used on Linux and OpenBSD systems. It is readily available on the Internet. Installation of these components is beyond the scope of this document.
-
-
- The Windows and Linux versions of the Open Powerline Toolkit use the same code base but the Windows version requires a Microsoft solution file that includes special compiler settings and specific POSIX header files. The solution file and header files are included in the same archive as Linux version.
-
-
-
- Microsoft Visual Studio .NET 2003
-
-
-
-
-
-
-
-
- Use an application like WinZip to extract archived files into a build folder of your choice. Use Windows Explorer to locate solution file .\VisualStudioNET\plc-utils.sln under the toolkit root folder. Double-click the file to open it with Visual Studio .NET. In Visual Studio .NET, open the window and observe a display similar to that shown above.
-
-
- Figure 1 illustrates a Visual Studio .NET window with the pane exposed. In the Solution Explorer window, right-click the plc-utils solution and select the menu option. Compiliation should begin. Watch for comilation errors.
-
-
- On successful compilation of all projects in this solution, you should find executable programs in the Release folder under each project folder. If not then look in the Debug folder, instead. You can now open a console window, change to each Release or Debug folder in turn and run the programs located there. Instead, we recommend that you create a Windows Installer package by right-clicking on the Install project in the Solution Explorer window and selecting the menu option. Compilation should resume.
-
-
- On successful completion of the install project build, you should find the Windows Installer file plc-utils.msi in the VisualStudioNET folder above the install project folder. Double-clicking on this file will start the Windows Installer program.
-
-
- To distribute the toolkit package to other Windows computers, copy the Windows Installer file to a public network share or some type of portable media.
-
-
-
-
-
- Microsoft Solution Files
-
-
- The Atheros Open Powerline Toolkit includes a Visual Studio .NET solution file, ./VisualStudioNET/plc-utils.sln, that will build the toolkit on Windows XP SP2 from the Linux code base. The following information may be helpful to developers wanting to modify or extend the solution or port it to another version of Microsoft Visual Studio:
-
-
-
-
- All projects are WIN32 Console Projects.
-
-
-
-
- All projects have pre-compiled headers suppressed.
-
-
-
-
- All projects should globally define preprocessor constant MAKEFILE to prevent proliferation of "already defined" link errors. See Stand-alone Compiling on GNU/Linux for an explanation of this constant.
-
-
-
-
- All projects search folder ..\include for stdint.h and unistd.h because Microsoft does not provide them. These header files are customized or abbreviated versions of their POSIX counterparts and should be used when originals are available.
-
-
-
-
- Projects that perform raw Ethernet I/O should globally define preprocessor constant WINPCAP to enable appropriate code segments. Preprocessor error statements should (but may not) alert you if WINPCAP is not defined on Windows platforms.
-
-
-
- Projects that perform raw Ethernet I/O search folder ..\include for WinPcap header files. These files are taken from the WinPcap development package and may require periodic updates. Header files pcap.h, pca-stdinc.h, pcap-bpf.h, ipv6_misc.h and bittypes.h belong in folder VisualStudioNET\include. Other header files belong in folder VisualStudioNET\include\pcap.
-
-
-
-
- Projects that perform raw Ethernet I/O should include folder ..\library for core WinPcap libraries.
-
-
-
-
- Projects that perform raw Ethernet I/O should link to libraries ws2_32.lib, packet.lib and wpcap.lib. The first library is the Microsoft Winsock2 library. The others are core WinPcap libraries.
-
-
-
-
-
-
- Header Files
-
-
- Atheros Open Powerline Toolkit programs reference POSIX functions and constants where possible. Specifically, they make wide use of the data types uint8_t, uint16_t and uint32_t which are defined in file stdint.h. Microsoft Visual C and .NET environments do not include this file. Consequently, Atheros provides an alternative in folder ../Windows/include. This file is open source and was designed to be compatible with the Microsoft development environments; however, you may occassionally experience warnings about the "benign redefinition" for some of these data types.
-
-
- Where possible, this toolkit includes OpenBSD network constants because the OpenBSD project pioneered many of the common network protocols and applications used today. Some systems do not include all OpenBSD network header files or do not define all OpenBSD network constants. Specifically, Microsoft systems do not provide file netinet/if_ether.h and so an alternative is included in folder ../Windows/include/netinet and Windows applications should include it.
-
-
- When the gcc -std=iso9899:1999 option is enabled, some OpenBSD header files found on GNU/Linux systems will exclude required constant definitions because they do not conform to that standard. Atheros is investigating the best way to address this problem.
-
-
- On some systems, such as OpenBSD, FreeBSD and Mac OS X, header files must be included in specific order to avoid compilation errors. We have done our best to deal with this problem. Visit the GNU Autocnf Project for more information about this.
-
-
-
-
- Compiler Constants
-
-
-
- Platform Constants
-
-
- Platform constants conditionaly compile source code blocks based on the hardware architecture and host operating system. Hardware architecture constants are normally defined in system header files. Operating system constants are often compiler intrinsic or defined in system header files.
-
-
-
-
- __APPLE__
-
-
-
- A intrinsic compiler constant indicating Mac OS X operating system support.
-
-
-
-
-
- __BYTE_ORDER
-
-
-
- A standard constant indicating big or little endian host architecture. Some systems may not define this constant and so an alternative should be used.
-
-
-
-
-
- LIBPCAP
-
-
-
- An Atheros constant, that must be manually defined in your makefile or solution file, to indicate that the target host will have LibPcap support. It is not used by the toolkit, at this time, and so the associated code has not been tested.
-
-
-
-
-
- __linux__
-
-
-
- A standard constant indicating GNU/Linux kernel support. It is automatically defined on GNU/Linux systems.
-
-
-
-
-
- __OpenBSD__
-
-
-
- A standard constant indicating OpenBSD kernel support. It is automatically define on OpenBSD systems. It is not used by the toolkit, at this time, and so the associated code has not been extensively tested.
-
-
-
-
-
- WIN32
-
-
-
- A standard constant indicating Microsoft Windows support. It is automatically defined in Microsoft Windows environments.
-
-
-
-
-
- WINPCAP
-
-
-
- An Atheros constant, that must be manually defined in your makefile or solution file, to indicate that the target host will have WinPcap support. The toolkit only defines this constant in Windows Microsoft project files for programs that perform raw Ethernet I/O.
-
-
-
-
-
-
-
- Ethernet Constants
-
-
- The toolkit attempts to use existing definitions for Ethernet related constants where possible. This has been problematic due to inconsistencies in the way different systems structure their header files. Most of the following definitions already exist on Linux, OpenBSD and OS X but there are still some differences between Linux distributions and many constants are undefined on Windows.
-
-
- The Windows version of the toolkit includes an abbreviated net/ethernet.h that provides constant definitions mentioned in this section.
-
-
-
-
- ETHER_ADDR_LEN
-
-
-
- The length of an Ethernet hardware address in bytes. The value is 6 bytes. On Linux and OS X, this is defined in net/ethernet.h.
-
-
-
-
-
- ETHER_CRC_LEN
-
-
-
- The length of an Ethernet frame FCS trailer. The value is 4 bytes. On Linux and OS X, this is defined in net/ethernet.h. Atheros also includes a conditional definition in int6k/int6k.h because some Linux system do not define it anywhere.
-
-
-
-
-
- ETHER_HDR_LEN
-
-
-
- The length of an Ethernet frame header including the source address, destination address and type/length field. The value is 14 bytes or ETHER_ADDR_LEN + ETHER_ADDR_LEN + ETHER_TYPE_LEN. On Linux and OS X, this is defined in net/ethernet.h.
-
-
-
-
-
- ETHER_MAX_LEN
-
-
-
- The maximum length of an Ethernet frame in bytes. The value is 1518 bytes of ETHER_HDR_LEN + ETHERMTU + ETHER_CRC_LEN. On Linux and OS X, this is defined in net/ethernet.h.
-
-
-
-
-
- ETHER_MIN_LEN
-
-
-
- The minimum length of an Ethernet frame in bytes. The value is 64 bytes. On Linux and OS X this is defined in net/ethernet.h
-
-
-
-
-
- ETHER_TYPE_LEN
-
-
-
- The length of Ethernet type/length, or ethertype, field in bytes. The value is 2. On Linux and OS X, it is defined in net/ethernet.h.
-
-
-
-
-
- ETHERMTU
-
-
-
- The maximum transfer unit (ie; data handling capacity) for an Ethernet frame in bytes. The value is 1500 bytes. On Linux and OS X, this is defined in net/ethernet.h
-
-
-
-
-
-
-
-
- <application>LibPcap</application>, <application>WinPcap</application> and <application>BPF</application>
-
-
- LibPcap is an open source Ethernet packet capture library that is widely used. It provides core functionality for the Wireshark packet sniffer, formerly known as Ethereal.
-LibPcap libraries are available for Linux and OpenBSD. On Linux and OpenBSD you must link applications to libpcap.a and libwpcap.a. The toolkit does not use either of these libraries on Linux because they are not needed there.
-
-
- WinPcap is an open source version of LibPcap written for Microsoft Windows. The WinPcap libraries let Windows applications send and receive raw packets. On Windows you must link applications to Packet.lib and wpcap.lib.
-
-
- In principle, the LibPcap and WinPcap library implementations should function identically but they do not; however, they are similar enough to provide a useful degree of platform independence. Defining preprocessor constants LIBPCAP or WINPCAP when compiling the toolkit will enable the corresponding source code. This can be done by adding "-DLIBPCAP" or "-DWINPCAP" to variable LFLAGS in file Makefile in folders int6k, int6k2, efsu and hpav. Constant WINPCAP need only be defined this way when compiling the toolkit using cygwin or mingw environments. Do not define both constants LIBPCAP and WINPCAP at the same time or compiler errors will occur.
-
-
- Berkeley Packet Filters (BPF) is an open source Ethernet packet capture mechanism available on many UNIX-like systems. Native BPF is supported on some systems but must be explicitly compiled into the kernel on other systems. Linux systems normally do not support BPF by default but Mac OS X does and so we automatically use it whenever compiler constant __APPLE__ is defined. In principle, one could compile a custom Linux kernel with BPF enabled.
-
-
-
-
- Structure Packing
-
- Programs in this toolkit make extensive use of packed data structures to simplify source code and guarantee reliability; however, this creates portability issues because different compilers implement structure packing in different ways. Three common structure packing mechanisms are:
-
-
-
- _packed
-
-
-
- The __packed keyword is not part of any C or C++ standard but it is recognized by some compilers, such as the ARM C/C++ and OpenBSD C compiler. This keyword only affects the data structure that it prefaces and it is an ideal way to selectively pack structures. It can be easily defined and undefined using a preprocessor macro. Atheros has elected to insert this keyword wherever it might be appropriate. The ARM C compilers accept this keyword.
-
-
-
- Packing Structures with keyword <quote>__packed</quote>
-
-
-typedef struct __packed header_eth
-{
- uint8_t source [ETHER_ADDR_LEN];
- uint8_t target [ETHER_ADDR_LEN];
- uint16_t protocol;
-}
-header_eth;
-
-
-
-
-
-
- __attribute__ ((packed))
-
-
-
- Attributes are not part of any C or C++ standard but they are recognized by the gcc and Sun Microsystems C compiler. Attributes only affect structures and functions that reference them in their declaration. This is convenient because we can use a preprocessor macro to define the keyword __packed, mentioned above, to be __attribute__ ((packed)). Atheros includes this definition in tools/types.h and OpenBSD does this in their system header files.
-
-
-
- Packing Structures with Attribute <quote>packed</quote>
-
-
-typedef struct __attribute__ ((packed)) header_eth
-{
- uint8_t source [ETHER_ADDR_LEN];
- uint8_t target [ETHER_ADDR_LEN];
- uint16_t protocol;
-}
-header_eth;
-
-
-
-
-
-
- #pragrma pack
-
-
-
- Pragmas are part of most C and C++ language standards but some compilers do not recognize or implement the pack pragma. In addition, different compilers implement it in different ways. The pack pragma affects all data structures up the next pack pragma or end of compile unit. Most pragma implementations accept the push and pop option for pragma nesting. Some pragma pack implementations accept no arguments, most permit either one or two arguments while others allow three arguments. OpenBSD does not recognize this pragma and generates warnings in all cases. Aside from all that, the pack pragma is the most widely supported method for declaring packed structures.
-
-
-
- Packing Structures with the Pragma <quote>pack</quote>
-
-
-#pragma pack (push, 1)
-struct header_eth
-{
- uint8_t source [ETHER_ADDR_LEN];
- uint8_t target [ETHER_ADDR_LEN];
- uint16_t protocol;
-}
-header_eth;
-#pragma pack (pop)
-
-
-
-
-
-
- The Atheros Way
-
-
-
- Toolkit programs declares packed structures using all three methods, as shown below.
-
-
-
- Packing Structures the Atheros Way
-
-
-
-
-
-
-
-
-
- Endian-ness
-
-
- Atheros vendor-specific messages contain information in mixed endian format. The Ethernet header portion is sent big endian but the Atheros header and payload are sent in little endian . The traditional endian converstion functions htons(), htonl(), ntohs() and ntohl() can be used to perform platform independent conversions on the Ethernet header but not the Atheros header payload.
-
-
- The Open Powerline Toolkit includes similar macros HTOLE16, HTOLE32, LE16TOH and LE32TOH in endian.h which serve the same function but conform to recommendations for standarized byte order function on Linux, OpenBSD and FreeBSD. Observe that the names are independent of any network implications.
-
-
-
- In addition, the Open Powerline Toolkit includes function endian that reverses byte order over a variable-length memory region.
-
-
-
-
- Packet Basics
-
-
- Local and remote HomePlug AV powerline devices are managed by sending Ethernet frames that contain HomePlug AV formatted management messages. These frames have an 802.3 Ethernet header and a payload that contains the Management Message (MM).
-
-
- The Ethernet header must be transmitted in newtwork byte order which is big-endian. The Ethernet payload must be sent in ARM host byte order which is little endian. You should use standard network functions htons() and htonl() to write Ethernet headers and ntohs() and ntohl() to read them. You should use function HTOLE16() and HTOLE32() to write integer payload values and LE26TOH() and LE32TOH() to read them.
-
-
-
-
-
- Ethernet headers consist of a destination address (ODA), a source address (OSA) and an ethertype (MTYPE). The ethertype is always 0x88E1 for Homeplug frames of any type. Programmers may use either function EthernetHeader.c or EncodeEthernetHeader to encode a buffer with the ODA and OSA and the HomePlug ethertype. An example appears later on. Structure header_eth is defined in ihp.h for this purpose.
-
-
-
-
-
- Management messages consist of a message header (MMHEADER) and a message entry (MMENTRY). The message header identifies the nature of the message entry that follows it. The acronyms MME and MMENTRY both mean Management Message Entry but they are often used to mean the entire management message or Ethernet frame. This imprecise usage can be confusing at times. Structure header_mme is defined in ihp.h for this purpose.
-
-
-
-
-
- The message header contains message protocol version (MMV), message type (MMTYPE) and vendor identifier (OUI). The management message entry (MMENTRY) that follows the header contains information unique to a the request (REQ), confirmation (CNF), response (RSP) or indication (IND). Programmers may use the Atheros EncodeAtherosHeader function to encode a buffer with a specific MMTYPE and the Atheros MMV and OUI. AN example appears later on.
-
-
-
-
-
- The MMV value, within MMHEADER, indicates the Homeplug AV Management Message protocol version which determines how the message should be interpreted. The protocol version is defined in the HomePlug AV Specification and may change from time to time. One notable change is the recent insertion of an FMI (Fragment Management Information ) field between MMTYPE and OUI , as shown below.
-
-
- In most cases, protocol changes are hidden from the application by the Atheros API functions; however, software developers should set the HOMEPLUG_MMV constant, defined in ihp.h, to the version appropriate for their firmware or application. The value of this constant enables or disables conditional compilation statements throughout the HomePlug API code base.
-
-
- To send an MME, you must encode an Ethernet frame buffer with information and transmit it. To read an MME, you must read an Ethernet frame buffer and decode it. The information necessary to encode or decode Atheros vendor-specific Ethernet frames is covered in the INT6000 Firmware Technical Reference Manual; however, the Atheros HomePlug API includes many buffer encode and decode functions that support basic operational requirements.
-
-
-
-
- Frame Encoding
-
-
- The following technique illustrates one way to encode a frame buffer with an Ethernet header followed by an Atheros message header. We first declare the frame buffer then a length variable to keep track of how many bytes have actually been encoded. At any time, the value 'buffer + length' is the address of the next buffer position to encode and the expression 'sizeof (buffer) - length' is the number of un-encoded bytes remaining in the buffer. Each call to an encoding function will increment the length for the next operation. This technique minimizes the number of intermmediate application variables and makes maximum use of compiler generated constants.
-
-
-
- Frame Encoding by Offset
-
-
-
-
-
-
- For those who prefer to use pointers, the following technique accomplishes the same thing because. At any given time, the value bp - buffer is the encoded length.
-
-
-
- Frame Encoding by Address
-
-
-
-
-
diff --git a/docbook/start.sh.html b/docbook/start.sh.html
deleted file mode 100644
index 5870c1fb..00000000
--- a/docbook/start.sh.html
+++ /dev/null
@@ -1,91 +0,0 @@
-
-
-
-
-
- start.sh
-
-
-
-
-
-
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2011 by Qualcomm Atheros.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose with or without fee is hereby granted, provided
- * that the above copyright notice and this permission notice appear
- * in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
- * THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
- * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
- * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
- * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
-
- *
- * stdint.h - substitute stdint.h file for Windows;
- *
- * this is an important POSIX header that Microsoft ommits;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef STDINT_HEADER
-#define STDINT_HEADER
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <limits.h>
-
-/*====================================================================*
- * variable types;
- *--------------------------------------------------------------------*/
-
-#ifdef _MSC_VER
-typedef __int8 int8_t;
-typedef __int16 int16_t;
-typedef __int32 int32_t;
-typedef __int64 int64_t;
-typedef unsigned __int8 uint8_t;
-typedef unsigned __int16 uint16_t;
-typedef unsigned __int32 uint32_t;
-typedef unsigned __int64 uint64_t;
-typedef long off_t;
-#endif
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2015 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-/*====================================================================*
- *
- * char * strnpwd (char buffer [], unsigned length, unsigned count, unsigned group, char space);
- *
- * keys.h
- *
- * encode a buffer with a password containing the specified number
- * of random letters and digits; optionally, group the letters and
- * digits and separate groups with a space character; return the
- * address of the byte following the encoded password;
- *
- * alphabet is an array of 32 printable password characters;
- * count is the number of characters to be selected from alphabet;
- * group is the grouping factor;
- * space is the group separator;
- *
- * grouping is suppressed when group is zero or greater than or
- * equal to count;
- *
- * Contributors:
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef STRNPWD_SOURCE
-#define STRNPWD_SOURCE
-
-#include <unistd.h>
-#include <fcntl.h>
-#include <errno.h>
-
-#include "../tools/types.h"
-#include "../tools/error.h"
-#include "../key/keys.h"
-
-char * strnpwd (char buffer [], unsigned length, unsigned count, unsigned group, char space)
-
-{
- signed fd;
- if ((fd = open ("/dev/urandom", O_RDONLY)) == -1)
- {
- error (1, errno, "can't open /dev/urandom");
- }
- while (count--)
- {
- static const char alphabet [] =
- {
- '2',
- '3',
- '4',
- '5',
- '6',
- '7',
- '8',
- '9',
- 'A',
- 'B',
- 'C',
- 'D',
- 'E',
- 'F',
- 'G',
- 'H',
- 'J',
- 'K',
- 'L',
- 'M',
- 'N',
- 'P',
- 'Q',
- 'R',
- 'S',
- 'T',
- 'U',
- 'V',
- 'W',
- 'X',
- 'Y',
- 'Z'
- };
- unsigned member;
- if (read (fd, & member, sizeof (member)) != sizeof (member))
- {
- error (1, errno, "can't read /dev/urandom");
- }
- if (length)
- {
- *buffer = alphabet [member % sizeof (alphabet)];
- buffer++;
- length--;
- }
- if ((count) && (group) && ! (count % group))
- {
- if (length)
- {
- *buffer = space;
- buffer++;
- length--;
- }
- }
- }
- close (fd);
- return (buffer);
-}
-
-#endif
-
-
-
-
-
-
diff --git a/docbook/support.xml b/docbook/support.xml
deleted file mode 100644
index 7f7bf21a..00000000
--- a/docbook/support.xml
+++ /dev/null
@@ -1,24 +0,0 @@
-
-
- Support Function Reference
-
-
-
- Introduction
-
-
- The Open Powerline Toolkit includes many general-purpose or multi-purpose functions that may appear in other Qualcomm Atheros applications or in third party packages. Consequently, we describe them separately and store them in separate folders withing the toolkit.
-
-
- &command;
- ðernet;
- &network;
- &generic;
- &message;
- &keys;
- &xml;
- &download;
- &procrastinate;
- &traffic;
- &slac;
-
diff --git a/docbook/support1.xml b/docbook/support1.xml
deleted file mode 100644
index 8b6a32c0..00000000
--- a/docbook/support1.xml
+++ /dev/null
@@ -1,264 +0,0 @@
-
-
- Command Line Functions
-
-
- Command line functions are used by all toolkit programs. They are generic functions but we include them in a special section because they collectively co-operate to convert command line options and arguments into appropriate binary representations and provide concise but meaningful feedback when that is not possible.
-
-
-
- assist
-
-
-
- void assist
- char const * name
- char const * type
- const struct _code_ list []
- size_t size
- FILE * fp
-
-
-
- Show why a symbolic name was rejected by function lookup or similar functions. Argument type contains a title for the class of names stored in list. This function prints an error message on file stream fp showing the program name, the type string, the symbolic name and all names stored in the list. The _code_ structure is declared in types.h. The function is declared in symbol.h and defined in assist.c. Function expect is used to print list names.
-
-
-
-
- basespec
-
-
-
- uint64_t basespec
- char const * string
- unsigned base
- unsigned size
-
-
-
- Return the unsigned integer equivalent of a numeric string. Print an error message on stderr and exit the program with status 1 if a syntax error occurs or the result exceeds the capacity of the requested integer size in bytes. If base is 0, numeric values may be expressed in decimal, hexadecimal or binary notation where hexadecimal values start with "0x" and binary values start with "0b". When base is non-zero, the notation in string must conform to the corresponding number base rules. Applications should cast the return value to the appropriate data type prevent loss-of-data compiler warnings. This function is typically used to convert and length-check integers entered as command line arguments. The function is declared in number.h and defined in basespec.c.
-
-
- Like function uintspec, this function both converts and range checks numeric string values, but the minimum and maximum value are implicit in the size of the integer. The minimum value is always 0 and the maximum value can be computed by ((1 << size << 3) - 1).
-
-
-
-
- bytespec
-
-
-
- void bytespec
- char const * string
- void * memory
- size_t extent
-
-
-
- Encode a memory region with the binary equivalent of a fixed-length hexadecimal string. Print an error message on stderr and exit the program with status 1 if a syntax error occurs or the number of octets does not equal extent. Hexadecimal octets may be separated by colons for readability but colons are not required. Empty octets are illegal. The function is declared in memory.h and defined in bytespec.c.
-
-
- This function is typically used to enter fixed-length data, like hardware addresses and encryption keys, on the command line.
-
-
-
-
- checkfilename
-
-
-
- bool checkfilename
- char const * filename
-
-
-
- Return logical true if the filename argument contains only letters, digits, slashes, periods, underscores and hyphens. This function can be used to detect cases where a user accidentally entered an Ethernet address in place of a filename on the command line. Ethernet address strings are, as it happens, also valid filenames. The function is declared in files.h and defined in checkfilename.c.
-
-
-
-
- dataspec
-
-
-
- void dataspec
- char const * string
- void * memory
- size_t extent
-
-
-
- Encode a memory region with the binary equivalent of a variable-length hexadecimal string. Print an error message on stderr and exit the program with the status 1 if a syntax error occurs or the number of octets exceeds extent. The number of octets may, however, be less than extent. Unlike function bytespec, hexadecimal octets may not be separated by colons. This function is typically used to enter variable-length data from the command line. The function is declared in memory.h and defined in dataspec.c.
-
-
-
-
- error
-
-
-
- void error
- intexitcode
- errno_t number
- char const * format
- ...
-
-
-
- This function works like printf except that printed messages appear on stderr and are prefixed with the program name and error information. If argument errno is non-zero then messages are prefixed with the system error description. If argument exitcode is non-zero then function error exits the program with value exitcode after printing the message and does not return to the caller. The function is declared in error.h and defined in error.c.
-
-
- This function is used to print informative error messages on the console and prevent program execution from proceeding when input is invalid or some error condition exists.
-
-
-
-
- expect
-
-
-
- void expect
- const struct _code_ list []
- size_t size
- FILE * fp
-
-
-
- Display all names in argument list on file stream fp. This function is called by runction assist to print the list of symbolic names but other function may have use for it. The _code_ structure is declared in types.h. The function is declared in symbol.h and defined in expect.c.
-
-
-
-
- getoptv
-
-
-
- int getoptv
- int argc
- char const * argv []
- char const * optv []
-
-
-
- A custom version of the POSIX function getopt. It supports standard global variables optind, opterr, optopt and optarg and the non-standard variable optmin. It extracts the program name from argv[0] and sets global string pointer program_name for use by functions alert, error and others. Options -? and --help both display program information on stdout. Options -! and --version both display program version information on stdout. String vector optv includes both the standard argument optstring and usage text found in many programs. The function is declared in getoptv.h and defined in getoptv.c.
-
-
-
-
- ipv4spec
-
-
-
- size_t ipv4spec
- char const * string
- void * memory
-
-
-
- Encode a 4-byte memory region with an IPv4 dotted-decimal string and return the number of bytes encoded. Terminate the program with an error message and exitcode of 1 on conversion error. The value returned by this function is always 4 and memory is always encoded in network byte order. This function is typically used to convert IPv4 strings entered as command line arguments. The function is declared in memory.h and defined in ipv4spec.c.
-
-
- Dotted-decimal format consists of decimal values in the range 0 through 255. Each value represents one octet or 8-bit value. IPv4 addresses require 4 such values separated by one decimal point. This function permits empty octets and leading zeros within octets. For example, ... is equivalent to 0.0.0.0 and 127.0.000.001 is equivalent to 127.0.0.1. The second example will encode memory as follows { 0x7F, 0x00, 0x00, 0x01 } which is in network byte order, or big endian.
-
-
-
-
- ipv6spec
-
-
-
- size_t ipv6spec
- char const * string
- void * memory
-
-
-
- Encode a 16-byte memory region with an IPv6 colon-separated hexadecimal quartet string and return the number of bytes encoded. Terminate the program with an error message and exitcode of 1 on conversion error. The value returned by this function is always 16 and memory is always encoded in network byte order. This function is typically used to convert IPv6 strings entered as command line arguments. The function is declared in memory.h and defined in ipv6spec.c.
-
-
- Colon-separated hexadecimal quartet notation consists of hexadecimal values in the range 0 through FFFF. Each value represents a quartet or a 32-bit value. IPv6 addresses require 8 quartets separated by one colon. By convention, an empty quartet expands with enough zeros to right-justify the remainder of the address. This function permits multiple empty quartets and leading zeros within quartets. When multiple empty quartets appear, only the right-most occurance expands to zeros. For example, AA12::BB34::CC56::DD78 is equivalent to AA12:0000:BB34:0000:CC56:0000:0000:DD78 because only the right-most empty field expands. This will encode memory as follows { 0xAA, 0x12, 0x00, 0x00, 0xBB, 0x34, 0x00, 0x00, 0xCC, 0x56, 0x00, 0x00, 0x00, 0x00, 0xDD, 0x78 } which is in network byte order, or big-endian.
-
-
-
-
- lookup
-
-
-
- signed lookup
- char const * name
- const struct _code_ list []
- size_t size
-
-
-
- Lookup a symbolic name in a list and return an associated integer or -1 if the name does not appear in the list. A typical use is the translation of symbolic command line arguments to integer codes. For example, some Toolkit programs assign symbolic names to field codes so that users can enter names instead of numbers. This approach becomes more useful as the number of permitted codes increases. The _code_ structure is declared in types.h. The function is declared in symbol.h and defined in lookup.c.
-
-
- This function offers two benefits: 1) multiple symbols can translate to one code and 2) names can be changed or new names added without affecting program logic. This function is similar to but different from function synonym which returns a character string instead of an integer.
-
-
-
-
- putoptv
-
-
-
- void putoptv
- char const * optv []
-
-
-
- Print program information on stdout. Program information is stored in string vector optv. String indexes are defined in file putoptv.h. String optv[0] is the POSIX standard argument optstring. This function is called by function getoptv whenever option -? or --help is detected on the command line. There is virtually no need to call this function directly. The function is declared in putoptv.h and defined in putoptv.c.
-
-
-
-
- synonym
-
-
-
- char const * synonym
- char const * string
- const struct _term_ list []
- size_t size
-
-
-
- Lookup a symbolic name in a list and return an associated string or the original string if the name does not appear in the list. A typical use is the translation of symbolic command line arguments to their equivalent numeric strings before encoding them. For example, many Toolkit programs convert the command line argument local to 00:B0:52:00:00:01 before encoding the device MAC address. The _term_ structure is declared in types.h. The function is declared in symbol.h and defined in synonym.c.
-
-
- This function is similar to but different from function lookup which returns an integer instead of a character string.
-
-
-
-
- uintspec
-
-
-
- uint64_t uintspec
- char const * string
- uint64_t minimum
- uint64_t maximum
-
-
-
- Return the unsigned integer equivalent of a numeric string. Print an error message on stderr and exit the program with the value 1 when a syntax error occurs or the result exceeds the specified minimum or maximum value. Numeric values may be expressed in decimal, hexadecimal or binary notation where hexadecimal values start with "0x" and binary values start with "0b". Applications should cast the return value to the appropriate data type to avoid loss-of-data warnings on some compilers. This function is typically used to convert and range-check integer values entered as command-line arguments. The function is declared in number.h and defined in uintspec.c.
-
-
-
-
- version
-
-
-
- void version
-
-
-
-
- Print package and program version information on stdout. This function is called by function getoptv whenever option -! or --version is detected on the command line. There is no need to call this function directly. The function is declared in version.h and defined in version.c. Constants PACKAGE and VERSION define the information that is displayed. They are defined in file version.h and must be maintained by developers.
-
-
-
diff --git a/docbook/support10.xml b/docbook/support10.xml
deleted file mode 100644
index a7be3bcc..00000000
--- a/docbook/support10.xml
+++ /dev/null
@@ -1,129 +0,0 @@
-
-
- Traffic Functions
-
-
- Traffic functions generate powerline traffic in various ways. Some send traffic direct from the host to each device while others use the VS_FR_LBK message to echo Ethernet frames back to the sender.
-
-
-
- CrossTraffic1
-
-
-
- signed CrossTraffic1
- struct plc * plc
-
-
-
- Instruct a powerline device to send a generic Ethernet frame to another powerline device for a fixed period of time in order to set the TX rate on the source device and the RX rate on the destination device. The source and destination address are specified in plc->MAC and plc->RDA, respectively, and the duration is specified in plc->timeperiod. This function is similar to function CrossTraffic2 but the source and destination addresses are reversed. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file CrossTraffic1.c.
-
-
-
-
- CrossTraffic2
-
-
-
- signed CrossTraffic2
- struct plc * plc
-
-
-
- Instruct a powerline device to send a generic Ethernet frame to another powerline device for a fixed period of time in order to set the TX rate on the source device and the RX rate on the destination device. The source and destination address are specified in plc->RDA and plc->MAC, respectively, and the duration is specified in plc->timeperiod. This function is similar to function CrossTraffic1 but the source and destination addresses are reversed. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file CrossTraffic2.c.
-
-
-
-
- LocalTraffic1
-
-
-
- signed LocalTraffic1
- struct plc * plc
-
-
-
- Send a fixed number of generic frames from the local host a remote powerline device in order to set the TX rate on the local powerline device and the RX rate on the remote powerline device. The local and remote device address are specified in plc->MAC and plc->RDA, respectively, and the count is specified in plc->count. This function is similar to function LocalTraffic2 which instructs a remote device to echo frames back to the local device. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file LocalTraffic1.c.
-
-
-
-
- LocalTraffic2
-
-
-
- signed LocalTraffic2
- struct plc * plc
-
-
-
- Instruct a remote powerline device to echo generic Ethernet frames back to the local host for a fixed period of time in order to set the TX rate on the remote powerline device and the RX rate on the local powerline device. The local and remote device address are specified in plc->MAC and plc->RDA, respectively, and the count is specified in plc->count. This function is useful when there is no easy way to send traffic from the remote host. This function complements function LocalTraffic1 which send frames from the local device to a remote device. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file LocalTraffic2.c.
-
-
-
-
- NetworkTraffic1
-
-
-
- signed NetworkTraffic1
- struct plc * plc
-
-
-
- This function is an alternative to function NetworkTraffic2 which uses Qualcomm Version 1 management messages to determine network topology. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file NetworkTraffic1.c.
-
-
- This function use VS_SW_INFO and VS_NW_INFO messages to discover powerline network topology then calls functions LocalTraffic1 and LocalTraffic2 to generate traffic between the local powerline device and each remote powerline device. Unlike function NetworkTraffic1, it does not generate traffic between various remote devices.
-
-
-
-
- NetworkTraffic2
-
-
-
- signed NetworkTraffic2
- struct plc * plc
-
-
-
- This function is an alternative to function NetworkTraffic1 which uses Qualcomm Version 0 management messages to determine network topology. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file NetworkTraffic2.c.
-
-
-
-
- Traffic1
-
-
-
- signed Traffic1
- struct plc * plc
-
-
-
- This function is an alternative to function Traffic2 which uses Qualcomm Version 1 management messages to determine network topology. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file Traffic1.c.
-
-
- This function use VS_SW_INFO and VS_NW_INFO messages to discover powerline network topology then calls functions LocalTraffic1 and LocalTraffic2 to generate traffic between the local powerline device and each remote powerline device. Unlike function NetworkTraffic1, it does not generate traffic between remote devices.
-
-
-
-
- Traffic2
-
-
-
- signed Traffic2
- struct plc * plc
-
-
-
- This function is an alternative to function Traffic1 which uses Qualcomm Version 0 management messages to determine network topology. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in plc.h and defined in file Traffic2.c.
-
-
- This function use VS_SW_INFO and VS_NW_INFO messages to discover powerline network topology then calls functions LocalTraffic1 and LocalTraffic2 to generate traffic between the local powerline device and each remote powerline device. Unlike function NetworkTraffic2, it does not generate traffic between remote devices.
-
-
-
diff --git a/docbook/support11.xml b/docbook/support11.xml
deleted file mode 100644
index 64c6ce32..00000000
--- a/docbook/support11.xml
+++ /dev/null
@@ -1,605 +0,0 @@
-
-
- SLAC Functions and Variables
-
-
- The functions described in this chapter implement SLAC protocol building blocks. Essentially, there is one function for each dataflow shown on the SLAC interface diagram. The implementations are not sophisticated. Customers must adapt them their own run-time environments.
-
-
- To assist in adapting functions fo various environments, SLAC functions all accept three arguments. The first is a session variable that references information that supports a single PEV-EVSE SLAC interaction. The second is a channel variable that references information that supports ISO Layer 2 network communications. The third is a message variable that references an IEEE 802.3 frame buffer used to format, transmit, receive and interpret SLAC messages. Applications may create lists, stacks, queues or heaps of session variables to support multiple PEV-EVSE conversations. That has not been done here but may be done in the future.
-
-
- PEV-HLE determines the application type and security type and stores them in the session variable before attempting a new SLAC session. PEV-HLE also generates and stores the run identifier in the session variable before attempting a new SLAC session. The run identifier is included in messages so that the EVSE-HLE can distinguish frames from different PEV-HLEs when transmitted in broadcast.
-
-
-
- The Session Variable
-
-
- The session variable is a structure defined in slac.h. It stores the information needed to manage a single SLAC protocol session between PEV-HLE and EVSE-HLE. It is necessary because there are cases where multiple PEV-HLE attempt to communicate with one EVSE-HLE or vice verse and each communication involves multiple steps and some steps will fail or be abandoned.
-
-
-
-
- session.RunID
-
-
-
-A session identifier used to support multiple PEV-EVSE sessions.
-The PEV-HLE defines a new value with each associateion attempt and broadcasts it to EVSE-HLE in CM_SLAC_PARAM.REQRunID.
-EVSE-HLE receive it and store it in their session variable.
-Once association starts, subsequent messages, in both directions, include this identifier so that PEV-HLE and EVSE-HLE can detect and collate messages from the same conversation.
-
-
-
-
-
- session.APPLICATION_TYPE
-
-
-
-Indicates the context in which the SLAC process is being carried out.
-Currently, the only context is PEV-EVSE association.
-The PEV-HLE sends this value to the EVSE-HLE in EVSE-HLE in CM_SLAC_PARAM.REQ message APPLICATION_TYPE field.
-EVSE-HLE receive it and store it in their session variable.
-
-
-
-
-
- session.SECURITY_TYPE
-
-
-
-Indicates that the sender prefers Secure SLAC for PEV-EVSE matching.
-Currently, the only value used in SLAC demonstration software is 0 for No Security.
-The PEV-HLE defines this value as 0 on startup and broadcasts it to EVSE-HLE in in CM_SLAC_PARAM.REQ message SECURITY_TYPE field.
-EVSE-HLE receive it and store it in their session variable for later use when sending SLAC messages.
-
-
-
-
-
- session.RESP_TYPE
-
-
-
-The EVSE-HLE defines this value and sends it to the PEV-HLE in CM_SLAC_PARAM.CNF message RESP_TYPE field.
-THe default is 0 but this can be changed using response type = in profile evse.ini.
-
-
-
-
-
- session.NUM_SOUNDS
-
-
-
-The number of CM_MNBC_SOUND.IND messages that the PEV-HLE should send during sounding.
-The EVSE-HLE defines this value and sends it to PEV-HLE in CM_SLAC_PARAM.CNF message NUM_SOUNDS field.
-The default is 10 but this can be changed using time to soundi = in profile evse.ini.
-
-
-
-
-
- session.TIME_OUT
-
-
-
-The total time allowed for all session sounding to complete.
-Any msounds arriving after the timeout will be lost.
-The time is expressed in 100 msec increments.
-The EVSE-HLE defines this value and sends it to PEV_HLE in CM_SLAC_PARAM.CNF.
-The default is 8 but this can be changed using number of sounds = in profile evse.ini.
-
-
-
-
-
- session.AAG []
-
-
-
-The cumulative average attenuation across 58 groups of 16 carriers.
-The EVSE-HLE computes these averages from multiple CM_ATTEN_PROFILE.IND and forwards them to PEV-HLE in CM_ATTEN_CHAR.IND.
-PEV_HLE populates array from CM_ATTEN_CHAR.IND message ACVarField.ATTEN_PROFILE.AAG field and evaluates it by averaging all values in the array to determine the overall average attenuation.
-If that values is less than or equal to session.limit then a match may be attempted.
-
-
-
-
-
- session.NumGroups
-
-
-
-The number of elements in array session.AAG.
-This EVSE-HLE defines this number and sends it to PEV-HLE in CM_ATTEN_CHAR.INDACVarField.NumGroups.
-For practical purposes, this value of this variable is constant at 58.
-
-
-
-
-
- session.MSOUND_TARGET
-
-
-
-MAC address of EVSE-HLE that will receive CM_MNBC_SOUND.IND messages.
-The EVSE-HLE defines this address and broadcasts it to PEV-HLE in CM_SLAC_PARAM.CNF message M-SOUND_TRAGET field.
-THe PEV-HLE stores this address in its session variable.
-The default is FF:FF:FF:FF:FF:FF and remains constant.
-This value is not used at this time.
-
-
-
-
-
- session.FORWARDING_STA
-
-
-
-MAC address of PEV-HLE to receive CM_SLAC_PROFILE.IND messages.
-The EVSE-HLE defines this address and sends it to PEV-HLE in CM_SLAC_PARAM.CNF message FORWARDING_STA field.
-THe PEV-HLE stores this address in its session variable.
-The default is FF:FF:FF:FF:FF:FF and remains constant.
-This value is ignored when RESP_TYPE=0.
-
-
-
-
-
- session.PEV_ID
-
-
-
-The vehicle identification number.
-The PEV-HLE sends this value to the EVSE-HLE in CM_SLAC_MATCH.REQMatchVarField.PEV_ID field.
-The default is AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA but is can be changed using vehicle identifier = in profile pev.ini.
-The MatchVarField portion of the message forms the transaction record and may be encrypted.
-
-
-
-
-
- session.PEV_MAC
-
-
-
-PEV-HLE MAC address.
-The PEV-HLE sends this address to the EVSE-HLE in CM_SLAC_MATCH.REQMatchVarField.PEV_MAC field.
-The MatchVarField portion of the message forms the transaction record and may be encrypted.
-
-
-
-
-
- session.EVSE_ID
-
-
-
-The station identification number.
-The EVSE-HLE sends this value to PEV-HLE in CM_SLAC_MATCH.CNF message MatchVarField.EVSE_ID field.
-The default is BBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBBB but is can be changed using station identifier = in profile evse.ini.
-The MatchVarField portion of the message forms the transaction record and may be encrypted.
-
-
-
-
-
- session.EVSE_MAC
-
-
-
-EVSE-HLE MAC address.
-The EVSE-HLE sends this value to PEV-HLE in CM_SLAC_MATCH.CNF message MatchVarField.EVSE_MAC field.
-The MatchVarField portion of the message forms the transaction record and may be encrypted.
-
-
-
-
-
- session.NMK
-
-
-
-The EVSE-PLC Network Membership Key.
-The EVSE-HLE defines this value when the station powers on.
-The EVSE-HLE sends the NMK to the PEV-HLE in CM_SLAC_MATCH.CNF message MatchField.NMK field.
-The PEV-HLE uses this value to form a network with the EVSE-PLC during charging.
-The MatchVarField portion of the message forms the transaction record and may be encrypted.
-
-
-The default for PEV-HLE is 50D3E4933F855B7040784DF815AA8DB7, which is the key derived from network password HomePlugAV, but that can be changed using nwtwork membership key = in profile pev.ini.
-
-
-The default for EVSE-HLE is B59319D7E8157BA001B018669CCEE30D, which is the key derived from network password HomePlugAV0123, but that can be changed using nwtwork membership key = in profile evse.ini.
-
-
-
-
-
-
- session.NID
-
-
-
-The EVSE-PLC Network Identifier.
-The EVSE-HLE defines this value when the station powers.
-The EVSE-HLE sends the NID to the PEV-HLE in CM_SLAC_MATCH.CNF message MatchField.NID field.
-The PEV-HLE uses this value to form a network with the EVSE-PLC during charging.
-The MatchVarField portion of the message forms the transaction record and may be encrypted.
-
-
-The default for PEV-HLE is B0F2E695666B03, which is the key derived from network password HomePlugAV, but that can be changed using nwtwork membership key = in profile pev.ini.
-
-
-The default for EVSE-HLE is 026BCBA5354E08, which is the key derived from network password HomePlugAV0123, but that can be changed using nwtwork membership key = in profile evse.ini.
-
-
-
-
-
- session.RND
-
-
-
-A random value.
-PEV-HLE computes this value and sends it to EVSE-HLE in CM_MNBC_SOUND.IND.
-This value is not used at this time.
-
-
-
-
-
- session.original_nmk
-
-
-
-The original PEV-PLC Network Membership Key.
-This is the original NMK of the PEV-HLE.
-The PEV-HLE preserves this value before, and restores it after, the charging cycle.
-The Qualcomm Atheros PEV-HLE and EVSE-HLE demonstration software reads these values from profile pev.ini and evse.ini, respectively, by network membership key = .
-
-
-
-
-
- session.original_nid
-
-
-
-The PLC Network Identifier (NID).
-PEV-PLC and EVSE-PLC will each have a different NID at the start of the SLAC process.
-This value must be preserved before, and restored after, charging.
-Once charging is complete, PEV-HLE and EVSE-HLE restore this value to their respective PLC using CM_SET_KEY.
-In a real world implementation, PEV-HLE and EVSE-HLE would read this value from their repective PLC and save it in session.nmk and session.NMK.
-The Qualcomm Atheros PEV-HLE and EVSE-HLE demonstration software reads these values from profile pev.ini and evse.ini, respectively, by network identifier = .
-
-
-
-
-
- session.state
-
-
-
-The current SLAC protocol session state. Qualcomm Atheros PEV-HLE and EVSE-HLE demonstration programs use this value to direct internal state transitions.
-Values range from 0 through 3.
-
-
-
-
-
- session.sounds
-
-
-
-The number of MSounds captured received by EVSE-HLE.
-This value may be less that NUM_SOUNDS the requested by the EVSE_HLE due to network interruptions or EVSE-HLE overloading.
-This is the denominator used when computing the average attenuation in array session.AAG.
-The values is set by PEV_HLE from CM_ATTEN_CHAR.IND message NUM_SOUNDS field.
-
-
-
-
-
- session.limit
-
-
-
-The attenuation threshold.
-If the average attenuation value in session.AAG exceeds this value the PEV-HLE will make no attempt to connect the PEV-PLC to the EVSE-PLC.
-The default value is 10 but this can be re-defined in profile pev.ini by attenuation threshold = .
-
-
-
-
-
- session.pause
-
-
-
-The time in milliseconds between MSounds.
-Sounding too frequently does not allow enough time for the EVSE-PLC to sample and compute values.
-Sounding too infrequently wastes time.
-The maximum sample rate may be limited by the quality of the powerline media and traffic passwing through the EVSE-PLC.
-The default is 10 but can be re-defined in profile pev.ini by msound pause = .
-
-
-
-
-
- session.chargetime
-
-
-
-The time in milliseconds allowed for the charging cycle to complete.
-The default is 10 but this can be changed using charge time = in profile pev.ini and evse.ini.
-The charge time should be the same for PEV-HLE and EVSE-HLE when running long tests.
-
-
-
-
-
- session.settletime
-
-
-
-The time in milliseconds allowed for the charging cycle to complete.
-The default is 10 but this can be changed using settle time = in profile pev.ini and evse.ini.
-The settle time should be the same for PEV-HLE and EVSE-HLE when running long tests.
-
-
-
-
-
- session.counter
-
-
-
-The number of chaging session that have take place.
-This variable is not part of the SLAC protocol.
-The PEV-HLE and EVSE-HLE increment this counter each time they enter the Charging state and exchange this value in the unused CM_SLAC_PARAM.REW and CM_SLAC_PARAM.CNF message CipherSuite field.
-Runtime options can be used to instruct either the PEV-HLE or EVSE-HLE to terminate if their counts are out-of-sync.
-
-
-
-
-
- session.flags
-
-
-
-A bit-mapped flagword used to control program flow based on user-specified command line options.
-
-
-
-
-
-
-
-
-
-
-
-
-
- pev_cm_slac_param
-
-
-
- signed pev_cm_slac_param
- struct session * session
- struct channel * channel
- struct message * message
-
-
-
-PEV-HLE broadcasts CM_SLAC_PARAM.REQ messages and waits for a CM_SLAC_PARAM.CNF from EVSE-HLEs.
-This is the first message sent and it initiates SLAC session one some EVSE-HLE responds.
-Function pev_cm_slac_param copies session.APPLICATION_TYPE, session.SECURITY_TYPE and session.RunID into CM_SLAC_PARAM.REQ and broadcasts it to listening EVSE-HLE.
-
-
-It is possible that multiple EVSE-HLEs will respond but one response is sufficient to proceed.
-If a CM_SLAC_PARAM.CNF is not received within a reasonable time, PEV-HLE sends another another CM_SLAC_PARAM.REQ message.
-PEV-HLE should compare the run identifier in the CM_SLAC_PARAM.CNF to that stored in the session variable to ensure that it is not processing CM_SLAC_PARAM.CNF messages from some other session.
-PEV-HLE compares RunID, APPLICATION_TYPE and SECURITY_TYPE from CM_SLAC_PARAM.CNF to that stored in the session variable to ensure they have not changed.
-PEV-HLE stores MSOUND_TARGET, NUM_SOUNDS and TIME_OUT in the session variable for later use.
-
-
-
-
- evse_cm_slac_param
-
-
-
- signed evse_cm_slac_param
- struct session * session
- struct channel * channel
- struct message * message
-
-
-
-EVSE-HLE receives a CM_SLAC_PARAM.REQ and responds with a CM_SLAC_PARAM.CNF message.
-This function waits indefinitly for CM_SLAC_PARAM.REQ then copies RunID, APPLICATION_TYPE and SECURITY_TYPE from CM_SLAC_PARAM.REQ to the session variable for later use.
-It then copies session.MSOUND_TARGET, session.NUM_SOUNDS, session.TIME_OUT, session.RESP_TYPE, session.FORWARDING_STA, session.APPLICATION_TYPE, session.SECURITY_TYPE and session.RunID to CM_SLAC_PARAM.CNF and sends it unicast to the requesting PEV-HLE.
-
-
-
-
-
- pev_cm_start_atten_char
-
-
-
- signed evse_cm_start_atten_char
- struct session * session
- struct channel * channel
- struct message * message
-
-
-
-PEV-HLE informs listening EVSE-HLE that sounding is about to start by broadcasting CM_START_ATTEN_CHAR.IND.
-Function pev_cm_start_char copies session.NUM_SOUNDS, session.TIME_OUT, session.RESP_TYPE, session.FORWARDING_STA and session.RunID to CM_START_ATTEN_CHAR.IND.
-
-
- The standard recommends that this message be sent three times. Our demonstration software does not do this.
-
-
-
-
- evse_cm_start_atten_char
-
-
-
- signed evse_cm_start_atten_char
- struct session * session
- struct channel * channel
- struct message * message
-
-
-
-EVSE-HLE receives CM_START_ATTEN_CHAR from PEV-HLE and prepares to receive sounds by initializing msound counters and starting a timer.
-This function compares RunID from CM_START_ATTEN_CHAR to session.RunID to ensure that this message belongs to a known session.
-This function compares APPLICATION_TYPE, SECURITY_TYPE, NUM_SOUNDS, TIME_OUT, RESP_TYPE and FORWARDING_STA to the session variable to ensure that values have not changed.
-
-
-
-
- pev_cm_mnbc_sound
-
-
-
- signed pev_cm_mnbc_sound
- struct session * session
- struct channel * channel
- struct message * message
-
-
-
-PEV-HLE sends periodic CM_MNBC_SOUND.IND to EVSE-HLE.
-
-
-
-
- evse_cm_mnbc_sound
-
-
-
- signed evse_cm_mnbc_sound
- struct session * session
- struct channel * channel
- struct message * message
-
-
-
-EVSE-HLE receives interleaved CM_MNBC_SOUND.IND from PEV-HLE and CM_ATTEN_PROFILE.IND messages from EVSE-PLC.
-This function maintains a running average of attenuation values across each carrier group in array session.AAG.
-
-
-
-
- evse_cm_atten_char
-
-
-
- signed evse_cm_atten_char
- struct session * session
- struct channel * channel
- struct message * message
-
-
-
-EVSE-HLE sends CM_ATTEN_CHAR.IND to PEV-HLE.
-This function copies session.AAG to CM_ATTEN_CHAR.IND.
-
-
-
-
- pev_cm_atten_char
-
-
-
- signed pev_cm_atten_char
- struct session * session
- struct channel * channel
- struct message * message
-
-
-
-PEV-HLE receives CM_ATTEN_CHAR.IND from EVSE-HLE and acknwoledges with CM_ATTEN_CHAR.RSP.
-
-
-
-
- pev_cm_slac_match
-
-
-
- signed pev_cm_slac_match
- struct session * session
- struct channel * channel
- struct message * message
-
-
-
-PEV-HLE sends CM_SLAC_MATCH.REQ to selected EVSE-HLE and waits for CM_SLAC_MATCH.CNF.
-This function evaluates sounds across all carrier groups and compares result to some threshold and selects one EVSE-HLE.
-This function copies session.APPLICAION_TYPE, session.SECURITY_TYPE, session.PEV_ID, session.PEV_MAC and session.RunID to CM_SLAC_PARAM.REQ and sends it unicast to the selected EVSE-HLE.
-
-
-
-
- evse_cm_slac_match
-
-
-
- signed evse_cm_slac_match
- struct session * session
- struct channel * channel
- struct message * message
-
-
-
-EVSE-HLE listens for CM_SLAC_MATCH.REQ from PEV-HLE and abandons the session if no indication is received within a reasonable time.
-If an indication is received then this function compares RunID from CM_SLAC_MATCH.REQ to the session.RunID to ensure the message is part of the current session.
-This function compares APPLICATION_TYPE and SECURITY_TYPE to the session.APPLICATION_TYPE and session.SECURITY_TYPE to ensure that they have not changed.
-This function copies PEV_ID and PEV_MAC from CM_SLAC_MATCH.REQ to the session variable for later use.
-This function updates session.NMK and session.NID with random values.
-This function copies session.EVSE_ID, session.EVSE_MAC, session.NMK and session.NID to CM_SLAC_MATCH.RSP and sends it unicast to the selecing PEV-HLE.
-
-
-
-
-
- evse_cm_set_key
-
-
-
- signed evse_cm_mnbc_sound
- struct session * session
- struct channel * channel
- struct message * message
-
-
-
-
-
-
-
- pev_cm_set_key
-
-
-
- signed pev_cm_mnbc_sound
- struct session * session
- struct channel * channel
- struct message * message
-
-
-
-
-
-
diff --git a/docbook/support2.xml b/docbook/support2.xml
deleted file mode 100644
index c6bd923d..00000000
--- a/docbook/support2.xml
+++ /dev/null
@@ -1,187 +0,0 @@
-
-
- Ethernet Functions
-
-
- The Open Powerline Toolkit supports raw Ethernet I/O on several popular operating systems, including Linux, Mac OS X and Microsoft Windows. Other operating systems will probably be added over time. These functions are found in the ether folder.
-
-
- Each operating system has a different raw Ethernet interface and so some abstraction was needed to support the toolkit for all environments. Our solution was the channel which is implemented like a FILE pointer but is used like a file descriptor. All toolkit programs, with a few exceptions, perform raw Ethernet I/O by opening a channel, reading and writing to it and then closing it.
-
-
-
- channel
-
-
- The channel structure contains enough information to perform raw Ethernet I/O in several common runtime environments; however, portions of the structure vary depending on the environment. These differences are appled by compile time constants that include required structure members and exclude others. The common structure members are identified and described below. The others elements are not discussed because they may change.
-
-
-typedef struct __packed channel
-{
- signed fd;
- signed ifindex;
- char const * ifname;
- uint8_t peer [ETHER_ADDR_LEN];
- uint8_t host [ETHER_ADDR_LEN];
- uint16_t type;
-
- ... <operating system dependent data> ...
-
- signed timeout;
- flag_t flags;
-} CHANNEL;
-
-
-
-
- .fd
-
-
-
- Socket file descriptor.
-
-
-
-
-
- .ifindex
-
-
-
- Ethernet device index. The index only applies when the toolkit is compiled for LibPcap or WinPcap. This value is the same as that returned in the .ifr_ifindex member of the ifreq structure available on most operating systems.
-
-
-
-
-
- .ifname
-
-
-
- The interface name. On Linux, ethernet names are typically eth0, eth1 and so on. On Mac OS X, interface names are en0, en1 and so on. This string is the same as that returned by the ifr_ifname member of the ifreq structure available on most operating systems.
-
-
-
-
-
- .peer
-
-
-
- The Ethernet hardware address of some remote device. It is used to encode the ODA field of outgoing Ethernet frames and format some console messages. It is initialized to the Atheros Local Management Address, 00:B0:52:00:00:01 for HomePlug AV applications. Application programs can, and often do, replace this value at runtime.
-
-
-
-
-
- .host
-
-
-
- The Ethernet hardware address of the host computer. It is used to encode the OSA field of outgoing Ethernet frames and format some console messages. This address is initialized to the hardware address assigned to the interface by the host operating system. The value should not change.
-
-
-
-
-
- .type
-
-
-
- The Ethernet type/length field. It is used to encode the MTYPE field of outgoing Ethernet frames. The values is initialized to 0x88E1 for HomePlug AV application and 0x887B for HomePlug 1.0 application. The value should not change.
-
-
-
-
-
- .timeout
-
-
-
- A time interval. On Linux and Mac OS X, it is the maximum time that the application will wait for a device to respond when a response is expected. With LibPcap and WinPcap it the mininum time the application will wait. It is initialized to 50 milliseconds which is a reasonable compromise but most toolkit programs allow the user to change this value.
-
-
-
-
-
- .flags
-
-
-
- A bitmap where each bit enables a special behavior during channel open or close or packet read or write. Of general interest is the CHANNEL_VERBOSE bit which prints outgoing and incoming frames on stderr in hexadecimal dump format. The verbose feature is implemented in for all toolkit programs that perform raw Ethernet I/O and is helpful when debugging device behavior.
-
-
-
-
-
- Since toolkit applications typically communicate with one powerline device at a time, this structure is statically initialized in a stand-alone module that is linked into each application. It is possible to dynamically initialize it, if needed. The structure is declared in channel.h and statically defined in channel.c.
-
-
-
-
- closechannel
-
-
-
- signed closechannel
- struct channel * channel
-
-
-
- Close the Ethernet socket associated with a channel and free associated memory and data structures. Return 0 on success. Return -1 on failure. This function is declared in channel.h and defined in closechannel.c.
-
-
-
-
- openchannel
-
-
-
- signed openchannel
- struct channel * channel
- uint16_t protocol
-
-
-
- Open an Ethernet socket that supports the specified protocol and associate it with the interface referenced by the channel structure .name member. Initialize the interface as needed. The protocol effectively filters incoming frames for the application.
-
-
- Interface initialization differs significantly from environment to environment. The socket descriptor is stored in the channel structure .fd member and the interface hardware address is stored in the channel structure .host member. Return 0 on success. Terminate the program with an error message on failure. This function is declared in channel.h and defined in openchannel.c.
-
-
-
-
- readpacket
-
-
-
- signed readpacket
- struct channel * channel
- void * packet
- signed length
-
-
-
- Read one Ethernet frame from the specified channel. The frame is written into memory starting at address packet and is truncated to the specified length, if necessary. Return the actual number of bytes read on success. Return 0 on timeout. Return -1 on network error. This function behaves like the standard library read function. The target memory region remains unchanged on timeout or error. This function is declared in channel.h and defined in readpacket.c.
-
-
- On systems using Berkeley Packet Filters, such as MacOS X, the ODA field is automatically replaced on transmission to prevent Ethernet address spoofing. This may not be true on other systems but the practice is becoming more common.
-
-
-
-
- sendpacket
-
-
-
- signed sendpacket
- struct channel * channel
- void * packet
- signed length
-
-
-
- Write one Ethernet frame to the specified channel. The frame is read from memory starting at address packet and ending at the specified length. Return the actual number of bytes sent on success. Return 0 on timeout. Return -1 on network error. The frame should be properly formatted as an ethernet frame and must be at least 60 bytes long or it will not be sent. This function behaves like the standard library write function. The source memory region is not modified. This function is declared in channel.h and defined in sendpacket.c.
-
-
-
diff --git a/docbook/support3.xml b/docbook/support3.xml
deleted file mode 100644
index de38b653..00000000
--- a/docbook/support3.xml
+++ /dev/null
@@ -1,82 +0,0 @@
-
-
- Network Functions
-
-
-
- NetworkBridges
-
-
-
- size_t NetworkBridges
- struct channel * channel
- void * memory
- size_t extent
-
-
-
- Search a channel for local powerline devices (bridges) and store their Ethernet hardware in consecutive memory locations. The memory extent is specified in bytes. The number of devices found is returned as the function value, provided enough space is available to store all addressed. Unlike function NetworkDevices, the channel peer address is ignored.
-
-
- We call local devices bridges because each serves as an Ethernet-to-Powerline bridge for the local host.
-
-
-
- Enumerating Local Devices
-
-
-#include <net/if.h>
-#include "../ether/channel.h"
-extern struct channel channel;
-uint8_t address [255][ETHER_ADDR_LEN];
-size_t bridges = NetworkBridges (&channel, address, sizeof (address));
-size_t bridge = 0;
-while (bridge < bridges)
-{
- binout (address [bridge], ETHER_ADDR_LEN, ':', stdout);
- putc ('\n', stdout);
-}
-
-
- The code segment shown above illustrates how to use function NetworkBridges to identify all local devices. We do not need to set the channel peer because NetworkBridges always uses the Atheros localcast address. Array address is declared with two dimensions to simplify access to individual addresses on return.
-
-
-
-
-
- NetworkDevices
-
-
-
- size_t NetworkDevices
- struct channel * channel
- void * memory
- size_t extent
-
-
-
- Query a powerline device, specified by channel, for neighboring network devices and store their Ethernet addresses in consecutive memory locations. The memory extent is specified in bytes. The number of devices found is returned as the function value, provided sufficient space is available to store all addresses. Unlike function NetworkBridges, the channelpeer address is identifies the device to be queried.
-
-
-
- Enumerating Network Devices
-
-
-#include <net/if.h>
-#include "../ether/channel.h"
-extern struct channel channel;
-uint8_t address [255][ETHER_ADDR_LEN];
-size_t devices = NetworkDevices (&channel, address, sizeof (address));
-size_t device = 0;
-while (device < devices)
-{
- binout (address [device], ETHER_ADDR_LEN, ':', stdout);
- putc ('\n';, stdout);
-}
-
-
- The code segment shown above illustrates how to use function NetworkDevices to identify all devices on a specific network. You must set the channel peer address before calling NetworkDevices. Array address is declared with two dimensions to simplify access to individual addresses on return. If the channel peer address is not the Ethernet broadcast or Atheros localcast address then the first address returned will be the channel peer address.
-
-
-
-
diff --git a/docbook/support4.xml b/docbook/support4.xml
deleted file mode 100644
index 3fba6f8c..00000000
--- a/docbook/support4.xml
+++ /dev/null
@@ -1,435 +0,0 @@
-
-
- Generic Functions
-
-
- The functions in this chapter are generic and may have application beyond the Open Powerline Toolkit. In some cases, these functions appear in other Atheros or Open Source software packages. In a few cases, the Toolkit may include complementary or supplementary support functions but only use one or two of them. For example, functions memincr and memdecr are both included but memdecr is not used.
-
-
-
- binout
-
-
-
- void binout
- void const * memory
- size_t extent
- char c
- char e
- FILE * fp
-
-
-
- Print a memory region as a series of binary octets separated by character c and terminated by character e. Normally, character c will be BIN_EXTENDER, defined in file number.h, but it could be any character value. Normally, character e will be a space or newline, but it could be any character value. A typical use might be to print a register in readable format. For example, specifying c as '-', e as ';' and extent as 4 would produce output looking something like "10101010-1111111-00000000-11001100;" where each octet is expressed as a binary integer. The function is declared in memory.h and defined in binout.c.
-
-
-
-
- checksum32
-
-
-
- unint32_t checksum32
- const uint32_t memory []
- size_t extent
- uint32_t checksum
-
-
-
- Return the 32 bit checksum of a memory region. The checksum is the one's complement of the XOR of all 32 bit words in the region. Argument extent is the region extent in 32 bit words. Argument checksum is the reference checksum. The function will return the computed checksum when referencechecksum is 0 and will return 0 if reference checksum equals the computed checksum. A typical use is to validate PIB and NVM files or compute new checksums when these files are created or modified. The function is declared in memory.h and defined in checksum32.c.
-
-
- This function is similar to checksum_32 but is used exclusively by API functions. It may be deprecated at some point in the future.
-
-
-
-
- checksum_32
-
-
-
- unint32_t checksum_32
- void const * memory
- size_t extent
- uint32_t checksum
-
-
-
- Return the 32 bit checksum of a memory region. The checksum is the one's complement of the XOR of all 32 bit words in the region. The region extent is specified in bytes but it will be rounded down to the nearest multiple of 4 bytes. Argument checksum is the reference checksum. The function will return the computed checksum when referencechecksum is 0 and will return 0 if reference checksum equals the computed checksum. A typical use is to validate PIB and NVM files or compute new checksums when these files are created or modified. The function is declared in memory.h and defined in checksum_32.c.
-
-
- This function is similar to function checksum32 however there is no need to cast memory to uint32_t and there is no need to round extent down to a multiple of 4 bytes before calling the function because both operations are performed internally. Also, there is no unecessary endian manipulation of the checksum. It is the prefered method of computing a checksum.
-
-
-
-
- chrout
-
-
-
- void chrout
- void const * memory
- size_t extent
- char c
- char e
- FILE * fp
-
-
-
- Print a memory region as a string of printable ASCII characters terminated by character e. Character c is printed in place of non-printable characters. The string is terminated by character e. Normally, character c is '.' but it could be any character value. Normally, character e is space or newline but it could be any charcter value. A typical use might be to print a memory region that may (or may not) contain an HFID or other printable text. The function is declared in memory.h and defined in chrout.c.
-
-
-
-
- decout
-
-
-
- void decout
- void const * memory
- size_t extent
- char c
- char e
- FILE * fp
-
-
-
- Print a memory region as a series of decimal octets separated by character c and terminated by character e. Normally, character c will be DEC_EXTENDER, defined in file number.h, but it could be any character value. Normally, character e will be a space or newline but it could be any character value. A typical use might be to print an IP address in readable format. For example, specifying c as '.', character e as '/' and extent as 4 would produce output looking something like "192.168.099.001/" where each octet is expressed as a decimal integer. The function is declared in memory.h and defined in decout.c.
-
-
-
-
- endian
-
-
-
- void endian
- void * memory
- size_t extent
-
-
-
- Reverse the byte order of a memory region. It is a variable extent version of functions like __bswap_16, __bswap_32 and __bswap_64. The function is declared in memory.h and defined in endian.c.
-
-
-
-
- fdchecksum32
-
-
-
- unit32_t fdchecksum32
- int fd
- size_t extent
- unit32_t checksum
-
-
-
- Return the 32 bit checksum of a file region starting from the current file position. The checksum is the one's complement of the XOR or of all 32 bit words in the region. Argument extent must be specified in 32 bit words, not bytes. Argument checksum is the reference checksum. The function will return the computed checksum when referencechecksum is 0 and will return 0 if reference checksum equals the computed checksum. A typical use is to validate NVM files header by header or section by section. The function is declared in memory.h and defined in fdchecksum32.c.
-
-
-
-
- fdchecksum_32
-
-
-
- unit32_t fdchecksum_32
- int fd
- size_t extent
- unit32_t checksum
-
-
-
- Return the 32 bit checksum of a file region starting from the current file position. The checksum is the one's complement of the XOR or of all 32 bit words in the region. Argument extent is specified in bytes but is rounded down to the nearest multiple of 4 bytes. Argument checksum is the reference checksum. The function will return the computed checksum when referencechecksum is 0 and will return 0 if reference checksum equals the computed checksum. A typical use is to validate NVM files header by header or section by section. The function is declared in memory.h and defined in fdchecksum_32.c.
-
-
- This function is similar to function fdchecksum32 but there is no need to round extent down to the nearest multiple of 4 bytes before calling the function because that is done internally. Also, there is no unecessary endian manuipulation of the checksum.
-
-
-
-
- filepart
-
-
-
- char const * filepart
- char const * pathname
-
-
-
- Return the address of the filename portion of a pathname string. The filename portion is everything after the rightmost path separator. If a path separator is not present then the address of the pathname string is returned. This function is similar to the POSIX basename function but it returns an empty string whenever the rightmost character is a path separator. The path separator can be either slash ('/') or backslash ('\\'). The function is declared in files.h and defined in filepart.c.
-
-
-
-
- hexdecode
-
-
-
- signed hexdecode
- void * memory
- size_t extent
- char const buffer []
- size_t extent
-
-
-
- Decode a memory region as a string of ASCII hexadecimal digits. Convert memory until the buffer or memory exhausts and return the string extent. Allow three (3) string characters for each memory byte to be decoded. The number of bytes decoded will be the lesser of argument extent divided by 3 or argument extent. The function is declared in memory.h and defined in hexdecode.c.
-
-
-
-
- hexdump
-
-
-
- void hexdump
- void const * memory
- size_t offset
- size_t extent
- FILE * fp
-
-
-
- Print a full or partial memory region in hexadecimal format showing memory offsets, hexadecimal byte values and ASCII character values. Argument memory contains some memory region. Argument extent is the region extent. Argument offset is the starting display location. Locations memory [offset] up to memory [extent] are displayed, allowing a partial dump of the memory region. An offset of 0 will display the entire region. The function is declared in memory.h and defined in hexdump.c.
-
-
- This function is similar to but different from function hexview .
-
-
-
-
- hexencode
-
-
-
- signed hexencode
- void * memory
- size_t extent
- char const * string
-
-
-
- Encode a memory region with the binary equivalent of an ASCII hexadecimal string. Return the number of bytes encoded or 0 on error. The value of errno is set to EINVAL if the number of bytes encoded is less than extent or the entire string cannot be converted due to illegal digits or excessive digits. Ignore optional HEX_EXTENDER characters separating octets in argument string. Constant HEX_EXTENDER is defined in file number.h. The function is declared in memory.h and defined in hexencode.c.
-
-
-
-
- hexin
-
-
-
- ssize_t hexin
- void const * memory
- size_t extent
- FILE * fp
-
-
-
- This function is similar to hexencode but it reads from file, instead of a string and ignores non-hexadecimal text and comments within the input stream. Incoming text is binary encoded and written to the specified memory region. The actual number of bytes encoded is returned or -1 on error. See the efsu man page for a thorough explanation of function behavior. The function is declared in memory.h and defined in hexin.c.
-
-
-
-
- hexout
-
-
-
- void hexout
- void const * memory
- size_t extent
- char c
- char e
- FILE * fp
-
-
-
- Print a memory region as a series of hexdecimal octets separated by character c and termianted by character e. Normally, character c will be HEX_EXTENDER, defined in file number.h, but it could be any character value. Normally, character e will be a space or newline but it could be any character value. A typical use might be to print a MAC or Ethernet address in readable format. For example, specifying c as ':', character e as ',' and extent as 6 would produce output looking something like "00:B0:52:DA:DA:01," where each octet is expressed as a hexadecimal integer. The function is declared in memory.h and defined in hexout.c.
-
-
-
-
- hexstring
-
-
-
- char * hexstring
- char buffer []
- size_t length
- void const * memory
- size_t extent
-
-
-
- Convert a memory region to a NUL terminated string and return the string address. This function is identical to function hexdecode but it return the string address instead of the number of characters decoded. The function is declared in memory.h and defined in hexstring.c.
-
-
-
-
- hexview
-
-
-
- void hexview
- void const * memory
- size_t offset
- size_t extent
- FILE * fp
-
-
-
- Print a partial memory region in hexadecimal format showing memory offsets, hexadecimal byte values and ASCII character values. Argument memory contains part of a larger memory region, much like a file window. Argument extent is the window length. Argument offset is the relative offset of the window within the region. Locations memory [0] up to but excluding memory [extent] are displayed as a partial dump, providing a window into the region. The function is declared in memory.h and defined in hexview.c.
-
- This function is similar to but different from function hexdump.
-
-
-
-
- memdecr
-
-
-
- signed memdecr
- void * memory
- size_t extent
-
-
-
- Decrement a multi-byte memory region. Return 0 on success or -1 if all bytes have decremented to 0x00. For example, { 0xFF, 0xFF, 0xFF } decrements to { 0xFF, 0xFF, 0xFE } and { 0xFF, 0x00, 0x00 } decrements to { 0xFE, 0xFF, 0xFF }. A typical use is to iterate through a range if IP or MAC address values. The function is declared in memory.h and defined in memdecr.c.
-
-
-
-
- memincr
-
-
-
- signed memincr
- void * memory
- size_t extent
-
-
-
- Increment a multi-byte memory region. Return 0 on success or -1 once all bytes have been incremented to 0xFF. For example { 0x00, 0x00, 0x00 } increments to { 0x00, 0x00, 0x01 } and { 0x00, 0xFF, 0xFF } increments to { 0x01, 0x00, 0x00 }. A typical use is to iterate through a range of IP or MAC address values. The function is declared in memory.h and defined in memincr.c.
-
-
-
-
- memout
-
-
-
- void memout
- void const * memory
- size_t extent
- char const * format
- unsigned group
- signed c
- FILE * fp
-
-
-
- Print a memory region as a series of octet groups wach separated by character c. The group argument specifies the number of octets per group. The format argument determines how each octet is displayed. Normally, character c will be one of BIN_EXTENDER, DEC_EXTENDER or HEX_EXTENDER as defined in file number.h, but it could be any character value. The function is declared in memory.h and defined in memout.c.
-
-
-
-
- memswap
-
-
-
- void memswap
- void * buffer1
- void * buffer2
- size_t length
-
-
-
- Exchange the contents of one buffer with that of another. No provision is made for buffer overlap. No value is returned. A typical use might be to exchange source and destination addresses in an ethernet packet. The function is declared in memory.h and defined in memswap.c.
-
-
-
-
- strdecr
-
-
-
- signed strdecr
- void * memory
- size_t extent
- byte min
- byte max
-
-
-
- Decrement a multi-byte memory region using only ASCII character values in the range min through max. Return 0 on success or -1 once all characters have been decremented to the value of argument min. For example, if argument min is 'A' and argument max is 'Z' then { 'A', 'B', 'C' } decrements to { 'A', 'B', 'B' } and { 'B', 'Z', 'Z' } decrements to { 'A', 'A', 'A' }. A typical use is to generate a sequence of distinct character strings to seed encryption key functions. The function is declared in memory.h and defined in strdecr.c.
-
-
-
-
- strfbits
-
-
-
- size_t strfbits
- char const buffer []
- size_t length
- char const * operands []
- char const * operator
- unsigned flagword
-
-
-
- Encode a buffer with an enumerated list of the operands associated with the corresponding bits in flagword. separate enumerated operands with an operator string. For example, given char const *operands [] = { "loop", "wait", "busy" } and unsigned flagword = 0x05 then strfbits (buffer, length, operands, "|", flagword) would encode buffer with "loop|busy". Observe that each bit set in flagword appears in buffer as the corresponding string from operands. A typical application for this function is the enumeration of flagword states. The function is declared in format.h and defined in strfbits.c.
-
-
-
-
- strincr
-
-
-
- signed strincr
- void * memory
- size_t extent
- byte min
- byte max
-
-
-
- Increment a multi-byte memory region using only ASCII character values in the range min through max. Return 0 on success or -1 once all characters have been incremented to the value of argument max. For example, if argument min is 'A' and argument max is 'Z' then { 'A', 'B', 'C' } increments to { 'A', 'B', 'D' } and { 'A', 'Z', 'Z' } increments to { 'B', 'A', 'A' }. A typical use is to generate a sequence of distinct character strings to seed encryption key functions. The function is declared in memory.h and defined in strincr.c.
-
-
-
-
- todigit
-
-
-
- unsigned todigit
- unsigned c
-
-
-
- Return the integer value of character c interpreted as digit in the base 36 number system. It is called by many encode functions to support number base conversion. If the value of c is '0' through '9' then integer 0 through 9 is returned. If the value of c is 'A' through 'Z' or 'a' through 'z' then integer 10 through 35 is returned. The function is declared in number.h and defined in todigit.c.
-
-
-
-
- typename
-
-
-
- char const * typename
- const struct _type_ list []
- size_t size
- type_t type
- char const * name
-
-
-
- Return the name associated with a message type by searching a list arranged in ascending order by message type. Return argument name as the function value if the message type is not present in the list. Data types struct _type_ and type_t are defined in file types.h. A typical use might be to return the name of message based on the message type. The function is declared in symbol.h and defined in typename.c.
-
-
-
diff --git a/docbook/support5.xml b/docbook/support5.xml
deleted file mode 100644
index b0d2482a..00000000
--- a/docbook/support5.xml
+++ /dev/null
@@ -1,76 +0,0 @@
-
-
- Message Debug Functions
-
-
- Message debug functions are not needed for proper toolkit operation but they can be useful during development, debugging and testing phases of product development. They are specific to HomePlug AV messages only.
-
-
-
- MMECode
-
-
-
- char const * MMECode
- uint16_t MMTYPE
- uint8_t MSTATUS
-
-
-
- Return text that explains the status code for a given Atheros vendor-specific management message. Argument MMTYPE is an unsigned integer in the range 0xA000 through 0xAFFF and must exactly match the MMTYPE of the message returning the status code. For example, the CNF variant of a message is currently the only variant that has an MSTATUS field and so other variants return a default string. The function is declared in mme.h and defined in MMECode.c.
-
-
- Inclusion of this function can increase application size by 3kb because the text associated with all Atheros vendor-specific management messages and errors are included whether needed or not. Conditional compilation statements are provided internally to suppress the full table with a terse substitute.
-
-
- Although the Bootloader and firmware share some common Vendor Specific Management Messages, the two programs may return different codes for a given message and error condition. Where there are conflicts, Bootloader codes take precedence over firmware codes because it is unlikely that users will .issue the same messages to a device running firmware.
-
-
-
-
- MMEMode
-
-
-
- char const * MMEMode
- uint16_t MMTYPE
-
-
-
- Return the mode of a given management message type as a string. The mode is determined by the two least significant bits of argument MMTYPE. The mode string will be one of REQ, CNF, IND or RSP. The function is declared in ihp.h and defined in MMEMode.c.
-
-
- Most management messages have a request and a confirmation variant while a few have an indication and a response variant. Requests originate from the host and are acknolwedged by a confirmation from the device. Indications originate from a device and are acknowledged by a response from the host.
-
-
-
-
- MMEName
-
-
-
- char const * MMEName
- uint16_t MMTYPE
-
-
-
- Return the name associated with a given management message type. The name is the mnemonic used to distinguish one message type from another in the HomePlug AV Specification or Atheros Firwmare Technical Reference Manual. Argument MMTYPE is an unsigned integer in the range 0x0000 through 0xAFFF. The request, confirmation, indication and response variants of a management message will all return the same message name. The function is declared in mme.h and defined in MMEName.c.
-
-
-
-
- MMEPeek
-
-
-
- void MMEPeek
- void const * memory
- size_t extent
- FILE *fp
-
-
-
- Prints an Atheros vendor-specific management message to stream fp in human readable format. Argument buffer is the message address and argument extent is the message extent in bytes. Output consists of a formatted header showing decoded header. The function is declared in mme.h and defined in MMEPeek.c.
-
-
-
diff --git a/docbook/support6.xml b/docbook/support6.xml
deleted file mode 100644
index 1a521052..00000000
--- a/docbook/support6.xml
+++ /dev/null
@@ -1,242 +0,0 @@
-
-
- Key Generation Functions
-
-
- Atheros applications use the SHA256 algorithm to compute unique HomePlug AV keys, including the Device Access Key (DAK), Network Membership Key (NMK) and Network Identifier (NID). The SHA256 algorithm is seeded, salted and rehashed differently for each type of HomePlug AV key. A different function is used to compute each type of HomePlug AV key but all of them call the SHA256 functions. The SHA256 algorithm returns a 256 bit (32 byte) digest but only the upper 128 bits (16 bytes) are used for HomePlug AV keys.
-
-
-
- SHA256 Digest Computation
-
-
- The following code example illustrates how to generate, rehash and print an SHA256 digest, or key, from a user-defined seed string and salt string. This logic is typical of that used to generate HomePlug AV compliant keys. See the HomePlug AV Specification for the specific rules used to generate each type of key.
-
-
-
-#include "../crypt/SHA256.h"
-
-#include "../crypt/SHA256Reset.c"
-#include "../crypt/SHA256Block.c"
-#include "../crypt/SHA256Write.c"
-#include "../crypt/SHA256Fetch.c"
-
-struct sha256 sha256;
-char * seed = "ForMeToKnowAndYouToFindOut";
-char * salt = "X$z@p";
-byte digest [SHA256_DIGEST_SIZE];
-int i;
-
-SHA256Reset (&sha256);
-SHA256Write (&sha256, (byte *)(seed), strlen (seed));
-SHA256Write (&sha256, (byte *)(salt), strlen (salt));
-SHA256Fetch (&sha256, digest);
-
-for (i = 0; i < 999; i++)
-{
- SHA256Reset (&sha256);
- SHA256Write (&sha256, digest, sizeof (digest));
- SHA256Fetch (&sha256, digest);
-}
-for (i = 0; i < 16; i++)
-{
- printf ("%02x", digest [i]);
-}
-printf ("\n");
-]]>
-
- Above, we declare struct sha256 and initialize it using function SHA256Reset. We then write a user-defined seed string (or password) followed by an optional salt string to the digest using function SHA256Write. The resulting digest (or key) is obtained by calling function SHA256Fetch. Constant SHA256_DIGEST_SIZE is defined in SHA256.h. Although the digest is probably secure enough at this point, we rehash it 999 times for good measure. We then print the first 16 bytes of the result because HomePlug AV keys are always 16 bytes long.
-
-
-
-
- MACPasswords
-
-
-
- void MACPasswords
- uint32_tvendor
- uint32_tdevice
- uint32_tnumber
- unsigned count
- unsigned bunch
- unsigned space
- flag_t flags
-
-
-
- Print a range of device addresses and user passwords on stdout. The calling application must split the starting device address into a three-byte OUI and three-byte device number and pass them as the unsigned 32-bit integers vendor and device, respectively. Argument device is the first device number in the range and number is the final device number. Argument count is the number of uppercase letters comprising a password. Passwords contain this many letters but the letters are grouped for easy reading. Letter groups are separated by hyphens. Argument bunch defines how many letters form each group. Argument space is the character used to separate groups of letters. Argument flags enables or disables function features such as insertion of a used flag for use by the Atheros Production Test System or the omission of the device address on output. The output of this function is similar to that produced by the DB Builder utility distributed with the PTS. This function is declared in keys.h and defined in MACPasswords.c.
-
-
-
- HPAVKeyDAK
-
-
-
- void HPAVKeyDAK
- byte DAK []
- char const string
-
-
-
- Encode buffer DAK with the Device Access Key (DAK) derived from the NUL terminated string. The string is salted, hashed and re-hashed using the SHA256 algorithm. The DAK is always HPAVKEY_DAK_LEN bytes, defined in HPAVKey.h, so no length argument is needed. See the HomePlug AV Specification for more information. This function is declared in HPAVKey.h and defined in HPAVKeyDAK.c.
-
-
-
-
- HPAVKeyNMK
-
-
-
- void HPAVKeyNMK
- byte digest []
- char const string
-
-
-
- Encode buffer NMK with the Network Membership Key (NMK) derived from the NUL terminated string. The string is salted, hashed and re-hashed using the SHA256 algorithm. The DAK is always HPAVKEY_NMK_LEN bytes, as defined in HPAVKey.h, so no length argument is needed. See the HomePlug AV Specification for more information. This function is declared in HPAVKey.h and defined in HPAVKeyNMK.c.
-
-
-
-
- HPAVKeyNID
-
-
-
- void HPAVKeyNID
- byte NID []
- byte const NMK []
- signed level
-
-
-
- Encode buffer NID with the Network Identification Key (NID) derived from the 16-byte Network Membership Key (NMK). The NMK is hashed and re-hashed using the SHA256 algorithm then encoded with the security level. The NID is always HPAVKEY_NID_LEN bytes, as defined in HPAVKey.h, so no length argument is needed. See the HomePlug AV Specification for more information. This function is declared in HPAVKey.h and defined in HPAVKeyNID.c.
-
-
-
-
- HPAVKeyOut
-
-
-
- void HPAVKeyOut
- byte const digest []
- size_t length
- char const * phrase
- flag_t flags
-
-
-
- Decode and print up to length bytes from buffer digest on stdout. Print NUL terminated phrase on the same line following the digest when bit HPAVKEY_VERBOSE, defined in HPAVKey.h, is set in flags. This procedure prints keys and phrases in a standard column-oriented format that other applications can easily read and use. This function is declared in HPAVKey.h and defined in HPAVKeyOut.c.
-
-
-
-
- SHA256Block
-
-
-
- void SHA256Block
- struct sha256 * sha256
- void const * memory
-
-
-
- Merge 64 bytes of memory into the current SHA256 digest. This function performs the core computations required by the SHA256 algoithm. It is called by function SHA256Fetch and so there is no reason to call this function directly. The sha256 structure is defined in SHA256.h. The function is declared in SHA256.h and defined in SHA256Block.c.
-
-
-
-
- SHA256Fetch
-
-
-
- void SHA256Fetch
- struct sha256 * sha256
- byte digest []
-
-
-
- Conclude SHA256 computation and transfer the result to the named 32-byte digest then flush the sha256 structure. The digest is always 32 bytes long regardless of the amount of information that has been written using function SHA256Write. The sha256 structure is defined in SHA256.h. This function is declared in SHA256.h and defined in SHA256Fetch.c.
-
-
- Once this function is called, the sha256 structure is purged for security reasons. You must call SHA256Reset again before starting another hash or subsequent calls to this function or SHA256Write will have unpredictable results. .
-
-
-
-
- SHA256Ident
-
-
-
- void SHA256Ident
- int fd
- byte digest []
-
-
-
- Compute the SHA256 digest from the content of a file. The digest serves as the file fingerprint and can be used to identify identical content despite filename changes. File descriptor fd is the subject file which must be positioned to the start befor calling this function. Buffer digest will be written with the computed 256-digest and must be SHA256_DIGEST_SIZE bytes long, as defined in SHA256.h. This function is declared in SHA256.h and defined in SHA256Ident.c.
-
-
-
-
- SHA256Match
-
-
-
- void SHA256Match
- int fd
- byte const digest []
-
-
-
- Search a registry file for a known SHA256 digest. Return true on success or false on failure. File descriptor fd is the registry file which must be positioned to the start before calling this function. Buffer digest contains the known 256-bit digest and must be SHA256_DIGEST_SIZE bytes long, as defined in SHA256.h. A registry file consists of 64-digit hexadecimal strings that represent SHA256 digest values. Optional text may be appear between the digest and newline to document digest significance. This function ignores such text. This function is declared in SHA256.h and defined in SHA256Match.c.
-
-
-
-
- SHA256Print
-
-
-
- void SHA256Print
- byte const digest []
- char const * string
-
-
-
- Print an SHA256 digest and optional string on stdout. Buffer digest must be SHA256_DIGEST_SIZE bytes long, as defined in SHA256.h, which results in 64 hexadecimal digits on output. Variable length string is NUL terminated but may be NULL. If string is not NULL and is not empty then a space is inserted between the digest and the string on output. This function may be used to print SHA256 digests and optional strings in standard format, such as a registry file. This function is declared in SHA256.h and defined in SHA256Print.c.
-
-
-
-
- SHA256Reset
-
-
-
- void SHA256Reset
- struct sha256 * sha256
-
-
-
- Initialize a sha256 structure before computing a new SHA256 digest. This function should be called once before calling SHA256Write for the first time for a given digest. The sha256 structure is defined in SHA256.h. This function is declared in SHA256.h and defined in SHA256Reset.c.
-
-
-
-
- SHA256Write
-
-
-
- void SHA256Write
- struct sha256 * sha256
- void const * memory
- size_t extent
-
-
-
- Writes a region of memory to the current SHA256 digest contained in an sha256 structure. An application may call this function any number of times to concatinate multiple memory regions before fetching the digest with function SHA256Fetch. The sha256 structure is defined in SHA256.h. This function is declared in SHA256.h and defined in SHA256Write.c.
-
-
-
diff --git a/docbook/support7.xml b/docbook/support7.xml
deleted file mode 100644
index 3187e4fd..00000000
--- a/docbook/support7.xml
+++ /dev/null
@@ -1,307 +0,0 @@
-
-
- XML Editing Functions
-
-
- Atheros provides support for remote PIB management using XML instruction files. The concept is based on an XML schema that defines the elements and attributes needed to edit a PIB file. The schema is located in file piboffset.xsd. In practice, this schema could be used to edit any buffer containing data but we are only interested in editing PIB files here.
-
-
- Users may create XML files that conform to the schema and specify the PIB objects they want to change and how they want each to change. In brief, the files specify an offset, a data length and a data value. A data value has type dataString, dataHex or dataByte and may be a single data item or an array of data items. Each XML file should include a reference to the Atheros schema and be submitted to a validating XML parser, such as Internet Explorer or Firefox, to ensure that file structure and syntax are correct before use. An example XML file can be seen in piboffset.xml.
-
-
- Editing involves the following steps. An example of these steps can be seen in the pxe program source code and in function RdModWrPib2.c which is a component of the int6k2 program.
-
-
-
- Obtain a copy of the PIB to be edited. This can be done by opening a PIB file and reading the entire file into memory or by requesting the PIB directly from an active Atheros powerline device. The PIB length can be determined from the PIB header.
-
-
-
-
- Open the XML file, generate an XML parse tree and close the file. This can be done by passing the filename to function xmlopen. It will perform all these steps and return the parse tree root node.
-
-
-
-
- Modify the PIB based to instructions stored in the parse tree. This is done by passing the parse tree, PIB buffer and PIB length to function xmledit. It will traverse the parse tree and apply changes to the buffer as defined in the parse tree.
-
-
-
-
- Discard the parse tree. This can be done by passing the parse tree to function xmlfree.
-
-
-
-
- Compute a new PIB checksum. This can be done by clearing the PIB checksum then passing the PIB buffer and PIB length to function checksum32 with a checksum value of 0.
-
-
-
-
- Write the PIB to file or transmit it over the network to an Atheros powerline device.
-
-
-
-
-
-
- xmledit
-
-
-
- signed xmledit
- struct node * node
- void *memory
- unsigned extent
-
-
-
- Write data into memory based on the data offset and length defined in XML parse tree, node. This function will not apply modifications having malformed structure or having an invalid or illegal offset, length or data value. Use function xmlschema to print the current schema. The function is declared in node.h and defined in xmledit.c. The node structure is defined in node.h.
-
-
-
-
- xmlfree
-
-
-
- void xmlfree
- struct node * node
-
-
-
- Release memory associated with an XML parse tree. The function is declared in node.h and defined in xmlfree.c. The node structure is defined in node.h.
-
-
- The text member if the parse tree root node points to memory allocated by xmlscan to store the original XML string. The application must either deallocate that memory before calling this function or store the text address and deallocate that memory after calling this function; otherwise, memory leaks will result.
-
-
-
-
- xmlnode
-
-
-
- struct node *xmlnode
- struct node *node
-
-
-
- Create an empty node blow the specified node and return a pointer to it. A typical application can be seen in function xmlscan.c. The function is declared in node.h and defined in xmlnode.c. The node structure is defined in node.h.
-
-
-
-
- xmlopen
-
-
-
- struct node * xmlopen
- char const * filename
-
-
-
- Open the named XML file, parse it and return the XML parse tree. The parse tree contains, among other things, all XML elements, attributes and values specified in the file. The function is declared in node.h and defined in xmlopen.c. The node structure is defined in node.h.
-
-
- The returned parse tree is ready to traverse using struct node members above, below, prior and after. Each node has a line, type and test member. This function calls function xmlscan to parse the file and generate the tree. The parse tree can be inspected by passing the root node to function xmltree.
-
-
-
-
- xmlscan
-
-
-
- signed xmlscan
- struct node * node
-
-
-
- Scan the XML string attached to the specified node and create a parse tree below it. Return 0 if parsing is successrul or -1 if not. The function is declared in node.h and defined in xmlscan.c. The node structure is defined in node.h.
-
-
- The application must point the text member to a copy of the XML string before calling this function because parsing is destructive and requires write access to the string. The application can search and manipulate the tree on return. The application should deallocate string memory before calling xmlfree.
-
-
-
- XML Source File
-
-
- The following is sample input to function xmlscan. The element and attribute names shown are for illustration and were selected to that they can be easily identified in the output. The parse tree from this file can be seen in the example for function xmltree.
-
-
-
-
-
- 1234567890
-
-
- The quick brown fox jumped over the lazy dog.
-
-
-
-
-
-
- The quick brown
- fox jumped over
- the lazy dog.
-
-
-
-
-
-
- value2
-
-
-
-]]>
-
-
-
-
- xmlschema
-
-
-
- void xmlschema
-
-
-
-
- Print an XML schema that supports function xmledit on stdout. This function has no argument. The schema produced by this function is guaranteed to support the parse logic implemented by function xmledit. Scheme element names are defined as constants in node.h so that they can be referenced by applications that create their own XML edit instructions. The function is declared in node.h and defined in xmlschema.c.
-
-
- The text member in the parse tree root node points to memory allocated by xmlscan to store the original XML string. The application must either deallocate that memory before calling this function or store the text address and deallocate that memory after calling this function; otherwise, memory leaks will result.
-
-
-
- XML Edit Schema
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-]]>
-
- The schema shown above was produced by function xmlschema. It is should be used to validate XML edit instructions before submitting them to program pxe.
-
-
-
-
-
- xmltree
-
-
-
- void xmltree
- struct node * node
-
-
-
- Print the XML parse tree on stdout. The function is declared in node.h and defined in xmltree.c.
-
-
-
- XML Parse Tree
-
-
- The following is sample output from function xmltree. The XML source is shown in the example for function xmlscan . The numbers appearing down the left margin indicate the input line number from the XML source file parsed by function xmlscan . The character codes indicate the node type and are defined in node.h. The node structure is defined in node.h.
-
-] [1234567890]
-006 [/] [attribute]
-007 [<] [attribute]
-007 [ ] [name]
-007 [=] [Attribute2]
-008 [>] [The quick brown fox jumped over the lazy dog.]
-009 [/] [attribute]
-010 [/] [element]
-011 [<] [element]
-011 [ ] [name]
-011 [=] [Element2]
-012 [<] [attribute]
-012 [ ] [name]
-012 [=] [Attribute1]
-013 [/] [attribute]
-014 [<] [attribute]
-014 [ ] [name]
-014 [=] [Attribute2]
-015 [>] [The quick brown fox jumped over the lazy dog.azy]
-018 [/] [attribute]
-019 [/] [element]
-020 [!] [-- comments can go anywhere --]
-021 [<] [element]
-021 [ ] [name]
-021 [=] [Element2]
-022 [<] [attribute]
-022 [ ] [name]
-022 [=] [Attribute1]
-023 [<] [attribute]
-023 [ ] [name]
-023 [=] [Attribute2]
-024 [>] [value2]
-025 [/] [attribute]
-026 [/] [element]
-027 [/] [xmlfile]
-]]>
-
-
-
diff --git a/docbook/support8.xml b/docbook/support8.xml
deleted file mode 100644
index de75a405..00000000
--- a/docbook/support8.xml
+++ /dev/null
@@ -1,53 +0,0 @@
-
-
- Download Functions
-
-
- Download function write applets, parameters and runtime firmware to device SDRAM or NVRAM.
-
-
-
- WriteExecuteApplet
-
-
-
- signed WriteExecuteApplet
- struct plc * plc
- void const * header
-
-
-
- Write an NVM image directly into SDRAM using VS_WRITE_AND_EXECUTE messages. This function calls either WriteExecuteApplet1 or WriteExecuteApplet2 based on the NVM header version. The function is declared in plc.h and defined in WriteExecuteApplet.c. The plc structure is defined in plc.h.
-
-
-
-
- WriteExecuteApplet1
-
-
-
- signed WriteExecuteApplet1
- struct plc * plc
- struct nvm_header1 * header
-
-
-
- Write an NVM image directly into SDRAM using VS_WRITE_AND_EXECUTE messages. This function is similar to WriteExecuteApplet2 but expects a structure nvm_header1 pointer instead of a structure nvm_header2 pointer. The function is declared in plc.h and defined in WriteExecuteApplet.c. Structure plc is defined in file plc.h. Structure nvm_header1 is defined in file nvm.h.
-
-
-
-
- WriteExecuteApplet2
-
-
-
- signed WriteExecuteApplet2
- struct plc * plc
- struct nvm_header2 * header
-
-
-
- Write an NVM image directly into SDRAM using VS_WRITE_AND_EXECUTE messages. This function is similar to WriteExecuteApplet1 but expects a structure nvm_header2 pointer instead of a structure nvm_header1 pointer. The function is declared in plc.h and defined in WriteExecuteApplet.c. Structure plc is defined in file plc.h. Structure nvm_header1 is defined in file nvm.h.
-
-
-
diff --git a/docbook/support9.xml b/docbook/support9.xml
deleted file mode 100644
index 9604a2ce..00000000
--- a/docbook/support9.xml
+++ /dev/null
@@ -1,80 +0,0 @@
-
-
- Procrastination Functions
-
-
- Procrastinations functions wait for specific events to occur or fail to occur.
-
-
-
- WaitForAssoc
-
-
-
- signed WaitForAssoc
- struct plc * plc
-
-
-
- Poll a powerline device using VS_NW_INFO messages until the device forms or joins a network. The host ethernet interface, destination hardware address and source hardware address are specified in structure plc. It calls either WaitForAssoc1 or WaitForAssoc2 to procrastinate based on the hardwareID member of structure plc. The function is declared in plc.h and defined in file WaitForAssoc.c. Struct plc is declared in file plc.h and defined in file plc.c.
-
-
-
-
- WaitForAssoc1
-
-
-
- signed WaitForAssoc1
- struct plc * plc
-
-
-
- Poll a 200mbs powerline device using VS_NW_INFO version 0 messages until the device joins or forms a network. The host ethernet interface, destination hardware address and source hardware address are specified in structure plc. The function is declared in file plc.h and defined in file WaitForAssoc1.c. Struct plc is declared in file plc.h and defined in file plc.c.
-
-
-
-
- WaitForAssoc2
-
-
-
- signed WaitForAssoc2
- struct plc * plc
-
-
-
- Poll a 1000mbs powerline device using VS_NW_INFO version 1 messages until the device joins or forms a network. The host ethernet interface, destination hardware address and source hardware address are specified in structure plc. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in file plc.h and defined in file WaitForAssoc2.c.
-
-
-
-
- WaitForReset
-
-
-
- signed WaitForReset
- struct plc * plc
-
-
-
- Poll a powerline device using VS_SW_VER messages until the device stops responding. The host ethernet interface, destination hardware address and source hardware address are specified in structure plc. Structure plc is declared in file plc.h and define in file plc.c. The function is declared in plc.h and defined in file WaitForReset.c.
-
-
-
-
- WaitForStart
-
-
-
- signed WaitForStart
- struct plc * plc
- char firmware
- size_t length
-
-
-
- Poll a powerline device using VS_SW_VER messages until the device responds. The host ethernet interface, destination hardware address and source hardware address are specified in structure plc. Update the hardwareID member of the plc structure. Return the firmware revision string contained in the confirmation message. Structure plc is declared in file plc.h and defined in file plc.c. The function is declared in file plc.h and defined in file WaitForStart.c.
-
-
-
diff --git a/docbook/symbol.h.html b/docbook/symbol.h.html
deleted file mode 100644
index 66170f5c..00000000
--- a/docbook/symbol.h.html
+++ /dev/null
@@ -1,79 +0,0 @@
-
-
-
-
-
- symbol.h
-
-
-
-
-
-
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2011 by Qualcomm Atheros.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose with or without fee is hereby granted, provided
- * that the above copyright notice and this permission notice appear
- * in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
- * THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
- * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
- * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
- * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- *
- *--------------------------------------------------------------------*/
-
-#ifndef TIME_HEADER
-#define TIME_HEADER
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#if defined(_MSC_VER) || defined(_MSC_EXTENSIONS)
-# define DELTA_EPOCH_IN_MICROSECS 11644473600000000Ui64
-#else
-# define DELTA_EPOCH_IN_MICROSECS 11644473600000000ULL
-#endif
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-struct timezone
-
-{
-
-/* minutes W of Greenwich */
-
- int tz_minuteswest;
-
-/* type of dst correction */
-
- int tz_dsttime;
-};
-
-int gettimeofday (struct timeval *, struct timezone *);
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * tlv.h - nvm file format definitions and declarations;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef TLV_HEADER
-#define TLV_HEADER
-
-/*====================================================================*
- * macros;
- *--------------------------------------------------------------------*/
-
-#define TLVSPAN(node) (sizeof(*(node))-sizeof((node)->data)+ LE32TOH((node)->size))
-#define TLVDUMP(node) hexdump(&(node)->data,0,(node)->size,stderr)
-
-/*====================================================================*
- * variables;
- *--------------------------------------------------------------------*/
-
-#ifndef __GNUC__
-#pragma pack (push,1)
-#endif
-
-typedef struct __packed TLVNode
-
-{
- uint32_t type;
- uint32_t size;
- uint32_t data;
-}
-
-TLVNode;
-
-#ifndef __GNUC__
-#pragma pack (pop)
-#endif
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
The following is an alphabetical index of the manual pages, header files, source files, scripts and applets that comprise the Qualcomm Atheros Open Powerline Toolkit. It is provided for those who do not have access to on-line manual pages or want to browse through the software.
-#!/bin/sh
-# file: tr069prog.sh
-
-# ====================================================================
-#
-# This script programs a unique TR-069 ACS Username and ACS Password
-# into a INT6400 powerline device and updates the Mfg feed file;
-# the original MAC, DAK and NMK are preserved; the MFG, NET and USR
-# HFIDs are set to the values defined in this file; the ACS Username
-# is derived from the original MAC; the ACS Password is derived from
-# the local host random number generator;
-#
-# devices should be programmed and tested using the PTS then updated
-# using his script; Atheros Powerline Toolkit 1.3.1 is needed;
-#
-# --------------------------------------------------------------------
-
-#
-# Define environment;
-#
-
-ETH=eth0 # PC ethernet port
-NVMFILE=tr069.nvm # This is the NVM file to program
-REFPIB=tr069.pib # This is the PIB template to use
-PIBFILE=tmp.pib # Temp PIB to modify
-MFGFILE=mfgfeed.txt # Manufacturing Feed File
-
-#
-# Determine device identity;
-#
-
-MAC=$(int6kid -Ai ${ETH})
-DAK=$(int6kid -Di ${ETH})
-NMK=$(int6kid -Mi ${ETH})
-
-#
-# Define default HFIDs;
-#
-
-MFG="MANUFACTURER MODEL-AB-02-01"
-NET="MANUFACTURER MODEL-AB-02-01"
-USR="MANUFACTURER MODEL-AB-02-01"
-
-#
-# Make a copy of PIB to edit
-#
-
-cp ${REFPIB} ${PIBFILE}
-
-#
-# Set MAC, DAK, NMK, MFG_HFID, NET_HFID and USR_HFID in PIB file
-#
-
-modpib ${PIBFILE} -M ${MAC} -D ${DAK} -N ${NMK} -S "${MFG}" -T "${NET}" -U "${USR}"
-
-UMAC=$(echo $MAC | sed 'y/abcdef/ABCDEF/' | sed 's/://g' | sed 's/ //g')
-OUI=$(echo $UMAC | cut -c 1-6)
-
-#
-# Build the ACS Username
-#
-
-UNAME="$OUI"-"$UMAC"
-
-#
-# Generate a 16 character lower case random ACS password
-#
-
-RANDOMPWORD=$(</dev/urandom tr -dc a-z0-9| (head -c $1 > /dev/null 2>&1 || head -c 16))
-
-#
-# Set Username and Password in PIB file
-#
-
-setpib ${PIBFILE} 2DCC username ${UNAME}
-setpib ${PIBFILE} 2ECD password ${RANDOMPWORD}
-setpib ${PIBFILE} 2FCE byte 01
-
-#
-# Write NVM and PIB
-#
-
-int6kp -i ${ETH} -P ${PIBFILE} -N ${NVMFILE} -FF -D ${DAK}
-FW=$(int6k -qri ${ETH} | rev | cut -d " " -f1 | rev)
-
-#
-# Write the record to Mfg feed file
-#
-
-echo $UMAC"|"$FW"|"$RANDOMPWORD"|1.0|"$RANDOMPWORD"|000000" >> ${MFGFILE}
-
-
-
-
-
-
diff --git a/docbook/trouble-shooting.xml b/docbook/trouble-shooting.xml
deleted file mode 100644
index 69228fee..00000000
--- a/docbook/trouble-shooting.xml
+++ /dev/null
@@ -1,66 +0,0 @@
-
-
- Trouble-shooting Problems
-
-
- The following steps may help determine why two devices cannot communicate via ethernet over the powerline. They assume that you have successfully installed the Powerline Toolkit but are having trouble forming a powerline network.
-
-
-
-
- On Linux, run program ifconfig to determine available interface names as described earlier. The default interface name is eth1 on Linux. You must use interface names, not numbers, on the Linux command line.
-
-
- On Windows, run program pcapdevs to determine available interface numbers as described earlier. The default interface number is 2 on Windows. You must use interface numbers, not names, on Windows command lines, even under Cygwin.
-
-
- In either case, Linux or Windows, if a powerline device is connected to any interface other than the default interface then you must specify the name or number on the command line each time you run int6k. In the following examples, we will use device numbers 3 and 4 to indicate two different interfaces on the same host.
-
-
-
-
- Make sure both devices respond to int6k -ri3 and int6k -ri4 as described earlier. They should each display the software revision information. If you get no response then check your connections and network configuration. If you see Bootloader then the connection is good but the firmware is not running. If the firmware versions are different then make them the same.
-
-
- You must have running firmware to continue and the firmware revisions should be the same.
-
-
-
-
- Make sure both devices respond to int6k -Ii3 then int6k -Ii4 as described earlier. They should display about 10 lines of information showing their MAC, DAK and NMK.
-
-
- If the MAC is 00:B0:52:00:00:01 then either the default Atheros PIB was stored in NVRAM or you downloaded and flashed the generic Atheros PIB without changing the MAC address beforehand.
-
-
- If the MAC is 00:B0:52:00:00:03 then either no PIB was stored in NVRAM or you downloaded and attempted to flashed an invalid PIB. The firmware will disable powerline communications in this case.
-
-
-
-
- If the devices have different NMKs they will not form a network.
-
-
- One way to form a network is to manually set the NMK on each device to a known value with int6k -Mi3 then int6k -Mi4. Each device will reset afterwards and may reset again when the other device is changed. Repeat Step 3 and confirm that both devices have the same NMK and that (HomePlugAV) appears next to the NMK.
-
-
- Another way to form a network is to physically press the push-button on each device for 2 to 3 seconds or simulate a push-button press on each device with int6k -B1 -i3 then int6k -B1 -i4. The devices should reset several times and then form a network.
-
-
-
-
- Make sure each device knows the other one is present on the network with int6k -mi3 then int6k -Mi4. Each device should show that a network exists and identify the other device as a station on that network. It may take up to 120 seconds for one device to find another and up to 5 minutes to recognise that the other device has left the network.
-
-
-
-
- Step 5 should also show the TX and RX PHY rates for each device. Ping each host Interface from the other several times to generate traffic. The PHY Rates should then be non-zero. We use efsu to generate traffic inside our own scripts. You may elect to use another method.
-
-
-
-
- Power down both devices then power them up. Wait about 20 seconds and confirm that you can ping in either direction.
-
-
-
-
diff --git a/docbook/ttycat.1.html b/docbook/ttycat.1.html
deleted file mode 100644
index 96e5d075..00000000
--- a/docbook/ttycat.1.html
+++ /dev/null
@@ -1,85 +0,0 @@
-
-
-
-
-
- ttycat.1
-
-
-
-
-
-
-
-
-
-ttycat(1) Qualcomm Atheros Open Powerline Toolkit ttycat(1)
-
-NAME
- ttycat - Serial Line Output Utility
-
-SYNOPSIS
- ttycat [options] [file] [file] [>stdout]
-
- ttycat [options] [<stdin] [>stdout]
-
-DESCRIPTION
- Copy one or more files to a serial device. This program is similar to traditional cat utility but expects stdout to be a
- serial tty device. It will configure stdout before writing and will restore the original configuration afterwards. It
- can be used to send data to the local Atheros UART-enabled powerline device. If the remote powerline device is not UART-
- enabled, use program edru to capture and display arriving at the remote host and program edsu to send files in the oppo‐
- site direction.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-COMMENTS
- This program only supports the Linux and MacOSX platforms, at present.
-
-OPTIONS
- -s speed
- The serial baud rate. Supported baud rates are 0, 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800,
- 9600, 19200, 38400, 57600, 115200, 230400, 460800, 500000 and 921600.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- file The name of an input file. No assumptions are made about the file based on the filename or extension. Input
- files are not modified.
-
- stdout The name of a serial output device. A error will occur if the device is not a true tty device according as deter‐
- mined by the isatty function. Depending on the amount of input data and the baud rate, serial output may take
- several seconds or several minutes.
-
-EXAMPLES
- The following command copies files abc.txt and def.bin to stdout which must be an active serial device or an error will
- occur.
-
- # ttycat abc.txt def.bin > /dev/ttyUSB1
-
-SEE ALSO
- amp(1), edru(1), edsu(1), int6kuart(1),
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 ttycat(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2013 Qualcomm Atheros, Inc.
- *
- * 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.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- *
- * ttycat.c - serial port test program;
- *
- * write one or more files to a serial device;
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
- * system header files;
- *--------------------------------------------------------------------*/
-
-#include <stdlib.h>
-#include <limits.h>
-#include <memory.h>
-#include <signal.h>
-#include <termios.h>
-#include <unistd.h>
-
-/*====================================================================*
- * custom header files;
- *--------------------------------------------------------------------*/
-
-#include "../tools/getoptv.h"
-#include "../tools/putoptv.h"
-#include "../tools/number.h"
-#include "../tools/error.h"
-#include "../tools/files.h"
-#include "../serial/serial.h"
-
-/*====================================================================*
- * custom source files;
- *--------------------------------------------------------------------*/
-
-#ifndef MAKEFILE
-#include "../tools/getoptv.c"
-#include "../tools/putoptv.c"
-#include "../tools/version.c"
-#include "../tools/efreopen.c"
-#include "../tools/uintspec.c"
-#include "../tools/todigit.c"
-#include "../tools/error.c"
-#endif
-
-/*====================================================================*
- * program warnings;
- *--------------------------------------------------------------------*/
-
-#if defined (WIN32)
-#error "This program does not support Windows platforms"
-#endif
-
-/*====================================================================*
- *
- * signed copy (signed ifd, signed ofd, void * memory, signed extent)
- *
- * copy ifd to ofd using a buffer of specified size;
- *
- *--------------------------------------------------------------------*/
-
-static signed copy (signed ifd, signed ofd, void * memory, signed extent)
-
-{
- while ((extent = read (ifd, memory, extent)) > 0)
- {
- if (write (ofd, memory, extent) < extent)
- {
- return (-1);
- }
- }
- return (0);
-}
-
-/*====================================================================*
- *
- * int main (int argc, char const * argv []);
- *
- *--------------------------------------------------------------------*/
-
-int main (int argc, char const * argv [])
-
-{
- static char const * optv [] =
- {
- "s:",
- PUTOPTV_S_FUNNEL,
- "copy one or more files to a serial device",
- "s n\tline speed is (n) [115200]",
- (char const *)(0)
- };
- struct termios restore;
- struct termios current;
- speed_t speed = B115200;
- byte buffer [512];
- signed c;
- while ((c = getoptv (argc, argv, optv)) != -1)
- {
- switch (c)
- {
- case 's':
- if (baudrate (uintspec (optarg, 0, UINT_MAX), &speed))
- {
- error (1, 0, "could not set baud rate");
- }
- break;
- default:
- break;
- }
- }
- argc -= optind;
- argv += optind;
- if (!isatty (STDOUT_FILENO))
- {
- error (1, ENOTSUP, "stdout must be a serial line device");
- }
- tcflush (STDOUT_FILENO, TCIFLUSH);
- tcgetattr (STDOUT_FILENO, &restore);
- memset (¤t, 0, sizeof (current));
- current.c_cflag = speed | CS8 | CLOCAL | CREAD;
- current.c_iflag = IGNPAR;
- current.c_oflag = 0;
- current.c_lflag = 0;
- current.c_cc [VTIME] = 0;
- current.c_cc [VMIN] = 5;
- tcsetattr (STDOUT_FILENO, TCSANOW, ¤t);
- if (!argc)
- {
- copy (STDIN_FILENO, STDOUT_FILENO, buffer, sizeof (buffer));
- }
- while ((argc) && (* argv))
- {
- if (efreopen (* argv, "rb", stdin))
- {
- copy (STDIN_FILENO, STDOUT_FILENO, buffer, sizeof (buffer));
- }
- argc--;
- argv++;
- }
- tcsetattr (STDOUT_FILENO, TCSANOW, &restore);
- exit (0);
-}
-
-
-
-ttyrecv(1) Qualcomm Atheros Open Powerline Toolkit ttyrecv(1)
-
-NAME
- ttyrecv - Serial Line Rate Tester (Receive)
-
-SYNOPSIS
- ttyrecv [options] [>stdout]
-
-DESCRIPTION
- Receive data from a serial device. The primary purpose of this program is to receive data over a serial port for a spec‐
- ified time duration.
-
- The ttyrecv program exits after the receive time (see -t) has elapsed.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-COMMENTS
- This program does not yet support Windows platforms.
-
-OPTIONS
- -c Consume all data received (do not print to standard output).
-
- -l file
- The serial port file to read data from. The default is /dev/ttyS0.
-
- -r Print the receive rate to standard output after the receive time has elapsed.
-
- -s speed
- The serial baud rate. Supported baud rates are 0, 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800,
- 9600, 19200, 38400, 57600, 115200, 230400, 460800, 500000 and 921600.
-
- -t time
- Receive for time seconds. The default is 10 seconds.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-EXAMPLES
- None.
-
-SEE ALSO
- amp(1), int6kuart(1), ttysend(1),
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 ttyrecv(1)
-
-ttysend(1) Qualcomm Atheros Open Powerline Toolkit ttysend(1)
-
-NAME
- ttysend - Serial Line Rate Tester (Send)
-
-SYNOPSIS
- ttysend [options] [<stdin]
-
-DESCRIPTION
- Send data to a serial device. The primary purpose of this program is to send data over a serial port that can then be
- received with the ttyrecv utility.
-
- The ttysend program exits when either one of the following conditions are met:
- 1. The file specified on the command line (see -f) is sent in its entirety.
- 2. The send time specified on the command line (see -t) has elapsed.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-COMMENTS
- This program does not yet support Windows platforms.
-
-OPTIONS
- -f file
- The file to send. If this option is not specified, the values 0x00 to 0xFF are sent in a loop. Instead of a
- filename, a '-' may be specified. This is similar to the tar utility, and instructs ttysend to read from standard
- input.
-
- -l file
- The serial port file to send data to. The default is /dev/ttyS0.
-
- -s speed
- The serial baud rate. Supported baud rates are 0, 50, 75, 110, 134, 150, 200, 300, 600, 1200, 1800, 2400, 4800,
- 9600, 19200, 38400, 57600, 115200, 230400, 460800, 500000 and 921600.
-
- -t time
- Transmit for a maximum of time seconds. The default is 15 seconds.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-EXAMPLES
- None.
-
-SEE ALSO
- amp(1), int6kuart(1), ttyrecv(1)
-
-CREDITS
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 ttysend(1)
-
-ttysig(1) Qualcomm Atheros Open Powerline Toolkit ttysig(1)
-
-NAME
- ttysig - Serial Line Signal Controller
-
-SYNOPSIS
- ttysig [options]
-
-DESCRIPTION
- Interactively control serial line output signals (Request To Send, Data Terminal Ready), and read the current value of
- all control signals (Request To Send, Clear To Send, Data Set Ready, Data Terminal Ready, Data Carrier Detect, Ring Indi‐
- cator).
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -s device
- Specify the serial device used. The default is serial console device "/dev/ttyS0".
-
- -D value
- Set the serial control line DTR high if value is non-zero, low otherwise.
-
- -I Interactive mode.
-
- -R value
- Set the serial control line RTS high if value is non-zero, low otherwise.
-
- -r Print serial control line status on stdout. This is performed after -R and -D.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -?,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-EXAMPLES
- The following example sets DTR high and RTS low at program start. The user then interactively prints the current control
- signal values, and then sets DTR low. Since no serial devices are specified, program defaults are used.
-
- $ ./ttysig -I -D 1 -R 0
- command (D #, R #, r, q): r
- RTS: -V
- CTS: -V
- DSR: -V
- DTR: +V
- DCD: -V
- RI : -V
- command (D #, R #, r, q): D 0
- command (D #, R #, r, q):
-
-SEE ALSO
- amp(1), int6kdetect(1), int6kuart(1)
-
-CREDITS
- Nathaniel Houghton <nhoughto@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 ttysig(1)
-
-/*====================================================================*
- *
- * Copyright (c) 2011 by Qualcomm Atheros.
- *
- * Permission to use, copy, modify, and/or distribute this software
- * for any purpose with or without fee is hereby granted, provided
- * that the above copyright notice and this permission notice appear
- * in all copies.
- *
- * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
- * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
- * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL
- * THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
- * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
- * LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
- * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
- * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
- *
- *--------------------------------------------------------------------*/
-
-/*====================================================================*
-
- *
- * unistd.h - substitute unistd.h file for Windows;
- *
- * this is an important POSIX header that Microsoft ommits;
- *
- * Contributor(s):
- * Charles Maier <cmaier@qca.qualcomm.com>
- * Nathaniel Houghton <nhoughto@qca.qualcomm.com>
- * Abdel Younes <younes@leacom.fr>
- *
- *--------------------------------------------------------------------*/
-
-#ifndef UNISTD_HEADER
-#define UNISTD_HEADER
-
-/*====================================================================*
- * system header files
- *--------------------------------------------------------------------*/
-
-#if defined (WIN32)
-#include <io.h>
-#endif
-
- /*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#define STDIN_FILENO 0
-#define STDOUT_FILENO 1
-#define STDERR_FILENO 2
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#if defined (WIN32)
-#define sleep(x) Sleep(1000*(x))
-#define strcasecmp(a,b) stricmp(a,b)
-typedef signed ssize_t;
-#endif
-
-#if !defined (_MSC_VER) || _MSC_VER < 1500
-#define vsnprintf _vsnprintf
-#endif
-
-#define snprintf _snprintf
-
-/*====================================================================*
- *
- *--------------------------------------------------------------------*/
-
-#endif
-
-
-
-
-/*
- * Copyright (c) 2006 Paolo Abeni (Italy)
- * All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- *
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. 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.
- * 3. The name of the author may not be used to endorse or promote
- * products derived from this software without specific prior written
- * permission.
- *
- * 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.
- *
- * Basic USB data struct
- * By Paolo Abeni <paolo.abeni@email.it>
- *
- * @(#) $Header: /tcpdump/master/libpcap/pcap/usb.h,v 1.6 2007/09/22 02:06:08 guy Exp $
- */
-
-#ifndef _PCAP_USB_STRUCTS_H__
-#define _PCAP_USB_STRUCTS_H__
-
-/*
- * possible transfer mode
- */
-#define URB_TRANSFER_IN 0x80
-#define URB_ISOCHRONOUS 0x0
-#define URB_INTERRUPT 0x1
-#define URB_CONTROL 0x2
-#define URB_BULK 0x3
-
-/*
- * possible event type
- */
-#define URB_SUBMIT 'S'
-#define URB_COMPLETE 'C'
-#define URB_ERROR 'E'
-
-/*
- * USB setup header as defined in USB specification.
- * Appears at the front of each packet in DLT_USB captures.
- */
-typedef struct _usb_setup {
- u_int8_t bmRequestType;
- u_int8_t bRequest;
- u_int16_t wValue;
- u_int16_t wIndex;
- u_int16_t wLength;
-} pcap_usb_setup;
-
-/*
- * Header prepended by linux kernel to each event.
- * Appears at the front of each packet in DLT_USB_LINUX captures.
- */
-typedef struct _usb_header {
- u_int64_t id;
- u_int8_t event_type;
- u_int8_t transfer_type;
- u_int8_t endpoint_number;
- u_int8_t device_address;
- u_int16_t bus_id;
- char setup_flag;/*if !=0 the urb setup header is not present*/
- char data_flag; /*if !=0 no urb data is present*/
- int64_t ts_sec;
- int32_t ts_usec;
- int32_t status;
- u_int32_t urb_len;
- u_int32_t data_len; /* amount of urb data really present in this event*/
- pcap_usb_setup setup;
-} pcap_usb_header;
-
-#endif
-
-/*-
- * Copyright (c) 1990, 1991, 1992, 1993, 1994, 1995, 1996, 1997
- * The Regents of the University of California. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- * notice, this list of conditions and the following disclaimer.
- * 2. 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.
- * 3. All advertising materials mentioning features or use of this software
- * must display the following acknowledgement:
- * This product includes software developed by the University of
- * California, Berkeley and its contributors.
- * 4. Neither the name of the University nor the names of its contributors
- * may be used to endorse or promote products derived from this software
- * without specific prior written permission.
- *
- * THIS SOFTWARE IS PROVIDED BY THE REGENTS 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 REGENTS 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.
- *
- * @(#) $Header: /tcpdump/master/libpcap/pcap/vlan.h,v 1.1.2.2 2008-08-06 07:45:59 guy Exp $
- */
-
-#ifndef lib_pcap_vlan_h
-#define lib_pcap_vlan_h
-
-struct vlan_tag {
- u_int16_t vlan_tpid; /* ETH_P_8021Q */
- u_int16_t vlan_tci; /* VLAN TCI */
-};
-
-#define VLAN_TAG_LEN 4
-
-#endif
-
-weeder(1) Qualcomm Atheros Open Powerline Toolkit weeder(1)
-
-NAME
- weeder - Weeder Solid State Relay Module Controller
-
-SYNOPSIS
- weeder [options] [attenuation]
-
-DESCRIPTION
- Set or get the attenuation level on the Qualcomm Atheros Production Test System using a local RS-232 communication port.
- Attenuator settings are changed if an attenuation value is specified. Attenuator settings are read and displayed if no
- attenuation value is specified. The serial port settings must be configured before running this program. Settings are
- 9600 baud, no parity, 8 data and 1 stop bit. See datasheet http://www.weedtech.com/wtssr-m.pdf for more information.
-
-OPTIONS
- -e echo
- Enable or disable echo mode. The value of echo can be 1=on or 0=off. Alternately, keywords "on" and "off" can be
- used. Atheros recommends that you always disable echo when using this program to speed relay switching.
-
- -m mode
- Turn on or off the Device Under Test power. The value of mode can be 1=on or 0=off. Alternately, keywords "on"
- and "off" can be used.
-
- -o units
- Change relay control module order. Individual relay control modules are assigned a digital address that can be
- referenced using the UTF-8 letters "[A-P]" then "[a-p]". The Atheros PTS is configured so that module "B" is
- activated before module "A". This options lets you specify some other module order. The default value is "BA" to
- indicate "B" before "A".
-
- -p port
- The name of the serial port. On Linux, the name is usually "/dev/ttyS[0-4]". On OS/X, the name is usually
- "/dev/cua[0-4]". On Windows, the name is "com[0-9]:". The default is "/dev/ttyS0" on Linux and "com1:" on Win‐
- dows. If environment string "WEEDER" is defined then it takes precedence over the default serial port. This
- option then takes precedence over either default. Belkin USB-to-serial cables are named "/dev/ttyUSB0" on Linux.
-
- -w wait
- Wait time in milliseconds. Serial I/O operation are slow and a delay is needed after each write operation.
- Unfortunately, different operating systems require different wait times. This options lets you adjust the time.
- The default is 10 milliseconds which should be adequate on most systems.
-
-ARGUMENTS
- attenuation
- The attenuation in decibels. The attenuation may be expressed in decimal, binary or hexadecimal when setting
- attenuator but is displayed in decimal when reading the attenuator. Binary values start with "0b" and hexadecimal
- values start with "0x".
-
-EXAMPLES
- The following example turns the Device Under Test power on and configures the attenuator for 72db attenuation. Option -m
- is not necessary if the Device Under Test power is already on.
-
- # weeder -m 1 72
-
- The next example configures the controller for 42db attenuation. There is no needed to turn the Device Under Test on
- again because it remains on until turned off.
-
- # weeder 42
-
- The next example configures the controller for 56db attenuation and turns the Device Under Test off.
-
- # weeder -m off 56
-
- The next example displays the current attenuation on the console because no attenuation value was specified.
-
- # weeder
-
-REFERENCES
- Information shown above applies to WTSSR-M Solid State Relay Module by Weeder Technologies, 90-A Beal Pkwy NW, Fort Wal‐
- ton Beach FL 32548 USA; Tel +44 850 863 5723.
-
-SEE ALSO
- amp(1), ptsctl(1), WTSSR-M(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 weeder(1)
-
-xml2pib(1) Qualcomm Atheros Open Powerline Toolkit xml2pib(1)
-
-NAME
- xml2pib - Qualcomm Atheros XML driven PIB editor
-
-SYNOPSIS
- xml2pib [options] pib-file [pib-file] [...]
-
-DESCRIPTION
- The Atheros PIB XML Editor modifies an Atheros PIB file based on XML instructions defined in one or more instruction
- files. Instruction files must be valid XML and conform to schema file piboffset.xsd or errors will occur. Always vali‐
- date XML files against this schema with a validating parser before submitting them to this program. Firefox or Internet
- Explorer are suitable for validation purposes purpose.
-
- This program is part of the Qualcomm Atheros Powerline Toolkit. See the AMP man page for an overview and installation
- instructions.
-
-OPTIONS
- -f filename
- The XML instruction file. XML instruction files must conform to the Qualcomm Atheros scheme designed for this
- purpose. If more that one .xml file is specified then edits are applied in order of filename such that later edit
- instructions can over-write eariler instructions. Instruction files usually have a .xml extension but this pro‐
- gram makes no assumption based on filename and does not enforce any filename conventions.
-
- -o Print the appropriate XML schema on stdout. This schema should be used to validate XML instructions using a vali‐
- dating parser such as Firefox or Microsoft Internet Explorer.
-
- -q Suppresses printing of progress messages. This option has no effect at this time.
-
- -v Print additional information. This option has no effect at this time.
-
- -?,--help
- Print program help summary on stdout. This option takes precedence over other options on the command line.
-
- -!,--version
- Print program version information on stdout. This option takes precedence over other options on the command line.
- Use this option when sending screen dumps to Atheros Technical Support so that they know exactly which version of
- the Linux Toolkit you are using.
-
-ARGUMENTS
- pib-file
- An Atheros parameter filename. Only one parameter file can be edited at a time and so care must be taken to avoid
- the use of wildcard filenames. Parameter files usually have a .pib extension but this program makes no assumption
- based on filename and does not enforce any filename conventions.
-
-SCHEMA
- The official Atheros XML PIB Edit schema follows. It defines general instruction file structure and the elements used to
- edit PIB files. This file should be a controlled document and instruction files should always be validated against it
- before using them to edit a PIB file. An explanation of this file appears below.
-
- <?xml version='1.0' encoding='iso-8859-1'?>
- <xs:schema xmlns:xs='http://www.w3.org/2001/XMLSchema' elementFormDefault='qualified'>
- <xs:element name='pib'>
- <xs:complexType>
- <xs:sequence>
- <xs:element maxOccurs='unbounded' ref='object'/>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- <xs:element name='object'>
- <xs:complexType>
- <xs:attribute name='name' use='required' type='xs:NCName'/>
- <xs:sequence>
- <xs:sequence>
- <xs:element ref='offset'/>
- <xs:element ref='length'/>
- </xs:sequence>
- <xs:choice>
- <xs:element ref='array'/>
- <xs:element ref='dataString'/>
- <xs:element ref='dataHuge'/>
- <xs:element ref='dataLong'/>
- <xs:element ref='dataWord'/>
- <xs:element ref='dataByte'/>
- </xs:choice>
- </xs:sequence>
- </xs:complexType>
- </xs:element>
- <xs:element name='length' type='xs:positiveInteger'/>
- <xs:element name='offset' type='xs:hexBinary'/>
- <xs:element name='array'>
- <xs:complexType>
- <xs:choice maxOccurs='unbounded'>
- <xs:element ref='dataByte'/>
- <xs:element ref='dataHex'/>
- </xs:choice>
- </xs:complexType>
- </xs:element>
- <xs:element name='dataString' type='xs:string'/>
- <xs:element name='dataHuge' type='xs:unsignedLong'/>
- <xs:element name='dataLong' type='xs:unsignedInt'/>
- <xs:element name='dataWord' type='xs:unsignedShort'/>
- <xs:element name='dataByte' type='xs:unsignedByte'/>
- <xs:element name='dataHex' type='xs:hexBinary'/>
- </xs:schema>
-
-ELEMENTS
- <pib> The Parameter Information Block subject to edit. There is exactly one pib defined in an instruction file.
-
- <object>
- A data region withn a pib. There must be at least one object defined inside a pib. Each object has an offset, a
- length and data where data is expressed as one dataString, a dataByte, a dataHex or an array as described below.
- The name attribute optional but may be used for clarity or for reporting purposes.
-
- <offset>
- The relative position of the object in bytes expressed in hexadecimal. The offset plus the length of an object
- cannot exceed PIB length or an error will occur. The offset and length element can appear in either order but
- both must appear before the data element. The offset element is required.
-
- <length>
- The extent of the object expressed in decimal bytes. The offset plus length of an object cannot exceed PIB
- length. The the offset and length elements can occur in either order but both must precede the data element. The
- length element is required for elements array and dataString but may be omitted for elements dataHuge, dataLong,
- dataWord and dataByte.
-
- <array>
- A sequence of dataByte and/or dataHex elements. The implied length is determined by array members but must equal
- the object length attribute or an error will occur. A dataString is illegal inside an array.
-
- <dataString>
- Any sequence of printable characters. The implied length is 1 byte longer than the number of characters. The
- string will be truncated or padded with NUL bytes to match the object length attribute. An object length
- attribute of 0 stores one NUL byte. A dataString element is illegal within an array block.
-
- <dataHuge>
- A unsigned decimal integer string that represents any 64 bit binary value. The implied length is 8 bytes. The
- object length attribute is ignored and may be omitted.
-
- <dataLong>
- A unsigned decimal integer string that represents any 32 bit binary value. The implied length is 4 bytes. The
- object length attribute is ignored and may be omitted.
-
- <dataWord>
- A unsigned decimal integer string that represents any 16 bit binary value. The implied length is 2 bytes. The
- object length attribute is ignored and may be omitted.
-
- <dataByte>
- An unsigned decimal digit string that represents any 8 bit binary value. The implied length is 1 byte. The
- object length attribute is ignored and may be omitted.
-
- <dataHex>
- A hexadecimal digit string that represents one byte for each digit pair (octet) present. There must be an even
- number of digits or an error will occur. The resulting length must equal the object length unless the value
- appears inside an array. Inside an array, the resulting length must not exceed the remaining array length.
-
-PROCESS
- The program reads one PIB file and replaces selected values with new ones, computes the new checksum and re-writes the
- file. New values are defined by offset, length, format and value. The object name is actually irrelevant. Critical
- values are the offset, length and data type/value. Obviously, care must be taken when specifying offsets and lengths to
- avoid editing objects incorrectly.
-
-INSTRUCTIONS
- An example instruction file follows. It references the Qualcomm Atheros XML PIB Edit schema file, piboffset.xsd, that is
- shown above so that a validating parser can find the schema and perform document checks. The remainder of the file
- describes a series of object names, offsets, lengths and values that describe the edits to be performed.
-
- <pib xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
- xsi:noNamespaceSchemaLocation="piboffset.xsd">
- <object name="HFID_Manufacturer">
- <offset>0024</offset>
- <length>64</length>
- <dataString>Atheros HomePlug AV Device</dataString>
- </object>
- <object name="HFID_User">
- <length>64</length>
- <offset>0074</offset>
- <dataString>Atheros</dataString>
- </object>
- <object name="MDURole">
- <offset>0101</offset>
- <dataByte>0</dataByte>
- </object>
- <object name="PriorityTTl">
- <offset>0210</offset>
- <length>16</length>
- <array>
- <dataHex>80841E008084</dataHex>
- <dataHex>1e</dataHex>
- <dataByte>0</dataByte>
- <dataHex></dataHex>
- <dataHex></dataHex>
- <dataHex></dataHex>
- <dataHex></dataHex>
- <dataHex>C0</dataHex>
- <dataByte>198</dataByte>
- <dataHex>2d</dataHex>
- <dataHex>00</dataHex>
- </array>
- </object>
- <object name="VLANPrioTOSPrecMatrix">
- <length>4</length>
- <offset>0224</offset>
- <array>
- <dataByte>65</dataByte>
- <dataByte>250</dataByte>
- <dataHex></dataHex>
- <dataHex>Fa</dataHex>
- </array>
- </object>
- <object name="EnableLEDThroughputIndicate">
- <length>1</length>
- <offset>1E94</offset>
- <dataByte>0</dataByte>
- </object>
- <object name="HFID_AVLN">
- <length>64</length>
- <offset>00B4</offset>
- <dataString>Atheros-Net</dataString>
- </object>
- </pib>
-
-EXAMPLES
- The following example reads PIB file abc.pib and edits it according to instructions found in XML file local.xml. The PIB
- file is always specified first, followed by one or more XML instruction files.
-
- # xml2pib abc.pib local.xml
-
- The following example reads PIB file abc.pib and edits it according to three XML instruction files, in the order speci‐
- fied. Order can be critical since later edits could over-write earlier edits.
-
- # xml2pib abc.pib standard.xml custom.xml errata.xml
-
- The following example does nothing because no instruction files are specified.
-
- # xml2pib abc.pib
-
-SEE ALSO
- chkpib(7), chkpib2(7), getpib(7), modpib(1), pib2xml(1), pibcomp(1), pibdump(1), setpib(1)
-
-CREDITS
- Charles Maier <cmaier@qca.qualcomm.com>
-
-open-plc-utils-0.0.3 Mar 2014 xml2pib(1)
-
