Initial public release.
This commit is contained in:
Joe Kearney
parent
7b169e8116
commit
dac4af8d25
255 changed files with 68595 additions and 2 deletions
303
2020TPCApp0.cydsn/dfu_user.c
Normal file
303
2020TPCApp0.cydsn/dfu_user.c
Normal file
|
|
@ -0,0 +1,303 @@
|
|||
/***************************************************************************//**
|
||||
* \file dfu_user.c
|
||||
* \version 3.0
|
||||
*
|
||||
* This file provides the custom API for a firmware application with
|
||||
* DFU SDK.
|
||||
* - Cy_DFU_ReadData (address, length, ctl, params) - to read the NVM block
|
||||
* - Cy_DFU_WriteData(address, length, ctl, params) - to write the NVM block
|
||||
*
|
||||
* - Cy_DFU_TransportStart() to start a communication interface
|
||||
* - Cy_DFU_TransportStop () to stop a communication interface
|
||||
* - Cy_DFU_TransportReset() to reset a communication interface
|
||||
* - Cy_DFU_TransportRead (buffer, size, count, timeout)
|
||||
* - Cy_DFU_TransportWrite(buffer, size, count, timeout)
|
||||
*
|
||||
********************************************************************************
|
||||
* \copyright
|
||||
* Copyright 2016-2019, Cypress Semiconductor Corporation. All rights reserved.
|
||||
* You may use this file only in accordance with the license, terms, conditions,
|
||||
* disclaimers, and limitations in the end user license agreement accompanying
|
||||
* the software package with which this file was provided.
|
||||
*******************************************************************************/
|
||||
|
||||
#include <string.h>
|
||||
#include "transport_ble.h"
|
||||
#include "cy_syslib.h"
|
||||
#include "cy_flash.h"
|
||||
#include "cy_dfu.h"
|
||||
|
||||
|
||||
/*
|
||||
* The DFU SDK metadata initial value is placed here
|
||||
* Note: the number of elements equal to the number of the app multiplies by 2
|
||||
* because of the two fields per app plus one element for the CRC-32C field.
|
||||
*/
|
||||
CY_SECTION(".cy_boot_metadata") __USED
|
||||
static const uint32_t cy_dfu_metadata[CY_FLASH_SIZEOF_ROW / sizeof(uint32_t)] =
|
||||
{
|
||||
CY_DFU_APP0_VERIFY_START, CY_DFU_APP0_VERIFY_LENGTH, /* The App0 base address and length */
|
||||
CY_DFU_APP1_VERIFY_START, CY_DFU_APP1_VERIFY_LENGTH, /* The App1 base address and length */
|
||||
0u /* The rest does not matter */
|
||||
};
|
||||
|
||||
|
||||
static uint32_t IsMultipleOf(uint32_t value, uint32_t multiple);
|
||||
static void GetStartEndAddress(uint32_t appId, uint32_t *startAddress, uint32_t *endAddress);
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
* Function Name: IsMultipleOf
|
||||
****************************************************************************//**
|
||||
*
|
||||
* This internal function check if value parameter is a multiple of parameter
|
||||
* multiple
|
||||
*
|
||||
* \param value value that will be checked
|
||||
* \param multiple value with which value is checked
|
||||
*
|
||||
* \return 1 - value is multiple of parameter multiple, else 0
|
||||
*
|
||||
*******************************************************************************/
|
||||
static uint32_t IsMultipleOf(uint32_t value, uint32_t multiple)
|
||||
{
|
||||
return ( ((value % multiple) == 0u)? 1ul : 0ul);
|
||||
}
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
* Function Name: GetStartEndAddress
|
||||
****************************************************************************//**
|
||||
*
|
||||
* This internal function returns start and end address of application
|
||||
*
|
||||
* \param appId The application number
|
||||
* \param startAddress The pointer to a variable where an application start
|
||||
* address is stored
|
||||
* \param endAddress The pointer to a variable where a size of application
|
||||
* area is stored.
|
||||
*
|
||||
*******************************************************************************/
|
||||
static void GetStartEndAddress(uint32_t appId, uint32_t *startAddress, uint32_t *endAddress)
|
||||
{
|
||||
uint32_t verifyStart;
|
||||
uint32_t verifySize;
|
||||
|
||||
(void)Cy_DFU_GetAppMetadata(appId, &verifyStart, &verifySize);
|
||||
|
||||
#if (CY_DFU_APP_FORMAT == CY_DFU_SIMPLIFIED_APP)
|
||||
*startAddress = verifyStart - CY_DFU_SIGNATURE_SIZE;
|
||||
*endAddress = verifyStart + verifySize;
|
||||
#else
|
||||
*startAddress = verifyStart;
|
||||
*endAddress = verifyStart + verifySize + CY_DFU_SIGNATURE_SIZE;
|
||||
#endif
|
||||
}
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
* Function Name: Cy_DFU_WriteData
|
||||
****************************************************************************//**
|
||||
*
|
||||
* This function documentation is part of the DFU SDK API, see the
|
||||
* cy_dfu.h file or DFU SDK API Reference Manual for details.
|
||||
*
|
||||
*******************************************************************************/
|
||||
cy_en_dfu_status_t Cy_DFU_WriteData (uint32_t address, uint32_t length, uint32_t ctl,
|
||||
cy_stc_dfu_params_t *params)
|
||||
{
|
||||
/* User Flash Limits */
|
||||
/* Note that App0 is out of range */
|
||||
const uint32_t minUFlashAddress = CY_FLASH_BASE + CY_DFU_APP0_VERIFY_LENGTH;
|
||||
const uint32_t maxUFlashAddress = CY_FLASH_BASE + CY_FLASH_SIZE;
|
||||
/* EM_EEPROM Limits*/
|
||||
const uint32_t minEmEepromAddress = CY_EM_EEPROM_BASE;
|
||||
const uint32_t maxEmEepromAddress = CY_EM_EEPROM_BASE + CY_EM_EEPROM_SIZE;
|
||||
|
||||
cy_en_dfu_status_t status = CY_DFU_SUCCESS;
|
||||
|
||||
uint32_t app = Cy_DFU_GetRunningApp();
|
||||
uint32_t startAddress;
|
||||
uint32_t endAddress;
|
||||
|
||||
GetStartEndAddress(app, &startAddress, &endAddress);
|
||||
|
||||
/* Check if the address and length are valid
|
||||
* Note Length = 0 is valid for erase command */
|
||||
if ( (IsMultipleOf(address, CY_FLASH_SIZEOF_ROW) == 0u) ||
|
||||
( (length != CY_FLASH_SIZEOF_ROW) && ( (ctl & CY_DFU_IOCTL_ERASE) == 0u) ) )
|
||||
{
|
||||
status = CY_DFU_ERROR_LENGTH;
|
||||
}
|
||||
|
||||
/* Refuse to write to a row within a range of the current application */
|
||||
if ( (startAddress <= address) && (address < endAddress) )
|
||||
{ /* It is forbidden to overwrite the currently running application */
|
||||
status = CY_DFU_ERROR_ADDRESS;
|
||||
}
|
||||
#if CY_DFU_OPT_GOLDEN_IMAGE
|
||||
if (status == CY_DFU_SUCCESS)
|
||||
{
|
||||
uint8_t goldenImages[] = { CY_DFU_GOLDEN_IMAGE_IDS() };
|
||||
uint32_t count = sizeof(goldenImages) / sizeof(goldenImages[0]);
|
||||
uint32_t idx;
|
||||
for (idx = 0u; idx < count; ++idx)
|
||||
{
|
||||
app = goldenImages[idx];
|
||||
GetStartEndAddress(app, &startAddress, &endAddress);
|
||||
|
||||
if ( (startAddress <= address) && (address < endAddress) )
|
||||
{
|
||||
status = Cy_DFU_ValidateApp(app, params);
|
||||
status = (status == CY_DFU_SUCCESS) ? CY_DFU_ERROR_ADDRESS : CY_DFU_SUCCESS;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
#endif /* #if CY_DFU_OPT_GOLDEN_IMAGE != 0 */
|
||||
|
||||
/* Check if the address is inside the valid range */
|
||||
if ( ( (minUFlashAddress <= address) && (address < maxUFlashAddress) )
|
||||
|| ( (minEmEepromAddress <= address) && (address < maxEmEepromAddress) ) )
|
||||
{ /* Do nothing, this is an allowed memory range to update to */
|
||||
}
|
||||
else
|
||||
{
|
||||
status = CY_DFU_ERROR_ADDRESS;
|
||||
}
|
||||
|
||||
if (status == CY_DFU_SUCCESS)
|
||||
{
|
||||
if ((ctl & CY_DFU_IOCTL_ERASE) != 0u)
|
||||
{
|
||||
(void) memset(params->dataBuffer, 0, CY_FLASH_SIZEOF_ROW);
|
||||
}
|
||||
cy_en_flashdrv_status_t fstatus = Cy_Flash_WriteRow(address, (uint32_t*)params->dataBuffer);
|
||||
status = (fstatus == CY_FLASH_DRV_SUCCESS) ? CY_DFU_SUCCESS : CY_DFU_ERROR_DATA;
|
||||
}
|
||||
return (status);
|
||||
}
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
* Function Name: Cy_DFU_ReadData
|
||||
****************************************************************************//**
|
||||
*
|
||||
* This function documentation is part of the DFU SDK API, see the
|
||||
* cy_dfu.h file or DFU SDK API Reference Manual for details.
|
||||
*
|
||||
*******************************************************************************/
|
||||
cy_en_dfu_status_t Cy_DFU_ReadData (uint32_t address, uint32_t length, uint32_t ctl,
|
||||
cy_stc_dfu_params_t *params)
|
||||
{
|
||||
/* User Flash Limits */
|
||||
/* Note that App0 is out of range */
|
||||
const uint32_t minUFlashAddress = CY_FLASH_BASE + CY_DFU_APP0_VERIFY_LENGTH;
|
||||
const uint32_t maxUFlashAddress = CY_FLASH_BASE + CY_FLASH_SIZE;
|
||||
/* EM_EEPROM Limits*/
|
||||
const uint32_t minEmEepromAddress = CY_EM_EEPROM_BASE;
|
||||
const uint32_t maxEmEepromAddress = CY_EM_EEPROM_BASE + CY_EM_EEPROM_SIZE;
|
||||
|
||||
cy_en_dfu_status_t status = CY_DFU_SUCCESS;
|
||||
|
||||
/* Check if the length is valid */
|
||||
if (IsMultipleOf(length, CY_FLASH_SIZEOF_ROW) == 0u)
|
||||
{
|
||||
status = CY_DFU_ERROR_LENGTH;
|
||||
}
|
||||
|
||||
/* Check if the address is inside the valid range */
|
||||
if ( ( (minUFlashAddress <= address) && (address < maxUFlashAddress) )
|
||||
|| ( (minEmEepromAddress <= address) && (address < maxEmEepromAddress) ) )
|
||||
{ /* Do nothing, this is an allowed memory range to update to */
|
||||
}
|
||||
else
|
||||
{
|
||||
status = CY_DFU_ERROR_ADDRESS;
|
||||
}
|
||||
|
||||
/* Read or Compare */
|
||||
if (status == CY_DFU_SUCCESS)
|
||||
{
|
||||
if ((ctl & CY_DFU_IOCTL_COMPARE) == 0u)
|
||||
{
|
||||
(void) memcpy(params->dataBuffer, (const void *)address, length);
|
||||
status = CY_DFU_SUCCESS;
|
||||
}
|
||||
else
|
||||
{
|
||||
status = ( memcmp(params->dataBuffer, (const void *)address, length) == 0 )
|
||||
? CY_DFU_SUCCESS : CY_DFU_ERROR_VERIFY;
|
||||
}
|
||||
}
|
||||
return (status);
|
||||
}
|
||||
|
||||
|
||||
/*******************************************************************************
|
||||
* Function Name: Cy_DFU_TransportRead
|
||||
****************************************************************************//**
|
||||
*
|
||||
* This function documentation is part of the DFU SDK API, see the
|
||||
* cy_dfu.h file or DFU SDK API Reference Manual for details.
|
||||
*
|
||||
*******************************************************************************/
|
||||
cy_en_dfu_status_t Cy_DFU_TransportRead (uint8_t *buffer, uint32_t size, uint32_t *count, uint32_t timeout)
|
||||
{
|
||||
return (CyBLE_CyBtldrCommRead(buffer, size, count, timeout));
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
* Function Name: Cy_DFU_TransportWrite
|
||||
****************************************************************************//**
|
||||
*
|
||||
* This function documentation is part of the DFU SDK API, see the
|
||||
* cy_dfu.h file or DFU SDK API Reference Manual for details.
|
||||
*
|
||||
*******************************************************************************/
|
||||
cy_en_dfu_status_t Cy_DFU_TransportWrite(uint8_t *buffer, uint32_t size, uint32_t *count, uint32_t timeout)
|
||||
{
|
||||
return (CyBLE_CyBtldrCommWrite(buffer, size, count, timeout));
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
* Function Name: Cy_DFU_TransportReset
|
||||
****************************************************************************//**
|
||||
*
|
||||
* This function documentation is part of the DFU SDK API, see the
|
||||
* cy_dfu.h file or DFU SDK API Reference Manual for details.
|
||||
*
|
||||
*******************************************************************************/
|
||||
void Cy_DFU_TransportReset(void)
|
||||
{
|
||||
CyBLE_CyBtldrCommReset();
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
* Function Name: Cy_DFU_TransportStart
|
||||
****************************************************************************//**
|
||||
*
|
||||
* This function documentation is part of the DFU SDK API, see the
|
||||
* cy_dfu.h file or DFU SDK API Reference Manual for details.
|
||||
*
|
||||
*******************************************************************************/
|
||||
void Cy_DFU_TransportStart(void)
|
||||
{
|
||||
CyBLE_CyBtldrCommStart();
|
||||
}
|
||||
|
||||
/*******************************************************************************
|
||||
* Function Name: Cy_DFU_TransportStop
|
||||
****************************************************************************//**
|
||||
*
|
||||
* This function documentation is part of the DFU SDK API, see the
|
||||
* cy_dfu.h file or DFU SDK API Reference Manual for details.
|
||||
*
|
||||
*******************************************************************************/
|
||||
void Cy_DFU_TransportStop(void)
|
||||
{
|
||||
CyBLE_CyBtldrCommStop();
|
||||
}
|
||||
|
||||
|
||||
/* [] END OF FILE */
|
||||
Loading…
Add table
Add a link
Reference in a new issue