mtd.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: 2016 OTA keys S.A.
 * SPDX-License-Identifier: LGPL-2.1-only
 */
 
#pragma once

 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#include "xfa.h"
 
#ifdef __cplusplus
extern "C" {
#endif

enum mtd_power_state {
    MTD_POWER_UP,    
    MTD_POWER_DOWN,  
};

typedef struct mtd_desc mtd_desc_t;

typedef struct {
    const mtd_desc_t *driver;  
    uint32_t sector_count;     
    uint32_t pages_per_sector; 
    uint32_t page_size;        
    uint32_t write_size;       
#if defined(MODULE_MTD_WRITE_PAGE) || DOXYGEN
    void *work_area;           
#endif
} mtd_dev_t;

#if !DOXYGEN
XFA_USE_CONST(mtd_dev_t *, mtd_dev_xfa);
#else
mtd_dev_t * const mtd_dev_xfa[];
#endif

#define MTD_XFA_ADD(dev, idx) \
    XFA_CONST(mtd_dev_t, mtd_dev_xfa, idx) *mtd ## idx = (mtd_dev_t *)&(dev)

#define MTD_NUMOF   XFA_LEN(mtd_dev_t *, mtd_dev_xfa)

#define MTD_DRIVER_FLAG_DIRECT_WRITE    (1 << 0)

#define MTD_DRIVER_FLAG_CLEARING_OVERWRITE    (1 << 1)

struct mtd_desc {
    int (*init)(mtd_dev_t *dev);

    int (*read)(mtd_dev_t *dev,
                void *buff,
                uint32_t addr,
                uint32_t size);

    int (*read_page)(mtd_dev_t *dev,
                     void *buff,
                     uint32_t page,
                     uint32_t offset,
                     uint32_t size);

    int (*write_page)(mtd_dev_t *dev,
                      const void *buff,
                      uint32_t page,
                      uint32_t offset,
                      uint32_t size);

    int (*erase)(mtd_dev_t *dev,
                 uint32_t addr,
                 uint32_t size);

    int (*erase_sector)(mtd_dev_t *dev,
                        uint32_t sector,
                        uint32_t count);

    int (*power)(mtd_dev_t *dev, enum mtd_power_state power);

    uint8_t flags;
};

int mtd_init(mtd_dev_t *mtd);

int mtd_read(mtd_dev_t *mtd, void *dest, uint32_t addr, uint32_t count);

int mtd_read_page(mtd_dev_t *mtd, void *dest, uint32_t page, uint32_t offset, uint32_t size);

int mtd_write(mtd_dev_t *mtd, const void *src, uint32_t addr, uint32_t count);

int mtd_write_page_raw(mtd_dev_t *mtd, const void *src, uint32_t page,
                       uint32_t offset, uint32_t size);

int mtd_write_page(mtd_dev_t *mtd, const void *src, uint32_t page,
                   uint32_t offset, uint32_t size);

int mtd_erase(mtd_dev_t *mtd, uint32_t addr, uint32_t count);

int mtd_erase_sector(mtd_dev_t *mtd, uint32_t sector, uint32_t num);

int mtd_write_sector(mtd_dev_t *mtd, const void *src, uint32_t sector, uint32_t num);

int mtd_power(mtd_dev_t *mtd, enum mtd_power_state power);

static inline mtd_dev_t *mtd_dev_get(unsigned idx)
{
    assert(MTD_NUMOF != 0);
    assert(idx < MTD_NUMOF);
 
    return mtd_dev_xfa[idx];
}
 
#ifdef __cplusplus
}
#endif