/* * Copyright (c) 2020, Arm Limited and affiliates. * SPDX-License-Identifier: Apache-2.0 * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef SFDP_H #define SFDP_H #include #include #include "features/storage/blockdevice/BlockDevice.h" #include "platform/Callback.h" namespace mbed { /** \defgroup drivers-internal-api-sfdp SFDP * \ingroup drivers-internal-api * Serial Flash Discoverable Parameters. * * Based on JESD216D.01 Standard. * @{ */ static const int SFDP_HEADER_SIZE = 8; ///< Size of an SFDP header in bytes, 2 DWORDS static const int SFDP_BASIC_PARAMS_TBL_SIZE = 80; ///< Basic Parameter Table size in bytes, 20 DWORDS static const int SFDP_SECTOR_MAP_MAX_REGIONS = 10; ///< Maximum number of regions with different erase granularity // Erase Types Per Region BitMask static const int SFDP_ERASE_BITMASK_TYPE4 = 0x08; ///< Erase type 4 (erase granularity) identifier static const int SFDP_ERASE_BITMASK_TYPE3 = 0x04; ///< Erase type 3 (erase granularity) identifier static const int SFDP_ERASE_BITMASK_TYPE2 = 0x02; ///< Erase type 2 (erase granularity) identifier static const int SFDP_ERASE_BITMASK_TYPE1 = 0x01; ///< Erase type 1 (erase granularity) identifier static const int SFDP_ERASE_BITMASK_NONE = 0x00; ///< Erase type None static const int SFDP_ERASE_BITMASK_ALL = 0x0F; ///< Erase type All static const int SFDP_MAX_NUM_OF_ERASE_TYPES = 4; ///< Maximum number of different erase types (erase granularity) /** SFDP Basic Parameter Table info */ struct sfdp_bptbl_info { uint32_t addr; ///< Address size_t size; ///< Size }; /** SFDP Sector Map Table info */ struct sfdp_smptbl_info { uint32_t addr; ///< Address size_t size; ///< Size int region_cnt; ///< Number of erase regions int region_size[SFDP_SECTOR_MAP_MAX_REGIONS]; ///< Erase region size in bytes uint8_t region_erase_types_bitfld[SFDP_SECTOR_MAP_MAX_REGIONS]; ///< Each Region can support a bit combination of any of the 4 Erase Types unsigned int regions_min_common_erase_size; ///< Minimal common erase size for all regions (0 if none exists) bd_size_t region_high_boundary[SFDP_SECTOR_MAP_MAX_REGIONS]; ///< Region high address offset boundary int erase_type_inst_arr[SFDP_MAX_NUM_OF_ERASE_TYPES]; ///< // Up To 4 Erase Types are supported by SFDP (each with its own command Instruction and Size) unsigned int erase_type_size_arr[SFDP_MAX_NUM_OF_ERASE_TYPES]; ///< Erase sizes for all different erase types }; /** SFDP Parameter Table addresses and sizes */ struct sfdp_hdr_info { sfdp_bptbl_info bptbl; sfdp_smptbl_info smptbl; }; /** SFDP Header */ struct sfdp_hdr { uint8_t SIG_B0; ///< SFDP Signature, Byte 0 uint8_t SIG_B1; ///< SFDP Signature, Byte 1 uint8_t SIG_B2; ///< SFDP Signature, Byte 2 uint8_t SIG_B3; ///< SFDP Signature, Byte 3 uint8_t R_MINOR; ///< SFDP Minor Revision uint8_t R_MAJOR; ///< SFDP Major Revision uint8_t NPH; ///< Number of parameter headers (0-based, 0 indicates 1 parameter header) uint8_t ACP; ///< SFDP Access Protocol }; /** SFDP Parameter header */ struct sfdp_prm_hdr { uint8_t PID_LSB; ///< Parameter ID LSB uint8_t P_MINOR; ///< Parameter Minor Revision uint8_t P_MAJOR; ///< Parameter Major Revision uint8_t P_LEN; ///< Parameter length in DWORDS uint32_t DWORD2; ///< Parameter ID MSB + Parameter Table Pointer }; /** Parse SFDP Header * @param sfdp_hdr_ptr Pointer to memory holding an SFDP header * @return Number of Parameter Headers on success, -1 on failure */ int sfdp_parse_sfdp_header(sfdp_hdr *sfdp_hdr_ptr); /** Parse Parameter Header * @param parameter_header Pointer to memory holding a single SFDP Parameter header * @param hdr_info Reference to a Parameter Table structure where info about the table is written * @return 0 on success, -1 on failure */ int sfdp_parse_single_param_header(sfdp_prm_hdr *parameter_header, sfdp_hdr_info &hdr_info); /** Parse SFDP Headers * Retrieves SFDP headers from a device and parses the information contained by the headers * * @param sfdp_reader Callback function used to read headers from a device * @param hdr_info All information parsed from the headers gets passed back on this structure * * @return 0 on success, negative error code on failure */ int sfdp_parse_headers(Callback sfdp_reader, sfdp_hdr_info &hdr_info); /** Parse Sector Map Parameter Table * Retrieves the table from a device and parses the information contained by the table * * @param sfdp_reader Callback function used to read headers from a device * @param smtbl All information parsed from the table gets passed back on this structure * * @return 0 on success, negative error code on failure */ int sfdp_parse_sector_map_table(Callback sfdp_reader, sfdp_smptbl_info &smtbl); /** @}*/ } /* namespace mbed */ #endif