blob: 122c9339583e8805cff4c1e703bd1f95a9160d7a [file] [log] [blame]
#pragma once
#ifdef VIRTUAL_PNOR_ENABLED
#include <limits.h>
#include "pnor_partition_defs.h"
struct mbox_context;
struct vpnor_partition_table;
struct vpnor_partition_paths
{
char ro_loc[PATH_MAX];
char rw_loc[PATH_MAX];
char prsv_loc[PATH_MAX];
char patch_loc[PATH_MAX];
};
#ifdef __cplusplus
extern "C" {
#endif
/** @brief Create a virtual PNOR partition table.
*
* @param[in] context - mbox context pointer
*
* This API should be called before calling any other APIs below. If a table
* already exists, this function will not do anything further. This function
* will not do anything if the context is NULL.
*
* Returns 0 if the call succeeds, else a negative error code.
*/
int init_vpnor(struct mbox_context *context);
/** @brief Create a virtual PNOR partition table.
*
* @param[in] context - mbox context pointer
* @param[in] path - location of the partition file
*
* This API is same as above one but it reads the partition file from
* from the given location(path).
*
* Returns 0 if the call succeeds, else a negative error code.
*/
int vpnor_create_partition_table_from_path(struct mbox_context *context,
const char* path);
/** @brief Get partition table size, in blocks (1 block = 4KB)
*
* @param[in] context - mbox context pointer
*
* @returns partition table size. 0 if no table exists, or if the
* context is NULL.
*/
size_t vpnor_get_partition_table_size(const struct mbox_context *context);
/** @brief Get virtual PNOR partition table with host-compatible byte-ordering
*
* @param[in] context - mbox context pointer
*
* @returns pointer to partition table, NULL if partition table doesn't
* exist or if the context is NULL.
*/
const struct pnor_partition_table* vpnor_get_partition_table(
const struct mbox_context *context);
/** @brief Get a specific partition, by PNOR offset. The returned
* partition is such that the offset lies in that partition's
* boundary.
*
* @param[in] context - mbox context pointer
* @param[in] offset - PNOR offset
*
* @returns const pointer to pnor_partition, NULL if partition table doesn't
* exist or if the context is NULL
*/
const struct pnor_partition* vpnor_get_partition(
const struct mbox_context *context,
const size_t offset);
/** @brief Copy bootloader partition (alongwith TOC) to LPC memory
*
* @param[in] context - mbox context pointer
*
* @returns 0 on success, negative error code on failure
*/
int vpnor_copy_bootloader_partition(const struct mbox_context *context);
/** @brief Destroy partition table, if it exists.
*
* @param[in] context - mbox context pointer
*/
void destroy_vpnor(struct mbox_context *context);
#ifdef __cplusplus
}
#endif
#endif