AMiRo-OS

/************************************************************************************//**

* \file         Source\xcp.c

* \brief        XCP 1.0 protocol core source file.

* \ingroup      Core

* \internal

*----------------------------------------------------------------------------------------

*                          C O P Y R I G H T

*----------------------------------------------------------------------------------------

*   Copyright (c) 2011  by Feaser    http://www.feaser.com    All rights reserved

*

*----------------------------------------------------------------------------------------

*                            L I C E N S E

*----------------------------------------------------------------------------------------

* This file is part of OpenBLT. OpenBLT is free software: you can redistribute it and/or

* modify it under the terms of the GNU General Public License as published by the Free

* Software Foundation, either version 3 of the License, or (at your option) any later

* version.

*

* OpenBLT is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;

* without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR

* PURPOSE. See the GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License along with OpenBLT.

* If not, see <http://www.gnu.org/licenses/>.

*

* A special exception to the GPL is included to allow you to distribute a combined work

* that includes OpenBLT without being obliged to provide the source code for any

* proprietary components. The exception text is included at the bottom of the license

* file <license.html>.

*

* \endinternal

****************************************************************************************/

/****************************************************************************************

* Include files

****************************************************************************************/

#include "boot.h"                                /* bootloader generic header          */

#include <helper.h>

/****************************************************************************************

* Defines

****************************************************************************************/

/** \brief XCP protocol layer version number (16-bit). */

#define XCP_VERSION_PROTOCOL_LAYER  (0x0100)

/** \brief XCP transport layer version number (16-bit). */

#define XCP_VERSION_TRANSPORT_LAYER (0x0100)

/* XCP packet identifiers */

/** \brief Command response packet identifier. */

#define XCP_PID_RES                 (0xff)

/** \brief Error packet identifier. */

#define XCP_PID_ERR                 (0xfe)

/* XCP error codes */

/** \brief Cmd processor synchronization error code. */

#define XCP_ERR_CMD_SYNCH           (0x00)

/** \brief Command was not executed error code. */

#define XCP_ERR_CMD_BUSY            (0x10)

/** \brief Unknown or unsupported command error code. */

#define XCP_ERR_CMD_UNKNOWN         (0x20)

/** \brief Parameter out of range error code. */

#define XCP_ERR_OUT_OF_RANGE        (0x22)

/** \brief Protected error code. Seed/key required. */

#define XCP_ERR_ACCESS_LOCKED       (0x25)

/** \brief Cal page not valid error code. */

#define XCP_ERR_PAGE_NOT_VALID      (0x26)

/** \brief Sequence error code. */

#define XCP_ERR_SEQUENCE            (0x29)

/** \brief Generic error code. */

#define XCP_ERR_GENERIC             (0x31)

/* XCP command codes */

/** \brief CONNECT command code. */

#define XCP_CMD_CONNECT             (0xff)

/** \brief DISCONNECT command code. */

#define XCP_CMD_DISCONNECT          (0xfe)

/** \brief GET_STATUS command code. */

#define XCP_CMD_GET_STATUS          (0xfd)

/** \brief SYNCH command code. */

#define XCP_CMD_SYNCH               (0xfc)

/** \brief GET_ID command code. */

#define XCP_CMD_GET_ID              (0xfa)

/** \brief GET_SEED command code. */

#define XCP_CMD_GET_SEED            (0xf8)

/** \brief UNLOCK command code. */

#define XCP_CMD_UNLOCK              (0xf7)

/** \brief SET_MTA command code. */

#define XCP_CMD_SET_MTA             (0xf6)

/** \brief UPLOAD command code. */

#define XCP_CMD_UPLOAD              (0xf5)

/** \brief SHORT_UPLOAD command code. */

#define XCP_CMD_SHORT_UPLOAD        (0xf4)

/** \brief BUILD_CHECKSUM command code. */

#define XCP_CMD_BUILD_CHECKSUM      (0xf3)

/** \brief DOWNLOAD command code. */

#define XCP_CMD_DOWNLOAD            (0xf0)

/** \brief DOWNLOAD_MAX command code. */

#define XCP_CMD_DOWLOAD_MAX         (0xee)

/** \brief SET_CALPAGE command code. */

#define XCP_CMD_SET_CAL_PAGE        (0xeb)

/** \brief GET_CALPAGE command code. */

#define XCP_CMD_GET_CAL_PAGE        (0xea)

/** \brief PROGRAM_START command code. */

#define XCP_CMD_PROGRAM_START       (0xd2)

/** \brief PROGRAM_CLEAR command code. */

#define XCP_CMD_PROGRAM_CLEAR       (0xd1)

/** \brief PROGRAM command code. */

#define XCP_CMD_PROGRAM             (0xd0)

/** \brief PROGRAM_RESET command code. */

#define XCP_CMD_PROGRAM_RESET       (0xcf)

/** \brief PROGRAM_PREPARE command code. */

#define XCP_CMD_PROGRAM_PREPARE     (0xcc)

/** \brief PROGRAM_MAX command code. */

#define XCP_CMD_PROGRAM_MAX         (0xc9)

/****************************************************************************************

* Type definitions

****************************************************************************************/

/** \brief Struture type for grouping XCP internal module information. */

typedef struct

{

  blt_int8u  connected;                             /**< connection established                      */

#if (BOOT_GATE_ENABLE > 0)

  blt_int32u  other_connection;                      /**< connection to other device established      */

#endif

#if (BOOTLOADER_OF_MAIN_DEVICE > 0)

  blt_bool   wasMainConnection;                     /**< connection to serialboot (0x00) established */

#endif

  blt_int8u  oldData[BOOT_COM_RX_MAX_DATA];         /**< old packet data buffer                      */

  blt_int8u  protection;                            /**< protection state                            */

  blt_int8u  s_n_k_resource;                        /**< for seed/key sequence                       */

  blt_int8u  ctoData[BOOT_COM_RX_MAX_DATA];         /**< cto packet data buffer                      */

  blt_int8u  ctoPending;                            /**< cto transmission pending flag               */

  blt_int16s ctoLen;                                /**< cto current packet length                   */

  blt_int32u mta;                                   /**< memory transfer address                     */

} tXcpInfo;

/****************************************************************************************

* Function prototypes

****************************************************************************************/

/* transport layer specific functions */

#if (BOOT_GATE_ENABLE > 0)

static void      XcpTransmitPacket(blt_int8u *data, blt_int16s len, blt_bool fromGate);

#else

static void      XcpTransmitPacket(blt_int8u *data, blt_int16s len);

#endif /* BOOT_GATE_ENABLE > 0 */

/* application specific functions */

static blt_int8u XcpComputeChecksum(blt_int32u address, blt_int32u length,

                                    blt_int32u *checksum);

#if (XCP_SEED_KEY_PROTECTION_EN == 1)

static blt_int8u XcpGetSeed(blt_int8u resource, blt_int8u *seed);

static blt_int8u XcpVerifyKey(blt_int8u resource, blt_int8u *key, blt_int8u len);

#endif

/* general utility functions */

static void XcpProtectResources(void);

static void XcpSetCtoError(blt_int8u error);

/* XCP command processors */

static void XcpCmdConnect(blt_int8u *data, blt_int16s dataLength);

static void XcpCmdDisconnect(blt_int8u *data);

static void XcpCmdGetStatus(blt_int8u *data);

static void XcpCmdSynch(blt_int8u *data);

static void XcpCmdGetId(blt_int8u *data);

static void XcpCmdSetMta(blt_int8u *data);

static void XcpCmdUpload(blt_int8u *data);

static void XcpCmdShortUpload(blt_int8u *data);

static void XcpCmdBuildCheckSum(blt_int8u *data);

#if (XCP_SEED_KEY_PROTECTION_EN == 1)

static void XcpCmdGetSeed(blt_int8u *data);

static void XcpCmdUnlock(blt_int8u *data);

#endif

#if (XCP_RES_CALIBRATION_EN == 1)

static void XcpCmdDownload(blt_int8u *data);

static void XcpCmdDownloadMax(blt_int8u *data);

#endif

#if (XCP_RES_PAGING_EN == 1)

static void XcpCmdSetCalPage(blt_int8u *data);

static void XcpCmdGetCalPage(blt_int8u *data);

#endif

#if (XCP_RES_PROGRAMMING_EN == 1)

static void XcpCmdProgramMax(blt_int8u *data);

static void XcpCmdProgram(blt_int8u *data);

static void XcpCmdProgramStart(blt_int8u *data);

static void XcpCmdProgramClear(blt_int8u *data);

static void XcpCmdProgramReset(blt_int8u *data);

static void XcpCmdProgramPrepare(blt_int8u *data);

#endif

static void portedTransmission(blt_int8u *data);

/****************************************************************************************

* Hook functions

****************************************************************************************/

#if (XCP_RES_PAGING_EN == 1)

extern blt_int8u XcpCalSetPageHook(blt_int8u segment, blt_int8u page);

extern blt_int8u XcpCalGetPageHook(blt_int8u segment);

#endif

#if (XCP_CONNECT_MODE_HOOK_EN == 1)

extern blt_bool XcpConnectModeHook(blt_int8u mode);

#endif

#if (XCP_SEED_KEY_PROTECTION_EN == 1)

extern blt_int8u XcpGetSeedHook(blt_int8u resource, blt_int8u *seed);

extern blt_int8u XcpVerifyKeyHook(blt_int8u resource, blt_int8u *key, blt_int8u len);

#endif

/****************************************************************************************

* External functions

****************************************************************************************/

#if (BOOT_COM_ENABLE == 0)

/* in case no internally supported communication interface is used, a custom

 * communication module can be added. In order to use the XCP protocol in the custom

 * communication module, this hook function needs to be implemented. In the XCP protocol

 * is not needed, then simply remove the xcp.c source from the project.

 */

extern void XcpTransmitPacketHook(blt_int8u *data, blt_int16u len);

#endif

/****************************************************************************************

* Local constants

****************************************************************************************/

/** \brief String buffer with station id. */

static const blt_int8s xcpStationId[] = XCP_STATION_ID_STRING;

/****************************************************************************************

* Local data definitions

****************************************************************************************/

/** \brief Local variable for storing XCP internal module info. */

static tXcpInfo xcpInfo;

/************************************************************************************//**

** \brief     Initializes the XCP driver. Should be called once upon system startup.

** \return    none

**

****************************************************************************************/

void XcpInit(void)

{

  /* reset xcp module info */

  xcpInfo.connected = 0;

#if (BOOT_GATE_ENABLE > 0)

  xcpInfo.other_connection = 0;

#endif

#if (BOOTLOADER_OF_MAIN_DEVICE > 0)

  xcpInfo.wasMainConnection = BLT_FALSE;

#endif

  xcpInfo.mta = 0;

  xcpInfo.ctoPending = 0;

  xcpInfo.ctoLen = 0;

  xcpInfo.s_n_k_resource = 0;

  xcpInfo.protection = 0;

} /*** end of XcpInit ***/

/************************************************************************************//**

** \brief     Obtains information about the XCP connection state.

** \return    BLT_TRUE is an XCP connection is established, BLT_FALSE otherwise.

**

****************************************************************************************/

blt_bool XcpIsConnected(void)

{

#if (BOOT_GATE_ENABLE > 0)

  if (xcpInfo.connected == 0 && xcpInfo.other_connection == 0)

#else

  if (xcpInfo.connected == 0)

#endif

  {

    return BLT_FALSE;

  }

  return BLT_TRUE;

} /*** end of XcpIsConnected ***/

#if (BOOTLOADER_OF_MAIN_DEVICE > 0)

/************************************************************************************//**

** \brief     Obtains information about the XCP main connection state.

** \return    BLT_TRUE is an XCP connection to main was established, BLT_FALSE otherwise.

**

****************************************************************************************/

blt_bool XcpWasConnectedToMain(void)

{

  return xcpInfo.wasMainConnection;

} /*** end of XcpWasConnectedToMain ***/

#endif

/************************************************************************************//**

** \brief     Informs the core that a pending packet transmission was completed by

**            the transport layer.

** \return    none

**

****************************************************************************************/

void XcpPacketTransmitted(void)

{

  /* reset packet transmission pending flag */

  xcpInfo.ctoPending = 0;

} /*** end of XcpPacketTransmitted ***/

/************************************************************************************//**

** \brief     Informs the core that a new packet was received by the transport layer.

** \param     data       Pointer to byte buffer with packet data.

** \param     dataLength Number of data bytes that need to be transmitted.

** \return    none

**

****************************************************************************************/

#if (BOOT_GATE_ENABLE > 0)

void XcpPacketReceived(blt_int8u *data, blt_int16s dataLength, blt_bool fromGate)

#else

void XcpPacketReceived(blt_int8u *data, blt_int16s dataLength)

#endif /* BOOT_GATE_ENABLE > 0 */

{

  /* was this a connect command? */

  if (data[0] == XCP_CMD_CONNECT)

  {

    /* process the connect command */

    XcpCmdConnect(data, dataLength);

  }

  /* only continue if connected */

  else if (xcpInfo.connected == 1)

  {

    switch (data[0])

    {

      case XCP_CMD_UPLOAD:

        XcpCmdUpload(data);

        break;

      case XCP_CMD_SHORT_UPLOAD:

        XcpCmdShortUpload(data);