StartFirmware1.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.
     *
     *--------------------------------------------------------------------*/

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

[PREV] [HOME] [NEXT]