WriteExecuteFirmware2.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 WriteExecuteFirmware2 (struct plc * plc, unsigned module, const struct nvm_header2 * nvm_header);
     *
     *   plc.h
     *
     *   use VS_WRITE_AND_EXECUTE_APPLET 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_WRITE_AND_EXECUTE_APPLET messages;
     *
     *
     *   Contributor(s):
     *      Charles Maier <cmaier@qca.qualcomm.com>
     *
     *--------------------------------------------------------------------*/

    #ifndef WRITEEXECUTEFIRMWARE2_SOURCE
    #define WRITEEXECUTEFIRMWARE2_SOURCE

    #include "../tools/files.h"
    #include "../tools/error.h"
    #include "../plc/plc.h"

    signed WriteExecuteFirmware2 (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_write_execute_request
    	{
    		struct ethernet_hdr ethernet;
    		struct qualcomm_hdr qualcomm;
    		uint32_t CLIENT_SESSION_ID;
    		uint32_t SERVER_SESSION_ID;
    		uint32_t FLAGS;
    		uint8_t ALLOWED_MEM_TYPES [8];
    		uint32_t TOTAL_LENGTH;
    		uint32_t CURR_PART_LENGTH;
    		uint32_t CURR_PART_OFFSET;
    		uint32_t START_ADDR;
    		uint32_t CHECKSUM;
    		uint8_t RESERVED2 [8];
    		uint8_t IMAGE [PLC_MODULE_SIZE];
    	}
    	* request = (struct vs_write_execute_request *) (message);
    	struct __packed vs_write_execute_confirm
    	{
    		struct ethernet_hdr ethernet;
    		struct qualcomm_hdr qualcomm;
    		uint32_t MSTATUS;
    		uint32_t CLIENT_SESSION_ID;
    		uint32_t SERVER_SESSION_ID;
    		uint32_t FLAGS;
    		uint8_t ALLOWED_MEM_TYPES [8];
    		uint32_t TOTAL_LENGTH;
    		uint32_t CURR_PART_LENGTH;
    		uint32_t CURR_PART_OFFSET;
    		uint32_t START_ADDR;
    		uint32_t CHECKSUM;
    		uint8_t RESERVED2 [8];
    		uint32_t CURR_PART_ABSOLUTE_ADDR;
    		uint32_t ABSOLUTE_START_ADDR;
    	}
    	* confirm = (struct vs_write_execute_confirm *) (message);

    #ifndef __GNUC__
    #pragma pack (pop)
    #endif

    	unsigned action = PLC_MODULE_ABSOLUTE;
    	uint32_t length = PLC_MODULE_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_WRITE_AND_EXECUTE_APPLET | MMTYPE_REQ));
    		if (length > extent)
    		{
    			if (!(LE32TOH(nvm_header->EntryPoint) % sizeof(nvm_header->EntryPoint)))
    			{
    				Request (plc, "Start %s (%d) (%08X)", plc->NVM.name, module, LE32TOH (nvm_header->EntryPoint));
    				action |= PLC_MODULE_EXECUTE;
    			}
    			length = extent;
    		}
    		if (read (plc->NVM.file, request->IMAGE, length) != (signed)(length))
    		{
    			error (1, errno, FILE_CANTREAD, plc->NVM.name);
    		}
    		request->CLIENT_SESSION_ID = HTOLE32 (plc->cookie);
    		request->SERVER_SESSION_ID = HTOLE32 (0);
    		request->FLAGS = HTOLE32 (action);
    		request->ALLOWED_MEM_TYPES [0] = 1;
    		request->TOTAL_LENGTH = nvm_header->ImageLength;
    		request->CURR_PART_LENGTH = HTOLE32 (length);
    		request->CURR_PART_OFFSET = HTOLE32 (offset);
    		request->START_ADDR = nvm_header->EntryPoint;
    		request->CHECKSUM = nvm_header->ImageChecksum;
    		plc->packetsize = sizeof (* request);
    		if (SendMME (plc) <= 0)
    		{
    			error (PLC_EXIT (plc), errno, CHANNEL_CANTSEND);
    			return (-1);
    		}
    		if (ReadMME (plc, 0, (VS_WRITE_AND_EXECUTE_APPLET | MMTYPE_CNF)) <= 0)
    		{
    			error (PLC_EXIT (plc), errno, CHANNEL_CANTREAD);
    			return (-1);
    		}
    		if (confirm->MSTATUS)
    		{
    			Failure (plc, PLC_WONTDOIT);
    			return (-1);
    		}
    		if (LE32TOH (confirm->CURR_PART_LENGTH) != length)
    		{
    			error (PLC_EXIT (plc), 0, PLC_ERR_LENGTH);
    			return (-1);
    		}
    		if (LE32TOH (confirm->CURR_PART_OFFSET) != offset)
    		{
    			error (PLC_EXIT (plc), 0, PLC_ERR_OFFSET);
    			return (-1);
    		}
    		offset += length;
    		extent -= length;
    	}
    	return (0);
    }

    #endif

[PREV] [HOME] [NEXT]