Data Structures
struct	ptxNSC_Download

Typedefs
typedef struct ptxNSC_Download	ptxNSC_Download_t

Functions
ptxStatus_t	ptxNSC_Download_WriteCode (ptxNSC_t nscCtx, uint8_t fwImageBuf, size_t fwImageLen, size_t num_addresses, size_t index_addresses)
	Process and Download the fw image to the chip.

ptxStatus_t	ptxNSC_Download_CheckImageFormat (ptxNSC_t nscCtx, uint8_t fwImageBuf, size_t fwImageLen, size_t numEntries, size_t indexOfPayload)
	Check that the fw image has proper format.

Detailed Description

SPDX-License-Identifier: BSD-3-Clause

Redistribution and use in source and binary forms, with or without modification, are permitted 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 Renesas 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 Renesas "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL RENESAS 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.

Project : PTX1K Module : NSC File : ptxNSC_Download.h

Description : Definition of NFC Soft Controller Interface for Firmware Activation. Contains function(s) to download the firmware after the power-up and to activate the firmware after successful download.

Typedef Documentation

◆ ptxNSC_Download_t

typedef struct ptxNSC_Download ptxNSC_Download_t

Main NSC Download structure.

Function Documentation

◆ ptxNSC_Download_CheckImageFormat()

ptxStatus_t ptxNSC_Download_CheckImageFormat	(	ptxNSC_t *	nscCtx,
		uint8_t *	fwImageBuf,
		size_t	fwImageLen,
		size_t *	numEntries,
		size_t *	indexOfPayload )

Check that the fw image has proper format.

Parameters

[in]	nscCtx	Pointer to the component structure.
[in]	fwImageBuf	Pointer to a buffer with the fw image in ASCII format (Not parsed yet).
[in]	fwImageLen	Number of bytes in the fw image.
[out]	numEntries	Pointer to provide number of entries in the fw image.
[out]	indexOfPayload	Pointer to the index in the buffer, where addresses region starts.

Returns: Status, indicating whether the operation was successful. See ptxStatus_t.

◆ ptxNSC_Download_WriteCode()

ptxStatus_t ptxNSC_Download_WriteCode	(	ptxNSC_t *	nscCtx,
		uint8_t *	fwImageBuf,
		size_t	fwImageLen,
		size_t	num_addresses,
		size_t	index_addresses )

Process and Download the fw image to the chip.