flashpage.h

Go to the documentation of this file.

/*
 * Copyright (C) 2016 Freie Universität Berlin
 *               2017 Inria
 *
 * 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.
 */
 
#ifndef PERIPH_FLASHPAGE_H
#define PERIPH_FLASHPAGE_H
 
#include <stddef.h>
#include <stdint.h>
 
#include "cpu_conf.h"
#include "periph_cpu.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifndef CPU_FLASH_BASE
#define CPU_FLASH_BASE      (0)
#endif
#ifdef DOXYGEN
#define FLASHPAGE_WRITE_BLOCK_SIZE
#endif
 
#ifdef DOXYGEN
#define FLASHPAGE_WRITE_BLOCK_ALIGNMENT
#endif
 
#if defined(DOXYGEN) || !defined(FLASHPAGE_ERASE_STATE)
#define FLASHPAGE_ERASE_STATE           (0xFFU)
#endif
 
#ifdef DOXYGEN
#define PERIPH_FLASHPAGE_CUSTOM_PAGESIZES
#endif
 
#ifdef DOXYGEN
#define PERIPH_FLASHPAGE_NEEDS_FLASHPAGE_ADDR
#endif
 
#ifdef DOXYGEN
#define PERIPH_FLASHPAGE_NEEDS_FLASHPAGE_PAGE
#endif
 
enum {
    FLASHPAGE_OK      =  0,     
    FLASHPAGE_NOMATCH = -1      
};
 
#if !defined(PERIPH_FLASHPAGE_CUSTOM_PAGESIZES) || defined(DOXYGEN)
#ifndef FLASHPAGE_SIZE
#error "periph/flashpage: FLASHPAGE_SIZE not defined"
#endif
#ifndef FLASHPAGE_NUMOF
#error "periph/flashpage: FLASHPAGE_NUMOF not defined"
#endif
 
#if defined(MODULE_PERIPH_FLASHPAGE_IN_ADDRESS_SPACE) || defined(DOXYGEN)
#define FLASH_WRITABLE_INIT(name, size) \
    __attribute__((aligned(FLASHPAGE_SIZE))) \
    __attribute__((section(".flash_writable." #name))) \
    static const uint8_t name [size * FLASHPAGE_SIZE]
#endif
 
static inline size_t flashpage_size(unsigned page)
{
    (void)page;
    return FLASHPAGE_SIZE;
}
 
static inline void *flashpage_addr(unsigned page)
{
    return (void *)(CPU_FLASH_BASE + (page * FLASHPAGE_SIZE));
}
 
static inline unsigned flashpage_page(const void *addr)
{
    return (((intptr_t)addr - CPU_FLASH_BASE) / FLASHPAGE_SIZE);
}
 
#else
 
/* Bare prototypes for the above functions. See above for the documentation */
size_t flashpage_size(unsigned page);
void *flashpage_addr(unsigned page);
unsigned flashpage_page(const void *addr);
 
#endif
 
void flashpage_erase(unsigned page);
 
void flashpage_write_page(unsigned page, const void *data);
 
void flashpage_write(void *target_addr, const void *data, size_t len);
 
void flashpage_read(unsigned page, void *data);
 
int flashpage_verify(unsigned page, const void *data);
 
int flashpage_write_and_verify(unsigned page, const void *data);
 
#ifdef FLASHPAGE_RWWEE_NUMOF
 
static inline void *flashpage_rwwee_addr(unsigned page)
{
    return (void *)(CPU_FLASH_RWWEE_BASE + (page * FLASHPAGE_SIZE));
}
 
static inline int flashpage_rwwee_page(const void *addr)
{
    return (int)(((int)addr - CPU_FLASH_RWWEE_BASE) / FLASHPAGE_SIZE);
}
 
void flashpage_rwwee_write_page(unsigned page, const void *data);
 
void flashpage_rwwee_write(void *target_addr, const void *data, size_t len);
 
void flashpage_rwwee_read(unsigned page, void *data);
 
int flashpage_rwwee_verify(unsigned page, const void *data);
 
int flashpage_rwwee_write_and_verify(unsigned page, const void *data);
 
#endif /* FLASHPAGE_RWWEE_NUMOF */
 
#ifdef __cplusplus
}
#endif
 
#endif /* PERIPH_FLASHPAGE_H */