This is the HCC Embedded Product Documentation.

HCC Embedded Main Website   |    HCC Documentation Home Page  |     Contacting HCC Embedded

This section describes all the source code files included in the system. These files follow the HCC Embedded standard source tree system, described in the HCC Source Tree Guide. All references to file pathnames refer to locations within this standard source tree, not within the package you initially receive.

Note: Do not modify any files except the configuration files and PSP files.

API Header File

The file src/api/api_ftl_nand_mt29fxg08_ecc.h is the only file that should be included by an application using this module. For details of the single API function, see Application Programming Interface.

Configuration File

The file src/config/config_ftl_nand_mt29fxg08_ecc.h contains all the configurable parameters of the system. Configure these as required.

Source Code File

The file src/media-drv/ftl/drivers/nand/micron/nand_mt29fxg08_ecc.c holds the source code for the media driver. This file should only be modified by HCC.

Platform Support Package (PSP) Files

These files provide functions the core code needs to call, depending on the hardware. There are two sets of files, in the directories src/psp_stm32f4xx/target/nand_mt29fxg08_ecc and src/psp_omapl138/target/nand_mt29fxg08_ecc.

Note: You must modify these PSP implementations for your specific microcontroller and development board; see PSP Porting for details.

The files are as follows:

psp_nand_mt29fxg08_ecc.cSource code.
psp_nand_mt29fxg08_ecc.hHeader file.

Version File

The file src/version/ver_ftl_nand_mt29fxg08_ecc.h contains the version number of this module. This version number is checked by all modules that use a module to ensure system consistency over upgrades.