sw/device/lib/spi_flash.h

/*
 * Copyright 2023 Google LLC
 *
 * 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 SW_DEVICE_LIB_SPI_FLASH_H_
#define SW_DEVICE_LIB_SPI_FLASH_H_

#include <stdint.h>

#include "sw/device/lib/base/mmio.h"
#include "sw/device/lib/dif/dif_base.h"

#define SPI_PAGE_SIZE (512)

#if defined(__cplusplus)
extern "C" {
#endif

/* General SPI flash related methods */
dif_result_t spi_flash_init(mmio_region_t spi_host_addr,
                            mmio_region_t eflash_addr, mmio_region_t otp_addr);
dif_result_t spi_flash_read_page(uint32_t page, uint8_t* buf);

/* Tar filesystem related methods */
dif_result_t load_file_from_tar(const char* filename, void* addr,
                                size_t max_mem_addr);

dif_result_t load_file_prefix_from_tar(const char* file_prefix, void* addr,
                                       size_t max_mem_addr, size_t* bin_offset,
                                       char* filename, size_t filename_len);

#if defined(__cplusplus)
}
#endif

#endif  // SW_DEVICE_LIB_SPI_FLASH_H_