222 lines
9.0 KiB
C
222 lines
9.0 KiB
C
/************************************************************************************//**
|
|
* \file Demo/_template/Prog/boot.c
|
|
* \brief Demo program bootloader interface source file.
|
|
* \ingroup Prog__template
|
|
* \internal
|
|
*----------------------------------------------------------------------------------------
|
|
* C O P Y R I G H T
|
|
*----------------------------------------------------------------------------------------
|
|
* Copyright (c) 2019 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 have received a copy of the GNU General Public License along with OpenBLT. It
|
|
* should be located in ".\Doc\license.html". If not, contact Feaser to obtain a copy.
|
|
*
|
|
* \endinternal
|
|
****************************************************************************************/
|
|
|
|
/****************************************************************************************
|
|
* Include files
|
|
****************************************************************************************/
|
|
#include "header.h" /* generic header */
|
|
|
|
|
|
/****************************************************************************************
|
|
* Function prototypes
|
|
****************************************************************************************/
|
|
#if (BOOT_COM_RS232_ENABLE > 0)
|
|
static void BootComRs232Init(void);
|
|
static void BootComRs232CheckActivationRequest(void);
|
|
#endif
|
|
|
|
|
|
/************************************************************************************//**
|
|
** \brief Initializes the communication interface.
|
|
** \return none.
|
|
**
|
|
****************************************************************************************/
|
|
void BootComInit(void)
|
|
{
|
|
#if (BOOT_COM_RS232_ENABLE > 0)
|
|
BootComRs232Init();
|
|
#endif
|
|
} /*** end of BootComInit ***/
|
|
|
|
|
|
/************************************************************************************//**
|
|
** \brief Receives the CONNECT request from the host, which indicates that the
|
|
** bootloader should be activated and, if so, activates it.
|
|
** \return none.
|
|
**
|
|
****************************************************************************************/
|
|
void BootComCheckActivationRequest(void)
|
|
{
|
|
#if (BOOT_COM_RS232_ENABLE > 0)
|
|
BootComRs232CheckActivationRequest();
|
|
#endif
|
|
} /*** end of BootComCheckActivationRequest ***/
|
|
|
|
|
|
/************************************************************************************//**
|
|
** \brief Bootloader activation function.
|
|
** \return none.
|
|
**
|
|
****************************************************************************************/
|
|
void BootActivate(void)
|
|
{
|
|
/* TODO ##Prog The bootloader is typically executed by performing a software reset.
|
|
* Performing a software reset it typically supported by a microcontroller target. If
|
|
* not, then an alternative is to enable the watchdog here and then enter an infinite
|
|
* loop, which will trigger a watchdog reset. After a reset event the bootloader always
|
|
* runs first, so this is a valid method for activating the bootloader.
|
|
*/
|
|
} /*** end of BootActivate ***/
|
|
|
|
|
|
#if (BOOT_COM_RS232_ENABLE > 0)
|
|
/****************************************************************************************
|
|
* U N I V E R S A L A S Y N C H R O N O U S R X T X I N T E R F A C E
|
|
****************************************************************************************/
|
|
|
|
/****************************************************************************************
|
|
* Macro definitions
|
|
****************************************************************************************/
|
|
/** \brief Timeout time for the reception of a CTO packet. The timer is started upon
|
|
* reception of the first packet byte.
|
|
*/
|
|
#define RS232_CTO_RX_PACKET_TIMEOUT_MS (100u)
|
|
|
|
|
|
/****************************************************************************************
|
|
* Function prototypes
|
|
****************************************************************************************/
|
|
static unsigned char Rs232ReceiveByte(unsigned char *data);
|
|
|
|
|
|
/************************************************************************************//**
|
|
** \brief Initializes the UART communication interface.
|
|
** \return none.
|
|
**
|
|
****************************************************************************************/
|
|
static void BootComRs232Init(void)
|
|
{
|
|
/* TODO ##Prog Configure and initialize the UART peripheral for the configured UART
|
|
* channel. The communication speed should be set to the value configured with
|
|
* BOOT_COM_RS232_BAUDRATE in blt_conf.h. Further communication settings are:
|
|
* 8 databits, no parity, and 1 stopbit.
|
|
*/
|
|
} /*** end of BootComRs232Init ***/
|
|
|
|
|
|
/************************************************************************************//**
|
|
** \brief Receives the CONNECT request from the host, which indicates that the
|
|
** bootloader should be activated and, if so, activates it.
|
|
** \return none.
|
|
**
|
|
****************************************************************************************/
|
|
static void BootComRs232CheckActivationRequest(void)
|
|
{
|
|
static unsigned char xcpCtoReqPacket[BOOT_COM_RS232_RX_MAX_DATA+1];
|
|
static unsigned char xcpCtoRxLength;
|
|
static unsigned char xcpCtoRxInProgress = 0;
|
|
static unsigned long xcpCtoRxStartTime = 0;
|
|
|
|
/* start of cto packet received? */
|
|
if (xcpCtoRxInProgress == 0)
|
|
{
|
|
/* store the message length when received */
|
|
if (Rs232ReceiveByte(&xcpCtoReqPacket[0]) == 1)
|
|
{
|
|
/* check that the length has a valid value. it should not be 0 */
|
|
if ( (xcpCtoReqPacket[0] > 0) &&
|
|
(xcpCtoReqPacket[0] <= BOOT_COM_RS232_RX_MAX_DATA) )
|
|
{
|
|
/* store the start time */
|
|
xcpCtoRxStartTime = TimerGet();
|
|
/* indicate that a cto packet is being received */
|
|
xcpCtoRxInProgress = 1;
|
|
/* reset packet data count */
|
|
xcpCtoRxLength = 0;
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
/* store the next packet byte */
|
|
if (Rs232ReceiveByte(&xcpCtoReqPacket[xcpCtoRxLength+1]) == 1)
|
|
{
|
|
/* increment the packet data count */
|
|
xcpCtoRxLength++;
|
|
|
|
/* check to see if the entire packet was received */
|
|
if (xcpCtoRxLength == xcpCtoReqPacket[0])
|
|
{
|
|
/* done with cto packet reception */
|
|
xcpCtoRxInProgress = 0;
|
|
|
|
/* check if this was an XCP CONNECT command */
|
|
if ((xcpCtoReqPacket[1] == 0xff) && (xcpCtoReqPacket[2] == 0x00))
|
|
{
|
|
/* connection request received so start the bootloader */
|
|
BootActivate();
|
|
}
|
|
}
|
|
}
|
|
else
|
|
{
|
|
/* check packet reception timeout */
|
|
if (TimerGet() > (xcpCtoRxStartTime + RS232_CTO_RX_PACKET_TIMEOUT_MS))
|
|
{
|
|
/* cancel cto packet reception due to timeout. note that this automatically
|
|
* discards the already received packet bytes, allowing the host to retry.
|
|
*/
|
|
xcpCtoRxInProgress = 0;
|
|
}
|
|
}
|
|
}
|
|
} /*** end of BootComRs232CheckActivationRequest ***/
|
|
|
|
|
|
/************************************************************************************//**
|
|
** \brief Receives a communication interface byte if one is present.
|
|
** \param data Pointer to byte where the data is to be stored.
|
|
** \return 1 if a byte was received, 0 otherwise.
|
|
**
|
|
****************************************************************************************/
|
|
static unsigned char Rs232ReceiveByte(unsigned char *data)
|
|
{
|
|
unsigned char result = 0;
|
|
|
|
/* TODO ##Prog Check if a new byte was received on the configured channel. This is
|
|
* typically done by checking the reception register not empty flag. If a new byte
|
|
* was received, read it out and store it in '*data'. Next, clear the reception flag
|
|
* such that a new byte can be received again. Finally, set 'result' to 1 to indicate
|
|
* to the caller of this function that a new byte was received and stored.
|
|
*/
|
|
if (1 == 0)
|
|
{
|
|
/* retrieve and store the newly received byte */
|
|
*data = 0;
|
|
/* update the result */
|
|
result = 1;
|
|
}
|
|
|
|
/* give the result back to the caller */
|
|
return result;
|
|
} /*** end of Rs232ReceiveByte ***/
|
|
#endif /* BOOT_COM_RS232_ENABLE > 0 */
|
|
|
|
|
|
/*********************************** end of boot.c *************************************/
|