Jump to main content

##

# 1.1.4.4.11 DRV_NAND_FLASH_ParameterPageRead Function

## C

    bool DRV_NAND_FLASH_ParameterPageRead(const DRV_HANDLE handle, uint8_t *parameterPage, uint32_t size);

## Summary

Returns the Parameter page of the NAND Flash device.

## Description

This routine reads the parameter page of the NAND Flash device. It reads target's organization, features, timings and other behavioural parameters of NAND Flash device.

## Precondition

The DRV_NAND_FLASH_Open() routine must have been called for the specified NAND FLASH driver instance.

## Parameters

Param | Description
--- | ---
handle | A valid open-instance handle, returned from the driver's open routine
parameterPage | Pointer to destination buffer into which parameter page to be placed from NAND Flash
size | Total number of parameter page data bytes to be read

## Returns

true - If parameter page is successfully read from the NAND Flash

false - If parameter page read is failed

## Example

    DRV_HANDLE handle; // Returned from DRV_NAND_FLASH_Open
    uint8_t parameterPage[116];

    if (DRV_NAND_FLASH_ParameterPageRead(handle, parameterPage, sizeof(parameterPage)))
    {
        // Parameter page read successfully
    }

## Remarks

This routine will block wait for hardware access.