mirror of
https://gitlab.rtems.org/rtems/rtos/rtems.git
synced 2025-11-16 04:24:45 +00:00
145 lines
4.6 KiB
C
145 lines
4.6 KiB
C
/* SPDX-License-Identifier: BSD-2-Clause */
|
|
|
|
/*
|
|
* Copyright (C) 2023 On-Line Applications Research Corporation (OAR)
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. 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.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
|
|
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER 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.
|
|
*/
|
|
|
|
#include <rtems/rtems/status.h>
|
|
#include <stddef.h>
|
|
#include <stdint.h>
|
|
|
|
/**
|
|
* This struct holds the information parsed from the Common Flash Memory
|
|
* Information (CFI) read from a flash chip.
|
|
*/
|
|
typedef struct NOR_Config_Data {
|
|
/* JEDEC ID */
|
|
uint32_t jedec_id;
|
|
/* Sector size in bytes */
|
|
uint32_t SectorSize;
|
|
/* Number of sectors */
|
|
uint32_t NumSectors;
|
|
/* Page size in bytes. This will default to 256 if unavailable. */
|
|
uint16_t PageSize;
|
|
/* This is the size of the flash device */
|
|
uint64_t DeviceSize;
|
|
/*
|
|
* Alternative Sector size in bytes. This will be 0 if the alternative sector
|
|
* size is unsupported or unavailable.
|
|
*/
|
|
uint32_t AltSectorSize;
|
|
/* The command byte to erase sectors in the alternative size */
|
|
uint8_t AltSectorCmd;
|
|
/* Number of sectors for the alternative sector size */
|
|
uint32_t NumAltSectors;
|
|
} NOR_Config_Data;
|
|
|
|
/**
|
|
*
|
|
* This function parses the provided buffer of CFI data into a NOR_Config_Data
|
|
* structure.
|
|
*
|
|
* @param cfi_raw is a buffer containing CFI data.
|
|
* @param cfi_raw_len is the length of the data in cfi_raw.
|
|
* @param data is a pointer to a NOR_Config_Data struct to be filled with data
|
|
* about the flash chip.
|
|
*
|
|
* @return RTEMS_SUCCESSFUL if successful.
|
|
*/
|
|
rtems_status_code CFI_parse_from_buffer(
|
|
uint8_t *cfi_raw,
|
|
size_t cfi_raw_len,
|
|
NOR_Config_Data *data
|
|
);
|
|
|
|
/**
|
|
*
|
|
* This function parses the provided buffer of SFDP data into a NOR_Config_Data
|
|
* structure.
|
|
*
|
|
* @param sfdp_raw is a buffer containing SFDP data.
|
|
* @param sfdp_raw_len is the length of the data in sfdp_raw.
|
|
* @param data is a pointer to a NOR_Config_Data struct to be filled with data
|
|
* about the flash chip.
|
|
*
|
|
* @return RTEMS_SUCCESSFUL if successful.
|
|
*/
|
|
rtems_status_code SFDP_parse_from_buffer(
|
|
uint8_t *sfdp_raw,
|
|
size_t sfdp_raw_len,
|
|
NOR_Config_Data *data
|
|
);
|
|
|
|
/**
|
|
* @brief Acquire data from the NOR chip.
|
|
*
|
|
* @param[in] context The context data used to retrieve bytes.
|
|
* @param[in] offset The offset to read from the flash begin in bytes.
|
|
* @param[in] length The size of the buffer in bytes.
|
|
*
|
|
* @retval NULL on failure.
|
|
* @retval pointer to the requested data on success.
|
|
*/
|
|
typedef uint8_t *(*NOR_Config_Resource_Acquire)(
|
|
void *context,
|
|
uint32_t offset,
|
|
size_t length
|
|
);
|
|
|
|
/**
|
|
* @brief Release data acquired from the NOR chip.
|
|
*
|
|
* @param[in] context The context data used to retrieve bytes.
|
|
* @param[in] data The data previously acquired.
|
|
*/
|
|
typedef void (*NOR_Config_Resource_Release)(
|
|
void *context,
|
|
uint8_t *data
|
|
);
|
|
|
|
typedef struct NOR_Config_Accessor {
|
|
/* The context provided to the acquire and release functions */
|
|
void *context;
|
|
/* The function used to acquire a block of data */
|
|
NOR_Config_Resource_Acquire acquire;
|
|
/* The function used to release a block of data */
|
|
NOR_Config_Resource_Release release;
|
|
} NOR_Config_Accessor;
|
|
|
|
/**
|
|
*
|
|
* This function parses a SFDP configuration space into a NOR_Config_Data
|
|
* structure.
|
|
*
|
|
* @param accessor is the accessor for the SFDP configuration space.
|
|
* @param data is a pointer to a NOR_Config_Data struct to be filled with data
|
|
* about the flash chip.
|
|
*
|
|
* @return RTEMS_SUCCESSFUL if successful.
|
|
*/
|
|
rtems_status_code SFDP_parse(
|
|
NOR_Config_Accessor *accessor,
|
|
NOR_Config_Data *data
|
|
);
|