command_packet.h

/*
 * Copyright (c) 2013 - 2015, Freescale Semiconductor, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * o Redistributions of source code must retain the above copyright notice, this list
 *   of conditions and the following disclaimer.
 *
 * o 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.
 *
 * o Neither the name of Freescale Semiconductor, Inc. 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 HOLDER 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.
 */
#if !defined(__COMMAND_PACKET_H__)
#define __COMMAND_PACKET_H__

#include "bootloader_common.h"


// Declarations

enum _command_packet_constants
{
    kMinPacketBufferSize = 32,
    kDefaultMaxPacketSize = kMinPacketBufferSize,
    kMaxPropertyReturnValues =
        (kMinPacketBufferSize / sizeof(uint32_t)) - 2, 

    kMaxProgramOnceValues =
        (kMinPacketBufferSize / sizeof(uint32_t)) - 3, 
    kCommandTagCount = 12 
};

enum _command_tags
{
    kCommandTag_GenericResponse = 0xa0,
    kCommandTag_FlashEraseAll = 0x01,
    kCommandTag_FlashEraseRegion = 0x02,
    kCommandTag_ReadMemory = 0x03,
    kCommandTag_ReadMemoryResponse = 0xa3,
    kCommandTag_WriteMemory = 0x04,
    kCommandTag_FillMemory = 0x05,
    kCommandTag_FlashSecurityDisable = 0x06,
    kCommandTag_GetProperty = 0x07,
    kCommandTag_GetPropertyResponse = 0xa7,
    kCommandTag_ReceiveSbFile = 0x08,
    kCommandTag_Execute = 0x09,
    kCommandTag_Call = 0x0a,
    kCommandTag_Reset = 0x0b,
    kCommandTag_SetProperty = 0x0c,
    kCommandTag_FlashEraseAllUnsecure = 0x0d,
    kCommandTag_FlashProgramOnce = 0x0e,
    kCommandTag_FlashReadOnce = 0x0f,
    kCommandTag_FlashReadOnceResponse = 0xaf,
    kCommandTag_FlashReadResource = 0x10,
    kCommandTag_FlashReadResourceResponse = 0xb0,
    kCommandTag_ConfigureQuadSpi = 0x11,
    kCommandTag_ReliableUpdate = 0x12,

    kCommandTag_ConfigureI2c = 0xc1, 
    kCommandTag_ConfigureSpi = 0xc2, 
    kCommandTag_ConfigureCan = 0xc3, 

    kFirstCommandTag = kCommandTag_FlashEraseAll,

    kLastCommandTag = kCommandTag_ReliableUpdate,

    kResponseCommandHighNibbleMask =
        0xa0 
};

enum _command_packet_flags
{
    kCommandFlag_None = 0,
    kCommandFlag_HasDataPhase = 1
};

enum _flash_mem_id
{
    kFlashMemInternal = 0,
    kFlashMemQuadSpi0 = 1,
    kFlashMemExecuteOnly = 0x10
};

typedef struct CommandPacket
{
    uint8_t commandTag;     
    uint8_t flags;          
    uint8_t reserved;       
    uint8_t parameterCount; 
} command_packet_t;



typedef struct FlashEraseAllPacket
{
    command_packet_t commandPacket; 
    uint32_t memoryId;              
} flash_erase_all_packet_t;

typedef struct FlashEraseRegionPacket
{
    command_packet_t commandPacket; 
    uint32_t startAddress;          
    uint32_t byteCount;             
} flash_erase_region_packet_t;

typedef struct GetPropertyPacket
{
    command_packet_t commandPacket; 
    uint32_t propertyTag;           
    uint32_t memoryId;              
} get_property_packet_t;

typedef struct SetPropertyPacket
{
    command_packet_t commandPacket; 
    uint32_t propertyTag;           
    uint32_t propertyValue;         
} set_property_packet_t;

typedef struct ReceiveSbFilePacket
{
    command_packet_t commandPacket; 
    uint32_t byteCount;             
} receive_sb_file_packet_t;

typedef struct WriteMemoryPacket
{
    command_packet_t commandPacket; 
    uint32_t startAddress;          
    uint32_t byteCount;             
} write_memory_packet_t;

typedef struct ReadMemoryPacket
{
    command_packet_t commandPacket; 
    uint32_t startAddress;          
    uint32_t byteCount;             
} read_memory_packet_t;

typedef struct FillMemoryPacket
{
    command_packet_t commandPacket; 
    uint32_t startAddress;          
    uint32_t byteCount;             
    uint32_t patternWord;           
} fill_memory_packet_t;

typedef status_t (*call_function_t)(uint32_t);

typedef struct ExecuteCallPacket
{
    command_packet_t commandPacket; 
    uint32_t callAddress;           
    uint32_t argumentWord;          
    uint32_t stackpointer;          
} execute_call_packet_t;

typedef struct FlashSecurityDisablePacket
{
    command_packet_t commandPacket; 
    uint32_t keyLow;                
    uint32_t keyHigh;               
} flash_security_disable_packet_t;

typedef struct ProgramOncePacket
{
    command_packet_t commandPacket;       
    uint32_t index;                       
    uint32_t byteCount;                   
    uint32_t data[kMaxProgramOnceValues]; 
} flash_program_once_packet_t;

typedef struct ReadOncePacket
{
    command_packet_t commandPacket; 
    uint32_t index;                 
    uint32_t byteCount;             
} flash_read_once_packet_t;

typedef struct FlashReadResourcePacket
{
    command_packet_t commandPacket; 
    uint32_t startAddress;          
    uint32_t byteCount;             
    uint32_t option;                
} flash_read_resource_packet_t;

typedef struct ConfigureQuadSpiPacket
{
    command_packet_t commandPacket; 
    uint32_t flashMemId;            
    uint32_t configBlockAddress;    
} configure_quadspi_packet_t;

typedef struct ReliableUpdatePacket
{
    command_packet_t commandPacket; 
    uint32_t address;               
} reliable_update_packet_t;

typedef struct ConfigureI2cPacket
{
    command_packet_t commandPacket; 
    uint32_t address;               
    uint32_t speed;                 
} configure_i2c_packet_t;

typedef struct ConfigureSpiPacket
{
    command_packet_t commandPacket; 
    uint32_t speedKhz;              
    uint32_t polarity;              
    uint32_t phase;                 
    uint32_t direction;             
} configure_spi_packet_t;

typedef struct ConfigureCanPacket
{
    command_packet_t commandPacket; 
    uint32_t speed;                 
    uint32_t txid;                  
    uint32_t rxid;                  
} configure_can_packet_t;




typedef struct GenericResponsePacket
{
    command_packet_t commandPacket; 
    uint32_t status;                
    uint32_t commandTag;            
} generic_response_packet_t;

typedef struct GetPropertyResponsePacket
{
    command_packet_t commandPacket;                   
    uint32_t status;                                  
    uint32_t propertyValue[kMaxPropertyReturnValues]; 
} get_property_response_packet_t;

typedef struct ReadMemoryResponsePacket
{
    command_packet_t commandPacket; 
    uint32_t status;                
    uint32_t dataByteCount;         
} read_memory_response_packet_t;

typedef struct FlashReadOnceResponsePacket
{
    command_packet_t commandPacket;       
    uint32_t status;                      
    uint32_t byteCount;                   
    uint32_t data[kMaxProgramOnceValues]; 
} flash_read_once_response_packet_t;

typedef struct FlashReadResourceResponsePacket
{
    command_packet_t commandPacket; 
    uint32_t status;                
    uint32_t dataByteCount;         
} flash_read_resource_response_packet_t;



#endif // __COMMAND_PACKET_H__
// EOF