HostActionIndicate.c
Author: cmaier@cmassoc.net

    /*====================================================================*
     *
     *   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

[PREV] [HOME] [NEXT]