diff options
Diffstat (limited to 'src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-pbus-flash.h')
-rw-r--r-- | src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-pbus-flash.h | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-pbus-flash.h b/src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-pbus-flash.h new file mode 100644 index 0000000000..a5cd2d592d --- /dev/null +++ b/src/vendorcode/cavium/include/bdk/libbdk-hal/bdk-pbus-flash.h @@ -0,0 +1,111 @@ +/***********************license start*********************************** +* Copyright (c) 2016-2017 Cavium Inc. (support@cavium.com). All rights +* reserved. +* +* +* Redistribution and use in source and binary forms, with or without +* modification, are permitted provided that the following conditions are +* met: +* +* * Redistributions of source code must retain the above copyright +* notice, this list of conditions and the following disclaimer. +* +* * 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. +* +* * Neither the name of Cavium Inc. nor the names of +* its contributors may be used to endorse or promote products +* derived from this software without specific prior written +* permission. +* +* This Software, including technical data, may be subject to U.S. export +* control laws, including the U.S. Export Administration Act and its +* associated regulations, and may be subject to export or import +* regulations in other countries. +* +* TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED "AS IS" +* AND WITH ALL FAULTS AND CAVIUM INC. MAKES NO PROMISES, REPRESENTATIONS OR +* WARRANTIES, EITHER EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, WITH RESPECT +* TO THE SOFTWARE, INCLUDING ITS CONDITION, ITS CONFORMITY TO ANY +* REPRESENTATION OR DESCRIPTION, OR THE EXISTENCE OF ANY LATENT OR PATENT +* DEFECTS, AND CAVIUM SPECIFICALLY DISCLAIMS ALL IMPLIED (IF ANY) WARRANTIES +* OF TITLE, MERCHANTABILITY, NONINFRINGEMENT, FITNESS FOR A PARTICULAR +* PURPOSE, LACK OF VIRUSES, ACCURACY OR COMPLETENESS, QUIET ENJOYMENT, +* QUIET POSSESSION OR CORRESPONDENCE TO DESCRIPTION. THE ENTIRE RISK +* ARISING OUT OF USE OR PERFORMANCE OF THE SOFTWARE LIES WITH YOU. +***********************license end**************************************/ + +/** + * @file + * + * This file provides bootbus flash operations + * + * <hr>$Revision: 49448 $<hr> + * + * @addtogroup hal + * @{ + */ + +typedef struct +{ + int start_offset; + int block_size; + int num_blocks; +} bdk_pbus_flash_region_t; + +/** + * Initialize the flash access library + */ +void bdk_pbus_flash_initialize(bdk_node_t node); + +/** + * Return a pointer to the flash chip + * + * @param chip_id Chip ID to return + * @return Zero if the chip doesn't exist + */ +uint64_t bdk_pbus_flash_get_base(int chip_id); + +/** + * Return the number of erasable regions on the chip + * + * @param chip_id Chip to return info for + * @return Number of regions + */ +int bdk_pbus_flash_get_num_regions(int chip_id); + +/** + * Return information about a flash chips region + * + * @param chip_id Chip to get info for + * @param region Region to get info for + * @return Region information + */ +const bdk_pbus_flash_region_t *bdk_pbus_flash_get_region_info(int chip_id, int region); + +/** + * Erase a block on the flash chip + * + * @param chip_id Chip to erase a block on + * @param region Region to erase a block in + * @param block Block number to erase + * @return Zero on success. Negative on failure + */ +int bdk_pbus_flash_erase_block(int chip_id, int region, int block); + +/** + * Write data to flash. The block must have already been erased. You can call + * this multiple times on the same block to piecemeal write it. + * + * @param chip_id Which flash to write + * @param offset Offset into device to start write + * @param data Data to write + * @param len Length of the data + * + * @return Zero on success. Negative on failure + */ +int bdk_pbus_flash_write(int chip_id, int offset, const void *data, int len); + +/** @} */ |