ModuleCommit.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 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

[PREV] [HOME] [NEXT]