/*
 * Copyright 2014 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */

/**
 * @defgroup    drivers_flashrom Flash memory driver
 * @ingroup     drivers
 * @brief       Generic flash memory driver
 * @{
 *
 * @file
 *
 * @brief       Generic flash memory driver
 * @author      unknown
 */

#ifndef FLASHROM_H
#define FLASHROM_H

#include <stdint.h>
#include <stddef.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief Erase sector
 *
 * @param[out] addr Address within a flash sector to erase
 *
 * @return          1 on success, 0 otherwise
 */
uint8_t             flashrom_erase(uint8_t *addr);

/**
 * @brief Write buffer from ram to flash
 *
 * @param[out] dst  Address within a flash sector to write, must be a 256 byte boundary
 * @param[in] src   Address within ram, must be a word boundary
 * @param[in] size  Bytes to write
 *
 * @return          1 on success, 0 otherwise
 */
uint8_t             flashrom_write(uint8_t *dst, const uint8_t *src, size_t size);

#ifdef __cplusplus
}
#endif

#endif /* FLASHROM_H */
/** @} */