mirror of
https://github.com/eclipse-threadx/levelx.git
synced 2026-09-14 04:06:00 +08:00
221 lines
9.5 KiB
C
221 lines
9.5 KiB
C
/***************************************************************************
|
|
* Copyright (c) 2024 Microsoft Corporation
|
|
*
|
|
* This program and the accompanying materials are made available under the
|
|
* terms of the MIT License which is available at
|
|
* https://opensource.org/licenses/MIT.
|
|
*
|
|
* SPDX-License-Identifier: MIT
|
|
**************************************************************************/
|
|
|
|
|
|
/**************************************************************************/
|
|
/**************************************************************************/
|
|
/** */
|
|
/** LevelX Component */
|
|
/** */
|
|
/** NOR Flash */
|
|
/** */
|
|
/**************************************************************************/
|
|
/**************************************************************************/
|
|
|
|
#define LX_SOURCE_CODE
|
|
|
|
|
|
/* Disable ThreadX error checking. */
|
|
|
|
#ifndef LX_DISABLE_ERROR_CHECKING
|
|
#define LX_DISABLE_ERROR_CHECKING
|
|
#endif
|
|
|
|
|
|
/* Include necessary system files. */
|
|
|
|
#include "lx_api.h"
|
|
|
|
|
|
/**************************************************************************/
|
|
/* */
|
|
/* FUNCTION RELEASE */
|
|
/* */
|
|
/* _lx_nor_flash_sector_read PORTABLE C */
|
|
/* 6.3.0 */
|
|
/* AUTHOR */
|
|
/* */
|
|
/* William E. Lamie, Microsoft Corporation */
|
|
/* */
|
|
/* DESCRIPTION */
|
|
/* */
|
|
/* This function reads a logical sector from NOR flash. */
|
|
/* */
|
|
/* INPUT */
|
|
/* */
|
|
/* nor_flash NOR flash instance */
|
|
/* logical_sector Logical sector number */
|
|
/* buffer Pointer to buffer to read into*/
|
|
/* (the size is 512 bytes) */
|
|
/* */
|
|
/* OUTPUT */
|
|
/* */
|
|
/* return status */
|
|
/* */
|
|
/* CALLS */
|
|
/* */
|
|
/* _lx_nor_flash_driver_write Driver flash sector write */
|
|
/* _lx_nor_flash_driver_read Driver flash sector read */
|
|
/* _lx_nor_flash_logical_sector_find Find logical sector */
|
|
/* _lx_nor_flash_physical_sector_allocate */
|
|
/* Allocate new logical sector */
|
|
/* _lx_nor_flash_system_error Internal system error handler */
|
|
/* tx_mutex_get Get thread protection */
|
|
/* tx_mutex_put Release thread protection */
|
|
/* */
|
|
/* CALLED BY */
|
|
/* */
|
|
/* Application Code */
|
|
/* */
|
|
/* RELEASE HISTORY */
|
|
/* */
|
|
/* DATE NAME DESCRIPTION */
|
|
/* */
|
|
/* 05-19-2020 William E. Lamie Initial Version 6.0 */
|
|
/* 09-30-2020 William E. Lamie Modified comment(s), */
|
|
/* resulting in version 6.1 */
|
|
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
|
|
/* resulting in version 6.1.7 */
|
|
/* 10-31-2023 Xiuwen Cai Modified comment(s), */
|
|
/* added mapping bitmap cache, */
|
|
/* resulting in version 6.3.0 */
|
|
/* */
|
|
/**************************************************************************/
|
|
UINT _lx_nor_flash_sector_read(LX_NOR_FLASH *nor_flash, ULONG logical_sector, VOID *buffer)
|
|
{
|
|
|
|
UINT status;
|
|
ULONG *mapping_address;
|
|
ULONG mapping_entry;
|
|
ULONG *sector_address;
|
|
|
|
|
|
#ifdef LX_THREAD_SAFE_ENABLE
|
|
|
|
/* Obtain the thread safe mutex. */
|
|
tx_mutex_get(&nor_flash -> lx_nor_flash_mutex, TX_WAIT_FOREVER);
|
|
#endif
|
|
|
|
/* Increment the number of read requests. */
|
|
nor_flash -> lx_nor_flash_read_requests++;
|
|
|
|
/* See if we can find the sector in the current mapping. */
|
|
_lx_nor_flash_logical_sector_find(nor_flash, logical_sector, LX_FALSE, &mapping_address, §or_address);
|
|
|
|
/* Determine if the logical sector was found. */
|
|
if (mapping_address)
|
|
{
|
|
|
|
/* Yes, we were able to find the logical sector. */
|
|
|
|
/* Read the sector data from the physical sector. */
|
|
status = _lx_nor_flash_driver_read(nor_flash, sector_address, buffer, LX_NOR_SECTOR_SIZE);
|
|
|
|
/* Check for an error from flash driver. Drivers should never return an error.. */
|
|
if (status)
|
|
{
|
|
|
|
/* Call system error handler. */
|
|
_lx_nor_flash_system_error(nor_flash, status);
|
|
|
|
/* Adjust return status. */
|
|
status = LX_ERROR;
|
|
}
|
|
else
|
|
{
|
|
|
|
/* Set the status to success. */
|
|
status = LX_SUCCESS;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
|
|
/* Allocate a new physical sector for this write. */
|
|
_lx_nor_flash_physical_sector_allocate(nor_flash, logical_sector, &mapping_address, §or_address);
|
|
|
|
/* Determine if the new sector allocation was successful. */
|
|
if (mapping_address)
|
|
{
|
|
|
|
/* Update the number of free physical sectors. */
|
|
nor_flash -> lx_nor_flash_free_physical_sectors--;
|
|
|
|
/* Read the sector data from the physical sector. */
|
|
status = _lx_nor_flash_driver_read(nor_flash, sector_address, buffer, LX_NOR_SECTOR_SIZE);
|
|
|
|
/* Check for an error from flash driver. Drivers should never return an error.. */
|
|
if (status)
|
|
{
|
|
|
|
/* Call system error handler. */
|
|
_lx_nor_flash_system_error(nor_flash, status);
|
|
}
|
|
|
|
/* Now build the new mapping entry. */
|
|
mapping_entry = ((ULONG) LX_NOR_PHYSICAL_SECTOR_VALID) | ((ULONG) LX_NOR_PHYSICAL_SECTOR_SUPERCEDED) | logical_sector;
|
|
|
|
/* Write out the new mapping entry. */
|
|
status = _lx_nor_flash_driver_write(nor_flash, mapping_address, &mapping_entry, 1);
|
|
|
|
/* Check for an error from flash driver. Drivers should never return an error.. */
|
|
if (status)
|
|
{
|
|
|
|
/* Call system error handler. */
|
|
_lx_nor_flash_system_error(nor_flash, status);
|
|
|
|
#ifdef LX_THREAD_SAFE_ENABLE
|
|
|
|
/* Release the thread safe mutex. */
|
|
tx_mutex_put(&nor_flash -> lx_nor_flash_mutex);
|
|
#endif
|
|
|
|
/* Return status. */
|
|
return(LX_ERROR);
|
|
}
|
|
#ifndef LX_NOR_DISABLE_EXTENDED_CACHE
|
|
#ifdef LX_NOR_ENABLE_MAPPING_BITMAP
|
|
|
|
/* Determine if the logical sector is within the mapping bitmap. */
|
|
if (logical_sector < nor_flash -> lx_nor_flash_extended_cache_mapping_bitmap_max_logical_sector)
|
|
{
|
|
|
|
/* Set the bit in the mapping bitmap. */
|
|
nor_flash -> lx_nor_flash_extended_cache_mapping_bitmap[logical_sector >> 5] |= (ULONG)(1 << (logical_sector & 31));
|
|
}
|
|
#endif
|
|
#endif
|
|
|
|
/* Increment the number of mapped physical sectors. */
|
|
nor_flash -> lx_nor_flash_mapped_physical_sectors++;
|
|
|
|
/* Set the status to success. */
|
|
status = LX_SUCCESS;
|
|
}
|
|
else
|
|
{
|
|
|
|
/* Could not find the logical sector. */
|
|
status = LX_SECTOR_NOT_FOUND;
|
|
}
|
|
}
|
|
|
|
#ifdef LX_THREAD_SAFE_ENABLE
|
|
|
|
/* Release the thread safe mutex. */
|
|
tx_mutex_put(&nor_flash -> lx_nor_flash_mutex);
|
|
#endif
|
|
|
|
/* Return status. */
|
|
return(status);
|
|
}
|
|
|